From db6d4299c7980849ca2517084210bee8ce5b9330 Mon Sep 17 00:00:00 2001 From: cronon Date: Mon, 4 Apr 2016 13:46:47 +0300 Subject: [PATCH 001/844] Add documentation for cookie-js --- cookiejs/cookiejs.d.ts | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/cookiejs/cookiejs.d.ts b/cookiejs/cookiejs.d.ts index 1bc4d2b5ee..77b8973aed 100644 --- a/cookiejs/cookiejs.d.ts +++ b/cookiejs/cookiejs.d.ts @@ -2,20 +2,46 @@ // Project: https://github.com/js-coder/cookie.js // Definitions by: Boltmade // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - +/** + * Shortcut for cookie.get() + */ declare function cookie(key : string, fallback?: string) : string; declare function cookie(keys : string[], fallback?: string) : string; declare namespace cookie { + /** + * Create a cookie. The value will automatically be escaped. + */ export function set(key : string, value : string, options? : any) : void; + /** + * Set several cookies at once + */ export function set(obj : any, options? : any) : void; + /** + * Remove cookies + */ export function remove(key : string) : void; export function remove(keys : string[]) : void; export function remove(...args : string[]) : void; + /** + * Remove all cookies + */ export function empty() : void; + /** + * Retrieve the value of the cookie + */ export function get(key : string, fallback?: string) : string; - export function get(keys : string[], fallback?: string) : string; + /** + * Retrieve values of several cookies + */ + export function get(keys : string[], fallback?: string) : any; + /** + * Get all currently saved cookies + */ export function all() : any; + /** + * Test if cookies are enabled + */ export function enabled() : boolean; } From b391281610c6c915875ba29eaa399bc48b1cc6f2 Mon Sep 17 00:00:00 2001 From: Christopher Cortes Date: Sun, 4 Dec 2016 17:46:15 +0100 Subject: [PATCH 002/844] Add new Angular 1.5.9 methods to $compileProvider Add new methods available in Angular 1.5.9: onChangesTtl(), commentDirectivesEnabled() and cssClassDirectivesEnabled() --- angularjs/angular.d.ts | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/angularjs/angular.d.ts b/angularjs/angular.d.ts index b16438bdcb..7d30fba2a0 100644 --- a/angularjs/angular.d.ts +++ b/angularjs/angular.d.ts @@ -1205,6 +1205,15 @@ declare namespace angular { debugInfoEnabled(): boolean; debugInfoEnabled(enabled: boolean): ICompileProvider; + + onChangesTtl(): number; + onChangesTtl(limit: number): ICompileProvider; + + commentDirectivesEnabled(): boolean; + commentDirectivesEnabled(enabled: boolean): ICompileProvider; + + cssClassDirectivesEnabled(): boolean; + cssClassDirectivesEnabled(enabled: boolean): ICompileProvider; } interface ICloneAttachFunction { From 82984a5325b92b1b720e3aaa361c1f6905491fa0 Mon Sep 17 00:00:00 2001 From: Christopher Cortes Date: Mon, 5 Dec 2016 09:18:39 +0100 Subject: [PATCH 003/844] Add JSDoc to Angular 1.59 new methods of $compileProvider JSDoc for onChangesTtl(), commentDirectivesEnabled() and cssClassDirectivesEnabled() methods. --- angularjs/angular.d.ts | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/angularjs/angular.d.ts b/angularjs/angular.d.ts index 7d30fba2a0..ddd1056821 100644 --- a/angularjs/angular.d.ts +++ b/angularjs/angular.d.ts @@ -1206,12 +1206,27 @@ declare namespace angular { debugInfoEnabled(): boolean; debugInfoEnabled(enabled: boolean): ICompileProvider; + /** + * Sets the number of times $onChanges hooks can trigger new changes before giving up and assuming that the model is unstable. + * Increasing the TTL could have performance implications, so you should not change it without proper justification. + * Default: 10. + */ onChangesTtl(): number; onChangesTtl(limit: number): ICompileProvider; + /** + * It indicates to the compiler whether or not directives on comments should be compiled. + * It results in a compilation performance gain since the compiler doesn't have to check comments when looking for directives. + * Defaults to true. + */ commentDirectivesEnabled(): boolean; commentDirectivesEnabled(enabled: boolean): ICompileProvider; + /** + * It indicates to the compiler whether or not directives on element classes should be compiled. + * It results in a compilation performance gain since the compiler doesn't have to check element classes when looking for directives. + * Defaults to true. + */ cssClassDirectivesEnabled(): boolean; cssClassDirectivesEnabled(enabled: boolean): ICompileProvider; } From 76c47b02f0a90cfef9d99912c14e371a9f958f0e Mon Sep 17 00:00:00 2001 From: Christopher Cortes Date: Mon, 5 Dec 2016 09:23:22 +0100 Subject: [PATCH 004/844] Expand $compileProvider JSDoc Urls added to JSDoc of Angular 1.5.9 new methods . --- angularjs/angular.d.ts | 3 +++ 1 file changed, 3 insertions(+) diff --git a/angularjs/angular.d.ts b/angularjs/angular.d.ts index ddd1056821..87870bbbd6 100644 --- a/angularjs/angular.d.ts +++ b/angularjs/angular.d.ts @@ -1210,6 +1210,7 @@ declare namespace angular { * Sets the number of times $onChanges hooks can trigger new changes before giving up and assuming that the model is unstable. * Increasing the TTL could have performance implications, so you should not change it without proper justification. * Default: 10. + * See: https://docs.angularjs.org/api/ng/provider/$compileProvider#onChangesTtl */ onChangesTtl(): number; onChangesTtl(limit: number): ICompileProvider; @@ -1218,6 +1219,7 @@ declare namespace angular { * It indicates to the compiler whether or not directives on comments should be compiled. * It results in a compilation performance gain since the compiler doesn't have to check comments when looking for directives. * Defaults to true. + * See: https://docs.angularjs.org/api/ng/provider/$compileProvider#commentDirectivesEnabled */ commentDirectivesEnabled(): boolean; commentDirectivesEnabled(enabled: boolean): ICompileProvider; @@ -1226,6 +1228,7 @@ declare namespace angular { * It indicates to the compiler whether or not directives on element classes should be compiled. * It results in a compilation performance gain since the compiler doesn't have to check element classes when looking for directives. * Defaults to true. + * See: https://docs.angularjs.org/api/ng/provider/$compileProvider#cssClassDirectivesEnabled */ cssClassDirectivesEnabled(): boolean; cssClassDirectivesEnabled(enabled: boolean): ICompileProvider; From 11aece9e50aa73feb5497bab8073599b699c040e Mon Sep 17 00:00:00 2001 From: Jason Burns Date: Thu, 23 Mar 2017 20:15:25 -0700 Subject: [PATCH 005/844] Add node-jose types. The tests are taken from the documentation currently provided on the NPM page for node-jose. They need to be cleaned up and added to. --- node-jose/index.d.ts | 1379 ++++++++++++++++++++++++++++++++++ node-jose/node-jose-tests.ts | 388 ++++++++++ node-jose/tsconfig.json | 22 + 3 files changed, 1789 insertions(+) create mode 100644 node-jose/index.d.ts create mode 100644 node-jose/node-jose-tests.ts create mode 100644 node-jose/tsconfig.json diff --git a/node-jose/index.d.ts b/node-jose/index.d.ts new file mode 100644 index 0000000000..d3a7fd891c --- /dev/null +++ b/node-jose/index.d.ts @@ -0,0 +1,1379 @@ +// Type definitions for node-jose v0.9.3 +// Project: https://github.com/cisco/node-jose +// Definitions by: Jason Burns +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +// Most of this documentation comes directly from the excellently documented +// node-jose package, with only a bit added in to explain intermediate types. +// It should currently be considered a wip, as I created it for a personal +// project, but have not spent the necessary time to make it feature complete. +// Uses 'object' so requires tsc >2.2 + +/// + +/** + * Exposes all implemented algorithms through a common interface comprised of + * six primary 'action' functions. + */ +export module JWA { + + /** + * Options that can be given to the decrypt function. Additional data can be + * passed in with `aad` or `adata` (`aad` will take precedence if both are given), + * an initialization vector with `iv`, and an authentication tag or code with + * `tag` or `mac` (`tag` will take precedence). + */ + type decryptEncryptOptions = { + aad?: Buffer, + adata?: Buffer, + iv?: Buffer, + tag?: Buffer, // Not used in encrypt + mac?: Buffer, // Not used in encrypt + epu?: Buffer, // encryption party info + epv?: Buffer, // encryption party info + kdata?: Buffer, + epk?: Buffer, // ephemeral pub key used in ec + enc?: string, // algorithm to use in ec + alg?: string, // variation of enc, probably oversight in lib code + apu?: Buffer, // agreement party info used in ec + apv?: Buffer, // agreement party info used in ec + p2s?: Buffer, // used in pbes + p2c?: number // used in pbes + }; + + /** + * Options that can be given to the derive functions. Some options are only viable + * for certain algorithms. Future doc will expand these use cases. + */ + type deriveOptions = { + length?: number, // key length + otherInfo?: Buffer, // info used in concatkdf + public?: Buffer, // public key used in ecdh + hash?: Buffer, // hash used in ecdh + salt?: Buffer, // salt value used in hkdf + info?: Buffer, // app identifier info used in hkdf + }; + + /** + * Options used for all sign algorithms. + */ + type signVerifyOptions = { loose?: boolean }; // used in hmac algo + + /** + * The object that is returned from encrypt options. Some algorithms return a + * tag value, so a simple buffer cannot be used here. + */ + type encryptReturn = { + data: Buffer, // The cipher text + tag?: Buffer // The tag used in some algorithms + } + + /** + * Return object for sign functions. The data is replicated into the return for + * ease of use. + */ + type signReturn = { + data: Buffer, // the data passed into the sign function + mac: Buffer // the signature for `data` + } + + /** + * Return object for verify functions. The data and mac are replicated into the + * return for ease of use. + */ + type verifyReturn = { + data: Buffer, // the data passed into the verify function + mac: Buffer, // the signature for `data` + valid: boolean // whether the signature matches the data + } + + /** + * Run the decryption algorithm given by `alg`, if it is supported in the current + * implementation. + * + * @param {string} alg The algorithm to use + * @param {(string | Buffer)} key The decryption key + * @param {(string | Buffer)} cdata The ciphertext + * @param {decryptOptions} [props] Any of the allowed decryption options given in `JWA.decryptEncryptOptions` + * @returns {Promise} A buffer with the plain text. + */ + function decrypt(alg: string, key: string | Buffer, cdata: string | Buffer, props?: decryptEncryptOptions): Promise; + + /** + * Derive a new cryptographically strong key from weaker key material, using `alg` if it is + * implemented + * + * @param {string} alg The algorithm to use + * @param {(string | Buffer)} key The weak key material + * @param {deriveOptions} props Options to be used by algorithm, defined in `JWA.deriveOptions`. + * @returns {Promise} The stronger key material + */ + function derive(alg: string, key: string | Buffer, props?: deriveOptions): Promise; + + /** + * Create a hash of `data` using the algorithm `alg` if implemented. + * + * @param {string} alg The algorithm to use + * @param {(string | Buffer)} data The data to hash + * @param {*} props Unused at this time, left for future implementations + * @returns {Promise} The hash + */ + function digest(alg: string, data: string | Buffer, props?: any): Promise; + + /** + * Run the encryption algorithm given by `alg`, if it is supported by the implementation. + * + * @param {string} alg The algorithm to use + * @param {(string | Buffer)} key The encryption key + * @param {(string | Buffer)} pdata The plaintext + * @param {encryptOptions} props Options used by the specified algorithm in `JWA.decryptEncryptOptions`. + * @returns {Promise} The ciphertext in `data` field, `tag` field included if in algorithm. + */ + function encrypt(alg: string, key: string | Buffer, pdata: string | Buffer, props?: decryptEncryptOptions): Promise; + + /** + * Sign `pdata` with the request algorithm if supported. + * + * @param {string} alg The algorithm to use + * @param {(string | Buffer)} key The signing key + * @param {(string | Buffer)} pdata The data to add integrity to + * @param {signOptions} props Options used by the algorithm as defined in `JWA.signVerifyOptions` + * @returns {Promise} The signature is in the `mac` field. + */ + function sign(alg: string, key: string | Buffer, pdata: string | Buffer, props: signVerifyOptions): Promise; + + /** + * Verify the data in `pdata` is valid by using `key` and `mac`. + * + * @param {string} alg The algorithm to use + * @param {(string | Buffer)} key The verifying key + * @param {(string | Buffer)} pdata The signed data to verify + * @param {(string | Buffer)} mac The signature as previously returned via the `sign` function + * @param {signVerifyOptions} props Options used by the algorithm as defined in `JWA.signVerifyOptions` + * @returns {Promise; +} + +/** + * Contains all the encrypton tools for JWTs. + */ +export module JWE { + + /** + * Used to customize decryption processes. The following options are currently + * supported: + * + * @property {} handlers An object where each name is a JOSE header member name and + * the value can be a boolean, function, or an object. + * + * Handlers are intended to support 'crit' extensions. When a boolean value, + * the member is expected to be processed once decryption is fully complete. + * When a function, it is called just before the ciphertext is decrypted + * (processed as if it were a `prepare` handler, as decribed in `decryptCritProcessors`). + * Note that normal processing of `decrypt()` does not continue until all + * relevant handlers have completed. Any changes handlers make to the + * provided objects affects `decrypt()`'s processing. + */ + type decryptCritHeaderOptions = { + handlers: { [crit_header: string]: boolean | Function | decryptCritProcessors } + }; + + /** + * For the critical header processing, the options may include an object like this, + * which defines these fields to run at various times of decryption processing. + * @property {Function} recipient A function called after a valid key is + * determined; it takes an object describing the recipient, and + * returns a Promise that is fulfilled once the handler's processing + * is complete. + * @property {Function} prepare A function called just prior to decrypting + * the ciphertext; it takes an object describing the decryption + * result (but containing `ciphertext` and `tag' instead of `payload` + * and `plaintext`), and returns a Promise that is fulfilled once + * the handler's processing is complete. + * @property {Function} complete A function called once decryption is complete, + * just prior to fulfilling the Promise returned by `decrypt()`; it + * takes the object that will be returned by `decrypt()`'s fulfilled + * Promise, and returns a Promise that is fulfilled once the handler's + * processing is complete. + */ + type decryptCritProcessors = { + recipient?: Function, + prepare?: Function, + complete?: Function + }; + + /** + * Object that defines the output that is given from the `decrypt()` function + * of a `Decryptor`. + * + * @property {any} header The JOSE Header, combined from the relevant "header" and + * "protected" fields from the original JWE object. + * @property {string[]} protected An array containing the names of the protected fields + * @property {JWK.Key} key The used to decrypt the content + * @property {Buffer} payload The decrypted content (as a Buffer) + * @property {Buffer} plaintext An alias for `payload` + */ + type decryptReturn = { + header: any, + protected: string[], + key: JWK.Key, + payload: Buffer, + plaintext: Buffer + }; + + /** + * The options for {@link createEncrypt}. + * + * @property {boolean|string} zip Determines the compression algorithm to + * apply to the plaintext (if any) before it is encrypted. This can + * also be `true` (which is equivalent to `"DEF"`) or **`false`** + * (the default, which is equivalent to no compression). + * @property {string} format Determines the serialization format of the + * output. Expected to be `"general"` for general JSON + * Serialization, `"flattened"` for flattened JSON Serialization, + * or `"compact"` for Compact Serialization (default is + * **`"general"`**). + * @property {boolean} compact Determines if the output is the Compact + * serialization (`true`) or the JSON serialization (**`false`**, + * the default). + * @property {string} contentAlg The algorithm used to encrypt the plaintext + * (default is **`"A128CBC-HS256"`**). + * @property {string|string[]} protect The names of the headers to integrity + * protect. The value `""` means that none of the header parameters + * are integrity protected, while `"*"` (the default) means that all + * header parameters are integrity protected. + * @property {object} fields Any extra fields to include in the JWT. + * @property {string} aad Additional authenticated data to include + * @property {string} cek A content encryption key for the underlying algorithm + * @property {string} iv An init vector for the underlying algorithm. + */ + type encOpts = { + zip?: boolean | string, + format?: string, + compact?: boolean, + contentAlg?: string, + protect?: string | string[], + fields?: any, + aad?: string, + cek?: string, + iv?: string + }; + + /** + * Factory function that reates a new Decrypter for the given Key or KeyStore. + * + * @param {(JWK.KeyStore|JWK.Key)} ks The Key or KeyStore to use for decryption. + * @param {decryptCritHeaderOptions} [opts] The options for this decryptor. + * @returns {Decrypter} The new Decryptor. + */ + function createDecrypt(ks: JWK.KeyStore | JWK.Key, opts?: decryptCritHeaderOptions): Decrypter; + + /** + * Factory function to create `Encrypter`s. See doc for opts and return for more info. + * + * @param {enc_opts} opts The options used to create the Encrypter. + * @param {(JWK.Key|JWK.Key[]|{key: JWK.Key}|{key: JWK.Key}[])} rcpts The recipient list for the JWT + * @returns {Encrypter} An object that can perform actions turning JWTs into JWEs. + */ + function createEncrypt(opts: encOpts, rcpts: JWK.Key | JWK.Key[] | { key: JWK.Key } | { key: JWK.Key }[]): Encrypter; + function createEncrypt(rcpts: JWK.Key | JWK.Key[] | { key: JWK.Key } | { key: JWK.Key }[]): Encrypter; + + /** + * @class Decrypter + * @classdesc + * Processor of encrypted data. + * + * @description + * **NOTE:** This class cannot be instantiated directly. Instead + * call {@link createDecrypt}. + */ + interface Decrypter { + + /** + * Decrypts the given input. + * + * {opts}, if provided, is used to customize this specific decrypt operation. + * This argument has the same semantics as {JWE.createDecrypt}, and takes + * precedence over those options. + * + * @param {object|string} input The encrypted content + * @param {decryptCritHeaderOptions} [opts] The options for this decryption operation. + * @returns {Promise} A promise for the decyprted plaintext + * @memberOf Decrypter + */ + decrypt(input: object | string, opts?: decryptCritHeaderOptions): Promise; + } + + /** + * @class Encrypter + * @classdesc + * Generator of encrypted data. + * + * @description + * **NOTE:** This class cannot be instantiated directly. Instead call + * {@link createEncrypt}. + */ + interface Encrypter { + /** + * Indicates the compression algorithm applied to the plaintext + * before it is encrypted. The possible values are: + * + * + **`"DEF"`**: Compress the plaintext using the DEFLATE algorithm. + * + **`""`**: Do not compress the plaintext. + * + * @type {string} + * @memberOf Encrypter + * @readonly + */ + zip: string; + + /** + * Indicates whether the output of this encryption generator is + * using the Compact serialization (`true`) or the JSON + * serialization (`false`). + * + * @type {boolean} + * @memberOf Encrypter + * @readonly + */ + compact: boolean; + + /** + * Indicates the format the output of this encryption generator takes. + * + * @type {string} + * @memberOf Encrypter + * @readonly + */ + format: string; + + /** + * The header parameter names that are protected. Protected header fields + * are first serialized to UTF-8 then encoded as util.base64url, then used as + * the additional authenticated data in the encryption operation. + * + * @type {string[]} + * @memberOf Encrypter + * @readonly + */ + protected: string[]; + + /** + * The global header parameters, both protected and unprotected. Call + * {@link Encrypter#protected} to determine which parameters will + * be protected. + * + * @type {object} + * @memberOf Encrypter + * @readonly + */ + header: object; + + /** + * Updates the plaintext data for the encryption generator. The plaintext + * is appended to the end of any other plaintext already applied. + * + * If {data} is a Buffer, {encoding} is ignored. Otherwise, {data} is + * converted to a Buffer internally to {encoding}. + * + * @param {(Buffer|string)} [data] The plaintext to apply. + * @param {string} [encoding] The encoding of the plaintext. + * @returns {Encrypter} This encryption generator. + * @throws {Error} If ciphertext has already been generated. + * @memberOf Encrypter + */ + update(data?: Buffer | string, encoding?: string): Encrypter; + + /** + * Finishes the encryption operation. + * + * The returned Promise, when fulfilled, is the JSON Web Encryption (JWE) + * object, either in the Compact (if {@link Encrypter#compact} is + * `true`) or the JSON serialization. + * + * @param {(Buffer|string)} [data] The final plaintext data to apply. + * @param {string} [encoding] The encoding of the final plaintext data (if any). + * @returns {(Promise)} A promise for the encryption operation. + * @throws {Error} If ciphertext has already been generated. + * @memberOf Encrypter + */ + final(data?: Buffer | string, encoding?: string): Promise; + } +} + +/** + * Tools for creating and manipulating keys and keystores. + */ +export module JWK { + + /** + * The following constants are used to select the different modes for + * operation, their names are self-explanatory. + */ + const MODE_DECRYPT: string; + const MODE_ENCRYPT: string; + const MODE_SIGN: string; + const MODE_UNWRAP: string; + const MODE_VERIFY: string; + const MODE_WRAP: string; + + // These are copied in code directly from KeyStore statics, don't know + // how to mimic that in d.ts, so for now they're copy pasta. Also, the javadoc will be + // on these defitions as the actual library will not usually have you executing the static + // methods themselves (e.g. you'll do JWK.asKey instead of JWK.KeyStore.asKey()). + /** + * Coerces the given object into a Key. If {key} is an instance of JWK.Key, + * it is returned directly. Otherwise, this method first creates a new + * JWK.KeyStore and calls {@link KeyStore#add} on this new KeyStore. + * + * @param {(object|string)} key The value to coerce into a Key + * @param {string} [form] The format of a String Key to expect + * @param {object} [extras] extra jwk fields inserted when importing from a non json string (eg "pem") + * @returns {Promise} A promise for the coerced Key. + */ + function asKey(key: object | string, form?: string, extras?: object): Promise; + + /** + * Coerces the given object into a KeyStore. This method uses the following + * algorithm to coerce {ks}: + * + * 1. if {ks} is an instance of JWK.KeyStore, it is returned directly + * 2. if {ks} is a string, it is parsed into a JSON value + * 3. if {ks} is an array, it creates a new JWK.KeyStore and calls {@link + * JWK.KeyStore#add} for each element in the {ks} array. + * 4. if {ks} is a JSON object, it creates a new JWK.KeyStore and calls {@link + * JWK.KeyStore#add} for each element in the "keys" property. + * + * @param {object|string} ks The value to coerce into a KeyStore + * @returns {Promise} A promise for the coerced KeyStore. + */ + function asKeyStore(ks: object | string): Promise; + + /** + * Creates a new empty KeyStore. + * + * @returns {JWK.KeyStore} The empty KeyStore. + */ + function createKeyStore(): JWK.KeyStore; + + /** + * Determines if the given object is a JWK.Key instance. + * + * @param {object} obj The object to test + * @returns {boolean} `true` if {obj} is a JWK.Key + */ + function isKey(obj: any): boolean; + + /** + * Determines if the given object is an instance of JWK.KeyStore. + * + * @param {*} obj The object to test + * @returns {boolean} `true` if {obj} is an instance of JWK.KeyStore, + * and `false` otherwise. + */ + function isKeyStore(obj: any): boolean; + + /** + * Options that can be used for searching a keystore for specific keys. + */ + type KS_search_props = { alg?: string, use?: string, kid?: string, kty?: string }; + + /** + * @class JWK.KeyStore + * @classdesc + * Represents a collection of Keys. + * + * @description + * **NOTE:** This constructor cannot be called directly. Instead call {@link + * JWK.createKeyStore}. + */ + interface KeyStore { + /** + * @method JWK.KeyStore#add + * @description + * Adds a Key to this KeyStore. If {jwk} is a string, it is first + * parsed into a plain JSON object. If {jwk} is already an instance + * of JWK.Key, its (public) JSON representation is first obtained + * then applied to a new JWK.Key object within this KeyStore. + * + * @param {(string|JWK.Key|object)} key The JSON Web Key (JWK) + * @param {string} [form] The formate of a string key to expect + * @param {*} [extras] extra jwk fields inserted when importing from a non json string (eg "pem") + * @returns {Promise} The promise for the added key + * + * @memberOf KeyStore + */ + add(key: string | JWK.Key | object, form?: string, extras?: any): Promise; + + /** + * Retrieves all of the contained Keys that optinally match all of the + * given properties. + * + * If {props} are specified, this method only returns Keys which exactly + * match the given properties. The properties can be any of the + * following: + * + * + **alg**: The algorithm for the Key. + * + **use**: The usage for the Key. + * + **kid**: The identifier for the Key. + * + * If no properties are given, this method returns all of the Keys for this + * KeyStore. + * + * @param {JWK.KS_search_props} [props] The properties to match against + * @param {boolean} [local = false] `true` if only the Keys + * directly contained by this KeyStore should be returned, or + * `false` if it should return all Keys of this KeyStore and + * its ancestors. + * @returns {JWK.Key[]} The list of matching Keys, or an empty array if no + * matches are found. + * + * @memberOf KeyStore + */ + all(props?: JWK.KS_search_props, local?: boolean): JWK.Key[]; + + /** + * @method JWK.KeyStore#generate + * @description + * Generates a new random Key into this KeyStore. + * + * The type of {size} depends on the value of {kty}: + * + * + **`EC`**: String naming the curve to use, which can be one of: + * `"P-256"`, `"P-384"`, or `"P-521"` (default is **`"P-256"`**). + * + **`RSA`**: Number describing the size of the key, in bits (default is + * **`2048`**). + * + **`oct`**: Number describing the size of the key, in bits (default is + * **`256`**). + * + * Any properties in {props} are applied before the key is generated, + * and are expected to be data types acceptable in JSON. This allows the + * generated key to have a specific key identifier, or to specify its + * acceptable usage. + * + * The returned Promise, when fulfilled, returns the generated Key. + * + * @param {string} kty The type of generated key + * @param {(string|number)} [size] The size of the generated key + * @param {*} [props] Additional properties to apply to the generated + * key. + * @returns {Promise} The promise for the generated Key + * @throws {Error} If {kty} is not supported + * + * @memberOf KeyStore + */ + generate(kty: string, size?: string | number, props?: any): Promise; + + /** + * Retrieves the contained Key matching the given {kid}, and optionally + * all of the given properties. This method equivalent to calling + * {@link JWK.Store#all}, then returning the first Key whose + * "kid" is {kid}. If {kid} is undefined, then the first Key that + * is returned from `all()` is returned. + * + * @param {String} [kid] + * @param {object} [props] + * @param {Boolean} [local = false] + * @returns {JWK.Key} + * + * @param {string} [kid] The key identifier to match against. + * @param {JWK.KS_search_props} [props] The properties to match against. + * @param {boolean} [local = false] `true` if only the Keys + * directly contained by this KeyStore should be returned, or + * `false` if it should return all Keys of this KeyStore and + * its ancestors. + * @returns {JWK.Key} The Key matching {kid} and {props}, or `null` + * if no match is found. + * + * @memberOf KeyStore + */ + get(kid?: string, props?: JWK.KS_search_props, local?: boolean): JWK.Key; + get(props?: JWK.KS_search_props, local?: boolean): JWK.Key; + + /** + * @method JWK.KeyStore#remove + * @description + * Removes a Key from this KeyStore. + * + * **NOTE:** The removed Key's {keystore} property is not changed. + * + * @param {JWK.Key} key The key to remove. + * + * @memberOf KeyStore + */ + remove(key: JWK.Key): void; + + /** + * @method JWK.KeyStore#temp + * @description + * Creates a temporary KeyStore based on this KeyStore. + * + * @returns {JWK.KeyStore} The temporary KeyStore. + * + * @memberOf KeyStore + */ + temp(): JWK.KeyStore; + + /** + * @method JWK.KeyStore#toJSON + * @description + * Generates a JSON representation of this KeyStore, which conforms + * to a JWK Set from {I-D.ietf-jose-json-web-key}. + * + * @param {boolean} [isPrivate = false] `true` if the private fields + * of stored keys are to be included. + * @returns {*} The JSON representation of this KeyStore. + * + * @memberOf KeyStore + */ + toJSON(isPrivate?: boolean): any; + } + + // The below functions are technically defined as static functions on the KeyStore class, + // and then copied to the exports for the JWK module. See the documentation above for their + // use, but they are here just for completion sake, but commented out as you should use them + // from the module as intended. + /* + var KeyStore: { + asKey(key: object|string, form: string, extras: object): Promise; + asKeyStore(ks: any): Promise; + createKeyStore(): JWK.KeyStore; + isKey(obj: any): boolean; + isKeyStore(obj: any): boolean; + } + */ + + /** + * @class JWK.Key + * @classdesc + * Represents a JSON Web Key instance. + * + * @description + * **NOTE:** This class cannot be instantiated directly. Instead call + * {@link JWK.asKey}, {@link JWK.KeyStore#add}, or + * {@link JWK.KeyStore#generate}. + */ + interface Key { + + /** + * @member {String} JWK.Key#alg + * @description + * The sole algorithm this key can be used for. + * + * @type {string} + * @memberOf Key + */ + alg: string; + + /** + * @member {JWK.KeyStore} JWK.Key#keystore + * @description + * The owning keystore. + * + * @type {JWK.KeyStore} + * @memberOf Key + */ + keystore: JWK.KeyStore; + + /** + * @member {string} JWK.Key#kid + * @description + * The identifier for this Key. + * + * @type {string} + * @memberOf Key + */ + kid: string; + + /** + * @member {string} JWK.Key#kty + * @description + * The type of Key. + * + * @type {string} + * @memberOf Key + */ + kty: string; + + /** + * @member {number} JWK.Key#length + * @description + * The size of this Key, in bits. + * + * @type {number} + * @memberOf Key + */ + length: number; + + /** + * @member {String} JWK.Key#use + * @description + * The usage for this Key. + * + * @type {string} + * @memberOf Key + */ + use: string; + + /** + * @method JWK.Key#algorithms + * @description + * The possible algorithms this Key can be used for. The returned + * list is not any particular order, but is filtered based on the + * Key's intended usage. + * + * @param {string} mode The operation mode, see the MODE_* JWK constants. + * @returns {string[]} The list of supported algorithms + * @see JWK.Key#supports + * @memberOf Key + */ + algorithms: (mode: string) => string[]; + + /** + * @method JWK.Key#decrypt + * @description + * Decrypts the given data using the specified algorithm. + * + * **NOTE:** This is the primitive decryption operation; the input is + * _**NOT**_ a JSON Web Encryption (JWE) object. + * + * **NOTE:** This operation is treated as distinct from {@link + * JWK.Key#unwrap}, as different algorithms and properties are often used + * for unwrapping a key versues decrypting arbitrary data. + * + * The Promise, when fulfilled, returns the plaintext data. + * + * @param {String} alg The decryption algorithm. + * @param {Buffer|String} data The data to decypt. + * @param {object} [props] Additional data for the decryption operation. + * @returns {Promise} The promise for the decryption operation. + * @throws {Error} If {alg} is not appropriate for this Key; or if + * the Key does not contain the appropriate properties. + * + * + * @memberOf Key + */ + decrypt: (alg: string, data: string | Buffer, props?: any) => Promise; + + /** + * @method JWK.Key#encrypt + * @description + * Encrypts the given data using the specified algorithm. + * + * **NOTE:** This is the primitive encryption operation; the output is + * _**NOT**_ a JSON Web Encryption (JWE) object. + * + * **NOTE:** This operation is treated as distinct from {@link + * JWK.Key#wrap}, as different algorithms and properties are often + * used for wrapping a key versues encrypting arbitrary data. + * + * The Promise, when fulfilled, returns an object with the following + * properties: + * + * + **data**: The ciphertext data + * + **mac**: The associated message authentication code (MAC). + * + * @param {String} alg The encryption algorithm + * @param {Buffer|String} data The data to encrypt + * @param {object} [props] Additional properties for the encryption + * algorithm. + * @returns {Promise} The promise for the encryption operation. + * @throws {Error} If {alg} is not appropriate for this Key; or if + * this Key does not contain the appropriate parameters. + * + * + * @memberOf Key + */ + encrypt: (alg: string, data: string | Buffer, props?: any) => Promise; + + /** + * @method JWK.Key#get + * @description + * Retrieves the value of the given parameter. The value returned by this + * method is in its natural format, which might not exactly match its + * JSON encoding (e.g., a binary string rather than a base64url-encoded + * string). + * + * **NOTE:** This method can return `false`. Call + * {@link JWK.Key#has} to determine if the parameter is present. + * + * @param {String} name The name of the parameter + * @param {Boolean} [isPrivate=false] `true` if private parameters should + * be checked. + * @returns {any} The value of the named parameter, or undefined if + * it is not present. + * + * + * @memberOf Key + */ + get: (name: string, isPrivate?: boolean) => any; + + /** + * @method JWK.Key#has + * @description + * Determines if this Key contains the given parameter. + * + * @param {string} name The name of the parameter + * @param {boolean} [isPrivate=false] `true` if private parameters should be + * checked. + * @returns {boolean} `true` if the given parameter is present; `false` + * otherwise. + * @memberOf Key + */ + has: (name: string, isPrivate?: boolean) => boolean; + + /** + * @method JWK.Key#sign + * @description + * Sign the given data using the specified algorithm. + * + * **NOTE:** This is the primitive signing operation; the output is + * _**NOT**_ a JSON Web Signature (JWS) object. + * + * The Promise, when fulfilled, returns an object with the following + * properties: + * + * + **data**: The data that was signed (and should be equal to {data}). + * + **mac**: The signature or message authentication code (MAC). + * + * @param {String} alg The signing algorithm + * @param {String|Buffer} data The data to sign + * @param {object} [props] Additional properties for the signing + * algorithm. + * @returns {Promise} The promise for the signing operation. + * @throws {Error} If {alg} is not appropriate for this Key; or if + * this Key does not contain the appropriate parameters. + * @memberOf Key + */ + sign: (alg: string, data: string | Buffer, props?: any) => Promise; + + /** + * @method JWK.Key#supports + * @description + * Determines if the given algorithm is supported. + * + * @param {String} alg The algorithm in question + * @param {String} [mode] The operation mode + * @returns {Boolean} `true` if {alg} is supported, and `false` otherwise. + * @see JWK.Key#algorithms + * @memberOf Key + */ + supports: (alg: string, mode?: string) => boolean; + + /** + * Generates the thumbprint of this Key. + * + * @param {String} [hash] The hash algorithm to use + * @returns {Promise} The promise for the thumbprint generation. + * @memberOf Key + */ + thumbprint: (hash?: string) => Promise; + + /** + * @method JWK.Key#toJSON + * @description + * Returns the JSON representation of this Key. All properties of the + * returned JSON object are properly encoded (e.g., base64url encoding for + * any binary strings). + * + * @param {Boolean} [isPrivate=false] `true` if private parameters should be + * included. + * @param {String[]} [excluded] The list of parameters to exclude from + * the returned JSON. + * @returns {object} The plain JSON object + * + * + * @memberOf Key + */ + toJSON: (isPrivate?: boolean, excluded?: string[]) => object; + + /** + * @method JWK.Key#toObject + * @description + * Returns the plain object representing this Key. All properties of the + * returned object are in their natural encoding (e.g., binary strings + * instead of base64url encoded). + * + * @param {Boolean} [isPrivate=false] `true` if private parameters should be + * included. + * @param {String[]} [excluded] The list of parameters to exclude from + * the returned object. + * @returns {object} The plain object. + * + * + * @memberOf Key + */ + toObject: (isPrivate?: boolean, excluded?: string[]) => object; + + /** + * @method JWK.Key#toPEM + * @description + * Returns the PEM representation of this Key as a string. + * + * @param {Boolean} [isPrivate=false] `true` if private parameters should be + * included. + * @returns {string} The PEM-encoded string + * @memberOf Key + */ + toPEM: (include_priv?: boolean) => string; + + /** + * @method JWK.Key#unwrap + * @description + * Unwraps the given key using the specified algorithm. + * + * **NOTE:** This is the primitive unwrap operation; the input is + * _**NOT**_ a JSON Web Encryption (JWE) object. + * + * **NOTE:** This operation is treated as distinct from {@link + * JWK.Key#decrypt}, as different algorithms and properties are often used + * for unwrapping a key versues decrypting arbitrary data. + * + * The Promise, when fulfilled, returns the unwrapped key. + * + * @param {String} alg The unwrap algorithm. + * @param {Buffer|String} data The data to unwrap. + * @param {object} [props] Additional data for the unwrap operation. + * @returns {Promise} The promise for the unwrap operation. + * @throws {Error} If {alg} is not appropriate for this Key; or if + * the Key does not contain the appropriate properties. + * @memberOf Key + */ + unwrap: (alg: string, data: string | Buffer, props?: any) => Promise; + + /** + * @method JWK.Key#verify + * @description + * Verify the given data and signature using the specified algorithm. + * + * **NOTE:** This is the primitive verification operation; the input is + * _**NOT**_ a JSON Web Signature.

+ * + * The Promise, when fulfilled, returns an object with the following + * properties: + * + * + **data**: The data that was verified (and should be equal to + * {data}). + * + **mac**: The signature or MAC that was verified (and should be equal + * to {mac}). + * + **valid**: `true` if {mac} is valid for {data}. + * + * @param {String} alg The verification algorithm + * @param {String|Buffer} data The data to verify + * @param {String|Buffer} mac The signature or MAC to verify + * @param {object} [props] Additional properties for the verification + * algorithm. + * @returns {Promise} The promise for the verification operation. + * @throws {Error} If {alg} is not appropriate for this Key; or if + * the Key does not contain the appropriate properties. + * + * + * @memberOf Key + */ + verify: (alg: string, data: string | Buffer, mac: string | Buffer, props?: any) => Promise; + + /** + * @method JWK.Key#wrap + * @description + * Wraps the given key using the specified algorithm. + * + * **NOTE:** This is the primitive encryption operation; the output is + * _**NOT**_ a JSON Web Encryption (JWE) object. + * + * **NOTE:** This operation is treated as distinct from {@link + * JWK.Key#encrypt}, as different algorithms and properties are + * often used for wrapping a key versues encrypting arbitrary data. + * + * The Promise, when fulfilled, returns an object with the following + * properties: + * + * + **data**: The ciphertext data + * + **headers**: The additional header parameters to apply to a JWE. + * + * @param {String} alg The encryption algorithm + * @param {Buffer|String} data The data to encrypt + * @param {object} [props] Additional properties for the encryption + * algorithm. + * @returns {Promise} The promise for the encryption operation. + * @throws {Error} If {alg} is not appropriate for this Key; or if + * this Key does not contain the appropriate parameters. + * @memberOf Key + */ + wrap: (alg: string, data: string | Buffer, props?: any) => Promise; + } +} + +/** + * Contains all the signing tools for JWTs. + */ +export module JWS { + + /** + * @property {Boolean} [compact] Use compact serialization? + * @property {String} [format] The serialization format to use ("compact", + * "flattened", "general") + * @property {object} [fields] Additional header fields + * @property {"*" | string[]} [protect] which headers to protect, "*" for all headers. + */ + type signOpts = { + alg?: string, + compact?: boolean, + format?: string, + fields?: object, + protect?: "*" | string[] + }; + + /** + * @property {JWK.Key} key Key used to sign content + * @property {object} [header] Per-signatory header fields + * @property {String} [reference] Reference field to identify the key + * @property {"*" | string[]} [protect] List of fields to integrity + * protect ("*" to protect all fields) + */ + type signSignatory = { + key: JWK.Key, + header?: object, + reference?: string, + protect?: "*" | string[] + }; + + /** + * Used to customize verification processes. The following options are currently + * supported: + * + * @property {} handlers An object where each name is a JOSE header member name and + * the value can be a boolean, function, or an object. + * + * Handlers are intended to support 'crit' extensions. When a boolean value, + * the member is expected to be processed once verification is fully complete. + * When a function, it is called just before the input is verified. + * (processed as if it were a `prepare` handler, as decribed in `verifyCritProcessors`). + * Note that normal processing of `verify()` does not continue until all + * relevant handlers have completed. Any changes handlers make to the + * provided objects affects `verify()`'s processing. + */ + type verifyOptions = { + handlers: { [crit_header: string]: boolean | Function | verifyCritProcessors } + }; + + /** + * For the critical header processing, the options may include an object like this, + * which defines these fields to run at various times of verification processing. + * @property {Function} recipient A function called after a valid key is + * determined; it takes an object describing the recipient, and + * returns a Promise that is fulfilled once the handler's processing + * is complete. + * @property {Function} prepare A function called just prior to verifying + * the input; it takes an object describing the verification + * result, and returns a Promise that is fulfilled once + * the handler's processing is complete. + * @property {Function} complete A function called once verification is complete, + * just prior to fulfilling the Promise returned by `verify()`; it + * takes the object that will be returned by `verify()`'s fulfilled + * Promise, and returns a Promise that is fulfilled once the handler's + * processing is complete. + */ + type verifyCritProcessors = { + recipient?: Function, + prepare?: Function, + complete?: Function + }; + + /** + * Object that defines the output that is given from the `verify()` function + * of a `Verifier`. + * + * @property {any} header The JOSE Header, combined from the relevant "header" and + * "protected" fields from the original JWE object. + * @property {JWK.Key} key The Key used for verifying. + * @property {Buffer} payload The verified content (as a Buffer) + * @property {string[]} protected An array containing the names of the protected fields + * @property {Buffer} signature The data that was used to verify payload with key. + */ + type verifyReturn = { + header: object, + key: JWK.Key, + payload: Buffer, + protected: string[], + signature: Buffer + } + + /** + * Creates a new JWS.Signer with the given options and signatories. + * + * @param {signOpts} opts The signing options. + * @param {(JWK.Key|JWK.Key[]|signSignatory[])} signs Signatories, either as an array of + * JWK.Key instances; or an array of signing signatory objects. + * @returns {Signer} The signature generator. + * @throws {Error} If Compact serialization is requested but there are + * multiple signatories + */ + function createSign(opts: signOpts, signs: JWK.Key | JWK.Key[] | signSignatory[]): Signer; + function createSign(signs: JWK.Key | JWK.Key[] | signSignatory[]): Signer; + + /** + * @description + * Creates a new JWS.Verifier with the given Key or KeyStore. + * + * @param {JWK.Key|JWK.KeyStore} ks The Key or KeyStore to use for verification. + * @returns {Verifier} The new verifier. + */ + function createVerify(ks?: JWK.Key | JWK.KeyStore, opts?: verifyOptions): Verifier; + + /** + * @class JWS.Signer + * @classdesc Generator of signed content. + * + * @description + * **NOTE:** this class cannot be instantiated directly. Instead call {@link + * JWS.createSign}. + */ + interface Signer { + + /** + * @member {Boolean} JWS.Signer#compact + * @description + * Indicates whether the outuput of this signature generator is using + * the Compact serialization (`true`) or the JSON serialization + * (`false`). + * + * @type {boolean} + * @memberOf Signer + */ + compact: boolean; + + /** + * @member {string} JWS.Signer#format + * @description + * The serialization format to use ("compact", + * "flattened", "general") + * @memberOf Signer + */ + format: string; + + /** + * @method JWS.Signer#update + * @description + * Updates the signing content for this signature content. The content + * is appended to the end of any other content already applied. + * + * If {data} is a Buffer, {encoding} is ignored. Otherwise, {data} is + * converted to a Buffer internally to {encoding}. + * + * @param {Buffer|String} data The data to sign. + * @param {String} [encoding="binary"] The encoding of {data}. + * @returns {Signer} This signature generator. + * @throws {Error} If a signature has already been generated. + * @memberOf Signer + */ + update(data?: Buffer | string, encoding?: string): Signer; + + /** + * @method JWS.Signer#final + * @description + * Finishes the signature operation. + * + * The returned Promise, when fulfilled, is the JSON Web Signature (JWS) + * object, either in the Compact (if {@link JWS.Signer#format} is + * `"compact"`), the flattened JSON (if {@link JWS.Signer#format} is + * "flattened"), or the general JSON serialization. + * + * @param {Buffer|String} [data] The final content to apply. + * @param {String} [encoding="binary"] The encoding of the final content + * (if any). + * @returns {Promise} The promise for the signatures + * @throws {Error} If a signature has already been generated. + * @memberOf Signer + */ + final(data?: Buffer | string, encoding?: string): Promise; + } + + /** + * @class JWS.Verifier + * @classdesc Parser of signed content. + * + * @description + * **NOTE:** this class cannot be instantiated directly. Instead call {@link + * JWS.createVerify}. + * + * @interface Verifier + */ + interface Verifier { + + /** + * If the verifier was created with a key, this key will be assumed to be + * assumed to be be the one to verify a signature, regardless of the kid of + * the JWT. + * + * @type {JWK.Key} + * @memberOf Verifier + */ + defaultKey: JWK.Key; + + /** + * The keystore that will be used to look up the `kid` from the JWT in. + * + * @type {JWK.KeyStore} + * @memberOf Verifier + */ + keystore: JWK.KeyStore; + + /** + * @method JWS.Verifier#verify + * @description + * Verifies the input JWS with one of the keys in the keystore associated with + * this verifier. + * + * @param {string} input The JWS in compact format. + * @param {verifyOptions} [opts] See verifyOptions documentation. + * @returns {Promise} See verifyReturn documentation. + * @memberOf Verifier + */ + verify(input: string, opts?: verifyOptions): Promise + } +} + +/** + * A collection of Buffer and conversion utilities. + */ +export module util { + + /** + * Converts the given input into a Buffer with the given encoding. + * + * @param {(Buffer|string|Array|ArrayBuffer|ArrayBufferView)} input + * @param {string} encoding Defaults to 'binary' + * @returns {Buffer} + */ + function asBuffer(input: Buffer | string | Array | ArrayBuffer | ArrayBufferView, encoding?: string): Buffer; + + /** + * Returns a Buffer filled with random bytes of length `len`. + * + * @param {number} len + * @returns {Buffer} + */ + function randomBytes(len: number): Buffer; + + /** + * @namespace base64url + * @description + * Provides methods to encode and decode data according to the + * base64url alphabet. + */ + module base64url { + + /** + * Decodes the input from base64url. + * + * @param {String} input The data to decode. + * @returns {Buffer} the base64url decoding of {input}. + */ + function decode(input: string): Buffer; + + /** + * Encodes the input to base64url. + * + * If {input} is a Buffer, then {encoding} is ignored. Otherwise, + * {encoding} can be one of "binary", "base64", "hex", "utf8". + * + * @param {(Buffer|string)} input The data to encode. + * @param {string} [encoding = binary] The input encoding format. + * @returns {string} the base64url encoding of {input}. + */ + function encode(input: Buffer | string, encoding?: string): string; + } + + /** + * @namespace utf8 + * @description + * Provides methods to encode and decode data as utf8. + */ + module utf8 { + + /** + * Decodes the input from utf8. + * + * @param {string} input The data to decode. + * @returns {string} the utf8 decoding of {input}. + */ + function decode(input: string): string; + + /** + * Encodes the input as utf8 + * + * @param {string} input the data to encode. + * @returns {string} the ut8 encoding of {input}. + */ + function encode(input: string): string; + } +} + +/** + * Possible return value from the parse function. The values inside the return + * depend heavily on the type of JWT that is passed into it. + * @property {string} type Defines whether the JWT was a "JWS" or a "JWE" + * @property {string} format Whether the JWT was in compact or JSON format + * @property {Buffer|string|object} input The JWT + * @property {object} header All of the headers from the recipients or signatories. + * @property {function} perform The operation to perform. After calling parse, call the + * `perform` function from the return with a valid keystore to verify or decrypt the JWT. + */ +type parseCompactReturn = { + type: "JWS" | "JWE", + format: "compact" | "json", + input: Buffer | string | object, + header: object, + perform: (ks: JWK.KeyStore) => Promise | Promise +}; + +/** + * Possible return value from the parse function. The values inside the return + * depend heavily on the type of JWT that is passed into it. + * @property {string} type Defines whether the JWT was a "JWS" or a "JWE" + * @property {string} format Whether the JWT was in compact or JSON format + * @property {Buffer|string|object} input The JWT + * @property {object} all All of the headers from the recipients or signatories. + * @property {function} perform The operation to perform. After calling parse, call the + * `perform` function from the return with a valid keystore to verify or decrypt the JWT. + */ +type parseJSONReturn = { + type: "JWS" | "JWE", + format: "compact" | "json", + input: Buffer | string | object, + all: object, + perform: (ks: JWK.KeyStore) => Promise | Promise +}; + +/** + * Given a JWT passed in as input, the function will return all the known data about + * the JWT as described in the return documentation, as well as a function to process + * the token (either verify it or decrypt it). This is a helper function that performs + * guessing logic so the user does not need to manage whether a token is compact, json, + * JWS, or JWE. + * + * @param {Buffer|string|object} input The token + * @returns {parseCompactReturn|parseJSONReturn} the return object, as defined by its documentation. + */ +export function parse(input: Buffer | string | object): parseCompactReturn | parseJSONReturn; +export namespace parse { + + /** + * A helper function for `parse`, but is available for usage. This function is called + * for JWTs in the compact format. + * + * @param {Buffer|string|object} input The token + * @returns {parseCompactReturn|parseJSONReturn} the return object, as defined by its documentation. + */ + function compact(input: Buffer | string | object): parseCompactReturn | parseJSONReturn; + + /** + * A helper function for `parse`, but is available for usage. This function is called + * for JWTs in the JSON format. + * + * @param {Buffer|string|object} input The token + * @returns {parseCompactReturn|parseJSONReturn} the return object, as defined by its documentation. + */ + function json(input: Buffer | string | object): parseCompactReturn | parseJSONReturn; +} diff --git a/node-jose/node-jose-tests.ts b/node-jose/node-jose-tests.ts new file mode 100644 index 0000000000..fa43a262a9 --- /dev/null +++ b/node-jose/node-jose-tests.ts @@ -0,0 +1,388 @@ +/* + * Test file for node-jose. At this time these tests were taken verbatim + * from the documentation on the NPM page at + * https://www.npmjs.com/package/node-jose + * This file definitely needs to be cleaned up and more tests added to + * test the entirety of the definition file. + */ + +import * as jose from 'node-jose'; + +let keystore = jose.JWK.createKeyStore(); +let buf = new Buffer('a'); + +jose.JWK.asKeyStore("{key: somekey}"). + then(function (result) { + // {result} is a jose.JWK.KeyStore + keystore = result; + }); + +let output = keystore.toJSON(); +output = keystore.toJSON(true); + +// by 'kid' +let kid: string = "someID"; +let key = keystore.get(kid); + +// ... and by 'kty' +key = keystore.get(kid, { kty: 'RSA' }); + +// ... and by 'use' +key = keystore.get(kid, { use: 'enc' }); + +// ... and by 'alg' +key = keystore.get(kid, { use: 'RSA-OAEP' }); + +// ... and by 'kty' and 'use' +key = keystore.get(kid, { kty: 'RSA', use: 'enc' }); + +// same as above, but with a single {props} argument +key = keystore.get({ kid: kid, kty: 'RSA', use: 'enc' }); + + +// searching for keys +let everything = keystore.all(); + +// filter by 'kid' +everything = keystore.all({ kid: kid }); + +// filter by 'kty' +everything = keystore.all({ kty: 'RSA' }); + +// filter by 'use' +everything = keystore.all({ use: 'enc' }); + +// filter by 'alg' +everything = keystore.all({ alg: 'RSA-OAEP' }); + +// filter by 'kid' + 'kty' + 'alg' +everything = keystore.all({ kid: kid, kty: 'RSA', alg: 'RSA-OAEP' }); + +// input is either a: +// * jose.JWK.Key to copy from; or +// * JSON object representing a JWK; or +keystore.add({}). + then(function (result) { + // {result} is a jose.JWK.Key + key = result; + }); + +// input is either a: +// * String serialization of a JSON JWK/(base64-encoded) PEM/(binary-encoded) DER +// * Buffer of a JSON JWK/(base64-encoded) PEM/(binary-encoded) DER +// form is either a: +// * "json" for a JSON stringified JWK +// * "private" for a DER encoded 'raw' private key +// * "pkcs8" for a DER encoded (unencrypted!) PKCS8 private key +// * "public" for a DER encoded SPKI public key (alternate to 'spki') +// * "spki" for a DER encoded SPKI public key +// * "pkix" for a DER encoded PKIX X.509 certificate +// * "x509" for a DER encoded PKIX X.509 certificate +// * "pem" for a PEM encoded of PKCS8 / SPKI / PKIX +keystore.add(buf, "json"). + then(function (result) { + // {result} is a jose.JWK.Key + key = result; + }); + +// first argument is the key type (kty) +// second is the key size (in bits) or named curve ('crv') for "EC" +keystore.generate("oct", 256). + then(function (result) { + // {result} is a jose.JWK.Key + key = result; + }); + +// ... with properties +var props = { + kid: 'gBdaS-G8RLax2qgObTD94w', + alg: 'A256GCM', + use: 'enc' +}; +keystore.generate("oct", 256, props). + then(function (result) { + // {result} is a jose.JWK.Key + key = result; + }); + +keystore.remove(key); +// NOTE: key.keystore does not change!! + +// where input is either a: +// * jose.JWK.Key instance +// * JSON Object representation of a JWK +jose.JWK.asKey({}). + then(function (result) { + // {result} is a jose.JWK.Key + // {result.keystore} is a unique jose.JWK.KeyStore + key = result; + }); + +// where input is either a: +// * String serialization of a JSON JWK/(base64-encoded) PEM/(binary-encoded) DER +// * Buffer of a JSON JWK/(base64-encoded) PEM/(binary-encoded) DER +// form is either a: +// * "json" for a JSON stringified JWK +// * "pkcs8" for a DER encoded (unencrypted!) PKCS8 private key +// * "spki" for a DER encoded SPKI public key +// * "pkix" for a DER encoded PKIX X.509 certificate +// * "x509" for a DER encoded PKIX X.509 certificate +// * "pem" for a PEM encoded of PKCS8 / SPKI / PKIX +jose.JWK.asKey({}, 'json'). + then(function (result) { + // {result} is a jose.JWK.Key + // {result.keystore} is a unique jose.JWK.KeyStore + key = result; + }); + +output = key.toJSON(); +output = key.toJSON(true); + +// where hash is a supported algorithm, currently one of: +// * SHA-1 +// * SHA-256 +// * SHA-384 +// * SHA-512 +key.thumbprint('SHA-1'). + then(function (print) { + // {print} is a Buffer containing the thumbprint binary value + }); + +// {input} is a Buffer +jose.JWS.createSign(key). + update(buf). + final(). + then(function (result) { + // {result} is a JSON object -- JWS using the JSON General Serialization + }); + +jose.JWS.createSign({ format: 'flattened' }, key). + update(buf). + final(). + then(function (result) { + // {result} is a JSON object -- JWS using the JSON Flattened Serialization + }); + +jose.JWS.createSign({ format: 'compact' }, key). + update(buf). + final(). + then(function (result) { + // {result} is a String -- JWS using the Compact Serialization + }); + +jose.JWS.createSign({ alg: 'PS256' }, key). + update(buf). + final(). + then(function (result) { + // .... + }); + +jose.JWS.createSign({ fields: { cty: 'jwk+json' } }, key). + update(buf). + final(). + then(function (result) { + // .... + }); + +jose.JWS.createSign(key). + update(buf, "utf8"). + final(). + then(function (result) { + // .... + }); + +// {keys} is an Array of jose.JWK.Key instances +jose.JWS.createSign([key, key]). + update(buf). + final(). + then(function (result) { + // .... + }); + +jose.JWS.createVerify(keystore). + verify("some.jws.object"). + then(function (result) { + // {result} is a Object with: + // * header: the combined 'protected' and 'unprotected' header members + // * payload: Buffer of the signed content + // * signature: Buffer of the verified signature + // * key: The key used to verify the signature + }); + +// {key} can be: +// * jose.JWK.Key +// * JSON object representing a JWK +jose.JWS.createVerify(key). + verify('some.jws.object'). + then(function (result) { + // ... + }); + +jose.JWS.createVerify(). + verify('some.jws.key'). + then(function (result) { + // ... + }); + +var opts = { + handlers: { + "exp": true + } +}; + +jose.JWS.createVerify(key, opts). + verify('some.jws.key'). + then(function (result) { + // ... + }); + +var opts2 = { + handlers: { + "exp": function (jws: any) { + // {jws} is the JWS verify output, pre-verification + jws.header.exp = new Date(jws.header.exp); + } + } +}; +jose.JWS.createVerify(key, opts2). + verify('some.jws.key'). + then(function (result) { + // ... + }); + +var opts3 = { + handlers: { + "exp": { + complete: function (jws: any) { + // {jws} is the JWS verify output, post-verification + jws.header.exp = new Date(jws.header.exp); + } + } + } +}; +jose.JWS.createVerify(key, opts3). + verify('some.jws.key'). + then(function (result) { + // ... + }); + +//Encryption + +// {input} is a Buffer +jose.JWE.createEncrypt(key). + update(buf). + final(). + then(function (result) { + // {result} is a JSON Object -- JWE using the JSON General Serialization + }); + +jose.JWE.createEncrypt({ format: 'compact' }, key). + update(buf). + final(). + then(function (result) { + // {result} is a String -- JWE using the Compact Serialization + }); + +jose.JWE.createEncrypt({ format: 'flattened' }, key). + update(buf). + final(). + then(function (result) { + // {result} is a JSON Object -- JWE using the JSON Flattened Serialization + }); + +jose.JWE.createEncrypt({ zip: true }, key). + update(buf). + final(). + then(function (result) { + // .... + }); + +jose.JWE.createEncrypt({ fields: { cty: 'jwk+json' } }, key). + update(buf). + final(). + then(function (result) { + // .... + }); + +// {keys} is an Array of jose.JWK.Key instances +jose.JWE.createEncrypt([key, key]). + update(buf). + final(). + then(function (result) { + // .... + }); + +jose.JWE.createDecrypt(keystore). + decrypt('some.jwe'). + then(function (result) { + // {result} is a Object with: + // * header: the combined 'protected' and 'unprotected' header members + // * protected: an array of the member names from the "protected" member + // * key: Key used to decrypt + // * payload: Buffer of the decrypted content + // * plaintext: Buffer of the decrypted content (alternate) + }); + +jose.JWE.createDecrypt(key). + decrypt('some.jwe'). + then(function (result) { + // .... + }); + +var opts4 = { + handlers: { + "exp": true + } +}; +jose.JWE.createDecrypt(key, opts4). + decrypt('some.jwe'). + then(function (result) { + // ... + }); +//To perform additional (pre-decrypt) processing on a crit header member: + +var opts5 = { + handlers: { + "exp": function (jwe: any) { + // {jwe} is the JWE decrypt output, pre-decryption + jwe.header.exp = new Date(jwe.header.exp); + } + } +}; +jose.JWE.createDecrypt(key, opts5). + decrypt('some.jwe'). + then(function (result) { + // ... + }); +//To perform additional (post-decrypt) processing on a crit header member: + +var opts6 = { + handlers: { + "exp": { + complete: function (jwe: any) { + // {jwe} is the JWE decrypt output, post-decryption + jwe.header.exp = new Date(jwe.header.exp); + } + } + } +}; +jose.JWE.createDecrypt(key, opts6). + decrypt('some.jwe'). + then(function (result) { + // ... + }); + +var buff = jose.util.asBuffer('input'); + +var output2 = jose.util.base64url.encode(buf); + +// explicit encoding +output2 = jose.util.base64url.encode(buf, "utf8"); + +// implied "utf8" encoding +output2 = jose.util.base64url.encode(buf); + +var output3 = jose.util.base64url.decode('input'); + +// argument is size (in bytes) +var rnd = jose.util.randomBytes(32); diff --git a/node-jose/tsconfig.json b/node-jose/tsconfig.json new file mode 100644 index 0000000000..0de8c3967e --- /dev/null +++ b/node-jose/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", + "node-jose-tests.ts" + ] +} From 539308239d0da175db7577359772772d5dd48814 Mon Sep 17 00:00:00 2001 From: Jason Burns Date: Thu, 23 Mar 2017 20:22:53 -0700 Subject: [PATCH 006/844] Add TS 2.2 header as advised by Travis. --- node-jose/index.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/node-jose/index.d.ts b/node-jose/index.d.ts index d3a7fd891c..93ae198493 100644 --- a/node-jose/index.d.ts +++ b/node-jose/index.d.ts @@ -2,6 +2,7 @@ // Project: https://github.com/cisco/node-jose // Definitions by: Jason Burns // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.2 // Most of this documentation comes directly from the excellently documented // node-jose package, with only a bit added in to explain intermediate types. From 867cb974ead3360eda11a7341269d272bee2fa35 Mon Sep 17 00:00:00 2001 From: JuanFran Date: Sat, 25 Mar 2017 01:02:15 +0100 Subject: [PATCH 007/844] Support for new 3.0.3 version of moment-range --- types/moment-range/index.d.ts | 107 +++++++++++++++++------ types/moment-range/moment-range-tests.ts | 77 ++++++++++------ types/moment-range/package.json | 3 +- 3 files changed, 129 insertions(+), 58 deletions(-) diff --git a/types/moment-range/index.d.ts b/types/moment-range/index.d.ts index 7ff7feb9b8..25cc786acf 100644 --- a/types/moment-range/index.d.ts +++ b/types/moment-range/index.d.ts @@ -1,6 +1,6 @@ -// Type definitions for Moment.js 2.0.4 +// Type definitions for Moment-range.js 3.0.3 // Project: https://github.com/gf3/moment-range -// Definitions by: Bart van den Burg , Wilgert Velinga +// Definitions by: Bart van den Burg , Wilgert Velinga , Juan Francisco Adame // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped import * as moment from 'moment'; @@ -8,48 +8,99 @@ import * as moment from 'moment'; export = moment; declare module 'moment' { - interface Range { - start: Moment; - end: Moment; + class DateRange implements Range { + start: moment.Moment; + end: moment.Moment; - contains (other: Date, exclusive?: boolean): boolean; - contains (other: Moment, exclusive?: boolean): boolean; + constructor(range: string | Date[] | moment.Moment[]); + constructor(start: Date | moment.Moment, end: Date | moment.Moment); - overlaps (range: Range): boolean; - intersect (other: Range): Range; + contains(other: DateRange | moment.Moment | Date, options?: { exclusive?: boolean }): boolean; - add (other: Range): Range; + overlaps(range: DateRange, options?: { adjacent?: boolean }): boolean; - subtract (other: Range): Range[]; + intersect(other: DateRange): DateRange; - by (range: string, hollaback: (current: Moment) => void, exclusive?: boolean): void; - by (range: Range, hollaback: (current: Moment) => void, exclusive?: boolean): void; + add(other: DateRange): DateRange; - isSame (other: Range): boolean; + subtract(other: DateRange): DateRange[]; - diff (unit?: string): number; + by(interval: moment.unitOfTime.Diff, options?: { exclusive?: boolean, step?: number }): Iterable; - toDate (): Date; + byRange(interval: DateRange, options?: { exclusive?: boolean, step?: number }): Iterable; - toString (): string; + isSame(other: DateRange): boolean; - toArray (by: Range|String, exclusive?: boolean): Moment[]; + diff(unit?: moment.unitOfTime.Diff, rounded?: boolean): number; - valueOf (): number; + toDate(): Date[]; - center (): number; + toString(): string; - clone (): Range; + valueOf(): number; + + center(): moment.Moment; + + clone(): DateRange; + + isEqual(other: DateRange): boolean; + + adjacent(other: DateRange): boolean; + + duration(unit?: moment.unitOfTime.Diff, precise?: boolean): number; + + reverseBy(interval: moment.unitOfTime.Diff, options?: { exclusive?: boolean, step?: number }): Iterable; + + reverseByRange(interval: DateRange, options?: { exclusive?: boolean, step?: number }): Iterable; } - interface Moment { - within (x: moment.Range): boolean; + interface Range { + start: moment.Moment; + end: moment.Moment; + + contains(other: DateRange | moment.Moment | Date, options?: { exclusive?: boolean }): boolean; + + overlaps(range: DateRange, options?: { adjacent?: boolean }): boolean; + + intersect(other: DateRange): DateRange; + + add(other: DateRange): DateRange; + + subtract(other: DateRange): DateRange[]; + + by(interval: moment.unitOfTime.Diff, options?: { exclusive?: boolean, step?: number }): Iterable; + + byRange(interval: DateRange, options?: { exclusive?: boolean, step?: number }): Iterable; + + isSame(other: DateRange): boolean; + + diff(unit?: moment.unitOfTime.Diff, rounded?: boolean): number; + + toDate(): Date[]; + + toString(): string; + + valueOf(): number; + + center(): moment.Moment; + + clone(): DateRange; + + isEqual(other: DateRange): boolean; + + adjacent(other: DateRange): boolean; + + duration(unit?: moment.unitOfTime.Diff, precise?: boolean): number; + + reverseBy(interval: moment.unitOfTime.Diff, options?: { exclusive?: boolean, step?: number }): Iterable; + + reverseByRange(interval: DateRange, options?: { exclusive?: boolean, step?: number }): Iterable; + } - function range(range: string): moment.Range; - function range(range: Date[]): moment.Range; - function range(range: Moment[]): moment.Range; - function range(start: Date, end: Date): moment.Range; - function range(start: Moment, end: Moment): moment.Range; + function extendMoment(moment: any): any; + + function range(range: string | Date[] | moment.Moment[]): moment.Range; + function range(start: Date | moment.Moment, end: Date | moment.Moment): moment.Range; } diff --git a/types/moment-range/moment-range-tests.ts b/types/moment-range/moment-range-tests.ts index 16bcf7c808..9667e62d75 100644 --- a/types/moment-range/moment-range-tests.ts +++ b/types/moment-range/moment-range-tests.ts @@ -1,47 +1,66 @@ import * as moment from 'moment'; +import * as momentRange from "moment-range"; -var range: moment.Range = moment.range(new Date(2012, 0, 15), new Date(2012, 4, 23)); -var range2: moment.Range = moment.range(moment("2011-04-15", "YYYY-MM-DD"), moment("2011-11-27", "YYYY-MM-DD")); -var range3: moment.Range = moment.range([moment("2011-04-15", "YYYY-MM-DD"), moment("2011-11-27", "YYYY-MM-DD")]); -var range4: moment.Range = moment.range("2015-01-17T09:50:04+00:00/2015-04-17T08:29:55+00:00"); +var range: momentRange.DateRange = new momentRange.DateRange(new Date(2012, 0, 15), new Date(2012, 4, 23)); +var range2: momentRange.DateRange = new momentRange.DateRange(moment("2011-04-15", "YYYY-MM-DD"), moment("2011-11-27", "YYYY-MM-DD")); +var range3: momentRange.DateRange = new momentRange.DateRange([moment("2011-04-15", "YYYY-MM-DD"), moment("2011-11-27", "YYYY-MM-DD")]); +var range4: momentRange.DateRange = new momentRange.DateRange("2015-01-17T09:50:04+00:00/2015-04-17T08:29:55+00:00"); -var date: moment.Moment = moment('2012-05- 15'); +var date: moment.Moment = moment('2012-05-15'); -var res1: boolean = range.contains(date); -var res2: boolean = range.contains(date, false); -var res3: boolean = range.contains(date, true); +var res1: boolean = range.adjacent(range2); -var res4: boolean = date.within(range); +var it0: Iterable = range.by('days'); +var it1: Iterable = range.by('months', {exclusive: true}); +var it2: Iterable = range.by('years', {exclusive: false, step: 2}); -var res5: boolean = range.overlaps(range2); +var it3: Iterable = range.byRange(range); +var it4: Iterable = range.byRange(range, {exclusive: true}); +var it5: Iterable = range.byRange(range, {exclusive: false, step: 2}); -var res6: moment.Range = range.intersect(range2); +var res2: moment.Moment = range.center(); -var res7: moment.Range = range.add(range2); +var res3: momentRange.DateRange = range.clone(); -var res8: Array = range.subtract(range2); +var res4: boolean = range.contains(range); +var res5: boolean = range.contains(range, {exclusive: true}); +var res6: boolean = range.contains(range, {exclusive: false}); -range.by('days', (moment: moment.Moment) => { }); -range.by(range2, (moment: moment.Moment) => { }); -range.by('d', (moment: moment.Moment) => { }, true); - -var res9: boolean = range.isSame(range2); - -var res10: number = range.diff('months'); +var res10: number = range.diff('months', true); var res11: number = range.diff('days'); var res12: number = range.diff(); -var res13: Date = range.toDate(); -var res14: string = range.toString(); +var res13: number = range.duration('months', true); +var res14: number = range.duration('days'); +var res15: number = range.duration(); -var res15: number = range.valueOf(); +var res16: momentRange.DateRange = range.intersect(range2); -var res16: number = range.center(); +var res17: boolean = range.isSame(range2); -var res17: moment.Range = range.clone(); +var res18: boolean = range.isEqual(range2); -var res18: moment.Moment = range.start; -var res19: moment.Moment = range.end; +var res20: boolean = range.overlaps(range2); +var res21: boolean = range.overlaps(range2, {adjacent: true}); +var res22: boolean = range.overlaps(range2, {adjacent: false}); -var res20: moment.Moment[] = range.toArray('days'); -var res22: moment.Moment[] = range.toArray('days', true); +var it6: Iterable = range.reverseBy('days'); +var it7: Iterable = range.reverseBy('months', {exclusive: true}); +var it8: Iterable = range.reverseBy('years', {exclusive: false, step: 2}); + +var it9: Iterable = range.reverseByRange(range); +var it10: Iterable = range.reverseByRange(range, {exclusive: true}); +var it11: Iterable = range.reverseByRange(range, {exclusive: false, step: 2}); + +var res23: momentRange.DateRange = range.add(range2); + +var res24: Array = range.subtract(range2); + +var res25: Date[] = range.toDate(); + +var res26: string = range.toString(); + +var res27: number = range.valueOf(); + +var res28: moment.Moment = range.start; +var res29: moment.Moment = range.end; diff --git a/types/moment-range/package.json b/types/moment-range/package.json index 4c6d24a445..ce42336f8c 100644 --- a/types/moment-range/package.json +++ b/types/moment-range/package.json @@ -1,5 +1,6 @@ { "dependencies": { - "moment": ">=2.14.0" + "moment": "2.17.1", + "moment-range": "3.0.3" } } \ No newline at end of file From 3ab99add41868f9c1b6823b3d2658960916ef385 Mon Sep 17 00:00:00 2001 From: epicgirl1998 Date: Sat, 25 Mar 2017 04:52:25 +0200 Subject: [PATCH 008/844] Fix chrome.webNavigation filtering again --- types/chrome/index.d.ts | 9 +++++---- types/chrome/test/index.ts | 18 +++++------------- 2 files changed, 10 insertions(+), 17 deletions(-) diff --git a/types/chrome/index.d.ts b/types/chrome/index.d.ts index 1b07c1c2e8..be0f59ebca 100644 --- a/types/chrome/index.d.ts +++ b/types/chrome/index.d.ts @@ -7074,12 +7074,13 @@ declare namespace chrome.webNavigation { transitionQualifiers: string[]; } - interface WebNavigationRequestFilter extends chrome.webRequest.RequestFilter { - /** fulfills the webRequest.RequestFilter interface even though it is under web navigation **/ + interface WebNavigationEventFilter { + /** Conditions that the URL being navigated to must satisfy. The 'schemes' and 'ports' fields of UrlFilter are ignored for this event. */ + url: chrome.events.UrlFilter[]; } interface WebNavigationEvent extends chrome.events.Event<(details: T) => void> { - addListener(callback: (details: T) => void, filters?: WebNavigationRequestFilter): void; + addListener(callback: (details: T) => void, filters?: WebNavigationEventFilter): void; } interface WebNavigationFramedEvent extends WebNavigationEvent {} @@ -7189,7 +7190,7 @@ declare namespace chrome.webRequest { */ types?: string[]; /** A list of URLs or URL patterns. Requests that cannot match any of the URLs will be filtered out. */ - urls: string[] | RegExp[] | ""; + urls: string[]; /** Optional. */ windowId?: number; diff --git a/types/chrome/test/index.ts b/types/chrome/test/index.ts index 3da3f534be..ffe1ece74d 100644 --- a/types/chrome/test/index.ts +++ b/types/chrome/test/index.ts @@ -171,7 +171,7 @@ function catBlock () { ["blocking"]); } -// webNavigation.onBeforeNavigate.addListener example similar api to onBeforeRequest but without extra spec +// webNavigation.onBeforeNavigate.addListener example function beforeRedditNavigation() { chrome.webNavigation.onBeforeNavigate.addListener(function (requestDetails) { console.log("URL we want to redirect to: " + requestDetails.url); @@ -180,18 +180,10 @@ function beforeRedditNavigation() { return; } - let url = new URL(requestDetails.url); - let splitUrl = url.hostname.split('.'); - //` Note: Does not cover the XX.co.uk type edge case - let host = (splitUrl[(splitUrl.length -1) - 1]); - - if (host === null) { - return; - } else if (host === "reddit") { - alert("Were you trying to go on reddit, during working hours? :(") - return; - } - },{urls: ["http://*/*"], types: ["image"]}); + alert("Were you trying to go on reddit, during working hours? :(") + },{url: [ + {hostSuffix: ".reddit.com"} + ]}); } // for chrome.tabs.InjectDetails.frameId From 266710318846d12d5f6af5285c17d08e3c67abd4 Mon Sep 17 00:00:00 2001 From: rzymek Date: Sat, 25 Mar 2017 09:49:19 +0100 Subject: [PATCH 009/844] lodash - _.zipObjectDeep https://lodash.com/docs/4.17.4#zipObjectDeep The same signature as _.zipObject --- types/lodash.zipobjectdeep/index.d.ts | 8 ++ types/lodash.zipobjectdeep/tsconfig.json | 21 +++++ types/lodash.zipobjectdeep/tslint.json | 1 + types/lodash/index.d.ts | 102 ++++++++++++++++++++++- types/lodash/lodash-tests.ts | 22 +++++ types/lodash/zipObjectDeep/index.d.ts | 2 + 6 files changed, 153 insertions(+), 3 deletions(-) create mode 100644 types/lodash.zipobjectdeep/index.d.ts create mode 100644 types/lodash.zipobjectdeep/tsconfig.json create mode 100644 types/lodash.zipobjectdeep/tslint.json create mode 100644 types/lodash/zipObjectDeep/index.d.ts 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 6326773899..170ce63aaf 100644 --- a/types/lodash/index.d.ts +++ b/types/lodash/index.d.ts @@ -5660,9 +5660,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. @@ -5672,6 +5671,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 @@ -5680,6 +5690,13 @@ declare namespace _ { props: List|List>, values?: List ): TResult; + /** + * @see _.zipObjectDeep + */ + zipObjectDeep( + props: List|List>, + values?: List + ): TResult; /** * @see _.zipObject @@ -5688,6 +5705,13 @@ declare namespace _ { props: List|List>, values?: List ): _.Dictionary; + /** + * @see _.zipObjectDeep + */ + zipObjectDepp( + props: List|List>, + values?: List + ): _.Dictionary; } interface LoDashImplicitArrayWrapper { @@ -5697,6 +5721,12 @@ declare namespace _ { zipObject( values?: List ): _.LoDashImplicitObjectWrapper; + /** + * @see _.zipObjectDeep + */ + zipObjectDeep( + values?: List + ): _.LoDashImplicitObjectWrapper; /** * @see _.zipObject @@ -5704,6 +5734,12 @@ declare namespace _ { zipObject( values?: List ): _.LoDashImplicitObjectWrapper; + /** + * @see _.zipObjectDeep + */ + zipObjectDeep( + values?: List + ): _.LoDashImplicitObjectWrapper; /** * @see _.zipObject @@ -5711,6 +5747,12 @@ declare namespace _ { zipObject( values?: List ): _.LoDashImplicitObjectWrapper<_.Dictionary>; + /** + * @see _.zipObjectDeep + */ + zipObjectDeep( + values?: List + ): _.LoDashImplicitObjectWrapper<_.Dictionary>; } interface LoDashImplicitObjectWrapper { @@ -5720,6 +5762,12 @@ declare namespace _ { zipObject( values?: List ): _.LoDashImplicitObjectWrapper; + /** + * @see _.zipObjectDeep + */ + zipObjectDeep( + values?: List + ): _.LoDashImplicitObjectWrapper; /** * @see _.zipObject @@ -5727,6 +5775,12 @@ declare namespace _ { zipObject( values?: List ): _.LoDashImplicitObjectWrapper; + /** + * @see _.zipObjectDeep + */ + zipObjectDeep( + values?: List + ): _.LoDashImplicitObjectWrapper; /** * @see _.zipObject @@ -5734,6 +5788,12 @@ declare namespace _ { zipObject( values?: List ): _.LoDashImplicitObjectWrapper<_.Dictionary>; + /** + * @see _.zipObjectDeep + */ + zipObjectDeep( + values?: List + ): _.LoDashImplicitObjectWrapper<_.Dictionary>; } interface LoDashExplicitArrayWrapper { @@ -5743,6 +5803,12 @@ declare namespace _ { zipObject( values?: List ): _.LoDashExplicitObjectWrapper; + /** + * @see _.zipObjectDeep + */ + zipObjectDeep( + values?: List + ): _.LoDashExplicitObjectWrapper; /** * @see _.zipObject @@ -5750,6 +5816,12 @@ declare namespace _ { zipObject( values?: List ): _.LoDashExplicitObjectWrapper; + /** + * @see _.zipObjectDeep + */ + zipObjectDeep( + values?: List + ): _.LoDashExplicitObjectWrapper; /** * @see _.zipObject @@ -5757,6 +5829,12 @@ declare namespace _ { zipObject( values?: List ): _.LoDashExplicitObjectWrapper<_.Dictionary>; + /** + * @see _.zipObjectDeep + */ + zipObjectDeep( + values?: List + ): _.LoDashExplicitObjectWrapper<_.Dictionary>; } interface LoDashExplicitObjectWrapper { @@ -5766,6 +5844,12 @@ declare namespace _ { zipObject( values?: List ): _.LoDashExplicitObjectWrapper; + /** + * @see _.zipObjectDeep + */ + zipObjectDeep( + values?: List + ): _.LoDashExplicitObjectWrapper; /** * @see _.zipObject @@ -5773,6 +5857,12 @@ declare namespace _ { zipObject( values?: List ): _.LoDashExplicitObjectWrapper; + /** + * @see _.zipObjectDeep + */ + zipObjectDeep( + values?: List + ): _.LoDashExplicitObjectWrapper; /** * @see _.zipObject @@ -5780,6 +5870,12 @@ declare namespace _ { zipObject( values?: List ): _.LoDashExplicitObjectWrapper<_.Dictionary>; + /** + * @see _.zipObjectDeep + */ + zipObjectDeep( + values?: List + ): _.LoDashExplicitObjectWrapper<_.Dictionary>; } //_.zipWith diff --git a/types/lodash/lodash-tests.ts b/types/lodash/lodash-tests.ts index b260df8ee5..311e2e8242 100644 --- a/types/lodash/lodash-tests.ts +++ b/types/lodash/lodash-tests.ts @@ -2608,12 +2608,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); @@ -2647,15 +2653,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); } { @@ -2686,15 +2700,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); } } 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 From 259d2a3ec8323aaa6e8d183c39b309f441fdfb0d Mon Sep 17 00:00:00 2001 From: rzymek Date: Sat, 25 Mar 2017 17:23:29 +0100 Subject: [PATCH 010/844] add zipObjectDeep to tsconfig.json fixed failed travis test: lodash/zipObjectDeep has unused file index.d.ts --- types/lodash/tsconfig.json | 1 + 1 file changed, 1 insertion(+) 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": { From 5a634f7fdb5b593c50b229c5a14507789c888be7 Mon Sep 17 00:00:00 2001 From: KeitaNishimoto Date: Sun, 26 Mar 2017 01:45:51 +0900 Subject: [PATCH 011/844] add API Gateway CustomAuthorizerEvent --- types/aws-lambda/aws-lambda-tests.ts | 7 +++++++ types/aws-lambda/index.d.ts | 8 ++++++++ 2 files changed, 15 insertions(+) diff --git a/types/aws-lambda/aws-lambda-tests.ts b/types/aws-lambda/aws-lambda-tests.ts index 3aede36d4c..07908b2677 100644 --- a/types/aws-lambda/aws-lambda-tests.ts +++ b/types/aws-lambda/aws-lambda-tests.ts @@ -5,6 +5,7 @@ var num: number = 5; var error: Error = new Error(); var b: boolean = true; var apiGwEvt: AWSLambda.APIGatewayEvent; +var customAuthorizerEvt: AWSLambda.CustomAuthorizerEvent; var clientCtx: AWSLambda.ClientContext; var clientContextEnv: AWSLambda.ClientContextEnv; var clientContextClient: AWSLambda.ClientContextClient; @@ -87,6 +88,11 @@ str = apiGwEvt.requestContext.resourceId; str = apiGwEvt.requestContext.resourcePath; str = apiGwEvt.resource; +/* API Gateway CustomAuthorizer Event */ +str = customAuthorizerEvt.type; +str = customAuthorizerEvt.authorizationToken; +str = customAuthorizerEvt.methodArn; + /* SNS Event */ snsEvtRecs = snsEvt.Records; @@ -183,3 +189,4 @@ context.fail(str); /* Handler */ let handler: AWSLambda.Handler = (event: any, context: AWSLambda.Context, cb: AWSLambda.Callback) => { }; let proxyHandler: AWSLambda.ProxyHandler = (event: AWSLambda.APIGatewayEvent, context: AWSLambda.Context, cb: AWSLambda.ProxyCallback) => { }; +let CustomAuthorizerHandler: AWSLambda.CustomAuthorizerHandler = (event: AWSLambda.CustomAuthorizerEvent, context: AWSLambda.Context, cb: AWSLambda.Callback) => { }; diff --git a/types/aws-lambda/index.d.ts b/types/aws-lambda/index.d.ts index c5e49d54c6..f388302d24 100644 --- a/types/aws-lambda/index.d.ts +++ b/types/aws-lambda/index.d.ts @@ -39,6 +39,13 @@ interface APIGatewayEvent { resource: string; } +// API Gateway CustomAuthorizer "event" +interface CustomAuthorizerEvent { + type: string; + authorizationToken: string; + methodArn: string; +} + // SNS "event" interface SNSMessageAttribute { Type: string; @@ -190,6 +197,7 @@ interface ProxyResult { */ export type Handler = (event: any, context: Context, callback?: Callback) => void; export type ProxyHandler = (event: APIGatewayEvent, context: Context, callback?: ProxyCallback) => void; +export type CustomAuthorizerHandler = (event: CustomAuthorizerEvent, context: Context, callback?: Callback) => void; /** * Optional callback parameter. From 0b91832778478e00e962510b97d9fae6c9b7e264 Mon Sep 17 00:00:00 2001 From: Nicolas Laplante Date: Sat, 25 Mar 2017 12:56:05 -0400 Subject: [PATCH 012/844] add types & mtehods from dockerode current (v2.4.2) --- types/dockerode/index.d.ts | 71 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) diff --git a/types/dockerode/index.d.ts b/types/dockerode/index.d.ts index 968199436a..71dac87f54 100644 --- a/types/dockerode/index.d.ts +++ b/types/dockerode/index.d.ts @@ -137,6 +137,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; @@ -575,6 +618,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 +628,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 +647,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 +671,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 +707,8 @@ declare class Dockerode { swarmUpdate(options: {}, callback: Callback): void; + swarmInspect(callback: Callback): void; + modem: any; } From 701ad3fcc01782b5c366f5b507a2ee4fcb6a57ec Mon Sep 17 00:00:00 2001 From: Tamir Duberstein Date: Fri, 24 Mar 2017 13:53:25 -0400 Subject: [PATCH 013/844] lodash: fix toPairs, toPairsIn definitions toPairs: https://github.com/lodash/lodash/blob/4.17.4/lodash.js#L13684:L13708 toPairsIn: https://github.com/lodash/lodash/blob/4.17.4/lodash.js#L13710:L13734 Fixes #14654. --- types/lodash/index.d.ts | 16 ++++++++-------- types/lodash/lodash-tests.ts | 24 ++++++++++++------------ 2 files changed, 20 insertions(+), 20 deletions(-) diff --git a/types/lodash/index.d.ts b/types/lodash/index.d.ts index 6326773899..79326724b1 100644 --- a/types/lodash/index.d.ts +++ b/types/lodash/index.d.ts @@ -16993,23 +16993,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 @@ -17020,23 +17020,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 b260df8ee5..8659859557 100644 --- a/types/lodash/lodash-tests.ts +++ b/types/lodash/lodash-tests.ts @@ -10176,37 +10176,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(); } @@ -10217,37 +10217,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(); } From a7d8ae9f4f015e685944be144a90a078fafb4680 Mon Sep 17 00:00:00 2001 From: Nicolas Laplante Date: Sat, 25 Mar 2017 13:08:42 -0400 Subject: [PATCH 014/844] add definition author --- types/dockerode/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/dockerode/index.d.ts b/types/dockerode/index.d.ts index 71dac87f54..c4f7750dfd 100644 --- a/types/dockerode/index.d.ts +++ b/types/dockerode/index.d.ts @@ -1,6 +1,6 @@ // Type definitions for dockerode 2.3 // Project: https://github.com/apocas/dockerode -// Definitions by: Carl Winkler +// Definitions by: Carl Winkler , Nicolas Laplante // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped /// From 105eb862579c7e9cae4608d70ea9d95c53f95fd9 Mon Sep 17 00:00:00 2001 From: Nicolas Laplante Date: Sat, 25 Mar 2017 13:08:52 -0400 Subject: [PATCH 015/844] upgrade dockerode version --- types/dockerode/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/dockerode/index.d.ts b/types/dockerode/index.d.ts index c4f7750dfd..8c5b1f56c7 100644 --- a/types/dockerode/index.d.ts +++ b/types/dockerode/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for dockerode 2.3 +// Type definitions for dockerode 2.4.2 // Project: https://github.com/apocas/dockerode // Definitions by: Carl Winkler , Nicolas Laplante // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped From 171855d201093525e44c65c33eb49a4bba2306ce Mon Sep 17 00:00:00 2001 From: Nicolas Laplante Date: Sat, 25 Mar 2017 13:09:02 -0400 Subject: [PATCH 016/844] add tests for new api --- types/dockerode/dockerode-tests.ts | 68 +++++++++++++++++++++++++++++- 1 file changed, 67 insertions(+), 1 deletion(-) 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 +}); From 8a9add5b87f0f6b767e1de33b80e86f312de8ad2 Mon Sep 17 00:00:00 2001 From: Nicolas Laplante Date: Sat, 25 Mar 2017 13:10:28 -0400 Subject: [PATCH 017/844] remove minor from version --- types/dockerode/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/dockerode/index.d.ts b/types/dockerode/index.d.ts index 8c5b1f56c7..8f82d982c6 100644 --- a/types/dockerode/index.d.ts +++ b/types/dockerode/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for dockerode 2.4.2 +// Type definitions for dockerode 2.4 // Project: https://github.com/apocas/dockerode // Definitions by: Carl Winkler , Nicolas Laplante // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped From c7e08e933c62ec1dff93eaf1b857895669d2bfd9 Mon Sep 17 00:00:00 2001 From: Nicolas Laplante Date: Sun, 26 Mar 2017 11:48:12 -0400 Subject: [PATCH 018/844] add type definitions --- types/dockerode/index.d.ts | 165 +++++++++++++++++++++++++++++++++---- 1 file changed, 149 insertions(+), 16 deletions(-) diff --git a/types/dockerode/index.d.ts b/types/dockerode/index.d.ts index 8f82d982c6..4d9a979665 100644 --- a/types/dockerode/index.d.ts +++ b/types/dockerode/index.d.ts @@ -94,8 +94,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; @@ -142,7 +142,7 @@ declare namespace Dockerode { name: string; remote: any; - inspect(callback: Callback): void; + inspect(callback: Callback): void; remove(options: {}, callback: Callback): void; remove(callback: Callback): void; @@ -168,7 +168,7 @@ declare namespace Dockerode { } interface Secret { - inspect(callback: Callback): void; + inspect(callback: Callback): void; update(options: {}, callback: Callback): void; update(callback: Callback): void; @@ -589,6 +589,139 @@ 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; @@ -647,11 +780,11 @@ declare class Dockerode { listTasks(options: {}, callback: Callback): void; listTasks(callback: Callback): void; - listSecrets(options: {}, callback: Callback): void; - listSecrets(callback: Callback): void; + listSecrets(options: {}, callback: Callback): void; + listSecrets(callback: Callback): void; - listPlugins(options: {}, callback: Callback): void; - listPlugins(callback: Callback): void; + listPlugins(options: {}, callback: Callback): void; + listPlugins(callback: Callback): void; listVolumes(options: {}, callback: Callback): void; listVolumes(callback: Callback): void; @@ -671,17 +804,17 @@ declare class Dockerode { searchImages(options: {}, callback: Callback): void; - pruneImages(options: {}, callback: Callback): void; - pruneImages(callback: Callback): void; + pruneImages(options: {}, callback: Callback): void; + pruneImages(callback: Callback): void; - pruneContainers(options: {}, callback: Callback): void; - pruneContainers(callback: Callback): void; + pruneContainers(options: {}, callback: Callback): void; + pruneContainers(callback: Callback): void; - pruneVolumes(options: {}, callback: Callback): void; - pruneVolumes(callback: Callback): void; + pruneVolumes(options: {}, callback: Callback): void; + pruneVolumes(callback: Callback): void; - pruneNetworks(options: {}, callback: Callback): void; - pruneNetworks(callback: Callback): void; + pruneNetworks(options: {}, callback: Callback): void; + pruneNetworks(callback: Callback): void; info(callback: Callback): void; From 60bda6cf4f8cd130f8a47a3dc3cdcd71bbffc6ea Mon Sep 17 00:00:00 2001 From: keita-nishimoto Date: Mon, 27 Mar 2017 14:15:05 +0900 Subject: [PATCH 019/844] add CustomAuthorizerCallback & AuthResponse --- types/aws-lambda/aws-lambda-tests.ts | 49 +++++++++++++++++++++++++++- types/aws-lambda/index.d.ts | 42 +++++++++++++++++++++++- 2 files changed, 89 insertions(+), 2 deletions(-) diff --git a/types/aws-lambda/aws-lambda-tests.ts b/types/aws-lambda/aws-lambda-tests.ts index 07908b2677..3c22a88cbc 100644 --- a/types/aws-lambda/aws-lambda-tests.ts +++ b/types/aws-lambda/aws-lambda-tests.ts @@ -12,6 +12,10 @@ var clientContextClient: AWSLambda.ClientContextClient; var context: AWSLambda.Context; var identity: AWSLambda.CognitoIdentity; var proxyResult: AWSLambda.ProxyResult; +var authResponse: AWSLambda.AuthResponse; +var policyDocument: AWSLambda.PolicyDocument; +var statement: AWSLambda.Statement; +var authResponseContext: AWSLambda.AuthResponseContext; var snsEvt: AWSLambda.SNSEvent; var snsEvtRecs: AWSLambda.SNSEventRecord[]; var snsEvtRec: AWSLambda.SNSEventRecord; @@ -125,6 +129,41 @@ proxyResult.headers["example"] = b; proxyResult.headers["example"] = num; str = proxyResult.body; +/* API Gateway CustomAuthorizer AuthResponse */ +authResponseContext = { + stringKey: str, + numberKey: num, + booleanKey: b +}; + +statement = { + Action: str, + Effect: str, + Resource: str +}; + +statement = { + Action: str, + Effect: str, + Resource: [str, str] +}; + +policyDocument = { + Version: str, + Statement: [statement] +}; + +authResponse = { + principalId: str, + policyDocument: policyDocument, + context: authResponseContext +}; + +authResponse = { + principalId: str, + policyDocument: policyDocument +}; + /* Context */ b = context.callbackWaitsForEmptyEventLoop; str = context.functionName; @@ -176,6 +215,14 @@ function proxyCallback(cb: AWSLambda.ProxyCallback) { cb(null, proxyResult); } +/* CustomAuthorizerCallback */ +function customAuthorizerCallback(cb: AWSLambda.CustomAuthorizerCallback) { + cb(); + cb(null); + cb(error); + cb(null, authResponse); +} + /* Compatibility functions */ context.done(); context.done(error); @@ -189,4 +236,4 @@ context.fail(str); /* Handler */ let handler: AWSLambda.Handler = (event: any, context: AWSLambda.Context, cb: AWSLambda.Callback) => { }; let proxyHandler: AWSLambda.ProxyHandler = (event: AWSLambda.APIGatewayEvent, context: AWSLambda.Context, cb: AWSLambda.ProxyCallback) => { }; -let CustomAuthorizerHandler: AWSLambda.CustomAuthorizerHandler = (event: AWSLambda.CustomAuthorizerEvent, context: AWSLambda.Context, cb: AWSLambda.Callback) => { }; +let CustomAuthorizerHandler: AWSLambda.CustomAuthorizerHandler = (event: AWSLambda.CustomAuthorizerEvent, context: AWSLambda.Context, cb: AWSLambda.CustomAuthorizerCallback) => { }; diff --git a/types/aws-lambda/index.d.ts b/types/aws-lambda/index.d.ts index f388302d24..d8507ef7de 100644 --- a/types/aws-lambda/index.d.ts +++ b/types/aws-lambda/index.d.ts @@ -187,6 +187,45 @@ interface ProxyResult { body: string; } +/** + * API Gateway CustomAuthorizer AuthResponse. + * http://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html#api-gateway-custom-authorizer-output + */ +interface AuthResponse { + principalId: string; + policyDocument: PolicyDocument; + context?: AuthResponseContext; +} + +/** + * API Gateway CustomAuthorizer AuthResponse.PolicyDocument. + * http://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html#api-gateway-custom-authorizer-output + */ +interface PolicyDocument { + Version: string; + Statement: [Statement]; +} + +/** + * API Gateway CustomAuthorizer AuthResponse.PolicyDocument.Statement. + * http://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html#api-gateway-custom-authorizer-output + */ +interface Statement { + Action: string; + Effect: string; + Resource: string | [string]; +} + +/** + * API Gateway CustomAuthorizer AuthResponse.PolicyDocument.Statement. + * http://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html#api-gateway-custom-authorizer-output + */ +interface AuthResponseContext { + stringKey: string; + numberKey: number; + booleanKey: boolean; +} + /** * AWS Lambda handler function. * http://docs.aws.amazon.com/lambda/latest/dg/nodejs-prog-model-handler.html @@ -197,7 +236,7 @@ interface ProxyResult { */ export type Handler = (event: any, context: Context, callback?: Callback) => void; export type ProxyHandler = (event: APIGatewayEvent, context: Context, callback?: ProxyCallback) => void; -export type CustomAuthorizerHandler = (event: CustomAuthorizerEvent, context: Context, callback?: Callback) => void; +export type CustomAuthorizerHandler = (event: CustomAuthorizerEvent, context: Context, callback?: CustomAuthorizerCallback) => void; /** * Optional callback parameter. @@ -208,5 +247,6 @@ export type CustomAuthorizerHandler = (event: CustomAuthorizerEvent, context: Co */ export type Callback = (error?: Error, result?: any) => void; export type ProxyCallback = (error?: Error, result?: ProxyResult) => void; +export type CustomAuthorizerCallback = (error?: Error, result?: AuthResponse) => void; export as namespace AWSLambda; From 96bc18e2218cb25a20df28057880225ea12ac67f Mon Sep 17 00:00:00 2001 From: Eric Ivarsson Date: Mon, 27 Mar 2017 11:43:44 +0200 Subject: [PATCH 020/844] Added optional property navigateToLoginRequestUrl New in 1.0.14 is the ability to turn of default navigation to start page after login. --- types/adal/index.d.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) 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 { From 09644d8ba8cede4c62b4f3029af1a0bc13863c98 Mon Sep 17 00:00:00 2001 From: Marco Ramos Date: Mon, 27 Mar 2017 07:26:35 -0400 Subject: [PATCH 021/844] Type Error Classes missing from json-patch Enforce stricter typings --- types/json-patch/index.d.ts | 34 ++++++++++++++++------------ types/json-patch/json-patch-tests.ts | 19 ++++++++++++++++ 2 files changed, 39 insertions(+), 14 deletions(-) diff --git a/types/json-patch/index.d.ts b/types/json-patch/index.d.ts index bb70cff6c6..6f257924b0 100644 --- a/types/json-patch/index.d.ts +++ b/types/json-patch/index.d.ts @@ -4,36 +4,42 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped declare namespace jsonpatch { - type OpPatch = AddPath | RemovePath | ReplacePath | MovePath | CopyPath | TestPath; + type OpPatch = AddPatch | RemovePatch | ReplacePatch | MovePatch | CopyPatch | TestPatch; interface Patch { - op: string; - } - interface AddPath extends Patch { path: string; + } + interface AddPatch extends Patch { + op: 'add'; value: any; } - interface RemovePath extends Patch { - path: string; + interface RemovePatch extends Patch { + op: 'remove'; } - interface ReplacePath extends Patch { - path: string; + interface ReplacePatch extends Patch { + op: 'replace'; value: any; } - interface MovePath extends Patch { + interface MovePatch extends Patch { + op: 'move'; from: string; - path: string; } - interface CopyPath extends Patch { + interface CopyPatch extends Patch { + op: 'copy'; from: string; - path: string; } - interface TestPath extends Patch { - path: string; + interface TestPatch extends Patch { + op: 'test'; value: any; } function apply(document: any, patches: OpPatch[]): any; function compile(patches: OpPatch[]): (document: any) => any; + + class JSONPatchError extends Error { } + class InvalidPointerError extends Error { } + class InvalidPatchError extends JSONPatchError { } + class PatchConflictError extends JSONPatchError { } + class PatchTestFailed extends Error { } } export = jsonpatch; diff --git a/types/json-patch/json-patch-tests.ts b/types/json-patch/json-patch-tests.ts index 3c3ff51f22..470b12fe54 100644 --- a/types/json-patch/json-patch-tests.ts +++ b/types/json-patch/json-patch-tests.ts @@ -32,3 +32,22 @@ jsonpatch.apply({ foo: 'bar' }, [{ op: 'test', path: '/foo', value: 'bar' }]); jsonpatch.compile([{ op: 'test', path: '/foo', value: 'bar' }])({ foo: 'bar' }); jp.apply({}, [{ op: 'add', path: '/foo', value: 'bar' }]); + +function patchShouldFail(document: any, patches: jsonpatch.OpPatch[]): string { + try { + jsonpatch.apply(document, patches); + throw new Error('Patch did not fail...'); + } catch (err) { + if (err instanceof jsonpatch.PatchTestFailed) { + return 'Test failed'; + } else if (err instanceof jsonpatch.InvalidPointerError) { + return 'Invalid Pointer'; + } else if (err instanceof jsonpatch.InvalidPatchError) { + return 'Invalid Patch'; + } else if (err instanceof jsonpatch.PatchConflictError) { + return 'Patch Conflict'; + } else { + return 'Failed with unknown error'; + } + } +} \ No newline at end of file From ecd2181818b06441edd1d55aebb4c826c06989e2 Mon Sep 17 00:00:00 2001 From: huhuanming Date: Mon, 27 Mar 2017 23:13:52 +0800 Subject: [PATCH 022/844] Add hegiht && paginationStyle --- types/react-native-swiper/index.d.ts | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/types/react-native-swiper/index.d.ts b/types/react-native-swiper/index.d.ts index f41a771caf..3ac3be55c3 100644 --- a/types/react-native-swiper/index.d.ts +++ b/types/react-native-swiper/index.d.ts @@ -1,6 +1,6 @@ // Type definitions for react-native-swiper 1.5 // Project: https://github.com/leecade/react-native-swiper#readme -// Definitions by: CaiHuan +// Definitions by: CaiHuan , HuHuanming // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.1 @@ -58,6 +58,12 @@ interface SwiperProperties extends React.Props { dotColor?: string; activeDotColor?: string; + + height?: number; + + width?: number; + + paginationStyle?: ViewStyle; } export default class Swiper extends React.Component { From 8484faf7747a8731783bb8debc2a733a19de1592 Mon Sep 17 00:00:00 2001 From: Kalle Ott Date: Mon, 27 Mar 2017 21:23:45 +0200 Subject: [PATCH 023/844] update for react-virtualized 9.4 replaced single declaration file with multiple files to represent the module structure of react-virtualized. This makes the future maintanance easier, because changes in the lib can be easier mirrored in the corresponding declaration file. This typings update should be the last with large breaking changes --- types/react-virtualized/ArrowKeyStepper.d.ts | 55 ++ .../ArrowKeyStepper.test.tsx | 71 ++ types/react-virtualized/AutoSizer.d.ts | 49 ++ types/react-virtualized/AutoSizer.test.tsx | 47 ++ types/react-virtualized/CellMeasurer.d.ts | 78 ++ types/react-virtualized/CellMeasurer.test.tsx | 74 ++ types/react-virtualized/Collection.d.ts | 124 ++++ types/react-virtualized/Collection.test.tsx | 160 +++++ types/react-virtualized/ColumnSizer.d.ts | 50 ++ types/react-virtualized/ColumnSizer.test.tsx | 113 +++ types/react-virtualized/Grid.d.ts | 462 ++++++++++++ types/react-virtualized/Grid.test.tsx | 207 ++++++ types/react-virtualized/InfiniteLoader.d.ts | 80 +++ .../react-virtualized/InfiniteLoader.test.tsx | 138 ++++ types/react-virtualized/List.d.ts | 138 ++++ types/react-virtualized/List.test.tsx | 160 +++++ types/react-virtualized/Masonry.d.ts | 146 ++++ types/react-virtualized/Masonry.test.tsx | 200 ++++++ types/react-virtualized/MultiGrid.d.ts | 75 ++ types/react-virtualized/MultiGrid.test.tsx | 105 +++ types/react-virtualized/ScrollSync.d.ts | 51 ++ types/react-virtualized/ScrollSync.test.tsx | 222 ++++++ types/react-virtualized/Table.d.ts | 447 ++++++++++++ types/react-virtualized/Table.test.tsx | 196 +++++ types/react-virtualized/WindowScroller.d.ts | 60 ++ .../react-virtualized/WindowScroller.test.tsx | 88 +++ types/react-virtualized/genericTypes.d.ts | 40 ++ types/react-virtualized/index.d.ts | 671 ++++-------------- .../react-virtualized-tests.tsx | 532 -------------- types/react-virtualized/tsconfig.json | 28 +- 30 files changed, 3795 insertions(+), 1072 deletions(-) create mode 100644 types/react-virtualized/ArrowKeyStepper.d.ts create mode 100644 types/react-virtualized/ArrowKeyStepper.test.tsx create mode 100644 types/react-virtualized/AutoSizer.d.ts create mode 100644 types/react-virtualized/AutoSizer.test.tsx create mode 100644 types/react-virtualized/CellMeasurer.d.ts create mode 100644 types/react-virtualized/CellMeasurer.test.tsx create mode 100644 types/react-virtualized/Collection.d.ts create mode 100644 types/react-virtualized/Collection.test.tsx create mode 100644 types/react-virtualized/ColumnSizer.d.ts create mode 100644 types/react-virtualized/ColumnSizer.test.tsx create mode 100644 types/react-virtualized/Grid.d.ts create mode 100644 types/react-virtualized/Grid.test.tsx create mode 100644 types/react-virtualized/InfiniteLoader.d.ts create mode 100644 types/react-virtualized/InfiniteLoader.test.tsx create mode 100644 types/react-virtualized/List.d.ts create mode 100644 types/react-virtualized/List.test.tsx create mode 100644 types/react-virtualized/Masonry.d.ts create mode 100644 types/react-virtualized/Masonry.test.tsx create mode 100644 types/react-virtualized/MultiGrid.d.ts create mode 100644 types/react-virtualized/MultiGrid.test.tsx create mode 100644 types/react-virtualized/ScrollSync.d.ts create mode 100644 types/react-virtualized/ScrollSync.test.tsx create mode 100644 types/react-virtualized/Table.d.ts create mode 100644 types/react-virtualized/Table.test.tsx create mode 100644 types/react-virtualized/WindowScroller.d.ts create mode 100644 types/react-virtualized/WindowScroller.test.tsx create mode 100644 types/react-virtualized/genericTypes.d.ts delete mode 100644 types/react-virtualized/react-virtualized-tests.tsx diff --git a/types/react-virtualized/ArrowKeyStepper.d.ts b/types/react-virtualized/ArrowKeyStepper.d.ts new file mode 100644 index 0000000000..e42ff353f2 --- /dev/null +++ b/types/react-virtualized/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/ArrowKeyStepper.test.tsx b/types/react-virtualized/ArrowKeyStepper.test.tsx new file mode 100644 index 0000000000..8204aafdd6 --- /dev/null +++ b/types/react-virtualized/ArrowKeyStepper.test.tsx @@ -0,0 +1,71 @@ +/** @flow */ +import * as React from 'react'; +import { PureComponent } from 'react' +import { ArrowKeyStepper, AutoSizer, Grid } from 'react-virtualized' + +export default class ArrowKeyStepperExample extends PureComponent { + constructor(props) { + super(props) + + this._getColumnWidth = this._getColumnWidth.bind(this) + this._getRowHeight = this._getRowHeight.bind(this) + this._cellRenderer = this._cellRenderer.bind(this) + } + + render() { + const { mode } = this.state + + 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}`} +
+ ) + } +} diff --git a/types/react-virtualized/AutoSizer.d.ts b/types/react-virtualized/AutoSizer.d.ts new file mode 100644 index 0000000000..6d82a44482 --- /dev/null +++ b/types/react-virtualized/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/AutoSizer.test.tsx b/types/react-virtualized/AutoSizer.test.tsx new file mode 100644 index 0000000000..670d77b52b --- /dev/null +++ b/types/react-virtualized/AutoSizer.test.tsx @@ -0,0 +1,47 @@ +/** @flow */ +import * as React from 'react'; +import { PureComponent } from 'react' +import { AutoSizer, List } from 'react-virtualized' + +export default class AutoSizerExample extends PureComponent { + constructor(props) { + super(props) + + this._rowRenderer = this._rowRenderer.bind(this) + } + + render() { + const { list } = this.context + const { hideDescription } = this.state + + return ( + + {({ width, height }) => ( + + )} + + ) + } + + _rowRenderer({ index, key, style }) { + const { list } = this.context + const row = list.get(index) + + return ( +
+ {row.name} +
+ ) + } +} diff --git a/types/react-virtualized/CellMeasurer.d.ts b/types/react-virtualized/CellMeasurer.d.ts new file mode 100644 index 0000000000..5e1e0db3fb --- /dev/null +++ b/types/react-virtualized/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/CellMeasurer.test.tsx b/types/react-virtualized/CellMeasurer.test.tsx new file mode 100644 index 0000000000..5b510704c0 --- /dev/null +++ b/types/react-virtualized/CellMeasurer.test.tsx @@ -0,0 +1,74 @@ +/** @flow */ +import * as React from 'react' +import { PropTypes, PureComponent } from 'react' +import { CellMeasurer, CellMeasurerCache, List } from 'react-virtualized' + +export default 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 }) => ( +
+ +
+ )} + + ) + } +} diff --git a/types/react-virtualized/Collection.d.ts b/types/react-virtualized/Collection.d.ts new file mode 100644 index 0000000000..7e11946eb1 --- /dev/null +++ b/types/react-virtualized/Collection.d.ts @@ -0,0 +1,124 @@ +/** @flow */ +import { PureComponent, Validator, Requireable } from 'react' +import { + Index, + ScrollPosition, + SizeInfo, + SizeAndPositionInfo +} from './genericTypes'; + +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/Collection.test.tsx b/types/react-virtualized/Collection.test.tsx new file mode 100644 index 0000000000..8a7860b3c7 --- /dev/null +++ b/types/react-virtualized/Collection.test.tsx @@ -0,0 +1,160 @@ +/** @flow */ +import * as React from 'react' +import { PropTypes, PureComponent } from 'react' +import { AutoSizer, 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 default 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} +
+ ) + } + + _cellSizeAndPositionGetter({ index }) { + const { list } = this.context + const { columnCount } = this.state + + const columnPosition = index % (columnCount || 1) + const datum = list.get(index % list.size) + + // 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 + + this._columnYMap[columnPosition] = y + height + GUTTER_SIZE + + return { + height, + width, + x, + y + } + } + + _getColumnCount(cellCount) { + return Math.round(Math.sqrt(cellCount)) + } + + _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 }) + } +} diff --git a/types/react-virtualized/ColumnSizer.d.ts b/types/react-virtualized/ColumnSizer.d.ts new file mode 100644 index 0000000000..6efcf8c044 --- /dev/null +++ b/types/react-virtualized/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/ColumnSizer.test.tsx b/types/react-virtualized/ColumnSizer.test.tsx new file mode 100644 index 0000000000..97de9fff45 --- /dev/null +++ b/types/react-virtualized/ColumnSizer.test.tsx @@ -0,0 +1,113 @@ +import * as React from 'react' +import { PureComponent } from 'react' +import { AutoSizer, ColumnSizer, Grid } from 'react-virtualized' + +export default 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}`} +
+ ) + } +} diff --git a/types/react-virtualized/Grid.d.ts b/types/react-virtualized/Grid.d.ts new file mode 100644 index 0000000000..ea7130857c --- /dev/null +++ b/types/react-virtualized/Grid.d.ts @@ -0,0 +1,462 @@ +/** @flow */ +import { Validator, Requireable, PureComponent } from 'react' +import { List } from './List'; +import { Table } from './Table'; +import { CellMeasurerCache } from './CellMeasurer'; +import { Index, Map, Alignment } from './genericTypes'; + +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; \ No newline at end of file diff --git a/types/react-virtualized/Grid.test.tsx b/types/react-virtualized/Grid.test.tsx new file mode 100644 index 0000000000..634fcdc137 --- /dev/null +++ b/types/react-virtualized/Grid.test.tsx @@ -0,0 +1,207 @@ +/** @flow */ +import * as React from 'react' +import { PropTypes, PureComponent } from 'react' +import { AutoSizer, Grid } from 'react-virtualized' + +export default 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 }) + } +} diff --git a/types/react-virtualized/InfiniteLoader.d.ts b/types/react-virtualized/InfiniteLoader.d.ts new file mode 100644 index 0000000000..4493921e72 --- /dev/null +++ b/types/react-virtualized/InfiniteLoader.d.ts @@ -0,0 +1,80 @@ +import { PureComponent, Validator, Requireable } from 'react' +import { Index, IndexRange } from './genericTypes'; + +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/InfiniteLoader.test.tsx b/types/react-virtualized/InfiniteLoader.test.tsx new file mode 100644 index 0000000000..0509f46216 --- /dev/null +++ b/types/react-virtualized/InfiniteLoader.test.tsx @@ -0,0 +1,138 @@ +/** @flow */ +import * as React from 'react' +import { PropTypes, PureComponent } from 'react' +import { AutoSizer, InfiniteLoader, List } from 'react-virtualized' + +const STATUS_LOADING = 1 +const STATUS_LOADED = 2 + +export default 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 (var 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 (var 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 ( +
+ {content} +
+ ) + } +} diff --git a/types/react-virtualized/List.d.ts b/types/react-virtualized/List.d.ts new file mode 100644 index 0000000000..d4d5196a34 --- /dev/null +++ b/types/react-virtualized/List.d.ts @@ -0,0 +1,138 @@ +/** @flow */ +import { PureComponent, Validator, Requireable } from 'react' +import { Grid, GridCellProps } from './Grid' +import { Index, IndexRange, Alignment } from './genericTypes' +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/List.test.tsx b/types/react-virtualized/List.test.tsx new file mode 100644 index 0000000000..86763a95f8 --- /dev/null +++ b/types/react-virtualized/List.test.tsx @@ -0,0 +1,160 @@ +import * as React from 'react' +import { PropTypes, PureComponent } from 'react' +import { AutoSizer, List } from 'react-virtualized' + +export default 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) + } + + render() { + const { + listHeight, + listRowHeight, + overscanRowCount, + rowCount, + scrollToIndex, + showScrollingPlaceholder, + useDynamicRowHeight + } = this.state + + return ( + + {({ width }) => ( + + )} + + ) + } + + _getDatum(index) { + const { list } = this.context + + return list.get(index % list.size) + } + + _getRowHeight({ index }) { + return this._getDatum(index).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 }) + } + + _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 + + } +
+ ) + } +} diff --git a/types/react-virtualized/Masonry.d.ts b/types/react-virtualized/Masonry.d.ts new file mode 100644 index 0000000000..c4187bf611 --- /dev/null +++ b/types/react-virtualized/Masonry.d.ts @@ -0,0 +1,146 @@ +import { PureComponent, Validator, Requireable } from 'react' +import { } from './genericTypes'; +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; \ No newline at end of file diff --git a/types/react-virtualized/Masonry.test.tsx b/types/react-virtualized/Masonry.test.tsx new file mode 100644 index 0000000000..902e5498c5 --- /dev/null +++ b/types/react-virtualized/Masonry.test.tsx @@ -0,0 +1,200 @@ +import * as React from 'react' +import { PropTypes, PureComponent } from 'react' +import { + CellMeasurer, + CellMeasurerCache, + AutoSizer, + WindowScroller, + createMasonryCellPositioner as createCellPositioner, + Positioner, + Masonry, + MasonryCellProps +} from 'react-virtualized' + +export default class GridExample 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 + } +} diff --git a/types/react-virtualized/MultiGrid.d.ts b/types/react-virtualized/MultiGrid.d.ts new file mode 100644 index 0000000000..1bb8b7dfac --- /dev/null +++ b/types/react-virtualized/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/MultiGrid.test.tsx b/types/react-virtualized/MultiGrid.test.tsx new file mode 100644 index 0000000000..f2f3af9397 --- /dev/null +++ b/types/react-virtualized/MultiGrid.test.tsx @@ -0,0 +1,105 @@ +/** @flow */ +import * as React from 'react' +import { PropTypes, PureComponent } from 'react' +import { AutoSizer, 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 default 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 ( + `` + ) + } +} diff --git a/types/react-virtualized/ScrollSync.d.ts b/types/react-virtualized/ScrollSync.d.ts new file mode 100644 index 0000000000..4f1e924a69 --- /dev/null +++ b/types/react-virtualized/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; +} \ No newline at end of file diff --git a/types/react-virtualized/ScrollSync.test.tsx b/types/react-virtualized/ScrollSync.test.tsx new file mode 100644 index 0000000000..9919b72ab3 --- /dev/null +++ b/types/react-virtualized/ScrollSync.test.tsx @@ -0,0 +1,222 @@ +import * as React from 'react' +import { PureComponent } from 'react' +import { AutoSizer, Grid, 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 default class GridExample 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 ( +
+ {`C${columnIndex}`} +
+ ) + } + + _renderLeftSideCell({ columnIndex, key, rowIndex, style }) { + return ( +
+ {`R${rowIndex}, C${columnIndex}`} +
+ ) + } +} + +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 } +} diff --git a/types/react-virtualized/Table.d.ts b/types/react-virtualized/Table.d.ts new file mode 100644 index 0000000000..af5cf9b0b5 --- /dev/null +++ b/types/react-virtualized/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 './genericTypes'; +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: Array, + 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: () => React.ReactElement[]; +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/Table.test.tsx b/types/react-virtualized/Table.test.tsx new file mode 100644 index 0000000000..8714634d1d --- /dev/null +++ b/types/react-virtualized/Table.test.tsx @@ -0,0 +1,196 @@ +import * as React from 'react' +import { PropTypes, PureComponent } from 'react' +import { AutoSizer, Column, Table, SortDirection, SortIndicator } from 'react-virtualized' + +export default 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 + } + + 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) + } + + render() { + const { + disableHeader, + headerHeight, + height, + hideIndexRow, + overscanRowCount, + rowHeight, + rowCount, + scrollToIndex, + sortBy, + sortDirection, + useDynamicRowHeight + } = this.state + + const { list } = this.context + const sortedList = this._isSortEnabled() + ? list + .sortBy(item => item[sortBy]) + .update(list => + sortDirection === SortDirection.DESC + ? list.reverse() + : list + ) + : list + + const rowGetter = ({ index }) => this._getDatum(sortedList, index) + + return ( +
+ + {({ width }) => ( + + {!hideIndexRow && + rowData.index + } + dataKey='index' + disableSort={!this._isSortEnabled()} + width={60} + /> + } + + cellData + } + flexGrow={1} + /> +
+ )} + +
+ ) + } + + _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 + }) + } +} diff --git a/types/react-virtualized/WindowScroller.d.ts b/types/react-virtualized/WindowScroller.d.ts new file mode 100644 index 0000000000..093debdd78 --- /dev/null +++ b/types/react-virtualized/WindowScroller.d.ts @@ -0,0 +1,60 @@ +/** @flow */ +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/WindowScroller.test.tsx b/types/react-virtualized/WindowScroller.test.tsx new file mode 100644 index 0000000000..c72a1b197a --- /dev/null +++ b/types/react-virtualized/WindowScroller.test.tsx @@ -0,0 +1,88 @@ +import * as React from 'react' +import { PropTypes, PureComponent } from 'react' +import { WindowScroller, List, AutoSizer } from 'react-virtualized' + +export default 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/genericTypes.d.ts b/types/react-virtualized/genericTypes.d.ts new file mode 100644 index 0000000000..7f4b6ff4b4 --- /dev/null +++ b/types/react-virtualized/genericTypes.d.ts @@ -0,0 +1,40 @@ +export type Index = { + index: number +}; + +export type PositionInfo = { + x: number, + y: number +}; + +export type ScrollPosition = { + scrollLeft: number, + scrollTop: number +}; + +export type SizeInfo = { + height: number, + width: number +}; + +export type SizeAndPositionInfo = SizeInfo & PositionInfo; + +export type Map = { [key: string]: T }; + +export type Alignment = 'auto' | 'end' | 'start' | 'center'; + +export type IndexRange = { + startIndex: number, + stopIndex: number +} + +export type OverscanIndexRange = { + overscanStartIndex: number, + overscanStopIndex: number, +} + +export type ScrollEventData = { + clientHeight: number, + scrollHeight: number, + scrollTop: number +} \ No newline at end of file diff --git a/types/react-virtualized/index.d.ts b/types/react-virtualized/index.d.ts index f89183c90f..31a6ee29c8 100644 --- a/types/react-virtualized/index.d.ts +++ b/types/react-virtualized/index.d.ts @@ -1,545 +1,138 @@ -// 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 -import * as React from "react"; +export { + ArrowKeyStepper, + ArrowKeyStepperProps, + ChildProps as ArrowKeyStepperChildProps +} from './ArrowKeyStepper' +export { + AutoSizer, + AutoSizerProps, + Dimensions +} from './AutoSizer' +export { + CellMeasurer, + CellMeasurerCache, + CellMeasurerCacheParams, + CellMeasurerProps, + KeyMapper +} from './CellMeasurer' +export { + Collection, + CollectionCellGroupRenderer, + CollectionCellGroupRendererParams, + CollectionCellRenderer, + CollectionCellRendererParams, + CollectionCellSizeAndPosition, + CollectionCellSizeAndPositionGetter, + CollectionProps +} from './Collection' +export { + ColumnSizer, + ColumnSizerProps, + SizedColumnProps +} from './ColumnSizer' +export { + defaultCellRangeRenderer, + Grid, + CellSizeAndPositionManager, + ConfigureParams, + ContainerSizeAndOffset, + GetVisibleCellRangeParams, + GridCellProps, + GridCellRangeProps, + GridCellRangeRenderer, + GridCellRenderer, + GridProps, + GridState, + OverscanIndices, + OverscanIndicesGetterParams, + ScrollDirection, + ScrollParams, + SectionRenderedParams, + SizeAndPositionData, + VisibleCellRange +} from './Grid' +export { + InfiniteLoader, + InfiniteLoaderChildProps, + InfiniteLoaderProps +} from './InfiniteLoader' +export { + List, + ListProps, + ListRowProps, + ListRowRenderer +} from './List' +export { + createCellPositioner as createMasonryCellPositioner, + Masonry, + CellRenderer, + MasonryCellProps, + MasonryProps, + MasonryState, + OnCellsRenderedCallback, + OnScrollCallback, + Position, + Positioner +} from './Masonry' +export { + MultiGrid, + MultiGridProps, + MultiGridState +} from './MultiGrid' +export { + ScrollSync, + OnScrollParams, + ScrollSyncChildProps, + ScrollSyncProps, + ScrollSyncState +} from './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 './Table' +export { + WindowScroller, + WindowScrollerChildProps, + WindowScrollerProps, + WindowScrollerState +} from './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 = { - 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 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 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, - 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; - -// 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 RowClickHandlerParams = { - rowData: { - columnData: Object, - id: string, - index: 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 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, - 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 { } +export { + Alignment, + Index, + IndexRange, + Map, + PositionInfo, + ScrollEventData, + ScrollPosition, + SizeAndPositionInfo, + SizeInfo +} from './genericTypes' \ No newline at end of file diff --git a/types/react-virtualized/react-virtualized-tests.tsx b/types/react-virtualized/react-virtualized-tests.tsx deleted file mode 100644 index aa1dc087a9..0000000000 --- a/types/react-virtualized/react-virtualized-tests.tsx +++ /dev/null @@ -1,532 +0,0 @@ -import * as React from "react"; -import * as ReactDOM from "react-dom"; - -import { - Collection, - SortDirection, - Grid, - ArrowKeyStepper, - AutoSizer, - CellMeasurer, - ColumnSizer, - InfiniteLoader, - ScrollSync, - WindowScroller, - WindowScrollerRenderCallBackParams, - List, - Column, - Table, -} from "react-virtualized"; - -/* - * Collection - */ - -function CollectionTest() { - const list = [ - { name: "Brian Vaughn", x: 13, y: 34, width: 123, size: 234, height: 123 } - ]; - - // 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") - ); -} - -function GridTest() { - // Grid data as an array of arrays - const list = [ - ['Brian Vaughn', 'Software Engineer', 'San Jose', 'CA', 95125 /* ... */] - // And so on... - ]; - - // Render your grid - ReactDOM.render( - list[rowIndex][columnIndex]} - />, - document.getElementById('example') - ); -} - -function ListTest() { - // List data - const list = [ - { name: 'Brian Vaughn', occupation: 'Software Engineer', location: 'San Jose, CA, 95125' /* ... */ } - // And so on... - ]; - - // Render your List - ReactDOM.render( - list[index]} - />, - document.getElementById('example') - ); -} - -function TableTest() { - const list = [ - { name: 'Brian Vaughn', description: 'Software engineer' } - // And so on... - ]; - ReactDOM.render( - list[index]} - > - - -
, - document.getElementById('example') - ); -} - -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]; - - return ( -
- {row} -
- ) - } - - // Render your list - ReactDOM.render( - - {({ width, height }) => ( - { - const row = list[index]; - - return ( -
- {row} -
- ) - }} - width={width} - /> - )} - , - document.getElementById('example') - ); -} - -function CellMeasurerTest() { - const columnCount = 12; - const rowCount = 3; - const cellRenderer = ({ columnIndex, rowIndex }) => `${rowIndex}, ${columnIndex}`; - const fixedRowHeight = 42; - const height = 12; - const width = 12; - - ReactDOM.render( - - {({ getColumnWidth }) => ( - - )} - , - document.getElementById('example') - ); -} - -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]; - } - - function loadMoreRows({ startIndex, stopIndex }: { startIndex: number, stopIndex: number }) { - return new Promise(resolve => resolve(list.push('test'))); - } - - function rowRenderer({ index, key, style }) { - const content = list[index]; - - return ( -
- {content} -
- ) - } - - - // 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 - } - - 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; - - - 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 } - }; - - function renderLeftHeaderCell({ columnIndex, key, rowIndex, style }) { - return ( -
- {`C${columnIndex}`} -
- ) - }; - 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(' ') - - return ( -
- {`R${rowIndex}, C${columnIndex}`} -
- ) - }; - - function renderHeaderCell({ columnIndex, key, rowIndex, style }) { - if (columnIndex < 1) { - return - } - - return renderLeftHeaderCell({ columnIndex, key, rowIndex, style }) - }; - - function renderBodyCell({ columnIndex, key, rowIndex, style }) { - if (columnIndex < 1) { - return - } - - return renderLeftSideCell({ columnIndex, key, rowIndex, style }) - } - - 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 }) => ( -
-
- -
-
- -
-
- )} - -
-
- ) - }} - - ); -} - -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 }) => ( - - {({ width }) => ( - list[index].name} - scrollTop={scrollTop} - width={width} - /> - )} - - )} - , - document.getElementById('example') - ); - // test that onScroll & onResize are optional - ReactDOM.render( - , - document.getElementById('example') - ); -} diff --git a/types/react-virtualized/tsconfig.json b/types/react-virtualized/tsconfig.json index ac62cf83d8..21a0e43a0d 100644 --- a/types/react-virtualized/tsconfig.json +++ b/types/react-virtualized/tsconfig.json @@ -19,6 +19,32 @@ }, "files": [ "index.d.ts", - "react-virtualized-tests.tsx" + "ArrowKeyStepper.d.ts", + "ArrowKeyStepper.test.tsx", + "AutoSizer.d.ts", + "AutoSizer.test.tsx", + "CellMeasurer.d.ts", + "CellMeasurer.test.tsx", + "Collection.d.ts", + "Collection.test.tsx", + "ColumnSizer.d.ts", + "ColumnSizer.test.tsx", + "genericTypes.d.ts", + "Grid.d.ts", + "Grid.test.tsx", + "InfiniteLoader.d.ts", + "InfiniteLoader.test.tsx", + "List.d.ts", + "List.test.tsx", + "Masonry.d.ts", + "Masonry.test.tsx", + "MultiGrid.d.ts", + "MultiGrid.test.tsx", + "ScrollSync.d.ts", + "ScrollSync.test.tsx", + "Table.d.ts", + "Table.test.tsx", + "WindowScroller.d.ts", + "WindowScroller.test.tsx" ] } \ No newline at end of file From 62ad9abc10b38daae1940f0345b094882f4d5f6f Mon Sep 17 00:00:00 2001 From: Kalle Ott Date: Mon, 27 Mar 2017 21:32:02 +0200 Subject: [PATCH 024/844] fixed linting error --- types/react-virtualized/Collection.d.ts | 6 +++--- types/react-virtualized/tslint.json | 1 + 2 files changed, 4 insertions(+), 3 deletions(-) create mode 100644 types/react-virtualized/tslint.json diff --git a/types/react-virtualized/Collection.d.ts b/types/react-virtualized/Collection.d.ts index 7e11946eb1..52a69de286 100644 --- a/types/react-virtualized/Collection.d.ts +++ b/types/react-virtualized/Collection.d.ts @@ -31,11 +31,11 @@ export type CollectionProps = { sectionSize?: number; className?: string; height: number; - width:number; + width: number; horizontalOverscanSize?: number; noContentRenderer?: () => JSX.Element; - scrollToCell?: number; - verticalOverscanSize?:number; + scrollToCell?: number; + verticalOverscanSize?: number; }; /** diff --git a/types/react-virtualized/tslint.json b/types/react-virtualized/tslint.json new file mode 100644 index 0000000000..2221e40e4a --- /dev/null +++ b/types/react-virtualized/tslint.json @@ -0,0 +1 @@ +{ "extends": "../tslint.json" } \ No newline at end of file From 97fd2fc247ed9996d7faf87f0ca3cd3e67eef208 Mon Sep 17 00:00:00 2001 From: Kalle Ott Date: Mon, 27 Mar 2017 21:54:40 +0200 Subject: [PATCH 025/844] replaced mulstiple testfiles with on to obey definitely typed naming --- .../ArrowKeyStepper.test.tsx | 71 - types/react-virtualized/AutoSizer.test.tsx | 47 - types/react-virtualized/CellMeasurer.test.tsx | 74 - types/react-virtualized/Collection.test.tsx | 160 -- types/react-virtualized/ColumnSizer.test.tsx | 113 -- types/react-virtualized/Grid.test.tsx | 207 -- .../react-virtualized/InfiniteLoader.test.tsx | 138 -- types/react-virtualized/List.test.tsx | 160 -- types/react-virtualized/Masonry.test.tsx | 200 -- types/react-virtualized/MultiGrid.test.tsx | 105 - types/react-virtualized/ScrollSync.test.tsx | 222 --- types/react-virtualized/Table.test.tsx | 196 -- .../react-virtualized/WindowScroller.test.tsx | 88 - .../react-virtualized-tests.tsx | 1753 +++++++++++++++++ types/react-virtualized/tsconfig.json | 14 +- 15 files changed, 1754 insertions(+), 1794 deletions(-) delete mode 100644 types/react-virtualized/ArrowKeyStepper.test.tsx delete mode 100644 types/react-virtualized/AutoSizer.test.tsx delete mode 100644 types/react-virtualized/CellMeasurer.test.tsx delete mode 100644 types/react-virtualized/Collection.test.tsx delete mode 100644 types/react-virtualized/ColumnSizer.test.tsx delete mode 100644 types/react-virtualized/Grid.test.tsx delete mode 100644 types/react-virtualized/InfiniteLoader.test.tsx delete mode 100644 types/react-virtualized/List.test.tsx delete mode 100644 types/react-virtualized/Masonry.test.tsx delete mode 100644 types/react-virtualized/MultiGrid.test.tsx delete mode 100644 types/react-virtualized/ScrollSync.test.tsx delete mode 100644 types/react-virtualized/Table.test.tsx delete mode 100644 types/react-virtualized/WindowScroller.test.tsx create mode 100644 types/react-virtualized/react-virtualized-tests.tsx diff --git a/types/react-virtualized/ArrowKeyStepper.test.tsx b/types/react-virtualized/ArrowKeyStepper.test.tsx deleted file mode 100644 index 8204aafdd6..0000000000 --- a/types/react-virtualized/ArrowKeyStepper.test.tsx +++ /dev/null @@ -1,71 +0,0 @@ -/** @flow */ -import * as React from 'react'; -import { PureComponent } from 'react' -import { ArrowKeyStepper, AutoSizer, Grid } from 'react-virtualized' - -export default class ArrowKeyStepperExample extends PureComponent { - constructor(props) { - super(props) - - this._getColumnWidth = this._getColumnWidth.bind(this) - this._getRowHeight = this._getRowHeight.bind(this) - this._cellRenderer = this._cellRenderer.bind(this) - } - - render() { - const { mode } = this.state - - 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}`} -
- ) - } -} diff --git a/types/react-virtualized/AutoSizer.test.tsx b/types/react-virtualized/AutoSizer.test.tsx deleted file mode 100644 index 670d77b52b..0000000000 --- a/types/react-virtualized/AutoSizer.test.tsx +++ /dev/null @@ -1,47 +0,0 @@ -/** @flow */ -import * as React from 'react'; -import { PureComponent } from 'react' -import { AutoSizer, List } from 'react-virtualized' - -export default class AutoSizerExample extends PureComponent { - constructor(props) { - super(props) - - this._rowRenderer = this._rowRenderer.bind(this) - } - - render() { - const { list } = this.context - const { hideDescription } = this.state - - return ( - - {({ width, height }) => ( - - )} - - ) - } - - _rowRenderer({ index, key, style }) { - const { list } = this.context - const row = list.get(index) - - return ( -
- {row.name} -
- ) - } -} diff --git a/types/react-virtualized/CellMeasurer.test.tsx b/types/react-virtualized/CellMeasurer.test.tsx deleted file mode 100644 index 5b510704c0..0000000000 --- a/types/react-virtualized/CellMeasurer.test.tsx +++ /dev/null @@ -1,74 +0,0 @@ -/** @flow */ -import * as React from 'react' -import { PropTypes, PureComponent } from 'react' -import { CellMeasurer, CellMeasurerCache, List } from 'react-virtualized' - -export default 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 }) => ( -
- -
- )} - - ) - } -} diff --git a/types/react-virtualized/Collection.test.tsx b/types/react-virtualized/Collection.test.tsx deleted file mode 100644 index 8a7860b3c7..0000000000 --- a/types/react-virtualized/Collection.test.tsx +++ /dev/null @@ -1,160 +0,0 @@ -/** @flow */ -import * as React from 'react' -import { PropTypes, PureComponent } from 'react' -import { AutoSizer, 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 default 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} -
- ) - } - - _cellSizeAndPositionGetter({ index }) { - const { list } = this.context - const { columnCount } = this.state - - const columnPosition = index % (columnCount || 1) - const datum = list.get(index % list.size) - - // 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 - - this._columnYMap[columnPosition] = y + height + GUTTER_SIZE - - return { - height, - width, - x, - y - } - } - - _getColumnCount(cellCount) { - return Math.round(Math.sqrt(cellCount)) - } - - _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 }) - } -} diff --git a/types/react-virtualized/ColumnSizer.test.tsx b/types/react-virtualized/ColumnSizer.test.tsx deleted file mode 100644 index 97de9fff45..0000000000 --- a/types/react-virtualized/ColumnSizer.test.tsx +++ /dev/null @@ -1,113 +0,0 @@ -import * as React from 'react' -import { PureComponent } from 'react' -import { AutoSizer, ColumnSizer, Grid } from 'react-virtualized' - -export default 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}`} -
- ) - } -} diff --git a/types/react-virtualized/Grid.test.tsx b/types/react-virtualized/Grid.test.tsx deleted file mode 100644 index 634fcdc137..0000000000 --- a/types/react-virtualized/Grid.test.tsx +++ /dev/null @@ -1,207 +0,0 @@ -/** @flow */ -import * as React from 'react' -import { PropTypes, PureComponent } from 'react' -import { AutoSizer, Grid } from 'react-virtualized' - -export default 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 }) - } -} diff --git a/types/react-virtualized/InfiniteLoader.test.tsx b/types/react-virtualized/InfiniteLoader.test.tsx deleted file mode 100644 index 0509f46216..0000000000 --- a/types/react-virtualized/InfiniteLoader.test.tsx +++ /dev/null @@ -1,138 +0,0 @@ -/** @flow */ -import * as React from 'react' -import { PropTypes, PureComponent } from 'react' -import { AutoSizer, InfiniteLoader, List } from 'react-virtualized' - -const STATUS_LOADING = 1 -const STATUS_LOADED = 2 - -export default 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 (var 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 (var 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 ( -
- {content} -
- ) - } -} diff --git a/types/react-virtualized/List.test.tsx b/types/react-virtualized/List.test.tsx deleted file mode 100644 index 86763a95f8..0000000000 --- a/types/react-virtualized/List.test.tsx +++ /dev/null @@ -1,160 +0,0 @@ -import * as React from 'react' -import { PropTypes, PureComponent } from 'react' -import { AutoSizer, List } from 'react-virtualized' - -export default 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) - } - - render() { - const { - listHeight, - listRowHeight, - overscanRowCount, - rowCount, - scrollToIndex, - showScrollingPlaceholder, - useDynamicRowHeight - } = this.state - - return ( - - {({ width }) => ( - - )} - - ) - } - - _getDatum(index) { - const { list } = this.context - - return list.get(index % list.size) - } - - _getRowHeight({ index }) { - return this._getDatum(index).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 }) - } - - _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 - - } -
- ) - } -} diff --git a/types/react-virtualized/Masonry.test.tsx b/types/react-virtualized/Masonry.test.tsx deleted file mode 100644 index 902e5498c5..0000000000 --- a/types/react-virtualized/Masonry.test.tsx +++ /dev/null @@ -1,200 +0,0 @@ -import * as React from 'react' -import { PropTypes, PureComponent } from 'react' -import { - CellMeasurer, - CellMeasurerCache, - AutoSizer, - WindowScroller, - createMasonryCellPositioner as createCellPositioner, - Positioner, - Masonry, - MasonryCellProps -} from 'react-virtualized' - -export default class GridExample 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 - } -} diff --git a/types/react-virtualized/MultiGrid.test.tsx b/types/react-virtualized/MultiGrid.test.tsx deleted file mode 100644 index f2f3af9397..0000000000 --- a/types/react-virtualized/MultiGrid.test.tsx +++ /dev/null @@ -1,105 +0,0 @@ -/** @flow */ -import * as React from 'react' -import { PropTypes, PureComponent } from 'react' -import { AutoSizer, 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 default 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 ( - `` - ) - } -} diff --git a/types/react-virtualized/ScrollSync.test.tsx b/types/react-virtualized/ScrollSync.test.tsx deleted file mode 100644 index 9919b72ab3..0000000000 --- a/types/react-virtualized/ScrollSync.test.tsx +++ /dev/null @@ -1,222 +0,0 @@ -import * as React from 'react' -import { PureComponent } from 'react' -import { AutoSizer, Grid, 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 default class GridExample 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 ( -
- {`C${columnIndex}`} -
- ) - } - - _renderLeftSideCell({ columnIndex, key, rowIndex, style }) { - return ( -
- {`R${rowIndex}, C${columnIndex}`} -
- ) - } -} - -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 } -} diff --git a/types/react-virtualized/Table.test.tsx b/types/react-virtualized/Table.test.tsx deleted file mode 100644 index 8714634d1d..0000000000 --- a/types/react-virtualized/Table.test.tsx +++ /dev/null @@ -1,196 +0,0 @@ -import * as React from 'react' -import { PropTypes, PureComponent } from 'react' -import { AutoSizer, Column, Table, SortDirection, SortIndicator } from 'react-virtualized' - -export default 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 - } - - 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) - } - - render() { - const { - disableHeader, - headerHeight, - height, - hideIndexRow, - overscanRowCount, - rowHeight, - rowCount, - scrollToIndex, - sortBy, - sortDirection, - useDynamicRowHeight - } = this.state - - const { list } = this.context - const sortedList = this._isSortEnabled() - ? list - .sortBy(item => item[sortBy]) - .update(list => - sortDirection === SortDirection.DESC - ? list.reverse() - : list - ) - : list - - const rowGetter = ({ index }) => this._getDatum(sortedList, index) - - return ( -
- - {({ width }) => ( - - {!hideIndexRow && - rowData.index - } - dataKey='index' - disableSort={!this._isSortEnabled()} - width={60} - /> - } - - cellData - } - flexGrow={1} - /> -
- )} - -
- ) - } - - _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 - }) - } -} diff --git a/types/react-virtualized/WindowScroller.test.tsx b/types/react-virtualized/WindowScroller.test.tsx deleted file mode 100644 index c72a1b197a..0000000000 --- a/types/react-virtualized/WindowScroller.test.tsx +++ /dev/null @@ -1,88 +0,0 @@ -import * as React from 'react' -import { PropTypes, PureComponent } from 'react' -import { WindowScroller, List, AutoSizer } from 'react-virtualized' - -export default 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/react-virtualized-tests.tsx b/types/react-virtualized/react-virtualized-tests.tsx new file mode 100644 index 0000000000..71386b2780 --- /dev/null +++ b/types/react-virtualized/react-virtualized-tests.tsx @@ -0,0 +1,1753 @@ +import * as React from 'react'; +import { PureComponent } from 'react' +import { ArrowKeyStepper, AutoSizer, Grid } from 'react-virtualized' + +export class ArrowKeyStepperExample extends PureComponent { + constructor(props) { + super(props) + + this._getColumnWidth = this._getColumnWidth.bind(this) + this._getRowHeight = this._getRowHeight.bind(this) + this._cellRenderer = this._cellRenderer.bind(this) + } + + render() { + const { mode } = this.state + + 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}`} +
+ ) + } +} + +import { List } from 'react-virtualized' + +export class AutoSizerExample extends PureComponent { + constructor(props) { + super(props) + + this._rowRenderer = this._rowRenderer.bind(this) + } + + render() { + const { list } = this.context + const { hideDescription } = this.state + + return ( + + {({ width, height }) => ( + + )} + + ) + } + + _rowRenderer({ index, key, style }) { + const { list } = this.context + const row = list.get(index) + + return ( +
+ {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} +
+ ) + } + + _cellSizeAndPositionGetter({ index }) { + const { list } = this.context + const { columnCount } = this.state + + const columnPosition = index % (columnCount || 1) + const datum = list.get(index % list.size) + + // 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 + + this._columnYMap[columnPosition] = y + height + GUTTER_SIZE + + return { + height, + width, + x, + y + } + } + + _getColumnCount(cellCount) { + return Math.round(Math.sqrt(cellCount)) + } + + _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 (var 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 (var 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 ( +
+ {content} +
+ ) + } +} + +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) + } + + render() { + const { + listHeight, + listRowHeight, + overscanRowCount, + rowCount, + scrollToIndex, + showScrollingPlaceholder, + useDynamicRowHeight + } = this.state + + return ( + + {({ width }) => ( + + )} + + ) + } + + _getDatum(index) { + const { list } = this.context + + return list.get(index % list.size) + } + + _getRowHeight({ index }) { + return this._getDatum(index).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 }) + } + + _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 ( +
+ {`C${columnIndex}`} +
+ ) + } + + _renderLeftSideCell({ columnIndex, key, rowIndex, style }) { + return ( +
+ {`R${rowIndex}, C${columnIndex}`} +
+ ) + } +} + +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 + } + + 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) + } + + render() { + const { + disableHeader, + headerHeight, + height, + hideIndexRow, + overscanRowCount, + rowHeight, + rowCount, + scrollToIndex, + sortBy, + sortDirection, + useDynamicRowHeight + } = this.state + + const { list } = this.context + const sortedList = this._isSortEnabled() + ? list + .sortBy(item => item[sortBy]) + .update(list => + sortDirection === SortDirection.DESC + ? list.reverse() + : list + ) + : list + + const rowGetter = ({ index }) => this._getDatum(sortedList, index) + + return ( +
+ + {({ width }) => ( + + {!hideIndexRow && + rowData.index + } + dataKey='index' + disableSort={!this._isSortEnabled()} + width={60} + /> + } + + cellData + } + flexGrow={1} + /> +
+ )} + +
+ ) + } + + _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 21a0e43a0d..6be15dbe8a 100644 --- a/types/react-virtualized/tsconfig.json +++ b/types/react-virtualized/tsconfig.json @@ -20,31 +20,19 @@ "files": [ "index.d.ts", "ArrowKeyStepper.d.ts", - "ArrowKeyStepper.test.tsx", "AutoSizer.d.ts", - "AutoSizer.test.tsx", "CellMeasurer.d.ts", - "CellMeasurer.test.tsx", "Collection.d.ts", - "Collection.test.tsx", "ColumnSizer.d.ts", - "ColumnSizer.test.tsx", "genericTypes.d.ts", "Grid.d.ts", - "Grid.test.tsx", "InfiniteLoader.d.ts", - "InfiniteLoader.test.tsx", "List.d.ts", - "List.test.tsx", "Masonry.d.ts", - "Masonry.test.tsx", "MultiGrid.d.ts", - "MultiGrid.test.tsx", "ScrollSync.d.ts", - "ScrollSync.test.tsx", "Table.d.ts", - "Table.test.tsx", "WindowScroller.d.ts", - "WindowScroller.test.tsx" + "react-virtualized-tests.tsx" ] } \ No newline at end of file From a500aedade3a27ccd6348c134ba0a032000a9257 Mon Sep 17 00:00:00 2001 From: Kalle Ott Date: Mon, 27 Mar 2017 21:58:19 +0200 Subject: [PATCH 026/844] update to typescript 2.2 for object type --- types/react-virtualized/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/react-virtualized/index.d.ts b/types/react-virtualized/index.d.ts index 31a6ee29c8..3280d8410d 100644 --- a/types/react-virtualized/index.d.ts +++ b/types/react-virtualized/index.d.ts @@ -2,7 +2,7 @@ // 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 export { ArrowKeyStepper, From 4e37f8d9f9913922d441bf2f03ea17d7293cf5ec Mon Sep 17 00:00:00 2001 From: Kalle Ott Date: Tue, 28 Mar 2017 09:14:58 +0200 Subject: [PATCH 027/844] fixed mapping to distribution folder structure --- .../dist/commonjs/ArrowKeyStepper.d.ts | 1 + .../dist/commonjs/AutoSizer.d.ts | 1 + .../dist/commonjs/CellMeasurer.d.ts | 1 + .../dist/commonjs/Collection.d.ts | 1 + .../dist/commonjs/ColumnSizer.d.ts | 1 + .../react-virtualized/dist/commonjs/Grid.d.ts | 1 + .../dist/commonjs/InfiniteLoader.d.ts | 1 + .../react-virtualized/dist/commonjs/List.d.ts | 1 + .../dist/commonjs/Masonry.d.ts | 1 + .../dist/commonjs/MultiGrid.d.ts | 1 + .../dist/commonjs/ScrollSync.d.ts | 1 + .../dist/commonjs/Table.d.ts | 1 + .../dist/commonjs/WindowScroller.d.ts | 1 + .../{ => dist/es}/ArrowKeyStepper.d.ts | 0 .../{ => dist/es}/AutoSizer.d.ts | 0 .../{ => dist/es}/CellMeasurer.d.ts | 0 .../{ => dist/es}/Collection.d.ts | 3 +- .../{ => dist/es}/ColumnSizer.d.ts | 0 .../react-virtualized/{ => dist/es}/Grid.d.ts | 3 +- .../{ => dist/es}/InfiniteLoader.d.ts | 2 +- .../react-virtualized/{ => dist/es}/List.d.ts | 3 +- .../{ => dist/es}/Masonry.d.ts | 1 - .../{ => dist/es}/MultiGrid.d.ts | 0 .../{ => dist/es}/ScrollSync.d.ts | 0 .../{ => dist/es}/Table.d.ts | 2 +- .../{ => dist/es}/WindowScroller.d.ts | 1 - types/react-virtualized/genericTypes.d.ts | 40 ---------- types/react-virtualized/index.d.ts | 77 +++++++++++++------ 28 files changed, 71 insertions(+), 74 deletions(-) create mode 100644 types/react-virtualized/dist/commonjs/ArrowKeyStepper.d.ts create mode 100644 types/react-virtualized/dist/commonjs/AutoSizer.d.ts create mode 100644 types/react-virtualized/dist/commonjs/CellMeasurer.d.ts create mode 100644 types/react-virtualized/dist/commonjs/Collection.d.ts create mode 100644 types/react-virtualized/dist/commonjs/ColumnSizer.d.ts create mode 100644 types/react-virtualized/dist/commonjs/Grid.d.ts create mode 100644 types/react-virtualized/dist/commonjs/InfiniteLoader.d.ts create mode 100644 types/react-virtualized/dist/commonjs/List.d.ts create mode 100644 types/react-virtualized/dist/commonjs/Masonry.d.ts create mode 100644 types/react-virtualized/dist/commonjs/MultiGrid.d.ts create mode 100644 types/react-virtualized/dist/commonjs/ScrollSync.d.ts create mode 100644 types/react-virtualized/dist/commonjs/Table.d.ts create mode 100644 types/react-virtualized/dist/commonjs/WindowScroller.d.ts rename types/react-virtualized/{ => dist/es}/ArrowKeyStepper.d.ts (100%) rename types/react-virtualized/{ => dist/es}/AutoSizer.d.ts (100%) rename types/react-virtualized/{ => dist/es}/CellMeasurer.d.ts (100%) rename types/react-virtualized/{ => dist/es}/Collection.d.ts (99%) rename types/react-virtualized/{ => dist/es}/ColumnSizer.d.ts (100%) rename types/react-virtualized/{ => dist/es}/Grid.d.ts (99%) rename types/react-virtualized/{ => dist/es}/InfiniteLoader.d.ts (98%) rename types/react-virtualized/{ => dist/es}/List.d.ts (98%) rename types/react-virtualized/{ => dist/es}/Masonry.d.ts (99%) rename types/react-virtualized/{ => dist/es}/MultiGrid.d.ts (100%) rename types/react-virtualized/{ => dist/es}/ScrollSync.d.ts (100%) rename types/react-virtualized/{ => dist/es}/Table.d.ts (99%) rename types/react-virtualized/{ => dist/es}/WindowScroller.d.ts (99%) delete mode 100644 types/react-virtualized/genericTypes.d.ts 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..fd16c58feb --- /dev/null +++ b/types/react-virtualized/dist/commonjs/ArrowKeyStepper.d.ts @@ -0,0 +1 @@ +export * from '../es/ArrowKeyStepper'; \ No newline at end of file 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..c0551a98a4 --- /dev/null +++ b/types/react-virtualized/dist/commonjs/AutoSizer.d.ts @@ -0,0 +1 @@ +export * from '../es/AutoSizer'; \ No newline at end of file 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..907eafee51 --- /dev/null +++ b/types/react-virtualized/dist/commonjs/CellMeasurer.d.ts @@ -0,0 +1 @@ +export * from '../es/CellMeasurer'; \ No newline at end of file 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..2764686c76 --- /dev/null +++ b/types/react-virtualized/dist/commonjs/Collection.d.ts @@ -0,0 +1 @@ +export * from '../es/Collection'; \ No newline at end of file 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..80c9cf5d2e --- /dev/null +++ b/types/react-virtualized/dist/commonjs/ColumnSizer.d.ts @@ -0,0 +1 @@ +export * from '../es/ColumnSizer'; \ No newline at end of file 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..168a11ac52 --- /dev/null +++ b/types/react-virtualized/dist/commonjs/Grid.d.ts @@ -0,0 +1 @@ +export * from '../es/Grid'; \ No newline at end of file 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..29449c85ff --- /dev/null +++ b/types/react-virtualized/dist/commonjs/InfiniteLoader.d.ts @@ -0,0 +1 @@ +export * from '../es/InfiniteLoader'; \ No newline at end of file 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..6fdfde2dc0 --- /dev/null +++ b/types/react-virtualized/dist/commonjs/List.d.ts @@ -0,0 +1 @@ +export * from '../es/List'; \ No newline at end of file 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..e5189fb5f9 --- /dev/null +++ b/types/react-virtualized/dist/commonjs/Masonry.d.ts @@ -0,0 +1 @@ +export * from '../es/Masonry'; \ No newline at end of file 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..09f385eca4 --- /dev/null +++ b/types/react-virtualized/dist/commonjs/MultiGrid.d.ts @@ -0,0 +1 @@ +export * from '../es/MultiGrid'; \ No newline at end of file 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..ffb4423c0a --- /dev/null +++ b/types/react-virtualized/dist/commonjs/ScrollSync.d.ts @@ -0,0 +1 @@ +export * from '../es/ScrollSync'; \ No newline at end of file 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..db2670ceda --- /dev/null +++ b/types/react-virtualized/dist/commonjs/Table.d.ts @@ -0,0 +1 @@ +export * from '../es/Table'; \ No newline at end of file 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..0380f0a4fb --- /dev/null +++ b/types/react-virtualized/dist/commonjs/WindowScroller.d.ts @@ -0,0 +1 @@ +export * from '../es/WindowScroller'; \ No newline at end of file diff --git a/types/react-virtualized/ArrowKeyStepper.d.ts b/types/react-virtualized/dist/es/ArrowKeyStepper.d.ts similarity index 100% rename from types/react-virtualized/ArrowKeyStepper.d.ts rename to types/react-virtualized/dist/es/ArrowKeyStepper.d.ts diff --git a/types/react-virtualized/AutoSizer.d.ts b/types/react-virtualized/dist/es/AutoSizer.d.ts similarity index 100% rename from types/react-virtualized/AutoSizer.d.ts rename to types/react-virtualized/dist/es/AutoSizer.d.ts diff --git a/types/react-virtualized/CellMeasurer.d.ts b/types/react-virtualized/dist/es/CellMeasurer.d.ts similarity index 100% rename from types/react-virtualized/CellMeasurer.d.ts rename to types/react-virtualized/dist/es/CellMeasurer.d.ts diff --git a/types/react-virtualized/Collection.d.ts b/types/react-virtualized/dist/es/Collection.d.ts similarity index 99% rename from types/react-virtualized/Collection.d.ts rename to types/react-virtualized/dist/es/Collection.d.ts index 52a69de286..404d329222 100644 --- a/types/react-virtualized/Collection.d.ts +++ b/types/react-virtualized/dist/es/Collection.d.ts @@ -1,11 +1,10 @@ -/** @flow */ import { PureComponent, Validator, Requireable } from 'react' import { Index, ScrollPosition, SizeInfo, SizeAndPositionInfo -} from './genericTypes'; +} from '../../index'; export type CollectionCellSizeAndPosition = { height: number, width: number, x: number, y: number }; export type CollectionCellSizeAndPositionGetter = (params: Index) => CollectionCellSizeAndPosition; diff --git a/types/react-virtualized/ColumnSizer.d.ts b/types/react-virtualized/dist/es/ColumnSizer.d.ts similarity index 100% rename from types/react-virtualized/ColumnSizer.d.ts rename to types/react-virtualized/dist/es/ColumnSizer.d.ts diff --git a/types/react-virtualized/Grid.d.ts b/types/react-virtualized/dist/es/Grid.d.ts similarity index 99% rename from types/react-virtualized/Grid.d.ts rename to types/react-virtualized/dist/es/Grid.d.ts index ea7130857c..b68cf45956 100644 --- a/types/react-virtualized/Grid.d.ts +++ b/types/react-virtualized/dist/es/Grid.d.ts @@ -1,9 +1,8 @@ -/** @flow */ import { Validator, Requireable, PureComponent } from 'react' import { List } from './List'; import { Table } from './Table'; import { CellMeasurerCache } from './CellMeasurer'; -import { Index, Map, Alignment } from './genericTypes'; +import { Index, Map, Alignment } from '../../index'; export type GridCellProps = { columnIndex: number; diff --git a/types/react-virtualized/InfiniteLoader.d.ts b/types/react-virtualized/dist/es/InfiniteLoader.d.ts similarity index 98% rename from types/react-virtualized/InfiniteLoader.d.ts rename to types/react-virtualized/dist/es/InfiniteLoader.d.ts index 4493921e72..e16359adca 100644 --- a/types/react-virtualized/InfiniteLoader.d.ts +++ b/types/react-virtualized/dist/es/InfiniteLoader.d.ts @@ -1,5 +1,5 @@ import { PureComponent, Validator, Requireable } from 'react' -import { Index, IndexRange } from './genericTypes'; +import { Index, IndexRange } from '../../index'; export type InfiniteLoaderChildProps = { onRowsRendered: (params: { startIndex: number, stopIndex: number }) => void, diff --git a/types/react-virtualized/List.d.ts b/types/react-virtualized/dist/es/List.d.ts similarity index 98% rename from types/react-virtualized/List.d.ts rename to types/react-virtualized/dist/es/List.d.ts index d4d5196a34..2a4f30dbfe 100644 --- a/types/react-virtualized/List.d.ts +++ b/types/react-virtualized/dist/es/List.d.ts @@ -1,7 +1,6 @@ -/** @flow */ import { PureComponent, Validator, Requireable } from 'react' import { Grid, GridCellProps } from './Grid' -import { Index, IndexRange, Alignment } from './genericTypes' +import { Index, IndexRange, Alignment } from '../../index' import { CellMeasurerCache } from './CellMeasurer' export type ListRowProps = GridCellProps & { index: number, style: React.CSSProperties }; diff --git a/types/react-virtualized/Masonry.d.ts b/types/react-virtualized/dist/es/Masonry.d.ts similarity index 99% rename from types/react-virtualized/Masonry.d.ts rename to types/react-virtualized/dist/es/Masonry.d.ts index c4187bf611..51c59a90fc 100644 --- a/types/react-virtualized/Masonry.d.ts +++ b/types/react-virtualized/dist/es/Masonry.d.ts @@ -1,5 +1,4 @@ import { PureComponent, Validator, Requireable } from 'react' -import { } from './genericTypes'; import { CellMeasurerCache, KeyMapper } from './CellMeasurer'; import { GridCellRenderer } from './Grid'; /** diff --git a/types/react-virtualized/MultiGrid.d.ts b/types/react-virtualized/dist/es/MultiGrid.d.ts similarity index 100% rename from types/react-virtualized/MultiGrid.d.ts rename to types/react-virtualized/dist/es/MultiGrid.d.ts diff --git a/types/react-virtualized/ScrollSync.d.ts b/types/react-virtualized/dist/es/ScrollSync.d.ts similarity index 100% rename from types/react-virtualized/ScrollSync.d.ts rename to types/react-virtualized/dist/es/ScrollSync.d.ts diff --git a/types/react-virtualized/Table.d.ts b/types/react-virtualized/dist/es/Table.d.ts similarity index 99% rename from types/react-virtualized/Table.d.ts rename to types/react-virtualized/dist/es/Table.d.ts index af5cf9b0b5..6607211dcf 100644 --- a/types/react-virtualized/Table.d.ts +++ b/types/react-virtualized/dist/es/Table.d.ts @@ -1,6 +1,6 @@ import { Validator, Requireable, PureComponent, Component } from 'react'; import { CellMeasurerCache } from './CellMeasurer'; -import { Index, Alignment, ScrollEventData, IndexRange, OverscanIndexRange } from './genericTypes'; +import { Index, Alignment, ScrollEventData, IndexRange, OverscanIndexRange } from '../../index'; import { Grid } from './Grid'; export type TableCellDataGetterParams = { diff --git a/types/react-virtualized/WindowScroller.d.ts b/types/react-virtualized/dist/es/WindowScroller.d.ts similarity index 99% rename from types/react-virtualized/WindowScroller.d.ts rename to types/react-virtualized/dist/es/WindowScroller.d.ts index 093debdd78..7e0a09379e 100644 --- a/types/react-virtualized/WindowScroller.d.ts +++ b/types/react-virtualized/dist/es/WindowScroller.d.ts @@ -1,4 +1,3 @@ -/** @flow */ import { Validator, Requireable, PureComponent } from 'react' export type WindowScrollerChildProps = { diff --git a/types/react-virtualized/genericTypes.d.ts b/types/react-virtualized/genericTypes.d.ts deleted file mode 100644 index 7f4b6ff4b4..0000000000 --- a/types/react-virtualized/genericTypes.d.ts +++ /dev/null @@ -1,40 +0,0 @@ -export type Index = { - index: number -}; - -export type PositionInfo = { - x: number, - y: number -}; - -export type ScrollPosition = { - scrollLeft: number, - scrollTop: number -}; - -export type SizeInfo = { - height: number, - width: number -}; - -export type SizeAndPositionInfo = SizeInfo & PositionInfo; - -export type Map = { [key: string]: T }; - -export type Alignment = 'auto' | 'end' | 'start' | 'center'; - -export type IndexRange = { - startIndex: number, - stopIndex: number -} - -export type OverscanIndexRange = { - overscanStartIndex: number, - overscanStopIndex: number, -} - -export type ScrollEventData = { - clientHeight: number, - scrollHeight: number, - scrollTop: number -} \ No newline at end of file diff --git a/types/react-virtualized/index.d.ts b/types/react-virtualized/index.d.ts index 3280d8410d..d6860176ed 100644 --- a/types/react-virtualized/index.d.ts +++ b/types/react-virtualized/index.d.ts @@ -8,19 +8,19 @@ export { ArrowKeyStepper, ArrowKeyStepperProps, ChildProps as ArrowKeyStepperChildProps -} from './ArrowKeyStepper' +} from './dist/es/ArrowKeyStepper' export { AutoSizer, AutoSizerProps, Dimensions -} from './AutoSizer' +} from './dist/es/AutoSizer' export { CellMeasurer, CellMeasurerCache, CellMeasurerCacheParams, CellMeasurerProps, KeyMapper -} from './CellMeasurer' +} from './dist/es/CellMeasurer' export { Collection, CollectionCellGroupRenderer, @@ -30,12 +30,12 @@ export { CollectionCellSizeAndPosition, CollectionCellSizeAndPositionGetter, CollectionProps -} from './Collection' +} from './dist/es/Collection' export { ColumnSizer, ColumnSizerProps, SizedColumnProps -} from './ColumnSizer' +} from './dist/es/ColumnSizer' export { defaultCellRangeRenderer, Grid, @@ -56,18 +56,18 @@ export { SectionRenderedParams, SizeAndPositionData, VisibleCellRange -} from './Grid' +} from './dist/es/Grid' export { InfiniteLoader, InfiniteLoaderChildProps, InfiniteLoaderProps -} from './InfiniteLoader' +} from './dist/es/InfiniteLoader' export { List, ListProps, ListRowProps, ListRowRenderer -} from './List' +} from './dist/es/List' export { createCellPositioner as createMasonryCellPositioner, Masonry, @@ -79,19 +79,19 @@ export { OnScrollCallback, Position, Positioner -} from './Masonry' +} from './dist/es/Masonry' export { MultiGrid, MultiGridProps, MultiGridState -} from './MultiGrid' +} from './dist/es/MultiGrid' export { ScrollSync, OnScrollParams, ScrollSyncChildProps, ScrollSyncProps, ScrollSyncState -} from './ScrollSync' +} from './dist/es/ScrollSync' export { defaultTableCellDataGetter, defaultTableCellRenderer, @@ -117,22 +117,51 @@ export { TableProps, TableRowProps, TableRowRenderer -} from './Table' +} from './dist/es/Table' export { WindowScroller, WindowScrollerChildProps, WindowScrollerProps, WindowScrollerState -} from './WindowScroller' +} from './dist/es/WindowScroller' -export { - Alignment, - Index, - IndexRange, - Map, - PositionInfo, - ScrollEventData, - ScrollPosition, - SizeAndPositionInfo, - SizeInfo -} from './genericTypes' \ No newline at end of file +export type Index = { + index: number +}; + +export type PositionInfo = { + x: number, + y: number +}; + +export type ScrollPosition = { + scrollLeft: number, + scrollTop: number +}; + +export type SizeInfo = { + height: number, + width: number +}; + +export type SizeAndPositionInfo = SizeInfo & PositionInfo; + +export type Map = { [key: string]: T }; + +export type Alignment = 'auto' | 'end' | 'start' | 'center'; + +export type IndexRange = { + startIndex: number, + stopIndex: number +} + +export type OverscanIndexRange = { + overscanStartIndex: number, + overscanStopIndex: number, +} + +export type ScrollEventData = { + clientHeight: number, + scrollHeight: number, + scrollTop: number +} \ No newline at end of file From 7835e89a401fae0283530a91db2846e00e3dbf31 Mon Sep 17 00:00:00 2001 From: Kalle Ott Date: Tue, 28 Mar 2017 09:21:51 +0200 Subject: [PATCH 028/844] fixed tsconfig --- types/react-virtualized/tsconfig.json | 40 +++++++++++++++++---------- 1 file changed, 26 insertions(+), 14 deletions(-) diff --git a/types/react-virtualized/tsconfig.json b/types/react-virtualized/tsconfig.json index 6be15dbe8a..7e2936975f 100644 --- a/types/react-virtualized/tsconfig.json +++ b/types/react-virtualized/tsconfig.json @@ -19,20 +19,32 @@ }, "files": [ "index.d.ts", - "ArrowKeyStepper.d.ts", - "AutoSizer.d.ts", - "CellMeasurer.d.ts", - "Collection.d.ts", - "ColumnSizer.d.ts", - "genericTypes.d.ts", - "Grid.d.ts", - "InfiniteLoader.d.ts", - "List.d.ts", - "Masonry.d.ts", - "MultiGrid.d.ts", - "ScrollSync.d.ts", - "Table.d.ts", - "WindowScroller.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 From 51fda94d0497b362656fea922022ef5a12014a0a Mon Sep 17 00:00:00 2001 From: Wayne Dela Cruz Date: Tue, 28 Mar 2017 21:10:03 +0800 Subject: [PATCH 029/844] Add specific typings to css overflow props CSS overflows are any one of the ff. auto, hidden, scroll, visible Applied those to overflow, overlowX, and overflowY --- types/react/index.d.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/types/react/index.d.ts b/types/react/index.d.ts index 73cb0ae16f..969c86f353 100644 --- a/types/react/index.d.ts +++ b/types/react/index.d.ts @@ -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. From 6f8a10f1a1d343328e2047fc7c0a9f642fde6912 Mon Sep 17 00:00:00 2001 From: Wayne Dela Cruz Date: Tue, 28 Mar 2017 21:12:19 +0800 Subject: [PATCH 030/844] Wrote tests for css overflow props --- types/react/test/cssProperties.tsx | 3 +++ 1 file changed, 3 insertions(+) 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 }; From 1436b17cd246b68dc7e1434d682ebe8bf2a327a1 Mon Sep 17 00:00:00 2001 From: KeitaNishimoto Date: Tue, 28 Mar 2017 22:46:35 +0900 Subject: [PATCH 031/844] fix Corrected the structure of "AuthResponseContext" was wrong --- types/aws-lambda/index.d.ts | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/types/aws-lambda/index.d.ts b/types/aws-lambda/index.d.ts index d8507ef7de..4e94e5782c 100644 --- a/types/aws-lambda/index.d.ts +++ b/types/aws-lambda/index.d.ts @@ -221,9 +221,7 @@ interface Statement { * http://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html#api-gateway-custom-authorizer-output */ interface AuthResponseContext { - stringKey: string; - numberKey: number; - booleanKey: boolean; + [name: string]: string | number | boolean; } /** From 294118edad7a385f019da21925e7cf51147049c9 Mon Sep 17 00:00:00 2001 From: Huy Nguyen Date: Tue, 28 Mar 2017 16:17:05 -0400 Subject: [PATCH 032/844] Add type definition for react-router-redux v5 For the latest version (v5) of react-router-redux, the package was moved from [an external repo](https://github.com/reactjs/react-router-redux) to [live alongside](https://github.com/ReactTraining/react-router/tree/master/packages/react-router-redux) the react-router code base. The API has also changed significantly and merits a freshly written type definition. The current version (v4) was moved into its own directory. --- types/react-router-redux/index.d.ts | 102 +++++++++--------- .../react-router-redux-tests.tsx | 46 ++++++++ types/react-router-redux/tsconfig.json | 9 +- types/react-router-redux/tslint.json | 7 +- types/react-router-redux/v4/index.d.ts | 63 +++++++++++ types/react-router-redux/v4/package.json | 5 + .../{ => v4}/react-router-redux-tests.ts | 0 types/react-router-redux/v4/tsconfig.json | 28 +++++ types/react-router-redux/v4/tslint.json | 6 ++ 9 files changed, 211 insertions(+), 55 deletions(-) create mode 100644 types/react-router-redux/react-router-redux-tests.tsx create mode 100644 types/react-router-redux/v4/index.d.ts create mode 100644 types/react-router-redux/v4/package.json rename types/react-router-redux/{ => v4}/react-router-redux-tests.ts (100%) create mode 100644 types/react-router-redux/v4/tsconfig.json create mode 100644 types/react-router-redux/v4/tslint.json diff --git a/types/react-router-redux/index.d.ts b/types/react-router-redux/index.d.ts index 9f8044a7c0..5638b135b9 100644 --- a/types/react-router-redux/index.d.ts +++ b/types/react-router-redux/index.d.ts @@ -1,59 +1,65 @@ -// Type definitions for react-router-redux 4.0 -// Project: https://github.com/rackt/react-router-redux -// Definitions by: Isman Usoh , Noah Shipley , Dimitri Rosenberg , Karol Janyst , Dovydas Navickas +// Type definitions for react-router-redux 5.0 +// Project: https://github.com/ReactTraining/react-router/tree/master/packages/react-router-redux +// Definitions by: Huy Nguyen // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -// TypeScript Version: 2.1 +// TypeScript Version: 2.2 -import { Action, Middleware, Store } from "redux"; -import { History, Location, LocationDescriptor } from "history"; +import { + Store, + Dispatch, + Action, + Middleware +} from 'redux'; +import { + History, + Location, + Path, + LocationState, + LocationDescriptorObject +} from 'history'; +import * as React from 'react'; -export const CALL_HISTORY_METHOD: string; -export const LOCATION_CHANGE: string; +export interface ConnectedRouterProps { + store?: Store, + history?: History +} +export class ConnectedRouter extends React.Component, {}> {} + +export const LOCATION_CHANGE = '@@router/LOCATION_CHANGE' + +export interface RouterState { + location: Location | null +} + +export function routerReducer(state?: RouterState, action?: RouterAction): RouterState + +export const CALL_HISTORY_METHOD = '@@router/LOCATION_CHANGE'; + +export function push(path: Path, state?: LocationState): RouterAction +export function push(location: LocationDescriptorObject): RouterAction +export function replace(path: Path, state?: LocationState): RouterAction +export function replace(location: LocationDescriptorObject): RouterAction +export function go(n: number): RouterAction +export function goBack(): RouterAction +export function goForward(): RouterAction + +export const routerAction: { + push: typeof push + replace: typeof replace + go: typeof go + goBack: typeof goBack + goForward: typeof goForward +} export interface LocationActionPayload { - method: string; - args?: any[]; + method: string, + args?: any[], } export interface RouterAction extends Action { - payload?: LocationActionPayload; + type: typeof CALL_HISTORY_METHOD, + payload: LocationActionPayload } -type LocationAction = (nextLocation: LocationDescriptor) => RouterAction; -type GoAction = (n: number) => RouterAction; -type NavigateAction = () => RouterAction; +export function routerMiddleware(history: History): Middleware -export const push: LocationAction; -export const replace: LocationAction; -export const go: GoAction; -export const goBack: NavigateAction; -export const goForward: NavigateAction; - -interface RouteActions { - push: typeof push; - replace: typeof replace; - go: typeof go; - goForward: typeof goForward; - goBack: typeof goBack; -} - -export const routerActions: RouteActions; - -export interface RouterState { - locationBeforeTransitions: Location; -} - -export type DefaultSelectLocationState = (state: any) => RouterState; - -export interface SyncHistoryWithStoreOptions { - selectLocationState?: DefaultSelectLocationState; - adjustUrlOnReplay?: boolean; -} - -export interface HistoryUnsubscribe { - unsubscribe(): void; -} - -export function routerReducer(state?: RouterState, action?: Action): RouterState; -export function syncHistoryWithStore(history: History, store: Store, options?: SyncHistoryWithStoreOptions): History & HistoryUnsubscribe; -export function routerMiddleware(history: History): Middleware; diff --git a/types/react-router-redux/react-router-redux-tests.tsx b/types/react-router-redux/react-router-redux-tests.tsx new file mode 100644 index 0000000000..cd2c42167d --- /dev/null +++ b/types/react-router-redux/react-router-redux-tests.tsx @@ -0,0 +1,46 @@ +import * as React from 'react' +import * as ReactDOM from 'react-dom' + +import { createStore, combineReducers, applyMiddleware, Reducer } from 'redux' +import { Provider } from 'react-redux' + +import createHistory from 'history/createBrowserHistory' +import { Route } from 'react-router' + +import { ConnectedRouter, routerReducer, routerMiddleware, push, RouterState } from 'react-router-redux' + +// Create a history of your choosing (we're using a browser history in this case) +const history = createHistory() + +// Build the middleware for intercepting and dispatching navigation actions +const middleware = routerMiddleware(history) + +interface State { + router: RouterState +} + +// For testing, assume the router reducer is the only sub-reducer: +const reducers: Reducer = combineReducers({router: routerReducer}) + +// Add the reducer to your store on the `router` key +// Also apply our middleware for navigating +const store = createStore( + reducers, + applyMiddleware(middleware) +) + +const Home = () =>
Home
+ReactDOM.render( + + { /* ConnectedRouter will use the store from Provider automatically */ } + +
+ +
+ + , + document.getElementById('root') +) + +// Now you can dispatch navigation actions from anywhere! +store.dispatch(push('/foo')) diff --git a/types/react-router-redux/tsconfig.json b/types/react-router-redux/tsconfig.json index 7e9539f9dd..bd33709ea0 100644 --- a/types/react-router-redux/tsconfig.json +++ b/types/react-router-redux/tsconfig.json @@ -8,20 +8,17 @@ "noImplicitAny": true, "noImplicitThis": true, "strictNullChecks": true, + "jsx": "react", "baseUrl": "../", "typeRoots": [ - "../" + "../" ], - "paths": { - "history": ["history/v3"], - "history/*": ["history/v3/*"] - }, "types": [], "noEmit": true, "forceConsistentCasingInFileNames": true }, "files": [ "index.d.ts", - "react-router-redux-tests.ts" + "react-router-redux-tests.tsx" ] } diff --git a/types/react-router-redux/tslint.json b/types/react-router-redux/tslint.json index 377cc837d4..f05741c59b 100644 --- a/types/react-router-redux/tslint.json +++ b/types/react-router-redux/tslint.json @@ -1 +1,6 @@ -{ "extends": "../tslint.json" } +{ + "extends": "../tslint.json", + "rules": { + "forbidden-types": false + } +} diff --git a/types/react-router-redux/v4/index.d.ts b/types/react-router-redux/v4/index.d.ts new file mode 100644 index 0000000000..90d403da24 --- /dev/null +++ b/types/react-router-redux/v4/index.d.ts @@ -0,0 +1,63 @@ +// Type definitions for react-router-redux 4.0 +// Project: https://github.com/rackt/react-router-redux +// Definitions by: Isman Usoh , +// Noah Shipley , +// Dimitri Rosenberg , +// Karol Janyst , +// Dovydas Navickas +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.1 + +import { Action, Middleware, Store } from "redux"; +import { History, Location, LocationDescriptor } from "history"; + +export const CALL_HISTORY_METHOD: string; +export const LOCATION_CHANGE: string; + +export interface LocationActionPayload { + method: string; + args?: any[]; +} + +export interface RouterAction extends Action { + payload?: LocationActionPayload; +} + +type LocationAction = (nextLocation: LocationDescriptor) => RouterAction; +type GoAction = (n: number) => RouterAction; +type NavigateAction = () => RouterAction; + +export const push: LocationAction; +export const replace: LocationAction; +export const go: GoAction; +export const goBack: NavigateAction; +export const goForward: NavigateAction; + +interface RouteActions { + push: typeof push; + replace: typeof replace; + go: typeof go; + goForward: typeof goForward; + goBack: typeof goBack; +} + +export const routerActions: RouteActions; + +export interface RouterState { + locationBeforeTransitions: Location; +} + +export type DefaultSelectLocationState = (state: any) => RouterState; + +export interface SyncHistoryWithStoreOptions { + selectLocationState?: DefaultSelectLocationState; + adjustUrlOnReplay?: boolean; +} + +export interface HistoryUnsubscribe { + unsubscribe(): void; +} + +export function routerReducer(state?: RouterState, action?: Action): RouterState; +export function syncHistoryWithStore(history: History, store: Store, options?: SyncHistoryWithStoreOptions): History & HistoryUnsubscribe; +export function routerMiddleware(history: History): Middleware; diff --git a/types/react-router-redux/v4/package.json b/types/react-router-redux/v4/package.json new file mode 100644 index 0000000000..36ce503807 --- /dev/null +++ b/types/react-router-redux/v4/package.json @@ -0,0 +1,5 @@ +{ + "dependencies": { + "redux": "^3.6.0" + } +} diff --git a/types/react-router-redux/react-router-redux-tests.ts b/types/react-router-redux/v4/react-router-redux-tests.ts similarity index 100% rename from types/react-router-redux/react-router-redux-tests.ts rename to types/react-router-redux/v4/react-router-redux-tests.ts diff --git a/types/react-router-redux/v4/tsconfig.json b/types/react-router-redux/v4/tsconfig.json new file mode 100644 index 0000000000..83cf349881 --- /dev/null +++ b/types/react-router-redux/v4/tsconfig.json @@ -0,0 +1,28 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6", + "dom" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../../", + "typeRoots": [ + "../../" + ], + "paths": { + "history": ["history/v3"], + "history/*": ["history/v3/*"], + "react-router-redux": ["react-router-redux/v4"] + }, + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "react-router-redux-tests.ts" + ] +} diff --git a/types/react-router-redux/v4/tslint.json b/types/react-router-redux/v4/tslint.json new file mode 100644 index 0000000000..f05741c59b --- /dev/null +++ b/types/react-router-redux/v4/tslint.json @@ -0,0 +1,6 @@ +{ + "extends": "../tslint.json", + "rules": { + "forbidden-types": false + } +} From a3ecd4e75f0e2ca366cc879a2465e2f200ddc83c Mon Sep 17 00:00:00 2001 From: Erik Krogh Kristensen Date: Tue, 28 Mar 2017 22:37:22 +0200 Subject: [PATCH 033/844] Leaflet: Changed the extension methods back to methods. --- types/leaflet/index.d.ts | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/types/leaflet/index.d.ts b/types/leaflet/index.d.ts index 0efffe8f9e..ae18f8aa6f 100644 --- a/types/leaflet/index.d.ts +++ b/types/leaflet/index.d.ts @@ -424,11 +424,11 @@ declare namespace L { getTooltip(): Tooltip | undefined; // Extension methods - onAdd?: (map: Map) => this; - onRemove?: (map: Map) => this; - getEvents?: () => {[name: string]: (event: Event) => void}; - getAttribution?: () => string | null; - beforeAdd?: (map: Map) => this; + onAdd?(map: Map) : this; + onRemove?(map: Map) : this; + getEvents?() : {[name: string]: (event: Event) => void}; + getAttribution?() : string | null; + beforeAdd?(map: Map) : this; } interface GridLayerOptions { @@ -992,8 +992,8 @@ declare namespace L { remove(): this; // Extension methods - onAdd?: (map: Map) => HTMLElement; - onRemove?: (map: Map) => void; + onAdd?(map: Map) : HTMLElement; + onRemove?(map: Map) : void; options: ControlOptions; } @@ -1175,8 +1175,8 @@ declare namespace L { enabled(): boolean; // Extension methods - addHooks?: () => void; - removeHooks?: () => void; + addHooks?() : void; + removeHooks?() : void; } interface Event { From e4aac9b800c31ce5cc3cc9fef050be50094f4439 Mon Sep 17 00:00:00 2001 From: Justin Firth Date: Tue, 28 Mar 2017 18:02:51 -0400 Subject: [PATCH 034/844] Improve inference and coercion of specific HTMLElement types in hyperscript; Fix lint errors in hyperscript tests --- types/hyperscript/hyperscript-tests.ts | 14 ++++++++++++++ types/hyperscript/index.d.ts | 8 ++++++-- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/types/hyperscript/hyperscript-tests.ts b/types/hyperscript/hyperscript-tests.ts index f4bab0550a..02ea158977 100644 --- a/types/hyperscript/hyperscript-tests.ts +++ b/types/hyperscript/hyperscript-tests.ts @@ -56,3 +56,17 @@ h2('a', {href: '#', }, "Click this") h2.cleanup() + +/* Polymorphic type tests */ + +// determine proper HTMLElement type from tagName +let test1: HTMLCanvasElement = h('canvas'); + +// allow coercion of decorated tagName to proper type +let test2: HTMLCanvasElement = h('canvas#test2'); + +// inline coercion if you were feeling pedantic +// example +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..b57aa455f6 100644 --- a/types/hyperscript/index.d.ts +++ b/types/hyperscript/index.d.ts @@ -6,8 +6,12 @@ declare module 'hyperscript' { interface HyperScript { - /** Creates an HTML element */ - (tagName: string, ...args: any[]): HTMLElement; + /** Creates a typed HTMLElement */ + (tagName: T, attrs?: Object, ...children: any[]): HTMLElementTagNameMap[T]; + /** Creates a typed HTMLElement via coercion */ + (tagName: string, attrs?: Object, ...children: any[]): T; + /** Creates an HTMLElement */ + (tagName: T, attrs?: Object, ...children: any[]): HTMLElement; /** Cleans up any event handlers created by this hyperscript context */ cleanup(): void; /** Creates a new hyperscript context */ From 4a2542e4aff839c3d187f45c21566138abf8cac1 Mon Sep 17 00:00:00 2001 From: Michael Strobel Date: Mon, 27 Mar 2017 11:26:32 +0800 Subject: [PATCH 035/844] react-router MemoryRouter.initialEntries * Use History.LocationDescriptor[] * Add example --- types/react-router/index.d.ts | 2 +- types/react-router/test/MemoryRouter.tsx | 43 ++++++++++++++++++++++++ types/react-router/tsconfig.json | 1 + 3 files changed, 45 insertions(+), 1 deletion(-) create mode 100644 types/react-router/test/MemoryRouter.tsx diff --git a/types/react-router/index.d.ts b/types/react-router/index.d.ts index a3e05a29cb..4eb3aa14f9 100644 --- a/types/react-router/index.d.ts +++ b/types/react-router/index.d.ts @@ -30,7 +30,7 @@ declare module 'react-router' { } } interface MemoryRouterProps { - initialEntries?: H.Location[]; + initialEntries?: H.LocationDescriptor[]; initialIndex?: number; getUserConfirmation?: () => void; keyLength?: number; diff --git a/types/react-router/test/MemoryRouter.tsx b/types/react-router/test/MemoryRouter.tsx new file mode 100644 index 0000000000..1dd247acb2 --- /dev/null +++ b/types/react-router/test/MemoryRouter.tsx @@ -0,0 +1,43 @@ +import * as React from 'react' +import { + MemoryRouter, + Route, + Link +} from 'react-router-dom' + +const initialRouterEntries = [ + '/', + { + pathname: '/about' + } +] + +const MemoryRouterExample = () => ( + +
+
    +
  • Home
    • +
  • About
    • +
+ +
+ + + +
+ +) + +const Home = () => ( +
+

Home

+
+) + +const About = () => ( +
+

About

+
+) + +export default MemoryRouterExample diff --git a/types/react-router/tsconfig.json b/types/react-router/tsconfig.json index 239a137bbc..9ae373d000 100644 --- a/types/react-router/tsconfig.json +++ b/types/react-router/tsconfig.json @@ -21,6 +21,7 @@ "test/CustomLink.tsx", "test/ModalGallery.tsx", "test/NavigateWithContext.tsx", + "test/MemoryRouter.tsx", "test/NoMatch.tsx", "test/Params.tsx", "test/PreventingTransitions.tsx", From 8e1326969fa23e5da1e8ce7c6b054e16812b2f92 Mon Sep 17 00:00:00 2001 From: spacejack Date: Tue, 28 Mar 2017 20:47:25 -0400 Subject: [PATCH 036/844] Type definitions for Mithril 1.1 --- types/mithril/hyperscript.d.ts | 3 + types/mithril/index.d.ts | 1059 ++++-------------- types/mithril/mithril-tests.ts | 55 - types/mithril/mount.d.ts | 3 + types/mithril/redraw.d.ts | 3 + types/mithril/render.d.ts | 3 + types/mithril/request.d.ts | 3 + types/mithril/route.d.ts | 3 + types/mithril/stream/index.d.ts | 44 + types/mithril/test/test-api.ts | 738 ++++++++++++ types/mithril/test/test-class-component.ts | 135 +++ types/mithril/test/test-component.ts | 160 +++ types/mithril/test/test-factory-component.ts | 179 +++ types/mithril/test/test-fragment.ts | 17 + types/mithril/test/test-jsonp.ts | 27 + types/mithril/test/test-misc.ts | 16 + types/mithril/test/test-request.ts | 73 ++ types/mithril/test/test-route.ts | 60 + types/mithril/test/test-stream.ts | 391 +++++++ types/mithril/tsconfig.json | 60 +- types/mithril/tslint.json | 54 + types/mithril/withAttr.d.ts | 3 + 22 files changed, 2191 insertions(+), 898 deletions(-) create mode 100644 types/mithril/hyperscript.d.ts delete mode 100644 types/mithril/mithril-tests.ts create mode 100644 types/mithril/mount.d.ts create mode 100644 types/mithril/redraw.d.ts create mode 100644 types/mithril/render.d.ts create mode 100644 types/mithril/request.d.ts create mode 100644 types/mithril/route.d.ts create mode 100644 types/mithril/stream/index.d.ts create mode 100644 types/mithril/test/test-api.ts create mode 100644 types/mithril/test/test-class-component.ts create mode 100644 types/mithril/test/test-component.ts create mode 100644 types/mithril/test/test-factory-component.ts create mode 100644 types/mithril/test/test-fragment.ts create mode 100644 types/mithril/test/test-jsonp.ts create mode 100644 types/mithril/test/test-misc.ts create mode 100644 types/mithril/test/test-request.ts create mode 100644 types/mithril/test/test-route.ts create mode 100644 types/mithril/test/test-stream.ts create mode 100644 types/mithril/tslint.json create mode 100644 types/mithril/withAttr.d.ts diff --git a/types/mithril/hyperscript.d.ts b/types/mithril/hyperscript.d.ts new file mode 100644 index 0000000000..6f83f2244f --- /dev/null +++ b/types/mithril/hyperscript.d.ts @@ -0,0 +1,3 @@ +import { Hyperscript } from "mithril"; +declare const h: Hyperscript; +export = h; diff --git a/types/mithril/index.d.ts b/types/mithril/index.d.ts index d1c2ba78a6..adfc9cd117 100644 --- a/types/mithril/index.d.ts +++ b/types/mithril/index.d.ts @@ -1,863 +1,280 @@ -// Type definitions for Mithril +// Type definitions for Mithril 1.1 // Project: http://lhorie.github.io/mithril/ -// Definitions by: Leo Horie , Chris Bowdon +// Definitions by: Leo Horie , Chris Bowdon , Mike Linkovich , AndrĂ¡s Parditka // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.2 -// Mithril type definitions for Typescript - -/** -* This is the module containing all the types/declarations/etc. for Mithril -*/ declare namespace Mithril { - interface ChildArray extends Array {} - type Children = Child | ChildArray; - type Child = string | VirtualElement | Component; - interface Static { - /** - * Creates a virtual element for use with m.render, m.mount, etc. - * - * @param selector A simple CSS selector. May include SVG tags. Nested - * selectors are not supported. - * @param attributes Attributes to add. Any DOM attribute may be used - * as an attribute, although innerHTML and the like may be overwritten - * silently. - * @param children Child elements, components, and text to add. - * @return A virtual element. - * - * @see m.render - * @see m.mount - * @see m.component - */ - ( - selector: string, - ...children: Children[] - ): VirtualElement; - - /** - * Creates a virtual element for use with m.render, m.mount, etc. - * - * @param selector A simple CSS selector. May include SVG tags. Nested - * selectors are not supported. - * @param attributes Attributes to add. Any DOM attribute may be used - * as an attribute, although innerHTML and the like may be overwritten - * silently. - * @param children Child elements, components, and text to add. - * @return A virtual element. - * - * @see m.render - * @see m.mount - * @see m.component - */ - ( - selector: string, - attributes: Attributes, - ...children: Children[] - ): VirtualElement; - - /** - * Initializes a component for use with m.render, m.mount, etc. - * - * @param component A component. - * @param args Arguments to optionally pass to the component. - * @return A component. - * - * @see m.render - * @see m.mount - * @see m - */ - ( - component: Component, - ...args: any[] - ): Component; - - /** - * Creates a getter-setter function that wraps a Mithril promise. Useful - * for uniform data access, m.withAttr, etc. - * - * @param promise A thennable to initialize the property with. It may - * optionally be a Mithril promise. - * @return A getter-setter function wrapping the promise. - * - * @see m.withAttr - */ - prop(promise: Thennable) : Promise; - - /** - * Creates a getter-setter function that wraps a simple value. Useful - * for uniform data access, m.withAttr, etc. - * - * @param value A value to initialize the property with - * @return A getter-setter function wrapping the value. - * - * @see m.withAttr - */ - prop(value: T): BasicProperty; - - /** - * Creates a getter-setter function that wraps a simple value. Useful - * for uniform data access, m.withAttr, etc. - * - * @return A getter-setter function wrapping the value. - * - * @see m.withAttr - */ - prop(): BasicProperty; - - /** - * Returns a event handler that can be bound to an element, firing with - * the specified property. - * - * @param property The property to get from the event. - * @param callback The handler to use the value from the event. - * @return A function suitable for listening to an event. - */ - withAttr( - property: string, - callback: (value: any) => any, - callbackThis?: any - ): (e: Event) => void; - - /** - * @deprecated Use m.mount instead - */ - module( - rootElement: Node, - component: Component - ): T; - - /** - * Mounts a component to a base DOM node. - * - * @param rootElement The base node. - * @param component The component to mount. - * @return An instance of the top-level component's controller - */ - mount( - rootElement: Node, - component: Component - ): T; - - /** - * Initializes a component for use with m.render, m.mount, etc. - * - * @param selector A component. - * @param args Arguments to optionally pass to the component. - * @return A component. - * - * @see m.render - * @see m.mount - * @see m - */ - component( - component: Component, - ...args: any[] - ): Component; - - /** - * Trust this string of HTML. - * - * @param html The HTML to trust - * @return A String object instance with an added internal flag to mark - * it as trusted. - */ - trust(html: string): TrustedString; - - /** - * Render a virtual DOM tree. - * - * @param rootElement The base element/node to render the tree from. - * @param children One or more child nodes to add to the tree. - * @param forceRecreation If true, overwrite the entire tree without - * diffing against it. - */ - render( - rootElement: Element, - children: VirtualElement|VirtualElement[], - forceRecreation?: boolean - ): void; - - redraw: { - /** - * Force a redraw the active component. It redraws asynchronously by - * default to allow for simultaneous events to run before redrawing, - * such as the event combination keypress + input frequently used for - * input. - * - * @param force If true, redraw synchronously. - */ - (force?: boolean): void; - - /** - * Gets/sets the current redraw strategy, which returns one of the - * following: - * - * "all" - recreates the DOM tree from scratch - * "diff" - recreates the DOM tree from scratch - * "none" - leaves the DOM tree intact - * - * This is useful for event handlers, which may want to cancel - * the next redraw if the event doesn't update the UI. - * - * @return The current strategy - */ - strategy: BasicProperty<"all" | "diff" | "none">; - } - - route: { - /** - * Enable routing, mounting a controller based on the route. It - * automatically mounts the components for you, starting with the one - * specified by the default route. - * - * @param rootElement The element to mount the active controller to. - * @param defaultRoute The route to start with. - * @param routes A key-value mapping of pathname to controller. - */ - ( - rootElement: Element, - defaultRoute: string, - routes: Routes - ): void; - - /** - * This allows m.route to be used as the `config` attribute for a - * virtual element, particularly useful for cases like this: - * - * ```ts - * // Note that the '#' is not required in `href`, thanks to the - * `config` setting. - * m("a[href='/dashboard/alicesmith']", {config: m.route}); - * ``` - */ - ( - element: Element, - isInitialized: boolean, - context?: Context, - vdom?: VirtualElement - ): void; - - /** - * Programmatically redirect to another route. - * - * @param path The route to go to. - * @param params Parameters to pass as a query string. - * @param shouldReplaceHistory Whether to replace the current history - * instead of adding a new one. - */ - (path: string, params?: any, shouldReplaceHistory?: boolean): void; - - /** - * Gets the current route. - * - * @return The current route. - */ - (): string; - - /** - * Gets a route parameter. - * - * @param key The key to get. - * @return The value associated with the parameter key. - */ - param(key: string): string; - - /** - * The current routing mode. This may be changed before calling - * m.route to change the part of the URL used to perform the routing. - * - * The value can be set to one of the following, defaulting to - * "hash": - * - * "search" - Uses the query string. This allows for named anchors to - * work on the page, but changes cause IE8 and lower to refresh the - * page. - * - * "hash" - Uses the hash. This is the only routing mode that does - * not cause page refreshes on any browser, but it does not support - * named anchors. - * - * "pathname" - Uses the URL pathname. This requires server-side - * setup to support bookmarking and page refreshes. It always causes - * page refreshes on IE8 and lower. Note that this requires that the - * application to be run from the root of the URL. - */ - mode: "search" | "hash" | "pathname"; - - /** - * Serialize an object into a query string. - * - * @param data The data to serialize. - * @return The serialized string. - */ - buildQueryString(data: Object): string; - - /** - * Parse a query string into an object. - * - * @param data The data to parse. - * @return The parsed object data. - */ - parseQueryString(data: string): Object; - } - - /** - * Send an XHR request to a server. Note that the `url` option is - * required. - * - * @param options The options to use for the request. - * @return A promise to the returned data, or void if not applicable. - * - * @see XHROptions for the available options. - */ - request(options: XHROptions): Promise - - /** - * Send a JSONP request to a server. Note that the `url` option is - * required. - * - * @param options The options to use - * @return A promise to the returned data. - * - * @see JSONPOptions for the available options. - */ - request(options: JSONPOptions): Promise; - - deferred: { - /** - * Create a Mithril deferred object. It behaves synchronously if - * possible, an intentional deviation from Promises/A+. Note that - * deferreds are completely separate from the redrawing system, and - * never trigger a redraw on their own. - * - * @return A new Mithril deferred instance. - * - * @see m.deferred.onerror for the error callback called for Error - * subclasses - */ - (): Deferred; - - /** - * A callback for all uncaught native Error subclasses in deferreds. - * This defaults to synchronously rethrowing all errors, a deviation - * from Promises/A+, but the behavior is configurable. To restore - * Promises/A+-compatible behavior. simply set this to a no-op. - */ - onerror(e: Error): void; - } - - /** - * Takes a list of promises or thennables and returns a Mithril promise - * that resolves once all in the list are resolved, or rejects if any of - * them reject. - * - * @param promises A list of promises to try to resolve. - * @return A promise that resolves to all the promises if all resolve, or - * rejects with the error contained in the first rejection. - */ - sync(promises: Thennable[]): Promise; - - /** - * Use this and endComputation if your views aren't redrawing after - * calls to third-party libraries. For integrating asynchronous code, - * this should be called before any asynchronous work is done. For - * synchronous code, this should be called at the beginning of the - * problematic segment. Note that these calls must be balanced, much like - * braces and parentheses. This is mostly used internally. Prefer - * m.redraw where possible, especially when making repeated calls. - * - * @see endComputation - * @see m.render - */ - startComputation(): void; - - /** - * Use startComputation and this if your views aren't redrawing after - * calls to third-party libraries. For integrating asynchronous code, - * this should be called after all asynchronous work completes. For - * synchronous code, this should be called at the end of the problematic - * segment. Note that these calls must be balanced, much like braces and - * parentheses. This is mostly used internally. Prefer m.redraw where - * possible, especially when making repeated calls. - * - * @see startComputation - * @see m.render - */ - endComputation(): void; - - /** - * This overwrites the internal version of window used by Mithril. - * It's mostly useful for testing, and is also used internally by - * Mithril to test itself. By default Mithril uses `window` for the - * dependency. - * - * @param mockWindow The mock to use for the window. - * @return The mock that was passed in. - */ - deps(mockWindow: Window): Window; + export interface Lifecycle { + /** Any property attached to the component object is copied for every instance of the component. This allows simple state initialization. */ + [propName: string]: any; + /** The oninit hook is called before a vnode is touched by the virtual DOM engine. */ + oninit?: (this: State, vnode: Vnode) => any; + /** The oncreate hook is called after a DOM element is created and attached to the document. */ + oncreate?: (this: State, vnode: VnodeDOM) => any; + /** The onbeforeupdate hook is called before a vnode is diffed in a update. */ + onbeforeremove?: (this: State, vnode: VnodeDOM) => Promise | void; + /** The onupdate hook is called after a DOM element is updated, while attached to the document. */ + onremove?: (this: State, vnode: VnodeDOM) => any; + /** The onbeforeremove hook is called before a DOM element is detached from the document. If a Promise is returned, Mithril only detaches the DOM element after the promise completes. */ + onbeforeupdate?: (this: State, vnode: Vnode, old: VnodeDOM) => boolean | void; + /** The onremove hook is called before a DOM element is removed from the document. */ + onupdate?: (this: State, vnode: VnodeDOM) => any; } - interface TrustedString extends String { - /** @private Implementation detail. Don't depend on it. */ - $trusted: boolean; + export interface Hyperscript { + /** Creates a virtual element (Vnode). */ + (selector: string, ...children: Children[]): Vnode; + /** Creates a virtual element (Vnode). */ + (selector: string, attributes: Attributes, ...children: Children[]): Vnode; + /** Creates a virtual element (Vnode). */ + (component: ComponentTypes, attributes: Attrs & Lifecycle & { key?: string | number }, ...args: Children[]): Vnode; + /** Creates a virtual element (Vnode). */ + (component: ComponentTypes, ...args: Children[]): Vnode; + /** Creates a fragment virtual element (Vnode). */ + fragment(attrs: Lifecycle & { [key: string]: any }, children: ChildArrayOrPrimitive): Vnode; + /** Turns an HTML string into a virtual element (Vnode). Do not use trust on unsanitized user input. */ + trust(html: string): Vnode; } - /** - * The interface for a virtual element. It's best to consider this immutable - * for most use cases. - * - * @see m - */ - interface VirtualElement { - /** - * The tag name of this element. - */ - tag: string; - - /** - * The attributes of this element. - */ - attrs: Attributes; - - /** - * The children of this element. - */ - children: Children[]; + export interface RouteResolver { + /** The onmatch hook is called when the router needs to find a component to render. */ + render?: (this: State, vnode: Vnode) => Children; + /** The render method is called on every redraw for a matching route. */ + onmatch?: (args: Params, requestedPath: string) => Component | Promise | void; } - /** - * An event passed by Mithril to unload event handlers. - */ - interface Event { - /** - * Prevent the default behavior of scrolling the page and updating the - * URL on next route change. - */ - preventDefault(): void; + /** This represents a key-value mapping linking routes to components. */ + export interface RouteDefs { + /** The key represents the route. The value represents the corresponding component. */ + [url: string]: ComponentTypes | RouteResolver; } - /** - * A context object for configuration functions. - * - * @see ElementConfig - */ - interface Context { - /** - * A function to call when the node is unloaded. Useful for cleanup. - */ - onunload?(): any; - - /** - * Set true if the backing DOM node needs to be retained between route - * changes if possible. Set false if this node needs to be recreated - * every single time, regardless of how "different" it is. - */ - retain?: boolean; + export interface RouteOptions { + /** Routing parameters. If path has routing parameter slots, the properties of this object are interpolated into the path string. */ + replace?: boolean; + /** The state object to pass to the underlying history.pushState / history.replaceState call.*/ + state?: any; + /** The title string to pass to the underlying history.pushState / history.replaceState call. */ + title?: string; } - /** - * This represents a callback function for a virtual element's config - * attribute. It's a low-level function useful for extra cleanup after - * removal from the tree, storing instances of third-party classes that - * need to be associated with the DOM, etc. - * - * @see Attributes - * @see Context - */ - interface ElementConfig { - /** - * A callback function for a virtual element's config attribute. - * - * @param element The associated DOM element. - * @param isInitialized Whether this is the first call for the virtual - * element or not. - * @param context The associated context for this element. - * @param vdom The associated virtual element. - */ - ( - element: Element, - isInitialized: boolean, - context: Context, - vdom: VirtualElement - ): void; + export interface Route { + /** Creates application routes and mounts Components and/or RouteResolvers to a DOM element. */ + (element: Element, defaultRoute: string, routes: RouteDefs): void; + /** Returns the last fully resolved routing path, without the prefix. */ + get(): string; + /** Redirects to a matching route or to the default route if no matching routes can be found. */ + set(route: string, data?: any, options?: RouteOptions): void; + /** Defines a router prefix which is a fragment of the URL that dictates the underlying strategy used by the router. */ + prefix(urlFragment: string): void; + /** This method is meant to be used in conjunction with an Vnode's oncreate hook. */ + link(vnode: Vnode): (e?: Event) => any; + /** Returns the named parameter value from the current route. */ + param(name: string): string; + /** Gets all route parameters. */ + param(): any; } - /** - * This represents the attributes available for configuring virtual elements, - * beyond the applicable DOM attributes. - * - * @see m - */ - interface Attributes { - /** - * The class name(s) for this virtual element, as a space-separated list. - */ - className?: string; - - /** - * The class name(s) for this virtual element, as a space-separated list. - */ - class?: string; - - /** - * A custom, low-level configuration in case this element needs special - * cleanup after removal from the tree. - * - * @see ElementConfig - */ - config?: ElementConfig; - - /** - * A key to optionally associate with this element. - */ - key?: string | number; - - /** - * Any other virtual element properties, including attributes and event - * handlers. - */ - [property: string]: any; + export interface Mount { + /** Mounts a component to a DOM element, enabling it to autoredraw on user events. */ + (element: Element, component: ComponentTypes | null): void; } - /** - * The basis of a Mithril controller instance. - */ - interface Controller { - /** - * An optional handler to call when the associated virtual element is - * destroyed. - * - * @param evt An associated event. - */ - onunload?(evt: Event): any; + export interface WithAttr { + /** Creates an event handler which takes the value of the specified DOM element property and calls a function with it as the argument. */ + (name: string, callback: (value: any) => any, thisArg?: any): (e: { currentTarget: any, [p: string]: any }) => void; } - /** - * This represents a controller function. - * - * @see ControllerConstructor - */ - interface ControllerFunction { - (...args: any[]): T; + export interface ParseQueryString { + /** Returns an object with key/value pairs parsed from a string of the form: ?a=1&b=2 */ + (queryString: string): { [p: string]: any }; } - /** - * This represents a controller constructor. - * - * @see ControllerFunction - */ - interface ControllerConstructor { - new (...args: any[]): T; + export interface BuildQueryString { + /** Turns the key/value pairs of an object into a string of the form: a=1&b=2 */ + (values: { [p: string]: any }): string; } - /** - * This represents a Mithril component. - * - * @see m - * @see m.component - */ - interface Component { - /** - * The component's controller. - * - * @see m.component - */ - controller: ControllerFunction | ControllerConstructor; - - /** - * Creates a view out of virtual elements. - * - * @see m.component - */ - view(ctrl?: T, ...args: any[]): VirtualElement; - } - - /** - * This is the base interface for property getter-setters - * - * @see m.prop - */ - interface Property { - /** - * Gets the contained value. - * - * @return The contained value. - */ - (): T; - - /** - * Sets the contained value. - * - * @param value The new value to set. - * @return The newly set value. - */ - (value: T): T; - } - - /** - * This represents a non-promise getter-setter functions. - * - * @see m.prop which returns objects that implement this interface. - */ - interface BasicProperty extends Property { - /** - * Makes this serializable to JSON. - */ - toJSON(): T; - } - - /** - * This represents a key-value mapping linking routes to components. - */ - interface Routes { - /** - * The key represents the route. The value represents the corresponding - * component. - */ - [key: string]: Component; - } - - /** - * This represents a Mithril deferred object. - */ - interface Deferred { - /** - * Resolve this deferred's promise with a value. - * - * @param value The value to resolve the promise with. - */ - resolve(value?: T): void; - - /** - * Reject this deferred with an error. - * - * @param value The reason for rejecting the promise. - */ - reject(reason?: any): void; - - /** - * The backing promise. - * - * @see Promise - */ - promise: Promise; - } - - /** - * This represents a thennable success callback. - */ - interface SuccessCallback { - (value: T): U | Thennable; - } - - /** - * This represents a thennable error callback. - */ - interface ErrorCallback { - (value: Error): T | Thennable; - } - - /** - * This represents a thennable. - */ - interface Thennable { - then(success: SuccessCallback): Thennable; - then(success: SuccessCallback, error: ErrorCallback): Thennable; - catch?(error: ErrorCallback): Thennable; - catch?(error: ErrorCallback): Thennable; - } - - /** - * This represents a Mithril promise object. - */ - interface Promise extends Thennable, Property> { - /** - * Chain this promise with a simple success callback, propogating - * rejections. - * - * @param success The callback to call when the promise is resolved. - * @return The chained promise. - */ - then(success: SuccessCallback): Promise; - - /** - * Chain this promise with a success callback and error callback, without - * propogating rejections. - * - * @param success The callback to call when the promise is resolved. - * @param error The callback to call when the promise is rejected. - * @return The chained promise. - */ - then(success: SuccessCallback, error: ErrorCallback): Promise; - - /** - * Chain this promise with a single error callback, without propogating - * rejections. - * - * @param error The callback to call when the promise is rejected. - * @return The chained promise. - */ - catch(error: ErrorCallback): Promise; - } - - /** - * These are the common options shared across normal and JSONP requests. - * - * @see m.request - */ - interface RequestOptions { - /** - * The data to be sent. It's automatically serialized in the right format - * depending on the method (with exception of HTML5 FormData), and put in - * the appropriate section of the request. - */ + export interface RequestOptions { + /** The HTTP method to use. */ + method?: string; + /** The data to be interpolated into the URL and serialized into the querystring (for GET requests) or body (for other types of requests). */ data?: any; - - /** - * Whether to run it in the background, i.e. true if it doesn't affect - * template rendering. - */ + /** Whether the request should be asynchronous. Defaults to true. */ + async?: boolean; + /** A username for HTTP authorization. */ + user?: string; + /** A password for HTTP authorization. */ + password?: string; + /** Whether to send cookies to 3rd party domains. */ + withCredentials?: boolean; + /** Exposes the underlying XMLHttpRequest object for low-level configuration. */ + config?: (xhr: XMLHttpRequest) => any; + /** Headers to append to the request before sending it. */ + headers?: any; + /** A constructor to be applied to each object in the response. */ + type?: new (o: any) => any; + /** A serialization method to be applied to data. Defaults to JSON.stringify, or if options.data is an instance of FormData, defaults to the identity function. */ + serialize?: (data: any) => any; + /** A deserialization method to be applied to the response. Defaults to a small wrapper around JSON.parse that returns null for empty responses. */ + deserialize?: (data: string) => T; + /** A hook to specify how the XMLHttpRequest response should be read. Useful for reading response headers and cookies. Defaults to a function that returns xhr.responseText */ + extract?: (xhr: XMLHttpRequest, options: RequestOptions) => T; + /** Force the use of the HTTP body section for data in GET requests when set to true, or the use of querystring for other HTTP methods when set to false. Defaults to false for GET requests and true for other methods. */ + useBody?: boolean; + /** If false, redraws mounted components upon completion of the request. If true, it does not. */ background?: boolean; + } - /** - * Set an initial value while the request is working, to populate the - * promise getter-setter. - */ - initialValue?: any; - - /** - * An optional preprocessor function to unwrap a successful response, in - * case the response contains metadata wrapping the data. - * - * @param data The data to unwrap. - * @return The unwrapped result. - */ - unwrapSuccess?(data: any): any; - - /** - * An optional preprocessor function to unwrap an unsuccessful response, - * in case the response contains metadata wrapping the data. - * - * @param data The data to unwrap. - * @return The unwrapped result. - */ - unwrapError?(data: any): any; - - /** - * An optional function to serialize the data. This defaults to - * `JSON.stringify`. - * - * @param dataToSerialize The data to serialize. - * @return The serialized form as a string. - */ - serialize?(dataToSerialize: any): string; - - /** - * An optional function to deserialize the data. This defaults to - * `JSON.parse`. - * - * @param dataToSerialize The data to parse. - * @return The parsed form. - */ - deserialize?(dataToDeserialize: string): any; - - /** - * An optional function to extract the data from a raw XMLHttpRequest, - * useful if the relevant data is in a response header or the status - * field. - * - * @param xhr The associated XMLHttpRequest. - * @param options The options passed to this request. - * @return string The serialized format. - */ - extract?(xhr: XMLHttpRequest, options: this): string; - - /** - * The parsed data, or its children if it's an array, will be passed to - * this class constructor if it's given, to parse it into classes. - * - * @param data The data to parse. - * @return The new instance for the list. - */ - type?: new (data: any) => any; - - /** - * The URL to send the request to. - */ + export interface RequestOptionsAll extends RequestOptions { + /** The URL to send the request to. */ url: string; } - /** - * This represents the available options for configuring m.request for JSONP - * requests. - * - * @see m.request - */ - interface JSONPOptions extends RequestOptions { - /** - * For JSONP requests, this must be the string "jsonp". Otherwise, it's - * ignored. - */ - dataType: "jsonp"; + export interface Request { + /** Makes an XHR request and returns a promise. */ + (options: RequestOptionsAll): Promise; + /** Makes an XHR request and returns a promise. */ + (url: string, options?: RequestOptions): Promise; + } - /** - * The querystring key for the JSONP request callback. This is useful for - * APIs that don't use common conventions, such as - * `www.example.com/?jsonpCallback=doSomething`. It defaults to - * `callback`. - */ + export interface JsonpOptions { + /** The data to be interpolated into the URL and serialized into the querystring. */ + data?: any; + /** A constructor to be applied to each object in the response. */ + type?: new (o: any) => any; + /** The name of the function that will be called as the callback. */ + callbackName?: string; + /** The name of the querystring parameter name that specifies the callback name. */ callbackKey?: string; - - /** - * The data to send with the request. This is automatically serialized - * to a querystring. - */ - data?: Object; + /** If false, redraws mounted components upon completion of the request. If true, it does not. */ + background?: boolean; } - /** - * This represents the available options for configuring m.request for - * standard AJAX requests. - * - * @see m.request - */ - interface XHROptions extends RequestOptions { - /** - * This represents the HTTP method used, defaulting to "GET". - */ - method: "GET" | "POST" | "PUT" | "DELETE" | "HEAD" | "OPTIONS"; + export interface JsonpOptionsAll extends JsonpOptions { + /** The URL to send the request to. */ + url: string; + } - /** - * The username for HTTP authentication. - */ - user?: string; + export interface Jsonp { + /** Makes a JSON-P request and returns a promise. */ + (options: JsonpOptionsAll): Promise; + /** Makes a JSON-P request and returns a promise. */ + (url: string, options?: JsonpOptions): Promise; + } - /** - * The password for HTTP authentication. - */ - password?: string; + export interface RequestService { + request: Request; + jsonp: Jsonp; + } - /** - * An optional function to run between `open` and `send`, useful for - * adding request headers or using XHR2 features such as the `upload` - * property. It is even possible to override the XHR altogether with a - * similar object, such as an XDomainRequest instance. - * - * @param xhr The associated XMLHttpRequest. - * @param options The options passed to this request. - * @return The new XMLHttpRequest, or nothing if the same one is kept. - */ - config?(xhr: XMLHttpRequest, options: this): any; + export interface Render { + /** Renders a vnode structure into a DOM element. */ + (el: Element, vnodes: Children): void; + } - /** - * The data to send with the request. - */ - data?: Object; + export interface RenderService { + render: Render + } + + export interface Redraw { + /** Manually triggers a redraw of mounted components. */ + (): void; + } + + export interface RedrawService { + redraw: Redraw + render: Render + } + + export interface Static extends Hyperscript { + route: Route; + /** Activates a component, enabling it to autoredraw on user events. */ + mount: Mount; + /** Returns a event handler that can be bound to an element, firing with the specified property. */ + withAttr: WithAttr; + render: Render; + redraw: Redraw; + request: Request; + jsonp: Jsonp; + /** Parse a query string into an object. */ + parseQueryString: ParseQueryString; + /** Serialize an object into a query string. */ + buildQueryString: BuildQueryString; + /** A string containing the semver value for the current Mithril release. */ + version: string; + } + + // Vnode children types + export type Child = Vnode | string | number | boolean | null | undefined; + export interface ChildArray extends Array { } + export type Children = Child | ChildArray; + export type ChildArrayOrPrimitive = ChildArray | string | number | boolean; + + /** Virtual DOM nodes, or vnodes, are Javascript objects that represent an element (or parts of the DOM). */ + export interface Vnode> { + /** The nodeName of a DOM element. It may also be the string [ if a vnode is a fragment, # if it's a text vnode, or < if it's a trusted HTML vnode. Additionally, it may be a component. */ + tag: string | Component; + /** A hashmap of DOM attributes, events, properties and lifecycle methods. */ + attrs: Attrs; + /** An object that is persisted between redraws. In component vnodes, state is a shallow clone of the component object. */ + state: State; + /** The value used to map a DOM element to its respective item in an array of data. */ + key?: string | number; + /** In most vnode types, the children property is an array of vnodes. For text and trusted HTML vnodes, The children property is either a string, a number or a boolean. */ + children?: ChildArrayOrPrimitive; + /** This is used instead of children if a vnode contains a text node as its only child. This is done for performance reasons. Component vnodes never use the text property even if they have a text node as their only child. */ + text?: string | number | boolean; + } + + // In some lifecycle methods, Vnode will have a dom property + // and possibly a domSize property. + export interface VnodeDOM extends Vnode { + + /** Points to the element that corresponds to the vnode. */ + dom: Element; + + /** This defines the number of DOM elements that the vnode represents (starting from the element referenced by the dom property). */ + domSize?: number; + } + + export interface CVnode extends Vnode> { } + + export interface CVnodeDOM extends VnodeDOM> { } + + /** Components are a mechanism to encapsulate parts of a view to make code easier to organize and/or reuse. Any Javascript object that has a view method is a Mithril component. Components can be consumed via the m() utility. */ + export interface Component> extends Lifecycle { + + /** Creates a view out of virtual elements. */ + view(this: State, vnode: Vnode): Children | null | void; + } + + export interface ClassComponent extends Lifecycle> { + view(this: ClassComponent, vnode: CVnode): Children | null | void; + } + + // Factory component + export type FactoryComponent = (vnode: Vnode) => Component + + /** Components are a mechanism to encapsulate parts of a view to make code easier to organize and/or reuse. Any Javascript object that has a view method is a Mithril component. Components can be consumed via the m() utility. */ + export type Comp> = Component & State; + + export type ComponentTypes = Component | { new (vnode: CVnode): ClassComponent } | FactoryComponent + + /** This represents the attributes available for configuring virtual elements, beyond the applicable DOM attributes.*/ + export interface Attributes extends Lifecycle { + /** The class name(s) for this virtual element, as a space-separated list. */ + className?: string; + /** The class name(s) for this virtual element, as a space-separated list. */ + class?: string; + /** A key to optionally associate with this element. */ + key?: string | number; + /** Any other virtual element properties, including attributes and event handlers. */ + [property: string]: any; } } -declare const m: Mithril.Static; - -declare module "mithril" { - export = m; -} +declare const Mithril: Mithril.Static; +export = Mithril; diff --git a/types/mithril/mithril-tests.ts b/types/mithril/mithril-tests.ts deleted file mode 100644 index 8479074e07..0000000000 --- a/types/mithril/mithril-tests.ts +++ /dev/null @@ -1,55 +0,0 @@ - -// This is the todolist example from http://lhorie.github.io/mithril/getting-started.html - -var todo = { - - //the Todo class has two properties - Todo: function(data: any) { - this.description = m.prop(data.description); - this.done = m.prop(false); - }, - - //the TodoList class is a list of Todo's - TodoList: Array, - - //the controller uses three model-level entities, of which one is a custom defined class: - //`Todo` is the central class in this application - //`list` is merely a generic array, with standard array methods - //`description` is a temporary storage box that holds a string - // - //the `add` method simply adds a new todo to the list - controller: function() { - this.list = new todo.TodoList(); - this.description = m.prop(""); - - this.add = function() { - if (this.description()) { - this.list.push(new (todo.Todo)({description: this.description()})); - this.description(""); - } - }.bind(this); - }, - - //here's the view - view: function(ctrl: any) { - return m("html", [ - m("body", [ - m("input", {onchange: m.withAttr("value", ctrl.description), value: ctrl.description()} as any /* TODO remove `as any` */), - m("button", {onclick: ctrl.add} as any /* TODO remove `as any` */, "Add"), - m("table", [ - ctrl.list.map(function(task: any) { - return m("tr", [ - m("td", [ - m("input[type=checkbox]", {onclick: m.withAttr("checked", task.done), checked: task.done()} as any /* TODO remove `as any` */) - ]), - m("td", {style: {textDecoration: task.done() ? "line-through" : "none"}} as any /* TODO remove `as any` */, task.description()), - ]) - }) - ]) - ]) - ]); - }, -}; - -//initialize the application -m.mount(document, todo); diff --git a/types/mithril/mount.d.ts b/types/mithril/mount.d.ts new file mode 100644 index 0000000000..c177527f84 --- /dev/null +++ b/types/mithril/mount.d.ts @@ -0,0 +1,3 @@ +import { Mount } from "mithril"; +declare const mount: Mount; +export = mount; diff --git a/types/mithril/redraw.d.ts b/types/mithril/redraw.d.ts new file mode 100644 index 0000000000..8206db5c0e --- /dev/null +++ b/types/mithril/redraw.d.ts @@ -0,0 +1,3 @@ +import { Redraw } from "mithril"; +declare const redraw: Redraw; +export = redraw; diff --git a/types/mithril/render.d.ts b/types/mithril/render.d.ts new file mode 100644 index 0000000000..72651f42b4 --- /dev/null +++ b/types/mithril/render.d.ts @@ -0,0 +1,3 @@ +import { Render } from "mithril"; +declare const render: Render; +export = render; diff --git a/types/mithril/request.d.ts b/types/mithril/request.d.ts new file mode 100644 index 0000000000..0e737a04e9 --- /dev/null +++ b/types/mithril/request.d.ts @@ -0,0 +1,3 @@ +import { Request } from "mithril"; +declare const request: Request; +export = request; diff --git a/types/mithril/route.d.ts b/types/mithril/route.d.ts new file mode 100644 index 0000000000..df8a13181c --- /dev/null +++ b/types/mithril/route.d.ts @@ -0,0 +1,3 @@ +import { Route } from "mithril"; +declare const route: Route; +export = route; diff --git a/types/mithril/stream/index.d.ts b/types/mithril/stream/index.d.ts new file mode 100644 index 0000000000..7c5c1b3be0 --- /dev/null +++ b/types/mithril/stream/index.d.ts @@ -0,0 +1,44 @@ +declare namespace Stream { + export type Combiner = (...streams: any[]) => T; + + export interface Stream { + /** Returns the value of the stream. */ + (): T; + /** Sets the value of the stream. */ + (value: T): this; + /** Creates a dependent stream whose value is set to the result of the callback function. */ + map(f: (current: T) => Stream | T | void): Stream; + /** Creates a dependent stream whose value is set to the result of the callback function. */ + map(f: (current: T) => Stream | U): Stream; + /** This method is functionally identical to stream. It exists to conform to Fantasy Land's Applicative specification. */ + of(val?: T): Stream; + /** Apply. */ + ap(f: Stream<(value: T) => U>): Stream; + /** A co-dependent stream that unregisters dependent streams when set to true. */ + end: Stream; + /** When a stream is passed as the argument to JSON.stringify(), the value of the stream is serialized.*/ + toJSON(): string; + /** Returns the value of the stream. */ + valueOf(): T; + } + + export interface Static { + /** Creates a stream. */ + (value?: T): Stream; + /** Creates a computed stream that reactively updates if any of its upstreams are updated. */ + combine(combiner: Combiner, streams: Stream[]): Stream; + /** Creates a stream whose value is the array of values from an array of streams. */ + merge(streams: Stream[]): Stream; + /** Creates a new stream with the results of calling the function on every incoming stream with and accumulator and the incoming value. */ + scan(fn: (acc: U, value: T) => U, acc: U, stream: Stream): Stream; + /** Takes an array of pairs of streams and scan functions and merges all those streams using the given functions into a single stream. */ + scanMerge(pairs: [Stream, (acc: U, value: T) => U][], acc: U): Stream; + /** Takes an array of pairs of streams and scan functions and merges all those streams using the given functions into a single stream. */ + scanMerge(pairs: [Stream, (acc: U, value: any) => U][], acc: U): Stream; + /** A special value that can be returned to stream callbacks to halt execution of downstreams. */ + readonly HALT: any; + } +} + +declare const Stream: Stream.Static; +export = Stream; diff --git a/types/mithril/test/test-api.ts b/types/mithril/test/test-api.ts new file mode 100644 index 0000000000..49fb8ebefc --- /dev/null +++ b/types/mithril/test/test-api.ts @@ -0,0 +1,738 @@ +// Typescript adaptation of mithril's test suite. +// Not intended to be run; only to compile & check types. + +import * as m from 'mithril' +import * as stream from 'mithril/stream' + +const FRAME_BUDGET = 100 + +{ + let vnode = m("div") + console.assert(vnode.tag === "div") + console.assert(typeof m.version === "string") + console.assert(m.version.indexOf(".") > -1) +} + +{ + const vnode = m.trust("
") +} + +{ + const vnode = m.fragment({key: 123}, [m("div")]) + console.assert((vnode.children as m.Vnode[]).length === 1) + console.assert(vnode.children![0].tag === 'div') +} + +{ + const handler = m.withAttr("value", (value) => {}) + handler({currentTarget: {value: 10}}) +} + +{ + const params = m.parseQueryString("?a=1&b=2") + const query = m.buildQueryString({a: 1, b: 2}) +} + +{ + const root = window.document.createElement("div") + m.render(root, m("div")) + console.assert(root.childNodes.length === 1) +} + +{ + const root = window.document.createElement("div") + m.mount(root, {view: function() {return m("div")}}) + console.assert(root.childNodes.length === 1) + console.assert(root.firstChild!.nodeName === "DIV") +} + +{ + const root = window.document.createElement("div") + m.route(root, "/a", { + "/a": {view: function() {return m("div")}} + }) + + setTimeout(function() { + console.assert(root.childNodes.length === 1) + console.assert(root.firstChild!.nodeName === "DIV") + }, FRAME_BUDGET) +} + +{ + const root = window.document.createElement("div") + m.route.prefix("#") + m.route(root, "/a", { + "/a": {view: function() {return m("div")}} + }) + + setTimeout(function() { + console.assert(root.childNodes.length === 1) + console.assert(root.firstChild!.nodeName === "DIV") + }, FRAME_BUDGET) +} + +{ + const root = window.document.createElement("div") + m.route(root, "/a", { + "/a": {view: function() {return m("div")}} + }) + + setTimeout(function() { + console.assert(m.route.get() === "/a") + }, FRAME_BUDGET) +} + +{ + const root = window.document.createElement("div") + m.route(root, "/a", { + "/:id": {view: function() {return m("div")}} + }) + + setTimeout(function() { + m.route.set("/b") + setTimeout(function() { + console.assert(m.route.get() === "/b") + }, FRAME_BUDGET) + }, FRAME_BUDGET) +} + +{ + let count = 0 + const root = window.document.createElement("div") + m.mount(root, {view: function() {count++}}) + setTimeout(function() { + m.redraw() + console.assert(count === 2) + }, FRAME_BUDGET) +} + +// +// Additional tests by andraaspar +// + +//////////////////////////////////////////////////////////////////////////////// +// http://mithril.js.org/hyperscript.html#components +//////////////////////////////////////////////////////////////////////////////// + +;(function() { + + // define a component + let Greeter: m.Comp<{}, {}> = { + view: function(vnode) { + return m("div", vnode.attrs, ["Hello ", vnode.children]) + } + } + + // consume it + m(Greeter, { style: "color:red;" }, "world") + +}) + +//////////////////////////////////////////////////////////////////////////////// +// http://mithril.js.org/hyperscript.html#keys +//////////////////////////////////////////////////////////////////////////////// + +;(function() { + + let users = [ + { id: 1, name: "John" }, + { id: 2, name: "Mary" }, + ] + + function userInputs(users: { id: number, name: string }[]) { + return users.map(function(u) { + return m("input", { key: u.id }, u.name) + }) + } + + m.render(document.body, userInputs(users)) + +}) + +//////////////////////////////////////////////////////////////////////////////// +// http://mithril.js.org/components.html#state +//////////////////////////////////////////////////////////////////////////////// + +;(function() { + let ComponentWithInitialState: m.Comp<{}, {data: string}> = { + data: "Initial content", + view: function(vnode) { + return m("div", vnode.state.data) + } + } + + m(ComponentWithInitialState) +}) + +;(function() { + let ComponentWithDynamicState: m.Comp<{text: string}, {data?: string}> = { + oninit: function(vnode) { + vnode.state.data = vnode.attrs.text + }, + view: function(vnode) { + return m("div", vnode.state.data) + } + } + + m(ComponentWithDynamicState, { text: "Hello" }) +}) + +;(function() { + let ComponentUsingThis: m.Comp<{text: string}, {data?: string}> = { + oninit: function(vnode) { + this.data = vnode.attrs.text + }, + view: function(vnode) { + return m("div", this.data) + } + } + + m(ComponentUsingThis, { text: "Hello" }) +}) + +//////////////////////////////////////////////////////////////////////////////// +// http://mithril.js.org/lifecycle-methods.html +//////////////////////////////////////////////////////////////////////////////// + +;(function() { + let Fader: m.Comp<{}, {}> = { + onbeforeremove: function(vnode) { + vnode.dom.classList.add("fade-out") + return new Promise(function(resolve) { + setTimeout(resolve, 1000) + }) + }, + view: function() { + return m("div", "Bye") + }, + } +}) + +//////////////////////////////////////////////////////////////////////////////// +// http://mithril.js.org/route.html#wrapping-a-layout-component +//////////////////////////////////////////////////////////////////////////////// + +;(function() { + + let Home = { + view: function() { + return "Welcome" + } + } + + let state = { + term: "", + search: function() { + // save the state for this route + // this is equivalent to `history.replaceState({term: state.term}, null, location.href)` + m.route.set(m.route.get(), null, { replace: true, state: { term: state.term } }) + + // navigate away + location.href = "https://google.com/?q=" + state.term + } + } + + let Form: m.Comp<{term: string}, {}> = { + oninit: function(vnode) { + state.term = vnode.attrs.term || "" // populated from the `history.state` property if the user presses the back button + }, + view: function() { + return m("form", [ + m("input[placeholder='Search']", { oninput: m.withAttr("value", function(v) { state.term = v }), value: state.term }), + m("button", { onclick: state.search }, "Search") + ]) + } + } + + let Layout: m.Comp<{}, {}> = { + view: function(vnode) { + return m(".layout", vnode.children) + } + } + + // example 1 + m.route(document.body, "/", { + "/": { + view: function() { + return m(Layout, m(Home)) + }, + }, + "/form": { + view: function() { + return m(Layout, m(Form)) + }, + } + }) + + // example 2 + m.route(document.body, "/", { + "/": { + render: function() { + return m(Layout, m(Home)) + }, + }, + "/form": { + render: function() { + return m(Layout, m(Form)) + }, + } + }) + + // functionally equivalent to example 1 + let Anon1 = { + view: function() { + return m(Layout, m(Home)) + }, + } + let Anon2 = { + view: function() { + return m(Layout, m(Form)) + }, + } + + m.route(document.body, "/", { + "/": { + render: function() { + return m(Anon1) + } + }, + "/form": { + render: function() { + return m(Anon2) + } + }, + }) +}) + +//////////////////////////////////////////////////////////////////////////////// +// http://mithril.js.org/route.html#preloading-data +//////////////////////////////////////////////////////////////////////////////// + +;(function() { + let state = { + users: [], + loadUsers: function() { + return m.request("/api/v1/users").then(function(users) { + state.users = users + }) + } + } + + m.route(document.body, "/user/list", { + "/user/list": { + onmatch: state.loadUsers, + render: function() { + return state.users.map(function(user) { + return m("div", user.id) + }) + } + }, + }) +}) + +//////////////////////////////////////////////////////////////////////////////// +// http://mithril.js.org/request.html#monitoring-progress +//////////////////////////////////////////////////////////////////////////////// + +;(function() { + let progress = 0 + + m.mount(document.body, { + view: function() { + return [ + m("input[type=file]", { onchange: upload }), + progress + "% completed" + ] + } + }) + + function upload(e: Event) { + let file = ((e.target).files)[0] + + let data = new FormData() + data.append("myfile", file) + + m.request({ + method: "POST", + url: "/api/v1/upload", + data: data, + config: function(xhr) { + xhr.addEventListener("progress", function(e) { + progress = e.loaded / e.total + + m.redraw() // tell Mithril that data changed and a re-render is needed + }) + } + }) + } +}) + +//////////////////////////////////////////////////////////////////////////////// +// http://mithril.js.org/request.html#casting-response-to-a-type +//////////////////////////////////////////////////////////////////////////////// + +;(function() { + + // Start rewrite to TypeScript + class User { + name: string; + constructor(data: any) { + this.name = data.firstName + " " + data.lastName + } + } + // End rewrite to TypeScript + + // function User(data) { + // this.name = data.firstName + " " + data.lastName + // } + + m.request({ + method: "GET", + url: "/api/v1/users", + type: User + }) + .then(function(users) { + console.log(users[0].name) // logs a name + }) +}) + +//////////////////////////////////////////////////////////////////////////////// +// http://mithril.js.org/request.html#non-json-responses +//////////////////////////////////////////////////////////////////////////////// + +;(function() { + m.request({ + method: "GET", + url: "/files/icon.svg", + deserialize: function(value) { return value } + }) + .then(function(svg) { + m.render(document.body, m.trust(svg)) + }) +}) + +//////////////////////////////////////////////////////////////////////////////// +// http://mithril.js.org/jsonp.html +//////////////////////////////////////////////////////////////////////////////// + +;(function() { + m.jsonp({ + url: "/api/v1/users/:id", + data: { id: 1 }, + callbackKey: "callback", + }) + .then(function(result) { + console.log(result) + }) +}) + +//////////////////////////////////////////////////////////////////////////////// +// http://mithril.js.org/fragment.html +//////////////////////////////////////////////////////////////////////////////// + +;(function() { + let groupVisible = true + let log = function() { + console.log("group is now visible") + } + + m("ul", [ + m("li", "child 1"), + m("li", "child 2"), + groupVisible ? m.fragment({ oninit: log }, [ + // a fragment containing two elements + m("li", "child 3"), + m("li", "child 4"), + ]) : null + ]) +}) + +//////////////////////////////////////////////////////////////////////////////// +// http://mithril.js.org/stream.html#computed-properties +//////////////////////////////////////////////////////////////////////////////// + +;(function() { + let firstName = stream("John") + let lastName = stream("Doe") + let fullName = stream.merge([firstName, lastName]).map(function(values) { + return values.join(" ") + }) + + console.log(fullName()) // logs "John Doe" + + firstName("Mary") + + console.log(fullName()) // logs "Mary Doe" +}) + +//////////////////////////////////////////////////////////////////////////////// +// http://mithril.js.org/stream.html#chaining-streams +//////////////////////////////////////////////////////////////////////////////// + +;(function() { + let halted = stream(1).map(function(value) { + return stream.HALT + }) + + halted.map(function() { + // never runs + }) +}) + +//////////////////////////////////////////////////////////////////////////////// +// http://mithril.js.org/stream.html#combining-streams +//////////////////////////////////////////////////////////////////////////////// + +;(function() { + let a = stream(5) + let b = stream(7) + + let added = stream.combine(function(a: stream.Stream, b: stream.Stream) { + return a() + b() + }, [a, b]) + + console.log(added()) // logs 12 +}) + +//////////////////////////////////////////////////////////////////////////////// +// http://mithril.js.org/stream.html#ended-state +//////////////////////////////////////////////////////////////////////////////// + +;(function() { + let value = stream() + let doubled = value.map(function(value) { return value * 2 }) + + value.end(true) // set to ended state + + value(5) + + console.log(doubled()) +}) + +//////////////////////////////////////////////////////////////////////////////// +// https://github.com/lhorie/mithril.js/blob/master/examples/animation/mosaic.html +//////////////////////////////////////////////////////////////////////////////// + +// Excerpt + +;(function() { + + let root = (document.getElementById("root")) + + let empty: any[] = [] + let full: any[] = [] + for (let i = 0; i < 100; i++) full.push(i) + + let cells: any[] + + function view() { + return m(".container", cells.map(function(i) { + return m(".slice", { + style: {backgroundPosition: (i % 10 * 11) + "% " + (Math.floor(i / 10) * 11) + "%"}, + onbeforeremove: exit + }) + })) + } + + function exit(vnode: m.VnodeDOM) { + vnode.dom.classList.add("exit") + return new Promise(function(resolve) { + setTimeout(resolve, 1000) + }) + } + + function run() { + cells = cells === full ? empty : full + + m.render(root, [view()]) + + setTimeout(run, 2000) + } + + run() + +}) + +//////////////////////////////////////////////////////////////////////////////// +// https://github.com/lhorie/mithril.js/blob/master/examples/editor/index.html +//////////////////////////////////////////////////////////////////////////////// + +// Excerpt + +;(function() { + + // Start extra declarations + let marked = (v: string) => v + // End extra declarations + + //model + let state = { + text: "# Markdown Editor\n\nType on the left panel and see the result on the right panel", + update: function(value: string) { + state.text = value + } + } + + //view + let Editor = { + view: function() { + return [ + m("textarea.input", { + oninput: m.withAttr("value", state.update), + value: state.text + }), + m(".preview", m.trust(marked(state.text))), + ] + } + } + + m.mount(document.getElementById("editor"), Editor) + +}) + +//////////////////////////////////////////////////////////////////////////////// +// https://github.com/lhorie/mithril.js/blob/master/examples/todomvc/todomvc.js +//////////////////////////////////////////////////////////////////////////////// + +;(function() { + + //model + let state = { + dispatch: function(action: string, args?: any) { + (state)[action].apply(state, args || []) + requestAnimationFrame(function() { + localStorage["todos-mithril"] = JSON.stringify(state.todos) + }) + }, + + todos: JSON.parse(localStorage["todos-mithril"] || "[]"), + editing: null, + filter: "", + remaining: 0, + todosByStatus: [], + showing: undefined, + + createTodo: function(title: string) { + state.todos.push({title: title.trim(), completed: false}) + }, + setStatuses: function(completed: boolean) { + for (let i = 0; i < state.todos.length; i++) state.todos[i].completed = completed + }, + setStatus: function(todo: any, completed: boolean) { + todo.completed = completed + }, + destroy: function(todo: any) { + let index = state.todos.indexOf(todo) + if (index > -1) state.todos.splice(index, 1) + }, + clear: function() { + for (let i = 0; i < state.todos.length; i++) { + if (state.todos[i].completed) state.destroy(state.todos[i--]) + } + }, + + edit: function(todo: any) { + state.editing = todo + }, + update: function(title: string) { + if (state.editing != null) { + state.editing.title = title.trim() + if (state.editing.title === "") state.destroy(state.editing) + state.editing = null + } + }, + reset: function() { + state.editing = null + }, + + computed: function(vnode: m.Vnode) { + state.showing = vnode.attrs.status || "" + state.remaining = state.todos.filter(function(todo: any) {return !todo.completed}).length + state.todosByStatus = state.todos.filter(function(todo: any) { + switch (state.showing) { + case "": return true + case "active": return !todo.completed + case "completed": return todo.completed + } + }) + } + } + + //view + let Todos: m.Comp<{}, { + add(e: Event): void + toggleAll(): void + toggle(todo: any): void + focus(vnode: m.VnodeDOM, todo: any): void + save(e: KeyboardEvent): void + }> = { + add: function(e: KeyboardEvent) { + if (e.keyCode === 13) { + state.dispatch("createTodo", [(e.target).value]); + (e.target).value = "" + } + }, + toggleAll: function() { + state.dispatch("setStatuses", [(document.getElementById("toggle-all")).checked]) + }, + toggle: function(todo: any) { + state.dispatch("setStatus", [todo, !todo.completed]) + }, + focus: function(vnode: m.VnodeDOM, todo: any) { + if (todo === state.editing && vnode.dom !== document.activeElement) { + (vnode.dom).value = todo.title + (vnode.dom).focus() + (vnode.dom).selectionStart = (vnode.dom).selectionEnd = todo.title.length + } + }, + save: function(e: KeyboardEvent) { + if (e.keyCode === 13 || e.type === "blur") state.dispatch("update", [(e.target).value]) + else if (e.keyCode === 27) state.dispatch("reset") + }, + oninit: state.computed, + onbeforeupdate: state.computed, + view: function(vnode) { + let ui = vnode.state + return [ + m("header.header", [ + m("h1", "todos"), + m("input#new-todo[placeholder='What needs to be done?'][autofocus]", {onkeypress: ui.add}), + ]), + m("section#main", {style: {display: state.todos.length > 0 ? "" : "none"}}, [ + m("input#toggle-all[type='checkbox']", {checked: state.remaining === 0, onclick: ui.toggleAll}), + m("label[for='toggle-all']", {onclick: ui.toggleAll}, "Mark all as complete"), + m("ul#todo-list", [ + state.todosByStatus.map(function(todo: any) { + return m("li", {class: (todo.completed ? "completed" : "") + " " + (todo === state.editing ? "editing" : "")}, [ + m(".view", [ + m("input.toggle[type='checkbox']", {checked: todo.completed, onclick: function() {ui.toggle(todo)}}), + m("label", {ondblclick: function() {state.dispatch("edit", [todo])}}, todo.title), + m("button.destroy", {onclick: function() {state.dispatch("destroy", [todo])}}), + ]), + m("input.edit", {onupdate: function(vnode: m.VnodeDOM) {ui.focus(vnode, todo)}, onkeypress: ui.save, onblur: ui.save}) + ]) + }), + ]), + ]), + state.todos.length ? m("footer#footer", [ + m("span#todo-count", [ + m("strong", state.remaining), + state.remaining === 1 ? " item left" : " items left", + ]), + m("ul#filters", [ + m("li", m("a[href='/']", {oncreate: m.route.link, class: state.showing === "" ? "selected" : ""}, "All")), + m("li", m("a[href='/active']", {oncreate: m.route.link, class: state.showing === "active" ? "selected" : ""}, "Active")), + m("li", m("a[href='/completed']", {oncreate: m.route.link, class: state.showing === "completed" ? "selected" : ""}, "Completed")), + ]), + m("button#clear-completed", {onclick: function() {state.dispatch("clear")}}, "Clear completed"), + ]) : null, + ] + } + } + + m.route(document.getElementById("todoapp")!, "/", { + "/": Todos, + "/:status": Todos, + }) + +}) diff --git a/types/mithril/test/test-class-component.ts b/types/mithril/test/test-class-component.ts new file mode 100644 index 0000000000..3b99bb63ef --- /dev/null +++ b/types/mithril/test/test-class-component.ts @@ -0,0 +1,135 @@ +import * as m from 'mithril' +import {ClassComponent, CVnode, CVnodeDOM} from 'mithril' + +/////////////////////////////////////////////////////////// +// 0. +// Simplest component example - no attrs or state. +// +class Comp0 implements ClassComponent<{}> { + constructor (vnode: CVnode<{}>) { + } + view() { + return m('span', "Test") + } +} + +// Mount the component +m.mount(document.getElementById('comp0')!, Comp0) + +// Unmount the component +m.mount(document.getElementById('comp0')!, null) + +/////////////////////////////////////////////////////////// +// 1. +// Simple example with lifecycle methods. +// +class Comp1 implements ClassComponent<{}> { + oninit (vnode: CVnode<{}>) { + } + oncreate ({dom}: CVnodeDOM<{}>) { + } + view (vnode: CVnode<{}>) { + return m('span', "Test") + } +} + +/////////////////////////////////////////////////////////// +// 2. +// Component with attrs type +// +interface Comp2Attrs { + title: string + description: string +} + +class Comp2 implements ClassComponent { + view ({attrs: {title, description}}: CVnode) { + return [m('h2', title), m('p', description)] + } +} + +/////////////////////////////////////////////////////////// +// 3. +// Declares attrs type inline. +// Uses comp2 with typed attrs and makes use of `onremove` +// lifecycle method. +// +class Comp3 implements ClassComponent<{pageHead: string}> { + oncreate ({dom}: CVnodeDOM<{pageHead: string}>) { + // Can do stuff with dom + } + view ({attrs}: CVnode<{pageHead: string}>) { + return m('.page', + m('h1', attrs.pageHead), + m(Comp2, + { + // attrs is type checked - nice! + title: "A Title", + description: "Some descriptive text.", + onremove: (vnode) => { + // Vnode type is inferred + console.log("comp2 was removed") + }, + } + ), + // Test other hyperscript parameter variations + m(Comp1, m(Comp1)), + m('br') + ) + } +} + +/////////////////////////////////////////////////////////// +// 4. +// Typed attrs, component with state, methods +// +interface Comp4Attrs { + name: string +} + +class Comp4 implements ClassComponent { + count: number + constructor (vnode: CVnode) { + this.count = 0 + } + add (num: number) { + this.count += num + } + view ({attrs}: CVnode) { + return [ + m('h1', `This ${attrs.name} has been clicked ${this.count} times`), + m('button', + { + onclick: () => this.add(1) + }, + "Click me") + ] + } +} + +/////////////////////////////////////////////////////////// +// +// Test that all are mountable components +// +m.route(document.body, '/', { + '/comp0': Comp0, + '/comp1': Comp1, + '/comp2': Comp2, + '/comp3': Comp3, + '/comp4': Comp4 +}) + +/////////////////////////////////////////////////////////// +// +// Concise module example with default export +// +export interface Attrs { + name: string +} + +export default class MyComponent implements ClassComponent { + count = 0 + view ({attrs}: CVnode) { + return m('span', `name: ${attrs.name}, count: ${this.count}`) + } +} diff --git a/types/mithril/test/test-component.ts b/types/mithril/test/test-component.ts new file mode 100644 index 0000000000..060997b555 --- /dev/null +++ b/types/mithril/test/test-component.ts @@ -0,0 +1,160 @@ +import * as m from 'mithril' +import {Component, Comp} from 'mithril' + +/////////////////////////////////////////////////////////// +// 0. +// Simplest component example - no attrs or state. +// +const comp0 = { + view() { + return m('span', "Test") + } +} + +// Mount the component +m.mount(document.getElementById('comp0')!, comp0) + +// Unmount the component +m.mount(document.getElementById('comp0')!, null) + +/////////////////////////////////////////////////////////// +// 1. +// Simple example. Vnode type for component methods is inferred. +// +const comp1: Component<{},{}> = { + oncreate ({dom}) { + // vnode.dom type inferred + }, + view (vnode) { + return m('span', "Test") + } +} + +/////////////////////////////////////////////////////////// +// 2. +// Component with attrs +// +interface Comp2Attrs { + title: string + description: string +} + +const comp2: Component = { + view ({attrs: {title, description}}) { // Comp2Attrs type is inferred + return [m('h2', title), m('p', description)] + } +} + +/////////////////////////////////////////////////////////// +// 3. +// Declares attrs type inline. +// Uses comp2 with typed attrs and makes use of `onremove` +// lifecycle method. +// +const comp3: Component<{pageHead: string},{}> = { + oncreate ({dom}) { + // Can do stuff with dom + }, + view ({attrs}) { + return m('.page', + m('h1', attrs.pageHead), + m(comp2, + { + // attrs is type checked - nice! + title: "A Title", + description: "Some descriptive text.", + onremove: (vnode) => { + console.log("comp2 was removed") + }, + } + ), + // Test other hyperscript parameter variations + m(comp1, m(comp1)), + m('br') + ) + } +} + +/////////////////////////////////////////////////////////// +// 4. +// Typed attrs and state, and `this` type is inferred. +// +interface Comp4Attrs { + name: string +} + +interface Comp4State { + count: number + add: (this: Comp4State, num: number) => void +} + +// Either of these two Comp4 defs will work: +type Comp4 = Component & Comp4State +//interface Comp4 extends Component, Comp4State {} + +const comp4: Comp4 = { + count: 0, // <- Must be declared to satisfy Comp4 type which includes Comp4State type + add (num) { + // num and this types inferred + this.count += num + }, + oninit() { + this.count = 0 + }, + view ({attrs}) { + return [ + m('h1', `This ${attrs.name} has been clicked ${this.count} times`), + m('button', + { + // 'this' is typed! + onclick: () => this.add(1) + }, + "Click me") + ] + } +} + +/////////////////////////////////////////////////////////// +// 5. +// Stateful component (Equivalent to Comp4 example.) +// Avoids the use of `this` completely; state manipulated +// through vnode.state. +// +const comp5: Component = { + oninit ({state}) { + state.count = 0 + state.add = num => {state.count += num} + }, + view ({attrs, state}) { + return [ + m('h1', `This ${attrs.name} has been clicked ${state.count} times`), + m('button', + { + onclick: () => {state.add(1)} + }, + "Click me" + ) + ] + } +} + + +/////////////////////////////////////////////////////////// +// +// Concise module example with default export +// +interface Attrs { + name: string +} + +interface State { + count: number +} + +export default { + count: 0, + view ({attrs}) { + return m('span', `name: ${attrs.name}, count: ${this.count}`) + } +} as Comp +// Using the Comp type will apply the State intersection type for us. diff --git a/types/mithril/test/test-factory-component.ts b/types/mithril/test/test-factory-component.ts new file mode 100644 index 0000000000..1f8e10bb73 --- /dev/null +++ b/types/mithril/test/test-factory-component.ts @@ -0,0 +1,179 @@ +import * as m from 'mithril' +import {Component, FactoryComponent, Vnode} from 'mithril' + +/////////////////////////////////////////////////////////// +// 0. +// Simplest component example - no attrs or state. +// +function comp0() { + return { + view() { + return m('span', "Test") + } + } +} + +// Mount the component +m.mount(document.getElementById('comp0')!, comp0) + +// Unmount the component +m.mount(document.getElementById('comp0')!, null) + +/////////////////////////////////////////////////////////// +// 1. +// Simple example. Vnode type for component methods is inferred. +// +function comp1() { + return { + oncreate ({dom}) { + // vnode.dom type inferred + }, + view (vnode) { + return m('span', "Test") + } + } as Component<{},{}> +} + +/////////////////////////////////////////////////////////// +// 2. +// Component with attrs type. Different type annotation +// style to infer factory vnode type. +// +interface Comp2Attrs { + title: string + description: string +} + +const comp2 = function (vnode) { // vnode is inferred + return { + view ({attrs: {title, description}}) { // Comp2Attrs type is inferred + return [m('h2', title), m('p', description)] + } + } +} as FactoryComponent + +/////////////////////////////////////////////////////////// +// 3. +// Declares attrs type inline. +// Uses comp2 with typed attrs and makes use of `onremove` +// lifecycle method. +// +const comp3 = function() { + return { + oncreate ({dom}) { + // Can do stuff with dom + }, + view ({attrs}) { + return m('.page', + m('h1', attrs.pageHead), + m(comp2, + { + // attrs is type checked - nice! + title: "A Title", + description: "Some descriptive text.", + onremove: (vnode) => { + console.log("comp2 was removed") + }, + } + ), + // Test other hyperscript parameter variations + m(comp1, m(comp1)), + m('br') + ) + } + } +} as FactoryComponent<{pageHead: string}> + +/////////////////////////////////////////////////////////// +// 4. +// Stateful component using closure method & var +// to hold state. +// +interface Comp4Attrs { + name: string +} + +function comp4(): Component { + let count = 0 + + function add (num: number) { + count += num + } + + return { + oninit() { + count = 0 + }, + view ({attrs}) { + return [ + m('h1', `This ${attrs.name} has been clicked ${count} times`), + m('button', + { + onclick: () => add(1) + }, + "Click me" + ) + ] + } + } +} + +/////////////////////////////////////////////////////////// +// 5. +// Stateful component (Equivalent to Comp4 example.) +// Uses vnode.state instead of closure. +// +interface Comp5State { + count: number + add (num: number): void +} + +function comp5(): Component { + return { + oninit ({state}) { + state.count = 0 + state.add = num => {state.count += num} + }, + view ({attrs, state}) { + return [ + m('h1', `This ${attrs.name} has been clicked ${state.count} times`), + m('button', + { + onclick: () => {state.add(1)} + }, + "Click me" + ) + ] + } + } +} + +/////////////////////////////////////////////////////////// +// +// Test that all are mountable components +// +m.route(document.body, '/', { + '/comp0': comp0, + '/comp1': comp1, + '/comp2': comp2, + '/comp3': comp3, + '/comp4': comp4, + '/comp5': comp5 +}) + +/////////////////////////////////////////////////////////// +// +// Concise module example with default export +// +interface Attrs { + name: string +} + +export default (): Component => { + let count = 0 + return { + view ({attrs}) { + return m('span', `name: ${attrs.name}, count: ${count}`) + } + } +} diff --git a/types/mithril/test/test-fragment.ts b/types/mithril/test/test-fragment.ts new file mode 100644 index 0000000000..364680bbb2 --- /dev/null +++ b/types/mithril/test/test-fragment.ts @@ -0,0 +1,17 @@ +import * as m from 'mithril' +import {Vnode} from 'mithril/' +import * as h from 'mithril/hyperscript' + +const vnode = m.fragment({id: 'abc'}, ['test']) + +m.fragment({}, ['Test', 123]) + +m.fragment( + { + id: 'abc', + oninit: (vnode: Vnode) => { + console.log('oninit') + } + }, + [h('p', 'test1'), [123, h('p', 'abc'), ['abc']], 'Abc', h('p', 'test2')] +) diff --git a/types/mithril/test/test-jsonp.ts b/types/mithril/test/test-jsonp.ts new file mode 100644 index 0000000000..32f40ca4b6 --- /dev/null +++ b/types/mithril/test/test-jsonp.ts @@ -0,0 +1,27 @@ +import * as m from 'mithril' + +interface Result { + id: number +} + +m.jsonp('/item').then(data => { + console.log(data.id) +}) + +class User { + id: number + constructor (result: Result) { + this.id = result.id + } +} + +m.jsonp({ + url: '/user', + data: {test: 'abc'}, + type: User, + callbackName: 'getuser', + callbackKey: 'key', + background: true +}).then(user => { + console.log(user.id) +}) diff --git a/types/mithril/test/test-misc.ts b/types/mithril/test/test-misc.ts new file mode 100644 index 0000000000..75f1367de8 --- /dev/null +++ b/types/mithril/test/test-misc.ts @@ -0,0 +1,16 @@ +import * as m from 'mithril' + +const vnode = m.trust('Some bold text.') + +const params = m.parseQueryString('?id=123') + +const qstr = m.buildQueryString({id: 123}) + +m.render(document.body, 'Hello') +m.render(document.body, m('h1', 'Test')) +m.render(document.body, [ + m('h1', 'Test'), "abc", null, 123, false, m('p', 'Vnode array'), + ['a', 123, undefined, m('div', 'Nested')] +]) + +m.redraw() diff --git a/types/mithril/test/test-request.ts b/types/mithril/test/test-request.ts new file mode 100644 index 0000000000..8ea24fe091 --- /dev/null +++ b/types/mithril/test/test-request.ts @@ -0,0 +1,73 @@ +import * as request from 'mithril/request' + +interface Result { + id: number +} + +request({method: "GET", url: "/item"}).then(result => { + console.log(result.id) +}) + +request<{a: string}>("/item", {method: "POST"}).then(result => { + console.log(result.a) +}) + +request({ + method: "GET", + url: "/item", + data: {x: "y"} +}).then(result => { + console.log(result) +}) + +request({ + method: "GET", + url: "/item", + data: 5, + serialize: (data: number) => "id=" + data.toString() +}).then(result => { + console.log(result) +}) + +request('/item', { + method: "GET", + deserialize: str => JSON.parse(str) as Result +}).then(result => { + console.log(result.id) +}) + +request('/id', { + method: "GET", + extract: xhr => ({id: Number(xhr.responseText)}) +}).then(result => { + console.log(result.id) +}) + +request('/item', { + config: xhr => { + xhr.setRequestHeader('accept', '*') + }, + headers: {"Content-Type": "application/json"}, + background: true, +}).then(result => { + console.log(result.id) +}) + +class Item { + identifier: number + constructor(result: Result) { + this.identifier = result.id + } +} + +request('/item', { + method: 'GET', + async: true, + user: "Me", + password: "qwerty", + withCredentials: true, + type: Item, + useBody: false +}).then(item => { + console.log(item.identifier) +}) diff --git a/types/mithril/test/test-route.ts b/types/mithril/test/test-route.ts new file mode 100644 index 0000000000..900bb2f1f0 --- /dev/null +++ b/types/mithril/test/test-route.ts @@ -0,0 +1,60 @@ +import {Component} from 'mithril' +import * as h from 'mithril/hyperscript' +import * as route from 'mithril/route' + +const component1 = { + view() { + return h('h1', 'Test') + } +} + +const component2 = { + view ({attrs: {title}}) { + return h('h1', title) + } +} as Component<{title: string},{}> + +route(document.body, '/', { + '/': component1, + '/test1': { + onmatch (args, path) { + return component1 + } + }, + '/test2': { + render(vnode) { + return h(component1) + } + }, + 'test3': { + onmatch (args, path) { + return component2 + }, + render (vnode) { + return ['abc', 123, null, h(component2), ['nested', h('p', 123)]] + } + }, + 'test4': { + onmatch (args, path) { + // Must provide a Promise type if we want type checking + return new Promise>((resolve, reject) => { + resolve(component2) + }) + } + } +}) + +route.prefix('/app') +route.set('/test1') + +route.set('/test/:id', {id: 1}) + +route.set('/test2', undefined, { + replace: true, + state: {abc: 123}, + title: "Title" +}) + +const path: string = route.get() + +const fn = route.link(h('div', 'test')) diff --git a/types/mithril/test/test-stream.ts b/types/mithril/test/test-stream.ts new file mode 100644 index 0000000000..7e55d0273d --- /dev/null +++ b/types/mithril/test/test-stream.ts @@ -0,0 +1,391 @@ +import * as stream from 'mithril/stream' +import {Stream} from 'mithril/stream' + +{ + const s = stream(1) + const initialValue = s() + s(2) + const newValue = s() + console.assert(initialValue === 1) + console.assert(newValue === 2) +} + +{ + const s = stream() + console.assert(s() === undefined) +} + +{ + const s: Stream = stream(1) + s(undefined) + console.assert(s() === undefined) +} + +{ + const s = stream(stream(1)) + console.assert(s()() === 1) +} + +{ + const s = stream() + const doubled = stream.combine(function(s) {return s() * 2}, [s]) + s(2) + console.assert(doubled() === 4) +} + +{ + const s = stream(2) + const doubled = stream.combine(function(s) {return s() * 2}, [s]) + console.assert(doubled() === 4) +} + +{ + const s1 = stream() + const s2 = stream() + const added = stream.combine(function(s1, s2) {return s1() + s2()}, [s1, s2]) + s1(2) + s2(3) + console.assert(added() === 5) +} + +{ + const s1 = stream(2) + const s2 = stream(3) + const added = stream.combine(function(s1, s2) {return s1() + s2()}, [s1, s2]) + console.assert(added() === 5) +} + +{ + const s1 = stream(2) + const s2 = stream() + const added = stream.combine(function(s1, s2) {return s1() + s2()}, [s1, s2]) + s2(3) + console.assert(added() === 5) +} + +{ + let count = 0 + const a = stream() + const b = stream.combine(function(a) {return a() * 2}, [a]) + const c = stream.combine(function(a) {return a() * a()}, [a]) + const d = stream.combine(function(b, c) { + count++ + return b() + c() + }, [b, c]) + a(3) + console.assert(d() === 15) + console.assert(count === 1) +} + +{ + let count = 0 + const a = stream(3) + const b = stream.combine(function(a) {return a() * 2}, [a]) + const c = stream.combine(function(a) {return a() * a()}, [a]) + const d = stream.combine(function(b, c) { + count++ + return b() + c() + }, [b, c]) + console.assert(d() === 15) + console.assert(count === 1) +} + +{ + let streams: Stream[] = [] + const a = stream() + const b = stream() + const c = stream.combine(function(a, b, changed) { + streams = changed + }, [a, b]) + a(3) + b(5) + console.assert(streams.length === 1) + console.assert(streams[0] === b) +} + +{ + let streams: Stream[] = [] + const a = stream(3) + const b = stream(5) + const c = stream.combine(function(a, b, changed) { + streams = changed + }, [a, b]) + a(7) + console.assert(streams.length === 1) + console.assert(streams[0] === a) +} + +{ + const a = stream(1) + const b = stream.combine(function(a) { + return undefined + }, [a]) + + console.assert(b() === undefined) +} + +{ + const a = stream(1) + const b = stream.combine(function(a) { + return stream(2) + }, [a]) + console.assert(b()() === 2) +} + +{ + const a = stream(1) + const b = stream.combine(function(a) { + return stream() + }, [a]) + console.assert(b()() === undefined) +} + +{ + let count = 0 + const a = stream(1) + const b = stream.combine(function(a) { + return stream.HALT + }, [a]) + ["fantasy-land/map"](function() { + count++ + return 1 + }) + console.assert(b() === undefined) +} + +{ + const all = stream.merge([ + stream(10), + stream("20"), + stream({value: 30}), + ]) +} + +{ + const straggler = stream() + const all = stream.merge([ + stream(10), + stream("20"), + straggler, + ]) + console.assert(all() === undefined) + straggler(30) +} + +{ + let value = 0 + const id = function(value: number) {return value} + const a = stream() + const b = stream() + + const all = stream.merge([a.map(id), b.map(id)]).map(function(data) { + value = data[0] + data[1] + }) + + a(1) + b(2) + console.assert(value === 3) + + a(3) + b(4) + console.assert(value === 7) +} + +{ + const s = stream() + const doubled = stream.combine(function(stream) {return stream() * 2}, [s]) + s.end(true) + s(3) + console.assert(doubled() === undefined) +} + +{ + const s = stream(2) + const doubled = stream.combine(function(stream) {return stream() * 2}, [s]) + s.end(true) + s(3) + console.assert(doubled() === 4) +} + +{ + const s = stream(2) + s.end(true) + const doubled = stream.combine(function(stream) {return stream() * 2}, [s]) + s(3) + console.assert(doubled() === undefined) +} + +{ + const s = stream(2) + const doubled = stream.combine(function(stream) {return stream() * 2}, [s]) + doubled.end(true) + s(4) + console.assert(doubled() === 4) +} + +{ + const s = stream() + const doubled = s["fantasy-land/map"](function(value: number) {return value * 2}) + s(3) + console.assert(doubled() === 6) +} + +{ + const s = stream(3) + const doubled = s["fantasy-land/map"](function(value: number) {return value * 2}) + console.assert(doubled() === 6) +} + +{ + const s = stream() + const mapped = s["fantasy-land/map"](function(value: undefined) {return String(value)}) + s(undefined) + console.assert(mapped() === "undefined") +} + +{ + const s = stream(undefined) + const mapped = s["fantasy-land/map"](function(value: undefined) {return String(value)}) + console.assert(mapped() === "undefined") +} + +{ + const s = stream(undefined) + const mapped = s["fantasy-land/map"](function(value: undefined) {return stream()}) + console.assert(mapped()() === undefined) +} + +{ + const s = stream(undefined) + console.assert(s["fantasy-land/map"] === s.map) +} + +{ + const apply = stream(function(value: number) {return value * 2}) + const s = stream(3) + const applied = s["fantasy-land/ap"](apply) + console.assert(applied() === 6) + apply(function(value) {return value / 3}) + console.assert(applied() === 1) + s(9) + console.assert(applied() === 3) +} + +{ + const apply = stream(function(value: undefined) {return String(value)}) + const s = stream(undefined) + const applied = s["fantasy-land/ap"](apply) + console.assert(applied() === "undefined") + apply(function(value) {return String(value) + "a"}) + console.assert(applied() === "undefineda") +} + +{ + const s = stream(3) + const mapped = s["fantasy-land/map"](function(value: number) {return value}) + console.assert(s() === mapped()) +} + +{ + const f = function f(x: number) {return x * 2} + const g = function g(x: number) {return x * x} + const s = stream(3) + const mapped = s["fantasy-land/map"](function(value: any) {return f(g(value))}) + const composed = s["fantasy-land/map"](g)["fantasy-land/map"](f) + console.assert(mapped() === 18) + console.assert(mapped() === composed()) +} + +{ + const a = stream(function(value: number) {return value * 2}) + const u = stream(function(value: number) {return value * 3}) + const v = stream(5) + const mapped = v["fantasy-land/ap"](u["fantasy-land/ap"](a["fantasy-land/map"](function(f: any) { + return function(g: any) { + return function(x: any) { + return f(g(x)) + } + } + }))) + const composed = v["fantasy-land/ap"](u)["fantasy-land/ap"](a) + console.assert(mapped() === 30) + console.assert(mapped() === composed()) +} + +{ + const a = stream()["fantasy-land/of"](function(value: number) {return value}) + const v = stream(5) + console.assert(v["fantasy-land/ap"](a)() === 5) + console.assert(v["fantasy-land/ap"](a)() === v()) +} + +{ + const a = stream(0) + const f = function(value: number) {return value * 2} + const x = 3 + console.assert(a["fantasy-land/of"](x)["fantasy-land/ap"](a["fantasy-land/of"](f))() === 6) + console.assert(a["fantasy-land/of"](x)["fantasy-land/ap"](a["fantasy-land/of"](f))() === a["fantasy-land/of"](f(x))()) +} + +{ + const u = stream(function(value: number) {return value * 2}) + const a = stream() + const y = 3 + console.assert(a["fantasy-land/of"](y)["fantasy-land/ap"](u)() === 6) + console.assert(a["fantasy-land/of"](y)["fantasy-land/ap"](u)() === u["fantasy-land/ap"](a["fantasy-land/of"](function(f: any) {return f(y)}))()) +} + +// scan + +{ + const parent = stream() + const child = stream.scan((out, p) => out - p, 123, parent) +} + +{ + const parent = stream() + const child = stream.scan((arr, p) => arr.concat(p), [] as number[], parent) + parent(7) +} + +// scanMerge + +{ + const parent1 = stream() + const parent2 = stream() + + const child = stream.scanMerge([ + [parent1, (out, p1) => out + p1], + [parent2, (out, p2) => out + p2] + ], -10) +} + +{ + const parent1 = stream() + const parent2 = stream() + + const child = stream.scanMerge([ + [parent1, (out, p1) => out + p1], + [parent2, (out, p2) => out + p2 + p2] + ], "a") + + parent1("b") + parent2("c") + parent1("b") + + console.assert(child() === 'abccb') +} + +{ + const parent1 = stream() + const parent2 = stream() + const child = stream.scanMerge([ + [parent1, (out, p1) => out + p1], + [parent2, (out, p2) => out + p2 + p2] + ], "a") + + parent1("a") + parent2(1) + + console.assert(child() === 'aa11') +} diff --git a/types/mithril/tsconfig.json b/types/mithril/tsconfig.json index a80a6ce9f2..8189032c62 100644 --- a/types/mithril/tsconfig.json +++ b/types/mithril/tsconfig.json @@ -1,23 +1,39 @@ { - "compilerOptions": { - "module": "commonjs", - "lib": [ - "es6", - "dom" - ], - "noImplicitAny": true, - "noImplicitThis": false, - "strictNullChecks": false, - "baseUrl": "../", - "typeRoots": [ - "../" - ], - "types": [], - "noEmit": true, - "forceConsistentCasingInFileNames": true - }, - "files": [ - "index.d.ts", - "mithril-tests.ts" - ] -} \ No newline at end of file + "compilerOptions": { + "module": "commonjs", + "lib": ["es2015", "dom"], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "suppressImplicitAnyIndexErrors": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "baseUrl": "../", + "typeRoots": ["../"], + "types": [] + }, + "files": [ + "test/test-api.ts", + "test/test-class-component.ts", + "test/test-component.ts", + "test/test-factory-component.ts", + "test/test-fragment.ts", + "test/test-jsonp.ts", + "test/test-misc.ts", + "test/test-request.ts", + "test/test-route.ts", + "test/test-stream.ts", + "index.d.ts", + "hyperscript.d.ts", + "mount.d.ts", + "redraw.d.ts", + "render.d.ts", + "request.d.ts", + "route.d.ts", + "withAttr.d.ts", + "stream/index.d.ts" + ], + "atom": { + "rewriteTsconfig": false + } +} diff --git a/types/mithril/tslint.json b/types/mithril/tslint.json new file mode 100644 index 0000000000..2c473fb8ea --- /dev/null +++ b/types/mithril/tslint.json @@ -0,0 +1,54 @@ +{ + "rules": { + "class-name": true, + "comment-format": [ + false, + "check-space" + ], + "indent": [ + true, + "tabs" + ], + "no-duplicate-variable": true, + "no-eval": true, + "no-internal-module": false, + "no-trailing-whitespace": true, + "no-var-keyword": true, + "one-line": [ + true, + "check-open-brace", + "check-whitespace" + ], + "quotemark": [ + false, + "double" + ], + "semicolon": [false, "always"], + "triple-equals": [ + true, + "allow-null-check" + ], + "typedef-whitespace": [ + false, + { + "call-signature": "nospace", + "index-signature": "nospace", + "parameter": "nospace", + "property-declaration": "nospace", + "variable-declaration": "nospace" + } + ], + "variable-name": [ + true, + "ban-keywords" + ], + "whitespace": [ + false, + "check-branch", + "check-decl", + "check-operator", + "check-separator", + "check-type" + ] + } +} \ No newline at end of file diff --git a/types/mithril/withAttr.d.ts b/types/mithril/withAttr.d.ts new file mode 100644 index 0000000000..14623971a6 --- /dev/null +++ b/types/mithril/withAttr.d.ts @@ -0,0 +1,3 @@ +import { WithAttr } from "mithril"; +declare const withAttr: WithAttr; +export = withAttr; From b3959a812efc71520c624d69f236683b337d2aa1 Mon Sep 17 00:00:00 2001 From: Natan Camargos Date: Fri, 24 Mar 2017 14:41:10 -0300 Subject: [PATCH 037/844] angularjs - Fix ITimeoutService interface ($timeout signature) $timeout is not correctly described by ITimeoutService, causing compile time errors like: 'TS2322:Type 'IPromise' is not assignable to type 'IPromise'...' --- types/angular/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/angular/index.d.ts b/types/angular/index.d.ts index 485ad9ebb3..4c0edf95cc 100644 --- a/types/angular/index.d.ts +++ b/types/angular/index.d.ts @@ -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; } From e6ad73d5e3d178f3b19100718c78b4e56a946090 Mon Sep 17 00:00:00 2001 From: Wayne Dela Cruz Date: Wed, 29 Mar 2017 10:06:29 +0800 Subject: [PATCH 038/844] Fix travis build errors in material-ui tests * Create type Stylesheet who's props are all of type CSSProperties * Declared function createStylesheet which takes in an object and converts it's key-values to CSSProperties --- types/material-ui/material-ui-tests.tsx | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/types/material-ui/material-ui-tests.tsx b/types/material-ui/material-ui-tests.tsx index bb2bba94c8..2388630d8f 100644 --- a/types/material-ui/material-ui-tests.tsx +++ b/types/material-ui/material-ui-tests.tsx @@ -109,7 +109,13 @@ function handleTouchTap() { alert('onTouchTap triggered on the title component'); } -const styles = { +type Stylesheet = { + [P in keyof T]: React.CSSProperties +}; + +declare function createStylesheet(args: T): Stylesheet; + +const styles = createStylesheet({ title: { cursor: 'pointer', }, @@ -232,7 +238,7 @@ const styles = { floatingLabelFocusStyle: { color: blue500, }, -}; +}); const style = { marginRight: 20, From e1cb7511a137637ef84e98e5e94bd484f5e1043e Mon Sep 17 00:00:00 2001 From: Erik Krogh Kristensen Date: Wed, 29 Mar 2017 09:25:48 +0200 Subject: [PATCH 039/844] Leaflet: whitespace in extension methods --- types/leaflet/index.d.ts | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/types/leaflet/index.d.ts b/types/leaflet/index.d.ts index ae18f8aa6f..e6855ef870 100644 --- a/types/leaflet/index.d.ts +++ b/types/leaflet/index.d.ts @@ -424,11 +424,11 @@ declare namespace L { getTooltip(): Tooltip | undefined; // Extension methods - onAdd?(map: Map) : this; - onRemove?(map: Map) : this; - getEvents?() : {[name: string]: (event: Event) => void}; - getAttribution?() : string | null; - beforeAdd?(map: Map) : this; + onAdd?(map: Map): this; + onRemove?(map: Map): this; + getEvents?(): {[name: string]: (event: Event) => void}; + getAttribution?(): string | null; + beforeAdd?(map: Map): this; } interface GridLayerOptions { @@ -992,8 +992,8 @@ declare namespace L { remove(): this; // Extension methods - onAdd?(map: Map) : HTMLElement; - onRemove?(map: Map) : void; + onAdd?(map: Map): HTMLElement; + onRemove?(map: Map): void; options: ControlOptions; } @@ -1175,8 +1175,8 @@ declare namespace L { enabled(): boolean; // Extension methods - addHooks?() : void; - removeHooks?() : void; + addHooks?(): void; + removeHooks?(): void; } interface Event { From 6200c9a89605f61e32bafbb8fbfe0f14515c4966 Mon Sep 17 00:00:00 2001 From: Steve Hipwell Date: Wed, 29 Mar 2017 11:35:56 +0100 Subject: [PATCH 040/844] Updated oauth2orize typings --- types/oauth2orize/index.d.ts | 182 +++++++++++++++++++------ types/oauth2orize/oauth2orize-tests.ts | 32 ++--- 2 files changed, 156 insertions(+), 58 deletions(-) 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); }); From 172eb8218d2838c4896d46553ce4d8ac905ac562 Mon Sep 17 00:00:00 2001 From: Maxim Kulikov Date: Wed, 29 Mar 2017 15:52:59 +0300 Subject: [PATCH 041/844] Define debounce option in ng-model-options --- types/angular/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/angular/index.d.ts b/types/angular/index.d.ts index 485ad9ebb3..023f83dd1c 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; From 56934db45996e0b665c7919d6c8d59bb44215a50 Mon Sep 17 00:00:00 2001 From: Huy Nguyen Date: Wed, 29 Mar 2017 10:17:39 -0400 Subject: [PATCH 042/844] Incorporate reviewer's suggest changes --- types/react-router-redux/index.d.ts | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/types/react-router-redux/index.d.ts b/types/react-router-redux/index.d.ts index 5638b135b9..73be776ec5 100644 --- a/types/react-router-redux/index.d.ts +++ b/types/react-router-redux/index.d.ts @@ -15,7 +15,7 @@ import { Location, Path, LocationState, - LocationDescriptorObject + LocationDescriptor } from 'history'; import * as React from 'react'; @@ -25,7 +25,7 @@ export interface ConnectedRouterProps { } export class ConnectedRouter extends React.Component, {}> {} -export const LOCATION_CHANGE = '@@router/LOCATION_CHANGE' +export const LOCATION_CHANGE: string; export interface RouterState { location: Location | null @@ -33,12 +33,10 @@ export interface RouterState { export function routerReducer(state?: RouterState, action?: RouterAction): RouterState -export const CALL_HISTORY_METHOD = '@@router/LOCATION_CHANGE'; +export const CALL_HISTORY_METHOD: string; -export function push(path: Path, state?: LocationState): RouterAction -export function push(location: LocationDescriptorObject): RouterAction -export function replace(path: Path, state?: LocationState): RouterAction -export function replace(location: LocationDescriptorObject): RouterAction +export function push(location: LocationDescriptor, state?: LocationState): RouterAction +export function replace(location: LocationDescriptor, state?: LocationState): RouterAction export function go(n: number): RouterAction export function goBack(): RouterAction export function goForward(): RouterAction From 96666eee57ff5ebd734a3d7c72cf45ad74327f9c Mon Sep 17 00:00:00 2001 From: KeitaNishimoto Date: Thu, 30 Mar 2017 00:09:43 +0900 Subject: [PATCH 043/844] fix type Statement.Action(I responded to the review) --- types/aws-lambda/aws-lambda-tests.ts | 2 +- types/aws-lambda/index.d.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/types/aws-lambda/aws-lambda-tests.ts b/types/aws-lambda/aws-lambda-tests.ts index 3c22a88cbc..e793442177 100644 --- a/types/aws-lambda/aws-lambda-tests.ts +++ b/types/aws-lambda/aws-lambda-tests.ts @@ -143,7 +143,7 @@ statement = { }; statement = { - Action: str, + Action: [str, str], Effect: str, Resource: [str, str] }; diff --git a/types/aws-lambda/index.d.ts b/types/aws-lambda/index.d.ts index 4e94e5782c..a5fa271699 100644 --- a/types/aws-lambda/index.d.ts +++ b/types/aws-lambda/index.d.ts @@ -211,7 +211,7 @@ interface PolicyDocument { * http://docs.aws.amazon.com/apigateway/latest/developerguide/use-custom-authorizer.html#api-gateway-custom-authorizer-output */ interface Statement { - Action: string; + Action: string | [string]; Effect: string; Resource: string | [string]; } From 42a5ec04feb509c08b3e5087292cc92a4125392a Mon Sep 17 00:00:00 2001 From: Chandra Galbiati Date: Thu, 23 Mar 2017 17:42:50 -0400 Subject: [PATCH 044/844] Update arguments for before and afterChange These functions both have arguments in the source code --- types/react-slick/index.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/types/react-slick/index.d.ts b/types/react-slick/index.d.ts index 513fc0d440..1278605b27 100644 --- a/types/react-slick/index.d.ts +++ b/types/react-slick/index.d.ts @@ -40,8 +40,8 @@ interface __config { variableWidth?: boolean useCSS?: boolean vertical?: boolean - afterChange?: (() => void) - beforeChange?: (() => void) + afterChange?: ((currentSlide: number) => void) + beforeChange?: ((currentSlide: number, nextSlide: number) => void) slickGoTo?: number // int } From 132919890f10e8eaa64cdc499bea3613717f4fe9 Mon Sep 17 00:00:00 2001 From: Stephen Lautier Date: Wed, 29 Mar 2017 18:47:50 +0200 Subject: [PATCH 045/844] added definitions for multimatch --- types/multimatch/index.d.ts | 73 ++++++++++++++++++++++++++++ types/multimatch/multimatch-tests.ts | 8 +++ types/multimatch/tsconfig.json | 22 +++++++++ types/multimatch/tslint.json | 1 + 4 files changed, 104 insertions(+) create mode 100644 types/multimatch/index.d.ts create mode 100644 types/multimatch/multimatch-tests.ts create mode 100644 types/multimatch/tsconfig.json create mode 100644 types/multimatch/tslint.json diff --git a/types/multimatch/index.d.ts b/types/multimatch/index.d.ts new file mode 100644 index 0000000000..5a1c1daab9 --- /dev/null +++ b/types/multimatch/index.d.ts @@ -0,0 +1,73 @@ +// Type definitions for multimatch 2.1 +// Project: https://github.com/sindresorhus/multimatch +// Definitions by: Stephen Lautier +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +/** + * Match utility function which supports multiple pattern globbing. + * + * @param {string[]} paths list to match against. + * @param {string[]} patterns globbing patterns to use. e.g. `[*, "!cake"]`. + * @param {multimatch.MultimatchOptions} [options] + * @returns {string[]} + */ +declare function multimatch(paths: string[], patterns: string[], options?: multimatch.MultimatchOptions): string[]; + +declare namespace multimatch { + + /** + * Options based on [minimatch](https://github.com/isaacs/minimatch#minimatchmatchlist-pattern-options) + */ + interface MultimatchOptions { + /** Dump a ton of stuff to stderr. */ + debug?: boolean; + + /** Do not expand `{a,b}` and `{1..3}` brace sets. */ + nobrace?: boolean; + + /** Disable `**` matching against multiple folder names. */ + noglobstar?: boolean; + + /** + * Allow patterns to match filenames starting with a period, even if + * the pattern does not explicitly have a period in that spot. + * + * Note that by default, `a/** /b` will **not** match `a/.d/b`, unless `dot` is set. + */ + dot?: boolean; + + /** Disable "extglob" style patterns like `+(a|b)`. */ + noext?: boolean; + + /** Perform a case-insensitive match. */ + nocase?: boolean; + + /** + * When a match is not found by `minimatch.match`, return a list containing + * the pattern itself if this option is set. When not set, an empty list + * is returned if there are no matches. + */ + nonull?: boolean; + + /** + * If set, then patterns without slashes will be matched + * against the basename of the path if it contains slashes. For example, + * `a?b` would match the path `/xyz/123/acb`, but not `/xyz/acb/123`. + */ + matchBase?: boolean; + + /** Suppress the behavior of treating `#` at the start of a pattern as a comment. */ + nocomment?: boolean; + + /** Suppress the behavior of treating a leading `!` character as negation. */ + nonegate?: boolean; + + /** Returns from negate expressions the same as if they were not negated. + * (Ie, true on a hit, false on a miss.) + */ + flipNegate?: boolean; + } + +} + +export = multimatch; diff --git a/types/multimatch/multimatch-tests.ts b/types/multimatch/multimatch-tests.ts new file mode 100644 index 0000000000..e867848b28 --- /dev/null +++ b/types/multimatch/multimatch-tests.ts @@ -0,0 +1,8 @@ +import * as multimatch from "multimatch"; + +const options: multimatch.MultimatchOptions = { + debug: true +}; + +multimatch(["unicorn", "cake", "rainbows"], ["*", "!cake"]); +multimatch(["unicorn", "cake", "rainbows"], ["*", "!cake"], options); diff --git a/types/multimatch/tsconfig.json b/types/multimatch/tsconfig.json new file mode 100644 index 0000000000..3f5a4db2ac --- /dev/null +++ b/types/multimatch/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "multimatch-tests.ts" + ] +} diff --git a/types/multimatch/tslint.json b/types/multimatch/tslint.json new file mode 100644 index 0000000000..377cc837d4 --- /dev/null +++ b/types/multimatch/tslint.json @@ -0,0 +1 @@ +{ "extends": "../tslint.json" } From 31aa4d57dcf78c4f92c1e8cb8ecfd49bde225fb7 Mon Sep 17 00:00:00 2001 From: Stephen Lautier Date: Wed, 29 Mar 2017 19:12:45 +0200 Subject: [PATCH 046/844] changed patterns to be either array or string --- types/multimatch/index.d.ts | 2 +- types/multimatch/multimatch-tests.ts | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/types/multimatch/index.d.ts b/types/multimatch/index.d.ts index 5a1c1daab9..7130cafbd0 100644 --- a/types/multimatch/index.d.ts +++ b/types/multimatch/index.d.ts @@ -11,7 +11,7 @@ * @param {multimatch.MultimatchOptions} [options] * @returns {string[]} */ -declare function multimatch(paths: string[], patterns: string[], options?: multimatch.MultimatchOptions): string[]; +declare function multimatch(paths: string[], patterns: string | string[], options?: multimatch.MultimatchOptions): string[]; declare namespace multimatch { diff --git a/types/multimatch/multimatch-tests.ts b/types/multimatch/multimatch-tests.ts index e867848b28..b8c9cac658 100644 --- a/types/multimatch/multimatch-tests.ts +++ b/types/multimatch/multimatch-tests.ts @@ -4,5 +4,6 @@ const options: multimatch.MultimatchOptions = { debug: true }; +multimatch(["unicorn", "cake", "rainbows"], "!cake"); multimatch(["unicorn", "cake", "rainbows"], ["*", "!cake"]); multimatch(["unicorn", "cake", "rainbows"], ["*", "!cake"], options); From d679f337ee06899b7ad8db406a7733fe121c5a1b Mon Sep 17 00:00:00 2001 From: Lindsey Smith Date: Wed, 29 Mar 2017 14:04:44 -0400 Subject: [PATCH 047/844] Add types for linkify-it --- types/linkify-it/index.d.ts | 50 ++++++++++++++++++++++++++++ types/linkify-it/linkify-it-tests.ts | 24 +++++++++++++ types/linkify-it/tsconfig.json | 22 ++++++++++++ types/linkify-it/tslint.json | 1 + 4 files changed, 97 insertions(+) create mode 100644 types/linkify-it/index.d.ts create mode 100644 types/linkify-it/linkify-it-tests.ts create mode 100644 types/linkify-it/tsconfig.json create mode 100644 types/linkify-it/tslint.json diff --git a/types/linkify-it/index.d.ts b/types/linkify-it/index.d.ts new file mode 100644 index 0000000000..00b564bff6 --- /dev/null +++ b/types/linkify-it/index.d.ts @@ -0,0 +1,50 @@ +// Type definitions for tweezer.js 2.0 +// Project: https://github.com/markdown-it/linkify-it +// Definitions by: Lindsey Smith , Robert Coie +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare const LinkifyIt: { + (schemas?: LinkifyIt.SchemaRules, options?: LinkifyIt.Options): LinkifyIt.LinkifyIt; + new (schemas?: LinkifyIt.SchemaRules, options?: LinkifyIt.Options): LinkifyIt.LinkifyIt; +}; + +declare namespace LinkifyIt { + export interface FullRule { + validate: (text: string, pos: number, self: LinkifyIt) => number; + normalize?: (match: string) => string; + } + + export type Rule = string | RegExp | FullRule; + + export interface SchemaRules { + [schema: string]: Rule; + } + + export interface Options { + fuzzyLink?: boolean; + fuzzyIP?: boolean; + fuzzyEmail?: boolean; + } + + export interface Match { + index: number; + lastIndex: number; + raw: string; + schema: string; + text: string; + url: string; + } + + export interface LinkifyIt { + add(schema: string, rule: Rule): LinkifyIt; + match(text: string): Match[]; + normalize(raw: string): string; + pretest(text: string): boolean; + set(options: Options): LinkifyIt; + test(text: string): boolean; + testSchemaAt(text: string, schemaName: string, pos: number): number; + tlds(list: string | string[], keepOld?: boolean): LinkifyIt; + } +} + +export = LinkifyIt; diff --git a/types/linkify-it/linkify-it-tests.ts b/types/linkify-it/linkify-it-tests.ts new file mode 100644 index 0000000000..c4366321cf --- /dev/null +++ b/types/linkify-it/linkify-it-tests.ts @@ -0,0 +1,24 @@ +import LinkifyIt = require('linkify-it'); + +// fluent interface +const linkifier = new LinkifyIt(); + +linkifier + .add('git:', 'http:') + .set({ fuzzyIP: true }) + .tlds('onion', true) + .test("https://github.com/DefinitelyTyped/DefinitelyTyped/"); + +// match +const matches = linkifier.match("https://github.com/DefinitelyTyped/DefinitelyTyped/"); +matches.forEach(({index, lastIndex, raw, schema, text, url}) => {}); + +// complex rule +linkifier.add('@', { + validate: (text, pos, self) => { + return 42; + }, + normalize: (match) => { + return 'forty-two'; + } +}); diff --git a/types/linkify-it/tsconfig.json b/types/linkify-it/tsconfig.json new file mode 100644 index 0000000000..d773912f34 --- /dev/null +++ b/types/linkify-it/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "linkify-it-tests.ts" + ] +} diff --git a/types/linkify-it/tslint.json b/types/linkify-it/tslint.json new file mode 100644 index 0000000000..2221e40e4a --- /dev/null +++ b/types/linkify-it/tslint.json @@ -0,0 +1 @@ +{ "extends": "../tslint.json" } \ No newline at end of file From 047b39d29bfdced98ef39b22d44005b5e6394151 Mon Sep 17 00:00:00 2001 From: Andy Date: Wed, 29 Mar 2017 11:28:28 -0700 Subject: [PATCH 048/844] Remove useless package.json (#15478) --- types/leaflet-fullscreen/package.json | 5 ----- types/leaflet-fullscreen/tsconfig.json | 3 +++ 2 files changed, 3 insertions(+), 5 deletions(-) delete mode 100644 types/leaflet-fullscreen/package.json diff --git a/types/leaflet-fullscreen/package.json b/types/leaflet-fullscreen/package.json deleted file mode 100644 index 8501cf4dbc..0000000000 --- a/types/leaflet-fullscreen/package.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "dependencies": { - "@types/leaflet": "^1.0.58" - } -} \ No newline at end of file diff --git a/types/leaflet-fullscreen/tsconfig.json b/types/leaflet-fullscreen/tsconfig.json index a47f7af1bd..0da8d35169 100644 --- a/types/leaflet-fullscreen/tsconfig.json +++ b/types/leaflet-fullscreen/tsconfig.json @@ -9,6 +9,9 @@ "noImplicitThis": true, "strictNullChecks": true, "baseUrl": "../", + "typeRoots": [ + "../" + ], "types": [], "noEmit": true, "forceConsistentCasingInFileNames": true From 77649ca319b27064390e5bbf88bb69b46896f6c4 Mon Sep 17 00:00:00 2001 From: Andy Date: Wed, 29 Mar 2017 11:33:18 -0700 Subject: [PATCH 049/844] leaflet.locatecontrol: Remove useless package.json (#15479) --- types/leaflet.locatecontrol/package.json | 5 ----- types/leaflet.locatecontrol/tsconfig.json | 3 +++ 2 files changed, 3 insertions(+), 5 deletions(-) delete mode 100644 types/leaflet.locatecontrol/package.json diff --git a/types/leaflet.locatecontrol/package.json b/types/leaflet.locatecontrol/package.json deleted file mode 100644 index 8afe476d51..0000000000 --- a/types/leaflet.locatecontrol/package.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "dependencies": { - "@types/leaflet": "^1.0.58" - } -} diff --git a/types/leaflet.locatecontrol/tsconfig.json b/types/leaflet.locatecontrol/tsconfig.json index 0637d48285..0ccab11228 100644 --- a/types/leaflet.locatecontrol/tsconfig.json +++ b/types/leaflet.locatecontrol/tsconfig.json @@ -9,6 +9,9 @@ "noImplicitThis": true, "strictNullChecks": true, "baseUrl": "../", + "typeRoots": [ + "../" + ], "types": [], "noEmit": true, "forceConsistentCasingInFileNames": true From 57c79ade9fb483e8c6b6af3baf7a8eb8f2818bf0 Mon Sep 17 00:00:00 2001 From: Steven Date: Wed, 29 Mar 2017 14:58:56 -0400 Subject: [PATCH 050/844] Add `max` length to ParameterOptions --- types/tedious/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/tedious/index.d.ts b/types/tedious/index.d.ts index 39d8664e0d..b89ac58beb 100644 --- a/types/tedious/index.d.ts +++ b/types/tedious/index.d.ts @@ -297,7 +297,7 @@ export interface ConnectionConfig { export interface ParameterOptions { // for VarChar, NVarChar, VarBinary - length?: number; + length?: number | 'max'; // precision for Numeric, Decimal precision?: number; // scale for Numeric, Decimal, Time, DateTime2, DateTimeOffset From 5f3ba451365118d954cd0976d5678f54bfec595d Mon Sep 17 00:00:00 2001 From: Andy Date: Wed, 29 Mar 2017 13:07:39 -0700 Subject: [PATCH 051/844] Use `dtslint` (#15482) --- .github/PULL_REQUEST_TEMPLATE.md | 6 ++--- README.md | 11 ++++---- package.json | 9 +++---- scripts/lint.js | 25 ------------------- types/amplify-deferred/tslint.json | 2 +- types/amplify/tslint.json | 2 +- types/angular/tslint.json | 2 +- types/base64-js/base64-js-tests.ts | 6 ++--- types/bluebird-global/tslint.json | 2 +- types/charm/tslint.json | 2 +- types/co-views/tslint.json | 2 +- types/core-decorators/tslint.json | 2 +- types/core-js/tslint.json | 2 +- types/ember/tslint.json | 2 +- types/fabric/tslint.json | 2 +- types/fullcalendar/tslint.json | 2 +- types/fullcalendar/v1/tslint.json | 2 +- types/google.analytics/tslint.json | 2 +- types/handsontable/tslint.json | 4 +-- types/highcharts/tslint.json | 2 +- types/ignite-ui/tslint.json | 2 +- types/jasmine-ajax/tslint.json | 2 +- types/jquery-mask-plugin/tslint.json | 2 +- types/jquery.validation/tslint.json | 2 +- types/js-data-http/tslint.json | 2 +- types/jui-grid/tslint.json | 2 +- types/koa-views/tslint.json | 2 +- types/libpq/tslint.json | 2 +- types/lodash/tslint.json | 2 +- types/mapbox/tslint.json | 2 +- types/merge-descriptors/tslint.json | 2 +- types/ng-stomp/tslint.json | 2 +- types/pixi.js/tslint.json | 2 +- .../qlik-visualizationextensions/tslint.json | 4 +-- types/react-native/tslint.json | 2 +- types/react-router-redux/v3/tslint.json | 2 +- types/react-router/v2/tslint.json | 2 +- types/redux-localstorage/tslint.json | 2 +- types/reflux/tslint.json | 2 +- types/rx-dom/tslint.json | 4 +-- types/rx-lite/tslint.json | 2 +- types/selenium-webdriver/tslint.json | 2 +- types/steed/tslint.json | 2 +- types/tcomb/tslint.json | 2 +- types/transducers-js/tslint.json | 2 +- types/tslint.json | 2 +- types/universal-router/tslint.json | 2 +- 47 files changed, 60 insertions(+), 87 deletions(-) delete mode 100644 scripts/lint.js diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 1fc8897d23..3e8c430b55 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,19 +1,17 @@ Please fill in this template. -- [ ] Make your PR against the `master` branch. - [ ] Use a meaningful title for the pull request. Include the name of the package modified. - [ ] Test the change in your own code. (Compile and run.) - [ ] Follow the advice from the [readme](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.md#make-a-pull-request). - [ ] Avoid [common mistakes](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/README.md#common-mistakes). -- [ ] Run `tsc` without errors. -- [ ] Run `npm run lint package-name` if a `tslint.json` is present. +- [ ] Run `npm run lint package-name` (or `tsc` if no `tslint.json` is present). Select one of these and delete the others: If adding a new definition: - [ ] The package does not provide its own types, and you can not add them. - [ ] If this is for an NPM package, match the name. If not, do not conflict with the name of an NPM package. -- [ ] Create it with `npm run new-package package-name`, not by basing it on an existing project. +- [ ] Create it with `dts-gen --dt`, not by basing it on an existing project. - [ ] `tslint.json` should be present, and `tsconfig.json` should have `noImplicitAny`, `noImplicitThis`, and `strictNullChecks` set to `true`. If changing an existing definition: diff --git a/README.md b/README.md index 9dbb809b57..6868d116cf 100644 --- a/README.md +++ b/README.md @@ -110,9 +110,8 @@ Your package should have this structure: | tsconfig.json | This allows you to run `tsc` within the package. | | tslint.json | Enables linting. | -Generate these by running `npm run new-package -- --name my-package-name --template module`. -(Other templates are `module-class`, `module-function`, `module-plugin`, `global`, `global-plugin`, and `global-modifying-module`. -This just wraps [dts-gen](https://github.com/Microsoft/dts-gen), so it supports all options from that.) +Generate these by running `npm install -g dts-gen` and `dts-gen --dt --name my-package-name --template module`. +See all options at [dts-gen](https://github.com/Microsoft/dts-gen). You may edit the `tsconfig.json` to add new files, to add `"target": "es6"` (needed for async functions), to add to `"lib"`, or to add the `"jsx"` compiler option. @@ -167,9 +166,11 @@ If a `tslint.json` turns rules off, this is because that hasn't been fixed yet. } ``` -(To indicate that a lint rule truly does not apply, use `// tslint:disable:rule-name` or better, `//tslint:disable-next-line:rule-name`.) +(To indicate that a lint rule truly does not apply, use `// tslint:disable rule-name` or better, `//tslint:disable-next-line rule-name`.) + +Test by running `npm run lint package-name` where `package-name` is the name of your package. +This script uses [dtslint](https://github.com/Microsoft/dtslint). -Test the linter by running `npm run lint -- package-name`. Do not use a globally installed tslint. ## FAQ diff --git a/package.json b/package.json index 1dad46394d..77e57cbb44 100644 --- a/package.json +++ b/package.json @@ -16,13 +16,12 @@ }, "scripts": { "compile-scripts": "tsc -p scripts", - "new-package": "dts-gen --dt", "not-needed": "node scripts/not-needed.js", - "lint": "node scripts/lint.js", - "test": "node node_modules/types-publisher/bin/tester/test.js --run-from-definitely-typed --nProcesses 1" + "test": "node node_modules/types-publisher/bin/tester/test.js --run-from-definitely-typed --nProcesses 1", + "lint": "dtslint --dt types" }, "devDependencies": { - "types-publisher": "Microsoft/types-publisher#production", - "dts-gen": "latest" + "dtslint": "Microsoft/dtslint#production", + "types-publisher": "Microsoft/types-publisher#production" } } diff --git a/scripts/lint.js b/scripts/lint.js deleted file mode 100644 index 84ef71259d..0000000000 --- a/scripts/lint.js +++ /dev/null @@ -1,25 +0,0 @@ -// Usage: npm run lint -- my-package-name -const pkg = process.argv[2]; -const execSync = require("child_process").execSync; -const existsSync = require("fs").existsSync; -const path = require("path"); - -const pkgPath = path.join("types", pkg); - -// Path of tslint when `types-publisher` is symlinked -const symlinkedTslintPath = "../../node_modules/types-publisher/node_modules/tslint" -let tslintPath = existsSync(path.join(pkgPath, symlinkedTslintPath)) ? symlinkedTslintPath : "../node_modules/tslint"; -// An older version (e.g. abs/v0) is in a nested directory, so needs to look one more level up for tslint. -if (pkg.includes("/") && pkg[pkg.length - 1] !== "/") { - tslintPath = path.join("..", tslintPath); -} - -const cmd = `node ${tslintPath}/lib/tslint-cli --format stylish "**/*.ts"`; -console.log(cmd); - -try { - // Child process writes directly to our own stdout - execSync(cmd, { cwd: pkgPath, stdio: "inherit" }); -} catch (_) { - // Process should have printed out error info -} diff --git a/types/amplify-deferred/tslint.json b/types/amplify-deferred/tslint.json index f05741c59b..b0e7084e94 100644 --- a/types/amplify-deferred/tslint.json +++ b/types/amplify-deferred/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } diff --git a/types/amplify/tslint.json b/types/amplify/tslint.json index fe03bea79d..6e33505955 100644 --- a/types/amplify/tslint.json +++ b/types/amplify/tslint.json @@ -1,7 +1,7 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false, + "ban-types": false, "unified-signatures": false } } diff --git a/types/angular/tslint.json b/types/angular/tslint.json index 7ba374959e..6bbe7c9318 100644 --- a/types/angular/tslint.json +++ b/types/angular/tslint.json @@ -12,7 +12,7 @@ ], "align": true, "callable-types": false, - "forbidden-types": false, + "ban-types": false, "indent": [ true, "spaces" diff --git a/types/base64-js/base64-js-tests.ts b/types/base64-js/base64-js-tests.ts index 13c3f705b5..402ce43e88 100644 --- a/types/base64-js/base64-js-tests.ts +++ b/types/base64-js/base64-js-tests.ts @@ -1,5 +1,5 @@ import * as base64js from "base64-js"; -const length: number = base64js.byteLength(""); -const bytes: Uint8Array = base64js.toByteArray(""); -const decoded: string = base64js.fromByteArray(new Uint8Array(0)); +base64js.byteLength(""); // $ExpectType number +base64js.toByteArray(""); // $ExpectType Uint8Array +base64js.fromByteArray(new Uint8Array(0)); // $ExpectTpe string diff --git a/types/bluebird-global/tslint.json b/types/bluebird-global/tslint.json index b03221674a..37c90f2397 100644 --- a/types/bluebird-global/tslint.json +++ b/types/bluebird-global/tslint.json @@ -5,6 +5,6 @@ "no-empty-interface": false, "array-type": false, "unified-signatures": false, - "forbidden-types": false + "ban-types": false } } diff --git a/types/charm/tslint.json b/types/charm/tslint.json index f05741c59b..b0e7084e94 100644 --- a/types/charm/tslint.json +++ b/types/charm/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } diff --git a/types/co-views/tslint.json b/types/co-views/tslint.json index f05741c59b..b0e7084e94 100644 --- a/types/co-views/tslint.json +++ b/types/co-views/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } diff --git a/types/core-decorators/tslint.json b/types/core-decorators/tslint.json index 0332a8383e..caa1fde509 100644 --- a/types/core-decorators/tslint.json +++ b/types/core-decorators/tslint.json @@ -2,6 +2,6 @@ "extends": "../tslint.json", "rules": { "callable-types": false, - "forbidden-types": false + "ban-types": false } } diff --git a/types/core-js/tslint.json b/types/core-js/tslint.json index 0f47deabb4..3bfbe8c142 100644 --- a/types/core-js/tslint.json +++ b/types/core-js/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } \ No newline at end of file diff --git a/types/ember/tslint.json b/types/ember/tslint.json index fcd9410184..c91d42f0b2 100644 --- a/types/ember/tslint.json +++ b/types/ember/tslint.json @@ -2,7 +2,7 @@ "extends": "../tslint.json", "rules": { // Heavy use of Function type in this older package. - "forbidden-types": false, + "ban-types": false, "no-misused-new": false, // not sure what this means "no-single-declare-module": false diff --git a/types/fabric/tslint.json b/types/fabric/tslint.json index 525190cf34..4702666135 100644 --- a/types/fabric/tslint.json +++ b/types/fabric/tslint.json @@ -2,7 +2,7 @@ "extends": "../tslint.json", "rules": { "adjacent-overload-signatures": false, - "forbidden-types": false, + "ban-types": false, "interface-name": false, "no-empty-interface": false, "unified-signatures": false diff --git a/types/fullcalendar/tslint.json b/types/fullcalendar/tslint.json index fe03bea79d..6e33505955 100644 --- a/types/fullcalendar/tslint.json +++ b/types/fullcalendar/tslint.json @@ -1,7 +1,7 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false, + "ban-types": false, "unified-signatures": false } } diff --git a/types/fullcalendar/v1/tslint.json b/types/fullcalendar/v1/tslint.json index fe03bea79d..6e33505955 100644 --- a/types/fullcalendar/v1/tslint.json +++ b/types/fullcalendar/v1/tslint.json @@ -1,7 +1,7 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false, + "ban-types": false, "unified-signatures": false } } diff --git a/types/google.analytics/tslint.json b/types/google.analytics/tslint.json index e8bc207e33..de20a402c4 100644 --- a/types/google.analytics/tslint.json +++ b/types/google.analytics/tslint.json @@ -2,7 +2,7 @@ "extends": "../tslint.json", "rules": { "dt-header": false, - "forbidden-types": false, + "ban-types": false, "unified-signatures": false } } diff --git a/types/handsontable/tslint.json b/types/handsontable/tslint.json index 14c6526bd1..6efbba674b 100644 --- a/types/handsontable/tslint.json +++ b/types/handsontable/tslint.json @@ -1,7 +1,7 @@ -{ +{ "extends": "../tslint.json", "rules": { - "forbidden-types": false, + "ban-types": false, "no-single-declare-module": false } } \ No newline at end of file diff --git a/types/highcharts/tslint.json b/types/highcharts/tslint.json index 6fb4f705cf..a53062e5df 100644 --- a/types/highcharts/tslint.json +++ b/types/highcharts/tslint.json @@ -1,7 +1,7 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false, + "ban-types": false, "unified-signatures": false, "array-type": false, "no-empty-interface": false, diff --git a/types/ignite-ui/tslint.json b/types/ignite-ui/tslint.json index 71f9eaad3f..c1f39f62eb 100644 --- a/types/ignite-ui/tslint.json +++ b/types/ignite-ui/tslint.json @@ -2,7 +2,7 @@ "extends": "../tslint.json", "rules": { "dt-header": false, - "forbidden-types": false, + "ban-types": false, "unified-signatures": false, "max-line-length": false, "whitespace": false diff --git a/types/jasmine-ajax/tslint.json b/types/jasmine-ajax/tslint.json index fe03bea79d..6e33505955 100644 --- a/types/jasmine-ajax/tslint.json +++ b/types/jasmine-ajax/tslint.json @@ -1,7 +1,7 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false, + "ban-types": false, "unified-signatures": false } } diff --git a/types/jquery-mask-plugin/tslint.json b/types/jquery-mask-plugin/tslint.json index f05741c59b..b0e7084e94 100644 --- a/types/jquery-mask-plugin/tslint.json +++ b/types/jquery-mask-plugin/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } diff --git a/types/jquery.validation/tslint.json b/types/jquery.validation/tslint.json index f05741c59b..b0e7084e94 100644 --- a/types/jquery.validation/tslint.json +++ b/types/jquery.validation/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } diff --git a/types/js-data-http/tslint.json b/types/js-data-http/tslint.json index 394d3ce319..27b52dc1e1 100644 --- a/types/js-data-http/tslint.json +++ b/types/js-data-http/tslint.json @@ -1,7 +1,7 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false, + "ban-types": false, "no-misused-new": false } } diff --git a/types/jui-grid/tslint.json b/types/jui-grid/tslint.json index f05741c59b..b0e7084e94 100644 --- a/types/jui-grid/tslint.json +++ b/types/jui-grid/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } diff --git a/types/koa-views/tslint.json b/types/koa-views/tslint.json index 0f47deabb4..3bfbe8c142 100644 --- a/types/koa-views/tslint.json +++ b/types/koa-views/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } \ No newline at end of file diff --git a/types/libpq/tslint.json b/types/libpq/tslint.json index f05741c59b..b0e7084e94 100644 --- a/types/libpq/tslint.json +++ b/types/libpq/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } diff --git a/types/lodash/tslint.json b/types/lodash/tslint.json index 62d13dc883..7805e0387d 100644 --- a/types/lodash/tslint.json +++ b/types/lodash/tslint.json @@ -4,7 +4,7 @@ "array-type": false, "callable-types": false, "comment-format": false, - "forbidden-types": false, + "ban-types": false, "interface-name": false, "interface-over-type-literal": false, "max-line-length": false, diff --git a/types/mapbox/tslint.json b/types/mapbox/tslint.json index f05741c59b..b0e7084e94 100644 --- a/types/mapbox/tslint.json +++ b/types/mapbox/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } diff --git a/types/merge-descriptors/tslint.json b/types/merge-descriptors/tslint.json index f05741c59b..b0e7084e94 100644 --- a/types/merge-descriptors/tslint.json +++ b/types/merge-descriptors/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } diff --git a/types/ng-stomp/tslint.json b/types/ng-stomp/tslint.json index 2ab0c36fa8..867dfe94d3 100644 --- a/types/ng-stomp/tslint.json +++ b/types/ng-stomp/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } \ No newline at end of file diff --git a/types/pixi.js/tslint.json b/types/pixi.js/tslint.json index 6fa0ddab84..136166583e 100644 --- a/types/pixi.js/tslint.json +++ b/types/pixi.js/tslint.json @@ -1,7 +1,7 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false, + "ban-types": false, "interface-name": false, "no-single-declare-module": false, "unified-signatures": false, diff --git a/types/qlik-visualizationextensions/tslint.json b/types/qlik-visualizationextensions/tslint.json index cae1bdf2ad..97addf8511 100644 --- a/types/qlik-visualizationextensions/tslint.json +++ b/types/qlik-visualizationextensions/tslint.json @@ -1,7 +1,7 @@ -{ +{ "extends": "../tslint.json", "rules": { - "forbidden-types": false, + "ban-types": false, "no-empty-interface": false, "interface-name": false } diff --git a/types/react-native/tslint.json b/types/react-native/tslint.json index dd4e4a1cba..8ca9d9f2c3 100644 --- a/types/react-native/tslint.json +++ b/types/react-native/tslint.json @@ -2,6 +2,6 @@ "extends": "../tslint.json", "rules": { // Lowercase `object` is available in TypeScript 2.2 only. - "forbidden-types": false + "ban-types": false } } diff --git a/types/react-router-redux/v3/tslint.json b/types/react-router-redux/v3/tslint.json index d032145676..7a5f77c1dc 100644 --- a/types/react-router-redux/v3/tslint.json +++ b/types/react-router-redux/v3/tslint.json @@ -1,7 +1,7 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false, + "ban-types": false, "no-empty-interface": false } } diff --git a/types/react-router/v2/tslint.json b/types/react-router/v2/tslint.json index d032145676..7a5f77c1dc 100644 --- a/types/react-router/v2/tslint.json +++ b/types/react-router/v2/tslint.json @@ -1,7 +1,7 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false, + "ban-types": false, "no-empty-interface": false } } diff --git a/types/redux-localstorage/tslint.json b/types/redux-localstorage/tslint.json index d032145676..7a5f77c1dc 100644 --- a/types/redux-localstorage/tslint.json +++ b/types/redux-localstorage/tslint.json @@ -1,7 +1,7 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false, + "ban-types": false, "no-empty-interface": false } } diff --git a/types/reflux/tslint.json b/types/reflux/tslint.json index f05741c59b..b0e7084e94 100644 --- a/types/reflux/tslint.json +++ b/types/reflux/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } diff --git a/types/rx-dom/tslint.json b/types/rx-dom/tslint.json index 8dd3240216..ee6fc74495 100644 --- a/types/rx-dom/tslint.json +++ b/types/rx-dom/tslint.json @@ -2,7 +2,7 @@ "extends": "../tslint.json", "rules": { // this package augments Rx with namespace level functions - // it would be particualrly strange to type these functions differently - "forbidden-types": false + // it would be particualrly strange to type these functions differently + "ban-types": false } } diff --git a/types/rx-lite/tslint.json b/types/rx-lite/tslint.json index 1bec85bd5c..69a2063c99 100644 --- a/types/rx-lite/tslint.json +++ b/types/rx-lite/tslint.json @@ -3,7 +3,7 @@ "rules": { "unified-signatures": false, "no-empty-interface": false, - "forbidden-types": false, + "ban-types": false, "interface-name": false, "array-type": false, "max-line-length": false, diff --git a/types/selenium-webdriver/tslint.json b/types/selenium-webdriver/tslint.json index 93fffac84e..f38c4dfc69 100644 --- a/types/selenium-webdriver/tslint.json +++ b/types/selenium-webdriver/tslint.json @@ -1,8 +1,8 @@ { "extends": "../tslint.json", "rules": { + "ban-types": false, "callable-types": false, - "forbidden-types": false, "interface-name": [false], "no-empty-interface": false, "unified-signatures": false diff --git a/types/steed/tslint.json b/types/steed/tslint.json index 0f47deabb4..3bfbe8c142 100644 --- a/types/steed/tslint.json +++ b/types/steed/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } \ No newline at end of file diff --git a/types/tcomb/tslint.json b/types/tcomb/tslint.json index c3d18eb9dd..d3cce83dc9 100644 --- a/types/tcomb/tslint.json +++ b/types/tcomb/tslint.json @@ -2,7 +2,7 @@ "extends": "../tslint.json", "rules": { "callable-types": false, - "forbidden-types": false, + "ban-types": false, "no-empty-interface": false, "no-single-declare-module": false, "unified-signatures": false diff --git a/types/transducers-js/tslint.json b/types/transducers-js/tslint.json index f05741c59b..b0e7084e94 100644 --- a/types/transducers-js/tslint.json +++ b/types/transducers-js/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } diff --git a/types/tslint.json b/types/tslint.json index 56b31d320a..6602359a97 100644 --- a/types/tslint.json +++ b/types/tslint.json @@ -1 +1 @@ -{ "extends": "../node_modules/types-publisher/tslint-definitions.json" } \ No newline at end of file +{ "extends": "dtslint/dtslint.json" } \ No newline at end of file diff --git a/types/universal-router/tslint.json b/types/universal-router/tslint.json index f05741c59b..b0e7084e94 100644 --- a/types/universal-router/tslint.json +++ b/types/universal-router/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "ban-types": false } } From 2628148cfc8b8fcb1573d938f6a040e56826ba10 Mon Sep 17 00:00:00 2001 From: Andy Date: Wed, 29 Mar 2017 14:25:29 -0700 Subject: [PATCH 052/844] amplify: Apply new lint rules (#15483) --- types/amplify/amplify-tests.ts | 15 +++++---------- types/amplify/index.d.ts | 4 ++-- 2 files changed, 7 insertions(+), 12 deletions(-) diff --git a/types/amplify/amplify-tests.ts b/types/amplify/amplify-tests.ts index 8cce567960..ab4a9bf1bd 100644 --- a/types/amplify/amplify-tests.ts +++ b/types/amplify/amplify-tests.ts @@ -16,7 +16,6 @@ amplify.subscribe("dataexample", data => { alert(data.foo); // bar }); - amplify.publish("dataexample", { foo: "bar" }); amplify.subscribe("dataexample2", (param1, param2) => { @@ -47,7 +46,6 @@ amplify.subscribe("priorityexample", data => { } }, 1); - // Store data with amplify storage picking the default storage technology: amplify.publish("priorityexample", { foo: "bar" }); @@ -56,9 +54,9 @@ amplify.publish("priorityexample", { foo: "oops" }); amplify.store("storeExample1", { foo: "bar" }); amplify.store("storeExample2", "baz"); // retrieve the data later via the key -var myStoredValue = amplify.store("storeExample1"), - myStoredValue2 = amplify.store("storeExample2"), - myStoredValues = amplify.store(); +const myStoredValue = amplify.store("storeExample1"); +let myStoredValue2 = amplify.store("storeExample2"); +const myStoredValues = amplify.store(); myStoredValue.foo; // bar myStoredValue2; // baz myStoredValues.storeExample1.foo; // bar @@ -68,15 +66,13 @@ myStoredValues.storeExample2; // baz amplify.store.sessionStorage("explicitExample", { foo2: "baz" }); // retrieve the data later via the key -var myStoredValue2 = amplify.store.sessionStorage("explicitExample"); +myStoredValue2 = amplify.store.sessionStorage("explicitExample"); myStoredValue2.foo2; // baz - // REQUEST // Set up and use a request utilizing Ajax - amplify.request.define("ajaxExample1", "ajax", { url: "/myApiUrl", dataType: "json", @@ -175,7 +171,7 @@ amplify.request("twitter-mentions", { user: "amplifyjs" }); // Example: -var appEnvelopeDecoder: amplify.Decoder = (data, status, xhr, success, error) => { +const appEnvelopeDecoder: amplify.Decoder = (data, status, xhr, success, error) => { if (data.status === "success") { success(data.data); } else if (data.status === "fail" || data.status === "error") { @@ -197,7 +193,6 @@ amplify.request.decoders.appEnvelope = appEnvelopeDecoder; // but you can also just add it via an index amplify.request.decoders['appEnvelopeStr'] = appEnvelopeDecoder; - amplify.request.define("decoderExample", "ajax", { url: "/myAjaxUrl", type: "POST", diff --git a/types/amplify/index.d.ts b/types/amplify/index.d.ts index 5cb03e5b1d..f88c754264 100644 --- a/types/amplify/index.d.ts +++ b/types/amplify/index.d.ts @@ -9,8 +9,8 @@ declare namespace amplify { interface RequestSettings { resourceId: string; data?: any; - success?: (...args: any[]) => void; - error?: (...args: any[]) => void; + success?(...args: any[]): void; + error?(...args: any[]): void; } type Decoder = From d426ff3083ffad410eac5b4e798695529a5652fc Mon Sep 17 00:00:00 2001 From: Andy Date: Wed, 29 Mar 2017 14:46:16 -0700 Subject: [PATCH 053/844] Apply new lint rules to yet more packages (#15486) --- .../angular-gridster-tests.ts | 5 +- types/angular-oauth2/angular-oauth2-tests.ts | 2 +- .../bluebird-global/bluebird-global-tests.ts | 2 - types/charm/charm-tests.ts | 16 +- types/core-decorators/index.d.ts | 51 ++---- types/core-js/index.d.ts | 4 +- types/fabric/index.d.ts | 2 +- types/fullcalendar/index.d.ts | 48 ++--- types/fullcalendar/v1/index.d.ts | 48 ++--- types/google.analytics/index.d.ts | 2 +- types/handsontable/index.d.ts | 164 +++++++++--------- types/jasmine-ajax/index.d.ts | 2 +- types/js-data-http/index.d.ts | 6 +- types/jui-grid/index.d.ts | 2 +- types/koa-views/index.d.ts | 4 - types/koa-views/koa-views-tests.ts | 2 +- types/mapbox/index.d.ts | 4 +- types/pixi.js/tslint.json | 1 + types/qlik-visualizationextensions/index.d.ts | 2 +- types/rx-lite-async/rx-lite-async-tests.ts | 37 ++-- types/rx-lite-coincidence/index.d.ts | 1 - types/rx-lite-experimental/index.d.ts | 1 - types/rx-lite-joinpatterns/index.d.ts | 1 - types/tslint.json | 8 +- 24 files changed, 195 insertions(+), 220 deletions(-) diff --git a/types/angular-gridster/angular-gridster-tests.ts b/types/angular-gridster/angular-gridster-tests.ts index 7af4908d2d..f8c5a93c81 100644 --- a/types/angular-gridster/angular-gridster-tests.ts +++ b/types/angular-gridster/angular-gridster-tests.ts @@ -3,11 +3,10 @@ import * as angular from "angular"; import gridster from "angular-gridster"; -var myApp = angular.module("testModule", ["gridster"]); +const myApp = angular.module("testModule", ["gridster"]); // configure gridster's global options myApp.run(["gridsterConfig", (gridsterConfig: angular.gridster.GridsterConfig) => { - gridsterConfig.mobileBreakPoint = 697; gridsterConfig.colWidth = "100"; gridsterConfig.rowHeight = "100"; @@ -24,4 +23,4 @@ myApp.run(["gridsterConfig", (gridsterConfig: angular.gridster.GridsterConfig) = gridsterConfig.resizable = { enabled: true, handles: ["n", "s", "e", "w", "ne", "se", "sw", "nw"]}; } -]); \ No newline at end of file +]); diff --git a/types/angular-oauth2/angular-oauth2-tests.ts b/types/angular-oauth2/angular-oauth2-tests.ts index 042fe537aa..89dd51b4aa 100644 --- a/types/angular-oauth2/angular-oauth2-tests.ts +++ b/types/angular-oauth2/angular-oauth2-tests.ts @@ -7,4 +7,4 @@ angular.module('angular-oauth2-test', ['angular-oauth2']) clientId: 'CLIENT_ID', clientSecret: 'CLIENT_SECRET' // optional }); - }]); \ No newline at end of file + }]); diff --git a/types/bluebird-global/bluebird-global-tests.ts b/types/bluebird-global/bluebird-global-tests.ts index 43d5fee050..0464b188cd 100644 --- a/types/bluebird-global/bluebird-global-tests.ts +++ b/types/bluebird-global/bluebird-global-tests.ts @@ -7,7 +7,6 @@ function testSomeStaticMethods() { function testFunctionReturningPromise() { function functionReturningPromise(): Promise { return new Promise((resolve, reject, onCancel) => { - if (onCancel) { onCancel(() => { console.log("onCancel cleanup"); @@ -40,5 +39,4 @@ function testPromiseRejection() { .then((value) => { return value.toUpperCase(); }); - } diff --git a/types/charm/charm-tests.ts b/types/charm/charm-tests.ts index afc8cbc3b6..d87a360084 100644 --- a/types/charm/charm-tests.ts +++ b/types/charm/charm-tests.ts @@ -3,15 +3,15 @@ const charm = getCharm(); charm.pipe(process.stdout); charm.reset(); -var colors: getCharm.CharmColor[] = [ 'red', 'cyan', 'yellow', 'green', 'blue' ]; -var text = 'Always after me lucky charms.'; +const colors: getCharm.CharmColor[] = [ 'red', 'cyan', 'yellow', 'green', 'blue' ]; +const text = 'Always after me lucky charms.'; -var offset = 0; -var iv = setInterval(() => { - var y = 0, dy = 1; - for (var i = 0; i < 40; i++) { - var color = colors[(i + offset) % colors.length]; - var c = text[(i + offset) % text.length]; +let offset = 0; +const iv = setInterval(() => { + let y = 0, dy = 1; + for (let i = 0; i < 40; i++) { + const color = colors[(i + offset) % colors.length]; + const c = text[(i + offset) % text.length]; charm .move(1, dy) .foreground(color) diff --git a/types/core-decorators/index.d.ts b/types/core-decorators/index.d.ts index d0a51009eb..4af9fd5fa5 100644 --- a/types/core-decorators/index.d.ts +++ b/types/core-decorators/index.d.ts @@ -49,87 +49,68 @@ export interface Console { * Forces invocations of this function to always have this refer to the class instance, * even if the function is passed around or would otherwise lose its this context. e.g. var fn = context.method; */ -declare var autobind: Function; +export const autobind: Function; /** * Marks a property or method as not being writable. */ -declare var readonly: PropertyOrMethodDecorator; +export const readonly: PropertyOrMethodDecorator; /** * Checks that the marked method indeed overrides a function with the same signature somewhere on the prototype chain. */ -declare var override: MethodDecorator; +export const override: MethodDecorator; /** * Calls console.warn() with a deprecation message. Provide a custom message to override the default one. You can also provide an options hash with a url, for further reading. */ -declare var deprecate: Deprecate; +export const deprecate: Deprecate; /** * Calls console.warn() with a deprecation message. Provide a custom message to override the default one. You can also provide an options hash with a url, for further reading. */ -declare var deprecated: Deprecate; +export const deprecated: Deprecate; /** * Creates a new debounced function which will be invoked after wait milliseconds since the time it was invoked. Default timeout is 300 ms. */ -declare var debounce: (wait: number) => MethodDecorator; +export function debounce(wait: number): MethodDecorator; /** * Creates a new throttled function which will be invoked in every wait milliseconds. Default timeout is 300 ms. */ -declare var throttle: (wait: number, options?: ThrottleOptions) => MethodDecorator; +export function throttle(wait: number, options?: ThrottleOptions): MethodDecorator; /** * Suppresses any JavaScript console.warn() call while the decorated function is called. (i.e. on the stack) */ -declare var suppressWarnings: MethodDecorator; +export const suppressWarnings: MethodDecorator; /** * Marks a property or method as not being enumerable. */ -declare var nonenumerable: PropertyOrMethodDecorator; +export const nonenumerable: PropertyOrMethodDecorator; /** * Marks a property or method as not being writable. */ -declare var nonconfigurable: PropertyOrMethodDecorator; +export const nonconfigurable: PropertyOrMethodDecorator; /** * Initial implementation included, likely slow. WIP. */ -declare var memoize: MethodDecorator; +export const memoize: MethodDecorator; /** * Immediately applies the provided function and arguments to the method, allowing you to wrap methods with arbitrary helpers like those provided by lodash. * The first argument is the function to apply, all further arguments will be passed to that decorating function. */ -declare var decorate: (func: Function, ...args: any[]) => MethodDecorator; +export function decorate(func: Function, ...args: any[]): MethodDecorator; /** * Prevents a property initializer from running until the decorated property is actually looked up. * Useful to prevent excess allocations that might otherwise not be used, but be careful not to over-optimize things. */ -declare var lazyInitialize: PropertyDecorator; +export const lazyInitialize: PropertyDecorator; /** * Mixes in all property descriptors from the provided Plain Old JavaScript Objects (aka POJOs) as arguments. * Mixins are applied in the order they are passed, but do not override descriptors already on the class, including those inherited traditionally. */ -declare var mixin: (...mixins: any[]) => ClassDecorator; +export function mixin(...mixins: any[]): ClassDecorator; /** * Mixes in all property descriptors from the provided Plain Old JavaScript Objects (aka POJOs) as arguments. * Mixins are applied in the order they are passed, but do not override descriptors already on the class, including those inherited traditionally. */ -declare var mixins: (...mixins: any[]) => ClassDecorator; +export function mixins(...mixins: any[]): ClassDecorator; /** * Uses console.time and console.timeEnd to provide function timings with a unique label whose default prefix is ClassName.method. Supply a first argument to override the prefix: */ -declare var time: (label: string, console?: Console) => MethodDecorator; - -export { -autobind, -readonly, -override, -deprecate, -deprecated, -debounce, -throttle, -suppressWarnings, -nonenumerable, -nonconfigurable, -memoize, -decorate, -lazyInitialize, -mixin, -mixins, -time, -}; +export function time(label: string, console?: Console): MethodDecorator; diff --git a/types/core-js/index.d.ts b/types/core-js/index.d.ts index 0bbe4974ae..dc37560d4d 100644 --- a/types/core-js/index.d.ts +++ b/types/core-js/index.d.ts @@ -927,7 +927,7 @@ declare module "core-js/fn/function" { export = Function; } declare module "core-js/fn/function/has-instance" { - const hasInstance: (value: any) => boolean; + function hasInstance(value: any): boolean; export = hasInstance; } declare module "core-js/fn/function/name" { @@ -1706,7 +1706,7 @@ declare module "core-js/library/fn/function" { export = Function; } declare module "core-js/library/fn/function/has-instance" { - const hasInstance: (value: any) => boolean; + function hasInstance(value: any): boolean; export = hasInstance; } declare module "core-js/library/fn/function/name" { diff --git a/types/fabric/index.d.ts b/types/fabric/index.d.ts index 27a4188f52..18b9c41e82 100644 --- a/types/fabric/index.d.ts +++ b/types/fabric/index.d.ts @@ -933,7 +933,7 @@ interface IStaticCanvasOptions { * Function that determines clipping of entire canvas area * Being passed context as first argument. See clipping canvas area */ - clipTo?: (context: CanvasRenderingContext2D) => void; + clipTo?(context: CanvasRenderingContext2D): void; /** * Indicates whether object controls (borders/controls) are rendered above overlay image diff --git a/types/fullcalendar/index.d.ts b/types/fullcalendar/index.d.ts index 5d6401b9df..76a5de13f3 100644 --- a/types/fullcalendar/index.d.ts +++ b/types/fullcalendar/index.d.ts @@ -55,10 +55,10 @@ export interface Options extends AgendaOptions, EventDraggingResizingOptions, Dr aspectRatio?: number; handleWindowResize?: boolean; views?: ViewSpecificOptions; - viewRender?: (view: ViewObject, element: JQuery) => void; - viewDestroy?: (view: ViewObject, element: JQuery) => void; - dayRender?: (date: Date, cell: HTMLTableDataCellElement) => void; - windowResize?: (view: ViewObject) => void; + viewRender?(view: ViewObject, element: JQuery): void; + viewDestroy?(view: ViewObject, element: JQuery): void; + dayRender?(date: Date, cell: HTMLTableDataCellElement): void; + windowResize?(view: ViewObject): void; // Timezone timezone?: string | boolean; @@ -90,10 +90,10 @@ export interface Options extends AgendaOptions, EventDraggingResizingOptions, Dr // Clicking & Hovering - http://fullcalendar.io/docs/mouse/ - dayClick?: (date: Date, allDay: boolean, jsEvent: MouseEvent, view: ViewObject) => void; - eventClick?: (event: EventObject, jsEvent: MouseEvent, view: ViewObject) => any; // return type boolean or void - eventMouseover?: (event: EventObject, jsEvent: MouseEvent, view: ViewObject) => void; - eventMouseout?: (event: EventObject, jsEvent: MouseEvent, view: ViewObject) => void; + dayClick?(date: Date, allDay: boolean, jsEvent: MouseEvent, view: ViewObject): void; + eventClick?(event: EventObject, jsEvent: MouseEvent, view: ViewObject): any; // return type boolean or void + eventMouseover?(event: EventObject, jsEvent: MouseEvent, view: ViewObject): void; + eventMouseout?(event: EventObject, jsEvent: MouseEvent, view: ViewObject): void; // Event Data - http://fullcalendar.io/docs/event_data/ @@ -120,8 +120,8 @@ export interface Options extends AgendaOptions, EventDraggingResizingOptions, Dr startParam?: string; endParam?: string; lazyFetching?: boolean; - eventDataTransform?: (eventData: any) => EventObject; - loading?: (isLoading: boolean, view: ViewObject) => void; + eventDataTransform?(eventData: any): EventObject; + loading?(isLoading: boolean, view: ViewObject): void; eventLimit?: boolean; // Event Rendering - http://fullcalendar.io/docs/event_rendering/ @@ -130,10 +130,10 @@ export interface Options extends AgendaOptions, EventDraggingResizingOptions, Dr eventBackgroundColor?: string; eventBorderColor?: string; eventTextColor?: string; - eventRender?: (event: EventObject, element: HTMLDivElement, view: ViewObject) => void; - eventAfterRender?: (event: EventObject, element: HTMLDivElement, view: ViewObject) => void; - eventAfterAllRender?: (view: ViewObject) => void; - eventDestroy?: (event: EventObject, element: JQuery, view: ViewObject) => void; + eventRender?(event: EventObject, element: HTMLDivElement, view: ViewObject): void; + eventAfterRender?(event: EventObject, element: HTMLDivElement, view: ViewObject): void; + eventAfterAllRender?(view: ViewObject): void; + eventDestroy?(event: EventObject, element: JQuery, view: ViewObject): void; // scheduler options resourceAreaWidth?: number; @@ -172,12 +172,12 @@ export interface EventDraggingResizingOptions { dragScroll?: boolean; eventOverlap?: boolean | ((stillEvent: EventObject, movingEvent: EventObject) => boolean); eventConstraint?: "businessHours" | BusinessHours | Timespan; - eventDragStart?: (event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject) => void; - eventDragStop?: (event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject) => void; - eventDrop?: (event: EventObject, delta: moment.Duration, revertFunc: Function, jsEvent: Event, ui: any, view: ViewObject) => void; - eventResizeStart?: (event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject) => void; - eventResizeStop?: (event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject) => void; - eventResize?: (event: EventObject, delta: moment.Duration, revertFunc: Function, jsEvent: Event, ui: any, view: ViewObject) => void; + eventDragStart?(event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject): void; + eventDragStop?(event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject): void; + eventDrop?(event: EventObject, delta: moment.Duration, revertFunc: Function, jsEvent: Event, ui: any, view: ViewObject): void; + eventResizeStart?(event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject): void; + eventResizeStop?(event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject): void; + eventResize?(event: EventObject, delta: moment.Duration, revertFunc: Function, jsEvent: Event, ui: any, view: ViewObject): void; } /* * Selection - http://fullcalendar.io/docs/selection/ @@ -189,15 +189,15 @@ export interface SelectionOptions { unselectCancel?: string; selectOverlap?: boolean | ((event: EventObject) => boolean); selectConstraint?: Timespan | BusinessHours; - select?: (start: moment.Moment, end: moment.Moment, jsEvent: MouseEvent, view: ViewObject, resource?: any) => void; - unselect?: (view: ViewObject, jsEvent: Event) => void; + select?(start: moment.Moment, end: moment.Moment, jsEvent: MouseEvent, view: ViewObject, resource?: any): void; + unselect?(view: ViewObject, jsEvent: Event): void; } export interface DroppingExternalElementsOptions { droppable?: boolean; dropAccept?: string | ((draggable: any) => boolean); - drop?: (date: moment.Moment, jsEvent: MouseEvent, ui: any) => void; - eventReceive?: (event: EventObject) => void; + drop?(date: moment.Moment, jsEvent: MouseEvent, ui: any): void; + eventReceive?(event: EventObject): void; } export interface ButtonTextObject { diff --git a/types/fullcalendar/v1/index.d.ts b/types/fullcalendar/v1/index.d.ts index 4fcb41731b..4c8a5dc65a 100644 --- a/types/fullcalendar/v1/index.d.ts +++ b/types/fullcalendar/v1/index.d.ts @@ -71,10 +71,10 @@ declare global { contentHeight?: number; aspectRatio?: number; handleWindowResize?: boolean; - viewRender?: (view: ViewObject, element: JQuery) => void; - viewDestroy?: (view: ViewObject, element: JQuery) => void; - dayRender?: (date: Date, cell: HTMLTableDataCellElement) => void; - windowResize?: (view: ViewObject) => void; + viewRender?(view: ViewObject, element: JQuery): void; + viewDestroy?(view: ViewObject, element: JQuery): void; + dayRender?(date: Date, cell: HTMLTableDataCellElement): void; + windowResize?(view: ViewObject): void; // Timezone timezone?: string | boolean; @@ -106,10 +106,10 @@ declare global { // Clicking & Hovering - http://arshaw.com/fullcalendar/docs/mouse/ - dayClick?: (date: Date, allDay: boolean, jsEvent: MouseEvent, view: ViewObject) => void; - eventClick?: (event: EventObject, jsEvent: MouseEvent, view: ViewObject) => any; // return type boolean or void - eventMouseover?: (event: EventObject, jsEvent: MouseEvent, view: ViewObject) => void; - eventMouseout?: (event: EventObject, jsEvent: MouseEvent, view: ViewObject) => void; + dayClick?(date: Date, allDay: boolean, jsEvent: MouseEvent, view: ViewObject): void; + eventClick?(event: EventObject, jsEvent: MouseEvent, view: ViewObject): any; // return type boolean or void + eventMouseover?(event: EventObject, jsEvent: MouseEvent, view: ViewObject): void; + eventMouseout?(event: EventObject, jsEvent: MouseEvent, view: ViewObject): void; // Event Data - http://arshaw.com/fullcalendar/docs/event_data/ @@ -137,8 +137,8 @@ declare global { startParam?: string; endParam?: string; lazyFetching?: boolean; - eventDataTransform?: (eventData: any) => EventObject; - loading?: (isLoading: boolean, view: ViewObject) => void; + eventDataTransform?(eventData: any): EventObject; + loading?(isLoading: boolean, view: ViewObject): void; // Event Rendering - http://arshaw.com/fullcalendar/docs/event_rendering/ @@ -146,10 +146,10 @@ declare global { eventBackgroundColor?: string; eventBorderColor?: string; eventTextColor?: string; - eventRender?: (event: EventObject, element: HTMLDivElement, view: ViewObject) => void; - eventAfterRender?: (event: EventObject, element: HTMLDivElement, view: ViewObject) => void; - eventAfterAllRender?: (view: ViewObject) => void; - eventDestroy?: (event: EventObject, element: JQuery, view: ViewObject) => void; + eventRender?(event: EventObject, element: HTMLDivElement, view: ViewObject): void; + eventAfterRender?(event: EventObject, element: HTMLDivElement, view: ViewObject): void; + eventAfterAllRender?(view: ViewObject): void; + eventDestroy?(event: EventObject, element: JQuery, view: ViewObject): void; } interface ViewOptionHash { @@ -193,12 +193,12 @@ declare global { dragScroll?: boolean; eventOverlap?: boolean | ((stillEvent: EventObject, movingEvent: EventObject) => boolean); eventConstraint?: BusinessHours | Timespan; - eventDragStart?: (event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject) => void; - eventDragStop?: (event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject) => void; - eventDrop?: (event: EventObject, delta: moment.Duration, revertFunc: Function, jsEvent: Event, ui: any, view: ViewObject) => void; - eventResizeStart?: (event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject) => void; - eventResizeStop?: (event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject) => void; - eventResize?: (event: EventObject, delta: moment.Duration, revertFunc: Function, jsEvent: Event, ui: any, view: ViewObject) => void; + eventDragStart?(event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject): void; + eventDragStop?(event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject): void; + eventDrop?(event: EventObject, delta: moment.Duration, revertFunc: Function, jsEvent: Event, ui: any, view: ViewObject): void; + eventResizeStart?(event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject): void; + eventResizeStop?(event: EventObject, jsEvent: MouseEvent, ui: any, view: ViewObject): void; + eventResize?(event: EventObject, delta: moment.Duration, revertFunc: Function, jsEvent: Event, ui: any, view: ViewObject): void; } /* * Selection - http://arshaw.com/fullcalendar/docs/selection/ @@ -210,15 +210,15 @@ declare global { unselectCancel?: string; selectOverlap?: boolean | ((event: EventObject) => boolean); selectConstraint?: Timespan | BusinessHours; - select?: (start: moment.Moment, end: moment.Moment, jsEvent: MouseEvent, view: ViewObject, resource?: any) => void; - unselect?: (view: ViewObject, jsEvent: Event) => void; + select?(start: moment.Moment, end: moment.Moment, jsEvent: MouseEvent, view: ViewObject, resource?: any): void; + unselect?(view: ViewObject, jsEvent: Event): void; } interface DroppingExternalElementsOptions { droppable?: boolean; dropAccept?: string | ((draggable: any) => boolean); - drop?: (date: moment.Moment, jsEvent: MouseEvent, ui: any) => void; - eventReceive?: (event: EventObject) => void; + drop?(date: moment.Moment, jsEvent: MouseEvent, ui: any): void; + eventReceive?(event: EventObject): void; } interface ButtonTextObject { diff --git a/types/google.analytics/index.d.ts b/types/google.analytics/index.d.ts index c8bf91fd74..088ce364e1 100644 --- a/types/google.analytics/index.d.ts +++ b/types/google.analytics/index.d.ts @@ -292,7 +292,7 @@ declare namespace UniversalAnalytics { expVar?: string; flashVersion?: string; forceSSL?: boolean; - hitCallback?: () => void; + hitCallback?(): void; hitType?: string; hostname?: string; id?: string; diff --git a/types/handsontable/index.d.ts b/types/handsontable/index.d.ts index ed2f0db27f..ea57730f93 100644 --- a/types/handsontable/index.d.ts +++ b/types/handsontable/index.d.ts @@ -122,90 +122,90 @@ declare namespace ht { visibleRows?: number; width?: number|Function; wordWrap?: boolean; - isEmptyCol?: (col: number) => boolean; - isEmptyRow?: (row: number) => boolean; + isEmptyCol?(col: number): boolean; + isEmptyRow?(row: number): boolean; // hooks - afterAutofillApplyValues?: (startArea: any[], entireArea: any[]) => void; - afterCellMetaReset?: () => void; - afterChange?: (changes: any[], source: string) => void; - afterChangesObserved?: () => void; - afterColumnMove?: (startColumn: number, endColumn: number) => void; - afterColumnResize?: (currentColumn: number, newSize: number, isDoubleClick: boolean) => void; - afterColumnSort?: (column: number, order: boolean) => void; - afterContextMenuDefaultOptions?: (predefinedItems: any[]) => void; - afterContextMenuHide?: (context: Object) => void; - afterContextMenuShow?: (context: Object) => void; - afterCopyLimit?: (selectedRows: number, selectedColumnds: number, copyRowsLimit: number, copyColumnsLimit: number) => void; - afterCreateCol?: (index: number, amount: number) => void; - afterCreateRow?: (index: number, amount: number) => void; - afterDeselect?: () => void; - afterDestroy?: () => void; - afterDocumentKeyDown?: (event: Event) => void; - afterFilter?: (formulasStack: any[]) => void; - afterGetCellMeta?: (row: number, col: number, cellProperties: Object) => void; - afterGetColHeader?: (col: number, TH: Element) => void; - afterGetColumnHeaderRenderers?: (array: any[]) => void; - afterGetRowHeader?: (row: number, TH: Element) => void; - afterGetRowHeaderRenderers?: (array: any[]) => void; - afterInit?: () => void; - afterLoadData?: (firstTime: boolean) => void; - afterMomentumScroll?: () => void; - afterOnCellCornerMouseDown?: (event: Object) => void; - afterOnCellMouseDown?: (event: Object, coords: Object, TD: Element) => void; - afterOnCellMouseOver?: (event: Object, coords: Object, TD: Element) => void; - afterRemoveCol?: (index: number, amount: number) => void; - afterRemoveRow?: (index: number, amount: number) => void; - afterRender?: (isForced: boolean) => void; - afterRenderer?: (TD: Element, row: number, col: number, prop: string|number, value: string, cellProperties: Object) => void; - afterRowMove?: (startRow: number, endRow: number) => void; - afterRowResize?: (currentRow: number, newSize: number, isDoubleClick: boolean) => void; - afterScrollHorizontally?: () => void; - afterScrollVertically?: () => void; - afterSelection?: (r: number, c: number, r2: number, c2: number) => void; - afterSelectionByProp?: (r: number, p: string, r2: number, p2: string) => void; - afterSelectionEnd?: (r: number, c: number, r2: number, c2: number) => void; - afterSelectionEndByProp?: (r: number, p: string, r2: number, p2: string) => void; - afterSetCellMeta?: (row: number, col: number, key: string, value: any) => void; - afterUpdateSettings?: () => void; - afterValidate?: (isValid: boolean, value: any, row: number, prop: string|number, source: string) => void|boolean; - beforeAutofill?: (start: Object, end: Object, data: any[]) => void; - beforeCellAlignment?: (stateBefore: any, range: any, type: string, alignmentClass: string) => void; - beforeChange?: (changes: any[], source: string) => void; - beforeChangeRender?: (changes: any[], source: string) => void; - beforeColumnMove?: (startColumn: number, endColumn: number) => void; - beforeColumnResize?: (currentColumn: number, newSize: number, isDoubleClick: boolean) => void; - beforeColumnSort?: (column: number, order: boolean) => void; - beforeDrawBorders?: (corners: any[], borderClassName: string) => void; - beforeFilter?: (formulasStack: any[]) => void; - beforeGetCellMeta?: (row: number, col: number, cellProperties: Object) => void; - beforeInit?: () => void; - beforeInitWalkontable?: (walkontableConfig: Object) => void; - beforeKeyDown?: (event: Event) => void; - beforeOnCellMouseDown?: (event: Event, coords: Object, TD: Element) => void; - beforeRemoveCol?: (index: number, amount: number, logicalCols?: any[]) => void; - beforeRemoveRow?: (index: number, amount: number, logicalRows?: any[]) => void; - beforeRender?: (isForced: boolean) => void; - beforeRenderer?: (TD: Element, row: number, col: number, prop: string|number, value: string, cellProperties: Object) => void; - beforeRowMove?: (startRow: number, endRow: number) => void; - beforeRowResize?: (currentRow: number, newSize: number, isDoubleClick: boolean) => any; - beforeSetRangeEnd?: (coords: any[]) => void; - beforeStretchingColumnWidth?: (stretchedWidth: number, column: number) => void; - beforeTouchScroll?: () => void; - beforeValidate?: (value: any, row: number, prop: string|number, source: string) => void; - construct?: () => void; - init?: () => void; - modifyCol?: (col: number) => void; - modifyColHeader?: (column: number) => void; - modifyColWidth?: (width: number, col: number) => void; - modifyCopyableRange?: (copyableRanges: any[]) => void; - modifyRow?: (row: number) => void; - modifyRowHeader?: (row: number) => void; - modifyRowHeight?: (height: number, row: number) => void; - persistentStateLoad?: (key: string, valuePlaceholder: Object) => void; - persistentStateReset?: (key: string) => void; - persistentStateSave?: (key: string, value: any) => void; - unmodifyCol?: (col: number) => void; + afterAutofillApplyValues?(startArea: any[], entireArea: any[]): void; + afterCellMetaReset?(): void; + afterChange?(changes: any[], source: string): void; + afterChangesObserved?(): void; + afterColumnMove?(startColumn: number, endColumn: number): void; + afterColumnResize?(currentColumn: number, newSize: number, isDoubleClick: boolean): void; + afterColumnSort?(column: number, order: boolean): void; + afterContextMenuDefaultOptions?(predefinedItems: any[]): void; + afterContextMenuHide?(context: Object): void; + afterContextMenuShow?(context: Object): void; + afterCopyLimit?(selectedRows: number, selectedColumnds: number, copyRowsLimit: number, copyColumnsLimit: number): void; + afterCreateCol?(index: number, amount: number): void; + afterCreateRow?(index: number, amount: number): void; + afterDeselect?(): void; + afterDestroy?(): void; + afterDocumentKeyDown?(event: Event): void; + afterFilter?(formulasStack: any[]): void; + afterGetCellMeta?(row: number, col: number, cellProperties: Object): void; + afterGetColHeader?(col: number, TH: Element): void; + afterGetColumnHeaderRenderers?(array: any[]): void; + afterGetRowHeader?(row: number, TH: Element): void; + afterGetRowHeaderRenderers?(array: any[]): void; + afterInit?(): void; + afterLoadData?(firstTime: boolean): void; + afterMomentumScroll?(): void; + afterOnCellCornerMouseDown?(event: Object): void; + afterOnCellMouseDown?(event: Object, coords: Object, TD: Element): void; + afterOnCellMouseOver?(event: Object, coords: Object, TD: Element): void; + afterRemoveCol?(index: number, amount: number): void; + afterRemoveRow?(index: number, amount: number): void; + afterRender?(isForced: boolean): void; + afterRenderer?(TD: Element, row: number, col: number, prop: string|number, value: string, cellProperties: Object): void; + afterRowMove?(startRow: number, endRow: number): void; + afterRowResize?(currentRow: number, newSize: number, isDoubleClick: boolean): void; + afterScrollHorizontally?(): void; + afterScrollVertically?(): void; + afterSelection?(r: number, c: number, r2: number, c2: number): void; + afterSelectionByProp?(r: number, p: string, r2: number, p2: string): void; + afterSelectionEnd?(r: number, c: number, r2: number, c2: number): void; + afterSelectionEndByProp?(r: number, p: string, r2: number, p2: string): void; + afterSetCellMeta?(row: number, col: number, key: string, value: any): void; + afterUpdateSettings?(): void; + afterValidate?(isValid: boolean, value: any, row: number, prop: string|number, source: string): void|boolean; + beforeAutofill?(start: Object, end: Object, data: any[]): void; + beforeCellAlignment?(stateBefore: any, range: any, type: string, alignmentClass: string): void; + beforeChange?(changes: any[], source: string): void; + beforeChangeRender?(changes: any[], source: string): void; + beforeColumnMove?(startColumn: number, endColumn: number): void; + beforeColumnResize?(currentColumn: number, newSize: number, isDoubleClick: boolean): void; + beforeColumnSort?(column: number, order: boolean): void; + beforeDrawBorders?(corners: any[], borderClassName: string): void; + beforeFilter?(formulasStack: any[]): void; + beforeGetCellMeta?(row: number, col: number, cellProperties: Object): void; + beforeInit?(): void; + beforeInitWalkontable?(walkontableConfig: Object): void; + beforeKeyDown?(event: Event): void; + beforeOnCellMouseDown?(event: Event, coords: Object, TD: Element): void; + beforeRemoveCol?(index: number, amount: number, logicalCols?: any[]): void; + beforeRemoveRow?(index: number, amount: number, logicalRows?: any[]): void; + beforeRender?(isForced: boolean): void; + beforeRenderer?(TD: Element, row: number, col: number, prop: string|number, value: string, cellProperties: Object): void; + beforeRowMove?(startRow: number, endRow: number): void; + beforeRowResize?(currentRow: number, newSize: number, isDoubleClick: boolean): any; + beforeSetRangeEnd?(coords: any[]): void; + beforeStretchingColumnWidth?(stretchedWidth: number, column: number): void; + beforeTouchScroll?(): void; + beforeValidate?(value: any, row: number, prop: string|number, source: string): void; + construct?(): void; + init?(): void; + modifyCol?(col: number): void; + modifyColHeader?(column: number): void; + modifyColWidth?(width: number, col: number): void; + modifyCopyableRange?(copyableRanges: any[]): void; + modifyRow?(row: number): void; + modifyRowHeader?(row: number): void; + modifyRowHeight?(height: number, row: number): void; + persistentStateLoad?(key: string, valuePlaceholder: Object): void; + persistentStateReset?(key: string): void; + persistentStateSave?(key: string, value: any): void; + unmodifyCol?(col: number): void; } interface Methods { addHook(key: string, callback: Function|any[]): void; diff --git a/types/jasmine-ajax/index.d.ts b/types/jasmine-ajax/index.d.ts index 4e227add1b..4762ba085a 100644 --- a/types/jasmine-ajax/index.d.ts +++ b/types/jasmine-ajax/index.d.ts @@ -21,7 +21,7 @@ interface JasmineAjaxRequest extends XMLHttpRequest { password: string; requestHeaders: { [key: string]: string }; overriddenMimeType: string; - data: () => string; + data(): string; respondWith(response: JasmineAjaxResponse): void; } diff --git a/types/js-data-http/index.d.ts b/types/js-data-http/index.d.ts index 2a2fafcedb..62a2c1e25b 100644 --- a/types/js-data-http/index.d.ts +++ b/types/js-data-http/index.d.ts @@ -7,9 +7,9 @@ import * as JSData from 'js-data'; declare module 'js-data' { interface DSHttpAdapterOptions { - serialize?: (resourceName: string, data: any) => any; - deserialize?: (resourceName: string, data: any) => any; - queryTransform?: (resourceName: string, params: DSFilterParams) => any; + serialize?(resourceName: string, data: any): any; + deserialize?(resourceName: string, data: any): any; + queryTransform?(resourceName: string, params: DSFilterParams): any; httpConfig?: any; forceTrailingSlash?: boolean; log?: boolean | ((message?: any, ...optionalParams: any[]) => void); diff --git a/types/jui-grid/index.d.ts b/types/jui-grid/index.d.ts index 31b3ca2b51..8ced2164e4 100644 --- a/types/jui-grid/index.d.ts +++ b/types/jui-grid/index.d.ts @@ -71,7 +71,7 @@ export interface GridRow { type: "open"|"fold"; /** @property {Function} [type="null"] State value that indicates whether a child row is shown or hidden. */ - tpl?: () => void; + tpl?(): void; setIndex(rownum: number|string): void; reload(columns: GridColumn[], seq: any, xssFilter: any): void; diff --git a/types/koa-views/index.d.ts b/types/koa-views/index.d.ts index 5d9d88b647..c06be87dfb 100644 --- a/types/koa-views/index.d.ts +++ b/types/koa-views/index.d.ts @@ -23,11 +23,9 @@ =============================================== */ - import * as Koa from "koa"; declare function views(dir: string, opts?: { - /* * default extension for your views */ @@ -44,13 +42,11 @@ declare function views(dir: string, opts?: { * replace consolidate as default engine source */ engineSource?: any, - }): Koa.Middleware; declare namespace views { } export = views; - import * as koa from "koa"; declare module 'koa' { diff --git a/types/koa-views/koa-views-tests.ts b/types/koa-views/koa-views-tests.ts index f025f55d93..65d6be7e1f 100644 --- a/types/koa-views/koa-views-tests.ts +++ b/types/koa-views/koa-views-tests.ts @@ -16,4 +16,4 @@ app.use((ctx: Koa.Context) => { ctx.render('user', { user: 'John' }).then(() => console.log('done render call')); -}); \ No newline at end of file +}); diff --git a/types/mapbox/index.d.ts b/types/mapbox/index.d.ts index d3ab08dedd..87a34e4823 100644 --- a/types/mapbox/index.d.ts +++ b/types/mapbox/index.d.ts @@ -113,7 +113,7 @@ declare global { interface FeatureLayerOptions { filter?: FilterFunction; - sanitizer?: (template: string) => string; + sanitizer?(template: string): string; } interface FeatureLayer extends Leaflet.FeatureGroup { @@ -187,7 +187,7 @@ declare global { ////////////////////////////////////////////////////////////////////// interface ControlOptions extends Leaflet.ControlOptions { - sanitizer?: (template: string) => string; + sanitizer?(template: string): string; } // InfoControl diff --git a/types/pixi.js/tslint.json b/types/pixi.js/tslint.json index 136166583e..bb288627d0 100644 --- a/types/pixi.js/tslint.json +++ b/types/pixi.js/tslint.json @@ -3,6 +3,7 @@ "rules": { "ban-types": false, "interface-name": false, + "no-empty-interface": false, "no-single-declare-module": false, "unified-signatures": false, diff --git a/types/qlik-visualizationextensions/index.d.ts b/types/qlik-visualizationextensions/index.d.ts index 97ffca8733..4a4a635e4f 100644 --- a/types/qlik-visualizationextensions/index.d.ts +++ b/types/qlik-visualizationextensions/index.d.ts @@ -2265,7 +2265,7 @@ declare namespace ExtensionAPI { interface IExtension { definition?: IDefinition; - paint?: ($element: HTMLElement, layout?: any) => void; + paint?($element: HTMLElement, layout?: any): void; initialProperties?: IInitialProperties; template?: string; controller?: any; diff --git a/types/rx-lite-async/rx-lite-async-tests.ts b/types/rx-lite-async/rx-lite-async-tests.ts index 8c88cc135c..43c5155e2f 100644 --- a/types/rx-lite-async/rx-lite-async-tests.ts +++ b/types/rx-lite-async/rx-lite-async-tests.ts @@ -1,27 +1,24 @@ // Tests for RxJS-Async TypeScript definitions // Tests by Igor Oleinikov -namespace Rx.Tests.Async { +let obsNum: Rx.Observable; +let obsStr: Rx.Observable; +let sch: Rx.IScheduler; - var obsNum: Rx.Observable; - var obsStr: Rx.Observable; - var sch: Rx.IScheduler; +function start() { + obsNum = Rx.Observable.start(() => 10, obsStr, sch); + obsNum = Rx.Observable.start(() => 10, obsStr); + obsNum = Rx.Observable.start(() => 10); +} - function start() { - obsNum = Rx.Observable.start(() => 10, obsStr, sch); - obsNum = Rx.Observable.start(() => 10, obsStr); - obsNum = Rx.Observable.start(() => 10); - } +function toAsync() { + obsNum = Rx.Observable.toAsync(() => 1, sch)(); + obsNum = Rx.Observable.toAsync((a1: number) => a1)(1); + obsStr = Rx.Observable.toAsync((a1: string, a2: number) => a1 + a2.toFixed(0))("", 1); + obsStr = Rx.Observable.toAsync((a1: string, a2: number, a3: Date) => a1 + a2.toFixed(0) + a3.toDateString())("", 1, new Date()); + obsStr = Rx.Observable.toAsync((a1: string, a2: number, a3: Date, a4: boolean) => a1 + a2.toFixed(0) + a3.toDateString() + (a4 ? 1 : 0))("", 1, new Date(), false); +} - function toAsync() { - obsNum = Rx.Observable.toAsync(() => 1, sch)(); - obsNum = Rx.Observable.toAsync((a1: number) => a1)(1); - obsStr = Rx.Observable.toAsync((a1: string, a2: number) => a1 + a2.toFixed(0))("", 1); - obsStr = Rx.Observable.toAsync((a1: string, a2: number, a3: Date) => a1 + a2.toFixed(0) + a3.toDateString())("", 1, new Date()); - obsStr = Rx.Observable.toAsync((a1: string, a2: number, a3: Date, a4: boolean) => a1 + a2.toFixed(0) + a3.toDateString() + (a4 ? 1 : 0))("", 1, new Date(), false); - } - - function startAsync() { - var o: Rx.Observable = Rx.Observable.startAsync(() => > {}); - } +function startAsync() { + const o: Rx.Observable = Rx.Observable.startAsync(() => > {}); } diff --git a/types/rx-lite-coincidence/index.d.ts b/types/rx-lite-coincidence/index.d.ts index 0361d025c2..3dc9f4c1be 100644 --- a/types/rx-lite-coincidence/index.d.ts +++ b/types/rx-lite-coincidence/index.d.ts @@ -6,7 +6,6 @@ /// declare namespace Rx { - interface Observable { join( right: Observable, diff --git a/types/rx-lite-experimental/index.d.ts b/types/rx-lite-experimental/index.d.ts index 9659d9fec6..d9c5ad3ac0 100644 --- a/types/rx-lite-experimental/index.d.ts +++ b/types/rx-lite-experimental/index.d.ts @@ -6,7 +6,6 @@ /// declare namespace Rx { - interface Observable { /** * Returns an observable sequence that is the result of invoking the selector on the source sequence, without sharing subscriptions. diff --git a/types/rx-lite-joinpatterns/index.d.ts b/types/rx-lite-joinpatterns/index.d.ts index 658c93d1a4..5e9b9d24b4 100644 --- a/types/rx-lite-joinpatterns/index.d.ts +++ b/types/rx-lite-joinpatterns/index.d.ts @@ -6,7 +6,6 @@ /// declare namespace Rx { - interface Pattern1 { and(other: Observable): Pattern2; thenDo(selector: (item1: T1) => TR): Plan; diff --git a/types/tslint.json b/types/tslint.json index 6602359a97..36eac22f51 100644 --- a/types/tslint.json +++ b/types/tslint.json @@ -1 +1,7 @@ -{ "extends": "dtslint/dtslint.json" } \ No newline at end of file +{ + "extends": "dtslint/dtslint.json", + "rules": { + // https://github.com/palantir/tslint/pull/2391 + "prefer-const": false + } +} From 1aff76c069b7711ac46eb440f805a86ec42bb60f Mon Sep 17 00:00:00 2001 From: Andy Date: Wed, 29 Mar 2017 14:50:51 -0700 Subject: [PATCH 054/844] vinyl-fs: Lint (#15489) --- types/vinyl-fs/index.d.ts | 17 +- types/vinyl-fs/vinyl-fs-tests.ts | 440 +++++++++++++++---------------- 2 files changed, 225 insertions(+), 232 deletions(-) diff --git a/types/vinyl-fs/index.d.ts b/types/vinyl-fs/index.d.ts index 52aa5cd506..84bcaf3533 100644 --- a/types/vinyl-fs/index.d.ts +++ b/types/vinyl-fs/index.d.ts @@ -101,7 +101,7 @@ interface SrcOptions extends globStream.Options { * fs.src(['!b*.js', '*.js']) would not exclude any files, but this would: fs.src(['*.js', '!b*.js']) * @param opt Options Vinyl source options, changes the way the files are read, found, or stored in the vinyl stream */ -declare function src(globs: string|string[], opt?: SrcOptions): NodeJS.ReadWriteStream; +export function src(globs: string|string[], opt?: SrcOptions): NodeJS.ReadWriteStream; /** * This is just a glob-watcher @@ -110,7 +110,7 @@ declare function src(globs: string|string[], opt?: SrcOptions): NodeJS.ReadWrite * Globs are executed in order, so negations should follow positive globs * fs.src(['!b*.js', '*.js']) would not exclude any files, but this would: fs.src(['*.js', '!b*.js']) */ -declare function watch(globs: string|string[], cb?: (outEvt: { type: any; path: any; old: any; }) => void): _events.EventEmitter; +export function watch(globs: string|string[], cb?: (outEvt: { type: any; path: any; old: any; }) => void): _events.EventEmitter; /** * This is just a glob-watcher @@ -119,13 +119,13 @@ declare function watch(globs: string|string[], cb?: (outEvt: { type: any; path: * Globs are executed in order, so negations should follow positive globs * fs.src(['!b*.js', '*.js']) would not exclude any files, but this would: fs.src(['*.js', '!b*.js']) */ -declare function watch( +export function watch( globs: string|string[], opt?: { interval?: number; debounceDelay?: number; cwd?: string; - maxListeners?: () => number; + maxListeners?(): number; }, cb?: (outEvt: { type: any; path: any; old: any; }) => void): _events.EventEmitter; @@ -138,7 +138,7 @@ declare function watch( * contents will have it's position reset to the beginning if it is a stream * @param folder destination folder */ -declare function dest(folder: string, opt?: { +export function dest(folder: string, opt?: { /** Specify the working directory the folder is relative to * Default is process.cwd() */ @@ -166,7 +166,7 @@ declare function dest(folder: string, opt?: { * contents will have it's position reset to the beginning if it is a stream * @param getFolderPath function that takes in a file and returns a folder path */ -declare function dest(getFolderPath: (file: File) => string): NodeJS.ReadWriteStream; +export function dest(getFolderPath: (file: File) => string): NodeJS.ReadWriteStream; /** * On write the stream will create a symbolic link (i.e. symlink) on disk at the folder/cwd specified. @@ -174,7 +174,7 @@ declare function dest(getFolderPath: (file: File) => string): NodeJS.ReadWriteSt * The file will be modified after being written to this stream: * cwd, base, and path will be overwritten to match the folder */ -declare function symlink(folder: string, opts?: { +export function symlink(folder: string, opts?: { /** * Specify the working directory the folder is relative to * Default is process.cwd() @@ -197,7 +197,7 @@ declare function symlink(folder: string, opts?: { * The file will be modified after being written to this stream: * cwd, base, and path will be overwritten to match the folder */ -declare function symlink(getFolderPath: (File: File) => string, opts?: +export function symlink(getFolderPath: (File: File) => string, opts?: { /** * Specify the working directory the folder is relative to @@ -210,5 +210,4 @@ declare function symlink(getFolderPath: (File: File) => string, opts?: * Default is the process mode */ dirMode?: number - }): NodeJS.ReadWriteStream; diff --git a/types/vinyl-fs/vinyl-fs-tests.ts b/types/vinyl-fs/vinyl-fs-tests.ts index 33d031f521..38585422c8 100644 --- a/types/vinyl-fs/vinyl-fs-tests.ts +++ b/types/vinyl-fs/vinyl-fs-tests.ts @@ -6,20 +6,20 @@ import * as path from 'path'; import * as fs from 'fs'; // require('graceful-fs'); // import bufEqual = require('buffer-equal'); -declare var bufEqual: any; +declare const bufEqual: any; // import through = require('through2'); -declare var through: any; +declare const through: any; import File = require('vinyl'); -// var spies = require('./spy'); -declare var spies: any; +// const spies = require('./spy'); +declare const spies: any; import * as should from 'should'; import 'mocha'; -declare var gulp: any; -declare var bufferStream: any; +declare const gulp: any; +let bufferStream: any; -var dataWrap = (fn: any) => { +let dataWrap = (fn: any) => { return (data: any, enc: any, cb: any) => { fn(data); cb(); @@ -27,9 +27,8 @@ var dataWrap = (fn: any) => { }; describe('source stream', () => { - it('should explode on invalid glob (empty)', done => { - var stream: any; + let stream: any; try { stream = gulp.src(); } catch (err) { @@ -40,7 +39,7 @@ describe('source stream', () => { }); it('should explode on invalid glob (number)', done => { - var stream: any; + let stream: any; try { stream = gulp.src(123); } catch (err) { @@ -51,7 +50,7 @@ describe('source stream', () => { }); it('should explode on invalid glob (empty array)', done => { - var stream: any; + let stream: any; try { stream = gulp.src([]); } catch (err) { @@ -62,26 +61,26 @@ describe('source stream', () => { }); it('should pass through writes', done => { - var expectedPath = path.join(__dirname, "./fixtures/test.coffee"); - var expectedContent = fs.readFileSync(expectedPath); + const expectedPath = path.join(__dirname, "./fixtures/test.coffee"); + const expectedContent = fs.readFileSync(expectedPath); - var expectedFile = new File({ + const expectedFile = new File({ base: __dirname, cwd: __dirname, path: expectedPath, contents: expectedContent }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); bufEqual(buffered[0].contents, expectedContent).should.equal(true); done(); }; - var stream = vfs.src("./fixtures/nothing.coffee"); + const stream = vfs.src("./fixtures/nothing.coffee"); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -89,10 +88,10 @@ describe('source stream', () => { }); it('should glob a file with default settings', done => { - var expectedPath = path.join(__dirname, "./fixtures/test.coffee"); - var expectedContent = fs.readFileSync(expectedPath); + const expectedPath = path.join(__dirname, "./fixtures/test.coffee"); + const expectedContent = fs.readFileSync(expectedPath); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); should.exist(buffered[0].stat); buffered[0].path.should.equal(expectedPath); @@ -101,18 +100,18 @@ describe('source stream', () => { done(); }; - var stream = vfs.src("./fixtures/*.coffee", { cwd: __dirname }); + const stream = vfs.src("./fixtures/*.coffee", { cwd: __dirname }); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); }); it('should glob a file with default settings and relative cwd', done => { - var expectedPath = path.join(__dirname, "./fixtures/test.coffee"); - var expectedContent = fs.readFileSync(expectedPath); + const expectedPath = path.join(__dirname, "./fixtures/test.coffee"); + const expectedContent = fs.readFileSync(expectedPath); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); should.exist(buffered[0].stat); buffered[0].path.should.equal(expectedPath); @@ -121,17 +120,17 @@ describe('source stream', () => { done(); }; - var stream = vfs.src("./fixtures/*.coffee", { cwd: path.relative(process.cwd(), __dirname) }); + const stream = vfs.src("./fixtures/*.coffee", { cwd: path.relative(process.cwd(), __dirname) }); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); }); it('should glob a directory with default settings', done => { - var expectedPath = path.join(__dirname, "./fixtures/wow"); + const expectedPath = path.join(__dirname, "./fixtures/wow"); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].path.should.equal(expectedPath); buffered[0].isNull().should.equal(true); @@ -139,18 +138,18 @@ describe('source stream', () => { done(); }; - var stream = vfs.src("./fixtures/wow/", { cwd: __dirname }); + const stream = vfs.src("./fixtures/wow/", { cwd: __dirname }); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); }); it('should glob a file with with no contents', done => { - var expectedPath = path.join(__dirname, "./fixtures/test.coffee"); - var expectedContent = fs.readFileSync(expectedPath); + const expectedPath = path.join(__dirname, "./fixtures/test.coffee"); + const expectedContent = fs.readFileSync(expectedPath); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].path.should.equal(expectedPath); buffered[0].isNull().should.equal(true); @@ -158,25 +157,25 @@ describe('source stream', () => { done(); }; - var stream = vfs.src("./fixtures/*.coffee", { cwd: __dirname, read: false }); + const stream = vfs.src("./fixtures/*.coffee", { cwd: __dirname, read: false }); - var buffered: any = []; + const buffered: any = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); }); it('should glob a file with streaming contents', done => { - var expectedPath = path.join(__dirname, "./fixtures/test.coffee"); - var expectedContent = fs.readFileSync(expectedPath); + const expectedPath = path.join(__dirname, "./fixtures/test.coffee"); + const expectedContent = fs.readFileSync(expectedPath); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); should.exist(buffered[0].stat); buffered[0].path.should.equal(expectedPath); buffered[0].isStream().should.equal(true); - var contentBuffer = new Buffer([]); - var contentBufferStream = through(dataWrap((data: any) => { + let contentBuffer = new Buffer([]); + const contentBufferStream = through(dataWrap((data: any) => { contentBuffer = Buffer.concat([contentBuffer, data]); })); buffered[0].contents.pipe(contentBufferStream); @@ -186,41 +185,40 @@ describe('source stream', () => { }); }; - var stream = vfs.src("./fixtures/*.coffee", { cwd: __dirname, buffer: false }); + const stream = vfs.src("./fixtures/*.coffee", { cwd: __dirname, buffer: false }); - var buffered: any = []; + const buffered: any = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); }); - }); // from dest -// var vfs = require('../'); +// const vfs = require('../'); -// var path = require('path'); -// var fs = require('graceful-fs'); +// const path = require('path'); +// const fs = require('graceful-fs'); import rimraf = require('rimraf'); -// var bufEqual = require('buffer-equal'); -// var through = require('through2'); -// var File = require('vinyl'); +// const bufEqual = require('buffer-equal'); +// const through = require('through2'); +// const File = require('vinyl'); -// var should = require('should'); +// const should = require('should'); // require('mocha'); -var wipeOut = (cb: any) => { +let wipeOut = (cb: any) => { rimraf(path.join(__dirname, "./out-fixtures/"), cb); }; -var dataWrap = (fn: any) => { +dataWrap = (fn: any) => { return (data: any, enc: any, cb: any) => { fn(data); cb(); }; }; -var realMode = (n: any) => { +let realMode = (n: any) => { return n & parseInt("07777", 8); }; @@ -229,7 +227,7 @@ describe('dest stream', () => { afterEach(wipeOut); it('should explode on invalid folder', done => { - var stream: any; + let stream: any; try { stream = gulp.dest(); } catch (err) { @@ -240,24 +238,24 @@ describe('dest stream', () => { }); it('should pass through writes with cwd', done => { - var inputPath = path.join(__dirname, "./fixtures/test.coffee"); + const inputPath = path.join(__dirname, "./fixtures/test.coffee"); - var expectedFile = new File({ + const expectedFile = new File({ base: __dirname, cwd: __dirname, path: inputPath, contents: null }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); done(); }; - var stream = vfs.dest("./out-fixtures/", { cwd: __dirname }); + const stream = vfs.dest("./out-fixtures/", { cwd: __dirname }); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -265,24 +263,24 @@ describe('dest stream', () => { }); it('should pass through writes with default cwd', done => { - var inputPath = path.join(__dirname, "./fixtures/test.coffee"); + const inputPath = path.join(__dirname, "./fixtures/test.coffee"); - var expectedFile = new File({ + const expectedFile = new File({ base: __dirname, cwd: __dirname, path: inputPath, contents: null }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); done(); }; - var stream = vfs.dest(path.join(__dirname, "./out-fixtures/")); + const stream = vfs.dest(path.join(__dirname, "./out-fixtures/")); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -290,20 +288,20 @@ describe('dest stream', () => { }); it('should not write null files', done => { - var inputPath = path.join(__dirname, "./fixtures/test.coffee"); - var inputBase = path.join(__dirname, "./fixtures/"); - var expectedPath = path.join(__dirname, "./out-fixtures/test.coffee"); - var expectedCwd = __dirname; - var expectedBase = path.join(__dirname, "./out-fixtures"); + const inputPath = path.join(__dirname, "./fixtures/test.coffee"); + const inputBase = path.join(__dirname, "./fixtures/"); + const expectedPath = path.join(__dirname, "./out-fixtures/test.coffee"); + const expectedCwd = __dirname; + const expectedBase = path.join(__dirname, "./out-fixtures"); - var expectedFile = new File({ + const expectedFile = new File({ base: inputBase, cwd: __dirname, path: inputPath, contents: null }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); buffered[0].cwd.should.equal(expectedCwd, 'cwd should have changed'); @@ -313,9 +311,9 @@ describe('dest stream', () => { done(); }; - var stream = vfs.dest("./out-fixtures/", { cwd: __dirname }); + const stream = vfs.dest("./out-fixtures/", { cwd: __dirname }); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -323,21 +321,21 @@ describe('dest stream', () => { }); it('should write buffer files to the right folder with relative cwd', done => { - var inputPath = path.join(__dirname, "./fixtures/test.coffee"); - var inputBase = path.join(__dirname, "./fixtures/"); - var expectedPath = path.join(__dirname, "./out-fixtures/test.coffee"); - var expectedCwd = __dirname; - var expectedBase = path.join(__dirname, "./out-fixtures"); - var expectedContents = fs.readFileSync(inputPath); + const inputPath = path.join(__dirname, "./fixtures/test.coffee"); + const inputBase = path.join(__dirname, "./fixtures/"); + const expectedPath = path.join(__dirname, "./out-fixtures/test.coffee"); + const expectedCwd = __dirname; + const expectedBase = path.join(__dirname, "./out-fixtures"); + const expectedContents = fs.readFileSync(inputPath); - var expectedFile = new File({ + const expectedFile = new File({ base: inputBase, cwd: __dirname, path: inputPath, contents: expectedContents }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); buffered[0].cwd.should.equal(expectedCwd, 'cwd should have changed'); @@ -348,9 +346,9 @@ describe('dest stream', () => { done(); }; - var stream = vfs.dest("./out-fixtures/", { cwd: path.relative(process.cwd(), __dirname) }); + const stream = vfs.dest("./out-fixtures/", { cwd: path.relative(process.cwd(), __dirname) }); - var buffered: any = []; + const buffered: any = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -358,15 +356,15 @@ describe('dest stream', () => { }); it('should write buffer files to the right folder', done => { - var inputPath = path.join(__dirname, "./fixtures/test.coffee"); - var inputBase = path.join(__dirname, "./fixtures/"); - var expectedPath = path.join(__dirname, "./out-fixtures/test.coffee"); - var expectedContents = fs.readFileSync(inputPath); - var expectedCwd = __dirname; - var expectedBase = path.join(__dirname, "./out-fixtures"); - var expectedMode = parseInt("0655", 8); + const inputPath = path.join(__dirname, "./fixtures/test.coffee"); + const inputBase = path.join(__dirname, "./fixtures/"); + const expectedPath = path.join(__dirname, "./out-fixtures/test.coffee"); + const expectedContents = fs.readFileSync(inputPath); + const expectedCwd = __dirname; + const expectedBase = path.join(__dirname, "./out-fixtures"); + const expectedMode = parseInt("0655", 8); - var expectedFile = new File({ + const expectedFile = new File({ base: inputBase, cwd: __dirname, path: inputPath, @@ -376,7 +374,7 @@ describe('dest stream', () => { } }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); buffered[0].cwd.should.equal(expectedCwd, 'cwd should have changed'); @@ -388,9 +386,9 @@ describe('dest stream', () => { done(); }; - var stream = vfs.dest("./out-fixtures/", { cwd: __dirname }); + const stream = vfs.dest("./out-fixtures/", { cwd: __dirname }); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -398,16 +396,16 @@ describe('dest stream', () => { }); it('should write streaming files to the right folder', done => { - var inputPath = path.join(__dirname, "./fixtures/test.coffee"); - var inputBase = path.join(__dirname, "./fixtures/"); - var expectedPath = path.join(__dirname, "./out-fixtures/test.coffee"); - var expectedContents = fs.readFileSync(inputPath); - var expectedCwd = __dirname; - var expectedBase = path.join(__dirname, "./out-fixtures"); - var expectedMode = parseInt("0655", 8); + const inputPath = path.join(__dirname, "./fixtures/test.coffee"); + const inputBase = path.join(__dirname, "./fixtures/"); + const expectedPath = path.join(__dirname, "./out-fixtures/test.coffee"); + const expectedContents = fs.readFileSync(inputPath); + const expectedCwd = __dirname; + const expectedBase = path.join(__dirname, "./out-fixtures"); + const expectedMode = parseInt("0655", 8); - var contentStream = through.obj(); - var expectedFile = new File({ + const contentStream = through.obj(); + const expectedFile = new File({ base: inputBase, cwd: __dirname, path: inputPath, @@ -417,7 +415,7 @@ describe('dest stream', () => { } }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); buffered[0].cwd.should.equal(expectedCwd, 'cwd should have changed'); @@ -429,9 +427,9 @@ describe('dest stream', () => { done(); }; - var stream = vfs.dest("./out-fixtures/", { cwd: __dirname }); + const stream = vfs.dest("./out-fixtures/", { cwd: __dirname }); - var buffered: any = []; + const buffered: any = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -443,14 +441,14 @@ describe('dest stream', () => { }); it('should write directories to the right folder', done => { - var inputPath = path.join(__dirname, "./fixtures/test"); - var inputBase = path.join(__dirname, "./fixtures/"); - var expectedPath = path.join(__dirname, "./out-fixtures/test"); - var expectedCwd = __dirname; - var expectedBase = path.join(__dirname, "./out-fixtures"); - var expectedMode = parseInt("0655", 8); + const inputPath = path.join(__dirname, "./fixtures/test"); + const inputBase = path.join(__dirname, "./fixtures/"); + const expectedPath = path.join(__dirname, "./out-fixtures/test"); + const expectedCwd = __dirname; + const expectedBase = path.join(__dirname, "./out-fixtures"); + const expectedMode = parseInt("0655", 8); - var expectedFile = new File({ + const expectedFile = new File({ base: inputBase, cwd: __dirname, path: inputPath, @@ -461,7 +459,7 @@ describe('dest stream', () => { } }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); buffered[0].cwd.should.equal(expectedCwd, 'cwd should have changed'); @@ -473,9 +471,9 @@ describe('dest stream', () => { done(); }; - var stream = vfs.dest("./out-fixtures/", { cwd: __dirname }); + const stream = vfs.dest("./out-fixtures/", { cwd: __dirname }); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -483,14 +481,14 @@ describe('dest stream', () => { }); it('should allow piping multiple dests in streaming mode', done => { - var inputPath1 = path.join(__dirname, "./out-fixtures/multiple-first"); - var inputPath2 = path.join(__dirname, "./out-fixtures/multiple-second"); - var inputBase = path.join(__dirname, "./out-fixtures/"); - var srcPath = path.join(__dirname, "./fixtures/test.coffee"); - var stream1 = vfs.dest('./out-fixtures/', { cwd: __dirname }); - var stream2 = vfs.dest('./out-fixtures/', { cwd: __dirname }); - var content = fs.readFileSync(srcPath); - var rename = through.obj((file: any, _: any, next: any) => { + const inputPath1 = path.join(__dirname, "./out-fixtures/multiple-first"); + const inputPath2 = path.join(__dirname, "./out-fixtures/multiple-second"); + const inputBase = path.join(__dirname, "./out-fixtures/"); + const srcPath = path.join(__dirname, "./fixtures/test.coffee"); + const stream1 = vfs.dest('./out-fixtures/', { cwd: __dirname }); + const stream2 = vfs.dest('./out-fixtures/', { cwd: __dirname }); + const content = fs.readFileSync(srcPath); + const rename = through.obj((file: any, _: any, next: any) => { file.path = inputPath2; this.push(file); next(); @@ -509,7 +507,7 @@ describe('dest stream', () => { done(); }); - var file = new File({ + const file = new File({ base: inputBase, path: inputPath1, cwd: __dirname, @@ -519,32 +517,28 @@ describe('dest stream', () => { stream1.write(file); stream1.end(); }); - }); - - // This test is from +const chmodSpy = spies.chmodSpy; +const statSpy = spies.statSpy; -var chmodSpy = spies.chmodSpy; -var statSpy = spies.statSpy; - -var wipeOut = (cb: any) => { +wipeOut = (cb: any) => { rimraf(path.join(__dirname, './out-fixtures/'), cb); spies.setError('false'); statSpy.reset(); chmodSpy.reset(); }; -var dataWrap = (fn: any) => { +dataWrap = (fn: any) => { return (data: any, enc: any, cb: any) => { fn(data); cb(); }; }; -var realMode = (n: any) => { +realMode = (n: any) => { return n & parseInt("07777", 8); }; @@ -553,7 +547,7 @@ describe('symlink stream', () => { afterEach(wipeOut); it('should explode on invalid folder', (done: any) => { - var stream: any; + let stream: any; try { stream = gulp.symlink(); } catch (err) { @@ -564,24 +558,24 @@ describe('symlink stream', () => { }); it('should pass through writes with cwd', done => { - var inputPath = path.join(__dirname, './fixtures/test.coffee'); + const inputPath = path.join(__dirname, './fixtures/test.coffee'); - var expectedFile = new File({ + const expectedFile = new File({ base: __dirname, cwd: __dirname, path: inputPath, contents: null }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); done(); }; - var stream = vfs.symlink('./out-fixtures/', { cwd: __dirname }); + const stream = vfs.symlink('./out-fixtures/', { cwd: __dirname }); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -589,24 +583,24 @@ describe('symlink stream', () => { }); it('should pass through writes with default cwd', done => { - var inputPath = path.join(__dirname, './fixtures/test.coffee'); + const inputPath = path.join(__dirname, './fixtures/test.coffee'); - var expectedFile = new File({ + const expectedFile = new File({ base: __dirname, cwd: __dirname, path: inputPath, contents: null }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); done(); }; - var stream = vfs.symlink(path.join(__dirname, './out-fixtures/')); + const stream = vfs.symlink(path.join(__dirname, './out-fixtures/')); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -614,21 +608,21 @@ describe('symlink stream', () => { }); it('should make link to the right folder with relative cwd', done => { - var inputPath = path.join(__dirname, './fixtures/test.coffee'); - var inputBase = path.join(__dirname, './fixtures/'); - var expectedPath = path.join(__dirname, './out-fixtures/test.coffee'); - var expectedCwd = __dirname; - var expectedBase = path.join(__dirname, './out-fixtures'); - var expectedContents = fs.readFileSync(inputPath); + const inputPath = path.join(__dirname, './fixtures/test.coffee'); + const inputBase = path.join(__dirname, './fixtures/'); + const expectedPath = path.join(__dirname, './out-fixtures/test.coffee'); + const expectedCwd = __dirname; + const expectedBase = path.join(__dirname, './out-fixtures'); + const expectedContents = fs.readFileSync(inputPath); - var expectedFile = new File({ + const expectedFile = new File({ base: inputBase, cwd: __dirname, path: inputPath, contents: expectedContents }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); buffered[0].cwd.should.equal(__dirname, 'cwd should have changed'); @@ -640,9 +634,9 @@ describe('symlink stream', () => { done(); }; - var stream = vfs.symlink('./out-fixtures/', { cwd: path.relative(process.cwd(), __dirname) }); + const stream = vfs.symlink('./out-fixtures/', { cwd: path.relative(process.cwd(), __dirname) }); - var buffered: any = []; + const buffered: any = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -650,21 +644,21 @@ describe('symlink stream', () => { }); it('should write buffer files to the right folder with function and relative cwd', done => { - var inputPath = path.join(__dirname, './fixtures/test.coffee'); - var inputBase = path.join(__dirname, './fixtures/'); - var expectedPath = path.join(__dirname, './out-fixtures/test.coffee'); - var expectedCwd = __dirname; - var expectedBase = path.join(__dirname, './out-fixtures'); - var expectedContents = fs.readFileSync(inputPath); + const inputPath = path.join(__dirname, './fixtures/test.coffee'); + const inputBase = path.join(__dirname, './fixtures/'); + const expectedPath = path.join(__dirname, './out-fixtures/test.coffee'); + const expectedCwd = __dirname; + const expectedBase = path.join(__dirname, './out-fixtures'); + const expectedContents = fs.readFileSync(inputPath); - var expectedFile = new File({ + const expectedFile = new File({ base: inputBase, cwd: __dirname, path: inputPath, contents: expectedContents }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); buffered[0].cwd.should.equal(__dirname, 'cwd should have changed'); @@ -676,13 +670,13 @@ describe('symlink stream', () => { done(); }; - var stream = vfs.symlink(file => { + const stream = vfs.symlink(file => { should.exist(file); file.should.equal(expectedFile); return './out-fixtures'; }, { cwd: path.relative(process.cwd(), __dirname) }); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -690,15 +684,15 @@ describe('symlink stream', () => { }); it('should write buffer files to the right folder', done => { - var inputPath = path.join(__dirname, './fixtures/test.coffee'); - var inputBase = path.join(__dirname, './fixtures/'); - var expectedPath = path.join(__dirname, './out-fixtures/test.coffee'); - var expectedContents = fs.readFileSync(inputPath); - var expectedCwd = __dirname; - var expectedBase = path.join(__dirname, './out-fixtures'); - var expectedMode = parseInt("0655", 8); + const inputPath = path.join(__dirname, './fixtures/test.coffee'); + const inputBase = path.join(__dirname, './fixtures/'); + const expectedPath = path.join(__dirname, './out-fixtures/test.coffee'); + const expectedContents = fs.readFileSync(inputPath); + const expectedCwd = __dirname; + const expectedBase = path.join(__dirname, './out-fixtures'); + const expectedMode = parseInt("0655", 8); - var expectedFile = new File({ + const expectedFile = new File({ base: inputBase, cwd: __dirname, path: inputPath, @@ -708,7 +702,7 @@ describe('symlink stream', () => { } }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); buffered[0].cwd.should.equal(__dirname, 'cwd should have changed'); @@ -720,9 +714,9 @@ describe('symlink stream', () => { done(); }; - var stream = vfs.symlink('./out-fixtures/', { cwd: __dirname }); + const stream = vfs.symlink('./out-fixtures/', { cwd: __dirname }); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -730,16 +724,16 @@ describe('symlink stream', () => { }); it('should write streaming files to the right folder', done => { - var inputPath = path.join(__dirname, './fixtures/test.coffee'); - var inputBase = path.join(__dirname, './fixtures/'); - var expectedPath = path.join(__dirname, './out-fixtures/test.coffee'); - var expectedContents = fs.readFileSync(inputPath); - var expectedCwd = __dirname; - var expectedBase = path.join(__dirname, './out-fixtures'); - var expectedMode = parseInt("0655", 8); + const inputPath = path.join(__dirname, './fixtures/test.coffee'); + const inputBase = path.join(__dirname, './fixtures/'); + const expectedPath = path.join(__dirname, './out-fixtures/test.coffee'); + const expectedContents = fs.readFileSync(inputPath); + const expectedCwd = __dirname; + const expectedBase = path.join(__dirname, './out-fixtures'); + const expectedMode = parseInt("0655", 8); - var contentStream = through.obj(); - var expectedFile = new File({ + const contentStream = through.obj(); + const expectedFile = new File({ base: inputBase, cwd: __dirname, path: inputPath, @@ -749,7 +743,7 @@ describe('symlink stream', () => { } }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); buffered[0].cwd.should.equal(__dirname, 'cwd should have changed'); @@ -761,9 +755,9 @@ describe('symlink stream', () => { done(); }; - var stream = vfs.symlink('./out-fixtures/', { cwd: __dirname }); + const stream = vfs.symlink('./out-fixtures/', { cwd: __dirname }); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -775,14 +769,14 @@ describe('symlink stream', () => { }); it('should write directories to the right folder', done => { - var inputPath = path.join(__dirname, './fixtures/wow'); - var inputBase = path.join(__dirname, './fixtures/'); - var expectedPath = path.join(__dirname, './out-fixtures/wow'); - var expectedCwd = __dirname; - var expectedBase = path.join(__dirname, './out-fixtures'); - var expectedMode = parseInt("0655", 8); + const inputPath = path.join(__dirname, './fixtures/wow'); + const inputBase = path.join(__dirname, './fixtures/'); + const expectedPath = path.join(__dirname, './out-fixtures/wow'); + const expectedCwd = __dirname; + const expectedBase = path.join(__dirname, './out-fixtures'); + const expectedMode = parseInt("0655", 8); - var expectedFile = new File({ + const expectedFile = new File({ base: inputBase, cwd: __dirname, path: inputPath, @@ -793,7 +787,7 @@ describe('symlink stream', () => { } }); - var onEnd = () => { + const onEnd = () => { buffered.length.should.equal(1); buffered[0].should.equal(expectedFile); buffered[0].cwd.should.equal(__dirname, 'cwd should have changed'); @@ -805,9 +799,9 @@ describe('symlink stream', () => { done(); }; - var stream = vfs.symlink('./out-fixtures/', { cwd: __dirname }); + const stream = vfs.symlink('./out-fixtures/', { cwd: __dirname }); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); stream.write(expectedFile); @@ -815,32 +809,32 @@ describe('symlink stream', () => { }); it('should use different modes for files and directories', done => { - var inputBase = path.join(__dirname, './fixtures'); - var inputPath = path.join(__dirname, './fixtures/wow/suchempty'); - var expectedBase = path.join(__dirname, './out-fixtures/wow'); - var expectedDirMode = parseInt("0755", 8); - var expectedFileMode = parseInt("0655", 8); + const inputBase = path.join(__dirname, './fixtures'); + const inputPath = path.join(__dirname, './fixtures/wow/suchempty'); + const expectedBase = path.join(__dirname, './out-fixtures/wow'); + const expectedDirMode = parseInt("0755", 8); + const expectedFileMode = parseInt("0655", 8); - var firstFile = new File({ + const firstFile = new File({ base: inputBase, cwd: __dirname, path: inputPath, stat: fs.statSync(inputPath) }); - var onEnd = () => { + const onEnd = () => { realMode(fs.lstatSync(expectedBase).mode).should.equal(expectedDirMode); realMode(buffered[0].stat.mode).should.equal(expectedFileMode); done(); }; - var stream = vfs.symlink('./out-fixtures/', { + const stream = vfs.symlink('./out-fixtures/', { cwd: __dirname, mode: expectedFileMode, dirMode: expectedDirMode }); - var buffered: any[] = []; + const buffered: any[] = []; bufferStream = through.obj(dataWrap(buffered.push.bind(buffered)), onEnd); stream.pipe(bufferStream); @@ -849,15 +843,15 @@ describe('symlink stream', () => { }); it('should report IO errors', done => { - var inputPath = path.join(__dirname, './fixtures/test.coffee'); - var inputBase = path.join(__dirname, './fixtures/'); - var expectedPath = path.join(__dirname, './out-fixtures/test.coffee'); - var expectedContents = fs.readFileSync(inputPath); - var expectedCwd = __dirname; - var expectedBase = path.join(__dirname, './out-fixtures'); - var expectedMode = parseInt("0722", 8); + const inputPath = path.join(__dirname, './fixtures/test.coffee'); + const inputBase = path.join(__dirname, './fixtures/'); + const expectedPath = path.join(__dirname, './out-fixtures/test.coffee'); + const expectedContents = fs.readFileSync(inputPath); + const expectedCwd = __dirname; + const expectedBase = path.join(__dirname, './out-fixtures'); + const expectedMode = parseInt("0722", 8); - var expectedFile = new File({ + const expectedFile = new File({ base: inputBase, cwd: __dirname, path: inputPath, @@ -870,7 +864,7 @@ describe('symlink stream', () => { fs.mkdirSync(expectedBase); fs.chmodSync(expectedBase, 0); - var stream = vfs.symlink('./out-fixtures/', { cwd: __dirname }); + const stream = vfs.symlink('./out-fixtures/', { cwd: __dirname }); stream.on('error', (err: any) => { err.code.should.equal('EACCES'); done(); @@ -880,14 +874,14 @@ describe('symlink stream', () => { ['end', 'finish'].forEach(eventName => { it('should emit ' + eventName + ' event', done => { - var srcPath = path.join(__dirname, './fixtures/test.coffee'); - var stream = vfs.symlink('./out-fixtures/', { cwd: __dirname }); + const srcPath = path.join(__dirname, './fixtures/test.coffee'); + const stream = vfs.symlink('./out-fixtures/', { cwd: __dirname }); stream.on(eventName, () => { done(); }); - var file = new File({ + const file = new File({ path: srcPath, cwd: __dirname, contents: new Buffer("1234567890") @@ -898,13 +892,13 @@ describe('symlink stream', () => { }); }); it('should check if it"s a vinyl file', () => { - var srcPath = path.join(__dirname, './fixtures/test.coffee'); - var options = { + const srcPath = path.join(__dirname, './fixtures/test.coffee'); + const options = { path: srcPath, cwd: __dirname, contents: new Buffer("1234567890") }; - var file = new File(options); + const file = new File(options); File.isVinyl(file).should.equal(true); File.isVinyl(options).should.equal(false); }); From 8d717e1e250e6958fb33b1eb8144a25e891fc859 Mon Sep 17 00:00:00 2001 From: Gilad Gray Date: Wed, 29 Mar 2017 14:52:20 -0700 Subject: [PATCH 055/844] add types for kss --- types/kss/index.d.ts | 149 ++++++++++++++++++++++++++++++++++++++++ types/kss/kss-tests.ts | 10 +++ types/kss/tsconfig.json | 23 +++++++ types/kss/tslint.json | 3 + 4 files changed, 185 insertions(+) create mode 100644 types/kss/index.d.ts create mode 100644 types/kss/kss-tests.ts create mode 100644 types/kss/tsconfig.json create mode 100644 types/kss/tslint.json diff --git a/types/kss/index.d.ts b/types/kss/index.d.ts new file mode 100644 index 0000000000..0937ba408e --- /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.IKssOptions): Promise; +declare namespace kss { + interface IFile { + /** bath to source directory */ + base: string; + /** file contents */ + contents: string; + /** full path to file */ + path: string; + } + + interface ISource { + /** 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 IOptions { + /** + * 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 IKssOptions extends IOptions { + 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?: object); + 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(): object; + } + + class KssSection { + constructor(data?: object); + 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(): ISource; + source(source: ISource): KssSection; + sourceFileName(): string; + sourceLine(): string; + styleGuide(): KssStyleguide; + styleGuide(styleguide: KssStyleguide): KssSection; + toJSON(): object; + weight(): number; + weight(weight: number): KssSection; + } + + class KssModifier { + constructor(data?: object); + 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(): object; + } + + class KssParameter { + constructor(data?: object); + defaultValue(): string; + description(): string; + description(description: string): KssParameter; + name(): string; + name(name: string): KssParameter; + section(): KssSection; + section(section: KssSection): KssParameter; + toJSON(): object; + } + + /** Parse a string of documented CSS, or an array of file objects with their content. */ + function parse(input: string | IFile[], options: IOptions): KssStyleguide; + + /** Traverse a directory, parse its contents, and create a `KssStyleGuide`. */ + function traverse(directory: string | string[], options: IOptions): 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..4dcd9b1539 --- /dev/null +++ b/types/kss/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6", + "dom" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": false, + "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" +} From e2be06066be093783f698a3b900d463038339b70 Mon Sep 17 00:00:00 2001 From: Gilad Gray Date: Wed, 29 Mar 2017 14:57:03 -0700 Subject: [PATCH 056/844] fix linting --- types/kss/index.d.ts | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/types/kss/index.d.ts b/types/kss/index.d.ts index 0937ba408e..1a7359c1da 100644 --- a/types/kss/index.d.ts +++ b/types/kss/index.d.ts @@ -4,9 +4,9 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped /** Builds a styleguide given the proper options. */ -declare function kss(options?: kss.IKssOptions): Promise; +declare function kss(options?: kss.KssOptions): Promise; declare namespace kss { - interface IFile { + interface File { /** bath to source directory */ base: string; /** file contents */ @@ -15,7 +15,7 @@ declare namespace kss { path: string; } - interface ISource { + interface Source { /** The name of the file. */ filename: string; /** The full path of the file. */ @@ -24,7 +24,7 @@ declare namespace kss { line: number; } - interface IOptions { + interface Options { /** * Whether to automatically format Markdown using [marked](https://github.com/chjj/marked). * Enabled by default. @@ -45,11 +45,11 @@ declare namespace kss { header?: boolean; } - interface IKssOptions extends IOptions { + interface KssOptions extends Options { builder?: any; clone?: boolean; custom?: any; - logErrorFunction?: (...msg: string[]) => void; + logErrorFunction?(...msg: string[]): void; json?: boolean; mask?: string | RegExp; source: string[]; @@ -59,7 +59,7 @@ declare namespace kss { type CallbackFn = (error: Error | null, styleguide: KssStyleguide) => void; class KssStyleguide { - constructor(data?: object); + constructor(data?: any); autoInit(autoInit: boolean): KssStyleguide; customPropertyNames(): string[]; customPropertyNames(names: string | string[]): KssStyleguide; @@ -69,11 +69,11 @@ declare namespace kss { sections(): KssSection[]; sections(query: string | RegExp): false | KssSection | KssSection[]; sections(sections: KssSection | KssSection[]): KssStyleguide; - toJSON(): object; + toJSON(): any; } class KssSection { - constructor(data?: object); + constructor(data?: any); custom(name: string): any; custom(name: string, value: any): KssSection; customPropertyNames(): string[]; @@ -101,19 +101,19 @@ declare namespace kss { referenceNumber(referenceNumber: string): KssSection; referenceURI(): string; referenceURI(referenceURI: string): KssSection; - source(): ISource; - source(source: ISource): KssSection; + source(): Source; + source(source: Source): KssSection; sourceFileName(): string; sourceLine(): string; styleGuide(): KssStyleguide; styleGuide(styleguide: KssStyleguide): KssSection; - toJSON(): object; + toJSON(): any; weight(): number; weight(weight: number): KssSection; } class KssModifier { - constructor(data?: object); + constructor(data?: any); className(): string; className(className: string): KssModifier; description(): string; @@ -124,11 +124,11 @@ declare namespace kss { name(name: string): KssModifier; section(): KssSection; section(section: KssSection): KssModifier; - toJSON(): object; + toJSON(): any; } class KssParameter { - constructor(data?: object); + constructor(data?: any); defaultValue(): string; description(): string; description(description: string): KssParameter; @@ -136,14 +136,14 @@ declare namespace kss { name(name: string): KssParameter; section(): KssSection; section(section: KssSection): KssParameter; - toJSON(): object; + toJSON(): any; } - /** Parse a string of documented CSS, or an array of file objects with their content. */ - function parse(input: string | IFile[], options: IOptions): KssStyleguide; + /** 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: IOptions): Promise; + function traverse(directory: string | string[], options: Options): Promise; } export = kss; From 6e16e2a540585830575fdf67b83ad2860f5c7589 Mon Sep 17 00:00:00 2001 From: Andy Date: Wed, 29 Mar 2017 15:24:42 -0700 Subject: [PATCH 057/844] sharepoint: Apply new lint rules (#15492) --- types/sharepoint/index.d.ts | 2028 ++++++++++++-------------- types/sharepoint/sharepoint-tests.ts | 759 ++++------ 2 files changed, 1275 insertions(+), 1512 deletions(-) diff --git a/types/sharepoint/index.d.ts b/types/sharepoint/index.d.ts index 1908d46b0c..da19c221d4 100644 --- a/types/sharepoint/index.d.ts +++ b/types/sharepoint/index.d.ts @@ -14,7 +14,7 @@ declare function ExecuteOrDelayUntilEventNotified(func: (...args: any[]) => void declare var Strings: any; declare namespace SP { - export class SOD { + class SOD { static execute(fileName: string, functionName: string, ...args: any[]): void; static executeFunc(fileName: string, typeName: string, fn: () => void): void; static executeOrDelayUntilEventNotified(func: (...args: any[]) => void, eventName: string): boolean; @@ -33,7 +33,7 @@ declare namespace SP { static set_ribbonImagePrefetchEnabled(value: boolean): void; } - export enum ListLevelPermissionMask { + enum ListLevelPermissionMask { viewListItems, // : 1, insertListItems, // : 2, editListItems, // : 4, @@ -47,7 +47,7 @@ declare namespace SP { manageLists // : 2048 } - export class HtmlBuilder { + class HtmlBuilder { constructor(); addAttribute(name: string, value: string): void; addCssClass(cssClassName: string): void; @@ -59,7 +59,7 @@ declare namespace SP { toString(): string; } - export class ScriptHelpers { + class ScriptHelpers { static disableWebpartSelection(context: SPClientTemplates.RenderContext): void; static getDocumentQueryPairs(): { [index: string]: string; }; static getFieldFromSchema(schema: SPClientTemplates.ListSchema, fieldName: string): SPClientTemplates.FieldSchema; @@ -84,8 +84,7 @@ declare namespace SP { static resizeImageToSquareLength(imgElement: HTMLImageElement, squareLength: number): void; } - - export class PageContextInfo { + class PageContextInfo { static get_siteServerRelativeUrl(): string; static get_webServerRelativeUrl(): string; static get_webAbsoluteUrl(): string; @@ -107,32 +106,30 @@ declare namespace SP { get_pagePersonalizationScope(): string; } - export class ContextPermissions { + class ContextPermissions { has(perm: number): boolean; hasPermissions(high: number, low: number): boolean; fromJson(json: { High: number; Low: number; }): void; } - export namespace ListOperation { - export namespace ViewOperation { - export function getSelectedView(): string; - export function navigateUp(viewId: string): void; - export function refreshView(viewId: string): void; + namespace ListOperation { + namespace ViewOperation { + function getSelectedView(): string; + function navigateUp(viewId: string): void; + function refreshView(viewId: string): void; } - export namespace Selection { - export function selectListItem(iid: string, bSelect: boolean): void; - export function getSelectedItems(): Array<{ id: number; fsObjType: FileSystemObjectType; }>; - export function getSelectedList(): string; - export function getSelectedView(): string; - export function navigateUp(viewId: string): void; - export function deselectAllListItems(iid: string): void; + namespace Selection { + function selectListItem(iid: string, bSelect: boolean): void; + function getSelectedItems(): Array<{ id: number; fsObjType: FileSystemObjectType; }>; + function getSelectedList(): string; + function getSelectedView(): string; + function navigateUp(viewId: string): void; + function deselectAllListItems(iid: string): void; } - export namespace Overrides { - export function overrideDeleteConfirmation(listId: string, overrideText: string): void; + namespace Overrides { + function overrideDeleteConfirmation(listId: string, overrideText: string): void; } } - - } /** Register function to rerun on partial update in MDS-enabled site.*/ @@ -277,8 +274,8 @@ interface ContextInfo extends SPClientTemplates.RenderContext { SendToLocationName: string; SendToLocationUrl: string; StateInitDone: boolean; - TableCbxFocusHandler: (instance: any, eventArgs: any) => void; - TableMouseoverHandler: (instance: any, eventArgs: any) => void; + TableCbxFocusHandler(instance: any, eventArgs: any): void; + TableMouseoverHandler(instance: any, eventArgs: any): void; TotalListItems: number; WorkflowsAssociated: boolean; clvp: any; @@ -302,7 +299,7 @@ interface ContextInfo extends SPClientTemplates.RenderContext { listTemplate: string; listUrlDir: string; newFormUrl: string; - onRefreshFailed: (context: any, requrest: any, response: any) => void; + onRefreshFailed(context: any, requrest: any, response: any): void; overrideDeleteConfirmation: string; overrideFilterQstring: string; recursiveView: boolean; @@ -322,13 +319,12 @@ interface ContextInfo extends SPClientTemplates.RenderContext { noGroupCollapse: boolean; SiteTemplateId: number; ExcludeFromOfflineClient: boolean; - } declare function GetCurrentCtx(): ContextInfo; declare function SetFullScreenMode(fullscreen: boolean): void; declare namespace SP { - export enum RequestExecutorErrors { + enum RequestExecutorErrors { requestAbortedOrTimedout, unexpectedResponse, httpError, @@ -338,7 +334,7 @@ declare namespace SP { iFrameLoadError } - export class RequestExecutor { + class RequestExecutor { constructor(url: string, options?: any); get_formDigestHandlingEnabled(): boolean; set_formDigestHandlingEnabled(value: boolean): void; @@ -348,7 +344,7 @@ declare namespace SP { attemptLogin(returnUrl: string, success: (response: ResponseInfo) => void, error?: (response: ResponseInfo, error: RequestExecutorErrors, statusText: string) => void): void; } - export interface RequestInfo { + interface RequestInfo { url: string; method?: string; headers?: { [key: string]: string; }; @@ -359,12 +355,12 @@ declare namespace SP { /** Currently need fix to get ginary response. Details: http:// techmikael.blogspot.ru/2013/07/how-to-copy-files-between-sites-using.html */ binaryStringResponseBody?: boolean; timeout?: number; - success?: (response: ResponseInfo) => void; - error?: (response: ResponseInfo, error: RequestExecutorErrors, statusText: string) => void; + success?(response: ResponseInfo): void; + error?(response: ResponseInfo, error: RequestExecutorErrors, statusText: string): void; state?: any; } - export interface ResponseInfo { + interface ResponseInfo { statusCode?: number; statusText?: string; responseAvailable: boolean; @@ -376,11 +372,11 @@ declare namespace SP { state?: any; } - export class ProxyWebRequestExecutor extends Sys.Net.WebRequestExecutor { + class ProxyWebRequestExecutor extends Sys.Net.WebRequestExecutor { constructor(url: string, options?: any); } - export class ProxyWebRequestExecutorFactory implements SP.IWebRequestExecutorFactory { + class ProxyWebRequestExecutorFactory implements SP.IWebRequestExecutorFactory { constructor(url: string, options?: any); createWebRequestExecutor(): ProxyWebRequestExecutor; } @@ -591,7 +587,6 @@ declare class CalloutActionMenuEntry { wzDesc: string); } - declare class CalloutActionMenu { constructor(actionsId: any); addAction(action: CalloutAction): void; @@ -601,7 +596,6 @@ declare class CalloutActionMenu { calculateActionWidth(): void; } - declare class CalloutAction { constructor(options: CalloutActionOptions); getText(): string; @@ -710,7 +704,6 @@ declare class CalloutOptions { positionAlgorithm: (callout: Callout) => void; } - declare class CalloutManager { /** Creates a new callout */ static createNew(options: CalloutOptions): Callout; @@ -737,21 +730,19 @@ declare class CalloutManager { static isAtLeastOneCalloutOn(): boolean; } - declare namespace SPClientTemplates { - - export enum FileSystemObjectType { + enum FileSystemObjectType { Invalid, File, Folder, Web } - export enum ChoiceFormatType { + enum ChoiceFormatType { Dropdown, Radio } - export enum ClientControlMode { + enum ClientControlMode { Invalid, DisplayForm, EditForm, @@ -759,24 +750,24 @@ declare namespace SPClientTemplates { View } - export enum RichTextMode { + enum RichTextMode { Compatible, FullHtml, HtmlAsXml, ThemeHtml } - export enum UrlFormatType { + enum UrlFormatType { Hyperlink, Image } - export enum DateTimeDisplayFormat { + enum DateTimeDisplayFormat { DateOnly, DateTime, TimeOnly } - export enum DateTimeCalendarType { + enum DateTimeCalendarType { None, Gregorian, Japan, @@ -794,20 +785,20 @@ declare namespace SPClientTemplates { SakaEra, UmAlQura } - export enum UserSelectionMode { + enum UserSelectionMode { PeopleOnly, PeopleAndGroups } /** Represents schema for a Choice field in list form or in list view in grid mode */ - export interface FieldSchema_InForm_Choice extends FieldSchema_InForm { + interface FieldSchema_InForm_Choice extends FieldSchema_InForm { /** List of choices for this field. */ Choices: string[]; /** Display format for the choice field */ FormatType: ChoiceFormatType; } /** Represents schema for a Lookup field in list form or in list view in grid mode */ - export interface FieldSchema_InForm_Lookup extends FieldSchema_InForm { + interface FieldSchema_InForm_Lookup extends FieldSchema_InForm { /** Specifies if the field allows multiple values */ AllowMultipleValues: boolean; /** Returns base url for a list display form, e.g. "http:// portal/web/_layouts/15/listform.aspx?PageType=4" @@ -826,10 +817,9 @@ declare namespace SPClientTemplates { ChoiceCount: number; LookupListId: string; - } /** Represents schema for a DateTime field in list form or in list view in grid mode */ - export interface FieldSchema_InForm_DateTime extends FieldSchema_InForm { + interface FieldSchema_InForm_DateTime extends FieldSchema_InForm { /** Type of calendar to use */ CalendarType: DateTimeCalendarType; /** Display format for DateTime field. */ @@ -851,19 +841,19 @@ declare namespace SPClientTemplates { HoursOptions: string[]; } /** Represents schema for a DateTime field in list form or in list view in grid mode */ - export interface FieldSchema_InForm_Geolocation extends FieldSchema_InForm { + interface FieldSchema_InForm_Geolocation extends FieldSchema_InForm { BingMapsKey: string; IsBingMapBlockedInCurrentRegion: boolean; } /** Represents schema for a Choice field in list form or in list view in grid mode */ - export interface FieldSchema_InForm_MultiChoice extends FieldSchema_InForm { + interface FieldSchema_InForm_MultiChoice extends FieldSchema_InForm { /** List of choices for this field. */ MultiChoices: string[]; /** Indicates wherever fill-in choice is allowed */ FillInChoice: boolean; } /** Represents schema for a Choice field in list form or in list view in grid mode */ - export interface FieldSchema_InForm_MultiLineText extends FieldSchema_InForm { + interface FieldSchema_InForm_MultiLineText extends FieldSchema_InForm { /** Specifies whether rich text formatting can be used in the field */ RichText: boolean; /** Changes are appended to the existing text. */ @@ -878,19 +868,19 @@ declare namespace SPClientTemplates { ScriptEditorAdderId: string; } /** Represents schema for a Number field in list form or in list view in grid mode */ - export interface FieldSchema_InForm_Number extends FieldSchema_InForm { + interface FieldSchema_InForm_Number extends FieldSchema_InForm { ShowAsPercentage: boolean; } /** Represents schema for a Number field in list form or in list view in grid mode */ - export interface FieldSchema_InForm_Text extends FieldSchema_InForm { + interface FieldSchema_InForm_Text extends FieldSchema_InForm { MaxLength: number; } /** Represents schema for a Number field in list form or in list view in grid mode */ - export interface FieldSchema_InForm_Url extends FieldSchema_InForm { + interface FieldSchema_InForm_Url extends FieldSchema_InForm { DisplayFormat: UrlFormatType; } /** Represents schema for a Number field in list form or in list view in grid mode */ - export interface FieldSchema_InForm_User extends FieldSchema_InForm { + interface FieldSchema_InForm_User extends FieldSchema_InForm { Presence: boolean; WithPicture: boolean; DefaultRender: boolean; @@ -904,7 +894,7 @@ declare namespace SPClientTemplates { PictureSize: string; } - export interface FieldSchema { + interface FieldSchema { /** Specifies if the field can be edited while list view is in the Grid mode */ AllowGridEditing: boolean; /** String representation of the field type, e.g. "Lookup". Same as SPField.TypeAsString */ @@ -918,7 +908,7 @@ declare namespace SPClientTemplates { /** Represents field schema in Grid mode and on list forms. Consider casting objects of this type to more specific field types, e.g. FieldSchemaInForm_Lookup */ - export interface FieldSchema_InForm extends FieldSchema { + interface FieldSchema_InForm extends FieldSchema { /** Description for this field. */ Description: string; /** Direction of the reading order for the field. */ @@ -941,25 +931,24 @@ declare namespace SPClientTemplates { UseMinWidth: boolean; } - export interface ListSchema { + interface ListSchema { Field: FieldSchema[]; } - - export interface ListSchema_InForm extends ListSchema { + interface ListSchema_InForm extends ListSchema { Field: FieldSchema_InForm[]; } - export interface ListData_InForm { + interface ListData_InForm { Items: Item[]; } - export interface RenderContext_FieldInForm extends RenderContext_Form { + interface RenderContext_FieldInForm extends RenderContext_Form { CurrentGroupIdx: number; CurrentGroup: Group; CurrentItems: Item[]; CurrentFieldSchema: FieldSchema_InForm; CurrentFieldValue: any; } - export interface RenderContext_Form extends RenderContext { + interface RenderContext_Form extends RenderContext { CurrentItem: Item; FieldControlModes: { [fieldInternalName: string]: ClientControlMode; }; FormContext: ClientFormContext; @@ -969,9 +958,7 @@ declare namespace SPClientTemplates { CSRCustomLayout?: boolean; } - - - export interface FieldSchema_InView_LookupField extends FieldSchema_InView { + interface FieldSchema_InView_LookupField extends FieldSchema_InView { /** Either "TRUE" or "FALSE" */ AllowMultipleValues: string; /** Target lookup list display form URL, including PageType and List attributes. */ @@ -979,7 +966,7 @@ declare namespace SPClientTemplates { /** Either "TRUE" or "FALSE" */ HasPrefix: string; } - export interface FieldSchema_InView_UserField extends FieldSchema_InView { + interface FieldSchema_InView_UserField extends FieldSchema_InView { /** Either "TRUE" or "FALSE" */ AllowMultipleValues: string; /** Either "TRUE" or "FALSE" */ @@ -992,7 +979,7 @@ declare namespace SPClientTemplates { DefaultRender: string; } /** Represents field schema in a list view. */ - export interface FieldSchema_InView extends FieldSchema { + interface FieldSchema_InView extends FieldSchema { /** Either "TRUE" or "FALSE" */ CalloutMenu: string; ClassInfo: string; // e.g. "Menu" @@ -1021,7 +1008,7 @@ declare namespace SPClientTemplates { /** Indicates whether the field can be sorted. Either "TRUE" or "FALSE" */ Sortable: string; } - export interface ListSchema_InView extends ListSchema { + interface ListSchema_InView extends ListSchema { /** Key-value object that represents all aggregations defined for the view. Key specifies the field internal name, and value specifies the type of the aggregation. */ Aggregate: { [name: string]: string; }; @@ -1090,7 +1077,7 @@ declare namespace SPClientTemplates { /** Query string parameters that specify current root folder (RootFolder) and folder content type id (FolderCTID) */ ViewSelector_ViewParameters: string; } - export interface ListData_InView { + interface ListData_InView { FilterLink: string; FilterFields: string; FirstRow: number; @@ -1106,12 +1093,12 @@ declare namespace SPClientTemplates { LastRow: number; Row: Item[]; } - export interface RenderContext_GroupInView extends RenderContext_InView { + interface RenderContext_GroupInView extends RenderContext_InView { CurrentGroupIdx: number; CurrentGroup: Group; CurrentItems: Item[]; } - export interface RenderContext_InView extends RenderContext { + interface RenderContext_InView extends RenderContext { AllowCreateFolder: boolean; AllowGridMode: boolean; BasePermissions: { [PermissionName: string]: boolean; }; // SP.BasePermissions? @@ -1199,11 +1186,11 @@ declare namespace SPClientTemplates { wpq: string; WriteSecurity: string; } - export interface RenderContext_ItemInView extends RenderContext_InView { + interface RenderContext_ItemInView extends RenderContext_InView { CurrentItem: Item; CurrentItemIdx: number; } - export interface RenderContext_FieldInView extends RenderContext_ItemInView { + interface RenderContext_FieldInView extends RenderContext_ItemInView { /** If in grid mode (context.inGridMode == true), cast to FieldSchema_InForm, otherwise cast to FieldSchema_InView */ CurrentFieldSchema: FieldSchema_InForm | FieldSchema_InView; CurrentFieldValue: any; @@ -1212,15 +1199,15 @@ declare namespace SPClientTemplates { FormUniqueId: string; } - export interface Item { + interface Item { [fieldInternalName: string]: any; } - export interface Group { + interface Group { Items: Item[]; } type RenderCallback = (ctx: RenderContext) => void; - export interface RenderContext { + interface RenderContext { BaseViewID?: number; ControlMode?: ClientControlMode; CurrentCultureName?: string; @@ -1231,37 +1218,37 @@ declare namespace SPClientTemplates { OnPostRender?: RenderCallback | RenderCallback[]; OnPreRender?: RenderCallback | RenderCallback[]; onRefreshFailed?: any; - RenderBody?: (renderContext: RenderContext) => string; - RenderFieldByName?: (renderContext: RenderContext, fieldName: string) => string; - RenderFields?: (renderContext: RenderContext) => string; - RenderFooter?: (renderContext: RenderContext) => string; - RenderGroups?: (renderContext: RenderContext) => string; - RenderHeader?: (renderContext: RenderContext) => string; - RenderItems?: (renderContext: RenderContext) => string; - RenderView?: (renderContext: RenderContext) => string; + RenderBody?(renderContext: RenderContext): string; + RenderFieldByName?(renderContext: RenderContext, fieldName: string): string; + RenderFields?(renderContext: RenderContext): string; + RenderFooter?(renderContext: RenderContext): string; + RenderGroups?(renderContext: RenderContext): string; + RenderHeader?(renderContext: RenderContext): string; + RenderItems?(renderContext: RenderContext): string; + RenderView?(renderContext: RenderContext): string; SiteClientTag?: string; Templates?: Templates; } /** Must return null in order to fall back to a more common template or to a system default template */ - export type SingleTemplateCallback = (renderContext: RenderContext_InView) => string; + type SingleTemplateCallback = (renderContext: RenderContext_InView) => string; /** Must return null in order to fall back to a more common template or to a system default template */ - export type GroupCallback = (renderContext: RenderContext_GroupInView) => string; + type GroupCallback = (renderContext: RenderContext_GroupInView) => string; /** Must return null in order to fall back to a more common template or to a system default template */ - export type ItemCallback = (renderContext: RenderContext) => string; + type ItemCallback = (renderContext: RenderContext) => string; /** Must return null in order to fall back to a more common template or to a system default template */ - export type FieldCallback = (renderContext: RenderContext) => string; + type FieldCallback = (renderContext: RenderContext) => string; /** Must return null in order to fall back to a more common template or to a system default template */ - export type FieldInFormCallback = (renderContext: RenderContext_FieldInForm) => string; + type FieldInFormCallback = (renderContext: RenderContext_FieldInForm) => string; /** Must return null in order to fall back to a more common template or to a system default template */ - export type FieldInViewCallback = (renderContext: RenderContext_FieldInView) => string; + type FieldInViewCallback = (renderContext: RenderContext_FieldInView) => string; - export interface FieldTemplateOverrides { + interface FieldTemplateOverrides { /** Defines templates for rendering the field on a display form. */ DisplayForm?: FieldInFormCallback; /** Defines templates for rendering the field on an edit form. */ @@ -1272,11 +1259,11 @@ declare namespace SPClientTemplates { View?: FieldInViewCallback; } - export interface FieldTemplates { + interface FieldTemplates { [fieldInternalName: string]: FieldCallback; } - export interface Templates { + interface Templates { View?: RenderCallback | string; // TODO: determine appropriate context type and purpose of this template Body?: RenderCallback | string; // TODO: determine appropriate context type and purpose of this template /** Defines templates for rendering groups (aggregations). */ @@ -1293,11 +1280,11 @@ declare namespace SPClientTemplates { Fields?: FieldTemplates; } - export interface FieldTemplateMap { + interface FieldTemplateMap { [fieldInternalName: string]: FieldTemplateOverrides; } - export interface TemplateOverrides { + interface TemplateOverrides { View?: RenderCallback | string; // TODO: determine appropriate context type and purpose of this template Body?: RenderCallback | string; // TODO: determine appropriate context type and purpose of this template /** Defines templates for rendering groups (aggregations). */ @@ -1313,7 +1300,7 @@ declare namespace SPClientTemplates { /** Defines templates for fields rendering. The field is specified by it's internal name. */ Fields?: FieldTemplateMap; } - export interface TemplateOverridesOptions { + interface TemplateOverridesOptions { /** Template overrides */ Templates?: TemplateOverrides; @@ -1333,12 +1320,12 @@ declare namespace SPClientTemplates { If not defined, the templates will be applied to all views. */ BaseViewID?: number | string; } - export class TemplateManager { + class TemplateManager { static RegisterTemplateOverrides(renderCtx: TemplateOverridesOptions): void; static GetTemplates(renderCtx: RenderContext): Templates; } - export interface ClientUserValue { + interface ClientUserValue { lookupId: number; lookupValue: string; displayStr: string; @@ -1349,15 +1336,15 @@ declare namespace SPClientTemplates { department: string; jobTitle: string; } - export interface ClientLookupValue { + interface ClientLookupValue { LookupId: number; LookupValue: string; } - export interface ClientUrlValue { + interface ClientUrlValue { URL: string; Description: string; } - export class Utility { + class Utility { static ComputeRegisterTypeInfo(renderCtx: TemplateOverridesOptions): any; static ControlModeToString(mode: SPClientTemplates.ClientControlMode): string; static FileSystemObjectTypeToString(fileSystemObjectType: SPClientTemplates.FileSystemObjectType): string; @@ -1387,7 +1374,7 @@ declare namespace SPClientTemplates { static UserMultiValueDelimitString: string; } - export class ClientFormContext { + class ClientFormContext { fieldValue: any; fieldSchema: SPClientTemplates.FieldSchema_InForm; fieldName: string; @@ -1421,7 +1408,6 @@ declare namespace SPClientTemplates { registerClientValidator(fieldname: string, validator: SPClientForms.ClientValidation.ValidatorSet): void; registerHasValueChangedCallback(fieldname: string, callback: (eventArg?: any) => void): void; } - } declare function GenerateIID(renderCtx: SPClientTemplates.RenderContext_ItemInView): string; @@ -1432,38 +1418,36 @@ declare function CoreRender(template: any, context: any): string; declare namespace SPClientForms { namespace ClientValidation { - export class ValidationResult { + class ValidationResult { constructor(hasErrors: boolean, errorMsg: string); } - export class ValidatorSet { + class ValidatorSet { RegisterValidator(validator: IValidator): void; } // tslint:disable-next-line: interface-name - export interface IValidator { + interface IValidator { Validate(value: any): ValidationResult; } - export class RequiredValidator implements IValidator { + class RequiredValidator implements IValidator { Validate(value: any): ValidationResult; } - export class RequiredFileValidator implements IValidator { + class RequiredFileValidator implements IValidator { Validate(value: any): ValidationResult; } - export class RequiredRichTextValidator implements IValidator { + class RequiredRichTextValidator implements IValidator { Validate(value: any): ValidationResult; } - export class MaxLengthUrlValidator implements IValidator { + class MaxLengthUrlValidator implements IValidator { Validate(value: any): ValidationResult; } - - } - export enum FormManagerEvents { + enum FormManagerEvents { Event_OnControlValueChanged, // : 1, Event_OnControlInitializedCallback, // : 2, Event_OnControlFocusSetCallback, // : 3, @@ -1473,14 +1457,14 @@ declare namespace SPClientForms { Event_GetHasValueChangedCallback // : 7 } - export class ClientForm { + class ClientForm { constructor(qualifier: string); RenderClientForm(): void; SubmitClientForm(): boolean; NotifyControlEvent(eventName: FormManagerEvents, fldName: string, eventArg: any): void; } - export class ClientFormManager { + class ClientFormManager { static GetClientForm(qualifier: string): ClientForm; static RegisterClientForm(qualifier: string): void; static SubmitClientForm(qualifier: string): boolean; @@ -1523,7 +1507,7 @@ declare function SPFieldLookupMulti_Edit(ctx: SPClientTemplates.RenderContext_Fi declare function SPFieldAttachments_Default(ctx: SPClientTemplates.RenderContext_FieldInForm): string; declare namespace SPAnimation { - export enum Attribute { + enum Attribute { PositionX, PositionY, Height, @@ -1531,7 +1515,7 @@ declare namespace SPAnimation { Opacity } - export enum ID { + enum ID { Basic_Show, Basic_SlowShow, Basic_Fade, @@ -1556,27 +1540,26 @@ declare namespace SPAnimation { Basic_QuickSize } - export class Settings { + class Settings { static DisableAnimation(): void; static DisableSessionAnimation(): void; static IsAnimationEnabled(): boolean; } - - export class State { + class State { SetAttribute(attributeId: Attribute, value: number): void; GetAttribute(attributeId: Attribute): number; GetDataIndex(attributeId: Attribute): number } - export class Object { + class Object { constructor(animationID: ID, delay: number, element: HTMLElement | HTMLElement[], finalState: State, finishFunc?: (data: any) => void, data?: any); RunAnimation(): void; } } declare namespace SPAnimationUtility { - export class BasicAnimator { + class BasicAnimator { static FadeIn(element: HTMLElement, finishFunc?: (data: any) => void, data?: any): void; static FadeOut(element: HTMLElement, finishFunc?: (data: any) => void, data?: any): void; static Move(element: HTMLElement, posX: number, posY: number, finishFunc?: (data: any) => void, data?: any): void; @@ -1611,13 +1594,13 @@ interface IEnumerable { } declare namespace SP { - export class ScriptUtility { + class ScriptUtility { static isNullOrEmptyString(str: string): boolean; static isNullOrUndefined(obj: any): boolean; static isUndefined(obj: any): boolean; static truncateToInt(n: number): number; } - export class Guid { + class Guid { constructor(guidText: string); static get_empty(): SP.Guid; static newGuid(): SP.Guid; @@ -1627,7 +1610,7 @@ declare namespace SP { ToSerialized(): string; } /** Specifies permissions that are used to define user roles. Represents SPBasePermissions class. */ - export enum PermissionKind { + enum PermissionKind { /** Has no permissions on the Web site. Not available through the user interface. */ emptyMask, /** View items in lists, documents in document libraries, and view Web discussion comments. */ @@ -1704,18 +1687,18 @@ declare namespace SP { fullMask, } - export class BaseCollection implements IEnumerable { + class BaseCollection implements IEnumerable { getEnumerator(): IEnumerator; get_count(): number; itemAtIndex(index: number): T; constructor(); } // tslint:disable-next-line: interface-name - export interface IFromJson { + interface IFromJson { fromJson(initValue: any): void; customFromJson(initValue: any): boolean; } - export class Base64EncodedByteArray { + class Base64EncodedByteArray { constructor(base64Str?: string); get_length(): number; toBase64String(): string; @@ -1723,7 +1706,7 @@ declare namespace SP { getByteAt(index: number): any; setByteAt(index: number, b: any): void; } - export class ConditionalScopeBase { + class ConditionalScopeBase { startScope(): any; startIfTrue(): any; startIfFalse(): any; @@ -1731,59 +1714,59 @@ declare namespace SP { fromJson(initValue: any): void; customFromJson(initValue: any): boolean; } - export class ClientObjectPropertyConditionalScope extends SP.ConditionalScopeBase { + class ClientObjectPropertyConditionalScope extends SP.ConditionalScopeBase { constructor(clientObject: SP.ClientObject, propertyName: string, comparisonOperator: string, valueToCompare: any, allowAllActions?: boolean); } - // export class ClientResult { + // class ClientResult { // get_value(): any; // setValue(value: any): void; // constructor(); // } - export class ClientResult { + class ClientResult { get_value(): T; setValue(value: T): void; constructor(); } - export class BooleanResult { + class BooleanResult { get_value(): boolean; constructor(); } - export class CharResult { + class CharResult { get_value(): any; constructor(); } - export class IntResult { + class IntResult { get_value(): number; constructor(); } - export class DoubleResult { + class DoubleResult { get_value(): number; constructor(); } - export class StringResult { + class StringResult { get_value(): string; constructor(); } - export class DateTimeResult { + class DateTimeResult { get_value(): Date; constructor(); } - export class GuidResult { + class GuidResult { get_value(): SP.Guid; constructor(); } - export class JsonObjectResult { + class JsonObjectResult { get_value(): any; constructor(); } - export class ClientDictionaryResultHandler { + class ClientDictionaryResultHandler { constructor(dict: SP.ClientResult); } - export class ClientUtility { + class ClientUtility { static urlPathEncodeForXmlHttpRequest(url: string): string; static getOrCreateObjectPathForConstructor(context: SP.ClientRuntimeContext, typeId: string, args: any[]): SP.ObjectPath; } - export class XElement { + class XElement { get_name(): string; set_name(value: string): void; get_attributes(): any; @@ -1792,17 +1775,17 @@ declare namespace SP { set_children(value: any): void; constructor(); } - export class ClientXElement { + class ClientXElement { get_element(): SP.XElement; set_element(value: SP.XElement): void; constructor(); } - export class ClientXDocument { + class ClientXDocument { get_root(): SP.XElement; set_root(value: SP.XElement): void; constructor(); } - export class DataConvert { + class DataConvert { static writePropertiesToXml(writer: SP.XmlWriter, obj: any, propNames: string[], serializationContext: SP.SerializationContext): void; static populateDictionaryFromObject(dict: any, parentNode: any): void; static fixupTypes(context: SP.ClientRuntimeContext, dict: any): void; @@ -1820,18 +1803,18 @@ declare namespace SP { } // tslint:disable-next-line: interface-name - export interface IWebRequestExecutorFactory { + interface IWebRequestExecutorFactory { createWebRequestExecutor(): Sys.Net.WebRequestExecutor; } - export class PageRequestFailedEventArgs extends Sys.EventArgs { + class PageRequestFailedEventArgs extends Sys.EventArgs { get_executor(): Sys.Net.WebRequestExecutor; get_errorMessage(): string; get_isErrorPage(): boolean; } - export class PageRequestSucceededEventArgs extends Sys.EventArgs { + class PageRequestSucceededEventArgs extends Sys.EventArgs { get_executor(): Sys.Net.WebRequestExecutor; } - export class PageRequest { + class PageRequest { get_request(): Sys.Net.WebRequest; get_url(): string; set_url(value: string): void; @@ -1847,11 +1830,11 @@ declare namespace SP { remove_failed(value: (sender: any, args: SP.PageRequestFailedEventArgs) => void): void; constructor(); } - export class ResResources { + class ResResources { static getString(resourceId: string, args: any[]): string; } /** Defines a writer that provides a set of methods to append text in XML format. Use the static SP.XmlWriter.create(sb) Method to create an SP.XmlWriter object with the Sys.StringBuilder object you pass in. */ - export class XmlWriter { + class XmlWriter { /** Creates a new instance of the XmlWriter class with the specified string builder. */ static create(sb: Sys.StringBuilder): SP.XmlWriter; /** Appends a start element tag with the specified name in XML format to the object?s string builder. */ @@ -1874,7 +1857,7 @@ declare namespace SP { close(): void; } - export class ClientConstants { + class ClientConstants { AddExpandoFieldTypeSuffix: string; Actions: string; ApplicationName: string; @@ -1999,14 +1982,13 @@ declare namespace SP { fluidApplicationInitParamRequestToken: string; fluidApplicationInitParamFormDigestTimeoutSeconds: string; fluidApplicationInitParamFormDigest: string; - } - export class ClientSchemaVersions { + class ClientSchemaVersions { version14: string; version15: string; currentVersion: string; } - export class ClientErrorCodes { + class ClientErrorCodes { genericError: number; accessDenied: number; docAlreadyExists: number; @@ -2019,24 +2001,24 @@ declare namespace SP { fieldValueFailedValidation: number; itemValueFailedValidation: number; } - export class ClientAction { + class ClientAction { get_id(): number; get_path(): SP.ObjectPath; get_name(): string; } - export class ClientActionSetProperty extends SP.ClientAction { + class ClientActionSetProperty extends SP.ClientAction { constructor(obj: SP.ClientObject, propName: string, propValue: any); } - export class ClientActionSetStaticProperty extends SP.ClientAction { + class ClientActionSetStaticProperty extends SP.ClientAction { constructor(context: SP.ClientRuntimeContext, typeId: string, propName: string, propValue: any); } - export class ClientActionInvokeMethod extends SP.ClientAction { + class ClientActionInvokeMethod extends SP.ClientAction { constructor(obj: SP.ClientObject, methodName: string, parameters: any[]); } - export class ClientActionInvokeStaticMethod extends SP.ClientAction { + class ClientActionInvokeStaticMethod extends SP.ClientAction { constructor(context: SP.ClientRuntimeContext, typeId: string, methodName: string, parameters: any[]); } - export class ClientObject { + class ClientObject { constructor(context: SP.ClientRuntimeContext, objectPath: SP.ObjectPath); get_context(): SP.ClientRuntimeContext; get_path(): SP.ObjectPath; @@ -2053,14 +2035,14 @@ declare namespace SP { initPropertiesFromJson(initValue: any): void; checkUninitializedProperty(propName: string): void; } - export class ClientObjectData { + class ClientObjectData { get_properties(): any; get_clientObjectProperties(): any; get_methodReturnObjects(): any; constructor(); } /** Provides a base class for a collection of objects on a remote client. */ - export class ClientObjectCollection extends SP.ClientObject implements IEnumerable { + class ClientObjectCollection extends SP.ClientObject implements IEnumerable { get_areItemsAvailable(): boolean; /** Gets the data for all of the items in the collection. */ retrieveItems(): SP.ClientObjectPrototype; @@ -2074,30 +2056,30 @@ declare namespace SP { fromJson(obj: any): void; } - export class ClientObjectList extends SP.ClientObjectCollection { + class ClientObjectList extends SP.ClientObjectCollection { constructor(context: SP.ClientRuntimeContext, objectPath: SP.ObjectPath, childItemType: any); fromJson(initValue: any): void; customFromJson(initValue: any): boolean; } - export class ClientObjectPrototype { + class ClientObjectPrototype { retrieve(propertyNames?: string[]): void; retrieveObject(propertyName: string): SP.ClientObjectPrototype; retrieveCollectionObject(propertyName: string): SP.ClientObjectCollectionPrototype; } - export class ClientObjectCollectionPrototype extends SP.ClientObjectPrototype { + class ClientObjectCollectionPrototype extends SP.ClientObjectPrototype { retrieveItems(): SP.ClientObjectPrototype; } - export enum ClientRequestStatus { + enum ClientRequestStatus { active, inProgress, completedSuccess, completedException, } - export class WebRequestEventArgs extends Sys.EventArgs { + class WebRequestEventArgs extends Sys.EventArgs { constructor(webRequest: Sys.Net.WebRequest); get_webRequest(): Sys.Net.WebRequest; } - export class ClientRequest { + class ClientRequest { static get_nextSequenceId(): number; get_webRequest(): Sys.Net.WebRequest; add_requestSucceeded(value: (sender: any, args: SP.ClientRequestSucceededEventArgs) => void): void; @@ -2107,10 +2089,10 @@ declare namespace SP { get_navigateWhenServerRedirect(): boolean; set_navigateWhenServerRedirect(value: boolean): void; } - export class ClientRequestEventArgs extends Sys.EventArgs { + class ClientRequestEventArgs extends Sys.EventArgs { get_request(): SP.ClientRequest; } - export class ClientRequestFailedEventArgs extends SP.ClientRequestEventArgs { + class ClientRequestFailedEventArgs extends SP.ClientRequestEventArgs { constructor(request: SP.ClientRequest, message: string, stackTrace: string, errorCode: number, errorValue: string, errorTypeName: string, errorDetails: any, errorTraceCorrelationId?: string); get_message(): string; get_stackTrace(): string; @@ -2120,9 +2102,9 @@ declare namespace SP { get_errorDetails(): any; get_errorTraceCorrelationId(): string; } - export class ClientRequestSucceededEventArgs extends SP.ClientRequestEventArgs { + class ClientRequestSucceededEventArgs extends SP.ClientRequestEventArgs { } - export class ClientRuntimeContext implements Sys.IDisposable { + class ClientRuntimeContext implements Sys.IDisposable { constructor(serverRelativeUrlOrFullUrl: string); get_url(): string; get_viaUrl(): string; @@ -2161,23 +2143,23 @@ declare namespace SP { set_traceCorrelationId(value: string): void; dispose(): void; } - export class SimpleDataTable { + class SimpleDataTable { get_rows(): any[]; constructor(); } - export class ClientValueObject { + class ClientValueObject { fromJson(obj: any): void; customFromJson(obj: any): boolean; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; customWriteToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): boolean; get_typeId(): string; } - export class ClientValueObjectCollection extends SP.ClientValueObject implements IEnumerable { + class ClientValueObjectCollection extends SP.ClientValueObject implements IEnumerable { get_count(): number; getEnumerator(): IEnumerator; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; } - export class ExceptionHandlingScope { + class ExceptionHandlingScope { constructor(context: SP.ClientRuntimeContext); startScope(): any; startTry(): any; @@ -2192,32 +2174,32 @@ declare namespace SP { get_serverErrorTypeName(): string; get_serverErrorDetails(): any; } - export class ObjectIdentityQuery extends SP.ClientAction { + class ObjectIdentityQuery extends SP.ClientAction { constructor(objectPath: SP.ObjectPath); } - export class ObjectPath { + class ObjectPath { setPendingReplace(): void; } - export class ObjectPathProperty extends SP.ObjectPath { + class ObjectPathProperty extends SP.ObjectPath { constructor(context: SP.ClientRuntimeContext, parent: SP.ObjectPath, propertyName: string); } - export class ObjectPathStaticProperty extends SP.ObjectPath { + class ObjectPathStaticProperty extends SP.ObjectPath { constructor(context: SP.ClientRuntimeContext, typeId: string, propertyName: string); } - export class ObjectPathMethod extends SP.ObjectPath { + class ObjectPathMethod extends SP.ObjectPath { constructor(context: SP.ClientRuntimeContext, parent: SP.ObjectPath, methodName: string, parameters: any[]); } - export class ObjectPathStaticMethod extends SP.ObjectPath { + class ObjectPathStaticMethod extends SP.ObjectPath { constructor(context: SP.ClientRuntimeContext, typeId: string, methodName: string, parameters: any[]); } - export class ObjectPathConstructor extends SP.ObjectPath { + class ObjectPathConstructor extends SP.ObjectPath { constructor(context: SP.ClientRuntimeContext, typeId: string, parameters: any[]); } - export class SerializationContext { + class SerializationContext { addClientObject(obj: SP.ClientObject): void; addObjectPath(path: SP.ObjectPath): void; } - export class ResourceStrings { + class ResourceStrings { argumentExceptionMessage: string; argumentNullExceptionMessage: string; cC_AppIconAlt: string; @@ -2279,7 +2261,7 @@ declare namespace SP { unknownError: string; unknownResponseData: string; } - export class RuntimeRes { + class RuntimeRes { cC_PlaceHolderElementNotFound: string; rE_CannotAccessSiteOpenWindowFailed: string; noObjectPathAssociatedWithObject: string; @@ -2341,16 +2323,16 @@ declare namespace SP { requestHasBeenExecuted: string; objectNameMethod: string; } - export class ParseJSONUtil { + class ParseJSONUtil { static parseObjectFromJsonString(json: string): any; static validateJson(text: string): boolean; } - export enum DateTimeKind { + enum DateTimeKind { unspecified, utc, local, } - export class OfficeVersion { + class OfficeVersion { majorBuildVersion: number; previousMajorBuildVersion: number; majorVersion: string; @@ -2360,18 +2342,18 @@ declare namespace SP { assemblyVersion: string; wssMajorVersion: string; } - export class ClientContext extends SP.ClientRuntimeContext { + class ClientContext extends SP.ClientRuntimeContext { constructor(serverRelativeUrlOrFullUrl?: string); static get_current(): SP.ClientContext; get_web(): SP.Web; get_site(): SP.Site; get_serverVersion(): string; } - export enum ULSTraceLevel { + enum ULSTraceLevel { verbose, } /** Provides a Unified Logging Service (ULS) that monitors log messages. */ - export class ULS { + class ULS { /** Gets a value that indicates whether the Unified Logging Service (ULS) is enabled. */ static get_enabled(): boolean; /** Sets a value that indicates whether the Unified Logging Service (ULS) is enabled. */ @@ -2388,11 +2370,11 @@ declare namespace SP { /** Traces when the function has finished. */ static traceApiLeave(): void; } - export class AccessRequests { + class AccessRequests { static changeRequestStatus(context: SP.ClientRuntimeContext, itemId: number, newStatus: number, convStr: string, permType: string, permissionLevel: number): void; static changeRequestStatusBulk(context: SP.ClientRuntimeContext, requestIds: number[], newStatus: number): void; } - export enum AddFieldOptions { + enum AddFieldOptions { defaultValue, addToDefaultContentType, addToNoContentType, @@ -2401,27 +2383,27 @@ declare namespace SP { addFieldToDefaultView, addFieldCheckDisplayName, } - export class AlternateUrl extends SP.ClientObject { + class AlternateUrl extends SP.ClientObject { get_uri(): string; get_urlZone(): SP.UrlZone; } - export class App extends SP.ClientObject { + class App extends SP.ClientObject { get_assetId(): string; get_contentMarket(): string; get_versionString(): string; } - export class AppCatalog { + class AppCatalog { static getAppInstances(context: SP.ClientRuntimeContext, web: SP.Web): SP.ClientObjectList; static getDeveloperSiteAppInstancesByIds(context: SP.ClientRuntimeContext, site: SP.Site, appInstanceIds: SP.Guid[]): SP.ClientObjectList; static isAppSideloadingEnabled(context: SP.ClientRuntimeContext): SP.BooleanResult; } - export class AppContextSite extends SP.ClientObject { + class AppContextSite extends SP.ClientObject { constructor(context: SP.ClientRuntimeContext, siteUrl: string); get_site(): SP.Site; get_web(): SP.Web; static newObject(context: SP.ClientRuntimeContext, siteUrl: string): SP.AppContextSite; } - export class AppInstance extends SP.ClientObject { + class AppInstance extends SP.ClientObject { get_appPrincipalId(): string; get_appWebFullUrl(): string; get_id(): SP.Guid; @@ -2441,7 +2423,7 @@ declare namespace SP { getPreviousAppVersion(): SP.App; retryAllJobs(): void; } - export class AppInstanceErrorDetails extends SP.ClientObject { + class AppInstanceErrorDetails extends SP.ClientObject { get_correlationId(): SP.Guid; set_correlationId(value: SP.Guid): void; get_errorDetail(): string; @@ -2453,7 +2435,7 @@ declare namespace SP { set_source(value: SP.AppInstanceErrorSource): void; get_sourceName(): string; } - export enum AppInstanceErrorSource { + enum AppInstanceErrorSource { common, appWeb, parentWeb, @@ -2463,12 +2445,12 @@ declare namespace SP { eventCallouts, finalization, } - export enum AppInstanceErrorType { + enum AppInstanceErrorType { transient, configuration, app, } - export enum AppInstanceStatus { + enum AppInstanceStatus { invalidStatus, installing, canceling, @@ -2480,36 +2462,36 @@ declare namespace SP { disabling, disabled, } - export class AppLicense extends SP.ClientValueObject { + class AppLicense extends SP.ClientValueObject { get_rawXMLLicenseToken(): string; get_typeId(): string; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class AppLicenseCollection extends SP.ClientValueObjectCollection { + class AppLicenseCollection extends SP.ClientValueObjectCollection { add(item: SP.AppLicense): void; get_item(index: number): SP.AppLicense; get_typeId(): string; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export enum AppLicenseType { + enum AppLicenseType { perpetualMultiUser, perpetualAllUsers, trialMultiUser, trialAllUsers, } - export class Attachment extends SP.ClientObject { + class Attachment extends SP.ClientObject { get_fileName(): string; get_serverRelativeUrl(): string; deleteObject(): void; } - export class AttachmentCollection extends SP.ClientObjectCollection { + class AttachmentCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.Attachment; get_item(index: number): SP.Attachment; getByFileName(fileName: string): SP.Attachment; } - export class AttachmentCreationInformation extends SP.ClientValueObject { + class AttachmentCreationInformation extends SP.ClientValueObject { get_contentStream(): SP.Base64EncodedByteArray; set_contentStream(value: SP.Base64EncodedByteArray): void; get_fileName(): string; @@ -2518,7 +2500,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class BasePermissions extends SP.ClientValueObject { + class BasePermissions extends SP.ClientValueObject { set(perm: SP.PermissionKind): void; clear(perm: SP.PermissionKind): void; clearAll(): void; @@ -2530,7 +2512,7 @@ declare namespace SP { constructor(); } /** Specifies the base type for a list. */ - export enum BaseType { + enum BaseType { none, genericList, documentLibrary, @@ -2539,11 +2521,11 @@ declare namespace SP { survey, issue, } - export enum BrowserFileHandling { + enum BrowserFileHandling { permissive, strict, } - export enum CalendarType { + enum CalendarType { none, gregorian, japan, @@ -2562,7 +2544,7 @@ declare namespace SP { umAlQura, } /** Specifies a Collaborative Application Markup Language (CAML) query on a list. */ - export class CamlQuery extends SP.ClientValueObject { + class CamlQuery extends SP.ClientValueObject { constructor(); /** This method creates a Collaborative Application Markup Language (CAML) string that can be used to recursively get all of the items in a list, including @@ -2591,49 +2573,49 @@ declare namespace SP { get_typeId(): string; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; } - export class Change extends SP.ClientObject { + class Change extends SP.ClientObject { get_changeToken(): SP.ChangeToken; get_changeType(): SP.ChangeType; get_siteId(): SP.Guid; get_time(): Date; } - export class ChangeAlert extends SP.Change { + class ChangeAlert extends SP.Change { get_alertId(): SP.Guid; get_webId(): SP.Guid; } - export class ChangeCollection extends SP.ClientObjectCollection { + class ChangeCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.Change; get_item(index: number): SP.Change; } - export class ChangeContentType extends SP.Change { + class ChangeContentType extends SP.Change { get_contentTypeId(): SP.ContentTypeId; get_webId(): SP.Guid; } - export class ChangeField extends SP.Change { + class ChangeField extends SP.Change { get_fieldId(): SP.Guid; get_webId(): SP.Guid; } - export class ChangeFile extends SP.Change { + class ChangeFile extends SP.Change { get_uniqueId(): SP.Guid; get_webId(): SP.Guid; } - export class ChangeFolder extends SP.Change { + class ChangeFolder extends SP.Change { get_uniqueId(): SP.Guid; get_webId(): SP.Guid; } - export class ChangeGroup extends SP.Change { + class ChangeGroup extends SP.Change { get_groupId(): number; } - export class ChangeItem extends SP.Change { + class ChangeItem extends SP.Change { get_itemId(): number; get_listId(): SP.Guid; get_webId(): SP.Guid; } - export class ChangeList extends SP.Change { + class ChangeList extends SP.Change { get_listId(): SP.Guid; get_webId(): SP.Guid; } - export class ChangeLogItemQuery extends SP.ClientValueObject { + class ChangeLogItemQuery extends SP.ClientValueObject { get_changeToken(): string; set_changeToken(value: string): void; get_contains(): string; @@ -2652,7 +2634,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class ChangeQuery extends SP.ClientValueObject { + class ChangeQuery extends SP.ClientValueObject { constructor(); constructor(allChangeObjectTypes: boolean, allChangeTypes: boolean); get_add(): boolean; @@ -2718,16 +2700,16 @@ declare namespace SP { get_typeId(): string; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; } - export class ChangeSite extends SP.Change { + class ChangeSite extends SP.Change { } - export class ChangeToken extends SP.ClientValueObject { + class ChangeToken extends SP.ClientValueObject { get_stringValue(): string; set_stringValue(value: string): void; get_typeId(): string; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export enum ChangeType { + enum ChangeType { noChange, add, update, @@ -2750,35 +2732,35 @@ declare namespace SP { listContentTypeAdd, listContentTypeDelete, } - export class ChangeUser extends SP.Change { + class ChangeUser extends SP.Change { get_activate(): boolean; get_userId(): number; } - export class ChangeView extends SP.Change { + class ChangeView extends SP.Change { get_viewId(): SP.Guid; get_listId(): SP.Guid; get_webId(): SP.Guid; } - export class ChangeWeb extends SP.Change { + class ChangeWeb extends SP.Change { get_webId(): SP.Guid; } - export enum CheckinType { + enum CheckinType { minorCheckIn, majorCheckIn, overwriteCheckIn, } - export enum CheckOutType { + enum CheckOutType { online, offline, none, } - export enum ChoiceFormatType { + enum ChoiceFormatType { dropdown, radioButtons, } - export class CompatibilityRange extends SP.ClientObject { + class CompatibilityRange extends SP.ClientObject { } - export class ContentType extends SP.ClientObject { + class ContentType extends SP.ClientObject { get_description(): string; set_description(value: string): void; get_displayFormTemplateName(): string; @@ -2821,14 +2803,14 @@ declare namespace SP { update(updateChildren: boolean): void; deleteObject(): void; } - export class ContentTypeCollection extends SP.ClientObjectCollection { + class ContentTypeCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.ContentType; get_item(index: number): SP.ContentType; getById(contentTypeId: string): SP.ContentType; addExistingContentType(contentType: SP.ContentType): SP.ContentType; add(parameters: SP.ContentTypeCreationInformation): SP.ContentType; } - export class ContentTypeCreationInformation extends SP.ClientValueObject { + class ContentTypeCreationInformation extends SP.ClientValueObject { get_description(): string; set_description(value: string): void; get_group(): string; @@ -2841,33 +2823,33 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class ContentTypeId extends SP.ClientValueObject { + class ContentTypeId extends SP.ClientValueObject { toString(): string; get_stringValue(): string; get_typeId(): string; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export enum CustomizedPageStatus { + enum CustomizedPageStatus { none, uncustomized, customized, } - export enum DateTimeFieldFormatType { + enum DateTimeFieldFormatType { dateOnly, dateTime, } - export enum DateTimeFieldFriendlyFormatType { + enum DateTimeFieldFriendlyFormatType { unspecified, disabled, relative, } - export enum DraftVisibilityType { + enum DraftVisibilityType { reader, author, approver, } - export class EventReceiverDefinition extends SP.ClientObject { + class EventReceiverDefinition extends SP.ClientObject { get_receiverAssembly(): string; get_receiverClass(): string; get_receiverId(): SP.Guid; @@ -2879,13 +2861,13 @@ declare namespace SP { update(): void; deleteObject(): void; } - export class EventReceiverDefinitionCollection extends SP.ClientObjectCollection { + class EventReceiverDefinitionCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.EventReceiverDefinition; get_item(index: number): SP.EventReceiverDefinition; getById(eventReceiverId: SP.Guid): SP.EventReceiverDefinition; add(eventReceiverCreationInformation: SP.EventReceiverDefinitionCreationInformation): SP.EventReceiverDefinition; } - export class EventReceiverDefinitionCreationInformation extends SP.ClientValueObject { + class EventReceiverDefinitionCreationInformation extends SP.ClientValueObject { get_receiverAssembly(): string; set_receiverAssembly(value: string): void; get_receiverClass(): string; @@ -2904,12 +2886,12 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export enum EventReceiverSynchronization { + enum EventReceiverSynchronization { defaultSynchronization, synchronous, asynchronous, } - export enum EventReceiverType { + enum EventReceiverType { invalidReceiver, itemAdding, itemUpdating, @@ -2987,23 +2969,23 @@ declare namespace SP { emailReceived, contextEvent, } - export class Feature extends SP.ClientObject { + class Feature extends SP.ClientObject { get_definitionId(): SP.Guid; } - export class FeatureCollection extends SP.ClientObjectCollection { + class FeatureCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.Feature; get_item(index: number): SP.Feature; getById(featureId: SP.Guid): SP.Feature; add(featureId: SP.Guid, force: boolean, featdefScope: SP.FeatureDefinitionScope): SP.Feature; remove(featureId: SP.Guid, force: boolean): void; } - export enum FeatureDefinitionScope { + enum FeatureDefinitionScope { none, farm, site, web, } - export class Field extends SP.ClientObject { + class Field extends SP.ClientObject { get_canBeDeleted(): boolean; get_defaultValue(): string; set_defaultValue(value: string): void; @@ -3058,7 +3040,7 @@ declare namespace SP { setShowInEditForm(value: boolean): void; setShowInNewForm(value: boolean): void; } - export class FieldCalculated extends SP.Field { + class FieldCalculated extends SP.Field { get_dateFormat(): SP.DateTimeFieldFormatType; set_dateFormat(value: SP.DateTimeFieldFormatType): void; get_formula(): string; @@ -3066,24 +3048,24 @@ declare namespace SP { get_outputType(): SP.FieldType; set_outputType(value: SP.FieldType): void; } - export class FieldCalculatedErrorValue extends SP.ClientValueObject { + class FieldCalculatedErrorValue extends SP.ClientValueObject { get_errorMessage(): string; get_typeId(): string; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class FieldMultiChoice extends SP.Field { + class FieldMultiChoice extends SP.Field { get_fillInChoice(): boolean; set_fillInChoice(value: boolean): void; get_mappings(): string; get_choices(): string[]; set_choices(value: string[]): void; } - export class FieldChoice extends SP.FieldMultiChoice { + class FieldChoice extends SP.FieldMultiChoice { get_editFormat(): SP.ChoiceFormatType; set_editFormat(value: SP.ChoiceFormatType): void; } - export class FieldCollection extends SP.ClientObjectCollection { + class FieldCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.Field; get_item(index: number): SP.Field; get_schemaXml(): string; @@ -3094,21 +3076,21 @@ declare namespace SP { addFieldAsXml(schemaXml: string, addToDefaultView: boolean, options: SP.AddFieldOptions): SP.Field; getByInternalNameOrTitle(strName: string): SP.Field; } - export class FieldComputed extends SP.Field { + class FieldComputed extends SP.Field { get_enableLookup(): boolean; set_enableLookup(value: boolean): void; } - export class FieldNumber extends SP.Field { + class FieldNumber extends SP.Field { get_maximumValue(): number; set_maximumValue(value: number): void; get_minimumValue(): number; set_minimumValue(value: number): void; } - export class FieldCurrency extends SP.FieldNumber { + class FieldCurrency extends SP.FieldNumber { get_currencyLocaleId(): number; set_currencyLocaleId(value: number): void; } - export class FieldDateTime extends SP.Field { + class FieldDateTime extends SP.Field { get_dateTimeCalendarType(): SP.CalendarType; set_dateTimeCalendarType(value: SP.CalendarType): void; get_displayFormat(): SP.DateTimeFieldFormatType; @@ -3116,9 +3098,9 @@ declare namespace SP { get_friendlyDisplayFormat(): SP.DateTimeFieldFriendlyFormatType; set_friendlyDisplayFormat(value: SP.DateTimeFieldFriendlyFormatType): void; } - export class FieldGeolocation extends SP.Field { + class FieldGeolocation extends SP.Field { } - export class FieldGeolocationValue extends SP.ClientValueObject { + class FieldGeolocationValue extends SP.ClientValueObject { get_altitude(): number; set_altitude(value: number): void; get_latitude(): number; @@ -3131,9 +3113,9 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class FieldGuid extends SP.Field { + class FieldGuid extends SP.Field { } - export class FieldLink extends SP.ClientObject { + class FieldLink extends SP.ClientObject { get_hidden(): boolean; set_hidden(value: boolean): void; get_id(): SP.Guid; @@ -3142,21 +3124,21 @@ declare namespace SP { set_required(value: boolean): void; deleteObject(): void; } - export class FieldLinkCollection extends SP.ClientObjectCollection { + class FieldLinkCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.FieldLink; get_item(index: number): SP.FieldLink; getById(id: SP.Guid): SP.FieldLink; add(parameters: SP.FieldLinkCreationInformation): SP.FieldLink; reorder(internalNames: string[]): void; } - export class FieldLinkCreationInformation extends SP.ClientValueObject { + class FieldLinkCreationInformation extends SP.ClientValueObject { get_field(): SP.Field; set_field(value: SP.Field): void; get_typeId(): string; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class FieldLookup extends SP.Field { + class FieldLookup extends SP.Field { get_allowMultipleValues(): boolean; set_allowMultipleValues(value: boolean): void; get_isRelationship(): boolean; @@ -3172,7 +3154,7 @@ declare namespace SP { get_relationshipDeleteBehavior(): SP.RelationshipDeleteBehaviorType; set_relationshipDeleteBehavior(value: SP.RelationshipDeleteBehaviorType): void; } - export class FieldLookupValue extends SP.ClientValueObject { + class FieldLookupValue extends SP.ClientValueObject { get_lookupId(): number; set_lookupId(value: number): void; get_lookupValue(): string; @@ -3180,7 +3162,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class FieldMultiLineText extends SP.Field { + class FieldMultiLineText extends SP.Field { get_allowHyperlink(): boolean; set_allowHyperlink(value: boolean): void; get_appendOnly(): boolean; @@ -3193,7 +3175,7 @@ declare namespace SP { set_richText(value: boolean): void; get_wikiLinking(): boolean; } - export class FieldRatingScale extends SP.FieldMultiChoice { + class FieldRatingScale extends SP.FieldMultiChoice { get_gridEndNumber(): number; set_gridEndNumber(value: number): void; get_gridNAOptionText(): string; @@ -3208,7 +3190,7 @@ declare namespace SP { set_gridTextRangeLow(value: string): void; get_rangeCount(): number; } - export class FieldRatingScaleQuestionAnswer extends SP.ClientValueObject { + class FieldRatingScaleQuestionAnswer extends SP.ClientValueObject { get_answer(): number; set_answer(value: number): void; get_question(): string; @@ -3217,16 +3199,16 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class FieldStringValues extends SP.ClientObject { + class FieldStringValues extends SP.ClientObject { get_fieldValues(): any; get_item(fieldName: string): string; refreshLoad(): void; } - export class FieldText extends SP.Field { + class FieldText extends SP.Field { get_maxLength(): number; set_maxLength(value: number): void; } - export enum FieldType { + enum FieldType { invalid, integer, text, @@ -3262,11 +3244,11 @@ declare namespace SP { outcomeChoice, maxItems, } - export class FieldUrl extends SP.Field { + class FieldUrl extends SP.Field { get_displayFormat(): SP.UrlFieldFormatType; set_displayFormat(value: SP.UrlFieldFormatType): void; } - export class FieldUrlValue extends SP.ClientValueObject { + class FieldUrlValue extends SP.ClientValueObject { get_description(): string; set_description(value: string): void; get_url(): string; @@ -3275,7 +3257,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class FieldUser extends SP.FieldLookup { + class FieldUser extends SP.FieldLookup { get_allowDisplay(): boolean; set_allowDisplay(value: boolean): void; get_presence(): boolean; @@ -3285,18 +3267,18 @@ declare namespace SP { get_selectionMode(): SP.FieldUserSelectionMode; set_selectionMode(value: SP.FieldUserSelectionMode): void; } - export enum FieldUserSelectionMode { + enum FieldUserSelectionMode { peopleOnly, peopleAndGroups, } - export class FieldUserValue extends SP.FieldLookupValue { + class FieldUserValue extends SP.FieldLookupValue { static fromUser(userName: string): SP.FieldUserValue; get_typeId(): string; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } /** Represents a file in a SharePoint Web site that can be a Web Part Page, an item in a document library, or a file in a folder. */ - export class File extends SP.ClientObject { + class File extends SP.ClientObject { get_author(): SP.User; /** Returns the user who has checked out the file. */ get_checkedOutByUser(): SP.User; @@ -3355,14 +3337,14 @@ declare namespace SP { recycle(): SP.GuidResult; checkOut(): void; } - export class FileCollection extends SP.ClientObjectCollection { + class FileCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.File; get_item(index: number): SP.File; getByUrl(url: string): SP.File; add(parameters: SP.FileCreationInformation): SP.File; addTemplateFile(urlOfFile: string, templateFileType: SP.TemplateFileType): SP.File; } - export class FileCreationInformation extends SP.ClientValueObject { + class FileCreationInformation extends SP.ClientValueObject { get_content(): SP.Base64EncodedByteArray; set_content(value: SP.Base64EncodedByteArray): void; get_overwrite(): boolean; @@ -3373,12 +3355,12 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export enum FileLevel { + enum FileLevel { published, draft, checkout, } - export class FileSaveBinaryInformation extends SP.ClientValueObject { + class FileSaveBinaryInformation extends SP.ClientValueObject { get_checkRequiredFields(): boolean; set_checkRequiredFields(value: boolean): void; get_content(): SP.Base64EncodedByteArray; @@ -3391,13 +3373,13 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export enum FileSystemObjectType { + enum FileSystemObjectType { invalid, file, folder, web, } - export class FileVersion extends SP.ClientObject { + class FileVersion extends SP.ClientObject { get_checkInComment(): string; get_created(): Date; get_createdBy(): SP.User; @@ -3408,7 +3390,7 @@ declare namespace SP { get_versionLabel(): string; deleteObject(): void; } - export class FileVersionCollection extends SP.ClientObjectCollection { + class FileVersionCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.FileVersion; get_item(index: number): SP.FileVersion; getById(versionid: number): SP.FileVersion; @@ -3417,7 +3399,7 @@ declare namespace SP { deleteAll(): void; restoreByLabel(versionlabel: string): void; } - export class Folder extends SP.ClientObject { + class Folder extends SP.ClientObject { get_contentTypeOrder(): SP.ContentTypeId[]; get_files(): SP.FileCollection; get_listItemAllFields(): SP.ListItem; @@ -3435,24 +3417,24 @@ declare namespace SP { deleteObject(): void; recycle(): SP.GuidResult; } - export class FolderCollection extends SP.ClientObjectCollection { + class FolderCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.Folder; get_item(index: number): SP.Folder; getByUrl(url: string): SP.Folder; add(url: string): SP.Folder; } - export class Form extends SP.ClientObject { + class Form extends SP.ClientObject { get_id(): SP.Guid; get_serverRelativeUrl(): string; get_formType(): SP.PageType; } - export class FormCollection extends SP.ClientObjectCollection
{ + class FormCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.Form; get_item(index: number): SP.Form; getByPageType(formType: SP.PageType): SP.Form; getById(id: SP.Guid): SP.Form; } - export class Principal extends SP.ClientObject { + class Principal extends SP.ClientObject { get_id(): number; get_isHiddenInUI(): boolean; get_loginName(): string; @@ -3460,7 +3442,7 @@ declare namespace SP { set_title(value: string): void; get_principalType(): SP.Utilities.PrincipalType; } - export class Group extends SP.Principal { + class Group extends SP.Principal { get_allowMembersEditMembership(): boolean; set_allowMembersEditMembership(value: boolean): void; get_allowRequestToJoinLeave(): boolean; @@ -3482,7 +3464,7 @@ declare namespace SP { get_users(): SP.UserCollection; update(): void; } - export class GroupCollection extends SP.ClientObjectCollection { + class GroupCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.Group; get_item(index: number): SP.Group; getByName(name: string): SP.Group; @@ -3492,7 +3474,7 @@ declare namespace SP { removeById(id: number): void; remove(group: SP.Group): void; } - export class GroupCreationInformation extends SP.ClientValueObject { + class GroupCreationInformation extends SP.ClientValueObject { get_description(): string; set_description(value: string): void; get_title(): string; @@ -3501,7 +3483,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class InformationRightsManagementSettings extends SP.ClientObject { + class InformationRightsManagementSettings extends SP.ClientObject { get_allowPrint(): boolean; set_allowPrint(value: boolean): void; get_allowScript(): boolean; @@ -3533,7 +3515,7 @@ declare namespace SP { reset(): void; update(): void; } - export class Language extends SP.ClientValueObject { + class Language extends SP.ClientValueObject { get_displayName(): string; get_languageTag(): string; get_lcid(): number; @@ -3541,7 +3523,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class SecurableObject extends SP.ClientObject { + class SecurableObject extends SP.ClientObject { get_firstUniqueAncestorSecurableObject(): SP.SecurableObject; get_hasUniqueRoleAssignments(): boolean; get_roleAssignments(): SP.RoleAssignmentCollection; @@ -3549,14 +3531,14 @@ declare namespace SP { breakRoleInheritance(copyRoleAssignments: boolean, clearSubscopes: boolean): void; } /** Represents display mode for a control or form */ - export enum ControlMode { + enum ControlMode { invalid, displayMode, editMode, newMode } /** Represents a list on a SharePoint Web site. */ - export class List extends SP.SecurableObject { + class List extends SP.SecurableObject { /** Gets item by id. */ getItemById(id: number): SP.ListItem; /** Gets a value that specifies whether the list supports content types. */ @@ -3773,7 +3755,7 @@ declare namespace SP { addItem(parameters: SP.ListItemCreationInformation): SP.ListItem; } /** Represents a collection of SP.List objects */ - export class ListCollection extends SP.ClientObjectCollection { + class ListCollection extends SP.ClientObjectCollection { /** Gets the list at the specified index in the collection. */ itemAt(index: number): SP.List; /** Gets the list at the specified index in the collection. */ @@ -3789,7 +3771,7 @@ declare namespace SP { /** Gets a list that is the default asset location for images or other files, which the users upload to their wiki pages. */ ensureSiteAssetsLibrary(): SP.List; } - export class ListCreationInformation extends SP.ClientValueObject { + class ListCreationInformation extends SP.ClientValueObject { get_customSchemaXml(): string; set_customSchemaXml(value: string): void; get_dataSourceProperties(): any; @@ -3812,20 +3794,20 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class ListDataSource extends SP.ClientValueObject { + class ListDataSource extends SP.ClientValueObject { get_properties(): any; get_typeId(): string; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class ListDataValidationExceptionValue extends SP.ClientValueObject { + class ListDataValidationExceptionValue extends SP.ClientValueObject { get_fieldFailures(): SP.ListDataValidationFailure[]; get_itemFailure(): SP.ListDataValidationFailure; get_typeId(): string; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class ListDataValidationFailure extends SP.ClientValueObject { + class ListDataValidationFailure extends SP.ClientValueObject { get_displayName(): string; get_message(): string; get_name(): string; @@ -3835,11 +3817,11 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export enum ListDataValidationFailureReason { + enum ListDataValidationFailureReason { dataFailure, formulaError, } - export enum ListDataValidationType { + enum ListDataValidationType { userFormulaField, userFormulaItem, requiredField, @@ -3848,7 +3830,7 @@ declare namespace SP { textField, } /** Represents an item or row in a list. */ - export class ListItem extends SP.SecurableObject { + class ListItem extends SP.SecurableObject { get_fieldValues(): any; /** Gets the specified field value for the list item. Field value is returned as string, but it can be casted to a specific field value type, e.g. SP.LookupFieldValue, etc. */ get_item(fieldInternalName: string): any; @@ -3896,13 +3878,13 @@ declare namespace SP { /** Validates form values specified for the list item. Errors are returned through hasException and errorMessage properties of the ListItemFormUpdateValue objects */ validateUpdateListItem(formValues: SP.ListItemFormUpdateValue[], bNewDocumentUpdate: boolean): SP.ListItemFormUpdateValue[]; } - export class ListItemCollection extends SP.ClientObjectCollection { + class ListItemCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.ListItem; get_item(index: number): SP.ListItem; getById(id: number | string): SP.ListItem; get_listItemCollectionPosition(): SP.ListItemCollectionPosition; } - export class ListItemCollectionPosition extends SP.ClientValueObject { + class ListItemCollectionPosition extends SP.ClientValueObject { get_pagingInfo(): string; set_pagingInfo(value: string): void; get_typeId(): string; @@ -3910,7 +3892,7 @@ declare namespace SP { constructor(); } /** Specifies the properties of the new list item. */ - export class ListItemCreationInformation extends SP.ClientValueObject { + class ListItemCreationInformation extends SP.ClientValueObject { get_folderUrl(): string; /** Sets a value that specifies the folder for the new list item. */ set_folderUrl(value: string): void; @@ -3924,11 +3906,11 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class ListItemEntityCollection extends SP.ClientObjectCollection { + class ListItemEntityCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.ListItem; get_item(index: number): SP.ListItem; } - export class ListItemFormUpdateValue extends SP.ClientValueObject { + class ListItemFormUpdateValue extends SP.ClientValueObject { get_errorMessage(): string; set_errorMessage(value: string): void; get_fieldName(): string; @@ -3941,7 +3923,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class ListTemplate extends SP.ClientObject { + class ListTemplate extends SP.ClientObject { get_allowsFolderCreation(): boolean; get_baseType(): SP.BaseType; get_description(): string; @@ -3955,12 +3937,12 @@ declare namespace SP { get_listTemplateTypeKind(): number; get_unique(): boolean; } - export class ListTemplateCollection extends SP.ClientObjectCollection { + class ListTemplateCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.ListTemplate; get_item(index: number): SP.ListTemplate; getByName(name: string): SP.ListTemplate; } - export enum ListTemplateType { + enum ListTemplateType { invalidType, noListTemplate, genericList, @@ -4022,20 +4004,20 @@ declare namespace SP { healthReports, developerSiteDraftApps, } - export enum MoveOperations { + enum MoveOperations { none, overwrite, allowBrokenThickets, bypassApprovePermission, } - export class Navigation extends SP.ClientObject { + class Navigation extends SP.ClientObject { get_quickLaunch(): SP.NavigationNodeCollection; get_topNavigationBar(): SP.NavigationNodeCollection; get_useShared(): boolean; set_useShared(value: boolean): void; getNodeById(id: number): SP.NavigationNode; } - export class NavigationNode extends SP.ClientObject { + class NavigationNode extends SP.ClientObject { get_children(): SP.NavigationNodeCollection; get_id(): number; get_isDocLib(): boolean; @@ -4049,12 +4031,12 @@ declare namespace SP { update(): void; deleteObject(): void; } - export class NavigationNodeCollection extends SP.ClientObjectCollection { + class NavigationNodeCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.NavigationNode; get_item(index: number): SP.NavigationNode; add(parameters: SP.NavigationNodeCreationInformation): SP.NavigationNode; } - export class NavigationNodeCreationInformation extends SP.ClientValueObject { + class NavigationNodeCreationInformation extends SP.ClientValueObject { get_asLastNode(): boolean; set_asLastNode(value: boolean): void; get_isExternal(): boolean; @@ -4069,7 +4051,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class ObjectSharingInformation extends SP.ClientObject { + class ObjectSharingInformation extends SP.ClientObject { get_anonymousEditLink(): string; get_anonymousViewLink(): string; get_canManagePermissions(): boolean; @@ -4085,7 +4067,7 @@ declare namespace SP { static getWebSharingInformation(context: SP.ClientRuntimeContext, excludeCurrentUser: boolean, excludeSiteAdmin: boolean, excludeSecurityGroups: boolean, retrieveAnonymousLinks: boolean, retrieveUserInfoDetails: boolean, checkForAccessRequests: boolean): SP.ObjectSharingInformation; static getObjectSharingInformation(context: SP.ClientRuntimeContext, securableObject: SP.SecurableObject, excludeCurrentUser: boolean, excludeSiteAdmin: boolean, excludeSecurityGroups: boolean, retrieveAnonymousLinks: boolean, retrieveUserInfoDetails: boolean, checkForAccessRequests: boolean, retrievePermissionLevels: boolean): SP.ObjectSharingInformation; } - export class ObjectSharingInformationUser extends SP.ClientObject { + class ObjectSharingInformationUser extends SP.ClientObject { get_customRoleNames(): string; get_department(): string; get_email(): string; @@ -4101,11 +4083,11 @@ declare namespace SP { get_sipAddress(): string; get_user(): SP.User; } - export enum OpenWebOptions { + enum OpenWebOptions { none, initNavigationCache, } - export enum PageType { + enum PageType { invalid, defaultView, normalView, @@ -4120,13 +4102,13 @@ declare namespace SP { solutionForm, pAGE_MAXITEMS, } - export class PropertyValues extends SP.ClientObject { + class PropertyValues extends SP.ClientObject { get_fieldValues(): any; get_item(fieldName: string): any; set_item(fieldName: string, value: any): void; refreshLoad(): void; } - export class PushNotificationSubscriber extends SP.ClientObject { + class PushNotificationSubscriber extends SP.ClientObject { get_customArgs(): string; set_customArgs(value: string): void; get_deviceAppInstanceId(): SP.Guid; @@ -4139,17 +4121,17 @@ declare namespace SP { get_user(): SP.User; update(): void; } - export class PushNotificationSubscriberCollection extends SP.ClientObjectCollection { + class PushNotificationSubscriberCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.PushNotificationSubscriber; get_item(index: number): SP.PushNotificationSubscriber; getByStoreId(id: string): SP.PushNotificationSubscriber; } - export enum QuickLaunchOptions { + enum QuickLaunchOptions { off, on, defaultValue, } - export class RecycleBinItem extends SP.ClientObject { + class RecycleBinItem extends SP.ClientObject { get_author(): SP.User; get_deletedBy(): SP.User; get_deletedDate(): Date; @@ -4163,19 +4145,19 @@ declare namespace SP { deleteObject(): void; restore(): void; } - export class RecycleBinItemCollection extends SP.ClientObjectCollection { + class RecycleBinItemCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.RecycleBinItem; get_item(index: number): SP.RecycleBinItem; getById(id: SP.Guid): SP.RecycleBinItem; deleteAll(): void; restoreAll(): void; } - export enum RecycleBinItemState { + enum RecycleBinItemState { none, firstStageRecycleBin, secondStageRecycleBin, } - export enum RecycleBinItemType { + enum RecycleBinItemType { none, file, fileVersion, @@ -4188,7 +4170,7 @@ declare namespace SP { cascadeParent, web, } - export class RegionalSettings extends SP.ClientObject { + class RegionalSettings extends SP.ClientObject { get_adjustHijriDays(): number; get_alternateCalendarType(): number; get_aM(): string; @@ -4221,18 +4203,18 @@ declare namespace SP { get_workDays(): number; get_workDayStartHour(): number; } - export class RelatedField extends SP.ClientObject { + class RelatedField extends SP.ClientObject { get_fieldId(): SP.Guid; get_listId(): SP.Guid; get_lookupList(): SP.List; get_relationshipDeleteBehavior(): SP.RelationshipDeleteBehaviorType; get_webId(): SP.Guid; } - export class RelatedFieldCollection extends SP.ClientObjectCollection { + class RelatedFieldCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.RelatedField; get_item(index: number): SP.RelatedField; } - export class RelatedFieldExtendedData extends SP.ClientObject { + class RelatedFieldExtendedData extends SP.ClientObject { get_fieldId(): SP.Guid; get_listId(): SP.Guid; get_listImageUrl(): string; @@ -4240,11 +4222,11 @@ declare namespace SP { get_toolTipDescription(): string; get_webId(): SP.Guid; } - export class RelatedFieldExtendedDataCollection extends SP.ClientObjectCollection { + class RelatedFieldExtendedDataCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.RelatedFieldExtendedData; get_item(index: number): SP.RelatedFieldExtendedData; } - export class RelatedItem extends SP.ClientValueObject { + class RelatedItem extends SP.ClientValueObject { get_iconUrl(): string; set_iconUrl(value: string): void; get_itemId(): number; @@ -4261,7 +4243,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class RelatedItemManager extends SP.ClientObject { + class RelatedItemManager extends SP.ClientObject { static getRelatedItems(context: SP.ClientRuntimeContext, SourceListName: string, SourceItemID: number): SP.RelatedItem[]; static getPageOneRelatedItems(context: SP.ClientRuntimeContext, SourceListName: string, SourceItemID: number): SP.RelatedItem[]; static addSingleLink(context: SP.ClientRuntimeContext, SourceListName: string, SourceItemID: number, SourceWebUrl: string, TargetListName: string, TargetItemID: number, TargetWebUrl: string, TryAddReverseLink: boolean): void; @@ -4269,19 +4251,19 @@ declare namespace SP { static addSingleLinkFromUrl(context: SP.ClientRuntimeContext, SourceItemUrl: string, TargetListName: string, TargetItemID: number, TryAddReverseLink: boolean): void; static deleteSingleLink(context: SP.ClientRuntimeContext, SourceListName: string, SourceItemID: number, SourceWebUrl: string, TargetListName: string, TargetItemID: number, TargetWebUrl: string, TryDeleteReverseLink: boolean): void; } - export enum RelationshipDeleteBehaviorType { + enum RelationshipDeleteBehaviorType { none, cascade, restrict, } - export class RequestVariable extends SP.ClientObject { + class RequestVariable extends SP.ClientObject { constructor(context: SP.ClientRuntimeContext); get_value(): string; static newObject(context: SP.ClientRuntimeContext): SP.RequestVariable; append(value: string): void; set(value: string): void; } - export class RoleAssignment extends SP.ClientObject { + class RoleAssignment extends SP.ClientObject { get_member(): SP.Principal; get_principalId(): number; get_roleDefinitionBindings(): SP.RoleDefinitionBindingCollection; @@ -4289,7 +4271,7 @@ declare namespace SP { update(): void; deleteObject(): void; } - export class RoleAssignmentCollection extends SP.ClientObjectCollection { + class RoleAssignmentCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.RoleAssignment; get_item(index: number): SP.RoleAssignment; get_groups(): SP.GroupCollection; @@ -4297,7 +4279,7 @@ declare namespace SP { getByPrincipalId(principalId: number): SP.RoleAssignment; add(principal: SP.Principal, roleBindings: SP.RoleDefinitionBindingCollection): SP.RoleAssignment; } - export class RoleDefinition extends SP.ClientObject { + class RoleDefinition extends SP.ClientObject { get_basePermissions(): SP.BasePermissions; set_basePermissions(value: SP.BasePermissions): void; get_description(): string; @@ -4312,7 +4294,7 @@ declare namespace SP { update(): void; deleteObject(): void; } - export class RoleDefinitionBindingCollection extends SP.ClientObjectCollection { + class RoleDefinitionBindingCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.RoleDefinition; get_item(index: number): SP.RoleDefinition; constructor(context: SP.ClientRuntimeContext); @@ -4321,7 +4303,7 @@ declare namespace SP { remove(roleDefinition: SP.RoleDefinition): void; removeAll(): void; } - export class RoleDefinitionCollection extends SP.ClientObjectCollection { + class RoleDefinitionCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.RoleDefinition; get_item(index: number): SP.RoleDefinition; getByName(name: string): SP.RoleDefinition; @@ -4329,7 +4311,7 @@ declare namespace SP { getById(id: number): SP.RoleDefinition; getByType(roleType: SP.RoleType): SP.RoleDefinition; } - export class RoleDefinitionCreationInformation extends SP.ClientValueObject { + class RoleDefinitionCreationInformation extends SP.ClientValueObject { get_basePermissions(): SP.BasePermissions; set_basePermissions(value: SP.BasePermissions): void; get_description(): string; @@ -4342,7 +4324,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export enum RoleType { + enum RoleType { none, guest, reader, @@ -4351,11 +4333,11 @@ declare namespace SP { administrator, editor, } - export class ServerSettings { + class ServerSettings { static getAlternateUrls(context: SP.ClientRuntimeContext): SP.ClientObjectList; static getGlobalInstalledLanguages(context: SP.ClientRuntimeContext, compatibilityLevel: number): SP.Language[]; } - export class Site extends SP.ClientObject { + class Site extends SP.ClientObject { get_allowDesigner(): boolean; set_allowDesigner(value: boolean): void; get_allowMasterPageEditing(): boolean; @@ -4405,9 +4387,9 @@ declare namespace SP { extendUpgradeReminderDate(): void; invalidate(): void; } - export class SiteUrl extends SP.ClientObject { + class SiteUrl extends SP.ClientObject { } - export class SubwebQuery extends SP.ClientValueObject { + class SubwebQuery extends SP.ClientValueObject { get_configurationFilter(): number; set_configurationFilter(value: number): void; get_webTemplateFilter(): number; @@ -4416,30 +4398,30 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export enum TemplateFileType { + enum TemplateFileType { standardPage, wikiPage, formPage, } - export class ThemeInfo extends SP.ClientObject { + class ThemeInfo extends SP.ClientObject { get_accessibleDescription(): string; get_themeBackgroundImageUri(): string; getThemeShadeByName(name: string): SP.StringResult; getThemeFontByName(name: string, lcid: number): SP.StringResult; } - export class TimeZone extends SP.ClientObject { + class TimeZone extends SP.ClientObject { get_description(): string; get_id(): number; get_information(): SP.TimeZoneInformation; localTimeToUTC(date: Date): SP.DateTimeResult; utcToLocalTime(date: Date): SP.DateTimeResult; } - export class TimeZoneCollection extends SP.ClientObjectCollection { + class TimeZoneCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.TimeZone; get_item(index: number): SP.TimeZone; getById(id: number): SP.TimeZone; } - export class TimeZoneInformation extends SP.ClientValueObject { + class TimeZoneInformation extends SP.ClientValueObject { get_bias(): number; get_daylightBias(): number; get_standardBias(): number; @@ -4447,7 +4429,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class UpgradeInfo extends SP.ClientValueObject { + class UpgradeInfo extends SP.ClientValueObject { get_errorFile(): string; get_errors(): number; get_lastUpdated(): Date; @@ -4462,28 +4444,28 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export enum UpgradeStatus { + enum UpgradeStatus { none, inProgress, failed, completed, } - export enum UpgradeType { + enum UpgradeType { buildUpgrade, versionUpgrade, } - export enum UrlFieldFormatType { + enum UrlFieldFormatType { hyperlink, image, } - export enum UrlZone { + enum UrlZone { defaultZone, intranet, internet, custom, extranet, } - export class UsageInfo extends SP.ClientValueObject { + class UsageInfo extends SP.ClientValueObject { get_bandwidth(): number; get_discussionStorage(): number; get_hits(): number; @@ -4494,7 +4476,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class User extends SP.Principal { + class User extends SP.Principal { get_email(): string; set_email(value: string): void; get_groups(): SP.GroupCollection; @@ -4503,7 +4485,7 @@ declare namespace SP { get_userId(): SP.UserIdInfo; update(): void; } - export class UserCollection extends SP.ClientObjectCollection { + class UserCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.User; get_item(index: number): SP.User; getByLoginName(loginName: string): SP.User; @@ -4515,7 +4497,7 @@ declare namespace SP { add(parameters: SP.UserCreationInformation): SP.User; addUser(user: SP.User): SP.User; } - export class UserCreationInformation extends SP.ClientValueObject { + class UserCreationInformation extends SP.ClientValueObject { get_email(): string; set_email(value: string): void; get_loginName(): string; @@ -4526,7 +4508,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class UserCustomAction extends SP.ClientObject { + class UserCustomAction extends SP.ClientObject { get_commandUIExtension(): string; set_commandUIExtension(value: string): void; get_description(): string; @@ -4561,34 +4543,34 @@ declare namespace SP { update(): void; deleteObject(): void; } - export class UserCustomActionCollection extends SP.ClientObjectCollection { + class UserCustomActionCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.UserCustomAction; get_item(index: number): SP.UserCustomAction; getById(id: SP.Guid): SP.UserCustomAction; clear(): void; add(): SP.UserCustomAction; } - export enum UserCustomActionRegistrationType { + enum UserCustomActionRegistrationType { none, list, contentType, progId, fileType, } - export enum UserCustomActionScope { + enum UserCustomActionScope { unknown, site, web, list, } - export class UserIdInfo extends SP.ClientValueObject { + class UserIdInfo extends SP.ClientValueObject { get_nameId(): string; get_nameIdIssuer(): string; get_typeId(): string; writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class View extends SP.ClientObject { + class View extends SP.ClientObject { get_aggregations(): string; set_aggregations(value: string): void; get_aggregationsStatus(): string; @@ -4654,14 +4636,14 @@ declare namespace SP { renderAsHtml(): SP.StringResult; update(): void; } - export class ViewCollection extends SP.ClientObjectCollection { + class ViewCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.View; get_item(index: number): SP.View; getByTitle(strTitle: string): SP.View; getById(guidId: SP.Guid): SP.View; add(parameters: SP.ViewCreationInformation): SP.View; } - export class ViewCreationInformation extends SP.ClientValueObject { + class ViewCreationInformation extends SP.ClientValueObject { get_paged(): boolean; set_paged(value: boolean): void; get_personalView(): boolean; @@ -4682,7 +4664,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class ViewFieldCollection extends SP.ClientObjectCollection { + class ViewFieldCollection extends SP.ClientObjectCollection { itemAt(index: number): string; get_item(index: number): string; get_schemaXml(): string; @@ -4691,13 +4673,13 @@ declare namespace SP { remove(strField: string): void; removeAll(): void; } - export enum ViewScope { + enum ViewScope { defaultValue, recursive, recursiveAll, filesOnly, } - export enum ViewType { + enum ViewType { none, html, grid, @@ -4706,7 +4688,7 @@ declare namespace SP { chart, gantt, } - export class Web extends SP.SecurableObject { + class Web extends SP.SecurableObject { get_allowDesignerForCurrentUser(): boolean; get_allowMasterPageEditingForCurrentUser(): boolean; get_allowRevertFromTemplateForCurrentUser(): boolean; @@ -4813,12 +4795,12 @@ declare namespace SP { /** Available after March 2015 CU for SharePoint 2013*/ getList(url: string): List; } - export class WebCollection extends SP.ClientObjectCollection { + class WebCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.Web; get_item(index: number): SP.Web; add(parameters: SP.WebCreationInformation): SP.Web; } - export class WebCreationInformation extends SP.ClientValueObject { + class WebCreationInformation extends SP.ClientValueObject { get_description(): string; set_description(value: string): void; get_language(): number; @@ -4835,7 +4817,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class WebInformation extends SP.ClientObject { + class WebInformation extends SP.ClientObject { get_configuration(): number; get_created(): Date; get_description(): string; @@ -4847,10 +4829,10 @@ declare namespace SP { get_webTemplate(): string; get_webTemplateId(): number; } - export class WebProxy { + class WebProxy { static invoke(context: SP.ClientRuntimeContext, requestInfo: SP.WebRequestInfo): SP.WebResponseInfo; } - export class WebRequestInfo extends SP.ClientValueObject { + class WebRequestInfo extends SP.ClientValueObject { get_body(): string; set_body(value: string): void; get_headers(): any; @@ -4863,7 +4845,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class WebResponseInfo extends SP.ClientValueObject { + class WebResponseInfo extends SP.ClientValueObject { get_body(): string; set_body(value: string): void; get_headers(): any; @@ -4874,7 +4856,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class WebTemplate extends SP.ClientObject { + class WebTemplate extends SP.ClientObject { get_description(): string; get_displayCategory(): string; get_id(): number; @@ -4886,34 +4868,34 @@ declare namespace SP { get_name(): string; get_title(): string; } - export class WebTemplateCollection extends SP.ClientObjectCollection { + class WebTemplateCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.WebTemplate; get_item(index: number): SP.WebTemplate; getByName(name: string): SP.WebTemplate; } - export namespace Application { - export namespace UI { - export interface DefaultFormsInformationRequestor { + namespace Application { + namespace UI { + interface DefaultFormsInformationRequestor { onDefaultFormsInformationRetrieveSuccess(defaultForms: SP.Application.UI.DefaultFormsInformation): void; onDefaultFormsInformationRetrieveFailure(): void; } - export class FormsInfo { + class FormsInfo { ContentTypeName: string; NewFormUrl: string; DisplayFormUrl: string; EditFormUrl: string; constructor(); } - export class DefaultFormsInformation { + class DefaultFormsInformation { DefaultForms: SP.Application.UI.FormsInfo; OtherForms: any; constructor(); } - export class DefaultFormsMenuBuilder { + class DefaultFormsMenuBuilder { static getDefaultFormsInformation(requestor: SP.Application.UI.DefaultFormsInformationRequestor, listId: SP.Guid): void; } - export class ViewSelectorMenuOptions { + class ViewSelectorMenuOptions { showRepairView: boolean; showMergeView: boolean; showEditView: boolean; @@ -4924,10 +4906,10 @@ declare namespace SP { viewParameters: string; constructor(); } - export interface ViewInformationRequestor { + interface ViewInformationRequestor { onViewInformationReturned(viewGroups: SP.Application.UI.ViewSelectorGroups): void; } - export class ViewSelectorGroups { + class ViewSelectorGroups { ModeratedViews: any; PublicViews: any; PersonalViews: any; @@ -4936,7 +4918,7 @@ declare namespace SP { ViewCreation: any; constructor(); } - export class ViewSelectorMenuItem { + class ViewSelectorMenuItem { Text: string; ActionScriptText: string; NavigateUrl: string; @@ -4948,33 +4930,33 @@ declare namespace SP { GroupId: number; constructor(); } - export class ViewSelectorSubMenu { + class ViewSelectorSubMenu { Text: string; ImageSourceUrl: string; SubMenuItems: any; constructor(); } - export class ViewSelectorMenuBuilder { + class ViewSelectorMenuBuilder { static get_filterMenuItemsCallback(): (menuItems: any) => any; static set_filterMenuItemsCallback(value: (menuItems: any) => any): void; static showMenu(elem: HTMLElement, options: SP.Application.UI.ViewSelectorMenuOptions): void; static getViewInformation(requestor: SP.Application.UI.ViewInformationRequestor, options: SP.Application.UI.ViewSelectorMenuOptions): void; } - export class MoreColorsPicker extends Sys.UI.Control { + class MoreColorsPicker extends Sys.UI.Control { constructor(e: HTMLElement); initialize(): void; dispose(): void; get_colorValue(): string; set_colorValue(value: string): void; } - export class MoreColorsPage extends Sys.UI.Control { + class MoreColorsPage extends Sys.UI.Control { constructor(e: HTMLElement); initialize(): void; dispose(): void; get_moreColorsPicker(): SP.Application.UI.MoreColorsPicker; set_moreColorsPicker(value: SP.Application.UI.MoreColorsPicker): void; } - export class ThemeWebPage extends Sys.UI.Control { + class ThemeWebPage extends Sys.UI.Control { add_themeDisplayUpdated(value: (sender: any, e: Sys.EventArgs) => void): void; remove_themeDisplayUpdated(value: (sender: any, e: Sys.EventArgs) => void): void; constructor(e: HTMLElement); @@ -4985,7 +4967,7 @@ declare namespace SP { get_thmxThemes(): any; set_thmxThemes(value: any): void; } - export class WikiPageNameInPlaceEditor { + class WikiPageNameInPlaceEditor { constructor(ownerDoc: any, displayElemId: string, editElemId: string, editTextBoxId: string); editingPageCallback(): void; savingPageCallback(): void; @@ -4993,15 +4975,14 @@ declare namespace SP { } } - - export namespace Analytics { - export class AnalyticsUsageEntry extends SP.ClientObject { + namespace Analytics { + class AnalyticsUsageEntry extends SP.ClientObject { static logAnalyticsEvent(context: SP.ClientRuntimeContext, eventTypeId: number, itemId: string): void; static logAnalyticsEvent2(context: SP.ClientRuntimeContext, eventTypeId: number, itemId: string, rollupScopeId: SP.Guid, siteId: SP.Guid, userId: string): void; static logAnalyticsAppEvent(context: SP.ClientRuntimeContext, appEventTypeId: SP.Guid, itemId: string): void; static logAnalyticsAppEvent2(context: SP.ClientRuntimeContext, appEventTypeId: SP.Guid, itemId: string, rollupScopeId: SP.Guid, siteId: SP.Guid, userId: string): void; } - export enum EventTypeId { + enum EventTypeId { none, first, view, @@ -5011,8 +4992,8 @@ declare namespace SP { } } - export namespace SiteHealth { - export class SiteHealthResult extends SP.ClientValueObject { + namespace SiteHealth { + class SiteHealthResult extends SP.ClientValueObject { get_messageAsText(): string; get_ruleHelpLink(): string; get_ruleId(): SP.Guid; @@ -5026,29 +5007,24 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export enum SiteHealthStatusType { + enum SiteHealthStatusType { passed, failedWarning, failedError, } - export class SiteHealthSummary extends SP.ClientObject { + class SiteHealthSummary extends SP.ClientObject { get_failedErrorCount(): number; get_failedWarningCount(): number; get_passedCount(): number; get_results(): SP.SiteHealth.SiteHealthResult[]; } } - } - - - declare namespace Microsoft.SharePoint.Client.Search { namespace Query { - /**Contains information common to all types of search queries.*/ - export class Query extends SP.ClientObject { + class Query extends SP.ClientObject { get_blockDedupeMode: () => number; set_blockDedupeMode: (value: number) => void; @@ -5155,24 +5131,19 @@ declare namespace Microsoft.SharePoint.Client.Search { get_trimDuplicates: () => boolean; set_trimDuplicates: (value: boolean) => void; - get_uiLanguage: () => number; set_uiLanguage: (value: number) => void; - - getQuerySuggestionsWithResults: (iNumberOfQuerySuggestions: number, iNumberOfResultSuggestions: number, fPreQuerySuggestions: boolean, fHitHighlighting: boolean, fCapitalizeFirstLetters: boolean, fPrefixMatchAllTerms: boolean) => QuerySuggestionResults; - - } /**Contains information about a keyword based search query.*/ - export class KeywordQuery extends Query { + class KeywordQuery extends Query { constructor(context: SP.ClientContext); get_collapseSpecification: () => string; @@ -5205,7 +5176,7 @@ declare namespace Microsoft.SharePoint.Client.Search { } /**Executes queries against a search server.*/ - export class SearchExecutor extends SP.ClientObject { + class SearchExecutor extends SP.ClientObject { constructor(context: SP.ClientContext); /**Runs a query.*/ @@ -5224,8 +5195,7 @@ declare namespace Microsoft.SharePoint.Client.Search { exportPopularQueries: (web: SP.Web, sourceId: SP.Guid) => SP.JsonObjectResult; } - - export class StringCollection extends SP.ClientObjectCollection { + class StringCollection extends SP.ClientObjectCollection { constructor(context: SP.ClientContext); itemAt: (index: number) => string; get_item: (index: number) => string; @@ -5234,11 +5204,11 @@ declare namespace Microsoft.SharePoint.Client.Search { clear: () => void; } - export class QueryPersonalizationData extends SP.ClientObject { + class QueryPersonalizationData extends SP.ClientObject { // It's really empty; } - export class QuerySuggestionResults extends SP.ClientValueObject { + class QuerySuggestionResults extends SP.ClientValueObject { get_peopleNames: () => string[]; set_peopleNames: (value: string[]) => void; @@ -5249,7 +5219,7 @@ declare namespace Microsoft.SharePoint.Client.Search { set_queries: (value: QuerySuggestionQuery[]) => void; } - export class PersonalResultSuggestion extends SP.ClientValueObject { + class PersonalResultSuggestion extends SP.ClientValueObject { get_highlightedTitle: () => string; set_highlightedTitle: (value: string) => void; @@ -5263,7 +5233,7 @@ declare namespace Microsoft.SharePoint.Client.Search { set_url: (value: string) => void; } - export class QuerySuggestionQuery extends SP.ClientValueObject { + class QuerySuggestionQuery extends SP.ClientValueObject { get_isPersonal: () => boolean; set_isPersonal: (value: boolean) => void; @@ -5271,14 +5241,14 @@ declare namespace Microsoft.SharePoint.Client.Search { set_query: (value: string) => void; } - export class KeywordQueryProperties extends SP.ClientObject { + class KeywordQueryProperties extends SP.ClientObject { get_item: (key: string) => any; set_item: (key: string, value: any) => void; setQueryPropertyValue: (name: string) => QueryPropertyValue; getQueryPropertyValue: (name: string, value: QueryPropertyValue) => void; } - export enum QueryPropertyValueType { + enum QueryPropertyValueType { none, stringType, int32TYpe, @@ -5287,7 +5257,7 @@ declare namespace Microsoft.SharePoint.Client.Search { unSupportedType } - export class QueryPropertyValue extends SP.ClientValueObject { + class QueryPropertyValue extends SP.ClientValueObject { get_boolVal: () => boolean; set_boolVal: (value: boolean) => boolean; @@ -5301,12 +5271,12 @@ declare namespace Microsoft.SharePoint.Client.Search { set_strVal: (value: string) => string; } - export class QueryUtility { + class QueryUtility { static create: (name: string, val: any) => QueryPropertyValue; static getQueryPropertyValueType: (val: QueryPropertyValue) => QueryPropertyValueType; static queryPropertyValueToObject: (val: QueryPropertyValue) => any; } - export class ReorderingRuleCollection extends SP.ClientObjectCollection { + class ReorderingRuleCollection extends SP.ClientObjectCollection { itemAt: (index: number) => ReorderingRule; get_item: (index: number) => ReorderingRule; get_childItemType: () => typeof ReorderingRule; @@ -5314,7 +5284,7 @@ declare namespace Microsoft.SharePoint.Client.Search { clear: () => void; } - export enum ReorderingRuleMatchType { + enum ReorderingRuleMatchType { resultContainsKeyword, titleContainsKeyword, titleMatchesKeyword, @@ -5326,7 +5296,7 @@ declare namespace Microsoft.SharePoint.Client.Search { manualCondition } - export class ReorderingRule extends SP.ClientValueObject { + class ReorderingRule extends SP.ClientValueObject { get_boost: () => number; set_boost: (value: number) => void; @@ -5337,7 +5307,7 @@ declare namespace Microsoft.SharePoint.Client.Search { set_matchValue: (value: string) => void; } - export class SortCollection extends SP.ClientObjectCollection { + class SortCollection extends SP.ClientObjectCollection { itemAt: (index: number) => Sort; get_item: (index: number) => Sort; get_childItemType: () => typeof Sort; @@ -5350,7 +5320,7 @@ declare namespace Microsoft.SharePoint.Client.Search { descending, fqlFormula } - export class Sort extends SP.ClientValueObject { + class Sort extends SP.ClientValueObject { get_direction: () => SortDirection; set_direction: (value: SortDirection) => void; @@ -5358,8 +5328,7 @@ declare namespace Microsoft.SharePoint.Client.Search { set_property: (value: string) => void; } - - export class ResultTableCollection extends SP.ClientValueObjectCollection { + class ResultTableCollection extends SP.ClientValueObjectCollection { get_item: (index: number) => ResultTable; get_elapsedTime: () => number; @@ -5376,10 +5345,9 @@ declare namespace Microsoft.SharePoint.Client.Search { get_triggeredRules: () => SP.Guid[]; initPropertiesFromJson: (parentNode: any) => void; - } - export class ResultTable extends SP.ClientValueObject { + class ResultTable extends SP.ClientValueObject { get_groupTemplateId: () => string; get_itemTemplateId: () => string; @@ -5407,14 +5375,14 @@ declare namespace Microsoft.SharePoint.Client.Search { initPropertiesFromJson: (parentNode: any) => void; } - export class RankingLabeling extends SP.ClientObject { + class RankingLabeling extends SP.ClientObject { constructor(context: SP.ClientContext); getJudgementsForQuery: (query: string) => SP.JsonObjectResult; addJudgment: (userQuery: string, url: string, labelId: number) => void; normalizeResultUrl: (url: string) => SP.JsonObjectResult; } - export class PopularQuery extends SP.ClientValueObject { + class PopularQuery extends SP.ClientValueObject { get_clickCount: () => number; set_clickCount: (value: number) => void; @@ -5428,7 +5396,7 @@ declare namespace Microsoft.SharePoint.Client.Search { set_queryText: (value: string) => void; } - export class QueryPropertyNames { + class QueryPropertyNames { static blockDedupeMode: string; // 'BlockDedupeMode'; static bypassResultTypes: string; // 'BypassResultTypes'; static clientType: string; // 'ClientType'; @@ -5466,12 +5434,12 @@ declare namespace Microsoft.SharePoint.Client.Search { static uiLanguage: string; // 'UILanguage'; } - export class QueryObjectPropertyNames { + class QueryObjectPropertyNames { static hitHighlightedProperties: string; // = 'HitHighlightedProperties'; static personalizationData: string; // = 'PersonalizationData'; } - export class KeywordQueryPropertyNames { + class KeywordQueryPropertyNames { static collapseSpecification: string; // 'CollapseSpecification'; static enableSorting: string; // 'EnableSorting'; static hiddenConstraints: string; // 'HiddenConstraints'; @@ -5479,7 +5447,7 @@ declare namespace Microsoft.SharePoint.Client.Search { static trimDuplicatesIncludeId: string; // 'TrimDuplicatesIncludeId'; } - export class KeywordQueryObjectPropertyNames { + class KeywordQueryObjectPropertyNames { static properties: string; // 'Properties'; static refinementFilters: string; // 'RefinementFilters'; static reorderingRules: string; // 'ReorderingRules'; @@ -5489,7 +5457,7 @@ declare namespace Microsoft.SharePoint.Client.Search { } namespace WebControls { - export class ControlMessage extends SP.ClientValueObject { + class ControlMessage extends SP.ClientValueObject { get_code: () => number; get_correlationID: () => string; @@ -5515,7 +5483,7 @@ declare namespace Microsoft.SharePoint.Client.Search { get_type: () => string; } - export enum MessageLevel { + enum MessageLevel { information, warning, error @@ -5523,7 +5491,7 @@ declare namespace Microsoft.SharePoint.Client.Search { } namespace Administration { - export class DocumentCrawlLog extends SP.ClientObject { + class DocumentCrawlLog extends SP.ClientObject { constructor(context: SP.ClientContext, site: SP.Site); getCrawledUrls: (getCountOnly: boolean, maxRows: { High: number; Low: number; }, @@ -5536,11 +5504,11 @@ declare namespace Microsoft.SharePoint.Client.Search { endDateTime: Date) => SP.JsonObjectResult; } - export class SearchObjectOwner extends SP.ClientObject { + class SearchObjectOwner extends SP.ClientObject { constructor(context: SP.ClientContext, lowestCurrentLevelToUse: SearchObjectLevel); } - export enum SearchObjectLevel { + enum SearchObjectLevel { spWeb, spSite, spSiteSubscription, @@ -5549,7 +5517,7 @@ declare namespace Microsoft.SharePoint.Client.Search { } namespace Portability { - export class SearchConfigurationPortability extends SP.ClientObject { + class SearchConfigurationPortability extends SP.ClientObject { constructor(context: SP.ClientContext); get_importWarnings: () => string; @@ -5560,14 +5528,14 @@ declare namespace Microsoft.SharePoint.Client.Search { deleteSearchConfiguration: (owningScope: Administration.SearchObjectOwner, searchConfiguration: string) => void; } - export class SearchConfigurationPortabilityPropertyNames { + class SearchConfigurationPortabilityPropertyNames { static importWarnings: string; // = 'ImportWarnings' } } /**Located in sp.search.apps.js*/ namespace Analytics { - export class AnalyticsItemData extends SP.ClientObject { + class AnalyticsItemData extends SP.ClientObject { get_lastProcessingTime: () => Date; get_totalHits: () => number; @@ -5583,7 +5551,7 @@ declare namespace Microsoft.SharePoint.Client.Search { getUniqueUsersCountForMonth: (day: Date) => number; } - export class UsageAnalytics extends SP.ClientObject { + class UsageAnalytics extends SP.ClientObject { getAnalyticsItemData: (eventType: number, listItem: SP.ListItem) => AnalyticsItemData; getAnalyticsItemDataForApplicationEventType: (appEventType: SP.Guid, listItem: SP.ListItem) => AnalyticsItemData; @@ -5592,15 +5560,12 @@ declare namespace Microsoft.SharePoint.Client.Search { deleteCustomEventUsageData: (appEventTypeId: SP.Guid) => void; } - - - } } declare namespace SP { - export namespace BusinessData { - export class AppBdcCatalog extends SP.ClientObject { + namespace BusinessData { + class AppBdcCatalog extends SP.ClientObject { getEntity(namespace: string, name: string): SP.BusinessData.Entity; getLobSystemProperty(lobSystemName: string, propertyName: string): SP.StringResult; setLobSystemProperty(lobSystemName: string, propertyName: string, propertyValue: string): void; @@ -5610,7 +5575,7 @@ declare namespace SP { setConnectionId(lobSystemName: string, lobSystemInstanceName: string, connectionId: string): void; getPermissibleConnections(): string[]; } - export class Entity extends SP.ClientObject { + class Entity extends SP.ClientObject { get_estimatedInstanceCount(): number; get_name(): string; get_namespace(): string; @@ -5635,20 +5600,20 @@ declare namespace SP { subscribe(eventType: SP.BusinessData.Runtime.EntityEventType, notificationCallback: SP.BusinessData.Runtime.NotificationCallback, onBehalfOfUser: string, subscriberName: string, lobSystemInstance: SP.BusinessData.LobSystemInstance): SP.BusinessData.Runtime.Subscription; unsubscribe(subscription: SP.BusinessData.Runtime.Subscription, onBehalfOfUser: string, unsubscriberName: string, lobSystemInstance: SP.BusinessData.LobSystemInstance): void; } - export class EntityField extends SP.ClientObject { + class EntityField extends SP.ClientObject { get_containsLocalizedDisplayName(): boolean; get_defaultDisplayName(): string; get_localizedDisplayName(): string; get_name(): string; } - export class EntityIdentifier extends SP.ClientObject { + class EntityIdentifier extends SP.ClientObject { get_identifierType(): string; get_name(): string; getDefaultDisplayName(): SP.StringResult; containsLocalizedDisplayName(): SP.BooleanResult; getLocalizedDisplayName(): SP.StringResult; } - export class EntityView extends SP.ClientObject { + class EntityView extends SP.ClientObject { get_fields(): SP.BusinessData.Collections.EntityFieldCollection; get_name(): string; get_relatedSpecificFinderName(): string; @@ -5657,7 +5622,7 @@ declare namespace SP { getTypeDescriptor(fieldDotNotation: string): SP.BusinessData.TypeDescriptor; getType(fieldDotNotation: string): SP.StringResult; } - export class Filter extends SP.ClientObject { + class Filter extends SP.ClientObject { get_defaultDisplayName(): string; get_filterField(): string; get_filterType(): string; @@ -5665,21 +5630,21 @@ declare namespace SP { get_name(): string; get_valueCount(): number; } - export class LobSystem extends SP.ClientObject { + class LobSystem extends SP.ClientObject { get_name(): string; getLobSystemInstances(): SP.BusinessData.Collections.LobSystemInstanceCollection; } - export class LobSystemInstance extends SP.ClientObject { + class LobSystemInstance extends SP.ClientObject { get_name(): string; } - export class MethodExecutionResult extends SP.ClientObject { + class MethodExecutionResult extends SP.ClientObject { get_returnParameterCollection(): SP.BusinessData.ReturnParameterCollection; } - export class ReturnParameterCollection extends SP.ClientObjectCollection { + class ReturnParameterCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.BusinessData.Runtime.EntityFieldValueDictionary; get_item(index: number): SP.BusinessData.Runtime.EntityFieldValueDictionary; } - export class TypeDescriptor extends SP.ClientObject { + class TypeDescriptor extends SP.ClientObject { get_containsReadOnly(): boolean; get_isCollection(): boolean; get_isReadOnly(): boolean; @@ -5693,50 +5658,50 @@ declare namespace SP { getChildTypeDescriptors(): SP.BusinessData.Collections.TypeDescriptorCollection; getParentTypeDescriptor(): SP.BusinessData.TypeDescriptor; } - export namespace Collections { - export class EntityFieldCollection extends SP.ClientObjectCollection { + namespace Collections { + class EntityFieldCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.BusinessData.EntityField; get_item(index: number): SP.BusinessData.EntityField; } - export class EntityIdentifierCollection extends SP.ClientObjectCollection { + class EntityIdentifierCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.BusinessData.EntityIdentifier; get_item(index: number): SP.BusinessData.EntityIdentifier; } - export class EntityInstanceCollection extends SP.ClientObjectCollection { + class EntityInstanceCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.BusinessData.Runtime.EntityInstance; get_item(index: number): SP.BusinessData.Runtime.EntityInstance; } - export class FilterCollection extends SP.ClientObjectCollection { + class FilterCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.BusinessData.Filter; get_item(index: number): SP.BusinessData.Filter; setFilterValue(inputFilterName: string, valueIndex: number, value: any): void; } - export class LobSystemInstanceCollection extends SP.ClientObjectCollection { + class LobSystemInstanceCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.BusinessData.LobSystemInstance; get_item(index: number): SP.BusinessData.LobSystemInstance; } - export class TypeDescriptorCollection extends SP.ClientObjectCollection { + class TypeDescriptorCollection extends SP.ClientObjectCollection { itemAt(index: number): SP.BusinessData.TypeDescriptor; get_item(index: number): SP.BusinessData.TypeDescriptor; } } - export namespace Infrastructure { - export class ExternalSubscriptionStore extends SP.ClientObject { + namespace Infrastructure { + class ExternalSubscriptionStore extends SP.ClientObject { constructor(context: SP.ClientRuntimeContext, web: SP.Web); static newObject(context: SP.ClientRuntimeContext, web: SP.Web): SP.BusinessData.Infrastructure.ExternalSubscriptionStore; indexStore(): void; } } - export namespace Runtime { - export enum EntityEventType { + namespace Runtime { + enum EntityEventType { none, itemAdded, itemUpdated, itemDeleted, } - export class EntityFieldValueDictionary extends SP.ClientObject { + class EntityFieldValueDictionary extends SP.ClientObject { get_fieldValues(): any; get_item(fieldName: string): any; set_item(fieldName: string, value: any): void; @@ -5747,7 +5712,7 @@ declare namespace SP { createCollectionInstance(fieldDotNotation: string, size: number): void; getCollectionSize(fieldDotNotation: string): SP.IntResult; } - export class EntityIdentity extends SP.ClientObject { + class EntityIdentity extends SP.ClientObject { get_fieldValues(): any; get_item(fieldName: string): any; constructor(context: SP.ClientRuntimeContext, identifierValues: any[]); @@ -5755,7 +5720,7 @@ declare namespace SP { static newObject(context: SP.ClientRuntimeContext, identifierValues: any[]): SP.BusinessData.Runtime.EntityIdentity; refreshLoad(): void; } - export class EntityInstance extends SP.ClientObject { + class EntityInstance extends SP.ClientObject { get_fieldValues(): any; get_item(fieldName: string): any; set_item(fieldName: string, value: any): void; @@ -5768,7 +5733,7 @@ declare namespace SP { fromXml(xml: string): void; toXml(): SP.StringResult; } - export class NotificationCallback extends SP.ClientObject { + class NotificationCallback extends SP.ClientObject { constructor(context: SP.ClientRuntimeContext, notificationEndpoint: string); get_notificationContext(): string; set_notificationContext(value: string): void; @@ -5777,7 +5742,7 @@ declare namespace SP { set_notificationForwarderType(value: string): void; static newObject(context: SP.ClientRuntimeContext, notificationEndpoint: string): SP.BusinessData.Runtime.NotificationCallback; } - export class Subscription extends SP.ClientObject { + class Subscription extends SP.ClientObject { constructor(context: SP.ClientRuntimeContext, id: any, hash: string); get_hash(): string; get_iD(): any; @@ -5788,19 +5753,19 @@ declare namespace SP { } declare namespace SP { - export namespace Sharing { - export class DocumentSharingManager { + namespace Sharing { + class DocumentSharingManager { static getRoleDefinition(context: SP.ClientRuntimeContext, role: SP.Sharing.Role): SP.RoleDefinition; static isDocumentSharingEnabled(context: SP.ClientRuntimeContext, list: SP.List): SP.BooleanResult; static updateDocumentSharingInfo(context: SP.ClientRuntimeContext, resourceAddress: string, userRoleAssignments: SP.Sharing.UserRoleAssignment[], validateExistingPermissions: boolean, additiveMode: boolean, sendServerManagedNotification: boolean, customMessage: string, includeAnonymousLinksInNotification: boolean): SP.Sharing.UserSharingResult[]; } - export enum Role { + enum Role { none, view, edit, owner, } - export class UserRoleAssignment extends SP.ClientValueObject { + class UserRoleAssignment extends SP.ClientValueObject { get_role(): SP.Sharing.Role; set_role(value: SP.Sharing.Role): void; get_userId(): string; @@ -5809,7 +5774,7 @@ declare namespace SP { writeToXml(writer: SP.XmlWriter, serializationContext: SP.SerializationContext): void; constructor(); } - export class UserSharingResult extends SP.ClientValueObject { + class UserSharingResult extends SP.ClientValueObject { get_allowedRoles(): SP.Sharing.Role[]; get_currentRole(): SP.Sharing.Role; get_isUserKnown(): boolean; @@ -5821,21 +5786,19 @@ declare namespace SP { constructor(); } } - } declare namespace SP { - - export namespace Social { + namespace Social { /** Identifies an actor as a user, document, site, or tag. */ - export enum SocialActorType { + enum SocialActorType { user, document, site, tag } /** Specifies one or more actor types in a query to the server. */ - export enum SocialActorTypes { + enum SocialActorTypes { none, users, documents, @@ -5846,21 +5809,21 @@ declare namespace SP { all } /** Specifies whether the action is to navigate to the attachment or to perform some action dependent on the context in which the attachment is presented to the user. */ - export enum SocialAttachmentActionKind { + enum SocialAttachmentActionKind { /** This value specifies that the action is to navigate to the attachment. */ navigate, /** This value specifies that the action is dependent on the context that the attachment is displayed to the user. */ adHocAction } - export enum SocialAttachmentKind { + enum SocialAttachmentKind { image, video, document } /** Specifies whether the item being inserted is a user, document, site, tag, or link. */ - export enum SocialDataItemType { + enum SocialDataItemType { user, document, site, @@ -5869,19 +5832,19 @@ declare namespace SP { } /** Specifies whether the overlay is a link or one or more actors. */ - export enum SocialDataOverlayType { + enum SocialDataOverlayType { link, actors } /** Specifies whether the sort order is by creation time or modification time. */ - export enum SocialFeedSortOrder { + enum SocialFeedSortOrder { byModifiedTime, byCreatedTime } /** Identifies the kind of post to be retrieved. */ - export enum SocialFeedType { + enum SocialFeedType { personal, news, timeline, @@ -5890,7 +5853,7 @@ declare namespace SP { } // For some reasons this enum doesn't exist - // export enum SocialFollowResult { + // enum SocialFollowResult { // ok = 0, // alreadyFollowing = 1, // limitReached = 2, @@ -5899,13 +5862,13 @@ declare namespace SP { /** Provides information about the feed. This type provides information about whether the feed on the server contains additional threads that were not returned. */ - export enum SocialFeedAttributes { + enum SocialFeedAttributes { none, moreThreadsAvailable } /** Specifies attributes of the post, such as whether the current user can like or delete the post. */ - export enum SocialPostAttributes { + enum SocialPostAttributes { none, canLike, canDelete, @@ -5916,7 +5879,7 @@ declare namespace SP { /** Defines the type of item being specified in the SocialPostDefinitionDataItem. This type is only available in server-to-server calls. */ - export enum SocialPostDefinitionDataItemType { + enum SocialPostDefinitionDataItemType { text, user, document, @@ -5925,13 +5888,13 @@ declare namespace SP { link } - export enum SocialPostType { + enum SocialPostType { root, reply } /** Specifies a status or error code. */ - export enum SocialStatusCode { + enum SocialStatusCode { OK, /** This value specifies that an invalid request was encountered. */ invalidRequest, @@ -5962,7 +5925,7 @@ declare namespace SP { } /** Specifies properties of the thread. */ - export enum SocialThreadAttributes { + enum SocialThreadAttributes { none, isDigest, canReply, @@ -5971,7 +5934,7 @@ declare namespace SP { replyLimitReached } - export enum SocialThreadType { + enum SocialThreadType { normal, likeReference, replyReference, @@ -5980,7 +5943,7 @@ declare namespace SP { } /** Contains information about an actor retrieved from server. An actor is a user, document, site, or tag. */ - export class SocialActor extends SP.ClientValueObject { + class SocialActor extends SP.ClientValueObject { /** The AccountName property returns the user account name. This property is only available for social actors of type "user". */ get_accountName(): string; @@ -6026,7 +5989,7 @@ declare namespace SP { } /** Identifies an actor to the server. An actor can be a user, document, site, or tag. */ - export class SocialActorInfo extends SP.ClientValueObject { + class SocialActorInfo extends SP.ClientValueObject { /** User account name. This property is only available for social actors of type "user". */ get_accountName(): string; @@ -6056,7 +6019,7 @@ declare namespace SP { } /** Represents an image, document preview, or video preview attachment. */ - export class SocialAttachment extends SP.ClientValueObject { + class SocialAttachment extends SP.ClientValueObject { /** Specifies the type of object that the attachment contains. */ get_attachmentKind(): SocialAttachmentKind; /** Specifies the type of object that the attachment contains. */ @@ -6103,7 +6066,7 @@ declare namespace SP { set_width(value: number): number; } /** Specifies the user actions that are allowed for the attachment object. */ - export class SocialAttachmentAction extends SP.ClientValueObject { + class SocialAttachmentAction extends SP.ClientValueObject { /** Specifies whether the action is to navigate to a URI or an action that is dependent on the context in which the object is presented to the user. */ get_actionKind(): SocialAttachmentActionKind; /** Specifies whether the action is to navigate to a URI or an action that is dependent on the context in which the object is presented to the user. */ @@ -6117,7 +6080,7 @@ declare namespace SP { /** Defines a user, document, site, tag, or link to be inserted in a new post. The SocialPostCreationData class defines the content text that contains substitution strings. Each substitution string is replaced by a SocialDataItem value. */ - export class SocialDataItem extends SP.ClientValueObject { + class SocialDataItem extends SP.ClientValueObject { /** Identifies the user. */ get_accountName(): string; /** Identifies the user. */ @@ -6144,7 +6107,7 @@ declare namespace SP { An overlay is a substring in a post that represents a user, document, site, tag, or link. The SocialPost class contains an array of SocialDataOverlay objects. Each of the SocialDataOverlay objects specifies a link or one or more actors. */ - export class SocialDataOverlay extends SP.ClientValueObject { + class SocialDataOverlay extends SP.ClientValueObject { /** Specifies one or more actors as an array of integers where each integer specifies an index into the SocialThreadActors array. This property is only available if the get_overlayType() has a value of SocialDataOverlayType.actors. */ get_actorIndexes(): number[]; @@ -6160,7 +6123,7 @@ declare namespace SP { } /** Specifies information about errors that the server has encountered. */ - export class SocialExceptionDetails extends SP.ClientValueObject { + class SocialExceptionDetails extends SP.ClientValueObject { get_internalErrorCode(): number; get_internalMessage(): string; get_internalStackTrace(): string; @@ -6170,7 +6133,7 @@ declare namespace SP { } /** Specifies a feed, which contains an array of SocialThreads, each of which specifies a root SocialPost object and an array of response SocialPost objects. */ - export class SocialFeed extends SP.ClientValueObject { + class SocialFeed extends SP.ClientValueObject { /** Specifies attributes of the returned feed. The attributes specify if the requested feed has additional threads that were not included in the returned thread. */ get_attributes(): SocialFeedAttributes; @@ -6190,7 +6153,7 @@ declare namespace SP { /** Provides access to social feeds. It provides methods to create posts, delete posts, read posts, and perform other operations on posts. */ - export class SocialFeedManager extends SP.ClientObject { + class SocialFeedManager extends SP.ClientObject { constructor(context: SP.ClientRuntimeContext); /** Returns the current user */ get_owner(): SocialActor; @@ -6260,7 +6223,7 @@ declare namespace SP { getPreviewImage(url: string, key: string, iv: string): any; } - export class SocialFeedOptions extends SP.ClientObject { + class SocialFeedOptions extends SP.ClientObject { get_maxThreadCount(): number; set_maxThreadCount(value: number): number; get_newerThan(): string; @@ -6273,7 +6236,7 @@ declare namespace SP { /** Provides properties and methods for managing a user's list of followed actors. Actors can be users, documents, sites, and tags. */ - export class SocialFollowingManager extends SP.ClientObject { + class SocialFollowingManager extends SP.ClientObject { constructor(context: SP.ClientRuntimeContext); /** URI to a site that lists the current user's followed documents. */ get_followedDocumentsUri(): string; @@ -6297,7 +6260,7 @@ declare namespace SP { /** Defines a link that includes a URI and text representation. This class is used to represent the location of a web site. */ - export class SocialLink extends SP.ClientValueObject { + class SocialLink extends SP.ClientValueObject { get_text(): string; set_text(value: string): string; get_uri(): string; @@ -6305,7 +6268,7 @@ declare namespace SP { } /** Specifies a post read from the server. */ - export class SocialPost extends SP.ClientValueObject { + class SocialPost extends SP.ClientValueObject { /** Specifies an image, document preview, or video preview attachment */ get_attachment(): SocialAttachment; /** Describes attributes about the post, such as whether the current user can delete or like the post. */ @@ -6333,7 +6296,7 @@ declare namespace SP { } /** Specifies a set of users, documents, sites, and tags by an index into the SocialThreadActors array */ - export class SocialPostActorInfo extends SP.ClientValueObject { + class SocialPostActorInfo extends SP.ClientValueObject { get_includesCurrentUser(): boolean; /** Specifies an array of indexes into the SocialThreadActors array. The server can choose to return a limited set of actors. For example, the server can choose to return a subset of the users that like a post. */ @@ -6343,7 +6306,7 @@ declare namespace SP { /** Specifies the content of a post in the SocialFeedManager.createPost method. The post consists of a text message, which can optionally include social tags, mentions of users, and links. */ - export class SocialPostCreationData extends SP.ClientValueObject { + class SocialPostCreationData extends SP.ClientValueObject { /** Specifies an image, document preview, or video preview to be used in the post. */ get_attachment(): SocialAttachment; /** Specifies an image, document preview, or video preview to be used in the post. */ @@ -6382,7 +6345,7 @@ declare namespace SP { /** Provides additional information about server-generated posts. This type can only be specified in a server-to-server call. */ - export class SocialPostDefinitionData extends SP.ClientValueObject { + class SocialPostDefinitionData extends SP.ClientValueObject { get_items(): SocialPostDefinitionDataItem[]; set_items(value: SocialPostDefinitionDataItem[]): SocialPostDefinitionDataItem[]; get_name(): string; @@ -6391,7 +6354,7 @@ declare namespace SP { /** Specifies an item to be inserted in a post by replacing a token in the post definition. This type can only be specified in a server-to-server call. */ - export class SocialPostDefinitionDataItem extends SP.ClientValueObject { + class SocialPostDefinitionDataItem extends SP.ClientValueObject { /** Specifies the name of the user. This property is only used if the ItemType property specifies that the item is a User. */ get_accountName(): string; @@ -6426,7 +6389,7 @@ declare namespace SP { /** Specifies a reference to a post in another thread. The referenced post can be a post with a tag, a post that is liked, a post that mentions a user, or a post that is a reply. */ - export class SocialPostReference extends SP.ClientValueObject { + class SocialPostReference extends SP.ClientValueObject { /** Provides a digest of the thread containing the referenced post */ get_digest(): SocialThread; get_post(): SocialPost; @@ -6438,7 +6401,7 @@ declare namespace SP { /** Specifies a thread that is stored on the server. The thread contains a root post and zero or more reply posts. */ - export class SocialThread extends SP.ClientValueObject { + class SocialThread extends SP.ClientValueObject { /** Specifies the users who have created a post in the returned thread and also contains any users, documents, sites, and tags that are referenced in any of the posts in the returned thread. */ get_actors(): SocialActor[]; /** Specifies attributes of the thread, such as whether the current user can reply or lock the thread and whether the thread is a digest of a thread on the server, whether the number of replies has reached the maximum, and whether the thread is locked. */ @@ -6463,18 +6426,16 @@ declare namespace SP { get_threadType(): SocialThreadType; get_totalReplyCount(): number; } - } - } declare namespace SP { namespace Taxonomy { - export enum StringMatchOption { + enum StringMatchOption { startsWith, exactMatch } - export enum ChangeItemType { + enum ChangeItemType { unknown, term, termSet, @@ -6483,7 +6444,7 @@ declare namespace SP { site } - export enum ChangeOperationType { + enum ChangeOperationType { unknown, add, edit, @@ -6496,8 +6457,7 @@ declare namespace SP { restore } - - export class TaxonomySession extends SP.ClientObject { + class TaxonomySession extends SP.ClientObject { static getTaxonomySession(context: SP.ClientContext): TaxonomySession; get_offlineTermStoreNames(): string[]; get_termStores(): TermStoreCollection; @@ -6529,14 +6489,14 @@ declare namespace SP { getDefaultSiteCollectionTermStore(): TermStore; } - export class TermStoreCollection extends SP.ClientObjectCollection { + class TermStoreCollection extends SP.ClientObjectCollection { itemAt(index: number): TermStore; get_item(index: number): TermStore; getById(id: SP.Guid): TermStore; getByName(name: string): TermStore; } - export class TermStore extends SP.ClientObject { + class TermStore extends SP.ClientObject { get_contentTypePublishingHub(): string; get_defaultLanguage(): number; set_defaultLanguage(value: number): void; @@ -6579,7 +6539,7 @@ declare namespace SP { updateUsedTermsOnSite(currentSite: SP.Site): void; } - export class TaxonomyItem extends SP.ClientObject { + class TaxonomyItem extends SP.ClientObject { static normalizeName(context: SP.ClientContext, name: string): SP.StringResult; get_createdDate(): Date; get_id(): SP.Guid; @@ -6590,14 +6550,14 @@ declare namespace SP { deleteObject(): void; } - export class TermGroupCollection extends SP.ClientObjectCollection { + class TermGroupCollection extends SP.ClientObjectCollection { itemAt(index: number): TermGroup; get_item(index: number): TermGroup; getById(id: SP.Guid): TermGroup; getByName(name: string): TermGroup; } - export class TermGroup extends TaxonomyItem { + class TermGroup extends TaxonomyItem { get_description(): string; set_description(value: string): void; get_isSiteCollectionGroup(): boolean; @@ -6609,7 +6569,7 @@ declare namespace SP { getTermSetsWithCustomProperty(customPropertyMatchInformation: CustomPropertyMatchInformation): TermSetCollection; } - export class TermSetItem extends TaxonomyItem { + class TermSetItem extends TaxonomyItem { get_customProperties(): { [key: string]: string; }; get_customSortOrder(): string; set_customSortOrder(value: string): void; @@ -6627,14 +6587,14 @@ declare namespace SP { setCustomProperty(name: string, value: string): void; } - export class TermSetCollection extends SP.ClientObjectCollection { + class TermSetCollection extends SP.ClientObjectCollection { itemAt(index: number): TermSet; get_item(index: number): TermSet; getById(id: SP.Guid): TermSet; getByName(name: string): TermSet; } - export class TermSet extends TermSetItem { + class TermSet extends TermSetItem { get_contact(): string; set_contact(value: string): void; get_description(): string; @@ -6657,14 +6617,14 @@ declare namespace SP { move(targetGroup: TermGroup): void; } - export class TermCollection extends SP.ClientObjectCollection { + class TermCollection extends SP.ClientObjectCollection { itemAt(index: number): Term; get_item(index: number): Term; getById(id: SP.Guid): Term; getByName(name: string): Term; } - export class Term extends TermSetItem { + class Term extends TermSetItem { get_description(): string; get_isDeprecated(): boolean; get_isKeyword(): boolean; @@ -6711,14 +6671,13 @@ declare namespace SP { getPath(lcid: number): SP.StringResult; } - - export class LabelCollection extends SP.ClientObjectCollection'); } - var results = list.getItems(query); + const results = list.getItems(query); ctx.load(results); - ctx.executeQueryAsync((o, e) => { - var selected = false; + let selected = false; while (_dropdownElt.options.length) { (_dropdownElt.options as any /* TODO remove `as any` */).remove(0); } if (!_schema.Required) { - var defaultOpt = new Option(Strings.STS.L_LookupFieldNoneOption, '0', selected, selected); + const defaultOpt = new Option(Strings.STS.L_LookupFieldNoneOption, '0', selected, selected); (_dropdownElt.options as any /* TODO remove `as any` */).add(defaultOpt); selected = _selectedValue === 0; } - var isEmptyList = true; + let isEmptyList = true; - var enumerator = results.getEnumerator(); + const enumerator = results.getEnumerator(); while (enumerator.moveNext()) { - var c = enumerator.get_current(); - var id: number; - var text: string; + const c = enumerator.get_current(); + let id: number; + let text: string; if (!lookupField) { id = c.get_id(); text = c.get_item('Title'); } else { - var value = c.get_item(lookupField) as SP.FieldLookupValue; + const value = c.get_item(lookupField) as SP.FieldLookupValue; id = value.get_lookupId(); text = value.get_lookupValue(); } - var isSelected = _selectedValue === id; + const isSelected = _selectedValue === id; if (isSelected) { selected = true; } - var opt = new Option(text, id.toString(), isSelected, isSelected); + const opt = new Option(text, id.toString(), isSelected, isSelected); (_dropdownElt.options as any /* TODO remove `as any` */).add(opt); isEmptyList = false; } @@ -1134,31 +1090,26 @@ namespace CSR { OnLookupValueChanged(); } } - - }, (o, args) => { console.log(args.get_message()); }); } } - } koEditField(fieldName: string, template: string, vm: KoFieldInForm, dependencyFields?: string[]): CSR { return this.fieldEdit(fieldName, koEditField_Edit) .fieldNew(fieldName, koEditField_Edit); - function koEditField_Edit(rCtx: SPClientTemplates.RenderContext_FieldInForm) { if (rCtx == null) return ''; - var _myData = SPClientTemplates.Utility.GetFormContextForCurrentField(rCtx); + const _myData = SPClientTemplates.Utility.GetFormContextForCurrentField(rCtx); if (_myData == null || _myData.fieldSchema == null) return ''; - var elementId = _myData.fieldName + '_' + _myData.fieldSchema.Id + '_$' + _myData.fieldSchema.Type; + const elementId = _myData.fieldName + '_' + _myData.fieldSchema.Id + '_$' + _myData.fieldSchema.Type; vm.renderingContext = rCtx; - if (dependencyFields) { dependencyFields.forEach(dependencyField => { if (!vm[dependencyField]) { @@ -1170,7 +1121,6 @@ namespace CSR { }); } - if (!vm.value) { vm.value = ko.observable(); } @@ -1178,7 +1128,6 @@ namespace CSR { vm.value.subscribe(v => { _myData.updateControlValue(fieldName, v); }); _myData.registerGetValueCallback(fieldName, () => vm.value()); - _myData.registerInitCallback(fieldName, () => { ko.applyBindings(vm, $get(elementId)); }); @@ -1188,18 +1137,17 @@ namespace CSR { } computedValue(targetField: string, transform: (...values: string[]) => string, ...sourceField: string[]): CSR { - var dependentValues: { [field: string]: string } = {}; + const dependentValues: { [field: string]: string } = {}; return this.onPostRenderField(targetField, (schema: SPClientTemplates.FieldSchema_InForm, ctx: SPClientTemplates.RenderContext_FieldInForm) => { if (ctx.ControlMode === SPClientTemplates.ClientControlMode.EditForm || ctx.ControlMode === SPClientTemplates.ClientControlMode.NewForm) { - var targetControl = CSR.getControl(schema as SPClientTemplates.FieldSchema_InForm); + const targetControl = CSR.getControl(schema as SPClientTemplates.FieldSchema_InForm); sourceField.forEach((field) => { CSR.addUpdatedValueCallback(ctx, field, v => { dependentValues[field] = v; targetControl.value = transform.apply(this, sourceField.map(n => dependentValues[n] || '')); - }); }); } @@ -1216,7 +1164,6 @@ namespace CSR { } } - autofill(fieldName: string, init: (ctx: AutoFillFieldContext) => () => void): CSR { return this .fieldNew(fieldName, SPFieldLookup_Autofill_Edit) @@ -1225,17 +1172,17 @@ namespace CSR { function SPFieldLookup_Autofill_Edit(rCtx: SPClientTemplates.RenderContext_FieldInForm) { if (rCtx == null) return ''; - var _myData = SPClientTemplates.Utility.GetFormContextForCurrentField(rCtx); + const _myData = SPClientTemplates.Utility.GetFormContextForCurrentField(rCtx); if (_myData == null || _myData.fieldSchema == null) return ''; - var _autoFillControl: SPClientAutoFill; - var _textInputElt: HTMLInputElement; - var _textInputId = _myData.fieldName + '_' + _myData.fieldSchema.Id + '_$' + _myData.fieldSchema.Type + 'Field'; - var _autofillContainerId = _myData.fieldName + '_' + _myData.fieldSchema.Id + '_$AutoFill'; + let _autoFillControl: SPClientAutoFill; + let _textInputElt: HTMLInputElement; + const _textInputId = _myData.fieldName + '_' + _myData.fieldSchema.Id + '_$' + _myData.fieldSchema.Type + 'Field'; + const _autofillContainerId = _myData.fieldName + '_' + _myData.fieldSchema.Id + '_$AutoFill'; - var validators = new SPClientForms.ClientValidation.ValidatorSet(); + const validators = new SPClientForms.ClientValidation.ValidatorSet(); if (_myData.fieldSchema.Required) { validators.RegisterValidator(new SPClientForms.ClientValidation.RequiredValidator()); } @@ -1259,7 +1206,7 @@ namespace CSR { SP.SOD.executeFunc("autofill.js", "SPClientAutoFill", () => { _autoFillControl = new SPClientAutoFill(_textInputId, _autofillContainerId, (_) => callback()); - var callback = init({ + const callback = init({ renderContext: rCtx, fieldContext: _myData, autofill: _autoFillControl, @@ -1270,10 +1217,8 @@ namespace CSR { // _autoFillControl.VisibleItemCount = 15; // _autoFillControl.AutoFillTimeout = 500; }); - } // function OnPopulate(targetElement: HTMLInputElement) { - // } // function OnLookupValueChanged() { @@ -1283,7 +1228,7 @@ namespace CSR { // return _valueStr; // } function buildAutoFillControl() { - var result: string[] = []; + const result: string[] = []; result.push('
'); result.push(''); @@ -1293,21 +1238,19 @@ namespace CSR { return result.join(""); } } - - } seachLookup(fieldName: string): CSR { return this.autofill(fieldName, (ctx: AutoFillFieldContext) => { - var _myData = ctx.fieldContext; - var _schema = _myData.fieldSchema as SPClientTemplates.FieldSchema_InForm_Lookup; + const _myData = ctx.fieldContext; + const _schema = _myData.fieldSchema as SPClientTemplates.FieldSchema_InForm_Lookup; if (_myData.fieldSchema.Type !== 'Lookup') { return null; } - var _valueStr = _myData.fieldValue != null ? _myData.fieldValue : ''; - var _selectedValue = SPClientTemplates.Utility.ParseLookupValue(_valueStr); - var _noValueSelected = _selectedValue.LookupId === 0; + const _valueStr = _myData.fieldValue != null ? _myData.fieldValue : ''; + const _selectedValue = SPClientTemplates.Utility.ParseLookupValue(_valueStr); + const _noValueSelected = _selectedValue.LookupId === 0; ctx.control.value = _selectedValue.LookupValue; $addHandler(ctx.control, "blur", _ => { if (ctx.control.value === '') { @@ -1319,39 +1262,39 @@ namespace CSR { if (_noValueSelected) _myData.fieldValue = ''; - var _autoFillControl = ctx.autofill; + const _autoFillControl = ctx.autofill; _autoFillControl.AutoFillMinTextLength = 2; _autoFillControl.VisibleItemCount = 15; _autoFillControl.AutoFillTimeout = 500; return () => { - var value = ctx.control.value; + const value = ctx.control.value; _autoFillControl.PopulateAutoFill([AutoFillOptionBuilder.buildLoadingItem('Please wait...')], onSelectItem); SP.SOD.executeFunc("sp.search.js", "Microsoft.SharePoint.Client.Search.Query", () => { - var Search = Microsoft.SharePoint.Client.Search.Query; - var ctx = SP.ClientContext.get_current(); - var query = new Search.KeywordQuery(ctx); + const Search = Microsoft.SharePoint.Client.Search.Query; + const ctx = SP.ClientContext.get_current(); + const query = new Search.KeywordQuery(ctx); query.set_rowLimit(_autoFillControl.VisibleItemCount); query.set_queryText('contentclass:STS_ListItem ListID:{' + _schema.LookupListId + '} ' + value); - var selectProps = query.get_selectProperties(); + const selectProps = query.get_selectProperties(); selectProps.clear(); // TODO: Handle ShowField attribute selectProps.add('Title'); selectProps.add('ListItemId'); - var executor = new Search.SearchExecutor(ctx); - var result = executor.executeQuery(query); + const executor = new Search.SearchExecutor(ctx); + const result = executor.executeQuery(query); ctx.executeQueryAsync( () => { // TODO: Discover proper way to load collection - var tableCollection = new Search.ResultTableCollection(); + const tableCollection = new Search.ResultTableCollection(); tableCollection.initPropertiesFromJson(result.get_value()); - var relevantResults = tableCollection.get_item(0); - var rows = relevantResults.get_resultRows(); + const relevantResults = tableCollection.get_item(0); + const rows = relevantResults.get_resultRows(); - var items = []; - for (var row of rows) { + const items = []; + for (const row of rows) { items.push(AutoFillOptionBuilder.buildOptionItem(parseInt(row["ListItemId"], 10), row["Title"])); } @@ -1363,7 +1306,6 @@ namespace CSR { items.push(AutoFillOptionBuilder.buildFooterItem("Showing " + rows.length + " of" + relevantResults.get_totalRows() + " items!")); _autoFillControl.PopulateAutoFill(items, onSelectItem); - }, (sender, args) => { _autoFillControl.PopulateAutoFill([AutoFillOptionBuilder.buildFooterItem("Error executing query/ See log for details.")], onSelectItem); @@ -1373,36 +1315,36 @@ namespace CSR { }; function onSelectItem(targetInputId, item: ISPClientAutoFillData) { - var targetElement = ctx.control; + const targetElement = ctx.control; targetElement.value = item[SPClientAutoFill.DisplayTextProperty]; _selectedValue.LookupId = item[SPClientAutoFill.KeyProperty]; _selectedValue.LookupValue = item[SPClientAutoFill.DisplayTextProperty]; _myData.fieldValue = item[SPClientAutoFill.KeyProperty] + ';#' + item[SPClientAutoFill.TitleTextProperty]; _myData.updateControlValue(_myData.fieldSchema.Name, _myData.fieldValue); } - }); } lookupAddNew(fieldName: string, prompt: string, showDialog?: boolean, contentTypeId?: string): CSR { return this.onPostRenderField(fieldName, (schema: SPClientTemplates.FieldSchema_InForm_Lookup, ctx: SPClientTemplates.RenderContext_FieldInForm) => { + let control: HTMLInputElement; if (ctx.ControlMode === SPClientTemplates.ClientControlMode.EditForm || ctx.ControlMode === SPClientTemplates.ClientControlMode.NewForm) - var control = CSR.getControl(schema); + control = CSR.getControl(schema); if (control) { - var weburl = _spPageContextInfo.webServerRelativeUrl; + let weburl = _spPageContextInfo.webServerRelativeUrl; if (weburl[weburl.length - 1] === '/') { weburl = weburl.substring(0, weburl.length - 1); } - var newFormUrl = weburl + '/_layouts/listform.aspx/listform.aspx?PageType=8' + let newFormUrl = weburl + '/_layouts/listform.aspx/listform.aspx?PageType=8' + "&ListId=" + encodeURIComponent('{' + schema.LookupListId + '}'); if (contentTypeId) { newFormUrl += '&ContentTypeId=' + contentTypeId; } - var link = document.createElement('a'); + const link = document.createElement('a'); link.href = "javascript:NewItem2(event, \'" + newFormUrl + "&Source=" + encodeURIComponent(document.location.href) + "')"; link.textContent = prompt; if (control.nextElementSibling) { @@ -1433,9 +1375,8 @@ namespace CSR { } export class AutoFillOptionBuilder { - static buildFooterItem(title: string): ISPClientAutoFillData { - var item = {}; + const item = {}; item[SPClientAutoFill.DisplayTextProperty] = title; item[SPClientAutoFill.MenuOptionTypeProperty] = SPClientAutoFill.MenuOptionType.Footer; @@ -1444,8 +1385,7 @@ namespace CSR { } static buildOptionItem(id: number, title: string, displayText?: string, subDisplayText?: string): ISPClientAutoFillData { - - var item = {}; + const item = {}; item[SPClientAutoFill.KeyProperty] = id; item[SPClientAutoFill.DisplayTextProperty] = displayText || title; @@ -1457,19 +1397,18 @@ namespace CSR { } static buildSeparatorItem(): ISPClientAutoFillData { - var item = {}; + const item = {}; item[SPClientAutoFill.MenuOptionTypeProperty] = SPClientAutoFill.MenuOptionType.Separator; return item; } static buildLoadingItem(title: string): ISPClientAutoFillData { - var item = {}; + const item = {}; item[SPClientAutoFill.MenuOptionTypeProperty] = SPClientAutoFill.MenuOptionType.Loading; item[SPClientAutoFill.DisplayTextProperty] = title; return item; } - } type RenderContext = (ctx: SPClientTemplates.RenderContext) => T; /** Lightweight client-side rendering template overrides.*/ @@ -1606,7 +1545,6 @@ namespace CSR { // tslint:disable-next-line: unified-signatures fieldNew(fieldName: string, template: (ctx: SPClientTemplates.RenderContext_FieldInForm) => string): CSR; - /** Set initial value for field. @param fieldName Internal name of the field. @param value Initial value for field. @@ -1618,7 +1556,6 @@ namespace CSR { */ makeHidden(fieldName: string): CSR; - /** Replace New and Edit templates for field to Display template. @param fieldName Internal name of the field. */ @@ -1656,8 +1593,6 @@ namespace CSR { lookupAddNew(fieldName: string, prompt: string, showDialog?: boolean, contentTypeId?: string): CSR; koEditField(fieldName: string, template: string, vm: KoFieldInForm, dependencyFields?: string[]): CSR; - - } export interface AutoFillFieldContext { @@ -1672,7 +1607,6 @@ namespace CSR { value?: KnockoutObservable; } - interface FormRenderContexWithHook extends SPClientTemplates.RenderContext_FieldInForm { FormContextHook: FormContextHook; } @@ -1684,16 +1618,14 @@ namespace CSR { interface FormContextHookField { fieldSchema?: SPClientTemplates.FieldSchema_InForm; lastValue?: any; - getValue?: () => any; + getValue?(): any; updatedValueCallbacks: UpdatedValueCallback[]; } - function ensureFormContextHookField(hook: FormContextHook, fieldName: string): FormContextHookField { return hook[fieldName] = hook[fieldName] || { updatedValueCallbacks: [] }; - } class BooleanValueValidator implements SPClientForms.ClientValidation.IValidator { @@ -1703,23 +1635,17 @@ namespace CSR { return new SPClientForms.ClientValidation.ValidationResult(!this.valueGetter(), this.validationMessage); } } - } if (typeof SP === 'object' && SP && typeof SP.SOD === 'object' && SP.SOD) { SP.SOD.notifyScriptLoadedAndExecuteWaitingJobs("typescripttemplates.ts"); } - // mquery.ts - - - namespace spdevlab { export namespace mQuery { export class DynamicTable { - // private fields _domContainer: HTMLElement; _tableContainer: MQueryResultSetElements; @@ -1735,7 +1661,6 @@ namespace spdevlab { // public methods init(domContainer: HTMLElement, options) { - if (m$.isDefinedAndNotNull(options)) { m$.extend(this._options, options); } @@ -1749,7 +1674,6 @@ namespace spdevlab { // private methods _initContainers(domContainer) { - this._domContainer = domContainer; this._tableContainer = m$(this._options.tableCnt, this._domContainer); } @@ -1759,17 +1683,13 @@ namespace spdevlab { } _initEvents() { - m$(this._options.addCnt, this._domContainer).click(() => { - if (m$.isDefinedAndNotNull(this._rowTemplateContent)) { - m$(this._tableContainer).append(this._rowTemplateContent); m$("tr:last-child " + this._options.removeCnt, this._tableContainer).click((e) => { - - var targetElement = e.currentTarget as HTMLElement; - var parentRow = m$(targetElement).parents("tr").first(); + const targetElement = e.currentTarget as HTMLElement; + const parentRow = m$(targetElement).parents("tr").first(); m$(parentRow).remove(); }); @@ -1780,7 +1700,7 @@ namespace spdevlab { } _initRowTemplate() { - var templateId = m$(this._tableContainer).attr("template-id"); + const templateId = m$(this._tableContainer).attr("template-id"); if (m$.isDefinedAndNotNull(templateId)) { this._rowTemplateId = templateId; @@ -1792,8 +1712,7 @@ namespace spdevlab { static initTables() { // init templates m$('script').forEach((template: HTMLElement) => { - - var id = m$(template).attr("dynamic-table-template-id"); + const id = m$(template).attr("dynamic-table-template-id"); if (m$.isDefinedAndNotNull(id)) { DynamicTable._templates[id] = template.innerHTML; @@ -1802,18 +1721,14 @@ namespace spdevlab { // init tables m$(".spdev-rep-tb-cnt").forEach(divContainer => { - - var dynamicTable = new DynamicTable(); + const dynamicTable = new DynamicTable(); dynamicTable.init(divContainer, { removeCnt: '.spdev-rep-tb-del-override' }); }); } - }; - - } } @@ -1821,16 +1736,14 @@ m$.ready(() => { spdevlab.mQuery.DynamicTable.initTables(); }); - // whoisapppart.ts - namespace _ { - var queryString = parseQueryString(); - var isIframe = queryString['DisplayMode'] === 'iframe'; - var spHostUrl = queryString['SPHostUrl']; - var editmode = Number(queryString['editmode']); - var includeDetails = queryString['boolProp'] === 'true'; + const queryString = parseQueryString(); + const isIframe = queryString['DisplayMode'] === 'iframe'; + const spHostUrl = queryString['SPHostUrl']; + const editmode = Number(queryString['editmode']); + const includeDetails = queryString['boolProp'] === 'true'; prepareVisual(); m$.ready(() => { @@ -1844,7 +1757,7 @@ namespace _ { // Load the people picker function loadPeoplePicker(peoplePickerElementId: string) { - var schema: ISPClientPeoplePickerSchema = { + const schema: ISPClientPeoplePickerSchema = { PrincipalAccountType: "User", AllowMultipleValues: false, Width: 300, @@ -1856,20 +1769,19 @@ namespace _ { function onUserResolvedClientScript(el: string, users: ISPClientPeoplePickerEntity[]) { if (users.length > 0) { - var person = users[0]; - var accountName = person.Key; + const person = users[0]; + const accountName = person.Key; - var context = SP.ClientContext.get_current(); + const context = SP.ClientContext.get_current(); - var peopleManager = new SP.UserProfiles.PeopleManager(context); - var personProperties = peopleManager.getPropertiesFor(accountName); + const peopleManager = new SP.UserProfiles.PeopleManager(context); + const personProperties = peopleManager.getPropertiesFor(accountName); context.load(personProperties); context.executeQueryAsync((sender, args) => { - $get("basicInfo").style.display = 'block'; - var userPic = personProperties.get_userProfileProperties()["PictureURL"]; + const userPic = personProperties.get_userProfileProperties()["PictureURL"]; $get("pic").innerHTML = ' + personProperties.get_displayName() + '; $get("name").innerHTML = '' + personProperties.get_displayName() + ''; @@ -1878,9 +1790,9 @@ namespace _ { $get("department").innerHTML = person.EntityData.Department; $get("phone").innerHTML = person.EntityData.MobilePhone; - var properties = personProperties.get_userProfileProperties(); - var messageText = ""; - for (var key in properties) { + const properties = personProperties.get_userProfileProperties(); + let messageText = ""; + for (const key in properties) { if (properties.hasOwnProperty(key)) continue; messageText += "
[" + key + "]: \"" + properties[key] + "\""; @@ -1890,14 +1802,11 @@ namespace _ { if (isIframe) { partResize(); } - }, (sender, args) => { alert('Error: ' + args.get_message()); }); - } } function partProperties() { - if (editmode === 1) { $get("editmodehdr").style.display = "inline"; $get("content").style.display = "none"; @@ -1910,23 +1819,22 @@ namespace _ { } function partResize() { - var bounds = Sys.UI.DomElement.getBounds(document.body); + const bounds = Sys.UI.DomElement.getBounds(document.body); parent.postMessage('resize(' + bounds.width + ',' + bounds.height + ')', '*'); } function prepareVisual() { if (isIframe) { // Create a Link element for the defaultcss.ashx resource - var linkElement = document.createElement('link'); + const linkElement = document.createElement('link'); linkElement.setAttribute('rel', 'stylesheet'); linkElement.setAttribute('href', spHostUrl + '/_layouts/15/defaultcss.ashx'); // Add the linkElement as a child to the head section of the html document.head.appendChild(linkElement); } else { - m$.ready(() => { - var nav = new SP.UI.Controls.Navigation('navigation', { + const nav = new SP.UI.Controls.Navigation('navigation', { appIconUrl: queryString['SPHostLogo'], appTitle: document.title }); @@ -1938,13 +1846,13 @@ namespace _ { } function parseQueryString() { - var result = {}; - var qs = document.location.search.split('?')[1]; + const result = {}; + const qs = document.location.search.split('?')[1]; if (qs) { - var parts = qs.split('&'); - for (var part of parts) { + const parts = qs.split('&'); + for (const part of parts) { if (part) { - var pair = part.split('='); + const pair = part.split('='); result[pair[0]] = decodeURIComponent(pair[1]); } } @@ -1955,12 +1863,11 @@ namespace _ { // taxonomy namespace MySP { - // Class export class ClientContextPromise extends SP.ClientContext { /** To use this function, you must ensure that jQuery and CSOMPromise js files are loaded to the page */ executeQueryPromise(): JQueryPromise { - var deferred = jQuery.Deferred(); + const deferred = jQuery.Deferred(); this.executeQueryAsync(function done(sender, args) { deferred.resolve(sender, args); }, @@ -1977,20 +1884,18 @@ namespace MySP { static get_current(): ClientContextPromise { return new ClientContextPromise(_spPageContextInfo.siteServerRelativeUrl); } - } - } SP.SOD.notifyScriptLoadedAndExecuteWaitingJobs("CSOMPromise.ts"); namespace _ { - var context: MySP.ClientContextPromise; - var web: SP.Web; - var site: SP.Site; - var session: SP.Taxonomy.TaxonomySession; - var termStore: SP.Taxonomy.TermStore; - var groups: SP.Taxonomy.TermGroupCollection; + let context: MySP.ClientContextPromise; + let web: SP.Web; + let site: SP.Site; + let session: SP.Taxonomy.TaxonomySession; + let termStore: SP.Taxonomy.TermStore; + let groups: SP.Taxonomy.TermGroupCollection; // This code runs when the DOM is ready and creates a context object // which is needed to use the SharePoint object model. @@ -2033,15 +1938,15 @@ namespace _ { function onRetrieveGroups() { $('#report').children().remove(); - var groupEnum = groups.getEnumerator(); + const groupEnum = groups.getEnumerator(); // For each group, we'll build a clickable div. while (groupEnum.moveNext()) { (() => { - var currentGroup = groupEnum.get_current(); - var groupName = document.createElement("div"); + const currentGroup = groupEnum.get_current(); + const groupName = document.createElement("div"); groupName.setAttribute("style", "float:none;cursor:pointer"); - var groupID = currentGroup.get_id(); + const groupID = currentGroup.get_id(); groupName.setAttribute("id", groupID.toString()); $(groupName).click(() => showTermSets(groupID)); groupName.appendChild(document.createTextNode(currentGroup.get_name())); @@ -2056,23 +1961,22 @@ namespace _ { // do is retrieve a reference to the group with the same ID as the div, and // then add the term sets that belong to that group under the div that was clicked. function showTermSets(groupID: SP.Guid) { - // First thing is to remnove the divs under the group DIV to ensure we have a clean place to write to. // The reason we don't clear them all is becuase we want to retain the text node of the // group div. I.E. that's why we use "parentDiv.childNodes.length>1" as our loop // controller. - var parentDiv = document.getElementById(groupID.toString()); + const parentDiv = document.getElementById(groupID.toString()); while (parentDiv.childNodes.length > 1) { parentDiv.removeChild(parentDiv.lastChild); } // For each term set, we'll build a clickable div - var currentGroup = groups.getById(groupID); + const currentGroup = groups.getById(groupID); // We need to load and populate the matching group first, or the // term sets that it contains will be inaccessible to our code. context.load(currentGroup); - var termSets: SP.Taxonomy.TermSetCollection; + let termSets: SP.Taxonomy.TermSetCollection; context.executeQueryPromise() .then( () => { @@ -2096,25 +2000,23 @@ namespace _ { // group ID. We also pass in the event object, so that we can cancel the bubble // because this clickable div will be inside a parent clickable div and we // don't want the parent's event to fire. - var termSetEnum = termSets.getEnumerator(); + const termSetEnum = termSets.getEnumerator(); while (termSetEnum.moveNext()) { (() => { - var currentTermSet = termSetEnum.get_current(); - var termSetName = document.createElement("div"); + const currentTermSet = termSetEnum.get_current(); + const termSetName = document.createElement("div"); termSetName.appendChild(document.createTextNode(" + " + currentTermSet.get_name())); termSetName.setAttribute("style", "float:none;cursor:pointer;"); - var termSetID = currentTermSet.get_id(); + const termSetID = currentTermSet.get_id(); termSetName.setAttribute("id", termSetID.toString()); $(termSetName).click(e => showTerms(e, groupID, termSetID)); parentDiv.appendChild(termSetName); })(); } - }) .fail(() => parentDiv.appendChild(document.createTextNode("An error occurred in loading the term sets for this group"))); } - // This is the function that runs when the user clicks one of the divs // that we created in the showTermSets function. We can know which // div was clicked by interrogating the termSetID parameter. So what we'll @@ -2122,7 +2024,6 @@ namespace _ { // then add the term that belong to that term set under the div that was clicked. function showTerms(event: JQueryEventObject, groupID: SP.Guid, termSetID: SP.Guid) { - // First, cancel the bubble so that the group div click handler does not also fire // because that removes all term set divs and we don't want that here. event.cancelBubble = true; @@ -2130,17 +2031,17 @@ namespace _ { // Get a reference to the term set div that was click and // remove its children (apart from the TextNode that is currently // showing the term set name. - var parentDiv = document.getElementById(termSetID.toString()); + const parentDiv = document.getElementById(termSetID.toString()); while (parentDiv.childNodes.length > 1) { parentDiv.removeChild(parentDiv.lastChild); } // We need to load and populate the matching group first, or the // term sets that it contains will be inaccessible to our code. - var currentGroup = groups.getById(groupID); - var termSets: SP.Taxonomy.TermSetCollection; - var currentTermSet: SP.Taxonomy.TermSet; - var terms: SP.Taxonomy.TermCollection; + const currentGroup = groups.getById(groupID); + let termSets: SP.Taxonomy.TermSetCollection; + let currentTermSet: SP.Taxonomy.TermSet; + let terms: SP.Taxonomy.TermCollection; context.load(currentGroup); context @@ -2166,11 +2067,11 @@ namespace _ { return context.executeQueryPromise(); }) .then(() => { - var termsEnum = terms.getEnumerator(); + const termsEnum = terms.getEnumerator(); while (termsEnum.moveNext()) { - var currentTerm = termsEnum.get_current(); + const currentTerm = termsEnum.get_current(); - var term = document.createElement("div"); + const term = document.createElement("div"); term.appendChild(document.createTextNode(" - " + currentTerm.get_name())); term.setAttribute("style", "float:none;margin-left:10px;"); parentDiv.appendChild(term); @@ -2193,7 +2094,6 @@ namespace _ { $('#report').append("Failed to get session. Error: " + args.get_message()); } - // When the createTerms button is clicked, start by loading // a TaxonomySession for the current context. Also get and load // the associated term store. @@ -2205,22 +2105,21 @@ namespace _ { context.executeQueryAsync(onGetTaxonomySession, onFailTaxonomySession); } - // This function is the success callback for loading the session and store from the createTerms function function onGetTaxonomySession() { // Create six GUIDs that we will need when we create a new group, term set, and associated terms - var guidGroupValue = SP.Guid.newGuid(); - var guidTermSetValue = SP.Guid.newGuid(); - var guidTerm1 = SP.Guid.newGuid(); - var guidTerm2 = SP.Guid.newGuid(); - var guidTerm3 = SP.Guid.newGuid(); - var guidTerm4 = SP.Guid.newGuid(); + const guidGroupValue = SP.Guid.newGuid(); + const guidTermSetValue = SP.Guid.newGuid(); + const guidTerm1 = SP.Guid.newGuid(); + const guidTerm2 = SP.Guid.newGuid(); + const guidTerm3 = SP.Guid.newGuid(); + const guidTerm4 = SP.Guid.newGuid(); // Create a new group - var myGroup = termStore.createGroup("CustomTerms", guidGroupValue); + const myGroup = termStore.createGroup("CustomTerms", guidGroupValue); // Create a new term set in the newly-created group - var myTermSet = myGroup.createTermSet("Privacy", guidTermSetValue, 1033); + const myTermSet = myGroup.createTermSet("Privacy", guidTermSetValue, 1033); // Create four new terms in the newly-created term set myTermSet.createTerm("Top Secret", 1033, guidTerm1); @@ -2235,7 +2134,6 @@ namespace _ { // Execute all the preceeding statements in this function context.executeQueryAsync(onAddTerms, onFailAddTerms); - } // If all is well with creating the terms, then this function will run. @@ -2258,7 +2156,6 @@ namespace _ { $('#report').children().remove(); $('#report').append("Failed to get session. Error: " + args.get_message()); } - }; // publishing.ts @@ -2266,46 +2163,43 @@ namespace _ { JSRequest.EnsureSetup(); SP.SOD.execute('mquery.js', 'm$.ready', () => { - var context = SP.ClientContext.get_current(); - var web = context.get_web(); + const context = SP.ClientContext.get_current(); + const web = context.get_web(); m$('#CreatePage').click(createPage); }); function createPage(evt) { SP.SOD.execute('sp.js', 'SP.ClientConext', () => { SP.SOD.execute('sp.publishing.js', 'SP.Publishing', () => { - var context = SP.ClientContext.get_current(); + const context = SP.ClientContext.get_current(); - - var hostUrl = decodeURIComponent(JSRequest.QueryString["SPHostUrl"]); - var hostcontext = new SP.AppContextSite(context, hostUrl); - var web = hostcontext.get_web(); - var pubWeb = SP.Publishing.PublishingWeb.getPublishingWeb(context, web); + const hostUrl = decodeURIComponent(JSRequest.QueryString["SPHostUrl"]); + const hostcontext = new SP.AppContextSite(context, hostUrl); + const web = hostcontext.get_web(); + const pubWeb = SP.Publishing.PublishingWeb.getPublishingWeb(context, web); context.load(web); context.load(pubWeb); context.executeQueryAsync( // Success callback after getting the host Web as a PublishingWeb. // We now want to add a new Publishing Page. function done() { - var pageInfo = new SP.Publishing.PublishingPageInformation(); - var newPage = pubWeb.addPublishingPage(pageInfo); + const pageInfo = new SP.Publishing.PublishingPageInformation(); + const newPage = pubWeb.addPublishingPage(pageInfo); context.load(newPage); context.executeQueryAsync( function done() { - // Success callback after adding a new Publishing Page. // We want to get the actual list item that is represented by the Publishing Page. - var listItem = newPage.get_listItem(); + const listItem = newPage.get_listItem(); context.load(listItem); context.executeQueryAsync( - // Success callback after getting the actual list item that is // represented by the Publishing Page. // We can now get its FieldValues, one of which is its FileLeafRef value. // We can then use that value to build the Url to the new page // and set the href or our link to that Url. function done() { - var link = document.getElementById("linkToPage"); + const link = document.getElementById("linkToPage"); link.setAttribute("href", web.get_url() + "/Pages/" + listItem.get_fieldValues().FileLeafRef); link.innerText = "Go to new page!"; }, @@ -2334,13 +2228,11 @@ function createPage(evt) { // likes namespace SampleReputation { - interface MyList extends SPClientTemplates.RenderContext_InView { listId: string; } class MyItem { - id: number; title: string; likesCount: number; @@ -2355,7 +2247,7 @@ namespace SampleReputation { private getLike(likedBy): boolean { if (likedBy && likedBy.length > 0) { - for (var likedByItem of likedBy) { + for (const likedByItem of likedBy) { if (likedByItem.id === _spPageContextInfo.userId) { return true; } @@ -2383,15 +2275,14 @@ namespace SampleReputation { RegisterModuleInit('/SPTypeScript/ReputationModule/likes.js', init); }); - SP.SOD.notifyScriptLoadedAndExecuteWaitingJobs('likes.js'); } function renderTemplate(ctx: MyList) { - var rows = ctx.ListData.Row; - var result = ''; - for (var row of rows) { - var item = new MyItem(row); + const rows = ctx.ListData.Row; + let result = ''; + for (const row of rows) { + const item = new MyItem(row); result += '\
  • ' + item.title + '\ \ @@ -2407,14 +2298,14 @@ namespace SampleReputation { } export function setLike(itemId: number, listId: string): void { - var context = SP.ClientContext.get_current(); - var isLiked = m$('#likesCountText' + itemId)[0].textContent === '\u2661'; + const context = SP.ClientContext.get_current(); + const isLiked = m$('#likesCountText' + itemId)[0].textContent === '\u2661'; SP.SOD.executeFunc('reputation.js', 'Microsoft.Office.Server.ReputationModel.Reputation', function fail() { Microsoft.Office.Server.ReputationModel.Reputation.setLike(context, listId, itemId, isLiked); context.executeQueryAsync( () => { m$('#likesCountText' + itemId)[0].textContent = getLikeText(isLiked); - var likesCount = parseInt(m$('#likesCount' + itemId)[0].textContent, 10); + const likesCount = parseInt(m$('#likesCount' + itemId)[0].textContent, 10); m$('#likesCount' + itemId)[0].textContent = (isLiked ? likesCount + 1 : likesCount - 1).toString(); }, (sender, args) => { @@ -2426,12 +2317,10 @@ namespace SampleReputation { init(); } - - // code from https://github.com/gandjustas/SharePointAngularTS namespace App { "use strict"; - var app = angular.module("app", []); + const app = angular.module("app", []); } // Install the angularjs.TypeScript.DefinitelyTyped NuGet package @@ -2440,7 +2329,7 @@ namespace App { interface Iappcontroller { title: string; - activate: () => void; + activate(): void; } class appcontroller implements Iappcontroller { @@ -2454,27 +2343,24 @@ namespace App { } activate() { - var loading = this.$n.showLoading(true); + const loading = this.$n.showLoading(true); this.$SharePoint .getLists() .then(l => this.lists = l) .catch((e: string) => this.$n.show(e, true)) .finally(() => this.$n.remove(loading)); ; - } } angular.module("app").controller("appcontroller", appcontroller); } - - namespace App { "use strict"; export interface SharePoint { - getLists: () => ng.IPromise; + getLists(): ng.IPromise; } class SharePointServcie implements SharePoint { @@ -2484,18 +2370,18 @@ namespace App { } getLists() { - var promise = this.$q.defer(); + const promise = this.$q.defer(); SP.SOD.executeFunc("sp.js", "SP.ClientContext", () => { - var ctx = SP.ClientContext.get_current(); - var hostUrl = decodeURIComponent(SP.ScriptHelpers.getDocumentQueryPairs()['SPHostUrl']); - var appCtx = new SP.AppContextSite(ctx, hostUrl); - var hostWeb = appCtx.get_web(); - var lists = hostWeb.get_lists(); + const ctx = SP.ClientContext.get_current(); + const hostUrl = decodeURIComponent(SP.ScriptHelpers.getDocumentQueryPairs()['SPHostUrl']); + const appCtx = new SP.AppContextSite(ctx, hostUrl); + const hostWeb = appCtx.get_web(); + const lists = hostWeb.get_lists(); ctx.load(lists); ctx.executeQueryAsync(() => { - var result: SP.List[] = []; - for (var e = lists.getEnumerator(); e.moveNext(); /* nothing */) { + const result: SP.List[] = []; + for (const e = lists.getEnumerator(); e.moveNext(); /* nothing */) { result.push(e.get_current()); } promise.resolve(result); @@ -2509,7 +2395,6 @@ namespace App { angular.module("app").service("$SharePoint", SharePointServcie); } - // Install the angularjs.TypeScript.DefinitelyTyped NuGet package namespace App { "use strict"; @@ -2523,7 +2408,6 @@ namespace App { class NotifyImpl implements SpNotify { static $inject: string[] = []; - showLoading(sticky: boolean = false) { return SP.UI.Notify.showLoadingNotification(sticky); } @@ -2539,4 +2423,3 @@ namespace App { angular.module("app").service("$spnotify", NotifyImpl); } - From 3e49f5d2ba5d8954a0752c80a72970b840bef8dc Mon Sep 17 00:00:00 2001 From: Andy Date: Wed, 29 Mar 2017 15:33:53 -0700 Subject: [PATCH 058/844] angular: Apply new lint rules and remove redundant rules from tslint.json (#15484) --- types/angular/angular-tests.ts | 111 +++++++++++++++------------------ types/angular/index.d.ts | 11 ++-- types/angular/tslint.json | 26 ++------ 3 files changed, 60 insertions(+), 88 deletions(-) diff --git a/types/angular/angular-tests.ts b/types/angular/angular-tests.ts index b4e394aa37..637ebda708 100644 --- a/types/angular/angular-tests.ts +++ b/types/angular/angular-tests.ts @@ -62,7 +62,6 @@ angular.module('http-auth-interceptor', []) * On 401 response - it stores the request and broadcasts 'event:angular-auth-loginRequired'. */ .config(['$httpProvider', 'authServiceProvider', ($httpProvider: ng.IHttpProvider, authServiceProvider: any) => { - $httpProvider.defaults.headers.common = {Authorization: 'Bearer token'}; $httpProvider.defaults.headers.get['Authorization'] = 'Bearer token'; $httpProvider.defaults.headers.post['Authorization'] = (config: ng.IRequestConfig) => 'Bearer token'; @@ -108,7 +107,7 @@ namespace HttpAndRegularPromiseTests { $http.get('http://somewhere/some/resource') .then((response: ng.IHttpPromiseCallbackArg) => { // typing lost, so something like - // var i: number = response.data + // const i: number = response.data // would type check $scope.person = response.data; }); @@ -116,7 +115,7 @@ namespace HttpAndRegularPromiseTests { $http.get('http://somewhere/some/resource') .then((response: ng.IHttpPromiseCallbackArg) => { // typing lost, so something like - // var i: number = response.data + // const i: number = response.data // would NOT type check $scope.person = response.data; }); @@ -153,7 +152,13 @@ namespace HttpAndRegularPromiseTests { // Test for AngularJS Syntax namespace My.Namespace { - export var x: any; // need to export something for module to kick in + export const x: any = null; // need to export something for module to kick in +} + +class TestProvider implements ng.IServiceProvider { + constructor(private $scope: ng.IScope) {} + + $get() {} } // IModule Registering Test @@ -229,14 +234,6 @@ mod.value(My.Namespace); mod.decorator('name', ($scope: ng.IScope) => {}); mod.decorator('name', ['$scope', ($scope: ng.IScope) => {}]); -class TestProvider implements ng.IServiceProvider { - constructor(private $scope: ng.IScope) { - } - - $get() { - } -} - // QProvider tests angular.module('qprovider-test', []) .config(['$qProvider', ($qProvider: ng.IQProvider) => { @@ -276,8 +273,8 @@ foo.then((x) => { // Object is inferred here x.a = 123; // Try a promise - var y: ng.IPromise; - var condition: boolean; + const y: ng.IPromise = null; + const condition: boolean = null; return condition ? y : x.a; // IPromise | T, both are good for the 1st arg of .then() }).then((x) => { // x is infered to be a number, which is the resolved value of a promise @@ -299,15 +296,15 @@ namespace TestQ { g: string; h: number; } - var tResult: TResult; - var promiseTResult: angular.IPromise; - var tValue: TValue; - var promiseTValue: angular.IPromise; - var tOther: TOther; - var promiseTOther: angular.IPromise; + const tResult: TResult = null; + const promiseTResult: angular.IPromise = null; + const tValue: TValue = null; + const promiseTValue: angular.IPromise = null; + const tOther: TOther = null; + const promiseTOther: angular.IPromise = null; - var $q: angular.IQService; - var promiseAny: angular.IPromise; + const $q: angular.IQService = null; + const promiseAny: angular.IPromise = null; const assertPromiseType = (arg: angular.IPromise) => arg; @@ -346,7 +343,7 @@ namespace TestQ { let result: angular.IDeferred; result = $q.defer(); result.resolve(tResult); - var anyValue: any; + const anyValue: any = null; result.reject(anyValue); result.promise.then(result => { return $q.resolve(result); @@ -411,7 +408,7 @@ namespace TestQ { let httpFoo: ng.IHttpPromise; httpFoo.then((x) => { // When returning a promise the generic type must be inferred. - var innerPromise: ng.IPromise; + const innerPromise: ng.IPromise = null; return innerPromise; }).then((x) => { // must still be number. @@ -427,16 +424,16 @@ httpFoo.then((response: ng.IHttpPromiseCallbackArg) => { // Deferred signature tests namespace TestDeferred { - var any: any; + const any: any = null; interface TResult { a: number; b: string; c: boolean; } - var tResult: TResult; + const tResult: TResult = null; - var deferred: angular.IDeferred; + const deferred: angular.IDeferred = null; // deferred.resolve { @@ -467,7 +464,7 @@ namespace TestDeferred { } namespace TestInjector { - var $injector: angular.auto.IInjectorService; + const $injector: angular.auto.IInjectorService = null; $injector.strictDi = true; @@ -477,7 +474,7 @@ namespace TestInjector { // Promise signature tests namespace TestPromise { - var any: any; + const any: any = null; interface TResult { kind: 'result'; @@ -497,16 +494,16 @@ namespace TestPromise { return x.kind === 'result'; } - var tresult: TResult; - var tresultPromise: ng.IPromise; - var tresultHttpPromise: ng.IHttpPromise; + const tresult: TResult = null; + const tresultPromise: ng.IPromise = null; + const tresultHttpPromise: ng.IHttpPromise = null; - var tother: TOther; - var totherPromise: ng.IPromise; - var totherHttpPromise: ng.IHttpPromise; + const tother: TOther = null; + const totherPromise: ng.IPromise = null; + const totherHttpPromise: ng.IHttpPromise = null; - var promise: angular.IPromise; - var $q: angular.IQService; + const promise: angular.IPromise = null; + const $q: angular.IQService = null; const assertPromiseType = (arg: angular.IPromise) => arg; const reject = $q.reject(); @@ -608,9 +605,9 @@ namespace TestTimeout { b: string; c: boolean; } - var fnTResult: (...args: any[]) => TResult; - var promiseAny: angular.IPromise; - var $timeout: angular.ITimeoutService; + const fnTResult: (...args: any[]) => TResult = null; + const promiseAny: angular.IPromise = null; + const $timeout: angular.ITimeoutService = null; // $timeout { @@ -670,9 +667,7 @@ class SampleDirective implements ng.IDirective { return new SampleDirective(); } - link(scope: ng.IScope) { - - } + link(scope: ng.IScope) {} } class SampleDirective2 implements ng.IDirective { @@ -688,9 +683,7 @@ class SampleDirective2 implements ng.IDirective { return new SampleDirective2(); } - link(scope: ng.IScope) { - - } + link(scope: ng.IScope) {} } angular.module('SameplDirective', []).directive('sampleDirective', SampleDirective.instance).directive('sameplDirective2', SampleDirective2.instance); @@ -825,7 +818,6 @@ angular.module('docsTimeDirective', []) $scope.format = 'M/d/yy h:mm:ss a'; }]) .directive('myCurrentTime', ['$interval', 'dateFilter', ($interval: any, dateFilter: any) => { - return { link(scope: ng.IScope, element: ng.IAugmentedJQuery, attrs: ng.IAttributes) { let format: any, @@ -1030,11 +1022,10 @@ interface ICopyExampleUser { } interface ICopyExampleScope { - user: ICopyExampleUser; master: ICopyExampleUser; - update: (copyExampleUser: ICopyExampleUser) => any; - reset: () => any; + update(copyExampleUser: ICopyExampleUser): any; + reset(): any; } angular.module('copyExample', []) @@ -1055,8 +1046,7 @@ angular.module('copyExample', []) }]); namespace locationTests { - - var $location: ng.ILocationService; + const $location: ng.ILocationService = null; /* * From https://docs.angularjs.org/api/ng/service/$location @@ -1114,9 +1104,9 @@ namespace locationTests { // NgModelController function NgModelControllerTyping() { - var ngModel: angular.INgModelController; - var $http: angular.IHttpService; - var $q: angular.IQService; + const ngModel: angular.INgModelController = null; + const $http: angular.IHttpService = null; + const $q: angular.IQService = null; // See https://docs.angularjs.org/api/ng/type/ngModel.NgModelController#$validators ngModel.$validators['validCharacters'] = (modelValue, viewValue) => { @@ -1141,8 +1131,7 @@ function NgModelControllerTyping() { let $filter: angular.IFilterService; function testFilter() { - - var items: string[]; + const items: string[] = null; $filter('filter')(items, 'test'); $filter('filter')(items, {name: 'test'}); $filter('filter')(items, (val, index, array) => { @@ -1224,7 +1213,7 @@ function testCustomFilter() { } function parseTyping() { - var $parse: angular.IParseService; + const $parse: angular.IParseService = null; const compiledExp = $parse('a.b.c'); if (compiledExp.constant) { return compiledExp({}); @@ -1234,7 +1223,7 @@ function parseTyping() { } function parseWithParams() { - var $parse: angular.IParseService; + const $parse: angular.IParseService = null; const compiledExp1 = $parse('a.b.c', () => null); const compiledExp2 = $parse('a.b.c', null, false); } @@ -1255,7 +1244,7 @@ function doBootstrap(element: Element | JQuery, mode: string): ng.auto.IInjector } function testIHttpParamSerializerJQLikeProvider() { - var serializer: angular.IHttpParamSerializer; + const serializer: angular.IHttpParamSerializer = null; serializer({ a: 'b' }); @@ -1271,6 +1260,6 @@ function anyOf3(v1: T1, v2: T2, v3: T3) { } function toPromise(val: T): ng.IPromise { - var p: ng.IPromise; + const p: ng.IPromise = null; return p; } diff --git a/types/angular/index.d.ts b/types/angular/index.d.ts index 485ad9ebb3..6ff43a5290 100644 --- a/types/angular/index.d.ts +++ b/types/angular/index.d.ts @@ -782,7 +782,7 @@ declare namespace angular { // Check angular's i18n files for exemples NUMBER_FORMATS: ILocaleNumberFormatDescriptor; DATETIME_FORMATS: ILocaleDateTimeFormatDescriptor; - pluralCat: (num: any) => string; + pluralCat(num: any): string; } interface ILocaleNumberFormatDescriptor { @@ -1591,10 +1591,10 @@ declare namespace angular { } interface IHttpInterceptor { - request?: (config: IRequestConfig) => IRequestConfig|IPromise; - requestError?: (rejection: any) => any; - response?: (response: IHttpPromiseCallbackArg) => IPromise>|IHttpPromiseCallbackArg; - responseError?: (rejection: any) => any; + request?(config: IRequestConfig): IRequestConfig|IPromise; + requestError?(rejection: any): any; + response?(response: IHttpPromiseCallbackArg): IPromise>|IHttpPromiseCallbackArg; + responseError?(rejection: any): any; } interface IHttpInterceptorFactory { @@ -2025,7 +2025,6 @@ declare namespace angular { service(name: string, inlineAnnotatedFunction: any[]): IServiceProvider; value(name: string, value: any): IServiceProvider; } - } /** diff --git a/types/angular/tslint.json b/types/angular/tslint.json index 6bbe7c9318..196218148d 100644 --- a/types/angular/tslint.json +++ b/types/angular/tslint.json @@ -2,32 +2,16 @@ "extends": "../tslint.json", "rules": { "class-name": true, - "curly": true, - "max-line-length": false, - "no-consecutive-blank-lines": true, - "no-shadowed-variable": true, - "quotemark": [ - true, - "single" - ], - "align": true, + "indent": [true, "spaces"], + "quotemark": [true, "single"], + "variable-name": [true, "check-format"], + "callable-types": false, "ban-types": false, - "indent": [ - true, - "spaces" - ], "interface-name": false, - "linebreak-style": [ - true, - "LF" - ], "no-empty-interface": false, + "max-line-length": false, "unified-signatures": false, - "variable-name": [ - true, - "check-format" - ], "void-return": false } } From a38d4c657d02dfc5a85e8350498be191e39705fb Mon Sep 17 00:00:00 2001 From: Andy Date: Wed, 29 Mar 2017 15:34:15 -0700 Subject: [PATCH 059/844] fs-promise: Apply new lint rules (#15494) --- types/fs-promise/fs-promise-tests.ts | 16 ++++++++-------- types/fs-promise/index.d.ts | 2 +- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/types/fs-promise/fs-promise-tests.ts b/types/fs-promise/fs-promise-tests.ts index 43decbd256..51da06bb05 100644 --- a/types/fs-promise/fs-promise-tests.ts +++ b/types/fs-promise/fs-promise-tests.ts @@ -1,19 +1,19 @@ import * as fs from "fs-promise"; -var src: string; -var dst: string; -var dir: string; -var path: string; -var data: any; -var writeOptions: fs.WriteOptions; -var writeJsonOptions: fs.WriteJsonOptions = { +let src: string; +let dst: string; +let dir: string; +let path: string; +let data: any; +let writeOptions: fs.WriteOptions; +const writeJsonOptions: fs.WriteJsonOptions = { spaces: 2, replacer(key, value) { src = key; return value; } }; -var readJsonOptions: fs.ReadJsonOptions; +let readJsonOptions: fs.ReadJsonOptions; async function test() { await fs.copy(src, dst); diff --git a/types/fs-promise/index.d.ts b/types/fs-promise/index.d.ts index 2038190ca1..6455018e5c 100644 --- a/types/fs-promise/index.d.ts +++ b/types/fs-promise/index.d.ts @@ -27,7 +27,7 @@ export interface WriteJsonOptions extends WriteOptions { export interface ReadJsonOptions { encoding: string; flag?: string; - reviver: (key: any, value: any) => any; + reviver(key: any, value: any): any; } export function copy(src: string, dst: string): Promise; From efecc1d6374aa37c9f9108cb4085f9c4a67b0837 Mon Sep 17 00:00:00 2001 From: Andy Date: Wed, 29 Mar 2017 15:41:22 -0700 Subject: [PATCH 060/844] lodash: Apply new lint rules (#15491) --- types/lodash/add/index.d.ts | 2 +- types/lodash/after/index.d.ts | 2 +- types/lodash/ary/index.d.ts | 2 +- types/lodash/assign/index.d.ts | 2 +- types/lodash/assignIn/index.d.ts | 2 +- types/lodash/assignInWith/index.d.ts | 2 +- types/lodash/assignWith/index.d.ts | 2 +- types/lodash/at/index.d.ts | 2 +- types/lodash/attempt/index.d.ts | 2 +- types/lodash/before/index.d.ts | 2 +- types/lodash/bind/index.d.ts | 2 +- types/lodash/bindAll/index.d.ts | 2 +- types/lodash/bindKey/index.d.ts | 2 +- types/lodash/camelCase/index.d.ts | 2 +- types/lodash/capitalize/index.d.ts | 2 +- types/lodash/castArray/index.d.ts | 2 +- types/lodash/ceil/index.d.ts | 2 +- types/lodash/chain/index.d.ts | 2 +- types/lodash/chunk/index.d.ts | 2 +- types/lodash/clamp/index.d.ts | 2 +- types/lodash/clone/index.d.ts | 2 +- types/lodash/cloneDeep/index.d.ts | 2 +- types/lodash/cloneDeepWith/index.d.ts | 2 +- types/lodash/cloneWith/index.d.ts | 2 +- types/lodash/compact/index.d.ts | 2 +- types/lodash/concat/index.d.ts | 2 +- types/lodash/constant/index.d.ts | 2 +- types/lodash/countBy/index.d.ts | 2 +- types/lodash/create/index.d.ts | 2 +- types/lodash/curry/index.d.ts | 2 +- types/lodash/curryRight/index.d.ts | 2 +- types/lodash/debounce/index.d.ts | 2 +- types/lodash/deburr/index.d.ts | 2 +- types/lodash/defaults/index.d.ts | 2 +- types/lodash/defaultsDeep/index.d.ts | 2 +- types/lodash/defer/index.d.ts | 2 +- types/lodash/delay/index.d.ts | 2 +- types/lodash/difference/index.d.ts | 2 +- types/lodash/differenceBy/index.d.ts | 2 +- types/lodash/differenceWith/index.d.ts | 2 +- types/lodash/drop/index.d.ts | 2 +- types/lodash/dropRight/index.d.ts | 2 +- types/lodash/dropRightWhile/index.d.ts | 2 +- types/lodash/dropWhile/index.d.ts | 2 +- types/lodash/each/index.d.ts | 2 +- types/lodash/eachRight/index.d.ts | 2 +- types/lodash/endsWith/index.d.ts | 2 +- types/lodash/eq/index.d.ts | 2 +- types/lodash/escape/index.d.ts | 2 +- types/lodash/escapeRegExp/index.d.ts | 2 +- types/lodash/every/index.d.ts | 2 +- types/lodash/extend/index.d.ts | 2 +- types/lodash/extendWith/index.d.ts | 2 +- types/lodash/fill/index.d.ts | 2 +- types/lodash/filter/index.d.ts | 2 +- types/lodash/find/index.d.ts | 2 +- types/lodash/findIndex/index.d.ts | 2 +- types/lodash/findKey/index.d.ts | 2 +- types/lodash/findLast/index.d.ts | 2 +- types/lodash/findLastIndex/index.d.ts | 2 +- types/lodash/findLastKey/index.d.ts | 2 +- types/lodash/first/index.d.ts | 2 +- types/lodash/flatMap/index.d.ts | 2 +- types/lodash/flatten/index.d.ts | 2 +- types/lodash/flattenDeep/index.d.ts | 2 +- types/lodash/flattenDepth/index.d.ts | 2 +- types/lodash/flip/index.d.ts | 2 +- types/lodash/floor/index.d.ts | 2 +- types/lodash/flow/index.d.ts | 2 +- types/lodash/flowRight/index.d.ts | 2 +- types/lodash/forEach/index.d.ts | 2 +- types/lodash/forEachRight/index.d.ts | 2 +- types/lodash/forIn/index.d.ts | 2 +- types/lodash/forInRight/index.d.ts | 2 +- types/lodash/forOwn/index.d.ts | 2 +- types/lodash/forOwnRight/index.d.ts | 2 +- types/lodash/fromPairs/index.d.ts | 2 +- types/lodash/functions/index.d.ts | 2 +- types/lodash/functionsIn/index.d.ts | 2 +- types/lodash/get/index.d.ts | 2 +- types/lodash/groupBy/index.d.ts | 2 +- types/lodash/gt/index.d.ts | 2 +- types/lodash/gte/index.d.ts | 2 +- types/lodash/has/index.d.ts | 2 +- types/lodash/hasIn/index.d.ts | 2 +- types/lodash/head/index.d.ts | 2 +- types/lodash/identity/index.d.ts | 2 +- types/lodash/inRange/index.d.ts | 2 +- types/lodash/includes/index.d.ts | 2 +- types/lodash/index.d.ts | 18 +---- types/lodash/indexOf/index.d.ts | 2 +- types/lodash/initial/index.d.ts | 2 +- types/lodash/intersection/index.d.ts | 2 +- types/lodash/intersectionBy/index.d.ts | 2 +- types/lodash/intersectionWith/index.d.ts | 2 +- types/lodash/invert/index.d.ts | 2 +- types/lodash/invertBy/index.d.ts | 2 +- types/lodash/invoke/index.d.ts | 2 +- types/lodash/invokeMap/index.d.ts | 2 +- types/lodash/isArguments/index.d.ts | 2 +- types/lodash/isArray/index.d.ts | 2 +- types/lodash/isArrayBuffer/index.d.ts | 2 +- types/lodash/isArrayLike/index.d.ts | 2 +- types/lodash/isArrayLikeObject/index.d.ts | 2 +- types/lodash/isBoolean/index.d.ts | 2 +- types/lodash/isBuffer/index.d.ts | 2 +- types/lodash/isDate/index.d.ts | 2 +- types/lodash/isElement/index.d.ts | 2 +- types/lodash/isEmpty/index.d.ts | 2 +- types/lodash/isEqual/index.d.ts | 2 +- types/lodash/isEqualWith/index.d.ts | 2 +- types/lodash/isError/index.d.ts | 2 +- types/lodash/isFinite/index.d.ts | 2 +- types/lodash/isFunction/index.d.ts | 2 +- types/lodash/isInteger/index.d.ts | 2 +- types/lodash/isLength/index.d.ts | 2 +- types/lodash/isMap/index.d.ts | 2 +- types/lodash/isMatch/index.d.ts | 2 +- types/lodash/isMatchWith/index.d.ts | 2 +- types/lodash/isNaN/index.d.ts | 2 +- types/lodash/isNative/index.d.ts | 2 +- types/lodash/isNil/index.d.ts | 2 +- types/lodash/isNull/index.d.ts | 2 +- types/lodash/isNumber/index.d.ts | 2 +- types/lodash/isObject/index.d.ts | 2 +- types/lodash/isObjectLike/index.d.ts | 2 +- types/lodash/isPlainObject/index.d.ts | 2 +- types/lodash/isRegExp/index.d.ts | 2 +- types/lodash/isSafeInteger/index.d.ts | 2 +- types/lodash/isSet/index.d.ts | 2 +- types/lodash/isString/index.d.ts | 2 +- types/lodash/isSymbol/index.d.ts | 2 +- types/lodash/isTypedArray/index.d.ts | 2 +- types/lodash/isUndefined/index.d.ts | 2 +- types/lodash/isWeakMap/index.d.ts | 2 +- types/lodash/isWeakSet/index.d.ts | 2 +- types/lodash/iteratee/index.d.ts | 2 +- types/lodash/join/index.d.ts | 2 +- types/lodash/kebabCase/index.d.ts | 2 +- types/lodash/keyBy/index.d.ts | 2 +- types/lodash/keys/index.d.ts | 2 +- types/lodash/keysIn/index.d.ts | 2 +- types/lodash/last/index.d.ts | 2 +- types/lodash/lastIndexOf/index.d.ts | 2 +- types/lodash/lodash-tests.ts | 94 ++++++++--------------- types/lodash/lowerCase/index.d.ts | 2 +- types/lodash/lowerFirst/index.d.ts | 2 +- types/lodash/lt/index.d.ts | 2 +- types/lodash/lte/index.d.ts | 2 +- types/lodash/map/index.d.ts | 2 +- types/lodash/mapKeys/index.d.ts | 2 +- types/lodash/mapValues/index.d.ts | 2 +- types/lodash/matches/index.d.ts | 2 +- types/lodash/matchesProperty/index.d.ts | 2 +- types/lodash/max/index.d.ts | 2 +- types/lodash/maxBy/index.d.ts | 2 +- types/lodash/mean/index.d.ts | 2 +- types/lodash/meanBy/index.d.ts | 2 +- types/lodash/memoize/index.d.ts | 2 +- types/lodash/merge/index.d.ts | 2 +- types/lodash/mergeWith/index.d.ts | 2 +- types/lodash/method/index.d.ts | 2 +- types/lodash/methodOf/index.d.ts | 2 +- types/lodash/min/index.d.ts | 2 +- types/lodash/minBy/index.d.ts | 2 +- types/lodash/mixin/index.d.ts | 2 +- types/lodash/negate/index.d.ts | 2 +- types/lodash/noConflict/index.d.ts | 2 +- types/lodash/noop/index.d.ts | 2 +- types/lodash/now/index.d.ts | 2 +- types/lodash/nth/index.d.ts | 2 +- types/lodash/nthArg/index.d.ts | 2 +- types/lodash/omit/index.d.ts | 2 +- types/lodash/omitBy/index.d.ts | 2 +- types/lodash/once/index.d.ts | 2 +- types/lodash/orderBy/index.d.ts | 2 +- types/lodash/over/index.d.ts | 2 +- types/lodash/overArgs/index.d.ts | 2 +- types/lodash/overEvery/index.d.ts | 2 +- types/lodash/overSome/index.d.ts | 2 +- types/lodash/pad/index.d.ts | 2 +- types/lodash/padEnd/index.d.ts | 2 +- types/lodash/padStart/index.d.ts | 2 +- types/lodash/parseInt/index.d.ts | 2 +- types/lodash/partial/index.d.ts | 2 +- types/lodash/partialRight/index.d.ts | 2 +- types/lodash/partition/index.d.ts | 2 +- types/lodash/pick/index.d.ts | 2 +- types/lodash/pickBy/index.d.ts | 2 +- types/lodash/property/index.d.ts | 2 +- types/lodash/propertyOf/index.d.ts | 2 +- types/lodash/pull/index.d.ts | 2 +- types/lodash/pullAll/index.d.ts | 2 +- types/lodash/pullAllBy/index.d.ts | 2 +- types/lodash/pullAt/index.d.ts | 2 +- types/lodash/random/index.d.ts | 2 +- types/lodash/range/index.d.ts | 2 +- types/lodash/rangeRight/index.d.ts | 2 +- types/lodash/rearg/index.d.ts | 2 +- types/lodash/reduce/index.d.ts | 2 +- types/lodash/reduceRight/index.d.ts | 2 +- types/lodash/reject/index.d.ts | 2 +- types/lodash/remove/index.d.ts | 2 +- types/lodash/repeat/index.d.ts | 2 +- types/lodash/replace/index.d.ts | 2 +- types/lodash/rest/index.d.ts | 2 +- types/lodash/result/index.d.ts | 2 +- types/lodash/reverse/index.d.ts | 2 +- types/lodash/round/index.d.ts | 2 +- types/lodash/runInContext/index.d.ts | 2 +- types/lodash/sample/index.d.ts | 2 +- types/lodash/sampleSize/index.d.ts | 2 +- types/lodash/scripts/generate-modules.ts | 2 +- types/lodash/set/index.d.ts | 2 +- types/lodash/setWith/index.d.ts | 2 +- types/lodash/shuffle/index.d.ts | 2 +- types/lodash/size/index.d.ts | 2 +- types/lodash/slice/index.d.ts | 2 +- types/lodash/snakeCase/index.d.ts | 2 +- types/lodash/some/index.d.ts | 2 +- types/lodash/sortBy/index.d.ts | 2 +- types/lodash/sortedIndex/index.d.ts | 2 +- types/lodash/sortedIndexBy/index.d.ts | 2 +- types/lodash/sortedIndexOf/index.d.ts | 2 +- types/lodash/sortedLastIndex/index.d.ts | 2 +- types/lodash/sortedLastIndexBy/index.d.ts | 2 +- types/lodash/sortedLastIndexOf/index.d.ts | 2 +- types/lodash/sortedUniq/index.d.ts | 2 +- types/lodash/sortedUniqBy/index.d.ts | 2 +- types/lodash/split/index.d.ts | 2 +- types/lodash/spread/index.d.ts | 2 +- types/lodash/startCase/index.d.ts | 2 +- types/lodash/startsWith/index.d.ts | 2 +- types/lodash/subtract/index.d.ts | 2 +- types/lodash/sum/index.d.ts | 2 +- types/lodash/sumBy/index.d.ts | 2 +- types/lodash/tail/index.d.ts | 2 +- types/lodash/take/index.d.ts | 2 +- types/lodash/takeRight/index.d.ts | 2 +- types/lodash/takeRightWhile/index.d.ts | 2 +- types/lodash/takeWhile/index.d.ts | 2 +- types/lodash/tap/index.d.ts | 2 +- types/lodash/template/index.d.ts | 2 +- types/lodash/throttle/index.d.ts | 2 +- types/lodash/thru/index.d.ts | 2 +- types/lodash/times/index.d.ts | 2 +- types/lodash/toArray/index.d.ts | 2 +- types/lodash/toInteger/index.d.ts | 2 +- types/lodash/toLength/index.d.ts | 2 +- types/lodash/toLower/index.d.ts | 2 +- types/lodash/toNumber/index.d.ts | 2 +- types/lodash/toPairs/index.d.ts | 2 +- types/lodash/toPairsIn/index.d.ts | 2 +- types/lodash/toPath/index.d.ts | 2 +- types/lodash/toPlainObject/index.d.ts | 2 +- types/lodash/toSafeInteger/index.d.ts | 2 +- types/lodash/toString/index.d.ts | 2 +- types/lodash/toUpper/index.d.ts | 2 +- types/lodash/transform/index.d.ts | 2 +- types/lodash/trim/index.d.ts | 2 +- types/lodash/trimEnd/index.d.ts | 2 +- types/lodash/trimStart/index.d.ts | 2 +- types/lodash/truncate/index.d.ts | 2 +- types/lodash/unary/index.d.ts | 2 +- types/lodash/unescape/index.d.ts | 2 +- types/lodash/union/index.d.ts | 2 +- types/lodash/unionBy/index.d.ts | 2 +- types/lodash/unionWith/index.d.ts | 2 +- types/lodash/uniq/index.d.ts | 2 +- types/lodash/uniqBy/index.d.ts | 2 +- types/lodash/uniqWith/index.d.ts | 2 +- types/lodash/uniqueId/index.d.ts | 2 +- types/lodash/unset/index.d.ts | 2 +- types/lodash/unzip/index.d.ts | 2 +- types/lodash/unzipWith/index.d.ts | 2 +- types/lodash/update/index.d.ts | 2 +- types/lodash/upperCase/index.d.ts | 2 +- types/lodash/upperFirst/index.d.ts | 2 +- types/lodash/values/index.d.ts | 2 +- types/lodash/valuesIn/index.d.ts | 2 +- types/lodash/without/index.d.ts | 2 +- types/lodash/words/index.d.ts | 2 +- types/lodash/wrap/index.d.ts | 2 +- types/lodash/xor/index.d.ts | 2 +- types/lodash/xorBy/index.d.ts | 2 +- types/lodash/xorWith/index.d.ts | 2 +- types/lodash/zip/index.d.ts | 2 +- types/lodash/zipObject/index.d.ts | 2 +- types/lodash/zipWith/index.d.ts | 2 +- 289 files changed, 322 insertions(+), 364 deletions(-) diff --git a/types/lodash/add/index.d.ts b/types/lodash/add/index.d.ts index f6b8ffe169..bfe1d46805 100644 --- a/types/lodash/add/index.d.ts +++ b/types/lodash/add/index.d.ts @@ -1,2 +1,2 @@ import { add } from "../index"; -export = add; \ No newline at end of file +export = add; diff --git a/types/lodash/after/index.d.ts b/types/lodash/after/index.d.ts index 646ac91611..eea017f6fd 100644 --- a/types/lodash/after/index.d.ts +++ b/types/lodash/after/index.d.ts @@ -1,2 +1,2 @@ import { after } from "../index"; -export = after; \ No newline at end of file +export = after; diff --git a/types/lodash/ary/index.d.ts b/types/lodash/ary/index.d.ts index c5281575ea..2b86cf6d4e 100644 --- a/types/lodash/ary/index.d.ts +++ b/types/lodash/ary/index.d.ts @@ -1,2 +1,2 @@ import { ary } from "../index"; -export = ary; \ No newline at end of file +export = ary; diff --git a/types/lodash/assign/index.d.ts b/types/lodash/assign/index.d.ts index 204edbb182..b38bbc5bb6 100644 --- a/types/lodash/assign/index.d.ts +++ b/types/lodash/assign/index.d.ts @@ -1,2 +1,2 @@ import { assign } from "../index"; -export = assign; \ No newline at end of file +export = assign; diff --git a/types/lodash/assignIn/index.d.ts b/types/lodash/assignIn/index.d.ts index da3f4f123b..2f182e7e90 100644 --- a/types/lodash/assignIn/index.d.ts +++ b/types/lodash/assignIn/index.d.ts @@ -1,2 +1,2 @@ import { assignIn } from "../index"; -export = assignIn; \ No newline at end of file +export = assignIn; diff --git a/types/lodash/assignInWith/index.d.ts b/types/lodash/assignInWith/index.d.ts index 1159a8d998..5b092fa13c 100644 --- a/types/lodash/assignInWith/index.d.ts +++ b/types/lodash/assignInWith/index.d.ts @@ -1,2 +1,2 @@ import { assignInWith } from "../index"; -export = assignInWith; \ No newline at end of file +export = assignInWith; diff --git a/types/lodash/assignWith/index.d.ts b/types/lodash/assignWith/index.d.ts index 29c0c36681..9424c4e75a 100644 --- a/types/lodash/assignWith/index.d.ts +++ b/types/lodash/assignWith/index.d.ts @@ -1,2 +1,2 @@ import { assignWith } from "../index"; -export = assignWith; \ No newline at end of file +export = assignWith; diff --git a/types/lodash/at/index.d.ts b/types/lodash/at/index.d.ts index e613328596..fc009ef6c8 100644 --- a/types/lodash/at/index.d.ts +++ b/types/lodash/at/index.d.ts @@ -1,2 +1,2 @@ import { at } from "../index"; -export = at; \ No newline at end of file +export = at; diff --git a/types/lodash/attempt/index.d.ts b/types/lodash/attempt/index.d.ts index 26849500cb..991d4605cf 100644 --- a/types/lodash/attempt/index.d.ts +++ b/types/lodash/attempt/index.d.ts @@ -1,2 +1,2 @@ import { attempt } from "../index"; -export = attempt; \ No newline at end of file +export = attempt; diff --git a/types/lodash/before/index.d.ts b/types/lodash/before/index.d.ts index 6595204ea2..c9ccdbbb41 100644 --- a/types/lodash/before/index.d.ts +++ b/types/lodash/before/index.d.ts @@ -1,2 +1,2 @@ import { before } from "../index"; -export = before; \ No newline at end of file +export = before; diff --git a/types/lodash/bind/index.d.ts b/types/lodash/bind/index.d.ts index 61ac4bb6fd..bfae1efa26 100644 --- a/types/lodash/bind/index.d.ts +++ b/types/lodash/bind/index.d.ts @@ -1,2 +1,2 @@ import { bind } from "../index"; -export = bind; \ No newline at end of file +export = bind; diff --git a/types/lodash/bindAll/index.d.ts b/types/lodash/bindAll/index.d.ts index 4b54d76b2e..90b7f67bcc 100644 --- a/types/lodash/bindAll/index.d.ts +++ b/types/lodash/bindAll/index.d.ts @@ -1,2 +1,2 @@ import { bindAll } from "../index"; -export = bindAll; \ No newline at end of file +export = bindAll; diff --git a/types/lodash/bindKey/index.d.ts b/types/lodash/bindKey/index.d.ts index d5c6217cc0..711b02f0e1 100644 --- a/types/lodash/bindKey/index.d.ts +++ b/types/lodash/bindKey/index.d.ts @@ -1,2 +1,2 @@ import { bindKey } from "../index"; -export = bindKey; \ No newline at end of file +export = bindKey; diff --git a/types/lodash/camelCase/index.d.ts b/types/lodash/camelCase/index.d.ts index 8dbf939e8a..99cc4f8b36 100644 --- a/types/lodash/camelCase/index.d.ts +++ b/types/lodash/camelCase/index.d.ts @@ -1,2 +1,2 @@ import { camelCase } from "../index"; -export = camelCase; \ No newline at end of file +export = camelCase; diff --git a/types/lodash/capitalize/index.d.ts b/types/lodash/capitalize/index.d.ts index c8da4286b7..035d00ce94 100644 --- a/types/lodash/capitalize/index.d.ts +++ b/types/lodash/capitalize/index.d.ts @@ -1,2 +1,2 @@ import { capitalize } from "../index"; -export = capitalize; \ No newline at end of file +export = capitalize; diff --git a/types/lodash/castArray/index.d.ts b/types/lodash/castArray/index.d.ts index 6b508b8a98..f278e73a40 100644 --- a/types/lodash/castArray/index.d.ts +++ b/types/lodash/castArray/index.d.ts @@ -1,2 +1,2 @@ import { castArray } from "../index"; -export = castArray; \ No newline at end of file +export = castArray; diff --git a/types/lodash/ceil/index.d.ts b/types/lodash/ceil/index.d.ts index 5e048b3d1d..732861a411 100644 --- a/types/lodash/ceil/index.d.ts +++ b/types/lodash/ceil/index.d.ts @@ -1,2 +1,2 @@ import { ceil } from "../index"; -export = ceil; \ No newline at end of file +export = ceil; diff --git a/types/lodash/chain/index.d.ts b/types/lodash/chain/index.d.ts index 4b73db1c6c..2be62c817e 100644 --- a/types/lodash/chain/index.d.ts +++ b/types/lodash/chain/index.d.ts @@ -1,2 +1,2 @@ import { chain } from "../index"; -export = chain; \ No newline at end of file +export = chain; diff --git a/types/lodash/chunk/index.d.ts b/types/lodash/chunk/index.d.ts index 732721395b..27254c0cce 100644 --- a/types/lodash/chunk/index.d.ts +++ b/types/lodash/chunk/index.d.ts @@ -1,2 +1,2 @@ import { chunk } from "../index"; -export = chunk; \ No newline at end of file +export = chunk; diff --git a/types/lodash/clamp/index.d.ts b/types/lodash/clamp/index.d.ts index 4d42abd905..a14ebc3edd 100644 --- a/types/lodash/clamp/index.d.ts +++ b/types/lodash/clamp/index.d.ts @@ -1,2 +1,2 @@ import { clamp } from "../index"; -export = clamp; \ No newline at end of file +export = clamp; diff --git a/types/lodash/clone/index.d.ts b/types/lodash/clone/index.d.ts index ba68623796..7ec6d46f62 100644 --- a/types/lodash/clone/index.d.ts +++ b/types/lodash/clone/index.d.ts @@ -1,2 +1,2 @@ import { clone } from "../index"; -export = clone; \ No newline at end of file +export = clone; diff --git a/types/lodash/cloneDeep/index.d.ts b/types/lodash/cloneDeep/index.d.ts index 4e416a08f7..7ec0d7cc22 100644 --- a/types/lodash/cloneDeep/index.d.ts +++ b/types/lodash/cloneDeep/index.d.ts @@ -1,2 +1,2 @@ import { cloneDeep } from "../index"; -export = cloneDeep; \ No newline at end of file +export = cloneDeep; diff --git a/types/lodash/cloneDeepWith/index.d.ts b/types/lodash/cloneDeepWith/index.d.ts index 795155856f..387559395b 100644 --- a/types/lodash/cloneDeepWith/index.d.ts +++ b/types/lodash/cloneDeepWith/index.d.ts @@ -1,2 +1,2 @@ import { cloneDeepWith } from "../index"; -export = cloneDeepWith; \ No newline at end of file +export = cloneDeepWith; diff --git a/types/lodash/cloneWith/index.d.ts b/types/lodash/cloneWith/index.d.ts index d1fa9863cd..070f583fc7 100644 --- a/types/lodash/cloneWith/index.d.ts +++ b/types/lodash/cloneWith/index.d.ts @@ -1,2 +1,2 @@ import { cloneWith } from "../index"; -export = cloneWith; \ No newline at end of file +export = cloneWith; diff --git a/types/lodash/compact/index.d.ts b/types/lodash/compact/index.d.ts index 9d7b1fade1..e1617e88da 100644 --- a/types/lodash/compact/index.d.ts +++ b/types/lodash/compact/index.d.ts @@ -1,2 +1,2 @@ import { compact } from "../index"; -export = compact; \ No newline at end of file +export = compact; diff --git a/types/lodash/concat/index.d.ts b/types/lodash/concat/index.d.ts index 26e6c184cc..309b54cc8f 100644 --- a/types/lodash/concat/index.d.ts +++ b/types/lodash/concat/index.d.ts @@ -1,2 +1,2 @@ import { concat } from "../index"; -export = concat; \ No newline at end of file +export = concat; diff --git a/types/lodash/constant/index.d.ts b/types/lodash/constant/index.d.ts index 16adcbe902..e812062c91 100644 --- a/types/lodash/constant/index.d.ts +++ b/types/lodash/constant/index.d.ts @@ -1,2 +1,2 @@ import { constant } from "../index"; -export = constant; \ No newline at end of file +export = constant; diff --git a/types/lodash/countBy/index.d.ts b/types/lodash/countBy/index.d.ts index 062ea86901..d44affd3b1 100644 --- a/types/lodash/countBy/index.d.ts +++ b/types/lodash/countBy/index.d.ts @@ -1,2 +1,2 @@ import { countBy } from "../index"; -export = countBy; \ No newline at end of file +export = countBy; diff --git a/types/lodash/create/index.d.ts b/types/lodash/create/index.d.ts index 4040edabf3..54cec6e4cb 100644 --- a/types/lodash/create/index.d.ts +++ b/types/lodash/create/index.d.ts @@ -1,2 +1,2 @@ import { create } from "../index"; -export = create; \ No newline at end of file +export = create; diff --git a/types/lodash/curry/index.d.ts b/types/lodash/curry/index.d.ts index b5132423ba..a6ab8c799c 100644 --- a/types/lodash/curry/index.d.ts +++ b/types/lodash/curry/index.d.ts @@ -1,2 +1,2 @@ import { curry } from "../index"; -export = curry; \ No newline at end of file +export = curry; diff --git a/types/lodash/curryRight/index.d.ts b/types/lodash/curryRight/index.d.ts index 999330fa63..c179a26dbd 100644 --- a/types/lodash/curryRight/index.d.ts +++ b/types/lodash/curryRight/index.d.ts @@ -1,2 +1,2 @@ import { curryRight } from "../index"; -export = curryRight; \ No newline at end of file +export = curryRight; diff --git a/types/lodash/debounce/index.d.ts b/types/lodash/debounce/index.d.ts index 2817fce4e1..98fc36743a 100644 --- a/types/lodash/debounce/index.d.ts +++ b/types/lodash/debounce/index.d.ts @@ -1,2 +1,2 @@ import { debounce } from "../index"; -export = debounce; \ No newline at end of file +export = debounce; diff --git a/types/lodash/deburr/index.d.ts b/types/lodash/deburr/index.d.ts index 8bcee7b151..4b5fdbf028 100644 --- a/types/lodash/deburr/index.d.ts +++ b/types/lodash/deburr/index.d.ts @@ -1,2 +1,2 @@ import { deburr } from "../index"; -export = deburr; \ No newline at end of file +export = deburr; diff --git a/types/lodash/defaults/index.d.ts b/types/lodash/defaults/index.d.ts index 9a93890329..c80d5d318d 100644 --- a/types/lodash/defaults/index.d.ts +++ b/types/lodash/defaults/index.d.ts @@ -1,2 +1,2 @@ import { defaults } from "../index"; -export = defaults; \ No newline at end of file +export = defaults; diff --git a/types/lodash/defaultsDeep/index.d.ts b/types/lodash/defaultsDeep/index.d.ts index 35ca6cc3bc..5ee0aa1854 100644 --- a/types/lodash/defaultsDeep/index.d.ts +++ b/types/lodash/defaultsDeep/index.d.ts @@ -1,2 +1,2 @@ import { defaultsDeep } from "../index"; -export = defaultsDeep; \ No newline at end of file +export = defaultsDeep; diff --git a/types/lodash/defer/index.d.ts b/types/lodash/defer/index.d.ts index a3dab9837a..4e0bffe6d0 100644 --- a/types/lodash/defer/index.d.ts +++ b/types/lodash/defer/index.d.ts @@ -1,2 +1,2 @@ import { defer } from "../index"; -export = defer; \ No newline at end of file +export = defer; diff --git a/types/lodash/delay/index.d.ts b/types/lodash/delay/index.d.ts index e5569f3b67..1aecd0124c 100644 --- a/types/lodash/delay/index.d.ts +++ b/types/lodash/delay/index.d.ts @@ -1,2 +1,2 @@ import { delay } from "../index"; -export = delay; \ No newline at end of file +export = delay; diff --git a/types/lodash/difference/index.d.ts b/types/lodash/difference/index.d.ts index 2d9e1d1569..f188c1695c 100644 --- a/types/lodash/difference/index.d.ts +++ b/types/lodash/difference/index.d.ts @@ -1,2 +1,2 @@ import { difference } from "../index"; -export = difference; \ No newline at end of file +export = difference; diff --git a/types/lodash/differenceBy/index.d.ts b/types/lodash/differenceBy/index.d.ts index 35cc4325ad..fc4fbb97cd 100644 --- a/types/lodash/differenceBy/index.d.ts +++ b/types/lodash/differenceBy/index.d.ts @@ -1,2 +1,2 @@ import { differenceBy } from "../index"; -export = differenceBy; \ No newline at end of file +export = differenceBy; diff --git a/types/lodash/differenceWith/index.d.ts b/types/lodash/differenceWith/index.d.ts index 37fe7fd014..c13a1a5356 100644 --- a/types/lodash/differenceWith/index.d.ts +++ b/types/lodash/differenceWith/index.d.ts @@ -1,2 +1,2 @@ import { differenceWith } from "../index"; -export = differenceWith; \ No newline at end of file +export = differenceWith; diff --git a/types/lodash/drop/index.d.ts b/types/lodash/drop/index.d.ts index b6e3653747..a20de1c85e 100644 --- a/types/lodash/drop/index.d.ts +++ b/types/lodash/drop/index.d.ts @@ -1,2 +1,2 @@ import { drop } from "../index"; -export = drop; \ No newline at end of file +export = drop; diff --git a/types/lodash/dropRight/index.d.ts b/types/lodash/dropRight/index.d.ts index 12d8f9a466..eddbac88af 100644 --- a/types/lodash/dropRight/index.d.ts +++ b/types/lodash/dropRight/index.d.ts @@ -1,2 +1,2 @@ import { dropRight } from "../index"; -export = dropRight; \ No newline at end of file +export = dropRight; diff --git a/types/lodash/dropRightWhile/index.d.ts b/types/lodash/dropRightWhile/index.d.ts index 913a3d2264..e7b0bb4855 100644 --- a/types/lodash/dropRightWhile/index.d.ts +++ b/types/lodash/dropRightWhile/index.d.ts @@ -1,2 +1,2 @@ import { dropRightWhile } from "../index"; -export = dropRightWhile; \ No newline at end of file +export = dropRightWhile; diff --git a/types/lodash/dropWhile/index.d.ts b/types/lodash/dropWhile/index.d.ts index 758a605fd7..4ffa087cc5 100644 --- a/types/lodash/dropWhile/index.d.ts +++ b/types/lodash/dropWhile/index.d.ts @@ -1,2 +1,2 @@ import { dropWhile } from "../index"; -export = dropWhile; \ No newline at end of file +export = dropWhile; diff --git a/types/lodash/each/index.d.ts b/types/lodash/each/index.d.ts index f7408a03ba..4a6ea0af51 100644 --- a/types/lodash/each/index.d.ts +++ b/types/lodash/each/index.d.ts @@ -1,2 +1,2 @@ import { each } from "../index"; -export = each; \ No newline at end of file +export = each; diff --git a/types/lodash/eachRight/index.d.ts b/types/lodash/eachRight/index.d.ts index 976747a4fe..2e04a5c9f8 100644 --- a/types/lodash/eachRight/index.d.ts +++ b/types/lodash/eachRight/index.d.ts @@ -1,2 +1,2 @@ import { eachRight } from "../index"; -export = eachRight; \ No newline at end of file +export = eachRight; diff --git a/types/lodash/endsWith/index.d.ts b/types/lodash/endsWith/index.d.ts index 96a03e5e2d..6fb61e7f4b 100644 --- a/types/lodash/endsWith/index.d.ts +++ b/types/lodash/endsWith/index.d.ts @@ -1,2 +1,2 @@ import { endsWith } from "../index"; -export = endsWith; \ No newline at end of file +export = endsWith; diff --git a/types/lodash/eq/index.d.ts b/types/lodash/eq/index.d.ts index 70fc8dcc9b..87d4de60ed 100644 --- a/types/lodash/eq/index.d.ts +++ b/types/lodash/eq/index.d.ts @@ -1,2 +1,2 @@ import { eq } from "../index"; -export = eq; \ No newline at end of file +export = eq; diff --git a/types/lodash/escape/index.d.ts b/types/lodash/escape/index.d.ts index 462727c1dd..3766a06712 100644 --- a/types/lodash/escape/index.d.ts +++ b/types/lodash/escape/index.d.ts @@ -1,2 +1,2 @@ import { escape } from "../index"; -export = escape; \ No newline at end of file +export = escape; diff --git a/types/lodash/escapeRegExp/index.d.ts b/types/lodash/escapeRegExp/index.d.ts index edd6c1f5f2..6419043fb3 100644 --- a/types/lodash/escapeRegExp/index.d.ts +++ b/types/lodash/escapeRegExp/index.d.ts @@ -1,2 +1,2 @@ import { escapeRegExp } from "../index"; -export = escapeRegExp; \ No newline at end of file +export = escapeRegExp; diff --git a/types/lodash/every/index.d.ts b/types/lodash/every/index.d.ts index 71a4c3d65b..a6cc43aa14 100644 --- a/types/lodash/every/index.d.ts +++ b/types/lodash/every/index.d.ts @@ -1,2 +1,2 @@ import { every } from "../index"; -export = every; \ No newline at end of file +export = every; diff --git a/types/lodash/extend/index.d.ts b/types/lodash/extend/index.d.ts index d86ec7d7b3..0f46cd5b85 100644 --- a/types/lodash/extend/index.d.ts +++ b/types/lodash/extend/index.d.ts @@ -1,2 +1,2 @@ import { extend } from "../index"; -export = extend; \ No newline at end of file +export = extend; diff --git a/types/lodash/extendWith/index.d.ts b/types/lodash/extendWith/index.d.ts index c4c3383e12..0274ebff23 100644 --- a/types/lodash/extendWith/index.d.ts +++ b/types/lodash/extendWith/index.d.ts @@ -1,2 +1,2 @@ import { extendWith } from "../index"; -export = extendWith; \ No newline at end of file +export = extendWith; diff --git a/types/lodash/fill/index.d.ts b/types/lodash/fill/index.d.ts index 06cade9a02..06dc85a9d9 100644 --- a/types/lodash/fill/index.d.ts +++ b/types/lodash/fill/index.d.ts @@ -1,2 +1,2 @@ import { fill } from "../index"; -export = fill; \ No newline at end of file +export = fill; diff --git a/types/lodash/filter/index.d.ts b/types/lodash/filter/index.d.ts index 164a9ccfa5..0b257c4dfc 100644 --- a/types/lodash/filter/index.d.ts +++ b/types/lodash/filter/index.d.ts @@ -1,2 +1,2 @@ import { filter } from "../index"; -export = filter; \ No newline at end of file +export = filter; diff --git a/types/lodash/find/index.d.ts b/types/lodash/find/index.d.ts index 6a22162c86..5dacac0168 100644 --- a/types/lodash/find/index.d.ts +++ b/types/lodash/find/index.d.ts @@ -1,2 +1,2 @@ import { find } from "../index"; -export = find; \ No newline at end of file +export = find; diff --git a/types/lodash/findIndex/index.d.ts b/types/lodash/findIndex/index.d.ts index e716bfd130..3c973bdfc5 100644 --- a/types/lodash/findIndex/index.d.ts +++ b/types/lodash/findIndex/index.d.ts @@ -1,2 +1,2 @@ import { findIndex } from "../index"; -export = findIndex; \ No newline at end of file +export = findIndex; diff --git a/types/lodash/findKey/index.d.ts b/types/lodash/findKey/index.d.ts index 503e047fb5..faca19e1cc 100644 --- a/types/lodash/findKey/index.d.ts +++ b/types/lodash/findKey/index.d.ts @@ -1,2 +1,2 @@ import { findKey } from "../index"; -export = findKey; \ No newline at end of file +export = findKey; diff --git a/types/lodash/findLast/index.d.ts b/types/lodash/findLast/index.d.ts index 91e5b6a3d9..f4f896790c 100644 --- a/types/lodash/findLast/index.d.ts +++ b/types/lodash/findLast/index.d.ts @@ -1,2 +1,2 @@ import { findLast } from "../index"; -export = findLast; \ No newline at end of file +export = findLast; diff --git a/types/lodash/findLastIndex/index.d.ts b/types/lodash/findLastIndex/index.d.ts index 8a24b5e8c3..122be1450f 100644 --- a/types/lodash/findLastIndex/index.d.ts +++ b/types/lodash/findLastIndex/index.d.ts @@ -1,2 +1,2 @@ import { findLastIndex } from "../index"; -export = findLastIndex; \ No newline at end of file +export = findLastIndex; diff --git a/types/lodash/findLastKey/index.d.ts b/types/lodash/findLastKey/index.d.ts index ce65fa5b51..52d9f8adde 100644 --- a/types/lodash/findLastKey/index.d.ts +++ b/types/lodash/findLastKey/index.d.ts @@ -1,2 +1,2 @@ import { findLastKey } from "../index"; -export = findLastKey; \ No newline at end of file +export = findLastKey; diff --git a/types/lodash/first/index.d.ts b/types/lodash/first/index.d.ts index cb8d284bf2..b743ed962d 100644 --- a/types/lodash/first/index.d.ts +++ b/types/lodash/first/index.d.ts @@ -1,2 +1,2 @@ import { first } from "../index"; -export = first; \ No newline at end of file +export = first; diff --git a/types/lodash/flatMap/index.d.ts b/types/lodash/flatMap/index.d.ts index 7d7f65be20..7ac8502c20 100644 --- a/types/lodash/flatMap/index.d.ts +++ b/types/lodash/flatMap/index.d.ts @@ -1,2 +1,2 @@ import { flatMap } from "../index"; -export = flatMap; \ No newline at end of file +export = flatMap; diff --git a/types/lodash/flatten/index.d.ts b/types/lodash/flatten/index.d.ts index 33f1490358..708c89ad86 100644 --- a/types/lodash/flatten/index.d.ts +++ b/types/lodash/flatten/index.d.ts @@ -1,2 +1,2 @@ import { flatten } from "../index"; -export = flatten; \ No newline at end of file +export = flatten; diff --git a/types/lodash/flattenDeep/index.d.ts b/types/lodash/flattenDeep/index.d.ts index 7da0a2b110..8bf39277bd 100644 --- a/types/lodash/flattenDeep/index.d.ts +++ b/types/lodash/flattenDeep/index.d.ts @@ -1,2 +1,2 @@ import { flattenDeep } from "../index"; -export = flattenDeep; \ No newline at end of file +export = flattenDeep; diff --git a/types/lodash/flattenDepth/index.d.ts b/types/lodash/flattenDepth/index.d.ts index 0a619cc924..38491c47fe 100644 --- a/types/lodash/flattenDepth/index.d.ts +++ b/types/lodash/flattenDepth/index.d.ts @@ -1,2 +1,2 @@ import { flattenDepth } from "../index"; -export = flattenDepth; \ No newline at end of file +export = flattenDepth; diff --git a/types/lodash/flip/index.d.ts b/types/lodash/flip/index.d.ts index b13716ca19..e5fd68e0e8 100644 --- a/types/lodash/flip/index.d.ts +++ b/types/lodash/flip/index.d.ts @@ -1,2 +1,2 @@ import { flip } from "../index"; -export = flip; \ No newline at end of file +export = flip; diff --git a/types/lodash/floor/index.d.ts b/types/lodash/floor/index.d.ts index 39e00a9eee..da725ee51d 100644 --- a/types/lodash/floor/index.d.ts +++ b/types/lodash/floor/index.d.ts @@ -1,2 +1,2 @@ import { floor } from "../index"; -export = floor; \ No newline at end of file +export = floor; diff --git a/types/lodash/flow/index.d.ts b/types/lodash/flow/index.d.ts index 681601a616..31bd309be5 100644 --- a/types/lodash/flow/index.d.ts +++ b/types/lodash/flow/index.d.ts @@ -1,2 +1,2 @@ import { flow } from "../index"; -export = flow; \ No newline at end of file +export = flow; diff --git a/types/lodash/flowRight/index.d.ts b/types/lodash/flowRight/index.d.ts index d787765c55..65fe107bde 100644 --- a/types/lodash/flowRight/index.d.ts +++ b/types/lodash/flowRight/index.d.ts @@ -1,2 +1,2 @@ import { flowRight } from "../index"; -export = flowRight; \ No newline at end of file +export = flowRight; diff --git a/types/lodash/forEach/index.d.ts b/types/lodash/forEach/index.d.ts index cd50458a13..bdcae5ac8a 100644 --- a/types/lodash/forEach/index.d.ts +++ b/types/lodash/forEach/index.d.ts @@ -1,2 +1,2 @@ import { forEach } from "../index"; -export = forEach; \ No newline at end of file +export = forEach; diff --git a/types/lodash/forEachRight/index.d.ts b/types/lodash/forEachRight/index.d.ts index 3c579e867d..16bfc91bd8 100644 --- a/types/lodash/forEachRight/index.d.ts +++ b/types/lodash/forEachRight/index.d.ts @@ -1,2 +1,2 @@ import { forEachRight } from "../index"; -export = forEachRight; \ No newline at end of file +export = forEachRight; diff --git a/types/lodash/forIn/index.d.ts b/types/lodash/forIn/index.d.ts index 8ce44be7b3..176b0bc3c4 100644 --- a/types/lodash/forIn/index.d.ts +++ b/types/lodash/forIn/index.d.ts @@ -1,2 +1,2 @@ import { forIn } from "../index"; -export = forIn; \ No newline at end of file +export = forIn; diff --git a/types/lodash/forInRight/index.d.ts b/types/lodash/forInRight/index.d.ts index c8a8b63da3..791c1ae43a 100644 --- a/types/lodash/forInRight/index.d.ts +++ b/types/lodash/forInRight/index.d.ts @@ -1,2 +1,2 @@ import { forInRight } from "../index"; -export = forInRight; \ No newline at end of file +export = forInRight; diff --git a/types/lodash/forOwn/index.d.ts b/types/lodash/forOwn/index.d.ts index 5a8fb41203..41230e4df0 100644 --- a/types/lodash/forOwn/index.d.ts +++ b/types/lodash/forOwn/index.d.ts @@ -1,2 +1,2 @@ import { forOwn } from "../index"; -export = forOwn; \ No newline at end of file +export = forOwn; diff --git a/types/lodash/forOwnRight/index.d.ts b/types/lodash/forOwnRight/index.d.ts index c50c88ffcb..cf09aaea78 100644 --- a/types/lodash/forOwnRight/index.d.ts +++ b/types/lodash/forOwnRight/index.d.ts @@ -1,2 +1,2 @@ import { forOwnRight } from "../index"; -export = forOwnRight; \ No newline at end of file +export = forOwnRight; diff --git a/types/lodash/fromPairs/index.d.ts b/types/lodash/fromPairs/index.d.ts index 0a9528aa6e..007dd84c4f 100644 --- a/types/lodash/fromPairs/index.d.ts +++ b/types/lodash/fromPairs/index.d.ts @@ -1,2 +1,2 @@ import { fromPairs } from "../index"; -export = fromPairs; \ No newline at end of file +export = fromPairs; diff --git a/types/lodash/functions/index.d.ts b/types/lodash/functions/index.d.ts index 1d85c6d363..ecb9881d1f 100644 --- a/types/lodash/functions/index.d.ts +++ b/types/lodash/functions/index.d.ts @@ -1,2 +1,2 @@ import { functions } from "../index"; -export = functions; \ No newline at end of file +export = functions; diff --git a/types/lodash/functionsIn/index.d.ts b/types/lodash/functionsIn/index.d.ts index 93e45415db..e3d733ae40 100644 --- a/types/lodash/functionsIn/index.d.ts +++ b/types/lodash/functionsIn/index.d.ts @@ -1,2 +1,2 @@ import { functionsIn } from "../index"; -export = functionsIn; \ No newline at end of file +export = functionsIn; diff --git a/types/lodash/get/index.d.ts b/types/lodash/get/index.d.ts index 435d3df99d..d38d6753aa 100644 --- a/types/lodash/get/index.d.ts +++ b/types/lodash/get/index.d.ts @@ -1,2 +1,2 @@ import { get } from "../index"; -export = get; \ No newline at end of file +export = get; diff --git a/types/lodash/groupBy/index.d.ts b/types/lodash/groupBy/index.d.ts index e04afa237b..2d09926b8f 100644 --- a/types/lodash/groupBy/index.d.ts +++ b/types/lodash/groupBy/index.d.ts @@ -1,2 +1,2 @@ import { groupBy } from "../index"; -export = groupBy; \ No newline at end of file +export = groupBy; diff --git a/types/lodash/gt/index.d.ts b/types/lodash/gt/index.d.ts index 9601fc765b..842d6c11f2 100644 --- a/types/lodash/gt/index.d.ts +++ b/types/lodash/gt/index.d.ts @@ -1,2 +1,2 @@ import { gt } from "../index"; -export = gt; \ No newline at end of file +export = gt; diff --git a/types/lodash/gte/index.d.ts b/types/lodash/gte/index.d.ts index c329cb2544..ffdf651d58 100644 --- a/types/lodash/gte/index.d.ts +++ b/types/lodash/gte/index.d.ts @@ -1,2 +1,2 @@ import { gte } from "../index"; -export = gte; \ No newline at end of file +export = gte; diff --git a/types/lodash/has/index.d.ts b/types/lodash/has/index.d.ts index ef4607fd00..56a5f39b91 100644 --- a/types/lodash/has/index.d.ts +++ b/types/lodash/has/index.d.ts @@ -1,2 +1,2 @@ import { has } from "../index"; -export = has; \ No newline at end of file +export = has; diff --git a/types/lodash/hasIn/index.d.ts b/types/lodash/hasIn/index.d.ts index 28e46e8d42..bcacce21c1 100644 --- a/types/lodash/hasIn/index.d.ts +++ b/types/lodash/hasIn/index.d.ts @@ -1,2 +1,2 @@ import { hasIn } from "../index"; -export = hasIn; \ No newline at end of file +export = hasIn; diff --git a/types/lodash/head/index.d.ts b/types/lodash/head/index.d.ts index f9cdf839d6..686e6372a8 100644 --- a/types/lodash/head/index.d.ts +++ b/types/lodash/head/index.d.ts @@ -1,2 +1,2 @@ import { head } from "../index"; -export = head; \ No newline at end of file +export = head; diff --git a/types/lodash/identity/index.d.ts b/types/lodash/identity/index.d.ts index 26894a8e4e..92a3e32afb 100644 --- a/types/lodash/identity/index.d.ts +++ b/types/lodash/identity/index.d.ts @@ -1,2 +1,2 @@ import { identity } from "../index"; -export = identity; \ No newline at end of file +export = identity; diff --git a/types/lodash/inRange/index.d.ts b/types/lodash/inRange/index.d.ts index 128b554abc..873efdaef4 100644 --- a/types/lodash/inRange/index.d.ts +++ b/types/lodash/inRange/index.d.ts @@ -1,2 +1,2 @@ import { inRange } from "../index"; -export = inRange; \ No newline at end of file +export = inRange; diff --git a/types/lodash/includes/index.d.ts b/types/lodash/includes/index.d.ts index d1c5d94e90..c78736dc58 100644 --- a/types/lodash/includes/index.d.ts +++ b/types/lodash/includes/index.d.ts @@ -1,2 +1,2 @@ import { includes } from "../index"; -export = includes; \ No newline at end of file +export = includes; diff --git a/types/lodash/index.d.ts b/types/lodash/index.d.ts index 10326ae888..39dad36ed5 100644 --- a/types/lodash/index.d.ts +++ b/types/lodash/index.d.ts @@ -43,7 +43,6 @@ changes: - [x] Made _.capitalize uppercase the first character & lowercase the rest - [x] Made _.functions return only own method names - added 23 array methods: - [x] _.concat - [x] _.differenceBy @@ -101,7 +100,6 @@ added 13 object methods: - [x] _.omitBy - [x] _.pickBy - added 8 string methods: - [x] _.lowerCase - [x] _.lowerFirst @@ -237,7 +235,6 @@ Methods: - [ ] _.next */ - export = _; export as namespace _; @@ -246,7 +243,6 @@ declare var _: _.LoDashStatic; type PartialObject = Partial; declare namespace _ { - type Many = T | T[]; interface LoDashStatic { @@ -3202,11 +3198,9 @@ declare namespace _ { sortedIndex( value: T ): LoDashExplicitWrapper; - - } - //_.sortedIndexBy + // _.sortedIndexBy interface LoDashStatic { /** * This method is like `_.sortedIndex` except that it accepts `iteratee` @@ -8662,7 +8656,6 @@ declare namespace _ { reduce( collection: NumericDictionary, callback: MemoIterator): TResult; - } interface LoDashImplicitArrayWrapper { @@ -9248,7 +9241,6 @@ declare namespace _ { predicate?: string|[string, any] ): boolean; - /** * @see _.some */ @@ -10517,7 +10509,6 @@ declare namespace _ { flowRight(...funcs: Function[]): LoDashExplicitObjectWrapper; } - //_.memoize interface MemoizedFunction extends Function { cache: MapCache; @@ -11163,7 +11154,6 @@ declare namespace _ { } interface LoDashImplicitArrayWrapper { - /** * @see _.clone */ @@ -11185,7 +11175,6 @@ declare namespace _ { } interface LoDashExplicitArrayWrapper { - /** * @see _.clone */ @@ -13875,7 +13864,6 @@ declare namespace _ { end: number ): boolean; - /** * @see _.inRange */ @@ -14720,7 +14708,6 @@ declare namespace _ { create(properties?: U): LoDashExplicitObjectWrapper; } - //_.defaults interface LoDashStatic { /** @@ -16593,7 +16580,6 @@ declare namespace _ { } interface LoDashImplicitObjectWrapper { - /** * @see _.omit */ @@ -16603,7 +16589,6 @@ declare namespace _ { } interface LoDashExplicitObjectWrapper { - /** * @see _.omit */ @@ -19498,7 +19483,6 @@ declare namespace _ { } } - // Backward compatibility with --target es5 declare global { interface Set { } diff --git a/types/lodash/indexOf/index.d.ts b/types/lodash/indexOf/index.d.ts index ab5c82d8ed..d2f21b9864 100644 --- a/types/lodash/indexOf/index.d.ts +++ b/types/lodash/indexOf/index.d.ts @@ -1,2 +1,2 @@ import { indexOf } from "../index"; -export = indexOf; \ No newline at end of file +export = indexOf; diff --git a/types/lodash/initial/index.d.ts b/types/lodash/initial/index.d.ts index 800c0a6ca2..459fa17ade 100644 --- a/types/lodash/initial/index.d.ts +++ b/types/lodash/initial/index.d.ts @@ -1,2 +1,2 @@ import { initial } from "../index"; -export = initial; \ No newline at end of file +export = initial; diff --git a/types/lodash/intersection/index.d.ts b/types/lodash/intersection/index.d.ts index b44a84ac45..d186c26fc9 100644 --- a/types/lodash/intersection/index.d.ts +++ b/types/lodash/intersection/index.d.ts @@ -1,2 +1,2 @@ import { intersection } from "../index"; -export = intersection; \ No newline at end of file +export = intersection; diff --git a/types/lodash/intersectionBy/index.d.ts b/types/lodash/intersectionBy/index.d.ts index 82df722083..430bf52bbf 100644 --- a/types/lodash/intersectionBy/index.d.ts +++ b/types/lodash/intersectionBy/index.d.ts @@ -1,2 +1,2 @@ import { intersectionBy } from "../index"; -export = intersectionBy; \ No newline at end of file +export = intersectionBy; diff --git a/types/lodash/intersectionWith/index.d.ts b/types/lodash/intersectionWith/index.d.ts index 6c69b5323b..f6a3ec0dd8 100644 --- a/types/lodash/intersectionWith/index.d.ts +++ b/types/lodash/intersectionWith/index.d.ts @@ -1,2 +1,2 @@ import { intersectionWith } from "../index"; -export = intersectionWith; \ No newline at end of file +export = intersectionWith; diff --git a/types/lodash/invert/index.d.ts b/types/lodash/invert/index.d.ts index 21e2a38243..525a57d57e 100644 --- a/types/lodash/invert/index.d.ts +++ b/types/lodash/invert/index.d.ts @@ -1,2 +1,2 @@ import { invert } from "../index"; -export = invert; \ No newline at end of file +export = invert; diff --git a/types/lodash/invertBy/index.d.ts b/types/lodash/invertBy/index.d.ts index c489f376a2..5e87b4d801 100644 --- a/types/lodash/invertBy/index.d.ts +++ b/types/lodash/invertBy/index.d.ts @@ -1,2 +1,2 @@ import { invertBy } from "../index"; -export = invertBy; \ No newline at end of file +export = invertBy; diff --git a/types/lodash/invoke/index.d.ts b/types/lodash/invoke/index.d.ts index a8ecc5713e..b4457e8b25 100644 --- a/types/lodash/invoke/index.d.ts +++ b/types/lodash/invoke/index.d.ts @@ -1,2 +1,2 @@ import { invoke } from "../index"; -export = invoke; \ No newline at end of file +export = invoke; diff --git a/types/lodash/invokeMap/index.d.ts b/types/lodash/invokeMap/index.d.ts index d4d4ecd4f5..7b2f232247 100644 --- a/types/lodash/invokeMap/index.d.ts +++ b/types/lodash/invokeMap/index.d.ts @@ -1,2 +1,2 @@ import { invokeMap } from "../index"; -export = invokeMap; \ No newline at end of file +export = invokeMap; diff --git a/types/lodash/isArguments/index.d.ts b/types/lodash/isArguments/index.d.ts index c340e2213b..1eab52baf4 100644 --- a/types/lodash/isArguments/index.d.ts +++ b/types/lodash/isArguments/index.d.ts @@ -1,2 +1,2 @@ import { isArguments } from "../index"; -export = isArguments; \ No newline at end of file +export = isArguments; diff --git a/types/lodash/isArray/index.d.ts b/types/lodash/isArray/index.d.ts index cf6bccc392..d25e63b785 100644 --- a/types/lodash/isArray/index.d.ts +++ b/types/lodash/isArray/index.d.ts @@ -1,2 +1,2 @@ import { isArray } from "../index"; -export = isArray; \ No newline at end of file +export = isArray; diff --git a/types/lodash/isArrayBuffer/index.d.ts b/types/lodash/isArrayBuffer/index.d.ts index d7f1adfc48..503f3fffdb 100644 --- a/types/lodash/isArrayBuffer/index.d.ts +++ b/types/lodash/isArrayBuffer/index.d.ts @@ -1,2 +1,2 @@ import { isArrayBuffer } from "../index"; -export = isArrayBuffer; \ No newline at end of file +export = isArrayBuffer; diff --git a/types/lodash/isArrayLike/index.d.ts b/types/lodash/isArrayLike/index.d.ts index 40bfb93a16..706e959347 100644 --- a/types/lodash/isArrayLike/index.d.ts +++ b/types/lodash/isArrayLike/index.d.ts @@ -1,2 +1,2 @@ import { isArrayLike } from "../index"; -export = isArrayLike; \ No newline at end of file +export = isArrayLike; diff --git a/types/lodash/isArrayLikeObject/index.d.ts b/types/lodash/isArrayLikeObject/index.d.ts index 1d0fae7cd8..2336469e2e 100644 --- a/types/lodash/isArrayLikeObject/index.d.ts +++ b/types/lodash/isArrayLikeObject/index.d.ts @@ -1,2 +1,2 @@ import { isArrayLikeObject } from "../index"; -export = isArrayLikeObject; \ No newline at end of file +export = isArrayLikeObject; diff --git a/types/lodash/isBoolean/index.d.ts b/types/lodash/isBoolean/index.d.ts index 641d0a3e24..348c40747c 100644 --- a/types/lodash/isBoolean/index.d.ts +++ b/types/lodash/isBoolean/index.d.ts @@ -1,2 +1,2 @@ import { isBoolean } from "../index"; -export = isBoolean; \ No newline at end of file +export = isBoolean; diff --git a/types/lodash/isBuffer/index.d.ts b/types/lodash/isBuffer/index.d.ts index 96260453e7..2e3f555fbf 100644 --- a/types/lodash/isBuffer/index.d.ts +++ b/types/lodash/isBuffer/index.d.ts @@ -1,2 +1,2 @@ import { isBuffer } from "../index"; -export = isBuffer; \ No newline at end of file +export = isBuffer; diff --git a/types/lodash/isDate/index.d.ts b/types/lodash/isDate/index.d.ts index 671f2f0111..23abc5b9e2 100644 --- a/types/lodash/isDate/index.d.ts +++ b/types/lodash/isDate/index.d.ts @@ -1,2 +1,2 @@ import { isDate } from "../index"; -export = isDate; \ No newline at end of file +export = isDate; diff --git a/types/lodash/isElement/index.d.ts b/types/lodash/isElement/index.d.ts index c533c31990..ccf79d3ad4 100644 --- a/types/lodash/isElement/index.d.ts +++ b/types/lodash/isElement/index.d.ts @@ -1,2 +1,2 @@ import { isElement } from "../index"; -export = isElement; \ No newline at end of file +export = isElement; diff --git a/types/lodash/isEmpty/index.d.ts b/types/lodash/isEmpty/index.d.ts index 8953bc88a5..593a4af122 100644 --- a/types/lodash/isEmpty/index.d.ts +++ b/types/lodash/isEmpty/index.d.ts @@ -1,2 +1,2 @@ import { isEmpty } from "../index"; -export = isEmpty; \ No newline at end of file +export = isEmpty; diff --git a/types/lodash/isEqual/index.d.ts b/types/lodash/isEqual/index.d.ts index 57b5e8eac5..732f1db607 100644 --- a/types/lodash/isEqual/index.d.ts +++ b/types/lodash/isEqual/index.d.ts @@ -1,2 +1,2 @@ import { isEqual } from "../index"; -export = isEqual; \ No newline at end of file +export = isEqual; diff --git a/types/lodash/isEqualWith/index.d.ts b/types/lodash/isEqualWith/index.d.ts index d43f81c209..3f3ffb8d61 100644 --- a/types/lodash/isEqualWith/index.d.ts +++ b/types/lodash/isEqualWith/index.d.ts @@ -1,2 +1,2 @@ import { isEqualWith } from "../index"; -export = isEqualWith; \ No newline at end of file +export = isEqualWith; diff --git a/types/lodash/isError/index.d.ts b/types/lodash/isError/index.d.ts index b56665a1ca..ba36080a20 100644 --- a/types/lodash/isError/index.d.ts +++ b/types/lodash/isError/index.d.ts @@ -1,2 +1,2 @@ import { isError } from "../index"; -export = isError; \ No newline at end of file +export = isError; diff --git a/types/lodash/isFinite/index.d.ts b/types/lodash/isFinite/index.d.ts index bc1dcd04ef..55e07fe26b 100644 --- a/types/lodash/isFinite/index.d.ts +++ b/types/lodash/isFinite/index.d.ts @@ -1,2 +1,2 @@ import { isFinite } from "../index"; -export = isFinite; \ No newline at end of file +export = isFinite; diff --git a/types/lodash/isFunction/index.d.ts b/types/lodash/isFunction/index.d.ts index b67b30d201..3a0f17bae3 100644 --- a/types/lodash/isFunction/index.d.ts +++ b/types/lodash/isFunction/index.d.ts @@ -1,2 +1,2 @@ import { isFunction } from "../index"; -export = isFunction; \ No newline at end of file +export = isFunction; diff --git a/types/lodash/isInteger/index.d.ts b/types/lodash/isInteger/index.d.ts index bdc8732dc6..271a02cbc9 100644 --- a/types/lodash/isInteger/index.d.ts +++ b/types/lodash/isInteger/index.d.ts @@ -1,2 +1,2 @@ import { isInteger } from "../index"; -export = isInteger; \ No newline at end of file +export = isInteger; diff --git a/types/lodash/isLength/index.d.ts b/types/lodash/isLength/index.d.ts index 7d3044c7a7..d930fb357f 100644 --- a/types/lodash/isLength/index.d.ts +++ b/types/lodash/isLength/index.d.ts @@ -1,2 +1,2 @@ import { isLength } from "../index"; -export = isLength; \ No newline at end of file +export = isLength; diff --git a/types/lodash/isMap/index.d.ts b/types/lodash/isMap/index.d.ts index 55fa964b92..579632c190 100644 --- a/types/lodash/isMap/index.d.ts +++ b/types/lodash/isMap/index.d.ts @@ -1,2 +1,2 @@ import { isMap } from "../index"; -export = isMap; \ No newline at end of file +export = isMap; diff --git a/types/lodash/isMatch/index.d.ts b/types/lodash/isMatch/index.d.ts index e0fe216b20..d0ad2c8f4d 100644 --- a/types/lodash/isMatch/index.d.ts +++ b/types/lodash/isMatch/index.d.ts @@ -1,2 +1,2 @@ import { isMatch } from "../index"; -export = isMatch; \ No newline at end of file +export = isMatch; diff --git a/types/lodash/isMatchWith/index.d.ts b/types/lodash/isMatchWith/index.d.ts index 826b89a9d5..07e83bfe93 100644 --- a/types/lodash/isMatchWith/index.d.ts +++ b/types/lodash/isMatchWith/index.d.ts @@ -1,2 +1,2 @@ import { isMatchWith } from "../index"; -export = isMatchWith; \ No newline at end of file +export = isMatchWith; diff --git a/types/lodash/isNaN/index.d.ts b/types/lodash/isNaN/index.d.ts index c3aac0325a..e2c48a8f47 100644 --- a/types/lodash/isNaN/index.d.ts +++ b/types/lodash/isNaN/index.d.ts @@ -1,2 +1,2 @@ import { isNaN } from "../index"; -export = isNaN; \ No newline at end of file +export = isNaN; diff --git a/types/lodash/isNative/index.d.ts b/types/lodash/isNative/index.d.ts index 5ebd0dd433..6f32bd4138 100644 --- a/types/lodash/isNative/index.d.ts +++ b/types/lodash/isNative/index.d.ts @@ -1,2 +1,2 @@ import { isNative } from "../index"; -export = isNative; \ No newline at end of file +export = isNative; diff --git a/types/lodash/isNil/index.d.ts b/types/lodash/isNil/index.d.ts index eb45696d78..46f4928dda 100644 --- a/types/lodash/isNil/index.d.ts +++ b/types/lodash/isNil/index.d.ts @@ -1,2 +1,2 @@ import { isNil } from "../index"; -export = isNil; \ No newline at end of file +export = isNil; diff --git a/types/lodash/isNull/index.d.ts b/types/lodash/isNull/index.d.ts index 534886638c..a8ff0aa678 100644 --- a/types/lodash/isNull/index.d.ts +++ b/types/lodash/isNull/index.d.ts @@ -1,2 +1,2 @@ import { isNull } from "../index"; -export = isNull; \ No newline at end of file +export = isNull; diff --git a/types/lodash/isNumber/index.d.ts b/types/lodash/isNumber/index.d.ts index 5a8b9d82a9..13dd5e71df 100644 --- a/types/lodash/isNumber/index.d.ts +++ b/types/lodash/isNumber/index.d.ts @@ -1,2 +1,2 @@ import { isNumber } from "../index"; -export = isNumber; \ No newline at end of file +export = isNumber; diff --git a/types/lodash/isObject/index.d.ts b/types/lodash/isObject/index.d.ts index 8ffd829177..782c639180 100644 --- a/types/lodash/isObject/index.d.ts +++ b/types/lodash/isObject/index.d.ts @@ -1,2 +1,2 @@ import { isObject } from "../index"; -export = isObject; \ No newline at end of file +export = isObject; diff --git a/types/lodash/isObjectLike/index.d.ts b/types/lodash/isObjectLike/index.d.ts index d8ccba7e88..1f3e27b9e3 100644 --- a/types/lodash/isObjectLike/index.d.ts +++ b/types/lodash/isObjectLike/index.d.ts @@ -1,2 +1,2 @@ import { isObjectLike } from "../index"; -export = isObjectLike; \ No newline at end of file +export = isObjectLike; diff --git a/types/lodash/isPlainObject/index.d.ts b/types/lodash/isPlainObject/index.d.ts index c475c55813..5f474f0259 100644 --- a/types/lodash/isPlainObject/index.d.ts +++ b/types/lodash/isPlainObject/index.d.ts @@ -1,2 +1,2 @@ import { isPlainObject } from "../index"; -export = isPlainObject; \ No newline at end of file +export = isPlainObject; diff --git a/types/lodash/isRegExp/index.d.ts b/types/lodash/isRegExp/index.d.ts index ec98ecb1c5..aa85288df5 100644 --- a/types/lodash/isRegExp/index.d.ts +++ b/types/lodash/isRegExp/index.d.ts @@ -1,2 +1,2 @@ import { isRegExp } from "../index"; -export = isRegExp; \ No newline at end of file +export = isRegExp; diff --git a/types/lodash/isSafeInteger/index.d.ts b/types/lodash/isSafeInteger/index.d.ts index d01b370acc..e3002bd6b9 100644 --- a/types/lodash/isSafeInteger/index.d.ts +++ b/types/lodash/isSafeInteger/index.d.ts @@ -1,2 +1,2 @@ import { isSafeInteger } from "../index"; -export = isSafeInteger; \ No newline at end of file +export = isSafeInteger; diff --git a/types/lodash/isSet/index.d.ts b/types/lodash/isSet/index.d.ts index c08ee683ba..e7f1b52379 100644 --- a/types/lodash/isSet/index.d.ts +++ b/types/lodash/isSet/index.d.ts @@ -1,2 +1,2 @@ import { isSet } from "../index"; -export = isSet; \ No newline at end of file +export = isSet; diff --git a/types/lodash/isString/index.d.ts b/types/lodash/isString/index.d.ts index 2413f17435..1f791b7d92 100644 --- a/types/lodash/isString/index.d.ts +++ b/types/lodash/isString/index.d.ts @@ -1,2 +1,2 @@ import { isString } from "../index"; -export = isString; \ No newline at end of file +export = isString; diff --git a/types/lodash/isSymbol/index.d.ts b/types/lodash/isSymbol/index.d.ts index eba542157f..15c9097d3f 100644 --- a/types/lodash/isSymbol/index.d.ts +++ b/types/lodash/isSymbol/index.d.ts @@ -1,2 +1,2 @@ import { isSymbol } from "../index"; -export = isSymbol; \ No newline at end of file +export = isSymbol; diff --git a/types/lodash/isTypedArray/index.d.ts b/types/lodash/isTypedArray/index.d.ts index 0320879333..8856310cd6 100644 --- a/types/lodash/isTypedArray/index.d.ts +++ b/types/lodash/isTypedArray/index.d.ts @@ -1,2 +1,2 @@ import { isTypedArray } from "../index"; -export = isTypedArray; \ No newline at end of file +export = isTypedArray; diff --git a/types/lodash/isUndefined/index.d.ts b/types/lodash/isUndefined/index.d.ts index 8efbb37b1f..dbb326461e 100644 --- a/types/lodash/isUndefined/index.d.ts +++ b/types/lodash/isUndefined/index.d.ts @@ -1,2 +1,2 @@ import { isUndefined } from "../index"; -export = isUndefined; \ No newline at end of file +export = isUndefined; diff --git a/types/lodash/isWeakMap/index.d.ts b/types/lodash/isWeakMap/index.d.ts index 69caa4c956..954f587ecf 100644 --- a/types/lodash/isWeakMap/index.d.ts +++ b/types/lodash/isWeakMap/index.d.ts @@ -1,2 +1,2 @@ import { isWeakMap } from "../index"; -export = isWeakMap; \ No newline at end of file +export = isWeakMap; diff --git a/types/lodash/isWeakSet/index.d.ts b/types/lodash/isWeakSet/index.d.ts index d0cf33fdd6..28a84390d8 100644 --- a/types/lodash/isWeakSet/index.d.ts +++ b/types/lodash/isWeakSet/index.d.ts @@ -1,2 +1,2 @@ import { isWeakSet } from "../index"; -export = isWeakSet; \ No newline at end of file +export = isWeakSet; diff --git a/types/lodash/iteratee/index.d.ts b/types/lodash/iteratee/index.d.ts index 81764d4ad2..2969a1f3e4 100644 --- a/types/lodash/iteratee/index.d.ts +++ b/types/lodash/iteratee/index.d.ts @@ -1,2 +1,2 @@ import { iteratee } from "../index"; -export = iteratee; \ No newline at end of file +export = iteratee; diff --git a/types/lodash/join/index.d.ts b/types/lodash/join/index.d.ts index 2c2bd4f91e..ba5a4a26a7 100644 --- a/types/lodash/join/index.d.ts +++ b/types/lodash/join/index.d.ts @@ -1,2 +1,2 @@ import { join } from "../index"; -export = join; \ No newline at end of file +export = join; diff --git a/types/lodash/kebabCase/index.d.ts b/types/lodash/kebabCase/index.d.ts index 73576c0249..875a153635 100644 --- a/types/lodash/kebabCase/index.d.ts +++ b/types/lodash/kebabCase/index.d.ts @@ -1,2 +1,2 @@ import { kebabCase } from "../index"; -export = kebabCase; \ No newline at end of file +export = kebabCase; diff --git a/types/lodash/keyBy/index.d.ts b/types/lodash/keyBy/index.d.ts index 80a0a4d7c9..93f370b5a7 100644 --- a/types/lodash/keyBy/index.d.ts +++ b/types/lodash/keyBy/index.d.ts @@ -1,2 +1,2 @@ import { keyBy } from "../index"; -export = keyBy; \ No newline at end of file +export = keyBy; diff --git a/types/lodash/keys/index.d.ts b/types/lodash/keys/index.d.ts index 53693b5705..3a19ec5b7a 100644 --- a/types/lodash/keys/index.d.ts +++ b/types/lodash/keys/index.d.ts @@ -1,2 +1,2 @@ import { keys } from "../index"; -export = keys; \ No newline at end of file +export = keys; diff --git a/types/lodash/keysIn/index.d.ts b/types/lodash/keysIn/index.d.ts index e0747ccc46..159a7e9b8c 100644 --- a/types/lodash/keysIn/index.d.ts +++ b/types/lodash/keysIn/index.d.ts @@ -1,2 +1,2 @@ import { keysIn } from "../index"; -export = keysIn; \ No newline at end of file +export = keysIn; diff --git a/types/lodash/last/index.d.ts b/types/lodash/last/index.d.ts index 2590a6ac4f..8b56dda8bf 100644 --- a/types/lodash/last/index.d.ts +++ b/types/lodash/last/index.d.ts @@ -1,2 +1,2 @@ import { last } from "../index"; -export = last; \ No newline at end of file +export = last; diff --git a/types/lodash/lastIndexOf/index.d.ts b/types/lodash/lastIndexOf/index.d.ts index 8e83b85f3b..47a9e1fef9 100644 --- a/types/lodash/lastIndexOf/index.d.ts +++ b/types/lodash/lastIndexOf/index.d.ts @@ -1,2 +1,2 @@ import { lastIndexOf } from "../index"; -export = lastIndexOf; \ No newline at end of file +export = lastIndexOf; diff --git a/types/lodash/lodash-tests.ts b/types/lodash/lodash-tests.ts index b260df8ee5..a168825dad 100644 --- a/types/lodash/lodash-tests.ts +++ b/types/lodash/lodash-tests.ts @@ -1,4 +1,4 @@ -declare var $: any, jQuery: any; +declare const $: any, jQuery: any; interface IFoodOrganic { name: string; @@ -41,38 +41,38 @@ interface IDictionary { [index: string]: T; } -var foodsOrganic: IFoodOrganic[] = [ +const foodsOrganic: IFoodOrganic[] = [ { name: 'banana', organic: true }, { name: 'beet', organic: false }, ]; -var foodsType: IFoodType[] = [ +const foodsType: IFoodType[] = [ { name: 'apple', type: 'fruit' }, { name: 'banana', type: 'fruit' }, { name: 'beet', type: 'vegetable' } ]; -var foodsCombined: IFoodCombined[] = [ +const foodsCombined: IFoodCombined[] = [ { 'name': 'apple', 'organic': false, 'type': 'fruit' }, { 'name': 'carrot', 'organic': true, 'type': 'vegetable' } ]; -var stoogesQuotes: IStoogesQuote[] = [ +const stoogesQuotes: IStoogesQuote[] = [ { 'name': 'curly', 'quotes': ['Oh, a wise guy, eh?', 'Poifect!'] }, { 'name': 'moe', 'quotes': ['Spread out!', 'You knucklehead!'] } ]; -var stoogesAges: IStoogesAge[] = [ +const stoogesAges: IStoogesAge[] = [ { 'name': 'moe', 'age': 40 }, { 'name': 'larry', 'age': 50 } ]; -var stoogesAgesDict: IDictionary = { +const stoogesAgesDict: IDictionary = { first: { 'name': 'moe', 'age': 40 }, second: { 'name': 'larry', 'age': 50 } }; -var stoogesCombined: IStoogesCombined[] = [ +const stoogesCombined: IStoogesCombined[] = [ { 'name': 'curly', 'age': 30, 'quotes': ['Oh, a wise guy, eh?', 'Poifect!'] }, { 'name': 'moe', 'age': 40, 'quotes': ['Spread out!', 'You knucklehead!'] } ]; -var keys: IKey[] = [ +const keys: IKey[] = [ { 'dir': 'left', 'code': 97 }, { 'dir': 'right', 'code': 100 } ]; @@ -85,9 +85,9 @@ class Dog { } } -var result: any; +let result: any; -var any: any; +let any: any; interface TResult { a: number; @@ -96,7 +96,7 @@ interface TResult { } // _.MapCache -var testMapCache: _.MapCache; +let testMapCache: _.MapCache; result = <(key: string) => boolean>testMapCache.delete; result = <(key: string) => any>testMapCache.get; result = <(key: string) => boolean>testMapCache.has; @@ -498,7 +498,6 @@ namespace TestDropRight { result = _.dropRight(list); result = _.dropRight(list, 42); - } { @@ -1488,7 +1487,6 @@ namespace TestTail { result = _.tail(array); result = _.tail(list); - } { @@ -1562,7 +1560,6 @@ namespace TestSortedIndex { result = _(array).sortedIndex(value); result = _(list).sortedIndex(value); - } { @@ -1573,7 +1570,6 @@ namespace TestSortedIndex { result = _(array).chain().sortedIndex(value); result = _(list).chain().sortedIndex(value); - } } @@ -1749,7 +1745,6 @@ namespace TestTail { result = _.tail(array); result = _.tail(list); - } { @@ -2197,11 +2192,9 @@ namespace TestUniq { result = _(array).chain().uniq(); result = _(list).chain().uniq(); - } } - // _.uniqBy namespace TestUniqBy { type SampleObject = {a: number; b: string; c: boolean}; @@ -2702,7 +2695,7 @@ namespace TestZipObject { interface TestZipWithFn { (a1: number, a2: number): number; } -var testZipWithFn: TestZipWithFn; +let testZipWithFn: TestZipWithFn; result = _.zipWith([1, 2]); result = _.zipWith([1, 2], testZipWithFn); result = _.zipWith([1, 2], [1, 2], testZipWithFn); @@ -5209,7 +5202,6 @@ result = _.sortBy(stoogesAges, 'name', stooge => Math.sin(stooge. result = _(foodsOrganic).sortBy('organic', (food) => food.name, { organic: true }).value(); - // _.orderBy namespace TestorderBy { type SampleObject = {a: number; b: string; c: boolean}; @@ -5533,7 +5525,7 @@ namespace TestBindAll { // _.bindKey namespace TestBindKey { let object: { - foo: (a: number, b: string) => boolean; + foo(a: number, b: string): boolean; } { @@ -5612,14 +5604,14 @@ namespace TestBindKey { } } -var createCallbackObj: { [index: string]: string; } = { name: 'Joe' }; +const createCallbackObj: { [index: string]: string; } = { name: 'Joe' }; result = <() => any>_.createCallback('name'); result = <() => boolean>_.createCallback(createCallbackObj); result = <_.LoDashImplicitObjectWrapper<() => any>>_('name').createCallback(); result = <_.LoDashImplicitObjectWrapper<() => boolean>>_(createCallbackObj).createCallback(); // _.curry -var testCurryFn = (a: number, b: number, c: number) => [a, b, c]; +const testCurryFn = (a: number, b: number, c: number) => [a, b, c]; let curryResult0: number[] let curryResult1: _.CurriedFunction1 let curryResult2: _.CurriedFunction2 @@ -5650,7 +5642,7 @@ curryResult5 = _.curry(testCurry2)("1"); curryResult6 = _.curry(testCurry2); // _.curryRight -var testCurryRightFn = (a: number, b: number, c: number) => [a, b, c]; +const testCurryRightFn = (a: number, b: number, c: number) => [a, b, c]; curryResult0 = _.curryRight(testCurryRightFn)(1, 2, 3); curryResult2 = _.curryRight(testCurryRightFn)(1); curryResult0 = _(testCurryRightFn).curryRight().value()(1, 2, 3); @@ -5996,7 +5988,7 @@ namespace TestNegate { (a1: number, a2: number): boolean; } - var predicate = (a1: number, a2: number) => a1 > a2; + const predicate = (a1: number, a2: number) => a1 > a2; { let result: ResultFn; @@ -6047,14 +6039,13 @@ namespace TestOnce { } } -var greetPartial = (greeting: string, name: string) => greeting + ' ' + name; -var hi = _.partial(greetPartial, 'hi'); +const greetPartial = (greeting: string, name: string) => greeting + ' ' + name; +const hi = _.partial(greetPartial, 'hi'); hi('moe'); +const defaultsDeep = _.partialRight(_.merge, _.defaults); -var defaultsDeep = _.partialRight(_.merge, _.defaults); - -var optionsPartialRight = { +const optionsPartialRight = { 'variable': 'data', 'imports': { 'jq': $ } }; @@ -6062,7 +6053,7 @@ var optionsPartialRight = { defaultsDeep(optionsPartialRight, _.templateSettings); //_.rearg -var testReargFn = (a: string, b: string, c: string) => [a, b, c]; +const testReargFn = (a: string, b: string, c: string) => [a, b, c]; interface TestReargResultFn { (b: string, c: string, a: string): string[]; } @@ -7102,7 +7093,6 @@ namespace TestIsMatch { result = _({}).isMatch({}); } - // _.isMatchWith namespace TestIsMatchWith { let testIsMatchCustiomizerFn: (value: any, other: any, indexOrKey: number|string) => boolean; @@ -7111,7 +7101,6 @@ namespace TestIsMatchWith { result = _.isMatchWith({}, {}, testIsMatchCustiomizerFn); result = _({}).isMatchWith({}, testIsMatchCustiomizerFn); - } // _.isNaN @@ -7634,7 +7623,6 @@ namespace TestToArray { // _.toPlainObject namespace TestToPlainObject { - { let result: TResult; result = _.toPlainObject(); @@ -7877,7 +7865,6 @@ namespace TestMean { result = _.mean(array); result = _(array).mean(); - } // _.min @@ -7892,7 +7879,6 @@ namespace TestMin { result = _(array).min(); result = _(list).min(); - } // _.minBy @@ -8634,7 +8620,6 @@ namespace TestCreate { } } - // _.defaults namespace TestDefaults { interface Obj { a: string }; @@ -8767,12 +8752,11 @@ interface DefaultsDeepResult { age: number; } } -var TestDefaultsDeepObject = { 'user': { 'name': 'barney' } }; -var TestDefaultsDeepSource = { 'user': { 'name': 'fred', 'age': 36 } }; +const TestDefaultsDeepObject = { 'user': { 'name': 'barney' } }; +const TestDefaultsDeepSource = { 'user': { 'name': 'fred', 'age': 36 } }; result = _.defaultsDeep(TestDefaultsDeepObject, TestDefaultsDeepSource); result = _(TestDefaultsDeepObject).defaultsDeep(TestDefaultsDeepSource).value(); - // _.extend namespace TestExtend { type Obj = { a: string }; @@ -8900,7 +8884,6 @@ namespace TestExtend { } } - // _.extendWith namespace TestExtendWith { type Obj = { a: string }; @@ -9038,7 +9021,6 @@ namespace TestFindKey { result = _.findKey<{a: string;}>({a: ''}, predicateFn); - result = _.findKey<{a: string;}>({a: ''}, ''); result = _.findKey<{a: number;}, {a: string;}>({a: ''}, {a: 42}); @@ -9047,7 +9029,6 @@ namespace TestFindKey { result = _<{a: string;}>({a: ''}).findKey(predicateFn); - result = _<{a: string;}>({a: ''}).findKey(''); result = _<{a: string;}>({a: ''}).findKey<{a: number;}>({a: 42}); @@ -9070,7 +9051,6 @@ namespace TestFindKey { result = _<{a: string;}>({a: ''}).chain().findKey(predicateFn); - result = _<{a: string;}>({a: ''}).chain().findKey(''); result = _<{a: string;}>({a: ''}).chain().findKey<{a: number;}>({a: 42}); @@ -9094,7 +9074,6 @@ namespace TestFindLastKey { result = _.findLastKey<{a: string;}>({a: ''}, predicateFn); - result = _.findLastKey<{a: string;}>({a: ''}, ''); result = _.findLastKey<{a: number;}, {a: string;}>({a: ''}, {a: 42}); @@ -9103,7 +9082,6 @@ namespace TestFindLastKey { result = _<{a: string;}>({a: ''}).findLastKey(predicateFn); - result = _<{a: string;}>({a: ''}).findLastKey(''); result = _<{a: string;}>({a: ''}).findLastKey<{a: number;}>({a: 42}); @@ -9126,7 +9104,6 @@ namespace TestFindLastKey { result = _<{a: string;}>({a: ''}).chain().findLastKey(predicateFn); - result = _<{a: string;}>({a: ''}).chain().findLastKey(''); result = _<{a: string;}>({a: ''}).chain().findLastKey<{a: number;}>({a: 42}); @@ -9733,8 +9710,8 @@ namespace TestMerge { type InitialValue = { a : number }; type MergingValue = { b : string }; - var initialValue = { a : 1 }; - var mergingValue = { b : "hi" }; + const initialValue = { a : 1 }; + const mergingValue = { b : "hi" }; type ExpectedResult = { a: number, b: string }; let result: ExpectedResult; @@ -9752,10 +9729,9 @@ namespace TestMerge { // Once we get to the varargs version, you have to specify the result explicitly result = _.merge(initialValue, {}, {}, {}, {}, mergingValue); - type ComplicatedExpectedType = { a: number, b: string, c: {}, d: number[], e: boolean }; - var complicatedResult: ComplicatedExpectedType = _.merge({ a: 1 }, + let complicatedResult: ComplicatedExpectedType = _.merge({ a: 1 }, { b: "string" }, { c: {} }, { d: [1] }, @@ -9764,7 +9740,7 @@ namespace TestMerge { type ExpectedTypeAfterOverriding = { a: boolean }; - var overriddenResult: ExpectedTypeAfterOverriding = _.merge({ a: 1 }, + let overriddenResult: ExpectedTypeAfterOverriding = _.merge({ a: 1 }, { a: "string" }, { a: {} }, { a: [1] }, @@ -9785,14 +9761,14 @@ namespace TestMerge { // Test complex multiple combinations with chaining - var complicatedResult: ComplicatedExpectedType = _({ a: 1 }).merge({ b: "string" }, + complicatedResult = _({ a: 1 }).merge({ b: "string" }, { c: {} }, { d: [1] }, { e: true }).value(); // Test for type overriding with chaining - var overriddenResult: ExpectedTypeAfterOverriding = _({ a: 1 }).merge({ a: "string" }, + overriddenResult = _({ a: 1 }).merge({ a: "string" }, { a: {} }, { a: [1] }, { a: true }).value(); @@ -9824,8 +9800,8 @@ namespace TestMergeWith { type InitialValue = { a : number }; type MergingValue = { b : string }; - var initialValue = { a : 1 }; - var mergingValue = { b : "hi" }; + const initialValue = { a : 1 }; + const mergingValue = { b : "hi" }; type ExpectedResult = { a: number, b: string }; let result: ExpectedResult; @@ -11115,7 +11091,6 @@ namespace TestUnescape { } } - // _.upperCase namespace TestUpperCase { { @@ -11387,7 +11362,6 @@ namespace TestDefaultTo { result = _(null).chain().defaultTo({a : 'a'}); result = _(NaN).chain().defaultTo({a : 'a'}); } - } // _.identity @@ -11643,7 +11617,7 @@ namespace TestMethod { // _.methodOf namespace TestMethodOf { - type SampleObject = {a: {b: () => TResult}[]}; + type SampleObject = { a: { b(): TResult }[] }; type ResultFn = (path: _.StringRepresentable|_.StringRepresentable[]) => TResult; let object: SampleObject; diff --git a/types/lodash/lowerCase/index.d.ts b/types/lodash/lowerCase/index.d.ts index 0f949d854d..792ecb2fca 100644 --- a/types/lodash/lowerCase/index.d.ts +++ b/types/lodash/lowerCase/index.d.ts @@ -1,2 +1,2 @@ import { lowerCase } from "../index"; -export = lowerCase; \ No newline at end of file +export = lowerCase; diff --git a/types/lodash/lowerFirst/index.d.ts b/types/lodash/lowerFirst/index.d.ts index ef7f89f0ad..57d5a9c60e 100644 --- a/types/lodash/lowerFirst/index.d.ts +++ b/types/lodash/lowerFirst/index.d.ts @@ -1,2 +1,2 @@ import { lowerFirst } from "../index"; -export = lowerFirst; \ No newline at end of file +export = lowerFirst; diff --git a/types/lodash/lt/index.d.ts b/types/lodash/lt/index.d.ts index 827f2ea49a..483de251ea 100644 --- a/types/lodash/lt/index.d.ts +++ b/types/lodash/lt/index.d.ts @@ -1,2 +1,2 @@ import { lt } from "../index"; -export = lt; \ No newline at end of file +export = lt; diff --git a/types/lodash/lte/index.d.ts b/types/lodash/lte/index.d.ts index 095b471f0b..62e11824f5 100644 --- a/types/lodash/lte/index.d.ts +++ b/types/lodash/lte/index.d.ts @@ -1,2 +1,2 @@ import { lte } from "../index"; -export = lte; \ No newline at end of file +export = lte; diff --git a/types/lodash/map/index.d.ts b/types/lodash/map/index.d.ts index caf04d4309..055e43250f 100644 --- a/types/lodash/map/index.d.ts +++ b/types/lodash/map/index.d.ts @@ -1,2 +1,2 @@ import { map } from "../index"; -export = map; \ No newline at end of file +export = map; diff --git a/types/lodash/mapKeys/index.d.ts b/types/lodash/mapKeys/index.d.ts index c30ea40d4a..b830255f5e 100644 --- a/types/lodash/mapKeys/index.d.ts +++ b/types/lodash/mapKeys/index.d.ts @@ -1,2 +1,2 @@ import { mapKeys } from "../index"; -export = mapKeys; \ No newline at end of file +export = mapKeys; diff --git a/types/lodash/mapValues/index.d.ts b/types/lodash/mapValues/index.d.ts index 01d43efac4..60df8d2502 100644 --- a/types/lodash/mapValues/index.d.ts +++ b/types/lodash/mapValues/index.d.ts @@ -1,2 +1,2 @@ import { mapValues } from "../index"; -export = mapValues; \ No newline at end of file +export = mapValues; diff --git a/types/lodash/matches/index.d.ts b/types/lodash/matches/index.d.ts index 320bcb1a15..bd88217869 100644 --- a/types/lodash/matches/index.d.ts +++ b/types/lodash/matches/index.d.ts @@ -1,2 +1,2 @@ import { matches } from "../index"; -export = matches; \ No newline at end of file +export = matches; diff --git a/types/lodash/matchesProperty/index.d.ts b/types/lodash/matchesProperty/index.d.ts index 58a98d9619..342aa1c70f 100644 --- a/types/lodash/matchesProperty/index.d.ts +++ b/types/lodash/matchesProperty/index.d.ts @@ -1,2 +1,2 @@ import { matchesProperty } from "../index"; -export = matchesProperty; \ No newline at end of file +export = matchesProperty; diff --git a/types/lodash/max/index.d.ts b/types/lodash/max/index.d.ts index d532530e30..8bce255b0e 100644 --- a/types/lodash/max/index.d.ts +++ b/types/lodash/max/index.d.ts @@ -1,2 +1,2 @@ import { max } from "../index"; -export = max; \ No newline at end of file +export = max; diff --git a/types/lodash/maxBy/index.d.ts b/types/lodash/maxBy/index.d.ts index 2a8f023c94..2a3f4f9e18 100644 --- a/types/lodash/maxBy/index.d.ts +++ b/types/lodash/maxBy/index.d.ts @@ -1,2 +1,2 @@ import { maxBy } from "../index"; -export = maxBy; \ No newline at end of file +export = maxBy; diff --git a/types/lodash/mean/index.d.ts b/types/lodash/mean/index.d.ts index 21e660ab51..0265e22a76 100644 --- a/types/lodash/mean/index.d.ts +++ b/types/lodash/mean/index.d.ts @@ -1,2 +1,2 @@ import { mean } from "../index"; -export = mean; \ No newline at end of file +export = mean; diff --git a/types/lodash/meanBy/index.d.ts b/types/lodash/meanBy/index.d.ts index e4651a4412..58b90c7694 100644 --- a/types/lodash/meanBy/index.d.ts +++ b/types/lodash/meanBy/index.d.ts @@ -1,2 +1,2 @@ import { meanBy } from "../index"; -export = meanBy; \ No newline at end of file +export = meanBy; diff --git a/types/lodash/memoize/index.d.ts b/types/lodash/memoize/index.d.ts index 676d3c7884..ce92f6eba1 100644 --- a/types/lodash/memoize/index.d.ts +++ b/types/lodash/memoize/index.d.ts @@ -1,2 +1,2 @@ import { memoize } from "../index"; -export = memoize; \ No newline at end of file +export = memoize; diff --git a/types/lodash/merge/index.d.ts b/types/lodash/merge/index.d.ts index 5e3ac2b3e1..a2d07fa045 100644 --- a/types/lodash/merge/index.d.ts +++ b/types/lodash/merge/index.d.ts @@ -1,2 +1,2 @@ import { merge } from "../index"; -export = merge; \ No newline at end of file +export = merge; diff --git a/types/lodash/mergeWith/index.d.ts b/types/lodash/mergeWith/index.d.ts index 3141da1f87..bd7b7b2be7 100644 --- a/types/lodash/mergeWith/index.d.ts +++ b/types/lodash/mergeWith/index.d.ts @@ -1,2 +1,2 @@ import { mergeWith } from "../index"; -export = mergeWith; \ No newline at end of file +export = mergeWith; diff --git a/types/lodash/method/index.d.ts b/types/lodash/method/index.d.ts index a2efc6992c..38b265b19a 100644 --- a/types/lodash/method/index.d.ts +++ b/types/lodash/method/index.d.ts @@ -1,2 +1,2 @@ import { method } from "../index"; -export = method; \ No newline at end of file +export = method; diff --git a/types/lodash/methodOf/index.d.ts b/types/lodash/methodOf/index.d.ts index 74c092ea97..817f1518b2 100644 --- a/types/lodash/methodOf/index.d.ts +++ b/types/lodash/methodOf/index.d.ts @@ -1,2 +1,2 @@ import { methodOf } from "../index"; -export = methodOf; \ No newline at end of file +export = methodOf; diff --git a/types/lodash/min/index.d.ts b/types/lodash/min/index.d.ts index 9289b95bbc..1b51b9d6de 100644 --- a/types/lodash/min/index.d.ts +++ b/types/lodash/min/index.d.ts @@ -1,2 +1,2 @@ import { min } from "../index"; -export = min; \ No newline at end of file +export = min; diff --git a/types/lodash/minBy/index.d.ts b/types/lodash/minBy/index.d.ts index 703e8cbf58..4c4b8fb3ae 100644 --- a/types/lodash/minBy/index.d.ts +++ b/types/lodash/minBy/index.d.ts @@ -1,2 +1,2 @@ import { minBy } from "../index"; -export = minBy; \ No newline at end of file +export = minBy; diff --git a/types/lodash/mixin/index.d.ts b/types/lodash/mixin/index.d.ts index fedace0795..7bd81f8005 100644 --- a/types/lodash/mixin/index.d.ts +++ b/types/lodash/mixin/index.d.ts @@ -1,2 +1,2 @@ import { mixin } from "../index"; -export = mixin; \ No newline at end of file +export = mixin; diff --git a/types/lodash/negate/index.d.ts b/types/lodash/negate/index.d.ts index 7020b8f0b1..e538c5cd67 100644 --- a/types/lodash/negate/index.d.ts +++ b/types/lodash/negate/index.d.ts @@ -1,2 +1,2 @@ import { negate } from "../index"; -export = negate; \ No newline at end of file +export = negate; diff --git a/types/lodash/noConflict/index.d.ts b/types/lodash/noConflict/index.d.ts index 1b38b9d530..228f39cae5 100644 --- a/types/lodash/noConflict/index.d.ts +++ b/types/lodash/noConflict/index.d.ts @@ -1,2 +1,2 @@ import { noConflict } from "../index"; -export = noConflict; \ No newline at end of file +export = noConflict; diff --git a/types/lodash/noop/index.d.ts b/types/lodash/noop/index.d.ts index 0ce69cbefa..eb4a36bb7c 100644 --- a/types/lodash/noop/index.d.ts +++ b/types/lodash/noop/index.d.ts @@ -1,2 +1,2 @@ import { noop } from "../index"; -export = noop; \ No newline at end of file +export = noop; diff --git a/types/lodash/now/index.d.ts b/types/lodash/now/index.d.ts index 8f81c014af..b603059fb5 100644 --- a/types/lodash/now/index.d.ts +++ b/types/lodash/now/index.d.ts @@ -1,2 +1,2 @@ import { now } from "../index"; -export = now; \ No newline at end of file +export = now; diff --git a/types/lodash/nth/index.d.ts b/types/lodash/nth/index.d.ts index afbe952398..709c6df8b5 100644 --- a/types/lodash/nth/index.d.ts +++ b/types/lodash/nth/index.d.ts @@ -1,2 +1,2 @@ import { nth } from "../index"; -export = nth; \ No newline at end of file +export = nth; diff --git a/types/lodash/nthArg/index.d.ts b/types/lodash/nthArg/index.d.ts index d2b699e32a..9fd0b4540c 100644 --- a/types/lodash/nthArg/index.d.ts +++ b/types/lodash/nthArg/index.d.ts @@ -1,2 +1,2 @@ import { nthArg } from "../index"; -export = nthArg; \ No newline at end of file +export = nthArg; diff --git a/types/lodash/omit/index.d.ts b/types/lodash/omit/index.d.ts index c474c36895..3c92d6293e 100644 --- a/types/lodash/omit/index.d.ts +++ b/types/lodash/omit/index.d.ts @@ -1,2 +1,2 @@ import { omit } from "../index"; -export = omit; \ No newline at end of file +export = omit; diff --git a/types/lodash/omitBy/index.d.ts b/types/lodash/omitBy/index.d.ts index f91e134545..d92d14852e 100644 --- a/types/lodash/omitBy/index.d.ts +++ b/types/lodash/omitBy/index.d.ts @@ -1,2 +1,2 @@ import { omitBy } from "../index"; -export = omitBy; \ No newline at end of file +export = omitBy; diff --git a/types/lodash/once/index.d.ts b/types/lodash/once/index.d.ts index eca2c3fbc0..369fcc08ac 100644 --- a/types/lodash/once/index.d.ts +++ b/types/lodash/once/index.d.ts @@ -1,2 +1,2 @@ import { once } from "../index"; -export = once; \ No newline at end of file +export = once; diff --git a/types/lodash/orderBy/index.d.ts b/types/lodash/orderBy/index.d.ts index 9283bbba9e..57dc0723d8 100644 --- a/types/lodash/orderBy/index.d.ts +++ b/types/lodash/orderBy/index.d.ts @@ -1,2 +1,2 @@ import { orderBy } from "../index"; -export = orderBy; \ No newline at end of file +export = orderBy; diff --git a/types/lodash/over/index.d.ts b/types/lodash/over/index.d.ts index 631a2a3cc3..0f92ad9429 100644 --- a/types/lodash/over/index.d.ts +++ b/types/lodash/over/index.d.ts @@ -1,2 +1,2 @@ import { over } from "../index"; -export = over; \ No newline at end of file +export = over; diff --git a/types/lodash/overArgs/index.d.ts b/types/lodash/overArgs/index.d.ts index aa8cf236e8..07f93f9698 100644 --- a/types/lodash/overArgs/index.d.ts +++ b/types/lodash/overArgs/index.d.ts @@ -1,2 +1,2 @@ import { overArgs } from "../index"; -export = overArgs; \ No newline at end of file +export = overArgs; diff --git a/types/lodash/overEvery/index.d.ts b/types/lodash/overEvery/index.d.ts index d0fa45c9d3..8533d45602 100644 --- a/types/lodash/overEvery/index.d.ts +++ b/types/lodash/overEvery/index.d.ts @@ -1,2 +1,2 @@ import { overEvery } from "../index"; -export = overEvery; \ No newline at end of file +export = overEvery; diff --git a/types/lodash/overSome/index.d.ts b/types/lodash/overSome/index.d.ts index 3bc6bfff2b..5d27576568 100644 --- a/types/lodash/overSome/index.d.ts +++ b/types/lodash/overSome/index.d.ts @@ -1,2 +1,2 @@ import { overSome } from "../index"; -export = overSome; \ No newline at end of file +export = overSome; diff --git a/types/lodash/pad/index.d.ts b/types/lodash/pad/index.d.ts index 331e55c5cf..00cd386111 100644 --- a/types/lodash/pad/index.d.ts +++ b/types/lodash/pad/index.d.ts @@ -1,2 +1,2 @@ import { pad } from "../index"; -export = pad; \ No newline at end of file +export = pad; diff --git a/types/lodash/padEnd/index.d.ts b/types/lodash/padEnd/index.d.ts index 2223f7a60e..6cc4425148 100644 --- a/types/lodash/padEnd/index.d.ts +++ b/types/lodash/padEnd/index.d.ts @@ -1,2 +1,2 @@ import { padEnd } from "../index"; -export = padEnd; \ No newline at end of file +export = padEnd; diff --git a/types/lodash/padStart/index.d.ts b/types/lodash/padStart/index.d.ts index 1c3da5ff91..e2d9f9bf86 100644 --- a/types/lodash/padStart/index.d.ts +++ b/types/lodash/padStart/index.d.ts @@ -1,2 +1,2 @@ import { padStart } from "../index"; -export = padStart; \ No newline at end of file +export = padStart; diff --git a/types/lodash/parseInt/index.d.ts b/types/lodash/parseInt/index.d.ts index 47ec8282b4..8efd3cb6fc 100644 --- a/types/lodash/parseInt/index.d.ts +++ b/types/lodash/parseInt/index.d.ts @@ -1,2 +1,2 @@ import { parseInt } from "../index"; -export = parseInt; \ No newline at end of file +export = parseInt; diff --git a/types/lodash/partial/index.d.ts b/types/lodash/partial/index.d.ts index 3b32f1d962..8c7ee10740 100644 --- a/types/lodash/partial/index.d.ts +++ b/types/lodash/partial/index.d.ts @@ -1,2 +1,2 @@ import { partial } from "../index"; -export = partial; \ No newline at end of file +export = partial; diff --git a/types/lodash/partialRight/index.d.ts b/types/lodash/partialRight/index.d.ts index d13a6c73d3..c6f1c8acde 100644 --- a/types/lodash/partialRight/index.d.ts +++ b/types/lodash/partialRight/index.d.ts @@ -1,2 +1,2 @@ import { partialRight } from "../index"; -export = partialRight; \ No newline at end of file +export = partialRight; diff --git a/types/lodash/partition/index.d.ts b/types/lodash/partition/index.d.ts index 3bd1cd7715..1cd0cc12b3 100644 --- a/types/lodash/partition/index.d.ts +++ b/types/lodash/partition/index.d.ts @@ -1,2 +1,2 @@ import { partition } from "../index"; -export = partition; \ No newline at end of file +export = partition; diff --git a/types/lodash/pick/index.d.ts b/types/lodash/pick/index.d.ts index 287e6bfd66..33d5b2fbe0 100644 --- a/types/lodash/pick/index.d.ts +++ b/types/lodash/pick/index.d.ts @@ -1,2 +1,2 @@ import { pick } from "../index"; -export = pick; \ No newline at end of file +export = pick; diff --git a/types/lodash/pickBy/index.d.ts b/types/lodash/pickBy/index.d.ts index 92da32054a..7b4da3a299 100644 --- a/types/lodash/pickBy/index.d.ts +++ b/types/lodash/pickBy/index.d.ts @@ -1,2 +1,2 @@ import { pickBy } from "../index"; -export = pickBy; \ No newline at end of file +export = pickBy; diff --git a/types/lodash/property/index.d.ts b/types/lodash/property/index.d.ts index d57f4d0775..99d8057c4f 100644 --- a/types/lodash/property/index.d.ts +++ b/types/lodash/property/index.d.ts @@ -1,2 +1,2 @@ import { property } from "../index"; -export = property; \ No newline at end of file +export = property; diff --git a/types/lodash/propertyOf/index.d.ts b/types/lodash/propertyOf/index.d.ts index b10c8ebd0c..68e4a6ae85 100644 --- a/types/lodash/propertyOf/index.d.ts +++ b/types/lodash/propertyOf/index.d.ts @@ -1,2 +1,2 @@ import { propertyOf } from "../index"; -export = propertyOf; \ No newline at end of file +export = propertyOf; diff --git a/types/lodash/pull/index.d.ts b/types/lodash/pull/index.d.ts index 7716f98234..69696c43e1 100644 --- a/types/lodash/pull/index.d.ts +++ b/types/lodash/pull/index.d.ts @@ -1,2 +1,2 @@ import { pull } from "../index"; -export = pull; \ No newline at end of file +export = pull; diff --git a/types/lodash/pullAll/index.d.ts b/types/lodash/pullAll/index.d.ts index f39bbd2db7..32aa606b03 100644 --- a/types/lodash/pullAll/index.d.ts +++ b/types/lodash/pullAll/index.d.ts @@ -1,2 +1,2 @@ import { pullAll } from "../index"; -export = pullAll; \ No newline at end of file +export = pullAll; diff --git a/types/lodash/pullAllBy/index.d.ts b/types/lodash/pullAllBy/index.d.ts index acd205768b..4b8ff6da5b 100644 --- a/types/lodash/pullAllBy/index.d.ts +++ b/types/lodash/pullAllBy/index.d.ts @@ -1,2 +1,2 @@ import { pullAllBy } from "../index"; -export = pullAllBy; \ No newline at end of file +export = pullAllBy; diff --git a/types/lodash/pullAt/index.d.ts b/types/lodash/pullAt/index.d.ts index a036de7324..3019515a8e 100644 --- a/types/lodash/pullAt/index.d.ts +++ b/types/lodash/pullAt/index.d.ts @@ -1,2 +1,2 @@ import { pullAt } from "../index"; -export = pullAt; \ No newline at end of file +export = pullAt; diff --git a/types/lodash/random/index.d.ts b/types/lodash/random/index.d.ts index 5d9cfe9102..7116b7df74 100644 --- a/types/lodash/random/index.d.ts +++ b/types/lodash/random/index.d.ts @@ -1,2 +1,2 @@ import { random } from "../index"; -export = random; \ No newline at end of file +export = random; diff --git a/types/lodash/range/index.d.ts b/types/lodash/range/index.d.ts index 3cbc7f9937..ba9ec7c4e2 100644 --- a/types/lodash/range/index.d.ts +++ b/types/lodash/range/index.d.ts @@ -1,2 +1,2 @@ import { range } from "../index"; -export = range; \ No newline at end of file +export = range; diff --git a/types/lodash/rangeRight/index.d.ts b/types/lodash/rangeRight/index.d.ts index 19d62a7b10..7cead2895f 100644 --- a/types/lodash/rangeRight/index.d.ts +++ b/types/lodash/rangeRight/index.d.ts @@ -1,2 +1,2 @@ import { rangeRight } from "../index"; -export = rangeRight; \ No newline at end of file +export = rangeRight; diff --git a/types/lodash/rearg/index.d.ts b/types/lodash/rearg/index.d.ts index 2553b2243a..9fd61a68e0 100644 --- a/types/lodash/rearg/index.d.ts +++ b/types/lodash/rearg/index.d.ts @@ -1,2 +1,2 @@ import { rearg } from "../index"; -export = rearg; \ No newline at end of file +export = rearg; diff --git a/types/lodash/reduce/index.d.ts b/types/lodash/reduce/index.d.ts index 3e4af8bdc1..0137ae329d 100644 --- a/types/lodash/reduce/index.d.ts +++ b/types/lodash/reduce/index.d.ts @@ -1,2 +1,2 @@ import { reduce } from "../index"; -export = reduce; \ No newline at end of file +export = reduce; diff --git a/types/lodash/reduceRight/index.d.ts b/types/lodash/reduceRight/index.d.ts index f0dbae92a0..4853cbd33f 100644 --- a/types/lodash/reduceRight/index.d.ts +++ b/types/lodash/reduceRight/index.d.ts @@ -1,2 +1,2 @@ import { reduceRight } from "../index"; -export = reduceRight; \ No newline at end of file +export = reduceRight; diff --git a/types/lodash/reject/index.d.ts b/types/lodash/reject/index.d.ts index 6088450a69..a3829a3781 100644 --- a/types/lodash/reject/index.d.ts +++ b/types/lodash/reject/index.d.ts @@ -1,2 +1,2 @@ import { reject } from "../index"; -export = reject; \ No newline at end of file +export = reject; diff --git a/types/lodash/remove/index.d.ts b/types/lodash/remove/index.d.ts index 7b5726e971..75f0141175 100644 --- a/types/lodash/remove/index.d.ts +++ b/types/lodash/remove/index.d.ts @@ -1,2 +1,2 @@ import { remove } from "../index"; -export = remove; \ No newline at end of file +export = remove; diff --git a/types/lodash/repeat/index.d.ts b/types/lodash/repeat/index.d.ts index 9cd920ba5d..9c8b314c7d 100644 --- a/types/lodash/repeat/index.d.ts +++ b/types/lodash/repeat/index.d.ts @@ -1,2 +1,2 @@ import { repeat } from "../index"; -export = repeat; \ No newline at end of file +export = repeat; diff --git a/types/lodash/replace/index.d.ts b/types/lodash/replace/index.d.ts index ba0c9e6a96..7ca7a89276 100644 --- a/types/lodash/replace/index.d.ts +++ b/types/lodash/replace/index.d.ts @@ -1,2 +1,2 @@ import { replace } from "../index"; -export = replace; \ No newline at end of file +export = replace; diff --git a/types/lodash/rest/index.d.ts b/types/lodash/rest/index.d.ts index f8a93de5d8..482d23ae13 100644 --- a/types/lodash/rest/index.d.ts +++ b/types/lodash/rest/index.d.ts @@ -1,2 +1,2 @@ import { rest } from "../index"; -export = rest; \ No newline at end of file +export = rest; diff --git a/types/lodash/result/index.d.ts b/types/lodash/result/index.d.ts index a2d1f8b511..86677691e2 100644 --- a/types/lodash/result/index.d.ts +++ b/types/lodash/result/index.d.ts @@ -1,2 +1,2 @@ import { result } from "../index"; -export = result; \ No newline at end of file +export = result; diff --git a/types/lodash/reverse/index.d.ts b/types/lodash/reverse/index.d.ts index e689c4b0eb..47783137c1 100644 --- a/types/lodash/reverse/index.d.ts +++ b/types/lodash/reverse/index.d.ts @@ -1,2 +1,2 @@ import { reverse } from "../index"; -export = reverse; \ No newline at end of file +export = reverse; diff --git a/types/lodash/round/index.d.ts b/types/lodash/round/index.d.ts index e369276c67..84d6bb4646 100644 --- a/types/lodash/round/index.d.ts +++ b/types/lodash/round/index.d.ts @@ -1,2 +1,2 @@ import { round } from "../index"; -export = round; \ No newline at end of file +export = round; diff --git a/types/lodash/runInContext/index.d.ts b/types/lodash/runInContext/index.d.ts index b6b9ca8883..4d14f9de1f 100644 --- a/types/lodash/runInContext/index.d.ts +++ b/types/lodash/runInContext/index.d.ts @@ -1,2 +1,2 @@ import { runInContext } from "../index"; -export = runInContext; \ No newline at end of file +export = runInContext; diff --git a/types/lodash/sample/index.d.ts b/types/lodash/sample/index.d.ts index c3097d2b67..9c73951cb9 100644 --- a/types/lodash/sample/index.d.ts +++ b/types/lodash/sample/index.d.ts @@ -1,2 +1,2 @@ import { sample } from "../index"; -export = sample; \ No newline at end of file +export = sample; diff --git a/types/lodash/sampleSize/index.d.ts b/types/lodash/sampleSize/index.d.ts index 77208b933c..0f4b02cd60 100644 --- a/types/lodash/sampleSize/index.d.ts +++ b/types/lodash/sampleSize/index.d.ts @@ -1,2 +1,2 @@ import { sampleSize } from "../index"; -export = sampleSize; \ No newline at end of file +export = sampleSize; diff --git a/types/lodash/scripts/generate-modules.ts b/types/lodash/scripts/generate-modules.ts index 3bc3190f85..69b8e178b0 100644 --- a/types/lodash/scripts/generate-modules.ts +++ b/types/lodash/scripts/generate-modules.ts @@ -23,7 +23,7 @@ async function main() { // Generate local module const localDir = path.join("..", module); ensureDir(localDir); - fs.writeFileSync(path.join(localDir, "index.d.ts"), `import { ${module} } from "../index";\nexport = ${module};`); + fs.writeFileSync(path.join(localDir, "index.d.ts"), `import { ${module} } from "../index";\nexport = ${module};\n`); // Generate non-local module if (!notOnNpm.has(module)) { diff --git a/types/lodash/set/index.d.ts b/types/lodash/set/index.d.ts index d5b68f01d8..8a61f06eaa 100644 --- a/types/lodash/set/index.d.ts +++ b/types/lodash/set/index.d.ts @@ -1,2 +1,2 @@ import { set } from "../index"; -export = set; \ No newline at end of file +export = set; diff --git a/types/lodash/setWith/index.d.ts b/types/lodash/setWith/index.d.ts index 8c4353054c..358eab644e 100644 --- a/types/lodash/setWith/index.d.ts +++ b/types/lodash/setWith/index.d.ts @@ -1,2 +1,2 @@ import { setWith } from "../index"; -export = setWith; \ No newline at end of file +export = setWith; diff --git a/types/lodash/shuffle/index.d.ts b/types/lodash/shuffle/index.d.ts index 50f7fafddd..161b303cc6 100644 --- a/types/lodash/shuffle/index.d.ts +++ b/types/lodash/shuffle/index.d.ts @@ -1,2 +1,2 @@ import { shuffle } from "../index"; -export = shuffle; \ No newline at end of file +export = shuffle; diff --git a/types/lodash/size/index.d.ts b/types/lodash/size/index.d.ts index cec775d6b4..8880bf0192 100644 --- a/types/lodash/size/index.d.ts +++ b/types/lodash/size/index.d.ts @@ -1,2 +1,2 @@ import { size } from "../index"; -export = size; \ No newline at end of file +export = size; diff --git a/types/lodash/slice/index.d.ts b/types/lodash/slice/index.d.ts index 326dbd4235..0a01a3b37b 100644 --- a/types/lodash/slice/index.d.ts +++ b/types/lodash/slice/index.d.ts @@ -1,2 +1,2 @@ import { slice } from "../index"; -export = slice; \ No newline at end of file +export = slice; diff --git a/types/lodash/snakeCase/index.d.ts b/types/lodash/snakeCase/index.d.ts index 9248ebcb68..83a69eed7d 100644 --- a/types/lodash/snakeCase/index.d.ts +++ b/types/lodash/snakeCase/index.d.ts @@ -1,2 +1,2 @@ import { snakeCase } from "../index"; -export = snakeCase; \ No newline at end of file +export = snakeCase; diff --git a/types/lodash/some/index.d.ts b/types/lodash/some/index.d.ts index 5f687f85a5..737e5026a0 100644 --- a/types/lodash/some/index.d.ts +++ b/types/lodash/some/index.d.ts @@ -1,2 +1,2 @@ import { some } from "../index"; -export = some; \ No newline at end of file +export = some; diff --git a/types/lodash/sortBy/index.d.ts b/types/lodash/sortBy/index.d.ts index ccfb52f54d..f25a80ef63 100644 --- a/types/lodash/sortBy/index.d.ts +++ b/types/lodash/sortBy/index.d.ts @@ -1,2 +1,2 @@ import { sortBy } from "../index"; -export = sortBy; \ No newline at end of file +export = sortBy; diff --git a/types/lodash/sortedIndex/index.d.ts b/types/lodash/sortedIndex/index.d.ts index 82619b92b3..752e42308c 100644 --- a/types/lodash/sortedIndex/index.d.ts +++ b/types/lodash/sortedIndex/index.d.ts @@ -1,2 +1,2 @@ import { sortedIndex } from "../index"; -export = sortedIndex; \ No newline at end of file +export = sortedIndex; diff --git a/types/lodash/sortedIndexBy/index.d.ts b/types/lodash/sortedIndexBy/index.d.ts index 201307f855..de6c51ad0f 100644 --- a/types/lodash/sortedIndexBy/index.d.ts +++ b/types/lodash/sortedIndexBy/index.d.ts @@ -1,2 +1,2 @@ import { sortedIndexBy } from "../index"; -export = sortedIndexBy; \ No newline at end of file +export = sortedIndexBy; diff --git a/types/lodash/sortedIndexOf/index.d.ts b/types/lodash/sortedIndexOf/index.d.ts index fd3d7e7bcd..4ee1da9b33 100644 --- a/types/lodash/sortedIndexOf/index.d.ts +++ b/types/lodash/sortedIndexOf/index.d.ts @@ -1,2 +1,2 @@ import { sortedIndexOf } from "../index"; -export = sortedIndexOf; \ No newline at end of file +export = sortedIndexOf; diff --git a/types/lodash/sortedLastIndex/index.d.ts b/types/lodash/sortedLastIndex/index.d.ts index 8ec4d0e9e9..5a2d225624 100644 --- a/types/lodash/sortedLastIndex/index.d.ts +++ b/types/lodash/sortedLastIndex/index.d.ts @@ -1,2 +1,2 @@ import { sortedLastIndex } from "../index"; -export = sortedLastIndex; \ No newline at end of file +export = sortedLastIndex; diff --git a/types/lodash/sortedLastIndexBy/index.d.ts b/types/lodash/sortedLastIndexBy/index.d.ts index d0846cb4e4..18b961a312 100644 --- a/types/lodash/sortedLastIndexBy/index.d.ts +++ b/types/lodash/sortedLastIndexBy/index.d.ts @@ -1,2 +1,2 @@ import { sortedLastIndexBy } from "../index"; -export = sortedLastIndexBy; \ No newline at end of file +export = sortedLastIndexBy; diff --git a/types/lodash/sortedLastIndexOf/index.d.ts b/types/lodash/sortedLastIndexOf/index.d.ts index e65393da6c..84970275ed 100644 --- a/types/lodash/sortedLastIndexOf/index.d.ts +++ b/types/lodash/sortedLastIndexOf/index.d.ts @@ -1,2 +1,2 @@ import { sortedLastIndexOf } from "../index"; -export = sortedLastIndexOf; \ No newline at end of file +export = sortedLastIndexOf; diff --git a/types/lodash/sortedUniq/index.d.ts b/types/lodash/sortedUniq/index.d.ts index af5960f98d..d4a19d27cb 100644 --- a/types/lodash/sortedUniq/index.d.ts +++ b/types/lodash/sortedUniq/index.d.ts @@ -1,2 +1,2 @@ import { sortedUniq } from "../index"; -export = sortedUniq; \ No newline at end of file +export = sortedUniq; diff --git a/types/lodash/sortedUniqBy/index.d.ts b/types/lodash/sortedUniqBy/index.d.ts index 5ce03e8e78..a8e310ad3f 100644 --- a/types/lodash/sortedUniqBy/index.d.ts +++ b/types/lodash/sortedUniqBy/index.d.ts @@ -1,2 +1,2 @@ import { sortedUniqBy } from "../index"; -export = sortedUniqBy; \ No newline at end of file +export = sortedUniqBy; diff --git a/types/lodash/split/index.d.ts b/types/lodash/split/index.d.ts index cdf59fb9a7..15e23e48d9 100644 --- a/types/lodash/split/index.d.ts +++ b/types/lodash/split/index.d.ts @@ -1,2 +1,2 @@ import { split } from "../index"; -export = split; \ No newline at end of file +export = split; diff --git a/types/lodash/spread/index.d.ts b/types/lodash/spread/index.d.ts index 49214fa68d..eb27ed2f74 100644 --- a/types/lodash/spread/index.d.ts +++ b/types/lodash/spread/index.d.ts @@ -1,2 +1,2 @@ import { spread } from "../index"; -export = spread; \ No newline at end of file +export = spread; diff --git a/types/lodash/startCase/index.d.ts b/types/lodash/startCase/index.d.ts index f46a84c55a..8a6b629293 100644 --- a/types/lodash/startCase/index.d.ts +++ b/types/lodash/startCase/index.d.ts @@ -1,2 +1,2 @@ import { startCase } from "../index"; -export = startCase; \ No newline at end of file +export = startCase; diff --git a/types/lodash/startsWith/index.d.ts b/types/lodash/startsWith/index.d.ts index d0bc2d6110..96410734dd 100644 --- a/types/lodash/startsWith/index.d.ts +++ b/types/lodash/startsWith/index.d.ts @@ -1,2 +1,2 @@ import { startsWith } from "../index"; -export = startsWith; \ No newline at end of file +export = startsWith; diff --git a/types/lodash/subtract/index.d.ts b/types/lodash/subtract/index.d.ts index d802dccc59..30e5c0f374 100644 --- a/types/lodash/subtract/index.d.ts +++ b/types/lodash/subtract/index.d.ts @@ -1,2 +1,2 @@ import { subtract } from "../index"; -export = subtract; \ No newline at end of file +export = subtract; diff --git a/types/lodash/sum/index.d.ts b/types/lodash/sum/index.d.ts index 011a16d554..d861fe54b4 100644 --- a/types/lodash/sum/index.d.ts +++ b/types/lodash/sum/index.d.ts @@ -1,2 +1,2 @@ import { sum } from "../index"; -export = sum; \ No newline at end of file +export = sum; diff --git a/types/lodash/sumBy/index.d.ts b/types/lodash/sumBy/index.d.ts index 642b734092..edfadab963 100644 --- a/types/lodash/sumBy/index.d.ts +++ b/types/lodash/sumBy/index.d.ts @@ -1,2 +1,2 @@ import { sumBy } from "../index"; -export = sumBy; \ No newline at end of file +export = sumBy; diff --git a/types/lodash/tail/index.d.ts b/types/lodash/tail/index.d.ts index ab8b30bba0..7c16421431 100644 --- a/types/lodash/tail/index.d.ts +++ b/types/lodash/tail/index.d.ts @@ -1,2 +1,2 @@ import { tail } from "../index"; -export = tail; \ No newline at end of file +export = tail; diff --git a/types/lodash/take/index.d.ts b/types/lodash/take/index.d.ts index b9de51879b..09acc7cc67 100644 --- a/types/lodash/take/index.d.ts +++ b/types/lodash/take/index.d.ts @@ -1,2 +1,2 @@ import { take } from "../index"; -export = take; \ No newline at end of file +export = take; diff --git a/types/lodash/takeRight/index.d.ts b/types/lodash/takeRight/index.d.ts index ddc1dab3f2..f5f0829506 100644 --- a/types/lodash/takeRight/index.d.ts +++ b/types/lodash/takeRight/index.d.ts @@ -1,2 +1,2 @@ import { takeRight } from "../index"; -export = takeRight; \ No newline at end of file +export = takeRight; diff --git a/types/lodash/takeRightWhile/index.d.ts b/types/lodash/takeRightWhile/index.d.ts index ff42088754..3b3a4c5264 100644 --- a/types/lodash/takeRightWhile/index.d.ts +++ b/types/lodash/takeRightWhile/index.d.ts @@ -1,2 +1,2 @@ import { takeRightWhile } from "../index"; -export = takeRightWhile; \ No newline at end of file +export = takeRightWhile; diff --git a/types/lodash/takeWhile/index.d.ts b/types/lodash/takeWhile/index.d.ts index 4b6548a649..2cd57257e2 100644 --- a/types/lodash/takeWhile/index.d.ts +++ b/types/lodash/takeWhile/index.d.ts @@ -1,2 +1,2 @@ import { takeWhile } from "../index"; -export = takeWhile; \ No newline at end of file +export = takeWhile; diff --git a/types/lodash/tap/index.d.ts b/types/lodash/tap/index.d.ts index 1af8eccefd..26c6c1dfd8 100644 --- a/types/lodash/tap/index.d.ts +++ b/types/lodash/tap/index.d.ts @@ -1,2 +1,2 @@ import { tap } from "../index"; -export = tap; \ No newline at end of file +export = tap; diff --git a/types/lodash/template/index.d.ts b/types/lodash/template/index.d.ts index 465b01d7f8..898eb4b44e 100644 --- a/types/lodash/template/index.d.ts +++ b/types/lodash/template/index.d.ts @@ -1,2 +1,2 @@ import { template } from "../index"; -export = template; \ No newline at end of file +export = template; diff --git a/types/lodash/throttle/index.d.ts b/types/lodash/throttle/index.d.ts index dee71aae98..ba7f353aeb 100644 --- a/types/lodash/throttle/index.d.ts +++ b/types/lodash/throttle/index.d.ts @@ -1,2 +1,2 @@ import { throttle } from "../index"; -export = throttle; \ No newline at end of file +export = throttle; diff --git a/types/lodash/thru/index.d.ts b/types/lodash/thru/index.d.ts index 70245825d9..c23ea4f7f8 100644 --- a/types/lodash/thru/index.d.ts +++ b/types/lodash/thru/index.d.ts @@ -1,2 +1,2 @@ import { thru } from "../index"; -export = thru; \ No newline at end of file +export = thru; diff --git a/types/lodash/times/index.d.ts b/types/lodash/times/index.d.ts index 7da9c6763f..53ce4b64da 100644 --- a/types/lodash/times/index.d.ts +++ b/types/lodash/times/index.d.ts @@ -1,2 +1,2 @@ import { times } from "../index"; -export = times; \ No newline at end of file +export = times; diff --git a/types/lodash/toArray/index.d.ts b/types/lodash/toArray/index.d.ts index 5f1b4b5e89..a78ca2b2cd 100644 --- a/types/lodash/toArray/index.d.ts +++ b/types/lodash/toArray/index.d.ts @@ -1,2 +1,2 @@ import { toArray } from "../index"; -export = toArray; \ No newline at end of file +export = toArray; diff --git a/types/lodash/toInteger/index.d.ts b/types/lodash/toInteger/index.d.ts index cb600f94f2..90415a1155 100644 --- a/types/lodash/toInteger/index.d.ts +++ b/types/lodash/toInteger/index.d.ts @@ -1,2 +1,2 @@ import { toInteger } from "../index"; -export = toInteger; \ No newline at end of file +export = toInteger; diff --git a/types/lodash/toLength/index.d.ts b/types/lodash/toLength/index.d.ts index 04080ab623..1efae9b628 100644 --- a/types/lodash/toLength/index.d.ts +++ b/types/lodash/toLength/index.d.ts @@ -1,2 +1,2 @@ import { toLength } from "../index"; -export = toLength; \ No newline at end of file +export = toLength; diff --git a/types/lodash/toLower/index.d.ts b/types/lodash/toLower/index.d.ts index d264d11bb2..9a8690312f 100644 --- a/types/lodash/toLower/index.d.ts +++ b/types/lodash/toLower/index.d.ts @@ -1,2 +1,2 @@ import { toLower } from "../index"; -export = toLower; \ No newline at end of file +export = toLower; diff --git a/types/lodash/toNumber/index.d.ts b/types/lodash/toNumber/index.d.ts index 0f706b4373..59c0521e63 100644 --- a/types/lodash/toNumber/index.d.ts +++ b/types/lodash/toNumber/index.d.ts @@ -1,2 +1,2 @@ import { toNumber } from "../index"; -export = toNumber; \ No newline at end of file +export = toNumber; diff --git a/types/lodash/toPairs/index.d.ts b/types/lodash/toPairs/index.d.ts index a0b3265c0c..500242710c 100644 --- a/types/lodash/toPairs/index.d.ts +++ b/types/lodash/toPairs/index.d.ts @@ -1,2 +1,2 @@ import { toPairs } from "../index"; -export = toPairs; \ No newline at end of file +export = toPairs; diff --git a/types/lodash/toPairsIn/index.d.ts b/types/lodash/toPairsIn/index.d.ts index d0193b6847..4d7f61b9dd 100644 --- a/types/lodash/toPairsIn/index.d.ts +++ b/types/lodash/toPairsIn/index.d.ts @@ -1,2 +1,2 @@ import { toPairsIn } from "../index"; -export = toPairsIn; \ No newline at end of file +export = toPairsIn; diff --git a/types/lodash/toPath/index.d.ts b/types/lodash/toPath/index.d.ts index 0c0f16d60c..23912d9437 100644 --- a/types/lodash/toPath/index.d.ts +++ b/types/lodash/toPath/index.d.ts @@ -1,2 +1,2 @@ import { toPath } from "../index"; -export = toPath; \ No newline at end of file +export = toPath; diff --git a/types/lodash/toPlainObject/index.d.ts b/types/lodash/toPlainObject/index.d.ts index 0bf86dae50..3a9298e1e3 100644 --- a/types/lodash/toPlainObject/index.d.ts +++ b/types/lodash/toPlainObject/index.d.ts @@ -1,2 +1,2 @@ import { toPlainObject } from "../index"; -export = toPlainObject; \ No newline at end of file +export = toPlainObject; diff --git a/types/lodash/toSafeInteger/index.d.ts b/types/lodash/toSafeInteger/index.d.ts index e7237d1ff9..4838cd8eba 100644 --- a/types/lodash/toSafeInteger/index.d.ts +++ b/types/lodash/toSafeInteger/index.d.ts @@ -1,2 +1,2 @@ import { toSafeInteger } from "../index"; -export = toSafeInteger; \ No newline at end of file +export = toSafeInteger; diff --git a/types/lodash/toString/index.d.ts b/types/lodash/toString/index.d.ts index f2cea86234..bfc2d699df 100644 --- a/types/lodash/toString/index.d.ts +++ b/types/lodash/toString/index.d.ts @@ -1,2 +1,2 @@ import { toString } from "../index"; -export = toString; \ No newline at end of file +export = toString; diff --git a/types/lodash/toUpper/index.d.ts b/types/lodash/toUpper/index.d.ts index c5b1ec212d..d191b6cb23 100644 --- a/types/lodash/toUpper/index.d.ts +++ b/types/lodash/toUpper/index.d.ts @@ -1,2 +1,2 @@ import { toUpper } from "../index"; -export = toUpper; \ No newline at end of file +export = toUpper; diff --git a/types/lodash/transform/index.d.ts b/types/lodash/transform/index.d.ts index ffa0169325..266d50f504 100644 --- a/types/lodash/transform/index.d.ts +++ b/types/lodash/transform/index.d.ts @@ -1,2 +1,2 @@ import { transform } from "../index"; -export = transform; \ No newline at end of file +export = transform; diff --git a/types/lodash/trim/index.d.ts b/types/lodash/trim/index.d.ts index 86117b38d2..0a6e07d1c3 100644 --- a/types/lodash/trim/index.d.ts +++ b/types/lodash/trim/index.d.ts @@ -1,2 +1,2 @@ import { trim } from "../index"; -export = trim; \ No newline at end of file +export = trim; diff --git a/types/lodash/trimEnd/index.d.ts b/types/lodash/trimEnd/index.d.ts index 83f6445934..c01d487ffa 100644 --- a/types/lodash/trimEnd/index.d.ts +++ b/types/lodash/trimEnd/index.d.ts @@ -1,2 +1,2 @@ import { trimEnd } from "../index"; -export = trimEnd; \ No newline at end of file +export = trimEnd; diff --git a/types/lodash/trimStart/index.d.ts b/types/lodash/trimStart/index.d.ts index ed7e9afb33..478d4f8fb5 100644 --- a/types/lodash/trimStart/index.d.ts +++ b/types/lodash/trimStart/index.d.ts @@ -1,2 +1,2 @@ import { trimStart } from "../index"; -export = trimStart; \ No newline at end of file +export = trimStart; diff --git a/types/lodash/truncate/index.d.ts b/types/lodash/truncate/index.d.ts index e152c53d3b..0d8b7d96a2 100644 --- a/types/lodash/truncate/index.d.ts +++ b/types/lodash/truncate/index.d.ts @@ -1,2 +1,2 @@ import { truncate } from "../index"; -export = truncate; \ No newline at end of file +export = truncate; diff --git a/types/lodash/unary/index.d.ts b/types/lodash/unary/index.d.ts index d7c0bd0558..2ffc81ae86 100644 --- a/types/lodash/unary/index.d.ts +++ b/types/lodash/unary/index.d.ts @@ -1,2 +1,2 @@ import { unary } from "../index"; -export = unary; \ No newline at end of file +export = unary; diff --git a/types/lodash/unescape/index.d.ts b/types/lodash/unescape/index.d.ts index 1af1f917b7..a830cd17b6 100644 --- a/types/lodash/unescape/index.d.ts +++ b/types/lodash/unescape/index.d.ts @@ -1,2 +1,2 @@ import { unescape } from "../index"; -export = unescape; \ No newline at end of file +export = unescape; diff --git a/types/lodash/union/index.d.ts b/types/lodash/union/index.d.ts index 03bb0d6a9c..4372f5b359 100644 --- a/types/lodash/union/index.d.ts +++ b/types/lodash/union/index.d.ts @@ -1,2 +1,2 @@ import { union } from "../index"; -export = union; \ No newline at end of file +export = union; diff --git a/types/lodash/unionBy/index.d.ts b/types/lodash/unionBy/index.d.ts index 6ec5957241..92e877b02a 100644 --- a/types/lodash/unionBy/index.d.ts +++ b/types/lodash/unionBy/index.d.ts @@ -1,2 +1,2 @@ import { unionBy } from "../index"; -export = unionBy; \ No newline at end of file +export = unionBy; diff --git a/types/lodash/unionWith/index.d.ts b/types/lodash/unionWith/index.d.ts index 16f5cfe660..cc13611e47 100644 --- a/types/lodash/unionWith/index.d.ts +++ b/types/lodash/unionWith/index.d.ts @@ -1,2 +1,2 @@ import { unionWith } from "../index"; -export = unionWith; \ No newline at end of file +export = unionWith; diff --git a/types/lodash/uniq/index.d.ts b/types/lodash/uniq/index.d.ts index 4d10a58c54..2a900a0547 100644 --- a/types/lodash/uniq/index.d.ts +++ b/types/lodash/uniq/index.d.ts @@ -1,2 +1,2 @@ import { uniq } from "../index"; -export = uniq; \ No newline at end of file +export = uniq; diff --git a/types/lodash/uniqBy/index.d.ts b/types/lodash/uniqBy/index.d.ts index afca1fccb8..849bf7c291 100644 --- a/types/lodash/uniqBy/index.d.ts +++ b/types/lodash/uniqBy/index.d.ts @@ -1,2 +1,2 @@ import { uniqBy } from "../index"; -export = uniqBy; \ No newline at end of file +export = uniqBy; diff --git a/types/lodash/uniqWith/index.d.ts b/types/lodash/uniqWith/index.d.ts index 4df7c0934d..a889f887e9 100644 --- a/types/lodash/uniqWith/index.d.ts +++ b/types/lodash/uniqWith/index.d.ts @@ -1,2 +1,2 @@ import { uniqWith } from "../index"; -export = uniqWith; \ No newline at end of file +export = uniqWith; diff --git a/types/lodash/uniqueId/index.d.ts b/types/lodash/uniqueId/index.d.ts index 0aae44d724..6ce0280474 100644 --- a/types/lodash/uniqueId/index.d.ts +++ b/types/lodash/uniqueId/index.d.ts @@ -1,2 +1,2 @@ import { uniqueId } from "../index"; -export = uniqueId; \ No newline at end of file +export = uniqueId; diff --git a/types/lodash/unset/index.d.ts b/types/lodash/unset/index.d.ts index 8e526713d7..b06997a103 100644 --- a/types/lodash/unset/index.d.ts +++ b/types/lodash/unset/index.d.ts @@ -1,2 +1,2 @@ import { unset } from "../index"; -export = unset; \ No newline at end of file +export = unset; diff --git a/types/lodash/unzip/index.d.ts b/types/lodash/unzip/index.d.ts index 57a50c8aa6..4900372c9e 100644 --- a/types/lodash/unzip/index.d.ts +++ b/types/lodash/unzip/index.d.ts @@ -1,2 +1,2 @@ import { unzip } from "../index"; -export = unzip; \ No newline at end of file +export = unzip; diff --git a/types/lodash/unzipWith/index.d.ts b/types/lodash/unzipWith/index.d.ts index 64c2b43089..28aad1a417 100644 --- a/types/lodash/unzipWith/index.d.ts +++ b/types/lodash/unzipWith/index.d.ts @@ -1,2 +1,2 @@ import { unzipWith } from "../index"; -export = unzipWith; \ No newline at end of file +export = unzipWith; diff --git a/types/lodash/update/index.d.ts b/types/lodash/update/index.d.ts index 141993229f..cba70b1b80 100644 --- a/types/lodash/update/index.d.ts +++ b/types/lodash/update/index.d.ts @@ -1,2 +1,2 @@ import { update } from "../index"; -export = update; \ No newline at end of file +export = update; diff --git a/types/lodash/upperCase/index.d.ts b/types/lodash/upperCase/index.d.ts index 25eb774983..6ff442cc20 100644 --- a/types/lodash/upperCase/index.d.ts +++ b/types/lodash/upperCase/index.d.ts @@ -1,2 +1,2 @@ import { upperCase } from "../index"; -export = upperCase; \ No newline at end of file +export = upperCase; diff --git a/types/lodash/upperFirst/index.d.ts b/types/lodash/upperFirst/index.d.ts index 05acb0f6d8..b8d53837aa 100644 --- a/types/lodash/upperFirst/index.d.ts +++ b/types/lodash/upperFirst/index.d.ts @@ -1,2 +1,2 @@ import { upperFirst } from "../index"; -export = upperFirst; \ No newline at end of file +export = upperFirst; diff --git a/types/lodash/values/index.d.ts b/types/lodash/values/index.d.ts index e4cee9048b..fb10161bb7 100644 --- a/types/lodash/values/index.d.ts +++ b/types/lodash/values/index.d.ts @@ -1,2 +1,2 @@ import { values } from "../index"; -export = values; \ No newline at end of file +export = values; diff --git a/types/lodash/valuesIn/index.d.ts b/types/lodash/valuesIn/index.d.ts index c2ae64e353..11fcc6500d 100644 --- a/types/lodash/valuesIn/index.d.ts +++ b/types/lodash/valuesIn/index.d.ts @@ -1,2 +1,2 @@ import { valuesIn } from "../index"; -export = valuesIn; \ No newline at end of file +export = valuesIn; diff --git a/types/lodash/without/index.d.ts b/types/lodash/without/index.d.ts index f6c3026a03..0fa415a090 100644 --- a/types/lodash/without/index.d.ts +++ b/types/lodash/without/index.d.ts @@ -1,2 +1,2 @@ import { without } from "../index"; -export = without; \ No newline at end of file +export = without; diff --git a/types/lodash/words/index.d.ts b/types/lodash/words/index.d.ts index e69803e9cb..6a76947ca1 100644 --- a/types/lodash/words/index.d.ts +++ b/types/lodash/words/index.d.ts @@ -1,2 +1,2 @@ import { words } from "../index"; -export = words; \ No newline at end of file +export = words; diff --git a/types/lodash/wrap/index.d.ts b/types/lodash/wrap/index.d.ts index 07c7914c4e..63f068b94d 100644 --- a/types/lodash/wrap/index.d.ts +++ b/types/lodash/wrap/index.d.ts @@ -1,2 +1,2 @@ import { wrap } from "../index"; -export = wrap; \ No newline at end of file +export = wrap; diff --git a/types/lodash/xor/index.d.ts b/types/lodash/xor/index.d.ts index 4804fb322f..9c2e0ea17b 100644 --- a/types/lodash/xor/index.d.ts +++ b/types/lodash/xor/index.d.ts @@ -1,2 +1,2 @@ import { xor } from "../index"; -export = xor; \ No newline at end of file +export = xor; diff --git a/types/lodash/xorBy/index.d.ts b/types/lodash/xorBy/index.d.ts index d468896792..4a2621d592 100644 --- a/types/lodash/xorBy/index.d.ts +++ b/types/lodash/xorBy/index.d.ts @@ -1,2 +1,2 @@ import { xorBy } from "../index"; -export = xorBy; \ No newline at end of file +export = xorBy; diff --git a/types/lodash/xorWith/index.d.ts b/types/lodash/xorWith/index.d.ts index 48337ca060..33e897a1f2 100644 --- a/types/lodash/xorWith/index.d.ts +++ b/types/lodash/xorWith/index.d.ts @@ -1,2 +1,2 @@ import { xorWith } from "../index"; -export = xorWith; \ No newline at end of file +export = xorWith; diff --git a/types/lodash/zip/index.d.ts b/types/lodash/zip/index.d.ts index a39e3d3099..ea074ac268 100644 --- a/types/lodash/zip/index.d.ts +++ b/types/lodash/zip/index.d.ts @@ -1,2 +1,2 @@ import { zip } from "../index"; -export = zip; \ No newline at end of file +export = zip; diff --git a/types/lodash/zipObject/index.d.ts b/types/lodash/zipObject/index.d.ts index 5ea9f4323f..b1577579b1 100644 --- a/types/lodash/zipObject/index.d.ts +++ b/types/lodash/zipObject/index.d.ts @@ -1,2 +1,2 @@ import { zipObject } from "../index"; -export = zipObject; \ No newline at end of file +export = zipObject; diff --git a/types/lodash/zipWith/index.d.ts b/types/lodash/zipWith/index.d.ts index c3b006c65e..bf808f690b 100644 --- a/types/lodash/zipWith/index.d.ts +++ b/types/lodash/zipWith/index.d.ts @@ -1,2 +1,2 @@ import { zipWith } from "../index"; -export = zipWith; \ No newline at end of file +export = zipWith; From bd29808df7f1288d3ed9da358a1b3d6de9f615fd Mon Sep 17 00:00:00 2001 From: Andy Date: Wed, 29 Mar 2017 15:53:09 -0700 Subject: [PATCH 061/844] react-native: Fix lint failures (#15496) ...mostly by disabling them. --- .../react-native-fs/react-native-fs-tests.ts | 19 +++++++++---------- .../index.d.ts | 10 ++++------ ...react-native-scrollable-tab-view-tests.tsx | 3 +-- types/react-native-swiper/index.d.ts | 4 +--- .../react-native-swiper-tests.tsx | 3 +-- types/react-native/index.d.ts | 19 ++++++++++--------- types/react-native/test/animated.tsx | 2 +- types/react-native/test/index.tsx | 17 ++++------------- types/react-native/tslint.json | 15 ++++++++++++++- 9 files changed, 45 insertions(+), 47 deletions(-) diff --git a/types/react-native-fs/react-native-fs-tests.ts b/types/react-native-fs/react-native-fs-tests.ts index a006086a9a..85a623b82e 100644 --- a/types/react-native-fs/react-native-fs-tests.ts +++ b/types/react-native-fs/react-native-fs-tests.ts @@ -1,6 +1,5 @@ import * as RNFS from 'react-native-fs'; - // get a list of files and directories in the main bundle RNFS.readDir(RNFS.MainBundlePath) // On Android, use "RNFS.DocumentDirectoryPath" (MainBundlePath is not defined) .then((result) => { @@ -26,7 +25,7 @@ RNFS.readDir(RNFS.MainBundlePath) // On Android, use "RNFS.DocumentDirectoryPath }); // create a path you want to write to -var path = RNFS.DocumentDirectoryPath + '/test.txt'; +const path = RNFS.DocumentDirectoryPath + '/test.txt'; // write the file RNFS.writeFile(path, 'Lorem ipsum dolor sit amet', 'utf8') @@ -46,9 +45,9 @@ RNFS.unlink('path') console.log(err.message); }); -var uploadUrl = 'http://requestb.in/XXXXXXX'; // For testing purposes, go to http://requestb.in/ and create your own link +const uploadUrl = 'http://requestb.in/XXXXXXX'; // For testing purposes, go to http://requestb.in/ and create your own link // create an array of objects of the files you want to upload -var files = [ +const files = [ { name: 'test1', filename: 'test1.w4a', @@ -62,13 +61,13 @@ var files = [ } ]; -var uploadBegin: RNFS.UploadCallbackBegin = (response) => { - var jobId = response.jobId; +const uploadBegin: RNFS.UploadCallbackBegin = (response) => { + const jobId = response.jobId; console.log('UPLOAD HAS BEGUN! JobId: ' + jobId); }; -var uploadProgress: RNFS.UploadCallbackProgress = (response) => { - var percentage = Math.floor((response.totalBytesSent / response.totalBytesExpectedToSend) * 100); +const uploadProgress: RNFS.UploadCallbackProgress = (response) => { + const percentage = Math.floor((response.totalBytesSent / response.totalBytesExpectedToSend) * 100); console.log('UPLOAD IS ' + percentage + '% DONE!'); }; @@ -99,13 +98,13 @@ RNFS.uploadFiles({ console.log(err); }); -var downloadProgress: RNFS.DownloadCallbackProgress = (result) => { +const downloadProgress: RNFS.DownloadCallbackProgress = (result) => { result.bytesWritten === 0; result.contentLength > 10; result.jobId; }; -var downloadBegin: RNFS.DownloadCallbackBegin = (result) => { +const downloadBegin: RNFS.DownloadCallbackBegin = (result) => { result.headers === {}; }; diff --git a/types/react-native-scrollable-tab-view/index.d.ts b/types/react-native-scrollable-tab-view/index.d.ts index 873d69855b..9ef7e5a247 100644 --- a/types/react-native-scrollable-tab-view/index.d.ts +++ b/types/react-native-scrollable-tab-view/index.d.ts @@ -23,8 +23,7 @@ export interface onChangeTabProperties { } export interface renderTabBarProperties { - - goToPage: (pageNumber: number) => void; + goToPage(pageNumber: number): void; tabs: JSX.Element; @@ -36,7 +35,6 @@ export interface renderTabBarProperties { } interface ScrollableTabViewProperties extends React.Props { - /** * tabBarPosition (String) Defaults to "top". * "bottom" to position the tab bar below content. @@ -61,13 +59,13 @@ interface ScrollableTabViewProperties extends React.Props { * an Object containing two keys: i: the index of the tab that is selected, ref: the ref of the * tab that is selected */ - onChangeTab?: (value: onChangeTabProperties) => void; + onChangeTab?(value: onChangeTabProperties): void; /** * onScroll (Function) - function to call when the pages are sliding, * should accept 1 argument which is an Float number representing the page position in the slide frame. */ - onScroll?: (value: number) => void; + onScroll?(value: number): void; /** * renderTabBar (Function:ReactComponent) - accept 1 argument props and should return a component @@ -75,7 +73,7 @@ interface ScrollableTabViewProperties extends React.Props { * and should implement setAnimationValue to be able to animate itself along with the tab content. * You can manually pass the props to the TabBar component. */ - renderTabBar?: (value: JSX.Element) => JSX.Element; + renderTabBar?(value: JSX.Element): JSX.Element; /** * style (View.propTypes.style) diff --git a/types/react-native-scrollable-tab-view/react-native-scrollable-tab-view-tests.tsx b/types/react-native-scrollable-tab-view/react-native-scrollable-tab-view-tests.tsx index 2d79537221..0fb10a4ffb 100644 --- a/types/react-native-scrollable-tab-view/react-native-scrollable-tab-view-tests.tsx +++ b/types/react-native-scrollable-tab-view/react-native-scrollable-tab-view-tests.tsx @@ -22,7 +22,6 @@ class MyText extends React.Component { } class ScrollableTabViewDemo extends React.Component<{}, {}> { - constructor(props: ScrollableTabViewDemo) { super(props); } @@ -42,4 +41,4 @@ class ScrollableTabViewDemo extends React.Component<{}, {}> { protected componentWillUnmount?(): void { } -} \ No newline at end of file +} diff --git a/types/react-native-swiper/index.d.ts b/types/react-native-swiper/index.d.ts index f41a771caf..81888289b8 100644 --- a/types/react-native-swiper/index.d.ts +++ b/types/react-native-swiper/index.d.ts @@ -10,7 +10,6 @@ import { } from 'react-native'; interface SwiperProperties extends React.Props { - horizontal?: boolean; style?: ViewStyle; @@ -49,7 +48,7 @@ interface SwiperProperties extends React.Props { index?: number; - renderPagination?: (index: number, total: number, thisObject: Swiper) => JSX.Element; + renderPagination?(index: number, total: number, thisObject: Swiper): JSX.Element; dotStyle?: ViewStyle; @@ -62,4 +61,3 @@ interface SwiperProperties extends React.Props { export default class Swiper extends React.Component { } - diff --git a/types/react-native-swiper/react-native-swiper-tests.tsx b/types/react-native-swiper/react-native-swiper-tests.tsx index fa214e18f0..7463ac0b70 100644 --- a/types/react-native-swiper/react-native-swiper-tests.tsx +++ b/types/react-native-swiper/react-native-swiper-tests.tsx @@ -7,7 +7,6 @@ import { } from 'react-native'; import Swiper from 'react-native-swiper'; - class SwiperTest extends React.Component<{}, {}> { constructor(props: {}) { super(props); @@ -60,4 +59,4 @@ const styles = StyleSheet.create({ fontSize: 30, fontWeight: 'bold' } as ViewStyle -}); \ No newline at end of file +}); diff --git a/types/react-native/index.d.ts b/types/react-native/index.d.ts index 6a833a4467..3742bf5003 100644 --- a/types/react-native/index.d.ts +++ b/types/react-native/index.d.ts @@ -337,7 +337,8 @@ export interface NativeMethodsMixinStatic { } // see react-jsx.d.ts -export function createElement

    (type: React.ReactType, +export function createElement

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

    ; @@ -1230,7 +1231,7 @@ interface TextInputState { * Unfocuses the specified text field * noop if it wasn't focused */ - blurTextInput(textFieldID?: number) : void + blurTextInput(textFieldID?: number): void } /** @@ -4165,7 +4166,7 @@ export interface LeftToRightGesture { direction: string; } -export interface JumpGesture extends LeftToRightGesture{ +export interface JumpGesture extends LeftToRightGesture { overswipe: { frictionConstant: number frictionByDistance: number @@ -5774,7 +5775,7 @@ export interface SnapshotViewIOSProperties extends ViewProperties, React.Props } @@ -7288,7 +7289,7 @@ export interface EasingStatic { inOut(easing: EasingFunction): EasingFunction; } -export module Animated { +export namespace Animated { // Most (all?) functions where AnimatedValue is used any subclass of Animated can be used as well. type AnimatedValue = Animated; type AnimatedValueXY = ValueXY; @@ -7549,7 +7550,7 @@ export module Animated { * Spring animation based on Rebound and Origami. Tracks velocity state to * create fluid motions as the `toValue` updates, and can be chained together. */ - export function spring ( + export function spring( value: AnimatedValue | AnimatedValueXY, config: SpringAnimationConfig ): CompositeAnimation; @@ -7563,7 +7564,7 @@ export module Animated { * of the animations is stopped, they will all be stopped. You can override * this with the `stopTogether` flag. */ - export function parallel ( + export function parallel( animations: Array, config?: ParallelConfig ): CompositeAnimation; @@ -7589,7 +7590,7 @@ export module Animated { * ]), *``` */ - export function event ( + export function event( argMapping: Mapping[], config?: EventConfig ): (...args: any[]) => void; @@ -7597,7 +7598,7 @@ export module Animated { /** * Make any React component Animatable. Used to create `Animated.View`, etc. */ - export function createAnimatedComponent (component: any) : any; + export function createAnimatedComponent(component: any): any; /** * Animated variants of the basic native views. Accepts Animated.Value for diff --git a/types/react-native/test/animated.tsx b/types/react-native/test/animated.tsx index 3b3457384c..8efd5fd171 100644 --- a/types/react-native/test/animated.tsx +++ b/types/react-native/test/animated.tsx @@ -90,4 +90,4 @@ function TestAnimatedAPI() { ); -} \ No newline at end of file +} diff --git a/types/react-native/test/index.tsx b/types/react-native/test/index.tsx index f7a4abae57..575693211e 100644 --- a/types/react-native/test/index.tsx +++ b/types/react-native/test/index.tsx @@ -28,19 +28,12 @@ import { } from 'react-native'; function testDimensions() { - var { + const { width, height, scale, fontScale, - } = Dimensions.get("window"); - - var { - width, - height, - scale, - fontScale, - } = Dimensions.get("screen"); + } = Dimensions.get(1 === 1 ? "window" : "screen"); } BackAndroid.addEventListener("hardwareBackPress", () => { @@ -52,7 +45,7 @@ interface LocalStyles { instructions: TextStyle; } -var styles = StyleSheet.create( +const styles = StyleSheet.create( { container: { flex: 1, @@ -97,7 +90,6 @@ const stylesAlt = StyleSheet.create( class Welcome extends React.Component { - refs: { [key: string]: any rootView: View @@ -113,7 +105,6 @@ class Welcome extends React.Component { } render() { - return ( @@ -135,7 +126,7 @@ export default Welcome; // App State -function appStateListener(state : string) { +function appStateListener(state: string) { console.log('New state: ' + state); } diff --git a/types/react-native/tslint.json b/types/react-native/tslint.json index 8ca9d9f2c3..b58d132131 100644 --- a/types/react-native/tslint.json +++ b/types/react-native/tslint.json @@ -2,6 +2,19 @@ "extends": "../tslint.json", "rules": { // Lowercase `object` is available in TypeScript 2.2 only. - "ban-types": false + "ban-types": false, + // Below are all TODO + "array-type": false, + "comment-format": false, + "interface-over-type-literal": false, + "no-misused-new": false, + "no-consecutive-blank-lines": false, + "no-empty-interface": false, + "no-padding": false, + "no-redundant-modifiers": false, + "no-var": false, + "prefer-declare-function": false, + "prefer-method-signature": false, + "semicolon": false } } From 3e861f09ecfbc7884f571fbc08cf3a7a3c5e34ad Mon Sep 17 00:00:00 2001 From: Andy Date: Wed, 29 Mar 2017 16:02:31 -0700 Subject: [PATCH 062/844] ignite-ui: Apply new lint rules (#15498) --- types/ignite-ui/index.d.ts | 14987 ++++++++++++++++------------------ types/ignite-ui/tslint.json | 3 + 2 files changed, 7206 insertions(+), 7784 deletions(-) diff --git a/types/ignite-ui/index.d.ts b/types/ignite-ui/index.d.ts index 6909aa644c..7052460f8b 100644 --- a/types/ignite-ui/index.d.ts +++ b/types/ignite-ui/index.d.ts @@ -4,7 +4,6 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped interface DataSourceSettingsPaging { - /** * Paging is not enabled by default * @@ -58,7 +57,6 @@ interface DataSourceSettingsPaging { } interface DataSourceSettingsFiltering { - /** * Filtering type. * @@ -129,7 +127,6 @@ interface DataSourceSettingsFiltering { } interface DataSourceSettingsSorting { - /** * Sorting direction * @@ -224,7 +221,6 @@ interface DataSourceSettingsSorting { } interface DataSourceSettingsGroupby { - /** * Default collapse state * @@ -238,7 +234,6 @@ interface DataSourceSettingsGroupby { } interface DataSourceSettingsSummaries { - /** * Specifies whether summaries will be applied locally or remotely (via a remote request) * @@ -285,7 +280,6 @@ interface DataSourceSettingsSummaries { } interface DataSourceSettings { - /** * Setting this is only necessary when the data source is set to a table in string format. we need to create an invisible dummy data container in the body and append the table data to it * @@ -536,481 +530,480 @@ interface DataSourceSettings { [optionName: string]: any; } -declare module Infragistics { -export class DataSource { - constructor(settings: DataSourceSettings); +declare namespace Infragistics { + class DataSource { + constructor(settings: DataSourceSettings); - /** - * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields - * - * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } - */ - fields(fields?: Object): Object; + /** + * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields + * + * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } + */ + fields(fields?: Object): Object; - /** - * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type - */ - analyzeDataSource(): string; + /** + * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type + */ + analyzeDataSource(): string; - /** - * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView - */ - dataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView + */ + dataView(): any[]; - /** - * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. - */ - data(): Object; + /** + * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. + */ + data(): Object; - /** - * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging - * - * @param transformedExecution - */ - transformedData(transformedExecution: Object): Object; + /** + * Returns transformed data according to transformed execution: + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging + * + * @param transformedExecution + */ + transformedData(transformedExecution: Object): Object; - /** - * Returns summaries data - */ - dataSummaries(): Object; + /** + * Returns summaries data + */ + dataSummaries(): Object; - /** - * Gets/sets the schema definition. - * - * @param s a schema object - * @param t type of the data source. See settings.type - */ - schema(s?: Object, t?: string): void; + /** + * Gets/sets the schema definition. + * + * @param s a schema object + * @param t type of the data source. See settings.type + */ + schema(s?: Object, t?: string): void; - /** - * Gets/sets a list of paging settings - * - * @param p object holding all paging settings. See settings.paging - */ - pagingSettings(p?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @param p object holding all paging settings. See settings.paging + */ + pagingSettings(p?: Object): Object; - /** - * Gets/sets a list of filtering settings - * - * @param f object holding all filtering settings. See settings.filtering - */ - filterSettings(f?: Object): void; + /** + * Gets/sets a list of filtering settings + * + * @param f object holding all filtering settings. See settings.filtering + */ + filterSettings(f?: Object): void; - /** - * Gets/sets a list of paging settings - * - * @param s object holding all sorting settings. See settings.sorting - */ - sortSettings(s?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @param s object holding all sorting settings. See settings.sorting + */ + sortSettings(s?: Object): Object; - /** - * Gets/sets a list of summaries settings. - * - * @param s object holding all summaries settings. See settings.summaries - */ - summariesSettings(s?: Object): void; + /** + * Gets/sets a list of summaries settings. + * + * @param s object holding all summaries settings. See settings.summaries + */ + summariesSettings(s?: Object): void; - /** - * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource - * - * @param ds - */ - dataSource(ds?: Object): Object; + /** + * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource + * + * @param ds + */ + dataSource(ds?: Object): Object; - /** - * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type - * - * @param t - * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty - */ - type(t?: Object): string; + /** + * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type + * + * @param t + * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty + */ + type(t?: Object): string; - /** - * Returns a record by a specified key (requires that primaryKey is set in the settings) - * - * @param key Primary key of the record - * @param ds the data source in which to search for the record. When not set it will use the current data source. - * @param objPath Not used in $.ig.DataSource - */ - findRecordByKey(key: string, ds?: string, objPath?: string): Object; + /** + * Returns a record by a specified key (requires that primaryKey is set in the settings) + * + * @param key Primary key of the record + * @param ds the data source in which to search for the record. When not set it will use the current data source. + * @param objPath Not used in $.ig.DataSource + */ + findRecordByKey(key: string, ds?: string, objPath?: string): Object; - /** - * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source - * - * @param key primary key of the record - * @param origDs - */ - removeRecordByKey(key: Object, origDs: Object): void; + /** + * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source + * + * @param key primary key of the record + * @param origDs + */ + removeRecordByKey(key: Object, origDs: Object): void; - /** - * Removes a record from the data source at specific index. - * - * @param index index of record - * @param origDs - */ - removeRecordByIndex(index: number, origDs: Object): void; + /** + * Removes a record from the data source at specific index. + * + * @param index index of record + * @param origDs + */ + removeRecordByIndex(index: number, origDs: Object): void; - /** - * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it - * - * @param rowId the rowId - row key (string) or index (number) - * @param colId the column id - column key (string) or index (number) - * @param val The new value - * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log - */ - setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; + /** + * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it + * + * @param rowId the rowId - row key (string) or index (number) + * @param colId the column id - column key (string) or index (number) + * @param val The new value + * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log + */ + setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; - /** - * Updates a record in the datasource. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; + /** + * Updates a record in the datasource. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; - /** - * Adds a new row to the data source. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; + /** + * Adds a new row to the data source. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; - /** - * Adds a new row to the data source. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param rowIndex row index at which to insert the new row - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - * @param parentRowId Not used in $.ig.DataSource - */ - insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; + /** + * Adds a new row to the data source. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param rowIndex row index at which to insert the new row + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param parentRowId Not used in $.ig.DataSource + */ + insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; - /** - * Deletes a row from the data source. - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - deleteRow(rowId: Object, autoCommit: boolean): Object; + /** + * Deletes a row from the data source. + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + deleteRow(rowId: Object, autoCommit: boolean): Object; - /** - * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back - * - * @param data the transaction data - */ - addNode(data: Object): void; + /** + * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back + * + * @param data the transaction data + */ + addNode(data: Object): void; - /** - * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back - * - * @param data the transaction data - */ - removeNode(data: Object): void; + /** + * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back + * + * @param data the transaction data + */ + removeNode(data: Object): void; - /** - * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source - * - * @param t a transaction object - */ - getDetachedRecord(t: Object): Object; + /** + * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source + * + * @param t a transaction object + */ + getDetachedRecord(t: Object): Object; - /** - * Update the data source with every transaction from the log - * - * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. - */ - commit(id?: number): void; + /** + * Update the data source with every transaction from the log + * + * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. + */ + commit(id?: number): void; - /** - * Clears the transaction log without updating anything in the data source - * - * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. - */ - rollback(id?: Object): void; + /** + * Clears the transaction log without updating anything in the data source + * + * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. + */ + rollback(id?: Object): void; - /** - * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source - */ - pendingTransactions(): any[]; + /** + * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source + */ + pendingTransactions(): any[]; - /** - * Returns a list of all transaction objects that are either pending, or have been committed in the data source. - */ - allTransactions(): any[]; + /** + * Returns a list of all transaction objects that are either pending, or have been committed in the data source. + */ + allTransactions(): any[]; - /** - * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently - */ - transactionsAsString(): string; + /** + * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently + */ + transactionsAsString(): string; - /** - * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params - * - * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) - * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) - */ - saveChanges(success: Function, error: Function): void; + /** + * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params + * + * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) + * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) + */ + saveChanges(success: Function, error: Function): void; - /** - * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView - * 6. fire the databound event - * - * @param callback callback function - * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context - */ - dataBind(callback?: string, callee?: Object): void; + /** + * Data binds to the current data source + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView + * 6. fire the databound event + * + * @param callback callback function + * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context + */ + dataBind(callback?: string, callee?: Object): void; - /** - * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. - * - * @param fieldName the fieldName - name of the field - * @param record the record from which to get it - */ - getCellValue(fieldName: string, record: Object): Object; + /** + * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. + * + * @param fieldName the fieldName - name of the field + * @param record the record from which to get it + */ + getCellValue(fieldName: string, record: Object): Object; - /** - * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * If key or dsObj are not set then returns summaries data. - * Takes summary data from passed argument dsObj(using argument key) - * - * @param key response key to take summary data(for example "Metadata.Summaries") - * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) - */ - summariesResponse(key?: string, dsObj?: Object): Object; + /** + * Applicable only when the data source is bound to remote data. + * Gets or sets summaries data. + * If key or dsObj are not set then returns summaries data. + * Takes summary data from passed argument dsObj(using argument key) + * + * @param key response key to take summary data(for example "Metadata.Summaries") + * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) + */ + summariesResponse(key?: string, dsObj?: Object): Object; - /** - * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. - */ - filteredData(): any[]; + /** + * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. + */ + filteredData(): any[]; - /** - * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * fields => an array of fields object definitions: - * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] - * - * @param fields an array of fields object definitions - * @param direction asc / desc direction - */ - sort(fields: Object, direction: string): void; + /** + * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * fields => an array of fields object definitions: + * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] + * + * @param fields an array of fields object definitions + * @param direction asc / desc direction + */ + sort(fields: Object, direction: string): void; - /** - * This clears local sorting applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalSorting(): void; + /** + * This clears local sorting applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalSorting(): void; - /** - * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain - * if expr is detected to be a regular expression, the "cond" part is skipped - * - * @param fieldExpressions a list of field expression definitions - * @param boolLogic boolean logic. Accepted values are AND and OR. - * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions - * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. - */ - filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; + /** + * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain + * if expr is detected to be a regular expression, the "cond" part is skipped + * + * @param fieldExpressions a list of field expression definitions + * @param boolLogic boolean logic. Accepted values are AND and OR. + * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions + * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. + */ + filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): void; - /** - * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * the actual total number of records may not - * match the number of records that exists on the client - * - * @param count the total number of records - * @param key - * @param dsObj - * @param context - */ - totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; + /** + * Applicable only when the data source is bound to remote data. + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * the actual total number of records may not + * match the number of records that exists on the client + * + * @param count the total number of records + * @param key + * @param dsObj + * @param context + */ + totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; - /** - * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend - * - * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend - */ - hasTotalRecordsCount(hasCount: boolean): void; + /** + * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend + * + * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend + */ + hasTotalRecordsCount(hasCount: boolean): void; - /** - * Returns metadata object for the specified key - * - * @param key Primary key of the record - */ - metadata(key: string): Object; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * Returns the total number of records in the local data source + */ + totalLocalRecordsCount(): number; - /** - * Returns the total number of pages - */ - pageCount(): number; + /** + * Returns the total number of pages + */ + pageCount(): number; - /** - * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. - * - * @param index the page index. If none is specified, returns the current page index. - */ - pageIndex(index?: number): number; + /** + * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. + * + * @param index the page index. If none is specified, returns the current page index. + */ + pageIndex(index?: number): number; - /** - * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. - * - * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. - */ - persistedPageIndex(value?: number): number; + /** + * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. + * + * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. + */ + persistedPageIndex(value?: number): number; - /** - * Sets the page index to be equal to the previous page index and rebinds the data source - */ - prevPage(): void; + /** + * Sets the page index to be equal to the previous page index and rebinds the data source + */ + prevPage(): void; - /** - * Sets the page index to be equal to the next page index and rebinds the data source - */ - nextPage(): void; + /** + * Sets the page index to be equal to the next page index and rebinds the data source + */ + nextPage(): void; - /** - * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size - * - * @param s the page size. - */ - pageSize(s?: number): number; + /** + * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size + * + * @param s the page size. + */ + pageSize(s?: number): number; - /** - * For internal use - * - * @param dirty - */ - pageSizeDirty(dirty: Object): void; + /** + * For internal use + * + * @param dirty + */ + pageSizeDirty(dirty: Object): void; - /** - * Returns a list of records for the specified page. Implies that paging is enabled. - * - * @param p the page index for which records will be returned - */ - recordsForPage(p: number): void; + /** + * Returns a list of records for the specified page. Implies that paging is enabled. + * + * @param p the page index for which records will be returned + */ + recordsForPage(p: number): void; - /** - * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data - * - * @param tableDOM TABLE dom element to transform - */ - tableToObject(tableDOM: Element): Object; + /** + * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data + * + * @param tableDOM TABLE dom element to transform + */ + tableToObject(tableDOM: Element): Object; - /** - * Parses the string and returns an evaluated JSON object - * - * @param s the JSON as string. - */ - stringToJSONObject(s: string): void; + /** + * Parses the string and returns an evaluated JSON object + * + * @param s the JSON as string. + */ + stringToJSONObject(s: string): void; - /** - * Parses a string and returns a XML Document - * - * @param s the XML represented as a string - */ - stringToXmlObject(s: string): void; + /** + * Parses a string and returns a XML Document + * + * @param s the XML represented as a string + */ + stringToXmlObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data - */ - groupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data + */ + groupByData(): any[]; - /** - * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) - */ - visibleGroupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) + */ + visibleGroupByData(): any[]; - /** - * Returns the current normalized/transformed and paged/filtered/sorted group-by data - */ - groupByDataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted group-by data + */ + groupByDataView(): any[]; - /** - * Toggle grouped record with the specified id and updates collections visible groupby data and data view - * - * @param id data-id attribute of the respective group row in the DOM - * @param collapsed if true the record should be collapsed, otherwise expanded - */ - toggleGroupByRecord(id: string, collapsed: boolean): void; + /** + * Toggle grouped record with the specified id and updates collections visible groupby data and data view + * + * @param id data-id attribute of the respective group row in the DOM + * @param collapsed if true the record should be collapsed, otherwise expanded + */ + toggleGroupByRecord(id: string, collapsed: boolean): void; - /** - * Check whether the specified gorupby record is collapsed - * - * @param gbRec id of the grouped record OR grouped record - */ - isGroupByRecordCollapsed(gbRec: Object): boolean; + /** + * Check whether the specified gorupby record is collapsed + * + * @param gbRec id of the grouped record OR grouped record + */ + isGroupByRecordCollapsed(gbRec: Object): boolean; - /** - * Check whether grouping is applied for the specified sorting expressions. - * - * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings - */ - isGroupByApplied(exprs?: any[]): boolean; -} + /** + * Check whether grouping is applied for the specified sorting expressions. + * + * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings + */ + isGroupByApplied(exprs?: any[]): boolean; + } } interface IgniteUIStatic { DataSource: typeof Infragistics.DataSource; } -declare module Infragistics { -export class TypeParser { - toStr(obj: Object): void; +declare namespace Infragistics { + class TypeParser { + toStr(obj: Object): void; - /** - * L.A. 18 June 2012 Fixing bug #113265 Column 'date' shows empty values as 'NaN' - * - * @param obj - * @param pk - * @param key - */ - toDate(obj: Object, pk: Object, key: Object): void; - toNumber(obj: Object): void; - toBool(obj: Object): void; - isNullOrUndefined(obj: Object): void; - empty(): void; - num(): void; -} + /** + * L.A. 18 June 2012 Fixing bug #113265 Column 'date' shows empty values as 'NaN' + * + * @param obj + * @param pk + * @param key + */ + toDate(obj: Object, pk: Object, key: Object): void; + toNumber(obj: Object): void; + toBool(obj: Object): void; + isNullOrUndefined(obj: Object): void; + empty(): void; + num(): void; + } } interface DataSchemaSchemaFields { - /** * Name of the field */ @@ -1043,7 +1036,6 @@ interface DataSchemaSchemaFields { } interface DataSchemaSchema { - /** * A list of field definitions specifying the schema of the data source. Field objects description: {name, [type], [xpath]} * returnType="array" @@ -1066,950 +1058,949 @@ interface DataSchemaSchema { [optionName: string]: any; } -declare module Infragistics { -export class DataSchema { - constructor(schema: DataSchemaSchema); +declare namespace Infragistics { + class DataSchema { + constructor(schema: DataSchemaSchema); - /** - * Performs a transformation on the schema so that the resulting data matches the schema - * - * @param data the data to transform - */ - transform(data: Object): Object; + /** + * Performs a transformation on the schema so that the resulting data matches the schema + * + * @param data the data to transform + */ + transform(data: Object): Object; - /** - * Specifies if the object is null, undefined, or an empty string - * - * @param o the object to check for being empty - */ - isEmpty(o: Object): Object; + /** + * Specifies if the object is null, undefined, or an empty string + * + * @param o the object to check for being empty + */ + isEmpty(o: Object): Object; - /** - * Specifies if the object has custom properties or not - * - * @param obj the object to check for presence or lack of custom properties - */ - isObjEmpty(obj: Object): Object; + /** + * Specifies if the object has custom properties or not + * + * @param obj the object to check for presence or lack of custom properties + */ + isObjEmpty(obj: Object): Object; - /** - * A list of field definitions specifying the schema of the data source. - * Field objects description: {fieldName, [fieldDataType], [fieldXPath]} - */ - fields(): any[]; -} + /** + * A list of field definitions specifying the schema of the data source. + * Field objects description: {fieldName, [fieldDataType], [fieldXPath]} + */ + fields(): any[]; + } } interface IgniteUIStatic { DataSchema: typeof Infragistics.DataSchema; } -declare module Infragistics { -export class RemoteDataSource { - constructor(settings: DataSourceSettings); +declare namespace Infragistics { + class RemoteDataSource { + constructor(settings: DataSourceSettings); - /** - * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields - * - * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } - */ - fields(fields?: Object): Object; + /** + * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields + * + * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } + */ + fields(fields?: Object): Object; - /** - * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type - */ - analyzeDataSource(): string; + /** + * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type + */ + analyzeDataSource(): string; - /** - * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView - */ - dataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView + */ + dataView(): any[]; - /** - * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. - */ - data(): Object; + /** + * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. + */ + data(): Object; - /** - * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging - * - * @param transformedExecution - */ - transformedData(transformedExecution: Object): Object; + /** + * Returns transformed data according to transformed execution: + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging + * + * @param transformedExecution + */ + transformedData(transformedExecution: Object): Object; - /** - * Returns summaries data - */ - dataSummaries(): Object; + /** + * Returns summaries data + */ + dataSummaries(): Object; - /** - * Gets/sets the schema definition. - * - * @param s a schema object - * @param t type of the data source. See settings.type - */ - schema(s?: Object, t?: string): void; + /** + * Gets/sets the schema definition. + * + * @param s a schema object + * @param t type of the data source. See settings.type + */ + schema(s?: Object, t?: string): void; - /** - * Gets/sets a list of paging settings - * - * @param p object holding all paging settings. See settings.paging - */ - pagingSettings(p?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @param p object holding all paging settings. See settings.paging + */ + pagingSettings(p?: Object): Object; - /** - * Gets/sets a list of filtering settings - * - * @param f object holding all filtering settings. See settings.filtering - */ - filterSettings(f?: Object): void; + /** + * Gets/sets a list of filtering settings + * + * @param f object holding all filtering settings. See settings.filtering + */ + filterSettings(f?: Object): void; - /** - * Gets/sets a list of paging settings - * - * @param s object holding all sorting settings. See settings.sorting - */ - sortSettings(s?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @param s object holding all sorting settings. See settings.sorting + */ + sortSettings(s?: Object): Object; - /** - * Gets/sets a list of summaries settings. - * - * @param s object holding all summaries settings. See settings.summaries - */ - summariesSettings(s?: Object): void; + /** + * Gets/sets a list of summaries settings. + * + * @param s object holding all summaries settings. See settings.summaries + */ + summariesSettings(s?: Object): void; - /** - * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource - * - * @param ds - */ - dataSource(ds?: Object): Object; + /** + * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource + * + * @param ds + */ + dataSource(ds?: Object): Object; - /** - * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type - * - * @param t - * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty - */ - type(t?: Object): string; + /** + * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type + * + * @param t + * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty + */ + type(t?: Object): string; - /** - * Returns a record by a specified key (requires that primaryKey is set in the settings) - * - * @param key Primary key of the record - * @param ds the data source in which to search for the record. When not set it will use the current data source. - * @param objPath Not used in $.ig.DataSource - */ - findRecordByKey(key: string, ds?: string, objPath?: string): Object; + /** + * Returns a record by a specified key (requires that primaryKey is set in the settings) + * + * @param key Primary key of the record + * @param ds the data source in which to search for the record. When not set it will use the current data source. + * @param objPath Not used in $.ig.DataSource + */ + findRecordByKey(key: string, ds?: string, objPath?: string): Object; - /** - * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source - * - * @param key primary key of the record - * @param origDs - */ - removeRecordByKey(key: Object, origDs: Object): void; + /** + * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source + * + * @param key primary key of the record + * @param origDs + */ + removeRecordByKey(key: Object, origDs: Object): void; - /** - * Removes a record from the data source at specific index. - * - * @param index index of record - * @param origDs - */ - removeRecordByIndex(index: number, origDs: Object): void; + /** + * Removes a record from the data source at specific index. + * + * @param index index of record + * @param origDs + */ + removeRecordByIndex(index: number, origDs: Object): void; - /** - * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it - * - * @param rowId the rowId - row key (string) or index (number) - * @param colId the column id - column key (string) or index (number) - * @param val The new value - * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log - */ - setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; + /** + * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it + * + * @param rowId the rowId - row key (string) or index (number) + * @param colId the column id - column key (string) or index (number) + * @param val The new value + * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log + */ + setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; - /** - * Updates a record in the datasource. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; + /** + * Updates a record in the datasource. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; - /** - * Adds a new row to the data source. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; + /** + * Adds a new row to the data source. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; - /** - * Adds a new row to the data source. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param rowIndex row index at which to insert the new row - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - * @param parentRowId Not used in $.ig.DataSource - */ - insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; + /** + * Adds a new row to the data source. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param rowIndex row index at which to insert the new row + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param parentRowId Not used in $.ig.DataSource + */ + insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; - /** - * Deletes a row from the data source. - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - deleteRow(rowId: Object, autoCommit: boolean): Object; + /** + * Deletes a row from the data source. + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + deleteRow(rowId: Object, autoCommit: boolean): Object; - /** - * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back - * - * @param data the transaction data - */ - addNode(data: Object): void; + /** + * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back + * + * @param data the transaction data + */ + addNode(data: Object): void; - /** - * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back - * - * @param data the transaction data - */ - removeNode(data: Object): void; + /** + * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back + * + * @param data the transaction data + */ + removeNode(data: Object): void; - /** - * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source - * - * @param t a transaction object - */ - getDetachedRecord(t: Object): Object; + /** + * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source + * + * @param t a transaction object + */ + getDetachedRecord(t: Object): Object; - /** - * Update the data source with every transaction from the log - * - * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. - */ - commit(id?: number): void; + /** + * Update the data source with every transaction from the log + * + * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. + */ + commit(id?: number): void; - /** - * Clears the transaction log without updating anything in the data source - * - * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. - */ - rollback(id?: Object): void; + /** + * Clears the transaction log without updating anything in the data source + * + * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. + */ + rollback(id?: Object): void; - /** - * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source - */ - pendingTransactions(): any[]; + /** + * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source + */ + pendingTransactions(): any[]; - /** - * Returns a list of all transaction objects that are either pending, or have been committed in the data source. - */ - allTransactions(): any[]; + /** + * Returns a list of all transaction objects that are either pending, or have been committed in the data source. + */ + allTransactions(): any[]; - /** - * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently - */ - transactionsAsString(): string; + /** + * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently + */ + transactionsAsString(): string; - /** - * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params - * - * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) - * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) - */ - saveChanges(success: Function, error: Function): void; + /** + * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params + * + * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) + * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) + */ + saveChanges(success: Function, error: Function): void; - /** - * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView - * 6. fire the databound event - * - * @param callback callback function - * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context - */ - dataBind(callback?: string, callee?: Object): void; + /** + * Data binds to the current data source + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView + * 6. fire the databound event + * + * @param callback callback function + * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context + */ + dataBind(callback?: string, callee?: Object): void; - /** - * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. - * - * @param fieldName the fieldName - name of the field - * @param record the record from which to get it - */ - getCellValue(fieldName: string, record: Object): Object; + /** + * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. + * + * @param fieldName the fieldName - name of the field + * @param record the record from which to get it + */ + getCellValue(fieldName: string, record: Object): Object; - /** - * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * If key or dsObj are not set then returns summaries data. - * Takes summary data from passed argument dsObj(using argument key) - * - * @param key response key to take summary data(for example "Metadata.Summaries") - * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) - */ - summariesResponse(key?: string, dsObj?: Object): Object; + /** + * Applicable only when the data source is bound to remote data. + * Gets or sets summaries data. + * If key or dsObj are not set then returns summaries data. + * Takes summary data from passed argument dsObj(using argument key) + * + * @param key response key to take summary data(for example "Metadata.Summaries") + * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) + */ + summariesResponse(key?: string, dsObj?: Object): Object; - /** - * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. - */ - filteredData(): any[]; + /** + * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. + */ + filteredData(): any[]; - /** - * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * fields => an array of fields object definitions: - * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] - * - * @param fields an array of fields object definitions - * @param direction asc / desc direction - */ - sort(fields: Object, direction: string): void; + /** + * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * fields => an array of fields object definitions: + * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] + * + * @param fields an array of fields object definitions + * @param direction asc / desc direction + */ + sort(fields: Object, direction: string): void; - /** - * This clears local sorting applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalSorting(): void; + /** + * This clears local sorting applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalSorting(): void; - /** - * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain - * if expr is detected to be a regular expression, the "cond" part is skipped - * - * @param fieldExpressions a list of field expression definitions - * @param boolLogic boolean logic. Accepted values are AND and OR. - * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions - * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. - */ - filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; + /** + * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain + * if expr is detected to be a regular expression, the "cond" part is skipped + * + * @param fieldExpressions a list of field expression definitions + * @param boolLogic boolean logic. Accepted values are AND and OR. + * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions + * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. + */ + filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): void; - /** - * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * the actual total number of records may not - * match the number of records that exists on the client - * - * @param count the total number of records - * @param key - * @param dsObj - * @param context - */ - totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; + /** + * Applicable only when the data source is bound to remote data. + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * the actual total number of records may not + * match the number of records that exists on the client + * + * @param count the total number of records + * @param key + * @param dsObj + * @param context + */ + totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; - /** - * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend - * - * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend - */ - hasTotalRecordsCount(hasCount: boolean): void; + /** + * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend + * + * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend + */ + hasTotalRecordsCount(hasCount: boolean): void; - /** - * Returns metadata object for the specified key - * - * @param key Primary key of the record - */ - metadata(key: string): Object; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * Returns the total number of records in the local data source + */ + totalLocalRecordsCount(): number; - /** - * Returns the total number of pages - */ - pageCount(): number; + /** + * Returns the total number of pages + */ + pageCount(): number; - /** - * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. - * - * @param index the page index. If none is specified, returns the current page index. - */ - pageIndex(index?: number): number; + /** + * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. + * + * @param index the page index. If none is specified, returns the current page index. + */ + pageIndex(index?: number): number; - /** - * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. - * - * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. - */ - persistedPageIndex(value?: number): number; + /** + * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. + * + * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. + */ + persistedPageIndex(value?: number): number; - /** - * Sets the page index to be equal to the previous page index and rebinds the data source - */ - prevPage(): void; + /** + * Sets the page index to be equal to the previous page index and rebinds the data source + */ + prevPage(): void; - /** - * Sets the page index to be equal to the next page index and rebinds the data source - */ - nextPage(): void; + /** + * Sets the page index to be equal to the next page index and rebinds the data source + */ + nextPage(): void; - /** - * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size - * - * @param s the page size. - */ - pageSize(s?: number): number; + /** + * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size + * + * @param s the page size. + */ + pageSize(s?: number): number; - /** - * For internal use - * - * @param dirty - */ - pageSizeDirty(dirty: Object): void; + /** + * For internal use + * + * @param dirty + */ + pageSizeDirty(dirty: Object): void; - /** - * Returns a list of records for the specified page. Implies that paging is enabled. - * - * @param p the page index for which records will be returned - */ - recordsForPage(p: number): void; + /** + * Returns a list of records for the specified page. Implies that paging is enabled. + * + * @param p the page index for which records will be returned + */ + recordsForPage(p: number): void; - /** - * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data - * - * @param tableDOM TABLE dom element to transform - */ - tableToObject(tableDOM: Element): Object; + /** + * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data + * + * @param tableDOM TABLE dom element to transform + */ + tableToObject(tableDOM: Element): Object; - /** - * Parses the string and returns an evaluated JSON object - * - * @param s the JSON as string. - */ - stringToJSONObject(s: string): void; + /** + * Parses the string and returns an evaluated JSON object + * + * @param s the JSON as string. + */ + stringToJSONObject(s: string): void; - /** - * Parses a string and returns a XML Document - * - * @param s the XML represented as a string - */ - stringToXmlObject(s: string): void; + /** + * Parses a string and returns a XML Document + * + * @param s the XML represented as a string + */ + stringToXmlObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data - */ - groupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data + */ + groupByData(): any[]; - /** - * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) - */ - visibleGroupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) + */ + visibleGroupByData(): any[]; - /** - * Returns the current normalized/transformed and paged/filtered/sorted group-by data - */ - groupByDataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted group-by data + */ + groupByDataView(): any[]; - /** - * Toggle grouped record with the specified id and updates collections visible groupby data and data view - * - * @param id data-id attribute of the respective group row in the DOM - * @param collapsed if true the record should be collapsed, otherwise expanded - */ - toggleGroupByRecord(id: string, collapsed: boolean): void; + /** + * Toggle grouped record with the specified id and updates collections visible groupby data and data view + * + * @param id data-id attribute of the respective group row in the DOM + * @param collapsed if true the record should be collapsed, otherwise expanded + */ + toggleGroupByRecord(id: string, collapsed: boolean): void; - /** - * Check whether the specified gorupby record is collapsed - * - * @param gbRec id of the grouped record OR grouped record - */ - isGroupByRecordCollapsed(gbRec: Object): boolean; + /** + * Check whether the specified gorupby record is collapsed + * + * @param gbRec id of the grouped record OR grouped record + */ + isGroupByRecordCollapsed(gbRec: Object): boolean; - /** - * Check whether grouping is applied for the specified sorting expressions. - * - * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings - */ - isGroupByApplied(exprs?: any[]): boolean; -} + /** + * Check whether grouping is applied for the specified sorting expressions. + * + * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings + */ + isGroupByApplied(exprs?: any[]): boolean; + } } interface IgniteUIStatic { RemoteDataSource: typeof Infragistics.RemoteDataSource; } -declare module Infragistics { -export class JSONDataSource { - constructor(settings: DataSourceSettings); +declare namespace Infragistics { + class JSONDataSource { + constructor(settings: DataSourceSettings); - /** - * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields - * - * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } - */ - fields(fields?: Object): Object; + /** + * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields + * + * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } + */ + fields(fields?: Object): Object; - /** - * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type - */ - analyzeDataSource(): string; + /** + * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type + */ + analyzeDataSource(): string; - /** - * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView - */ - dataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView + */ + dataView(): any[]; - /** - * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. - */ - data(): Object; + /** + * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. + */ + data(): Object; - /** - * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging - * - * @param transformedExecution - */ - transformedData(transformedExecution: Object): Object; + /** + * Returns transformed data according to transformed execution: + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging + * + * @param transformedExecution + */ + transformedData(transformedExecution: Object): Object; - /** - * Returns summaries data - */ - dataSummaries(): Object; + /** + * Returns summaries data + */ + dataSummaries(): Object; - /** - * Gets/sets the schema definition. - * - * @param s a schema object - * @param t type of the data source. See settings.type - */ - schema(s?: Object, t?: string): void; + /** + * Gets/sets the schema definition. + * + * @param s a schema object + * @param t type of the data source. See settings.type + */ + schema(s?: Object, t?: string): void; - /** - * Gets/sets a list of paging settings - * - * @param p object holding all paging settings. See settings.paging - */ - pagingSettings(p?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @param p object holding all paging settings. See settings.paging + */ + pagingSettings(p?: Object): Object; - /** - * Gets/sets a list of filtering settings - * - * @param f object holding all filtering settings. See settings.filtering - */ - filterSettings(f?: Object): void; + /** + * Gets/sets a list of filtering settings + * + * @param f object holding all filtering settings. See settings.filtering + */ + filterSettings(f?: Object): void; - /** - * Gets/sets a list of paging settings - * - * @param s object holding all sorting settings. See settings.sorting - */ - sortSettings(s?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @param s object holding all sorting settings. See settings.sorting + */ + sortSettings(s?: Object): Object; - /** - * Gets/sets a list of summaries settings. - * - * @param s object holding all summaries settings. See settings.summaries - */ - summariesSettings(s?: Object): void; + /** + * Gets/sets a list of summaries settings. + * + * @param s object holding all summaries settings. See settings.summaries + */ + summariesSettings(s?: Object): void; - /** - * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource - * - * @param ds - */ - dataSource(ds?: Object): Object; + /** + * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource + * + * @param ds + */ + dataSource(ds?: Object): Object; - /** - * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type - * - * @param t - * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty - */ - type(t?: Object): string; + /** + * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type + * + * @param t + * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty + */ + type(t?: Object): string; - /** - * Returns a record by a specified key (requires that primaryKey is set in the settings) - * - * @param key Primary key of the record - * @param ds the data source in which to search for the record. When not set it will use the current data source. - * @param objPath Not used in $.ig.DataSource - */ - findRecordByKey(key: string, ds?: string, objPath?: string): Object; + /** + * Returns a record by a specified key (requires that primaryKey is set in the settings) + * + * @param key Primary key of the record + * @param ds the data source in which to search for the record. When not set it will use the current data source. + * @param objPath Not used in $.ig.DataSource + */ + findRecordByKey(key: string, ds?: string, objPath?: string): Object; - /** - * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source - * - * @param key primary key of the record - * @param origDs - */ - removeRecordByKey(key: Object, origDs: Object): void; + /** + * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source + * + * @param key primary key of the record + * @param origDs + */ + removeRecordByKey(key: Object, origDs: Object): void; - /** - * Removes a record from the data source at specific index. - * - * @param index index of record - * @param origDs - */ - removeRecordByIndex(index: number, origDs: Object): void; + /** + * Removes a record from the data source at specific index. + * + * @param index index of record + * @param origDs + */ + removeRecordByIndex(index: number, origDs: Object): void; - /** - * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it - * - * @param rowId the rowId - row key (string) or index (number) - * @param colId the column id - column key (string) or index (number) - * @param val The new value - * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log - */ - setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; + /** + * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it + * + * @param rowId the rowId - row key (string) or index (number) + * @param colId the column id - column key (string) or index (number) + * @param val The new value + * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log + */ + setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; - /** - * Updates a record in the datasource. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; + /** + * Updates a record in the datasource. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; - /** - * Adds a new row to the data source. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; + /** + * Adds a new row to the data source. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; - /** - * Adds a new row to the data source. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param rowIndex row index at which to insert the new row - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - * @param parentRowId Not used in $.ig.DataSource - */ - insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; + /** + * Adds a new row to the data source. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param rowIndex row index at which to insert the new row + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param parentRowId Not used in $.ig.DataSource + */ + insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; - /** - * Deletes a row from the data source. - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - deleteRow(rowId: Object, autoCommit: boolean): Object; + /** + * Deletes a row from the data source. + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + deleteRow(rowId: Object, autoCommit: boolean): Object; - /** - * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back - * - * @param data the transaction data - */ - addNode(data: Object): void; + /** + * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back + * + * @param data the transaction data + */ + addNode(data: Object): void; - /** - * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back - * - * @param data the transaction data - */ - removeNode(data: Object): void; + /** + * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back + * + * @param data the transaction data + */ + removeNode(data: Object): void; - /** - * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source - * - * @param t a transaction object - */ - getDetachedRecord(t: Object): Object; + /** + * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source + * + * @param t a transaction object + */ + getDetachedRecord(t: Object): Object; - /** - * Update the data source with every transaction from the log - * - * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. - */ - commit(id?: number): void; + /** + * Update the data source with every transaction from the log + * + * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. + */ + commit(id?: number): void; - /** - * Clears the transaction log without updating anything in the data source - * - * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. - */ - rollback(id?: Object): void; + /** + * Clears the transaction log without updating anything in the data source + * + * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. + */ + rollback(id?: Object): void; - /** - * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source - */ - pendingTransactions(): any[]; + /** + * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source + */ + pendingTransactions(): any[]; - /** - * Returns a list of all transaction objects that are either pending, or have been committed in the data source. - */ - allTransactions(): any[]; + /** + * Returns a list of all transaction objects that are either pending, or have been committed in the data source. + */ + allTransactions(): any[]; - /** - * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently - */ - transactionsAsString(): string; + /** + * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently + */ + transactionsAsString(): string; - /** - * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params - * - * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) - * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) - */ - saveChanges(success: Function, error: Function): void; + /** + * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params + * + * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) + * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) + */ + saveChanges(success: Function, error: Function): void; - /** - * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView - * 6. fire the databound event - * - * @param callback callback function - * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context - */ - dataBind(callback?: string, callee?: Object): void; + /** + * Data binds to the current data source + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView + * 6. fire the databound event + * + * @param callback callback function + * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context + */ + dataBind(callback?: string, callee?: Object): void; - /** - * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. - * - * @param fieldName the fieldName - name of the field - * @param record the record from which to get it - */ - getCellValue(fieldName: string, record: Object): Object; + /** + * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. + * + * @param fieldName the fieldName - name of the field + * @param record the record from which to get it + */ + getCellValue(fieldName: string, record: Object): Object; - /** - * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * If key or dsObj are not set then returns summaries data. - * Takes summary data from passed argument dsObj(using argument key) - * - * @param key response key to take summary data(for example "Metadata.Summaries") - * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) - */ - summariesResponse(key?: string, dsObj?: Object): Object; + /** + * Applicable only when the data source is bound to remote data. + * Gets or sets summaries data. + * If key or dsObj are not set then returns summaries data. + * Takes summary data from passed argument dsObj(using argument key) + * + * @param key response key to take summary data(for example "Metadata.Summaries") + * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) + */ + summariesResponse(key?: string, dsObj?: Object): Object; - /** - * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. - */ - filteredData(): any[]; + /** + * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. + */ + filteredData(): any[]; - /** - * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * fields => an array of fields object definitions: - * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] - * - * @param fields an array of fields object definitions - * @param direction asc / desc direction - */ - sort(fields: Object, direction: string): void; + /** + * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * fields => an array of fields object definitions: + * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] + * + * @param fields an array of fields object definitions + * @param direction asc / desc direction + */ + sort(fields: Object, direction: string): void; - /** - * This clears local sorting applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalSorting(): void; + /** + * This clears local sorting applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalSorting(): void; - /** - * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain - * if expr is detected to be a regular expression, the "cond" part is skipped - * - * @param fieldExpressions a list of field expression definitions - * @param boolLogic boolean logic. Accepted values are AND and OR. - * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions - * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. - */ - filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; + /** + * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain + * if expr is detected to be a regular expression, the "cond" part is skipped + * + * @param fieldExpressions a list of field expression definitions + * @param boolLogic boolean logic. Accepted values are AND and OR. + * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions + * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. + */ + filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): void; - /** - * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * the actual total number of records may not - * match the number of records that exists on the client - * - * @param count the total number of records - * @param key - * @param dsObj - * @param context - */ - totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; + /** + * Applicable only when the data source is bound to remote data. + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * the actual total number of records may not + * match the number of records that exists on the client + * + * @param count the total number of records + * @param key + * @param dsObj + * @param context + */ + totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; - /** - * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend - * - * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend - */ - hasTotalRecordsCount(hasCount: boolean): void; + /** + * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend + * + * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend + */ + hasTotalRecordsCount(hasCount: boolean): void; - /** - * Returns metadata object for the specified key - * - * @param key Primary key of the record - */ - metadata(key: string): Object; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * Returns the total number of records in the local data source + */ + totalLocalRecordsCount(): number; - /** - * Returns the total number of pages - */ - pageCount(): number; + /** + * Returns the total number of pages + */ + pageCount(): number; - /** - * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. - * - * @param index the page index. If none is specified, returns the current page index. - */ - pageIndex(index?: number): number; + /** + * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. + * + * @param index the page index. If none is specified, returns the current page index. + */ + pageIndex(index?: number): number; - /** - * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. - * - * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. - */ - persistedPageIndex(value?: number): number; + /** + * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. + * + * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. + */ + persistedPageIndex(value?: number): number; - /** - * Sets the page index to be equal to the previous page index and rebinds the data source - */ - prevPage(): void; + /** + * Sets the page index to be equal to the previous page index and rebinds the data source + */ + prevPage(): void; - /** - * Sets the page index to be equal to the next page index and rebinds the data source - */ - nextPage(): void; + /** + * Sets the page index to be equal to the next page index and rebinds the data source + */ + nextPage(): void; - /** - * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size - * - * @param s the page size. - */ - pageSize(s?: number): number; + /** + * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size + * + * @param s the page size. + */ + pageSize(s?: number): number; - /** - * For internal use - * - * @param dirty - */ - pageSizeDirty(dirty: Object): void; + /** + * For internal use + * + * @param dirty + */ + pageSizeDirty(dirty: Object): void; - /** - * Returns a list of records for the specified page. Implies that paging is enabled. - * - * @param p the page index for which records will be returned - */ - recordsForPage(p: number): void; + /** + * Returns a list of records for the specified page. Implies that paging is enabled. + * + * @param p the page index for which records will be returned + */ + recordsForPage(p: number): void; - /** - * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data - * - * @param tableDOM TABLE dom element to transform - */ - tableToObject(tableDOM: Element): Object; + /** + * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data + * + * @param tableDOM TABLE dom element to transform + */ + tableToObject(tableDOM: Element): Object; - /** - * Parses the string and returns an evaluated JSON object - * - * @param s the JSON as string. - */ - stringToJSONObject(s: string): void; + /** + * Parses the string and returns an evaluated JSON object + * + * @param s the JSON as string. + */ + stringToJSONObject(s: string): void; - /** - * Parses a string and returns a XML Document - * - * @param s the XML represented as a string - */ - stringToXmlObject(s: string): void; + /** + * Parses a string and returns a XML Document + * + * @param s the XML represented as a string + */ + stringToXmlObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data - */ - groupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data + */ + groupByData(): any[]; - /** - * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) - */ - visibleGroupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) + */ + visibleGroupByData(): any[]; - /** - * Returns the current normalized/transformed and paged/filtered/sorted group-by data - */ - groupByDataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted group-by data + */ + groupByDataView(): any[]; - /** - * Toggle grouped record with the specified id and updates collections visible groupby data and data view - * - * @param id data-id attribute of the respective group row in the DOM - * @param collapsed if true the record should be collapsed, otherwise expanded - */ - toggleGroupByRecord(id: string, collapsed: boolean): void; + /** + * Toggle grouped record with the specified id and updates collections visible groupby data and data view + * + * @param id data-id attribute of the respective group row in the DOM + * @param collapsed if true the record should be collapsed, otherwise expanded + */ + toggleGroupByRecord(id: string, collapsed: boolean): void; - /** - * Check whether the specified gorupby record is collapsed - * - * @param gbRec id of the grouped record OR grouped record - */ - isGroupByRecordCollapsed(gbRec: Object): boolean; + /** + * Check whether the specified gorupby record is collapsed + * + * @param gbRec id of the grouped record OR grouped record + */ + isGroupByRecordCollapsed(gbRec: Object): boolean; - /** - * Check whether grouping is applied for the specified sorting expressions. - * - * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings - */ - isGroupByApplied(exprs?: any[]): boolean; -} + /** + * Check whether grouping is applied for the specified sorting expressions. + * + * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings + */ + isGroupByApplied(exprs?: any[]): boolean; + } } interface IgniteUIStatic { JSONDataSource: typeof Infragistics.JSONDataSource; } interface RESTDataSourceSettingsRestSettingsCreate { - /** * Specifies a remote URL to which create requests will be sent. This will be used for both batch and non-batch, however if template is also set, this URL will only be used for batch requests. */ @@ -2032,7 +2023,6 @@ interface RESTDataSourceSettingsRestSettingsCreate { } interface RESTDataSourceSettingsRestSettingsUpdate { - /** * Specifies a remote URL to which update requests will be sent. This will be used for both batch and non-batch, however if template is also set, this URL will only be used for batch requests. */ @@ -2055,7 +2045,6 @@ interface RESTDataSourceSettingsRestSettingsUpdate { } interface RESTDataSourceSettingsRestSettingsRemove { - /** * Specifies a remote URL to which remove requests will be sent. This will be used for both batch and non-batch, however if template is also set, this URL will only be used for batch requests. */ @@ -2078,7 +2067,6 @@ interface RESTDataSourceSettingsRestSettingsRemove { } interface RESTDataSourceSettingsRestSettings { - /** * Settings for create requests */ @@ -2116,7 +2104,6 @@ interface RESTDataSourceSettingsRestSettings { } interface RESTDataSourceSettings { - /** * Settings related to REST compliant update routine */ @@ -2128,461 +2115,460 @@ interface RESTDataSourceSettings { [optionName: string]: any; } -declare module Infragistics { -export class RESTDataSource { - constructor(settings: RESTDataSourceSettings); +declare namespace Infragistics { + class RESTDataSource { + constructor(settings: RESTDataSourceSettings); - /** - * Posts to the restSettings urls using $.ajax, by serializing the changes as url params. - * - * @param success - * @param error - */ - saveChanges(success: Object, error: Object): void; + /** + * Posts to the restSettings urls using $.ajax, by serializing the changes as url params. + * + * @param success + * @param error + */ + saveChanges(success: Object, error: Object): void; - /** - * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields - * - * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } - */ - fields(fields?: Object): Object; + /** + * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields + * + * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } + */ + fields(fields?: Object): Object; - /** - * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type - */ - analyzeDataSource(): string; + /** + * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type + */ + analyzeDataSource(): string; - /** - * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView - */ - dataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView + */ + dataView(): any[]; - /** - * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. - */ - data(): Object; + /** + * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. + */ + data(): Object; - /** - * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging - * - * @param transformedExecution - */ - transformedData(transformedExecution: Object): Object; + /** + * Returns transformed data according to transformed execution: + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging + * + * @param transformedExecution + */ + transformedData(transformedExecution: Object): Object; - /** - * Returns summaries data - */ - dataSummaries(): Object; + /** + * Returns summaries data + */ + dataSummaries(): Object; - /** - * Gets/sets the schema definition. - * - * @param s a schema object - * @param t type of the data source. See settings.type - */ - schema(s?: Object, t?: string): void; + /** + * Gets/sets the schema definition. + * + * @param s a schema object + * @param t type of the data source. See settings.type + */ + schema(s?: Object, t?: string): void; - /** - * Gets/sets a list of paging settings - * - * @param p object holding all paging settings. See settings.paging - */ - pagingSettings(p?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @param p object holding all paging settings. See settings.paging + */ + pagingSettings(p?: Object): Object; - /** - * Gets/sets a list of filtering settings - * - * @param f object holding all filtering settings. See settings.filtering - */ - filterSettings(f?: Object): void; + /** + * Gets/sets a list of filtering settings + * + * @param f object holding all filtering settings. See settings.filtering + */ + filterSettings(f?: Object): void; - /** - * Gets/sets a list of paging settings - * - * @param s object holding all sorting settings. See settings.sorting - */ - sortSettings(s?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @param s object holding all sorting settings. See settings.sorting + */ + sortSettings(s?: Object): Object; - /** - * Gets/sets a list of summaries settings. - * - * @param s object holding all summaries settings. See settings.summaries - */ - summariesSettings(s?: Object): void; + /** + * Gets/sets a list of summaries settings. + * + * @param s object holding all summaries settings. See settings.summaries + */ + summariesSettings(s?: Object): void; - /** - * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource - * - * @param ds - */ - dataSource(ds?: Object): Object; + /** + * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource + * + * @param ds + */ + dataSource(ds?: Object): Object; - /** - * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type - * - * @param t - * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty - */ - type(t?: Object): string; + /** + * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type + * + * @param t + * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty + */ + type(t?: Object): string; - /** - * Returns a record by a specified key (requires that primaryKey is set in the settings) - * - * @param key Primary key of the record - * @param ds the data source in which to search for the record. When not set it will use the current data source. - * @param objPath Not used in $.ig.DataSource - */ - findRecordByKey(key: string, ds?: string, objPath?: string): Object; + /** + * Returns a record by a specified key (requires that primaryKey is set in the settings) + * + * @param key Primary key of the record + * @param ds the data source in which to search for the record. When not set it will use the current data source. + * @param objPath Not used in $.ig.DataSource + */ + findRecordByKey(key: string, ds?: string, objPath?: string): Object; - /** - * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source - * - * @param key primary key of the record - * @param origDs - */ - removeRecordByKey(key: Object, origDs: Object): void; + /** + * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source + * + * @param key primary key of the record + * @param origDs + */ + removeRecordByKey(key: Object, origDs: Object): void; - /** - * Removes a record from the data source at specific index. - * - * @param index index of record - * @param origDs - */ - removeRecordByIndex(index: number, origDs: Object): void; + /** + * Removes a record from the data source at specific index. + * + * @param index index of record + * @param origDs + */ + removeRecordByIndex(index: number, origDs: Object): void; - /** - * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it - * - * @param rowId the rowId - row key (string) or index (number) - * @param colId the column id - column key (string) or index (number) - * @param val The new value - * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log - */ - setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; + /** + * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it + * + * @param rowId the rowId - row key (string) or index (number) + * @param colId the column id - column key (string) or index (number) + * @param val The new value + * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log + */ + setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; - /** - * Updates a record in the datasource. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; + /** + * Updates a record in the datasource. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; - /** - * Adds a new row to the data source. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; + /** + * Adds a new row to the data source. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; - /** - * Adds a new row to the data source. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param rowIndex row index at which to insert the new row - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - * @param parentRowId Not used in $.ig.DataSource - */ - insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; + /** + * Adds a new row to the data source. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param rowIndex row index at which to insert the new row + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param parentRowId Not used in $.ig.DataSource + */ + insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; - /** - * Deletes a row from the data source. - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - deleteRow(rowId: Object, autoCommit: boolean): Object; + /** + * Deletes a row from the data source. + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + deleteRow(rowId: Object, autoCommit: boolean): Object; - /** - * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back - * - * @param data the transaction data - */ - addNode(data: Object): void; + /** + * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back + * + * @param data the transaction data + */ + addNode(data: Object): void; - /** - * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back - * - * @param data the transaction data - */ - removeNode(data: Object): void; + /** + * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back + * + * @param data the transaction data + */ + removeNode(data: Object): void; - /** - * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source - * - * @param t a transaction object - */ - getDetachedRecord(t: Object): Object; + /** + * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source + * + * @param t a transaction object + */ + getDetachedRecord(t: Object): Object; - /** - * Update the data source with every transaction from the log - * - * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. - */ - commit(id?: number): void; + /** + * Update the data source with every transaction from the log + * + * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. + */ + commit(id?: number): void; - /** - * Clears the transaction log without updating anything in the data source - * - * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. - */ - rollback(id?: Object): void; + /** + * Clears the transaction log without updating anything in the data source + * + * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. + */ + rollback(id?: Object): void; - /** - * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source - */ - pendingTransactions(): any[]; + /** + * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source + */ + pendingTransactions(): any[]; - /** - * Returns a list of all transaction objects that are either pending, or have been committed in the data source. - */ - allTransactions(): any[]; + /** + * Returns a list of all transaction objects that are either pending, or have been committed in the data source. + */ + allTransactions(): any[]; - /** - * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently - */ - transactionsAsString(): string; + /** + * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently + */ + transactionsAsString(): string; - /** - * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView - * 6. fire the databound event - * - * @param callback callback function - * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context - */ - dataBind(callback?: string, callee?: Object): void; + /** + * Data binds to the current data source + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView + * 6. fire the databound event + * + * @param callback callback function + * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context + */ + dataBind(callback?: string, callee?: Object): void; - /** - * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. - * - * @param fieldName the fieldName - name of the field - * @param record the record from which to get it - */ - getCellValue(fieldName: string, record: Object): Object; + /** + * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. + * + * @param fieldName the fieldName - name of the field + * @param record the record from which to get it + */ + getCellValue(fieldName: string, record: Object): Object; - /** - * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * If key or dsObj are not set then returns summaries data. - * Takes summary data from passed argument dsObj(using argument key) - * - * @param key response key to take summary data(for example "Metadata.Summaries") - * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) - */ - summariesResponse(key?: string, dsObj?: Object): Object; + /** + * Applicable only when the data source is bound to remote data. + * Gets or sets summaries data. + * If key or dsObj are not set then returns summaries data. + * Takes summary data from passed argument dsObj(using argument key) + * + * @param key response key to take summary data(for example "Metadata.Summaries") + * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) + */ + summariesResponse(key?: string, dsObj?: Object): Object; - /** - * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. - */ - filteredData(): any[]; + /** + * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. + */ + filteredData(): any[]; - /** - * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * fields => an array of fields object definitions: - * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] - * - * @param fields an array of fields object definitions - * @param direction asc / desc direction - */ - sort(fields: Object, direction: string): void; + /** + * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * fields => an array of fields object definitions: + * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] + * + * @param fields an array of fields object definitions + * @param direction asc / desc direction + */ + sort(fields: Object, direction: string): void; - /** - * This clears local sorting applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalSorting(): void; + /** + * This clears local sorting applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalSorting(): void; - /** - * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain - * if expr is detected to be a regular expression, the "cond" part is skipped - * - * @param fieldExpressions a list of field expression definitions - * @param boolLogic boolean logic. Accepted values are AND and OR. - * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions - * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. - */ - filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; + /** + * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain + * if expr is detected to be a regular expression, the "cond" part is skipped + * + * @param fieldExpressions a list of field expression definitions + * @param boolLogic boolean logic. Accepted values are AND and OR. + * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions + * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. + */ + filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): void; - /** - * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * the actual total number of records may not - * match the number of records that exists on the client - * - * @param count the total number of records - * @param key - * @param dsObj - * @param context - */ - totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; + /** + * Applicable only when the data source is bound to remote data. + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * the actual total number of records may not + * match the number of records that exists on the client + * + * @param count the total number of records + * @param key + * @param dsObj + * @param context + */ + totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; - /** - * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend - * - * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend - */ - hasTotalRecordsCount(hasCount: boolean): void; + /** + * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend + * + * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend + */ + hasTotalRecordsCount(hasCount: boolean): void; - /** - * Returns metadata object for the specified key - * - * @param key Primary key of the record - */ - metadata(key: string): Object; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * Returns the total number of records in the local data source + */ + totalLocalRecordsCount(): number; - /** - * Returns the total number of pages - */ - pageCount(): number; + /** + * Returns the total number of pages + */ + pageCount(): number; - /** - * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. - * - * @param index the page index. If none is specified, returns the current page index. - */ - pageIndex(index?: number): number; + /** + * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. + * + * @param index the page index. If none is specified, returns the current page index. + */ + pageIndex(index?: number): number; - /** - * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. - * - * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. - */ - persistedPageIndex(value?: number): number; + /** + * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. + * + * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. + */ + persistedPageIndex(value?: number): number; - /** - * Sets the page index to be equal to the previous page index and rebinds the data source - */ - prevPage(): void; + /** + * Sets the page index to be equal to the previous page index and rebinds the data source + */ + prevPage(): void; - /** - * Sets the page index to be equal to the next page index and rebinds the data source - */ - nextPage(): void; + /** + * Sets the page index to be equal to the next page index and rebinds the data source + */ + nextPage(): void; - /** - * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size - * - * @param s the page size. - */ - pageSize(s?: number): number; + /** + * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size + * + * @param s the page size. + */ + pageSize(s?: number): number; - /** - * For internal use - * - * @param dirty - */ - pageSizeDirty(dirty: Object): void; + /** + * For internal use + * + * @param dirty + */ + pageSizeDirty(dirty: Object): void; - /** - * Returns a list of records for the specified page. Implies that paging is enabled. - * - * @param p the page index for which records will be returned - */ - recordsForPage(p: number): void; + /** + * Returns a list of records for the specified page. Implies that paging is enabled. + * + * @param p the page index for which records will be returned + */ + recordsForPage(p: number): void; - /** - * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data - * - * @param tableDOM TABLE dom element to transform - */ - tableToObject(tableDOM: Element): Object; + /** + * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data + * + * @param tableDOM TABLE dom element to transform + */ + tableToObject(tableDOM: Element): Object; - /** - * Parses the string and returns an evaluated JSON object - * - * @param s the JSON as string. - */ - stringToJSONObject(s: string): void; + /** + * Parses the string and returns an evaluated JSON object + * + * @param s the JSON as string. + */ + stringToJSONObject(s: string): void; - /** - * Parses a string and returns a XML Document - * - * @param s the XML represented as a string - */ - stringToXmlObject(s: string): void; + /** + * Parses a string and returns a XML Document + * + * @param s the XML represented as a string + */ + stringToXmlObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data - */ - groupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data + */ + groupByData(): any[]; - /** - * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) - */ - visibleGroupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) + */ + visibleGroupByData(): any[]; - /** - * Returns the current normalized/transformed and paged/filtered/sorted group-by data - */ - groupByDataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted group-by data + */ + groupByDataView(): any[]; - /** - * Toggle grouped record with the specified id and updates collections visible groupby data and data view - * - * @param id data-id attribute of the respective group row in the DOM - * @param collapsed if true the record should be collapsed, otherwise expanded - */ - toggleGroupByRecord(id: string, collapsed: boolean): void; + /** + * Toggle grouped record with the specified id and updates collections visible groupby data and data view + * + * @param id data-id attribute of the respective group row in the DOM + * @param collapsed if true the record should be collapsed, otherwise expanded + */ + toggleGroupByRecord(id: string, collapsed: boolean): void; - /** - * Check whether the specified gorupby record is collapsed - * - * @param gbRec id of the grouped record OR grouped record - */ - isGroupByRecordCollapsed(gbRec: Object): boolean; + /** + * Check whether the specified gorupby record is collapsed + * + * @param gbRec id of the grouped record OR grouped record + */ + isGroupByRecordCollapsed(gbRec: Object): boolean; - /** - * Check whether grouping is applied for the specified sorting expressions. - * - * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings - */ - isGroupByApplied(exprs?: any[]): boolean; -} + /** + * Check whether grouping is applied for the specified sorting expressions. + * + * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings + */ + isGroupByApplied(exprs?: any[]): boolean; + } } interface IgniteUIStatic { RESTDataSource: typeof Infragistics.RESTDataSource; } interface JSONPDataSourceSettings { - /** * Override the callback function name in a jsonp request. Sets option jsonp in $.ajax functionbool Setting the jsonp option to false prevents jQuery from adding the "?callback" string to the URL or attempting to use "=?" for transformation * @@ -2600,2273 +2586,2272 @@ interface JSONPDataSourceSettings { [optionName: string]: any; } -declare module Infragistics { -export class JSONPDataSource { - constructor(settings: JSONPDataSourceSettings); +declare namespace Infragistics { + class JSONPDataSource { + constructor(settings: JSONPDataSourceSettings); - /** - * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields - * - * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } - */ - fields(fields?: Object): Object; + /** + * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields + * + * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } + */ + fields(fields?: Object): Object; - /** - * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type - */ - analyzeDataSource(): string; + /** + * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type + */ + analyzeDataSource(): string; - /** - * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView - */ - dataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView + */ + dataView(): any[]; - /** - * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. - */ - data(): Object; + /** + * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. + */ + data(): Object; - /** - * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging - * - * @param transformedExecution - */ - transformedData(transformedExecution: Object): Object; + /** + * Returns transformed data according to transformed execution: + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging + * + * @param transformedExecution + */ + transformedData(transformedExecution: Object): Object; - /** - * Returns summaries data - */ - dataSummaries(): Object; + /** + * Returns summaries data + */ + dataSummaries(): Object; - /** - * Gets/sets the schema definition. - * - * @param s a schema object - * @param t type of the data source. See settings.type - */ - schema(s?: Object, t?: string): void; + /** + * Gets/sets the schema definition. + * + * @param s a schema object + * @param t type of the data source. See settings.type + */ + schema(s?: Object, t?: string): void; - /** - * Gets/sets a list of paging settings - * - * @param p object holding all paging settings. See settings.paging - */ - pagingSettings(p?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @param p object holding all paging settings. See settings.paging + */ + pagingSettings(p?: Object): Object; - /** - * Gets/sets a list of filtering settings - * - * @param f object holding all filtering settings. See settings.filtering - */ - filterSettings(f?: Object): void; + /** + * Gets/sets a list of filtering settings + * + * @param f object holding all filtering settings. See settings.filtering + */ + filterSettings(f?: Object): void; - /** - * Gets/sets a list of paging settings - * - * @param s object holding all sorting settings. See settings.sorting - */ - sortSettings(s?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @param s object holding all sorting settings. See settings.sorting + */ + sortSettings(s?: Object): Object; - /** - * Gets/sets a list of summaries settings. - * - * @param s object holding all summaries settings. See settings.summaries - */ - summariesSettings(s?: Object): void; + /** + * Gets/sets a list of summaries settings. + * + * @param s object holding all summaries settings. See settings.summaries + */ + summariesSettings(s?: Object): void; - /** - * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource - * - * @param ds - */ - dataSource(ds?: Object): Object; + /** + * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource + * + * @param ds + */ + dataSource(ds?: Object): Object; - /** - * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type - * - * @param t - * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty - */ - type(t?: Object): string; + /** + * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type + * + * @param t + * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty + */ + type(t?: Object): string; - /** - * Returns a record by a specified key (requires that primaryKey is set in the settings) - * - * @param key Primary key of the record - * @param ds the data source in which to search for the record. When not set it will use the current data source. - * @param objPath Not used in $.ig.DataSource - */ - findRecordByKey(key: string, ds?: string, objPath?: string): Object; + /** + * Returns a record by a specified key (requires that primaryKey is set in the settings) + * + * @param key Primary key of the record + * @param ds the data source in which to search for the record. When not set it will use the current data source. + * @param objPath Not used in $.ig.DataSource + */ + findRecordByKey(key: string, ds?: string, objPath?: string): Object; - /** - * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source - * - * @param key primary key of the record - * @param origDs - */ - removeRecordByKey(key: Object, origDs: Object): void; + /** + * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source + * + * @param key primary key of the record + * @param origDs + */ + removeRecordByKey(key: Object, origDs: Object): void; - /** - * Removes a record from the data source at specific index. - * - * @param index index of record - * @param origDs - */ - removeRecordByIndex(index: number, origDs: Object): void; + /** + * Removes a record from the data source at specific index. + * + * @param index index of record + * @param origDs + */ + removeRecordByIndex(index: number, origDs: Object): void; - /** - * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it - * - * @param rowId the rowId - row key (string) or index (number) - * @param colId the column id - column key (string) or index (number) - * @param val The new value - * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log - */ - setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; + /** + * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it + * + * @param rowId the rowId - row key (string) or index (number) + * @param colId the column id - column key (string) or index (number) + * @param val The new value + * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log + */ + setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; - /** - * Updates a record in the datasource. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; + /** + * Updates a record in the datasource. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; - /** - * Adds a new row to the data source. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; + /** + * Adds a new row to the data source. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; - /** - * Adds a new row to the data source. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param rowIndex row index at which to insert the new row - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - * @param parentRowId Not used in $.ig.DataSource - */ - insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; + /** + * Adds a new row to the data source. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param rowIndex row index at which to insert the new row + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param parentRowId Not used in $.ig.DataSource + */ + insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; - /** - * Deletes a row from the data source. - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - deleteRow(rowId: Object, autoCommit: boolean): Object; + /** + * Deletes a row from the data source. + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + deleteRow(rowId: Object, autoCommit: boolean): Object; - /** - * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back - * - * @param data the transaction data - */ - addNode(data: Object): void; + /** + * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back + * + * @param data the transaction data + */ + addNode(data: Object): void; - /** - * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back - * - * @param data the transaction data - */ - removeNode(data: Object): void; + /** + * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back + * + * @param data the transaction data + */ + removeNode(data: Object): void; - /** - * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source - * - * @param t a transaction object - */ - getDetachedRecord(t: Object): Object; + /** + * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source + * + * @param t a transaction object + */ + getDetachedRecord(t: Object): Object; - /** - * Update the data source with every transaction from the log - * - * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. - */ - commit(id?: number): void; + /** + * Update the data source with every transaction from the log + * + * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. + */ + commit(id?: number): void; - /** - * Clears the transaction log without updating anything in the data source - * - * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. - */ - rollback(id?: Object): void; + /** + * Clears the transaction log without updating anything in the data source + * + * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. + */ + rollback(id?: Object): void; - /** - * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source - */ - pendingTransactions(): any[]; + /** + * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source + */ + pendingTransactions(): any[]; - /** - * Returns a list of all transaction objects that are either pending, or have been committed in the data source. - */ - allTransactions(): any[]; + /** + * Returns a list of all transaction objects that are either pending, or have been committed in the data source. + */ + allTransactions(): any[]; - /** - * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently - */ - transactionsAsString(): string; + /** + * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently + */ + transactionsAsString(): string; - /** - * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params - * - * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) - * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) - */ - saveChanges(success: Function, error: Function): void; + /** + * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params + * + * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) + * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) + */ + saveChanges(success: Function, error: Function): void; - /** - * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView - * 6. fire the databound event - * - * @param callback callback function - * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context - */ - dataBind(callback?: string, callee?: Object): void; + /** + * Data binds to the current data source + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView + * 6. fire the databound event + * + * @param callback callback function + * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context + */ + dataBind(callback?: string, callee?: Object): void; - /** - * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. - * - * @param fieldName the fieldName - name of the field - * @param record the record from which to get it - */ - getCellValue(fieldName: string, record: Object): Object; + /** + * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. + * + * @param fieldName the fieldName - name of the field + * @param record the record from which to get it + */ + getCellValue(fieldName: string, record: Object): Object; - /** - * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * If key or dsObj are not set then returns summaries data. - * Takes summary data from passed argument dsObj(using argument key) - * - * @param key response key to take summary data(for example "Metadata.Summaries") - * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) - */ - summariesResponse(key?: string, dsObj?: Object): Object; + /** + * Applicable only when the data source is bound to remote data. + * Gets or sets summaries data. + * If key or dsObj are not set then returns summaries data. + * Takes summary data from passed argument dsObj(using argument key) + * + * @param key response key to take summary data(for example "Metadata.Summaries") + * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) + */ + summariesResponse(key?: string, dsObj?: Object): Object; - /** - * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. - */ - filteredData(): any[]; + /** + * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. + */ + filteredData(): any[]; - /** - * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * fields => an array of fields object definitions: - * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] - * - * @param fields an array of fields object definitions - * @param direction asc / desc direction - */ - sort(fields: Object, direction: string): void; + /** + * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * fields => an array of fields object definitions: + * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] + * + * @param fields an array of fields object definitions + * @param direction asc / desc direction + */ + sort(fields: Object, direction: string): void; - /** - * This clears local sorting applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalSorting(): void; + /** + * This clears local sorting applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalSorting(): void; - /** - * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain - * if expr is detected to be a regular expression, the "cond" part is skipped - * - * @param fieldExpressions a list of field expression definitions - * @param boolLogic boolean logic. Accepted values are AND and OR. - * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions - * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. - */ - filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; + /** + * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain + * if expr is detected to be a regular expression, the "cond" part is skipped + * + * @param fieldExpressions a list of field expression definitions + * @param boolLogic boolean logic. Accepted values are AND and OR. + * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions + * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. + */ + filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): void; - /** - * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * the actual total number of records may not - * match the number of records that exists on the client - * - * @param count the total number of records - * @param key - * @param dsObj - * @param context - */ - totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; + /** + * Applicable only when the data source is bound to remote data. + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * the actual total number of records may not + * match the number of records that exists on the client + * + * @param count the total number of records + * @param key + * @param dsObj + * @param context + */ + totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; - /** - * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend - * - * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend - */ - hasTotalRecordsCount(hasCount: boolean): void; + /** + * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend + * + * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend + */ + hasTotalRecordsCount(hasCount: boolean): void; - /** - * Returns metadata object for the specified key - * - * @param key Primary key of the record - */ - metadata(key: string): Object; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * Returns the total number of records in the local data source + */ + totalLocalRecordsCount(): number; - /** - * Returns the total number of pages - */ - pageCount(): number; + /** + * Returns the total number of pages + */ + pageCount(): number; - /** - * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. - * - * @param index the page index. If none is specified, returns the current page index. - */ - pageIndex(index?: number): number; + /** + * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. + * + * @param index the page index. If none is specified, returns the current page index. + */ + pageIndex(index?: number): number; - /** - * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. - * - * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. - */ - persistedPageIndex(value?: number): number; + /** + * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. + * + * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. + */ + persistedPageIndex(value?: number): number; - /** - * Sets the page index to be equal to the previous page index and rebinds the data source - */ - prevPage(): void; + /** + * Sets the page index to be equal to the previous page index and rebinds the data source + */ + prevPage(): void; - /** - * Sets the page index to be equal to the next page index and rebinds the data source - */ - nextPage(): void; + /** + * Sets the page index to be equal to the next page index and rebinds the data source + */ + nextPage(): void; - /** - * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size - * - * @param s the page size. - */ - pageSize(s?: number): number; + /** + * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size + * + * @param s the page size. + */ + pageSize(s?: number): number; - /** - * For internal use - * - * @param dirty - */ - pageSizeDirty(dirty: Object): void; + /** + * For internal use + * + * @param dirty + */ + pageSizeDirty(dirty: Object): void; - /** - * Returns a list of records for the specified page. Implies that paging is enabled. - * - * @param p the page index for which records will be returned - */ - recordsForPage(p: number): void; + /** + * Returns a list of records for the specified page. Implies that paging is enabled. + * + * @param p the page index for which records will be returned + */ + recordsForPage(p: number): void; - /** - * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data - * - * @param tableDOM TABLE dom element to transform - */ - tableToObject(tableDOM: Element): Object; + /** + * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data + * + * @param tableDOM TABLE dom element to transform + */ + tableToObject(tableDOM: Element): Object; - /** - * Parses the string and returns an evaluated JSON object - * - * @param s the JSON as string. - */ - stringToJSONObject(s: string): void; + /** + * Parses the string and returns an evaluated JSON object + * + * @param s the JSON as string. + */ + stringToJSONObject(s: string): void; - /** - * Parses a string and returns a XML Document - * - * @param s the XML represented as a string - */ - stringToXmlObject(s: string): void; + /** + * Parses a string and returns a XML Document + * + * @param s the XML represented as a string + */ + stringToXmlObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data - */ - groupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data + */ + groupByData(): any[]; - /** - * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) - */ - visibleGroupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) + */ + visibleGroupByData(): any[]; - /** - * Returns the current normalized/transformed and paged/filtered/sorted group-by data - */ - groupByDataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted group-by data + */ + groupByDataView(): any[]; - /** - * Toggle grouped record with the specified id and updates collections visible groupby data and data view - * - * @param id data-id attribute of the respective group row in the DOM - * @param collapsed if true the record should be collapsed, otherwise expanded - */ - toggleGroupByRecord(id: string, collapsed: boolean): void; + /** + * Toggle grouped record with the specified id and updates collections visible groupby data and data view + * + * @param id data-id attribute of the respective group row in the DOM + * @param collapsed if true the record should be collapsed, otherwise expanded + */ + toggleGroupByRecord(id: string, collapsed: boolean): void; - /** - * Check whether the specified gorupby record is collapsed - * - * @param gbRec id of the grouped record OR grouped record - */ - isGroupByRecordCollapsed(gbRec: Object): boolean; + /** + * Check whether the specified gorupby record is collapsed + * + * @param gbRec id of the grouped record OR grouped record + */ + isGroupByRecordCollapsed(gbRec: Object): boolean; - /** - * Check whether grouping is applied for the specified sorting expressions. - * - * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings - */ - isGroupByApplied(exprs?: any[]): boolean; -} + /** + * Check whether grouping is applied for the specified sorting expressions. + * + * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings + */ + isGroupByApplied(exprs?: any[]): boolean; + } } interface IgniteUIStatic { JSONPDataSource: typeof Infragistics.JSONPDataSource; } -declare module Infragistics { -export class XmlDataSource { - constructor(settings: DataSourceSettings); +declare namespace Infragistics { + class XmlDataSource { + constructor(settings: DataSourceSettings); - /** - * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields - * - * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } - */ - fields(fields?: Object): Object; + /** + * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields + * + * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } + */ + fields(fields?: Object): Object; - /** - * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type - */ - analyzeDataSource(): string; + /** + * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type + */ + analyzeDataSource(): string; - /** - * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView - */ - dataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView + */ + dataView(): any[]; - /** - * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. - */ - data(): Object; + /** + * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. + */ + data(): Object; - /** - * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging - * - * @param transformedExecution - */ - transformedData(transformedExecution: Object): Object; + /** + * Returns transformed data according to transformed execution: + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging + * + * @param transformedExecution + */ + transformedData(transformedExecution: Object): Object; - /** - * Returns summaries data - */ - dataSummaries(): Object; + /** + * Returns summaries data + */ + dataSummaries(): Object; - /** - * Gets/sets the schema definition. - * - * @param s a schema object - * @param t type of the data source. See settings.type - */ - schema(s?: Object, t?: string): void; + /** + * Gets/sets the schema definition. + * + * @param s a schema object + * @param t type of the data source. See settings.type + */ + schema(s?: Object, t?: string): void; - /** - * Gets/sets a list of paging settings - * - * @param p object holding all paging settings. See settings.paging - */ - pagingSettings(p?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @param p object holding all paging settings. See settings.paging + */ + pagingSettings(p?: Object): Object; - /** - * Gets/sets a list of filtering settings - * - * @param f object holding all filtering settings. See settings.filtering - */ - filterSettings(f?: Object): void; + /** + * Gets/sets a list of filtering settings + * + * @param f object holding all filtering settings. See settings.filtering + */ + filterSettings(f?: Object): void; - /** - * Gets/sets a list of paging settings - * - * @param s object holding all sorting settings. See settings.sorting - */ - sortSettings(s?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @param s object holding all sorting settings. See settings.sorting + */ + sortSettings(s?: Object): Object; - /** - * Gets/sets a list of summaries settings. - * - * @param s object holding all summaries settings. See settings.summaries - */ - summariesSettings(s?: Object): void; + /** + * Gets/sets a list of summaries settings. + * + * @param s object holding all summaries settings. See settings.summaries + */ + summariesSettings(s?: Object): void; - /** - * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource - * - * @param ds - */ - dataSource(ds?: Object): Object; + /** + * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource + * + * @param ds + */ + dataSource(ds?: Object): Object; - /** - * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type - * - * @param t - * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty - */ - type(t?: Object): string; + /** + * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type + * + * @param t + * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty + */ + type(t?: Object): string; - /** - * Returns a record by a specified key (requires that primaryKey is set in the settings) - * - * @param key Primary key of the record - * @param ds the data source in which to search for the record. When not set it will use the current data source. - * @param objPath Not used in $.ig.DataSource - */ - findRecordByKey(key: string, ds?: string, objPath?: string): Object; + /** + * Returns a record by a specified key (requires that primaryKey is set in the settings) + * + * @param key Primary key of the record + * @param ds the data source in which to search for the record. When not set it will use the current data source. + * @param objPath Not used in $.ig.DataSource + */ + findRecordByKey(key: string, ds?: string, objPath?: string): Object; - /** - * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source - * - * @param key primary key of the record - * @param origDs - */ - removeRecordByKey(key: Object, origDs: Object): void; + /** + * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source + * + * @param key primary key of the record + * @param origDs + */ + removeRecordByKey(key: Object, origDs: Object): void; - /** - * Removes a record from the data source at specific index. - * - * @param index index of record - * @param origDs - */ - removeRecordByIndex(index: number, origDs: Object): void; + /** + * Removes a record from the data source at specific index. + * + * @param index index of record + * @param origDs + */ + removeRecordByIndex(index: number, origDs: Object): void; - /** - * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it - * - * @param rowId the rowId - row key (string) or index (number) - * @param colId the column id - column key (string) or index (number) - * @param val The new value - * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log - */ - setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; + /** + * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it + * + * @param rowId the rowId - row key (string) or index (number) + * @param colId the column id - column key (string) or index (number) + * @param val The new value + * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log + */ + setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; - /** - * Updates a record in the datasource. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; + /** + * Updates a record in the datasource. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; - /** - * Adds a new row to the data source. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; + /** + * Adds a new row to the data source. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; - /** - * Adds a new row to the data source. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param rowIndex row index at which to insert the new row - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - * @param parentRowId Not used in $.ig.DataSource - */ - insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; + /** + * Adds a new row to the data source. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param rowIndex row index at which to insert the new row + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param parentRowId Not used in $.ig.DataSource + */ + insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; - /** - * Deletes a row from the data source. - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - deleteRow(rowId: Object, autoCommit: boolean): Object; + /** + * Deletes a row from the data source. + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + deleteRow(rowId: Object, autoCommit: boolean): Object; - /** - * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back - * - * @param data the transaction data - */ - addNode(data: Object): void; + /** + * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back + * + * @param data the transaction data + */ + addNode(data: Object): void; - /** - * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back - * - * @param data the transaction data - */ - removeNode(data: Object): void; + /** + * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back + * + * @param data the transaction data + */ + removeNode(data: Object): void; - /** - * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source - * - * @param t a transaction object - */ - getDetachedRecord(t: Object): Object; + /** + * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source + * + * @param t a transaction object + */ + getDetachedRecord(t: Object): Object; - /** - * Update the data source with every transaction from the log - * - * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. - */ - commit(id?: number): void; + /** + * Update the data source with every transaction from the log + * + * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. + */ + commit(id?: number): void; - /** - * Clears the transaction log without updating anything in the data source - * - * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. - */ - rollback(id?: Object): void; + /** + * Clears the transaction log without updating anything in the data source + * + * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. + */ + rollback(id?: Object): void; - /** - * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source - */ - pendingTransactions(): any[]; + /** + * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source + */ + pendingTransactions(): any[]; - /** - * Returns a list of all transaction objects that are either pending, or have been committed in the data source. - */ - allTransactions(): any[]; + /** + * Returns a list of all transaction objects that are either pending, or have been committed in the data source. + */ + allTransactions(): any[]; - /** - * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently - */ - transactionsAsString(): string; + /** + * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently + */ + transactionsAsString(): string; - /** - * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params - * - * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) - * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) - */ - saveChanges(success: Function, error: Function): void; + /** + * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params + * + * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) + * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) + */ + saveChanges(success: Function, error: Function): void; - /** - * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView - * 6. fire the databound event - * - * @param callback callback function - * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context - */ - dataBind(callback?: string, callee?: Object): void; + /** + * Data binds to the current data source + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView + * 6. fire the databound event + * + * @param callback callback function + * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context + */ + dataBind(callback?: string, callee?: Object): void; - /** - * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. - * - * @param fieldName the fieldName - name of the field - * @param record the record from which to get it - */ - getCellValue(fieldName: string, record: Object): Object; + /** + * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. + * + * @param fieldName the fieldName - name of the field + * @param record the record from which to get it + */ + getCellValue(fieldName: string, record: Object): Object; - /** - * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * If key or dsObj are not set then returns summaries data. - * Takes summary data from passed argument dsObj(using argument key) - * - * @param key response key to take summary data(for example "Metadata.Summaries") - * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) - */ - summariesResponse(key?: string, dsObj?: Object): Object; + /** + * Applicable only when the data source is bound to remote data. + * Gets or sets summaries data. + * If key or dsObj are not set then returns summaries data. + * Takes summary data from passed argument dsObj(using argument key) + * + * @param key response key to take summary data(for example "Metadata.Summaries") + * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) + */ + summariesResponse(key?: string, dsObj?: Object): Object; - /** - * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. - */ - filteredData(): any[]; + /** + * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. + */ + filteredData(): any[]; - /** - * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * fields => an array of fields object definitions: - * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] - * - * @param fields an array of fields object definitions - * @param direction asc / desc direction - */ - sort(fields: Object, direction: string): void; + /** + * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * fields => an array of fields object definitions: + * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] + * + * @param fields an array of fields object definitions + * @param direction asc / desc direction + */ + sort(fields: Object, direction: string): void; - /** - * This clears local sorting applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalSorting(): void; + /** + * This clears local sorting applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalSorting(): void; - /** - * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain - * if expr is detected to be a regular expression, the "cond" part is skipped - * - * @param fieldExpressions a list of field expression definitions - * @param boolLogic boolean logic. Accepted values are AND and OR. - * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions - * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. - */ - filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; + /** + * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain + * if expr is detected to be a regular expression, the "cond" part is skipped + * + * @param fieldExpressions a list of field expression definitions + * @param boolLogic boolean logic. Accepted values are AND and OR. + * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions + * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. + */ + filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): void; - /** - * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * the actual total number of records may not - * match the number of records that exists on the client - * - * @param count the total number of records - * @param key - * @param dsObj - * @param context - */ - totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; + /** + * Applicable only when the data source is bound to remote data. + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * the actual total number of records may not + * match the number of records that exists on the client + * + * @param count the total number of records + * @param key + * @param dsObj + * @param context + */ + totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; - /** - * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend - * - * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend - */ - hasTotalRecordsCount(hasCount: boolean): void; + /** + * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend + * + * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend + */ + hasTotalRecordsCount(hasCount: boolean): void; - /** - * Returns metadata object for the specified key - * - * @param key Primary key of the record - */ - metadata(key: string): Object; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * Returns the total number of records in the local data source + */ + totalLocalRecordsCount(): number; - /** - * Returns the total number of pages - */ - pageCount(): number; + /** + * Returns the total number of pages + */ + pageCount(): number; - /** - * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. - * - * @param index the page index. If none is specified, returns the current page index. - */ - pageIndex(index?: number): number; + /** + * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. + * + * @param index the page index. If none is specified, returns the current page index. + */ + pageIndex(index?: number): number; - /** - * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. - * - * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. - */ - persistedPageIndex(value?: number): number; + /** + * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. + * + * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. + */ + persistedPageIndex(value?: number): number; - /** - * Sets the page index to be equal to the previous page index and rebinds the data source - */ - prevPage(): void; + /** + * Sets the page index to be equal to the previous page index and rebinds the data source + */ + prevPage(): void; - /** - * Sets the page index to be equal to the next page index and rebinds the data source - */ - nextPage(): void; + /** + * Sets the page index to be equal to the next page index and rebinds the data source + */ + nextPage(): void; - /** - * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size - * - * @param s the page size. - */ - pageSize(s?: number): number; + /** + * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size + * + * @param s the page size. + */ + pageSize(s?: number): number; - /** - * For internal use - * - * @param dirty - */ - pageSizeDirty(dirty: Object): void; + /** + * For internal use + * + * @param dirty + */ + pageSizeDirty(dirty: Object): void; - /** - * Returns a list of records for the specified page. Implies that paging is enabled. - * - * @param p the page index for which records will be returned - */ - recordsForPage(p: number): void; + /** + * Returns a list of records for the specified page. Implies that paging is enabled. + * + * @param p the page index for which records will be returned + */ + recordsForPage(p: number): void; - /** - * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data - * - * @param tableDOM TABLE dom element to transform - */ - tableToObject(tableDOM: Element): Object; + /** + * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data + * + * @param tableDOM TABLE dom element to transform + */ + tableToObject(tableDOM: Element): Object; - /** - * Parses the string and returns an evaluated JSON object - * - * @param s the JSON as string. - */ - stringToJSONObject(s: string): void; + /** + * Parses the string and returns an evaluated JSON object + * + * @param s the JSON as string. + */ + stringToJSONObject(s: string): void; - /** - * Parses a string and returns a XML Document - * - * @param s the XML represented as a string - */ - stringToXmlObject(s: string): void; + /** + * Parses a string and returns a XML Document + * + * @param s the XML represented as a string + */ + stringToXmlObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data - */ - groupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data + */ + groupByData(): any[]; - /** - * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) - */ - visibleGroupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) + */ + visibleGroupByData(): any[]; - /** - * Returns the current normalized/transformed and paged/filtered/sorted group-by data - */ - groupByDataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted group-by data + */ + groupByDataView(): any[]; - /** - * Toggle grouped record with the specified id and updates collections visible groupby data and data view - * - * @param id data-id attribute of the respective group row in the DOM - * @param collapsed if true the record should be collapsed, otherwise expanded - */ - toggleGroupByRecord(id: string, collapsed: boolean): void; + /** + * Toggle grouped record with the specified id and updates collections visible groupby data and data view + * + * @param id data-id attribute of the respective group row in the DOM + * @param collapsed if true the record should be collapsed, otherwise expanded + */ + toggleGroupByRecord(id: string, collapsed: boolean): void; - /** - * Check whether the specified gorupby record is collapsed - * - * @param gbRec id of the grouped record OR grouped record - */ - isGroupByRecordCollapsed(gbRec: Object): boolean; + /** + * Check whether the specified gorupby record is collapsed + * + * @param gbRec id of the grouped record OR grouped record + */ + isGroupByRecordCollapsed(gbRec: Object): boolean; - /** - * Check whether grouping is applied for the specified sorting expressions. - * - * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings - */ - isGroupByApplied(exprs?: any[]): boolean; -} + /** + * Check whether grouping is applied for the specified sorting expressions. + * + * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings + */ + isGroupByApplied(exprs?: any[]): boolean; + } } interface IgniteUIStatic { XmlDataSource: typeof Infragistics.XmlDataSource; } -declare module Infragistics { -export class FunctionDataSource { - constructor(settings: DataSourceSettings); +declare namespace Infragistics { + class FunctionDataSource { + constructor(settings: DataSourceSettings); - /** - * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields - * - * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } - */ - fields(fields?: Object): Object; + /** + * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields + * + * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } + */ + fields(fields?: Object): Object; - /** - * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type - */ - analyzeDataSource(): string; + /** + * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type + */ + analyzeDataSource(): string; - /** - * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView - */ - dataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView + */ + dataView(): any[]; - /** - * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. - */ - data(): Object; + /** + * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. + */ + data(): Object; - /** - * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging - * - * @param transformedExecution - */ - transformedData(transformedExecution: Object): Object; + /** + * Returns transformed data according to transformed execution: + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging + * + * @param transformedExecution + */ + transformedData(transformedExecution: Object): Object; - /** - * Returns summaries data - */ - dataSummaries(): Object; + /** + * Returns summaries data + */ + dataSummaries(): Object; - /** - * Gets/sets the schema definition. - * - * @param s a schema object - * @param t type of the data source. See settings.type - */ - schema(s?: Object, t?: string): void; + /** + * Gets/sets the schema definition. + * + * @param s a schema object + * @param t type of the data source. See settings.type + */ + schema(s?: Object, t?: string): void; - /** - * Gets/sets a list of paging settings - * - * @param p object holding all paging settings. See settings.paging - */ - pagingSettings(p?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @param p object holding all paging settings. See settings.paging + */ + pagingSettings(p?: Object): Object; - /** - * Gets/sets a list of filtering settings - * - * @param f object holding all filtering settings. See settings.filtering - */ - filterSettings(f?: Object): void; + /** + * Gets/sets a list of filtering settings + * + * @param f object holding all filtering settings. See settings.filtering + */ + filterSettings(f?: Object): void; - /** - * Gets/sets a list of paging settings - * - * @param s object holding all sorting settings. See settings.sorting - */ - sortSettings(s?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @param s object holding all sorting settings. See settings.sorting + */ + sortSettings(s?: Object): Object; - /** - * Gets/sets a list of summaries settings. - * - * @param s object holding all summaries settings. See settings.summaries - */ - summariesSettings(s?: Object): void; + /** + * Gets/sets a list of summaries settings. + * + * @param s object holding all summaries settings. See settings.summaries + */ + summariesSettings(s?: Object): void; - /** - * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource - * - * @param ds - */ - dataSource(ds?: Object): Object; + /** + * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource + * + * @param ds + */ + dataSource(ds?: Object): Object; - /** - * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type - * - * @param t - * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty - */ - type(t?: Object): string; + /** + * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type + * + * @param t + * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty + */ + type(t?: Object): string; - /** - * Returns a record by a specified key (requires that primaryKey is set in the settings) - * - * @param key Primary key of the record - * @param ds the data source in which to search for the record. When not set it will use the current data source. - * @param objPath Not used in $.ig.DataSource - */ - findRecordByKey(key: string, ds?: string, objPath?: string): Object; + /** + * Returns a record by a specified key (requires that primaryKey is set in the settings) + * + * @param key Primary key of the record + * @param ds the data source in which to search for the record. When not set it will use the current data source. + * @param objPath Not used in $.ig.DataSource + */ + findRecordByKey(key: string, ds?: string, objPath?: string): Object; - /** - * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source - * - * @param key primary key of the record - * @param origDs - */ - removeRecordByKey(key: Object, origDs: Object): void; + /** + * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source + * + * @param key primary key of the record + * @param origDs + */ + removeRecordByKey(key: Object, origDs: Object): void; - /** - * Removes a record from the data source at specific index. - * - * @param index index of record - * @param origDs - */ - removeRecordByIndex(index: number, origDs: Object): void; + /** + * Removes a record from the data source at specific index. + * + * @param index index of record + * @param origDs + */ + removeRecordByIndex(index: number, origDs: Object): void; - /** - * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it - * - * @param rowId the rowId - row key (string) or index (number) - * @param colId the column id - column key (string) or index (number) - * @param val The new value - * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log - */ - setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; + /** + * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it + * + * @param rowId the rowId - row key (string) or index (number) + * @param colId the column id - column key (string) or index (number) + * @param val The new value + * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log + */ + setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; - /** - * Updates a record in the datasource. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; + /** + * Updates a record in the datasource. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; - /** - * Adds a new row to the data source. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; + /** + * Adds a new row to the data source. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; - /** - * Adds a new row to the data source. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param rowIndex row index at which to insert the new row - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - * @param parentRowId Not used in $.ig.DataSource - */ - insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; + /** + * Adds a new row to the data source. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param rowIndex row index at which to insert the new row + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param parentRowId Not used in $.ig.DataSource + */ + insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; - /** - * Deletes a row from the data source. - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - deleteRow(rowId: Object, autoCommit: boolean): Object; + /** + * Deletes a row from the data source. + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + deleteRow(rowId: Object, autoCommit: boolean): Object; - /** - * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back - * - * @param data the transaction data - */ - addNode(data: Object): void; + /** + * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back + * + * @param data the transaction data + */ + addNode(data: Object): void; - /** - * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back - * - * @param data the transaction data - */ - removeNode(data: Object): void; + /** + * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back + * + * @param data the transaction data + */ + removeNode(data: Object): void; - /** - * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source - * - * @param t a transaction object - */ - getDetachedRecord(t: Object): Object; + /** + * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source + * + * @param t a transaction object + */ + getDetachedRecord(t: Object): Object; - /** - * Update the data source with every transaction from the log - * - * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. - */ - commit(id?: number): void; + /** + * Update the data source with every transaction from the log + * + * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. + */ + commit(id?: number): void; - /** - * Clears the transaction log without updating anything in the data source - * - * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. - */ - rollback(id?: Object): void; + /** + * Clears the transaction log without updating anything in the data source + * + * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. + */ + rollback(id?: Object): void; - /** - * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source - */ - pendingTransactions(): any[]; + /** + * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source + */ + pendingTransactions(): any[]; - /** - * Returns a list of all transaction objects that are either pending, or have been committed in the data source. - */ - allTransactions(): any[]; + /** + * Returns a list of all transaction objects that are either pending, or have been committed in the data source. + */ + allTransactions(): any[]; - /** - * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently - */ - transactionsAsString(): string; + /** + * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently + */ + transactionsAsString(): string; - /** - * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params - * - * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) - * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) - */ - saveChanges(success: Function, error: Function): void; + /** + * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params + * + * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) + * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) + */ + saveChanges(success: Function, error: Function): void; - /** - * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView - * 6. fire the databound event - * - * @param callback callback function - * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context - */ - dataBind(callback?: string, callee?: Object): void; + /** + * Data binds to the current data source + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView + * 6. fire the databound event + * + * @param callback callback function + * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context + */ + dataBind(callback?: string, callee?: Object): void; - /** - * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. - * - * @param fieldName the fieldName - name of the field - * @param record the record from which to get it - */ - getCellValue(fieldName: string, record: Object): Object; + /** + * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. + * + * @param fieldName the fieldName - name of the field + * @param record the record from which to get it + */ + getCellValue(fieldName: string, record: Object): Object; - /** - * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * If key or dsObj are not set then returns summaries data. - * Takes summary data from passed argument dsObj(using argument key) - * - * @param key response key to take summary data(for example "Metadata.Summaries") - * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) - */ - summariesResponse(key?: string, dsObj?: Object): Object; + /** + * Applicable only when the data source is bound to remote data. + * Gets or sets summaries data. + * If key or dsObj are not set then returns summaries data. + * Takes summary data from passed argument dsObj(using argument key) + * + * @param key response key to take summary data(for example "Metadata.Summaries") + * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) + */ + summariesResponse(key?: string, dsObj?: Object): Object; - /** - * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. - */ - filteredData(): any[]; + /** + * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. + */ + filteredData(): any[]; - /** - * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * fields => an array of fields object definitions: - * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] - * - * @param fields an array of fields object definitions - * @param direction asc / desc direction - */ - sort(fields: Object, direction: string): void; + /** + * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * fields => an array of fields object definitions: + * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] + * + * @param fields an array of fields object definitions + * @param direction asc / desc direction + */ + sort(fields: Object, direction: string): void; - /** - * This clears local sorting applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalSorting(): void; + /** + * This clears local sorting applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalSorting(): void; - /** - * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain - * if expr is detected to be a regular expression, the "cond" part is skipped - * - * @param fieldExpressions a list of field expression definitions - * @param boolLogic boolean logic. Accepted values are AND and OR. - * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions - * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. - */ - filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; + /** + * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain + * if expr is detected to be a regular expression, the "cond" part is skipped + * + * @param fieldExpressions a list of field expression definitions + * @param boolLogic boolean logic. Accepted values are AND and OR. + * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions + * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. + */ + filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): void; - /** - * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * the actual total number of records may not - * match the number of records that exists on the client - * - * @param count the total number of records - * @param key - * @param dsObj - * @param context - */ - totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; + /** + * Applicable only when the data source is bound to remote data. + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * the actual total number of records may not + * match the number of records that exists on the client + * + * @param count the total number of records + * @param key + * @param dsObj + * @param context + */ + totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; - /** - * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend - * - * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend - */ - hasTotalRecordsCount(hasCount: boolean): void; + /** + * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend + * + * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend + */ + hasTotalRecordsCount(hasCount: boolean): void; - /** - * Returns metadata object for the specified key - * - * @param key Primary key of the record - */ - metadata(key: string): Object; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * Returns the total number of records in the local data source + */ + totalLocalRecordsCount(): number; - /** - * Returns the total number of pages - */ - pageCount(): number; + /** + * Returns the total number of pages + */ + pageCount(): number; - /** - * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. - * - * @param index the page index. If none is specified, returns the current page index. - */ - pageIndex(index?: number): number; + /** + * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. + * + * @param index the page index. If none is specified, returns the current page index. + */ + pageIndex(index?: number): number; - /** - * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. - * - * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. - */ - persistedPageIndex(value?: number): number; + /** + * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. + * + * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. + */ + persistedPageIndex(value?: number): number; - /** - * Sets the page index to be equal to the previous page index and rebinds the data source - */ - prevPage(): void; + /** + * Sets the page index to be equal to the previous page index and rebinds the data source + */ + prevPage(): void; - /** - * Sets the page index to be equal to the next page index and rebinds the data source - */ - nextPage(): void; + /** + * Sets the page index to be equal to the next page index and rebinds the data source + */ + nextPage(): void; - /** - * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size - * - * @param s the page size. - */ - pageSize(s?: number): number; + /** + * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size + * + * @param s the page size. + */ + pageSize(s?: number): number; - /** - * For internal use - * - * @param dirty - */ - pageSizeDirty(dirty: Object): void; + /** + * For internal use + * + * @param dirty + */ + pageSizeDirty(dirty: Object): void; - /** - * Returns a list of records for the specified page. Implies that paging is enabled. - * - * @param p the page index for which records will be returned - */ - recordsForPage(p: number): void; + /** + * Returns a list of records for the specified page. Implies that paging is enabled. + * + * @param p the page index for which records will be returned + */ + recordsForPage(p: number): void; - /** - * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data - * - * @param tableDOM TABLE dom element to transform - */ - tableToObject(tableDOM: Element): Object; + /** + * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data + * + * @param tableDOM TABLE dom element to transform + */ + tableToObject(tableDOM: Element): Object; - /** - * Parses the string and returns an evaluated JSON object - * - * @param s the JSON as string. - */ - stringToJSONObject(s: string): void; + /** + * Parses the string and returns an evaluated JSON object + * + * @param s the JSON as string. + */ + stringToJSONObject(s: string): void; - /** - * Parses a string and returns a XML Document - * - * @param s the XML represented as a string - */ - stringToXmlObject(s: string): void; + /** + * Parses a string and returns a XML Document + * + * @param s the XML represented as a string + */ + stringToXmlObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data - */ - groupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data + */ + groupByData(): any[]; - /** - * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) - */ - visibleGroupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) + */ + visibleGroupByData(): any[]; - /** - * Returns the current normalized/transformed and paged/filtered/sorted group-by data - */ - groupByDataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted group-by data + */ + groupByDataView(): any[]; - /** - * Toggle grouped record with the specified id and updates collections visible groupby data and data view - * - * @param id data-id attribute of the respective group row in the DOM - * @param collapsed if true the record should be collapsed, otherwise expanded - */ - toggleGroupByRecord(id: string, collapsed: boolean): void; + /** + * Toggle grouped record with the specified id and updates collections visible groupby data and data view + * + * @param id data-id attribute of the respective group row in the DOM + * @param collapsed if true the record should be collapsed, otherwise expanded + */ + toggleGroupByRecord(id: string, collapsed: boolean): void; - /** - * Check whether the specified gorupby record is collapsed - * - * @param gbRec id of the grouped record OR grouped record - */ - isGroupByRecordCollapsed(gbRec: Object): boolean; + /** + * Check whether the specified gorupby record is collapsed + * + * @param gbRec id of the grouped record OR grouped record + */ + isGroupByRecordCollapsed(gbRec: Object): boolean; - /** - * Check whether grouping is applied for the specified sorting expressions. - * - * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings - */ - isGroupByApplied(exprs?: any[]): boolean; -} + /** + * Check whether grouping is applied for the specified sorting expressions. + * + * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings + */ + isGroupByApplied(exprs?: any[]): boolean; + } } interface IgniteUIStatic { FunctionDataSource: typeof Infragistics.FunctionDataSource; } -declare module Infragistics { -export class HtmlTableDataSource { - constructor(settings: DataSourceSettings); +declare namespace Infragistics { + class HtmlTableDataSource { + constructor(settings: DataSourceSettings); - /** - * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields - * - * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } - */ - fields(fields?: Object): Object; + /** + * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields + * + * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } + */ + fields(fields?: Object): Object; - /** - * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type - */ - analyzeDataSource(): string; + /** + * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type + */ + analyzeDataSource(): string; - /** - * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView - */ - dataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView + */ + dataView(): any[]; - /** - * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. - */ - data(): Object; + /** + * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. + */ + data(): Object; - /** - * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging - * - * @param transformedExecution - */ - transformedData(transformedExecution: Object): Object; + /** + * Returns transformed data according to transformed execution: + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging + * + * @param transformedExecution + */ + transformedData(transformedExecution: Object): Object; - /** - * Returns summaries data - */ - dataSummaries(): Object; + /** + * Returns summaries data + */ + dataSummaries(): Object; - /** - * Gets/sets the schema definition. - * - * @param s a schema object - * @param t type of the data source. See settings.type - */ - schema(s?: Object, t?: string): void; + /** + * Gets/sets the schema definition. + * + * @param s a schema object + * @param t type of the data source. See settings.type + */ + schema(s?: Object, t?: string): void; - /** - * Gets/sets a list of paging settings - * - * @param p object holding all paging settings. See settings.paging - */ - pagingSettings(p?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @param p object holding all paging settings. See settings.paging + */ + pagingSettings(p?: Object): Object; - /** - * Gets/sets a list of filtering settings - * - * @param f object holding all filtering settings. See settings.filtering - */ - filterSettings(f?: Object): void; + /** + * Gets/sets a list of filtering settings + * + * @param f object holding all filtering settings. See settings.filtering + */ + filterSettings(f?: Object): void; - /** - * Gets/sets a list of paging settings - * - * @param s object holding all sorting settings. See settings.sorting - */ - sortSettings(s?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @param s object holding all sorting settings. See settings.sorting + */ + sortSettings(s?: Object): Object; - /** - * Gets/sets a list of summaries settings. - * - * @param s object holding all summaries settings. See settings.summaries - */ - summariesSettings(s?: Object): void; + /** + * Gets/sets a list of summaries settings. + * + * @param s object holding all summaries settings. See settings.summaries + */ + summariesSettings(s?: Object): void; - /** - * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource - * - * @param ds - */ - dataSource(ds?: Object): Object; + /** + * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource + * + * @param ds + */ + dataSource(ds?: Object): Object; - /** - * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type - * - * @param t - * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty - */ - type(t?: Object): string; + /** + * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type + * + * @param t + * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty + */ + type(t?: Object): string; - /** - * Returns a record by a specified key (requires that primaryKey is set in the settings) - * - * @param key Primary key of the record - * @param ds the data source in which to search for the record. When not set it will use the current data source. - * @param objPath Not used in $.ig.DataSource - */ - findRecordByKey(key: string, ds?: string, objPath?: string): Object; + /** + * Returns a record by a specified key (requires that primaryKey is set in the settings) + * + * @param key Primary key of the record + * @param ds the data source in which to search for the record. When not set it will use the current data source. + * @param objPath Not used in $.ig.DataSource + */ + findRecordByKey(key: string, ds?: string, objPath?: string): Object; - /** - * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source - * - * @param key primary key of the record - * @param origDs - */ - removeRecordByKey(key: Object, origDs: Object): void; + /** + * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source + * + * @param key primary key of the record + * @param origDs + */ + removeRecordByKey(key: Object, origDs: Object): void; - /** - * Removes a record from the data source at specific index. - * - * @param index index of record - * @param origDs - */ - removeRecordByIndex(index: number, origDs: Object): void; + /** + * Removes a record from the data source at specific index. + * + * @param index index of record + * @param origDs + */ + removeRecordByIndex(index: number, origDs: Object): void; - /** - * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it - * - * @param rowId the rowId - row key (string) or index (number) - * @param colId the column id - column key (string) or index (number) - * @param val The new value - * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log - */ - setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; + /** + * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it + * + * @param rowId the rowId - row key (string) or index (number) + * @param colId the column id - column key (string) or index (number) + * @param val The new value + * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log + */ + setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; - /** - * Updates a record in the datasource. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; + /** + * Updates a record in the datasource. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; - /** - * Adds a new row to the data source. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; + /** + * Adds a new row to the data source. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; - /** - * Adds a new row to the data source. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param rowIndex row index at which to insert the new row - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - * @param parentRowId Not used in $.ig.DataSource - */ - insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; + /** + * Adds a new row to the data source. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param rowIndex row index at which to insert the new row + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param parentRowId Not used in $.ig.DataSource + */ + insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; - /** - * Deletes a row from the data source. - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - deleteRow(rowId: Object, autoCommit: boolean): Object; + /** + * Deletes a row from the data source. + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + deleteRow(rowId: Object, autoCommit: boolean): Object; - /** - * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back - * - * @param data the transaction data - */ - addNode(data: Object): void; + /** + * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back + * + * @param data the transaction data + */ + addNode(data: Object): void; - /** - * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back - * - * @param data the transaction data - */ - removeNode(data: Object): void; + /** + * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back + * + * @param data the transaction data + */ + removeNode(data: Object): void; - /** - * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source - * - * @param t a transaction object - */ - getDetachedRecord(t: Object): Object; + /** + * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source + * + * @param t a transaction object + */ + getDetachedRecord(t: Object): Object; - /** - * Update the data source with every transaction from the log - * - * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. - */ - commit(id?: number): void; + /** + * Update the data source with every transaction from the log + * + * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. + */ + commit(id?: number): void; - /** - * Clears the transaction log without updating anything in the data source - * - * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. - */ - rollback(id?: Object): void; + /** + * Clears the transaction log without updating anything in the data source + * + * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. + */ + rollback(id?: Object): void; - /** - * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source - */ - pendingTransactions(): any[]; + /** + * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source + */ + pendingTransactions(): any[]; - /** - * Returns a list of all transaction objects that are either pending, or have been committed in the data source. - */ - allTransactions(): any[]; + /** + * Returns a list of all transaction objects that are either pending, or have been committed in the data source. + */ + allTransactions(): any[]; - /** - * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently - */ - transactionsAsString(): string; + /** + * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently + */ + transactionsAsString(): string; - /** - * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params - * - * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) - * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) - */ - saveChanges(success: Function, error: Function): void; + /** + * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params + * + * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) + * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) + */ + saveChanges(success: Function, error: Function): void; - /** - * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView - * 6. fire the databound event - * - * @param callback callback function - * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context - */ - dataBind(callback?: string, callee?: Object): void; + /** + * Data binds to the current data source + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView + * 6. fire the databound event + * + * @param callback callback function + * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context + */ + dataBind(callback?: string, callee?: Object): void; - /** - * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. - * - * @param fieldName the fieldName - name of the field - * @param record the record from which to get it - */ - getCellValue(fieldName: string, record: Object): Object; + /** + * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. + * + * @param fieldName the fieldName - name of the field + * @param record the record from which to get it + */ + getCellValue(fieldName: string, record: Object): Object; - /** - * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * If key or dsObj are not set then returns summaries data. - * Takes summary data from passed argument dsObj(using argument key) - * - * @param key response key to take summary data(for example "Metadata.Summaries") - * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) - */ - summariesResponse(key?: string, dsObj?: Object): Object; + /** + * Applicable only when the data source is bound to remote data. + * Gets or sets summaries data. + * If key or dsObj are not set then returns summaries data. + * Takes summary data from passed argument dsObj(using argument key) + * + * @param key response key to take summary data(for example "Metadata.Summaries") + * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) + */ + summariesResponse(key?: string, dsObj?: Object): Object; - /** - * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. - */ - filteredData(): any[]; + /** + * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. + */ + filteredData(): any[]; - /** - * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * fields => an array of fields object definitions: - * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] - * - * @param fields an array of fields object definitions - * @param direction asc / desc direction - */ - sort(fields: Object, direction: string): void; + /** + * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * fields => an array of fields object definitions: + * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] + * + * @param fields an array of fields object definitions + * @param direction asc / desc direction + */ + sort(fields: Object, direction: string): void; - /** - * This clears local sorting applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalSorting(): void; + /** + * This clears local sorting applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalSorting(): void; - /** - * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain - * if expr is detected to be a regular expression, the "cond" part is skipped - * - * @param fieldExpressions a list of field expression definitions - * @param boolLogic boolean logic. Accepted values are AND and OR. - * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions - * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. - */ - filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; + /** + * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain + * if expr is detected to be a regular expression, the "cond" part is skipped + * + * @param fieldExpressions a list of field expression definitions + * @param boolLogic boolean logic. Accepted values are AND and OR. + * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions + * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. + */ + filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): void; - /** - * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * the actual total number of records may not - * match the number of records that exists on the client - * - * @param count the total number of records - * @param key - * @param dsObj - * @param context - */ - totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; + /** + * Applicable only when the data source is bound to remote data. + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * the actual total number of records may not + * match the number of records that exists on the client + * + * @param count the total number of records + * @param key + * @param dsObj + * @param context + */ + totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; - /** - * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend - * - * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend - */ - hasTotalRecordsCount(hasCount: boolean): void; + /** + * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend + * + * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend + */ + hasTotalRecordsCount(hasCount: boolean): void; - /** - * Returns metadata object for the specified key - * - * @param key Primary key of the record - */ - metadata(key: string): Object; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * Returns the total number of records in the local data source + */ + totalLocalRecordsCount(): number; - /** - * Returns the total number of pages - */ - pageCount(): number; + /** + * Returns the total number of pages + */ + pageCount(): number; - /** - * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. - * - * @param index the page index. If none is specified, returns the current page index. - */ - pageIndex(index?: number): number; + /** + * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. + * + * @param index the page index. If none is specified, returns the current page index. + */ + pageIndex(index?: number): number; - /** - * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. - * - * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. - */ - persistedPageIndex(value?: number): number; + /** + * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. + * + * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. + */ + persistedPageIndex(value?: number): number; - /** - * Sets the page index to be equal to the previous page index and rebinds the data source - */ - prevPage(): void; + /** + * Sets the page index to be equal to the previous page index and rebinds the data source + */ + prevPage(): void; - /** - * Sets the page index to be equal to the next page index and rebinds the data source - */ - nextPage(): void; + /** + * Sets the page index to be equal to the next page index and rebinds the data source + */ + nextPage(): void; - /** - * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size - * - * @param s the page size. - */ - pageSize(s?: number): number; + /** + * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size + * + * @param s the page size. + */ + pageSize(s?: number): number; - /** - * For internal use - * - * @param dirty - */ - pageSizeDirty(dirty: Object): void; + /** + * For internal use + * + * @param dirty + */ + pageSizeDirty(dirty: Object): void; - /** - * Returns a list of records for the specified page. Implies that paging is enabled. - * - * @param p the page index for which records will be returned - */ - recordsForPage(p: number): void; + /** + * Returns a list of records for the specified page. Implies that paging is enabled. + * + * @param p the page index for which records will be returned + */ + recordsForPage(p: number): void; - /** - * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data - * - * @param tableDOM TABLE dom element to transform - */ - tableToObject(tableDOM: Element): Object; + /** + * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data + * + * @param tableDOM TABLE dom element to transform + */ + tableToObject(tableDOM: Element): Object; - /** - * Parses the string and returns an evaluated JSON object - * - * @param s the JSON as string. - */ - stringToJSONObject(s: string): void; + /** + * Parses the string and returns an evaluated JSON object + * + * @param s the JSON as string. + */ + stringToJSONObject(s: string): void; - /** - * Parses a string and returns a XML Document - * - * @param s the XML represented as a string - */ - stringToXmlObject(s: string): void; + /** + * Parses a string and returns a XML Document + * + * @param s the XML represented as a string + */ + stringToXmlObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data - */ - groupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data + */ + groupByData(): any[]; - /** - * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) - */ - visibleGroupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) + */ + visibleGroupByData(): any[]; - /** - * Returns the current normalized/transformed and paged/filtered/sorted group-by data - */ - groupByDataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted group-by data + */ + groupByDataView(): any[]; - /** - * Toggle grouped record with the specified id and updates collections visible groupby data and data view - * - * @param id data-id attribute of the respective group row in the DOM - * @param collapsed if true the record should be collapsed, otherwise expanded - */ - toggleGroupByRecord(id: string, collapsed: boolean): void; + /** + * Toggle grouped record with the specified id and updates collections visible groupby data and data view + * + * @param id data-id attribute of the respective group row in the DOM + * @param collapsed if true the record should be collapsed, otherwise expanded + */ + toggleGroupByRecord(id: string, collapsed: boolean): void; - /** - * Check whether the specified gorupby record is collapsed - * - * @param gbRec id of the grouped record OR grouped record - */ - isGroupByRecordCollapsed(gbRec: Object): boolean; + /** + * Check whether the specified gorupby record is collapsed + * + * @param gbRec id of the grouped record OR grouped record + */ + isGroupByRecordCollapsed(gbRec: Object): boolean; - /** - * Check whether grouping is applied for the specified sorting expressions. - * - * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings - */ - isGroupByApplied(exprs?: any[]): boolean; -} + /** + * Check whether grouping is applied for the specified sorting expressions. + * + * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings + */ + isGroupByApplied(exprs?: any[]): boolean; + } } interface IgniteUIStatic { HtmlTableDataSource: typeof Infragistics.HtmlTableDataSource; } -declare module Infragistics { -export class ArrayDataSource { - constructor(settings: DataSourceSettings); +declare namespace Infragistics { + class ArrayDataSource { + constructor(settings: DataSourceSettings); - /** - * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields - * - * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } - */ - fields(fields?: Object): Object; + /** + * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields + * + * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } + */ + fields(fields?: Object): Object; - /** - * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type - */ - analyzeDataSource(): string; + /** + * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type + */ + analyzeDataSource(): string; - /** - * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView - */ - dataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView + */ + dataView(): any[]; - /** - * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. - */ - data(): Object; + /** + * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. + */ + data(): Object; - /** - * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging - * - * @param transformedExecution - */ - transformedData(transformedExecution: Object): Object; + /** + * Returns transformed data according to transformed execution: + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging + * + * @param transformedExecution + */ + transformedData(transformedExecution: Object): Object; - /** - * Returns summaries data - */ - dataSummaries(): Object; + /** + * Returns summaries data + */ + dataSummaries(): Object; - /** - * Gets/sets the schema definition. - * - * @param s a schema object - * @param t type of the data source. See settings.type - */ - schema(s?: Object, t?: string): void; + /** + * Gets/sets the schema definition. + * + * @param s a schema object + * @param t type of the data source. See settings.type + */ + schema(s?: Object, t?: string): void; - /** - * Gets/sets a list of paging settings - * - * @param p object holding all paging settings. See settings.paging - */ - pagingSettings(p?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @param p object holding all paging settings. See settings.paging + */ + pagingSettings(p?: Object): Object; - /** - * Gets/sets a list of filtering settings - * - * @param f object holding all filtering settings. See settings.filtering - */ - filterSettings(f?: Object): void; + /** + * Gets/sets a list of filtering settings + * + * @param f object holding all filtering settings. See settings.filtering + */ + filterSettings(f?: Object): void; - /** - * Gets/sets a list of paging settings - * - * @param s object holding all sorting settings. See settings.sorting - */ - sortSettings(s?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @param s object holding all sorting settings. See settings.sorting + */ + sortSettings(s?: Object): Object; - /** - * Gets/sets a list of summaries settings. - * - * @param s object holding all summaries settings. See settings.summaries - */ - summariesSettings(s?: Object): void; + /** + * Gets/sets a list of summaries settings. + * + * @param s object holding all summaries settings. See settings.summaries + */ + summariesSettings(s?: Object): void; - /** - * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource - * - * @param ds - */ - dataSource(ds?: Object): Object; + /** + * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource + * + * @param ds + */ + dataSource(ds?: Object): Object; - /** - * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type - * - * @param t - * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty - */ - type(t?: Object): string; + /** + * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type + * + * @param t + * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty + */ + type(t?: Object): string; - /** - * Returns a record by a specified key (requires that primaryKey is set in the settings) - * - * @param key Primary key of the record - * @param ds the data source in which to search for the record. When not set it will use the current data source. - * @param objPath Not used in $.ig.DataSource - */ - findRecordByKey(key: string, ds?: string, objPath?: string): Object; + /** + * Returns a record by a specified key (requires that primaryKey is set in the settings) + * + * @param key Primary key of the record + * @param ds the data source in which to search for the record. When not set it will use the current data source. + * @param objPath Not used in $.ig.DataSource + */ + findRecordByKey(key: string, ds?: string, objPath?: string): Object; - /** - * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source - * - * @param key primary key of the record - * @param origDs - */ - removeRecordByKey(key: Object, origDs: Object): void; + /** + * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source + * + * @param key primary key of the record + * @param origDs + */ + removeRecordByKey(key: Object, origDs: Object): void; - /** - * Removes a record from the data source at specific index. - * - * @param index index of record - * @param origDs - */ - removeRecordByIndex(index: number, origDs: Object): void; + /** + * Removes a record from the data source at specific index. + * + * @param index index of record + * @param origDs + */ + removeRecordByIndex(index: number, origDs: Object): void; - /** - * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it - * - * @param rowId the rowId - row key (string) or index (number) - * @param colId the column id - column key (string) or index (number) - * @param val The new value - * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log - */ - setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; + /** + * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it + * + * @param rowId the rowId - row key (string) or index (number) + * @param colId the column id - column key (string) or index (number) + * @param val The new value + * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log + */ + setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; - /** - * Updates a record in the datasource. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; + /** + * Updates a record in the datasource. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; - /** - * Adds a new row to the data source. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; + /** + * Adds a new row to the data source. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; - /** - * Adds a new row to the data source. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param rowIndex row index at which to insert the new row - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - * @param parentRowId Not used in $.ig.DataSource - */ - insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; + /** + * Adds a new row to the data source. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param rowIndex row index at which to insert the new row + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param parentRowId Not used in $.ig.DataSource + */ + insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; - /** - * Deletes a row from the data source. - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - deleteRow(rowId: Object, autoCommit: boolean): Object; + /** + * Deletes a row from the data source. + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + deleteRow(rowId: Object, autoCommit: boolean): Object; - /** - * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back - * - * @param data the transaction data - */ - addNode(data: Object): void; + /** + * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back + * + * @param data the transaction data + */ + addNode(data: Object): void; - /** - * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back - * - * @param data the transaction data - */ - removeNode(data: Object): void; + /** + * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back + * + * @param data the transaction data + */ + removeNode(data: Object): void; - /** - * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source - * - * @param t a transaction object - */ - getDetachedRecord(t: Object): Object; + /** + * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source + * + * @param t a transaction object + */ + getDetachedRecord(t: Object): Object; - /** - * Update the data source with every transaction from the log - * - * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. - */ - commit(id?: number): void; + /** + * Update the data source with every transaction from the log + * + * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. + */ + commit(id?: number): void; - /** - * Clears the transaction log without updating anything in the data source - * - * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. - */ - rollback(id?: Object): void; + /** + * Clears the transaction log without updating anything in the data source + * + * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. + */ + rollback(id?: Object): void; - /** - * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source - */ - pendingTransactions(): any[]; + /** + * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source + */ + pendingTransactions(): any[]; - /** - * Returns a list of all transaction objects that are either pending, or have been committed in the data source. - */ - allTransactions(): any[]; + /** + * Returns a list of all transaction objects that are either pending, or have been committed in the data source. + */ + allTransactions(): any[]; - /** - * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently - */ - transactionsAsString(): string; + /** + * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently + */ + transactionsAsString(): string; - /** - * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params - * - * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) - * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) - */ - saveChanges(success: Function, error: Function): void; + /** + * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params + * + * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) + * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) + */ + saveChanges(success: Function, error: Function): void; - /** - * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView - * 6. fire the databound event - * - * @param callback callback function - * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context - */ - dataBind(callback?: string, callee?: Object): void; + /** + * Data binds to the current data source + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object tree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView + * 6. fire the databound event + * + * @param callback callback function + * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context + */ + dataBind(callback?: string, callee?: Object): void; - /** - * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. - * - * @param fieldName the fieldName - name of the field - * @param record the record from which to get it - */ - getCellValue(fieldName: string, record: Object): Object; + /** + * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. + * + * @param fieldName the fieldName - name of the field + * @param record the record from which to get it + */ + getCellValue(fieldName: string, record: Object): Object; - /** - * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * If key or dsObj are not set then returns summaries data. - * Takes summary data from passed argument dsObj(using argument key) - * - * @param key response key to take summary data(for example "Metadata.Summaries") - * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) - */ - summariesResponse(key?: string, dsObj?: Object): Object; + /** + * Applicable only when the data source is bound to remote data. + * Gets or sets summaries data. + * If key or dsObj are not set then returns summaries data. + * Takes summary data from passed argument dsObj(using argument key) + * + * @param key response key to take summary data(for example "Metadata.Summaries") + * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) + */ + summariesResponse(key?: string, dsObj?: Object): Object; - /** - * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. - */ - filteredData(): any[]; + /** + * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. + */ + filteredData(): any[]; - /** - * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * fields => an array of fields object definitions: - * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] - * - * @param fields an array of fields object definitions - * @param direction asc / desc direction - */ - sort(fields: Object, direction: string): void; + /** + * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * fields => an array of fields object definitions: + * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] + * + * @param fields an array of fields object definitions + * @param direction asc / desc direction + */ + sort(fields: Object, direction: string): void; - /** - * This clears local sorting applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalSorting(): void; + /** + * This clears local sorting applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalSorting(): void; - /** - * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain - * if expr is detected to be a regular expression, the "cond" part is skipped - * - * @param fieldExpressions a list of field expression definitions - * @param boolLogic boolean logic. Accepted values are AND and OR. - * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions - * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. - */ - filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; + /** + * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain + * if expr is detected to be a regular expression, the "cond" part is skipped + * + * @param fieldExpressions a list of field expression definitions + * @param boolLogic boolean logic. Accepted values are AND and OR. + * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions + * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. + */ + filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): void; - /** - * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * the actual total number of records may not - * match the number of records that exists on the client - * - * @param count the total number of records - * @param key - * @param dsObj - * @param context - */ - totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; + /** + * Applicable only when the data source is bound to remote data. + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * the actual total number of records may not + * match the number of records that exists on the client + * + * @param count the total number of records + * @param key + * @param dsObj + * @param context + */ + totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; - /** - * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend - * - * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend - */ - hasTotalRecordsCount(hasCount: boolean): void; + /** + * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend + * + * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend + */ + hasTotalRecordsCount(hasCount: boolean): void; - /** - * Returns metadata object for the specified key - * - * @param key Primary key of the record - */ - metadata(key: string): Object; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * Returns the total number of records in the local data source + */ + totalLocalRecordsCount(): number; - /** - * Returns the total number of pages - */ - pageCount(): number; + /** + * Returns the total number of pages + */ + pageCount(): number; - /** - * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. - * - * @param index the page index. If none is specified, returns the current page index. - */ - pageIndex(index?: number): number; + /** + * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. + * + * @param index the page index. If none is specified, returns the current page index. + */ + pageIndex(index?: number): number; - /** - * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. - * - * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. - */ - persistedPageIndex(value?: number): number; + /** + * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. + * + * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. + */ + persistedPageIndex(value?: number): number; - /** - * Sets the page index to be equal to the previous page index and rebinds the data source - */ - prevPage(): void; + /** + * Sets the page index to be equal to the previous page index and rebinds the data source + */ + prevPage(): void; - /** - * Sets the page index to be equal to the next page index and rebinds the data source - */ - nextPage(): void; + /** + * Sets the page index to be equal to the next page index and rebinds the data source + */ + nextPage(): void; - /** - * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size - * - * @param s the page size. - */ - pageSize(s?: number): number; + /** + * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size + * + * @param s the page size. + */ + pageSize(s?: number): number; - /** - * For internal use - * - * @param dirty - */ - pageSizeDirty(dirty: Object): void; + /** + * For internal use + * + * @param dirty + */ + pageSizeDirty(dirty: Object): void; - /** - * Returns a list of records for the specified page. Implies that paging is enabled. - * - * @param p the page index for which records will be returned - */ - recordsForPage(p: number): void; + /** + * Returns a list of records for the specified page. Implies that paging is enabled. + * + * @param p the page index for which records will be returned + */ + recordsForPage(p: number): void; - /** - * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data - * - * @param tableDOM TABLE dom element to transform - */ - tableToObject(tableDOM: Element): Object; + /** + * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data + * + * @param tableDOM TABLE dom element to transform + */ + tableToObject(tableDOM: Element): Object; - /** - * Parses the string and returns an evaluated JSON object - * - * @param s the JSON as string. - */ - stringToJSONObject(s: string): void; + /** + * Parses the string and returns an evaluated JSON object + * + * @param s the JSON as string. + */ + stringToJSONObject(s: string): void; - /** - * Parses a string and returns a XML Document - * - * @param s the XML represented as a string - */ - stringToXmlObject(s: string): void; + /** + * Parses a string and returns a XML Document + * + * @param s the XML represented as a string + */ + stringToXmlObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data - */ - groupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data + */ + groupByData(): any[]; - /** - * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) - */ - visibleGroupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) + */ + visibleGroupByData(): any[]; - /** - * Returns the current normalized/transformed and paged/filtered/sorted group-by data - */ - groupByDataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted group-by data + */ + groupByDataView(): any[]; - /** - * Toggle grouped record with the specified id and updates collections visible groupby data and data view - * - * @param id data-id attribute of the respective group row in the DOM - * @param collapsed if true the record should be collapsed, otherwise expanded - */ - toggleGroupByRecord(id: string, collapsed: boolean): void; + /** + * Toggle grouped record with the specified id and updates collections visible groupby data and data view + * + * @param id data-id attribute of the respective group row in the DOM + * @param collapsed if true the record should be collapsed, otherwise expanded + */ + toggleGroupByRecord(id: string, collapsed: boolean): void; - /** - * Check whether the specified gorupby record is collapsed - * - * @param gbRec id of the grouped record OR grouped record - */ - isGroupByRecordCollapsed(gbRec: Object): boolean; + /** + * Check whether the specified gorupby record is collapsed + * + * @param gbRec id of the grouped record OR grouped record + */ + isGroupByRecordCollapsed(gbRec: Object): boolean; - /** - * Check whether grouping is applied for the specified sorting expressions. - * - * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings - */ - isGroupByApplied(exprs?: any[]): boolean; -} + /** + * Check whether grouping is applied for the specified sorting expressions. + * + * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings + */ + isGroupByApplied(exprs?: any[]): boolean; + } } interface IgniteUIStatic { ArrayDataSource: typeof Infragistics.ArrayDataSource; } interface MashupDataSourceMashupSettings { - /** * Indicates whether to ignore records that have no corresponding data in all of the provided data sources. */ @@ -4883,445 +4868,444 @@ interface MashupDataSourceMashupSettings { [optionName: string]: any; } -declare module Infragistics { -export class MashupDataSource { - constructor(mashupSettings: MashupDataSourceMashupSettings); - constructor(settings: DataSourceSettings); +declare namespace Infragistics { + class MashupDataSource { + constructor(mashupSettings: MashupDataSourceMashupSettings); + constructor(settings: DataSourceSettings); - /** - * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it - * - * @param rowId the rowId - row key (string) or index (number) - * @param colId the column id - column key (string) or index (number) - * @param val The new value - * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log - */ - setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; + /** + * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it + * + * @param rowId the rowId - row key (string) or index (number) + * @param colId the column id - column key (string) or index (number) + * @param val The new value + * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log + */ + setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; - /** - * Updates a record in the datasource. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; + /** + * Updates a record in the datasource. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; - /** - * Adds a new row to the data source. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; + /** + * Adds a new row to the data source. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; - /** - * Adds a new row to the data source. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param rowIndex row index at which to insert the new row - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - * @param parentRowId Not used in $.ig.DataSource - */ - insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; + /** + * Adds a new row to the data source. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param rowIndex row index at which to insert the new row + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param parentRowId Not used in $.ig.DataSource + */ + insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; - /** - * Data binds to the current data source. - */ - dataBind(): void; + /** + * Data binds to the current data source. + */ + dataBind(): void; - /** - * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields - * - * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } - */ - fields(fields?: Object): Object; + /** + * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields + * + * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } + */ + fields(fields?: Object): Object; - /** - * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type - */ - analyzeDataSource(): string; + /** + * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type + */ + analyzeDataSource(): string; - /** - * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView - */ - dataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView + */ + dataView(): any[]; - /** - * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. - */ - data(): Object; + /** + * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. + */ + data(): Object; - /** - * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging - * - * @param transformedExecution - */ - transformedData(transformedExecution: Object): Object; + /** + * Returns transformed data according to transformed execution: + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging + * + * @param transformedExecution + */ + transformedData(transformedExecution: Object): Object; - /** - * Returns summaries data - */ - dataSummaries(): Object; + /** + * Returns summaries data + */ + dataSummaries(): Object; - /** - * Gets/sets the schema definition. - * - * @param s a schema object - * @param t type of the data source. See settings.type - */ - schema(s?: Object, t?: string): void; + /** + * Gets/sets the schema definition. + * + * @param s a schema object + * @param t type of the data source. See settings.type + */ + schema(s?: Object, t?: string): void; - /** - * Gets/sets a list of paging settings - * - * @param p object holding all paging settings. See settings.paging - */ - pagingSettings(p?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @param p object holding all paging settings. See settings.paging + */ + pagingSettings(p?: Object): Object; - /** - * Gets/sets a list of filtering settings - * - * @param f object holding all filtering settings. See settings.filtering - */ - filterSettings(f?: Object): void; + /** + * Gets/sets a list of filtering settings + * + * @param f object holding all filtering settings. See settings.filtering + */ + filterSettings(f?: Object): void; - /** - * Gets/sets a list of paging settings - * - * @param s object holding all sorting settings. See settings.sorting - */ - sortSettings(s?: Object): Object; + /** + * Gets/sets a list of paging settings + * + * @param s object holding all sorting settings. See settings.sorting + */ + sortSettings(s?: Object): Object; - /** - * Gets/sets a list of summaries settings. - * - * @param s object holding all summaries settings. See settings.summaries - */ - summariesSettings(s?: Object): void; + /** + * Gets/sets a list of summaries settings. + * + * @param s object holding all summaries settings. See settings.summaries + */ + summariesSettings(s?: Object): void; - /** - * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource - * - * @param ds - */ - dataSource(ds?: Object): Object; + /** + * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource + * + * @param ds + */ + dataSource(ds?: Object): Object; - /** - * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type - * - * @param t - * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty - */ - type(t?: Object): string; + /** + * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type + * + * @param t + * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty + */ + type(t?: Object): string; - /** - * Returns a record by a specified key (requires that primaryKey is set in the settings) - * - * @param key Primary key of the record - * @param ds the data source in which to search for the record. When not set it will use the current data source. - * @param objPath Not used in $.ig.DataSource - */ - findRecordByKey(key: string, ds?: string, objPath?: string): Object; + /** + * Returns a record by a specified key (requires that primaryKey is set in the settings) + * + * @param key Primary key of the record + * @param ds the data source in which to search for the record. When not set it will use the current data source. + * @param objPath Not used in $.ig.DataSource + */ + findRecordByKey(key: string, ds?: string, objPath?: string): Object; - /** - * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source - * - * @param key primary key of the record - * @param origDs - */ - removeRecordByKey(key: Object, origDs: Object): void; + /** + * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source + * + * @param key primary key of the record + * @param origDs + */ + removeRecordByKey(key: Object, origDs: Object): void; - /** - * Removes a record from the data source at specific index. - * - * @param index index of record - * @param origDs - */ - removeRecordByIndex(index: number, origDs: Object): void; + /** + * Removes a record from the data source at specific index. + * + * @param index index of record + * @param origDs + */ + removeRecordByIndex(index: number, origDs: Object): void; - /** - * Deletes a row from the data source. - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - deleteRow(rowId: Object, autoCommit: boolean): Object; + /** + * Deletes a row from the data source. + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + deleteRow(rowId: Object, autoCommit: boolean): Object; - /** - * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back - * - * @param data the transaction data - */ - addNode(data: Object): void; + /** + * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back + * + * @param data the transaction data + */ + addNode(data: Object): void; - /** - * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back - * - * @param data the transaction data - */ - removeNode(data: Object): void; + /** + * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back + * + * @param data the transaction data + */ + removeNode(data: Object): void; - /** - * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source - * - * @param t a transaction object - */ - getDetachedRecord(t: Object): Object; + /** + * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source + * + * @param t a transaction object + */ + getDetachedRecord(t: Object): Object; - /** - * Update the data source with every transaction from the log - * - * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. - */ - commit(id?: number): void; + /** + * Update the data source with every transaction from the log + * + * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. + */ + commit(id?: number): void; - /** - * Clears the transaction log without updating anything in the data source - * - * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. - */ - rollback(id?: Object): void; + /** + * Clears the transaction log without updating anything in the data source + * + * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. + */ + rollback(id?: Object): void; - /** - * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source - */ - pendingTransactions(): any[]; + /** + * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source + */ + pendingTransactions(): any[]; - /** - * Returns a list of all transaction objects that are either pending, or have been committed in the data source. - */ - allTransactions(): any[]; + /** + * Returns a list of all transaction objects that are either pending, or have been committed in the data source. + */ + allTransactions(): any[]; - /** - * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently - */ - transactionsAsString(): string; + /** + * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently + */ + transactionsAsString(): string; - /** - * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params - * - * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) - * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) - */ - saveChanges(success: Function, error: Function): void; + /** + * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params + * + * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) + * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) + */ + saveChanges(success: Function, error: Function): void; - /** - * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. - * - * @param fieldName the fieldName - name of the field - * @param record the record from which to get it - */ - getCellValue(fieldName: string, record: Object): Object; + /** + * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. + * + * @param fieldName the fieldName - name of the field + * @param record the record from which to get it + */ + getCellValue(fieldName: string, record: Object): Object; - /** - * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * If key or dsObj are not set then returns summaries data. - * Takes summary data from passed argument dsObj(using argument key) - * - * @param key response key to take summary data(for example "Metadata.Summaries") - * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) - */ - summariesResponse(key?: string, dsObj?: Object): Object; + /** + * Applicable only when the data source is bound to remote data. + * Gets or sets summaries data. + * If key or dsObj are not set then returns summaries data. + * Takes summary data from passed argument dsObj(using argument key) + * + * @param key response key to take summary data(for example "Metadata.Summaries") + * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) + */ + summariesResponse(key?: string, dsObj?: Object): Object; - /** - * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. - */ - filteredData(): any[]; + /** + * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. + */ + filteredData(): any[]; - /** - * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * fields => an array of fields object definitions: - * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] - * - * @param fields an array of fields object definitions - * @param direction asc / desc direction - */ - sort(fields: Object, direction: string): void; + /** + * Sorts the data source locally. The result (filtered data) can be obtained by calling dataView(). + * Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * fields => an array of fields object definitions: + * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] + * + * @param fields an array of fields object definitions + * @param direction asc / desc direction + */ + sort(fields: Object, direction: string): void; - /** - * This clears local sorting applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalSorting(): void; + /** + * This clears local sorting applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalSorting(): void; - /** - * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and - * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain - * if expr is detected to be a regular expression, the "cond" part is skipped - * - * @param fieldExpressions a list of field expression definitions - * @param boolLogic boolean logic. Accepted values are AND and OR. - * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions - * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. - */ - filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; + /** + * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and + * setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain + * if expr is detected to be a regular expression, the "cond" part is skipped + * + * @param fieldExpressions a list of field expression definitions + * @param boolLogic boolean logic. Accepted values are AND and OR. + * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions + * @param fieldExpressionsOnStrings a list of field expression definitions (or a string with the conditions separated by AND/OR operator, example: "ID = 1 OR ID = 2"), which when applied will threat the related field as if it's string and can only apply conditions valid for string types. + */ + filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalFilter(): void; + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalFilter(): void; - /** - * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * the actual total number of records may not - * match the number of records that exists on the client - * - * @param count the total number of records - * @param key - * @param dsObj - * @param context - */ - totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; + /** + * Applicable only when the data source is bound to remote data. + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * the actual total number of records may not + * match the number of records that exists on the client + * + * @param count the total number of records + * @param key + * @param dsObj + * @param context + */ + totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; - /** - * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend - * - * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend - */ - hasTotalRecordsCount(hasCount: boolean): void; + /** + * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend + * + * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend + */ + hasTotalRecordsCount(hasCount: boolean): void; - /** - * Returns metadata object for the specified key - * - * @param key Primary key of the record - */ - metadata(key: string): Object; + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; + /** + * Returns the total number of records in the local data source + */ + totalLocalRecordsCount(): number; - /** - * Returns the total number of pages - */ - pageCount(): number; + /** + * Returns the total number of pages + */ + pageCount(): number; - /** - * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. - * - * @param index the page index. If none is specified, returns the current page index. - */ - pageIndex(index?: number): number; + /** + * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. + * + * @param index the page index. If none is specified, returns the current page index. + */ + pageIndex(index?: number): number; - /** - * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. - * - * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. - */ - persistedPageIndex(value?: number): number; + /** + * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. + * + * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. + */ + persistedPageIndex(value?: number): number; - /** - * Sets the page index to be equal to the previous page index and rebinds the data source - */ - prevPage(): void; + /** + * Sets the page index to be equal to the previous page index and rebinds the data source + */ + prevPage(): void; - /** - * Sets the page index to be equal to the next page index and rebinds the data source - */ - nextPage(): void; + /** + * Sets the page index to be equal to the next page index and rebinds the data source + */ + nextPage(): void; - /** - * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size - * - * @param s the page size. - */ - pageSize(s?: number): number; + /** + * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size + * + * @param s the page size. + */ + pageSize(s?: number): number; - /** - * For internal use - * - * @param dirty - */ - pageSizeDirty(dirty: Object): void; + /** + * For internal use + * + * @param dirty + */ + pageSizeDirty(dirty: Object): void; - /** - * Returns a list of records for the specified page. Implies that paging is enabled. - * - * @param p the page index for which records will be returned - */ - recordsForPage(p: number): void; + /** + * Returns a list of records for the specified page. Implies that paging is enabled. + * + * @param p the page index for which records will be returned + */ + recordsForPage(p: number): void; - /** - * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data - * - * @param tableDOM TABLE dom element to transform - */ - tableToObject(tableDOM: Element): Object; + /** + * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data + * + * @param tableDOM TABLE dom element to transform + */ + tableToObject(tableDOM: Element): Object; - /** - * Parses the string and returns an evaluated JSON object - * - * @param s the JSON as string. - */ - stringToJSONObject(s: string): void; + /** + * Parses the string and returns an evaluated JSON object + * + * @param s the JSON as string. + */ + stringToJSONObject(s: string): void; - /** - * Parses a string and returns a XML Document - * - * @param s the XML represented as a string - */ - stringToXmlObject(s: string): void; + /** + * Parses a string and returns a XML Document + * + * @param s the XML represented as a string + */ + stringToXmlObject(s: string): void; - /** - * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data - */ - groupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data + */ + groupByData(): any[]; - /** - * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) - */ - visibleGroupByData(): any[]; + /** + * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) + */ + visibleGroupByData(): any[]; - /** - * Returns the current normalized/transformed and paged/filtered/sorted group-by data - */ - groupByDataView(): any[]; + /** + * Returns the current normalized/transformed and paged/filtered/sorted group-by data + */ + groupByDataView(): any[]; - /** - * Toggle grouped record with the specified id and updates collections visible groupby data and data view - * - * @param id data-id attribute of the respective group row in the DOM - * @param collapsed if true the record should be collapsed, otherwise expanded - */ - toggleGroupByRecord(id: string, collapsed: boolean): void; + /** + * Toggle grouped record with the specified id and updates collections visible groupby data and data view + * + * @param id data-id attribute of the respective group row in the DOM + * @param collapsed if true the record should be collapsed, otherwise expanded + */ + toggleGroupByRecord(id: string, collapsed: boolean): void; - /** - * Check whether the specified gorupby record is collapsed - * - * @param gbRec id of the grouped record OR grouped record - */ - isGroupByRecordCollapsed(gbRec: Object): boolean; + /** + * Check whether the specified gorupby record is collapsed + * + * @param gbRec id of the grouped record OR grouped record + */ + isGroupByRecordCollapsed(gbRec: Object): boolean; - /** - * Check whether grouping is applied for the specified sorting expressions. - * - * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings - */ - isGroupByApplied(exprs?: any[]): boolean; -} + /** + * Check whether grouping is applied for the specified sorting expressions. + * + * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings + */ + isGroupByApplied(exprs?: any[]): boolean; + } } interface IgniteUIStatic { MashupDataSource: typeof Infragistics.MashupDataSource; } interface HierarchicalDataSourceSettingsPaging { - /** * Option for HierarchicalDataSourceSettingsPaging */ @@ -5329,7 +5313,6 @@ interface HierarchicalDataSourceSettingsPaging { } interface HierarchicalDataSourceSettingsSorting { - /** * Option for HierarchicalDataSourceSettingsSorting */ @@ -5337,7 +5320,6 @@ interface HierarchicalDataSourceSettingsSorting { } interface HierarchicalDataSourceSettingsFiltering { - /** * Option for HierarchicalDataSourceSettingsFiltering */ @@ -5345,7 +5327,6 @@ interface HierarchicalDataSourceSettingsFiltering { } interface HierarchicalDataSourceSettingsSchema { - /** * Option for HierarchicalDataSourceSettingsSchema */ @@ -5391,20 +5372,19 @@ interface HierarchicalDataSourceSettings { [optionName: string]: any; } -declare module Infragistics { -export class HierarchicalDataSource { - constructor(settings: HierarchicalDataSourceSettings); - dataBind(callback: Object, callee: Object): void; - root(): void; - dataAt(path: Object, keyspath: Object): void; -} +declare namespace Infragistics { + class HierarchicalDataSource { + constructor(settings: HierarchicalDataSourceSettings); + dataBind(callback: Object, callee: Object): void; + root(): void; + dataAt(path: Object, keyspath: Object): void; + } } interface IgniteUIStatic { HierarchicalDataSource: typeof Infragistics.HierarchicalDataSource; } interface TreeHierarchicalDataSourceSettingsTreeDSFiltering { - /** * Specifies from which data bound level to be applied filtering - 0 is the first level */ @@ -5432,7 +5412,6 @@ interface TreeHierarchicalDataSourceSettingsTreeDSFiltering { } interface TreeHierarchicalDataSourceSettingsTreeDSSorting { - /** * Specifies from which data bound level to be applied sorting - 0 is the first level */ @@ -5450,7 +5429,6 @@ interface TreeHierarchicalDataSourceSettingsTreeDSSorting { } interface TreeHierarchicalDataSourceSettingsTreeDSPaging { - /** * Sets gets paging mode. * @@ -5477,7 +5455,6 @@ interface TreeHierarchicalDataSourceSettingsTreeDSPaging { } interface TreeHierarchicalDataSourceSettingsTreeDS { - /** * Property name of the array of child data in a hierarchical data source. */ @@ -5568,7 +5545,6 @@ interface TreeHierarchicalDataSourceSettingsTreeDS { } interface TreeHierarchicalDataSourceSettings { - /** * Configure tree datasource specific settings */ @@ -5580,644 +5556,644 @@ interface TreeHierarchicalDataSourceSettings { [optionName: string]: any; } -declare module Infragistics { -export class TreeHierarchicalDataSource { - constructor(settings: TreeHierarchicalDataSourceSettings); - - /** - * Data binds to the current data source - * databinding works using the following workflow: - * 1. fire the databinding event - * 2. based on the data source type (see analyzeDataSource()), do the following: - * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. - * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting - * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. - * if no paging/sorting/filtering are enabled, use just this._data to save space - * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL - * if the data source is invalid, throw an exception - * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if - * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object ree - * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion - * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView - * 6. fire the databound event - * - * @param callback callback function - * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context - */ - dataBind(callback?: string, callee?: Object): void; - - /** - * Gets the passed record's parent records - * - * @param dataRow the child record. - * @param ds the data source in which to search for the related parent records. - */ - getParentRowsForRow(dataRow: Object, ds?: Object): Object; - - /** - * Gets the current data bound depth of the tree grid hierarchy. - */ - getDataBoundDepth(): void; - - /** - * Gets/Sets whether the data source has been transformed from flat to hierarchical - * - * @param isTransformed Determines if the data source is marked as transformed or not. - */ - isTransformedToHierarchicalData(isTransformed?: boolean): void; - - /** - * Transforms flat data to hierararchical data and returns the result - * - * @param data The flat data that will be transformed to hierarchical - */ - transformToHierarchicalData(data: Object): Object; - - /** - * This processes the passed data for the specified level and applies the schema transformation to it. - * - * @param data The data to be processed and transformed - * @param level The level to which the data belongs to. If this is not set it defaults to 0. - * @param suppressTransformation Determines whether the data should go through schema transformation. If true schema transofrmatin will not be applied. - */ - processDataPerLevel(data: Object, level?: number, suppressTransformation?: boolean): Object; - - /** - * Returnschild data transformed to flat data - * - * @param record The data record whose data is transformed and returned as flat - * @param level The level. If not set defaults to 0. - */ - getFlatDataForRecord(record: Object, level?: number): Object; - - /** - * Generates flat data. - * Returns an object that contains the generated flat data, the flat visible data, records count and visible records count. - * - * @param data The data record whose data is transformed. - * @param level The level from which to start recursively generating the flat data. If not set defaults to 0. - */ - generateFlatData(data: Object, level?: number): Object; - - /** - * Generates a flat data view from the current (hierarchical)data - */ - generateFlatDataView(): void; - - /** - * Returns the current flat data view - */ - flatDataView(): Object; - - /** - * Returns flat visible data. - */ - getVisibleFlatData(): Object; - - /** - * Returns flat data(without taking into account visible/expansion state). - */ - getFlatData(): Object; - - /** - * Returns total records count(without taking into account visible/expansion state). - */ - getFlatDataCount(): number; - - /** - * Sets the expanded/collapsed state of a row by its index - * - * @param index The index of the row. - * @param expanded If true then the row will be expanded. Otherwise it will be collapsed. - * @param callbackArgs Specifies a custom function to be called when the state of the row is changed. - */ - setExpandedStateByRowIndex(index: number, expanded: boolean, callbackArgs: Function): void; - - /** - * Sets the expanded state of a row by its primary key - * - * @param rowId The id of the row. - * @param expanded If true the row will be expanded. Otherwise it will be collapsed. - * @param callbackArgs Specifies a custom function to be called when the state of the row is changed. - */ - setExpandedStateByPrimaryKey(rowId: string, expanded: boolean, callbackArgs: Function): void; - - /** - * Gets whether the row with the specified id is expanded.Returns true if the row is expanded or false if it's not. - * - * @param rowId //The id of the row. - */ - getExpandStateById(rowId: string): boolean; - - /** - * Toggles the row's state by the row's id. - * - * @param rowId The id of the row. - * @param callbackArgs Specifies a custom function to be called when the state of the row is changed. - */ - toggleRow(rowId: string, callbackArgs: Function): void; - - /** - * Sorts the data source locally. The result (sorted data) can be obtained by calling dataView(). - * Remote filtering can be performed by just calling dataBind() and setting the settings.sorting.expressions - * multi-column sorting can be enabled by setting keepSortState to true. - * fields => an array of fields object definitions: - * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] - * - * @param fields an array of fields object definitions - * @param direction asc / desc direction - */ - sort(fields: Object, direction: string): void; - - /** - * Sorts the given data recursively - * fields => an array of fields object definitions: - * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] - * - * @param data the data array that will be sorted. - * @param level the level to which the data belongs to - * @param fields an array of fields object definitions - * @param direction asc / desc direction - */ - sortDataRecursive(data: Object, level: number, fields: Object, direction: string): void; - - /** - * Sorts the passed data and returns the sorted result. - * - * @param data the data to be sorted - - fields => an array of fields object definitions: - example: [{fieldName : "firstName"}, {fieldName : "lastName"}] - example 2: [{fieldIndex : 1} , {fieldIndex : 2}] - - * @param fields an array of fields object definitions - * @param direction asc / desc direction - */ - sortData(data: Object, fields: Object, direction: string): void; - - /** - * Returns the total number of records in the local data source - */ - totalLocalRecordsCount(): number; - - /** - * Returns the total number of pages - */ - pageCount(): number; - - /** - * Returns the total number of match filtering records in the data source. - * When the dataSource is remote and filtering is applied then it is taken value - * of property "filtering.countRecords" in metatadata - if set. If it is not set returns totalRecordsCount - */ - getFilteringMatchRecordsCount(): number; - - /** - * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() - * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] - * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] - * expr is the filter expression text , such as "abc", or a regular expression such as *test* - * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain - * if expr is detected to be a regular expression, the "cond" part is skipped - * - * @param fieldExpressions a list of field expression definitions - * @param boolLogic boolean logic. Accepted values are AND and OR. - * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions - * @param fieldExpressionsOnStrings - */ - filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; - - /** - * Gets the count of the filtered records in the dataView - */ - getFilteredRecordsCountFromDataView(): number; - - /** - * Gets the count of the filtered records - */ - getFilteredRecordsCount(): number; - - /** - * This clears local filtering applied to the data view by resetting it to the original data and applying any paging. - */ - clearLocalFilter(): void; - - /** - * Gets whether the flat data view should be generated by calling the generateFlatDataView method. - */ - shouldCallGenerateFlatDataView(): void; - - /** - * Clears __matchFiltering property from the data record objects in the filtered data source. The __matchFiltering property determines whether a record matches the specified filtering condition. - * - * @param data the array of data objects to be cleared. If not set the current filtered data array is used. - */ - clearMatchFiltering(data?: Object): void; - - /** - * Gets the path of a record by the record or the record's key - * - * @param record the record or the record's key as string or number - */ - getPathBy(record: Object): void; - - /** - * Returns a record by a specified key (requires that primaryKey is set in the settings) - * - * @param key Primary key of the record - * @param ds the data source in which to search for the record. When not set it will use the current data source. - * @param objPath path to the object. Example: {path: '5/1'} - */ - findRecordByKey(key: Object, ds?: string, objPath?: Object): Object; - - /** - * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source - * - * @param key primary key of the record - * @param origDs - */ - removeRecordByKey(key: Object, origDs: Object): void; - - /** - * Deletes a row from the data source. - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - deleteRow(rowId: Object, autoCommit: boolean): Object; - - /** - * Gets the chilren records by the parent record's key in the passed data source - * - * @param key primary key of the record - * @param ds the data source - */ - getChildrenByKey(key: Object, ds: Object): Object; - - /** - * Adds a new row to the data source. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param rowIndex row index at which to be insert the new row - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - * @param parentRowId the value of the primary key of the parent row(if any) - */ - insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; - - /** - * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields - * - * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } - */ - fields(fields?: Object): Object; - - /** - * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type - */ - analyzeDataSource(): string; - - /** - * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView - */ - dataView(): any[]; - - /** - * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. - */ - data(): Object; - - /** - * Returns transformed data according to transformed execution: - * 1. Before paging and filtering - * 2. After filtering before paging - * 3. After filtering and paging - * - * @param transformedExecution - */ - transformedData(transformedExecution: Object): Object; - - /** - * Returns summaries data - */ - dataSummaries(): Object; - - /** - * Gets/sets the schema definition. - * - * @param s a schema object - * @param t type of the data source. See settings.type - */ - schema(s?: Object, t?: string): void; - - /** - * Gets/sets a list of paging settings - * - * @param p object holding all paging settings. See settings.paging - */ - pagingSettings(p?: Object): Object; - - /** - * Gets/sets a list of filtering settings - * - * @param f object holding all filtering settings. See settings.filtering - */ - filterSettings(f?: Object): void; - - /** - * Gets/sets a list of paging settings - * - * @param s object holding all sorting settings. See settings.sorting - */ - sortSettings(s?: Object): Object; - - /** - * Gets/sets a list of summaries settings. - * - * @param s object holding all summaries settings. See settings.summaries - */ - summariesSettings(s?: Object): void; - - /** - * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource - * - * @param ds - */ - dataSource(ds?: Object): Object; - - /** - * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type - * - * @param t - * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty - */ - type(t?: Object): string; - - /** - * Removes a record from the data source at specific index. - * - * @param index index of record - * @param origDs - */ - removeRecordByIndex(index: number, origDs: Object): void; - - /** - * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it - * - * @param rowId the rowId - row key (string) or index (number) - * @param colId the column id - column key (string) or index (number) - * @param val The new value - * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log - */ - setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; - - /** - * Updates a record in the datasource. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; - - /** - * Adds a new row to the data source. Creates a transaction that can be committed / rolled back - * - * @param rowId the record key - primaryKey (string) or index (number) - * @param rowObject the new record data. - * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log - */ - addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; - - /** - * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back - * - * @param data the transaction data - */ - addNode(data: Object): void; - - /** - * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back - * - * @param data the transaction data - */ - removeNode(data: Object): void; - - /** - * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source - * - * @param t a transaction object - */ - getDetachedRecord(t: Object): Object; - - /** - * Update the data source with every transaction from the log - * - * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. - */ - commit(id?: number): void; - - /** - * Clears the transaction log without updating anything in the data source - * - * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. - */ - rollback(id?: Object): void; - - /** - * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source - */ - pendingTransactions(): any[]; - - /** - * Returns a list of all transaction objects that are either pending, or have been committed in the data source. - */ - allTransactions(): any[]; - - /** - * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently - */ - transactionsAsString(): string; - - /** - * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params - * - * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) - * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) - */ - saveChanges(success: Function, error: Function): void; - - /** - * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. - * - * @param fieldName the fieldName - name of the field - * @param record the record from which to get it - */ - getCellValue(fieldName: string, record: Object): Object; - - /** - * Applicable only when the data source is bound to remote data. - * Gets or sets summaries data. - * If key or dsObj are not set then returns summaries data. - * Takes summary data from passed argument dsObj(using argument key) - * - * @param key response key to take summary data(for example "Metadata.Summaries") - * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) - */ - summariesResponse(key?: string, dsObj?: Object): Object; - - /** - * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. - */ - filteredData(): any[]; - - /** - * This clears local sorting applied to the data view by resetting it to the original data and applying any paging - */ - clearLocalSorting(): void; - - /** - * Applicable only when the data source is bound to remote data. - * Gets / sets the total number of records in the data source. - * If data binding is remote, and there's paging or filtering enabled, - * the actual total number of records may not - * match the number of records that exists on the client - * - * @param count the total number of records - * @param key - * @param dsObj - * @param context - */ - totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; - - /** - * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend - * - * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend - */ - hasTotalRecordsCount(hasCount: boolean): void; - - /** - * Returns metadata object for the specified key - * - * @param key Primary key of the record - */ - metadata(key: string): Object; - - /** - * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. - * - * @param index the page index. If none is specified, returns the current page index. - */ - pageIndex(index?: number): number; - - /** - * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. - * - * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. - */ - persistedPageIndex(value?: number): number; - - /** - * Sets the page index to be equal to the previous page index and rebinds the data source - */ - prevPage(): void; - - /** - * Sets the page index to be equal to the next page index and rebinds the data source - */ - nextPage(): void; - - /** - * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size - * - * @param s the page size. - */ - pageSize(s?: number): number; - - /** - * For internal use - * - * @param dirty - */ - pageSizeDirty(dirty: Object): void; - - /** - * Returns a list of records for the specified page. Implies that paging is enabled. - * - * @param p the page index for which records will be returned - */ - recordsForPage(p: number): void; - - /** - * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data - * - * @param tableDOM TABLE dom element to transform - */ - tableToObject(tableDOM: Element): Object; - - /** - * Parses the string and returns an evaluated JSON object - * - * @param s the JSON as string. - */ - stringToJSONObject(s: string): void; - - /** - * Parses a string and returns a XML Document - * - * @param s the XML represented as a string - */ - stringToXmlObject(s: string): void; - - /** - * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data - */ - groupByData(): any[]; - - /** - * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) - */ - visibleGroupByData(): any[]; - - /** - * Returns the current normalized/transformed and paged/filtered/sorted group-by data - */ - groupByDataView(): any[]; - - /** - * Toggle grouped record with the specified id and updates collections visible groupby data and data view - * - * @param id data-id attribute of the respective group row in the DOM - * @param collapsed if true the record should be collapsed, otherwise expanded - */ - toggleGroupByRecord(id: string, collapsed: boolean): void; - - /** - * Check whether the specified gorupby record is collapsed - * - * @param gbRec id of the grouped record OR grouped record - */ - isGroupByRecordCollapsed(gbRec: Object): boolean; - - /** - * Check whether grouping is applied for the specified sorting expressions. - * - * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings - */ - isGroupByApplied(exprs?: any[]): boolean; -} +declare namespace Infragistics { + class TreeHierarchicalDataSource { + constructor(settings: TreeHierarchicalDataSourceSettings); + + /** + * Data binds to the current data source + * databinding works using the following workflow: + * 1. fire the databinding event + * 2. based on the data source type (see analyzeDataSource()), do the following: + * 3. if type is HtmlTable, parse the table and set the data and dataView respectively. + * if the type is Function, call it, apply Paging/Filtering/Sorting, and set this._dataView . If the developer wants to do his own paging, filtering or sorting + * in that case, then he should handle the PageIndexChanging and/or DataFiltering, and/or ColumnSorting client-side events, and cancel them. + * if no paging/sorting/filtering are enabled, use just this._data to save space + * if the data source is of type RemoteUrl, use jQuery's $.ajax API to trigger a remote request to the service. Use the param() API to encode the URL + * if the data source is invalid, throw an exception + * if the analyzed runtime data source type , that is, the result of analyzeDataSource(), is Unknown, check if + * the value of settings.type is set to XML or JSON. If string, eval for JSON, and parse for the XML to build the object ree + * 4. now normalize/transform the data, if a schema is supplied. This inplies any additional data type conversion + * 5. next, if OpType is Local, apply paging, sorting, and/or filtering to the data, and store the result in this._dataView + * 6. fire the databound event + * + * @param callback callback function + * @param callee callee object on which the callback will be executed. If none is specified, will assume global execution context + */ + dataBind(callback?: string, callee?: Object): void; + + /** + * Gets the passed record's parent records + * + * @param dataRow the child record. + * @param ds the data source in which to search for the related parent records. + */ + getParentRowsForRow(dataRow: Object, ds?: Object): Object; + + /** + * Gets the current data bound depth of the tree grid hierarchy. + */ + getDataBoundDepth(): void; + + /** + * Gets/Sets whether the data source has been transformed from flat to hierarchical + * + * @param isTransformed Determines if the data source is marked as transformed or not. + */ + isTransformedToHierarchicalData(isTransformed?: boolean): void; + + /** + * Transforms flat data to hierararchical data and returns the result + * + * @param data The flat data that will be transformed to hierarchical + */ + transformToHierarchicalData(data: Object): Object; + + /** + * This processes the passed data for the specified level and applies the schema transformation to it. + * + * @param data The data to be processed and transformed + * @param level The level to which the data belongs to. If this is not set it defaults to 0. + * @param suppressTransformation Determines whether the data should go through schema transformation. If true schema transofrmatin will not be applied. + */ + processDataPerLevel(data: Object, level?: number, suppressTransformation?: boolean): Object; + + /** + * Returnschild data transformed to flat data + * + * @param record The data record whose data is transformed and returned as flat + * @param level The level. If not set defaults to 0. + */ + getFlatDataForRecord(record: Object, level?: number): Object; + + /** + * Generates flat data. + * Returns an object that contains the generated flat data, the flat visible data, records count and visible records count. + * + * @param data The data record whose data is transformed. + * @param level The level from which to start recursively generating the flat data. If not set defaults to 0. + */ + generateFlatData(data: Object, level?: number): Object; + + /** + * Generates a flat data view from the current (hierarchical)data + */ + generateFlatDataView(): void; + + /** + * Returns the current flat data view + */ + flatDataView(): Object; + + /** + * Returns flat visible data. + */ + getVisibleFlatData(): Object; + + /** + * Returns flat data(without taking into account visible/expansion state). + */ + getFlatData(): Object; + + /** + * Returns total records count(without taking into account visible/expansion state). + */ + getFlatDataCount(): number; + + /** + * Sets the expanded/collapsed state of a row by its index + * + * @param index The index of the row. + * @param expanded If true then the row will be expanded. Otherwise it will be collapsed. + * @param callbackArgs Specifies a custom function to be called when the state of the row is changed. + */ + setExpandedStateByRowIndex(index: number, expanded: boolean, callbackArgs: Function): void; + + /** + * Sets the expanded state of a row by its primary key + * + * @param rowId The id of the row. + * @param expanded If true the row will be expanded. Otherwise it will be collapsed. + * @param callbackArgs Specifies a custom function to be called when the state of the row is changed. + */ + setExpandedStateByPrimaryKey(rowId: string, expanded: boolean, callbackArgs: Function): void; + + /** + * Gets whether the row with the specified id is expanded.Returns true if the row is expanded or false if it's not. + * + * @param rowId //The id of the row. + */ + getExpandStateById(rowId: string): boolean; + + /** + * Toggles the row's state by the row's id. + * + * @param rowId The id of the row. + * @param callbackArgs Specifies a custom function to be called when the state of the row is changed. + */ + toggleRow(rowId: string, callbackArgs: Function): void; + + /** + * Sorts the data source locally. The result (sorted data) can be obtained by calling dataView(). + * Remote filtering can be performed by just calling dataBind() and setting the settings.sorting.expressions + * multi-column sorting can be enabled by setting keepSortState to true. + * fields => an array of fields object definitions: + * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] + * + * @param fields an array of fields object definitions + * @param direction asc / desc direction + */ + sort(fields: Object, direction: string): void; + + /** + * Sorts the given data recursively + * fields => an array of fields object definitions: + * example: [{fieldName : "firstName"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2}] + * + * @param data the data array that will be sorted. + * @param level the level to which the data belongs to + * @param fields an array of fields object definitions + * @param direction asc / desc direction + */ + sortDataRecursive(data: Object, level: number, fields: Object, direction: string): void; + + /** + * Sorts the passed data and returns the sorted result. + * + * @param data the data to be sorted + + fields => an array of fields object definitions: + example: [{fieldName : "firstName"}, {fieldName : "lastName"}] + example 2: [{fieldIndex : 1} , {fieldIndex : 2}] + + * @param fields an array of fields object definitions + * @param direction asc / desc direction + */ + sortData(data: Object, fields: Object, direction: string): void; + + /** + * Returns the total number of records in the local data source + */ + totalLocalRecordsCount(): number; + + /** + * Returns the total number of pages + */ + pageCount(): number; + + /** + * Returns the total number of match filtering records in the data source. + * When the dataSource is remote and filtering is applied then it is taken value + * of property "filtering.countRecords" in metatadata - if set. If it is not set returns totalRecordsCount + */ + getFilteringMatchRecordsCount(): number; + + /** + * Filters the data source locally. Remote filtering can be performed by just calling dataBind() and setting the settings.filtering.expressions. The result (filtered data) can be obtained by calling dataView() + * example: [{fieldName : "firstName", expr: "abc", cond: "StartsWith"}, {fieldName : "lastName"}] + * example 2: [{fieldIndex : 1} , {fieldIndex : 2, expr: "a", cond : "contains"}] + * expr is the filter expression text , such as "abc", or a regular expression such as *test* + * cond is the filtering condition such as startsWith, endsWith, contains, equals, doesNotEqual, doesNotContain + * if expr is detected to be a regular expression, the "cond" part is skipped + * + * @param fieldExpressions a list of field expression definitions + * @param boolLogic boolean logic. Accepted values are AND and OR. + * @param keepFilterState if keepFilterState is set to true, it will not discard previous filtering expressions + * @param fieldExpressionsOnStrings + */ + filter(fieldExpressions: Object, boolLogic: Object, keepFilterState: boolean, fieldExpressionsOnStrings: Object): void; + + /** + * Gets the count of the filtered records in the dataView + */ + getFilteredRecordsCountFromDataView(): number; + + /** + * Gets the count of the filtered records + */ + getFilteredRecordsCount(): number; + + /** + * This clears local filtering applied to the data view by resetting it to the original data and applying any paging. + */ + clearLocalFilter(): void; + + /** + * Gets whether the flat data view should be generated by calling the generateFlatDataView method. + */ + shouldCallGenerateFlatDataView(): void; + + /** + * Clears __matchFiltering property from the data record objects in the filtered data source. The __matchFiltering property determines whether a record matches the specified filtering condition. + * + * @param data the array of data objects to be cleared. If not set the current filtered data array is used. + */ + clearMatchFiltering(data?: Object): void; + + /** + * Gets the path of a record by the record or the record's key + * + * @param record the record or the record's key as string or number + */ + getPathBy(record: Object): void; + + /** + * Returns a record by a specified key (requires that primaryKey is set in the settings) + * + * @param key Primary key of the record + * @param ds the data source in which to search for the record. When not set it will use the current data source. + * @param objPath path to the object. Example: {path: '5/1'} + */ + findRecordByKey(key: Object, ds?: string, objPath?: Object): Object; + + /** + * Removes a specific record denoted by the primaryKey of the passed key parameter from the data source + * + * @param key primary key of the record + * @param origDs + */ + removeRecordByKey(key: Object, origDs: Object): void; + + /** + * Deletes a row from the data source. + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + deleteRow(rowId: Object, autoCommit: boolean): Object; + + /** + * Gets the chilren records by the parent record's key in the passed data source + * + * @param key primary key of the record + * @param ds the data source + */ + getChildrenByKey(key: Object, ds: Object): Object; + + /** + * Adds a new row to the data source. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param rowIndex row index at which to be insert the new row + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + * @param parentRowId the value of the primary key of the parent row(if any) + */ + insertRow(rowId: Object, rowObject: Object, rowIndex: number, autoCommit: boolean, parentRowId: Object): Object; + + /** + * Sets a list of fields to the data source. If no parameter is specified, just returns the already existing list of fields + * + * @param fields a field has the following format: {key: 'fieldKey', dataType: 'string/number/date' } + */ + fields(fields?: Object): Object; + + /** + * Analyzes the dataSource setting to automatically determine the type of the data source. Returns the data source type. See settings.type + */ + analyzeDataSource(): string; + + /** + * Returns the current normalized/transformed and paged/filtered/sorted data, i.e. the dataView + */ + dataView(): any[]; + + /** + * Returns all of the bound data, without taking into account local paging, sorting, filtering, etc. + */ + data(): Object; + + /** + * Returns transformed data according to transformed execution: + * 1. Before paging and filtering + * 2. After filtering before paging + * 3. After filtering and paging + * + * @param transformedExecution + */ + transformedData(transformedExecution: Object): Object; + + /** + * Returns summaries data + */ + dataSummaries(): Object; + + /** + * Gets/sets the schema definition. + * + * @param s a schema object + * @param t type of the data source. See settings.type + */ + schema(s?: Object, t?: string): void; + + /** + * Gets/sets a list of paging settings + * + * @param p object holding all paging settings. See settings.paging + */ + pagingSettings(p?: Object): Object; + + /** + * Gets/sets a list of filtering settings + * + * @param f object holding all filtering settings. See settings.filtering + */ + filterSettings(f?: Object): void; + + /** + * Gets/sets a list of paging settings + * + * @param s object holding all sorting settings. See settings.sorting + */ + sortSettings(s?: Object): Object; + + /** + * Gets/sets a list of summaries settings. + * + * @param s object holding all summaries settings. See settings.summaries + */ + summariesSettings(s?: Object): void; + + /** + * Gets/sets the dataSource setting. If no parameter is specified, returns settings.dataSource + * + * @param ds + */ + dataSource(ds?: Object): Object; + + /** + * Gets/sets the type of the dataSource. If no parameter is specified, returns settings.type + * + * @param t + * @return json|xml|unknown|array|function|htmlTableString|htmlTableId|htmlTableDom|invalid|remoteUrl|empty + */ + type(t?: Object): string; + + /** + * Removes a record from the data source at specific index. + * + * @param index index of record + * @param origDs + */ + removeRecordByIndex(index: number, origDs: Object): void; + + /** + * Sets a cell value for the cell denoted by rowId and colId. Creates a transaction for the update operation and returns it + * + * @param rowId the rowId - row key (string) or index (number) + * @param colId the column id - column key (string) or index (number) + * @param val The new value + * @param autoCommit if autoCommit is true, it updates the datasource automatically and the transaction is still stored in the accumulated transaction log + */ + setCellValue(rowId: Object, colId: Object, val: Object, autoCommit: boolean): Object; + + /** + * Updates a record in the datasource. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the record object containing the key/value pairs we want to update. It doesn't have to include key/value pairs for all fields defined in the schema or in the data source (if no schema is defined) + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + updateRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; + + /** + * Adds a new row to the data source. Creates a transaction that can be committed / rolled back + * + * @param rowId the record key - primaryKey (string) or index (number) + * @param rowObject the new record data. + * @param autoCommit if autoCommit is true, the datasource will be updated automatically and the transaction is still stored in the accumulated transaction log + */ + addRow(rowId: Object, rowObject: Object, autoCommit: boolean): Object; + + /** + * Adds a new node to the tree data source. Creates a transaction that can be committed / rolled back + * + * @param data the transaction data + */ + addNode(data: Object): void; + + /** + * Removes a node from the tree data source. Creates a transaction that can be committed / rolled back + * + * @param data the transaction data + */ + removeNode(data: Object): void; + + /** + * Returns a standalone object (copy) that represents the commited transactions, but detached from the data source + * + * @param t a transaction object + */ + getDetachedRecord(t: Object): Object; + + /** + * Update the data source with every transaction from the log + * + * @param id Id of the transaction to commit. If no id is specified, will commit all transactions to the data source. + */ + commit(id?: number): void; + + /** + * Clears the transaction log without updating anything in the data source + * + * @param id Record Id to find transactions for. If no id is specified, will rollback all transactions to the data source. + */ + rollback(id?: Object): void; + + /** + * Returns a list of all transaction objects that are pending to be committed or rolled back to the data source + */ + pendingTransactions(): any[]; + + /** + * Returns a list of all transaction objects that are either pending, or have been committed in the data source. + */ + allTransactions(): any[]; + + /** + * Returns the accumulated transaction log as a string. The purpose of this is to be passed to URLs or used conveniently + */ + transactionsAsString(): string; + + /** + * Posts to the settings.updateUrl using $.ajax, by serializing the changes as url params + * + * @param success Specifies a custom function to be called when AJAX request to the updateUrl option succeeds(optional) + * @param error Specifies a custom function to be called when AJAX request to the updateUrl option fails(optional) + */ + saveChanges(success: Function, error: Function): void; + + /** + * Gets a cell value from the record by the specified fieldName. If there's a mapper defined for the field, the resolved by the mapper value will be returned. + * + * @param fieldName the fieldName - name of the field + * @param record the record from which to get it + */ + getCellValue(fieldName: string, record: Object): Object; + + /** + * Applicable only when the data source is bound to remote data. + * Gets or sets summaries data. + * If key or dsObj are not set then returns summaries data. + * Takes summary data from passed argument dsObj(using argument key) + * + * @param key response key to take summary data(for example "Metadata.Summaries") + * @param dsObj data source object - usually contains information about data records and metadata(holds info about summaries) + */ + summariesResponse(key?: string, dsObj?: Object): Object; + + /** + * Returns filtered data if local filtering is applied. If filtering is not applied OR type of filtering is remote returns undefined. + */ + filteredData(): any[]; + + /** + * This clears local sorting applied to the data view by resetting it to the original data and applying any paging + */ + clearLocalSorting(): void; + + /** + * Applicable only when the data source is bound to remote data. + * Gets / sets the total number of records in the data source. + * If data binding is remote, and there's paging or filtering enabled, + * the actual total number of records may not + * match the number of records that exists on the client + * + * @param count the total number of records + * @param key + * @param dsObj + * @param context + */ + totalRecordsCount(count?: number, key?: Object, dsObj?: Object, context?: Object): number; + + /** + * Gets / sets if the response from the server contains a property which specifies the total number of records in the server-side backend + * + * @param hasCount specifies if the data source contains a property that denotes the total number of records in the server-side backend + */ + hasTotalRecordsCount(hasCount: boolean): void; + + /** + * Returns metadata object for the specified key + * + * @param key Primary key of the record + */ + metadata(key: string): Object; + + /** + * Gets /sets the current page index. If an index is passed as a parameter, the data source is re-bound. + * + * @param index the page index. If none is specified, returns the current page index. + */ + pageIndex(index?: number): number; + + /** + * Gets /sets the page index that should be persisted. For now ONLY when filtering is applied and call explicitly DataBind. + * + * @param value the page index that should be persisted. If none is specified, returns the current page index that should be persisted. + */ + persistedPageIndex(value?: number): number; + + /** + * Sets the page index to be equal to the previous page index and rebinds the data source + */ + prevPage(): void; + + /** + * Sets the page index to be equal to the next page index and rebinds the data source + */ + nextPage(): void; + + /** + * Gets /sets the page size and rebinds the data source if a parameter is specified. If no parameter is passed, returns the current page size + * + * @param s the page size. + */ + pageSize(s?: number): number; + + /** + * For internal use + * + * @param dirty + */ + pageSizeDirty(dirty: Object): void; + + /** + * Returns a list of records for the specified page. Implies that paging is enabled. + * + * @param p the page index for which records will be returned + */ + recordsForPage(p: number): void; + + /** + * Converts a HTML TABLE dom element to a JavaScript array of objects that contain the records data + * + * @param tableDOM TABLE dom element to transform + */ + tableToObject(tableDOM: Element): Object; + + /** + * Parses the string and returns an evaluated JSON object + * + * @param s the JSON as string. + */ + stringToJSONObject(s: string): void; + + /** + * Parses a string and returns a XML Document + * + * @param s the XML represented as a string + */ + stringToXmlObject(s: string): void; + + /** + * Returns collection of data and non-data(grouped) records. Flat representation of hierarchical data + */ + groupByData(): any[]; + + /** + * Returns collection of data and non-data(grouped) records. Returns only visible records(children of collapsed grouped records are not included in the collection) + */ + visibleGroupByData(): any[]; + + /** + * Returns the current normalized/transformed and paged/filtered/sorted group-by data + */ + groupByDataView(): any[]; + + /** + * Toggle grouped record with the specified id and updates collections visible groupby data and data view + * + * @param id data-id attribute of the respective group row in the DOM + * @param collapsed if true the record should be collapsed, otherwise expanded + */ + toggleGroupByRecord(id: string, collapsed: boolean): void; + + /** + * Check whether the specified gorupby record is collapsed + * + * @param gbRec id of the grouped record OR grouped record + */ + isGroupByRecordCollapsed(gbRec: Object): boolean; + + /** + * Check whether grouping is applied for the specified sorting expressions. + * + * @param exprs array of sorting expressions. If not set check expressions defined in sorting settings + */ + isGroupByApplied(exprs?: any[]): boolean; + } } interface IgniteUIStatic { TreeHierarchicalDataSource: typeof Infragistics.TreeHierarchicalDataSource; } -declare module Infragistics { -export class DvCommonWidget { - option(key: Object, value: Object): void; -} +declare namespace Infragistics { + class DvCommonWidget { + option(key: Object, value: Object): void; + } } interface SimpleTextMarkerTemplateSettings { @@ -6235,21 +6211,20 @@ interface SimpleTextMarkerTemplateSettings { [optionName: string]: any; } -declare module Infragistics { -export class SimpleTextMarkerTemplate { - constructor(requireThis: boolean); - constructor(settings: SimpleTextMarkerTemplateSettings); - getText(item: Object, textDelegate: Object): void; - measure(measureInfo: Object): void; - render(renderInfo: Object): void; -} +declare namespace Infragistics { + class SimpleTextMarkerTemplate { + constructor(requireThis: boolean); + constructor(settings: SimpleTextMarkerTemplateSettings); + getText(item: Object, textDelegate: Object): void; + measure(measureInfo: Object): void; + render(renderInfo: Object): void; + } } interface IgniteUIStatic { SimpleTextMarkerTemplate: typeof Infragistics.SimpleTextMarkerTemplate; } interface GridExcelExporterSettingsGridFeatureOptions { - /** * Indicates whether sorting will be applied in the exported table. This is set_ to none by default, but will change to applied if sorting feature is defined in the igGrid. * @@ -6313,7 +6288,6 @@ interface GridExcelExporterSettingsGridFeatureOptions { } interface GridExcelExporterSettings { - /** * Specifies the name of the excel file that will be generated. */ @@ -6373,7 +6347,6 @@ interface GridExcelExporterSettings { } interface GridExcelExporterCallbacks { - /** * Cancel="true" Callback fired when the exporting has started. * Function takes arguments sender and args. @@ -6494,27 +6467,26 @@ interface GridExcelExporterCallbacks { [optionName: string]: any; } -declare module Infragistics { -export class GridExcelExporter { - constructor(settings: GridExcelExporterSettings); - constructor(callbacks: GridExcelExporterCallbacks); +declare namespace Infragistics { + class GridExcelExporter { + constructor(settings: GridExcelExporterSettings); + constructor(callbacks: GridExcelExporterCallbacks); - /** - * Exports the provided igGrid to Excel document. - * - * @param grid Grid to be exported. - * @param userSettings Settings for exporting the grid. - * @param userCallbacks Callbacks for the events. - */ - exportGrid(grid: Object, userSettings: Object, userCallbacks: Object): void; -} + /** + * Exports the provided igGrid to Excel document. + * + * @param grid Grid to be exported. + * @param userSettings Settings for exporting the grid. + * @param userCallbacks Callbacks for the events. + */ + exportGrid(grid: Object, userSettings: Object, userCallbacks: Object): void; + } } interface IgniteUIStatic { GridExcelExporter: typeof Infragistics.GridExcelExporter; } interface OlapXmlaDataSourceOptionsRequestOptions { - /** * The value is applied to XmlHttpRequest.withCredentials if supported by the user agent. * Setting this property to true will allow IE8/IE9 to make authenticated cross-origin requests to tusted domains through XmlHttpRequest instead of XDomainRequest @@ -6534,7 +6506,6 @@ interface OlapXmlaDataSourceOptionsRequestOptions { } interface OlapXmlaDataSourceOptionsMdxSettings { - /** * Optional="true" a value indicating whether a NON EMPTY clause is present on ROWS axis. Default value is true */ @@ -6572,7 +6543,6 @@ interface OlapXmlaDataSourceOptionsMdxSettings { } interface OlapXmlaDataSourceOptions { - /** * Optional="false" The URL of the XMLA server. */ @@ -6646,323 +6616,322 @@ interface OlapXmlaDataSourceOptions { [optionName: string]: any; } -declare module Infragistics { -export class OlapXmlaDataSource { - constructor(options: OlapXmlaDataSourceOptions); +declare namespace Infragistics { + class OlapXmlaDataSource { + constructor(options: OlapXmlaDataSourceOptions); - /** - * Initializes the data source and returns a promise that will be resolved once the data source is initialized. - * The promise's result will be the metadata tree for the catalog/cube/measureGroup specified in the settings or null if the settings do not provide a valid cube initialization data. - * The data source is not functional until it has been initialized and all other methods other than initialize() will throw an error if isInitialized() returns false. - */ - initialize(): Object; + /** + * Initializes the data source and returns a promise that will be resolved once the data source is initialized. + * The promise's result will be the metadata tree for the catalog/cube/measureGroup specified in the settings or null if the settings do not provide a valid cube initialization data. + * The data source is not functional until it has been initialized and all other methods other than initialize() will throw an error if isInitialized() returns false. + */ + initialize(): Object; - /** - * Retrieves the initialization state of the data source. - */ - isInitialized(): boolean; + /** + * Retrieves the initialization state of the data source. + */ + isInitialized(): boolean; - /** - * Indicates whether the data source is modified. - */ - isModified(): boolean; + /** + * Indicates whether the data source is modified. + */ + isModified(): boolean; - /** - * Indicates whether the update() method execution is in progress. - */ - isUpdating(): boolean; + /** + * Indicates whether the update() method execution is in progress. + */ + isUpdating(): boolean; - /** - * Retrieves the currently loaded catalogs in the data source. - */ - catalogs(): any[]; + /** + * Retrieves the currently loaded catalogs in the data source. + */ + catalogs(): any[]; - /** - * Retrieves the current catalog in the data source. - */ - catalog(): Object; + /** + * Retrieves the current catalog in the data source. + */ + catalog(): Object; - /** - * Sets the current catalog for the data source and updates the cubes() and catalog() properties. - * - * @param catalogName the name of the catalog. - */ - setCatalog(catalogName: string): Object; + /** + * Sets the current catalog for the data source and updates the cubes() and catalog() properties. + * + * @param catalogName the name of the catalog. + */ + setCatalog(catalogName: string): Object; - /** - * Retrieves the currently loaded cubes in the data source. - */ - cubes(): any[]; + /** + * Retrieves the currently loaded cubes in the data source. + */ + cubes(): any[]; - /** - * Retrieves the current cube in the data source. - */ - cube(): Object; + /** + * Retrieves the current cube in the data source. + */ + cube(): Object; - /** - * Sets the current cube for the data source and updates the cube(), measureGroup() and metadataTree() properties. - * - * @param cubeName the name of the cube. - */ - setCube(cubeName: string): Object; + /** + * Sets the current cube for the data source and updates the cube(), measureGroup() and metadataTree() properties. + * + * @param cubeName the name of the cube. + */ + setCube(cubeName: string): Object; - /** - * Retrieves the currently loaded measure groups in the data source. - */ - measureGroups(): any[]; + /** + * Retrieves the currently loaded measure groups in the data source. + */ + measureGroups(): any[]; - /** - * Retrieves the current measureGroup in the data source. - */ - measureGroup(): Object; + /** + * Retrieves the current measureGroup in the data source. + */ + measureGroup(): Object; - /** - * Sets the current measure group for the data source and updates the measureGroup() and metadataTree() properties. - * Even though the catalogs/cubes/measureGroups items are cascading(e.g. in order to load the cubes a catalog has to be set) in order to construct the metadata tree a measure group is not required as it just filters the resulting metadata. - * Once setCube(cubeName) is called the metadata tree would be loaded and the measureGroup() property would be filled with the default '(All)' measure group which indicates that no measure group is selected. - * - * @param measureGroupName the name of the measure group. - */ - setMeasureGroup(measureGroupName: string): Object; + /** + * Sets the current measure group for the data source and updates the measureGroup() and metadataTree() properties. + * Even though the catalogs/cubes/measureGroups items are cascading(e.g. in order to load the cubes a catalog has to be set) in order to construct the metadata tree a measure group is not required as it just filters the resulting metadata. + * Once setCube(cubeName) is called the metadata tree would be loaded and the measureGroup() property would be filled with the default '(All)' measure group which indicates that no measure group is selected. + * + * @param measureGroupName the name of the measure group. + */ + setMeasureGroup(measureGroupName: string): Object; - /** - * Returns the fully loaded metadata tree. - */ - metadataTree(): Object; + /** + * Returns the fully loaded metadata tree. + */ + metadataTree(): Object; - /** - * Adds a hierarchy to the rows of the pivot grid. - * - * @param rowItem An object of type $.ig.Hierarchy which is the hierarchy to add in the pivot grid rows. - */ - addRowItem(rowItem: Object): void; + /** + * Adds a hierarchy to the rows of the pivot grid. + * + * @param rowItem An object of type $.ig.Hierarchy which is the hierarchy to add in the pivot grid rows. + */ + addRowItem(rowItem: Object): void; - /** - * Removes a hierarchy or the measure list from the rows of the pivot grid. - * - * @param rowItem an object of type $.ig.Hierarchy or $.ig.MeasureList which is the hierarchy to remove or the measure list if there are more than one measures added and the measure list location is set to "rows". - */ - removeRowItem(rowItem: Object): void; + /** + * Removes a hierarchy or the measure list from the rows of the pivot grid. + * + * @param rowItem an object of type $.ig.Hierarchy or $.ig.MeasureList which is the hierarchy to remove or the measure list if there are more than one measures added and the measure list location is set to "rows". + */ + removeRowItem(rowItem: Object): void; - /** - * Adds a hierarchy to the columns of the pivot grid. - * - * @param columnItem an object of type $.ig.Hierarchy which is the hierarchy to add in the pivot grid columns. - */ - addColumnItem(columnItem: Object): void; + /** + * Adds a hierarchy to the columns of the pivot grid. + * + * @param columnItem an object of type $.ig.Hierarchy which is the hierarchy to add in the pivot grid columns. + */ + addColumnItem(columnItem: Object): void; - /** - * Removes a hierarchy or the measure list from the columns of the pivot grid. - * - * @param columnItem an object of type $.ig.Hierarchy or $.ig.MeasureList which is the hierarchy to remove or the measure list if there are more than one measures added and the measure list location is set to "columns". - */ - removeColumnItem(columnItem: Object): void; + /** + * Removes a hierarchy or the measure list from the columns of the pivot grid. + * + * @param columnItem an object of type $.ig.Hierarchy or $.ig.MeasureList which is the hierarchy to remove or the measure list if there are more than one measures added and the measure list location is set to "columns". + */ + removeColumnItem(columnItem: Object): void; - /** - * Adds a hierarchy to the filter axis of the pivot grid. - * - * @param filterItem an object of type $.ig.Hierarchy which is the hierarchy to add. - */ - addFilterItem(filterItem: Object): void; + /** + * Adds a hierarchy to the filter axis of the pivot grid. + * + * @param filterItem an object of type $.ig.Hierarchy which is the hierarchy to add. + */ + addFilterItem(filterItem: Object): void; - /** - * Removes a hierarchy from the filter axis of the pivot grid. - * - * @param filterItem an object of type $.ig.Hierarchy which is the hierarchy to remove. - */ - removeFilterItem(filterItem: Object): void; + /** + * Removes a hierarchy from the filter axis of the pivot grid. + * + * @param filterItem an object of type $.ig.Hierarchy which is the hierarchy to remove. + */ + removeFilterItem(filterItem: Object): void; - /** - * Adds a measure to the measures of the pivot grid. - * - * @param measureItem an object of type $.ig.Measure which is the measure to add. - */ - addMeasureItem(measureItem: Object): void; + /** + * Adds a measure to the measures of the pivot grid. + * + * @param measureItem an object of type $.ig.Measure which is the measure to add. + */ + addMeasureItem(measureItem: Object): void; - /** - * Removes a measure from the measures of the pivot grid. - * - * @param measureItem An object of type $.ig.Measure which is the measure to remove. - */ - removeMeasureItem(measureItem: Object): void; + /** + * Removes a measure from the measures of the pivot grid. + * + * @param measureItem An object of type $.ig.Measure which is the measure to remove. + */ + removeMeasureItem(measureItem: Object): void; - /** - * Sets the index at which the measure list will be positioned in the rows/columns it resides. - * - * @param index the index where measure list to appear. - */ - setMeasureListIndex(index: number): void; + /** + * Sets the index at which the measure list will be positioned in the rows/columns it resides. + * + * @param index the index where measure list to appear. + */ + setMeasureListIndex(index: number): void; - /** - * Sets the location of the measure list. - * - * @param location accepted values are 'rows' and 'columns'. - */ - setMeasureListLocation(location: Object): void; + /** + * Sets the location of the measure list. + * + * @param location accepted values are 'rows' and 'columns'. + */ + setMeasureListLocation(location: Object): void; - /** - * Sets a tuple member to be expanded next time the update() method is called. - * Calling this method on an already expanded member does nothing. - * - * @param axisName the name of the axis for the tuple. - * @param tupleIndex the index of the tuple in the axis. - * @param memberIndex the index of the member in the tuple. - */ - expandTupleMember(axisName: string, tupleIndex: number, memberIndex: number): void; + /** + * Sets a tuple member to be expanded next time the update() method is called. + * Calling this method on an already expanded member does nothing. + * + * @param axisName the name of the axis for the tuple. + * @param tupleIndex the index of the tuple in the axis. + * @param memberIndex the index of the member in the tuple. + */ + expandTupleMember(axisName: string, tupleIndex: number, memberIndex: number): void; - /** - * Sets a tuple member to be collapsed next time the update() method is called. - * Calling this method on an already collapsed member does nothing. - * - * @param axisName the name of the axis for the tuple. - * @param tupleIndex the index of the tuple in the axis. - * @param memberIndex the index of the member in the tuple. - */ - collapseTupleMember(axisName: string, tupleIndex: number, memberIndex: number): void; + /** + * Sets a tuple member to be collapsed next time the update() method is called. + * Calling this method on an already collapsed member does nothing. + * + * @param axisName the name of the axis for the tuple. + * @param tupleIndex the index of the tuple in the axis. + * @param memberIndex the index of the member in the tuple. + */ + collapseTupleMember(axisName: string, tupleIndex: number, memberIndex: number): void; - /** - * Returns the items in the row axis. - */ - rowAxis(): any[]; + /** + * Returns the items in the row axis. + */ + rowAxis(): any[]; - /** - * Returns the items in the column axis. - */ - columnAxis(): any[]; + /** + * Returns the items in the column axis. + */ + columnAxis(): any[]; - /** - * Returns the items in the filter axis. - */ - filters(): any[]; + /** + * Returns the items in the filter axis. + */ + filters(): any[]; - /** - * Returns the items in the measures axis. - */ - measures(): any[]; + /** + * Returns the items in the measures axis. + */ + measures(): any[]; - /** - * Returns the result from the last update or null if the last update was unsuccessful. - */ - result(): Object; + /** + * Returns the result from the last update or null if the last update was unsuccessful. + */ + result(): Object; - /** - * Clears all pending changes since last time the update() method is called. - */ - clearPendingChanges(): void; + /** + * Clears all pending changes since last time the update() method is called. + */ + clearPendingChanges(): void; - /** - * Performs an update with the list of pending changes and updates the data source result. - */ - update(): Object; + /** + * Performs an update with the list of pending changes and updates the data source result. + */ + update(): Object; - /** - * Gets the first element of the specified elementType which matches the specified predicate or null if there is no such element found. - * - * @param predicate a predicate callback invoked against each core element of the specified type. It has to return true when the element has matched the serach criteria, otherwise - false. - * @param elementType an object specified by $.ig.ICoreOlapElement.prototype.$type property. Valid types which prototype can be examined are: $.ig.Dimension, $.ig.Hierarchy, $.ig.Level, $.ig.Measure and $.ig.MeasureList. - */ - getCoreElement(predicate: Function, elementType: Object): Object; + /** + * Gets the first element of the specified elementType which matches the specified predicate or null if there is no such element found. + * + * @param predicate a predicate callback invoked against each core element of the specified type. It has to return true when the element has matched the serach criteria, otherwise - false. + * @param elementType an object specified by $.ig.ICoreOlapElement.prototype.$type property. Valid types which prototype can be examined are: $.ig.Dimension, $.ig.Hierarchy, $.ig.Level, $.ig.Measure and $.ig.MeasureList. + */ + getCoreElement(predicate: Function, elementType: Object): Object; - /** - * Gets an array with elements of the specified elementType which match the specified predicate or empty array if there is no such element found. - * - * @param predicate a predicate callback invoked against each core element of the specified type. It has to return true when the element has matched the serach criteria, otherwise - false. - * @param elementType an object specified by $.ig.ICoreOlapElement.prototype.$type property. Valid types which prototype can be examined are: $.ig.Dimension, $.ig.Hierarchy, $.ig.Level, $.ig.Measure and $.ig.MeasureList. - */ - getCoreElements(predicate: Function, elementType: Object): Object; + /** + * Gets an array with elements of the specified elementType which match the specified predicate or empty array if there is no such element found. + * + * @param predicate a predicate callback invoked against each core element of the specified type. It has to return true when the element has matched the serach criteria, otherwise - false. + * @param elementType an object specified by $.ig.ICoreOlapElement.prototype.$type property. Valid types which prototype can be examined are: $.ig.Dimension, $.ig.Hierarchy, $.ig.Level, $.ig.Measure and $.ig.MeasureList. + */ + getCoreElements(predicate: Function, elementType: Object): Object; - /** - * Returns $.ig.Dimension object for the specified unique name. - * - * @param dimensionUniqueName the unique name of the searched dimension object. - */ - getDimension(dimensionUniqueName: string): Object; + /** + * Returns $.ig.Dimension object for the specified unique name. + * + * @param dimensionUniqueName the unique name of the searched dimension object. + */ + getDimension(dimensionUniqueName: string): Object; - /** - * Returns $.ig.Hierarchy object for the specified unique name. - * - * @param hierarchyUniqueName the unique name of the searched hierarchy object. - */ - getHierarchy(hierarchyUniqueName: string): Object; + /** + * Returns $.ig.Hierarchy object for the specified unique name. + * + * @param hierarchyUniqueName the unique name of the searched hierarchy object. + */ + getHierarchy(hierarchyUniqueName: string): Object; - /** - * Returns $.ig.Level object for the specified unique name. - * - * @param levelUniqueName the unique name of the searched level object. - */ - getLevel(levelUniqueName: string): Object; + /** + * Returns $.ig.Level object for the specified unique name. + * + * @param levelUniqueName the unique name of the searched level object. + */ + getLevel(levelUniqueName: string): Object; - /** - * Returns $.ig.Measure object for the specified unique name. - * - * @param measureUniqueName the unique name of the searched measure object. - */ - getMeasure(measureUniqueName: string): Object; + /** + * Returns $.ig.Measure object for the specified unique name. + * + * @param measureUniqueName the unique name of the searched measure object. + */ + getMeasure(measureUniqueName: string): Object; - /** - * Returns $.ig.MeasureList object available when operates with more than one $.ig.Measure object. - */ - getMeasureList(): Object; + /** + * Returns $.ig.MeasureList object available when operates with more than one $.ig.Measure object. + */ + getMeasureList(): Object; - /** - * Returns an array of strings with the unique names of selected for given hierarchy filter members. - * - * @param hierarchyUniqueName the unique name of the hierarchy whose active filter members are returned. - */ - getFilterMemberNames(hierarchyUniqueName: string): any[]; + /** + * Returns an array of strings with the unique names of selected for given hierarchy filter members. + * + * @param hierarchyUniqueName the unique name of the hierarchy whose active filter members are returned. + */ + getFilterMemberNames(hierarchyUniqueName: string): any[]; - /** - * Adds a member to list of filter members that will be present in result. - * If a member of given hierarchy is added to this filter list then only those members which are present in this filter list will be present for that hierarchy in the result. - * - * @param hierarchyUniqueName the unique name of the hierarchy this member belongs to. - * @param memberUniqueName the unique name of the member to be added. - */ - addFilterMember(hierarchyUniqueName: string, memberUniqueName: string): void; + /** + * Adds a member to list of filter members that will be present in result. + * If a member of given hierarchy is added to this filter list then only those members which are present in this filter list will be present for that hierarchy in the result. + * + * @param hierarchyUniqueName the unique name of the hierarchy this member belongs to. + * @param memberUniqueName the unique name of the member to be added. + */ + addFilterMember(hierarchyUniqueName: string, memberUniqueName: string): void; - /** - * Removes a member from the list of filter members that will be present in result. - * - * @param hierarchyUniqueName the unique name of the hierarchy this member belongs to. - * @param memberUniqueName the unique name of the member to be removed. - */ - removeFilterMember(hierarchyUniqueName: string, memberUniqueName: string): void; + /** + * Removes a member from the list of filter members that will be present in result. + * + * @param hierarchyUniqueName the unique name of the hierarchy this member belongs to. + * @param memberUniqueName the unique name of the member to be removed. + */ + removeFilterMember(hierarchyUniqueName: string, memberUniqueName: string): void; - /** - * Removes all members from the list of filter members and the filter for the specified hierarchy is cleared. - * - * @param hierarchyUniqueName the unique name of the hierarchy which filter members to be cleared. - */ - removeAllFilterMembers(hierarchyUniqueName: string): void; + /** + * Removes all members from the list of filter members and the filter for the specified hierarchy is cleared. + * + * @param hierarchyUniqueName the unique name of the hierarchy which filter members to be cleared. + */ + removeAllFilterMembers(hierarchyUniqueName: string): void; - /** - * Returns Promise which on completion provides an array of $.ig.OlapResultAxisMember objects of selected for given level filter member. - * - * @param levelUniqueName the unique name of the member whose active filter members are returned. - */ - getMembersOfLevel(levelUniqueName: string): void; + /** + * Returns Promise which on completion provides an array of $.ig.OlapResultAxisMember objects of selected for given level filter member. + * + * @param levelUniqueName the unique name of the member whose active filter members are returned. + */ + getMembersOfLevel(levelUniqueName: string): void; - /** - * Returns Promise which on completion provides an array of $.ig.OlapResultAxisMember objects of selected for given hierarchy filter member. - * - * @param hierarchyUniqueName the unique name of the member whose active filter members are returned. - */ - getMembersOfHierarchy(hierarchyUniqueName: string): void; + /** + * Returns Promise which on completion provides an array of $.ig.OlapResultAxisMember objects of selected for given hierarchy filter member. + * + * @param hierarchyUniqueName the unique name of the member whose active filter members are returned. + */ + getMembersOfHierarchy(hierarchyUniqueName: string): void; - /** - * Returns Promise which on completion provides an array of $.ig.OlapResultAxisMember objects that are children of the current member. - * - * @param memberUniqueName the unique name of the member whose active filter members are returned. - */ - getMembersOfMember(memberUniqueName: string): void; -} + /** + * Returns Promise which on completion provides an array of $.ig.OlapResultAxisMember objects that are children of the current member. + * + * @param memberUniqueName the unique name of the member whose active filter members are returned. + */ + getMembersOfMember(memberUniqueName: string): void; + } } interface IgniteUIStatic { OlapXmlaDataSource: typeof Infragistics.OlapXmlaDataSource; } interface OlapFlatDataSourceOptionsMetadataCubeMeasuresDimensionMeasure { - /** * Optional="false" A unique name for the measure. */ @@ -6991,7 +6960,6 @@ interface OlapFlatDataSourceOptionsMetadataCubeMeasuresDimensionMeasure { } interface OlapFlatDataSourceOptionsMetadataCubeMeasuresDimension { - /** * A unique name for the measures dimension. * The default value is "Measures". This name is used to create the names of dimensions using the following pattern: @@ -7017,7 +6985,6 @@ interface OlapFlatDataSourceOptionsMetadataCubeMeasuresDimension { } interface OlapFlatDataSourceOptionsMetadataCubeDimensionHierarchieLevel { - /** * Optional="false" A name for the level. * The unique name of the level is formed using the following pattern: @@ -7043,7 +7010,6 @@ interface OlapFlatDataSourceOptionsMetadataCubeDimensionHierarchieLevel { } interface OlapFlatDataSourceOptionsMetadataCubeDimensionHierarchie { - /** * Optional="false" A name for the hierarchy. * The unique name of the hierarchy is formed using the following pattern: @@ -7057,8 +7023,8 @@ interface OlapFlatDataSourceOptionsMetadataCubeDimensionHierarchie { caption?: string; /** - * The path to be used when displaying the hierarchy in the user interface. - * Nested folders are indicated by a backslash (\). + * The path to be used when displaying the hierarchy in the user interface. + * Nested folders are indicated by a backslash (\). * The folder hierarchy will appear under parent dimension node. */ displayFolder?: string; @@ -7075,7 +7041,6 @@ interface OlapFlatDataSourceOptionsMetadataCubeDimensionHierarchie { } interface OlapFlatDataSourceOptionsMetadataCubeDimension { - /** * Optional="false" A unique name for the dimension. */ @@ -7098,7 +7063,6 @@ interface OlapFlatDataSourceOptionsMetadataCubeDimension { } interface OlapFlatDataSourceOptionsMetadataCube { - /** * Optional="false" A unique name for the cube. */ @@ -7126,7 +7090,6 @@ interface OlapFlatDataSourceOptionsMetadataCube { } interface OlapFlatDataSourceOptionsMetadata { - /** * Optional="false" Metadata used for the creation of the cube. */ @@ -7139,7 +7102,6 @@ interface OlapFlatDataSourceOptionsMetadata { } interface OlapFlatDataSourceOptions { - /** * Optional="true" Specifies any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself. */ @@ -7196,348 +7158,346 @@ interface OlapFlatDataSourceOptions { [optionName: string]: any; } -declare module Infragistics { -export class OlapFlatDataSource { - constructor(options: OlapFlatDataSourceOptions); +declare namespace Infragistics { + class OlapFlatDataSource { + constructor(options: OlapFlatDataSourceOptions); - /** - * Initializes the data source and returns a promise that will be resolved once the data source is initialized. - * The promise's result will be the metadata tree for the catalog/cube/measureGroup specified in the settings or null if the settings do not provide a valid cube initialization data. - * The data source is not functional until it has been initialized and all other methods other than initialize() will throw an error if isInitialized() returns false. - */ - initialize(): Object; + /** + * Initializes the data source and returns a promise that will be resolved once the data source is initialized. + * The promise's result will be the metadata tree for the catalog/cube/measureGroup specified in the settings or null if the settings do not provide a valid cube initialization data. + * The data source is not functional until it has been initialized and all other methods other than initialize() will throw an error if isInitialized() returns false. + */ + initialize(): Object; - /** - * Retrieves the initialization state of the data source. - */ - isInitialized(): boolean; + /** + * Retrieves the initialization state of the data source. + */ + isInitialized(): boolean; - /** - * Indicates whether the data source is modified. - */ - isModified(): boolean; + /** + * Indicates whether the data source is modified. + */ + isModified(): boolean; - /** - * Indicates whether the update() method execution is in progress. - */ - isUpdating(): boolean; + /** + * Indicates whether the update() method execution is in progress. + */ + isUpdating(): boolean; - /** - * Retrieves the currently loaded cubes in the data source. - */ - cubes(): any[]; + /** + * Retrieves the currently loaded cubes in the data source. + */ + cubes(): any[]; - /** - * Retrieves the current cube in the data source. - */ - cube(): Object; + /** + * Retrieves the current cube in the data source. + */ + cube(): Object; - /** - * Sets the current cube for the data source and updates the cube(), measureGroup() and metadataTree() properties. - * - * @param cubeName the name of the cube. - */ - setCube(cubeName: string): Object; + /** + * Sets the current cube for the data source and updates the cube(), measureGroup() and metadataTree() properties. + * + * @param cubeName the name of the cube. + */ + setCube(cubeName: string): Object; - /** - * Returns the fully loaded metadata tree. - */ - metadataTree(): Object; + /** + * Returns the fully loaded metadata tree. + */ + metadataTree(): Object; - /** - * Adds a hierarchy to the rows of the pivot grid. - * - * @param rowItem An object of type $.ig.Hierarchy which is the hierarchy to add in the pivot grid rows. - */ - addRowItem(rowItem: Object): void; + /** + * Adds a hierarchy to the rows of the pivot grid. + * + * @param rowItem An object of type $.ig.Hierarchy which is the hierarchy to add in the pivot grid rows. + */ + addRowItem(rowItem: Object): void; - /** - * Removes a hierarchy or the measure list from the rows of the pivot grid. - * - * @param rowItem an object of type $.ig.Hierarchy or $.ig.MeasureList which is the hierarchy to remove or the measure list if there are more than one measures added and the measure list location is set to "rows". - */ - removeRowItem(rowItem: Object): void; + /** + * Removes a hierarchy or the measure list from the rows of the pivot grid. + * + * @param rowItem an object of type $.ig.Hierarchy or $.ig.MeasureList which is the hierarchy to remove or the measure list if there are more than one measures added and the measure list location is set to "rows". + */ + removeRowItem(rowItem: Object): void; - /** - * Adds a hierarchy to the columns of the pivot grid. - * - * @param columnItem an object of type $.ig.Hierarchy which is the hierarchy to add in the pivot grid columns. - */ - addColumnItem(columnItem: Object): void; + /** + * Adds a hierarchy to the columns of the pivot grid. + * + * @param columnItem an object of type $.ig.Hierarchy which is the hierarchy to add in the pivot grid columns. + */ + addColumnItem(columnItem: Object): void; - /** - * Removes a hierarchy or the measure list from the columns of the pivot grid. - * - * @param columnItem an object of type $.ig.Hierarchy or $.ig.MeasureList which is the hierarchy to remove or the measure list if there are more than one measures added and the measure list location is set to "columns". - */ - removeColumnItem(columnItem: Object): void; + /** + * Removes a hierarchy or the measure list from the columns of the pivot grid. + * + * @param columnItem an object of type $.ig.Hierarchy or $.ig.MeasureList which is the hierarchy to remove or the measure list if there are more than one measures added and the measure list location is set to "columns". + */ + removeColumnItem(columnItem: Object): void; - /** - * Adds a hierarchy to the filter axis of the pivot grid. - * - * @param filterItem an object of type $.ig.Hierarchy which is the hierarchy to add. - */ - addFilterItem(filterItem: Object): void; + /** + * Adds a hierarchy to the filter axis of the pivot grid. + * + * @param filterItem an object of type $.ig.Hierarchy which is the hierarchy to add. + */ + addFilterItem(filterItem: Object): void; - /** - * Removes a hierarchy from the filter axis of the pivot grid. - * - * @param filterItem an object of type $.ig.Hierarchy which is the hierarchy to remove. - */ - removeFilterItem(filterItem: Object): void; + /** + * Removes a hierarchy from the filter axis of the pivot grid. + * + * @param filterItem an object of type $.ig.Hierarchy which is the hierarchy to remove. + */ + removeFilterItem(filterItem: Object): void; - /** - * Adds a measure to the measures of the pivot grid. - * - * @param measureItem an object of type $.ig.Measure which is the measure to add. - */ - addMeasureItem(measureItem: Object): void; + /** + * Adds a measure to the measures of the pivot grid. + * + * @param measureItem an object of type $.ig.Measure which is the measure to add. + */ + addMeasureItem(measureItem: Object): void; - /** - * Removes a measure from the measures of the pivot grid. - * - * @param measureItem An object of type $.ig.Measure which is the measure to remove. - */ - removeMeasureItem(measureItem: Object): void; + /** + * Removes a measure from the measures of the pivot grid. + * + * @param measureItem An object of type $.ig.Measure which is the measure to remove. + */ + removeMeasureItem(measureItem: Object): void; - /** - * Sets the index at which the measure list will be positioned in the rows/columns it resides. - * - * @param index the index where measure list to appear. - */ - setMeasureListIndex(index: number): void; + /** + * Sets the index at which the measure list will be positioned in the rows/columns it resides. + * + * @param index the index where measure list to appear. + */ + setMeasureListIndex(index: number): void; - /** - * Sets the location of the measure list. - * - * @param location accepted values are 'rows' and 'columns'. - */ - setMeasureListLocation(location: Object): void; + /** + * Sets the location of the measure list. + * + * @param location accepted values are 'rows' and 'columns'. + */ + setMeasureListLocation(location: Object): void; - /** - * Sets a tuple member to be expanded next time the update() method is called. - * Calling this method on an already expanded member does nothing. - * - * @param axisName the name of the axis for the tuple. - * @param tupleIndex the index of the tuple in the axis. - * @param memberIndex the index of the member in the tuple. - */ - expandTupleMember(axisName: string, tupleIndex: number, memberIndex: number): void; + /** + * Sets a tuple member to be expanded next time the update() method is called. + * Calling this method on an already expanded member does nothing. + * + * @param axisName the name of the axis for the tuple. + * @param tupleIndex the index of the tuple in the axis. + * @param memberIndex the index of the member in the tuple. + */ + expandTupleMember(axisName: string, tupleIndex: number, memberIndex: number): void; - /** - * Sets a tuple member to be collapsed next time the update() method is called. - * Calling this method on an already collapsed member does nothing. - * - * @param axisName the name of the axis for the tuple. - * @param tupleIndex the index of the tuple in the axis. - * @param memberIndex the index of the member in the tuple. - */ - collapseTupleMember(axisName: string, tupleIndex: number, memberIndex: number): void; + /** + * Sets a tuple member to be collapsed next time the update() method is called. + * Calling this method on an already collapsed member does nothing. + * + * @param axisName the name of the axis for the tuple. + * @param tupleIndex the index of the tuple in the axis. + * @param memberIndex the index of the member in the tuple. + */ + collapseTupleMember(axisName: string, tupleIndex: number, memberIndex: number): void; - /** - * Returns the items in the row axis. - */ - rowAxis(): any[]; + /** + * Returns the items in the row axis. + */ + rowAxis(): any[]; - /** - * Returns the items in the column axis. - */ - columnAxis(): any[]; + /** + * Returns the items in the column axis. + */ + columnAxis(): any[]; - /** - * Returns the items in the filter axis. - */ - filters(): any[]; + /** + * Returns the items in the filter axis. + */ + filters(): any[]; - /** - * Returns the items in the measures axis. - */ - measures(): any[]; + /** + * Returns the items in the measures axis. + */ + measures(): any[]; - /** - * Returns the result from the last update or null if the last update was unsuccessful. - */ - result(): Object; + /** + * Returns the result from the last update or null if the last update was unsuccessful. + */ + result(): Object; - /** - * Clears all pending changes since last time the update() method is called. - */ - clearPendingChanges(): void; + /** + * Clears all pending changes since last time the update() method is called. + */ + clearPendingChanges(): void; - /** - * Performs an update with the list of pending changes and updates the data source result. - */ - update(): Object; + /** + * Performs an update with the list of pending changes and updates the data source result. + */ + update(): Object; - /** - * Gets the first element of the specified elementType which matches the specified predicate or null if there is no such element found. - * - * @param predicate a predicate callback invoked against each core element of the specified type. It has to return true when the element has matched the serach criteria, otherwise - false. - * @param elementType an object specified by $.ig.ICoreOlapElement.prototype.$type property. Valid types which prototype can be examined are: $.ig.Dimension, $.ig.Hierarchy, $.ig.Level, $.ig.Measure and $.ig.MeasureList. - */ - getCoreElement(predicate: Function, elementType: Object): Object; + /** + * Gets the first element of the specified elementType which matches the specified predicate or null if there is no such element found. + * + * @param predicate a predicate callback invoked against each core element of the specified type. It has to return true when the element has matched the serach criteria, otherwise - false. + * @param elementType an object specified by $.ig.ICoreOlapElement.prototype.$type property. Valid types which prototype can be examined are: $.ig.Dimension, $.ig.Hierarchy, $.ig.Level, $.ig.Measure and $.ig.MeasureList. + */ + getCoreElement(predicate: Function, elementType: Object): Object; - /** - * Gets an array with elements of the specified elementType which match the specified predicate or empty array if there is no such element found. - * - * @param predicate a predicate callback invoked against each core element of the specified type. It has to return true when the element has matched the serach criteria, otherwise - false. - * @param elementType an object specified by $.ig.ICoreOlapElement.prototype.$type property. Valid types which prototype can be examined are: $.ig.Dimension, $.ig.Hierarchy, $.ig.Level, $.ig.Measure and $.ig.MeasureList. - */ - getCoreElements(predicate: Function, elementType: Object): Object; + /** + * Gets an array with elements of the specified elementType which match the specified predicate or empty array if there is no such element found. + * + * @param predicate a predicate callback invoked against each core element of the specified type. It has to return true when the element has matched the serach criteria, otherwise - false. + * @param elementType an object specified by $.ig.ICoreOlapElement.prototype.$type property. Valid types which prototype can be examined are: $.ig.Dimension, $.ig.Hierarchy, $.ig.Level, $.ig.Measure and $.ig.MeasureList. + */ + getCoreElements(predicate: Function, elementType: Object): Object; - /** - * Returns $.ig.Dimension object for the specified unique name. - * - * @param dimensionUniqueName the unique name of the searched dimension object. - */ - getDimension(dimensionUniqueName: string): Object; + /** + * Returns $.ig.Dimension object for the specified unique name. + * + * @param dimensionUniqueName the unique name of the searched dimension object. + */ + getDimension(dimensionUniqueName: string): Object; - /** - * Returns $.ig.Hierarchy object for the specified unique name. - * - * @param hierarchyUniqueName the unique name of the searched hierarchy object. - */ - getHierarchy(hierarchyUniqueName: string): Object; + /** + * Returns $.ig.Hierarchy object for the specified unique name. + * + * @param hierarchyUniqueName the unique name of the searched hierarchy object. + */ + getHierarchy(hierarchyUniqueName: string): Object; - /** - * Returns $.ig.Level object for the specified unique name. - * - * @param levelUniqueName the unique name of the searched level object. - */ - getLevel(levelUniqueName: string): Object; + /** + * Returns $.ig.Level object for the specified unique name. + * + * @param levelUniqueName the unique name of the searched level object. + */ + getLevel(levelUniqueName: string): Object; - /** - * Returns $.ig.Measure object for the specified unique name. - * - * @param measureUniqueName the unique name of the searched measure object. - */ - getMeasure(measureUniqueName: string): Object; + /** + * Returns $.ig.Measure object for the specified unique name. + * + * @param measureUniqueName the unique name of the searched measure object. + */ + getMeasure(measureUniqueName: string): Object; - /** - * Returns $.ig.MeasureList object available when operates with more than one $.ig.Measure object. - */ - getMeasureList(): Object; + /** + * Returns $.ig.MeasureList object available when operates with more than one $.ig.Measure object. + */ + getMeasureList(): Object; - /** - * Returns an array of strings with the unique names of selected for given hierarchy filter members. - * - * @param hierarchyUniqueName the unique name of the hierarchy whose active filter members are returned. - */ - getFilterMemberNames(hierarchyUniqueName: string): any[]; + /** + * Returns an array of strings with the unique names of selected for given hierarchy filter members. + * + * @param hierarchyUniqueName the unique name of the hierarchy whose active filter members are returned. + */ + getFilterMemberNames(hierarchyUniqueName: string): any[]; - /** - * Adds a member to list of filter members that will be present in result. - * If a member of given hierarchy is added to this filter list then only those members which are present in this filter list will be present for that hierarchy in the result. - * - * @param hierarchyUniqueName the unique name of the hierarchy this member belongs to. - * @param memberUniqueName the unique name of the member to be added. - */ - addFilterMember(hierarchyUniqueName: string, memberUniqueName: string): void; + /** + * Adds a member to list of filter members that will be present in result. + * If a member of given hierarchy is added to this filter list then only those members which are present in this filter list will be present for that hierarchy in the result. + * + * @param hierarchyUniqueName the unique name of the hierarchy this member belongs to. + * @param memberUniqueName the unique name of the member to be added. + */ + addFilterMember(hierarchyUniqueName: string, memberUniqueName: string): void; - /** - * Removes a member from the list of filter members that will be present in result. - * - * @param hierarchyUniqueName the unique name of the hierarchy this member belongs to. - * @param memberUniqueName the unique name of the member to be removed. - */ - removeFilterMember(hierarchyUniqueName: string, memberUniqueName: string): void; + /** + * Removes a member from the list of filter members that will be present in result. + * + * @param hierarchyUniqueName the unique name of the hierarchy this member belongs to. + * @param memberUniqueName the unique name of the member to be removed. + */ + removeFilterMember(hierarchyUniqueName: string, memberUniqueName: string): void; - /** - * Removes all members from the list of filter members and the filter for the specified hierarchy is cleared. - * - * @param hierarchyUniqueName the unique name of the hierarchy which filter members to be cleared. - */ - removeAllFilterMembers(hierarchyUniqueName: string): void; + /** + * Removes all members from the list of filter members and the filter for the specified hierarchy is cleared. + * + * @param hierarchyUniqueName the unique name of the hierarchy which filter members to be cleared. + */ + removeAllFilterMembers(hierarchyUniqueName: string): void; - /** - * Returns Promise which on completion provides an array of $.ig.OlapResultAxisMember objects of selected for given level filter member. - * - * @param levelUniqueName the unique name of the level whose active filter members are returned. - */ - getMembersOfLevel(levelUniqueName: string): void; + /** + * Returns Promise which on completion provides an array of $.ig.OlapResultAxisMember objects of selected for given level filter member. + * + * @param levelUniqueName the unique name of the level whose active filter members are returned. + */ + getMembersOfLevel(levelUniqueName: string): void; - /** - * Returns Promise which on completion provides an array of $.ig.OlapResultAxisMember objects of selected for given hierarchy filter member. - * - * @param hierarchyUniqueName the unique name of the hierarchy whose active filter members are returned. - */ - getMembersOfHierarchy(hierarchyUniqueName: string): void; + /** + * Returns Promise which on completion provides an array of $.ig.OlapResultAxisMember objects of selected for given hierarchy filter member. + * + * @param hierarchyUniqueName the unique name of the hierarchy whose active filter members are returned. + */ + getMembersOfHierarchy(hierarchyUniqueName: string): void; - /** - * Returns Promise which on completion provides an array of $.ig.OlapResultAxisMember objects that are children of the current member. - * - * @param memberUniqueName the unique name of the member whose active filter members are returned. - */ - getMembersOfMember(memberUniqueName: string): void; -} + /** + * Returns Promise which on completion provides an array of $.ig.OlapResultAxisMember objects that are children of the current member. + * + * @param memberUniqueName the unique name of the member whose active filter members are returned. + */ + getMembersOfMember(memberUniqueName: string): void; + } } interface IgniteUIStatic { OlapFlatDataSource: typeof Infragistics.OlapFlatDataSource; } -declare module Infragistics { -export class OlapMetadataTreeItem { +declare namespace Infragistics { + class OlapMetadataTreeItem { + /** + * Returns the OLAP metadata item that this tree item represents which is an object of type $.ig.Cube, $.ig.Dimension, $.ig.Hierarchy, $.ig.Measure, $.ig.Level. + */ + item(): Object; - /** - * Returns the OLAP metadata item that this tree item represents which is an object of type $.ig.Cube, $.ig.Dimension, $.ig.Hierarchy, $.ig.Measure, $.ig.Level. - */ - item(): Object; + /** + * Returns the metadata tree item type which is a value from the $.ig.MetadataTreeItemType enumeration. + * + * $.ig.MetadataTreeItemType.prototype.cube = 0; + * Item type for the cube tree items. Contain an item() of type $.ig.Cube. + * + * $.ig.MetadataTreeItemType.prototype.dimension = 1; + * Item type for the dimension tree items. Contain an item() of type $.ig.Dimension. + * + * $.ig.MetadataTreeItemType.prototype.group = 2; + * Item type for the group tree items. Does not have item(). + * + * $.ig.MetadataTreeItemType.prototype.userDefinedHierarchy = 3; + * Item type for the userDefinedHierarchy tree items. Contain an item() of type $.ig.Hierarchy. + * + * $.ig.MetadataTreeItemType.prototype.systemEnabledHierarchy = 4; + * Item type for the systemEnabledHierarchy tree items. Contain an item() of type $.ig.Hierarchy. + * + * $.ig.MetadataTreeItemType.prototype.parentChildHierarchy = 5; + * Item type for the parentChildHierarchy tree items. Contain an item() of type $.ig.Hierarchy. + * + * $.ig.MetadataTreeItemType.prototype.measure = 6; + * Item type for the measure tree items. Contain an item() of type $.ig.Measure. + * + * $.ig.MetadataTreeItemType.prototype.level1 = 7; + * Item type for the level1 tree items. Contain an item() of type $.ig.Level. + * + * $.ig.MetadataTreeItemType.prototype.level2 = 8; + * Item type for the level2 tree items. Contain an item() of type $.ig.Level. + * + * $.ig.MetadataTreeItemType.prototype.level3 = 9; + * Item type for the level3 tree items. Contain an item() of type $.ig.Level. + * + * $.ig.MetadataTreeItemType.prototype.level4 = 10; + * Item type for the level4 tree items. Contain an item() of type $.ig.Level. + * + * $.ig.MetadataTreeItemType.prototype.level5 = 11; + * Item type for the level5 tree items. Contain an item() of type $.ig.Level. + */ + type(): number; - /** - * Returns the metadata tree item type which is a value from the $.ig.MetadataTreeItemType enumeration. - * - * $.ig.MetadataTreeItemType.prototype.cube = 0; - * Item type for the cube tree items. Contain an item() of type $.ig.Cube. - * - * $.ig.MetadataTreeItemType.prototype.dimension = 1; - * Item type for the dimension tree items. Contain an item() of type $.ig.Dimension. - * - * $.ig.MetadataTreeItemType.prototype.group = 2; - * Item type for the group tree items. Does not have item(). - * - * $.ig.MetadataTreeItemType.prototype.userDefinedHierarchy = 3; - * Item type for the userDefinedHierarchy tree items. Contain an item() of type $.ig.Hierarchy. - * - * $.ig.MetadataTreeItemType.prototype.systemEnabledHierarchy = 4; - * Item type for the systemEnabledHierarchy tree items. Contain an item() of type $.ig.Hierarchy. - * - * $.ig.MetadataTreeItemType.prototype.parentChildHierarchy = 5; - * Item type for the parentChildHierarchy tree items. Contain an item() of type $.ig.Hierarchy. - * - * $.ig.MetadataTreeItemType.prototype.measure = 6; - * Item type for the measure tree items. Contain an item() of type $.ig.Measure. - * - * $.ig.MetadataTreeItemType.prototype.level1 = 7; - * Item type for the level1 tree items. Contain an item() of type $.ig.Level. - * - * $.ig.MetadataTreeItemType.prototype.level2 = 8; - * Item type for the level2 tree items. Contain an item() of type $.ig.Level. - * - * $.ig.MetadataTreeItemType.prototype.level3 = 9; - * Item type for the level3 tree items. Contain an item() of type $.ig.Level. - * - * $.ig.MetadataTreeItemType.prototype.level4 = 10; - * Item type for the level4 tree items. Contain an item() of type $.ig.Level. - * - * $.ig.MetadataTreeItemType.prototype.level5 = 11; - * Item type for the level5 tree items. Contain an item() of type $.ig.Level. - */ - type(): number; + /** + * Returns the caption text that should be displayed for this tree item. + */ + caption(): string; - /** - * Returns the caption text that should be displayed for this tree item. - */ - caption(): string; - - /** - * Returns the children ot this tree item. - */ - children(): Object; -} + /** + * Returns the children ot this tree item. + */ + children(): Object; + } } interface OlapResultViewOptions { - /** * Optional="false" an object of type $.ig.OlapResult which represents the full cached result. */ @@ -7564,46 +7524,45 @@ interface OlapResultViewOptions { [optionName: string]: any; } -declare module Infragistics { -export class OlapResultView { - constructor(options: OlapResultViewOptions); +declare namespace Infragistics { + class OlapResultView { + constructor(options: OlapResultViewOptions); - /** - * Creates a new $.ig.OlapResultView object with result object having the same structure as the original one and new visibleResult where the tuples which appear as children under specified tuple and member index are no longer present. - * - * @param axisName - * @param tupleIndex - * @param memberIndex - */ - collapseTupleMember(axisName: Object, tupleIndex: Object, memberIndex: Object): Object; + /** + * Creates a new $.ig.OlapResultView object with result object having the same structure as the original one and new visibleResult where the tuples which appear as children under specified tuple and member index are no longer present. + * + * @param axisName + * @param tupleIndex + * @param memberIndex + */ + collapseTupleMember(axisName: Object, tupleIndex: Object, memberIndex: Object): Object; - /** - * Creates a $.ig.OlapResultView view object with result object having the same structure as the original one and new visibleResult where the tuples which appear as children under specified tuple and member index are accessible as part of the visibleResult. - * - * @param axisName - * @param tupleIndex - * @param memberIndex - */ - expandTupleMember(axisName: Object, tupleIndex: Object, memberIndex: Object): Object; + /** + * Creates a $.ig.OlapResultView view object with result object having the same structure as the original one and new visibleResult where the tuples which appear as children under specified tuple and member index are accessible as part of the visibleResult. + * + * @param axisName + * @param tupleIndex + * @param memberIndex + */ + expandTupleMember(axisName: Object, tupleIndex: Object, memberIndex: Object): Object; - /** - * Creates a new $.ig.OlapResultView object as the axis specified by axisName of the original result object is extended with the tuples of the same axis found into supplied partialResult object. - * - * @param partialResult - * @param axisName - */ - extend(partialResult: Object, axisName: Object): Object; -} + /** + * Creates a new $.ig.OlapResultView object as the axis specified by axisName of the original result object is extended with the tuples of the same axis found into supplied partialResult object. + * + * @param partialResult + * @param axisName + */ + extend(partialResult: Object, axisName: Object): Object; + } } interface IgniteUIStatic { OlapResultView: typeof Infragistics.OlapResultView; } interface OlapTableViewOptionsViewSettings { - /** * Optional="false" a value indicating whether parent for columns is in front of its children. - * If set to true the query set sorts members in a level in their natural order. Their natural order is the default ordering of the members along the hierarchy when no other sort conditions are specified. + * If set to true the query set sorts members in a level in their natural order. Their natural order is the default ordering of the members along the hierarchy when no other sort conditions are specified. * Child members immediately follow their parent members. * If set to false the query set sorts the members in a level using a post-natural order. In other words, child members precede their parents. */ @@ -7611,7 +7570,7 @@ interface OlapTableViewOptionsViewSettings { /** * Optional="false" a value indicating whether parent for rows is in front of its children. - * If set to true the query set sorts members in a level in their natural order. Their natural order is the default ordering of the members along the hierarchy when no other sort conditions are specified. + * If set to true the query set sorts members in a level in their natural order. Their natural order is the default ordering of the members along the hierarchy when no other sort conditions are specified. * Child members immediately follow their parent members. * If set to false the query set sorts the members in a level using a post-natural order. In other words, child members precede their parents. */ @@ -7634,7 +7593,6 @@ interface OlapTableViewOptionsViewSettings { } interface OlapTableViewOptions { - /** * Optional="false" an object of type $.ig.OlapResult. */ @@ -7661,661 +7619,649 @@ interface OlapTableViewOptions { [optionName: string]: any; } -declare module Infragistics { -export class OlapTableView { - constructor(options: OlapTableViewOptions); +declare namespace Infragistics { + class OlapTableView { + constructor(options: OlapTableViewOptions); - /** - * Initializes the table view object as its rowHeaders, columnHeaders and resultCells are created for the result object the table view is related to. - * Applies the items from the columnSortDirections and levelDortDirections to produce the sorted result. - */ - initialize(): void; + /** + * Initializes the table view object as its rowHeaders, columnHeaders and resultCells are created for the result object the table view is related to. + * Applies the items from the columnSortDirections and levelDortDirections to produce the sorted result. + */ + initialize(): void; - /** - * Returns the configuration object this table view is created with. - */ - viewSettings(): Object; + /** + * Returns the configuration object this table view is created with. + */ + viewSettings(): Object; - /** - * Gets or sets the column sort direction items, which will be applied when the $.ig.OlapTableView is initialized. - * - tupleIndex (number): specifies the index of the tuple, which corresponds to a column in the column axis. - * - sortDirection (string: ascending|descending): indicates the sort direction for the column. The allowed values are 'ascending' (default) and 'descending'. - * - comparer (function): an optional function, which will be used to compare the cells from the column. The function should return a number: - * 1. If Cell1 < Cell2, return a value lower than 0. - * 2. If Cell1 == Cell2, return 0. - * 3. If Cell1 > Cell2, return a value greater than 0. - * - * @param columnSortDirections an array of objects, which have the following properties: - */ - columnSortDirections(columnSortDirections?: any[]): any[]; + /** + * Gets or sets the column sort direction items, which will be applied when the $.ig.OlapTableView is initialized. + * - tupleIndex (number): specifies the index of the tuple, which corresponds to a column in the column axis. + * - sortDirection (string: ascending|descending): indicates the sort direction for the column. The allowed values are 'ascending' (default) and 'descending'. + * - comparer (function): an optional function, which will be used to compare the cells from the column. The function should return a number: + * 1. If Cell1 < Cell2, return a value lower than 0. + * 2. If Cell1 == Cell2, return 0. + * 3. If Cell1 > Cell2, return a value greater than 0. + * + * @param columnSortDirections an array of objects, which have the following properties: + */ + columnSortDirections(columnSortDirections?: any[]): any[]; - /** - * Returns the column sort direction items, which were applied during the $.ig.OlapTableView initialization. - */ - appliedColumnSortDirections(): any[]; + /** + * Returns the column sort direction items, which were applied during the $.ig.OlapTableView initialization. + */ + appliedColumnSortDirections(): any[]; - /** - * Gets or sets the level sort direction items, which will be applied when the $.ig.OlapTableView is - * - levelUniqueName (string): the name of the level to be sorted. - * - sortDirection (string: ascending|descending): indicates the sort direction for the level. The allowed values are 'ascending' (default) and 'descending'. - * - sortBehavior (string:alphabetical|system): indicates the type of sorting to be applied. The allowed values are 'alphabetical' (default) and 'system'. - * - * @param levelSortDirections an array of objects, which have the following properties: - */ - levelSortDirections(levelSortDirections?: any[]): any[]; + /** + * Gets or sets the level sort direction items, which will be applied when the $.ig.OlapTableView is + * - levelUniqueName (string): the name of the level to be sorted. + * - sortDirection (string: ascending|descending): indicates the sort direction for the level. The allowed values are 'ascending' (default) and 'descending'. + * - sortBehavior (string: alphabetical|system): indicates the type of sorting to be applied. The allowed values are 'alphabetical' (default) and 'system'. + * + * @param levelSortDirections an array of objects, which have the following properties: + */ + levelSortDirections(levelSortDirections?: any[]): any[]; - /** - * Returns the level sort direction items, which were applied during the $.ig.OlapTableView initialization. - */ - appliedLevelSortDirections(): any[]; + /** + * Returns the level sort direction items, which were applied during the $.ig.OlapTableView initialization. + */ + appliedLevelSortDirections(): any[]; - /** - * Returns a javascript object, which maps the applied level sort directions to the axis name, hierarchy index in the axis and the level depth. - * It is used internally to determine, which $.ig.OlapTableViewHeaderCell needs to display a sorting indicator in the user interface. - */ - appliedSortDirectionsMap(): Object; + /** + * Returns a javascript object, which maps the applied level sort directions to the axis name, hierarchy index in the axis and the level depth. + * It is used internally to determine, which $.ig.OlapTableViewHeaderCell needs to display a sorting indicator in the user interface. + */ + appliedSortDirectionsMap(): Object; - /** - * Returns the table row headers. - */ - rowHeaders(): any[]; + /** + * Returns the table row headers. + */ + rowHeaders(): any[]; - /** - * Returns the table column headers. - */ - columnHeaders(): any[]; + /** + * Returns the table column headers. + */ + columnHeaders(): any[]; - /** - * Returns the table result cells ordered as if the grid is iterated row by row. - */ - resultCells(): any[]; + /** + * Returns the table result cells ordered as if the grid is iterated row by row. + */ + resultCells(): any[]; - /** - * Returns the sorted $.ig.OlapResult object. - */ - result(): Object; -} + /** + * Returns the sorted $.ig.OlapResult object. + */ + result(): Object; + } } interface IgniteUIStatic { OlapTableView: typeof Infragistics.OlapTableView; } -declare module Infragistics { -export class OlapTableViewHeaderCell { +declare namespace Infragistics { + class OlapTableViewHeaderCell { + /** + * Returns the caption for the header cell. + */ + caption(): string; - /** - * Returns the caption for the header cell. - */ - caption(): string; + /** + * Returns the expaned state for the header cell. + */ + isExpanded(): boolean; - /** - * Returns the expaned state for the header cell. - */ - isExpanded(): boolean; + /** + * Indicates whether the header cell can be expanded. + */ + isExpanable(): boolean; - /** - * Indicates whether the header cell can be expanded. - */ - isExpanable(): boolean; + /** + * Returns the row index for the header cell. + */ + rowIndex(): number; - /** - * Returns the row index for the header cell. - */ - rowIndex(): number; + /** + * Returns the row span for the header cell. + */ + rowSpan(): number; - /** - * Returns the row span for the header cell. - */ - rowSpan(): number; + /** + * Returns the column index for the header cell. + */ + columnIndex(): number; - /** - * Returns the column index for the header cell. - */ - columnIndex(): number; + /** + * Returns the column span for the header cell. + */ + columnSpan(): number; - /** - * Returns the column span for the header cell. - */ - columnSpan(): number; + /** + * Returns the name of the axis this header cell is related to. + */ + axisName(): string; - /** - * Returns the name of the axis this header cell is related to. - */ - axisName(): string; + /** + * Returns the index of tuple in the axis this header cell is related to. + */ + tupleIndex(): number; - /** - * Returns the index of tuple in the axis this header cell is related to. - */ - tupleIndex(): number; - - /** - * Returns the index of the axis member in the tuple this header cell is related to. - */ - memberIndex(): number; -} + /** + * Returns the index of the axis member in the tuple this header cell is related to. + */ + memberIndex(): number; + } } -declare module Infragistics { -export class OlapTableViewResultCell { +declare namespace Infragistics { + class OlapTableViewResultCell { + /** + * Returns the value provided by $.ig.Cell object. + */ + value(): Object; - /** - * Returns the value provided by $.ig.Cell object. - */ - value(): Object; + /** + * Returns the formmated value to be displayed by the data cell. + */ + formattedValue(): string; - /** - * Returns the formmated value to be displayed by the data cell. - */ - formattedValue(): string; + /** + * Returns the ordinal of this cell used to determine its position into the data cells' grid. + */ + cellOrdinal(): number; - /** - * Returns the ordinal of this cell used to determine its position into the data cells' grid. - */ - cellOrdinal(): number; - - /** - * Returns the index of $.ig.Cell object in $.ig.OlapResult object. - */ - resultCellIndex(): number; -} + /** + * Returns the index of $.ig.Cell object in $.ig.OlapResult object. + */ + resultCellIndex(): number; + } } -declare module Infragistics { -export class Catalog { +declare namespace Infragistics { + class Catalog { + /** + * Returns the name of the catalog. + * + * @param value + */ + name(value: Object): string; - /** - * Returns the name of the catalog. - * - * @param value - */ - name(value: Object): string; + /** + * Returns the unique name of the catalog. + * + * @param value + */ + uniqueName(value: Object): string; - /** - * Returns the unique name of the catalog. - * - * @param value - */ - uniqueName(value: Object): string; + /** + * Returns the caption of the catalog used when displaying the name of the catalog to the user. + * + * @param value + */ + caption(value: Object): string; - /** - * Returns the caption of the catalog used when displaying the name of the catalog to the user. - * - * @param value - */ - caption(value: Object): string; - - /** - * Returns the description of the catalog which is a human-readable description of the catalog - * - * @param value - */ - description(value: Object): string; -} + /** + * Returns the description of the catalog which is a human-readable description of the catalog + * + * @param value + */ + description(value: Object): string; + } } -declare module Infragistics { -export class Cube { +declare namespace Infragistics { + class Cube { + /** + * Returns the name of the cube. + * + * @param value + */ + name(value: Object): string; - /** - * Returns the name of the cube. - * - * @param value - */ - name(value: Object): string; + /** + * Returns the unique name of the cube. + * + * @param value + */ + uniqueName(value: Object): string; - /** - * Returns the unique name of the cube. - * - * @param value - */ - uniqueName(value: Object): string; + /** + * Returns the caption of the cube used when displaying the name of the cube to the user. + * + * @param value + */ + caption(value: Object): string; - /** - * Returns the caption of the cube used when displaying the name of the cube to the user. - * - * @param value - */ - caption(value: Object): string; + /** + * Returns a user-friendly description of the cube. + * + * @param value + */ + description(value: Object): string; - /** - * Returns a user-friendly description of the cube. - * - * @param value - */ - description(value: Object): string; + /** + * Returns the type of the cube which is a value from the $.ig.CubeType enumeration. + * + * $.ig.CubeType.prototype.cube = 0; + * $.ig.CubeType.prototype.dimension = 1; + * $.ig.CubeType.prototype.unknown = 2; + * + * @param value + */ + cubeType(value: Object): number; - /** - * Returns the type of the cube which is a value from the $.ig.CubeType enumeration. - * - * $.ig.CubeType.prototype.cube = 0; - * $.ig.CubeType.prototype.dimension = 1; - * $.ig.CubeType.prototype.unknown = 2; - * - * @param value - */ - cubeType(value: Object): number; + /** + * Returns the date and time on which the cube was last processed. + * + * @param value + */ + lastProcessed(value: Object): Object; - /** - * Returns the date and time on which the cube was last processed. - * - * @param value - */ - lastProcessed(value: Object): Object; - - /** - * Returns the date and time on which the cube was last updated. - * - * @param value - */ - lastUpdated(value: Object): Object; -} + /** + * Returns the date and time on which the cube was last updated. + * + * @param value + */ + lastUpdated(value: Object): Object; + } } -declare module Infragistics { -export class Dimension { +declare namespace Infragistics { + class Dimension { + /** + * Returns the name of the dimension. + * + * @param value + */ + name(value: Object): string; - /** - * Returns the name of the dimension. - * - * @param value - */ - name(value: Object): string; + /** + * Returns the unique name of the dimension. + * + * @param value + */ + uniqueName(value: Object): string; - /** - * Returns the unique name of the dimension. - * - * @param value - */ - uniqueName(value: Object): string; + /** + * Returns the caption of the dimension used when displaying the name of the dimension to the user. + * + * @param value + */ + caption(value: Object): string; - /** - * Returns the caption of the dimension used when displaying the name of the dimension to the user. - * - * @param value - */ - caption(value: Object): string; + /** + * Returns a user-friendly description of the dimension. + * + * @param value + */ + description(value: Object): string; - /** - * Returns a user-friendly description of the dimension. - * - * @param value - */ - description(value: Object): string; - - /** - * Returns the type of the dimension which is a value from the $.ig.DimensionType enumeration. - * - * $.ig.DimensionType.prototype.unknown = 0; - * $.ig.DimensionType.prototype.time = 1; - * $.ig.DimensionType.prototype.measure = 2; - * $.ig.DimensionType.prototype.other = 3; - * $.ig.DimensionType.prototype.quantitative = 5; - * $.ig.DimensionType.prototype.accounts = 6; - * $.ig.DimensionType.prototype.customers = 7; - * $.ig.DimensionType.prototype.products = 8; - * $.ig.DimensionType.prototype.scenario = 9; - * $.ig.DimensionType.prototype.utility = 10; - * $.ig.DimensionType.prototype.currency = 11; - * $.ig.DimensionType.prototype.rates = 12; - * $.ig.DimensionType.prototype.channel = 13; - * $.ig.DimensionType.prototype.promotion = 14; - * $.ig.DimensionType.prototype.organization = 15; - * $.ig.DimensionType.prototype.billOfMaterials = 16; - * $.ig.DimensionType.prototype.geography = 17; - * - * @param value - */ - dimensionType(value: Object): number; -} + /** + * Returns the type of the dimension which is a value from the $.ig.DimensionType enumeration. + * + * $.ig.DimensionType.prototype.unknown = 0; + * $.ig.DimensionType.prototype.time = 1; + * $.ig.DimensionType.prototype.measure = 2; + * $.ig.DimensionType.prototype.other = 3; + * $.ig.DimensionType.prototype.quantitative = 5; + * $.ig.DimensionType.prototype.accounts = 6; + * $.ig.DimensionType.prototype.customers = 7; + * $.ig.DimensionType.prototype.products = 8; + * $.ig.DimensionType.prototype.scenario = 9; + * $.ig.DimensionType.prototype.utility = 10; + * $.ig.DimensionType.prototype.currency = 11; + * $.ig.DimensionType.prototype.rates = 12; + * $.ig.DimensionType.prototype.channel = 13; + * $.ig.DimensionType.prototype.promotion = 14; + * $.ig.DimensionType.prototype.organization = 15; + * $.ig.DimensionType.prototype.billOfMaterials = 16; + * $.ig.DimensionType.prototype.geography = 17; + * + * @param value + */ + dimensionType(value: Object): number; + } } -declare module Infragistics { -export class Hierarchy { +declare namespace Infragistics { + class Hierarchy { + /** + * Returns the name of the hierarchy. + * + * @param value + */ + name(value: Object): string; - /** - * Returns the name of the hierarchy. - * - * @param value - */ - name(value: Object): string; + /** + * Returns the unique name of the hierarchy. + * + * @param value + */ + uniqueName(value: Object): string; - /** - * Returns the unique name of the hierarchy. - * - * @param value - */ - uniqueName(value: Object): string; + /** + * Returns the caption of the hierarchy used when displaying the name of the hierarchy to the user. + * + * @param value + */ + caption(value: Object): string; - /** - * Returns the caption of the hierarchy used when displaying the name of the hierarchy to the user. - * - * @param value - */ - caption(value: Object): string; + /** + * Returns a user-friendly description of the hierarchy. + * + * @param value + */ + description(value: Object): string; - /** - * Returns a user-friendly description of the hierarchy. - * - * @param value - */ - description(value: Object): string; + /** + * Returns the unique name of the default member for the hierarchy. + * + * @param value + */ + defaultMember(value: Object): string; - /** - * Returns the unique name of the default member for the hierarchy. - * - * @param value - */ - defaultMember(value: Object): string; + /** + * Returns the unique name of the 'All' member for the hierarchy. + * + * @param value + */ + allMember(value: Object): string; - /** - * Returns the unique name of the 'All' member for the hierarchy. - * - * @param value - */ - allMember(value: Object): string; + /** + * Returns the unique name of the dimension that contains the hierarchy. + * + * @param value + */ + dimensionUniqueName(value: Object): string; - /** - * Returns the unique name of the dimension that contains the hierarchy. - * - * @param value - */ - dimensionUniqueName(value: Object): string; + /** + * Returns the source of the hierarchy which is a value from the $.ig.HierarchyOrigin enumeration. + * + * $.ig.HierarchyOrigin.prototype.userDefined = 1; + * Identifies user defined hierarchies. + * + * $.ig.HierarchyOrigin.prototype.systemEnabled = 2; + * Identifies attribute hierarchies. + * + * $.ig.HierarchyOrigin.prototype.systemInternal = 4; + * Identifies attributes with no attribute . + * + * @param value + */ + hierarchyOrigin(value: Object): number; - /** - * Returns the source of the hierarchy which is a value from the $.ig.HierarchyOrigin enumeration. - * - * $.ig.HierarchyOrigin.prototype.userDefined = 1; - * Identifies user defined hierarchies. - * - * $.ig.HierarchyOrigin.prototype.systemEnabled = 2; - * Identifies attribute hierarchies. - * - * $.ig.HierarchyOrigin.prototype.systemInternal = 4; - * Identifies attributes with no attribute . - * - * @param value - */ - hierarchyOrigin(value: Object): number; - - /** - * Returns the hierarchy display folder path to be used when displaying the hierarchy in the user interface. - * Folder names will be separated by a semicolon (;). Nested folders are indicated by a backslash (\). - * - * @param value - */ - hierarchyDisplayFolder(value: Object): string; -} + /** + * Returns the hierarchy display folder path to be used when displaying the hierarchy in the user interface. + * Folder names will be separated by a semicolon (;). Nested folders are indicated by a backslash (\). + * + * @param value + */ + hierarchyDisplayFolder(value: Object): string; + } } -declare module Infragistics { -export class Measure { +declare namespace Infragistics { + class Measure { + /** + * Returns the name of the measure. + * + * @param value + */ + name(value: Object): string; - /** - * Returns the name of the measure. - * - * @param value - */ - name(value: Object): string; + /** + * Returns the unique name of the measure. + * + * @param value + */ + uniqueName(value: Object): string; - /** - * Returns the unique name of the measure. - * - * @param value - */ - uniqueName(value: Object): string; + /** + * Returns the caption of the measure used when displaying the name of the measure to the user. + * + * @param value + */ + caption(value: Object): string; - /** - * Returns the caption of the measure used when displaying the name of the measure to the user. - * - * @param value - */ - caption(value: Object): string; + /** + * Returns a user-friendly description of the measure. + * + * @param value + */ + description(value: Object): string; - /** - * Returns a user-friendly description of the measure. - * - * @param value - */ - description(value: Object): string; + /** + * Returns the name of the measure group this measure belongs to. + * + * @param value + */ + measureGroupName(value: Object): string; - /** - * Returns the name of the measure group this measure belongs to. - * - * @param value - */ - measureGroupName(value: Object): string; + /** + * Returns the aggregator type that identifies how a measure was derived. It is a value from the $.ig.AggregatorType enumeration. + * + * $.ig.AggregatorType.prototype.unknown = 0; + * The aggregated function is undefined. + * + * $.ig.AggregatorType.prototype.sum = 1; + * The aggregated function adds all values. + * + * $.ig.AggregatorType.prototype.count = 2; + * The aggregated function will count the number of the values. + * + * $.ig.AggregatorType.prototype.min = 3; + * The aggregated function will returns the smallest value. + * + * $.ig.AggregatorType.prototype.max = 4; + * The aggregated function will returns the largest value. + * + * $.ig.AggregatorType.prototype.average = 5; + * The aggregated function will returns the average of cells value. + * + * $.ig.AggregatorType.prototype.variance = 6; + * The aggregated function will estimates variance based on the sample. + * + * $.ig.AggregatorType.prototype.std = 7; + * The aggregated function will estimates the standart deviation based on sample. + * + * $.ig.AggregatorType.prototype.distinctCount = 8; + * The aggregated function will returns the number of distinct, nonempty tuples in a set. + * + * $.ig.AggregatorType.prototype.none = 9; + * No aggregation performed. + * + * $.ig.AggregatorType.prototype.averageOfChildren = 10; + * The aggregated function will returns the average of the measure's children. + * + * $.ig.AggregatorType.prototype.firstNonEmpty = 13; + * The aggregated function will returns the measure's first nonempty member. + * + * $.ig.AggregatorType.prototype.lastNonEmpty = 14; + * The aggregated function will returns the measure's last nonempty member. + * + * $.ig.AggregatorType.prototype.byAccount = 15; + * Aggregated by the aggregation function associated with the specified account type of an attribute in an account dimension. + * + * $.ig.AggregatorType.prototype.calculated = 127; + * The aggregated function will returns the result derived from a formula. + * + * @param value + */ + aggregatorType(value: Object): number; - /** - * Returns the aggregator type that identifies how a measure was derived. It is a value from the $.ig.AggregatorType enumeration. - * - * $.ig.AggregatorType.prototype.unknown = 0; - * The aggregated function is undefined. - * - * $.ig.AggregatorType.prototype.sum = 1; - * The aggregated function adds all values. - * - * $.ig.AggregatorType.prototype.count = 2; - * The aggregated function will count the number of the values. - * - * $.ig.AggregatorType.prototype.min = 3; - * The aggregated function will returns the smallest value. - * - * $.ig.AggregatorType.prototype.max = 4; - * The aggregated function will returns the largest value. - * - * $.ig.AggregatorType.prototype.average = 5; - * The aggregated function will returns the average of cells value. - * - * $.ig.AggregatorType.prototype.variance = 6; - * The aggregated function will estimates variance based on the sample. - * - * $.ig.AggregatorType.prototype.std = 7; - * The aggregated function will estimates the standart deviation based on sample. - * - * $.ig.AggregatorType.prototype.distinctCount = 8; - * The aggregated function will returns the number of distinct, nonempty tuples in a set. - * - * $.ig.AggregatorType.prototype.none = 9; - * No aggregation performed. - * - * $.ig.AggregatorType.prototype.averageOfChildren = 10; - * The aggregated function will returns the average of the measure's children. - * - * $.ig.AggregatorType.prototype.firstNonEmpty = 13; - * The aggregated function will returns the measure's first nonempty member. - * - * $.ig.AggregatorType.prototype.lastNonEmpty = 14; - * The aggregated function will returns the measure's last nonempty member. - * - * $.ig.AggregatorType.prototype.byAccount = 15; - * Aggregated by the aggregation function associated with the specified account type of an attribute in an account dimension. - * - * $.ig.AggregatorType.prototype.calculated = 127; - * The aggregated function will returns the result derived from a formula. - * - * @param value - */ - aggregatorType(value: Object): number; + /** + * Returns the default format string for the measure. + * + * @param value + */ + defaultFormatString(value: Object): string; - /** - * Returns the default format string for the measure. - * - * @param value - */ - defaultFormatString(value: Object): string; - - /** - * Returns the measure display folder path to be used when displaying the measure in the user interface. - * Folder names will be separated by a semicolon (;). Nested folders are indicated by a backslash (\). - * - * @param value - */ - measureDisplayFolder(value: Object): string; -} + /** + * Returns the measure display folder path to be used when displaying the measure in the user interface. + * Folder names will be separated by a semicolon (;). Nested folders are indicated by a backslash (\). + * + * @param value + */ + measureDisplayFolder(value: Object): string; + } } -declare module Infragistics { -export class Level { +declare namespace Infragistics { + class Level { + /** + * Returns the name of the level. + * + * @param value + */ + name(value: Object): string; - /** - * Returns the name of the level. - * - * @param value - */ - name(value: Object): string; + /** + * Returns the unique name of the level. + * + * @param value + */ + uniqueName(value: Object): string; - /** - * Returns the unique name of the level. - * - * @param value - */ - uniqueName(value: Object): string; + /** + * Returns the caption of the level used when displaying the name of the level to the user. + * + * @param value + */ + caption(value: Object): string; - /** - * Returns the caption of the level used when displaying the name of the level to the user. - * - * @param value - */ - caption(value: Object): string; + /** + * Returns a user-friendly description of the level. + * + * @param value + */ + description(value: Object): string; - /** - * Returns a user-friendly description of the level. - * - * @param value - */ - description(value: Object): string; + /** + * Returns the distance of the level from the root of the level. Root level is zero (0) + * + * @param value + */ + depth(value: Object): number; - /** - * Returns the distance of the level from the root of the level. Root level is zero (0) - * - * @param value - */ - depth(value: Object): number; + /** + * Returns the unique name of the hierarchy that contains the level. + * + * @param value + */ + hierarchyUniqueName(value: Object): string; - /** - * Returns the unique name of the hierarchy that contains the level. - * - * @param value - */ - hierarchyUniqueName(value: Object): string; + /** + * Returns the unique name of the dimension that contains the level. + * + * @param value + */ + dimensionUniqueName(value: Object): string; - /** - * Returns the unique name of the dimension that contains the level. - * - * @param value - */ - dimensionUniqueName(value: Object): string; + /** + * Returns the count of all members in the level. + * + * @param value + */ + membersCount(value: Object): number; - /** - * Returns the count of all members in the level. - * - * @param value - */ - membersCount(value: Object): number; + /** + * Returns a value that defines how the level was sourced. + * + * @param value + */ + levelOrigin(value: Object): number; - /** - * Returns a value that defines how the level was sourced. - * - * @param value - */ - levelOrigin(value: Object): number; - - /** - * Returns the ID of the attribute that the level is sorted on. - * - * @param value - */ - levelOrderingProperty(value: Object): number; -} + /** + * Returns the ID of the attribute that the level is sorted on. + * + * @param value + */ + levelOrderingProperty(value: Object): number; + } } -declare module Infragistics { -export class MeasureGroup { +declare namespace Infragistics { + class MeasureGroup { + /** + * Returns the name of the measure group. + * + * @param value + */ + name(value: Object): string; - /** - * Returns the name of the measure group. - * - * @param value - */ - name(value: Object): string; + /** + * Returns the caption of the measure group used when displaying the name of the measure group to the user. + * + * @param value + */ + caption(value: Object): string; - /** - * Returns the caption of the measure group used when displaying the name of the measure group to the user. - * - * @param value - */ - caption(value: Object): string; + /** + * Returns a user-friendly description of the measure group. + * + * @param value + */ + description(value: Object): string; - /** - * Returns a user-friendly description of the measure group. - * - * @param value - */ - description(value: Object): string; + /** + * Returns the name of the catalog to which this measure group belongs. + * + * @param value + */ + catalogName(value: Object): string; - /** - * Returns the name of the catalog to which this measure group belongs. - * - * @param value - */ - catalogName(value: Object): string; - - /** - * Returns the name of the cube to which this measure group belongs - * - * @param value - */ - cubeName(value: Object): string; -} + /** + * Returns the name of the cube to which this measure group belongs + * + * @param value + */ + cubeName(value: Object): string; + } } -declare module Infragistics { -export class MeasureList { +declare namespace Infragistics { + class MeasureList { + /** + * Returns the caption of the measure list used when displaying the name of the measure list to the user. + * + * @param value + */ + caption(value: Object): string; - /** - * Returns the caption of the measure list used when displaying the name of the measure list to the user. - * - * @param value - */ - caption(value: Object): string; - - /** - * Returns an array of $.ig.Measure objects this measure list is grouping. - * - * @param value - */ - measures(value: Object): any[]; -} + /** + * Returns an array of $.ig.Measure objects this measure list is grouping. + * + * @param value + */ + measures(value: Object): any[]; + } } -declare module Infragistics { -export class OlapResult { +declare namespace Infragistics { + class OlapResult { + /** + * Returns a value indicating whether the result object contains any data. + * + * @param value + */ + isEmpty(value: Object): boolean; - /** - * Returns a value indicating whether the result object contains any data. - * - * @param value - */ - isEmpty(value: Object): boolean; + /** + * Returns an array of $.ig.OlapResultAxis objects this result is built on. + * + * @param value + */ + axes(value: Object): any[]; - /** - * Returns an array of $.ig.OlapResultAxis objects this result is built on. - * - * @param value - */ - axes(value: Object): any[]; - - /** - * Returns an array of $.ig.OlapResultCell objects which hold the result data. - * - * @param value - */ - cells(value: Object): any[]; -} + /** + * Returns an array of $.ig.OlapResultCell objects which hold the result data. + * + * @param value + */ + cells(value: Object): any[]; + } } interface OlapResultAxisOptions { - /** * Optional="false" array of $.ig.OlapResultTuple objects which form the axis. */ @@ -8332,27 +8278,26 @@ interface OlapResultAxisOptions { [optionName: string]: any; } -declare module Infragistics { -export class OlapResultAxis { - constructor(options: OlapResultAxisOptions); +declare namespace Infragistics { + class OlapResultAxis { + constructor(options: OlapResultAxisOptions); - /** - * Returns an array of $.ig.OlapResultTuple objects which form the axis. - */ - tuples(): any[]; + /** + * Returns an array of $.ig.OlapResultTuple objects which form the axis. + */ + tuples(): any[]; - /** - * Returns the count of the $.ig.OlapResultAxisMember objects of each tuple. - */ - tupleSize(): number; -} + /** + * Returns the count of the $.ig.OlapResultAxisMember objects of each tuple. + */ + tupleSize(): number; + } } interface IgniteUIStatic { OlapResultAxis: typeof Infragistics.OlapResultAxis; } interface OlapResultTupleOptions { - /** * Optional="false" array of $.ig.OlapResultAxisMember objects which form the tuple object. */ @@ -8364,143 +8309,140 @@ interface OlapResultTupleOptions { [optionName: string]: any; } -declare module Infragistics { -export class OlapResultTuple { - constructor(options: OlapResultTupleOptions); +declare namespace Infragistics { + class OlapResultTuple { + constructor(options: OlapResultTupleOptions); - /** - * Returns an array of $.ig.OlapResultTuple objects which form the axis. - */ - members(): any[]; -} + /** + * Returns an array of $.ig.OlapResultTuple objects which form the axis. + */ + members(): any[]; + } } interface IgniteUIStatic { OlapResultTuple: typeof Infragistics.OlapResultTuple; } -declare module Infragistics { -export class OlapResultAxisMember { +declare namespace Infragistics { + class OlapResultAxisMember { + /** + * Returns the unique name of the axis member. + * + * @param value + */ + uniqueName(value: Object): string; - /** - * Returns the unique name of the axis member. - * - * @param value - */ - uniqueName(value: Object): string; + /** + * Returns the caption of the axis member used when displaying the name of the axis member to the user. + * + * @param value + */ + caption(value: Object): string; - /** - * Returns the caption of the axis member used when displaying the name of the axis member to the user. - * - * @param value - */ - caption(value: Object): string; + /** + * Returns the unique name of the level this member belongs to. + * + * @param value + */ + levelUniqueName(value: Object): string; - /** - * Returns the unique name of the level this member belongs to. - * - * @param value - */ - levelUniqueName(value: Object): string; + /** + * Returns the unique name of the hierarchy that contains the level. + * + * @param value + */ + hierarchyUniqueName(value: Object): string; - /** - * Returns the unique name of the hierarchy that contains the level. - * - * @param value - */ - hierarchyUniqueName(value: Object): string; + /** + * Returns the distance of member parent level from the root of the level. Root level is zero (0) + * + * @param value + */ + levelNumber(value: Object): number; - /** - * Returns the distance of member parent level from the root of the level. Root level is zero (0) - * - * @param value - */ - levelNumber(value: Object): number; + /** + * A bitmap of the information projected by childCount, drilledDown and parentSameAsPrev properties. + * + * @param value + */ + displayInfo(value: Object): number; - /** - * A bitmap of the information projected by childCount, drilledDown and parentSameAsPrev properties. - * - * @param value - */ - displayInfo(value: Object): number; + /** + * Returns the count of children members this member has. + * + * @param value + */ + childCount(value: Object): number; - /** - * Returns the count of children members this member has. - * - * @param value - */ - childCount(value: Object): number; + /** + * Returns a value that indicates whether at least one child of this member appears on the axis, immediately following all occurrences of that member. This can be used by applications to display a "+" or a "-" next to the member. + * + * @param value + */ + drilledDown(value: Object): boolean; - /** - * Returns a value that indicates whether at least one child of this member appears on the axis, immediately following all occurrences of that member. This can be used by applications to display a "+" or a "-" next to the member. - * - * @param value - */ - drilledDown(value: Object): boolean; + /** + * Returns a value that indicates whether the parent of this member is the same as the parent of the member preceding all occurrences of the current member. + * + * @param value + */ + parentSameAsPrev(value: Object): boolean; - /** - * Returns a value that indicates whether the parent of this member is the same as the parent of the member preceding all occurrences of the current member. - * - * @param value - */ - parentSameAsPrev(value: Object): boolean; - - /** - * Returns a key value map of the members' properties. By default only 'PARENT_UNIQUE_NAME' and 'CHILDREN_CARDINALITY' properties are available. - * - * @param value - */ - properties(value: Object): Object; -} + /** + * Returns a key value map of the members' properties. By default only 'PARENT_UNIQUE_NAME' and 'CHILDREN_CARDINALITY' properties are available. + * + * @param value + */ + properties(value: Object): Object; + } } -declare module Infragistics { -export class OlapResultCell { +declare namespace Infragistics { + class OlapResultCell { + /** + * Returns the position of the cell when cells are iterated row by row. + * + * @param value + */ + cellOrdinal(value: Object): number; - /** - * Returns the position of the cell when cells are iterated row by row. - * - * @param value - */ - cellOrdinal(value: Object): number; - - /** - * Returns a key value map of the cell's properties. Currently only 'Value' and 'FmtValue' properties are available. - * - * @param value - */ - properties(value: Object): Object; -} + /** + * Returns a key value map of the cell's properties. Currently only 'Value' and 'FmtValue' properties are available. + * + * @param value + */ + properties(value: Object): Object; + } } interface IgTemplatingRegExp { - /** * Option for IgTemplatingRegExp */ [optionName: string]: any; } -declare module Infragistics { -export class igTemplating { - constructor(regExp: IgTemplatingRegExp); +declare namespace Infragistics { + class igTemplating { + constructor(regExp: IgTemplatingRegExp); - /** - * Populates the given template with the provided data. If data is a function that requires arguments, the arguments need to be provided as an array following the data. tmpl(template, data[, args]) - * - * @param template Specifies the template string - * @param data Specifies the data to be templated in the template. If function is provided, then it has to be object or array returning function, possible receiving arguments array which can be specified as the third parameter - * @param args If function is provided as the second parameter, then this parameter is the arguments for the function. - */ - tmpl(template: string, data: Object, args?: any[]): string; - clearTmplCache(): void; + /** + * Populates the given template with the provided data. If data is a function that requires arguments, the arguments need to be provided as an array following the data. tmpl(template, data[, args]) + * + * @param template Specifies the template string + * @param data Specifies the data to be templated in the template. If function is provided, then it has to be object or array returning function, possible receiving arguments array which can be specified as the third parameter + * @param args If function is provided as the second parameter, then this parameter is the arguments for the function. + */ + tmpl(template: string, data: Object, args?: any[]): string; + clearTmplCache(): void; - /** - * Encoding < > ' and " - * - * @param value The string to be encoded. - */ - encode(value: string): string; -} + /** + * Encoding < > ' and " + * + * @param value The string to be encoded. + */ + encode(value: string): string; + } } interface IgniteUIStatic { igTemplating: typeof Infragistics.igTemplating; @@ -8511,7 +8453,6 @@ interface ErrorMessageDisplayingEvent { } interface ErrorMessageDisplayingEventUIParam { - /** * Used to obtain reference to the barcode widget. */ @@ -8528,7 +8469,6 @@ interface DataChangedEvent { } interface DataChangedEventUIParam { - /** * Used to obtain reference to the barcode widget. */ @@ -8541,7 +8481,6 @@ interface DataChangedEventUIParam { } interface IgQRCodeBarcode { - /** * The width of the barcode. It can be set as a number in pixels, string (px) or percentage (%). */ @@ -8596,9 +8535,9 @@ interface IgQRCodeBarcode { * Gets or sets the stretch. * * Valid values: - * "none" - * "fill" - * "uniform" + * "none" + * "fill" + * "uniform" * "uniformToFill" */ stretch?: string; @@ -8694,7 +8633,7 @@ interface IgQRCodeBarcode { encodingMode?: string; /** - * Each Extended Channel Interpretation (ECI) is designated by a six-digit assignment number: 000000 - 999999. + * Each Extended Channel Interpretation (ECI) is designated by a six-digit assignment number: 000000 - 999999. * The default value depends on the loaded encodings. The default is ECI 000003 (representing ISO/IEC 8859-1) if the ISO/IEC 8859-1 character set is loaded. Otherwise the default value is 000026 (representing UTF-8). */ eciNumber?: number; @@ -8746,7 +8685,6 @@ interface IgQRCodeBarcode { [optionName: string]: any; } interface IgQRCodeBarcodeMethods { - /** * Returns information about how the barcode is rendered. */ @@ -8768,7 +8706,7 @@ interface IgQRCodeBarcodeMethods { styleUpdated(): void; } interface JQuery { - data(propertyName: "igQRCodeBarcode"):IgQRCodeBarcodeMethods; + data(propertyName: "igQRCodeBarcode"): IgQRCodeBarcodeMethods; } interface JQuery { @@ -8982,13 +8920,13 @@ interface JQuery { igQRCodeBarcode(optionLiteral: 'option', optionName: "encodingMode", optionValue: string): void; /** - * Each Extended Channel Interpretation (ECI) is designated by a six-digit assignment number: 000000 - 999999. + * Each Extended Channel Interpretation (ECI) is designated by a six-digit assignment number: 000000 - 999999. * The default value depends on the loaded encodings. The default is ECI 000003 (representing ISO/IEC 8859-1) if the ISO/IEC 8859-1 character set is loaded. Otherwise the default value is 000026 (representing UTF-8). */ igQRCodeBarcode(optionLiteral: 'option', optionName: "eciNumber"): number; /** - * Each Extended Channel Interpretation (ECI) is designated by a six-digit assignment number: 000000 - 999999. + * Each Extended Channel Interpretation (ECI) is designated by a six-digit assignment number: 000000 - 999999. * The default value depends on the loaded encodings. The default is ECI 000003 (representing ISO/IEC 8859-1) if the ISO/IEC 8859-1 character set is loaded. Otherwise the default value is 000026 (representing UTF-8). * * @optionValue New value to be set. @@ -9079,7 +9017,6 @@ interface DataBindingEvent { } interface DataBindingEventUIParam { - /** * Used to obtain reference to chart widget. */ @@ -9096,7 +9033,6 @@ interface DataBoundEvent { } interface DataBoundEventUIParam { - /** * Used to obtain reference to chart widget. */ @@ -9118,7 +9054,6 @@ interface UpdateTooltipEvent { } interface UpdateTooltipEventUIParam { - /** * Used to obtain reference to chart widget. */ @@ -9155,7 +9090,6 @@ interface HideTooltipEvent { } interface HideTooltipEventUIParam { - /** * Used to obtain reference to chart widget. */ @@ -9173,7 +9107,6 @@ interface HideTooltipEventUIParam { } interface IgBaseChart { - /** * The width of the chart. */ @@ -9269,7 +9202,6 @@ interface IgBaseChart { [optionName: string]: any; } interface IgBaseChartMethods { - /** * Find index of item within actual data used by chart. * @@ -9373,7 +9305,7 @@ interface IgBaseChartMethods { destroy(): void; } interface JQuery { - data(propertyName: "igBaseChart"):IgBaseChartMethods; + data(propertyName: "igBaseChart"): IgBaseChartMethods; } interface JQuery { @@ -9602,7 +9534,6 @@ interface JQuery { igBaseChart(methodName: string, ...methodParams: any[]): any; } interface IgBulletGraphRange { - /** * Gets or sets the name of the range. */ @@ -9678,7 +9609,6 @@ interface AlignLabelEventUIParam { } interface IgBulletGraph { - /** * The width of the gauge. It can be set as a number in pixels, string (px) or percentage (%). */ @@ -9713,7 +9643,7 @@ interface IgBulletGraph { * Gets or sets the orientation of the scale. * * Valid values: - * "horizontal" + * "horizontal" * "vertical" */ orientation?: string; @@ -9993,7 +9923,6 @@ interface IgBulletGraph { [optionName: string]: any; } interface IgBulletGraphMethods { - /** * Returns a string containing the names of all the ranges delimited with a \n symbol. */ @@ -10041,7 +9970,7 @@ interface IgBulletGraphMethods { styleUpdated(): void; } interface JQuery { - data(propertyName: "igBulletGraph"):IgBulletGraphMethods; + data(propertyName: "igBulletGraph"): IgBulletGraphMethods; } interface JQuery { @@ -10807,7 +10736,6 @@ interface PropertyChangedEventUIParam { } interface IgCategoryChart { - /** * Gets or sets the data value corresponding to the minimum value of the Y-axis. */ @@ -11158,9 +11086,9 @@ interface IgCategoryChart { * Gets or sets horizontal alignment which determines the title position, relative to the left and right edges of the chart. * * Valid values: - * "left" - * "center" - * "right" + * "left" + * "center" + * "right" * "stretch" */ titleAlignment?: string; @@ -11169,9 +11097,9 @@ interface IgCategoryChart { * Gets or sets horizontal alignment which determines the subtitle position, relative to the left and right edges of the chart. * * Valid values: - * "left" - * "center" - * "right" + * "left" + * "center" + * "right" * "stretch" */ subtitleAlignment?: string; @@ -11181,7 +11109,7 @@ interface IgCategoryChart { * * * Valid values: - * "linearInterpolate" + * "linearInterpolate" * "dontPlot" */ unknownValuePlotting?: string; @@ -11190,7 +11118,7 @@ interface IgCategoryChart { * Gets or sets behavior for markers in each series which are placed too close together for the current view, resulting in a collision. * * Valid values: - * "none" + * "none" * "omit" */ markerCollisionAvoidance?: string; @@ -11204,25 +11132,25 @@ interface IgCategoryChart { * Gets or sets the method that determines how to animate series plots when the chart is loading into view * * Valid values: - * "auto" - * "fromZero" - * "sweepFromLeft" - * "sweepFromRight" - * "sweepFromTop" - * "sweepFromBottom" - * "sweepFromCenter" - * "accordionFromLeft" - * "accordionFromRight" - * "accordionFromTop" - * "accordionFromBottom" - * "expand" - * "sweepFromCategoryAxisMinimum" - * "sweepFromCategoryAxisMaximum" - * "sweepFromValueAxisMinimum" - * "sweepFromValueAxisMaximum" - * "accordionFromCategoryAxisMinimum" - * "accordionFromCategoryAxisMaximum" - * "accordionFromValueAxisMinimum" + * "auto" + * "fromZero" + * "sweepFromLeft" + * "sweepFromRight" + * "sweepFromTop" + * "sweepFromBottom" + * "sweepFromCenter" + * "accordionFromLeft" + * "accordionFromRight" + * "accordionFromTop" + * "accordionFromBottom" + * "expand" + * "sweepFromCategoryAxisMinimum" + * "sweepFromCategoryAxisMaximum" + * "sweepFromValueAxisMinimum" + * "sweepFromValueAxisMaximum" + * "accordionFromCategoryAxisMinimum" + * "accordionFromCategoryAxisMaximum" + * "accordionFromValueAxisMinimum" * "accordionFromValueAxisMaximum" */ transitionInMode?: string; @@ -11231,10 +11159,10 @@ interface IgCategoryChart { * Gets or sets the arrival speed used for animating series plots when the chart is loading into view * * Valid values: - * "auto" - * "normal" - * "valueScaled" - * "indexScaled" + * "auto" + * "normal" + * "valueScaled" + * "indexScaled" * "random" */ transitionInSpeedType?: string; @@ -11451,19 +11379,19 @@ interface IgCategoryChart { * Gets or sets the formula used for calculating trend lines in this chart. * * Valid values: - * "none" - * "linearFit" - * "quadraticFit" - * "cubicFit" - * "quarticFit" - * "quinticFit" - * "logarithmicFit" - * "exponentialFit" - * "powerLawFit" - * "simpleAverage" - * "exponentialAverage" - * "modifiedAverage" - * "cumulativeAverage" + * "none" + * "linearFit" + * "quadraticFit" + * "cubicFit" + * "quarticFit" + * "quinticFit" + * "logarithmicFit" + * "exponentialFit" + * "powerLawFit" + * "simpleAverage" + * "exponentialAverage" + * "modifiedAverage" + * "cumulativeAverage" * "weightedAverage" */ trendLineType?: string; @@ -11516,9 +11444,9 @@ interface IgCategoryChart { * Gets or sets the horizontal alignment of the X-axis title. * * Valid values: - * "left" - * "center" - * "right" + * "left" + * "center" + * "right" * "stretch" */ xAxisTitleAlignment?: string; @@ -11527,9 +11455,9 @@ interface IgCategoryChart { * Gets or sets the vertical alignment of the Y-axis title. * * Valid values: - * "top" - * "center" - * "bottom" + * "top" + * "center" + * "bottom" * "stretch" */ yAxisTitleAlignment?: string; @@ -11538,9 +11466,9 @@ interface IgCategoryChart { * Gets or sets the horizontal alignment of X-axis labels. * * Valid values: - * "left" - * "center" - * "right" + * "left" + * "center" + * "right" * "stretch" */ xAxisLabelHorizontalAlignment?: string; @@ -11549,9 +11477,9 @@ interface IgCategoryChart { * Gets or sets the horizontal alignment of Y-axis labels. * * Valid values: - * "left" - * "center" - * "right" + * "left" + * "center" + * "right" * "stretch" */ yAxisLabelHorizontalAlignment?: string; @@ -11560,9 +11488,9 @@ interface IgCategoryChart { * Gets or sets the vertical alignment of X-axis labels. * * Valid values: - * "top" - * "center" - * "bottom" + * "top" + * "center" + * "bottom" * "stretch" */ xAxisLabelVerticalAlignment?: string; @@ -11571,9 +11499,9 @@ interface IgCategoryChart { * Gets or sets the vertical alignment of Y-axis labels. * * Valid values: - * "top" - * "center" - * "bottom" + * "top" + * "center" + * "bottom" * "stretch" */ yAxisLabelVerticalAlignment?: string; @@ -11582,7 +11510,7 @@ interface IgCategoryChart { * Gets or sets the visibility of X-axis labels. * * Valid values: - * "visible" + * "visible" * "collapsed" */ xAxisLabelVisibility?: string; @@ -11591,7 +11519,7 @@ interface IgCategoryChart { * Gets or sets the visibility of Y-axis labels. * * Valid values: - * "visible" + * "visible" * "collapsed" */ yAxisLabelVisibility?: string; @@ -11798,7 +11726,7 @@ interface IgCategoryChartMethods { dataBind(): void; } interface JQuery { - data(propertyName: "igCategoryChart"):IgCategoryChartMethods; + data(propertyName: "igCategoryChart"): IgCategoryChartMethods; } interface JQuery { @@ -13645,7 +13573,6 @@ interface JQuery { igCategoryChart(methodName: string, ...methodParams: any[]): any; } interface IgDataChartCrosshairPoint { - /** * The x coordinate. */ @@ -13663,7 +13590,6 @@ interface IgDataChartCrosshairPoint { } interface IgDataChartLegend { - /** * The name of the element to turn into a legend. */ @@ -13702,7 +13628,6 @@ interface IgDataChartLegend { } interface IgDataChartAxes { - /** * Type of the axis. * @@ -14105,7 +14030,6 @@ interface IgDataChartAxes { } interface IgDataChartSeriesLegend { - /** * The name of the element to turn into a legend. */ @@ -14144,7 +14068,6 @@ interface IgDataChartSeriesLegend { } interface IgDataChartSeries { - /** * Type of the series. * @@ -14871,7 +14794,6 @@ interface TooltipShowingEvent { } interface TooltipShowingEventUIParam { - /** * Used to get reference to tooltip DOM element. */ @@ -14908,7 +14830,6 @@ interface TooltipShownEvent { } interface TooltipShownEventUIParam { - /** * Used to get reference to tooltip DOM element. */ @@ -14945,7 +14866,6 @@ interface TooltipHidingEvent { } interface TooltipHidingEventUIParam { - /** * Used to get reference to tooltip DOM element. */ @@ -14982,7 +14902,6 @@ interface TooltipHiddenEvent { } interface TooltipHiddenEventUIParam { - /** * Used to get reference to tooltip DOM element. */ @@ -15026,7 +14945,6 @@ interface SeriesCursorMouseMoveEvent { } interface SeriesCursorMouseMoveEventUIParam { - /** * Used to get reference to current series item object. */ @@ -15068,7 +14986,6 @@ interface SeriesMouseLeftButtonDownEvent { } interface SeriesMouseLeftButtonDownEventUIParam { - /** * Used to get reference to current series item object. */ @@ -15110,7 +15027,6 @@ interface SeriesMouseLeftButtonUpEvent { } interface SeriesMouseLeftButtonUpEventUIParam { - /** * Used to get reference to current series item object. */ @@ -15152,7 +15068,6 @@ interface SeriesMouseMoveEvent { } interface SeriesMouseMoveEventUIParam { - /** * Used to get reference to current series item object. */ @@ -15194,7 +15109,6 @@ interface SeriesMouseEnterEvent { } interface SeriesMouseEnterEventUIParam { - /** * Used to get reference to current series item object. */ @@ -15236,7 +15150,6 @@ interface SeriesMouseLeaveEvent { } interface SeriesMouseLeaveEventUIParam { - /** * Used to get reference to current series item object. */ @@ -15278,7 +15191,6 @@ interface WindowRectChangedEvent { } interface WindowRectChangedEventUIParam { - /** * Used to get reference to chart object. */ @@ -15330,7 +15242,6 @@ interface GridAreaRectChangedEvent { } interface GridAreaRectChangedEventUIParam { - /** * Used to get reference to chart object. */ @@ -15382,7 +15293,6 @@ interface RefreshCompletedEvent { } interface RefreshCompletedEventUIParam { - /** * Used to get reference to chart object. */ @@ -15394,7 +15304,6 @@ interface AxisRangeChangedEvent { } interface AxisRangeChangedEventUIParam { - /** * Used to get reference to current chart axis object. */ @@ -15431,7 +15340,6 @@ interface TypicalBasedOnEvent { } interface TypicalBasedOnEventUIParam { - /** * Used to get reference to chart object. */ @@ -15473,7 +15381,6 @@ interface ProgressiveLoadStatusChangedEvent { } interface ProgressiveLoadStatusChangedEventUIParam { - /** * Used to get reference to chart object. */ @@ -15495,7 +15402,6 @@ interface AssigningCategoryStyleEvent { } interface AssigningCategoryStyleEventUIParam { - /** * Used to get reference to chart object. */ @@ -15564,7 +15470,6 @@ interface AssigningCategoryMarkerStyleEvent { } interface AssigningCategoryMarkerStyleEventUIParam { - /** * Used to get reference to chart object. */ @@ -15629,7 +15534,6 @@ interface AssigningCategoryMarkerStyleEventUIParam { } interface IgDataChart { - /** * Gets or sets whether the series viewer can allow the page to pan if a control pan is not possible in the requested direction. */ @@ -16805,11 +16709,10 @@ interface IgDataChartMethods { clearTileZoomCache(): void; } interface JQuery { - data(propertyName: "igDataChart"):IgDataChartMethods; + data(propertyName: "igDataChart"): IgDataChartMethods; } interface IgPieChartLegend { - /** * The name of the element to turn into a legend. */ @@ -16845,7 +16748,6 @@ interface SliceClickEvent { } interface SliceClickEventUIParam { - /** * Used to get reference to chart object. */ @@ -16862,7 +16764,6 @@ interface LabelClickEvent { } interface LabelClickEventUIParam { - /** * Used to get reference to the slice object. */ @@ -16879,7 +16780,6 @@ interface SelectedItemChangingEvent { } interface SelectedItemChangingEventUIParam { - /** * Used to get a reference to the current selected data item. */ @@ -16901,7 +16801,6 @@ interface SelectedItemChangedEvent { } interface SelectedItemChangedEventUIParam { - /** * Used to get a reference to the previous selected data item. */ @@ -16918,7 +16817,6 @@ interface SelectedItemsChangingEvent { } interface SelectedItemsChangingEventUIParam { - /** * Used to get a reference to the current selected data items. */ @@ -16940,7 +16838,6 @@ interface SelectedItemsChangedEvent { } interface SelectedItemsChangedEventUIParam { - /** * Used to get a reference to the previous selected data items. */ @@ -16953,7 +16850,6 @@ interface SelectedItemsChangedEventUIParam { } interface IgPieChart { - /** * The width of the chart. It can be set as a number in pixels, string (px) or percentage (%). */ @@ -17392,7 +17288,7 @@ interface IgPieChartMethods { exportVisualData(): void; } interface JQuery { - data(propertyName: "igPieChart"):IgPieChartMethods; + data(propertyName: "igPieChart"): IgPieChartMethods; } interface JQuery { @@ -19836,7 +19732,6 @@ interface LegendItemMouseLeftButtonDownEvent { } interface LegendItemMouseLeftButtonDownEventUIParam { - /** * Used to get reference to current legend object. */ @@ -19873,7 +19768,6 @@ interface LegendItemMouseLeftButtonUpEvent { } interface LegendItemMouseLeftButtonUpEventUIParam { - /** * Used to get reference to current legend object. */ @@ -19910,7 +19804,6 @@ interface LegendItemMouseEnterEvent { } interface LegendItemMouseEnterEventUIParam { - /** * Used to get reference to current legend object. */ @@ -19947,7 +19840,6 @@ interface LegendItemMouseLeaveEvent { } interface LegendItemMouseLeaveEventUIParam { - /** * Used to get reference to current legend object. */ @@ -19980,7 +19872,6 @@ interface LegendItemMouseLeaveEventUIParam { } interface IgChartLegend { - /** * Type of the legend. * @@ -20078,7 +19969,7 @@ interface IgChartLegendMethods { id(): string; } interface JQuery { - data(propertyName: "igChartLegend"):IgChartLegendMethods; + data(propertyName: "igChartLegend"): IgChartLegendMethods; } interface JQuery { @@ -20249,7 +20140,6 @@ interface ColorSelectedEvent { } interface ColorSelectedEventUIParam { - /** * Used to get a reference to the color object. */ @@ -20257,7 +20147,6 @@ interface ColorSelectedEventUIParam { } interface IgColorPicker { - /** * Gets/Sets the default colors. Default colors are the ones displayed in the upper table of the color picker. * The array should contain arrays that contain the color values for every next row. @@ -20274,7 +20163,7 @@ interface IgColorPicker { /** * The event is fired when a color is selected. - * + * * Function takes arguments evt and ui. * Use ui.color to get a reference to the color object. */ @@ -20286,7 +20175,6 @@ interface IgColorPicker { [optionName: string]: any; } interface IgColorPickerMethods { - /** * Gets a reference to the div element of the color table */ @@ -20323,7 +20211,7 @@ interface IgColorPickerMethods { selectColor(color: string): Object; } interface JQuery { - data(propertyName: "igColorPicker"):IgColorPickerMethods; + data(propertyName: "igColorPicker"): IgColorPickerMethods; } interface JQuery { @@ -20368,7 +20256,7 @@ interface JQuery { /** * The event is fired when a color is selected. - * + * * Function takes arguments evt and ui. * Use ui.color to get a reference to the color object. */ @@ -20376,7 +20264,7 @@ interface JQuery { /** * The event is fired when a color is selected. - * + * * Function takes arguments evt and ui. * Use ui.color to get a reference to the color object. * @@ -20394,7 +20282,6 @@ interface ClickEvent { } interface ClickEventUIParam { - /** * Used to get a reference the igSplitButton element. */ @@ -20406,7 +20293,6 @@ interface ExpandedEvent { } interface ExpandedEventUIParam { - /** * Used to get a reference the igSplitButton. */ @@ -20418,7 +20304,6 @@ interface ExpandingEvent { } interface ExpandingEventUIParam { - /** * Used to get a reference the igSplitButton. */ @@ -20430,7 +20315,6 @@ interface CollapsedEvent { } interface CollapsedEventUIParam { - /** * Used to get a reference the igSplitButton. */ @@ -20442,7 +20326,6 @@ interface CollapsingEvent { } interface CollapsingEventUIParam { - /** * Used to get a reference the igSplitButton. */ @@ -20450,7 +20333,6 @@ interface CollapsingEventUIParam { } interface IgColorPickerSplitButton { - /** * Button items. * @@ -20483,7 +20365,7 @@ interface IgColorPickerSplitButton { /** * Event fired when the button is clicked. - * + * * Function takes arguments evt and ui. * Use ui.item to get a reference the igSplitButton element. */ @@ -20491,7 +20373,7 @@ interface IgColorPickerSplitButton { /** * Event fired after the button is expanded. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -20499,7 +20381,7 @@ interface IgColorPickerSplitButton { /** * Event fired before a button item is expanded. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -20507,7 +20389,7 @@ interface IgColorPickerSplitButton { /** * Event fired after the button is collapsed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -20515,7 +20397,7 @@ interface IgColorPickerSplitButton { /** * Event fired before a button item is collapsed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -20527,7 +20409,6 @@ interface IgColorPickerSplitButton { [optionName: string]: any; } interface IgColorPickerSplitButtonMethods { - /** * Sets the color of the split button * @@ -20538,14 +20419,14 @@ interface IgColorPickerSplitButtonMethods { /** * Collapse the widget. * - * @param e + * @param e */ collapse(e: Object): Object; /** * Expands the widget. * - * @param e + * @param e */ expand(e: Object): Object; @@ -20570,7 +20451,7 @@ interface IgColorPickerSplitButtonMethods { toggle(e: Object): Object; } interface JQuery { - data(propertyName: "igColorPickerSplitButton"):IgColorPickerSplitButtonMethods; + data(propertyName: "igColorPickerSplitButton"): IgColorPickerSplitButtonMethods; } interface JQuery { @@ -20654,7 +20535,7 @@ interface JQuery { /** * Event fired when the button is clicked. - * + * * Function takes arguments evt and ui. * Use ui.item to get a reference the igSplitButton element. */ @@ -20662,7 +20543,7 @@ interface JQuery { /** * Event fired when the button is clicked. - * + * * Function takes arguments evt and ui. * Use ui.item to get a reference the igSplitButton element. * @@ -20672,7 +20553,7 @@ interface JQuery { /** * Event fired after the button is expanded. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -20680,7 +20561,7 @@ interface JQuery { /** * Event fired after the button is expanded. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. * @@ -20690,7 +20571,7 @@ interface JQuery { /** * Event fired before a button item is expanded. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -20698,7 +20579,7 @@ interface JQuery { /** * Event fired before a button item is expanded. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. * @@ -20708,7 +20589,7 @@ interface JQuery { /** * Event fired after the button is collapsed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -20716,7 +20597,7 @@ interface JQuery { /** * Event fired after the button is collapsed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. * @@ -20726,7 +20607,7 @@ interface JQuery { /** * Event fired before a button item is collapsed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -20734,7 +20615,7 @@ interface JQuery { /** * Event fired before a button item is collapsed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. * @@ -20748,7 +20629,6 @@ interface JQuery { igColorPickerSplitButton(methodName: string, ...methodParams: any[]): any; } interface IgComboLoadOnDemandSettings { - /** * Gets/Sets option to enable load on demand. * @@ -20768,7 +20648,6 @@ interface IgComboLoadOnDemandSettings { } interface IgComboMultiSelection { - /** * Set enabled to true to turn multi selection on. Set to true by default when target element for the combo is a select with the multiple attribute set. * @@ -20800,7 +20679,6 @@ interface IgComboMultiSelection { } interface IgComboGrouping { - /** * Gets/Sets name of column by which the records will be grouped. Setting this option enables the grouping. * @@ -20824,7 +20702,6 @@ interface IgComboGrouping { } interface IgComboInitialSelectedItem { - /** * Optional="true" Index of item in the list. The index should be greater than -1 and less than the count of the [items](ui.igcombo#methods:items) in the list (rows in dataSource). * @@ -20848,7 +20725,6 @@ interface RenderedEvent { } interface RenderedEventUIParam { - /** * Used to get a reference to the combo performing rendering. */ @@ -20865,7 +20741,6 @@ interface FilteringEvent { } interface FilteringEventUIParam { - /** * Used to obtain reference to igCombo. */ @@ -20882,7 +20757,6 @@ interface FilteredEvent { } interface FilteredEventUIParam { - /** * Used to obtain reference to igCombo. */ @@ -20899,7 +20773,6 @@ interface ItemsRenderingEvent { } interface ItemsRenderingEventUIParam { - /** * Used to get a reference to the combo performing rendering. */ @@ -20916,7 +20789,6 @@ interface ItemsRenderedEvent { } interface ItemsRenderedEventUIParam { - /** * Used to get a reference to the combo performing rendering. */ @@ -20933,7 +20805,6 @@ interface DropDownOpeningEvent { } interface DropDownOpeningEventUIParam { - /** * Used to obtain reference to igCombo. */ @@ -20950,7 +20821,6 @@ interface DropDownOpenedEvent { } interface DropDownOpenedEventUIParam { - /** * Used to obtain reference to igCombo. */ @@ -20967,7 +20837,6 @@ interface DropDownClosingEvent { } interface DropDownClosingEventUIParam { - /** * Used to obtain reference to igCombo. */ @@ -20984,7 +20853,6 @@ interface DropDownClosedEvent { } interface DropDownClosedEventUIParam { - /** * Used to obtain reference to igCombo. */ @@ -21001,7 +20869,6 @@ interface SelectionChangingEvent { } interface SelectionChangingEventUIParam { - /** * Used to obtain reference to igCombo. */ @@ -21023,7 +20890,6 @@ interface SelectionChangedEvent { } interface SelectionChangedEventUIParam { - /** * Used to obtain reference to igCombo. */ @@ -21041,7 +20907,6 @@ interface SelectionChangedEventUIParam { } interface IgCombo { - /** * Gets/Sets the width of combo. The numeric and string values (valid html units for size) are supported. It includes %, px, em and other units. * @@ -21187,7 +21052,7 @@ interface IgCombo { /** * Gets/Sets type of filtering.Note: option is set to "remote", then the "css.waitFiltering" is applied to combo and its drop-down list. - * + * * * * Valid values: @@ -21205,7 +21070,7 @@ interface IgCombo { /** * Gets/Sets condition used for filtering.Note: When [autoComplete](ui.igcombo#options:autoComplete) is enabled, the filtering condition is always "startsWith". - * + * * * * Valid values: @@ -21393,9 +21258,9 @@ interface IgCombo { * Valid options are: * "auto" (default) - uses automatic formatting for Date and number objects. * "none", "", or null - will disable formatting - * + * * Custom values can be something like "currency", "percent", "dateLong", "time", "MMM-dd-yyyy H:mm tt", etc. - * + * * Custom format strings should match the data type in "textKey" column. * */ @@ -21440,7 +21305,7 @@ interface IgCombo { /** * Event which is raised after rendering of the combo completes. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the combo performing rendering. * Use ui.element to get a reference to the main/top combo element. @@ -21449,7 +21314,7 @@ interface IgCombo { /** * Event which is raised before data binding is performed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to igCombo performing the databinding. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) combo is to be databound to. @@ -21458,7 +21323,7 @@ interface IgCombo { /** * Event which is raised after data binding is complete. - * + * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo performing the data binding. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) combo is databound to. @@ -21469,7 +21334,7 @@ interface IgCombo { /** * Event which is raised before data filtering. - * + * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. * Use ui.expression to obtain reference to array which contains expressions supported by [$.ig.DataSource](ig.datasource). @@ -21479,7 +21344,7 @@ interface IgCombo { /** * Event which is raised after filtering. - * + * * Function takes arguments evt and ui. * Use evt.originalEvent to obtain reference to event of browser. That can be null. * Use ui.owner to obtain reference to igCombo. @@ -21489,7 +21354,7 @@ interface IgCombo { /** * Event which is raised before rendering of the combo items is performed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the combo performing rendering. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) combo is databound to. @@ -21498,7 +21363,7 @@ interface IgCombo { /** * Event which is raised after rendering of the combo items completes. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the combo performing rendering. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) combo is databound to. @@ -21507,7 +21372,7 @@ interface IgCombo { /** * Event which is raised before drop-down list is opened. - * + * * Return false in order to cancel drop-down action. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. @@ -21517,7 +21382,7 @@ interface IgCombo { /** * Event which is raised after drop-down list was opened. - * + * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. * Use ui.list to obtain reference to jquery DOM element which represents drop down list container. @@ -21526,7 +21391,7 @@ interface IgCombo { /** * Event which is raised before drop-down list is closed. - * + * * Return false in order to cancel hide action. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. @@ -21536,7 +21401,7 @@ interface IgCombo { /** * Event which is raised after drop-down list was closed. - * + * * Function takes arguments evt and ui. * Use evt.originalEvent to obtain reference to event of browser. * Use ui.owner to obtain reference to igCombo. @@ -21546,7 +21411,7 @@ interface IgCombo { /** * Event which is raised before selection change. - * + * * Return false in order to cancel change. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. @@ -21557,7 +21422,7 @@ interface IgCombo { /** * Event which is raised after selection change. - * + * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. * Use ui.items to obtain reference to array of new selected items. That can be null. @@ -21571,7 +21436,6 @@ interface IgCombo { [optionName: string]: any; } interface IgComboMethods { - /** * Performs databinding on the combo box. The [databinding](ui.igcombo#events:dataBinding) and [dataBound](ui.igcombo#events:dataBound) events are always raised. */ @@ -21579,7 +21443,7 @@ interface IgComboMethods { /** * Forces an update of the igCombo value according to the current text in the igCombo input. - * + * * The refresh is primarily intended to be used with [allowCustomValue](ui.igcombo#options:allowCustomValue) set to true. * The refresh will take the current text and, if no selection is applied, will set it as igCombo value provided that [allowCustomValue](ui.igcombo#options:allowCustomValue) true. */ @@ -21888,7 +21752,7 @@ interface IgComboMethods { destroy(): Object; } interface JQuery { - data(propertyName: "igCombo"):IgComboMethods; + data(propertyName: "igCombo"): IgComboMethods; } interface JQuery { @@ -22237,14 +22101,14 @@ interface JQuery { /** * Gets/Sets type of filtering.Note: option is set to "remote", then the "css.waitFiltering" is applied to combo and its drop-down list. - * + * * */ igCombo(optionLiteral: 'option', optionName: "filteringType"): string; /** * /Sets type of filtering.Note: option is set to "remote", then the "css.waitFiltering" is applied to combo and its drop-down list. - * + * * * * @optionValue New value to be set. @@ -22267,14 +22131,14 @@ interface JQuery { /** * Gets/Sets condition used for filtering.Note: When [autoComplete](ui.igcombo#options:autoComplete) is enabled, the filtering condition is always "startsWith". - * + * * */ igCombo(optionLiteral: 'option', optionName: "filteringCondition"): string; /** * /Sets condition used for filtering.Note: When [autoComplete](ui.igcombo#options:autoComplete) is enabled, the filtering condition is always "startsWith". - * + * * * * @optionValue New value to be set. @@ -22630,9 +22494,9 @@ interface JQuery { * Valid options are: * "auto" (default) - uses automatic formatting for Date and number objects. * "none", "", or null - will disable formatting - * + * * Custom values can be something like "currency", "percent", "dateLong", "time", "MMM-dd-yyyy H:mm tt", etc. - * + * * Custom format strings should match the data type in "textKey" column. * */ @@ -22643,9 +22507,9 @@ interface JQuery { * Valid options are: * "auto" (default) - uses automatic formatting for Date and number objects. * "none", "", or null - will disable formatting - * + * * Custom values can be something like "currency", "percent", "dateLong", "time", "MMM-dd-yyyy H:mm tt", etc. - * + * * Custom format strings should match the data type in "textKey" column. * * @@ -22729,7 +22593,7 @@ interface JQuery { /** * Event which is raised after rendering of the combo completes. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the combo performing rendering. * Use ui.element to get a reference to the main/top combo element. @@ -22738,7 +22602,7 @@ interface JQuery { /** * Event which is raised after rendering of the combo completes. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the combo performing rendering. * Use ui.element to get a reference to the main/top combo element. @@ -22749,7 +22613,7 @@ interface JQuery { /** * Event which is raised before data binding is performed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to igCombo performing the databinding. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) combo is to be databound to. @@ -22758,7 +22622,7 @@ interface JQuery { /** * Event which is raised before data binding is performed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to igCombo performing the databinding. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) combo is to be databound to. @@ -22769,7 +22633,7 @@ interface JQuery { /** * Event which is raised after data binding is complete. - * + * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo performing the data binding. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) combo is databound to. @@ -22780,7 +22644,7 @@ interface JQuery { /** * Event which is raised after data binding is complete. - * + * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo performing the data binding. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) combo is databound to. @@ -22793,7 +22657,7 @@ interface JQuery { /** * Event which is raised before data filtering. - * + * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. * Use ui.expression to obtain reference to array which contains expressions supported by [$.ig.DataSource](ig.datasource). @@ -22803,7 +22667,7 @@ interface JQuery { /** * Event which is raised before data filtering. - * + * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. * Use ui.expression to obtain reference to array which contains expressions supported by [$.ig.DataSource](ig.datasource). @@ -22815,7 +22679,7 @@ interface JQuery { /** * Event which is raised after filtering. - * + * * Function takes arguments evt and ui. * Use evt.originalEvent to obtain reference to event of browser. That can be null. * Use ui.owner to obtain reference to igCombo. @@ -22825,7 +22689,7 @@ interface JQuery { /** * Event which is raised after filtering. - * + * * Function takes arguments evt and ui. * Use evt.originalEvent to obtain reference to event of browser. That can be null. * Use ui.owner to obtain reference to igCombo. @@ -22837,7 +22701,7 @@ interface JQuery { /** * Event which is raised before rendering of the combo items is performed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the combo performing rendering. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) combo is databound to. @@ -22846,7 +22710,7 @@ interface JQuery { /** * Event which is raised before rendering of the combo items is performed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the combo performing rendering. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) combo is databound to. @@ -22857,7 +22721,7 @@ interface JQuery { /** * Event which is raised after rendering of the combo items completes. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the combo performing rendering. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) combo is databound to. @@ -22866,7 +22730,7 @@ interface JQuery { /** * Event which is raised after rendering of the combo items completes. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the combo performing rendering. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) combo is databound to. @@ -22877,7 +22741,7 @@ interface JQuery { /** * Event which is raised before drop-down list is opened. - * + * * Return false in order to cancel drop-down action. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. @@ -22887,7 +22751,7 @@ interface JQuery { /** * Event which is raised before drop-down list is opened. - * + * * Return false in order to cancel drop-down action. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. @@ -22899,7 +22763,7 @@ interface JQuery { /** * Event which is raised after drop-down list was opened. - * + * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. * Use ui.list to obtain reference to jquery DOM element which represents drop down list container. @@ -22908,7 +22772,7 @@ interface JQuery { /** * Event which is raised after drop-down list was opened. - * + * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. * Use ui.list to obtain reference to jquery DOM element which represents drop down list container. @@ -22919,7 +22783,7 @@ interface JQuery { /** * Event which is raised before drop-down list is closed. - * + * * Return false in order to cancel hide action. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. @@ -22929,7 +22793,7 @@ interface JQuery { /** * Event which is raised before drop-down list is closed. - * + * * Return false in order to cancel hide action. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. @@ -22941,7 +22805,7 @@ interface JQuery { /** * Event which is raised after drop-down list was closed. - * + * * Function takes arguments evt and ui. * Use evt.originalEvent to obtain reference to event of browser. * Use ui.owner to obtain reference to igCombo. @@ -22951,7 +22815,7 @@ interface JQuery { /** * Event which is raised after drop-down list was closed. - * + * * Function takes arguments evt and ui. * Use evt.originalEvent to obtain reference to event of browser. * Use ui.owner to obtain reference to igCombo. @@ -22963,7 +22827,7 @@ interface JQuery { /** * Event which is raised before selection change. - * + * * Return false in order to cancel change. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. @@ -22974,7 +22838,7 @@ interface JQuery { /** * Event which is raised before selection change. - * + * * Return false in order to cancel change. * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. @@ -22987,7 +22851,7 @@ interface JQuery { /** * Event which is raised after selection change. - * + * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. * Use ui.items to obtain reference to array of new selected items. That can be null. @@ -22997,7 +22861,7 @@ interface JQuery { /** * Event which is raised after selection change. - * + * * Function takes arguments evt and ui. * Use ui.owner to obtain reference to igCombo. * Use ui.items to obtain reference to array of new selected items. That can be null. @@ -23017,7 +22881,6 @@ interface StateChangingEvent { } interface StateChangingEventUIParam { - /** * Used to obtain a reference to the igDialog. */ @@ -23049,7 +22912,6 @@ interface StateChangedEvent { } interface StateChangedEventUIParam { - /** * Used to obtain a reference to the igDialog. */ @@ -23081,7 +22943,6 @@ interface AnimationEndedEvent { } interface AnimationEndedEventUIParam { - /** * Used to obtain a reference to the igDialog. */ @@ -23098,7 +22959,6 @@ interface FocusEvent { } interface FocusEventUIParam { - /** * Used to obtain a reference to the igDialog. */ @@ -23110,7 +22970,6 @@ interface BlurEvent { } interface BlurEventUIParam { - /** * Used to obtain a reference to the igDialog. */ @@ -23118,7 +22977,6 @@ interface BlurEventUIParam { } interface IgDialog { - /** * Gets the jquery DIV object which is used as the main container for the dialog. * Notes: @@ -23132,7 +22990,7 @@ interface IgDialog { /** * Gets/Sets the state of the dialog.Note: when the dialog is modal, then pinned and minimized states are not supported, because that will trigger misbehavior. - * + * * * * Valid values: @@ -23238,7 +23096,7 @@ interface IgDialog { /** * Gets/Sets the initial height of the dialog in pixels for normal state.Besides numeric values, following units are supported: "px", "em" and "%". * In case of "%", the size of browser window is used and it has effect only on open action. - * + * * */ height?: number|string; @@ -23246,7 +23104,7 @@ interface IgDialog { /** * Gets/Sets the initial width of the dialog in pixels for normal state.Besides numeric values, following units are supported: "px", "em" and "%". * In case of "%", the size of browser window is used and it has effect only on open action. - * + * * */ width?: number|string; @@ -23388,7 +23246,7 @@ interface IgDialog { * Gets/Sets the processing of the double-click on the dialog-header.If this option is not false and dialog was minimized, then its state will be set to normal. * If this option is set to "auto" and showMaximizeButton is enabled or if this option is set to true, then the dialog will be maximized when it was in normal state, * and dialog-state will be set to normal if it was maximized. - * + * * */ enableDblclick?: any; @@ -23396,7 +23254,7 @@ interface IgDialog { /** * Event which is raised before the state of dialog was changed. * Return false in order to cancel action. - * + * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. That parameter can be null if the state was modified from the code. * Use ui.owner to obtain a reference to the igDialog. @@ -23416,7 +23274,7 @@ interface IgDialog { /** * Event which is raised after the state of the dialog was changed. - * + * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. That parameter can be null if the state was modified from the code. * Use ui.owner to obtain a reference to the igDialog. @@ -23436,7 +23294,7 @@ interface IgDialog { /** * Event which is raised after the end of the animation when the dialod was closed or opened. - * + * * The function takes arguments "evt" and "ui". * Use ui.owner to obtain a reference to the igDialog. * Use ui.action to obtain the name of the action, which triggered the animation. @@ -23447,7 +23305,7 @@ interface IgDialog { /** * Event which is raised when the dialog or its content gets focus. - * + * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. * Use ui.owner to obtain a reference to the igDialog. @@ -23456,7 +23314,7 @@ interface IgDialog { /** * Event which is raised when the dialog or its content loses focus. - * + * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. * Use ui.owner to obtain a reference to the igDialog. @@ -23469,7 +23327,6 @@ interface IgDialog { [optionName: string]: any; } interface IgDialogMethods { - /** * Destroys the igDialog and moves the target element to its original parent. */ @@ -23565,7 +23422,7 @@ interface IgDialogMethods { content(newContent?: string): Object; } interface JQuery { - data(propertyName: "igDialog"):IgDialogMethods; + data(propertyName: "igDialog"): IgDialogMethods; } interface JQuery { @@ -23610,14 +23467,14 @@ interface JQuery { /** * Gets/Sets the state of the dialog.Note: when the dialog is modal, then pinned and minimized states are not supported, because that will trigger misbehavior. - * + * * */ igDialog(optionLiteral: 'option', optionName: "state"): string; /** * /Sets the state of the dialog.Note: when the dialog is modal, then pinned and minimized states are not supported, because that will trigger misbehavior. - * + * * * * @optionValue New value to be set. @@ -23839,7 +23696,7 @@ interface JQuery { /** * Gets/Sets the initial height of the dialog in pixels for normal state.Besides numeric values, following units are supported: "px", "em" and "%". * In case of "%", the size of browser window is used and it has effect only on open action. - * + * * */ igDialog(optionLiteral: 'option', optionName: "height"): number|string; @@ -23847,7 +23704,7 @@ interface JQuery { /** * /Sets the initial height of the dialog in pixels for normal state.Besides numeric values, following units are supported: "px", "em" and "%". * In case of "%", the size of browser window is used and it has effect only on open action. - * + * * * * @optionValue New value to be set. @@ -23857,7 +23714,7 @@ interface JQuery { /** * Gets/Sets the initial width of the dialog in pixels for normal state.Besides numeric values, following units are supported: "px", "em" and "%". * In case of "%", the size of browser window is used and it has effect only on open action. - * + * * */ igDialog(optionLiteral: 'option', optionName: "width"): number|string; @@ -23865,7 +23722,7 @@ interface JQuery { /** * /Sets the initial width of the dialog in pixels for normal state.Besides numeric values, following units are supported: "px", "em" and "%". * In case of "%", the size of browser window is used and it has effect only on open action. - * + * * * * @optionValue New value to be set. @@ -24184,7 +24041,7 @@ interface JQuery { * Gets/Sets the processing of the double-click on the dialog-header.If this option is not false and dialog was minimized, then its state will be set to normal. * If this option is set to "auto" and showMaximizeButton is enabled or if this option is set to true, then the dialog will be maximized when it was in normal state, * and dialog-state will be set to normal if it was maximized. - * + * * */ igDialog(optionLiteral: 'option', optionName: "enableDblclick"): any; @@ -24193,7 +24050,7 @@ interface JQuery { * /Sets the processing of the double-click on the dialog-header.If this option is not false and dialog was minimized, then its state will be set to normal. * If this option is set to "auto" and showMaximizeButton is enabled or if this option is set to true, then the dialog will be maximized when it was in normal state, * and dialog-state will be set to normal if it was maximized. - * + * * * * @optionValue New value to be set. @@ -24203,7 +24060,7 @@ interface JQuery { /** * Event which is raised before the state of dialog was changed. * Return false in order to cancel action. - * + * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. That parameter can be null if the state was modified from the code. * Use ui.owner to obtain a reference to the igDialog. @@ -24224,7 +24081,7 @@ interface JQuery { /** * Event which is raised before the state of dialog was changed. * Return false in order to cancel action. - * + * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. That parameter can be null if the state was modified from the code. * Use ui.owner to obtain a reference to the igDialog. @@ -24246,7 +24103,7 @@ interface JQuery { /** * Event which is raised after the state of the dialog was changed. - * + * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. That parameter can be null if the state was modified from the code. * Use ui.owner to obtain a reference to the igDialog. @@ -24266,7 +24123,7 @@ interface JQuery { /** * Event which is raised after the state of the dialog was changed. - * + * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. That parameter can be null if the state was modified from the code. * Use ui.owner to obtain a reference to the igDialog. @@ -24288,7 +24145,7 @@ interface JQuery { /** * Event which is raised after the end of the animation when the dialod was closed or opened. - * + * * The function takes arguments "evt" and "ui". * Use ui.owner to obtain a reference to the igDialog. * Use ui.action to obtain the name of the action, which triggered the animation. @@ -24299,7 +24156,7 @@ interface JQuery { /** * Event which is raised after the end of the animation when the dialod was closed or opened. - * + * * The function takes arguments "evt" and "ui". * Use ui.owner to obtain a reference to the igDialog. * Use ui.action to obtain the name of the action, which triggered the animation. @@ -24312,7 +24169,7 @@ interface JQuery { /** * Event which is raised when the dialog or its content gets focus. - * + * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. * Use ui.owner to obtain a reference to the igDialog. @@ -24321,7 +24178,7 @@ interface JQuery { /** * Event which is raised when the dialog or its content gets focus. - * + * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. * Use ui.owner to obtain a reference to the igDialog. @@ -24332,7 +24189,7 @@ interface JQuery { /** * Event which is raised when the dialog or its content loses focus. - * + * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. * Use ui.owner to obtain a reference to the igDialog. @@ -24341,7 +24198,7 @@ interface JQuery { /** * Event which is raised when the dialog or its content loses focus. - * + * * The function takes arguments "evt" and "ui". * Use evt to obtain the browser event. * Use ui.owner to obtain a reference to the igDialog. @@ -24356,7 +24213,6 @@ interface JQuery { igDialog(methodName: string, ...methodParams: any[]): any; } interface IgDoughnutChartSeries { - /** * Gets or sets the current series type. * @@ -24399,10 +24255,10 @@ interface IgDoughnutChartSeries { * Gets or sets the position of chart labels. * * Valid values: - * "none" - * "center" - * "insideEnd" - * "outsideEnd" + * "none" + * "center" + * "insideEnd" + * "outsideEnd" * "bestFit" */ labelsPosition?: string; @@ -24411,7 +24267,7 @@ interface IgDoughnutChartSeries { * Gets or sets whether the leader lines are visible. * * Valid values: - * "visible" + * "visible" * "collapsed" */ leaderLineVisibility?: string; @@ -24425,8 +24281,8 @@ interface IgDoughnutChartSeries { * Gets or sets what type of leader lines will be used for the outside end labels. * * Valid values: - * "straight" - * "arc" + * "straight" + * "arc" * "spline" */ leaderLineType?: string; @@ -24445,7 +24301,7 @@ interface IgDoughnutChartSeries { * Gets or sets whether to use numeric or percent-based threshold value. * * Valid values: - * "number" + * "number" * "percent" */ othersCategoryType?: string; @@ -24524,7 +24380,6 @@ interface HoleDimensionsChangedEventUIParam { } interface IgDoughnutChart { - /** * The width of the chart. It can be set as a number in pixels, string (px) or percentage (%). */ @@ -24604,7 +24459,7 @@ interface IgDoughnutChart { responseDataKey?: string; /** - * Event fired when the mouse has hovered on a series and the tooltip is about to show + * Event fired when the mouse has hovered on a series and the tooltip is about to show * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current series item object. @@ -24640,7 +24495,7 @@ interface IgDoughnutChart { tooltipHiding?: TooltipHidingEvent; /** - * Event fired after a tooltip is hidden + * Event fired after a tooltip is hidden * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current series item object. @@ -24713,7 +24568,6 @@ interface IgDoughnutChart { [optionName: string]: any; } interface IgDoughnutChartMethods { - /** * Adds a new series to the doughnut chart. * @@ -24858,7 +24712,7 @@ interface IgDoughnutChartMethods { dataBind(): void; } interface JQuery { - data(propertyName: "igDoughnutChart"):IgDoughnutChartMethods; + data(propertyName: "igDoughnutChart"): IgDoughnutChartMethods; } interface JQuery { @@ -25071,7 +24925,7 @@ interface JQuery { igDoughnutChart(optionLiteral: 'option', optionName: "responseDataKey", optionValue: string): void; /** - * Event fired when the mouse has hovered on a series and the tooltip is about to show + * Event fired when the mouse has hovered on a series and the tooltip is about to show * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current series item object. @@ -25083,7 +24937,7 @@ interface JQuery { igDoughnutChart(optionLiteral: 'option', optionName: "tooltipShowing"): TooltipShowingEvent; /** - * Event fired when the mouse has hovered on a series and the tooltip is about to show + * Event fired when the mouse has hovered on a series and the tooltip is about to show * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current series item object. @@ -25149,7 +25003,7 @@ interface JQuery { igDoughnutChart(optionLiteral: 'option', optionName: "tooltipHiding", optionValue: TooltipHidingEvent): void; /** - * Event fired after a tooltip is hidden + * Event fired after a tooltip is hidden * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current series item object. @@ -25161,7 +25015,7 @@ interface JQuery { igDoughnutChart(optionLiteral: 'option', optionName: "tooltipHidden"): TooltipHiddenEvent; /** - * Event fired after a tooltip is hidden + * Event fired after a tooltip is hidden * Function takes arguments evt and ui. * Use ui.element to get reference to tooltip DOM element. * Use ui.item to get reference to current series item object. @@ -25310,7 +25164,6 @@ interface RenderingEvent { } interface RenderingEventUIParam { - /** * Used to get a reference to the editor performing rendering. */ @@ -25327,7 +25180,6 @@ interface MousedownEvent { } interface MousedownEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25349,7 +25201,6 @@ interface MouseupEvent { } interface MouseupEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25371,7 +25222,6 @@ interface MousemoveEvent { } interface MousemoveEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25393,7 +25243,6 @@ interface MouseoverEvent { } interface MouseoverEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25415,7 +25264,6 @@ interface MouseoutEvent { } interface MouseoutEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25437,7 +25285,6 @@ interface KeydownEvent { } interface KeydownEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25454,7 +25301,6 @@ interface KeypressEvent { } interface KeypressEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25471,7 +25317,6 @@ interface KeyupEvent { } interface KeyupEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25488,7 +25333,6 @@ interface ValueChangingEvent { } interface ValueChangingEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25515,7 +25359,6 @@ interface ValueChangedEvent { } interface ValueChangedEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25538,7 +25381,6 @@ interface ValueChangedEventUIParam { } interface IgBaseEditor { - /** * Gets/Sets the width of the control. * @@ -25744,7 +25586,6 @@ interface IgBaseEditor { [optionName: string]: any; } interface IgBaseEditorMethods { - /** * Gets/Sets name attribute applied to the editor element. * @@ -25806,7 +25647,7 @@ interface IgBaseEditorMethods { destroy(): void; } interface JQuery { - data(propertyName: "igBaseEditor"):IgBaseEditorMethods; + data(propertyName: "igBaseEditor"): IgBaseEditorMethods; } interface DropDownListOpeningEvent { @@ -25814,7 +25655,6 @@ interface DropDownListOpeningEvent { } interface DropDownListOpeningEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25836,7 +25676,6 @@ interface DropDownListOpenedEvent { } interface DropDownListOpenedEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25858,7 +25697,6 @@ interface DropDownListClosingEvent { } interface DropDownListClosingEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25880,7 +25718,6 @@ interface DropDownListClosedEvent { } interface DropDownListClosedEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25902,7 +25739,6 @@ interface DropDownItemSelectingEvent { } interface DropDownItemSelectingEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25929,7 +25765,6 @@ interface DropDownItemSelectedEvent { } interface DropDownItemSelectedEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25956,7 +25791,6 @@ interface TextChangedEvent { } interface TextChangedEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -25974,10 +25808,9 @@ interface TextChangedEventUIParam { } interface IgTextEditor { - /** * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. - * + * * * * Valid values: @@ -26435,7 +26268,6 @@ interface IgTextEditor { [optionName: string]: any; } interface IgTextEditorMethods { - /** * Gets the visible text in the editor. */ @@ -26603,11 +26435,10 @@ interface IgTextEditorMethods { destroy(): void; } interface JQuery { - data(propertyName: "igTextEditor"):IgTextEditorMethods; + data(propertyName: "igTextEditor"): IgTextEditorMethods; } interface IgNumericEditor { - /** * Gets/Sets list of items which are used as a source for the drop-down list. * Items in the list can be of type string, number or object. The items are directly rendered without any casting, or manipulation. @@ -26701,7 +26532,7 @@ interface IgNumericEditor { * Defines the range that editor's value can accept.This is achieved by setting the [minValue](ui.igNumericEditor#options:minValue) and [maxValue](ui.igNumericEditor#options:maxValue) editor's options, accordingly to the lowest and highest accepted values for the defined numeric mode. * The range for the specific type follows the numeric type standards, e.g. in .NET Framework [floating-point](https://msdn.microsoft.com/en-us/library/9ahet949.aspx) types and [integral types](https://msdn.microsoft.com/en-us/library/exx3b86w.aspx). * In addition, the maximum value that can be set to [minDecimals](ui.igNumericEditor#options:minDecimals) and [maxDecimals](ui.igNumericEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. - * + * * * * Valid values: @@ -26747,7 +26578,7 @@ interface IgNumericEditor { * Gets/Sets support for scientific format in edit mode. * If that option is set, then numeric value appears as a string with possible E-power flag. In edit mode the "E" or "e" character can be entered as well. * Notes: The "+" character is not supported in edit mode. - * + * * * * Valid values: @@ -26791,20 +26622,20 @@ interface IgNumericEditor { toUpper?: any; /** - * + * */ textMode?: any; /** * Gets/Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. - * + * * */ value?: any; /** * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. - * + * * * * Valid values: @@ -27045,7 +26876,6 @@ interface IgNumericEditor { [optionName: string]: any; } interface IgNumericEditorMethods { - /** * Gets/Sets editor value. * @@ -27166,11 +26996,10 @@ interface IgNumericEditorMethods { spinDownButton(): string; } interface JQuery { - data(propertyName: "igNumericEditor"):IgNumericEditorMethods; + data(propertyName: "igNumericEditor"): IgNumericEditorMethods; } interface IgCurrencyEditor { - /** * Gets/Sets the string, which is used as positive pattern. The "n" flag represents the value of number. * Note: This option has priority over possible regional settings. @@ -27278,7 +27107,7 @@ interface IgCurrencyEditor { * Defines the range that editor's value can accept.This is achieved by setting the [minValue](ui.igNumericEditor#options:minValue) and [maxValue](ui.igNumericEditor#options:maxValue) editor's options, accordingly to the lowest and highest accepted values for the defined numeric mode. * The range for the specific type follows the numeric type standards, e.g. in .NET Framework [floating-point](https://msdn.microsoft.com/en-us/library/9ahet949.aspx) types and [integral types](https://msdn.microsoft.com/en-us/library/exx3b86w.aspx). * In addition, the maximum value that can be set to [minDecimals](ui.igNumericEditor#options:minDecimals) and [maxDecimals](ui.igNumericEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. - * + * * * * Valid values: @@ -27324,7 +27153,7 @@ interface IgCurrencyEditor { * Gets/Sets support for scientific format in edit mode. * If that option is set, then numeric value appears as a string with possible E-power flag. In edit mode the "E" or "e" character can be entered as well. * Notes: The "+" character is not supported in edit mode. - * + * * * * Valid values: @@ -27368,20 +27197,20 @@ interface IgCurrencyEditor { toUpper?: any; /** - * + * */ textMode?: any; /** * Gets/Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. - * + * * */ value?: any; /** * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. - * + * * * * Valid values: @@ -27556,7 +27385,6 @@ interface IgCurrencyEditor { [optionName: string]: any; } interface IgCurrencyEditorMethods { - /** * Gets/sets a string that is used as the currency symbol shown with the number in the input. The value provided as a param is propagated to the currencySymbol option and thus has the same priority as the option. * @@ -27611,11 +27439,10 @@ interface IgCurrencyEditorMethods { getRegionalOption(): string; } interface JQuery { - data(propertyName: "igCurrencyEditor"):IgCurrencyEditorMethods; + data(propertyName: "igCurrencyEditor"): IgCurrencyEditorMethods; } interface IgPercentEditor { - /** * Gets/Sets the pattern for positive numeric values, which is used in display (no focus) state. * If you use the "en-US" culture the default value for "positivePattern" will be "n$" where the "$" flag represents the "numericSymbol" and the "n" flag represents the value of the number. @@ -27645,7 +27472,7 @@ interface IgPercentEditor { * Defines the range that editor's value can accept.This is achieved by setting the [minValue](ui.igPercentEditor#options:minValue) and [maxValue](ui.igPercentEditor#options:maxValue) editor's options, accordingly to the lowest and highest accepted values for the defined numeric mode. * The range for the specific type follows the numeric type standards, e.g. in .NET Framework [floating-point](https://msdn.microsoft.com/en-us/library/9ahet949.aspx) types and [integral types](https://msdn.microsoft.com/en-us/library/exx3b86w.aspx). * In addition, the maximum value that can be set to [minDecimals](ui.igPercentEditor#options:minDecimals) and [maxDecimals](ui.igPercentEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. - * + * * * * Valid values: @@ -27780,7 +27607,7 @@ interface IgPercentEditor { * Gets/Sets support for scientific format in edit mode. * If that option is set, then numeric value appears as a string with possible E-power flag. In edit mode the "E" or "e" character can be entered as well. * Notes: The "+" character is not supported in edit mode. - * + * * * * Valid values: @@ -27824,20 +27651,20 @@ interface IgPercentEditor { toUpper?: any; /** - * + * */ textMode?: any; /** * Gets/Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. - * + * * */ value?: any; /** * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. - * + * * * * Valid values: @@ -28012,7 +27839,6 @@ interface IgPercentEditor { [optionName: string]: any; } interface IgPercentEditorMethods { - /** * Paste text at location of the caret or over the current selection. Best used during editing, as the method will instead set the text as value (modified by the [displayFactor](ui.igpercenteditor#options:displayFactor)) if the editor is not focused. * Note: the method raises the [textChanged](ui.igpercenteditor#events:textChanged) event. @@ -28075,11 +27901,10 @@ interface IgPercentEditorMethods { getRegionalOption(): string; } interface JQuery { - data(propertyName: "igPercentEditor"):IgPercentEditorMethods; + data(propertyName: "igPercentEditor"): IgPercentEditorMethods; } interface IgMaskEditor { - /** * Gets custom regional settings for editor. If it is string, then $.ig.regional[stringValue] is assumed. * @@ -28088,7 +27913,7 @@ interface IgMaskEditor { /** * Gets visibility of the clear button. That option can be set only on initialization. - * + * * clear A button to clear the value is located on the right side of the editor. */ buttonType?: string; @@ -28212,7 +28037,7 @@ interface IgMaskEditor { dropDownOnReadOnly?: boolean; /** - * + * */ textMode?: any; @@ -28387,7 +28212,6 @@ interface IgMaskEditor { [optionName: string]: any; } interface IgMaskEditorMethods { - /** * Gets/Sets mask editor value. * @@ -28454,11 +28278,10 @@ interface IgMaskEditorMethods { select(start: number, end: number): void; } interface JQuery { - data(propertyName: "igMaskEditor"):IgMaskEditorMethods; + data(propertyName: "igMaskEditor"): IgMaskEditorMethods; } interface IgDateEditor { - /** * Gets/Sets the value of the editor. Date object can be set as value. String can be set and the editor will pass it to the Date object constructor and use the corresponding Date object as the value. MVC date format can be used too. * Note! This option doesn't use the displayInputFormat to extract the date. @@ -28722,7 +28545,7 @@ interface IgDateEditor { dropDownOrientation?: string; /** - * + * */ textMode?: any; @@ -28885,10 +28708,9 @@ interface IgDateEditor { [optionName: string]: any; } interface IgDateEditorMethods { - /** * Gets/Sets editor value. - * + * * Note! This option doesn't use the displayInputFormat to extract the date * * @param newValue New editor value. Date object can be set as value. String value can be passed and the editor will use the javascript Date object constructor to create date object and will use it for the comparison. MVC date format can be used too. For example Date(/"thicks"/). @@ -28903,7 +28725,7 @@ interface IgDateEditorMethods { /** * Sets selected date. * - * @param date + * @param date */ selectDate(date: Object): void; @@ -28945,7 +28767,7 @@ interface IgDateEditorMethods { hideDropDown(): void; } interface JQuery { - data(propertyName: "igDateEditor"):IgDateEditorMethods; + data(propertyName: "igDateEditor"): IgDateEditorMethods; } interface ItemSelectedEvent { @@ -28953,7 +28775,6 @@ interface ItemSelectedEvent { } interface ItemSelectedEventUIParam { - /** * Used to obtain reference to igEditor. */ @@ -28976,7 +28797,6 @@ interface ItemSelectedEventUIParam { } interface IgDatePicker { - /** * Gets/Sets the custom regional settings for the editor. If it is a string, then $.ig.regional[stringValue] is assumed. * @@ -29249,7 +29069,7 @@ interface IgDatePicker { dropDownOrientation?: string; /** - * + * */ textMode?: any; @@ -29434,7 +29254,6 @@ interface IgDatePicker { [optionName: string]: any; } interface IgDatePickerMethods { - /** * Returns a reference to the jQuery calendar used as a picker selector */ @@ -29471,7 +29290,7 @@ interface IgDatePickerMethods { /** * Gets/Sets editor value. - * + * * Note! This option doesn't use the displayInputFormat to extract the date * * @param newValue New editor value. Date object can be set as value. String value can be passed and the editor will use the javascript Date object constructor to create date object and will use it for the comparison. MVC date format can be used too. For example Date(/"thicks"/). @@ -29486,7 +29305,7 @@ interface IgDatePickerMethods { /** * Sets selected date. * - * @param date + * @param date */ selectDate(date: Object): void; @@ -29520,11 +29339,10 @@ interface IgDatePickerMethods { isValid(): boolean; } interface JQuery { - data(propertyName: "igDatePicker"):IgDatePickerMethods; + data(propertyName: "igDatePicker"): IgDatePickerMethods; } interface IgCheckboxEditor { - /** * Gets/Sets whether the checkbox is checked. * @@ -29533,7 +29351,7 @@ interface IgCheckboxEditor { /** * Gets/Sets size of the checkbox based on preset styles.For different sizes, define 'width' and 'height' options instead. - * + * * * * Valid values: @@ -29748,7 +29566,6 @@ interface IgCheckboxEditor { [optionName: string]: any; } interface IgCheckboxEditorMethods { - /** * Checks if the value in the editor is valid. Note: This function will not trigger automatic notifications. */ @@ -29761,7 +29578,7 @@ interface IgCheckboxEditorMethods { * 2. If the [value](ui.igcheckboxeditor#options:value) option IS defined, then 'value' method will return the value that will be submitted when the editor is checked and the form is submitted. * To get checked state regardless of the 'value' option, use $(".selector").igCheckboxEditor("option", "checked"); * - * @param newValue + * @param newValue */ value(newValue: Object): string; @@ -29825,7 +29642,7 @@ interface IgCheckboxEditorMethods { destroy(): void; } interface JQuery { - data(propertyName: "igCheckboxEditor"):IgCheckboxEditorMethods; + data(propertyName: "igCheckboxEditor"): IgCheckboxEditorMethods; } interface JQuery { @@ -30316,14 +30133,14 @@ interface JQuery { /** * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. - * + * * */ igTextEditor(optionLiteral: 'option', optionName: "buttonType"): string; /** * Visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. - * + * * * * @optionValue New value to be set. @@ -31490,7 +31307,7 @@ interface JQuery { * Defines the range that editor's value can accept.This is achieved by setting the [minValue](ui.igNumericEditor#options:minValue) and [maxValue](ui.igNumericEditor#options:maxValue) editor's options, accordingly to the lowest and highest accepted values for the defined numeric mode. * The range for the specific type follows the numeric type standards, e.g. in .NET Framework [floating-point](https://msdn.microsoft.com/en-us/library/9ahet949.aspx) types and [integral types](https://msdn.microsoft.com/en-us/library/exx3b86w.aspx). * In addition, the maximum value that can be set to [minDecimals](ui.igNumericEditor#options:minDecimals) and [maxDecimals](ui.igNumericEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. - * + * * */ igNumericEditor(optionLiteral: 'option', optionName: "dataMode"): string; @@ -31499,7 +31316,7 @@ interface JQuery { * Defines the range that editor's value can accept.This is achieved by setting the [minValue](ui.igNumericEditor#options:minValue) and [maxValue](ui.igNumericEditor#options:maxValue) editor's options, accordingly to the lowest and highest accepted values for the defined numeric mode. * The range for the specific type follows the numeric type standards, e.g. in .NET Framework [floating-point](https://msdn.microsoft.com/en-us/library/9ahet949.aspx) types and [integral types](https://msdn.microsoft.com/en-us/library/exx3b86w.aspx). * In addition, the maximum value that can be set to [minDecimals](ui.igNumericEditor#options:minDecimals) and [maxDecimals](ui.igNumericEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. - * + * * * * @optionValue New value to be set. @@ -31568,7 +31385,7 @@ interface JQuery { * Gets/Sets support for scientific format in edit mode. * If that option is set, then numeric value appears as a string with possible E-power flag. In edit mode the "E" or "e" character can be entered as well. * Notes: The "+" character is not supported in edit mode. - * + * * */ igNumericEditor(optionLiteral: 'option', optionName: "scientificFormat"): string; @@ -31577,7 +31394,7 @@ interface JQuery { * /Sets support for scientific format in edit mode. * If that option is set, then numeric value appears as a string with possible E-power flag. In edit mode the "E" or "e" character can be entered as well. * Notes: The "+" character is not supported in edit mode. - * + * * * * @optionValue New value to be set. @@ -31668,14 +31485,14 @@ interface JQuery { /** * Gets/Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. - * + * * */ igNumericEditor(optionLiteral: 'option', optionName: "value"): any; /** * /Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. - * + * * * * @optionValue New value to be set. @@ -31684,14 +31501,14 @@ interface JQuery { /** * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. - * + * * */ igNumericEditor(optionLiteral: 'option', optionName: "buttonType"): string; /** * Visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. - * + * * * * @optionValue New value to be set. @@ -32414,7 +32231,7 @@ interface JQuery { * Defines the range that editor's value can accept.This is achieved by setting the [minValue](ui.igNumericEditor#options:minValue) and [maxValue](ui.igNumericEditor#options:maxValue) editor's options, accordingly to the lowest and highest accepted values for the defined numeric mode. * The range for the specific type follows the numeric type standards, e.g. in .NET Framework [floating-point](https://msdn.microsoft.com/en-us/library/9ahet949.aspx) types and [integral types](https://msdn.microsoft.com/en-us/library/exx3b86w.aspx). * In addition, the maximum value that can be set to [minDecimals](ui.igNumericEditor#options:minDecimals) and [maxDecimals](ui.igNumericEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. - * + * * */ igCurrencyEditor(optionLiteral: 'option', optionName: "dataMode"): string; @@ -32423,7 +32240,7 @@ interface JQuery { * Defines the range that editor's value can accept.This is achieved by setting the [minValue](ui.igNumericEditor#options:minValue) and [maxValue](ui.igNumericEditor#options:maxValue) editor's options, accordingly to the lowest and highest accepted values for the defined numeric mode. * The range for the specific type follows the numeric type standards, e.g. in .NET Framework [floating-point](https://msdn.microsoft.com/en-us/library/9ahet949.aspx) types and [integral types](https://msdn.microsoft.com/en-us/library/exx3b86w.aspx). * In addition, the maximum value that can be set to [minDecimals](ui.igNumericEditor#options:minDecimals) and [maxDecimals](ui.igNumericEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. - * + * * * * @optionValue New value to be set. @@ -32492,7 +32309,7 @@ interface JQuery { * Gets/Sets support for scientific format in edit mode. * If that option is set, then numeric value appears as a string with possible E-power flag. In edit mode the "E" or "e" character can be entered as well. * Notes: The "+" character is not supported in edit mode. - * + * * */ igCurrencyEditor(optionLiteral: 'option', optionName: "scientificFormat"): string; @@ -32501,7 +32318,7 @@ interface JQuery { * /Sets support for scientific format in edit mode. * If that option is set, then numeric value appears as a string with possible E-power flag. In edit mode the "E" or "e" character can be entered as well. * Notes: The "+" character is not supported in edit mode. - * + * * * * @optionValue New value to be set. @@ -32592,14 +32409,14 @@ interface JQuery { /** * Gets/Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. - * + * * */ igCurrencyEditor(optionLiteral: 'option', optionName: "value"): any; /** * /Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. - * + * * * * @optionValue New value to be set. @@ -32608,14 +32425,14 @@ interface JQuery { /** * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. - * + * * */ igCurrencyEditor(optionLiteral: 'option', optionName: "buttonType"): string; /** * Visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. - * + * * * * @optionValue New value to be set. @@ -33029,7 +32846,7 @@ interface JQuery { * Defines the range that editor's value can accept.This is achieved by setting the [minValue](ui.igPercentEditor#options:minValue) and [maxValue](ui.igPercentEditor#options:maxValue) editor's options, accordingly to the lowest and highest accepted values for the defined numeric mode. * The range for the specific type follows the numeric type standards, e.g. in .NET Framework [floating-point](https://msdn.microsoft.com/en-us/library/9ahet949.aspx) types and [integral types](https://msdn.microsoft.com/en-us/library/exx3b86w.aspx). * In addition, the maximum value that can be set to [minDecimals](ui.igPercentEditor#options:minDecimals) and [maxDecimals](ui.igPercentEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. - * + * * */ igPercentEditor(optionLiteral: 'option', optionName: "dataMode"): string; @@ -33038,7 +32855,7 @@ interface JQuery { * Defines the range that editor's value can accept.This is achieved by setting the [minValue](ui.igPercentEditor#options:minValue) and [maxValue](ui.igPercentEditor#options:maxValue) editor's options, accordingly to the lowest and highest accepted values for the defined numeric mode. * The range for the specific type follows the numeric type standards, e.g. in .NET Framework [floating-point](https://msdn.microsoft.com/en-us/library/9ahet949.aspx) types and [integral types](https://msdn.microsoft.com/en-us/library/exx3b86w.aspx). * In addition, the maximum value that can be set to [minDecimals](ui.igPercentEditor#options:minDecimals) and [maxDecimals](ui.igPercentEditor#options:maxDecimals) options can be 15, when editor is in 'double' mode and 7, when in 'float' mode. - * + * * * * @optionValue New value to be set. @@ -33295,7 +33112,7 @@ interface JQuery { * Gets/Sets support for scientific format in edit mode. * If that option is set, then numeric value appears as a string with possible E-power flag. In edit mode the "E" or "e" character can be entered as well. * Notes: The "+" character is not supported in edit mode. - * + * * */ igPercentEditor(optionLiteral: 'option', optionName: "scientificFormat"): string; @@ -33304,7 +33121,7 @@ interface JQuery { * /Sets support for scientific format in edit mode. * If that option is set, then numeric value appears as a string with possible E-power flag. In edit mode the "E" or "e" character can be entered as well. * Notes: The "+" character is not supported in edit mode. - * + * * * * @optionValue New value to be set. @@ -33395,14 +33212,14 @@ interface JQuery { /** * Gets/Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. - * + * * */ igPercentEditor(optionLiteral: 'option', optionName: "value"): any; /** * /Sets value in editor. The effect of setting/getting that option depends on type of editor and on dataMode options for every type of editor. - * + * * * * @optionValue New value to be set. @@ -33411,14 +33228,14 @@ interface JQuery { /** * Gets visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. - * + * * */ igPercentEditor(optionLiteral: 'option', optionName: "buttonType"): string; /** * Visibility of the spin, clear and drop-down button. That option can be set only on initialization. Combinations like 'dropdown,spin' or 'spin,clear' are supported too.Note! This option can not be set runtime. - * + * * * * @optionValue New value to be set. @@ -33797,14 +33614,14 @@ interface JQuery { /** * Gets visibility of the clear button. That option can be set only on initialization. - * + * * clear A button to clear the value is located on the right side of the editor. */ igMaskEditor(optionLiteral: 'option', optionName: "buttonType"): string; /** * Visibility of the clear button. That option can be set only on initialization. - * + * * clear A button to clear the value is located on the right side of the editor. * * @optionValue New value to be set. @@ -36383,14 +36200,14 @@ interface JQuery { /** * Gets/Sets size of the checkbox based on preset styles.For different sizes, define 'width' and 'height' options instead. - * + * * */ igCheckboxEditor(optionLiteral: 'option', optionName: "size"): string; /** * /Sets size of the checkbox based on preset styles.For different sizes, define 'width' and 'height' options instead. - * + * * * * @optionValue New value to be set. @@ -36849,7 +36666,6 @@ interface SliceClickedEvent { } interface SliceClickedEventUIParam { - /** * Used to obtain reference to igFunnelChart. */ @@ -36872,7 +36688,6 @@ interface SliceClickedEventUIParam { } interface IgFunnelChart { - /** * Gets or sets values for upper and lower bezier points. That option has effect only when useBezierCurve is enabled. * Value should provide 4 numeric values in range from 0 to 1 separated by space character. @@ -36935,7 +36750,7 @@ interface IgFunnelChart { * Gets or sets whether the inner labels are visible. * * Valid values: - * "visible" + * "visible" * "collapsed" */ innerLabelVisibility?: string; @@ -36944,7 +36759,7 @@ interface IgFunnelChart { * Gets or sets whether the outer labels are visible. * * Valid values: - * "visible" + * "visible" * "collapsed" */ outerLabelVisibility?: string; @@ -37167,7 +36982,6 @@ interface IgFunnelChart { [optionName: string]: any; } interface IgFunnelChartMethods { - /** * Gets array of selected slice items. * @@ -37302,7 +37116,7 @@ interface IgFunnelChartMethods { dataBind(): void; } interface JQuery { - data(propertyName: "igFunnelChart"):IgFunnelChartMethods; + data(propertyName: "igFunnelChart"): IgFunnelChartMethods; } interface JQuery { @@ -37974,7 +37788,6 @@ interface JQuery { igFunnelChart(methodName: string, ...methodParams: any[]): any; } interface IgPopoverHeaderTemplate { - /** * Controls whether the popover renders a functional close button */ @@ -37996,7 +37809,6 @@ interface ShowingEvent { } interface ShowingEventUIParam { - /** * Used to get the element the popover will show for. */ @@ -38023,7 +37835,6 @@ interface ShownEvent { } interface ShownEventUIParam { - /** * Used to get the element the popover showed for. */ @@ -38050,7 +37861,6 @@ interface HidingEvent { } interface HidingEventUIParam { - /** * Used to get the element the popover will hide for. */ @@ -38077,7 +37887,6 @@ interface HiddenEvent { } interface HiddenEventUIParam { - /** * Used to get the element the popover is hidden for. */ @@ -38300,7 +38109,7 @@ interface IgGridFeatureChooserPopoverMethods { setCoordinates(pos: Object): void; } interface JQuery { - data(propertyName: "igGridFeatureChooserPopover"):IgGridFeatureChooserPopoverMethods; + data(propertyName: "igGridFeatureChooserPopover"): IgGridFeatureChooserPopoverMethods; } interface FeatureChooserRenderingEvent { @@ -38401,7 +38210,7 @@ interface IgGridFeatureChooserMethods { destroy(e: Object, args: Object): void; } interface JQuery { - data(propertyName: "igGridFeatureChooser"):IgGridFeatureChooserMethods; + data(propertyName: "igGridFeatureChooser"): IgGridFeatureChooserMethods; } interface JQuery { @@ -38787,7 +38596,6 @@ interface JQuery { igGridFeatureChooser(methodName: string, ...methodParams: any[]): any; } interface IgGridGroupByGroupedColumn { - /** * Key of the column that's grouped */ @@ -38818,7 +38626,6 @@ interface IgGridGroupByGroupedColumn { } interface IgGridGroupBySummarySettings { - /** * Specifies the delimiter for multiple summaries. * @@ -38838,7 +38645,6 @@ interface IgGridGroupBySummarySettings { } interface IgGridGroupByColumnSettingsSummaries { - /** * the summary function key * @@ -38865,7 +38671,7 @@ interface IgGridGroupByColumnSettingsSummaries { * array - array of cell values for the specified column, * key - key of the grouped column, * allGroupData - array of data records for the group(for the whole data source - not only for the data view) - * + * * * * Valid values: @@ -38881,7 +38687,6 @@ interface IgGridGroupByColumnSettingsSummaries { } interface IgGridGroupByColumnSettings { - /** * Enables/disables grouping a column from the UI. By default all columns can be grouped. * @@ -38950,7 +38755,6 @@ interface GroupedColumnsChangingEvent { } interface GroupedColumnsChangingEventUIParam { - /** * Used to access the GroupBy widget object */ @@ -38992,7 +38796,6 @@ interface GroupedColumnsChangedEvent { } interface GroupedColumnsChangedEventUIParam { - /** * Used to access the GroupBy widget object */ @@ -39029,7 +38832,6 @@ interface ModalDialogMovingEvent { } interface ModalDialogMovingEventUIParam { - /** * Used to get the reference to the igGridGroupBy widget. */ @@ -39056,7 +38858,6 @@ interface ModalDialogClosingEvent { } interface ModalDialogClosingEventUIParam { - /** * Used to get the reference to the igGridGroupBy widget. */ @@ -39073,7 +38874,6 @@ interface ModalDialogClosedEvent { } interface ModalDialogClosedEventUIParam { - /** * Used to get the reference to the igGridGroupBy widget. */ @@ -39090,7 +38890,6 @@ interface ModalDialogOpeningEvent { } interface ModalDialogOpeningEventUIParam { - /** * Used to get the reference to the igGridGroupBy widget. */ @@ -39107,7 +38906,6 @@ interface ModalDialogOpenedEvent { } interface ModalDialogOpenedEventUIParam { - /** * Used to get the reference to the igGridGroupBy widget. */ @@ -39124,7 +38922,6 @@ interface ModalDialogContentsRenderingEvent { } interface ModalDialogContentsRenderingEventUIParam { - /** * Used to get the reference to the igGridGroupby widget. */ @@ -39141,7 +38938,6 @@ interface ModalDialogContentsRenderedEvent { } interface ModalDialogContentsRenderedEventUIParam { - /** * Used to get the reference to the igGridGroupBy widget. */ @@ -39158,7 +38954,6 @@ interface ModalDialogButtonApplyClickEvent { } interface ModalDialogButtonApplyClickEventUIParam { - /** * Used to get the reference to the igGridGroupby widget. */ @@ -39190,7 +38985,6 @@ interface ModalDialogButtonResetClickEvent { } interface ModalDialogButtonResetClickEventUIParam { - /** * Used to get the reference to the igGridGroupby widget. */ @@ -39207,7 +39001,6 @@ interface ModalDialogGroupingColumnEvent { } interface ModalDialogGroupingColumnEventUIParam { - /** * Used to get the reference to the igGridGroupby widget. */ @@ -39229,7 +39022,6 @@ interface ModalDialogGroupColumnEvent { } interface ModalDialogGroupColumnEventUIParam { - /** * Used to get the reference to the igGridGroupby widget. */ @@ -39256,7 +39048,6 @@ interface ModalDialogUngroupingColumnEvent { } interface ModalDialogUngroupingColumnEventUIParam { - /** * Used to get the reference to the igGridGroupby widget. */ @@ -39278,7 +39069,6 @@ interface ModalDialogUngroupColumnEvent { } interface ModalDialogUngroupColumnEventUIParam { - /** * Used to get the reference to the igGridGroupby widget. */ @@ -39305,7 +39095,6 @@ interface ModalDialogSortGroupedColumnEvent { } interface ModalDialogSortGroupedColumnEventUIParam { - /** * Used to get the reference to the igGridGroupby widget. */ @@ -39328,7 +39117,6 @@ interface ModalDialogSortGroupedColumnEventUIParam { } interface IgGridGroupBy { - /** * Sets the place in the grid where the GroupBy area will be * @@ -39787,7 +39575,6 @@ interface IgGridGroupBy { [optionName: string]: any; } interface IgGridGroupByMethods { - /** * Open groupby modal dialog */ @@ -39877,7 +39664,7 @@ interface IgGridGroupByMethods { destroy(): void; } interface JQuery { - data(propertyName: "igGridGroupBy"):IgGridGroupByMethods; + data(propertyName: "igGridGroupBy"): IgGridGroupByMethods; } interface JQuery { @@ -40876,7 +40663,6 @@ interface JQuery { igGridGroupBy(methodName: string, ...methodParams: any[]): any; } interface IgGridHidingColumnSetting { - /** * Column key. this is a required property in every column setting if columnIndex is not set. * @@ -40912,7 +40698,6 @@ interface ColumnHidingEvent { } interface ColumnHidingEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -40934,7 +40719,6 @@ interface ColumnHidingRefusedEvent { } interface ColumnHidingRefusedEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -40947,7 +40731,6 @@ interface ColumnShowingRefusedEvent { } interface ColumnShowingRefusedEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -40960,7 +40743,6 @@ interface MultiColumnHidingEvent { } interface MultiColumnHidingEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -40977,7 +40759,6 @@ interface ColumnHiddenEvent { } interface ColumnHiddenEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -40999,7 +40780,6 @@ interface ColumnShowingEvent { } interface ColumnShowingEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -41021,7 +40801,6 @@ interface ColumnShownEvent { } interface ColumnShownEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -41043,7 +40822,6 @@ interface ColumnChooserOpeningEvent { } interface ColumnChooserOpeningEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -41060,7 +40838,6 @@ interface ColumnChooserOpenedEvent { } interface ColumnChooserOpenedEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -41077,7 +40854,6 @@ interface ColumnChooserMovingEvent { } interface ColumnChooserMovingEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -41104,7 +40880,6 @@ interface ColumnChooserClosingEvent { } interface ColumnChooserClosingEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -41121,7 +40896,6 @@ interface ColumnChooserClosedEvent { } interface ColumnChooserClosedEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -41138,7 +40912,6 @@ interface ColumnChooserContentsRenderingEvent { } interface ColumnChooserContentsRenderingEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -41155,7 +40928,6 @@ interface ColumnChooserContentsRenderedEvent { } interface ColumnChooserContentsRenderedEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -41172,7 +40944,6 @@ interface ColumnChooserButtonApplyClickEvent { } interface ColumnChooserButtonApplyClickEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -41199,7 +40970,6 @@ interface ColumnChooserButtonResetClickEvent { } interface ColumnChooserButtonResetClickEventUIParam { - /** * Used to get the reference to the GridHiding widget. */ @@ -41212,7 +40982,6 @@ interface ColumnChooserButtonResetClickEventUIParam { } interface IgGridHiding { - /** * A list of column settings that specifies hiding options on a per column basis. * @@ -41227,7 +40996,7 @@ interface IgGridHiding { /** * Controls containment behavior. - * + * * owner The column chooser dialog will be draggable only in the grid area * window The column chooser dialog will be draggable in the whole window area */ @@ -41487,7 +41256,6 @@ interface IgGridHiding { [optionName: string]: any; } interface IgGridHidingMethods { - /** * Destroys the hiding widget */ @@ -41562,7 +41330,7 @@ interface IgGridHidingMethods { removeColumnChooserResetButton(): void; } interface JQuery { - data(propertyName: "igGridHiding"):IgGridHidingMethods; + data(propertyName: "igGridHiding"): IgGridHidingMethods; } interface JQuery { @@ -41608,7 +41376,7 @@ interface JQuery { /** * Controls containment behavior. - * + * * owner The column chooser dialog will be draggable only in the grid area * window The column chooser dialog will be draggable in the whole window area */ @@ -41616,7 +41384,7 @@ interface JQuery { /** * Controls containment behavior. - * + * * owner The column chooser dialog will be draggable only in the grid area * window The column chooser dialog will be draggable in the whole window area * @@ -42190,7 +41958,6 @@ interface JQuery { igGridHiding(methodName: string, ...methodParams: any[]): any; } interface IgHierarchicalGridColumnLayout { - /** * Specifies the columnLayout key. This is the property that holds the data records for the current column layout. */ @@ -42217,7 +41984,6 @@ interface RowExpandingEvent { } interface RowExpandingEventUIParam { - /** * Used to access the hierarchical grid object */ @@ -42234,7 +42000,6 @@ interface RowExpandedEvent { } interface RowExpandedEventUIParam { - /** * Used to access the hierarchical grid object */ @@ -42251,7 +42016,6 @@ interface RowCollapsingEvent { } interface RowCollapsingEventUIParam { - /** * Used to access the hierarchical grid object */ @@ -42268,7 +42032,6 @@ interface RowCollapsedEvent { } interface RowCollapsedEventUIParam { - /** * Used to access the hierarchical grid object */ @@ -42285,7 +42048,6 @@ interface ChildrenPopulatingEvent { } interface ChildrenPopulatingEventUIParam { - /** * Used to access the hierarchical grid object */ @@ -42307,7 +42069,6 @@ interface ChildrenPopulatedEvent { } interface ChildrenPopulatedEventUIParam { - /** * Used to access the hierarchical grid object */ @@ -42329,7 +42090,6 @@ interface ChildGridRenderedEvent { } interface ChildGridRenderedEventUIParam { - /** * Used to access the hierarchical grid object */ @@ -42361,7 +42121,6 @@ interface ChildGridCreatedEventUIParam { } interface IgHierarchicalGrid { - /** * Only the first level will be data-bound initially. Also serves as "render" depth, meaning that depending on this prop, the grid will */ @@ -42507,7 +42266,6 @@ interface IgHierarchicalGrid { [optionName: string]: any; } interface IgHierarchicalGridMethods { - /** * Data binds the hierarchical grid. No child grids will be created or rendered by default, unless there is initialExpandDepth >= 0 set. */ @@ -42607,7 +42365,7 @@ interface IgHierarchicalGridMethods { destroy(): void; } interface JQuery { - data(propertyName: "igHierarchicalGrid"):IgHierarchicalGridMethods; + data(propertyName: "igHierarchicalGrid"): IgHierarchicalGridMethods; } interface JQuery { @@ -42963,7 +42721,6 @@ interface GroupCollapsingEvent { } interface GroupCollapsingEventUIParam { - /** * Used to get the reference to the GridMultiColumnHeaders widget. */ @@ -42985,7 +42742,6 @@ interface GroupCollapsedEvent { } interface GroupCollapsedEventUIParam { - /** * Used to get the reference to the GridMultiColumnHeaders widget. */ @@ -43007,7 +42763,6 @@ interface GroupExpandingEvent { } interface GroupExpandingEventUIParam { - /** * Used to get the reference to the GridMultiColumnHeaders widget. */ @@ -43029,7 +42784,6 @@ interface GroupExpandedEvent { } interface GroupExpandedEventUIParam { - /** * Used to get the reference to the GridMultiColumnHeaders widget. */ @@ -43047,7 +42801,6 @@ interface GroupExpandedEventUIParam { } interface IgGridMultiColumnHeaders { - /** * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. */ @@ -43099,7 +42852,6 @@ interface IgGridMultiColumnHeaders { [optionName: string]: any; } interface IgGridMultiColumnHeadersMethods { - /** * Expands a collapsed group. If the group is expanded, the method does nothing. * Note: This method is asynchronous which means that it returns immediately and any subsequent code will execute in parallel. This may lead to runtime errors. To avoid them put the subsequent code in the callback parameter provided by the method. @@ -43138,7 +42890,7 @@ interface IgGridMultiColumnHeadersMethods { destroy(): void; } interface JQuery { - data(propertyName: "igGridMultiColumnHeaders"):IgGridMultiColumnHeadersMethods; + data(propertyName: "igGridMultiColumnHeaders"): IgGridMultiColumnHeadersMethods; } interface JQuery { @@ -43258,7 +43010,6 @@ interface PageIndexChangingEvent { } interface PageIndexChangingEventUIParam { - /** * Used to get reference to GridPaging. */ @@ -43280,7 +43031,6 @@ interface PageIndexChangedEvent { } interface PageIndexChangedEventUIParam { - /** * Used to get reference to GridPaging. */ @@ -43297,7 +43047,6 @@ interface PageSizeChangingEvent { } interface PageSizeChangingEventUIParam { - /** * Used to get reference to GridPaging. */ @@ -43319,7 +43068,6 @@ interface PageSizeChangedEvent { } interface PageSizeChangedEventUIParam { - /** * Used to get reference to GridPaging. */ @@ -43336,7 +43084,6 @@ interface PagerRenderingEvent { } interface PagerRenderingEventUIParam { - /** * Used to get reference to GridPaging. */ @@ -43353,7 +43100,6 @@ interface PagerRenderedEvent { } interface PagerRenderedEventUIParam { - /** * Used to get reference to GridPaging. */ @@ -43366,7 +43112,6 @@ interface PagerRenderedEventUIParam { } interface IgGridPaging { - /** * Number of records loaded and displayed per page. * @@ -43580,7 +43325,7 @@ interface IgGridPaging { persist?: boolean; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. * */ inherit?: boolean; @@ -43650,7 +43395,6 @@ interface IgGridPaging { [optionName: string]: any; } interface IgGridPagingMethods { - /** * Gets/Sets the current page index, delegates data binding and paging to [$.ig.DataSource](ig.datasource). * @@ -43671,7 +43415,7 @@ interface IgGridPagingMethods { destroy(): void; } interface JQuery { - data(propertyName: "igGridPaging"):IgGridPagingMethods; + data(propertyName: "igGridPaging"): IgGridPagingMethods; } interface JQuery { @@ -44156,13 +43900,13 @@ interface JQuery { igGridPaging(optionLiteral: 'option', optionName: "persist", optionValue: boolean): void; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. * */ igGridPaging(optionLiteral: 'option', optionName: "inherit"): boolean; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. * * * @optionValue New value to be set. @@ -44305,7 +44049,6 @@ interface JQuery { igGridPaging(methodName: string, ...methodParams: any[]): any; } interface IgGridResizingColumnSetting { - /** * Column key. this is a required property in every column setting if columnIndex is not set. * @@ -44347,7 +44090,6 @@ interface ColumnResizingEvent { } interface ColumnResizingEventUIParam { - /** * Used to get the reference to the GridResizing widget. */ @@ -44374,7 +44116,6 @@ interface ColumnResizingRefusedEvent { } interface ColumnResizingRefusedEventUIParam { - /** * Used to get the reference to the GridResizing widget. */ @@ -44401,7 +44142,6 @@ interface ColumnResizedEvent { } interface ColumnResizedEventUIParam { - /** * Used to get the reference to the GridResizing widget. */ @@ -44429,7 +44169,6 @@ interface ColumnResizedEventUIParam { } interface IgGridResizing { - /** * Resize the column to the size of the longest currently visible cell value. * @@ -44499,7 +44238,6 @@ interface IgGridResizing { [optionName: string]: any; } interface IgGridResizingMethods { - /** * Destroys the resizing widget */ @@ -44514,7 +44252,7 @@ interface IgGridResizingMethods { resize(column: Object, width?: Object): void; } interface JQuery { - data(propertyName: "igGridResizing"):IgGridResizingMethods; + data(propertyName: "igGridResizing"): IgGridResizingMethods; } interface JQuery { @@ -44669,7 +44407,6 @@ interface JQuery { igGridResizing(methodName: string, ...methodParams: any[]): any; } interface IgGridResponsiveColumnSetting { - /** * Column key. This is a required property in every column setting if columnIndex is not set. * @@ -44701,7 +44438,6 @@ interface IgGridResponsiveColumnSetting { } interface IgGridResponsiveAllowedColumnWidthPerType { - /** * Minimal width in pixels string columns can take before forcing vertical rendering * @@ -44743,7 +44479,6 @@ interface ResponsiveColumnHidingEvent { } interface ResponsiveColumnHidingEventUIParam { - /** * Used to get the reference to the igGridResponsive widget. */ @@ -44765,7 +44500,6 @@ interface ResponsiveColumnHiddenEvent { } interface ResponsiveColumnHiddenEventUIParam { - /** * Used to get the reference to the igGridResponsive widget. */ @@ -44787,7 +44521,6 @@ interface ResponsiveColumnShowingEvent { } interface ResponsiveColumnShowingEventUIParam { - /** * Used to get the reference to the igGridResponsive widget. */ @@ -44809,7 +44542,6 @@ interface ResponsiveColumnShownEvent { } interface ResponsiveColumnShownEventUIParam { - /** * Used to get the reference to the igGridResponsive widget. */ @@ -44831,7 +44563,6 @@ interface ResponsiveModeChangedEvent { } interface ResponsiveModeChangedEventUIParam { - /** * Used to get the reference to the igGridResponsive widget. */ @@ -44849,7 +44580,6 @@ interface ResponsiveModeChangedEventUIParam { } interface IgGridResponsive { - /** * A list of column settings that specifies how columns will react based on the environment the grid is run on. * @@ -44991,7 +44721,6 @@ interface IgGridResponsive { [optionName: string]: any; } interface IgGridResponsiveMethods { - /** * Destroys the responsive widget. */ @@ -45003,7 +44732,7 @@ interface IgGridResponsiveMethods { getCurrentResponsiveMode(): void; } interface JQuery { - data(propertyName: "igGridResponsive"):IgGridResponsiveMethods; + data(propertyName: "igGridResponsive"): IgGridResponsiveMethods; } interface ResponsiveModeSettings { @@ -45018,11 +44747,11 @@ interface ResponsiveModeSettings { [optionName: string]: any; } -declare module Infragistics { -export class ResponsiveMode { - constructor(settings: ResponsiveModeSettings); - isActive(): void; -} +declare namespace Infragistics { + class ResponsiveMode { + constructor(settings: ResponsiveModeSettings); + isActive(): void; + } } interface IgniteUIStatic { ResponsiveMode: typeof Infragistics.ResponsiveMode; @@ -45038,11 +44767,11 @@ interface InfragisticsModeSettings { [optionName: string]: any; } -declare module Infragistics { -export class InfragisticsMode { - constructor(settings: InfragisticsModeSettings); - isActive(): void; -} +declare namespace Infragistics { + class InfragisticsMode { + constructor(settings: InfragisticsModeSettings); + isActive(): void; + } } interface IgniteUIStatic { InfragisticsMode: typeof Infragistics.InfragisticsMode; @@ -45058,11 +44787,11 @@ interface BootstrapModeSettings { [optionName: string]: any; } -declare module Infragistics { -export class BootstrapMode { - constructor(settings: BootstrapModeSettings); - isActive(): void; -} +declare namespace Infragistics { + class BootstrapMode { + constructor(settings: BootstrapModeSettings); + isActive(): void; + } } interface IgniteUIStatic { BootstrapMode: typeof Infragistics.BootstrapMode; @@ -45360,7 +45089,6 @@ interface RowSelectorClickedEvent { } interface RowSelectorClickedEventUIParam { - /** * Used to get reference to the row the clicked row selector resides in. */ @@ -45402,7 +45130,6 @@ interface CheckBoxStateChangingEvent { } interface CheckBoxStateChangingEventUIParam { - /** * Used to get reference to the row the clicked row selector resides in. */ @@ -45454,7 +45181,6 @@ interface CheckBoxStateChangedEvent { } interface CheckBoxStateChangedEventUIParam { - /** * Used to get reference to the row the clicked row selector resides in. */ @@ -45497,7 +45223,6 @@ interface CheckBoxStateChangedEventUIParam { } interface IgGridRowSelectors { - /** * Determines whether the row selectors column should contain row numbering * @@ -45517,7 +45242,7 @@ interface IgGridRowSelectors { rowNumberingSeed?: number; /** - * + * * * Valid values: * "string" The row selector column width can be set in pixels (px) and percentage (%) @@ -45622,7 +45347,7 @@ interface IgGridRowSelectorsMethods { destroy(): void; } interface JQuery { - data(propertyName: "igGridRowSelectors"):IgGridRowSelectorsMethods; + data(propertyName: "igGridRowSelectors"): IgGridRowSelectorsMethods; } interface JQuery { @@ -45884,7 +45609,6 @@ interface RowSelectionChangingEvent { } interface RowSelectionChangingEventUIParam { - /** * Used to get reference to GridSelection. */ @@ -45916,7 +45640,6 @@ interface RowSelectionChangedEvent { } interface RowSelectionChangedEventUIParam { - /** * Used to get reference to GridSelection. */ @@ -45938,7 +45661,6 @@ interface CellSelectionChangingEvent { } interface CellSelectionChangingEventUIParam { - /** * Used to get reference to GridSelection. */ @@ -45980,7 +45702,6 @@ interface CellSelectionChangedEvent { } interface CellSelectionChangedEventUIParam { - /** * Used to get reference to GridSelection. */ @@ -46002,7 +45723,6 @@ interface ActiveCellChangingEvent { } interface ActiveCellChangingEventUIParam { - /** * Used to get reference to GridSelection. */ @@ -46019,7 +45739,6 @@ interface ActiveCellChangedEvent { } interface ActiveCellChangedEventUIParam { - /** * Used to get reference to GridSelection. */ @@ -46036,7 +45755,6 @@ interface ActiveRowChangingEvent { } interface ActiveRowChangingEventUIParam { - /** * Used to get reference to GridSelection. */ @@ -46053,7 +45771,6 @@ interface ActiveRowChangedEvent { } interface ActiveRowChangedEventUIParam { - /** * Used to get reference to GridSelection. */ @@ -46066,7 +45783,6 @@ interface ActiveRowChangedEventUIParam { } interface IgGridSelection { - /** * Enables / Disables multiple selection of cells and rows - depending on the mode * @@ -46259,7 +45975,6 @@ interface IgGridSelection { [optionName: string]: any; } interface IgGridSelectionMethods { - /** * Destroys the selection widget. */ @@ -46334,28 +46049,28 @@ interface IgGridSelectionMethods { /** * Returns an array of selected cells in arbitrary order where every objects has the format { element: , row: , index: , rowIndex: , columnKey: } . - * + * * If multiple selection is disabled the function will return null. */ selectedCells(): any[]; /** * Returns an array of selected rows in arbitrary order where every object has the format { element: , index: } . - * + * * If multiple selection is disabled the function will return null. */ selectedRows(): any[]; /** * Returns the currently selected cell that has the format { element: , row: , index: , rowIndex: , columnKey: }, if any. - * + * * If multiple selection is enabled the function will return null. */ selectedCell(): Object; /** * Returns the currently selected row that has the format { element: , index: }, if any. - * + * * If multiple selection is enabled the function will return null. */ selectedRow(): Object; @@ -46371,11 +46086,10 @@ interface IgGridSelectionMethods { activeRow(): Object; } interface JQuery { - data(propertyName: "igGridSelection"):IgGridSelectionMethods; + data(propertyName: "igGridSelection"): IgGridSelectionMethods; } interface SelectionCollectionSettingsSubscribers { - /** * Option for SelectionCollectionSettingsSubscribers */ @@ -46393,94 +46107,94 @@ interface SelectionCollectionSettings { [optionName: string]: any; } -declare module Infragistics { -export class SelectionCollection { - constructor(settings: SelectionCollectionSettings); - addSubscriber(subscriber: Object, owner: Object): void; - removeSubscriber(subscriberId: Object, owner: Object): void; - changeOwner(newOwner: Object): void; - isSelected(identifier: Object, forOwner: Object): void; - isActive(identifier: Object, forOwner: Object): void; - elementFromIdentifier(identifier: Object): void; - toggle(element: Object): void; - activate(identifier: Object, element: Object, suppress: Object): void; - deactivate(suppress: Object): void; - select(identifier: Object, add: Object, info: Object, suppress: Object): void; - rangeSelect(range: Object, add: Object, prevRange: Object, info: Object, suppress: Object): void; - rangeDeselect(range: Object, info: Object, suppress: Object): void; - deselect(identifier: Object, info: Object, suppress: Object): void; - deselectAll(suppress: Object): void; - clearSelection(forOwner: Object): void; - cleanAll(forOwner: Object): void; - onlyOneSelected(): void; - selectedCells(): void; - selectedRows(): void; - selectionLength(): void; -} +declare namespace Infragistics { + class SelectionCollection { + constructor(settings: SelectionCollectionSettings); + addSubscriber(subscriber: Object, owner: Object): void; + removeSubscriber(subscriberId: Object, owner: Object): void; + changeOwner(newOwner: Object): void; + isSelected(identifier: Object, forOwner: Object): void; + isActive(identifier: Object, forOwner: Object): void; + elementFromIdentifier(identifier: Object): void; + toggle(element: Object): void; + activate(identifier: Object, element: Object, suppress: Object): void; + deactivate(suppress: Object): void; + select(identifier: Object, add: Object, info: Object, suppress: Object): void; + rangeSelect(range: Object, add: Object, prevRange: Object, info: Object, suppress: Object): void; + rangeDeselect(range: Object, info: Object, suppress: Object): void; + deselect(identifier: Object, info: Object, suppress: Object): void; + deselectAll(suppress: Object): void; + clearSelection(forOwner: Object): void; + cleanAll(forOwner: Object): void; + onlyOneSelected(): void; + selectedCells(): void; + selectedRows(): void; + selectionLength(): void; + } } interface IgniteUIStatic { SelectionCollection: typeof Infragistics.SelectionCollection; } -declare module Infragistics { -export class SelectedRowsCollection { - constructor(settings: SelectionCollectionSettings); - isSelected(identifier: Object, forOwner: Object): void; - isActive(identifier: Object, forOwner: Object): void; - selectedDataRows(): void; - selectedRows(): void; - activeRow(): void; - elementFromIdentifier(identifier: Object): void; - elementPosition(identifier: Object, element: Object): void; - onlyOneSelected(): void; - addSubscriber(subscriber: Object, owner: Object): void; - removeSubscriber(subscriberId: Object, owner: Object): void; - changeOwner(newOwner: Object): void; - toggle(element: Object): void; - activate(identifier: Object, element: Object, suppress: Object): void; - deactivate(suppress: Object): void; - select(identifier: Object, add: Object, info: Object, suppress: Object): void; - rangeSelect(range: Object, add: Object, prevRange: Object, info: Object, suppress: Object): void; - rangeDeselect(range: Object, info: Object, suppress: Object): void; - deselect(identifier: Object, info: Object, suppress: Object): void; - deselectAll(suppress: Object): void; - clearSelection(forOwner: Object): void; - cleanAll(forOwner: Object): void; - selectedCells(): void; - selectionLength(): void; -} +declare namespace Infragistics { + class SelectedRowsCollection { + constructor(settings: SelectionCollectionSettings); + isSelected(identifier: Object, forOwner: Object): void; + isActive(identifier: Object, forOwner: Object): void; + selectedDataRows(): void; + selectedRows(): void; + activeRow(): void; + elementFromIdentifier(identifier: Object): void; + elementPosition(identifier: Object, element: Object): void; + onlyOneSelected(): void; + addSubscriber(subscriber: Object, owner: Object): void; + removeSubscriber(subscriberId: Object, owner: Object): void; + changeOwner(newOwner: Object): void; + toggle(element: Object): void; + activate(identifier: Object, element: Object, suppress: Object): void; + deactivate(suppress: Object): void; + select(identifier: Object, add: Object, info: Object, suppress: Object): void; + rangeSelect(range: Object, add: Object, prevRange: Object, info: Object, suppress: Object): void; + rangeDeselect(range: Object, info: Object, suppress: Object): void; + deselect(identifier: Object, info: Object, suppress: Object): void; + deselectAll(suppress: Object): void; + clearSelection(forOwner: Object): void; + cleanAll(forOwner: Object): void; + selectedCells(): void; + selectionLength(): void; + } } interface IgniteUIStatic { SelectedRowsCollection: typeof Infragistics.SelectedRowsCollection; } -declare module Infragistics { -export class SelectedCellsCollection { - constructor(settings: SelectionCollectionSettings); - isSelected(identifier: Object, forOwner: Object): void; - atLeastOneSelected(rowId: Object, forOwner: Object): void; - isActive(identifier: Object, forOwner: Object): void; - selectedCells(): void; - activeCell(): void; - elementFromIdentifier(identifier: Object): void; - elementPosition(identifier: Object, element: Object): void; - onlyOneSelected(): void; - addSubscriber(subscriber: Object, owner: Object): void; - removeSubscriber(subscriberId: Object, owner: Object): void; - changeOwner(newOwner: Object): void; - toggle(element: Object): void; - activate(identifier: Object, element: Object, suppress: Object): void; - deactivate(suppress: Object): void; - select(identifier: Object, add: Object, info: Object, suppress: Object): void; - rangeSelect(range: Object, add: Object, prevRange: Object, info: Object, suppress: Object): void; - rangeDeselect(range: Object, info: Object, suppress: Object): void; - deselect(identifier: Object, info: Object, suppress: Object): void; - deselectAll(suppress: Object): void; - clearSelection(forOwner: Object): void; - cleanAll(forOwner: Object): void; - selectedRows(): void; - selectionLength(): void; -} +declare namespace Infragistics { + class SelectedCellsCollection { + constructor(settings: SelectionCollectionSettings); + isSelected(identifier: Object, forOwner: Object): void; + atLeastOneSelected(rowId: Object, forOwner: Object): void; + isActive(identifier: Object, forOwner: Object): void; + selectedCells(): void; + activeCell(): void; + elementFromIdentifier(identifier: Object): void; + elementPosition(identifier: Object, element: Object): void; + onlyOneSelected(): void; + addSubscriber(subscriber: Object, owner: Object): void; + removeSubscriber(subscriberId: Object, owner: Object): void; + changeOwner(newOwner: Object): void; + toggle(element: Object): void; + activate(identifier: Object, element: Object, suppress: Object): void; + deactivate(suppress: Object): void; + select(identifier: Object, add: Object, info: Object, suppress: Object): void; + rangeSelect(range: Object, add: Object, prevRange: Object, info: Object, suppress: Object): void; + rangeDeselect(range: Object, info: Object, suppress: Object): void; + deselect(identifier: Object, info: Object, suppress: Object): void; + deselectAll(suppress: Object): void; + clearSelection(forOwner: Object): void; + cleanAll(forOwner: Object): void; + selectedRows(): void; + selectionLength(): void; + } } interface IgniteUIStatic { SelectedCellsCollection: typeof Infragistics.SelectedCellsCollection; @@ -46914,7 +46628,6 @@ interface ButtonOKClickEvent { } interface ButtonOKClickEventUIParam { - /** * Used to get the reference to the igGridModalDialog widget. */ @@ -46931,7 +46644,6 @@ interface ButtonCancelClickEvent { } interface ButtonCancelClickEventUIParam { - /** * Used to get the reference to the igGridModalDialog widget. */ @@ -47061,11 +46773,10 @@ interface IgGridModalDialogMethods { destroy(): void; } interface JQuery { - data(propertyName: "igGridModalDialog"):IgGridModalDialogMethods; + data(propertyName: "igGridModalDialog"): IgGridModalDialogMethods; } interface IgEditorFilter { - /** * Option for igEditorFilter */ @@ -47080,266 +46791,264 @@ interface IgEditorFilterMethods { destroy(): void; } interface JQuery { - data(propertyName: "igEditorFilter"):IgEditorFilterMethods; + data(propertyName: "igEditorFilter"): IgEditorFilterMethods; } -declare module Infragistics { -export class EditorProvider { - - /** - * Create handlers cache - * - * @param callbacks - * @param key - * @param editorOptions - * @param tabIndex - * @param format - * @param element - */ - createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; - keyDown(evt: Object, ui: Object): void; - attachErrorEvents(errorShowing: Object, errorShown: Object, errorHidden: Object): void; - getEditor(): void; - refreshValue(): void; - getValue(): void; - setValue(val: Object): void; - setFocus(toggle: Object): void; - setSize(width: Object, height: Object): void; - removeFromParent(): void; - destroy(): void; - validator(): void; - validate(): void; - requestValidate(evt: Object): void; - isValid(): void; -} +declare namespace Infragistics { + class EditorProvider { + /** + * Create handlers cache + * + * @param callbacks + * @param key + * @param editorOptions + * @param tabIndex + * @param format + * @param element + */ + createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; + keyDown(evt: Object, ui: Object): void; + attachErrorEvents(errorShowing: Object, errorShown: Object, errorHidden: Object): void; + getEditor(): void; + refreshValue(): void; + getValue(): void; + setValue(val: Object): void; + setFocus(toggle: Object): void; + setSize(width: Object, height: Object): void; + removeFromParent(): void; + destroy(): void; + validator(): void; + validate(): void; + requestValidate(evt: Object): void; + isValid(): void; + } } -declare module Infragistics { -export class EditorProviderBase { - - /** - * Call parent createEditor - * - * @param callbacks - * @param key - * @param editorOptions - * @param tabIndex - * @param format - * @param element - */ - createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; - textChanged(evt: Object, ui: Object): void; - setSize(width: Object, height: Object): void; - setFocus(): void; - removeFromParent(): void; - destroy(): void; - refreshValue(): void; - validator(): void; - isValid(): void; - keyDown(evt: Object, ui: Object): void; - attachErrorEvents(errorShowing: Object, errorShown: Object, errorHidden: Object): void; - getEditor(): void; - getValue(): void; - setValue(val: Object): void; - validate(): void; - requestValidate(evt: Object): void; -} +declare namespace Infragistics { + class EditorProviderBase { + /** + * Call parent createEditor + * + * @param callbacks + * @param key + * @param editorOptions + * @param tabIndex + * @param format + * @param element + */ + createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; + textChanged(evt: Object, ui: Object): void; + setSize(width: Object, height: Object): void; + setFocus(): void; + removeFromParent(): void; + destroy(): void; + refreshValue(): void; + validator(): void; + isValid(): void; + keyDown(evt: Object, ui: Object): void; + attachErrorEvents(errorShowing: Object, errorShown: Object, errorHidden: Object): void; + getEditor(): void; + getValue(): void; + setValue(val: Object): void; + validate(): void; + requestValidate(evt: Object): void; + } } -declare module Infragistics { -export class EditorProviderText { - createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; - keyDown(evt: Object, ui: Object): void; - textChanged(evt: Object, ui: Object): void; - setSize(width: Object, height: Object): void; - setFocus(): void; - removeFromParent(): void; - destroy(): void; - refreshValue(): void; - validator(): void; - isValid(): void; -} +declare namespace Infragistics { + class EditorProviderText { + createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; + keyDown(evt: Object, ui: Object): void; + textChanged(evt: Object, ui: Object): void; + setSize(width: Object, height: Object): void; + setFocus(): void; + removeFromParent(): void; + destroy(): void; + refreshValue(): void; + validator(): void; + isValid(): void; + } } -declare module Infragistics { -export class EditorProviderNumeric { - createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; - getValue(): void; - textChanged(evt: Object, ui: Object): void; - setSize(width: Object, height: Object): void; - setFocus(): void; - removeFromParent(): void; - destroy(): void; - refreshValue(): void; - validator(): void; - isValid(): void; -} +declare namespace Infragistics { + class EditorProviderNumeric { + createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; + getValue(): void; + textChanged(evt: Object, ui: Object): void; + setSize(width: Object, height: Object): void; + setFocus(): void; + removeFromParent(): void; + destroy(): void; + refreshValue(): void; + validator(): void; + isValid(): void; + } } -declare module Infragistics { -export class EditorProviderCurrency { - createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; - textChanged(evt: Object, ui: Object): void; - setSize(width: Object, height: Object): void; - setFocus(): void; - removeFromParent(): void; - destroy(): void; - refreshValue(): void; - validator(): void; - isValid(): void; -} +declare namespace Infragistics { + class EditorProviderCurrency { + createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; + textChanged(evt: Object, ui: Object): void; + setSize(width: Object, height: Object): void; + setFocus(): void; + removeFromParent(): void; + destroy(): void; + refreshValue(): void; + validator(): void; + isValid(): void; + } } -declare module Infragistics { -export class EditorProviderPercent { - createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; - textChanged(evt: Object, ui: Object): void; - setSize(width: Object, height: Object): void; - setFocus(): void; - removeFromParent(): void; - destroy(): void; - refreshValue(): void; - validator(): void; - isValid(): void; -} +declare namespace Infragistics { + class EditorProviderPercent { + createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; + textChanged(evt: Object, ui: Object): void; + setSize(width: Object, height: Object): void; + setFocus(): void; + removeFromParent(): void; + destroy(): void; + refreshValue(): void; + validator(): void; + isValid(): void; + } } -declare module Infragistics { -export class EditorProviderMask { - createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; - textChanged(evt: Object, ui: Object): void; - setSize(width: Object, height: Object): void; - setFocus(): void; - removeFromParent(): void; - destroy(): void; - refreshValue(): void; - validator(): void; - isValid(): void; -} +declare namespace Infragistics { + class EditorProviderMask { + createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; + textChanged(evt: Object, ui: Object): void; + setSize(width: Object, height: Object): void; + setFocus(): void; + removeFromParent(): void; + destroy(): void; + refreshValue(): void; + validator(): void; + isValid(): void; + } } -declare module Infragistics { -export class EditorProviderDate { - createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; - textChanged(evt: Object, ui: Object): void; - setSize(width: Object, height: Object): void; - setFocus(): void; - removeFromParent(): void; - destroy(): void; - refreshValue(): void; - validator(): void; - isValid(): void; -} +declare namespace Infragistics { + class EditorProviderDate { + createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; + textChanged(evt: Object, ui: Object): void; + setSize(width: Object, height: Object): void; + setFocus(): void; + removeFromParent(): void; + destroy(): void; + refreshValue(): void; + validator(): void; + isValid(): void; + } } -declare module Infragistics { -export class EditorProviderDatePicker { - createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; - removeFromParent(): void; - textChanged(evt: Object, ui: Object): void; - setSize(width: Object, height: Object): void; - setFocus(): void; - destroy(): void; - refreshValue(): void; - validator(): void; - isValid(): void; -} +declare namespace Infragistics { + class EditorProviderDatePicker { + createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; + removeFromParent(): void; + textChanged(evt: Object, ui: Object): void; + setSize(width: Object, height: Object): void; + setFocus(): void; + destroy(): void; + refreshValue(): void; + validator(): void; + isValid(): void; + } } -declare module Infragistics { -export class EditorProviderBoolean { - createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; - valueChanged(evt: Object, ui: Object): void; - refreshValue(): void; - getValue(): void; - setValue(val: Object): void; - setSize(width: Object, height: Object): void; - removeFromParent(): void; - destroy(): void; - textChanged(evt: Object, ui: Object): void; - setFocus(): void; - validator(): void; - isValid(): void; -} +declare namespace Infragistics { + class EditorProviderBoolean { + createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; + valueChanged(evt: Object, ui: Object): void; + refreshValue(): void; + getValue(): void; + setValue(val: Object): void; + setSize(width: Object, height: Object): void; + removeFromParent(): void; + destroy(): void; + textChanged(evt: Object, ui: Object): void; + setFocus(): void; + validator(): void; + isValid(): void; + } } -declare module Infragistics { -export class EditorProviderCombo { - createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; - keyDown(evt: Object, ui: Object): void; - internalSelectionChanged(evt: Object, ui: Object): void; - selectionChanged(evt: Object, ui: Object): void; - refreshValue(): void; - getValue(): void; - setValue(val: Object, fire: Object): void; - setSize(width: Object, height: Object): void; - setFocus(): void; - removeFromParent(): void; - validator(): void; - destroy(): void; - isValid(): void; - attachErrorEvents(errorShowing: Object, errorShown: Object, errorHidden: Object): void; - getEditor(): void; - validate(): void; - requestValidate(evt: Object): void; -} +declare namespace Infragistics { + class EditorProviderCombo { + createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; + keyDown(evt: Object, ui: Object): void; + internalSelectionChanged(evt: Object, ui: Object): void; + selectionChanged(evt: Object, ui: Object): void; + refreshValue(): void; + getValue(): void; + setValue(val: Object, fire: Object): void; + setSize(width: Object, height: Object): void; + setFocus(): void; + removeFromParent(): void; + validator(): void; + destroy(): void; + isValid(): void; + attachErrorEvents(errorShowing: Object, errorShown: Object, errorHidden: Object): void; + getEditor(): void; + validate(): void; + requestValidate(evt: Object): void; + } } -declare module Infragistics { -export class EditorProviderObjectCombo { - getValue(): void; - setValue(val: Object, fire: Object): void; - createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; - keyDown(evt: Object, ui: Object): void; - internalSelectionChanged(evt: Object, ui: Object): void; - selectionChanged(evt: Object, ui: Object): void; - refreshValue(): void; - setSize(width: Object, height: Object): void; - setFocus(): void; - removeFromParent(): void; - validator(): void; - destroy(): void; - isValid(): void; -} +declare namespace Infragistics { + class EditorProviderObjectCombo { + getValue(): void; + setValue(val: Object, fire: Object): void; + createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; + keyDown(evt: Object, ui: Object): void; + internalSelectionChanged(evt: Object, ui: Object): void; + selectionChanged(evt: Object, ui: Object): void; + refreshValue(): void; + setSize(width: Object, height: Object): void; + setFocus(): void; + removeFromParent(): void; + validator(): void; + destroy(): void; + isValid(): void; + } } -declare module Infragistics { -export class EditorProviderRating { - createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; - internalValueChange(evt: Object, ui: Object): void; - valueChange(evt: Object, ui: Object): void; - setValue(val: Object): void; - setSize(width: Object, height: Object): void; - setFocus(): void; - validator(): void; - destroy(): void; - isValid(): void; - keyDown(evt: Object, ui: Object): void; - attachErrorEvents(errorShowing: Object, errorShown: Object, errorHidden: Object): void; - getEditor(): void; - refreshValue(): void; - getValue(): void; - removeFromParent(): void; - validate(): void; - requestValidate(evt: Object): void; -} +declare namespace Infragistics { + class EditorProviderRating { + createEditor(callbacks: Object, key: Object, editorOptions: Object, tabIndex: Object, format: Object, element: Object): void; + internalValueChange(evt: Object, ui: Object): void; + valueChange(evt: Object, ui: Object): void; + setValue(val: Object): void; + setSize(width: Object, height: Object): void; + setFocus(): void; + validator(): void; + destroy(): void; + isValid(): void; + keyDown(evt: Object, ui: Object): void; + attachErrorEvents(errorShowing: Object, errorShown: Object, errorHidden: Object): void; + getEditor(): void; + refreshValue(): void; + getValue(): void; + removeFromParent(): void; + validate(): void; + requestValidate(evt: Object): void; + } } -declare module Infragistics { -export class SortingExpressionsManager { - setGridInstance(grid: Object): void; +declare namespace Infragistics { + class SortingExpressionsManager { + setGridInstance(grid: Object): void; - /** - * Insert expr at the first position of the se (sorting expressions) if there are not any other expressions with flag group by - * otherwise if there are such expressions inserts after the last - * - * @param se - * @param expr - * @param feature - */ - addSortingExpression(se: Object, expr: Object, feature: Object): void; - setFormattersForSortingExprs(exprs: Object, grid: Object): void; -} + /** + * Insert expr at the first position of the se (sorting expressions) if there are not any other expressions with flag group by + * otherwise if there are such expressions inserts after the last + * + * @param se + * @param expr + * @param feature + */ + addSortingExpression(se: Object, expr: Object, feature: Object): void; + setFormattersForSortingExprs(exprs: Object, grid: Object): void; + } } interface JQuery { @@ -47647,7 +47356,6 @@ interface JQuery { igEditorFilter(methodName: string, ...methodParams: any[]): any; } interface IgGridSortingColumnSetting { - /** * Identifies the grid column by key. Either key or index must be set in every column setting. * @@ -47715,7 +47423,6 @@ interface ColumnSortingEvent { } interface ColumnSortingEventUIParam { - /** * Used to get reference to GridSorting. */ @@ -47742,7 +47449,6 @@ interface ColumnSortedEvent { } interface ColumnSortedEventUIParam { - /** * Used to get reference to GridSorting. */ @@ -47769,7 +47475,6 @@ interface ModalDialogSortingChangedEvent { } interface ModalDialogSortingChangedEventUIParam { - /** * Used to get the reference to the GridSorting widget. */ @@ -47796,7 +47501,6 @@ interface ModalDialogButtonUnsortClickEvent { } interface ModalDialogButtonUnsortClickEventUIParam { - /** * Used to get the reference to the GridSorting widget. */ @@ -47818,7 +47522,6 @@ interface ModalDialogSortClickEvent { } interface ModalDialogSortClickEventUIParam { - /** * Used to get the reference to the GridSorting widget. */ @@ -47836,7 +47539,6 @@ interface ModalDialogSortClickEventUIParam { } interface IgGridSorting { - /** * Defines local or remote sorting operations. * @@ -48026,7 +47728,7 @@ interface IgGridSorting { /** * Controls containment behavior of multiple sorting dialog. - * + * * owner The multi sorting dialog will be draggable only in the grid area * window The multi sorting dialog will be draggable in the whole window area */ @@ -48188,13 +47890,12 @@ interface IgGridSorting { [optionName: string]: any; } interface IgGridSortingMethods { - /** * Sorts the data in a grid column and updates the UI. * * @param index Column key (string) or index (number) - for multi-row grid only column key can be used. Specifies the column which we want to sort. If the mode is multiple, previous sorting states are not cleared. * @param direction Specifies sorting direction (ascending or descending) - * @param header + * @param header */ sortColumn(index: Object, direction: Object, header: Object): void; @@ -48234,7 +47935,7 @@ interface IgGridSortingMethods { /** * Renders content of multiple sorting dialog - sorted and unsorted columns. * - * @param isToCallEvents + * @param isToCallEvents */ renderMultipleSortingDialogContent(isToCallEvents: Object): void; @@ -48244,7 +47945,7 @@ interface IgGridSortingMethods { removeDialogClearButton(): void; } interface JQuery { - data(propertyName: "igGridSorting"):IgGridSortingMethods; + data(propertyName: "igGridSorting"): IgGridSortingMethods; } interface JQuery { @@ -48650,7 +48351,7 @@ interface JQuery { /** * Controls containment behavior of multiple sorting dialog. - * + * * owner The multi sorting dialog will be draggable only in the grid area * window The multi sorting dialog will be draggable in the whole window area */ @@ -48658,7 +48359,7 @@ interface JQuery { /** * Controls containment behavior of multiple sorting dialog. - * + * * owner The multi sorting dialog will be draggable only in the grid area * window The multi sorting dialog will be draggable in the whole window area * @@ -49004,7 +48705,6 @@ interface JQuery { igGridSorting(methodName: string, ...methodParams: any[]): any; } interface IgGridSummariesColumnSettingSummaryOperand { - /** * Text of the summary method which is shown in summary cell * @@ -49062,7 +48762,6 @@ interface IgGridSummariesColumnSettingSummaryOperand { } interface IgGridSummariesColumnSetting { - /** * Enables disables summaries for the column * @@ -49098,7 +48797,6 @@ interface SummariesCalculatingEvent { } interface SummariesCalculatingEventUIParam { - /** * Used to access the igGridSummaries widget object. */ @@ -49110,7 +48808,6 @@ interface SummariesCalculatedEvent { } interface SummariesCalculatedEventUIParam { - /** * Used to get data for calculated summaries */ @@ -49127,7 +48824,6 @@ interface SummariesMethodSelectionChangedEvent { } interface SummariesMethodSelectionChangedEventUIParam { - /** * Used to get column key of the column where it is changed selection of summary method */ @@ -49154,7 +48850,6 @@ interface SummariesTogglingEvent { } interface SummariesTogglingEventUIParam { - /** * Used to get whether summaries are shown or not. */ @@ -49171,7 +48866,6 @@ interface SummariesToggledEvent { } interface SummariesToggledEventUIParam { - /** * Used to get whether summaries are shown or not. */ @@ -49188,7 +48882,6 @@ interface DropDownOKClickedEvent { } interface DropDownOKClickedEventUIParam { - /** * Used to get column key for which OK button is clicked. */ @@ -49210,7 +48903,6 @@ interface DropDownCancelClickedEvent { } interface DropDownCancelClickedEventUIParam { - /** * Used to get column key for which Cancel button is clicked. */ @@ -49223,7 +48915,6 @@ interface DropDownCancelClickedEventUIParam { } interface IgGridSummaries { - /** * type of summaries calculating. * @@ -49545,7 +49236,7 @@ interface IgGridSummariesMethods { * @param columnMethods Array of column methods objects * @param data Object which represents result represents dataType for the current column - * @param dataType + * @param dataType */ calculateSummaryColumn(ck: string, columnMethods: any[], data: Object, dataType: Object): void; @@ -49557,12 +49248,12 @@ interface IgGridSummariesMethods { /** * Return a JQUERY object which holds all summaries for column with the specified column key * - * @param columnKey + * @param columnKey */ summariesFor(columnKey: Object): void; } interface JQuery { - data(propertyName: "igGridSummaries"):IgGridSummariesMethods; + data(propertyName: "igGridSummaries"): IgGridSummariesMethods; } interface JQuery { @@ -50135,7 +49826,6 @@ interface JQuery { igGridSummaries(methodName: string, ...methodParams: any[]): any; } interface IgGridTooltipsColumnSettings { - /** * Either key or index must be set in every column setting. * @@ -50167,7 +49857,6 @@ interface IgGridTooltipsColumnSettings { } interface IgGridTooltips { - /** * determines the tooltip visibility option * @@ -50286,7 +49975,6 @@ interface IgGridTooltips { [optionName: string]: any; } interface IgGridTooltipsMethods { - /** * Destroys the tooltip widget. */ @@ -50298,7 +49986,7 @@ interface IgGridTooltipsMethods { id(): string; } interface JQuery { - data(propertyName: "igGridTooltips"):IgGridTooltipsMethods; + data(propertyName: "igGridTooltips"): IgGridTooltipsMethods; } interface JQuery { @@ -50543,7 +50231,6 @@ interface JQuery { igGridTooltips(methodName: string, ...methodParams: any[]): any; } interface IgGridUpdatingColumnSetting { - /** * Identifies the grid column by key. * @@ -50627,7 +50314,6 @@ interface IgGridUpdatingColumnSetting { } interface IgGridUpdatingRowEditDialogOptions { - /** * Specifies the caption of the dialog. If not set, $.ig.GridUpdating.locale.rowEditDialogCaptionLabel is used. * @@ -50713,14 +50399,14 @@ interface IgGridUpdatingRowEditDialogOptions { /** * Specifies a template to be rendered against the currently edited record (or up-to-date key-value pairs in the case of not yet created records). It may contain an element decorated with the 'data-render-tmpl' attribute to specify where the control should render the editors template specified in the [editorsTemplate](ui.iggridupdating#options:rowEditDialogOptions.editorsTemplate) option. For custom dialogs, the elements can be decorated with 'data-editor-for-' attributes where columnKey is the key of the column that editor or input will be used to edit. If both dialogTemplate and [dialogTemplateSelector](ui.iggridupdating#options:rowEditDialogOptions.dialogTemplateSelector) are specified, dialogTemplateSelector will be used.The default template is '
    '. - * + * * */ dialogTemplate?: string; /** * Specifies a selector to a template rendered against the currently edited record (or up-to-date key-value pairs in the case of not yet created records). It may contain an element decorated with the 'data-render-tmpl' attribute to specify where the control should render the editors template specified in the [editorsTemplate](ui.iggridupdating#options:rowEditDialogOptions.editorsTemplate) option. For custom dialogs, the elements can be decorated with 'data-editor-for-' attributes where columnKey is the key of the column that editor or input will be used to edit. If both [dialogTemplate](ui.iggridupdating#options:rowEditDialogOptions.dialogTemplate) and dialogTemplateSelector are specified, dialogTemplateSelector will be used.The default template is '
    '. - * + * * */ dialogTemplateSelector?: string; @@ -50750,7 +50436,6 @@ interface EditRowStartingEvent { } interface EditRowStartingEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -50772,7 +50457,6 @@ interface EditRowStartedEvent { } interface EditRowStartedEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -50794,7 +50478,6 @@ interface EditRowEndingEvent { } interface EditRowEndingEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -50831,7 +50514,6 @@ interface EditRowEndedEvent { } interface EditRowEndedEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -50868,7 +50550,6 @@ interface EditCellStartingEvent { } interface EditCellStartingEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -50910,7 +50591,6 @@ interface EditCellStartedEvent { } interface EditCellStartedEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -50952,7 +50632,6 @@ interface EditCellEndingEvent { } interface EditCellEndingEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -51004,7 +50683,6 @@ interface EditCellEndedEvent { } interface EditCellEndedEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -51056,7 +50734,6 @@ interface RowAddingEvent { } interface RowAddingEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -51078,7 +50755,6 @@ interface RowAddedEvent { } interface RowAddedEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -51100,7 +50776,6 @@ interface RowDeletingEvent { } interface RowDeletingEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -51122,7 +50797,6 @@ interface RowDeletedEvent { } interface RowDeletedEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -51144,7 +50818,6 @@ interface DataDirtyEvent { } interface DataDirtyEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -51156,7 +50829,6 @@ interface GeneratePrimaryKeyValueEvent { } interface GeneratePrimaryKeyValueEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -51173,7 +50845,6 @@ interface RowEditDialogBeforeOpenEvent { } interface RowEditDialogBeforeOpenEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -51190,7 +50861,6 @@ interface RowEditDialogAfterOpenEvent { } interface RowEditDialogAfterOpenEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -51207,7 +50877,6 @@ interface RowEditDialogBeforeCloseEvent { } interface RowEditDialogBeforeCloseEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -51224,7 +50893,6 @@ interface RowEditDialogAfterCloseEvent { } interface RowEditDialogAfterCloseEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -51241,7 +50909,6 @@ interface RowEditDialogContentsRenderedEvent { } interface RowEditDialogContentsRenderedEventUIParam { - /** * Used to get a reference to GridUpdating. */ @@ -51254,7 +50921,6 @@ interface RowEditDialogContentsRenderedEventUIParam { } interface IgGridUpdating { - /** * A list of custom column options that specify editing and validation settings for a specific column. * @@ -51631,7 +51297,6 @@ interface IgGridUpdating { [optionName: string]: any; } interface IgGridUpdatingMethods { - /** * Sets a cell value for the specified cell. It also creates a transaction and updates the UI. * If the specified cell is currently in edit mode, the function will set the desired value in the cell's editor instead. @@ -51732,7 +51397,7 @@ interface IgGridUpdatingMethods { hideDeleteButton(): void; } interface JQuery { - data(propertyName: "igGridUpdating"):IgGridUpdatingMethods; + data(propertyName: "igGridUpdating"): IgGridUpdatingMethods; } interface JQuery { @@ -52657,7 +52322,6 @@ interface WorkspaceResizedEventUIParam { } interface IgHtmlEditor { - /** * Shows/hides the "Formatting" toolbar. * @@ -52794,7 +52458,6 @@ interface IgHtmlEditor { [optionName: string]: any; } interface IgHtmlEditorMethods { - /** * Returns the element on which the widget was instantiated */ @@ -52871,7 +52534,7 @@ interface IgHtmlEditorMethods { insertAtCaret(element: Object): void; } interface JQuery { - data(propertyName: "igHtmlEditor"):IgHtmlEditorMethods; + data(propertyName: "igHtmlEditor"): IgHtmlEditorMethods; } interface IgPathFinder { @@ -52930,7 +52593,7 @@ interface IgHtmlEditorPopoverMethods { hide(): void; } interface JQuery { - data(propertyName: "igHtmlEditorPopover"):IgHtmlEditorPopoverMethods; + data(propertyName: "igHtmlEditorPopover"): IgHtmlEditorPopoverMethods; } interface IgLinkPropertiesDialog { @@ -52952,7 +52615,7 @@ interface IgLinkPropertiesDialogMethods { hide(): void; } interface JQuery { - data(propertyName: "igLinkPropertiesDialog"):IgLinkPropertiesDialogMethods; + data(propertyName: "igLinkPropertiesDialog"): IgLinkPropertiesDialogMethods; } interface IgTablePropertiesDialog { @@ -52974,7 +52637,7 @@ interface IgTablePropertiesDialogMethods { hide(): void; } interface JQuery { - data(propertyName: "igTablePropertiesDialog"):IgTablePropertiesDialogMethods; + data(propertyName: "igTablePropertiesDialog"): IgTablePropertiesDialogMethods; } interface IgImagePropertiesDialog { @@ -52996,30 +52659,30 @@ interface IgImagePropertiesDialogMethods { hide(): void; } interface JQuery { - data(propertyName: "igImagePropertiesDialog"):IgImagePropertiesDialogMethods; + data(propertyName: "igImagePropertiesDialog"): IgImagePropertiesDialogMethods; } -declare module Infragistics { -export class SelectionWrapper { - constructor(NODE: any); - getSelectedItem(): void; - getSelectionAsText(): void; - select(element: Object): void; - insertElement(element: Object): void; - execCommand(name: Object, args: Object): void; - replaceNode(newNode: Object): void; - insertTable(table: Object): void; - focus(): void; -} +declare namespace Infragistics { + class SelectionWrapper { + constructor(NODE: any); + getSelectedItem(): void; + getSelectionAsText(): void; + select(element: Object): void; + insertElement(element: Object): void; + execCommand(name: Object, args: Object): void; + replaceNode(newNode: Object): void; + insertTable(table: Object): void; + focus(): void; + } } interface IgniteUIStatic { -SelectionWrapper: typeof Infragistics.SelectionWrapper; + SelectionWrapper: typeof Infragistics.SelectionWrapper; } -declare module Infragistics { -export class ToolbarHelper { - analyse(el: Object): void; -} +declare namespace Infragistics { + class ToolbarHelper { + analyse(el: Object): void; + } } interface JQuery { @@ -53351,7 +53014,6 @@ interface JQuery { igHtmlEditor(methodName: string, ...methodParams: any[]): any; } interface JQuery { - /** */ igPathFinder(optionLiteral: 'option', optionName: "items"): any; @@ -53626,7 +53288,6 @@ interface JQuery { igImagePropertiesDialog(methodName: string, ...methodParams: any[]): any; } interface IgLayoutManagerBorderLayout { - /** * Option specifying the width of the left region, either in px or percentages * @@ -53670,7 +53331,6 @@ interface IgLayoutManagerBorderLayout { } interface IgLayoutManagerGridLayout { - /** * Specifies the duration of the animations in the layout manager"s grid layout * @@ -53733,7 +53393,6 @@ interface IgLayoutManagerGridLayout { } interface IgLayoutManagerItem { - /** * Column index of the item in the grid * @@ -53783,7 +53442,6 @@ interface InternalResizedEvent { } interface InternalResizedEventUIParam { - /** * Used to get a reference to the layout manager performing resizing. */ @@ -53795,7 +53453,6 @@ interface InternalResizingEvent { } interface InternalResizingEventUIParam { - /** * Used to get a reference to the layout manager performing resizing. */ @@ -53807,7 +53464,6 @@ interface ItemRenderedEvent { } interface ItemRenderedEventUIParam { - /** * Used to get reference to the igLayoutManager. */ @@ -53834,7 +53490,6 @@ interface ItemRenderingEvent { } interface ItemRenderingEventUIParam { - /** * Used to get reference to the igLayoutManager. */ @@ -53857,7 +53512,6 @@ interface ItemRenderingEventUIParam { } interface IgLayoutManager { - /** * Options specific to a border layout * @@ -53963,7 +53617,6 @@ interface IgLayoutManager { [optionName: string]: any; } interface IgLayoutManagerMethods { - /** * Triggers recalculation of the layout dimensions. Layouts may not need to be reflowed manually, if their sizes are in percentages (i.e. they are responsive by default) * this can be particularly useful with a grid layout, when the container has percentage sizes, but items are calculated in pixels and positioned absolutely in the container. @@ -53983,7 +53636,7 @@ interface IgLayoutManagerMethods { destroy(): void; } interface JQuery { - data(propertyName: "igLayoutManager"):IgLayoutManagerMethods; + data(propertyName: "igLayoutManager"): IgLayoutManagerMethods; } interface JQuery { @@ -54204,7 +53857,6 @@ interface JQuery { igLayoutManager(methodName: string, ...methodParams: any[]): any; } interface IgLinearGaugeRange { - /** * Gets or sets the name of the range. */ @@ -54266,7 +53918,6 @@ interface IgLinearGaugeRange { } interface IgLinearGauge { - /** * The width of the gauge. It can be set as a number in pixels, string (px) or percentage (%). */ @@ -54296,7 +53947,7 @@ interface IgLinearGauge { * Gets or sets the orientation of the scale. * * Valid values: - * "horizontal" + * "horizontal" * "vertical" */ orientation?: string; @@ -54332,10 +53983,10 @@ interface IgLinearGauge { * Gets or sets the shape to use when rendering the needle from a number of options. * * Valid values: - * "custom" - * "rectangle" - * "triangle" - * "needle" + * "custom" + * "rectangle" + * "triangle" + * "needle" * "trapezoid" */ needleShape?: string; @@ -54622,7 +54273,6 @@ interface IgLinearGauge { [optionName: string]: any; } interface IgLinearGaugeMethods { - /** * Returns a string containing the names of all the ranges delimited with a \n symbol. */ @@ -54652,8 +54302,8 @@ interface IgLinearGaugeMethods { /** * Gets the value for the main scale of the gauge for a given point within the bounds of the gauge. * - * @param x - * @param y + * @param x + * @param y */ getValueForPoint(x: Object, y: Object): number; @@ -54686,7 +54336,7 @@ interface IgLinearGaugeMethods { styleUpdated(): void; } interface JQuery { - data(propertyName: "igLinearGauge"):IgLinearGaugeMethods; + data(propertyName: "igLinearGauge"): IgLinearGaugeMethods; } interface JQuery { @@ -55523,7 +55173,6 @@ interface JQuery { igLinearGauge(methodName: string, ...methodParams: any[]): any; } interface IgMapCrosshairPoint { - /** * The x coordinate. */ @@ -55541,7 +55190,6 @@ interface IgMapCrosshairPoint { } interface IgMapBackgroundContent { - /** * Type of the background content for the map. * @@ -55584,7 +55232,6 @@ interface IgMapBackgroundContent { } interface IgMapSeries { - /** * Type of the series. * @@ -56079,7 +55726,6 @@ interface TriangulationStatusChangedEvent { } interface TriangulationStatusChangedEventUIParam { - /** * Used to get reference to map object. */ @@ -56097,7 +55743,6 @@ interface TriangulationStatusChangedEventUIParam { } interface IgMap { - /** * The width of the map. It can be set as a number in pixels, string (px) or percentage (%). */ @@ -56700,14 +56345,14 @@ interface IgMapMethods { /** * Gets the actual minimum value of the target xAxis or yAxis * - * @param targetName + * @param targetName */ getActualMinimumValue(targetName: Object): void; /** * Gets the actual maximum value of the target xAxis or yAxis * - * @param targetName + * @param targetName */ getActualMaximumValue(targetName: Object): void; @@ -56751,11 +56396,10 @@ interface IgMapMethods { renderSeries(targetName: string, animate: boolean): void; } interface JQuery { - data(propertyName: "igMap"):IgMapMethods; + data(propertyName: "igMap"): IgMapMethods; } interface ShapeDataSourceSettings { - /** * The unique identifier. */ @@ -56811,32 +56455,31 @@ interface ShapeDataSourceSettings { [optionName: string]: any; } -declare module Infragistics { -export class ShapeDataSource { - constructor(settings: ShapeDataSourceSettings); +declare namespace Infragistics { + class ShapeDataSource { + constructor(settings: ShapeDataSourceSettings); - /** - * Loads to the current data source - */ - dataBind(): void; + /** + * Loads to the current data source + */ + dataBind(): void; - /** - * Returns true if data is loaded - */ - isBound(): boolean; + /** + * Returns true if data is loaded + */ + isBound(): boolean; - /** - * Returns the current converter instance - */ - converter(): Object; -} + /** + * Returns the current converter instance + */ + converter(): Object; + } } interface IgniteUIStatic { -ShapeDataSource: typeof Infragistics.ShapeDataSource; + ShapeDataSource: typeof Infragistics.ShapeDataSource; } interface TriangulationDataSourceSettings { - /** * The unique identifier. */ @@ -56868,28 +56511,28 @@ interface TriangulationDataSourceSettings { [optionName: string]: any; } -declare module Infragistics { -export class TriangulationDataSource { - constructor(settings: TriangulationDataSourceSettings); +declare namespace Infragistics { + class TriangulationDataSource { + constructor(settings: TriangulationDataSourceSettings); - /** - * Loads to the current data source - */ - dataBind(): void; + /** + * Loads to the current data source + */ + dataBind(): void; - /** - * Returns true if data is loaded - */ - isBound(): boolean; + /** + * Returns true if data is loaded + */ + isBound(): boolean; - /** - * Returns the current converter instance - */ - converter(): Object; -} + /** + * Returns the current converter instance + */ + converter(): Object; + } } interface IgniteUIStatic { -TriangulationDataSource: typeof Infragistics.TriangulationDataSource; + TriangulationDataSource: typeof Infragistics.TriangulationDataSource; } interface JQuery { @@ -57880,7 +57523,6 @@ interface IgNotifierMessages { } interface IgNotifierHeaderTemplate { - /** * Controls whether the popover renders a functional close button * @@ -57900,7 +57542,6 @@ interface IgNotifierHeaderTemplate { } interface IgNotifier { - /** * Gets/Sets the current state of the igNotifier messages. State controls what CSS classes are applied to the messages and target and has interactions with other options as well. * @@ -57937,7 +57578,7 @@ interface IgNotifier { /** * Controls the positioning mode of messages. Setting a mode will override the default behavior which is auto.Note: Inline element uses a block container as is always placed after the target. - * + * * * * Valid values: @@ -58115,7 +57756,6 @@ interface IgNotifier { [optionName: string]: any; } interface IgNotifierMethods { - /** * Triggers a notification with a certain state and optional message. The [notifyLevel](ui.ignotifier#options:notifyLevel) option determines if the notification will be displayed. * @@ -58187,7 +57827,7 @@ interface IgNotifierMethods { setCoordinates(pos: Object): void; } interface JQuery { - data(propertyName: "igNotifier"):IgNotifierMethods; + data(propertyName: "igNotifier"): IgNotifierMethods; } interface JQuery { @@ -58248,14 +57888,14 @@ interface JQuery { /** * Controls the positioning mode of messages. Setting a mode will override the default behavior which is auto.Note: Inline element uses a block container as is always placed after the target. - * + * * */ igNotifier(optionLiteral: 'option', optionName: "mode"): string; /** * Controls the positioning mode of messages. Setting a mode will override the default behavior which is auto.Note: Inline element uses a block container as is always placed after the target. - * + * * * * @optionValue New value to be set. @@ -58590,7 +58230,6 @@ interface JQuery { igNotifier(methodName: string, ...methodParams: any[]): any; } interface IgPivotDataSelectorDataSourceOptionsXmlaOptionsRequestOptions { - /** * The value is applied to XmlHttpRequest.withCredentials if supported by the user agent. * Setting this property to true will allow IE8/IE9 to make authenticated cross-origin requests to tusted domains through XmlHttpRequest instead of XDomainRequest @@ -58610,7 +58249,6 @@ interface IgPivotDataSelectorDataSourceOptionsXmlaOptionsRequestOptions { } interface IgPivotDataSelectorDataSourceOptionsXmlaOptionsMdxSettings { - /** * Optional="true" a value indicating whether a NON EMPTY clause is present on ROWS axis. Default value is true */ @@ -58648,7 +58286,6 @@ interface IgPivotDataSelectorDataSourceOptionsXmlaOptionsMdxSettings { } interface IgPivotDataSelectorDataSourceOptionsXmlaOptions { - /** * Optional="false" The URL of the XMLA server. */ @@ -58703,7 +58340,6 @@ interface IgPivotDataSelectorDataSourceOptionsXmlaOptions { } interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimensionMeasure { - /** * Optional="false" A unique name for the measure. */ @@ -58732,7 +58368,6 @@ interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeMeasure } interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimension { - /** * A unique name for the measures dimension. * The default value is "Measures". This name is used to create the names of dimensions using the following pattern: @@ -58758,7 +58393,6 @@ interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeMeasure } interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchieLevel { - /** * Optional="false" A name for the level. * The unique name of the level is formed using the following pattern: @@ -58784,7 +58418,6 @@ interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeDimensi } interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchie { - /** * Optional="false" A name for the hierarchy. * The unique name of the hierarchy is formed using the following pattern: @@ -58798,8 +58431,8 @@ interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeDimensi caption?: string; /** - * The path to be used when displaying the hierarchy in the user interface. - * Nested folders are indicated by a backslash (\). + * The path to be used when displaying the hierarchy in the user interface. + * Nested folders are indicated by a backslash (\). * The folder hierarchy will appear under parent dimension node. */ displayFolder?: string; @@ -58816,7 +58449,6 @@ interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeDimensi } interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeDimension { - /** * Optional="false" A unique name for the dimension. */ @@ -58839,7 +58471,6 @@ interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCubeDimensi } interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCube { - /** * Optional="false" A unique name for the cube. */ @@ -58867,7 +58498,6 @@ interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadataCube { } interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadata { - /** * Optional="false" Metadata used for the creation of the cube. */ @@ -58880,7 +58510,6 @@ interface IgPivotDataSelectorDataSourceOptionsFlatDataOptionsMetadata { } interface IgPivotDataSelectorDataSourceOptionsFlatDataOptions { - /** * Specifies any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself. */ @@ -58897,8 +58526,8 @@ interface IgPivotDataSelectorDataSourceOptionsFlatDataOptions { dataSourceType?: string; /** - * See $.ig.DataSource. - * string Specifies the name of the property in which data records are held if the response is wrapped. + * See $.ig.DataSource. + * string Specifies the name of the property in which data records are held if the response is wrapped. * null Option is ignored. */ responseDataKey?: string; @@ -58921,7 +58550,6 @@ interface IgPivotDataSelectorDataSourceOptionsFlatDataOptions { } interface IgPivotDataSelectorDataSourceOptions { - /** * Settings for creating an instance of $.ig.OlapXmlaDataSource. */ @@ -58959,7 +58587,6 @@ interface IgPivotDataSelectorDataSourceOptions { } interface IgPivotDataSelectorDragAndDropSettings { - /** * Which element the draggable helper should be appended to while dragging. */ @@ -58987,7 +58614,6 @@ interface DataSelectorRenderedEvent { } interface DataSelectorRenderedEventUIParam { - /** * Used to get a reference to the data selector. */ @@ -58999,7 +58625,6 @@ interface DataSourceInitializedEvent { } interface DataSourceInitializedEventUIParam { - /** * Used to get a reference to the data selector. */ @@ -59026,7 +58651,6 @@ interface DataSourceUpdatedEvent { } interface DataSourceUpdatedEventUIParam { - /** * Used to get a reference to the data selector. */ @@ -59053,7 +58677,6 @@ interface DeferUpdateChangedEvent { } interface DeferUpdateChangedEventUIParam { - /** * Used to get a reference to the data selector. */ @@ -59070,7 +58693,6 @@ interface DragStartEvent { } interface DragStartEventUIParam { - /** * Used to get a reference to the data. */ @@ -59102,7 +58724,6 @@ interface DragEvent { } interface DragEventUIParam { - /** * Used to get a reference to the data. */ @@ -59134,7 +58755,6 @@ interface DragStopEvent { } interface DragStopEventUIParam { - /** * Used to get a reference to the helper. */ @@ -59161,7 +58781,6 @@ interface MetadataDroppingEvent { } interface MetadataDroppingEventUIParam { - /** * Used to the drop target. */ @@ -59203,7 +58822,6 @@ interface MetadataDroppedEvent { } interface MetadataDroppedEventUIParam { - /** * Used to the drop target. */ @@ -59245,7 +58863,6 @@ interface MetadataRemovingEvent { } interface MetadataRemovingEventUIParam { - /** * Used to the dragged element. */ @@ -59262,7 +58879,6 @@ interface MetadataRemovedEvent { } interface MetadataRemovedEventUIParam { - /** * Used to get a reference to the data. */ @@ -59274,7 +58890,6 @@ interface FilterDropDownOpeningEvent { } interface FilterDropDownOpeningEventUIParam { - /** * Used to the hierarchy. */ @@ -59286,7 +58901,6 @@ interface FilterDropDownOpenedEvent { } interface FilterDropDownOpenedEventUIParam { - /** * Used to the hierarchy. */ @@ -59303,7 +58917,6 @@ interface FilterMembersLoadedEvent { } interface FilterMembersLoadedEventUIParam { - /** * Used to get the parent node or the igTree instance in the initial load. */ @@ -59317,7 +58930,6 @@ interface FilterDropDownOkEvent { } interface FilterDropDownOkEventUIParam { - /** * Used to the hierarchy. */ @@ -59335,7 +58947,6 @@ interface FilterDropDownClosingEvent { } interface FilterDropDownClosingEventUIParam { - /** * Used to the hierarchy. */ @@ -59352,7 +58963,6 @@ interface FilterDropDownClosedEvent { } interface FilterDropDownClosedEventUIParam { - /** * Used to the hierarchy. */ @@ -59576,7 +59186,6 @@ interface IgPivotDataSelector { [optionName: string]: any; } interface IgPivotDataSelectorMethods { - /** * Updates the data source. */ @@ -59591,7 +59200,7 @@ interface IgPivotDataSelectorMethods { destroy(): void; } interface JQuery { - data(propertyName: "igPivotDataSelector"):IgPivotDataSelectorMethods; + data(propertyName: "igPivotDataSelector"): IgPivotDataSelectorMethods; } interface JQuery { @@ -60074,7 +59683,6 @@ interface JQuery { igPivotDataSelector(methodName: string, ...methodParams: any[]): any; } interface IgPivotGridDataSourceOptionsXmlaOptionsRequestOptions { - /** * The value is applied to XmlHttpRequest.withCredentials if supported by the user agent. * Setting this property to true will allow IE8/IE9 to make authenticated cross-origin requests to tusted domains through XmlHttpRequest instead of XDomainRequest @@ -60094,7 +59702,6 @@ interface IgPivotGridDataSourceOptionsXmlaOptionsRequestOptions { } interface IgPivotGridDataSourceOptionsXmlaOptionsMdxSettings { - /** * Optional="true" a value indicating whether a NON EMPTY clause is present on ROWS axis. Default value is true */ @@ -60132,7 +59739,6 @@ interface IgPivotGridDataSourceOptionsXmlaOptionsMdxSettings { } interface IgPivotGridDataSourceOptionsXmlaOptions { - /** * Optional="false" The URL of the XMLA server. */ @@ -60187,7 +59793,6 @@ interface IgPivotGridDataSourceOptionsXmlaOptions { } interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimensionMeasure { - /** * Optional="false" A unique name for the measure. */ @@ -60216,7 +59821,6 @@ interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimensi } interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimension { - /** * A unique name for the measures dimension. * The default value is "Measures". This name is used to create the names of dimensions using the following pattern: @@ -60242,7 +59846,6 @@ interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimensi } interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchieLevel { - /** * Optional="false" A name for the level. * The unique name of the level is formed using the following pattern: @@ -60268,7 +59871,6 @@ interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierar } interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchie { - /** * Optional="false" A name for the hierarchy. * The unique name of the hierarchy is formed using the following pattern: @@ -60282,8 +59884,8 @@ interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierar caption?: string; /** - * The path to be used when displaying the hierarchy in the user interface. - * Nested folders are indicated by a backslash (\). + * The path to be used when displaying the hierarchy in the user interface. + * Nested folders are indicated by a backslash (\). * The folder hierarchy will appear under parent dimension node. */ displayFolder?: string; @@ -60300,7 +59902,6 @@ interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierar } interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeDimension { - /** * Optional="false" A unique name for the dimension. */ @@ -60323,7 +59924,6 @@ interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCubeDimension { } interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCube { - /** * Optional="false" A unique name for the cube. */ @@ -60351,7 +59951,6 @@ interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadataCube { } interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadata { - /** * Optional="false" Metadata used for the creation of the cube. */ @@ -60364,7 +59963,6 @@ interface IgPivotGridDataSourceOptionsFlatDataOptionsMetadata { } interface IgPivotGridDataSourceOptionsFlatDataOptions { - /** * Specifies any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself. */ @@ -60381,8 +59979,8 @@ interface IgPivotGridDataSourceOptionsFlatDataOptions { dataSourceType?: string; /** - * See $.ig.DataSource. - * string Specifies the name of the property in which data records are held if the response is wrapped. + * See $.ig.DataSource. + * string Specifies the name of the property in which data records are held if the response is wrapped. * null Option is ignored. */ responseDataKey?: string; @@ -60405,7 +60003,6 @@ interface IgPivotGridDataSourceOptionsFlatDataOptions { } interface IgPivotGridDataSourceOptions { - /** * Settings for creating an instance of $.ig.OlapXmlaDataSource. */ @@ -60443,7 +60040,6 @@ interface IgPivotGridDataSourceOptions { } interface IgPivotGridLevelSortDirection { - /** * Specifies the unique name of the level, which will be sorted. */ @@ -60470,7 +60066,6 @@ interface IgPivotGridLevelSortDirection { } interface IgPivotGridGridOptionsFeatures { - /** * Option for IgPivotGridGridOptionsFeatures */ @@ -60478,7 +60073,6 @@ interface IgPivotGridGridOptionsFeatures { } interface IgPivotGridGridOptions { - /** * Default column width that will be set for all columns. */ @@ -60521,7 +60115,6 @@ interface IgPivotGridGridOptions { } interface IgPivotGridDragAndDropSettings { - /** * Which element the draggable helper should be appended to while dragging. */ @@ -60549,7 +60142,6 @@ interface PivotGridHeadersRenderedEvent { } interface PivotGridHeadersRenderedEventUIParam { - /** * Used to get a reference to the pivot grid. */ @@ -60571,7 +60163,6 @@ interface PivotGridRenderedEvent { } interface PivotGridRenderedEventUIParam { - /** * Used to get a reference to the pivot grid. */ @@ -60588,7 +60179,6 @@ interface TupleMemberExpandingEvent { } interface TupleMemberExpandingEventUIParam { - /** * Used to get a reference to the pivot grid. */ @@ -60620,7 +60210,6 @@ interface TupleMemberExpandedEvent { } interface TupleMemberExpandedEventUIParam { - /** * Used to get a reference to the pivot grid. */ @@ -60652,7 +60241,6 @@ interface TupleMemberCollapsingEvent { } interface TupleMemberCollapsingEventUIParam { - /** * Used to get a reference to the pivot grid. */ @@ -60684,7 +60272,6 @@ interface TupleMemberCollapsedEvent { } interface TupleMemberCollapsedEventUIParam { - /** * Used to get a reference to the pivot grid. */ @@ -60716,7 +60303,6 @@ interface SortingEvent { } interface SortingEventUIParam { - /** * Used to get a reference to the pivot grid. */ @@ -60733,7 +60319,6 @@ interface SortedEvent { } interface SortedEventUIParam { - /** * Used to get a reference to the pivot grid. */ @@ -60755,7 +60340,6 @@ interface HeadersSortingEvent { } interface HeadersSortingEventUIParam { - /** * Used to get a reference to the pivot grid. */ @@ -60772,7 +60356,6 @@ interface HeadersSortedEvent { } interface HeadersSortedEventUIParam { - /** * Used to get a reference to the pivot grid. */ @@ -61210,7 +60793,6 @@ interface IgPivotGrid { [optionName: string]: any; } interface IgPivotGridMethods { - /** * Returns the igGrid instance used to render the OLAP data. */ @@ -61265,7 +60847,7 @@ interface IgPivotGridMethods { destroy(): void; } interface JQuery { - data(propertyName: "igPivotGrid"):IgPivotGridMethods; + data(propertyName: "igPivotGrid"): IgPivotGridMethods; } interface JQuery { @@ -62207,7 +61789,6 @@ interface JQuery { igPivotGrid(methodName: string, ...methodParams: any[]): any; } interface IgPivotViewDataSourceOptionsXmlaOptionsRequestOptions { - /** * The value is applied to XmlHttpRequest.withCredentials if supported by the user agent. * Setting this property to true will allow IE8/IE9 to make authenticated cross-origin requests to tusted domains through XmlHttpRequest instead of XDomainRequest @@ -62227,7 +61808,6 @@ interface IgPivotViewDataSourceOptionsXmlaOptionsRequestOptions { } interface IgPivotViewDataSourceOptionsXmlaOptionsMdxSettings { - /** * Optional="true" a value indicating whether a NON EMPTY clause is present on ROWS axis. Default value is true */ @@ -62265,7 +61845,6 @@ interface IgPivotViewDataSourceOptionsXmlaOptionsMdxSettings { } interface IgPivotViewDataSourceOptionsXmlaOptions { - /** * Optional="false" The URL of the XMLA server. */ @@ -62320,7 +61899,6 @@ interface IgPivotViewDataSourceOptionsXmlaOptions { } interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimensionMeasure { - /** * Optional="false" A unique name for the measure. */ @@ -62349,7 +61927,6 @@ interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimensi } interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimension { - /** * A unique name for the measures dimension. * The default value is "Measures". This name is used to create the names of dimensions using the following pattern: @@ -62375,7 +61952,6 @@ interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeMeasuresDimensi } interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchieLevel { - /** * Optional="false" A name for the level. * The unique name of the level is formed using the following pattern: @@ -62401,7 +61977,6 @@ interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierar } interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierarchie { - /** * Optional="false" A name for the hierarchy. * The unique name of the hierarchy is formed using the following pattern: @@ -62415,8 +61990,8 @@ interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierar caption?: string; /** - * The path to be used when displaying the hierarchy in the user interface. - * Nested folders are indicated by a backslash (\). + * The path to be used when displaying the hierarchy in the user interface. + * Nested folders are indicated by a backslash (\). * The folder hierarchy will appear under parent dimension node. */ displayFolder?: string; @@ -62433,7 +62008,6 @@ interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeDimensionHierar } interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeDimension { - /** * Optional="false" A unique name for the dimension. */ @@ -62456,7 +62030,6 @@ interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCubeDimension { } interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCube { - /** * Optional="false" A unique name for the cube. */ @@ -62484,7 +62057,6 @@ interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadataCube { } interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadata { - /** * Optional="false" Metadata used for the creation of the cube. */ @@ -62497,7 +62069,6 @@ interface IgPivotViewDataSourceOptionsFlatDataOptionsMetadata { } interface IgPivotViewDataSourceOptionsFlatDataOptions { - /** * Specifies any valid data source accepted by $.ig.DataSource, or an instance of an $.ig.DataSource itself. */ @@ -62514,8 +62085,8 @@ interface IgPivotViewDataSourceOptionsFlatDataOptions { dataSourceType?: string; /** - * See $.ig.DataSource. - * string Specifies the name of the property in which data records are held if the response is wrapped. + * See $.ig.DataSource. + * string Specifies the name of the property in which data records are held if the response is wrapped. * null Option is ignored. */ responseDataKey?: string; @@ -62538,7 +62109,6 @@ interface IgPivotViewDataSourceOptionsFlatDataOptions { } interface IgPivotViewDataSourceOptions { - /** * Settings for creating an instance of $.ig.OlapXmlaDataSource. */ @@ -62576,7 +62146,6 @@ interface IgPivotViewDataSourceOptions { } interface IgPivotViewPivotGridOptionsLevelSortDirection { - /** * Specifies the unique name of the level, which will be sorted. */ @@ -62595,7 +62164,6 @@ interface IgPivotViewPivotGridOptionsLevelSortDirection { } interface IgPivotViewPivotGridOptionsGridOptionsFeatures { - /** * Option for IgPivotViewPivotGridOptionsGridOptionsFeatures */ @@ -62603,7 +62171,6 @@ interface IgPivotViewPivotGridOptionsGridOptionsFeatures { } interface IgPivotViewPivotGridOptionsGridOptions { - /** * Default column width that will be set for all columns. * @@ -62650,7 +62217,6 @@ interface IgPivotViewPivotGridOptionsGridOptions { } interface IgPivotViewPivotGridOptionsDragAndDropSettings { - /** * Which element the draggable helper should be appended to while dragging. */ @@ -62674,7 +62240,6 @@ interface IgPivotViewPivotGridOptionsDragAndDropSettings { } interface IgPivotViewPivotGridOptions { - /** * A boolean value indicating whether a parent in the columns is in front of its children. * If set to true, the query set sorts members in a level in their natural order - child members immediately follow their parent members. @@ -62815,7 +62380,6 @@ interface IgPivotViewPivotGridOptions { } interface IgPivotViewDataSelectorOptionsDragAndDropSettings { - /** * Which element the draggable helper should be appended to while dragging. */ @@ -62839,7 +62403,6 @@ interface IgPivotViewDataSelectorOptionsDragAndDropSettings { } interface IgPivotViewDataSelectorOptions { - /** * Settings for the drag and drop functionality of the igPivotDataSelector. */ @@ -62866,7 +62429,6 @@ interface IgPivotViewDataSelectorOptions { } interface IgPivotViewPivotGridPanel { - /** * Determines if the panel containing the igPivotGrid will be resizable. */ @@ -62899,7 +62461,6 @@ interface IgPivotViewPivotGridPanel { } interface IgPivotViewDataSelectorPanel { - /** * Determines the position of the data selector panel inside the igPivotView widget. */ @@ -62977,7 +62538,6 @@ interface IgPivotView { [optionName: string]: any; } interface IgPivotViewMethods { - /** * Returns the igPivotGrid instance of the pivot view. */ @@ -63002,7 +62562,7 @@ interface IgPivotViewMethods { destroy(): void; } interface JQuery { - data(propertyName: "igPivotView"):IgPivotViewMethods; + data(propertyName: "igPivotView"): IgPivotViewMethods; } interface JQuery { @@ -63107,7 +62667,6 @@ interface JQuery { igPivotView(methodName: string, ...methodParams: any[]): any; } interface IgPopover { - /** * Controls whether the popover will close on blur or not */ @@ -63256,7 +62815,6 @@ interface IgPopover { [optionName: string]: any; } interface IgPopoverMethods { - /** * Destroys the popover widget. */ @@ -63315,7 +62873,7 @@ interface IgPopoverMethods { setCoordinates(pos: Object): void; } interface JQuery { - data(propertyName: "igPopover"):IgPopoverMethods; + data(propertyName: "igPopover"): IgPopoverMethods; } interface JQuery { @@ -63606,7 +63164,6 @@ interface JQuery { igPopover(methodName: string, ...methodParams: any[]): any; } interface IgRadialGaugeRange { - /** * Gets or sets the name of the range. */ @@ -63669,7 +63226,6 @@ interface IgRadialGaugeRange { } interface IgRadialGauge { - /** * The width of the gauge. It can be set as a number in pixels, string (px) or percentage (%). */ @@ -63741,7 +63297,7 @@ interface IgRadialGauge { * Gets or sets the direction in which the scale sweeps around the center from the start angle to end angle. * * Valid values: - * "counterclockwise" + * "counterclockwise" * "clockwise" */ scaleSweepDirection?: string; @@ -63767,7 +63323,7 @@ interface IgRadialGauge { needleOutline?: string; /** - * Gets or sets the extent (from -1 to 1) at which to start rendering the needle, measured from the center of the gauge. + * Gets or sets the extent (from -1 to 1) at which to start rendering the needle, measured from the center of the gauge. * Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. */ needleStartExtent?: number; @@ -63782,14 +63338,14 @@ interface IgRadialGauge { * Gets or sets the shape to use when rendering the needle from a number of options. * * Valid values: - * "none" - * "rectangle" - * "triangle" - * "needle" - * "trapezoid" - * "rectangleWithBulb" - * "triangleWithBulb" - * "needleWithBulb" + * "none" + * "rectangle" + * "triangle" + * "needle" + * "trapezoid" + * "rectangleWithBulb" + * "triangleWithBulb" + * "needleWithBulb" * "trapezoidWithBulb" */ needleShape?: string; @@ -63845,12 +63401,12 @@ interface IgRadialGauge { * Gets or sets the shape to use for the needle cap. * * Valid values: - * "none" - * "circle" - * "circleWithHole" - * "circleOverlay" - * "circleOverlayWithHole" - * "circleUnderlay" + * "none" + * "circle" + * "circleWithHole" + * "circleOverlay" + * "circleOverlayWithHole" + * "circleUnderlay" * "circleUnderlayWithHole" */ needlePivotShape?: string; @@ -63991,8 +63547,8 @@ interface IgRadialGauge { * Gets or sets the over or shape to use for the excess fill area for the scale. * * Valid values: - * "auto" - * "circular" + * "auto" + * "circular" * "fitted" */ scaleOversweepShape?: string; @@ -64011,14 +63567,14 @@ interface IgRadialGauge { * Gets or sets the type of shape to use for the backing of the gauge. * * Valid values: - * "circular" + * "circular" * "fitted" */ backingShape?: string; /** - * Gets or sets the multiplying factor to apply to the normal radius of the gauge. - * The radius of the gauge is defined by the minimum of the width and height of the control divided by 2.0. + * Gets or sets the multiplying factor to apply to the normal radius of the gauge. + * The radius of the gauge is defined by the minimum of the width and height of the control divided by 2.0. * This introduces a multiplicative factor to that value. */ radiusMultiplier?: number; @@ -64027,9 +63583,9 @@ interface IgRadialGauge { * Gets or sets the strategy to use for omitting labels if the first and last label have the same value. * * Valid values: - * "omitLast" - * "omitFirst" - * "omitNeither" + * "omitLast" + * "omitFirst" + * "omitNeither" * "omitBoth" */ duplicateLabelOmissionStrategy?: string; @@ -64072,7 +63628,6 @@ interface IgRadialGauge { [optionName: string]: any; } interface IgRadialGaugeMethods { - /** * Returns a string containing the names of all the ranges delimited with a \n symbol. */ @@ -64081,21 +63636,21 @@ interface IgRadialGaugeMethods { /** * Adds a new range to the radial gauge. * - * @param value + * @param value */ addRange(value: Object): void; /** * Removes a specified range. * - * @param value + * @param value */ removeRange(value: Object): void; /** * Updates the range. * - * @param value + * @param value */ updateRange(value: Object): void; @@ -64107,38 +63662,38 @@ interface IgRadialGaugeMethods { /** * Scales a value on the gauge's main scale to an angle around the center point of the gauge, in radians. * - * @param value + * @param value */ scaleValue(value: Object): void; /** * Unscales a value from an angle in radians to the represented value along the main scale of the gauge. * - * @param value + * @param value */ unscaleValue(value: Object): void; /** * Gets the value for the main scale of the gauge for a given point within the bounds of the gauge. * - * @param x - * @param y + * @param x + * @param y */ getValueForPoint(x: Object, y: Object): number; /** * Gets the point on the gauge for a given scale value and extent. * - * @param value - * @param extent + * @param value + * @param extent */ getPointForValue(value: Object, extent: Object): void; /** * Returns true if the main gauge needle bounding box contains the point provided, otherwise false. * - * @param x - * @param y + * @param x + * @param y */ needleContainsPoint(x: Object, y: Object): void; @@ -64163,7 +63718,7 @@ interface IgRadialGaugeMethods { styleUpdated(): void; } interface JQuery { - data(propertyName: "igRadialGauge"):IgRadialGaugeMethods; + data(propertyName: "igRadialGauge"): IgRadialGaugeMethods; } interface JQuery { @@ -64403,13 +63958,13 @@ interface JQuery { igRadialGauge(optionLiteral: 'option', optionName: "needleOutline", optionValue: string): void; /** - * Gets the extent (from -1 to 1) at which to start rendering the needle, measured from the center of the gauge. + * Gets the extent (from -1 to 1) at which to start rendering the needle, measured from the center of the gauge. * Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. */ igRadialGauge(optionLiteral: 'option', optionName: "needleStartExtent"): number; /** - * Sets the extent (from -1 to 1) at which to start rendering the needle, measured from the center of the gauge. + * Sets the extent (from -1 to 1) at which to start rendering the needle, measured from the center of the gauge. * Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. * * @optionValue New value to be set. @@ -64927,15 +64482,15 @@ interface JQuery { igRadialGauge(optionLiteral: 'option', optionName: "backingShape", optionValue: string): void; /** - * Gets the multiplying factor to apply to the normal radius of the gauge. - * The radius of the gauge is defined by the minimum of the width and height of the control divided by 2.0. + * Gets the multiplying factor to apply to the normal radius of the gauge. + * The radius of the gauge is defined by the minimum of the width and height of the control divided by 2.0. * This introduces a multiplicative factor to that value. */ igRadialGauge(optionLiteral: 'option', optionName: "radiusMultiplier"): number; /** - * Sets the multiplying factor to apply to the normal radius of the gauge. - * The radius of the gauge is defined by the minimum of the width and height of the control divided by 2.0. + * Sets the multiplying factor to apply to the normal radius of the gauge. + * The radius of the gauge is defined by the minimum of the width and height of the control divided by 2.0. * This introduces a multiplicative factor to that value. * * @optionValue New value to be set. @@ -65048,17 +64603,16 @@ interface JQuery { igRadialGauge(methodName: string, ...methodParams: any[]): any; } interface IgRadialMenuItem { - /** * Gets or sets a value indicating what type of item is being provided. * * * Valid values: - * "button" - * "coloritem" - * "colorwell" - * "list" - * "numericitem" + * "button" + * "coloritem" + * "colorwell" + * "list" + * "numericitem" * "numericgauge" */ type?: string; @@ -65369,7 +64923,6 @@ interface ClosedEvent { } interface ClosedEventUIParam { - /** * Used to obtain reference to menu widget. */ @@ -65381,7 +64934,6 @@ interface OpenedEvent { } interface OpenedEventUIParam { - /** * Used to obtain reference to menu widget. */ @@ -65389,7 +64941,6 @@ interface OpenedEventUIParam { } interface IgRadialMenu { - /** * Gets or sets the items in the menu. */ @@ -65541,7 +65092,6 @@ interface IgRadialMenu { [optionName: string]: any; } interface IgRadialMenuMethods { - /** * Gets or sets the value of a property for the item created with the specified key * @@ -65572,7 +65122,7 @@ interface IgRadialMenuMethods { styleUpdated(): void; } interface JQuery { - data(propertyName: "igRadialMenu"):IgRadialMenuMethods; + data(propertyName: "igRadialMenu"): IgRadialMenuMethods; } interface JQuery { @@ -65944,7 +65494,6 @@ interface HoverChangeEvent { } interface HoverChangeEventUIParam { - /** * Used to get new value. */ @@ -65961,7 +65510,6 @@ interface ValueChangeEvent { } interface ValueChangeEventUIParam { - /** * Used to get new value. */ @@ -65974,7 +65522,6 @@ interface ValueChangeEventUIParam { } interface IgRating { - /** * Gets a vertical or horizontal orientation for the votes. * Change of that option is not supported after igRating was created. @@ -66101,7 +65648,7 @@ interface IgRating { /** * Event which is raised before hover value is changed. * If application returns false, then action is canceled and hover value stays unchanged. - * + * * Function takes arguments evt and ui. * Use ui.value to get new value. * Use ui.oldValue to get old value. @@ -66111,7 +65658,7 @@ interface IgRating { /** * Event which is raised before (selected) value is changed. * If application returns false, then action is canceled and value stays unchanged. - * + * * Function takes arguments evt and ui. * Use ui.value to get new value. * Use ui.oldValue to get old value. @@ -66124,7 +65671,6 @@ interface IgRating { [optionName: string]: any; } interface IgRatingMethods { - /** * Gets reference to [igValidator](ui.igvalidator) used by igRating. * @@ -66169,7 +65715,7 @@ interface IgRatingMethods { destroy(): Object; } interface JQuery { - data(propertyName: "igRating"):IgRatingMethods; + data(propertyName: "igRating"): IgRatingMethods; } interface JQuery { @@ -66450,7 +65996,7 @@ interface JQuery { /** * Event which is raised before hover value is changed. * If application returns false, then action is canceled and hover value stays unchanged. - * + * * Function takes arguments evt and ui. * Use ui.value to get new value. * Use ui.oldValue to get old value. @@ -66460,7 +66006,7 @@ interface JQuery { /** * Event which is raised before hover value is changed. * If application returns false, then action is canceled and hover value stays unchanged. - * + * * Function takes arguments evt and ui. * Use ui.value to get new value. * Use ui.oldValue to get old value. @@ -66472,7 +66018,7 @@ interface JQuery { /** * Event which is raised before (selected) value is changed. * If application returns false, then action is canceled and value stays unchanged. - * + * * Function takes arguments evt and ui. * Use ui.value to get new value. * Use ui.oldValue to get old value. @@ -66482,7 +66028,7 @@ interface JQuery { /** * Event which is raised before (selected) value is changed. * If application returns false, then action is canceled and value stays unchanged. - * + * * Function takes arguments evt and ui. * Use ui.value to get new value. * Use ui.oldValue to get old value. @@ -66501,7 +66047,6 @@ interface ScrollingEvent { } interface ScrollingEventUIParam { - /** * Used to obtain reference to igScroll. */ @@ -66538,7 +66083,6 @@ interface ScrolledEvent { } interface ScrolledEventUIParam { - /** * Used to obtain reference to igScroll. */ @@ -66565,7 +66109,6 @@ interface ThumbDragStartEvent { } interface ThumbDragStartEventUIParam { - /** * Used to obtain reference to igScroll. */ @@ -66582,7 +66125,6 @@ interface ThumbDragMoveEvent { } interface ThumbDragMoveEventUIParam { - /** * Used to obtain reference to igScroll. */ @@ -66609,7 +66151,6 @@ interface ThumbDragEndEvent { } interface ThumbDragEndEventUIParam { - /** * Used to obtain reference to igScroll. */ @@ -66622,7 +66163,6 @@ interface ThumbDragEndEventUIParam { } interface IgScroll { - /** * Sets or gets if the scrollbars should be always visible (on all environments). Otherwise it will be the default behavior. Note: this option is only for the custom scrollbars set through the scrollbarType option. * @@ -66858,7 +66398,7 @@ interface IgScrollMethods { destroy(): void; } interface JQuery { - data(propertyName: "igScroll"):IgScrollMethods; + data(propertyName: "igScroll"): IgScrollMethods; } interface JQuery { @@ -67391,11 +66931,10 @@ interface IgLoadingMethods { destroy(): void; } interface JQuery { - data(propertyName: "igLoading"):IgLoadingMethods; + data(propertyName: "igLoading"): IgLoadingMethods; } interface IgSliderBookmarks { - /** * Get or set the bookmark value. Should be between slider min and max values. */ @@ -67465,7 +67004,6 @@ interface BookmarkClickEventUIParam { } interface IgSlider { - /** * Get or set whether the slide handle will animate when it is moved. */ @@ -67553,7 +67091,7 @@ interface IgSliderMethods { value(newValue: Object): void; } interface JQuery { - data(propertyName: "igSlider"):IgSliderMethods; + data(propertyName: "igSlider"): IgSliderMethods; } interface IgProgressBar { @@ -67585,7 +67123,7 @@ interface IgProgressBarMethods { value(newValue: Object): void; } interface JQuery { - data(propertyName: "igProgressBar"):IgProgressBarMethods; + data(propertyName: "igProgressBar"): IgProgressBarMethods; } interface IgButtonLink { @@ -67631,7 +67169,7 @@ interface IgButtonMethods { destroy(): void; } interface JQuery { - data(propertyName: "igButton"):IgButtonMethods; + data(propertyName: "igButton"): IgButtonMethods; } interface IgTooltip { @@ -67647,7 +67185,7 @@ interface IgTooltipMethods { destroy(): void; } interface JQuery { - data(propertyName: "igTooltip"):IgTooltipMethods; + data(propertyName: "igTooltip"): IgTooltipMethods; } interface CaptureEvent { @@ -67675,11 +67213,10 @@ interface MouseWrapperMethods { destroy(): void; } interface JQuery { - data(propertyName: "mouseWrapper"):MouseWrapperMethods; + data(propertyName: "mouseWrapper"): MouseWrapperMethods; } interface IgResponsiveContainer { - /** * The time between two resize checks in milliseconds. */ @@ -67691,7 +67228,6 @@ interface IgResponsiveContainer { [optionName: string]: any; } interface IgResponsiveContainerMethods { - /** * Destroys the ResponsiveContainer widget */ @@ -67725,7 +67261,7 @@ interface IgResponsiveContainerMethods { addCallback(callback: Function, owner: Object, reactionStep: number, reactionDirection: Object): void; } interface JQuery { - data(propertyName: "igResponsiveContainer"):IgResponsiveContainerMethods; + data(propertyName: "igResponsiveContainer"): IgResponsiveContainerMethods; } interface JQuery { @@ -68253,7 +67789,6 @@ interface JQuery { igResponsiveContainer(methodName: string, ...methodParams: any[]): any; } interface IgSparkline { - /** * The width of the sparkline. It can be set as a number in pixels, string (px) or percentage (%). */ @@ -68328,7 +67863,7 @@ interface IgSparkline { * Gets or sets the display state of the horizontal axis. * * Valid values: - * "visible" + * "visible" * "collapsed" */ horizontalAxisVisibility?: string; @@ -68337,7 +67872,7 @@ interface IgSparkline { * Gets or sets the display state of the vertical axis. * * Valid values: - * "visible" + * "visible" * "collapsed" */ verticalAxisVisibility?: string; @@ -68346,7 +67881,7 @@ interface IgSparkline { * Gets or sets the marker visibility of the sparkline. * * Valid values: - * "visible" + * "visible" * "collapsed" */ markerVisibility?: string; @@ -68355,7 +67890,7 @@ interface IgSparkline { * Gets or sets the negative marker visibility of the sparkline. * * Valid values: - * "visible" + * "visible" * "collapsed" */ negativeMarkerVisibility?: string; @@ -68364,7 +67899,7 @@ interface IgSparkline { * Gets or sets the first marker visibility of the sparkline. * * Valid values: - * "visible" + * "visible" * "collapsed" */ firstMarkerVisibility?: string; @@ -68373,7 +67908,7 @@ interface IgSparkline { * Gets or sets the last marker visibility of the sparkline. * * Valid values: - * "visible" + * "visible" * "collapsed" */ lastMarkerVisibility?: string; @@ -68382,7 +67917,7 @@ interface IgSparkline { * Gets or sets the low marker visibility of the sparkline. * * Valid values: - * "visible" + * "visible" * "collapsed" */ lowMarkerVisibility?: string; @@ -68391,7 +67926,7 @@ interface IgSparkline { * Gets or sets the high marker visibility of the sparkline. * * Valid values: - * "visible" + * "visible" * "collapsed" */ highMarkerVisibility?: string; @@ -68400,7 +67935,7 @@ interface IgSparkline { * Gets or sets the normal range visibility of the sparkline. * * Valid values: - * "visible" + * "visible" * "collapsed" */ normalRangeVisibility?: string; @@ -68459,19 +67994,19 @@ interface IgSparkline { * Gets or sets the type of trendline used by the sparkline. * * Valid values: - * "none" - * "linearFit" - * "quadraticFit" - * "cubicFit" - * "quarticFit" - * "quinticFit" - * "logarithmicFit" - * "exponentialFit" - * "powerLawFit" - * "simpleAverage" - * "exponentialAverage" - * "modifiedAverage" - * "cumulativeAverage" + * "none" + * "linearFit" + * "quadraticFit" + * "cubicFit" + * "quarticFit" + * "quinticFit" + * "logarithmicFit" + * "exponentialFit" + * "powerLawFit" + * "simpleAverage" + * "exponentialAverage" + * "modifiedAverage" + * "cumulativeAverage" * "weightedAverage" */ trendLineType?: string; @@ -68511,7 +68046,7 @@ interface IgSparkline { * Gets or sets the way null values are interpreted. * * Valid values: - * "linearInterpolate" + * "linearInterpolate" * "dontPlot" */ unknownValuePlotting?: string; @@ -68718,7 +68253,7 @@ interface IgSparklineMethods { dataBind(): void; } interface JQuery { - data(propertyName: "igSparkline"):IgSparklineMethods; + data(propertyName: "igSparkline"): IgSparklineMethods; } interface JQuery { @@ -69449,7 +68984,6 @@ interface JQuery { igSparkline(methodName: string, ...methodParams: any[]): any; } interface IgSplitButtonItem { - /** * Item name */ @@ -69472,7 +69006,6 @@ interface IgSplitButtonItem { } interface IgSplitButton { - /** * Button items. * @@ -69493,7 +69026,7 @@ interface IgSplitButton { /** * Event fired when the button is clicked. - * + * * Function takes arguments evt and ui. * Use ui.item to get a reference the igSplitButton element. */ @@ -69501,7 +69034,7 @@ interface IgSplitButton { /** * Event fired after the button is expanded. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -69509,7 +69042,7 @@ interface IgSplitButton { /** * Event fired before a button item is expanded. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -69517,7 +69050,7 @@ interface IgSplitButton { /** * Event fired after the button is collapsed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -69525,7 +69058,7 @@ interface IgSplitButton { /** * Event fired before a button item is collapsed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -69537,7 +69070,6 @@ interface IgSplitButton { [optionName: string]: any; } interface IgSplitButtonMethods { - /** * Switch to given igToolbar button. * @@ -69573,7 +69105,7 @@ interface IgSplitButtonMethods { destroy(): void; } interface JQuery { - data(propertyName: "igSplitButton"):IgSplitButtonMethods; + data(propertyName: "igSplitButton"): IgSplitButtonMethods; } interface JQuery { @@ -69628,7 +69160,7 @@ interface JQuery { /** * Event fired when the button is clicked. - * + * * Function takes arguments evt and ui. * Use ui.item to get a reference the igSplitButton element. */ @@ -69636,7 +69168,7 @@ interface JQuery { /** * Event fired when the button is clicked. - * + * * Function takes arguments evt and ui. * Use ui.item to get a reference the igSplitButton element. * @@ -69646,7 +69178,7 @@ interface JQuery { /** * Event fired after the button is expanded. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -69654,7 +69186,7 @@ interface JQuery { /** * Event fired after the button is expanded. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. * @@ -69664,7 +69196,7 @@ interface JQuery { /** * Event fired before a button item is expanded. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -69672,7 +69204,7 @@ interface JQuery { /** * Event fired before a button item is expanded. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. * @@ -69682,7 +69214,7 @@ interface JQuery { /** * Event fired after the button is collapsed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -69690,7 +69222,7 @@ interface JQuery { /** * Event fired after the button is collapsed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. * @@ -69700,7 +69232,7 @@ interface JQuery { /** * Event fired before a button item is collapsed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. */ @@ -69708,7 +69240,7 @@ interface JQuery { /** * Event fired before a button item is collapsed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference the igSplitButton. * @@ -69722,7 +69254,6 @@ interface JQuery { igSplitButton(methodName: string, ...methodParams: any[]): any; } interface IgSplitterPanel { - /** * Gets the size of the panel * @@ -69770,7 +69301,6 @@ interface ResizeStartedEvent { } interface ResizeStartedEventUIParam { - /** * Used to get a reference to the splitter instance. */ @@ -69782,7 +69312,6 @@ interface ResizingEvent { } interface ResizingEventUIParam { - /** * Used to get a reference to the splitter instance. */ @@ -69794,7 +69323,6 @@ interface ResizeEndedEvent { } interface ResizeEndedEventUIParam { - /** * Used to get a reference to the splitter instance. */ @@ -69806,7 +69334,6 @@ interface LayoutRefreshingEvent { } interface LayoutRefreshingEventUIParam { - /** * Used to get a reference to the splitter instance. */ @@ -69818,7 +69345,6 @@ interface LayoutRefreshedEvent { } interface LayoutRefreshedEventUIParam { - /** * Used to get a reference to the splitter instance. */ @@ -69826,7 +69352,6 @@ interface LayoutRefreshedEventUIParam { } interface IgSplitter { - /** * Gets/Sets the width of the container. * @@ -69875,7 +69400,7 @@ interface IgSplitter { /** * Fired after collapsing is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. * Use ui.index to get an index of collapsed panel. @@ -69884,7 +69409,7 @@ interface IgSplitter { /** * Fired after expanding is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. * Use ui.index to get an index of expanded panel. @@ -69893,7 +69418,7 @@ interface IgSplitter { /** * Fired before split bar move is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. */ @@ -69901,7 +69426,7 @@ interface IgSplitter { /** * Fired while split bar move is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. */ @@ -69909,7 +69434,7 @@ interface IgSplitter { /** * Fired after split bar move is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. */ @@ -69917,7 +69442,7 @@ interface IgSplitter { /** * Fired before the panels are refreshed because of browser"s resizing. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. */ @@ -69925,7 +69450,7 @@ interface IgSplitter { /** * Fired after the panels are refreshed because of browser"s resizing. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. */ @@ -69937,7 +69462,6 @@ interface IgSplitter { [optionName: string]: any; } interface IgSplitterMethods { - /** * Returns the element that represents this widget. */ @@ -69992,7 +69516,7 @@ interface IgSplitterMethods { destroy(): void; } interface JQuery { - data(propertyName: "igSplitter"):IgSplitterMethods; + data(propertyName: "igSplitter"): IgSplitterMethods; } interface JQuery { @@ -70092,7 +69616,7 @@ interface JQuery { /** * Fired after collapsing is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. * Use ui.index to get an index of collapsed panel. @@ -70101,7 +69625,7 @@ interface JQuery { /** * Fired after collapsing is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. * Use ui.index to get an index of collapsed panel. @@ -70112,7 +69636,7 @@ interface JQuery { /** * Fired after expanding is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. * Use ui.index to get an index of expanded panel. @@ -70121,7 +69645,7 @@ interface JQuery { /** * Fired after expanding is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. * Use ui.index to get an index of expanded panel. @@ -70132,7 +69656,7 @@ interface JQuery { /** * Fired before split bar move is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. */ @@ -70140,7 +69664,7 @@ interface JQuery { /** * Fired before split bar move is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. * @@ -70150,7 +69674,7 @@ interface JQuery { /** * Fired while split bar move is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. */ @@ -70158,7 +69682,7 @@ interface JQuery { /** * Fired while split bar move is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. * @@ -70168,7 +69692,7 @@ interface JQuery { /** * Fired after split bar move is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. */ @@ -70176,7 +69700,7 @@ interface JQuery { /** * Fired after split bar move is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. * @@ -70186,7 +69710,7 @@ interface JQuery { /** * Fired before the panels are refreshed because of browser"s resizing. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. */ @@ -70194,7 +69718,7 @@ interface JQuery { /** * Fired before the panels are refreshed because of browser"s resizing. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. * @@ -70204,7 +69728,7 @@ interface JQuery { /** * Fired after the panels are refreshed because of browser"s resizing. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. */ @@ -70212,7 +69736,7 @@ interface JQuery { /** * Fired after the panels are refreshed because of browser"s resizing. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. * @@ -70226,10 +69750,9 @@ interface JQuery { igSplitter(methodName: string, ...methodParams: any[]): any; } interface IgTileManagerSplitterOptionsEvents { - /** * Event fired after collapsing is performed. Not cancellable. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. * Use ui.index to get an index of collased panel. @@ -70238,7 +69761,7 @@ interface IgTileManagerSplitterOptionsEvents { /** * Event fired after expanding is performed. Not cancellable. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the splitter instance. * Use ui.index to get an index of expanded panel. @@ -70252,7 +69775,6 @@ interface IgTileManagerSplitterOptionsEvents { } interface IgTileManagerSplitterOptions { - /** * Gets/Sets whether the splitter should be enabled. * @@ -70288,7 +69810,6 @@ interface TileRenderingEvent { } interface TileRenderingEventUIParam { - /** * Used to get a reference to the tile manager performing rendering. */ @@ -70305,7 +69826,6 @@ interface TileRenderedEvent { } interface TileRenderedEventUIParam { - /** * Used to get a reference to the tile manager performing rendering. */ @@ -70322,7 +69842,6 @@ interface TileMaximizingEvent { } interface TileMaximizingEventUIParam { - /** * Used to get a reference to the tile manager performing the maximizing the tile belongs to. */ @@ -70344,7 +69863,6 @@ interface TileMaximizedEvent { } interface TileMaximizedEventUIParam { - /** * Used to get a reference to the tile manager the maximized tile belongs to. */ @@ -70361,7 +69879,6 @@ interface TileMinimizingEvent { } interface TileMinimizingEventUIParam { - /** * Used to get a reference to the tile manager performing the minimizing the tile belongs to. */ @@ -70383,7 +69900,6 @@ interface TileMinimizedEvent { } interface TileMinimizedEventUIParam { - /** * Used to get a reference to the tile manager the minimized tile belongs to. */ @@ -70396,9 +69912,8 @@ interface TileMinimizedEventUIParam { } interface IgTileManager { - /** - * + * * * Valid values: * "string" The container width can be set in pixels (px) and percentage (%). @@ -70461,14 +69976,14 @@ interface IgTileManager { /** * Gets/Sets the horizontal spacing between tiles. - * + * * number The horizontal spacing between tiles can be set as a number. */ marginLeft?: number; /** * Gets/Sets the vertical spacing between tiles. - * + * * number The vertical spacing between tiles can be set as a number. */ marginTop?: number; @@ -70625,7 +70140,7 @@ interface IgTileManager { /** * Fired before databinding is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing databinding. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) the tile manager is to be databound to. @@ -70634,7 +70149,7 @@ interface IgTileManager { /** * Fired after databinding is complete - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing databinding. * Use ui.dataView to get a reference to the data the tile manager is databound to. @@ -70645,7 +70160,7 @@ interface IgTileManager { /** * Fired before rendering of the tile manager begins. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. * Use ui.tiles to get a reference to the tiles the tile manager is going to render. If using data source this referes to the data provided. @@ -70655,7 +70170,7 @@ interface IgTileManager { /** * Fired after rendering of the tile manager completes. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. */ @@ -70663,7 +70178,7 @@ interface IgTileManager { /** * Event fired before a tile is rendered in the container - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. * Use ui.tile to get a reference to the tile being rendered @@ -70672,7 +70187,7 @@ interface IgTileManager { /** * Event Fired after a tile has been rendered in the container - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. * Use ui.tile to get a reference to the rendered tile @@ -70681,7 +70196,7 @@ interface IgTileManager { /** * Fired before a tile in the tile manager is maximized. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing the maximizing the tile belongs to. * Use ui.tile to get the jQuery element of the tile being maximized @@ -70691,7 +70206,7 @@ interface IgTileManager { /** * Fired after a tile in the tile manager is maximized. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager the maximized tile belongs to. * Use ui.tile to get the jQuery element of the maximized tile @@ -70700,7 +70215,7 @@ interface IgTileManager { /** * Fired before a tile in the tile manager is minimized. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing the minimizing the tile belongs to. * Use ui.tile to get the jQuery element of the tile being minimized @@ -70710,7 +70225,7 @@ interface IgTileManager { /** * Fired after a tile in the tile manager is minimized. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager the minimized tile belongs to. * Use ui.tile to get the jQuery element of the minimized tile @@ -70723,7 +70238,6 @@ interface IgTileManager { [optionName: string]: any; } interface IgTileManagerMethods { - /** * Maximizes a given tile. * @@ -70790,7 +70304,7 @@ interface IgTileManagerMethods { destroy(): Object; } interface JQuery { - data(propertyName: "igTileManager"):IgTileManagerMethods; + data(propertyName: "igTileManager"): IgTileManagerMethods; } interface JQuery { @@ -70889,14 +70403,14 @@ interface JQuery { /** * Gets/Sets the horizontal spacing between tiles. - * + * * number The horizontal spacing between tiles can be set as a number. */ igTileManager(optionLiteral: 'option', optionName: "marginLeft"): number; /** * /Sets the horizontal spacing between tiles. - * + * * number The horizontal spacing between tiles can be set as a number. * * @optionValue New value to be set. @@ -70905,14 +70419,14 @@ interface JQuery { /** * Gets/Sets the vertical spacing between tiles. - * + * * number The vertical spacing between tiles can be set as a number. */ igTileManager(optionLiteral: 'option', optionName: "marginTop"): number; /** * /Sets the vertical spacing between tiles. - * + * * number The vertical spacing between tiles can be set as a number. * * @optionValue New value to be set. @@ -71187,7 +70701,7 @@ interface JQuery { /** * Fired before databinding is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing databinding. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) the tile manager is to be databound to. @@ -71196,7 +70710,7 @@ interface JQuery { /** * Fired before databinding is performed - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing databinding. * Use ui.dataSource to get a reference to the [$.ig.DataSource](ig.datasource) the tile manager is to be databound to. @@ -71207,7 +70721,7 @@ interface JQuery { /** * Fired after databinding is complete - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing databinding. * Use ui.dataView to get a reference to the data the tile manager is databound to. @@ -71218,7 +70732,7 @@ interface JQuery { /** * Fired after databinding is complete - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing databinding. * Use ui.dataView to get a reference to the data the tile manager is databound to. @@ -71231,7 +70745,7 @@ interface JQuery { /** * Fired before rendering of the tile manager begins. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. * Use ui.tiles to get a reference to the tiles the tile manager is going to render. If using data source this referes to the data provided. @@ -71241,7 +70755,7 @@ interface JQuery { /** * Fired before rendering of the tile manager begins. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. * Use ui.tiles to get a reference to the tiles the tile manager is going to render. If using data source this referes to the data provided. @@ -71253,7 +70767,7 @@ interface JQuery { /** * Fired after rendering of the tile manager completes. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. */ @@ -71261,7 +70775,7 @@ interface JQuery { /** * Fired after rendering of the tile manager completes. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. * @@ -71271,7 +70785,7 @@ interface JQuery { /** * Event fired before a tile is rendered in the container - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. * Use ui.tile to get a reference to the tile being rendered @@ -71280,7 +70794,7 @@ interface JQuery { /** * Event fired before a tile is rendered in the container - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. * Use ui.tile to get a reference to the tile being rendered @@ -71291,7 +70805,7 @@ interface JQuery { /** * Event Fired after a tile has been rendered in the container - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. * Use ui.tile to get a reference to the rendered tile @@ -71300,7 +70814,7 @@ interface JQuery { /** * Event Fired after a tile has been rendered in the container - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing rendering. * Use ui.tile to get a reference to the rendered tile @@ -71311,7 +70825,7 @@ interface JQuery { /** * Fired before a tile in the tile manager is maximized. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing the maximizing the tile belongs to. * Use ui.tile to get the jQuery element of the tile being maximized @@ -71321,7 +70835,7 @@ interface JQuery { /** * Fired before a tile in the tile manager is maximized. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing the maximizing the tile belongs to. * Use ui.tile to get the jQuery element of the tile being maximized @@ -71333,7 +70847,7 @@ interface JQuery { /** * Fired after a tile in the tile manager is maximized. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager the maximized tile belongs to. * Use ui.tile to get the jQuery element of the maximized tile @@ -71342,7 +70856,7 @@ interface JQuery { /** * Fired after a tile in the tile manager is maximized. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager the maximized tile belongs to. * Use ui.tile to get the jQuery element of the maximized tile @@ -71353,7 +70867,7 @@ interface JQuery { /** * Fired before a tile in the tile manager is minimized. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing the minimizing the tile belongs to. * Use ui.tile to get the jQuery element of the tile being minimized @@ -71363,7 +70877,7 @@ interface JQuery { /** * Fired before a tile in the tile manager is minimized. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager performing the minimizing the tile belongs to. * Use ui.tile to get the jQuery element of the tile being minimized @@ -71375,7 +70889,7 @@ interface JQuery { /** * Fired after a tile in the tile manager is minimized. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager the minimized tile belongs to. * Use ui.tile to get the jQuery element of the minimized tile @@ -71384,7 +70898,7 @@ interface JQuery { /** * Fired after a tile in the tile manager is minimized. - * + * * Function takes arguments evt and ui. * Use ui.owner to get a reference to the tile manager the minimized tile belongs to. * Use ui.tile to get the jQuery element of the minimized tile @@ -71462,7 +70976,6 @@ interface WindowResizedEventUIParam { } interface IgToolbar { - /** * Set/Get the widget height. * @@ -71588,7 +71101,6 @@ interface IgToolbar { [optionName: string]: any; } interface IgToolbarMethods { - /** * Returns the element on which the widget was instantiated */ @@ -71642,7 +71154,7 @@ interface IgToolbarMethods { destroy(): void; } interface JQuery { - data(propertyName: "igToolbar"):IgToolbarMethods; + data(propertyName: "igToolbar"): IgToolbarMethods; } interface JQuery { @@ -71947,7 +71459,6 @@ interface ActivatingEvent { } interface ActivatingEventUIParam { - /** * Used to get reference to this igToolbarButton. */ @@ -71959,7 +71470,6 @@ interface ActivatedEvent { } interface ActivatedEventUIParam { - /** * Used to get reference to this igToolbarButton. */ @@ -71971,7 +71481,6 @@ interface DeactivatingEvent { } interface DeactivatingEventUIParam { - /** * Used to get reference to this igToolbarButton. */ @@ -71983,7 +71492,6 @@ interface DeactivatedEvent { } interface DeactivatedEventUIParam { - /** * Used to get reference to this igToolbarButton. */ @@ -71991,7 +71499,6 @@ interface DeactivatedEventUIParam { } interface IgToolbarButton { - /** * Enable/Disable the "Toggling" of a button. * @@ -72038,7 +71545,6 @@ interface IgToolbarButton { [optionName: string]: any; } interface IgToolbarButtonMethods { - /** * Toggle toolbar button */ @@ -72047,14 +71553,14 @@ interface IgToolbarButtonMethods { /** * Activate toolbar button * - * @param event + * @param event */ activate(event: Object): void; /** * Deactivate toolbar button * - * @param event + * @param event */ deactivate(event: Object): void; @@ -72069,7 +71575,7 @@ interface IgToolbarButtonMethods { destroy(): void; } interface JQuery { - data(propertyName: "igToolbarButton"):IgToolbarButtonMethods; + data(propertyName: "igToolbarButton"): IgToolbarButtonMethods; } interface JQuery { @@ -72177,7 +71683,6 @@ interface JQuery { igToolbarButton(methodName: string, ...methodParams: any[]): any; } interface IgTreeGridColumnFixing { - /** * Option for igTreeGridColumnFixing */ @@ -72187,7 +71692,7 @@ interface IgTreeGridColumnFixingMethods { destroy(): void; } interface JQuery { - data(propertyName: "igTreeGridColumnFixing"):IgTreeGridColumnFixingMethods; + data(propertyName: "igTreeGridColumnFixing"): IgTreeGridColumnFixingMethods; } interface JQuery { @@ -72199,7 +71704,6 @@ interface JQuery { igTreeGridColumnFixing(methodName: string, ...methodParams: any[]): any; } interface IgTreeGridColumnMoving { - /** * Option for igTreeGridColumnMoving */ @@ -72209,7 +71713,7 @@ interface IgTreeGridColumnMovingMethods { destroy(): void; } interface JQuery { - data(propertyName: "igTreeGridColumnMoving"):IgTreeGridColumnMovingMethods; + data(propertyName: "igTreeGridColumnMoving"): IgTreeGridColumnMovingMethods; } interface JQuery { @@ -72221,7 +71725,6 @@ interface JQuery { igTreeGridColumnMoving(methodName: string, ...methodParams: any[]): any; } interface IgTreeGridFiltering { - /** * The property in the response that will hold the total number of records in the data source * @@ -72271,7 +71774,6 @@ interface IgTreeGridFiltering { [optionName: string]: any; } interface IgTreeGridFilteringMethods { - /** * Returns the count of data records that match filtering conditions */ @@ -72279,7 +71781,7 @@ interface IgTreeGridFilteringMethods { destroy(): void; } interface JQuery { - data(propertyName: "igTreeGridFiltering"):IgTreeGridFilteringMethods; + data(propertyName: "igTreeGridFiltering"): IgTreeGridFilteringMethods; } interface JQuery { @@ -72390,7 +71892,6 @@ interface JQuery { igTreeGridFiltering(methodName: string, ...methodParams: any[]): any; } interface IgTreeGridHiding { - /** * A list of column settings that specifies hiding options on a per column basis. * @@ -72405,7 +71906,7 @@ interface IgTreeGridHiding { /** * Controls containment behavior. - * + * * owner The column chooser dialog will be draggable only in the grid area * window The column chooser dialog will be draggable in the whole window area */ @@ -72736,7 +72237,7 @@ interface IgTreeGridHidingMethods { removeColumnChooserResetButton(): void; } interface JQuery { - data(propertyName: "igTreeGridHiding"):IgTreeGridHidingMethods; + data(propertyName: "igTreeGridHiding"): IgTreeGridHidingMethods; } interface JQuery { @@ -72782,7 +72283,7 @@ interface JQuery { /** * Controls containment behavior. - * + * * owner The column chooser dialog will be draggable only in the grid area * window The column chooser dialog will be draggable in the whole window area */ @@ -72790,7 +72291,7 @@ interface JQuery { /** * Controls containment behavior. - * + * * owner The column chooser dialog will be draggable only in the grid area * window The column chooser dialog will be draggable in the whole window area * @@ -73364,7 +72865,6 @@ interface JQuery { igTreeGridHiding(methodName: string, ...methodParams: any[]): any; } interface IgTreeGridDataSourceSettings { - /** * The name of the property that keeps track of the expansion state of a data item. Defaults to __ig_options.expanded. * @@ -73390,7 +72890,6 @@ interface IgTreeGridDataSourceSettings { } interface IgTreeGrid { - /** * Specifies the indentation (in pixels or percent) for a tree grid row. Nested indentation is achieved by calculating the level times the indentation value. Ex: '10px' or '5%'. Default is 30. * @@ -73519,7 +73018,6 @@ interface IgTreeGrid { [optionName: string]: any; } interface IgTreeGridMethods { - /** * Clears the transaction log (delegates to igDataSource). Note that this does not update the UI. In case the UI must be updated, set the second parameter "updateUI" to true, which will trigger a call to dataBind() to re-render the contents. * @@ -73571,7 +73069,7 @@ interface IgTreeGridMethods { destroy(): Object; } interface JQuery { - data(propertyName: "igTreeGrid"):IgTreeGridMethods; + data(propertyName: "igTreeGrid"): IgTreeGridMethods; } interface JQuery { @@ -73869,7 +73367,6 @@ interface JQuery { igTreeGrid(methodName: string, ...methodParams: any[]): any; } interface IgTreeGridMultiColumnHeaders { - /** * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. */ @@ -73956,7 +73453,7 @@ interface IgTreeGridMultiColumnHeadersMethods { getMultiColumnHeaders(): any[]; } interface JQuery { - data(propertyName: "igTreeGridMultiColumnHeaders"):IgTreeGridMultiColumnHeadersMethods; + data(propertyName: "igTreeGridMultiColumnHeaders"): IgTreeGridMultiColumnHeadersMethods; } interface JQuery { @@ -74076,7 +73573,6 @@ interface ContextRowRenderingEvent { } interface ContextRowRenderingEventUIParam { - /** * Used to get reference to igTreeGridPaging. */ @@ -74103,7 +73599,6 @@ interface ContextRowRenderedEvent { } interface ContextRowRenderedEventUIParam { - /** * Used to get reference to igTreeGridPaging. */ @@ -74131,7 +73626,6 @@ interface ContextRowRenderedEventUIParam { } interface IgTreeGridPaging { - /** * Sets gets paging mode. * @@ -74396,7 +73890,7 @@ interface IgTreeGridPaging { persist?: boolean; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. * */ inherit?: boolean; @@ -74488,7 +73982,6 @@ interface IgTreeGridPaging { [optionName: string]: any; } interface IgTreeGridPagingMethods { - /** * Destroys the igTreeGridPaging feature by removing all elements in the pager area, unbinding events, and resetting data to discard data filtering on paging */ @@ -74519,7 +74012,7 @@ interface IgTreeGridPagingMethods { pageSize(size?: number): number; } interface JQuery { - data(propertyName: "igTreeGridPaging"):IgTreeGridPagingMethods; + data(propertyName: "igTreeGridPaging"): IgTreeGridPagingMethods; } interface JQuery { @@ -75104,13 +74597,13 @@ interface JQuery { igTreeGridPaging(optionLiteral: 'option', optionName: "persist", optionValue: boolean): void; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. * */ igTreeGridPaging(optionLiteral: 'option', optionName: "inherit"): boolean; /** - * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. + * Enables/disables feature inheritance for the child layouts. NOTE: It only applies for igHierarchicalGrid. * * * @optionValue New value to be set. @@ -75301,7 +74794,6 @@ interface JQuery { igTreeGridPaging(methodName: string, ...methodParams: any[]): any; } interface IgTreeGridResizing { - /** * Resize the column to the size of the longest currently visible cell value. * @@ -75382,7 +74874,7 @@ interface IgTreeGridResizingMethods { resize(column: Object, width?: Object): void; } interface JQuery { - data(propertyName: "igTreeGridResizing"):IgTreeGridResizingMethods; + data(propertyName: "igTreeGridResizing"): IgTreeGridResizingMethods; } interface JQuery { @@ -75537,7 +75029,6 @@ interface JQuery { igTreeGridResizing(methodName: string, ...methodParams: any[]): any; } interface IgTreeGridRowSelectors { - /** * Determines row numbering format. * @@ -75577,7 +75068,7 @@ interface IgTreeGridRowSelectors { rowNumberingSeed?: number; /** - * + * * * Valid values: * "string" The row selector column width can be set in pixels (px) and percentage (%) @@ -75729,12 +75220,12 @@ interface IgTreeGridRowSelectorsMethods { /** * Returns the check state of the row by id. * - * @param rowId + * @param rowId */ checkStateById(rowId: Object): string; } interface JQuery { - data(propertyName: "igTreeGridRowSelectors"):IgTreeGridRowSelectorsMethods; + data(propertyName: "igTreeGridRowSelectors"): IgTreeGridRowSelectorsMethods; } interface JQuery { @@ -76028,7 +75519,6 @@ interface JQuery { igTreeGridRowSelectors(methodName: string, ...methodParams: any[]): any; } interface IgTreeGridSelection { - /** * Enables / Disables multiple selection of cells and rows - depending on the mode * @@ -76292,28 +75782,28 @@ interface IgTreeGridSelectionMethods { /** * Returns an array of selected cells in arbitrary order where every objects has the format { element: , row: , index: , rowIndex: , columnKey: } . - * + * * If multiple selection is disabled the function will return null. */ selectedCells(): any[]; /** * Returns an array of selected rows in arbitrary order where every object has the format { element: , index: } . - * + * * If multiple selection is disabled the function will return null. */ selectedRows(): any[]; /** * Returns the currently selected cell that has the format { element: , row: , index: , rowIndex: , columnKey: }, if any. - * + * * If multiple selection is enabled the function will return null. */ selectedCell(): Object; /** * Returns the currently selected row that has the format { element: , index: }, if any. - * + * * If multiple selection is enabled the function will return null. */ selectedRow(): Object; @@ -76329,7 +75819,7 @@ interface IgTreeGridSelectionMethods { activeRow(): Object; } interface JQuery { - data(propertyName: "igTreeGridSelection"):IgTreeGridSelectionMethods; + data(propertyName: "igTreeGridSelection"): IgTreeGridSelectionMethods; } interface JQuery { @@ -76756,7 +76246,6 @@ interface JQuery { igTreeGridSelection(methodName: string, ...methodParams: any[]): any; } interface IgTreeGridSorting { - /** * Specifies from which data bound level to be applied sorting - 0 is the first level * @@ -76958,7 +76447,7 @@ interface IgTreeGridSorting { /** * Controls containment behavior of multiple sorting dialog. - * + * * owner The multi sorting dialog will be draggable only in the grid area * window The multi sorting dialog will be draggable in the whole window area */ @@ -77120,7 +76609,6 @@ interface IgTreeGridSorting { [optionName: string]: any; } interface IgTreeGridSortingMethods { - /** * Returns whether a column with the specified columnKey is sorted(taken from the data source sorting expressions) * @@ -77134,7 +76622,7 @@ interface IgTreeGridSortingMethods { * * @param index Column key (string) or index (number) - for multi-row grid only column key can be used. Specifies the column which we want to sort. If the mode is multiple, previous sorting states are not cleared. * @param direction Specifies sorting direction (ascending or descending) - * @param header + * @param header */ sortColumn(index: Object, direction: Object, header: Object): void; @@ -77169,7 +76657,7 @@ interface IgTreeGridSortingMethods { /** * Renders content of multiple sorting dialog - sorted and unsorted columns. * - * @param isToCallEvents + * @param isToCallEvents */ renderMultipleSortingDialogContent(isToCallEvents: Object): void; @@ -77179,7 +76667,7 @@ interface IgTreeGridSortingMethods { removeDialogClearButton(): void; } interface JQuery { - data(propertyName: "igTreeGridSorting"):IgTreeGridSortingMethods; + data(propertyName: "igTreeGridSorting"): IgTreeGridSortingMethods; } interface JQuery { @@ -77614,7 +77102,7 @@ interface JQuery { /** * Controls containment behavior of multiple sorting dialog. - * + * * owner The multi sorting dialog will be draggable only in the grid area * window The multi sorting dialog will be draggable in the whole window area */ @@ -77622,7 +77110,7 @@ interface JQuery { /** * Controls containment behavior of multiple sorting dialog. - * + * * owner The multi sorting dialog will be draggable only in the grid area * window The multi sorting dialog will be draggable in the whole window area * @@ -77968,7 +77456,6 @@ interface JQuery { igTreeGridSorting(methodName: string, ...methodParams: any[]): any; } interface IgTreeGridTooltips { - /** * determines the tooltip visibility option * @@ -78095,7 +77582,7 @@ interface IgTreeGridTooltipsMethods { id(): string; } interface JQuery { - data(propertyName: "igTreeGridTooltips"):IgTreeGridTooltipsMethods; + data(propertyName: "igTreeGridTooltips"): IgTreeGridTooltipsMethods; } interface JQuery { @@ -78340,7 +77827,6 @@ interface JQuery { igTreeGridTooltips(methodName: string, ...methodParams: any[]): any; } interface IgTreeGridUpdating { - /** * Specifies whether to enable or disable adding children to rows. * @@ -78735,7 +78221,6 @@ interface IgTreeGridUpdating { [optionName: string]: any; } interface IgTreeGridUpdatingMethods { - /** * Adds a new child to a specific row. It also creates a transaction and updates the UI. * @@ -78860,7 +78345,7 @@ interface IgTreeGridUpdatingMethods { hideDeleteButton(): void; } interface JQuery { - data(propertyName: "igTreeGridUpdating"):IgTreeGridUpdatingMethods; + data(propertyName: "igTreeGridUpdating"): IgTreeGridUpdatingMethods; } interface JQuery { @@ -79770,11 +79255,10 @@ interface IgBrowseButtonMethods { destroy(): void; } interface JQuery { - data(propertyName: "igBrowseButton"):IgBrowseButtonMethods; + data(propertyName: "igBrowseButton"): IgBrowseButtonMethods; } interface IgUploadFileExtensionIcons { - /** * Array of string for file extensions */ @@ -79801,7 +79285,6 @@ interface FileSelectingEvent { } interface FileSelectingEventUIParam { - /** * Used to access the igUpload widget object. */ @@ -79813,7 +79296,6 @@ interface FileSelectedEvent { } interface FileSelectedEventUIParam { - /** * Used to get unique identifier of the file */ @@ -79835,7 +79317,6 @@ interface FileUploadingEvent { } interface FileUploadingEventUIParam { - /** * Used to get unique identifier of the file */ @@ -79877,7 +79358,6 @@ interface FileUploadedEvent { } interface FileUploadedEventUIParam { - /** * Used to get unique identifier of the file */ @@ -79909,7 +79389,6 @@ interface FileUploadAbortedEvent { } interface FileUploadAbortedEventUIParam { - /** * Used to get unique identifier of the file */ @@ -79946,7 +79425,6 @@ interface CancelAllClickedEvent { } interface CancelAllClickedEventUIParam { - /** * Used to access the igUpload widget object. */ @@ -79958,7 +79436,6 @@ interface OnErrorEvent { } interface OnErrorEventUIParam { - /** * Used to get current errorCode */ @@ -79995,7 +79472,6 @@ interface FileExtensionsValidatingEvent { } interface FileExtensionsValidatingEventUIParam { - /** * Used to get the full file name */ @@ -80017,7 +79493,6 @@ interface OnXHRLoadEvent { } interface OnXHRLoadEventUIParam { - /** * Used to get unique identifier of the file */ @@ -80044,7 +79519,6 @@ interface OnFormDataSubmitEvent { } interface OnFormDataSubmitEventUIParam { - /** * Used to get unique identifier of the file */ @@ -80072,7 +79546,6 @@ interface OnFormDataSubmitEventUIParam { } interface IgUpload { - /** * Get or set width of the main container of the file upload control. Main container contains all buttons, progressbar, etc. * @@ -80421,7 +79894,6 @@ interface IgUpload { [optionName: string]: any; } interface IgUploadMethods { - /** * Return jquery object of fileupload container - html DOM element */ @@ -80491,7 +79963,7 @@ interface IgUploadMethods { getFileInfo(fileIndex: number): Object; } interface JQuery { - data(propertyName: "igUpload"):IgUploadMethods; + data(propertyName: "igUpload"): IgUploadMethods; } interface JQuery { @@ -81335,7 +80807,6 @@ interface JQuery { igUpload(methodName: string, ...methodParams: any[]): any; } interface IgValidatorField { - /** * Gets the target element (input or control target) to be validated. This field setting is required. * @@ -81357,7 +80828,6 @@ interface ValidatingEvent { } interface ValidatingEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81374,7 +80844,6 @@ interface ValidatedEvent { } interface ValidatedEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81401,7 +80870,6 @@ interface SuccessEvent { } interface SuccessEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81428,7 +80896,6 @@ interface ErrorEvent { } interface ErrorEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81455,7 +80922,6 @@ interface ErrorShowingEvent { } interface ErrorShowingEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81477,7 +80943,6 @@ interface ErrorHidingEvent { } interface ErrorHidingEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81499,7 +80964,6 @@ interface ErrorShownEvent { } interface ErrorShownEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81521,7 +80985,6 @@ interface ErrorHiddenEvent { } interface ErrorHiddenEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81543,7 +81006,6 @@ interface SuccessShowingEvent { } interface SuccessShowingEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81565,7 +81027,6 @@ interface SuccessHidingEvent { } interface SuccessHidingEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81587,7 +81048,6 @@ interface SuccessShownEvent { } interface SuccessShownEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81609,7 +81069,6 @@ interface SuccessHiddenEvent { } interface SuccessHiddenEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81631,7 +81090,6 @@ interface FormValidatingEvent { } interface FormValidatingEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81648,7 +81106,6 @@ interface FormValidatedEvent { } interface FormValidatedEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81670,7 +81127,6 @@ interface FormErrorEvent { } interface FormErrorEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81687,7 +81143,6 @@ interface FormSuccessEvent { } interface FormSuccessEventUIParam { - /** * Used to get reference to the igValidator widget. */ @@ -81700,7 +81155,6 @@ interface FormSuccessEventUIParam { } interface IgValidator { - /** * Gets/Sets whether validation is triggered when the text in editor changes. * Note that this is more appropriate for selection controls such as checkbox, combo or rating. @@ -81734,7 +81188,7 @@ interface IgValidator { /** * Gets/Sets number validation rule options.Default separators for decimals and thousands are '.' and ',' respectively and are defined in the "$.ui.igValidator.defaults" object. - * + * * * * Valid values: @@ -81745,7 +81199,7 @@ interface IgValidator { /** * Gets/Sets date validation rule options. This can additionally help guide the [valueRange](ui.igvalidator#options:valueRange) validation.Note: Dependat on JavaScript Date parsing which will accept a wide range of values. - * + * * * * Valid values: @@ -81786,7 +81240,7 @@ interface IgValidator { /** * Gets/Sets Credit Card number validation rule options.Note: This rule will only validate the checksum of the number using Luhn algorithm irregardless of card type. - * + * * * * Valid values: @@ -81881,7 +81335,7 @@ interface IgValidator { /** * Event which is raised on validation before default validation logic is applied. * Return false in order to cancel the event and consider the field valid. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.value to get current value in target. @@ -81891,7 +81345,7 @@ interface IgValidator { /** * Event which is raised after value was validated but before any action takes effect. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.value to get current value in target. @@ -81905,7 +81359,7 @@ interface IgValidator { /** * Event raised for valid field after value was validated but before any action takes effect. * Function takes arguments evt and ui. - * + * * Use ui.owner to get reference to the igValidator widget. * Use ui.value to get current value in target. * Use ui.valid to determine the outcome of the validation. @@ -81917,7 +81371,7 @@ interface IgValidator { /** * Event raised for invalid field after value was validated but before any action takes effect. * Function takes arguments evt and ui. - * + * * Use ui.owner to get reference to the igValidator widget. * Use ui.value to get current value in target. * Use ui.valid to determine the outcome of the validation. @@ -81930,7 +81384,7 @@ interface IgValidator { /** * Event which is raised before error message is displayed. * Return false in order to prevent error message display. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -81942,7 +81396,7 @@ interface IgValidator { /** * Event which is raised before error message is hidden. * Return false in order to keep the error message displayed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -81953,7 +81407,7 @@ interface IgValidator { /** * Event which is raised after error message was displayed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -81964,7 +81418,7 @@ interface IgValidator { /** * Event which is raised after error message was hidden. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -81976,7 +81430,7 @@ interface IgValidator { /** * Event which is raised before success message is displayed. * Return false in order to prevent success message display. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -81988,7 +81442,7 @@ interface IgValidator { /** * Event which is raised before success message is hidden. * Return false in order to keep success message displayed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -81999,7 +81453,7 @@ interface IgValidator { /** * Event which is raised after success message was displayed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -82010,7 +81464,7 @@ interface IgValidator { /** * Event which is raised after success message was hidden. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -82022,7 +81476,7 @@ interface IgValidator { /** * Event triggered on Validator instance level before handling a form submit event. * Return false to cancel to skip validating and potentially allow the submit if no other other validators return erros. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.target to get reference of the event target form. @@ -82031,7 +81485,7 @@ interface IgValidator { /** * Event triggered on Validator instance level after validation on form submit event.. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.target to get reference of the event target form. @@ -82041,7 +81495,7 @@ interface IgValidator { /** * Event triggered on Validator instance level after failed validation on form submit event. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.target to get reference of the event target form. @@ -82050,7 +81504,7 @@ interface IgValidator { /** * Event triggered on Validator instance level after successful validation on form submit event. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.target to get reference of the event target form. @@ -82063,7 +81517,6 @@ interface IgValidator { [optionName: string]: any; } interface IgValidatorMethods { - /** * Trigger validation and show errors for invalid fields. * @@ -82137,372 +81590,372 @@ interface IgValidatorMethods { destroy(): void; } interface JQuery { - data(propertyName: "igValidator"):IgValidatorMethods; + data(propertyName: "igValidator"): IgValidatorMethods; } -declare module Infragistics { -export class IgValidatorBaseRule { - constructor(name: string); - constructor(formatItems: any[]); +declare namespace Infragistics { + class IgValidatorBaseRule { + constructor(name: string); + constructor(formatItems: any[]); - /** - * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. - * Only used when there's no errorMessage option available through getRuleMessage. - * - * @param options - */ - getMessageType(options: Object): string; + /** + * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. + * Only used when there's no errorMessage option available through getRuleMessage. + * + * @param options + */ + getMessageType(options: Object): string; - /** - * Gets an errorMessage from either the rule or field/global options. - * - * @param options - */ - getRuleMessage(options: Object): string; + /** + * Gets an errorMessage from either the rule or field/global options. + * + * @param options + */ + getRuleMessage(options: Object): string; - /** - * Formats an error message using rule-specific values (usually from formatItems). - * - * @param message The unformatted error message the validator intends to display. - */ - formatMessage(message: string): string; + /** + * Formats an error message using rule-specific values (usually from formatItems). + * + * @param message The unformatted error message the validator intends to display. + */ + formatMessage(message: string): string; - /** - * Validates a value against this rule and returns the result. - * - * @param options Options for the validator, if fields are used this parameter is already populated with inherited ones. - * @param value The value to check. - */ - isValid(options: Object, value: Object): boolean; -} + /** + * Validates a value against this rule and returns the result. + * + * @param options Options for the validator, if fields are used this parameter is already populated with inherited ones. + * @param value The value to check. + */ + isValid(options: Object, value: Object): boolean; + } } interface IgniteUIStatic { -IgValidatorBaseRule: typeof Infragistics.IgValidatorBaseRule; + IgValidatorBaseRule: typeof Infragistics.IgValidatorBaseRule; } -declare module Infragistics { -export class IgValidatorRequiredRule { - constructor(name: string); - constructor(groupTypes: any[]); - constructor(groupMessageName: string); - constructor(formatItems: any[]); - getMessageType(options: Object): void; - isValid(options: Object, value: Object): void; +declare namespace Infragistics { + class IgValidatorRequiredRule { + constructor(name: string); + constructor(groupTypes: any[]); + constructor(groupMessageName: string); + constructor(formatItems: any[]); + getMessageType(options: Object): void; + isValid(options: Object, value: Object): void; - /** - * Gets an errorMessage from either the rule or field/global options. - * - * @param options - */ - getRuleMessage(options: Object): string; + /** + * Gets an errorMessage from either the rule or field/global options. + * + * @param options + */ + getRuleMessage(options: Object): string; - /** - * Formats an error message using rule-specific values (usually from formatItems). - * - * @param message The unformatted error message the validator intends to display. - */ - formatMessage(message: string): string; -} + /** + * Formats an error message using rule-specific values (usually from formatItems). + * + * @param message The unformatted error message the validator intends to display. + */ + formatMessage(message: string): string; + } } interface IgniteUIStatic { -IgValidatorRequiredRule: typeof Infragistics.IgValidatorRequiredRule; + IgValidatorRequiredRule: typeof Infragistics.IgValidatorRequiredRule; } -declare module Infragistics { -export class IgValidatorControlRule { - constructor(name: string); - constructor(formatItems: any[]); - getMessageType(): void; +declare namespace Infragistics { + class IgValidatorControlRule { + constructor(name: string); + constructor(formatItems: any[]); + getMessageType(): void; - /** - * Returns an error message for the rule from options - * - * @param options - */ - getRuleMessage(options: Object): void; - isValid(options: Object): void; + /** + * Returns an error message for the rule from options + * + * @param options + */ + getRuleMessage(options: Object): void; + isValid(options: Object): void; - /** - * Formats an error message using rule-specific values (usually from formatItems). - * - * @param message The unformatted error message the validator intends to display. - */ - formatMessage(message: string): string; -} + /** + * Formats an error message using rule-specific values (usually from formatItems). + * + * @param message The unformatted error message the validator intends to display. + */ + formatMessage(message: string): string; + } } interface IgniteUIStatic { -IgValidatorControlRule: typeof Infragistics.IgValidatorControlRule; + IgValidatorControlRule: typeof Infragistics.IgValidatorControlRule; } -declare module Infragistics { -export class IgValidatorNumberRule { - constructor(name: string); - constructor(formatItems: any[]); - isValid(options: Object, value: Object): void; +declare namespace Infragistics { + class IgValidatorNumberRule { + constructor(name: string); + constructor(formatItems: any[]); + isValid(options: Object, value: Object): void; - /** - * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. - * Only used when there's no errorMessage option available through getRuleMessage. - * - * @param options - */ - getMessageType(options: Object): string; + /** + * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. + * Only used when there's no errorMessage option available through getRuleMessage. + * + * @param options + */ + getMessageType(options: Object): string; - /** - * Gets an errorMessage from either the rule or field/global options. - * - * @param options - */ - getRuleMessage(options: Object): string; + /** + * Gets an errorMessage from either the rule or field/global options. + * + * @param options + */ + getRuleMessage(options: Object): string; - /** - * Formats an error message using rule-specific values (usually from formatItems). - * - * @param message The unformatted error message the validator intends to display. - */ - formatMessage(message: string): string; -} + /** + * Formats an error message using rule-specific values (usually from formatItems). + * + * @param message The unformatted error message the validator intends to display. + */ + formatMessage(message: string): string; + } } interface IgniteUIStatic { -IgValidatorNumberRule: typeof Infragistics.IgValidatorNumberRule; + IgValidatorNumberRule: typeof Infragistics.IgValidatorNumberRule; } -declare module Infragistics { -export class IgValidatorDateRule { - constructor(name: string); - constructor(formatItems: any[]); - isValid(options: Object, value: Object): void; +declare namespace Infragistics { + class IgValidatorDateRule { + constructor(name: string); + constructor(formatItems: any[]); + isValid(options: Object, value: Object): void; - /** - * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. - * Only used when there's no errorMessage option available through getRuleMessage. - * - * @param options - */ - getMessageType(options: Object): string; + /** + * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. + * Only used when there's no errorMessage option available through getRuleMessage. + * + * @param options + */ + getMessageType(options: Object): string; - /** - * Gets an errorMessage from either the rule or field/global options. - * - * @param options - */ - getRuleMessage(options: Object): string; + /** + * Gets an errorMessage from either the rule or field/global options. + * + * @param options + */ + getRuleMessage(options: Object): string; - /** - * Formats an error message using rule-specific values (usually from formatItems). - * - * @param message The unformatted error message the validator intends to display. - */ - formatMessage(message: string): string; -} + /** + * Formats an error message using rule-specific values (usually from formatItems). + * + * @param message The unformatted error message the validator intends to display. + */ + formatMessage(message: string): string; + } } interface IgniteUIStatic { -IgValidatorDateRule: typeof Infragistics.IgValidatorDateRule; + IgValidatorDateRule: typeof Infragistics.IgValidatorDateRule; } -declare module Infragistics { -export class IgValidatorLengthRule { - constructor(name: string); - constructor(formatItems: any[]); - getMessageType(): void; - isValid(options: Object, value: Object): void; +declare namespace Infragistics { + class IgValidatorLengthRule { + constructor(name: string); + constructor(formatItems: any[]); + getMessageType(): void; + isValid(options: Object, value: Object): void; - /** - * Gets an errorMessage from either the rule or field/global options. - * - * @param options - */ - getRuleMessage(options: Object): string; + /** + * Gets an errorMessage from either the rule or field/global options. + * + * @param options + */ + getRuleMessage(options: Object): string; - /** - * Formats an error message using rule-specific values (usually from formatItems). - * - * @param message The unformatted error message the validator intends to display. - */ - formatMessage(message: string): string; -} + /** + * Formats an error message using rule-specific values (usually from formatItems). + * + * @param message The unformatted error message the validator intends to display. + */ + formatMessage(message: string): string; + } } interface IgniteUIStatic { -IgValidatorLengthRule: typeof Infragistics.IgValidatorLengthRule; + IgValidatorLengthRule: typeof Infragistics.IgValidatorLengthRule; } -declare module Infragistics { -export class IgValidatorValueRule { - constructor(name: string); - constructor(formatItems: any[]); - getMessageType(): void; - isValid(options: Object, value: Object): void; -} +declare namespace Infragistics { + class IgValidatorValueRule { + constructor(name: string); + constructor(formatItems: any[]); + getMessageType(): void; + isValid(options: Object, value: Object): void; + } } interface IgniteUIStatic { -IgValidatorValueRule: typeof Infragistics.IgValidatorValueRule; + IgValidatorValueRule: typeof Infragistics.IgValidatorValueRule; } -declare module Infragistics { -export class IgValidatorEqualToRule { - constructor(name: string); - constructor(formatItems: any[]); - isValid(options: Object, value: Object): void; +declare namespace Infragistics { + class IgValidatorEqualToRule { + constructor(name: string); + constructor(formatItems: any[]); + isValid(options: Object, value: Object): void; - /** - * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. - * Only used when there's no errorMessage option available through getRuleMessage. - * - * @param options - */ - getMessageType(options: Object): string; + /** + * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. + * Only used when there's no errorMessage option available through getRuleMessage. + * + * @param options + */ + getMessageType(options: Object): string; - /** - * Gets an errorMessage from either the rule or field/global options. - * - * @param options - */ - getRuleMessage(options: Object): string; + /** + * Gets an errorMessage from either the rule or field/global options. + * + * @param options + */ + getRuleMessage(options: Object): string; - /** - * Formats an error message using rule-specific values (usually from formatItems). - * - * @param message The unformatted error message the validator intends to display. - */ - formatMessage(message: string): string; -} + /** + * Formats an error message using rule-specific values (usually from formatItems). + * + * @param message The unformatted error message the validator intends to display. + */ + formatMessage(message: string): string; + } } interface IgniteUIStatic { -IgValidatorEqualToRule: typeof Infragistics.IgValidatorEqualToRule; + IgValidatorEqualToRule: typeof Infragistics.IgValidatorEqualToRule; } -declare module Infragistics { -export class IgValidatorEmailRule { - constructor(name: string); - constructor(formatItems: any[]); - isValid(options: Object, value: Object): void; +declare namespace Infragistics { + class IgValidatorEmailRule { + constructor(name: string); + constructor(formatItems: any[]); + isValid(options: Object, value: Object): void; - /** - * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. - * Only used when there's no errorMessage option available through getRuleMessage. - * - * @param options - */ - getMessageType(options: Object): string; + /** + * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. + * Only used when there's no errorMessage option available through getRuleMessage. + * + * @param options + */ + getMessageType(options: Object): string; - /** - * Gets an errorMessage from either the rule or field/global options. - * - * @param options - */ - getRuleMessage(options: Object): string; + /** + * Gets an errorMessage from either the rule or field/global options. + * + * @param options + */ + getRuleMessage(options: Object): string; - /** - * Formats an error message using rule-specific values (usually from formatItems). - * - * @param message The unformatted error message the validator intends to display. - */ - formatMessage(message: string): string; -} + /** + * Formats an error message using rule-specific values (usually from formatItems). + * + * @param message The unformatted error message the validator intends to display. + */ + formatMessage(message: string): string; + } } interface IgniteUIStatic { -IgValidatorEmailRule: typeof Infragistics.IgValidatorEmailRule; + IgValidatorEmailRule: typeof Infragistics.IgValidatorEmailRule; } -declare module Infragistics { -export class IgValidatorPatternRule { - constructor(name: string); - constructor(formatItems: any[]); - isValid(options: Object, value: Object): void; +declare namespace Infragistics { + class IgValidatorPatternRule { + constructor(name: string); + constructor(formatItems: any[]); + isValid(options: Object, value: Object): void; - /** - * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. - * Only used when there's no errorMessage option available through getRuleMessage. - * - * @param options - */ - getMessageType(options: Object): string; + /** + * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. + * Only used when there's no errorMessage option available through getRuleMessage. + * + * @param options + */ + getMessageType(options: Object): string; - /** - * Gets an errorMessage from either the rule or field/global options. - * - * @param options - */ - getRuleMessage(options: Object): string; + /** + * Gets an errorMessage from either the rule or field/global options. + * + * @param options + */ + getRuleMessage(options: Object): string; - /** - * Formats an error message using rule-specific values (usually from formatItems). - * - * @param message The unformatted error message the validator intends to display. - */ - formatMessage(message: string): string; -} + /** + * Formats an error message using rule-specific values (usually from formatItems). + * + * @param message The unformatted error message the validator intends to display. + */ + formatMessage(message: string): string; + } } interface IgniteUIStatic { -IgValidatorPatternRule: typeof Infragistics.IgValidatorPatternRule; + IgValidatorPatternRule: typeof Infragistics.IgValidatorPatternRule; } -declare module Infragistics { -export class IgValidatorCustomRule { - constructor(name: string); - constructor(formatItems: any[]); - getMessageType(): void; - isValid(options: Object, value: Object): void; +declare namespace Infragistics { + class IgValidatorCustomRule { + constructor(name: string); + constructor(formatItems: any[]); + getMessageType(): void; + isValid(options: Object, value: Object): void; - /** - * Gets an errorMessage from either the rule or field/global options. - * - * @param options - */ - getRuleMessage(options: Object): string; + /** + * Gets an errorMessage from either the rule or field/global options. + * + * @param options + */ + getRuleMessage(options: Object): string; - /** - * Formats an error message using rule-specific values (usually from formatItems). - * - * @param message The unformatted error message the validator intends to display. - */ - formatMessage(message: string): string; -} + /** + * Formats an error message using rule-specific values (usually from formatItems). + * + * @param message The unformatted error message the validator intends to display. + */ + formatMessage(message: string): string; + } } interface IgniteUIStatic { -IgValidatorCustomRule: typeof Infragistics.IgValidatorCustomRule; + IgValidatorCustomRule: typeof Infragistics.IgValidatorCustomRule; } -declare module Infragistics { -export class IgValidatorCreditCardRule { - constructor(name: string); - constructor(formatItems: any[]); +declare namespace Infragistics { + class IgValidatorCreditCardRule { + constructor(name: string); + constructor(formatItems: any[]); - /** - * Based on ASP.NET CreditCardAttribute check, - * https://github.com/Microsoft/referencesource/blob/master/System.ComponentModel.DataAnnotations/DataAnnotations/CreditCardAttribute.cs - * using Luhn algorithm https://en.wikipedia.org/wiki/Luhn_algorithm - * - * @param options - * @param value - */ - isValid(options: Object, value: Object): void; + /** + * Based on ASP.NET CreditCardAttribute check, + * https://github.com/Microsoft/referencesource/blob/master/System.ComponentModel.DataAnnotations/DataAnnotations/CreditCardAttribute.cs + * using Luhn algorithm https://en.wikipedia.org/wiki/Luhn_algorithm + * + * @param options + * @param value + */ + isValid(options: Object, value: Object): void; - /** - * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. - * Only used when there's no errorMessage option available through getRuleMessage. - * - * @param options - */ - getMessageType(options: Object): string; + /** + * Gets the error message type to get from locale settings (matching as "Message>"). Returns the rule name by default. + * Only used when there's no errorMessage option available through getRuleMessage. + * + * @param options + */ + getMessageType(options: Object): string; - /** - * Gets an errorMessage from either the rule or field/global options. - * - * @param options - */ - getRuleMessage(options: Object): string; + /** + * Gets an errorMessage from either the rule or field/global options. + * + * @param options + */ + getRuleMessage(options: Object): string; - /** - * Formats an error message using rule-specific values (usually from formatItems). - * - * @param message The unformatted error message the validator intends to display. - */ - formatMessage(message: string): string; -} + /** + * Formats an error message using rule-specific values (usually from formatItems). + * + * @param message The unformatted error message the validator intends to display. + */ + formatMessage(message: string): string; + } } interface IgniteUIStatic { -IgValidatorCreditCardRule: typeof Infragistics.IgValidatorCreditCardRule; + IgValidatorCreditCardRule: typeof Infragistics.IgValidatorCreditCardRule; } interface JQuery { @@ -82581,14 +82034,14 @@ interface JQuery { /** * Gets/Sets number validation rule options.Default separators for decimals and thousands are '.' and ',' respectively and are defined in the "$.ui.igValidator.defaults" object. - * + * * */ igValidator(optionLiteral: 'option', optionName: "number"): boolean|Object; /** * /Sets number validation rule options.Default separators for decimals and thousands are '.' and ',' respectively and are defined in the "$.ui.igValidator.defaults" object. - * + * * * * @optionValue New value to be set. @@ -82597,14 +82050,14 @@ interface JQuery { /** * Gets/Sets date validation rule options. This can additionally help guide the [valueRange](ui.igvalidator#options:valueRange) validation.Note: Dependat on JavaScript Date parsing which will accept a wide range of values. - * + * * */ igValidator(optionLiteral: 'option', optionName: "date"): boolean|Object; /** * /Sets date validation rule options. This can additionally help guide the [valueRange](ui.igvalidator#options:valueRange) validation.Note: Dependat on JavaScript Date parsing which will accept a wide range of values. - * + * * * * @optionValue New value to be set. @@ -82655,14 +82108,14 @@ interface JQuery { /** * Gets/Sets Credit Card number validation rule options.Note: This rule will only validate the checksum of the number using Luhn algorithm irregardless of card type. - * + * * */ igValidator(optionLiteral: 'option', optionName: "creditCard"): boolean|Object; /** * /Sets Credit Card number validation rule options.Note: This rule will only validate the checksum of the number using Luhn algorithm irregardless of card type. - * + * * * * @optionValue New value to be set. @@ -82834,7 +82287,7 @@ interface JQuery { /** * Event which is raised on validation before default validation logic is applied. * Return false in order to cancel the event and consider the field valid. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.value to get current value in target. @@ -82845,7 +82298,7 @@ interface JQuery { /** * Event which is raised on validation before default validation logic is applied. * Return false in order to cancel the event and consider the field valid. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.value to get current value in target. @@ -82857,7 +82310,7 @@ interface JQuery { /** * Event which is raised after value was validated but before any action takes effect. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.value to get current value in target. @@ -82870,7 +82323,7 @@ interface JQuery { /** * Event which is raised after value was validated but before any action takes effect. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.value to get current value in target. @@ -82886,7 +82339,7 @@ interface JQuery { /** * Event raised for valid field after value was validated but before any action takes effect. * Function takes arguments evt and ui. - * + * * Use ui.owner to get reference to the igValidator widget. * Use ui.value to get current value in target. * Use ui.valid to determine the outcome of the validation. @@ -82898,7 +82351,7 @@ interface JQuery { /** * Event raised for valid field after value was validated but before any action takes effect. * Function takes arguments evt and ui. - * + * * Use ui.owner to get reference to the igValidator widget. * Use ui.value to get current value in target. * Use ui.valid to determine the outcome of the validation. @@ -82912,7 +82365,7 @@ interface JQuery { /** * Event raised for invalid field after value was validated but before any action takes effect. * Function takes arguments evt and ui. - * + * * Use ui.owner to get reference to the igValidator widget. * Use ui.value to get current value in target. * Use ui.valid to determine the outcome of the validation. @@ -82925,7 +82378,7 @@ interface JQuery { /** * Event raised for invalid field after value was validated but before any action takes effect. * Function takes arguments evt and ui. - * + * * Use ui.owner to get reference to the igValidator widget. * Use ui.value to get current value in target. * Use ui.valid to determine the outcome of the validation. @@ -82940,7 +82393,7 @@ interface JQuery { /** * Event which is raised before error message is displayed. * Return false in order to prevent error message display. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -82952,7 +82405,7 @@ interface JQuery { /** * Event which is raised before error message is displayed. * Return false in order to prevent error message display. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -82966,7 +82419,7 @@ interface JQuery { /** * Event which is raised before error message is hidden. * Return false in order to keep the error message displayed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -82978,7 +82431,7 @@ interface JQuery { /** * Event which is raised before error message is hidden. * Return false in order to keep the error message displayed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -82991,7 +82444,7 @@ interface JQuery { /** * Event which is raised after error message was displayed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -83002,7 +82455,7 @@ interface JQuery { /** * Event which is raised after error message was displayed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -83015,7 +82468,7 @@ interface JQuery { /** * Event which is raised after error message was hidden. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -83026,7 +82479,7 @@ interface JQuery { /** * Event which is raised after error message was hidden. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -83040,7 +82493,7 @@ interface JQuery { /** * Event which is raised before success message is displayed. * Return false in order to prevent success message display. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -83052,7 +82505,7 @@ interface JQuery { /** * Event which is raised before success message is displayed. * Return false in order to prevent success message display. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -83066,7 +82519,7 @@ interface JQuery { /** * Event which is raised before success message is hidden. * Return false in order to keep success message displayed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -83078,7 +82531,7 @@ interface JQuery { /** * Event which is raised before success message is hidden. * Return false in order to keep success message displayed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -83091,7 +82544,7 @@ interface JQuery { /** * Event which is raised after success message was displayed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -83102,7 +82555,7 @@ interface JQuery { /** * Event which is raised after success message was displayed. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -83115,7 +82568,7 @@ interface JQuery { /** * Event which is raised after success message was hidden. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -83126,7 +82579,7 @@ interface JQuery { /** * Event which is raised after success message was hidden. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.message to get text of message. @@ -83140,7 +82593,7 @@ interface JQuery { /** * Event triggered on Validator instance level before handling a form submit event. * Return false to cancel to skip validating and potentially allow the submit if no other other validators return erros. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.target to get reference of the event target form. @@ -83150,7 +82603,7 @@ interface JQuery { /** * Event triggered on Validator instance level before handling a form submit event. * Return false to cancel to skip validating and potentially allow the submit if no other other validators return erros. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.target to get reference of the event target form. @@ -83161,7 +82614,7 @@ interface JQuery { /** * Event triggered on Validator instance level after validation on form submit event.. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.target to get reference of the event target form. @@ -83171,7 +82624,7 @@ interface JQuery { /** * Event triggered on Validator instance level after validation on form submit event.. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.target to get reference of the event target form. @@ -83183,7 +82636,7 @@ interface JQuery { /** * Event triggered on Validator instance level after failed validation on form submit event. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.target to get reference of the event target form. @@ -83192,7 +82645,7 @@ interface JQuery { /** * Event triggered on Validator instance level after failed validation on form submit event. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.target to get reference of the event target form. @@ -83203,7 +82656,7 @@ interface JQuery { /** * Event triggered on Validator instance level after successful validation on form submit event. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.target to get reference of the event target form. @@ -83212,7 +82665,7 @@ interface JQuery { /** * Event triggered on Validator instance level after successful validation on form submit event. - * + * * Function takes arguments evt and ui. * Use ui.owner to get reference to the igValidator widget. * Use ui.target to get reference of the event target form. @@ -83227,7 +82680,6 @@ interface JQuery { igValidator(methodName: string, ...methodParams: any[]): any; } interface IgVideoPlayerBookmark { - /** * Gets/Sets where the bookmark will be positioned. Should be between 0 and movie duration in seconds. * @@ -83253,7 +82705,6 @@ interface IgVideoPlayerBookmark { } interface IgVideoPlayerRelatedVideo { - /** * Gets/Sets the URL of the related video image. * @@ -83303,7 +82754,6 @@ interface IgVideoPlayerRelatedVideo { } interface IgVideoPlayerBanner { - /** * Gets/Sets the banner image url. * @@ -83383,7 +82833,6 @@ interface IgVideoPlayerBanner { } interface IgVideoPlayerCommercialsLinkedCommercial { - /** * Gets/Sets the sources of the linked commercial video. * @@ -83415,7 +82864,6 @@ interface IgVideoPlayerCommercialsLinkedCommercial { } interface IgVideoPlayerCommercialsEmbeddedCommercial { - /** * Gets/Sets the start second of the embedded commercial. * @@ -83447,7 +82895,6 @@ interface IgVideoPlayerCommercialsEmbeddedCommercial { } interface IgVideoPlayerCommercialsAdMessage { - /** * Gets/Sets whether to apply an animation effect when showing or hiding the ad message. If set to true, the animation is played for [animationDuration](ui.igvideoplayer#options:commercials.adMessage.animationDuration) in milliseconds. * @@ -83479,7 +82926,6 @@ interface IgVideoPlayerCommercialsAdMessage { } interface IgVideoPlayerCommercials { - /** * Gets/Sets an array of linked commercial objects. A linked commercial is a separate video file that will be played in the specified position of the original movie clip by [startTime](ui.igvideoplayer#options:commercials.linkedCommercials.startTime). This feature is useful if you have frequently changing outside commercial sources. * @@ -83521,7 +82967,6 @@ interface EndedEvent { } interface EndedEventUIParam { - /** * Used to get the url of the playing video. */ @@ -83538,7 +82983,6 @@ interface PlayingEvent { } interface PlayingEventUIParam { - /** * Used to get the url of the playing video. */ @@ -83555,7 +82999,6 @@ interface PausedEvent { } interface PausedEventUIParam { - /** * Used to get the url of the playing video. */ @@ -83572,7 +83015,6 @@ interface BufferingEvent { } interface BufferingEventUIParam { - /** * Used to get the url of the playing video. */ @@ -83589,7 +83031,6 @@ interface ProgressEvent { } interface ProgressEventUIParam { - /** * Used to get the url of the playing video. */ @@ -83611,7 +83052,6 @@ interface WaitingEvent { } interface WaitingEventUIParam { - /** * Used to get the url of the playing video. */ @@ -83633,7 +83073,6 @@ interface EnterFullScreenEvent { } interface EnterFullScreenEventUIParam { - /** * Used to get the url of the playing video. */ @@ -83645,7 +83084,6 @@ interface ExitFullScreenEvent { } interface ExitFullScreenEventUIParam { - /** * Used to get the url of the playing video. */ @@ -83657,7 +83095,6 @@ interface RelatedVideoClickEvent { } interface RelatedVideoClickEventUIParam { - /** * Used to get the relatedVideo object from the relatedVideos array. */ @@ -83674,7 +83111,6 @@ interface BannerVisibleEvent { } interface BannerVisibleEventUIParam { - /** * Used to get the banner index in the banners array. */ @@ -83696,7 +83132,6 @@ interface BannerHiddenEvent { } interface BannerHiddenEventUIParam { - /** * Used to get the banner index in the banners array. */ @@ -83718,7 +83153,6 @@ interface BannerClickEvent { } interface BannerClickEventUIParam { - /** * Used to get the banner html element in the DOM. */ @@ -83726,7 +83160,6 @@ interface BannerClickEventUIParam { } interface IgVideoPlayer { - /** * Gets/Sets a list of video sources to choose from. Best coded/format is automatically detected by the control. Supported types are depending on the browser and could be one of the following mov, mp4, webm, ogg. * @@ -83855,7 +83288,7 @@ interface IgVideoPlayer { /** * Occurs when video has ended. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.duration to get the video duration in seconds. @@ -83864,7 +83297,7 @@ interface IgVideoPlayer { /** * Occurs when video gets playing. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.duration to get the video duration in seconds. @@ -83873,7 +83306,7 @@ interface IgVideoPlayer { /** * Occurs when video is paused. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.duration to get the video duration in seconds. @@ -83882,7 +83315,7 @@ interface IgVideoPlayer { /** * Occurs when a chunk of data is buffered. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.buffered to get buffered percentage. @@ -83891,7 +83324,7 @@ interface IgVideoPlayer { /** * Occurs when video has advanced the playback position. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.currentTime to get current position in the video at which the event was fired. @@ -83901,7 +83334,7 @@ interface IgVideoPlayer { /** * Occurs when igVideoPlayer is waiting for data from the server. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.currentTime to get current position in the video at which the event was fired. @@ -83911,7 +83344,7 @@ interface IgVideoPlayer { /** * Occurs when the bookmark is hit. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.bookmark to get the bookmark object from the bookmarks array. @@ -83921,7 +83354,7 @@ interface IgVideoPlayer { /** * Occurs when the bookmark is clicked. - * + * * Function takes arguments evt and ui. * Use ui.bookmark to get the bookmark object from the bookmarks array. * Use ui.bookmarkElement to get the html element in the DOM. @@ -83930,7 +83363,7 @@ interface IgVideoPlayer { /** * Occurs when igVideoPlayer enters full screen mode. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. */ @@ -83938,7 +83371,7 @@ interface IgVideoPlayer { /** * Occurs when igVideoPlayer exits full screen mode. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. */ @@ -83946,7 +83379,7 @@ interface IgVideoPlayer { /** * Occurs when related video is clicked. - * + * * Function takes arguments evt and ui. * Use ui.relatedVideo to get the relatedVideo object from the relatedVideos array. * Use ui.relatedVideoElement to get the relatedVideo html element in the DOM. @@ -83955,7 +83388,7 @@ interface IgVideoPlayer { /** * Defines the name of the player banner visible event. Fired when the banner has been displayed. - * + * * Function takes arguments evt and ui. * Use ui.index to get the banner index in the banners array. * Use ui.banner to get the banner object from the banners array. @@ -83965,7 +83398,7 @@ interface IgVideoPlayer { /** * Occurs when the banner is hidden. - * + * * Function takes arguments evt and ui. * Use ui.index to get the banner index in the banners array. * Use ui.banner to get the banner object from the banners array. @@ -83975,7 +83408,7 @@ interface IgVideoPlayer { /** * Occurs when the banner is clicked. - * + * * Function takes arguments evt and ui. * Use ui.bannerElement to get the banner html element in the DOM. */ @@ -83992,7 +83425,6 @@ interface IgVideoPlayer { [optionName: string]: any; } interface IgVideoPlayerMethods { - /** * Returns the element on which the widget was instantiated */ @@ -84104,7 +83536,7 @@ interface IgVideoPlayerMethods { destroy(): void; } interface JQuery { - data(propertyName: "igVideoPlayer"):IgVideoPlayerMethods; + data(propertyName: "igVideoPlayer"): IgVideoPlayerMethods; } interface JQuery { @@ -84425,7 +83857,7 @@ interface JQuery { /** * Occurs when video has ended. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.duration to get the video duration in seconds. @@ -84434,7 +83866,7 @@ interface JQuery { /** * Occurs when video has ended. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.duration to get the video duration in seconds. @@ -84445,7 +83877,7 @@ interface JQuery { /** * Occurs when video gets playing. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.duration to get the video duration in seconds. @@ -84454,7 +83886,7 @@ interface JQuery { /** * Occurs when video gets playing. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.duration to get the video duration in seconds. @@ -84465,7 +83897,7 @@ interface JQuery { /** * Occurs when video is paused. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.duration to get the video duration in seconds. @@ -84474,7 +83906,7 @@ interface JQuery { /** * Occurs when video is paused. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.duration to get the video duration in seconds. @@ -84485,7 +83917,7 @@ interface JQuery { /** * Occurs when a chunk of data is buffered. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.buffered to get buffered percentage. @@ -84494,7 +83926,7 @@ interface JQuery { /** * Occurs when a chunk of data is buffered. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.buffered to get buffered percentage. @@ -84505,7 +83937,7 @@ interface JQuery { /** * Occurs when video has advanced the playback position. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.currentTime to get current position in the video at which the event was fired. @@ -84515,7 +83947,7 @@ interface JQuery { /** * Occurs when video has advanced the playback position. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.currentTime to get current position in the video at which the event was fired. @@ -84527,7 +83959,7 @@ interface JQuery { /** * Occurs when igVideoPlayer is waiting for data from the server. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.currentTime to get current position in the video at which the event was fired. @@ -84537,7 +83969,7 @@ interface JQuery { /** * Occurs when igVideoPlayer is waiting for data from the server. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.currentTime to get current position in the video at which the event was fired. @@ -84549,7 +83981,7 @@ interface JQuery { /** * Occurs when the bookmark is hit. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.bookmark to get the bookmark object from the bookmarks array. @@ -84559,7 +83991,7 @@ interface JQuery { /** * Occurs when the bookmark is hit. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * Use ui.bookmark to get the bookmark object from the bookmarks array. @@ -84571,7 +84003,7 @@ interface JQuery { /** * Occurs when the bookmark is clicked. - * + * * Function takes arguments evt and ui. * Use ui.bookmark to get the bookmark object from the bookmarks array. * Use ui.bookmarkElement to get the html element in the DOM. @@ -84580,7 +84012,7 @@ interface JQuery { /** * Occurs when the bookmark is clicked. - * + * * Function takes arguments evt and ui. * Use ui.bookmark to get the bookmark object from the bookmarks array. * Use ui.bookmarkElement to get the html element in the DOM. @@ -84591,7 +84023,7 @@ interface JQuery { /** * Occurs when igVideoPlayer enters full screen mode. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. */ @@ -84599,7 +84031,7 @@ interface JQuery { /** * Occurs when igVideoPlayer enters full screen mode. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * @@ -84609,7 +84041,7 @@ interface JQuery { /** * Occurs when igVideoPlayer exits full screen mode. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. */ @@ -84617,7 +84049,7 @@ interface JQuery { /** * Occurs when igVideoPlayer exits full screen mode. - * + * * Function takes arguments evt and ui. * Use ui.source to get the url of the playing video. * @@ -84627,7 +84059,7 @@ interface JQuery { /** * Occurs when related video is clicked. - * + * * Function takes arguments evt and ui. * Use ui.relatedVideo to get the relatedVideo object from the relatedVideos array. * Use ui.relatedVideoElement to get the relatedVideo html element in the DOM. @@ -84636,7 +84068,7 @@ interface JQuery { /** * Occurs when related video is clicked. - * + * * Function takes arguments evt and ui. * Use ui.relatedVideo to get the relatedVideo object from the relatedVideos array. * Use ui.relatedVideoElement to get the relatedVideo html element in the DOM. @@ -84647,7 +84079,7 @@ interface JQuery { /** * Defines the name of the player banner visible event. Fired when the banner has been displayed. - * + * * Function takes arguments evt and ui. * Use ui.index to get the banner index in the banners array. * Use ui.banner to get the banner object from the banners array. @@ -84657,7 +84089,7 @@ interface JQuery { /** * Defines the name of the player banner visible event. Fired when the banner has been displayed. - * + * * Function takes arguments evt and ui. * Use ui.index to get the banner index in the banners array. * Use ui.banner to get the banner object from the banners array. @@ -84669,7 +84101,7 @@ interface JQuery { /** * Occurs when the banner is hidden. - * + * * Function takes arguments evt and ui. * Use ui.index to get the banner index in the banners array. * Use ui.banner to get the banner object from the banners array. @@ -84679,7 +84111,7 @@ interface JQuery { /** * Occurs when the banner is hidden. - * + * * Function takes arguments evt and ui. * Use ui.index to get the banner index in the banners array. * Use ui.banner to get the banner object from the banners array. @@ -84691,7 +84123,7 @@ interface JQuery { /** * Occurs when the banner is clicked. - * + * * Function takes arguments evt and ui. * Use ui.bannerElement to get the banner html element in the DOM. */ @@ -84699,7 +84131,7 @@ interface JQuery { /** * Occurs when the banner is clicked. - * + * * Function takes arguments evt and ui. * Use ui.bannerElement to get the banner html element in the DOM. * @@ -84725,7 +84157,6 @@ interface JQuery { igVideoPlayer(methodName: string, ...methodParams: any[]): any; } interface IgZoombarDefaultZoomWindow { - /** * The left component of the zoom window in percentages. * @@ -84749,7 +84180,6 @@ interface ZoomChangingEvent { } interface ZoomChangingEventUIParam { - /** * Used to get reference to igZoombar. */ @@ -84761,7 +84191,6 @@ interface ZoomChangedEvent { } interface ZoomChangedEventUIParam { - /** * Used to get reference to igZoombar. */ @@ -84773,7 +84202,6 @@ interface ProviderCreatedEvent { } interface ProviderCreatedEventUIParam { - /** * Used to get the reference the created provider */ @@ -84790,7 +84218,6 @@ interface WindowDragStartingEvent { } interface WindowDragStartingEventUIParam { - /** * Used to get reference to igZoombar. */ @@ -84802,7 +84229,6 @@ interface WindowDragStartedEvent { } interface WindowDragStartedEventUIParam { - /** * Used to get reference to igZoombar. */ @@ -84814,7 +84240,6 @@ interface WindowDraggingEvent { } interface WindowDraggingEventUIParam { - /** * Used to get reference to igZoombar. */ @@ -84826,7 +84251,6 @@ interface WindowDragEndingEvent { } interface WindowDragEndingEventUIParam { - /** * Used to get reference to igZoombar. */ @@ -84838,7 +84262,6 @@ interface WindowDragEndedEvent { } interface WindowDragEndedEventUIParam { - /** * Used to get reference to igZoombar. */ @@ -84850,7 +84273,6 @@ interface WindowResizingEvent { } interface WindowResizingEventUIParam { - /** * Used to get reference to igZoombar. */ @@ -84858,7 +84280,6 @@ interface WindowResizingEventUIParam { } interface IgZoombar { - /** * Specifies a provider class which interfaces the widget that is being zoomed. * object Provider class to use. The provider should implement all methods in the $.ig.ZoombarProviderDefault class and is suggested to be extended from it. @@ -85048,7 +84469,6 @@ interface IgZoombar { [optionName: string]: any; } interface IgZoombarMethods { - /** * Destroys the Zoombar widget */ @@ -85083,11 +84503,10 @@ interface IgZoombarMethods { zoom(left?: number, width?: number): Object; } interface JQuery { - data(propertyName: "igZoombar"):IgZoombarMethods; + data(propertyName: "igZoombar"): IgZoombarMethods; } interface ZoombarProviderDefaultSettings { - /** * Contains the target component's instance */ @@ -85113,99 +84532,99 @@ interface ZoombarProviderDefaultSettings { [optionName: string]: any; } -declare module Infragistics { -export class ZoombarProviderDefault { - constructor(settings: ZoombarProviderDefaultSettings); +declare namespace Infragistics { + class ZoombarProviderDefault { + constructor(settings: ZoombarProviderDefaultSettings); - /** - * Will be called before the provider instance is deleted (to unbind jQuery events, etc.) - */ - clean(): void; + /** + * Will be called before the provider instance is deleted (to unbind jQuery events, etc.) + */ + clean(): void; - /** - * Gets basic options for initializing the clone, based on the options the target is initialized with - * - * @param options if the Zoombar has a copy of the options object it'll pass it to the provider - */ - getBaseOpts(options: Object): void; + /** + * Gets basic options for initializing the clone, based on the options the target is initialized with + * + * @param options if the Zoombar has a copy of the options object it'll pass it to the provider + */ + getBaseOpts(options: Object): void; - /** - * Alters specific options so that the the clone is more suitable for its purpose - * - * @param options the base options of the widget obtained from getBaseOpts - */ - cleanOptsForZoom(options: Object): void; + /** + * Alters specific options so that the the clone is more suitable for its purpose + * + * @param options the base options of the widget obtained from getBaseOpts + */ + cleanOptsForZoom(options: Object): void; - /** - * Will be called by the Zoombar if a clone of the target widget should be created - * - * @param container a jQuery wrapped element to create the clone component in - * @param options the options that are obtained from cleanOptsForZoom - */ - createClone(container: Object, options: Object): void; + /** + * Will be called by the Zoombar if a clone of the target widget should be created + * + * @param container a jQuery wrapped element to create the clone component in + * @param options the options that are obtained from cleanOptsForZoom + */ + createClone(container: Object, options: Object): void; - /** - * Returns the provider"s widget name - */ - widgetName(): void; + /** + * Returns the provider"s widget name + */ + widgetName(): void; - /** - * Returns the target widget width property - */ - targetWidth(): void; + /** + * Returns the target widget width property + */ + targetWidth(): void; - /** - * Sets the target widget min window width (to be in sync with the same property of the zoombar) - * - * @param minWidth a number from 0 to 1 representing the minimal width (i.e. maximal zoom) the zoom window can take as a fraction of the total one - */ - syncMinWidth(minWidth: number): void; + /** + * Sets the target widget min window width (to be in sync with the same property of the zoombar) + * + * @param minWidth a number from 0 to 1 representing the minimal width (i.e. maximal zoom) the zoom window can take as a fraction of the total one + */ + syncMinWidth(minWidth: number): void; - /** - * Sets the width and height of the clone component - * - * @param width The width to set in pixels or string (px or % -affixed). - * @param height The height to set in pixels or string (px or % -affixed). - */ - setSize(width: Object, height: Object): void; + /** + * Sets the width and height of the clone component + * + * @param width The width to set in pixels or string (px or % -affixed). + * @param height The height to set in pixels or string (px or % -affixed). + */ + setSize(width: Object, height: Object): void; - /** - * Gets/sets the target object - * - * @param obj the new target component instance to set - */ - targetObject(obj?: Object): void; + /** + * Gets/sets the target object + * + * @param obj the new target component instance to set + */ + targetObject(obj?: Object): void; - /** - * Jshint ignore:line - * - * @param a - * @param b - */ - update(a: Object, b: Object): void; -} + /** + * Jshint ignore:line + * + * @param a + * @param b + */ + update(a: Object, b: Object): void; + } } interface IgniteUIStatic { -ZoombarProviderDefault: typeof Infragistics.ZoombarProviderDefault; + ZoombarProviderDefault: typeof Infragistics.ZoombarProviderDefault; } -declare module Infragistics { -export class ZoombarProviderDataChart { - constructor(settings: ZoombarProviderDefaultSettings); - clean(): void; - getBaseOpts(options: Object): void; - cleanOptsForZoom(options: Object): void; - createClone(container: Object, options: Object): void; - widgetName(): void; - targetWidth(): void; - targetObject(obj: Object): void; - syncMinWidth(minWidth: Object): void; - setSize(width: Object, height: Object): void; - update(a: Object, b: Object): void; -} +declare namespace Infragistics { + class ZoombarProviderDataChart { + constructor(settings: ZoombarProviderDefaultSettings); + clean(): void; + getBaseOpts(options: Object): void; + cleanOptsForZoom(options: Object): void; + createClone(container: Object, options: Object): void; + widgetName(): void; + targetWidth(): void; + targetObject(obj: Object): void; + syncMinWidth(minWidth: Object): void; + setSize(width: Object, height: Object): void; + update(a: Object, b: Object): void; + } } interface IgniteUIStatic { -ZoombarProviderDataChart: typeof Infragistics.ZoombarProviderDataChart; + ZoombarProviderDataChart: typeof Infragistics.ZoombarProviderDataChart; } interface JQuery { diff --git a/types/ignite-ui/tslint.json b/types/ignite-ui/tslint.json index c1f39f62eb..a04d4ac95d 100644 --- a/types/ignite-ui/tslint.json +++ b/types/ignite-ui/tslint.json @@ -1,8 +1,11 @@ { "extends": "../tslint.json", "rules": { + "array-type": false, "dt-header": false, "ban-types": false, + "callable-types": false, + "no-empty-interface": false, "unified-signatures": false, "max-line-length": false, "whitespace": false From 318b10fd01c9c7bc90f4b7f19ff6275696000c3a Mon Sep 17 00:00:00 2001 From: Andy Date: Wed, 29 Mar 2017 16:02:51 -0700 Subject: [PATCH 063/844] jquery.validation: Apply new lint rules (#15497) --- types/jquery.validation/index.d.ts | 90 +++++++++---------- .../jquery.validation-tests.ts | 42 ++++----- 2 files changed, 62 insertions(+), 70 deletions(-) diff --git a/types/jquery.validation/index.d.ts b/types/jquery.validation/index.d.ts index bbe55f2c93..9b77a80e23 100644 --- a/types/jquery.validation/index.d.ts +++ b/types/jquery.validation/index.d.ts @@ -5,18 +5,16 @@ /// -declare namespace JQueryValidation -{ - type RulesDictionary = { [name: string]: any }; +declare namespace JQueryValidation { + interface RulesDictionary { [name: string]: any; } type ValidatePredicate = ((element: HTMLElement, event: JQueryEventObject) => void); type ShouldValidatePredicate = boolean|ValidatePredicate; - interface ValidationOptions - { + interface ValidationOptions { /** - * Enables debug mode. If true, the form is not submitted and certain errors are displayed on the console + * Enables debug mode. If true, the form is not submitted and certain errors are displayed on the console * (will check if a window.console property exists). Try to enable when a form is just submitted instead of validation stopping the submit. * * default: false @@ -48,24 +46,24 @@ declare namespace JQueryValidation * * default: Places the error label after the invalid element */ - errorPlacement?: (error: JQuery, element: JQuery) => void; + errorPlacement?(error: JQuery, element: JQuery): void; /** - * If enabled, removes the errorClass from the invalid elements and hides all error messages whenever the element is focused. + * If enabled, removes the errorClass from the invalid elements and hides all error messages whenever the element is focused. * Avoid combination with focusInvalid. * * default: false */ focusCleanup?: boolean; /** - * Focus the last active or first invalid element on submit via validator.focusInvalid(). The last active element is the one - * that had focus when the form was submitted, avoiding stealing its focus. If there was no element focused, the first one + * Focus the last active or first invalid element on submit via validator.focusInvalid(). The last active element is the one + * that had focus when the form was submitted, avoiding stealing its focus. If there was no element focused, the first one * in the form gets it, unless this option is turned off. * * default: true */ focusInvalid?: boolean; /** - * Specify grouping of error messages. A group consists of an arbitrary group name as the key and a space separated list of + * Specify grouping of error messages. A group consists of an arbitrary group name as the key and a space separated list of * element names as the value. Use errorPlacement to control where the group message is placed. */ groups?: { [groupName: string]: string }; @@ -74,29 +72,29 @@ declare namespace JQueryValidation * * default: Adds errorClass (see the option) to the element */ - highlight?: (element: HTMLElement, errorClass: string, validClass: string) => void; + highlight?(element: HTMLElement, errorClass: string, validClass: string): void; /** - * Elements to ignore when validating, simply filtering them out. jQuery's not-method is used, therefore everything that is + * Elements to ignore when validating, simply filtering them out. jQuery's not-method is used, therefore everything that is * accepted by not() can be passed as this option. Inputs of type submit and reset are always ignored, so are disabled elements. */ ignore?: string; /** - * Set to skip reading messages from the title attribute, helps to avoid issues with Google Toolbar; default is false for compability, + * Set to skip reading messages from the title attribute, helps to avoid issues with Google Toolbar; default is false for compability, * the message-from-title is likely to be completely removed in a future release. * * default: false */ ignoreTitle?: boolean; /** - * Callback for custom code when an invalid form is submitted. Called with an event object as the first argument, and the validator + * Callback for custom code when an invalid form is submitted. Called with an event object as the first argument, and the validator * as the second. */ - invalidHandler?: (event: JQueryEventObject, validator: Validator) => void; + invalidHandler?(event: JQueryEventObject, validator: Validator): void; /** - * Key/value pairs defining custom messages. Key is the name of an element, value the message to display for that element. Instead - * of a plain message, another map with specific messages for each rule can be used. Overrides the title attribute of an element or - * the default message for the method (in that order). Each message can be a String or a Callback. The callback is called in the scope - * of the validator, with the rule's parameters as the first argument and the element as the second, and must return a String to display + * Key/value pairs defining custom messages. Key is the name of an element, value the message to display for that element. Instead + * of a plain message, another map with specific messages for each rule can be used. Overrides the title attribute of an element or + * the default message for the method (in that order). Each message can be a String or a Callback. The callback is called in the scope + * of the validator, with the rule's parameters as the first argument and the element as the second, and must return a String to display * as the message. * * default: the default message for the method used @@ -111,8 +109,8 @@ declare namespace JQueryValidation */ onclick?: ShouldValidatePredicate; /** - * Function. Validate elements when user focuses in. If omitted hides all other fields marked as invalid. - * + * Function. Validate elements when user focuses in. If omitted hides all other fields marked as invalid. + * * Set to a custom Function to decide for yourself when to run validation. */ onfocusin?: ValidatePredicate; @@ -124,7 +122,7 @@ declare namespace JQueryValidation */ onfocusout?: ShouldValidatePredicate; /** - * Boolean or Function. Validate elements on keyup. As long as the field is not marked as invalid, nothing happens. + * Boolean or Function. Validate elements on keyup. As long as the field is not marked as invalid, nothing happens. * Otherwise, all rules are checked on each key up event. Set to false to disable. * * Set to a Function to decide for yourself when to run validation. @@ -140,36 +138,36 @@ declare namespace JQueryValidation */ onsubmit?: boolean; /** - * A custom message display handler. Gets the map of errors as the first argument and an array of errors as the second, - * called in the context of the validator object. The arguments contain only those elements currently validated, - * which can be a single element when doing validation onblur/keyup. You can trigger (in addition to your own messages) + * A custom message display handler. Gets the map of errors as the first argument and an array of errors as the second, + * called in the context of the validator object. The arguments contain only those elements currently validated, + * which can be a single element when doing validation onblur/keyup. You can trigger (in addition to your own messages) * the default behaviour by calling this.defaultShowErrors(). */ rules?: RulesDictionary; /** - * A custom message display handler. Gets the map of errors as the first argument and an array of errors as the second, - * called in the context of the validator object. The arguments contain only those elements currently validated, which can - * be a single element when doing validation onblur/keyup. You can trigger (in addition to your own messages) the default + * A custom message display handler. Gets the map of errors as the first argument and an array of errors as the second, + * called in the context of the validator object. The arguments contain only those elements currently validated, which can + * be a single element when doing validation onblur/keyup. You can trigger (in addition to your own messages) the default * behaviour by calling this.defaultShowErrors(). */ - showErrors?: (errorMap: ErrorDictionary, errorList: ErrorListItem[]) => void; + showErrors?(errorMap: ErrorDictionary, errorList: ErrorListItem[]): void; /** - * Callback for handling the actual submit when the form is valid. Gets the form and the event object. Replaces the default submit. + * Callback for handling the actual submit when the form is valid. Gets the form and the event object. Replaces the default submit. * The right place to submit a form via Ajax after it is validated. */ - submitHandler?: (form: HTMLFormElement, event?: JQueryEventObject) => void; + submitHandler?(form: HTMLFormElement, event?: JQueryEventObject): void; /** - * String or Function. If specified, the error label is displayed to show a valid element. If a String is given, it is added as - * a class to the label. If a Function is given, it is called with the label (as a jQuery object) and the validated input (as a DOM element). + * String or Function. If specified, the error label is displayed to show a valid element. If a String is given, it is added as + * a class to the label. If a Function is given, it is called with the label (as a jQuery object) and the validated input (as a DOM element). * The label can be used to add a text like "ok!". */ - success?: string|{($label: JQuery, validatedInput: HTMLElement): void}; + success?: string | (($label: JQuery, validatedInput: HTMLElement) => void); /** * Called to revert changes made by option highlight, same arguments as highlight. * * default: Removes the errorClass */ - unhighlight?: (element: HTMLElement, errorClass: string, validClass: string) => void; + unhighlight?(element: HTMLElement, errorClass: string, validClass: string): void; /** * This class is added to an element after it was validated and considered valid. * @@ -184,19 +182,16 @@ declare namespace JQueryValidation wrapper?: string; } - interface ErrorDictionary - { + interface ErrorDictionary { [name: string]: string; } - interface ErrorListItem - { + interface ErrorListItem { message: string; element: HTMLElement; } - interface ValidatorStatic - { + interface ValidatorStatic { /** * Add a compound class method - useful to refactor common combinations of rules into a single class. * @@ -236,8 +231,7 @@ declare namespace JQueryValidation methods: { [index: string]: Function }; } - interface Validator - { + interface Validator { element(element: string|JQuery): boolean; checkForm(): boolean; /** @@ -277,8 +271,7 @@ declare namespace JQueryValidation } } -interface JQuery -{ +interface JQuery { /** * Remove the specified attributes from the first matched element and return them. * @@ -288,7 +281,7 @@ interface JQuery // tslint:disable:unified-signatures /** * Adds the specified rules and returns all rules for the first matched element. Requires that the parent form is validated, that is, $( "form" ).validate() is called first. - * + * * @param command "remove" or "add" * @param rules The rules to add. Accepts the same format as the rules-option of the validate-method. */ @@ -317,8 +310,7 @@ interface JQuery validate(options?: JQueryValidation.ValidationOptions): JQueryValidation.Validator; } -interface JQueryStatic -{ +interface JQueryStatic { /** * Replaces {n} placeholders with arguments. * diff --git a/types/jquery.validation/jquery.validation-tests.ts b/types/jquery.validation/jquery.validation-tests.ts index 8d73db97d5..08bc439973 100644 --- a/types/jquery.validation/jquery.validation-tests.ts +++ b/types/jquery.validation/jquery.validation-tests.ts @@ -12,9 +12,9 @@ function test_validate() { }); $(".selector").validate({ invalidHandler: (form, validator) => { - var errors = validator.numberOfInvalids(); + const errors = validator.numberOfInvalids(); if (errors) { - var message = errors == 1 + const message = errors === 1 ? 'You missed 1 field. It has been highlighted' : 'You missed ' + errors + ' fields. They have been highlighted'; $("div.error span").html(message); @@ -55,8 +55,8 @@ function test_validate() { username: "fname lname" }, errorPlacement: (error, element) => { - if (element.attr("name") == "fname" - || element.attr("name") == "lname") + if (element.attr("name") === "fname" + || element.attr("name") === "lname") error.insertAfter("#lastname"); else error.insertAfter(element); @@ -97,7 +97,7 @@ function test_validate() { }); $("#myform").validate({ meta: "validate", - submitHandler: () => { alert("Submitted!") } + submitHandler: () => { alert("Submitted!"); } }); $(".selector").validate({ errorClass: "invalid" @@ -114,13 +114,13 @@ function test_validate() { $("#myform").validate({ errorLabelContainer: "#messageBox", wrapper: "li", - submitHandler: () => { alert("Submitted!") } + submitHandler: () => { alert("Submitted!"); } }); $("#myform").validate({ errorContainer: "#messageBox1, #messageBox2", errorLabelContainer: "#messageBox1 ul", wrapper: "li", debug: true, - submitHandler: () => { alert("Submitted!") } + submitHandler: () => { alert("Submitted!"); } }); $(".selector").validate({ showErrors: (errorMap: JQueryValidation.ErrorDictionary, errorList: JQueryValidation.ErrorListItem[]) => { @@ -136,13 +136,13 @@ function test_validate() { }); $("#myform").validate({ success: "valid", - submitHandler: () => { alert("Submitted!") } + submitHandler: () => { alert("Submitted!"); } }); $("#myform").validate({ success: (label) => { - label.addClass("valid").text("Ok!") + label.addClass("valid").text("Ok!"); }, - submitHandler: () => { alert("Submitted!") } + submitHandler: () => { alert("Submitted!"); } }); $(".selector").validate({ highlight: (element, errorClass) => { @@ -176,7 +176,7 @@ function test_validate() { $('.selector').validate({ onfocusout: () => {}, onkeyup: () => {}, - onclick: (elt) => { return 2; } + onclick: elt => 2, }); } @@ -205,7 +205,7 @@ function test_methods() { } }); $("#skip").click(() => { - var rules = $("#myinput").removeAttrs("min max"); + const rules = $("#myinput").removeAttrs("min max"); $("#myform").submit(); $("#myinput").attr(rules); }); @@ -213,25 +213,25 @@ function test_methods() { $("#myform").validate().form(); $("#myform").validate().element("#myselect"); $("#myform").validate().element($("#myselect")); - var validator = $("#myform").validate(); + const validator = $("#myform").validate(); validator.resetForm(); - validator.showErrors({ "firstname": "I know that your firstname is Pete, Pete!" }); + validator.showErrors({ firstname: "I know that your firstname is Pete, Pete!" }); validator.hideErrors(); - var isValid: boolean = validator.valid(); - var size: number = validator.size(); - var errorMap: JQueryValidation.ErrorDictionary = validator.errorMap; - var errorList: JQueryValidation.ErrorListItem[] = validator.errorList; + const isValid: boolean = validator.valid(); + const size: number = validator.size(); + const errorMap: JQueryValidation.ErrorDictionary = validator.errorMap; + const errorList: JQueryValidation.ErrorListItem[] = validator.errorList; $("#summary").text(validator.numberOfInvalids() + " field(s) are invalid"); - var invalidElements: HTMLElement[] = validator.invalidElements(); - var validElements: HTMLElement[] = validator.validElements(); + const invalidElements: HTMLElement[] = validator.invalidElements(); + const validElements: HTMLElement[] = validator.validElements(); } function test_static_methods() { jQuery.validator.setDefaults({ debug: true }); - jQuery.validator.addMethod("domain", function (value, element) { + jQuery.validator.addMethod("domain", function(value, element) { return this.optional(element) || /^http:\/\/mycorporatedomain.com/.test(value); }, "Please specify the correct domain for your documents"); jQuery.validator.addClassRules({ From 515be0adcf132dbd2d3dfd83f27a795a6d6c4b7a Mon Sep 17 00:00:00 2001 From: Andy Date: Wed, 29 Mar 2017 16:11:11 -0700 Subject: [PATCH 064/844] hyco-ws: Apply new lint rules (#15501) --- types/hyco-ws/hyco-ws-tests.ts | 2 +- types/hyco-ws/index.d.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/types/hyco-ws/hyco-ws-tests.ts b/types/hyco-ws/hyco-ws-tests.ts index 05b500d81c..e08890b3b1 100644 --- a/types/hyco-ws/hyco-ws-tests.ts +++ b/types/hyco-ws/hyco-ws-tests.ts @@ -18,4 +18,4 @@ const wss = AzureRelay.createRelayedServer( wss.on('error', (err: any) => { console.log('error' + err); -}); \ No newline at end of file +}); diff --git a/types/hyco-ws/index.d.ts b/types/hyco-ws/index.d.ts index 053c7fba18..68d0575fb5 100644 --- a/types/hyco-ws/index.d.ts +++ b/types/hyco-ws/index.d.ts @@ -24,4 +24,4 @@ export function createRelayToken(uri: string, key_name: string, key: string, exp export function appendRelayToken(uri: string, key_name: string, key: string, expiry?: number): string; export function createRelayBaseUri(serviceBusNamespace: string, path: string): string; export function createRelaySendUri(serviceBusNamespace: string, path: string, token?: any, id?: any): string; -export function createRelayListenUri(serviceBusNamespace: string, path: string, token?: any, id?: any): string; \ No newline at end of file +export function createRelayListenUri(serviceBusNamespace: string, path: string, token?: any, id?: any): string; From eeb0f2e7eb5b4215e6be4397211e62d1e2435020 Mon Sep 17 00:00:00 2001 From: Andy Date: Wed, 29 Mar 2017 16:16:52 -0700 Subject: [PATCH 065/844] highcharts: Apply new lint rules (#15502) --- types/highcharts/highcharts-more.d.ts | 2 +- types/highcharts/highstock.d.ts | 2 +- types/highcharts/index.d.ts | 100 +++++++++--------- types/highcharts/modules/boost.d.ts | 2 +- types/highcharts/modules/exporting.d.ts | 2 +- .../modules/no-data-to-display.d.ts | 2 +- .../highcharts/modules/offline-exporting.d.ts | 2 +- 7 files changed, 56 insertions(+), 56 deletions(-) diff --git a/types/highcharts/highcharts-more.d.ts b/types/highcharts/highcharts-more.d.ts index 14f4940784..6bd8693409 100644 --- a/types/highcharts/highcharts-more.d.ts +++ b/types/highcharts/highcharts-more.d.ts @@ -5,6 +5,6 @@ import * as Highcharts from "highcharts"; -declare var HighchartsMore: (H: Highcharts.Static) => Highcharts.Static; +declare function HighchartsMore(H: Highcharts.Static): Highcharts.Static; export = HighchartsMore; export as namespace HighchartsMore; diff --git a/types/highcharts/highstock.d.ts b/types/highcharts/highstock.d.ts index 35c1179ff1..f67a83ba37 100644 --- a/types/highcharts/highstock.d.ts +++ b/types/highcharts/highstock.d.ts @@ -46,7 +46,7 @@ declare namespace Highstock { inputBoxHeight?: number; inputBoxWidth?: number; inputDateFormat?: string; - inputDateParser?: (date: string) => number; + inputDateParser?(date: string): number; inputEditDateFormat?: string; inputEnabled?: boolean; inputPosition?: { diff --git a/types/highcharts/index.d.ts b/types/highcharts/index.d.ts index 9fe60ef542..952de318b0 100644 --- a/types/highcharts/index.d.ts +++ b/types/highcharts/index.d.ts @@ -96,7 +96,7 @@ declare namespace Highcharts { * this are axis, chart, isFirst and isLast. * @default function() {return this.value;} */ - formatter?: () => string; + formatter?(): string; /** * Horizontal axis only. When staggerLines is not set, maxStaggerLines defines how many lines the axis is allowed to * add to automatically avoid overlapping X labels. Set to 1 to disable overlap detection. @@ -173,10 +173,10 @@ declare namespace Highcharts { } interface MousePlotEvents { - click?: (event: Event) => void; - mouseover?: (event: Event) => void; - mouseout?: (event: Event) => void; - mousemove?: (event: Event) => void; + click?(event: Event): void; + mouseover?(event: Event): void; + mouseout?(event: Event): void; + mousemove?(event: Event): void; } /** @@ -491,19 +491,19 @@ declare namespace Highcharts { * An event fired after the breaks have rendered. * @since 4.1.0 */ - afterBreaks?: (event: Event) => void; + afterBreaks?(event: Event): void; /** * As opposed to the setExtremes event, this event fires after the final min and max values are computed and * corrected for minRange. * The this keyword refers to the {@link AxisObject|Axis} object. * @since 2.3 */ - afterSetExtremes?: (event: AxisEvent) => void; + afterSetExtremes?(event: AxisEvent): void; /** * An event fired when a break from this axis occurs on a point. * The this keyword refers to the {@link AxisObject|Axis} object. */ - pointBreak?: (event: Event) => void; + pointBreak?(event: Event): void; /** * Fires when the minimum and maximum is set for the axis, either by calling the .setExtremes() method or by * selecting an area in the chart. One parameter, event, is passed to the function. This contains common event @@ -516,7 +516,7 @@ declare namespace Highcharts { * The this keyword refers to the {@link AxisObject|Axis} object. * @since 1.2.0 */ - setExtremes?: (event: AxisEvent) => void; + setExtremes?(event: AxisEvent): void; }; /** * The lowest allowed value for automatically computed axis extremes. @@ -868,7 +868,7 @@ declare namespace Highcharts { * behaviour of tickPixelInterval and tickInterval. The automatic tick positions are accessible through * this.tickPositions and can be modified by the callback. */ - tickPositioner?: (min: number, max: number) => void; + tickPositioner?(min: number, max: number): void; /** * An array defining where the ticks are laid out on the axis. This overrides the default behaviour of * tickPixelInterval and tickInterval. @@ -958,7 +958,7 @@ declare namespace Highcharts { * corrected for minRange. * The this keyword refers to the {@link AxisObject|Axis} object. */ - afterSetExtremes?: (event: AxisEvent) => void; + afterSetExtremes?(event: AxisEvent): void; /** * Fires when the minimum and maximum is set for the axis, either by calling the .setExtremes() method or by * selecting an area in the chart. One parameter, event, is passed to the function. This contains common event @@ -970,7 +970,7 @@ declare namespace Highcharts { * * The this keyword refers to the {@link AxisObject|Axis} object. */ - setExtremes?: (event: AxisEvent) => void; + setExtremes?(event: AxisEvent): void; }; /** * Color of the grid lines extending from the axis across the gradient. @@ -1163,7 +1163,7 @@ declare namespace Highcharts { * A callback function returning array defining where the ticks are laid out on the axis. This overrides the default * behaviour of tickPixelInterval and tickInterval. */ - tickPositioner?: (min: number, max: number) => void; + tickPositioner?(min: number, max: number): void; /** * An array defining where the ticks are laid out on the axis. This overrides the default behaviour of * tickPixelInterval and tickInterval. @@ -1281,19 +1281,19 @@ declare namespace Highcharts { * The this keyword refers to the Chart object. * @since 1.2.0 */ - addSeries?: (event: AddSeriesEvent) => boolean | void; + addSeries?(event: AddSeriesEvent): boolean | void; /** * Fires after a chart is printed through the context menu item or the Chart.print method. Requires the exporting * module. * @since 4.1.0 */ - afterPrint?: (event: Event) => void; + afterPrint?(event: Event): void; /** * Fires before a chart is printed through the context menu item or the Chart.print method. Requires the exporting * module. * @since 4.1.0 */ - beforePrint?: (event: Event) => void; + beforePrint?(event: Event): void; /** * Fires when clicking on the plot background. One parameter, event, is passed to the function. This contains common * event information based on jQuery or MooTools depending on which library is used as the base for Highcharts. @@ -1309,17 +1309,17 @@ declare namespace Highcharts { * The this keyword refers to the Chart object. * @since 1.2.0 */ - click?: (event: ChartClickEvent) => void; + click?(event: ChartClickEvent): void; /** * Fires when a drilldown point is clicked, before the new series is added. * @since 3.0.8 */ - drilldown?: (event: ChartDrilldownEvent) => void; + drilldown?(event: ChartDrilldownEvent): void; /** * Fires when drilling up from a drilldown series. * @since 3.0.8 */ - drillup?: (event: Event) => void; + drillup?(event: Event): void; /** * Fires when the chart is finished loading. One parameter, event, is passed to the function. This contains common * event information based on jQuery or MooTools depending on which library is used as the base for Highcharts. @@ -1329,7 +1329,7 @@ declare namespace Highcharts { * * The this keyword refers to the Chart object. */ - load?: (event: Event) => void; + load?(event: Event): void; /** * Fires when the chart is redrawn, either after a call to chart.redraw() or after an axis, series or point is * modified with the redraw option set to true. One parameter, event, is passed to the function. This contains @@ -1339,7 +1339,7 @@ declare namespace Highcharts { * The this keyword refers to the Chart object. * @since 1.2.0 */ - redraw?: (event: Event) => void; + redraw?(event: Event): void; /** * Fires when an area of the chart has been selected. Selection is enabled by setting the chart's zoomType. One * parameter, event, is passed to the function. This contains common event information based on jQuery or MooTools @@ -1360,7 +1360,7 @@ declare namespace Highcharts { * console.log(event.yAxis[0].min, event.yAxis[0].max); * } */ - selection?: (event: ChartSelectionEvent) => void; + selection?(event: ChartSelectionEvent): void; } interface LinearGradient { @@ -1886,7 +1886,7 @@ declare namespace Highcharts { * extended with additional options and passed directly to the chart constructor. * @since 4.0 */ - complete?: (options: Options) => void; + complete?(options: Options): void; /** * A comma delimited string to be parsed. Related options are startRow, endRow, startColumn and endColumn to delimit * what part of the table is used. The lineDelimiter and itemDelimiter options define the CSV delimiter formats. @@ -1955,14 +1955,14 @@ declare namespace Highcharts { * timestamp on success. * @since 4.0 */ - parseDate?: (val: any) => number; + parseDate?(val: any): number; /** * A callback function to access the parsed columns, the two-dimentional input data array directly, before they are * interpreted into series data and categories. Return false to stop completion, or call this.complete() to continue * async. * @since 4.0 */ - parsed?: (columns: [string | number][]) => boolean | void; + parsed?(columns: [string | number][]): boolean | void; /** * The same as the columns input option, but defining rows intead of columns. * @since 4.0 @@ -2080,7 +2080,7 @@ declare namespace Highcharts { /** * Callback function to run on click. */ - onclick: () => void; + onclick(): void; } interface Button { @@ -2184,7 +2184,7 @@ declare namespace Highcharts { * A click handler callback to use on the button directly instead of the popup menu. * @since 2.0 */ - onclick?: () => void; + onclick?(): void; /** * The symbol for the button. Points to a definition function in the Highcharts.Renderer.symbols collection. The * default exportIcon function is part of the exporting module. @@ -2345,7 +2345,7 @@ declare namespace Highcharts { * charts in specific time zones using their local DST crossover dates, with the help of external libraries. * @since 4.1.0 */ - getTimezoneOffset?: (timestamp: number) => number; + getTimezoneOffset?(timestamp: number): number; /** * The timezone offset in minutes. Positive values are west, negative values are east of UTC, as in the ECMAScript * getTimezoneOffset method. Use this to display UTC based data in a predefined time zone. @@ -2624,7 +2624,7 @@ declare namespace Highcharts { * Callback function to format each of the series' labels. The this keyword refers to the series object, or the * point object in case of pie charts. By default the series or point name is printed. */ - labelFormatter?: () => string; + labelFormatter?(): string; /** * The layout of the legend items. Can be one of 'horizontal' or 'vertical'. * @default 'horizontal' @@ -2983,7 +2983,7 @@ declare namespace Highcharts { * - this.x: The x value. * - this.y: The y value. */ - formatter?: () => string; + formatter?(): string; /** * For points with an extent, like columns, whether to align the data label inside the box or to the actual value * point. Defaults to false in most cases, true in stacked columns. @@ -3126,7 +3126,7 @@ declare namespace Highcharts { * The this keyword refers to the Series object. * @since 4.0 */ - afterAnimate?: (event: Event) => void; + afterAnimate?(event: Event): void; /** * Fires when the checkbox next to the series' name in the legend is clicked. One parameter, event, is passed to the * function. The state of the checkbox is found by event.checked. The checked item is found by event.item. Return @@ -3135,7 +3135,7 @@ declare namespace Highcharts { * The this keyword refers to the Series object. * @since 1.2.0 */ - checkboxClick?: (event: AreaCheckboxEvent) => boolean | void; + checkboxClick?(event: AreaCheckboxEvent): boolean | void; /** * Fires when the series is clicked. One parameter, event, is passed to the function. This contains common event * information based on jQuery or MooTools depending on which library is used as the base for Highcharts. @@ -3143,14 +3143,14 @@ declare namespace Highcharts { * * The this keyword refers to the Series object. */ - click?: (event: AreaClickEvent) => void; + click?(event: AreaClickEvent): void; /** * Fires when the series is hidden after chart generation time, either by clicking the legend item or by calling * .hide(). * * The this keyword refers to the Series object. */ - hide?: () => void; + hide?(): void; /** * Fires when the legend item belonging to the series is clicked. One parameter, event, is passed to the function. * This contains common event information based on jQuery or MooTools depending on which library is used as the base @@ -3159,7 +3159,7 @@ declare namespace Highcharts { * * The this keyword refers to the Series object. */ - legendItemClick?: (event: Event) => boolean | void; + legendItemClick?(event: Event): boolean | void; /** * Fires when the mouse leaves the graph. One parameter, event, is passed to the function. This contains common * event information based on jQuery or MooTools depending on which library is used as the base for Highcharts. If @@ -3168,14 +3168,14 @@ declare namespace Highcharts { * * The this keyword refers to the Series object. */ - mouseOut?: (event: Event) => void; + mouseOut?(event: Event): void; /** * Fires when the mouse enters the graph. One parameter, event, is passed to the function. This contains common * event information based on jQuery or MooTools depending on which library is used as the base for Highcharts. * * The this keyword refers to the Series object. */ - mouseOver?: (event: Event) => void; + mouseOver?(event: Event): void; /** * Fires when the series is shown after chart generation time, either by clicking the legend item or by calling * .show(). @@ -3183,7 +3183,7 @@ declare namespace Highcharts { * The this keyword refers to the Series object. * @since 1.2.0 */ - show?: () => void; + show?(): void; } interface MarkerState { @@ -3273,7 +3273,7 @@ declare namespace Highcharts { * * The this keyword refers to the Point object. */ - click?: (event: Event) => boolean; + click?(event: Event): boolean; /** * Fires when the mouse leaves the area close to the point. One parameter, event, is passed to the function. This * contains common event information based on jQuery or MooTools depending on which library is used as the base for @@ -3281,7 +3281,7 @@ declare namespace Highcharts { * * The this keyword refers to the Point object. */ - mouseOut?: (event: Event) => void; + mouseOut?(event: Event): void; /** * Fires when the mouse enters the area close to the point. One parameter, event, is passed to the function. This * contains common event information based on jQuery or MooTools depending on which library is used as the base for @@ -3289,7 +3289,7 @@ declare namespace Highcharts { * * The this keyword refers to the Point object. */ - mouseOver?: (event: Event) => void; + mouseOver?(event: Event): void; /** * Fires when the point is removed using the .remove() method. One parameter, event, is passed to the function. * Returning false cancels the operation. @@ -3297,7 +3297,7 @@ declare namespace Highcharts { * The this keyword refers to the Point object. * @since 1.2.0 */ - remove?: (event: Event) => boolean | void; + remove?(event: Event): boolean | void; /** * Fires when the point is selected either programmatically or following a click on the point. One parameter, event, * is passed to the function. Returning false cancels the operation. @@ -3305,7 +3305,7 @@ declare namespace Highcharts { * The this keyword refers to the Point object. * @since 1.2.0 */ - select?: (event: Event) => boolean | void; + select?(event: Event): boolean | void; /** * Fires when the point is unselected either programmatically or following a click on the point. One parameter, * event, is passed to the function. Returning false cancels the operation. @@ -3313,7 +3313,7 @@ declare namespace Highcharts { * The this keyword refers to the Point object. * @since 1.2.0 */ - unselect?: (event: Event) => boolean | void; + unselect?(event: Event): boolean | void; /** * Fires when the point is updated programmatically through the .update() method. One parameter, event, is passed to * the function. The new point options can be accessed through event.options. Returning false cancels the operation. @@ -3321,14 +3321,14 @@ declare namespace Highcharts { * The this keyword refers to the Point object. * @since 1.2.0 */ - update?: (event: Event) => boolean | void; + update?(event: Event): boolean | void; /** * Fires when the legend item belonging to the pie point (slice) is clicked. * The this keyword refers to the point itself. One parameter, event, is passed to the function. * This contains common event information based on jQuery or MooTools depending on which library is used as the base for Highcharts. * The default action is to toggle the visibility of the point. This can be prevented by calling event.preventDefault(). */ - legendItemClick?: (event: Event) => boolean | void; + legendItemClick?(event: Event): boolean | void; } interface Halo { @@ -3516,7 +3516,7 @@ declare namespace Highcharts { * - this.x: The x value. * - this.y: The y value. */ - formatter?: () => string; + formatter?(): string; /** * For points with an extent, like columns, whether to align the data label inside the box or to the actual value * point. Defaults to false in most cases, true in stacked columns. @@ -5404,7 +5404,7 @@ declare namespace Highcharts { * this.y (not shared) / this.points[i].y (shared) * The y value. */ - formatter?: () => boolean | string; + formatter?(): boolean | string; /** * A callback function to place the tooltip in a default position. The callback receives three parameters: * labelWidth, labelHeight and point, where point contains values for plotX and plotY telling where the reference @@ -5413,7 +5413,7 @@ declare namespace Highcharts { * The return should be an object containing x and y values, for example { x: 100, y: 100 }. * @since 2.2.4 */ - positioner?: (labelWidth: number, labelHeight: number, point: PlotPoint) => { x: number; y: number; }; + positioner?(labelWidth: number, labelHeight: number, point: PlotPoint): { x: number; y: number; }; /** * Whether to apply a drop shadow to the tooltip. * @default true @@ -5516,7 +5516,7 @@ declare namespace Highcharts { * The this keyword refers to the Point object. * @since 4.1.0 */ - pointFormatter?: () => string; + pointFormatter?(): string; /** * How many decimals to show in each series' y value. This is overridable in each series' tooltip options object. * The default is to preserve all decimals. diff --git a/types/highcharts/modules/boost.d.ts b/types/highcharts/modules/boost.d.ts index 9b62dab1c7..1a297c7087 100644 --- a/types/highcharts/modules/boost.d.ts +++ b/types/highcharts/modules/boost.d.ts @@ -5,6 +5,6 @@ import { Static } from "highcharts"; -declare var HighchartsBoost: (H: Static) => Static; +declare function HighchartsBoost(H: Static): Static; export = HighchartsBoost; export as namespace HighchartsBoost; diff --git a/types/highcharts/modules/exporting.d.ts b/types/highcharts/modules/exporting.d.ts index 877ef3d0c1..8d808c1929 100644 --- a/types/highcharts/modules/exporting.d.ts +++ b/types/highcharts/modules/exporting.d.ts @@ -5,6 +5,6 @@ import { Static } from "highcharts"; -declare var HighchartsExporting: (H: Static) => Static; +declare function HighchartsExporting(H: Static): Static; export = HighchartsExporting; export as namespace HighchartsExporting; diff --git a/types/highcharts/modules/no-data-to-display.d.ts b/types/highcharts/modules/no-data-to-display.d.ts index 750f8de607..f807860838 100644 --- a/types/highcharts/modules/no-data-to-display.d.ts +++ b/types/highcharts/modules/no-data-to-display.d.ts @@ -29,6 +29,6 @@ declare module "highcharts" { } } -declare var HighchartsNoDataToDisplay: (H: Static) => Static; +declare function HighchartsNoDataToDisplay(H: Static): Static; export = HighchartsNoDataToDisplay; export as namespace HighchartsNoDataToDisplay; diff --git a/types/highcharts/modules/offline-exporting.d.ts b/types/highcharts/modules/offline-exporting.d.ts index 94ecf53485..5b58f65c46 100644 --- a/types/highcharts/modules/offline-exporting.d.ts +++ b/types/highcharts/modules/offline-exporting.d.ts @@ -5,6 +5,6 @@ import { Static } from "highcharts"; -declare var HighchartsOfflineExporting: (H: Static) => Static; +declare function HighchartsOfflineExporting(H: Static): Static; export = HighchartsOfflineExporting; export as namespace HighchartsOfflineExporting; From 0dcb154bc07d9d49368e8eb9fa8fff433e0c3ae5 Mon Sep 17 00:00:00 2001 From: Andy Date: Wed, 29 Mar 2017 16:17:11 -0700 Subject: [PATCH 066/844] selenium-webdriver: Apply new lint rules (#15500) --- types/selenium-webdriver/chrome.d.ts | 21 -- types/selenium-webdriver/edge.d.ts | 1 - types/selenium-webdriver/firefox.d.ts | 16 -- types/selenium-webdriver/http.d.ts | 1 - types/selenium-webdriver/index.d.ts | 104 +++----- types/selenium-webdriver/remote.d.ts | 7 +- types/selenium-webdriver/test/chrome.ts | 16 +- types/selenium-webdriver/test/firefox.ts | 29 ++- types/selenium-webdriver/test/index.ts | 291 +++++++++++------------ 9 files changed, 200 insertions(+), 286 deletions(-) diff --git a/types/selenium-webdriver/chrome.d.ts b/types/selenium-webdriver/chrome.d.ts index 2604b99e89..6bd2fe22a8 100644 --- a/types/selenium-webdriver/chrome.d.ts +++ b/types/selenium-webdriver/chrome.d.ts @@ -59,7 +59,6 @@ export class Options { */ static fromCapabilities(capabilities: webdriver.Capabilities): Options; - /** * Add additional command line arguments to use when launching the Chrome * browser. Each argument may be specified with or without the '--' prefix @@ -70,7 +69,6 @@ export class Options { */ addArguments(...var_args: string[]): Options; - /** * List of Chrome command line switches to exclude that ChromeDriver by default * passes when starting Chrome. Do not prefix switches with '--'. @@ -80,7 +78,6 @@ export class Options { */ excludeSwitches(...var_args: string[]): Options; - /** * Add additional extensions to install when launching Chrome. Each extension * should be specified as the path to the packed CRX file, or a Buffer for an @@ -91,7 +88,6 @@ export class Options { */ addExtensions(...var_args: any[]): Options; - /** * Sets the path to the Chrome binary to use. On Mac OS X, this path should * reference the actual Chrome executable, not just the application binary @@ -105,7 +101,6 @@ export class Options { */ setChromeBinaryPath(path: string): Options; - /** * Sets whether to leave the started Chrome browser running if the controlling * ChromeDriver service is killed before {@link webdriver.WebDriver#quit()} is @@ -116,7 +111,6 @@ export class Options { */ detachDriver(detach: boolean): Options; - /** * Sets the user preferences for Chrome's user profile. See the 'Preferences' * file in Chrome's user data directory for examples. @@ -125,7 +119,6 @@ export class Options { */ setUserPreferences(prefs: any): Options; - /** * Sets the logging preferences for the new session. * @param {!webdriver.logging.Preferences} prefs The logging preferences. @@ -159,7 +152,6 @@ export class Options { */ setPerfLoggingPrefs(prefs: IPerfLoggingPrefs): Options; - /** * Sets preferences for the 'Local State' file in Chrome's user data * directory. @@ -168,7 +160,6 @@ export class Options { */ setLocalState(state: any): Options; - /** * Sets the name of the activity hosting a Chrome-based Android WebView. This * option must be set to connect to an [Android WebView]( @@ -179,7 +170,6 @@ export class Options { */ androidActivity(name: string): Options; - /** * Sets the device serial number to connect to via ADB. If not specified, the * ChromeDriver will select an unused device at random. An error will be @@ -190,7 +180,6 @@ export class Options { */ androidDeviceSerial(serial: string): Options; - /** * Configures the ChromeDriver to launch Chrome on Android via adb. This * function is shorthand for @@ -199,7 +188,6 @@ export class Options { */ androidChrome(): Options; - /** * Sets the package name of the Chrome or WebView app. * @@ -209,7 +197,6 @@ export class Options { */ androidPackage(pkg: string): Options; - /** * Sets the process name of the Activity hosting the WebView (as given by `ps`). * If not specified, the process name is assumed to be the same as @@ -220,7 +207,6 @@ export class Options { */ androidProcess(processName: string): Options; - /** * Sets whether to connect to an already-running instead of the specified * {@linkplain #androidProcess app} instead of launching the app with a clean @@ -231,7 +217,6 @@ export class Options { */ androidUseRunningApp(useRunning: boolean): Options; - /** * Sets the path to Chrome's log file. This path should exist on the machine * that will launch Chrome. @@ -240,7 +225,6 @@ export class Options { */ setChromeLogFile(path: string): Options; - /** * Sets the directory to store Chrome minidumps in. This option is only * supported when ChromeDriver is running on Linux. @@ -249,7 +233,6 @@ export class Options { */ setChromeMinidumpPath(path: string): Options; - /** * Configures Chrome to emulate a mobile device. For more information, refer * to the ChromeDriver project page on [mobile emulation][em]. Configuration @@ -295,7 +278,6 @@ export class Options { */ setProxy(proxy: webdriver.ProxyConfig): Options; - /** * Converts this options instance to a {@link webdriver.Capabilities} object. * @param {webdriver.Capabilities=} opt_capabilities The capabilities to merge @@ -330,7 +312,6 @@ export class ServiceBuilder extends remote.DriverService.Builder { */ setAdbPort(port: number): this; - /** * Sets the path of the log file the driver should log to. If a log file is * not specified, the driver will log to stderr. @@ -339,14 +320,12 @@ export class ServiceBuilder extends remote.DriverService.Builder { */ loggingTo(path: string): this; - /** * Enables verbose logging. * @return {!ServiceBuilder} A self reference. */ enableVerboseLogging(): this; - /** * Sets the number of threads the driver should use to manage HTTP requests. * By default, the driver will use 4 threads. diff --git a/types/selenium-webdriver/edge.d.ts b/types/selenium-webdriver/edge.d.ts index 3fb3408b1f..90b45fc92d 100644 --- a/types/selenium-webdriver/edge.d.ts +++ b/types/selenium-webdriver/edge.d.ts @@ -27,7 +27,6 @@ export class Driver extends webdriver.WebDriver { * Class for managing MicrosoftEdgeDriver specific options. */ export class Options { - /** * Extracts the MicrosoftEdgeDriver specific options from the given * capabilities object. diff --git a/types/selenium-webdriver/firefox.d.ts b/types/selenium-webdriver/firefox.d.ts index 6746c3c683..0c2ecdbe92 100644 --- a/types/selenium-webdriver/firefox.d.ts +++ b/types/selenium-webdriver/firefox.d.ts @@ -20,7 +20,6 @@ export class Binary { */ addArguments(...var_args: string[]): void; - /** * Launches Firefox and eturns a promise that will be fulfilled when the process * terminates. @@ -30,7 +29,6 @@ export class Binary { */ launch(profile: string): webdriver.promise.Promise; - /** * Kills the managed Firefox process. * @return {!promise.Promise} A promise for when the process has terminated. @@ -59,7 +57,6 @@ export class Profile { */ addExtension(extension: string): void; - /** * Sets a desired preference for this profile. * @param {string} key The preference key. @@ -70,7 +67,6 @@ export class Profile { setPreference(key: string, value: number): void; setPreference(key: string, value: boolean): void; - /** * Returns the currently configured value of a profile preference. This does * not include any defaults defined in the profile's template directory user.js @@ -81,7 +77,6 @@ export class Profile { */ getPreference(key: string): any; - /** * @return {number} The port this profile is currently configured to use, or * 0 if the port will be selected at random when the profile is written @@ -89,21 +84,18 @@ export class Profile { */ getPort(): number; - /** * Sets the port to use for the WebDriver extension loaded by this profile. * @param {number} port The desired port, or 0 to use any free port. */ setPort(port: number): void; - /** * @return {boolean} Whether the FirefoxDriver is configured to automatically * accept untrusted SSL certificates. */ acceptUntrustedCerts(): boolean; - /** * Sets whether the FirefoxDriver should automatically accept untrusted SSL * certificates. @@ -111,35 +103,30 @@ export class Profile { */ setAcceptUntrustedCerts(value: boolean): void; - /** * Sets whether to assume untrusted certificates come from untrusted issuers. * @param {boolean} value . */ setAssumeUntrustedCertIssuer(value: boolean): void; - /** * @return {boolean} Whether to assume untrusted certs come from untrusted * issuers. */ assumeUntrustedCertIssuer(): boolean; - /** * Sets whether to use native events with this profile. * @param {boolean} enabled . */ setNativeEventsEnabled(enabled: boolean): void; - /** * Returns whether native events are enabled in this profile. * @return {boolean} . */ nativeEventsEnabled(): boolean; - /** * Writes this profile to disk. * @param {boolean=} opt_excludeWebDriverExt Whether to exclude the WebDriver @@ -151,7 +138,6 @@ export class Profile { */ writeToDisk(opt_excludeWebDriverExt?: boolean): webdriver.promise.Promise; - /** * Encodes this profile as a zipped, base64 encoded directory. * @return {!promise.Promise.} A promise for the encoded profile. @@ -264,7 +250,6 @@ export class Driver extends webdriver.WebDriver { */ static createSession(opt_config?: Options | webdriver.Capabilities, opt_executor?: http.Executor | remote.DriverService, opt_flow?: webdriver.promise.ControlFlow): Driver; - /** * This function is a no-op as file detectors are not supported by this * implementation. @@ -305,4 +290,3 @@ export class ServiceBuilder extends remote.DriverService.Builder { */ setFirefoxBinary(binary: string | Binary): this; } - diff --git a/types/selenium-webdriver/http.d.ts b/types/selenium-webdriver/http.d.ts index 4fc12afb19..72fa1b2c5f 100644 --- a/types/selenium-webdriver/http.d.ts +++ b/types/selenium-webdriver/http.d.ts @@ -42,7 +42,6 @@ export class Response { toString(): string; } - export function post(path: string): any; export function del(path: string): any; export function get(path: string): any; diff --git a/types/selenium-webdriver/index.d.ts b/types/selenium-webdriver/index.d.ts index bfd583302e..08b77d0ce1 100644 --- a/types/selenium-webdriver/index.d.ts +++ b/types/selenium-webdriver/index.d.ts @@ -241,7 +241,6 @@ export namespace error { } export namespace logging { - /** * A hash describing log preferences. * @typedef {Object.} @@ -268,7 +267,7 @@ export namespace logging { * Common log types. * @enum {string} */ - var Type: IType; + const Type: IType; /** * Defines a message level that may be used to control logging output. @@ -984,28 +983,22 @@ export namespace promise { */ constructor(resolver: (resolve: IFulfilledCallback, reject: IRejectedCallback) => void, opt_flow?: ControlFlow); - //region Static Methods + /** + * Creates a promise that is immediately resolved with the given value. + * + * @param {T=} opt_value The value to resolve. + * @return {!ManagedPromise} A promise resolved with the given value. + * @template T + */ + static resolve(opt_value?: T): Promise; - /** - * Creates a promise that is immediately resolved with the given value. - * - * @param {T=} opt_value The value to resolve. - * @return {!ManagedPromise} A promise resolved with the given value. - * @template T - */ - static resolve(opt_value?: T): Promise; - - /** - * Creates a promise that is immediately rejected with the given reason. - * - * @param {*=} opt_reason The rejection reason. - * @return {!ManagedPromise} A new rejected promise. - */ - static reject(opt_reason?: any): Promise; - - //endregion - - // region Methods + /** + * Creates a promise that is immediately rejected with the given reason. + * + * @param {*=} opt_reason The rejection reason. + * @return {!ManagedPromise} A new rejected promise. + */ + static reject(opt_reason?: any): Promise; /** * Registers listeners for when this instance is resolved. @@ -1046,9 +1039,6 @@ export namespace promise { * @template R */ catch(errback: (err: any) => R | IThenable): Promise; - - - // endregion } /** @@ -1124,10 +1114,10 @@ export namespace promise { } interface IControlFlowTimer { - clearInterval: (ms: number) => void; - clearTimeout: (ms: number) => void; - setInterval: (fn: Function, ms: number) => number; - setTimeout: (fn: Function, ms: number) => number; + clearInterval(ms: number): void; + clearTimeout(ms: number): void; + setInterval(fn: Function, ms: number): number; + setTimeout(fn: Function, ms: number): number; } interface IEventType { @@ -1314,7 +1304,6 @@ export class WebElementCondition extends Condition { } export namespace until { - /** * Creates a condition that will wait until the input driver is able to switch * to the designated frame. The target frame may be specified as @@ -1545,7 +1534,7 @@ interface IButton { * * @enum {string} */ -export var Button: IButton; +export const Button: IButton; interface IKey { NULL: string; @@ -1624,7 +1613,7 @@ interface IKey { * @param {...string} var_args The key sequence to concatenate. * @return {string} The null-terminated key sequence. */ - chord: (...var_args: Array) => string; + chord(...var_args: Array): string; } /** @@ -1634,7 +1623,7 @@ interface IKey { * * @enum {string} */ -export var Key: IKey; +export const Key: IKey; /** * Class for defining sequences of complex user interactions. Each sequence @@ -1652,7 +1641,6 @@ export var Key: IKey; * */ export class ActionSequence { - // region Constructors /** @@ -1827,7 +1815,6 @@ export class ActionSequence { // endregion } - /** * Class for defining sequences of user touch interactions. Each sequence * will not be executed until {@link #perform} is called. @@ -1847,7 +1834,6 @@ export class TouchSequence { */ constructor(driver: WebDriver); - /** * Executes this action sequence. * @return {!promise.Promise} A promise that will be resolved once @@ -1855,7 +1841,6 @@ export class TouchSequence { */ perform(): promise.Promise; - /** * Taps an element. * @@ -1864,7 +1849,6 @@ export class TouchSequence { */ tap(elem: WebElement): TouchSequence; - /** * Double taps an element. * @@ -1873,7 +1857,6 @@ export class TouchSequence { */ doubleTap(elem: WebElement): TouchSequence; - /** * Long press on an element. * @@ -1882,7 +1865,6 @@ export class TouchSequence { */ longPress(elem: WebElement): TouchSequence; - /** * Touch down at the given location. * @@ -1891,7 +1873,6 @@ export class TouchSequence { */ tapAndHold(location: ILocation): TouchSequence; - /** * Move a held {@linkplain #tapAndHold touch} to the specified location. * @@ -1900,7 +1881,6 @@ export class TouchSequence { */ move(location: ILocation): TouchSequence; - /** * Release a held {@linkplain #tapAndHold touch} at the specified location. * @@ -1909,7 +1889,6 @@ export class TouchSequence { */ release(location: ILocation): TouchSequence; - /** * Scrolls the touch screen by the given offset. * @@ -2019,7 +1998,6 @@ export class Alert { sendKeys(text: string): promise.Promise; // endregion - } /** @@ -2107,7 +2085,7 @@ interface IBrowser { HTMLUNIT: string; } -export var Browser: IBrowser; +export const Browser: IBrowser; interface ProxyConfig { proxyType: string; @@ -2116,9 +2094,9 @@ interface ProxyConfig { httpProxy?: string; sslProxy?: string; noProxy?: string; - socksProxy?: string, - socksUsername?: string, - socksPassword?: string + socksProxy?: string; + socksUsername?: string; + socksPassword?: string; } /** @@ -2161,7 +2139,6 @@ interface ProxyConfig { * node mytest.js */ export class Builder { - // region Constructors /** @@ -2399,7 +2376,6 @@ export class Builder { * @final */ export class By { - /** * @param {string} using the name of the location strategy to use. * @param {string} value the value to search for. @@ -2539,7 +2515,6 @@ type ByHash = { className: string } | * @enum {string} */ interface ICapability { - /** * Indicates whether a driver should accept all SSL certs by default. This * capability only applies when requesting a new session. To query whether @@ -2548,7 +2523,6 @@ interface ICapability { */ ACCEPT_SSL_CERTS: string; - /** * The browser name. Common browser names are defined in the * {@link Browser} enum. @@ -2628,7 +2602,7 @@ interface ICapability { VERSION: string; } -export var Capability: ICapability; +export const Capability: ICapability; export class Capabilities { // region Constructors @@ -2681,7 +2655,6 @@ export class Capabilities { */ setProxy(proxy: ProxyConfig): Capabilities; - /** * Sets whether native events should be used. * @param {boolean} enabled Whether to enable native events. @@ -2689,7 +2662,6 @@ export class Capabilities { */ setEnableNativeEvents(enabled: boolean): Capabilities; - /** * Sets how elements should be scrolled into view for interaction. * @param {number} behavior The desired scroll behavior: either 0 to align with @@ -2916,7 +2888,7 @@ interface ICommandName { UPLOAD_FILE: string; } -export var CommandName: ICommandName; +export const CommandName: ICommandName; /** * Describes a command to be executed by the WebDriverJS framework. @@ -3046,7 +3018,6 @@ export class EventEmitter { */ addListener(type: string, fn: Function, opt_scope?: any, opt_oneshot?: boolean): EventEmitter; - /** * Registers a one-time listener which will be called only the first time an * event is emitted, after which it will be removed. @@ -3085,7 +3056,6 @@ export class EventEmitter { // endregion } - /** * Interface for navigating back and forth in the browser history. */ @@ -3141,7 +3111,6 @@ export class Navigation { } interface IWebDriverOptionsCookie { - /** * The name of the cookie. */ @@ -3199,7 +3168,7 @@ interface IWebDriverOptionsCookie { * * @type {(!number|undefined)} */ - expiry?: number + expiry?: number; } /** @@ -3354,7 +3323,6 @@ export class Timeouts { * An interface for managing the current window. */ export class Window { - // region Constructors /** @@ -3417,7 +3385,6 @@ export class Window { * Interface for managing WebDriver log records. */ export class Logs { - // region Constructors /** @@ -3460,7 +3427,6 @@ export class Logs { * An interface for changing the focus of the driver to another frame or window. */ export class TargetLocator { - // region Constructors /** @@ -3576,7 +3542,7 @@ export class FileDetector { type CreateSessionCapabilities = Capabilities | { desired?: Capabilities, required?: Capabilities - } + }; /** * Creates a new WebDriver client, which provides control over a browser. @@ -3708,7 +3674,6 @@ export class WebDriver { */ schedule(command: Command, description: string): promise.Promise; - /** * Sets the {@linkplain input.FileDetector file detector} that should be * used with this instance. @@ -3716,21 +3681,18 @@ export class WebDriver { */ setFileDetector(detector: FileDetector): void; - /** * @return {!promise.Promise.} A promise for this * client's session. */ getSession(): promise.Promise; - /** * @return {!promise.Promise.} A promise * that will resolve with the this instance's capabilities. */ getCapabilities(): promise.Promise; - /** * Schedules a command to quit the current session. After calling quit, this * instance will be invalidated and may no longer be used to issue commands @@ -3755,7 +3717,6 @@ export class WebDriver { */ actions(): ActionSequence; - /** * Creates a new touch sequence using this driver. The sequence will not be * scheduled for execution until {@link actions.TouchSequence#perform} is @@ -3770,7 +3731,6 @@ export class WebDriver { */ touchActions(): TouchSequence; - /** * Schedules a command to execute JavaScript in the context of the currently * selected frame or window. The script fragment will be executed as the body @@ -4842,7 +4802,6 @@ export class WebElementPromise extends WebElement implements promise.IThenable(opt_callback?: (value: WebElement) => R, opt_errback?: (error: any) => any): promise.Promise; - /** * Registers a listener for when this promise is rejected. This is synonymous * with the {@code catch} clause in a synchronous API: @@ -4873,7 +4832,6 @@ export class WebElementPromise extends WebElement implements promise.IThenable; } -export module DriverService { - +export namespace DriverService { /** * Creates {@link DriverService} objects that manage a WebDriver server in a * child process. */ - export class Builder { + class Builder { /** * @param {string} exe Path to the executable to use. This executable must * accept the `--port` flag for defining the port to start the server on. @@ -90,7 +89,6 @@ export module DriverService { */ addArguments(...var_args: string[]): this; - /** * Sets the host name to access the server on. If specified, the * {@linkplain #setLoopback() loopback} setting will be ignored. @@ -119,7 +117,6 @@ export module DriverService { */ setPath(basePath: string | null): this; - /** * Sets the port to start the server on. * diff --git a/types/selenium-webdriver/test/chrome.ts b/types/selenium-webdriver/test/chrome.ts index b26c43c2d6..a40afe854e 100644 --- a/types/selenium-webdriver/test/chrome.ts +++ b/types/selenium-webdriver/test/chrome.ts @@ -3,17 +3,17 @@ import * as remote from 'selenium-webdriver/remote'; import * as webdriver from 'selenium-webdriver'; function TestChromeDriver() { - var driver: chrome.Driver = chrome.Driver.createSession(); + let driver: chrome.Driver = chrome.Driver.createSession(); driver = chrome.Driver.createSession(webdriver.Capabilities.chrome()); driver = chrome.Driver.createSession(webdriver.Capabilities.chrome(), new remote.DriverService('executable', new chrome.Options()), new webdriver.promise.ControlFlow()); - var baseDriver: webdriver.WebDriver = driver; + let baseDriver: webdriver.WebDriver = driver; } function TestChromeOptions() { - var options: chrome.Options = new chrome.Options(); + let options: chrome.Options = new chrome.Options(); options = chrome.Options.fromCapabilities(webdriver.Capabilities.chrome()); options = options.addArguments('a', 'b', 'c'); @@ -35,15 +35,15 @@ function TestChromeOptions() { tracingCategories: 'category', bufferUsageReportingInterval: 1000 }); options = options.setProxy({ proxyType: 'proxyType' }); options = options.setUserPreferences('preferences'); - var capabilities: webdriver.Capabilities = options.toCapabilities(); + let capabilities: webdriver.Capabilities = options.toCapabilities(); capabilities = options.toCapabilities(webdriver.Capabilities.chrome()); } function TestServiceBuilder() { - var builder: chrome.ServiceBuilder = new chrome.ServiceBuilder(); + let builder: chrome.ServiceBuilder = new chrome.ServiceBuilder(); builder = new chrome.ServiceBuilder('exe'); - var anything: any = builder.build(); + let anything: any = builder.build(); builder = builder.setPort(8080); builder = builder.setAdbPort(5037); builder = builder.loggingTo('path'); @@ -52,10 +52,10 @@ function TestServiceBuilder() { builder = builder.setPath('path'); builder = builder.setStdio('config'); builder = builder.setStdio(['A', 'B']); - builder = builder.setEnvironment({ 'A': 'a', 'B': 'b' }); + builder = builder.setEnvironment({ A: 'a', B: 'b' }); } function TestChromeModule() { - var service: any = chrome.getDefaultService(); + let service: any = chrome.getDefaultService(); chrome.setDefaultService(new remote.DriverService('executable', new chrome.Options())); } diff --git a/types/selenium-webdriver/test/firefox.ts b/types/selenium-webdriver/test/firefox.ts index 38a3c3634e..0a8cabda41 100644 --- a/types/selenium-webdriver/test/firefox.ts +++ b/types/selenium-webdriver/test/firefox.ts @@ -4,26 +4,26 @@ import * as webdriver from 'selenium-webdriver'; import * as http from 'selenium-webdriver/http'; function TestBinary() { - var binary: firefox.Binary = new firefox.Binary(); + let binary: firefox.Binary = new firefox.Binary(); binary = new firefox.Binary('exe'); binary.addArguments('A', 'B', 'C'); - var promise: webdriver.promise.Promise = binary.kill(); + let promise: webdriver.promise.Promise = binary.kill(); binary.launch('profile').then((result: any) => {}); } function TestFirefoxDriver() { - var driver: firefox.Driver = firefox.Driver.createSession(); + let driver: firefox.Driver = firefox.Driver.createSession(); driver = firefox.Driver.createSession(webdriver.Capabilities.firefox()); driver = firefox.Driver.createSession(webdriver.Capabilities.firefox(), new http.Executor(new http.HttpClient('http://someurl'))); driver = firefox.Driver.createSession(webdriver.Capabilities.firefox(), new remote.DriverService('/dev/null', {})); driver = firefox.Driver.createSession(webdriver.Capabilities.firefox(), new remote.DriverService('/dev/null', {}), new webdriver.promise.ControlFlow()); - var baseDriver: webdriver.WebDriver = driver; + let baseDriver: webdriver.WebDriver = driver; } function TestFirefoxOptions() { - var options: firefox.Options = new firefox.Options(); + let options: firefox.Options = new firefox.Options(); options = options.setBinary('binary'); options = options.setBinary(new firefox.Binary()); @@ -31,19 +31,19 @@ function TestFirefoxOptions() { options = options.setProfile('profile'); options = options.setProfile(new firefox.Profile()); options = options.setProxy({ proxyType: 'proxy' }); - var capabilities: webdriver.Capabilities = options.toCapabilities(); + let capabilities: webdriver.Capabilities = options.toCapabilities(); } function TestFirefoxProfile() { - var profile: firefox.Profile = new firefox.Profile(); + let profile: firefox.Profile = new firefox.Profile(); profile = new firefox.Profile('dir'); - var bool: boolean = profile.acceptUntrustedCerts(); + let bool: boolean = profile.acceptUntrustedCerts(); profile.addExtension('ext'); bool = profile.assumeUntrustedCertIssuer(); profile.encode().then((prof: string) => {}); - var num: number = profile.getPort(); - var anything: any = profile.getPreference('key'); + let num: number = profile.getPort(); + let anything: any = profile.getPreference('key'); bool = profile.nativeEventsEnabled(); profile.setAcceptUntrustedCerts(true); profile.setAssumeUntrustedCertIssuer(true); @@ -52,16 +52,15 @@ function TestFirefoxProfile() { profile.setPreference('key', 'value'); profile.setPreference('key', 5); profile.setPreference('key', true); - var stringPromise: webdriver.promise.Promise = profile.writeToDisk(); + let stringPromise: webdriver.promise.Promise = profile.writeToDisk(); stringPromise = profile.writeToDisk(true); } - function TestServiceBuilder() { - var builder: firefox.ServiceBuilder = new firefox.ServiceBuilder(); + let builder: firefox.ServiceBuilder = new firefox.ServiceBuilder(); builder = new firefox.ServiceBuilder('exe'); - var anything: any = builder.build(); + let anything: any = builder.build(); builder = builder.setPort(8080); builder = builder.enableVerboseLogging(); builder = builder.enableVerboseLogging(true); @@ -70,5 +69,5 @@ function TestServiceBuilder() { builder = builder.setPath('path'); builder = builder.setStdio('config'); builder = builder.setStdio(['A', 'B']); - builder = builder.setEnvironment({ 'A': 'a', 'B': 'b' }); + builder = builder.setEnvironment({ A: 'a', B: 'b' }); } diff --git a/types/selenium-webdriver/test/index.ts b/types/selenium-webdriver/test/index.ts index 2556e7e2a8..5d4f8e8b4e 100644 --- a/types/selenium-webdriver/test/index.ts +++ b/types/selenium-webdriver/test/index.ts @@ -6,15 +6,15 @@ import * as remote from 'selenium-webdriver/remote'; import * as testing from 'selenium-webdriver/testing'; function TestBuilder() { - var builder: webdriver.Builder = new webdriver.Builder(); + let builder: webdriver.Builder = new webdriver.Builder(); - var driver: webdriver.WebDriver = builder.build(); + let driver: webdriver.WebDriver = builder.build(); builder = builder.forBrowser('name'); builder = builder.forBrowser('name', 'version'); builder = builder.forBrowser('name', 'version', 'platform'); - var cap: webdriver.Capabilities = builder.getCapabilities(); - var str: string = builder.getServerUrl(); + let cap: webdriver.Capabilities = builder.getCapabilities(); + let str: string = builder.getServerUrl(); builder = builder.setAlertBehavior('behavior'); builder = builder.setChromeOptions(new chrome.Options()); @@ -31,13 +31,13 @@ function TestBuilder() { } function TestActionSequence() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var sequence: webdriver.ActionSequence = new webdriver.ActionSequence(driver); - var element: webdriver.WebElement = new webdriver.WebElement(driver, 'elementId'); - var promise: webdriver.promise.Promise; + let sequence: webdriver.ActionSequence = new webdriver.ActionSequence(driver); + let element: webdriver.WebElement = new webdriver.WebElement(driver, 'elementId'); + let promise: webdriver.promise.Promise; element = new webdriver.WebElement(driver, promise); // Click @@ -87,12 +87,12 @@ function TestActionSequence() { } function TestTouchSequence() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var element: webdriver.WebElement = new webdriver.WebElement(driver, 'elementId'); + let element: webdriver.WebElement = new webdriver.WebElement(driver, 'elementId'); - var sequence: webdriver.TouchSequence = new webdriver.TouchSequence(driver); + let sequence: webdriver.TouchSequence = new webdriver.TouchSequence(driver); sequence = sequence.tap(element); sequence = sequence.doubleTap(element); @@ -109,11 +109,11 @@ function TestTouchSequence() { } function TestAlert() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var alert: webdriver.Alert = driver.switchTo().alert(); + let alert: webdriver.Alert = driver.switchTo().alert(); alert.accept().then(() => {}); alert.dismiss().then(() => {}); @@ -122,7 +122,7 @@ function TestAlert() { } function TestBrowser() { - var browser: string; + let browser: string; browser = webdriver.Browser.ANDROID; browser = webdriver.Browser.CHROME; @@ -137,7 +137,7 @@ function TestBrowser() { } function TestButton() { - var button: string; + let button: string; button = webdriver.Button.LEFT; button = webdriver.Button.MIDDLE; @@ -145,14 +145,14 @@ function TestButton() { } function TestCapabilities() { - var capabilities: webdriver.Capabilities = new webdriver.Capabilities(); + let capabilities: webdriver.Capabilities = new webdriver.Capabilities(); capabilities = new webdriver.Capabilities(webdriver.Capabilities.chrome()); - var objCapabilities: any = {}; + let objCapabilities: any = {}; objCapabilities[webdriver.Capability.BROWSER_NAME] = webdriver.Browser.PHANTOM_JS; capabilities = new webdriver.Capabilities(objCapabilities); - var anything: any = capabilities.get(webdriver.Capability.SECURE_SSL); - var check: boolean = capabilities.has(webdriver.Capability.SECURE_SSL); + let anything: any = capabilities.get(webdriver.Capability.SECURE_SSL); + let check: boolean = capabilities.has(webdriver.Capability.SECURE_SSL); capabilities = capabilities.merge(capabilities); capabilities = capabilities.merge(objCapabilities); capabilities = capabilities.set(webdriver.Capability.VERSION, { abc: 'def' }); @@ -180,7 +180,7 @@ function TestCapabilities() { } function TestCapability() { - var capability: string; + let capability: string; capability = webdriver.Capability.ACCEPT_SSL_CERTS; capability = webdriver.Capability.BROWSER_NAME; @@ -202,19 +202,19 @@ function TestCapability() { } function TestCommand() { - var command: webdriver.Command = new webdriver.Command(webdriver.CommandName.ADD_COOKIE); + let command: webdriver.Command = new webdriver.Command(webdriver.CommandName.ADD_COOKIE); - var name: string = command.getName(); - var param: any = command.getParameter('param'); + let name: string = command.getName(); + let param: any = command.getParameter('param'); - var params: any = command.getParameters(); + let params: any = command.getParameters(); command = command.setParameter('param', 123); command = command.setParameters({ param: 123 }); } function TestCommandName() { - var command: string; + let command: string; command = webdriver.CommandName.ACCEPT_ALERT; command = webdriver.CommandName.ADD_COOKIE; @@ -315,21 +315,21 @@ function TestCommandName() { } function TestEventEmitter() { - var emitter: webdriver.EventEmitter = new webdriver.EventEmitter(); + let emitter: webdriver.EventEmitter = new webdriver.EventEmitter(); - var callback = (a: number, b: number, c: number) => {}; + let callback = (a: number, b: number, c: number) => {}; emitter = emitter.addListener('ABC', callback); emitter = emitter.addListener('ABC', callback, this); emitter.emit('ABC', 1, 2, 3); - var listeners = emitter.listeners('ABC'); + let listeners = emitter.listeners('ABC'); if (listeners[0].oneshot) { listeners[0].fn.apply(listeners[0].scope); } - var length: number = listeners.length; - var listenerInfo = listeners[0]; + let length: number = listeners.length; + let listenerInfo = listeners[0]; if (listenerInfo.oneshot) { listenerInfo.fn.apply(listenerInfo.scope, [1, 2, 3]); } @@ -347,7 +347,7 @@ function TestEventEmitter() { } function TestKey() { - var key: string; + let key: string; key = webdriver.Key.ADD; key = webdriver.Key.ALT; @@ -412,13 +412,13 @@ function TestKey() { } function TestBy() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var locator: webdriver.By = new webdriver.By('class name', 'class'); + let locator: webdriver.By = new webdriver.By('class name', 'class'); - var str: string = locator.toString(); + let str: string = locator.toString(); locator = webdriver.By.className('class'); locator = webdriver.By.css('css'); @@ -430,9 +430,9 @@ function TestBy() { locator = webdriver.By.xpath('xpath'); // Can import 'By' without import declarations - var By = webdriver.By; + let By = webdriver.By; - var locatorHash: webdriver.ByHash; + let locatorHash: webdriver.ByHash; locatorHash = { className: 'class' }; locatorHash = { css: 'css' }; locatorHash = { id: 'id' }; @@ -446,45 +446,45 @@ function TestBy() { } function TestSession() { - var session: webdriver.Session = new webdriver.Session('ABC', webdriver.Capabilities.android()); - var capabilitiesObj: any = {}; + let session: webdriver.Session = new webdriver.Session('ABC', webdriver.Capabilities.android()); + let capabilitiesObj: any = {}; capabilitiesObj[webdriver.Capability.BROWSER_NAME] = webdriver.Browser.ANDROID; capabilitiesObj[webdriver.Capability.PLATFORM] = 'ANDROID'; session = new webdriver.Session('ABC', capabilitiesObj); - var capabilities: webdriver.Capabilities = session.getCapabilities(); - var capability: any = session.getCapability(webdriver.Capability.BROWSER_NAME); - var id: string = session.getId(); - var data: string = session.toJSON(); + let capabilities: webdriver.Capabilities = session.getCapabilities(); + let capability: any = session.getCapability(webdriver.Capability.BROWSER_NAME); + let id: string = session.getId(); + let data: string = session.toJSON(); } function TestWebDriverFileDetector() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var fileDetector: webdriver.FileDetector = new webdriver.FileDetector(); + let fileDetector: webdriver.FileDetector = new webdriver.FileDetector(); fileDetector.handleFile(driver, 'path/to/file').then((path: string) => {}); } function TestWebDriverLogs() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var logs: webdriver.Logs = new webdriver.Logs(driver); + let logs: webdriver.Logs = new webdriver.Logs(driver); logs.get(webdriver.logging.Type.BROWSER).then((entries: webdriver.logging.Entry[]) => {}); logs.getAvailableLogTypes().then((types: string[]) => {}); } function TestWebDriverNavigation() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var navigation: webdriver.Navigation = new webdriver.Navigation(driver); + let navigation: webdriver.Navigation = new webdriver.Navigation(driver); navigation.back().then(() => {}); navigation.forward().then(() => {}); @@ -493,19 +493,19 @@ function TestWebDriverNavigation() { } function TestWebDriverOptions() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var options: webdriver.Options = new webdriver.Options(driver); - var promise: webdriver.promise.Promise; + let options: webdriver.Options = new webdriver.Options(driver); + let promise: webdriver.promise.Promise; - var name: string = 'name'; - var value: string = 'value'; - var path: string = 'path'; - var domain: string = 'domain'; - var secure: boolean = true; - var httpOnly: boolean = true; + let name: string = 'name'; + let value: string = 'value'; + let path: string = 'path'; + let domain: string = 'domain'; + let secure: boolean = true; + let httpOnly: boolean = true; // Add Cookie promise = options.addCookie({ name, value }); @@ -519,37 +519,37 @@ function TestWebDriverOptions() { promise = options.deleteAllCookies(); promise = options.deleteCookie('name'); options.getCookie('name').then((cookie: webdriver.IWebDriverCookie) => { - var expiry: number = cookie.expiry; + let expiry: number = cookie.expiry; }); options.getCookies().then((cookies: webdriver.IWebDriverCookie[]) => { }); - var logs: webdriver.Logs = options.logs(); - var timeouts: webdriver.Timeouts = options.timeouts(); - var window: webdriver.Window = options.window(); + let logs: webdriver.Logs = options.logs(); + let timeouts: webdriver.Timeouts = options.timeouts(); + let window: webdriver.Window = options.window(); } function TestWebDriverTargetLocator() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var locator: webdriver.TargetLocator = new webdriver.TargetLocator(driver); - var promise: webdriver.promise.Promise; + let locator: webdriver.TargetLocator = new webdriver.TargetLocator(driver); + let promise: webdriver.promise.Promise; - var element: webdriver.WebElement = locator.activeElement(); - var alert: webdriver.Alert = locator.alert(); + let element: webdriver.WebElement = locator.activeElement(); + let alert: webdriver.Alert = locator.alert(); promise = locator.defaultContent(); promise = locator.frame(1); promise = locator.window('nameOrHandle'); } function TestWebDriverTimeouts() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var timeouts: webdriver.Timeouts = new webdriver.Timeouts(driver); - var promise: webdriver.promise.Promise; + let timeouts: webdriver.Timeouts = new webdriver.Timeouts(driver); + let promise: webdriver.promise.Promise; promise = timeouts.implicitlyWait(123); promise = timeouts.pageLoadTimeout(123); @@ -557,14 +557,14 @@ function TestWebDriverTimeouts() { } function TestWebDriverWindow() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var window: webdriver.Window = new webdriver.Window(driver); - var locationPromise: webdriver.promise.Promise; - var sizePromise: webdriver.promise.Promise; - var voidPromise: webdriver.promise.Promise; + let window: webdriver.Window = new webdriver.Window(driver); + let locationPromise: webdriver.promise.Promise; + let sizePromise: webdriver.promise.Promise; + let voidPromise: webdriver.promise.Promise; locationPromise = window.getPosition(); sizePromise = window.getSize(); @@ -574,28 +574,28 @@ function TestWebDriverWindow() { } function TestWebDriver() { - var session: webdriver.Session = new webdriver.Session('ABC', webdriver.Capabilities.android()); - var sessionPromise: webdriver.promise.Promise; - var httpClient: http.HttpClient = new http.HttpClient('http://someserver'); - var executor: http.Executor = new http.Executor(httpClient); - var flow: webdriver.promise.ControlFlow = new webdriver.promise.ControlFlow(); - var driver: webdriver.WebDriver = new webdriver.WebDriver(session, executor); + let session: webdriver.Session = new webdriver.Session('ABC', webdriver.Capabilities.android()); + let sessionPromise: webdriver.promise.Promise; + let httpClient: http.HttpClient = new http.HttpClient('http://someserver'); + let executor: http.Executor = new http.Executor(httpClient); + let flow: webdriver.promise.ControlFlow = new webdriver.promise.ControlFlow(); + let driver: webdriver.WebDriver = new webdriver.WebDriver(session, executor); driver = new webdriver.WebDriver(session, executor, flow); driver = new webdriver.WebDriver(sessionPromise, executor); driver = new webdriver.WebDriver(sessionPromise, executor, flow); - var voidPromise: webdriver.promise.Promise; - var stringPromise: webdriver.promise.Promise; - var booleanPromise: webdriver.promise.Promise; - var webElementPromise: webdriver.WebElementPromise; + let voidPromise: webdriver.promise.Promise; + let stringPromise: webdriver.promise.Promise; + let booleanPromise: webdriver.promise.Promise; + let webElementPromise: webdriver.WebElementPromise; - var actions: webdriver.ActionSequence = driver.actions(); - var touchActions: webdriver.TouchSequence = driver.touchActions(); + let actions: webdriver.ActionSequence = driver.actions(); + let touchActions: webdriver.TouchSequence = driver.touchActions(); // call stringPromise = driver.call(() => 'value'); stringPromise = driver.call(() => stringPromise); - stringPromise = driver.call(() => { var d: any = this; return 'value'; }, driver); + stringPromise = driver.call(() => { let d: any = this; return 'value'; }, driver); stringPromise = driver.call((a: number) => 'value', driver, 1); voidPromise = driver.close(); @@ -614,7 +614,7 @@ function TestWebDriver() { stringPromise = driver.executeScript((a: number) => {}, 1); // findElement - var element: webdriver.WebElement; + let element: webdriver.WebElement; element = driver.findElement(webdriver.By.id('ABC')); element = driver.findElement(webdriver.By.js('function(){}')); @@ -631,11 +631,11 @@ function TestWebDriver() { stringPromise = driver.getTitle(); stringPromise = driver.getWindowHandle(); - var options: webdriver.Options = driver.manage(); - var navigation: webdriver.Navigation = driver.navigate(); - var locator: webdriver.TargetLocator = driver.switchTo(); + let options: webdriver.Options = driver.manage(); + let navigation: webdriver.Navigation = driver.navigate(); + let locator: webdriver.TargetLocator = driver.switchTo(); - var fileDetector: webdriver.FileDetector = new webdriver.FileDetector(); + let fileDetector: webdriver.FileDetector = new webdriver.FileDetector(); driver.setFileDetector(fileDetector); voidPromise = driver.quit(); @@ -643,7 +643,7 @@ function TestWebDriver() { voidPromise = driver.sleep(123); stringPromise = driver.takeScreenshot(); - var booleanCondition: webdriver.Condition; + let booleanCondition: webdriver.Condition; booleanPromise = driver.wait(booleanPromise); booleanPromise = driver.wait(booleanCondition); booleanPromise = driver.wait((driver: webdriver.WebDriver) => true); @@ -660,24 +660,24 @@ function TestWebDriver() { } function TestSerializable() { - var serializable: webdriver.Serializable; - var serial: string | webdriver.promise.IThenable = serializable.serialize(); + let serializable: webdriver.Serializable; + let serial: string | webdriver.promise.IThenable = serializable.serialize(); } function TestWebElement() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var promise: webdriver.promise.Promise; - var element: webdriver.WebElement; + let promise: webdriver.promise.Promise; + let element: webdriver.WebElement; element = new webdriver.WebElement(driver, 'elementId'); element = new webdriver.WebElement(driver, promise); - var voidPromise: webdriver.promise.Promise; - var stringPromise: webdriver.promise.Promise; - var booleanPromise: webdriver.promise.Promise; + let voidPromise: webdriver.promise.Promise; + let stringPromise: webdriver.promise.Promise; + let booleanPromise: webdriver.promise.Promise; voidPromise = element.clear(); voidPromise = element.click(); @@ -709,11 +709,11 @@ function TestWebElement() { } function TestWebElementPromise() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var elementPromise: webdriver.WebElementPromise = driver.findElement(webdriver.By.id('id')); + let elementPromise: webdriver.WebElementPromise = driver.findElement(webdriver.By.id('id')); elementPromise.then(); elementPromise.then((element: webdriver.WebElement) => {}); @@ -722,11 +722,11 @@ function TestWebElementPromise() { } function TestLogging() { - var preferences: webdriver.logging.Preferences = new webdriver.logging.Preferences(); + let preferences: webdriver.logging.Preferences = new webdriver.logging.Preferences(); preferences.setLevel(webdriver.logging.Type.BROWSER, webdriver.logging.Level.ALL); - var prefs: any = preferences.toJSON(); + let prefs: any = preferences.toJSON(); - var level: webdriver.logging.Level = webdriver.logging.getLevel('OFF'); + let level: webdriver.logging.Level = webdriver.logging.getLevel('OFF'); level = webdriver.logging.getLevel(1); level = webdriver.logging.Level.ALL; @@ -736,10 +736,10 @@ function TestLogging() { level = webdriver.logging.Level.SEVERE; level = webdriver.logging.Level.WARNING; - var name: string = level.name; - var value: number = level.value; + let name: string = level.name; + let value: number = level.value; - var type: string; + let type: string; type = webdriver.logging.Type.BROWSER; type = webdriver.logging.Type.CLIENT; type = webdriver.logging.Type.DRIVER; @@ -748,7 +748,7 @@ function TestLogging() { } function TestLoggingEntry() { - var entry: webdriver.logging.Entry; + let entry: webdriver.logging.Entry; entry = new webdriver.logging.Entry(webdriver.logging.Level.ALL, 'ABC'); entry = new webdriver.logging.Entry('ALL', 'ABC'); @@ -757,23 +757,23 @@ function TestLoggingEntry() { entry = new webdriver.logging.Entry(webdriver.logging.Level.ALL, 'ABC', 123, webdriver.logging.Type.BROWSER); entry = new webdriver.logging.Entry('ALL', 'ABC', 123, webdriver.logging.Type.BROWSER); - var entryObj: any = entry.toJSON(); + let entryObj: any = entry.toJSON(); - var message: string = entry.message; - var timestamp: number = entry.timestamp; - var type: string = entry.type; + let message: string = entry.message; + let timestamp: number = entry.timestamp; + let type: string = entry.type; } function TestPromiseModule() { - var cancellationError: webdriver.promise.CancellationError = new webdriver.promise.CancellationError(); + let cancellationError: webdriver.promise.CancellationError = new webdriver.promise.CancellationError(); cancellationError = new webdriver.promise.CancellationError('message'); - var str: string = cancellationError.message; + let str: string = cancellationError.message; str = cancellationError.name; - var stringPromise: webdriver.promise.Promise; - var numberPromise: webdriver.promise.Promise; - var booleanPromise: webdriver.promise.Promise; - var voidPromise: webdriver.promise.Promise; + let stringPromise: webdriver.promise.Promise; + let numberPromise: webdriver.promise.Promise; + let booleanPromise: webdriver.promise.Promise; + let voidPromise: webdriver.promise.Promise; webdriver.promise.all([stringPromise]).then((values: string[]) => {}); @@ -791,7 +791,7 @@ function TestPromiseModule() { webdriver.promise.consume((a: number, b: number, c: number) => 5, this, 1, 2, 3) .then((value: number) => {}); - var numbersPromise: webdriver.promise.Promise = webdriver.promise.filter([1, 2, 3], (element: number, type: any, index: number, arr: number[]) => { + let numbersPromise: webdriver.promise.Promise = webdriver.promise.filter([1, 2, 3], (element: number, type: any, index: number, arr: number[]) => { return true; }); numbersPromise = webdriver.promise.filter([1, 2, 3], (element: number, type: any, index: number, arr: number[]) => { @@ -817,11 +817,11 @@ function TestPromiseModule() { return true; }, this); - var flow: webdriver.promise.ControlFlow = webdriver.promise.controlFlow(); + let flow: webdriver.promise.ControlFlow = webdriver.promise.controlFlow(); stringPromise = webdriver.promise.createFlow((newFlow: webdriver.promise.ControlFlow) => 'ABC'); - var deferred: webdriver.promise.Deferred; + let deferred: webdriver.promise.Deferred; deferred = webdriver.promise.defer(); deferred = webdriver.promise.defer(); @@ -837,8 +837,8 @@ function TestPromiseModule() { stringPromise = webdriver.promise.fullyResolved('abc'); - var bool: boolean = webdriver.promise.isGenerator(() => {}); - var isPromise: boolean = webdriver.promise.isPromise('ABC'); + let bool: boolean = webdriver.promise.isGenerator(() => {}); + let isPromise: boolean = webdriver.promise.isPromise('ABC'); stringPromise = webdriver.promise.rejected('{a: 123}'); @@ -848,18 +848,18 @@ function TestPromiseModule() { } function TestUntilModule() { - var driver: webdriver.WebDriver = new webdriver.Builder(). + let driver: webdriver.WebDriver = new webdriver.Builder(). withCapabilities(webdriver.Capabilities.chrome()). build(); - var conditionB: webdriver.Condition = new webdriver.Condition('message', (driver: webdriver.WebDriver) => true); - var conditionBBase: webdriver.Condition = conditionB; - var conditionWebElement: webdriver.WebElementCondition; - var conditionWebElements: webdriver.Condition; + let conditionB: webdriver.Condition = new webdriver.Condition('message', (driver: webdriver.WebDriver) => true); + let conditionBBase: webdriver.Condition = conditionB; + let conditionWebElement: webdriver.WebElementCondition; + let conditionWebElements: webdriver.Condition; conditionB = webdriver.until.ableToSwitchToFrame(5); - var conditionAlert: webdriver.Condition = webdriver.until.alertIsPresent(); - var el: webdriver.WebElement = driver.findElement(webdriver.By.id('id')); + let conditionAlert: webdriver.Condition = webdriver.until.alertIsPresent(); + let el: webdriver.WebElement = driver.findElement(webdriver.By.id('id')); conditionB = webdriver.until.stalenessOf(el); conditionB = webdriver.until.titleContains('text'); conditionB = webdriver.until.titleIs('text'); @@ -882,31 +882,31 @@ function TestUntilModule() { } function TestControlFlow() { - var flow: webdriver.promise.ControlFlow; + let flow: webdriver.promise.ControlFlow; flow = new webdriver.promise.ControlFlow(); - var emitter: webdriver.EventEmitter = flow; + let emitter: webdriver.EventEmitter = flow; - var eventType: string; + let eventType: string; eventType = webdriver.promise.ControlFlow.EventType.IDLE; eventType = webdriver.promise.ControlFlow.EventType.RESET; eventType = webdriver.promise.ControlFlow.EventType.SCHEDULE_TASK; eventType = webdriver.promise.ControlFlow.EventType.UNCAUGHT_EXCEPTION; - var stringPromise: webdriver.promise.Promise; + let stringPromise: webdriver.promise.Promise; stringPromise = flow.execute(() => 'value'); stringPromise = flow.execute(() => stringPromise); stringPromise = flow.execute(() => stringPromise, 'Description'); - var schedule: string; + let schedule: string; schedule = flow.toString(); schedule = flow.getSchedule(); schedule = flow.getSchedule(true); flow.reset(); - var voidPromise: webdriver.promise.Promise = flow.timeout(123); + let voidPromise: webdriver.promise.Promise = flow.timeout(123); voidPromise = flow.timeout(123, 'Description'); stringPromise = flow.wait(stringPromise); @@ -917,12 +917,12 @@ function TestControlFlow() { } function TestDeferred() { - var deferred: webdriver.promise.Deferred; + let deferred: webdriver.promise.Deferred; deferred = new webdriver.promise.Deferred(); deferred = new webdriver.promise.Deferred(new webdriver.promise.ControlFlow()); - var promise: webdriver.promise.Promise = deferred.promise; + let promise: webdriver.promise.Promise = deferred.promise; deferred.errback(new Error('Error')); deferred.errback('Error'); @@ -933,8 +933,8 @@ function TestDeferred() { } function TestPromiseClass() { - var controlFlow: webdriver.promise.ControlFlow; - var promise: webdriver.promise.Promise; + let controlFlow: webdriver.promise.ControlFlow; + let promise: webdriver.promise.Promise; promise = new webdriver.promise.Promise((resolve: (value: string) => void, reject: () => void) => {}); promise = new webdriver.promise.Promise((resolve: (value: webdriver.promise.Promise) => void, reject: () => void) => {}); promise = new webdriver.promise.Promise((resolve: (value: string) => void, reject: () => void) => {}, controlFlow); @@ -946,7 +946,7 @@ function TestPromiseClass() { } function TestThenableClass() { - var thenable: webdriver.promise.Promise = new webdriver.promise.Promise((resolve, reject) => { + let thenable: webdriver.promise.Promise = new webdriver.promise.Promise((resolve, reject) => { resolve('a'); }); @@ -956,8 +956,8 @@ function TestThenableClass() { } async function TestAsyncAwaitable() { - var thenable: webdriver.promise.Promise = new webdriver.promise.Promise((resolve, reject) => resolve('foo')); - var str: string = await thenable; + let thenable: webdriver.promise.Promise = new webdriver.promise.Promise((resolve, reject) => resolve('foo')); + let str: string = await thenable; } function TestTestingModule() { @@ -973,7 +973,6 @@ function TestTestingModule() { testing.iit('My exclusive test.', () => { }); - }); testing.xdescribe('My disabled suite', () => { From 8bd131f9fe4d00090d39b72f3ff5f4a991440d17 Mon Sep 17 00:00:00 2001 From: Gilad Gray Date: Wed, 29 Mar 2017 16:31:05 -0700 Subject: [PATCH 067/844] enable strictNullChecks --- types/kss/tsconfig.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/kss/tsconfig.json b/types/kss/tsconfig.json index 4dcd9b1539..30cdd58f41 100644 --- a/types/kss/tsconfig.json +++ b/types/kss/tsconfig.json @@ -7,7 +7,7 @@ ], "noImplicitAny": true, "noImplicitThis": true, - "strictNullChecks": false, + "strictNullChecks": true, "baseUrl": "../", "typeRoots": [ "../" From ed0cfdd8aa36ead3faebab9674101f447392cbf7 Mon Sep 17 00:00:00 2001 From: spacejack Date: Wed, 29 Mar 2017 21:40:04 -0400 Subject: [PATCH 068/844] Extend DT tslint.json, code style updates. --- types/mithril/index.d.ts | 62 ++--- types/mithril/test/test-api.ts | 374 +++++++++++++-------------- types/mithril/test/test-component.ts | 5 +- types/mithril/tslint.json | 52 +--- 4 files changed, 215 insertions(+), 278 deletions(-) diff --git a/types/mithril/index.d.ts b/types/mithril/index.d.ts index adfc9cd117..069d162c76 100644 --- a/types/mithril/index.d.ts +++ b/types/mithril/index.d.ts @@ -5,22 +5,21 @@ // TypeScript Version: 2.2 declare namespace Mithril { - export interface Lifecycle { /** Any property attached to the component object is copied for every instance of the component. This allows simple state initialization. */ [propName: string]: any; /** The oninit hook is called before a vnode is touched by the virtual DOM engine. */ - oninit?: (this: State, vnode: Vnode) => any; + oninit?(this: State, vnode: Vnode): any; /** The oncreate hook is called after a DOM element is created and attached to the document. */ - oncreate?: (this: State, vnode: VnodeDOM) => any; + oncreate?(this: State, vnode: VnodeDOM): any; /** The onbeforeupdate hook is called before a vnode is diffed in a update. */ - onbeforeremove?: (this: State, vnode: VnodeDOM) => Promise | void; + onbeforeremove?(this: State, vnode: VnodeDOM): Promise | void; /** The onupdate hook is called after a DOM element is updated, while attached to the document. */ - onremove?: (this: State, vnode: VnodeDOM) => any; + onremove?(this: State, vnode: VnodeDOM): any; /** The onbeforeremove hook is called before a DOM element is detached from the document. If a Promise is returned, Mithril only detaches the DOM element after the promise completes. */ - onbeforeupdate?: (this: State, vnode: Vnode, old: VnodeDOM) => boolean | void; + onbeforeupdate?(this: State, vnode: Vnode, old: VnodeDOM): boolean | void; /** The onremove hook is called before a DOM element is removed from the document. */ - onupdate?: (this: State, vnode: VnodeDOM) => any; + onupdate?(this: State, vnode: VnodeDOM): any; } export interface Hyperscript { @@ -40,9 +39,9 @@ declare namespace Mithril { export interface RouteResolver { /** The onmatch hook is called when the router needs to find a component to render. */ - render?: (this: State, vnode: Vnode) => Children; + render?(this: State, vnode: Vnode): Children; /** The render method is called on every redraw for a matching route. */ - onmatch?: (args: Params, requestedPath: string) => Component | Promise | void; + onmatch?(args: Params, requestedPath: string): Component | Promise | void; } /** This represents a key-value mapping linking routes to components. */ @@ -79,23 +78,19 @@ declare namespace Mithril { export interface Mount { /** Mounts a component to a DOM element, enabling it to autoredraw on user events. */ - (element: Element, component: ComponentTypes | null): void; + (element: Element, component: ComponentTypes): void; + /** Unmounts a component from a DOM element. */ + (element: Element, component: null): void; } - export interface WithAttr { - /** Creates an event handler which takes the value of the specified DOM element property and calls a function with it as the argument. */ - (name: string, callback: (value: any) => any, thisArg?: any): (e: { currentTarget: any, [p: string]: any }) => void; - } + /** Creates an event handler which takes the value of the specified DOM element property and calls a function with it as the argument. */ + export type WithAttr = (name: string, callback: (value: any) => any, thisArg?: any) => (e: { currentTarget: any, [p: string]: any }) => void; - export interface ParseQueryString { - /** Returns an object with key/value pairs parsed from a string of the form: ?a=1&b=2 */ - (queryString: string): { [p: string]: any }; - } + /** Returns an object with key/value pairs parsed from a string of the form: ?a=1&b=2 */ + export type ParseQueryString = (queryString: string) => { [p: string]: any }; - export interface BuildQueryString { - /** Turns the key/value pairs of an object into a string of the form: a=1&b=2 */ - (values: { [p: string]: any }): string; - } + /** Turns the key/value pairs of an object into a string of the form: a=1&b=2 */ + export type BuildQueryString = (values: { [p: string]: any }) => string; export interface RequestOptions { /** The HTTP method to use. */ @@ -111,17 +106,17 @@ declare namespace Mithril { /** Whether to send cookies to 3rd party domains. */ withCredentials?: boolean; /** Exposes the underlying XMLHttpRequest object for low-level configuration. */ - config?: (xhr: XMLHttpRequest) => any; + config?(xhr: XMLHttpRequest): any; /** Headers to append to the request before sending it. */ headers?: any; /** A constructor to be applied to each object in the response. */ type?: new (o: any) => any; /** A serialization method to be applied to data. Defaults to JSON.stringify, or if options.data is an instance of FormData, defaults to the identity function. */ - serialize?: (data: any) => any; + serialize?(data: any): any; /** A deserialization method to be applied to the response. Defaults to a small wrapper around JSON.parse that returns null for empty responses. */ - deserialize?: (data: string) => T; + deserialize?(data: string): T; /** A hook to specify how the XMLHttpRequest response should be read. Useful for reading response headers and cookies. Defaults to a function that returns xhr.responseText */ - extract?: (xhr: XMLHttpRequest, options: RequestOptions) => T; + extract?(xhr: XMLHttpRequest, options: RequestOptions): T; /** Force the use of the HTTP body section for data in GET requests when set to true, or the use of querystring for other HTTP methods when set to false. Defaults to false for GET requests and true for other methods. */ useBody?: boolean; /** If false, redraws mounted components upon completion of the request. If true, it does not. */ @@ -170,19 +165,15 @@ declare namespace Mithril { jsonp: Jsonp; } - export interface Render { - /** Renders a vnode structure into a DOM element. */ - (el: Element, vnodes: Children): void; - } + /** Renders a vnode structure into a DOM element. */ + export type Render = (el: Element, vnodes: Children) => void; export interface RenderService { render: Render } - export interface Redraw { - /** Manually triggers a redraw of mounted components. */ - (): void; - } + /** Manually triggers a redraw of mounted components. */ + export type Redraw = () => void; export interface RedrawService { redraw: Redraw @@ -232,10 +223,8 @@ declare namespace Mithril { // In some lifecycle methods, Vnode will have a dom property // and possibly a domSize property. export interface VnodeDOM extends Vnode { - /** Points to the element that corresponds to the vnode. */ dom: Element; - /** This defines the number of DOM elements that the vnode represents (starting from the element referenced by the dom property). */ domSize?: number; } @@ -246,7 +235,6 @@ declare namespace Mithril { /** Components are a mechanism to encapsulate parts of a view to make code easier to organize and/or reuse. Any Javascript object that has a view method is a Mithril component. Components can be consumed via the m() utility. */ export interface Component> extends Lifecycle { - /** Creates a view out of virtual elements. */ view(this: State, vnode: Vnode): Children | null | void; } diff --git a/types/mithril/test/test-api.ts b/types/mithril/test/test-api.ts index 49fb8ebefc..221cad02e8 100644 --- a/types/mithril/test/test-api.ts +++ b/types/mithril/test/test-api.ts @@ -7,7 +7,7 @@ import * as stream from 'mithril/stream' const FRAME_BUDGET = 100 { - let vnode = m("div") + const vnode = m("div") console.assert(vnode.tag === "div") console.assert(typeof m.version === "string") console.assert(m.version.indexOf(".") > -1) @@ -41,7 +41,7 @@ const FRAME_BUDGET = 100 { const root = window.document.createElement("div") - m.mount(root, {view: function() {return m("div")}}) + m.mount(root, {view() {return m("div")}}) console.assert(root.childNodes.length === 1) console.assert(root.firstChild!.nodeName === "DIV") } @@ -49,10 +49,10 @@ const FRAME_BUDGET = 100 { const root = window.document.createElement("div") m.route(root, "/a", { - "/a": {view: function() {return m("div")}} + "/a": {view() {return m("div")}} }) - setTimeout(function() { + setTimeout(() => { console.assert(root.childNodes.length === 1) console.assert(root.firstChild!.nodeName === "DIV") }, FRAME_BUDGET) @@ -62,10 +62,10 @@ const FRAME_BUDGET = 100 const root = window.document.createElement("div") m.route.prefix("#") m.route(root, "/a", { - "/a": {view: function() {return m("div")}} + "/a": {view() {return m("div")}} }) - setTimeout(function() { + setTimeout(() => { console.assert(root.childNodes.length === 1) console.assert(root.firstChild!.nodeName === "DIV") }, FRAME_BUDGET) @@ -74,10 +74,10 @@ const FRAME_BUDGET = 100 { const root = window.document.createElement("div") m.route(root, "/a", { - "/a": {view: function() {return m("div")}} + "/a": {view() {return m("div")}} }) - setTimeout(function() { + setTimeout(() => { console.assert(m.route.get() === "/a") }, FRAME_BUDGET) } @@ -85,12 +85,12 @@ const FRAME_BUDGET = 100 { const root = window.document.createElement("div") m.route(root, "/a", { - "/:id": {view: function() {return m("div")}} + "/:id": {view() {return m("div")}} }) - setTimeout(function() { + setTimeout(() => { m.route.set("/b") - setTimeout(function() { + setTimeout(() => { console.assert(m.route.get() === "/b") }, FRAME_BUDGET) }, FRAME_BUDGET) @@ -99,8 +99,8 @@ const FRAME_BUDGET = 100 { let count = 0 const root = window.document.createElement("div") - m.mount(root, {view: function() {count++}}) - setTimeout(function() { + m.mount(root, {view() {count++}}) + setTimeout(() => { m.redraw() console.assert(count === 2) }, FRAME_BUDGET) @@ -114,115 +114,110 @@ const FRAME_BUDGET = 100 // http://mithril.js.org/hyperscript.html#components //////////////////////////////////////////////////////////////////////////////// -;(function() { - +{ // define a component - let Greeter: m.Comp<{}, {}> = { - view: function(vnode) { + const Greeter: m.Comp<{}, {}> = { + view(vnode) { return m("div", vnode.attrs, ["Hello ", vnode.children]) } } // consume it m(Greeter, { style: "color:red;" }, "world") - -}) +} //////////////////////////////////////////////////////////////////////////////// // http://mithril.js.org/hyperscript.html#keys //////////////////////////////////////////////////////////////////////////////// -;(function() { - - let users = [ +{ + const users = [ { id: 1, name: "John" }, { id: 2, name: "Mary" }, ] - function userInputs(users: { id: number, name: string }[]) { - return users.map(function(u) { + const userInputs = function(users: { id: number, name: string }[]) { + return users.map(u => { return m("input", { key: u.id }, u.name) }) } m.render(document.body, userInputs(users)) - -}) +} //////////////////////////////////////////////////////////////////////////////// // http://mithril.js.org/components.html#state //////////////////////////////////////////////////////////////////////////////// -;(function() { - let ComponentWithInitialState: m.Comp<{}, {data: string}> = { +{ + const ComponentWithInitialState: m.Comp<{}, {data: string}> = { data: "Initial content", - view: function(vnode) { + view(vnode) { return m("div", vnode.state.data) } } m(ComponentWithInitialState) -}) +} -;(function() { - let ComponentWithDynamicState: m.Comp<{text: string}, {data?: string}> = { - oninit: function(vnode) { +{ + const ComponentWithDynamicState: m.Comp<{text: string}, {data?: string}> = { + oninit(vnode) { vnode.state.data = vnode.attrs.text }, - view: function(vnode) { + view(vnode) { return m("div", vnode.state.data) } } m(ComponentWithDynamicState, { text: "Hello" }) -}) +} -;(function() { - let ComponentUsingThis: m.Comp<{text: string}, {data?: string}> = { - oninit: function(vnode) { +{ + const ComponentUsingThis: m.Comp<{text: string}, {data?: string}> = { + oninit(vnode) { this.data = vnode.attrs.text }, - view: function(vnode) { + view(vnode) { return m("div", this.data) } } m(ComponentUsingThis, { text: "Hello" }) -}) +} //////////////////////////////////////////////////////////////////////////////// // http://mithril.js.org/lifecycle-methods.html //////////////////////////////////////////////////////////////////////////////// -;(function() { - let Fader: m.Comp<{}, {}> = { - onbeforeremove: function(vnode) { +{ + const Fader: m.Comp<{}, {}> = { + onbeforeremove(vnode) { vnode.dom.classList.add("fade-out") - return new Promise(function(resolve) { + return new Promise(resolve => { setTimeout(resolve, 1000) }) }, - view: function() { + view() { return m("div", "Bye") }, } -}) +} //////////////////////////////////////////////////////////////////////////////// // http://mithril.js.org/route.html#wrapping-a-layout-component //////////////////////////////////////////////////////////////////////////////// -;(function() { - - let Home = { - view: function() { +{ + const Home = { + view() { return "Welcome" } } - let state = { + const state = { term: "", - search: function() { + search() { // save the state for this route // this is equivalent to `history.replaceState({term: state.term}, null, location.href)` m.route.set(m.route.get(), null, { replace: true, state: { term: state.term } }) @@ -232,20 +227,20 @@ const FRAME_BUDGET = 100 } } - let Form: m.Comp<{term: string}, {}> = { - oninit: function(vnode) { + const Form: m.Comp<{term: string}, {}> = { + oninit(vnode) { state.term = vnode.attrs.term || "" // populated from the `history.state` property if the user presses the back button }, - view: function() { + view() { return m("form", [ - m("input[placeholder='Search']", { oninput: m.withAttr("value", function(v) { state.term = v }), value: state.term }), + m("input[placeholder='Search']", { oninput: m.withAttr("value", v => { state.term = v }), value: state.term }), m("button", { onclick: state.search }, "Search") ]) } } - let Layout: m.Comp<{}, {}> = { - view: function(vnode) { + const Layout: m.Comp<{}, {}> = { + view(vnode) { return m(".layout", vnode.children) } } @@ -253,12 +248,12 @@ const FRAME_BUDGET = 100 // example 1 m.route(document.body, "/", { "/": { - view: function() { + view() { return m(Layout, m(Home)) }, }, "/form": { - view: function() { + view() { return m(Layout, m(Form)) }, } @@ -267,52 +262,52 @@ const FRAME_BUDGET = 100 // example 2 m.route(document.body, "/", { "/": { - render: function() { + render() { return m(Layout, m(Home)) }, }, "/form": { - render: function() { + render() { return m(Layout, m(Form)) }, } }) // functionally equivalent to example 1 - let Anon1 = { - view: function() { + const Anon1 = { + view() { return m(Layout, m(Home)) }, } - let Anon2 = { - view: function() { + const Anon2 = { + view() { return m(Layout, m(Form)) }, } m.route(document.body, "/", { "/": { - render: function() { + render() { return m(Anon1) } }, "/form": { - render: function() { + render() { return m(Anon2) } }, }) -}) +} //////////////////////////////////////////////////////////////////////////////// // http://mithril.js.org/route.html#preloading-data //////////////////////////////////////////////////////////////////////////////// -;(function() { - let state = { - users: [], - loadUsers: function() { - return m.request("/api/v1/users").then(function(users) { +{ + const state = { + users: [] as any[], + loadUsers() { + return m.request("/api/v1/users").then(users => { state.users = users }) } @@ -321,24 +316,22 @@ const FRAME_BUDGET = 100 m.route(document.body, "/user/list", { "/user/list": { onmatch: state.loadUsers, - render: function() { - return state.users.map(function(user) { - return m("div", user.id) - }) + render() { + return state.users.map(user => m("div", user.id)) } }, }) -}) +} //////////////////////////////////////////////////////////////////////////////// // http://mithril.js.org/request.html#monitoring-progress //////////////////////////////////////////////////////////////////////////////// -;(function() { +{ let progress = 0 m.mount(document.body, { - view: function() { + view() { return [ m("input[type=file]", { onchange: upload }), progress + "% completed" @@ -346,33 +339,29 @@ const FRAME_BUDGET = 100 } }) - function upload(e: Event) { - let file = ((e.target).files)[0] - - let data = new FormData() + const upload = function(e: Event) { + const file = ((e.target as HTMLInputElement).files as FileList)[0] + const data = new FormData() data.append("myfile", file) - m.request({ method: "POST", url: "/api/v1/upload", - data: data, - config: function(xhr) { - xhr.addEventListener("progress", function(e) { + data, + config: xhr => { + xhr.addEventListener("progress", e => { progress = e.loaded / e.total - m.redraw() // tell Mithril that data changed and a re-render is needed }) } }) } -}) +} //////////////////////////////////////////////////////////////////////////////// // http://mithril.js.org/request.html#casting-response-to-a-type //////////////////////////////////////////////////////////////////////////////// -;(function() { - +{ // Start rewrite to TypeScript class User { name: string; @@ -391,48 +380,48 @@ const FRAME_BUDGET = 100 url: "/api/v1/users", type: User }) - .then(function(users) { + .then(users => { console.log(users[0].name) // logs a name }) -}) +} //////////////////////////////////////////////////////////////////////////////// // http://mithril.js.org/request.html#non-json-responses //////////////////////////////////////////////////////////////////////////////// -;(function() { +{ m.request({ method: "GET", url: "/files/icon.svg", - deserialize: function(value) { return value } + deserialize: value => value }) - .then(function(svg) { + .then(svg => { m.render(document.body, m.trust(svg)) }) -}) +} //////////////////////////////////////////////////////////////////////////////// // http://mithril.js.org/jsonp.html //////////////////////////////////////////////////////////////////////////////// -;(function() { +{ m.jsonp({ url: "/api/v1/users/:id", data: { id: 1 }, callbackKey: "callback", }) - .then(function(result) { + .then(result => { console.log(result) }) -}) +} //////////////////////////////////////////////////////////////////////////////// // http://mithril.js.org/fragment.html //////////////////////////////////////////////////////////////////////////////// -;(function() { - let groupVisible = true - let log = function() { +{ + const groupVisible = true + const log = function() { console.log("group is now visible") } @@ -445,16 +434,16 @@ const FRAME_BUDGET = 100 m("li", "child 4"), ]) : null ]) -}) +} //////////////////////////////////////////////////////////////////////////////// // http://mithril.js.org/stream.html#computed-properties //////////////////////////////////////////////////////////////////////////////// -;(function() { - let firstName = stream("John") - let lastName = stream("Doe") - let fullName = stream.merge([firstName, lastName]).map(function(values) { +{ + const firstName = stream("John") + const lastName = stream("Doe") + const fullName = stream.merge([firstName, lastName]).map(values => { return values.join(" ") }) @@ -463,51 +452,51 @@ const FRAME_BUDGET = 100 firstName("Mary") console.log(fullName()) // logs "Mary Doe" -}) +} //////////////////////////////////////////////////////////////////////////////// // http://mithril.js.org/stream.html#chaining-streams //////////////////////////////////////////////////////////////////////////////// -;(function() { - let halted = stream(1).map(function(value) { +{ + const halted = stream(1).map(value => { return stream.HALT }) - halted.map(function() { + halted.map(() => { // never runs }) -}) +} //////////////////////////////////////////////////////////////////////////////// // http://mithril.js.org/stream.html#combining-streams //////////////////////////////////////////////////////////////////////////////// -;(function() { - let a = stream(5) - let b = stream(7) +{ + const a = stream(5) + const b = stream(7) - let added = stream.combine(function(a: stream.Stream, b: stream.Stream) { + const added = stream.combine((a: stream.Stream, b: stream.Stream) => { return a() + b() }, [a, b]) console.log(added()) // logs 12 -}) +} //////////////////////////////////////////////////////////////////////////////// // http://mithril.js.org/stream.html#ended-state //////////////////////////////////////////////////////////////////////////////// -;(function() { - let value = stream() - let doubled = value.map(function(value) { return value * 2 }) +{ + const value = stream() + const doubled = value.map(value => value * 2) value.end(true) // set to ended state value(5) console.log(doubled()) -}) +} //////////////////////////////////////////////////////////////////////////////// // https://github.com/lhorie/mithril.js/blob/master/examples/animation/mosaic.html @@ -515,18 +504,15 @@ const FRAME_BUDGET = 100 // Excerpt -;(function() { - - let root = (document.getElementById("root")) - - let empty: any[] = [] - let full: any[] = [] +{ + const root = document.getElementById("root")! + const empty: any[] = [] + const full: any[] = [] for (let i = 0; i < 100; i++) full.push(i) - let cells: any[] - function view() { - return m(".container", cells.map(function(i) { + const view = function() { + return m(".container", cells.map(i => { return m(".slice", { style: {backgroundPosition: (i % 10 * 11) + "% " + (Math.floor(i / 10) * 11) + "%"}, onbeforeremove: exit @@ -534,14 +520,14 @@ const FRAME_BUDGET = 100 })) } - function exit(vnode: m.VnodeDOM) { + const exit = function(vnode: m.VnodeDOM) { vnode.dom.classList.add("exit") - return new Promise(function(resolve) { + return new Promise(resolve => { setTimeout(resolve, 1000) }) } - function run() { + const run = function() { cells = cells === full ? empty : full m.render(root, [view()]) @@ -550,8 +536,7 @@ const FRAME_BUDGET = 100 } run() - -}) +} //////////////////////////////////////////////////////////////////////////////// // https://github.com/lhorie/mithril.js/blob/master/examples/editor/index.html @@ -559,23 +544,22 @@ const FRAME_BUDGET = 100 // Excerpt -;(function() { - +{ // Start extra declarations - let marked = (v: string) => v + const marked = (v: string) => v // End extra declarations - //model - let state = { + // model + const state = { text: "# Markdown Editor\n\nType on the left panel and see the result on the right panel", - update: function(value: string) { + update(value: string) { state.text = value } } - //view - let Editor = { - view: function() { + // view + const Editor = { + view() { return [ m("textarea.input", { oninput: m.withAttr("value", state.update), @@ -586,69 +570,67 @@ const FRAME_BUDGET = 100 } } - m.mount(document.getElementById("editor"), Editor) - -}) + m.mount(document.getElementById("editor")!, Editor) +} //////////////////////////////////////////////////////////////////////////////// // https://github.com/lhorie/mithril.js/blob/master/examples/todomvc/todomvc.js //////////////////////////////////////////////////////////////////////////////// -;(function() { - - //model - let state = { - dispatch: function(action: string, args?: any) { - (state)[action].apply(state, args || []) - requestAnimationFrame(function() { +{ + // model + const state = { + dispatch(action: string, args?: any) { + (state as any)[action].apply(state, args || []) + requestAnimationFrame(() => { localStorage["todos-mithril"] = JSON.stringify(state.todos) }) }, todos: JSON.parse(localStorage["todos-mithril"] || "[]"), - editing: null, + editing: null as any, filter: "", remaining: 0, - todosByStatus: [], - showing: undefined, + todosByStatus: [] as any[], + showing: undefined as any, - createTodo: function(title: string) { + createTodo(title: string) { state.todos.push({title: title.trim(), completed: false}) }, - setStatuses: function(completed: boolean) { + setStatuses(completed: boolean) { for (let i = 0; i < state.todos.length; i++) state.todos[i].completed = completed }, - setStatus: function(todo: any, completed: boolean) { + setStatus(todo: any, completed: boolean) { todo.completed = completed }, - destroy: function(todo: any) { - let index = state.todos.indexOf(todo) + destroy(todo: any) { + const index = state.todos.indexOf(todo) if (index > -1) state.todos.splice(index, 1) }, - clear: function() { + clear() { for (let i = 0; i < state.todos.length; i++) { if (state.todos[i].completed) state.destroy(state.todos[i--]) } }, - edit: function(todo: any) { + edit(todo: any) { state.editing = todo }, - update: function(title: string) { + update(title: string) { if (state.editing != null) { state.editing.title = title.trim() if (state.editing.title === "") state.destroy(state.editing) state.editing = null } }, - reset: function() { + reset() { state.editing = null }, - computed: function(vnode: m.Vnode) { + computed(vnode: m.Vnode) { state.showing = vnode.attrs.status || "" - state.remaining = state.todos.filter(function(todo: any) {return !todo.completed}).length - state.todosByStatus = state.todos.filter(function(todo: any) { + state.remaining = state.todos.filter((todo: any) => !todo.completed).length + state.todosByStatus = state.todos.filter((todo: any) => { switch (state.showing) { case "": return true case "active": return !todo.completed @@ -658,41 +640,42 @@ const FRAME_BUDGET = 100 } } - //view - let Todos: m.Comp<{}, { + // view + const Todos: m.Comp<{}, { add(e: Event): void toggleAll(): void toggle(todo: any): void focus(vnode: m.VnodeDOM, todo: any): void save(e: KeyboardEvent): void }> = { - add: function(e: KeyboardEvent) { + add(e: KeyboardEvent) { if (e.keyCode === 13) { - state.dispatch("createTodo", [(e.target).value]); - (e.target).value = "" + state.dispatch("createTodo", [(e.target as HTMLInputElement).value]); + (e.target as HTMLInputElement).value = "" } }, - toggleAll: function() { - state.dispatch("setStatuses", [(document.getElementById("toggle-all")).checked]) + toggleAll() { + state.dispatch("setStatuses", [(document.getElementById("toggle-all") as HTMLInputElement).checked]) }, - toggle: function(todo: any) { + toggle(todo: any) { state.dispatch("setStatus", [todo, !todo.completed]) }, - focus: function(vnode: m.VnodeDOM, todo: any) { + focus(vnode: m.VnodeDOM, todo: any) { if (todo === state.editing && vnode.dom !== document.activeElement) { - (vnode.dom).value = todo.title - (vnode.dom).focus() - (vnode.dom).selectionStart = (vnode.dom).selectionEnd = todo.title.length + const el = vnode.dom as HTMLInputElement + el.value = todo.title + el.focus() + el.selectionStart = el.selectionEnd = todo.title.length } }, - save: function(e: KeyboardEvent) { - if (e.keyCode === 13 || e.type === "blur") state.dispatch("update", [(e.target).value]) + save(e: KeyboardEvent) { + if (e.keyCode === 13 || e.type === "blur") state.dispatch("update", [(e.target as HTMLInputElement).value]) else if (e.keyCode === 27) state.dispatch("reset") }, oninit: state.computed, onbeforeupdate: state.computed, - view: function(vnode) { - let ui = vnode.state + view(vnode) { + const ui = vnode.state return [ m("header.header", [ m("h1", "todos"), @@ -702,14 +685,14 @@ const FRAME_BUDGET = 100 m("input#toggle-all[type='checkbox']", {checked: state.remaining === 0, onclick: ui.toggleAll}), m("label[for='toggle-all']", {onclick: ui.toggleAll}, "Mark all as complete"), m("ul#todo-list", [ - state.todosByStatus.map(function(todo: any) { + state.todosByStatus.map((todo: any) => { return m("li", {class: (todo.completed ? "completed" : "") + " " + (todo === state.editing ? "editing" : "")}, [ m(".view", [ - m("input.toggle[type='checkbox']", {checked: todo.completed, onclick: function() {ui.toggle(todo)}}), - m("label", {ondblclick: function() {state.dispatch("edit", [todo])}}, todo.title), - m("button.destroy", {onclick: function() {state.dispatch("destroy", [todo])}}), + m("input.toggle[type='checkbox']", {checked: todo.completed, onclick: () => {ui.toggle(todo)}}), + m("label", {ondblclick: () => {state.dispatch("edit", [todo])}}, todo.title), + m("button.destroy", {onclick: () => {state.dispatch("destroy", [todo])}}), ]), - m("input.edit", {onupdate: function(vnode: m.VnodeDOM) {ui.focus(vnode, todo)}, onkeypress: ui.save, onblur: ui.save}) + m("input.edit", {onupdate(vnode: m.VnodeDOM) {ui.focus(vnode, todo)}, onkeypress: ui.save, onblur: ui.save}) ]) }), ]), @@ -724,7 +707,7 @@ const FRAME_BUDGET = 100 m("li", m("a[href='/active']", {oncreate: m.route.link, class: state.showing === "active" ? "selected" : ""}, "Active")), m("li", m("a[href='/completed']", {oncreate: m.route.link, class: state.showing === "completed" ? "selected" : ""}, "Completed")), ]), - m("button#clear-completed", {onclick: function() {state.dispatch("clear")}}, "Clear completed"), + m("button#clear-completed", {onclick: () => {state.dispatch("clear")}}, "Clear completed"), ]) : null, ] } @@ -734,5 +717,4 @@ const FRAME_BUDGET = 100 "/": Todos, "/:status": Todos, }) - -}) +} diff --git a/types/mithril/test/test-component.ts b/types/mithril/test/test-component.ts index 060997b555..c97c9eafeb 100644 --- a/types/mithril/test/test-component.ts +++ b/types/mithril/test/test-component.ts @@ -85,12 +85,12 @@ interface Comp4Attrs { interface Comp4State { count: number - add: (this: Comp4State, num: number) => void + add(this: Comp4State, num: number): void } // Either of these two Comp4 defs will work: type Comp4 = Component & Comp4State -//interface Comp4 extends Component, Comp4State {} +// interface Comp4 extends Component, Comp4State {} const comp4: Comp4 = { count: 0, // <- Must be declared to satisfy Comp4 type which includes Comp4State type @@ -138,7 +138,6 @@ const comp5: Component = { } } - /////////////////////////////////////////////////////////// // // Concise module example with default export diff --git a/types/mithril/tslint.json b/types/mithril/tslint.json index 2c473fb8ea..b3c768774e 100644 --- a/types/mithril/tslint.json +++ b/types/mithril/tslint.json @@ -1,47 +1,15 @@ { + "extends": "../tslint.json", "rules": { - "class-name": true, - "comment-format": [ - false, - "check-space" - ], - "indent": [ - true, - "tabs" - ], - "no-duplicate-variable": true, - "no-eval": true, - "no-internal-module": false, - "no-trailing-whitespace": true, - "no-var-keyword": true, - "one-line": [ - true, - "check-open-brace", - "check-whitespace" - ], - "quotemark": [ - false, - "double" - ], + "array-type": [false, "array"], + "quotemark": [false, "double"], "semicolon": [false, "always"], - "triple-equals": [ - true, - "allow-null-check" - ], - "typedef-whitespace": [ - false, - { - "call-signature": "nospace", - "index-signature": "nospace", - "parameter": "nospace", - "property-declaration": "nospace", - "variable-declaration": "nospace" - } - ], - "variable-name": [ - true, - "ban-keywords" - ], + "space-before-function-paren": [false, "always"], + "max-line-length": [false, 200], + "no-empty-interface": false, + "no-redundant-modifiers": false, + "prefer-for-of": false, + "unified-signatures": false, "whitespace": [ false, "check-branch", @@ -51,4 +19,4 @@ "check-type" ] } -} \ No newline at end of file +} From 9fb63b71118c3f442ed96d94a3b827603f497cb3 Mon Sep 17 00:00:00 2001 From: Kevin Date: Thu, 30 Mar 2017 00:25:44 -0400 Subject: [PATCH 069/844] Removed optional parameter from lstat The optional flag on the callback version of lstat causes tsc to complain about using as promise. It always assumes to first variant which does not return a Promise. You can see the `stat` and `fstat` have it removed. I am very confident this is the intended behaviour, and the optional flag is a copy-paste typo. --- types/mz/fs.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/types/mz/fs.d.ts b/types/mz/fs.d.ts index 975850c3ab..ff7222acee 100644 --- a/types/mz/fs.d.ts +++ b/types/mz/fs.d.ts @@ -142,7 +142,7 @@ export function stat(path: string | Buffer): Promise; * `lstat()` is identical to `stat()`, except that if path is a symbolic link, then the link itself * is stat-ed, not the file that it refers to. */ -export function lstat(path: string | Buffer, callback?: (err: NodeJS.ErrnoException, stats: fs.Stats) => any): void; +export function lstat(path: string | Buffer, callback: (err: NodeJS.ErrnoException, stats: fs.Stats) => any): void; /** * Asynchronous `lstat(2)`. @@ -502,4 +502,4 @@ export function access(path: string | Buffer, callback: (err: NodeJS.ErrnoExcept * @param path The path to access. * @param mode An optional integer that specifies the accessibility checks to be performed. */ -export function access(path: string, mode?: number): Promise; \ No newline at end of file +export function access(path: string, mode?: number): Promise; From 66df4cafa960207cc8bd9f60f881976475649704 Mon Sep 17 00:00:00 2001 From: Jens Duttke Date: Thu, 30 Mar 2017 09:39:15 +0200 Subject: [PATCH 070/844] requirejs: RequireError.requireModules can be null In the require.js source code (line 901 in v2.3.3), requireModules is set to `null`. --- types/requirejs/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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). From ce331bb0a8d73c703747dd556a9b8c1f9bbe5fc8 Mon Sep 17 00:00:00 2001 From: Minghao Ni Date: Thu, 30 Mar 2017 15:57:15 +0800 Subject: [PATCH 071/844] add requireInteraction field in NotificationOptions, used in chrome.notification.* apis --- types/chrome/index.d.ts | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/types/chrome/index.d.ts b/types/chrome/index.d.ts index 8c0c3bf5f2..dba15539a4 100644 --- a/types/chrome/index.d.ts +++ b/types/chrome/index.d.ts @@ -4269,6 +4269,12 @@ declare namespace chrome.notifications { appIconMaskUrl?: string; /** Optional. A URL to the image thumbnail for image-type notifications. URLs have the same restrictions as iconUrl. */ imageUrl?: string; + /** + * Indicates that the notification should remain visible on screen until the user activates or dismisses the notification. + * This defaults to false. + * @since Chrome 50 + */ + requireInteraction?: boolean; } interface NotificationClosedEvent extends chrome.events.Event<(notificationId: string, byUser: boolean) => void> {} From 56dbbbfb6ea15052c095ce5b8b8446eb5a89a5e3 Mon Sep 17 00:00:00 2001 From: Syncfusion-JavaScript Date: Thu, 30 Mar 2017 14:14:45 +0530 Subject: [PATCH 072/844] 15.1.0.41 typings added. --- types/ej.web.all/ej.web.all-tests.ts | 180 +- types/ej.web.all/index.d.ts | 7383 ++++++++++++++------------ 2 files changed, 4031 insertions(+), 3532 deletions(-) diff --git a/types/ej.web.all/ej.web.all-tests.ts b/types/ej.web.all/ej.web.all-tests.ts index 50b4c117e4..cae7001218 100644 --- a/types/ej.web.all/ej.web.all-tests.ts +++ b/types/ej.web.all/ej.web.all-tests.ts @@ -20,7 +20,7 @@ module AccordionComponent { }); } - + module AutocompleteComponent{ var carList = [ @@ -44,15 +44,15 @@ module AutocompleteComponent{ "Triumph Spitfire", "Toyota 2000GT", "Volvo P1800", "Volkswagen Shirako" ]; - $(function () { - var autocompleteInstance =new ej.Autocomplete($("#selectCar"), { + $(function () { + var autocompleteInstance =new ej.Autocomplete($("#selectCar"), { width: "100%", watermarkText: "Select a car", dataSource: carList, enableAutoFill: true, showPopupButton: true, multiSelectMode: "delimiter" - }); + }); }); } @@ -150,7 +150,7 @@ module ButtonComponent { }); }); } - + @@ -166,7 +166,7 @@ module ChartComponent { range: { min: 25, max: 50, interval: 5 }, labelFormat: "{value}%", title: { text: "Efficiency" }, - + }, commonSeriesOptions: { @@ -181,28 +181,28 @@ module ChartComponent { }, visible: true }, - border : {width: 2} - }, - series: + border : {width: 2} + }, + series: [ { - points: [{ x: 2005, y: 28 }, { x: 2006, y: 25 },{ x: 2007, y: 26 }, { x: 2008, y: 27 }, - { x: 2009, y: 32 }, { x: 2010, y: 35 }, { x: 2011, y: 30 }], + points: [{ x: 2005, y: 28 }, { x: 2006, y: 25 },{ x: 2007, y: 26 }, { x: 2008, y: 27 }, + { x: 2009, y: 32 }, { x: 2010, y: 35 }, { x: 2011, y: 30 }], name: 'India' - }, + }, { - points: [{ x: 2005, y: 31 }, { x: 2006, y: 28 },{ x: 2007, y: 30 }, { x: 2008, y: 36 }, - { x: 2009, y: 36 }, { x: 2010, y: 39 }, { x: 2011, y: 37 }], + points: [{ x: 2005, y: 31 }, { x: 2006, y: 28 },{ x: 2007, y: 30 }, { x: 2008, y: 36 }, + { x: 2009, y: 36 }, { x: 2010, y: 39 }, { x: 2011, y: 37 }], name: 'Germany' }, { - points: [{ x: 2005, y: 36 }, { x: 2006, y: 32 },{ x: 2007, y: 34 }, { x: 2008, y: 41 }, - { x: 2009, y: 42 }, { x: 2010, y: 42 }, { x: 2011, y: 43 }], + points: [{ x: 2005, y: 36 }, { x: 2006, y: 32 },{ x: 2007, y: 34 }, { x: 2008, y: 41 }, + { x: 2009, y: 42 }, { x: 2010, y: 42 }, { x: 2011, y: 43 }], name: 'England' - }, + }, { - points: [{ x: 2005, y: 39 }, { x: 2006, y: 36 },{ x: 2007, y: 40 }, { x: 2008, y: 44 }, - { x: 2009, y: 45 }, { x: 2010, y: 48 }, { x: 2011, y: 46 }], + points: [{ x: 2005, y: 39 }, { x: 2006, y: 36 },{ x: 2007, y: 40 }, { x: 2008, y: 44 }, + { x: 2009, y: 45 }, { x: 2010, y: 48 }, { x: 2011, y: 46 }], name: 'France' } ], @@ -290,7 +290,7 @@ module circulargaugecomponent { backgroundColor: "#f5b43f", border: { color: "#f5b43f" } }] - }] + }] }); }); } @@ -377,7 +377,7 @@ $(function () { createConnector({ name: "connector6", sourceNode: "Project", targetNode: "Resources", labels: [createLabel({ "text": "No" })] }) ] }); - + }); function createNode(option: ej.datavisualization.Diagram.Node) { @@ -402,7 +402,7 @@ function createLabel(options : any) { return options; } - + module DialogComponent { $(function () { @@ -452,7 +452,7 @@ module digitalgaugecomponent { } - + @@ -472,12 +472,12 @@ module DropDownListComponent { enableFilterSearch: true, caseSensitiveSearch: true, enableIncrementalSearch: true, - enablePopupResize: true, + enablePopupResize: true, delimiterChar: ";", multiSelectMode: ej.MultiSelectMode.Delimiter, maxPopupHeight: "300px", - minPopupHeight: "150px", - maxPopupWidth: "500px", + minPopupHeight: "150px", + maxPopupWidth: "500px", minPopupWidth: "350px", showCheckbox: true, showRoundedCorner: true @@ -513,7 +513,7 @@ module GanttComponent { dataSource: (window).projectData, allowColumnResize: true, allowSorting: true, - allowSelection: true, + allowSelection: true, enableContextMenu: true, taskIdMapping: "taskID", allowDragAndDrop: true, @@ -554,7 +554,7 @@ module GanttComponent { treeColumnIndex: 1, isResponsive: true, }); -}); +}); } @@ -596,7 +596,7 @@ module GridComponent { -var columns = ["Vegie-spread", "Tofuaa", "Alice Mutton", "Konbu", "Fløtemysost"] +var columns = ["Vegie-spread", "Tofuaa", "Alice Mutton", "Konbu", "Fløtemysost"] var itemSource: any[] = []; for (var i = 0; i < columns.length; i++) { for (var j = 0; j < 6; j++) { @@ -670,7 +670,7 @@ module KanbanComponent { }); } - + module lineargaugecomponent { @@ -696,14 +696,14 @@ module lineargaugecomponent { backgroundColor: "#E94649", border: { color: "#E94649" }, startWidth: 4, endWidth: 4 }] - }] + }] }); }); } + - - + module ListBoxComponent { $(function () { @@ -713,12 +713,12 @@ module ListBoxComponent { }); } - + module ListviewComponent { $(function () { var listviewInstance = new ej.ListView($("#defaultlistview"), { - enableCheckMark: true, + enableCheckMark: true, width: 400 }); }); @@ -760,7 +760,7 @@ var world_map= { "type": "Feature", "properties": { "admin": "Switzerland", "name": "Switzerland", "continent": "Europe" }, "geometry": { "type": "Polygon", "coordinates": [[[9.594226108446346, 47.525058091820256], [9.632931756232974, 47.347601223329974], [9.479969516649019, 47.102809963563367], [9.932448357796657, 46.920728054382948], [10.442701450246627, 46.893546250997424], [10.36337812667861, 46.483571275409851], [9.922836541390378, 46.314899400409182], [9.182881707403054, 46.440214748716976], [8.966305779667804, 46.036931871111186], [8.489952426801322, 46.005150865251672], [8.316629672894377, 46.163642483090847], [7.755992058959832, 45.824490057959302], [7.273850945676655, 45.776947740250769], [6.843592970414504, 45.991146552100595], [6.500099724970424, 46.429672756529428], [6.022609490593537, 46.272989813820466], [6.037388950229, 46.725778713561859], [6.768713820023605, 47.287708238303686], [6.736571079138058, 47.541801255882838], [7.192202182655505, 47.449765529971003], [7.466759067422228, 47.620581976911794], [8.31730146651415, 47.613579820336255], [8.522611932009765, 47.830827541691285], [9.594226108446346, 47.525058091820256]]] } }, { "type": "Feature", "properties": { "admin": "Chile", "name": "Chile", "continent": "South America" }, "geometry": { "type": "MultiPolygon", "coordinates": [[[[-68.634010227583147, -52.636370458874353], [-68.633349999999879, -54.8695], [-67.56244, -54.87001], [-66.95992, -54.89681], [-67.291029999999878, -55.30124], [-68.148629999999841, -55.61183], [-68.639990810811796, -55.580017999086877], [-69.2321, -55.49906], [-69.95809, -55.19843], [-71.00568, -55.05383], [-72.2639, -54.49514], [-73.2852, -53.957519999999874], [-74.66253, -52.83749], [-73.8381, -53.04743], [-72.43418, -53.7154], [-71.10773, -54.07433], [-70.591779999999787, -53.61583], [-70.26748, -52.93123], [-69.345649999999878, -52.5183], [-68.634010227583147, -52.636370458874353]]], [[[-68.219913092711224, -21.49434661223183], [-67.828179897722634, -22.872918796482178], [-67.106673550063604, -22.735924574476392], [-66.985233934177629, -22.986348565362825], [-67.328442959244128, -24.025303236590908], [-68.417652960876111, -24.518554782816874], [-68.386001146097342, -26.185016371365229], [-68.594799770772667, -26.50690886811126], [-68.295541551370391, -26.899339694935787], [-69.001234910748266, -27.521213881136127], [-69.656130337183143, -28.459141127233686], [-70.013550381129861, -29.367922865518544], [-69.919008348251921, -30.336339206668306], [-70.535068935819439, -31.365010267870279], [-70.074399380153622, -33.09120981214803], [-69.814776984319209, -33.273886000299839], [-69.817309129501453, -34.193571465798279], [-70.388049485949082, -35.169687595359441], [-70.364769253201658, -36.005088799789931], [-71.121880662709771, -36.65812387466233], [-71.118625047475419, -37.576827487947192], [-70.814664272734703, -38.552995293940732], [-71.413516608349042, -38.916022230791107], [-71.680761277946445, -39.808164157878061], [-71.915734015577542, -40.832339369470716], [-71.746803758415453, -42.051386407235988], [-72.148898078078517, -42.254888197601375], [-71.915423956983901, -43.408564548517404], [-71.464056159130493, -43.787611179378324], [-71.793622606071935, -44.207172133156099], [-71.329800788036195, -44.407521661151677], [-71.222778896759721, -44.784242852559409], [-71.659315558545316, -44.973688653341434], [-71.552009446891233, -45.560732924177117], [-71.917258470330196, -46.884838148791786], [-72.44735531278026, -47.738532810253517], [-72.331160854771937, -48.244238376661819], [-72.648247443314929, -48.878618259476774], [-73.415435757120022, -49.318436374712952], [-73.328050910114456, -50.378785088909865], [-72.975746832964617, -50.741450290734299], [-72.309973517532342, -50.677009779666342], [-72.329403856074023, -51.425956312872394], [-71.914803839796321, -52.009022305865912], [-69.498362189396076, -52.142760912637236], [-68.571545376241332, -52.299443855346247], [-69.461284349226617, -52.291950772663924], [-69.94277950710611, -52.537930590373243], [-70.8451016913545, -52.899200528525711], [-71.006332160105217, -53.833252042201345], [-71.429794684520928, -53.856454760300373], [-72.557942877884855, -53.531410001184447], [-73.702756720662862, -52.835069268607249], [-73.702756720662862, -52.835070076051487], [-74.946763475225154, -52.262753588419017], [-75.260026007778507, -51.62935475037321], [-74.976632453089806, -51.043395684615675], [-75.47975419788348, -50.378371677451547], [-75.608015102831942, -48.673772881871784], [-75.182769741502128, -47.711919447623153], [-74.126580980104677, -46.939253431995084], [-75.644395311165439, -46.647643324572016], [-74.69215369332305, -45.76397633238097], [-74.351709357384252, -44.10304412208788], [-73.240356004515192, -44.454960625995611], [-72.717803921179765, -42.383355808278985], [-73.388899909138232, -42.117532240569567], [-73.701335618774834, -43.365776462579738], [-74.33194312203257, -43.224958184584395], [-74.017957119427152, -41.794812920906828], [-73.677099372029943, -39.942212823243111], [-73.217592536090663, -39.258688653318508], [-73.505559455037044, -38.282882582351064], [-73.588060879191076, -37.156284681956016], [-73.166717088499283, -37.123780206044351], [-72.553136969681717, -35.508840020491022], [-71.861732143832555, -33.909092706031522], [-71.438450486929895, -32.418899428030819], [-71.668720669222424, -30.920644626592516], [-71.370082567007714, -30.095682061484997], [-71.48989437527645, -28.861442152625909], [-70.905123867461569, -27.640379734001193], [-70.724953986275963, -25.705924167587209], [-70.403965827095035, -23.628996677344542], [-70.091245897080668, -21.393319187101223], [-70.164419725205974, -19.756468194256183], [-70.372572394477714, -18.347975355708879], [-69.858443569605797, -18.092693780187027], [-69.590423753523979, -17.580011895419286], [-69.100246955019401, -18.260125420812653], [-68.966818406841824, -18.981683444904089], [-68.442225104430918, -19.405068454671419], [-68.757167121033703, -20.37265797290447], [-68.219913092711224, -21.49434661223183]]]] } }, { "type": "Feature", "properties": { "admin": "China", "name": "China", "continent": "Asia" }, "geometry": { "type": "MultiPolygon", "coordinates": [[[[110.339187860151526, 18.678395087147603], [109.475209588663702, 18.19770091396861], [108.655207961056135, 18.507681993071397], [108.626217482540426, 19.367887885001974], [109.119055617308007, 19.821038519769385], [110.211598748822837, 20.101253973872073], [110.786550734502228, 20.077534491450077], [111.01005130416462, 19.695929877190732], [110.570646600386794, 19.255879218009305], [110.339187860151526, 18.678395087147603]]], [[[127.657407261262378, 49.760270494172929], [129.397817824420429, 49.440600084015429], [130.58229332898236, 48.729687404976112], [130.987281528853828, 47.790132351261391], [132.506671991099495, 47.788969631534876], [133.373595819228001, 48.183441677434914], [135.026311476786702, 48.478229885443902], [134.500813836810607, 47.578439846377833], [134.112362095272601, 47.212467352886719], [133.76964399631288, 46.116926988299056], [133.097126906466428, 45.14406647397216], [131.883454217659562, 45.32116160743643], [131.025212030156069, 44.967953192721573], [131.288555129115537, 44.111519680348252], [131.144687941614848, 42.929989732426932], [130.633866408409801, 42.903014634770543], [130.640015903852429, 42.39500946712527], [129.994267205933227, 42.985386867843793], [129.596668735879462, 42.424981797854592], [128.05221520397231, 41.994284572917984], [128.208433058790717, 41.466771552082534], [127.343782993683021, 41.503151760415953], [126.869083286649854, 41.816569322266155], [126.18204511932943, 41.107336127276362], [125.079941847840587, 40.569823716792449], [124.265624627785314, 39.928493353834135], [122.86757042856101, 39.637787583976255], [122.131387974130917, 39.170451768544623], [121.054554478032856, 38.89747101496291], [121.585994907722466, 39.360853583324136], [121.376757033372641, 39.750261338859524], [122.168595005381007, 40.422442531896046], [121.640358514493528, 40.946389878903304], [120.768628778161954, 40.593388169917596], [119.639602085449056, 39.898055935214209], [119.023463983233015, 39.252333075511096], [118.042748651197897, 39.204273993479674], [117.532702264477052, 38.73763580988409], [118.05969852098967, 38.061475531561051], [118.878149855628351, 37.897325344385898], [118.911636183753501, 37.448463853498723], [119.702802362142037, 37.156388658185072], [120.823457472823648, 37.870427761377968], [121.711258579597938, 37.481123358707165], [122.357937453298462, 37.454484157860684], [122.519994744965814, 36.930614325501828], [121.104163853033029, 36.651329047180432], [120.63700890511457, 36.111439520811125], [119.66456180224607, 35.609790554337728], [119.151208123858567, 34.909859117160458], [120.227524855633717, 34.360331936168613], [120.620369093916565, 33.37672272392512], [121.229014113450219, 32.460318711877186], [121.908145786630044, 31.692174384074683], [121.891919386890336, 30.949351508095098], [121.264257440273298, 30.676267401648712], [121.503519321784722, 30.14291494396425], [122.092113885589086, 29.832520453403156], [121.93842817595305, 29.018022365834803], [121.684438511238469, 28.225512600206677], [121.125661248866436, 28.135673122667178], [120.395473260582307, 27.053206895449385], [119.585496860839555, 25.740780544532605], [118.656871372554519, 24.547390855400234], [117.281606479970833, 23.624501451099714], [115.890735304835118, 22.782873236578094], [114.763827345846209, 22.668074042241663], [114.152546828265656, 22.223760077396204], [113.806779819800752, 22.548339748621423], [113.241077915501592, 22.051367499270462], [111.843592157032447, 21.550493679281512], [110.78546552942413, 21.39714386645533], [110.444039341271662, 20.34103261970639], [109.88986128137357, 20.282457383703441], [109.627655063924635, 21.008227037026725], [109.864488153118316, 21.395050970947516], [108.522812941524421, 21.715212307211821], [108.050180291782979, 21.552379869060101], [107.043420037872636, 21.8118989120299], [106.567273390735352, 22.21820486092474], [106.725403273548466, 22.794267889898375], [105.811247186305209, 22.976892401617899], [105.329209425886631, 23.352063300056976], [104.476858351664475, 22.819150092046918], [103.504514601660503, 22.703756618739217], [102.706992222100155, 22.708795070887696], [102.170435825613552, 22.464753119389336], [101.652017856861576, 22.318198757409554], [101.803119744882906, 21.174366766845051], [101.27002566936001, 21.201651923095167], [101.180005324307558, 21.436572984294052], [101.150032993578236, 21.849984442629015], [100.416537713627349, 21.558839423096654], [99.983489211021549, 21.742936713136451], [99.240898878987196, 22.118314317304559], [99.53199222208741, 22.949038804612591], [98.898749220782804, 23.142722072842581], [98.66026248575578, 24.063286037690002], [97.604719679762027, 23.897404690033049], [97.724609002679131, 25.083637193293036], [98.671838006589212, 25.91870250091349], [98.712093947344556, 26.743535874940243], [98.682690057370507, 27.508812160750658], [98.246230910233351, 27.747221381129172], [97.91198774616943, 28.335945136014367], [97.327113885490007, 28.261582749946339], [96.248833449287829, 28.411030992134467], [96.586590610747521, 28.830979519154361], [96.117678664131006, 29.452802028922513], [95.404802280664626, 29.031716620392157], [94.565990431702929, 29.27743805593996], [93.413347609432662, 28.640629380807233], [92.503118931043616, 27.896876329046442], [91.696656528696693, 27.771741848251615], [91.258853794319876, 28.040614325466343], [90.730513950567797, 28.064953925075738], [90.015828891971182, 28.296438503527177], [89.475810174521158, 28.042758897406365], [88.814248488320573, 27.299315904239389], [88.730325962278528, 28.086864732367552], [88.120440708369941, 27.876541652939572], [86.954517043000635, 27.974261786403524], [85.823319940131526, 28.203575954698742], [85.011638218123053, 28.642773952747369], [84.23457970575015, 28.839893703724691], [83.89899295444674, 29.320226141877633], [83.337115106137176, 29.463731594352193], [82.327512648450877, 30.115268052688204], [81.525804477874786, 30.422716986608659], [81.111256138029276, 30.183480943313402], [79.721366815107118, 30.882714748654728], [78.738894484374001, 31.515906073527045], [78.458446486326025, 32.61816437431272], [79.176128777995544, 32.483779812137747], [79.208891636068543, 32.994394639613738], [78.811086460285722, 33.506198025032397], [78.912268914713209, 34.321936346975768], [77.83745079947461, 35.494009507787794], [76.192848341785705, 35.89840342868785], [75.896897414050173, 36.666806138651872], [75.158027785140987, 37.133030910789152], [74.980002475895404, 37.419990139305888], [74.829985792952144, 37.990007025701445], [74.864815708316783, 38.378846340481587], [74.25751427602269, 38.606506862943476], [73.928852166646394, 38.505815334622717], [73.675379266254836, 39.431236884105566], [73.960013055318427, 39.660008449861714], [73.822243686828315, 39.893973497063136], [74.776862420556043, 40.366425279291619], [75.467827996730719, 40.56207225194867], [76.526368035797432, 40.427946071935132], [76.90448449087711, 41.066485907549648], [78.187196893226044, 41.185315863604799], [78.543660923175253, 41.582242540038713], [80.119430373051401, 42.12394074153822], [80.259990268885318, 42.34999929459908], [80.180150180994374, 42.920067857426844], [80.866206496101213, 43.180362046881008], [79.966106398441426, 44.917516994804622], [81.947070753918084, 45.317027492853143], [82.458925815769035, 45.539649563166499], [83.180483839860543, 47.330031236350735], [85.164290399113213, 47.000955715516099], [85.720483839870667, 47.452969468773077], [85.76823286330837, 48.455750637396896], [86.59877648310335, 48.549181626980605], [87.359970330762692, 49.214980780629148], [87.751264276076668, 49.297197984405464], [88.013832228551678, 48.599462795600594], [88.854297723346747, 48.069081732773007], [90.280825636763893, 47.693549099307901], [90.970809360724957, 46.88814606382293], [90.585768263718307, 45.719716091487491], [90.945539585334316, 45.286073309910243], [92.133890822318222, 45.115075995456429], [93.480733677141316, 44.97547211362], [94.688928664125356, 44.352331854828456], [95.306875441471504, 44.241330878265458], [95.762454868556688, 43.319449164394619], [96.349395786527808, 42.725635280928643], [97.451757440177971, 42.74888967546007], [99.515817498779995, 42.524691473961688], [100.845865513108279, 42.663804429691417], [101.833040399179936, 42.51487295182627], [103.312278273534787, 41.907468166667613], [104.522281935649005, 41.90834666601662], [104.964993931093431, 41.597409572916334], [106.129315627061658, 42.134327704428891], [107.744772576937976, 42.481515814781908], [109.243595819131428, 42.519446316084149], [110.412103306115299, 42.871233628911014], [111.129682244920218, 43.406834011400171], [111.82958784388137, 43.743118394539486], [111.667737257943202, 44.073175767587706], [111.348376906379428, 44.457441718110047], [111.87330610560025, 45.102079372735112], [112.436062453258842, 45.01164561622425], [113.463906691544196, 44.808893134127111], [114.46033165899604, 45.339816799493875], [115.985096470200133, 45.727235012386004], [116.717868280098855, 46.38820241961524], [117.421701287914246, 46.67273285581421], [118.874325799638711, 46.805412095723646], [119.663269891438745, 46.692679958678944], [119.772823927897562, 47.048058783550132], [118.866574334794947, 47.747060044946195], [118.064142694166719, 48.06673045510373], [117.295507440257438, 47.697709052107385], [116.308952671373234, 47.853410142602812], [115.742837355615734, 47.726544501326273], [115.485282017073018, 48.135382595403442], [116.191802199367601, 49.134598090199056], [116.67880089728618, 49.888531399121398], [117.879244419426371, 49.510983384796944], [119.288460728025839, 50.142882798862033], [119.279365675942358, 50.582907619827282], [120.182049595216924, 51.64356639261802], [120.738191359541972, 51.964115302124547], [120.725789015791975, 52.516226304730814], [120.177088657716865, 52.753886216841195], [121.003084751470226, 53.251401068731226], [122.245747918792858, 53.431725979213681], [123.571506789240843, 53.458804429734627], [125.068211297710434, 53.161044826868832], [125.946348911646169, 52.792798570356936], [126.564399041856959, 51.784255479532689], [126.939156528837657, 51.353894151405896], [127.287455682484904, 50.739797268265434], [127.657407261262378, 49.760270494172929]]]] } }, - { "type": "Feature", "properties": { "admin": "Ivory Coast", "name": "CĂ´te d'Ivoire", "continent": "Africa" }, "geometry": { "type": "Polygon", "coordinates": [[[-2.856125047202397, 4.994475816259508], [-3.311084357100071, 4.984295559098014], [-4.008819545904941, 5.179813340674314], [-4.64991736491791, 5.168263658057084], [-5.834496222344525, 4.993700669775135], [-6.528769090185845, 4.705087795425015], [-7.518941209330434, 4.338288479017307], [-7.712159389669749, 4.364565944837721], [-7.63536821128403, 5.188159084489455], [-7.53971513511176, 5.313345241716517], [-7.570152553731686, 5.707352199725903], [-7.993692592795879, 6.126189683451541], [-8.311347622094017, 6.193033148621081], [-8.602880214868618, 6.467564195171659], [-8.385451626000572, 6.911800645368742], [-8.485445522485348, 7.395207831243068], [-8.439298468448696, 7.686042792181736], [-8.280703497744936, 7.687179673692156], [-8.221792364932197, 8.123328762235571], [-8.299048631208562, 8.316443589710302], [-8.203498907900878, 8.455453192575446], [-7.832100389019186, 8.575704250518625], [-8.079113735374348, 9.376223863152033], [-8.309616461612249, 9.789531968622439], [-8.22933712404682, 10.129020290563897], [-8.029943610048617, 10.206534939001711], [-7.89958980959237, 10.297382106970824], [-7.622759161804808, 10.147236232946792], [-6.850506557635057, 10.138993841996237], [-6.666460944027547, 10.430810655148447], [-6.493965013037267, 10.411302801958268], [-6.205222947606429, 10.524060777219132], [-6.050452032892266, 10.096360785355442], [-5.816926235365286, 10.222554633012191], [-5.404341599946973, 10.370736802609144], [-4.954653286143098, 10.152713934769732], [-4.779883592131966, 9.821984768101741], [-4.330246954760383, 9.610834865757139], [-3.980449184576684, 9.862344061721698], [-3.511898972986272, 9.900326239456216], [-2.827496303712706, 9.642460842319775], [-2.56218950032624, 8.219627793811481], [-2.983584967450326, 7.379704901555511], [-3.244370083011261, 6.2504715031135], [-2.810701463217839, 5.389051215024109], [-2.856125047202397, 4.994475816259508]]] } }, + { "type": "Feature", "properties": { "admin": "Ivory Coast", "name": "Côte d'Ivoire", "continent": "Africa" }, "geometry": { "type": "Polygon", "coordinates": [[[-2.856125047202397, 4.994475816259508], [-3.311084357100071, 4.984295559098014], [-4.008819545904941, 5.179813340674314], [-4.64991736491791, 5.168263658057084], [-5.834496222344525, 4.993700669775135], [-6.528769090185845, 4.705087795425015], [-7.518941209330434, 4.338288479017307], [-7.712159389669749, 4.364565944837721], [-7.63536821128403, 5.188159084489455], [-7.53971513511176, 5.313345241716517], [-7.570152553731686, 5.707352199725903], [-7.993692592795879, 6.126189683451541], [-8.311347622094017, 6.193033148621081], [-8.602880214868618, 6.467564195171659], [-8.385451626000572, 6.911800645368742], [-8.485445522485348, 7.395207831243068], [-8.439298468448696, 7.686042792181736], [-8.280703497744936, 7.687179673692156], [-8.221792364932197, 8.123328762235571], [-8.299048631208562, 8.316443589710302], [-8.203498907900878, 8.455453192575446], [-7.832100389019186, 8.575704250518625], [-8.079113735374348, 9.376223863152033], [-8.309616461612249, 9.789531968622439], [-8.22933712404682, 10.129020290563897], [-8.029943610048617, 10.206534939001711], [-7.89958980959237, 10.297382106970824], [-7.622759161804808, 10.147236232946792], [-6.850506557635057, 10.138993841996237], [-6.666460944027547, 10.430810655148447], [-6.493965013037267, 10.411302801958268], [-6.205222947606429, 10.524060777219132], [-6.050452032892266, 10.096360785355442], [-5.816926235365286, 10.222554633012191], [-5.404341599946973, 10.370736802609144], [-4.954653286143098, 10.152713934769732], [-4.779883592131966, 9.821984768101741], [-4.330246954760383, 9.610834865757139], [-3.980449184576684, 9.862344061721698], [-3.511898972986272, 9.900326239456216], [-2.827496303712706, 9.642460842319775], [-2.56218950032624, 8.219627793811481], [-2.983584967450326, 7.379704901555511], [-3.244370083011261, 6.2504715031135], [-2.810701463217839, 5.389051215024109], [-2.856125047202397, 4.994475816259508]]] } }, { "type": "Feature", "properties": { "admin": "Cameroon", "name": "Cameroon", "continent": "Africa" }, "geometry": { "type": "Polygon", "coordinates": [[[13.07582238124675, 2.267097072759014], [12.951333855855605, 2.321615708826939], [12.359380323952218, 2.19281220133945], [11.751665480199787, 2.326757513839993], [11.276449008843711, 2.261050930180871], [9.649158155972627, 2.283866075037735], [9.795195753629455, 3.073404445809117], [9.404366896205998, 3.734526882335202], [8.948115675501068, 3.904128933117135], [8.744923943729416, 4.352215277519959], [8.488815545290889, 4.495617377129917], [8.500287713259693, 4.771982937026847], [8.757532993208626, 5.47966583904791], [9.233162876023043, 6.444490668153334], [9.522705926154398, 6.453482367372116], [10.118276808318255, 7.038769639509879], [10.497375115611417, 7.055357774275562], [11.058787876030349, 6.644426784690593], [11.745774366918509, 6.981382961449753], [11.839308709366801, 7.397042344589434], [12.063946160539556, 7.799808457872301], [12.218872104550597, 8.305824082874322], [12.753671502339214, 8.717762762888993], [12.955467970438971, 9.417771714714702], [13.1675997249971, 9.64062632897341], [13.308676385153914, 10.160362046748926], [13.572949659894558, 10.798565985553564], [14.415378859116682, 11.572368882692071], [14.468192172918974, 11.90475169519341], [14.57717776862253, 12.085360826053501], [14.181336297266792, 12.483656927943112], [14.213530714584634, 12.802035427293344], [14.495787387762842, 12.859396267137326], [14.893385857816522, 12.219047756392582], [14.960151808337598, 11.555574042197222], [14.923564894274955, 10.891325181517471], [15.467872755605269, 9.982336737503429], [14.909353875394713, 9.99212942142273], [14.627200555081057, 9.920919297724536], [14.171466098699025, 10.021378282099928], [13.954218377344002, 9.549494940626685], [14.544466586981766, 8.965861314322266], [14.979995558337688, 8.796104234243471], [15.120865512765331, 8.382150173369423], [15.436091749745765, 7.692812404811971], [15.279460483469107, 7.421924546737968], [14.776545444404572, 6.408498033062044], [14.536560092841111, 6.22695872642069], [14.459407179429345, 5.451760565610299], [14.558935988023501, 5.03059764243153], [14.478372430080466, 4.732605495620446], [14.950953403389658, 4.21038930909492], [15.036219516671249, 3.851367295747123], [15.405395948964379, 3.335300604664339], [15.862732374747479, 3.013537298998982], [15.907380812247649, 2.557389431158612], [16.01285241055535, 2.267639675298084], [15.940918816805061, 1.727672634280295], [15.14634199388524, 1.964014797367184], [14.337812534246577, 2.22787466064949], [13.07582238124675, 2.267097072759014]]] } }, { "type": "Feature", "properties": { "admin": "Democratic Republic of the Congo", "name": "Dem. Rep. Congo", "continent": "Africa" }, "geometry": { "type": "Polygon", "coordinates": [[[30.833859897593801, 3.50916596111034], [30.773346795380036, 2.339883327642127], [31.174149204235807, 2.204465236821263], [30.852670118948048, 1.849396470543809], [30.468507521290292, 1.58380544677972], [30.086153598762703, 1.062312730306288], [29.875778842902488, 0.597379868976304], [29.819503208136634, -0.205310153813372], [29.587837762172164, -0.58740569417948], [29.579466180140876, -1.341313164885626], [29.29188683443661, -1.620055840667987], [29.254834832483336, -2.215109958508911], [29.117478875451546, -2.292211195488384], [29.02492638521678, -2.839257907730157], [29.276383904749046, -3.293907159034063], [29.339997592900342, -4.499983412294092], [29.519986606572925, -5.419978936386313], [29.41999271008816, -5.939998874539432], [29.620032179490003, -6.520015150583424], [30.199996779101692, -7.079980970898161], [30.740015496551781, -8.340007419470913], [30.34608605319081, -8.238256524288216], [29.002912225060467, -8.40703175215347], [28.734866570762495, -8.526559340044576], [28.449871046672818, -9.164918308146083], [28.673681674928922, -9.605924981324931], [28.496069777141763, -10.789883721564044], [28.372253045370421, -11.793646742401389], [28.642417433392346, -11.971568698782312], [29.341547885869087, -12.36074391037241], [29.616001417771223, -12.178894545137307], [29.699613885219485, -13.257226657771827], [28.934285922976834, -13.248958428605132], [28.52356163912102, -12.698604424696679], [28.15510867687998, -12.272480564017894], [27.38879886242378, -12.132747491100663], [27.164419793412456, -11.608748467661071], [26.55308759939961, -11.924439792532125], [25.752309604604726, -11.784965101776356], [25.418118116973197, -11.330935967659958], [24.783169793402948, -11.238693536018962], [24.314516228947948, -11.262826429899269], [24.257155389103982, -10.951992689663655], [23.912215203555714, -10.926826267137512], [23.456790805767433, -10.867863457892481], [22.837345411884733, -11.017621758674329], [22.402798292742371, -10.99307545333569], [22.155268182064304, -11.084801120653768], [22.208753289486388, -9.894796237836507], [21.87518191904234, -9.523707777548564], [21.801801385187897, -8.908706556842978], [21.949130893652036, -8.305900974158275], [21.746455926203303, -7.920084730667147], [21.728110792739695, -7.2908724910813], [20.514748162526498, -7.299605808138629], [20.601822950938292, -6.93931772219968], [20.091621534920645, -6.943090101756993], [20.037723016040214, -7.116361179231644], [19.417502475673157, -7.155428562044297], [19.166613396896107, -7.738183688999753], [19.016751743249664, -7.988245944860132], [18.464175652752683, -7.847014255406442], [18.134221632569048, -7.98767750410492], [17.472970004962232, -8.068551120641699], [17.089995965247166, -7.545688978712525], [16.860190870845198, -7.222297865429984], [16.573179965896141, -6.622644545115087], [16.326528354567042, -5.877470391466267], [13.375597364971892, -5.864241224799548], [13.02486941900696, -5.984388929878157], [12.735171339578695, -5.965682061388497], [12.322431674863507, -6.100092461779658], [12.182336866920249, -5.789930515163837], [12.436688266660866, -5.684303887559245], [12.468004184629734, -5.248361504745003], [12.631611769265788, -4.991271254092935], [12.995517205465173, -4.781103203961883], [13.258240187237044, -4.882957452009165], [13.600234816144676, -4.500138441590969], [14.144956088933295, -4.510008640158715], [14.209034864975219, -4.793092136253597], [14.582603794013179, -4.970238946150139], [15.170991652088441, -4.3435071753143], [15.753540073314749, -3.855164890156096], [16.006289503654298, -3.535132744972528], [15.972803175529149, -2.712392266453612], [16.407091912510051, -1.740927015798682], [16.86530683764212, -1.225816338713287], [17.523716261472853, -0.743830254726987], [17.638644646889983, -0.424831638189246], [17.663552687254676, -0.058083998213817], [17.826540154703245, 0.288923244626105], [17.774191928791563, 0.855658677571085], [17.89883548347958, 1.741831976728278], [18.09427575040743, 2.365721543788055], [18.39379235197114, 2.90044342692822], [18.453065219809925, 3.504385891123348], [18.542982211997778, 4.201785183118317], [18.932312452884755, 4.709506130385973], [19.467783644293146, 5.031527818212779], [20.290679152108932, 4.691677761245287], [20.927591180106273, 4.322785549329736], [21.659122755630019, 4.224341945813719], [22.405123732195531, 4.02916006104732], [22.704123569436284, 4.633050848810156], [22.841479526468103, 4.710126247573483], [23.297213982850135, 4.609693101414221], [24.41053104014625, 5.108784084489129], [24.805028924262409, 4.897246608902349], [25.128833449003274, 4.927244777847789], [25.278798455514302, 5.170408229997191], [25.650455356557465, 5.256087754737123], [26.402760857862535, 5.150874538590869], [27.044065382604703, 5.127852688004835], [27.374226108517483, 5.233944403500059], [27.979977247842807, 4.408413397637373], [28.428993768026906, 4.287154649264493], [28.696677687298795, 4.455077215996936], [29.159078403446497, 4.38926727947323], [29.715995314256013, 4.600804755060024], [29.953500197069467, 4.173699042167683], [30.833859897593801, 3.50916596111034]]] } }, { "type": "Feature", "properties": { "admin": "Republic of Congo", "name": "Congo", "continent": "Africa" }, "geometry": { "type": "Polygon", "coordinates": [[[12.995517205465173, -4.781103203961883], [12.620759718484491, -4.438023369976135], [12.318607618873923, -4.606230157086187], [11.914963006242086, -5.037986748884789], [11.093772820691923, -3.978826592630546], [11.855121697648114, -3.42687061932105], [11.478038771214299, -2.765618991714241], [11.820963575903189, -2.514161472181982], [12.495702752338159, -2.391688327650242], [12.575284458067639, -1.948511244315134], [13.109618767965626, -2.428740329603513], [13.992407260807706, -2.470804945489099], [14.299210239324564, -1.998275648612213], [14.425455763413593, -1.333406670744971], [14.316418491277741, -0.552627455247048], [13.843320753645653, 0.038757635901149], [14.276265903386953, 1.196929836426619], [14.026668735417214, 1.395677395021153], [13.282631463278816, 1.31418366129688], [13.003113641012074, 1.830896307783319], [13.07582238124675, 2.267097072759014], [14.337812534246577, 2.22787466064949], [15.14634199388524, 1.964014797367184], [15.940918816805061, 1.727672634280295], [16.01285241055535, 2.267639675298084], [16.537058139724135, 3.198254706226278], [17.133042433346297, 3.728196519379451], [17.809900343505259, 3.560196437998569], [18.453065219809925, 3.504385891123348], [18.39379235197114, 2.90044342692822], [18.09427575040743, 2.365721543788055], [17.89883548347958, 1.741831976728278], [17.774191928791563, 0.855658677571085], [17.826540154703245, 0.288923244626105], [17.663552687254676, -0.058083998213817], [17.638644646889983, -0.424831638189246], [17.523716261472853, -0.743830254726987], [16.86530683764212, -1.225816338713287], [16.407091912510051, -1.740927015798682], [15.972803175529149, -2.712392266453612], [16.006289503654298, -3.535132744972528], [15.753540073314749, -3.855164890156096], [15.170991652088441, -4.3435071753143], [14.582603794013179, -4.970238946150139], [14.209034864975219, -4.793092136253597], [14.144956088933295, -4.510008640158715], [13.600234816144676, -4.500138441590969], [13.258240187237044, -4.882957452009165], [12.995517205465173, -4.781103203961883]]] } }, @@ -983,7 +983,7 @@ module MenuComponent { - + module NavigationDrawerComponent { $(function () { @@ -1023,7 +1023,7 @@ module PivotChartOlap { $(function () { var sample = new ej.PivotChart($("#PivotChart"),{ dataSource: { - data: "http://bi.syncfusion.com/olap/msmdpump.dll", + data: "http://bi.syncfusion.com/olap/msmdpump.dll", catalog: "Adventure Works DW 2008 SE", cube: "Adventure Works", rows: [ @@ -1191,7 +1191,7 @@ module PivotGaugeOlap { length: 120, width: 7 }, - { + { type: "marker", markerType: "diamond", distanceFromScale: 5, @@ -1220,7 +1220,7 @@ module PivotGaugeOlap { distanceFromScale: -5, backgroundColor: "#fc0606", border: { color: "#fc0606" } - }, + }, { distanceFromScale: -5 }], @@ -1238,7 +1238,7 @@ module PivotGaugeOlap { }] }] }); - }); + }); } @@ -1312,7 +1312,7 @@ module PivotGaugeRelational { length: 120, width: 7 }, - { + { type: "marker", markerType: "diamond", distanceFromScale: 5, @@ -1341,7 +1341,7 @@ module PivotGaugeRelational { distanceFromScale: -5, backgroundColor: "#fc0606", border: { color: "#fc0606" } - }, + }, { distanceFromScale: -5 }], @@ -1359,7 +1359,7 @@ module PivotGaugeRelational { }] }] }); - }); + }); } @@ -1394,7 +1394,7 @@ module PivotGridOlap { ], filters:[] }, - enableGroupingBar: true, + enableGroupingBar: true, pivotTableFieldListID:"PivotSchemaDesigner" }); $("#PivotSchemaDesigner").ejPivotSchemaDesigner(); @@ -1445,7 +1445,7 @@ module PivotGridRelational { fieldCaption: "State" } ], - columns: + columns: [{ fieldName: "Product", fieldCaption: "Product" @@ -1463,10 +1463,10 @@ module PivotGridRelational { ], filters:[] }, - enableGroupingBar: true, + enableGroupingBar: true, pivotTableFieldListID:"PivotSchemaDesigner" }); - $("#PivotSchemaDesigner").ejPivotSchemaDesigner(); + $("#PivotSchemaDesigner").ejPivotSchemaDesigner(); }); } @@ -1607,7 +1607,7 @@ function redo(e: any) { } - + module RadialSliderComponent { $(function () { @@ -1640,7 +1640,7 @@ module rangecomponent { fill: '#69D2E7' } ]; - } + } }); }); @@ -1692,7 +1692,7 @@ module RatingComponent { shapeWidth: 25, showTooltip: true }); - + var sample2 = new ej.Rating($("#halfRating"),{ precision: ej.Rating.Precision.Half, value: 3.5, @@ -1723,7 +1723,7 @@ module RatingComponent { shapeHeight: 25, shapeWidth: 25, showTooltip: true - }); + }); }); } @@ -1756,7 +1756,7 @@ module RibbonComponent { toolTip: "Pin the Ribbon" }, applicationTab: { - type: ej.Ribbon.ApplicationTabType.Menu, menuItemID: "ribbonmenu", menuSettings: { openOnClick: false } + type: ej.Ribbon.ApplicationTabType.Menu, menuItemID: "ribbonmenu", menuSettings: { openOnClick: false } }, tabs: [{ id: "home", text: "HOME", groups: [{ @@ -1833,7 +1833,7 @@ module RibbonComponent { width: 60, isBig: false } - }] + }] }, { text: "Font", alignType: "rows", content: [{ @@ -2112,7 +2112,7 @@ module RibbonComponent { groups: [{ id: "zoomin", text: "Zoom In", - toolTip: "Zoom In", + toolTip: "Zoom In", buttonSettings: { width: 58, contentType: ej.ContentType.TextAndImage, @@ -2123,7 +2123,7 @@ module RibbonComponent { { id: "zoomout", text: "Zoom Out", - toolTip: "Zoom Out", + toolTip: "Zoom Out", buttonSettings: { width: 70, contentType: ej.ContentType.TextAndImage, @@ -2134,7 +2134,7 @@ module RibbonComponent { { id: "fullscreen", text: "Full Screen", - toolTip: "Full Screen", + toolTip: "Full Screen", buttonSettings: { width: 73, contentType: ej.ContentType.TextAndImage, @@ -2363,7 +2363,7 @@ module RibbonComponent { } ] } - ], + ], create: function createControl(args) { var ribbon = $("#defaultRibbon").data("ejRibbon"); $("#fontcolor").ejColorPicker({ value: "#FFFF00", modelType: "palette", cssClass: "e-ribbon", toolIcon: "e-fontcoloricon", select: colorHandler }); @@ -2379,7 +2379,7 @@ function colorHandler(args:any) { - + module RotatorComponent { $(function () { @@ -2542,7 +2542,7 @@ module ScheduleComponent { } }); }); -} +} @@ -2725,9 +2725,9 @@ module piesparkline4 { }); } + - - + module SplitterComponent { @@ -2762,7 +2762,7 @@ $(function () { pdfUrl: (window).baseurl + "api/Spreadsheet/PdfExport" }, sheets: [{ rangeSettings: [{ dataSource: (window).defaultData, startCell: "A1" }] }], - loadComplete: () => { + loadComplete: () => { var spreadsheet = $("#basicSpreadsheet").data("ejSpreadsheet"), xlFormat = spreadsheet.XLFormat; if (!(spreadsheet).isImport) { spreadsheet.setWidthToColumns([140, 128, 105, 100, 100, 110, 120, 120, 100]); @@ -2786,13 +2786,13 @@ var default_data: Array = [ { Category : "Employees", Country : "USA", JobDescription : "Technical", JobGroup : "Developers", JobRole : "Web", EmployeesCount : 70 }, { Category : "Employees", Country : "USA", JobDescription : "Management", EmployeesCount : 40 }, { Category : "Employees", Country : "USA", JobDescription : "Accounts", EmployeesCount : 60 }, - + { Category : "Employees", Country : "India", JobDescription : "Technical", JobGroup : "Testers", EmployeesCount : 43 }, { Category : "Employees", Country : "India", JobDescription : "Technical", JobGroup : "Developers", JobRole : "Windows", EmployeesCount : 125}, { Category : "Employees", Country : "India", JobDescription : "Technical", JobGroup : "Developers", JobRole : "Web", EmployeesCount : 60 }, { Category : "Employees", Country : "India", JobDescription : "HR Executives", EmployeesCount : 70 }, { Category : "Employees", Country : "India", JobDescription : "Accounts", EmployeesCount : 45 }, - + { Category : "Employees", Country : "Germany", JobDescription : "Sales", JobGroup : "Executive", EmployeesCount : 30 }, { Category : "Employees", Country : "Germany", JobDescription : "Sales", JobGroup : "Analyst", EmployeesCount : 40 }, { Category : "Employees", Country : "Germany", JobDescription : "Marketing", EmployeesCount : 50 }, @@ -2801,13 +2801,13 @@ var default_data: Array = [ { Category : "Employees", Country : "Germany", JobDescription : "Technical", JobGroup : "Developers", JobRole : "Web", EmployeesCount : 27 }, { Category : "Employees", Country : "Germany", JobDescription : "Management", EmployeesCount : 33 }, { Category : "Employees", Country : "Germany", JobDescription : "Accounts", EmployeesCount : 55 }, - + { Category : "Employees", Country : "UK", JobDescription : "Technical", JobGroup : "Testers", EmployeesCount : 45 }, { Category : "Employees", Country : "UK", JobDescription : "Technical", JobGroup : "Developers", JobRole : "Windows", EmployeesCount : 96 }, { Category : "Employees", Country : "UK", JobDescription : "Technical", JobGroup : "Developers", JobRole : "Web", EmployeesCount : 55 }, { Category : "Employees", Country : "UK", JobDescription : "HR Executives", EmployeesCount : 60 }, { Category : "Employees", Country : "UK", JobDescription: "Accounts", EmployeesCount: 30 }, - + { Category : "Employees", Country : "France", JobDescription : "Technical", JobGroup : "Testers", EmployeesCount : 40 }, { Category : "Employees", Country : "France", JobDescription : "Technical", JobGroup : "Developers", JobRole : "Windows", EmployeesCount : 65 }, { Category : "Employees", Country : "France", JobDescription : "Technical", JobGroup : "Developers", JobRole : "Web", EmployeesCount : 27 }, @@ -2817,7 +2817,7 @@ var default_data: Array = [ module sunburstcomponent { $(function () { var sunburstsample = new ej.SunburstChart($("#Sunburst"), { - valueMemberPath: "EmployeesCount", + valueMemberPath: "EmployeesCount", levels: [ {groupMemberPath: "Country"}, {groupMemberPath: "JobDescription"}, @@ -2856,8 +2856,8 @@ module TabComponent { module TagCloudComponent { - - + + var websiteCollection = [ { text: "Google", url: "http://www.google.com", frequency: 12 }, { text: "All Things Digital", url: "http://allthingsd.com/", frequency: 3 }, @@ -2888,7 +2888,7 @@ module TagCloudComponent { text: "text", url: "url", frequency: "frequency" } }); - + }); } @@ -2928,7 +2928,7 @@ module EditorComponent { - + module TileViewComponent { $(function () { @@ -2939,38 +2939,38 @@ module TileViewComponent { imageUrl:'content/images/tile/windows/people_1.png' }); var tile2 = new ej.Tile($("#tile2"), { - imagePosition:"center", + imagePosition:"center", tileSize:"small", - imageUrl:'content/images/tile/windows/alerts.png', - + imageUrl:'content/images/tile/windows/alerts.png', + }); var tile3 = new ej.Tile($("#tile3"), { - imagePosition:"center", + imagePosition:"center", tileSize:"small", - imageUrl:'content/images/tile/windows/bing.png', + imageUrl:'content/images/tile/windows/bing.png', }); var tile4 = new ej.Tile($("#tile4"), { tileSize:"small", - imageUrl:'content/images/tile/windows/camera.png', + imageUrl:'content/images/tile/windows/camera.png', }); var tile5 = new ej.Tile($("#tile5"), { - imagePosition:"center", + imagePosition:"center", tileSize:"small", - imageUrl:'content/images/tile/windows/messages.png', + imageUrl:'content/images/tile/windows/messages.png', }); var tile6 = new ej.Tile($("#tile6"), { - imagePosition:"center", + imagePosition:"center", tileSize:"medium", - imageUrl:'content/images/tile/windows/games.png', + imageUrl:'content/images/tile/windows/games.png', caption:{text:"Play"} }); - var tile7 = new ej.Tile($("#tile7"), { + var tile7 = new ej.Tile($("#tile7"), { tileSize:"medium", imageUrl:'content/images/tile/windows/map.png', caption:{text:"Maps"} }); var tile8 = new ej.Tile($("#tile8"), { - imagePosition:"fill", + imagePosition:"fill", tileSize:"wide", imageUrl:'content/images/tile/windows/sports.png', caption:{text:"Sports"} @@ -3022,7 +3022,7 @@ module TimePickerComponent { module ToolbarComponent { - + $(function () { var sample = new ej.Toolbar($("#editingToolbar"),{ width: "100%", @@ -3041,7 +3041,7 @@ module ToolbarComponent { module TooltipComponent { - + $(function () { var sample1 = new ej.Tooltip($("#link1"),{ @@ -3136,7 +3136,7 @@ module TreeGridComponent { isResponsive: true, }); }); -} +} @@ -3181,7 +3181,7 @@ module treemapcomponent { - + module TreeViewComponent { $(function () { @@ -3198,7 +3198,7 @@ module TreeViewComponent { module UploadboxComponent { - + $(function () { var sample = new ej.Uploadbox($("#UploadDefault"),{ saveUrl: "uploadbox/saveFiles.ashx", @@ -3232,4 +3232,4 @@ module WaitingPopupComponent { }); }); -} \ No newline at end of file +} diff --git a/types/ej.web.all/index.d.ts b/types/ej.web.all/index.d.ts index ca17c06c5a..8328f30d95 100644 --- a/types/ej.web.all/index.d.ts +++ b/types/ej.web.all/index.d.ts @@ -7,15 +7,16 @@ /*! * filename: ej.web.all.d.ts -* version : 15.1.0.37 +* version : 15.1.0.41 * Copyright Syncfusion Inc. 2001 - 2017. All rights reserved. * Use of this code is subject to the terms of our license. * A copy of the current license can be obtained at any time by e-mailing * licensing@syncfusion.com. Any infringement will be prosecuted under -* applicable laws. +* applicable laws. */ -declare namespace ej { - const dataUtil: dataUtil; +declare module ej { + + var dataUtil: dataUtil; function isMobile(): boolean; function isIOS(): boolean; function isAndroid(): boolean; @@ -28,33 +29,33 @@ declare namespace ej { function isTouchDevice(): boolean; function addPrefix(style: string): string; function animationEndEvent(): string; - function blockDefaultActions(e: any): void; - function buildTag(tag: string, innerHtml?: string, styles?: any, attrs?: any): JQuery; + function blockDefaultActions(e: Object): void; + function buildTag(tag: string, innerHtml?: string, styles?: Object, attrs?: Object): JQuery; function cancelEvent(): string; function copyObject(): string; - function createObject(nameSpace: string, value: any, initIn: any): JQuery; + function createObject(nameSpace: string, value: Object, initIn: any): JQuery; function createObject(element: any, eventEmitter: any, model: any): any; function setCulture(culture: string): void; - function getObject(element: string, model: any ): T; - function getObject(nameSpace: string, fromdata?: any): any; - function defineClass(className: string, constructor: any, proto: any, replace: boolean): any; - function destroyWidgets(element: any): void; + function getObject(element :string, model :any ): T; + function defineClass(className: string, constructor:any, proto: Object, replace: boolean): Object; + function destroyWidgets(element: Object): void; function endEvent(): string; - function event(type: string, data: any, eventProp: any): any; - function getAndroidVersion(): any; - function getAttrVal(ele: any, val: string, option: any): any; - function getBooleanVal(ele: any, val: string, option: any): any; + function event(type: string, data: any, eventProp: Object): Object; + function getAndroidVersion(): Object; + function getAttrVal(ele: Object, val: string, option: Object): Object; + function getBooleanVal(ele: Object, val: string, option: Object): Object; function getClearString(): string; - function getDimension(element: any, method: string): any; - function getFontString(fontObj: any): string; + function getDimension(element: Object, method: string): Object; + function getFontString(fontObj: Object): string; function getFontStyle(style: string): string; function getMaxZindex(): number; function getNameSpace(className: string): string; - function getOffset(ele: string): any; + function getObject(nameSpace: string, fromdata?: any): Object; + function getOffset(ele: string): Object; function getRenderMode(): string; - function getScrollableParents(element: any): void; + function getScrollableParents(element: Object): void; function getTheme(): string; - function getZindexPartial(element: any, popupEle: string): number; + function getZindexPartial(element: Object, popupEle: string): number; function hasRenderMode(element: string): void; function hasStyle(prop: string): boolean; function hasTheme(element: string): string; @@ -65,90 +66,91 @@ declare namespace ej { function isIOS7(): boolean; function isIOSWebView(): boolean; function isLowerAndroid(): boolean; - function isNullOrUndefined(value: any): boolean; + function isNullOrUndefined(value: Object): boolean; function isPlainObject(): JQuery; function isPortrait(): any; function isTablet(): boolean; function isWindowsWebView(): string; - function listenEvents(selectors: any, eventTypes: any, handlers: any, remove?: any, pluginObj?: any, disableMouse?: boolean): void; - function listenTouchEvent(selectors: any, eventTypes: any, handlers: any, remove?: any, pluginObj?: any, disableMouse?: boolean): void; + function listenEvents(selectors:any, eventTypes: any, handlers: any, remove?: any, pluginObj?: any, disableMouse?: boolean): void; + function listenTouchEvent(selectors:any, eventTypes: any, handlers: any, remove?: any, pluginObj?: any, disableMouse?: boolean): void; function logBase(val: string, base: string): number; function measureText(text: string, maxwidth: number, font: string): string; function moveEvent(): string; function print(element: string, printWindow: any): void; - function proxy(fn: any, context?: string, arg?: string): any; + function proxy(fn: Object, context?: string, arg?: string): any; function round(value: string, div: string, up: string): any; - function sendAjaxRequest(ajaxOptions: any): void; + function sendAjaxRequest(ajaxOptions: Object): void; function setCaretToPos(nput: string, pos1: string, pos2: string): void; function setRenderMode(element: string): void; - function setTheme(): any; + function setTheme(): Object; function startEvent(): string; function tapEvent(): string; function tapHoldEvent(): string; - function throwError(): any; - function transitionEndEvent(): any; + function throwError(): Object; + function transitionEndEvent(): Object; function userAgent(): boolean; - function widget(pluginName: string, className: string, proto: any): any; - function avg(json: any, filedName: string): any; + function widget(pluginName: string, className: string, proto: Object): Object; + function avg(json: Object, filedName: string): any; function getGuid(prefix: string): number; - function group(jsonArray: any, field: string, agg: string, level: number, groupDs: string): any; + function group(jsonArray: any, field: string, agg: string, level: number, groupDs: string): Object; function isJson(jsonData: string): string; function max(jsonArray: any, fieldName?: string, comparer?: string): any; function min(jsonArray: any, fieldName: string, comparer: string): any; function merge(first: string, second: string): any; function mergeshort(jsonArray: any, fieldName: string, comparer: string): any; function parseJson(jsonText: string): string; - function parseTable(table: number, headerOption: string, headerRowIndex: string): any; + function parseTable(table: number, headerOption: string, headerRowIndex: string): Object; function select(jsonArray: any, fields: string): any; function setTransition(): boolean; function sum(json: string, fieldName: string): string; - function swap(array: any, x: string, y: string): any; - const cssUA: string; - const serverTimezoneOffset: number; - const transform: string; - const transformOrigin: string; - const transformStyle: string; - const transition: string; - const transitionDelay: string; - const transitionDuration: string; - const transitionProperty: string; - const transitionTimingFunction: string; - const template: any; - const util: { + function swap(array: any, x: string, y: string): any; + var cssUA: string; + var serverTimezoneOffset: number; + var transform: string; + var transformOrigin: string; + var transformStyle: string; + var transition: string; + var transitionDelay: string; + var transitionDuration: string; + var transitionProperty: string; + var transitionTimingFunction: string; + var template: any; + var util: { valueFunction(val: string): any; - }; - export namespace device { + } + export module device { function isAndroid(): boolean; function isIOS(): boolean; function isFlat(): boolean; function isIOS7(): boolean; function isWindows(): boolean; } - export namespace widget { - const autoInit: boolean; - const registeredInstances: any[]; - const registeredWidgets: any[]; + export module widget { + var autoInit: boolean; + var registeredInstances: Array; + var registeredWidgets: Array; function register(pluginName: string, className: string, prototype: any): void; function destroyAll(elements: Element): void; function init(element: Element): void; - function registerInstance(element: Element, pluginName: string, className: string, prototype: any): void; - } + function registerInstance(element: Element, pluginName: string, className: string, prototype: any):void; + } + interface browserInfoOptions { name: string; version: string; - culture: any; + culture: Object; isMSPointerEnabled: boolean; } class WidgetBase { destroy(): void; element: JQuery; - setModel(options: any, forceSet?: boolean): any; - option(prop?: any, value?: any, forceSet?: boolean): any; - _trigger(eventName?: string, eventProp?: any): any; + setModel(options: Object, forceSet?: boolean):any; + option(prop?: Object, value?: Object, forceSet?: boolean): any; + _trigger(eventName?: string, eventProp?: Object): any; _on(element: JQuery, eventType?: string, handler?: (eventObject: JQueryEventObject) => any): any; _on(element: JQuery, eventType ?: string, selector ?: string, handler ?: (eventObject: JQueryEventObject) => any): any; _off(element: JQuery, eventName: string, handler ?: (eventObject: JQueryEventObject) => any): any; - _off(element: JQuery, eventType ?: string, selector ?: string, handler ?: (eventObject: JQueryEventObject) => any): any; + _off(element: JQuery, eventType ?: string, selector ?: string, handler ?: (eventObject: JQueryEventObject) => any): any; persistState(): void; restoreState(silent: boolean): void; } @@ -158,30 +160,30 @@ declare namespace ej { static fn: Widget; static extend(widget: Widget): any; register(pluginName: string, className: string, prototype: any): void; - destroyAll(elements: Element): void; - model: any; + destroyAll(elements: Element): void; + model: any; } interface BaseEvent { cancel: boolean; - type: string; + type: string; } class DataManager { - constructor(dataSource?: any, query?: ej.Query, adaptor?: any); + constructor(dataSource?: any, query?: ej.Query, adaptor?: any); setDefaultQuery(query: ej.Query): void; executeQuery(query?: ej.Query, done?: any, fail?: any, always?: any): JQueryPromise; executeLocal(query?: ej.Query): ej.DataManager; saveChanges(changes?: Changes, key?: string, tableName?: string): JQueryDeferred; - insert(data: any, tableName?: string): JQueryPromise; - remove(keyField: string, value: any, tableName?: string): any; - update(keyField: string, value: any, tableName?: string): any; - } + insert(data: Object, tableName?: string): JQueryPromise; + remove(keyField: string, value: any, tableName?: string): Object; + update(keyField: string, value: any, tableName?: string): Object; + } class Query { constructor(); static fn: Query; - static extend(prototype: any): Query; + static extend(prototype: Object): Query; key(field: string): ej.Query; using(dataManager: ej.DataManager): ej.Query; execute(dataManager: ej.DataManager, done: any, fail?: string, always?: string): any; @@ -191,8 +193,8 @@ declare namespace ej { addParams(key: string, value: string): ej.Query; expand(tables: any): ej.Query; where(fieldName: string, operator: ej.FilterOperators, value: any, ignoreCase?: boolean): ej.Query; - where(predicate: ej.Predicate): ej.Query; - search(searchKey: any, fieldNames?: any, operator?: string, ignoreCase?: boolean): ej.Query; + where(predicate:ej.Predicate):ej.Query; + search(searchKey: any, fieldNames?: any, operator?: string, ignoreCase?: boolean): ej.Query; sortBy(fieldName: string, comparer?: ej.SortOrder, isFromGroup?: boolean): ej.Query; sortByDesc(fieldName: string): ej.Query; group(fieldName: string): ej.Query; @@ -203,17 +205,17 @@ declare namespace ej { hierarchy(query: ej.Query, selectorFn: any): ej.Query; foreignKey(key: string): ej.Query; requiresCount(): ej.Query; - range(start: number, end: number): ej.Query; + range(start:number, end:number): ej.Query; } class Adaptor { constructor(ds: any); - pvt: any; + pvt: Object; type: ej.Adaptor; options: AdaptorOptions; extend(overrides: any): ej.Adaptor; - processQuery(dm: ej.DataManager, query: ej.Query): any; - processResponse(data: any, ds: any, query: ej.Query, xhr: JQueryXHR, request?: any, changes?: Changes): any; + processQuery(dm: ej.DataManager, query: ej.Query):any; + processResponse(data: Object, ds: any, query: ej.Query, xhr: JQueryXHR, request?: Object, changes?: Changes): Object; convertToQueryString(req: any, query: ej.Query, dm: ej.DataManager): JQueryParam; } @@ -233,18 +235,18 @@ declare namespace ej { class UrlAdaptor extends ej.Adaptor { constructor(); - processQuery(dm: ej.DataManager, query: ej.Query, hierarchyFilters?: any): { - type: string; url: string; ejPvtData: any; contentType?: string; data?: any; + processQuery(dm: ej.DataManager, query: ej.Query, hierarchyFilters?: Object): { + type: string; url: string; ejPvtData: Object; contentType?: string; data?: Object; } - convertToQueryString(req: any, query: ej.Query, dm: ej.DataManager): JQueryParam; - processResponse(data: any, ds: any, query: ej.Query, xhr: JQueryXHR, request?: any, changes?: Changes): any; + convertToQueryString(req: Object, query: ej.Query, dm: ej.DataManager): JQueryParam; + processResponse(data: Object, ds: any, query: ej.Query, xhr: JQueryXHR, request?: Object, changes?: Changes): Object; onGroup(e: any): void; batchRequest(dm: ej.DataManager, changes: Changes, e: any): void; - beforeSend(dm: ej.DataManager, request: any, settings?: any): void; - insert(dm: ej.DataManager, data: any, tableName: string): { url: string; data: any }; + beforeSend(dm: ej.DataManager, request: any, settings?:any): void; + insert(dm: ej.DataManager, data: Object, tableName: string): { url: string; data: any }; remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data?: any }; update(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data: any }; - getFiltersFrom(data: any, query: ej.Query): ej.Predicate; + getFiltersFrom(data: Object, query: ej.Query): ej.Predicate; } class ODataAdaptor extends ej.UrlAdaptor { @@ -253,26 +255,26 @@ declare namespace ej { onEachWhere(filter: any, requiresCast: boolean): any; onPredicate(pred: ej.Predicate, query: ej.Query, requiresCast: boolean): string; onComplexPredicate(pred: ej.Predicate, requiresCast: boolean): string; - onWhere(filters: string[]): string; - onEachSearch(e: any): void; - onSearch(e: any): string; - onEachSort(e: any): string; - onSortBy(e: any): string; - onGroup(e: any): string; - onSelect(e: any): string; - onCount(e: any): string; + onWhere(filters: Array): string; + onEachSearch(e: Object): void; + onSearch(e: Object): string; + onEachSort(e: Object): string; + onSortBy(e: Object): string; + onGroup(e: Object): string; + onSelect(e: Object): string; + onCount(e: Object): string; beforeSend(dm: ej.DataManager, request: any, settings?: any): void; - processResponse(data: any, ds: any, query: ej.Query, xhr: any, request: any, changes: Changes): { - result: any; count: number + processResponse(data: Object, ds: Object, query: ej.Query, xhr:any, request: any, changes: Changes): { + result: Object; count: number }; - convertToQueryString(req: any, query: ej.Query, dm: ej.DataManager): JQueryParam; - insert(dm: ej.DataManager, data: any, tableName: string): { url: string; data: any; } + convertToQueryString(req: Object, query: ej.Query, dm: ej.DataManager): JQueryParam; + insert(dm: ej.DataManager, data: Object, tableName: string): { url: string; data: Object; } remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): { url: string; type: string; } - update(dm: ej.DataManager, keyField: string, value: any, tableName: string): { url: string; type: string; data: any; accept: string; } - batchRequest(dm: ej.DataManager, changes: Changes, e: any): { url: string; type: string; data: any; contentType: string; } - generateDeleteRequest(arr: any[], e: any): string; - generateInsertRequest(arr: any[], e: any): string; - generateUpdateRequest(arr: any[], e: any): string; + update(dm: ej.DataManager, keyField: string, value: any, tableName: string): { url: string; type: string; data: Object; accept: string; } + batchRequest(dm: ej.DataManager, changes: Changes, e: any): { url: string; type: string; data: Object; contentType: string; } + generateDeleteRequest(arr: Array, e: any): string; + generateInsertRequest(arr: Array, e: any): string; + generateUpdateRequest(arr: Array, e: any): string; } interface UrlAdaptorOptions { requestType?: string; @@ -293,25 +295,28 @@ declare namespace ej { changeSetContent?: string; batchChangeSetContentType?: string; } + class WebApiAdaptor extends ej.ODataAdaptor { constructor(); - insert(dm: ej.DataManager, data: any, tableName?: string): { url: string; type: string; data: any; } - remove(dm: ej.DataManager, value: any, keyField?: string, tableName?: string): { url: string; type: string; data: any; } - update(dm: ej.DataManager, value: any, keyField?: string, tableName?: string): { url: string; type: string; data: any; accept: string; } - processResponse(data: any, ds: any, query: ej.Query, xhr: any, request: any, changes: Changes): { - result: any; count: number + insert(dm: ej.DataManager, data: Object, tableName?: string): { url: string; type: string; data: Object; } + remove(dm: ej.DataManager, value: any, keyField?: string, tableName?: string): { url: string; type: string; data: Object; } + update(dm: ej.DataManager, value: any, keyField?: string, tableName?: string): { url: string; type: string; data: Object; accept: string; } + processResponse(data: Object, ds: Object, query: ej.Query, xhr: any, request: any, changes: Changes): { + result: Object; count: number }; } + class ODataV4Adaptor extends ej.ODataAdaptor { constructor(); options: ODataAdaptorOptions; - onCount(e: any): string; - onEachSearch(e: any): void; - onSearch(e: any): string; + onCount(e: Object): string; + onEachSearch(e: Object): void; + onSearch(e: Object): string; beforeSend(dm: ej.DataManager, request: any, settings?: any): void; - processResponse(data: any, ds: any, query: ej.Query, xhr: any, request: any, changes: Changes): { - result: any; count: number + processResponse(data: Object, ds: Object, query: ej.Query, xhr:any, request: any, changes: Changes): { + result: Object; count: number }; + } interface ODataAdaptorOptions { requestType?: string; @@ -336,31 +341,31 @@ declare namespace ej { class JsonAdaptor extends ej.Adaptor { constructor(); - processQuery(ds: any, query: ej.Query): string; - batchRequest(dm: ej.DataManager, changes: Changes, e: any): Changes; - onWhere(ds: any, e: any): any; - onSearch(ds: any, e: any): any - onSortBy(ds: any, e: any, query: ej.Query): any; - onGroup(ds: any, e: any, query: ej.Query): any; - onPage(ds: any, e: any, query: ej.Query): any; - onRange(ds: any, e: any): any; - onTake(ds: any, e: any): any; - onSkip(ds: any, e: any): any; - onSelect(ds: any, e: any): any; - insert(dm: ej.DataManager, data: any): any; - remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): any; - update(dm: ej.DataManager, keyField: string, value: any, tableName: string): any; + processQuery(ds: Object, query: ej.Query): string; + batchRequest(dm: ej.DataManager, changes: Changes, e:any): Changes; + onWhere(ds: Object, e: any): any; + onSearch(ds: Object, e: any): any + onSortBy(ds: Object, e: any, query: ej.Query): Object; + onGroup(ds: Object, e: any, query: ej.Query): Object; + onPage(ds: Object, e: any, query: ej.Query): Object; + onRange(ds: Object, e: any): Object; + onTake(ds: Object, e: any): Object; + onSkip(ds: Object, e: any): Object; + onSelect(ds: Object, e: any): Object; + insert(dm: ej.DataManager, data: any): Object; + remove(dm: ej.DataManager, keyField: string, value:any, tableName: string): Object; + update(dm: ej.DataManager, keyField: string, value:any, tableName: string): Object; } class remoteSaveAdaptor extends ej.UrlAdaptor { constructor(); batchRequest(dm: ej.DataManager, changes: Changes, e: any): void; beforeSend(dm: ej.DataManager, request: any, settings?: any): void; - insert(dm: ej.DataManager, data: any, tableName: string): { url: string; data: any }; + insert(dm: ej.DataManager, data: Object, tableName: string): { url: string; data: any }; remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data?: any }; update(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data: any }; } class TableModel { - constructor(name: string, jsonArray: any[], dataManager: ej.DataManager, modelComputed: any); + constructor(name: string, jsonArray: Array, dataManager: ej.DataManager, modelComputed: any); on(eventName: string, handler: any): void; off(eventName: string, handler: any): void; setDataManager(dataManager: DataManager): void; @@ -371,15 +376,15 @@ declare namespace ej { remove(key: string): void; isDirty(): boolean; getChanges(): Changes; - toArray(): any[]; - setDirty(dirty: any, model: any): void; + toArray(): Array; + setDirty(dirty:any, model:any): void; get(index: number): void; length(): number; bindTo(element: any): void; } class Model { constructor(json: any, table: string, name: string); - formElements: string[]; + formElements: Array; computes(value: any): void; on(eventName: string, handler: any): void; off(eventName: string, handler: any): void; @@ -395,17 +400,17 @@ declare namespace ej { unbind(element: any): void; } interface Changes { - changed?: any[]; - added?: any[]; - deleted?: any[]; + changed?: Array; + added?: Array; + deleted?: Array; } class Predicate { constructor(); constructor(field: string, operator: ej.FilterOperators, value: any, ignoreCase: boolean); - and(field: string, operator: any, value: any, ignoreCase: boolean): ej.Predicate; + and(field: string, operator: any, value:any, ignoreCase:boolean): ej.Predicate; or(field: string, operator: any, value: any, ignoreCase: boolean): ej.Predicate; - or(predicate: any[]): any; - validate(record: any): boolean; + or(predicate: Array): any; + validate(record: Object): boolean; toJSON(): { isComplex: boolean; field: string; @@ -416,17 +421,17 @@ declare namespace ej { predicates: any; }; } - interface dataUtil { - swap(array: any[], x: number, y: number): void; - mergeSort(jsonArray: any[], fieldName?: string, comparer?: any): any[]; - max(jsonArray: any[], fieldName?: string, comparer?: string): any[]; - min(jsonArray: any[], fieldName: string, comparer: string): any[]; - distinct(jsonArray: any[], fieldName?: string, requiresCompleteRecord?: any): any[]; - sum(json: any, fieldName: string): number; - avg(json: any, fieldName: string): number; - select(jsonArray: any[], fieldName: string, fields: string): any[]; - group(jsonArray: any[], field: string, /* internal */ level: number): any[]; - parseTable(table: string, headerOption: ej.headerOption, headerRowIndex: number): any; + interface dataUtil { + swap(array: Array, x: number, y: number): void; + mergeSort(jsonArray: Array, fieldName?: string, comparer?:any): Array; + max(jsonArray: Array, fieldName?: string, comparer?: string): Array; + min(jsonArray: Array, fieldName: string, comparer: string): Array; + distinct(jsonArray: Array, fieldName?: string, requiresCompleteRecord?:any): Array; + sum(json:any, fieldName: string): number; + avg(json:any, fieldName: string): number; + select(jsonArray: Array, fieldName: string, fields:string): Array; + group(jsonArray: Array, field: string, /* internal */ level: number): Array; + parseTable(table: string, headerOption: ej.headerOption, headerRowIndex: number): Object; } interface AjaxSettings { type?: string; @@ -486,7 +491,8 @@ declare namespace ej { row, tHead } - enum filterType { + + enum filterType{ StartsWith, Contains, EndsWith, @@ -497,32 +503,33 @@ declare namespace ej { Equal, NotEqual } - enum Animation { + enum Animation{ Fade, None, Slide - } - enum Type { + } + enum Type{ Overlay, Slide } - enum SortOrder { + enum SortOrder{ Ascending, Descending } class Draggable extends ej.Widget { static fn: Draggable; - constructor(element: JQuery | Element, options?: Draggable.Model); + constructor(element: JQuery, options?: Draggable.Model); + constructor(element: Element, options?: Draggable.Model); static Locale: any; - model: Draggable.Model; - defaults: Draggable.Model; + model:Draggable.Model; + defaults:Draggable.Model; /** destroy in the draggable. * @returns {void} */ _destroy(): void; } -export namespace Draggable { +export module Draggable{ export interface Model { @@ -557,19 +564,19 @@ export interface Model { scope?: string; /** This event is triggered when dragging element is destroyed. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** This event is triggered when the mouse is moved during the dragging. */ - drag?(e: DragEventArgs): void; + drag? (e: DragEventArgs): void; /** Supply a callback function to handle the drag start event as an init option. */ - dragStart?(e: DragStartEventArgs): void; + dragStart? (e: DragStartEventArgs): void; /** This event is triggered when the mouse is moved during the dragging. */ - dragStop?(e: DragStopEventArgs): void; + dragStop? (e: DragStopEventArgs): void; /** This event is triggered when dragged. */ - helper?(e: HelperEventArgs): void; + helper? (e: HelperEventArgs): void; } export interface DestroyEventArgs { @@ -670,17 +677,18 @@ export interface HelperEventArgs { class Droppable extends ej.Widget { static fn: Droppable; - constructor(element: JQuery | Element, options?: Droppable.Model); + constructor(element: JQuery, options?: Droppable.Model); + constructor(element: Element, options?: Droppable.Model); static Locale: any; - model: Droppable.Model; - defaults: Droppable.Model; + model:Droppable.Model; + defaults:Droppable.Model; /** destroy in the Droppable. * @returns {void} */ _destroy(): void; } -export namespace Droppable { +export module Droppable{ export interface Model { @@ -695,13 +703,13 @@ export interface Model { scope?: string; /** This event is triggered when the mouse up is moved during the dragging. */ - drop?(e: DropEventArgs): void; + drop? (e: DropEventArgs): void; /** This event is triggered when the mouse is moved out. */ - out?(e: OutEventArgs): void; + out? (e: OutEventArgs): void; /** This event is triggered when the mouse is moved over. */ - over?(e: OverEventArgs): void; + over? (e: OverEventArgs): void; } export interface DropEventArgs { @@ -764,17 +772,18 @@ export interface OverEventArgs { class Resizable extends ej.Widget { static fn: Resizable; - constructor(element: JQuery | Element, options?: Resizable.Model); + constructor(element: JQuery, options?: Resizable.Model); + constructor(element: Element, options?: Resizable.Model); static Locale: any; - model: Resizable.Model; - defaults: Resizable.Model; + model:Resizable.Model; + defaults:Resizable.Model; /** destroy in the Resizable. * @returns {void} */ _destroy(): void; } -export namespace Resizable { +export module Resizable{ export interface Model { @@ -819,10 +828,10 @@ export interface Model { scope?: string; /** This event is triggered when the widget destroys. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** This event is triggered when resized. */ - helper?(e: HelperEventArgs): void; + helper? (e: HelperEventArgs): void; } export interface DestroyEventArgs { @@ -857,8 +866,8 @@ export interface HelperEventArgs { } - const globalize: globalize; - const cultures: culture; + var globalize:globalize; + var cultures:culture; function addCulture(name: string, culture ?: any): void; function preferredCulture(culture ?: string): culture; function format(value: any, format: string, culture ?: string): string; @@ -867,10 +876,10 @@ export interface HelperEventArgs { function parseDate(value: string, format: string, culture ?: string): Date; function getLocalizedConstants(controlName: string, culture ?: string): any; -interface globalize { +interface globalize { addCulture(name: string, culture?: any): void; preferredCulture(culture?: string): culture; - format(value: any, format: string, culture?: string): string; + format(value: any, format: string, culture?: string): string; parseInt(value: string, radix?: any, culture?: string): number; parseFloat(value: string, radix?: any, culture?: string): number; parseDate(value: string, format: string, culture?: string): Date; @@ -886,22 +895,22 @@ interface globalize { calendars?: calendarsSettings; } interface formatSettings { - pattern: string[]; + pattern: Array; decimals: number; - groupSizes: number[]; + groupSizes: Array; percent: percentSettings; currency: currencySettings; } interface percentSettings { - pattern: string[]; + pattern: Array; decimals: number; - groupSizes: number[]; + groupSizes: Array; symbol: string; } interface currencySettings { - pattern: string[]; + pattern: Array; decimals: number; - groupSizes: number[]; + groupSizes: Array; symbol: string; } interface calendarsSettings { @@ -911,19 +920,19 @@ interface globalize { firstDay: number; days: daySettings; months: monthSettings; - AM: string[]; - PM: string[]; + AM: Array; + PM: Array; twoDigitYearMax: number; patterns: patternSettings; } interface daySettings { - names: string[]; - namesAbbr: string[]; - namesShort: string[]; + names: Array; + namesAbbr: Array; + namesShort: Array; } interface monthSettings { - names: string[]; - namesAbbr: string[]; + names: Array; + namesAbbr: Array; } interface patternSettings { d: string; @@ -935,13 +944,14 @@ interface globalize { M: string; Y: string; S: string; - } + } class Scroller extends ej.Widget { static fn: Scroller; - constructor(element: JQuery | Element, options?: Scroller.Model); + constructor(element: JQuery, options?: Scroller.Model); + constructor(element: Element, options?: Scroller.Model); static Locale: any; - model: Scroller.Model; - defaults: Scroller.Model; + model:Scroller.Model; + defaults:Scroller.Model; /** destroy the Scroller control, unbind the all ej control related events automatically and bring the control to pre-init state. * @returns {void} @@ -989,7 +999,7 @@ class Scroller extends ej.Widget { */ scrollY(pixel: number|string, disableAnimation: boolean, animationSpeed: number): void; } -export namespace Scroller { +export module Scroller{ export interface Model { @@ -1064,28 +1074,28 @@ export interface Model { width?: number|string; /** Fires when Scroller control is created. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Fires when Scroller control is destroyed. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Fires when a thumb point is moved along the touch surface. */ - thumbMove?(e: ThumbMoveEventArgs): void; + thumbMove? (e: ThumbMoveEventArgs): void; /** Fires when a thumb point is placed on the touch surface. */ - thumbStart?(e: ThumbStartEventArgs): void; + thumbStart? (e: ThumbStartEventArgs): void; /** Fires when a thumb point is removed from the touch surface. */ - thumbEnd?(e: ThumbEndEventArgs): void; + thumbEnd? (e: ThumbEndEventArgs): void; /** It fires whenever the mouse wheel is rotated either in upwards or downwards. */ - wheelMove?(e: WheelMoveEventArgs): void; + wheelMove? (e: WheelMoveEventArgs): void; /** It will fire when mouse trackball has been start to wheel. */ - wheelStart?(e: WheelStartEventArgs): void; + wheelStart? (e: WheelStartEventArgs): void; /** It will fire when mouse trackball has been stop to wheel. */ - wheelStop?(e: WheelStopEventArgs): void; + wheelStop? (e: WheelStopEventArgs): void; } export interface CreateEventArgs { @@ -1243,10 +1253,11 @@ export interface WheelStopEventArgs { class Accordion extends ej.Widget { static fn: Accordion; - constructor(element: JQuery | Element, options?: Accordion.Model); + constructor(element: JQuery, options?: Accordion.Model); + constructor(element: Element, options?: Accordion.Model); static Locale: any; - model: Accordion.Model; - defaults: Accordion.Model; + model:Accordion.Model; + defaults:Accordion.Model; /** AddItem method is used to add the panel in dynamically. It receives the following parameters * @param {string} specify the name of the header @@ -1281,7 +1292,7 @@ class Accordion extends ej.Widget { * @param {Array} index values to disable the panels * @returns {void} */ - disableItems(index: any[]): void; + disableItems(index: Array): void; /** Enable the accordion widget includes all the headers and content panels. * @returns {void} @@ -1292,7 +1303,7 @@ class Accordion extends ej.Widget { * @param {Array} index values to enable the panels * @returns {void} */ - enableItems(index: any[]): void; + enableItems(index: Array): void; /** To expand all the accordion widget items. * @returns {void} @@ -1330,7 +1341,7 @@ class Accordion extends ej.Widget { */ show(): void; } -export namespace Accordion { +export module Accordion{ export interface Model { @@ -1342,7 +1353,7 @@ export interface Model { /** Accordion headers can be expanded and collapsed on keyboard action. * @Default {true} */ - allowKeyboardNavigation?: boolean; + allowKeyboardNavigation?: Boolean; /** To set the Accordion headers Collapse Speed. * @Default {300} @@ -1356,9 +1367,9 @@ export interface Model { /** Sets the root CSS class for Accordion theme, which is used customize. */ - cssClass?: string; + cssClass?: String; - /** Allows you to set the custom header Icon. It accepts two key values “headerâ€, â€selectedHeaderâ€. + /** Allows you to set the custom header Icon. It accepts two key values Ă¢â‚¬Å“headerĂ¢â‚¬Â, Ă¢â‚¬ÂselectedHeaderĂ¢â‚¬Â. * @Default {{ header: e-collapse, selectedHeader: e-expand }} */ customIcon?: CustomIcon; @@ -1371,12 +1382,12 @@ export interface Model { /** Specifies the animation behavior in accordion. * @Default {true} */ - enableAnimation?: boolean; + enableAnimation?: Boolean; /** With this enabled property, you can enable or disable the Accordion. * @Default {true} */ - enabled?: boolean; + enabled?: Boolean; /** Used to enable the disabled items in accordion. * @Default {[]} @@ -1386,22 +1397,22 @@ export interface Model { /** Multiple content panels to activate at a time. * @Default {false} */ - enableMultipleOpen?: boolean; + enableMultipleOpen?: Boolean; /** Save current model value to browser cookies for maintaining states. When refreshing the accordion control page, the model value is applied from browser cookies or HTML 5local storage. * @Default {false} */ - enablePersistence?: boolean; + enablePersistence?: Boolean; /** Display headers and panel text from right-to-left. * @Default {false} */ - enableRTL?: boolean; + enableRTL?: Boolean; /** The events API binds the action for activating the accordion header. Users can activate the header by using mouse actions such as mouse-over, mouse-up, mouse-down, and soon. * @Default {click} */ - events?: string; + events?: String; /** To set the Accordion headers Expand Speed. * @Default {300} @@ -1440,7 +1451,7 @@ export interface Model { /** Used to determines the close button visibility an each accordion items. This close button helps to remove the accordion item from the control. * @Default {false} */ - showCloseButton?: boolean; + showCloseButton?: Boolean; /** Displays rounded corner borders on the Accordion control's panels and headers. * @Default {false} @@ -1453,34 +1464,34 @@ export interface Model { width?: number|string; /** Triggered after a Accordion item is active or inactive. Argument values are activeIndex, activeHeader, inActiveHeader, inActiveIndex and current model value. */ - activate?(e: ActivateEventArgs): void; + activate? (e: ActivateEventArgs): void; /** Triggered before the AJAX content is loaded in a content panel. Arguments have location of the content (URL) and current model value. */ - ajaxBeforeLoad?(e: AjaxBeforeLoadEventArgs): void; + ajaxBeforeLoad? (e: AjaxBeforeLoadEventArgs): void; /** Triggered after AJAX load failed action. Arguments have URL, error message, and current model value. */ - ajaxError?(e: AjaxErrorEventArgs): void; + ajaxError? (e: AjaxErrorEventArgs): void; /** Triggered after the AJAX content loads. Arguments have current model values. */ - ajaxLoad?(e: AjaxLoadEventArgs): void; + ajaxLoad? (e: AjaxLoadEventArgs): void; /** Triggered after AJAX success action. Arguments have URL, content, and current model values. */ - ajaxSuccess?(e: AjaxSuccessEventArgs): void; + ajaxSuccess? (e: AjaxSuccessEventArgs): void; /** Triggered before a tab item is active. Arguments have active index and model values. */ - beforeActivate?(e: BeforeActivateEventArgs): void; + beforeActivate? (e: BeforeActivateEventArgs): void; /** Triggered after a Accordion item is active or inactive. Argument values are activeIndex, activeHeader, inActiveHeader, inActiveIndex and current model value. */ - beforeInactivate?(e: BeforeInactivateEventArgs): void; + beforeInactivate? (e: BeforeInactivateEventArgs): void; /** Triggered after Accordion control creation. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Triggered after Accordion control destroy. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Triggered after a Accordion item is active or inactive. Argument values are activeIndex, activeHeader, inActiveHeader, inActiveIndex and current model value. */ - inActivate?(e: InActivateEventArgs): void; + inActivate? (e: InActivateEventArgs): void; } export interface ActivateEventArgs { @@ -1705,15 +1716,15 @@ export interface AjaxSettings { /** It specifies, whether to enable or disable asynchronous request. */ - async?: boolean; + async?: Boolean; /** It specifies the page will be cached in the web browser. */ - cache?: boolean; + cache?: Boolean; /** It specifies the type of data is send in the query string. */ - contentType?: string; + contentType?: String; /** It specifies the data as an object, will be passed in the query string. */ @@ -1721,25 +1732,25 @@ export interface AjaxSettings { /** It specifies the type of data that you're expecting back from the response. */ - dataType?: string; + dataType?: String; /** It specifies the HTTP request type. */ - type?: string; + type?: String; } export interface CustomIcon { /** This class name set to collapsing header. */ - header?: string; + header?: String; /** This class name set to expanded (active) header. */ - selectedHeader?: string; + selectedHeader?: String; } -enum HeightAdjustMode { +enum HeightAdjustMode{ ///Height fit to the content in the panel Content, @@ -1755,10 +1766,11 @@ enum HeightAdjustMode { class Autocomplete extends ej.Widget { static fn: Autocomplete; - constructor(element: JQuery | Element, options?: Autocomplete.Model); + constructor(element: JQuery, options?: Autocomplete.Model); + constructor(element: Element, options?: Autocomplete.Model); static Locale: any; - model: Autocomplete.Model; - defaults: Autocomplete.Model; + model:Autocomplete.Model; + defaults:Autocomplete.Model; /** Clears the text in the Autocomplete textbox. * @returns {void} @@ -1817,17 +1829,16 @@ class Autocomplete extends ej.Widget { */ selectValueByText(Text: string): void; } -export namespace Autocomplete { +export module Autocomplete{ export interface Model { /** Customize "Add New" text (label) to be added in the autocomplete popup list for the entered text when there are no suggestions for it. * @Default {Add New} */ - addNewText?: boolean; + addNewText?: string; - /** Allows new values to be added to the autocomplete input other than the values in the suggestion list. - * Normally, when there are no suggestions it will display “No suggestions†label in the popup. + /** Allows new values to be added to the autocomplete input other than the values in the suggestion list. Normally, when there are no suggestions it will display Ă¢â‚¬Å“No suggestionsĂ¢â‚¬Â label in the popup. * @Default {false} */ allowAddNew?: boolean; @@ -1853,14 +1864,14 @@ export interface Model { caseSensitiveSearch?: boolean; /** The root class for the Autocomplete textbox widget which helps in customizing its theme. - * @Default {â€â€} + * @Default {Ă¢â‚¬ÂĂ¢â‚¬Â} */ cssClass?: string; - /** The data source contains the list of data for the suggestions list. It can be a string array or JSON array. + /** The data source contains the list of data for the suggestions list. It can be a string array or JSON array or service URL that returns JSON. * @Default {null} */ - dataSource?: any|any[]; + dataSource?: any|Array; /** The time delay (in milliseconds) after which the suggestion popup will be shown. * @Default {200} @@ -1868,12 +1879,12 @@ export interface Model { delaySuggestionTimeout?: number; /** The special character which acts as a separator for the given words for multi-mode search i.e. the text after the delimiter are considered as a separate word or query for search operation. - * @Default {’,’} + * @Default {Ă¢â‚¬â„¢,Ă¢â‚¬â„¢} */ delimiterChar?: string; /** The text to be displayed in the popup when there are no suggestions available for the entered text. - * @Default {“No suggestionsâ€} + * @Default {Ă¢â‚¬Å“No suggestionsĂ¢â‚¬Â} */ emptyResultText?: string; @@ -1892,14 +1903,12 @@ export interface Model { */ enableDistinct?: boolean; - /** Allows the current model values to be saved in local storage or browser cookies for state maintenance - * when it is set to true. - * While refreshing the page, it retains the model value from browser cookies or local storage. + /** Allows the current model values to be saved in local storage or browser cookies for state maintenance when it is set to true. While refreshing the page, it retains the model value from browser cookies or local storage. * @Default {false} */ enablePersistence?: boolean; - /** Displays the Autocomplete widget’s content from right to left when enabled. + /** Displays the Autocomplete widgetĂ¢â‚¬â„¢s content from right to left when enabled. * @Default {false} */ enableRTL?: boolean; @@ -1909,10 +1918,7 @@ export interface Model { */ fields?: Fields; - /** Specifies the search filter type. - * There are several types of search filter available such as ‘startswith’, - * ‘contains’, ‘endswith’, ‘lessthan’, ‘lessthanorequal’, ‘greaterthan’, - * ‘greaterthanorequal’, ‘equal’, ‘notequal’. + /** Specifies the search filter type. There are several types of search filter available such as Ă¢â‚¬ËœstartswithĂ¢â‚¬â„¢, Ă¢â‚¬ËœcontainsĂ¢â‚¬â„¢, Ă¢â‚¬ËœendswithĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœgreaterthanĂ¢â‚¬â„¢, Ă¢â‚¬ËœgreaterthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœnotequalĂ¢â‚¬â„¢. * @Default {ej.filterType.StartsWith} */ filterType?: string; @@ -1920,7 +1926,7 @@ export interface Model { /** The height of the Autocomplete textbox. * @Default {null} */ - height?: string; + height?: string|number; /** The search text can be highlighted in the AutoComplete suggestion list when enabled. * @Default {false} @@ -1951,12 +1957,12 @@ export interface Model { multiSelectMode?: ej.Autocomplete.MultiSelectMode|string; /** The height of the suggestion list. - * @Default {“152pxâ€} + * @Default {Ă¢â‚¬Å“152pxĂ¢â‚¬Â} */ popupHeight?: string; /** The width of the suggestion list. - * @Default {“autoâ€} + * @Default {Ă¢â‚¬Å“autoĂ¢â‚¬Â} */ popupWidth?: string; @@ -2037,67 +2043,55 @@ export interface Model { /** The width of the Autocomplete textbox. * @Default {null} */ - width?: string; + width?: string|number; /** Triggers when the AJAX requests Begins. */ - actionBegin?(e: ActionBeginEventArgs): void; + actionBegin? (e: ActionBeginEventArgs): void; /** Triggers when the data requested from AJAX will get successfully loaded in the Autocomplete widget. */ - actionSuccess?(e: ActionSuccessEventArgs): void; + actionSuccess? (e: ActionSuccessEventArgs): void; /** Triggers when the AJAX requests complete. The request may get failed or succeed. */ - actionComplete?(e: ActionCompleteEventArgs): void; + actionComplete? (e: ActionCompleteEventArgs): void; /** Triggers when the data requested from AJAX get failed. */ - actionFailure?(e: ActionFailureEventArgs): void; + actionFailure? (e: ActionFailureEventArgs): void; /** Triggers when the text box value is changed. */ - change?(e: ChangeEventArgs): void; + change? (e: ChangeEventArgs): void; /** Triggers after the suggestion popup is closed. */ - close?(e: CloseEventArgs): void; + close? (e: CloseEventArgs): void; /** Triggers when Autocomplete widget is created. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Triggers after the Autocomplete widget is destroyed. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Triggers after the autocomplete textbox is focused. */ - focusIn?(e: FocusInEventArgs): void; + focusIn? (e: FocusInEventArgs): void; /** Triggers after the Autocomplete textbox gets out of the focus. */ - focusOut?(e: FocusOutEventArgs): void; + focusOut? (e: FocusOutEventArgs): void; /** Triggers after the suggestion list is opened. */ - open?(e: OpenEventArgs): void; + open? (e: OpenEventArgs): void; /** Triggers when an item has been selected from the suggestion list. */ - select?(e: SelectEventArgs): void; + select? (e: SelectEventArgs): void; } export interface ActionBeginEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; } export interface ActionSuccessEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; } export interface ActionCompleteEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; } export interface ActionFailureEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; } export interface ChangeEventArgs { @@ -2281,14 +2275,12 @@ export interface MultiColumnSettingsColumn { */ cssClass?: string; - /** Specifies the search data type. There are four types of data types available such as string, ‘number’, ‘boolean’ and ‘date’. + /** Specifies the search data type. There are four types of data types available such as string, Ă¢â‚¬ËœnumberĂ¢â‚¬â„¢, Ă¢â‚¬ËœbooleanĂ¢â‚¬â„¢ and Ă¢â‚¬ËœdateĂ¢â‚¬â„¢. * @Default {ej.Type.String} */ type?: ej.Type|string; - /** Specifies the search filter type. There are several types of search filter available such as ‘startswith’, - * ‘contains’, ‘endswith’, ‘lessthan’, ‘lessthanorequal’, ‘greaterthan’, - * ‘greaterthanorequal’, ‘equal’, ‘notequal’. + /** Specifies the search filter type. There are several types of search filter available such as Ă¢â‚¬ËœstartswithĂ¢â‚¬â„¢, Ă¢â‚¬ËœcontainsĂ¢â‚¬â„¢, Ă¢â‚¬ËœendswithĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœgreaterthanĂ¢â‚¬â„¢, Ă¢â‚¬ËœgreaterthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœnotequalĂ¢â‚¬â„¢. * @Default {ej.filterType.StartsWith} */ filterType?: ej.filterType|string; @@ -2301,7 +2293,7 @@ export interface MultiColumnSettingsColumn { /** Gets or sets a value that indicates to align the text within the column. See textAlign * @Default {ej.TextAlign.Left} */ - textAlign?: ej.TextAlign|string; + textAlign?: ej.TextAlign|string; } export interface MultiColumnSettings { @@ -2322,10 +2314,10 @@ export interface MultiColumnSettings { /** Field and Header Text collections can be defined and customized through columns field. */ - columns?: MultiColumnSettingsColumn[]; + columns?: Array; } -enum Animation { +enum Animation{ ///Supports to animation type with none type only. None, @@ -2338,7 +2330,7 @@ enum Animation { } -enum MultiSelectMode { +enum MultiSelectMode{ ///Multiple values are separated using a given special character. Delimiter, @@ -2348,7 +2340,7 @@ enum MultiSelectMode { } -enum SortOrder { +enum SortOrder{ ///Items to be displayed in the suggestion list in ascending order. Ascending, @@ -2361,10 +2353,11 @@ enum SortOrder { class Button extends ej.Widget { static fn: Button; - constructor(element: JQuery | Element, options?: Button.Model); + constructor(element: JQuery, options?: Button.Model); + constructor(element: Element, options?: Button.Model); static Locale: any; - model: Button.Model; - defaults: Button.Model; + model:Button.Model; + defaults:Button.Model; /** destroy the button widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. * @returns {void} @@ -2381,7 +2374,7 @@ class Button extends ej.Widget { */ enable(): void; } -export namespace Button { +export module Button{ export interface Model { @@ -2414,9 +2407,7 @@ export interface Model { */ htmlAttributes?: any; - /** Specifies the image position of the Button. This image position is applicable - * only with the textandimage contentType property. The images can be positioned in both - * imageLeft and imageRight options. See below to know about available ImagePosition + /** Specifies the image position of the Button. This image position is applicable only with the textandimage contentType property. The images can be positioned in both imageLeft and imageRight options. See below to know about available ImagePosition * @Default {ej.ImagePosition.ImageLeft} */ imagePosition?: ej.ImagePosition|string; @@ -2466,17 +2457,14 @@ export interface Model { */ width?: string|number; - /** Fires when Button control is clicked successfully.Consider the scenario to perform any validation, - * modification of content or any other operations click on button,we can make use of this click event - * to achieve the scenario. - */ - click?(e: ClickEventArgs): void; + /** Fires when Button control is clicked successfully.Consider the scenario to perform any validation,modification of content or any other operations click on button,we can make use of this click event to achieve the scenario. */ + click? (e: ClickEventArgs): void; /** Fires after Button control is created.If the user want to perform any operation after the button control creation then the user can make use of this create event. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Fires when the button is destroyed successfully.If the user want to perform any operation after the destroy button control then the user can make use of this destroy event. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; } export interface ClickEventArgs { @@ -2497,7 +2485,7 @@ export interface ClickEventArgs { */ status?: boolean; - /** return the event model for sever side processing. + /** return the event model for sever side processing. */ e?: any; } @@ -2532,7 +2520,8 @@ export interface DestroyEventArgs { type?: string; } } -enum ContentType { +enum ContentType +{ //To display the text content only in button TextOnly, //To display the image only in button @@ -2544,7 +2533,8 @@ TextAndImage, //Supports to display image with both ends of the text ImageTextImage, } -enum ImagePosition { +enum ImagePosition +{ //support for aligning text in left and image in right ImageRight, //support for aligning text in right and image in left @@ -2554,22 +2544,24 @@ ImageTop, //support for aligning text in top and image in bottom ImageBottom, } -enum ButtonSize { +enum ButtonSize +{ //Creates button with Built-in default size height, width specified Normal, //Creates button with Built-in mini size height, width specified Mini, //Creates button with Built-in small size height, width specified Small, -//Creates button with Built-in medium size height, width specified +//Creates button with Built-in medium size height, width specified Medium, -//Creates button with Built-in large size height, width specified +//Creates button with Built-in large size height, width specified Large, } -enum ButtonType { +enum ButtonType +{ //Creates button with Built-in button type specified Button, -//Creates button with Built-in reset type specified +//Creates button with Built-in reset type specified Reset, //Creates button with Built-in submit type specified Submit, @@ -2577,12 +2569,13 @@ Submit, class Captcha extends ej.Widget { static fn: Captcha; - constructor(element: JQuery | Element, options?: Captcha.Model); + constructor(element: JQuery, options?: Captcha.Model); + constructor(element: Element, options?: Captcha.Model); static Locale: any; - model: Captcha.Model; - defaults: Captcha.Model; + model:Captcha.Model; + defaults:Captcha.Model; } -export namespace Captcha { +export module Captcha{ export interface Model { @@ -2655,16 +2648,16 @@ export interface Model { width?: number; /** Fires when captcha refresh begins. */ - refreshBegin?(e: RefreshBeginEventArgs): void; + refreshBegin? (e: RefreshBeginEventArgs): void; /** Fires after captcha refresh completed. */ - refreshComplete?(e: RefreshCompleteEventArgs): void; + refreshComplete? (e: RefreshCompleteEventArgs): void; /** Fires when captcha refresh fails to load. */ - refreshFailure?(e: RefreshFailureEventArgs): void; + refreshFailure? (e: RefreshFailureEventArgs): void; /** Fires after captcha refresh succeeded. */ - refreshSuccess?(e: RefreshSuccessEventArgs): void; + refreshSuccess? (e: RefreshSuccessEventArgs): void; } export interface RefreshBeginEventArgs { @@ -2727,7 +2720,8 @@ export interface RefreshSuccessEventArgs { type?: string; } } -enum HatchStyle { +enum HatchStyle +{ //Set background as None to Captcha None, //Set background as BackwardDiagonal to Captcha @@ -2806,14 +2800,14 @@ ZigZag, class ListBox extends ej.Widget { static fn: ListBox; - constructor(element: JQuery | Element, options?: ListBox.Model); + constructor(element: JQuery, options?: ListBox.Model); + constructor(element: Element, options?: ListBox.Model); static Locale: any; - model: ListBox.Model; - defaults: ListBox.Model; + model:ListBox.Model; + defaults:ListBox.Model; /** Adds a given list items in the ListBox widget at a specified index. It accepts two parameters. - * @param {any|string} This can be a list item object (for JSON binding) or a string (for UL and LI rendering). - * Also we can the specify this as an array of list item object or an array of strings to add multiple items. + * @param {any|string} This can be a list item object (for JSON binding) or a string (for UL and LI rendering). Also we can the specify this as an array of list item object or an array of strings to add multiple items. * @param {number} The index value to add the given items at the specified index. If index is not specified, the given items will be added at the end of the list. * @returns {void} */ @@ -2892,29 +2886,29 @@ class ListBox extends ej.Widget { */ getSelectedItems(): any; - /** Returns an item’s index based on the given text. + /** Returns an itemĂ¢â‚¬â„¢s index based on the given text. * @param {string} The list item text (label) * @returns {number} */ getIndexByText(text: string): number; - /** Returns an item’s index based on the value given. - * @param {string} The list item’s value + /** Returns an itemĂ¢â‚¬â„¢s index based on the value given. + * @param {string} The list itemĂ¢â‚¬â„¢s value * @returns {number} */ getIndexByValue(indices: string): number; - /** Returns an item’s text (label) based on the index given. + /** Returns an itemĂ¢â‚¬â„¢s text (label) based on the index given. * @returns {string} */ getTextByIndex(): string; - /** Returns a list item’s object using its index. + /** Returns a list itemĂ¢â‚¬â„¢s object using its index. * @returns {any} */ getItemByIndex(): any; - /** Returns a list item’s object based on the text given. + /** Returns a list itemĂ¢â‚¬â„¢s object based on the text given. * @param {string} The list item text. * @returns {any} */ @@ -2924,7 +2918,7 @@ class ListBox extends ej.Widget { * @param {Array} Data to merge in listbox. * @returns {void} */ - mergeData(data: any[]): void; + mergeData(data: Array): void; /** Selects the next item based on the current selection. * @returns {void} @@ -2953,7 +2947,7 @@ class ListBox extends ej.Widget { removeSelectedItems(): void; /** Removes a list item by using its text. - * @param {string} Text of the listbox item to be removed. + * @param {string} Text of the listbox item to be removed. * @returns {void} */ removeItemByText(text: string): void; @@ -2964,7 +2958,7 @@ class ListBox extends ej.Widget { */ removeItemByIndex(index: number): void; - /** + /** * @returns {void} */ selectAll(): void; @@ -3010,7 +3004,7 @@ class ListBox extends ej.Widget { */ uncheckItemsByIndices(indices: number[]|string): void; - /** + /** * @returns {void} */ unselectAll(): void; @@ -3060,13 +3054,13 @@ class ListBox extends ej.Widget { * @param {Array} Values of the listbox items to be shown. * @returns {void} */ - showItemsByValues(values: any[]): void; + showItemsByValues(values: Array): void; /** Hides the list item using its values. * @param {Array} Values of the listbox items to be hidden. * @returns {void} */ - hideItemsByValues(values: any[]): void; + hideItemsByValues(values: Array): void; /** Shows a hidden list item using its value. * @param {string} Value of the listbox item to be shown. @@ -3092,7 +3086,7 @@ class ListBox extends ej.Widget { */ hideItemByIndex(index: number): void; - /** + /** * @returns {void} */ show(): void; @@ -3112,7 +3106,7 @@ class ListBox extends ej.Widget { */ showAllItems(): void; } -export namespace ListBox { +export module ListBox{ export interface Model { @@ -3131,7 +3125,7 @@ export interface Model { */ allowMultiSelection?: boolean; - /** Loads the list data on demand via scrolling behavior to improve the application’s performance. There are two ways to load data which can be defined using “virtualScrollMode†property. + /** Loads the list data on demand via scrolling behavior to improve the applicationĂ¢â‚¬â„¢s performance. There are two ways to load data which can be defined using Ă¢â‚¬Å“virtualScrollModeĂ¢â‚¬Â property. * @Default {false} */ allowVirtualScrolling?: boolean; @@ -3141,9 +3135,7 @@ export interface Model { */ caseSensitiveSearch?: boolean; - /** Dynamically populate data of a list box while selecting an item in another list box i.e. - * rendering child list box based on the item selection in parent list box. - * This property accepts the id of the child ListBox widget to populate the data. + /** Dynamically populate data of a list box while selecting an item in another list box i.e. rendering child list box based on the item selection in parent list box. This property accepts the id of the child ListBox widget to populate the data. * @Default {null} */ cascadeTo?: string; @@ -3151,10 +3143,10 @@ export interface Model { /** Set of list items to be checked by default using its index. It works only when the showCheckbox property is set to true. * @Default {null} */ - checkedIndices?: any[]; + checkedIndices?: Array; /** The root class for the ListBox widget to customize the existing theme. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ cssClass?: string; @@ -3178,7 +3170,7 @@ export interface Model { */ enablePersistence?: boolean; - /** Displays the ListBox widget’s content from right to left when enabled. + /** Displays the ListBox widgetĂ¢â‚¬â„¢s content from right to left when enabled. * @Default {false} */ enableRTL?: boolean; @@ -3235,7 +3227,7 @@ export interface Model { /** The list items to be selected by default using its indices. To use this property allowMultiSelection should be enabled. * @Default {[]} */ - selectedIndices?: any[]; + selectedIndices?: Array; /** Enables/Disables the multi selection option with the help of checkbox control. * @Default {false} @@ -3253,7 +3245,7 @@ export interface Model { template?: string; /** Holds the selected items values and used to bind value to the list item using AngularJS and KnockoutJS. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ value?: number; @@ -3271,79 +3263,67 @@ export interface Model { targetID?: string; /** Triggers before the AJAX request begins to load data in the ListBox widget. */ - actionBegin?(e: ActionBeginEventArgs): void; + actionBegin? (e: ActionBeginEventArgs): void; /** Triggers after the data requested via AJAX is successfully loaded in the ListBox widget. */ - actionSuccess?(e: ActionSuccessEventArgs): void; + actionSuccess? (e: ActionSuccessEventArgs): void; /** Triggers when the AJAX requests complete. The request may get failed or succeed. */ - actionComplete?(e: ActionCompleteEventArgs): void; + actionComplete? (e: ActionCompleteEventArgs): void; /** Triggers when the data requested from AJAX get failed. */ - actionFailure?(e: ActionFailureEventArgs): void; + actionFailure? (e: ActionFailureEventArgs): void; /** Event will be triggered before the requested data via AJAX once loaded in successfully. */ - actionBeforeSuccess?(e: ActionBeforeSuccessEventArgs): void; + actionBeforeSuccess? (e: ActionBeforeSuccessEventArgs): void; /** Triggers when the item selection is changed. */ - change?(e: ChangeEventArgs): void; + change? (e: ChangeEventArgs): void; /** Triggers when the list item is checked or unchecked. */ - checkChange?(e: CheckChangeEventArgs): void; + checkChange? (e: CheckChangeEventArgs): void; /** Triggers when the ListBox widget is created successfully. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Triggers when the ListBox widget is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Triggers when focus the listbox items. */ - focusIn?(e: FocusInEventArgs): void; + focusIn? (e: FocusInEventArgs): void; /** Triggers when focus out from listbox items. */ - focusOut?(e: FocusOutEventArgs): void; + focusOut? (e: FocusOutEventArgs): void; /** Triggers when the list item is being dragged. */ - itemDrag?(e: ItemDragEventArgs): void; + itemDrag? (e: ItemDragEventArgs): void; /** Triggers when the list item is ready to be dragged. */ - itemDragStart?(e: ItemDragStartEventArgs): void; + itemDragStart? (e: ItemDragStartEventArgs): void; /** Triggers when the list item stops dragging. */ - itemDragStop?(e: ItemDragStopEventArgs): void; + itemDragStop? (e: ItemDragStopEventArgs): void; /** Triggers when the list item is dropped. */ - itemDrop?(e: ItemDropEventArgs): void; + itemDrop? (e: ItemDropEventArgs): void; /** Triggers when a list item gets selected. */ - select?(e: SelectEventArgs): void; + select? (e: SelectEventArgs): void; /** Triggers when a list item gets unselected. */ - unselect?(e: UnselectEventArgs): void; + unselect? (e: UnselectEventArgs): void; } export interface ActionBeginEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; } export interface ActionSuccessEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; } export interface ActionCompleteEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; } export interface ActionFailureEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; } export interface ActionBeforeSuccessEventArgs { @@ -3370,7 +3350,7 @@ export interface ActionBeforeSuccessEventArgs { /** List of array object */ - result?: any[]; + result?: Array; /** ExecuteQuery object of DataManager */ @@ -3395,7 +3375,7 @@ export interface ChangeEventArgs { */ data?: any; - /** List item’s index. + /** List itemĂ¢â‚¬â„¢s index. */ index?: number; @@ -3415,11 +3395,11 @@ export interface ChangeEventArgs { */ isEnabled?: boolean; - /** List item’s text (label). + /** List itemĂ¢â‚¬â„¢s text (label). */ text?: string; - /** List item’s value. + /** List itemĂ¢â‚¬â„¢s value. */ value?: string; } @@ -3442,7 +3422,7 @@ export interface CheckChangeEventArgs { */ data?: any; - /** List item’s index. + /** List itemĂ¢â‚¬â„¢s index. */ index?: number; @@ -3462,11 +3442,11 @@ export interface CheckChangeEventArgs { */ isEnabled?: boolean; - /** List item’s text (label). + /** List itemĂ¢â‚¬â„¢s text (label). */ text?: string; - /** List item’s value. + /** List itemĂ¢â‚¬â„¢s value. */ value?: string; } @@ -3549,7 +3529,7 @@ export interface ItemDragEventArgs { */ data?: any; - /** List item’s index. + /** List itemĂ¢â‚¬â„¢s index. */ index?: number; @@ -3565,11 +3545,11 @@ export interface ItemDragEventArgs { */ isEnabled?: boolean; - /** List item’s text (label). + /** List itemĂ¢â‚¬â„¢s text (label). */ text?: string; - /** List item’s value. + /** List itemĂ¢â‚¬â„¢s value. */ value?: string; } @@ -3592,7 +3572,7 @@ export interface ItemDragStartEventArgs { */ data?: any; - /** List item’s index. + /** List itemĂ¢â‚¬â„¢s index. */ index?: number; @@ -3608,11 +3588,11 @@ export interface ItemDragStartEventArgs { */ isEnabled?: boolean; - /** List item’s text (label). + /** List itemĂ¢â‚¬â„¢s text (label). */ text?: string; - /** List item’s value. + /** List itemĂ¢â‚¬â„¢s value. */ value?: string; } @@ -3635,7 +3615,7 @@ export interface ItemDragStopEventArgs { */ data?: any; - /** List item’s index. + /** List itemĂ¢â‚¬â„¢s index. */ index?: number; @@ -3651,11 +3631,11 @@ export interface ItemDragStopEventArgs { */ isEnabled?: boolean; - /** List item’s text (label). + /** List itemĂ¢â‚¬â„¢s text (label). */ text?: string; - /** List item’s value. + /** List itemĂ¢â‚¬â„¢s value. */ value?: string; } @@ -3678,7 +3658,7 @@ export interface ItemDropEventArgs { */ data?: any; - /** List item’s index. + /** List itemĂ¢â‚¬â„¢s index. */ index?: number; @@ -3694,11 +3674,11 @@ export interface ItemDropEventArgs { */ isEnabled?: boolean; - /** List item’s text (label). + /** List itemĂ¢â‚¬â„¢s text (label). */ text?: string; - /** List item’s value. + /** List itemĂ¢â‚¬â„¢s value. */ value?: string; } @@ -3721,7 +3701,7 @@ export interface SelectEventArgs { */ data?: any; - /** List item’s index. + /** List itemĂ¢â‚¬â„¢s index. */ index?: number; @@ -3741,11 +3721,11 @@ export interface SelectEventArgs { */ isEnabled?: boolean; - /** List item’s text (label). + /** List itemĂ¢â‚¬â„¢s text (label). */ text?: string; - /** List item’s value. + /** List itemĂ¢â‚¬â„¢s value. */ value?: string; } @@ -3768,7 +3748,7 @@ export interface UnselectEventArgs { */ data?: any; - /** List item’s index. + /** List itemĂ¢â‚¬â„¢s index. */ index?: number; @@ -3788,11 +3768,11 @@ export interface UnselectEventArgs { */ isEnabled?: boolean; - /** List item’s text (label). + /** List itemĂ¢â‚¬â„¢s text (label). */ text?: string; - /** List item’s value. + /** List itemĂ¢â‚¬â„¢s value. */ value?: string; } @@ -3847,10 +3827,11 @@ export interface Fields { class Calculate { static fn: Calculate; - constructor(element: JQuery | Element, options?: Calculate.Model); + constructor(element: JQuery, options?: Calculate.Model); + constructor(element: Element, options?: Calculate.Model); static Locale: any; - model: Calculate.Model; - defaults: Calculate.Model; + model:Calculate.Model; + defaults:Calculate.Model; /** Add the custom formulas with function in CalcEngine library * @param {string} pass the formula name @@ -3901,21 +3882,19 @@ class Calculate { */ computeFormula(Formula: string): string; } -export namespace Calculate { +export module Calculate{ export interface Model { - /** Returns the cancel option value. - */ - cancel?: boolean; } } class CheckBox extends ej.Widget { static fn: CheckBox; - constructor(element: JQuery | Element, options?: CheckBox.Model); + constructor(element: JQuery, options?: CheckBox.Model); + constructor(element: Element, options?: CheckBox.Model); static Locale: any; - model: CheckBox.Model; - defaults: CheckBox.Model; + model:CheckBox.Model; + defaults:CheckBox.Model; /** Destroy the CheckBox widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. * @returns {void} @@ -3937,15 +3916,11 @@ class CheckBox extends ej.Widget { */ isChecked(): boolean; } -export namespace CheckBox { +export module CheckBox{ export interface Model { - /** Specifies whether CheckBox has to be in checked or not. - * We can also specify array of string as value for this property. - * If any of the value in the specified array matches the value of the textbox, - * then it will be considered as checked. It will be useful in MVVM binding, - * specify array type to identify the values of the checked CheckBoxes. + /** Specifies whether CheckBox has to be in checked or not. We can also specify array of string as value for this property. If any of the value in the specified array matches the value of the textbox, then it will be considered as checked. It will be useful in MVVM binding, specify array type to identify the values of the checked CheckBoxes. * @Default {false} */ checked?: boolean|string[]; @@ -3964,9 +3939,7 @@ export interface Model { */ enabled?: boolean; - /** Specifies the persist property for CheckBox while initialization. - * The persist API save current model value to browser cookies for state maintains. - * While refreshing the CheckBox control page the model value apply from browser cookies. + /** Specifies the persist property for CheckBox while initialization. The persist API save current model value to browser cookies for state maintains. While refreshing the CheckBox control page the model value apply from browser cookies. * @Default {false} */ enablePersistence?: boolean; @@ -4031,16 +4004,16 @@ export interface Model { value?: string; /** Fires before the CheckBox is going to changed its state successfully */ - beforeChange?(e: BeforeChangeEventArgs): void; + beforeChange? (e: BeforeChangeEventArgs): void; /** Fires when the CheckBox state is changed successfully */ - change?(e: ChangeEventArgs): void; + change? (e: ChangeEventArgs): void; /** Fires when the CheckBox state is created successfully */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Fires when the CheckBox state is destroyed successfully */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; } export interface BeforeChangeEventArgs { @@ -4123,7 +4096,8 @@ export interface DestroyEventArgs { type?: string; } } -enum CheckState { +enum CheckState +{ //string Uncheck, //string @@ -4131,7 +4105,8 @@ Check, //string Indeterminate, } -enum CheckboxSize { +enum CheckboxSize +{ //Displays the CheckBox in medium size Medium, //Displays the CheckBox in small size @@ -4140,10 +4115,11 @@ Small, class ColorPicker extends ej.Widget { static fn: ColorPicker; - constructor(element: JQuery | Element, options?: ColorPicker.Model); + constructor(element: JQuery, options?: ColorPicker.Model); + constructor(element: Element, options?: ColorPicker.Model); static Locale: any; - model: ColorPicker.Model; - defaults: ColorPicker.Model; + model:ColorPicker.Model; + defaults:ColorPicker.Model; /** Disables the color picker control * @returns {void} @@ -4199,7 +4175,7 @@ class ColorPicker extends ej.Widget { */ show(): void; } -export namespace ColorPicker { +export module ColorPicker{ export interface Model { @@ -4225,7 +4201,7 @@ export interface Model { /** This property allows to define the custom colors in the palette model.Custom palettes are created by passing a comma delimited string of HEX values or an array of colors. * @Default {empty} */ - custom?: any[]; + custom?: Array; /** This property allows to embed the popup in the order of DOM element flow . When we set the value as true, the color picker popup is always in visible state. * @Default {false} @@ -4267,8 +4243,7 @@ export interface Model { */ palette?: ej.ColorPicker.Palette|string; - /** This property allows to define the preset model to be rendered initially in palette type.It consists of 12 different types of presets. Each presets have 50 colors. - * See below available Presets + /** This property allows to define the preset model to be rendered initially in palette type.It consists of 12 different types of presets. Each presets have 50 colors. See below available Presets * @Default {ej.ColorPicker.Presets.Basic} */ presetType?: ej.ColorPicker.Presets|string; @@ -4288,8 +4263,7 @@ export interface Model { */ showPreview?: boolean; - /** This property allows to store the color values in custom list.The ColorPicker will keep up to 11 colors in a custom list. - * By clicking the add button, the selected color from picker or palette will get added in the recent color list. + /** This property allows to store the color values in custom list.The ColorPicker will keep up to 11 colors in a custom list.By clicking the add button, the selected color from picker or palette will get added in the recent color list. * @Default {false} */ showRecentColors?: boolean; @@ -4310,9 +4284,7 @@ export interface Model { toolIcon?: string; /** This property allows to define the customized text or content to displayed when mouse over the following elements. This property also allows to use the culture values. - * @Default {{ switcher: Switcher, addbutton: Add Color, basic: Basic, monochrome: Mono Chrome, flatcolors: Flat Color, seawolf: Sea Wolf, webcolors: Web Colors, - * sandy: Sandy, pinkshades: Pink Shades, misty: Misty, citrus: Citrus, vintage: Vintage, moonlight: Moon Light, candycrush: Candy Crush, - * currentcolor: Current Color, selectedcolor: Selected Color }} + * @Default {{ switcher: Switcher, addbutton: Add Color, basic: Basic, monochrome: Mono Chrome, flatcolors: Flat Color, seawolf: Sea Wolf, webcolors: Web Colors, sandy: Sandy, pinkshades: Pink Shades, misty: Misty, citrus: Citrus, vintage: Vintage, moonlight: Moon Light, candycrush: Candy Crush, currentcolor: Current Color, selectedcolor: Selected Color }} */ tooltipText?: TooltipText; @@ -4322,22 +4294,22 @@ export interface Model { value?: string; /** Fires after Color value has been changed successfully.If the user want to perform any operation after the color value changed then the user can make use of this change event. */ - change?(e: ChangeEventArgs): void; + change? (e: ChangeEventArgs): void; /** Fires after closing the color picker popup. */ - close?(e: CloseEventArgs): void; + close? (e: CloseEventArgs): void; /** Fires after Color picker control is created. If the user want to perform any operation after the color picker control creation then the user can make use of this create event. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Fires after Color picker control is destroyed. If the user want to perform any operation after the color picker control destroyed then the user can make use of this destroy event. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Fires after opening the color picker popup */ - open?(e: OpenEventArgs): void; + open? (e: OpenEventArgs): void; /** Fires after Color value has been selected successfully. If the user want to perform any operation after the color value selected then the user can make use of this select event. */ - select?(e: SelectEventArgs): void; + select? (e: SelectEventArgs): void; } export interface ChangeEventArgs { @@ -4520,7 +4492,7 @@ export interface TooltipText { selectedcolor?: string; } -enum ModelType { +enum ModelType{ ///support palette type mode in color picker. Palette, @@ -4530,7 +4502,7 @@ enum ModelType { } -enum Palette { +enum Palette{ ///used to show the basic palette BasicPalette, @@ -4540,7 +4512,7 @@ enum Palette { } -enum Presets { +enum Presets{ ///used to show the basic presets Basic, @@ -4577,8 +4549,9 @@ enum Presets { } } -enum ButtonMode { -//Displays the button in split mode +enum ButtonMode +{ +//Displays the button in split mode Split, //Displays the button in Dropdown mode Dropdown, @@ -4586,10 +4559,11 @@ Dropdown, class FileExplorer extends ej.Widget { static fn: FileExplorer; - constructor(element: JQuery | Element, options?: FileExplorer.Model); + constructor(element: JQuery, options?: FileExplorer.Model); + constructor(element: Element, options?: FileExplorer.Model); static Locale: any; - model: FileExplorer.Model; - defaults: FileExplorer.Model; + model:FileExplorer.Model; + defaults:FileExplorer.Model; /** Refresh the size of FileExplorer control. * @returns {void} @@ -4597,25 +4571,25 @@ class FileExplorer extends ej.Widget { adjustSize(): void; /** Disable the particular context menu item. - * @param {string|HTMLElement} Id of the menu item/ Menu element to be disabled + * @param {string|HTMLElement} Id of the menu item/ Menu element to be disabled * @returns {void} */ disableMenuItem(item: string|HTMLElement): void; /** Disable the particular toolbar item. - * @param {string|HTMLElement} Id of the toolbar item/ Tool item element to be disabled + * @param {string|HTMLElement} Id of the toolbar item/ Tool item element to be disabled * @returns {void} */ disableToolbarItem(item: string|HTMLElement): void; /** Enable the particular context menu item. - * @param {string|HTMLElement} Id of the menu item/ Menu element to be Enabled + * @param {string|HTMLElement} Id of the menu item/ Menu element to be Enabled * @returns {void} */ enableMenuItem(item: string|HTMLElement): void; /** Enable the particular toolbar item - * @param {string|HTMLElement} Id of the tool item/ Tool item element to be Enabled + * @param {string|HTMLElement} Id of the tool item/ Tool item element to be Enabled * @returns {void} */ enableToolbarItem(item: string|HTMLElement): void; @@ -4626,12 +4600,12 @@ class FileExplorer extends ej.Widget { refresh(): void; /** Remove the particular toolbar item. - * @param {string|HTMLElement} Id of the tool item/ tool item element to be removed + * @param {string|HTMLElement} Id of the tool item/ tool item element to be removed * @returns {void} */ removeToolbarItem(item: string|HTMLElement): void; } -export namespace FileExplorer { +export module FileExplorer{ export interface Model { @@ -4644,14 +4618,12 @@ export interface Model { */ ajaxDataType?: string; - /** By using ajaxSettings property, you can customize the AJAX configurations. Normally you can customize the following option in AJAX handling data, URL, type, async, contentType, dataType and - * success. For upload, download and getImage API, you can only customize URL. + /** By using ajaxSettings property, you can customize the AJAX configurations. Normally you can customize the following option in AJAX handling data, URL, type, async, contentType, dataType and success. For upload, download and getImage API, you can only customize URL. * @Default {{ read: {}, createFolder: {}, remove: {}, rename: {}, paste: {}, getDetails: {}, download: {}, upload: {}, getImage: {}, search: {}}} */ ajaxSettings?: any; - /** The FileExplorer allows to move the files from one folder to another folder of FileExplorer by using drag and drop option. Also it supports to upload a file by dragging it - * from windows explorer to the necessary folder of ejFileExplorer. + /** The FileExplorer allows to move the files from one folder to another folder of FileExplorer by using drag and drop option. Also it supports to upload a file by dragging it from windows explorer to the necessary folder of ejFileExplorer. * @Default {true} */ allowDragAndDrop?: boolean; @@ -4670,8 +4642,7 @@ export interface Model { */ contextMenuSettings?: ContextMenuSettings; - /** Sets the root class for FileExplorer theme. This cssClass API allows to use custom skinning option for File Explorer control. - * By defining the root class by using this API, you have to include this root class in CSS. + /** Sets the root class for FileExplorer theme. This cssClass API allows to use custom skinning option for File Explorer control. By defining the root class by using this API, you have to include this root class in CSS. */ cssClass?: string; @@ -4758,7 +4729,7 @@ export interface Model { /** The selectedItems is used to select the specified items (file, folder) of FileExplorer control. */ - selectedItems?: string|any[]; + selectedItems?: string|Array; /** Enables or disables the checkbox option in FileExplorer control. * @Default {true} @@ -4770,8 +4741,7 @@ export interface Model { */ showContextMenu?: boolean; - /** Enables or disables the footer in FileExplorer control. The footer element displays the details of the current selected files and folders. - * And also the footer having the switcher to change the layout view. + /** Enables or disables the footer in FileExplorer control. The footer element displays the details of the current selected files and folders. And also the footer having the switcher to change the layout view. * @Default {true} */ showFooter?: boolean; @@ -4791,22 +4761,20 @@ export interface Model { */ showToolbar?: boolean; - /** Enables or disables the navigation pane in FileExplorer control. The navigation pane contains a tree view element that displays all the folders from the filesystem in a hierarchical manner. - * This is useful to a quick navigation of any folder in the filesystem. + /** Enables or disables the navigation pane in FileExplorer control. The navigation pane contains a tree view element that displays all the folders from the filesystem in a hierarchical manner. This is useful to a quick navigation of any folder in the filesystem. * @Default {true} */ showNavigationPane?: boolean; /** The tools property is used to configure and group required toolbar items in FileExplorer control. - * @Default {{ creation: [NewFolder], navigation: [Back, Forward, Upward], addressBar: [Addressbar], editing: [Refresh, Upload, Delete, Rename, Download], copyPaste: [Cut, Copy, Paste], - * getProperties: [Details], searchBar: [Searchbar], layout: [Layout], sortBy: [SortBy]}} + * @Default {{ creation: [NewFolder], navigation: [Back, Forward, Upward], addressBar: [Addressbar], editing: [Refresh, Upload, Delete, Rename, Download], copyPaste: [Cut, Copy, Paste], getProperties: [Details], searchBar: [Searchbar], layout: [Layout], sortBy: [SortBy]}} */ tools?: any; /** The toolsList property is used to arrange the toolbar items in the FileExplorer control. * @Default {[layout, creation, navigation, addressBar, editing, copyPaste, sortBy, getProperties, searchBar]} */ - toolsList?: any[]; + toolsList?: Array; /** Gets or sets an object that indicates whether to customize the upload behavior in the FileExplorer. */ @@ -4818,93 +4786,91 @@ export interface Model { width?: string|number; /** Fires before the AJAX request is performed. */ - beforeAjaxRequest?(e: BeforeAjaxRequestEventArgs): void; + beforeAjaxRequest? (e: BeforeAjaxRequestEventArgs): void; /** Fires before downloading the files. */ - beforeDownload?(e: BeforeDownloadEventArgs): void; + beforeDownload? (e: BeforeDownloadEventArgs): void; - /** Fires before getting a requested image from server. Also this event will be triggered when you have enabled thumbnail image compression option in FileExplorer. - * Using this event, you can customize the image compression size. - */ - beforeGetImage?(e: BeforeGetImageEventArgs): void; + /** Fires before getting a requested image from server. Also this event will be triggered when you have enabled thumbnail image compression option in FileExplorer.Using this event, you can customize the image compression size. */ + beforeGetImage? (e: BeforeGetImageEventArgs): void; /** Fires before files or folders open. */ - beforeOpen?(e: BeforeOpenEventArgs): void; + beforeOpen? (e: BeforeOpenEventArgs): void; /** Fires before uploading the files. */ - beforeUpload?(e: BeforeUploadEventArgs): void; + beforeUpload? (e: BeforeUploadEventArgs): void; /** Fires when FileExplorer control was created */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Fires when file or folder is copied successfully. */ - copy?(e: CopyEventArgs): void; + copy? (e: CopyEventArgs): void; /** Fires when new folder is created successfully in file system. */ - createFolder?(e: CreateFolderEventArgs): void; + createFolder? (e: CreateFolderEventArgs): void; /** Fires when file or folder is cut successfully. */ - cut?(e: CutEventArgs): void; + cut? (e: CutEventArgs): void; /** Fires when the FileExplorer is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Fires when the files or directory has been started to drag over on the FileExplorer */ - dragStart?(e: DragStartEventArgs): void; + dragStart? (e: DragStartEventArgs): void; /** Fires when the files or directory is dragging over on the FileExplorer. */ - drag?(e: DragEventArgs): void; + drag? (e: DragEventArgs): void; /** Fires when the files or directory has been stopped to drag over on FileExplorer */ - dragStop?(e: DragStopEventArgs): void; + dragStop? (e: DragStopEventArgs): void; /** Fires when the files or directory is dropped to the target folder of FileExplorer */ - drop?(e: DropEventArgs): void; + drop? (e: DropEventArgs): void; /** Fires after loading the requested image from server. Using this event, you can get the details of loaded image. */ - getImage?(e: GetImageEventArgs): void; + getImage? (e: GetImageEventArgs): void; /** Fires when keydown in FileExplorer control. */ - keydown?(e: KeydownEventArgs): void; + keydown? (e: KeydownEventArgs): void; /** Fires when the file view type is changed. */ - layoutChange?(e: LayoutChangeEventArgs): void; + layoutChange? (e: LayoutChangeEventArgs): void; /** Fires when before the ContextMenu opening. */ - menuBeforeOpen?(e: MenuBeforeOpenEventArgs): void; + menuBeforeOpen? (e: MenuBeforeOpenEventArgs): void; /** Fires when click the ContextMenu item. */ - menuClick?(e: MenuClickEventArgs): void; + menuClick? (e: MenuClickEventArgs): void; /** Fires when ContextMenu is successfully opened. */ - menuOpen?(e: MenuOpenEventArgs): void; + menuOpen? (e: MenuOpenEventArgs): void; /** Fires when files are successfully opened. */ - open?(e: OpenEventArgs): void; + open? (e: OpenEventArgs): void; /** Fires when a file or folder is pasted successfully. */ - paste?(e: PasteEventArgs): void; + paste? (e: PasteEventArgs): void; /** Fires when file or folder is deleted successfully. */ - remove?(e: RemoveEventArgs): void; + remove? (e: RemoveEventArgs): void; /** Fires when resizing is performed for FileExplorer. */ - resize?(e: ResizeEventArgs): void; + resize? (e: ResizeEventArgs): void; /** Fires when resizing is started for FileExplorer. */ - resizeStart?(e: ResizeStartEventArgs): void; + resizeStart? (e: ResizeStartEventArgs): void; /** Fires this event when the resizing is stopped for FileExplorer. */ - resizeStop?(e: ResizeStopEventArgs): void; + resizeStop? (e: ResizeStopEventArgs): void; /** Fires when the items from grid view or tile view of FileExplorer control is selected. */ - select?(e: SelectEventArgs): void; + select? (e: SelectEventArgs): void; /** Triggered when refresh the template column elements in the grid view of FileExplorer control. */ - templateRefresh?(e: TemplateRefreshEventArgs): void; + templateRefresh? (e: TemplateRefreshEventArgs): void; /** Fires when the items from grid view or tile view or large icons view of FileExplorer control is unselected. */ - unselect?(e: UnselectEventArgs): void; + unselect? (e: UnselectEventArgs): void; } export interface BeforeAjaxRequestEventArgs { @@ -5366,7 +5332,7 @@ export interface MenuBeforeOpenEventArgs { /** returns the dataSource of ContextMenu. */ - dataSource?: any[]; + dataSource?: Array; /** returns the element of ContextMenu. */ @@ -5695,21 +5661,20 @@ export interface UnselectEventArgs { /** Returns the unselected items details. */ - unselectedItems?: any[]; + unselectedItems?: Array; } export interface ContextMenuSettings { /** The items property is used to configure and group the required ContextMenu items in FileExplorer control. - * @Default {{% highlight javascript %}{navbar: [NewFolder, Upload, |, Delete, Rename, |, Cut, Copy, Paste, |, Getinfo],cwd: [Refresh, Paste,|, SortBy, |, NewFolder, Upload, |, - * Getinfo],files: [Open, Download, |, Upload, |, Delete, Rename, |, Cut, Copy, Paste, |, OpenFolderLocation, Getinfo]}{% endhighlight %}} + * @Default {{% highlight javascript %}{navbar: [NewFolder, Upload, |, Delete, Rename, |, Cut, Copy, Paste, |, Getinfo],cwd: [Refresh, Paste,|, SortBy, |, NewFolder, Upload, |, Getinfo],files: [Open, Download, |, Upload, |, Delete, Rename, |, Cut, Copy, Paste, |, OpenFolderLocation, Getinfo]}{% endhighlight %}} */ items?: any; /** The customMenuFields property is used to define custom functionality for custom ContextMenu item's which are defined in items property. * @Default {[]} */ - customMenuFields?: any[]; + customMenuFields?: Array; } export interface FilterSettings { @@ -5743,10 +5708,9 @@ export interface GridSettings { allowSorting?: boolean; /** Gets or sets an object that indicates to render the grid with specified columns. You can use this property same as the column property in Grid control. - * @Default {[{ field: name, headerText: Name, width: 30% }, { field: dateModified, headerText: Date Modified, width: 30% }, { field: type, headerText: Type, width: 15% }, - * { field: size, headerText: Size, width: 12%, textAlign: right, headerTextAlign: left }]} + * @Default {[{ field: name, headerText: Name, width: 30% }, { field: dateModified, headerText: Date Modified, width: 30% }, { field: type, headerText: Type, width: 15% }, { field: size, headerText: Size, width: 12%, textAlign: right, headerTextAlign: left }]} */ - columns?: any[]; + columns?: Array; } export interface UploadSettings { @@ -5767,12 +5731,12 @@ export interface UploadSettings { autoUpload?: boolean; } -enum layoutType { +enum layoutType{ ///Supports to display files in tile view Tile, - ///Supports to display files in grid view + ///Supports to display files in grid view Grid, ///Supports to display files as large icons @@ -5783,10 +5747,11 @@ enum layoutType { class DatePicker extends ej.Widget { static fn: DatePicker; - constructor(element: JQuery | Element, options?: DatePicker.Model); + constructor(element: JQuery, options?: DatePicker.Model); + constructor(element: Element, options?: DatePicker.Model); static Locale: any; - model: DatePicker.Model; - defaults: DatePicker.Model; + model:DatePicker.Model; + defaults:DatePicker.Model; /** Disables the DatePicker control. * @returns {void} @@ -5813,7 +5778,7 @@ class DatePicker extends ej.Widget { */ show(): void; } -export namespace DatePicker { +export module DatePicker{ export interface Model { @@ -5851,8 +5816,7 @@ export interface Model { */ dayHeaderFormat?: string | ej.DatePicker.Header; - /** Specifies the navigation depth level in DatePicker calendar. This option is not applied when start level view option is lower than depth level view. - * See below to know available levels in DatePicker Calendar + /** Specifies the navigation depth level in DatePicker calendar. This option is not applied when start level view option is lower than depth level view. See below to know available levels in DatePicker Calendar */ depthLevel?: string | ej.DatePicker.Level; @@ -5881,8 +5845,7 @@ export interface Model { */ enableRTL?: boolean; - /** Allows to enter valid or invalid date in input textbox and indicate as error if it is invalid value, when this API value is set to true. For false value, invalid date is not allowed - * to input field and corrected to valid date automatically, even if invalid date is given. + /** Allows to enter valid or invalid date in input textbox and indicate as error if it is invalid value, when this API value is set to true. For false value, invalid date is not allowed to input field and corrected to valid date automatically, even if invalid date is given. * @Default {false} */ enableStrictMode?: boolean; @@ -6018,40 +5981,40 @@ export interface Model { width?: string; /** Fires before closing the DatePicker popup. */ - beforeClose?(e: BeforeCloseEventArgs): void; + beforeClose? (e: BeforeCloseEventArgs): void; /** Fires when each date is created in the DatePicker popup calendar. */ - beforeDateCreate?(e: BeforeDateCreateEventArgs): void; + beforeDateCreate? (e: BeforeDateCreateEventArgs): void; /** Fires before opening the DatePicker popup. */ - beforeOpen?(e: BeforeOpenEventArgs): void; + beforeOpen? (e: BeforeOpenEventArgs): void; /** Fires when the DatePicker input value is changed. */ - change?(e: ChangeEventArgs): void; + change? (e: ChangeEventArgs): void; /** Fires when DatePicker popup is closed. */ - close?(e: CloseEventArgs): void; + close? (e: CloseEventArgs): void; /** Fires when the DatePicker is created successfully. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Fires when the DatePicker is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Fires when DatePicker input gets focus. */ - focusIn?(e: FocusInEventArgs): void; + focusIn? (e: FocusInEventArgs): void; /** Fires when DatePicker input loses the focus. */ - focusOut?(e: FocusOutEventArgs): void; + focusOut? (e: FocusOutEventArgs): void; /** Fires when calender view navigates to month/year/decade/century. */ - navigate?(e: NavigateEventArgs): void; + navigate? (e: NavigateEventArgs): void; /** Fires when DatePicker popup is opened. */ - open?(e: OpenEventArgs): void; + open? (e: OpenEventArgs): void; /** Fires when a date is selected from the DatePicker popup. */ - select?(e: SelectEventArgs): void; + select? (e: SelectEventArgs): void; } export interface BeforeCloseEventArgs { @@ -6357,7 +6320,7 @@ export interface Fields { cssClass?: string; } -enum Header { +enum Header{ ///Removes day header in DatePicker None, @@ -6370,7 +6333,7 @@ enum Header { } -enum Level { +enum Level{ ///allow navigation upto year level in DatePicker Year, @@ -6383,12 +6346,12 @@ enum Level { } -enum HighlightSection { +enum HighlightSection{ - ///Highlight the week of the currently selected date in DatePicker popup calendar + ///Highlight the week of the currently selected date in DatePicker popup calendar Week, - ///Highlight the workdays in a currently selected date's week in DatePicker popup calendar + ///Highlight the workdays in a currently selected date's week in DatePicker popup calendar WorkDays, ///Nothing will be highlighted, remove highlights from DatePicker popup calendar if already exists @@ -6399,10 +6362,11 @@ enum HighlightSection { class DateTimePicker extends ej.Widget { static fn: DateTimePicker; - constructor(element: JQuery | Element, options?: DateTimePicker.Model); + constructor(element: JQuery, options?: DateTimePicker.Model); + constructor(element: Element, options?: DateTimePicker.Model); static Locale: any; - model: DateTimePicker.Model; - defaults: DateTimePicker.Model; + model:DateTimePicker.Model; + defaults:DateTimePicker.Model; /** Disables the DateTimePicker control. * @returns {void} @@ -6434,7 +6398,7 @@ class DateTimePicker extends ej.Widget { */ show(): void; } -export namespace DateTimePicker { +export module DateTimePicker{ export interface Model { @@ -6462,8 +6426,7 @@ export interface Model { */ dayHeaderFormat?: ej.DatePicker.Header|string; - /** Specifies the navigation depth level in DatePicker calendar inside DateTimePicker popup. This option is not applied - * when start level view option is lower than depth level view. See ej.DatePicker.Level + /** Specifies the navigation depth level in DatePicker calendar inside DateTimePicker popup. This option is not applied when start level view option is lower than depth level view. See ej.DatePicker.Level */ depthLevel?: ej.DatePicker.Level|string; @@ -6532,7 +6495,7 @@ export interface Model { */ popupPosition?: string | ej.popupPosition; - /** Indicates that the DateTimePicker value can only be read and can’t change. + /** Indicates that the DateTimePicker value can only be read and canĂ¢â‚¬â„¢t change. * @Default {false} */ readOnly?: boolean; @@ -6607,31 +6570,31 @@ export interface Model { width?: string|number; /** Fires before the datetime popup closed in the DateTimePicker. */ - beforeClose?(e: BeforeCloseEventArgs): void; + beforeClose? (e: BeforeCloseEventArgs): void; /** Fires before the datetime popup open in the DateTimePicker. */ - beforeOpen?(e: BeforeOpenEventArgs): void; + beforeOpen? (e: BeforeOpenEventArgs): void; /** Fires when the datetime value changed in the DateTimePicker textbox. */ - change?(e: ChangeEventArgs): void; + change? (e: ChangeEventArgs): void; /** Fires when DateTimePicker popup closes. */ - close?(e: CloseEventArgs): void; + close? (e: CloseEventArgs): void; /** Fires after DateTimePicker control is created. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Fires when the DateTimePicker is destroyed successfully */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Fires when the focus-in happens in the DateTimePicker textbox. */ - focusIn?(e: FocusInEventArgs): void; + focusIn? (e: FocusInEventArgs): void; /** Fires when the focus-out happens in the DateTimePicker textbox. */ - focusOut?(e: FocusOutEventArgs): void; + focusOut? (e: FocusOutEventArgs): void; /** Fires when DateTimePicker popup opens. */ - open?(e: OpenEventArgs): void; + open? (e: OpenEventArgs): void; } export interface BeforeCloseEventArgs { @@ -6863,26 +6826,28 @@ export interface TimeDrillDown { autoClose?: boolean; } } -enum popupPosition { +enum popupPosition +{ //Opens the DateTimePicker popup below to the DateTimePicker input box Bottom, -//Opens the DateTimePicker popup above to the DateTimePicker input box +//Opens the DateTimePicker popup above to the DateTimePicker input box Top, } class DateRangePicker extends ej.Widget { static fn: DateRangePicker; - constructor(element: JQuery | Element, options?: DateRangePicker.Model); + constructor(element: JQuery, options?: DateRangePicker.Model); + constructor(element: Element, options?: DateRangePicker.Model); static Locale: any; - model: DateRangePicker.Model; - defaults: DateRangePicker.Model; + model:DateRangePicker.Model; + defaults:DateRangePicker.Model; /** Add the preset ranges to DateRangePicker popup. * @param {string} Display name * @param {Array} StartDate and endDate of range. * @returns {void} */ - addRanges(label: string, range: any[]): void; + addRanges(label: string, range: Array): void; /** Clears the all ranges selections in DateRangePicker popup * @returns {void} @@ -6919,7 +6884,7 @@ class DateRangePicker extends ej.Widget { */ setRange(): void; } -export namespace DateRangePicker { +export module DateRangePicker{ export interface Model { @@ -7013,28 +6978,28 @@ export interface Model { width?: string|number; /** Fires before closing the DateRangePicker popup. */ - beforeClose?(e: BeforeCloseEventArgs): void; + beforeClose? (e: BeforeCloseEventArgs): void; /** Fires before opening the DateRangePicker popup. */ - beforeOpen?(e: BeforeOpenEventArgs): void; + beforeOpen? (e: BeforeOpenEventArgs): void; /** Fires when the DateRangePicker values get changed. */ - onChange?(e: OnChangeEventArgs): void; + onChange? (e: OnChangeEventArgs): void; /** Fires when DateRangePicker popup is closed. */ - close?(e: CloseEventArgs): void; + close? (e: CloseEventArgs): void; /** Fires when the DateRangePicker is created successfully. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Fires when the DateRangePicker is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Fires when DateRangePicker popup is opened. */ - open?(e: OpenEventArgs): void; + open? (e: OpenEventArgs): void; /** Fires when a date ranges is selected from the DateRangePicker popup. */ - select?(e: SelectEventArgs): void; + select? (e: SelectEventArgs): void; } export interface BeforeCloseEventArgs { @@ -7212,10 +7177,11 @@ export interface SelectEventArgs { class Dialog extends ej.Widget { static fn: Dialog; - constructor(element: JQuery | Element, options?: Dialog.Model); + constructor(element: JQuery, options?: Dialog.Model); + constructor(element: Element, options?: Dialog.Model); static Locale: any; - model: Dialog.Model; - defaults: Dialog.Model; + model:Dialog.Model; + defaults:Dialog.Model; /** Closes the dialog widget dynamically. * @returns {any} @@ -7294,7 +7260,7 @@ class Dialog extends ej.Widget { */ focus(): any; } -export namespace Dialog { +export module Dialog{ export interface Model { @@ -7315,8 +7281,7 @@ export interface Model { */ allowKeyboardNavigation?: boolean; - /** Customizes the Dialog widget animations. The Dialog widget can be animated while opening and closing the dialog. - * In order to customize animation effects, you need to set “enableAnimation†as true. It contains the following sub properties. + /** Customizes the Dialog widget animations. The Dialog widget can be animated while opening and closing the dialog. In order to customize animation effects, you need to set Ă¢â‚¬Å“enableAnimationĂ¢â‚¬Â as true. It contains the following sub properties. */ animation?: any; @@ -7328,12 +7293,11 @@ export interface Model { */ containment?: string; - /** The content type to load the dialog content at run time. The possible values are null, AJAX, iframe and image. When it is null (default value), - * the content inside dialog element will be displayed as content and when it is not null, the content will be loaded from the URL specified in the contentUrl property. + /** The content type to load the dialog content at run time. The possible values are null, AJAX, iframe and image. When it is null (default value), the content inside dialog element will be displayed as content and when it is not null, the content will be loaded from the URL specified in the contentUrl property. */ contentType?: string; - /** The URL to load the dialog content (such as AJAX, image, and iframe). In order to load content from URL, you need to set contentType as ‘ajax’ or ‘iframe’ or ‘image’. + /** The URL to load the dialog content (such as AJAX, image, and iframe). In order to load content from URL, you need to set contentType as Ă¢â‚¬ËœajaxĂ¢â‚¬â„¢ or Ă¢â‚¬ËœiframeĂ¢â‚¬â„¢ or Ă¢â‚¬ËœimageĂ¢â‚¬â„¢. */ contentUrl?: string; @@ -7365,12 +7329,11 @@ export interface Model { */ enableRTL?: boolean; - /** The CSS class name to display the favicon in the dialog header. In order to display favicon, you need to set� showHeader� as true since the favicon will be displayed in the dialog header. + /** The CSS class name to display the favicon in the dialog header. In order to display favicon, you need to set showHeader as true since the favicon will be displayed in the dialog header. */ faviconCSS?: string; - /** Sets the height for the dialog widget. It accepts both string and integer values. For example, it can accepts values like “autoâ€, “100%â€, “100px†as string type - * and “100â€, “500†as integer type. + /** Sets the height for the dialog widget. It accepts both string and integer values. For example, it can accepts values like Ă¢â‚¬Å“autoĂ¢â‚¬Â, Ă¢â‚¬Å“100%Ă¢â‚¬Â, Ă¢â‚¬Å“100pxĂ¢â‚¬Â as string type and Ă¢â‚¬Å“100Ă¢â‚¬Â, Ă¢â‚¬Å“500Ă¢â‚¬Â as integer type. */ height?: string|number; @@ -7383,7 +7346,7 @@ export interface Model { */ isResponsive?: boolean; - /** Default Value:{:.param}“en-US†+ /** Default Value:{:.param}Ă¢â‚¬Å“en-USĂ¢â‚¬Â */ locale?: number; @@ -7431,8 +7394,7 @@ export interface Model { */ tooltip?: any; - /** Sets the height for the dialog widget. It accepts both string and integer values. For example, it can accepts values like “autoâ€, “100%â€, - * “100px†as string type and “100â€, “500†as integer type. + /** Sets the height for the dialog widget. It accepts both string and integer values. For example, it can accepts values like Ă¢â‚¬Å“autoĂ¢â‚¬Â, Ă¢â‚¬Å“100%Ă¢â‚¬Â, Ă¢â‚¬Å“100pxĂ¢â‚¬Â as string type and Ă¢â‚¬Å“100Ă¢â‚¬Â, Ă¢â‚¬Å“500Ă¢â‚¬Â as integer type. */ width?: string|number; @@ -7449,58 +7411,58 @@ export interface Model { footerTemplateId?: string; /** This event is triggered before the dialog widgets gets open. */ - beforeOpen?(e: BeforeOpenEventArgs): void; + beforeOpen? (e: BeforeOpenEventArgs): void; /** This event is triggered whenever the AJAX request fails to retrieve the dialog content. */ - ajaxError?(e: AjaxErrorEventArgs): void; + ajaxError? (e: AjaxErrorEventArgs): void; /** This event is triggered whenever the AJAX request to retrieve the dialog content, gets succeed. */ - ajaxSuccess?(e: AjaxSuccessEventArgs): void; + ajaxSuccess? (e: AjaxSuccessEventArgs): void; /** This event is triggered before the dialog widgets get closed. */ - beforeClose?(e: BeforeCloseEventArgs): void; + beforeClose? (e: BeforeCloseEventArgs): void; /** This event is triggered after the dialog widget is closed. */ - close?(e: CloseEventArgs): void; + close? (e: CloseEventArgs): void; /** Triggered after the dialog content is loaded in DOM. */ - contentLoad?(e: ContentLoadEventArgs): void; + contentLoad? (e: ContentLoadEventArgs): void; /** Triggered after the dialog is created successfully */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Triggered after the dialog widget is destroyed successfully */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Triggered while the dialog is dragged. */ - drag?(e: DragEventArgs): void; + drag? (e: DragEventArgs): void; /** Triggered when the user starts dragging the dialog. */ - dragStart?(e: DragStartEventArgs): void; + dragStart? (e: DragStartEventArgs): void; /** Triggered when the user stops dragging the dialog. */ - dragStop?(e: DragStopEventArgs): void; + dragStop? (e: DragStopEventArgs): void; /** Triggered after the dialog is opened. */ - open?(e: OpenEventArgs): void; + open? (e: OpenEventArgs): void; /** Triggered while the dialog is resized. */ - resize?(e: ResizeEventArgs): void; + resize? (e: ResizeEventArgs): void; /** Triggered when the user starts resizing the dialog. */ - resizeStart?(e: ResizeStartEventArgs): void; + resizeStart? (e: ResizeStartEventArgs): void; /** Triggered when the user stops resizing the dialog. */ - resizeStop?(e: ResizeStopEventArgs): void; + resizeStop? (e: ResizeStopEventArgs): void; /** Triggered when the dialog content is expanded. */ - expand?(e: ExpandEventArgs): void; + expand? (e: ExpandEventArgs): void; /** Triggered when the dialog content is collapsed. */ - collapse?(e: CollapseEventArgs): void; + collapse? (e: CollapseEventArgs): void; /** Triggered when the custom action button clicked. */ - actionButtonClick?(e: ActionButtonClickEventArgs): void; + actionButtonClick? (e: ActionButtonClickEventArgs): void; } export interface BeforeOpenEventArgs { @@ -7875,16 +7837,17 @@ export interface AjaxSettings { class DropDownList extends ej.Widget { static fn: DropDownList; - constructor(element: JQuery | Element, options?: DropDownList.Model); + constructor(element: JQuery, options?: DropDownList.Model); + constructor(element: Element, options?: DropDownList.Model); static Locale: any; - model: DropDownList.Model; - defaults: DropDownList.Model; + model:DropDownList.Model; + defaults:DropDownList.Model; /** Adding a single item or an array of items into the DropDownList allows you to specify all the field attributes such as value, template, image URL, and HTML attributes for those items. * @param {any|Array} this parameter should have field attributes with respect to mapped field attributes and it's corresponding values to fields * @returns {void} */ - addItem(data: any|any[]): void; + addItem(data: any|Array): void; /** This method is used to select all the items in the DropDownList. * @returns {void} @@ -7910,7 +7873,7 @@ class DropDownList extends ej.Widget { * @param {string|number|Array} disable the given index list items * @returns {void} */ - disableItemsByIndices(index: string|number|any[]): void; + disableItemsByIndices(index: string|number|Array): void; /** This property enables the DropDownList control. * @returns {void} @@ -7921,13 +7884,13 @@ class DropDownList extends ej.Widget { * @param {string|number|Array} enable the given index list items if it's disabled * @returns {void} */ - enableItemsByIndices(index: string|number|any[]): void; + enableItemsByIndices(index: string|number|Array): void; /** This method retrieves the items using given value. * @param {string|number|any} Return the whole object of data based on given value * @returns {Array} */ - getItemDataByValue(value: string|number|any): any[]; + getItemDataByValue(value: string|number|any): Array; /** This method is used to retrieve the items that are bound with the DropDownList. * @returns {any} @@ -7937,12 +7900,12 @@ class DropDownList extends ej.Widget { /** This method is used to get the selected items in the DropDownList. * @returns {Array} */ - getSelectedItem(): any[]; + getSelectedItem(): Array; /** This method is used to retrieve the items value that are selected in the DropDownList. - * @returns {string} + * @returns {string|number} */ - getSelectedValue(): string; + getSelectedValue(): string|number; /** This method hides the suggestion popup in the DropDownList. * @returns {void} @@ -7953,19 +7916,19 @@ class DropDownList extends ej.Widget { * @param {string|number|Array} select the given index list items * @returns {void} */ - selectItemsByIndices(index: string|number|any[]): void; + selectItemsByIndices(index: string|number|Array): void; /** This method is used to select an item in the DropDownList by using the given text value. * @param {string|number|Array} select the list items relates to given text * @returns {void} */ - selectItemByText(index: string|number|any[]): void; + selectItemByText(index: string|number|Array): void; /** This method is used to select an item in the DropDownList by using the given value. * @param {string|number|Array} select the list items relates to given values * @returns {void} */ - selectItemByValue(index: string|number|any[]): void; + selectItemByValue(index: string|number|Array): void; /** This method shows the DropDownList control with the suggestion popup. * @returns {void} @@ -7981,31 +7944,30 @@ class DropDownList extends ej.Widget { * @param {string|number|Array} unselect the given index list items * @returns {void} */ - unselectItemsByIndices(index: string|number|any[]): void; + unselectItemsByIndices(index: string|number|Array): void; /** This method is used to unselect an item in the DropDownList by using the given text value. * @param {string|number|Array} unselect the list items relates to given text * @returns {void} */ - unselectItemByText(index: string|number|any[]): void; + unselectItemByText(index: string|number|Array): void; /** This method is used to unselect an item in the DropDownList by using the given value. * @param {string|number|Array} unselect the list items relates to given values * @returns {void} */ - unselectItemByValue(index: string|number|any[]): void; + unselectItemByValue(index: string|number|Array): void; } -export namespace DropDownList { +export module DropDownList{ export interface Model { - /** The Virtual Scrolling(lazy loading) feature is used to display a large amount of data that you require without buffering the entire load of a huge database records in the DropDownList, - * that is, when scrolling, an AJAX request is sent to fetch some amount of data from the server dynamically. To achieve this scenario with DropDownList, set the allowVirtualScrolling to true. + /** The Virtual Scrolling(lazy loading) feature is used to display a large amount of data that you require without buffering the entire load of a huge database records in the DropDownList, that is, when scrolling, an AJAX request is sent to fetch some amount of data from the server dynamically. To achieve this scenario with DropDownList, set the allowVirtualScrolling to true. * @Default {false} */ allowVirtualScrolling?: boolean; - /** The cascading DropDownLists is a series of two or more DropDownLists in which each DropDownList is filtered according to the previous DropDownList’s value. + /** The cascading DropDownLists is a series of two or more DropDownLists in which each DropDownList is filtered according to the previous DropDownListĂ¢â‚¬â„¢s value. * @Default {null} */ cascadeTo?: string; @@ -8015,19 +7977,16 @@ export interface Model { */ caseSensitiveSearch?: boolean; - /** Dropdown widget's style and appearance can be controlled based on 13 different default built-in themes.You can customize the appearance of the dropdown by using the cssClass property. - * You need to specify a class name in the cssClass property and the same class name is used before the class definitions wherever the custom styles are applied. + /** Dropdown widget's style and appearance can be controlled based on 13 different default built-in themes.You can customize the appearance of the dropdown by using the cssClass property. You need to specify a class name in the cssClass property and the same class name is used before the class definitions wherever the custom styles are applied. */ cssClass?: string; - /** This property is used to serve data from the data services based on the query provided. To bind the data to the dropdown widget, - * the dataSource property is assigned with the instance of the ej.DataManager. + /** This property is used to serve data from the data services based on the query provided. To bind the data to the dropdown widget, the dataSource property is assigned with the instance of the ej.DataManager. * @Default {null} */ dataSource?: any; - /** Sets the separator when the multiSelectMode with delimiter option or checkbox is enabled with the dropdown. When you enter the delimiter value,the texts after the delimiter are considered - * as a separate word or query. The delimiter string is a single character and must be a symbol. Mostly, the delimiter symbol is used as comma (,) or semi-colon (;) or any other special character. + /** Sets the separator when the multiSelectMode with delimiter option or checkbox is enabled with the dropdown. When you enter the delimiter value, the texts after the delimiter are considered as a separate word or query. The delimiter string is a single character and must be a symbol. Mostly, the delimiter symbol is used as comma (,) or semi-colon (;) or any other special character. * @Default {','} */ delimiterChar?: string; @@ -8037,8 +7996,7 @@ export interface Model { */ enableAnimation?: boolean; - /** This property is used to indicate whether the DropDownList control responds to the user interaction or not. By default, the control is in the enabled mode - * and you can disable it by setting it to false. + /** This property is used to indicate whether the DropDownList control responds to the user interaction or not. By default, the control is in the enabled mode and you can disable it by setting it to false. * @Default {true} */ enabled?: boolean; @@ -8053,8 +8011,7 @@ export interface Model { */ enableFilterSearch?: boolean; - /** Saves the current model value to the browser cookies for state maintenance. While refreshing the DropDownList control page, it retains the model value and - * it is applied from the browser cookies. + /** Saves the current model value to the browser cookies for state maintenance. While refreshing the DropDownList control page, it retains the model value and it is applied from the browser cookies. * @Default {false} */ enablePersistence?: boolean; @@ -8129,9 +8086,7 @@ export interface Model { */ minPopupWidth?: string|number; - /** With the help of this property, you can make a single or multi selection with the DropDownList and display the text in two modes, delimiter and visual mode. - * In delimiter mode, you can separate the items by using the delimiter character such as comma (,) or semi-colon (;) or any other special character. - * In the visual mode, the items are showcased like boxes with close icon in the textbox. + /** With the help of this property, you can make a single or multi selection with the DropDownList and display the text in two modes, delimiter and visual mode. In delimiter mode, you can separate the items by using the delimiter character such as comma (,) or semi-colon (;) or any other special character. In the visual mode, the items are showcased like boxes with close icon in the textbox. * @Default {ej.MultiSelectMode.None} */ multiSelectMode?: ej.MultiSelectMode|string; @@ -8164,7 +8119,7 @@ export interface Model { /** Specifies the selectedItems for the DropDownList. * @Default {[]} */ - selectedIndices?: any[]; + selectedIndices?: Array; /** Selects multiple items in the DropDownList with the help of the checkbox control. To achieve this, enable the showCheckbox option to true. * @Default {false} @@ -8186,7 +8141,7 @@ export interface Model { */ sortOrder?: ej.SortOrder|string; - /** Specifies the targetID for the DropDownList’s items. + /** Specifies the targetID for the DropDownListĂ¢â‚¬â„¢s items. * @Default {null} */ targetID?: string; @@ -8199,7 +8154,7 @@ export interface Model { /** Defines the text value that is displayed in the DropDownList textbox. * @Default {null} */ - text?: string; + text?: string|number; /** Sets the jQuery validation error message in the DropDownList * @Default {null} @@ -8226,75 +8181,73 @@ export interface Model { */ width?: string|number; - /** The Virtual Scrolling feature is used to display a large amount of records in the DropDownList, that is, when scrolling, an AJAX request is sent to fetch some amount of data from - * the server dynamically. To achieve this scenario with DropDownList, set the allowVirtualScrolling to true. - * You can set the itemsCount property that represents the number of items to be fetched from the server on every AJAX request. + /** The Virtual Scrolling feature is used to display a large amount of records in the DropDownList, that is, when scrolling, an AJAX request is sent to fetch some amount of data from the server dynamically. To achieve this scenario with DropDownList, set the allowVirtualScrolling to true. You can set the itemsCount property that represents the number of items to be fetched from the server on every AJAX request. * @Default {normal} */ virtualScrollMode?: ej.VirtualScrollMode|string; /** Fires the action before the XHR request. */ - actionBegin?(e: ActionBeginEventArgs): void; + actionBegin? (e: ActionBeginEventArgs): void; /** Fires the action when the list of items is bound to the DropDownList by xhr post calling */ - actionComplete?(e: ActionCompleteEventArgs): void; + actionComplete? (e: ActionCompleteEventArgs): void; /** Fires the action when the xhr post calling failed on remote data binding with the DropDownList control. */ - actionFailure?(e: ActionFailureEventArgs): void; + actionFailure? (e: ActionFailureEventArgs): void; /** Fires the action when the xhr post calling succeed on remote data binding with the DropDownList control */ - actionSuccess?(e: ActionSuccessEventArgs): void; + actionSuccess? (e: ActionSuccessEventArgs): void; /** Fires the action before the popup is ready to hide. */ - beforePopupHide?(e: BeforePopupHideEventArgs): void; + beforePopupHide? (e: BeforePopupHideEventArgs): void; /** Fires the action before the popup is ready to be displayed. */ - beforePopupShown?(e: BeforePopupShownEventArgs): void; + beforePopupShown? (e: BeforePopupShownEventArgs): void; /** Fires when the cascading happens between two DropDownList exactly after the value changes in the first dropdown and before filtering in the second Dropdown. */ - cascade?(e: CascadeEventArgs): void; + cascade? (e: CascadeEventArgs): void; - /** Fires the action when the DropDownList control’s value is changed. */ - change?(e: ChangeEventArgs): void; + /** Fires the action when the DropDownList controlĂ¢â‚¬â„¢s value is changed. */ + change? (e: ChangeEventArgs): void; /** Fires the action when the list item checkbox value is changed. */ - checkChange?(e: CheckChangeEventArgs): void; + checkChange? (e: CheckChangeEventArgs): void; /** Fires the action once the DropDownList is created. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Fires the action when the list items is bound to the DropDownList. */ - dataBound?(e: DataBoundEventArgs): void; + dataBound? (e: DataBoundEventArgs): void; /** Fires the action when the DropDownList is destroyed. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Fires the action when the DropDownList is focused. */ - focusIn?(e: FocusInEventArgs): void; + focusIn? (e: FocusInEventArgs): void; /** Fires the action when the DropDownList is about to lose focus. */ - focusOut?(e: FocusOutEventArgs): void; + focusOut? (e: FocusOutEventArgs): void; /** Fires the action, once the popup is closed */ - popupHide?(e: PopupHideEventArgs): void; + popupHide? (e: PopupHideEventArgs): void; /** Fires the action, when the popup is resized. */ - popupResize?(e: PopupResizeEventArgs): void; + popupResize? (e: PopupResizeEventArgs): void; /** Fires the action, once the popup is opened. */ - popupShown?(e: PopupShownEventArgs): void; + popupShown? (e: PopupShownEventArgs): void; /** Fires the action, when resizing a popup starts. */ - popupResizeStart?(e: PopupResizeStartEventArgs): void; + popupResizeStart? (e: PopupResizeStartEventArgs): void; /** Fires the action, when the popup resizing is stopped. */ - popupResizeStop?(e: PopupResizeStopEventArgs): void; + popupResizeStop? (e: PopupResizeStopEventArgs): void; /** Fires the action before filtering the list items that starts in the DropDownList when the enableFilterSearch is enabled. */ - search?(e: SearchEventArgs): void; + search? (e: SearchEventArgs): void; /** Fires the action, when the list of item is selected. */ - select?(e: SelectEventArgs): void; + select? (e: SelectEventArgs): void; } export interface ActionBeginEventArgs { @@ -8326,11 +8279,11 @@ export interface ActionCompleteEventArgs { */ model?: any; - /** Returns the query for data retrieval + /** Returns the query for data retrieval */ query?: any; - /** Returns the query for data retrieval from the Database + /** Returns the query for data retrieval from the Database */ request?: any; @@ -8340,7 +8293,7 @@ export interface ActionCompleteEventArgs { /** Returns the number of items fetched from remote data */ - result?: any[]; + result?: Array; /** Returns the requested data */ @@ -8361,7 +8314,7 @@ export interface ActionFailureEventArgs { */ model?: any; - /** Returns the query for data retrieval + /** Returns the query for data retrieval */ query?: any; @@ -8384,11 +8337,11 @@ export interface ActionSuccessEventArgs { */ model?: any; - /** Returns the query for data retrieval + /** Returns the query for data retrieval */ query?: any; - /** Returns the query for data retrieval from the Database + /** Returns the query for data retrieval from the Database */ request?: any; @@ -8398,7 +8351,7 @@ export interface ActionSuccessEventArgs { /** Returns the number of items fetched from remote data */ - result?: any[]; + result?: Array; /** Returns the requested data */ @@ -8835,21 +8788,24 @@ export interface Fields { value?: string; } } -enum FilterType { -//filter the data wherever contains search key +enum FilterType +{ +//filter the data wherever contains search key Contains, //filter the data based on search key present at start position StartsWith, } -enum MultiSelectMode { -// can select only single item in DropDownList +enum MultiSelectMode +{ +// can select only single item in DropDownList None, //can select multiple items and it's separated by delimiterChar Delimiter, // can select multiple items and it's show's like visual box in textbox VisualMode, } -enum VirtualScrollMode { +enum VirtualScrollMode +{ // The data is loaded only to the corresponding page (display items). When scrolling some other position, it enables the load on demand with the DropDownList. Normal, //The data items are loaded from the remote when scroll handle reaches the end of the scrollbar like infinity scrolling. @@ -8858,10 +8814,11 @@ Continuous, class Tooltip extends ej.Widget { static fn: Tooltip; - constructor(element: JQuery | Element, options?: Tooltip.Model); + constructor(element: JQuery, options?: Tooltip.Model); + constructor(element: Element, options?: Tooltip.Model); static Locale: any; - model: Tooltip.Model; - defaults: Tooltip.Model; + model:Tooltip.Model; + defaults:Tooltip.Model; /** Destroys the Tooltip control. * @returns {void} @@ -8883,7 +8840,7 @@ class Tooltip extends ej.Widget { * @param {Function} optional custom effect takes place when hiding the tooltip. * @returns {void} */ - hide(effect?: string, func?: any): void; + hide(effect?: string, func?: Function): void; /** Shows the Tooltip popup for the given target element with the specified effect. * @param {string} optional Determines the type of effect that takes place when showing the tooltip. @@ -8891,9 +8848,9 @@ class Tooltip extends ej.Widget { * @param {JQuery} optional Tooltip will be shown for the given element * @returns {void} */ - show(effect?: string, func?: any, target?: JQuery): void; + show(effect?: string, func?: Function, target?: JQuery): void; } -export namespace Tooltip { +export module Tooltip{ export interface Model { @@ -8996,31 +8953,31 @@ export interface Model { width?: string|number; /** This event is triggered before the Tooltip widget get closed. */ - beforeClose?(e: BeforeCloseEventArgs): void; + beforeClose? (e: BeforeCloseEventArgs): void; /** This event is triggered before the Tooltip widget gets open. */ - beforeOpen?(e: BeforeOpenEventArgs): void; + beforeOpen? (e: BeforeOpenEventArgs): void; /** Fires on clicking to the target element. */ - click?(e: ClickEventArgs): void; + click? (e: ClickEventArgs): void; /** This event is triggered after the Tooltip widget is closed. */ - close?(e: CloseEventArgs): void; + close? (e: CloseEventArgs): void; /** This event is triggered after the Tooltip is created successfully. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** This event is triggered after the Tooltip widget is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** This event is triggered while hovering the target element, when tooltip positioning relates to target element. */ - hover?(e: HoverEventArgs): void; + hover? (e: HoverEventArgs): void; /** This event is triggered after the Tooltip is opened. */ - open?(e: OpenEventArgs): void; + open? (e: OpenEventArgs): void; /** This event is triggered while hover the target element, when the tooltip positioning is relates to the mouse. */ - tracking?(e: TrackingEventArgs): void; + tracking? (e: TrackingEventArgs): void; } export interface BeforeCloseEventArgs { @@ -9236,7 +9193,7 @@ export interface Position { stem?: PositionStem; } -enum effect { +enum effect{ ///No animation takes place when showing/hiding the Tooltip None, @@ -9249,7 +9206,7 @@ enum effect { } -enum Associate { +enum Associate{ ///Sets the position related to target element. Target, @@ -9268,7 +9225,7 @@ enum Associate { } -enum CloseMode { +enum CloseMode{ ///Enables close button in Tooltip. Sticky, @@ -9281,7 +9238,7 @@ enum CloseMode { } -enum Collision { +enum Collision{ ///Flips the Tooltip to the opposite side of the target, if collision is occurs. Flip, @@ -9297,7 +9254,7 @@ enum Collision { } -enum Trigger { +enum Trigger{ ///The Tooltip to be shown when the target element is clicked. Click, @@ -9313,10 +9270,11 @@ enum Trigger { class Editor extends ej.Widget { static fn: Editor; - constructor(element: JQuery | Element, options?: Editor.Model); + constructor(element: JQuery, options?: Editor.Model); + constructor(element: Element, options?: Editor.Model); static Locale: any; - model: Editor.Model; - defaults: Editor.Model; + model:Editor.Model; + defaults:Editor.Model; /** destroy the editor widgets all events are unbind automatically and bring the control to pre-init state. * @returns {void} @@ -9339,15 +9297,15 @@ class Editor extends ej.Widget { getValue(): number; } - class NumericTextbox extends Editor { + class NumericTextbox extends Editor{ } - class CurrencyTextbox extends Editor { + class CurrencyTextbox extends Editor{ } - class PercentageTextbox extends Editor { + class PercentageTextbox extends Editor{ } -export namespace Editor { +export module Editor{ export interface Model { @@ -9430,14 +9388,12 @@ export interface Model { */ name?: string; - /** Specifies the pattern for formatting positive values in editor.We have maintained some standard to define the negative pattern. - * you have to specify 'n' to place the digit in your pattern.ejTextbox allows you to define a currency or percent symbol where you want to place it. + /** Specifies the pattern for formatting positive values in editor.We have maintained some standard to define the negative pattern. you have to specify 'n' to place the digit in your pattern.ejTextbox allows you to define a currency or percent symbol where you want to place it. * @Default {Based on the culture} */ negativePattern?: string; - /** Specifies the pattern for formatting positive values in editor.We have maintained some standard to define the positive pattern. - * you have to specify 'n' to place the digit in your pattern.ejTextbox allows you to define a currency or percent symbol where you want to place it. + /** Specifies the pattern for formatting positive values in editor.We have maintained some standard to define the positive pattern. you have to specify 'n' to place the digit in your pattern.ejTextbox allows you to define a currency or percent symbol where you want to place it. * @Default {Based on the culture} */ positivePattern?: string; @@ -9488,19 +9444,19 @@ export interface Model { width?: string; /** Fires after Editor control value is changed. */ - change?(e: ChangeEventArgs): void; + change? (e: ChangeEventArgs): void; /** Fires after Editor control is created. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Fires when the Editor is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Fires after Editor control is focused. */ - focusIn?(e: FocusInEventArgs): void; + focusIn? (e: FocusInEventArgs): void; /** Fires after Editor control is loss the focus. */ - focusOut?(e: FocusOutEventArgs): void; + focusOut? (e: FocusOutEventArgs): void; } export interface ChangeEventArgs { @@ -9597,10 +9553,11 @@ export interface FocusOutEventArgs { class ListView extends ej.Widget { static fn: ListView; - constructor(element: JQuery | Element, options?: ListView.Model); + constructor(element: JQuery, options?: ListView.Model); + constructor(element: Element, options?: ListView.Model); static Locale: any; - model: ListView.Model; - defaults: ListView.Model; + model:ListView.Model; + defaults:ListView.Model; /** To add item in the given index. If you have enabled grouping in ListView then you need to pass the corresponding group list title to add item in it. * @param {any} Specifies the item to be added in ListView @@ -9657,12 +9614,12 @@ class ListView extends ej.Widget { /** To get all the checked items. * @returns {Array} */ - getCheckedItems(): any[]; + getCheckedItems(): Array; /** To get the text of all the checked items. * @returns {Array} */ - getCheckedItemsText(): any[]; + getCheckedItemsText(): Array; /** To get the total item count. * @returns {number} @@ -9749,7 +9706,7 @@ class ListView extends ej.Widget { */ unCheckItem(index: number): void; } -export namespace ListView { +export module ListView{ export interface Model { @@ -9761,17 +9718,16 @@ export interface Model { /** Set the index values to be selected on initial loading. This works only when enableCheckMark is set true. * @Default {[]} */ - checkedIndices?: any[]; + checkedIndices?: Array; - /** Sets the root class for ListView theme. This cssClass API helps to use custom skinning option for ListView control. By defining the root class using this API, - * we need to include this root class in CSS. + /** Sets the root class for ListView theme. This cssClass API helps to use custom skinning option for ListView control. By defining the root class using this API, we need to include this root class in CSS. */ cssClass?: string; /** Contains the list of data for generating the ListView items. * @Default {[]} */ - dataSource?: any[]; + dataSource?: Array; /** Specifies whether to load AJAX content while selecting item. * @Default {false} @@ -9810,7 +9766,7 @@ export interface Model { /** Contains the array of items to be added in ListView. * @Default {[]} */ - items?: any[]; + items?: Array; /** Specifies the text of the back button in the header. * @Default {null} @@ -9877,28 +9833,28 @@ export interface Model { width?: string|number; /** Event triggers before the AJAX request happens. */ - ajaxBeforeLoad?(e: AjaxBeforeLoadEventArgs): void; + ajaxBeforeLoad? (e: AjaxBeforeLoadEventArgs): void; /** Event triggers after the AJAX content loaded completely. */ - ajaxComplete?(e: AjaxCompleteEventArgs): void; + ajaxComplete? (e: AjaxCompleteEventArgs): void; /** Event triggers when the AJAX request failed. */ - ajaxError?(e: AjaxErrorEventArgs): void; + ajaxError? (e: AjaxErrorEventArgs): void; /** Event triggers after the AJAX content loaded successfully. */ - ajaxSuccess?(e: AjaxSuccessEventArgs): void; + ajaxSuccess? (e: AjaxSuccessEventArgs): void; /** Event triggers before the items loaded. */ - load?(e: LoadEventArgs): void; + load? (e: LoadEventArgs): void; /** Event triggers after the items loaded. */ - loadComplete?(e: LoadCompleteEventArgs): void; + loadComplete? (e: LoadCompleteEventArgs): void; /** Event triggers when mouse down happens on the item. */ - mouseDown?(e: MouseDownEventArgs): void; + mouseDown? (e: MouseDownEventArgs): void; /** Event triggers when mouse up happens on the item. */ - mouseUp?(e: MouseUpEventArgs): void; + mouseUp? (e: MouseUpEventArgs): void; } export interface AjaxBeforeLoadEventArgs { @@ -10151,10 +10107,11 @@ export interface AjaxSettings { class MaskEdit extends ej.Widget { static fn: MaskEdit; - constructor(element: JQuery | Element, options?: MaskEdit.Model); + constructor(element: JQuery, options?: MaskEdit.Model); + constructor(element: Element, options?: MaskEdit.Model); static Locale: any; - model: MaskEdit.Model; - defaults: MaskEdit.Model; + model:MaskEdit.Model; + defaults:MaskEdit.Model; /** To clear the text in mask edit textbox control. * @returns {void} @@ -10181,7 +10138,7 @@ class MaskEdit extends ej.Widget { */ get_UnstrippedValue(): string; } -export namespace MaskEdit { +export module MaskEdit{ export interface Model { @@ -10285,34 +10242,34 @@ export interface Model { width?: string; /** Fires when value changed in mask edit textbox control. */ - change?(e: ChangeEventArgs): void; + change? (e: ChangeEventArgs): void; /** Fires after MaskEdit control is created. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Fires when the MaskEdit is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Fires when focused in mask edit textbox control. */ - focusIn?(e: FocusInEventArgs): void; + focusIn? (e: FocusInEventArgs): void; /** Fires when focused out in mask edit textbox control. */ - focusOut?(e: FocusOutEventArgs): void; + focusOut? (e: FocusOutEventArgs): void; /** Fires when keydown in mask edit textbox control. */ - keydown?(e: KeydownEventArgs): void; + keydown? (e: KeydownEventArgs): void; /** Fires when key press in mask edit textbox control. */ - keyPress?(e: KeyPressEventArgs): void; + keyPress? (e: KeyPressEventArgs): void; /** Fires when keyup in mask edit textbox control. */ - keyup?(e: KeyupEventArgs): void; + keyup? (e: KeyupEventArgs): void; /** Fires when mouse out in mask edit textbox control. */ - mouseOut?(e: MouseOutEventArgs): void; + mouseOut? (e: MouseOutEventArgs): void; /** Fires when mouse over in mask edit textbox control. */ - mouseOver?(e: MouseOverEventArgs): void; + mouseOver? (e: MouseOverEventArgs): void; } export interface ChangeEventArgs { @@ -10529,13 +10486,15 @@ export interface MouseOverEventArgs { unmaskedValue?: string; } } -enum InputMode { +enum InputMode +{ //string Password, //string Text, } -enum TextAlign { +enum TextAlign +{ //string Center, //string @@ -10548,10 +10507,11 @@ Right, class Menu extends ej.Widget { static fn: Menu; - constructor(element: JQuery | Element, options?: Menu.Model); + constructor(element: JQuery, options?: Menu.Model); + constructor(element: Element, options?: Menu.Model); static Locale: any; - model: Menu.Model; - defaults: Menu.Model; + model:Menu.Model; + defaults:Menu.Model; /** Disables the Menu control. * @returns {void} @@ -10622,7 +10582,7 @@ class Menu extends ej.Widget { * @param {any|Array} Selector of target node or Object of target node. * @returns {void} */ - remove(target: any|any[]): void; + remove(target: any|Array): void; /** To show the Menu control. * @param {number} x co-ordinate position of context menu. @@ -10638,7 +10598,7 @@ class Menu extends ej.Widget { */ showItems(): void; } -export namespace Menu { +export module Menu{ export interface Model { @@ -10757,37 +10717,37 @@ export interface Model { overflowWidth?: string|number; /** Fires before context menu gets open. */ - beforeOpen?(e: BeforeOpenEventArgs): void; + beforeOpen? (e: BeforeOpenEventArgs): void; /** Fires when mouse click on menu items. */ - click?(e: ClickEventArgs): void; + click? (e: ClickEventArgs): void; /** Fire when context menu on close. */ - close?(e: CloseEventArgs): void; + close? (e: CloseEventArgs): void; /** Fires when context menu on open. */ - open?(e: OpenEventArgs): void; + open? (e: OpenEventArgs): void; /** Fires to create menu items. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Fires to destroy menu items. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Fires when key down on menu items. */ - keydown?(e: KeydownEventArgs): void; + keydown? (e: KeydownEventArgs): void; /** Fires when mouse out from menu items. */ - mouseout?(e: MouseoutEventArgs): void; + mouseout? (e: MouseoutEventArgs): void; /** Fires when mouse over the Menu items. */ - mouseover?(e: MouseoverEventArgs): void; + mouseover? (e: MouseoverEventArgs): void; /** Fires when overflow popup menu opens. */ - overflowOpen?(e: OverflowOpenEventArgs): void; + overflowOpen? (e: OverflowOpenEventArgs): void; /** Fires when overflow popup menu closes. */ - overflowClose?(e: OverflowCloseEventArgs): void; + overflowClose? (e: OverflowCloseEventArgs): void; } export interface BeforeOpenEventArgs { @@ -11005,7 +10965,7 @@ export interface Fields { */ dataSource?: any; - /** Specifies the HTML attributes to “LI†item list. + /** Specifies the HTML attributes to Ă¢â‚¬Å“LIĂ¢â‚¬Â item list. */ htmlAttribute?: string; @@ -11013,11 +10973,11 @@ export interface Fields { */ id?: string; - /** Specifies the image attribute to “img†tag inside items list. + /** Specifies the image attribute to Ă¢â‚¬Å“imgĂ¢â‚¬Â tag inside items list. */ imageAttribute?: string; - /** Specifies the image URL to “img†tag inside item list. + /** Specifies the image URL to Ă¢â‚¬Å“imgĂ¢â‚¬Â tag inside item list. */ imageUrl?: string; @@ -11033,7 +10993,7 @@ export interface Fields { */ query?: any; - /** Specifies the sprite CSS class to “LI†item list. + /** Specifies the sprite CSS class to Ă¢â‚¬Å“LIĂ¢â‚¬Â item list. */ spriteCssClass?: string; @@ -11050,19 +11010,22 @@ export interface Fields { url?: string; } } -enum AnimationType { +enum AnimationType +{ //string Default, //string None, } -enum MenuType { +enum MenuType +{ //string ContextMenu, //string NormalMenu, } -enum Direction { +enum Direction +{ //string Left, //string @@ -11073,10 +11036,11 @@ Right, class Pager extends ej.Widget { static fn: Pager; - constructor(element: JQuery | Element, options?: Pager.Model); + constructor(element: JQuery, options?: Pager.Model); + constructor(element: Element, options?: Pager.Model); static Locale: any; - model: Pager.Model; - defaults: Pager.Model; + model:Pager.Model; + defaults:Pager.Model; /** Send a paging request to specified page through the pager control. * @param {number} Specifies the index to be navigated @@ -11089,7 +11053,7 @@ class Pager extends ej.Widget { */ refreshPager(): void; } -export namespace Pager { +export module Pager{ export interface Model { @@ -11121,8 +11085,7 @@ export interface Model { */ externalMessage?: string; - /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. - * in a language and culture specific to a particular country or region. + /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and culture specific to a particular country or region. * @Default {en-US} */ locale?: string; @@ -11153,7 +11116,7 @@ export interface Model { showPageInfo?: boolean; /** Triggered when pager numeric item is clicked in pager control. */ - click?(e: ClickEventArgs): void; + click? (e: ClickEventArgs): void; } export interface ClickEventArgs { @@ -11182,10 +11145,11 @@ export interface ClickEventArgs { class ProgressBar extends ej.Widget { static fn: ProgressBar; - constructor(element: JQuery | Element, options?: ProgressBar.Model); + constructor(element: JQuery, options?: ProgressBar.Model); + constructor(element: Element, options?: ProgressBar.Model); static Locale: any; - model: ProgressBar.Model; - defaults: ProgressBar.Model; + model:ProgressBar.Model; + defaults:ProgressBar.Model; /** Destroy the progressbar widget * @returns {void} @@ -11212,7 +11176,7 @@ class ProgressBar extends ej.Widget { */ getValue(): number; } -export namespace ProgressBar { +export module ProgressBar{ export interface Model { @@ -11282,19 +11246,19 @@ export interface Model { width?: number|string; /** Event triggers when the progress value changed */ - change?(e: ChangeEventArgs): void; + change? (e: ChangeEventArgs): void; /** Event triggers when the process completes (at 100%) */ - complete?(e: CompleteEventArgs): void; + complete? (e: CompleteEventArgs): void; /** Event triggers when the progressbar are created */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Event triggers when the progressbar are destroyed */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Event triggers when the process starts (from 0%) */ - start?(e: StartEventArgs): void; + start? (e: StartEventArgs): void; } export interface ChangeEventArgs { @@ -11399,10 +11363,11 @@ export interface StartEventArgs { class RadioButton extends ej.Widget { static fn: RadioButton; - constructor(element: JQuery | Element, options?: RadioButton.Model); + constructor(element: JQuery, options?: RadioButton.Model); + constructor(element: Element, options?: RadioButton.Model); static Locale: any; - model: RadioButton.Model; - defaults: RadioButton.Model; + model:RadioButton.Model; + defaults:RadioButton.Model; /** To disable the RadioButton * @returns {void} @@ -11414,7 +11379,7 @@ class RadioButton extends ej.Widget { */ enable(): void; } -export namespace RadioButton { +export module RadioButton{ export interface Model { @@ -11432,8 +11397,7 @@ export interface Model { */ enabled?: boolean; - /** Specifies the enablePersistence property for RadioButton while initialization. The enablePersistence API save current model value to browser cookies for state maintains. - * While refreshing the radio button control page the model value apply from browser cookies. + /** Specifies the enablePersistence property for RadioButton while initialization. The enablePersistence API save current model value to browser cookies for state maintains. While refreshing the radio button control page the model value apply from browser cookies. * @Default {false} */ enablePersistence?: boolean; @@ -11488,16 +11452,16 @@ export interface Model { value?: string; /** Fires before the RadioButton is going to changed its state successfully */ - beforeChange?(e: BeforeChangeEventArgs): void; + beforeChange? (e: BeforeChangeEventArgs): void; /** Fires when the RadioButton state is changed successfully */ - change?(e: ChangeEventArgs): void; + change? (e: ChangeEventArgs): void; /** Fires when the RadioButton created successfully */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Fires when the RadioButton destroyed successfully */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; } export interface BeforeChangeEventArgs { @@ -11576,7 +11540,8 @@ export interface DestroyEventArgs { type?: string; } } -enum RadioButtonSize { +enum RadioButtonSize +{ //Shows small size radio button Small, //Shows medium size radio button @@ -11585,10 +11550,11 @@ Medium, class Rating extends ej.Widget { static fn: Rating; - constructor(element: JQuery | Element, options?: Rating.Model); + constructor(element: JQuery, options?: Rating.Model); + constructor(element: Element, options?: Rating.Model); static Locale: any; - model: Rating.Model; - defaults: Rating.Model; + model:Rating.Model; + defaults:Rating.Model; /** Destroy the Rating widget all events bound will be unbind automatically and bring the control to pre-init state. * @returns {void} @@ -11626,7 +11592,7 @@ class Rating extends ej.Widget { */ show(): void; } -export namespace Rating { +export module Rating{ export interface Model { @@ -11715,22 +11681,22 @@ export interface Model { width?: string; /** Fires when Rating value changes. */ - change?(e: ChangeEventArgs): void; + change? (e: ChangeEventArgs): void; /** Fires when Rating control is clicked successfully. */ - click?(e: ClickEventArgs): void; + click? (e: ClickEventArgs): void; /** Fires when Rating control is created. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Fires when Rating control is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Fires when mouse hover is removed from Rating control. */ - mouseout?(e: MouseoutEventArgs): void; + mouseout? (e: MouseoutEventArgs): void; /** Fires when mouse hovered over the Rating control. */ - mouseover?(e: MouseoverEventArgs): void; + mouseover? (e: MouseoverEventArgs): void; } export interface ChangeEventArgs { @@ -11859,7 +11825,7 @@ export interface MouseoverEventArgs { index?: any; } -enum Precision { +enum Precision{ ///string Exact, @@ -11875,13 +11841,13 @@ enum Precision { class Ribbon extends ej.Widget { static fn: Ribbon; - constructor(element: JQuery | Element, options?: Ribbon.Model); + constructor(element: JQuery, options?: Ribbon.Model); + constructor(element: Element, options?: Ribbon.Model); static Locale: any; - model: Ribbon.Model; - defaults: Ribbon.Model; + model:Ribbon.Model; + defaults:Ribbon.Model; - /** Adds contextual tab or contextual tab set dynamically in the ribbon control with contextual tabs object and index position. - * When index is null, ribbon contextual tab or contextual tab set is added at the last index. + /** Adds contextual tab or contextual tab set dynamically in the ribbon control with contextual tabs object and index position. When index is null, ribbon contextual tab or contextual tab set is added at the last index. * @param {any} contextual tab or contextual tab set object. * @param {number} index of the contextual tab or contextual tab set, this is optional. * @returns {void} @@ -11901,7 +11867,7 @@ class Ribbon extends ej.Widget { * @param {number} index of the ribbon tab,this is optional. * @returns {void} */ - addTab(tabText: string, ribbonGroups: any[], index?: number): void; + addTab(tabText: string, ribbonGroups: Array, index?: number): void; /** Adds tab group dynamically in the ribbon control with given tab index, tab group object and group index position. When group index is null, ribbon group is added at the last index. * @param {number} ribbon tab index. @@ -11911,16 +11877,15 @@ class Ribbon extends ej.Widget { */ addTabGroup(tabIndex: number, tabGroup: any, groupIndex?: number): void; - /** Adds group content dynamically in the ribbon control with given tab index, group index, sub group index, content and content index position. - * When content index is null, content is added at the last index. + /** Adds group content dynamically in the ribbon control with given tab index, group index, content, content index and sub group index position. When content index is null, content is added at the last index. * @param {number} ribbon tab index. * @param {number} ribbon group index. - * @param {number} sub group index in the ribbon group, * @param {any} content to be displayed in the ribbon group. - * @param {number} ribbon content index .this is optional. + * @param {number} ribbon content index. This is optional. If the value is not given, then by default contentIndex will be considered as 0. + * @param {number} sub group index in the ribbon group. This is optional. If the value is not given, then by default contentIndex will be considered as 0. * @returns {void} */ - addTabGroupContent(tabIndex: number, groupIndex: number, subGroupIndex: number, content: any, contentIndex?: number): void; + addTabGroupContent(tabIndex: number, groupIndex: number, content: any, contentIndex?: number, subGroupIndex?: number): void; /** Hides the ribbon backstage page. * @returns {void} @@ -11946,7 +11911,7 @@ class Ribbon extends ej.Widget { * @param {number} index of the tab item. * @returns {String} */ - getTabText(index: number): string; + getTabText(index: number): String; /** Hides the given text tab in the ribbon control. * @param {string} text of the tab item. @@ -11958,13 +11923,13 @@ class Ribbon extends ej.Widget { * @param {string} text of the tab item. * @returns {Boolean} */ - isEnable(text: string): boolean; + isEnable(text: string): Boolean; /** Checks whether the given text tab in the ribbon control is visible or not. * @param {string} text of the tab item. * @returns {Boolean} */ - isVisible(text: string): boolean; + isVisible(text: string): Boolean; /** Removes the given index tab item from the ribbon control. * @param {number} index of tab item. @@ -12008,10 +11973,11 @@ class Ribbon extends ej.Widget { /** To customize whole content from Tab Group. * @param {number} ribbon tab index. * @param {string} ribbon group text. - * @param {number} sub group index in the ribbon group, + * @param {number} ribbon content index. This is optional. If the value is not given, all content groups will be removed. + * @param {number} sub group index in the ribbon group. This is optional. If the value is not given, all content groups will be removed. * @returns {void} */ - removeTabGroupContent(tabIndex: number, groupText: string, subGroupIndex?: number): void; + removeTabGroupContent(tabIndex: number, groupText: string, contentIndex?: number, subGroupIndex?: number): void; /** Remove option from Backstage. * @param {number} index to the backstage item @@ -12019,7 +11985,7 @@ class Ribbon extends ej.Widget { */ removeBackStageItem(index: number): void; } -export namespace Ribbon { +export module Ribbon{ export interface Model { @@ -12033,8 +11999,7 @@ export interface Model { */ isResponsive?: boolean; - /** Specifies the height, width, enableRTL, showRoundedCorner,enabled,cssClass property to the controls in the ribbon commonly andit will work only when those properties - * are not defined in buttonSettings and content defaults. + /** Specifies the height, width, enableRTL, showRoundedCorner,enabled,cssClass property to the controls in the ribbon commonly andit will work only when those properties are not defined in buttonSettings and content defaults. * @Default {Object} */ buttonDefaults?: any; @@ -12074,21 +12039,20 @@ export interface Model { */ applicationTab?: ApplicationTab; - /** Specifies the contextual tabs and tab set to the ribbon control with the background color and border color. Refer to the tabs section for adding tabs - * into the contextual tab and contextual tab set. + /** Specifies the contextual tabs and tab set to the ribbon control with the background color and border color. Refer to the tabs section for adding tabs into the contextual tab and contextual tab set. * @Default {Array} */ - contextualTabs?: ContextualTab[]; + contextualTabs?: Array; /** Specifies the index or indexes to disable the given index tab or indexes tabs in the ribbon control. * @Default {0} */ - disabledItemIndex?: any[]; + disabledItemIndex?: Array; /** Specifies the index or indexes to enable the given index tab or indexes tabs in the ribbon control. * @Default {null} */ - enabledItemIndex?: any[]; + enabledItemIndex?: Array; /** Specifies the index of the ribbon tab to select the given index tab item in the ribbon control. * @Default {1} @@ -12098,10 +12062,9 @@ export interface Model { /** Specifies the tabs and its groups. Also specifies the control details that has to be placed in the tab area in the ribbon control. * @Default {Array} */ - tabs?: Tab[]; + tabs?: Array; - /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and culture specific - * to a particular country or region and it will need to use the user's preference. + /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and culture specific to a particular country or region and it will need to use the user's preference. * @Default {en-US} */ locale?: string; @@ -12112,55 +12075,55 @@ export interface Model { width?: string|number; /** Triggered before the ribbon tab item is removed. */ - beforeTabRemove?(e: BeforeTabRemoveEventArgs): void; + beforeTabRemove? (e: BeforeTabRemoveEventArgs): void; /** Triggered before the ribbon control is created. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Triggered before the ribbon control is destroyed. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Triggered when the control in the group is clicked successfully. */ - groupClick?(e: GroupClickEventArgs): void; + groupClick? (e: GroupClickEventArgs): void; /** Triggered when the group expander in the group is clicked successfully. */ - groupExpand?(e: GroupExpandEventArgs): void; + groupExpand? (e: GroupExpandEventArgs): void; /** Triggered when an item in the Gallery control is clicked successfully. */ - galleryItemClick?(e: GalleryItemClickEventArgs): void; + galleryItemClick? (e: GalleryItemClickEventArgs): void; /** Triggered when a tab or button in the backstage page is clicked successfully. */ - backstageItemClick?(e: BackstageItemClickEventArgs): void; + backstageItemClick? (e: BackstageItemClickEventArgs): void; /** Triggered when the ribbon control is collapsed. */ - collapse?(e: CollapseEventArgs): void; + collapse? (e: CollapseEventArgs): void; /** Triggered when the ribbon control is expanded. */ - expand?(e: ExpandEventArgs): void; + expand? (e: ExpandEventArgs): void; /** Triggered before the ribbon control is load. */ - load?(e: LoadEventArgs): void; + load? (e: LoadEventArgs): void; /** Triggered after adding the new ribbon tab item. */ - tabAdd?(e: TabAddEventArgs): void; + tabAdd? (e: TabAddEventArgs): void; /** Triggered when tab is clicked successfully in the ribbon control. */ - tabClick?(e: TabClickEventArgs): void; + tabClick? (e: TabClickEventArgs): void; /** Triggered before the ribbon tab is created. */ - tabCreate?(e: TabCreateEventArgs): void; + tabCreate? (e: TabCreateEventArgs): void; /** Triggered after the tab item is removed from the ribbon control. */ - tabRemove?(e: TabRemoveEventArgs): void; + tabRemove? (e: TabRemoveEventArgs): void; /** Triggered after the ribbon tab item is selected in the ribbon control. */ - tabSelect?(e: TabSelectEventArgs): void; + tabSelect? (e: TabSelectEventArgs): void; /** Triggered when the expand/collapse button is clicked successfully . */ - toggleButtonClick?(e: ToggleButtonClickEventArgs): void; + toggleButtonClick? (e: ToggleButtonClickEventArgs): void; /** Triggered when the QAT menu item is clicked successfully . */ - qatMenuItemClick?(e: QatMenuItemClickEventArgs): void; + qatMenuItemClick? (e: QatMenuItemClickEventArgs): void; } export interface BeforeTabRemoveEventArgs { @@ -12548,8 +12511,7 @@ export interface ApplicationTabBackstageSettingsPage { */ text?: string; - /** Specifies the type for ribbon backstage page's contents. Set "ej.Ribbon.BackStageItemType.Tab" to render the tab or " - * ej.Ribbon.BackStageItemType.Button" to render the button. + /** Specifies the type for ribbon backstage page's contents. Set "ej.Ribbon.BackStageItemType.Tab" to render the tab or "ej.Ribbon.BackStageItemType.Button" to render the button. * @Default {ej.Ribbon.ItemType.Tab} */ itemType?: ej.Ribbon.ItemType|string; @@ -12585,7 +12547,7 @@ export interface ApplicationTabBackstageSettings { /** Specifies the ribbon backstage page with its tab and button elements. * @Default {Array} */ - pages?: ApplicationTabBackstageSettingsPage[]; + pages?: Array; /** Specifies the width of backstage page header that contains tabs and buttons. * @Default {null} @@ -12610,8 +12572,7 @@ export interface ApplicationTab { */ menuSettings?: any; - /** Specifies the application menu or backstage page. Specify the type of application tab as "ej.Ribbon.ApplicationTabType.Menu" to render the application menu or - * "ej.Ribbon.ApplicationTabType.Backstage" to render backstage page in the ribbon control. + /** Specifies the application menu or backstage page. Specify the type of application tab as "ej.Ribbon.ApplicationTabType.Menu" to render the application menu or "ej.Ribbon.ApplicationTabType.Backstage" to render backstage page in the ribbon control. * @Default {ej.Ribbon.ApplicationTabType.Menu} */ type?: ej.Ribbon.ApplicationTabType|string; @@ -12632,7 +12593,7 @@ export interface ContextualTab { /** Specifies the tabs to present in the contextual tabs and tab set. Refer to the tabs section for adding tabs into the contextual tabs and tab set. * @Default {Array} */ - tabs?: any[]; + tabs?: Array; } export interface TabsGroupsContentDefaults { @@ -12767,7 +12728,7 @@ export interface TabsGroupsContentGroup { /** Specifies the Syncfusion button and menu as gallery extra items. * @Default {Array} */ - customGalleryItems?: TabsGroupsContentGroupsCustomGalleryItem[]; + customGalleryItems?: Array; /** Provides custom tooltip for button, split button, dropdown list, toggle button, custom controls in the sub groups. Text and HTML support are also provided for title and content. * @Default {Object} @@ -12792,7 +12753,7 @@ export interface TabsGroupsContentGroup { /** Defines each gallery content. * @Default {Array} */ - galleryItems?: TabsGroupsContentGroupsGalleryItem[]; + galleryItems?: Array; /** Specifies the Id for button, split button, dropdown list, toggle button, gallery, custom controls in the sub groups. * @Default {null} @@ -12839,8 +12800,7 @@ export interface TabsGroupsContentGroup { */ quickAccessMode?: ej.Ribbon.QuickAccessMode|string; - /** Specifies the type as "ej.Ribbon.Type.Button" or "ej.Ribbon.Type.SplitButton" or "ej.Ribbon.Type.DropDownList" or "ej.Ribbon.Type.ToggleButton" - * or "ej.Ribbon.Type.Custom" or "ej.Ribbon.Type.Gallery" to render button, split, dropdown, toggle button, gallery, custom controls. + /** Specifies the type as "ej.Ribbon.Type.Button" or "ej.Ribbon.Type.SplitButton" or "ej.Ribbon.Type.DropDownList" or "ej.Ribbon.Type.ToggleButton" or "ej.Ribbon.Type.Custom" or "ej.Ribbon.Type.Gallery" to render button, split, dropdown, toggle button, gallery, custom controls. * @Default {ej.Ribbon.Type.Button} */ type?: ej.Ribbon.Type|string; @@ -12856,7 +12816,7 @@ export interface TabsGroupsContent { /** Specifies the controls such as Syncfusion button, split button, dropdown list, toggle button, gallery, custom controls in the subgroup of the ribbon tab . * @Default {Array} */ - groups?: TabsGroupsContentGroup[]; + groups?: Array; } export interface TabsGroupsGroupExpanderSettings { @@ -12874,8 +12834,7 @@ export interface TabsGroupsGroupExpanderSettings { export interface TabsGroup { - /** Specifies the alignment of controls in the groups in 'row' type or 'column' type. Value for row type is "ej.Ribbon.AlignType.Rows" - * and for column type is "ej.Ribbon.alignType.columns". + /** Specifies the alignment of controls in the groups in 'row' type or 'column' type. Value for row type is "ej.Ribbon.AlignType.Rows" and for column type is "ej.Ribbon.alignType.columns". * @Default {ej.Ribbon.AlignType.Rows} */ alignType?: ej.Ribbon.AlignType|string; @@ -12883,7 +12842,7 @@ export interface TabsGroup { /** Specifies the Syncfusion button, split button, dropdown list, toggle button, gallery, custom controls to the groups in the ribbon control. * @Default {Array} */ - content?: TabsGroupsContent[]; + content?: Array; /** Specifies the ID of custom items to be placed in the groups. * @Default {null} @@ -12921,7 +12880,7 @@ export interface Tab { /** Specifies single group or multiple groups and its contents to each tab in the ribbon control. * @Default {Array} */ - groups?: TabsGroup[]; + groups?: Array; /** Specifies the ID for each tab's content panel. * @Default {null} @@ -12934,17 +12893,17 @@ export interface Tab { text?: string; } -enum ItemType { +enum ItemType{ - ///To render the button for ribbon backstage page’s contents + ///To render the button for ribbon backstage pageĂ¢â‚¬â„¢s contents Button, - ///To render the tab for ribbon backstage page’s contents + ///To render the tab for ribbon backstage pageĂ¢â‚¬â„¢s contents Tab } -enum ApplicationTabType { +enum ApplicationTabType{ ///applicationTab display as menu Menu, @@ -12954,7 +12913,7 @@ enum ApplicationTabType { } -enum AlignType { +enum AlignType{ ///To align the group content's in row Rows, @@ -12964,7 +12923,7 @@ enum AlignType { } -enum CustomItemType { +enum CustomItemType{ ///Specifies the button type in customGalleryItems Button, @@ -12974,9 +12933,9 @@ enum CustomItemType { } -enum QuickAccessMode { +enum QuickAccessMode{ - ///Controls are hidden in Quick Access toolbar + ///Controls are hidden in Quick Access toolbar None, ///Add controls in toolBar @@ -12987,7 +12946,7 @@ enum QuickAccessMode { } -enum Type { +enum Type{ ///Specifies the button control Button, @@ -13012,10 +12971,11 @@ enum Type { class Kanban extends ej.Widget { static fn: Kanban; - constructor(element: JQuery | Element, options?: Kanban.Model); + constructor(element: JQuery, options?: Kanban.Model); + constructor(element: Element, options?: Kanban.Model); static Locale: any; - model: Kanban.Model; - defaults: Kanban.Model; + model:Kanban.Model; + defaults:Kanban.Model; /** Add or remove columns in Kanban columns collections.Default action is add. * @param {Array|string} Pass array of columns or string of headerText to add/remove the column in Kanban @@ -13023,7 +12983,7 @@ class Kanban extends ej.Widget { * @param {string} optional Pass add/remove action to be performed. By default "add" action will perform * @returns {void} */ - columns(columndetails: any[]|string, keyvalue: any[]|string, action?: string): void; + columns(columndetails: Array|string, keyvalue: Array|string, action?: string): void; /** Destroy the Kanban widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. * @returns {void} @@ -13034,7 +12994,7 @@ class Kanban extends ej.Widget { * @param {Array} Pass new data source to the Kanban * @returns {void} */ - dataSource(datasource: any[]): void; + dataSource(datasource: Array): void; /** toggleColumn based on the headerText in Kanban. * @param {any} Pass the header text of the column to get the corresponding column object @@ -13043,7 +13003,7 @@ class Kanban extends ej.Widget { toggleColumn(headerText: any): void; /** Expand or collapse the card based on the state of target "div" - * @param {string|number} Pass the id of card to be toggle + * @param {string|number} Pass the id of card to be toggle * @returns {void} */ toggleCard(key: string|number): void; @@ -13051,7 +13011,7 @@ class Kanban extends ej.Widget { /** Used for get the names of all the visible column name collections in Kanban. * @returns {Array} */ - getVisibleColumnNames(): any[]; + getVisibleColumnNames(): Array; /** Get the scroller object of Kanban. * @returns {ej.Scroller} @@ -13062,18 +13022,18 @@ class Kanban extends ej.Widget { * @param {string} Pass the header text of the column to get the corresponding column object * @returns {String} */ - getColumnByHeaderText(headerText: string): string; + getColumnByHeaderText(headerText: string): String; /** Get the table details based on the given header table in Kanban. * @returns {String} */ - getHeaderTable(): string; + getHeaderTable(): String; /** Hide columns from the Kanban based on the header text * @param {Array|string} you can pass either array of header text of various columns or a header text of a column to hide * @returns {void} */ - hideColumns(headerText: any[]|string): void; + hideColumns(headerText: Array|string): void; /** Print the Kanban Board * @returns {void} @@ -13095,14 +13055,14 @@ class Kanban extends ej.Widget { * @param {Array|string} You can pass either array of header text of various columns or a header text of a column to show * @returns {void} */ - showColumns(headerText: any[]|string): void; + showColumns(headerText: Array|string): void; /** Update a card in Kanban control based on key and JSON data given. * @param {string} Pass the key field Name of the column * @param {Array} Pass the edited JSON data of card need to be update. * @returns {void} */ - updateCard(key: string, data: any[]): void; + updateCard(key: string, data: Array): void; KanbanSelection: Kanban.KanbanSelection; @@ -13112,7 +13072,7 @@ class Kanban extends ej.Widget { KanbanEdit: Kanban.KanbanEdit; } -export namespace Kanban { +export module Kanban{ export interface KanbanSelection { @@ -13172,7 +13132,7 @@ export interface KanbanEdit { * @param {Array} Pass the edited JSON data of card need to be add. * @returns {void} */ - addCard(primaryKey: string, card: any[]): void; + addCard(primaryKey: string,card: Array): void; /** Send a cancel request of add/edit card in Kanban when allowEditing/allowAdding is set as true. * @returns {void} @@ -13201,7 +13161,7 @@ export interface KanbanEdit { * @param {any} Specify the validation rules for the field * @returns {void} */ - setValidationToField(name: string, rules: any): void; + setValidationToField(name: string,rules: any): void; } export interface Model { @@ -13269,7 +13229,7 @@ export interface Model { /** Gets or sets an object that indicates to render the Kanban with specified columns. * @Default {Array} */ - columns?: Column[]; + columns?: Array; /** Gets or sets an object that indicates whether to Customize the card settings. * @Default {Object} @@ -13279,7 +13239,7 @@ export interface Model { /** Gets or sets a value that indicates whether to add customToolbarItems within the toolbar to perform any action in the Kanban. * @Default {[]} */ - customToolbarItems?: CustomToolbarItem[]; + customToolbarItems?: Array; /** Gets or sets a value that indicates to render the Kanban with custom theme. */ @@ -13333,7 +13293,7 @@ export interface Model { /** To customize the filtering behavior based on queries given. * @Default {Array} */ - filterSettings?: FilterSetting[]; + filterSettings?: Array; /** ej Query to query database of Kanban. * @Default {null} @@ -13363,7 +13323,7 @@ export interface Model { /** Gets or sets an object that indicates to managing the collection of stacked header rows for the Kanban. * @Default {Array} */ - stackedHeaderRows?: StackedHeaderRow[]; + stackedHeaderRows?: Array; /** The tooltip allows to display card details in a tooltip while hovering on it. */ @@ -13372,88 +13332,90 @@ export interface Model { /** Gets or sets an object that indicates to render the Kanban with specified workflows. * @Default {Array} */ - workflows?: Workflow[]; + workflows?: Array; - /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and culture specific - * to a particular country or region. + /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and culture specific to a particular country or region. * @Default {en-US} */ locale?: string; /** Triggered for every Kanban action before its starts. */ - actionBegin?(e: ActionBeginEventArgs): void; + actionBegin? (e: ActionBeginEventArgs): void; /** Triggered for every Kanban action success event. */ - actionComplete?(e: ActionCompleteEventArgs): void; + actionComplete? (e: ActionCompleteEventArgs): void; /** Triggered for every Kanban action server failure event. */ - actionFailure?(e: ActionFailureEventArgs): void; + actionFailure? (e: ActionFailureEventArgs): void; /** Triggered before the task is going to be edited. */ - beginEdit?(e: BeginEditEventArgs): void; + beginEdit? (e: BeginEditEventArgs): void; /** Triggered before the card is going to be added */ - beginAdd?(e: BeginAddEventArgs): void; + beginAdd? (e: BeginAddEventArgs): void; /** Triggered before the card is selected. */ - beforeCardSelect?(e: BeforeCardSelectEventArgs): void; + beforeCardSelect? (e: BeforeCardSelectEventArgs): void; /** Trigger after the card is clicked. */ - cardClick?(e: CardClickEventArgs): void; + cardClick? (e: CardClickEventArgs): void; /** Triggered when the card is being dragged. */ - cardDrag?(e: CardDragEventArgs): void; + cardDrag? (e: CardDragEventArgs): void; /** Triggered when card dragging start. */ - cardDragStart?(e: CardDragStartEventArgs): void; + cardDragStart? (e: CardDragStartEventArgs): void; /** Triggered when card dragging stops. */ - cardDragStop?(e: CardDragStopEventArgs): void; + cardDragStop? (e: CardDragStopEventArgs): void; /** Triggered when the card is Dropped. */ - cardDrop?(e: CardDropEventArgs): void; + cardDrop? (e: CardDropEventArgs): void; /** Triggered after the card is selected. */ - cardSelect?(e: CardSelectEventArgs): void; + cardSelect? (e: CardSelectEventArgs): void; /** Triggered when card is double clicked. */ - cardDoubleClick?(e: CardDoubleClickEventArgs): void; + cardDoubleClick? (e: CardDoubleClickEventArgs): void; /** Triggered before the card is selected. */ - cardSelecting?(e: CardSelectingEventArgs): void; + cardSelecting? (e: CardSelectingEventArgs): void; /** Triggered when the Kanban is rendered completely */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Triggers after the cell is clicked. */ - cellClick?(e: CellClickEventArgs): void; - - /** Triggered the Kanban is bound with data during initial rendering. */ - dataBound?(e: DataBoundEventArgs): void; - - /** Triggered when Kanban going to destroy. */ - destroy?(e: DestroyEventArgs): void; - - /** Triggered after the card is deleted. */ - endDelete?(e: EndDeleteEventArgs): void; - - /** Triggered after the card is edited. */ - endEdit?(e: EndEditEventArgs): void; - - /** Triggers after the header is clicked. */ - headerClick?(e: HeaderClickEventArgs): void; - - /** Triggered initial load. */ - load?(e: LoadEventArgs): void; - - /** Triggered when toolbar item is clicked in Kanban. */ - toolbarClick?(e: ToolbarClickEventArgs): void; - - /** Triggered every time a single card rendered request is made to access particular card information. */ - queryCellInfo?(e: QueryCellInfoEventArgs): void; + cellClick? (e: CellClickEventArgs): void; /** Triggered before the context menu is opened. */ - contextOpen?(e: ContextOpenEventArgs): void; + contextOpen? (e: ContextOpenEventArgs): void; + + /** Triggered when context menu item is clicked in Kanban */ + contextClick? (e: ContextClickEventArgs): void; + + /** Triggered the Kanban is bound with data during initial rendering. */ + dataBound? (e: DataBoundEventArgs): void; + + /** Triggered when Kanban going to destroy. */ + destroy? (e: DestroyEventArgs): void; + + /** Triggered after the card is deleted. */ + endDelete? (e: EndDeleteEventArgs): void; + + /** Triggered after the card is edited. */ + endEdit? (e: EndEditEventArgs): void; + + /** Triggers after the header is clicked. */ + headerClick? (e: HeaderClickEventArgs): void; + + /** Triggered initial load. */ + load? (e: LoadEventArgs): void; + + /** Triggered every time a single card rendered request is made to access particular card information. */ + queryCellInfo? (e: QueryCellInfoEventArgs): void; + + /** Triggered when toolbar item is clicked in Kanban. */ + toolbarClick? (e: ToolbarClickEventArgs): void; } export interface ActionBeginEventArgs { @@ -13663,7 +13625,7 @@ export interface BeforeCardSelectEventArgs { /** Returns the previously select card indexes */ - previousRowcellindex?: any[]; + previousRowcellindex?: Array; /** Returns the Target item. */ @@ -13849,7 +13811,7 @@ export interface CardSelectEventArgs { /** Returns the previously select card indexes */ - previousRowcellindex?: any[]; + previousRowcellindex?: Array; /** Returns the current item. */ @@ -13911,7 +13873,7 @@ export interface CardSelectingEventArgs { /** Returns the previously rowcell is selecting card indexes */ - previousRowcellindex?: any[]; + previousRowcellindex?: Array; /** Returns the current item. */ @@ -13968,6 +13930,60 @@ export interface CellClickEventArgs { rowIndex?: number; } +export interface ContextOpenEventArgs { + + /** Returns the cancel option value. + */ + cancel?: boolean; + + /** Returns the Kanban model. + */ + model?: any; + + /** Returns the name of the event. + */ + type?: string; + + /** Returns the current item. + */ + currentTarget?: any; + + /** Returns the status of contextmenu item which denotes its enabled state. + */ + status?: boolean; + + /** Returns the target item. + */ + target?: any; +} + +export interface ContextClickEventArgs { + + /** Returns the cancel option value. + */ + cancel?: boolean; + + /** Returns the Kanban model. + */ + model?: any; + + /** Returns the name of the event. + */ + type?: string; + + /** Returns the current item. + */ + currentTarget?: any; + + /** Returns the status of contextmenu item which denotes its enabled state. + */ + status?: boolean; + + /** Returns the target item. + */ + target?: any; +} + export interface DataBoundEventArgs { /** Returns the cancel option value. @@ -14090,6 +14106,37 @@ export interface LoadEventArgs { type?: string; } +export interface QueryCellInfoEventArgs { + + /** Returns Kanban card. + */ + card?: any; + + /** Returns Kanban card. + */ + cell?: any; + + /** Returns the cancel option value. + */ + cancel?: boolean; + + /** Returns current row record object (JSON). + */ + data?: any; + + /** Returns the column object. + */ + column?: any; + + /** Returns the Kanban model. + */ + model?: any; + + /** Returns the name of the event. + */ + type?: string; +} + export interface ToolbarClickEventArgs { /** Returns the cancel option value. @@ -14129,64 +14176,6 @@ export interface ToolbarClickEventArgs { toolbarData?: any; } -export interface QueryCellInfoEventArgs { - - /** Returns Kanban card. - */ - card?: any; - - /** Returns Kanban card. - */ - cell?: any; - - /** Returns the cancel option value. - */ - cancel?: boolean; - - /** Returns current row record object (JSON). - */ - data?: any; - - /** Returns the column object. - */ - column?: any; - - /** Returns the Kanban model. - */ - model?: any; - - /** Returns the name of the event. - */ - type?: string; -} - -export interface ContextOpenEventArgs { - - /** Returns the cancel option value. - */ - cancel?: boolean; - - /** Returns the Kanban model. - */ - model?: any; - - /** Returns the name of the event. - */ - type?: string; - - /** Returns the current item. - */ - currentTarget?: any; - - /** Returns the status of contextmenu item which denotes its enabled state. - */ - status?: boolean; - - /** Returns the target item. - */ - target?: any; -} - export interface SwimlaneSettingsUnassignedGroup { /** To enable or disable unassigned category change with swim lane key values. @@ -14197,7 +14186,7 @@ export interface SwimlaneSettingsUnassignedGroup { /** To set the user defined values which are need to categorized as unassigned category swim lane groups. * @Default {[null,undefined,]} */ - keys?: any[]; + keys?: Array; } export interface SwimlaneSettings { @@ -14246,17 +14235,17 @@ export interface ContextMenuSettings { /** Gets or sets a value that indicates the list of items needs to be disable from default context menu items. * @Default {Array} */ - disableDefaultItems?: any[]; + disableDefaultItems?: Array; /** Its used to add specific default context menu items. * @Default {Array} */ - menuItems?: any[]; + menuItems?: Array; /** Gets or sets a value that indicates whether to add custom contextMenu items. * @Default {Array} */ - customMenuItems?: ContextMenuSettingsCustomMenuItem[]; + customMenuItems?: Array; } export interface ColumnsTotalCount { @@ -14417,7 +14406,7 @@ export interface EditSettings { /** Get or sets an object that indicates whether to customize the editing fields of Kanban card. * @Default {Array} */ - editItems?: EditSettingsEditItem[]; + editItems?: Array; /** This specifies the id of the template which is require to be edited using the External edit form. * @Default {null} @@ -14514,7 +14503,7 @@ export interface SearchSettings { /** To customize the fields the searching operation can be perform. * @Default {Array} */ - fields?: any[]; + fields?: Array; /** To customize the searching string. */ @@ -14549,7 +14538,7 @@ export interface StackedHeaderRow { /** Gets or sets a value that indicates whether to add stacked header columns into the stacked header rows. * @Default {Array} */ - stackedHeaderColumns?: StackedHeaderRowsStackedHeaderColumn[]; + stackedHeaderColumns?: Array; } export interface TooltipSettings { @@ -14578,7 +14567,7 @@ export interface Workflow { allowedTransitions?: string; } -enum Target { +enum Target{ ///Sets context menu to Kanban header Header, @@ -14594,7 +14583,7 @@ enum Target { } -enum EditMode { +enum EditMode{ ///Creates Kanban with editMode as Dialog Dialog, @@ -14610,12 +14599,12 @@ enum EditMode { } -enum EditingType { +enum EditingType{ ///Allows to set edit type as string edit type String, - ///Allows to set edit type as numeric edit type + ///Allows to set edit type as numeric edit type Numeric, ///Allows to set edit type as drop down edit type @@ -14635,7 +14624,7 @@ enum EditingType { } -enum FormPosition { +enum FormPosition{ ///Form position is bottom. Bottom, @@ -14645,7 +14634,7 @@ enum FormPosition { } -enum SelectionType { +enum SelectionType{ ///Support for Single selection in Kanban Single, @@ -14658,10 +14647,11 @@ enum SelectionType { class Rotator extends ej.Widget { static fn: Rotator; - constructor(element: JQuery | Element, options?: Rotator.Model); + constructor(element: JQuery, options?: Rotator.Model); + constructor(element: Element, options?: Rotator.Model); static Locale: any; - model: Rotator.Model; - defaults: Rotator.Model; + model:Rotator.Model; + defaults:Rotator.Model; /** Disables the Rotator control. * @returns {void} @@ -14711,7 +14701,7 @@ class Rotator extends ej.Widget { */ updateTemplateById(index: number, id: string): void; } -export namespace Rotator { +export module Rotator{ export interface Model { @@ -14783,8 +14773,7 @@ export interface Model { */ isResponsive?: boolean; - /** Specifies the number of Rotator Items to navigate on a single click (next/previous/play buttons). - * The navigateSteps property value must be less than or equal to the displayItemsCount property value. + /** Specifies the number of Rotator Items to navigate on a single click (next/previous/play buttons). The navigateSteps property value must be less than or equal to the displayItemsCount property value. * @Default {1} */ navigateSteps?: string|number; @@ -14804,8 +14793,7 @@ export interface Model { */ query?: string; - /** If the Rotator Item is an image, you can specify a caption for the Rotator Item. The caption text for each Rotator Item must be set by using the title attribute of the respective tag. - * The caption cannot be displayed if multiple Rotator Items are present. + /** If the Rotator Item is an image, you can specify a caption for the Rotator Item. The caption text for each Rotator Item must be set by using the title attribute of the respective tag. The caption cannot be displayed if multiple Rotator Items are present. * @Default {false} */ showCaption?: boolean; @@ -14825,8 +14813,7 @@ export interface Model { */ showPlayButton?: boolean; - /** Turns on or off thumbnail support in the Rotator control. Thumbnail is used to navigate between slides. Thumbnail supports only single slide transition - * You must specify the source for thumbnail elements through the thumbnailSourceID property. + /** Turns on or off thumbnail support in the Rotator control. Thumbnail is used to navigate between slides. Thumbnail supports only single slide transition You must specify the source for thumbnail elements through the thumbnailSourceID property. * @Default {false} */ showThumbnail?: boolean; @@ -14857,7 +14844,7 @@ export interface Model { /** The templateId enables to bind multiple customized template items in Rotator. * @Default {null} */ - templateId?: any[]; + templateId?: Array; /** Specifies the source for thumbnail elements. * @Default {null} @@ -14865,25 +14852,25 @@ export interface Model { thumbnailSourceID?: any; /** This event is fired when the Rotator slides are changed. */ - change?(e: ChangeEventArgs): void; + change? (e: ChangeEventArgs): void; /** This event is fired when the Rotator control is initialized. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** This event is fired when the Rotator control is destroyed. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** This event is fired when a pager is clicked. */ - pagerClick?(e: PagerClickEventArgs): void; + pagerClick? (e: PagerClickEventArgs): void; /** This event is fired when enableAutoPlay is started. */ - start?(e: StartEventArgs): void; + start? (e: StartEventArgs): void; /** This event is fired when autoplay is stopped or paused. */ - stop?(e: StopEventArgs): void; + stop? (e: StopEventArgs): void; /** This event is fired when a thumbnail pager is clicked. */ - thumbItemClick?(e: ThumbItemClickEventArgs): void; + thumbItemClick? (e: ThumbItemClickEventArgs): void; } export interface ChangeEventArgs { @@ -15058,7 +15045,7 @@ export interface Fields { url?: string; } -enum PagerPosition { +enum PagerPosition{ ///string BottomLeft, @@ -15083,10 +15070,11 @@ enum PagerPosition { class RTE extends ej.Widget { static fn: RTE; - constructor(element: JQuery | Element, options?: RTE.Model); + constructor(element: JQuery, options?: RTE.Model); + constructor(element: Element, options?: RTE.Model); static Locale: any; - model: RTE.Model; - defaults: RTE.Model; + model:RTE.Model; + defaults:RTE.Model; /** Returns the range object. * @returns {any} @@ -15159,21 +15147,20 @@ class RTE extends ej.Widget { insertMenuOption(): void; /** Add a table column at the right or left of the specified cell - * @param {boolean} If it’s true, add a column at the left of the cell, otherwise add a column at the right of the cell + * @param {boolean} If itĂ¢â‚¬â„¢s true, add a column at the left of the cell, otherwise add a column at the right of the cell * @param {JQuery} Column will be added based on the given cell element * @returns {HTMLElement} */ insertColumn(before?: boolean, cell?: JQuery): HTMLElement; /** To add a table row below or above the specified cell. - * @param {boolean} If it’s true, add a row before the cell, otherwise add a row after the cell + * @param {boolean} If itĂ¢â‚¬â„¢s true, add a row before the cell, otherwise add a row after the cell * @param {JQuery} Row will be added based on the given cell element * @returns {HTMLElement} */ insertRow(before?: boolean, cell?: JQuery): HTMLElement; - /** This method helps to insert/paste the content at the current cursor (caret) position or the selected content to be replaced with our text by passing the value as parameter to the - * pasteContent method in the Editor. + /** This method helps to insert/paste the content at the current cursor (caret) position or the selected content to be replaced with our text by passing the value as parameter to the pasteContent method in the Editor. * @returns {void} */ pasteContent(): void; @@ -15236,7 +15223,7 @@ class RTE extends ej.Widget { */ show(): void; } -export namespace RTE { +export module RTE{ export interface Model { @@ -15261,8 +15248,7 @@ export interface Model { autoHeight?: boolean; /** Sets the colorCode to display the color of the fontColor and backgroundColor in the font tools of the RTE. - * @Default {[000000, FFFFFF, C4C4C4, ADADAD, 595959, 262626, 4f81bd, dbe5f1, b8cce4, 95b3d7, 366092, 244061, c0504d, f2dcdb, e5b9b7, d99694, 953734,632423, 9bbb59, - ebf1dd, d7e3bc, c3d69b, 76923c, 4f6128, 8064a2, e5e0ec, ccc1d9, b2a2c7, 5f497a, 3f3151, f79646, fdeada, fbd5b5, fac08f,e36c09, 974806]} + * @Default {[000000, FFFFFF, C4C4C4, ADADAD, 595959, 262626, 4f81bd, dbe5f1, b8cce4, 95b3d7, 366092, 244061, c0504d, f2dcdb, e5b9b7, d99694, 953734,632423, 9bbb59, ebf1dd, d7e3bc, c3d69b, 76923c, 4f6128, 8064a2, e5e0ec, ccc1d9, b2a2c7, 5f497a, 3f3151, f79646, fdeada, fbd5b5, fac08f,e36c09, 974806]} */ colorCode?: any; @@ -15280,7 +15266,7 @@ export interface Model { */ cssClass?: string; - /** Enables/disables the RTE control’s accessibility or interaction. + /** Enables/disables the RTE controlĂ¢â‚¬â„¢s accessibility or interaction. * @Default {True} */ enabled?: boolean; @@ -15336,23 +15322,17 @@ export interface Model { fileBrowser?: FileBrowser; /** Sets the fontName in the RTE. - * @Default {{text: Segoe UI, value: Segoe UI },{text: Arial, value: Arial,Helvetica,sans-serif },{text: Courier New, value: Courier New,Courier,Monospace }, - * {text: Georgia, value: Georgia,serif },{text: Impact, value: Impact,Charcoal,sans-serif },{text: Lucida Console, value: Lucida Console,Monaco,Monospace }, - * {text: Tahoma, value: Tahoma,Geneva,sans-serif },{text: Times New Roman, value: Times New Roman },{text: Trebuchet MS, value: Trebuchet MS,Helvetica,sans-serif }, - * {text: Verdana, value: Verdana,Geneva,sans-serif}} + * @Default {{text: Segoe UI, value: Segoe UI },{text: Arial, value: Arial,Helvetica,sans-serif },{text: Courier New, value: Courier New,Courier,Monospace },{text: Georgia, value: Georgia,serif },{text: Impact, value: Impact,Charcoal,sans-serif },{text: Lucida Console, value: Lucida Console,Monaco,Monospace },{text: Tahoma, value: Tahoma,Geneva,sans-serif },{text: Times New Roman, value: Times New Roman },{text: Trebuchet MS, value: Trebuchet MS,Helvetica,sans-serif },{text: Verdana, value: Verdana,Geneva,sans-serif}} */ fontName?: any; /** Sets the fontSize in the RTE. - * @Default {{ text: 1, value: 1 },{ text: 2 (10pt), value: 2 },{ text: 3 (12pt), value: 3 },{ text: 4 (14pt), value: 4 },{ text: 5 (18pt), value: 5 }, - * { text: 6 (24pt), value: 6 },{ text: 7 (36pt), value: 7 }} + * @Default {{ text: 1, value: 1 },{ text: 2 (10pt), value: 2 },{ text: 3 (12pt), value: 3 },{ text: 4 (14pt), value: 4 },{ text: 5 (18pt), value: 5 },{ text: 6 (24pt), value: 6 },{ text: 7 (36pt), value: 7 }} */ fontSize?: any; /** Sets the format in the RTE. - * @Default {{ text: Paragraph, value: <p>, spriteCssClass: e-paragraph },{ text: Quotation, value: <blockquote>, spriteCssClass: e-quotation }, - * { text: Heading 1, value: <h1>, spriteCssClass: e-h1 },{ text: Heading 2, value: <h2>, spriteCssClass: e-h2 },{ text: Heading 3, value: <h3>, spriteCssClass: e-h3 }, - * { text: Heading 4, value: <h4>, spriteCssClass: e-h4 },{ text: Heading 5, value: <h5>, spriteCssClass: e-h5 },{ text: Heading 6, value: <h6>, spriteCssClass: e-h6}} + * @Default {{ text: Paragraph, value: <p>, spriteCssClass: e-paragraph },{ text: Quotation, value: <blockquote>, spriteCssClass: e-quotation },{ text: Heading 1, value: <h1>, spriteCssClass: e-h1 },{ text: Heading 2, value: <h2>, spriteCssClass: e-h2 },{ text: Heading 3, value: <h3>, spriteCssClass: e-h3 },{ text: Heading 4, value: <h4>, spriteCssClass: e-h4 },{ text: Heading 5, value: <h5>, spriteCssClass: e-h5 },{ text: Heading 6, value: <h6>, spriteCssClass: e-h6}} */ format?: string; @@ -15496,17 +15476,14 @@ export interface Model { tableRows?: number; /** Sets the tools in the RTE and gets the inner display order of the corresponding group element. Tools are dependent on the toolsList property. - * @Default {formatStyle: [format],style: [bold, italic, underline, strikethrough],alignment: [justifyLeft, justifyCenter, justifyRight, justifyFull],lists: [unorderedList, orderedList], - * indenting: [outdent, indent],doAction: [undo, redo],links: [createLink,removeLink],images: [image],media: [video],tables: [createTable, addRowAbove, addRowBelow, - * addColumnLeft, addColumnRight, deleteRow, deleteColumn, deleteTable]],view:[“fullScreenâ€,zoomIn,zoomOut],print:[print]} + * @Default {formatStyle: [format],style: [bold, italic, underline, strikethrough],alignment: [justifyLeft, justifyCenter, justifyRight, justifyFull],lists: [unorderedList, orderedList],indenting: [outdent, indent],doAction: [undo, redo],links: [createLink,removeLink],images: [image],media: [video],tables: [createTable, addRowAbove, addRowBelow, addColumnLeft, addColumnRight, deleteRow, deleteColumn, deleteTable]],view:[Ă¢â‚¬Å“fullScreenĂ¢â‚¬Â,zoomIn,zoomOut],print:[print]} */ tools?: Tools; - /** Specifies the list of groups and order of those groups displayed in the RTE toolbar. The toolsList property is used to get the root group order and tools property is used to get the - * inner order of the corresponding groups displayed. When the value is not specified, it gets its default display order and tools. + /** Specifies the list of groups and order of those groups displayed in the RTE toolbar. The toolsList property is used to get the root group order and tools property is used to get the inner order of the corresponding groups displayed. When the value is not specified, it gets its default display order and tools. * @Default {[formatStyle, font, style, effects, alignment, lists, indenting, clipboard, doAction, clear, links, images, media, tables, casing,view, customTools,print,edit]} */ - toolsList?: any[]; + toolsList?: Array; /** Display the hints for the tools in the Toolbar. * @Default {{ associate: mouseenter, showShadow: true, position: { stem: { horizontal: left, vertical: top } }, tip: { size: { width: 5, height: 5 }, isBalloon: false }} @@ -15544,31 +15521,31 @@ export interface Model { zoomStep?: string|number; /** Fires when changed successfully. */ - change?(e: ChangeEventArgs): void; + change? (e: ChangeEventArgs): void; /** Fires when the RTE is created successfully */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Fires when mouse click on menu items. */ - contextMenuClick?(e: ContextMenuClickEventArgs): void; + contextMenuClick? (e: ContextMenuClickEventArgs): void; /** Fires before the RTE is destroyed. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Fires when the commands are executed successfully. */ - execute?(e: ExecuteEventArgs): void; + execute? (e: ExecuteEventArgs): void; /** Fires when the keydown action is successful. */ - keydown?(e: KeydownEventArgs): void; + keydown? (e: KeydownEventArgs): void; /** Fires when the keyup action is successful. */ - keyup?(e: KeyupEventArgs): void; + keyup? (e: KeyupEventArgs): void; /** Fires before the RTE Edit area is rendered and after the toolbar is rendered. */ - preRender?(e: PreRenderEventArgs): void; + preRender? (e: PreRenderEventArgs): void; /** Fires when the text is selected in the text area */ - select?(e: SelectEventArgs): void; + select? (e: SelectEventArgs): void; } export interface ChangeEventArgs { @@ -15831,92 +15808,93 @@ export interface Tools { /** Specifies the casing tools and the display order of this tool in the RTE toolbar. */ - casing?: any[]; + casing?: Array; /** Specifies the clear tools and the display order of this tool in the RTE toolbar. */ - clear?: any[]; + clear?: Array; /** Specifies the clipboard tools and the display order of this tool in the RTE toolbar. */ - clipboard?: any[]; + clipboard?: Array; /** Specifies the edit tools and the displays tool in the RTE toolbar. */ - edit?: any[]; + edit?: Array; /** Specifies the doAction tools and the display order of this tool in the RTE toolbar. */ - doAction?: any[]; + doAction?: Array; /** Specifies the effect of tools and the display order of this tool in RTE toolbar. */ - effects?: any[]; + effects?: Array; /** Specifies the font tools and the display order of this tool in the RTE toolbar. */ - font?: any[]; + font?: Array; /** Specifies the formatStyle tools and the display order of this tool in the RTE toolbar. */ - formatStyle?: any[]; + formatStyle?: Array; /** Specifies the image tools and the display order of this tool in the RTE toolbar. */ - images?: any[]; + images?: Array; /** Specifies the indent tools and the display order of this tool in the RTE toolbar. */ - indenting?: any[]; + indenting?: Array; /** Specifies the link tools and the display order of this tool in the RTE toolbar. */ - links?: any[]; + links?: Array; /** Specifies the list tools and the display order of this tool in the RTE toolbar. */ - lists?: any[]; + lists?: Array; /** Specifies the media tools and the display order of this tool in the RTE toolbar. */ - media?: any[]; + media?: Array; /** Specifies the style tools and the display order of this tool in the RTE toolbar. */ - style?: any[]; + style?: Array; /** Specifies the table tools and the display order of this tool in the RTE toolbar. */ - tables?: any[]; + tables?: Array; /** Specifies the view tools and the display order of this tool in the RTE toolbar. */ - view?: any[]; + view?: Array; /** Specifies the print tools and the display order of this tool in the RTE toolbar. */ - print?: any[]; + print?: Array; /** Specifies the importExport tools and the display order of this tool in the RTE toolbar. */ - importExport?: any[]; + importExport?: Array; /** Specifies the customOrderedList tools and the display order of this tool in the RTE toolbar. */ - customOrderedList?: ToolsCustomOrderedList[]; + customOrderedList?: Array; /** Specifies the customUnOrderedList tools and the display order of this tool in the RTE toolbar. */ - customUnorderedList?: ToolsCustomUnorderedList[]; + customUnorderedList?: Array; } } class Slider extends ej.Widget { static fn: Slider; - constructor(element: JQuery | Element, options?: Slider.Model); + constructor(element: JQuery, options?: Slider.Model); + constructor(element: Element, options?: Slider.Model); static Locale: any; - model: Slider.Model; - defaults: Slider.Model; + model:Slider.Model; + defaults:Slider.Model; /** To disable the slider * @returns {void} @@ -15938,7 +15916,7 @@ class Slider extends ej.Widget { */ setValue(): void; } -export namespace Slider { +export module Slider{ export interface Model { @@ -16054,7 +16032,7 @@ export interface Model { /** Specifies the values of the range slider. But it's not applicable for default and minRange sliders. we can use value property for default and minRange sliders. * @Default {[minValue,maxValue]} */ - values?: any[]; + values?: Array; /** Specifies the width of the slider. * @Default {100%} @@ -16062,25 +16040,25 @@ export interface Model { width?: string; /** Fires once Slider control value is changed successfully. */ - change?(e: ChangeEventArgs): void; + change? (e: ChangeEventArgs): void; /** Fires once Slider control has been created successfully. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Fires when Slider control has been destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Fires once Slider control is sliding successfully. */ - slide?(e: SlideEventArgs): void; + slide? (e: SlideEventArgs): void; /** Fires once Slider control is started successfully. */ - start?(e: StartEventArgs): void; + start? (e: StartEventArgs): void; /** Fires when Slider control is stopped successfully. */ - stop?(e: StopEventArgs): void; + stop? (e: StopEventArgs): void; /** Fires when display the custom tooltip */ - tooltipChange?(e: TooltipChangeEventArgs): void; + tooltipChange? (e: TooltipChangeEventArgs): void; } export interface ChangeEventArgs { @@ -16109,7 +16087,7 @@ export interface ChangeEventArgs { */ value?: number; - /** returns true if event triggered by interaction else returns false. + /** returns true if event triggered by interaction else returns false. */ isInteraction?: boolean; } @@ -16226,13 +16204,12 @@ export interface StopEventArgs { } export interface TooltipChangeEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; } } -namespace slider { -enum sliderType { +module slider +{ +enum sliderType +{ //Shows default slider Default, //Shows minRange slider @@ -16244,10 +16221,11 @@ Range, class SplitButton extends ej.Widget { static fn: SplitButton; - constructor(element: JQuery | Element, options?: SplitButton.Model); + constructor(element: JQuery, options?: SplitButton.Model); + constructor(element: Element, options?: SplitButton.Model); static Locale: any; - model: SplitButton.Model; - defaults: SplitButton.Model; + model:SplitButton.Model; + defaults:SplitButton.Model; /** Destroy the split button widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. * @returns {void} @@ -16274,7 +16252,7 @@ class SplitButton extends ej.Widget { */ show(): void; } -export namespace SplitButton { +export module SplitButton{ export interface Model { @@ -16308,7 +16286,7 @@ export interface Model { enableRTL?: boolean; /** Specifies the height of the Split Button. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ height?: string|number; @@ -16349,36 +16327,36 @@ export interface Model { text?: string; /** Specifies the width of the Split Button. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ width?: string|number; /** Fires before menu of the split button control is opened. */ - beforeOpen?(e: BeforeOpenEventArgs): void; + beforeOpen? (e: BeforeOpenEventArgs): void; /** Fires when Button control is clicked successfully */ - click?(e: ClickEventArgs): void; + click? (e: ClickEventArgs): void; /** Fires before the list content of Button control is closed */ - close?(e: CloseEventArgs): void; + close? (e: CloseEventArgs): void; /** Fires after Split Button control is created. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Fires when the Split Button is destroyed successfully */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Fires when a menu item is Hovered out successfully */ - itemMouseOut?(e: ItemMouseOutEventArgs): void; + itemMouseOut? (e: ItemMouseOutEventArgs): void; /** Fires when a menu item is Hovered in successfully */ - itemMouseOver?(e: ItemMouseOverEventArgs): void; + itemMouseOver? (e: ItemMouseOverEventArgs): void; /** Fires when a menu item is clicked successfully */ - itemSelected?(e: ItemSelectedEventArgs): void; + itemSelected? (e: ItemSelectedEventArgs): void; /** Fires before the list content of Button control is opened */ - open?(e: OpenEventArgs): void; + open? (e: OpenEventArgs): void; } export interface BeforeOpenEventArgs { @@ -16564,7 +16542,8 @@ export interface OpenEventArgs { type?: string; } } -enum ArrowPosition { +enum ArrowPosition +{ //To set Left arrowPosition of the split button Left, //To set Right arrowPosition of the split button @@ -16577,10 +16556,11 @@ Bottom, class Splitter extends ej.Widget { static fn: Splitter; - constructor(element: JQuery | Element, options?: Splitter.Model); + constructor(element: JQuery, options?: Splitter.Model); + constructor(element: Element, options?: Splitter.Model); static Locale: any; - model: Splitter.Model; - defaults: Splitter.Model; + model:Splitter.Model; + defaults:Splitter.Model; /** To add a new pane to splitter control. * @param {string} content of pane. @@ -16613,7 +16593,7 @@ class Splitter extends ej.Widget { */ removeItem(index: number): void; } -export namespace Splitter { +export module Splitter{ export interface Model { @@ -16628,7 +16608,7 @@ export interface Model { animationSpeed?: number; /** Specify the CSS class to splitter control to achieve custom theme. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ cssClass?: string; @@ -16658,14 +16638,14 @@ export interface Model { isResponsive?: boolean; /** Specify the orientation for splitter control. See orientation - * @Default {ej.orientation.Horizontal or “horizontalâ€} + * @Default {ej.orientation.Horizontal or Ă¢â‚¬Å“horizontalĂ¢â‚¬Â} */ orientation?: ej.Orientation|string; /** Specify properties for each pane like paneSize, minSize, maxSize, collapsible, expandable, resizable. * @Default {[]} */ - properties?: any[]; + properties?: Array; /** Specify width for splitter control. * @Default {null} @@ -16673,19 +16653,19 @@ export interface Model { width?: string; /** Fires before expanding / collapsing the split pane of splitter control. */ - beforeExpandCollapse?(e: BeforeExpandCollapseEventArgs): void; + beforeExpandCollapse? (e: BeforeExpandCollapseEventArgs): void; /** Fires when splitter control pane has been created. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Fires when splitter control pane has been destroyed. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Fires when expand / collapse operation in splitter control pane has been performed successfully. */ - expandCollapse?(e: ExpandCollapseEventArgs): void; + expandCollapse? (e: ExpandCollapseEventArgs): void; /** Fires when resize in splitter control pane. */ - resize?(e: ResizeEventArgs): void; + resize? (e: ResizeEventArgs): void; } export interface BeforeExpandCollapseEventArgs { @@ -16802,12 +16782,13 @@ export interface ResizeEventArgs { class Tab extends ej.Widget { static fn: Tab; - constructor(element: JQuery | Element, options?: Tab.Model); + constructor(element: JQuery, options?: Tab.Model); + constructor(element: Element, options?: Tab.Model); static Locale: any; - model: Tab.Model; - defaults: Tab.Model; + model:Tab.Model; + defaults:Tab.Model; - /** Add new tab items with given name, URL and given index position, if index null it’s add last item. + /** Add new tab items with given name, URL and given index position, if index null itĂ¢â‚¬â„¢s add last item. * @param {string} URL name / tab id. * @param {string} Tab Display name. * @param {number} Index position to placed , this is optional. @@ -16860,7 +16841,7 @@ class Tab extends ej.Widget { */ showItem(index: number): void; } -export namespace Tab { +export module Tab{ export interface Model { @@ -16945,14 +16926,14 @@ export interface Model { /** Specifies to hide a pane of Tab control. * @Default {[]} */ - hiddenItemIndex?: any[]; + hiddenItemIndex?: Array; /** Specifies the HTML Attributes of the Tab. * @Default {{}} */ htmlAttributes?: any; - /** The idPrefix property appends the given string on the added tab item id’s in runtime. + /** The idPrefix property appends the given string on the added tab item idĂ¢â‚¬â„¢s in runtime. * @Default {ej-tab-} */ idPrefix?: string; @@ -16977,43 +16958,43 @@ export interface Model { */ showRoundedCorner?: boolean; - /** Set the width for outer panel element, if not it’s take parent width. + /** Set the width for outer panel element, if not itĂ¢â‚¬â„¢s take parent width. * @Default {null} */ width?: string|number; /** Triggered after a tab item activated. */ - itemActive?(e: ItemActiveEventArgs): void; + itemActive? (e: ItemActiveEventArgs): void; /** Triggered before AJAX content has been loaded. */ - ajaxBeforeLoad?(e: AjaxBeforeLoadEventArgs): void; + ajaxBeforeLoad? (e: AjaxBeforeLoadEventArgs): void; /** Triggered if error occurs in AJAX request. */ - ajaxError?(e: AjaxErrorEventArgs): void; + ajaxError? (e: AjaxErrorEventArgs): void; /** Triggered after AJAX content load action. */ - ajaxLoad?(e: AjaxLoadEventArgs): void; + ajaxLoad? (e: AjaxLoadEventArgs): void; /** Triggered after a tab item activated. */ - ajaxSuccess?(e: AjaxSuccessEventArgs): void; + ajaxSuccess? (e: AjaxSuccessEventArgs): void; /** Triggered before a tab item activated. */ - beforeActive?(e: BeforeActiveEventArgs): void; + beforeActive? (e: BeforeActiveEventArgs): void; /** Triggered before a tab item remove. */ - beforeItemRemove?(e: BeforeItemRemoveEventArgs): void; + beforeItemRemove? (e: BeforeItemRemoveEventArgs): void; /** Triggered before a tab item Create. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Triggered before a tab item destroy. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Triggered after new tab item add */ - itemAdd?(e: ItemAddEventArgs): void; + itemAdd? (e: ItemAddEventArgs): void; /** Triggered after tab item removed. */ - itemRemove?(e: ItemRemoveEventArgs): void; + itemRemove? (e: ItemRemoveEventArgs): void; } export interface ItemActiveEventArgs { @@ -17338,12 +17319,12 @@ export interface AjaxSettings { type?: string; } -enum Position { +enum Position{ ///Tab headers display to top position Top, - ///Tab headers display to bottom position + ///Tab headers display to bottom position Bottom, ///Tab headers display to left position. @@ -17354,7 +17335,7 @@ enum Position { } -enum HeightAdjustMode { +enum HeightAdjustMode{ ///string None, @@ -17373,10 +17354,11 @@ enum HeightAdjustMode { class TagCloud extends ej.Widget { static fn: TagCloud; - constructor(element: JQuery | Element, options?: TagCloud.Model); + constructor(element: JQuery, options?: TagCloud.Model); + constructor(element: Element, options?: TagCloud.Model); static Locale: any; - model: TagCloud.Model; - defaults: TagCloud.Model; + model:TagCloud.Model; + defaults:TagCloud.Model; /** Inserts a new item into the TagCloud * @param {string} Insert new item into the TagCloud @@ -17403,7 +17385,7 @@ class TagCloud extends ej.Widget { */ removeAt(position: number): void; } -export namespace TagCloud { +export module TagCloud{ export interface Model { @@ -17467,19 +17449,19 @@ export interface Model { titleText?: string; /** Event triggers when the TagCloud items are clicked */ - click?(e: ClickEventArgs): void; + click? (e: ClickEventArgs): void; /** Event triggers when the TagCloud are created */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Event triggers when the TagCloud are destroyed */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Event triggers when the cursor leaves out from a tag item */ - mouseout?(e: MouseoutEventArgs): void; + mouseout? (e: MouseoutEventArgs): void; /** Event triggers when the cursor hovers on a tag item */ - mouseover?(e: MouseoverEventArgs): void; + mouseover? (e: MouseoverEventArgs): void; } export interface ClickEventArgs { @@ -17600,7 +17582,8 @@ export interface Fields { url?: string; } } -enum Format { +enum Format +{ //To render the TagCloud items in cloud format Cloud, //To render the TagCloud items in list format @@ -17609,10 +17592,11 @@ List, class TimePicker extends ej.Widget { static fn: TimePicker; - constructor(element: JQuery | Element, options?: TimePicker.Model); + constructor(element: JQuery, options?: TimePicker.Model); + constructor(element: Element, options?: TimePicker.Model); static Locale: any; - model: TimePicker.Model; - defaults: TimePicker.Model; + model:TimePicker.Model; + defaults:TimePicker.Model; /** Allows you to disable the TimePicker. * @returns {void} @@ -17644,7 +17628,7 @@ class TimePicker extends ej.Widget { */ show(): void; } -export namespace TimePicker { +export module TimePicker{ export interface Model { @@ -17677,8 +17661,7 @@ export interface Model { */ enableRTL?: boolean; - /** When the enableStrictMode is set as true it allows the value outside of the range and also indicate with red color border, - * otherwise it internally changed to the min or max range value based an input value. + /** When the enableStrictMode is set as true it allows the value outside of the range and also indicate with red color border, otherwise it internally changed to the min or max range value based an input value. * @Default {false} */ enableStrictMode?: boolean; @@ -17732,7 +17715,7 @@ export interface Model { */ popupWidth?: string|number; - /** Toggles the readonly state of the TimePicker + /** Toggles the readonly state of the TimePicker. When the widget is readOnly, it doesnĂ¢â‚¬â„¢t allow your input. * @Default {false} */ readOnly?: boolean; @@ -17767,34 +17750,34 @@ export interface Model { width?: string|number; /** Fires when the time value changed in the TimePicker. */ - beforeChange?(e: BeforeChangeEventArgs): void; + beforeChange? (e: BeforeChangeEventArgs): void; /** Fires when the TimePicker popup before opened. */ - beforeOpen?(e: BeforeOpenEventArgs): void; + beforeOpen? (e: BeforeOpenEventArgs): void; /** Fires when the time value changed in the TimePicker. */ - change?(e: ChangeEventArgs): void; + change? (e: ChangeEventArgs): void; /** Fires when the TimePicker popup closed. */ - close?(e: CloseEventArgs): void; + close? (e: CloseEventArgs): void; /** Fires when create TimePicker successfully. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Fires when the TimePicker is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Fires when the TimePicker control gets focus. */ - focusIn?(e: FocusInEventArgs): void; + focusIn? (e: FocusInEventArgs): void; /** Fires when the TimePicker control get lost focus. */ - focusOut?(e: FocusOutEventArgs): void; + focusOut? (e: FocusOutEventArgs): void; /** Fires when the TimePicker popup opened. */ - open?(e: OpenEventArgs): void; + open? (e: OpenEventArgs): void; /** Fires when the value is selected from the TimePicker dropdown list. */ - select?(e: SelectEventArgs): void; + select? (e: SelectEventArgs): void; } export interface BeforeChangeEventArgs { @@ -18014,10 +17997,11 @@ export interface SelectEventArgs { class ToggleButton extends ej.Widget { static fn: ToggleButton; - constructor(element: JQuery | Element, options?: ToggleButton.Model); + constructor(element: JQuery, options?: ToggleButton.Model); + constructor(element: Element, options?: ToggleButton.Model); static Locale: any; - model: ToggleButton.Model; - defaults: ToggleButton.Model; + model:ToggleButton.Model; + defaults:ToggleButton.Model; /** Allows you to destroy the ToggleButton widget. * @returns {void} @@ -18034,7 +18018,7 @@ class ToggleButton extends ej.Widget { */ enable(): void; } -export namespace ToggleButton { +export module ToggleButton{ export interface Model { @@ -18134,16 +18118,16 @@ export interface Model { width?: number|string; /** Fires when ToggleButton control state is changed successfully. */ - change?(e: ChangeEventArgs): void; + change? (e: ChangeEventArgs): void; /** Fires when ToggleButton control is clicked successfully. */ - click?(e: ClickEventArgs): void; + click? (e: ClickEventArgs): void; /** Fires when ToggleButton control is created successfully. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Fires when ToggleButton control is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; } export interface ChangeEventArgs { @@ -18221,10 +18205,11 @@ export interface DestroyEventArgs { class Toolbar extends ej.Widget { static fn: Toolbar; - constructor(element: JQuery | Element, options?: Toolbar.Model); + constructor(element: JQuery, options?: Toolbar.Model); + constructor(element: Element, options?: Toolbar.Model); static Locale: any; - model: Toolbar.Model; - defaults: Toolbar.Model; + model:Toolbar.Model; + defaults:Toolbar.Model; /** Deselect the specified Toolbar item. * @param {any} The element need to be deselected @@ -18311,7 +18296,7 @@ class Toolbar extends ej.Widget { */ show(): void; } -export namespace Toolbar { +export module Toolbar{ export interface Model { @@ -18327,7 +18312,7 @@ export interface Model { /** Disables an Item or set of Items that are enabled in the Toolbar * @Default {[]} */ - disabledItemIndices?: any[]; + disabledItemIndices?: Array; /** Specifies the Toolbar control state. * @Default {true} @@ -18337,7 +18322,7 @@ export interface Model { /** Enables an Item or set of Items that are disabled in the Toolbar * @Default {[]} */ - enabledItemIndices?: any[]; + enabledItemIndices?: Array; /** Specifies enableRTL property to align the Toolbar control from right to left direction. * @Default {false} @@ -18404,28 +18389,28 @@ export interface Model { width?: number|string; /** Fires after Toolbar control is clicked. */ - click?(e: ClickEventArgs): void; + click? (e: ClickEventArgs): void; /** Fires after Toolbar control is created. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Fires after Toolbar control is focused. */ - focusOut?(e: FocusOutEventArgs): void; + focusOut? (e: FocusOutEventArgs): void; /** Fires when the Toolbar is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Fires after Toolbar control item is hovered. */ - itemHover?(e: ItemHoverEventArgs): void; + itemHover? (e: ItemHoverEventArgs): void; /** Fires after mouse leave from Toolbar control item. */ - itemLeave?(e: ItemLeaveEventArgs): void; + itemLeave? (e: ItemLeaveEventArgs): void; /** Fires when the overflow popup of toolbar is opened. */ - overflowOpen?(e: OverflowOpenEventArgs): void; + overflowOpen? (e: OverflowOpenEventArgs): void; /** Fires when the overflow popup of toolbar is closed. */ - overflowClose?(e: OverflowCloseEventArgs): void; + overflowClose? (e: OverflowCloseEventArgs): void; } export interface ClickEventArgs { @@ -18686,7 +18671,7 @@ export interface Items { template?: string; } -enum ResponsiveType { +enum ResponsiveType{ ///To display the toolbar overflow items as popup Popup, @@ -18699,10 +18684,11 @@ enum ResponsiveType { class TreeView extends ej.Widget { static fn: TreeView; - constructor(element: JQuery | Element, options?: TreeView.Model); + constructor(element: JQuery, options?: TreeView.Model); + constructor(element: Element, options?: TreeView.Model); static Locale: any; - model: TreeView.Model; - defaults: TreeView.Model; + model:TreeView.Model; + defaults:TreeView.Model; /** To add a Node or collection of nodes in TreeView. If target tree node is specified, then the given nodes are added as child of target tree node, otherwise nodes are added in TreeView. * @param {string|any} New node text or JSON object @@ -18716,7 +18702,7 @@ class TreeView extends ej.Widget { * @param {string|any} ID of TreeView node/object of TreeView node * @returns {void} */ - addNodes(collection: any|any[], target: string|any): void; + addNodes(collection: any|Array, target: string|any): void; /** To check all the nodes in TreeView. * @returns {void} @@ -18727,10 +18713,9 @@ class TreeView extends ej.Widget { * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes * @returns {void} */ - checkNode(element: string|any|any[]): void; + checkNode(element: string|any|Array): void; - /** This method is used to collapse all nodes in TreeView control. If you want to collapse all nodes up to the specific level in - * TreeView control then we need to pass levelUntil as argument to this method. + /** This method is used to collapse all nodes in TreeView control. If you want to collapse all nodes up to the specific level in TreeView control then we need to pass levelUntil as argument to this method. * @param {number} TreeView nodes will collapse until the given level * @param {boolean} Weather exclude the hidden nodes of TreeView while collapse all nodes * @returns {void} @@ -18741,19 +18726,19 @@ class TreeView extends ej.Widget { * @param {string|any|Array} ID of TreeView node|object of TreeView node/collection of ID/object of TreeView nodes * @returns {void} */ - collapseNode(element: string|any|any[]): void; + collapseNode(element: string|any|Array): void; /** To disable the node in the TreeView. * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes * @returns {void} */ - disableNode(element: string|any|any[]): void; + disableNode(element: string|any|Array): void; /** To enable the node in the TreeView. * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes * @returns {void} */ - enableNode(element: string|any|any[]): void; + enableNode(element: string|any|Array): void; /** To ensure that the TreeView node is visible in the TreeView. This method is useful if we need select a TreeView node dynamically. * @param {string|any} ID of TreeView node/object of TreeView node @@ -18761,8 +18746,7 @@ class TreeView extends ej.Widget { */ ensureVisible(element: string|any): boolean; - /** This method is used to expand all nodes in TreeView control. If you want to expand all nodes up to the specific level in TreeView control - * then we need to pass levelUntil as argument to this method. + /** This method is used to expand all nodes in TreeView control. If you want to expand all nodes up to the specific level in TreeView control then we need to pass levelUntil as argument to this method. * @param {number} TreeView nodes will expand until the given level * @param {boolean} Weather exclude the hidden nodes of TreeView while expand all nodes * @returns {void} @@ -18773,7 +18757,7 @@ class TreeView extends ej.Widget { * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes * @returns {void} */ - expandNode(element: string|any|any[]): void; + expandNode(element: string|any|Array): void; /** To get currently checked nodes in TreeView. * @returns {any} @@ -18783,15 +18767,14 @@ class TreeView extends ej.Widget { /** To get currently checked nodes indexes in TreeView. * @returns {Array} */ - getCheckedNodesIndex(): any[]; + getCheckedNodesIndex(): Array; - /** This method is used to get immediate child nodes of a node in TreeView control. If you want to get the all child nodes include nested - * child nodes then we need to pass includeNestedChild as true along with element arguments to this method. + /** This method is used to get immediate child nodes of a node in TreeView control. If you want to get the all child nodes include nested child nodes then we need to pass includeNestedChild as true along with element arguments to this method. * @param {string|any} ID of TreeView node/object of TreeView node * @param {boolean} Weather include nested child nodes of TreeView node * @returns {Array} */ - getChildren(element: string|any, includeNestedChild?: boolean): any[]; + getChildren(element: string|any, includeNestedChild?: boolean): Array; /** To get number of nodes in TreeView. * @returns {number} @@ -18806,7 +18789,7 @@ class TreeView extends ej.Widget { /** To get currently expanded nodes indexes in TreeView. * @returns {Array} */ - getExpandedNodesIndex(): any[]; + getExpandedNodesIndex(): Array; /** To get TreeView node by using index position in TreeView. * @param {number} Index position of TreeView node @@ -18840,7 +18823,7 @@ class TreeView extends ej.Widget { /** To get the currently selected nodes in TreeView. * @returns {Array} */ - getSelectedNodes(): any[]; + getSelectedNodes(): Array; /** To get the index position of currently selected node in TreeView. * @returns {number} @@ -18850,7 +18833,7 @@ class TreeView extends ej.Widget { /** To get the index positions of currently selected nodes in TreeView. * @returns {Array} */ - getSelectedNodesIndex(): any[]; + getSelectedNodesIndex(): Array; /** To get the text of a node in TreeView. * @param {string|any} ID of TreeView node/object of TreeView node @@ -18862,7 +18845,7 @@ class TreeView extends ej.Widget { * @param {string|number} ID of TreeView node * @returns {Array} */ - getTreeData(id?: string|number): any[]; + getTreeData(id?: string|number): Array; /** To get currently visible nodes in TreeView. * @returns {any} @@ -18884,7 +18867,7 @@ class TreeView extends ej.Widget { * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes * @returns {void} */ - hideNode(element: string|any|any[]): void; + hideNode(element: string|any|Array): void; /** To add a Node or collection of nodes after the particular TreeView node. * @param {string|any} New node text or JSON object @@ -18971,7 +18954,7 @@ class TreeView extends ej.Widget { * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes * @returns {void} */ - removeNode(element: string|any|any[]): void; + removeNode(element: string|any|Array): void; /** To select all the TreeView nodes when enable allowMultiSelection property. * @returns {void} @@ -18982,7 +18965,7 @@ class TreeView extends ej.Widget { * @param {string|any|Array} ID of TreeView node/object of TreeView node/ collection of ID/object of TreeView nodes * @returns {void} */ - selectNode(element: string|any|any[]): void; + selectNode(element: string|any|Array): void; /** To show nodes in TreeView. * @returns {void} @@ -18993,7 +18976,7 @@ class TreeView extends ej.Widget { * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes * @returns {void} */ - showNode(element: string|any|any[]): void; + showNode(element: string|any|Array): void; /** To uncheck all the nodes in TreeView. * @returns {void} @@ -19004,7 +18987,7 @@ class TreeView extends ej.Widget { * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes * @returns {void} */ - uncheckNode(element: string|any|any[]): void; + uncheckNode(element: string|any|Array): void; /** To unselect all the TreeView nodes when enable allowMultiSelection property. * @returns {void} @@ -19015,7 +18998,7 @@ class TreeView extends ej.Widget { * @param {string|any|Array} ID of TreeView node/object of TreeView node/ collection of ID/object of TreeView nodes * @returns {void} */ - unselectNode(element: string|any|any[]): void; + unselectNode(element: string|any|Array): void; /** To edit or update the text of the TreeView node. * @param {string|any} ID of TreeView node/object of TreeView node @@ -19024,7 +19007,7 @@ class TreeView extends ej.Widget { */ updateText(target: string|any, newText: string): void; } -export namespace TreeView { +export module TreeView{ export interface Model { @@ -19076,7 +19059,7 @@ export interface Model { /** Gets or sets a value that indicates the checkedNodes index collection as an array. The given array index position denotes the nodes, that are checked while rendering TreeView. * @Default {[]} */ - checkedNodes?: any[]; + checkedNodes?: Array; /** Sets the root CSS class for TreeView which allow us to customize the appearance. */ @@ -19110,7 +19093,7 @@ export interface Model { /** Gets or sets a array of value that indicates the expandedNodes index collection as an array. The given array index position denotes the nodes, that are expanded while rendering TreeView. * @Default {[]} */ - expandedNodes?: any[]; + expandedNodes?: Array; /** Gets or sets a value that indicates the TreeView node can be expand or collapse by using the specified action. * @Default {dblclick} @@ -19150,7 +19133,7 @@ export interface Model { /** Gets or sets a value that indicates the selectedNodes index collection as an array. The given array index position denotes the nodes, that are selected while rendering TreeView. * @Default {[]} */ - selectedNodes?: any[]; + selectedNodes?: Array; /** Gets or sets a value that indicates whether to display or hide checkbox for all TreeView nodes. * @Default {false} @@ -19172,100 +19155,100 @@ export interface Model { width?: string|number; /** Fires before adding node to TreeView. */ - beforeAdd?(e: BeforeAddEventArgs): void; + beforeAdd? (e: BeforeAddEventArgs): void; /** Fires before collapse a node. */ - beforeCollapse?(e: BeforeCollapseEventArgs): void; + beforeCollapse? (e: BeforeCollapseEventArgs): void; /** Fires before cut node in TreeView. */ - beforeCut?(e: BeforeCutEventArgs): void; + beforeCut? (e: BeforeCutEventArgs): void; /** Fires before deleting node in TreeView. */ - beforeDelete?(e: BeforeDeleteEventArgs): void; + beforeDelete? (e: BeforeDeleteEventArgs): void; /** Fires before editing the node in TreeView. */ - beforeEdit?(e: BeforeEditEventArgs): void; + beforeEdit? (e: BeforeEditEventArgs): void; /** Fires before expanding the node. */ - beforeExpand?(e: BeforeExpandEventArgs): void; + beforeExpand? (e: BeforeExpandEventArgs): void; /** Fires before loading nodes to TreeView. */ - beforeLoad?(e: BeforeLoadEventArgs): void; + beforeLoad? (e: BeforeLoadEventArgs): void; /** Fires before paste node in TreeView. */ - beforePaste?(e: BeforePasteEventArgs): void; + beforePaste? (e: BeforePasteEventArgs): void; /** Fires before selecting node in TreeView. */ - beforeSelect?(e: BeforeSelectEventArgs): void; + beforeSelect? (e: BeforeSelectEventArgs): void; /** Fires when TreeView created successfully. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Fires when TreeView destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Fires before nodeEdit Successful. */ - inlineEditValidation?(e: InlineEditValidationEventArgs): void; + inlineEditValidation? (e: InlineEditValidationEventArgs): void; /** Fires when key pressed successfully. */ - keyPress?(e: KeyPressEventArgs): void; + keyPress? (e: KeyPressEventArgs): void; /** Fires when data load fails. */ - loadError?(e: LoadErrorEventArgs): void; + loadError? (e: LoadErrorEventArgs): void; /** Fires when data loaded successfully. */ - loadSuccess?(e: LoadSuccessEventArgs): void; + loadSuccess? (e: LoadSuccessEventArgs): void; /** Fires once node added successfully. */ - nodeAdd?(e: NodeAddEventArgs): void; + nodeAdd? (e: NodeAddEventArgs): void; /** Fires once node checked successfully. */ - nodeCheck?(e: NodeCheckEventArgs): void; + nodeCheck? (e: NodeCheckEventArgs): void; /** Fires when node clicked successfully. */ - nodeClick?(e: NodeClickEventArgs): void; + nodeClick? (e: NodeClickEventArgs): void; /** Fires when node collapsed successfully. */ - nodeCollapse?(e: NodeCollapseEventArgs): void; + nodeCollapse? (e: NodeCollapseEventArgs): void; /** Fires when node cut successfully. */ - nodeCut?(e: NodeCutEventArgs): void; + nodeCut? (e: NodeCutEventArgs): void; /** Fires when node deleted successfully. */ - nodeDelete?(e: NodeDeleteEventArgs): void; + nodeDelete? (e: NodeDeleteEventArgs): void; /** Fires when node dragging. */ - nodeDrag?(e: NodeDragEventArgs): void; + nodeDrag? (e: NodeDragEventArgs): void; /** Fires once node drag start successfully. */ - nodeDragStart?(e: NodeDragStartEventArgs): void; + nodeDragStart? (e: NodeDragStartEventArgs): void; /** Fires before the dragged node to be dropped. */ - nodeDragStop?(e: NodeDragStopEventArgs): void; + nodeDragStop? (e: NodeDragStopEventArgs): void; /** Fires once node dropped successfully. */ - nodeDropped?(e: NodeDroppedEventArgs): void; + nodeDropped? (e: NodeDroppedEventArgs): void; /** Fires once node edited successfully. */ - nodeEdit?(e: NodeEditEventArgs): void; + nodeEdit? (e: NodeEditEventArgs): void; /** Fires once node expanded successfully. */ - nodeExpand?(e: NodeExpandEventArgs): void; + nodeExpand? (e: NodeExpandEventArgs): void; /** Fires once node pasted successfully. */ - nodePaste?(e: NodePasteEventArgs): void; + nodePaste? (e: NodePasteEventArgs): void; /** Fires when node selected successfully. */ - nodeSelect?(e: NodeSelectEventArgs): void; + nodeSelect? (e: NodeSelectEventArgs): void; /** Fires once node unchecked successfully. */ - nodeUncheck?(e: NodeUncheckEventArgs): void; + nodeUncheck? (e: NodeUncheckEventArgs): void; /** Fires once node unselected successfully. */ - nodeUnselect?(e: NodeUnselectEventArgs): void; + nodeUnselect? (e: NodeUnselectEventArgs): void; /** Fires when TreeView nodes are loaded successfully */ - ready?(e: ReadyEventArgs): void; + ready? (e: ReadyEventArgs): void; } export interface BeforeAddEventArgs { @@ -19329,7 +19312,7 @@ export interface BeforeCollapseEventArgs { */ parentId?: string; - /** returns the format asynchronous or synchronous + /** returns the format asynchronous or synchronous */ async?: boolean; } @@ -19401,7 +19384,7 @@ export interface BeforeDeleteEventArgs { /** returns the currently removed nodes */ - removedNodes?: any[]; + removedNodes?: Array; } export interface BeforeEditEventArgs { @@ -19457,7 +19440,7 @@ export interface BeforeExpandEventArgs { */ parentId?: string; - /** returns the format asynchronous or synchronous + /** returns the format asynchronous or synchronous */ async?: boolean; } @@ -19756,11 +19739,11 @@ export interface NodeCheckEventArgs { /** it returns the currently checked node name */ - currentNode?: any[]; + currentNode?: Array; /** it returns the currently checked and its child node details */ - currentCheckedNodes?: any[]; + currentCheckedNodes?: Array; } export interface NodeClickEventArgs { @@ -19828,7 +19811,7 @@ export interface NodeCollapseEventArgs { */ isChildLoaded?: boolean; - /** returns the format asynchronous or synchronous + /** returns the format asynchronous or synchronous */ async?: boolean; } @@ -19892,7 +19875,7 @@ export interface NodeDeleteEventArgs { /** returns the currently removed nodes */ - removedNodes?: any[]; + removedNodes?: Array; } export interface NodeDragEventArgs { @@ -20132,7 +20115,7 @@ export interface NodeExpandEventArgs { */ parentId?: string; - /** returns the format asynchronous or synchronous + /** returns the format asynchronous or synchronous */ async?: boolean; } @@ -20192,7 +20175,7 @@ export interface NodeSelectEventArgs { /** returns the current selected nodes index of TreeView */ - selectedNodes?: any[]; + selectedNodes?: Array; /** returns the value of the node */ @@ -20247,7 +20230,7 @@ export interface NodeUncheckEventArgs { /** it returns currently unchecked node and its child node details. */ - currentUncheckedNodes?: any[]; + currentUncheckedNodes?: Array; } export interface NodeUnselectEventArgs { @@ -20274,7 +20257,7 @@ export interface NodeUnselectEventArgs { /** returns the current selected nodes index of TreeView */ - selectedNodes?: any[]; + selectedNodes?: Array; /** returns the name of the event */ @@ -20326,7 +20309,7 @@ export interface Fields { */ id?: string; - /** Specifies the image attribute to “img†tag inside items list + /** Specifies the image attribute to Ă¢â‚¬Å“imgĂ¢â‚¬Â tag inside items list */ imageAttribute?: any; @@ -20338,7 +20321,7 @@ export interface Fields { */ isChecked?: string; - /** Specifies the link attribute to “a†tag in item list. + /** Specifies the link attribute to Ă¢â‚¬Å“aĂ¢â‚¬Â tag in item list. */ linkAttribute?: any; @@ -20380,7 +20363,8 @@ export interface SortSettings { sortOrder?: ej.sortOrder|string; } } -enum sortOrder { +enum sortOrder +{ //Enum for Ascending sort order Ascending, //Enum for Descending sort order @@ -20389,10 +20373,11 @@ Descending, class Uploadbox extends ej.Widget { static fn: Uploadbox; - constructor(element: JQuery | Element, options?: Uploadbox.Model); + constructor(element: JQuery, options?: Uploadbox.Model); + constructor(element: Element, options?: Uploadbox.Model); static Locale: any; - model: Uploadbox.Model; - defaults: Uploadbox.Model; + model:Uploadbox.Model; + defaults:Uploadbox.Model; /** The destroy method destroys the control and brings the control to a pre-init state. All the events of the Upload control is bound by using this._on unbinds automatically. * @returns {void} @@ -20414,7 +20399,7 @@ class Uploadbox extends ej.Widget { */ refresh(): void; } -export namespace Uploadbox { +export module Uploadbox{ export interface Model { @@ -20558,37 +20543,37 @@ export interface Model { width?: string; /** Fires when the upload progress beforeSend. */ - beforeSend?(e: BeforeSendEventArgs): void; + beforeSend? (e: BeforeSendEventArgs): void; /** Fires when the upload progress begins. */ - begin?(e: BeginEventArgs): void; + begin? (e: BeginEventArgs): void; /** Fires when the upload progress is cancelled. */ - cancel?(e: CancelEventArgs): void; + cancel? (e: CancelEventArgs): void; /** Fires when the file upload progress is completed. */ - complete?(e: CompleteEventArgs): void; + complete? (e: CompleteEventArgs): void; /** Fires when the file upload progress is succeeded. */ - success?(e: SuccessEventArgs): void; + success? (e: SuccessEventArgs): void; /** Fires when the Uploadbox control is created. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Fires when the Uploadbox control is destroyed. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Fires when the Upload process ends in Error. */ - error?(e: ErrorEventArgs): void; + error? (e: ErrorEventArgs): void; /** Fires when the file is selected for upload successfully. */ - fileSelect?(e: FileSelectEventArgs): void; + fileSelect? (e: FileSelectEventArgs): void; /** Fires when the file is uploading. */ - inProgress?(e: InProgressEventArgs): void; + inProgress? (e: InProgressEventArgs): void; /** Fires when the uploaded file is removed successfully. */ - remove?(e: RemoveEventArgs): void; + remove? (e: RemoveEventArgs): void; } export interface BeforeSendEventArgs { @@ -20864,14 +20849,14 @@ export interface DialogAction { */ drag?: boolean; - /** Enables or disables the Uploadbox dialog’s modal property to the dialog popup. + /** Enables or disables the Uploadbox dialogĂ¢â‚¬â„¢s modal property to the dialog popup. */ modal?: boolean; } export interface DialogText { - /** Sets the uploaded file’s Name (header text) to the Dialog popup. + /** Sets the uploaded fileĂ¢â‚¬â„¢s Name (header text) to the Dialog popup. */ name?: string; @@ -20891,10 +20876,11 @@ export interface DialogText { class WaitingPopup extends ej.Widget { static fn: WaitingPopup; - constructor(element: JQuery | Element, options?: WaitingPopup.Model); + constructor(element: JQuery, options?: WaitingPopup.Model); + constructor(element: Element, options?: WaitingPopup.Model); static Locale: any; - model: WaitingPopup.Model; - defaults: WaitingPopup.Model; + model:WaitingPopup.Model; + defaults:WaitingPopup.Model; /** To hide the waiting popup * @returns {void} @@ -20911,7 +20897,7 @@ class WaitingPopup extends ej.Widget { */ show(): void; } -export namespace WaitingPopup { +export module WaitingPopup{ export interface Model { @@ -20956,10 +20942,10 @@ export interface Model { text?: string; /** Fires after Create WaitingPopup successfully */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Fires after Destroy WaitingPopup successfully */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; } export interface CreateEventArgs { @@ -20995,28 +20981,29 @@ export interface DestroyEventArgs { class Grid extends ej.Widget { static fn: Grid; - constructor(element: JQuery | Element, options?: Grid.Model); + constructor(element: JQuery, options?: Grid.Model); + constructor(element: Element, options?: Grid.Model); static Locale: any; - model: Grid.Model; - defaults: Grid.Model; + model:Grid.Model; + defaults:Grid.Model; /** Adds a grid model property which is to be ignored upon exporting. - * @param {Array} Pass the array of parameters which need to be ignored on exporting + * @param {Array} Pass the array of parameters which need to be ignored on exporting * @returns {void} */ - addIgnoreOnExport(propertyNames: any[]): void; + addIgnoreOnExport(propertyNames: Array): void; /** Add a new record in grid control when allowAdding is set as true. * @returns {void} */ - //addRecord(): void; + addRecord(): void; /** Add a new record in grid control when allowAdding is set as true. * @param {Array} Pass the array of added Records * @param {Array} optionalIf we pass serverChange as true, send post to server side for server action. * @returns {void} */ - addRecord(data: any[], serverChange?: any[]): void; + addRecord(data: Array, serverChange?: Array): void; /** Cancel the modified changes in grid control when edit mode is "batch". * @returns {void} @@ -21041,20 +21028,20 @@ class Grid extends ej.Widget { /** It is used to clear all the cell selection. * @returns {Boolean} */ - clearCellSelection(): boolean; + clearCellSelection(): Boolean; /** It is used to clear specified cell selection based on the rowIndex and columnIndex provided. * @param {number} It is used to pass the row index of the cell * @param {number} It is used to pass the column index of the cell. * @returns {Boolean} */ - clearCellSelection(rowIndex: number, columnIndex: number): boolean; + clearCellSelection(rowIndex: number, columnIndex: number): Boolean; /** It is used to clear all the row selection or at specific row selection based on the index provided. * @param {number} optional If index of the column is specified then it will remove the selection from the particular column else it will clears all of the column selection * @returns {Boolean} */ - clearColumnSelection(index?: number): boolean; + clearColumnSelection(index?: number): Boolean; /** It is used to clear all the filtering done. * @param {string} If field of the column is specified then it will clear the particular filtering column @@ -21071,7 +21058,7 @@ class Grid extends ej.Widget { * @param {number} optional If index of the row is specified then it will remove the selection from the particular row else it will clears all of the row selection * @returns {Boolean} */ - clearSelection(index?: number): boolean; + clearSelection(index?: number): Boolean; /** Clear the sorting from columns in the grid * @returns {void} @@ -21093,21 +21080,21 @@ class Grid extends ej.Widget { * @param {string} optional Pass add/remove action to be performed. By default "add" action will perform * @returns {void} */ - columns(columnDetails: any[]|string, action?: string): void; + columns(columnDetails: Array|string, action?: string): void; /** Refresh the grid with new data source * @param {Array} Pass new data source to the grid * @param {boolean} optional When templateRefresh is set true, both header and contents get refreshed * @returns {void} */ - dataSource(datasource: any[], templateRefresh?: boolean): void; + dataSource(datasource: Array, templateRefresh?: boolean): void; /** Delete a record in grid control when allowDeleting is set as true * @param {string} Pass the primary key field Name of the column * @param {Array} Pass the JSON data of record need to be delete. * @returns {void} */ - deleteRecord(fieldName: string, data: any[]): void; + deleteRecord(fieldName: string, data: Array): void; /** Delete the row based on the given tr element in grid. * @param {JQuery} Pass the tr element in grid content to get its row index @@ -21130,7 +21117,7 @@ class Grid extends ej.Widget { /** It returns a value and if the input field values of edit form is not based on the validation rules then it will show the validation message. * @returns {Boolean} */ - editFormValidate(): boolean; + editFormValidate(): Boolean; /** Send a save request in grid. * @returns {void} @@ -21160,7 +21147,15 @@ class Grid extends ej.Widget { * @param {Array} optionalPass the array of the gridIds to be filtered * @returns {void} */ - export(action: string, serverEvent?: string, multipleExport?: boolean, gridIds?: any[]): void; + export(action: string, serverEvent?: string, multipleExport?: boolean, gridIds?: Array): void; + + /** Export the grid content to excel, word or PDF document. + * @param {string} Pass the controller action name corresponding to exporting + * @param {string} optionalASP server event name corresponding to exporting + * @param {boolean} optionalPass the multiple exporting value as true/false + * @returns {void} + */ + export(action: string, serverEvent?: string, multipleExport?: boolean): void; /** Send a filtering request to filter one column in grid. * @param {Array} Pass the field name of the column @@ -21171,13 +21166,13 @@ class Grid extends ej.Widget { * @param {any} optionalactualFilterValue denote the filter object of current filtered columns.Pass the value to filtered in a column * @returns {void} */ - filterColumn(fieldName: any[], filterOperator: string, filterValue: string, predicate: string, matchcase?: boolean, actualFilterValue?: any): void; + filterColumn(fieldName: Array, filterOperator: string, filterValue: string, predicate: string, matchcase?: boolean, actualFilterValue?: any): void; /** Send a filtering request to filter single or multiple column in grid. * @param {Array} Pass array of filterColumn query for performing filter operation * @returns {void} */ - filterColumn(filterQueries: any[]): void; + filterColumn(filterQueries: Array): void; /** Get the batch changes of edit, delete and add operations of grid. * @returns {any} @@ -21210,7 +21205,7 @@ class Grid extends ej.Widget { /** Get the list of field names from column collection in grid. * @returns {Array} */ - getColumnFieldNames(): any[]; + getColumnFieldNames(): Array; /** Get the column index of the given field in grid. * @param {string} Pass the field name of the column to get the corresponding column index @@ -21233,7 +21228,7 @@ class Grid extends ej.Widget { /** Get the content table element of grid * @returns {Array} */ - getContentTable(): HTMLTableElement[]; + getContentTable(): Array; /** Get the data of currently edited cell value in "batch" edit mode * @returns {any} @@ -21248,7 +21243,7 @@ class Grid extends ej.Widget { /** Get the current page data source of grid. * @returns {Array} */ - getCurrentViewData(): any[]; + getCurrentViewData(): Array; /** Get the data of given row index in grid. * @returns {any} @@ -21259,7 +21254,7 @@ class Grid extends ej.Widget { * @param {string} Pass header text of the column to get its corresponding field name * @returns {String} */ - getFieldNameByHeaderText(headerText: string): string; + getFieldNameByHeaderText(headerText: string): String; /** Get the filter bar of grid * @returns {HTMLElement} @@ -21269,7 +21264,7 @@ class Grid extends ej.Widget { /** Get the records filtered or searched in Grid * @returns {Array} */ - getFilteredRecords(): any[]; + getFilteredRecords(): Array; /** Get the footer content of grid. * @returns {HTMLElement} @@ -21295,12 +21290,12 @@ class Grid extends ej.Widget { * @param {string} Pass field name of the column to get its corresponding header text * @returns {String} */ - getHeaderTextByFieldName(field: string): string; + getHeaderTextByFieldName(field: string): String; /** Get the names of all the hidden column collections in grid. * @returns {Array} */ - getHiddenColumnNames(): any[]; + getHiddenColumnNames(): Array; /** Get the row index based on the given tr element in grid. * @param {JQuery} Pass the tr element in grid content to get its row index @@ -21316,7 +21311,7 @@ class Grid extends ej.Widget { /** Get the names of primary key columns in Grid * @returns {Array} */ - getPrimaryKeyFieldNames(): any[]; + getPrimaryKeyFieldNames(): Array; /** Get the rows(tr element) from the given from and to row index in grid * @param {number} Pass the from index from which the rows to be returned @@ -21343,12 +21338,12 @@ class Grid extends ej.Widget { /** Get the selected records details in grid. * @returns {Array} */ - getSelectedRecords(): any[]; + getSelectedRecords(): Array; /** Get the selected row element details in grid. * @returns {Array} */ - getSelectedRows(): any[]; + getSelectedRows(): Array; /** It accepts the string value and returns the field and sorted direction of the column in grid. * @param {string} Pass the field of the column to get the sorted direction of the corresponding column in Grid. @@ -21361,12 +21356,12 @@ class Grid extends ej.Widget { * @param {any} Pass JSON Array for which its field values to be calculated * @returns {Number} */ - getSummaryValues(summaryCol: any, summaryData: any): number; + getSummaryValues(summaryCol: any, summaryData: any): Number; /** Get the names of all the visible column collections in grid * @returns {Array} */ - getVisibleColumnNames(): any[]; + getVisibleColumnNames(): Array; /** Send a paging request to specified page in grid * @param {number} Pass the page index to perform paging at specified page index @@ -21384,7 +21379,7 @@ class Grid extends ej.Widget { * @param {Array|string} you can pass either array of header text of various columns or a header text of a column to hide * @returns {void} */ - hideColumns(headerText: any[]|string): void; + hideColumns(headerText: Array|string): void; /** Print the grid control * @returns {void} @@ -21421,7 +21416,7 @@ class Grid extends ej.Widget { * @param {Array|string} Pass array of field names of the columns to remove a collection of sorted columns or pass a string of field name to remove a column from sorted column collections * @returns {void} */ - removeSortedColumns(fieldName: any[]|string): void; + removeSortedColumns(fieldName: Array|string): void; /** Creates a grid control * @returns {void} @@ -21437,10 +21432,10 @@ class Grid extends ej.Widget { /** Re-order the row in grid * @param {Array} Pass the indexes of the rows needs to reorder. - * @param {number} Pass the index of a row where to be reorderd. + * @param {number} Pass the index of a row where to be reordered. * @returns {void} */ - reorderRows(indexes: any[], toindex: number): void; + reorderRows(indexes: Array, toIndex: number): void; /** Reset the model collections like pageSettings, groupSettings, filterSettings, sortSettings and summaryRows. * @returns {void} @@ -21462,10 +21457,10 @@ class Grid extends ej.Widget { /** Save the particular edited cell in grid. * @returns {void} */ - //saveCell(): void; + saveCell(): void; /** We can prevent the client side cellSave event triggering by passing the preventSaveEvent argument as true. - * @param {boolean} optionalIf we pass preventSaveEvent as true, it prevents the client side cellSave event triggering + * @param {boolean} optionalIf we pass preventSaveEvent as true, it prevents the client side cellSave event triggering * @returns {void} */ saveCell(preventSaveEvent: boolean): void; @@ -21505,7 +21500,7 @@ class Grid extends ej.Widget { * @param {number} optionalIt is used to set the ending index of column for selecting columns. * @returns {Boolean} */ - selectColumns(columnIndex: number, toIndex?: number): boolean; + selectColumns(columnIndex: number, toIndex?: number): Boolean; /** Select rows in grid. * @param {number} It is used to set the starting index of row for selecting rows. @@ -21520,13 +21515,13 @@ class Grid extends ej.Widget { * @param {any} optionalTarget element which is clicked. * @returns {void} */ - selectRows(from: any[]|number, to: number, target?: any): void; + selectRows(from: Array|number, to: number, target?: any): void; /** Select rows in grid. * @param {Array} Pass array of rowIndexes for selecting rows * @returns {void} */ - selectRows(rowIndexes: any[]): void; + selectRows(rowIndexes: Array): void; /** Used to update a particular cell value. * @returns {void} @@ -21552,7 +21547,12 @@ class Grid extends ej.Widget { */ setPhoneModeMaxWidth(Index: number): void; - /** Set validation to a field during editing. + /** Set validation to edit form in the grid. + * @returns {void} + */ + setValidation(): void; + + /** Set validation to a particular input field in a edit form dynamically. * @param {string} Specify the field name of the column to set validation rules * @param {any} Specify the validation rules for the field * @returns {void} @@ -21563,7 +21563,7 @@ class Grid extends ej.Widget { * @param {Array|string} you can pass either array of header text of various columns or a header text of a column to show * @returns {void} */ - showColumns(headerText: any[]|string): void; + showColumns(headerText: Array|string): void; /** Send a sorting request in grid. * @param {string} Pass the field name of the column as columnName for which sorting have to be performed @@ -21589,105 +21589,100 @@ class Grid extends ej.Widget { * @param {Array} Pass the edited JSON data of record need to be update. * @returns {void} */ - updateRecord(fieldName: string, data: any[]): void; + updateRecord(fieldName: string, data: Array): void; /** It adapts grid to its parent element or to the browsers window. * @returns {void} */ windowonresize(): void; } -export namespace Grid { +export module Grid{ export interface Model { /** Gets or sets a value that indicates whether to customizing cell based on our needs. * @Default {false} */ - allowCellMerging?: boolean; + allowCellMerging?: Boolean; - /** Gets or sets a value that indicates whether to enable dynamic grouping behavior. Grouping can be done by drag on drop desired columns to grid’s GroupDropArea. - * This can be further customized through “groupSettings†property. + /** Gets or sets a value that indicates whether to enable dynamic grouping behavior. Grouping can be done by drag on drop desired columns to gridĂ¢â‚¬â„¢s GroupDropArea. This can be further customized through Ă¢â‚¬Å“groupSettingsĂ¢â‚¬Â property. * @Default {false} */ - allowGrouping?: boolean; + allowGrouping?: Boolean; - /** Gets or sets a value that indicates whether to enable keyboard support for performing grid actions. selectionType – Gets or sets a value that indicates whether to enable single - * row or multiple rows selection behavior in grid. Multiple selection can be done through by holding CTRL and clicking the grid rows + /** Gets or sets a value that indicates whether to enable keyboard support for performing grid actions. selectionType Ă¢â‚¬â€œ Gets or sets a value that indicates whether to enable single row or multiple rows selection behavior in grid. Multiple selection can be done through by holding CTRL and clicking the grid rows * @Default {true} */ - allowKeyboardNavigation?: boolean; + allowKeyboardNavigation?: Boolean; - /** Gets or sets a value that indicates whether to enable dynamic filtering behavior on grid. Filtering can be used to limit the records displayed using required criteria and - * this can be further customized through “filterSettings†property + /** Gets or sets a value that indicates whether to enable dynamic filtering behavior on grid. Filtering can be used to limit the records displayed using required criteria and this can be further customized through Ă¢â‚¬Å“filterSettingsĂ¢â‚¬Â property * @Default {false} */ - allowFiltering?: boolean; + allowFiltering?: Boolean; /** Gets or sets a value that indicates whether to enable the dynamic sorting behavior on grid data. Sorting can be done through clicking on particular column header. * @Default {false} */ - allowSorting?: boolean; + allowSorting?: Boolean; /** Gets or sets a value that indicates whether to enable multi columns sorting behavior in grid. Sort multiple columns by holding CTRL and click on the corresponding column header. * @Default {false} */ - allowMultiSorting?: boolean; + allowMultiSorting?: Boolean; - /** This specifies the grid to show the paginated data. Also enables pager control at the bottom of grid for dynamic navigation through data source. - * Paging can be further customized through “pageSettings†property. + /** This specifies the grid to show the paginated data. Also enables pager control at the bottom of grid for dynamic navigation through data source. Paging can be further customized through Ă¢â‚¬Å“pageSettingsĂ¢â‚¬Â property. * @Default {false} */ - allowPaging?: boolean; + allowPaging?: Boolean; - /** Gets or sets a value that indicates whether to enable the columns reordering behavior in the grid. Reordering can be done through by drag and drop the particular column - * from one index to another index within the grid. + /** Gets or sets a value that indicates whether to enable the columns reordering behavior in the grid. Reordering can be done through by drag and drop the particular column from one index to another index within the grid. * @Default {false} */ - allowReordering?: boolean; + allowReordering?: Boolean; /** Gets or sets a value that indicates whether the column is non resizable. Column width is set automatically based on the content or header text which is large. * @Default {false} */ - allowResizeToFit?: boolean; + allowResizeToFit?: Boolean; /** Gets or sets a value that indicates whether to enable dynamic resizable of columns. Resize the width of the columns by simply click and move the particular column header line * @Default {false} */ - allowResizing?: boolean; + allowResizing?: Boolean; /** Gets or sets a value that indicates whether to enable the rows reordering in Grid and drag & drop rows between multiple Grid. * @Default {false} */ - allowRowDragAndDrop?: boolean; + allowRowDragAndDrop?: Boolean; /** Gets or sets a value that indicates whether to enable the scrollbar in the grid and view the records by scroll through the grid manually * @Default {false} */ - allowScrolling?: boolean; + allowScrolling?: Boolean; - /** Gets or sets a value that indicates whether to enable dynamic searching behavior in grid. Currently search box can be enabled through “toolbarSettings†+ /** Gets or sets a value that indicates whether to enable dynamic searching behavior in grid. Currently search box can be enabled through Ă¢â‚¬Å“toolbarSettingsĂ¢â‚¬Â * @Default {false} */ - allowSearching?: boolean; + allowSearching?: Boolean; /** Gets or sets a value that indicates whether user can select rows on grid. On enabling feature, selected row will be highlighted. * @Default {true} */ - allowSelection?: boolean; + allowSelection?: Boolean; /** Gets or sets a value that indicates whether the Content will wrap to the next line if the content exceeds the boundary of the Column Cells. * @Default {false} */ - allowTextWrap?: boolean; + allowTextWrap?: Boolean; /** Gets or sets a value that indicates whether to enable the multiple exporting behavior on grid data. * @Default {false} */ - allowMultipleExporting?: boolean; + allowMultipleExporting?: Boolean; /** Gets or sets a value that indicates to define common width for all the columns in the grid. */ - commonWidth?: number; + commonWidth?: Number; /** Gets or sets a value that indicates to enable the visibility of the grid lines. * @Default {ej.Grid.GridLines.Both} @@ -21707,7 +21702,7 @@ export interface Model { /** Gets or sets an object that indicates to render the grid with specified columns * @Default {[]} */ - columns?: Column[]; + columns?: Array; /** Gets or sets an object that indicates whether to customize the context menu behavior of the grid. */ @@ -21715,7 +21710,7 @@ export interface Model { /** Gets or sets a value that indicates to render the grid with custom theme. */ - cssClass?: string; + cssClass?: String; /** Gets or sets the data to render the grid with records * @Default {null} @@ -21725,7 +21720,7 @@ export interface Model { /** Default Value: * @Default {null} */ - detailsTemplate?: string; + detailsTemplate?: String; /** Gets or sets an object that indicates whether to customize the editing behavior of the grid. */ @@ -21734,47 +21729,47 @@ export interface Model { /** Gets or sets a value that indicates whether to enable the alternative rows differentiation in the grid records based on corresponding theme. * @Default {true} */ - enableAltRow?: boolean; + enableAltRow?: Boolean; /** Gets or sets a value that indicates whether to enable the save action in the grid through row selection * @Default {true} */ - enableAutoSaveOnSelectionChange?: boolean; + enableAutoSaveOnSelectionChange?: Boolean; /** Gets or sets a value that indicates whether to enable mouse over effect on the corresponding column header cell of the grid * @Default {false} */ - enableHeaderHover?: boolean; + enableHeaderHover?: Boolean; /** Gets or sets a value that indicates whether to persist the grid model state in page using applicable medium i.e., HTML5 localStorage or cookies * @Default {false} */ - enablePersistence?: boolean; + enablePersistence?: Boolean; /** Gets or sets a value that indicates whether the grid rows has to be rendered as detail view in mobile mode * @Default {false} */ - enableResponsiveRow?: boolean; + enableResponsiveRow?: Boolean; /** Gets or sets a value that indicates whether to enable mouse over effect on corresponding grid row. * @Default {true} */ - enableRowHover?: boolean; + enableRowHover?: Boolean; /** Align content in the grid control from right to left by setting the property as true. * @Default {false} */ - enableRTL?: boolean; + enableRTL?: Boolean; /** To Disable the mouse swipe property as false. * @Default {true} */ - enableTouch?: boolean; + enableTouch?: Boolean; /** It sets a value that indicates whether to enable toolbar items, when allowEditing, allowAdding and allowDeleting property set as false in the grid. * @Default {false} */ - enableToolbarItems?: boolean; + enableToolbarItems?: Boolean; /** Act as mapper for the excel exporting URL. * @Default {ExportToExcel} @@ -21802,23 +21797,22 @@ export interface Model { /** Gets or sets a value that indicates whether the grid design has be to made responsive. * @Default {false} */ - isResponsive?: boolean; + isResponsive?: Boolean; /** This specifies to change the key in keyboard interaction to grid control * @Default {null} */ keySettings?: any; - /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and - * culture specific to a particular country or region. + /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and culture specific to a particular country or region. * @Default {en-US} */ - locale?: string; + locale?: String; /** Gets or sets a value that indicates whether to set the minimum width of the responsive grid while isResponsive property is true and enableResponsiveRow property is set as false. * @Default {0} */ - minWidth?: number; + minWidth?: Number; /** Gets or sets an object that indicates whether to modify the pager default configuration. */ @@ -21833,11 +21827,10 @@ export interface Model { */ resizeSettings?: ResizeSettings; - /** Gets or sets a value that indicates to render the grid with template rows. The template row must be a table row. That table row must have the JavaScript render binding format ({{:columnName}}) - * then the grid data source binds the data to the corresponding table row of the template. + /** Gets or sets a value that indicates to render the grid with template rows. The template row must be a table row. That table row must have the JavaScript render binding format ({{:columnName}}) then the grid data source binds the data to the corresponding table row of the template. * @Default {null} */ - rowTemplate?: string; + rowTemplate?: String; /** Gets or sets an object that indicates whether to customize the drag and drop behavior of the grid rows */ @@ -21847,21 +21840,20 @@ export interface Model { */ searchSettings?: SearchSettings; - /** Gets a value that indicates whether the grid model to hold multiple selected records . selectedRecords can be used to displayed hold the single - * or multiple selected records using “selectedRecords†property + /** Gets a value that indicates whether the grid model to hold multiple selected records . selectedRecords can be used to displayed hold the single or multiple selected records using Ă¢â‚¬Å“selectedRecordsĂ¢â‚¬Â property * @Default {null} */ - selectedRecords?: any[]; + selectedRecords?: Array; /** Gets or sets a value that indicates to select the row while initializing the grid * @Default {-1} */ - selectedRowIndex?: number; + selectedRowIndex?: Number; /** Gets or sets a value that indicates the selected rows in grid * @Default {[]} */ - selectedRowIndices?: any[]; + selectedRowIndices?: Array; /** This property is used to configure the selection behavior of the grid. */ @@ -21879,17 +21871,17 @@ export interface Model { /** Default Value: * @Default {false} */ - showColumnChooser?: boolean; + showColumnChooser?: Boolean; - /** Gets or sets a value that indicates stacked header should be shown on grid layout when the property “stackedHeaderRows†is set. + /** Gets or sets a value that indicates stacked header should be shown on grid layout when the property Ă¢â‚¬Å“stackedHeaderRowsĂ¢â‚¬Â is set. * @Default {false} */ - showStackedHeader?: boolean; + showStackedHeader?: Boolean; - /** Gets or sets a value that indicates summary rows should be shown on grid layout when the property “summaryRows†is set + /** Gets or sets a value that indicates summary rows should be shown on grid layout when the property Ă¢â‚¬Å“summaryRowsĂ¢â‚¬Â is set * @Default {false} */ - showSummary?: boolean; + showSummary?: Boolean; /** Gets or sets a value that indicates whether to customize the sorting behavior of the grid. */ @@ -21898,12 +21890,12 @@ export interface Model { /** Gets or sets an object that indicates to managing the collection of stacked header rows for the grid. * @Default {[]} */ - stackedHeaderRows?: StackedHeaderRow[]; + stackedHeaderRows?: Array; /** Gets or sets an object that indicates to managing the collection of summary rows for the grid. * @Default {[]} */ - summaryRows?: SummaryRow[]; + summaryRows?: Array; /** Gets or sets an object that indicates whether to auto wrap the grid header or content or both */ @@ -21914,166 +21906,166 @@ export interface Model { toolbarSettings?: ToolbarSettings; /** Triggered for every grid action before its starts. */ - actionBegin?(e: ActionBeginEventArgs): void; + actionBegin? (e: ActionBeginEventArgs): void; /** Triggered for every grid action success event. */ - actionComplete?(e: ActionCompleteEventArgs): void; + actionComplete? (e: ActionCompleteEventArgs): void; /** Triggered for every grid action server failure event. */ - actionFailure?(e: ActionFailureEventArgs): void; + actionFailure? (e: ActionFailureEventArgs): void; /** Triggered when record batch add. */ - batchAdd?(e: BatchAddEventArgs): void; + batchAdd? (e: BatchAddEventArgs): void; /** Triggered when record batch delete. */ - batchDelete?(e: BatchDeleteEventArgs): void; + batchDelete? (e: BatchDeleteEventArgs): void; /** Triggered before the batch add. */ - beforeBatchAdd?(e: BeforeBatchAddEventArgs): void; + beforeBatchAdd? (e: BeforeBatchAddEventArgs): void; /** Triggered before the batch delete. */ - beforeBatchDelete?(e: BeforeBatchDeleteEventArgs): void; + beforeBatchDelete? (e: BeforeBatchDeleteEventArgs): void; /** Triggered before the batch save. */ - beforeBatchSave?(e: BeforeBatchSaveEventArgs): void; + beforeBatchSave? (e: BeforeBatchSaveEventArgs): void; /** Triggered before the print. */ - beforePrint?(e: BeforePrintEventArgs): void; + beforePrint? (e: BeforePrintEventArgs): void; /** Triggered before row drop in the grid */ - beforeRowDrop?(e: BeforeRowDropEventArgs): void; + beforeRowDrop? (e: BeforeRowDropEventArgs): void; /** Triggered before the record is going to be edited. */ - beginEdit?(e: BeginEditEventArgs): void; + beginEdit? (e: BeginEditEventArgs): void; /** Triggered when record cell edit. */ - cellEdit?(e: CellEditEventArgs): void; + cellEdit? (e: CellEditEventArgs): void; /** Triggered when record cell save. */ - cellSave?(e: CellSaveEventArgs): void; + cellSave? (e: CellSaveEventArgs): void; /** Triggered after the cell is selected. */ - cellSelected?(e: CellSelectedEventArgs): void; + cellSelected? (e: CellSelectedEventArgs): void; /** Triggered before the cell is going to be selected. */ - cellSelecting?(e: CellSelectingEventArgs): void; + cellSelecting? (e: CellSelectingEventArgs): void; /** Triggered after the cell is deselected. */ - cellDeselected?(e: CellDeselectedEventArgs): void; + cellDeselected? (e: CellDeselectedEventArgs): void; /** Triggered before the cell is going to be deselected. */ - cellDeselecting?(e: CellDeselectingEventArgs): void; + cellDeselecting? (e: CellDeselectingEventArgs): void; /** Triggered when the column is being dragged. */ - columnDrag?(e: ColumnDragEventArgs): void; + columnDrag? (e: ColumnDragEventArgs): void; /** Triggered when column dragging begins. */ - columnDragStart?(e: ColumnDragStartEventArgs): void; + columnDragStart? (e: ColumnDragStartEventArgs): void; /** Triggered when the column is dropped. */ - columnDrop?(e: ColumnDropEventArgs): void; + columnDrop? (e: ColumnDropEventArgs): void; /** Triggered when the row is being dragged. */ - rowDrag?(e: RowDragEventArgs): void; + rowDrag? (e: RowDragEventArgs): void; /** Triggered when row dragging begins. */ - rowDragStart?(e: RowDragStartEventArgs): void; + rowDragStart? (e: RowDragStartEventArgs): void; /** Triggered when the row is dropped. */ - rowDrop?(e: RowDropEventArgs): void; + rowDrop? (e: RowDropEventArgs): void; /** Triggered after the column is selected. */ - columnSelected?(e: ColumnSelectedEventArgs): void; + columnSelected? (e: ColumnSelectedEventArgs): void; /** Triggered before the column is going to be selected. */ - columnSelecting?(e: ColumnSelectingEventArgs): void; + columnSelecting? (e: ColumnSelectingEventArgs): void; /** Triggered after the column is deselected. */ - columnDeselected?(e: ColumnDeselectedEventArgs): void; + columnDeselected? (e: ColumnDeselectedEventArgs): void; /** Triggered before the column is going to be deselected. */ - columnDeselecting?(e: ColumnDeselectingEventArgs): void; + columnDeselecting? (e: ColumnDeselectingEventArgs): void; /** Triggered when context menu item is clicked */ - contextClick?(e: ContextClickEventArgs): void; + contextClick? (e: ContextClickEventArgs): void; /** Triggered before the context menu is opened. */ - contextOpen?(e: ContextOpenEventArgs): void; + contextOpen? (e: ContextOpenEventArgs): void; /** Triggered when the grid is rendered completely. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Triggered when the grid is bound with data during initial rendering. */ - dataBound?(e: DataBoundEventArgs): void; + dataBound? (e: DataBoundEventArgs): void; /** Triggered when grid going to destroy. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Triggered when detail template row is clicked to collapse. */ - detailsCollapse?(e: DetailsCollapseEventArgs): void; + detailsCollapse? (e: DetailsCollapseEventArgs): void; /** Triggered detail template row is initialized. */ - detailsDataBound?(e: DetailsDataBoundEventArgs): void; + detailsDataBound? (e: DetailsDataBoundEventArgs): void; /** Triggered when detail template row is clicked to expand. */ - detailsExpand?(e: DetailsExpandEventArgs): void; + detailsExpand? (e: DetailsExpandEventArgs): void; /** Triggered after the record is added. */ - endAdd?(e: EndAddEventArgs): void; + endAdd? (e: EndAddEventArgs): void; /** Triggered after the record is deleted. */ - endDelete?(e: EndDeleteEventArgs): void; + endDelete? (e: EndDeleteEventArgs): void; /** Triggered after the record is edited. */ - endEdit?(e: EndEditEventArgs): void; + endEdit? (e: EndEditEventArgs): void; /** Triggered initial load. */ - load?(e: LoadEventArgs): void; + load? (e: LoadEventArgs): void; /** Triggered every time a request is made to access particular cell information, element and data. */ - mergeCellInfo?(e: MergeCellInfoEventArgs): void; + mergeCellInfo? (e: MergeCellInfoEventArgs): void; /** Triggered every time a request is made to access particular cell information, element and data. */ - queryCellInfo?(e: QueryCellInfoEventArgs): void; + queryCellInfo? (e: QueryCellInfoEventArgs): void; /** Triggered when record is clicked. */ - recordClick?(e: RecordClickEventArgs): void; + recordClick? (e: RecordClickEventArgs): void; /** Triggered when record is double clicked. */ - recordDoubleClick?(e: RecordDoubleClickEventArgs): void; + recordDoubleClick? (e: RecordDoubleClickEventArgs): void; /** Triggered after column resized. */ - resized?(e: ResizedEventArgs): void; + resized? (e: ResizedEventArgs): void; /** Triggered when column resize end. */ - resizeEnd?(e: ResizeEndEventArgs): void; + resizeEnd? (e: ResizeEndEventArgs): void; /** Triggered when column resize start. */ - resizeStart?(e: ResizeStartEventArgs): void; + resizeStart? (e: ResizeStartEventArgs): void; /** Triggered when right clicked on grid element. */ - rightClick?(e: RightClickEventArgs): void; + rightClick? (e: RightClickEventArgs): void; /** Triggered every time a request is made to access row information, element and data. */ - rowDataBound?(e: RowDataBoundEventArgs): void; + rowDataBound? (e: RowDataBoundEventArgs): void; /** Triggered after the row is selected. */ - rowSelected?(e: RowSelectedEventArgs): void; + rowSelected? (e: RowSelectedEventArgs): void; /** Triggered before the row is going to be selected. */ - rowSelecting?(e: RowSelectingEventArgs): void; + rowSelecting? (e: RowSelectingEventArgs): void; /** Triggered after the row is deselected. */ - rowDeselected?(e: RowDeselectedEventArgs): void; + rowDeselected? (e: RowDeselectedEventArgs): void; /** Triggered before the row is going to be deselected. */ - rowDeselecting?(e: RowDeselectingEventArgs): void; + rowDeselecting? (e: RowDeselectingEventArgs): void; /** Triggered when refresh the template column elements in the Grid. */ - templateRefresh?(e: TemplateRefreshEventArgs): void; + templateRefresh? (e: TemplateRefreshEventArgs): void; /** Triggered when toolbar item is clicked in grid. */ - toolbarClick?(e: ToolbarClickEventArgs): void; + toolbarClick? (e: ToolbarClickEventArgs): void; } export interface ActionBeginEventArgs { @@ -22727,7 +22719,7 @@ export interface CellSelectedEventArgs { /** Returns the selected row cell index values. */ - selectedRowCellIndex?: any[]; + selectedRowCellIndex?: Array; /** Returns the cancel option value. */ @@ -23033,7 +23025,7 @@ export interface ColumnSelectedEventArgs { /** Returns the selected columns values. */ - selectedColumnsIndex?: any[]; + selectedColumnsIndex?: Array; /** Returns the cancel option value. */ @@ -23413,15 +23405,15 @@ export interface MergeCellInfoEventArgs { /** Method to merge Grid rows. */ - rowMerge?: any; + rowMerge?: void; /** Method to merge Grid columns. */ - colMerge?: any; + colMerge?: void; /** Method to merge Grid rows and columns. */ - merge?: any; + merge?: void; /** Returns the grid model. */ @@ -23959,60 +23951,59 @@ export interface Column { /** Gets or sets a value that indicates whether to enable editing behavior for particular column. * @Default {true} */ - allowEditing?: boolean; + allowEditing?: Boolean; /** Gets or sets a value that indicates whether to enable dynamic filtering behavior for particular column. * @Default {true} */ - allowFiltering?: boolean; + allowFiltering?: Boolean; /** Gets or sets a value that indicates whether to enable dynamic grouping behavior for particular column. * @Default {true} */ - allowGrouping?: boolean; + allowGrouping?: Boolean; /** Gets or sets a value that indicates whether to enable dynamic sorting behavior for particular column. * @Default {true} */ - allowSorting?: boolean; + allowSorting?: Boolean; /** Gets or sets a value that indicates whether to enable dynamic resizable for particular column. * @Default {true} */ - allowResizing?: boolean; + allowResizing?: Boolean; /** Gets or sets an object that indicates to define a command column in the grid. * @Default {[]} */ - commands?: ColumnsCommand[]; + commands?: Array; /** Gets or sets a value that indicates to provide custom CSS for an individual column. */ - cssClass?: string; + cssClass?: String; /** Gets or sets a value that indicates the attribute values to the td element of a particular column */ customAttributes?: any; - /** Gets or sets a value that indicates to bind the external datasource to the particular column when column editType as dropdownedit and also it is used to bind the datasource - * to the foreign key column while editing the grid. //Where data is array of JSON objects of text and value for the drop-down and array of JSON objects for foreign key column. + /** Gets or sets a value that indicates to bind the external datasource to the particular column when column editType as dropdownedit and also it is used to bind the datasource to the foreign key column while editing the grid. //Where data is array of JSON objects of text and value for the drop-down and array of JSON objects for foreign key column. * @Default {null} */ - dataSource?: any[]; + dataSource?: Array; /** Gets or sets a value that indicates to display the specified default value while adding a new record to the grid */ - defaultValue?: string|number|boolean|Date; + defaultValue?: String|Number|Boolean|Date; /** Gets or sets a value that indicates to render the grid content and header with an HTML elements * @Default {false} */ - disableHtmlEncode?: boolean; + disableHtmlEncode?: Boolean; /** Gets or sets a value that indicates to display a column value as checkbox or string * @Default {true} */ - displayAsCheckBox?: boolean; + displayAsCheckBox?: Boolean; /** Gets or sets a value that indicates to customize ejNumericTextbox of an editable column. See editingType */ @@ -24031,11 +24022,11 @@ export interface Column { /** Gets or sets a value that indicates to groups the column based on its column format. * @Default {false} */ - enableGroupByFormat?: boolean; + enableGroupByFormat?: Boolean; /** Gets or sets a value that indicates to display the columns in the grid mapping with column name of the dataSource. */ - field?: string; + field?: String; /** Gets or sets a template that customize the filter control from default . See filterBarTemplate * @Default {null} @@ -24050,25 +24041,25 @@ export interface Column { /** Gets or sets a value that indicates to define foreign key field name of the grid datasource. * @Default {null} */ - foreignKeyField?: string; + foreignKeyField?: String; /** Gets or sets a value that indicates to bind the field which is in foreign column datasource based on the foreignKeyField * @Default {null} */ - foreignKeyValue?: string; + foreignKeyValue?: String; /** Gets or sets a value that indicates the format for the text applied on the column */ - format?: string; + format?: String; /** Gets or sets a value that indicates to add the template within the header element of the particular column. * @Default {null} */ - headerTemplateID?: string; + headerTemplateID?: String; /** Gets or sets a value that indicates to display the title of that particular column. */ - headerText?: string; + headerText?: String; /** This defines the text alignment of a particular column header cell value. See headerTextAlign * @Default {null} @@ -24078,42 +24069,42 @@ export interface Column { /** It accepts the string value and shows the tooltip for the Grid column header. * @Default {null} */ - headerTooltip?: string; + headerTooltip?: String; /** You can use this property to freeze selected columns in grid at the time of scrolling. * @Default {false} */ - isFrozen?: boolean; + isFrozen?: Boolean; /** Gets or sets a value that indicates the column has an identity in the database. * @Default {false} */ - isIdentity?: boolean; + isIdentity?: Boolean; /** Gets or sets a value that indicates the column is act as a primary key(read-only) of the grid. The editing is performed based on the primary key column * @Default {false} */ - isPrimaryKey?: boolean; + isPrimaryKey?: Boolean; /** Gets or sets a value that indicates the order of Column that are to be hidden or visible when Grid element is in responsive mode and could not occupy all columns. * @Default {-1} */ - priority?: number; + priority?: Number; /** Used to hide the particular column in column chooser by giving value as false. * @Default {true} */ - showInColumnChooser?: boolean; + showInColumnChooser?: Boolean; /** Gets or sets a value that indicates whether to enables column template for a particular column. * @Default {false} */ - template?: boolean|string; + template?: Boolean|String; /** Gets or sets a value that indicates to align the text within the column. See textAlign * @Default {ej.TextAlign.Left} */ - textAlign?: ej.TextAlign|string; + textAlign?: ej.TextAlign|string; /** Sets the template for Tooltip in Grid Columns(both header and content) */ @@ -24121,7 +24112,7 @@ export interface Column { /** Gets or sets a value that indicates to specify the data type of the specified columns. */ - type?: string; + type?: String; /** Gets or sets a value that indicates to define constraints for saving data to the database. */ @@ -24130,11 +24121,11 @@ export interface Column { /** Gets or sets a value that indicates whether this column is visible in the grid. * @Default {true} */ - visible?: boolean; + visible?: Boolean; /** Gets or sets a value that indicates to define the width for a particular column in the grid. */ - width?: number; + width?: Number; } export interface ContextMenuSettingsSubContextMenu { @@ -24147,35 +24138,34 @@ export interface ContextMenuSettingsSubContextMenu { /** Used to get or set the sub menu items to the custom context menu item. * @Default {[]} */ - subMenu?: any[]; + subMenu?: Array; } export interface ContextMenuSettings { - /** Gets or sets a value that indicates whether to add the default context menu actions as a context menu items If enableContextMenu is true it will show all the items related to the target, - * if you want selected items from contextmenu you have to mention in the contextMenuItems + /** Gets or sets a value that indicates whether to add the default context menu actions as a context menu items If enableContextMenu is true it will show all the items related to the target, if you want selected items from contextmenu you have to mention in the contextMenuItems * @Default {[]} */ - contextMenuItems?: any[]; + contextMenuItems?: Array; /** Gets or sets a value that indicates whether to add custom contextMenu items within the toolbar to perform any action in the grid * @Default {[]} */ - customContextMenuItems?: any[]; + customContextMenuItems?: Array; /** Gets or sets a value that indicates whether to enable the context menu action in the grid. * @Default {false} */ - enableContextMenu?: boolean; + enableContextMenu?: Boolean; /** Used to get or set the subMenu to the corresponding custom context menu item. */ - subContextMenu?: ContextMenuSettingsSubContextMenu[]; + subContextMenu?: Array; /** Gets or sets a value that indicates whether to disable the default context menu items in the grid. * @Default {false} */ - disableDefaultItems?: boolean; + disableDefaultItems?: Boolean; } export interface EditSettings { @@ -24183,27 +24173,27 @@ export interface EditSettings { /** Gets or sets a value that indicates whether to enable insert action in the editing mode. * @Default {false} */ - allowAdding?: boolean; + allowAdding?: Boolean; /** Gets or sets a value that indicates whether to enable the delete action in the editing mode. * @Default {false} */ - allowDeleting?: boolean; + allowDeleting?: Boolean; /** Gets or sets a value that indicates whether to enable the edit action in the editing mode. * @Default {false} */ - allowEditing?: boolean; + allowEditing?: Boolean; /** Gets or sets a value that indicates whether to enable the editing action while double click on the record * @Default {true} */ - allowEditOnDblClick?: boolean; + allowEditOnDblClick?: Boolean; /** This specifies the id of the template. This template can be used to display the data that you require to be edited using the Dialog Box * @Default {null} */ - dialogEditorTemplateID?: string; + dialogEditorTemplateID?: String; /** Gets or sets a value that indicates whether to define the mode of editing See editMode * @Default {ej.Grid.EditMode.Normal} @@ -24213,9 +24203,9 @@ export interface EditSettings { /** This specifies the id of the template. This template can be used to display the data that you require to be edited using the External edit form * @Default {null} */ - externalFormTemplateID?: string; + externalFormTemplateID?: String; - /** This specifies to set the position of an External edit form either in the top-right or bottom-left of the grid + /** This specifies to set the position of an External edit form either in the top-right or bottom-left of the grid. See formPosition * @Default {ej.Grid.FormPosition.BottomLeft} */ formPosition?: ej.Grid.FormPosition|string; @@ -24223,9 +24213,9 @@ export interface EditSettings { /** This specifies the id of the template. This template can be used to display the data that you require to be edited using the Inline edit form * @Default {null} */ - inlineFormTemplateID?: string; + inlineFormTemplateID?: String; - /** This specifies to set the position of an adding new row either in the top or bottom of the grid + /** This specifies to set the position of an adding new row either in the top or bottom of the grid. See rowPosition * @Default {ej.Grid.RowPosition.Top} */ rowPosition?: ej.Grid.RowPosition|string; @@ -24233,22 +24223,22 @@ export interface EditSettings { /** Gets or sets a value that indicates whether the confirm dialog has to be shown while saving or discarding the batch changes * @Default {true} */ - showConfirmDialog?: boolean; + showConfirmDialog?: Boolean; /** Gets or sets a value that indicates whether the confirm dialog has to be shown while deleting record * @Default {false} */ - showDeleteConfirmDialog?: boolean; + showDeleteConfirmDialog?: Boolean; /** Gets or sets a value that indicates whether the title for edit form is different from the primarykey column. * @Default {null} */ - titleColumn?: string; + titleColumn?: String; /** Gets or sets a value that indicates whether to display the add new form by default in the grid. * @Default {false} */ - showAddNewRow?: boolean; + showAddNewRow?: Boolean; } export interface FilterSettingsFilteredColumn { @@ -24259,7 +24249,7 @@ export interface FilterSettingsFilteredColumn { /** Gets or sets a value that indicates whether to define the matchCase of given value to be filter. */ - matchCase?: boolean; + matchCase?: Boolean; /** Gets or sets a value that indicates whether to define the filter condition to filtered column. See operator */ @@ -24279,12 +24269,12 @@ export interface FilterSettings { /** Gets or sets a value that indicates to perform the filter operation with case sensitive in excel styled filter menu mode * @Default {false} */ - enableCaseSensitivity?: boolean; + enableCaseSensitivity?: Boolean; /** Gets or sets a value that indicates to define the interDeterminateState of checkbox in excel filter dialog. * @Default {true} */ - enableInterDeterminateState?: boolean; + enableInterDeterminateState?: Boolean; /** This specifies the grid to starts the filter action while typing in the filterBar or after pressing the enter key. based on the filterBarMode. See filterBarMode. * @Default {ej.Grid.FilterBarMode.Immediate} @@ -24294,7 +24284,7 @@ export interface FilterSettings { /** Gets or sets a value that indicates whether to define the filtered columns details programmatically at initial load * @Default {[]} */ - filteredColumns?: FilterSettingsFilteredColumn[]; + filteredColumns?: Array; /** This specifies the grid to show the filterBar or filterMenu to the grid records. See filterType * @Default {ej.Grid.FilterType.FilterBar} @@ -24304,22 +24294,22 @@ export interface FilterSettings { /** This specifies the grid to delay the filter action while typing in the filterBar. * @Default {1500} */ - immediateModeDelay?: number; + immediateModeDelay?: Number; /** Gets or sets a value that indicates the maximum number of filter choices that can be showed in the excel styled filter menu. * @Default {1000} */ - maxFilterChoices?: number; + maxFilterChoices?: Number; /** This specifies the grid to show the filter text within the grid pager itself. * @Default {true} */ - showFilterBarMessage?: boolean; + showFilterBarStatus?: Boolean; /** Gets or sets a value that indicates whether to enable the predicate options in the filtering menu * @Default {false} */ - showPredicate?: boolean; + showPredicate?: Boolean; } export interface GroupSettings { @@ -24327,38 +24317,37 @@ export interface GroupSettings { /** Gets or sets a value that customize the group caption format. * @Default {null} */ - captionFormat?: string; + captionFormat?: String; /** Gets or sets a value that indicates whether to enable animation button option in the group drop area of the grid. * @Default {false} */ - enableDropAreaAutoSizing?: boolean; + enableDropAreaAutoSizing?: Boolean; /** Gets or sets a value that indicates whether to add grouped columns programmatically at initial load * @Default {[]} */ - groupedColumns?: any[]; + groupedColumns?: Array; /** Gets or sets a value that indicates whether to show the group drop area just above the column header. It can be used to avoid ungrouping the already grouped column using groupSettings. * @Default {true} */ - showDropArea?: boolean; + showDropArea?: Boolean; /** Gets or sets a value that indicates whether to hide the grouped columns from the grid * @Default {false} */ - showGroupedColumn?: boolean; + showGroupedColumn?: Boolean; - /** Gets or sets a value that indicates whether to show the group button image(toggle button)in the column header and also in the grouped column in the group drop area. - * It can be used to group/ungroup the columns by click on the toggle button. + /** Gets or sets a value that indicates whether to show the group button image(toggle button)in the column header and also in the grouped column in the group drop area . It can be used to group/ungroup the columns by click on the toggle button. * @Default {false} */ - showToggleButton?: boolean; + showToggleButton?: Boolean; /** Gets or sets a value that indicates whether to enable the close button in the grouped column which is in the group drop area to ungroup the grouped column * @Default {false} */ - showUngroupButton?: boolean; + showUngroupButton?: Boolean; } export interface PageSettings { @@ -24366,49 +24355,49 @@ export interface PageSettings { /** Gets or sets a value that indicates whether to define which page to display currently in the grid * @Default {1} */ - currentPage?: number; + currentPage?: Number; /** Gets or sets a value that indicates whether to pass the current page information as a query string along with the URL while navigating to other page. * @Default {false} */ - enableQueryString?: boolean; + enableQueryString?: Boolean; /** Gets or sets a value that indicates whether to enables pager template for the grid. * @Default {false} */ - enableTemplates?: boolean; + enableTemplates?: Boolean; /** Gets or sets a value that indicates whether to define the number of pages displayed in the pager for navigation * @Default {8} */ - pageCount?: number; + pageCount?: Number; /** Gets or sets a value that indicates whether to define the number of records displayed per page * @Default {12} */ - pageSize?: number; + pageSize?: Number; /** Gets or sets a value that indicates whether to enables default pager for the grid. * @Default {false} */ - showDefaults?: boolean; + showDefaults?: Boolean; /** Gets or sets a value that indicates to add the template as a pager template for grid. * @Default {null} */ - template?: string; + template?: String; /** Get the value of total number of pages in the grid. The totalPages value is calculated based on page size and total records of grid * @Default {null} */ - totalPages?: number; + totalPages?: Number; /** Get the value of total number of records which is bound to the grid. The totalRecordsCount value is calculated based on dataSource bound to the grid. * @Default {null} */ - totalRecordsCount?: number; + totalRecordsCount?: Number; - /** Gets or sets a value that indicates whether to define the number of pages to print + /** Gets or sets a value that indicates whether to define the number of pages to print. See printMode. * @Default {ej.Grid.PrintMode.AllPages} */ printMode?: ej.Grid.PrintMode|string; @@ -24467,17 +24456,17 @@ export interface SelectionSettings { /** Gets or sets a value that indicates the cell selection actions based on the cell selection mode. * @Default {flow} */ - cellSelectionMode?: string; + cellSelectionMode?: String; /** Gets or sets a value that indicates whether to enable the toggle selection behavior for row, cell and column. * @Default {false} */ - enableToggle?: boolean; + enableToggle?: Boolean; /** Gets or sets a value that indicates whether to add the default selection actions as a selection mode.See selectionMode * @Default {[row]} */ - selectionMode?: any[]; + selectionMode?: Array; } export interface ScrollSettings { @@ -24485,42 +24474,42 @@ export interface ScrollSettings { /** This specify the grid to to view data that you require without buffering the entire load of a huge database * @Default {false} */ - allowVirtualScrolling?: boolean; + allowVirtualScrolling?: Boolean; /** It accepts the boolean value and shows or hides the scrollbar while focus in or focus out of the Grid. * @Default {false} */ - autoHide?: boolean; + autoHide?: Boolean; /** Specifies the height and width of button in the scrollbar. * @Default {18} */ - buttonSize?: number; + buttonSize?: Number; /** This specify the grid to enable/disable touch control for scrolling. * @Default {true} */ - enableTouchScroll?: boolean; + enableTouchScroll?: Boolean; /** This specify the grid to freeze particular columns at the time of scrolling. * @Default {0} */ - frozenColumns?: number; + frozenColumns?: Number; /** This specify the grid to freeze particular rows at the time of scrolling. * @Default {0} */ - frozenRows?: number; + frozenRows?: Number; /** This specify the grid to show the vertical scroll bar, to scroll and view the grid contents. * @Default {0} */ - height?: string|number; + height?: String|Number; /** It accepts the integer value and sets the width of scrollbar. * @Default {18} */ - scrollerSize?: number; + scrollerSize?: Number; /** This is used to define the mode of virtual scrolling in grid. See virtualScrollMode * @Default {ej.Grid.VirtualScrollMode.Normal} @@ -24530,35 +24519,35 @@ export interface ScrollSettings { /** This is used to enable the enhanced virtual scrolling in Grid. * @Default {false} */ - enableVirtualization?: boolean; + enableVirtualization?: Boolean; /** This specify the grid to show the horizontal scroll bar, to scroll and view the grid contents * @Default {250} */ - width?: string|number; + width?: String|Number; /** This specify the scroll down pixel of mouse wheel, to scroll mouse wheel and view the grid contents. * @Default {57} */ - scrollOneStepBy?: number; + scrollOneStepBy?: Number; } export interface SortSettingsSortedColumn { /** Gets or sets a value that indicates whether to define the direction to sort the column. */ - direction?: string; + direction?: String; /** Gets or sets a value that indicates whether to define the field name of the column to be sort */ - field?: string; + field?: String; } export interface SortSettings { /** Gets or sets a value that indicates whether to define the direction and field to sort the column. */ - sortedColumns?: SortSettingsSortedColumn[]; + sortedColumns?: Array; } export interface StackedHeaderRowsStackedHeaderColumn { @@ -24571,22 +24560,22 @@ export interface StackedHeaderRowsStackedHeaderColumn { /** Gets or sets a value that indicates class to the corresponding stackedHeaderColumn. * @Default {null} */ - cssClass?: string; + cssClass?: String; /** Gets or sets a value that indicates the header text for the particular stacked header column. * @Default {null} */ - headerText?: string; + headerText?: String; /** Gets or sets a value that indicates the text alignment of the corresponding headerText. * @Default {ej.TextAlign.Left} */ - textAlign?: string; + textAlign?: String; /** Sets the template for tooltip for the Grid stackedHeaderColumns. * @Default {null} */ - tooltip?: string; + tooltip?: String; } export interface StackedHeaderRow { @@ -24594,7 +24583,7 @@ export interface StackedHeaderRow { /** Gets or sets a value that indicates whether to add stacked header columns into the stacked header rows * @Default {[]} */ - stackedHeaderColumns?: StackedHeaderRowsStackedHeaderColumn[]; + stackedHeaderColumns?: Array; } export interface SummaryRowsSummaryColumn { @@ -24602,34 +24591,34 @@ export interface SummaryRowsSummaryColumn { /** Gets or sets a value that indicates the text displayed in the summary column as a value * @Default {null} */ - customSummaryValue?: string; + customSummaryValue?: String; /** This specifies summary column used to perform the summary calculation * @Default {null} */ - dataMember?: string; + dataMember?: String; /** Gets or sets a value that indicates to define the target column at which to display the summary. * @Default {null} */ - displayColumn?: string; + displayColumn?: String; /** Gets or sets a value that indicates the format for the text applied on the column * @Default {null} */ - format?: string; + format?: String; /** Gets or sets a value that indicates the text displayed before the summary column value * @Default {null} */ - prefix?: string; + prefix?: String; /** Gets or sets a value that indicates the text displayed after the summary column value * @Default {null} */ - suffix?: string; + suffix?: String; - /** Gets or sets a value that indicates the type of calculations to be performed for the corresponding summary column + /** Gets or sets a value that indicates the type of calculations to be performed for the corresponding summary column. See summaryType. * @Default {[]} */ summaryType?: ej.Grid.SummaryType|string; @@ -24637,7 +24626,7 @@ export interface SummaryRowsSummaryColumn { /** Gets or sets a value that indicates to add the template for the summary value of dataMember given. * @Default {null} */ - template?: string; + template?: String; } export interface SummaryRow { @@ -24645,31 +24634,31 @@ export interface SummaryRow { /** Gets or sets a value that indicates whether to show the summary value within the group caption area for the corresponding summary column while grouping the column * @Default {false} */ - showCaptionSummary?: boolean; + showCaptionSummary?: Boolean; /** Gets or sets a value that indicates whether to show the group summary value for the corresponding summary column while grouping a column * @Default {false} */ - showGroupSummary?: boolean; + showGroupSummary?: Boolean; /** Gets or sets a value that indicates whether to show the total summary value the for the corresponding summary column. The summary row is added after the grid content. * @Default {true} */ - showTotalSummary?: boolean; + showTotalSummary?: Boolean; /** Gets or sets a value that indicates whether to add summary columns into the summary rows. * @Default {[]} */ - summaryColumns?: SummaryRowsSummaryColumn[]; + summaryColumns?: Array; /** This specifies the grid to show the title for the summary rows. */ - title?: string; + title?: String; /** This specifies the grid to show the title of summary row in the specified column. * @Default {null} */ - titleColumn?: string; + titleColumn?: String; } export interface TextWrapSettings { @@ -24685,20 +24674,20 @@ export interface ToolbarSettings { /** Gets or sets a value that indicates whether to add custom toolbar items within the toolbar to perform any action in the grid * @Default {[]} */ - customToolbarItems?: any[]; + customToolbarItems?: Array; /** Gets or sets a value that indicates whether to enable toolbar in the grid. * @Default {false} */ - showToolbar?: boolean; + showToolbar?: Boolean; - /** Gets or sets a value that indicates whether to add the default editing actions as a toolbar items + /** Gets or sets a value that indicates whether to add the default editing actions as a toolbar items. See toolbarItems. * @Default {[]} */ toolbarItems?: Array; } -enum GridLines { +enum GridLines{ ///Displays both the horizontal and vertical grid lines. Both, @@ -24714,7 +24703,7 @@ enum GridLines { } -enum ClipMode { +enum ClipMode{ ///Shows ellipsis for the overflown cell. Ellipsis, @@ -24727,7 +24716,7 @@ enum ClipMode { } -enum ColumnLayout { +enum ColumnLayout{ ///Column layout is auto(based on width). Auto, @@ -24737,7 +24726,7 @@ enum ColumnLayout { } -enum UnboundType { +enum UnboundType{ ///Unbound type is edit. Edit, @@ -24753,7 +24742,7 @@ enum UnboundType { } -enum EditingType { +enum EditingType{ ///Specifies editing type as string edit. String, @@ -24775,7 +24764,7 @@ enum EditingType { } -enum FilterType { +enum FilterType{ ///Specifies the filter type as menu. Menu, @@ -24785,7 +24774,7 @@ enum FilterType { } -enum EditMode { +enum EditMode{ ///Edit mode is normal. Normal, @@ -24813,7 +24802,7 @@ enum EditMode { } -enum FormPosition { +enum FormPosition{ ///Form position is bottomleft. BottomLeft, @@ -24823,7 +24812,7 @@ enum FormPosition { } -enum RowPosition { +enum RowPosition{ ///Specifies position of add new row as top. Top, @@ -24833,7 +24822,7 @@ enum RowPosition { } -enum FilterBarMode { +enum FilterBarMode{ ///Initiate filter operation on typing the filter query. Immediate, @@ -24843,7 +24832,7 @@ enum FilterBarMode { } -enum PrintMode { +enum PrintMode{ ///Prints all pages. AllPages, @@ -24853,7 +24842,7 @@ enum PrintMode { } -enum ResizeMode { +enum ResizeMode{ ///New column size will be adjusted by all other Columns Normal, @@ -24866,7 +24855,7 @@ enum ResizeMode { } -enum SelectionType { +enum SelectionType{ ///Specifies the selection type as single. Single, @@ -24876,7 +24865,7 @@ enum SelectionType { } -enum VirtualScrollMode { +enum VirtualScrollMode{ ///virtual scroll mode is normal. Normal, @@ -24886,7 +24875,7 @@ enum VirtualScrollMode { } -enum SummaryType { +enum SummaryType{ ///Summary type is average. Average, @@ -24914,7 +24903,7 @@ enum SummaryType { } -enum WrapMode { +enum WrapMode{ ///Auto wrap is applied for both content and header. Both, @@ -24927,7 +24916,7 @@ enum WrapMode { } -enum ToolBarItems { +enum ToolBarItems{ ///Toolbar item is add. Add, @@ -24961,17 +24950,18 @@ enum ToolBarItems { class Sparkline extends ej.Widget { static fn: Sparkline; - constructor(element: JQuery | Element, options?: Sparkline.Model); + constructor(element: JQuery, options?: Sparkline.Model); + constructor(element: Element, options?: Sparkline.Model); static Locale: any; - model: Sparkline.Model; - defaults: Sparkline.Model; + model:Sparkline.Model; + defaults:Sparkline.Model; /** Redraws the entire sparkline. You can call this method whenever you update, add or remove points from the data source or whenever you want to refresh the UI. * @returns {void} */ redraw(): void; } -export namespace Sparkline { +export module Sparkline{ export interface Model { @@ -25094,28 +25084,28 @@ export interface Model { axisLineSettings?: AxisLineSettings; /** Fires before loading the sparkline. */ - load?(e: LoadEventArgs): void; + load? (e: LoadEventArgs): void; /** Fires after loaded the sparkline. */ - loaded?(e: LoadedEventArgs): void; + loaded? (e: LoadedEventArgs): void; /** Fires before rendering trackball tooltip. You can use this event to customize the text displayed in trackball tooltip. */ - tooltipInitialize?(e: TooltipInitializeEventArgs): void; + tooltipInitialize? (e: TooltipInitializeEventArgs): void; /** Fires before rendering a series. This event is fired for each series in Sparkline. */ - seriesRendering?(e: SeriesRenderingEventArgs): void; + seriesRendering? (e: SeriesRenderingEventArgs): void; /** Fires when mouse is moved over a point. */ - pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; + pointRegionMouseMove? (e: PointRegionMouseMoveEventArgs): void; /** Fires on clicking a point in sparkline. You can use this event to handle clicks made on points. */ - pointRegionMouseClick?(e: PointRegionMouseClickEventArgs): void; + pointRegionMouseClick? (e: PointRegionMouseClickEventArgs): void; /** Fires on moving mouse over the sparkline. */ - sparklineMouseMove?(e: SparklineMouseMoveEventArgs): void; + sparklineMouseMove? (e: SparklineMouseMoveEventArgs): void; /** Fires on moving mouse outside the sparkline. */ - sparklineMouseLeave?(e: SparklineMouseLeaveEventArgs): void; + sparklineMouseLeave? (e: SparklineMouseLeaveEventArgs): void; } export interface LoadEventArgs { @@ -25150,7 +25140,7 @@ export interface LoadedEventArgs { export interface TooltipInitializeEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -25274,7 +25264,7 @@ export interface PointRegionMouseClickEventArgs { export interface SparklineMouseMoveEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -25289,7 +25279,7 @@ export interface SparklineMouseMoveEventArgs { export interface SparklineMouseLeaveEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -25490,8 +25480,10 @@ export interface AxisLineSettings { dashArray?: number; } } -namespace Sparkline { -enum Type { +module Sparkline +{ +enum Type +{ //string Area, //string @@ -25504,8 +25496,10 @@ Pie, WinLoss, } } -namespace Sparkline { -enum Theme { +module Sparkline +{ +enum Theme +{ //string Azure, //string @@ -25528,16 +25522,20 @@ GradientLight, GradientDark, } } -namespace Sparkline { -enum FontStyle { +module Sparkline +{ +enum FontStyle +{ //string Normal, //string Italic, } } -namespace Sparkline { -enum FontWeight { +module Sparkline +{ +enum FontWeight +{ //string Regular, //string @@ -25549,10 +25547,11 @@ Lighter, class SunburstChart extends ej.Widget { static fn: SunburstChart; - constructor(element: JQuery | Element, options?: SunburstChart.Model); + constructor(element: JQuery, options?: SunburstChart.Model); + constructor(element: Element, options?: SunburstChart.Model); static Locale: any; - model: SunburstChart.Model; - defaults: SunburstChart.Model; + model:SunburstChart.Model; + defaults:SunburstChart.Model; /** Redraws the entire sunburst. You can call this method whenever you update, add or remove points from the data source or whenever you want to refresh the UI. * @returns {void} @@ -25564,7 +25563,7 @@ class SunburstChart extends ej.Widget { */ _destroy(): void; } -export namespace SunburstChart { +export module SunburstChart{ export interface Model { @@ -25672,7 +25671,7 @@ export interface Model { /** Specify levels of sunburst for grouped visualization of data * @Default {[]} */ - levels?: Level[]; + levels?: Array; /** Options to customize the legend items and legend title. */ @@ -25707,40 +25706,40 @@ export interface Model { animationType?: ej.datavisualization.Sunburst.Animation|string; /** Fires before loading. */ - load?(e: LoadEventArgs): void; + load? (e: LoadEventArgs): void; /** Fires before rendering sunburst. */ - preRender?(e: PreRenderEventArgs): void; + preRender? (e: PreRenderEventArgs): void; /** Fires after rendering sunburst. */ - loaded?(e: LoadedEventArgs): void; + loaded? (e: LoadedEventArgs): void; /** Fires before rendering the datalabel */ - dataLabelRendering?(e: DataLabelRenderingEventArgs): void; + dataLabelRendering? (e: DataLabelRenderingEventArgs): void; /** Fires before rendering each segment */ - segmentRendering?(e: SegmentRenderingEventArgs): void; + segmentRendering? (e: SegmentRenderingEventArgs): void; /** Fires before rendering sunburst title. */ - titleRendering?(e: TitleRenderingEventArgs): void; + titleRendering? (e: TitleRenderingEventArgs): void; /** Fires during initialization of tooltip. */ - tooltipInitialize?(e: TooltipInitializeEventArgs): void; + tooltipInitialize? (e: TooltipInitializeEventArgs): void; /** Fires after clicking the point in sunburst */ - pointRegionClick?(e: PointRegionClickEventArgs): void; + pointRegionClick? (e: PointRegionClickEventArgs): void; /** Fires while moving the mouse over sunburst points */ - pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; + pointRegionMouseMove? (e: PointRegionMouseMoveEventArgs): void; /** Fires when clicking the point to perform drilldown. */ - drillDownClick?(e: DrillDownClickEventArgs): void; + drillDownClick? (e: DrillDownClickEventArgs): void; /** Fires when resetting drilldown points. */ - drillDownBack?(e: DrillDownBackEventArgs): void; + drillDownBack? (e: DrillDownBackEventArgs): void; /** Fires after resetting the sunburst points */ - drillDownReset?(e: DrillDownResetEventArgs): void; + drillDownReset? (e: DrillDownResetEventArgs): void; } export interface LoadEventArgs { @@ -26563,16 +26562,20 @@ export interface ZoomSettings { toolbarVerticalAlignment?: ej.datavisualization.Sunburst.SunburstVerticalAlignment|string; } } -namespace Sunburst { -enum FontStyle { +module Sunburst +{ +enum FontStyle +{ //string Normal, //string Italic, } } -namespace Sunburst { -enum FontWeight { +module Sunburst +{ +enum FontWeight +{ //string Regular, //string @@ -26581,16 +26584,20 @@ Bold, Lighter, } } -namespace Sunburst { -enum SunburstLabelRotationMode { +module Sunburst +{ +enum SunburstLabelRotationMode +{ //string Angle, //string Normal, } } -namespace Sunburst { -enum SunburstLabelOverflowMode { +module Sunburst +{ +enum SunburstLabelOverflowMode +{ //string Trim, //string @@ -26599,8 +26606,10 @@ Hide, None, } } -namespace Sunburst { -enum SunburstAlignment { +module Sunburst +{ +enum SunburstAlignment +{ //string Center, //string @@ -26609,8 +26618,10 @@ Near, Far, } } -namespace Sunburst { -enum SunburstHighlightMode { +module Sunburst +{ +enum SunburstHighlightMode +{ //string Point, //string @@ -26621,16 +26632,20 @@ Child, All, } } -namespace Sunburst { -enum SunburstHighlightType { +module Sunburst +{ +enum SunburstHighlightType +{ //string Opacity, //string Color, } } -namespace Sunburst { -enum SunburstClickAction { +module Sunburst +{ +enum SunburstClickAction +{ //string None, //string @@ -26639,8 +26654,10 @@ ToggleSegmentVisibility, ToggleSegmentSelection, } } -namespace Sunburst { -enum SunburstLegendPosition { +module Sunburst +{ +enum SunburstLegendPosition +{ //string Left, //string @@ -26651,8 +26668,10 @@ Top, Bottom, } } -namespace Sunburst { -enum SunburstLegendShape { +module Sunburst +{ +enum SunburstLegendShape +{ //string Diamond, //string @@ -26667,16 +26686,20 @@ Cross, Triangle, } } -namespace Sunburst { -enum SunburstTheme { +module Sunburst +{ +enum SunburstTheme +{ //string FlatLight, //string FlatDark, } } -namespace Sunburst { -enum SunburstHorizontalAlignment { +module Sunburst +{ +enum SunburstHorizontalAlignment +{ //string Center, //string @@ -26685,8 +26708,10 @@ Left, Right, } } -namespace Sunburst { -enum SunburstVerticalAlignment { +module Sunburst +{ +enum SunburstVerticalAlignment +{ //string Top, //string @@ -26695,8 +26720,10 @@ Bottom, Middle, } } -namespace Sunburst { -enum Animation { +module Sunburst +{ +enum Animation +{ //string Rotation, //string @@ -26706,10 +26733,11 @@ FadeIn, class PivotGrid extends ej.Widget { static fn: PivotGrid; - constructor(element: JQuery | Element, options?: PivotGrid.Model); + constructor(element: JQuery, options?: PivotGrid.Model); + constructor(element: Element, options?: PivotGrid.Model); static Locale: any; - model: PivotGrid.Model; - defaults: PivotGrid.Model; + model:PivotGrid.Model; + defaults:PivotGrid.Model; /** Performs an asynchronous HTTP (AJAX) request. * @returns {void} @@ -26779,7 +26807,7 @@ class PivotGrid extends ej.Widget { /** Returns the JSON records formed to render the control. * @returns {Array} */ - getJSONRecords(): any[]; + getJSONRecords(): Array; /** Sets the JSON records formed to render the control. * @returns {void} @@ -26796,7 +26824,7 @@ class PivotGrid extends ej.Widget { */ renderControlFromJSON(): void; } -export namespace PivotGrid { +export module PivotGrid{ export interface Model { @@ -26806,12 +26834,12 @@ export interface Model { analysisMode?: ej.Pivot.AnalysisMode|string; /** Specifies the CSS class to PivotGrid to achieve custom theme. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ cssClass?: string; /** Connects the PivotSchemaDesigner with the specified ID to the PivotGrid Control. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ pivotTableFieldListID?: string; @@ -26820,7 +26848,7 @@ export interface Model { */ dataSource?: DataSource; - /** Holds the neccessary properties for value sorting. + /** Holds the necessary properties for value sorting. * @Default {{}} */ valueSortSettings?: ValueSortSettings; @@ -26950,7 +26978,7 @@ export interface Model { */ hyperlinkSettings?: HyperlinkSettings; - /** Allows the user to enable PivotGrid’s responsiveness in the browser layout. + /** Allows the user to enable PivotGridĂ¢â‚¬â„¢s responsiveness in the browser layout. * @Default {false} */ isResponsive?: boolean; @@ -26980,69 +27008,69 @@ export interface Model { serviceMethodSettings?: ServiceMethodSettings; /** Connects the service using the specified URL for any server updates. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ url?: string; /** Triggers when it reaches client-side after any AJAX request. */ - afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; + afterServiceInvoke? (e: AfterServiceInvokeEventArgs): void; /** Triggers before any AJAX request is passed from PivotGrid to service methods. */ - beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; + beforeServiceInvoke? (e: BeforeServiceInvokeEventArgs): void; /** Triggers before Pivot Engine starts to populate. */ - beforePivotEnginePopulate?(e: BeforePivotEnginePopulateEventArgs): void; + beforePivotEnginePopulate? (e: BeforePivotEnginePopulateEventArgs): void; /** Triggers when double click action is performed over a cell. */ - cellDoubleClick?(e: CellDoubleClickEventArgs): void; + cellDoubleClick? (e: CellDoubleClickEventArgs): void; /** Triggers when right-click action is performed on a cell. */ - cellContext?(e: CellContextEventArgs): void; + cellContext? (e: CellContextEventArgs): void; /** Triggers when a specific range of value cells are selected. */ - cellSelection?(e: CellSelectionEventArgs): void; + cellSelection? (e: CellSelectionEventArgs): void; /** Triggers when the hyperlink of column header is clicked. */ - columnHeaderHyperlinkClick?(e: ColumnHeaderHyperlinkClickEventArgs): void; + columnHeaderHyperlinkClick? (e: ColumnHeaderHyperlinkClickEventArgs): void; /** Triggers after performing drill operation in PivotGrid. */ - drillSuccess?(e: DrillSuccessEventArgs): void; + drillSuccess? (e: DrillSuccessEventArgs): void; /** Triggers while clicking "OK" button in the drill-through dialog. */ - drillThrough?(e: DrillThroughEventArgs): void; + drillThrough? (e: DrillThroughEventArgs): void; /** Triggers when PivotGrid loading is initiated. */ - load?(e: LoadEventArgs): void; + load? (e: LoadEventArgs): void; /** Triggers when PivotGrid widget completes all operations at client-side after any AJAX request. */ - renderComplete?(e: RenderCompleteEventArgs): void; + renderComplete? (e: RenderCompleteEventArgs): void; /** Triggers when any error occurred during AJAX request. */ - renderFailure?(e: RenderFailureEventArgs): void; + renderFailure? (e: RenderFailureEventArgs): void; /** Triggers when PivotGrid successfully reaches client-side after any AJAX request. */ - renderSuccess?(e: RenderSuccessEventArgs): void; + renderSuccess? (e: RenderSuccessEventArgs): void; /** Triggers when the hyperlink of row header is clicked. */ - rowHeaderHyperlinkClick?(e: RowHeaderHyperlinkClickEventArgs): void; + rowHeaderHyperlinkClick? (e: RowHeaderHyperlinkClickEventArgs): void; /** Triggers when the hyperlink of summary cell is clicked. */ - summaryCellHyperlinkClick?(e: SummaryCellHyperlinkClickEventArgs): void; + summaryCellHyperlinkClick? (e: SummaryCellHyperlinkClickEventArgs): void; /** Triggers when the hyperlink of value cell is clicked. */ - valueCellHyperlinkClick?(e: ValueCellHyperlinkClickEventArgs): void; + valueCellHyperlinkClick? (e: ValueCellHyperlinkClickEventArgs): void; /** Triggers before saving the current report to database. */ - saveReport?(e: SaveReportEventArgs): void; + saveReport? (e: SaveReportEventArgs): void; /** Triggers before loading a report from database. */ - loadReport?(e: LoadReportEventArgs): void; + loadReport? (e: LoadReportEventArgs): void; /** Triggers before performing exporting in pivot grid. */ - beforeExport?(e: BeforeExportEventArgs): void; + beforeExport? (e: BeforeExportEventArgs): void; /** Triggers before editing the cells. */ - cellEdit?(e: CellEditEventArgs): void; + cellEdit? (e: CellEditEventArgs): void; } export interface AfterServiceInvokeEventArgs { @@ -27086,7 +27114,7 @@ export interface CellDoubleClickEventArgs { /** returns the JSON details of the double clicked cell. */ - selectedData?: any[]; + selectedData?: Array; /** returns the custom object bound with PivotGrid control. */ @@ -27318,7 +27346,7 @@ export interface CellEditEventArgs { /** contains the array of cells selected for editing. */ - editCellsInfo?: any[]; + editCellsInfo?: Array; } export interface DataSourceColumnsAdvancedFilter { @@ -27347,7 +27375,7 @@ export interface DataSourceColumnsAdvancedFilter { /** Allows the user to hold the filter operand values in advanced filtering. */ - values?: any[]; + values?: Array; } export interface DataSourceColumnsFilterItems { @@ -27360,7 +27388,7 @@ export interface DataSourceColumnsFilterItems { /** Contains the collection of items to be included/excluded among the field members. * @Default {[]} */ - values?: any[]; + values?: Array; } export interface DataSourceColumn { @@ -27376,7 +27404,7 @@ export interface DataSourceColumn { /** Allows the user to filter the report by default using advanced filtering (excel-like) option for OLAP data source in client-mode. * @Default {[]} */ - advancedFilter?: DataSourceColumnsAdvancedFilter[]; + advancedFilter?: Array; /** Allows the user to indicate whether the added item is a named set or not. * @Default {false} @@ -27396,7 +27424,7 @@ export interface DataSourceColumn { /** Contains the list of members need to be drilled down by default in the field. * @Default {[]} */ - drilledItems?: any[]; + drilledItems?: Array; /** Applies filter to the field members. * @Default {null} @@ -27430,7 +27458,7 @@ export interface DataSourceRowsAdvancedFilter { /** Allows the user to hold the filter operand values in advanced filtering. */ - values?: any[]; + values?: Array; } export interface DataSourceRowsFilterItems { @@ -27443,7 +27471,7 @@ export interface DataSourceRowsFilterItems { /** Contains the collection of items to be included/excluded among the field members. * @Default {[]} */ - values?: any[]; + values?: Array; } export interface DataSourceRow { @@ -27459,7 +27487,7 @@ export interface DataSourceRow { /** Allows the user to filter the report by default using advanced filtering (excel-like) option for OLAP data source in client-mode. * @Default {[]} */ - advancedFilter?: DataSourceRowsAdvancedFilter[]; + advancedFilter?: Array; /** Allows the user to indicate whether the added item is a named set or not. * @Default {false} @@ -27479,7 +27507,7 @@ export interface DataSourceRow { /** Contains the list of members need to be drilled down by default in the field. * @Default {[]} */ - drilledItems?: any[]; + drilledItems?: Array; /** Applies filter to the field members. * @Default {null} @@ -27507,7 +27535,7 @@ export interface DataSourceValue { /** This holds the list of unique names of measures to bind them from the OLAP cube. * @Default {[]} */ - measures?: DataSourceValuesMeasure[]; + measures?: Array; /** Allows to set the axis name to place the measures items. * @Default {rows} @@ -27547,7 +27575,7 @@ export interface DataSourceFiltersFilterItems { /** Contains the collection of items to be included/excluded among the field members. * @Default {[]} */ - values?: any[]; + values?: Array; } export interface DataSourceFilter { @@ -27594,25 +27622,25 @@ export interface DataSource { /** Lists out the items to be arranged in columns section of PivotGrid. * @Default {[]} */ - columns?: DataSourceColumn[]; + columns?: Array; /** Lists out the items to be arranged in rows section of PivotGrid. * @Default {[]} */ - rows?: DataSourceRow[]; + rows?: Array; /** Lists out the items which supports calculation in PivotGrid. * @Default {[]} */ - values?: DataSourceValue[]; + values?: Array; /** Lists out the items which supports filtering of values without displaying the members in UI in PivotGrid. * @Default {[]} */ - filters?: DataSourceFilter[]; + filters?: Array; /** Contains the respective cube name from OLAP database as string type. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ cube?: string; @@ -27622,7 +27650,7 @@ export interface DataSource { data?: any; /** In connection with an OLAP database, this property contains the database name as string to fetch the data from the given connection string. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ catalog?: string; @@ -27791,7 +27819,7 @@ export interface ServiceMethodSettings { writeBack?: string; } -enum Layout { +enum Layout{ ///To set normal summary layout in PivotGrid. Normal, @@ -27807,16 +27835,20 @@ enum Layout { } } -namespace Pivot { -enum AnalysisMode { +module Pivot +{ +enum AnalysisMode +{ //To bind an OLAP data source to PivotGrid. OLAP, //To bind a relational data source to PivotGrid. Pivot, } } -namespace PivotAnalysis { -enum SortOrder { +module PivotAnalysis +{ +enum SortOrder +{ //Sorts the members of the field in ascending order. Ascending, //Sorts the members of the field in descending order. @@ -27825,16 +27857,20 @@ Descending, None, } } -namespace PivotAnalysis { -enum FilterType { +module PivotAnalysis +{ +enum FilterType +{ //Excludes the specified values among the members of the field. Exclude, //Includes the specified values alone among the members of the field. Include, } } -namespace PivotAnalysis { -enum SummaryType { +module PivotAnalysis +{ +enum SummaryType +{ //Calculates the summary as the total of all values. Sum, //Displays the average of all values as the summaries. @@ -27847,8 +27883,10 @@ Min, Max, } } -namespace Pivot { -enum OperationalMode { +module Pivot +{ +enum OperationalMode +{ //To bind data source completely from client-side. ClientMode, //To bind data source completely from server-side. @@ -27858,10 +27896,11 @@ ServerMode, class PivotSchemaDesigner extends ej.Widget { static fn: PivotSchemaDesigner; - constructor(element: JQuery | Element, options?: PivotSchemaDesigner.Model); + constructor(element: JQuery, options?: PivotSchemaDesigner.Model); + constructor(element: Element, options?: PivotSchemaDesigner.Model); static Locale: any; - model: PivotSchemaDesigner.Model; - defaults: PivotSchemaDesigner.Model; + model:PivotSchemaDesigner.Model; + defaults:PivotSchemaDesigner.Model; /** Performs an asynchronous HTTP (AJAX) request. * @returns {void} @@ -27873,12 +27912,12 @@ class PivotSchemaDesigner extends ej.Widget { */ refreshControl(): void; } -export namespace PivotSchemaDesigner { +export module PivotSchemaDesigner{ export interface Model { /** Specifies the CSS class to PivotSchemaDesigner to achieve custom theme. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ cssClass?: string; @@ -27887,8 +27926,7 @@ export interface Model { */ customObject?: any; - /** For ASP.NET and MVC Wrapper, PivotSchemaDesigner will be initialized and rendered empty initially. Once the connected pivot control widget is rendered completely, - * PivotSchemaDesigner will just be populated with data source by setting this property to “trueâ€. + /** For ASP.NET and MVC Wrapper, PivotSchemaDesigner will be initialized and rendered empty initially. Once the connected pivot control widget is rendered completely, PivotSchemaDesigner will just be populated with data source by setting this property to Ă¢â‚¬Å“trueĂ¢â‚¬Â. * @Default {false} */ enableWrapper?: boolean; @@ -27909,7 +27947,7 @@ export interface Model { enableDragDrop?: boolean; /** Sets the height for PivotSchemaDesigner. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ height?: string; @@ -27929,12 +27967,12 @@ export interface Model { serviceMethod?: ServiceMethod; /** Connects the service using the specified URL for any server updates. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ url?: string; /** Sets the width for PivotSchemaDesigner. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ width?: string; @@ -27944,13 +27982,13 @@ export interface Model { layout?: ej.PivotSchemaDesigner.Layouts|string; /** Triggers when it reaches client-side after any AJAX request. */ - afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; + afterServiceInvoke? (e: AfterServiceInvokeEventArgs): void; /** Triggers before any AJAX request is passed from PivotSchemaDesigner to service methods. */ - beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; + beforeServiceInvoke? (e: BeforeServiceInvokeEventArgs): void; /** Triggers when we start dragging any field from PivotSchemaDesigner. */ - dragMove?(e: DragMoveEventArgs): void; + dragMove? (e: DragMoveEventArgs): void; } export interface AfterServiceInvokeEventArgs { @@ -28048,7 +28086,7 @@ export interface ServiceMethod { removeButton?: string; } -enum Layouts { +enum Layouts{ ///To set the layout as same in the Excel. Excel, @@ -28064,17 +28102,18 @@ enum Layouts { class PivotPager extends ej.Widget { static fn: PivotPager; - constructor(element: JQuery | Element, options?: PivotPager.Model); + constructor(element: JQuery, options?: PivotPager.Model); + constructor(element: Element, options?: PivotPager.Model); static Locale: any; - model: PivotPager.Model; - defaults: PivotPager.Model; + model:PivotPager.Model; + defaults:PivotPager.Model; /** This function initializes the page counts and page numbers for the PivotPager. * @returns {void} */ initPagerProperties(): void; } -export namespace PivotPager { +export module PivotPager{ export interface Model { @@ -28109,12 +28148,12 @@ export interface Model { seriesPageCount?: number; /** Contains the ID of the target element for which paging needs to be done. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ targetControlID?: string; } -enum Mode { +enum Mode{ ///To set both categorical and series pager for paging. Both, @@ -28130,10 +28169,11 @@ enum Mode { class PivotChart extends ej.Widget { static fn: PivotChart; - constructor(element: JQuery | Element, options?: PivotChart.Model); + constructor(element: JQuery, options?: PivotChart.Model); + constructor(element: Element, options?: PivotChart.Model); static Locale: any; - model: PivotChart.Model; - defaults: PivotChart.Model; + model:PivotChart.Model; + defaults:PivotChart.Model; /** Performs an asynchronous HTTP (AJAX) request. * @returns {void} @@ -28173,7 +28213,7 @@ class PivotChart extends ej.Widget { /** Returns the JSON records formed to render the control. * @returns {Array} */ - getJSONRecords(): any[]; + getJSONRecords(): Array; /** Sets the JSON records to render the control. * @returns {void} @@ -28183,7 +28223,7 @@ class PivotChart extends ej.Widget { /** Returns the PivotEngine formed to render the control. * @returns {Array} */ - getPivotEngine(): any[]; + getPivotEngine(): Array; /** Sets the PivotEngine required to render the control. * @returns {void} @@ -28205,7 +28245,7 @@ class PivotChart extends ej.Widget { */ refreshPagedPivotChart(): void; } -export namespace PivotChart { +export module PivotChart{ export interface Model { @@ -28215,7 +28255,7 @@ export interface Model { analysisMode?: ej.Pivot.AnalysisMode|string; /** Specifies the CSS class to PivotChart to achieve custom theme. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ cssClass?: string; @@ -28249,7 +28289,7 @@ export interface Model { */ enableRTL?: boolean; - /** Allows the user to enable PivotChart’s responsiveness in the browser layout. + /** Allows the user to enable PivotChartĂ¢â‚¬â„¢s responsiveness in the browser layout. * @Default {false} */ isResponsive?: boolean; @@ -28269,16 +28309,12 @@ export interface Model { */ operationalMode?: ej.Pivot.OperationalMode|string; - /** This is a horizontal axis that contains options to configure axis and it is the primary x axis for all the series in series array. - * To override x axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. - * Then, assign the name to the series’s xAxisName property to link both axis and series. + /** This is a horizontal axis that contains options to configure axis and it is the primary x axis for all the series in series array. To override x axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. Then, assign the name to the seriesĂ¢â‚¬â„¢s xAxisName property to link both axis and series. * @Default {{}} */ primaryXAxis?: any; - /** This is a vertical axis that contains options to configure axis. This is the primary y axis for all the series in series array. - * To override y axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. - * Then, assign the name to the series’s yAxisName property to link both axis and series. + /** This is a vertical axis that contains options to configure axis. This is the primary y axis for all the series in series array. To override y axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. Then, assign the name to the seriesĂ¢â‚¬â„¢s yAxisName property to link both axis and series. * @Default {{}} */ primaryYAxis?: any; @@ -28299,33 +28335,33 @@ export interface Model { size?: any; /** Connects the service using the specified URL for any server updates on operating the control in server mode. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ url?: string; /** Triggers when PivotChart starts to render. */ - load?(e: LoadEventArgs): void; + load? (e: LoadEventArgs): void; /** Triggers when it reaches client-side after any AJAX request. */ - afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; + afterServiceInvoke? (e: AfterServiceInvokeEventArgs): void; /** Triggers before any AJAX request is passed from PivotChart to service methods. */ - beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; + beforeServiceInvoke? (e: BeforeServiceInvokeEventArgs): void; /** Triggers on performing drill up/down in PivotChart control. */ - drillSuccess?(e: DrillSuccessEventArgs): void; + drillSuccess? (e: DrillSuccessEventArgs): void; /** Triggers when PivotChart widget completes all operations at client-side after any AJAX request. */ - renderComplete?(e: RenderCompleteEventArgs): void; + renderComplete? (e: RenderCompleteEventArgs): void; /** Triggers when any error occurred during AJAX request. */ - renderFailure?(e: RenderFailureEventArgs): void; + renderFailure? (e: RenderFailureEventArgs): void; /** Triggers when PivotChart successfully reaches client-side after any AJAX request. */ - renderSuccess?(e: RenderSuccessEventArgs): void; + renderSuccess? (e: RenderSuccessEventArgs): void; /** Triggers before performing exporting in pivot chart. */ - beforeExport?(e: BeforeExportEventArgs): void; + beforeExport? (e: BeforeExportEventArgs): void; } export interface LoadEventArgs { @@ -28470,7 +28506,7 @@ export interface DataSourceColumnsFilterItems { /** Contains the collection of items to be included/excluded among the field members. * @Default {[]} */ - values?: any[]; + values?: Array; } export interface DataSourceColumn { @@ -28509,7 +28545,7 @@ export interface DataSourceRowsFilterItems { /** Contains the collection of items to be included/excluded among the field members. * @Default {[]} */ - values?: any[]; + values?: Array; } export interface DataSourceRow { @@ -28558,7 +28594,7 @@ export interface DataSourceValue { /** This holds the list of unique names of measures to bind them from the OLAP cube. * @Default {[]} */ - measures?: DataSourceValuesMeasure[]; + measures?: Array; /** Allows to set the axis name to place the measures items. * @Default {rows} @@ -28585,7 +28621,7 @@ export interface DataSourceFiltersFilterItems { /** Contains the collection of items to be included/excluded among the field members. * @Default {[]} */ - values?: any[]; + values?: Array; } export interface DataSourceFilter { @@ -28603,7 +28639,7 @@ export interface DataSourceFilter { export interface DataSource { /** Contains the respective cube name from OLAP database as string type. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ cube?: string; @@ -28613,29 +28649,29 @@ export interface DataSource { data?: any; /** In connection with an OLAP database, this property contains the database name as string to fetch the data from the given connection string. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ catalog?: string; /** Lists out the items to be displayed as series of PivotChart. * @Default {[]} */ - columns?: DataSourceColumn[]; + columns?: Array; /** Lists out the items to be displayed as segments of PivotChart. * @Default {[]} */ - rows?: DataSourceRow[]; + rows?: Array; /** Lists out the items supports calculation in PivotChart. * @Default {[]} */ - values?: DataSourceValue[]; + values?: Array; /** Lists out the items which supports filtering of values without displaying the members in UI in PivotChart. * @Default {[]} */ - filters?: DataSourceFilter[]; + filters?: Array; } export interface ServiceMethodSettings { @@ -28661,7 +28697,7 @@ export interface ServiceMethodSettings { paging?: string; } -enum ChartTypes { +enum ChartTypes{ ///To render a Line type PivotChart. Line, @@ -28719,10 +28755,11 @@ enum ChartTypes { class PivotClient extends ej.Widget { static fn: PivotClient; - constructor(element: JQuery | Element, options?: PivotClient.Model); + constructor(element: JQuery, options?: PivotClient.Model); + constructor(element: Element, options?: PivotClient.Model); static Locale: any; - model: PivotClient.Model; - defaults: PivotClient.Model; + model:PivotClient.Model; + defaults:PivotClient.Model; /** Performs an asynchronous HTTP (AJAX) request. * @returns {void} @@ -28767,14 +28804,14 @@ class PivotClient extends ej.Widget { /** Returns the JSON records formed to render the control. * @returns {Array} */ - getJSONRecords(): any[]; + getJSONRecords(): Array; /** Sets the JSON records formed to render the control to a property. * @returns {void} */ setJSONRecords(): void; } -export namespace PivotClient { +export module PivotClient{ export interface Model { @@ -28794,7 +28831,7 @@ export interface Model { clientExportMode?: ej.PivotClient.ClientExportMode|string; /** Specifies the CSS class to PivotClient to achieve custom theme. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ cssClass?: string; @@ -28873,6 +28910,11 @@ export interface Model { */ gridLayout?: ej.PivotGrid.Layout|string; + /** Allows the user to enable PivotClientĂ¢â‚¬â„¢s responsiveness in the browser layout. + * @Default {false} + */ + isResponsive?: boolean; + /** Allows the user to set the localized language for the widget. * @Default {en-US} */ @@ -28897,40 +28939,40 @@ export interface Model { url?: string; /** Triggers when it reaches client-side after any AJAX request. */ - afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; + afterServiceInvoke? (e: AfterServiceInvokeEventArgs): void; /** Triggers before any AJAX request is passed from client-side to service methods. */ - beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; + beforeServiceInvoke? (e: BeforeServiceInvokeEventArgs): void; /** Triggers before saving the current collection of reports. */ - saveReport?(e: SaveReportEventArgs): void; + saveReport? (e: SaveReportEventArgs): void; /** Triggers before loading a saved collection of reports. */ - loadReport?(e: LoadReportEventArgs): void; + loadReport? (e: LoadReportEventArgs): void; /** Triggers before fetching the report collection from storage. */ - fetchReport?(e: FetchReportEventArgs): void; + fetchReport? (e: FetchReportEventArgs): void; /** Triggers before exporting the control. */ - beforeExport?(e: BeforeExportEventArgs): void; + beforeExport? (e: BeforeExportEventArgs): void; /** Triggers before rendering the PivotChart. */ - chartLoad?(e: ChartLoadEventArgs): void; + chartLoad? (e: ChartLoadEventArgs): void; /** Triggers before rendering the PivotTreeMap. */ - treeMapLoad?(e: TreeMapLoadEventArgs): void; + treeMapLoad? (e: TreeMapLoadEventArgs): void; /** Triggers while we initiate loading of the widget. */ - load?(e: LoadEventArgs): void; + load? (e: LoadEventArgs): void; /** Triggers when PivotClient widget completes all operations at client-end after any AJAX request. */ - renderComplete?(e: RenderCompleteEventArgs): void; + renderComplete? (e: RenderCompleteEventArgs): void; /** Triggers when any error occurred during AJAX request. */ - renderFailure?(e: RenderFailureEventArgs): void; + renderFailure? (e: RenderFailureEventArgs): void; /** Triggers when PivotClient successfully completes rendering. */ - renderSuccess?(e: RenderSuccessEventArgs): void; + renderSuccess? (e: RenderSuccessEventArgs): void; } export interface AfterServiceInvokeEventArgs { @@ -29107,7 +29149,7 @@ export interface DataSourceColumnsAdvancedFilter { /** Allows the user to hold the filter operand values in advanced filtering. */ - values?: any[]; + values?: Array; } export interface DataSourceColumnsFilterItems { @@ -29120,7 +29162,7 @@ export interface DataSourceColumnsFilterItems { /** Contains the collection of items to be included/excluded among the field members. * @Default {[]} */ - values?: any[]; + values?: Array; } export interface DataSourceColumn { @@ -29136,7 +29178,7 @@ export interface DataSourceColumn { /** Allows the user to filter the report by default using advanced filtering (excel-like) option for OLAP data source in client-mode. * @Default {[]} */ - advancedFilter?: DataSourceColumnsAdvancedFilter[]; + advancedFilter?: Array; /** Allows the user to indicate whether the added item is a named set or not. * @Default {false} @@ -29156,7 +29198,7 @@ export interface DataSourceColumn { /** Contains the list of members need to be drilled down by default in the field. * @Default {[]} */ - drilledItems?: any[]; + drilledItems?: Array; /** Applies filter to the field members. * @Default {null} @@ -29190,7 +29232,7 @@ export interface DataSourceRowsAdvancedFilter { /** Allows the user to hold the filter operand values in advanced filtering. */ - values?: any[]; + values?: Array; } export interface DataSourceRowsFilterItems { @@ -29203,7 +29245,7 @@ export interface DataSourceRowsFilterItems { /** Contains the collection of items to be included/excluded among the field members. * @Default {[]} */ - values?: any[]; + values?: Array; } export interface DataSourceRow { @@ -29219,7 +29261,7 @@ export interface DataSourceRow { /** Allows the user to filter the report by default using advanced filtering (excel-like) option for OLAP data source in client-mode. * @Default {[]} */ - advancedFilter?: DataSourceRowsAdvancedFilter[]; + advancedFilter?: Array; /** Allows the user to indicate whether the added item is a named set or not. * @Default {false} @@ -29239,7 +29281,7 @@ export interface DataSourceRow { /** Contains the list of members need to be drilled down by default in the field. * @Default {[]} */ - drilledItems?: any[]; + drilledItems?: Array; /** Applies filter to the field members. * @Default {null} @@ -29267,7 +29309,7 @@ export interface DataSourceValue { /** This holds the list of unique names of measures to bind them from the OLAP cube. * @Default {[]} */ - measures?: DataSourceValuesMeasure[]; + measures?: Array; /** Allows to set the axis name to place the measures items. * @Default {rows} @@ -29307,7 +29349,7 @@ export interface DataSourceFiltersFilterItems { /** Contains the collection of items to be included/excluded among the field members. * @Default {[]} */ - values?: any[]; + values?: Array; } export interface DataSourceFilter { @@ -29354,25 +29396,25 @@ export interface DataSource { /** Lists out the items to be arranged in columns section of PivotClient. * @Default {[]} */ - columns?: DataSourceColumn[]; + columns?: Array; /** Lists out the items to be arranged in rows section of PivotClient. * @Default {[]} */ - rows?: DataSourceRow[]; + rows?: Array; /** Lists out the items which supports calculation in PivotClient. * @Default {[]} */ - values?: DataSourceValue[]; + values?: Array; /** Lists out the items which supports filtering of values without displaying the members in UI in PivotClient. * @Default {[]} */ - filters?: DataSourceFilter[]; + filters?: Array; /** Contains the respective cube name from OLAP database as string type. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ cube?: string; @@ -29382,7 +29424,7 @@ export interface DataSource { data?: any; /** In connection with an OLAP database, this property contains the database name as string to fetch the data from the given connection string. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ catalog?: string; @@ -29423,11 +29465,6 @@ export interface DisplaySettings { */ enableTogglePanel?: boolean; - /** Allows the user to enable PivotClient’s responsiveness in the browser layout. - * @Default {false} - */ - isResponsive?: boolean; - /** Sets the display mode (Only Chart/Only Grid/Both) in PivotClient. * @Default {ej.PivotClient.DisplayMode.ChartAndGrid} */ @@ -29522,7 +29559,7 @@ export interface ServiceMethodSettings { paging?: string; } -enum ClientExportMode { +enum ClientExportMode{ ///Exports both the PivotChart and PivotGrid on exporting. ChartAndGrid, @@ -29535,7 +29572,7 @@ enum ClientExportMode { } -enum ControlPlacement { +enum ControlPlacement{ ///Displays PivotChart and PivotGrid widgets in separate tabs. Tab, @@ -29545,7 +29582,7 @@ enum ControlPlacement { } -enum DefaultView { +enum DefaultView{ ///To set PivotChart as a default control in view. Chart, @@ -29555,7 +29592,7 @@ enum DefaultView { } -enum DisplayMode { +enum DisplayMode{ ///To display only PivotChart widget. ChartOnly, @@ -29571,10 +29608,11 @@ enum DisplayMode { class PivotGauge extends ej.Widget { static fn: PivotGauge; - constructor(element: JQuery | Element, options?: PivotGauge.Model); + constructor(element: JQuery, options?: PivotGauge.Model); + constructor(element: Element, options?: PivotGauge.Model); static Locale: any; - model: PivotGauge.Model; - defaults: PivotGauge.Model; + model:PivotGauge.Model; + defaults:PivotGauge.Model; /** Performs an asynchronous HTTP (AJAX) request. * @returns {void} @@ -29609,7 +29647,7 @@ class PivotGauge extends ej.Widget { /** Returns the JSON records formed to render the control. * @returns {Array} */ - getJSONRecords(): any[]; + getJSONRecords(): Array; /** Sets the JSON records to render the control. * @returns {void} @@ -29621,7 +29659,7 @@ class PivotGauge extends ej.Widget { */ getJSONData(): void; } -export namespace PivotGauge { +export module PivotGauge{ export interface Model { @@ -29631,7 +29669,7 @@ export interface Model { columnsCount?: number; /** Specifies the CSS class to PivotGauge to achieve custom theme. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ cssClass?: string; @@ -29660,7 +29698,7 @@ export interface Model { */ enableRTL?: boolean; - /** Allows the user to enable PivotGauge’s responsiveness in the browser layout. + /** Allows the user to enable PivotGaugeĂ¢â‚¬â„¢s responsiveness in the browser layout. * @Default {false} */ isResponsive?: boolean; @@ -29696,7 +29734,7 @@ export interface Model { showHeaderLabel?: boolean; /** Connects the service using the specified URL for any server updates on server mode operation. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ url?: string; @@ -29711,25 +29749,25 @@ export interface Model { operationalMode?: ej.Pivot.OperationalMode|string; /** Triggers when it reaches client-side after any AJAX request. */ - afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; + afterServiceInvoke? (e: AfterServiceInvokeEventArgs): void; /** Triggers before any AJAX request is passed from PivotGauge to service methods. */ - beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; + beforeServiceInvoke? (e: BeforeServiceInvokeEventArgs): void; /** Triggers before populating the pivot engine on operating in client mode. */ - beforePivotEnginePopulate?(e: BeforePivotEnginePopulateEventArgs): void; + beforePivotEnginePopulate? (e: BeforePivotEnginePopulateEventArgs): void; /** Triggers when PivotGauge started loading at client-side. */ - load?(e: LoadEventArgs): void; + load? (e: LoadEventArgs): void; /** Triggers when PivotGauge widget completes all operations at client-side after any AJAX request. */ - renderComplete?(e: RenderCompleteEventArgs): void; + renderComplete? (e: RenderCompleteEventArgs): void; /** Triggers when any error occurred during AJAX request. */ - renderFailure?(e: RenderFailureEventArgs): void; + renderFailure? (e: RenderFailureEventArgs): void; /** Triggers when PivotGauge successfully reaches client-side after any AJAX request. */ - renderSuccess?(e: RenderSuccessEventArgs): void; + renderSuccess? (e: RenderSuccessEventArgs): void; } export interface AfterServiceInvokeEventArgs { @@ -29827,7 +29865,7 @@ export interface DataSourceColumnsFilterItems { /** Contains the collection of items to be included/excluded among the field members. * @Default {[]} */ - values?: any[]; + values?: Array; } export interface DataSourceColumn { @@ -29852,7 +29890,7 @@ export interface DataSourceRowsFilterItems { /** Contains the collection of items to be included/excluded among the field members. * @Default {[]} */ - values?: any[]; + values?: Array; } export interface DataSourceRow { @@ -29887,7 +29925,7 @@ export interface DataSourceValue { /** This holds the list of unique names of measures to bind them from the OLAP cube. * @Default {[]} */ - measures?: DataSourceValuesMeasure[]; + measures?: Array; /** Allows to set the axis name to place the measures items. * @Default {rows} @@ -29914,7 +29952,7 @@ export interface DataSourceFiltersFilterItems { /** Contains the collection of items to be included/excluded among the field members. * @Default {[]} */ - values?: any[]; + values?: Array; } export interface DataSourceFilter { @@ -29932,7 +29970,7 @@ export interface DataSourceFilter { export interface DataSource { /** Contains the respective cube name from OLAP database as string type. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ cube?: string; @@ -29942,29 +29980,29 @@ export interface DataSource { data?: any; /** In connection with an OLAP database, this property contains the database name as string to fetch the data from the given connection string. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ catalog?: string; /** Lists out the items to bind in columns section. * @Default {[]} */ - columns?: DataSourceColumn[]; + columns?: Array; /** Lists out the items to bind in rows section. * @Default {[]} */ - rows?: DataSourceRow[]; + rows?: Array; /** Lists out the items supports calculation in PivotGauge. * @Default {[]} */ - values?: DataSourceValue[]; + values?: Array; /** Lists out the items which supports filtering of values without displaying the members in UI in PivotGauge. * @Default {[]} */ - filters?: DataSourceFilter[]; + filters?: Array; } export interface LabelFormatSettings { @@ -29996,7 +30034,7 @@ export interface ServiceMethodSettings { initialize?: string; } -enum NumberFormat { +enum NumberFormat{ ///To set default format for label values. Default, @@ -30024,10 +30062,11 @@ enum NumberFormat { class PivotTreeMap extends ej.Widget { static fn: PivotTreeMap; - constructor(element: JQuery | Element, options?: PivotTreeMap.Model); + constructor(element: JQuery, options?: PivotTreeMap.Model); + constructor(element: Element, options?: PivotTreeMap.Model); static Locale: any; - model: PivotTreeMap.Model; - defaults: PivotTreeMap.Model; + model:PivotTreeMap.Model; + defaults:PivotTreeMap.Model; /** Performs an asynchronous HTTP (AJAX) request. * @returns {void} @@ -30047,7 +30086,7 @@ class PivotTreeMap extends ej.Widget { /** Returns the JSON records formed to render the control. * @returns {Array} */ - getJSONRecords(): any[]; + getJSONRecords(): Array; /** Sets the JSON records to render the control. * @returns {void} @@ -30069,12 +30108,12 @@ class PivotTreeMap extends ej.Widget { */ renderControlSuccess(): void; } -export namespace PivotTreeMap { +export module PivotTreeMap{ export interface Model { /** Specifies the CSS class to PivotTreeMap to achieve custom theme. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ cssClass?: string; @@ -30088,7 +30127,7 @@ export interface Model { */ customObject?: any; - /** Allows the user to enable PivotTreeMap’s responsiveness in the browser layout. + /** Allows the user to enable PivotTreeMapĂ¢â‚¬â„¢s responsiveness in the browser layout. * @Default {false} */ isResponsive?: boolean; @@ -30109,33 +30148,33 @@ export interface Model { serviceMethodSettings?: ServiceMethodSettings; /** Connects the service using the specified URL for any server updates. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ url?: string; /** Triggers when it reaches client-side after any AJAX request. */ - afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; + afterServiceInvoke? (e: AfterServiceInvokeEventArgs): void; /** Triggers before any AJAX request is passed from PivotTreeMap to service methods. */ - beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; + beforeServiceInvoke? (e: BeforeServiceInvokeEventArgs): void; /** Triggers when PivotTreeMap starts to render. */ - load?(e: LoadEventArgs): void; + load? (e: LoadEventArgs): void; /** Triggers before populating the pivot engine from datasource. */ - beforePivotEnginePopulate?(e: BeforePivotEnginePopulateEventArgs): void; + beforePivotEnginePopulate? (e: BeforePivotEnginePopulateEventArgs): void; /** Triggers when drill up/down happens in PivotTreeMap control. And it returns the outer HTML of PivotTreeMap control. */ - drillSuccess?(e: DrillSuccessEventArgs): void; + drillSuccess? (e: DrillSuccessEventArgs): void; /** Triggers when PivotTreeMap widget completes all operations at client-side after any AJAX request. */ - renderComplete?(e: RenderCompleteEventArgs): void; + renderComplete? (e: RenderCompleteEventArgs): void; /** Triggers when any error occurred during AJAX request. */ - renderFailure?(e: RenderFailureEventArgs): void; + renderFailure? (e: RenderFailureEventArgs): void; /** Triggers when PivotTreeMap successfully reaches client-side after any AJAX request. */ - renderSuccess?(e: RenderSuccessEventArgs): void; + renderSuccess? (e: RenderSuccessEventArgs): void; } export interface AfterServiceInvokeEventArgs { @@ -30251,7 +30290,7 @@ export interface DataSourceColumnsFilterItems { /** Contains the collection of items to be excluded among the field members. * @Default {[]} */ - values?: any[]; + values?: Array; } export interface DataSourceColumn { @@ -30276,7 +30315,7 @@ export interface DataSourceRowsFilterItems { /** Contains the collection of items to be excluded among the field members. * @Default {[]} */ - values?: any[]; + values?: Array; } export interface DataSourceRow { @@ -30308,7 +30347,7 @@ export interface DataSourceValue { /** This holds the list of unique names of measures to bind them from the OLAP cube. * @Default {[]} */ - measures?: DataSourceValuesMeasure[]; + measures?: Array; /** Allows to set the axis name to place the measures items. * @Default {rows} @@ -30321,7 +30360,7 @@ export interface DataSourceFiltersFilterItems { /** Contains the collection of items to be excluded among the field members. * @Default {[]} */ - values?: any[]; + values?: Array; } export interface DataSourceFilter { @@ -30344,34 +30383,34 @@ export interface DataSource { data?: any; /** Contains the respective cube name from OLAP database as string type. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ cube?: string; /** In connection with an OLAP database, this property contains the database name as string to fetch the data from the given connection string. - * @Default {“â€} + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} */ catalog?: string; /** Lists out the items to be displayed as series of PivotTreeMap. * @Default {[]} */ - columns?: DataSourceColumn[]; + columns?: Array; /** Lists out the items to be displayed as segments of PivotTreeMap. * @Default {[]} */ - rows?: DataSourceRow[]; + rows?: Array; /** Lists out the items supports calculation in PivotTreeMap. * @Default {[]} */ - values?: DataSourceValue[]; + values?: Array; /** Lists out the items which supports filtering of values without displaying the members in UI in PivotTreeMap. * @Default {[]} */ - filters?: DataSourceFilter[]; + filters?: Array; } export interface ServiceMethodSettings { @@ -30390,10 +30429,11 @@ export interface ServiceMethodSettings { class Schedule extends ej.Widget { static fn: Schedule; - constructor(element: JQuery | Element, options?: Schedule.Model); + constructor(element: JQuery, options?: Schedule.Model); + constructor(element: Element, options?: Schedule.Model); static Locale: any; - model: Schedule.Model; - defaults: Schedule.Model; + model:Schedule.Model; + defaults:Schedule.Model; /** This method is used to delete the appointment based on the guid value or the appointment data passed to it. * @param {string|any} GUID value of an appointment element or an appointment object @@ -30418,15 +30458,14 @@ class Schedule extends ej.Widget { * @param {Array} Holds array of one or more conditional objects for filtering the appointments based on it. * @returns {Array} */ - filterAppointments(filterConditions: any[]): any[]; + filterAppointments(filterConditions: Array): Array; /** Gets the complete appointment list of Schedule control. * @returns {Array} */ - getAppointments(): any[]; + getAppointments(): Array; - /** Prints the entire Scheduler or a single appointment based on the appointment data passed as an argument to it. Simply calling the print() method, - * without passing any argument will print the entire Scheduler. + /** Prints the entire Scheduler or a single appointment based on the appointment data passed as an argument to it. Simply calling the print() method, without passing any argument will print the entire Scheduler. * @param {any} Either accepts no arguments at all or else accepts an appointment object. * @returns {void} */ @@ -30448,9 +30487,7 @@ class Schedule extends ej.Widget { */ getRecurrenceRule(): string; - /** Retrieves the time slot information (start/end time and resource details) of the given element. - * The parameter is optional - as when no element is passed to it, the currently selected cell information will be retrieved. When multiple cells are selected in the Scheduler, - * it is not necessary to provide the parameter. + /** Retrieves the time slot information (start/end time and resource details) of the given element. The parameter is optional - as when no element is passed to it, the currently selected cell information will be retrieved. When multiple cells are selected in the Scheduler, it is not necessary to provide the parameter. * @param {any} TD element object rendered as Scheduler work cell * @returns {any} */ @@ -30463,7 +30500,7 @@ class Schedule extends ej.Widget { * @param {boolean} Defines the ignoreCase value for performing the search operation. * @returns {Array} */ - searchAppointments(searchString: any|string, field: string, operator: ej.FilterOperators|string, ignoreCase: boolean): any[]; + searchAppointments(searchString: any|string, field: string, operator: ej.FilterOperators|string, ignoreCase: boolean): Array; /** Refreshes the entire Schedule control. * @returns {void} @@ -30480,7 +30517,7 @@ class Schedule extends ej.Widget { */ notifyChanges(): void; } -export namespace Schedule { +export module Schedule{ export interface Model { @@ -30494,13 +30531,11 @@ export interface Model { */ allowKeyboardNavigation?: boolean; - /** It includes the dataSource option and the fields related to Schedule appointments. The appointment fields within the appointmentSettings can accept both string and object type values. - * To apply validation rules on the appointment window fields, then the appointment fields needs to be defined with object type values. + /** It includes the dataSource option and the fields related to Schedule appointments. The appointment fields within the appointmentSettings can accept both string and object type values. To apply validation rules on the appointment window fields, then the appointment fields needs to be defined with object type values. */ appointmentSettings?: AppointmentSettings; - /** Template design that applies on the Schedule appointments. All the field names that are mapped from dataSource - * to the appropriate field properties within the appointmentSettings can be used within the template. + /** Template design that applies on the Schedule appointments. All the field names that are mapped from dataSource to the appropriate field properties within the appointmentSettings can be used within the template. * @Default {null} */ appointmentTemplateId?: string; @@ -30531,9 +30566,7 @@ export interface Model { */ currentDate?: any; - /** Sets current view of the Schedule. Schedule renders initially with the view that is specified here. The available views are day, week, workweek, month, agenda and - * custom view - from which any one of the required view can be set to the Schedule. It accepts both string or enum values. The enum values that are accepted - * by currentView(ej.Schedule.CurrentView) are as follows, + /** Sets current view of the Schedule. Schedule renders initially with the view that is specified here. The available views are day, week, workweek, month, agenda and custom view - from which any one of the required view can be set to the Schedule. It accepts both string or enum values. The enum values that are accepted by currentView(ej.Schedule.CurrentView) are as follows, * @Default {ej.Schedule.CurrentView.Week} */ currentView?: string|ej.Schedule.CurrentView; @@ -30610,8 +30643,7 @@ export interface Model { */ minDate?: any; - /** Sets the mode of Schedule rendering either in a vertical or horizontal direction. It accepts either string("vertical" or "horizontal") or enum values. - * The enum values that are accepted by orientation(ej.Schedule.Orientation) are as follows, + /** Sets the mode of Schedule rendering either in a vertical or horizontal direction. It accepts either string("vertical" or "horizontal") or enum values. The enum values that are accepted by orientation(ej.Schedule.Orientation) are as follows, * @Default {ej.Schedule.Orientation.Vertical} */ orientation?: string|ej.Schedule.Orientation; @@ -30629,8 +30661,7 @@ export interface Model { */ reminderSettings?: ReminderSettings; - /** Defines the specific start and end dates to be rendered in the Schedule control. To render such user-specified custom date ranges in the Schedule control, - * set the currentView property to ej.Schedule.CurrentView.CustomView. + /** Defines the specific start and end dates to be rendered in the Schedule control. To render such user-specified custom date ranges in the Schedule control, set the currentView property to ej.Schedule.CurrentView.CustomView. * @Default {null} */ renderDates?: RenderDates; @@ -30640,11 +30671,10 @@ export interface Model { */ resourceHeaderTemplateId?: string; - /** Holds all the options related to the resources settings of the Schedule. It is a collection of one or more resource objects, where the levels of resources are rendered on the Schedule - * based on the order of the resource data provided within this collection. + /** Holds all the options related to the resources settings of the Schedule. It is a collection of one or more resource objects, where the levels of resources are rendered on the Schedule based on the order of the resource data provided within this collection. * @Default {null} */ - resources?: Resource[]; + resources?: Array; /** When set to true, displays the all-day row cells on the Schedule. * @Default {true} @@ -30681,8 +30711,7 @@ export interface Model { */ startHour?: number; - /** Sets either 12 or 24 hour time mode on the Schedule. It accepts either the string value("12" or "24") or the below mentioned enum values. - * The enum values that are accepted by timeMode(ej.Schedule.TimeMode) are as follows, + /** Sets either 12 or 24 hour time mode on the Schedule. It accepts either the string value("12" or "24") or the below mentioned enum values. The enum values that are accepted by timeMode(ej.Schedule.TimeMode) are as follows, * @Default {null} */ timeMode?: string|ej.Schedule.TimeMode; @@ -30699,15 +30728,14 @@ export interface Model { /** Defines the view collection to be displayed on the Schedule. By default, it displays all the views namely, Day, Week, WorkWeek and Month. * @Default {[Day, Week, WorkWeek, Month, Agenda]} */ - views?: any[]; + views?: Array; /** Sets the width of the Schedule. Accepts both pixel and percentage values. * @Default {100%} */ width?: string; - /** When set to true, Schedule allows the validation of recurrence pattern to take place before it is being assigned to the appointments. For example, when one of the instance of - * recurrence appointment is dragged beyond the next or previous instance of the same recurrence appointment, a pop-up is displayed with the validation message disallowing the drag functionality. + /** When set to true, Schedule allows the validation of recurrence pattern to take place before it is being assigned to the appointments. For example, when one of the instance of recurrence appointment is dragged beyond the next or previous instance of the same recurrence appointment, a pop-up is displayed with the validation message disallowing the drag functionality. * @Default {true} */ enableRecurrenceValidation?: boolean; @@ -30724,7 +30752,7 @@ export interface Model { /** Sets different day collection within workWeek view. * @Default {[Monday, Tuesday, Wednesday, Thursday, Friday]} */ - workWeek?: any[]; + workWeek?: Array; /** Allows to pop-up appointment details in a tooltip while hovering over the appointments. */ @@ -30768,100 +30796,99 @@ export interface Model { */ showNextPrevMonth?: boolean; - /** Blocks the user-specific time interval on the Scheduler, so that no appointments can be created on that particular time slots. - * It includes the dataSource option and also the fields related to block intervals. + /** Blocks the user-specific time interval on the Scheduler, so that no appointments can be created on that particular time slots. It includes the dataSource option and also the fields related to block intervals. */ blockoutSettings?: BlockoutSettings; /** Triggers on the beginning of every action that starts within the Schedule. */ - actionBegin?(e: ActionBeginEventArgs): void; + actionBegin? (e: ActionBeginEventArgs): void; /** Triggers after the completion of every action within the Schedule. */ - actionComplete?(e: ActionCompleteEventArgs): void; + actionComplete? (e: ActionCompleteEventArgs): void; /** Triggers after an appointment is clicked. */ - appointmentClick?(e: AppointmentClickEventArgs): void; + appointmentClick? (e: AppointmentClickEventArgs): void; /** Triggers before the appointment is being removed from the Scheduler. */ - beforeAppointmentRemove?(e: BeforeAppointmentRemoveEventArgs): void; + beforeAppointmentRemove? (e: BeforeAppointmentRemoveEventArgs): void; /** Triggers before the edited appointment is being saved. */ - beforeAppointmentChange?(e: BeforeAppointmentChangeEventArgs): void; + beforeAppointmentChange? (e: BeforeAppointmentChangeEventArgs): void; /** Triggers on hovering the mouse over the appointments. */ - appointmentHover?(e: AppointmentHoverEventArgs): void; + appointmentHover? (e: AppointmentHoverEventArgs): void; /** Triggers before the new appointment gets saved. */ - beforeAppointmentCreate?(e: BeforeAppointmentCreateEventArgs): void; + beforeAppointmentCreate? (e: BeforeAppointmentCreateEventArgs): void; /** Triggers before the appointment window opens. */ - appointmentWindowOpen?(e: AppointmentWindowOpenEventArgs): void; + appointmentWindowOpen? (e: AppointmentWindowOpenEventArgs): void; /** Triggers before the context menu opens. */ - beforeContextMenuOpen?(e: BeforeContextMenuOpenEventArgs): void; + beforeContextMenuOpen? (e: BeforeContextMenuOpenEventArgs): void; /** Triggers after the cell is clicked. */ - cellClick?(e: CellClickEventArgs): void; + cellClick? (e: CellClickEventArgs): void; /** Triggers after the cell is clicked twice. */ - cellDoubleClick?(e: CellDoubleClickEventArgs): void; + cellDoubleClick? (e: CellDoubleClickEventArgs): void; /** Triggers on hovering the mouse overs the cells. */ - cellHover?(e: CellHoverEventArgs): void; + cellHover? (e: CellHoverEventArgs): void; /** Triggers when the Scheduler completely renders on the page. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Triggers when the Scheduler and all its sub-components gets destroyed. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Triggers while the appointment is being dragged over the work cells. */ - drag?(e: DragEventArgs): void; + drag? (e: DragEventArgs): void; /** Triggers when the appointment dragging begins. */ - dragStart?(e: DragStartEventArgs): void; + dragStart? (e: DragStartEventArgs): void; /** Triggers when the appointment is dropped. */ - dragStop?(e: DragStopEventArgs): void; + dragStop? (e: DragStopEventArgs): void; /** Triggers after the menu/sub-menu items within the context menu is clicked. */ - menuItemClick?(e: MenuItemClickEventArgs): void; + menuItemClick? (e: MenuItemClickEventArgs): void; /** Triggers after the Schedule view or date is navigated. */ - navigation?(e: NavigationEventArgs): void; + navigation? (e: NavigationEventArgs): void; /** Triggers every time before the elements of the scheduler such as work cells, time cells or header cells and so on renders or re-renders on a page. */ - queryCellInfo?(e: QueryCellInfoEventArgs): void; + queryCellInfo? (e: QueryCellInfoEventArgs): void; /** Triggers when the reminder is raised for an appointment based on the alertBefore value. */ - reminder?(e: ReminderEventArgs): void; + reminder? (e: ReminderEventArgs): void; /** Triggers while resizing the appointment. */ - resize?(e: ResizeEventArgs): void; + resize? (e: ResizeEventArgs): void; /** Triggers when the appointment resizing begins. */ - resizeStart?(e: ResizeStartEventArgs): void; + resizeStart? (e: ResizeStartEventArgs): void; /** Triggers when an appointment resizing stops. */ - resizeStop?(e: ResizeStopEventArgs): void; + resizeStop? (e: ResizeStopEventArgs): void; /** Triggers when the overflow button is clicked. */ - overflowButtonClick?(e: OverflowButtonClickEventArgs): void; + overflowButtonClick? (e: OverflowButtonClickEventArgs): void; /** Triggers while mouse hovering on the overflow button. */ - overflowButtonHover?(e: OverflowButtonHoverEventArgs): void; + overflowButtonHover? (e: OverflowButtonHoverEventArgs): void; /** Triggers when any of the keyboard keys are pressed. */ - keyDown?(e: KeyDownEventArgs): void; + keyDown? (e: KeyDownEventArgs): void; /** Triggers after the new appointment is saved. */ - appointmentCreated?(e: AppointmentCreatedEventArgs): void; + appointmentCreated? (e: AppointmentCreatedEventArgs): void; /** Triggers after an existing appointment is edited. */ - appointmentChanged?(e: AppointmentChangedEventArgs): void; + appointmentChanged? (e: AppointmentChangedEventArgs): void; /** Triggers after the appointment is deleted. */ - appointmentRemoved?(e: AppointmentRemovedEventArgs): void; + appointmentRemoved? (e: AppointmentRemovedEventArgs): void; } export interface ActionBeginEventArgs { @@ -31502,7 +31529,7 @@ export interface ResizeStopEventArgs { export interface OverflowButtonClickEventArgs { - /** Returns the object consisting of start time, end time and resource value of the underlying cell on which the clicked overflow button is present. + /** Returns the object consisting of start time, end time and resource value of the underlying cell on which the clicked overflow button is present. */ object?: any; @@ -31525,7 +31552,7 @@ export interface OverflowButtonClickEventArgs { export interface OverflowButtonHoverEventArgs { - /** Returns the object consisting of start time, end time and resource value of the underlying cell on which the overflow button is currently hovered. + /** Returns the object consisting of start time, end time and resource value of the underlying cell on which the overflow button is currently hovered. */ object?: any; @@ -31627,7 +31654,7 @@ export interface AppointmentSettings { /** The dataSource option accepts either JSON object collection or DataManager (ej.DataManager) instance that contains Schedule appointments. * @Default {[]} */ - dataSource?: any|any[]; + dataSource?: any|Array; /** It holds either the ej.Query() object or simply the query string that retrieves the specified records from the table. * @Default {null} @@ -31704,14 +31731,12 @@ export interface AppointmentSettings { */ priority?: string; - /** Binds the name of start timezone field in dataSource. It indicates the timezone of appointment start date. When startTimeZone field is not mentioned, - * the appointment uses the Schedule timeZone or System timeZone. + /** Binds the name of start timezone field in dataSource. It indicates the timezone of appointment start date. When startTimeZone field is not mentioned, the appointment uses the Schedule timeZone or System timeZone. * @Default {null} */ startTimeZone?: string; - /** Binds the name of end timezone field in dataSource. It indicates the timezone of appointment end date. When the endTimeZone field is not mentioned, - * the appointment uses the Schedule timeZone or System timeZone. + /** Binds the name of end timezone field in dataSource. It indicates the timezone of appointment end date. When the endTimeZone field is not mentioned, the appointment uses the Schedule timeZone or System timeZone. * @Default {null} */ endTimeZone?: string; @@ -31731,7 +31756,7 @@ export interface CategorizeSettings { /** The dataSource option accepts either the JSON object collection or DataManager [ej.DataManager] instance that contains the categorize data. */ - dataSource?: any[]|any; + dataSource?: Array|any; /** Binds id field name in the dataSource to id of category data. * @Default {id} @@ -31758,11 +31783,11 @@ export interface ContextMenuSettingsMenuItems { /** All the appointment related context menu items are grouped under this appointment menu collection. */ - appointment?: any[]; + appointment?: Array; /** All the Scheduler cell related context menu items are grouped under this cells menu item collection. */ - cells?: any[]; + cells?: Array; } export interface ContextMenuSettings { @@ -31781,7 +31806,7 @@ export interface Group { /** Holds the array of resource names to be grouped on the Schedule. */ - resources?: any[]; + resources?: Array; } export interface WorkHours { @@ -31812,7 +31837,7 @@ export interface PrioritySettings { /** The dataSource option can accept the JSON object collection that contains the priority related data. * @Default {{% highlight js%}[{ text: None, value: none },{ text: High, value: high },{ text: Medium, value: medium },{ text: Low, value: low }]{% endhighlight %}} */ - dataSource?: any|any[]; + dataSource?: any|Array; /** Binds text field name in the dataSource to prioritySettings text. These text gets listed out in priority field of the appointment window. * @Default {text} @@ -31861,7 +31886,7 @@ export interface ResourcesResourceSettings { /** The dataSource option accepts either JSON object collection or DataManager (ejDataManager) instance that contains the resources related data. * @Default {[]} */ - dataSource?: any|any[]; + dataSource?: any|Array; /** Binds text field name in the dataSource to resourceSettings text. These text gets listed out in resources field of the appointment window. * @Default {null} @@ -31893,8 +31918,7 @@ export interface ResourcesResourceSettings { */ end?: string; - /** Binds the resources working days field name in the dataSource. It's optional, and accepts the array of strings (week day names). When provided with specific collection of - * days (array of day names), only those days will render for the specific resources. + /** Binds the resources working days field name in the dataSource. It's optional, and accepts the array of strings (week day names). When provided with specific collection of days (array of day names), only those days will render for the specific resources. * @Default {null} */ workWeek?: string; @@ -31979,8 +32003,7 @@ export interface TooltipSettings { */ enable?: boolean; - /** Template design that customizes the tooltip. All the field names that are mapped from dataSource to the appropriate field properties within - * the appointmentSettings can be accessed within the template. + /** Template design that customizes the tooltip. All the field names that are mapped from dataSource to the appropriate field properties within the appointmentSettings can be accessed within the template. * @Default {null} */ templateId?: string; @@ -32021,8 +32044,7 @@ export interface BlockoutSettings { */ enable?: boolean; - /** Template design that applies on the Schedule block intervals. All the field names that are mapped from dataSource to the appropriate field - * properties within the blockoutSettings can be used within the template. + /** Template design that applies on the Schedule block intervals. All the field names that are mapped from dataSource to the appropriate field properties within the blockoutSettings can be used within the template. * @Default {null} */ templateId?: string; @@ -32030,7 +32052,7 @@ export interface BlockoutSettings { /** The dataSource option accepts either JSON object collection or DataManager (ej.DataManager) instance that contains Schedule block intervals. * @Default {[]} */ - dataSource?: any|any[]; + dataSource?: any|Array; /** It holds either the ej.Query() object or simply the query string that retrieves the specified records from the table. * @Default {null} @@ -32083,7 +32105,7 @@ export interface BlockoutSettings { customStyle?: string; } -enum CurrentView { +enum CurrentView{ ///Sets currentView of the Scheduler as Day Day, @@ -32105,7 +32127,7 @@ enum CurrentView { } -enum Orientation { +enum Orientation{ ///Set orientation as vertical to Scheduler Vertical, @@ -32115,7 +32137,7 @@ enum Orientation { } -enum TimeMode { +enum TimeMode{ ///Sets 12 hour time mode to Scheduler Hour12, @@ -32128,15 +32150,16 @@ enum TimeMode { class RecurrenceEditor extends ej.Widget { static fn: RecurrenceEditor; - constructor(element: JQuery | Element, options?: RecurrenceEditor.Model); + constructor(element: JQuery, options?: RecurrenceEditor.Model); + constructor(element: Element, options?: RecurrenceEditor.Model); static Locale: any; - model: RecurrenceEditor.Model; - defaults: RecurrenceEditor.Model; + model:RecurrenceEditor.Model; + defaults:RecurrenceEditor.Model; /** Generates the recurrence rule with the options selected within the Recurrence Editor. * @returns {String} */ - getRecurrenceRule(): string; + getRecurrenceRule(): String; /** Generates the collection of date, that lies within the selected recurrence start and end date for which the recurrence pattern applies. * @param {string} It refers the recurrence rule. @@ -32152,14 +32175,14 @@ class RecurrenceEditor extends ej.Widget { */ recurrenceRuleSplit(recurrenceRule: string, exDate: any): any; } -export namespace RecurrenceEditor { +export module RecurrenceEditor{ export interface Model { /** Defines the collection of recurrence frequencies within Recurrence Editor such as Never, Daily, Weekly, Monthly, Yearly and Every Weekday. * @Default {[never, daily, weekly, monthly, yearly, everyweekday]} */ - frequencies?: any[]; + frequencies?: Array; /** Sets the starting day of the week. * @Default {null} @@ -32190,20 +32213,17 @@ export interface Model { */ enableRTL?: boolean; - /** Sets the active/current repeat type(frequency) on Recurrence Editor based on the index value provided. For example, setting the value 1 will initially set the repeat type - * as Daily and display its related options. + /** Sets the active/current repeat type(frequency) on Recurrence Editor based on the index value provided. For example, setting the value 1 will initially set the repeat type as Daily and display its related options. * @Default {0} */ selectedRecurrenceType?: number; - /** Sets the minimum date limit to display on the datepickers defined within the Recurrence Editor. Setting minDate with specific date value disallows the datepickers within - * Recurrence Editor to navigate beyond that date. + /** Sets the minimum date limit to display on the datepickers defined within the Recurrence Editor. Setting minDate with specific date value disallows the datepickers within Recurrence Editor to navigate beyond that date. * @Default {new Date(1900, 01, 01)} */ minDate?: any; - /** Sets the maximum date limit to display on the datepickers used within the Recurrence Editor. Setting maxDate with specific date value disallows the - * datepickers within the Recurrence Editor to navigate beyond that date. + /** Sets the maximum date limit to display on the datepickers used within the Recurrence Editor. Setting maxDate with specific date value disallows the datepickers within the Recurrence Editor to navigate beyond that date. * @Default {new Date(2099, 12, 31)} */ maxDate?: any; @@ -32213,7 +32233,7 @@ export interface Model { cssClass?: string; /** Triggers whenever any of the Recurrence Editor's value is changed. */ - change?(e: ChangeEventArgs): void; + change? (e: ChangeEventArgs): void; } export interface ChangeEventArgs { @@ -32238,10 +32258,11 @@ export interface ChangeEventArgs { class Gantt extends ej.Widget { static fn: Gantt; - constructor(element: JQuery | Element, options?: Gantt.Model); + constructor(element: JQuery, options?: Gantt.Model); + constructor(element: Element, options?: Gantt.Model); static Locale: any; - model: Gantt.Model; - defaults: Gantt.Model; + model:Gantt.Model; + defaults:Gantt.Model; /** To add a new item in Gantt * @param {any} Item to add in Gantt row. @@ -32255,7 +32276,7 @@ class Gantt extends ej.Widget { * @param {boolean} Defines that we need to preserve the previously selected cells of not * @returns {void} */ - selectCells(Indexes: any[], preservePreviousSelectedCell: boolean): void; + selectCells(Indexes: Array, preservePreviousSelectedCell: boolean): void; /** Positions the splitter by the specified column index. * @param {number} Set the splitter position based on column index. @@ -32343,14 +32364,14 @@ class Gantt extends ej.Widget { */ showColumn(headerText: string): void; } -export namespace Gantt { +export module Gantt{ export interface Model { /** Specifies the fields to be included in the add dialog in Gantt * @Default {[]} */ - addDialogFields?: any[]; + addDialogFields?: Array; /** Enables or disables the ability to resize column. * @Default {false} @@ -32417,7 +32438,7 @@ export interface Model { /** To Specify the column fields to be displayed in the dialog while inserting a column using column menu. * @Default {[]} */ - columnDialogFields?: any[]; + columnDialogFields?: Array; /** Specifies the background of connector lines in Gantt */ @@ -32444,7 +32465,7 @@ export interface Model { /** Collection of data or hierarchical data to represent in Gantt * @Default {null} */ - dataSource?: any[]; + dataSource?: Array; /** Specifies the dateFormat for Gantt , given format is displayed in tooltip , Grid . * @Default {MM/dd/yyyy} @@ -32463,7 +32484,7 @@ export interface Model { /** Specifies the fields to be included in the edit dialog in Gantt * @Default {[]} */ - editDialogFields?: any[]; + editDialogFields?: Array; /** Enables or disables the responsiveness of Gantt * @Default {false} @@ -32556,7 +32577,7 @@ export interface Model { /** Collection of holidays with date, background and label information to be displayed in Gantt. * @Default {[]} */ - holidays?: any[]; + holidays?: Array; /** Specifies whether to include weekends while calculating the duration of a task. * @Default {true} @@ -32687,7 +32708,7 @@ export interface Model { /** Collection of data regarding resources involved in entire project * @Default {[]} */ - resources?: any[]; + resources?: Array; /** Specifies whether rounding off the day working time edits * @Default {true} @@ -32754,7 +32775,7 @@ export interface Model { /** Specifies the selected cell information on rendering Gantt. */ - selectedCellIndexes?: SelectedCellIndex[]; + selectedCellIndexes?: Array; /** Specifies the sorting options for Gantt. */ @@ -32772,7 +32793,7 @@ export interface Model { /** Specifies the options for striplines * @Default {[]} */ - stripLines?: any[]; + stripLines?: Array; /** Specifies the background of the taskbar in Gantt */ @@ -32840,79 +32861,79 @@ export interface Model { workingTimeScale?: ej.Gantt.workingTimeScale|string; /** Triggered for every Gantt action before its starts. */ - actionBegin?(e: ActionBeginEventArgs): void; + actionBegin? (e: ActionBeginEventArgs): void; /** Triggered for every Gantt action success event. */ - actionComplete?(e: ActionCompleteEventArgs): void; + actionComplete? (e: ActionCompleteEventArgs): void; /** Triggered while enter the edit mode in the TreeGrid cell */ - beginEdit?(e: BeginEditEventArgs): void; + beginEdit? (e: BeginEditEventArgs): void; /** Triggered before selecting a cell */ - cellSelecting?(e: CellSelectingEventArgs): void; + cellSelecting? (e: CellSelectingEventArgs): void; /** Triggered after selected a cell */ - cellSelected?(e: CellSelectedEventArgs): void; + cellSelected? (e: CellSelectedEventArgs): void; /** Triggered while dragging a row in Gantt control */ - rowDrag?(e: RowDragEventArgs): void; + rowDrag? (e: RowDragEventArgs): void; /** Triggered while start to drag row in Gantt control */ - rowDragStart?(e: RowDragStartEventArgs): void; + rowDragStart? (e: RowDragStartEventArgs): void; /** Triggered while drop a row in Gantt control */ - rowDragStop?(e: RowDragStopEventArgs): void; + rowDragStop? (e: RowDragStopEventArgs): void; /** Triggered after collapsed the Gantt record */ - collapsed?(e: CollapsedEventArgs): void; + collapsed? (e: CollapsedEventArgs): void; /** Triggered while collapsing the Gantt record */ - collapsing?(e: CollapsingEventArgs): void; + collapsing? (e: CollapsingEventArgs): void; /** Triggered while Context Menu is rendered in Gantt control */ - contextMenuOpen?(e: ContextMenuOpenEventArgs): void; + contextMenuOpen? (e: ContextMenuOpenEventArgs): void; /** Triggered when Gantt is rendered completely. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Triggered after save the modified cellValue in Gantt. */ - endEdit?(e: EndEditEventArgs): void; + endEdit? (e: EndEditEventArgs): void; /** Triggered after expand the record */ - expanded?(e: ExpandedEventArgs): void; + expanded? (e: ExpandedEventArgs): void; /** Triggered while expanding the Gantt record */ - expanding?(e: ExpandingEventArgs): void; + expanding? (e: ExpandingEventArgs): void; /** Triggered while Gantt is loaded */ - load?(e: LoadEventArgs): void; + load? (e: LoadEventArgs): void; /** Triggered while rendering each cell in the TreeGrid */ - queryCellInfo?(e: QueryCellInfoEventArgs): void; + queryCellInfo? (e: QueryCellInfoEventArgs): void; /** Triggered while rendering each taskbar in the Gantt */ - queryTaskbarInfo?(e: QueryTaskbarInfoEventArgs): void; + queryTaskbarInfo? (e: QueryTaskbarInfoEventArgs): void; /** Triggered while rendering each row */ - rowDataBound?(e: RowDataBoundEventArgs): void; + rowDataBound? (e: RowDataBoundEventArgs): void; /** Triggered after the row is selected. */ - rowSelected?(e: RowSelectedEventArgs): void; + rowSelected? (e: RowSelectedEventArgs): void; /** Triggered before the row is going to be selected. */ - rowSelecting?(e: RowSelectingEventArgs): void; + rowSelecting? (e: RowSelectingEventArgs): void; /** Triggered after completing the editing operation in taskbar */ - taskbarEdited?(e: TaskbarEditedEventArgs): void; + taskbarEdited? (e: TaskbarEditedEventArgs): void; /** Triggered while editing the Gantt chart (dragging, resizing the taskbar ) */ - taskbarEditing?(e: TaskbarEditingEventArgs): void; + taskbarEditing? (e: TaskbarEditingEventArgs): void; /** Triggered when taskbar item is clicked in Gantt. */ - taskbarClick?(e: TaskbarClickEventArgs): void; + taskbarClick? (e: TaskbarClickEventArgs): void; /** Triggered when toolbar item is clicked in Gantt. */ - toolbarClick?(e: ToolbarClickEventArgs): void; + toolbarClick? (e: ToolbarClickEventArgs): void; } export interface ActionBeginEventArgs { @@ -33249,7 +33270,7 @@ export interface ContextMenuOpenEventArgs { /** Returns the default context menu items to which we add custom items. */ - contextMenuItems?: any[]; + contextMenuItems?: Array; /** Returns the Gantt model. */ @@ -33608,7 +33629,7 @@ export interface DragTooltip { /** Specifies the data source fields to be displayed in the drag tooltip. * @Default {[]} */ - tooltipItems?: any[]; + tooltipItems?: Array; /** Specifies the custom template for drag tooltip. * @Default {null} @@ -33758,7 +33779,7 @@ export interface SortSettings { /** Specifies the sorted columns for Gantt * @Default {[]} */ - sortedColumns?: any[]; + sortedColumns?: Array; } export interface ToolbarSettings { @@ -33771,10 +33792,10 @@ export interface ToolbarSettings { /** Specifies the list of toolbar items to be rendered in Gantt toolbar * @Default {[]} */ - toolbarItems?: any[]; + toolbarItems?: Array; } -enum DurationUnit { +enum DurationUnit{ ///Sets the Duration Unit as day. Day, @@ -33787,7 +33808,7 @@ enum DurationUnit { } -enum BeginEditAction { +enum BeginEditAction{ ///you can begin the editing at double click DblClick, @@ -33797,7 +33818,7 @@ enum BeginEditAction { } -enum RowPosition { +enum RowPosition{ ///you can add a new row at top. Top, @@ -33816,7 +33837,7 @@ enum RowPosition { } -enum TaskType { +enum TaskType{ ///Resource unit remains constant while editing the work and duration values. FixedUnit, @@ -33829,7 +33850,7 @@ enum TaskType { } -enum WorkUnit { +enum WorkUnit{ ///Displays the work involved in a task in days. Day, @@ -33842,7 +33863,7 @@ enum WorkUnit { } -enum TaskSchedulingMode { +enum TaskSchedulingMode{ ///All the tasks in the project will be displayed in auto scheduled mode, where the tasks are scheduled automatically over non-working days and holidays. Auto, @@ -33855,7 +33876,7 @@ enum TaskSchedulingMode { } -enum SelectionType { +enum SelectionType{ ///you can select a single row. Single, @@ -33865,7 +33886,7 @@ enum SelectionType { } -enum minutesPerInterval { +enum minutesPerInterval{ ///Sets the interval automatically according with schedule start and end date. Auto, @@ -33884,7 +33905,7 @@ enum minutesPerInterval { } -enum ScheduleHeaderType { +enum ScheduleHeaderType{ ///Sets year Schedule Mode. Year, @@ -33903,7 +33924,7 @@ enum ScheduleHeaderType { } -enum TimescaleRoundMode { +enum TimescaleRoundMode{ ///The round-off value will be automatically calculated based on the data source values. Auto, @@ -33919,7 +33940,7 @@ enum TimescaleRoundMode { } -enum SelectionMode { +enum SelectionMode{ ///you can select a row. Row, @@ -33929,7 +33950,7 @@ enum SelectionMode { } -enum workingTimeScale { +enum workingTimeScale{ ///Sets eight hour timescale. TimeScale8Hours, @@ -33942,10 +33963,11 @@ enum workingTimeScale { class ReportViewer extends ej.Widget { static fn: ReportViewer; - constructor(element: JQuery | Element, options?: ReportViewer.Model); + constructor(element: JQuery, options?: ReportViewer.Model); + constructor(element: Element, options?: ReportViewer.Model); static Locale: any; - model: ReportViewer.Model; - defaults: ReportViewer.Model; + model:ReportViewer.Model; + defaults:ReportViewer.Model; /** Export the report to the specified format. * @returns {void} @@ -34017,19 +34039,19 @@ class ReportViewer extends ej.Widget { */ refresh(): void; } -export namespace ReportViewer { +export module ReportViewer{ export interface Model { /** Gets or sets the list of data sources for the RDLC report. * @Default {[]} */ - dataSources?: DataSource[]; + dataSources?: Array; /** Enables or disables the page cache of report. * @Default {false} */ - enablePageCache?: boolean; + enablePageCache?: Boolean; /** Specifies the export settings. */ @@ -34038,12 +34060,12 @@ export interface Model { /** When set to true, adapts the report layout to fit the screen size of devices on which it renders. * @Default {true} */ - isResponsive?: boolean; + isResponsive?: Boolean; /** Specifies the locale for report viewer. * @Default {en-US} */ - locale?: string; + locale?: String; /** Specifies the page settings. */ @@ -34052,12 +34074,12 @@ export interface Model { /** Gets or sets the list of parameters associated with the report. * @Default {[]} */ - parameters?: Parameter[]; + parameters?: Array; /** Enables and disables the print mode. * @Default {false} */ - printMode?: boolean; + printMode?: Boolean; /** Specifies the print option of the report. * @Default {ej.ReportViewer.PrintOptions.Default} @@ -34077,17 +34099,17 @@ export interface Model { /** Gets or sets the path of the report file. * @Default {empty} */ - reportPath?: string; + reportPath?: String; /** Gets or sets the reports server URL. * @Default {empty} */ - reportServerUrl?: string; + reportServerUrl?: String; /** Specifies the report Web API service URL. * @Default {empty} */ - reportServiceUrl?: string; + reportServiceUrl?: String; /** Specifies the toolbar settings. */ @@ -34096,31 +34118,31 @@ export interface Model { /** Gets or sets the zoom factor for report viewer. * @Default {1} */ - zoomFactor?: number; + zoomFactor?: Number; /** Fires when the report viewer is destroyed successfully.If you want to perform any operation after destroying the reportviewer control,you can make use of the destroy event. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Fires during drill through action done in report.If you want to perform any operation when a drill through action is performed, you can make use of the drillThrough event. */ - drillThrough?(e: DrillThroughEventArgs): void; + drillThrough? (e: DrillThroughEventArgs): void; /** Fires before report rendering is completed.If you want to perform any operation before the rendering of report,you can make use of the renderingBegin event. */ - renderingBegin?(e: RenderingBeginEventArgs): void; + renderingBegin? (e: RenderingBeginEventArgs): void; /** Fires after report rendering completed.If you want to perform any operation after the rendering of report,you can make use of this renderingComplete event. */ - renderingComplete?(e: RenderingCompleteEventArgs): void; + renderingComplete? (e: RenderingCompleteEventArgs): void; /** Fires when any error occurred while rendering the report.If you want to perform any operation when an error occurs in the report, you can make use of the reportError event. */ - reportError?(e: ReportErrorEventArgs): void; + reportError? (e: ReportErrorEventArgs): void; /** Fires when the report is being exported.If you want to perform any operation before exporting of report, you can make use of the reportExport event. */ - reportExport?(e: ReportExportEventArgs): void; + reportExport? (e: ReportExportEventArgs): void; /** Fires when the report is loaded.If you want to perform any operation after the successful loading of report, you can make use of the reportLoaded event. */ - reportLoaded?(e: ReportLoadedEventArgs): void; + reportLoaded? (e: ReportLoadedEventArgs): void; /** Fires when click the View Report Button. */ - viewReportClick?(e: ViewReportClickEventArgs): void; + viewReportClick? (e: ViewReportClickEventArgs): void; } export interface DestroyEventArgs { @@ -34264,12 +34286,12 @@ export interface DataSource { /** Gets or sets the name of the data source. * @Default {empty} */ - name?: string; + name?: String; /** Gets or sets the values of data source. * @Default {[]} */ - values?: any[]; + values?: Array; } export interface ExportSettings { @@ -34308,27 +34330,27 @@ export interface Parameter { /** Gets or sets the parameter labels. * @Default {null} */ - labels?: any[]; + labels?: Array; /** Gets or sets the name of the parameter. * @Default {empty} */ - name?: string; + name?: String; /** Gets or sets whether the parameter allows nullable value or not. * @Default {false} */ - nullable?: boolean; + nullable?: Boolean; /** Gets or sets the prompt message associated with the specified parameter. * @Default {empty} */ - prompt?: string; + prompt?: String; /** Gets or sets the parameter values. * @Default {[]} */ - values?: any[]; + values?: Array; } export interface ToolbarSettings { @@ -34336,7 +34358,7 @@ export interface ToolbarSettings { /** Fires when user click on toolbar item in the toolbar. * @Default {empty} */ - click?: string; + click?: String; /** Specifies the toolbar items. * @Default {ej.ReportViewer.ToolbarItems.All} @@ -34346,20 +34368,20 @@ export interface ToolbarSettings { /** Shows or hides the toolbar. * @Default {true} */ - showToolbar?: boolean; + showToolbar?: Boolean; /** Shows or hides the tooltip of toolbar items. * @Default {true} */ - showTooltip?: boolean; + showTooltip?: Boolean; /** Specifies the toolbar template ID. * @Default {empty} */ - templateId?: string; + templateId?: String; } -enum ExportOptions { +enum ExportOptions{ ///Specifies the All property in ExportOptions to get all available options. All, @@ -34378,7 +34400,7 @@ enum ExportOptions { } -enum ExcelFormats { +enum ExcelFormats{ ///Specifies the Excel97to2003 property in ExcelFormats to get specified version of exported format. Excel97to2003, @@ -34394,7 +34416,7 @@ enum ExcelFormats { } -enum WordFormats { +enum WordFormats{ ///Specifies the Doc property in WordFormats to get specified version of exported format. Doc, @@ -34461,7 +34483,7 @@ enum WordFormats { } -enum Orientation { +enum Orientation{ ///Specifies the Landscape property in pageSettings.orientation to get specified layout. Landscape, @@ -34471,7 +34493,7 @@ enum Orientation { } -enum PaperSize { +enum PaperSize{ ///Specifies the A3 as value in pageSettings.paperSize to get specified size. A3, @@ -34508,7 +34530,7 @@ enum PaperSize { } -enum PrintOptions { +enum PrintOptions{ ///Specifies the Default property in printOptions. Default, @@ -34521,7 +34543,7 @@ enum PrintOptions { } -enum ProcessingMode { +enum ProcessingMode{ ///Specifies the Remote property in processingMode. Remote, @@ -34531,7 +34553,7 @@ enum ProcessingMode { } -enum RenderMode { +enum RenderMode{ ///Specifies the Default property in RenderMode to get default output. Default, @@ -34544,7 +34566,7 @@ enum RenderMode { } -enum ToolbarItems { +enum ToolbarItems{ ///Specifies the Print as value in ToolbarItems to get specified item. Print, @@ -34578,10 +34600,11 @@ enum ToolbarItems { class TreeGrid extends ej.Widget { static fn: TreeGrid; - constructor(element: JQuery | Element, options?: TreeGrid.Model); + constructor(element: JQuery, options?: TreeGrid.Model); + constructor(element: Element, options?: TreeGrid.Model); static Locale: any; - model: TreeGrid.Model; - defaults: TreeGrid.Model; + model:TreeGrid.Model; + defaults:TreeGrid.Model; /** Add a new row in TreeGrid, while allowAdding is set to true * @param {any} Item to add in TreeGrid row. @@ -34601,11 +34624,11 @@ class TreeGrid extends ej.Widget { * @param {boolean} Defines that we need to preserve the previously selected cells or not * @returns {void} */ - selectCells(Indexes: any[], preservePreviousSelectedCell: boolean): void; + selectCells(Indexes: Array, preservePreviousSelectedCell: boolean): void; /** To rename a column with the specified name * @param {number} Index of the column to be renamed - * @param {string} Header text of the column + * @param {string} Header text of the column * @returns {void} */ renameColumn(columnIndex: number, name: string): void; @@ -34644,7 +34667,7 @@ class TreeGrid extends ej.Widget { * @param {any} Pass which data you want to show in tree grid * @returns {void} */ - refresh(dataSource: any[], query: any): void; + refresh(dataSource: Array, query: any): void; /** Freeze all the columns preceding to the column specified by the field name. * @param {string} Freeze all Columns before this field column. @@ -34690,7 +34713,7 @@ class TreeGrid extends ej.Widget { */ reorderColumn(fieldName: string, targetIndex: string): void; } -export namespace TreeGrid { +export module TreeGrid{ export interface Model { @@ -34709,8 +34732,7 @@ export interface Model { */ allowDragAndDrop?: boolean; - /** Enables or disables the ability to filter the data on all the columns. Enabling this property will display a row with editor controls corresponding to each column. - * You can restrict filtering on particular column by disabling this property directly on that column instance itself. + /** Enables or disables the ability to filter the data on all the columns. Enabling this property will display a row with editor controls corresponding to each column. You can restrict filtering on particular column by disabling this property directly on that column instance itself. * @Default {false} */ allowFiltering?: boolean; @@ -34750,12 +34772,12 @@ export interface Model { /** Option for adding columns; each column has the option to bind to a field in the dataSource. */ - columns?: Column[]; + columns?: Array; /** To Specify the column fields to be displayed in the dialog while inserting a column using column menu. * @Default {[]} */ - columnDialogFields?: any[]; + columnDialogFields?: Array; /** Options for displaying and customizing context menu items. */ @@ -34768,7 +34790,7 @@ export interface Model { /** Specifies hierarchical or self-referential data to populate the TreeGrid. * @Default {null} */ - dataSource?: any[]; + dataSource?: Array; /** Specifies whether to wrap the header text when it is overflown i.e., when it exceeds the header width. * @Default {none} @@ -34871,8 +34893,7 @@ export interface Model { */ showColumnOptions?: boolean; - /** Controls the visibility of the menu button, which is displayed on the column header. Clicking on this button will show a popup menu. When you choose Columns item from this popup, - * a list box with column names will be shown, from which you can select/deselect a column name to control the visibility of the respective columns. + /** Controls the visibility of the menu button, which is displayed on the column header. Clicking on this button will show a popup menu. When you choose Columns item from this popup, a list box with column names will be shown, from which you can select/deselect a column name to control the visibility of the respective columns. * @Default {false} */ showColumnChooser?: boolean; @@ -34909,7 +34930,7 @@ export interface Model { /** Specifies the summary row collection object to be displayed * @Default {[]} */ - summaryRows?: any[]; + summaryRows?: Array; /** Specifies whether to show tooltip when mouse is hovered on the cell. * @Default {true} @@ -34939,88 +34960,88 @@ export interface Model { treeColumnIndex?: number; /** Triggered before every success event of TreeGrid action. */ - actionBegin?(e: ActionBeginEventArgs): void; + actionBegin? (e: ActionBeginEventArgs): void; /** Triggered for every TreeGrid action success event. */ - actionComplete?(e: ActionCompleteEventArgs): void; + actionComplete? (e: ActionCompleteEventArgs): void; /** Triggered while enter the edit mode in the TreeGrid cell */ - beginEdit?(e: BeginEditEventArgs): void; + beginEdit? (e: BeginEditEventArgs): void; /** Triggered after collapsed the TreeGrid record */ - collapsed?(e: CollapsedEventArgs): void; + collapsed? (e: CollapsedEventArgs): void; /** Triggered while collapsing the TreeGrid record */ - collapsing?(e: CollapsingEventArgs): void; + collapsing? (e: CollapsingEventArgs): void; /** Triggered while clicking a row, even when allowSelection property is disabled. */ - recordClick?(e: RecordClickEventArgs): void; + recordClick? (e: RecordClickEventArgs): void; /** Triggered when you start to drag a column */ - columnDragStart?(e: ColumnDragStartEventArgs): void; + columnDragStart? (e: ColumnDragStartEventArgs): void; /** Triggered while dragging a column */ - columnDrag?(e: ColumnDragEventArgs): void; + columnDrag? (e: ColumnDragEventArgs): void; /** Triggered when a column is dropped */ - columnDrop?(e: ColumnDropEventArgs): void; + columnDrop? (e: ColumnDropEventArgs): void; /** Triggered after a column resized */ - columnResized?(e: ColumnResizedEventArgs): void; + columnResized? (e: ColumnResizedEventArgs): void; /** Triggered while start to resize a column */ - columnResizeStart?(e: ColumnResizeStartEventArgs): void; + columnResizeStart? (e: ColumnResizeStartEventArgs): void; /** Triggered when a column has been resized */ - columnResizeEnd?(e: ColumnResizeEndEventArgs): void; + columnResizeEnd? (e: ColumnResizeEndEventArgs): void; /** Triggered while Context Menu is rendered in TreeGrid control */ - contextMenuOpen?(e: ContextMenuOpenEventArgs): void; + contextMenuOpen? (e: ContextMenuOpenEventArgs): void; /** Triggered when TreeGrid is rendered completely */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Triggered after saved the modified cellValue in TreeGrid */ - endEdit?(e: EndEditEventArgs): void; + endEdit? (e: EndEditEventArgs): void; /** Triggered after expand the record */ - expanded?(e: ExpandedEventArgs): void; + expanded? (e: ExpandedEventArgs): void; /** Triggered while expanding the TreeGrid record */ - expanding?(e: ExpandingEventArgs): void; + expanding? (e: ExpandingEventArgs): void; /** Triggered while Treegrid is loaded */ - load?(e: LoadEventArgs): void; + load? (e: LoadEventArgs): void; /** Triggered while rendering each cell in the TreeGrid */ - queryCellInfo?(e: QueryCellInfoEventArgs): void; + queryCellInfo? (e: QueryCellInfoEventArgs): void; /** Triggered while rendering each row */ - rowDataBound?(e: RowDataBoundEventArgs): void; + rowDataBound? (e: RowDataBoundEventArgs): void; /** Triggered while dragging a row in TreeGrid control */ - rowDrag?(e: RowDragEventArgs): void; + rowDrag? (e: RowDragEventArgs): void; /** Triggered while start to drag row in TreeGrid control */ - rowDragStart?(e: RowDragStartEventArgs): void; + rowDragStart? (e: RowDragStartEventArgs): void; /** Triggered while drop a row in TreeGrid control */ - rowDragStop?(e: RowDragStopEventArgs): void; + rowDragStop? (e: RowDragStopEventArgs): void; /** Triggered before selecting a cell */ - cellSelecting?(e: CellSelectingEventArgs): void; + cellSelecting? (e: CellSelectingEventArgs): void; /** Triggered after selected a cell */ - cellSelected?(e: CellSelectedEventArgs): void; + cellSelected? (e: CellSelectedEventArgs): void; /** Triggered after the row is selected. */ - rowSelected?(e: RowSelectedEventArgs): void; + rowSelected? (e: RowSelectedEventArgs): void; /** Triggered before the row is going to be selected. */ - rowSelecting?(e: RowSelectingEventArgs): void; + rowSelecting? (e: RowSelectingEventArgs): void; /** Triggered when toolbar item is clicked in TreeGrid. */ - toolbarClick?(e: ToolbarClickEventArgs): void; + toolbarClick? (e: ToolbarClickEventArgs): void; } export interface ActionBeginEventArgs { @@ -35399,7 +35420,7 @@ export interface ContextMenuOpenEventArgs { /** Returns the default context menu items to which we add custom items. */ - contextMenuItems?: any[]; + contextMenuItems?: Array; /** Returns the TreeGrid model. */ @@ -35867,11 +35888,11 @@ export interface Column { /** Gets or sets a value for treegrid column width */ - width?: number; + width?: Number; /** Specifies the header template value for the column header */ - headerTemplateID?: string; + headerTemplateID?: String; /** Specifies the display format of a column * @Default {null} @@ -35900,7 +35921,7 @@ export interface Column { /** Specifies the template for the TreeGrid column */ - templateID?: string; + templateID?: String; /** Enables or disables the ability to edit a row or cell. * @Default {false} @@ -35918,7 +35939,7 @@ export interface ContextMenuSettings { /** Option for adding items to context menu. * @Default {[]} */ - contextMenuItems?: any[]; + contextMenuItems?: Array; /** Shows/hides the context menu. * @Default {false} @@ -35936,7 +35957,7 @@ export interface DragTooltip { /** Option to add field names whose corresponding values in the dragged row needs to be shown in the preview tooltip. * @Default {[]} */ - tooltipItems?: any[]; + tooltipItems?: Array; /** Custom template for that tooltip that is shown while dragging a row. * @Default {null} @@ -36000,7 +36021,7 @@ export interface FilterSettings { /** Specifies the column collection for filtering the TreeGrid content on initial load * @Default {[]} */ - filteredColumns?: any[]; + filteredColumns?: Array; } export interface PageSettings { @@ -36077,7 +36098,7 @@ export interface SortSettings { /** Option to add columns based on which the rows have to be sorted recursively. * @Default {[]} */ - sortedColumns?: any[]; + sortedColumns?: Array; } export interface ToolbarSettings { @@ -36090,10 +36111,10 @@ export interface ToolbarSettings { /** Specifies the list of toolbar items to be rendered in TreeGrid toolbar * @Default {[]} */ - toolbarItems?: any[]; + toolbarItems?: Array; } -enum EditingType { +enum EditingType{ ///It Specifies String edit type. String, @@ -36118,7 +36139,7 @@ enum EditingType { } -enum BeginEditAction { +enum BeginEditAction{ ///you can begin the editing at double click DblClick, @@ -36128,7 +36149,7 @@ enum BeginEditAction { } -enum EditMode { +enum EditMode{ ///you can edit a cell. CellEditing, @@ -36138,7 +36159,7 @@ enum EditMode { } -enum RowPosition { +enum RowPosition{ ///you can add a new row at top. Top, @@ -36157,7 +36178,7 @@ enum RowPosition { } -enum PageSizeMode { +enum PageSizeMode{ ///To count all the parent and child records. All, @@ -36167,7 +36188,7 @@ enum PageSizeMode { } -enum SelectionMode { +enum SelectionMode{ ///you can select a row. Row, @@ -36177,7 +36198,7 @@ enum SelectionMode { } -enum SelectionType { +enum SelectionType{ ///you can select a single row. Single, @@ -36193,10 +36214,11 @@ enum SelectionType { class GroupButton extends ej.Widget { static fn: GroupButton; - constructor(element: JQuery | Element, options?: GroupButton.Model); + constructor(element: JQuery, options?: GroupButton.Model); + constructor(element: Element, options?: GroupButton.Model); static Locale: any; - model: GroupButton.Model; - defaults: GroupButton.Model; + model:GroupButton.Model; + defaults:GroupButton.Model; /** Remove the selection state of the specified the button element from the GroupButton * @param {JQuery} Specific button element @@ -36280,7 +36302,7 @@ class GroupButton extends ej.Widget { */ showItem(element: JQuery): void; } -export namespace GroupButton { +export module GroupButton{ export interface Model { @@ -36333,7 +36355,7 @@ export interface Model { */ query?: any; - /** Sets the list of button elements to be selected. To enable this option groupButtonMode should be in “checkbox†mode. + /** Sets the list of button elements to be selected. To enable this option groupButtonMode should be in Ă¢â‚¬Å“checkboxĂ¢â‚¬Â mode. * @Default {[]} */ selectedItemIndex?: number[]|string[]; @@ -36353,19 +36375,19 @@ export interface Model { width?: string|number; /** Triggered before any button element in the GroupButton get selected. */ - beforeSelect?(e: BeforeSelectEventArgs): void; + beforeSelect? (e: BeforeSelectEventArgs): void; /** Fires after GroupButton control is created.If the user want to perform any operation after the button control creation then the user can make use of this create event. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Fires when the GroupButton is destroyed successfully.If the user want to perform any operation after the destroy button control then the user can make use of this destroy event. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Triggered once the key is pressed, when the control is in focused state. */ - keyPress?(e: KeyPressEventArgs): void; + keyPress? (e: KeyPressEventArgs): void; /** Triggered when the button element get selected. */ - select?(e: SelectEventArgs): void; + select? (e: SelectEventArgs): void; } export interface BeforeSelectEventArgs { @@ -36515,19 +36537,21 @@ export interface SelectEventArgs { status?: boolean; } } -enum GroupButtonMode { -//Sets the GroupButton to work as checkbox mode +enum GroupButtonMode +{ +//Sets the GroupButton to work as checkbox mode CheckBox, -//Sets the RadioButton to work as radio button mode +//Sets the RadioButton to work as radio button mode RadioButton, } class NavigationDrawer extends ej.Widget { static fn: NavigationDrawer; - constructor(element: JQuery | Element, options?: NavigationDrawer.Model); + constructor(element: JQuery, options?: NavigationDrawer.Model); + constructor(element: Element, options?: NavigationDrawer.Model); static Locale: any; - model: NavigationDrawer.Model; - defaults: NavigationDrawer.Model; + model:NavigationDrawer.Model; + defaults:NavigationDrawer.Model; /** To close the navigation drawer control * @returns {void} @@ -36549,7 +36573,7 @@ class NavigationDrawer extends ej.Widget { */ toggle(): void; } -export namespace NavigationDrawer { +export module NavigationDrawer{ export interface Model { @@ -36563,8 +36587,7 @@ export interface Model { */ contentId?: string; - /** Sets the root class for NavigationDrawer theme. This cssClass API helps to use custom skinning option for NavigationDrawer control. - * By defining the root class using this API, we need to include this root class in CSS. + /** Sets the root class for NavigationDrawer theme. This cssClass API helps to use custom skinning option for NavigationDrawer control. By defining the root class using this API, we need to include this root class in CSS. */ cssClass?: string; @@ -36581,7 +36604,7 @@ export interface Model { /** Specifies the listview items as an array of object. * @Default {[]} */ - items?: any[]; + items?: Array; /** Sets all the properties of listview to render in navigation drawer */ @@ -36612,22 +36635,22 @@ export interface Model { isPaneOpen?: boolean; /** Event triggers after the AJAX content loaded completely. */ - ajaxComplete?(e: AjaxCompleteEventArgs): void; + ajaxComplete? (e: AjaxCompleteEventArgs): void; /** Event triggers when the AJAX request failed. */ - ajaxError?(e: AjaxErrorEventArgs): void; + ajaxError? (e: AjaxErrorEventArgs): void; /** Event triggers after the AJAX content loaded successfully. */ - ajaxSuccess?(e: AjaxSuccessEventArgs): void; + ajaxSuccess? (e: AjaxSuccessEventArgs): void; /** Event triggers before the control gets closed. */ - beforeClose?(e: BeforeCloseEventArgs): void; + beforeClose? (e: BeforeCloseEventArgs): void; /** Event triggers when the control open. */ - open?(e: OpenEventArgs): void; + open? (e: OpenEventArgs): void; /** Event triggers when the Swipe happens. */ - swipe?(e: SwipeEventArgs): void; + swipe? (e: SwipeEventArgs): void; } export interface AjaxCompleteEventArgs { @@ -36766,10 +36789,11 @@ export interface AjaxSettings { class RadialMenu extends ej.Widget { static fn: RadialMenu; - constructor(element: JQuery | Element, options?: RadialMenu.Model); + constructor(element: JQuery, options?: RadialMenu.Model); + constructor(element: Element, options?: RadialMenu.Model); static Locale: any; - model: RadialMenu.Model; - defaults: RadialMenu.Model; + model:RadialMenu.Model; + defaults:RadialMenu.Model; /** To hide the radialmenu * @returns {void} @@ -36801,7 +36825,7 @@ class RadialMenu extends ej.Widget { * @param {Array} Index of the Radialmenu to be enabled. * @returns {void} */ - enableItemsByIndices(itemIndices: any[]): void; + enableItemsByIndices(itemIndices: Array): void; /** To disable menu item using index * @param {number} Index of the Radialmenu to be disabled. @@ -36813,7 +36837,7 @@ class RadialMenu extends ej.Widget { * @param {Array} items of the Radialmenu to disable. * @returns {void} */ - disableItemsByIndices(itemIndices: any[]): void; + disableItemsByIndices(itemIndices: Array): void; /** To enable menu item using item text * @param {string} item of the Radialmenu item to enable. @@ -36831,13 +36855,13 @@ class RadialMenu extends ej.Widget { * @param {Array} items of the Radialmenu item to enable. * @returns {void} */ - enableItems(items: any[]): void; + enableItems(items: Array): void; /** To disable menu items using item texts * @param {Array} items of the Radialmenu item to disable. * @returns {void} */ - disableItems(items: any[]): void; + disableItems(items: Array): void; /** To update menu item badge value * @param {number} The index value to add the given items at the specified index. If index is not specified, the given value will not be updated. @@ -36858,7 +36882,7 @@ class RadialMenu extends ej.Widget { */ hideBadge(index: number): void; } -export namespace RadialMenu { +export module RadialMenu{ export interface Model { @@ -36870,8 +36894,7 @@ export interface Model { */ backImageClass?: string; - /** Sets the root class for RadialMenu theme. This cssClass API helps to use custom skinning option for RadialMenu control. By defining the root class using this API, - * we need to include this root class in CSS. + /** Sets the root class for RadialMenu theme. This cssClass API helps to use custom skinning option for RadialMenu control. By defining the root class using this API, we need to include this root class in CSS. */ cssClass?: string; @@ -36885,7 +36908,7 @@ export interface Model { /** Specify the items of radial menu */ - items?: Item[]; + items?: Array; /** Specifies the radius of radial menu */ @@ -36900,13 +36923,13 @@ export interface Model { position?: any; /** Event triggers when we click an item. */ - click?(e: ClickEventArgs): void; + click? (e: ClickEventArgs): void; /** Event triggers when the menu is opened. */ - open?(e: OpenEventArgs): void; + open? (e: OpenEventArgs): void; /** Event triggers when the menu is closed. */ - close?(e: CloseEventArgs): void; + close? (e: CloseEventArgs): void; } export interface ClickEventArgs { @@ -36977,7 +37000,7 @@ export interface ItemsSliderSettings { /** Specifies the sliderSettings ticks values of nested radial menu items. */ - ticks?: any[]; + ticks?: Array; /** Specifies the sliderSettings stroke Width value. */ @@ -37020,16 +37043,17 @@ export interface Item { /** Specifies to add sub level items . */ - items?: any[]; + items?: Array; } } class Tile extends ej.Widget { static fn: Tile; - constructor(element: JQuery | Element, options?: Tile.Model); + constructor(element: JQuery, options?: Tile.Model); + constructor(element: Element, options?: Tile.Model); static Locale: any; - model: Tile.Model; - defaults: Tile.Model; + model:Tile.Model; + defaults:Tile.Model; /** Update the image template of tile item to another one. * @param {string} UpdateTemplate by using id @@ -37038,7 +37062,7 @@ class Tile extends ej.Widget { */ updateTemplate(id: string, index: number): void; } -export namespace Tile { +export module Tile{ export interface Model { @@ -37086,7 +37110,7 @@ export interface Model { /** Set the localization culture for Tile Widget. */ - locale?: string; + locale?: String; /** Section for liveTile specific functionalities. */ @@ -37118,10 +37142,10 @@ export interface Model { backgroundColor?: string; /** Event triggers when the mouseDown happens in the tile */ - mouseDown?(e: MouseDownEventArgs): void; + mouseDown? (e: MouseDownEventArgs): void; /** Event triggers when the mouseUp happens in the tile */ - mouseUp?(e: MouseUpEventArgs): void; + mouseUp? (e: MouseUpEventArgs): void; } export interface MouseDownEventArgs { @@ -37142,7 +37166,7 @@ export interface MouseDownEventArgs { */ text?: string; - /** returns the index of current tile item + /** returns the index of current tile item */ index?: number; } @@ -37165,7 +37189,7 @@ export interface MouseUpEventArgs { */ text?: boolean; - /** returns the index of current tile item + /** returns the index of current tile item */ index?: number; } @@ -37198,7 +37222,7 @@ export interface Badge { value?: number; /** Sets position for tile badge. - * @Default {“bottomrightâ€} + * @Default {Ă¢â‚¬Å“bottomrightĂ¢â‚¬Â} */ position?: ej.Tile.BadgePosition|string; } @@ -37241,17 +37265,17 @@ export interface LiveTile { /** Specifies liveTile images in CSS classes. * @Default {null} */ - imageClass?: any[]; + imageClass?: Array; /** Specifies liveTile images in templates. * @Default {null} */ - imageTemplateId?: any[]; + imageTemplateId?: Array; /** Specifies liveTile images in CSS classes. * @Default {null} */ - imageUrl?: any[]; + imageUrl?: Array; /** Specifies liveTile type for Tile. See orientation * @Default {flip} @@ -37266,10 +37290,10 @@ export interface LiveTile { /** Sets the text to each living tile * @Default {Null} */ - text?: any[]; + text?: Array; } -enum BadgePosition { +enum BadgePosition{ ///To set the topright position of tile badge Topright, @@ -37279,7 +37303,7 @@ enum BadgePosition { } -enum CaptionAlignment { +enum CaptionAlignment{ ///To set the normal alignment of text in tile control Normal, @@ -37295,7 +37319,7 @@ enum CaptionAlignment { } -enum CaptionPosition { +enum CaptionPosition{ ///To set the inner top position of the tile text Innertop, @@ -37308,7 +37332,7 @@ enum CaptionPosition { } -enum ImagePosition { +enum ImagePosition{ ///To set the center position of tile image Center, @@ -37342,7 +37366,7 @@ enum ImagePosition { } -enum liveTileType { +enum liveTileType{ ///To set flip type of liveTile for tile control Flip, @@ -37355,7 +37379,7 @@ enum liveTileType { } -enum TileSize { +enum TileSize{ ///To set the medium size for tile control Medium, @@ -37374,10 +37398,11 @@ enum TileSize { class Signature extends ej.Widget { static fn: Signature; - constructor(element: JQuery | Element, options?: Signature.Model); + constructor(element: JQuery, options?: Signature.Model); + constructor(element: Element, options?: Signature.Model); static Locale: any; - model: Signature.Model; - defaults: Signature.Model; + model:Signature.Model; + defaults:Signature.Model; /** Clears the strokes in the signature. * @returns {void} @@ -37424,7 +37449,7 @@ class Signature extends ej.Widget { */ undo(): void; } -export namespace Signature { +export module Signature{ export interface Model { @@ -37482,16 +37507,16 @@ export interface Model { width?: string; /** Triggers when the stroke is changed. */ - change?(e: ChangeEventArgs): void; + change? (e: ChangeEventArgs): void; /** Triggered when the pointer is clicked or touched in the signature canvas. */ - mouseDown?(e: MouseDownEventArgs): void; + mouseDown? (e: MouseDownEventArgs): void; /** Triggered when the pointer is moved in the signature canvas. */ - mouseMove?(e: MouseMoveEventArgs): void; + mouseMove? (e: MouseMoveEventArgs): void; /** Triggered when the pointer is released after click or touch in the signature canvas. */ - mouseUp?(e: MouseUpEventArgs): void; + mouseUp? (e: MouseUpEventArgs): void; } export interface ChangeEventArgs { @@ -37570,7 +37595,7 @@ export interface MouseUpEventArgs { value?: any; } -enum SaveImageFormat { +enum SaveImageFormat{ ///To save the signature image with PNG format only. PNG, @@ -37589,10 +37614,11 @@ enum SaveImageFormat { class RadialSlider extends ej.Widget { static fn: RadialSlider; - constructor(element: JQuery | Element, options?: RadialSlider.Model); + constructor(element: JQuery, options?: RadialSlider.Model); + constructor(element: Element, options?: RadialSlider.Model); static Locale: any; - model: RadialSlider.Model; - defaults: RadialSlider.Model; + model:RadialSlider.Model; + defaults:RadialSlider.Model; /** To show the radialslider * @returns {void} @@ -37604,7 +37630,7 @@ class RadialSlider extends ej.Widget { */ hide(): void; } -export namespace RadialSlider { +export module RadialSlider{ export interface Model { @@ -37613,8 +37639,7 @@ export interface Model { */ autoOpen?: boolean; - /** Sets the root class for RadialSlider theme. This cssClass API helps to use custom skinning option for RadialSlider control. - * By defining the root class using this API, we need to include this root class in CSS. + /** Sets the root class for RadialSlider theme. This cssClass API helps to use custom skinning option for RadialSlider control. By defining the root class using this API, we need to include this root class in CSS. */ cssClass?: string; @@ -37675,7 +37700,7 @@ export interface Model { /** Specifies the ticks value of radial slider */ - ticks?: any[]; + ticks?: Array; /** Specifies the value of radial slider * @Default {10} @@ -37683,142 +37708,142 @@ export interface Model { value?: number; /** Event triggers when the change occurs. */ - change?(e: ChangeEventArgs): void; + change? (e: ChangeEventArgs): void; /** Event triggers when the radial slider is created. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Event triggers when the mouse pointer is dragged over the radial slider. */ - mouseover?(e: MouseoverEventArgs): void; + mouseover? (e: MouseoverEventArgs): void; /** Event triggers when the Radial slider slides. */ - slide?(e: SlideEventArgs): void; + slide? (e: SlideEventArgs): void; /** Event triggers when the radial slider starts. */ - start?(e: StartEventArgs): void; + start? (e: StartEventArgs): void; /** Event triggers when the radial slider stops. */ - stop?(e: StopEventArgs): void; + stop? (e: StopEventArgs): void; } export interface ChangeEventArgs { - /** returns the Radialslider model + /** returns the Radialslider model */ model?: any; - /** if the event should be canceled; otherwise, false. + /** if the event should be canceled; otherwise, false. */ cancel?: boolean; - /** returns the initial value of Radial slider + /** returns the initial value of Radial slider */ oldValue?: number; - /** returns the name of the event + /** returns the name of the event */ type?: string; - /** returns the current value of the Radial slider + /** returns the current value of the Radial slider */ value?: number; } export interface CreateEventArgs { - /** if the event should be canceled; otherwise, false. + /** if the event should be canceled; otherwise, false. */ cancel?: boolean; - /** returns the Radialslider model + /** returns the Radialslider model */ model?: any; - /** returns the name of the event + /** returns the name of the event */ type?: string; } export interface MouseoverEventArgs { - /** if the event should be canceled; otherwise, false. + /** if the event should be canceled; otherwise, false. */ cancel?: boolean; - /** returns the Radialslider model + /** returns the Radialslider model */ model?: any; - /** returns the value selected + /** returns the value selected */ selectedValue?: number; - /** returns the name of the event + /** returns the name of the event */ type?: string; - /** returns the current value selected in Radial slider + /** returns the current value selected in Radial slider */ value?: number; } export interface SlideEventArgs { - /** if the event should be canceled; otherwise, false. + /** if the event should be canceled; otherwise, false. */ cancel?: boolean; - /** returns the Radialslider model + /** returns the Radialslider model */ model?: any; - /** returns the value selected in Radial slider + /** returns the value selected in Radial slider */ selectedValue?: number; - /** returns the name of the event + /** returns the name of the event */ type?: string; - /** returns the currently selected value + /** returns the currently selected value */ value?: number; } export interface StartEventArgs { - /** if the event should be canceled; otherwise, false. + /** if the event should be canceled; otherwise, false. */ cancel?: boolean; - /** returns the Radialslider model + /** returns the Radialslider model */ model?: any; - /** returns the name of the event + /** returns the name of the event */ type?: string; - /** returns the current value selected in Radial slider + /** returns the current value selected in Radial slider */ value?: number; } export interface StopEventArgs { - /** if the event should be canceled; otherwise, false. + /** if the event should be canceled; otherwise, false. */ cancel?: boolean; - /** returns the Radialslider model + /** returns the Radialslider model */ model?: any; - /** returns the name of the event + /** returns the name of the event */ type?: string; - /** returns the current value selected in Radial slider + /** returns the current value selected in Radial slider */ value?: number; } @@ -37826,10 +37851,11 @@ export interface StopEventArgs { class Spreadsheet extends ej.Widget { static fn: Spreadsheet; - constructor(element: JQuery | Element, options?: Spreadsheet.Model); + constructor(element: JQuery, options?: Spreadsheet.Model); + constructor(element: Element, options?: Spreadsheet.Model); static Locale: any; - model: Spreadsheet.Model; - defaults: Spreadsheet.Model; + model:Spreadsheet.Model; + defaults:Spreadsheet.Model; /** This method is used to add custom formulas in Spreadsheet. * @param {string} Pass the name of the formula. @@ -37844,28 +37870,28 @@ class Spreadsheet extends ej.Widget { addNewSheet(): void; /** It is used to clear all the data and format in the specified range of cells in Spreadsheet. - * @param {string|Array} Optional. If range is specified, then it will clear all content in the specified range else it will use the current selected range. + * @param {string|Array} Optional. If range is specified, then it will clear all content in the specified range else it will use the current selected range. * @returns {void} */ - clearAll(range?: string|any[]): void; + clearAll(range?: string|Array): void; /** This property is used to clear all the formats applied in the specified range in Spreadsheet. - * @param {string|Array} Optional. If range is specified, then it will clear all format in the specified range else it will use the current selected range. + * @param {string|Array} Optional. If range is specified, then it will clear all format in the specified range else it will use the current selected range. * @returns {void} */ - clearAllFormat(range?: string|any[]): void; + clearAllFormat(range?: string|Array): void; /** Used to clear the applied border in the specified range in Spreadsheet. * @param {string|Array} Optional. If range is specified, then it will clear border in the specified range else it will use the current selected range. * @returns {void} */ - clearBorder(range?: string|any[]): void; + clearBorder(range?: string|Array): void; /** This property is used to clear the contents in the specified range in Spreadsheet. - * @param {string|Array} Optional. If the range is specified, then it will clear the content in the specified range else it will use the current selected range. + * @param {string|Array} Optional. If the range is specified, then it will clear the content in the specified range else it will use the current selected range. * @returns {void} */ - clearContents(range?: string|any[]): void; + clearContents(range?: string|Array): void; /** This method is used to remove only the data in the range denoted by the specified range name. * @param {string} Pass the defined rangeSettings property name. @@ -37874,15 +37900,15 @@ class Spreadsheet extends ej.Widget { clearRange(rangeName: string): void; /** It is used to remove data in the specified range of cells based on the defined property. - * @param {Array|string} Optional. If range is specified, it will clear data for the specified range else it will use the current selected range. - * @param {string} Optional. If property is specified, it will remove the specified property in the range else it will remove default properties + * @param {Array|string} Optional. If range is specified, it will clear data for the specified range else it will use the current selected range. + * @param {string} Optional. If property is specified, it will remove the specified property in the range else it will remove default properties * @param {any} Optional. - * @param {boolean} Optional. pass {{'`true`' | markdownify}}, if you want to skip the hidden rows + * @param {boolean} Optional. pass {{'`true`' | markdownify}}, if you want to skip the hidden rows * @param {any} Optional. Pass the status to perform undo and redo operation. * @param {any} Optional. It specifies whether to skip element processing or not. * @returns {void} */ - clearRangeData(range?: any[]|string, property?: string, cells?: any, skipHiddenRow?: boolean, status?: any, skipCell?: any): void; + clearRangeData(range?: Array|string, property?: string, cells?: any, skipHiddenRow?: boolean, status?: any, skipCell?: any): void; /** This method is used to clear undo and redo collections in the Spreadsheet. * @returns {void} @@ -37936,7 +37962,7 @@ class Spreadsheet extends ej.Widget { * @param {Function} Pass the function that you want to perform range edit. * @returns {void} */ - editRange(rangeName: string, fn: any): void; + editRange(rangeName: string, fn: Function): void; /** This method is used to get the activation panel in the Spreadsheet. * @returns {HTMLElement} @@ -38006,16 +38032,16 @@ class Spreadsheet extends ej.Widget { getRange(range: string, sheetIdx: number, skipHiddenRow?: boolean): HTMLElement; /** This method is used to get the data in specified range in Spreadsheet. - * @param {any} Optional. Pass the range, property, sheetIdx, valueOnly in options. + * @param {any} Optional. Pass the range, property, sheetIdx, valueOnly in options. * @returns {Array} */ - getRangeData(options?: any): any[]; + getRangeData(options?: any): Array; /** This method is used to get the range indices array based on the specified alpha range in Spreadsheet. * @param {string} Pass the alpha range that you want to get range indices. * @returns {Array} */ - getRangeIndices(range: string): any[]; + getRangeIndices(range: string): Array; /** This method is used to get the sheet details based on the given sheet index in Spreadsheet. * @param {number} Pass the sheet index to get the sheet object. @@ -38032,7 +38058,7 @@ class Spreadsheet extends ej.Widget { /** This method is used to get all the sheets in workbook. * @returns {Array} */ - getSheets(): any[]; + getSheets(): Array; /** This method is used to send a paging request to the specified sheet Index in the Spreadsheet. * @param {number} Pass the sheet index to perform paging at specified sheet index @@ -38121,7 +38147,7 @@ class Spreadsheet extends ej.Widget { * @param {string} Optional. By default is {{'`true`' | markdownify}}. If it is {{'`false`' | markdownify}} locked cells are unlocked. * @returns {void} */ - lockCells(range: string|any[], isLocked?: string): void; + lockCells(range: string|Array, isLocked?: string): void; /** This method is used to merge cells by across in the Spreadsheet. * @param {string} Optional. To pass the cell range or selected cells are process. @@ -38135,7 +38161,7 @@ class Spreadsheet extends ej.Widget { * @param {boolean} Optional. If pass {{'`true`' | markdownify}} it does not show alert. * @returns {void} */ - mergeCells(range?: string|any[], alertStatus?: boolean): void; + mergeCells(range?: string|Array, alertStatus?: boolean): void; /** This method is used to select a cell or range in the Spreadsheet. * @param {any} Pass the start cell to perform selection. @@ -38145,7 +38171,7 @@ class Spreadsheet extends ej.Widget { performSelection(startCell: any, endCell: any): void; /** This method is used to protect or unprotect active sheet. - * @param {boolean} Optional. By default is `true`. If it is `false` active sheet is unprotected. + * @param {boolean} Optional. By default is {{'`true`' | markdownify}}. If it is {{'`false`' | markdownify}} active sheet is unprotected. * @returns {void} */ protectSheet(isProtected?: boolean): void; @@ -38188,7 +38214,7 @@ class Spreadsheet extends ej.Widget { * @param {string|Array} Pass the range. * @returns {void} */ - removeReadOnly(range?: string|any[]): void; + removeReadOnly(range?: string|Array): void; /** This method is used to save JSON data in Spreadsheet. * @returns {any} @@ -38226,7 +38252,7 @@ class Spreadsheet extends ej.Widget { * @param {Array|any} Pass the row index and height of the rows. * @returns {void} */ - setHeightToRows(heightColl: any[]|any): void; + setHeightToRows(heightColl: Array|any): void; /** This method is used to set the hyperlink in selected cells of the current sheet. * @param {string|Array} If range is specified, it will set the hyperlink in range of the cells. @@ -38234,13 +38260,13 @@ class Spreadsheet extends ej.Widget { * @param {number} If we pass cellAddress then which sheet to be navigate in the applied link. * @returns {void} */ - setHyperlink(range: string|any[], link: any, sheetIdx: number): void; + setHyperlink(range: string|Array, link: any, sheetIdx: number): void; /** This method is used to set the readonly option for the specified range. * @param {string|Array} Pass the range. * @returns {void} */ - setReadOnly(range?: string|any[]): void; + setReadOnly(range?: string|Array): void; /** This method is used to set the focus to the Spreadsheet. * @returns {void} @@ -38251,7 +38277,7 @@ class Spreadsheet extends ej.Widget { * @param {Array|any} Pass the column index and width of the columns. * @returns {void} */ - setWidthToColumns(widthColl: any[]|any): void; + setWidthToColumns(widthColl: Array|any): void; /** This method is used to rename the active sheet. * @param {string} Pass the sheet name that you want to change the current active sheet name. @@ -38307,11 +38333,6 @@ class Spreadsheet extends ej.Widget { */ showWaitingPopUp(): void; - /** This method is used to unfreeze the frozen rows and columns in the Spreadsheet. - * @returns {void} - */ - unfreezePanes(): void; - /** This method is used to unhide the sheet based on specified sheet name or sheet index. * @param {string|number} Pass the sheet name or index that you want to unhide. * @returns {void} @@ -38328,14 +38349,14 @@ class Spreadsheet extends ej.Widget { * @param {Array|string} Optional. If the range is specified, then it will update unwrap in the specified range else it will use the current selected range. * @returns {void} */ - unWrapText(range?: any[]|string): void; + unWrapText(range?: Array|string): void; /** This method is used to update the data for the specified range of cells in the Spreadsheet. * @param {any} Pass the cells data that you want to update. - * @param {Array|string} Optional. If range is specified, it will update data for the specified range else it will use the current selected range. + * @param {Array|string} Optional. If range is specified, it will update data for the specified range else it will use the current selected range. * @returns {void} */ - updateData(data: any, range?: any[]|string): void; + updateData(data: any, range?: Array|string): void; /** This method is used to update the formula bar in the Spreadsheet. * @returns {void} @@ -38361,13 +38382,13 @@ class Spreadsheet extends ej.Widget { * @param {any} Optional. It specifies whether to skip element processing or not. * @returns {void} */ - updateUniqueData(data: any, range?: any[]|string, skipCell?: any): void; + updateUniqueData(data: any, range?: Array|string, skipCell?: any): void; /** This method is used to wrap the selected range of cells in the Spreadsheet. * @param {Array|string} Optional. If the range is specified, then it will update wrap in the specified range else it will use the current selected range. * @returns {void} */ - wrapText(range?: any[]|string): void; + wrapText(range?: Array|string): void; XLCellType: Spreadsheet.XLCellType; @@ -38400,6 +38421,11 @@ class Spreadsheet extends ej.Widget { XLFreeze: Spreadsheet.XLFreeze; + /** This method is used to unfreeze the frozen rows and columns in the Spreadsheet. + * @returns {void} + */ + unfreezePanes(): void; + XLPivot: Spreadsheet.XLPivot; XLPrint: Spreadsheet.XLPrint; @@ -38418,7 +38444,7 @@ class Spreadsheet extends ej.Widget { XLValidate: Spreadsheet.XLValidate; } -export namespace Spreadsheet { +export module Spreadsheet{ export interface XLCellType { @@ -38428,31 +38454,30 @@ export interface XLCellType { * @param {number} Optional. Pass sheet index. * @returns {void} */ - addCellTypes(range: string, settings: any, sheetIdx: number): void; + addCellTypes(range: string,settings: any,sheetIdx: number): void; /** This method is used to remove cell type from the specified range of cells in the Spreadsheet. * @param {string|Array} Pass the range where you want remove cell type. * @param {number} Optional. Pass sheet index. * @returns {void} */ - removeCellTypes(range: string|any[], sheetIdx: number): void; + removeCellTypes(range: string|Array,sheetIdx: number): void; } export interface XLCFormat { /** This method is used to clear the applied conditional formatting rules in the Spreadsheet. - * @param {boolean} Pass {{'`true`' | markdownify}} if you want to clear rules from selected cells else it will clear rules from entire sheet. * @param {Array|string} Optional. If range is specified, it will clear rules for the specified range else it will use the current selected range. * @returns {void} */ - clearCF(isSelected: boolean, range: any[]|string): void; + clearCF(range: Array|string): void; /** This method is used to get the applied conditional formatting rules as array of objects based on the specified row Index and column Index in the Spreadsheet. * @param {number} Pass the row index. * @param {number} Pass the column index. * @returns {Array} */ - getCFRule(rowIdx: number, colIdx: number): any[]; + getCFRule(rowIdx: number,colIdx: number): Array; /** This method is used to set the conditional formatting rule in the Spreadsheet. * @param {any} Pass the rule to set. @@ -38468,14 +38493,14 @@ export interface XLChart { * @param {ej.datavisualization.Chart.Theme} Pass the chart theme which want to update. * @returns {void} */ - changeTheme(chartId: string, theme: ej.datavisualization.Chart.Theme): void; + changeTheme(chartId: string,theme: ej.datavisualization.Chart.Theme): void; /** This method is used to change the type of the chart in the Spreadsheet. * @param {string} Pass the chart id. * @param {any} Pass the chart type. * @returns {void} */ - changeType(chartId: string, option: any): void; + changeType(chartId: string,option: any): void; /** This method is used to change the data range of the chart in the Spreadsheet. * @param {string} Pass the chart id. @@ -38484,21 +38509,21 @@ export interface XLChart { * @param {string} Legend range of chart data. * @returns {void} */ - changeDataRange(chartId: string, xRange: string, yRange: string, lRange: string): void; + changeDataRange(chartId: string,xRange: string,yRange: string,lRange: string): void; /** This method is used to create a chart for specified range in Spreadsheet. * @param {string|Array} Optional. If range is specified, it will create chart for the specified range else it will use the current selected range. * @param {any} Optional. To pass the type of chart and chart name. * @returns {void} */ - createChart(range: string|any[], options: any): void; + createChart(range: string|Array,options: any): void; /** This method is used to refresh the chart in the Spreadsheet. * @param {string} To pass the chart Id. * @param {any} To pass the type of chart and chart name. * @returns {void} */ - refreshChart(id: string, options: any): void; + refreshChart(id: string,options: any): void; /** This method is used to resize the chart of specified id in the Spreadsheet. * @param {string} To pass the chart id. @@ -38506,14 +38531,14 @@ export interface XLChart { * @param {number} To pass the width value. * @returns {void} */ - resizeChart(id: string, height: number, width: number): void; + resizeChart(id: string,height: number,width: number): void; /** This method is used to update the chart element, such as axes, titles, data labels, grid lines and legends in the Spreadsheet. * @param {string} Pass the chart id. * @param {ej.Spreadsheet.ChartProperties} Pass chart element value which you want to update. * @returns {void} */ - updateChartElement(chartId: string, value: ej.Spreadsheet.ChartProperties): void; + updateChartElement(chartId: string,value: ej.Spreadsheet.ChartProperties): void; /** This method is used switch row to columns and vice versa for chart in the Spreadsheet. So that the data is displayed in the chart the way you want. * @param {string} Pass the chart id. @@ -38543,15 +38568,15 @@ export interface XLClipboard { export interface XLComment { /** This method is used to delete the comment in the specified range in Spreadsheet. - * @param {Array|string} Optional. If range is specified, it will delete comments for the specified range else it will use the current selected range. + * @param {Array|string} Optional. If range is specified, it will delete comments for the specified range else it will use the current selected range. * @param {number} Optional. If sheetIdx is specified, it will delete comment in specified sheet else it will use active sheet. * @param {boolean} Optional. Pass {{'`true`' | markdownify}}, if you want to skip the hidden rows data. * @returns {void} */ - deleteComment(range: any[]|string, sheetIdx: number, skipHiddenRow: boolean): void; + deleteComment(range: Array|string,sheetIdx: number,skipHiddenRow: boolean): void; /** This method is used to edit the comment in the target Cell in Spreadsheet. - * @param {any} Optional. Pass the row index and column index of the cell which contains comment. + * @param {any} Optional. Pass the row index and column index of the cell which contains comment. * @returns {void} */ editComment(targetCell: any): void; @@ -38573,13 +38598,13 @@ export interface XLComment { getComment(cell: HTMLElement): any; /** This method is used to set new comment in Spreadsheet. - * @param {string|Array} Optional. If we pass the range comment will set in the range otherwise it will set with selected cells. + * @param {string|Array} Optional. If we pass the range comment will set in the range otherwise it will set with selected cells. * @param {string} Optional. Pass the comment data. - * @param {boolean} Optional. Pass {{'`true`' | markdownify}} to show comment in edit mode - * @param {boolean} Optional. Pass {{'`true`' | markdownify}} to show the user name + * @param {boolean} Optional. Pass {{'`true`' | markdownify}} to show comment in edit mode + * @param {boolean} Optional. Pass {{'`true`' | markdownify}} to show the user name * @returns {void} */ - setComment(range: string|any[], data: string, showEditPanel: boolean, showUserName: boolean): void; + setComment(range: string|Array,data: string,showEditPanel: boolean,showUserName: boolean): void; /** This method is used to show all the comments in the Spreadsheet. * @returns {void} @@ -38601,35 +38626,35 @@ export interface XLCMenu { * @param {string} Specifies the type of operation to be performed * @returns {void} */ - addItem(target: string, itemColl: any[], operation: string): void; + addItem(target: string,itemColl: Array,operation: string): void; /** This method is used to change data source in the context menu. * @param {string} Specifies the context menu type to bind the data source. * @param {Array} Pass the data source to be binded * @returns {void} */ - changeDataSource(target: string, data: any[]): void; + changeDataSource(target: string,data: Array): void; /** This method is used to disable the items in the context menu. * @param {string} Specifies the context menu type in which the item to be disabled. * @param {Array} Specifies the Menu Item id collection to be disabled * @returns {void} */ - disableItem(target: string, idxColl: any[]): void; + disableItem(target: string,idxColl: Array): void; /** This method is used to enable the items in the context menu. * @param {string} Specifies the context menu type in which the item to be enabled. * @param {Array} Specifies the Menu Item id collection to be enabled * @returns {void} */ - enableItem(target: string, idxColl: any[]): void; + enableItem(target: string,idxColl: Array): void; /** This method is used to remove the items in the context menu. * @param {string} Specifies the context menu type in which the item to be removed. * @param {Array} Specifies the Menu Item id collection to be removed * @returns {void} */ - removeItem(target: string, idxColl: any[]): void; + removeItem(target: string,idxColl: Array): void; } export interface XLDragDrop { @@ -38639,7 +38664,7 @@ export interface XLDragDrop { * @param {any|Array} Pass the destination range to drop the dragged cells. * @returns {void} */ - moveRangeTo(sourceRange: any|any[], destinationRange: any|any[]): void; + moveRangeTo(sourceRange: any|Array,destinationRange: any|Array): void; } export interface XLDragFill { @@ -38681,28 +38706,24 @@ export interface XLEdit { * @param {boolean} Pass {{'`true`' | markdownify}}, if you want to maintain previous cell value. * @returns {void} */ - editCell(rowIdx: number, colIdx: number, oldData: boolean): void; + editCell(rowIdx: number,colIdx: number,oldData: boolean): void; /** This method is used to get the property value of particular cell, based on the row and column index in the Spreadsheet. * @param {number} Pass the row index to get the property value. * @param {number} Pass the column index to get the property value. - * @param {string} Optional. Pass the property name that you want("value", "value2", "type", "cFormatRule", "range", "thousandSeparator", "rule", "format", "border", "picture", - * "chart", "calcValue", "align", "hyperlink", "formats", "borders", "tformats", "tborders", "isFilterHeader", "filterState", "tableName", "comment", "formatStr", - * "decimalPlaces", "cellType"). + * @param {string} Optional. Pass the property name that you want("value", "value2", "type", "cFormatRule", "range", "thousandSeparator", "rule", "format", "border", "picture", "chart", "calcValue", "align", "hyperlink", "formats", "borders", "tformats", "tborders", "isFilterHeader", "filterState", "tableName", "comment", "formatStr", "decimalPlaces", "cellType"). * @param {number} Optional. Pass the index of the sheet. * @returns {any|string|Array} */ - getPropertyValue(rowIdx: number, colIdx: number, prop: string, sheetIdx: number): any|string|any[]; + getPropertyValue(rowIdx: number,colIdx: number,prop: string,sheetIdx: number): any|string|Array; /** This method is used to get the property value in specified cell in Spreadsheet. * @param {HTMLElement} Pass the cell element to get property value. - * @param {string} Pass the property name that you want ("value", "value2", "type", "cFormatRule", "range", "thousandSeparator", "rule", "format", "border", - * "picture", "chart", "calcValue", "align", "hyperlink", "formats", "borders", "tformats", "tborders", "isFilterHeader", "filterState", "tableName", - * "comment", "formatStr", "decimalPlaces", "cellType"). + * @param {string} Pass the property name that you want ("value", "value2", "type", "cFormatRule", "range", "thousandSeparator", "rule", "format", "border", "picture", "chart", "calcValue", "align", "hyperlink", "formats", "borders", "tformats", "tborders", "isFilterHeader", "filterState", "tableName", "comment", "formatStr", "decimalPlaces", "cellType"). * @param {number} Pass the index of sheet. * @returns {any|string|Array} */ - getPropertyValueByElem(elem: HTMLElement, property: string, sheetIdx: number): any|string|any[]; + getPropertyValueByElem(elem: HTMLElement,property: string,sheetIdx: number): any|string|Array; /** This method is used to save the edited cell value in the Spreadsheet. * @returns {void} @@ -38714,22 +38735,22 @@ export interface XLEdit { * @param {string|number} Pass the cell value. * @returns {void} */ - updateCell(cell: any, value: string|number): void; + updateCell(cell: any,value: string|number): void; /** This method is used to update a particular cell value and its format in the Spreadsheet. * @param {any} Pass row index and column index of the cell. * @param {string|number} Pass the cell value. - * @param {string} Pass the class name to update format. + * @param {string} Pass the class name to update format. * @param {number} Pass sheet index. * @returns {void} */ - updateCellValue(cellIdx: any, val: string|number, formatClass: string, sheetIdx: number): void; + updateCellValue(cellIdx: any,val: string|number,formatClass: string,sheetIdx: number): void; } export interface XLExport { /** This method is used to save the sheet data as Excel ,CSV or PDF document (.xls, .xlsx .csv, .pdf) in Spreadsheet. - * @param {string} Pass the export type that you want. + * @param {string} Pass the export type that you want. * @returns {void} */ export(type: string): void; @@ -38751,7 +38772,7 @@ export interface XLFilter { * @param {string|Array} Pass the range of the selected cells. * @returns {void} */ - filter(range: string|any[]): void; + filter(range: string|Array): void; /** This method is used to apply filter for the column by active cell's value in the Spreadsheet. * @returns {void} @@ -38769,24 +38790,24 @@ export interface XLFormat { /** This method is used to create a table for the selected range of cells in the Spreadsheet. * @param {any} Pass the table object. - * @param {string|Array} Optional. If the range is specified, then it will create table in the specified range else it will use the current selected range. + * @param {string|Array} Optional. If the range is specified, then it will create table in the specified range else it will use the current selected range. * @returns {string} */ - createTable(tableObject: any, range: string|any[]): string; + createTable(tableObject: any,range: string|Array): string; /** This method is used to set format style and values in a cell or range of cells. * @param {any} Pass the formatObject which contains style, type, format, groupSeparator and decimalPlaces. * @param {string} Pass the range to format cells. * @returns {void} */ - format(formatObj: any, range: string): void; + format(formatObj: any,range: string): void; /** This method is used to remove the style in the specified range. * @param {Array|string} Pass the cell range . * @param {any} Optional. Pass the options for which the style gets removed. * @returns {void} */ - removeStyle(range: any[]|string, options: any): void; + removeStyle(range: Array|string,options: any): void; /** This method is used to remove table with specified tableId in the Spreadsheet. * @param {number} Pass the tableId that you want to remove. @@ -38799,21 +38820,21 @@ export interface XLFormat { * @param {string|Array} Pass the range. * @returns {void} */ - updateDecimalPlaces(type: string, range: string|any[]): void; + updateDecimalPlaces(type: string,range: string|Array): void; /** This method is used to update the format for the selected range of cells in the Spreadsheet. * @param {any} Pass the format object that you want to update. - * @param {Array} Optional. If the range is specified, then it will update format in the specified range else it will use the current selected range. + * @param {Array} Optional. If the range is specified, then it will update format in the specified range else it will use the current selected range. * @returns {void} */ - updateFormat(formatObj: any, range: any[]): void; + updateFormat(formatObj: any,range: Array): void; /** This method is used to update the unique format for selected range of cells in the Spreadsheet. * @param {string} Pass the unique format class. * @param {Array} Optional. If the range is specified, then it will update format in the specified range else it will use the current selected range. * @returns {void} */ - updateUniqueFormat(formatClass: string, range: any[]): void; + updateUniqueFormat(formatClass: string,range: Array): void; } export interface XLFreeze { @@ -38830,10 +38851,11 @@ export interface XLFreeze { freezeLeftColumn(): void; /** This method is used to freeze rows and columns before the specified cell in the Spreadsheet. - * @param {any} Row index and column index of the cell which you want to freeze. + * @param {number} Index of the row to be freeze. + * @param {number} Index of the column to be freeze. * @returns {void} */ - freezePanes(cell: any): void; + freezePanes(rowIdx: number,colIdx: number): void; /** This method is used to freeze rows upto the specified row index in the Spreadsheet. * @param {number} Index of the row to be freeze. @@ -38845,12 +38867,17 @@ export interface XLFreeze { * @returns {void} */ freezeTopRow(): void; + + /** This method is used to unfreeze the frozen rows and columns in the Spreadsheet. + * @returns {void} + */ + unfreezePanes(): void; } export interface XLPivot { /** This property is used to clear the pivot table list in Spreadsheet. - * @param {string} Pass the name of the pivot table. + * @param {string} Pass the name of the pivot table. * @returns {void} */ clearPivotFieldList(pivotName: string): void; @@ -38863,7 +38890,7 @@ export interface XLPivot { * @param {any} Pass the pivot range, sheet index, address and data source . * @returns {string} */ - createPivotTable(range: string, location: string, name: string, settings: any, pvt: any): string; + createPivotTable(range: string,location: string,name: string,settings: any,pvt: any): string; /** This method is used to delete the pivot table which is selected. * @param {string} Pass the name of the pivot table. @@ -38876,7 +38903,7 @@ export interface XLPivot { * @param {number} Optional. Pass the index of the sheet. * @returns {void} */ - refreshDataSource(name: string, sheetIdx: number): void; + refreshDataSource(name: string,sheetIdx: number): void; } export interface XLPrint { @@ -38898,13 +38925,13 @@ export interface XLResize { * @param {Array} Optional. Pass row index collection that you want to fit its height. * @returns {void} */ - fitHeight(rowIndexes: any[]): void; + fitHeight(rowIndexes: Array): void; /** This method is used to fit the width of columns in the Spreadsheet. * @param {Array} Optional. Pass column index collection that you want to fit its width. * @returns {void} */ - fitWidth(colIndexes: any[]): void; + fitWidth(colIndexes: Array): void; /** This method is used to get the column width of the specified column index in the Spreadsheet. * @param {number} Pass the column index. @@ -38923,14 +38950,14 @@ export interface XLResize { * @param {number} Pass the width value that you want to set. * @returns {void} */ - setColWidth(colIdx: number, size: number): void; + setColWidth(colIdx: number,size: number): void; /** This method is used to set the row height of the specified row index in the Spreadsheet. * @param {number} Pass the row index. * @param {number} Pass the height value that you want to set. * @returns {void} */ - setRowHeight(rowIdx: number, size: number): void; + setRowHeight(rowIdx: number,size: number): void; } export interface XLRibbon { @@ -38940,21 +38967,21 @@ export interface XLRibbon { * @param {number} pass the index of the item to be added in the backstage. * @returns {void} */ - addBackStageItem(pageItem: any, index: number): void; + addBackStageItem(pageItem: any,index: number): void; /** This method is used to dynamically add the contextual tabs in the ribbon. * @param {any} Specifies the contextual tab set object. * @param {number} pass the index of the contextual tab. * @returns {void} */ - addContextualTabs(contextualTabSet: any, index: number): void; + addContextualTabs(contextualTabSet: any,index: number): void; /** This method is used to dynamically add the menu item in the file menu. * @param {Array} Specifies the item to be added * @param {number} pass the index of the menu item. * @returns {void} */ - addMenuItem(item: any[], index: number): void; + addMenuItem(item: Array,index: number): void; /** This method is used to add a new name in the Spreadsheet name manager. * @param {string} Pass the name that you want to define in name manager. @@ -38963,7 +38990,7 @@ export interface XLRibbon { * @param {number} Optional. Pass the sheet index. * @returns {void} */ - addNamedRange(name: string, refersTo: string, comment: string, sheetIdx: number): void; + addNamedRange(name: string,refersTo: string,comment: string,sheetIdx: number): void; /** This method is used to dynamically add the tab in the ribbon. * @param {Array} Specifies the text to be displayed in the tab. @@ -38971,7 +38998,7 @@ export interface XLRibbon { * @param {number} pass the index of the tab. * @returns {void} */ - addTab(tabText: any[], ribbonGroups: number, index: number): void; + addTab(tabText: Array,ribbonGroups: number,index: number): void; /** This method is used to dynamically add the tab group in the ribbon. * @param {number} Specifies the ribbon tab index. @@ -38979,14 +39006,14 @@ export interface XLRibbon { * @param {number} pass the index of the ribbon group. * @returns {void} */ - addTabGroup(tabIndex: number, tabGroup: any, groupIndex: number): void; + addTabGroup(tabIndex: number,tabGroup: any,groupIndex: number): void; /** This method is used to insert the few type (SUM, MAX, MIN, AVG, COUNT) of formulas in the selected range of cells in the Spreadsheet. * @param {string} To pass the type("SUM","MAX","MIN","AVG","COUNT"). * @param {string|Array} If range is specified, it will apply auto sum for the specified range else it will use the current selected range. * @returns {void} */ - autoSum(type: string, range: string|any[]): void; + autoSum(type: string,range: string|Array): void; /** This method is used to hide the file menu in the ribbon tab. * @returns {void} @@ -39016,14 +39043,14 @@ export interface XLRibbon { * @param {boolean} pass the boolean value to remove the tab from ribbon * @returns {void} */ - removeTab(index: number, isRemoveMenu: boolean): void; + removeTab(index: number,isRemoveMenu: boolean): void; /** This method is used to remove the tab group form ribbon in the spreadsheet. * @param {number} Specifies the index of the tab group to be removed from the ribbon. * @param {string} Specifies the text to be displayed in the tab group * @returns {void} */ - removeTabGroup(tabIndex: number, groupText: string): void; + removeTabGroup(tabIndex: number,groupText: string): void; /** This method is used to show the file menu in the ribbon tab. * @returns {void} @@ -39035,7 +39062,7 @@ export interface XLRibbon { * @param {number} pass the index of the item to be updated * @returns {void} */ - updateMenuItem(item: any, index: number): void; + updateMenuItem(item: any,index: number): void; /** This method is used to update the ribbon icons in the Spreadsheet. * @returns {void} @@ -39052,7 +39079,7 @@ export interface XLSearch { * @param {boolean} Pass {{'`true`' | markdownify}}, if you want to match with entire cell contents. * @returns {void} */ - replaceAllByBook(findData: string, replaceData: string, isCSen: boolean, isEMatch: boolean): void; + replaceAllByBook(findData: string,replaceData: string,isCSen: boolean,isEMatch: boolean): void; /** This method is used to find and replace all data by sheet in Spreadsheet. * @param {string} Pass the search data. @@ -39061,7 +39088,7 @@ export interface XLSearch { * @param {boolean} Pass {{'`true`' | markdownify}}, if you want to match with entire cell contents. * @returns {void} */ - replaceAllBySheet(findData: string, replaceData: string, isCSen: boolean, isEMatch: boolean): void; + replaceAllBySheet(findData: string,replaceData: string,isCSen: boolean,isEMatch: boolean): void; } export interface XLSelection { @@ -39081,7 +39108,7 @@ export interface XLSelection { * @param {Array|string} Optional. Pass range to refresh selection. * @returns {void} */ - refreshSelection(range: any[]|string): void; + refreshSelection(range: Array|string): void; /** This method is used to select a single column in the Spreadsheet. * @param {number} Pass the column index value. @@ -39094,7 +39121,7 @@ export interface XLSelection { * @param {number} Pass the column end index. * @returns {void} */ - selectColumns(startIdx: number, endIdx: number): void; + selectColumns(startIdx: number,endIdx: number): void; /** This method is used to select the specified range of cells in the Spreadsheet. * @param {string} Pass range which want to select. @@ -39113,7 +39140,7 @@ export interface XLSelection { * @param {number} Pass the end row index. * @returns {void} */ - selectRows(startIdx: number, endIdx: number): void; + selectRows(startIdx: number,endIdx: number): void; /** This method is used to select all cells in active sheet. * @returns {void} @@ -39132,7 +39159,7 @@ export interface XLShape { * @param {number} Optional. Pass the left of the image that you want to set. * @returns {string} */ - setPicture(range: string, url: string, width: number, height: number, top: number, left: number): string; + setPicture(range: string,url: string,width: number,height: number,top: number,left: number): string; } export interface XLSort { @@ -39143,7 +39170,7 @@ export interface XLSort { * @param {string} Pass the range * @returns {void} */ - sortByColor(operation: string, color: any, range: string): void; + sortByColor(operation: string,color: any,range: string): void; /** This method is used to sort a particular range of cells based on its values in the Spreadsheet. * @param {Array|string} Pass the range to sort. @@ -39151,32 +39178,32 @@ export interface XLSort { * @param {any} Pass the direction to sort (ascending or descending). * @returns {boolean} */ - sortByRange(range: any[]|string, columnName: string, direction: any): boolean; + sortByRange(range: Array|string,columnName: string,direction: any): boolean; } export interface XLValidate { /** This method is used to apply data validation rules in a selected range of cells based on the defined condition in the Spreadsheet. - * @param {string|Array} If range is specified, it will apply rules for the specified range else it will use the current selected range. + * @param {string|Array} If range is specified, it will apply rules for the specified range else it will use the current selected range. * @param {Array} Pass the validation condition, value1 and value2. * @param {string} Pass the data type. * @param {boolean} Pass {{'`true`' | markdownify}} if you ignore blank values. * @param {boolean} Pass {{'`true`' | markdownify}} if you want to show an error alert. * @returns {void} */ - applyDVRules(range: string|any[], values: any[], type: string, required: boolean, showErrorAlert: boolean): void; + applyDVRules(range: string|Array,values: Array,type: string,required: boolean,showErrorAlert: boolean): void; /** This method is used to clear the applied validation rules in a specified range of cells in the Spreadsheet. - * @param {string|Array} Optional. If range is specified, it will clear rules for the specified range else it will use the current selected range. + * @param {string|Array} Optional. If range is specified, it will clear rules for the specified range else it will use the current selected range. * @returns {void} */ - clearDV(range: string|any[]): void; + clearDV(range: string|Array): void; /** This method is used to highlight invalid data in a specified range of cells in the Spreadsheet. * @param {string|Array} Optional. If range is specified, it will clear rules for the specified range else it will use the current selected range. * @returns {void} */ - highlightInvalidData(range: string|any[]): void; + highlightInvalidData(range: string|Array): void; } export interface Model { @@ -39231,8 +39258,7 @@ export interface Model { */ allowComments?: boolean; - /** Gets or sets a value that indicates whether to enable or disable Conditional Format feature in the Spreadsheet. By enabling this, you can apply formatting to the selected range - * of cells based on the provided conditions (Greater than, Less than, Equal, Between, Contains, etc.). + /** Gets or sets a value that indicates whether to enable or disable Conditional Format feature in the Spreadsheet. By enabling this, you can apply formatting to the selected range of cells based on the provided conditions (Greater than, Less than, Equal, Between, Contains, etc.). * @Default {true} */ allowConditionalFormats?: boolean; @@ -39267,8 +39293,7 @@ export interface Model { */ allowFormatAsTable?: boolean; - /** Get or sets a value that indicates whether to enable or disable format painter feature in the Spreadsheet. By enabling this feature, you can copy - * the format from the selected range and apply it to another range. + /** Get or sets a value that indicates whether to enable or disable format painter feature in the Spreadsheet. By enabling this feature, you can copy the format from the selected range and apply it to another range. * @Default {true} */ allowFormatPainter?: boolean; @@ -39278,14 +39303,12 @@ export interface Model { */ allowFormulaBar?: boolean; - /** Gets or sets a value that indicates whether to enable or disable freeze pane support in Spreadsheet. After enabling this feature, - * you can use freeze top row, freeze first column and freeze panes options. - * @Default {false} + /** Gets or sets a value that indicates whether to enable or disable freeze pane support in Spreadsheet. By enabling this feature, you can use freeze top row, freeze first column and freeze panes options. + * @Default {true} */ allowFreezing?: boolean; - /** Gets or sets a value that indicates whether to enable or disable hyperlink feature in the Spreadsheet. By enabling this feature, you can add hyperlink which is used to - * easily navigate to the cell reference from one sheet to another or a web page. + /** Gets or sets a value that indicates whether to enable or disable hyperlink feature in the Spreadsheet. By enabling this feature, you can add hyperlink which is used to easily navigate to the cell reference from one sheet to another or a web page. * @Default {true} */ allowHyperlink?: boolean; @@ -39320,14 +39343,12 @@ export interface Model { */ allowOverflow?: boolean; - /** Gets or sets a value that indicates whether to enable or disable resizing feature in the Spreadsheet. By enabling this feature, you can change the column width and - * row height by dragging its header boundaries. + /** Gets or sets a value that indicates whether to enable or disable resizing feature in the Spreadsheet. By enabling this feature, you can change the column width and row height by dragging its header boundaries. * @Default {true} */ allowResizing?: boolean; - /** Gets or sets a value that indicates whether to enable or disable find and replace feature in the Spreadsheet. By enabling this, you can easily find and replace - * a specific value in the sheet or workbook. By using goto behavior, you can select and highlight all cells that contains specific data or data types. + /** Gets or sets a value that indicates whether to enable or disable find and replace feature in the Spreadsheet. By enabling this, you can easily find and replace a specific value in the sheet or workbook. By using goto behavior, you can select and highlight all cells that contains specific data or data types. * @Default {true} */ allowSearching?: boolean; @@ -39347,8 +39368,7 @@ export interface Model { */ allowUndoRedo?: boolean; - /** Gets or sets a value that indicates whether to enable or disable wrap text feature in the Spreadsheet. By enabling this, cell content can wrap to the next line, - * if the cell content exceeds the boundary of the cell. + /** Gets or sets a value that indicates whether to enable or disable wrap text feature in the Spreadsheet. By enabling this, cell content can wrap to the next line, if the cell content exceeds the boundary of the cell. * @Default {true} */ allowWrap?: boolean; @@ -39383,7 +39403,7 @@ export interface Model { /** Gets or sets a value that indicates custom formulas in Spreadsheet. * @Default {[]} */ - customFormulas?: any[]; + customFormulas?: Array; /** Gets or sets a value that indicates whether to enable or disable context menu in the Spreadsheet. * @Default {true} @@ -39417,8 +39437,7 @@ export interface Model { */ isReadOnly?: boolean; - /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data (i.e.) - * in a language and culture specific to a particular country or region. + /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data (i.e.) in a language and culture specific to a particular country or region. * @Default {en-US} */ locale?: string; @@ -39460,7 +39479,7 @@ export interface Model { /** Gets or sets an object that indicates to customize the sheet behavior in Spreadsheet. */ - sheets?: Sheet[]; + sheets?: Array; /** Gets or sets a value that indicates whether to show or hide pager in the Spreadsheet. * @Default {true} @@ -39483,118 +39502,118 @@ export interface Model { userName?: string; /** Triggered for every action before its starts. */ - actionBegin?(e: ActionBeginEventArgs): void; + actionBegin? (e: ActionBeginEventArgs): void; /** Triggered for every action complete. */ - actionComplete?(e: ActionCompleteEventArgs): void; + actionComplete? (e: ActionCompleteEventArgs): void; /** Triggered when the auto fill operation begins. */ - autoFillBegin?(e: AutoFillBeginEventArgs): void; + autoFillBegin? (e: AutoFillBeginEventArgs): void; /** Triggered when the auto fill operation completes. */ - autoFillComplete?(e: AutoFillCompleteEventArgs): void; + autoFillComplete? (e: AutoFillCompleteEventArgs): void; /** Triggered before the batch save. */ - beforeBatchSave?(e: BeforeBatchSaveEventArgs): void; + beforeBatchSave? (e: BeforeBatchSaveEventArgs): void; /** Triggered before the cells to be formatted. */ - beforeCellFormat?(e: BeforeCellFormatEventArgs): void; + beforeCellFormat? (e: BeforeCellFormatEventArgs): void; /** Triggered before the cell selection. */ - beforeCellSelect?(e: BeforeCellSelectEventArgs): void; + beforeCellSelect? (e: BeforeCellSelectEventArgs): void; /** Triggered before the selected cells are dropped. */ - beforeDrop?(e: BeforeDropEventArgs): void; + beforeDrop? (e: BeforeDropEventArgs): void; /** Triggered while start to edit the comment. */ - beforeEditComment?(e: BeforeEditCommentEventArgs): void; + beforeEditComment? (e: BeforeEditCommentEventArgs): void; /** Triggered before the contextmenu is open. */ - beforeOpen?(e: BeforeOpenEventArgs): void; + beforeOpen? (e: BeforeOpenEventArgs): void; /** Triggered before the activation panel is open. */ - beforePanelOpen?(e: BeforePanelOpenEventArgs): void; + beforePanelOpen? (e: BeforePanelOpenEventArgs): void; /** Triggered when click on sheet cell. */ - cellClick?(e: CellClickEventArgs): void; + cellClick? (e: CellClickEventArgs): void; /** Triggered when the cell is edited. */ - cellEdit?(e: CellEditEventArgs): void; + cellEdit? (e: CellEditEventArgs): void; /** Triggered while cell is formatting. */ - cellFormatting?(e: CellFormattingEventArgs): void; + cellFormatting? (e: CellFormattingEventArgs): void; /** Triggered when mouse hover on cell in sheets. */ - cellHover?(e: CellHoverEventArgs): void; + cellHover? (e: CellHoverEventArgs): void; /** Triggered when save the edited cell. */ - cellSave?(e: CellSaveEventArgs): void; + cellSave? (e: CellSaveEventArgs): void; /** Triggered when the cell is selected. */ - cellSelected?(e: CellSelectedEventArgs): void; + cellSelected? (e: CellSelectedEventArgs): void; /** Triggered when click the contextmenu items. */ - contextMenuClick?(e: ContextMenuClickEventArgs): void; + contextMenuClick? (e: ContextMenuClickEventArgs): void; /** Triggered when the selected cells are being dragged. */ - drag?(e: DragEventArgs): void; + drag? (e: DragEventArgs): void; /** Triggered when you start to drag the picture or chart. */ - dragShape?(e: DragShapeEventArgs): void; + dragShape? (e: DragShapeEventArgs): void; /** Triggered when the selected cells are initiated to drag. */ - dragStart?(e: DragStartEventArgs): void; + dragStart? (e: DragStartEventArgs): void; /** Triggered when the selected cells are dropped. */ - drop?(e: DropEventArgs): void; + drop? (e: DropEventArgs): void; /** Triggered before the range editing starts. */ - editRangeBegin?(e: EditRangeBeginEventArgs): void; + editRangeBegin? (e: EditRangeBeginEventArgs): void; /** Triggered after range editing completes. */ - editRangeComplete?(e: EditRangeCompleteEventArgs): void; + editRangeComplete? (e: EditRangeCompleteEventArgs): void; /** Triggered when the key is pressed down. */ - keyDown?(e: KeyDownEventArgs): void; + keyDown? (e: KeyDownEventArgs): void; /** Triggered when the key is released. */ - keyUp?(e: KeyUpEventArgs): void; + keyUp? (e: KeyUpEventArgs): void; /** Triggered before the sheet is loaded. */ - load?(e: LoadEventArgs): void; + load? (e: LoadEventArgs): void; /** Triggered after the sheet is loaded. */ - loadComplete?(e: LoadCompleteEventArgs): void; + loadComplete? (e: LoadCompleteEventArgs): void; /** Triggered every click of the menu item. */ - menuClick?(e: MenuClickEventArgs): void; + menuClick? (e: MenuClickEventArgs): void; /** Triggered when a file is imported. */ - onImport?(e: OnImportEventArgs): void; + onImport? (e: OnImportEventArgs): void; /** Triggered when import sheet is failed to open. */ - openFailure?(e: OpenFailureEventArgs): void; + openFailure? (e: OpenFailureEventArgs): void; /** Triggered when pager item is clicked in the Spreadsheet. */ - pagerClick?(e: PagerClickEventArgs): void; + pagerClick? (e: PagerClickEventArgs): void; /** Triggered when you start resizing the chart, picture, row and column. */ - resizeStart?(e: ResizeStartEventArgs): void; + resizeStart? (e: ResizeStartEventArgs): void; /** Triggered after end of resizing the chart, picture, row and column. */ - resizeEnd?(e: ResizeEndEventArgs): void; + resizeEnd? (e: ResizeEndEventArgs): void; /** Triggered when click on the ribbon. */ - ribbonClick?(e: RibbonClickEventArgs): void; + ribbonClick? (e: RibbonClickEventArgs): void; /** Triggered when the chart series rendering. */ - seriesRendering?(e: SeriesRenderingEventArgs): void; + seriesRendering? (e: SeriesRenderingEventArgs): void; /** Triggered when click the ribbon tab. */ - tabClick?(e: TabClickEventArgs): void; + tabClick? (e: TabClickEventArgs): void; /** Triggered when select the ribbon tab. */ - tabSelect?(e: TabSelectEventArgs): void; + tabSelect? (e: TabSelectEventArgs): void; } export interface ActionBeginEventArgs { @@ -39613,7 +39632,7 @@ export interface ActionBeginEventArgs { /** Returns the cell range. */ - range?: any[]; + range?: Array; /** Returns the action format. */ @@ -39648,7 +39667,7 @@ export interface ActionCompleteEventArgs { /** Returns the applied cell format object. */ - selectedCell?: any[]|any; + selectedCell?: Array|any; /** Returns the sheet index. */ @@ -39671,7 +39690,7 @@ export interface AutoFillBeginEventArgs { /** Returns auto fill begin cell range. */ - dataRange?: any[]; + dataRange?: Array; /** Returns which direction drag the auto fill. */ @@ -39679,7 +39698,7 @@ export interface AutoFillBeginEventArgs { /** Returns fill cells range. */ - fillRange?: any[]; + fillRange?: Array; /** Returns the auto fill type. */ @@ -39706,7 +39725,7 @@ export interface AutoFillCompleteEventArgs { /** Returns auto fill begin cell range. */ - dataRange?: any[]; + dataRange?: Array; /** Returns which direction to drag the auto fill. */ @@ -39714,7 +39733,7 @@ export interface AutoFillCompleteEventArgs { /** Returns fill cells range. */ - fillRange?: any[]; + fillRange?: Array; /** Returns the auto fill type. */ @@ -39764,7 +39783,7 @@ export interface BeforeCellFormatEventArgs { /** Returns the selected cells. */ - cells?: any[]|any; + cells?: Array|any; /** Returns the Spreadsheet model. */ @@ -39783,11 +39802,11 @@ export interface BeforeCellSelectEventArgs { /** Returns the previous cell range. */ - prevRange?: any[]; + prevRange?: Array; /** Returns the current cell range. */ - currRange?: any[]; + currRange?: Array; /** Returns the Spreadsheet model. */ @@ -40093,7 +40112,7 @@ export interface CellSelectedEventArgs { /** Returns the selected range. */ - selectedRange?: any[]; + selectedRange?: Array; /** Returns the target element. */ @@ -40861,7 +40880,7 @@ export interface RibbonSettingsApplicationTabMenuSettings { /** Specifies the data source to append in application tab. * @Default {[]} */ - dataSource?: any[]; + dataSource?: Array; } export interface RibbonSettingsApplicationTab { @@ -40950,7 +40969,7 @@ export interface SelectionSettings { export interface SheetsBorder { - /** + /** */ type?: ej.Spreadsheet.BorderType|string; @@ -40976,7 +40995,7 @@ export interface SheetsCFormatRule { /** Specifies the inputs for conditional formatting in Spreadsheet. * @Default {[]} */ - inputs?: any[]; + inputs?: Array; /** Specifies the range for conditional formatting in Spreadsheet. */ @@ -41126,7 +41145,7 @@ export interface SheetsRow { /** Specifies the cells of a row in Spreadsheet. * @Default {[]} */ - cells?: SheetsRowsCell[]; + cells?: Array; /** Gets or sets the index of a row in Spreadsheet. * @Default {0} @@ -41139,12 +41158,17 @@ export interface Sheet { /** Specifies the border for the cell in the Spreadsheet. * @Default {[]} */ - border?: SheetsBorder[]; + border?: Array; + + /** Specifies the cell types for a cell or range in Spreadsheet. + * @Default {[]} + */ + cellTypes?: Array; /** Specifies the conditional formatting for the range of cell in Spreadsheet. * @Default {[]} */ - cFormatRule?: SheetsCFormatRule[]; + cFormatRule?: Array; /** Gets or sets a value that indicates to define column count in the Spreadsheet. * @Default {21} @@ -41166,6 +41190,16 @@ export interface Sheet { */ fieldAsColumnHeader?: boolean; + /** Gets or sets a value to freeze rows in the Spreadsheet. + * @Default {0} + */ + frozenRows?: number; + + /** Gets or sets a value to freeze columns in the Spreadsheet. + * @Default {0} + */ + frozenColumns?: number; + /** Specifies the header styles for the headers in datasource range. * @Default {null} */ @@ -41174,17 +41208,17 @@ export interface Sheet { /** To hide the specified columns in Spreadsheet. * @Default {[]} */ - hideColumns?: any[]; + hideColumns?: Array; /** To hide the specified rows in Spreadsheet. * @Default {[]} */ - hideRows?: any[]; + hideRows?: Array; /** To merge specified ranges in Spreadsheet. * @Default {[]} */ - mergeCells?: any[]; + mergeCells?: Array; /** Specifies the primary key for the datasource in Spreadsheet. */ @@ -41198,7 +41232,7 @@ export interface Sheet { /** Specifies single range or multiple range settings for a sheet in Spreadsheet. * @Default {[]} */ - rangeSettings?: SheetsRangeSetting[]; + rangeSettings?: Array; /** Gets or sets a value that indicates to define row count in the Spreadsheet. * @Default {20} @@ -41208,7 +41242,7 @@ export interface Sheet { /** Specifies the rows for a sheet in Spreadsheet. * @Default {[]} */ - rows?: SheetsRow[]; + rows?: Array; /** Gets or sets a value that indicates whether to show or hide grid lines in the Spreadsheet. * @Default {true} @@ -41231,7 +41265,7 @@ export interface Sheet { startCell?: string; } -enum AutoFillOptions { +enum AutoFillOptions{ ///Specifies the CopyCells property in AutoFillOptions. CopyCells, @@ -41250,7 +41284,7 @@ enum AutoFillOptions { } -enum scrollMode { +enum scrollMode{ ///To enable Infinite scroll mode for Spreadsheet. Infinite, @@ -41260,7 +41294,7 @@ enum scrollMode { } -enum SelectionType { +enum SelectionType{ ///To select only Column in Spreadsheet. Column, @@ -41273,7 +41307,7 @@ enum SelectionType { } -enum SelectionUnit { +enum SelectionUnit{ ///To enable Single selection in Spreadsheet Single, @@ -41286,7 +41320,7 @@ enum SelectionUnit { } -enum BorderType { +enum BorderType{ ///To apply top border for the given range of cell. Top, @@ -41320,7 +41354,7 @@ enum BorderType { } -enum CFormatRule { +enum CFormatRule{ ///To identify greater than values in the given range of cells. GreaterThan, @@ -41342,7 +41376,7 @@ enum CFormatRule { } -enum CFormatHighlightColor { +enum CFormatHighlightColor{ ///Highlights red with dark red text color. RedFillwithDarkRedText, @@ -41361,7 +41395,7 @@ enum CFormatHighlightColor { } -enum ChartProperties { +enum ChartProperties{ ///Specifies to make the data label center of the chart. DataLabelCenter, @@ -41434,10 +41468,11 @@ enum ChartProperties { class PdfViewer extends ej.Widget { static fn: PdfViewer; - constructor(element: JQuery | Element, options?: PdfViewer.Model); + constructor(element: JQuery, options?: PdfViewer.Model); + constructor(element: Element, options?: PdfViewer.Model); static Locale: any; - model: PdfViewer.Model; - defaults: PdfViewer.Model; + model:PdfViewer.Model; + defaults:PdfViewer.Model; /** Loads the document with the filename and displays it in PDF viewer. * @param {string} File name to be loaded @@ -41547,7 +41582,7 @@ class PdfViewer extends ej.Widget { */ unload(): void; } -export namespace PdfViewer { +export module PdfViewer{ export interface Model { @@ -41616,34 +41651,37 @@ export interface Model { fileName?: string; /** Triggers when the PDF document gets loaded and is ready to view in the Control. */ - documentLoad?(e: DocumentLoadEventArgs): void; + documentLoad? (e: DocumentLoadEventArgs): void; + + /** Triggers when the PDF document gets unloaded from the PDF viewer. */ + documentUnload? (e: DocumentUnloadEventArgs): void; /** Triggers when there is change in current page number. */ - pageChange?(e: PageChangeEventArgs): void; + pageChange? (e: PageChangeEventArgs): void; /** Triggers when there is change in the magnification value. */ - zoomChange?(e: ZoomChangeEventArgs): void; + zoomChange? (e: ZoomChangeEventArgs): void; /** Triggers when hyperlink in the PDF Document is clicked */ - hyperlinkClick?(e: HyperlinkClickEventArgs): void; + hyperlinkClick? (e: HyperlinkClickEventArgs): void; /** Triggers before the printing starts. */ - beforePrint?(e: BeforePrintEventArgs): void; + beforePrint? (e: BeforePrintEventArgs): void; /** Triggers after the printing is completed. */ - afterPrint?(e: AfterPrintEventArgs): void; + afterPrint? (e: AfterPrintEventArgs): void; /** Triggers when the mouse click is performed over the page of the PDF document. */ - pageClick?(e: PageClickEventArgs): void; + pageClick? (e: PageClickEventArgs): void; /** Triggers when the client buffering process starts. */ - bufferStart?(e: BufferStartEventArgs): void; + bufferStart? (e: BufferStartEventArgs): void; /** Triggers when the client buffering process ends. */ - bufferEnd?(e: BufferEndEventArgs): void; + bufferEnd? (e: BufferEndEventArgs): void; /** Triggers when PDF viewer control is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; } export interface DocumentLoadEventArgs { @@ -41659,6 +41697,25 @@ export interface DocumentLoadEventArgs { /** Returns the name of the event */ type?: string; + + /** Returns the PDF document name displaying in the PDF viewer. + */ + fileName?: string; +} + +export interface DocumentUnloadEventArgs { + + /** true, if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** Returns the PDF viewer model + */ + model?: any; + + /** Returns the name of the event + */ + type?: string; } export interface PageChangeEventArgs { @@ -41858,7 +41915,7 @@ export interface ServerActionSettings { download?: string; } -enum ToolbarItems { +enum ToolbarItems{ ///Shows only magnification tools in the toolbar. MagnificationTools, @@ -41877,7 +41934,7 @@ enum ToolbarItems { } -enum PdfService { +enum PdfService{ ///Denotes that the service is located in the local project Local, @@ -41887,9 +41944,9 @@ enum PdfService { } -enum LinkTarget { +enum LinkTarget{ - ///Opens the hyperlink in the same tab of the browser. + ///Opens the hyperlink in the same tab of the browser. Default, ///Opens the hyperlink in a new tab of the browser. @@ -41903,10 +41960,11 @@ enum LinkTarget { class SpellCheck extends ej.Widget { static fn: SpellCheck; - constructor(element: JQuery | Element, options?: SpellCheck.Model); + constructor(element: JQuery, options?: SpellCheck.Model); + constructor(element: Element, options?: SpellCheck.Model); static Locale: any; - model: SpellCheck.Model; - defaults: SpellCheck.Model; + model:SpellCheck.Model; + defaults:SpellCheck.Model; /** Open the dialog to correct the spelling of the target content. * @returns {void} @@ -41963,7 +42021,7 @@ class SpellCheck extends ej.Widget { */ addToDictionary(customWord: string): any; } -export namespace SpellCheck { +export module SpellCheck{ export interface Model { @@ -41989,7 +42047,7 @@ export interface Model { /** To ignore the words from the error word consideration. * @Default {[]} */ - ignoreWords?: any[]; + ignoreWords?: Array; /** Holds all options related to the context menu settings of SpellCheck. */ @@ -42010,39 +42068,40 @@ export interface Model { controlsToValidate?: string; /** Triggers on the success of AJAX call request. */ - actionSuccess?(e: ActionSuccessEventArgs): void; + actionSuccess? (e: ActionSuccessEventArgs): void; /** Triggers on the AJAX call request beginning. */ - actionBegin?(e: ActionBeginEventArgs): void; + actionBegin? (e: ActionBeginEventArgs): void; /** Triggers when the AJAX call request failure. */ - actionFailure?(e: ActionFailureEventArgs): void; + actionFailure? (e: ActionFailureEventArgs): void; /** Triggers when the dialog mode spell check starting. */ - start?(e: StartEventArgs): void; + start? (e: StartEventArgs): void; /** Triggers when the spell check operations completed through dialog mode. */ - complete?(e: CompleteEventArgs): void; + complete? (e: CompleteEventArgs): void; /** Triggers before context menu opening. */ - contextOpen?(e: ContextOpenEventArgs): void; + contextOpen? (e: ContextOpenEventArgs): void; /** Triggers when the context menu item clicked. */ - contextClick?(e: ContextClickEventArgs): void; + contextClick? (e: ContextClickEventArgs): void; /** Triggers before the spell check dialog opens. */ - dialogBeforeOpen?(e: DialogBeforeOpenEventArgs): void; + dialogBeforeOpen? (e: DialogBeforeOpenEventArgs): void; + /** Triggers after the spell check dialog opens. */ - dialogOpen?(e: DialogOpenEventArgs): void; + dialogOpen? (e: DialogOpenEventArgs): void; /** Triggers when the spell check dialog closed. */ - dialogClose?(e: DialogCloseEventArgs): void; + dialogClose? (e: DialogCloseEventArgs): void; /** Triggers when the spell check control performing the spell check operations such as ignore, ignoreAll, change, changeAll and addToDictionary. */ - validating?(e: ValidatingEventArgs): void; + validating? (e: ValidatingEventArgs): void; /** Triggers before loading the target HTML element text into the dialog sentence area. */ - targetUpdating?(e: TargetUpdatingEventArgs): void; + targetUpdating? (e: TargetUpdatingEventArgs): void; } export interface ActionSuccessEventArgs { @@ -42383,11 +42442,10 @@ export interface ContextMenuSettings { */ enable?: boolean; - /** Contains all the default context menu options that are applicable for SpellCheck. It also supports adding custom menu items. - * All the SpellCheck related context menu items are grouped under this menu collection. + /** Contains all the default context menu options that are applicable for SpellCheck. It also supports adding custom menu items. All the SpellCheck related context menu items are grouped under this menu collection. * @Default {{% highlight javascript %}[{ id: IgnoreAll, text: Ignore All },{ id: AddToDictionary, text: Add To Dictionary }]{% endhighlight %}} */ - menuItems?: any[]; + menuItems?: Array; } export interface IgnoreSettings { @@ -42426,10 +42484,11 @@ export interface IgnoreSettings { class DocumentEditor extends ej.Widget { static fn: DocumentEditor; - constructor(element: JQuery | Element, options?: DocumentEditor.Model); + constructor(element: JQuery, options?: DocumentEditor.Model); + constructor(element: Element, options?: DocumentEditor.Model); static Locale: any; - model: DocumentEditor.Model; - defaults: DocumentEditor.Model; + model:DocumentEditor.Model; + defaults:DocumentEditor.Model; /** Loads the document from specified path using web API provided by importUrl. * @param {string} Specifies the file path. @@ -42474,7 +42533,7 @@ class DocumentEditor extends ej.Widget { */ find(text: string): void; } -export namespace DocumentEditor { +export module DocumentEditor{ export interface Model { @@ -42483,16 +42542,16 @@ export interface Model { importExportSettings?: ImportExportSettings; /** Triggers when the document changes. */ - onDocumentChange?(e: OnDocumentChangeEventArgs): void; + onDocumentChange? (e: OnDocumentChangeEventArgs): void; /** Triggers when the selection changes. */ - onSelectionChange?(e: OnSelectionChangeEventArgs): void; + onSelectionChange? (e: OnSelectionChangeEventArgs): void; /** Triggers when the zoom factor changes. */ - onZoomFactorChange?(e: OnZoomFactorChangeEventArgs): void; + onZoomFactorChange? (e: OnZoomFactorChangeEventArgs): void; /** Triggers when the hyperlink is clicked. */ - onRequestNavigate?(e: OnRequestNavigateEventArgs): void; + onRequestNavigate? (e: OnRequestNavigateEventArgs): void; } export interface OnDocumentChangeEventArgs { @@ -42568,14 +42627,15 @@ export interface ImportExportSettings { } } -declare namespace ej.datavisualization { - +declare module ej.datavisualization { + class SymbolPalette extends ej.Widget { static fn: SymbolPalette; - constructor(element: JQuery | Element, options?: SymbolPalette.Model); + constructor(element: JQuery, options?: SymbolPalette.Model); + constructor(element: Element, options?: SymbolPalette.Model); static Locale: any; - model: SymbolPalette.Model; - defaults: SymbolPalette.Model; + model:SymbolPalette.Model; + defaults:SymbolPalette.Model; /** Add items to Palettes at runtime * @param {string} name of the Palette @@ -42591,7 +42651,7 @@ class SymbolPalette extends ej.Widget { */ removePaletteItem(paletteName: string, node: any): void; } -export namespace SymbolPalette { +export module SymbolPalette{ export interface Model { @@ -42637,7 +42697,7 @@ export interface Model { /** An array of JSON objects, where each object represents a node/connector * @Default {[]} */ - palettes?: Palette[]; + palettes?: Array; /** Defines the preview height of the symbols * @Default {100} @@ -42665,7 +42725,7 @@ export interface Model { width?: number; /** Triggers when a palette item is selected or unselected */ - selectionChange?(e: SelectionChangeEventArgs): void; + selectionChange? (e: SelectionChangeEventArgs): void; } export interface SelectionChangeEventArgs { @@ -42707,16 +42767,17 @@ export interface Palette { /** Defines the palette items * @Default {[]} */ - items?: any[]; + items?: Array; } } class LinearGauge extends ej.Widget { static fn: LinearGauge; - constructor(element: JQuery | Element, options?: LinearGauge.Model); + constructor(element: JQuery, options?: LinearGauge.Model); + constructor(element: Element, options?: LinearGauge.Model); static Locale: any; - model: LinearGauge.Model; - defaults: LinearGauge.Model; + model:LinearGauge.Model; + defaults:LinearGauge.Model; /** destroy the linear gauge all events bound using this._on will be unbind automatically and bring the control to pre-init state. * @returns {void} @@ -43133,7 +43194,7 @@ class LinearGauge extends ej.Widget { */ setTickYDistanceFromScale(): void; } -export namespace LinearGauge { +export module LinearGauge{ export interface Model { @@ -43220,7 +43281,7 @@ export interface Model { /** Specifies the scales * @Default {null} */ - scales?: Scale[]; + scales?: Array; /** Specifies the theme for Linear gauge. See LinearGauge.Themes * @Default {flatlight} @@ -43248,43 +43309,43 @@ export interface Model { width?: number; /** Triggers while the bar pointer are being drawn on the gauge. */ - drawBarPointers?(e: DrawBarPointersEventArgs): void; + drawBarPointers? (e: DrawBarPointersEventArgs): void; /** Triggers while the customLabel are being drawn on the gauge. */ - drawCustomLabel?(e: DrawCustomLabelEventArgs): void; + drawCustomLabel? (e: DrawCustomLabelEventArgs): void; /** Triggers while the Indicator are being drawn on the gauge. */ - drawIndicators?(e: DrawIndicatorsEventArgs): void; + drawIndicators? (e: DrawIndicatorsEventArgs): void; /** Triggers while the label are being drawn on the gauge. */ - drawLabels?(e: DrawLabelsEventArgs): void; + drawLabels? (e: DrawLabelsEventArgs): void; /** Triggers while the marker are being drawn on the gauge. */ - drawMarkerPointers?(e: DrawMarkerPointersEventArgs): void; + drawMarkerPointers? (e: DrawMarkerPointersEventArgs): void; /** Triggers while the range are being drawn on the gauge. */ - drawRange?(e: DrawRangeEventArgs): void; + drawRange? (e: DrawRangeEventArgs): void; /** Triggers while the ticks are being drawn on the gauge. */ - drawTicks?(e: DrawTicksEventArgs): void; + drawTicks? (e: DrawTicksEventArgs): void; /** Triggers when the gauge is initialized. */ - init?(e: InitEventArgs): void; + init? (e: InitEventArgs): void; /** Triggers while the gauge start to Load. */ - load?(e: LoadEventArgs): void; + load? (e: LoadEventArgs): void; /** Triggers when the left mouse button is clicked. */ - mouseClick?(e: MouseClickEventArgs): void; + mouseClick? (e: MouseClickEventArgs): void; /** Triggers when clicking and dragging the mouse pointer over the gauge pointer. */ - mouseClickMove?(e: MouseClickMoveEventArgs): void; + mouseClickMove? (e: MouseClickMoveEventArgs): void; /** Triggers when the mouse click is released. */ - mouseClickUp?(e: MouseClickUpEventArgs): void; + mouseClickUp? (e: MouseClickUpEventArgs): void; /** Triggers while the rendering of the gauge completed. */ - renderComplete?(e: RenderCompleteEventArgs): void; + renderComplete? (e: RenderCompleteEventArgs): void; } export interface DrawBarPointersEventArgs { @@ -44152,7 +44213,7 @@ export interface ScalesIndicator { /** Specifies the state ranges in bar indicators * @Default {Array} */ - stateRanges?: ScalesIndicatorsStateRange[]; + stateRanges?: Array; /** Specifies the textLocation in bar indicators * @Default {null} @@ -44464,7 +44525,7 @@ export interface Scale { /** Specifies the scaleBar Gradient of bar pointer * @Default {Array} */ - barPointers?: ScalesBarPointer[]; + barPointers?: Array; /** Specifies the border of the Scale. * @Default {null} @@ -44474,7 +44535,7 @@ export interface Scale { /** Specifies the customLabel * @Default {Array} */ - customLabels?: ScalesCustomLabel[]; + customLabels?: Array; /** Specifies the scale Direction of the Scale. See Directions * @Default {CounterClockwise} @@ -44484,12 +44545,12 @@ export interface Scale { /** Specifies the indicator * @Default {Array} */ - indicators?: ScalesIndicator[]; + indicators?: Array; /** Specifies the labels. * @Default {Array} */ - labels?: ScalesLabel[]; + labels?: Array; /** Specifies the scaleBar Length. * @Default {290} @@ -44504,7 +44565,7 @@ export interface Scale { /** Specifies the markerPointers * @Default {Array} */ - markerPointers?: ScalesMarkerPointer[]; + markerPointers?: Array; /** Specifies the maximum of the Scale. * @Default {null} @@ -44534,7 +44595,7 @@ export interface Scale { /** Specifies the ranges in the tick. * @Default {Array} */ - ranges?: ScalesRange[]; + ranges?: Array; /** Specifies the shadowOffset. * @Default {0} @@ -44579,7 +44640,7 @@ export interface Scale { /** Specifies the ticks in the scale. * @Default {Array} */ - ticks?: ScalesTick[]; + ticks?: Array; /** Specifies the scaleBar type .See ScaleType * @Default {Rectangle} @@ -44610,8 +44671,10 @@ export interface Tooltip { templateID?: string; } } -namespace LinearGauge { -enum OuterCustomLabelPosition { +module LinearGauge +{ +enum OuterCustomLabelPosition +{ //string Left, //string @@ -44622,8 +44685,10 @@ Top, Bottom, } } -namespace LinearGauge { -enum FontStyle { +module LinearGauge +{ +enum FontStyle +{ //string Bold, //string @@ -44636,16 +44701,20 @@ Strikeout, Underline, } } -namespace LinearGauge { -enum Direction { +module LinearGauge +{ +enum Direction +{ //string Clockwise, //string CounterClockwise, } } -namespace LinearGauge { -enum IndicatorTypes { +module LinearGauge +{ +enum IndicatorTypes +{ //string Rectangle, //string @@ -44656,8 +44725,10 @@ RoundedRectangle, Text, } } -namespace LinearGauge { -enum PointerPlacement { +module LinearGauge +{ +enum PointerPlacement +{ //string Near, //string @@ -44666,24 +44737,30 @@ Far, Center, } } -namespace LinearGauge { -enum ScaleType { +module LinearGauge +{ +enum ScaleType +{ //string Major, //string Minor, } } -namespace LinearGauge { -enum UnitTextPlacement { +module LinearGauge +{ +enum UnitTextPlacement +{ //string Back, //string From, } } -namespace LinearGauge { -enum MarkerType { +module LinearGauge +{ +enum MarkerType +{ //string Rectangle, //string @@ -44710,16 +44787,20 @@ Trapezoid, RoundedRectangle, } } -namespace LinearGauge { -enum TicksType { +module LinearGauge +{ +enum TicksType +{ //string Majorinterval, //string Minorinterval, } } -namespace LinearGauge { -enum Themes { +module LinearGauge +{ +enum Themes +{ //string FlatLight, //string @@ -44729,10 +44810,11 @@ FlatDark, class CircularGauge extends ej.Widget { static fn: CircularGauge; - constructor(element: JQuery | Element, options?: CircularGauge.Model); + constructor(element: JQuery, options?: CircularGauge.Model); + constructor(element: Element, options?: CircularGauge.Model); static Locale: any; - model: CircularGauge.Model; - defaults: CircularGauge.Model; + model:CircularGauge.Model; + defaults:CircularGauge.Model; /** destroy the circular gauge widget. all events bound using this._on will be unbind automatically and bring the control to pre-init state. * @returns {void} @@ -45154,7 +45236,7 @@ class CircularGauge extends ej.Widget { */ setTickWidth(): void; } -export namespace CircularGauge { +export module CircularGauge{ export interface Model { @@ -45236,7 +45318,7 @@ export interface Model { /** Specify the pointers, ticks, labels, indicators, ranges of circular gauge * @Default {null} */ - scales?: Scale[]; + scales?: Array; /** Specify the theme of circular gauge. * @Default {flatlight} @@ -45259,40 +45341,40 @@ export interface Model { width?: number; /** Triggers while the custom labels are being drawn on the gauge. */ - drawCustomLabel?(e: DrawCustomLabelEventArgs): void; + drawCustomLabel? (e: DrawCustomLabelEventArgs): void; /** Triggers while the indicators are being started to drawn on the gauge. */ - drawIndicators?(e: DrawIndicatorsEventArgs): void; + drawIndicators? (e: DrawIndicatorsEventArgs): void; /** Triggers while the labels are being drawn on the gauge. */ - drawLabels?(e: DrawLabelsEventArgs): void; + drawLabels? (e: DrawLabelsEventArgs): void; /** Triggers while the pointer cap is being drawn on the gauge. */ - drawPointerCap?(e: DrawPointerCapEventArgs): void; + drawPointerCap? (e: DrawPointerCapEventArgs): void; /** Triggers while the pointers are being drawn on the gauge. */ - drawPointers?(e: DrawPointersEventArgs): void; + drawPointers? (e: DrawPointersEventArgs): void; /** Triggers when the ranges begin to be getting drawn on the gauge. */ - drawRange?(e: DrawRangeEventArgs): void; + drawRange? (e: DrawRangeEventArgs): void; /** Triggers while the ticks are being drawn on the gauge. */ - drawTicks?(e: DrawTicksEventArgs): void; + drawTicks? (e: DrawTicksEventArgs): void; /** Triggers while the gauge start to Load. */ - load?(e: LoadEventArgs): void; + load? (e: LoadEventArgs): void; /** Triggers when the left mouse button is clicked. */ - mouseClick?(e: MouseClickEventArgs): void; + mouseClick? (e: MouseClickEventArgs): void; /** Triggers when clicking and dragging the mouse pointer over the gauge pointer. */ - mouseClickMove?(e: MouseClickMoveEventArgs): void; + mouseClickMove? (e: MouseClickMoveEventArgs): void; /** Triggers when the mouse click is released. */ - mouseClickUp?(e: MouseClickUpEventArgs): void; + mouseClickUp? (e: MouseClickUpEventArgs): void; /** Triggers when the rendering of the gauge is completed. */ - renderComplete?(e: RenderCompleteEventArgs): void; + renderComplete? (e: RenderCompleteEventArgs): void; } export interface DrawCustomLabelEventArgs { @@ -46013,7 +46095,7 @@ export interface ScalesIndicator { /** Specify the various states of circular gauge * @Default {Array} */ - stateRanges?: ScalesIndicatorsStateRange[]; + stateRanges?: Array; /** Specify indicator style of circular gauge. See IndicatorType * @Default {Circle} @@ -46446,17 +46528,17 @@ export interface Scale { /** Specify the custom labels for the scales. * @Default {Array} */ - customLabels?: ScalesCustomLabel[]; + customLabels?: Array; /** Specify representing state of circular gauge * @Default {Array} */ - indicators?: ScalesIndicator[]; + indicators?: Array; /** Specify the text values displayed in a meaningful manner alongside the ticks of circular gauge * @Default {Array} */ - labels?: ScalesLabel[]; + labels?: Array; /** Specify majorIntervalValue of circular gauge * @Default {10} @@ -46491,7 +46573,7 @@ export interface Scale { /** Specify pointers value of circular gauge * @Default {Array} */ - pointers?: ScalesPointer[]; + pointers?: Array; /** Specify scale radius of circular gauge * @Default {170} @@ -46501,7 +46583,7 @@ export interface Scale { /** Specify ranges value of circular gauge * @Default {Array} */ - ranges?: ScalesRange[]; + ranges?: Array; /** Specify shadowOffset value of circular gauge * @Default {0} @@ -46551,7 +46633,7 @@ export interface Scale { /** Specify subGauge of circular gauge * @Default {Array} */ - subGauges?: ScalesSubGauge[]; + subGauges?: Array; /** Specify sweepAngle of circular gauge * @Default {310} @@ -46561,7 +46643,7 @@ export interface Scale { /** Specify ticks of circular gauge * @Default {Array} */ - ticks?: ScalesTick[]; + ticks?: Array; } export interface Tooltip { @@ -46582,16 +46664,20 @@ export interface Tooltip { templateID?: string; } } -namespace CircularGauge { -enum FrameType { +module CircularGauge +{ +enum FrameType +{ //string FullCircle, //string HalfCircle, } } -namespace CircularGauge { -enum gaugePosition { +module CircularGauge +{ +enum gaugePosition +{ //string TopLeft, //string @@ -46612,8 +46698,10 @@ BottomRight, BottomCenter, } } -namespace CircularGauge { -enum CustomLabelPositionType { +module CircularGauge +{ +enum CustomLabelPositionType +{ //string Top, //string @@ -46624,16 +46712,20 @@ Right, Left, } } -namespace CircularGauge { -enum Direction { +module CircularGauge +{ +enum Direction +{ //string Clockwise, //string CounterClockwise, } } -namespace CircularGauge { -enum IndicatorTypes { +module CircularGauge +{ +enum IndicatorTypes +{ //string Rectangle, //string @@ -46646,32 +46738,40 @@ RoundedRectangle, Image, } } -namespace CircularGauge { -enum Placement { +module CircularGauge +{ +enum Placement +{ //string Near, //string Far, } } -namespace CircularGauge { -enum LabelType { +module CircularGauge +{ +enum LabelType +{ //string Major, //string Minor, } } -namespace CircularGauge { -enum UnitTextPlacement { +module CircularGauge +{ +enum UnitTextPlacement +{ //string Back, //string Front, } } -namespace CircularGauge { -enum MarkerType { +module CircularGauge +{ +enum MarkerType +{ //string Rectangle, //string @@ -46698,8 +46798,10 @@ RoundedRectangle, Image, } } -namespace CircularGauge { -enum NeedleType { +module CircularGauge +{ +enum NeedleType +{ //string Triangle, //string @@ -46712,8 +46814,10 @@ Image, Trapezoid, } } -namespace CircularGauge { -enum PointerType { +module CircularGauge +{ +enum PointerType +{ //string Needle, //string @@ -46723,10 +46827,11 @@ Marker, class DigitalGauge extends ej.Widget { static fn: DigitalGauge; - constructor(element: JQuery | Element, options?: DigitalGauge.Model); + constructor(element: JQuery, options?: DigitalGauge.Model); + constructor(element: Element, options?: DigitalGauge.Model); static Locale: any; - model: DigitalGauge.Model; - defaults: DigitalGauge.Model; + model:DigitalGauge.Model; + defaults:DigitalGauge.Model; /** To destroy the digital gauge * @returns {void} @@ -46771,7 +46876,7 @@ class DigitalGauge extends ej.Widget { */ setValue(itemIndex: number, value: string): void; } -export namespace DigitalGauge { +export module DigitalGauge{ export interface Model { @@ -46793,7 +46898,7 @@ export interface Model { /** Specifies the items for the DigitalGauge. * @Default {null} */ - items?: Item[]; + items?: Array; /** Specifies the matrixSegmentData for the DigitalGauge. */ @@ -46819,16 +46924,16 @@ export interface Model { width?: number; /** Triggers when the gauge is initialized. */ - init?(e: InitEventArgs): void; + init? (e: InitEventArgs): void; /** Triggers when the gauge item rendering. */ - itemRendering?(e: ItemRenderingEventArgs): void; + itemRendering? (e: ItemRenderingEventArgs): void; /** Triggers when the gauge is start to load. */ - load?(e: LoadEventArgs): void; + load? (e: LoadEventArgs): void; /** Triggers when the gauge render is completed. */ - renderComplete?(e: RenderCompleteEventArgs): void; + renderComplete? (e: RenderCompleteEventArgs): void; } export interface InitEventArgs { @@ -47107,8 +47212,10 @@ export interface Item { value?: string; } } -namespace DigitalGauge { -enum CharacterType { +module DigitalGauge +{ +enum CharacterType +{ //string SevenSegment, //string @@ -47121,8 +47228,10 @@ EightCrossEightDotMatrix, EightCrossEightSquareMatrix, } } -namespace DigitalGauge { -enum FontStyle { +module DigitalGauge +{ +enum FontStyle +{ //string Normal, //string @@ -47138,14 +47247,14 @@ Strikeout, class Chart extends ej.Widget { static fn: Chart; - constructor(element: JQuery | Element, options?: Chart.Model); + constructor(element: JQuery, options?: Chart.Model); + constructor(element: Element, options?: Chart.Model); static Locale: any; - model: Chart.Model; - defaults: Chart.Model; + model:Chart.Model; + defaults:Chart.Model; /** Animates the series and/or indicators in Chart. When parameter is not passed to this method, then all the series and indicators present in Chart are animated. - * @param {any} If an array collection is passed as parameter, series and indicator objects passed in array collection are animated.ExampleIf a series - * or indicator object is passed to this method, then the specific series or indicator is animated.Example, + * @param {any} If an array collection is passed as parameter, series and indicator objects passed in array collection are animated.ExampleIf a series or indicator object is passed to this method, then the specific series or indicator is animated.Example, * @returns {void} */ animate(options: any): void; @@ -47153,8 +47262,7 @@ class Chart extends ej.Widget { /** Exports chart as an image or to an excel file. Chart can be exported as an image only when exportCanvasRendering option is set to true. * @param {string} Type of the export operation to be performed. Following are the two export types that are supported now,1. 'image'2. 'excel'Example * @param {string} URL of the service, where the chart will be exported to excel.Example, - * @param {boolean} When this parameter is true, all the chart objects initialized to the same document are exported to a single excel file. - * This is an optional parameter. By default, it is false.Example, + * @param {boolean} When this parameter is true, all the chart objects initialized to the same document are exported to a single excel file. This is an optional parameter. By default, it is false.Example, * @returns {any} */ export(type: string, URL: string, exportMultipleChart: boolean): any; @@ -47164,13 +47272,13 @@ class Chart extends ej.Widget { */ redraw(): void; } -export namespace Chart { +export module Chart{ export interface Model { /** Options for adding and customizing annotations in Chart. */ - annotations?: Annotation[]; + annotations?: Array; /** URL of the image to be used as chart background. * @Default {null} @@ -47191,7 +47299,7 @@ export interface Model { /** Options to split Chart into multiple plotting areas vertically. Each object in the collection represents a plotting area in Chart. */ - columnDefinitions?: ColumnDefinition[]; + columnDefinitions?: Array; /** Options for configuring the properties of all the series. You can also override the options for specific series by using series collection. */ @@ -47216,8 +47324,7 @@ export interface Model { */ enableCanvasRendering?: boolean; - /** Controls whether the series has to be rendered at initial loading of chart, this will be useful in scenarios where chart is placed at the bottom of the web page - * and we need to render the series only when the chart is visible while scrolling to the top. + /** Controls whether the series has to be rendered at initial loading of chart, this will be useful in scenarios where chart is placed at the bottom of the web page and we need to render the series only when the chart is visible while scrolling to the top. * @Default {true} */ initSeriesRender?: boolean; @@ -47229,7 +47336,7 @@ export interface Model { /** Options to customize the technical indicators. */ - indicators?: Indicator[]; + indicators?: Array; /** Controls whether Chart has to be responsive while resizing. * @Default {false} @@ -47240,8 +47347,7 @@ export interface Model { */ legend?: Legend; - /** Name of the culture based on which chart should be localized. Number and date time values are localized with respect to the culture name.String type properties like title text are - * not localized automatically. Provide localized text as value to string type properties. + /** Name of the culture based on which chart should be localized. Number and date time values are localized with respect to the culture name.String type properties like title text are not localized automatically. Provide localized text as value to string type properties. * @Default {en-US} */ locale?: string; @@ -47249,32 +47355,26 @@ export interface Model { /** Palette is used to store the series fill color in array and apply the color to series collection in the order of series index. * @Default {null} */ - palette?: any[]; + palette?: Array; /** Options to customize the left, right, top and bottom margins of chart area. */ Margin?: any; - /** Perspective angle of the 3D view. Chart appears closer when perspective angle is decreased, and distant when perspective angle is increased. - * This property is applicable only when 3D view is enabled + /** Perspective angle of the 3D view. Chart appears closer when perspective angle is decreased, and distant when perspective angle is increased.This property is applicable only when 3D view is enabled * @Default {90} */ perspectiveAngle?: number; - /** This is a horizontal axis that contains options to configure axis and it is the primary x axis for all the series in series array. - * To override x axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. - * Then, assign the name to the series’s xAxisName property to link both axis and series. + /** This is a horizontal axis that contains options to configure axis and it is the primary x axis for all the series in series array. To override x axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. Then, assign the name to the seriesĂ¢â‚¬â„¢s xAxisName property to link both axis and series. */ primaryXAxis?: PrimaryXAxis; - /** To override x axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. - * Then, assign the name to the series’s xAxisName property to link both axis and series. + /** To override x axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. Then, assign the name to the seriesĂ¢â‚¬â„¢s xAxisName property to link both axis and series. */ - axes?: Axis[]; + axes?: Array; - /** This is a vertical axis that contains options to configure axis. This is the primary y axis for all the series in series array. - * To override y axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. - * Then, assign the name to the series’s yAxisName property to link both axis and series. + /** This is a vertical axis that contains options to configure axis. This is the primary y axis for all the series in series array. To override y axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. Then, assign the name to the seriesĂ¢â‚¬â„¢s yAxisName property to link both axis and series. */ primaryYAxis?: PrimaryYAxis; @@ -47285,11 +47385,11 @@ export interface Model { /** Options to split Chart into multiple plotting areas horizontally. Each object in the collection represents a plotting area in Chart. */ - rowDefinitions?: RowDefinition[]; + rowDefinitions?: Array; /** Specifies the properties used for customizing the series. */ - series?: Series[]; + series?: Array; /** Controls whether data points has to be displayed side by side or along the depth of the axis. * @Default {false} @@ -47324,116 +47424,115 @@ export interface Model { zooming?: Zooming; /** Fires after the series animation is completed. This event will be triggered for each series when animation is enabled. */ - animationComplete?(e: AnimationCompleteEventArgs): void; + animationComplete? (e: AnimationCompleteEventArgs): void; /** Fires before rendering the labels. This event is fired for each label in axis. You can use this event to add custom text to axis labels. */ - axesLabelRendering?(e: AxesLabelRenderingEventArgs): void; + axesLabelRendering? (e: AxesLabelRenderingEventArgs): void; /** Fires during the initialization of axis labels. */ - axesLabelsInitialize?(e: AxesLabelsInitializeEventArgs): void; + axesLabelsInitialize? (e: AxesLabelsInitializeEventArgs): void; /** Fires during axes range calculation. This event is fired for each axis present in Chart. You can use this event to customize axis range as required. */ - axesRangeCalculate?(e: AxesRangeCalculateEventArgs): void; + axesRangeCalculate? (e: AxesRangeCalculateEventArgs): void; /** Fires before rendering the axis title. This event is triggered for each axis with title. You can use this event to add custom text to axis title. */ - axesTitleRendering?(e: AxesTitleRenderingEventArgs): void; + axesTitleRendering? (e: AxesTitleRenderingEventArgs): void; /** Fires during the calculation of chart area bounds. You can use this event to customize the bounds of chart area. */ - chartAreaBoundsCalculate?(e: ChartAreaBoundsCalculateEventArgs): void; + chartAreaBoundsCalculate? (e: ChartAreaBoundsCalculateEventArgs): void; /** Fires after chart is created. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; /** Fires when chart is destroyed completely. */ - destroy?(e: DestroyEventArgs): void; + destroy? (e: DestroyEventArgs): void; /** Fires before rendering the data labels. This event is triggered for each data label in the series. You can use this event to add custom text in data labels. */ - displayTextRendering?(e: DisplayTextRenderingEventArgs): void; + displayTextRendering? (e: DisplayTextRenderingEventArgs): void; /** Fires during the calculation of legend bounds. You can use this event to customize the bounds of legend. */ - legendBoundsCalculate?(e: LegendBoundsCalculateEventArgs): void; + legendBoundsCalculate? (e: LegendBoundsCalculateEventArgs): void; /** Fires on clicking the legend item. */ - legendItemClick?(e: LegendItemClickEventArgs): void; + legendItemClick? (e: LegendItemClickEventArgs): void; /** Fires when moving mouse over legend item. You can use this event for hit testing on legend items. */ - legendItemMouseMove?(e: LegendItemMouseMoveEventArgs): void; + legendItemMouseMove? (e: LegendItemMouseMoveEventArgs): void; /** Fires before rendering the legend item. This event is fired for each legend item in Chart. You can use this event to customize legend item shape or add custom text to legend item. */ - legendItemRendering?(e: LegendItemRenderingEventArgs): void; + legendItemRendering? (e: LegendItemRenderingEventArgs): void; /** Fires before loading the chart. */ - load?(e: LoadEventArgs): void; + load? (e: LoadEventArgs): void; /** Fires after selected the data in chart. */ - rangeSelected?(e: RangeSelectedEventArgs): void; + rangeSelected? (e: RangeSelectedEventArgs): void; /** Fires on clicking a point in chart. You can use this event to handle clicks made on points. */ - pointRegionClick?(e: PointRegionClickEventArgs): void; + pointRegionClick? (e: PointRegionClickEventArgs): void; /** Fires when mouse is moved over a point. */ - pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; + pointRegionMouseMove? (e: PointRegionMouseMoveEventArgs): void; /** Fires before rendering chart. */ - preRender?(e: PreRenderEventArgs): void; + preRender? (e: PreRenderEventArgs): void; /** Fires after selecting a series. This event is triggered after selecting a series only if selection mode is series. */ - seriesRegionClick?(e: SeriesRegionClickEventArgs): void; + seriesRegionClick? (e: SeriesRegionClickEventArgs): void; /** Fires before rendering a series. This event is fired for each series in Chart. */ - seriesRendering?(e: SeriesRenderingEventArgs): void; + seriesRendering? (e: SeriesRenderingEventArgs): void; /** Fires before rendering the marker symbols. This event is triggered for each marker in Chart. */ - symbolRendering?(e: SymbolRenderingEventArgs): void; + symbolRendering? (e: SymbolRenderingEventArgs): void; /** Fires before rendering the Chart title. You can use this event to add custom text in Chart title. */ - titleRendering?(e: TitleRenderingEventArgs): void; + titleRendering? (e: TitleRenderingEventArgs): void; /** Fires before rendering the tooltip. This event is fired when tooltip is enabled and mouse is hovered on a Chart point. You can use this event to customize tooltip before rendering. */ - toolTipInitialize?(e: ToolTipInitializeEventArgs): void; + toolTipInitialize? (e: ToolTipInitializeEventArgs): void; /** Fires before rendering crosshair tooltip in axis. This event is fired for each axis with crosshair label enabled. You can use this event to customize crosshair label before rendering */ - trackAxisToolTip?(e: TrackAxisToolTipEventArgs): void; + trackAxisToolTip? (e: TrackAxisToolTipEventArgs): void; - /** Fires before rendering trackball tooltip. This event is fired for each series in Chart because trackball tooltip is displayed for all the series. - * You can use this event to customize the text displayed in trackball tooltip. */ - trackToolTip?(e: TrackToolTipEventArgs): void; + /** Fires before rendering trackball tooltip. This event is fired for each series in Chart because trackball tooltip is displayed for all the series. You can use this event to customize the text displayed in trackball tooltip. */ + trackToolTip? (e: TrackToolTipEventArgs): void; /** Fires, on clicking the axis label. */ - axisLabelClick?(e: AxisLabelClickEventArgs): void; + axisLabelClick? (e: AxisLabelClickEventArgs): void; /** Fires on moving mouse over the axis label. */ - axisLabelMouseMove?(e: AxisLabelMouseMoveEventArgs): void; + axisLabelMouseMove? (e: AxisLabelMouseMoveEventArgs): void; /** Fires, on the clicking the chart. */ - chartClick?(e: ChartClickEventArgs): void; + chartClick? (e: ChartClickEventArgs): void; /** Fires on moving mouse over the chart. */ - chartMouseMove?(e: ChartMouseMoveEventArgs): void; + chartMouseMove? (e: ChartMouseMoveEventArgs): void; /** Fires, on double clicking the chart. */ - chartDoubleClick?(e: ChartDoubleClickEventArgs): void; + chartDoubleClick? (e: ChartDoubleClickEventArgs): void; /** Fires on clicking the annotation. */ - annotationClick?(e: AnnotationClickEventArgs): void; + annotationClick? (e: AnnotationClickEventArgs): void; /** Fires, after the chart is resized. */ - afterResize?(e: AfterResizeEventArgs): void; + afterResize? (e: AfterResizeEventArgs): void; /** Fires, when chart size is changing. */ - beforeResize?(e: BeforeResizeEventArgs): void; + beforeResize? (e: BeforeResizeEventArgs): void; /** Fires, when error bar is rendering. */ - errorBarRendering?(e: ErrorBarRenderingEventArgs): void; + errorBarRendering? (e: ErrorBarRenderingEventArgs): void; /** Trigger, after the scrollbar position is changed. */ - scrollChanged?(e: ScrollChangedEventArgs): void; + scrollChanged? (e: ScrollChangedEventArgs): void; /** Event triggered when scroll starts */ - scrollStart?(e: ScrollStartEventArgs): void; + scrollStart? (e: ScrollStartEventArgs): void; /** Event triggered when scroll end */ - scrollEnd?(e: ScrollEndEventArgs): void; + scrollEnd? (e: ScrollEndEventArgs): void; } export interface AnimationCompleteEventArgs { @@ -47459,15 +47558,15 @@ export interface AxesLabelRenderingEventArgs { /** Instance of the corresponding axis. */ - Axis?: any; + axis?: any; /** Formatted text of the respective label. You can also add custom text to the label. */ - LabelText?: string; + Text?: string; /** Actual value of the label. */ - LabelValue?: string; + Value?: string; /** Set this option to true to cancel the event. */ @@ -47638,11 +47737,11 @@ export interface DisplayTextRenderingEventArgs { */ locationY?: number; - /** Index of the series in series Collection whose data label is being rendered + /** Index of the series in series Collection whose data label is being rendered */ seriesIndex?: number; - /** Index of the point in series whose data label is being rendered + /** Index of the point in series whose data label is being rendered */ pointIndex?: number; @@ -47712,7 +47811,7 @@ export interface LegendItemClickEventArgs { */ LegendItem?: any; - /** Options to customize the legend item styles such as border, color, size, etc…, + /** Options to customize the legend item styles such as border, color, size, etcĂ¢â‚¬Â¦, */ style?: any; @@ -47755,11 +47854,11 @@ export interface LegendItemMouseMoveEventArgs { */ LegendItem?: any; - /** Options to customize the legend item styles such as border, color, size, etc…, + /** Options to customize the legend item styles such as border, color, size, etcĂ¢â‚¬Â¦, */ style?: any; - /** Options to customize the legend item styles such as border, color, size, etc…, + /** Options to customize the legend item styles such as border, color, size, etcĂ¢â‚¬Â¦, */ Bounds?: any; @@ -47962,7 +48061,7 @@ export interface SeriesRenderingEventArgs { export interface SymbolRenderingEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -47985,7 +48084,7 @@ export interface SymbolRenderingEventArgs { export interface TitleRenderingEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48012,7 +48111,7 @@ export interface TitleRenderingEventArgs { export interface ToolTipInitializeEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48039,7 +48138,7 @@ export interface ToolTipInitializeEventArgs { export interface TrackAxisToolTipEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48070,7 +48169,7 @@ export interface TrackAxisToolTipEventArgs { export interface TrackToolTipEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48105,7 +48204,7 @@ export interface TrackToolTipEventArgs { export interface AxisLabelClickEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48117,7 +48216,7 @@ export interface AxisLabelClickEventArgs { */ type?: string; - /** X and Y co-ordinate of the labels in chart area. + /** X and Y co-ordinate of the labels in chart area. */ location?: any; @@ -48136,7 +48235,7 @@ export interface AxisLabelClickEventArgs { export interface AxisLabelMouseMoveEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48148,7 +48247,7 @@ export interface AxisLabelMouseMoveEventArgs { */ type?: string; - /** X and Y co-ordinate of the labels in chart area. + /** X and Y co-ordinate of the labels in chart area. */ location?: any; @@ -48167,7 +48266,7 @@ export interface AxisLabelMouseMoveEventArgs { export interface ChartClickEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48179,30 +48278,30 @@ export interface ChartClickEventArgs { */ type?: string; - /** X and Y co-ordinate of the points with respect to chart area. + /** X and Y co-ordinate of the points with respect to chart area. */ location?: any; - /** ID of the target element. + /** ID of the target element. */ id?: string; - /** Width and height of the chart. + /** Width and height of the chart. */ size?: any; - /** x-coordinate of the pointer, relative to the page + /** x-coordinate of the pointer, relative to the page */ pageX?: number; - /** y-coordinate of the pointer, relative to the page + /** y-coordinate of the pointer, relative to the page */ pageY?: number; } export interface ChartMouseMoveEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48214,30 +48313,30 @@ export interface ChartMouseMoveEventArgs { */ type?: string; - /** X and Y co-ordinate of the points with respect to chart area. + /** X and Y co-ordinate of the points with respect to chart area. */ location?: any; - /** ID of the target element. + /** ID of the target element. */ id?: string; - /** Width and height of the chart. + /** Width and height of the chart. */ size?: any; - /** x-coordinate of the pointer, relative to the page + /** x-coordinate of the pointer, relative to the page */ pageX?: number; - /** y-coordinate of the pointer, relative to the page + /** y-coordinate of the pointer, relative to the page */ pageY?: number; } export interface ChartDoubleClickEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48249,30 +48348,30 @@ export interface ChartDoubleClickEventArgs { */ type?: string; - /** X and Y co-ordinate of the points with respect to chart area. + /** X and Y co-ordinate of the points with respect to chart area. */ location?: any; - /** ID of the target element. + /** ID of the target element. */ id?: string; - /** Width and height of the chart. + /** Width and height of the chart. */ size?: any; - /** x-coordinate of the pointer, relative to the page + /** x-coordinate of the pointer, relative to the page */ pageX?: number; - /** y-coordinate of the pointer, relative to the page + /** y-coordinate of the pointer, relative to the page */ pageY?: number; } export interface AnnotationClickEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48284,26 +48383,26 @@ export interface AnnotationClickEventArgs { */ type?: string; - /** X and Y co-ordinate of the annotation in chart area. + /** X and Y co-ordinate of the annotation in chart area. */ location?: any; - /** Information about the annotation, like Coordinate unit, Region, content + /** Information about the annotation, like Coordinate unit, Region, content */ contentData?: any; - /** x-coordinate of the pointer, relative to the page + /** x-coordinate of the pointer, relative to the page */ pageX?: number; - /** y-coordinate of the pointer, relative to the page + /** y-coordinate of the pointer, relative to the page */ pageY?: number; } export interface AfterResizeEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48315,34 +48414,34 @@ export interface AfterResizeEventArgs { */ type?: string; - /** Chart width, after resize + /** Chart width, after resize */ width?: number; - /** Chart height, after resize + /** Chart height, after resize */ height?: number; - /** Chart width, before resize + /** Chart width, before resize */ prevWidth?: number; - /** Chart height, before resize + /** Chart height, before resize */ prevHeight?: number; - /** Chart width, when the chart was first rendered + /** Chart width, when the chart was first rendered */ originalWidth?: number; - /** Chart height, when the chart was first rendered + /** Chart height, when the chart was first rendered */ originalHeight?: number; } export interface BeforeResizeEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48354,26 +48453,26 @@ export interface BeforeResizeEventArgs { */ type?: string; - /** Chart width, before resize + /** Chart width, before resize */ currentWidth?: number; - /** Chart height, before resize + /** Chart height, before resize */ currentHeight?: number; - /** Chart width, after resize + /** Chart width, after resize */ newWidth?: number; - /** Chart height, after resize + /** Chart height, after resize */ newHeight?: number; } export interface ErrorBarRenderingEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48385,7 +48484,7 @@ export interface ErrorBarRenderingEventArgs { */ type?: string; - /** Error bar Object + /** Error bar Object */ errorbar?: any; } @@ -48539,8 +48638,7 @@ export interface Annotation { */ visible?: boolean; - /** Represents the horizontal offset when coordinateUnit is pixels.when coordinateUnit is points, it represents the x-coordinate of axis bounded with xAxisName property - * or primary X axis when xAxisName is not provided.This property is not applicable when coordinateUnit is none. + /** Represents the horizontal offset when coordinateUnit is pixels.when coordinateUnit is points, it represents the x-coordinate of axis bounded with xAxisName property or primary X axis when xAxisName is not provided.This property is not applicable when coordinateUnit is none. * @Default {0} */ x?: number; @@ -48549,8 +48647,7 @@ export interface Annotation { */ xAxisName?: string; - /** Represents the vertical offset when coordinateUnit is pixels.When coordinateUnit is points, it represents the y-coordinate of axis bounded with - * yAxisName property or primary Y axis when yAxisName is not provided.This property is not applicable when coordinateUnit is none. + /** Represents the vertical offset when coordinateUnit is pixels.When coordinateUnit is points, it represents the y-coordinate of axis bounded with yAxisName property or primary Y axis when yAxisName is not provided.This property is not applicable when coordinateUnit is none. * @Default {0} */ y?: number; @@ -48877,7 +48974,7 @@ export interface CommonSeriesOptionsMarkerDataLabel { */ shape?: ej.datavisualization.Chart.Shape|string; - /** Custom template to format the data label content. Use “point.x†and “point.y†as a placeholder text to display the corresponding data point’s x and y value. + /** Custom template to format the data label content. Use Ă¢â‚¬Å“point.xĂ¢â‚¬Â and Ă¢â‚¬Å“point.yĂ¢â‚¬Â as a placeholder text to display the corresponding data pointĂ¢â‚¬â„¢s x and y value. */ template?: string; @@ -48929,7 +49026,7 @@ export interface CommonSeriesOptionsMarker { */ fill?: string; - /** The URL for the Image to be displayed as marker. In order to display image as marker, set series.marker.shape as ‘image’. + /** The URL for the Image to be displayed as marker. In order to display image as marker, set series.marker.shape as Ă¢â‚¬ËœimageĂ¢â‚¬â„¢. */ imageUrl?: string; @@ -49055,7 +49152,7 @@ export interface CommonSeriesOptionsTooltip { */ opacity?: number; - /** Custom template to format the tooltip content. Use “point.x†and “point.y†as a placeholder text to display the corresponding data point’s x and y value. + /** Custom template to format the tooltip content. Use Ă¢â‚¬Å“point.xĂ¢â‚¬Â and Ă¢â‚¬Å“point.yĂ¢â‚¬Â as a placeholder text to display the corresponding data pointĂ¢â‚¬â„¢s x and y value. * @Default {null} */ template?: string; @@ -49160,7 +49257,7 @@ export interface CommonSeriesOptionsErrorBarCap { length?: number; /** Color of the error bar cap. - * @Default {“#000000â€} + * @Default {Ă¢â‚¬Å“#000000Ă¢â‚¬Â} */ fill?: string; } @@ -49668,7 +49765,7 @@ export interface CommonSeriesOptions { /** Option to add the trendlines to chart. */ - trendlines?: CommonSeriesOptionsTrendline[]; + trendlines?: Array; /** Options for customizing the appearance of the series or data point while highlighting. */ @@ -49902,7 +49999,7 @@ export interface IndicatorsTooltip { */ enableAnimation?: boolean; - /** Format of indicator tooltip. Use “point.x†and “point.y†as a placeholder text to display the corresponding data point’s x and y value. + /** Format of indicator tooltip. Use Ă¢â‚¬Å“point.xĂ¢â‚¬Â and Ă¢â‚¬Å“point.yĂ¢â‚¬Â as a placeholder text to display the corresponding data pointĂ¢â‚¬â„¢s x and y value. * @Default {#point.x# : #point.y#} */ format?: string; @@ -50647,8 +50744,7 @@ export interface PrimaryXAxisStripLine { */ width?: number; - /** Specifies the order where the strip line and the series have to be rendered. When Z-order is “behindâ€, strip line is rendered - * under the series and when it is “overâ€, it is rendered above the series. + /** Specifies the order where the strip line and the series have to be rendered. When Z-order is Ă¢â‚¬Å“behindĂ¢â‚¬Â, strip line is rendered under the series and when it is Ă¢â‚¬Å“overĂ¢â‚¬Â, it is rendered above the series. * @Default {over. See ZIndex} */ zIndex?: ej.datavisualization.Chart.ZIndex|string; @@ -50742,19 +50838,17 @@ export interface PrimaryXAxis { */ alternateGridBand?: PrimaryXAxisAlternateGridBand; - /** Specifies where horizontal axis should intersect the vertical axis or vice versa. Value should be provided in axis co-ordinates. - * If provided value is greater than the maximum value of crossing axis, then axis will be placed at the opposite side. + /** Specifies where horizontal axis should intersect the vertical axis or vice versa. Value should be provided in axis co-ordinates. If provided value is greater than the maximum value of crossing axis, then axis will be placed at the opposite side. * @Default {null} */ crossesAt?: number; - /** Name of the axis used for crossing. Vertical axis name should be provided for horizontal axis and vice versa. - * If the provided name does not belongs to a valid axis, then primary X axis or primary Y axis will be used for crossing + /** Name of the axis used for crossing. Vertical axis name should be provided for horizontal axis and vice versa. If the provided name does not belongs to a valid axis, then primary X axis or primary Y axis will be used for crossing * @Default {null} */ crossesInAxis?: string; - /** Category axis can also plot points based on index value of data points. Index based plotting can be enabled by setting ‘isIndexed’ property to true. + /** Category axis can also plot points based on index value of data points. Index based plotting can be enabled by setting Ă¢â‚¬ËœisIndexedĂ¢â‚¬â„¢ property to true. * @Default {false} */ isIndexed?: boolean; @@ -50904,12 +50998,12 @@ export interface PrimaryXAxis { /** Options for customizing the multi level labels. * @Default {[ ]} */ - multiLevelLabels?: PrimaryXAxisMultiLevelLabel[]; + multiLevelLabels?: Array; /** Options for customizing the strip lines. * @Default {[ ]} */ - stripLine?: PrimaryXAxisStripLine[]; + stripLine?: Array; /** Specifies the position of the axis tick lines. * @Default {outside. See TickLinesPosition} @@ -51330,8 +51424,7 @@ export interface AxesStripLine { */ width?: number; - /** Specifies the order where the strip line and the series have to be rendered. When Z-order is “behindâ€, strip line is rendered under the series and when it is “overâ€, - * it is rendered above the series. + /** Specifies the order where the strip line and the series have to be rendered. When Z-order is Ă¢â‚¬Å“behindĂ¢â‚¬Â, strip line is rendered under the series and when it is Ă¢â‚¬Å“overĂ¢â‚¬Â, it is rendered above the series. * @Default {over. See ZIndex} */ zIndex?: ej.datavisualization.Chart.ZIndex|string; @@ -51425,13 +51518,12 @@ export interface Axis { */ alternateGridBand?: AxesAlternateGridBand; - /** Specifies where axis should intersect the vertical axis or vice versa. Value should be provided in axis co-ordinates. If provided value is greater than the maximum value of crossing axis, - * then axis will be placed at the opposite side. + /** Specifies where axis should intersect the vertical axis or vice versa. Value should be provided in axis co-ordinates. If provided value is greater than the maximum value of crossing axis, then axis will be placed at the opposite side. * @Default {null} */ crossesAt?: number; - /** Category axis can also plot points based on index value of data points. Index based plotting can be enabled by setting ‘isIndexed’ property to true. + /** Category axis can also plot points based on index value of data points. Index based plotting can be enabled by setting Ă¢â‚¬ËœisIndexedĂ¢â‚¬â„¢ property to true. * @Default {false} */ isIndexed?: boolean; @@ -51581,12 +51673,12 @@ export interface Axis { /** Options for customizing the multi level labels. * @Default {[ ]} */ - multiLevelLabels?: AxesMultiLevelLabel[]; + multiLevelLabels?: Array; /** Options for customizing the strip lines. * @Default {[ ]} */ - stripLine?: AxesStripLine[]; + stripLine?: Array; /** Specifies the position of the axis tick lines. * @Default {outside. See TickLinesPosition} @@ -51982,7 +52074,7 @@ export interface PrimaryYAxisStripLine { */ start?: number; - /** Indicates whether to render the strip line from the minimum/start value of the axis. This property won’t work when start property is set. + /** Indicates whether to render the strip line from the minimum/start value of the axis. This property wonĂ¢â‚¬â„¢t work when start property is set. * @Default {false} */ startFromAxis?: boolean; @@ -52007,8 +52099,7 @@ export interface PrimaryYAxisStripLine { */ width?: number; - /** Specifies the order in which strip line and the series have to be rendered. When Z-order is “behindâ€, strip line is rendered below the series and - * when it is “overâ€, it is rendered above the series. + /** Specifies the order in which strip line and the series have to be rendered. When Z-order is Ă¢â‚¬Å“behindĂ¢â‚¬Â, strip line is rendered below the series and when it is Ă¢â‚¬Å“overĂ¢â‚¬Â, it is rendered above the series. * @Default {over. See ZIndex} */ zIndex?: ej.datavisualization.Chart.ZIndex|string; @@ -52106,14 +52197,12 @@ export interface PrimaryYAxis { */ axisLine?: PrimaryYAxisAxisLine; - /** Specifies where horizontal axis should intersect the vertical axis or vice versa. Value should be provided in axis co-ordinates. - * If provided value is greater than the maximum value of crossing axis, then axis will be placed at the opposite side. + /** Specifies where horizontal axis should intersect the vertical axis or vice versa. Value should be provided in axis co-ordinates. If provided value is greater than the maximum value of crossing axis, then axis will be placed at the opposite side. * @Default {null} */ crossesAt?: number; - /** Name of the axis used for crossing. Vertical axis name should be provided for horizontal axis and vice versa. If the provided name does not belongs to a valid axis, - * then primary X axis or primary Y axis will be used for crossing + /** Name of the axis used for crossing. Vertical axis name should be provided for horizontal axis and vice versa. If the provided name does not belongs to a valid axis, then primary X axis or primary Y axis will be used for crossing * @Default {null} */ crossesInAxis?: string; @@ -52254,12 +52343,12 @@ export interface PrimaryYAxis { /** Options for customizing the multi level labels. * @Default {[ ]} */ - multiLevelLabels?: PrimaryYAxisMultiLevelLabel[]; + multiLevelLabels?: Array; /** Options for customizing the strip lines. * @Default {[ ]} */ - stripLine?: PrimaryYAxisStripLine[]; + stripLine?: Array; /** Specifies the position of the axis tick lines. * @Default {outside. See TickLinesPosition} @@ -52523,7 +52612,7 @@ export interface SeriesMarkerDataLabel { opacity?: number; /** Background shape of the data label. - * @Default {No shape is rendered by default, so its value is ‘none’. See Shape} + * @Default {No shape is rendered by default, so its value is Ă¢â‚¬ËœnoneĂ¢â‚¬â„¢. See Shape} */ shape?: ej.datavisualization.Chart.Shape|string; @@ -52546,7 +52635,7 @@ export interface SeriesMarkerDataLabel { */ visible?: boolean; - /** Custom template to format the data label content. Use “point.x†and “point.y†as a placeholder text to display the corresponding data point’s x and y value. + /** Custom template to format the data label content. Use Ă¢â‚¬Å“point.xĂ¢â‚¬Â and Ă¢â‚¬Å“point.yĂ¢â‚¬Â as a placeholder text to display the corresponding data pointĂ¢â‚¬â„¢s x and y value. */ template?: string; @@ -52584,7 +52673,7 @@ export interface SeriesMarker { */ fill?: string; - /** The URL for the Image that is to be displayed as marker. In order to display image as marker, set series.marker.shape as ‘image’. + /** The URL for the Image that is to be displayed as marker. In order to display image as marker, set series.marker.shape as Ă¢â‚¬ËœimageĂ¢â‚¬â„¢. */ imageUrl?: string; @@ -52941,7 +53030,7 @@ export interface SeriesPointsMarkerDataLabel { opacity?: number; /** Background shape of the data label. - * @Default {No shape is rendered by default, so its value is ‘none’. See Shape} + * @Default {No shape is rendered by default, so its value is Ă¢â‚¬ËœnoneĂ¢â‚¬â„¢. See Shape} */ shape?: ej.datavisualization.Chart.Shape|string; @@ -52960,7 +53049,7 @@ export interface SeriesPointsMarkerDataLabel { */ visible?: boolean; - /** Custom template to format the data label content. Use “point.x†and “point.y†as a placeholder text to display the corresponding data point’s x and y value. + /** Custom template to format the data label content. Use Ă¢â‚¬Å“point.xĂ¢â‚¬Â and Ă¢â‚¬Å“point.yĂ¢â‚¬Â as a placeholder text to display the corresponding data pointĂ¢â‚¬â„¢s x and y value. */ template?: string; @@ -52998,7 +53087,7 @@ export interface SeriesPointsMarker { */ fill?: string; - /** The URL for the Image that is to be displayed as marker. In order to display image as marker, set series.marker.shape as ‘image’. + /** The URL for the Image that is to be displayed as marker. In order to display image as marker, set series.marker.shape as Ă¢â‚¬ËœimageĂ¢â‚¬â„¢. */ imageUrl?: string; @@ -53170,7 +53259,7 @@ export interface SeriesTooltip { */ opacity?: number; - /** Custom template to format the tooltip content. Use “point.x†and “point.y†as a placeholder text to display the corresponding data point’s x and y value. + /** Custom template to format the tooltip content. Use Ă¢â‚¬Å“point.xĂ¢â‚¬Â and Ă¢â‚¬Å“point.yĂ¢â‚¬Â as a placeholder text to display the corresponding data pointĂ¢â‚¬â„¢s x and y value. * @Default {null} */ template?: string; @@ -53549,7 +53638,7 @@ export interface Series { /** Option to add data points; each point should have x and y property. Also, optionally, you can customize the points color, border, marker by using fill, border and marker options. */ - points?: SeriesPoint[]; + points?: Array; /** Specifies the mode of the pyramid series. * @Default {linear} @@ -53646,7 +53735,7 @@ export interface Series { /** Option to add trendlines to chart. */ - trendlines?: SeriesTrendline[]; + trendlines?: Array; /** Options for customizing the appearance of the series or data point while highlighting. */ @@ -53861,11 +53950,13 @@ export interface Zooming { /** To display user specified buttons in zooming toolbar. * @Default {[zoomIn, zoomOut, zoom, pan, reset]} */ - toolbarItems?: any[]; + toolbarItems?: Array; } } -namespace Chart { -enum CoordinateUnit { +module Chart +{ +enum CoordinateUnit +{ //string None, //string @@ -53874,8 +53965,10 @@ Pixels, Points, } } -namespace Chart { -enum HorizontalAlignment { +module Chart +{ +enum HorizontalAlignment +{ //string Left, //string @@ -53884,16 +53977,20 @@ Right, Middle, } } -namespace Chart { -enum Region { +module Chart +{ +enum Region +{ //string Chart, //string Series, } } -namespace Chart { -enum VerticalAlignment { +module Chart +{ +enum VerticalAlignment +{ //string Top, //string @@ -53902,8 +53999,10 @@ Bottom, Middle, } } -namespace Chart { -enum ExportingType { +module Chart +{ +enum ExportingType +{ //string PNG, //string @@ -53918,40 +54017,50 @@ XLSX, SVG, } } -namespace Chart { -enum ExportingOrientation { +module Chart +{ +enum ExportingOrientation +{ //string Portrait, //string Landscape, } } -namespace Chart { -enum ExportingMode { +module Chart +{ +enum ExportingMode +{ //string ServerSide, //string ClientSide, } } -namespace Chart { -enum Unit { +module Chart +{ +enum Unit +{ //string Percentage, //string Pixel, } } -namespace Chart { -enum ColumnFacet { +module Chart +{ +enum ColumnFacet +{ //string Rectangle, //string Cylinder, } } -namespace Chart { -enum DrawType { +module Chart +{ +enum DrawType +{ //string Line, //string @@ -53960,16 +54069,20 @@ Area, Column, } } -namespace Chart { -enum FontStyle { +module Chart +{ +enum FontStyle +{ //string Normal, //string Italic, } } -namespace Chart { -enum FontWeight { +module Chart +{ +enum FontWeight +{ //string Regular, //string @@ -53978,8 +54091,10 @@ Bold, Lighter, } } -namespace Chart { -enum LabelPosition { +module Chart +{ +enum LabelPosition +{ //string Inside, //string @@ -53988,8 +54103,10 @@ Outside, OutsideExtended, } } -namespace Chart { -enum boxPlotMode { +module Chart +{ +enum boxPlotMode +{ //string Exclusive, //string @@ -53998,8 +54115,10 @@ Inclusive, Normal, } } -namespace Chart { -enum LineCap { +module Chart +{ +enum LineCap +{ //string Butt, //string @@ -54008,8 +54127,10 @@ Round, Square, } } -namespace Chart { -enum LineJoin { +module Chart +{ +enum LineJoin +{ //string Round, //string @@ -54018,16 +54139,20 @@ Bevel, Miter, } } -namespace Chart { -enum ConnectorLineType { +module Chart +{ +enum ConnectorLineType +{ //string Line, //string Bezier, } } -namespace Chart { -enum HorizontalTextAlignment { +module Chart +{ +enum HorizontalTextAlignment +{ //string Center, //string @@ -54036,8 +54161,10 @@ Near, Far, } } -namespace Chart { -enum Shape { +module Chart +{ +enum Shape +{ //string None, //string @@ -54078,8 +54205,10 @@ Image, SeriesType, } } -namespace Chart { -enum TextPosition { +module Chart +{ +enum TextPosition +{ //string Top, //string @@ -54088,8 +54217,10 @@ Bottom, Middle, } } -namespace Chart { -enum VerticalTextAlignment { +module Chart +{ +enum VerticalTextAlignment +{ //string Center, //string @@ -54098,16 +54229,20 @@ Near, Far, } } -namespace Chart { -enum PyramidMode { +module Chart +{ +enum PyramidMode +{ //string Linear, //string Surface, } } -namespace Chart { -enum Type { +module Chart +{ +enum Type +{ //string Area, //string @@ -54164,8 +54299,10 @@ Radar, RangeArea, } } -namespace Chart { -enum EmptyPointMode { +module Chart +{ +enum EmptyPointMode +{ //string Gap, //string @@ -54174,8 +54311,10 @@ Zero, Average, } } -namespace Chart { -enum ErrorBarType { +module Chart +{ +enum ErrorBarType +{ //string FixedValue, //string @@ -54186,8 +54325,10 @@ StandardDeviation, StandardError, } } -namespace Chart { -enum ErrorBarMode { +module Chart +{ +enum ErrorBarMode +{ //string Both, //string @@ -54196,8 +54337,10 @@ Vertical, Horizontal, } } -namespace Chart { -enum ErrorBarDirection { +module Chart +{ +enum ErrorBarDirection +{ //string Both, //string @@ -54206,8 +54349,10 @@ Plus, Minus, } } -namespace Chart { -enum Mode { +module Chart +{ +enum Mode +{ //string Series, //string @@ -54218,16 +54363,20 @@ Cluster, Range, } } -namespace Chart { -enum SelectionType { +module Chart +{ +enum SelectionType +{ //string Single, //string Multiple, } } -namespace Chart { -enum RangeType { +module Chart +{ +enum RangeType +{ //string XY, //string @@ -54236,24 +54385,30 @@ X, Y, } } -namespace Chart { -enum CrosshairMode { +module Chart +{ +enum CrosshairMode +{ //string Float, //string Grouping, } } -namespace Chart { -enum CrosshairType { +module Chart +{ +enum CrosshairType +{ //string Crosshair, //string Trackball, } } -namespace Chart { -enum Alignment { +module Chart +{ +enum Alignment +{ //string Center, //string @@ -54262,8 +54417,10 @@ Near, Far, } } -namespace Chart { -enum Position { +module Chart +{ +enum Position +{ //string Left, //string @@ -54274,8 +54431,10 @@ Top, Bottom, } } -namespace Chart { -enum TextOverflow { +module Chart +{ +enum TextOverflow +{ //string None, //string @@ -54286,16 +54445,20 @@ Wrap, WrapAndTrim, } } -namespace Chart { -enum LabelPlacement { +module Chart +{ +enum LabelPlacement +{ //string OnTicks, //string BetweenTicks, } } -namespace Chart { -enum EdgeLabelPlacement { +module Chart +{ +enum EdgeLabelPlacement +{ //string None, //string @@ -54304,8 +54467,10 @@ Shift, Hide, } } -namespace Chart { -enum IntervalType { +module Chart +{ +enum IntervalType +{ //string Days, //string @@ -54322,8 +54487,10 @@ Months, Years, } } -namespace Chart { -enum LabelIntersectAction { +module Chart +{ +enum LabelIntersectAction +{ //string None, //string @@ -54342,8 +54509,10 @@ Hide, MultipleRows, } } -namespace Chart { -enum LabelAlignment { +module Chart +{ +enum LabelAlignment +{ //string Near, //string @@ -54352,8 +54521,10 @@ Far, Center, } } -namespace Chart { -enum RangePadding { +module Chart +{ +enum RangePadding +{ //string Additional, //string @@ -54364,8 +54535,10 @@ None, Round, } } -namespace Chart { -enum MultiLevelLabelsBorderType { +module Chart +{ +enum MultiLevelLabelsBorderType +{ //string Rectangle, //string @@ -54378,8 +54551,10 @@ Brace, CurlyBrace, } } -namespace Chart { -enum TextAlignment { +module Chart +{ +enum TextAlignment +{ //string MiddleTop, //string @@ -54388,24 +54563,30 @@ MiddleCenter, MiddleBottom, } } -namespace Chart { -enum ZIndex { +module Chart +{ +enum ZIndex +{ //string Inside, //string Over, } } -namespace Chart { -enum TickLinesPosition { +module Chart +{ +enum TickLinesPosition +{ //string Inside, //string Outside, } } -namespace Chart { -enum ValueType { +module Chart +{ +enum ValueType +{ //string Double, //string @@ -54416,8 +54597,10 @@ DateTime, Logarithmic, } } -namespace Chart { -enum Theme { +module Chart +{ +enum Theme +{ //string Azure, //string @@ -54443,17 +54626,18 @@ GradientDark, class RangeNavigator extends ej.Widget { static fn: RangeNavigator; - constructor(element: JQuery | Element, options?: RangeNavigator.Model); + constructor(element: JQuery, options?: RangeNavigator.Model); + constructor(element: Element, options?: RangeNavigator.Model); static Locale: any; - model: RangeNavigator.Model; - defaults: RangeNavigator.Model; + model:RangeNavigator.Model; + defaults:RangeNavigator.Model; /** destroy the range navigator widget * @returns {void} */ _destroy(): void; } -export namespace RangeNavigator { +export module RangeNavigator{ export interface Model { @@ -54472,7 +54656,7 @@ export interface Model { /** Specifies the properties used for customizing the range series. */ - series?: Series[]; + series?: Array; /** Toggles the redrawing of chart on moving the sliders. * @Default {true} @@ -54564,22 +54748,22 @@ export interface Model { yName?: any; /** Fires on load of range navigator. */ - load?(e: LoadEventArgs): void; + load? (e: LoadEventArgs): void; /** Fires after range navigator is loaded. */ - loaded?(e: LoadedEventArgs): void; + loaded? (e: LoadedEventArgs): void; /** Fires on changing the range of range navigator. */ - rangeChanged?(e: RangeChangedEventArgs): void; + rangeChanged? (e: RangeChangedEventArgs): void; /** Fires on changing the scrollbar position of range navigator. */ - scrollChanged?(e: ScrollChangedEventArgs): void; + scrollChanged? (e: ScrollChangedEventArgs): void; /** Fires on when starting to change the scrollbar position of range navigator. */ - scrollStart?(e: ScrollStartEventArgs): void; + scrollStart? (e: ScrollStartEventArgs): void; /** Fires on changes ending the scrollbar position of range navigator. */ - scrollEnd?(e: ScrollEndEventArgs): void; + scrollEnd? (e: ScrollEndEventArgs): void; } export interface LoadEventArgs { @@ -55438,8 +55622,10 @@ export interface ValueAxisSettings { visible?: boolean; } } -namespace RangeNavigator { -enum Type { +module RangeNavigator +{ +enum Type +{ //string Area, //string @@ -55454,8 +55640,10 @@ SplineArea, StepLine, } } -namespace RangeNavigator { -enum IntervalType { +module RangeNavigator +{ +enum IntervalType +{ //string Years, //string @@ -55472,24 +55660,30 @@ Hours, Minutes, } } -namespace RangeNavigator { -enum LabelPlacement { +module RangeNavigator +{ +enum LabelPlacement +{ //string Inside, //string Outside, } } -namespace RangeNavigator { -enum Position { +module RangeNavigator +{ +enum Position +{ //string Top, //string Bottom, } } -namespace RangeNavigator { -enum FontStyle { +module RangeNavigator +{ +enum FontStyle +{ //string Normal, //string @@ -55498,16 +55692,20 @@ Bold, Italic, } } -namespace RangeNavigator { -enum FontWeight { +module RangeNavigator +{ +enum FontWeight +{ //string Regular, //string Lighter, } } -namespace RangeNavigator { -enum HorizontalAlignment { +module RangeNavigator +{ +enum HorizontalAlignment +{ //string Middle, //string @@ -55516,8 +55714,10 @@ Left, Right, } } -namespace RangeNavigator { -enum RangePadding { +module RangeNavigator +{ +enum RangePadding +{ //string Additional, //string @@ -55528,8 +55728,10 @@ None, Round, } } -namespace RangeNavigator { -enum ValueType { +module RangeNavigator +{ +enum ValueType +{ //string Numeric, //string @@ -55539,10 +55741,11 @@ DateTime, class BulletGraph extends ej.Widget { static fn: BulletGraph; - constructor(element: JQuery | Element, options?: BulletGraph.Model); + constructor(element: JQuery, options?: BulletGraph.Model); + constructor(element: Element, options?: BulletGraph.Model); static Locale: any; - model: BulletGraph.Model; - defaults: BulletGraph.Model; + model:BulletGraph.Model; + defaults:BulletGraph.Model; /** To destroy the bullet graph * @returns {void} @@ -55564,7 +55767,7 @@ class BulletGraph extends ej.Widget { */ setFeatureMeasureBarValue(): void; } -export namespace BulletGraph { +export module BulletGraph{ export interface Model { @@ -55614,7 +55817,7 @@ export interface Model { /** Contains property to customize the qualitative ranges. */ - qualitativeRanges?: QualitativeRange[]; + qualitativeRanges?: Array; /** Size of the qualitative range depends up on the specified value. * @Default {32} @@ -55650,28 +55853,28 @@ export interface Model { width?: number; /** Fires on rendering the caption of bullet graph. */ - drawCaption?(e: DrawCaptionEventArgs): void; + drawCaption? (e: DrawCaptionEventArgs): void; /** Fires on rendering the category. */ - drawCategory?(e: DrawCategoryEventArgs): void; + drawCategory? (e: DrawCategoryEventArgs): void; /** Fires on rendering the comparative measure symbol. */ - drawComparativeMeasureSymbol?(e: DrawComparativeMeasureSymbolEventArgs): void; + drawComparativeMeasureSymbol? (e: DrawComparativeMeasureSymbolEventArgs): void; /** Fires on rendering the feature measure bar. */ - drawFeatureMeasureBar?(e: DrawFeatureMeasureBarEventArgs): void; + drawFeatureMeasureBar? (e: DrawFeatureMeasureBarEventArgs): void; /** Fires on rendering the indicator of bullet graph. */ - drawIndicator?(e: DrawIndicatorEventArgs): void; + drawIndicator? (e: DrawIndicatorEventArgs): void; /** Fires on rendering the labels. */ - drawLabels?(e: DrawLabelsEventArgs): void; + drawLabels? (e: DrawLabelsEventArgs): void; /** Fires on rendering the qualitative ranges. */ - drawQualitativeRanges?(e: DrawQualitativeRangesEventArgs): void; + drawQualitativeRanges? (e: DrawQualitativeRangesEventArgs): void; /** Fires on loading bullet graph. */ - load?(e: LoadEventArgs): void; + load? (e: LoadEventArgs): void; } export interface DrawCaptionEventArgs { @@ -55808,9 +56011,6 @@ export interface DrawQualitativeRangesEventArgs { } export interface LoadEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; } export interface CaptionSettingsFont { @@ -55975,8 +56175,7 @@ export interface CaptionSettingsIndicator { */ textAlignment?: ej.datavisualization.BulletGraph.TextAlignment|string; - /** Specifies where indicator text should be anchored when indicator overlaps with other caption group text. Text will be anchored when overlapping caption group text are at same position. - * Anchoring is not applicable for float position. + /** Specifies where indicator text should be anchored when indicator overlaps with other caption group text. Text will be anchored when overlapping caption group text are at same position. Anchoring is not applicable for float position. * @Default {'start'} */ textAnchor?: ej.datavisualization.BulletGraph.TextAnchor|string; @@ -56085,8 +56284,7 @@ export interface CaptionSettingsSubTitle { */ textAlignment?: ej.datavisualization.BulletGraph.TextAlignment|string; - /** Specifies where subtitle text should be anchored when sub title text overlaps with other caption group text. Text will be anchored when overlapping - * caption group text are at same position. Anchoring is not applicable for float position. + /** Specifies where subtitle text should be anchored when sub title text overlaps with other caption group text. Text will be anchored when overlapping caption group text are at same position. Anchoring is not applicable for float position. * @Default {'start'} */ textAnchor?: ej.datavisualization.BulletGraph.TextAnchor|string; @@ -56139,8 +56337,7 @@ export interface CaptionSettings { */ textAlignment?: ej.datavisualization.BulletGraph.TextAlignment|string; - /** Specifies caption text anchoring when caption text overlaps with other caption group text. - * Text will be anchored when overlapping caption group text are at same position. Anchoring is not applicable for float position. + /** Specifies caption text anchoring when caption text overlaps with other caption group text. Text will be anchored when overlapping caption group text are at same position. Anchoring is not applicable for float position. * @Default {'start'} */ textAnchor?: ej.datavisualization.BulletGraph.TextAnchor|string; @@ -56377,7 +56574,7 @@ export interface QuantitativeScaleSettings { /** Contains property to customize the featured measure. */ - featureMeasures?: QuantitativeScaleSettingsFeatureMeasure[]; + featureMeasures?: Array; /** Contains property to customize the fields. */ @@ -56453,8 +56650,10 @@ export interface TooltipSettings { visible?: boolean; } } -namespace BulletGraph { -enum FontStyle { +module BulletGraph +{ +enum FontStyle +{ //string Normal, //string @@ -56463,8 +56662,10 @@ Italic, Oblique, } } -namespace BulletGraph { -enum FontWeight { +module BulletGraph +{ +enum FontWeight +{ //string Normal, //string @@ -56475,8 +56676,10 @@ Bolder, Lighter, } } -namespace BulletGraph { -enum TextAlignment { +module BulletGraph +{ +enum TextAlignment +{ //string Near, //string @@ -56485,8 +56688,10 @@ Far, Center, } } -namespace BulletGraph { -enum TextAnchor { +module BulletGraph +{ +enum TextAnchor +{ //string Start, //string @@ -56495,8 +56700,10 @@ Middle, End, } } -namespace BulletGraph { -enum TextPosition { +module BulletGraph +{ +enum TextPosition +{ //string Top, //string @@ -56509,48 +56716,60 @@ Bottom, Float, } } -namespace BulletGraph { -enum FlowDirection { +module BulletGraph +{ +enum FlowDirection +{ //string Forward, //string Backward, } } -namespace BulletGraph { -enum Orientation { +module BulletGraph +{ +enum Orientation +{ //string Horizontal, //string Vertical, } } -namespace BulletGraph { -enum LabelPlacement { +module BulletGraph +{ +enum LabelPlacement +{ //string Inside, //string Outside, } } -namespace BulletGraph { -enum LabelPosition { +module BulletGraph +{ +enum LabelPosition +{ //string Above, //string Below, } } -namespace BulletGraph { -enum TickPlacement { +module BulletGraph +{ +enum TickPlacement +{ //string Inside, //string Outside, } } -namespace BulletGraph { -enum TickPosition { +module BulletGraph +{ +enum TickPosition +{ //string Below, //string @@ -56562,10 +56781,11 @@ Cross, class Barcode extends ej.Widget { static fn: Barcode; - constructor(element: JQuery | Element, options?: Barcode.Model); + constructor(element: JQuery, options?: Barcode.Model); + constructor(element: Element, options?: Barcode.Model); static Locale: any; - model: Barcode.Model; - defaults: Barcode.Model; + model:Barcode.Model; + defaults:Barcode.Model; /** To disable the barcode * @returns {void} @@ -56577,7 +56797,7 @@ class Barcode extends ej.Widget { */ enable(): void; } -export namespace Barcode { +export module Barcode{ export interface Model { @@ -56585,8 +56805,7 @@ export interface Model { */ barcodeToTextGapHeight?: number; - /** Specifies the height of bars in the Barcode. By modifying the barHeight, the entire barcode height can be customized. - * Please refer to xDimension for two dimensional barcode height customization. + /** Specifies the height of bars in the Barcode. By modifying the barHeight, the entire barcode height can be customized. Please refer to xDimension for two dimensional barcode height customization. */ barHeight?: number; @@ -56602,8 +56821,7 @@ export interface Model { */ enabled?: boolean; - /** Specifies the start and stop encode symbol in the Barcode. In one dimensional barcodes, an additional character is added as start and stop delimiters. - * These symbols are optional and the unique of the symbol allows the reader to determine the direction of the barcode being scanned. + /** Specifies the start and stop encode symbol in the Barcode. In one dimensional barcodes, an additional character is added as start and stop delimiters. These symbols are optional and the unique of the symbol allows the reader to determine the direction of the barcode being scanned. */ encodeStartStopSymbol?: number; @@ -56611,13 +56829,11 @@ export interface Model { */ lightBarColor?: any; - /** Specifies the width of the narrow bars in the barcode. The dark bars in the one dimensional barcode contains random narrow and wide bars based on - * the provided input which can be specified during initialization. + /** Specifies the width of the narrow bars in the barcode. The dark bars in the one dimensional barcode contains random narrow and wide bars based on the provided input which can be specified during initialization. */ narrowBarWidth?: number; - /** Specifies the width of the quiet zone. In barcode, a quiet zone is the blank margin on either side of a barcode which informs the reader where a barcode's symbology starts and stops. - * The purpose of a quiet zone is to prevent the reader from picking up unrelated information. + /** Specifies the width of the quiet zone. In barcode, a quiet zone is the blank margin on either side of a barcode which informs the reader where a barcode's symbology starts and stops. The purpose of a quiet zone is to prevent the reader from picking up unrelated information. */ quietZone?: QuietZone; @@ -56642,7 +56858,7 @@ export interface Model { xDimension?: number; /** Fires after Barcode control is loaded. */ - load?(e: LoadEventArgs): void; + load? (e: LoadEventArgs): void; } export interface LoadEventArgs { @@ -56687,8 +56903,10 @@ export interface QuietZone { top?: number; } } -namespace Barcode { -enum SymbologyType { +module Barcode +{ +enum SymbologyType +{ //Represents the QR code QRBarcode, //Represents the Data Matrix barcode @@ -56718,10 +56936,11 @@ Code128C, class Map extends ej.Widget { static fn: Map; - constructor(element: JQuery | Element, options?: Map.Model); + constructor(element: JQuery, options?: Map.Model); + constructor(element: Element, options?: Map.Model); static Locale: any; - model: Map.Model; - defaults: Map.Model; + model:Map.Model; + defaults:Map.Model; /** Method for navigating to specific shape based on latitude, longitude and zoom level. * @param {number} Pass the latitude value for map @@ -56760,7 +56979,7 @@ class Map extends ej.Widget { */ zoom(level: number, isAnimate: boolean): void; } -export namespace Map { +export module Map{ export interface Model { @@ -56809,31 +57028,31 @@ export interface Model { /** Layer for holding the map shapes */ - layers?: Layer[]; + layers?: Array; /** Triggered on selecting the map markers. */ - markerSelected?(e: MarkerSelectedEventArgs): void; + markerSelected? (e: MarkerSelectedEventArgs): void; /** Triggers while leaving the hovered map shape */ - mouseleave?(e: MouseleaveEventArgs): void; + mouseleave? (e: MouseleaveEventArgs): void; /** Triggers while hovering the map shape. */ - mouseover?(e: MouseoverEventArgs): void; + mouseover? (e: MouseoverEventArgs): void; /** Triggers once map render completed. */ - onRenderComplete?(e: OnRenderCompleteEventArgs): void; + onRenderComplete? (e: OnRenderCompleteEventArgs): void; /** Triggers when map panning ends. */ - panned?(e: PannedEventArgs): void; + panned? (e: PannedEventArgs): void; /** Triggered on selecting the map shapes. */ - shapeSelected?(e: ShapeSelectedEventArgs): void; + shapeSelected? (e: ShapeSelectedEventArgs): void; /** Triggered when map is zoomed-in. */ - zoomedIn?(e: ZoomedInEventArgs): void; + zoomedIn? (e: ZoomedInEventArgs): void; /** Triggers when map is zoomed out. */ - zoomedOut?(e: ZoomedOutEventArgs): void; + zoomedOut? (e: ZoomedOutEventArgs): void; } export interface MarkerSelectedEventArgs { @@ -56975,7 +57194,7 @@ export interface LayersBubbleSettingsColorMappingsRangeColorMapping { /** GradientColors in the bubble layer of map. */ - gradientColors?: any[]; + gradientColors?: Array; /** Color of the bubble layer. * @Default {null} @@ -56988,7 +57207,7 @@ export interface LayersBubbleSettingsColorMappings { /** Specifies the range colorMappings in the bubble layer. * @Default {null} */ - rangeColorMapping?: LayersBubbleSettingsColorMappingsRangeColorMapping[]; + rangeColorMapping?: Array; } export interface LayersBubbleSettings { @@ -57049,7 +57268,7 @@ export interface LayersLabelSettings { /** enable or disable the enableSmartLabel property * @Default {false} */ - enableSmartLabel?: boolean; + enableSmartLabel?: Boolean; /** set the labelLength property * @Default {'2'} @@ -57180,7 +57399,7 @@ export interface LayersShapeSettingsColorMappingsRangeColorMapping { /** Specifies the gradientColors in the shape layer of map. * @Default {null} */ - gradientColors?: any[]; + gradientColors?: Array; } export interface LayersShapeSettingsColorMappingsEqualColorMapping { @@ -57201,12 +57420,12 @@ export interface LayersShapeSettingsColorMappings { /** Specifies the range colorMappings in the shape layer of map. * @Default {null} */ - rangeColorMapping?: LayersShapeSettingsColorMappingsRangeColorMapping[]; + rangeColorMapping?: Array; /** Specifies the equalColorMapping in the shape layer of map. * @Default {null} */ - equalColorMapping?: LayersShapeSettingsColorMappingsEqualColorMapping[]; + equalColorMapping?: Array; } export interface LayersShapeSettings { @@ -57350,7 +57569,7 @@ export interface Layer { /** Specify markers for shape layer. * @Default {[]} */ - markers?: any[]; + markers?: Array; /** Specifies the map marker template for map layer. * @Default {null} @@ -57360,7 +57579,7 @@ export interface Layer { /** Specify selectedMapShapes for shape layer * @Default {[]} */ - selectedMapShapes?: any[]; + selectedMapShapes?: Array; /** Specifies the selection mode of the map. Accepted selection mode values are Default and Multiple. * @Default {default} @@ -57395,8 +57614,10 @@ export interface Layer { urlTemplate?: string; } } -namespace Map { -enum Position { +module Map +{ +enum Position +{ //specifies the none position None, //specifies the topleft position @@ -57419,16 +57640,20 @@ Bottomcenter, Bottomright, } } -namespace Map { -enum LabelOrientation { +module Map +{ +enum LabelOrientation +{ //specifies the horizontal position Horizontal, //specifies the vertical position Vertical, } } -namespace Map { -enum BingMapType { +module Map +{ +enum BingMapType +{ //specifies the aerial type Aerial, //specifies the aerialwithlabel type @@ -57437,24 +57662,30 @@ Aerialwithlabel, Road, } } -namespace Map { -enum LabelSize { +module Map +{ +enum LabelSize +{ //specifies the fixed size Fixed, //specifies the default size Default, } } -namespace Map { -enum GeometryType { +module Map +{ +enum GeometryType +{ //specifies the geographic view of map Geographic, //specifies the normal land view of map Normal, } } -namespace Map { -enum LayerType { +module Map +{ +enum LayerType +{ //specifies the geometry type Geometry, //specifies the osm type @@ -57463,8 +57694,10 @@ Osm, Bing, } } -namespace Map { -enum DockPosition { +module Map +{ +enum DockPosition +{ //specifies the top position Top, //specifies the bottom position @@ -57475,40 +57708,50 @@ Right, Left, } } -namespace Map { -enum LegendIcons { +module Map +{ +enum LegendIcons +{ //specifies the rectangle position Rectangle, //specifies the circle position Circle, } } -namespace Map { -enum Mode { +module Map +{ +enum Mode +{ //specifies the default mode Default, //specifies the interactive mode Interactive, } } -namespace Map { -enum LegendType { +module Map +{ +enum LegendType +{ //specifies the layers type Layers, //specifies the bubbles type Bubbles, } } -namespace Map { -enum SelectionMode { +module Map +{ +enum SelectionMode +{ //specifies the default position Default, //specifies the multiple position Multiple, } } -namespace Map { -enum ColorPalette { +module Map +{ +enum ColorPalette +{ //specifies the palette1 color Palette1, //specifies the palette2 color @@ -57522,17 +57765,18 @@ Custompalette, class TreeMap extends ej.Widget { static fn: TreeMap; - constructor(element: JQuery | Element, options?: TreeMap.Model); + constructor(element: JQuery, options?: TreeMap.Model); + constructor(element: Element, options?: TreeMap.Model); static Locale: any; - model: TreeMap.Model; - defaults: TreeMap.Model; + model:TreeMap.Model; + defaults:TreeMap.Model; /** Method to reload treemap with updated values. * @returns {void} */ refresh(): void; } -export namespace TreeMap { +export module TreeMap{ export interface Model { @@ -57621,7 +57865,7 @@ export interface Model { /** Specifies the group color mapping of the treemap * @Default {[]} */ - groupColorMapping?: GroupColorMapping[]; + groupColorMapping?: Array; /** Specifies the legend settings of the treemap */ @@ -57669,7 +57913,7 @@ export interface Model { /** Specifies the rangeColorMapping settings of the treemap * @Default {[]} */ - rangeColorMapping?: RangeColorMapping[]; + rangeColorMapping?: Array; /** Specifies the selection mode of treemap item. Accepted selection mode values are Default and Multiple. * @Default {default} @@ -57703,12 +57947,12 @@ export interface Model { /** Hold the treeMapItems to be displayed in treemap * @Default {[]} */ - treeMapItems?: any[]; + treeMapItems?: Array; /** Specify levels of treemap for grouped visualization of data * @Default {[]} */ - levels?: Level[]; + levels?: Array; /** Specifies the weight value path of the treemap * @Default {null} @@ -57716,7 +57960,7 @@ export interface Model { weightValuePath?: string; /** Triggers on treemap item selected. */ - treeMapItemSelected?(e: TreeMapItemSelectedEventArgs): void; + treeMapItemSelected? (e: TreeMapItemSelectedEventArgs): void; } export interface TreeMapItemSelectedEventArgs { @@ -57767,7 +58011,7 @@ export interface PaletteColorMapping { /** Specifies the colors of the paletteColorMapping * @Default {[]} */ - colors?: any[]; + colors?: Array; } export interface GroupColorMapping { @@ -57886,7 +58130,7 @@ export interface RangeColorMapping { /** specifies the gradient colors for th given range value * @Default {[]} */ - gradientColors?: any[]; + gradientColors?: Array; /** Specifies the from value for rangeColorMapping. * @Default {-1} @@ -57976,8 +58220,10 @@ export interface Level { showLabels?: boolean; } } -namespace TreeMap { -enum DockPosition { +module TreeMap +{ +enum DockPosition +{ //specifies the top position Top, //specifies the bottom position @@ -57988,8 +58234,10 @@ Right, Left, } } -namespace TreeMap { -enum ItemsLayoutMode { +module TreeMap +{ +enum ItemsLayoutMode +{ //specifies the squarified as layout type position Squarified, //specifies the sliceanddicehorizontal as layout type position @@ -58000,8 +58248,10 @@ Sliceanddicevertical, Sliceanddiceauto, } } -namespace TreeMap { -enum Position { +module TreeMap +{ +enum Position +{ //specifies the none position None, //specifies the topleft position @@ -58024,24 +58274,30 @@ Bottomcenter, Bottomright, } } -namespace TreeMap { -enum VisibilityMode { +module TreeMap +{ +enum VisibilityMode +{ //specifies the visible mode Top, //specifies the hide on exceeded length mode Hideonexceededlength, } } -namespace TreeMap { -enum selectionMode { +module TreeMap +{ +enum selectionMode +{ //specifies the default mode Default, //specifies the multiple mode Multiple, } } -namespace TreeMap { -enum groupSelectionMode { +module TreeMap +{ +enum groupSelectionMode +{ //specifies the default mode Default, //specifies the multiple mode @@ -58051,10 +58307,11 @@ Multiple, class Diagram extends ej.Widget { static fn: Diagram; - constructor(element: JQuery | Element, options?: Diagram.Model); + constructor(element: JQuery, options?: Diagram.Model); + constructor(element: Element, options?: Diagram.Model); static Locale: any; - model: Diagram.Model; - defaults: Diagram.Model; + model:Diagram.Model; + defaults:Diagram.Model; /** Add nodes and connectors to diagram at runtime * @param {any} a JSON to define a node/connector or an array of nodes and connector @@ -58088,7 +58345,7 @@ class Diagram extends ej.Widget { * @param {Array} a collection of ports to be added to the specified node * @returns {void} */ - addPorts(name: string, ports: any[]): void; + addPorts(name: string, ports: Array): void; /** Add the specified node to selection list * @param {any} the node to be selected @@ -58369,12 +58626,12 @@ class Diagram extends ej.Widget { upgrade(data: any): void; /** Used to zoomIn/zoomOut diagram - * @param {Diagram.Zoom} options to zoom the diagram(zoom factor, zoomIn/zoomOut) + * @param {Diagram.Zoom} options to zoom the diagram(zoom factor, zoomIn/zoomOut) * @returns {void} */ zoomTo(Zoom?: Diagram.Zoom): void; } -export namespace Diagram { +export module Diagram{ export interface Options { @@ -58417,7 +58674,7 @@ export interface Zoom { */ zoomCommand?: ej.datavisualization.Diagram.ZoomCommand; - /** Used to zoom-in or zoom-out the diagram based on the point. + /** Used to zoom-in or zoom-out the diagram based on the point. */ focusPoint?: ej.datavisualization.Diagram.ConnectorsSourcePoint; } @@ -58445,7 +58702,7 @@ export interface Model { /** A collection of JSON objects where each object represents a connector * @Default {[]} */ - connectors?: Connector[]; + connectors?: Array; /** Binds the custom JSON data with connector properties * @Default {null} @@ -58511,7 +58768,7 @@ export interface Model { /** Array of JSON objects where each object represents a node * @Default {[]} */ - nodes?: Node[]; + nodes?: Array; /** Binds the custom JSON data with node properties * @Default {null} @@ -58560,94 +58817,94 @@ export interface Model { zoomFactor?: number; /** Triggers When auto scroll is changed */ - autoScrollChange?(e: AutoScrollChangeEventArgs): void; + autoScrollChange? (e: AutoScrollChangeEventArgs): void; /** Triggers when a node, connector or diagram is clicked */ - click?(e: ClickEventArgs): void; + click? (e: ClickEventArgs): void; /** Triggers when the connection is changed */ - connectionChange?(e: ConnectionChangeEventArgs): void; + connectionChange? (e: ConnectionChangeEventArgs): void; /** Triggers when the connector collection is changed */ - connectorCollectionChange?(e: ConnectorCollectionChangeEventArgs): void; + connectorCollectionChange? (e: ConnectorCollectionChangeEventArgs): void; /** Triggers when the connectors' source point is changed */ - connectorSourceChange?(e: ConnectorSourceChangeEventArgs): void; + connectorSourceChange? (e: ConnectorSourceChangeEventArgs): void; /** Triggers when the connectors' target point is changed */ - connectorTargetChange?(e: ConnectorTargetChangeEventArgs): void; + connectorTargetChange? (e: ConnectorTargetChangeEventArgs): void; /** Triggers before opening the context menu */ - contextMenuBeforeOpen?(e: ContextMenuBeforeOpenEventArgs): void; + contextMenuBeforeOpen? (e: ContextMenuBeforeOpenEventArgs): void; /** Triggers when a context menu item is clicked */ - contextMenuClick?(e: ContextMenuClickEventArgs): void; + contextMenuClick? (e: ContextMenuClickEventArgs): void; /** Triggers when a node, connector or diagram model is clicked twice */ - doubleClick?(e: DoubleClickEventArgs): void; + doubleClick? (e: DoubleClickEventArgs): void; /** Triggers while dragging the elements in diagram */ - drag?(e: DragEventArgs): void; + drag? (e: DragEventArgs): void; /** Triggers when a symbol is dragged into diagram from symbol palette */ - dragEnter?(e: DragEnterEventArgs): void; + dragEnter? (e: DragEnterEventArgs): void; /** Triggers when a symbol is dragged outside of the diagram. */ - dragLeave?(e: DragLeaveEventArgs): void; + dragLeave? (e: DragLeaveEventArgs): void; /** Triggers when a symbol is dragged over diagram */ - dragOver?(e: DragOverEventArgs): void; + dragOver? (e: DragOverEventArgs): void; /** Triggers when a symbol is dragged and dropped from symbol palette to drawing area */ - drop?(e: DropEventArgs): void; + drop? (e: DropEventArgs): void; /** Triggers when editor got focus at the time of node's label or text node editing. */ - editorFocusChange?(e: EditorFocusChangeEventArgs): void; + editorFocusChange? (e: EditorFocusChangeEventArgs): void; /** Triggers when a child is added to or removed from a group */ - groupChange?(e: GroupChangeEventArgs): void; + groupChange? (e: GroupChangeEventArgs): void; /** Triggers when a change is reverted or restored(undo/redo) */ - historyChange?(e: HistoryChangeEventArgs): void; + historyChange? (e: HistoryChangeEventArgs): void; /** Triggers when a diagram element is clicked */ - itemClick?(e: ItemClickEventArgs): void; + itemClick? (e: ItemClickEventArgs): void; /** Triggers when mouse enters a node/connector */ - mouseEnter?(e: MouseEnterEventArgs): void; + mouseEnter? (e: MouseEnterEventArgs): void; /** Triggers when mouse leaves node/connector */ - mouseLeave?(e: MouseLeaveEventArgs): void; + mouseLeave? (e: MouseLeaveEventArgs): void; /** Triggers when mouse hovers over a node/connector */ - mouseOver?(e: MouseOverEventArgs): void; + mouseOver? (e: MouseOverEventArgs): void; /** Triggers when node collection is changed */ - nodeCollectionChange?(e: NodeCollectionChangeEventArgs): void; + nodeCollectionChange? (e: NodeCollectionChangeEventArgs): void; /** Triggers when the node properties(x, y,width and height alone) are changed using nudge commands or updateNode API. */ - propertyChange?(e: PropertyChangeEventArgs): void; + propertyChange? (e: PropertyChangeEventArgs): void; /** Triggers when the diagram elements are rotated */ - rotationChange?(e: RotationChangeEventArgs): void; + rotationChange? (e: RotationChangeEventArgs): void; /** Triggers when the diagram is zoomed or panned */ - scrollChange?(e: ScrollChangeEventArgs): void; + scrollChange? (e: ScrollChangeEventArgs): void; /** Triggers when a connector segment is edited */ - segmentChange?(e: SegmentChangeEventArgs): void; + segmentChange? (e: SegmentChangeEventArgs): void; /** Triggers when the selection is changed in diagram */ - selectionChange?(e: SelectionChangeEventArgs): void; + selectionChange? (e: SelectionChangeEventArgs): void; /** Triggers when a node is resized */ - sizeChange?(e: SizeChangeEventArgs): void; + sizeChange? (e: SizeChangeEventArgs): void; /** Triggers when label editing is ended */ - textChange?(e: TextChangeEventArgs): void; + textChange? (e: TextChangeEventArgs): void; /** Triggered when the diagram is rendered completely. */ - create?(e: CreateEventArgs): void; + create? (e: CreateEventArgs): void; } export interface AutoScrollChangeEventArgs { @@ -58977,9 +59234,6 @@ export interface DropEventArgs { } export interface EditorFocusChangeEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; } export interface GroupChangeEventArgs { @@ -59009,11 +59263,11 @@ export interface HistoryChangeEventArgs { /** An array of objects, where each object represents the changes made in last undo/redo. To explore how the changes are defined, refer [Undo Redo Changes](#undo-redo-changes) */ - changes?: any[]; + changes?: Array; /** A collection of objects that are changed in the last undo/redo */ - Source?: any[]; + Source?: Array; /** parameter returns the id of the diagram */ @@ -59223,15 +59477,15 @@ export interface SelectionChangeEventArgs { /** parameter returns the collection of nodes and connectors that have to be removed from selection list */ - oldItems?: any[]; + oldItems?: Array; /** parameter returns the collection of nodes and connectors that have to be added to selection list */ - newItems?: any[]; + newItems?: Array; /** parameter returns the collection of nodes and connectors that will be selected after selection change */ - selectedItems?: any[]; + selectedItems?: Array; /** parameter to specify whether or not to cancel the selection change event */ @@ -59336,11 +59590,11 @@ export interface CommandManagerCommands { /** A method that defines whether the command is executable at the moment or not. */ - canExecute?: any; + canExecute?: Function; /** A method that defines what to be executed when the key combination is recognized. */ - execute?: any; + execute?: Function; /** Defines a combination of keys and key modifiers, on recognition of which the command will be executed */ @@ -59760,7 +60014,7 @@ export interface Connector { /** A collection of JSON objects where each object represents a label. * @Default {[]} */ - labels?: ConnectorsLabel[]; + labels?: Array; /** Sets the stroke color of the connector * @Default {black} @@ -59822,7 +60076,7 @@ export interface Connector { /** An array of JSON objects where each object represents a segment * @Default {[ { type:straight } ]} */ - segments?: ConnectorsSegment[]; + segments?: Array; /** Defines the role/meaning of the connector * @Default {null} @@ -59921,7 +60175,7 @@ export interface ContextMenuItem { /** Defines the collection of sub items for the context menu items * @Default {[]} */ - subItems?: any[]; + subItems?: Array; } export interface ContextMenu { @@ -59929,7 +60183,7 @@ export interface ContextMenu { /** Defines the collection of context menu items * @Default {[]} */ - items?: ContextMenuItem[]; + items?: Array; /** To set whether to display the default context menu items or not * @Default {false} @@ -59990,29 +60244,29 @@ export interface HistoryManager { /** A method that takes a history entry as argument and returns whether the specific entry can be popped or not */ - canPop?: any; + canPop?: Function; /** A method that ends grouping the changes */ - closeGroupAction?: any; + closeGroupAction?: Function; /** A method that removes the history of a recent change made in diagram */ - pop?: any; + pop?: Function; /** A method that allows to track the custom changes made in diagram */ - push?: any; + push?: Function; /** Defines what should be happened while trying to restore a custom change * @Default {null} */ - redo?: any; + redo?: Function; /** The redoStack property is used to get the number of redo actions to be stored on the history manager. Its an read-only property and the collection should not be modified. * @Default {[]} */ - redoStack?: any[]; + redoStack?: Array; /** The stackLimit property used to restrict the undo and redo actions to a certain limit. * @Default {null} @@ -60021,16 +60275,16 @@ export interface HistoryManager { /** A method that starts to group the changes to revert/restore them in a single undo or redo */ - startGroupAction?: any; + startGroupAction?: Function; /** Defines what should be happened while trying to revert a custom change */ - undo?: any; + undo?: Function; /** The undoStack property is used to get the number of undo actions to be stored on the history manager. Its an read-only property and the collection should not be modified. * @Default {[]} */ - undoStack?: any[]; + undoStack?: Array; } export interface Layout { @@ -60150,12 +60404,12 @@ export interface NodesClass { /** Defines the collection of attributes * @Default {[]} */ - attributes?: NodesClassAttribute[]; + attributes?: Array; /** Defines the collection of methods of a Class. * @Default {[]} */ - methods?: NodesClassMethod[]; + methods?: Array; } export interface NodesCollapseIcon { @@ -60248,7 +60502,7 @@ export interface NodesEnumeration { /** Defines the collection of enumeration members * @Default {[]} */ - members?: NodesEnumerationMember[]; + members?: Array; } export interface NodesExpandIcon { @@ -60304,7 +60558,7 @@ export interface NodesGradientLinearGradient { /** Defines the different colors and the region of color transitions * @Default {[]} */ - stops?: any[]; + stops?: Array; /** Defines the left most position(relative to node) of the rectangular region that needs to be painted * @Default {0} @@ -60352,7 +60606,7 @@ export interface NodesGradientRadialGradient { /** Defines the different colors and the region of color transitions. * @Default {[]} */ - stops?: any[]; + stops?: Array; } export interface NodesGradientStop { @@ -60418,12 +60672,12 @@ export interface NodesInterface { /** Defines a collection of attributes of the interface * @Default {[]} */ - attributes?: NodesInterfaceAttribute[]; + attributes?: Array; /** Defines the collection of public methods of an interface * @Default {[]} */ - methods?: NodesInterfaceMethod[]; + methods?: Array; } export interface NodesLabel { @@ -60577,7 +60831,7 @@ export interface NodesLane { /** An array of objects where each object represents a child node of the lane * @Default {[]} */ - children?: any[]; + children?: Array; /** Defines the fill color of the lane * @Default {white} @@ -60782,7 +61036,7 @@ export interface NodesSubProcess { /** Defines the collection of events that need to be appended with BPMN Sub-Process */ - events?: any[]; + events?: Array; /** Defines the loop type of a sub process. * @Default {ej.datavisualization.Diagram.BPMNLoops.None} @@ -60792,7 +61046,7 @@ export interface NodesSubProcess { /** Defines the children for BPMN's SubProcess * @Default {[]} */ - Processes?: any[]; + Processes?: Array; /** Defines the type of the event trigger * @Default {ej.datavisualization.Diagram.BPMNTriggers.Message} @@ -60867,7 +61121,7 @@ export interface Node { /** Array of JSON objects where each object represents a child node/connector * @Default {[]} */ - children?: any[]; + children?: Array; /** Sets the type of UML classifier. Applicable, if the node is a UML Class Diagram shape. * @Default {ej.datavisualization.Diagram.ClassifierShapes.Class} @@ -60967,7 +61221,7 @@ export interface Node { /** A read only collection of the incoming connectors/edges of the node * @Default {[]} */ - inEdges?: any[]; + inEdges?: Array; /** Defines an interface in a UML Class Diagram * @Default {null} @@ -60987,12 +61241,12 @@ export interface Node { /** A collection of objects where each object represents a label * @Default {[]} */ - labels?: NodesLabel[]; + labels?: Array; /** An array of objects where each object represents a lane. Applicable, if the node is a swimlane. * @Default {[]} */ - lanes?: NodesLane[]; + lanes?: Array; /** Defines the minimum space to be left between the bottom of parent bounds and the node. Applicable, if the parent is a container. * @Default {0} @@ -61061,7 +61315,7 @@ export interface Node { /** A read only collection of outgoing connectors/edges of the node * @Default {[]} */ - outEdges?: any[]; + outEdges?: Array; /** Defines the minimum padding value to be left between the bottom most position of a group and its children. Applicable, if the group is a container. * @Default {0} @@ -61099,7 +61353,7 @@ export interface Node { /** An array of objects, where each object represents a smaller region(phase) of a swimlane. * @Default {[]} */ - phases?: NodesPhase[]; + phases?: Array; /** Sets the height of the phase headers * @Default {0} @@ -61114,12 +61368,12 @@ export interface Node { /** Defines a collection of points to draw a polygon. Applicable, if the shape is a polygon. * @Default {[]} */ - points?: any[]; + points?: Array; /** An array of objects where each object represents a port * @Default {[]} */ - ports?: NodesPort[]; + ports?: Array; /** Sets the angle to which the node should be rotated * @Default {0} @@ -61347,7 +61601,7 @@ export interface SelectedItems { /** A read only collection of the selected items * @Default {[]} */ - children?: any[]; + children?: Array; /** Controls the visibility of selector. * @Default {ej.datavisualization.Diagram.SelectorConstraints.All} @@ -61387,7 +61641,7 @@ export interface SelectedItems { /** A collection of frequently used commands that will be added around the selector * @Default {[]} */ - userHandles?: SelectedItemsUserHandle[]; + userHandles?: Array; /** Sets the width of the selected items * @Default {0} @@ -61409,12 +61663,12 @@ export interface SnapSettingsHorizontalGridLines { /** A pattern of lines and gaps that defines a set of horizontal gridlines * @Default {[1.25, 18.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75]} */ - linesInterval?: any[]; + linesInterval?: Array; /** Specifies a set of intervals to snap the objects * @Default {[20]} */ - snapInterval?: any[]; + snapInterval?: Array; } export interface SnapSettingsVerticalGridLines { @@ -61431,12 +61685,12 @@ export interface SnapSettingsVerticalGridLines { /** A pattern of lines and gaps that defines a set of horizontal gridlines * @Default {[1.25, 18.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75]} */ - linesInterval?: any[]; + linesInterval?: Array; /** Specifies a set of intervals to snap the objects * @Default {[20]} */ - snapInterval?: any[]; + snapInterval?: Array; } export interface SnapSettings { @@ -61503,11 +61757,13 @@ export interface Tooltip { templateId?: string; } } -namespace Diagram { -enum ImageAlignment { +module Diagram +{ +enum ImageAlignment +{ //Scales the graphic content non-uniformly to the width and height of the diagram area None, -//Used to align the image at the top left of diagram area +//Used to align the image at the top left of diagram area XMinYMin, //Used to align the image at the left center of diagram area XMinYMid, @@ -61527,8 +61783,10 @@ XMaxYMid, XMaxYMax, } } -namespace Diagram { -enum BridgeDirection { +module Diagram +{ +enum BridgeDirection +{ //Used to set the direction of line bridges as left Left, //Used to set the direction of line bridges as right @@ -61539,8 +61797,10 @@ Top, Bottom, } } -namespace Diagram { -enum Keys { +module Diagram +{ +enum Keys +{ //No key pressed. None, //The A key. @@ -61633,8 +61893,10 @@ Tab, Enter, } } -namespace Diagram { -enum KeyModifiers { +module Diagram +{ +enum KeyModifiers +{ //No modifiers are pressed. None, //The ALT key. @@ -61645,8 +61907,10 @@ Control, Shift, } } -namespace Diagram { -enum ConnectorConstraints { +module Diagram +{ +enum ConnectorConstraints +{ //Disable all connector Constraints None, //Enables connector to be selected @@ -61675,8 +61939,10 @@ CrispEdges, Default, } } -namespace Diagram { -enum HorizontalAlignment { +module Diagram +{ +enum HorizontalAlignment +{ //Used to align text horizontally on left side of node/connector Left, //Used to align text horizontally on center of node/connector @@ -61685,8 +61951,10 @@ Center, Right, } } -namespace Diagram { -enum Alignment { +module Diagram +{ +enum Alignment +{ //Used to align the label either top or left(before) of the connector segment Before, //Used to align the label at center of the connector segment @@ -61695,16 +61963,20 @@ Center, After, } } -namespace Diagram { -enum LabelRelativeMode { +module Diagram +{ +enum LabelRelativeMode +{ //Sets the relativeMode as SegmentPath SegmentPath, //Sets the relativeMode as SegmentBounds SegmentBounds, } } -namespace Diagram { -enum Segments { +module Diagram +{ +enum Segments +{ //Used to specify the lines as Straight Straight, //Used to specify the lines as Orthogonal @@ -61713,8 +61985,10 @@ Orthogonal, Bezier, } } -namespace Diagram { -enum ConnectorShapes { +module Diagram +{ +enum ConnectorShapes +{ //Used to specify connector type as BPMN BPMN, //Used to specify connector type as UMLClassifier @@ -61723,18 +61997,22 @@ UMLClassifier, UMLActivity, } } -namespace Diagram { -enum BPMNFlows { +module Diagram +{ +enum BPMNFlows +{ //Used to specify the Sequence flow in a BPMN Process Sequence, -//Used to specify the Association flow in a BPMN Process +//Used to specify the Association flow in a BPMN Process Association, //Used to specify the Message flow in a BPMN Process Message, } } -namespace Diagram { -enum AssociationFlows { +module Diagram +{ +enum AssociationFlows +{ //Used to notate default association in a BPMN Process Default, //Used to notate directional association in a BPMN Process @@ -61743,8 +62021,10 @@ Directional, BiDirectional, } } -namespace Diagram { -enum BPMNMessageFlows { +module Diagram +{ +enum BPMNMessageFlows +{ //Used to notate the default message flow in a BPMN Process Default, //Used to notate the instantiating message flow in a BPMN Process @@ -61753,8 +62033,10 @@ InitiatingMessage, NonInitiatingMessage, } } -namespace Diagram { -enum BPMNSequenceFlows { +module Diagram +{ +enum BPMNSequenceFlows +{ //Used to notate the normal sequence flow in a BPMN Process Normal, //Used to notate the conditional sequence flow in a BPMN Process @@ -61763,8 +62045,10 @@ Conditional, Default, } } -namespace Diagram { -enum ClassifierShapes { +module Diagram +{ +enum ClassifierShapes +{ //Used to define a Class Class, //Used to define an Interface @@ -61783,8 +62067,10 @@ Dependency, Inheritance, } } -namespace Diagram { -enum Multiplicity { +module Diagram +{ +enum Multiplicity +{ //Each entity instance is related to a single instance of another entity OneToOne, //An entity instance can be related to multiple instances of the other entities @@ -61795,8 +62081,10 @@ ManyToOne, ManyToMany, } } -namespace Diagram { -enum UMLActivityFlow { +module Diagram +{ +enum UMLActivityFlow +{ //Defines a activity flow as Object in UML Activity Diagram Object, //Defines a activity flow as Control in UML Activity Diagram @@ -61805,8 +62093,10 @@ Control, Exception, } } -namespace Diagram { -enum DecoratorShapes { +module Diagram +{ +enum DecoratorShapes +{ //Used to set decorator shape as none None, //Used to set decorator shape as Arrow @@ -61821,8 +62111,10 @@ Diamond, Path, } } -namespace Diagram { -enum VerticalAlignment { +module Diagram +{ +enum VerticalAlignment +{ //Used to align text Vertically on left side of node/connector Top, //Used to align text Vertically on center of node/connector @@ -61831,8 +62123,10 @@ Center, Bottom, } } -namespace Diagram { -enum DiagramConstraints { +module Diagram +{ +enum DiagramConstraints +{ //Disables all DiagramConstraints None, //Enables/Disables PageEditing @@ -61855,16 +62149,20 @@ CrispEdges, Default, } } -namespace Diagram { -enum LabelRenderingMode { +module Diagram +{ +enum LabelRenderingMode +{ //Sets the labelRenderingMode as Html Html, //Sets the labelRenderingMode as Svg Svg, } } -namespace Diagram { -enum LayoutOrientations { +module Diagram +{ +enum LayoutOrientations +{ //Used to set LayoutOrientation from top to bottom TopToBottom, //Used to set LayoutOrientation from bottom to top @@ -61875,8 +62173,10 @@ LeftToRight, RightToLeft, } } -namespace Diagram { -enum LayoutTypes { +module Diagram +{ +enum LayoutTypes +{ //Used not to set any specific layout None, //Used to set layout type as hierarchical layout @@ -61885,8 +62185,10 @@ HierarchicalTree, OrganizationalChart, } } -namespace Diagram { -enum BPMNActivity { +module Diagram +{ +enum BPMNActivity +{ //Used to set BPMN Activity as None None, //Used to set BPMN Activity as Task @@ -61895,8 +62197,10 @@ Task, SubProcess, } } -namespace Diagram { -enum BPMNAnnotationDirection { +module Diagram +{ +enum BPMNAnnotationDirection +{ //Used to set the direction of BPMN Annotation as left Left, //Used to set the direction of BPMN Annotation as right @@ -61907,8 +62211,10 @@ Top, Bottom, } } -namespace Diagram { -enum IconShapes { +module Diagram +{ +enum IconShapes +{ //Used to set collapse icon shape as none None, //Used to set collapse icon shape as Arrow(Up/Down) @@ -61925,8 +62231,10 @@ Template, Image, } } -namespace Diagram { -enum NodeConstraints { +module Diagram +{ +enum NodeConstraints +{ //Disable all node Constraints None, //Enables node to be selected @@ -61973,16 +62281,20 @@ CrispEdges, Default, } } -namespace Diagram { -enum ContainerType { +module Diagram +{ +enum ContainerType +{ //Sets the container type as Canvas Canvas, //Sets the container type as Stack Stack, } } -namespace Diagram { -enum BPMNDataObjects { +module Diagram +{ +enum BPMNDataObjects +{ //Used to notate the Input type BPMN data object Input, //Used to notate the Output type BPMN data object @@ -61991,8 +62303,10 @@ Output, None, } } -namespace Diagram { -enum BPMNEvents { +module Diagram +{ +enum BPMNEvents +{ //Used to set BPMN Event as Start Start, //Used to set BPMN Event as Intermediate @@ -62007,8 +62321,10 @@ NonInterruptingIntermediate, ThrowingIntermediate, } } -namespace Diagram { -enum BPMNGateways { +module Diagram +{ +enum BPMNGateways +{ //Used to set BPMN Gateway as None None, //Used to set BPMN Gateway as Exclusive @@ -62027,24 +62343,30 @@ ExclusiveEventBased, ParallelEventBased, } } -namespace Diagram { -enum LabelEditMode { +module Diagram +{ +enum LabelEditMode +{ //Used to set label edit mode as edit Edit, //Used to set label edit mode as view View, } } -namespace Diagram { -enum OverflowType { +module Diagram +{ +enum OverflowType +{ //Set overflow Type as ellipsis Ellipsis, //Set overflow Type as Clip Clip, } } -namespace Diagram { -enum TextAlign { +module Diagram +{ +enum TextAlign +{ //Used to align text on left side of node/connector Left, //Used to align text on center of node/connector @@ -62053,8 +62375,10 @@ Center, Right, } } -namespace Diagram { -enum TextDecorations { +module Diagram +{ +enum TextDecorations +{ //Used to set text decoration of the label as Underline Underline, //Used to set text decoration of the label as Overline @@ -62065,8 +62389,10 @@ LineThrough, None, } } -namespace Diagram { -enum TextWrapping { +module Diagram +{ +enum TextWrapping +{ //Disables wrapping NoWrap, //Enables Line-break at normal word break points @@ -62075,8 +62401,10 @@ Wrap, WrapWithOverflow, } } -namespace Diagram { -enum PortConstraints { +module Diagram +{ +enum PortConstraints +{ //Disable all constraints None, //Enables connections with connector @@ -62085,8 +62413,10 @@ Connect, ConnectOnDrag, } } -namespace Diagram { -enum PortShapes { +module Diagram +{ +enum PortShapes +{ //Used to set port shape as X X, //Used to set port shape as Circle @@ -62097,8 +62427,10 @@ Square, Path, } } -namespace Diagram { -enum PortVisibility { +module Diagram +{ +enum PortVisibility +{ //Set the port visibility as Visible Visible, //Set the port visibility as Hidden @@ -62111,8 +62443,10 @@ Connect, Default, } } -namespace Diagram { -enum BasicShapes { +module Diagram +{ +enum BasicShapes +{ //Used to specify node Shape as Rectangle Rectangle, //Used to specify node Shape as Ellipse @@ -62143,8 +62477,10 @@ RightTriangle, Cylinder, } } -namespace Diagram { -enum FlowShapes { +module Diagram +{ +enum FlowShapes +{ //Used to specify node Shape as Process Process, //Used to specify node Shape as Decision @@ -62159,7 +62495,7 @@ Terminator, PaperTap, //Used to specify node Shape as DirectData DirectData, -//Used to specify node Shape as SequentialData +//Used to specify node Shape as SequentialData SequentialData, //Used to specify node Shape as Sort Sort, @@ -62189,12 +62525,14 @@ Annotation1, Annotation2, //Used to specify node Shape as Data Data, -//Used to specify node Shape as Card +//Used to specify node Shape as Card Card, } } -namespace Diagram { -enum BPMNShapes { +module Diagram +{ +enum BPMNShapes +{ //Used to specify node Shape as Event Event, //Used to specify node Shape as Gateway @@ -62211,8 +62549,10 @@ Activity, Group, } } -namespace Diagram { -enum UMLActivityShapes { +module Diagram +{ +enum UMLActivityShapes +{ //Used to set UML ActivityShapes as Action Action, //Used to set UML ActivityShapes as Decision @@ -62241,8 +62581,10 @@ StructuredNode, Note, } } -namespace Diagram { -enum BPMNBoundary { +module Diagram +{ +enum BPMNBoundary +{ //Used to set BPMN SubProcess's Boundary as Default Default, //Used to set BPMN SubProcess's Boundary as Call @@ -62251,8 +62593,10 @@ Call, Event, } } -namespace Diagram { -enum BPMNLoops { +module Diagram +{ +enum BPMNLoops +{ //Used to set BPMN Activity's Loop as None None, //Used to set BPMN Activity's Loop as Standard @@ -62263,8 +62607,10 @@ ParallelMultiInstance, SequenceMultiInstance, } } -namespace Diagram { -enum BPMNSubProcessTypes { +module Diagram +{ +enum BPMNSubProcessTypes +{ //Used to set BPMN SubProcess type as None None, //Used to set BPMN SubProcess type as Transaction @@ -62273,8 +62619,10 @@ Transaction, Event, } } -namespace Diagram { -enum BPMNTasks { +module Diagram +{ +enum BPMNTasks +{ //Used to set BPMN Task Type as None None, //Used to set BPMN Task Type as Service @@ -62297,8 +62645,10 @@ Script, Parallel, } } -namespace Diagram { -enum BPMNTriggers { +module Diagram +{ +enum BPMNTriggers +{ //Used to set Event Trigger as None None, //Used to set Event Trigger as Message @@ -62327,8 +62677,10 @@ Termination, Cancel, } } -namespace Diagram { -enum Shapes { +module Diagram +{ +enum Shapes +{ //Used to specify node type as Text Text, //Used to specify node type as Image @@ -62349,16 +62701,20 @@ UMLClassifier, UMLActivity, } } -namespace Diagram { -enum PageOrientations { +module Diagram +{ +enum PageOrientations +{ //Used to set orientation as Landscape Landscape, //Used to set orientation as portrait Portrait, } } -namespace Diagram { -enum ScrollLimit { +module Diagram +{ +enum ScrollLimit +{ //Used to set scrollLimit as Infinite Infinite, //Used to set scrollLimit as Diagram @@ -62367,8 +62723,10 @@ Diagram, Limited, } } -namespace Diagram { -enum BoundaryConstraints { +module Diagram +{ +enum BoundaryConstraints +{ //Used to set boundaryConstraints as Infinite Infinite, //Used to set boundaryConstraints as Diagram @@ -62377,8 +62735,10 @@ Diagram, Page, } } -namespace Diagram { -enum SelectorConstraints { +module Diagram +{ +enum SelectorConstraints +{ //Hides the selector None, //Sets the visibility of rotation handle as visible @@ -62391,8 +62751,10 @@ UserHandles, All, } } -namespace Diagram { -enum UserHandlePositions { +module Diagram +{ +enum UserHandlePositions +{ //Set the position of the userhandle as topleft TopLeft, //Set the position of the userhandle as topcenter @@ -62411,8 +62773,10 @@ BottomCenter, BottomRight, } } -namespace Diagram { -enum SnapConstraints { +module Diagram +{ +enum SnapConstraints +{ //Enables node to be snapped to horizontal gridlines None, //Enables node to be snapped to vertical gridlines @@ -62431,8 +62795,10 @@ ShowLines, All, } } -namespace Diagram { -enum Tool { +module Diagram +{ +enum Tool +{ //Disables all Tools None, //Enables/Disables SingleSelect tool @@ -62447,16 +62813,20 @@ DrawOnce, ContinuesDraw, } } -namespace Diagram { -enum RelativeMode { +module Diagram +{ +enum RelativeMode +{ //Shows tooltip around the node Object, //Shows tooltip at the mouse position Mouse, } } -namespace Diagram { -enum ZoomCommand { +module Diagram +{ +enum ZoomCommand +{ //Used to zoom in the Diagram ZoomIn, //Used to zoom out the diagram @@ -62466,12 +62836,13 @@ ZoomOut, class HeatMap extends ej.Widget { static fn: HeatMap; - constructor(element: JQuery | Element, options?: HeatMap.Model); + constructor(element: JQuery, options?: HeatMap.Model); + constructor(element: Element, options?: HeatMap.Model); static Locale: any; - model: HeatMap.Model; - defaults: HeatMap.Model; + model:HeatMap.Model; + defaults:HeatMap.Model; } -export namespace HeatMap { +export module HeatMap{ export interface Model { @@ -62527,7 +62898,7 @@ export interface Model { /** Specifies the no of legends can sync with heat map. * @Default {[]} */ - legendCollection?: any[]; + legendCollection?: Array; /** Specifies the property and display value of the heat map column. * @Default {[]} @@ -62537,19 +62908,19 @@ export interface Model { /** Specifies the color values of the heat map column data. * @Default {[]} */ - colorMappingCollection?: ColorMappingCollection[]; + colorMappingCollection?: Array; /** Triggered when the mouse over on the cell. */ - cellMouseOver?(e: CellMouseOverEventArgs): void; + cellMouseOver? (e: CellMouseOverEventArgs): void; /** Triggered when the mouse over on the cell. */ - cellMouseEnter?(e: CellMouseEnterEventArgs): void; + cellMouseEnter? (e: CellMouseEnterEventArgs): void; /** Triggered when the mouse over on the cell. */ - cellMouseLeave?(e: CellMouseLeaveEventArgs): void; + cellMouseLeave? (e: CellMouseLeaveEventArgs): void; /** Triggered when the mouse over on the cell. */ - cellSelected?(e: CellSelectedEventArgs): void; + cellSelected? (e: CellSelectedEventArgs): void; } export interface CellMouseOverEventArgs { @@ -62670,6 +63041,7 @@ export interface TooltipSettings { templateId?: string; /** Defines the tooltip of associate that should be shown when the mouse hovers over rows/columns. + * @Default {mouseFollow} */ associate?: ej.datavisualization.HeatMap.Associate|string; @@ -62803,7 +63175,7 @@ export interface ItemsMapping { */ column?: ItemsMappingColumn; - /** Specifies the property and display value of the heat map.row + /** Specifies the row property and display value of the heat map. * @Default {null} */ row?: ItemsMappingRow; @@ -62821,7 +63193,7 @@ export interface ItemsMapping { /** Specifies the property and display value of the collection of column. * @Default {[]} */ - columnMapping?: any[]; + columnMapping?: Array; } export interface ColorMappingCollectionLabel { @@ -62879,8 +63251,10 @@ export interface ColorMappingCollection { label?: ColorMappingCollectionLabel; } } -namespace HeatMap { -enum Associate { +module HeatMap +{ +enum Associate +{ //Used to set the associate of tooltip as Target Target, //Used to set the associate of tooltip as MouseFollow @@ -62889,8 +63263,10 @@ MouseFollow, MouseEnter, } } -namespace HeatMap { -enum Horizontal { +module HeatMap +{ +enum Horizontal +{ //Used to display the tooltip horizontally on left side of rows/columns Left, //Used to display the tooltip horizontally on center side of rows/columns @@ -62899,8 +63275,10 @@ Center, Right, } } -namespace HeatMap { -enum Vertical { +module HeatMap +{ +enum Vertical +{ //Used to display the tooltip horizontally on left side of rows/columns Top, //Used to display the tooltip horizontally on center side of rows/columns @@ -62909,16 +63287,20 @@ Center, Bottom, } } -namespace HeatMap { -enum Trigger { +module HeatMap +{ +enum Trigger +{ //Tooltip can be triggered on mouse hovers Hover, //Tooltip can be triggered on mouse click Click, } } -namespace HeatMap { -enum Effect { +module HeatMap +{ +enum Effect +{ //Sets tooltip animation as None None, //Sets tooltip animation as Fade @@ -62927,17 +63309,21 @@ Fade, Slide, } } -namespace HeatMap { -enum CellVisibility { -//Display the content of the cell +module HeatMap +{ +enum CellVisibility +{ +//Display the content of the cell Visible, -//Hide the content of the cell +//Hide the content of the cell Hidden, } } -namespace HeatMap { -enum TextDecoration { -//Defines a line below the text +module HeatMap +{ +enum TextDecoration +{ +//Defines a line below the text Underline, //Defines a line above the text Overline, @@ -62950,12 +63336,13 @@ None, class HeatMapLegend extends ej.Widget { static fn: HeatMapLegend; - constructor(element: JQuery | Element, options?: HeatMapLegend.Model); + constructor(element: JQuery, options?: HeatMapLegend.Model); + constructor(element: Element, options?: HeatMapLegend.Model); static Locale: any; - model: HeatMapLegend.Model; - defaults: HeatMapLegend.Model; + model:HeatMapLegend.Model; + defaults:HeatMapLegend.Model; } -export namespace HeatMapLegend { +export module HeatMapLegend{ export interface Model { @@ -62982,7 +63369,7 @@ export interface Model { /** Specifies the color values of the column data. * @Default {[]} */ - colorMappingCollection?: ColorMappingCollection[]; + colorMappingCollection?: Array; /** Specifies the orientation of the heatmap legend * @Default {ej.HeatMap.LegendOrientation.Horizontal} @@ -63050,36 +63437,41 @@ export interface ColorMappingCollection { label?: ColorMappingCollectionLabel; } } -namespace HeatMap { -enum LegendOrientation { -//Scales the graphic content non-uniformly to the width and height of the diagram area +module HeatMap +{ +enum LegendOrientation +{ +//Scales the graphic content non-uniformly to the width and height of the diagram area Horizontal, -//Used to align the image at the top left of diagram area +//Used to align the image at the top left of diagram area Vertical, } } -namespace HeatMap { -enum LegendMode { -//Scales the graphic content non-uniformly to the width and height of the diagram area +module HeatMap +{ +enum LegendMode +{ +//Scales the graphic content non-uniformly to the width and height of the diagram area Gradient, -//Used to align the image at the top left of diagram area +//Used to align the image at the top left of diagram area List, } } class Sparkline extends ej.Widget { static fn: Sparkline; - constructor(element: JQuery | Element, options?: Sparkline.Model); + constructor(element: JQuery, options?: Sparkline.Model); + constructor(element: Element, options?: Sparkline.Model); static Locale: any; - model: Sparkline.Model; - defaults: Sparkline.Model; + model:Sparkline.Model; + defaults:Sparkline.Model; /** Redraws the entire sparkline. You can call this method whenever you update, add or remove points from the data source or whenever you want to refresh the UI. * @returns {void} */ redraw(): void; } -export namespace Sparkline { +export module Sparkline{ export interface Model { @@ -63202,28 +63594,28 @@ export interface Model { axisLineSettings?: AxisLineSettings; /** Fires before loading the sparkline. */ - load?(e: LoadEventArgs): void; + load? (e: LoadEventArgs): void; /** Fires after loaded the sparkline. */ - loaded?(e: LoadedEventArgs): void; + loaded? (e: LoadedEventArgs): void; /** Fires before rendering trackball tooltip. You can use this event to customize the text displayed in trackball tooltip. */ - tooltipInitialize?(e: TooltipInitializeEventArgs): void; + tooltipInitialize? (e: TooltipInitializeEventArgs): void; /** Fires before rendering a series. This event is fired for each series in Sparkline. */ - seriesRendering?(e: SeriesRenderingEventArgs): void; + seriesRendering? (e: SeriesRenderingEventArgs): void; /** Fires when mouse is moved over a point. */ - pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; + pointRegionMouseMove? (e: PointRegionMouseMoveEventArgs): void; /** Fires on clicking a point in sparkline. You can use this event to handle clicks made on points. */ - pointRegionMouseClick?(e: PointRegionMouseClickEventArgs): void; + pointRegionMouseClick? (e: PointRegionMouseClickEventArgs): void; /** Fires on moving mouse over the sparkline. */ - sparklineMouseMove?(e: SparklineMouseMoveEventArgs): void; + sparklineMouseMove? (e: SparklineMouseMoveEventArgs): void; /** Fires on moving mouse outside the sparkline. */ - sparklineMouseLeave?(e: SparklineMouseLeaveEventArgs): void; + sparklineMouseLeave? (e: SparklineMouseLeaveEventArgs): void; } export interface LoadEventArgs { @@ -63258,7 +63650,7 @@ export interface LoadedEventArgs { export interface TooltipInitializeEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -63382,7 +63774,7 @@ export interface PointRegionMouseClickEventArgs { export interface SparklineMouseMoveEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -63397,7 +63789,7 @@ export interface SparklineMouseMoveEventArgs { export interface SparklineMouseLeaveEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -63598,8 +63990,10 @@ export interface AxisLineSettings { dashArray?: number; } } -namespace Sparkline { -enum Type { +module Sparkline +{ +enum Type +{ //string Area, //string @@ -63612,8 +64006,10 @@ Pie, WinLoss, } } -namespace Sparkline { -enum Theme { +module Sparkline +{ +enum Theme +{ //string Azure, //string @@ -63636,16 +64032,20 @@ GradientLight, GradientDark, } } -namespace Sparkline { -enum FontStyle { +module Sparkline +{ +enum FontStyle +{ //string Normal, //string Italic, } } -namespace Sparkline { -enum FontWeight { +module Sparkline +{ +enum FontWeight +{ //string Regular, //string @@ -63657,10 +64057,11 @@ Lighter, class SunburstChart extends ej.Widget { static fn: SunburstChart; - constructor(element: JQuery | Element, options?: SunburstChart.Model); + constructor(element: JQuery, options?: SunburstChart.Model); + constructor(element: Element, options?: SunburstChart.Model); static Locale: any; - model: SunburstChart.Model; - defaults: SunburstChart.Model; + model:SunburstChart.Model; + defaults:SunburstChart.Model; /** Redraws the entire sunburst. You can call this method whenever you update, add or remove points from the data source or whenever you want to refresh the UI. * @returns {void} @@ -63672,7 +64073,7 @@ class SunburstChart extends ej.Widget { */ _destroy(): void; } -export namespace SunburstChart { +export module SunburstChart{ export interface Model { @@ -63780,7 +64181,7 @@ export interface Model { /** Specify levels of sunburst for grouped visualization of data * @Default {[]} */ - levels?: Level[]; + levels?: Array; /** Options to customize the legend items and legend title. */ @@ -63815,40 +64216,40 @@ export interface Model { animationType?: ej.datavisualization.Sunburst.Animation|string; /** Fires before loading. */ - load?(e: LoadEventArgs): void; + load? (e: LoadEventArgs): void; /** Fires before rendering sunburst. */ - preRender?(e: PreRenderEventArgs): void; + preRender? (e: PreRenderEventArgs): void; /** Fires after rendering sunburst. */ - loaded?(e: LoadedEventArgs): void; + loaded? (e: LoadedEventArgs): void; /** Fires before rendering the datalabel */ - dataLabelRendering?(e: DataLabelRenderingEventArgs): void; + dataLabelRendering? (e: DataLabelRenderingEventArgs): void; /** Fires before rendering each segment */ - segmentRendering?(e: SegmentRenderingEventArgs): void; + segmentRendering? (e: SegmentRenderingEventArgs): void; /** Fires before rendering sunburst title. */ - titleRendering?(e: TitleRenderingEventArgs): void; + titleRendering? (e: TitleRenderingEventArgs): void; /** Fires during initialization of tooltip. */ - tooltipInitialize?(e: TooltipInitializeEventArgs): void; + tooltipInitialize? (e: TooltipInitializeEventArgs): void; /** Fires after clicking the point in sunburst */ - pointRegionClick?(e: PointRegionClickEventArgs): void; + pointRegionClick? (e: PointRegionClickEventArgs): void; /** Fires while moving the mouse over sunburst points */ - pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; + pointRegionMouseMove? (e: PointRegionMouseMoveEventArgs): void; /** Fires when clicking the point to perform drilldown. */ - drillDownClick?(e: DrillDownClickEventArgs): void; + drillDownClick? (e: DrillDownClickEventArgs): void; /** Fires when resetting drilldown points. */ - drillDownBack?(e: DrillDownBackEventArgs): void; + drillDownBack? (e: DrillDownBackEventArgs): void; /** Fires after resetting the sunburst points */ - drillDownReset?(e: DrillDownResetEventArgs): void; + drillDownReset? (e: DrillDownResetEventArgs): void; } export interface LoadEventArgs { @@ -64671,16 +65072,20 @@ export interface ZoomSettings { toolbarVerticalAlignment?: ej.datavisualization.Sunburst.SunburstVerticalAlignment|string; } } -namespace Sunburst { -enum FontStyle { +module Sunburst +{ +enum FontStyle +{ //string Normal, //string Italic, } } -namespace Sunburst { -enum FontWeight { +module Sunburst +{ +enum FontWeight +{ //string Regular, //string @@ -64689,16 +65094,20 @@ Bold, Lighter, } } -namespace Sunburst { -enum SunburstLabelRotationMode { +module Sunburst +{ +enum SunburstLabelRotationMode +{ //string Angle, //string Normal, } } -namespace Sunburst { -enum SunburstLabelOverflowMode { +module Sunburst +{ +enum SunburstLabelOverflowMode +{ //string Trim, //string @@ -64707,8 +65116,10 @@ Hide, None, } } -namespace Sunburst { -enum SunburstAlignment { +module Sunburst +{ +enum SunburstAlignment +{ //string Center, //string @@ -64717,8 +65128,10 @@ Near, Far, } } -namespace Sunburst { -enum SunburstHighlightMode { +module Sunburst +{ +enum SunburstHighlightMode +{ //string Point, //string @@ -64729,16 +65142,20 @@ Child, All, } } -namespace Sunburst { -enum SunburstHighlightType { +module Sunburst +{ +enum SunburstHighlightType +{ //string Opacity, //string Color, } } -namespace Sunburst { -enum SunburstClickAction { +module Sunburst +{ +enum SunburstClickAction +{ //string None, //string @@ -64747,8 +65164,10 @@ ToggleSegmentVisibility, ToggleSegmentSelection, } } -namespace Sunburst { -enum SunburstLegendPosition { +module Sunburst +{ +enum SunburstLegendPosition +{ //string Left, //string @@ -64759,8 +65178,10 @@ Top, Bottom, } } -namespace Sunburst { -enum SunburstLegendShape { +module Sunburst +{ +enum SunburstLegendShape +{ //string Diamond, //string @@ -64775,16 +65196,20 @@ Cross, Triangle, } } -namespace Sunburst { -enum SunburstTheme { +module Sunburst +{ +enum SunburstTheme +{ //string FlatLight, //string FlatDark, } } -namespace Sunburst { -enum SunburstHorizontalAlignment { +module Sunburst +{ +enum SunburstHorizontalAlignment +{ //string Center, //string @@ -64793,8 +65218,10 @@ Left, Right, } } -namespace Sunburst { -enum SunburstVerticalAlignment { +module Sunburst +{ +enum SunburstVerticalAlignment +{ //string Top, //string @@ -64803,8 +65230,10 @@ Bottom, Middle, } } -namespace Sunburst { -enum Animation { +module Sunburst +{ +enum Animation +{ //string Rotation, //string @@ -64814,12 +65243,13 @@ FadeIn, class Overview extends ej.Widget { static fn: Overview; - constructor(element: JQuery | Element, options?: Overview.Model); + constructor(element: JQuery, options?: Overview.Model); + constructor(element: Element, options?: Overview.Model); static Locale: any; - model: Overview.Model; - defaults: Overview.Model; + model:Overview.Model; + defaults:Overview.Model; } -export namespace Overview { +export module Overview{ export interface Model { @@ -64843,24 +65273,12 @@ export interface Model { } interface JQueryXHR { - /** Returns the cancel option value. - */ - cancel?: boolean; } interface JQueryPromise { - /** Returns the cancel option value. - */ - cancel?: boolean; } interface JQueryDeferred extends JQueryPromise { - /** Returns the cancel option value. - */ - cancel?: boolean; } interface JQueryParam { - /** Returns the cancel option value. - */ - cancel?: boolean; } interface JQuery { data(key: any): any; @@ -64870,332 +65288,413 @@ interface Window { } interface JQuery { +ejAccordion(): JQuery; ejAccordion(options?: ej.Accordion.Model): JQuery; ejAccordion(memberName: any, value?: any, param?: any): any; +data(key: "ejAccordion"): ej.Accordion; +ejAutocomplete(): JQuery; ejAutocomplete(options?: ej.Autocomplete.Model): JQuery; ejAutocomplete(memberName: any, value?: any, param?: any): any; +data(key: "ejAutocomplete"): ej.Autocomplete; +ejBarcode(): JQuery; ejBarcode(options?: ej.datavisualization.Barcode.Model): JQuery; ejBarcode(memberName: any, value?: any, param?: any): any; +data(key: "ejBarcode"): ej.datavisualization.Barcode; +ejBulletGraph(): JQuery; ejBulletGraph(options?: ej.datavisualization.BulletGraph.Model): JQuery; ejBulletGraph(memberName: any, value?: any, param?: any): any; +data(key: "ejBulletGraph"): ej.datavisualization.BulletGraph; +ejButton(): JQuery; ejButton(options?: ej.Button.Model): JQuery; ejButton(memberName: any, value?: any, param?: any): any; +data(key: "ejButton"): ej.Button; +ejCaptcha(): JQuery; ejCaptcha(options?: ej.Captcha.Model): JQuery; ejCaptcha(memberName: any, value?: any, param?: any): any; +data(key: "ejCaptcha"): ej.Captcha; +ejChart(): JQuery; ejChart(options?: ej.datavisualization.Chart.Model): JQuery; ejChart(memberName: any, value?: any, param?: any): any; +data(key: "ejChart"): ej.datavisualization.Chart; +ejCheckBox(): JQuery; ejCheckBox(options?: ej.CheckBox.Model): JQuery; ejCheckBox(memberName: any, value?: any, param?: any): any; +data(key: "ejCheckBox"): ej.CheckBox; +ejCircularGauge(): JQuery; ejCircularGauge(options?: ej.datavisualization.CircularGauge.Model): JQuery; ejCircularGauge(memberName: any, value?: any, param?: any): any; +data(key: "ejCircularGauge"): ej.datavisualization.CircularGauge; +ejColorPicker(): JQuery; ejColorPicker(options?: ej.ColorPicker.Model): JQuery; ejColorPicker(memberName: any, value?: any, param?: any): any; +data(key: "ejColorPicker"): ej.ColorPicker; +ejDatePicker(): JQuery; ejDatePicker(options?: ej.DatePicker.Model): JQuery; ejDatePicker(memberName: any, value?: any, param?: any): any; +data(key: "ejDatePicker"): ej.DatePicker; +ejDateRangePicker(): JQuery; ejDateRangePicker(options?: ej.DateRangePicker.Model): JQuery; ejDateRangePicker(memberName: any, value?: any, param?: any): any; +data(key: "ejDateRangePicker"): ej.DateRangePicker; +ejDateTimePicker(): JQuery; ejDateTimePicker(options?: ej.DateTimePicker.Model): JQuery; ejDateTimePicker(memberName: any, value?: any, param?: any): any; +data(key: "ejDateTimePicker"): ej.DateTimePicker; +ejDiagram(): JQuery; ejDiagram(options?: ej.datavisualization.Diagram.Model): JQuery; ejDiagram(memberName: any, value?: any, param?: any): any; +data(key: "ejDiagram"): ej.datavisualization.Diagram; +ejDialog(): JQuery; ejDialog(options?: ej.Dialog.Model): JQuery; ejDialog(memberName: any, value?: any, param?: any): any; +data(key: "ejDialog"): ej.Dialog; +ejDigitalGauge(): JQuery; ejDigitalGauge(options?: ej.datavisualization.DigitalGauge.Model): JQuery; ejDigitalGauge(memberName: any, value?: any, param?: any): any; +data(key: "ejDigitalGauge"): ej.datavisualization.DigitalGauge; +ejDocumentEditor(): JQuery; ejDocumentEditor(options?: ej.DocumentEditor.Model): JQuery; ejDocumentEditor(memberName: any, value?: any, param?: any): any; +data(key: "ejDocumentEditor"): ej.DocumentEditor; +ejDraggable(): JQuery; ejDraggable(options?: ej.Draggable.Model): JQuery; ejDraggable(memberName: any, value?: any, param?: any): any; +data(key: "ejDraggable"): ej.Draggable; +ejDropDownList(): JQuery; ejDropDownList(options?: ej.DropDownList.Model): JQuery; ejDropDownList(memberName: any, value?: any, param?: any): any; +data(key: "ejDropDownList"): ej.DropDownList; +ejDroppable(): JQuery; ejDroppable(options?: ej.Droppable.Model): JQuery; ejDroppable(memberName: any, value?: any, param?: any): any; +data(key: "ejDroppable"): ej.Droppable; +ejFileExplorer(): JQuery; ejFileExplorer(options?: ej.FileExplorer.Model): JQuery; ejFileExplorer(memberName: any, value?: any, param?: any): any; +data(key: "ejFileExplorer"): ej.FileExplorer; +ejGantt(): JQuery; ejGantt(options?: ej.Gantt.Model): JQuery; ejGantt(memberName: any, value?: any, param?: any): any; +data(key: "ejGantt"): ej.Gantt; +ejGrid(): JQuery; ejGrid(options?: ej.Grid.Model): JQuery; ejGrid(memberName: any, value?: any, param?: any): any; +data(key: "ejGrid"): ej.Grid; +ejGroupButton(): JQuery; ejGroupButton(options?: ej.GroupButton.Model): JQuery; ejGroupButton(memberName: any, value?: any, param?: any): any; +data(key: "ejGroupButton"): ej.GroupButton; +ejHeatMap(): JQuery; ejHeatMap(options?: ej.datavisualization.HeatMap.Model): JQuery; ejHeatMap(memberName: any, value?: any, param?: any): any; +data(key: "ejHeatMap"): ej.datavisualization.HeatMap; +ejHeatMapLegend(): JQuery; ejHeatMapLegend(options?: ej.datavisualization.HeatMapLegend.Model): JQuery; ejHeatMapLegend(memberName: any, value?: any, param?: any): any; +data(key: "ejHeatMapLegend"): ej.datavisualization.HeatMapLegend; +ejKanban(): JQuery; ejKanban(options?: ej.Kanban.Model): JQuery; ejKanban(memberName: any, value?: any, param?: any): any; +data(key: "ejKanban"): ej.Kanban; +ejLinearGauge(): JQuery; ejLinearGauge(options?: ej.datavisualization.LinearGauge.Model): JQuery; ejLinearGauge(memberName: any, value?: any, param?: any): any; +data(key: "ejLinearGauge"): ej.datavisualization.LinearGauge; +ejListBox(): JQuery; ejListBox(options?: ej.ListBox.Model): JQuery; ejListBox(memberName: any, value?: any, param?: any): any; +data(key: "ejListBox"): ej.ListBox; +ejListView(): JQuery; ejListView(options?: ej.ListView.Model): JQuery; ejListView(memberName: any, value?: any, param?: any): any; +data(key: "ejListView"): ej.ListView; +ejMap(): JQuery; ejMap(options?: ej.datavisualization.Map.Model): JQuery; ejMap(memberName: any, value?: any, param?: any): any; +data(key: "ejMap"): ej.datavisualization.Map; +ejMaskEdit(): JQuery; ejMaskEdit(options?: ej.MaskEdit.Model): JQuery; ejMaskEdit(memberName: any, value?: any, param?: any): any; +data(key: "ejMaskEdit"): ej.MaskEdit; +ejMenu(): JQuery; ejMenu(options?: ej.Menu.Model): JQuery; ejMenu(memberName: any, value?: any, param?: any): any; +data(key: "ejMenu"): ej.Menu; +ejNavigationDrawer(): JQuery; ejNavigationDrawer(options?: ej.NavigationDrawer.Model): JQuery; ejNavigationDrawer(memberName: any, value?: any, param?: any): any; +data(key: "ejNavigationDrawer"): ej.NavigationDrawer; +ejOverview(): JQuery; ejOverview(options?: ej.datavisualization.Overview.Model): JQuery; ejOverview(memberName: any, value?: any, param?: any): any; +data(key: "ejOverview"): ej.datavisualization.Overview; +ejPager(): JQuery; ejPager(options?: ej.Pager.Model): JQuery; ejPager(memberName: any, value?: any, param?: any): any; +data(key: "ejPager"): ej.Pager; +ejPdfViewer(): JQuery; ejPdfViewer(options?: ej.PdfViewer.Model): JQuery; ejPdfViewer(memberName: any, value?: any, param?: any): any; +data(key: "ejPdfViewer"): ej.PdfViewer; +ejPivotChart(): JQuery; ejPivotChart(options?: ej.PivotChart.Model): JQuery; ejPivotChart(memberName: any, value?: any, param?: any): any; +data(key: "ejPivotChart"): ej.PivotChart; +ejPivotClient(): JQuery; ejPivotClient(options?: ej.PivotClient.Model): JQuery; ejPivotClient(memberName: any, value?: any, param?: any): any; +data(key: "ejPivotClient"): ej.PivotClient; +ejPivotGauge(): JQuery; ejPivotGauge(options?: ej.PivotGauge.Model): JQuery; ejPivotGauge(memberName: any, value?: any, param?: any): any; +data(key: "ejPivotGauge"): ej.PivotGauge; +ejPivotGrid(): JQuery; ejPivotGrid(options?: ej.PivotGrid.Model): JQuery; ejPivotGrid(memberName: any, value?: any, param?: any): any; +data(key: "ejPivotGrid"): ej.PivotGrid; +ejPivotPager(): JQuery; ejPivotPager(options?: ej.PivotPager.Model): JQuery; ejPivotPager(memberName: any, value?: any, param?: any): any; +data(key: "ejPivotPager"): ej.PivotPager; +ejPivotSchemaDesigner(): JQuery; ejPivotSchemaDesigner(options?: ej.PivotSchemaDesigner.Model): JQuery; ejPivotSchemaDesigner(memberName: any, value?: any, param?: any): any; +data(key: "ejPivotSchemaDesigner"): ej.PivotSchemaDesigner; +ejPivotTreeMap(): JQuery; ejPivotTreeMap(options?: ej.PivotTreeMap.Model): JQuery; ejPivotTreeMap(memberName: any, value?: any, param?: any): any; +data(key: "ejPivotTreeMap"): ej.PivotTreeMap; +ejProgressBar(): JQuery; ejProgressBar(options?: ej.ProgressBar.Model): JQuery; ejProgressBar(memberName: any, value?: any, param?: any): any; +data(key: "ejProgressBar"): ej.ProgressBar; +ejRadialMenu(): JQuery; ejRadialMenu(options?: ej.RadialMenu.Model): JQuery; ejRadialMenu(memberName: any, value?: any, param?: any): any; +data(key: "ejRadialMenu"): ej.RadialMenu; +ejRadialSlider(): JQuery; ejRadialSlider(options?: ej.RadialSlider.Model): JQuery; ejRadialSlider(memberName: any, value?: any, param?: any): any; +data(key: "ejRadialSlider"): ej.RadialSlider; +ejRadioButton(): JQuery; ejRadioButton(options?: ej.RadioButton.Model): JQuery; ejRadioButton(memberName: any, value?: any, param?: any): any; +data(key: "ejRadioButton"): ej.RadioButton; +ejRangeNavigator(): JQuery; ejRangeNavigator(options?: ej.datavisualization.RangeNavigator.Model): JQuery; ejRangeNavigator(memberName: any, value?: any, param?: any): any; +data(key: "ejRangeNavigator"): ej.datavisualization.RangeNavigator; +ejRating(): JQuery; ejRating(options?: ej.Rating.Model): JQuery; ejRating(memberName: any, value?: any, param?: any): any; +data(key: "ejRating"): ej.Rating; +ejRecurrenceEditor(): JQuery; ejRecurrenceEditor(options?: ej.RecurrenceEditor.Model): JQuery; ejRecurrenceEditor(memberName: any, value?: any, param?: any): any; +data(key: "ejRecurrenceEditor"): ej.RecurrenceEditor; +ejReportViewer(): JQuery; ejReportViewer(options?: ej.ReportViewer.Model): JQuery; ejReportViewer(memberName: any, value?: any, param?: any): any; +data(key: "ejReportViewer"): ej.ReportViewer; +ejResizable(): JQuery; ejResizable(options?: ej.Resizable.Model): JQuery; ejResizable(memberName: any, value?: any, param?: any): any; +data(key: "ejResizable"): ej.Resizable; +ejRibbon(): JQuery; ejRibbon(options?: ej.Ribbon.Model): JQuery; ejRibbon(memberName: any, value?: any, param?: any): any; +data(key: "ejRibbon"): ej.Ribbon; +ejRotator(): JQuery; ejRotator(options?: ej.Rotator.Model): JQuery; ejRotator(memberName: any, value?: any, param?: any): any; +data(key: "ejRotator"): ej.Rotator; +ejRTE(): JQuery; ejRTE(options?: ej.RTE.Model): JQuery; ejRTE(memberName: any, value?: any, param?: any): any; +data(key: "ejRTE"): ej.RTE; +ejSchedule(): JQuery; ejSchedule(options?: ej.Schedule.Model): JQuery; ejSchedule(memberName: any, value?: any, param?: any): any; +data(key: "ejSchedule"): ej.Schedule; +ejScroller(): JQuery; ejScroller(options?: ej.Scroller.Model): JQuery; ejScroller(memberName: any, value?: any, param?: any): any; +data(key: "ejScroller"): ej.Scroller; +ejSignature(): JQuery; ejSignature(options?: ej.Signature.Model): JQuery; ejSignature(memberName: any, value?: any, param?: any): any; +data(key: "ejSignature"): ej.Signature; +ejSlider(): JQuery; ejSlider(options?: ej.Slider.Model): JQuery; ejSlider(memberName: any, value?: any, param?: any): any; +data(key: "ejSlider"): ej.Slider; +ejSparkline(): JQuery; ejSparkline(options?: ej.datavisualization.Sparkline.Model): JQuery; ejSparkline(memberName: any, value?: any, param?: any): any; +data(key: "ejSparkline"): ej.datavisualization.Sparkline; +ejSpellCheck(): JQuery; ejSpellCheck(options?: ej.SpellCheck.Model): JQuery; ejSpellCheck(memberName: any, value?: any, param?: any): any; +data(key: "ejSpellCheck"): ej.SpellCheck; +ejSplitButton(): JQuery; ejSplitButton(options?: ej.SplitButton.Model): JQuery; ejSplitButton(memberName: any, value?: any, param?: any): any; +data(key: "ejSplitButton"): ej.SplitButton; +ejSplitter(): JQuery; ejSplitter(options?: ej.Splitter.Model): JQuery; ejSplitter(memberName: any, value?: any, param?: any): any; +data(key: "ejSplitter"): ej.Splitter; +ejSpreadsheet(): JQuery; ejSpreadsheet(options?: ej.Spreadsheet.Model): JQuery; ejSpreadsheet(memberName: any, value?: any, param?: any): any; +data(key: "ejSpreadsheet"): ej.Spreadsheet; +ejSunburstChart(): JQuery; ejSunburstChart(options?: ej.datavisualization.SunburstChart.Model): JQuery; ejSunburstChart(memberName: any, value?: any, param?: any): any; +data(key: "ejSunburstChart"): ej.datavisualization.SunburstChart; +ejSymbolPalette(): JQuery; ejSymbolPalette(options?: ej.datavisualization.SymbolPalette.Model): JQuery; ejSymbolPalette(memberName: any, value?: any, param?: any): any; +data(key: "ejSymbolPalette"): ej.datavisualization.SymbolPalette; +ejTab(): JQuery; ejTab(options?: ej.Tab.Model): JQuery; ejTab(memberName: any, value?: any, param?: any): any; +data(key: "ejTab"): ej.Tab; +ejTagCloud(): JQuery; ejTagCloud(options?: ej.TagCloud.Model): JQuery; ejTagCloud(memberName: any, value?: any, param?: any): any; +data(key: "ejTagCloud"): ej.TagCloud; +ejNumericTextbox(): JQuery; ejNumericTextbox(options?: ej.Editor.Model): JQuery; ejNumericTextbox(memberName: any, value?: any, param?: any): any; +data(key: "ejNumericTextbox"): ej.NumericTextbox; +ejCurrencyTextbox(): JQuery; ejCurrencyTextbox(options?: ej.Editor.Model): JQuery; ejCurrencyTextbox(memberName: any, value?: any, param?: any): any; +data(key: "ejCurrencyTextbox"): ej.CurrencyTextbox; +ejPercentageTextbox(): JQuery; ejPercentageTextbox(options?: ej.Editor.Model): JQuery; ejPercentageTextbox(memberName: any, value?: any, param?: any): any; +data(key: "ejPercentageTextbox"): ej.PercentageTextbox; +ejTile(): JQuery; ejTile(options?: ej.Tile.Model): JQuery; ejTile(memberName: any, value?: any, param?: any): any; +data(key: "ejTile"): ej.Tile; +ejTimePicker(): JQuery; ejTimePicker(options?: ej.TimePicker.Model): JQuery; ejTimePicker(memberName: any, value?: any, param?: any): any; +data(key: "ejTimePicker"): ej.TimePicker; +ejToggleButton(): JQuery; ejToggleButton(options?: ej.ToggleButton.Model): JQuery; ejToggleButton(memberName: any, value?: any, param?: any): any; +data(key: "ejToggleButton"): ej.ToggleButton; +ejToolbar(): JQuery; ejToolbar(options?: ej.Toolbar.Model): JQuery; ejToolbar(memberName: any, value?: any, param?: any): any; +data(key: "ejToolbar"): ej.Toolbar; +ejTooltip(): JQuery; ejTooltip(options?: ej.Tooltip.Model): JQuery; ejTooltip(memberName: any, value?: any, param?: any): any; +data(key: "ejTooltip"): ej.Tooltip; +ejTreeGrid(): JQuery; ejTreeGrid(options?: ej.TreeGrid.Model): JQuery; ejTreeGrid(memberName: any, value?: any, param?: any): any; +data(key: "ejTreeGrid"): ej.TreeGrid; +ejTreeMap(): JQuery; ejTreeMap(options?: ej.datavisualization.TreeMap.Model): JQuery; ejTreeMap(memberName: any, value?: any, param?: any): any; +data(key: "ejTreeMap"): ej.datavisualization.TreeMap; +ejTreeView(): JQuery; ejTreeView(options?: ej.TreeView.Model): JQuery; ejTreeView(memberName: any, value?: any, param?: any): any; +data(key: "ejTreeView"): ej.TreeView; +ejUploadbox(): JQuery; ejUploadbox(options?: ej.Uploadbox.Model): JQuery; ejUploadbox(memberName: any, value?: any, param?: any): any; +data(key: "ejUploadbox"): ej.Uploadbox; +ejWaitingPopup(): JQuery; ejWaitingPopup(options?: ej.WaitingPopup.Model): JQuery; ejWaitingPopup(memberName: any, value?: any, param?: any): any; - -data(key: "ejAccordion"): ej.Accordion; -data(key: "ejAutocomplete"): ej.Autocomplete; -data(key: "ejBarcode"): ej.datavisualization.Barcode; -data(key: "ejBulletGraph"): ej.datavisualization.BulletGraph; -data(key: "ejButton"): ej.Button; -data(key: "ejCaptcha"): ej.Captcha; -data(key: "ejChart"): ej.datavisualization.Chart; -data(key: "ejCheckBox"): ej.CheckBox; -data(key: "ejCircularGauge"): ej.datavisualization.CircularGauge; -data(key: "ejColorPicker"): ej.ColorPicker; -data(key: "ejDatePicker"): ej.DatePicker; -data(key: "ejDateRangePicker"): ej.DateRangePicker; -data(key: "ejDateTimePicker"): ej.DateTimePicker; -data(key: "ejDiagram"): ej.datavisualization.Diagram; -data(key: "ejDialog"): ej.Dialog; -data(key: "ejDigitalGauge"): ej.datavisualization.DigitalGauge; -data(key: "ejDocumentEditor"): ej.DocumentEditor; -data(key: "ejDraggable"): ej.Draggable; -data(key: "ejDropDownList"): ej.DropDownList; -data(key: "ejDroppable"): ej.Droppable; -data(key: "ejFileExplorer"): ej.FileExplorer; -data(key: "ejGantt"): ej.Gantt; -data(key: "ejGrid"): ej.Grid; -data(key: "ejGroupButton"): ej.GroupButton; -data(key: "ejHeatMap"): ej.datavisualization.HeatMap; -data(key: "ejHeatMapLegend"): ej.datavisualization.HeatMapLegend; -data(key: "ejKanban"): ej.Kanban; -data(key: "ejLinearGauge"): ej.datavisualization.LinearGauge; -data(key: "ejListBox"): ej.ListBox; -data(key: "ejListView"): ej.ListView; -data(key: "ejMap"): ej.datavisualization.Map; -data(key: "ejMaskEdit"): ej.MaskEdit; -data(key: "ejMenu"): ej.Menu; -data(key: "ejNavigationDrawer"): ej.NavigationDrawer; -data(key: "ejOverview"): ej.datavisualization.Overview; -data(key: "ejPager"): ej.Pager; -data(key: "ejPdfViewer"): ej.PdfViewer; -data(key: "ejPivotChart"): ej.PivotChart; -data(key: "ejPivotClient"): ej.PivotClient; -data(key: "ejPivotGauge"): ej.PivotGauge; -data(key: "ejPivotGrid"): ej.PivotGrid; -data(key: "ejPivotPager"): ej.PivotPager; -data(key: "ejPivotSchemaDesigner"): ej.PivotSchemaDesigner; -data(key: "ejPivotTreeMap"): ej.PivotTreeMap; -data(key: "ejProgressBar"): ej.ProgressBar; -data(key: "ejRadialMenu"): ej.RadialMenu; -data(key: "ejRadialSlider"): ej.RadialSlider; -data(key: "ejRadioButton"): ej.RadioButton; -data(key: "ejRangeNavigator"): ej.datavisualization.RangeNavigator; -data(key: "ejRating"): ej.Rating; -data(key: "ejRecurrenceEditor"): ej.RecurrenceEditor; -data(key: "ejReportViewer"): ej.ReportViewer; -data(key: "ejResizable"): ej.Resizable; -data(key: "ejRibbon"): ej.Ribbon; -data(key: "ejRotator"): ej.Rotator; -data(key: "ejRTE"): ej.RTE; -data(key: "ejSchedule"): ej.Schedule; -data(key: "ejScroller"): ej.Scroller; -data(key: "ejSignature"): ej.Signature; -data(key: "ejSlider"): ej.Slider; -data(key: "ejSparkline"): ej.datavisualization.Sparkline; -data(key: "ejSpellCheck"): ej.SpellCheck; -data(key: "ejSplitButton"): ej.SplitButton; -data(key: "ejSplitter"): ej.Splitter; -data(key: "ejSpreadsheet"): ej.Spreadsheet; -data(key: "ejSunburstChart"): ej.datavisualization.SunburstChart; -data(key: "ejSymbolPalette"): ej.datavisualization.SymbolPalette; -data(key: "ejTab"): ej.Tab; -data(key: "ejTagCloud"): ej.TagCloud; -data(key: "ejNumericTextbox"): ej.NumericTextbox; -data(key: "ejCurrencyTextbox"): ej.CurrencyTextbox; -data(key: "ejPercentageTextbox"): ej.PercentageTextbox; -data(key: "ejTile"): ej.Tile; -data(key: "ejTimePicker"): ej.TimePicker; -data(key: "ejToggleButton"): ej.ToggleButton; -data(key: "ejToolbar"): ej.Toolbar; -data(key: "ejTooltip"): ej.Tooltip; -data(key: "ejTreeGrid"): ej.TreeGrid; -data(key: "ejTreeMap"): ej.datavisualization.TreeMap; -data(key: "ejTreeView"): ej.TreeView; -data(key: "ejUploadbox"): ej.Uploadbox; data(key: "ejWaitingPopup"): ej.WaitingPopup; } From 85b26475136eb8071c2675717b2c05b36270765d Mon Sep 17 00:00:00 2001 From: Wayne Dela Cruz Date: Thu, 30 Mar 2017 19:53:06 +0800 Subject: [PATCH 073/844] Material-ui tests less hacky Suggested by @vsiao --- types/material-ui/material-ui-tests.tsx | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/types/material-ui/material-ui-tests.tsx b/types/material-ui/material-ui-tests.tsx index 2388630d8f..6e60d6fc0e 100644 --- a/types/material-ui/material-ui-tests.tsx +++ b/types/material-ui/material-ui-tests.tsx @@ -109,13 +109,7 @@ function handleTouchTap() { alert('onTouchTap triggered on the title component'); } -type Stylesheet = { - [P in keyof T]: React.CSSProperties -}; - -declare function createStylesheet(args: T): Stylesheet; - -const styles = createStylesheet({ +const styles: { [key: string]: React.CSSProperties } = { title: { cursor: 'pointer', }, @@ -238,7 +232,7 @@ const styles = createStylesheet({ floatingLabelFocusStyle: { color: blue500, }, -}); +}; const style = { marginRight: 20, From 7ca4941d991cd82ada692a4735bf8bc2bfbcc098 Mon Sep 17 00:00:00 2001 From: Wayne Dela Cruz Date: Thu, 30 Mar 2017 19:55:26 +0800 Subject: [PATCH 074/844] Use double quotes instead of single quotes --- types/react/index.d.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/types/react/index.d.ts b/types/react/index.d.ts index 969c86f353..62233663d9 100644 --- a/types/react/index.d.ts +++ b/types/react/index.d.ts @@ -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 | 'auto' | 'hidden' | 'scroll' | 'visible'; + 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 | 'auto' | 'hidden' | 'scroll' | 'visible'; + 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 | 'auto' | 'hidden' | 'scroll' | 'visible'; + 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. From 05513e0a0ad8acd01216587583de7b4bee2eae9a Mon Sep 17 00:00:00 2001 From: Denis Date: Thu, 30 Mar 2017 08:30:25 -0400 Subject: [PATCH 075/844] leaflet.locate - remove useless package.json --- types/leaflet.locatecontrol/index.d.ts | 2 +- types/leaflet.locatecontrol/package.json | 5 ----- 2 files changed, 1 insertion(+), 6 deletions(-) delete mode 100644 types/leaflet.locatecontrol/package.json diff --git a/types/leaflet.locatecontrol/index.d.ts b/types/leaflet.locatecontrol/index.d.ts index 3f4d94e9ce..5758caed85 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 diff --git a/types/leaflet.locatecontrol/package.json b/types/leaflet.locatecontrol/package.json deleted file mode 100644 index 8afe476d51..0000000000 --- a/types/leaflet.locatecontrol/package.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "dependencies": { - "@types/leaflet": "^1.0.58" - } -} From 29cf119a4665469a83667e9bc61b4442b2080aa5 Mon Sep 17 00:00:00 2001 From: Denis Date: Thu, 30 Mar 2017 08:31:43 -0400 Subject: [PATCH 076/844] Update with typeRoots --- types/leaflet.locatecontrol/tsconfig.json | 3 +++ 1 file changed, 3 insertions(+) diff --git a/types/leaflet.locatecontrol/tsconfig.json b/types/leaflet.locatecontrol/tsconfig.json index 0637d48285..0ccab11228 100644 --- a/types/leaflet.locatecontrol/tsconfig.json +++ b/types/leaflet.locatecontrol/tsconfig.json @@ -9,6 +9,9 @@ "noImplicitThis": true, "strictNullChecks": true, "baseUrl": "../", + "typeRoots": [ + "../" + ], "types": [], "noEmit": true, "forceConsistentCasingInFileNames": true From 7a3e30fc163ad470527a211e265d6ca945c5a823 Mon Sep 17 00:00:00 2001 From: Viktor Smirnov Date: Thu, 30 Mar 2017 16:05:15 +0300 Subject: [PATCH 077/844] angular-material updated resolve object type --- .../angular-material-tests.ts | 71 +++++++++++++------ types/angular-material/index.d.ts | 13 ++-- 2 files changed, 58 insertions(+), 26 deletions(-) diff --git a/types/angular-material/angular-material-tests.ts b/types/angular-material/angular-material-tests.ts index f9195ec999..848eaa8402 100644 --- a/types/angular-material/angular-material-tests.ts +++ b/types/angular-material/angular-material-tests.ts @@ -22,9 +22,9 @@ myApp.config(( .dark(true); var browserColors: ng.material.IBrowserColors = { - theme: 'default', - palette: 'neonRed', - hue: '500' + theme: 'default', + palette: 'neonRed', + hue: '500' }; $mdThemingProvider.enableBrowserColor(browserColors); @@ -45,14 +45,20 @@ myApp.config(( }); }); -myApp.controller('BottomSheetController', ($scope: ng.IScope, $mdBottomSheet: ng.material.IBottomSheetService) => { +myApp.controller('BottomSheetController', ($scope: ng.IScope, $mdBottomSheet: ng.material.IBottomSheetService, $q: ng.IQService) => { $scope['openBottomSheet'] = () => { $mdBottomSheet.show({ template: 'Hello!', clickOutsideToClose: true, disableBackdrop: true, disableParentScroll: false, - parent: () => {} + parent: () => { }, + resolve: { + r1: () => $q.resolve(), + r2: () => Promise.resolve(), + r3: ['fakeService', (fake) => $q.resolve()], + r4: ['fakeService', (fake) => Promise.resolve()], + } }); }; $scope['hideBottomSheet'] = $mdBottomSheet.hide.bind($mdBottomSheet, 'hide'); @@ -60,8 +66,8 @@ myApp.controller('BottomSheetController', ($scope: ng.IScope, $mdBottomSheet: ng }); myApp.controller('ColorController', ($scope: ng.IScope, $mdColor: ng.material.IColorService) => { - var colorExpression : ng.material.IColorExpression; - var element : Element; + var colorExpression: ng.material.IColorExpression; + var element: Element; colorExpression = { color: '#FFFFFF' } @@ -78,10 +84,16 @@ myApp.controller('ColorController', ($scope: ng.IScope, $mdColor: ng.material.IC }; }); -myApp.controller('DialogController', ($scope: ng.IScope, $mdDialog: ng.material.IDialogService) => { +myApp.controller('DialogController', ($scope: ng.IScope, $mdDialog: ng.material.IDialogService, $q: ng.IQService) => { $scope['openDialog'] = () => { $mdDialog.show({ - template: 'Hello!' + template: 'Hello!', + resolve: { + r1: () => $q.resolve(), + r2: () => Promise.resolve(), + r3: ['fakeService', (fake) => $q.resolve()], + r4: ['fakeService', (fake) => Promise.resolve()], + } }); }; $scope['alertDialog'] = () => { @@ -109,7 +121,12 @@ myApp.controller('DialogController', ($scope: ng.IScope, $mdDialog: ng.material. $mdDialog.show($mdDialog.prompt().placeholder('Prompt input placeholder text')); }; $scope['promptDialog'] = () => { - $mdDialog.show($mdDialog.prompt().initialValue('Buddy')); + $mdDialog.show($mdDialog.prompt().initialValue('Buddy').resolve({ + r1: () => $q.resolve(), + r2: () => Promise.resolve(), + r3: ['fakeService', (fake) => $q.resolve()], + r4: ['fakeService', (fake) => Promise.resolve()], + })); }; $scope['prerenderedDialog'] = () => { $mdDialog.show({ @@ -165,38 +182,50 @@ myApp.controller('SidenavController', ($scope: ng.IScope, $mdSidenav: ng.materia instance.isLockedOpen(); }); - $scope['onClose'] = $mdSidenav(componentId).onClose(() => {}); + $scope['onClose'] = $mdSidenav(componentId).onClose(() => { }); }); -myApp.controller('ToastController', ($scope: ng.IScope, $mdToast: ng.material.IToastService) => { +myApp.controller('ToastController', ($scope: ng.IScope, $mdToast: ng.material.IToastService, $q: ng.IQService) => { $scope['openToast'] = () => { $mdToast.show($mdToast.simple().textContent('Hello!')); $mdToast.updateTextContent('New Content'); } $scope['customToast'] = () => { - var options = { + var options: ng.material.IToastOptions = { hideDelay: 3000, position: 'top right', - controller : 'ToastCtrl', - templateUrl : 'toast-template.html', - toastClass: 'my-class' + controller: 'ToastCtrl', + templateUrl: 'toast-template.html', + toastClass: 'my-class', + resolve: { + r1: () => $q.resolve(), + r2: () => Promise.resolve(), + r3: ['fakeService', (fake) => $q.resolve()], + r4: ['fakeService', (fake) => Promise.resolve()], + } }; $mdToast.show(options); } }); -myApp.controller('PanelController', ($scope: ng.IScope, $mdPanel: ng.material.IPanelService) => { +myApp.controller('PanelController', ($scope: ng.IScope, $mdPanel: ng.material.IPanelService, $q: ng.IQService) => { $scope['createPanel'] = () => { - var config = { + var config: ng.material.IPanelConfig = { id: 'myPanel', template: '

    Hello!

    ', hasBackdrop: true, disableParentScroll: true, - zIndex: 150 + zIndex: 150, + resolve: { + r1: () => $q.resolve(), + r2: () => Promise.resolve(), + r3: ['fakeService', (fake) => $q.resolve()], + r4: ['fakeService', (fake) => Promise.resolve()], + } }; - + $mdPanel.create(config); var panelRef = $mdPanel.create(config); @@ -232,6 +261,6 @@ myApp.controller('PanelController', ($scope: ng.IScope, $mdPanel: ng.material.IP $scope['newPanelAnimation'] = () => { $mdPanel.newPanelAnimation().openFrom('.some-target'); - $mdPanel.newPanelAnimation().openFrom({top: 0, left: 0}); + $mdPanel.newPanelAnimation().openFrom({ top: 0, left: 0 }); }; }); diff --git a/types/angular-material/index.d.ts b/types/angular-material/index.d.ts index a8196269a4..d2473e8014 100644 --- a/types/angular-material/index.d.ts +++ b/types/angular-material/index.d.ts @@ -10,6 +10,9 @@ export = _; declare module 'angular' { export namespace material { + + type ResolveObject = { [index: string]: angular.Injectable<(...args: any[]) => PromiseLike> }; + interface IBottomSheetOptions { templateUrl?: string; template?: string; @@ -21,7 +24,7 @@ declare module 'angular' { bindToController?: boolean; // default: false disableBackdrop?: boolean; escapeToClose?: boolean; - resolve?: { [index: string]: () => angular.IPromise }; + resolve?: ResolveObject; controllerAs?: string; parent?: Function | string | Object; // default: root node disableParentScroll?: boolean; // default: true @@ -52,7 +55,7 @@ declare module 'angular' { controller(controller?: string | Function): T; locals(locals?: { [index: string]: any }): T; bindToController(bindToController?: boolean): T; // default: false - resolve(resolve?: { [index: string]: () => angular.IPromise }): T; + resolve(resolve?: ResolveObject): T; controllerAs(controllerAs?: string): T; parent(parent?: string | Element | JQuery): T; // default: root node onComplete(onComplete?: Function): T; @@ -100,7 +103,7 @@ declare module 'angular' { controller?: string | Function; locals?: { [index: string]: any }; bindToController?: boolean; // default: false - resolve?: { [index: string]: () => angular.IPromise } + resolve?: ResolveObject; controllerAs?: string; parent?: string | Element | JQuery; // default: root node onShowing?: Function; @@ -178,7 +181,7 @@ declare module 'angular' { controller?: string | Function; locals?: { [index: string]: any }; bindToController?: boolean; // default: false - resolve?: { [index: string]: () => angular.IPromise } + resolve?: ResolveObject; controllerAs?: string; parent?: string | Element | JQuery; // default: root node } @@ -332,7 +335,7 @@ declare module 'angular' { controllerAs?: string; bindToController?: boolean; // default: true locals?: { [index: string]: any }; - resolve?: { [index: string]: () => angular.IPromise } + resolve?: ResolveObject; attachTo?: string | JQuery | Element; propagateContainerEvents?: boolean; panelClass?: string; From dce756eb2b31eb3b2e6bc3511a2edf5c08cfac81 Mon Sep 17 00:00:00 2001 From: Ryan Riley Date: Thu, 30 Mar 2017 09:48:53 -0500 Subject: [PATCH 078/844] Fix handsontable.d.ts --- types/handsontable/index.d.ts | 593 +++++++++++++++++----------------- 1 file changed, 293 insertions(+), 300 deletions(-) diff --git a/types/handsontable/index.d.ts b/types/handsontable/index.d.ts index ea57730f93..55e2d25e4d 100644 --- a/types/handsontable/index.d.ts +++ b/types/handsontable/index.d.ts @@ -1,295 +1,296 @@ -// Type definitions for Handsontable 0.30 +// Type definitions for Handsontable 0.31 // Project: https://handsontable.com/ -// Definitions by: Handsoncode sp. z o.o. +// Definitions by: Handsoncode sp. z o.o. , Ryan Riley // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped\ declare namespace ht { - interface Options { - allowEmpty?: boolean; - allowInsertColumn?: boolean; - allowInsertRow?: boolean; - allowInvalid?: boolean; - allowRemoveColumn?: boolean; - allowRemoveRow?: boolean; - autoColumnSize?: Object|boolean; - autoComplete?: any[]; - autoRowSize?: Object|boolean; - autoWrapCol?: boolean; - autoWrapRow?: boolean; - bindRowsWithHeaders?: boolean|string; - cell?: any[]; - cells?: Function; - checkedTemplate?: boolean|string; - className?: string|any[]; - colHeaders?: boolean|any[]|Function; - collapsibleColumns?: boolean|any[]; - columnHeaderHeight?: number|any[]; - columns?: any[]; - columnSorting?: boolean|Object; - columnSummary?: Object; - colWidths?: any[]|Function|number|string; - commentedCellClassName?: string; - comments?: boolean|any[]; - contextMenu?: boolean|any[]|Object; - contextMenuCopyPaste?: Object; - copyable?: boolean; - copyColsLimit?: number; - copyPaste?: boolean; - copyRowsLimit?: number; - correctFormat?: boolean; - currentColClassName?: string; - currentRowClassName?: string; - customBorders?: boolean|any[]; - data?: any[]|Function; - dataSchema?: Object; - dateFormat?: string; - debug?: boolean; - defaultDate?: string; - disableVisualSelection?: boolean|string|any[]; - dropdownMenu?: boolean|Object|any[]; - editor?: string|Function|boolean; - enterBeginsEditing?: boolean; - enterMoves?: Object|Function; - fillHandle?: boolean|string|Object; - filter?: boolean; - filteringCaseSensitive?: boolean; - filters?: boolean; - fixedColumnsLeft?: number; - fixedRowsBottom?: number; - fixedRowsTop?: number; - format?: string; - fragmentSelection?: boolean|string; - ganttChart?: Object; - headerTooltips?: boolean|Object; - height?: number|Function; - hiddenColumns?: boolean|Object; - hiddenRows?: boolean|Object; - invalidCellClassName?: string; - label?: Object; - language?: string; - manualColumnFreeze?: boolean; - manualColumnMove?: boolean|any[]; - manualColumnResize?: boolean|any[]; - manualRowMove?: boolean|any[]; - manualRowResize?: boolean|any[]; - maxCols?: number; - maxRows?: number; - mergeCells?: boolean|any[]; - minCols?: number; - minRows?: number; - minSpareCols?: number; - minSpareRows?: number; - multiSelect?: boolean; - nestedHeaders?: any[]; - noWordWrapClassName?: string; - observeChanges?: boolean; - observeDOMVisibility?: boolean; - outsideClickDeselects?: boolean; - pasteMode?: string; - persistentState?: boolean; - placeholder?: any; - placeholderCellClassName?: string; - preventOverflow?: string|boolean; - readOnly?: boolean; - readOnlyCellClassName?: string; - renderAllRows?: boolean; - renderer?: string|Function; - rowHeaders?: boolean|any[]|Function; - rowHeaderWidth?: number|any[]; - rowHeights?: any[]|Function|number|string; - search?: boolean; - selectOptions?: any[]; - skipColumnOnPaste?: boolean; - sortByRelevance?: boolean; - sortFunction?: Function; - sortIndicator?: boolean; - source?: any[]|Function; - startCols?: number; - startRows?: number; - stretchH?: string; - strict?: boolean; - tableClassName?: string|any[]; - tabMoves?: Object; - title?: string; - trimDropdown?: boolean; - trimWhitespace?: boolean; - type?: string; - uncheckedTemplate?: boolean|string; - undo?: boolean; - validator?: Function|RegExp; - viewportColumnRenderingOffset?: number|string; - viewportRowRenderingOffset?: number|string; - visibleRows?: number; - width?: number|Function; - wordWrap?: boolean; - isEmptyCol?(col: number): boolean; - isEmptyRow?(row: number): boolean; + interface Options { + allowEmpty?: boolean; + allowInsertColumn?: boolean; + allowInsertRow?: boolean; + allowInvalid?: boolean; + allowRemoveColumn?: boolean; + allowRemoveRow?: boolean; + autoColumnSize?: Object|boolean; + autoComplete?: any[]; + autoRowSize?: Object|boolean; + autoWrapCol?: boolean; + autoWrapRow?: boolean; + bindRowsWithHeaders?: boolean|string; + cell?: any[]; + cells?: Function; + checkedTemplate?: boolean|string; + className?: string|any[]; + colHeaders?: boolean|any[]|Function; + collapsibleColumns?: boolean|any[]; + columnHeaderHeight?: number|any[]; + columns?: any[]; + columnSorting?: boolean|Object; + columnSummary?: Object; + colWidths?: any[]|Function|number|string; + commentedCellClassName?: string; + comments?: boolean|any[]; + contextMenu?: boolean|any[]|Object; + contextMenuCopyPaste?: Object; + copyable?: boolean; + copyColsLimit?: number; + copyPaste?: boolean; + copyRowsLimit?: number; + correctFormat?: boolean; + currentColClassName?: string; + currentRowClassName?: string; + customBorders?: boolean|any[]; + data?: any[]|Function; + dataSchema?: Object; + dateFormat?: string; + debug?: boolean; + defaultDate?: string; + disableVisualSelection?: boolean|string|any[]; + dropdownMenu?: boolean|Object|any[]; + editor?: string|Function|boolean; + enterBeginsEditing?: boolean; + enterMoves?: Object|Function; + fillHandle?: boolean|string|Object; + filter?: boolean; + filteringCaseSensitive?: boolean; + filters?: boolean; + fixedColumnsLeft?: number; + fixedRowsBottom?: number; + fixedRowsTop?: number; + format?: string; + fragmentSelection?: boolean|string; + ganttChart?: Object; + headerTooltips?: boolean|Object; + height?: number|Function; + hiddenColumns?: boolean|Object; + hiddenRows?: boolean|Object; + invalidCellClassName?: string; + label?: Object; + language?: string; + manualColumnFreeze?: boolean; + manualColumnMove?: boolean|any[]; + manualColumnResize?: boolean|any[]; + manualRowMove?: boolean|any[]; + manualRowResize?: boolean|any[]; + maxCols?: number; + maxRows?: number; + mergeCells?: boolean|any[]; + minCols?: number; + minRows?: number; + minSpareCols?: number; + minSpareRows?: number; + multiSelect?: boolean; + nestedHeaders?: any[]; + noWordWrapClassName?: string; + observeChanges?: boolean; + observeDOMVisibility?: boolean; + outsideClickDeselects?: boolean; + pasteMode?: string; + persistentState?: boolean; + placeholder?: any; + placeholderCellClassName?: string; + preventOverflow?: string|boolean; + readOnly?: boolean; + readOnlyCellClassName?: string; + renderAllRows?: boolean; + renderer?: string|Function; + rowHeaders?: boolean|any[]|Function; + rowHeaderWidth?: number|any[]; + rowHeights?: any[]|Function|number|string; + search?: boolean; + selectOptions?: any[]; + skipColumnOnPaste?: boolean; + sortByRelevance?: boolean; + sortFunction?: Function; + sortIndicator?: boolean; + source?: any[]|Function; + startCols?: number; + startRows?: number; + stretchH?: string; + strict?: boolean; + tableClassName?: string|any[]; + tabMoves?: Object; + title?: string; + trimDropdown?: boolean; + trimWhitespace?: boolean; + type?: string; + uncheckedTemplate?: boolean|string; + undo?: boolean; + validator?: Function|RegExp; + viewportColumnRenderingOffset?: number|string; + viewportRowRenderingOffset?: number|string; + visibleRows?: number; + width?: number|Function; + wordWrap?: boolean; + isEmptyCol?(col: number): boolean; + isEmptyRow?(row: number): boolean; - // hooks - afterAutofillApplyValues?(startArea: any[], entireArea: any[]): void; - afterCellMetaReset?(): void; - afterChange?(changes: any[], source: string): void; - afterChangesObserved?(): void; - afterColumnMove?(startColumn: number, endColumn: number): void; - afterColumnResize?(currentColumn: number, newSize: number, isDoubleClick: boolean): void; - afterColumnSort?(column: number, order: boolean): void; - afterContextMenuDefaultOptions?(predefinedItems: any[]): void; - afterContextMenuHide?(context: Object): void; - afterContextMenuShow?(context: Object): void; - afterCopyLimit?(selectedRows: number, selectedColumnds: number, copyRowsLimit: number, copyColumnsLimit: number): void; - afterCreateCol?(index: number, amount: number): void; - afterCreateRow?(index: number, amount: number): void; - afterDeselect?(): void; - afterDestroy?(): void; - afterDocumentKeyDown?(event: Event): void; - afterFilter?(formulasStack: any[]): void; - afterGetCellMeta?(row: number, col: number, cellProperties: Object): void; - afterGetColHeader?(col: number, TH: Element): void; - afterGetColumnHeaderRenderers?(array: any[]): void; - afterGetRowHeader?(row: number, TH: Element): void; - afterGetRowHeaderRenderers?(array: any[]): void; - afterInit?(): void; - afterLoadData?(firstTime: boolean): void; - afterMomentumScroll?(): void; - afterOnCellCornerMouseDown?(event: Object): void; - afterOnCellMouseDown?(event: Object, coords: Object, TD: Element): void; - afterOnCellMouseOver?(event: Object, coords: Object, TD: Element): void; - afterRemoveCol?(index: number, amount: number): void; - afterRemoveRow?(index: number, amount: number): void; - afterRender?(isForced: boolean): void; - afterRenderer?(TD: Element, row: number, col: number, prop: string|number, value: string, cellProperties: Object): void; - afterRowMove?(startRow: number, endRow: number): void; - afterRowResize?(currentRow: number, newSize: number, isDoubleClick: boolean): void; - afterScrollHorizontally?(): void; - afterScrollVertically?(): void; - afterSelection?(r: number, c: number, r2: number, c2: number): void; - afterSelectionByProp?(r: number, p: string, r2: number, p2: string): void; - afterSelectionEnd?(r: number, c: number, r2: number, c2: number): void; - afterSelectionEndByProp?(r: number, p: string, r2: number, p2: string): void; - afterSetCellMeta?(row: number, col: number, key: string, value: any): void; - afterUpdateSettings?(): void; - afterValidate?(isValid: boolean, value: any, row: number, prop: string|number, source: string): void|boolean; - beforeAutofill?(start: Object, end: Object, data: any[]): void; - beforeCellAlignment?(stateBefore: any, range: any, type: string, alignmentClass: string): void; - beforeChange?(changes: any[], source: string): void; - beforeChangeRender?(changes: any[], source: string): void; - beforeColumnMove?(startColumn: number, endColumn: number): void; - beforeColumnResize?(currentColumn: number, newSize: number, isDoubleClick: boolean): void; - beforeColumnSort?(column: number, order: boolean): void; - beforeDrawBorders?(corners: any[], borderClassName: string): void; - beforeFilter?(formulasStack: any[]): void; - beforeGetCellMeta?(row: number, col: number, cellProperties: Object): void; - beforeInit?(): void; - beforeInitWalkontable?(walkontableConfig: Object): void; - beforeKeyDown?(event: Event): void; - beforeOnCellMouseDown?(event: Event, coords: Object, TD: Element): void; - beforeRemoveCol?(index: number, amount: number, logicalCols?: any[]): void; - beforeRemoveRow?(index: number, amount: number, logicalRows?: any[]): void; - beforeRender?(isForced: boolean): void; - beforeRenderer?(TD: Element, row: number, col: number, prop: string|number, value: string, cellProperties: Object): void; - beforeRowMove?(startRow: number, endRow: number): void; - beforeRowResize?(currentRow: number, newSize: number, isDoubleClick: boolean): any; - beforeSetRangeEnd?(coords: any[]): void; - beforeStretchingColumnWidth?(stretchedWidth: number, column: number): void; - beforeTouchScroll?(): void; - beforeValidate?(value: any, row: number, prop: string|number, source: string): void; - construct?(): void; - init?(): void; - modifyCol?(col: number): void; - modifyColHeader?(column: number): void; - modifyColWidth?(width: number, col: number): void; - modifyCopyableRange?(copyableRanges: any[]): void; - modifyRow?(row: number): void; - modifyRowHeader?(row: number): void; - modifyRowHeight?(height: number, row: number): void; - persistentStateLoad?(key: string, valuePlaceholder: Object): void; - persistentStateReset?(key: string): void; - persistentStateSave?(key: string, value: any): void; - unmodifyCol?(col: number): void; - } - interface Methods { - addHook(key: string, callback: Function|any[]): void; - addHookOnce(key: string, callback: Function|any[]): void; - alter(action: string, index: number, amount?: number, source?: string, keepEmptyRows?: boolean): void; - clear(): void; - colOffset(): number; - colToProp(col: number): string|number; - countCols(): number; - countEmptyCols(ending?: boolean): number; - countEmptyRows(ending?: boolean): number; - countRenderedCols(): number; - countRenderedRows(): number; - countRows(): number; - countSourceRows(): number; - countVisibleCols(): number; - countVisibleRows(): number; - deselectCell(): void; - destroy(): void; - destroyEditor(revertOriginal?: boolean): void; - getActiveEditor(): Object; - getCell(row: number, col: number, topmost?: boolean): Element; - getCellEditor(row: number, col: number): Object; - getCellMeta(row: number, col: number): Object; - getCellRenderer(row: number, col: number): Function; - getCellValidator(row: number, col: number): any; - getColHeader(col?: number): any[]|string; - getColWidth(col: number): number; - getCoords(elem: Element): Object; - getCopyableData(row: number, column: number): string; - getCopyableText(startRow: number, startCol: number, endRow: number, endCol: number): string; - getData(r?: number, c?: number, r2?: number, c2?: number): any[]; - getDataAtCell(row: number, col: number): any; - getDataAtCol(col: number): any[]; - getDataAtProp(prop: string|number): any[]; - getDataAtRow(row: number): any[]; - getDataAtRowProp(row: number, prop: string): any; - getDataType(rowFrom: number, columnFrom: number, rowTo: number, columnTo: number): string; - getInstance(): any; - getPlugin(pluginName: string): any; - getRowHeader(row?: number): any[]|string; - getRowHeight(row: number): number; - getSchema(): Object; - getSelected(): any[]; - getSelectedRange(): Range; - getSettings(): Options; - getSourceData(r?: number, c?: number, r2?: number, c2?: number): any[]; - getSourceDataAtCell(row: number, column: number): any; - getSourceDataAtCol(column: number): any[]; - getSourceDataAtRow(row: number): any[]|Object; - getValue(): any; - hasColHeaders(): boolean; - hasHook(key: string): boolean; - hasRowHeaders(): boolean; - isEmptyCol(col: number): boolean; - isEmptyRow(row: number): boolean; - isListening(): boolean; - listen(): void; - loadData(data: any[]): void; - populateFromArray(row: number, col: number, input: any[], endRow?: number, endCol?: number, source?: string, method?: string, direction?: string, deltas?: any[]): any; - propToCol(prop: string | number): number; - removeCellMeta(row: number, col: number, key: string): void; - removeHook(key: string, callback: Function): void; - render(): void; - rowOffset(): number; - runHooks(key: string, p1?: any, p2?: any, p3?: any, p4?: any, p5?: any, p6?: any): any; - selectCell(row: number, col: number, endRow?: number, endCol?: number, scrollToCell?: boolean, changeListener?: boolean): boolean; - selectCellByProp(row: number, prop: string, endRow?: number, endProp?: string, scrollToCell?: boolean): boolean; - setCellMeta(row: number, col: number, key: string, val: string): void; - setCellMetaObject(row: number, col: number, prop: Object): void; - setDataAtCell(row: number|any[], col: number, value: string, source?: string): void; - setDataAtRowProp(row: number|any[], prop: string, value: string, source?: string): void; - spliceCol(col: number, index: number, amount: number, elements?: any): void; - spliceRow(row: number, index: number, amount: number, elements?: any): void; - toPhysicalRow(row: number): number; - toPhysicalColumn(column: number): number; - toVisualRow(row: number): number; - toVisualColumn(column: number): number; - unlisten(): void; - updateSettings(settings: Object, init?: boolean): void; - validateCells(callback: Function): void; - } + // hooks + afterAutofillApplyValues?(startArea: any[], entireArea: any[]): void; + afterCellMetaReset?(): void; + afterChange?(changes: any[], source: string): void; + afterChangesObserved?(): void; + afterColumnMove?(startColumn: number, endColumn: number): void; + afterColumnResize?(currentColumn: number, newSize: number, isDoubleClick: boolean): void; + afterColumnSort?(column: number, order: boolean): void; + afterContextMenuDefaultOptions?(predefinedItems: any[]): void; + afterContextMenuHide?(context: Object): void; + afterContextMenuShow?(context: Object): void; + afterCopyLimit?(selectedRows: number, selectedColumnds: number, copyRowsLimit: number, copyColumnsLimit: number): void; + afterCreateCol?(index: number, amount: number): void; + afterCreateRow?(index: number, amount: number): void; + afterDeselect?(): void; + afterDestroy?(): void; + afterDocumentKeyDown?(event: Event): void; + afterFilter?(formulasStack: any[]): void; + afterGetCellMeta?(row: number, col: number, cellProperties: Object): void; + afterGetColHeader?(col: number, TH: Element): void; + afterGetColumnHeaderRenderers?(array: any[]): void; + afterGetRowHeader?(row: number, TH: Element): void; + afterGetRowHeaderRenderers?(array: any[]): void; + afterInit?(): void; + afterLoadData?(firstTime: boolean): void; + afterMomentumScroll?(): void; + afterOnCellCornerMouseDown?(event: Object): void; + afterOnCellMouseDown?(event: Object, coords: Object, TD: Element): void; + afterOnCellMouseOver?(event: Object, coords: Object, TD: Element): void; + afterRemoveCol?(index: number, amount: number): void; + afterRemoveRow?(index: number, amount: number): void; + afterRender?(isForced: boolean): void; + afterRenderer?(TD: Element, row: number, col: number, prop: string|number, value: string, cellProperties: Object): void; + afterRowMove?(startRow: number, endRow: number): void; + afterRowResize?(currentRow: number, newSize: number, isDoubleClick: boolean): void; + afterScrollHorizontally?(): void; + afterScrollVertically?(): void; + afterSelection?(r: number, c: number, r2: number, c2: number): void; + afterSelectionByProp?(r: number, p: string, r2: number, p2: string): void; + afterSelectionEnd?(r: number, c: number, r2: number, c2: number): void; + afterSelectionEndByProp?(r: number, p: string, r2: number, p2: string): void; + afterSetCellMeta?(row: number, col: number, key: string, value: any): void; + afterUpdateSettings?(): void; + afterValidate?(isValid: boolean, value: any, row: number, prop: string|number, source: string): void|boolean; + beforeAutofill?(start: Object, end: Object, data: any[]): void; + beforeCellAlignment?(stateBefore: any, range: any, type: string, alignmentClass: string): void; + beforeChange?(changes: any[], source: string): void; + beforeChangeRender?(changes: any[], source: string): void; + beforeColumnMove?(startColumn: number, endColumn: number): void; + beforeColumnResize?(currentColumn: number, newSize: number, isDoubleClick: boolean): void; + beforeColumnSort?(column: number, order: boolean): void; + beforeDrawBorders?(corners: any[], borderClassName: string): void; + beforeFilter?(formulasStack: any[]): void; + beforeGetCellMeta?(row: number, col: number, cellProperties: Object): void; + beforeInit?(): void; + beforeInitWalkontable?(walkontableConfig: Object): void; + beforeKeyDown?(event: Event): void; + beforeOnCellMouseDown?(event: Event, coords: Object, TD: Element): void; + beforeRemoveCol?(index: number, amount: number, logicalCols?: any[]): void; + beforeRemoveRow?(index: number, amount: number, logicalRows?: any[]): void; + beforeRender?(isForced: boolean): void; + beforeRenderer?(TD: Element, row: number, col: number, prop: string|number, value: string, cellProperties: Object): void; + beforeRowMove?(startRow: number, endRow: number): void; + beforeRowResize?(currentRow: number, newSize: number, isDoubleClick: boolean): any; + beforeSetRangeEnd?(coords: any[]): void; + beforeStretchingColumnWidth?(stretchedWidth: number, column: number): void; + beforeTouchScroll?(): void; + beforeValidate?(value: any, row: number, prop: string|number, source: string): void; + construct?(): void; + init?(): void; + modifyCol?(col: number): void; + modifyColHeader?(column: number): void; + modifyColWidth?(width: number, col: number): void; + modifyCopyableRange?(copyableRanges: any[]): void; + modifyRow?(row: number): void; + modifyRowHeader?(row: number): void; + modifyRowHeight?(height: number, row: number): void; + persistentStateLoad?(key: string, valuePlaceholder: Object): void; + persistentStateReset?(key: string): void; + persistentStateSave?(key: string, value: any): void; + unmodifyCol?(col: number): void; + } - interface Selection { + interface Methods { + addHook(key: string, callback: Function|any[]): void; + addHookOnce(key: string, callback: Function|any[]): void; + alter(action: string, index: number, amount?: number, source?: string, keepEmptyRows?: boolean): void; + clear(): void; + colOffset(): number; + colToProp(col: number): string|number; + countCols(): number; + countEmptyCols(ending?: boolean): number; + countEmptyRows(ending?: boolean): number; + countRenderedCols(): number; + countRenderedRows(): number; + countRows(): number; + countSourceRows(): number; + countVisibleCols(): number; + countVisibleRows(): number; + deselectCell(): void; + destroy(): void; + destroyEditor(revertOriginal?: boolean): void; + getActiveEditor(): Object; + getCell(row: number, col: number, topmost?: boolean): Element; + getCellEditor(row: number, col: number): Object; + getCellMeta(row: number, col: number): Object; + getCellRenderer(row: number, col: number): Function; + getCellValidator(row: number, col: number): any; + getColHeader(col?: number): any[]|string; + getColWidth(col: number): number; + getCoords(elem: Element): Object; + getCopyableData(row: number, column: number): string; + getCopyableText(startRow: number, startCol: number, endRow: number, endCol: number): string; + getData(r?: number, c?: number, r2?: number, c2?: number): any[]; + getDataAtCell(row: number, col: number): any; + getDataAtCol(col: number): any[]; + getDataAtProp(prop: string|number): any[]; + getDataAtRow(row: number): any[]; + getDataAtRowProp(row: number, prop: string): any; + getDataType(rowFrom: number, columnFrom: number, rowTo: number, columnTo: number): string; + getInstance(): any; + getPlugin(pluginName: string): any; + getRowHeader(row?: number): any[]|string; + getRowHeight(row: number): number; + getSchema(): Object; + getSelected(): any[]; + getSelectedRange(): Range; + getSettings(): Options; + getSourceData(r?: number, c?: number, r2?: number, c2?: number): any[]; + getSourceDataAtCell(row: number, column: number): any; + getSourceDataAtCol(column: number): any[]; + getSourceDataAtRow(row: number): any[]|Object; + getValue(): any; + hasColHeaders(): boolean; + hasHook(key: string): boolean; + hasRowHeaders(): boolean; + isEmptyCol(col: number): boolean; + isEmptyRow(row: number): boolean; + isListening(): boolean; + listen(): void; + loadData(data: any[]): void; + populateFromArray(row: number, col: number, input: any[], endRow?: number, endCol?: number, source?: string, method?: string, direction?: string, deltas?: any[]): any; + propToCol(prop: string | number): number; + removeCellMeta(row: number, col: number, key: string): void; + removeHook(key: string, callback: Function): void; + render(): void; + rowOffset(): number; + runHooks(key: string, p1?: any, p2?: any, p3?: any, p4?: any, p5?: any, p6?: any): any; + selectCell(row: number, col: number, endRow?: number, endCol?: number, scrollToCell?: boolean, changeListener?: boolean): boolean; + selectCellByProp(row: number, prop: string, endRow?: number, endProp?: string, scrollToCell?: boolean): boolean; + setCellMeta(row: number, col: number, key: string, val: string): void; + setCellMetaObject(row: number, col: number, prop: Object): void; + setDataAtCell(row: number|any[], col: number, value: string, source?: string): void; + setDataAtRowProp(row: number|any[], prop: string, value: string, source?: string): void; + spliceCol(col: number, index: number, amount: number, elements?: any): void; + spliceRow(row: number, index: number, amount: number, elements?: any): void; + toPhysicalRow(row: number): number; + toPhysicalColumn(column: number): number; + toVisualRow(row: number): number; + toVisualColumn(column: number): number; + unlisten(): void; + updateSettings(settings: Object, init?: boolean): void; + validateCells(callback: Function): void; + } + + interface Selection { start: CellPosition; end: CellPosition; } @@ -388,7 +389,7 @@ declare namespace ht { interface Hooks { register(key: string): void; - run(instace: ht.Methods, hookName: string, key?: any, value?: any): any; + run(instace: Methods, hookName: string, key?: any, value?: any): any; } interface Dom { @@ -492,7 +493,7 @@ declare namespace ht { type DropdownColumn = AutocompleteColumn; } -declare var Handsontable: { +interface Handsontable { new (element: Element, options: ht.Options): ht.Methods; plugins: ht.Plugins; hooks: ht.Hooks; @@ -502,18 +503,10 @@ declare var Handsontable: { utils: ht.Utils; renderers: ht.Renderers; editors: ht.Editors; -}; +} declare module "handsontable" { - const Handsontable: { - new (element: Element, options: ht.Options): ht.Methods; - plugins: ht.Plugins; - hooks: ht.Hooks; - Dom: ht.Dom; - dom: ht.Dom; - helper: ht.Helper; - utils: ht.Utils; - renderers: ht.Renderers; - editors: ht.Editors; - }; + export = Handsontable; } + +declare var Handsontable: Handsontable; From 75ce0ec8cc35d02a5d86fd28a4960b2d6a5b1232 Mon Sep 17 00:00:00 2001 From: Viktor Smirnov Date: Thu, 30 Mar 2017 17:57:10 +0300 Subject: [PATCH 079/844] angular-material linting --- .../angular-material-tests.ts | 35 +++++------ types/angular-material/index.d.ts | 58 +++++++++---------- types/angular-material/tslint.json | 7 +++ 3 files changed, 50 insertions(+), 50 deletions(-) create mode 100644 types/angular-material/tslint.json diff --git a/types/angular-material/angular-material-tests.ts b/types/angular-material/angular-material-tests.ts index 848eaa8402..da898cfc13 100644 --- a/types/angular-material/angular-material-tests.ts +++ b/types/angular-material/angular-material-tests.ts @@ -1,15 +1,12 @@ - - -var myApp = angular.module('testModule', ['ngMaterial']); +const myApp = angular.module('testModule', ['ngMaterial']); myApp.config(( $mdThemingProvider: ng.material.IThemingProvider, $mdIconProvider: ng.material.IIconProvider, $mdProgressCircularProvider: ng.material.IProgressCircularProvider) => { - $mdThemingProvider.alwaysWatchTheme(true); - var neonRedMap: ng.material.IPalette = $mdThemingProvider.extendPalette('red', { - '500': 'ff0000' + const neonRedMap: ng.material.IPalette = $mdThemingProvider.extendPalette('red', { + 500: 'ff0000' }); // Register the new color palette map with the name neonRed $mdThemingProvider.definePalette('neonRed', neonRedMap); @@ -21,7 +18,7 @@ myApp.config(( .warnPalette('red') .dark(true); - var browserColors: ng.material.IBrowserColors = { + const browserColors: ng.material.IBrowserColors = { theme: 'default', palette: 'neonRed', hue: '500' @@ -52,7 +49,6 @@ myApp.controller('BottomSheetController', ($scope: ng.IScope, $mdBottomSheet: ng clickOutsideToClose: true, disableBackdrop: true, disableParentScroll: false, - parent: () => { }, resolve: { r1: () => $q.resolve(), r2: () => Promise.resolve(), @@ -66,10 +62,10 @@ myApp.controller('BottomSheetController', ($scope: ng.IScope, $mdBottomSheet: ng }); myApp.controller('ColorController', ($scope: ng.IScope, $mdColor: ng.material.IColorService) => { - var colorExpression: ng.material.IColorExpression; - var element: Element; + let colorExpression: ng.material.IColorExpression; + let element: Element; - colorExpression = { color: '#FFFFFF' } + colorExpression = { color: '#FFFFFF' }; element = new Element(); @@ -77,7 +73,7 @@ myApp.controller('ColorController', ($scope: ng.IScope, $mdColor: ng.material.IC $mdColor.applyThemeColors(element, colorExpression); }; $scope['getThemeColor'] = () => { - $mdColor.getThemeColor('default-neonRed') + $mdColor.getThemeColor('default-neonRed'); }; $scope['hasTheme'] = () => { $mdColor.hasTheme(); @@ -140,13 +136,12 @@ myApp.controller('DialogController', ($scope: ng.IScope, $mdDialog: ng.material. }); class IconDirective implements ng.IDirective { - private $mdIcon: ng.material.IIcon; constructor($mdIcon: ng.material.IIcon) { this.$mdIcon = $mdIcon; } - public link($scope: ng.IScope, $elm: ng.IAugmentedJQuery) { + link($scope: ng.IScope, $elm: ng.IAugmentedJQuery) { this.$mdIcon('android').then((iconEl: Element) => $elm.append(iconEl)); this.$mdIcon('work:chair').then((iconEl: Element) => $elm.append(iconEl)); // Load and cache the external SVG using a URL @@ -167,7 +162,7 @@ myApp.controller('MediaController', ($scope: ng.IScope, $mdMedia: ng.material.IM }); myApp.controller('SidenavController', ($scope: ng.IScope, $mdSidenav: ng.material.ISidenavService) => { - var componentId = 'left'; + const componentId = 'left'; $scope['toggle'] = () => $mdSidenav(componentId).toggle(); $scope['open'] = () => $mdSidenav(componentId).open(); $scope['close'] = () => $mdSidenav(componentId).close(); @@ -189,10 +184,10 @@ myApp.controller('ToastController', ($scope: ng.IScope, $mdToast: ng.material.IT $scope['openToast'] = () => { $mdToast.show($mdToast.simple().textContent('Hello!')); $mdToast.updateTextContent('New Content'); - } + }; $scope['customToast'] = () => { - var options: ng.material.IToastOptions = { + const options: ng.material.IToastOptions = { hideDelay: 3000, position: 'top right', controller: 'ToastCtrl', @@ -207,12 +202,12 @@ myApp.controller('ToastController', ($scope: ng.IScope, $mdToast: ng.material.IT }; $mdToast.show(options); - } + }; }); myApp.controller('PanelController', ($scope: ng.IScope, $mdPanel: ng.material.IPanelService, $q: ng.IQService) => { $scope['createPanel'] = () => { - var config: ng.material.IPanelConfig = { + const config: ng.material.IPanelConfig = { id: 'myPanel', template: '

    Hello!

    ', hasBackdrop: true, @@ -228,7 +223,7 @@ myApp.controller('PanelController', ($scope: ng.IScope, $mdPanel: ng.material.IP $mdPanel.create(config); - var panelRef = $mdPanel.create(config); + let panelRef = $mdPanel.create(config); panelRef.open() .then((ref: ng.material.IPanelRef) => { ref.addClass('foo'); diff --git a/types/angular-material/index.d.ts b/types/angular-material/index.d.ts index d2473e8014..fff8a0a085 100644 --- a/types/angular-material/index.d.ts +++ b/types/angular-material/index.d.ts @@ -9,16 +9,17 @@ declare var _: string; export = _; declare module 'angular' { - export namespace material { - - type ResolveObject = { [index: string]: angular.Injectable<(...args: any[]) => PromiseLike> }; + namespace material { + interface ResolveObject { + [index: string]: angular.Injectable<(...args: any[]) => PromiseLike>; + } interface IBottomSheetOptions { templateUrl?: string; template?: string; scope?: angular.IScope; // default: new child scope preserveScope?: boolean; // default: false - controller?: string | Function; + controller?: string | ((...args: any[]) => any); locals?: { [index: string]: any }; clickOutsideToClose?: boolean; bindToController?: boolean; // default: false @@ -26,7 +27,7 @@ declare module 'angular' { escapeToClose?: boolean; resolve?: ResolveObject; controllerAs?: string; - parent?: Function | string | Object; // default: root node + parent?: string | Element | JQuery | ((scope: ng.IScope, element: JQuery, options: IBottomSheetOptions) => Element | JQuery); // default: root node disableParentScroll?: boolean; // default: true } @@ -52,16 +53,16 @@ declare module 'angular' { clickOutsideToClose(clickOutsideToClose?: boolean): T; // default: false escapeToClose(escapeToClose?: boolean): T; // default: true focusOnOpen(focusOnOpen?: boolean): T; // default: true - controller(controller?: string | Function): T; + controller(controller?: string | ((...args: any[]) => any)): T; locals(locals?: { [index: string]: any }): T; bindToController(bindToController?: boolean): T; // default: false resolve(resolve?: ResolveObject): T; controllerAs(controllerAs?: string): T; parent(parent?: string | Element | JQuery): T; // default: root node - onComplete(onComplete?: Function): T; ariaLabel(ariaLabel: string): T; } + // tslint:disable-next-line no-empty-interface interface IAlertDialog extends IPresetDialog { } @@ -100,15 +101,15 @@ declare module 'angular' { clickOutsideToClose?: boolean; // default: false escapeToClose?: boolean; // default: true focusOnOpen?: boolean; // default: true - controller?: string | Function; + controller?: string | ((...args: any[]) => any); locals?: { [index: string]: any }; bindToController?: boolean; // default: false resolve?: ResolveObject; controllerAs?: string; parent?: string | Element | JQuery; // default: root node - onShowing?: Function; - onComplete?: Function; - onRemoving?: Function; + onShowing?(scope: ng.IScope, element: JQuery): void; + onComplete?(scope: ng.IScope, element: JQuery): void; + onRemoving?(element: JQuery, action: ng.IPromise): void; skipHide?: boolean; multiple?: boolean; fullscreen?: boolean; // default: false @@ -123,9 +124,7 @@ declare module 'angular' { cancel(response?: any): void; } - interface IIcon { - (id: string): angular.IPromise; // id is a unique ID or URL - } + type IIcon = (id: string) => angular.IPromise; // id is a unique ID or URL interface IIconProvider { icon(id: string, url: string, viewBoxSize?: number): IIconProvider; // viewBoxSize default: 24 @@ -135,9 +134,7 @@ declare module 'angular' { defaultFontSet(name: string): IIconProvider; } - interface IMedia { - (media: string): boolean; - } + type IMedia = (media: string) => boolean; interface ISidenavObject { toggle(): angular.IPromise; @@ -145,7 +142,7 @@ declare module 'angular' { close(): angular.IPromise; isOpen(): boolean; isLockedOpen(): boolean; - onClose(onClose: Function): void; + onClose(onClose: () => void): void; } interface ISidenavService { @@ -166,6 +163,7 @@ declare module 'angular' { toastClass(toastClass: string): T; } + // tslint:disable-next-line no-empty-interface interface ISimpleToastPreset extends IToastPreset { } @@ -178,7 +176,7 @@ declare module 'angular' { hideDelay?: number | false; // default (ms): 3000 position?: string; // any combination of 'bottom'/'left'/'top'/'right'/'fit'; default: 'bottom left' toastClass?: string; - controller?: string | Function; + controller?: string | ((...args: any[]) => any); locals?: { [index: string]: any }; bindToController?: boolean; // default: false resolve?: ResolveObject; @@ -266,19 +264,19 @@ declare module 'angular' { interface IThemeConfig { disableTheming: boolean; - generateOnDemand: boolean; + generateOnDemand: boolean; nonce: string; defaultTheme: string; alwaysWatchTheme: boolean; - registeredStyles: Array; + registeredStyles: string[]; } interface IThemingProvider { alwaysWatchTheme(alwaysWatch: boolean): void; definePalette(name: string, palette: IPalette): IThemingProvider; - enableBrowserColor(browserColors: IBrowserColors): Function; + enableBrowserColor(browserColors: IBrowserColors): () => void; extendPalette(name: string, palette: IPalette): IPalette; - registerStyles(styles: String): void; + registerStyles(styles: string): void; setDefaultTheme(theme: string): void; setNonce(nonce: string): void; theme(name: string, inheritFrom?: string): ITheme; @@ -331,7 +329,7 @@ declare module 'angular' { id?: string; template?: string; templateUrl?: string; - controller?: string | Function; + controller?: string | ((...args: any[]) => any); controllerAs?: string; bindToController?: boolean; // default: true locals?: { [index: string]: any }; @@ -349,10 +347,10 @@ declare module 'angular' { animation?: IPanelAnimation; hasBackdrop?: boolean; // default: false disableParentScroll?: boolean; // default: false - onDomAdded?: Function; - onOpenComplete?: Function; - onRemoving?: Function; - onDomRemoved?: Function; + onDomAdded?(...args: any[]): void; + onOpenComplete?(...args: any[]): void; + onRemoving?(...args: any[]): void; + onDomRemoved?(...args: any[]): void; origin?: string | JQuery | Element; onCloseSuccess?: ((panel: IPanelRef, closeReason: string) => any); } @@ -445,11 +443,11 @@ declare module 'angular' { progressSize?: number; strokeWidth?: number; duration?: number; - easeFn?: Function; + easeFn?(t: number, b: number, c: number, d: number): number; durationIndeterminate?: number; startIndeterminate?: number; endIndeterminate?: number; - easeFnIndeterminate?: Function; + easeFnIndeterminate?(t: number, b: number, c: number, d: number): number; } interface IProgressCircularProvider { diff --git a/types/angular-material/tslint.json b/types/angular-material/tslint.json new file mode 100644 index 0000000000..5783b495dd --- /dev/null +++ b/types/angular-material/tslint.json @@ -0,0 +1,7 @@ +{ + "extends": "../tslint.json", + "rules": { + "interface-name": false, + "max-line-length": false + } +} From d405d11df40c3e184143d6a3e52d2a754493461d Mon Sep 17 00:00:00 2001 From: maghis Date: Thu, 30 Mar 2017 12:21:33 -0400 Subject: [PATCH 080/844] Correct return type for getContents --- types/stream-buffers/index.d.ts | 2 +- types/stream-buffers/stream-buffers-tests.ts | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) 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. From c0083ec134066c4fcc96470deb9aebaf1ae42ef3 Mon Sep 17 00:00:00 2001 From: Justin Firth Date: Thu, 30 Mar 2017 13:03:14 -0400 Subject: [PATCH 081/844] Added version commit --- types/hyperscript/index.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/types/hyperscript/index.d.ts b/types/hyperscript/index.d.ts index b57aa455f6..b4384ba302 100644 --- a/types/hyperscript/index.d.ts +++ b/types/hyperscript/index.d.ts @@ -2,6 +2,7 @@ // Project: https://github.com/dominictarr/hyperscript // Definitions by: Mike Linkovich // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.2 declare module 'hyperscript' { From 58c3aaf8e3b493ecb436816b736bf0dcbe677a0a Mon Sep 17 00:00:00 2001 From: Fedor Nezhivoi Date: Thu, 30 Mar 2017 19:55:10 +0300 Subject: [PATCH 082/844] @types/react-native fix Picker types --- types/react-native/index.d.ts | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/types/react-native/index.d.ts b/types/react-native/index.d.ts index 3742bf5003..c906ac9fae 100644 --- a/types/react-native/index.d.ts +++ b/types/react-native/index.d.ts @@ -2612,12 +2612,14 @@ export interface PickerIOSItemStatic extends React.ComponentClass { +export interface PickerItemProperties extends React.Props { + testID?: string + color?: string label: string value?: any } -export interface PickerItemStatic extends React.ComponentClass { +export interface PickerItem extends React.ComponentClass { } export interface PickerPropertiesIOS extends ViewProperties, React.Props { @@ -2697,7 +2699,7 @@ export interface PickerProperties extends PickerPropertiesIOS, PickerPropertiesA */ export interface PickerStatic extends React.ComponentClass { - /** + /** * On Android, display the options in a dialog. */ MODE_DIALOG: string @@ -2706,7 +2708,7 @@ export interface PickerStatic extends React.ComponentClass { */ MODE_DROPDOWN: string - Item?: PickerItemStatic + Item: PickerItem } /** From deed8459fa2d763c9f484322e793b81fbb655555 Mon Sep 17 00:00:00 2001 From: Nathan Shively-Sanders Date: Thu, 30 Mar 2017 11:29:31 -0700 Subject: [PATCH 083/844] Make braintree a UMD module Add tests to show that it can be imported as well as used globally. The change required lots of refactoring. The merged interface-classes are gone since their constructors were not supposed to be used anyway. And everything moved into the BraintreeWeb namespace, which was renamed to just `braintree`. --- types/braintree-web/braintree-node-tests.ts | 440 +++++++++++++++++ types/braintree-web/braintree-web-tests.ts | 54 +- types/braintree-web/index.d.ts | 520 +++++++------------- types/braintree-web/tsconfig.json | 5 +- 4 files changed, 639 insertions(+), 380 deletions(-) create mode 100644 types/braintree-web/braintree-node-tests.ts diff --git a/types/braintree-web/braintree-node-tests.ts b/types/braintree-web/braintree-node-tests.ts new file mode 100644 index 0000000000..9eed5b228d --- /dev/null +++ b/types/braintree-web/braintree-node-tests.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/braintree-web-tests.ts index c9aee724c0..22073363d4 100644 --- a/types/braintree-web/braintree-web-tests.ts +++ b/types/braintree-web/braintree-web-tests.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/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/tsconfig.json b/types/braintree-web/tsconfig.json index abc64cd9c3..b0bd853841 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" + "braintree-web-tests.ts", + "braintree-node-tests.ts" ] -} \ No newline at end of file +} From 7fd19dab3bc358ff05972c3320bfe0540ef01293 Mon Sep 17 00:00:00 2001 From: Nathan Shively-Sanders Date: Thu, 30 Mar 2017 12:22:49 -0700 Subject: [PATCH 084/844] Move tests into test folder --- types/braintree-web/{braintree-node-tests.ts => test/node.ts} | 0 types/braintree-web/{braintree-web-tests.ts => test/web.ts} | 0 types/braintree-web/tsconfig.json | 4 ++-- 3 files changed, 2 insertions(+), 2 deletions(-) rename types/braintree-web/{braintree-node-tests.ts => test/node.ts} (100%) rename types/braintree-web/{braintree-web-tests.ts => test/web.ts} (100%) diff --git a/types/braintree-web/braintree-node-tests.ts b/types/braintree-web/test/node.ts similarity index 100% rename from types/braintree-web/braintree-node-tests.ts rename to types/braintree-web/test/node.ts diff --git a/types/braintree-web/braintree-web-tests.ts b/types/braintree-web/test/web.ts similarity index 100% rename from types/braintree-web/braintree-web-tests.ts rename to types/braintree-web/test/web.ts diff --git a/types/braintree-web/tsconfig.json b/types/braintree-web/tsconfig.json index b0bd853841..d326f77f12 100644 --- a/types/braintree-web/tsconfig.json +++ b/types/braintree-web/tsconfig.json @@ -18,7 +18,7 @@ }, "files": [ "index.d.ts", - "braintree-web-tests.ts", - "braintree-node-tests.ts" + "test/web.ts", + "test/node.ts" ] } From 4cac3c5b44b595aa8a5f9c08ca57c3e0ad8aec5b Mon Sep 17 00:00:00 2001 From: Andy Date: Thu, 30 Mar 2017 12:33:22 -0700 Subject: [PATCH 085/844] Apply new lint rules in more packages (#15521) --- types/ably/ably-tests.ts | 21 +-- types/ably/index.d.ts | 16 +- types/accounting/accounting-tests.ts | 9 - types/amplify/amplify-tests.ts | 22 +-- types/amqplib/amqplib-tests.ts | 15 +- types/angular/angular-tests.ts | 9 +- types/angular/index.d.ts | 3 +- types/angular/tslint.json | 4 +- types/applepayjs/applepayjs-tests.ts | 4 - types/applepayjs/index.d.ts | 16 -- types/applepayjs/tslint.json | 4 +- .../applicationinsights-js-tests.ts | 57 +++--- types/applicationinsights-js/index.d.ts | 169 +++++++++--------- .../arcgis-rest-api/arcgis-rest-api-tests.ts | 2 +- types/arcgis-rest-api/index.d.ts | 5 +- .../arcgis-to-geojson-utils-tests.ts | 4 +- types/arcgis-to-geojson-utils/index.d.ts | 2 +- types/array-uniq/array-uniq-tests.ts | 2 +- types/array-uniq/index.d.ts | 2 +- types/croppie/croppie-tests.ts | 1 - types/croppie/index.d.ts | 1 - types/dragster/dragster-tests.ts | 6 +- types/dragster/index.d.ts | 2 +- types/expect/expect-tests.ts | 6 +- types/is-root/is-root-tests.ts | 2 +- types/ityped/index.d.ts | 2 +- types/ityped/ityped-tests.ts | 2 +- types/jimp/index.d.ts | 1 - types/jimp/jimp-tests.ts | 78 ++++---- types/jui-core/index.d.ts | 15 +- types/jui-grid/jui-grid-tests.ts | 6 +- types/left-pad/index.d.ts | 2 +- types/left-pad/left-pad-tests.ts | 2 +- types/libpq/index.d.ts | 2 +- types/node-xmpp-client/index.d.ts | 2 +- types/node-xmpp-core/index.d.ts | 6 +- types/ns-api/ns-api-tests.ts | 2 +- types/opener/opener-tests.ts | 2 +- types/pad/pad-tests.ts | 2 +- types/pem/index.d.ts | 50 +++--- types/pem/pem-tests.ts | 90 +++++----- types/plugapi/index.d.ts | 50 +++--- types/python-shell/python-shell-tests.ts | 6 +- types/qlik-visualizationextensions/index.d.ts | 32 ++-- types/rrule/index.d.ts | 95 +++++----- types/sharepoint/index.d.ts | 16 +- types/sharepoint/sharepoint-tests.ts | 5 +- types/sharepoint/tslint.json | 1 + types/tweezer.js/index.d.ts | 2 +- types/tweezer.js/tweezer.js-tests.ts | 2 +- types/ui-router-extras/index.d.ts | 4 +- types/vinyl-fs/index.d.ts | 146 +++++++-------- .../wicg-mediasession-tests.ts | 1 - types/wu/wu-tests.ts | 5 +- types/xml/xml-tests.ts | 5 +- types/xml2json/xml2json-tests.ts | 10 +- types/xmpp__jid/index.d.ts | 14 +- types/xsd-schema-validator/index.d.ts | 2 +- .../xsd-schema-validator-tests.ts | 3 +- 59 files changed, 503 insertions(+), 544 deletions(-) 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/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..d046974ab9 100644 --- a/types/angular/index.d.ts +++ b/types/angular/index.d.ts @@ -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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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 +}); From 9e9ed74e03a1cce4469fdfe3fb00760638b2622e Mon Sep 17 00:00:00 2001 From: Troy Weber Date: Thu, 30 Mar 2017 12:57:48 -0700 Subject: [PATCH 086/844] improve definitions --- types/firmata/index.d.ts | 32 +++++++++++++++++++------------- types/serialport/index.d.ts | 21 ++++++++++++++++++++- 2 files changed, 39 insertions(+), 14 deletions(-) diff --git a/types/firmata/index.d.ts b/types/firmata/index.d.ts index a24fae435b..60a1284c4f 100644 --- a/types/firmata/index.d.ts +++ b/types/firmata/index.d.ts @@ -16,7 +16,7 @@ export = Board; * guarantee that it cannot be improved. */ declare class Board extends NodeJS.EventEmitter { - constructor(serialPort: string, callback?: (error: any) => void) + constructor(serialPort: string, optionsOrCallback:Board.Options, callback?: (error: any) => void) MODES: Board.PinModes; STEPPER: Board.StepperConstants; I2C_MODES: Board.I2cModes; @@ -151,6 +151,13 @@ declare class Board extends NodeJS.EventEmitter { } declare namespace Board { + // https://github.com/firmata/firmata.js/blob/master/lib/firmata.js#L429-L451 + interface Options { + reportVersionTimeout: number, + samplingInterval: number, + serialport: SerialPort.options + } + interface PinModes { INPUT: PIN_MODE; OUTPUT: PIN_MODE; @@ -251,9 +258,8 @@ declare namespace Board { minor: number; } - // TODO these enums could actually be non-const in the future (provides some benefits) --- TWW // https://github.com/firmata/firmata.js/blob/v0.15.0/lib/firmata.js#L449-L464 - const enum PIN_MODE { + enum PIN_MODE { INPUT = 0x00, OUTPUT = 0x01, ANALOG = 0x02, @@ -270,30 +276,30 @@ declare namespace Board { UNKNOWN = 0x10, } - const enum PIN_STATE { + enum PIN_STATE { LOW = 0, HIGH = 1 } - const enum REPORTING { + enum REPORTING { ON = 1, OFF = 0, } - const enum PULLUP_STATE { + enum PULLUP_STATE { ENABLED = 1, DISABLED = 0, } // https://github.com/firmata/firmata.js/blob/v0.15.0/lib/firmata.js#L474-L478 - const enum STEPPER_TYPE { + enum STEPPER_TYPE { DRIVER = 1, TWO_WIRE = 2, FOUR_WIRE = 4, } // https://github.com/firmata/firmata.js/blob/v0.15.0/lib/firmata.js#L479-L484 - const enum STEPPER_RUN_STATE { + enum STEPPER_RUN_STATE { STOP = 0, ACCEL = 1, DECEL = 2, @@ -301,13 +307,13 @@ declare namespace Board { } // https://github.com/firmata/firmata.js/blob/v0.15.0/lib/firmata.js#L485-L488 - const enum STEPPER_DIRECTION { + enum STEPPER_DIRECTION { CCW = 0, CW = 1, } // https://github.com/firmata/firmata.js/blob/v0.15.0/lib/firmata.js#L466-L471 - const enum I2C_MODE { + enum I2C_MODE { WRITE = 0, READ = 1, CONTINUOUS_READ = 2, @@ -315,13 +321,13 @@ declare namespace Board { } // https://github.com/firmata/firmata.js/blob/v0.15.0/lib/firmata.js#L491-L494 - const enum SERIAL_MODE { + enum SERIAL_MODE { CONTINUOUS_READ = 0x00, STOP_READING = 0x01, } // https://github.com/firmata/firmata.js/blob/v0.15.0/lib/firmata.js#L497-L512 - const enum SERIAL_PORT_ID { + enum SERIAL_PORT_ID { HW_SERIAL0 = 0x00, HW_SERIAL1 = 0x01, HW_SERIAL2 = 0x02, @@ -334,7 +340,7 @@ declare namespace Board { } // https://github.com/firmata/firmata.js/blob/v0.15.0/lib/firmata.js#L515-L524 - const enum SERIAL_PIN_TYPE { + enum SERIAL_PIN_TYPE { RES_RX0 = 0x00, RES_TX0 = 0x01, RES_RX1 = 0x02, diff --git a/types/serialport/index.d.ts b/types/serialport/index.d.ts index 5b284cc669..3a1a45d19c 100644 --- a/types/serialport/index.d.ts +++ b/types/serialport/index.d.ts @@ -6,7 +6,7 @@ declare module 'serialport' { class SerialPort { //openImmediately already removed in 4.0.7 - constructor(path: string, options?: Object, callback?: (err: any) => void) + constructor(path: string, options?: SerialPort.options, callback?: (err: any) => void) isOpen(): boolean; on(event: string, callback?: (data?: any) => void): void; open(callback?: (err: any) => void): void; @@ -48,6 +48,25 @@ declare module 'serialport' { interface updateOptions { baudRate?: number; } + + // https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/4.0.7/README.md#user-content-serialport-path-options-opencallback + interface options { + autoOpen?: boolean, + lock?: boolean, + baudRate?: 115200|57600|38400|19200|9600|4800|2400|1800|1200|600|300|200|150|134|110|75|50|number, + dataBits?: 8|7|6|5, + stopBits?: 1|2, + parity?: 'none'|'even'|'mark'|'odd'|'space', + rtscts?: boolean, + xon?: boolean, + xoff?: boolean, + bufferSize?: number, + parser?: Function, + platformOptions?: { + vmin?: number, + vtime?: number + } + } } export = SerialPort; From 4fd2d7547c4fb60c0577d447f0f50f7eb42a1d85 Mon Sep 17 00:00:00 2001 From: Kalle Ott Date: Thu, 30 Mar 2017 22:12:51 +0200 Subject: [PATCH 087/844] fixed the semver note in the header comment (#15522) * fixed the semver note in the header comment * changed tslint config * fixed linting --- .../dist/commonjs/ArrowKeyStepper.d.ts | 2 +- .../dist/commonjs/AutoSizer.d.ts | 2 +- .../dist/commonjs/CellMeasurer.d.ts | 2 +- .../dist/commonjs/Collection.d.ts | 2 +- .../dist/commonjs/ColumnSizer.d.ts | 2 +- .../react-virtualized/dist/commonjs/Grid.d.ts | 2 +- .../dist/commonjs/InfiniteLoader.d.ts | 2 +- .../react-virtualized/dist/commonjs/List.d.ts | 2 +- .../dist/commonjs/Masonry.d.ts | 2 +- .../dist/commonjs/MultiGrid.d.ts | 2 +- .../dist/commonjs/ScrollSync.d.ts | 2 +- .../dist/commonjs/Table.d.ts | 2 +- .../dist/commonjs/WindowScroller.d.ts | 2 +- .../react-virtualized/dist/es/AutoSizer.d.ts | 10 +- types/react-virtualized/dist/es/Grid.d.ts | 18 +-- types/react-virtualized/dist/es/Masonry.d.ts | 5 +- .../react-virtualized/dist/es/ScrollSync.d.ts | 2 +- types/react-virtualized/dist/es/Table.d.ts | 10 +- types/react-virtualized/index.d.ts | 2 +- .../react-virtualized-tests.tsx | 111 +++++++++--------- types/react-virtualized/tslint.json | 13 +- 21 files changed, 102 insertions(+), 95 deletions(-) diff --git a/types/react-virtualized/dist/commonjs/ArrowKeyStepper.d.ts b/types/react-virtualized/dist/commonjs/ArrowKeyStepper.d.ts index fd16c58feb..6cd9604575 100644 --- a/types/react-virtualized/dist/commonjs/ArrowKeyStepper.d.ts +++ b/types/react-virtualized/dist/commonjs/ArrowKeyStepper.d.ts @@ -1 +1 @@ -export * from '../es/ArrowKeyStepper'; \ No newline at end of file +export * from '../es/ArrowKeyStepper'; diff --git a/types/react-virtualized/dist/commonjs/AutoSizer.d.ts b/types/react-virtualized/dist/commonjs/AutoSizer.d.ts index c0551a98a4..6d16fa0c45 100644 --- a/types/react-virtualized/dist/commonjs/AutoSizer.d.ts +++ b/types/react-virtualized/dist/commonjs/AutoSizer.d.ts @@ -1 +1 @@ -export * from '../es/AutoSizer'; \ No newline at end of file +export * from '../es/AutoSizer'; diff --git a/types/react-virtualized/dist/commonjs/CellMeasurer.d.ts b/types/react-virtualized/dist/commonjs/CellMeasurer.d.ts index 907eafee51..77f4abea84 100644 --- a/types/react-virtualized/dist/commonjs/CellMeasurer.d.ts +++ b/types/react-virtualized/dist/commonjs/CellMeasurer.d.ts @@ -1 +1 @@ -export * from '../es/CellMeasurer'; \ No newline at end of file +export * from '../es/CellMeasurer'; diff --git a/types/react-virtualized/dist/commonjs/Collection.d.ts b/types/react-virtualized/dist/commonjs/Collection.d.ts index 2764686c76..e4905c3eee 100644 --- a/types/react-virtualized/dist/commonjs/Collection.d.ts +++ b/types/react-virtualized/dist/commonjs/Collection.d.ts @@ -1 +1 @@ -export * from '../es/Collection'; \ No newline at end of file +export * from '../es/Collection'; diff --git a/types/react-virtualized/dist/commonjs/ColumnSizer.d.ts b/types/react-virtualized/dist/commonjs/ColumnSizer.d.ts index 80c9cf5d2e..1c42d3b94b 100644 --- a/types/react-virtualized/dist/commonjs/ColumnSizer.d.ts +++ b/types/react-virtualized/dist/commonjs/ColumnSizer.d.ts @@ -1 +1 @@ -export * from '../es/ColumnSizer'; \ No newline at end of file +export * from '../es/ColumnSizer'; diff --git a/types/react-virtualized/dist/commonjs/Grid.d.ts b/types/react-virtualized/dist/commonjs/Grid.d.ts index 168a11ac52..6834f9b47d 100644 --- a/types/react-virtualized/dist/commonjs/Grid.d.ts +++ b/types/react-virtualized/dist/commonjs/Grid.d.ts @@ -1 +1 @@ -export * from '../es/Grid'; \ No newline at end of file +export * from '../es/Grid'; diff --git a/types/react-virtualized/dist/commonjs/InfiniteLoader.d.ts b/types/react-virtualized/dist/commonjs/InfiniteLoader.d.ts index 29449c85ff..d4614b32d7 100644 --- a/types/react-virtualized/dist/commonjs/InfiniteLoader.d.ts +++ b/types/react-virtualized/dist/commonjs/InfiniteLoader.d.ts @@ -1 +1 @@ -export * from '../es/InfiniteLoader'; \ No newline at end of file +export * from '../es/InfiniteLoader'; diff --git a/types/react-virtualized/dist/commonjs/List.d.ts b/types/react-virtualized/dist/commonjs/List.d.ts index 6fdfde2dc0..8a174d91e2 100644 --- a/types/react-virtualized/dist/commonjs/List.d.ts +++ b/types/react-virtualized/dist/commonjs/List.d.ts @@ -1 +1 @@ -export * from '../es/List'; \ No newline at end of file +export * from '../es/List'; diff --git a/types/react-virtualized/dist/commonjs/Masonry.d.ts b/types/react-virtualized/dist/commonjs/Masonry.d.ts index e5189fb5f9..fc2768d7b7 100644 --- a/types/react-virtualized/dist/commonjs/Masonry.d.ts +++ b/types/react-virtualized/dist/commonjs/Masonry.d.ts @@ -1 +1 @@ -export * from '../es/Masonry'; \ No newline at end of file +export * from '../es/Masonry'; diff --git a/types/react-virtualized/dist/commonjs/MultiGrid.d.ts b/types/react-virtualized/dist/commonjs/MultiGrid.d.ts index 09f385eca4..7504908682 100644 --- a/types/react-virtualized/dist/commonjs/MultiGrid.d.ts +++ b/types/react-virtualized/dist/commonjs/MultiGrid.d.ts @@ -1 +1 @@ -export * from '../es/MultiGrid'; \ No newline at end of file +export * from '../es/MultiGrid'; diff --git a/types/react-virtualized/dist/commonjs/ScrollSync.d.ts b/types/react-virtualized/dist/commonjs/ScrollSync.d.ts index ffb4423c0a..2e9ec08a4d 100644 --- a/types/react-virtualized/dist/commonjs/ScrollSync.d.ts +++ b/types/react-virtualized/dist/commonjs/ScrollSync.d.ts @@ -1 +1 @@ -export * from '../es/ScrollSync'; \ No newline at end of file +export * from '../es/ScrollSync'; diff --git a/types/react-virtualized/dist/commonjs/Table.d.ts b/types/react-virtualized/dist/commonjs/Table.d.ts index db2670ceda..c710f4050c 100644 --- a/types/react-virtualized/dist/commonjs/Table.d.ts +++ b/types/react-virtualized/dist/commonjs/Table.d.ts @@ -1 +1 @@ -export * from '../es/Table'; \ No newline at end of file +export * from '../es/Table'; diff --git a/types/react-virtualized/dist/commonjs/WindowScroller.d.ts b/types/react-virtualized/dist/commonjs/WindowScroller.d.ts index 0380f0a4fb..51cd1f6ac0 100644 --- a/types/react-virtualized/dist/commonjs/WindowScroller.d.ts +++ b/types/react-virtualized/dist/commonjs/WindowScroller.d.ts @@ -1 +1 @@ -export * from '../es/WindowScroller'; \ No newline at end of file +export * from '../es/WindowScroller'; diff --git a/types/react-virtualized/dist/es/AutoSizer.d.ts b/types/react-virtualized/dist/es/AutoSizer.d.ts index 6d82a44482..ea72c43c1e 100644 --- a/types/react-virtualized/dist/es/AutoSizer.d.ts +++ b/types/react-virtualized/dist/es/AutoSizer.d.ts @@ -19,10 +19,10 @@ export type AutoSizerProps = { export class AutoSizer extends PureComponent { static propTypes: { /** - * Function responsible for rendering children. - * This function should implement the following signature: - * ({ height, width }) => PropTypes.element - */ + * 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 */ @@ -36,7 +36,7 @@ export class AutoSizer extends PureComponent { }; static defaultProps: { - onResize: () => { } + onResize: () => {} }; constructor(props: AutoSizerProps); diff --git a/types/react-virtualized/dist/es/Grid.d.ts b/types/react-virtualized/dist/es/Grid.d.ts index b68cf45956..7fcd0d1314 100644 --- a/types/react-virtualized/dist/es/Grid.d.ts +++ b/types/react-virtualized/dist/es/Grid.d.ts @@ -75,16 +75,16 @@ export type CellSizeAndPositionManager = { 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. - */ + * 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. - */ + * 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. @@ -202,7 +202,7 @@ export class Grid extends PureComponent { * 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>, + cellRenderer: Validator<(props: GridCellProps) => React.ReactNode>, /** * Responsible for rendering a group of cells given their index ranges. @@ -458,4 +458,4 @@ export class Grid extends PureComponent { render(): JSX.Element; } -export const defaultCellRangeRenderer: GridCellRangeRenderer; \ No newline at end of file +export const defaultCellRangeRenderer: GridCellRangeRenderer; diff --git a/types/react-virtualized/dist/es/Masonry.d.ts b/types/react-virtualized/dist/es/Masonry.d.ts index 51c59a90fc..eb44635978 100644 --- a/types/react-virtualized/dist/es/Masonry.d.ts +++ b/types/react-virtualized/dist/es/Masonry.d.ts @@ -83,7 +83,6 @@ export type MasonryState = { * (Items may not span multiple columns.) */ export class Masonry extends PureComponent { - static defaultProps: { autoHeight: false, keyMapper: identity, @@ -140,6 +139,6 @@ export type resetParams = { spacer?: number }; -export type Positioner = ((index: number) => Position) & {reset: (params: resetParams) => void}; +export type Positioner = ((index: number) => Position) & { reset: (params: resetParams) => void }; -export const createCellPositioner: (params: createCellPositionerParams) => Positioner; \ No newline at end of file +export const createCellPositioner: (params: createCellPositionerParams) => Positioner; diff --git a/types/react-virtualized/dist/es/ScrollSync.d.ts b/types/react-virtualized/dist/es/ScrollSync.d.ts index 4f1e924a69..d244262d25 100644 --- a/types/react-virtualized/dist/es/ScrollSync.d.ts +++ b/types/react-virtualized/dist/es/ScrollSync.d.ts @@ -48,4 +48,4 @@ export class ScrollSync extends PureComponent constructor(props: ScrollSyncProps, context: any); render(): JSX.Element; -} \ No newline at end of file +} diff --git a/types/react-virtualized/dist/es/Table.d.ts b/types/react-virtualized/dist/es/Table.d.ts index 6607211dcf..118215f4fa 100644 --- a/types/react-virtualized/dist/es/Table.d.ts +++ b/types/react-virtualized/dist/es/Table.d.ts @@ -33,7 +33,7 @@ export type TableHeaderRowProps = { }; export type TableRowProps = { className: string, - columns: Array, + columns: any[], index: number, isScrolling: boolean, onRowClick?: (params: RowMouseEventHandlerParams) => void, @@ -198,7 +198,7 @@ export type TableProps = { export const defaultTableCellDataGetter: TableCellDataGetter; export const defaultTableCellRenderer: TableCellRenderer; -export const defaultTableHeaderRenderer: () => React.ReactElement[]; +export const defaultTableHeaderRenderer: () => Array>; export const defaultTableHeaderRowRenderer: TableHeaderRowRenderer; export const defaultTableRowRenderer: TableRowRenderer; @@ -286,9 +286,9 @@ export class Table extends PureComponent { noRowsRenderer: Requireable<() => JSX.Element>, /** - * Optional callback when a column's header is clicked. - * ({ columnData: any, dataKey: string }): void - */ + * Optional callback when a column's header is clicked. + * ({ columnData: any, dataKey: string }): void + */ onHeaderClick: Requireable<(params: HeaderMouseEventHandlerParams) => void>, /** diff --git a/types/react-virtualized/index.d.ts b/types/react-virtualized/index.d.ts index d6860176ed..2440e1dcf3 100644 --- a/types/react-virtualized/index.d.ts +++ b/types/react-virtualized/index.d.ts @@ -164,4 +164,4 @@ export type ScrollEventData = { clientHeight: number, scrollHeight: number, scrollTop: number -} \ No newline at end of file +} diff --git a/types/react-virtualized/react-virtualized-tests.tsx b/types/react-virtualized/react-virtualized-tests.tsx index 71386b2780..18de45e25a 100644 --- a/types/react-virtualized/react-virtualized-tests.tsx +++ b/types/react-virtualized/react-virtualized-tests.tsx @@ -113,7 +113,7 @@ export class AutoSizerExample extends PureComponent { ) } } -import { } from 'react' +import { } from 'react' import { CellMeasurer, CellMeasurerCache } from 'react-virtualized' export class DynamicHeightList extends PureComponent { @@ -194,7 +194,6 @@ const GUTTER_SIZE = 3 const CELL_WIDTH = 75 export class CollectionExample extends PureComponent { - _columnYMap: any; constructor(props, context) { @@ -457,8 +456,6 @@ export class ColumnSizerExample extends PureComponent { } export class GridExample extends PureComponent { - - constructor(props, context) { super(props, context) @@ -731,7 +728,7 @@ export class InfiniteLoaderExample extends PureComponent { const { loadedRowsMap, loadingRowCount } = this.state const increment = stopIndex - startIndex + 1 - for (var i = startIndex; i <= stopIndex; i++) { + for (let i = startIndex; i <= stopIndex; i++) { loadedRowsMap[i] = STATUS_LOADING } @@ -744,7 +741,7 @@ export class InfiniteLoaderExample extends PureComponent { delete this._timeoutIdMap[timeoutId] - for (var i = startIndex; i <= stopIndex; i++) { + for (let i = startIndex; i <= stopIndex; i++) { loadedRowsMap[i] = STATUS_LOADED } @@ -1251,7 +1248,7 @@ export class MultiGridExample extends PureComponent { } } -import {ScrollSync } from 'react-virtualized' +import { ScrollSync } from 'react-virtualized' const LEFT_COLOR_FROM = hexToRgb('#471061') const LEFT_COLOR_TO = hexToRgb('#BC3959') @@ -1532,59 +1529,59 @@ export class TableExample extends PureComponent { const rowGetter = ({ index }) => this._getDatum(sortedList, index) return ( -
    - - {({ width }) => ( - - {!hideIndexRow && - rowData.index - } - dataKey='index' - disableSort={!this._isSortEnabled()} - width={60} - /> - } +
    + + {({ width }) => ( +
    + {!hideIndexRow && - cellData + label='Index' + cellDataGetter={ + ({ columnData, dataKey, rowData }) => rowData.index } - flexGrow={1} + dataKey='index' + disableSort={!this._isSortEnabled()} + width={60} /> -
    - )} -     -
    + } + + cellData + } + flexGrow={1} + /> + + )} + + ) } diff --git a/types/react-virtualized/tslint.json b/types/react-virtualized/tslint.json index 2221e40e4a..65f4cad455 100644 --- a/types/react-virtualized/tslint.json +++ b/types/react-virtualized/tslint.json @@ -1 +1,12 @@ -{ "extends": "../tslint.json" } \ No newline at end of file +{ + "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 From f96d7d94b5caa65cd4d3ab2a9f3b135f5de9d0b0 Mon Sep 17 00:00:00 2001 From: Troy Weber Date: Thu, 30 Mar 2017 13:15:54 -0700 Subject: [PATCH 088/844] changes to past compile --- types/serialport/index.d.ts | 4 ++-- types/serialport/serialport-tests.ts | 5 ++--- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/types/serialport/index.d.ts b/types/serialport/index.d.ts index 3a1a45d19c..3c16de3a35 100644 --- a/types/serialport/index.d.ts +++ b/types/serialport/index.d.ts @@ -6,7 +6,7 @@ declare module 'serialport' { class SerialPort { //openImmediately already removed in 4.0.7 - constructor(path: string, options?: SerialPort.options, callback?: (err: any) => void) + constructor(path: string, options?: SerialPort.options|((err: any) => void), callback?: (err: any) => void) isOpen(): boolean; on(event: string, callback?: (data?: any) => void): void; open(callback?: (err: any) => void): void; @@ -61,7 +61,7 @@ declare module 'serialport' { xon?: boolean, xoff?: boolean, bufferSize?: number, - parser?: Function, + parser?: any, platformOptions?: { vmin?: number, vtime?: number diff --git a/types/serialport/serialport-tests.ts b/types/serialport/serialport-tests.ts index 60ca6f119c..3e799f2ee1 100644 --- a/types/serialport/serialport-tests.ts +++ b/types/serialport/serialport-tests.ts @@ -12,10 +12,9 @@ function test_basic_connect() { function test_connect_config() { let port = new SerialPort("", { - baudrate: 0, - disconnectedCallback: function () { }, + baudRate: 0, parser: SerialPort.parsers.readline("\n") - }); + }, function(err:any) { }); } function test_write() { From 34ce3dbb31cfe3ddbe3eabd326d9be21422ebc82 Mon Sep 17 00:00:00 2001 From: Troy Weber Date: Thu, 30 Mar 2017 13:25:07 -0700 Subject: [PATCH 089/844] lint issues --- types/firmata/index.d.ts | 88 ++++++++++++++++++++-------------------- 1 file changed, 44 insertions(+), 44 deletions(-) diff --git a/types/firmata/index.d.ts b/types/firmata/index.d.ts index 60a1284c4f..a4c6d96d71 100644 --- a/types/firmata/index.d.ts +++ b/types/firmata/index.d.ts @@ -16,7 +16,7 @@ export = Board; * guarantee that it cannot be improved. */ declare class Board extends NodeJS.EventEmitter { - constructor(serialPort: string, optionsOrCallback:Board.Options, callback?: (error: any) => void) + constructor(serialPort: string, optionsOrCallback?: Board.Options|((error: any) => void), callback?: (error: any) => void) MODES: Board.PinModes; STEPPER: Board.StepperConstants; I2C_MODES: Board.I2cModes; @@ -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, @@ -153,9 +153,9 @@ declare class Board extends NodeJS.EventEmitter { declare namespace Board { // https://github.com/firmata/firmata.js/blob/master/lib/firmata.js#L429-L451 interface Options { - reportVersionTimeout: number, - samplingInterval: number, - serialport: SerialPort.options + reportVersionTimeout: number; + samplingInterval: number; + serialport: SerialPort.options; } interface PinModes { From 0c1560db95027fb9cc1261ebf0163cf27eec926c Mon Sep 17 00:00:00 2001 From: Troy Weber Date: Thu, 30 Mar 2017 13:27:09 -0700 Subject: [PATCH 090/844] minor fubb --- types/firmata/index.d.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/types/firmata/index.d.ts b/types/firmata/index.d.ts index a4c6d96d71..f18294d110 100644 --- a/types/firmata/index.d.ts +++ b/types/firmata/index.d.ts @@ -153,9 +153,9 @@ declare class Board extends NodeJS.EventEmitter { declare namespace Board { // https://github.com/firmata/firmata.js/blob/master/lib/firmata.js#L429-L451 interface Options { - reportVersionTimeout: number; - samplingInterval: number; - serialport: SerialPort.options; + reportVersionTimeout?: number; + samplingInterval?: number; + serialport?: SerialPort.options; } interface PinModes { From 3d13ec53995bcccc68bdd4317e5bccb2235ee25e Mon Sep 17 00:00:00 2001 From: Andy Date: Thu, 30 Mar 2017 14:11:46 -0700 Subject: [PATCH 091/844] Lint react-* packages (#15526) --- types/react-autosuggest/index.d.ts | 28 +- types/react-body-classname/index.d.ts | 2 +- .../react-body-classname-tests.tsx | 2 +- types/react-bootstrap-date-picker/index.d.ts | 8 +- types/react-copy-to-clipboard/index.d.ts | 2 +- .../react-day-picker-tests.tsx | 2 +- .../react-dnd-html5-backend-tests.ts | 48 +-- types/react-event-listener/index.d.ts | 372 +++++++++--------- types/react-facebook-login/index.d.ts | 4 +- types/react-gravatar/index.d.ts | 6 +- types/react-gravatar/react-gravatar-tests.tsx | 2 +- types/react-highlight-words/index.d.ts | 2 +- .../react-highlighter-tests.tsx | 2 +- types/react-icon-base/index.d.ts | 4 +- .../react-icon-base/react-icon-base-tests.tsx | 2 +- types/react-icons/react-icons-tests.tsx | 2 - types/react-icons/tslint.json | 9 +- types/react-input-mask/index.d.ts | 4 +- types/react-joyride/index.d.ts | 2 +- types/react-json-pretty/index.d.ts | 4 +- types/react-leaflet/index.d.ts | 106 ++--- types/react-leaflet/react-leaflet-tests.tsx | 7 +- types/react-modal/index.d.ts | 6 +- types/react-modal/react-modal-tests.tsx | 2 +- types/react-onsenui/index.d.ts | 260 ++++++------ types/react-onsenui/react-onsenui-tests.tsx | 11 +- types/react-overlays/index.d.ts | 26 +- .../react-overlays/lib/RootCloseWrapper.d.ts | 2 +- types/react-overlays/react-overlays-tests.tsx | 1 - types/react-paginate/index.d.ts | 4 +- types/react-paginate/react-paginate-tests.tsx | 1 - types/react-portal/index.d.ts | 10 +- types/react-portal/react-portal-tests.tsx | 6 +- types/react-recaptcha/index.d.ts | 6 +- .../react-recaptcha/react-recaptcha-tests.tsx | 2 +- types/react-sidebar/index.d.ts | 2 +- types/react-smooth-scrollbar/index.d.ts | 3 +- types/react-sticky/index.d.ts | 2 +- types/react-test-renderer/index.d.ts | 2 +- types/reactstrap/index.d.ts | 140 +++---- types/reactstrap/reactstrap-tests.tsx | 83 ++-- 41 files changed, 575 insertions(+), 614 deletions(-) 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-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-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/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); From 6a285d2dcf6d2bece6fc2a5032644df187f38fd9 Mon Sep 17 00:00:00 2001 From: Andy Date: Thu, 30 Mar 2017 14:12:02 -0700 Subject: [PATCH 092/844] Lint d3-* packages (#15523) --- types/d3-array/index.d.ts | 4 +- types/d3-axis/index.d.ts | 16 +++--- types/d3-drag/d3-drag-tests.ts | 5 -- types/d3-drag/index.d.ts | 3 -- types/d3-dsv/v0/index.d.ts | 92 ++++++++++++++++---------------- types/d3-ease/d3-ease-tests.ts | 1 - types/d3-ease/index.d.ts | 37 ++++++------- types/d3-force/d3-force-tests.ts | 17 ------ types/d3-force/index.d.ts | 3 -- types/d3-geo/d3-geo-tests.ts | 4 +- types/d3-geo/index.d.ts | 66 +++++++++++------------ types/d3-scale/d3-scale-tests.ts | 41 -------------- types/d3-scale/index.d.ts | 75 +++++++++++--------------- types/d3-selection/index.d.ts | 22 ++++---- types/d3-shape/index.d.ts | 6 +-- 15 files changed, 153 insertions(+), 239 deletions(-) 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. From 389adfc542fee64c48cf040510bd2dcce8546c74 Mon Sep 17 00:00:00 2001 From: cailenmusselman Date: Thu, 30 Mar 2017 15:15:34 -0600 Subject: [PATCH 093/844] findNodeHandle also accepts base react-native components (#15444) * findNodeHandle also accepts base react-native components We're also able to pass in base react-native components like View, TextView, etc. to findNodeHandle * Added static tests for findNodeHandle definition * Removed trailing whitespace * Okay NOW all trailing white-space is removed --- types/react-native/index.d.ts | 2 +- types/react-native/test/index.tsx | 37 ++++++++++++++++++++++++++----- 2 files changed, 32 insertions(+), 7 deletions(-) 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 + ) } From 68e0aea47ae978cf9abbed03c5a70776d9082c35 Mon Sep 17 00:00:00 2001 From: Andy Date: Thu, 30 Mar 2017 14:25:38 -0700 Subject: [PATCH 094/844] Lint additional react packages (#15527) --- .../google-map-react-tests.tsx | 2 +- types/google-map-react/index.d.ts | 24 +++--- .../test/CustomColumnComponent.tsx | 2 +- types/navigation-react/index.d.ts | 2 +- types/qrcode.react/index.d.ts | 4 +- types/react-native-datepicker/index.d.ts | 4 +- .../react-native-datepicker-tests.tsx | 1 - .../index.d.ts | 77 +++++++++--------- ...ct-native-google-analytics-bridge-tests.ts | 29 ++++--- types/react-native/tslint.json | 2 + types/react-router-config/index.d.ts | 4 +- .../react-router-config-tests.tsx | 11 ++- types/react-router-dom/index.d.ts | 13 +--- types/react-router/test/ModalGallery.tsx | 1 - types/react-router/test/Recursive.tsx | 2 +- types/react-router/tslint.json | 8 +- types/react-router/v3/lib/IndexRoute.d.ts | 4 +- types/react-router/v3/lib/Route.d.ts | 4 +- .../v3/lib/applyRouterMiddleware.d.ts | 4 +- types/react-router/v3/react-router-tests.tsx | 12 +-- types/realm/index.d.ts | 78 +++++++++---------- 21 files changed, 139 insertions(+), 149 deletions(-) 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/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/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/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/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/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-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/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; From 93410826e1d07c3846424a6397cc66bfd92ba5e6 Mon Sep 17 00:00:00 2001 From: Denis Date: Thu, 30 Mar 2017 17:49:01 -0400 Subject: [PATCH 095/844] Fix linting --- types/leaflet.locatecontrol/index.d.ts | 52 +++++++++---------- .../leaflet.locatecontrol-tests.ts | 6 +-- 2 files changed, 29 insertions(+), 29 deletions(-) diff --git a/types/leaflet.locatecontrol/index.d.ts b/types/leaflet.locatecontrol/index.d.ts index 5758caed85..056e7b0d32 100644 --- a/types/leaflet.locatecontrol/index.d.ts +++ b/types/leaflet.locatecontrol/index.d.ts @@ -7,32 +7,32 @@ 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 Locate extends L.Control {} + 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; } } 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 +}})); From d7218e2fe3345e43c1bb90649abec084c71a8592 Mon Sep 17 00:00:00 2001 From: Justin Firth Date: Thu, 30 Mar 2017 18:13:46 -0400 Subject: [PATCH 096/844] Support SVG elements; Remove extraneous definition --- types/hyperscript/hyperscript-tests.ts | 19 +++++++++++++++---- types/hyperscript/index.d.ts | 11 ++++------- 2 files changed, 19 insertions(+), 11 deletions(-) diff --git a/types/hyperscript/hyperscript-tests.ts b/types/hyperscript/hyperscript-tests.ts index 02ea158977..687a2591c1 100644 --- a/types/hyperscript/hyperscript-tests.ts +++ b/types/hyperscript/hyperscript-tests.ts @@ -59,14 +59,25 @@ h2.cleanup() /* Polymorphic type tests */ -// determine proper HTMLElement type from tagName -let test1: HTMLCanvasElement = h('canvas'); +// 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 test2: HTMLCanvasElement = h('canvas#test2'); +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 -// example 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 b4384ba302..cec67e56ab 100644 --- a/types/hyperscript/index.d.ts +++ b/types/hyperscript/index.d.ts @@ -1,18 +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 a typed HTMLElement */ - (tagName: T, attrs?: Object, ...children: any[]): HTMLElementTagNameMap[T]; - /** Creates a typed HTMLElement via coercion */ - (tagName: string, attrs?: Object, ...children: any[]): T; - /** Creates an HTMLElement */ - (tagName: T, attrs?: Object, ...children: 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 */ From ff0d451b567d3ed245e6598c0eb2f3bc9b93d310 Mon Sep 17 00:00:00 2001 From: Andy Date: Thu, 30 Mar 2017 15:33:16 -0700 Subject: [PATCH 097/844] Fix various lint errors (#15529) --- types/artyom.js/artyom.js-tests.ts | 2 +- types/artyom.js/index.d.ts | 40 +-- types/bigi/bigi-tests.ts | 8 +- types/bitcoinjs-lib/bitcoinjs-lib-tests.ts | 34 +- types/blacklist/blacklist-tests.ts | 4 +- types/clndr/clndr-tests.ts | 2 +- types/cookies/cookies-tests.ts | 6 +- types/cpy/cpy-tests.ts | 3 +- types/cpy/index.d.ts | 5 +- types/csvtojson/index.d.ts | 6 +- types/csvtojson/tslint.json | 7 +- types/del/del-tests.ts | 3 +- types/dockerode/dockerode-tests.ts | 2 +- types/dockerode/index.d.ts | 1 - types/ecurve/ecurve-tests.ts | 22 +- types/f1/f1-tests.ts | 4 +- types/f1/index.d.ts | 4 +- types/falcor/index.d.ts | 66 ++-- types/fetch.io/index.d.ts | 24 +- types/globule/index.d.ts | 2 +- types/google-protobuf/tslint.json | 15 +- types/inert/index.d.ts | 2 +- .../is-absolute-url/is-absolute-url-tests.ts | 2 +- types/isbn-utils/index.d.ts | 1 - types/isbn-utils/isbn-utils-tests.ts | 1 - types/jsnlog/index.d.ts | 26 +- types/koa-json-error/index.d.ts | 6 +- types/koa-jwt/index.d.ts | 2 +- types/later/index.d.ts | 86 +++--- types/later/later-tests.ts | 68 ++-- types/memcached/memcached-tests.ts | 34 +- types/mock-raf/index.d.ts | 6 +- types/mock-raf/mock-raf-tests.ts | 2 +- types/nedb/index.d.ts | 6 +- types/optics-agent/index.d.ts | 2 +- types/parsimmon/index.d.ts | 8 +- types/progressbar/progressbar-tests.ts | 6 +- types/pump/index.d.ts | 4 +- types/raven/index.d.ts | 59 ++-- types/raven/raven-tests.ts | 7 +- types/rheostat/index.d.ts | 15 +- types/sha1/sha1-tests.ts | 25 +- types/sharp/sharp-tests.ts | 2 +- types/slimerjs/index.d.ts | 69 ++--- types/slimerjs/slimerjs-tests.ts | 25 +- types/sshpk/index.d.ts | 128 ++++---- types/sshpk/sshpk-tests.ts | 1 - types/strip-bom/strip-bom-tests.ts | 2 +- types/swiper/index.d.ts | 73 +++-- types/swiper/swiper-tests.ts | 141 +++++---- types/swiper/v2/index.d.ts | 25 +- types/swiper/v2/swiper-tests.ts | 58 ++-- types/tcomb/tcomb-tests.ts | 2 +- types/uikit/index.d.ts | 105 +++---- types/uikit/uikit-tests.ts | 136 ++++---- types/uuid-js/uuid-js-tests.ts | 22 +- types/vis/index.d.ts | 64 ++-- types/vis/vis-tests.ts | 44 +-- types/webpack-chain/index.d.ts | 290 +++++++++--------- types/webpack-chain/webpack-chain-tests.ts | 2 +- 60 files changed, 838 insertions(+), 979 deletions(-) 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/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/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/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/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/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/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/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/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/dockerode/dockerode-tests.ts b/types/dockerode/dockerode-tests.ts index 3bd1c30097..b010b68fe0 100644 --- a/types/dockerode/dockerode-tests.ts +++ b/types/dockerode/dockerode-tests.ts @@ -55,4 +55,4 @@ docker.createContainer({ Tty: true }, (err, container) => { container.start((err, data) => { // NOOP }); -}); \ No newline at end of file +}); diff --git a/types/dockerode/index.d.ts b/types/dockerode/index.d.ts index 968199436a..e35cd8b466 100644 --- a/types/dockerode/index.d.ts +++ b/types/dockerode/index.d.ts @@ -8,7 +8,6 @@ import * as stream from 'stream'; import * as events from 'events'; - declare namespace Dockerode { interface Container { inspect(options: {}, callback: Callback): void; 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/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/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.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/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-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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/vis/index.d.ts b/types/vis/index.d.ts index 0d94a44354..e4f8fe0dfd 100644 --- a/types/vis/index.d.ts +++ b/types/vis/index.d.ts @@ -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,15 +170,15 @@ 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; selectable?: 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/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({}) From f232d29caf964b59bf6306ae197f93f563ba87a3 Mon Sep 17 00:00:00 2001 From: Ryan Riley Date: Thu, 30 Mar 2017 18:22:52 -0500 Subject: [PATCH 098/844] Update index.d.ts --- types/handsontable/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/handsontable/index.d.ts b/types/handsontable/index.d.ts index 55e2d25e4d..4d79957d45 100644 --- a/types/handsontable/index.d.ts +++ b/types/handsontable/index.d.ts @@ -450,7 +450,7 @@ declare namespace ht { TextEditor: EditorConstructor; } - type Validator = (value: string, callback: (condition: boolean) => void) => void; + type Validator = (value: any, callback: (condition: boolean) => void) => void; interface Renderers { TextRenderer: CellRenderer; From 5379903578190c82cd55b5a0bd8a37ff025a4873 Mon Sep 17 00:00:00 2001 From: Nicolas Laplante Date: Thu, 30 Mar 2017 19:46:10 -0400 Subject: [PATCH 099/844] fix dtslint errors --- types/dockerode/index.d.ts | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/types/dockerode/index.d.ts b/types/dockerode/index.d.ts index 0acb68662b..743b516a88 100644 --- a/types/dockerode/index.d.ts +++ b/types/dockerode/index.d.ts @@ -590,19 +590,19 @@ declare namespace Dockerode { } interface SecretVersion { - Index: number + Index: number; } interface ServiceSpec { - Name: string + Name: string; } interface SecretInfo { - ID: string, + ID: string; Version: SecretVersion; - CreatedAt: string, - UpdatedAt?: string, - Spec?: ServiceSpec + CreatedAt: string; + UpdatedAt?: string; + Spec?: ServiceSpec; } interface PluginInfo { @@ -647,7 +647,7 @@ declare namespace Dockerode { interface PluginInterfaceType { Prefix: string; Capability: string; - Version: string + Version: string; } interface PluginMount { @@ -657,7 +657,7 @@ declare namespace Dockerode { Source: string; Destination: string; Type: string; - Options: string[] + Options: string[]; } interface Linux { @@ -704,7 +704,6 @@ declare namespace Dockerode { interface PruneImagesInfo { ImagesDeleted: ImageRemoveInfo[]; SpaceReclaimed: number; - } interface PruneVolumesInfo { @@ -720,7 +719,6 @@ declare namespace Dockerode { interface PruneNetworksInfo { NetworksDeleted: string[]; } - } type Callback = (error?: any, result?: T) => void; From 7a83c0174e2e726bd64107d933b74948d5bd96df Mon Sep 17 00:00:00 2001 From: Nicolas Laplante Date: Thu, 30 Mar 2017 19:48:51 -0400 Subject: [PATCH 100/844] fix one missing dtslint error --- types/dockerode/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/dockerode/index.d.ts b/types/dockerode/index.d.ts index 743b516a88..2e834f0b3b 100644 --- a/types/dockerode/index.d.ts +++ b/types/dockerode/index.d.ts @@ -599,7 +599,7 @@ declare namespace Dockerode { interface SecretInfo { ID: string; - Version: SecretVersion; + Version: SecretVersion; CreatedAt: string; UpdatedAt?: string; Spec?: ServiceSpec; From 2d9510949f2e2ad6cc4a5c160737f2e17bed5b85 Mon Sep 17 00:00:00 2001 From: Ryan Riley Date: Thu, 30 Mar 2017 18:51:55 -0500 Subject: [PATCH 101/844] Requested changes --- types/handsontable/handsontable-tests.ts | 299 ---------------------- types/handsontable/index.d.ts | 27 +- types/handsontable/test/global.ts | 301 +++++++++++++++++++++++ types/handsontable/test/module.ts | 301 +++++++++++++++++++++++ types/handsontable/tsconfig.json | 3 +- 5 files changed, 616 insertions(+), 315 deletions(-) delete mode 100644 types/handsontable/handsontable-tests.ts create mode 100644 types/handsontable/test/global.ts create mode 100644 types/handsontable/test/module.ts diff --git a/types/handsontable/handsontable-tests.ts b/types/handsontable/handsontable-tests.ts deleted file mode 100644 index 8ff99cc0b7..0000000000 --- a/types/handsontable/handsontable-tests.ts +++ /dev/null @@ -1,299 +0,0 @@ -function test_HandsontableInit() { - const elem = document.createElement('div'); - const hot = new Handsontable(elem, { - allowEmpty: true, - allowInsertColumn: true, - allowInsertRow: true, - allowInvalid: true, - allowRemoveColumn: true, - allowRemoveRow: true, - autoColumnSize: true, - autoComplete: [], - autoRowSize: true, - autoWrapCol: true, - autoWrapRow: true, - bindRowsWithHeaders: 'foo', - cell: [], - cells: () => { return; }, - checkedTemplate: true, - className: [], - colHeaders: true, - collapsibleColumns: true, - columnHeaderHeight: 123, - columns: [], - columnSorting: {}, - columnSummary: {}, - colWidths: 123, - commentedCellClassName: 'foo', - comments: [], - contextMenu: true, - contextMenuCopyPaste: {}, - copyable: true, - copyColsLimit: 123, - copyPaste: true, - copyRowsLimit: 123, - correctFormat: true, - currentColClassName: 'foo', - currentRowClassName: 'foo', - customBorders: true, - data: [], - dataSchema: {}, - dateFormat: 'foo', - debug: true, - defaultDate: 'foo', - disableVisualSelection: true, - dropdownMenu: [], - editor: true, - enterBeginsEditing: true, - enterMoves: {}, - fillHandle: true, - filter: true, - filteringCaseSensitive: true, - filters: false, - fixedColumnsLeft: 123, - fixedRowsBottom: 123, - fixedRowsTop: 123, - format: 'foo', - fragmentSelection: true, - ganttChart: {}, - headerTooltips: true, - height: 123, - hiddenColumns: true, - hiddenRows: {}, - invalidCellClassName: 'foo', - label: {}, - language: 'foo', - manualColumnFreeze: true, - manualColumnMove: true, - manualColumnResize: true, - manualRowMove: true, - manualRowResize: true, - maxCols: 123, - maxRows: 123, - mergeCells: true, - minCols: 123, - minRows: 123, - minSpareCols: 123, - minSpareRows: 123, - multiSelect: true, - nestedHeaders: [], - noWordWrapClassName: 'foo', - observeChanges: true, - observeDOMVisibility: true, - outsideClickDeselects: true, - pasteMode: 'foo', - persistentState: true, - placeholder: 123, - placeholderCellClassName: 'foo', - preventOverflow: true, - readOnly: true, - readOnlyCellClassName: 'foo', - renderAllRows: true, - renderer: 'foo', - rowHeaders: true, - rowHeaderWidth: 123, - rowHeights: 123, - search: true, - selectOptions: [], - skipColumnOnPaste: true, - sortByRelevance: true, - sortFunction: () => { return; }, - sortIndicator: true, - source: [], - startCols: 123, - startRows: 123, - stretchH: 'foo', - strict: true, - tableClassName: 'foo', - tabMoves: {}, - title: 'foo', - trimDropdown: true, - trimWhitespace: true, - type: 'foo', - uncheckedTemplate: true, - undo: true, - validator: () => {return; }, - viewportColumnRenderingOffset: 123, - viewportRowRenderingOffset: 123, - visibleRows: 123, - width: 1232, - wordWrap: true, - - // Hooks - afterAutofillApplyValues: () => {return; }, - afterCellMetaReset: () => {return; }, - afterChange: () => {return; }, - afterChangesObserved: () => {return; }, - afterColumnMove: () => {return; }, - afterColumnResize: () => {return; }, - afterColumnSort: () => {return; }, - afterContextMenuDefaultOptions: () => {return; }, - afterContextMenuHide: () => {return; }, - afterContextMenuShow: () => {return; }, - afterCopyLimit: () => {return; }, - afterCreateCol: () => {return; }, - afterCreateRow: () => {return; }, - afterDeselect: () => {return; }, - afterDestroy: () => {return; }, - afterDocumentKeyDown: () => {return; }, - afterFilter: () => {return; }, - afterGetCellMeta: () => {return; }, - afterGetColHeader: () => {return; }, - afterGetColumnHeaderRenderers: () => {return; }, - afterGetRowHeader: () => {return; }, - afterGetRowHeaderRenderers: () => {return; }, - afterInit: () => {return; }, - afterLoadData: () => {return; }, - afterMomentumScroll: () => {return; }, - afterOnCellCornerMouseDown: () => {return; }, - afterOnCellMouseDown: () => {return; }, - afterOnCellMouseOver: () => {return; }, - afterRemoveCol: () => {return; }, - afterRemoveRow: () => {return; }, - afterRender: () => {return; }, - afterRenderer: () => {return; }, - afterRowMove: () => {return; }, - afterRowResize: () => {return; }, - afterScrollHorizontally: () => {return; }, - afterScrollVertically: () => {return; }, - afterSelection: () => {return; }, - afterSelectionByProp: () => {return; }, - afterSelectionEnd: () => {return; }, - afterSelectionEndByProp: () => {return; }, - afterSetCellMeta: () => {return; }, - afterUpdateSettings: () => {return; }, - afterValidate: () => {return; }, - beforeAutofill: () => {return; }, - beforeCellAlignment: () => {return; }, - beforeChange: () => {return; }, - beforeChangeRender: () => {return; }, - beforeColumnMove: () => {return; }, - beforeColumnResize: () => {return; }, - beforeColumnSort: () => {return; }, - beforeDrawBorders: () => {return; }, - beforeFilter: () => {return; }, - beforeGetCellMeta: () => {return; }, - beforeInit: () => {return; }, - beforeInitWalkontable: () => {return; }, - beforeKeyDown: () => {return; }, - beforeOnCellMouseDown: () => {return; }, - beforeRemoveCol: () => {return; }, - beforeRemoveRow: () => {return; }, - beforeRender: () => {return; }, - beforeRenderer: () => {return; }, - beforeRowMove: () => {return; }, - beforeRowResize: () => {return; }, - beforeSetRangeEnd: () => {return; }, - beforeStretchingColumnWidth: () => {return; }, - beforeTouchScroll: () => {return; }, - beforeValidate: () => {return; }, - construct: () => {return; }, - init: () => {return; }, - modifyCol: () => {return; }, - modifyColHeader: () => {return; }, - modifyColWidth: () => {return; }, - modifyCopyableRange: () => {return; }, - modifyRow: () => {return; }, - modifyRowHeader: () => {return; }, - modifyRowHeight: () => {return; }, - persistentStateLoad: () => {return; }, - persistentStateReset: () => {return; }, - persistentStateSave: () => {return; }, - unmodifyCol: () => {return; } - }); -} - -function test_HandsontableMethods() { - const elem = document.createElement('div'); - const hot = new Handsontable(elem, {}); - hot.addHook('foo', []); - hot.addHookOnce('foo', []); - hot.alter('foo', 123, 123, 'foo', true); - hot.clear(); - hot.colOffset(); - hot.colToProp(123); - hot.countCols(); - hot.countEmptyCols(true); - hot.countEmptyRows(true); - hot.countRenderedCols(); - hot.countRenderedRows(); - hot.countRows(); - hot.countSourceRows(); - hot.countVisibleCols(); - hot.countVisibleRows(); - hot.deselectCell(); - hot.destroy(); - hot.destroyEditor(true); - hot.getActiveEditor(); - hot.getCell(123, 123, true); - hot.getCellEditor(123, 123); - hot.getCellMeta(123, 123); - hot.getCellRenderer(123, 123); - hot.getCellValidator(123, 123); - hot.getColHeader(123); - hot.getColWidth(123); - hot.getCoords(elem.querySelector('td')); - hot.getCopyableData(123, 123); - hot.getCopyableText(123, 123, 123, 123); - hot.getData(123, 123, 123, 123); - hot.getDataAtCell(123, 123); - hot.getDataAtCol(123); - hot.getDataAtProp(123); - hot.getDataAtRow(123); - hot.getDataAtRowProp(123, 'foo'); - hot.getDataType(123, 123, 123, 123); - hot.getInstance(); - hot.getPlugin('foo'); - hot.getRowHeader(123); - hot.getRowHeight(123); - hot.getSchema(); - hot.getSelected(); - const range: ht.Range = hot.getSelectedRange(); - hot.getSettings(); - hot.getSourceData(123, 123, 123, 123); - hot.getSourceDataAtCell(123, 123); - hot.getSourceDataAtCol(123); - hot.getSourceDataAtRow(123); - hot.getValue(); - hot.hasColHeaders(); - hot.hasHook('foo'); - hot.hasRowHeaders(); - hot.isEmptyCol(123); - hot.isEmptyRow(123); - hot.isListening(); - hot.listen(); - hot.loadData([]); - hot.populateFromArray(123, 123, [], 123, 123, 'foo', 'foo', 'foo', []); - hot.propToCol('foo'); - hot.propToCol(123); - hot.removeCellMeta(123, 123, 'foo'); - hot.removeHook('foo', () => {return; }); - hot.render(); - hot.rowOffset(); - hot.runHooks('foo', 123, 'foo', true, {}, [], () => {return; }); - hot.selectCell(123, 123, 123, 123, true, true); - hot.selectCellByProp(123, 'foo', 123, 'foo', true); - hot.setCellMeta(123, 123, 'foo', 'foo'); - hot.setCellMetaObject(123, 123, {}); - hot.setDataAtCell(123, 123, 'foo', 'foo'); - hot.setDataAtRowProp(123, 'foo', 'foo', 'foo'); - hot.spliceCol(123, 123, 123, 'foo'); - hot.spliceRow(123, 123, 123, 'foo'); - hot.toPhysicalRow(123); - hot.toPhysicalColumn(123); - hot.toVisualRow(123); - hot.toVisualColumn(123); - hot.unlisten(); - hot.updateSettings({}, true); - hot.validateCells(() => {return; }); - - Handsontable.renderers.NumericRenderer(hot, new HTMLTableDataCellElement(), 0, 0, "prop", 1.235, {}); - Handsontable.renderers.TextRenderer(hot, new HTMLTableDataCellElement(), 0, 0, "prop", 1.235, {}); - Handsontable.Dom.addEvent(new HTMLElement(), "eventName", () => { return; }); -} - -class MyCustomHotPlugin extends Handsontable.plugins.BasePlugin { - isEnabled(): boolean { - return !!this.hot.getSettings().manualRowMove; - } -} diff --git a/types/handsontable/index.d.ts b/types/handsontable/index.d.ts index 4d79957d45..06ee9ffb60 100644 --- a/types/handsontable/index.d.ts +++ b/types/handsontable/index.d.ts @@ -3,7 +3,7 @@ // Definitions by: Handsoncode sp. z o.o. , Ryan Riley // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped\ -declare namespace ht { +declare namespace Handsontable { interface Options { allowEmpty?: boolean; allowInsertColumn?: boolean; @@ -494,19 +494,16 @@ declare namespace ht { } interface Handsontable { - new (element: Element, options: ht.Options): ht.Methods; - plugins: ht.Plugins; - hooks: ht.Hooks; - Dom: ht.Dom; - dom: ht.Dom; - helper: ht.Helper; - utils: ht.Utils; - renderers: ht.Renderers; - editors: ht.Editors; + new (element: Element, options: Handsontable.Options): Handsontable.Methods; + plugins: Handsontable.Plugins; + hooks: Handsontable.Hooks; + Dom: Handsontable.Dom; + dom: Handsontable.Dom; + helper: Handsontable.Helper; + utils: Handsontable.Utils; + renderers: Handsontable.Renderers; + editors: Handsontable.Editors; } -declare module "handsontable" { - export = Handsontable; -} - -declare var Handsontable: Handsontable; +export = Handsontable; +export as namespace Handsontable; diff --git a/types/handsontable/test/global.ts b/types/handsontable/test/global.ts new file mode 100644 index 0000000000..44dae84026 --- /dev/null +++ b/types/handsontable/test/global.ts @@ -0,0 +1,301 @@ +namespace HandsontableGlobalTest { + function test_HandsontableInit() { + const elem = document.createElement('div'); + const hot = new Handsontable(elem, { + allowEmpty: true, + allowInsertColumn: true, + allowInsertRow: true, + allowInvalid: true, + allowRemoveColumn: true, + allowRemoveRow: true, + autoColumnSize: true, + autoComplete: [], + autoRowSize: true, + autoWrapCol: true, + autoWrapRow: true, + bindRowsWithHeaders: 'foo', + cell: [], + cells: () => { return; }, + checkedTemplate: true, + className: [], + colHeaders: true, + collapsibleColumns: true, + columnHeaderHeight: 123, + columns: [], + columnSorting: {}, + columnSummary: {}, + colWidths: 123, + commentedCellClassName: 'foo', + comments: [], + contextMenu: true, + contextMenuCopyPaste: {}, + copyable: true, + copyColsLimit: 123, + copyPaste: true, + copyRowsLimit: 123, + correctFormat: true, + currentColClassName: 'foo', + currentRowClassName: 'foo', + customBorders: true, + data: [], + dataSchema: {}, + dateFormat: 'foo', + debug: true, + defaultDate: 'foo', + disableVisualSelection: true, + dropdownMenu: [], + editor: true, + enterBeginsEditing: true, + enterMoves: {}, + fillHandle: true, + filter: true, + filteringCaseSensitive: true, + filters: false, + fixedColumnsLeft: 123, + fixedRowsBottom: 123, + fixedRowsTop: 123, + format: 'foo', + fragmentSelection: true, + ganttChart: {}, + headerTooltips: true, + height: 123, + hiddenColumns: true, + hiddenRows: {}, + invalidCellClassName: 'foo', + label: {}, + language: 'foo', + manualColumnFreeze: true, + manualColumnMove: true, + manualColumnResize: true, + manualRowMove: true, + manualRowResize: true, + maxCols: 123, + maxRows: 123, + mergeCells: true, + minCols: 123, + minRows: 123, + minSpareCols: 123, + minSpareRows: 123, + multiSelect: true, + nestedHeaders: [], + noWordWrapClassName: 'foo', + observeChanges: true, + observeDOMVisibility: true, + outsideClickDeselects: true, + pasteMode: 'foo', + persistentState: true, + placeholder: 123, + placeholderCellClassName: 'foo', + preventOverflow: true, + readOnly: true, + readOnlyCellClassName: 'foo', + renderAllRows: true, + renderer: 'foo', + rowHeaders: true, + rowHeaderWidth: 123, + rowHeights: 123, + search: true, + selectOptions: [], + skipColumnOnPaste: true, + sortByRelevance: true, + sortFunction: () => { return; }, + sortIndicator: true, + source: [], + startCols: 123, + startRows: 123, + stretchH: 'foo', + strict: true, + tableClassName: 'foo', + tabMoves: {}, + title: 'foo', + trimDropdown: true, + trimWhitespace: true, + type: 'foo', + uncheckedTemplate: true, + undo: true, + validator: () => {return; }, + viewportColumnRenderingOffset: 123, + viewportRowRenderingOffset: 123, + visibleRows: 123, + width: 1232, + wordWrap: true, + + // Hooks + afterAutofillApplyValues: () => {return; }, + afterCellMetaReset: () => {return; }, + afterChange: () => {return; }, + afterChangesObserved: () => {return; }, + afterColumnMove: () => {return; }, + afterColumnResize: () => {return; }, + afterColumnSort: () => {return; }, + afterContextMenuDefaultOptions: () => {return; }, + afterContextMenuHide: () => {return; }, + afterContextMenuShow: () => {return; }, + afterCopyLimit: () => {return; }, + afterCreateCol: () => {return; }, + afterCreateRow: () => {return; }, + afterDeselect: () => {return; }, + afterDestroy: () => {return; }, + afterDocumentKeyDown: () => {return; }, + afterFilter: () => {return; }, + afterGetCellMeta: () => {return; }, + afterGetColHeader: () => {return; }, + afterGetColumnHeaderRenderers: () => {return; }, + afterGetRowHeader: () => {return; }, + afterGetRowHeaderRenderers: () => {return; }, + afterInit: () => {return; }, + afterLoadData: () => {return; }, + afterMomentumScroll: () => {return; }, + afterOnCellCornerMouseDown: () => {return; }, + afterOnCellMouseDown: () => {return; }, + afterOnCellMouseOver: () => {return; }, + afterRemoveCol: () => {return; }, + afterRemoveRow: () => {return; }, + afterRender: () => {return; }, + afterRenderer: () => {return; }, + afterRowMove: () => {return; }, + afterRowResize: () => {return; }, + afterScrollHorizontally: () => {return; }, + afterScrollVertically: () => {return; }, + afterSelection: () => {return; }, + afterSelectionByProp: () => {return; }, + afterSelectionEnd: () => {return; }, + afterSelectionEndByProp: () => {return; }, + afterSetCellMeta: () => {return; }, + afterUpdateSettings: () => {return; }, + afterValidate: () => {return; }, + beforeAutofill: () => {return; }, + beforeCellAlignment: () => {return; }, + beforeChange: () => {return; }, + beforeChangeRender: () => {return; }, + beforeColumnMove: () => {return; }, + beforeColumnResize: () => {return; }, + beforeColumnSort: () => {return; }, + beforeDrawBorders: () => {return; }, + beforeFilter: () => {return; }, + beforeGetCellMeta: () => {return; }, + beforeInit: () => {return; }, + beforeInitWalkontable: () => {return; }, + beforeKeyDown: () => {return; }, + beforeOnCellMouseDown: () => {return; }, + beforeRemoveCol: () => {return; }, + beforeRemoveRow: () => {return; }, + beforeRender: () => {return; }, + beforeRenderer: () => {return; }, + beforeRowMove: () => {return; }, + beforeRowResize: () => {return; }, + beforeSetRangeEnd: () => {return; }, + beforeStretchingColumnWidth: () => {return; }, + beforeTouchScroll: () => {return; }, + beforeValidate: () => {return; }, + construct: () => {return; }, + init: () => {return; }, + modifyCol: () => {return; }, + modifyColHeader: () => {return; }, + modifyColWidth: () => {return; }, + modifyCopyableRange: () => {return; }, + modifyRow: () => {return; }, + modifyRowHeader: () => {return; }, + modifyRowHeight: () => {return; }, + persistentStateLoad: () => {return; }, + persistentStateReset: () => {return; }, + persistentStateSave: () => {return; }, + unmodifyCol: () => {return; } + }); + } + + function test_HandsontableMethods() { + const elem = document.createElement('div'); + const hot = new Handsontable(elem, {}); + hot.addHook('foo', []); + hot.addHookOnce('foo', []); + hot.alter('foo', 123, 123, 'foo', true); + hot.clear(); + hot.colOffset(); + hot.colToProp(123); + hot.countCols(); + hot.countEmptyCols(true); + hot.countEmptyRows(true); + hot.countRenderedCols(); + hot.countRenderedRows(); + hot.countRows(); + hot.countSourceRows(); + hot.countVisibleCols(); + hot.countVisibleRows(); + hot.deselectCell(); + hot.destroy(); + hot.destroyEditor(true); + hot.getActiveEditor(); + hot.getCell(123, 123, true); + hot.getCellEditor(123, 123); + hot.getCellMeta(123, 123); + hot.getCellRenderer(123, 123); + hot.getCellValidator(123, 123); + hot.getColHeader(123); + hot.getColWidth(123); + hot.getCoords(elem.querySelector('td')); + hot.getCopyableData(123, 123); + hot.getCopyableText(123, 123, 123, 123); + hot.getData(123, 123, 123, 123); + hot.getDataAtCell(123, 123); + hot.getDataAtCol(123); + hot.getDataAtProp(123); + hot.getDataAtRow(123); + hot.getDataAtRowProp(123, 'foo'); + hot.getDataType(123, 123, 123, 123); + hot.getInstance(); + hot.getPlugin('foo'); + hot.getRowHeader(123); + hot.getRowHeight(123); + hot.getSchema(); + hot.getSelected(); + const range: ht.Range = hot.getSelectedRange(); + hot.getSettings(); + hot.getSourceData(123, 123, 123, 123); + hot.getSourceDataAtCell(123, 123); + hot.getSourceDataAtCol(123); + hot.getSourceDataAtRow(123); + hot.getValue(); + hot.hasColHeaders(); + hot.hasHook('foo'); + hot.hasRowHeaders(); + hot.isEmptyCol(123); + hot.isEmptyRow(123); + hot.isListening(); + hot.listen(); + hot.loadData([]); + hot.populateFromArray(123, 123, [], 123, 123, 'foo', 'foo', 'foo', []); + hot.propToCol('foo'); + hot.propToCol(123); + hot.removeCellMeta(123, 123, 'foo'); + hot.removeHook('foo', () => {return; }); + hot.render(); + hot.rowOffset(); + hot.runHooks('foo', 123, 'foo', true, {}, [], () => {return; }); + hot.selectCell(123, 123, 123, 123, true, true); + hot.selectCellByProp(123, 'foo', 123, 'foo', true); + hot.setCellMeta(123, 123, 'foo', 'foo'); + hot.setCellMetaObject(123, 123, {}); + hot.setDataAtCell(123, 123, 'foo', 'foo'); + hot.setDataAtRowProp(123, 'foo', 'foo', 'foo'); + hot.spliceCol(123, 123, 123, 'foo'); + hot.spliceRow(123, 123, 123, 'foo'); + hot.toPhysicalRow(123); + hot.toPhysicalColumn(123); + hot.toVisualRow(123); + hot.toVisualColumn(123); + hot.unlisten(); + hot.updateSettings({}, true); + hot.validateCells(() => {return; }); + + Handsontable.renderers.NumericRenderer(hot, new HTMLTableDataCellElement(), 0, 0, "prop", 1.235, {}); + Handsontable.renderers.TextRenderer(hot, new HTMLTableDataCellElement(), 0, 0, "prop", 1.235, {}); + Handsontable.Dom.addEvent(new HTMLElement(), "eventName", () => { return; }); + } + + class MyCustomHotPlugin extends Handsontable.plugins.BasePlugin { + isEnabled(): boolean { + return !!this.hot.getSettings().manualRowMove; + } + } +} \ No newline at end of file diff --git a/types/handsontable/test/module.ts b/types/handsontable/test/module.ts new file mode 100644 index 0000000000..3f3e3a4c40 --- /dev/null +++ b/types/handsontable/test/module.ts @@ -0,0 +1,301 @@ +namespace HandsOnTableModuleTest { + function test_HandsontableInit() { + const elem = document.createElement('div'); + const hot = new Handsontable(elem, { + allowEmpty: true, + allowInsertColumn: true, + allowInsertRow: true, + allowInvalid: true, + allowRemoveColumn: true, + allowRemoveRow: true, + autoColumnSize: true, + autoComplete: [], + autoRowSize: true, + autoWrapCol: true, + autoWrapRow: true, + bindRowsWithHeaders: 'foo', + cell: [], + cells: () => { return; }, + checkedTemplate: true, + className: [], + colHeaders: true, + collapsibleColumns: true, + columnHeaderHeight: 123, + columns: [], + columnSorting: {}, + columnSummary: {}, + colWidths: 123, + commentedCellClassName: 'foo', + comments: [], + contextMenu: true, + contextMenuCopyPaste: {}, + copyable: true, + copyColsLimit: 123, + copyPaste: true, + copyRowsLimit: 123, + correctFormat: true, + currentColClassName: 'foo', + currentRowClassName: 'foo', + customBorders: true, + data: [], + dataSchema: {}, + dateFormat: 'foo', + debug: true, + defaultDate: 'foo', + disableVisualSelection: true, + dropdownMenu: [], + editor: true, + enterBeginsEditing: true, + enterMoves: {}, + fillHandle: true, + filter: true, + filteringCaseSensitive: true, + filters: false, + fixedColumnsLeft: 123, + fixedRowsBottom: 123, + fixedRowsTop: 123, + format: 'foo', + fragmentSelection: true, + ganttChart: {}, + headerTooltips: true, + height: 123, + hiddenColumns: true, + hiddenRows: {}, + invalidCellClassName: 'foo', + label: {}, + language: 'foo', + manualColumnFreeze: true, + manualColumnMove: true, + manualColumnResize: true, + manualRowMove: true, + manualRowResize: true, + maxCols: 123, + maxRows: 123, + mergeCells: true, + minCols: 123, + minRows: 123, + minSpareCols: 123, + minSpareRows: 123, + multiSelect: true, + nestedHeaders: [], + noWordWrapClassName: 'foo', + observeChanges: true, + observeDOMVisibility: true, + outsideClickDeselects: true, + pasteMode: 'foo', + persistentState: true, + placeholder: 123, + placeholderCellClassName: 'foo', + preventOverflow: true, + readOnly: true, + readOnlyCellClassName: 'foo', + renderAllRows: true, + renderer: 'foo', + rowHeaders: true, + rowHeaderWidth: 123, + rowHeights: 123, + search: true, + selectOptions: [], + skipColumnOnPaste: true, + sortByRelevance: true, + sortFunction: () => { return; }, + sortIndicator: true, + source: [], + startCols: 123, + startRows: 123, + stretchH: 'foo', + strict: true, + tableClassName: 'foo', + tabMoves: {}, + title: 'foo', + trimDropdown: true, + trimWhitespace: true, + type: 'foo', + uncheckedTemplate: true, + undo: true, + validator: () => {return; }, + viewportColumnRenderingOffset: 123, + viewportRowRenderingOffset: 123, + visibleRows: 123, + width: 1232, + wordWrap: true, + + // Hooks + afterAutofillApplyValues: () => {return; }, + afterCellMetaReset: () => {return; }, + afterChange: () => {return; }, + afterChangesObserved: () => {return; }, + afterColumnMove: () => {return; }, + afterColumnResize: () => {return; }, + afterColumnSort: () => {return; }, + afterContextMenuDefaultOptions: () => {return; }, + afterContextMenuHide: () => {return; }, + afterContextMenuShow: () => {return; }, + afterCopyLimit: () => {return; }, + afterCreateCol: () => {return; }, + afterCreateRow: () => {return; }, + afterDeselect: () => {return; }, + afterDestroy: () => {return; }, + afterDocumentKeyDown: () => {return; }, + afterFilter: () => {return; }, + afterGetCellMeta: () => {return; }, + afterGetColHeader: () => {return; }, + afterGetColumnHeaderRenderers: () => {return; }, + afterGetRowHeader: () => {return; }, + afterGetRowHeaderRenderers: () => {return; }, + afterInit: () => {return; }, + afterLoadData: () => {return; }, + afterMomentumScroll: () => {return; }, + afterOnCellCornerMouseDown: () => {return; }, + afterOnCellMouseDown: () => {return; }, + afterOnCellMouseOver: () => {return; }, + afterRemoveCol: () => {return; }, + afterRemoveRow: () => {return; }, + afterRender: () => {return; }, + afterRenderer: () => {return; }, + afterRowMove: () => {return; }, + afterRowResize: () => {return; }, + afterScrollHorizontally: () => {return; }, + afterScrollVertically: () => {return; }, + afterSelection: () => {return; }, + afterSelectionByProp: () => {return; }, + afterSelectionEnd: () => {return; }, + afterSelectionEndByProp: () => {return; }, + afterSetCellMeta: () => {return; }, + afterUpdateSettings: () => {return; }, + afterValidate: () => {return; }, + beforeAutofill: () => {return; }, + beforeCellAlignment: () => {return; }, + beforeChange: () => {return; }, + beforeChangeRender: () => {return; }, + beforeColumnMove: () => {return; }, + beforeColumnResize: () => {return; }, + beforeColumnSort: () => {return; }, + beforeDrawBorders: () => {return; }, + beforeFilter: () => {return; }, + beforeGetCellMeta: () => {return; }, + beforeInit: () => {return; }, + beforeInitWalkontable: () => {return; }, + beforeKeyDown: () => {return; }, + beforeOnCellMouseDown: () => {return; }, + beforeRemoveCol: () => {return; }, + beforeRemoveRow: () => {return; }, + beforeRender: () => {return; }, + beforeRenderer: () => {return; }, + beforeRowMove: () => {return; }, + beforeRowResize: () => {return; }, + beforeSetRangeEnd: () => {return; }, + beforeStretchingColumnWidth: () => {return; }, + beforeTouchScroll: () => {return; }, + beforeValidate: () => {return; }, + construct: () => {return; }, + init: () => {return; }, + modifyCol: () => {return; }, + modifyColHeader: () => {return; }, + modifyColWidth: () => {return; }, + modifyCopyableRange: () => {return; }, + modifyRow: () => {return; }, + modifyRowHeader: () => {return; }, + modifyRowHeight: () => {return; }, + persistentStateLoad: () => {return; }, + persistentStateReset: () => {return; }, + persistentStateSave: () => {return; }, + unmodifyCol: () => {return; } + }); + } + + function test_HandsontableMethods() { + const elem = document.createElement('div'); + const hot = new Handsontable(elem, {}); + hot.addHook('foo', []); + hot.addHookOnce('foo', []); + hot.alter('foo', 123, 123, 'foo', true); + hot.clear(); + hot.colOffset(); + hot.colToProp(123); + hot.countCols(); + hot.countEmptyCols(true); + hot.countEmptyRows(true); + hot.countRenderedCols(); + hot.countRenderedRows(); + hot.countRows(); + hot.countSourceRows(); + hot.countVisibleCols(); + hot.countVisibleRows(); + hot.deselectCell(); + hot.destroy(); + hot.destroyEditor(true); + hot.getActiveEditor(); + hot.getCell(123, 123, true); + hot.getCellEditor(123, 123); + hot.getCellMeta(123, 123); + hot.getCellRenderer(123, 123); + hot.getCellValidator(123, 123); + hot.getColHeader(123); + hot.getColWidth(123); + hot.getCoords(elem.querySelector('td')); + hot.getCopyableData(123, 123); + hot.getCopyableText(123, 123, 123, 123); + hot.getData(123, 123, 123, 123); + hot.getDataAtCell(123, 123); + hot.getDataAtCol(123); + hot.getDataAtProp(123); + hot.getDataAtRow(123); + hot.getDataAtRowProp(123, 'foo'); + hot.getDataType(123, 123, 123, 123); + hot.getInstance(); + hot.getPlugin('foo'); + hot.getRowHeader(123); + hot.getRowHeight(123); + hot.getSchema(); + hot.getSelected(); + const range: ht.Range = hot.getSelectedRange(); + hot.getSettings(); + hot.getSourceData(123, 123, 123, 123); + hot.getSourceDataAtCell(123, 123); + hot.getSourceDataAtCol(123); + hot.getSourceDataAtRow(123); + hot.getValue(); + hot.hasColHeaders(); + hot.hasHook('foo'); + hot.hasRowHeaders(); + hot.isEmptyCol(123); + hot.isEmptyRow(123); + hot.isListening(); + hot.listen(); + hot.loadData([]); + hot.populateFromArray(123, 123, [], 123, 123, 'foo', 'foo', 'foo', []); + hot.propToCol('foo'); + hot.propToCol(123); + hot.removeCellMeta(123, 123, 'foo'); + hot.removeHook('foo', () => {return; }); + hot.render(); + hot.rowOffset(); + hot.runHooks('foo', 123, 'foo', true, {}, [], () => {return; }); + hot.selectCell(123, 123, 123, 123, true, true); + hot.selectCellByProp(123, 'foo', 123, 'foo', true); + hot.setCellMeta(123, 123, 'foo', 'foo'); + hot.setCellMetaObject(123, 123, {}); + hot.setDataAtCell(123, 123, 'foo', 'foo'); + hot.setDataAtRowProp(123, 'foo', 'foo', 'foo'); + hot.spliceCol(123, 123, 123, 'foo'); + hot.spliceRow(123, 123, 123, 'foo'); + hot.toPhysicalRow(123); + hot.toPhysicalColumn(123); + hot.toVisualRow(123); + hot.toVisualColumn(123); + hot.unlisten(); + hot.updateSettings({}, true); + hot.validateCells(() => {return; }); + + Handsontable.renderers.NumericRenderer(hot, new HTMLTableDataCellElement(), 0, 0, "prop", 1.235, {}); + Handsontable.renderers.TextRenderer(hot, new HTMLTableDataCellElement(), 0, 0, "prop", 1.235, {}); + Handsontable.Dom.addEvent(new HTMLElement(), "eventName", () => { return; }); + } + + class MyCustomHotPlugin extends Handsontable.plugins.BasePlugin { + isEnabled(): boolean { + return !!this.hot.getSettings().manualRowMove; + } + } +} \ No newline at end of file diff --git a/types/handsontable/tsconfig.json b/types/handsontable/tsconfig.json index fd32d1d335..03348ea9b7 100644 --- a/types/handsontable/tsconfig.json +++ b/types/handsontable/tsconfig.json @@ -18,6 +18,7 @@ }, "files": [ "index.d.ts", - "handsontable-tests.ts" + "test/global.ts", + "test/module.ts" ] } \ No newline at end of file From efc8be0ec6c964fd8e17500dde3888b2c3f80bbe Mon Sep 17 00:00:00 2001 From: Denis Date: Thu, 30 Mar 2017 20:38:17 -0400 Subject: [PATCH 102/844] Fix linting --- types/leaflet.locatecontrol/index.d.ts | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/types/leaflet.locatecontrol/index.d.ts b/types/leaflet.locatecontrol/index.d.ts index 056e7b0d32..7692c2bb60 100644 --- a/types/leaflet.locatecontrol/index.d.ts +++ b/types/leaflet.locatecontrol/index.d.ts @@ -7,7 +7,6 @@ declare namespace L { namespace Control { - interface Locate extends L.Control {} interface LocateOptions { position?: string; layer?: L.Layer; @@ -35,11 +34,10 @@ declare namespace L { 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; } } From f2b6506ba550e909224e43ecd07e15bbfbfbfce3 Mon Sep 17 00:00:00 2001 From: Andy Date: Thu, 30 Mar 2017 17:42:07 -0700 Subject: [PATCH 103/844] Fix various lint errors (#15530) --- types/assert-plus/index.d.ts | 2 - types/awesomplete/awesomplete-tests.ts | 10 +- types/awesomplete/index.d.ts | 20 +- types/babel-code-frame/index.d.ts | 2 +- types/base-64/index.d.ts | 2 +- types/bignumber.js/bignumber.js-tests.ts | 18 +- types/bignumber.js/index.d.ts | 2 +- types/charm/charm-tests.ts | 3 +- types/core-js/index.d.ts | 306 +++++++++--------- types/html-webpack-plugin/index.d.ts | 2 +- types/js-md5/index.d.ts | 28 +- types/lodash/tslint.json | 8 +- types/massive/index.d.ts | 21 +- types/massive/massive-tests.ts | 2 +- types/navigo/index.d.ts | 10 +- types/navigo/navigo-tests.ts | 13 +- types/node-hid/node-hid-tests.ts | 9 +- types/phonon/phonon-tests.ts | 32 +- types/sparkpost/index.d.ts | 147 ++++----- types/sparkpost/sparkpost-tests.ts | 151 +++++---- types/sparkpost/tslint.json | 9 +- types/spatialite/index.d.ts | 1 - types/spatialite/spatialite-tests.ts | 15 +- types/stringify-object/index.d.ts | 2 +- types/strip-ansi/strip-ansi-tests.ts | 2 +- .../supertest-as-promised-tests.ts | 7 +- .../swagger-express-mw-tests.ts | 2 - types/swagger-hapi/swagger-hapi-tests.ts | 8 +- types/swagger-node-runner/index.d.ts | 41 ++- .../swagger-node-runner-tests.ts | 12 +- .../swagger-restify-mw-tests.ts | 2 - types/swagger-sails-hook/index.d.ts | 10 +- types/table/index.d.ts | 3 +- types/transducers-js/index.d.ts | 16 +- types/transducers-js/transducers-js-tests.ts | 9 +- types/update-notifier/index.d.ts | 2 +- .../update-notifier/update-notifier-tests.ts | 4 +- types/user-home/user-home-tests.ts | 2 +- types/verror/index.d.ts | 2 +- types/verror/verror-tests.ts | 21 +- types/videojs/index.d.ts | 1 - types/videojs/videojs-tests.ts | 27 +- types/vkbeautify/index.d.ts | 2 +- types/vkbeautify/vkbeautify-tests.ts | 3 +- types/web-animations-js/index.d.ts | 10 +- .../web-animations-js-tests.ts | 18 +- .../index.d.ts | 28 +- .../webappsec-credential-management-tests.ts | 4 +- types/webgl2/tslint.json | 3 + types/webpack/index.d.ts | 16 +- types/webpack/webpack-tests.ts | 20 +- 51 files changed, 517 insertions(+), 573 deletions(-) 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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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("..."); }); // From a086b92d64879e87e7162ca97e08e79d3d00ffa1 Mon Sep 17 00:00:00 2001 From: Wayne Dela Cruz Date: Fri, 31 Mar 2017 09:44:56 +0800 Subject: [PATCH 104/844] material-ui use TS 2.2 --- types/material-ui/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) 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 /// /// From a3b39389cd2ae5dda6bb0ccb3ffacfbbeb9fabf2 Mon Sep 17 00:00:00 2001 From: Wayne Dela Cruz Date: Fri, 31 Mar 2017 09:45:49 +0800 Subject: [PATCH 105/844] react use TS 2.2 --- types/react/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/react/index.d.ts b/types/react/index.d.ts index 62233663d9..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; From eaeb1cba08646bb26fc649067e0ad8588f6dca22 Mon Sep 17 00:00:00 2001 From: spacejack Date: Thu, 30 Mar 2017 21:48:47 -0400 Subject: [PATCH 106/844] Type signature fixes --- types/mithril/index.d.ts | 68 ++++++++++++++++----------------- types/mithril/stream/index.d.ts | 4 +- 2 files changed, 35 insertions(+), 37 deletions(-) diff --git a/types/mithril/index.d.ts b/types/mithril/index.d.ts index 069d162c76..655ed3a66c 100644 --- a/types/mithril/index.d.ts +++ b/types/mithril/index.d.ts @@ -1,13 +1,11 @@ // Type definitions for Mithril 1.1 -// Project: http://lhorie.github.io/mithril/ -// Definitions by: Leo Horie , Chris Bowdon , Mike Linkovich , AndrĂ¡s Parditka +// Project: https://mithril.js.org/ +// Definitions by: Mike Linkovich , AndrĂ¡s Parditka , Isiah Meadows // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.2 declare namespace Mithril { export interface Lifecycle { - /** Any property attached to the component object is copied for every instance of the component. This allows simple state initialization. */ - [propName: string]: any; /** The oninit hook is called before a vnode is touched by the virtual DOM engine. */ oninit?(this: State, vnode: Vnode): any; /** The oncreate hook is called after a DOM element is created and attached to the document. */ @@ -83,14 +81,12 @@ declare namespace Mithril { (element: Element, component: null): void; } - /** Creates an event handler which takes the value of the specified DOM element property and calls a function with it as the argument. */ - export type WithAttr = (name: string, callback: (value: any) => any, thisArg?: any) => (e: { currentTarget: any, [p: string]: any }) => void; - - /** Returns an object with key/value pairs parsed from a string of the form: ?a=1&b=2 */ - export type ParseQueryString = (queryString: string) => { [p: string]: any }; - - /** Turns the key/value pairs of an object into a string of the form: a=1&b=2 */ - export type BuildQueryString = (values: { [p: string]: any }) => string; + export interface WithAttr { + /** Creates an event handler which takes the value of the specified DOM element property and calls a function with it as the argument. */ + (name: string, callback: (value: any) => any): (e: { currentTarget: any, [p: string]: any }) => void; + /** Creates an event handler which takes the value of the specified DOM element property and calls a function with it as the argument. */ + (name: string, callback: (this: T, value: any) => any, thisArg: T): (e: { currentTarget: any, [p: string]: any }) => void; + } export interface RequestOptions { /** The HTTP method to use. */ @@ -108,7 +104,7 @@ declare namespace Mithril { /** Exposes the underlying XMLHttpRequest object for low-level configuration. */ config?(xhr: XMLHttpRequest): any; /** Headers to append to the request before sending it. */ - headers?: any; + headers?: { [key: string]: string }; /** A constructor to be applied to each object in the response. */ type?: new (o: any) => any; /** A serialization method to be applied to data. Defaults to JSON.stringify, or if options.data is an instance of FormData, defaults to the identity function. */ @@ -116,21 +112,16 @@ declare namespace Mithril { /** A deserialization method to be applied to the response. Defaults to a small wrapper around JSON.parse that returns null for empty responses. */ deserialize?(data: string): T; /** A hook to specify how the XMLHttpRequest response should be read. Useful for reading response headers and cookies. Defaults to a function that returns xhr.responseText */ - extract?(xhr: XMLHttpRequest, options: RequestOptions): T; + extract?(xhr: XMLHttpRequest, options: this): T; /** Force the use of the HTTP body section for data in GET requests when set to true, or the use of querystring for other HTTP methods when set to false. Defaults to false for GET requests and true for other methods. */ useBody?: boolean; /** If false, redraws mounted components upon completion of the request. If true, it does not. */ background?: boolean; } - export interface RequestOptionsAll extends RequestOptions { - /** The URL to send the request to. */ - url: string; - } - export interface Request { /** Makes an XHR request and returns a promise. */ - (options: RequestOptionsAll): Promise; + (options: RequestOptions & { url: string }): Promise; /** Makes an XHR request and returns a promise. */ (url: string, options?: RequestOptions): Promise; } @@ -148,14 +139,9 @@ declare namespace Mithril { background?: boolean; } - export interface JsonpOptionsAll extends JsonpOptions { - /** The URL to send the request to. */ - url: string; - } - export interface Jsonp { /** Makes a JSON-P request and returns a promise. */ - (options: JsonpOptionsAll): Promise; + (options: JsonpOptions & { url: string }): Promise; /** Makes a JSON-P request and returns a promise. */ (url: string, options?: JsonpOptions): Promise; } @@ -190,10 +176,10 @@ declare namespace Mithril { redraw: Redraw; request: Request; jsonp: Jsonp; - /** Parse a query string into an object. */ - parseQueryString: ParseQueryString; - /** Serialize an object into a query string. */ - buildQueryString: BuildQueryString; + /** Returns an object with key/value pairs parsed from a string of the form: ?a=1&b=2 */ + parseQueryString(queryString: string): { [p: string]: any }; + /** Turns the key/value pairs of an object into a string of the form: a=1&b=2 */ + buildQueryString(values: { [p: string]: any }): string; /** A string containing the semver value for the current Mithril release. */ version: string; } @@ -222,7 +208,7 @@ declare namespace Mithril { // In some lifecycle methods, Vnode will have a dom property // and possibly a domSize property. - export interface VnodeDOM extends Vnode { + export interface VnodeDOM> extends Vnode { /** Points to the element that corresponds to the vnode. */ dom: Element; /** This defines the number of DOM elements that the vnode represents (starting from the element referenced by the dom property). */ @@ -233,17 +219,31 @@ declare namespace Mithril { export interface CVnodeDOM extends VnodeDOM> { } - /** Components are a mechanism to encapsulate parts of a view to make code easier to organize and/or reuse. Any Javascript object that has a view method is a Mithril component. Components can be consumed via the m() utility. */ + /** Components are a mechanism to encapsulate parts of a view to make code easier to organize and/or reuse. Any Javascript object that has a view method can be used as a Mithril component. Components can be consumed via the m() utility. */ export interface Component> extends Lifecycle { /** Creates a view out of virtual elements. */ view(this: State, vnode: Vnode): Children | null | void; } + /** Components are a mechanism to encapsulate parts of a view to make code easier to organize and/or reuse. Any class that implements a view method can be used as a Mithril component. Components can be consumed via the m() utility. */ export interface ClassComponent extends Lifecycle> { - view(this: ClassComponent, vnode: CVnode): Children | null | void; + /** The oninit hook is called before a vnode is touched by the virtual DOM engine. */ + oninit?(vnode: Vnode): any; + /** The oncreate hook is called after a DOM element is created and attached to the document. */ + oncreate?(vnode: VnodeDOM): any; + /** The onbeforeupdate hook is called before a vnode is diffed in a update. */ + onbeforeremove?(vnode: VnodeDOM): Promise | void; + /** The onupdate hook is called after a DOM element is updated, while attached to the document. */ + onremove?(vnode: VnodeDOM): any; + /** The onbeforeremove hook is called before a DOM element is detached from the document. If a Promise is returned, Mithril only detaches the DOM element after the promise completes. */ + onbeforeupdate?(vnode: Vnode, old: VnodeDOM): boolean | void; + /** The onremove hook is called before a DOM element is removed from the document. */ + onupdate?(vnode: VnodeDOM): any; + /** Creates a view out of virtual elements. */ + view(vnode: CVnode): Children | null | void; } - // Factory component + /** Components are a mechanism to encapsulate parts of a view to make code easier to organize and/or reuse. Any function that returns an object with a view method can be used as a Mithril component. Components can be consumed via the m() utility. */ export type FactoryComponent = (vnode: Vnode) => Component /** Components are a mechanism to encapsulate parts of a view to make code easier to organize and/or reuse. Any Javascript object that has a view method is a Mithril component. Components can be consumed via the m() utility. */ diff --git a/types/mithril/stream/index.d.ts b/types/mithril/stream/index.d.ts index 7c5c1b3be0..4eb769e798 100644 --- a/types/mithril/stream/index.d.ts +++ b/types/mithril/stream/index.d.ts @@ -1,6 +1,4 @@ declare namespace Stream { - export type Combiner = (...streams: any[]) => T; - export interface Stream { /** Returns the value of the stream. */ (): T; @@ -26,7 +24,7 @@ declare namespace Stream { /** Creates a stream. */ (value?: T): Stream; /** Creates a computed stream that reactively updates if any of its upstreams are updated. */ - combine(combiner: Combiner, streams: Stream[]): Stream; + combine(combiner: (...streams: any[]) => T, streams: Stream[]): Stream; /** Creates a stream whose value is the array of values from an array of streams. */ merge(streams: Stream[]): Stream; /** Creates a new stream with the results of calling the function on every incoming stream with and accumulator and the incoming value. */ From c749c10a1ef85c77c7c1bb4180e2e950c3604416 Mon Sep 17 00:00:00 2001 From: spacejack Date: Thu, 30 Mar 2017 22:06:43 -0400 Subject: [PATCH 107/844] Updates for new tslint rules --- types/mithril/index.d.ts | 4 ++-- types/mithril/stream/index.d.ts | 2 +- types/mithril/tslint.json | 1 + 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/types/mithril/index.d.ts b/types/mithril/index.d.ts index 655ed3a66c..9e5a4897e5 100644 --- a/types/mithril/index.d.ts +++ b/types/mithril/index.d.ts @@ -51,7 +51,7 @@ declare namespace Mithril { export interface RouteOptions { /** Routing parameters. If path has routing parameter slots, the properties of this object are interpolated into the path string. */ replace?: boolean; - /** The state object to pass to the underlying history.pushState / history.replaceState call.*/ + /** The state object to pass to the underlying history.pushState / history.replaceState call. */ state?: any; /** The title string to pass to the underlying history.pushState / history.replaceState call. */ title?: string; @@ -251,7 +251,7 @@ declare namespace Mithril { export type ComponentTypes = Component | { new (vnode: CVnode): ClassComponent } | FactoryComponent - /** This represents the attributes available for configuring virtual elements, beyond the applicable DOM attributes.*/ + /** This represents the attributes available for configuring virtual elements, beyond the applicable DOM attributes. */ export interface Attributes extends Lifecycle { /** The class name(s) for this virtual element, as a space-separated list. */ className?: string; diff --git a/types/mithril/stream/index.d.ts b/types/mithril/stream/index.d.ts index 4eb769e798..e1850e7291 100644 --- a/types/mithril/stream/index.d.ts +++ b/types/mithril/stream/index.d.ts @@ -14,7 +14,7 @@ declare namespace Stream { ap(f: Stream<(value: T) => U>): Stream; /** A co-dependent stream that unregisters dependent streams when set to true. */ end: Stream; - /** When a stream is passed as the argument to JSON.stringify(), the value of the stream is serialized.*/ + /** When a stream is passed as the argument to JSON.stringify(), the value of the stream is serialized. */ toJSON(): string; /** Returns the value of the stream. */ valueOf(): T; diff --git a/types/mithril/tslint.json b/types/mithril/tslint.json index b3c768774e..250b1b7b5f 100644 --- a/types/mithril/tslint.json +++ b/types/mithril/tslint.json @@ -8,6 +8,7 @@ "max-line-length": [false, 200], "no-empty-interface": false, "no-redundant-modifiers": false, + "only-arrow-functions": [false], "prefer-for-of": false, "unified-signatures": false, "whitespace": [ From 9c0045fd41749c9080e52cd8b437ddc0bb1497a0 Mon Sep 17 00:00:00 2001 From: Andrey Kyrdyumov Date: Fri, 31 Mar 2017 09:30:21 +0600 Subject: [PATCH 108/844] Add support for loading daterangepicker using AMD --- types/daterangepicker/daterangepicker-tests.ts | 11 +++++++++++ types/daterangepicker/index.d.ts | 12 +++++++++++- 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/types/daterangepicker/daterangepicker-tests.ts b/types/daterangepicker/daterangepicker-tests.ts index 04ff80c0e8..24d372c09e 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; From 80a1bc1c9fd92685f56a68d3529aca0ae4206583 Mon Sep 17 00:00:00 2001 From: uglycoyote Date: Thu, 30 Mar 2017 22:40:29 -0700 Subject: [PATCH 109/844] Change return type of Paper.group() and Paper.g() to "Paper" Prior to this change, the return type of Paper.group() was specified as "any" which was not very helpful. In my code I was declaring the variable i was storing the group in as "Element" which seemed to make sense at first, but then I later realized that operations like myGroup.line (to add a line in the group) were resulting in type errors. The "group" type has a line method but the "Element" type does not. Looking in to the source code a bit more I found that groups are instantiated as Elements but then use the following code (in the Element construcor) to copy methods from the Paper prototype, which I believe makes the group type essentially equal to a "Paper": ``` if (this.type in {g: 1, mask: 1, pattern: 1, symbol: 1}) { for (var method in Paper.prototype) if (Paper.prototype[has](method)) { this[method] = Paper.prototype[method]; } } ``` I'm not exactly familiar with this syntax though; it's not clear to me what ```Paper.prototype[has](method)``` exactly means or whether this means that a group object only inherits a subset of the methods from Paper, and therefore there should be some other type in the Type Definition file which corresponds to groups, masks, patterns and symbols. Perhaps the Paper.mask and Paper.ptrn should be changed to return Paper as well? I'm not familiar with those so I didn't touch them in the type def file. --- types/snapsvg/index.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/types/snapsvg/index.d.ts b/types/snapsvg/index.d.ts index 50e0d14ac7..e724e7237d 100644 --- a/types/snapsvg/index.d.ts +++ b/types/snapsvg/index.d.ts @@ -306,8 +306,8 @@ declare namespace Snap { el(name:string, attr:Object):Snap.Element; filter(filstr:string):Snap.Element; gradient(gradient:string):any; - g(varargs?:any):any; - group(...els:any[]):any; + g(varargs?:any):Paper; + group(...els:any[]):Paper; mask(varargs:any):Object; ptrn(x:number,y:number,width:number,height:number,vbx:number,vby:number,vbw:number,vbh:number):Object; svg(x:number,y:number,width:number,height:number,vbx:number,vby:number,vbw:number,vbh:number):Object; From 073e443bf568c96f169118d0b497e253dd41c7a0 Mon Sep 17 00:00:00 2001 From: Markis Taylor Date: Thu, 30 Mar 2017 23:38:42 -0700 Subject: [PATCH 110/844] Add definitions for CSRF module --- types/csrf/csrf-tests.ts | 16 +++++++++++ types/csrf/index.d.ts | 62 ++++++++++++++++++++++++++++++++++++++++ types/csrf/tsconfig.json | 22 ++++++++++++++ types/csrf/tslint.json | 1 + 4 files changed, 101 insertions(+) create mode 100644 types/csrf/csrf-tests.ts create mode 100644 types/csrf/index.d.ts create mode 100644 types/csrf/tsconfig.json create mode 100644 types/csrf/tslint.json 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" } From 2d28b18a7fcf85e8f523b1742596b6767d7fab75 Mon Sep 17 00:00:00 2001 From: Andrey Kyrdyumov Date: Fri, 31 Mar 2017 16:36:01 +0600 Subject: [PATCH 111/844] Fix typo --- types/daterangepicker/daterangepicker-tests.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/daterangepicker/daterangepicker-tests.ts b/types/daterangepicker/daterangepicker-tests.ts index 24d372c09e..dc305bf1da 100644 --- a/types/daterangepicker/daterangepicker-tests.ts +++ b/types/daterangepicker/daterangepicker-tests.ts @@ -76,5 +76,5 @@ function tests_simple() { declare const host: HTMLElement; function test_from_amd() { var picker = new daterangepicker(host); - console.log(picker.startDate.format("YYYY-MM-DD");) + console.log(picker.startDate.format("YYYY-MM-DD")); } From f54704a9eb4e0a3e0b91c0e3180e59e13dcbbdd6 Mon Sep 17 00:00:00 2001 From: Federico Caselli Date: Fri, 31 Mar 2017 13:42:17 +0200 Subject: [PATCH 112/844] Added missing bson methods and removed duplication on mongodb --- types/bson/index.d.ts | 159 +++++++++++++++++++++++++++++++---- types/mongodb/index.d.ts | 174 ++------------------------------------- 2 files changed, 152 insertions(+), 181 deletions(-) diff --git a/types/bson/index.d.ts b/types/bson/index.d.ts index e34462b2b7..b1f622ad47 100644 --- a/types/bson/index.d.ts +++ b/types/bson/index.d.ts @@ -1,6 +1,7 @@ // Type definitions for bson 1.0 // Project: https://github.com/mongodb/js-bson // Definitions by: Hiroki Horiuchi +// Federico Caselli // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped /// @@ -37,6 +38,17 @@ export class Binary { static SUBTYPE_USER_DEFINED: number; constructor(buffer: Buffer, subType?: number); + + /** The length of the binary. */ + length(): number; + /** Updates this binary with byte_value */ + put(byte_value: number | string): void; + /** Reads length bytes starting at position. */ + read(position: number, length: number): Buffer; + /** Returns the value of this binary as a string. */ + value(): string; + /** Writes a buffer or string to the binary */ + write(buffer: Buffer | string, offset: number): void; } export class Code { constructor(code: string | Function, scope?: any); @@ -45,15 +57,55 @@ export class DBRef { constructor(namespace: string, oid: ObjectID, db?: string); } export class Double { - constructor (value: number); + constructor(value: number); + + valueOf(): number; } export class Long { + static MAX_VALUE: Long; + static MIN_VALUE: Long; + static NEG_ONE: Long; + static ONE: Long; + static ZERO: Long; + static fromInt(i: number): Long; static fromNumber(n: number): Long; static fromBits(lowBits: number, highBits: number): Long; static fromString(s: string, opt_radix?: number): Long; constructor(low: number, high: number); + + add(other: Long): Long; + and(other: Long): Long; + compare(other: Long): number; + div(other: Long): Long; + equals(other: Long): boolean; + getHighBits(): number; + getLowBits(): number; + getLowBitsUnsigned(): number; + getNumBitsAbs(): number; + greaterThan(other: Long): number; + greaterThanOrEqual(other: Long): number; + isNegative(): boolean; + isOdd(): boolean; + isZero(): boolean; + lessThan(other: Long): boolean; + lessThanOrEqual(other: Long): boolean; + modulo(other: Long): Long; + multiply(other: Long): Long; + negate(): Long; + not(): Long; + notEquals(other: Long): boolean; + or(other: Long): Long; + shiftLeft(other: number): Long; + shiftRight(other: number): Long; + shiftRightUnsigned(other: number): Long; + subtract(other: Long): Long; + toInt(): number; + toJSON(): string; + toNumber(): number; + toString(radix?: number): string; + xor(other: Long): Long; } export class MaxKey { constructor(); @@ -61,17 +113,56 @@ export class MaxKey { export class MinKey { constructor(); } -export class ObjectId { - static createPk(): ObjectId; - static createFromTime(time: number): ObjectId; - static createFromHexString(hexString: string): ObjectId; - static isValid(id: number | string | ObjectId): boolean; - - constructor(id?: number | string | ObjectId); - toHexString(): string; +export class ObjectID { + /** + * Create a new ObjectID instance + * @param {(string|number|ObjectID)} id Can be a 24 byte hex string, 12 byte binary string or a Number. + */ + constructor(id?: string | number | ObjectID); + /** The generation time of this ObjectID instance */ + generationTime: number; + /** + * Creates an ObjectID from a hex string representation of an ObjectID. + * @param {string} hexString create a ObjectID from a passed in 24 byte hexstring. + * @return {ObjectID} return the created ObjectID + */ + static createFromHexString(hexString: string): ObjectID; + /** + * Creates an ObjectID from a second based number, with the rest of the ObjectID zeroed out. Used for comparisons or sorting the ObjectID. + * @param {number} time an integer number representing a number of seconds. + * @return {ObjectID} return the created ObjectID + */ + static createFromTime(time: number): ObjectID; + /** + * Checks if a value is a valid bson ObjectID + * + * @return {boolean} return true if the value is a valid bson ObjectID, return false otherwise. + */ + static isValid(id: string | number | ObjectID): boolean; + /** + * Compares the equality of this ObjectID with `otherID`. + * @param {object} otherID ObjectID instance to compare against. + * @return {boolean} the result of comparing two ObjectID's + */ + equals(otherID: ObjectID): boolean; + /** + * Generate a 12 byte id string used in ObjectID's + * @param {number} time optional parameter allowing to pass in a second based timestamp. + * @return {string} return the 12 byte id binary string. + */ + generate(time?: number): string; + /** + * Returns the generation date (accurate up to the second) that this ID was generated. + * @return {date} the generation date + */ getTimestamp(): Date; + /** + * Return the ObjectID id as a 24 byte hex string representation + * @return {string} return the 24 byte hex string representation. + */ + toHexString(): string; } -export type ObjectID = ObjectId; +export { ObjectID as ObjectId }; export class BSONRegExp { constructor(pattern: string, options: string); } @@ -79,10 +170,48 @@ export class Symbol { constructor(value: string); } export class Timestamp { - static fromInt(i: number): Timestamp; - static fromNumber(n: number): Timestamp; - static fromBits(lowBits: number, highBits: number): Timestamp; - static fromString(s: string, opt_radix?: number): Timestamp; - constructor(low: number, high: number); + + static MAX_VALUE: Timestamp; + static MIN_VALUE: Timestamp; + static NEG_ONE: Timestamp; + static ONE: Timestamp; + static ZERO: Timestamp; + + static fromBits(lowBits: number, highBits: number): Timestamp; + static fromInt(value: number): Timestamp; + static fromNumber(value: number): Timestamp; + static fromString(str: string, radix?: number): Timestamp; + + add(other: Timestamp): Timestamp; + and(other: Timestamp): Timestamp; + compare(other: Timestamp): number; + div(other: Timestamp): Timestamp; + equals(other: Timestamp): boolean; + getHighBits(): number; + getLowBits(): number; + getLowBitsUnsigned(): number; + getNumBitsAbs(): number; + greaterThan(other: Timestamp): number; + greaterThanOrEqual(other: Timestamp): number; + isNegative(): boolean; + isOdd(): boolean; + isZero(): boolean; + lessThan(other: Timestamp): boolean; + lessThanOrEqual(other: Timestamp): boolean; + modulo(other: Timestamp): Timestamp; + multiply(other: Timestamp): Timestamp; + negate(): Timestamp; + not(): Timestamp; + notEquals(other: Timestamp): boolean; + or(other: Timestamp): Timestamp; + shiftLeft(other: number): Timestamp; + shiftRight(other: number): Timestamp; + shiftRightUnsigned(other: number): Timestamp; + subtract(other: Timestamp): Timestamp; + toInt(): number; + toJSON(): string; + toNumber(): number; + toString(radix?: number): string; + xor(other: Timestamp): Timestamp; } diff --git a/types/mongodb/index.d.ts b/types/mongodb/index.d.ts index c37bac86cd..e1837c04ed 100644 --- a/types/mongodb/index.d.ts +++ b/types/mongodb/index.d.ts @@ -6,10 +6,14 @@ // Documentation : http://mongodb.github.io/node-mongodb-native/2.1/api/ /// +/// -import {EventEmitter} from 'events'; +import { ObjectID } from 'bson'; +import { EventEmitter } from 'events'; import { Readable, Writable } from "stream"; +export { Binary, Double, Long, MaxKey, MinKey, ObjectID, Timestamp } from 'bson'; + // Class documentation : http://mongodb.github.io/node-mongodb-native/2.1/api/MongoClient.html export class MongoClient { constructor(); @@ -240,8 +244,6 @@ export class Db extends EventEmitter { stats(options: { scale?: number }, callback: MongoCallback): void; } - - // Deprecated http://mongodb.github.io/node-mongodb-native/2.1/api/Server.html export class Server extends EventEmitter { constructor(host: string, port: number, options?: ServerOptions); @@ -403,166 +405,6 @@ export interface FSyncOptions { fsync?: boolean } -// Class documentation : http://mongodb.github.io/node-mongodb-native/2.1/api/ObjectID.html -export class ObjectID { - constructor(s?: string | number); - - generationTime: number; - - // Creates an ObjectID from a hex string representation of an ObjectID. - // hexString – create a ObjectID from a passed in 24 byte hexstring. - static createFromHexString(hexString: string): ObjectID; - // Creates an ObjectID from a second based number, with the rest of the ObjectID zeroed out. Used for comparisons or sorting the ObjectID. - // time – an integer number representing a number of seconds. - static createFromTime(time: number): ObjectID; - // Checks if a value is a valid bson ObjectId - // id - Value to be checked - static isValid(id: any): boolean; - //Compares the equality of this ObjectID with otherID. - equals(otherID: ObjectID): boolean; - // Generate a 12 byte id string used in ObjectID's - // time - optional parameter allowing to pass in a second based timestamp - generate(time?: number): string; - // Returns the generation date (accurate up to the second) that this ID was generated. - getTimestamp(): Date; - // Returns the ObjectID id as a 24 byte hex string representation - toHexString(): string; - // Returns the ObjectID id as a 24 byte hex string representation - toString(): string; -} - -// Class documentation : http://mongodb.github.io/node-mongodb-native/2.1/api/Binary.html -export class Binary { - constructor(buffer: Buffer, subType?: number); - - static SUBTYPE_BYTE_ARRAY: number; - static SUBTYPE_DEFAULT: number; - static SUBTYPE_FUNCTION: number; - static SUBTYPE_MD5: number; - static SUBTYPE_USER_DEFINED: number; - static SUBTYPE_UUID: number; - static SUBTYPE_UUID_OLD: number; - - // The length of the binary. - length(): number; - // Updates this binary with byte_value - put(byte_value: number | string): void; - // Reads length bytes starting at position. - read(position: number, length: number): Buffer; - // Returns the value of this binary as a string. - value(): string; - // Writes a buffer or string to the binary - write(buffer: Buffer | string, offset: number): void; -} -//http://mongodb.github.io/node-mongodb-native/2.1/api/Double.html -export class Double { - constructor(value: number); - - valueOf(): number; -} - -//http://mongodb.github.io/node-mongodb-native/2.1/api/Long.html -export class Long { - constructor(low: number, high: number); - - static MAX_VALUE: Long; - static MIN_VALUE: Long; - static NEG_ONE: Long; - static ONE: Long; - static ZERO: Long; - - static fromBits(lowBits: number, highBits: number): Long; - static fromInt(value: number): Long; - static fromNumber(value: number): Long; - static fromString(str: string, radix?: number): Long; - - add(other: Long): Long; - and(other: Long): Long; - compare(other: Long): number; - div(other: Long): Long; - equals(other: Long): boolean; - getHighBits(): number; - getLowBits(): number; - getLowBitsUnsigned(): number; - getNumBitsAbs(): number; - greaterThan(other: Long): number; - greaterThanOrEqual(other: Long): number; - isNegative(): boolean; - isOdd(): boolean; - isZero(): boolean; - lessThan(other: Long): boolean; - lessThanOrEqual(other: Long): boolean; - modulo(other: Long): Long; - multiply(other: Long): Long; - negate(): Long; - not(): Long; - notEquals(other: Long): boolean; - or(other: Long): Long; - shiftLeft(other: number): Long; - shiftRight(other: number): Long; - shiftRightUnsigned(other: number): Long; - subtract(other: Long): Long; - toInt(): number; - toJSON(): string; - toNumber(): number; - toString(radix?: number): string; - xor(other: Long): Long; -} - -//http://mongodb.github.io/node-mongodb-native/2.1/api/MaxKey.html -export class MaxKey { } - -//http://mongodb.github.io/node-mongodb-native/2.1/api/MinKey.html -export class MinKey { } - -//http://mongodb.github.io/node-mongodb-native/2.1/api/Timestamp.html -export class Timestamp { - constructor(low: number, high: number); - - static MAX_VALUE: Timestamp; - static MIN_VALUE: Timestamp; - static NEG_ONE: Timestamp; - static ONE: Timestamp; - static ZERO: Timestamp; - - static fromBits(lowBits: number, highBits: number): Timestamp; - static fromInt(value: number): Timestamp; - static fromNumber(value: number): Timestamp; - static fromString(str: string, radix?: number): Timestamp; - - add(other: Timestamp): Timestamp; - and(other: Timestamp): Timestamp; - compare(other: Timestamp): number; - div(other: Timestamp): Timestamp; - equals(other: Timestamp): boolean; - getHighBits(): number; - getLowBits(): number; - getLowBitsUnsigned(): number; - getNumBitsAbs(): number; - greaterThan(other: Timestamp): number; - greaterThanOrEqual(other: Timestamp): number; - isNegative(): boolean; - isOdd(): boolean; - isZero(): boolean; - lessThan(other: Timestamp): boolean; - lessThanOrEqual(other: Timestamp): boolean; - modulo(other: Timestamp): Timestamp; - multiply(other: Timestamp): Timestamp; - negate(): Timestamp; - not(): Timestamp; - notEquals(other: Timestamp): boolean; - or(other: Timestamp): Timestamp; - shiftLeft(other: number): Timestamp; - shiftRight(other: number): Timestamp; - shiftRightUnsigned(other: number): Timestamp; - subtract(other: Timestamp): Timestamp; - toInt(): number; - toJSON(): string; - toNumber(): number; - toString(radix?: number): string; - xor(other: Timestamp): Timestamp; -} - // Documentation : http://mongodb.github.io/node-mongodb-native/2.1/api/Collection.html export interface Collection { // Get the collection name. @@ -983,7 +825,7 @@ export interface FindOperatorsOrdered { upsert(): FindOperatorsOrdered; } - //http://mongodb.github.io/node-mongodb-native/2.1/api/UnorderedBulkOperation.html +//http://mongodb.github.io/node-mongodb-native/2.1/api/UnorderedBulkOperation.html export interface UnorderedBulkOperation { //http://mongodb.github.io/node-mongodb-native/2.1/api/lib_bulk_unordered.js.html line 339 length: number; @@ -1371,8 +1213,8 @@ export interface GridFSBucketReadStreamOptions { } // https://mongodb.github.io/node-mongodb-native/2.1/api/GridFSBucketWriteStream.html -export class GridFSBucketWriteStream extends Writable{ - constructor(bucket: GridFSBucket, filename:string, options?: GridFSBucketWriteStreamOptions); +export class GridFSBucketWriteStream extends Writable { + constructor(bucket: GridFSBucket, filename: string, options?: GridFSBucketWriteStreamOptions); } // https://mongodb.github.io/node-mongodb-native/2.1/api/GridFSBucketWriteStream.html From 0e2ddee324dbaf5243ce6cfa8b43041295a99bca Mon Sep 17 00:00:00 2001 From: Jan Van Ryckeghem Date: Fri, 31 Mar 2017 14:30:15 +0200 Subject: [PATCH 113/844] All VisJS config options are optional. http://visjs.org/docs/timeline/#Configuration_Options --- types/vis/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/vis/index.d.ts b/types/vis/index.d.ts index e4f8fe0dfd..1167c6db6a 100644 --- a/types/vis/index.d.ts +++ b/types/vis/index.d.ts @@ -180,7 +180,7 @@ interface TimelineOptions { onRemoveGroup?(): void; // TODO order?(): void; // TODO orientation?: TimelineOptionsOrientationType; - rollingMode: boolean; + rollingMode?: boolean; selectable?: boolean; showCurrentTime?: boolean; showMajorLabels?: boolean; From 803c349a1b13417201c25a10ef9bcdaf93d1a1ae Mon Sep 17 00:00:00 2001 From: Jan Van Ryckeghem Date: Fri, 31 Mar 2017 14:36:19 +0200 Subject: [PATCH 114/844] increment version --- types/vis/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/vis/index.d.ts b/types/vis/index.d.ts index 1167c6db6a..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 From 2950b6bbe7fcb799bc7a4c9aceae6a125e54e95d Mon Sep 17 00:00:00 2001 From: Eric Anderson Date: Fri, 31 Mar 2017 09:00:17 -0400 Subject: [PATCH 115/844] Remove old warnings in react readme --- types/react/README.md | 26 -------------------------- 1 file changed, 26 deletions(-) diff --git a/types/react/README.md b/types/react/README.md index c09dc060c2..7fb8f8ef15 100644 --- a/types/react/README.md +++ b/types/react/README.md @@ -1,30 +1,4 @@ ## Known Problems & Workarounds - -### **The type of `setState` is will be overly strict prior to TS 2.1.5** -Starting with TypeScript 2.1, its more correct than it used to be, with a caveat: optional parameters on state interfaces are no longer valid. This issue is corrected in 2.1.5 (and beyond) and thus `Pick` becomes ideal. - -```ts -interface FooState { - bar: string; - foo?: string; -} - -const defaultFooState: FooState = { - bar: "Hi", - foo: undefined, -}; - -class Foo extends React.Component<{}, FooState> { - public doStuff() { - this.setState(defaultFooState); - } -} -``` - -Prior to 2.1.5, this code will produce an error. The other way the types could be written (using `Partial<>` instead of `Pick<>`) would allow for you to set `undefined` to a parameter that is not allowed -to be `undefined`, which could lead to bugs. Users who want to keep optional state parameters should continue to use the hack of `setState({...} as any);` in versions prior to 2.1.5. - -(This caveat should be dropped after no later than March 2017, maybe sooner.) ### **The type of `cloneElement` is incorrect.** This is similar to the `setState` problem, in that `cloneElement(element, props)` should should accept a `props` object with a subset of the properties on `element.props`. There is an additional complication, however—React attributes, such as `key` and `ref`, should also be accepted in `props`, but should not exist on `element.props`. The "correct" way to model this, then, is with From 68094fa835391c491d06fa9196991f069eff137e Mon Sep 17 00:00:00 2001 From: Eric Anderson Date: Fri, 31 Mar 2017 09:11:31 -0400 Subject: [PATCH 116/844] Add myself as an author for react --- types/react/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/react/index.d.ts b/types/react/index.d.ts index 73cb0ae16f..69aaef3319 100644 --- a/types/react/index.d.ts +++ b/types/react/index.d.ts @@ -1,6 +1,6 @@ // Type definitions for React v15.0 // Project: http://facebook.github.io/react/ -// Definitions by: Asana , AssureSign , Microsoft , John Reilly , Benoit Benezech , Patricio Zavolinsky , Digiguru +// Definitions by: Asana , AssureSign , Microsoft , John Reilly , Benoit Benezech , Patricio Zavolinsky , Digiguru , Eric Anderson // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.1 From 9b78e929f0657e635449cc34f2067c17a7ee40ba Mon Sep 17 00:00:00 2001 From: Flarna Date: Fri, 31 Mar 2017 15:22:35 +0200 Subject: [PATCH 117/844] Add reset() functions to sandbox. --- types/sinon/index.d.ts | 3 +++ types/sinon/sinon-tests.ts | 3 +++ 2 files changed, 6 insertions(+) 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..cf6e028c24 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.resetBehaviour(); } function testPromises() { From f16814539aa28e7355a1730ebd2da22506930c34 Mon Sep 17 00:00:00 2001 From: Flarna Date: Fri, 31 Mar 2017 15:33:01 +0200 Subject: [PATCH 118/844] correct a typo --- types/sinon/sinon-tests.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/sinon/sinon-tests.ts b/types/sinon/sinon-tests.ts index cf6e028c24..8354045a25 100644 --- a/types/sinon/sinon-tests.ts +++ b/types/sinon/sinon-tests.ts @@ -100,7 +100,7 @@ function testSandbox() { sandbox.restore(); sandbox.reset(); sandbox.resetHistory(); - sandbox.resetBehaviour(); + sandbox.resetBehavior(); } function testPromises() { From 64bf3f84569853cb3ed878fb59f427aab80b8015 Mon Sep 17 00:00:00 2001 From: Andy Date: Fri, 31 Mar 2017 08:14:27 -0700 Subject: [PATCH 119/844] Apply new lint rules to some more packages (#15546) --- types/enzyme/enzyme-tests.tsx | 37 +++++++-------- types/enzyme/index.d.ts | 6 +-- types/highcharts/highstock.d.ts | 6 +-- types/highcharts/index.d.ts | 46 +++++++++---------- types/highcharts/modules/map/index.d.ts | 4 +- types/highcharts/tslint.json | 1 - types/rc-slider/index.d.ts | 20 ++++---- types/rc-tree/index.d.ts | 11 ++--- types/rc-tree/rc-tree-tests.tsx | 2 - types/redux-auth-wrapper/index.d.ts | 10 ++-- .../redux-auth-wrapper-tests.tsx | 6 +-- types/redux-ui/index.d.ts | 2 +- types/redux-ui/redux-ui-tests.ts | 1 - 13 files changed, 72 insertions(+), 80 deletions(-) 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/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/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/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-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, }); - From 7e059afe0fc6567df343d178af52d52e00b923ed Mon Sep 17 00:00:00 2001 From: LaserUnicorns Date: Fri, 31 Mar 2017 19:45:48 +0300 Subject: [PATCH 120/844] Revert "[angular-material] updated resolve object typings in dialog, toast, etc" --- .../angular-material-tests.ts | 96 +++++++------------ types/angular-material/index.d.ts | 67 +++++++------ types/angular-material/tslint.json | 7 -- 3 files changed, 69 insertions(+), 101 deletions(-) delete mode 100644 types/angular-material/tslint.json diff --git a/types/angular-material/angular-material-tests.ts b/types/angular-material/angular-material-tests.ts index da898cfc13..f9195ec999 100644 --- a/types/angular-material/angular-material-tests.ts +++ b/types/angular-material/angular-material-tests.ts @@ -1,12 +1,15 @@ -const myApp = angular.module('testModule', ['ngMaterial']); + + +var myApp = angular.module('testModule', ['ngMaterial']); myApp.config(( $mdThemingProvider: ng.material.IThemingProvider, $mdIconProvider: ng.material.IIconProvider, $mdProgressCircularProvider: ng.material.IProgressCircularProvider) => { + $mdThemingProvider.alwaysWatchTheme(true); - const neonRedMap: ng.material.IPalette = $mdThemingProvider.extendPalette('red', { - 500: 'ff0000' + var neonRedMap: ng.material.IPalette = $mdThemingProvider.extendPalette('red', { + '500': 'ff0000' }); // Register the new color palette map with the name neonRed $mdThemingProvider.definePalette('neonRed', neonRedMap); @@ -18,10 +21,10 @@ myApp.config(( .warnPalette('red') .dark(true); - const browserColors: ng.material.IBrowserColors = { - theme: 'default', - palette: 'neonRed', - hue: '500' + var browserColors: ng.material.IBrowserColors = { + theme: 'default', + palette: 'neonRed', + hue: '500' }; $mdThemingProvider.enableBrowserColor(browserColors); @@ -42,19 +45,14 @@ myApp.config(( }); }); -myApp.controller('BottomSheetController', ($scope: ng.IScope, $mdBottomSheet: ng.material.IBottomSheetService, $q: ng.IQService) => { +myApp.controller('BottomSheetController', ($scope: ng.IScope, $mdBottomSheet: ng.material.IBottomSheetService) => { $scope['openBottomSheet'] = () => { $mdBottomSheet.show({ template: 'Hello!', clickOutsideToClose: true, disableBackdrop: true, disableParentScroll: false, - resolve: { - r1: () => $q.resolve(), - r2: () => Promise.resolve(), - r3: ['fakeService', (fake) => $q.resolve()], - r4: ['fakeService', (fake) => Promise.resolve()], - } + parent: () => {} }); }; $scope['hideBottomSheet'] = $mdBottomSheet.hide.bind($mdBottomSheet, 'hide'); @@ -62,10 +60,10 @@ myApp.controller('BottomSheetController', ($scope: ng.IScope, $mdBottomSheet: ng }); myApp.controller('ColorController', ($scope: ng.IScope, $mdColor: ng.material.IColorService) => { - let colorExpression: ng.material.IColorExpression; - let element: Element; + var colorExpression : ng.material.IColorExpression; + var element : Element; - colorExpression = { color: '#FFFFFF' }; + colorExpression = { color: '#FFFFFF' } element = new Element(); @@ -73,23 +71,17 @@ myApp.controller('ColorController', ($scope: ng.IScope, $mdColor: ng.material.IC $mdColor.applyThemeColors(element, colorExpression); }; $scope['getThemeColor'] = () => { - $mdColor.getThemeColor('default-neonRed'); + $mdColor.getThemeColor('default-neonRed') }; $scope['hasTheme'] = () => { $mdColor.hasTheme(); }; }); -myApp.controller('DialogController', ($scope: ng.IScope, $mdDialog: ng.material.IDialogService, $q: ng.IQService) => { +myApp.controller('DialogController', ($scope: ng.IScope, $mdDialog: ng.material.IDialogService) => { $scope['openDialog'] = () => { $mdDialog.show({ - template: 'Hello!', - resolve: { - r1: () => $q.resolve(), - r2: () => Promise.resolve(), - r3: ['fakeService', (fake) => $q.resolve()], - r4: ['fakeService', (fake) => Promise.resolve()], - } + template: 'Hello!' }); }; $scope['alertDialog'] = () => { @@ -117,12 +109,7 @@ myApp.controller('DialogController', ($scope: ng.IScope, $mdDialog: ng.material. $mdDialog.show($mdDialog.prompt().placeholder('Prompt input placeholder text')); }; $scope['promptDialog'] = () => { - $mdDialog.show($mdDialog.prompt().initialValue('Buddy').resolve({ - r1: () => $q.resolve(), - r2: () => Promise.resolve(), - r3: ['fakeService', (fake) => $q.resolve()], - r4: ['fakeService', (fake) => Promise.resolve()], - })); + $mdDialog.show($mdDialog.prompt().initialValue('Buddy')); }; $scope['prerenderedDialog'] = () => { $mdDialog.show({ @@ -136,12 +123,13 @@ myApp.controller('DialogController', ($scope: ng.IScope, $mdDialog: ng.material. }); class IconDirective implements ng.IDirective { + private $mdIcon: ng.material.IIcon; constructor($mdIcon: ng.material.IIcon) { this.$mdIcon = $mdIcon; } - link($scope: ng.IScope, $elm: ng.IAugmentedJQuery) { + public link($scope: ng.IScope, $elm: ng.IAugmentedJQuery) { this.$mdIcon('android').then((iconEl: Element) => $elm.append(iconEl)); this.$mdIcon('work:chair').then((iconEl: Element) => $elm.append(iconEl)); // Load and cache the external SVG using a URL @@ -162,7 +150,7 @@ myApp.controller('MediaController', ($scope: ng.IScope, $mdMedia: ng.material.IM }); myApp.controller('SidenavController', ($scope: ng.IScope, $mdSidenav: ng.material.ISidenavService) => { - const componentId = 'left'; + var componentId = 'left'; $scope['toggle'] = () => $mdSidenav(componentId).toggle(); $scope['open'] = () => $mdSidenav(componentId).open(); $scope['close'] = () => $mdSidenav(componentId).close(); @@ -177,53 +165,41 @@ myApp.controller('SidenavController', ($scope: ng.IScope, $mdSidenav: ng.materia instance.isLockedOpen(); }); - $scope['onClose'] = $mdSidenav(componentId).onClose(() => { }); + $scope['onClose'] = $mdSidenav(componentId).onClose(() => {}); }); -myApp.controller('ToastController', ($scope: ng.IScope, $mdToast: ng.material.IToastService, $q: ng.IQService) => { +myApp.controller('ToastController', ($scope: ng.IScope, $mdToast: ng.material.IToastService) => { $scope['openToast'] = () => { $mdToast.show($mdToast.simple().textContent('Hello!')); $mdToast.updateTextContent('New Content'); - }; + } $scope['customToast'] = () => { - const options: ng.material.IToastOptions = { + var options = { hideDelay: 3000, position: 'top right', - controller: 'ToastCtrl', - templateUrl: 'toast-template.html', - toastClass: 'my-class', - resolve: { - r1: () => $q.resolve(), - r2: () => Promise.resolve(), - r3: ['fakeService', (fake) => $q.resolve()], - r4: ['fakeService', (fake) => Promise.resolve()], - } + controller : 'ToastCtrl', + templateUrl : 'toast-template.html', + toastClass: 'my-class' }; $mdToast.show(options); - }; + } }); -myApp.controller('PanelController', ($scope: ng.IScope, $mdPanel: ng.material.IPanelService, $q: ng.IQService) => { +myApp.controller('PanelController', ($scope: ng.IScope, $mdPanel: ng.material.IPanelService) => { $scope['createPanel'] = () => { - const config: ng.material.IPanelConfig = { + var config = { id: 'myPanel', template: '

    Hello!

    ', hasBackdrop: true, disableParentScroll: true, - zIndex: 150, - resolve: { - r1: () => $q.resolve(), - r2: () => Promise.resolve(), - r3: ['fakeService', (fake) => $q.resolve()], - r4: ['fakeService', (fake) => Promise.resolve()], - } + zIndex: 150 }; - + $mdPanel.create(config); - let panelRef = $mdPanel.create(config); + var panelRef = $mdPanel.create(config); panelRef.open() .then((ref: ng.material.IPanelRef) => { ref.addClass('foo'); @@ -256,6 +232,6 @@ myApp.controller('PanelController', ($scope: ng.IScope, $mdPanel: ng.material.IP $scope['newPanelAnimation'] = () => { $mdPanel.newPanelAnimation().openFrom('.some-target'); - $mdPanel.newPanelAnimation().openFrom({ top: 0, left: 0 }); + $mdPanel.newPanelAnimation().openFrom({top: 0, left: 0}); }; }); diff --git a/types/angular-material/index.d.ts b/types/angular-material/index.d.ts index fff8a0a085..a8196269a4 100644 --- a/types/angular-material/index.d.ts +++ b/types/angular-material/index.d.ts @@ -9,25 +9,21 @@ declare var _: string; export = _; declare module 'angular' { - namespace material { - interface ResolveObject { - [index: string]: angular.Injectable<(...args: any[]) => PromiseLike>; - } - + export namespace material { interface IBottomSheetOptions { templateUrl?: string; template?: string; scope?: angular.IScope; // default: new child scope preserveScope?: boolean; // default: false - controller?: string | ((...args: any[]) => any); + controller?: string | Function; locals?: { [index: string]: any }; clickOutsideToClose?: boolean; bindToController?: boolean; // default: false disableBackdrop?: boolean; escapeToClose?: boolean; - resolve?: ResolveObject; + resolve?: { [index: string]: () => angular.IPromise }; controllerAs?: string; - parent?: string | Element | JQuery | ((scope: ng.IScope, element: JQuery, options: IBottomSheetOptions) => Element | JQuery); // default: root node + parent?: Function | string | Object; // default: root node disableParentScroll?: boolean; // default: true } @@ -53,16 +49,16 @@ declare module 'angular' { clickOutsideToClose(clickOutsideToClose?: boolean): T; // default: false escapeToClose(escapeToClose?: boolean): T; // default: true focusOnOpen(focusOnOpen?: boolean): T; // default: true - controller(controller?: string | ((...args: any[]) => any)): T; + controller(controller?: string | Function): T; locals(locals?: { [index: string]: any }): T; bindToController(bindToController?: boolean): T; // default: false - resolve(resolve?: ResolveObject): T; + resolve(resolve?: { [index: string]: () => angular.IPromise }): T; controllerAs(controllerAs?: string): T; parent(parent?: string | Element | JQuery): T; // default: root node + onComplete(onComplete?: Function): T; ariaLabel(ariaLabel: string): T; } - // tslint:disable-next-line no-empty-interface interface IAlertDialog extends IPresetDialog { } @@ -101,15 +97,15 @@ declare module 'angular' { clickOutsideToClose?: boolean; // default: false escapeToClose?: boolean; // default: true focusOnOpen?: boolean; // default: true - controller?: string | ((...args: any[]) => any); + controller?: string | Function; locals?: { [index: string]: any }; bindToController?: boolean; // default: false - resolve?: ResolveObject; + resolve?: { [index: string]: () => angular.IPromise } controllerAs?: string; parent?: string | Element | JQuery; // default: root node - onShowing?(scope: ng.IScope, element: JQuery): void; - onComplete?(scope: ng.IScope, element: JQuery): void; - onRemoving?(element: JQuery, action: ng.IPromise): void; + onShowing?: Function; + onComplete?: Function; + onRemoving?: Function; skipHide?: boolean; multiple?: boolean; fullscreen?: boolean; // default: false @@ -124,7 +120,9 @@ declare module 'angular' { cancel(response?: any): void; } - type IIcon = (id: string) => angular.IPromise; // id is a unique ID or URL + interface IIcon { + (id: string): angular.IPromise; // id is a unique ID or URL + } interface IIconProvider { icon(id: string, url: string, viewBoxSize?: number): IIconProvider; // viewBoxSize default: 24 @@ -134,7 +132,9 @@ declare module 'angular' { defaultFontSet(name: string): IIconProvider; } - type IMedia = (media: string) => boolean; + interface IMedia { + (media: string): boolean; + } interface ISidenavObject { toggle(): angular.IPromise; @@ -142,7 +142,7 @@ declare module 'angular' { close(): angular.IPromise; isOpen(): boolean; isLockedOpen(): boolean; - onClose(onClose: () => void): void; + onClose(onClose: Function): void; } interface ISidenavService { @@ -163,7 +163,6 @@ declare module 'angular' { toastClass(toastClass: string): T; } - // tslint:disable-next-line no-empty-interface interface ISimpleToastPreset extends IToastPreset { } @@ -176,10 +175,10 @@ declare module 'angular' { hideDelay?: number | false; // default (ms): 3000 position?: string; // any combination of 'bottom'/'left'/'top'/'right'/'fit'; default: 'bottom left' toastClass?: string; - controller?: string | ((...args: any[]) => any); + controller?: string | Function; locals?: { [index: string]: any }; bindToController?: boolean; // default: false - resolve?: ResolveObject; + resolve?: { [index: string]: () => angular.IPromise } controllerAs?: string; parent?: string | Element | JQuery; // default: root node } @@ -264,19 +263,19 @@ declare module 'angular' { interface IThemeConfig { disableTheming: boolean; - generateOnDemand: boolean; + generateOnDemand: boolean; nonce: string; defaultTheme: string; alwaysWatchTheme: boolean; - registeredStyles: string[]; + registeredStyles: Array; } interface IThemingProvider { alwaysWatchTheme(alwaysWatch: boolean): void; definePalette(name: string, palette: IPalette): IThemingProvider; - enableBrowserColor(browserColors: IBrowserColors): () => void; + enableBrowserColor(browserColors: IBrowserColors): Function; extendPalette(name: string, palette: IPalette): IPalette; - registerStyles(styles: string): void; + registerStyles(styles: String): void; setDefaultTheme(theme: string): void; setNonce(nonce: string): void; theme(name: string, inheritFrom?: string): ITheme; @@ -329,11 +328,11 @@ declare module 'angular' { id?: string; template?: string; templateUrl?: string; - controller?: string | ((...args: any[]) => any); + controller?: string | Function; controllerAs?: string; bindToController?: boolean; // default: true locals?: { [index: string]: any }; - resolve?: ResolveObject; + resolve?: { [index: string]: () => angular.IPromise } attachTo?: string | JQuery | Element; propagateContainerEvents?: boolean; panelClass?: string; @@ -347,10 +346,10 @@ declare module 'angular' { animation?: IPanelAnimation; hasBackdrop?: boolean; // default: false disableParentScroll?: boolean; // default: false - onDomAdded?(...args: any[]): void; - onOpenComplete?(...args: any[]): void; - onRemoving?(...args: any[]): void; - onDomRemoved?(...args: any[]): void; + onDomAdded?: Function; + onOpenComplete?: Function; + onRemoving?: Function; + onDomRemoved?: Function; origin?: string | JQuery | Element; onCloseSuccess?: ((panel: IPanelRef, closeReason: string) => any); } @@ -443,11 +442,11 @@ declare module 'angular' { progressSize?: number; strokeWidth?: number; duration?: number; - easeFn?(t: number, b: number, c: number, d: number): number; + easeFn?: Function; durationIndeterminate?: number; startIndeterminate?: number; endIndeterminate?: number; - easeFnIndeterminate?(t: number, b: number, c: number, d: number): number; + easeFnIndeterminate?: Function; } interface IProgressCircularProvider { diff --git a/types/angular-material/tslint.json b/types/angular-material/tslint.json deleted file mode 100644 index 5783b495dd..0000000000 --- a/types/angular-material/tslint.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "extends": "../tslint.json", - "rules": { - "interface-name": false, - "max-line-length": false - } -} From c0c9cd3d415b05d197feb47879f52ee4fa4ae6f1 Mon Sep 17 00:00:00 2001 From: uglycoyote Date: Fri, 31 Mar 2017 10:18:23 -0700 Subject: [PATCH 121/844] Changing Paper.g and Paper.group to return Snap.Paper rather than just Paper (failed Travis test) --- types/snapsvg/index.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/types/snapsvg/index.d.ts b/types/snapsvg/index.d.ts index e724e7237d..b58c938d74 100644 --- a/types/snapsvg/index.d.ts +++ b/types/snapsvg/index.d.ts @@ -306,8 +306,8 @@ declare namespace Snap { el(name:string, attr:Object):Snap.Element; filter(filstr:string):Snap.Element; gradient(gradient:string):any; - g(varargs?:any):Paper; - group(...els:any[]):Paper; + g(varargs?:any):Snap.Paper; + group(...els:any[]):Snap.Paper; mask(varargs:any):Object; ptrn(x:number,y:number,width:number,height:number,vbx:number,vby:number,vbw:number,vbh:number):Object; svg(x:number,y:number,width:number,height:number,vbx:number,vby:number,vbw:number,vbh:number):Object; From b6c343f2b39ea4f6a61ddd23abea390f455f4301 Mon Sep 17 00:00:00 2001 From: Andy Date: Fri, 31 Mar 2017 11:01:26 -0700 Subject: [PATCH 122/844] Apply new lint rules to yet more packages (#15548) * Apply new lint rules to yet more packages * Fix leaflet lint --- .../bittorrent-protocol-tests.ts | 2 +- types/bittorrent-protocol/index.d.ts | 18 +- types/body-parser/index.d.ts | 4 +- .../bootstrap.v3.datetimepicker-tests.ts | 2 +- types/bootstrap.v3.datetimepicker/index.d.ts | 296 ++++----- types/camelcase-keys/camelcase-keys-tests.ts | 6 +- types/chunked-dc/index.d.ts | 10 +- types/clipboard/index.d.ts | 6 +- types/code/code-tests.ts | 2 +- types/code/index.d.ts | 2 +- types/codependency/codependency-tests.ts | 17 +- types/codependency/index.d.ts | 4 +- types/coinstring/coinstring-tests.ts | 58 +- types/colors/index.d.ts | 72 +-- types/colors/safe.d.ts | 2 +- types/connect-ensure-login/index.d.ts | 88 +-- .../convert-source-map-tests.ts | 4 +- types/convert-source-map/index.d.ts | 7 +- types/csv-stringify/csv-stringify-tests.ts | 1 - types/csv-stringify/index.d.ts | 1 - types/currency-formatter/currencies.d.ts | 2 +- .../currency-formatter-tests.ts | 1 - types/decay/decay-tests.ts | 2 +- types/deepmerge/deepmerge-tests.ts | 2 +- types/deepmerge/index.d.ts | 4 +- types/detect-port/detect-port-tests.ts | 3 +- .../discontinuous-range-tests.ts | 2 +- types/discontinuous-range/index.d.ts | 3 +- types/dropkickjs/dropkickjs-tests.ts | 52 +- types/dropkickjs/index.d.ts | 10 +- types/duplexer2/duplexer2-tests.ts | 6 +- types/freeport/freeport-tests.ts | 4 +- types/geojson/geojson-tests.ts | 3 - types/geojson/index.d.ts | 229 ++++--- types/geolib/index.d.ts | 3 +- types/geopattern/geopattern-tests.ts | 2 +- types/gettext.js/gettext.js-tests.ts | 4 +- types/gettext.js/index.d.ts | 24 +- types/gsap/gsap-tests.ts | 2 +- types/handsontable/index.d.ts | 568 +++++++++--------- types/har-format/index.d.ts | 1 - types/hoek/hoek-tests.ts | 5 +- types/hoek/index.d.ts | 7 +- types/in-range/in-range-tests.ts | 2 +- types/is-archive/is-archive-tests.ts | 2 +- types/is-array/is-array-tests.ts | 2 +- types/is-binary-path/is-binary-path-tests.ts | 2 +- types/is-compressed/is-compressed-tests.ts | 2 +- types/is-path-cwd/index.d.ts | 2 +- types/is-path-cwd/is-path-cwd-tests.ts | 2 +- .../is-relative-url/is-relative-url-tests.ts | 2 +- types/is-root-path/is-root-path-tests.ts | 2 +- types/is-text-path/is-text-path-tests.ts | 2 +- types/is-windows/is-windows-tests.ts | 2 +- types/jump.js/index.d.ts | 2 +- types/keycloak-js/index.d.ts | 14 +- types/leaflet-draw/leaflet-draw-tests.ts | 12 +- types/leaflet-fullscreen/index.d.ts | 2 +- .../leaflet-fullscreen-tests.ts | 4 +- types/leaflet/index.d.ts | 10 +- types/loopback-boot/index.d.ts | 4 +- types/loopback-boot/loopback-boot-tests.ts | 2 +- types/lorem-ipsum/index.d.ts | 2 +- types/ltx/index.d.ts | 2 +- types/lz-string/index.d.ts | 100 +-- types/math3d/index.d.ts | 2 +- types/mem/index.d.ts | 2 +- types/memoizee/index.d.ts | 6 +- types/meteor-collection-hooks/index.d.ts | 12 +- .../meteor-collection-hooks-tests.ts | 2 +- types/msgpack-lite/index.d.ts | 42 +- types/msgpack-lite/msgpack-lite-tests.ts | 36 +- types/nanoscroller/index.d.ts | 138 ++--- types/openfin/index.d.ts | 152 +++-- types/openfin/v15/tslint.json | 9 +- types/openfin/v16/tslint.json | 16 +- .../path-is-absolute-tests.ts | 2 +- types/payment/payment-tests.ts | 8 +- types/pbf/pbf-tests.ts | 4 +- types/pikaday-time/index.d.ts | 10 +- types/pikaday-time/pikaday-time-tests.ts | 8 +- types/pixi.js/index.d.ts | 4 +- types/plotly.js/index.d.ts | 295 +++++---- types/plotly.js/plotly.js-tests.ts | 2 +- types/proj4/index.d.ts | 22 +- types/proj4/proj4-tests.ts | 2 +- types/pulltorefreshjs/index.d.ts | 111 ++-- .../pulltorefreshjs/pulltorefreshjs-tests.ts | 2 +- types/query-string/index.d.ts | 61 +- types/range-parser/index.d.ts | 8 +- types/raw-body/index.d.ts | 6 +- types/readline-sync/index.d.ts | 6 +- types/redux-action/redux-action-tests.ts | 1 - types/redux-actions/redux-actions-tests.ts | 4 +- .../redux-persist-transform-encrypt-tests.ts | 22 +- .../redux-persist-transform-filter-tests.ts | 14 +- types/restify-plugins/index.d.ts | 10 +- types/rx-core-binding/index.d.ts | 38 +- types/rx-core/index.d.ts | 12 +- types/rx-lite-async/index.d.ts | 8 +- types/rx-lite-backpressure/index.d.ts | 40 +- types/rx-lite-coincidence/index.d.ts | 34 +- types/rx-lite-time/index.d.ts | 4 +- types/rx-lite/index.d.ts | 204 +++---- types/safe-regex/safe-regex-tests.ts | 2 +- types/semantic-ui/index.d.ts | 238 ++++---- types/semver-diff/index.d.ts | 2 +- types/semver/semver-tests.ts | 41 +- types/serialize-javascript/index.d.ts | 6 +- types/sheetify/sheetify-tests.ts | 6 +- types/shipit-utils/shipit-utils-tests.ts | 6 +- types/shipit/index.d.ts | 16 +- types/simple-oauth2/simple-oauth2-tests.ts | 8 +- types/slug/slug-tests.ts | 4 +- 114 files changed, 1727 insertions(+), 1678 deletions(-) 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/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/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/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/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/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/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/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/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/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/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/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/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 ea57730f93..e4d1a7a8f1 100644 --- a/types/handsontable/index.d.ts +++ b/types/handsontable/index.d.ts @@ -4,292 +4,292 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped\ declare namespace ht { - interface Options { - allowEmpty?: boolean; - allowInsertColumn?: boolean; - allowInsertRow?: boolean; - allowInvalid?: boolean; - allowRemoveColumn?: boolean; - allowRemoveRow?: boolean; - autoColumnSize?: Object|boolean; - autoComplete?: any[]; - autoRowSize?: Object|boolean; - autoWrapCol?: boolean; - autoWrapRow?: boolean; - bindRowsWithHeaders?: boolean|string; - cell?: any[]; - cells?: Function; - checkedTemplate?: boolean|string; - className?: string|any[]; - colHeaders?: boolean|any[]|Function; - collapsibleColumns?: boolean|any[]; - columnHeaderHeight?: number|any[]; - columns?: any[]; - columnSorting?: boolean|Object; - columnSummary?: Object; - colWidths?: any[]|Function|number|string; - commentedCellClassName?: string; - comments?: boolean|any[]; - contextMenu?: boolean|any[]|Object; - contextMenuCopyPaste?: Object; - copyable?: boolean; - copyColsLimit?: number; - copyPaste?: boolean; - copyRowsLimit?: number; - correctFormat?: boolean; - currentColClassName?: string; - currentRowClassName?: string; - customBorders?: boolean|any[]; - data?: any[]|Function; - dataSchema?: Object; - dateFormat?: string; - debug?: boolean; - defaultDate?: string; - disableVisualSelection?: boolean|string|any[]; - dropdownMenu?: boolean|Object|any[]; - editor?: string|Function|boolean; - enterBeginsEditing?: boolean; - enterMoves?: Object|Function; - fillHandle?: boolean|string|Object; - filter?: boolean; - filteringCaseSensitive?: boolean; - filters?: boolean; - fixedColumnsLeft?: number; - fixedRowsBottom?: number; - fixedRowsTop?: number; - format?: string; - fragmentSelection?: boolean|string; - ganttChart?: Object; - headerTooltips?: boolean|Object; - height?: number|Function; - hiddenColumns?: boolean|Object; - hiddenRows?: boolean|Object; - invalidCellClassName?: string; - label?: Object; - language?: string; - manualColumnFreeze?: boolean; - manualColumnMove?: boolean|any[]; - manualColumnResize?: boolean|any[]; - manualRowMove?: boolean|any[]; - manualRowResize?: boolean|any[]; - maxCols?: number; - maxRows?: number; - mergeCells?: boolean|any[]; - minCols?: number; - minRows?: number; - minSpareCols?: number; - minSpareRows?: number; - multiSelect?: boolean; - nestedHeaders?: any[]; - noWordWrapClassName?: string; - observeChanges?: boolean; - observeDOMVisibility?: boolean; - outsideClickDeselects?: boolean; - pasteMode?: string; - persistentState?: boolean; - placeholder?: any; - placeholderCellClassName?: string; - preventOverflow?: string|boolean; - readOnly?: boolean; - readOnlyCellClassName?: string; - renderAllRows?: boolean; - renderer?: string|Function; - rowHeaders?: boolean|any[]|Function; - rowHeaderWidth?: number|any[]; - rowHeights?: any[]|Function|number|string; - search?: boolean; - selectOptions?: any[]; - skipColumnOnPaste?: boolean; - sortByRelevance?: boolean; - sortFunction?: Function; - sortIndicator?: boolean; - source?: any[]|Function; - startCols?: number; - startRows?: number; - stretchH?: string; - strict?: boolean; - tableClassName?: string|any[]; - tabMoves?: Object; - title?: string; - trimDropdown?: boolean; - trimWhitespace?: boolean; - type?: string; - uncheckedTemplate?: boolean|string; - undo?: boolean; - validator?: Function|RegExp; - viewportColumnRenderingOffset?: number|string; - viewportRowRenderingOffset?: number|string; - visibleRows?: number; - width?: number|Function; - wordWrap?: boolean; - isEmptyCol?(col: number): boolean; - isEmptyRow?(row: number): boolean; + interface Options { + allowEmpty?: boolean; + allowInsertColumn?: boolean; + allowInsertRow?: boolean; + allowInvalid?: boolean; + allowRemoveColumn?: boolean; + allowRemoveRow?: boolean; + autoColumnSize?: Object|boolean; + autoComplete?: any[]; + autoRowSize?: Object|boolean; + autoWrapCol?: boolean; + autoWrapRow?: boolean; + bindRowsWithHeaders?: boolean|string; + cell?: any[]; + cells?: Function; + checkedTemplate?: boolean|string; + className?: string|any[]; + colHeaders?: boolean|any[]|Function; + collapsibleColumns?: boolean|any[]; + columnHeaderHeight?: number|any[]; + columns?: any[]; + columnSorting?: boolean|Object; + columnSummary?: Object; + colWidths?: any[]|Function|number|string; + commentedCellClassName?: string; + comments?: boolean|any[]; + contextMenu?: boolean|any[]|Object; + contextMenuCopyPaste?: Object; + copyable?: boolean; + copyColsLimit?: number; + copyPaste?: boolean; + copyRowsLimit?: number; + correctFormat?: boolean; + currentColClassName?: string; + currentRowClassName?: string; + customBorders?: boolean|any[]; + data?: any[]|Function; + dataSchema?: Object; + dateFormat?: string; + debug?: boolean; + defaultDate?: string; + disableVisualSelection?: boolean|string|any[]; + dropdownMenu?: boolean|Object|any[]; + editor?: string|Function|boolean; + enterBeginsEditing?: boolean; + enterMoves?: Object|Function; + fillHandle?: boolean|string|Object; + filter?: boolean; + filteringCaseSensitive?: boolean; + filters?: boolean; + fixedColumnsLeft?: number; + fixedRowsBottom?: number; + fixedRowsTop?: number; + format?: string; + fragmentSelection?: boolean|string; + ganttChart?: Object; + headerTooltips?: boolean|Object; + height?: number|Function; + hiddenColumns?: boolean|Object; + hiddenRows?: boolean|Object; + invalidCellClassName?: string; + label?: Object; + language?: string; + manualColumnFreeze?: boolean; + manualColumnMove?: boolean|any[]; + manualColumnResize?: boolean|any[]; + manualRowMove?: boolean|any[]; + manualRowResize?: boolean|any[]; + maxCols?: number; + maxRows?: number; + mergeCells?: boolean|any[]; + minCols?: number; + minRows?: number; + minSpareCols?: number; + minSpareRows?: number; + multiSelect?: boolean; + nestedHeaders?: any[]; + noWordWrapClassName?: string; + observeChanges?: boolean; + observeDOMVisibility?: boolean; + outsideClickDeselects?: boolean; + pasteMode?: string; + persistentState?: boolean; + placeholder?: any; + placeholderCellClassName?: string; + preventOverflow?: string|boolean; + readOnly?: boolean; + readOnlyCellClassName?: string; + renderAllRows?: boolean; + renderer?: string|Function; + rowHeaders?: boolean|any[]|Function; + rowHeaderWidth?: number|any[]; + rowHeights?: any[]|Function|number|string; + search?: boolean; + selectOptions?: any[]; + skipColumnOnPaste?: boolean; + sortByRelevance?: boolean; + sortFunction?: Function; + sortIndicator?: boolean; + source?: any[]|Function; + startCols?: number; + startRows?: number; + stretchH?: string; + strict?: boolean; + tableClassName?: string|any[]; + tabMoves?: Object; + title?: string; + trimDropdown?: boolean; + trimWhitespace?: boolean; + type?: string; + uncheckedTemplate?: boolean|string; + undo?: boolean; + validator?: Function|RegExp; + viewportColumnRenderingOffset?: number|string; + viewportRowRenderingOffset?: number|string; + visibleRows?: number; + width?: number|Function; + wordWrap?: boolean; + isEmptyCol?(col: number): boolean; + isEmptyRow?(row: number): boolean; - // hooks - afterAutofillApplyValues?(startArea: any[], entireArea: any[]): void; - afterCellMetaReset?(): void; - afterChange?(changes: any[], source: string): void; - afterChangesObserved?(): void; - afterColumnMove?(startColumn: number, endColumn: number): void; - afterColumnResize?(currentColumn: number, newSize: number, isDoubleClick: boolean): void; - afterColumnSort?(column: number, order: boolean): void; - afterContextMenuDefaultOptions?(predefinedItems: any[]): void; - afterContextMenuHide?(context: Object): void; - afterContextMenuShow?(context: Object): void; - afterCopyLimit?(selectedRows: number, selectedColumnds: number, copyRowsLimit: number, copyColumnsLimit: number): void; - afterCreateCol?(index: number, amount: number): void; - afterCreateRow?(index: number, amount: number): void; - afterDeselect?(): void; - afterDestroy?(): void; - afterDocumentKeyDown?(event: Event): void; - afterFilter?(formulasStack: any[]): void; - afterGetCellMeta?(row: number, col: number, cellProperties: Object): void; - afterGetColHeader?(col: number, TH: Element): void; - afterGetColumnHeaderRenderers?(array: any[]): void; - afterGetRowHeader?(row: number, TH: Element): void; - afterGetRowHeaderRenderers?(array: any[]): void; - afterInit?(): void; - afterLoadData?(firstTime: boolean): void; - afterMomentumScroll?(): void; - afterOnCellCornerMouseDown?(event: Object): void; - afterOnCellMouseDown?(event: Object, coords: Object, TD: Element): void; - afterOnCellMouseOver?(event: Object, coords: Object, TD: Element): void; - afterRemoveCol?(index: number, amount: number): void; - afterRemoveRow?(index: number, amount: number): void; - afterRender?(isForced: boolean): void; - afterRenderer?(TD: Element, row: number, col: number, prop: string|number, value: string, cellProperties: Object): void; - afterRowMove?(startRow: number, endRow: number): void; - afterRowResize?(currentRow: number, newSize: number, isDoubleClick: boolean): void; - afterScrollHorizontally?(): void; - afterScrollVertically?(): void; - afterSelection?(r: number, c: number, r2: number, c2: number): void; - afterSelectionByProp?(r: number, p: string, r2: number, p2: string): void; - afterSelectionEnd?(r: number, c: number, r2: number, c2: number): void; - afterSelectionEndByProp?(r: number, p: string, r2: number, p2: string): void; - afterSetCellMeta?(row: number, col: number, key: string, value: any): void; - afterUpdateSettings?(): void; - afterValidate?(isValid: boolean, value: any, row: number, prop: string|number, source: string): void|boolean; - beforeAutofill?(start: Object, end: Object, data: any[]): void; - beforeCellAlignment?(stateBefore: any, range: any, type: string, alignmentClass: string): void; - beforeChange?(changes: any[], source: string): void; - beforeChangeRender?(changes: any[], source: string): void; - beforeColumnMove?(startColumn: number, endColumn: number): void; - beforeColumnResize?(currentColumn: number, newSize: number, isDoubleClick: boolean): void; - beforeColumnSort?(column: number, order: boolean): void; - beforeDrawBorders?(corners: any[], borderClassName: string): void; - beforeFilter?(formulasStack: any[]): void; - beforeGetCellMeta?(row: number, col: number, cellProperties: Object): void; - beforeInit?(): void; - beforeInitWalkontable?(walkontableConfig: Object): void; - beforeKeyDown?(event: Event): void; - beforeOnCellMouseDown?(event: Event, coords: Object, TD: Element): void; - beforeRemoveCol?(index: number, amount: number, logicalCols?: any[]): void; - beforeRemoveRow?(index: number, amount: number, logicalRows?: any[]): void; - beforeRender?(isForced: boolean): void; - beforeRenderer?(TD: Element, row: number, col: number, prop: string|number, value: string, cellProperties: Object): void; - beforeRowMove?(startRow: number, endRow: number): void; - beforeRowResize?(currentRow: number, newSize: number, isDoubleClick: boolean): any; - beforeSetRangeEnd?(coords: any[]): void; - beforeStretchingColumnWidth?(stretchedWidth: number, column: number): void; - beforeTouchScroll?(): void; - beforeValidate?(value: any, row: number, prop: string|number, source: string): void; - construct?(): void; - init?(): void; - modifyCol?(col: number): void; - modifyColHeader?(column: number): void; - modifyColWidth?(width: number, col: number): void; - modifyCopyableRange?(copyableRanges: any[]): void; - modifyRow?(row: number): void; - modifyRowHeader?(row: number): void; - modifyRowHeight?(height: number, row: number): void; - persistentStateLoad?(key: string, valuePlaceholder: Object): void; - persistentStateReset?(key: string): void; - persistentStateSave?(key: string, value: any): void; - unmodifyCol?(col: number): void; - } - interface Methods { - addHook(key: string, callback: Function|any[]): void; - addHookOnce(key: string, callback: Function|any[]): void; - alter(action: string, index: number, amount?: number, source?: string, keepEmptyRows?: boolean): void; - clear(): void; - colOffset(): number; - colToProp(col: number): string|number; - countCols(): number; - countEmptyCols(ending?: boolean): number; - countEmptyRows(ending?: boolean): number; - countRenderedCols(): number; - countRenderedRows(): number; - countRows(): number; - countSourceRows(): number; - countVisibleCols(): number; - countVisibleRows(): number; - deselectCell(): void; - destroy(): void; - destroyEditor(revertOriginal?: boolean): void; - getActiveEditor(): Object; - getCell(row: number, col: number, topmost?: boolean): Element; - getCellEditor(row: number, col: number): Object; - getCellMeta(row: number, col: number): Object; - getCellRenderer(row: number, col: number): Function; - getCellValidator(row: number, col: number): any; - getColHeader(col?: number): any[]|string; - getColWidth(col: number): number; - getCoords(elem: Element): Object; - getCopyableData(row: number, column: number): string; - getCopyableText(startRow: number, startCol: number, endRow: number, endCol: number): string; - getData(r?: number, c?: number, r2?: number, c2?: number): any[]; - getDataAtCell(row: number, col: number): any; - getDataAtCol(col: number): any[]; - getDataAtProp(prop: string|number): any[]; - getDataAtRow(row: number): any[]; - getDataAtRowProp(row: number, prop: string): any; - getDataType(rowFrom: number, columnFrom: number, rowTo: number, columnTo: number): string; - getInstance(): any; - getPlugin(pluginName: string): any; - getRowHeader(row?: number): any[]|string; - getRowHeight(row: number): number; - getSchema(): Object; - getSelected(): any[]; - getSelectedRange(): Range; - getSettings(): Options; - getSourceData(r?: number, c?: number, r2?: number, c2?: number): any[]; - getSourceDataAtCell(row: number, column: number): any; - getSourceDataAtCol(column: number): any[]; - getSourceDataAtRow(row: number): any[]|Object; - getValue(): any; - hasColHeaders(): boolean; - hasHook(key: string): boolean; - hasRowHeaders(): boolean; - isEmptyCol(col: number): boolean; - isEmptyRow(row: number): boolean; - isListening(): boolean; - listen(): void; - loadData(data: any[]): void; - populateFromArray(row: number, col: number, input: any[], endRow?: number, endCol?: number, source?: string, method?: string, direction?: string, deltas?: any[]): any; - propToCol(prop: string | number): number; - removeCellMeta(row: number, col: number, key: string): void; - removeHook(key: string, callback: Function): void; - render(): void; - rowOffset(): number; - runHooks(key: string, p1?: any, p2?: any, p3?: any, p4?: any, p5?: any, p6?: any): any; - selectCell(row: number, col: number, endRow?: number, endCol?: number, scrollToCell?: boolean, changeListener?: boolean): boolean; - selectCellByProp(row: number, prop: string, endRow?: number, endProp?: string, scrollToCell?: boolean): boolean; - setCellMeta(row: number, col: number, key: string, val: string): void; - setCellMetaObject(row: number, col: number, prop: Object): void; - setDataAtCell(row: number|any[], col: number, value: string, source?: string): void; - setDataAtRowProp(row: number|any[], prop: string, value: string, source?: string): void; - spliceCol(col: number, index: number, amount: number, elements?: any): void; - spliceRow(row: number, index: number, amount: number, elements?: any): void; - toPhysicalRow(row: number): number; - toPhysicalColumn(column: number): number; - toVisualRow(row: number): number; - toVisualColumn(column: number): number; - unlisten(): void; - updateSettings(settings: Object, init?: boolean): void; - validateCells(callback: Function): void; - } + // hooks + afterAutofillApplyValues?(startArea: any[], entireArea: any[]): void; + afterCellMetaReset?(): void; + afterChange?(changes: any[], source: string): void; + afterChangesObserved?(): void; + afterColumnMove?(startColumn: number, endColumn: number): void; + afterColumnResize?(currentColumn: number, newSize: number, isDoubleClick: boolean): void; + afterColumnSort?(column: number, order: boolean): void; + afterContextMenuDefaultOptions?(predefinedItems: any[]): void; + afterContextMenuHide?(context: Object): void; + afterContextMenuShow?(context: Object): void; + afterCopyLimit?(selectedRows: number, selectedColumnds: number, copyRowsLimit: number, copyColumnsLimit: number): void; + afterCreateCol?(index: number, amount: number): void; + afterCreateRow?(index: number, amount: number): void; + afterDeselect?(): void; + afterDestroy?(): void; + afterDocumentKeyDown?(event: Event): void; + afterFilter?(formulasStack: any[]): void; + afterGetCellMeta?(row: number, col: number, cellProperties: Object): void; + afterGetColHeader?(col: number, TH: Element): void; + afterGetColumnHeaderRenderers?(array: any[]): void; + afterGetRowHeader?(row: number, TH: Element): void; + afterGetRowHeaderRenderers?(array: any[]): void; + afterInit?(): void; + afterLoadData?(firstTime: boolean): void; + afterMomentumScroll?(): void; + afterOnCellCornerMouseDown?(event: Object): void; + afterOnCellMouseDown?(event: Object, coords: Object, TD: Element): void; + afterOnCellMouseOver?(event: Object, coords: Object, TD: Element): void; + afterRemoveCol?(index: number, amount: number): void; + afterRemoveRow?(index: number, amount: number): void; + afterRender?(isForced: boolean): void; + afterRenderer?(TD: Element, row: number, col: number, prop: string|number, value: string, cellProperties: Object): void; + afterRowMove?(startRow: number, endRow: number): void; + afterRowResize?(currentRow: number, newSize: number, isDoubleClick: boolean): void; + afterScrollHorizontally?(): void; + afterScrollVertically?(): void; + afterSelection?(r: number, c: number, r2: number, c2: number): void; + afterSelectionByProp?(r: number, p: string, r2: number, p2: string): void; + afterSelectionEnd?(r: number, c: number, r2: number, c2: number): void; + afterSelectionEndByProp?(r: number, p: string, r2: number, p2: string): void; + afterSetCellMeta?(row: number, col: number, key: string, value: any): void; + afterUpdateSettings?(): void; + afterValidate?(isValid: boolean, value: any, row: number, prop: string|number, source: string): void|boolean; + beforeAutofill?(start: Object, end: Object, data: any[]): void; + beforeCellAlignment?(stateBefore: any, range: any, type: string, alignmentClass: string): void; + beforeChange?(changes: any[], source: string): void; + beforeChangeRender?(changes: any[], source: string): void; + beforeColumnMove?(startColumn: number, endColumn: number): void; + beforeColumnResize?(currentColumn: number, newSize: number, isDoubleClick: boolean): void; + beforeColumnSort?(column: number, order: boolean): void; + beforeDrawBorders?(corners: any[], borderClassName: string): void; + beforeFilter?(formulasStack: any[]): void; + beforeGetCellMeta?(row: number, col: number, cellProperties: Object): void; + beforeInit?(): void; + beforeInitWalkontable?(walkontableConfig: Object): void; + beforeKeyDown?(event: Event): void; + beforeOnCellMouseDown?(event: Event, coords: Object, TD: Element): void; + beforeRemoveCol?(index: number, amount: number, logicalCols?: any[]): void; + beforeRemoveRow?(index: number, amount: number, logicalRows?: any[]): void; + beforeRender?(isForced: boolean): void; + beforeRenderer?(TD: Element, row: number, col: number, prop: string|number, value: string, cellProperties: Object): void; + beforeRowMove?(startRow: number, endRow: number): void; + beforeRowResize?(currentRow: number, newSize: number, isDoubleClick: boolean): any; + beforeSetRangeEnd?(coords: any[]): void; + beforeStretchingColumnWidth?(stretchedWidth: number, column: number): void; + beforeTouchScroll?(): void; + beforeValidate?(value: any, row: number, prop: string|number, source: string): void; + construct?(): void; + init?(): void; + modifyCol?(col: number): void; + modifyColHeader?(column: number): void; + modifyColWidth?(width: number, col: number): void; + modifyCopyableRange?(copyableRanges: any[]): void; + modifyRow?(row: number): void; + modifyRowHeader?(row: number): void; + modifyRowHeight?(height: number, row: number): void; + persistentStateLoad?(key: string, valuePlaceholder: Object): void; + persistentStateReset?(key: string): void; + persistentStateSave?(key: string, value: any): void; + unmodifyCol?(col: number): void; + } + interface Methods { + addHook(key: string, callback: Function|any[]): void; + addHookOnce(key: string, callback: Function|any[]): void; + alter(action: string, index: number, amount?: number, source?: string, keepEmptyRows?: boolean): void; + clear(): void; + colOffset(): number; + colToProp(col: number): string|number; + countCols(): number; + countEmptyCols(ending?: boolean): number; + countEmptyRows(ending?: boolean): number; + countRenderedCols(): number; + countRenderedRows(): number; + countRows(): number; + countSourceRows(): number; + countVisibleCols(): number; + countVisibleRows(): number; + deselectCell(): void; + destroy(): void; + destroyEditor(revertOriginal?: boolean): void; + getActiveEditor(): Object; + getCell(row: number, col: number, topmost?: boolean): Element; + getCellEditor(row: number, col: number): Object; + getCellMeta(row: number, col: number): Object; + getCellRenderer(row: number, col: number): Function; + getCellValidator(row: number, col: number): any; + getColHeader(col?: number): any[]|string; + getColWidth(col: number): number; + getCoords(elem: Element): Object; + getCopyableData(row: number, column: number): string; + getCopyableText(startRow: number, startCol: number, endRow: number, endCol: number): string; + getData(r?: number, c?: number, r2?: number, c2?: number): any[]; + getDataAtCell(row: number, col: number): any; + getDataAtCol(col: number): any[]; + getDataAtProp(prop: string|number): any[]; + getDataAtRow(row: number): any[]; + getDataAtRowProp(row: number, prop: string): any; + getDataType(rowFrom: number, columnFrom: number, rowTo: number, columnTo: number): string; + getInstance(): any; + getPlugin(pluginName: string): any; + getRowHeader(row?: number): any[]|string; + getRowHeight(row: number): number; + getSchema(): Object; + getSelected(): any[]; + getSelectedRange(): Range; + getSettings(): Options; + getSourceData(r?: number, c?: number, r2?: number, c2?: number): any[]; + getSourceDataAtCell(row: number, column: number): any; + getSourceDataAtCol(column: number): any[]; + getSourceDataAtRow(row: number): any[]|Object; + getValue(): any; + hasColHeaders(): boolean; + hasHook(key: string): boolean; + hasRowHeaders(): boolean; + isEmptyCol(col: number): boolean; + isEmptyRow(row: number): boolean; + isListening(): boolean; + listen(): void; + loadData(data: any[]): void; + populateFromArray(row: number, col: number, input: any[], endRow?: number, endCol?: number, source?: string, method?: string, direction?: string, deltas?: any[]): any; + propToCol(prop: string | number): number; + removeCellMeta(row: number, col: number, key: string): void; + removeHook(key: string, callback: Function): void; + render(): void; + rowOffset(): number; + runHooks(key: string, p1?: any, p2?: any, p3?: any, p4?: any, p5?: any, p6?: any): any; + selectCell(row: number, col: number, endRow?: number, endCol?: number, scrollToCell?: boolean, changeListener?: boolean): boolean; + selectCellByProp(row: number, prop: string, endRow?: number, endProp?: string, scrollToCell?: boolean): boolean; + setCellMeta(row: number, col: number, key: string, val: string): void; + setCellMetaObject(row: number, col: number, prop: Object): void; + setDataAtCell(row: number|any[], col: number, value: string, source?: string): void; + setDataAtRowProp(row: number|any[], prop: string, value: string, source?: string): void; + spliceCol(col: number, index: number, amount: number, elements?: any): void; + spliceRow(row: number, index: number, amount: number, elements?: any): void; + toPhysicalRow(row: number): number; + toPhysicalColumn(column: number): number; + toVisualRow(row: number): number; + toVisualColumn(column: number): number; + unlisten(): void; + updateSettings(settings: Object, init?: boolean): void; + validateCells(callback: Function): void; + } - interface Selection { + interface Selection { start: CellPosition; end: CellPosition; } 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/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/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/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-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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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-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/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/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/semantic-ui/index.d.ts b/types/semantic-ui/index.d.ts index bdfa5c2249..54c1abdb8f 100644 --- a/types/semantic-ui/index.d.ts +++ b/types/semantic-ui/index.d.ts @@ -1394,23 +1394,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 +1495,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 +1676,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 +1711,7 @@ declare namespace SemanticUI { * Templates used to generate dimmer content */ template?: { - dimmer?: () => JQuery; + dimmer?(): JQuery; }; /** * Class names used to attach style to state @@ -2078,39 +2078,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 +2406,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 +2483,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 +2599,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 +2747,7 @@ declare namespace SemanticUI { // region Callbacks - onHide?: (this: JQuery) => void; + onHide?(this: JQuery): void; // endregion @@ -2969,31 +2969,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 @@ -3184,23 +3184,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 +3360,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 +3575,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 +3769,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 +3966,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 +4153,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 @@ -4346,19 +4346,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 +4371,7 @@ declare namespace SemanticUI { /** * returns page title */ - determineTitle?: (tabArray: any[]) => string; + determineTitle?(tabArray: any[]): string; }; /** * Selectors used by module @@ -4515,19 +4515,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 +4736,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 @@ -5077,19 +5077,19 @@ 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 @@ -5279,43 +5279,43 @@ 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; + onBottomPassedReverse?(this: JQuery): void; // endregion @@ -5326,13 +5326,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 +5343,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 +5358,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/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/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/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 +}; From 866668b1ba5e9f9d34179daf708269a39aa273c7 Mon Sep 17 00:00:00 2001 From: Leonard Thieu Date: Fri, 31 Mar 2017 14:09:33 -0400 Subject: [PATCH 123/844] Added global settings and changes introduced in v2.2.8. --- types/semantic-ui/index.d.ts | 87 +++++++++++-- types/semantic-ui/semantic-ui-tests.ts | 169 +++++++++++++++++++------ 2 files changed, 208 insertions(+), 48 deletions(-) diff --git a/types/semantic-ui/index.d.ts b/types/semantic-ui/index.d.ts index bdfa5c2249..9de1310d2c 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?: Function): 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?: Function): 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?: Function): JQuery; /** * Hides results container */ - search(behavior: 'hide results'): JQuery; + search(behavior: 'hide results', callback?: Function): 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 @@ -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 @@ -3014,7 +3044,7 @@ declare namespace SemanticUI { /** * HTML content to display instead of preformatted title and content */ - html?: string; + html?: string | JQuery; // 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 @@ -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}\'' */ @@ -5093,6 +5133,23 @@ declare namespace SemanticUI { // endregion + // region Templates + + templates?: { + error?: (errors: string[]) => JQuery; + prompt?: (errors: string[]) => JQuery; + }; + + // endregion + + // region Rules + + rules?: { + [name: string]: Function; + }; + + // endregion + // region DOM Settings /** @@ -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 * @@ -5316,6 +5383,8 @@ declare namespace SemanticUI { * Element's bottom edge has not passed top of screen */ onBottomPassedReverse?: (this: JQuery) => void; + onOnScreen?: (this: JQuery) => void; + onOffScreen?: (this: JQuery) => void; // endregion diff --git a/types/semantic-ui/semantic-ui-tests.ts b/types/semantic-ui/semantic-ui-tests.ts index f116507459..b2bd35f905 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 = function (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(); From 8aab69b90a65f218ea09b89785e3a69913e3a6c7 Mon Sep 17 00:00:00 2001 From: Leonard Thieu Date: Fri, 31 Mar 2017 14:38:16 -0400 Subject: [PATCH 124/844] Fixed linting errors. --- types/semantic-ui/index.d.ts | 10 +++++----- types/semantic-ui/semantic-ui-tests.ts | 2 +- types/semantic-ui/tslint.json | 3 ++- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/types/semantic-ui/index.d.ts b/types/semantic-ui/index.d.ts index 9de1310d2c..c6c397393c 100644 --- a/types/semantic-ui/index.d.ts +++ b/types/semantic-ui/index.d.ts @@ -742,7 +742,7 @@ interface JQuery { /** * Search for value currently set in search input */ - search(behavior: 'query', callback?: Function): JQuery; + search(behavior: 'query', callback?: () => void): JQuery; /** * Displays message in search results with text, using template matching type */ @@ -762,7 +762,7 @@ interface JQuery { /** * Search remote endpoint for specified query and display results */ - search(behavior: 'search remote', query: string, callback?: Function): JQuery; + search(behavior: 'search remote', query: string, callback?: () => void): JQuery; /** * Search object for specified query and return results */ @@ -814,11 +814,11 @@ interface JQuery { /** * Shows results container */ - search(behavior: 'show results', callback?: Function): JQuery; + search(behavior: 'show results', callback?: () => void): JQuery; /** * Hides results container */ - search(behavior: 'hide results', callback?: Function): JQuery; + search(behavior: 'hide results', callback?: () => void): JQuery; /** * Generates results using parser specified by settings.template */ @@ -5145,7 +5145,7 @@ declare namespace SemanticUI { // region Rules rules?: { - [name: string]: Function; + [name: string]: (...args: any[]) => boolean; }; // endregion diff --git a/types/semantic-ui/semantic-ui-tests.ts b/types/semantic-ui/semantic-ui-tests.ts index b2bd35f905..ad71c0fe92 100644 --- a/types/semantic-ui/semantic-ui-tests.ts +++ b/types/semantic-ui/semantic-ui-tests.ts @@ -184,7 +184,7 @@ function test_form_specifyingValidationRules() { function test_form_addCustomRule() { const user = { adminLevel: 1 }; - $.fn.form.settings.rules.adminLevel = function (value: any, adminLevel: number) { + $.fn.form.settings.rules.adminLevel = (value: any, adminLevel: number) => { return (user.adminLevel >= adminLevel); }; $('.ui.form').form({ 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 } } From 261cc568816ed920c57ee598897ace33663c7379 Mon Sep 17 00:00:00 2001 From: Ryan Riley Date: Fri, 31 Mar 2017 14:14:26 -0500 Subject: [PATCH 125/844] Use class declaration and fix type resolution in tests --- types/handsontable/index.d.ts | 106 ++++++++++++++++++++++++++---- types/handsontable/test/global.ts | 2 +- types/handsontable/test/module.ts | 2 +- 3 files changed, 96 insertions(+), 14 deletions(-) diff --git a/types/handsontable/index.d.ts b/types/handsontable/index.d.ts index 06ee9ffb60..39b81d1f8d 100644 --- a/types/handsontable/index.d.ts +++ b/types/handsontable/index.d.ts @@ -493,17 +493,99 @@ declare namespace Handsontable { type DropdownColumn = AutocompleteColumn; } -interface Handsontable { - new (element: Element, options: Handsontable.Options): Handsontable.Methods; - plugins: Handsontable.Plugins; - hooks: Handsontable.Hooks; - Dom: Handsontable.Dom; - dom: Handsontable.Dom; - helper: Handsontable.Helper; - utils: Handsontable.Utils; - renderers: Handsontable.Renderers; - editors: Handsontable.Editors; +declare class Handsontable implements Handsontable.Methods { + constructor (element: Element, options: Handsontable.Options); + static plugins: Handsontable.Plugins; + static hooks: Handsontable.Hooks; + static Dom: Handsontable.Dom; + static dom: Handsontable.Dom; + static helper: Handsontable.Helper; + static utils: Handsontable.Utils; + static renderers: Handsontable.Renderers; + static editors: Handsontable.Editors; + addHook(key: string, callback: Function|any[]): void; + addHookOnce(key: string, callback: Function|any[]): void; + alter(action: string, index: number, amount?: number, source?: string, keepEmptyRows?: boolean): void; + clear(): void; + colOffset(): number; + colToProp(col: number): string|number; + countCols(): number; + countEmptyCols(ending?: boolean): number; + countEmptyRows(ending?: boolean): number; + countRenderedCols(): number; + countRenderedRows(): number; + countRows(): number; + countSourceRows(): number; + countVisibleCols(): number; + countVisibleRows(): number; + deselectCell(): void; + destroy(): void; + destroyEditor(revertOriginal?: boolean): void; + getActiveEditor(): Object; + getCell(row: number, col: number, topmost?: boolean): Element; + getCellEditor(row: number, col: number): Object; + getCellMeta(row: number, col: number): Object; + getCellRenderer(row: number, col: number): Function; + getCellValidator(row: number, col: number): any; + getColHeader(col?: number): any[]|string; + getColWidth(col: number): number; + getCoords(elem: Element): Object; + getCopyableData(row: number, column: number): string; + getCopyableText(startRow: number, startCol: number, endRow: number, endCol: number): string; + getData(r?: number, c?: number, r2?: number, c2?: number): any[]; + getDataAtCell(row: number, col: number): any; + getDataAtCol(col: number): any[]; + getDataAtProp(prop: string|number): any[]; + getDataAtRow(row: number): any[]; + getDataAtRowProp(row: number, prop: string): any; + getDataType(rowFrom: number, columnFrom: number, rowTo: number, columnTo: number): string; + getInstance(): any; + getPlugin(pluginName: string): any; + getRowHeader(row?: number): any[]|string; + getRowHeight(row: number): number; + getSchema(): Object; + getSelected(): any[]; + getSelectedRange(): Handsontable.Range; + getSettings(): Handsontable.Options; + getSourceData(r?: number, c?: number, r2?: number, c2?: number): any[]; + getSourceDataAtCell(row: number, column: number): any; + getSourceDataAtCol(column: number): any[]; + getSourceDataAtRow(row: number): any[]|Object; + getValue(): any; + hasColHeaders(): boolean; + hasHook(key: string): boolean; + hasRowHeaders(): boolean; + isEmptyCol(col: number): boolean; + isEmptyRow(row: number): boolean; + isListening(): boolean; + listen(): void; + loadData(data: any[]): void; + populateFromArray(row: number, col: number, input: any[], endRow?: number, endCol?: number, source?: string, method?: string, direction?: string, deltas?: any[]): any; + propToCol(prop: string | number): number; + removeCellMeta(row: number, col: number, key: string): void; + removeHook(key: string, callback: Function): void; + render(): void; + rowOffset(): number; + runHooks(key: string, p1?: any, p2?: any, p3?: any, p4?: any, p5?: any, p6?: any): any; + selectCell(row: number, col: number, endRow?: number, endCol?: number, scrollToCell?: boolean, changeListener?: boolean): boolean; + selectCellByProp(row: number, prop: string, endRow?: number, endProp?: string, scrollToCell?: boolean): boolean; + setCellMeta(row: number, col: number, key: string, val: string): void; + setCellMetaObject(row: number, col: number, prop: Object): void; + setDataAtCell(row: number|any[], col: number, value: string, source?: string): void; + setDataAtRowProp(row: number|any[], prop: string, value: string, source?: string): void; + spliceCol(col: number, index: number, amount: number, elements?: any): void; + spliceRow(row: number, index: number, amount: number, elements?: any): void; + toPhysicalRow(row: number): number; + toPhysicalColumn(column: number): number; + toVisualRow(row: number): number; + toVisualColumn(column: number): number; + unlisten(): void; + updateSettings(settings: Object, init?: boolean): void; + validateCells(callback: Function): void; } -export = Handsontable; -export as namespace Handsontable; +declare module "handsontable" { + export = Handsontable; +} +//export = Handsontable; +//export as namespace Handsontable; diff --git a/types/handsontable/test/global.ts b/types/handsontable/test/global.ts index 44dae84026..fb40f1d00d 100644 --- a/types/handsontable/test/global.ts +++ b/types/handsontable/test/global.ts @@ -249,7 +249,7 @@ namespace HandsontableGlobalTest { hot.getRowHeight(123); hot.getSchema(); hot.getSelected(); - const range: ht.Range = hot.getSelectedRange(); + const range: Handsontable.Range = hot.getSelectedRange(); hot.getSettings(); hot.getSourceData(123, 123, 123, 123); hot.getSourceDataAtCell(123, 123); diff --git a/types/handsontable/test/module.ts b/types/handsontable/test/module.ts index 3f3e3a4c40..343337b5f0 100644 --- a/types/handsontable/test/module.ts +++ b/types/handsontable/test/module.ts @@ -249,7 +249,7 @@ namespace HandsOnTableModuleTest { hot.getRowHeight(123); hot.getSchema(); hot.getSelected(); - const range: ht.Range = hot.getSelectedRange(); + const range: Handsontable.Range = hot.getSelectedRange(); hot.getSettings(); hot.getSourceData(123, 123, 123, 123); hot.getSourceDataAtCell(123, 123); From 5d6a823493251c364ddf96f811608be3d760346c Mon Sep 17 00:00:00 2001 From: Troy Weber Date: Fri, 31 Mar 2017 12:18:25 -0700 Subject: [PATCH 126/844] bring serialport up to speed --- types/serialport/index.d.ts | 146 +++++++++++++++------------ types/serialport/serialport-tests.ts | 55 +++++++--- types/serialport/tsconfig.json | 2 +- types/serialport/tslint.json | 1 + 4 files changed, 125 insertions(+), 79 deletions(-) create mode 100644 types/serialport/tslint.json diff --git a/types/serialport/index.d.ts b/types/serialport/index.d.ts index 3c16de3a35..ba632b7322 100644 --- a/types/serialport/index.d.ts +++ b/types/serialport/index.d.ts @@ -3,71 +3,87 @@ // Definitions by: Jeremy Foster // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -declare module 'serialport' { - class SerialPort { - //openImmediately already removed in 4.0.7 - constructor(path: string, options?: SerialPort.options|((err: any) => void), callback?: (err: any) => void) - isOpen(): boolean; - on(event: string, callback?: (data?: any) => void): void; - open(callback?: (err: any) => void): void; - write(buffer: any, callback?: (err: any, bytesWritten: number) => void): void - pause(): void; - resume(): void; - disconnected(err: Error): void; - close(callback?: (err: any) => void): void; - flush(callback?: (err: any) => void): void; - set(options: SerialPort.setOptions, callback: (err: any) => void): void; - drain(callback?: (err: any) => void): void; - update(options: SerialPort.updateOptions, callback?: (err: any) => void): void; - static list(callback: (err: any, ports: SerialPort.portConfig[]) => void): void; - static parsers: { - readline: (delimiter: string) => void, - raw: (emitter: any, buffer: string) => void - }; - } +/// +/// - namespace SerialPort { - interface portConfig { - comName: string; - manufacturer: string; - serialNumber: string; - pnpId: string; - locationId: string; - vendorId: string; - productId: string; - } +export = SerialPort; - interface setOptions { - brk?: boolean; - cts?: boolean; - dsr?: boolean; - dtr?: boolean; - rts?: boolean; - } - - interface updateOptions { - baudRate?: number; - } - - // https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/4.0.7/README.md#user-content-serialport-path-options-opencallback - interface options { - autoOpen?: boolean, - lock?: boolean, - baudRate?: 115200|57600|38400|19200|9600|4800|2400|1800|1200|600|300|200|150|134|110|75|50|number, - dataBits?: 8|7|6|5, - stopBits?: 1|2, - parity?: 'none'|'even'|'mark'|'odd'|'space', - rtscts?: boolean, - xon?: boolean, - xoff?: boolean, - bufferSize?: number, - parser?: any, - platformOptions?: { - vmin?: number, - vtime?: number - } - } - } - - export = SerialPort; +declare class SerialPort extends Stream { + // openImmediately already removed in 4.0.7 + constructor(path: string, options?: SerialPort.options|SerialPort.callback, callback?: SerialPort.callback); + isOpen(): boolean; + on(event: string, callback?: (data?: any) => void): void; + open(callback?: SerialPort.callback): void; + write(buffer: any, callback?: (err: any, bytesWritten: number) => void): void; + pause(): void; + resume(): void; + disconnected(err: Error): void; + close(callback?: SerialPort.callback): void; + flush(callback?: SerialPort.callback): void; + set(options: SerialPort.setOptions, callback: SerialPort.callback): void; + drain(callback?: SerialPort.callback): void; + update(options: SerialPort.updateOptions, callback?: SerialPort.callback): void; + static list(callback: (err: any, ports: SerialPort.portConfig[]) => void): void; + // https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/4.0.7/lib/parsers.js + static parsers: SerialPort.parsers; +} + +declare namespace SerialPort { + interface portConfig { + comName: string; + manufacturer: string; + serialNumber: string; + pnpId: string; + locationId: string; + vendorId: string; + productId: string; + } + + interface setOptions { + brk?: boolean; + cts?: boolean; + dsr?: boolean; + dtr?: boolean; + rts?: boolean; + } + + interface updateOptions { + baudRate?: number; + } + + type serialParser = (emitter: NodeJS.EventEmitter, buffer: Buffer|string) => void; + + type readlineParser = (delimiter: string, encoding?: 'ascii'|'utf8'|'utf16le'|'ucs2'|'base64'|'binary'|'hex') => serialParser; + + type byteLengthParser = (delimiter: number) => serialParser; + + type byteDelimiterParser = (delimiter: number[]) => serialParser; + + type callback = (error: any) => void; + + interface parsers { + raw: serialParser; + readline: readlineParser; + byteLength: byteLengthParser; + byteDelimiter: byteDelimiterParser; + } + + // https://github.com/EmergingTechnologyAdvisors/node-serialport/blob/4.0.7/README.md#user-content-serialport-path-options-opencallback + interface options { + autoOpen?: boolean; + lock?: boolean; + baudRate?: 115200|57600|38400|19200|9600|4800|2400|1800|1200|600|300|200|150|134|110|75|50|number; + dataBits?: 8|7|6|5; + stopBits?: 1|2; + parity?: 'none'|'even'|'mark'|'odd'|'space'; + rtscts?: boolean; + xon?: boolean; + xoff?: boolean; + bufferSize?: number; + parser?: serialParser; + platformOptions?: { + vmin?: number; + vtime?: number; + }; + } } diff --git a/types/serialport/serialport-tests.ts b/types/serialport/serialport-tests.ts index 3e799f2ee1..58d39cb1d6 100644 --- a/types/serialport/serialport-tests.ts +++ b/types/serialport/serialport-tests.ts @@ -7,29 +7,58 @@ import * as SerialPort from 'serialport'; function test_basic_connect() { - let port = new SerialPort(""); + let port = new SerialPort(''); } function test_connect_config() { - let port = new SerialPort("", { - baudRate: 0, - parser: SerialPort.parsers.readline("\n") - }, function(err:any) { }); + let port1 = new SerialPort('', { + baudRate: 0, + parser: SerialPort.parsers.raw + }, (err: any) => {}); + + let port2 = new SerialPort('', { + baudRate: 0, + parser: SerialPort.parsers.readline('\n', 'ascii') + }, (err: any) => {}); + + let port3 = new SerialPort('', { + baudRate: 0, + parser: SerialPort.parsers.byteLength(7) + }, (err: any) => {}); + + let port4 = new SerialPort('', { + baudRate: 0, + parser: SerialPort.parsers.byteDelimiter([3, 4, 5]) + }, (err: any) => {}); + + let port5 = new SerialPort('', { + autoOpen: false, + lock: false, + baudRate: 115200, + dataBits: 5, + stopBits: 2, + parity: 'odd', + rtscts: true, + xon: true, + xoff: true, + bufferSize: 1024, + platformOptions: { + vmin: 1, + vtime: 1 + } + }, (err: any) => {}); } function test_write() { - let port = new SerialPort(""); - port.write("main screen turn on", (err, bytesWritten) => { - }); + let port = new SerialPort(''); + port.write('main screen turn on', (err, bytesWritten) => {}); } function test_events() { - let port = new SerialPort(""); - port.on("open", function () { }); + let port = new SerialPort(''); + port.on('open', () => {}); } function test_list_ports() { - SerialPort.list( (err: string, ports: SerialPort.portConfig[]) => { - - }); + SerialPort.list((err: string, ports: SerialPort.portConfig[]) => {}); } diff --git a/types/serialport/tsconfig.json b/types/serialport/tsconfig.json index f70ef60163..72f0329252 100644 --- a/types/serialport/tsconfig.json +++ b/types/serialport/tsconfig.json @@ -6,7 +6,7 @@ ], "noImplicitAny": true, "noImplicitThis": true, - "strictNullChecks": false, + "strictNullChecks": true, "baseUrl": "../", "typeRoots": [ "../" diff --git a/types/serialport/tslint.json b/types/serialport/tslint.json new file mode 100644 index 0000000000..2221e40e4a --- /dev/null +++ b/types/serialport/tslint.json @@ -0,0 +1 @@ +{ "extends": "../tslint.json" } \ No newline at end of file From e69b58e400e4560fda5a802e3cbf9413453edc7d Mon Sep 17 00:00:00 2001 From: Andy Date: Fri, 31 Mar 2017 12:19:34 -0700 Subject: [PATCH 127/844] Apply new lint rules to ever more packages (#15551) --- types/ember/tslint.json | 1 + types/emojione/index.d.ts | 18 +- types/es6-weak-map/es6-weak-map-tests.ts | 6 +- types/express-mysql-session/index.d.ts | 1 - .../express-rate-limit-tests.ts | 4 +- types/express-rate-limit/index.d.ts | 12 +- types/extract-zip/index.d.ts | 2 +- types/fabric/fabric-tests.ts | 84 +- types/fabric/index.d.ts | 14 +- types/fetch-jsonp/fetch-jsonp-tests.ts | 28 +- types/fetch-mock/index.d.ts | 344 +- types/firmata/index.d.ts | 80 +- types/flatbuffers/flatbuffers-tests.ts | 2780 ++-- types/flatbuffers/index.d.ts | 45 +- types/flatbuffers/tslint.json | 7 +- types/flatpickr/index.d.ts | 2 +- types/forever-monitor/index.d.ts | 3 +- types/format-unicorn/test/index.ts | 2 +- types/format-unicorn/test/safe.ts | 2 +- types/fullcalendar/index.d.ts | 8 +- types/fusioncharts/fusioncharts.charts.d.ts | 2 +- types/fusioncharts/fusioncharts.gantt.d.ts | 2 +- types/fusioncharts/fusioncharts.maps.d.ts | 2 +- .../fusioncharts.powercharts.d.ts | 2 +- types/fusioncharts/fusioncharts.ssgrid.d.ts | 2 +- types/fusioncharts/fusioncharts.treemap.d.ts | 2 +- types/fusioncharts/fusioncharts.widgets.d.ts | 2 +- .../fusioncharts.zoomscatter.d.ts | 2 +- types/fusioncharts/index.d.ts | 6 +- types/fusioncharts/maps/fusioncharts.usa.d.ts | 2 +- .../fusioncharts/maps/fusioncharts.world.d.ts | 2 +- .../themes/fusioncharts.theme.carbon.d.ts | 2 +- .../themes/fusioncharts.theme.fint.d.ts | 2 +- .../themes/fusioncharts.theme.ocean.d.ts | 2 +- .../themes/fusioncharts.theme.zune.d.ts | 2 +- types/google.analytics/index.d.ts | 71 +- types/graphite-udp/index.d.ts | 2 +- types/graphql-relay/graphql-relay-tests.ts | 11 +- types/graphql-relay/index.d.ts | 17 +- types/hapi-auth-jwt2/hapi-auth-jwt2-tests.ts | 4 +- types/hapi-auth-jwt2/index.d.ts | 98 +- types/ignite-ui/index.d.ts | 11618 ++++++++-------- types/indent-string/indent-string-tests.ts | 2 +- .../intl-messageformat-tests.ts | 19 +- types/isotope-layout/index.d.ts | 19 +- types/isotope-layout/isotope-layout-tests.ts | 16 +- types/isotope-layout/tslint.json | 7 +- types/jasmine-ajax/jasmine-ajax-tests.ts | 94 +- .../jasmine-data_driven_tests-tests.ts | 4 +- types/jasmine-fixture/index.d.ts | 4 +- .../jasmine-fixture/jasmine-fixture-tests.ts | 6 +- types/jquery-toastmessage-plugin/index.d.ts | 5 +- types/jquery.tools/index.d.ts | 8 +- types/jquery.tools/jquery.tools-tests.ts | 175 +- types/js-quantities/js-quantities-tests.ts | 12 +- types/json-stable-stringify/index.d.ts | 3 - .../json-stable-stringify-tests.ts | 14 +- types/knuddels-userapps-api/index.d.ts | 59 +- .../knuddels-userapps-api-tests.ts | 12 +- types/koa-compose/koa-compose-tests.ts | 4 +- types/linkify-it/index.d.ts | 16 +- types/moment-round/moment-round-tests.ts | 2 +- .../moment-timezone/moment-timezone-tests.ts | 20 +- types/multimatch/index.d.ts | 2 - types/passport-anonymous/index.d.ts | 2 +- types/prismjs/index.d.ts | 2 - types/prismjs/prismjs-tests.ts | 8 +- types/selenium-webdriver/tslint.json | 3 + 68 files changed, 7933 insertions(+), 7883 deletions(-) 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/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/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/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/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/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/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/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/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/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/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/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/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/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/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-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/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/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/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/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/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/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/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/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 } } From 7bcfa77f05b0c8813b681d0d4c5e8905f7c5c19a Mon Sep 17 00:00:00 2001 From: Troy Weber Date: Fri, 31 Mar 2017 12:22:17 -0700 Subject: [PATCH 128/844] removed unnecessary header --- types/serialport/serialport-tests.ts | 4 ---- 1 file changed, 4 deletions(-) diff --git a/types/serialport/serialport-tests.ts b/types/serialport/serialport-tests.ts index 58d39cb1d6..7b1c69bf74 100644 --- a/types/serialport/serialport-tests.ts +++ b/types/serialport/serialport-tests.ts @@ -1,7 +1,3 @@ -// Tests for serialport.d.ts -// Project: https://github.com/EmergingTechnologyAdvisors/node-serialport -// Definitions by: Jeremy Foster -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // Tests taken from documentation samples. import * as SerialPort from 'serialport'; From e2eb29bf89a0cd58165c8afcf9ae85dbe87e84f3 Mon Sep 17 00:00:00 2001 From: Ryan Riley Date: Fri, 31 Mar 2017 15:16:15 -0500 Subject: [PATCH 129/844] More closely relate the definitions to the underlying source code. --- types/handsontable/index.d.ts | 268 +++++++++++++--------------------- 1 file changed, 101 insertions(+), 167 deletions(-) diff --git a/types/handsontable/index.d.ts b/types/handsontable/index.d.ts index 39b81d1f8d..fe4cfeb112 100644 --- a/types/handsontable/index.d.ts +++ b/types/handsontable/index.d.ts @@ -3,6 +3,97 @@ // Definitions by: Handsoncode sp. z o.o. , Ryan Riley // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped\ +declare namespace __Handsontable { + // The Core class is used inside the Handsontable namespace in the actual source code. + // However, there is a resolution issue when a class outside a namespace or module + // extends a class inside a module with the same name. That issue includes a work-around. + // Using the workaround found here: https://github.com/Microsoft/TypeScript/issues/3602 + + class Core { + constructor (element: Element, options: Handsontable.Options); + addHook(key: string, callback: Function|any[]): void; + addHookOnce(key: string, callback: Function|any[]): void; + alter(action: string, index: number, amount?: number, source?: string, keepEmptyRows?: boolean): void; + clear(): void; + colOffset(): number; + colToProp(col: number): string|number; + countCols(): number; + countEmptyCols(ending?: boolean): number; + countEmptyRows(ending?: boolean): number; + countRenderedCols(): number; + countRenderedRows(): number; + countRows(): number; + countSourceRows(): number; + countVisibleCols(): number; + countVisibleRows(): number; + deselectCell(): void; + destroy(): void; + destroyEditor(revertOriginal?: boolean): void; + getActiveEditor(): Object; + getCell(row: number, col: number, topmost?: boolean): Element; + getCellEditor(row: number, col: number): Object; + getCellMeta(row: number, col: number): Object; + getCellRenderer(row: number, col: number): Function; + getCellValidator(row: number, col: number): any; + getColHeader(col?: number): any[]|string; + getColWidth(col: number): number; + getCoords(elem: Element): Object; + getCopyableData(row: number, column: number): string; + getCopyableText(startRow: number, startCol: number, endRow: number, endCol: number): string; + getData(r?: number, c?: number, r2?: number, c2?: number): any[]; + getDataAtCell(row: number, col: number): any; + getDataAtCol(col: number): any[]; + getDataAtProp(prop: string|number): any[]; + getDataAtRow(row: number): any[]; + getDataAtRowProp(row: number, prop: string): any; + getDataType(rowFrom: number, columnFrom: number, rowTo: number, columnTo: number): string; + getInstance(): any; + getPlugin(pluginName: string): any; + getRowHeader(row?: number): any[]|string; + getRowHeight(row: number): number; + getSchema(): Object; + getSelected(): any[]; + getSelectedRange(): Handsontable.Range; + getSettings(): Handsontable.Options; + getSourceData(r?: number, c?: number, r2?: number, c2?: number): any[]; + getSourceDataAtCell(row: number, column: number): any; + getSourceDataAtCol(column: number): any[]; + getSourceDataAtRow(row: number): any[]|Object; + getValue(): any; + hasColHeaders(): boolean; + hasHook(key: string): boolean; + hasRowHeaders(): boolean; + isEmptyCol(col: number): boolean; + isEmptyRow(row: number): boolean; + isListening(): boolean; + listen(): void; + loadData(data: any[]): void; + populateFromArray(row: number, col: number, input: any[], endRow?: number, endCol?: number, source?: string, method?: string, direction?: string, deltas?: any[]): any; + propToCol(prop: string | number): number; + removeCellMeta(row: number, col: number, key: string): void; + removeHook(key: string, callback: Function): void; + render(): void; + rowOffset(): number; + runHooks(key: string, p1?: any, p2?: any, p3?: any, p4?: any, p5?: any, p6?: any): any; + selectCell(row: number, col: number, endRow?: number, endCol?: number, scrollToCell?: boolean, changeListener?: boolean): boolean; + selectCellByProp(row: number, prop: string, endRow?: number, endProp?: string, scrollToCell?: boolean): boolean; + setCellMeta(row: number, col: number, key: string, val: string): void; + setCellMetaObject(row: number, col: number, prop: Object): void; + setDataAtCell(row: number|any[], col: number, value: string, source?: string): void; + setDataAtRowProp(row: number|any[], prop: string, value: string, source?: string): void; + spliceCol(col: number, index: number, amount: number, elements?: any): void; + spliceRow(row: number, index: number, amount: number, elements?: any): void; + toPhysicalRow(row: number): number; + toPhysicalColumn(column: number): number; + toVisualRow(row: number): number; + toVisualColumn(column: number): number; + unlisten(): void; + updateSettings(settings: Object, init?: boolean): void; + validateCells(callback: Function): void; + } + +} + declare namespace Handsontable { interface Options { allowEmpty?: boolean; @@ -208,86 +299,8 @@ declare namespace Handsontable { unmodifyCol?(col: number): void; } - interface Methods { - addHook(key: string, callback: Function|any[]): void; - addHookOnce(key: string, callback: Function|any[]): void; - alter(action: string, index: number, amount?: number, source?: string, keepEmptyRows?: boolean): void; - clear(): void; - colOffset(): number; - colToProp(col: number): string|number; - countCols(): number; - countEmptyCols(ending?: boolean): number; - countEmptyRows(ending?: boolean): number; - countRenderedCols(): number; - countRenderedRows(): number; - countRows(): number; - countSourceRows(): number; - countVisibleCols(): number; - countVisibleRows(): number; - deselectCell(): void; - destroy(): void; - destroyEditor(revertOriginal?: boolean): void; - getActiveEditor(): Object; - getCell(row: number, col: number, topmost?: boolean): Element; - getCellEditor(row: number, col: number): Object; - getCellMeta(row: number, col: number): Object; - getCellRenderer(row: number, col: number): Function; - getCellValidator(row: number, col: number): any; - getColHeader(col?: number): any[]|string; - getColWidth(col: number): number; - getCoords(elem: Element): Object; - getCopyableData(row: number, column: number): string; - getCopyableText(startRow: number, startCol: number, endRow: number, endCol: number): string; - getData(r?: number, c?: number, r2?: number, c2?: number): any[]; - getDataAtCell(row: number, col: number): any; - getDataAtCol(col: number): any[]; - getDataAtProp(prop: string|number): any[]; - getDataAtRow(row: number): any[]; - getDataAtRowProp(row: number, prop: string): any; - getDataType(rowFrom: number, columnFrom: number, rowTo: number, columnTo: number): string; - getInstance(): any; - getPlugin(pluginName: string): any; - getRowHeader(row?: number): any[]|string; - getRowHeight(row: number): number; - getSchema(): Object; - getSelected(): any[]; - getSelectedRange(): Range; - getSettings(): Options; - getSourceData(r?: number, c?: number, r2?: number, c2?: number): any[]; - getSourceDataAtCell(row: number, column: number): any; - getSourceDataAtCol(column: number): any[]; - getSourceDataAtRow(row: number): any[]|Object; - getValue(): any; - hasColHeaders(): boolean; - hasHook(key: string): boolean; - hasRowHeaders(): boolean; - isEmptyCol(col: number): boolean; - isEmptyRow(row: number): boolean; - isListening(): boolean; - listen(): void; - loadData(data: any[]): void; - populateFromArray(row: number, col: number, input: any[], endRow?: number, endCol?: number, source?: string, method?: string, direction?: string, deltas?: any[]): any; - propToCol(prop: string | number): number; - removeCellMeta(row: number, col: number, key: string): void; - removeHook(key: string, callback: Function): void; - render(): void; - rowOffset(): number; - runHooks(key: string, p1?: any, p2?: any, p3?: any, p4?: any, p5?: any, p6?: any): any; - selectCell(row: number, col: number, endRow?: number, endCol?: number, scrollToCell?: boolean, changeListener?: boolean): boolean; - selectCellByProp(row: number, prop: string, endRow?: number, endProp?: string, scrollToCell?: boolean): boolean; - setCellMeta(row: number, col: number, key: string, val: string): void; - setCellMetaObject(row: number, col: number, prop: Object): void; - setDataAtCell(row: number|any[], col: number, value: string, source?: string): void; - setDataAtRowProp(row: number|any[], prop: string, value: string, source?: string): void; - spliceCol(col: number, index: number, amount: number, elements?: any): void; - spliceRow(row: number, index: number, amount: number, elements?: any): void; - toPhysicalRow(row: number): number; - toPhysicalColumn(column: number): number; - toVisualRow(row: number): number; - toVisualColumn(column: number): number; - unlisten(): void; - updateSettings(settings: Object, init?: boolean): void; - validateCells(callback: Function): void; + class Core extends __Handsontable.Core { + } interface Selection { @@ -301,8 +314,8 @@ declare namespace Handsontable { } interface HandsontableRegisterer { - getInstance(id: string): Methods; - registerInstance(id: string, instance: Methods): void; + getInstance(id: string): Core; + registerInstance(id: string, instance: Core): void; removeInstance(id: string): void; } @@ -342,11 +355,11 @@ declare namespace Handsontable { updatePlugin(): void; destroy(): void; enabled: boolean; - hot: Methods; + hot: Core; } interface PluginConstructor { - new (hotInstance: Methods): BasePlugin; + new (hotInstance: Core): BasePlugin; } interface ContextMenuPluginConstructor extends PluginConstructor { @@ -389,7 +402,7 @@ declare namespace Handsontable { interface Hooks { register(key: string): void; - run(instace: Methods, hookName: string, key?: any, value?: any): any; + run(instace: Core, hookName: string, key?: any, value?: any): any; } interface Dom { @@ -430,7 +443,7 @@ declare namespace Handsontable { } type CellRenderer = ( - instance: Methods, + instance: Core, td: HTMLTableCellElement, row: number, col: number, @@ -443,7 +456,7 @@ declare namespace Handsontable { } interface EditorConstructor { - new (instance: Methods): Editor; + new (instance: Core): Editor; } interface Editors { @@ -493,7 +506,7 @@ declare namespace Handsontable { type DropdownColumn = AutocompleteColumn; } -declare class Handsontable implements Handsontable.Methods { +declare class Handsontable extends __Handsontable.Core { constructor (element: Element, options: Handsontable.Options); static plugins: Handsontable.Plugins; static hooks: Handsontable.Hooks; @@ -503,85 +516,6 @@ declare class Handsontable implements Handsontable.Methods { static utils: Handsontable.Utils; static renderers: Handsontable.Renderers; static editors: Handsontable.Editors; - addHook(key: string, callback: Function|any[]): void; - addHookOnce(key: string, callback: Function|any[]): void; - alter(action: string, index: number, amount?: number, source?: string, keepEmptyRows?: boolean): void; - clear(): void; - colOffset(): number; - colToProp(col: number): string|number; - countCols(): number; - countEmptyCols(ending?: boolean): number; - countEmptyRows(ending?: boolean): number; - countRenderedCols(): number; - countRenderedRows(): number; - countRows(): number; - countSourceRows(): number; - countVisibleCols(): number; - countVisibleRows(): number; - deselectCell(): void; - destroy(): void; - destroyEditor(revertOriginal?: boolean): void; - getActiveEditor(): Object; - getCell(row: number, col: number, topmost?: boolean): Element; - getCellEditor(row: number, col: number): Object; - getCellMeta(row: number, col: number): Object; - getCellRenderer(row: number, col: number): Function; - getCellValidator(row: number, col: number): any; - getColHeader(col?: number): any[]|string; - getColWidth(col: number): number; - getCoords(elem: Element): Object; - getCopyableData(row: number, column: number): string; - getCopyableText(startRow: number, startCol: number, endRow: number, endCol: number): string; - getData(r?: number, c?: number, r2?: number, c2?: number): any[]; - getDataAtCell(row: number, col: number): any; - getDataAtCol(col: number): any[]; - getDataAtProp(prop: string|number): any[]; - getDataAtRow(row: number): any[]; - getDataAtRowProp(row: number, prop: string): any; - getDataType(rowFrom: number, columnFrom: number, rowTo: number, columnTo: number): string; - getInstance(): any; - getPlugin(pluginName: string): any; - getRowHeader(row?: number): any[]|string; - getRowHeight(row: number): number; - getSchema(): Object; - getSelected(): any[]; - getSelectedRange(): Handsontable.Range; - getSettings(): Handsontable.Options; - getSourceData(r?: number, c?: number, r2?: number, c2?: number): any[]; - getSourceDataAtCell(row: number, column: number): any; - getSourceDataAtCol(column: number): any[]; - getSourceDataAtRow(row: number): any[]|Object; - getValue(): any; - hasColHeaders(): boolean; - hasHook(key: string): boolean; - hasRowHeaders(): boolean; - isEmptyCol(col: number): boolean; - isEmptyRow(row: number): boolean; - isListening(): boolean; - listen(): void; - loadData(data: any[]): void; - populateFromArray(row: number, col: number, input: any[], endRow?: number, endCol?: number, source?: string, method?: string, direction?: string, deltas?: any[]): any; - propToCol(prop: string | number): number; - removeCellMeta(row: number, col: number, key: string): void; - removeHook(key: string, callback: Function): void; - render(): void; - rowOffset(): number; - runHooks(key: string, p1?: any, p2?: any, p3?: any, p4?: any, p5?: any, p6?: any): any; - selectCell(row: number, col: number, endRow?: number, endCol?: number, scrollToCell?: boolean, changeListener?: boolean): boolean; - selectCellByProp(row: number, prop: string, endRow?: number, endProp?: string, scrollToCell?: boolean): boolean; - setCellMeta(row: number, col: number, key: string, val: string): void; - setCellMetaObject(row: number, col: number, prop: Object): void; - setDataAtCell(row: number|any[], col: number, value: string, source?: string): void; - setDataAtRowProp(row: number|any[], prop: string, value: string, source?: string): void; - spliceCol(col: number, index: number, amount: number, elements?: any): void; - spliceRow(row: number, index: number, amount: number, elements?: any): void; - toPhysicalRow(row: number): number; - toPhysicalColumn(column: number): number; - toVisualRow(row: number): number; - toVisualColumn(column: number): number; - unlisten(): void; - updateSettings(settings: Object, init?: boolean): void; - validateCells(callback: Function): void; } declare module "handsontable" { From 45e6b04f36857bf3cdcc4994de7e89a9410bda45 Mon Sep 17 00:00:00 2001 From: Ryan Riley Date: Fri, 31 Mar 2017 15:23:45 -0500 Subject: [PATCH 130/844] Add spaces after comment to fix build --- types/handsontable/index.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/types/handsontable/index.d.ts b/types/handsontable/index.d.ts index e28562a08f..492dbd61a1 100644 --- a/types/handsontable/index.d.ts +++ b/types/handsontable/index.d.ts @@ -519,5 +519,5 @@ declare class Handsontable extends __Handsontable.Core { declare module "handsontable" { export = Handsontable; } -//export = Handsontable; -//export as namespace Handsontable; +// export = Handsontable; +// export as namespace Handsontable; From 2b6e1c7cb09acad419689b6c941e562365f63378 Mon Sep 17 00:00:00 2001 From: Ryan Riley Date: Fri, 31 Mar 2017 15:27:51 -0500 Subject: [PATCH 131/844] Fix build errors --- types/handsontable/index.d.ts | 3 +-- types/handsontable/test/global.ts | 2 +- types/handsontable/test/module.ts | 2 +- 3 files changed, 3 insertions(+), 4 deletions(-) diff --git a/types/handsontable/index.d.ts b/types/handsontable/index.d.ts index 492dbd61a1..4a7ef7f7da 100644 --- a/types/handsontable/index.d.ts +++ b/types/handsontable/index.d.ts @@ -10,7 +10,7 @@ declare namespace __Handsontable { // Using the workaround found here: https://github.com/Microsoft/TypeScript/issues/3602 class Core { - constructor (element: Element, options: Handsontable.Options); + constructor(element: Element, options: Handsontable.Options); addHook(key: string, callback: Function|any[]): void; addHookOnce(key: string, callback: Function|any[]): void; alter(action: string, index: number, amount?: number, source?: string, keepEmptyRows?: boolean): void; @@ -299,7 +299,6 @@ declare namespace Handsontable { } class Core extends __Handsontable.Core { - } interface Selection { diff --git a/types/handsontable/test/global.ts b/types/handsontable/test/global.ts index fb40f1d00d..d5134f0fa0 100644 --- a/types/handsontable/test/global.ts +++ b/types/handsontable/test/global.ts @@ -298,4 +298,4 @@ namespace HandsontableGlobalTest { return !!this.hot.getSettings().manualRowMove; } } -} \ No newline at end of file +} diff --git a/types/handsontable/test/module.ts b/types/handsontable/test/module.ts index 343337b5f0..0235127f6d 100644 --- a/types/handsontable/test/module.ts +++ b/types/handsontable/test/module.ts @@ -298,4 +298,4 @@ namespace HandsOnTableModuleTest { return !!this.hot.getSettings().manualRowMove; } } -} \ No newline at end of file +} From bc2f84cd24d4bd039c95cba1c165f969cebd1ce7 Mon Sep 17 00:00:00 2001 From: Zak Tsai Date: Fri, 31 Mar 2017 16:56:19 -0400 Subject: [PATCH 132/844] Added type check for setting object and format function overloads. --- types/moment-duration-format/index.d.ts | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/types/moment-duration-format/index.d.ts b/types/moment-duration-format/index.d.ts index eb81f2551a..6c09e59e36 100644 --- a/types/moment-duration-format/index.d.ts +++ b/types/moment-duration-format/index.d.ts @@ -5,7 +5,16 @@ declare namespace moment { - interface Duration { - format(template: string, precision?: string, settings?: any): string; + interface DurationFormatSettings { + template?: string; + precision?: number; + trim?: boolean|string; + forceLength?: boolean; } -} \ No newline at end of file + + interface Duration { + format(template: string, precision?: number, settings?: DurationFormatSettings): string; + format(template: string, settings?: DurationFormatSettings): string; + format(settings: DurationFormatSettings): string; + } +} From e6521f9e695212fd99eb219d02a56f15a2fd6176 Mon Sep 17 00:00:00 2001 From: Zak Tsai Date: Fri, 31 Mar 2017 17:08:37 -0400 Subject: [PATCH 133/844] Add tslint.json --- types/moment-duration-format/tslint.json | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 types/moment-duration-format/tslint.json diff --git a/types/moment-duration-format/tslint.json b/types/moment-duration-format/tslint.json new file mode 100644 index 0000000000..ec365f164b --- /dev/null +++ b/types/moment-duration-format/tslint.json @@ -0,0 +1,3 @@ +{ + "extends": "../tslint.json" +} From 6057f7c6c6e13407f865eba89022fcd3a132ff8c Mon Sep 17 00:00:00 2001 From: Andy Date: Fri, 31 Mar 2017 15:57:07 -0700 Subject: [PATCH 134/844] github: Provides its own types (#15557) --- notNeededPackages.json | 14 +- scripts/not-needed.js | 2 +- types/github/github-tests.ts | 27 --- types/github/index.d.ts | 326 ----------------------------------- types/github/tsconfig.json | 23 --- 5 files changed, 11 insertions(+), 381 deletions(-) delete mode 100644 types/github/github-tests.ts delete mode 100644 types/github/index.d.ts delete mode 100644 types/github/tsconfig.json diff --git a/notNeededPackages.json b/notNeededPackages.json index 90a63f066e..274f8f829b 100644 --- a/notNeededPackages.json +++ b/notNeededPackages.json @@ -84,6 +84,12 @@ "sourceRepoURL": "https://github.com/ascoders/gaea-model", "asOfVersion": "0.0.0" }, + { + "libraryName": "github", + "typingsPackageName": "github", + "sourceRepoURL": "https://github.com/mikedeboer/node-github", + "asOfVersion": "7.1.0" + }, { "libraryName": "Facebook's Immutable", "typingsPackageName": "immutable", @@ -157,10 +163,10 @@ "asOfVersion": "1.0.0" }, { - "libraryName": "localforage", - "typingsPackageName": "localforage", - "sourceRepoURL": "https://github.com/localForage/localForage", - "asOfVersion": "0.0.34" + "libraryName": "localforage", + "typingsPackageName": "localforage", + "sourceRepoURL": "https://github.com/localForage/localForage", + "asOfVersion": "0.0.34" }, { "libraryName": "lower-case", diff --git a/scripts/not-needed.js b/scripts/not-needed.js index e17b3ac6ce..9a2360c72b 100644 --- a/scripts/not-needed.js +++ b/scripts/not-needed.js @@ -17,7 +17,7 @@ rmdirRecursive(path.join("types", typingsPackageName)); const notNeededPackages = JSON.parse(fs.readFileSync("notNeededPackages.json", "utf-8")); notNeededPackages.packages.push({ libraryName, typingsPackageName, sourceRepoURL, asOfVersion }); notNeededPackages.packages.sort((x, y) => x.typingsPackageName < y.typingsPackageName ? -1 : 1); -fs.writeFileSync("notNeededPackages.json", JSON.stringify(notNeededPackages, undefined, 4), "utf-8"); +fs.writeFileSync("notNeededPackages.json", JSON.stringify(notNeededPackages, undefined, 4) + "\n", "utf-8"); function rmdirRecursive(dir) { for (let entry of fs.readdirSync(dir)) { diff --git a/types/github/github-tests.ts b/types/github/github-tests.ts deleted file mode 100644 index cc27c0cb5e..0000000000 --- a/types/github/github-tests.ts +++ /dev/null @@ -1,27 +0,0 @@ -import GitHubApi = require("github"); - -let github = new GitHubApi({ - // optional args - debug: true, - protocol: "https", - host: "github.my-GHE-enabled-company.com", // should be api.github.com for GitHub - pathPrefix: "/api/v3", // for some GHEs; none for GitHub - headers: { - "user-agent": "My-Cool-GitHub-App" // GitHub is happy with a unique user agent - }, - Promise: null as any, - followRedirects: false, // default: true; there's currently an issue with non-get redirects, so allow ability to disable follow-redirects - timeout: 5000 -}); - -// TODO: optional authentication here depending on desired endpoints. See below in README. - -github.users.getFollowingForUser({ - // optional: - // headers: { - // "cookie": "blahblah" - // }, - user: "defunkt" -}, (err: any, res: any) => { - console.log(JSON.stringify(res)); -}); diff --git a/types/github/index.d.ts b/types/github/index.d.ts deleted file mode 100644 index c48a24a345..0000000000 --- a/types/github/index.d.ts +++ /dev/null @@ -1,326 +0,0 @@ -// Type definitions for github -// Project: https://github.com/mikedeboer/node-github -// Definitions by: vvakame -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -export = Client; - -declare class Client { - authorization: Authorization; - events: Events; - gists: Gists; - gitdata: GitData; - gitignore: GitIgnore; - issues: Issues; - markdown: Markdown; - misc: Misc; - orgs: Orgs; - pullRequests: PullRequests; - releases: Releases; - repos: Repos; - search: Search; - statues: Statues; - users: User; - - constructor(options: Options); - - authenticate(...args: any[]): any; - getFirstPage(...args: any[]): any; - getLastPage(...args: any[]): any; - getNextPage(...args: any[]): any; - getPreviousPage(...args: any[]): any; - hasFirstPage(...args: any[]): any; - hasLastPage(...args: any[]): any; - hasNextPage(...args: any[]): any; - hasPreviousPage(...args: any[]): any; - httpSend(...args: any[]): any; - setupRoutes(...args: any[]): any; -} -declare namespace Client { } - -interface Options { - version?: string; - debug?: boolean; - protocol?: string; - host?: string; - pathPrefix?: string; - timeout?: number; - headers?: { [name: string]: any; }; - followRedirects?: boolean; - Promise?: typeof Promise; -} - -interface Authorization { - create(msg: AuthorizationCreateMessage, callback: Function): void; - delete: Function; - get: Function; - getAll: Function; - update: Function; -} - -interface AuthorizationCreateMessage { - headers?: { [name: string]: string; }; - scopes?: string[]; - note?: string; - note_url?: string; - client_id?: string; - client_secret?: string; - fingerprint?: string; -} - -interface Events { - get(...args: any[]): any; - getFromOrg(...args: any[]): any; - getFromRepo(...args: any[]): any; - getFromRepoIssues(...args: any[]): any; - getFromRepoNetwork(...args: any[]): any; - getFromUser(...args: any[]): any; - getFromUserOrg(...args: any[]): any; - getFromUserPublic(...args: any[]): any; - getReceived(...args: any[]): any; - getReceivedPublic(...args: any[]): any; -} - -interface Gists { - checkStar(...args: any[]): any; - create(...args: any[]): any; - createComment(...args: any[]): any; - delete(...args: any[]): any; - deleteComment(...args: any[]): any; - deleteStar(...args: any[]): any; - edit(...args: any[]): any; - editComment(...args: any[]): any; - fork(...args: any[]): any; - get(...args: any[]): any; - getAll(...args: any[]): any; - getComment(...args: any[]): any; - getComments(...args: any[]): any; - getFromUser(...args: any[]): any; - public(...args: any[]): any; - star(...args: any[]): any; - starred(...args: any[]): any; -} - -interface GitData { - createBlob(...args: any[]): any; - createCommit(...args: any[]): any; - createReference(...args: any[]): any; - createTag(...args: any[]): any; - createTree(...args: any[]): any; - deleteReference(...args: any[]): any; - getAllReferences(...args: any[]): any; - getBlob(...args: any[]): any; - getCommit(...args: any[]): any; - getReference(...args: any[]): any; - getTag(...args: any[]): any; - getTree(...args: any[]): any; - updateReference(...args: any[]): any; -} - -interface GitIgnore { - template(...args: any[]): any; - templates(...args: any[]): any; -} - -interface Issues { - create(...args: any[]): any; - createComment(...args: any[]): any; - createLabel(...args: any[]): any; - createMilestone(...args: any[]): any; - deleteComment(...args: any[]): any; - deleteLabel(...args: any[]): any; - deleteMilestone(...args: any[]): any; - edit(...args: any[]): any; - editComment(...args: any[]): any; - getAll(...args: any[]): any; - getAllMilestones(...args: any[]): any; - getComment(...args: any[]): any; - getComments(...args: any[]): any; - getEvent(...args: any[]): any; - getEvents(...args: any[]): any; - getIssueLabels(...args: any[]): any; - getLabel(...args: any[]): any; - getLabels(...args: any[]): any; - getMilestone(...args: any[]): any; - getRepoEvents(...args: any[]): any; - getRepoIssue(...args: any[]): any; - repoComments(...args: any[]): any; - repoIssues(...args: any[]): any; - updateLabel(...args: any[]): any; - updateMilestone(...args: any[]): any; -} - -interface Markdown { - render(...args: any[]): any; -} - -interface Misc { - emojis(...args: any[]): any; - meta(...args: any[]): any; - rateLimit(...args: any[]): any; -} - -interface Orgs { - addTeamMember(...args: any[]): any; - addTeamRepo(...args: any[]): any; - concealMembership(...args: any[]): any; - createTeam(...args: any[]): any; - deleteTeam(...args: any[]): any; - deleteTeamMember(...args: any[]): any; - deleteTeamRepo(...args: any[]): any; - get(...args: any[]): any; - getFromUser(...args: any[]): any; - getMember(...args: any[]): any; - getMembers(...args: any[]): any; - getPublicMember(...args: any[]): any; - getPublicMembers(...args: any[]): any; - getTeam(...args: any[]): any; - getTeamMember(...args: any[]): any; - getTeamMembers(...args: any[]): any; - getTeamRepo(...args: any[]): any; - getTeamRepos(...args: any[]): any; - getTeams(...args: any[]): any; - publicizeMembership(...args: any[]): any; - removeMember(...args: any[]): any; - update(...args: any[]): any; - updateTeam(...args: any[]): any; -} - -interface PullRequests { - create(...args: any[]): any; - createComment(...args: any[]): any; - createCommentReply(...args: any[]): any; - createFromIssue(...args: any[]): any; - deleteComment(...args: any[]): any; - get(...args: any[]): any; - getAll(...args: any[]): any; - getComment(...args: any[]): any; - getComments(...args: any[]): any; - getCommits(...args: any[]): any; - getFiles(...args: any[]): any; - getMerged(...args: any[]): any; - merge(...args: any[]): any; - update(...args: any[]): any; - updateComment(...args: any[]): any; -} - -interface Releases { - createRelease(...args: any[]): any; - deleteAsset(...args: any[]): any; - deleteRelease(...args: any[]): any; - editAsset(...args: any[]): any; - editRelease(...args: any[]): any; - getAsset(...args: any[]): any; - getRelease(...args: any[]): any; - listAssets(...args: any[]): any; - listReleases(...args: any[]): any; -} - -interface Repos { - addCollaborator(...args: any[]): any; - compareCommits(...args: any[]): any; - create(...args: any[]): any; - createCommitComment(...args: any[]): any; - createContent(...args: any[]): any; - createFile(...args: any[]): any; - createFromOrg(...args: any[]): any; - createHook(...args: any[]): any; - createKey(...args: any[]): any; - delete(...args: any[]): any; - deleteCommitComment(...args: any[]): any; - deleteDownload(...args: any[]): any; - deleteFile(...args: any[]): any; - deleteHook(...args: any[]): any; - deleteKey(...args: any[]): any; - fork(...args: any[]): any; - get(...args: any[]): any; - getAll(...args: any[]): any; - getAllCommitComments(...args: any[]): any; - getArchiveLink(...args: any[]): any; - getBranch(...args: any[]): any; - getBranches(...args: any[]): any; - getCollaborator(...args: any[]): any; - getCollaborators(...args: any[]): any; - getCommit(...args: any[]): any; - getCommitComment(...args: any[]): any; - getCommitComments(...args: any[]): any; - getCommits(...args: any[]): any; - getContent(...args: any[]): any; - getContributors(...args: any[]): any; - getDownload(...args: any[]): any; - getDownloads(...args: any[]): any; - getForks(...args: any[]): any; - getFromOrg(...args: any[]): any; - getFromUser(...args: any[]): any; - getHook(...args: any[]): any; - getHooks(...args: any[]): any; - getKey(...args: any[]): any; - getKeys(...args: any[]): any; - getLanguages(...args: any[]): any; - getReadme(...args: any[]): any; - getStargazers(...args: any[]): any; - getStarred(...args: any[]): any; - getStarredFromUser(...args: any[]): any; - getStarring(...args: any[]): any; - getStatsCodeFrequency(...args: any[]): any; - getStatsCommitActivity(...args: any[]): any; - getStatsContributors(...args: any[]): any; - getStatsParticipation(...args: any[]): any; - getStatsPunchCard(...args: any[]): any; - getTags(...args: any[]): any; - getTeams(...args: any[]): any; - getWatched(...args: any[]): any; - getWatchedFromUser(...args: any[]): any; - getWatchers(...args: any[]): any; - getWatching(...args: any[]): any; - merge(...args: any[]): any; - one(...args: any[]): any; - removeCollaborator(...args: any[]): any; - star(...args: any[]): any; - testHook(...args: any[]): any; - unStar(...args: any[]): any; - unWatch(...args: any[]): any; - update(...args: any[]): any; - updateCommitComment(...args: any[]): any; - updateFile(...args: any[]): any; - updateHook(...args: any[]): any; - updateKey(...args: any[]): any; - watch(...args: any[]): any; -} - -interface Search { - email(...args: any[]): any; - issues(...args: any[]): any; - repos(...args: any[]): any; - users(...args: any[]): any; -} - -interface Statues { - create(...args: any[]): any; - get(...args: any[]): any; - getCombined(...args: any[]): any; -} - -interface User { - user(...args: any[]): any; - addEmails(...args: any[]): any; - createKey(...args: any[]): any; - deleteEmails(...args: any[]): any; - deleteKey(...args: any[]): any; - followUser(...args: any[]): any; - get(...args: any[]): any; - getEmails(...args: any[]): any; - getFollowers(...args: any[]): any; - getFollowing(...args: any[]): any; - getFollowingFromUser(...args: any[]): any; - getFollowingForUser(...args: any[]): any; - getFrom(...args: any[]): any; - getKey(...args: any[]): any; - getKeys(...args: any[]): any; - getKeysFromUser(...args: any[]): any; - getOrgs(...args: any[]): any; - getTeams(...args: any[]): any; - unFollowUser(...args: any[]): any; - update(...args: any[]): any; - updateKey(...args: any[]): any; -} diff --git a/types/github/tsconfig.json b/types/github/tsconfig.json deleted file mode 100644 index 34008249b9..0000000000 --- a/types/github/tsconfig.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "compilerOptions": { - "module": "commonjs", - "lib": [ - "es6", - "dom" - ], - "noImplicitAny": true, - "noImplicitThis": true, - "strictNullChecks": true, - "baseUrl": "../", - "typeRoots": [ - "../" - ], - "types": [], - "noEmit": true, - "forceConsistentCasingInFileNames": true - }, - "files": [ - "index.d.ts", - "github-tests.ts" - ] -} \ No newline at end of file From 2f7adbeb8ece3a68a5b63cb0c6b3fbb374ea7fd5 Mon Sep 17 00:00:00 2001 From: Jonathan Little Date: Fri, 31 Mar 2017 16:24:20 -0700 Subject: [PATCH 135/844] Added assert, verify, and verifyAndRestore for SinonJS sandbox. --- types/sinon/index.d.ts | 3 +++ types/sinon/sinon-tests.ts | 5 +++++ 2 files changed, 8 insertions(+) diff --git a/types/sinon/index.d.ts b/types/sinon/index.d.ts index 224ab4003f..4a02ec691a 100644 --- a/types/sinon/index.d.ts +++ b/types/sinon/index.d.ts @@ -394,6 +394,7 @@ declare namespace Sinon { } interface SinonSandbox { + assert: SinonAssert; clock: SinonFakeTimers; requests: SinonFakeXMLHttpRequest; server: SinonFakeServer; @@ -407,6 +408,8 @@ declare namespace Sinon { reset(): void; resetHistory(): void; resetBehavior(): void; + verify(): void; + verifyAndRestore(): void; } interface SinonSandboxStatic { diff --git a/types/sinon/sinon-tests.ts b/types/sinon/sinon-tests.ts index 8354045a25..2637d92c33 100644 --- a/types/sinon/sinon-tests.ts +++ b/types/sinon/sinon-tests.ts @@ -90,6 +90,9 @@ function testNine() { function testSandbox() { var sandbox = sinon.sandbox.create(); + + sandbox.assert.notCalled(sinon.spy()); + if (sandbox.spy().called) { sandbox.stub(objectUnderTest, "process").yieldsTo("success"); sandbox.mock(objectUnderTest).expects("process").once(); @@ -101,6 +104,8 @@ function testSandbox() { sandbox.reset(); sandbox.resetHistory(); sandbox.resetBehavior(); + sandbox.verify(); + sandbox.verifyAndRestore(); } function testPromises() { From ed6280c87c29b5ea04d338a7aa3fad55b6b7b4b2 Mon Sep 17 00:00:00 2001 From: Zak Date: Fri, 31 Mar 2017 22:45:56 -0400 Subject: [PATCH 136/844] remove consecutive line --- types/moment-duration-format/index.d.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/types/moment-duration-format/index.d.ts b/types/moment-duration-format/index.d.ts index 6c09e59e36..437cf2a689 100644 --- a/types/moment-duration-format/index.d.ts +++ b/types/moment-duration-format/index.d.ts @@ -3,7 +3,6 @@ // Definitions by: Swint De Coninck // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - declare namespace moment { interface DurationFormatSettings { template?: string; From 750de45b975864334e970c50b4004faade96aab4 Mon Sep 17 00:00:00 2001 From: AlbertOzimek Date: Mon, 3 Apr 2017 09:45:58 +0200 Subject: [PATCH 137/844] Update index.d.ts updating highcharts/maps/index.d.ts based on the highmaps specification: http://api.highcharts.com/highmaps Adding: - plotOptions http://api.highcharts.com/highmaps/plotOptions - tooltip http://api.highcharts.com/highmaps/tooltip --- types/highcharts/modules/map/index.d.ts | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/types/highcharts/modules/map/index.d.ts b/types/highcharts/modules/map/index.d.ts index 7e3b126e47..fa8c0ed28d 100644 --- a/types/highcharts/modules/map/index.d.ts +++ b/types/highcharts/modules/map/index.d.ts @@ -13,16 +13,13 @@ declare module 'highcharts' { interface MapOptions { chart?: highcharts.ChartOptions; - legend?: highcharts.LegendOptions; - mapNavigation?: Navigation; - + plotOptions?: highcharts.PlotOptions; series?: MapSeriesOptions[]; - colorAxis?: ColorAxis; - title?: highcharts.TitleOptions; + tooltip?: highcharts.TooltipOptions; } interface MapSeriesOptions { From ddb82936f24e432152620405d8a2e10ef86e921a Mon Sep 17 00:00:00 2001 From: Huy Nguyen Date: Mon, 3 Apr 2017 14:21:15 -0400 Subject: [PATCH 138/844] Fix lint errors --- types/react-router-redux/index.d.ts | 31 ++++++++++++++-------------- types/react-router-redux/tslint.json | 2 +- 2 files changed, 16 insertions(+), 17 deletions(-) diff --git a/types/react-router-redux/index.d.ts b/types/react-router-redux/index.d.ts index 73be776ec5..bebaab7562 100644 --- a/types/react-router-redux/index.d.ts +++ b/types/react-router-redux/index.d.ts @@ -20,26 +20,26 @@ import { import * as React from 'react'; export interface ConnectedRouterProps { - store?: Store, - history?: History + store?: Store; + history?: History; } export class ConnectedRouter extends React.Component, {}> {} export const LOCATION_CHANGE: string; export interface RouterState { - location: Location | null + location: Location | null; } -export function routerReducer(state?: RouterState, action?: RouterAction): RouterState +export function routerReducer(state?: RouterState, action?: RouterAction): RouterState; export const CALL_HISTORY_METHOD: string; -export function push(location: LocationDescriptor, state?: LocationState): RouterAction -export function replace(location: LocationDescriptor, state?: LocationState): RouterAction -export function go(n: number): RouterAction -export function goBack(): RouterAction -export function goForward(): RouterAction +export function push(location: LocationDescriptor, state?: LocationState): RouterAction; +export function replace(location: LocationDescriptor, state?: LocationState): RouterAction; +export function go(n: number): RouterAction; +export function goBack(): RouterAction; +export function goForward(): RouterAction; export const routerAction: { push: typeof push @@ -47,17 +47,16 @@ export const routerAction: { go: typeof go goBack: typeof goBack goForward: typeof goForward -} +}; export interface LocationActionPayload { - method: string, - args?: any[], + method: string; + args?: any[]; } export interface RouterAction extends Action { - type: typeof CALL_HISTORY_METHOD, - payload: LocationActionPayload + type: typeof CALL_HISTORY_METHOD; + payload: LocationActionPayload; } -export function routerMiddleware(history: History): Middleware - +export function routerMiddleware(history: History): Middleware; diff --git a/types/react-router-redux/tslint.json b/types/react-router-redux/tslint.json index f05741c59b..c6a89d14c7 100644 --- a/types/react-router-redux/tslint.json +++ b/types/react-router-redux/tslint.json @@ -1,6 +1,6 @@ { "extends": "../tslint.json", "rules": { - "forbidden-types": false + "banned-types": false } } From 1e1de92c5575b40e04528901ecfcbf86726b2622 Mon Sep 17 00:00:00 2001 From: Alexander James Phillips Date: Mon, 3 Apr 2017 19:41:14 +0100 Subject: [PATCH 139/844] Move current boom definitions to v3 --- types/boom/{ => v3}/boom-tests.ts | 0 types/boom/{ => v3}/index.d.ts | 0 types/boom/{ => v3}/tsconfig.json | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename types/boom/{ => v3}/boom-tests.ts (100%) rename types/boom/{ => v3}/index.d.ts (100%) rename types/boom/{ => v3}/tsconfig.json (100%) diff --git a/types/boom/boom-tests.ts b/types/boom/v3/boom-tests.ts similarity index 100% rename from types/boom/boom-tests.ts rename to types/boom/v3/boom-tests.ts diff --git a/types/boom/index.d.ts b/types/boom/v3/index.d.ts similarity index 100% rename from types/boom/index.d.ts rename to types/boom/v3/index.d.ts diff --git a/types/boom/tsconfig.json b/types/boom/v3/tsconfig.json similarity index 100% rename from types/boom/tsconfig.json rename to types/boom/v3/tsconfig.json From ea837b86268dc5ccabb82757981849f84841f664 Mon Sep 17 00:00:00 2001 From: Alexander James Phillips Date: Mon, 3 Apr 2017 19:41:46 +0100 Subject: [PATCH 140/844] Fix boom v3 tsconfig --- types/boom/v3/tsconfig.json | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/types/boom/v3/tsconfig.json b/types/boom/v3/tsconfig.json index d64d51130b..689f5dec00 100644 --- a/types/boom/v3/tsconfig.json +++ b/types/boom/v3/tsconfig.json @@ -7,11 +7,16 @@ "noImplicitAny": true, "noImplicitThis": true, "strictNullChecks": false, - "baseUrl": "../", + "baseUrl": "../../", "typeRoots": [ - "../" + "../../" ], "types": [], + "paths": { + "boom": [ + "boom/v3" + ] + }, "noEmit": true, "forceConsistentCasingInFileNames": true }, From 9bd7ce5b7de520b08c91221cbaa70cb51342e141 Mon Sep 17 00:00:00 2001 From: Alexander James Phillips Date: Mon, 3 Apr 2017 19:48:08 +0100 Subject: [PATCH 141/844] Add boom version of v3.2 --- types/boom/v3/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/boom/v3/index.d.ts b/types/boom/v3/index.d.ts index e8cfb5722f..2c0a3ce21d 100644 --- a/types/boom/v3/index.d.ts +++ b/types/boom/v3/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for boom +// Type definitions for boom 3.2 // Project: http://github.com/hapijs/boom // Definitions by: Igor Rogatty // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped From d245364d9b6299485f0ffb9ab7aca9f03e4a3b29 Mon Sep 17 00:00:00 2001 From: Alexander James Phillips Date: Mon, 3 Apr 2017 19:37:05 +0100 Subject: [PATCH 142/844] Update to boom v4.3 BoomError subclasses Error Include typing of BoomError.output.headers and .payload Add missing error types Better typing of 401 unauthorized error Add more tests Add content from docs and links back to docs --- types/boom/boom-tests.ts | 39 +++++ types/boom/index.d.ts | 305 +++++++++++++++++++++++++++++++++++++++ types/boom/tsconfig.json | 22 +++ 3 files changed, 366 insertions(+) create mode 100644 types/boom/boom-tests.ts create mode 100644 types/boom/index.d.ts create mode 100644 types/boom/tsconfig.json diff --git a/types/boom/boom-tests.ts b/types/boom/boom-tests.ts new file mode 100644 index 0000000000..b1e34eef55 --- /dev/null +++ b/types/boom/boom-tests.ts @@ -0,0 +1,39 @@ + +import Boom = require('boom'); + +Boom.wrap(new Error('test'), 400, 'some message'); +Boom.create(500, 'Internal server error', { timestamp: Date.now() }); + +Boom.badRequest('message', {some: 'data'}); +Boom.unauthorized('message', 'scheme', {some: 'data'}); +Boom.unauthorized(null, 'scheme', 'data'); +Boom.paymentRequired('message', {some: 'data'}); +Boom.forbidden('message', {some: 'data'}); +Boom.notFound('message', {some: 'data'}); +Boom.methodNotAllowed('message', {some: 'data'}); +Boom.notAcceptable('message', {some: 'data'}); +Boom.proxyAuthRequired('message', {some: 'data'}); +Boom.clientTimeout('message', {some: 'data'}); +Boom.conflict('message', {some: 'data'}); +Boom.resourceGone('message', {some: 'data'}); +Boom.lengthRequired('message', {some: 'data'}); +Boom.preconditionFailed('message', {some: 'data'}); +Boom.entityTooLarge('message', {some: 'data'}); +Boom.uriTooLong('message', {some: 'data'}); +Boom.unsupportedMediaType('message', {some: 'data'}); +Boom.rangeNotSatisfiable('message', {some: 'data'}); +Boom.expectationFailed('message', {some: 'data'}); +Boom.teapot('message', {some: 'data'}); +Boom.badData('message', {some: 'data'}); +Boom.locked('message', {some: 'data'}); +Boom.preconditionRequired('message', {some: 'data'}); +Boom.tooManyRequests('message', {some: 'data'}); +Boom.illegal('message', {some: 'data'}); + +Boom.badImplementation('message', {some: 'data'}); +Boom.notImplemented('message', {some: 'data'}); +Boom.badGateway('message', {some: 'data'}); +Boom.serverUnavailable('message', {some: 'data'}); +Boom.gatewayTimeout('message', {some: 'data'}); + +Boom.unauthorized() as Error; diff --git a/types/boom/index.d.ts b/types/boom/index.d.ts new file mode 100644 index 0000000000..38edfd2d4b --- /dev/null +++ b/types/boom/index.d.ts @@ -0,0 +1,305 @@ +// Type definitions for boom 4.3 +// Project: http://github.com/hapijs/boom +// Definitions by: Igor Rogatty , AJP +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +/// + +export = Boom; + +declare namespace Boom { + + /** + * boom provides a set of utilities for returning HTTP errors. Each utility returns a Boom error response object (instance of Error) which includes the following properties: + * @see {@link https://github.com/hapijs/boom#boom} + */ + export interface BoomError extends Error { + /** isBoom - if true, indicates this is a Boom object instance. */ + isBoom: boolean; + /** isServer - convenience bool indicating status code >= 500. */ + isServer: boolean; + /** message - the error message. */ + message: string; + /** output - the formatted response. Can be directly manipulated after object construction to return a custom error response. Allowed root keys: */ + output: Output; + /** reformat() - rebuilds error.output using the other object properties. */ + reformat: () => string; + } + + export interface Output { + /** statusCode - the HTTP status code (typically 4xx or 5xx). */ + statusCode: number; + /** + * headers - an object containing any HTTP headers where each key is a header name and value is the header content. + * TODO can we limit value type any to string? + */ + headers: {[index: string]: any}; + /** payload - the formatted object used as the response payload (stringified). Can be directly manipulated but any changes will be lost if reformat() is called. Any content allowed and by default includes the following content: */ + payload: { + /** statusCode - the HTTP status code, derived from error.output.statusCode. */ + statusCode: number; + /** error - the HTTP status message (e.g. 'Bad Request', 'Internal Server Error') derived from statusCode. */ + error: string; + /** message - the error message derived from error.message. */ + message: string; + } + } + + /** + * Decorates an error with the boom properties + * @param error the error object to wrap. If error is already a boom object, returns back the same object. + * @param statusCode optional HTTP status code. Defaults to 500. + * @param message optional message string. If the error already has a message, it adds the message as a prefix. Defaults to no message. + * @see {@link https://github.com/hapijs/boom#wraperror-statuscode-message} + */ + export function wrap(error: Error, statusCode?: number, message?: string): BoomError; + + /** + * Generates an Error object with the boom decorations + * @param statusCode an HTTP error code number. Must be greater or equal 400. + * @param message optional message string. + * @param data additional error data set to error.data property. + * @see {@link https://github.com/hapijs/boom#createstatuscode-message-data} + */ + export function create(statusCode: number, message?: string, data?: any): BoomError; + + // 4xx + /** + * Returns a 400 Bad Request error + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boombadrequestmessage-data} + */ + export function badRequest(message?: string, data?: any): BoomError; + + /** + * Returns a 401 Unauthorized error + * @param message optional message. + * @param scheme can be one of the following: + * * an authentication scheme name + * * an array of string values. These values will be separated by ', ' and set to the 'WWW-Authenticate' header. + * @param attributes an object of values to use while setting the 'WWW-Authenticate' header. This value is only used when scheme is a string, otherwise it is ignored. Every key/value pair will be included in the 'WWW-Authenticate' in the format of 'key="value"' as well as in the response payload under the attributes key. Alternatively value can be a string which is use to set the value of the scheme, for example setting the token value for negotiate header. If string is used message parameter must be null. null and undefined will be replaced with an empty string. If attributes is set, message will be used as the 'error' segment of the 'WWW-Authenticate' header. If message is unset, the 'error' segment of the header will not be present and isMissing will be true on the error object. + * @see {@link https://github.com/hapijs/boom#boomunauthorizedmessage-scheme-attributes} + */ + export function unauthorized(message?: string, scheme?: string | string[], attributes?: {[index: string]: string}): BoomError; + export function unauthorized(message?: null, scheme?: string | string[], attributes?: string): BoomError; + + /** + * Returns a 402 Payment Required error + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boompaymentrequiredmessage-data} + */ + export function paymentRequired(message?: string, data?: any): BoomError; + + /** + * Returns a 403 Forbidden error + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boomforbiddenmessage-data} + */ + export function forbidden(message?: string, data?: any): BoomError; + + /** + * Returns a 404 Not Found error + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boomnotfoundmessage-data} + */ + export function notFound(message?: string, data?: any): BoomError; + + /** + * Returns a 405 Method Not Allowed error + * @param message optional message. + * @param data optional additional error data. + * @param allow optional string or array of strings (to be combined and separated by ', ') which is set to the 'Allow' header. + * @see {@link https://github.com/hapijs/boom#boommethodnotallowedmessage-data-allow} + */ + export function methodNotAllowed(message?: string, data?: any, allow?: string | string[]): BoomError; + + /** + * Returns a 406 Not Acceptable error + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boomnotacceptablemessage-data} + */ + export function notAcceptable(message?: string, data?: any): BoomError; + + /** + * Returns a 407 Proxy Authentication Required error + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boomproxyauthrequiredmessage-data} + */ + export function proxyAuthRequired(message?: string, data?: any): BoomError; + + /** + * Returns a 408 Request Time-out error + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boomclienttimeoutmessage-data} + */ + export function clientTimeout(message?: string, data?: any): BoomError; + + /** + * Returns a 409 Conflict error + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boomconflictmessage-data} + */ + export function conflict(message?: string, data?: any): BoomError; + + /** + * Returns a 410 Gone error + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boomresourcegonemessage-data} + */ + export function resourceGone(message?: string, data?: any): BoomError; + + /** + * Returns a 411 Length Required error + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boomlengthrequiredmessage-data} + */ + export function lengthRequired(message?: string, data?: any): BoomError; + + /** + * Returns a 412 Precondition Failed error + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boompreconditionfailedmessage-data} + */ + export function preconditionFailed(message?: string, data?: any): BoomError; + + /** + * Returns a 413 Request Entity Too Large error + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boomentitytoolargemessage-data} + */ + export function entityTooLarge(message?: string, data?: any): BoomError; + + /** + * Returns a 414 Request-URI Too Large error + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boomuritoolongmessage-data} + */ + export function uriTooLong(message?: string, data?: any): BoomError; + + /** + * Returns a 415 Unsupported Media Type error + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boomunsupportedmediatypemessage-data} + */ + export function unsupportedMediaType(message?: string, data?: any): BoomError; + + /** + * Returns a 416 Requested Range Not Satisfiable error + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boomrangenotsatisfiablemessage-data} + */ + export function rangeNotSatisfiable(message?: string, data?: any): BoomError; + + /** + * Returns a 417 Expectation Failed error + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boomexpectationfailedmessage-data} + */ + export function expectationFailed(message?: string, data?: any): BoomError; + + /** + * Returns a 418 I'm a Teapot error + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boomteapotmessage-data} + */ + export function teapot(message?: string, data?: any): BoomError; + + /** + * Returns a 422 Unprocessable Entity error + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boombaddatamessage-data} + */ + export function badData(message?: string, data?: any): BoomError; + + /** + * Returns a 423 Locked error + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boomlockedmessage-data} + */ + export function locked(message?: string, data?: any): BoomError; + + /** + * Returns a 428 Precondition Required error + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boompreconditionrequiredmessage-data} + */ + export function preconditionRequired(message?: string, data?: any): BoomError; + + /** + * Returns a 429 Too Many Requests error + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boomtoomanyrequestsmessage-data} + */ + export function tooManyRequests(message?: string, data?: any): BoomError; + + /** + * Returns a 451 Unavailable For Legal Reasons error + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boomillegalmessage-data} + */ + export function illegal(message?: string, data?: any): BoomError; + + // 5xx + /** + * Returns a 500 Internal Server Error error + * Only 500 errors will hide your message from the end user. Your message is recorded in the server log. + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boombadimplementationmessage-data---alias-internal} + */ + export function badImplementation(message?: string, data?: any): BoomError; + + /** + * Returns a 501 Not Implemented error with your error message to the user + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boomnotimplementedmessage-data} + */ + export function notImplemented(message?: string, data?: any): BoomError; + + /** + * Returns a 502 Bad Gateway error with your error message to the user + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boombadgatewaymessage-data} + */ + export function badGateway(message?: string, data?: any): BoomError; + + /** + * Returns a 503 Service Unavailable error with your error message to the user + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boomserverunavailablemessage-data} + */ + export function serverUnavailable(message?: string, data?: any): BoomError; + + /** + * Returns a 504 Gateway Time-out error with your error message to the user + * @param message optional message. + * @param data optional additional error data. + * @see {@link https://github.com/hapijs/boom#boomgatewaytimeoutmessage-data} + */ + export function gatewayTimeout(message?: string, data?: any): BoomError; +} diff --git a/types/boom/tsconfig.json b/types/boom/tsconfig.json new file mode 100644 index 0000000000..d64d51130b --- /dev/null +++ b/types/boom/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": false, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "boom-tests.ts" + ] +} \ No newline at end of file From b33942b17b4117f2fa5b2eae6ad3baa55323768f Mon Sep 17 00:00:00 2001 From: Alexander James Phillips Date: Mon, 3 Apr 2017 18:02:25 +0100 Subject: [PATCH 143/844] Update definition for inert 4.2 and add more tests --- types/inert/index.d.ts | 94 ++++++++++++++++++++++++++++++++++---- types/inert/inert-tests.ts | 23 ++++++++++ 2 files changed, 107 insertions(+), 10 deletions(-) diff --git a/types/inert/index.d.ts b/types/inert/index.d.ts index 9acbd6f1a7..d65b27e196 100644 --- a/types/inert/index.d.ts +++ b/types/inert/index.d.ts @@ -1,15 +1,89 @@ -// Type definitions for inert 4.0 +// Type definitions for inert 4.2 // Project: https://github.com/hapijs/inert/ -// Definitions by: Steve Ognibene +// Definitions by: Steve Ognibene , AJP // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -// Note: this definition contains only enough to make TypeScript happy (hapi?) when -// importing inert. The functionality that importing inert adds to the reply -// object and its other features are implemented in the hapi definition on -// DefinitelyTyped. The inert object is never actually used in practice except to -// be passed as an extension to the server.register() method which already takes -// an `any` argument, so just using `any` here is fine. +import * as hapi from 'hapi'; -/// +declare module 'hapi' { + interface IFileHandler { + /** path - a path string or function as described above (required). */ + path: string | IRequestHandler; + /** confine - serve file relative to this directory and returns 403 Forbidden if the path resolves outside the confine directory. Defaults to true which uses the relativeTo route option as the confine. Set to false to disable this security feature. */ + confine?: boolean; + /** filename - an optional filename to specify if sending a 'Content-Disposition' header, defaults to the basename of path */ + filename?: string; + /** + * mode - specifies whether to include the 'Content-Disposition' header with the response. Available values: + * * false - header is not included. This is the default value. + * * 'attachment' + * *'inline' + */ + mode?: false | 'attachment' | 'inline'; + /** lookupCompressed - if true, looks for for a pre-compressed version of the file with the same filename with an extension, depending on the accepted encoding. Defaults to false. */ + lookupCompressed?: boolean; + /** lookupMap - an object which maps content encoding to expected file name extension. Defaults to `{ gzip: '.gz' }. */ + lookupMap?: {[index: string]: string}; + /** + * etagMethod - specifies the method used to calculate the ETag header response. Available values: + * * 'hash' - SHA1 sum of the file contents, suitable for distributed deployments. Default value. + * * 'simple' - Hex encoded size and modification date, suitable when files are stored on a single server. + * * false - Disable ETag computation. + */ + etagMethod?: 'hash' | 'simple' | false; + /** start - offset in file to reading from, defaults to 0. */ + start?: number; + /** end - offset in file to stop reading from. If not set, will read to end of file. */ + end?: number; + } -export const inert: any; + interface IDirectoryHandler { + // TODO check if function returns error, what this type can be or is it raising an error which is caught? + /** path - (required) the directory root path (relative paths are resolved based on the route files configuration). Value can be: */ + path: string | string[] | IRequestHandler | IRequestHandler; + /** + * index - optional boolean|string|string[], determines if an index file will be served if found in the folder when requesting a directory. The given string or strings specify the name(s) of the index file to look for. If true, looks for 'index.html'. Any falsy value disables index file lookup. Defaults to true. + * * a single path string used as the prefix for any resources requested by appending the request path parameter to the provided string. + * * an array of path strings. Each path will be attempted in order until a match is found (by following the same process as the single path string). + * * a function with the signature function(request) which returns the path string or an array of path strings. If the function returns an error, the error is passed back to the client in the response. + */ + index?: boolean | string | string[]; + /** listing - optional boolean, determines if directory listing is generated when a directory is requested without an index document. Defaults to false. */ + listing?: boolean; + /** showHidden - optional boolean, determines if hidden files will be shown and served. Defaults to false. */ + showHidden?: boolean; + /** redirectToSlash - optional boolean, determines if requests for a directory without a trailing slash are redirected to the same path with the missing slash. Useful for ensuring relative links inside the response are resolved correctly. Disabled when the server config router.stripTrailingSlash is true.Defaults to false. */ + redirectToSlash?: boolean; + /** lookupCompressed - optional boolean, instructs the file processor to look for the same filename with the '.gz' suffix for a pre-compressed version of the file to serve if the request supports content encoding. Defaults to false. */ + lookupCompressed?: boolean; + /** + * etagMethod - specifies the method used to calculate the ETag header response. Available values: + * * 'hash' - SHA1 sum of the file contents, suitable for distributed deployments. Default value. + * * 'simple' - Hex encoded size and modification date, suitable when files are stored on a single server. + * * false - Disable ETag computation. + */ + etagMethod?: 'hash' | 'simple' | false; + /** defaultExtension - optional string, appended to file requests if the requested file is not found. Defaults to no extension. */ + defaultExtension?: string; + } + + interface IRouteConfiguration { + /** + * The file handler + * + * Generates a static file endpoint for serving a single file. file can be set to: + * * a relative or absolute file path string (relative paths are resolved based on the route files configuration). + * * a function with the signature function(request) which returns the relative or absolute file path. + * * an object with one or more of the following options: + * @see {@link https://github.com/hapijs/inert#the-file-handler} + */ + file?: string | IRequestHandler | IFileHandler; + /** + * The directory handler + * + * Generates a directory endpoint for serving static content from a directory. Routes using the directory handler must include a path parameter at the end of the path string (e.g. /path/to/somewhere/{param} where the parameter name does not matter). The path parameter can use any of the parameter options (e.g. {param} for one level files only, {param?} for one level files or the directory root, {param*} for any level, or {param*3} for a specific level). If additional path parameters are present, they are ignored for the purpose of selecting the file system resource. The directory handler is an object with the following options: + * @see {@link https://github.com/hapijs/inert#the-directory-handler} + */ + directory?: IDirectoryHandler; + } +} diff --git a/types/inert/inert-tests.ts b/types/inert/inert-tests.ts index e917fb9e41..0741065d20 100644 --- a/types/inert/inert-tests.ts +++ b/types/inert/inert-tests.ts @@ -3,3 +3,26 @@ import * as InertES6 from 'inert'; const server = new HapiES6.Server({}); server.register(InertES6, () => {}); + +server.route({ + path: '', + method: 'GET', + file: { + path: '', + confine: true, + }, + directory: { + path: '', + listing: true + } +}) + +var fileHandler: HapiES6.IFileHandler = { + path: '', + confine: true, +} + +var directoryHandler: HapiES6.IDirectoryHandler = { + path: '', + listing: true, +} From 8cc99268058c93851f6523db4a3476ecc4992f60 Mon Sep 17 00:00:00 2001 From: Alexander James Phillips Date: Mon, 3 Apr 2017 20:16:47 +0100 Subject: [PATCH 144/844] Correct documentation of path option of directory handler --- types/inert/index.d.ts | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/types/inert/index.d.ts b/types/inert/index.d.ts index d65b27e196..949b3610af 100644 --- a/types/inert/index.d.ts +++ b/types/inert/index.d.ts @@ -38,15 +38,14 @@ declare module 'hapi' { } interface IDirectoryHandler { - // TODO check if function returns error, what this type can be or is it raising an error which is caught? - /** path - (required) the directory root path (relative paths are resolved based on the route files configuration). Value can be: */ - path: string | string[] | IRequestHandler | IRequestHandler; - /** - * index - optional boolean|string|string[], determines if an index file will be served if found in the folder when requesting a directory. The given string or strings specify the name(s) of the index file to look for. If true, looks for 'index.html'. Any falsy value disables index file lookup. Defaults to true. + /** path - (required) the directory root path (relative paths are resolved based on the route files configuration). Value can be: * * a single path string used as the prefix for any resources requested by appending the request path parameter to the provided string. * * an array of path strings. Each path will be attempted in order until a match is found (by following the same process as the single path string). * * a function with the signature function(request) which returns the path string or an array of path strings. If the function returns an error, the error is passed back to the client in the response. + * TODO check what type of Error the "function returns an error" can be or is it raising an error which is caught? */ + path: string | string[] | IRequestHandler | IRequestHandler; + /** index - optional boolean|string|string[], determines if an index file will be served if found in the folder when requesting a directory. The given string or strings specify the name(s) of the index file to look for. If true, looks for 'index.html'. Any falsy value disables index file lookup. Defaults to true. */ index?: boolean | string | string[]; /** listing - optional boolean, determines if directory listing is generated when a directory is requested without an index document. Defaults to false. */ listing?: boolean; From 2b5bb39244616309aeabb1a4d79c2676ceacfb09 Mon Sep 17 00:00:00 2001 From: Kieran Peat Date: Mon, 3 Apr 2017 22:44:55 +0100 Subject: [PATCH 145/844] React-data-grid: adding in onRowClick (#15220) * adding in onRowClick * typo * updating to keep v1 and fixing addons for v2 * adding in column cellClass and getRowMetaData * adding in test for getRowMetaData * fixing test * adding filterRenderer * fixing silly mistakes --- types/react-data-grid/index.d.ts | 39 +- .../react-data-grid/react-data-grid-tests.tsx | 42 +- types/react-data-grid/v1/index.d.ts | 501 ++++++++++++++++++ .../v1/react-data-grid-tests.tsx | 285 ++++++++++ types/react-data-grid/v1/tsconfig.json | 27 + 5 files changed, 880 insertions(+), 14 deletions(-) create mode 100644 types/react-data-grid/v1/index.d.ts create mode 100644 types/react-data-grid/v1/react-data-grid-tests.tsx create mode 100644 types/react-data-grid/v1/tsconfig.json diff --git a/types/react-data-grid/index.d.ts b/types/react-data-grid/index.d.ts index 3ec11776f9..3db701477b 100644 --- a/types/react-data-grid/index.d.ts +++ b/types/react-data-grid/index.d.ts @@ -1,8 +1,8 @@ -// Type definitions for react-data-grid 1.0.4 +// Type definitions for react-data-grid 2.0 // Project: https://github.com/adazzle/react-data-grid.git -// Definitions by: Simon Gellis +// Definitions by: Simon Gellis , Kieran Peat // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -// TypeScript Version: 2.1 +// TypeScript Version: 2.2 /// @@ -18,7 +18,7 @@ declare namespace AdazzleReactDataGrid { * Gets the data to render in each row. Required. * Can be an array or a function that takes an index and returns an object. */ - rowGetter: Array | ((rowIdx: number) => Object) + rowGetter: Array | ((rowIdx: number) => object) /** * The total number of rows to render. Required. */ @@ -148,7 +148,7 @@ declare namespace AdazzleReactDataGrid { * Called when a row is selected. * @param rows The (complete) current selection of rows. */ - onRowSelect?: (rows: Array) => void + onRowSelect?: (rows: Array) => void /** * A property that's unique to every row. * This property is required to enable row selection. @@ -191,6 +191,13 @@ declare namespace AdazzleReactDataGrid { isSelectedKey?: string; } } + /** + * An event function called when a row is clicked. + * Clicking the header row will trigger a call with -1 for the rowIdx. + * @param rowIdx zero index number of row clicked + * @param row object behind the row + */ + onRowClick?: (rowIdx : number, row : object) => void } /** @@ -235,7 +242,11 @@ declare namespace AdazzleReactDataGrid { * Whether the rows in the grid can be filtered by this column. * @default false */ - filterable?: boolean + filterable?: boolean; + /** + * A custom formatter for this column's filter. + */ + filterRenderer?: React.ReactElement | React.ComponentClass | React.StatelessComponent; /** * The editor for this column. Several editors are available in "react-data-grid/addons". * @default A simple text editor @@ -258,6 +269,14 @@ declare namespace AdazzleReactDataGrid { events?: { [name: string]: ColumnEventCallback } + /** + * Retrieve meta data about the row, optionally provide column as a second argument + */ + getRowMetaData?: (rowdata: any, column?: Column) => any; + /** + * A class name to be applied to the cells in the column + */ + cellClass?: string; } interface ColumnEventCallback { @@ -280,7 +299,7 @@ declare namespace AdazzleReactDataGrid { /** * The columns that were updated and their values. */ - updated: Object + updated: object /** * The name of the column that was updated. */ @@ -328,7 +347,7 @@ declare namespace AdazzleReactDataGrid { /** * The values of the row. */ - rowData: Object + rowData: object /** * The double click event. */ @@ -380,7 +399,7 @@ declare namespace AdazzleReactDataGrid { /** * The columns that were updated and their values. */ - updated: Object + updated: object /** * The action that occurred to trigger this event. * One of 'cellUpdate', 'cellDrag', 'columnFill', or 'copyPaste'. @@ -472,7 +491,7 @@ declare module "react-data-grid" { export = ReactDataGrid; } -declare module "react-data-grid/addons" { +declare module "react-data-grid-addons" { import Plugins = AdazzleReactDataGridPlugins; import Editors = Plugins.Editors; import Formatters = Plugins.Formatters; diff --git a/types/react-data-grid/react-data-grid-tests.tsx b/types/react-data-grid/react-data-grid-tests.tsx index bff860ee02..287a74c449 100644 --- a/types/react-data-grid/react-data-grid-tests.tsx +++ b/types/react-data-grid/react-data-grid-tests.tsx @@ -1,6 +1,6 @@ import * as React from 'react'; import * as ReactDataGrid from 'react-data-grid'; -import * as ReactDataGridPlugins from 'react-data-grid/addons'; +import * as ReactDataGridPlugins from 'react-data-grid-addons'; import faker = require('faker'); var Editors = ReactDataGridPlugins.Editors; @@ -8,6 +8,29 @@ var Toolbar = ReactDataGridPlugins.Toolbar; var AutoCompleteEditor = Editors.AutoComplete; var DropDownEditor = Editors.DropDownEditor; + +class CustomFilterHeaderCell extends React.Component { + constructor(props: any, context: any) { + super(props, context); + + this.state = { + filterTerm: "" + }; + } + handleChange(e: any) { + let val = e.target.value; + this.setState({filterTerm: val}); + this.props.onChange({filterTerm: val, column: this.props.column}); + } + render() { + return ( +
    + this.handleChange(e)} /> +
    + ); + } +} + faker.locale = 'en_GB'; function createFakeRowObjectData(index:number):Object { @@ -103,7 +126,10 @@ var columns:ReactDataGrid.Column[] = [ name: 'County', editor: , width: 200, - resizable: true + resizable: true, + getRowMetaData: (rowdata: any, column: ReactDataGrid.Column) => { + return {}; + } }, { key: 'title', @@ -178,14 +204,17 @@ var columns:ReactDataGrid.Column[] = [ name: 'Company Name', editable: true, width: 200, - resizable: true + resizable: true, + filterable: true, + filterRenderer: CustomFilterHeaderCell }, { key: 'sentence', name: 'Sentence', editable: true, width: 200, - resizable: true + resizable: true, + cellClass: 'sentence-class' } ]; @@ -220,6 +249,10 @@ class Example extends React.Component { this.setState({rows: rows}); } + onRowClick(rowIdx:number, row: Object) { + // Do nothing, just test that it accepts an event + } + handleAddRow(e:any) { var newRow = { value: e.newRowIndex, @@ -278,6 +311,7 @@ class Example extends React.Component { keys: {rowKey: 'id', values: selectedRows} } }} + onRowClick={this.onRowClick} /> ); diff --git a/types/react-data-grid/v1/index.d.ts b/types/react-data-grid/v1/index.d.ts new file mode 100644 index 0000000000..3ec11776f9 --- /dev/null +++ b/types/react-data-grid/v1/index.d.ts @@ -0,0 +1,501 @@ +// Type definitions for react-data-grid 1.0.4 +// Project: https://github.com/adazzle/react-data-grid.git +// Definitions by: Simon Gellis +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.1 + +/// + +declare namespace AdazzleReactDataGrid { + + interface SelectionParams { + rowIdx: number, + row: any + } + + interface GridProps { + /** + * Gets the data to render in each row. Required. + * Can be an array or a function that takes an index and returns an object. + */ + rowGetter: Array | ((rowIdx: number) => Object) + /** + * The total number of rows to render. Required. + */ + rowsCount: number + /** + * The columns to render. + */ + columns?: Array + + /** + * Invoked when the user changes the value of a single cell. + * Should update that cell's value. + * @param e Information about the event + */ + onRowUpdated?: (e: RowUpdateEvent) => void + /** + * Invoked when the user pulls down the drag handle of an editable cell. + * Should update the values of the selected cells. + * @param e Information about the event + */ + onCellsDragged?: (e: CellDragEvent) => void + /** + * Invoked when the user double clicks on the drag handle of an editable cell. + * Should update the values of the cells beneath the selected cell. + * @param e Information about the event + */ + onDragHandleDoubleClick?: (e: DragHandleDoubleClickEvent) => void + /** + * Invoked when the user copies a value from one cell and pastes it into another (in the same column). + * Should update the value of the cell in row e.toRow. + * @param e Information about the event + */ + onCellCopyPaste?: (e: CellCopyPasteEvent) => void + /** + * Invoked after the user updates the grid rows in any way. + * @param e Information about the event + */ + onGridRowsUpdated?: (e: GridRowsUpdatedEvent) => void + + /** + * A toolbar to display above the grid. + * Consider using the toolbar included in "react-data-grid/addons". + */ + toolbar?: React.ReactElement + /** + * A context menu to disiplay when the user right-clicks a cell. + * Consider using "react-contextmenu", included in "react-data-grid/addons". + */ + contextMenu?: React.ReactElement + /** + * A react component to customize how rows are rendered. + * If you want to define your own, consider extending ReactDataGrid.Row. + */ + rowRenderer?: React.ReactElement | React.ComponentClass | React.StatelessComponent + /** + * A component to display when there are no rows to render. + */ + emptyRowsView?: React.ComponentClass | React.StatelessComponent + + /** + * The minimum width of the entire grid in pixels. + */ + minWidth?: number + /** + * The minimum height of the entire grid in pixels. + * @default 350 + */ + minHeight?: number + /** + * The height of each individual row in pixels. + * @default 35 + */ + rowHeight?: number + /** + * The height of the header row in pixels. + * @default rowHeight + */ + headerRowHeight?: number + /** + * The minimum width of each column in pixels. + * @default 80 + */ + minColumnWidth?: number + /** + * Invoked when a column has been resized. + * @param index The index of the column + * @param width The new width of the column + */ + onColumnResize?: (index: number, width: number) => void + + /** + * Controls what happens when the user navigates beyond the first or last cells. + * 'loopOverRow' will navigate to the beginning/end of the current row. + * 'changeRow' will navigate to the beginning of the next row or the end of the last. + * 'none' will do nothing. + * @default none + */ + cellNavigationMode?: 'none' | 'loopOverRow' | 'changeRow' + + /** + * Called when the user sorts the grid by some column. + * Should update the order of the rows returned by rowGetter. + * @param sortColumn The name of the column being sorted by + * @param sortDirection The direction to sort ('ASC'/'DESC'/'NONE') + */ + onGridSort?: (sortColumn: string, sortDirection: 'ASC' | 'DESC' | 'NONE') => void + /** + * Called when the user filters a column by some value. + * Should restrict the rows in rowGetter to only things that match the filter. + * @param filter The filter being added + */ + onAddFilter?: (filter: Filter) => void + /** + * Called when the user clears all filters. + * Should restore the rows in rowGetter to their original state. + */ + onClearFilters?: () => void + + /** + * When set to true or 'multi', enables multiple row select. + * When set to 'single', enables single row select. + * When set to false or not set, disables row select. + * @default false + */ + enableRowSelect?: boolean | 'single' | 'multi' + /** + * Called when a row is selected. + * @param rows The (complete) current selection of rows. + */ + onRowSelect?: (rows: Array) => void + /** + * A property that's unique to every row. + * This property is required to enable row selection. + * @default 'id' + */ + rowKey?: string + + /** + * Enables cells to be selected when clicked. + * @default false + */ + enableCellSelect?: boolean + /** + * Called when a cell is selected. + * @param coordinates The row and column indices of the selected cell. + */ + onCellSelected?: (coordinates: {rowIdx: number, idx: number}) => void + /** + * Called when a cell is deselected. + * @param coordinates The row and column indices of the deselected cell. + */ + onCellDeSelected?: (coordinates: {rowIdx: number, idx: number}) => void + + /** + * How long to wait before rendering a new row while scrolling in milliseconds. + * @default 0 + */ + rowScrollTimeout?: number + /** + * Options object for selecting rows + */ + rowSelection?: { + showCheckbox?: boolean + enableShiftSelect?: boolean + onRowsSelected?: (rows: Array) => void, + onRowsDeselected?: (rows: Array) => void, + selectBy?: { + indexes?: Array; + keys?: { rowKey: string, values: Array }; + isSelectedKey?: string; + } + } + } + + /** + * Information about a specific column to be rendered. + */ + interface Column { + /** + * A unique key for this column. Required. + * Each row should have a property with this name, which contains this column's value. + */ + key: string + /** + * This column's display name. Required. + */ + name: string + /** + * A custom width for this specific column. + * @default minColumnWidth from the ReactDataGrid + */ + width?: number + /** + * Whether this column can be resized by the user. + * @default false + */ + resizable?: boolean + /** + * Whether this column should stay fixed on the left as the user scrolls horizontally. + * @default false + */ + locked?: boolean + /** + * Whether this column can be edited. + * @default false + */ + editable?: boolean + /** + * Whether the rows in the grid can be sorted by this column. + * @default false + */ + sortable?: boolean + /** + * Whether the rows in the grid can be filtered by this column. + * @default false + */ + filterable?: boolean + /** + * The editor for this column. Several editors are available in "react-data-grid/addons". + * @default A simple text editor + */ + editor?: React.ReactElement + /** + * A custom read-only formatter for this column. An image formatter is available in "react-data-grid/addons". + */ + formatter?: React.ReactElement | React.ComponentClass | React.StatelessComponent + /** + * A custom formatter for this column's header. + */ + headerRenderer?: React.ReactElement | React.ComponentClass | React.StatelessComponent + /** + * Events to be bound to the cells in this specific column. + * Each event must respect this standard in order to work correctly: + * @example + * function onXxx(ev :SyntheticEvent, (rowIdx, idx, name): args) + */ + events?: { + [name: string]: ColumnEventCallback + } + } + + interface ColumnEventCallback { + /** + * A callback for a native react event on a specific cell. + * @param ev The react event + * @param args The row and column coordinates of the cell, and the name of the event. + */ + (ev: React.SyntheticEvent, args: {rowIdx: number, idx: number, name: string}): void + } + + /** + * Information about a row update + */ + interface RowUpdateEvent { + /** + * The index of the updated row. + */ + rowIdx: number + /** + * The columns that were updated and their values. + */ + updated: Object + /** + * The name of the column that was updated. + */ + cellKey: string + /** + * The name of the key pressed to trigger the event ('Tab', 'Enter', etc.). + */ + key: string + } + + /** + * Information about a cell drag + */ + interface CellDragEvent { + /** + * The name of the column that was dragged. + */ + cellKey: string + /** + * The row where the drag began. + */ + fromRow: number + /** + * The row where the drag ended. + */ + toRow: number + /** + * The value of the cell that was dragged. + */ + value: any + } + + /** + * Information about a drag handle double click + */ + interface DragHandleDoubleClickEvent { + /** + * The row where the double click occurred. + */ + rowIdx: number + /** + * The column where the double click occurred. + */ + idx: number + /** + * The values of the row. + */ + rowData: Object + /** + * The double click event. + */ + e: React.SyntheticEvent + } + + /** + * Information about a copy paste + */ + interface CellCopyPasteEvent { + /** + * The row that was pasted to. + */ + rowIdx: number + /** + * The value that was pasted. + */ + value: any + /** + * The row that was copied from. + */ + fromRow: number + /** + * The row that was pasted to. + */ + toRow: number + /** + * The key of the column where the copy paste occurred. + */ + cellKey: string + } + + /** + * Information about some update to the grid's contents + */ + interface GridRowsUpdatedEvent { + /** + * The key of the column where the event occurred. + */ + cellKey: string + /** + * The top row affected by the event. + */ + fromRow: number + /** + * The bottom row affected by the event. + */ + toRow: number + /** + * The columns that were updated and their values. + */ + updated: Object + /** + * The action that occurred to trigger this event. + * One of 'cellUpdate', 'cellDrag', 'columnFill', or 'copyPaste'. + */ + action: 'cellUpdate' | 'cellDrag' | 'columnFill' | 'copyPaste' + } + + /** + * Some filter to be applied to the grid's contents + */ + interface Filter { + /** + * The key of the column being filtered. + */ + columnKey: string + /** + * The term to filter by. + */ + filterTerm: string + } + + /** + * Excel-like grid component built with React, with editors, keyboard navigation, copy & paste, and the like + * http://adazzle.github.io/react-data-grid/ + */ + export class ReactDataGrid extends React.Component { } + export namespace ReactDataGrid { + // Useful types + export import Column = AdazzleReactDataGrid.Column; + export import Filter = AdazzleReactDataGrid.Filter; + + // Various events + export import RowUpdateEvent = AdazzleReactDataGrid.RowUpdateEvent; + export import SelectionParams = AdazzleReactDataGrid.SelectionParams; + export import CellDragEvent = AdazzleReactDataGrid.CellDragEvent; + export import DragHandleDoubleClickEvent = AdazzleReactDataGrid.DragHandleDoubleClickEvent; + export import CellCopyPasteEvent = AdazzleReactDataGrid.CellCopyPasteEvent; + export import GridRowsUpdatedEvent = AdazzleReactDataGrid.GridRowsUpdatedEvent; + + // Actual classes exposed on module.exports + /** + * A react component that renders a row of the grid + */ + export class Row extends React.Component { } + /** + * A react coponent that renders a cell of the grid + */ + export class Cell extends React.Component { } + } +} + +declare namespace AdazzleReactDataGridPlugins { + // TODO: refine types for these addons + export namespace Editors { + export class AutoComplete extends React.Component { } + export class DropDownEditor extends React.Component { } + export class SimpleTextEditor extends React.Component { } + export class CheckboxEditor extends React.Component { } + } + export namespace Formatters { + export class ImageFormatter extends React.Component { } + export class DropDownFormatter extends React.Component { } + } + export class Toolbar extends React.Component {} + // TODO: re-export the react-contextmenu typings once those exist + // https://github.com/vkbansal/react-contextmenu/issues/10 + export namespace Menu { + export class ContextMenu extends React.Component { } + export class MenuHeader extends React.Component { } + export class MenuItem extends React.Component { } + export class SubMenu extends React.Component { } + export const monitor: { + getItem(): any + getPosition(): any + hideMenu(): void + }; + export function connect(Menu: any): any; + export function ContextMenuLayer( + identifier: any, + configure?: (props: any) => any + ): (Component: any) => any + } +} + +declare module "react-data-grid" { + import ReactDataGrid = AdazzleReactDataGrid.ReactDataGrid; + + // commonjs export + export = ReactDataGrid; +} + +declare module "react-data-grid/addons" { + import Plugins = AdazzleReactDataGridPlugins; + import Editors = Plugins.Editors; + import Formatters = Plugins.Formatters; + import Toolbar = Plugins.Toolbar; + import Menu = Plugins.Menu; + + // ES6 named exports + export { + Editors, + Formatters, + Toolbar, + Menu + } + + // attach to window + global { + interface Window { + ReactDataGridPlugins: { + Editors: typeof Editors + Formatters: typeof Formatters + Toolbar: typeof Toolbar + Menu: typeof Menu + } + } + } +} diff --git a/types/react-data-grid/v1/react-data-grid-tests.tsx b/types/react-data-grid/v1/react-data-grid-tests.tsx new file mode 100644 index 0000000000..bff860ee02 --- /dev/null +++ b/types/react-data-grid/v1/react-data-grid-tests.tsx @@ -0,0 +1,285 @@ +import * as React from 'react'; +import * as ReactDataGrid from 'react-data-grid'; +import * as ReactDataGridPlugins from 'react-data-grid/addons'; +import faker = require('faker'); + +var Editors = ReactDataGridPlugins.Editors; +var Toolbar = ReactDataGridPlugins.Toolbar; +var AutoCompleteEditor = Editors.AutoComplete; +var DropDownEditor = Editors.DropDownEditor; + +faker.locale = 'en_GB'; + +function createFakeRowObjectData(index:number):Object { + return { + id: 'id_' + index, + avartar: faker.image.avatar(), + county: faker.address.county(), + email: faker.internet.email(), + title: faker.name.prefix(), + firstName: faker.name.firstName(), + lastName: faker.name.lastName(), + street: faker.address.streetName(), + zipCode: faker.address.zipCode(), + date: faker.date.past().toLocaleDateString(), + bs: faker.company.bs(), + catchPhrase: faker.company.catchPhrase(), + companyName: faker.company.companyName(), + words: faker.lorem.words(), + sentence: faker.lorem.sentence() + }; +} + +function createRows(numberOfRows:number) { + var rows:Object[] = []; + for (var i = 0; i < numberOfRows; i++) { + rows[i] = createFakeRowObjectData(i); + } + return rows; +} + +var counties = [ + {id: 0, title: 'Bedfordshire'}, + {id: 1, title: 'Berkshire'}, + {id: 2, title: 'Buckinghamshire'}, + {id: 3, title: 'Cambridgeshire'}, + {id: 4, title: 'Cheshire'}, + {id: 5, title: 'Cornwall'}, + {id: 6, title: 'Cumbria, (Cumberland)'}, + {id: 7, title: 'Derbyshire'}, + {id: 8, title: 'Devon'}, + {id: 9, title: 'Dorset'}, + {id: 10, title: 'Durham'}, + {id: 11, title: 'Essex'}, + {id: 12, title: 'Gloucestershire'}, + {id: 13, title: 'Hampshire'}, + {id: 14, title: 'Hertfordshire'}, + {id: 15, title: 'Huntingdonshire'}, + {id: 16, title: 'Kent'}, + {id: 17, title: 'Lancashire'}, + {id: 18, title: 'Leicestershire'}, + {id: 19, title: 'Lincolnshire'}, + {id: 20, title: 'Middlesex'}, + {id: 21, title: 'Norfolk'}, + {id: 22, title: 'Northamptonshire'}, + {id: 23, title: 'Northumberland'}, + {id: 24, title: 'Nottinghamshire'}, + {id: 25, title: 'Northamptonshire'}, + {id: 26, title: 'Oxfordshire'}, + {id: 27, title: 'Northamptonshire'}, + {id: 28, title: 'Rutland'}, + {id: 29, title: 'Shropshire'}, + {id: 30, title: 'Somerset'}, + {id: 31, title: 'Staffordshire'}, + {id: 32, title: 'Suffolk'}, + {id: 33, title: 'Surrey'}, + {id: 34, title: 'Sussex'}, + {id: 35, title: 'Warwickshire'}, + {id: 36, title: 'Westmoreland'}, + {id: 37, title: 'Wiltshire'}, + {id: 38, title: 'Worcestershire'}, + {id: 39, title: 'Yorkshire'} +]; + +var titles = ['Dr.', 'Mr.', 'Mrs.', 'Miss', 'Ms.']; + +var columns:ReactDataGrid.Column[] = [ + { + key: 'id', + name: 'ID', + width: 80, + resizable: true + }, + { + key: 'avartar', + name: 'Avartar', + width: 60, + formatter: ReactDataGridPlugins.Formatters.ImageFormatter, + resizable: true, + headerRenderer: + }, + { + key: 'county', + name: 'County', + editor: , + width: 200, + resizable: true + }, + { + key: 'title', + name: 'Title', + editor: , + width: 200, + resizable: true, + events: { + onDoubleClick: function () { + console.log("The user double clicked on title column"); + } + } + }, + { + key: 'firstName', + name: 'First Name', + editable: true, + width: 200, + resizable: true + }, + { + key: 'lastName', + name: 'Last Name', + editable: true, + width: 200, + resizable: true + }, + { + key: 'email', + name: 'Email', + editable: true, + width: 200, + resizable: true + }, + { + key: 'street', + name: 'Street', + editable: true, + width: 200, + resizable: true + }, + { + key: 'zipCode', + name: 'ZipCode', + editable: true, + width: 200, + resizable: true + }, + { + key: 'date', + name: 'Date', + editable: true, + width: 200, + resizable: true + }, + { + key: 'bs', + name: 'bs', + editable: true, + width: 200, + resizable: true + }, + { + key: 'catchPhrase', + name: 'Catch Phrase', + editable: true, + width: 200, + resizable: true + }, + { + key: 'companyName', + name: 'Company Name', + editable: true, + width: 200, + resizable: true + }, + { + key: 'sentence', + name: 'Sentence', + editable: true, + width: 200, + resizable: true + } +]; + +class Example extends React.Component { + getInitialState() { + var fakeRows = createRows(2000); + return {rows: fakeRows}; + } + + getColumns() { + var clonedColumns = columns.slice(); + clonedColumns[2].events = { + onClick: function (ev:React.SyntheticEvent, args:{idx:number, rowIdx:number}) { + var idx = args.idx; + var rowIdx = args.rowIdx; + this.refs.grid.openCellEditor(rowIdx, idx); + }.bind(this) + }; + + return clonedColumns; + } + + handleGridRowsUpdated(updatedRowData:ReactDataGrid.GridRowsUpdatedEvent) { + var rows = this.state.rows; + + for (var i = updatedRowData.fromRow; i <= updatedRowData.toRow; i++) { + var rowToUpdate = rows[i]; + var updatedRow = Object.assign({}, rowToUpdate, updatedRowData.updated); + rows[i] = updatedRow; + } + + this.setState({rows: rows}); + } + + handleAddRow(e:any) { + var newRow = { + value: e.newRowIndex, + userStory: '', + developer: '', + epic: '' + }; + var rows = this.state.rows; + rows.push(newRow); + this.setState({rows: rows}); + } + + getRowAt(index:number) { + if (index < 0 || index > this.getSize()) { + return undefined; + } + return this.state.rows[index]; + } + + getSize() { + return this.state.rows.length; + } + + onRowsSelected(rows: Array) { + var selectedIndexes = this.state.selectedIndexes as Array; + + this.setState({selectedIndexes: selectedIndexes.concat(rows.map(r => r.rowIdx))}); + } + onRowsDeselected(rows: Array) { + var rowIndexes = rows.map(r => r.rowIdx); + var selectedIndexes = this.state.selectedIndexes as Array; + this.setState({selectedIndexes: selectedIndexes.filter(i => rowIndexes.indexOf(i) === -1 )}); + } + + render() { + let selectedRows = ['id1', 'id2']; + return ( + } + enableRowSelect={true} + rowHeight={50} + minHeight={600} + rowScrollTimeout={200} + rowSelection={{ + showCheckbox: true, + enableShiftSelect: true, + onRowsSelected: this.onRowsSelected, + onRowsDeselected: this.onRowsDeselected, + selectBy: { + keys: {rowKey: 'id', values: selectedRows} + } + }} + /> + + ); + } +} diff --git a/types/react-data-grid/v1/tsconfig.json b/types/react-data-grid/v1/tsconfig.json new file mode 100644 index 0000000000..96020e8aac --- /dev/null +++ b/types/react-data-grid/v1/tsconfig.json @@ -0,0 +1,27 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6", + "dom" + ], + "noImplicitAny": true, + "noImplicitThis": false, + "strictNullChecks": false, + "baseUrl": "../../", + "jsx": "react", + "typeRoots": [ + "../../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "paths": { + "react-data-grid": [ "react-data-grid/v1" ] + } + }, + "files": [ + "index.d.ts", + "react-data-grid-tests.tsx" + ] +} From 15e2aafb62abda365bd68d7757063605231717cd Mon Sep 17 00:00:00 2001 From: Syncfusion-JavaScript Date: Tue, 4 Apr 2017 09:40:07 +0530 Subject: [PATCH 146/844] Lint errors fixed --- types/ej.web.all/index.d.ts | 6874 ++++++++++++++++------------------- 1 file changed, 3227 insertions(+), 3647 deletions(-) diff --git a/types/ej.web.all/index.d.ts b/types/ej.web.all/index.d.ts index 8328f30d95..ae27436c9d 100644 --- a/types/ej.web.all/index.d.ts +++ b/types/ej.web.all/index.d.ts @@ -12,11 +12,10 @@ * Use of this code is subject to the terms of our license. * A copy of the current license can be obtained at any time by e-mailing * licensing@syncfusion.com. Any infringement will be prosecuted under -* applicable laws. +* applicable laws. */ -declare module ej { - - var dataUtil: dataUtil; +declare namespace ej { + const dataUtil: dataUtil; function isMobile(): boolean; function isIOS(): boolean; function isAndroid(): boolean; @@ -29,33 +28,33 @@ declare module ej { function isTouchDevice(): boolean; function addPrefix(style: string): string; function animationEndEvent(): string; - function blockDefaultActions(e: Object): void; - function buildTag(tag: string, innerHtml?: string, styles?: Object, attrs?: Object): JQuery; + function blockDefaultActions(e: any): void; + function buildTag(tag: string, innerHtml?: string, styles?: any, attrs?: any): JQuery; function cancelEvent(): string; function copyObject(): string; - function createObject(nameSpace: string, value: Object, initIn: any): JQuery; + function createObject(nameSpace: string, value: any, initIn: any): JQuery; function createObject(element: any, eventEmitter: any, model: any): any; function setCulture(culture: string): void; - function getObject(element :string, model :any ): T; - function defineClass(className: string, constructor:any, proto: Object, replace: boolean): Object; - function destroyWidgets(element: Object): void; + function getObject(element: string, model: any ): T; + function getObject(nameSpace: string, fromdata?: any): any; + function defineClass(className: string, constructor: any, proto: any, replace: boolean): any; + function destroyWidgets(element: any): void; function endEvent(): string; - function event(type: string, data: any, eventProp: Object): Object; - function getAndroidVersion(): Object; - function getAttrVal(ele: Object, val: string, option: Object): Object; - function getBooleanVal(ele: Object, val: string, option: Object): Object; + function event(type: string, data: any, eventProp: any): any; + function getAndroidVersion(): any; + function getAttrVal(ele: any, val: string, option: any): any; + function getBooleanVal(ele: any, val: string, option: any): any; function getClearString(): string; - function getDimension(element: Object, method: string): Object; - function getFontString(fontObj: Object): string; + function getDimension(element: any, method: string): any; + function getFontString(fontObj: any): string; function getFontStyle(style: string): string; function getMaxZindex(): number; function getNameSpace(className: string): string; - function getObject(nameSpace: string, fromdata?: any): Object; - function getOffset(ele: string): Object; + function getOffset(ele: string): any; function getRenderMode(): string; - function getScrollableParents(element: Object): void; + function getScrollableParents(element: any): void; function getTheme(): string; - function getZindexPartial(element: Object, popupEle: string): number; + function getZindexPartial(element: any, popupEle: string): number; function hasRenderMode(element: string): void; function hasStyle(prop: string): boolean; function hasTheme(element: string): string; @@ -66,91 +65,90 @@ declare module ej { function isIOS7(): boolean; function isIOSWebView(): boolean; function isLowerAndroid(): boolean; - function isNullOrUndefined(value: Object): boolean; + function isNullOrUndefined(value: any): boolean; function isPlainObject(): JQuery; function isPortrait(): any; function isTablet(): boolean; function isWindowsWebView(): string; - function listenEvents(selectors:any, eventTypes: any, handlers: any, remove?: any, pluginObj?: any, disableMouse?: boolean): void; - function listenTouchEvent(selectors:any, eventTypes: any, handlers: any, remove?: any, pluginObj?: any, disableMouse?: boolean): void; + function listenEvents(selectors: any, eventTypes: any, handlers: any, remove?: any, pluginObj?: any, disableMouse?: boolean): void; + function listenTouchEvent(selectors: any, eventTypes: any, handlers: any, remove?: any, pluginObj?: any, disableMouse?: boolean): void; function logBase(val: string, base: string): number; function measureText(text: string, maxwidth: number, font: string): string; function moveEvent(): string; function print(element: string, printWindow: any): void; - function proxy(fn: Object, context?: string, arg?: string): any; + function proxy(fn: any, context?: string, arg?: string): any; function round(value: string, div: string, up: string): any; - function sendAjaxRequest(ajaxOptions: Object): void; + function sendAjaxRequest(ajaxOptions: any): void; function setCaretToPos(nput: string, pos1: string, pos2: string): void; function setRenderMode(element: string): void; - function setTheme(): Object; + function setTheme(): any; function startEvent(): string; function tapEvent(): string; function tapHoldEvent(): string; - function throwError(): Object; - function transitionEndEvent(): Object; + function throwError(): any; + function transitionEndEvent(): any; function userAgent(): boolean; - function widget(pluginName: string, className: string, proto: Object): Object; - function avg(json: Object, filedName: string): any; + function widget(pluginName: string, className: string, proto: any): any; + function avg(json: any, filedName: string): any; function getGuid(prefix: string): number; - function group(jsonArray: any, field: string, agg: string, level: number, groupDs: string): Object; + function group(jsonArray: any, field: string, agg: string, level: number, groupDs: string): any; function isJson(jsonData: string): string; function max(jsonArray: any, fieldName?: string, comparer?: string): any; function min(jsonArray: any, fieldName: string, comparer: string): any; function merge(first: string, second: string): any; function mergeshort(jsonArray: any, fieldName: string, comparer: string): any; function parseJson(jsonText: string): string; - function parseTable(table: number, headerOption: string, headerRowIndex: string): Object; + function parseTable(table: number, headerOption: string, headerRowIndex: string): any; function select(jsonArray: any, fields: string): any; function setTransition(): boolean; function sum(json: string, fieldName: string): string; - function swap(array: any, x: string, y: string): any; - var cssUA: string; - var serverTimezoneOffset: number; - var transform: string; - var transformOrigin: string; - var transformStyle: string; - var transition: string; - var transitionDelay: string; - var transitionDuration: string; - var transitionProperty: string; - var transitionTimingFunction: string; - var template: any; - var util: { + function swap(array: any, x: string, y: string): any; + const cssUA: string; + const serverTimezoneOffset: number; + const transform: string; + const transformOrigin: string; + const transformStyle: string; + const transition: string; + const transitionDelay: string; + const transitionDuration: string; + const transitionProperty: string; + const transitionTimingFunction: string; + const template: any; + const util: { valueFunction(val: string): any; - } - export module device { + }; + export namespace device { function isAndroid(): boolean; function isIOS(): boolean; function isFlat(): boolean; function isIOS7(): boolean; function isWindows(): boolean; } - export module widget { - var autoInit: boolean; - var registeredInstances: Array; - var registeredWidgets: Array; + export namespace widget { + const autoInit: boolean; + const registeredInstances: any[]; + const registeredWidgets: any[]; function register(pluginName: string, className: string, prototype: any): void; function destroyAll(elements: Element): void; function init(element: Element): void; - function registerInstance(element: Element, pluginName: string, className: string, prototype: any):void; - } - + function registerInstance(element: Element, pluginName: string, className: string, prototype: any): void; + } interface browserInfoOptions { name: string; version: string; - culture: Object; + culture: any; isMSPointerEnabled: boolean; } class WidgetBase { destroy(): void; element: JQuery; - setModel(options: Object, forceSet?: boolean):any; - option(prop?: Object, value?: Object, forceSet?: boolean): any; - _trigger(eventName?: string, eventProp?: Object): any; + setModel(options: any, forceSet?: boolean): any; + option(prop?: any, value?: any, forceSet?: boolean): any; + _trigger(eventName?: string, eventProp?: any): any; _on(element: JQuery, eventType?: string, handler?: (eventObject: JQueryEventObject) => any): any; _on(element: JQuery, eventType ?: string, selector ?: string, handler ?: (eventObject: JQueryEventObject) => any): any; _off(element: JQuery, eventName: string, handler ?: (eventObject: JQueryEventObject) => any): any; - _off(element: JQuery, eventType ?: string, selector ?: string, handler ?: (eventObject: JQueryEventObject) => any): any; + _off(element: JQuery, eventType ?: string, selector ?: string, handler ?: (eventObject: JQueryEventObject) => any): any; persistState(): void; restoreState(silent: boolean): void; } @@ -160,30 +158,30 @@ declare module ej { static fn: Widget; static extend(widget: Widget): any; register(pluginName: string, className: string, prototype: any): void; - destroyAll(elements: Element): void; - model: any; + destroyAll(elements: Element): void; + model: any; } interface BaseEvent { cancel: boolean; - type: string; + type: string; } class DataManager { - constructor(dataSource?: any, query?: ej.Query, adaptor?: any); + constructor(dataSource?: any, query?: ej.Query, adaptor?: any); setDefaultQuery(query: ej.Query): void; executeQuery(query?: ej.Query, done?: any, fail?: any, always?: any): JQueryPromise; executeLocal(query?: ej.Query): ej.DataManager; saveChanges(changes?: Changes, key?: string, tableName?: string): JQueryDeferred; - insert(data: Object, tableName?: string): JQueryPromise; - remove(keyField: string, value: any, tableName?: string): Object; - update(keyField: string, value: any, tableName?: string): Object; - } + insert(data: any, tableName?: string): JQueryPromise; + remove(keyField: string, value: any, tableName?: string): any; + update(keyField: string, value: any, tableName?: string): any; + } class Query { constructor(); static fn: Query; - static extend(prototype: Object): Query; + static extend(prototype: any): Query; key(field: string): ej.Query; using(dataManager: ej.DataManager): ej.Query; execute(dataManager: ej.DataManager, done: any, fail?: string, always?: string): any; @@ -193,8 +191,8 @@ declare module ej { addParams(key: string, value: string): ej.Query; expand(tables: any): ej.Query; where(fieldName: string, operator: ej.FilterOperators, value: any, ignoreCase?: boolean): ej.Query; - where(predicate:ej.Predicate):ej.Query; - search(searchKey: any, fieldNames?: any, operator?: string, ignoreCase?: boolean): ej.Query; + where(predicate: ej.Predicate): ej.Query; + search(searchKey: any, fieldNames?: any, operator?: string, ignoreCase?: boolean): ej.Query; sortBy(fieldName: string, comparer?: ej.SortOrder, isFromGroup?: boolean): ej.Query; sortByDesc(fieldName: string): ej.Query; group(fieldName: string): ej.Query; @@ -205,17 +203,17 @@ declare module ej { hierarchy(query: ej.Query, selectorFn: any): ej.Query; foreignKey(key: string): ej.Query; requiresCount(): ej.Query; - range(start:number, end:number): ej.Query; + range(start: number, end: number): ej.Query; } class Adaptor { constructor(ds: any); - pvt: Object; + pvt: any; type: ej.Adaptor; options: AdaptorOptions; extend(overrides: any): ej.Adaptor; - processQuery(dm: ej.DataManager, query: ej.Query):any; - processResponse(data: Object, ds: any, query: ej.Query, xhr: JQueryXHR, request?: Object, changes?: Changes): Object; + processQuery(dm: ej.DataManager, query: ej.Query): any; + processResponse(data: any, ds: any, query: ej.Query, xhr: JQueryXHR, request?: any, changes?: Changes): any; convertToQueryString(req: any, query: ej.Query, dm: ej.DataManager): JQueryParam; } @@ -235,18 +233,18 @@ declare module ej { class UrlAdaptor extends ej.Adaptor { constructor(); - processQuery(dm: ej.DataManager, query: ej.Query, hierarchyFilters?: Object): { - type: string; url: string; ejPvtData: Object; contentType?: string; data?: Object; + processQuery(dm: ej.DataManager, query: ej.Query, hierarchyFilters?: any): { + type: string; url: string; ejPvtData: any; contentType?: string; data?: any; } - convertToQueryString(req: Object, query: ej.Query, dm: ej.DataManager): JQueryParam; - processResponse(data: Object, ds: any, query: ej.Query, xhr: JQueryXHR, request?: Object, changes?: Changes): Object; + convertToQueryString(req: any, query: ej.Query, dm: ej.DataManager): JQueryParam; + processResponse(data: any, ds: any, query: ej.Query, xhr: JQueryXHR, request?: any, changes?: Changes): any; onGroup(e: any): void; batchRequest(dm: ej.DataManager, changes: Changes, e: any): void; - beforeSend(dm: ej.DataManager, request: any, settings?:any): void; - insert(dm: ej.DataManager, data: Object, tableName: string): { url: string; data: any }; + beforeSend(dm: ej.DataManager, request: any, settings?: any): void; + insert(dm: ej.DataManager, data: any, tableName: string): { url: string; data: any }; remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data?: any }; update(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data: any }; - getFiltersFrom(data: Object, query: ej.Query): ej.Predicate; + getFiltersFrom(data: any, query: ej.Query): ej.Predicate; } class ODataAdaptor extends ej.UrlAdaptor { @@ -255,26 +253,26 @@ declare module ej { onEachWhere(filter: any, requiresCast: boolean): any; onPredicate(pred: ej.Predicate, query: ej.Query, requiresCast: boolean): string; onComplexPredicate(pred: ej.Predicate, requiresCast: boolean): string; - onWhere(filters: Array): string; - onEachSearch(e: Object): void; - onSearch(e: Object): string; - onEachSort(e: Object): string; - onSortBy(e: Object): string; - onGroup(e: Object): string; - onSelect(e: Object): string; - onCount(e: Object): string; + onWhere(filters: string[]): string; + onEachSearch(e: any): void; + onSearch(e: any): string; + onEachSort(e: any): string; + onSortBy(e: any): string; + onGroup(e: any): string; + onSelect(e: any): string; + onCount(e: any): string; beforeSend(dm: ej.DataManager, request: any, settings?: any): void; - processResponse(data: Object, ds: Object, query: ej.Query, xhr:any, request: any, changes: Changes): { - result: Object; count: number + processResponse(data: any, ds: any, query: ej.Query, xhr: any, request: any, changes: Changes): { + result: any; count: number }; - convertToQueryString(req: Object, query: ej.Query, dm: ej.DataManager): JQueryParam; - insert(dm: ej.DataManager, data: Object, tableName: string): { url: string; data: Object; } + convertToQueryString(req: any, query: ej.Query, dm: ej.DataManager): JQueryParam; + insert(dm: ej.DataManager, data: any, tableName: string): { url: string; data: any; } remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): { url: string; type: string; } - update(dm: ej.DataManager, keyField: string, value: any, tableName: string): { url: string; type: string; data: Object; accept: string; } - batchRequest(dm: ej.DataManager, changes: Changes, e: any): { url: string; type: string; data: Object; contentType: string; } - generateDeleteRequest(arr: Array, e: any): string; - generateInsertRequest(arr: Array, e: any): string; - generateUpdateRequest(arr: Array, e: any): string; + update(dm: ej.DataManager, keyField: string, value: any, tableName: string): { url: string; type: string; data: any; accept: string; } + batchRequest(dm: ej.DataManager, changes: Changes, e: any): { url: string; type: string; data: any; contentType: string; } + generateDeleteRequest(arr: any[], e: any): string; + generateInsertRequest(arr: any[], e: any): string; + generateUpdateRequest(arr: any[], e: any): string; } interface UrlAdaptorOptions { requestType?: string; @@ -295,28 +293,25 @@ declare module ej { changeSetContent?: string; batchChangeSetContentType?: string; } - class WebApiAdaptor extends ej.ODataAdaptor { constructor(); - insert(dm: ej.DataManager, data: Object, tableName?: string): { url: string; type: string; data: Object; } - remove(dm: ej.DataManager, value: any, keyField?: string, tableName?: string): { url: string; type: string; data: Object; } - update(dm: ej.DataManager, value: any, keyField?: string, tableName?: string): { url: string; type: string; data: Object; accept: string; } - processResponse(data: Object, ds: Object, query: ej.Query, xhr: any, request: any, changes: Changes): { - result: Object; count: number + insert(dm: ej.DataManager, data: any, tableName?: string): { url: string; type: string; data: any; } + remove(dm: ej.DataManager, value: any, keyField?: string, tableName?: string): { url: string; type: string; data: any; } + update(dm: ej.DataManager, value: any, keyField?: string, tableName?: string): { url: string; type: string; data: any; accept: string; } + processResponse(data: any, ds: any, query: ej.Query, xhr: any, request: any, changes: Changes): { + result: any; count: number }; } - class ODataV4Adaptor extends ej.ODataAdaptor { constructor(); options: ODataAdaptorOptions; - onCount(e: Object): string; - onEachSearch(e: Object): void; - onSearch(e: Object): string; + onCount(e: any): string; + onEachSearch(e: any): void; + onSearch(e: any): string; beforeSend(dm: ej.DataManager, request: any, settings?: any): void; - processResponse(data: Object, ds: Object, query: ej.Query, xhr:any, request: any, changes: Changes): { - result: Object; count: number + processResponse(data: any, ds: any, query: ej.Query, xhr: any, request: any, changes: Changes): { + result: any; count: number }; - } interface ODataAdaptorOptions { requestType?: string; @@ -341,31 +336,31 @@ declare module ej { class JsonAdaptor extends ej.Adaptor { constructor(); - processQuery(ds: Object, query: ej.Query): string; - batchRequest(dm: ej.DataManager, changes: Changes, e:any): Changes; - onWhere(ds: Object, e: any): any; - onSearch(ds: Object, e: any): any - onSortBy(ds: Object, e: any, query: ej.Query): Object; - onGroup(ds: Object, e: any, query: ej.Query): Object; - onPage(ds: Object, e: any, query: ej.Query): Object; - onRange(ds: Object, e: any): Object; - onTake(ds: Object, e: any): Object; - onSkip(ds: Object, e: any): Object; - onSelect(ds: Object, e: any): Object; - insert(dm: ej.DataManager, data: any): Object; - remove(dm: ej.DataManager, keyField: string, value:any, tableName: string): Object; - update(dm: ej.DataManager, keyField: string, value:any, tableName: string): Object; + processQuery(ds: any, query: ej.Query): string; + batchRequest(dm: ej.DataManager, changes: Changes, e: any): Changes; + onWhere(ds: any, e: any): any; + onSearch(ds: any, e: any): any + onSortBy(ds: any, e: any, query: ej.Query): any; + onGroup(ds: any, e: any, query: ej.Query): any; + onPage(ds: any, e: any, query: ej.Query): any; + onRange(ds: any, e: any): any; + onTake(ds: any, e: any): any; + onSkip(ds: any, e: any): any; + onSelect(ds: any, e: any): any; + insert(dm: ej.DataManager, data: any): any; + remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): any; + update(dm: ej.DataManager, keyField: string, value: any, tableName: string): any; } class remoteSaveAdaptor extends ej.UrlAdaptor { constructor(); batchRequest(dm: ej.DataManager, changes: Changes, e: any): void; beforeSend(dm: ej.DataManager, request: any, settings?: any): void; - insert(dm: ej.DataManager, data: Object, tableName: string): { url: string; data: any }; + insert(dm: ej.DataManager, data: any, tableName: string): { url: string; data: any }; remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data?: any }; update(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data: any }; } class TableModel { - constructor(name: string, jsonArray: Array, dataManager: ej.DataManager, modelComputed: any); + constructor(name: string, jsonArray: any[], dataManager: ej.DataManager, modelComputed: any); on(eventName: string, handler: any): void; off(eventName: string, handler: any): void; setDataManager(dataManager: DataManager): void; @@ -376,15 +371,15 @@ declare module ej { remove(key: string): void; isDirty(): boolean; getChanges(): Changes; - toArray(): Array; - setDirty(dirty:any, model:any): void; + toArray(): any[]; + setDirty(dirty: any, model: any): void; get(index: number): void; length(): number; bindTo(element: any): void; } class Model { constructor(json: any, table: string, name: string); - formElements: Array; + formElements: string[]; computes(value: any): void; on(eventName: string, handler: any): void; off(eventName: string, handler: any): void; @@ -400,17 +395,17 @@ declare module ej { unbind(element: any): void; } interface Changes { - changed?: Array; - added?: Array; - deleted?: Array; + changed?: any[]; + added?: any[]; + deleted?: any[]; } class Predicate { constructor(); constructor(field: string, operator: ej.FilterOperators, value: any, ignoreCase: boolean); - and(field: string, operator: any, value:any, ignoreCase:boolean): ej.Predicate; + and(field: string, operator: any, value: any, ignoreCase: boolean): ej.Predicate; or(field: string, operator: any, value: any, ignoreCase: boolean): ej.Predicate; - or(predicate: Array): any; - validate(record: Object): boolean; + or(predicate: any[]): any; + validate(record: any): boolean; toJSON(): { isComplex: boolean; field: string; @@ -421,17 +416,17 @@ declare module ej { predicates: any; }; } - interface dataUtil { - swap(array: Array, x: number, y: number): void; - mergeSort(jsonArray: Array, fieldName?: string, comparer?:any): Array; - max(jsonArray: Array, fieldName?: string, comparer?: string): Array; - min(jsonArray: Array, fieldName: string, comparer: string): Array; - distinct(jsonArray: Array, fieldName?: string, requiresCompleteRecord?:any): Array; - sum(json:any, fieldName: string): number; - avg(json:any, fieldName: string): number; - select(jsonArray: Array, fieldName: string, fields:string): Array; - group(jsonArray: Array, field: string, /* internal */ level: number): Array; - parseTable(table: string, headerOption: ej.headerOption, headerRowIndex: number): Object; + interface dataUtil { + swap(array: any[], x: number, y: number): void; + mergeSort(jsonArray: any[], fieldName?: string, comparer?: any): any[]; + max(jsonArray: any[], fieldName?: string, comparer?: string): any[]; + min(jsonArray: any[], fieldName: string, comparer: string): any[]; + distinct(jsonArray: any[], fieldName?: string, requiresCompleteRecord?: any): any[]; + sum(json: any, fieldName: string): number; + avg(json: any, fieldName: string): number; + select(jsonArray: any[], fieldName: string, fields: string): any[]; + group(jsonArray: any[], field: string, /* internal */ level: number): any[]; + parseTable(table: string, headerOption: ej.headerOption, headerRowIndex: number): any; } interface AjaxSettings { type?: string; @@ -491,8 +486,7 @@ declare module ej { row, tHead } - - enum filterType{ + enum filterType { StartsWith, Contains, EndsWith, @@ -503,33 +497,32 @@ declare module ej { Equal, NotEqual } - enum Animation{ + enum Animation { Fade, None, Slide - } - enum Type{ + } + enum Type { Overlay, Slide } - enum SortOrder{ + enum SortOrder { Ascending, Descending } class Draggable extends ej.Widget { static fn: Draggable; - constructor(element: JQuery, options?: Draggable.Model); - constructor(element: Element, options?: Draggable.Model); + constructor(element: JQuery | Element, options?: Draggable.Model); static Locale: any; - model:Draggable.Model; - defaults:Draggable.Model; + model: Draggable.Model; + defaults: Draggable.Model; /** destroy in the draggable. * @returns {void} */ _destroy(): void; } -export module Draggable{ +export namespace Draggable { export interface Model { @@ -564,19 +557,19 @@ export interface Model { scope?: string; /** This event is triggered when dragging element is destroyed. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** This event is triggered when the mouse is moved during the dragging. */ - drag? (e: DragEventArgs): void; + drag?(e: DragEventArgs): void; /** Supply a callback function to handle the drag start event as an init option. */ - dragStart? (e: DragStartEventArgs): void; + dragStart?(e: DragStartEventArgs): void; /** This event is triggered when the mouse is moved during the dragging. */ - dragStop? (e: DragStopEventArgs): void; + dragStop?(e: DragStopEventArgs): void; /** This event is triggered when dragged. */ - helper? (e: HelperEventArgs): void; + helper?(e: HelperEventArgs): void; } export interface DestroyEventArgs { @@ -677,18 +670,17 @@ export interface HelperEventArgs { class Droppable extends ej.Widget { static fn: Droppable; - constructor(element: JQuery, options?: Droppable.Model); - constructor(element: Element, options?: Droppable.Model); + constructor(element: JQuery | Element, options?: Droppable.Model); static Locale: any; - model:Droppable.Model; - defaults:Droppable.Model; + model: Droppable.Model; + defaults: Droppable.Model; /** destroy in the Droppable. * @returns {void} */ _destroy(): void; } -export module Droppable{ +export namespace Droppable { export interface Model { @@ -703,13 +695,13 @@ export interface Model { scope?: string; /** This event is triggered when the mouse up is moved during the dragging. */ - drop? (e: DropEventArgs): void; + drop?(e: DropEventArgs): void; /** This event is triggered when the mouse is moved out. */ - out? (e: OutEventArgs): void; + out?(e: OutEventArgs): void; /** This event is triggered when the mouse is moved over. */ - over? (e: OverEventArgs): void; + over?(e: OverEventArgs): void; } export interface DropEventArgs { @@ -772,18 +764,17 @@ export interface OverEventArgs { class Resizable extends ej.Widget { static fn: Resizable; - constructor(element: JQuery, options?: Resizable.Model); - constructor(element: Element, options?: Resizable.Model); + constructor(element: JQuery | Element, options?: Resizable.Model); static Locale: any; - model:Resizable.Model; - defaults:Resizable.Model; + model: Resizable.Model; + defaults: Resizable.Model; /** destroy in the Resizable. * @returns {void} */ _destroy(): void; } -export module Resizable{ +export namespace Resizable { export interface Model { @@ -828,10 +819,10 @@ export interface Model { scope?: string; /** This event is triggered when the widget destroys. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** This event is triggered when resized. */ - helper? (e: HelperEventArgs): void; + helper?(e: HelperEventArgs): void; } export interface DestroyEventArgs { @@ -866,8 +857,8 @@ export interface HelperEventArgs { } - var globalize:globalize; - var cultures:culture; + const globalize: globalize; + const cultures: culture; function addCulture(name: string, culture ?: any): void; function preferredCulture(culture ?: string): culture; function format(value: any, format: string, culture ?: string): string; @@ -876,10 +867,10 @@ export interface HelperEventArgs { function parseDate(value: string, format: string, culture ?: string): Date; function getLocalizedConstants(controlName: string, culture ?: string): any; -interface globalize { +interface globalize { addCulture(name: string, culture?: any): void; preferredCulture(culture?: string): culture; - format(value: any, format: string, culture?: string): string; + format(value: any, format: string, culture?: string): string; parseInt(value: string, radix?: any, culture?: string): number; parseFloat(value: string, radix?: any, culture?: string): number; parseDate(value: string, format: string, culture?: string): Date; @@ -895,22 +886,22 @@ interface globalize { calendars?: calendarsSettings; } interface formatSettings { - pattern: Array; + pattern: string[]; decimals: number; - groupSizes: Array; + groupSizes: number[]; percent: percentSettings; currency: currencySettings; } interface percentSettings { - pattern: Array; + pattern: string[]; decimals: number; - groupSizes: Array; + groupSizes: number[]; symbol: string; } interface currencySettings { - pattern: Array; + pattern: string[]; decimals: number; - groupSizes: Array; + groupSizes: number[]; symbol: string; } interface calendarsSettings { @@ -920,19 +911,19 @@ interface globalize { firstDay: number; days: daySettings; months: monthSettings; - AM: Array; - PM: Array; + AM: string[]; + PM: string[]; twoDigitYearMax: number; patterns: patternSettings; } interface daySettings { - names: Array; - namesAbbr: Array; - namesShort: Array; + names: string[]; + namesAbbr: string[]; + namesShort: string[]; } interface monthSettings { - names: Array; - namesAbbr: Array; + names: string[]; + namesAbbr: string[]; } interface patternSettings { d: string; @@ -944,14 +935,13 @@ interface globalize { M: string; Y: string; S: string; - } + } class Scroller extends ej.Widget { static fn: Scroller; - constructor(element: JQuery, options?: Scroller.Model); - constructor(element: Element, options?: Scroller.Model); + constructor(element: JQuery | Element, options?: Scroller.Model); static Locale: any; - model:Scroller.Model; - defaults:Scroller.Model; + model: Scroller.Model; + defaults: Scroller.Model; /** destroy the Scroller control, unbind the all ej control related events automatically and bring the control to pre-init state. * @returns {void} @@ -999,7 +989,7 @@ class Scroller extends ej.Widget { */ scrollY(pixel: number|string, disableAnimation: boolean, animationSpeed: number): void; } -export module Scroller{ +export namespace Scroller { export interface Model { @@ -1074,28 +1064,28 @@ export interface Model { width?: number|string; /** Fires when Scroller control is created. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Fires when Scroller control is destroyed. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Fires when a thumb point is moved along the touch surface. */ - thumbMove? (e: ThumbMoveEventArgs): void; + thumbMove?(e: ThumbMoveEventArgs): void; /** Fires when a thumb point is placed on the touch surface. */ - thumbStart? (e: ThumbStartEventArgs): void; + thumbStart?(e: ThumbStartEventArgs): void; /** Fires when a thumb point is removed from the touch surface. */ - thumbEnd? (e: ThumbEndEventArgs): void; + thumbEnd?(e: ThumbEndEventArgs): void; /** It fires whenever the mouse wheel is rotated either in upwards or downwards. */ - wheelMove? (e: WheelMoveEventArgs): void; + wheelMove?(e: WheelMoveEventArgs): void; /** It will fire when mouse trackball has been start to wheel. */ - wheelStart? (e: WheelStartEventArgs): void; + wheelStart?(e: WheelStartEventArgs): void; /** It will fire when mouse trackball has been stop to wheel. */ - wheelStop? (e: WheelStopEventArgs): void; + wheelStop?(e: WheelStopEventArgs): void; } export interface CreateEventArgs { @@ -1253,11 +1243,10 @@ export interface WheelStopEventArgs { class Accordion extends ej.Widget { static fn: Accordion; - constructor(element: JQuery, options?: Accordion.Model); - constructor(element: Element, options?: Accordion.Model); + constructor(element: JQuery | Element, options?: Accordion.Model); static Locale: any; - model:Accordion.Model; - defaults:Accordion.Model; + model: Accordion.Model; + defaults: Accordion.Model; /** AddItem method is used to add the panel in dynamically. It receives the following parameters * @param {string} specify the name of the header @@ -1292,7 +1281,7 @@ class Accordion extends ej.Widget { * @param {Array} index values to disable the panels * @returns {void} */ - disableItems(index: Array): void; + disableItems(index: any[]): void; /** Enable the accordion widget includes all the headers and content panels. * @returns {void} @@ -1303,7 +1292,7 @@ class Accordion extends ej.Widget { * @param {Array} index values to enable the panels * @returns {void} */ - enableItems(index: Array): void; + enableItems(index: any[]): void; /** To expand all the accordion widget items. * @returns {void} @@ -1341,7 +1330,7 @@ class Accordion extends ej.Widget { */ show(): void; } -export module Accordion{ +export namespace Accordion { export interface Model { @@ -1353,7 +1342,7 @@ export interface Model { /** Accordion headers can be expanded and collapsed on keyboard action. * @Default {true} */ - allowKeyboardNavigation?: Boolean; + allowKeyboardNavigation?: boolean; /** To set the Accordion headers Collapse Speed. * @Default {300} @@ -1367,7 +1356,7 @@ export interface Model { /** Sets the root CSS class for Accordion theme, which is used customize. */ - cssClass?: String; + cssClass?: string; /** Allows you to set the custom header Icon. It accepts two key values Ă¢â‚¬Å“headerĂ¢â‚¬Â, Ă¢â‚¬ÂselectedHeaderĂ¢â‚¬Â. * @Default {{ header: e-collapse, selectedHeader: e-expand }} @@ -1382,12 +1371,12 @@ export interface Model { /** Specifies the animation behavior in accordion. * @Default {true} */ - enableAnimation?: Boolean; + enableAnimation?: boolean; /** With this enabled property, you can enable or disable the Accordion. * @Default {true} */ - enabled?: Boolean; + enabled?: boolean; /** Used to enable the disabled items in accordion. * @Default {[]} @@ -1397,22 +1386,22 @@ export interface Model { /** Multiple content panels to activate at a time. * @Default {false} */ - enableMultipleOpen?: Boolean; + enableMultipleOpen?: boolean; /** Save current model value to browser cookies for maintaining states. When refreshing the accordion control page, the model value is applied from browser cookies or HTML 5local storage. * @Default {false} */ - enablePersistence?: Boolean; + enablePersistence?: boolean; /** Display headers and panel text from right-to-left. * @Default {false} */ - enableRTL?: Boolean; + enableRTL?: boolean; /** The events API binds the action for activating the accordion header. Users can activate the header by using mouse actions such as mouse-over, mouse-up, mouse-down, and soon. * @Default {click} */ - events?: String; + events?: string; /** To set the Accordion headers Expand Speed. * @Default {300} @@ -1451,7 +1440,7 @@ export interface Model { /** Used to determines the close button visibility an each accordion items. This close button helps to remove the accordion item from the control. * @Default {false} */ - showCloseButton?: Boolean; + showCloseButton?: boolean; /** Displays rounded corner borders on the Accordion control's panels and headers. * @Default {false} @@ -1464,34 +1453,34 @@ export interface Model { width?: number|string; /** Triggered after a Accordion item is active or inactive. Argument values are activeIndex, activeHeader, inActiveHeader, inActiveIndex and current model value. */ - activate? (e: ActivateEventArgs): void; + activate?(e: ActivateEventArgs): void; /** Triggered before the AJAX content is loaded in a content panel. Arguments have location of the content (URL) and current model value. */ - ajaxBeforeLoad? (e: AjaxBeforeLoadEventArgs): void; + ajaxBeforeLoad?(e: AjaxBeforeLoadEventArgs): void; /** Triggered after AJAX load failed action. Arguments have URL, error message, and current model value. */ - ajaxError? (e: AjaxErrorEventArgs): void; + ajaxError?(e: AjaxErrorEventArgs): void; /** Triggered after the AJAX content loads. Arguments have current model values. */ - ajaxLoad? (e: AjaxLoadEventArgs): void; + ajaxLoad?(e: AjaxLoadEventArgs): void; /** Triggered after AJAX success action. Arguments have URL, content, and current model values. */ - ajaxSuccess? (e: AjaxSuccessEventArgs): void; + ajaxSuccess?(e: AjaxSuccessEventArgs): void; /** Triggered before a tab item is active. Arguments have active index and model values. */ - beforeActivate? (e: BeforeActivateEventArgs): void; + beforeActivate?(e: BeforeActivateEventArgs): void; /** Triggered after a Accordion item is active or inactive. Argument values are activeIndex, activeHeader, inActiveHeader, inActiveIndex and current model value. */ - beforeInactivate? (e: BeforeInactivateEventArgs): void; + beforeInactivate?(e: BeforeInactivateEventArgs): void; /** Triggered after Accordion control creation. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Triggered after Accordion control destroy. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Triggered after a Accordion item is active or inactive. Argument values are activeIndex, activeHeader, inActiveHeader, inActiveIndex and current model value. */ - inActivate? (e: InActivateEventArgs): void; + inActivate?(e: InActivateEventArgs): void; } export interface ActivateEventArgs { @@ -1716,15 +1705,15 @@ export interface AjaxSettings { /** It specifies, whether to enable or disable asynchronous request. */ - async?: Boolean; + async?: boolean; /** It specifies the page will be cached in the web browser. */ - cache?: Boolean; + cache?: boolean; /** It specifies the type of data is send in the query string. */ - contentType?: String; + contentType?: string; /** It specifies the data as an object, will be passed in the query string. */ @@ -1732,25 +1721,25 @@ export interface AjaxSettings { /** It specifies the type of data that you're expecting back from the response. */ - dataType?: String; + dataType?: string; /** It specifies the HTTP request type. */ - type?: String; + type?: string; } export interface CustomIcon { /** This class name set to collapsing header. */ - header?: String; + header?: string; /** This class name set to expanded (active) header. */ - selectedHeader?: String; + selectedHeader?: string; } -enum HeightAdjustMode{ +enum HeightAdjustMode { ///Height fit to the content in the panel Content, @@ -1766,11 +1755,10 @@ enum HeightAdjustMode{ class Autocomplete extends ej.Widget { static fn: Autocomplete; - constructor(element: JQuery, options?: Autocomplete.Model); - constructor(element: Element, options?: Autocomplete.Model); + constructor(element: JQuery | Element, options?: Autocomplete.Model); static Locale: any; - model:Autocomplete.Model; - defaults:Autocomplete.Model; + model: Autocomplete.Model; + defaults: Autocomplete.Model; /** Clears the text in the Autocomplete textbox. * @returns {void} @@ -1829,16 +1817,17 @@ class Autocomplete extends ej.Widget { */ selectValueByText(Text: string): void; } -export module Autocomplete{ +export namespace Autocomplete { export interface Model { /** Customize "Add New" text (label) to be added in the autocomplete popup list for the entered text when there are no suggestions for it. * @Default {Add New} */ - addNewText?: string; + addNewText?: boolean; - /** Allows new values to be added to the autocomplete input other than the values in the suggestion list. Normally, when there are no suggestions it will display Ă¢â‚¬Å“No suggestionsĂ¢â‚¬Â label in the popup. + /** Allows new values to be added to the autocomplete input other than the values in the suggestion list. + * Normally, when there are no suggestions it will display Ă¢â‚¬Å“No suggestionsĂ¢â‚¬Â label in the popup. * @Default {false} */ allowAddNew?: boolean; @@ -1868,10 +1857,10 @@ export interface Model { */ cssClass?: string; - /** The data source contains the list of data for the suggestions list. It can be a string array or JSON array or service URL that returns JSON. + /** The data source contains the list of data for the suggestions list. It can be a string array or JSON array. * @Default {null} */ - dataSource?: any|Array; + dataSource?: any|any[]; /** The time delay (in milliseconds) after which the suggestion popup will be shown. * @Default {200} @@ -1903,7 +1892,9 @@ export interface Model { */ enableDistinct?: boolean; - /** Allows the current model values to be saved in local storage or browser cookies for state maintenance when it is set to true. While refreshing the page, it retains the model value from browser cookies or local storage. + /** Allows the current model values to be saved in local storage or browser cookies for state maintenance + * when it is set to true. + * While refreshing the page, it retains the model value from browser cookies or local storage. * @Default {false} */ enablePersistence?: boolean; @@ -1918,7 +1909,10 @@ export interface Model { */ fields?: Fields; - /** Specifies the search filter type. There are several types of search filter available such as Ă¢â‚¬ËœstartswithĂ¢â‚¬â„¢, Ă¢â‚¬ËœcontainsĂ¢â‚¬â„¢, Ă¢â‚¬ËœendswithĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœgreaterthanĂ¢â‚¬â„¢, Ă¢â‚¬ËœgreaterthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœnotequalĂ¢â‚¬â„¢. + /** Specifies the search filter type. + * There are several types of search filter available such as Ă¢â‚¬ËœstartswithĂ¢â‚¬â„¢, + * Ă¢â‚¬ËœcontainsĂ¢â‚¬â„¢, Ă¢â‚¬ËœendswithĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœgreaterthanĂ¢â‚¬â„¢, + * Ă¢â‚¬ËœgreaterthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœnotequalĂ¢â‚¬â„¢. * @Default {ej.filterType.StartsWith} */ filterType?: string; @@ -2046,52 +2040,64 @@ export interface Model { width?: string|number; /** Triggers when the AJAX requests Begins. */ - actionBegin? (e: ActionBeginEventArgs): void; + actionBegin?(e: ActionBeginEventArgs): void; /** Triggers when the data requested from AJAX will get successfully loaded in the Autocomplete widget. */ - actionSuccess? (e: ActionSuccessEventArgs): void; + actionSuccess?(e: ActionSuccessEventArgs): void; /** Triggers when the AJAX requests complete. The request may get failed or succeed. */ - actionComplete? (e: ActionCompleteEventArgs): void; + actionComplete?(e: ActionCompleteEventArgs): void; /** Triggers when the data requested from AJAX get failed. */ - actionFailure? (e: ActionFailureEventArgs): void; + actionFailure?(e: ActionFailureEventArgs): void; /** Triggers when the text box value is changed. */ - change? (e: ChangeEventArgs): void; + change?(e: ChangeEventArgs): void; /** Triggers after the suggestion popup is closed. */ - close? (e: CloseEventArgs): void; + close?(e: CloseEventArgs): void; /** Triggers when Autocomplete widget is created. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Triggers after the Autocomplete widget is destroyed. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Triggers after the autocomplete textbox is focused. */ - focusIn? (e: FocusInEventArgs): void; + focusIn?(e: FocusInEventArgs): void; /** Triggers after the Autocomplete textbox gets out of the focus. */ - focusOut? (e: FocusOutEventArgs): void; + focusOut?(e: FocusOutEventArgs): void; /** Triggers after the suggestion list is opened. */ - open? (e: OpenEventArgs): void; + open?(e: OpenEventArgs): void; /** Triggers when an item has been selected from the suggestion list. */ - select? (e: SelectEventArgs): void; + select?(e: SelectEventArgs): void; } export interface ActionBeginEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; } export interface ActionSuccessEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; } export interface ActionCompleteEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; } export interface ActionFailureEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; } export interface ChangeEventArgs { @@ -2280,7 +2286,9 @@ export interface MultiColumnSettingsColumn { */ type?: ej.Type|string; - /** Specifies the search filter type. There are several types of search filter available such as Ă¢â‚¬ËœstartswithĂ¢â‚¬â„¢, Ă¢â‚¬ËœcontainsĂ¢â‚¬â„¢, Ă¢â‚¬ËœendswithĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœgreaterthanĂ¢â‚¬â„¢, Ă¢â‚¬ËœgreaterthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœnotequalĂ¢â‚¬â„¢. + /** Specifies the search filter type. There are several types of search filter available such as Ă¢â‚¬ËœstartswithĂ¢â‚¬â„¢, + * Ă¢â‚¬ËœcontainsĂ¢â‚¬â„¢, Ă¢â‚¬ËœendswithĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœgreaterthanĂ¢â‚¬â„¢, + * Ă¢â‚¬ËœgreaterthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœnotequalĂ¢â‚¬â„¢. * @Default {ej.filterType.StartsWith} */ filterType?: ej.filterType|string; @@ -2293,7 +2301,7 @@ export interface MultiColumnSettingsColumn { /** Gets or sets a value that indicates to align the text within the column. See textAlign * @Default {ej.TextAlign.Left} */ - textAlign?: ej.TextAlign|string; + textAlign?: ej.TextAlign|string; } export interface MultiColumnSettings { @@ -2314,10 +2322,10 @@ export interface MultiColumnSettings { /** Field and Header Text collections can be defined and customized through columns field. */ - columns?: Array; + columns?: MultiColumnSettingsColumn[]; } -enum Animation{ +enum Animation { ///Supports to animation type with none type only. None, @@ -2330,7 +2338,7 @@ enum Animation{ } -enum MultiSelectMode{ +enum MultiSelectMode { ///Multiple values are separated using a given special character. Delimiter, @@ -2340,7 +2348,7 @@ enum MultiSelectMode{ } -enum SortOrder{ +enum SortOrder { ///Items to be displayed in the suggestion list in ascending order. Ascending, @@ -2353,11 +2361,10 @@ enum SortOrder{ class Button extends ej.Widget { static fn: Button; - constructor(element: JQuery, options?: Button.Model); - constructor(element: Element, options?: Button.Model); + constructor(element: JQuery | Element, options?: Button.Model); static Locale: any; - model:Button.Model; - defaults:Button.Model; + model: Button.Model; + defaults: Button.Model; /** destroy the button widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. * @returns {void} @@ -2374,7 +2381,7 @@ class Button extends ej.Widget { */ enable(): void; } -export module Button{ +export namespace Button { export interface Model { @@ -2407,7 +2414,9 @@ export interface Model { */ htmlAttributes?: any; - /** Specifies the image position of the Button. This image position is applicable only with the textandimage contentType property. The images can be positioned in both imageLeft and imageRight options. See below to know about available ImagePosition + /** Specifies the image position of the Button. This image position is applicable + * only with the textandimage contentType property. The images can be positioned in both + * imageLeft and imageRight options. See below to know about available ImagePosition * @Default {ej.ImagePosition.ImageLeft} */ imagePosition?: ej.ImagePosition|string; @@ -2457,14 +2466,17 @@ export interface Model { */ width?: string|number; - /** Fires when Button control is clicked successfully.Consider the scenario to perform any validation,modification of content or any other operations click on button,we can make use of this click event to achieve the scenario. */ - click? (e: ClickEventArgs): void; + /** Fires when Button control is clicked successfully.Consider the scenario to perform any validation, + * modification of content or any other operations click on button,we can make use of this click event + * to achieve the scenario. + */ + click?(e: ClickEventArgs): void; /** Fires after Button control is created.If the user want to perform any operation after the button control creation then the user can make use of this create event. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Fires when the button is destroyed successfully.If the user want to perform any operation after the destroy button control then the user can make use of this destroy event. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; } export interface ClickEventArgs { @@ -2485,7 +2497,7 @@ export interface ClickEventArgs { */ status?: boolean; - /** return the event model for sever side processing. + /** return the event model for sever side processing. */ e?: any; } @@ -2520,8 +2532,7 @@ export interface DestroyEventArgs { type?: string; } } -enum ContentType -{ +enum ContentType { //To display the text content only in button TextOnly, //To display the image only in button @@ -2533,8 +2544,7 @@ TextAndImage, //Supports to display image with both ends of the text ImageTextImage, } -enum ImagePosition -{ +enum ImagePosition { //support for aligning text in left and image in right ImageRight, //support for aligning text in right and image in left @@ -2544,24 +2554,22 @@ ImageTop, //support for aligning text in top and image in bottom ImageBottom, } -enum ButtonSize -{ +enum ButtonSize { //Creates button with Built-in default size height, width specified Normal, //Creates button with Built-in mini size height, width specified Mini, //Creates button with Built-in small size height, width specified Small, -//Creates button with Built-in medium size height, width specified +//Creates button with Built-in medium size height, width specified Medium, -//Creates button with Built-in large size height, width specified +//Creates button with Built-in large size height, width specified Large, } -enum ButtonType -{ +enum ButtonType { //Creates button with Built-in button type specified Button, -//Creates button with Built-in reset type specified +//Creates button with Built-in reset type specified Reset, //Creates button with Built-in submit type specified Submit, @@ -2569,13 +2577,12 @@ Submit, class Captcha extends ej.Widget { static fn: Captcha; - constructor(element: JQuery, options?: Captcha.Model); - constructor(element: Element, options?: Captcha.Model); + constructor(element: JQuery | Element, options?: Captcha.Model); static Locale: any; - model:Captcha.Model; - defaults:Captcha.Model; + model: Captcha.Model; + defaults: Captcha.Model; } -export module Captcha{ +export namespace Captcha { export interface Model { @@ -2648,16 +2655,16 @@ export interface Model { width?: number; /** Fires when captcha refresh begins. */ - refreshBegin? (e: RefreshBeginEventArgs): void; + refreshBegin?(e: RefreshBeginEventArgs): void; /** Fires after captcha refresh completed. */ - refreshComplete? (e: RefreshCompleteEventArgs): void; + refreshComplete?(e: RefreshCompleteEventArgs): void; /** Fires when captcha refresh fails to load. */ - refreshFailure? (e: RefreshFailureEventArgs): void; + refreshFailure?(e: RefreshFailureEventArgs): void; /** Fires after captcha refresh succeeded. */ - refreshSuccess? (e: RefreshSuccessEventArgs): void; + refreshSuccess?(e: RefreshSuccessEventArgs): void; } export interface RefreshBeginEventArgs { @@ -2720,8 +2727,7 @@ export interface RefreshSuccessEventArgs { type?: string; } } -enum HatchStyle -{ +enum HatchStyle { //Set background as None to Captcha None, //Set background as BackwardDiagonal to Captcha @@ -2800,14 +2806,14 @@ ZigZag, class ListBox extends ej.Widget { static fn: ListBox; - constructor(element: JQuery, options?: ListBox.Model); - constructor(element: Element, options?: ListBox.Model); + constructor(element: JQuery | Element, options?: ListBox.Model); static Locale: any; - model:ListBox.Model; - defaults:ListBox.Model; + model: ListBox.Model; + defaults: ListBox.Model; /** Adds a given list items in the ListBox widget at a specified index. It accepts two parameters. - * @param {any|string} This can be a list item object (for JSON binding) or a string (for UL and LI rendering). Also we can the specify this as an array of list item object or an array of strings to add multiple items. + * @param {any|string} This can be a list item object (for JSON binding) or a string (for UL and LI rendering). + * Also we can the specify this as an array of list item object or an array of strings to add multiple items. * @param {number} The index value to add the given items at the specified index. If index is not specified, the given items will be added at the end of the list. * @returns {void} */ @@ -2918,7 +2924,7 @@ class ListBox extends ej.Widget { * @param {Array} Data to merge in listbox. * @returns {void} */ - mergeData(data: Array): void; + mergeData(data: any[]): void; /** Selects the next item based on the current selection. * @returns {void} @@ -2947,7 +2953,7 @@ class ListBox extends ej.Widget { removeSelectedItems(): void; /** Removes a list item by using its text. - * @param {string} Text of the listbox item to be removed. + * @param {string} Text of the listbox item to be removed. * @returns {void} */ removeItemByText(text: string): void; @@ -2958,7 +2964,7 @@ class ListBox extends ej.Widget { */ removeItemByIndex(index: number): void; - /** + /** * @returns {void} */ selectAll(): void; @@ -3004,7 +3010,7 @@ class ListBox extends ej.Widget { */ uncheckItemsByIndices(indices: number[]|string): void; - /** + /** * @returns {void} */ unselectAll(): void; @@ -3054,13 +3060,13 @@ class ListBox extends ej.Widget { * @param {Array} Values of the listbox items to be shown. * @returns {void} */ - showItemsByValues(values: Array): void; + showItemsByValues(values: any[]): void; /** Hides the list item using its values. * @param {Array} Values of the listbox items to be hidden. * @returns {void} */ - hideItemsByValues(values: Array): void; + hideItemsByValues(values: any[]): void; /** Shows a hidden list item using its value. * @param {string} Value of the listbox item to be shown. @@ -3086,7 +3092,7 @@ class ListBox extends ej.Widget { */ hideItemByIndex(index: number): void; - /** + /** * @returns {void} */ show(): void; @@ -3106,7 +3112,7 @@ class ListBox extends ej.Widget { */ showAllItems(): void; } -export module ListBox{ +export namespace ListBox { export interface Model { @@ -3135,7 +3141,9 @@ export interface Model { */ caseSensitiveSearch?: boolean; - /** Dynamically populate data of a list box while selecting an item in another list box i.e. rendering child list box based on the item selection in parent list box. This property accepts the id of the child ListBox widget to populate the data. + /** Dynamically populate data of a list box while selecting an item in another list box i.e. + * rendering child list box based on the item selection in parent list box. + * This property accepts the id of the child ListBox widget to populate the data. * @Default {null} */ cascadeTo?: string; @@ -3143,7 +3151,7 @@ export interface Model { /** Set of list items to be checked by default using its index. It works only when the showCheckbox property is set to true. * @Default {null} */ - checkedIndices?: Array; + checkedIndices?: any[]; /** The root class for the ListBox widget to customize the existing theme. * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} @@ -3227,7 +3235,7 @@ export interface Model { /** The list items to be selected by default using its indices. To use this property allowMultiSelection should be enabled. * @Default {[]} */ - selectedIndices?: Array; + selectedIndices?: any[]; /** Enables/Disables the multi selection option with the help of checkbox control. * @Default {false} @@ -3263,67 +3271,79 @@ export interface Model { targetID?: string; /** Triggers before the AJAX request begins to load data in the ListBox widget. */ - actionBegin? (e: ActionBeginEventArgs): void; + actionBegin?(e: ActionBeginEventArgs): void; /** Triggers after the data requested via AJAX is successfully loaded in the ListBox widget. */ - actionSuccess? (e: ActionSuccessEventArgs): void; + actionSuccess?(e: ActionSuccessEventArgs): void; /** Triggers when the AJAX requests complete. The request may get failed or succeed. */ - actionComplete? (e: ActionCompleteEventArgs): void; + actionComplete?(e: ActionCompleteEventArgs): void; /** Triggers when the data requested from AJAX get failed. */ - actionFailure? (e: ActionFailureEventArgs): void; + actionFailure?(e: ActionFailureEventArgs): void; /** Event will be triggered before the requested data via AJAX once loaded in successfully. */ - actionBeforeSuccess? (e: ActionBeforeSuccessEventArgs): void; + actionBeforeSuccess?(e: ActionBeforeSuccessEventArgs): void; /** Triggers when the item selection is changed. */ - change? (e: ChangeEventArgs): void; + change?(e: ChangeEventArgs): void; /** Triggers when the list item is checked or unchecked. */ - checkChange? (e: CheckChangeEventArgs): void; + checkChange?(e: CheckChangeEventArgs): void; /** Triggers when the ListBox widget is created successfully. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Triggers when the ListBox widget is destroyed successfully. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Triggers when focus the listbox items. */ - focusIn? (e: FocusInEventArgs): void; + focusIn?(e: FocusInEventArgs): void; /** Triggers when focus out from listbox items. */ - focusOut? (e: FocusOutEventArgs): void; + focusOut?(e: FocusOutEventArgs): void; /** Triggers when the list item is being dragged. */ - itemDrag? (e: ItemDragEventArgs): void; + itemDrag?(e: ItemDragEventArgs): void; /** Triggers when the list item is ready to be dragged. */ - itemDragStart? (e: ItemDragStartEventArgs): void; + itemDragStart?(e: ItemDragStartEventArgs): void; /** Triggers when the list item stops dragging. */ - itemDragStop? (e: ItemDragStopEventArgs): void; + itemDragStop?(e: ItemDragStopEventArgs): void; /** Triggers when the list item is dropped. */ - itemDrop? (e: ItemDropEventArgs): void; + itemDrop?(e: ItemDropEventArgs): void; /** Triggers when a list item gets selected. */ - select? (e: SelectEventArgs): void; + select?(e: SelectEventArgs): void; /** Triggers when a list item gets unselected. */ - unselect? (e: UnselectEventArgs): void; + unselect?(e: UnselectEventArgs): void; } export interface ActionBeginEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; } export interface ActionSuccessEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; } export interface ActionCompleteEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; } export interface ActionFailureEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; } export interface ActionBeforeSuccessEventArgs { @@ -3350,7 +3370,7 @@ export interface ActionBeforeSuccessEventArgs { /** List of array object */ - result?: Array; + result?: any[]; /** ExecuteQuery object of DataManager */ @@ -3827,11 +3847,10 @@ export interface Fields { class Calculate { static fn: Calculate; - constructor(element: JQuery, options?: Calculate.Model); - constructor(element: Element, options?: Calculate.Model); + constructor(element: JQuery | Element, options?: Calculate.Model); static Locale: any; - model:Calculate.Model; - defaults:Calculate.Model; + model: Calculate.Model; + defaults: Calculate.Model; /** Add the custom formulas with function in CalcEngine library * @param {string} pass the formula name @@ -3882,19 +3901,21 @@ class Calculate { */ computeFormula(Formula: string): string; } -export module Calculate{ +export namespace Calculate { export interface Model { + /** Returns the cancel option value. + */ + cancel?: boolean; } } class CheckBox extends ej.Widget { static fn: CheckBox; - constructor(element: JQuery, options?: CheckBox.Model); - constructor(element: Element, options?: CheckBox.Model); + constructor(element: JQuery | Element, options?: CheckBox.Model); static Locale: any; - model:CheckBox.Model; - defaults:CheckBox.Model; + model: CheckBox.Model; + defaults: CheckBox.Model; /** Destroy the CheckBox widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. * @returns {void} @@ -3916,11 +3937,15 @@ class CheckBox extends ej.Widget { */ isChecked(): boolean; } -export module CheckBox{ +export namespace CheckBox { export interface Model { - /** Specifies whether CheckBox has to be in checked or not. We can also specify array of string as value for this property. If any of the value in the specified array matches the value of the textbox, then it will be considered as checked. It will be useful in MVVM binding, specify array type to identify the values of the checked CheckBoxes. + /** Specifies whether CheckBox has to be in checked or not. + * We can also specify array of string as value for this property. + * If any of the value in the specified array matches the value of the textbox, + * then it will be considered as checked. It will be useful in MVVM binding, + * specify array type to identify the values of the checked CheckBoxes. * @Default {false} */ checked?: boolean|string[]; @@ -3939,7 +3964,9 @@ export interface Model { */ enabled?: boolean; - /** Specifies the persist property for CheckBox while initialization. The persist API save current model value to browser cookies for state maintains. While refreshing the CheckBox control page the model value apply from browser cookies. + /** Specifies the persist property for CheckBox while initialization. + * The persist API save current model value to browser cookies for state maintains. + * While refreshing the CheckBox control page the model value apply from browser cookies. * @Default {false} */ enablePersistence?: boolean; @@ -4004,16 +4031,16 @@ export interface Model { value?: string; /** Fires before the CheckBox is going to changed its state successfully */ - beforeChange? (e: BeforeChangeEventArgs): void; + beforeChange?(e: BeforeChangeEventArgs): void; /** Fires when the CheckBox state is changed successfully */ - change? (e: ChangeEventArgs): void; + change?(e: ChangeEventArgs): void; /** Fires when the CheckBox state is created successfully */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Fires when the CheckBox state is destroyed successfully */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; } export interface BeforeChangeEventArgs { @@ -4096,8 +4123,7 @@ export interface DestroyEventArgs { type?: string; } } -enum CheckState -{ +enum CheckState { //string Uncheck, //string @@ -4105,8 +4131,7 @@ Check, //string Indeterminate, } -enum CheckboxSize -{ +enum CheckboxSize { //Displays the CheckBox in medium size Medium, //Displays the CheckBox in small size @@ -4115,11 +4140,10 @@ Small, class ColorPicker extends ej.Widget { static fn: ColorPicker; - constructor(element: JQuery, options?: ColorPicker.Model); - constructor(element: Element, options?: ColorPicker.Model); + constructor(element: JQuery | Element, options?: ColorPicker.Model); static Locale: any; - model:ColorPicker.Model; - defaults:ColorPicker.Model; + model: ColorPicker.Model; + defaults: ColorPicker.Model; /** Disables the color picker control * @returns {void} @@ -4175,7 +4199,7 @@ class ColorPicker extends ej.Widget { */ show(): void; } -export module ColorPicker{ +export namespace ColorPicker { export interface Model { @@ -4201,7 +4225,7 @@ export interface Model { /** This property allows to define the custom colors in the palette model.Custom palettes are created by passing a comma delimited string of HEX values or an array of colors. * @Default {empty} */ - custom?: Array; + custom?: any[]; /** This property allows to embed the popup in the order of DOM element flow . When we set the value as true, the color picker popup is always in visible state. * @Default {false} @@ -4243,7 +4267,8 @@ export interface Model { */ palette?: ej.ColorPicker.Palette|string; - /** This property allows to define the preset model to be rendered initially in palette type.It consists of 12 different types of presets. Each presets have 50 colors. See below available Presets + /** This property allows to define the preset model to be rendered initially in palette type.It consists of 12 different types of presets. Each presets have 50 colors. + * See below available Presets * @Default {ej.ColorPicker.Presets.Basic} */ presetType?: ej.ColorPicker.Presets|string; @@ -4263,7 +4288,8 @@ export interface Model { */ showPreview?: boolean; - /** This property allows to store the color values in custom list.The ColorPicker will keep up to 11 colors in a custom list.By clicking the add button, the selected color from picker or palette will get added in the recent color list. + /** This property allows to store the color values in custom list.The ColorPicker will keep up to 11 colors in a custom list. + * By clicking the add button, the selected color from picker or palette will get added in the recent color list. * @Default {false} */ showRecentColors?: boolean; @@ -4284,7 +4310,9 @@ export interface Model { toolIcon?: string; /** This property allows to define the customized text or content to displayed when mouse over the following elements. This property also allows to use the culture values. - * @Default {{ switcher: Switcher, addbutton: Add Color, basic: Basic, monochrome: Mono Chrome, flatcolors: Flat Color, seawolf: Sea Wolf, webcolors: Web Colors, sandy: Sandy, pinkshades: Pink Shades, misty: Misty, citrus: Citrus, vintage: Vintage, moonlight: Moon Light, candycrush: Candy Crush, currentcolor: Current Color, selectedcolor: Selected Color }} + * @Default {{ switcher: Switcher, addbutton: Add Color, basic: Basic, monochrome: Mono Chrome, flatcolors: Flat Color, seawolf: Sea Wolf, webcolors: Web Colors, + * sandy: Sandy, pinkshades: Pink Shades, misty: Misty, citrus: Citrus, vintage: Vintage, moonlight: Moon Light, candycrush: Candy Crush, + * currentcolor: Current Color, selectedcolor: Selected Color }} */ tooltipText?: TooltipText; @@ -4294,22 +4322,22 @@ export interface Model { value?: string; /** Fires after Color value has been changed successfully.If the user want to perform any operation after the color value changed then the user can make use of this change event. */ - change? (e: ChangeEventArgs): void; + change?(e: ChangeEventArgs): void; /** Fires after closing the color picker popup. */ - close? (e: CloseEventArgs): void; + close?(e: CloseEventArgs): void; /** Fires after Color picker control is created. If the user want to perform any operation after the color picker control creation then the user can make use of this create event. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Fires after Color picker control is destroyed. If the user want to perform any operation after the color picker control destroyed then the user can make use of this destroy event. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Fires after opening the color picker popup */ - open? (e: OpenEventArgs): void; + open?(e: OpenEventArgs): void; /** Fires after Color value has been selected successfully. If the user want to perform any operation after the color value selected then the user can make use of this select event. */ - select? (e: SelectEventArgs): void; + select?(e: SelectEventArgs): void; } export interface ChangeEventArgs { @@ -4492,7 +4520,7 @@ export interface TooltipText { selectedcolor?: string; } -enum ModelType{ +enum ModelType { ///support palette type mode in color picker. Palette, @@ -4502,7 +4530,7 @@ enum ModelType{ } -enum Palette{ +enum Palette { ///used to show the basic palette BasicPalette, @@ -4512,7 +4540,7 @@ enum Palette{ } -enum Presets{ +enum Presets { ///used to show the basic presets Basic, @@ -4549,9 +4577,8 @@ enum Presets{ } } -enum ButtonMode -{ -//Displays the button in split mode +enum ButtonMode { +//Displays the button in split mode Split, //Displays the button in Dropdown mode Dropdown, @@ -4559,11 +4586,10 @@ Dropdown, class FileExplorer extends ej.Widget { static fn: FileExplorer; - constructor(element: JQuery, options?: FileExplorer.Model); - constructor(element: Element, options?: FileExplorer.Model); + constructor(element: JQuery | Element, options?: FileExplorer.Model); static Locale: any; - model:FileExplorer.Model; - defaults:FileExplorer.Model; + model: FileExplorer.Model; + defaults: FileExplorer.Model; /** Refresh the size of FileExplorer control. * @returns {void} @@ -4571,25 +4597,25 @@ class FileExplorer extends ej.Widget { adjustSize(): void; /** Disable the particular context menu item. - * @param {string|HTMLElement} Id of the menu item/ Menu element to be disabled + * @param {string|HTMLElement} Id of the menu item/ Menu element to be disabled * @returns {void} */ disableMenuItem(item: string|HTMLElement): void; /** Disable the particular toolbar item. - * @param {string|HTMLElement} Id of the toolbar item/ Tool item element to be disabled + * @param {string|HTMLElement} Id of the toolbar item/ Tool item element to be disabled * @returns {void} */ disableToolbarItem(item: string|HTMLElement): void; /** Enable the particular context menu item. - * @param {string|HTMLElement} Id of the menu item/ Menu element to be Enabled + * @param {string|HTMLElement} Id of the menu item/ Menu element to be Enabled * @returns {void} */ enableMenuItem(item: string|HTMLElement): void; /** Enable the particular toolbar item - * @param {string|HTMLElement} Id of the tool item/ Tool item element to be Enabled + * @param {string|HTMLElement} Id of the tool item/ Tool item element to be Enabled * @returns {void} */ enableToolbarItem(item: string|HTMLElement): void; @@ -4600,12 +4626,12 @@ class FileExplorer extends ej.Widget { refresh(): void; /** Remove the particular toolbar item. - * @param {string|HTMLElement} Id of the tool item/ tool item element to be removed + * @param {string|HTMLElement} Id of the tool item/ tool item element to be removed * @returns {void} */ removeToolbarItem(item: string|HTMLElement): void; } -export module FileExplorer{ +export namespace FileExplorer { export interface Model { @@ -4618,12 +4644,14 @@ export interface Model { */ ajaxDataType?: string; - /** By using ajaxSettings property, you can customize the AJAX configurations. Normally you can customize the following option in AJAX handling data, URL, type, async, contentType, dataType and success. For upload, download and getImage API, you can only customize URL. + /** By using ajaxSettings property, you can customize the AJAX configurations. Normally you can customize the following option in AJAX handling data, URL, type, async, contentType, dataType and + * success. For upload, download and getImage API, you can only customize URL. * @Default {{ read: {}, createFolder: {}, remove: {}, rename: {}, paste: {}, getDetails: {}, download: {}, upload: {}, getImage: {}, search: {}}} */ ajaxSettings?: any; - /** The FileExplorer allows to move the files from one folder to another folder of FileExplorer by using drag and drop option. Also it supports to upload a file by dragging it from windows explorer to the necessary folder of ejFileExplorer. + /** The FileExplorer allows to move the files from one folder to another folder of FileExplorer by using drag and drop option. Also it supports to upload a file by dragging it + * from windows explorer to the necessary folder of ejFileExplorer. * @Default {true} */ allowDragAndDrop?: boolean; @@ -4642,7 +4670,8 @@ export interface Model { */ contextMenuSettings?: ContextMenuSettings; - /** Sets the root class for FileExplorer theme. This cssClass API allows to use custom skinning option for File Explorer control. By defining the root class by using this API, you have to include this root class in CSS. + /** Sets the root class for FileExplorer theme. This cssClass API allows to use custom skinning option for File Explorer control. + * By defining the root class by using this API, you have to include this root class in CSS. */ cssClass?: string; @@ -4729,7 +4758,7 @@ export interface Model { /** The selectedItems is used to select the specified items (file, folder) of FileExplorer control. */ - selectedItems?: string|Array; + selectedItems?: string|any[]; /** Enables or disables the checkbox option in FileExplorer control. * @Default {true} @@ -4741,7 +4770,8 @@ export interface Model { */ showContextMenu?: boolean; - /** Enables or disables the footer in FileExplorer control. The footer element displays the details of the current selected files and folders. And also the footer having the switcher to change the layout view. + /** Enables or disables the footer in FileExplorer control. The footer element displays the details of the current selected files and folders. + * And also the footer having the switcher to change the layout view. * @Default {true} */ showFooter?: boolean; @@ -4761,20 +4791,22 @@ export interface Model { */ showToolbar?: boolean; - /** Enables or disables the navigation pane in FileExplorer control. The navigation pane contains a tree view element that displays all the folders from the filesystem in a hierarchical manner. This is useful to a quick navigation of any folder in the filesystem. + /** Enables or disables the navigation pane in FileExplorer control. The navigation pane contains a tree view element that displays all the folders from the filesystem in a hierarchical manner. + * This is useful to a quick navigation of any folder in the filesystem. * @Default {true} */ showNavigationPane?: boolean; /** The tools property is used to configure and group required toolbar items in FileExplorer control. - * @Default {{ creation: [NewFolder], navigation: [Back, Forward, Upward], addressBar: [Addressbar], editing: [Refresh, Upload, Delete, Rename, Download], copyPaste: [Cut, Copy, Paste], getProperties: [Details], searchBar: [Searchbar], layout: [Layout], sortBy: [SortBy]}} + * @Default {{ creation: [NewFolder], navigation: [Back, Forward, Upward], addressBar: [Addressbar], editing: [Refresh, Upload, Delete, Rename, Download], copyPaste: [Cut, Copy, Paste], + * getProperties: [Details], searchBar: [Searchbar], layout: [Layout], sortBy: [SortBy]}} */ tools?: any; /** The toolsList property is used to arrange the toolbar items in the FileExplorer control. * @Default {[layout, creation, navigation, addressBar, editing, copyPaste, sortBy, getProperties, searchBar]} */ - toolsList?: Array; + toolsList?: any[]; /** Gets or sets an object that indicates whether to customize the upload behavior in the FileExplorer. */ @@ -4786,91 +4818,93 @@ export interface Model { width?: string|number; /** Fires before the AJAX request is performed. */ - beforeAjaxRequest? (e: BeforeAjaxRequestEventArgs): void; + beforeAjaxRequest?(e: BeforeAjaxRequestEventArgs): void; /** Fires before downloading the files. */ - beforeDownload? (e: BeforeDownloadEventArgs): void; + beforeDownload?(e: BeforeDownloadEventArgs): void; - /** Fires before getting a requested image from server. Also this event will be triggered when you have enabled thumbnail image compression option in FileExplorer.Using this event, you can customize the image compression size. */ - beforeGetImage? (e: BeforeGetImageEventArgs): void; + /** Fires before getting a requested image from server. Also this event will be triggered when you have enabled thumbnail image compression option in FileExplorer. + * Using this event, you can customize the image compression size. + */ + beforeGetImage?(e: BeforeGetImageEventArgs): void; /** Fires before files or folders open. */ - beforeOpen? (e: BeforeOpenEventArgs): void; + beforeOpen?(e: BeforeOpenEventArgs): void; /** Fires before uploading the files. */ - beforeUpload? (e: BeforeUploadEventArgs): void; + beforeUpload?(e: BeforeUploadEventArgs): void; /** Fires when FileExplorer control was created */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Fires when file or folder is copied successfully. */ - copy? (e: CopyEventArgs): void; + copy?(e: CopyEventArgs): void; /** Fires when new folder is created successfully in file system. */ - createFolder? (e: CreateFolderEventArgs): void; + createFolder?(e: CreateFolderEventArgs): void; /** Fires when file or folder is cut successfully. */ - cut? (e: CutEventArgs): void; + cut?(e: CutEventArgs): void; /** Fires when the FileExplorer is destroyed successfully. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Fires when the files or directory has been started to drag over on the FileExplorer */ - dragStart? (e: DragStartEventArgs): void; + dragStart?(e: DragStartEventArgs): void; /** Fires when the files or directory is dragging over on the FileExplorer. */ - drag? (e: DragEventArgs): void; + drag?(e: DragEventArgs): void; /** Fires when the files or directory has been stopped to drag over on FileExplorer */ - dragStop? (e: DragStopEventArgs): void; + dragStop?(e: DragStopEventArgs): void; /** Fires when the files or directory is dropped to the target folder of FileExplorer */ - drop? (e: DropEventArgs): void; + drop?(e: DropEventArgs): void; /** Fires after loading the requested image from server. Using this event, you can get the details of loaded image. */ - getImage? (e: GetImageEventArgs): void; + getImage?(e: GetImageEventArgs): void; /** Fires when keydown in FileExplorer control. */ - keydown? (e: KeydownEventArgs): void; + keydown?(e: KeydownEventArgs): void; /** Fires when the file view type is changed. */ - layoutChange? (e: LayoutChangeEventArgs): void; + layoutChange?(e: LayoutChangeEventArgs): void; /** Fires when before the ContextMenu opening. */ - menuBeforeOpen? (e: MenuBeforeOpenEventArgs): void; + menuBeforeOpen?(e: MenuBeforeOpenEventArgs): void; /** Fires when click the ContextMenu item. */ - menuClick? (e: MenuClickEventArgs): void; + menuClick?(e: MenuClickEventArgs): void; /** Fires when ContextMenu is successfully opened. */ - menuOpen? (e: MenuOpenEventArgs): void; + menuOpen?(e: MenuOpenEventArgs): void; /** Fires when files are successfully opened. */ - open? (e: OpenEventArgs): void; + open?(e: OpenEventArgs): void; /** Fires when a file or folder is pasted successfully. */ - paste? (e: PasteEventArgs): void; + paste?(e: PasteEventArgs): void; /** Fires when file or folder is deleted successfully. */ - remove? (e: RemoveEventArgs): void; + remove?(e: RemoveEventArgs): void; /** Fires when resizing is performed for FileExplorer. */ - resize? (e: ResizeEventArgs): void; + resize?(e: ResizeEventArgs): void; /** Fires when resizing is started for FileExplorer. */ - resizeStart? (e: ResizeStartEventArgs): void; + resizeStart?(e: ResizeStartEventArgs): void; /** Fires this event when the resizing is stopped for FileExplorer. */ - resizeStop? (e: ResizeStopEventArgs): void; + resizeStop?(e: ResizeStopEventArgs): void; /** Fires when the items from grid view or tile view of FileExplorer control is selected. */ - select? (e: SelectEventArgs): void; + select?(e: SelectEventArgs): void; /** Triggered when refresh the template column elements in the grid view of FileExplorer control. */ - templateRefresh? (e: TemplateRefreshEventArgs): void; + templateRefresh?(e: TemplateRefreshEventArgs): void; /** Fires when the items from grid view or tile view or large icons view of FileExplorer control is unselected. */ - unselect? (e: UnselectEventArgs): void; + unselect?(e: UnselectEventArgs): void; } export interface BeforeAjaxRequestEventArgs { @@ -5332,7 +5366,7 @@ export interface MenuBeforeOpenEventArgs { /** returns the dataSource of ContextMenu. */ - dataSource?: Array; + dataSource?: any[]; /** returns the element of ContextMenu. */ @@ -5661,20 +5695,21 @@ export interface UnselectEventArgs { /** Returns the unselected items details. */ - unselectedItems?: Array; + unselectedItems?: any[]; } export interface ContextMenuSettings { /** The items property is used to configure and group the required ContextMenu items in FileExplorer control. - * @Default {{% highlight javascript %}{navbar: [NewFolder, Upload, |, Delete, Rename, |, Cut, Copy, Paste, |, Getinfo],cwd: [Refresh, Paste,|, SortBy, |, NewFolder, Upload, |, Getinfo],files: [Open, Download, |, Upload, |, Delete, Rename, |, Cut, Copy, Paste, |, OpenFolderLocation, Getinfo]}{% endhighlight %}} + * @Default {{% highlight javascript %}{navbar: [NewFolder, Upload, |, Delete, Rename, |, Cut, Copy, Paste, |, Getinfo],cwd: [Refresh, Paste,|, SortBy, |, NewFolder, Upload, |, + * Getinfo],files: [Open, Download, |, Upload, |, Delete, Rename, |, Cut, Copy, Paste, |, OpenFolderLocation, Getinfo]}{% endhighlight %}} */ items?: any; /** The customMenuFields property is used to define custom functionality for custom ContextMenu item's which are defined in items property. * @Default {[]} */ - customMenuFields?: Array; + customMenuFields?: any[]; } export interface FilterSettings { @@ -5708,9 +5743,10 @@ export interface GridSettings { allowSorting?: boolean; /** Gets or sets an object that indicates to render the grid with specified columns. You can use this property same as the column property in Grid control. - * @Default {[{ field: name, headerText: Name, width: 30% }, { field: dateModified, headerText: Date Modified, width: 30% }, { field: type, headerText: Type, width: 15% }, { field: size, headerText: Size, width: 12%, textAlign: right, headerTextAlign: left }]} + * @Default {[{ field: name, headerText: Name, width: 30% }, { field: dateModified, headerText: Date Modified, width: 30% }, { field: type, headerText: Type, width: 15% }, + * { field: size, headerText: Size, width: 12%, textAlign: right, headerTextAlign: left }]} */ - columns?: Array; + columns?: any[]; } export interface UploadSettings { @@ -5731,12 +5767,12 @@ export interface UploadSettings { autoUpload?: boolean; } -enum layoutType{ +enum layoutType { ///Supports to display files in tile view Tile, - ///Supports to display files in grid view + ///Supports to display files in grid view Grid, ///Supports to display files as large icons @@ -5747,11 +5783,10 @@ enum layoutType{ class DatePicker extends ej.Widget { static fn: DatePicker; - constructor(element: JQuery, options?: DatePicker.Model); - constructor(element: Element, options?: DatePicker.Model); + constructor(element: JQuery | Element, options?: DatePicker.Model); static Locale: any; - model:DatePicker.Model; - defaults:DatePicker.Model; + model: DatePicker.Model; + defaults: DatePicker.Model; /** Disables the DatePicker control. * @returns {void} @@ -5778,7 +5813,7 @@ class DatePicker extends ej.Widget { */ show(): void; } -export module DatePicker{ +export namespace DatePicker { export interface Model { @@ -5816,7 +5851,8 @@ export interface Model { */ dayHeaderFormat?: string | ej.DatePicker.Header; - /** Specifies the navigation depth level in DatePicker calendar. This option is not applied when start level view option is lower than depth level view. See below to know available levels in DatePicker Calendar + /** Specifies the navigation depth level in DatePicker calendar. This option is not applied when start level view option is lower than depth level view. + * See below to know available levels in DatePicker Calendar */ depthLevel?: string | ej.DatePicker.Level; @@ -5845,7 +5881,8 @@ export interface Model { */ enableRTL?: boolean; - /** Allows to enter valid or invalid date in input textbox and indicate as error if it is invalid value, when this API value is set to true. For false value, invalid date is not allowed to input field and corrected to valid date automatically, even if invalid date is given. + /** Allows to enter valid or invalid date in input textbox and indicate as error if it is invalid value, when this API value is set to true. For false value, invalid date is not allowed + * to input field and corrected to valid date automatically, even if invalid date is given. * @Default {false} */ enableStrictMode?: boolean; @@ -5981,40 +6018,40 @@ export interface Model { width?: string; /** Fires before closing the DatePicker popup. */ - beforeClose? (e: BeforeCloseEventArgs): void; + beforeClose?(e: BeforeCloseEventArgs): void; /** Fires when each date is created in the DatePicker popup calendar. */ - beforeDateCreate? (e: BeforeDateCreateEventArgs): void; + beforeDateCreate?(e: BeforeDateCreateEventArgs): void; /** Fires before opening the DatePicker popup. */ - beforeOpen? (e: BeforeOpenEventArgs): void; + beforeOpen?(e: BeforeOpenEventArgs): void; /** Fires when the DatePicker input value is changed. */ - change? (e: ChangeEventArgs): void; + change?(e: ChangeEventArgs): void; /** Fires when DatePicker popup is closed. */ - close? (e: CloseEventArgs): void; + close?(e: CloseEventArgs): void; /** Fires when the DatePicker is created successfully. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Fires when the DatePicker is destroyed successfully. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Fires when DatePicker input gets focus. */ - focusIn? (e: FocusInEventArgs): void; + focusIn?(e: FocusInEventArgs): void; /** Fires when DatePicker input loses the focus. */ - focusOut? (e: FocusOutEventArgs): void; + focusOut?(e: FocusOutEventArgs): void; /** Fires when calender view navigates to month/year/decade/century. */ - navigate? (e: NavigateEventArgs): void; + navigate?(e: NavigateEventArgs): void; /** Fires when DatePicker popup is opened. */ - open? (e: OpenEventArgs): void; + open?(e: OpenEventArgs): void; /** Fires when a date is selected from the DatePicker popup. */ - select? (e: SelectEventArgs): void; + select?(e: SelectEventArgs): void; } export interface BeforeCloseEventArgs { @@ -6320,7 +6357,7 @@ export interface Fields { cssClass?: string; } -enum Header{ +enum Header { ///Removes day header in DatePicker None, @@ -6333,7 +6370,7 @@ enum Header{ } -enum Level{ +enum Level { ///allow navigation upto year level in DatePicker Year, @@ -6346,12 +6383,12 @@ enum Level{ } -enum HighlightSection{ +enum HighlightSection { - ///Highlight the week of the currently selected date in DatePicker popup calendar + ///Highlight the week of the currently selected date in DatePicker popup calendar Week, - ///Highlight the workdays in a currently selected date's week in DatePicker popup calendar + ///Highlight the workdays in a currently selected date's week in DatePicker popup calendar WorkDays, ///Nothing will be highlighted, remove highlights from DatePicker popup calendar if already exists @@ -6362,11 +6399,10 @@ enum HighlightSection{ class DateTimePicker extends ej.Widget { static fn: DateTimePicker; - constructor(element: JQuery, options?: DateTimePicker.Model); - constructor(element: Element, options?: DateTimePicker.Model); + constructor(element: JQuery | Element, options?: DateTimePicker.Model); static Locale: any; - model:DateTimePicker.Model; - defaults:DateTimePicker.Model; + model: DateTimePicker.Model; + defaults: DateTimePicker.Model; /** Disables the DateTimePicker control. * @returns {void} @@ -6398,7 +6434,7 @@ class DateTimePicker extends ej.Widget { */ show(): void; } -export module DateTimePicker{ +export namespace DateTimePicker { export interface Model { @@ -6426,7 +6462,8 @@ export interface Model { */ dayHeaderFormat?: ej.DatePicker.Header|string; - /** Specifies the navigation depth level in DatePicker calendar inside DateTimePicker popup. This option is not applied when start level view option is lower than depth level view. See ej.DatePicker.Level + /** Specifies the navigation depth level in DatePicker calendar inside DateTimePicker popup. This option is not applied + * when start level view option is lower than depth level view. See ej.DatePicker.Level */ depthLevel?: ej.DatePicker.Level|string; @@ -6570,31 +6607,31 @@ export interface Model { width?: string|number; /** Fires before the datetime popup closed in the DateTimePicker. */ - beforeClose? (e: BeforeCloseEventArgs): void; + beforeClose?(e: BeforeCloseEventArgs): void; /** Fires before the datetime popup open in the DateTimePicker. */ - beforeOpen? (e: BeforeOpenEventArgs): void; + beforeOpen?(e: BeforeOpenEventArgs): void; /** Fires when the datetime value changed in the DateTimePicker textbox. */ - change? (e: ChangeEventArgs): void; + change?(e: ChangeEventArgs): void; /** Fires when DateTimePicker popup closes. */ - close? (e: CloseEventArgs): void; + close?(e: CloseEventArgs): void; /** Fires after DateTimePicker control is created. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Fires when the DateTimePicker is destroyed successfully */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Fires when the focus-in happens in the DateTimePicker textbox. */ - focusIn? (e: FocusInEventArgs): void; + focusIn?(e: FocusInEventArgs): void; /** Fires when the focus-out happens in the DateTimePicker textbox. */ - focusOut? (e: FocusOutEventArgs): void; + focusOut?(e: FocusOutEventArgs): void; /** Fires when DateTimePicker popup opens. */ - open? (e: OpenEventArgs): void; + open?(e: OpenEventArgs): void; } export interface BeforeCloseEventArgs { @@ -6826,28 +6863,26 @@ export interface TimeDrillDown { autoClose?: boolean; } } -enum popupPosition -{ +enum popupPosition { //Opens the DateTimePicker popup below to the DateTimePicker input box Bottom, -//Opens the DateTimePicker popup above to the DateTimePicker input box +//Opens the DateTimePicker popup above to the DateTimePicker input box Top, } class DateRangePicker extends ej.Widget { static fn: DateRangePicker; - constructor(element: JQuery, options?: DateRangePicker.Model); - constructor(element: Element, options?: DateRangePicker.Model); + constructor(element: JQuery | Element, options?: DateRangePicker.Model); static Locale: any; - model:DateRangePicker.Model; - defaults:DateRangePicker.Model; + model: DateRangePicker.Model; + defaults: DateRangePicker.Model; /** Add the preset ranges to DateRangePicker popup. * @param {string} Display name * @param {Array} StartDate and endDate of range. * @returns {void} */ - addRanges(label: string, range: Array): void; + addRanges(label: string, range: any[]): void; /** Clears the all ranges selections in DateRangePicker popup * @returns {void} @@ -6884,7 +6919,7 @@ class DateRangePicker extends ej.Widget { */ setRange(): void; } -export module DateRangePicker{ +export namespace DateRangePicker { export interface Model { @@ -6978,28 +7013,28 @@ export interface Model { width?: string|number; /** Fires before closing the DateRangePicker popup. */ - beforeClose? (e: BeforeCloseEventArgs): void; + beforeClose?(e: BeforeCloseEventArgs): void; /** Fires before opening the DateRangePicker popup. */ - beforeOpen? (e: BeforeOpenEventArgs): void; + beforeOpen?(e: BeforeOpenEventArgs): void; /** Fires when the DateRangePicker values get changed. */ - onChange? (e: OnChangeEventArgs): void; + onChange?(e: OnChangeEventArgs): void; /** Fires when DateRangePicker popup is closed. */ - close? (e: CloseEventArgs): void; + close?(e: CloseEventArgs): void; /** Fires when the DateRangePicker is created successfully. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Fires when the DateRangePicker is destroyed successfully. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Fires when DateRangePicker popup is opened. */ - open? (e: OpenEventArgs): void; + open?(e: OpenEventArgs): void; /** Fires when a date ranges is selected from the DateRangePicker popup. */ - select? (e: SelectEventArgs): void; + select?(e: SelectEventArgs): void; } export interface BeforeCloseEventArgs { @@ -7177,11 +7212,10 @@ export interface SelectEventArgs { class Dialog extends ej.Widget { static fn: Dialog; - constructor(element: JQuery, options?: Dialog.Model); - constructor(element: Element, options?: Dialog.Model); + constructor(element: JQuery | Element, options?: Dialog.Model); static Locale: any; - model:Dialog.Model; - defaults:Dialog.Model; + model: Dialog.Model; + defaults: Dialog.Model; /** Closes the dialog widget dynamically. * @returns {any} @@ -7260,7 +7294,7 @@ class Dialog extends ej.Widget { */ focus(): any; } -export module Dialog{ +export namespace Dialog { export interface Model { @@ -7281,7 +7315,8 @@ export interface Model { */ allowKeyboardNavigation?: boolean; - /** Customizes the Dialog widget animations. The Dialog widget can be animated while opening and closing the dialog. In order to customize animation effects, you need to set Ă¢â‚¬Å“enableAnimationĂ¢â‚¬Â as true. It contains the following sub properties. + /** Customizes the Dialog widget animations. The Dialog widget can be animated while opening and closing the dialog. + * In order to customize animation effects, you need to set Ă¢â‚¬Å“enableAnimationĂ¢â‚¬Â as true. It contains the following sub properties. */ animation?: any; @@ -7293,7 +7328,8 @@ export interface Model { */ containment?: string; - /** The content type to load the dialog content at run time. The possible values are null, AJAX, iframe and image. When it is null (default value), the content inside dialog element will be displayed as content and when it is not null, the content will be loaded from the URL specified in the contentUrl property. + /** The content type to load the dialog content at run time. The possible values are null, AJAX, iframe and image. When it is null (default value), + * the content inside dialog element will be displayed as content and when it is not null, the content will be loaded from the URL specified in the contentUrl property. */ contentType?: string; @@ -7329,11 +7365,12 @@ export interface Model { */ enableRTL?: boolean; - /** The CSS class name to display the favicon in the dialog header. In order to display favicon, you need to set showHeader as true since the favicon will be displayed in the dialog header. + /** The CSS class name to display the favicon in the dialog header. In order to display favicon, you need to setĂ‚ showHeaderĂ‚ as true since the favicon will be displayed in the dialog header. */ faviconCSS?: string; - /** Sets the height for the dialog widget. It accepts both string and integer values. For example, it can accepts values like Ă¢â‚¬Å“autoĂ¢â‚¬Â, Ă¢â‚¬Å“100%Ă¢â‚¬Â, Ă¢â‚¬Å“100pxĂ¢â‚¬Â as string type and Ă¢â‚¬Å“100Ă¢â‚¬Â, Ă¢â‚¬Å“500Ă¢â‚¬Â as integer type. + /** Sets the height for the dialog widget. It accepts both string and integer values. For example, it can accepts values like Ă¢â‚¬Å“autoĂ¢â‚¬Â, Ă¢â‚¬Å“100%Ă¢â‚¬Â, Ă¢â‚¬Å“100pxĂ¢â‚¬Â as string type + * and Ă¢â‚¬Å“100Ă¢â‚¬Â, Ă¢â‚¬Å“500Ă¢â‚¬Â as integer type. */ height?: string|number; @@ -7394,7 +7431,8 @@ export interface Model { */ tooltip?: any; - /** Sets the height for the dialog widget. It accepts both string and integer values. For example, it can accepts values like Ă¢â‚¬Å“autoĂ¢â‚¬Â, Ă¢â‚¬Å“100%Ă¢â‚¬Â, Ă¢â‚¬Å“100pxĂ¢â‚¬Â as string type and Ă¢â‚¬Å“100Ă¢â‚¬Â, Ă¢â‚¬Å“500Ă¢â‚¬Â as integer type. + /** Sets the height for the dialog widget. It accepts both string and integer values. For example, it can accepts values like Ă¢â‚¬Å“autoĂ¢â‚¬Â, Ă¢â‚¬Å“100%Ă¢â‚¬Â, + * Ă¢â‚¬Å“100pxĂ¢â‚¬Â as string type and Ă¢â‚¬Å“100Ă¢â‚¬Â, Ă¢â‚¬Å“500Ă¢â‚¬Â as integer type. */ width?: string|number; @@ -7411,58 +7449,58 @@ export interface Model { footerTemplateId?: string; /** This event is triggered before the dialog widgets gets open. */ - beforeOpen? (e: BeforeOpenEventArgs): void; + beforeOpen?(e: BeforeOpenEventArgs): void; /** This event is triggered whenever the AJAX request fails to retrieve the dialog content. */ - ajaxError? (e: AjaxErrorEventArgs): void; + ajaxError?(e: AjaxErrorEventArgs): void; /** This event is triggered whenever the AJAX request to retrieve the dialog content, gets succeed. */ - ajaxSuccess? (e: AjaxSuccessEventArgs): void; + ajaxSuccess?(e: AjaxSuccessEventArgs): void; /** This event is triggered before the dialog widgets get closed. */ - beforeClose? (e: BeforeCloseEventArgs): void; + beforeClose?(e: BeforeCloseEventArgs): void; /** This event is triggered after the dialog widget is closed. */ - close? (e: CloseEventArgs): void; + close?(e: CloseEventArgs): void; /** Triggered after the dialog content is loaded in DOM. */ - contentLoad? (e: ContentLoadEventArgs): void; + contentLoad?(e: ContentLoadEventArgs): void; /** Triggered after the dialog is created successfully */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Triggered after the dialog widget is destroyed successfully */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Triggered while the dialog is dragged. */ - drag? (e: DragEventArgs): void; + drag?(e: DragEventArgs): void; /** Triggered when the user starts dragging the dialog. */ - dragStart? (e: DragStartEventArgs): void; + dragStart?(e: DragStartEventArgs): void; /** Triggered when the user stops dragging the dialog. */ - dragStop? (e: DragStopEventArgs): void; + dragStop?(e: DragStopEventArgs): void; /** Triggered after the dialog is opened. */ - open? (e: OpenEventArgs): void; + open?(e: OpenEventArgs): void; /** Triggered while the dialog is resized. */ - resize? (e: ResizeEventArgs): void; + resize?(e: ResizeEventArgs): void; /** Triggered when the user starts resizing the dialog. */ - resizeStart? (e: ResizeStartEventArgs): void; + resizeStart?(e: ResizeStartEventArgs): void; /** Triggered when the user stops resizing the dialog. */ - resizeStop? (e: ResizeStopEventArgs): void; + resizeStop?(e: ResizeStopEventArgs): void; /** Triggered when the dialog content is expanded. */ - expand? (e: ExpandEventArgs): void; + expand?(e: ExpandEventArgs): void; /** Triggered when the dialog content is collapsed. */ - collapse? (e: CollapseEventArgs): void; + collapse?(e: CollapseEventArgs): void; /** Triggered when the custom action button clicked. */ - actionButtonClick? (e: ActionButtonClickEventArgs): void; + actionButtonClick?(e: ActionButtonClickEventArgs): void; } export interface BeforeOpenEventArgs { @@ -7837,17 +7875,16 @@ export interface AjaxSettings { class DropDownList extends ej.Widget { static fn: DropDownList; - constructor(element: JQuery, options?: DropDownList.Model); - constructor(element: Element, options?: DropDownList.Model); + constructor(element: JQuery | Element, options?: DropDownList.Model); static Locale: any; - model:DropDownList.Model; - defaults:DropDownList.Model; + model: DropDownList.Model; + defaults: DropDownList.Model; /** Adding a single item or an array of items into the DropDownList allows you to specify all the field attributes such as value, template, image URL, and HTML attributes for those items. * @param {any|Array} this parameter should have field attributes with respect to mapped field attributes and it's corresponding values to fields * @returns {void} */ - addItem(data: any|Array): void; + addItem(data: any|any[]): void; /** This method is used to select all the items in the DropDownList. * @returns {void} @@ -7873,7 +7910,7 @@ class DropDownList extends ej.Widget { * @param {string|number|Array} disable the given index list items * @returns {void} */ - disableItemsByIndices(index: string|number|Array): void; + disableItemsByIndices(index: string|number|any[]): void; /** This property enables the DropDownList control. * @returns {void} @@ -7884,13 +7921,13 @@ class DropDownList extends ej.Widget { * @param {string|number|Array} enable the given index list items if it's disabled * @returns {void} */ - enableItemsByIndices(index: string|number|Array): void; + enableItemsByIndices(index: string|number|any[]): void; /** This method retrieves the items using given value. * @param {string|number|any} Return the whole object of data based on given value * @returns {Array} */ - getItemDataByValue(value: string|number|any): Array; + getItemDataByValue(value: string|number|any): any[]; /** This method is used to retrieve the items that are bound with the DropDownList. * @returns {any} @@ -7900,12 +7937,12 @@ class DropDownList extends ej.Widget { /** This method is used to get the selected items in the DropDownList. * @returns {Array} */ - getSelectedItem(): Array; + getSelectedItem(): any[]; /** This method is used to retrieve the items value that are selected in the DropDownList. - * @returns {string|number} + * @returns {string} */ - getSelectedValue(): string|number; + getSelectedValue(): string; /** This method hides the suggestion popup in the DropDownList. * @returns {void} @@ -7916,19 +7953,19 @@ class DropDownList extends ej.Widget { * @param {string|number|Array} select the given index list items * @returns {void} */ - selectItemsByIndices(index: string|number|Array): void; + selectItemsByIndices(index: string|number|any[]): void; /** This method is used to select an item in the DropDownList by using the given text value. * @param {string|number|Array} select the list items relates to given text * @returns {void} */ - selectItemByText(index: string|number|Array): void; + selectItemByText(index: string|number|any[]): void; /** This method is used to select an item in the DropDownList by using the given value. * @param {string|number|Array} select the list items relates to given values * @returns {void} */ - selectItemByValue(index: string|number|Array): void; + selectItemByValue(index: string|number|any[]): void; /** This method shows the DropDownList control with the suggestion popup. * @returns {void} @@ -7944,25 +7981,26 @@ class DropDownList extends ej.Widget { * @param {string|number|Array} unselect the given index list items * @returns {void} */ - unselectItemsByIndices(index: string|number|Array): void; + unselectItemsByIndices(index: string|number|any[]): void; /** This method is used to unselect an item in the DropDownList by using the given text value. * @param {string|number|Array} unselect the list items relates to given text * @returns {void} */ - unselectItemByText(index: string|number|Array): void; + unselectItemByText(index: string|number|any[]): void; /** This method is used to unselect an item in the DropDownList by using the given value. * @param {string|number|Array} unselect the list items relates to given values * @returns {void} */ - unselectItemByValue(index: string|number|Array): void; + unselectItemByValue(index: string|number|any[]): void; } -export module DropDownList{ +export namespace DropDownList { export interface Model { - /** The Virtual Scrolling(lazy loading) feature is used to display a large amount of data that you require without buffering the entire load of a huge database records in the DropDownList, that is, when scrolling, an AJAX request is sent to fetch some amount of data from the server dynamically. To achieve this scenario with DropDownList, set the allowVirtualScrolling to true. + /** The Virtual Scrolling(lazy loading) feature is used to display a large amount of data that you require without buffering the entire load of a huge database records in the DropDownList, + * that is, when scrolling, an AJAX request is sent to fetch some amount of data from the server dynamically. To achieve this scenario with DropDownList, set the allowVirtualScrolling to true. * @Default {false} */ allowVirtualScrolling?: boolean; @@ -7977,16 +8015,19 @@ export interface Model { */ caseSensitiveSearch?: boolean; - /** Dropdown widget's style and appearance can be controlled based on 13 different default built-in themes.You can customize the appearance of the dropdown by using the cssClass property. You need to specify a class name in the cssClass property and the same class name is used before the class definitions wherever the custom styles are applied. + /** Dropdown widget's style and appearance can be controlled based on 13 different default built-in themes.You can customize the appearance of the dropdown by using the cssClass property. + * You need to specify a class name in the cssClass property and the same class name is used before the class definitions wherever the custom styles are applied. */ cssClass?: string; - /** This property is used to serve data from the data services based on the query provided. To bind the data to the dropdown widget, the dataSource property is assigned with the instance of the ej.DataManager. + /** This property is used to serve data from the data services based on the query provided. To bind the data to the dropdown widget, + * the dataSource property is assigned with the instance of the ej.DataManager. * @Default {null} */ dataSource?: any; - /** Sets the separator when the multiSelectMode with delimiter option or checkbox is enabled with the dropdown. When you enter the delimiter value, the texts after the delimiter are considered as a separate word or query. The delimiter string is a single character and must be a symbol. Mostly, the delimiter symbol is used as comma (,) or semi-colon (;) or any other special character. + /** Sets the separator when the multiSelectMode with delimiter option or checkbox is enabled with the dropdown. When you enter the delimiter value,the texts after the delimiter are considered + * as a separate word or query. The delimiter string is a single character and must be a symbol. Mostly, the delimiter symbol is used as comma (,) or semi-colon (;) or any other special character. * @Default {','} */ delimiterChar?: string; @@ -7996,7 +8037,8 @@ export interface Model { */ enableAnimation?: boolean; - /** This property is used to indicate whether the DropDownList control responds to the user interaction or not. By default, the control is in the enabled mode and you can disable it by setting it to false. + /** This property is used to indicate whether the DropDownList control responds to the user interaction or not. By default, the control is in the enabled mode + * and you can disable it by setting it to false. * @Default {true} */ enabled?: boolean; @@ -8011,7 +8053,8 @@ export interface Model { */ enableFilterSearch?: boolean; - /** Saves the current model value to the browser cookies for state maintenance. While refreshing the DropDownList control page, it retains the model value and it is applied from the browser cookies. + /** Saves the current model value to the browser cookies for state maintenance. While refreshing the DropDownList control page, it retains the model value and + * it is applied from the browser cookies. * @Default {false} */ enablePersistence?: boolean; @@ -8086,7 +8129,9 @@ export interface Model { */ minPopupWidth?: string|number; - /** With the help of this property, you can make a single or multi selection with the DropDownList and display the text in two modes, delimiter and visual mode. In delimiter mode, you can separate the items by using the delimiter character such as comma (,) or semi-colon (;) or any other special character. In the visual mode, the items are showcased like boxes with close icon in the textbox. + /** With the help of this property, you can make a single or multi selection with the DropDownList and display the text in two modes, delimiter and visual mode. + * In delimiter mode, you can separate the items by using the delimiter character such as comma (,) or semi-colon (;) or any other special character. + * In the visual mode, the items are showcased like boxes with close icon in the textbox. * @Default {ej.MultiSelectMode.None} */ multiSelectMode?: ej.MultiSelectMode|string; @@ -8119,7 +8164,7 @@ export interface Model { /** Specifies the selectedItems for the DropDownList. * @Default {[]} */ - selectedIndices?: Array; + selectedIndices?: any[]; /** Selects multiple items in the DropDownList with the help of the checkbox control. To achieve this, enable the showCheckbox option to true. * @Default {false} @@ -8181,73 +8226,75 @@ export interface Model { */ width?: string|number; - /** The Virtual Scrolling feature is used to display a large amount of records in the DropDownList, that is, when scrolling, an AJAX request is sent to fetch some amount of data from the server dynamically. To achieve this scenario with DropDownList, set the allowVirtualScrolling to true. You can set the itemsCount property that represents the number of items to be fetched from the server on every AJAX request. + /** The Virtual Scrolling feature is used to display a large amount of records in the DropDownList, that is, when scrolling, an AJAX request is sent to fetch some amount of data from + * the server dynamically. To achieve this scenario with DropDownList, set the allowVirtualScrolling to true. + * You can set the itemsCount property that represents the number of items to be fetched from the server on every AJAX request. * @Default {normal} */ virtualScrollMode?: ej.VirtualScrollMode|string; /** Fires the action before the XHR request. */ - actionBegin? (e: ActionBeginEventArgs): void; + actionBegin?(e: ActionBeginEventArgs): void; /** Fires the action when the list of items is bound to the DropDownList by xhr post calling */ - actionComplete? (e: ActionCompleteEventArgs): void; + actionComplete?(e: ActionCompleteEventArgs): void; /** Fires the action when the xhr post calling failed on remote data binding with the DropDownList control. */ - actionFailure? (e: ActionFailureEventArgs): void; + actionFailure?(e: ActionFailureEventArgs): void; /** Fires the action when the xhr post calling succeed on remote data binding with the DropDownList control */ - actionSuccess? (e: ActionSuccessEventArgs): void; + actionSuccess?(e: ActionSuccessEventArgs): void; /** Fires the action before the popup is ready to hide. */ - beforePopupHide? (e: BeforePopupHideEventArgs): void; + beforePopupHide?(e: BeforePopupHideEventArgs): void; /** Fires the action before the popup is ready to be displayed. */ - beforePopupShown? (e: BeforePopupShownEventArgs): void; + beforePopupShown?(e: BeforePopupShownEventArgs): void; /** Fires when the cascading happens between two DropDownList exactly after the value changes in the first dropdown and before filtering in the second Dropdown. */ - cascade? (e: CascadeEventArgs): void; + cascade?(e: CascadeEventArgs): void; /** Fires the action when the DropDownList controlĂ¢â‚¬â„¢s value is changed. */ - change? (e: ChangeEventArgs): void; + change?(e: ChangeEventArgs): void; /** Fires the action when the list item checkbox value is changed. */ - checkChange? (e: CheckChangeEventArgs): void; + checkChange?(e: CheckChangeEventArgs): void; /** Fires the action once the DropDownList is created. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Fires the action when the list items is bound to the DropDownList. */ - dataBound? (e: DataBoundEventArgs): void; + dataBound?(e: DataBoundEventArgs): void; /** Fires the action when the DropDownList is destroyed. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Fires the action when the DropDownList is focused. */ - focusIn? (e: FocusInEventArgs): void; + focusIn?(e: FocusInEventArgs): void; /** Fires the action when the DropDownList is about to lose focus. */ - focusOut? (e: FocusOutEventArgs): void; + focusOut?(e: FocusOutEventArgs): void; /** Fires the action, once the popup is closed */ - popupHide? (e: PopupHideEventArgs): void; + popupHide?(e: PopupHideEventArgs): void; /** Fires the action, when the popup is resized. */ - popupResize? (e: PopupResizeEventArgs): void; + popupResize?(e: PopupResizeEventArgs): void; /** Fires the action, once the popup is opened. */ - popupShown? (e: PopupShownEventArgs): void; + popupShown?(e: PopupShownEventArgs): void; /** Fires the action, when resizing a popup starts. */ - popupResizeStart? (e: PopupResizeStartEventArgs): void; + popupResizeStart?(e: PopupResizeStartEventArgs): void; /** Fires the action, when the popup resizing is stopped. */ - popupResizeStop? (e: PopupResizeStopEventArgs): void; + popupResizeStop?(e: PopupResizeStopEventArgs): void; /** Fires the action before filtering the list items that starts in the DropDownList when the enableFilterSearch is enabled. */ - search? (e: SearchEventArgs): void; + search?(e: SearchEventArgs): void; /** Fires the action, when the list of item is selected. */ - select? (e: SelectEventArgs): void; + select?(e: SelectEventArgs): void; } export interface ActionBeginEventArgs { @@ -8279,11 +8326,11 @@ export interface ActionCompleteEventArgs { */ model?: any; - /** Returns the query for data retrieval + /** Returns the query for data retrieval */ query?: any; - /** Returns the query for data retrieval from the Database + /** Returns the query for data retrieval from the Database */ request?: any; @@ -8293,7 +8340,7 @@ export interface ActionCompleteEventArgs { /** Returns the number of items fetched from remote data */ - result?: Array; + result?: any[]; /** Returns the requested data */ @@ -8314,7 +8361,7 @@ export interface ActionFailureEventArgs { */ model?: any; - /** Returns the query for data retrieval + /** Returns the query for data retrieval */ query?: any; @@ -8337,11 +8384,11 @@ export interface ActionSuccessEventArgs { */ model?: any; - /** Returns the query for data retrieval + /** Returns the query for data retrieval */ query?: any; - /** Returns the query for data retrieval from the Database + /** Returns the query for data retrieval from the Database */ request?: any; @@ -8351,7 +8398,7 @@ export interface ActionSuccessEventArgs { /** Returns the number of items fetched from remote data */ - result?: Array; + result?: any[]; /** Returns the requested data */ @@ -8788,24 +8835,21 @@ export interface Fields { value?: string; } } -enum FilterType -{ -//filter the data wherever contains search key +enum FilterType { +//filter the data wherever contains search key Contains, //filter the data based on search key present at start position StartsWith, } -enum MultiSelectMode -{ -// can select only single item in DropDownList +enum MultiSelectMode { +// can select only single item in DropDownList None, //can select multiple items and it's separated by delimiterChar Delimiter, // can select multiple items and it's show's like visual box in textbox VisualMode, } -enum VirtualScrollMode -{ +enum VirtualScrollMode { // The data is loaded only to the corresponding page (display items). When scrolling some other position, it enables the load on demand with the DropDownList. Normal, //The data items are loaded from the remote when scroll handle reaches the end of the scrollbar like infinity scrolling. @@ -8814,11 +8858,10 @@ Continuous, class Tooltip extends ej.Widget { static fn: Tooltip; - constructor(element: JQuery, options?: Tooltip.Model); - constructor(element: Element, options?: Tooltip.Model); + constructor(element: JQuery | Element, options?: Tooltip.Model); static Locale: any; - model:Tooltip.Model; - defaults:Tooltip.Model; + model: Tooltip.Model; + defaults: Tooltip.Model; /** Destroys the Tooltip control. * @returns {void} @@ -8840,7 +8883,7 @@ class Tooltip extends ej.Widget { * @param {Function} optional custom effect takes place when hiding the tooltip. * @returns {void} */ - hide(effect?: string, func?: Function): void; + hide(effect?: string, func?: any): void; /** Shows the Tooltip popup for the given target element with the specified effect. * @param {string} optional Determines the type of effect that takes place when showing the tooltip. @@ -8848,9 +8891,9 @@ class Tooltip extends ej.Widget { * @param {JQuery} optional Tooltip will be shown for the given element * @returns {void} */ - show(effect?: string, func?: Function, target?: JQuery): void; + show(effect?: string, func?: any, target?: JQuery): void; } -export module Tooltip{ +export namespace Tooltip { export interface Model { @@ -8953,31 +8996,31 @@ export interface Model { width?: string|number; /** This event is triggered before the Tooltip widget get closed. */ - beforeClose? (e: BeforeCloseEventArgs): void; + beforeClose?(e: BeforeCloseEventArgs): void; /** This event is triggered before the Tooltip widget gets open. */ - beforeOpen? (e: BeforeOpenEventArgs): void; + beforeOpen?(e: BeforeOpenEventArgs): void; /** Fires on clicking to the target element. */ - click? (e: ClickEventArgs): void; + click?(e: ClickEventArgs): void; /** This event is triggered after the Tooltip widget is closed. */ - close? (e: CloseEventArgs): void; + close?(e: CloseEventArgs): void; /** This event is triggered after the Tooltip is created successfully. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** This event is triggered after the Tooltip widget is destroyed successfully. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** This event is triggered while hovering the target element, when tooltip positioning relates to target element. */ - hover? (e: HoverEventArgs): void; + hover?(e: HoverEventArgs): void; /** This event is triggered after the Tooltip is opened. */ - open? (e: OpenEventArgs): void; + open?(e: OpenEventArgs): void; /** This event is triggered while hover the target element, when the tooltip positioning is relates to the mouse. */ - tracking? (e: TrackingEventArgs): void; + tracking?(e: TrackingEventArgs): void; } export interface BeforeCloseEventArgs { @@ -9193,7 +9236,7 @@ export interface Position { stem?: PositionStem; } -enum effect{ +enum effect { ///No animation takes place when showing/hiding the Tooltip None, @@ -9206,7 +9249,7 @@ enum effect{ } -enum Associate{ +enum Associate { ///Sets the position related to target element. Target, @@ -9225,7 +9268,7 @@ enum Associate{ } -enum CloseMode{ +enum CloseMode { ///Enables close button in Tooltip. Sticky, @@ -9238,7 +9281,7 @@ enum CloseMode{ } -enum Collision{ +enum Collision { ///Flips the Tooltip to the opposite side of the target, if collision is occurs. Flip, @@ -9254,7 +9297,7 @@ enum Collision{ } -enum Trigger{ +enum Trigger { ///The Tooltip to be shown when the target element is clicked. Click, @@ -9270,11 +9313,10 @@ enum Trigger{ class Editor extends ej.Widget { static fn: Editor; - constructor(element: JQuery, options?: Editor.Model); - constructor(element: Element, options?: Editor.Model); + constructor(element: JQuery | Element, options?: Editor.Model); static Locale: any; - model:Editor.Model; - defaults:Editor.Model; + model: Editor.Model; + defaults: Editor.Model; /** destroy the editor widgets all events are unbind automatically and bring the control to pre-init state. * @returns {void} @@ -9297,15 +9339,15 @@ class Editor extends ej.Widget { getValue(): number; } - class NumericTextbox extends Editor{ + class NumericTextbox extends Editor { } - class CurrencyTextbox extends Editor{ + class CurrencyTextbox extends Editor { } - class PercentageTextbox extends Editor{ + class PercentageTextbox extends Editor { } -export module Editor{ +export namespace Editor { export interface Model { @@ -9388,12 +9430,14 @@ export interface Model { */ name?: string; - /** Specifies the pattern for formatting positive values in editor.We have maintained some standard to define the negative pattern. you have to specify 'n' to place the digit in your pattern.ejTextbox allows you to define a currency or percent symbol where you want to place it. + /** Specifies the pattern for formatting positive values in editor.We have maintained some standard to define the negative pattern. + * you have to specify 'n' to place the digit in your pattern.ejTextbox allows you to define a currency or percent symbol where you want to place it. * @Default {Based on the culture} */ negativePattern?: string; - /** Specifies the pattern for formatting positive values in editor.We have maintained some standard to define the positive pattern. you have to specify 'n' to place the digit in your pattern.ejTextbox allows you to define a currency or percent symbol where you want to place it. + /** Specifies the pattern for formatting positive values in editor.We have maintained some standard to define the positive pattern. + * you have to specify 'n' to place the digit in your pattern.ejTextbox allows you to define a currency or percent symbol where you want to place it. * @Default {Based on the culture} */ positivePattern?: string; @@ -9444,19 +9488,19 @@ export interface Model { width?: string; /** Fires after Editor control value is changed. */ - change? (e: ChangeEventArgs): void; + change?(e: ChangeEventArgs): void; /** Fires after Editor control is created. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Fires when the Editor is destroyed successfully. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Fires after Editor control is focused. */ - focusIn? (e: FocusInEventArgs): void; + focusIn?(e: FocusInEventArgs): void; /** Fires after Editor control is loss the focus. */ - focusOut? (e: FocusOutEventArgs): void; + focusOut?(e: FocusOutEventArgs): void; } export interface ChangeEventArgs { @@ -9553,11 +9597,10 @@ export interface FocusOutEventArgs { class ListView extends ej.Widget { static fn: ListView; - constructor(element: JQuery, options?: ListView.Model); - constructor(element: Element, options?: ListView.Model); + constructor(element: JQuery | Element, options?: ListView.Model); static Locale: any; - model:ListView.Model; - defaults:ListView.Model; + model: ListView.Model; + defaults: ListView.Model; /** To add item in the given index. If you have enabled grouping in ListView then you need to pass the corresponding group list title to add item in it. * @param {any} Specifies the item to be added in ListView @@ -9614,12 +9657,12 @@ class ListView extends ej.Widget { /** To get all the checked items. * @returns {Array} */ - getCheckedItems(): Array; + getCheckedItems(): any[]; /** To get the text of all the checked items. * @returns {Array} */ - getCheckedItemsText(): Array; + getCheckedItemsText(): any[]; /** To get the total item count. * @returns {number} @@ -9706,7 +9749,7 @@ class ListView extends ej.Widget { */ unCheckItem(index: number): void; } -export module ListView{ +export namespace ListView { export interface Model { @@ -9718,16 +9761,17 @@ export interface Model { /** Set the index values to be selected on initial loading. This works only when enableCheckMark is set true. * @Default {[]} */ - checkedIndices?: Array; + checkedIndices?: any[]; - /** Sets the root class for ListView theme. This cssClass API helps to use custom skinning option for ListView control. By defining the root class using this API, we need to include this root class in CSS. + /** Sets the root class for ListView theme. This cssClass API helps to use custom skinning option for ListView control. By defining the root class using this API, + * we need to include this root class in CSS. */ cssClass?: string; /** Contains the list of data for generating the ListView items. * @Default {[]} */ - dataSource?: Array; + dataSource?: any[]; /** Specifies whether to load AJAX content while selecting item. * @Default {false} @@ -9766,7 +9810,7 @@ export interface Model { /** Contains the array of items to be added in ListView. * @Default {[]} */ - items?: Array; + items?: any[]; /** Specifies the text of the back button in the header. * @Default {null} @@ -9833,28 +9877,28 @@ export interface Model { width?: string|number; /** Event triggers before the AJAX request happens. */ - ajaxBeforeLoad? (e: AjaxBeforeLoadEventArgs): void; + ajaxBeforeLoad?(e: AjaxBeforeLoadEventArgs): void; /** Event triggers after the AJAX content loaded completely. */ - ajaxComplete? (e: AjaxCompleteEventArgs): void; + ajaxComplete?(e: AjaxCompleteEventArgs): void; /** Event triggers when the AJAX request failed. */ - ajaxError? (e: AjaxErrorEventArgs): void; + ajaxError?(e: AjaxErrorEventArgs): void; /** Event triggers after the AJAX content loaded successfully. */ - ajaxSuccess? (e: AjaxSuccessEventArgs): void; + ajaxSuccess?(e: AjaxSuccessEventArgs): void; /** Event triggers before the items loaded. */ - load? (e: LoadEventArgs): void; + load?(e: LoadEventArgs): void; /** Event triggers after the items loaded. */ - loadComplete? (e: LoadCompleteEventArgs): void; + loadComplete?(e: LoadCompleteEventArgs): void; /** Event triggers when mouse down happens on the item. */ - mouseDown? (e: MouseDownEventArgs): void; + mouseDown?(e: MouseDownEventArgs): void; /** Event triggers when mouse up happens on the item. */ - mouseUp? (e: MouseUpEventArgs): void; + mouseUp?(e: MouseUpEventArgs): void; } export interface AjaxBeforeLoadEventArgs { @@ -10107,11 +10151,10 @@ export interface AjaxSettings { class MaskEdit extends ej.Widget { static fn: MaskEdit; - constructor(element: JQuery, options?: MaskEdit.Model); - constructor(element: Element, options?: MaskEdit.Model); + constructor(element: JQuery | Element, options?: MaskEdit.Model); static Locale: any; - model:MaskEdit.Model; - defaults:MaskEdit.Model; + model: MaskEdit.Model; + defaults: MaskEdit.Model; /** To clear the text in mask edit textbox control. * @returns {void} @@ -10138,7 +10181,7 @@ class MaskEdit extends ej.Widget { */ get_UnstrippedValue(): string; } -export module MaskEdit{ +export namespace MaskEdit { export interface Model { @@ -10242,34 +10285,34 @@ export interface Model { width?: string; /** Fires when value changed in mask edit textbox control. */ - change? (e: ChangeEventArgs): void; + change?(e: ChangeEventArgs): void; /** Fires after MaskEdit control is created. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Fires when the MaskEdit is destroyed successfully. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Fires when focused in mask edit textbox control. */ - focusIn? (e: FocusInEventArgs): void; + focusIn?(e: FocusInEventArgs): void; /** Fires when focused out in mask edit textbox control. */ - focusOut? (e: FocusOutEventArgs): void; + focusOut?(e: FocusOutEventArgs): void; /** Fires when keydown in mask edit textbox control. */ - keydown? (e: KeydownEventArgs): void; + keydown?(e: KeydownEventArgs): void; /** Fires when key press in mask edit textbox control. */ - keyPress? (e: KeyPressEventArgs): void; + keyPress?(e: KeyPressEventArgs): void; /** Fires when keyup in mask edit textbox control. */ - keyup? (e: KeyupEventArgs): void; + keyup?(e: KeyupEventArgs): void; /** Fires when mouse out in mask edit textbox control. */ - mouseOut? (e: MouseOutEventArgs): void; + mouseOut?(e: MouseOutEventArgs): void; /** Fires when mouse over in mask edit textbox control. */ - mouseOver? (e: MouseOverEventArgs): void; + mouseOver?(e: MouseOverEventArgs): void; } export interface ChangeEventArgs { @@ -10486,15 +10529,13 @@ export interface MouseOverEventArgs { unmaskedValue?: string; } } -enum InputMode -{ +enum InputMode { //string Password, //string Text, } -enum TextAlign -{ +enum TextAlign { //string Center, //string @@ -10507,11 +10548,10 @@ Right, class Menu extends ej.Widget { static fn: Menu; - constructor(element: JQuery, options?: Menu.Model); - constructor(element: Element, options?: Menu.Model); + constructor(element: JQuery | Element, options?: Menu.Model); static Locale: any; - model:Menu.Model; - defaults:Menu.Model; + model: Menu.Model; + defaults: Menu.Model; /** Disables the Menu control. * @returns {void} @@ -10582,7 +10622,7 @@ class Menu extends ej.Widget { * @param {any|Array} Selector of target node or Object of target node. * @returns {void} */ - remove(target: any|Array): void; + remove(target: any|any[]): void; /** To show the Menu control. * @param {number} x co-ordinate position of context menu. @@ -10598,7 +10638,7 @@ class Menu extends ej.Widget { */ showItems(): void; } -export module Menu{ +export namespace Menu { export interface Model { @@ -10717,37 +10757,37 @@ export interface Model { overflowWidth?: string|number; /** Fires before context menu gets open. */ - beforeOpen? (e: BeforeOpenEventArgs): void; + beforeOpen?(e: BeforeOpenEventArgs): void; /** Fires when mouse click on menu items. */ - click? (e: ClickEventArgs): void; + click?(e: ClickEventArgs): void; /** Fire when context menu on close. */ - close? (e: CloseEventArgs): void; + close?(e: CloseEventArgs): void; /** Fires when context menu on open. */ - open? (e: OpenEventArgs): void; + open?(e: OpenEventArgs): void; /** Fires to create menu items. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Fires to destroy menu items. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Fires when key down on menu items. */ - keydown? (e: KeydownEventArgs): void; + keydown?(e: KeydownEventArgs): void; /** Fires when mouse out from menu items. */ - mouseout? (e: MouseoutEventArgs): void; + mouseout?(e: MouseoutEventArgs): void; /** Fires when mouse over the Menu items. */ - mouseover? (e: MouseoverEventArgs): void; + mouseover?(e: MouseoverEventArgs): void; /** Fires when overflow popup menu opens. */ - overflowOpen? (e: OverflowOpenEventArgs): void; + overflowOpen?(e: OverflowOpenEventArgs): void; /** Fires when overflow popup menu closes. */ - overflowClose? (e: OverflowCloseEventArgs): void; + overflowClose?(e: OverflowCloseEventArgs): void; } export interface BeforeOpenEventArgs { @@ -11010,22 +11050,19 @@ export interface Fields { url?: string; } } -enum AnimationType -{ +enum AnimationType { //string Default, //string None, } -enum MenuType -{ +enum MenuType { //string ContextMenu, //string NormalMenu, } -enum Direction -{ +enum Direction { //string Left, //string @@ -11036,11 +11073,10 @@ Right, class Pager extends ej.Widget { static fn: Pager; - constructor(element: JQuery, options?: Pager.Model); - constructor(element: Element, options?: Pager.Model); + constructor(element: JQuery | Element, options?: Pager.Model); static Locale: any; - model:Pager.Model; - defaults:Pager.Model; + model: Pager.Model; + defaults: Pager.Model; /** Send a paging request to specified page through the pager control. * @param {number} Specifies the index to be navigated @@ -11053,7 +11089,7 @@ class Pager extends ej.Widget { */ refreshPager(): void; } -export module Pager{ +export namespace Pager { export interface Model { @@ -11085,7 +11121,8 @@ export interface Model { */ externalMessage?: string; - /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and culture specific to a particular country or region. + /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. + * in a language and culture specific to a particular country or region. * @Default {en-US} */ locale?: string; @@ -11116,7 +11153,7 @@ export interface Model { showPageInfo?: boolean; /** Triggered when pager numeric item is clicked in pager control. */ - click? (e: ClickEventArgs): void; + click?(e: ClickEventArgs): void; } export interface ClickEventArgs { @@ -11145,11 +11182,10 @@ export interface ClickEventArgs { class ProgressBar extends ej.Widget { static fn: ProgressBar; - constructor(element: JQuery, options?: ProgressBar.Model); - constructor(element: Element, options?: ProgressBar.Model); + constructor(element: JQuery | Element, options?: ProgressBar.Model); static Locale: any; - model:ProgressBar.Model; - defaults:ProgressBar.Model; + model: ProgressBar.Model; + defaults: ProgressBar.Model; /** Destroy the progressbar widget * @returns {void} @@ -11176,7 +11212,7 @@ class ProgressBar extends ej.Widget { */ getValue(): number; } -export module ProgressBar{ +export namespace ProgressBar { export interface Model { @@ -11246,19 +11282,19 @@ export interface Model { width?: number|string; /** Event triggers when the progress value changed */ - change? (e: ChangeEventArgs): void; + change?(e: ChangeEventArgs): void; /** Event triggers when the process completes (at 100%) */ - complete? (e: CompleteEventArgs): void; + complete?(e: CompleteEventArgs): void; /** Event triggers when the progressbar are created */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Event triggers when the progressbar are destroyed */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Event triggers when the process starts (from 0%) */ - start? (e: StartEventArgs): void; + start?(e: StartEventArgs): void; } export interface ChangeEventArgs { @@ -11363,11 +11399,10 @@ export interface StartEventArgs { class RadioButton extends ej.Widget { static fn: RadioButton; - constructor(element: JQuery, options?: RadioButton.Model); - constructor(element: Element, options?: RadioButton.Model); + constructor(element: JQuery | Element, options?: RadioButton.Model); static Locale: any; - model:RadioButton.Model; - defaults:RadioButton.Model; + model: RadioButton.Model; + defaults: RadioButton.Model; /** To disable the RadioButton * @returns {void} @@ -11379,7 +11414,7 @@ class RadioButton extends ej.Widget { */ enable(): void; } -export module RadioButton{ +export namespace RadioButton { export interface Model { @@ -11397,7 +11432,8 @@ export interface Model { */ enabled?: boolean; - /** Specifies the enablePersistence property for RadioButton while initialization. The enablePersistence API save current model value to browser cookies for state maintains. While refreshing the radio button control page the model value apply from browser cookies. + /** Specifies the enablePersistence property for RadioButton while initialization. The enablePersistence API save current model value to browser cookies for state maintains. + * While refreshing the radio button control page the model value apply from browser cookies. * @Default {false} */ enablePersistence?: boolean; @@ -11452,16 +11488,16 @@ export interface Model { value?: string; /** Fires before the RadioButton is going to changed its state successfully */ - beforeChange? (e: BeforeChangeEventArgs): void; + beforeChange?(e: BeforeChangeEventArgs): void; /** Fires when the RadioButton state is changed successfully */ - change? (e: ChangeEventArgs): void; + change?(e: ChangeEventArgs): void; /** Fires when the RadioButton created successfully */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Fires when the RadioButton destroyed successfully */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; } export interface BeforeChangeEventArgs { @@ -11540,8 +11576,7 @@ export interface DestroyEventArgs { type?: string; } } -enum RadioButtonSize -{ +enum RadioButtonSize { //Shows small size radio button Small, //Shows medium size radio button @@ -11550,11 +11585,10 @@ Medium, class Rating extends ej.Widget { static fn: Rating; - constructor(element: JQuery, options?: Rating.Model); - constructor(element: Element, options?: Rating.Model); + constructor(element: JQuery | Element, options?: Rating.Model); static Locale: any; - model:Rating.Model; - defaults:Rating.Model; + model: Rating.Model; + defaults: Rating.Model; /** Destroy the Rating widget all events bound will be unbind automatically and bring the control to pre-init state. * @returns {void} @@ -11592,7 +11626,7 @@ class Rating extends ej.Widget { */ show(): void; } -export module Rating{ +export namespace Rating { export interface Model { @@ -11681,22 +11715,22 @@ export interface Model { width?: string; /** Fires when Rating value changes. */ - change? (e: ChangeEventArgs): void; + change?(e: ChangeEventArgs): void; /** Fires when Rating control is clicked successfully. */ - click? (e: ClickEventArgs): void; + click?(e: ClickEventArgs): void; /** Fires when Rating control is created. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Fires when Rating control is destroyed successfully. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Fires when mouse hover is removed from Rating control. */ - mouseout? (e: MouseoutEventArgs): void; + mouseout?(e: MouseoutEventArgs): void; /** Fires when mouse hovered over the Rating control. */ - mouseover? (e: MouseoverEventArgs): void; + mouseover?(e: MouseoverEventArgs): void; } export interface ChangeEventArgs { @@ -11825,7 +11859,7 @@ export interface MouseoverEventArgs { index?: any; } -enum Precision{ +enum Precision { ///string Exact, @@ -11841,13 +11875,13 @@ enum Precision{ class Ribbon extends ej.Widget { static fn: Ribbon; - constructor(element: JQuery, options?: Ribbon.Model); - constructor(element: Element, options?: Ribbon.Model); + constructor(element: JQuery | Element, options?: Ribbon.Model); static Locale: any; - model:Ribbon.Model; - defaults:Ribbon.Model; + model: Ribbon.Model; + defaults: Ribbon.Model; - /** Adds contextual tab or contextual tab set dynamically in the ribbon control with contextual tabs object and index position. When index is null, ribbon contextual tab or contextual tab set is added at the last index. + /** Adds contextual tab or contextual tab set dynamically in the ribbon control with contextual tabs object and index position. + * When index is null, ribbon contextual tab or contextual tab set is added at the last index. * @param {any} contextual tab or contextual tab set object. * @param {number} index of the contextual tab or contextual tab set, this is optional. * @returns {void} @@ -11867,7 +11901,7 @@ class Ribbon extends ej.Widget { * @param {number} index of the ribbon tab,this is optional. * @returns {void} */ - addTab(tabText: string, ribbonGroups: Array, index?: number): void; + addTab(tabText: string, ribbonGroups: any[], index?: number): void; /** Adds tab group dynamically in the ribbon control with given tab index, tab group object and group index position. When group index is null, ribbon group is added at the last index. * @param {number} ribbon tab index. @@ -11877,7 +11911,8 @@ class Ribbon extends ej.Widget { */ addTabGroup(tabIndex: number, tabGroup: any, groupIndex?: number): void; - /** Adds group content dynamically in the ribbon control with given tab index, group index, content, content index and sub group index position. When content index is null, content is added at the last index. + /** Adds group content dynamically in the ribbon control with given tab index, group index, sub group index, content and content index position. + * When content index is null, content is added at the last index. * @param {number} ribbon tab index. * @param {number} ribbon group index. * @param {any} content to be displayed in the ribbon group. @@ -11911,7 +11946,7 @@ class Ribbon extends ej.Widget { * @param {number} index of the tab item. * @returns {String} */ - getTabText(index: number): String; + getTabText(index: number): string; /** Hides the given text tab in the ribbon control. * @param {string} text of the tab item. @@ -11923,13 +11958,13 @@ class Ribbon extends ej.Widget { * @param {string} text of the tab item. * @returns {Boolean} */ - isEnable(text: string): Boolean; + isEnable(text: string): boolean; /** Checks whether the given text tab in the ribbon control is visible or not. * @param {string} text of the tab item. * @returns {Boolean} */ - isVisible(text: string): Boolean; + isVisible(text: string): boolean; /** Removes the given index tab item from the ribbon control. * @param {number} index of tab item. @@ -11985,7 +12020,7 @@ class Ribbon extends ej.Widget { */ removeBackStageItem(index: number): void; } -export module Ribbon{ +export namespace Ribbon { export interface Model { @@ -11999,7 +12034,8 @@ export interface Model { */ isResponsive?: boolean; - /** Specifies the height, width, enableRTL, showRoundedCorner,enabled,cssClass property to the controls in the ribbon commonly andit will work only when those properties are not defined in buttonSettings and content defaults. + /** Specifies the height, width, enableRTL, showRoundedCorner,enabled,cssClass property to the controls in the ribbon commonly andit will work only when those properties + * are not defined in buttonSettings and content defaults. * @Default {Object} */ buttonDefaults?: any; @@ -12039,20 +12075,21 @@ export interface Model { */ applicationTab?: ApplicationTab; - /** Specifies the contextual tabs and tab set to the ribbon control with the background color and border color. Refer to the tabs section for adding tabs into the contextual tab and contextual tab set. + /** Specifies the contextual tabs and tab set to the ribbon control with the background color and border color. Refer to the tabs section for adding tabs + * into the contextual tab and contextual tab set. * @Default {Array} */ - contextualTabs?: Array; + contextualTabs?: ContextualTab[]; /** Specifies the index or indexes to disable the given index tab or indexes tabs in the ribbon control. * @Default {0} */ - disabledItemIndex?: Array; + disabledItemIndex?: any[]; /** Specifies the index or indexes to enable the given index tab or indexes tabs in the ribbon control. * @Default {null} */ - enabledItemIndex?: Array; + enabledItemIndex?: any[]; /** Specifies the index of the ribbon tab to select the given index tab item in the ribbon control. * @Default {1} @@ -12062,9 +12099,10 @@ export interface Model { /** Specifies the tabs and its groups. Also specifies the control details that has to be placed in the tab area in the ribbon control. * @Default {Array} */ - tabs?: Array; + tabs?: Tab[]; - /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and culture specific to a particular country or region and it will need to use the user's preference. + /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and culture specific + * to a particular country or region and it will need to use the user's preference. * @Default {en-US} */ locale?: string; @@ -12075,55 +12113,55 @@ export interface Model { width?: string|number; /** Triggered before the ribbon tab item is removed. */ - beforeTabRemove? (e: BeforeTabRemoveEventArgs): void; + beforeTabRemove?(e: BeforeTabRemoveEventArgs): void; /** Triggered before the ribbon control is created. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Triggered before the ribbon control is destroyed. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Triggered when the control in the group is clicked successfully. */ - groupClick? (e: GroupClickEventArgs): void; + groupClick?(e: GroupClickEventArgs): void; /** Triggered when the group expander in the group is clicked successfully. */ - groupExpand? (e: GroupExpandEventArgs): void; + groupExpand?(e: GroupExpandEventArgs): void; /** Triggered when an item in the Gallery control is clicked successfully. */ - galleryItemClick? (e: GalleryItemClickEventArgs): void; + galleryItemClick?(e: GalleryItemClickEventArgs): void; /** Triggered when a tab or button in the backstage page is clicked successfully. */ - backstageItemClick? (e: BackstageItemClickEventArgs): void; + backstageItemClick?(e: BackstageItemClickEventArgs): void; /** Triggered when the ribbon control is collapsed. */ - collapse? (e: CollapseEventArgs): void; + collapse?(e: CollapseEventArgs): void; /** Triggered when the ribbon control is expanded. */ - expand? (e: ExpandEventArgs): void; + expand?(e: ExpandEventArgs): void; /** Triggered before the ribbon control is load. */ - load? (e: LoadEventArgs): void; + load?(e: LoadEventArgs): void; /** Triggered after adding the new ribbon tab item. */ - tabAdd? (e: TabAddEventArgs): void; + tabAdd?(e: TabAddEventArgs): void; /** Triggered when tab is clicked successfully in the ribbon control. */ - tabClick? (e: TabClickEventArgs): void; + tabClick?(e: TabClickEventArgs): void; /** Triggered before the ribbon tab is created. */ - tabCreate? (e: TabCreateEventArgs): void; + tabCreate?(e: TabCreateEventArgs): void; /** Triggered after the tab item is removed from the ribbon control. */ - tabRemove? (e: TabRemoveEventArgs): void; + tabRemove?(e: TabRemoveEventArgs): void; /** Triggered after the ribbon tab item is selected in the ribbon control. */ - tabSelect? (e: TabSelectEventArgs): void; + tabSelect?(e: TabSelectEventArgs): void; /** Triggered when the expand/collapse button is clicked successfully . */ - toggleButtonClick? (e: ToggleButtonClickEventArgs): void; + toggleButtonClick?(e: ToggleButtonClickEventArgs): void; /** Triggered when the QAT menu item is clicked successfully . */ - qatMenuItemClick? (e: QatMenuItemClickEventArgs): void; + qatMenuItemClick?(e: QatMenuItemClickEventArgs): void; } export interface BeforeTabRemoveEventArgs { @@ -12511,7 +12549,8 @@ export interface ApplicationTabBackstageSettingsPage { */ text?: string; - /** Specifies the type for ribbon backstage page's contents. Set "ej.Ribbon.BackStageItemType.Tab" to render the tab or "ej.Ribbon.BackStageItemType.Button" to render the button. + /** Specifies the type for ribbon backstage page's contents. Set "ej.Ribbon.BackStageItemType.Tab" to render the tab or " + * ej.Ribbon.BackStageItemType.Button" to render the button. * @Default {ej.Ribbon.ItemType.Tab} */ itemType?: ej.Ribbon.ItemType|string; @@ -12547,7 +12586,7 @@ export interface ApplicationTabBackstageSettings { /** Specifies the ribbon backstage page with its tab and button elements. * @Default {Array} */ - pages?: Array; + pages?: ApplicationTabBackstageSettingsPage[]; /** Specifies the width of backstage page header that contains tabs and buttons. * @Default {null} @@ -12572,7 +12611,8 @@ export interface ApplicationTab { */ menuSettings?: any; - /** Specifies the application menu or backstage page. Specify the type of application tab as "ej.Ribbon.ApplicationTabType.Menu" to render the application menu or "ej.Ribbon.ApplicationTabType.Backstage" to render backstage page in the ribbon control. + /** Specifies the application menu or backstage page. Specify the type of application tab as "ej.Ribbon.ApplicationTabType.Menu" to render the application menu or + * "ej.Ribbon.ApplicationTabType.Backstage" to render backstage page in the ribbon control. * @Default {ej.Ribbon.ApplicationTabType.Menu} */ type?: ej.Ribbon.ApplicationTabType|string; @@ -12593,7 +12633,7 @@ export interface ContextualTab { /** Specifies the tabs to present in the contextual tabs and tab set. Refer to the tabs section for adding tabs into the contextual tabs and tab set. * @Default {Array} */ - tabs?: Array; + tabs?: any[]; } export interface TabsGroupsContentDefaults { @@ -12728,7 +12768,7 @@ export interface TabsGroupsContentGroup { /** Specifies the Syncfusion button and menu as gallery extra items. * @Default {Array} */ - customGalleryItems?: Array; + customGalleryItems?: TabsGroupsContentGroupsCustomGalleryItem[]; /** Provides custom tooltip for button, split button, dropdown list, toggle button, custom controls in the sub groups. Text and HTML support are also provided for title and content. * @Default {Object} @@ -12753,7 +12793,7 @@ export interface TabsGroupsContentGroup { /** Defines each gallery content. * @Default {Array} */ - galleryItems?: Array; + galleryItems?: TabsGroupsContentGroupsGalleryItem[]; /** Specifies the Id for button, split button, dropdown list, toggle button, gallery, custom controls in the sub groups. * @Default {null} @@ -12800,7 +12840,8 @@ export interface TabsGroupsContentGroup { */ quickAccessMode?: ej.Ribbon.QuickAccessMode|string; - /** Specifies the type as "ej.Ribbon.Type.Button" or "ej.Ribbon.Type.SplitButton" or "ej.Ribbon.Type.DropDownList" or "ej.Ribbon.Type.ToggleButton" or "ej.Ribbon.Type.Custom" or "ej.Ribbon.Type.Gallery" to render button, split, dropdown, toggle button, gallery, custom controls. + /** Specifies the type as "ej.Ribbon.Type.Button" or "ej.Ribbon.Type.SplitButton" or "ej.Ribbon.Type.DropDownList" or "ej.Ribbon.Type.ToggleButton" + * or "ej.Ribbon.Type.Custom" or "ej.Ribbon.Type.Gallery" to render button, split, dropdown, toggle button, gallery, custom controls. * @Default {ej.Ribbon.Type.Button} */ type?: ej.Ribbon.Type|string; @@ -12816,7 +12857,7 @@ export interface TabsGroupsContent { /** Specifies the controls such as Syncfusion button, split button, dropdown list, toggle button, gallery, custom controls in the subgroup of the ribbon tab . * @Default {Array} */ - groups?: Array; + groups?: TabsGroupsContentGroup[]; } export interface TabsGroupsGroupExpanderSettings { @@ -12834,7 +12875,8 @@ export interface TabsGroupsGroupExpanderSettings { export interface TabsGroup { - /** Specifies the alignment of controls in the groups in 'row' type or 'column' type. Value for row type is "ej.Ribbon.AlignType.Rows" and for column type is "ej.Ribbon.alignType.columns". + /** Specifies the alignment of controls in the groups in 'row' type or 'column' type. Value for row type is "ej.Ribbon.AlignType.Rows" + * and for column type is "ej.Ribbon.alignType.columns". * @Default {ej.Ribbon.AlignType.Rows} */ alignType?: ej.Ribbon.AlignType|string; @@ -12842,7 +12884,7 @@ export interface TabsGroup { /** Specifies the Syncfusion button, split button, dropdown list, toggle button, gallery, custom controls to the groups in the ribbon control. * @Default {Array} */ - content?: Array; + content?: TabsGroupsContent[]; /** Specifies the ID of custom items to be placed in the groups. * @Default {null} @@ -12880,7 +12922,7 @@ export interface Tab { /** Specifies single group or multiple groups and its contents to each tab in the ribbon control. * @Default {Array} */ - groups?: Array; + groups?: TabsGroup[]; /** Specifies the ID for each tab's content panel. * @Default {null} @@ -12893,7 +12935,7 @@ export interface Tab { text?: string; } -enum ItemType{ +enum ItemType { ///To render the button for ribbon backstage pageĂ¢â‚¬â„¢s contents Button, @@ -12903,7 +12945,7 @@ enum ItemType{ } -enum ApplicationTabType{ +enum ApplicationTabType { ///applicationTab display as menu Menu, @@ -12913,7 +12955,7 @@ enum ApplicationTabType{ } -enum AlignType{ +enum AlignType { ///To align the group content's in row Rows, @@ -12923,7 +12965,7 @@ enum AlignType{ } -enum CustomItemType{ +enum CustomItemType { ///Specifies the button type in customGalleryItems Button, @@ -12933,9 +12975,9 @@ enum CustomItemType{ } -enum QuickAccessMode{ +enum QuickAccessMode { - ///Controls are hidden in Quick Access toolbar + ///Controls are hidden in Quick Access toolbar None, ///Add controls in toolBar @@ -12946,7 +12988,7 @@ enum QuickAccessMode{ } -enum Type{ +enum Type { ///Specifies the button control Button, @@ -12971,11 +13013,10 @@ enum Type{ class Kanban extends ej.Widget { static fn: Kanban; - constructor(element: JQuery, options?: Kanban.Model); - constructor(element: Element, options?: Kanban.Model); + constructor(element: JQuery | Element, options?: Kanban.Model); static Locale: any; - model:Kanban.Model; - defaults:Kanban.Model; + model: Kanban.Model; + defaults: Kanban.Model; /** Add or remove columns in Kanban columns collections.Default action is add. * @param {Array|string} Pass array of columns or string of headerText to add/remove the column in Kanban @@ -12983,7 +13024,7 @@ class Kanban extends ej.Widget { * @param {string} optional Pass add/remove action to be performed. By default "add" action will perform * @returns {void} */ - columns(columndetails: Array|string, keyvalue: Array|string, action?: string): void; + columns(columndetails: any[]|string, keyvalue: any[]|string, action?: string): void; /** Destroy the Kanban widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. * @returns {void} @@ -12994,7 +13035,7 @@ class Kanban extends ej.Widget { * @param {Array} Pass new data source to the Kanban * @returns {void} */ - dataSource(datasource: Array): void; + dataSource(datasource: any[]): void; /** toggleColumn based on the headerText in Kanban. * @param {any} Pass the header text of the column to get the corresponding column object @@ -13003,7 +13044,7 @@ class Kanban extends ej.Widget { toggleColumn(headerText: any): void; /** Expand or collapse the card based on the state of target "div" - * @param {string|number} Pass the id of card to be toggle + * @param {string|number} Pass the id of card to be toggle * @returns {void} */ toggleCard(key: string|number): void; @@ -13011,7 +13052,7 @@ class Kanban extends ej.Widget { /** Used for get the names of all the visible column name collections in Kanban. * @returns {Array} */ - getVisibleColumnNames(): Array; + getVisibleColumnNames(): any[]; /** Get the scroller object of Kanban. * @returns {ej.Scroller} @@ -13022,18 +13063,18 @@ class Kanban extends ej.Widget { * @param {string} Pass the header text of the column to get the corresponding column object * @returns {String} */ - getColumnByHeaderText(headerText: string): String; + getColumnByHeaderText(headerText: string): string; /** Get the table details based on the given header table in Kanban. * @returns {String} */ - getHeaderTable(): String; + getHeaderTable(): string; /** Hide columns from the Kanban based on the header text * @param {Array|string} you can pass either array of header text of various columns or a header text of a column to hide * @returns {void} */ - hideColumns(headerText: Array|string): void; + hideColumns(headerText: any[]|string): void; /** Print the Kanban Board * @returns {void} @@ -13055,14 +13096,14 @@ class Kanban extends ej.Widget { * @param {Array|string} You can pass either array of header text of various columns or a header text of a column to show * @returns {void} */ - showColumns(headerText: Array|string): void; + showColumns(headerText: any[]|string): void; /** Update a card in Kanban control based on key and JSON data given. * @param {string} Pass the key field Name of the column * @param {Array} Pass the edited JSON data of card need to be update. * @returns {void} */ - updateCard(key: string, data: Array): void; + updateCard(key: string, data: any[]): void; KanbanSelection: Kanban.KanbanSelection; @@ -13072,7 +13113,7 @@ class Kanban extends ej.Widget { KanbanEdit: Kanban.KanbanEdit; } -export module Kanban{ +export namespace Kanban { export interface KanbanSelection { @@ -13132,7 +13173,7 @@ export interface KanbanEdit { * @param {Array} Pass the edited JSON data of card need to be add. * @returns {void} */ - addCard(primaryKey: string,card: Array): void; + addCard(primaryKey: string, card: any[]): void; /** Send a cancel request of add/edit card in Kanban when allowEditing/allowAdding is set as true. * @returns {void} @@ -13161,7 +13202,7 @@ export interface KanbanEdit { * @param {any} Specify the validation rules for the field * @returns {void} */ - setValidationToField(name: string,rules: any): void; + setValidationToField(name: string, rules: any): void; } export interface Model { @@ -13229,7 +13270,7 @@ export interface Model { /** Gets or sets an object that indicates to render the Kanban with specified columns. * @Default {Array} */ - columns?: Array; + columns?: Column[]; /** Gets or sets an object that indicates whether to Customize the card settings. * @Default {Object} @@ -13239,7 +13280,7 @@ export interface Model { /** Gets or sets a value that indicates whether to add customToolbarItems within the toolbar to perform any action in the Kanban. * @Default {[]} */ - customToolbarItems?: Array; + customToolbarItems?: CustomToolbarItem[]; /** Gets or sets a value that indicates to render the Kanban with custom theme. */ @@ -13293,7 +13334,7 @@ export interface Model { /** To customize the filtering behavior based on queries given. * @Default {Array} */ - filterSettings?: Array; + filterSettings?: FilterSetting[]; /** ej Query to query database of Kanban. * @Default {null} @@ -13323,7 +13364,7 @@ export interface Model { /** Gets or sets an object that indicates to managing the collection of stacked header rows for the Kanban. * @Default {Array} */ - stackedHeaderRows?: Array; + stackedHeaderRows?: StackedHeaderRow[]; /** The tooltip allows to display card details in a tooltip while hovering on it. */ @@ -13332,90 +13373,91 @@ export interface Model { /** Gets or sets an object that indicates to render the Kanban with specified workflows. * @Default {Array} */ - workflows?: Array; + workflows?: Workflow[]; - /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and culture specific to a particular country or region. + /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and culture specific + * to a particular country or region. * @Default {en-US} */ locale?: string; /** Triggered for every Kanban action before its starts. */ - actionBegin? (e: ActionBeginEventArgs): void; + actionBegin?(e: ActionBeginEventArgs): void; /** Triggered for every Kanban action success event. */ - actionComplete? (e: ActionCompleteEventArgs): void; + actionComplete?(e: ActionCompleteEventArgs): void; /** Triggered for every Kanban action server failure event. */ - actionFailure? (e: ActionFailureEventArgs): void; + actionFailure?(e: ActionFailureEventArgs): void; /** Triggered before the task is going to be edited. */ - beginEdit? (e: BeginEditEventArgs): void; + beginEdit?(e: BeginEditEventArgs): void; /** Triggered before the card is going to be added */ - beginAdd? (e: BeginAddEventArgs): void; + beginAdd?(e: BeginAddEventArgs): void; /** Triggered before the card is selected. */ - beforeCardSelect? (e: BeforeCardSelectEventArgs): void; + beforeCardSelect?(e: BeforeCardSelectEventArgs): void; /** Trigger after the card is clicked. */ - cardClick? (e: CardClickEventArgs): void; + cardClick?(e: CardClickEventArgs): void; /** Triggered when the card is being dragged. */ - cardDrag? (e: CardDragEventArgs): void; + cardDrag?(e: CardDragEventArgs): void; /** Triggered when card dragging start. */ - cardDragStart? (e: CardDragStartEventArgs): void; + cardDragStart?(e: CardDragStartEventArgs): void; /** Triggered when card dragging stops. */ - cardDragStop? (e: CardDragStopEventArgs): void; + cardDragStop?(e: CardDragStopEventArgs): void; /** Triggered when the card is Dropped. */ - cardDrop? (e: CardDropEventArgs): void; + cardDrop?(e: CardDropEventArgs): void; /** Triggered after the card is selected. */ - cardSelect? (e: CardSelectEventArgs): void; + cardSelect?(e: CardSelectEventArgs): void; /** Triggered when card is double clicked. */ - cardDoubleClick? (e: CardDoubleClickEventArgs): void; + cardDoubleClick?(e: CardDoubleClickEventArgs): void; /** Triggered before the card is selected. */ - cardSelecting? (e: CardSelectingEventArgs): void; + cardSelecting?(e: CardSelectingEventArgs): void; /** Triggered when the Kanban is rendered completely */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Triggers after the cell is clicked. */ - cellClick? (e: CellClickEventArgs): void; + cellClick?(e: CellClickEventArgs): void; /** Triggered before the context menu is opened. */ - contextOpen? (e: ContextOpenEventArgs): void; + contextOpen?(e: ContextOpenEventArgs): void; /** Triggered when context menu item is clicked in Kanban */ - contextClick? (e: ContextClickEventArgs): void; + contextClick?(e: ContextClickEventArgs): void; /** Triggered the Kanban is bound with data during initial rendering. */ - dataBound? (e: DataBoundEventArgs): void; + dataBound?(e: DataBoundEventArgs): void; /** Triggered when Kanban going to destroy. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Triggered after the card is deleted. */ - endDelete? (e: EndDeleteEventArgs): void; + endDelete?(e: EndDeleteEventArgs): void; /** Triggered after the card is edited. */ - endEdit? (e: EndEditEventArgs): void; + endEdit?(e: EndEditEventArgs): void; /** Triggers after the header is clicked. */ - headerClick? (e: HeaderClickEventArgs): void; + headerClick?(e: HeaderClickEventArgs): void; /** Triggered initial load. */ - load? (e: LoadEventArgs): void; + load?(e: LoadEventArgs): void; /** Triggered every time a single card rendered request is made to access particular card information. */ - queryCellInfo? (e: QueryCellInfoEventArgs): void; + queryCellInfo?(e: QueryCellInfoEventArgs): void; /** Triggered when toolbar item is clicked in Kanban. */ - toolbarClick? (e: ToolbarClickEventArgs): void; + toolbarClick?(e: ToolbarClickEventArgs): void; } export interface ActionBeginEventArgs { @@ -13625,7 +13667,7 @@ export interface BeforeCardSelectEventArgs { /** Returns the previously select card indexes */ - previousRowcellindex?: Array; + previousRowcellindex?: any[]; /** Returns the Target item. */ @@ -13811,7 +13853,7 @@ export interface CardSelectEventArgs { /** Returns the previously select card indexes */ - previousRowcellindex?: Array; + previousRowcellindex?: any[]; /** Returns the current item. */ @@ -13873,7 +13915,7 @@ export interface CardSelectingEventArgs { /** Returns the previously rowcell is selecting card indexes */ - previousRowcellindex?: Array; + previousRowcellindex?: any[]; /** Returns the current item. */ @@ -14186,7 +14228,7 @@ export interface SwimlaneSettingsUnassignedGroup { /** To set the user defined values which are need to categorized as unassigned category swim lane groups. * @Default {[null,undefined,]} */ - keys?: Array; + keys?: any[]; } export interface SwimlaneSettings { @@ -14235,17 +14277,17 @@ export interface ContextMenuSettings { /** Gets or sets a value that indicates the list of items needs to be disable from default context menu items. * @Default {Array} */ - disableDefaultItems?: Array; + disableDefaultItems?: any[]; /** Its used to add specific default context menu items. * @Default {Array} */ - menuItems?: Array; + menuItems?: any[]; /** Gets or sets a value that indicates whether to add custom contextMenu items. * @Default {Array} */ - customMenuItems?: Array; + customMenuItems?: ContextMenuSettingsCustomMenuItem[]; } export interface ColumnsTotalCount { @@ -14406,7 +14448,7 @@ export interface EditSettings { /** Get or sets an object that indicates whether to customize the editing fields of Kanban card. * @Default {Array} */ - editItems?: Array; + editItems?: EditSettingsEditItem[]; /** This specifies the id of the template which is require to be edited using the External edit form. * @Default {null} @@ -14503,7 +14545,7 @@ export interface SearchSettings { /** To customize the fields the searching operation can be perform. * @Default {Array} */ - fields?: Array; + fields?: any[]; /** To customize the searching string. */ @@ -14538,7 +14580,7 @@ export interface StackedHeaderRow { /** Gets or sets a value that indicates whether to add stacked header columns into the stacked header rows. * @Default {Array} */ - stackedHeaderColumns?: Array; + stackedHeaderColumns?: StackedHeaderRowsStackedHeaderColumn[]; } export interface TooltipSettings { @@ -14567,7 +14609,7 @@ export interface Workflow { allowedTransitions?: string; } -enum Target{ +enum Target { ///Sets context menu to Kanban header Header, @@ -14583,7 +14625,7 @@ enum Target{ } -enum EditMode{ +enum EditMode { ///Creates Kanban with editMode as Dialog Dialog, @@ -14599,12 +14641,12 @@ enum EditMode{ } -enum EditingType{ +enum EditingType { ///Allows to set edit type as string edit type String, - ///Allows to set edit type as numeric edit type + ///Allows to set edit type as numeric edit type Numeric, ///Allows to set edit type as drop down edit type @@ -14624,7 +14666,7 @@ enum EditingType{ } -enum FormPosition{ +enum FormPosition { ///Form position is bottom. Bottom, @@ -14634,7 +14676,7 @@ enum FormPosition{ } -enum SelectionType{ +enum SelectionType { ///Support for Single selection in Kanban Single, @@ -14647,11 +14689,10 @@ enum SelectionType{ class Rotator extends ej.Widget { static fn: Rotator; - constructor(element: JQuery, options?: Rotator.Model); - constructor(element: Element, options?: Rotator.Model); + constructor(element: JQuery | Element, options?: Rotator.Model); static Locale: any; - model:Rotator.Model; - defaults:Rotator.Model; + model: Rotator.Model; + defaults: Rotator.Model; /** Disables the Rotator control. * @returns {void} @@ -14701,7 +14742,7 @@ class Rotator extends ej.Widget { */ updateTemplateById(index: number, id: string): void; } -export module Rotator{ +export namespace Rotator { export interface Model { @@ -14773,7 +14814,8 @@ export interface Model { */ isResponsive?: boolean; - /** Specifies the number of Rotator Items to navigate on a single click (next/previous/play buttons). The navigateSteps property value must be less than or equal to the displayItemsCount property value. + /** Specifies the number of Rotator Items to navigate on a single click (next/previous/play buttons). + * The navigateSteps property value must be less than or equal to the displayItemsCount property value. * @Default {1} */ navigateSteps?: string|number; @@ -14793,7 +14835,8 @@ export interface Model { */ query?: string; - /** If the Rotator Item is an image, you can specify a caption for the Rotator Item. The caption text for each Rotator Item must be set by using the title attribute of the respective tag. The caption cannot be displayed if multiple Rotator Items are present. + /** If the Rotator Item is an image, you can specify a caption for the Rotator Item. The caption text for each Rotator Item must be set by using the title attribute of the respective tag. + * The caption cannot be displayed if multiple Rotator Items are present. * @Default {false} */ showCaption?: boolean; @@ -14813,7 +14856,8 @@ export interface Model { */ showPlayButton?: boolean; - /** Turns on or off thumbnail support in the Rotator control. Thumbnail is used to navigate between slides. Thumbnail supports only single slide transition You must specify the source for thumbnail elements through the thumbnailSourceID property. + /** Turns on or off thumbnail support in the Rotator control. Thumbnail is used to navigate between slides. Thumbnail supports only single slide transition + * You must specify the source for thumbnail elements through the thumbnailSourceID property. * @Default {false} */ showThumbnail?: boolean; @@ -14844,7 +14888,7 @@ export interface Model { /** The templateId enables to bind multiple customized template items in Rotator. * @Default {null} */ - templateId?: Array; + templateId?: any[]; /** Specifies the source for thumbnail elements. * @Default {null} @@ -14852,25 +14896,25 @@ export interface Model { thumbnailSourceID?: any; /** This event is fired when the Rotator slides are changed. */ - change? (e: ChangeEventArgs): void; + change?(e: ChangeEventArgs): void; /** This event is fired when the Rotator control is initialized. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** This event is fired when the Rotator control is destroyed. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** This event is fired when a pager is clicked. */ - pagerClick? (e: PagerClickEventArgs): void; + pagerClick?(e: PagerClickEventArgs): void; /** This event is fired when enableAutoPlay is started. */ - start? (e: StartEventArgs): void; + start?(e: StartEventArgs): void; /** This event is fired when autoplay is stopped or paused. */ - stop? (e: StopEventArgs): void; + stop?(e: StopEventArgs): void; /** This event is fired when a thumbnail pager is clicked. */ - thumbItemClick? (e: ThumbItemClickEventArgs): void; + thumbItemClick?(e: ThumbItemClickEventArgs): void; } export interface ChangeEventArgs { @@ -15045,7 +15089,7 @@ export interface Fields { url?: string; } -enum PagerPosition{ +enum PagerPosition { ///string BottomLeft, @@ -15070,11 +15114,10 @@ enum PagerPosition{ class RTE extends ej.Widget { static fn: RTE; - constructor(element: JQuery, options?: RTE.Model); - constructor(element: Element, options?: RTE.Model); + constructor(element: JQuery | Element, options?: RTE.Model); static Locale: any; - model:RTE.Model; - defaults:RTE.Model; + model: RTE.Model; + defaults: RTE.Model; /** Returns the range object. * @returns {any} @@ -15160,7 +15203,8 @@ class RTE extends ej.Widget { */ insertRow(before?: boolean, cell?: JQuery): HTMLElement; - /** This method helps to insert/paste the content at the current cursor (caret) position or the selected content to be replaced with our text by passing the value as parameter to the pasteContent method in the Editor. + /** This method helps to insert/paste the content at the current cursor (caret) position or the selected content to be replaced with our text by passing the value as parameter to the + * pasteContent method in the Editor. * @returns {void} */ pasteContent(): void; @@ -15223,7 +15267,7 @@ class RTE extends ej.Widget { */ show(): void; } -export module RTE{ +export namespace RTE { export interface Model { @@ -15248,7 +15292,8 @@ export interface Model { autoHeight?: boolean; /** Sets the colorCode to display the color of the fontColor and backgroundColor in the font tools of the RTE. - * @Default {[000000, FFFFFF, C4C4C4, ADADAD, 595959, 262626, 4f81bd, dbe5f1, b8cce4, 95b3d7, 366092, 244061, c0504d, f2dcdb, e5b9b7, d99694, 953734,632423, 9bbb59, ebf1dd, d7e3bc, c3d69b, 76923c, 4f6128, 8064a2, e5e0ec, ccc1d9, b2a2c7, 5f497a, 3f3151, f79646, fdeada, fbd5b5, fac08f,e36c09, 974806]} + * @Default {[000000, FFFFFF, C4C4C4, ADADAD, 595959, 262626, 4f81bd, dbe5f1, b8cce4, 95b3d7, 366092, 244061, c0504d, f2dcdb, e5b9b7, d99694, 953734,632423, 9bbb59, + ebf1dd, d7e3bc, c3d69b, 76923c, 4f6128, 8064a2, e5e0ec, ccc1d9, b2a2c7, 5f497a, 3f3151, f79646, fdeada, fbd5b5, fac08f,e36c09, 974806]} */ colorCode?: any; @@ -15322,17 +15367,23 @@ export interface Model { fileBrowser?: FileBrowser; /** Sets the fontName in the RTE. - * @Default {{text: Segoe UI, value: Segoe UI },{text: Arial, value: Arial,Helvetica,sans-serif },{text: Courier New, value: Courier New,Courier,Monospace },{text: Georgia, value: Georgia,serif },{text: Impact, value: Impact,Charcoal,sans-serif },{text: Lucida Console, value: Lucida Console,Monaco,Monospace },{text: Tahoma, value: Tahoma,Geneva,sans-serif },{text: Times New Roman, value: Times New Roman },{text: Trebuchet MS, value: Trebuchet MS,Helvetica,sans-serif },{text: Verdana, value: Verdana,Geneva,sans-serif}} + * @Default {{text: Segoe UI, value: Segoe UI },{text: Arial, value: Arial,Helvetica,sans-serif },{text: Courier New, value: Courier New,Courier,Monospace }, + * {text: Georgia, value: Georgia,serif },{text: Impact, value: Impact,Charcoal,sans-serif },{text: Lucida Console, value: Lucida Console,Monaco,Monospace }, + * {text: Tahoma, value: Tahoma,Geneva,sans-serif },{text: Times New Roman, value: Times New Roman },{text: Trebuchet MS, value: Trebuchet MS,Helvetica,sans-serif }, + * {text: Verdana, value: Verdana,Geneva,sans-serif}} */ fontName?: any; /** Sets the fontSize in the RTE. - * @Default {{ text: 1, value: 1 },{ text: 2 (10pt), value: 2 },{ text: 3 (12pt), value: 3 },{ text: 4 (14pt), value: 4 },{ text: 5 (18pt), value: 5 },{ text: 6 (24pt), value: 6 },{ text: 7 (36pt), value: 7 }} + * @Default {{ text: 1, value: 1 },{ text: 2 (10pt), value: 2 },{ text: 3 (12pt), value: 3 },{ text: 4 (14pt), value: 4 },{ text: 5 (18pt), value: 5 }, + * { text: 6 (24pt), value: 6 },{ text: 7 (36pt), value: 7 }} */ fontSize?: any; /** Sets the format in the RTE. - * @Default {{ text: Paragraph, value: <p>, spriteCssClass: e-paragraph },{ text: Quotation, value: <blockquote>, spriteCssClass: e-quotation },{ text: Heading 1, value: <h1>, spriteCssClass: e-h1 },{ text: Heading 2, value: <h2>, spriteCssClass: e-h2 },{ text: Heading 3, value: <h3>, spriteCssClass: e-h3 },{ text: Heading 4, value: <h4>, spriteCssClass: e-h4 },{ text: Heading 5, value: <h5>, spriteCssClass: e-h5 },{ text: Heading 6, value: <h6>, spriteCssClass: e-h6}} + * @Default {{ text: Paragraph, value: <p>, spriteCssClass: e-paragraph },{ text: Quotation, value: <blockquote>, spriteCssClass: e-quotation }, + * { text: Heading 1, value: <h1>, spriteCssClass: e-h1 },{ text: Heading 2, value: <h2>, spriteCssClass: e-h2 },{ text: Heading 3, value: <h3>, spriteCssClass: e-h3 }, + * { text: Heading 4, value: <h4>, spriteCssClass: e-h4 },{ text: Heading 5, value: <h5>, spriteCssClass: e-h5 },{ text: Heading 6, value: <h6>, spriteCssClass: e-h6}} */ format?: string; @@ -15476,14 +15527,17 @@ export interface Model { tableRows?: number; /** Sets the tools in the RTE and gets the inner display order of the corresponding group element. Tools are dependent on the toolsList property. - * @Default {formatStyle: [format],style: [bold, italic, underline, strikethrough],alignment: [justifyLeft, justifyCenter, justifyRight, justifyFull],lists: [unorderedList, orderedList],indenting: [outdent, indent],doAction: [undo, redo],links: [createLink,removeLink],images: [image],media: [video],tables: [createTable, addRowAbove, addRowBelow, addColumnLeft, addColumnRight, deleteRow, deleteColumn, deleteTable]],view:[Ă¢â‚¬Å“fullScreenĂ¢â‚¬Â,zoomIn,zoomOut],print:[print]} + * @Default {formatStyle: [format],style: [bold, italic, underline, strikethrough],alignment: [justifyLeft, justifyCenter, justifyRight, justifyFull],lists: [unorderedList, orderedList], + * indenting: [outdent, indent],doAction: [undo, redo],links: [createLink,removeLink],images: [image],media: [video],tables: [createTable, addRowAbove, addRowBelow, + * addColumnLeft, addColumnRight, deleteRow, deleteColumn, deleteTable]],view:[Ă¢â‚¬Å“fullScreenĂ¢â‚¬Â,zoomIn,zoomOut],print:[print]} */ tools?: Tools; - /** Specifies the list of groups and order of those groups displayed in the RTE toolbar. The toolsList property is used to get the root group order and tools property is used to get the inner order of the corresponding groups displayed. When the value is not specified, it gets its default display order and tools. + /** Specifies the list of groups and order of those groups displayed in the RTE toolbar. The toolsList property is used to get the root group order and tools property is used to get the + * inner order of the corresponding groups displayed. When the value is not specified, it gets its default display order and tools. * @Default {[formatStyle, font, style, effects, alignment, lists, indenting, clipboard, doAction, clear, links, images, media, tables, casing,view, customTools,print,edit]} */ - toolsList?: Array; + toolsList?: any[]; /** Display the hints for the tools in the Toolbar. * @Default {{ associate: mouseenter, showShadow: true, position: { stem: { horizontal: left, vertical: top } }, tip: { size: { width: 5, height: 5 }, isBalloon: false }} @@ -15521,31 +15575,31 @@ export interface Model { zoomStep?: string|number; /** Fires when changed successfully. */ - change? (e: ChangeEventArgs): void; + change?(e: ChangeEventArgs): void; /** Fires when the RTE is created successfully */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Fires when mouse click on menu items. */ - contextMenuClick? (e: ContextMenuClickEventArgs): void; + contextMenuClick?(e: ContextMenuClickEventArgs): void; /** Fires before the RTE is destroyed. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Fires when the commands are executed successfully. */ - execute? (e: ExecuteEventArgs): void; + execute?(e: ExecuteEventArgs): void; /** Fires when the keydown action is successful. */ - keydown? (e: KeydownEventArgs): void; + keydown?(e: KeydownEventArgs): void; /** Fires when the keyup action is successful. */ - keyup? (e: KeyupEventArgs): void; + keyup?(e: KeyupEventArgs): void; /** Fires before the RTE Edit area is rendered and after the toolbar is rendered. */ - preRender? (e: PreRenderEventArgs): void; + preRender?(e: PreRenderEventArgs): void; /** Fires when the text is selected in the text area */ - select? (e: SelectEventArgs): void; + select?(e: SelectEventArgs): void; } export interface ChangeEventArgs { @@ -15808,93 +15862,92 @@ export interface Tools { /** Specifies the casing tools and the display order of this tool in the RTE toolbar. */ - casing?: Array; + casing?: any[]; /** Specifies the clear tools and the display order of this tool in the RTE toolbar. */ - clear?: Array; + clear?: any[]; /** Specifies the clipboard tools and the display order of this tool in the RTE toolbar. */ - clipboard?: Array; + clipboard?: any[]; /** Specifies the edit tools and the displays tool in the RTE toolbar. */ - edit?: Array; + edit?: any[]; /** Specifies the doAction tools and the display order of this tool in the RTE toolbar. */ - doAction?: Array; + doAction?: any[]; /** Specifies the effect of tools and the display order of this tool in RTE toolbar. */ - effects?: Array; + effects?: any[]; /** Specifies the font tools and the display order of this tool in the RTE toolbar. */ - font?: Array; + font?: any[]; /** Specifies the formatStyle tools and the display order of this tool in the RTE toolbar. */ - formatStyle?: Array; + formatStyle?: any[]; /** Specifies the image tools and the display order of this tool in the RTE toolbar. */ - images?: Array; + images?: any[]; /** Specifies the indent tools and the display order of this tool in the RTE toolbar. */ - indenting?: Array; + indenting?: any[]; /** Specifies the link tools and the display order of this tool in the RTE toolbar. */ - links?: Array; + links?: any[]; /** Specifies the list tools and the display order of this tool in the RTE toolbar. */ - lists?: Array; + lists?: any[]; /** Specifies the media tools and the display order of this tool in the RTE toolbar. */ - media?: Array; + media?: any[]; /** Specifies the style tools and the display order of this tool in the RTE toolbar. */ - style?: Array; + style?: any[]; /** Specifies the table tools and the display order of this tool in the RTE toolbar. */ - tables?: Array; + tables?: any[]; /** Specifies the view tools and the display order of this tool in the RTE toolbar. */ - view?: Array; + view?: any[]; /** Specifies the print tools and the display order of this tool in the RTE toolbar. */ - print?: Array; + print?: any[]; /** Specifies the importExport tools and the display order of this tool in the RTE toolbar. */ - importExport?: Array; + importExport?: any[]; /** Specifies the customOrderedList tools and the display order of this tool in the RTE toolbar. */ - customOrderedList?: Array; + customOrderedList?: ToolsCustomOrderedList[]; /** Specifies the customUnOrderedList tools and the display order of this tool in the RTE toolbar. */ - customUnorderedList?: Array; + customUnorderedList?: ToolsCustomUnorderedList[]; } } class Slider extends ej.Widget { static fn: Slider; - constructor(element: JQuery, options?: Slider.Model); - constructor(element: Element, options?: Slider.Model); + constructor(element: JQuery | Element, options?: Slider.Model); static Locale: any; - model:Slider.Model; - defaults:Slider.Model; + model: Slider.Model; + defaults: Slider.Model; /** To disable the slider * @returns {void} @@ -15916,7 +15969,7 @@ class Slider extends ej.Widget { */ setValue(): void; } -export module Slider{ +export namespace Slider { export interface Model { @@ -16032,7 +16085,7 @@ export interface Model { /** Specifies the values of the range slider. But it's not applicable for default and minRange sliders. we can use value property for default and minRange sliders. * @Default {[minValue,maxValue]} */ - values?: Array; + values?: any[]; /** Specifies the width of the slider. * @Default {100%} @@ -16040,25 +16093,25 @@ export interface Model { width?: string; /** Fires once Slider control value is changed successfully. */ - change? (e: ChangeEventArgs): void; + change?(e: ChangeEventArgs): void; /** Fires once Slider control has been created successfully. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Fires when Slider control has been destroyed successfully. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Fires once Slider control is sliding successfully. */ - slide? (e: SlideEventArgs): void; + slide?(e: SlideEventArgs): void; /** Fires once Slider control is started successfully. */ - start? (e: StartEventArgs): void; + start?(e: StartEventArgs): void; /** Fires when Slider control is stopped successfully. */ - stop? (e: StopEventArgs): void; + stop?(e: StopEventArgs): void; /** Fires when display the custom tooltip */ - tooltipChange? (e: TooltipChangeEventArgs): void; + tooltipChange?(e: TooltipChangeEventArgs): void; } export interface ChangeEventArgs { @@ -16087,7 +16140,7 @@ export interface ChangeEventArgs { */ value?: number; - /** returns true if event triggered by interaction else returns false. + /** returns true if event triggered by interaction else returns false. */ isInteraction?: boolean; } @@ -16204,12 +16257,13 @@ export interface StopEventArgs { } export interface TooltipChangeEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; } } -module slider -{ -enum sliderType -{ +namespace slider { +enum sliderType { //Shows default slider Default, //Shows minRange slider @@ -16221,11 +16275,10 @@ Range, class SplitButton extends ej.Widget { static fn: SplitButton; - constructor(element: JQuery, options?: SplitButton.Model); - constructor(element: Element, options?: SplitButton.Model); + constructor(element: JQuery | Element, options?: SplitButton.Model); static Locale: any; - model:SplitButton.Model; - defaults:SplitButton.Model; + model: SplitButton.Model; + defaults: SplitButton.Model; /** Destroy the split button widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. * @returns {void} @@ -16252,7 +16305,7 @@ class SplitButton extends ej.Widget { */ show(): void; } -export module SplitButton{ +export namespace SplitButton { export interface Model { @@ -16332,31 +16385,31 @@ export interface Model { width?: string|number; /** Fires before menu of the split button control is opened. */ - beforeOpen? (e: BeforeOpenEventArgs): void; + beforeOpen?(e: BeforeOpenEventArgs): void; /** Fires when Button control is clicked successfully */ - click? (e: ClickEventArgs): void; + click?(e: ClickEventArgs): void; /** Fires before the list content of Button control is closed */ - close? (e: CloseEventArgs): void; + close?(e: CloseEventArgs): void; /** Fires after Split Button control is created. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Fires when the Split Button is destroyed successfully */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Fires when a menu item is Hovered out successfully */ - itemMouseOut? (e: ItemMouseOutEventArgs): void; + itemMouseOut?(e: ItemMouseOutEventArgs): void; /** Fires when a menu item is Hovered in successfully */ - itemMouseOver? (e: ItemMouseOverEventArgs): void; + itemMouseOver?(e: ItemMouseOverEventArgs): void; /** Fires when a menu item is clicked successfully */ - itemSelected? (e: ItemSelectedEventArgs): void; + itemSelected?(e: ItemSelectedEventArgs): void; /** Fires before the list content of Button control is opened */ - open? (e: OpenEventArgs): void; + open?(e: OpenEventArgs): void; } export interface BeforeOpenEventArgs { @@ -16542,8 +16595,7 @@ export interface OpenEventArgs { type?: string; } } -enum ArrowPosition -{ +enum ArrowPosition { //To set Left arrowPosition of the split button Left, //To set Right arrowPosition of the split button @@ -16556,11 +16608,10 @@ Bottom, class Splitter extends ej.Widget { static fn: Splitter; - constructor(element: JQuery, options?: Splitter.Model); - constructor(element: Element, options?: Splitter.Model); + constructor(element: JQuery | Element, options?: Splitter.Model); static Locale: any; - model:Splitter.Model; - defaults:Splitter.Model; + model: Splitter.Model; + defaults: Splitter.Model; /** To add a new pane to splitter control. * @param {string} content of pane. @@ -16593,7 +16644,7 @@ class Splitter extends ej.Widget { */ removeItem(index: number): void; } -export module Splitter{ +export namespace Splitter { export interface Model { @@ -16645,7 +16696,7 @@ export interface Model { /** Specify properties for each pane like paneSize, minSize, maxSize, collapsible, expandable, resizable. * @Default {[]} */ - properties?: Array; + properties?: any[]; /** Specify width for splitter control. * @Default {null} @@ -16653,19 +16704,19 @@ export interface Model { width?: string; /** Fires before expanding / collapsing the split pane of splitter control. */ - beforeExpandCollapse? (e: BeforeExpandCollapseEventArgs): void; + beforeExpandCollapse?(e: BeforeExpandCollapseEventArgs): void; /** Fires when splitter control pane has been created. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Fires when splitter control pane has been destroyed. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Fires when expand / collapse operation in splitter control pane has been performed successfully. */ - expandCollapse? (e: ExpandCollapseEventArgs): void; + expandCollapse?(e: ExpandCollapseEventArgs): void; /** Fires when resize in splitter control pane. */ - resize? (e: ResizeEventArgs): void; + resize?(e: ResizeEventArgs): void; } export interface BeforeExpandCollapseEventArgs { @@ -16782,11 +16833,10 @@ export interface ResizeEventArgs { class Tab extends ej.Widget { static fn: Tab; - constructor(element: JQuery, options?: Tab.Model); - constructor(element: Element, options?: Tab.Model); + constructor(element: JQuery | Element, options?: Tab.Model); static Locale: any; - model:Tab.Model; - defaults:Tab.Model; + model: Tab.Model; + defaults: Tab.Model; /** Add new tab items with given name, URL and given index position, if index null itĂ¢â‚¬â„¢s add last item. * @param {string} URL name / tab id. @@ -16841,7 +16891,7 @@ class Tab extends ej.Widget { */ showItem(index: number): void; } -export module Tab{ +export namespace Tab { export interface Model { @@ -16926,7 +16976,7 @@ export interface Model { /** Specifies to hide a pane of Tab control. * @Default {[]} */ - hiddenItemIndex?: Array; + hiddenItemIndex?: any[]; /** Specifies the HTML Attributes of the Tab. * @Default {{}} @@ -16964,37 +17014,37 @@ export interface Model { width?: string|number; /** Triggered after a tab item activated. */ - itemActive? (e: ItemActiveEventArgs): void; + itemActive?(e: ItemActiveEventArgs): void; /** Triggered before AJAX content has been loaded. */ - ajaxBeforeLoad? (e: AjaxBeforeLoadEventArgs): void; + ajaxBeforeLoad?(e: AjaxBeforeLoadEventArgs): void; /** Triggered if error occurs in AJAX request. */ - ajaxError? (e: AjaxErrorEventArgs): void; + ajaxError?(e: AjaxErrorEventArgs): void; /** Triggered after AJAX content load action. */ - ajaxLoad? (e: AjaxLoadEventArgs): void; + ajaxLoad?(e: AjaxLoadEventArgs): void; /** Triggered after a tab item activated. */ - ajaxSuccess? (e: AjaxSuccessEventArgs): void; + ajaxSuccess?(e: AjaxSuccessEventArgs): void; /** Triggered before a tab item activated. */ - beforeActive? (e: BeforeActiveEventArgs): void; + beforeActive?(e: BeforeActiveEventArgs): void; /** Triggered before a tab item remove. */ - beforeItemRemove? (e: BeforeItemRemoveEventArgs): void; + beforeItemRemove?(e: BeforeItemRemoveEventArgs): void; /** Triggered before a tab item Create. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Triggered before a tab item destroy. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Triggered after new tab item add */ - itemAdd? (e: ItemAddEventArgs): void; + itemAdd?(e: ItemAddEventArgs): void; /** Triggered after tab item removed. */ - itemRemove? (e: ItemRemoveEventArgs): void; + itemRemove?(e: ItemRemoveEventArgs): void; } export interface ItemActiveEventArgs { @@ -17319,12 +17369,12 @@ export interface AjaxSettings { type?: string; } -enum Position{ +enum Position { ///Tab headers display to top position Top, - ///Tab headers display to bottom position + ///Tab headers display to bottom position Bottom, ///Tab headers display to left position. @@ -17335,7 +17385,7 @@ enum Position{ } -enum HeightAdjustMode{ +enum HeightAdjustMode { ///string None, @@ -17354,11 +17404,10 @@ enum HeightAdjustMode{ class TagCloud extends ej.Widget { static fn: TagCloud; - constructor(element: JQuery, options?: TagCloud.Model); - constructor(element: Element, options?: TagCloud.Model); + constructor(element: JQuery | Element, options?: TagCloud.Model); static Locale: any; - model:TagCloud.Model; - defaults:TagCloud.Model; + model: TagCloud.Model; + defaults: TagCloud.Model; /** Inserts a new item into the TagCloud * @param {string} Insert new item into the TagCloud @@ -17385,7 +17434,7 @@ class TagCloud extends ej.Widget { */ removeAt(position: number): void; } -export module TagCloud{ +export namespace TagCloud { export interface Model { @@ -17449,19 +17498,19 @@ export interface Model { titleText?: string; /** Event triggers when the TagCloud items are clicked */ - click? (e: ClickEventArgs): void; + click?(e: ClickEventArgs): void; /** Event triggers when the TagCloud are created */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Event triggers when the TagCloud are destroyed */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Event triggers when the cursor leaves out from a tag item */ - mouseout? (e: MouseoutEventArgs): void; + mouseout?(e: MouseoutEventArgs): void; /** Event triggers when the cursor hovers on a tag item */ - mouseover? (e: MouseoverEventArgs): void; + mouseover?(e: MouseoverEventArgs): void; } export interface ClickEventArgs { @@ -17582,8 +17631,7 @@ export interface Fields { url?: string; } } -enum Format -{ +enum Format { //To render the TagCloud items in cloud format Cloud, //To render the TagCloud items in list format @@ -17592,11 +17640,10 @@ List, class TimePicker extends ej.Widget { static fn: TimePicker; - constructor(element: JQuery, options?: TimePicker.Model); - constructor(element: Element, options?: TimePicker.Model); + constructor(element: JQuery | Element, options?: TimePicker.Model); static Locale: any; - model:TimePicker.Model; - defaults:TimePicker.Model; + model: TimePicker.Model; + defaults: TimePicker.Model; /** Allows you to disable the TimePicker. * @returns {void} @@ -17628,7 +17675,7 @@ class TimePicker extends ej.Widget { */ show(): void; } -export module TimePicker{ +export namespace TimePicker { export interface Model { @@ -17661,7 +17708,8 @@ export interface Model { */ enableRTL?: boolean; - /** When the enableStrictMode is set as true it allows the value outside of the range and also indicate with red color border, otherwise it internally changed to the min or max range value based an input value. + /** When the enableStrictMode is set as true it allows the value outside of the range and also indicate with red color border, + * otherwise it internally changed to the min or max range value based an input value. * @Default {false} */ enableStrictMode?: boolean; @@ -17715,7 +17763,7 @@ export interface Model { */ popupWidth?: string|number; - /** Toggles the readonly state of the TimePicker. When the widget is readOnly, it doesnĂ¢â‚¬â„¢t allow your input. + /** Toggles the readonly state of the TimePicker * @Default {false} */ readOnly?: boolean; @@ -17750,34 +17798,34 @@ export interface Model { width?: string|number; /** Fires when the time value changed in the TimePicker. */ - beforeChange? (e: BeforeChangeEventArgs): void; + beforeChange?(e: BeforeChangeEventArgs): void; /** Fires when the TimePicker popup before opened. */ - beforeOpen? (e: BeforeOpenEventArgs): void; + beforeOpen?(e: BeforeOpenEventArgs): void; /** Fires when the time value changed in the TimePicker. */ - change? (e: ChangeEventArgs): void; + change?(e: ChangeEventArgs): void; /** Fires when the TimePicker popup closed. */ - close? (e: CloseEventArgs): void; + close?(e: CloseEventArgs): void; /** Fires when create TimePicker successfully. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Fires when the TimePicker is destroyed successfully. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Fires when the TimePicker control gets focus. */ - focusIn? (e: FocusInEventArgs): void; + focusIn?(e: FocusInEventArgs): void; /** Fires when the TimePicker control get lost focus. */ - focusOut? (e: FocusOutEventArgs): void; + focusOut?(e: FocusOutEventArgs): void; /** Fires when the TimePicker popup opened. */ - open? (e: OpenEventArgs): void; + open?(e: OpenEventArgs): void; /** Fires when the value is selected from the TimePicker dropdown list. */ - select? (e: SelectEventArgs): void; + select?(e: SelectEventArgs): void; } export interface BeforeChangeEventArgs { @@ -17997,11 +18045,10 @@ export interface SelectEventArgs { class ToggleButton extends ej.Widget { static fn: ToggleButton; - constructor(element: JQuery, options?: ToggleButton.Model); - constructor(element: Element, options?: ToggleButton.Model); + constructor(element: JQuery | Element, options?: ToggleButton.Model); static Locale: any; - model:ToggleButton.Model; - defaults:ToggleButton.Model; + model: ToggleButton.Model; + defaults: ToggleButton.Model; /** Allows you to destroy the ToggleButton widget. * @returns {void} @@ -18018,7 +18065,7 @@ class ToggleButton extends ej.Widget { */ enable(): void; } -export module ToggleButton{ +export namespace ToggleButton { export interface Model { @@ -18118,16 +18165,16 @@ export interface Model { width?: number|string; /** Fires when ToggleButton control state is changed successfully. */ - change? (e: ChangeEventArgs): void; + change?(e: ChangeEventArgs): void; /** Fires when ToggleButton control is clicked successfully. */ - click? (e: ClickEventArgs): void; + click?(e: ClickEventArgs): void; /** Fires when ToggleButton control is created successfully. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Fires when ToggleButton control is destroyed successfully. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; } export interface ChangeEventArgs { @@ -18205,11 +18252,10 @@ export interface DestroyEventArgs { class Toolbar extends ej.Widget { static fn: Toolbar; - constructor(element: JQuery, options?: Toolbar.Model); - constructor(element: Element, options?: Toolbar.Model); + constructor(element: JQuery | Element, options?: Toolbar.Model); static Locale: any; - model:Toolbar.Model; - defaults:Toolbar.Model; + model: Toolbar.Model; + defaults: Toolbar.Model; /** Deselect the specified Toolbar item. * @param {any} The element need to be deselected @@ -18296,7 +18342,7 @@ class Toolbar extends ej.Widget { */ show(): void; } -export module Toolbar{ +export namespace Toolbar { export interface Model { @@ -18312,7 +18358,7 @@ export interface Model { /** Disables an Item or set of Items that are enabled in the Toolbar * @Default {[]} */ - disabledItemIndices?: Array; + disabledItemIndices?: any[]; /** Specifies the Toolbar control state. * @Default {true} @@ -18322,7 +18368,7 @@ export interface Model { /** Enables an Item or set of Items that are disabled in the Toolbar * @Default {[]} */ - enabledItemIndices?: Array; + enabledItemIndices?: any[]; /** Specifies enableRTL property to align the Toolbar control from right to left direction. * @Default {false} @@ -18389,28 +18435,28 @@ export interface Model { width?: number|string; /** Fires after Toolbar control is clicked. */ - click? (e: ClickEventArgs): void; + click?(e: ClickEventArgs): void; /** Fires after Toolbar control is created. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Fires after Toolbar control is focused. */ - focusOut? (e: FocusOutEventArgs): void; + focusOut?(e: FocusOutEventArgs): void; /** Fires when the Toolbar is destroyed successfully. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Fires after Toolbar control item is hovered. */ - itemHover? (e: ItemHoverEventArgs): void; + itemHover?(e: ItemHoverEventArgs): void; /** Fires after mouse leave from Toolbar control item. */ - itemLeave? (e: ItemLeaveEventArgs): void; + itemLeave?(e: ItemLeaveEventArgs): void; /** Fires when the overflow popup of toolbar is opened. */ - overflowOpen? (e: OverflowOpenEventArgs): void; + overflowOpen?(e: OverflowOpenEventArgs): void; /** Fires when the overflow popup of toolbar is closed. */ - overflowClose? (e: OverflowCloseEventArgs): void; + overflowClose?(e: OverflowCloseEventArgs): void; } export interface ClickEventArgs { @@ -18671,7 +18717,7 @@ export interface Items { template?: string; } -enum ResponsiveType{ +enum ResponsiveType { ///To display the toolbar overflow items as popup Popup, @@ -18684,11 +18730,10 @@ enum ResponsiveType{ class TreeView extends ej.Widget { static fn: TreeView; - constructor(element: JQuery, options?: TreeView.Model); - constructor(element: Element, options?: TreeView.Model); + constructor(element: JQuery | Element, options?: TreeView.Model); static Locale: any; - model:TreeView.Model; - defaults:TreeView.Model; + model: TreeView.Model; + defaults: TreeView.Model; /** To add a Node or collection of nodes in TreeView. If target tree node is specified, then the given nodes are added as child of target tree node, otherwise nodes are added in TreeView. * @param {string|any} New node text or JSON object @@ -18702,7 +18747,7 @@ class TreeView extends ej.Widget { * @param {string|any} ID of TreeView node/object of TreeView node * @returns {void} */ - addNodes(collection: any|Array, target: string|any): void; + addNodes(collection: any|any[], target: string|any): void; /** To check all the nodes in TreeView. * @returns {void} @@ -18713,9 +18758,10 @@ class TreeView extends ej.Widget { * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes * @returns {void} */ - checkNode(element: string|any|Array): void; + checkNode(element: string|any|any[]): void; - /** This method is used to collapse all nodes in TreeView control. If you want to collapse all nodes up to the specific level in TreeView control then we need to pass levelUntil as argument to this method. + /** This method is used to collapse all nodes in TreeView control. If you want to collapse all nodes up to the specific level in + * TreeView control then we need to pass levelUntil as argument to this method. * @param {number} TreeView nodes will collapse until the given level * @param {boolean} Weather exclude the hidden nodes of TreeView while collapse all nodes * @returns {void} @@ -18726,19 +18772,19 @@ class TreeView extends ej.Widget { * @param {string|any|Array} ID of TreeView node|object of TreeView node/collection of ID/object of TreeView nodes * @returns {void} */ - collapseNode(element: string|any|Array): void; + collapseNode(element: string|any|any[]): void; /** To disable the node in the TreeView. * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes * @returns {void} */ - disableNode(element: string|any|Array): void; + disableNode(element: string|any|any[]): void; /** To enable the node in the TreeView. * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes * @returns {void} */ - enableNode(element: string|any|Array): void; + enableNode(element: string|any|any[]): void; /** To ensure that the TreeView node is visible in the TreeView. This method is useful if we need select a TreeView node dynamically. * @param {string|any} ID of TreeView node/object of TreeView node @@ -18746,7 +18792,8 @@ class TreeView extends ej.Widget { */ ensureVisible(element: string|any): boolean; - /** This method is used to expand all nodes in TreeView control. If you want to expand all nodes up to the specific level in TreeView control then we need to pass levelUntil as argument to this method. + /** This method is used to expand all nodes in TreeView control. If you want to expand all nodes up to the specific level in TreeView control + * then we need to pass levelUntil as argument to this method. * @param {number} TreeView nodes will expand until the given level * @param {boolean} Weather exclude the hidden nodes of TreeView while expand all nodes * @returns {void} @@ -18757,7 +18804,7 @@ class TreeView extends ej.Widget { * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes * @returns {void} */ - expandNode(element: string|any|Array): void; + expandNode(element: string|any|any[]): void; /** To get currently checked nodes in TreeView. * @returns {any} @@ -18767,14 +18814,15 @@ class TreeView extends ej.Widget { /** To get currently checked nodes indexes in TreeView. * @returns {Array} */ - getCheckedNodesIndex(): Array; + getCheckedNodesIndex(): any[]; - /** This method is used to get immediate child nodes of a node in TreeView control. If you want to get the all child nodes include nested child nodes then we need to pass includeNestedChild as true along with element arguments to this method. + /** This method is used to get immediate child nodes of a node in TreeView control. If you want to get the all child nodes include nested + * child nodes then we need to pass includeNestedChild as true along with element arguments to this method. * @param {string|any} ID of TreeView node/object of TreeView node * @param {boolean} Weather include nested child nodes of TreeView node * @returns {Array} */ - getChildren(element: string|any, includeNestedChild?: boolean): Array; + getChildren(element: string|any, includeNestedChild?: boolean): any[]; /** To get number of nodes in TreeView. * @returns {number} @@ -18789,7 +18837,7 @@ class TreeView extends ej.Widget { /** To get currently expanded nodes indexes in TreeView. * @returns {Array} */ - getExpandedNodesIndex(): Array; + getExpandedNodesIndex(): any[]; /** To get TreeView node by using index position in TreeView. * @param {number} Index position of TreeView node @@ -18823,7 +18871,7 @@ class TreeView extends ej.Widget { /** To get the currently selected nodes in TreeView. * @returns {Array} */ - getSelectedNodes(): Array; + getSelectedNodes(): any[]; /** To get the index position of currently selected node in TreeView. * @returns {number} @@ -18833,7 +18881,7 @@ class TreeView extends ej.Widget { /** To get the index positions of currently selected nodes in TreeView. * @returns {Array} */ - getSelectedNodesIndex(): Array; + getSelectedNodesIndex(): any[]; /** To get the text of a node in TreeView. * @param {string|any} ID of TreeView node/object of TreeView node @@ -18845,7 +18893,7 @@ class TreeView extends ej.Widget { * @param {string|number} ID of TreeView node * @returns {Array} */ - getTreeData(id?: string|number): Array; + getTreeData(id?: string|number): any[]; /** To get currently visible nodes in TreeView. * @returns {any} @@ -18867,7 +18915,7 @@ class TreeView extends ej.Widget { * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes * @returns {void} */ - hideNode(element: string|any|Array): void; + hideNode(element: string|any|any[]): void; /** To add a Node or collection of nodes after the particular TreeView node. * @param {string|any} New node text or JSON object @@ -18954,7 +19002,7 @@ class TreeView extends ej.Widget { * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes * @returns {void} */ - removeNode(element: string|any|Array): void; + removeNode(element: string|any|any[]): void; /** To select all the TreeView nodes when enable allowMultiSelection property. * @returns {void} @@ -18965,7 +19013,7 @@ class TreeView extends ej.Widget { * @param {string|any|Array} ID of TreeView node/object of TreeView node/ collection of ID/object of TreeView nodes * @returns {void} */ - selectNode(element: string|any|Array): void; + selectNode(element: string|any|any[]): void; /** To show nodes in TreeView. * @returns {void} @@ -18976,7 +19024,7 @@ class TreeView extends ej.Widget { * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes * @returns {void} */ - showNode(element: string|any|Array): void; + showNode(element: string|any|any[]): void; /** To uncheck all the nodes in TreeView. * @returns {void} @@ -18987,7 +19035,7 @@ class TreeView extends ej.Widget { * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes * @returns {void} */ - uncheckNode(element: string|any|Array): void; + uncheckNode(element: string|any|any[]): void; /** To unselect all the TreeView nodes when enable allowMultiSelection property. * @returns {void} @@ -18998,7 +19046,7 @@ class TreeView extends ej.Widget { * @param {string|any|Array} ID of TreeView node/object of TreeView node/ collection of ID/object of TreeView nodes * @returns {void} */ - unselectNode(element: string|any|Array): void; + unselectNode(element: string|any|any[]): void; /** To edit or update the text of the TreeView node. * @param {string|any} ID of TreeView node/object of TreeView node @@ -19007,7 +19055,7 @@ class TreeView extends ej.Widget { */ updateText(target: string|any, newText: string): void; } -export module TreeView{ +export namespace TreeView { export interface Model { @@ -19059,7 +19107,7 @@ export interface Model { /** Gets or sets a value that indicates the checkedNodes index collection as an array. The given array index position denotes the nodes, that are checked while rendering TreeView. * @Default {[]} */ - checkedNodes?: Array; + checkedNodes?: any[]; /** Sets the root CSS class for TreeView which allow us to customize the appearance. */ @@ -19093,7 +19141,7 @@ export interface Model { /** Gets or sets a array of value that indicates the expandedNodes index collection as an array. The given array index position denotes the nodes, that are expanded while rendering TreeView. * @Default {[]} */ - expandedNodes?: Array; + expandedNodes?: any[]; /** Gets or sets a value that indicates the TreeView node can be expand or collapse by using the specified action. * @Default {dblclick} @@ -19133,7 +19181,7 @@ export interface Model { /** Gets or sets a value that indicates the selectedNodes index collection as an array. The given array index position denotes the nodes, that are selected while rendering TreeView. * @Default {[]} */ - selectedNodes?: Array; + selectedNodes?: any[]; /** Gets or sets a value that indicates whether to display or hide checkbox for all TreeView nodes. * @Default {false} @@ -19155,100 +19203,100 @@ export interface Model { width?: string|number; /** Fires before adding node to TreeView. */ - beforeAdd? (e: BeforeAddEventArgs): void; + beforeAdd?(e: BeforeAddEventArgs): void; /** Fires before collapse a node. */ - beforeCollapse? (e: BeforeCollapseEventArgs): void; + beforeCollapse?(e: BeforeCollapseEventArgs): void; /** Fires before cut node in TreeView. */ - beforeCut? (e: BeforeCutEventArgs): void; + beforeCut?(e: BeforeCutEventArgs): void; /** Fires before deleting node in TreeView. */ - beforeDelete? (e: BeforeDeleteEventArgs): void; + beforeDelete?(e: BeforeDeleteEventArgs): void; /** Fires before editing the node in TreeView. */ - beforeEdit? (e: BeforeEditEventArgs): void; + beforeEdit?(e: BeforeEditEventArgs): void; /** Fires before expanding the node. */ - beforeExpand? (e: BeforeExpandEventArgs): void; + beforeExpand?(e: BeforeExpandEventArgs): void; /** Fires before loading nodes to TreeView. */ - beforeLoad? (e: BeforeLoadEventArgs): void; + beforeLoad?(e: BeforeLoadEventArgs): void; /** Fires before paste node in TreeView. */ - beforePaste? (e: BeforePasteEventArgs): void; + beforePaste?(e: BeforePasteEventArgs): void; /** Fires before selecting node in TreeView. */ - beforeSelect? (e: BeforeSelectEventArgs): void; + beforeSelect?(e: BeforeSelectEventArgs): void; /** Fires when TreeView created successfully. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Fires when TreeView destroyed successfully. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Fires before nodeEdit Successful. */ - inlineEditValidation? (e: InlineEditValidationEventArgs): void; + inlineEditValidation?(e: InlineEditValidationEventArgs): void; /** Fires when key pressed successfully. */ - keyPress? (e: KeyPressEventArgs): void; + keyPress?(e: KeyPressEventArgs): void; /** Fires when data load fails. */ - loadError? (e: LoadErrorEventArgs): void; + loadError?(e: LoadErrorEventArgs): void; /** Fires when data loaded successfully. */ - loadSuccess? (e: LoadSuccessEventArgs): void; + loadSuccess?(e: LoadSuccessEventArgs): void; /** Fires once node added successfully. */ - nodeAdd? (e: NodeAddEventArgs): void; + nodeAdd?(e: NodeAddEventArgs): void; /** Fires once node checked successfully. */ - nodeCheck? (e: NodeCheckEventArgs): void; + nodeCheck?(e: NodeCheckEventArgs): void; /** Fires when node clicked successfully. */ - nodeClick? (e: NodeClickEventArgs): void; + nodeClick?(e: NodeClickEventArgs): void; /** Fires when node collapsed successfully. */ - nodeCollapse? (e: NodeCollapseEventArgs): void; + nodeCollapse?(e: NodeCollapseEventArgs): void; /** Fires when node cut successfully. */ - nodeCut? (e: NodeCutEventArgs): void; + nodeCut?(e: NodeCutEventArgs): void; /** Fires when node deleted successfully. */ - nodeDelete? (e: NodeDeleteEventArgs): void; + nodeDelete?(e: NodeDeleteEventArgs): void; /** Fires when node dragging. */ - nodeDrag? (e: NodeDragEventArgs): void; + nodeDrag?(e: NodeDragEventArgs): void; /** Fires once node drag start successfully. */ - nodeDragStart? (e: NodeDragStartEventArgs): void; + nodeDragStart?(e: NodeDragStartEventArgs): void; /** Fires before the dragged node to be dropped. */ - nodeDragStop? (e: NodeDragStopEventArgs): void; + nodeDragStop?(e: NodeDragStopEventArgs): void; /** Fires once node dropped successfully. */ - nodeDropped? (e: NodeDroppedEventArgs): void; + nodeDropped?(e: NodeDroppedEventArgs): void; /** Fires once node edited successfully. */ - nodeEdit? (e: NodeEditEventArgs): void; + nodeEdit?(e: NodeEditEventArgs): void; /** Fires once node expanded successfully. */ - nodeExpand? (e: NodeExpandEventArgs): void; + nodeExpand?(e: NodeExpandEventArgs): void; /** Fires once node pasted successfully. */ - nodePaste? (e: NodePasteEventArgs): void; + nodePaste?(e: NodePasteEventArgs): void; /** Fires when node selected successfully. */ - nodeSelect? (e: NodeSelectEventArgs): void; + nodeSelect?(e: NodeSelectEventArgs): void; /** Fires once node unchecked successfully. */ - nodeUncheck? (e: NodeUncheckEventArgs): void; + nodeUncheck?(e: NodeUncheckEventArgs): void; /** Fires once node unselected successfully. */ - nodeUnselect? (e: NodeUnselectEventArgs): void; + nodeUnselect?(e: NodeUnselectEventArgs): void; /** Fires when TreeView nodes are loaded successfully */ - ready? (e: ReadyEventArgs): void; + ready?(e: ReadyEventArgs): void; } export interface BeforeAddEventArgs { @@ -19312,7 +19360,7 @@ export interface BeforeCollapseEventArgs { */ parentId?: string; - /** returns the format asynchronous or synchronous + /** returns the format asynchronous or synchronous */ async?: boolean; } @@ -19384,7 +19432,7 @@ export interface BeforeDeleteEventArgs { /** returns the currently removed nodes */ - removedNodes?: Array; + removedNodes?: any[]; } export interface BeforeEditEventArgs { @@ -19440,7 +19488,7 @@ export interface BeforeExpandEventArgs { */ parentId?: string; - /** returns the format asynchronous or synchronous + /** returns the format asynchronous or synchronous */ async?: boolean; } @@ -19739,11 +19787,11 @@ export interface NodeCheckEventArgs { /** it returns the currently checked node name */ - currentNode?: Array; + currentNode?: any[]; /** it returns the currently checked and its child node details */ - currentCheckedNodes?: Array; + currentCheckedNodes?: any[]; } export interface NodeClickEventArgs { @@ -19811,7 +19859,7 @@ export interface NodeCollapseEventArgs { */ isChildLoaded?: boolean; - /** returns the format asynchronous or synchronous + /** returns the format asynchronous or synchronous */ async?: boolean; } @@ -19875,7 +19923,7 @@ export interface NodeDeleteEventArgs { /** returns the currently removed nodes */ - removedNodes?: Array; + removedNodes?: any[]; } export interface NodeDragEventArgs { @@ -20115,7 +20163,7 @@ export interface NodeExpandEventArgs { */ parentId?: string; - /** returns the format asynchronous or synchronous + /** returns the format asynchronous or synchronous */ async?: boolean; } @@ -20175,7 +20223,7 @@ export interface NodeSelectEventArgs { /** returns the current selected nodes index of TreeView */ - selectedNodes?: Array; + selectedNodes?: any[]; /** returns the value of the node */ @@ -20230,7 +20278,7 @@ export interface NodeUncheckEventArgs { /** it returns currently unchecked node and its child node details. */ - currentUncheckedNodes?: Array; + currentUncheckedNodes?: any[]; } export interface NodeUnselectEventArgs { @@ -20257,7 +20305,7 @@ export interface NodeUnselectEventArgs { /** returns the current selected nodes index of TreeView */ - selectedNodes?: Array; + selectedNodes?: any[]; /** returns the name of the event */ @@ -20363,8 +20411,7 @@ export interface SortSettings { sortOrder?: ej.sortOrder|string; } } -enum sortOrder -{ +enum sortOrder { //Enum for Ascending sort order Ascending, //Enum for Descending sort order @@ -20373,11 +20420,10 @@ Descending, class Uploadbox extends ej.Widget { static fn: Uploadbox; - constructor(element: JQuery, options?: Uploadbox.Model); - constructor(element: Element, options?: Uploadbox.Model); + constructor(element: JQuery | Element, options?: Uploadbox.Model); static Locale: any; - model:Uploadbox.Model; - defaults:Uploadbox.Model; + model: Uploadbox.Model; + defaults: Uploadbox.Model; /** The destroy method destroys the control and brings the control to a pre-init state. All the events of the Upload control is bound by using this._on unbinds automatically. * @returns {void} @@ -20399,7 +20445,7 @@ class Uploadbox extends ej.Widget { */ refresh(): void; } -export module Uploadbox{ +export namespace Uploadbox { export interface Model { @@ -20543,37 +20589,37 @@ export interface Model { width?: string; /** Fires when the upload progress beforeSend. */ - beforeSend? (e: BeforeSendEventArgs): void; + beforeSend?(e: BeforeSendEventArgs): void; /** Fires when the upload progress begins. */ - begin? (e: BeginEventArgs): void; + begin?(e: BeginEventArgs): void; /** Fires when the upload progress is cancelled. */ - cancel? (e: CancelEventArgs): void; + cancel?(e: CancelEventArgs): void; /** Fires when the file upload progress is completed. */ - complete? (e: CompleteEventArgs): void; + complete?(e: CompleteEventArgs): void; /** Fires when the file upload progress is succeeded. */ - success? (e: SuccessEventArgs): void; + success?(e: SuccessEventArgs): void; /** Fires when the Uploadbox control is created. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Fires when the Uploadbox control is destroyed. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Fires when the Upload process ends in Error. */ - error? (e: ErrorEventArgs): void; + error?(e: ErrorEventArgs): void; /** Fires when the file is selected for upload successfully. */ - fileSelect? (e: FileSelectEventArgs): void; + fileSelect?(e: FileSelectEventArgs): void; /** Fires when the file is uploading. */ - inProgress? (e: InProgressEventArgs): void; + inProgress?(e: InProgressEventArgs): void; /** Fires when the uploaded file is removed successfully. */ - remove? (e: RemoveEventArgs): void; + remove?(e: RemoveEventArgs): void; } export interface BeforeSendEventArgs { @@ -20876,11 +20922,10 @@ export interface DialogText { class WaitingPopup extends ej.Widget { static fn: WaitingPopup; - constructor(element: JQuery, options?: WaitingPopup.Model); - constructor(element: Element, options?: WaitingPopup.Model); + constructor(element: JQuery | Element, options?: WaitingPopup.Model); static Locale: any; - model:WaitingPopup.Model; - defaults:WaitingPopup.Model; + model: WaitingPopup.Model; + defaults: WaitingPopup.Model; /** To hide the waiting popup * @returns {void} @@ -20897,7 +20942,7 @@ class WaitingPopup extends ej.Widget { */ show(): void; } -export module WaitingPopup{ +export namespace WaitingPopup { export interface Model { @@ -20942,10 +20987,10 @@ export interface Model { text?: string; /** Fires after Create WaitingPopup successfully */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Fires after Destroy WaitingPopup successfully */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; } export interface CreateEventArgs { @@ -20981,29 +21026,28 @@ export interface DestroyEventArgs { class Grid extends ej.Widget { static fn: Grid; - constructor(element: JQuery, options?: Grid.Model); - constructor(element: Element, options?: Grid.Model); + constructor(element: JQuery | Element, options?: Grid.Model); static Locale: any; - model:Grid.Model; - defaults:Grid.Model; + model: Grid.Model; + defaults: Grid.Model; /** Adds a grid model property which is to be ignored upon exporting. - * @param {Array} Pass the array of parameters which need to be ignored on exporting + * @param {Array} Pass the array of parameters which need to be ignored on exporting * @returns {void} */ - addIgnoreOnExport(propertyNames: Array): void; + addIgnoreOnExport(propertyNames: any[]): void; /** Add a new record in grid control when allowAdding is set as true. * @returns {void} */ - addRecord(): void; + //addRecord(): void; /** Add a new record in grid control when allowAdding is set as true. * @param {Array} Pass the array of added Records * @param {Array} optionalIf we pass serverChange as true, send post to server side for server action. * @returns {void} */ - addRecord(data: Array, serverChange?: Array): void; + addRecord(data: any[], serverChange?: any[]): void; /** Cancel the modified changes in grid control when edit mode is "batch". * @returns {void} @@ -21028,20 +21072,20 @@ class Grid extends ej.Widget { /** It is used to clear all the cell selection. * @returns {Boolean} */ - clearCellSelection(): Boolean; + clearCellSelection(): boolean; /** It is used to clear specified cell selection based on the rowIndex and columnIndex provided. * @param {number} It is used to pass the row index of the cell * @param {number} It is used to pass the column index of the cell. * @returns {Boolean} */ - clearCellSelection(rowIndex: number, columnIndex: number): Boolean; + clearCellSelection(rowIndex: number, columnIndex: number): boolean; /** It is used to clear all the row selection or at specific row selection based on the index provided. * @param {number} optional If index of the column is specified then it will remove the selection from the particular column else it will clears all of the column selection * @returns {Boolean} */ - clearColumnSelection(index?: number): Boolean; + clearColumnSelection(index?: number): boolean; /** It is used to clear all the filtering done. * @param {string} If field of the column is specified then it will clear the particular filtering column @@ -21058,7 +21102,7 @@ class Grid extends ej.Widget { * @param {number} optional If index of the row is specified then it will remove the selection from the particular row else it will clears all of the row selection * @returns {Boolean} */ - clearSelection(index?: number): Boolean; + clearSelection(index?: number): boolean; /** Clear the sorting from columns in the grid * @returns {void} @@ -21080,21 +21124,21 @@ class Grid extends ej.Widget { * @param {string} optional Pass add/remove action to be performed. By default "add" action will perform * @returns {void} */ - columns(columnDetails: Array|string, action?: string): void; + columns(columnDetails: any[]|string, action?: string): void; /** Refresh the grid with new data source * @param {Array} Pass new data source to the grid * @param {boolean} optional When templateRefresh is set true, both header and contents get refreshed * @returns {void} */ - dataSource(datasource: Array, templateRefresh?: boolean): void; + dataSource(datasource: any[], templateRefresh?: boolean): void; /** Delete a record in grid control when allowDeleting is set as true * @param {string} Pass the primary key field Name of the column * @param {Array} Pass the JSON data of record need to be delete. * @returns {void} */ - deleteRecord(fieldName: string, data: Array): void; + deleteRecord(fieldName: string, data: any[]): void; /** Delete the row based on the given tr element in grid. * @param {JQuery} Pass the tr element in grid content to get its row index @@ -21117,7 +21161,7 @@ class Grid extends ej.Widget { /** It returns a value and if the input field values of edit form is not based on the validation rules then it will show the validation message. * @returns {Boolean} */ - editFormValidate(): Boolean; + editFormValidate(): boolean; /** Send a save request in grid. * @returns {void} @@ -21147,15 +21191,7 @@ class Grid extends ej.Widget { * @param {Array} optionalPass the array of the gridIds to be filtered * @returns {void} */ - export(action: string, serverEvent?: string, multipleExport?: boolean, gridIds?: Array): void; - - /** Export the grid content to excel, word or PDF document. - * @param {string} Pass the controller action name corresponding to exporting - * @param {string} optionalASP server event name corresponding to exporting - * @param {boolean} optionalPass the multiple exporting value as true/false - * @returns {void} - */ - export(action: string, serverEvent?: string, multipleExport?: boolean): void; + export(action: string, serverEvent?: string, multipleExport?: boolean, gridIds?: any[]): void; /** Send a filtering request to filter one column in grid. * @param {Array} Pass the field name of the column @@ -21166,13 +21202,13 @@ class Grid extends ej.Widget { * @param {any} optionalactualFilterValue denote the filter object of current filtered columns.Pass the value to filtered in a column * @returns {void} */ - filterColumn(fieldName: Array, filterOperator: string, filterValue: string, predicate: string, matchcase?: boolean, actualFilterValue?: any): void; + filterColumn(fieldName: any[], filterOperator: string, filterValue: string, predicate: string, matchcase?: boolean, actualFilterValue?: any): void; /** Send a filtering request to filter single or multiple column in grid. * @param {Array} Pass array of filterColumn query for performing filter operation * @returns {void} */ - filterColumn(filterQueries: Array): void; + filterColumn(filterQueries: any[]): void; /** Get the batch changes of edit, delete and add operations of grid. * @returns {any} @@ -21205,7 +21241,7 @@ class Grid extends ej.Widget { /** Get the list of field names from column collection in grid. * @returns {Array} */ - getColumnFieldNames(): Array; + getColumnFieldNames(): any[]; /** Get the column index of the given field in grid. * @param {string} Pass the field name of the column to get the corresponding column index @@ -21228,7 +21264,7 @@ class Grid extends ej.Widget { /** Get the content table element of grid * @returns {Array} */ - getContentTable(): Array; + getContentTable(): HTMLTableElement[]; /** Get the data of currently edited cell value in "batch" edit mode * @returns {any} @@ -21243,7 +21279,7 @@ class Grid extends ej.Widget { /** Get the current page data source of grid. * @returns {Array} */ - getCurrentViewData(): Array; + getCurrentViewData(): any[]; /** Get the data of given row index in grid. * @returns {any} @@ -21254,7 +21290,7 @@ class Grid extends ej.Widget { * @param {string} Pass header text of the column to get its corresponding field name * @returns {String} */ - getFieldNameByHeaderText(headerText: string): String; + getFieldNameByHeaderText(headerText: string): string; /** Get the filter bar of grid * @returns {HTMLElement} @@ -21264,7 +21300,7 @@ class Grid extends ej.Widget { /** Get the records filtered or searched in Grid * @returns {Array} */ - getFilteredRecords(): Array; + getFilteredRecords(): any[]; /** Get the footer content of grid. * @returns {HTMLElement} @@ -21290,12 +21326,12 @@ class Grid extends ej.Widget { * @param {string} Pass field name of the column to get its corresponding header text * @returns {String} */ - getHeaderTextByFieldName(field: string): String; + getHeaderTextByFieldName(field: string): string; /** Get the names of all the hidden column collections in grid. * @returns {Array} */ - getHiddenColumnNames(): Array; + getHiddenColumnNames(): any[]; /** Get the row index based on the given tr element in grid. * @param {JQuery} Pass the tr element in grid content to get its row index @@ -21311,7 +21347,7 @@ class Grid extends ej.Widget { /** Get the names of primary key columns in Grid * @returns {Array} */ - getPrimaryKeyFieldNames(): Array; + getPrimaryKeyFieldNames(): any[]; /** Get the rows(tr element) from the given from and to row index in grid * @param {number} Pass the from index from which the rows to be returned @@ -21338,12 +21374,12 @@ class Grid extends ej.Widget { /** Get the selected records details in grid. * @returns {Array} */ - getSelectedRecords(): Array; + getSelectedRecords(): any[]; /** Get the selected row element details in grid. * @returns {Array} */ - getSelectedRows(): Array; + getSelectedRows(): any[]; /** It accepts the string value and returns the field and sorted direction of the column in grid. * @param {string} Pass the field of the column to get the sorted direction of the corresponding column in Grid. @@ -21356,12 +21392,12 @@ class Grid extends ej.Widget { * @param {any} Pass JSON Array for which its field values to be calculated * @returns {Number} */ - getSummaryValues(summaryCol: any, summaryData: any): Number; + getSummaryValues(summaryCol: any, summaryData: any): number; /** Get the names of all the visible column collections in grid * @returns {Array} */ - getVisibleColumnNames(): Array; + getVisibleColumnNames(): any[]; /** Send a paging request to specified page in grid * @param {number} Pass the page index to perform paging at specified page index @@ -21379,7 +21415,7 @@ class Grid extends ej.Widget { * @param {Array|string} you can pass either array of header text of various columns or a header text of a column to hide * @returns {void} */ - hideColumns(headerText: Array|string): void; + hideColumns(headerText: any[]|string): void; /** Print the grid control * @returns {void} @@ -21416,7 +21452,7 @@ class Grid extends ej.Widget { * @param {Array|string} Pass array of field names of the columns to remove a collection of sorted columns or pass a string of field name to remove a column from sorted column collections * @returns {void} */ - removeSortedColumns(fieldName: Array|string): void; + removeSortedColumns(fieldName: any[]|string): void; /** Creates a grid control * @returns {void} @@ -21435,7 +21471,7 @@ class Grid extends ej.Widget { * @param {number} Pass the index of a row where to be reordered. * @returns {void} */ - reorderRows(indexes: Array, toIndex: number): void; + reorderRows(indexes: any[], toindex: number): void; /** Reset the model collections like pageSettings, groupSettings, filterSettings, sortSettings and summaryRows. * @returns {void} @@ -21457,10 +21493,10 @@ class Grid extends ej.Widget { /** Save the particular edited cell in grid. * @returns {void} */ - saveCell(): void; + //saveCell(): void; /** We can prevent the client side cellSave event triggering by passing the preventSaveEvent argument as true. - * @param {boolean} optionalIf we pass preventSaveEvent as true, it prevents the client side cellSave event triggering + * @param {boolean} optionalIf we pass preventSaveEvent as true, it prevents the client side cellSave event triggering * @returns {void} */ saveCell(preventSaveEvent: boolean): void; @@ -21500,7 +21536,7 @@ class Grid extends ej.Widget { * @param {number} optionalIt is used to set the ending index of column for selecting columns. * @returns {Boolean} */ - selectColumns(columnIndex: number, toIndex?: number): Boolean; + selectColumns(columnIndex: number, toIndex?: number): boolean; /** Select rows in grid. * @param {number} It is used to set the starting index of row for selecting rows. @@ -21515,13 +21551,13 @@ class Grid extends ej.Widget { * @param {any} optionalTarget element which is clicked. * @returns {void} */ - selectRows(from: Array|number, to: number, target?: any): void; + selectRows(from: any[]|number, to: number, target?: any): void; /** Select rows in grid. * @param {Array} Pass array of rowIndexes for selecting rows * @returns {void} */ - selectRows(rowIndexes: Array): void; + selectRows(rowIndexes: any[]): void; /** Used to update a particular cell value. * @returns {void} @@ -21563,7 +21599,7 @@ class Grid extends ej.Widget { * @param {Array|string} you can pass either array of header text of various columns or a header text of a column to show * @returns {void} */ - showColumns(headerText: Array|string): void; + showColumns(headerText: any[]|string): void; /** Send a sorting request in grid. * @param {string} Pass the field name of the column as columnName for which sorting have to be performed @@ -21589,100 +21625,105 @@ class Grid extends ej.Widget { * @param {Array} Pass the edited JSON data of record need to be update. * @returns {void} */ - updateRecord(fieldName: string, data: Array): void; + updateRecord(fieldName: string, data: any[]): void; /** It adapts grid to its parent element or to the browsers window. * @returns {void} */ windowonresize(): void; } -export module Grid{ +export namespace Grid { export interface Model { /** Gets or sets a value that indicates whether to customizing cell based on our needs. * @Default {false} */ - allowCellMerging?: Boolean; + allowCellMerging?: boolean; - /** Gets or sets a value that indicates whether to enable dynamic grouping behavior. Grouping can be done by drag on drop desired columns to gridĂ¢â‚¬â„¢s GroupDropArea. This can be further customized through Ă¢â‚¬Å“groupSettingsĂ¢â‚¬Â property. + /** Gets or sets a value that indicates whether to enable dynamic grouping behavior. Grouping can be done by drag on drop desired columns to gridĂ¢â‚¬â„¢s GroupDropArea. + * This can be further customized through Ă¢â‚¬Å“groupSettingsĂ¢â‚¬Â property. * @Default {false} */ - allowGrouping?: Boolean; + allowGrouping?: boolean; - /** Gets or sets a value that indicates whether to enable keyboard support for performing grid actions. selectionType Ă¢â‚¬â€œ Gets or sets a value that indicates whether to enable single row or multiple rows selection behavior in grid. Multiple selection can be done through by holding CTRL and clicking the grid rows + /** Gets or sets a value that indicates whether to enable keyboard support for performing grid actions. selectionType Ă¢â‚¬â€œ Gets or sets a value that indicates whether to enable single + * row or multiple rows selection behavior in grid. Multiple selection can be done through by holding CTRL and clicking the grid rows * @Default {true} */ - allowKeyboardNavigation?: Boolean; + allowKeyboardNavigation?: boolean; - /** Gets or sets a value that indicates whether to enable dynamic filtering behavior on grid. Filtering can be used to limit the records displayed using required criteria and this can be further customized through Ă¢â‚¬Å“filterSettingsĂ¢â‚¬Â property + /** Gets or sets a value that indicates whether to enable dynamic filtering behavior on grid. Filtering can be used to limit the records displayed using required criteria and + * this can be further customized through Ă¢â‚¬Å“filterSettingsĂ¢â‚¬Â property * @Default {false} */ - allowFiltering?: Boolean; + allowFiltering?: boolean; /** Gets or sets a value that indicates whether to enable the dynamic sorting behavior on grid data. Sorting can be done through clicking on particular column header. * @Default {false} */ - allowSorting?: Boolean; + allowSorting?: boolean; /** Gets or sets a value that indicates whether to enable multi columns sorting behavior in grid. Sort multiple columns by holding CTRL and click on the corresponding column header. * @Default {false} */ - allowMultiSorting?: Boolean; + allowMultiSorting?: boolean; - /** This specifies the grid to show the paginated data. Also enables pager control at the bottom of grid for dynamic navigation through data source. Paging can be further customized through Ă¢â‚¬Å“pageSettingsĂ¢â‚¬Â property. + /** This specifies the grid to show the paginated data. Also enables pager control at the bottom of grid for dynamic navigation through data source. + * Paging can be further customized through Ă¢â‚¬Å“pageSettingsĂ¢â‚¬Â property. * @Default {false} */ - allowPaging?: Boolean; + allowPaging?: boolean; - /** Gets or sets a value that indicates whether to enable the columns reordering behavior in the grid. Reordering can be done through by drag and drop the particular column from one index to another index within the grid. + /** Gets or sets a value that indicates whether to enable the columns reordering behavior in the grid. Reordering can be done through by drag and drop the particular column + * from one index to another index within the grid. * @Default {false} */ - allowReordering?: Boolean; + allowReordering?: boolean; /** Gets or sets a value that indicates whether the column is non resizable. Column width is set automatically based on the content or header text which is large. * @Default {false} */ - allowResizeToFit?: Boolean; + allowResizeToFit?: boolean; /** Gets or sets a value that indicates whether to enable dynamic resizable of columns. Resize the width of the columns by simply click and move the particular column header line * @Default {false} */ - allowResizing?: Boolean; + allowResizing?: boolean; /** Gets or sets a value that indicates whether to enable the rows reordering in Grid and drag & drop rows between multiple Grid. * @Default {false} */ - allowRowDragAndDrop?: Boolean; + allowRowDragAndDrop?: boolean; /** Gets or sets a value that indicates whether to enable the scrollbar in the grid and view the records by scroll through the grid manually * @Default {false} */ - allowScrolling?: Boolean; + allowScrolling?: boolean; /** Gets or sets a value that indicates whether to enable dynamic searching behavior in grid. Currently search box can be enabled through Ă¢â‚¬Å“toolbarSettingsĂ¢â‚¬Â * @Default {false} */ - allowSearching?: Boolean; + allowSearching?: boolean; /** Gets or sets a value that indicates whether user can select rows on grid. On enabling feature, selected row will be highlighted. * @Default {true} */ - allowSelection?: Boolean; + allowSelection?: boolean; /** Gets or sets a value that indicates whether the Content will wrap to the next line if the content exceeds the boundary of the Column Cells. * @Default {false} */ - allowTextWrap?: Boolean; + allowTextWrap?: boolean; /** Gets or sets a value that indicates whether to enable the multiple exporting behavior on grid data. * @Default {false} */ - allowMultipleExporting?: Boolean; + allowMultipleExporting?: boolean; /** Gets or sets a value that indicates to define common width for all the columns in the grid. */ - commonWidth?: Number; + commonWidth?: number; /** Gets or sets a value that indicates to enable the visibility of the grid lines. * @Default {ej.Grid.GridLines.Both} @@ -21702,7 +21743,7 @@ export interface Model { /** Gets or sets an object that indicates to render the grid with specified columns * @Default {[]} */ - columns?: Array; + columns?: Column[]; /** Gets or sets an object that indicates whether to customize the context menu behavior of the grid. */ @@ -21710,7 +21751,7 @@ export interface Model { /** Gets or sets a value that indicates to render the grid with custom theme. */ - cssClass?: String; + cssClass?: string; /** Gets or sets the data to render the grid with records * @Default {null} @@ -21720,7 +21761,7 @@ export interface Model { /** Default Value: * @Default {null} */ - detailsTemplate?: String; + detailsTemplate?: string; /** Gets or sets an object that indicates whether to customize the editing behavior of the grid. */ @@ -21729,47 +21770,47 @@ export interface Model { /** Gets or sets a value that indicates whether to enable the alternative rows differentiation in the grid records based on corresponding theme. * @Default {true} */ - enableAltRow?: Boolean; + enableAltRow?: boolean; /** Gets or sets a value that indicates whether to enable the save action in the grid through row selection * @Default {true} */ - enableAutoSaveOnSelectionChange?: Boolean; + enableAutoSaveOnSelectionChange?: boolean; /** Gets or sets a value that indicates whether to enable mouse over effect on the corresponding column header cell of the grid * @Default {false} */ - enableHeaderHover?: Boolean; + enableHeaderHover?: boolean; /** Gets or sets a value that indicates whether to persist the grid model state in page using applicable medium i.e., HTML5 localStorage or cookies * @Default {false} */ - enablePersistence?: Boolean; + enablePersistence?: boolean; /** Gets or sets a value that indicates whether the grid rows has to be rendered as detail view in mobile mode * @Default {false} */ - enableResponsiveRow?: Boolean; + enableResponsiveRow?: boolean; /** Gets or sets a value that indicates whether to enable mouse over effect on corresponding grid row. * @Default {true} */ - enableRowHover?: Boolean; + enableRowHover?: boolean; /** Align content in the grid control from right to left by setting the property as true. * @Default {false} */ - enableRTL?: Boolean; + enableRTL?: boolean; /** To Disable the mouse swipe property as false. * @Default {true} */ - enableTouch?: Boolean; + enableTouch?: boolean; /** It sets a value that indicates whether to enable toolbar items, when allowEditing, allowAdding and allowDeleting property set as false in the grid. * @Default {false} */ - enableToolbarItems?: Boolean; + enableToolbarItems?: boolean; /** Act as mapper for the excel exporting URL. * @Default {ExportToExcel} @@ -21797,22 +21838,23 @@ export interface Model { /** Gets or sets a value that indicates whether the grid design has be to made responsive. * @Default {false} */ - isResponsive?: Boolean; + isResponsive?: boolean; /** This specifies to change the key in keyboard interaction to grid control * @Default {null} */ keySettings?: any; - /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and culture specific to a particular country or region. + /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and + * culture specific to a particular country or region. * @Default {en-US} */ - locale?: String; + locale?: string; /** Gets or sets a value that indicates whether to set the minimum width of the responsive grid while isResponsive property is true and enableResponsiveRow property is set as false. * @Default {0} */ - minWidth?: Number; + minWidth?: number; /** Gets or sets an object that indicates whether to modify the pager default configuration. */ @@ -21827,10 +21869,11 @@ export interface Model { */ resizeSettings?: ResizeSettings; - /** Gets or sets a value that indicates to render the grid with template rows. The template row must be a table row. That table row must have the JavaScript render binding format ({{:columnName}}) then the grid data source binds the data to the corresponding table row of the template. + /** Gets or sets a value that indicates to render the grid with template rows. The template row must be a table row. That table row must have the JavaScript render binding format ({{:columnName}}) + * then the grid data source binds the data to the corresponding table row of the template. * @Default {null} */ - rowTemplate?: String; + rowTemplate?: string; /** Gets or sets an object that indicates whether to customize the drag and drop behavior of the grid rows */ @@ -21840,20 +21883,21 @@ export interface Model { */ searchSettings?: SearchSettings; - /** Gets a value that indicates whether the grid model to hold multiple selected records . selectedRecords can be used to displayed hold the single or multiple selected records using Ă¢â‚¬Å“selectedRecordsĂ¢â‚¬Â property + /** Gets a value that indicates whether the grid model to hold multiple selected records . selectedRecords can be used to displayed hold the single + * or multiple selected records using Ă¢â‚¬Å“selectedRecordsĂ¢â‚¬Â property * @Default {null} */ - selectedRecords?: Array; + selectedRecords?: any[]; /** Gets or sets a value that indicates to select the row while initializing the grid * @Default {-1} */ - selectedRowIndex?: Number; + selectedRowIndex?: number; /** Gets or sets a value that indicates the selected rows in grid * @Default {[]} */ - selectedRowIndices?: Array; + selectedRowIndices?: any[]; /** This property is used to configure the selection behavior of the grid. */ @@ -21871,17 +21915,17 @@ export interface Model { /** Default Value: * @Default {false} */ - showColumnChooser?: Boolean; + showColumnChooser?: boolean; /** Gets or sets a value that indicates stacked header should be shown on grid layout when the property Ă¢â‚¬Å“stackedHeaderRowsĂ¢â‚¬Â is set. * @Default {false} */ - showStackedHeader?: Boolean; + showStackedHeader?: boolean; /** Gets or sets a value that indicates summary rows should be shown on grid layout when the property Ă¢â‚¬Å“summaryRowsĂ¢â‚¬Â is set * @Default {false} */ - showSummary?: Boolean; + showSummary?: boolean; /** Gets or sets a value that indicates whether to customize the sorting behavior of the grid. */ @@ -21890,12 +21934,12 @@ export interface Model { /** Gets or sets an object that indicates to managing the collection of stacked header rows for the grid. * @Default {[]} */ - stackedHeaderRows?: Array; + stackedHeaderRows?: StackedHeaderRow[]; /** Gets or sets an object that indicates to managing the collection of summary rows for the grid. * @Default {[]} */ - summaryRows?: Array; + summaryRows?: SummaryRow[]; /** Gets or sets an object that indicates whether to auto wrap the grid header or content or both */ @@ -21906,166 +21950,166 @@ export interface Model { toolbarSettings?: ToolbarSettings; /** Triggered for every grid action before its starts. */ - actionBegin? (e: ActionBeginEventArgs): void; + actionBegin?(e: ActionBeginEventArgs): void; /** Triggered for every grid action success event. */ - actionComplete? (e: ActionCompleteEventArgs): void; + actionComplete?(e: ActionCompleteEventArgs): void; /** Triggered for every grid action server failure event. */ - actionFailure? (e: ActionFailureEventArgs): void; + actionFailure?(e: ActionFailureEventArgs): void; /** Triggered when record batch add. */ - batchAdd? (e: BatchAddEventArgs): void; + batchAdd?(e: BatchAddEventArgs): void; /** Triggered when record batch delete. */ - batchDelete? (e: BatchDeleteEventArgs): void; + batchDelete?(e: BatchDeleteEventArgs): void; /** Triggered before the batch add. */ - beforeBatchAdd? (e: BeforeBatchAddEventArgs): void; + beforeBatchAdd?(e: BeforeBatchAddEventArgs): void; /** Triggered before the batch delete. */ - beforeBatchDelete? (e: BeforeBatchDeleteEventArgs): void; + beforeBatchDelete?(e: BeforeBatchDeleteEventArgs): void; /** Triggered before the batch save. */ - beforeBatchSave? (e: BeforeBatchSaveEventArgs): void; + beforeBatchSave?(e: BeforeBatchSaveEventArgs): void; /** Triggered before the print. */ - beforePrint? (e: BeforePrintEventArgs): void; + beforePrint?(e: BeforePrintEventArgs): void; /** Triggered before row drop in the grid */ - beforeRowDrop? (e: BeforeRowDropEventArgs): void; + beforeRowDrop?(e: BeforeRowDropEventArgs): void; /** Triggered before the record is going to be edited. */ - beginEdit? (e: BeginEditEventArgs): void; + beginEdit?(e: BeginEditEventArgs): void; /** Triggered when record cell edit. */ - cellEdit? (e: CellEditEventArgs): void; + cellEdit?(e: CellEditEventArgs): void; /** Triggered when record cell save. */ - cellSave? (e: CellSaveEventArgs): void; + cellSave?(e: CellSaveEventArgs): void; /** Triggered after the cell is selected. */ - cellSelected? (e: CellSelectedEventArgs): void; + cellSelected?(e: CellSelectedEventArgs): void; /** Triggered before the cell is going to be selected. */ - cellSelecting? (e: CellSelectingEventArgs): void; + cellSelecting?(e: CellSelectingEventArgs): void; /** Triggered after the cell is deselected. */ - cellDeselected? (e: CellDeselectedEventArgs): void; + cellDeselected?(e: CellDeselectedEventArgs): void; /** Triggered before the cell is going to be deselected. */ - cellDeselecting? (e: CellDeselectingEventArgs): void; + cellDeselecting?(e: CellDeselectingEventArgs): void; /** Triggered when the column is being dragged. */ - columnDrag? (e: ColumnDragEventArgs): void; + columnDrag?(e: ColumnDragEventArgs): void; /** Triggered when column dragging begins. */ - columnDragStart? (e: ColumnDragStartEventArgs): void; + columnDragStart?(e: ColumnDragStartEventArgs): void; /** Triggered when the column is dropped. */ - columnDrop? (e: ColumnDropEventArgs): void; + columnDrop?(e: ColumnDropEventArgs): void; /** Triggered when the row is being dragged. */ - rowDrag? (e: RowDragEventArgs): void; + rowDrag?(e: RowDragEventArgs): void; /** Triggered when row dragging begins. */ - rowDragStart? (e: RowDragStartEventArgs): void; + rowDragStart?(e: RowDragStartEventArgs): void; /** Triggered when the row is dropped. */ - rowDrop? (e: RowDropEventArgs): void; + rowDrop?(e: RowDropEventArgs): void; /** Triggered after the column is selected. */ - columnSelected? (e: ColumnSelectedEventArgs): void; + columnSelected?(e: ColumnSelectedEventArgs): void; /** Triggered before the column is going to be selected. */ - columnSelecting? (e: ColumnSelectingEventArgs): void; + columnSelecting?(e: ColumnSelectingEventArgs): void; /** Triggered after the column is deselected. */ - columnDeselected? (e: ColumnDeselectedEventArgs): void; + columnDeselected?(e: ColumnDeselectedEventArgs): void; /** Triggered before the column is going to be deselected. */ - columnDeselecting? (e: ColumnDeselectingEventArgs): void; + columnDeselecting?(e: ColumnDeselectingEventArgs): void; /** Triggered when context menu item is clicked */ - contextClick? (e: ContextClickEventArgs): void; + contextClick?(e: ContextClickEventArgs): void; /** Triggered before the context menu is opened. */ - contextOpen? (e: ContextOpenEventArgs): void; + contextOpen?(e: ContextOpenEventArgs): void; /** Triggered when the grid is rendered completely. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Triggered when the grid is bound with data during initial rendering. */ - dataBound? (e: DataBoundEventArgs): void; + dataBound?(e: DataBoundEventArgs): void; /** Triggered when grid going to destroy. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Triggered when detail template row is clicked to collapse. */ - detailsCollapse? (e: DetailsCollapseEventArgs): void; + detailsCollapse?(e: DetailsCollapseEventArgs): void; /** Triggered detail template row is initialized. */ - detailsDataBound? (e: DetailsDataBoundEventArgs): void; + detailsDataBound?(e: DetailsDataBoundEventArgs): void; /** Triggered when detail template row is clicked to expand. */ - detailsExpand? (e: DetailsExpandEventArgs): void; + detailsExpand?(e: DetailsExpandEventArgs): void; /** Triggered after the record is added. */ - endAdd? (e: EndAddEventArgs): void; + endAdd?(e: EndAddEventArgs): void; /** Triggered after the record is deleted. */ - endDelete? (e: EndDeleteEventArgs): void; + endDelete?(e: EndDeleteEventArgs): void; /** Triggered after the record is edited. */ - endEdit? (e: EndEditEventArgs): void; + endEdit?(e: EndEditEventArgs): void; /** Triggered initial load. */ - load? (e: LoadEventArgs): void; + load?(e: LoadEventArgs): void; /** Triggered every time a request is made to access particular cell information, element and data. */ - mergeCellInfo? (e: MergeCellInfoEventArgs): void; + mergeCellInfo?(e: MergeCellInfoEventArgs): void; /** Triggered every time a request is made to access particular cell information, element and data. */ - queryCellInfo? (e: QueryCellInfoEventArgs): void; + queryCellInfo?(e: QueryCellInfoEventArgs): void; /** Triggered when record is clicked. */ - recordClick? (e: RecordClickEventArgs): void; + recordClick?(e: RecordClickEventArgs): void; /** Triggered when record is double clicked. */ - recordDoubleClick? (e: RecordDoubleClickEventArgs): void; + recordDoubleClick?(e: RecordDoubleClickEventArgs): void; /** Triggered after column resized. */ - resized? (e: ResizedEventArgs): void; + resized?(e: ResizedEventArgs): void; /** Triggered when column resize end. */ - resizeEnd? (e: ResizeEndEventArgs): void; + resizeEnd?(e: ResizeEndEventArgs): void; /** Triggered when column resize start. */ - resizeStart? (e: ResizeStartEventArgs): void; + resizeStart?(e: ResizeStartEventArgs): void; /** Triggered when right clicked on grid element. */ - rightClick? (e: RightClickEventArgs): void; + rightClick?(e: RightClickEventArgs): void; /** Triggered every time a request is made to access row information, element and data. */ - rowDataBound? (e: RowDataBoundEventArgs): void; + rowDataBound?(e: RowDataBoundEventArgs): void; /** Triggered after the row is selected. */ - rowSelected? (e: RowSelectedEventArgs): void; + rowSelected?(e: RowSelectedEventArgs): void; /** Triggered before the row is going to be selected. */ - rowSelecting? (e: RowSelectingEventArgs): void; + rowSelecting?(e: RowSelectingEventArgs): void; /** Triggered after the row is deselected. */ - rowDeselected? (e: RowDeselectedEventArgs): void; + rowDeselected?(e: RowDeselectedEventArgs): void; /** Triggered before the row is going to be deselected. */ - rowDeselecting? (e: RowDeselectingEventArgs): void; + rowDeselecting?(e: RowDeselectingEventArgs): void; /** Triggered when refresh the template column elements in the Grid. */ - templateRefresh? (e: TemplateRefreshEventArgs): void; + templateRefresh?(e: TemplateRefreshEventArgs): void; /** Triggered when toolbar item is clicked in grid. */ - toolbarClick? (e: ToolbarClickEventArgs): void; + toolbarClick?(e: ToolbarClickEventArgs): void; } export interface ActionBeginEventArgs { @@ -22719,7 +22763,7 @@ export interface CellSelectedEventArgs { /** Returns the selected row cell index values. */ - selectedRowCellIndex?: Array; + selectedRowCellIndex?: any[]; /** Returns the cancel option value. */ @@ -23025,7 +23069,7 @@ export interface ColumnSelectedEventArgs { /** Returns the selected columns values. */ - selectedColumnsIndex?: Array; + selectedColumnsIndex?: any[]; /** Returns the cancel option value. */ @@ -23405,15 +23449,15 @@ export interface MergeCellInfoEventArgs { /** Method to merge Grid rows. */ - rowMerge?: void; + rowMerge?: any; /** Method to merge Grid columns. */ - colMerge?: void; + colMerge?: any; /** Method to merge Grid rows and columns. */ - merge?: void; + merge?: any; /** Returns the grid model. */ @@ -23951,59 +23995,60 @@ export interface Column { /** Gets or sets a value that indicates whether to enable editing behavior for particular column. * @Default {true} */ - allowEditing?: Boolean; + allowEditing?: boolean; /** Gets or sets a value that indicates whether to enable dynamic filtering behavior for particular column. * @Default {true} */ - allowFiltering?: Boolean; + allowFiltering?: boolean; /** Gets or sets a value that indicates whether to enable dynamic grouping behavior for particular column. * @Default {true} */ - allowGrouping?: Boolean; + allowGrouping?: boolean; /** Gets or sets a value that indicates whether to enable dynamic sorting behavior for particular column. * @Default {true} */ - allowSorting?: Boolean; + allowSorting?: boolean; /** Gets or sets a value that indicates whether to enable dynamic resizable for particular column. * @Default {true} */ - allowResizing?: Boolean; + allowResizing?: boolean; /** Gets or sets an object that indicates to define a command column in the grid. * @Default {[]} */ - commands?: Array; + commands?: ColumnsCommand[]; /** Gets or sets a value that indicates to provide custom CSS for an individual column. */ - cssClass?: String; + cssClass?: string; /** Gets or sets a value that indicates the attribute values to the td element of a particular column */ customAttributes?: any; - /** Gets or sets a value that indicates to bind the external datasource to the particular column when column editType as dropdownedit and also it is used to bind the datasource to the foreign key column while editing the grid. //Where data is array of JSON objects of text and value for the drop-down and array of JSON objects for foreign key column. + /** Gets or sets a value that indicates to bind the external datasource to the particular column when column editType as dropdownedit and also it is used to bind the datasource + * to the foreign key column while editing the grid. //Where data is array of JSON objects of text and value for the drop-down and array of JSON objects for foreign key column. * @Default {null} */ - dataSource?: Array; + dataSource?: any[]; /** Gets or sets a value that indicates to display the specified default value while adding a new record to the grid */ - defaultValue?: String|Number|Boolean|Date; + defaultValue?: string|number|boolean|Date; /** Gets or sets a value that indicates to render the grid content and header with an HTML elements * @Default {false} */ - disableHtmlEncode?: Boolean; + disableHtmlEncode?: boolean; /** Gets or sets a value that indicates to display a column value as checkbox or string * @Default {true} */ - displayAsCheckBox?: Boolean; + displayAsCheckBox?: boolean; /** Gets or sets a value that indicates to customize ejNumericTextbox of an editable column. See editingType */ @@ -24022,11 +24067,11 @@ export interface Column { /** Gets or sets a value that indicates to groups the column based on its column format. * @Default {false} */ - enableGroupByFormat?: Boolean; + enableGroupByFormat?: boolean; /** Gets or sets a value that indicates to display the columns in the grid mapping with column name of the dataSource. */ - field?: String; + field?: string; /** Gets or sets a template that customize the filter control from default . See filterBarTemplate * @Default {null} @@ -24041,25 +24086,25 @@ export interface Column { /** Gets or sets a value that indicates to define foreign key field name of the grid datasource. * @Default {null} */ - foreignKeyField?: String; + foreignKeyField?: string; /** Gets or sets a value that indicates to bind the field which is in foreign column datasource based on the foreignKeyField * @Default {null} */ - foreignKeyValue?: String; + foreignKeyValue?: string; /** Gets or sets a value that indicates the format for the text applied on the column */ - format?: String; + format?: string; /** Gets or sets a value that indicates to add the template within the header element of the particular column. * @Default {null} */ - headerTemplateID?: String; + headerTemplateID?: string; /** Gets or sets a value that indicates to display the title of that particular column. */ - headerText?: String; + headerText?: string; /** This defines the text alignment of a particular column header cell value. See headerTextAlign * @Default {null} @@ -24069,42 +24114,42 @@ export interface Column { /** It accepts the string value and shows the tooltip for the Grid column header. * @Default {null} */ - headerTooltip?: String; + headerTooltip?: string; /** You can use this property to freeze selected columns in grid at the time of scrolling. * @Default {false} */ - isFrozen?: Boolean; + isFrozen?: boolean; /** Gets or sets a value that indicates the column has an identity in the database. * @Default {false} */ - isIdentity?: Boolean; + isIdentity?: boolean; /** Gets or sets a value that indicates the column is act as a primary key(read-only) of the grid. The editing is performed based on the primary key column * @Default {false} */ - isPrimaryKey?: Boolean; + isPrimaryKey?: boolean; /** Gets or sets a value that indicates the order of Column that are to be hidden or visible when Grid element is in responsive mode and could not occupy all columns. * @Default {-1} */ - priority?: Number; + priority?: number; /** Used to hide the particular column in column chooser by giving value as false. * @Default {true} */ - showInColumnChooser?: Boolean; + showInColumnChooser?: boolean; /** Gets or sets a value that indicates whether to enables column template for a particular column. * @Default {false} */ - template?: Boolean|String; + template?: boolean|string; /** Gets or sets a value that indicates to align the text within the column. See textAlign * @Default {ej.TextAlign.Left} */ - textAlign?: ej.TextAlign|string; + textAlign?: ej.TextAlign|string; /** Sets the template for Tooltip in Grid Columns(both header and content) */ @@ -24112,7 +24157,7 @@ export interface Column { /** Gets or sets a value that indicates to specify the data type of the specified columns. */ - type?: String; + type?: string; /** Gets or sets a value that indicates to define constraints for saving data to the database. */ @@ -24121,11 +24166,11 @@ export interface Column { /** Gets or sets a value that indicates whether this column is visible in the grid. * @Default {true} */ - visible?: Boolean; + visible?: boolean; /** Gets or sets a value that indicates to define the width for a particular column in the grid. */ - width?: Number; + width?: number; } export interface ContextMenuSettingsSubContextMenu { @@ -24138,34 +24183,35 @@ export interface ContextMenuSettingsSubContextMenu { /** Used to get or set the sub menu items to the custom context menu item. * @Default {[]} */ - subMenu?: Array; + subMenu?: any[]; } export interface ContextMenuSettings { - /** Gets or sets a value that indicates whether to add the default context menu actions as a context menu items If enableContextMenu is true it will show all the items related to the target, if you want selected items from contextmenu you have to mention in the contextMenuItems + /** Gets or sets a value that indicates whether to add the default context menu actions as a context menu items If enableContextMenu is true it will show all the items related to the target, + * if you want selected items from contextmenu you have to mention in the contextMenuItems * @Default {[]} */ - contextMenuItems?: Array; + contextMenuItems?: any[]; /** Gets or sets a value that indicates whether to add custom contextMenu items within the toolbar to perform any action in the grid * @Default {[]} */ - customContextMenuItems?: Array; + customContextMenuItems?: any[]; /** Gets or sets a value that indicates whether to enable the context menu action in the grid. * @Default {false} */ - enableContextMenu?: Boolean; + enableContextMenu?: boolean; /** Used to get or set the subMenu to the corresponding custom context menu item. */ - subContextMenu?: Array; + subContextMenu?: ContextMenuSettingsSubContextMenu[]; /** Gets or sets a value that indicates whether to disable the default context menu items in the grid. * @Default {false} */ - disableDefaultItems?: Boolean; + disableDefaultItems?: boolean; } export interface EditSettings { @@ -24173,27 +24219,27 @@ export interface EditSettings { /** Gets or sets a value that indicates whether to enable insert action in the editing mode. * @Default {false} */ - allowAdding?: Boolean; + allowAdding?: boolean; /** Gets or sets a value that indicates whether to enable the delete action in the editing mode. * @Default {false} */ - allowDeleting?: Boolean; + allowDeleting?: boolean; /** Gets or sets a value that indicates whether to enable the edit action in the editing mode. * @Default {false} */ - allowEditing?: Boolean; + allowEditing?: boolean; /** Gets or sets a value that indicates whether to enable the editing action while double click on the record * @Default {true} */ - allowEditOnDblClick?: Boolean; + allowEditOnDblClick?: boolean; /** This specifies the id of the template. This template can be used to display the data that you require to be edited using the Dialog Box * @Default {null} */ - dialogEditorTemplateID?: String; + dialogEditorTemplateID?: string; /** Gets or sets a value that indicates whether to define the mode of editing See editMode * @Default {ej.Grid.EditMode.Normal} @@ -24203,9 +24249,9 @@ export interface EditSettings { /** This specifies the id of the template. This template can be used to display the data that you require to be edited using the External edit form * @Default {null} */ - externalFormTemplateID?: String; + externalFormTemplateID?: string; - /** This specifies to set the position of an External edit form either in the top-right or bottom-left of the grid. See formPosition + /** This specifies to set the position of an External edit form either in the top-right or bottom-left of the grid * @Default {ej.Grid.FormPosition.BottomLeft} */ formPosition?: ej.Grid.FormPosition|string; @@ -24213,9 +24259,9 @@ export interface EditSettings { /** This specifies the id of the template. This template can be used to display the data that you require to be edited using the Inline edit form * @Default {null} */ - inlineFormTemplateID?: String; + inlineFormTemplateID?: string; - /** This specifies to set the position of an adding new row either in the top or bottom of the grid. See rowPosition + /** This specifies to set the position of an adding new row either in the top or bottom of the grid * @Default {ej.Grid.RowPosition.Top} */ rowPosition?: ej.Grid.RowPosition|string; @@ -24223,22 +24269,22 @@ export interface EditSettings { /** Gets or sets a value that indicates whether the confirm dialog has to be shown while saving or discarding the batch changes * @Default {true} */ - showConfirmDialog?: Boolean; + showConfirmDialog?: boolean; /** Gets or sets a value that indicates whether the confirm dialog has to be shown while deleting record * @Default {false} */ - showDeleteConfirmDialog?: Boolean; + showDeleteConfirmDialog?: boolean; /** Gets or sets a value that indicates whether the title for edit form is different from the primarykey column. * @Default {null} */ - titleColumn?: String; + titleColumn?: string; /** Gets or sets a value that indicates whether to display the add new form by default in the grid. * @Default {false} */ - showAddNewRow?: Boolean; + showAddNewRow?: boolean; } export interface FilterSettingsFilteredColumn { @@ -24249,7 +24295,7 @@ export interface FilterSettingsFilteredColumn { /** Gets or sets a value that indicates whether to define the matchCase of given value to be filter. */ - matchCase?: Boolean; + matchCase?: boolean; /** Gets or sets a value that indicates whether to define the filter condition to filtered column. See operator */ @@ -24269,12 +24315,12 @@ export interface FilterSettings { /** Gets or sets a value that indicates to perform the filter operation with case sensitive in excel styled filter menu mode * @Default {false} */ - enableCaseSensitivity?: Boolean; + enableCaseSensitivity?: boolean; /** Gets or sets a value that indicates to define the interDeterminateState of checkbox in excel filter dialog. * @Default {true} */ - enableInterDeterminateState?: Boolean; + enableInterDeterminateState?: boolean; /** This specifies the grid to starts the filter action while typing in the filterBar or after pressing the enter key. based on the filterBarMode. See filterBarMode. * @Default {ej.Grid.FilterBarMode.Immediate} @@ -24284,7 +24330,7 @@ export interface FilterSettings { /** Gets or sets a value that indicates whether to define the filtered columns details programmatically at initial load * @Default {[]} */ - filteredColumns?: Array; + filteredColumns?: FilterSettingsFilteredColumn[]; /** This specifies the grid to show the filterBar or filterMenu to the grid records. See filterType * @Default {ej.Grid.FilterType.FilterBar} @@ -24294,22 +24340,22 @@ export interface FilterSettings { /** This specifies the grid to delay the filter action while typing in the filterBar. * @Default {1500} */ - immediateModeDelay?: Number; + immediateModeDelay?: number; /** Gets or sets a value that indicates the maximum number of filter choices that can be showed in the excel styled filter menu. * @Default {1000} */ - maxFilterChoices?: Number; + maxFilterChoices?: number; /** This specifies the grid to show the filter text within the grid pager itself. * @Default {true} */ - showFilterBarStatus?: Boolean; + showFilterBarMessage?: boolean; /** Gets or sets a value that indicates whether to enable the predicate options in the filtering menu * @Default {false} */ - showPredicate?: Boolean; + showPredicate?: boolean; } export interface GroupSettings { @@ -24317,37 +24363,38 @@ export interface GroupSettings { /** Gets or sets a value that customize the group caption format. * @Default {null} */ - captionFormat?: String; + captionFormat?: string; /** Gets or sets a value that indicates whether to enable animation button option in the group drop area of the grid. * @Default {false} */ - enableDropAreaAutoSizing?: Boolean; + enableDropAreaAutoSizing?: boolean; /** Gets or sets a value that indicates whether to add grouped columns programmatically at initial load * @Default {[]} */ - groupedColumns?: Array; + groupedColumns?: any[]; /** Gets or sets a value that indicates whether to show the group drop area just above the column header. It can be used to avoid ungrouping the already grouped column using groupSettings. * @Default {true} */ - showDropArea?: Boolean; + showDropArea?: boolean; /** Gets or sets a value that indicates whether to hide the grouped columns from the grid * @Default {false} */ - showGroupedColumn?: Boolean; + showGroupedColumn?: boolean; - /** Gets or sets a value that indicates whether to show the group button image(toggle button)in the column header and also in the grouped column in the group drop area . It can be used to group/ungroup the columns by click on the toggle button. + /** Gets or sets a value that indicates whether to show the group button image(toggle button)in the column header and also in the grouped column in the group drop area. + * It can be used to group/ungroup the columns by click on the toggle button. * @Default {false} */ - showToggleButton?: Boolean; + showToggleButton?: boolean; /** Gets or sets a value that indicates whether to enable the close button in the grouped column which is in the group drop area to ungroup the grouped column * @Default {false} */ - showUngroupButton?: Boolean; + showUngroupButton?: boolean; } export interface PageSettings { @@ -24355,49 +24402,49 @@ export interface PageSettings { /** Gets or sets a value that indicates whether to define which page to display currently in the grid * @Default {1} */ - currentPage?: Number; + currentPage?: number; /** Gets or sets a value that indicates whether to pass the current page information as a query string along with the URL while navigating to other page. * @Default {false} */ - enableQueryString?: Boolean; + enableQueryString?: boolean; /** Gets or sets a value that indicates whether to enables pager template for the grid. * @Default {false} */ - enableTemplates?: Boolean; + enableTemplates?: boolean; /** Gets or sets a value that indicates whether to define the number of pages displayed in the pager for navigation * @Default {8} */ - pageCount?: Number; + pageCount?: number; /** Gets or sets a value that indicates whether to define the number of records displayed per page * @Default {12} */ - pageSize?: Number; + pageSize?: number; /** Gets or sets a value that indicates whether to enables default pager for the grid. * @Default {false} */ - showDefaults?: Boolean; + showDefaults?: boolean; /** Gets or sets a value that indicates to add the template as a pager template for grid. * @Default {null} */ - template?: String; + template?: string; /** Get the value of total number of pages in the grid. The totalPages value is calculated based on page size and total records of grid * @Default {null} */ - totalPages?: Number; + totalPages?: number; /** Get the value of total number of records which is bound to the grid. The totalRecordsCount value is calculated based on dataSource bound to the grid. * @Default {null} */ - totalRecordsCount?: Number; + totalRecordsCount?: number; - /** Gets or sets a value that indicates whether to define the number of pages to print. See printMode. + /** Gets or sets a value that indicates whether to define the number of pages to print * @Default {ej.Grid.PrintMode.AllPages} */ printMode?: ej.Grid.PrintMode|string; @@ -24456,17 +24503,17 @@ export interface SelectionSettings { /** Gets or sets a value that indicates the cell selection actions based on the cell selection mode. * @Default {flow} */ - cellSelectionMode?: String; + cellSelectionMode?: string; /** Gets or sets a value that indicates whether to enable the toggle selection behavior for row, cell and column. * @Default {false} */ - enableToggle?: Boolean; + enableToggle?: boolean; /** Gets or sets a value that indicates whether to add the default selection actions as a selection mode.See selectionMode * @Default {[row]} */ - selectionMode?: Array; + selectionMode?: any[]; } export interface ScrollSettings { @@ -24474,42 +24521,42 @@ export interface ScrollSettings { /** This specify the grid to to view data that you require without buffering the entire load of a huge database * @Default {false} */ - allowVirtualScrolling?: Boolean; + allowVirtualScrolling?: boolean; /** It accepts the boolean value and shows or hides the scrollbar while focus in or focus out of the Grid. * @Default {false} */ - autoHide?: Boolean; + autoHide?: boolean; /** Specifies the height and width of button in the scrollbar. * @Default {18} */ - buttonSize?: Number; + buttonSize?: number; /** This specify the grid to enable/disable touch control for scrolling. * @Default {true} */ - enableTouchScroll?: Boolean; + enableTouchScroll?: boolean; /** This specify the grid to freeze particular columns at the time of scrolling. * @Default {0} */ - frozenColumns?: Number; + frozenColumns?: number; /** This specify the grid to freeze particular rows at the time of scrolling. * @Default {0} */ - frozenRows?: Number; + frozenRows?: number; /** This specify the grid to show the vertical scroll bar, to scroll and view the grid contents. * @Default {0} */ - height?: String|Number; + height?: string|number; /** It accepts the integer value and sets the width of scrollbar. * @Default {18} */ - scrollerSize?: Number; + scrollerSize?: number; /** This is used to define the mode of virtual scrolling in grid. See virtualScrollMode * @Default {ej.Grid.VirtualScrollMode.Normal} @@ -24519,35 +24566,35 @@ export interface ScrollSettings { /** This is used to enable the enhanced virtual scrolling in Grid. * @Default {false} */ - enableVirtualization?: Boolean; + enableVirtualization?: boolean; /** This specify the grid to show the horizontal scroll bar, to scroll and view the grid contents * @Default {250} */ - width?: String|Number; + width?: string|number; /** This specify the scroll down pixel of mouse wheel, to scroll mouse wheel and view the grid contents. * @Default {57} */ - scrollOneStepBy?: Number; + scrollOneStepBy?: number; } export interface SortSettingsSortedColumn { /** Gets or sets a value that indicates whether to define the direction to sort the column. */ - direction?: String; + direction?: string; /** Gets or sets a value that indicates whether to define the field name of the column to be sort */ - field?: String; + field?: string; } export interface SortSettings { /** Gets or sets a value that indicates whether to define the direction and field to sort the column. */ - sortedColumns?: Array; + sortedColumns?: SortSettingsSortedColumn[]; } export interface StackedHeaderRowsStackedHeaderColumn { @@ -24560,22 +24607,22 @@ export interface StackedHeaderRowsStackedHeaderColumn { /** Gets or sets a value that indicates class to the corresponding stackedHeaderColumn. * @Default {null} */ - cssClass?: String; + cssClass?: string; /** Gets or sets a value that indicates the header text for the particular stacked header column. * @Default {null} */ - headerText?: String; + headerText?: string; /** Gets or sets a value that indicates the text alignment of the corresponding headerText. * @Default {ej.TextAlign.Left} */ - textAlign?: String; + textAlign?: string; /** Sets the template for tooltip for the Grid stackedHeaderColumns. * @Default {null} */ - tooltip?: String; + tooltip?: string; } export interface StackedHeaderRow { @@ -24583,7 +24630,7 @@ export interface StackedHeaderRow { /** Gets or sets a value that indicates whether to add stacked header columns into the stacked header rows * @Default {[]} */ - stackedHeaderColumns?: Array; + stackedHeaderColumns?: StackedHeaderRowsStackedHeaderColumn[]; } export interface SummaryRowsSummaryColumn { @@ -24591,34 +24638,34 @@ export interface SummaryRowsSummaryColumn { /** Gets or sets a value that indicates the text displayed in the summary column as a value * @Default {null} */ - customSummaryValue?: String; + customSummaryValue?: string; /** This specifies summary column used to perform the summary calculation * @Default {null} */ - dataMember?: String; + dataMember?: string; /** Gets or sets a value that indicates to define the target column at which to display the summary. * @Default {null} */ - displayColumn?: String; + displayColumn?: string; /** Gets or sets a value that indicates the format for the text applied on the column * @Default {null} */ - format?: String; + format?: string; /** Gets or sets a value that indicates the text displayed before the summary column value * @Default {null} */ - prefix?: String; + prefix?: string; /** Gets or sets a value that indicates the text displayed after the summary column value * @Default {null} */ - suffix?: String; + suffix?: string; - /** Gets or sets a value that indicates the type of calculations to be performed for the corresponding summary column. See summaryType. + /** Gets or sets a value that indicates the type of calculations to be performed for the corresponding summary column * @Default {[]} */ summaryType?: ej.Grid.SummaryType|string; @@ -24626,7 +24673,7 @@ export interface SummaryRowsSummaryColumn { /** Gets or sets a value that indicates to add the template for the summary value of dataMember given. * @Default {null} */ - template?: String; + template?: string; } export interface SummaryRow { @@ -24634,31 +24681,31 @@ export interface SummaryRow { /** Gets or sets a value that indicates whether to show the summary value within the group caption area for the corresponding summary column while grouping the column * @Default {false} */ - showCaptionSummary?: Boolean; + showCaptionSummary?: boolean; /** Gets or sets a value that indicates whether to show the group summary value for the corresponding summary column while grouping a column * @Default {false} */ - showGroupSummary?: Boolean; + showGroupSummary?: boolean; /** Gets or sets a value that indicates whether to show the total summary value the for the corresponding summary column. The summary row is added after the grid content. * @Default {true} */ - showTotalSummary?: Boolean; + showTotalSummary?: boolean; /** Gets or sets a value that indicates whether to add summary columns into the summary rows. * @Default {[]} */ - summaryColumns?: Array; + summaryColumns?: SummaryRowsSummaryColumn[]; /** This specifies the grid to show the title for the summary rows. */ - title?: String; + title?: string; /** This specifies the grid to show the title of summary row in the specified column. * @Default {null} */ - titleColumn?: String; + titleColumn?: string; } export interface TextWrapSettings { @@ -24674,20 +24721,20 @@ export interface ToolbarSettings { /** Gets or sets a value that indicates whether to add custom toolbar items within the toolbar to perform any action in the grid * @Default {[]} */ - customToolbarItems?: Array; + customToolbarItems?: any[]; /** Gets or sets a value that indicates whether to enable toolbar in the grid. * @Default {false} */ - showToolbar?: Boolean; + showToolbar?: boolean; - /** Gets or sets a value that indicates whether to add the default editing actions as a toolbar items. See toolbarItems. + /** Gets or sets a value that indicates whether to add the default editing actions as a toolbar items * @Default {[]} */ toolbarItems?: Array; } -enum GridLines{ +enum GridLines { ///Displays both the horizontal and vertical grid lines. Both, @@ -24703,7 +24750,7 @@ enum GridLines{ } -enum ClipMode{ +enum ClipMode { ///Shows ellipsis for the overflown cell. Ellipsis, @@ -24716,7 +24763,7 @@ enum ClipMode{ } -enum ColumnLayout{ +enum ColumnLayout { ///Column layout is auto(based on width). Auto, @@ -24726,7 +24773,7 @@ enum ColumnLayout{ } -enum UnboundType{ +enum UnboundType { ///Unbound type is edit. Edit, @@ -24742,7 +24789,7 @@ enum UnboundType{ } -enum EditingType{ +enum EditingType { ///Specifies editing type as string edit. String, @@ -24764,7 +24811,7 @@ enum EditingType{ } -enum FilterType{ +enum FilterType { ///Specifies the filter type as menu. Menu, @@ -24774,7 +24821,7 @@ enum FilterType{ } -enum EditMode{ +enum EditMode { ///Edit mode is normal. Normal, @@ -24802,7 +24849,7 @@ enum EditMode{ } -enum FormPosition{ +enum FormPosition { ///Form position is bottomleft. BottomLeft, @@ -24812,7 +24859,7 @@ enum FormPosition{ } -enum RowPosition{ +enum RowPosition { ///Specifies position of add new row as top. Top, @@ -24822,7 +24869,7 @@ enum RowPosition{ } -enum FilterBarMode{ +enum FilterBarMode { ///Initiate filter operation on typing the filter query. Immediate, @@ -24832,7 +24879,7 @@ enum FilterBarMode{ } -enum PrintMode{ +enum PrintMode { ///Prints all pages. AllPages, @@ -24842,7 +24889,7 @@ enum PrintMode{ } -enum ResizeMode{ +enum ResizeMode { ///New column size will be adjusted by all other Columns Normal, @@ -24855,7 +24902,7 @@ enum ResizeMode{ } -enum SelectionType{ +enum SelectionType { ///Specifies the selection type as single. Single, @@ -24865,7 +24912,7 @@ enum SelectionType{ } -enum VirtualScrollMode{ +enum VirtualScrollMode { ///virtual scroll mode is normal. Normal, @@ -24875,7 +24922,7 @@ enum VirtualScrollMode{ } -enum SummaryType{ +enum SummaryType { ///Summary type is average. Average, @@ -24903,7 +24950,7 @@ enum SummaryType{ } -enum WrapMode{ +enum WrapMode { ///Auto wrap is applied for both content and header. Both, @@ -24916,7 +24963,7 @@ enum WrapMode{ } -enum ToolBarItems{ +enum ToolBarItems { ///Toolbar item is add. Add, @@ -24950,18 +24997,17 @@ enum ToolBarItems{ class Sparkline extends ej.Widget { static fn: Sparkline; - constructor(element: JQuery, options?: Sparkline.Model); - constructor(element: Element, options?: Sparkline.Model); + constructor(element: JQuery | Element, options?: Sparkline.Model); static Locale: any; - model:Sparkline.Model; - defaults:Sparkline.Model; + model: Sparkline.Model; + defaults: Sparkline.Model; /** Redraws the entire sparkline. You can call this method whenever you update, add or remove points from the data source or whenever you want to refresh the UI. * @returns {void} */ redraw(): void; } -export module Sparkline{ +export namespace Sparkline { export interface Model { @@ -25084,28 +25130,28 @@ export interface Model { axisLineSettings?: AxisLineSettings; /** Fires before loading the sparkline. */ - load? (e: LoadEventArgs): void; + load?(e: LoadEventArgs): void; /** Fires after loaded the sparkline. */ - loaded? (e: LoadedEventArgs): void; + loaded?(e: LoadedEventArgs): void; /** Fires before rendering trackball tooltip. You can use this event to customize the text displayed in trackball tooltip. */ - tooltipInitialize? (e: TooltipInitializeEventArgs): void; + tooltipInitialize?(e: TooltipInitializeEventArgs): void; /** Fires before rendering a series. This event is fired for each series in Sparkline. */ - seriesRendering? (e: SeriesRenderingEventArgs): void; + seriesRendering?(e: SeriesRenderingEventArgs): void; /** Fires when mouse is moved over a point. */ - pointRegionMouseMove? (e: PointRegionMouseMoveEventArgs): void; + pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; /** Fires on clicking a point in sparkline. You can use this event to handle clicks made on points. */ - pointRegionMouseClick? (e: PointRegionMouseClickEventArgs): void; + pointRegionMouseClick?(e: PointRegionMouseClickEventArgs): void; /** Fires on moving mouse over the sparkline. */ - sparklineMouseMove? (e: SparklineMouseMoveEventArgs): void; + sparklineMouseMove?(e: SparklineMouseMoveEventArgs): void; /** Fires on moving mouse outside the sparkline. */ - sparklineMouseLeave? (e: SparklineMouseLeaveEventArgs): void; + sparklineMouseLeave?(e: SparklineMouseLeaveEventArgs): void; } export interface LoadEventArgs { @@ -25140,7 +25186,7 @@ export interface LoadedEventArgs { export interface TooltipInitializeEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -25264,7 +25310,7 @@ export interface PointRegionMouseClickEventArgs { export interface SparklineMouseMoveEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -25279,7 +25325,7 @@ export interface SparklineMouseMoveEventArgs { export interface SparklineMouseLeaveEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -25480,10 +25526,8 @@ export interface AxisLineSettings { dashArray?: number; } } -module Sparkline -{ -enum Type -{ +namespace Sparkline { +enum Type { //string Area, //string @@ -25496,10 +25540,8 @@ Pie, WinLoss, } } -module Sparkline -{ -enum Theme -{ +namespace Sparkline { +enum Theme { //string Azure, //string @@ -25522,20 +25564,16 @@ GradientLight, GradientDark, } } -module Sparkline -{ -enum FontStyle -{ +namespace Sparkline { +enum FontStyle { //string Normal, //string Italic, } } -module Sparkline -{ -enum FontWeight -{ +namespace Sparkline { +enum FontWeight { //string Regular, //string @@ -25547,11 +25585,10 @@ Lighter, class SunburstChart extends ej.Widget { static fn: SunburstChart; - constructor(element: JQuery, options?: SunburstChart.Model); - constructor(element: Element, options?: SunburstChart.Model); + constructor(element: JQuery | Element, options?: SunburstChart.Model); static Locale: any; - model:SunburstChart.Model; - defaults:SunburstChart.Model; + model: SunburstChart.Model; + defaults: SunburstChart.Model; /** Redraws the entire sunburst. You can call this method whenever you update, add or remove points from the data source or whenever you want to refresh the UI. * @returns {void} @@ -25563,7 +25600,7 @@ class SunburstChart extends ej.Widget { */ _destroy(): void; } -export module SunburstChart{ +export namespace SunburstChart { export interface Model { @@ -25671,7 +25708,7 @@ export interface Model { /** Specify levels of sunburst for grouped visualization of data * @Default {[]} */ - levels?: Array; + levels?: Level[]; /** Options to customize the legend items and legend title. */ @@ -25706,40 +25743,40 @@ export interface Model { animationType?: ej.datavisualization.Sunburst.Animation|string; /** Fires before loading. */ - load? (e: LoadEventArgs): void; + load?(e: LoadEventArgs): void; /** Fires before rendering sunburst. */ - preRender? (e: PreRenderEventArgs): void; + preRender?(e: PreRenderEventArgs): void; /** Fires after rendering sunburst. */ - loaded? (e: LoadedEventArgs): void; + loaded?(e: LoadedEventArgs): void; /** Fires before rendering the datalabel */ - dataLabelRendering? (e: DataLabelRenderingEventArgs): void; + dataLabelRendering?(e: DataLabelRenderingEventArgs): void; /** Fires before rendering each segment */ - segmentRendering? (e: SegmentRenderingEventArgs): void; + segmentRendering?(e: SegmentRenderingEventArgs): void; /** Fires before rendering sunburst title. */ - titleRendering? (e: TitleRenderingEventArgs): void; + titleRendering?(e: TitleRenderingEventArgs): void; /** Fires during initialization of tooltip. */ - tooltipInitialize? (e: TooltipInitializeEventArgs): void; + tooltipInitialize?(e: TooltipInitializeEventArgs): void; /** Fires after clicking the point in sunburst */ - pointRegionClick? (e: PointRegionClickEventArgs): void; + pointRegionClick?(e: PointRegionClickEventArgs): void; /** Fires while moving the mouse over sunburst points */ - pointRegionMouseMove? (e: PointRegionMouseMoveEventArgs): void; + pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; /** Fires when clicking the point to perform drilldown. */ - drillDownClick? (e: DrillDownClickEventArgs): void; + drillDownClick?(e: DrillDownClickEventArgs): void; /** Fires when resetting drilldown points. */ - drillDownBack? (e: DrillDownBackEventArgs): void; + drillDownBack?(e: DrillDownBackEventArgs): void; /** Fires after resetting the sunburst points */ - drillDownReset? (e: DrillDownResetEventArgs): void; + drillDownReset?(e: DrillDownResetEventArgs): void; } export interface LoadEventArgs { @@ -26562,20 +26599,16 @@ export interface ZoomSettings { toolbarVerticalAlignment?: ej.datavisualization.Sunburst.SunburstVerticalAlignment|string; } } -module Sunburst -{ -enum FontStyle -{ +namespace Sunburst { +enum FontStyle { //string Normal, //string Italic, } } -module Sunburst -{ -enum FontWeight -{ +namespace Sunburst { +enum FontWeight { //string Regular, //string @@ -26584,20 +26617,16 @@ Bold, Lighter, } } -module Sunburst -{ -enum SunburstLabelRotationMode -{ +namespace Sunburst { +enum SunburstLabelRotationMode { //string Angle, //string Normal, } } -module Sunburst -{ -enum SunburstLabelOverflowMode -{ +namespace Sunburst { +enum SunburstLabelOverflowMode { //string Trim, //string @@ -26606,10 +26635,8 @@ Hide, None, } } -module Sunburst -{ -enum SunburstAlignment -{ +namespace Sunburst { +enum SunburstAlignment { //string Center, //string @@ -26618,10 +26645,8 @@ Near, Far, } } -module Sunburst -{ -enum SunburstHighlightMode -{ +namespace Sunburst { +enum SunburstHighlightMode { //string Point, //string @@ -26632,20 +26657,16 @@ Child, All, } } -module Sunburst -{ -enum SunburstHighlightType -{ +namespace Sunburst { +enum SunburstHighlightType { //string Opacity, //string Color, } } -module Sunburst -{ -enum SunburstClickAction -{ +namespace Sunburst { +enum SunburstClickAction { //string None, //string @@ -26654,10 +26675,8 @@ ToggleSegmentVisibility, ToggleSegmentSelection, } } -module Sunburst -{ -enum SunburstLegendPosition -{ +namespace Sunburst { +enum SunburstLegendPosition { //string Left, //string @@ -26668,10 +26687,8 @@ Top, Bottom, } } -module Sunburst -{ -enum SunburstLegendShape -{ +namespace Sunburst { +enum SunburstLegendShape { //string Diamond, //string @@ -26686,20 +26703,16 @@ Cross, Triangle, } } -module Sunburst -{ -enum SunburstTheme -{ +namespace Sunburst { +enum SunburstTheme { //string FlatLight, //string FlatDark, } } -module Sunburst -{ -enum SunburstHorizontalAlignment -{ +namespace Sunburst { +enum SunburstHorizontalAlignment { //string Center, //string @@ -26708,10 +26721,8 @@ Left, Right, } } -module Sunburst -{ -enum SunburstVerticalAlignment -{ +namespace Sunburst { +enum SunburstVerticalAlignment { //string Top, //string @@ -26720,10 +26731,8 @@ Bottom, Middle, } } -module Sunburst -{ -enum Animation -{ +namespace Sunburst { +enum Animation { //string Rotation, //string @@ -26733,11 +26742,10 @@ FadeIn, class PivotGrid extends ej.Widget { static fn: PivotGrid; - constructor(element: JQuery, options?: PivotGrid.Model); - constructor(element: Element, options?: PivotGrid.Model); + constructor(element: JQuery | Element, options?: PivotGrid.Model); static Locale: any; - model:PivotGrid.Model; - defaults:PivotGrid.Model; + model: PivotGrid.Model; + defaults: PivotGrid.Model; /** Performs an asynchronous HTTP (AJAX) request. * @returns {void} @@ -26807,7 +26815,7 @@ class PivotGrid extends ej.Widget { /** Returns the JSON records formed to render the control. * @returns {Array} */ - getJSONRecords(): Array; + getJSONRecords(): any[]; /** Sets the JSON records formed to render the control. * @returns {void} @@ -26824,7 +26832,7 @@ class PivotGrid extends ej.Widget { */ renderControlFromJSON(): void; } -export module PivotGrid{ +export namespace PivotGrid { export interface Model { @@ -26848,7 +26856,7 @@ export interface Model { */ dataSource?: DataSource; - /** Holds the necessary properties for value sorting. + /** Holds the neccessary properties for value sorting. * @Default {{}} */ valueSortSettings?: ValueSortSettings; @@ -27013,64 +27021,64 @@ export interface Model { url?: string; /** Triggers when it reaches client-side after any AJAX request. */ - afterServiceInvoke? (e: AfterServiceInvokeEventArgs): void; + afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; /** Triggers before any AJAX request is passed from PivotGrid to service methods. */ - beforeServiceInvoke? (e: BeforeServiceInvokeEventArgs): void; + beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; /** Triggers before Pivot Engine starts to populate. */ - beforePivotEnginePopulate? (e: BeforePivotEnginePopulateEventArgs): void; + beforePivotEnginePopulate?(e: BeforePivotEnginePopulateEventArgs): void; /** Triggers when double click action is performed over a cell. */ - cellDoubleClick? (e: CellDoubleClickEventArgs): void; + cellDoubleClick?(e: CellDoubleClickEventArgs): void; /** Triggers when right-click action is performed on a cell. */ - cellContext? (e: CellContextEventArgs): void; + cellContext?(e: CellContextEventArgs): void; /** Triggers when a specific range of value cells are selected. */ - cellSelection? (e: CellSelectionEventArgs): void; + cellSelection?(e: CellSelectionEventArgs): void; /** Triggers when the hyperlink of column header is clicked. */ - columnHeaderHyperlinkClick? (e: ColumnHeaderHyperlinkClickEventArgs): void; + columnHeaderHyperlinkClick?(e: ColumnHeaderHyperlinkClickEventArgs): void; /** Triggers after performing drill operation in PivotGrid. */ - drillSuccess? (e: DrillSuccessEventArgs): void; + drillSuccess?(e: DrillSuccessEventArgs): void; /** Triggers while clicking "OK" button in the drill-through dialog. */ - drillThrough? (e: DrillThroughEventArgs): void; + drillThrough?(e: DrillThroughEventArgs): void; /** Triggers when PivotGrid loading is initiated. */ - load? (e: LoadEventArgs): void; + load?(e: LoadEventArgs): void; /** Triggers when PivotGrid widget completes all operations at client-side after any AJAX request. */ - renderComplete? (e: RenderCompleteEventArgs): void; + renderComplete?(e: RenderCompleteEventArgs): void; /** Triggers when any error occurred during AJAX request. */ - renderFailure? (e: RenderFailureEventArgs): void; + renderFailure?(e: RenderFailureEventArgs): void; /** Triggers when PivotGrid successfully reaches client-side after any AJAX request. */ - renderSuccess? (e: RenderSuccessEventArgs): void; + renderSuccess?(e: RenderSuccessEventArgs): void; /** Triggers when the hyperlink of row header is clicked. */ - rowHeaderHyperlinkClick? (e: RowHeaderHyperlinkClickEventArgs): void; + rowHeaderHyperlinkClick?(e: RowHeaderHyperlinkClickEventArgs): void; /** Triggers when the hyperlink of summary cell is clicked. */ - summaryCellHyperlinkClick? (e: SummaryCellHyperlinkClickEventArgs): void; + summaryCellHyperlinkClick?(e: SummaryCellHyperlinkClickEventArgs): void; /** Triggers when the hyperlink of value cell is clicked. */ - valueCellHyperlinkClick? (e: ValueCellHyperlinkClickEventArgs): void; + valueCellHyperlinkClick?(e: ValueCellHyperlinkClickEventArgs): void; /** Triggers before saving the current report to database. */ - saveReport? (e: SaveReportEventArgs): void; + saveReport?(e: SaveReportEventArgs): void; /** Triggers before loading a report from database. */ - loadReport? (e: LoadReportEventArgs): void; + loadReport?(e: LoadReportEventArgs): void; /** Triggers before performing exporting in pivot grid. */ - beforeExport? (e: BeforeExportEventArgs): void; + beforeExport?(e: BeforeExportEventArgs): void; /** Triggers before editing the cells. */ - cellEdit? (e: CellEditEventArgs): void; + cellEdit?(e: CellEditEventArgs): void; } export interface AfterServiceInvokeEventArgs { @@ -27114,7 +27122,7 @@ export interface CellDoubleClickEventArgs { /** returns the JSON details of the double clicked cell. */ - selectedData?: Array; + selectedData?: any[]; /** returns the custom object bound with PivotGrid control. */ @@ -27346,7 +27354,7 @@ export interface CellEditEventArgs { /** contains the array of cells selected for editing. */ - editCellsInfo?: Array; + editCellsInfo?: any[]; } export interface DataSourceColumnsAdvancedFilter { @@ -27375,7 +27383,7 @@ export interface DataSourceColumnsAdvancedFilter { /** Allows the user to hold the filter operand values in advanced filtering. */ - values?: Array; + values?: any[]; } export interface DataSourceColumnsFilterItems { @@ -27388,7 +27396,7 @@ export interface DataSourceColumnsFilterItems { /** Contains the collection of items to be included/excluded among the field members. * @Default {[]} */ - values?: Array; + values?: any[]; } export interface DataSourceColumn { @@ -27404,7 +27412,7 @@ export interface DataSourceColumn { /** Allows the user to filter the report by default using advanced filtering (excel-like) option for OLAP data source in client-mode. * @Default {[]} */ - advancedFilter?: Array; + advancedFilter?: DataSourceColumnsAdvancedFilter[]; /** Allows the user to indicate whether the added item is a named set or not. * @Default {false} @@ -27424,7 +27432,7 @@ export interface DataSourceColumn { /** Contains the list of members need to be drilled down by default in the field. * @Default {[]} */ - drilledItems?: Array; + drilledItems?: any[]; /** Applies filter to the field members. * @Default {null} @@ -27458,7 +27466,7 @@ export interface DataSourceRowsAdvancedFilter { /** Allows the user to hold the filter operand values in advanced filtering. */ - values?: Array; + values?: any[]; } export interface DataSourceRowsFilterItems { @@ -27471,7 +27479,7 @@ export interface DataSourceRowsFilterItems { /** Contains the collection of items to be included/excluded among the field members. * @Default {[]} */ - values?: Array; + values?: any[]; } export interface DataSourceRow { @@ -27487,7 +27495,7 @@ export interface DataSourceRow { /** Allows the user to filter the report by default using advanced filtering (excel-like) option for OLAP data source in client-mode. * @Default {[]} */ - advancedFilter?: Array; + advancedFilter?: DataSourceRowsAdvancedFilter[]; /** Allows the user to indicate whether the added item is a named set or not. * @Default {false} @@ -27507,7 +27515,7 @@ export interface DataSourceRow { /** Contains the list of members need to be drilled down by default in the field. * @Default {[]} */ - drilledItems?: Array; + drilledItems?: any[]; /** Applies filter to the field members. * @Default {null} @@ -27535,7 +27543,7 @@ export interface DataSourceValue { /** This holds the list of unique names of measures to bind them from the OLAP cube. * @Default {[]} */ - measures?: Array; + measures?: DataSourceValuesMeasure[]; /** Allows to set the axis name to place the measures items. * @Default {rows} @@ -27575,7 +27583,7 @@ export interface DataSourceFiltersFilterItems { /** Contains the collection of items to be included/excluded among the field members. * @Default {[]} */ - values?: Array; + values?: any[]; } export interface DataSourceFilter { @@ -27622,22 +27630,22 @@ export interface DataSource { /** Lists out the items to be arranged in columns section of PivotGrid. * @Default {[]} */ - columns?: Array; + columns?: DataSourceColumn[]; /** Lists out the items to be arranged in rows section of PivotGrid. * @Default {[]} */ - rows?: Array; + rows?: DataSourceRow[]; /** Lists out the items which supports calculation in PivotGrid. * @Default {[]} */ - values?: Array; + values?: DataSourceValue[]; /** Lists out the items which supports filtering of values without displaying the members in UI in PivotGrid. * @Default {[]} */ - filters?: Array; + filters?: DataSourceFilter[]; /** Contains the respective cube name from OLAP database as string type. * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} @@ -27819,7 +27827,7 @@ export interface ServiceMethodSettings { writeBack?: string; } -enum Layout{ +enum Layout { ///To set normal summary layout in PivotGrid. Normal, @@ -27835,20 +27843,16 @@ enum Layout{ } } -module Pivot -{ -enum AnalysisMode -{ +namespace Pivot { +enum AnalysisMode { //To bind an OLAP data source to PivotGrid. OLAP, //To bind a relational data source to PivotGrid. Pivot, } } -module PivotAnalysis -{ -enum SortOrder -{ +namespace PivotAnalysis { +enum SortOrder { //Sorts the members of the field in ascending order. Ascending, //Sorts the members of the field in descending order. @@ -27857,20 +27861,16 @@ Descending, None, } } -module PivotAnalysis -{ -enum FilterType -{ +namespace PivotAnalysis { +enum FilterType { //Excludes the specified values among the members of the field. Exclude, //Includes the specified values alone among the members of the field. Include, } } -module PivotAnalysis -{ -enum SummaryType -{ +namespace PivotAnalysis { +enum SummaryType { //Calculates the summary as the total of all values. Sum, //Displays the average of all values as the summaries. @@ -27883,10 +27883,8 @@ Min, Max, } } -module Pivot -{ -enum OperationalMode -{ +namespace Pivot { +enum OperationalMode { //To bind data source completely from client-side. ClientMode, //To bind data source completely from server-side. @@ -27896,11 +27894,10 @@ ServerMode, class PivotSchemaDesigner extends ej.Widget { static fn: PivotSchemaDesigner; - constructor(element: JQuery, options?: PivotSchemaDesigner.Model); - constructor(element: Element, options?: PivotSchemaDesigner.Model); + constructor(element: JQuery | Element, options?: PivotSchemaDesigner.Model); static Locale: any; - model:PivotSchemaDesigner.Model; - defaults:PivotSchemaDesigner.Model; + model: PivotSchemaDesigner.Model; + defaults: PivotSchemaDesigner.Model; /** Performs an asynchronous HTTP (AJAX) request. * @returns {void} @@ -27912,7 +27909,7 @@ class PivotSchemaDesigner extends ej.Widget { */ refreshControl(): void; } -export module PivotSchemaDesigner{ +export namespace PivotSchemaDesigner { export interface Model { @@ -27926,7 +27923,8 @@ export interface Model { */ customObject?: any; - /** For ASP.NET and MVC Wrapper, PivotSchemaDesigner will be initialized and rendered empty initially. Once the connected pivot control widget is rendered completely, PivotSchemaDesigner will just be populated with data source by setting this property to Ă¢â‚¬Å“trueĂ¢â‚¬Â. + /** For ASP.NET and MVC Wrapper, PivotSchemaDesigner will be initialized and rendered empty initially. Once the connected pivot control widget is rendered completely, + * PivotSchemaDesigner will just be populated with data source by setting this property to Ă¢â‚¬Å“trueĂ¢â‚¬Â. * @Default {false} */ enableWrapper?: boolean; @@ -27982,13 +27980,13 @@ export interface Model { layout?: ej.PivotSchemaDesigner.Layouts|string; /** Triggers when it reaches client-side after any AJAX request. */ - afterServiceInvoke? (e: AfterServiceInvokeEventArgs): void; + afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; /** Triggers before any AJAX request is passed from PivotSchemaDesigner to service methods. */ - beforeServiceInvoke? (e: BeforeServiceInvokeEventArgs): void; + beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; /** Triggers when we start dragging any field from PivotSchemaDesigner. */ - dragMove? (e: DragMoveEventArgs): void; + dragMove?(e: DragMoveEventArgs): void; } export interface AfterServiceInvokeEventArgs { @@ -28086,7 +28084,7 @@ export interface ServiceMethod { removeButton?: string; } -enum Layouts{ +enum Layouts { ///To set the layout as same in the Excel. Excel, @@ -28102,18 +28100,17 @@ enum Layouts{ class PivotPager extends ej.Widget { static fn: PivotPager; - constructor(element: JQuery, options?: PivotPager.Model); - constructor(element: Element, options?: PivotPager.Model); + constructor(element: JQuery | Element, options?: PivotPager.Model); static Locale: any; - model:PivotPager.Model; - defaults:PivotPager.Model; + model: PivotPager.Model; + defaults: PivotPager.Model; /** This function initializes the page counts and page numbers for the PivotPager. * @returns {void} */ initPagerProperties(): void; } -export module PivotPager{ +export namespace PivotPager { export interface Model { @@ -28153,7 +28150,7 @@ export interface Model { targetControlID?: string; } -enum Mode{ +enum Mode { ///To set both categorical and series pager for paging. Both, @@ -28169,11 +28166,10 @@ enum Mode{ class PivotChart extends ej.Widget { static fn: PivotChart; - constructor(element: JQuery, options?: PivotChart.Model); - constructor(element: Element, options?: PivotChart.Model); + constructor(element: JQuery | Element, options?: PivotChart.Model); static Locale: any; - model:PivotChart.Model; - defaults:PivotChart.Model; + model: PivotChart.Model; + defaults: PivotChart.Model; /** Performs an asynchronous HTTP (AJAX) request. * @returns {void} @@ -28213,7 +28209,7 @@ class PivotChart extends ej.Widget { /** Returns the JSON records formed to render the control. * @returns {Array} */ - getJSONRecords(): Array; + getJSONRecords(): any[]; /** Sets the JSON records to render the control. * @returns {void} @@ -28223,7 +28219,7 @@ class PivotChart extends ej.Widget { /** Returns the PivotEngine formed to render the control. * @returns {Array} */ - getPivotEngine(): Array; + getPivotEngine(): any[]; /** Sets the PivotEngine required to render the control. * @returns {void} @@ -28245,7 +28241,7 @@ class PivotChart extends ej.Widget { */ refreshPagedPivotChart(): void; } -export module PivotChart{ +export namespace PivotChart { export interface Model { @@ -28309,12 +28305,16 @@ export interface Model { */ operationalMode?: ej.Pivot.OperationalMode|string; - /** This is a horizontal axis that contains options to configure axis and it is the primary x axis for all the series in series array. To override x axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. Then, assign the name to the seriesĂ¢â‚¬â„¢s xAxisName property to link both axis and series. + /** This is a horizontal axis that contains options to configure axis and it is the primary x axis for all the series in series array. + * To override x axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. + * Then, assign the name to the seriesĂ¢â‚¬â„¢s xAxisName property to link both axis and series. * @Default {{}} */ primaryXAxis?: any; - /** This is a vertical axis that contains options to configure axis. This is the primary y axis for all the series in series array. To override y axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. Then, assign the name to the seriesĂ¢â‚¬â„¢s yAxisName property to link both axis and series. + /** This is a vertical axis that contains options to configure axis. This is the primary y axis for all the series in series array. + * To override y axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. + * Then, assign the name to the seriesĂ¢â‚¬â„¢s yAxisName property to link both axis and series. * @Default {{}} */ primaryYAxis?: any; @@ -28340,28 +28340,28 @@ export interface Model { url?: string; /** Triggers when PivotChart starts to render. */ - load? (e: LoadEventArgs): void; + load?(e: LoadEventArgs): void; /** Triggers when it reaches client-side after any AJAX request. */ - afterServiceInvoke? (e: AfterServiceInvokeEventArgs): void; + afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; /** Triggers before any AJAX request is passed from PivotChart to service methods. */ - beforeServiceInvoke? (e: BeforeServiceInvokeEventArgs): void; + beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; /** Triggers on performing drill up/down in PivotChart control. */ - drillSuccess? (e: DrillSuccessEventArgs): void; + drillSuccess?(e: DrillSuccessEventArgs): void; /** Triggers when PivotChart widget completes all operations at client-side after any AJAX request. */ - renderComplete? (e: RenderCompleteEventArgs): void; + renderComplete?(e: RenderCompleteEventArgs): void; /** Triggers when any error occurred during AJAX request. */ - renderFailure? (e: RenderFailureEventArgs): void; + renderFailure?(e: RenderFailureEventArgs): void; /** Triggers when PivotChart successfully reaches client-side after any AJAX request. */ - renderSuccess? (e: RenderSuccessEventArgs): void; + renderSuccess?(e: RenderSuccessEventArgs): void; /** Triggers before performing exporting in pivot chart. */ - beforeExport? (e: BeforeExportEventArgs): void; + beforeExport?(e: BeforeExportEventArgs): void; } export interface LoadEventArgs { @@ -28506,7 +28506,7 @@ export interface DataSourceColumnsFilterItems { /** Contains the collection of items to be included/excluded among the field members. * @Default {[]} */ - values?: Array; + values?: any[]; } export interface DataSourceColumn { @@ -28545,7 +28545,7 @@ export interface DataSourceRowsFilterItems { /** Contains the collection of items to be included/excluded among the field members. * @Default {[]} */ - values?: Array; + values?: any[]; } export interface DataSourceRow { @@ -28594,7 +28594,7 @@ export interface DataSourceValue { /** This holds the list of unique names of measures to bind them from the OLAP cube. * @Default {[]} */ - measures?: Array; + measures?: DataSourceValuesMeasure[]; /** Allows to set the axis name to place the measures items. * @Default {rows} @@ -28621,7 +28621,7 @@ export interface DataSourceFiltersFilterItems { /** Contains the collection of items to be included/excluded among the field members. * @Default {[]} */ - values?: Array; + values?: any[]; } export interface DataSourceFilter { @@ -28656,22 +28656,22 @@ export interface DataSource { /** Lists out the items to be displayed as series of PivotChart. * @Default {[]} */ - columns?: Array; + columns?: DataSourceColumn[]; /** Lists out the items to be displayed as segments of PivotChart. * @Default {[]} */ - rows?: Array; + rows?: DataSourceRow[]; /** Lists out the items supports calculation in PivotChart. * @Default {[]} */ - values?: Array; + values?: DataSourceValue[]; /** Lists out the items which supports filtering of values without displaying the members in UI in PivotChart. * @Default {[]} */ - filters?: Array; + filters?: DataSourceFilter[]; } export interface ServiceMethodSettings { @@ -28697,7 +28697,7 @@ export interface ServiceMethodSettings { paging?: string; } -enum ChartTypes{ +enum ChartTypes { ///To render a Line type PivotChart. Line, @@ -28755,11 +28755,10 @@ enum ChartTypes{ class PivotClient extends ej.Widget { static fn: PivotClient; - constructor(element: JQuery, options?: PivotClient.Model); - constructor(element: Element, options?: PivotClient.Model); + constructor(element: JQuery | Element, options?: PivotClient.Model); static Locale: any; - model:PivotClient.Model; - defaults:PivotClient.Model; + model: PivotClient.Model; + defaults: PivotClient.Model; /** Performs an asynchronous HTTP (AJAX) request. * @returns {void} @@ -28804,14 +28803,14 @@ class PivotClient extends ej.Widget { /** Returns the JSON records formed to render the control. * @returns {Array} */ - getJSONRecords(): Array; + getJSONRecords(): any[]; /** Sets the JSON records formed to render the control to a property. * @returns {void} */ setJSONRecords(): void; } -export module PivotClient{ +export namespace PivotClient { export interface Model { @@ -28939,40 +28938,40 @@ export interface Model { url?: string; /** Triggers when it reaches client-side after any AJAX request. */ - afterServiceInvoke? (e: AfterServiceInvokeEventArgs): void; + afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; /** Triggers before any AJAX request is passed from client-side to service methods. */ - beforeServiceInvoke? (e: BeforeServiceInvokeEventArgs): void; + beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; /** Triggers before saving the current collection of reports. */ - saveReport? (e: SaveReportEventArgs): void; + saveReport?(e: SaveReportEventArgs): void; /** Triggers before loading a saved collection of reports. */ - loadReport? (e: LoadReportEventArgs): void; + loadReport?(e: LoadReportEventArgs): void; /** Triggers before fetching the report collection from storage. */ - fetchReport? (e: FetchReportEventArgs): void; + fetchReport?(e: FetchReportEventArgs): void; /** Triggers before exporting the control. */ - beforeExport? (e: BeforeExportEventArgs): void; + beforeExport?(e: BeforeExportEventArgs): void; /** Triggers before rendering the PivotChart. */ - chartLoad? (e: ChartLoadEventArgs): void; + chartLoad?(e: ChartLoadEventArgs): void; /** Triggers before rendering the PivotTreeMap. */ - treeMapLoad? (e: TreeMapLoadEventArgs): void; + treeMapLoad?(e: TreeMapLoadEventArgs): void; /** Triggers while we initiate loading of the widget. */ - load? (e: LoadEventArgs): void; + load?(e: LoadEventArgs): void; /** Triggers when PivotClient widget completes all operations at client-end after any AJAX request. */ - renderComplete? (e: RenderCompleteEventArgs): void; + renderComplete?(e: RenderCompleteEventArgs): void; /** Triggers when any error occurred during AJAX request. */ - renderFailure? (e: RenderFailureEventArgs): void; + renderFailure?(e: RenderFailureEventArgs): void; /** Triggers when PivotClient successfully completes rendering. */ - renderSuccess? (e: RenderSuccessEventArgs): void; + renderSuccess?(e: RenderSuccessEventArgs): void; } export interface AfterServiceInvokeEventArgs { @@ -29149,7 +29148,7 @@ export interface DataSourceColumnsAdvancedFilter { /** Allows the user to hold the filter operand values in advanced filtering. */ - values?: Array; + values?: any[]; } export interface DataSourceColumnsFilterItems { @@ -29162,7 +29161,7 @@ export interface DataSourceColumnsFilterItems { /** Contains the collection of items to be included/excluded among the field members. * @Default {[]} */ - values?: Array; + values?: any[]; } export interface DataSourceColumn { @@ -29178,7 +29177,7 @@ export interface DataSourceColumn { /** Allows the user to filter the report by default using advanced filtering (excel-like) option for OLAP data source in client-mode. * @Default {[]} */ - advancedFilter?: Array; + advancedFilter?: DataSourceColumnsAdvancedFilter[]; /** Allows the user to indicate whether the added item is a named set or not. * @Default {false} @@ -29198,7 +29197,7 @@ export interface DataSourceColumn { /** Contains the list of members need to be drilled down by default in the field. * @Default {[]} */ - drilledItems?: Array; + drilledItems?: any[]; /** Applies filter to the field members. * @Default {null} @@ -29232,7 +29231,7 @@ export interface DataSourceRowsAdvancedFilter { /** Allows the user to hold the filter operand values in advanced filtering. */ - values?: Array; + values?: any[]; } export interface DataSourceRowsFilterItems { @@ -29245,7 +29244,7 @@ export interface DataSourceRowsFilterItems { /** Contains the collection of items to be included/excluded among the field members. * @Default {[]} */ - values?: Array; + values?: any[]; } export interface DataSourceRow { @@ -29261,7 +29260,7 @@ export interface DataSourceRow { /** Allows the user to filter the report by default using advanced filtering (excel-like) option for OLAP data source in client-mode. * @Default {[]} */ - advancedFilter?: Array; + advancedFilter?: DataSourceRowsAdvancedFilter[]; /** Allows the user to indicate whether the added item is a named set or not. * @Default {false} @@ -29281,7 +29280,7 @@ export interface DataSourceRow { /** Contains the list of members need to be drilled down by default in the field. * @Default {[]} */ - drilledItems?: Array; + drilledItems?: any[]; /** Applies filter to the field members. * @Default {null} @@ -29309,7 +29308,7 @@ export interface DataSourceValue { /** This holds the list of unique names of measures to bind them from the OLAP cube. * @Default {[]} */ - measures?: Array; + measures?: DataSourceValuesMeasure[]; /** Allows to set the axis name to place the measures items. * @Default {rows} @@ -29349,7 +29348,7 @@ export interface DataSourceFiltersFilterItems { /** Contains the collection of items to be included/excluded among the field members. * @Default {[]} */ - values?: Array; + values?: any[]; } export interface DataSourceFilter { @@ -29396,22 +29395,22 @@ export interface DataSource { /** Lists out the items to be arranged in columns section of PivotClient. * @Default {[]} */ - columns?: Array; + columns?: DataSourceColumn[]; /** Lists out the items to be arranged in rows section of PivotClient. * @Default {[]} */ - rows?: Array; + rows?: DataSourceRow[]; /** Lists out the items which supports calculation in PivotClient. * @Default {[]} */ - values?: Array; + values?: DataSourceValue[]; /** Lists out the items which supports filtering of values without displaying the members in UI in PivotClient. * @Default {[]} */ - filters?: Array; + filters?: DataSourceFilter[]; /** Contains the respective cube name from OLAP database as string type. * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} @@ -29559,7 +29558,7 @@ export interface ServiceMethodSettings { paging?: string; } -enum ClientExportMode{ +enum ClientExportMode { ///Exports both the PivotChart and PivotGrid on exporting. ChartAndGrid, @@ -29572,7 +29571,7 @@ enum ClientExportMode{ } -enum ControlPlacement{ +enum ControlPlacement { ///Displays PivotChart and PivotGrid widgets in separate tabs. Tab, @@ -29582,7 +29581,7 @@ enum ControlPlacement{ } -enum DefaultView{ +enum DefaultView { ///To set PivotChart as a default control in view. Chart, @@ -29592,7 +29591,7 @@ enum DefaultView{ } -enum DisplayMode{ +enum DisplayMode { ///To display only PivotChart widget. ChartOnly, @@ -29608,11 +29607,10 @@ enum DisplayMode{ class PivotGauge extends ej.Widget { static fn: PivotGauge; - constructor(element: JQuery, options?: PivotGauge.Model); - constructor(element: Element, options?: PivotGauge.Model); + constructor(element: JQuery | Element, options?: PivotGauge.Model); static Locale: any; - model:PivotGauge.Model; - defaults:PivotGauge.Model; + model: PivotGauge.Model; + defaults: PivotGauge.Model; /** Performs an asynchronous HTTP (AJAX) request. * @returns {void} @@ -29647,7 +29645,7 @@ class PivotGauge extends ej.Widget { /** Returns the JSON records formed to render the control. * @returns {Array} */ - getJSONRecords(): Array; + getJSONRecords(): any[]; /** Sets the JSON records to render the control. * @returns {void} @@ -29659,7 +29657,7 @@ class PivotGauge extends ej.Widget { */ getJSONData(): void; } -export module PivotGauge{ +export namespace PivotGauge { export interface Model { @@ -29749,25 +29747,25 @@ export interface Model { operationalMode?: ej.Pivot.OperationalMode|string; /** Triggers when it reaches client-side after any AJAX request. */ - afterServiceInvoke? (e: AfterServiceInvokeEventArgs): void; + afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; /** Triggers before any AJAX request is passed from PivotGauge to service methods. */ - beforeServiceInvoke? (e: BeforeServiceInvokeEventArgs): void; + beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; /** Triggers before populating the pivot engine on operating in client mode. */ - beforePivotEnginePopulate? (e: BeforePivotEnginePopulateEventArgs): void; + beforePivotEnginePopulate?(e: BeforePivotEnginePopulateEventArgs): void; /** Triggers when PivotGauge started loading at client-side. */ - load? (e: LoadEventArgs): void; + load?(e: LoadEventArgs): void; /** Triggers when PivotGauge widget completes all operations at client-side after any AJAX request. */ - renderComplete? (e: RenderCompleteEventArgs): void; + renderComplete?(e: RenderCompleteEventArgs): void; /** Triggers when any error occurred during AJAX request. */ - renderFailure? (e: RenderFailureEventArgs): void; + renderFailure?(e: RenderFailureEventArgs): void; /** Triggers when PivotGauge successfully reaches client-side after any AJAX request. */ - renderSuccess? (e: RenderSuccessEventArgs): void; + renderSuccess?(e: RenderSuccessEventArgs): void; } export interface AfterServiceInvokeEventArgs { @@ -29865,7 +29863,7 @@ export interface DataSourceColumnsFilterItems { /** Contains the collection of items to be included/excluded among the field members. * @Default {[]} */ - values?: Array; + values?: any[]; } export interface DataSourceColumn { @@ -29890,7 +29888,7 @@ export interface DataSourceRowsFilterItems { /** Contains the collection of items to be included/excluded among the field members. * @Default {[]} */ - values?: Array; + values?: any[]; } export interface DataSourceRow { @@ -29925,7 +29923,7 @@ export interface DataSourceValue { /** This holds the list of unique names of measures to bind them from the OLAP cube. * @Default {[]} */ - measures?: Array; + measures?: DataSourceValuesMeasure[]; /** Allows to set the axis name to place the measures items. * @Default {rows} @@ -29952,7 +29950,7 @@ export interface DataSourceFiltersFilterItems { /** Contains the collection of items to be included/excluded among the field members. * @Default {[]} */ - values?: Array; + values?: any[]; } export interface DataSourceFilter { @@ -29987,22 +29985,22 @@ export interface DataSource { /** Lists out the items to bind in columns section. * @Default {[]} */ - columns?: Array; + columns?: DataSourceColumn[]; /** Lists out the items to bind in rows section. * @Default {[]} */ - rows?: Array; + rows?: DataSourceRow[]; /** Lists out the items supports calculation in PivotGauge. * @Default {[]} */ - values?: Array; + values?: DataSourceValue[]; /** Lists out the items which supports filtering of values without displaying the members in UI in PivotGauge. * @Default {[]} */ - filters?: Array; + filters?: DataSourceFilter[]; } export interface LabelFormatSettings { @@ -30034,7 +30032,7 @@ export interface ServiceMethodSettings { initialize?: string; } -enum NumberFormat{ +enum NumberFormat { ///To set default format for label values. Default, @@ -30062,11 +30060,10 @@ enum NumberFormat{ class PivotTreeMap extends ej.Widget { static fn: PivotTreeMap; - constructor(element: JQuery, options?: PivotTreeMap.Model); - constructor(element: Element, options?: PivotTreeMap.Model); + constructor(element: JQuery | Element, options?: PivotTreeMap.Model); static Locale: any; - model:PivotTreeMap.Model; - defaults:PivotTreeMap.Model; + model: PivotTreeMap.Model; + defaults: PivotTreeMap.Model; /** Performs an asynchronous HTTP (AJAX) request. * @returns {void} @@ -30086,7 +30083,7 @@ class PivotTreeMap extends ej.Widget { /** Returns the JSON records formed to render the control. * @returns {Array} */ - getJSONRecords(): Array; + getJSONRecords(): any[]; /** Sets the JSON records to render the control. * @returns {void} @@ -30108,7 +30105,7 @@ class PivotTreeMap extends ej.Widget { */ renderControlSuccess(): void; } -export module PivotTreeMap{ +export namespace PivotTreeMap { export interface Model { @@ -30153,28 +30150,28 @@ export interface Model { url?: string; /** Triggers when it reaches client-side after any AJAX request. */ - afterServiceInvoke? (e: AfterServiceInvokeEventArgs): void; + afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; /** Triggers before any AJAX request is passed from PivotTreeMap to service methods. */ - beforeServiceInvoke? (e: BeforeServiceInvokeEventArgs): void; + beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; /** Triggers when PivotTreeMap starts to render. */ - load? (e: LoadEventArgs): void; + load?(e: LoadEventArgs): void; /** Triggers before populating the pivot engine from datasource. */ - beforePivotEnginePopulate? (e: BeforePivotEnginePopulateEventArgs): void; + beforePivotEnginePopulate?(e: BeforePivotEnginePopulateEventArgs): void; /** Triggers when drill up/down happens in PivotTreeMap control. And it returns the outer HTML of PivotTreeMap control. */ - drillSuccess? (e: DrillSuccessEventArgs): void; + drillSuccess?(e: DrillSuccessEventArgs): void; /** Triggers when PivotTreeMap widget completes all operations at client-side after any AJAX request. */ - renderComplete? (e: RenderCompleteEventArgs): void; + renderComplete?(e: RenderCompleteEventArgs): void; /** Triggers when any error occurred during AJAX request. */ - renderFailure? (e: RenderFailureEventArgs): void; + renderFailure?(e: RenderFailureEventArgs): void; /** Triggers when PivotTreeMap successfully reaches client-side after any AJAX request. */ - renderSuccess? (e: RenderSuccessEventArgs): void; + renderSuccess?(e: RenderSuccessEventArgs): void; } export interface AfterServiceInvokeEventArgs { @@ -30290,7 +30287,7 @@ export interface DataSourceColumnsFilterItems { /** Contains the collection of items to be excluded among the field members. * @Default {[]} */ - values?: Array; + values?: any[]; } export interface DataSourceColumn { @@ -30315,7 +30312,7 @@ export interface DataSourceRowsFilterItems { /** Contains the collection of items to be excluded among the field members. * @Default {[]} */ - values?: Array; + values?: any[]; } export interface DataSourceRow { @@ -30347,7 +30344,7 @@ export interface DataSourceValue { /** This holds the list of unique names of measures to bind them from the OLAP cube. * @Default {[]} */ - measures?: Array; + measures?: DataSourceValuesMeasure[]; /** Allows to set the axis name to place the measures items. * @Default {rows} @@ -30360,7 +30357,7 @@ export interface DataSourceFiltersFilterItems { /** Contains the collection of items to be excluded among the field members. * @Default {[]} */ - values?: Array; + values?: any[]; } export interface DataSourceFilter { @@ -30395,22 +30392,22 @@ export interface DataSource { /** Lists out the items to be displayed as series of PivotTreeMap. * @Default {[]} */ - columns?: Array; + columns?: DataSourceColumn[]; /** Lists out the items to be displayed as segments of PivotTreeMap. * @Default {[]} */ - rows?: Array; + rows?: DataSourceRow[]; /** Lists out the items supports calculation in PivotTreeMap. * @Default {[]} */ - values?: Array; + values?: DataSourceValue[]; /** Lists out the items which supports filtering of values without displaying the members in UI in PivotTreeMap. * @Default {[]} */ - filters?: Array; + filters?: DataSourceFilter[]; } export interface ServiceMethodSettings { @@ -30429,11 +30426,10 @@ export interface ServiceMethodSettings { class Schedule extends ej.Widget { static fn: Schedule; - constructor(element: JQuery, options?: Schedule.Model); - constructor(element: Element, options?: Schedule.Model); + constructor(element: JQuery | Element, options?: Schedule.Model); static Locale: any; - model:Schedule.Model; - defaults:Schedule.Model; + model: Schedule.Model; + defaults: Schedule.Model; /** This method is used to delete the appointment based on the guid value or the appointment data passed to it. * @param {string|any} GUID value of an appointment element or an appointment object @@ -30458,14 +30454,15 @@ class Schedule extends ej.Widget { * @param {Array} Holds array of one or more conditional objects for filtering the appointments based on it. * @returns {Array} */ - filterAppointments(filterConditions: Array): Array; + filterAppointments(filterConditions: any[]): any[]; /** Gets the complete appointment list of Schedule control. * @returns {Array} */ - getAppointments(): Array; + getAppointments(): any[]; - /** Prints the entire Scheduler or a single appointment based on the appointment data passed as an argument to it. Simply calling the print() method, without passing any argument will print the entire Scheduler. + /** Prints the entire Scheduler or a single appointment based on the appointment data passed as an argument to it. Simply calling the print() method, + * without passing any argument will print the entire Scheduler. * @param {any} Either accepts no arguments at all or else accepts an appointment object. * @returns {void} */ @@ -30487,7 +30484,9 @@ class Schedule extends ej.Widget { */ getRecurrenceRule(): string; - /** Retrieves the time slot information (start/end time and resource details) of the given element. The parameter is optional - as when no element is passed to it, the currently selected cell information will be retrieved. When multiple cells are selected in the Scheduler, it is not necessary to provide the parameter. + /** Retrieves the time slot information (start/end time and resource details) of the given element. + * The parameter is optional - as when no element is passed to it, the currently selected cell information will be retrieved. When multiple cells are selected in the Scheduler, + * it is not necessary to provide the parameter. * @param {any} TD element object rendered as Scheduler work cell * @returns {any} */ @@ -30500,7 +30499,7 @@ class Schedule extends ej.Widget { * @param {boolean} Defines the ignoreCase value for performing the search operation. * @returns {Array} */ - searchAppointments(searchString: any|string, field: string, operator: ej.FilterOperators|string, ignoreCase: boolean): Array; + searchAppointments(searchString: any|string, field: string, operator: ej.FilterOperators|string, ignoreCase: boolean): any[]; /** Refreshes the entire Schedule control. * @returns {void} @@ -30517,7 +30516,7 @@ class Schedule extends ej.Widget { */ notifyChanges(): void; } -export module Schedule{ +export namespace Schedule { export interface Model { @@ -30531,11 +30530,13 @@ export interface Model { */ allowKeyboardNavigation?: boolean; - /** It includes the dataSource option and the fields related to Schedule appointments. The appointment fields within the appointmentSettings can accept both string and object type values. To apply validation rules on the appointment window fields, then the appointment fields needs to be defined with object type values. + /** It includes the dataSource option and the fields related to Schedule appointments. The appointment fields within the appointmentSettings can accept both string and object type values. + * To apply validation rules on the appointment window fields, then the appointment fields needs to be defined with object type values. */ appointmentSettings?: AppointmentSettings; - /** Template design that applies on the Schedule appointments. All the field names that are mapped from dataSource to the appropriate field properties within the appointmentSettings can be used within the template. + /** Template design that applies on the Schedule appointments. All the field names that are mapped from dataSource + * to the appropriate field properties within the appointmentSettings can be used within the template. * @Default {null} */ appointmentTemplateId?: string; @@ -30566,7 +30567,9 @@ export interface Model { */ currentDate?: any; - /** Sets current view of the Schedule. Schedule renders initially with the view that is specified here. The available views are day, week, workweek, month, agenda and custom view - from which any one of the required view can be set to the Schedule. It accepts both string or enum values. The enum values that are accepted by currentView(ej.Schedule.CurrentView) are as follows, + /** Sets current view of the Schedule. Schedule renders initially with the view that is specified here. The available views are day, week, workweek, month, agenda and + * custom view - from which any one of the required view can be set to the Schedule. It accepts both string or enum values. The enum values that are accepted + * by currentView(ej.Schedule.CurrentView) are as follows, * @Default {ej.Schedule.CurrentView.Week} */ currentView?: string|ej.Schedule.CurrentView; @@ -30643,7 +30646,8 @@ export interface Model { */ minDate?: any; - /** Sets the mode of Schedule rendering either in a vertical or horizontal direction. It accepts either string("vertical" or "horizontal") or enum values. The enum values that are accepted by orientation(ej.Schedule.Orientation) are as follows, + /** Sets the mode of Schedule rendering either in a vertical or horizontal direction. It accepts either string("vertical" or "horizontal") or enum values. + * The enum values that are accepted by orientation(ej.Schedule.Orientation) are as follows, * @Default {ej.Schedule.Orientation.Vertical} */ orientation?: string|ej.Schedule.Orientation; @@ -30661,7 +30665,8 @@ export interface Model { */ reminderSettings?: ReminderSettings; - /** Defines the specific start and end dates to be rendered in the Schedule control. To render such user-specified custom date ranges in the Schedule control, set the currentView property to ej.Schedule.CurrentView.CustomView. + /** Defines the specific start and end dates to be rendered in the Schedule control. To render such user-specified custom date ranges in the Schedule control, + * set the currentView property to ej.Schedule.CurrentView.CustomView. * @Default {null} */ renderDates?: RenderDates; @@ -30671,10 +30676,11 @@ export interface Model { */ resourceHeaderTemplateId?: string; - /** Holds all the options related to the resources settings of the Schedule. It is a collection of one or more resource objects, where the levels of resources are rendered on the Schedule based on the order of the resource data provided within this collection. + /** Holds all the options related to the resources settings of the Schedule. It is a collection of one or more resource objects, where the levels of resources are rendered on the Schedule + * based on the order of the resource data provided within this collection. * @Default {null} */ - resources?: Array; + resources?: Resource[]; /** When set to true, displays the all-day row cells on the Schedule. * @Default {true} @@ -30711,7 +30717,8 @@ export interface Model { */ startHour?: number; - /** Sets either 12 or 24 hour time mode on the Schedule. It accepts either the string value("12" or "24") or the below mentioned enum values. The enum values that are accepted by timeMode(ej.Schedule.TimeMode) are as follows, + /** Sets either 12 or 24 hour time mode on the Schedule. It accepts either the string value("12" or "24") or the below mentioned enum values. + * The enum values that are accepted by timeMode(ej.Schedule.TimeMode) are as follows, * @Default {null} */ timeMode?: string|ej.Schedule.TimeMode; @@ -30728,14 +30735,15 @@ export interface Model { /** Defines the view collection to be displayed on the Schedule. By default, it displays all the views namely, Day, Week, WorkWeek and Month. * @Default {[Day, Week, WorkWeek, Month, Agenda]} */ - views?: Array; + views?: any[]; /** Sets the width of the Schedule. Accepts both pixel and percentage values. * @Default {100%} */ width?: string; - /** When set to true, Schedule allows the validation of recurrence pattern to take place before it is being assigned to the appointments. For example, when one of the instance of recurrence appointment is dragged beyond the next or previous instance of the same recurrence appointment, a pop-up is displayed with the validation message disallowing the drag functionality. + /** When set to true, Schedule allows the validation of recurrence pattern to take place before it is being assigned to the appointments. For example, when one of the instance of + * recurrence appointment is dragged beyond the next or previous instance of the same recurrence appointment, a pop-up is displayed with the validation message disallowing the drag functionality. * @Default {true} */ enableRecurrenceValidation?: boolean; @@ -30752,7 +30760,7 @@ export interface Model { /** Sets different day collection within workWeek view. * @Default {[Monday, Tuesday, Wednesday, Thursday, Friday]} */ - workWeek?: Array; + workWeek?: any[]; /** Allows to pop-up appointment details in a tooltip while hovering over the appointments. */ @@ -30796,99 +30804,100 @@ export interface Model { */ showNextPrevMonth?: boolean; - /** Blocks the user-specific time interval on the Scheduler, so that no appointments can be created on that particular time slots. It includes the dataSource option and also the fields related to block intervals. + /** Blocks the user-specific time interval on the Scheduler, so that no appointments can be created on that particular time slots. + * It includes the dataSource option and also the fields related to block intervals. */ blockoutSettings?: BlockoutSettings; /** Triggers on the beginning of every action that starts within the Schedule. */ - actionBegin? (e: ActionBeginEventArgs): void; + actionBegin?(e: ActionBeginEventArgs): void; /** Triggers after the completion of every action within the Schedule. */ - actionComplete? (e: ActionCompleteEventArgs): void; + actionComplete?(e: ActionCompleteEventArgs): void; /** Triggers after an appointment is clicked. */ - appointmentClick? (e: AppointmentClickEventArgs): void; + appointmentClick?(e: AppointmentClickEventArgs): void; /** Triggers before the appointment is being removed from the Scheduler. */ - beforeAppointmentRemove? (e: BeforeAppointmentRemoveEventArgs): void; + beforeAppointmentRemove?(e: BeforeAppointmentRemoveEventArgs): void; /** Triggers before the edited appointment is being saved. */ - beforeAppointmentChange? (e: BeforeAppointmentChangeEventArgs): void; + beforeAppointmentChange?(e: BeforeAppointmentChangeEventArgs): void; /** Triggers on hovering the mouse over the appointments. */ - appointmentHover? (e: AppointmentHoverEventArgs): void; + appointmentHover?(e: AppointmentHoverEventArgs): void; /** Triggers before the new appointment gets saved. */ - beforeAppointmentCreate? (e: BeforeAppointmentCreateEventArgs): void; + beforeAppointmentCreate?(e: BeforeAppointmentCreateEventArgs): void; /** Triggers before the appointment window opens. */ - appointmentWindowOpen? (e: AppointmentWindowOpenEventArgs): void; + appointmentWindowOpen?(e: AppointmentWindowOpenEventArgs): void; /** Triggers before the context menu opens. */ - beforeContextMenuOpen? (e: BeforeContextMenuOpenEventArgs): void; + beforeContextMenuOpen?(e: BeforeContextMenuOpenEventArgs): void; /** Triggers after the cell is clicked. */ - cellClick? (e: CellClickEventArgs): void; + cellClick?(e: CellClickEventArgs): void; /** Triggers after the cell is clicked twice. */ - cellDoubleClick? (e: CellDoubleClickEventArgs): void; + cellDoubleClick?(e: CellDoubleClickEventArgs): void; /** Triggers on hovering the mouse overs the cells. */ - cellHover? (e: CellHoverEventArgs): void; + cellHover?(e: CellHoverEventArgs): void; /** Triggers when the Scheduler completely renders on the page. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Triggers when the Scheduler and all its sub-components gets destroyed. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Triggers while the appointment is being dragged over the work cells. */ - drag? (e: DragEventArgs): void; + drag?(e: DragEventArgs): void; /** Triggers when the appointment dragging begins. */ - dragStart? (e: DragStartEventArgs): void; + dragStart?(e: DragStartEventArgs): void; /** Triggers when the appointment is dropped. */ - dragStop? (e: DragStopEventArgs): void; + dragStop?(e: DragStopEventArgs): void; /** Triggers after the menu/sub-menu items within the context menu is clicked. */ - menuItemClick? (e: MenuItemClickEventArgs): void; + menuItemClick?(e: MenuItemClickEventArgs): void; /** Triggers after the Schedule view or date is navigated. */ - navigation? (e: NavigationEventArgs): void; + navigation?(e: NavigationEventArgs): void; /** Triggers every time before the elements of the scheduler such as work cells, time cells or header cells and so on renders or re-renders on a page. */ - queryCellInfo? (e: QueryCellInfoEventArgs): void; + queryCellInfo?(e: QueryCellInfoEventArgs): void; /** Triggers when the reminder is raised for an appointment based on the alertBefore value. */ - reminder? (e: ReminderEventArgs): void; + reminder?(e: ReminderEventArgs): void; /** Triggers while resizing the appointment. */ - resize? (e: ResizeEventArgs): void; + resize?(e: ResizeEventArgs): void; /** Triggers when the appointment resizing begins. */ - resizeStart? (e: ResizeStartEventArgs): void; + resizeStart?(e: ResizeStartEventArgs): void; /** Triggers when an appointment resizing stops. */ - resizeStop? (e: ResizeStopEventArgs): void; + resizeStop?(e: ResizeStopEventArgs): void; /** Triggers when the overflow button is clicked. */ - overflowButtonClick? (e: OverflowButtonClickEventArgs): void; + overflowButtonClick?(e: OverflowButtonClickEventArgs): void; /** Triggers while mouse hovering on the overflow button. */ - overflowButtonHover? (e: OverflowButtonHoverEventArgs): void; + overflowButtonHover?(e: OverflowButtonHoverEventArgs): void; /** Triggers when any of the keyboard keys are pressed. */ - keyDown? (e: KeyDownEventArgs): void; + keyDown?(e: KeyDownEventArgs): void; /** Triggers after the new appointment is saved. */ - appointmentCreated? (e: AppointmentCreatedEventArgs): void; + appointmentCreated?(e: AppointmentCreatedEventArgs): void; /** Triggers after an existing appointment is edited. */ - appointmentChanged? (e: AppointmentChangedEventArgs): void; + appointmentChanged?(e: AppointmentChangedEventArgs): void; /** Triggers after the appointment is deleted. */ - appointmentRemoved? (e: AppointmentRemovedEventArgs): void; + appointmentRemoved?(e: AppointmentRemovedEventArgs): void; } export interface ActionBeginEventArgs { @@ -31529,7 +31538,7 @@ export interface ResizeStopEventArgs { export interface OverflowButtonClickEventArgs { - /** Returns the object consisting of start time, end time and resource value of the underlying cell on which the clicked overflow button is present. + /** Returns the object consisting of start time, end time and resource value of the underlying cell on which the clicked overflow button is present. */ object?: any; @@ -31552,7 +31561,7 @@ export interface OverflowButtonClickEventArgs { export interface OverflowButtonHoverEventArgs { - /** Returns the object consisting of start time, end time and resource value of the underlying cell on which the overflow button is currently hovered. + /** Returns the object consisting of start time, end time and resource value of the underlying cell on which the overflow button is currently hovered. */ object?: any; @@ -31654,7 +31663,7 @@ export interface AppointmentSettings { /** The dataSource option accepts either JSON object collection or DataManager (ej.DataManager) instance that contains Schedule appointments. * @Default {[]} */ - dataSource?: any|Array; + dataSource?: any|any[]; /** It holds either the ej.Query() object or simply the query string that retrieves the specified records from the table. * @Default {null} @@ -31731,12 +31740,14 @@ export interface AppointmentSettings { */ priority?: string; - /** Binds the name of start timezone field in dataSource. It indicates the timezone of appointment start date. When startTimeZone field is not mentioned, the appointment uses the Schedule timeZone or System timeZone. + /** Binds the name of start timezone field in dataSource. It indicates the timezone of appointment start date. When startTimeZone field is not mentioned, + * the appointment uses the Schedule timeZone or System timeZone. * @Default {null} */ startTimeZone?: string; - /** Binds the name of end timezone field in dataSource. It indicates the timezone of appointment end date. When the endTimeZone field is not mentioned, the appointment uses the Schedule timeZone or System timeZone. + /** Binds the name of end timezone field in dataSource. It indicates the timezone of appointment end date. When the endTimeZone field is not mentioned, + * the appointment uses the Schedule timeZone or System timeZone. * @Default {null} */ endTimeZone?: string; @@ -31756,7 +31767,7 @@ export interface CategorizeSettings { /** The dataSource option accepts either the JSON object collection or DataManager [ej.DataManager] instance that contains the categorize data. */ - dataSource?: Array|any; + dataSource?: any[]|any; /** Binds id field name in the dataSource to id of category data. * @Default {id} @@ -31783,11 +31794,11 @@ export interface ContextMenuSettingsMenuItems { /** All the appointment related context menu items are grouped under this appointment menu collection. */ - appointment?: Array; + appointment?: any[]; /** All the Scheduler cell related context menu items are grouped under this cells menu item collection. */ - cells?: Array; + cells?: any[]; } export interface ContextMenuSettings { @@ -31806,7 +31817,7 @@ export interface Group { /** Holds the array of resource names to be grouped on the Schedule. */ - resources?: Array; + resources?: any[]; } export interface WorkHours { @@ -31837,7 +31848,7 @@ export interface PrioritySettings { /** The dataSource option can accept the JSON object collection that contains the priority related data. * @Default {{% highlight js%}[{ text: None, value: none },{ text: High, value: high },{ text: Medium, value: medium },{ text: Low, value: low }]{% endhighlight %}} */ - dataSource?: any|Array; + dataSource?: any|any[]; /** Binds text field name in the dataSource to prioritySettings text. These text gets listed out in priority field of the appointment window. * @Default {text} @@ -31886,7 +31897,7 @@ export interface ResourcesResourceSettings { /** The dataSource option accepts either JSON object collection or DataManager (ejDataManager) instance that contains the resources related data. * @Default {[]} */ - dataSource?: any|Array; + dataSource?: any|any[]; /** Binds text field name in the dataSource to resourceSettings text. These text gets listed out in resources field of the appointment window. * @Default {null} @@ -31918,7 +31929,8 @@ export interface ResourcesResourceSettings { */ end?: string; - /** Binds the resources working days field name in the dataSource. It's optional, and accepts the array of strings (week day names). When provided with specific collection of days (array of day names), only those days will render for the specific resources. + /** Binds the resources working days field name in the dataSource. It's optional, and accepts the array of strings (week day names). When provided with specific collection of + * days (array of day names), only those days will render for the specific resources. * @Default {null} */ workWeek?: string; @@ -32003,7 +32015,8 @@ export interface TooltipSettings { */ enable?: boolean; - /** Template design that customizes the tooltip. All the field names that are mapped from dataSource to the appropriate field properties within the appointmentSettings can be accessed within the template. + /** Template design that customizes the tooltip. All the field names that are mapped from dataSource to the appropriate field properties within + * the appointmentSettings can be accessed within the template. * @Default {null} */ templateId?: string; @@ -32044,7 +32057,8 @@ export interface BlockoutSettings { */ enable?: boolean; - /** Template design that applies on the Schedule block intervals. All the field names that are mapped from dataSource to the appropriate field properties within the blockoutSettings can be used within the template. + /** Template design that applies on the Schedule block intervals. All the field names that are mapped from dataSource to the appropriate field + * properties within the blockoutSettings can be used within the template. * @Default {null} */ templateId?: string; @@ -32052,7 +32066,7 @@ export interface BlockoutSettings { /** The dataSource option accepts either JSON object collection or DataManager (ej.DataManager) instance that contains Schedule block intervals. * @Default {[]} */ - dataSource?: any|Array; + dataSource?: any|any[]; /** It holds either the ej.Query() object or simply the query string that retrieves the specified records from the table. * @Default {null} @@ -32105,7 +32119,7 @@ export interface BlockoutSettings { customStyle?: string; } -enum CurrentView{ +enum CurrentView { ///Sets currentView of the Scheduler as Day Day, @@ -32127,7 +32141,7 @@ enum CurrentView{ } -enum Orientation{ +enum Orientation { ///Set orientation as vertical to Scheduler Vertical, @@ -32137,7 +32151,7 @@ enum Orientation{ } -enum TimeMode{ +enum TimeMode { ///Sets 12 hour time mode to Scheduler Hour12, @@ -32150,16 +32164,15 @@ enum TimeMode{ class RecurrenceEditor extends ej.Widget { static fn: RecurrenceEditor; - constructor(element: JQuery, options?: RecurrenceEditor.Model); - constructor(element: Element, options?: RecurrenceEditor.Model); + constructor(element: JQuery | Element, options?: RecurrenceEditor.Model); static Locale: any; - model:RecurrenceEditor.Model; - defaults:RecurrenceEditor.Model; + model: RecurrenceEditor.Model; + defaults: RecurrenceEditor.Model; /** Generates the recurrence rule with the options selected within the Recurrence Editor. * @returns {String} */ - getRecurrenceRule(): String; + getRecurrenceRule(): string; /** Generates the collection of date, that lies within the selected recurrence start and end date for which the recurrence pattern applies. * @param {string} It refers the recurrence rule. @@ -32175,14 +32188,14 @@ class RecurrenceEditor extends ej.Widget { */ recurrenceRuleSplit(recurrenceRule: string, exDate: any): any; } -export module RecurrenceEditor{ +export namespace RecurrenceEditor { export interface Model { /** Defines the collection of recurrence frequencies within Recurrence Editor such as Never, Daily, Weekly, Monthly, Yearly and Every Weekday. * @Default {[never, daily, weekly, monthly, yearly, everyweekday]} */ - frequencies?: Array; + frequencies?: any[]; /** Sets the starting day of the week. * @Default {null} @@ -32213,17 +32226,20 @@ export interface Model { */ enableRTL?: boolean; - /** Sets the active/current repeat type(frequency) on Recurrence Editor based on the index value provided. For example, setting the value 1 will initially set the repeat type as Daily and display its related options. + /** Sets the active/current repeat type(frequency) on Recurrence Editor based on the index value provided. For example, setting the value 1 will initially set the repeat type + * as Daily and display its related options. * @Default {0} */ selectedRecurrenceType?: number; - /** Sets the minimum date limit to display on the datepickers defined within the Recurrence Editor. Setting minDate with specific date value disallows the datepickers within Recurrence Editor to navigate beyond that date. + /** Sets the minimum date limit to display on the datepickers defined within the Recurrence Editor. Setting minDate with specific date value disallows the datepickers within + * Recurrence Editor to navigate beyond that date. * @Default {new Date(1900, 01, 01)} */ minDate?: any; - /** Sets the maximum date limit to display on the datepickers used within the Recurrence Editor. Setting maxDate with specific date value disallows the datepickers within the Recurrence Editor to navigate beyond that date. + /** Sets the maximum date limit to display on the datepickers used within the Recurrence Editor. Setting maxDate with specific date value disallows the + * datepickers within the Recurrence Editor to navigate beyond that date. * @Default {new Date(2099, 12, 31)} */ maxDate?: any; @@ -32233,7 +32249,7 @@ export interface Model { cssClass?: string; /** Triggers whenever any of the Recurrence Editor's value is changed. */ - change? (e: ChangeEventArgs): void; + change?(e: ChangeEventArgs): void; } export interface ChangeEventArgs { @@ -32258,11 +32274,10 @@ export interface ChangeEventArgs { class Gantt extends ej.Widget { static fn: Gantt; - constructor(element: JQuery, options?: Gantt.Model); - constructor(element: Element, options?: Gantt.Model); + constructor(element: JQuery | Element, options?: Gantt.Model); static Locale: any; - model:Gantt.Model; - defaults:Gantt.Model; + model: Gantt.Model; + defaults: Gantt.Model; /** To add a new item in Gantt * @param {any} Item to add in Gantt row. @@ -32276,7 +32291,7 @@ class Gantt extends ej.Widget { * @param {boolean} Defines that we need to preserve the previously selected cells of not * @returns {void} */ - selectCells(Indexes: Array, preservePreviousSelectedCell: boolean): void; + selectCells(Indexes: any[], preservePreviousSelectedCell: boolean): void; /** Positions the splitter by the specified column index. * @param {number} Set the splitter position based on column index. @@ -32364,14 +32379,14 @@ class Gantt extends ej.Widget { */ showColumn(headerText: string): void; } -export module Gantt{ +export namespace Gantt { export interface Model { /** Specifies the fields to be included in the add dialog in Gantt * @Default {[]} */ - addDialogFields?: Array; + addDialogFields?: any[]; /** Enables or disables the ability to resize column. * @Default {false} @@ -32438,7 +32453,7 @@ export interface Model { /** To Specify the column fields to be displayed in the dialog while inserting a column using column menu. * @Default {[]} */ - columnDialogFields?: Array; + columnDialogFields?: any[]; /** Specifies the background of connector lines in Gantt */ @@ -32465,7 +32480,7 @@ export interface Model { /** Collection of data or hierarchical data to represent in Gantt * @Default {null} */ - dataSource?: Array; + dataSource?: any[]; /** Specifies the dateFormat for Gantt , given format is displayed in tooltip , Grid . * @Default {MM/dd/yyyy} @@ -32484,7 +32499,7 @@ export interface Model { /** Specifies the fields to be included in the edit dialog in Gantt * @Default {[]} */ - editDialogFields?: Array; + editDialogFields?: any[]; /** Enables or disables the responsiveness of Gantt * @Default {false} @@ -32577,7 +32592,7 @@ export interface Model { /** Collection of holidays with date, background and label information to be displayed in Gantt. * @Default {[]} */ - holidays?: Array; + holidays?: any[]; /** Specifies whether to include weekends while calculating the duration of a task. * @Default {true} @@ -32708,7 +32723,7 @@ export interface Model { /** Collection of data regarding resources involved in entire project * @Default {[]} */ - resources?: Array; + resources?: any[]; /** Specifies whether rounding off the day working time edits * @Default {true} @@ -32775,7 +32790,7 @@ export interface Model { /** Specifies the selected cell information on rendering Gantt. */ - selectedCellIndexes?: Array; + selectedCellIndexes?: SelectedCellIndex[]; /** Specifies the sorting options for Gantt. */ @@ -32793,7 +32808,7 @@ export interface Model { /** Specifies the options for striplines * @Default {[]} */ - stripLines?: Array; + stripLines?: any[]; /** Specifies the background of the taskbar in Gantt */ @@ -32861,79 +32876,79 @@ export interface Model { workingTimeScale?: ej.Gantt.workingTimeScale|string; /** Triggered for every Gantt action before its starts. */ - actionBegin? (e: ActionBeginEventArgs): void; + actionBegin?(e: ActionBeginEventArgs): void; /** Triggered for every Gantt action success event. */ - actionComplete? (e: ActionCompleteEventArgs): void; + actionComplete?(e: ActionCompleteEventArgs): void; /** Triggered while enter the edit mode in the TreeGrid cell */ - beginEdit? (e: BeginEditEventArgs): void; + beginEdit?(e: BeginEditEventArgs): void; /** Triggered before selecting a cell */ - cellSelecting? (e: CellSelectingEventArgs): void; + cellSelecting?(e: CellSelectingEventArgs): void; /** Triggered after selected a cell */ - cellSelected? (e: CellSelectedEventArgs): void; + cellSelected?(e: CellSelectedEventArgs): void; /** Triggered while dragging a row in Gantt control */ - rowDrag? (e: RowDragEventArgs): void; + rowDrag?(e: RowDragEventArgs): void; /** Triggered while start to drag row in Gantt control */ - rowDragStart? (e: RowDragStartEventArgs): void; + rowDragStart?(e: RowDragStartEventArgs): void; /** Triggered while drop a row in Gantt control */ - rowDragStop? (e: RowDragStopEventArgs): void; + rowDragStop?(e: RowDragStopEventArgs): void; /** Triggered after collapsed the Gantt record */ - collapsed? (e: CollapsedEventArgs): void; + collapsed?(e: CollapsedEventArgs): void; /** Triggered while collapsing the Gantt record */ - collapsing? (e: CollapsingEventArgs): void; + collapsing?(e: CollapsingEventArgs): void; /** Triggered while Context Menu is rendered in Gantt control */ - contextMenuOpen? (e: ContextMenuOpenEventArgs): void; + contextMenuOpen?(e: ContextMenuOpenEventArgs): void; /** Triggered when Gantt is rendered completely. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Triggered after save the modified cellValue in Gantt. */ - endEdit? (e: EndEditEventArgs): void; + endEdit?(e: EndEditEventArgs): void; /** Triggered after expand the record */ - expanded? (e: ExpandedEventArgs): void; + expanded?(e: ExpandedEventArgs): void; /** Triggered while expanding the Gantt record */ - expanding? (e: ExpandingEventArgs): void; + expanding?(e: ExpandingEventArgs): void; /** Triggered while Gantt is loaded */ - load? (e: LoadEventArgs): void; + load?(e: LoadEventArgs): void; /** Triggered while rendering each cell in the TreeGrid */ - queryCellInfo? (e: QueryCellInfoEventArgs): void; + queryCellInfo?(e: QueryCellInfoEventArgs): void; /** Triggered while rendering each taskbar in the Gantt */ - queryTaskbarInfo? (e: QueryTaskbarInfoEventArgs): void; + queryTaskbarInfo?(e: QueryTaskbarInfoEventArgs): void; /** Triggered while rendering each row */ - rowDataBound? (e: RowDataBoundEventArgs): void; + rowDataBound?(e: RowDataBoundEventArgs): void; /** Triggered after the row is selected. */ - rowSelected? (e: RowSelectedEventArgs): void; + rowSelected?(e: RowSelectedEventArgs): void; /** Triggered before the row is going to be selected. */ - rowSelecting? (e: RowSelectingEventArgs): void; + rowSelecting?(e: RowSelectingEventArgs): void; /** Triggered after completing the editing operation in taskbar */ - taskbarEdited? (e: TaskbarEditedEventArgs): void; + taskbarEdited?(e: TaskbarEditedEventArgs): void; /** Triggered while editing the Gantt chart (dragging, resizing the taskbar ) */ - taskbarEditing? (e: TaskbarEditingEventArgs): void; + taskbarEditing?(e: TaskbarEditingEventArgs): void; /** Triggered when taskbar item is clicked in Gantt. */ - taskbarClick? (e: TaskbarClickEventArgs): void; + taskbarClick?(e: TaskbarClickEventArgs): void; /** Triggered when toolbar item is clicked in Gantt. */ - toolbarClick? (e: ToolbarClickEventArgs): void; + toolbarClick?(e: ToolbarClickEventArgs): void; } export interface ActionBeginEventArgs { @@ -33270,7 +33285,7 @@ export interface ContextMenuOpenEventArgs { /** Returns the default context menu items to which we add custom items. */ - contextMenuItems?: Array; + contextMenuItems?: any[]; /** Returns the Gantt model. */ @@ -33629,7 +33644,7 @@ export interface DragTooltip { /** Specifies the data source fields to be displayed in the drag tooltip. * @Default {[]} */ - tooltipItems?: Array; + tooltipItems?: any[]; /** Specifies the custom template for drag tooltip. * @Default {null} @@ -33779,7 +33794,7 @@ export interface SortSettings { /** Specifies the sorted columns for Gantt * @Default {[]} */ - sortedColumns?: Array; + sortedColumns?: any[]; } export interface ToolbarSettings { @@ -33792,10 +33807,10 @@ export interface ToolbarSettings { /** Specifies the list of toolbar items to be rendered in Gantt toolbar * @Default {[]} */ - toolbarItems?: Array; + toolbarItems?: any[]; } -enum DurationUnit{ +enum DurationUnit { ///Sets the Duration Unit as day. Day, @@ -33808,7 +33823,7 @@ enum DurationUnit{ } -enum BeginEditAction{ +enum BeginEditAction { ///you can begin the editing at double click DblClick, @@ -33818,7 +33833,7 @@ enum BeginEditAction{ } -enum RowPosition{ +enum RowPosition { ///you can add a new row at top. Top, @@ -33837,7 +33852,7 @@ enum RowPosition{ } -enum TaskType{ +enum TaskType { ///Resource unit remains constant while editing the work and duration values. FixedUnit, @@ -33850,7 +33865,7 @@ enum TaskType{ } -enum WorkUnit{ +enum WorkUnit { ///Displays the work involved in a task in days. Day, @@ -33863,7 +33878,7 @@ enum WorkUnit{ } -enum TaskSchedulingMode{ +enum TaskSchedulingMode { ///All the tasks in the project will be displayed in auto scheduled mode, where the tasks are scheduled automatically over non-working days and holidays. Auto, @@ -33876,7 +33891,7 @@ enum TaskSchedulingMode{ } -enum SelectionType{ +enum SelectionType { ///you can select a single row. Single, @@ -33886,7 +33901,7 @@ enum SelectionType{ } -enum minutesPerInterval{ +enum minutesPerInterval { ///Sets the interval automatically according with schedule start and end date. Auto, @@ -33905,7 +33920,7 @@ enum minutesPerInterval{ } -enum ScheduleHeaderType{ +enum ScheduleHeaderType { ///Sets year Schedule Mode. Year, @@ -33924,7 +33939,7 @@ enum ScheduleHeaderType{ } -enum TimescaleRoundMode{ +enum TimescaleRoundMode { ///The round-off value will be automatically calculated based on the data source values. Auto, @@ -33940,7 +33955,7 @@ enum TimescaleRoundMode{ } -enum SelectionMode{ +enum SelectionMode { ///you can select a row. Row, @@ -33950,7 +33965,7 @@ enum SelectionMode{ } -enum workingTimeScale{ +enum workingTimeScale { ///Sets eight hour timescale. TimeScale8Hours, @@ -33963,11 +33978,10 @@ enum workingTimeScale{ class ReportViewer extends ej.Widget { static fn: ReportViewer; - constructor(element: JQuery, options?: ReportViewer.Model); - constructor(element: Element, options?: ReportViewer.Model); + constructor(element: JQuery | Element, options?: ReportViewer.Model); static Locale: any; - model:ReportViewer.Model; - defaults:ReportViewer.Model; + model: ReportViewer.Model; + defaults: ReportViewer.Model; /** Export the report to the specified format. * @returns {void} @@ -34039,19 +34053,19 @@ class ReportViewer extends ej.Widget { */ refresh(): void; } -export module ReportViewer{ +export namespace ReportViewer { export interface Model { /** Gets or sets the list of data sources for the RDLC report. * @Default {[]} */ - dataSources?: Array; + dataSources?: DataSource[]; /** Enables or disables the page cache of report. * @Default {false} */ - enablePageCache?: Boolean; + enablePageCache?: boolean; /** Specifies the export settings. */ @@ -34060,12 +34074,12 @@ export interface Model { /** When set to true, adapts the report layout to fit the screen size of devices on which it renders. * @Default {true} */ - isResponsive?: Boolean; + isResponsive?: boolean; /** Specifies the locale for report viewer. * @Default {en-US} */ - locale?: String; + locale?: string; /** Specifies the page settings. */ @@ -34074,12 +34088,12 @@ export interface Model { /** Gets or sets the list of parameters associated with the report. * @Default {[]} */ - parameters?: Array; + parameters?: Parameter[]; /** Enables and disables the print mode. * @Default {false} */ - printMode?: Boolean; + printMode?: boolean; /** Specifies the print option of the report. * @Default {ej.ReportViewer.PrintOptions.Default} @@ -34099,17 +34113,17 @@ export interface Model { /** Gets or sets the path of the report file. * @Default {empty} */ - reportPath?: String; + reportPath?: string; /** Gets or sets the reports server URL. * @Default {empty} */ - reportServerUrl?: String; + reportServerUrl?: string; /** Specifies the report Web API service URL. * @Default {empty} */ - reportServiceUrl?: String; + reportServiceUrl?: string; /** Specifies the toolbar settings. */ @@ -34118,31 +34132,31 @@ export interface Model { /** Gets or sets the zoom factor for report viewer. * @Default {1} */ - zoomFactor?: Number; + zoomFactor?: number; /** Fires when the report viewer is destroyed successfully.If you want to perform any operation after destroying the reportviewer control,you can make use of the destroy event. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Fires during drill through action done in report.If you want to perform any operation when a drill through action is performed, you can make use of the drillThrough event. */ - drillThrough? (e: DrillThroughEventArgs): void; + drillThrough?(e: DrillThroughEventArgs): void; /** Fires before report rendering is completed.If you want to perform any operation before the rendering of report,you can make use of the renderingBegin event. */ - renderingBegin? (e: RenderingBeginEventArgs): void; + renderingBegin?(e: RenderingBeginEventArgs): void; /** Fires after report rendering completed.If you want to perform any operation after the rendering of report,you can make use of this renderingComplete event. */ - renderingComplete? (e: RenderingCompleteEventArgs): void; + renderingComplete?(e: RenderingCompleteEventArgs): void; /** Fires when any error occurred while rendering the report.If you want to perform any operation when an error occurs in the report, you can make use of the reportError event. */ - reportError? (e: ReportErrorEventArgs): void; + reportError?(e: ReportErrorEventArgs): void; /** Fires when the report is being exported.If you want to perform any operation before exporting of report, you can make use of the reportExport event. */ - reportExport? (e: ReportExportEventArgs): void; + reportExport?(e: ReportExportEventArgs): void; /** Fires when the report is loaded.If you want to perform any operation after the successful loading of report, you can make use of the reportLoaded event. */ - reportLoaded? (e: ReportLoadedEventArgs): void; + reportLoaded?(e: ReportLoadedEventArgs): void; /** Fires when click the View Report Button. */ - viewReportClick? (e: ViewReportClickEventArgs): void; + viewReportClick?(e: ViewReportClickEventArgs): void; } export interface DestroyEventArgs { @@ -34286,12 +34300,12 @@ export interface DataSource { /** Gets or sets the name of the data source. * @Default {empty} */ - name?: String; + name?: string; /** Gets or sets the values of data source. * @Default {[]} */ - values?: Array; + values?: any[]; } export interface ExportSettings { @@ -34330,27 +34344,27 @@ export interface Parameter { /** Gets or sets the parameter labels. * @Default {null} */ - labels?: Array; + labels?: any[]; /** Gets or sets the name of the parameter. * @Default {empty} */ - name?: String; + name?: string; /** Gets or sets whether the parameter allows nullable value or not. * @Default {false} */ - nullable?: Boolean; + nullable?: boolean; /** Gets or sets the prompt message associated with the specified parameter. * @Default {empty} */ - prompt?: String; + prompt?: string; /** Gets or sets the parameter values. * @Default {[]} */ - values?: Array; + values?: any[]; } export interface ToolbarSettings { @@ -34358,7 +34372,7 @@ export interface ToolbarSettings { /** Fires when user click on toolbar item in the toolbar. * @Default {empty} */ - click?: String; + click?: string; /** Specifies the toolbar items. * @Default {ej.ReportViewer.ToolbarItems.All} @@ -34368,20 +34382,20 @@ export interface ToolbarSettings { /** Shows or hides the toolbar. * @Default {true} */ - showToolbar?: Boolean; + showToolbar?: boolean; /** Shows or hides the tooltip of toolbar items. * @Default {true} */ - showTooltip?: Boolean; + showTooltip?: boolean; /** Specifies the toolbar template ID. * @Default {empty} */ - templateId?: String; + templateId?: string; } -enum ExportOptions{ +enum ExportOptions { ///Specifies the All property in ExportOptions to get all available options. All, @@ -34400,7 +34414,7 @@ enum ExportOptions{ } -enum ExcelFormats{ +enum ExcelFormats { ///Specifies the Excel97to2003 property in ExcelFormats to get specified version of exported format. Excel97to2003, @@ -34416,7 +34430,7 @@ enum ExcelFormats{ } -enum WordFormats{ +enum WordFormats { ///Specifies the Doc property in WordFormats to get specified version of exported format. Doc, @@ -34483,7 +34497,7 @@ enum WordFormats{ } -enum Orientation{ +enum Orientation { ///Specifies the Landscape property in pageSettings.orientation to get specified layout. Landscape, @@ -34493,7 +34507,7 @@ enum Orientation{ } -enum PaperSize{ +enum PaperSize { ///Specifies the A3 as value in pageSettings.paperSize to get specified size. A3, @@ -34530,7 +34544,7 @@ enum PaperSize{ } -enum PrintOptions{ +enum PrintOptions { ///Specifies the Default property in printOptions. Default, @@ -34543,7 +34557,7 @@ enum PrintOptions{ } -enum ProcessingMode{ +enum ProcessingMode { ///Specifies the Remote property in processingMode. Remote, @@ -34553,7 +34567,7 @@ enum ProcessingMode{ } -enum RenderMode{ +enum RenderMode { ///Specifies the Default property in RenderMode to get default output. Default, @@ -34566,7 +34580,7 @@ enum RenderMode{ } -enum ToolbarItems{ +enum ToolbarItems { ///Specifies the Print as value in ToolbarItems to get specified item. Print, @@ -34600,11 +34614,10 @@ enum ToolbarItems{ class TreeGrid extends ej.Widget { static fn: TreeGrid; - constructor(element: JQuery, options?: TreeGrid.Model); - constructor(element: Element, options?: TreeGrid.Model); + constructor(element: JQuery | Element, options?: TreeGrid.Model); static Locale: any; - model:TreeGrid.Model; - defaults:TreeGrid.Model; + model: TreeGrid.Model; + defaults: TreeGrid.Model; /** Add a new row in TreeGrid, while allowAdding is set to true * @param {any} Item to add in TreeGrid row. @@ -34624,11 +34637,11 @@ class TreeGrid extends ej.Widget { * @param {boolean} Defines that we need to preserve the previously selected cells or not * @returns {void} */ - selectCells(Indexes: Array, preservePreviousSelectedCell: boolean): void; + selectCells(Indexes: any[], preservePreviousSelectedCell: boolean): void; /** To rename a column with the specified name * @param {number} Index of the column to be renamed - * @param {string} Header text of the column + * @param {string} Header text of the column * @returns {void} */ renameColumn(columnIndex: number, name: string): void; @@ -34667,7 +34680,7 @@ class TreeGrid extends ej.Widget { * @param {any} Pass which data you want to show in tree grid * @returns {void} */ - refresh(dataSource: Array, query: any): void; + refresh(dataSource: any[], query: any): void; /** Freeze all the columns preceding to the column specified by the field name. * @param {string} Freeze all Columns before this field column. @@ -34713,7 +34726,7 @@ class TreeGrid extends ej.Widget { */ reorderColumn(fieldName: string, targetIndex: string): void; } -export module TreeGrid{ +export namespace TreeGrid { export interface Model { @@ -34732,7 +34745,8 @@ export interface Model { */ allowDragAndDrop?: boolean; - /** Enables or disables the ability to filter the data on all the columns. Enabling this property will display a row with editor controls corresponding to each column. You can restrict filtering on particular column by disabling this property directly on that column instance itself. + /** Enables or disables the ability to filter the data on all the columns. Enabling this property will display a row with editor controls corresponding to each column. + * You can restrict filtering on particular column by disabling this property directly on that column instance itself. * @Default {false} */ allowFiltering?: boolean; @@ -34772,12 +34786,12 @@ export interface Model { /** Option for adding columns; each column has the option to bind to a field in the dataSource. */ - columns?: Array; + columns?: Column[]; /** To Specify the column fields to be displayed in the dialog while inserting a column using column menu. * @Default {[]} */ - columnDialogFields?: Array; + columnDialogFields?: any[]; /** Options for displaying and customizing context menu items. */ @@ -34790,7 +34804,7 @@ export interface Model { /** Specifies hierarchical or self-referential data to populate the TreeGrid. * @Default {null} */ - dataSource?: Array; + dataSource?: any[]; /** Specifies whether to wrap the header text when it is overflown i.e., when it exceeds the header width. * @Default {none} @@ -34893,7 +34907,8 @@ export interface Model { */ showColumnOptions?: boolean; - /** Controls the visibility of the menu button, which is displayed on the column header. Clicking on this button will show a popup menu. When you choose Columns item from this popup, a list box with column names will be shown, from which you can select/deselect a column name to control the visibility of the respective columns. + /** Controls the visibility of the menu button, which is displayed on the column header. Clicking on this button will show a popup menu. When you choose Columns item from this popup, + * a list box with column names will be shown, from which you can select/deselect a column name to control the visibility of the respective columns. * @Default {false} */ showColumnChooser?: boolean; @@ -34930,7 +34945,7 @@ export interface Model { /** Specifies the summary row collection object to be displayed * @Default {[]} */ - summaryRows?: Array; + summaryRows?: any[]; /** Specifies whether to show tooltip when mouse is hovered on the cell. * @Default {true} @@ -34960,88 +34975,88 @@ export interface Model { treeColumnIndex?: number; /** Triggered before every success event of TreeGrid action. */ - actionBegin? (e: ActionBeginEventArgs): void; + actionBegin?(e: ActionBeginEventArgs): void; /** Triggered for every TreeGrid action success event. */ - actionComplete? (e: ActionCompleteEventArgs): void; + actionComplete?(e: ActionCompleteEventArgs): void; /** Triggered while enter the edit mode in the TreeGrid cell */ - beginEdit? (e: BeginEditEventArgs): void; + beginEdit?(e: BeginEditEventArgs): void; /** Triggered after collapsed the TreeGrid record */ - collapsed? (e: CollapsedEventArgs): void; + collapsed?(e: CollapsedEventArgs): void; /** Triggered while collapsing the TreeGrid record */ - collapsing? (e: CollapsingEventArgs): void; + collapsing?(e: CollapsingEventArgs): void; /** Triggered while clicking a row, even when allowSelection property is disabled. */ - recordClick? (e: RecordClickEventArgs): void; + recordClick?(e: RecordClickEventArgs): void; /** Triggered when you start to drag a column */ - columnDragStart? (e: ColumnDragStartEventArgs): void; + columnDragStart?(e: ColumnDragStartEventArgs): void; /** Triggered while dragging a column */ - columnDrag? (e: ColumnDragEventArgs): void; + columnDrag?(e: ColumnDragEventArgs): void; /** Triggered when a column is dropped */ - columnDrop? (e: ColumnDropEventArgs): void; + columnDrop?(e: ColumnDropEventArgs): void; /** Triggered after a column resized */ - columnResized? (e: ColumnResizedEventArgs): void; + columnResized?(e: ColumnResizedEventArgs): void; /** Triggered while start to resize a column */ - columnResizeStart? (e: ColumnResizeStartEventArgs): void; + columnResizeStart?(e: ColumnResizeStartEventArgs): void; /** Triggered when a column has been resized */ - columnResizeEnd? (e: ColumnResizeEndEventArgs): void; + columnResizeEnd?(e: ColumnResizeEndEventArgs): void; /** Triggered while Context Menu is rendered in TreeGrid control */ - contextMenuOpen? (e: ContextMenuOpenEventArgs): void; + contextMenuOpen?(e: ContextMenuOpenEventArgs): void; /** Triggered when TreeGrid is rendered completely */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Triggered after saved the modified cellValue in TreeGrid */ - endEdit? (e: EndEditEventArgs): void; + endEdit?(e: EndEditEventArgs): void; /** Triggered after expand the record */ - expanded? (e: ExpandedEventArgs): void; + expanded?(e: ExpandedEventArgs): void; /** Triggered while expanding the TreeGrid record */ - expanding? (e: ExpandingEventArgs): void; + expanding?(e: ExpandingEventArgs): void; /** Triggered while Treegrid is loaded */ - load? (e: LoadEventArgs): void; + load?(e: LoadEventArgs): void; /** Triggered while rendering each cell in the TreeGrid */ - queryCellInfo? (e: QueryCellInfoEventArgs): void; + queryCellInfo?(e: QueryCellInfoEventArgs): void; /** Triggered while rendering each row */ - rowDataBound? (e: RowDataBoundEventArgs): void; + rowDataBound?(e: RowDataBoundEventArgs): void; /** Triggered while dragging a row in TreeGrid control */ - rowDrag? (e: RowDragEventArgs): void; + rowDrag?(e: RowDragEventArgs): void; /** Triggered while start to drag row in TreeGrid control */ - rowDragStart? (e: RowDragStartEventArgs): void; + rowDragStart?(e: RowDragStartEventArgs): void; /** Triggered while drop a row in TreeGrid control */ - rowDragStop? (e: RowDragStopEventArgs): void; + rowDragStop?(e: RowDragStopEventArgs): void; /** Triggered before selecting a cell */ - cellSelecting? (e: CellSelectingEventArgs): void; + cellSelecting?(e: CellSelectingEventArgs): void; /** Triggered after selected a cell */ - cellSelected? (e: CellSelectedEventArgs): void; + cellSelected?(e: CellSelectedEventArgs): void; /** Triggered after the row is selected. */ - rowSelected? (e: RowSelectedEventArgs): void; + rowSelected?(e: RowSelectedEventArgs): void; /** Triggered before the row is going to be selected. */ - rowSelecting? (e: RowSelectingEventArgs): void; + rowSelecting?(e: RowSelectingEventArgs): void; /** Triggered when toolbar item is clicked in TreeGrid. */ - toolbarClick? (e: ToolbarClickEventArgs): void; + toolbarClick?(e: ToolbarClickEventArgs): void; } export interface ActionBeginEventArgs { @@ -35420,7 +35435,7 @@ export interface ContextMenuOpenEventArgs { /** Returns the default context menu items to which we add custom items. */ - contextMenuItems?: Array; + contextMenuItems?: any[]; /** Returns the TreeGrid model. */ @@ -35888,11 +35903,11 @@ export interface Column { /** Gets or sets a value for treegrid column width */ - width?: Number; + width?: number; /** Specifies the header template value for the column header */ - headerTemplateID?: String; + headerTemplateID?: string; /** Specifies the display format of a column * @Default {null} @@ -35921,7 +35936,7 @@ export interface Column { /** Specifies the template for the TreeGrid column */ - templateID?: String; + templateID?: string; /** Enables or disables the ability to edit a row or cell. * @Default {false} @@ -35939,7 +35954,7 @@ export interface ContextMenuSettings { /** Option for adding items to context menu. * @Default {[]} */ - contextMenuItems?: Array; + contextMenuItems?: any[]; /** Shows/hides the context menu. * @Default {false} @@ -35957,7 +35972,7 @@ export interface DragTooltip { /** Option to add field names whose corresponding values in the dragged row needs to be shown in the preview tooltip. * @Default {[]} */ - tooltipItems?: Array; + tooltipItems?: any[]; /** Custom template for that tooltip that is shown while dragging a row. * @Default {null} @@ -36021,7 +36036,7 @@ export interface FilterSettings { /** Specifies the column collection for filtering the TreeGrid content on initial load * @Default {[]} */ - filteredColumns?: Array; + filteredColumns?: any[]; } export interface PageSettings { @@ -36098,7 +36113,7 @@ export interface SortSettings { /** Option to add columns based on which the rows have to be sorted recursively. * @Default {[]} */ - sortedColumns?: Array; + sortedColumns?: any[]; } export interface ToolbarSettings { @@ -36111,10 +36126,10 @@ export interface ToolbarSettings { /** Specifies the list of toolbar items to be rendered in TreeGrid toolbar * @Default {[]} */ - toolbarItems?: Array; + toolbarItems?: any[]; } -enum EditingType{ +enum EditingType { ///It Specifies String edit type. String, @@ -36139,7 +36154,7 @@ enum EditingType{ } -enum BeginEditAction{ +enum BeginEditAction { ///you can begin the editing at double click DblClick, @@ -36149,7 +36164,7 @@ enum BeginEditAction{ } -enum EditMode{ +enum EditMode { ///you can edit a cell. CellEditing, @@ -36159,7 +36174,7 @@ enum EditMode{ } -enum RowPosition{ +enum RowPosition { ///you can add a new row at top. Top, @@ -36178,7 +36193,7 @@ enum RowPosition{ } -enum PageSizeMode{ +enum PageSizeMode { ///To count all the parent and child records. All, @@ -36188,7 +36203,7 @@ enum PageSizeMode{ } -enum SelectionMode{ +enum SelectionMode { ///you can select a row. Row, @@ -36198,7 +36213,7 @@ enum SelectionMode{ } -enum SelectionType{ +enum SelectionType { ///you can select a single row. Single, @@ -36214,11 +36229,10 @@ enum SelectionType{ class GroupButton extends ej.Widget { static fn: GroupButton; - constructor(element: JQuery, options?: GroupButton.Model); - constructor(element: Element, options?: GroupButton.Model); + constructor(element: JQuery | Element, options?: GroupButton.Model); static Locale: any; - model:GroupButton.Model; - defaults:GroupButton.Model; + model: GroupButton.Model; + defaults: GroupButton.Model; /** Remove the selection state of the specified the button element from the GroupButton * @param {JQuery} Specific button element @@ -36302,7 +36316,7 @@ class GroupButton extends ej.Widget { */ showItem(element: JQuery): void; } -export module GroupButton{ +export namespace GroupButton { export interface Model { @@ -36375,19 +36389,19 @@ export interface Model { width?: string|number; /** Triggered before any button element in the GroupButton get selected. */ - beforeSelect? (e: BeforeSelectEventArgs): void; + beforeSelect?(e: BeforeSelectEventArgs): void; /** Fires after GroupButton control is created.If the user want to perform any operation after the button control creation then the user can make use of this create event. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Fires when the GroupButton is destroyed successfully.If the user want to perform any operation after the destroy button control then the user can make use of this destroy event. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Triggered once the key is pressed, when the control is in focused state. */ - keyPress? (e: KeyPressEventArgs): void; + keyPress?(e: KeyPressEventArgs): void; /** Triggered when the button element get selected. */ - select? (e: SelectEventArgs): void; + select?(e: SelectEventArgs): void; } export interface BeforeSelectEventArgs { @@ -36537,21 +36551,19 @@ export interface SelectEventArgs { status?: boolean; } } -enum GroupButtonMode -{ -//Sets the GroupButton to work as checkbox mode +enum GroupButtonMode { +//Sets the GroupButton to work as checkbox mode CheckBox, -//Sets the RadioButton to work as radio button mode +//Sets the RadioButton to work as radio button mode RadioButton, } class NavigationDrawer extends ej.Widget { static fn: NavigationDrawer; - constructor(element: JQuery, options?: NavigationDrawer.Model); - constructor(element: Element, options?: NavigationDrawer.Model); + constructor(element: JQuery | Element, options?: NavigationDrawer.Model); static Locale: any; - model:NavigationDrawer.Model; - defaults:NavigationDrawer.Model; + model: NavigationDrawer.Model; + defaults: NavigationDrawer.Model; /** To close the navigation drawer control * @returns {void} @@ -36573,7 +36585,7 @@ class NavigationDrawer extends ej.Widget { */ toggle(): void; } -export module NavigationDrawer{ +export namespace NavigationDrawer { export interface Model { @@ -36587,7 +36599,8 @@ export interface Model { */ contentId?: string; - /** Sets the root class for NavigationDrawer theme. This cssClass API helps to use custom skinning option for NavigationDrawer control. By defining the root class using this API, we need to include this root class in CSS. + /** Sets the root class for NavigationDrawer theme. This cssClass API helps to use custom skinning option for NavigationDrawer control. + * By defining the root class using this API, we need to include this root class in CSS. */ cssClass?: string; @@ -36604,7 +36617,7 @@ export interface Model { /** Specifies the listview items as an array of object. * @Default {[]} */ - items?: Array; + items?: any[]; /** Sets all the properties of listview to render in navigation drawer */ @@ -36635,22 +36648,22 @@ export interface Model { isPaneOpen?: boolean; /** Event triggers after the AJAX content loaded completely. */ - ajaxComplete? (e: AjaxCompleteEventArgs): void; + ajaxComplete?(e: AjaxCompleteEventArgs): void; /** Event triggers when the AJAX request failed. */ - ajaxError? (e: AjaxErrorEventArgs): void; + ajaxError?(e: AjaxErrorEventArgs): void; /** Event triggers after the AJAX content loaded successfully. */ - ajaxSuccess? (e: AjaxSuccessEventArgs): void; + ajaxSuccess?(e: AjaxSuccessEventArgs): void; /** Event triggers before the control gets closed. */ - beforeClose? (e: BeforeCloseEventArgs): void; + beforeClose?(e: BeforeCloseEventArgs): void; /** Event triggers when the control open. */ - open? (e: OpenEventArgs): void; + open?(e: OpenEventArgs): void; /** Event triggers when the Swipe happens. */ - swipe? (e: SwipeEventArgs): void; + swipe?(e: SwipeEventArgs): void; } export interface AjaxCompleteEventArgs { @@ -36789,11 +36802,10 @@ export interface AjaxSettings { class RadialMenu extends ej.Widget { static fn: RadialMenu; - constructor(element: JQuery, options?: RadialMenu.Model); - constructor(element: Element, options?: RadialMenu.Model); + constructor(element: JQuery | Element, options?: RadialMenu.Model); static Locale: any; - model:RadialMenu.Model; - defaults:RadialMenu.Model; + model: RadialMenu.Model; + defaults: RadialMenu.Model; /** To hide the radialmenu * @returns {void} @@ -36825,7 +36837,7 @@ class RadialMenu extends ej.Widget { * @param {Array} Index of the Radialmenu to be enabled. * @returns {void} */ - enableItemsByIndices(itemIndices: Array): void; + enableItemsByIndices(itemIndices: any[]): void; /** To disable menu item using index * @param {number} Index of the Radialmenu to be disabled. @@ -36837,7 +36849,7 @@ class RadialMenu extends ej.Widget { * @param {Array} items of the Radialmenu to disable. * @returns {void} */ - disableItemsByIndices(itemIndices: Array): void; + disableItemsByIndices(itemIndices: any[]): void; /** To enable menu item using item text * @param {string} item of the Radialmenu item to enable. @@ -36855,13 +36867,13 @@ class RadialMenu extends ej.Widget { * @param {Array} items of the Radialmenu item to enable. * @returns {void} */ - enableItems(items: Array): void; + enableItems(items: any[]): void; /** To disable menu items using item texts * @param {Array} items of the Radialmenu item to disable. * @returns {void} */ - disableItems(items: Array): void; + disableItems(items: any[]): void; /** To update menu item badge value * @param {number} The index value to add the given items at the specified index. If index is not specified, the given value will not be updated. @@ -36882,7 +36894,7 @@ class RadialMenu extends ej.Widget { */ hideBadge(index: number): void; } -export module RadialMenu{ +export namespace RadialMenu { export interface Model { @@ -36894,7 +36906,8 @@ export interface Model { */ backImageClass?: string; - /** Sets the root class for RadialMenu theme. This cssClass API helps to use custom skinning option for RadialMenu control. By defining the root class using this API, we need to include this root class in CSS. + /** Sets the root class for RadialMenu theme. This cssClass API helps to use custom skinning option for RadialMenu control. By defining the root class using this API, + * we need to include this root class in CSS. */ cssClass?: string; @@ -36908,7 +36921,7 @@ export interface Model { /** Specify the items of radial menu */ - items?: Array; + items?: Item[]; /** Specifies the radius of radial menu */ @@ -36923,13 +36936,13 @@ export interface Model { position?: any; /** Event triggers when we click an item. */ - click? (e: ClickEventArgs): void; + click?(e: ClickEventArgs): void; /** Event triggers when the menu is opened. */ - open? (e: OpenEventArgs): void; + open?(e: OpenEventArgs): void; /** Event triggers when the menu is closed. */ - close? (e: CloseEventArgs): void; + close?(e: CloseEventArgs): void; } export interface ClickEventArgs { @@ -37000,7 +37013,7 @@ export interface ItemsSliderSettings { /** Specifies the sliderSettings ticks values of nested radial menu items. */ - ticks?: Array; + ticks?: any[]; /** Specifies the sliderSettings stroke Width value. */ @@ -37043,17 +37056,16 @@ export interface Item { /** Specifies to add sub level items . */ - items?: Array; + items?: any[]; } } class Tile extends ej.Widget { static fn: Tile; - constructor(element: JQuery, options?: Tile.Model); - constructor(element: Element, options?: Tile.Model); + constructor(element: JQuery | Element, options?: Tile.Model); static Locale: any; - model:Tile.Model; - defaults:Tile.Model; + model: Tile.Model; + defaults: Tile.Model; /** Update the image template of tile item to another one. * @param {string} UpdateTemplate by using id @@ -37062,7 +37074,7 @@ class Tile extends ej.Widget { */ updateTemplate(id: string, index: number): void; } -export module Tile{ +export namespace Tile { export interface Model { @@ -37110,7 +37122,7 @@ export interface Model { /** Set the localization culture for Tile Widget. */ - locale?: String; + locale?: string; /** Section for liveTile specific functionalities. */ @@ -37142,10 +37154,10 @@ export interface Model { backgroundColor?: string; /** Event triggers when the mouseDown happens in the tile */ - mouseDown? (e: MouseDownEventArgs): void; + mouseDown?(e: MouseDownEventArgs): void; /** Event triggers when the mouseUp happens in the tile */ - mouseUp? (e: MouseUpEventArgs): void; + mouseUp?(e: MouseUpEventArgs): void; } export interface MouseDownEventArgs { @@ -37166,7 +37178,7 @@ export interface MouseDownEventArgs { */ text?: string; - /** returns the index of current tile item + /** returns the index of current tile item */ index?: number; } @@ -37189,7 +37201,7 @@ export interface MouseUpEventArgs { */ text?: boolean; - /** returns the index of current tile item + /** returns the index of current tile item */ index?: number; } @@ -37265,17 +37277,17 @@ export interface LiveTile { /** Specifies liveTile images in CSS classes. * @Default {null} */ - imageClass?: Array; + imageClass?: any[]; /** Specifies liveTile images in templates. * @Default {null} */ - imageTemplateId?: Array; + imageTemplateId?: any[]; /** Specifies liveTile images in CSS classes. * @Default {null} */ - imageUrl?: Array; + imageUrl?: any[]; /** Specifies liveTile type for Tile. See orientation * @Default {flip} @@ -37290,10 +37302,10 @@ export interface LiveTile { /** Sets the text to each living tile * @Default {Null} */ - text?: Array; + text?: any[]; } -enum BadgePosition{ +enum BadgePosition { ///To set the topright position of tile badge Topright, @@ -37303,7 +37315,7 @@ enum BadgePosition{ } -enum CaptionAlignment{ +enum CaptionAlignment { ///To set the normal alignment of text in tile control Normal, @@ -37319,7 +37331,7 @@ enum CaptionAlignment{ } -enum CaptionPosition{ +enum CaptionPosition { ///To set the inner top position of the tile text Innertop, @@ -37332,7 +37344,7 @@ enum CaptionPosition{ } -enum ImagePosition{ +enum ImagePosition { ///To set the center position of tile image Center, @@ -37366,7 +37378,7 @@ enum ImagePosition{ } -enum liveTileType{ +enum liveTileType { ///To set flip type of liveTile for tile control Flip, @@ -37379,7 +37391,7 @@ enum liveTileType{ } -enum TileSize{ +enum TileSize { ///To set the medium size for tile control Medium, @@ -37398,11 +37410,10 @@ enum TileSize{ class Signature extends ej.Widget { static fn: Signature; - constructor(element: JQuery, options?: Signature.Model); - constructor(element: Element, options?: Signature.Model); + constructor(element: JQuery | Element, options?: Signature.Model); static Locale: any; - model:Signature.Model; - defaults:Signature.Model; + model: Signature.Model; + defaults: Signature.Model; /** Clears the strokes in the signature. * @returns {void} @@ -37449,7 +37460,7 @@ class Signature extends ej.Widget { */ undo(): void; } -export module Signature{ +export namespace Signature { export interface Model { @@ -37507,16 +37518,16 @@ export interface Model { width?: string; /** Triggers when the stroke is changed. */ - change? (e: ChangeEventArgs): void; + change?(e: ChangeEventArgs): void; /** Triggered when the pointer is clicked or touched in the signature canvas. */ - mouseDown? (e: MouseDownEventArgs): void; + mouseDown?(e: MouseDownEventArgs): void; /** Triggered when the pointer is moved in the signature canvas. */ - mouseMove? (e: MouseMoveEventArgs): void; + mouseMove?(e: MouseMoveEventArgs): void; /** Triggered when the pointer is released after click or touch in the signature canvas. */ - mouseUp? (e: MouseUpEventArgs): void; + mouseUp?(e: MouseUpEventArgs): void; } export interface ChangeEventArgs { @@ -37595,7 +37606,7 @@ export interface MouseUpEventArgs { value?: any; } -enum SaveImageFormat{ +enum SaveImageFormat { ///To save the signature image with PNG format only. PNG, @@ -37614,11 +37625,10 @@ enum SaveImageFormat{ class RadialSlider extends ej.Widget { static fn: RadialSlider; - constructor(element: JQuery, options?: RadialSlider.Model); - constructor(element: Element, options?: RadialSlider.Model); + constructor(element: JQuery | Element, options?: RadialSlider.Model); static Locale: any; - model:RadialSlider.Model; - defaults:RadialSlider.Model; + model: RadialSlider.Model; + defaults: RadialSlider.Model; /** To show the radialslider * @returns {void} @@ -37630,7 +37640,7 @@ class RadialSlider extends ej.Widget { */ hide(): void; } -export module RadialSlider{ +export namespace RadialSlider { export interface Model { @@ -37639,7 +37649,8 @@ export interface Model { */ autoOpen?: boolean; - /** Sets the root class for RadialSlider theme. This cssClass API helps to use custom skinning option for RadialSlider control. By defining the root class using this API, we need to include this root class in CSS. + /** Sets the root class for RadialSlider theme. This cssClass API helps to use custom skinning option for RadialSlider control. + * By defining the root class using this API, we need to include this root class in CSS. */ cssClass?: string; @@ -37700,7 +37711,7 @@ export interface Model { /** Specifies the ticks value of radial slider */ - ticks?: Array; + ticks?: any[]; /** Specifies the value of radial slider * @Default {10} @@ -37708,142 +37719,142 @@ export interface Model { value?: number; /** Event triggers when the change occurs. */ - change? (e: ChangeEventArgs): void; + change?(e: ChangeEventArgs): void; /** Event triggers when the radial slider is created. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Event triggers when the mouse pointer is dragged over the radial slider. */ - mouseover? (e: MouseoverEventArgs): void; + mouseover?(e: MouseoverEventArgs): void; /** Event triggers when the Radial slider slides. */ - slide? (e: SlideEventArgs): void; + slide?(e: SlideEventArgs): void; /** Event triggers when the radial slider starts. */ - start? (e: StartEventArgs): void; + start?(e: StartEventArgs): void; /** Event triggers when the radial slider stops. */ - stop? (e: StopEventArgs): void; + stop?(e: StopEventArgs): void; } export interface ChangeEventArgs { - /** returns the Radialslider model + /** returns the Radialslider model */ model?: any; - /** if the event should be canceled; otherwise, false. + /** if the event should be canceled; otherwise, false. */ cancel?: boolean; - /** returns the initial value of Radial slider + /** returns the initial value of Radial slider */ oldValue?: number; - /** returns the name of the event + /** returns the name of the event */ type?: string; - /** returns the current value of the Radial slider + /** returns the current value of the Radial slider */ value?: number; } export interface CreateEventArgs { - /** if the event should be canceled; otherwise, false. + /** if the event should be canceled; otherwise, false. */ cancel?: boolean; - /** returns the Radialslider model + /** returns the Radialslider model */ model?: any; - /** returns the name of the event + /** returns the name of the event */ type?: string; } export interface MouseoverEventArgs { - /** if the event should be canceled; otherwise, false. + /** if the event should be canceled; otherwise, false. */ cancel?: boolean; - /** returns the Radialslider model + /** returns the Radialslider model */ model?: any; - /** returns the value selected + /** returns the value selected */ selectedValue?: number; - /** returns the name of the event + /** returns the name of the event */ type?: string; - /** returns the current value selected in Radial slider + /** returns the current value selected in Radial slider */ value?: number; } export interface SlideEventArgs { - /** if the event should be canceled; otherwise, false. + /** if the event should be canceled; otherwise, false. */ cancel?: boolean; - /** returns the Radialslider model + /** returns the Radialslider model */ model?: any; - /** returns the value selected in Radial slider + /** returns the value selected in Radial slider */ selectedValue?: number; - /** returns the name of the event + /** returns the name of the event */ type?: string; - /** returns the currently selected value + /** returns the currently selected value */ value?: number; } export interface StartEventArgs { - /** if the event should be canceled; otherwise, false. + /** if the event should be canceled; otherwise, false. */ cancel?: boolean; - /** returns the Radialslider model + /** returns the Radialslider model */ model?: any; - /** returns the name of the event + /** returns the name of the event */ type?: string; - /** returns the current value selected in Radial slider + /** returns the current value selected in Radial slider */ value?: number; } export interface StopEventArgs { - /** if the event should be canceled; otherwise, false. + /** if the event should be canceled; otherwise, false. */ cancel?: boolean; - /** returns the Radialslider model + /** returns the Radialslider model */ model?: any; - /** returns the name of the event + /** returns the name of the event */ type?: string; - /** returns the current value selected in Radial slider + /** returns the current value selected in Radial slider */ value?: number; } @@ -37851,11 +37862,10 @@ export interface StopEventArgs { class Spreadsheet extends ej.Widget { static fn: Spreadsheet; - constructor(element: JQuery, options?: Spreadsheet.Model); - constructor(element: Element, options?: Spreadsheet.Model); + constructor(element: JQuery | Element, options?: Spreadsheet.Model); static Locale: any; - model:Spreadsheet.Model; - defaults:Spreadsheet.Model; + model: Spreadsheet.Model; + defaults: Spreadsheet.Model; /** This method is used to add custom formulas in Spreadsheet. * @param {string} Pass the name of the formula. @@ -37870,28 +37880,28 @@ class Spreadsheet extends ej.Widget { addNewSheet(): void; /** It is used to clear all the data and format in the specified range of cells in Spreadsheet. - * @param {string|Array} Optional. If range is specified, then it will clear all content in the specified range else it will use the current selected range. + * @param {string|Array} Optional. If range is specified, then it will clear all content in the specified range else it will use the current selected range. * @returns {void} */ - clearAll(range?: string|Array): void; + clearAll(range?: string|any[]): void; /** This property is used to clear all the formats applied in the specified range in Spreadsheet. - * @param {string|Array} Optional. If range is specified, then it will clear all format in the specified range else it will use the current selected range. + * @param {string|Array} Optional. If range is specified, then it will clear all format in the specified range else it will use the current selected range. * @returns {void} */ - clearAllFormat(range?: string|Array): void; + clearAllFormat(range?: string|any[]): void; /** Used to clear the applied border in the specified range in Spreadsheet. * @param {string|Array} Optional. If range is specified, then it will clear border in the specified range else it will use the current selected range. * @returns {void} */ - clearBorder(range?: string|Array): void; + clearBorder(range?: string|any[]): void; /** This property is used to clear the contents in the specified range in Spreadsheet. - * @param {string|Array} Optional. If the range is specified, then it will clear the content in the specified range else it will use the current selected range. + * @param {string|Array} Optional. If the range is specified, then it will clear the content in the specified range else it will use the current selected range. * @returns {void} */ - clearContents(range?: string|Array): void; + clearContents(range?: string|any[]): void; /** This method is used to remove only the data in the range denoted by the specified range name. * @param {string} Pass the defined rangeSettings property name. @@ -37900,15 +37910,15 @@ class Spreadsheet extends ej.Widget { clearRange(rangeName: string): void; /** It is used to remove data in the specified range of cells based on the defined property. - * @param {Array|string} Optional. If range is specified, it will clear data for the specified range else it will use the current selected range. - * @param {string} Optional. If property is specified, it will remove the specified property in the range else it will remove default properties + * @param {Array|string} Optional. If range is specified, it will clear data for the specified range else it will use the current selected range. + * @param {string} Optional. If property is specified, it will remove the specified property in the range else it will remove default properties * @param {any} Optional. - * @param {boolean} Optional. pass {{'`true`' | markdownify}}, if you want to skip the hidden rows + * @param {boolean} Optional. pass {{'`true`' | markdownify}}, if you want to skip the hidden rows * @param {any} Optional. Pass the status to perform undo and redo operation. * @param {any} Optional. It specifies whether to skip element processing or not. * @returns {void} */ - clearRangeData(range?: Array|string, property?: string, cells?: any, skipHiddenRow?: boolean, status?: any, skipCell?: any): void; + clearRangeData(range?: any[]|string, property?: string, cells?: any, skipHiddenRow?: boolean, status?: any, skipCell?: any): void; /** This method is used to clear undo and redo collections in the Spreadsheet. * @returns {void} @@ -37962,7 +37972,7 @@ class Spreadsheet extends ej.Widget { * @param {Function} Pass the function that you want to perform range edit. * @returns {void} */ - editRange(rangeName: string, fn: Function): void; + editRange(rangeName: string, fn: any): void; /** This method is used to get the activation panel in the Spreadsheet. * @returns {HTMLElement} @@ -38032,16 +38042,16 @@ class Spreadsheet extends ej.Widget { getRange(range: string, sheetIdx: number, skipHiddenRow?: boolean): HTMLElement; /** This method is used to get the data in specified range in Spreadsheet. - * @param {any} Optional. Pass the range, property, sheetIdx, valueOnly in options. + * @param {any} Optional. Pass the range, property, sheetIdx, valueOnly in options. * @returns {Array} */ - getRangeData(options?: any): Array; + getRangeData(options?: any): any[]; /** This method is used to get the range indices array based on the specified alpha range in Spreadsheet. * @param {string} Pass the alpha range that you want to get range indices. * @returns {Array} */ - getRangeIndices(range: string): Array; + getRangeIndices(range: string): any[]; /** This method is used to get the sheet details based on the given sheet index in Spreadsheet. * @param {number} Pass the sheet index to get the sheet object. @@ -38058,7 +38068,7 @@ class Spreadsheet extends ej.Widget { /** This method is used to get all the sheets in workbook. * @returns {Array} */ - getSheets(): Array; + getSheets(): any[]; /** This method is used to send a paging request to the specified sheet Index in the Spreadsheet. * @param {number} Pass the sheet index to perform paging at specified sheet index @@ -38147,7 +38157,7 @@ class Spreadsheet extends ej.Widget { * @param {string} Optional. By default is {{'`true`' | markdownify}}. If it is {{'`false`' | markdownify}} locked cells are unlocked. * @returns {void} */ - lockCells(range: string|Array, isLocked?: string): void; + lockCells(range: string|any[], isLocked?: string): void; /** This method is used to merge cells by across in the Spreadsheet. * @param {string} Optional. To pass the cell range or selected cells are process. @@ -38161,7 +38171,7 @@ class Spreadsheet extends ej.Widget { * @param {boolean} Optional. If pass {{'`true`' | markdownify}} it does not show alert. * @returns {void} */ - mergeCells(range?: string|Array, alertStatus?: boolean): void; + mergeCells(range?: string|any[], alertStatus?: boolean): void; /** This method is used to select a cell or range in the Spreadsheet. * @param {any} Pass the start cell to perform selection. @@ -38214,7 +38224,7 @@ class Spreadsheet extends ej.Widget { * @param {string|Array} Pass the range. * @returns {void} */ - removeReadOnly(range?: string|Array): void; + removeReadOnly(range?: string|any[]): void; /** This method is used to save JSON data in Spreadsheet. * @returns {any} @@ -38252,7 +38262,7 @@ class Spreadsheet extends ej.Widget { * @param {Array|any} Pass the row index and height of the rows. * @returns {void} */ - setHeightToRows(heightColl: Array|any): void; + setHeightToRows(heightColl: any[]|any): void; /** This method is used to set the hyperlink in selected cells of the current sheet. * @param {string|Array} If range is specified, it will set the hyperlink in range of the cells. @@ -38260,13 +38270,13 @@ class Spreadsheet extends ej.Widget { * @param {number} If we pass cellAddress then which sheet to be navigate in the applied link. * @returns {void} */ - setHyperlink(range: string|Array, link: any, sheetIdx: number): void; + setHyperlink(range: string|any[], link: any, sheetIdx: number): void; /** This method is used to set the readonly option for the specified range. * @param {string|Array} Pass the range. * @returns {void} */ - setReadOnly(range?: string|Array): void; + setReadOnly(range?: string|any[]): void; /** This method is used to set the focus to the Spreadsheet. * @returns {void} @@ -38277,7 +38287,7 @@ class Spreadsheet extends ej.Widget { * @param {Array|any} Pass the column index and width of the columns. * @returns {void} */ - setWidthToColumns(widthColl: Array|any): void; + setWidthToColumns(widthColl: any[]|any): void; /** This method is used to rename the active sheet. * @param {string} Pass the sheet name that you want to change the current active sheet name. @@ -38349,14 +38359,14 @@ class Spreadsheet extends ej.Widget { * @param {Array|string} Optional. If the range is specified, then it will update unwrap in the specified range else it will use the current selected range. * @returns {void} */ - unWrapText(range?: Array|string): void; + unWrapText(range?: any[]|string): void; /** This method is used to update the data for the specified range of cells in the Spreadsheet. * @param {any} Pass the cells data that you want to update. - * @param {Array|string} Optional. If range is specified, it will update data for the specified range else it will use the current selected range. + * @param {Array|string} Optional. If range is specified, it will update data for the specified range else it will use the current selected range. * @returns {void} */ - updateData(data: any, range?: Array|string): void; + updateData(data: any, range?: any[]|string): void; /** This method is used to update the formula bar in the Spreadsheet. * @returns {void} @@ -38382,13 +38392,13 @@ class Spreadsheet extends ej.Widget { * @param {any} Optional. It specifies whether to skip element processing or not. * @returns {void} */ - updateUniqueData(data: any, range?: Array|string, skipCell?: any): void; + updateUniqueData(data: any, range?: any[]|string, skipCell?: any): void; /** This method is used to wrap the selected range of cells in the Spreadsheet. * @param {Array|string} Optional. If the range is specified, then it will update wrap in the specified range else it will use the current selected range. * @returns {void} */ - wrapText(range?: Array|string): void; + wrapText(range?: any[]|string): void; XLCellType: Spreadsheet.XLCellType; @@ -38444,7 +38454,7 @@ class Spreadsheet extends ej.Widget { XLValidate: Spreadsheet.XLValidate; } -export module Spreadsheet{ +export namespace Spreadsheet { export interface XLCellType { @@ -38454,14 +38464,14 @@ export interface XLCellType { * @param {number} Optional. Pass sheet index. * @returns {void} */ - addCellTypes(range: string,settings: any,sheetIdx: number): void; + addCellTypes(range: string, settings: any, sheetIdx: number): void; /** This method is used to remove cell type from the specified range of cells in the Spreadsheet. * @param {string|Array} Pass the range where you want remove cell type. * @param {number} Optional. Pass sheet index. * @returns {void} */ - removeCellTypes(range: string|Array,sheetIdx: number): void; + removeCellTypes(range: string|any[], sheetIdx: number): void; } export interface XLCFormat { @@ -38470,14 +38480,14 @@ export interface XLCFormat { * @param {Array|string} Optional. If range is specified, it will clear rules for the specified range else it will use the current selected range. * @returns {void} */ - clearCF(range: Array|string): void; + clearCF(range: any[] |string): void; /** This method is used to get the applied conditional formatting rules as array of objects based on the specified row Index and column Index in the Spreadsheet. * @param {number} Pass the row index. * @param {number} Pass the column index. * @returns {Array} */ - getCFRule(rowIdx: number,colIdx: number): Array; + getCFRule(rowIdx: number, colIdx: number): any[]; /** This method is used to set the conditional formatting rule in the Spreadsheet. * @param {any} Pass the rule to set. @@ -38493,14 +38503,14 @@ export interface XLChart { * @param {ej.datavisualization.Chart.Theme} Pass the chart theme which want to update. * @returns {void} */ - changeTheme(chartId: string,theme: ej.datavisualization.Chart.Theme): void; + changeTheme(chartId: string, theme: ej.datavisualization.Chart.Theme): void; /** This method is used to change the type of the chart in the Spreadsheet. * @param {string} Pass the chart id. * @param {any} Pass the chart type. * @returns {void} */ - changeType(chartId: string,option: any): void; + changeType(chartId: string, option: any): void; /** This method is used to change the data range of the chart in the Spreadsheet. * @param {string} Pass the chart id. @@ -38509,21 +38519,21 @@ export interface XLChart { * @param {string} Legend range of chart data. * @returns {void} */ - changeDataRange(chartId: string,xRange: string,yRange: string,lRange: string): void; + changeDataRange(chartId: string, xRange: string, yRange: string, lRange: string): void; /** This method is used to create a chart for specified range in Spreadsheet. * @param {string|Array} Optional. If range is specified, it will create chart for the specified range else it will use the current selected range. * @param {any} Optional. To pass the type of chart and chart name. * @returns {void} */ - createChart(range: string|Array,options: any): void; + createChart(range: string|any[], options: any): void; /** This method is used to refresh the chart in the Spreadsheet. * @param {string} To pass the chart Id. * @param {any} To pass the type of chart and chart name. * @returns {void} */ - refreshChart(id: string,options: any): void; + refreshChart(id: string, options: any): void; /** This method is used to resize the chart of specified id in the Spreadsheet. * @param {string} To pass the chart id. @@ -38531,14 +38541,14 @@ export interface XLChart { * @param {number} To pass the width value. * @returns {void} */ - resizeChart(id: string,height: number,width: number): void; + resizeChart(id: string, height: number, width: number): void; /** This method is used to update the chart element, such as axes, titles, data labels, grid lines and legends in the Spreadsheet. * @param {string} Pass the chart id. * @param {ej.Spreadsheet.ChartProperties} Pass chart element value which you want to update. * @returns {void} */ - updateChartElement(chartId: string,value: ej.Spreadsheet.ChartProperties): void; + updateChartElement(chartId: string, value: ej.Spreadsheet.ChartProperties): void; /** This method is used switch row to columns and vice versa for chart in the Spreadsheet. So that the data is displayed in the chart the way you want. * @param {string} Pass the chart id. @@ -38568,15 +38578,15 @@ export interface XLClipboard { export interface XLComment { /** This method is used to delete the comment in the specified range in Spreadsheet. - * @param {Array|string} Optional. If range is specified, it will delete comments for the specified range else it will use the current selected range. + * @param {Array|string} Optional. If range is specified, it will delete comments for the specified range else it will use the current selected range. * @param {number} Optional. If sheetIdx is specified, it will delete comment in specified sheet else it will use active sheet. * @param {boolean} Optional. Pass {{'`true`' | markdownify}}, if you want to skip the hidden rows data. * @returns {void} */ - deleteComment(range: Array|string,sheetIdx: number,skipHiddenRow: boolean): void; + deleteComment(range: any[]|string, sheetIdx: number, skipHiddenRow: boolean): void; /** This method is used to edit the comment in the target Cell in Spreadsheet. - * @param {any} Optional. Pass the row index and column index of the cell which contains comment. + * @param {any} Optional. Pass the row index and column index of the cell which contains comment. * @returns {void} */ editComment(targetCell: any): void; @@ -38598,13 +38608,13 @@ export interface XLComment { getComment(cell: HTMLElement): any; /** This method is used to set new comment in Spreadsheet. - * @param {string|Array} Optional. If we pass the range comment will set in the range otherwise it will set with selected cells. + * @param {string|Array} Optional. If we pass the range comment will set in the range otherwise it will set with selected cells. * @param {string} Optional. Pass the comment data. - * @param {boolean} Optional. Pass {{'`true`' | markdownify}} to show comment in edit mode - * @param {boolean} Optional. Pass {{'`true`' | markdownify}} to show the user name + * @param {boolean} Optional. Pass {{'`true`' | markdownify}} to show comment in edit mode + * @param {boolean} Optional. Pass {{'`true`' | markdownify}} to show the user name * @returns {void} */ - setComment(range: string|Array,data: string,showEditPanel: boolean,showUserName: boolean): void; + setComment(range: string|any[], data: string, showEditPanel: boolean, showUserName: boolean): void; /** This method is used to show all the comments in the Spreadsheet. * @returns {void} @@ -38626,35 +38636,35 @@ export interface XLCMenu { * @param {string} Specifies the type of operation to be performed * @returns {void} */ - addItem(target: string,itemColl: Array,operation: string): void; + addItem(target: string, itemColl: any[], operation: string): void; /** This method is used to change data source in the context menu. * @param {string} Specifies the context menu type to bind the data source. * @param {Array} Pass the data source to be binded * @returns {void} */ - changeDataSource(target: string,data: Array): void; + changeDataSource(target: string, data: any[]): void; /** This method is used to disable the items in the context menu. * @param {string} Specifies the context menu type in which the item to be disabled. * @param {Array} Specifies the Menu Item id collection to be disabled * @returns {void} */ - disableItem(target: string,idxColl: Array): void; + disableItem(target: string, idxColl: any[]): void; /** This method is used to enable the items in the context menu. * @param {string} Specifies the context menu type in which the item to be enabled. * @param {Array} Specifies the Menu Item id collection to be enabled * @returns {void} */ - enableItem(target: string,idxColl: Array): void; + enableItem(target: string, idxColl: any[]): void; /** This method is used to remove the items in the context menu. * @param {string} Specifies the context menu type in which the item to be removed. * @param {Array} Specifies the Menu Item id collection to be removed * @returns {void} */ - removeItem(target: string,idxColl: Array): void; + removeItem(target: string, idxColl: any[]): void; } export interface XLDragDrop { @@ -38664,7 +38674,7 @@ export interface XLDragDrop { * @param {any|Array} Pass the destination range to drop the dragged cells. * @returns {void} */ - moveRangeTo(sourceRange: any|Array,destinationRange: any|Array): void; + moveRangeTo(sourceRange: any|any[], destinationRange: any|any[]): void; } export interface XLDragFill { @@ -38706,24 +38716,28 @@ export interface XLEdit { * @param {boolean} Pass {{'`true`' | markdownify}}, if you want to maintain previous cell value. * @returns {void} */ - editCell(rowIdx: number,colIdx: number,oldData: boolean): void; + editCell(rowIdx: number, colIdx: number, oldData: boolean): void; /** This method is used to get the property value of particular cell, based on the row and column index in the Spreadsheet. * @param {number} Pass the row index to get the property value. * @param {number} Pass the column index to get the property value. - * @param {string} Optional. Pass the property name that you want("value", "value2", "type", "cFormatRule", "range", "thousandSeparator", "rule", "format", "border", "picture", "chart", "calcValue", "align", "hyperlink", "formats", "borders", "tformats", "tborders", "isFilterHeader", "filterState", "tableName", "comment", "formatStr", "decimalPlaces", "cellType"). + * @param {string} Optional. Pass the property name that you want("value", "value2", "type", "cFormatRule", "range", "thousandSeparator", "rule", "format", "border", "picture", + * "chart", "calcValue", "align", "hyperlink", "formats", "borders", "tformats", "tborders", "isFilterHeader", "filterState", "tableName", "comment", "formatStr", + * "decimalPlaces", "cellType"). * @param {number} Optional. Pass the index of the sheet. * @returns {any|string|Array} */ - getPropertyValue(rowIdx: number,colIdx: number,prop: string,sheetIdx: number): any|string|Array; + getPropertyValue(rowIdx: number, colIdx: number, prop: string, sheetIdx: number): any|string|any[]; /** This method is used to get the property value in specified cell in Spreadsheet. * @param {HTMLElement} Pass the cell element to get property value. - * @param {string} Pass the property name that you want ("value", "value2", "type", "cFormatRule", "range", "thousandSeparator", "rule", "format", "border", "picture", "chart", "calcValue", "align", "hyperlink", "formats", "borders", "tformats", "tborders", "isFilterHeader", "filterState", "tableName", "comment", "formatStr", "decimalPlaces", "cellType"). + * @param {string} Pass the property name that you want ("value", "value2", "type", "cFormatRule", "range", "thousandSeparator", "rule", "format", "border", + * "picture", "chart", "calcValue", "align", "hyperlink", "formats", "borders", "tformats", "tborders", "isFilterHeader", "filterState", "tableName", + * "comment", "formatStr", "decimalPlaces", "cellType"). * @param {number} Pass the index of sheet. * @returns {any|string|Array} */ - getPropertyValueByElem(elem: HTMLElement,property: string,sheetIdx: number): any|string|Array; + getPropertyValueByElem(elem: HTMLElement, property: string, sheetIdx: number): any|string|any[]; /** This method is used to save the edited cell value in the Spreadsheet. * @returns {void} @@ -38735,22 +38749,22 @@ export interface XLEdit { * @param {string|number} Pass the cell value. * @returns {void} */ - updateCell(cell: any,value: string|number): void; + updateCell(cell: any, value: string|number): void; /** This method is used to update a particular cell value and its format in the Spreadsheet. * @param {any} Pass row index and column index of the cell. * @param {string|number} Pass the cell value. - * @param {string} Pass the class name to update format. + * @param {string} Pass the class name to update format. * @param {number} Pass sheet index. * @returns {void} */ - updateCellValue(cellIdx: any,val: string|number,formatClass: string,sheetIdx: number): void; + updateCellValue(cellIdx: any, val: string|number, formatClass: string, sheetIdx: number): void; } export interface XLExport { /** This method is used to save the sheet data as Excel ,CSV or PDF document (.xls, .xlsx .csv, .pdf) in Spreadsheet. - * @param {string} Pass the export type that you want. + * @param {string} Pass the export type that you want. * @returns {void} */ export(type: string): void; @@ -38772,7 +38786,7 @@ export interface XLFilter { * @param {string|Array} Pass the range of the selected cells. * @returns {void} */ - filter(range: string|Array): void; + filter(range: string|any[]): void; /** This method is used to apply filter for the column by active cell's value in the Spreadsheet. * @returns {void} @@ -38790,24 +38804,24 @@ export interface XLFormat { /** This method is used to create a table for the selected range of cells in the Spreadsheet. * @param {any} Pass the table object. - * @param {string|Array} Optional. If the range is specified, then it will create table in the specified range else it will use the current selected range. + * @param {string|Array} Optional. If the range is specified, then it will create table in the specified range else it will use the current selected range. * @returns {string} */ - createTable(tableObject: any,range: string|Array): string; + createTable(tableObject: any, range: string|any[]): string; /** This method is used to set format style and values in a cell or range of cells. * @param {any} Pass the formatObject which contains style, type, format, groupSeparator and decimalPlaces. * @param {string} Pass the range to format cells. * @returns {void} */ - format(formatObj: any,range: string): void; + format(formatObj: any, range: string): void; /** This method is used to remove the style in the specified range. * @param {Array|string} Pass the cell range . * @param {any} Optional. Pass the options for which the style gets removed. * @returns {void} */ - removeStyle(range: Array|string,options: any): void; + removeStyle(range: any[]|string, options: any): void; /** This method is used to remove table with specified tableId in the Spreadsheet. * @param {number} Pass the tableId that you want to remove. @@ -38820,21 +38834,21 @@ export interface XLFormat { * @param {string|Array} Pass the range. * @returns {void} */ - updateDecimalPlaces(type: string,range: string|Array): void; + updateDecimalPlaces(type: string, range: string|any[]): void; /** This method is used to update the format for the selected range of cells in the Spreadsheet. * @param {any} Pass the format object that you want to update. - * @param {Array} Optional. If the range is specified, then it will update format in the specified range else it will use the current selected range. + * @param {Array} Optional. If the range is specified, then it will update format in the specified range else it will use the current selected range. * @returns {void} */ - updateFormat(formatObj: any,range: Array): void; + updateFormat(formatObj: any, range: any[]): void; /** This method is used to update the unique format for selected range of cells in the Spreadsheet. * @param {string} Pass the unique format class. * @param {Array} Optional. If the range is specified, then it will update format in the specified range else it will use the current selected range. * @returns {void} */ - updateUniqueFormat(formatClass: string,range: Array): void; + updateUniqueFormat(formatClass: string, range: any[]): void; } export interface XLFreeze { @@ -38855,7 +38869,7 @@ export interface XLFreeze { * @param {number} Index of the column to be freeze. * @returns {void} */ - freezePanes(rowIdx: number,colIdx: number): void; + freezePanes(rowIdx: number, colIdx: number): void; /** This method is used to freeze rows upto the specified row index in the Spreadsheet. * @param {number} Index of the row to be freeze. @@ -38877,7 +38891,7 @@ export interface XLFreeze { export interface XLPivot { /** This property is used to clear the pivot table list in Spreadsheet. - * @param {string} Pass the name of the pivot table. + * @param {string} Pass the name of the pivot table. * @returns {void} */ clearPivotFieldList(pivotName: string): void; @@ -38890,7 +38904,7 @@ export interface XLPivot { * @param {any} Pass the pivot range, sheet index, address and data source . * @returns {string} */ - createPivotTable(range: string,location: string,name: string,settings: any,pvt: any): string; + createPivotTable(range: string, location: string, name: string, settings: any, pvt: any): string; /** This method is used to delete the pivot table which is selected. * @param {string} Pass the name of the pivot table. @@ -38903,7 +38917,7 @@ export interface XLPivot { * @param {number} Optional. Pass the index of the sheet. * @returns {void} */ - refreshDataSource(name: string,sheetIdx: number): void; + refreshDataSource(name: string, sheetIdx: number): void; } export interface XLPrint { @@ -38925,13 +38939,13 @@ export interface XLResize { * @param {Array} Optional. Pass row index collection that you want to fit its height. * @returns {void} */ - fitHeight(rowIndexes: Array): void; + fitHeight(rowIndexes: any[]): void; /** This method is used to fit the width of columns in the Spreadsheet. * @param {Array} Optional. Pass column index collection that you want to fit its width. * @returns {void} */ - fitWidth(colIndexes: Array): void; + fitWidth(colIndexes: any[]): void; /** This method is used to get the column width of the specified column index in the Spreadsheet. * @param {number} Pass the column index. @@ -38950,14 +38964,14 @@ export interface XLResize { * @param {number} Pass the width value that you want to set. * @returns {void} */ - setColWidth(colIdx: number,size: number): void; + setColWidth(colIdx: number, size: number): void; /** This method is used to set the row height of the specified row index in the Spreadsheet. * @param {number} Pass the row index. * @param {number} Pass the height value that you want to set. * @returns {void} */ - setRowHeight(rowIdx: number,size: number): void; + setRowHeight(rowIdx: number, size: number): void; } export interface XLRibbon { @@ -38967,21 +38981,21 @@ export interface XLRibbon { * @param {number} pass the index of the item to be added in the backstage. * @returns {void} */ - addBackStageItem(pageItem: any,index: number): void; + addBackStageItem(pageItem: any, index: number): void; /** This method is used to dynamically add the contextual tabs in the ribbon. * @param {any} Specifies the contextual tab set object. * @param {number} pass the index of the contextual tab. * @returns {void} */ - addContextualTabs(contextualTabSet: any,index: number): void; + addContextualTabs(contextualTabSet: any, index: number): void; /** This method is used to dynamically add the menu item in the file menu. * @param {Array} Specifies the item to be added * @param {number} pass the index of the menu item. * @returns {void} */ - addMenuItem(item: Array,index: number): void; + addMenuItem(item: any[], index: number): void; /** This method is used to add a new name in the Spreadsheet name manager. * @param {string} Pass the name that you want to define in name manager. @@ -38990,7 +39004,7 @@ export interface XLRibbon { * @param {number} Optional. Pass the sheet index. * @returns {void} */ - addNamedRange(name: string,refersTo: string,comment: string,sheetIdx: number): void; + addNamedRange(name: string, refersTo: string, comment: string, sheetIdx: number): void; /** This method is used to dynamically add the tab in the ribbon. * @param {Array} Specifies the text to be displayed in the tab. @@ -38998,7 +39012,7 @@ export interface XLRibbon { * @param {number} pass the index of the tab. * @returns {void} */ - addTab(tabText: Array,ribbonGroups: number,index: number): void; + addTab(tabText: any[], ribbonGroups: number, index: number): void; /** This method is used to dynamically add the tab group in the ribbon. * @param {number} Specifies the ribbon tab index. @@ -39006,14 +39020,14 @@ export interface XLRibbon { * @param {number} pass the index of the ribbon group. * @returns {void} */ - addTabGroup(tabIndex: number,tabGroup: any,groupIndex: number): void; + addTabGroup(tabIndex: number, tabGroup: any, groupIndex: number): void; /** This method is used to insert the few type (SUM, MAX, MIN, AVG, COUNT) of formulas in the selected range of cells in the Spreadsheet. * @param {string} To pass the type("SUM","MAX","MIN","AVG","COUNT"). * @param {string|Array} If range is specified, it will apply auto sum for the specified range else it will use the current selected range. * @returns {void} */ - autoSum(type: string,range: string|Array): void; + autoSum(type: string, range: string|any[]): void; /** This method is used to hide the file menu in the ribbon tab. * @returns {void} @@ -39043,14 +39057,14 @@ export interface XLRibbon { * @param {boolean} pass the boolean value to remove the tab from ribbon * @returns {void} */ - removeTab(index: number,isRemoveMenu: boolean): void; + removeTab(index: number, isRemoveMenu: boolean): void; /** This method is used to remove the tab group form ribbon in the spreadsheet. * @param {number} Specifies the index of the tab group to be removed from the ribbon. * @param {string} Specifies the text to be displayed in the tab group * @returns {void} */ - removeTabGroup(tabIndex: number,groupText: string): void; + removeTabGroup(tabIndex: number, groupText: string): void; /** This method is used to show the file menu in the ribbon tab. * @returns {void} @@ -39062,7 +39076,7 @@ export interface XLRibbon { * @param {number} pass the index of the item to be updated * @returns {void} */ - updateMenuItem(item: any,index: number): void; + updateMenuItem(item: any, index: number): void; /** This method is used to update the ribbon icons in the Spreadsheet. * @returns {void} @@ -39079,7 +39093,7 @@ export interface XLSearch { * @param {boolean} Pass {{'`true`' | markdownify}}, if you want to match with entire cell contents. * @returns {void} */ - replaceAllByBook(findData: string,replaceData: string,isCSen: boolean,isEMatch: boolean): void; + replaceAllByBook(findData: string, replaceData: string, isCSen: boolean, isEMatch: boolean): void; /** This method is used to find and replace all data by sheet in Spreadsheet. * @param {string} Pass the search data. @@ -39088,7 +39102,7 @@ export interface XLSearch { * @param {boolean} Pass {{'`true`' | markdownify}}, if you want to match with entire cell contents. * @returns {void} */ - replaceAllBySheet(findData: string,replaceData: string,isCSen: boolean,isEMatch: boolean): void; + replaceAllBySheet(findData: string, replaceData: string, isCSen: boolean, isEMatch: boolean): void; } export interface XLSelection { @@ -39108,7 +39122,7 @@ export interface XLSelection { * @param {Array|string} Optional. Pass range to refresh selection. * @returns {void} */ - refreshSelection(range: Array|string): void; + refreshSelection(range: any[]|string): void; /** This method is used to select a single column in the Spreadsheet. * @param {number} Pass the column index value. @@ -39121,7 +39135,7 @@ export interface XLSelection { * @param {number} Pass the column end index. * @returns {void} */ - selectColumns(startIdx: number,endIdx: number): void; + selectColumns(startIdx: number, endIdx: number): void; /** This method is used to select the specified range of cells in the Spreadsheet. * @param {string} Pass range which want to select. @@ -39140,7 +39154,7 @@ export interface XLSelection { * @param {number} Pass the end row index. * @returns {void} */ - selectRows(startIdx: number,endIdx: number): void; + selectRows(startIdx: number, endIdx: number): void; /** This method is used to select all cells in active sheet. * @returns {void} @@ -39159,7 +39173,7 @@ export interface XLShape { * @param {number} Optional. Pass the left of the image that you want to set. * @returns {string} */ - setPicture(range: string,url: string,width: number,height: number,top: number,left: number): string; + setPicture(range: string, url: string, width: number, height: number, top: number, left: number): string; } export interface XLSort { @@ -39170,7 +39184,7 @@ export interface XLSort { * @param {string} Pass the range * @returns {void} */ - sortByColor(operation: string,color: any,range: string): void; + sortByColor(operation: string, color: any, range: string): void; /** This method is used to sort a particular range of cells based on its values in the Spreadsheet. * @param {Array|string} Pass the range to sort. @@ -39178,32 +39192,32 @@ export interface XLSort { * @param {any} Pass the direction to sort (ascending or descending). * @returns {boolean} */ - sortByRange(range: Array|string,columnName: string,direction: any): boolean; + sortByRange(range: any[]|string, columnName: string, direction: any): boolean; } export interface XLValidate { /** This method is used to apply data validation rules in a selected range of cells based on the defined condition in the Spreadsheet. - * @param {string|Array} If range is specified, it will apply rules for the specified range else it will use the current selected range. + * @param {string|Array} If range is specified, it will apply rules for the specified range else it will use the current selected range. * @param {Array} Pass the validation condition, value1 and value2. * @param {string} Pass the data type. * @param {boolean} Pass {{'`true`' | markdownify}} if you ignore blank values. * @param {boolean} Pass {{'`true`' | markdownify}} if you want to show an error alert. * @returns {void} */ - applyDVRules(range: string|Array,values: Array,type: string,required: boolean,showErrorAlert: boolean): void; + applyDVRules(range: string|any[], values: any[], type: string, required: boolean, showErrorAlert: boolean): void; /** This method is used to clear the applied validation rules in a specified range of cells in the Spreadsheet. - * @param {string|Array} Optional. If range is specified, it will clear rules for the specified range else it will use the current selected range. + * @param {string|Array} Optional. If range is specified, it will clear rules for the specified range else it will use the current selected range. * @returns {void} */ - clearDV(range: string|Array): void; + clearDV(range: string|any[]): void; /** This method is used to highlight invalid data in a specified range of cells in the Spreadsheet. * @param {string|Array} Optional. If range is specified, it will clear rules for the specified range else it will use the current selected range. * @returns {void} */ - highlightInvalidData(range: string|Array): void; + highlightInvalidData(range: string|any[]): void; } export interface Model { @@ -39258,7 +39272,8 @@ export interface Model { */ allowComments?: boolean; - /** Gets or sets a value that indicates whether to enable or disable Conditional Format feature in the Spreadsheet. By enabling this, you can apply formatting to the selected range of cells based on the provided conditions (Greater than, Less than, Equal, Between, Contains, etc.). + /** Gets or sets a value that indicates whether to enable or disable Conditional Format feature in the Spreadsheet. By enabling this, you can apply formatting to the selected range + * of cells based on the provided conditions (Greater than, Less than, Equal, Between, Contains, etc.). * @Default {true} */ allowConditionalFormats?: boolean; @@ -39293,7 +39308,8 @@ export interface Model { */ allowFormatAsTable?: boolean; - /** Get or sets a value that indicates whether to enable or disable format painter feature in the Spreadsheet. By enabling this feature, you can copy the format from the selected range and apply it to another range. + /** Get or sets a value that indicates whether to enable or disable format painter feature in the Spreadsheet. By enabling this feature, you can copy + * the format from the selected range and apply it to another range. * @Default {true} */ allowFormatPainter?: boolean; @@ -39303,12 +39319,14 @@ export interface Model { */ allowFormulaBar?: boolean; - /** Gets or sets a value that indicates whether to enable or disable freeze pane support in Spreadsheet. By enabling this feature, you can use freeze top row, freeze first column and freeze panes options. - * @Default {true} + /** Gets or sets a value that indicates whether to enable or disable freeze pane support in Spreadsheet. After enabling this feature, + * you can use freeze top row, freeze first column and freeze panes options. + * @Default {false} */ allowFreezing?: boolean; - /** Gets or sets a value that indicates whether to enable or disable hyperlink feature in the Spreadsheet. By enabling this feature, you can add hyperlink which is used to easily navigate to the cell reference from one sheet to another or a web page. + /** Gets or sets a value that indicates whether to enable or disable hyperlink feature in the Spreadsheet. By enabling this feature, you can add hyperlink which is used to + * easily navigate to the cell reference from one sheet to another or a web page. * @Default {true} */ allowHyperlink?: boolean; @@ -39343,12 +39361,14 @@ export interface Model { */ allowOverflow?: boolean; - /** Gets or sets a value that indicates whether to enable or disable resizing feature in the Spreadsheet. By enabling this feature, you can change the column width and row height by dragging its header boundaries. + /** Gets or sets a value that indicates whether to enable or disable resizing feature in the Spreadsheet. By enabling this feature, you can change the column width and + * row height by dragging its header boundaries. * @Default {true} */ allowResizing?: boolean; - /** Gets or sets a value that indicates whether to enable or disable find and replace feature in the Spreadsheet. By enabling this, you can easily find and replace a specific value in the sheet or workbook. By using goto behavior, you can select and highlight all cells that contains specific data or data types. + /** Gets or sets a value that indicates whether to enable or disable find and replace feature in the Spreadsheet. By enabling this, you can easily find and replace + * a specific value in the sheet or workbook. By using goto behavior, you can select and highlight all cells that contains specific data or data types. * @Default {true} */ allowSearching?: boolean; @@ -39368,7 +39388,8 @@ export interface Model { */ allowUndoRedo?: boolean; - /** Gets or sets a value that indicates whether to enable or disable wrap text feature in the Spreadsheet. By enabling this, cell content can wrap to the next line, if the cell content exceeds the boundary of the cell. + /** Gets or sets a value that indicates whether to enable or disable wrap text feature in the Spreadsheet. By enabling this, cell content can wrap to the next line, + * if the cell content exceeds the boundary of the cell. * @Default {true} */ allowWrap?: boolean; @@ -39403,7 +39424,7 @@ export interface Model { /** Gets or sets a value that indicates custom formulas in Spreadsheet. * @Default {[]} */ - customFormulas?: Array; + customFormulas?: any[]; /** Gets or sets a value that indicates whether to enable or disable context menu in the Spreadsheet. * @Default {true} @@ -39437,7 +39458,8 @@ export interface Model { */ isReadOnly?: boolean; - /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data (i.e.) in a language and culture specific to a particular country or region. + /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data (i.e.) + * in a language and culture specific to a particular country or region. * @Default {en-US} */ locale?: string; @@ -39479,7 +39501,7 @@ export interface Model { /** Gets or sets an object that indicates to customize the sheet behavior in Spreadsheet. */ - sheets?: Array; + sheets?: Sheet[]; /** Gets or sets a value that indicates whether to show or hide pager in the Spreadsheet. * @Default {true} @@ -39502,118 +39524,118 @@ export interface Model { userName?: string; /** Triggered for every action before its starts. */ - actionBegin? (e: ActionBeginEventArgs): void; + actionBegin?(e: ActionBeginEventArgs): void; /** Triggered for every action complete. */ - actionComplete? (e: ActionCompleteEventArgs): void; + actionComplete?(e: ActionCompleteEventArgs): void; /** Triggered when the auto fill operation begins. */ - autoFillBegin? (e: AutoFillBeginEventArgs): void; + autoFillBegin?(e: AutoFillBeginEventArgs): void; /** Triggered when the auto fill operation completes. */ - autoFillComplete? (e: AutoFillCompleteEventArgs): void; + autoFillComplete?(e: AutoFillCompleteEventArgs): void; /** Triggered before the batch save. */ - beforeBatchSave? (e: BeforeBatchSaveEventArgs): void; + beforeBatchSave?(e: BeforeBatchSaveEventArgs): void; /** Triggered before the cells to be formatted. */ - beforeCellFormat? (e: BeforeCellFormatEventArgs): void; + beforeCellFormat?(e: BeforeCellFormatEventArgs): void; /** Triggered before the cell selection. */ - beforeCellSelect? (e: BeforeCellSelectEventArgs): void; + beforeCellSelect?(e: BeforeCellSelectEventArgs): void; /** Triggered before the selected cells are dropped. */ - beforeDrop? (e: BeforeDropEventArgs): void; + beforeDrop?(e: BeforeDropEventArgs): void; /** Triggered while start to edit the comment. */ - beforeEditComment? (e: BeforeEditCommentEventArgs): void; + beforeEditComment?(e: BeforeEditCommentEventArgs): void; /** Triggered before the contextmenu is open. */ - beforeOpen? (e: BeforeOpenEventArgs): void; + beforeOpen?(e: BeforeOpenEventArgs): void; /** Triggered before the activation panel is open. */ - beforePanelOpen? (e: BeforePanelOpenEventArgs): void; + beforePanelOpen?(e: BeforePanelOpenEventArgs): void; /** Triggered when click on sheet cell. */ - cellClick? (e: CellClickEventArgs): void; + cellClick?(e: CellClickEventArgs): void; /** Triggered when the cell is edited. */ - cellEdit? (e: CellEditEventArgs): void; + cellEdit?(e: CellEditEventArgs): void; /** Triggered while cell is formatting. */ - cellFormatting? (e: CellFormattingEventArgs): void; + cellFormatting?(e: CellFormattingEventArgs): void; /** Triggered when mouse hover on cell in sheets. */ - cellHover? (e: CellHoverEventArgs): void; + cellHover?(e: CellHoverEventArgs): void; /** Triggered when save the edited cell. */ - cellSave? (e: CellSaveEventArgs): void; + cellSave?(e: CellSaveEventArgs): void; /** Triggered when the cell is selected. */ - cellSelected? (e: CellSelectedEventArgs): void; + cellSelected?(e: CellSelectedEventArgs): void; /** Triggered when click the contextmenu items. */ - contextMenuClick? (e: ContextMenuClickEventArgs): void; + contextMenuClick?(e: ContextMenuClickEventArgs): void; /** Triggered when the selected cells are being dragged. */ - drag? (e: DragEventArgs): void; + drag?(e: DragEventArgs): void; /** Triggered when you start to drag the picture or chart. */ - dragShape? (e: DragShapeEventArgs): void; + dragShape?(e: DragShapeEventArgs): void; /** Triggered when the selected cells are initiated to drag. */ - dragStart? (e: DragStartEventArgs): void; + dragStart?(e: DragStartEventArgs): void; /** Triggered when the selected cells are dropped. */ - drop? (e: DropEventArgs): void; + drop?(e: DropEventArgs): void; /** Triggered before the range editing starts. */ - editRangeBegin? (e: EditRangeBeginEventArgs): void; + editRangeBegin?(e: EditRangeBeginEventArgs): void; /** Triggered after range editing completes. */ - editRangeComplete? (e: EditRangeCompleteEventArgs): void; + editRangeComplete?(e: EditRangeCompleteEventArgs): void; /** Triggered when the key is pressed down. */ - keyDown? (e: KeyDownEventArgs): void; + keyDown?(e: KeyDownEventArgs): void; /** Triggered when the key is released. */ - keyUp? (e: KeyUpEventArgs): void; + keyUp?(e: KeyUpEventArgs): void; /** Triggered before the sheet is loaded. */ - load? (e: LoadEventArgs): void; + load?(e: LoadEventArgs): void; /** Triggered after the sheet is loaded. */ - loadComplete? (e: LoadCompleteEventArgs): void; + loadComplete?(e: LoadCompleteEventArgs): void; /** Triggered every click of the menu item. */ - menuClick? (e: MenuClickEventArgs): void; + menuClick?(e: MenuClickEventArgs): void; /** Triggered when a file is imported. */ - onImport? (e: OnImportEventArgs): void; + onImport?(e: OnImportEventArgs): void; /** Triggered when import sheet is failed to open. */ - openFailure? (e: OpenFailureEventArgs): void; + openFailure?(e: OpenFailureEventArgs): void; /** Triggered when pager item is clicked in the Spreadsheet. */ - pagerClick? (e: PagerClickEventArgs): void; + pagerClick?(e: PagerClickEventArgs): void; /** Triggered when you start resizing the chart, picture, row and column. */ - resizeStart? (e: ResizeStartEventArgs): void; + resizeStart?(e: ResizeStartEventArgs): void; /** Triggered after end of resizing the chart, picture, row and column. */ - resizeEnd? (e: ResizeEndEventArgs): void; + resizeEnd?(e: ResizeEndEventArgs): void; /** Triggered when click on the ribbon. */ - ribbonClick? (e: RibbonClickEventArgs): void; + ribbonClick?(e: RibbonClickEventArgs): void; /** Triggered when the chart series rendering. */ - seriesRendering? (e: SeriesRenderingEventArgs): void; + seriesRendering?(e: SeriesRenderingEventArgs): void; /** Triggered when click the ribbon tab. */ - tabClick? (e: TabClickEventArgs): void; + tabClick?(e: TabClickEventArgs): void; /** Triggered when select the ribbon tab. */ - tabSelect? (e: TabSelectEventArgs): void; + tabSelect?(e: TabSelectEventArgs): void; } export interface ActionBeginEventArgs { @@ -39632,7 +39654,7 @@ export interface ActionBeginEventArgs { /** Returns the cell range. */ - range?: Array; + range?: any[]; /** Returns the action format. */ @@ -39667,7 +39689,7 @@ export interface ActionCompleteEventArgs { /** Returns the applied cell format object. */ - selectedCell?: Array|any; + selectedCell?: any[]|any; /** Returns the sheet index. */ @@ -39690,7 +39712,7 @@ export interface AutoFillBeginEventArgs { /** Returns auto fill begin cell range. */ - dataRange?: Array; + dataRange?: any[]; /** Returns which direction drag the auto fill. */ @@ -39698,7 +39720,7 @@ export interface AutoFillBeginEventArgs { /** Returns fill cells range. */ - fillRange?: Array; + fillRange?: any[]; /** Returns the auto fill type. */ @@ -39725,7 +39747,7 @@ export interface AutoFillCompleteEventArgs { /** Returns auto fill begin cell range. */ - dataRange?: Array; + dataRange?: any[]; /** Returns which direction to drag the auto fill. */ @@ -39733,7 +39755,7 @@ export interface AutoFillCompleteEventArgs { /** Returns fill cells range. */ - fillRange?: Array; + fillRange?: any[]; /** Returns the auto fill type. */ @@ -39783,7 +39805,7 @@ export interface BeforeCellFormatEventArgs { /** Returns the selected cells. */ - cells?: Array|any; + cells?: any[]|any; /** Returns the Spreadsheet model. */ @@ -39802,11 +39824,11 @@ export interface BeforeCellSelectEventArgs { /** Returns the previous cell range. */ - prevRange?: Array; + prevRange?: any[]; /** Returns the current cell range. */ - currRange?: Array; + currRange?: any[]; /** Returns the Spreadsheet model. */ @@ -40112,7 +40134,7 @@ export interface CellSelectedEventArgs { /** Returns the selected range. */ - selectedRange?: Array; + selectedRange?: any[]; /** Returns the target element. */ @@ -40880,7 +40902,7 @@ export interface RibbonSettingsApplicationTabMenuSettings { /** Specifies the data source to append in application tab. * @Default {[]} */ - dataSource?: Array; + dataSource?: any[]; } export interface RibbonSettingsApplicationTab { @@ -40969,7 +40991,7 @@ export interface SelectionSettings { export interface SheetsBorder { - /** + /** */ type?: ej.Spreadsheet.BorderType|string; @@ -40995,7 +41017,7 @@ export interface SheetsCFormatRule { /** Specifies the inputs for conditional formatting in Spreadsheet. * @Default {[]} */ - inputs?: Array; + inputs?: any[]; /** Specifies the range for conditional formatting in Spreadsheet. */ @@ -41145,7 +41167,7 @@ export interface SheetsRow { /** Specifies the cells of a row in Spreadsheet. * @Default {[]} */ - cells?: Array; + cells?: SheetsRowsCell[]; /** Gets or sets the index of a row in Spreadsheet. * @Default {0} @@ -41158,17 +41180,17 @@ export interface Sheet { /** Specifies the border for the cell in the Spreadsheet. * @Default {[]} */ - border?: Array; + border?: SheetsBorder[]; /** Specifies the cell types for a cell or range in Spreadsheet. * @Default {[]} */ - cellTypes?: Array; + cellTypes?: any[]; /** Specifies the conditional formatting for the range of cell in Spreadsheet. * @Default {[]} */ - cFormatRule?: Array; + cFormatRule?: SheetsCFormatRule[]; /** Gets or sets a value that indicates to define column count in the Spreadsheet. * @Default {21} @@ -41208,17 +41230,17 @@ export interface Sheet { /** To hide the specified columns in Spreadsheet. * @Default {[]} */ - hideColumns?: Array; + hideColumns?: any[]; /** To hide the specified rows in Spreadsheet. * @Default {[]} */ - hideRows?: Array; + hideRows?: any[]; /** To merge specified ranges in Spreadsheet. * @Default {[]} */ - mergeCells?: Array; + mergeCells?: any[]; /** Specifies the primary key for the datasource in Spreadsheet. */ @@ -41232,7 +41254,7 @@ export interface Sheet { /** Specifies single range or multiple range settings for a sheet in Spreadsheet. * @Default {[]} */ - rangeSettings?: Array; + rangeSettings?: SheetsRangeSetting[]; /** Gets or sets a value that indicates to define row count in the Spreadsheet. * @Default {20} @@ -41242,7 +41264,7 @@ export interface Sheet { /** Specifies the rows for a sheet in Spreadsheet. * @Default {[]} */ - rows?: Array; + rows?: SheetsRow[]; /** Gets or sets a value that indicates whether to show or hide grid lines in the Spreadsheet. * @Default {true} @@ -41265,7 +41287,7 @@ export interface Sheet { startCell?: string; } -enum AutoFillOptions{ +enum AutoFillOptions { ///Specifies the CopyCells property in AutoFillOptions. CopyCells, @@ -41284,7 +41306,7 @@ enum AutoFillOptions{ } -enum scrollMode{ +enum scrollMode { ///To enable Infinite scroll mode for Spreadsheet. Infinite, @@ -41294,7 +41316,7 @@ enum scrollMode{ } -enum SelectionType{ +enum SelectionType { ///To select only Column in Spreadsheet. Column, @@ -41307,7 +41329,7 @@ enum SelectionType{ } -enum SelectionUnit{ +enum SelectionUnit { ///To enable Single selection in Spreadsheet Single, @@ -41320,7 +41342,7 @@ enum SelectionUnit{ } -enum BorderType{ +enum BorderType { ///To apply top border for the given range of cell. Top, @@ -41354,7 +41376,7 @@ enum BorderType{ } -enum CFormatRule{ +enum CFormatRule { ///To identify greater than values in the given range of cells. GreaterThan, @@ -41376,7 +41398,7 @@ enum CFormatRule{ } -enum CFormatHighlightColor{ +enum CFormatHighlightColor { ///Highlights red with dark red text color. RedFillwithDarkRedText, @@ -41395,7 +41417,7 @@ enum CFormatHighlightColor{ } -enum ChartProperties{ +enum ChartProperties { ///Specifies to make the data label center of the chart. DataLabelCenter, @@ -41468,11 +41490,10 @@ enum ChartProperties{ class PdfViewer extends ej.Widget { static fn: PdfViewer; - constructor(element: JQuery, options?: PdfViewer.Model); - constructor(element: Element, options?: PdfViewer.Model); + constructor(element: JQuery | Element, options?: PdfViewer.Model); static Locale: any; - model:PdfViewer.Model; - defaults:PdfViewer.Model; + model: PdfViewer.Model; + defaults: PdfViewer.Model; /** Loads the document with the filename and displays it in PDF viewer. * @param {string} File name to be loaded @@ -41582,7 +41603,7 @@ class PdfViewer extends ej.Widget { */ unload(): void; } -export module PdfViewer{ +export namespace PdfViewer { export interface Model { @@ -41651,37 +41672,37 @@ export interface Model { fileName?: string; /** Triggers when the PDF document gets loaded and is ready to view in the Control. */ - documentLoad? (e: DocumentLoadEventArgs): void; + documentLoad?(e: DocumentLoadEventArgs): void; /** Triggers when the PDF document gets unloaded from the PDF viewer. */ - documentUnload? (e: DocumentUnloadEventArgs): void; + documentUnload?(e: DocumentUnloadEventArgs): void; /** Triggers when there is change in current page number. */ - pageChange? (e: PageChangeEventArgs): void; + pageChange?(e: PageChangeEventArgs): void; /** Triggers when there is change in the magnification value. */ - zoomChange? (e: ZoomChangeEventArgs): void; + zoomChange?(e: ZoomChangeEventArgs): void; /** Triggers when hyperlink in the PDF Document is clicked */ - hyperlinkClick? (e: HyperlinkClickEventArgs): void; + hyperlinkClick?(e: HyperlinkClickEventArgs): void; /** Triggers before the printing starts. */ - beforePrint? (e: BeforePrintEventArgs): void; + beforePrint?(e: BeforePrintEventArgs): void; /** Triggers after the printing is completed. */ - afterPrint? (e: AfterPrintEventArgs): void; + afterPrint?(e: AfterPrintEventArgs): void; /** Triggers when the mouse click is performed over the page of the PDF document. */ - pageClick? (e: PageClickEventArgs): void; + pageClick?(e: PageClickEventArgs): void; /** Triggers when the client buffering process starts. */ - bufferStart? (e: BufferStartEventArgs): void; + bufferStart?(e: BufferStartEventArgs): void; /** Triggers when the client buffering process ends. */ - bufferEnd? (e: BufferEndEventArgs): void; + bufferEnd?(e: BufferEndEventArgs): void; /** Triggers when PDF viewer control is destroyed successfully. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; } export interface DocumentLoadEventArgs { @@ -41915,7 +41936,7 @@ export interface ServerActionSettings { download?: string; } -enum ToolbarItems{ +enum ToolbarItems { ///Shows only magnification tools in the toolbar. MagnificationTools, @@ -41934,7 +41955,7 @@ enum ToolbarItems{ } -enum PdfService{ +enum PdfService { ///Denotes that the service is located in the local project Local, @@ -41944,9 +41965,9 @@ enum PdfService{ } -enum LinkTarget{ +enum LinkTarget { - ///Opens the hyperlink in the same tab of the browser. + ///Opens the hyperlink in the same tab of the browser. Default, ///Opens the hyperlink in a new tab of the browser. @@ -41960,11 +41981,10 @@ enum LinkTarget{ class SpellCheck extends ej.Widget { static fn: SpellCheck; - constructor(element: JQuery, options?: SpellCheck.Model); - constructor(element: Element, options?: SpellCheck.Model); + constructor(element: JQuery | Element, options?: SpellCheck.Model); static Locale: any; - model:SpellCheck.Model; - defaults:SpellCheck.Model; + model: SpellCheck.Model; + defaults: SpellCheck.Model; /** Open the dialog to correct the spelling of the target content. * @returns {void} @@ -42021,7 +42041,7 @@ class SpellCheck extends ej.Widget { */ addToDictionary(customWord: string): any; } -export module SpellCheck{ +export namespace SpellCheck { export interface Model { @@ -42047,7 +42067,7 @@ export interface Model { /** To ignore the words from the error word consideration. * @Default {[]} */ - ignoreWords?: Array; + ignoreWords?: any[]; /** Holds all options related to the context menu settings of SpellCheck. */ @@ -42068,40 +42088,39 @@ export interface Model { controlsToValidate?: string; /** Triggers on the success of AJAX call request. */ - actionSuccess? (e: ActionSuccessEventArgs): void; + actionSuccess?(e: ActionSuccessEventArgs): void; /** Triggers on the AJAX call request beginning. */ - actionBegin? (e: ActionBeginEventArgs): void; + actionBegin?(e: ActionBeginEventArgs): void; /** Triggers when the AJAX call request failure. */ - actionFailure? (e: ActionFailureEventArgs): void; + actionFailure?(e: ActionFailureEventArgs): void; /** Triggers when the dialog mode spell check starting. */ - start? (e: StartEventArgs): void; + start?(e: StartEventArgs): void; /** Triggers when the spell check operations completed through dialog mode. */ - complete? (e: CompleteEventArgs): void; + complete?(e: CompleteEventArgs): void; /** Triggers before context menu opening. */ - contextOpen? (e: ContextOpenEventArgs): void; + contextOpen?(e: ContextOpenEventArgs): void; /** Triggers when the context menu item clicked. */ - contextClick? (e: ContextClickEventArgs): void; + contextClick?(e: ContextClickEventArgs): void; /** Triggers before the spell check dialog opens. */ - dialogBeforeOpen? (e: DialogBeforeOpenEventArgs): void; - + dialogBeforeOpen?(e: DialogBeforeOpenEventArgs): void; /** Triggers after the spell check dialog opens. */ - dialogOpen? (e: DialogOpenEventArgs): void; + dialogOpen?(e: DialogOpenEventArgs): void; /** Triggers when the spell check dialog closed. */ - dialogClose? (e: DialogCloseEventArgs): void; + dialogClose?(e: DialogCloseEventArgs): void; /** Triggers when the spell check control performing the spell check operations such as ignore, ignoreAll, change, changeAll and addToDictionary. */ - validating? (e: ValidatingEventArgs): void; + validating?(e: ValidatingEventArgs): void; /** Triggers before loading the target HTML element text into the dialog sentence area. */ - targetUpdating? (e: TargetUpdatingEventArgs): void; + targetUpdating?(e: TargetUpdatingEventArgs): void; } export interface ActionSuccessEventArgs { @@ -42442,10 +42461,11 @@ export interface ContextMenuSettings { */ enable?: boolean; - /** Contains all the default context menu options that are applicable for SpellCheck. It also supports adding custom menu items. All the SpellCheck related context menu items are grouped under this menu collection. + /** Contains all the default context menu options that are applicable for SpellCheck. It also supports adding custom menu items. + * All the SpellCheck related context menu items are grouped under this menu collection. * @Default {{% highlight javascript %}[{ id: IgnoreAll, text: Ignore All },{ id: AddToDictionary, text: Add To Dictionary }]{% endhighlight %}} */ - menuItems?: Array; + menuItems?: any[]; } export interface IgnoreSettings { @@ -42484,11 +42504,10 @@ export interface IgnoreSettings { class DocumentEditor extends ej.Widget { static fn: DocumentEditor; - constructor(element: JQuery, options?: DocumentEditor.Model); - constructor(element: Element, options?: DocumentEditor.Model); + constructor(element: JQuery | Element, options?: DocumentEditor.Model); static Locale: any; - model:DocumentEditor.Model; - defaults:DocumentEditor.Model; + model: DocumentEditor.Model; + defaults: DocumentEditor.Model; /** Loads the document from specified path using web API provided by importUrl. * @param {string} Specifies the file path. @@ -42533,7 +42552,7 @@ class DocumentEditor extends ej.Widget { */ find(text: string): void; } -export module DocumentEditor{ +export namespace DocumentEditor { export interface Model { @@ -42542,16 +42561,16 @@ export interface Model { importExportSettings?: ImportExportSettings; /** Triggers when the document changes. */ - onDocumentChange? (e: OnDocumentChangeEventArgs): void; + onDocumentChange?(e: OnDocumentChangeEventArgs): void; /** Triggers when the selection changes. */ - onSelectionChange? (e: OnSelectionChangeEventArgs): void; + onSelectionChange?(e: OnSelectionChangeEventArgs): void; /** Triggers when the zoom factor changes. */ - onZoomFactorChange? (e: OnZoomFactorChangeEventArgs): void; + onZoomFactorChange?(e: OnZoomFactorChangeEventArgs): void; /** Triggers when the hyperlink is clicked. */ - onRequestNavigate? (e: OnRequestNavigateEventArgs): void; + onRequestNavigate?(e: OnRequestNavigateEventArgs): void; } export interface OnDocumentChangeEventArgs { @@ -42627,15 +42646,14 @@ export interface ImportExportSettings { } } -declare module ej.datavisualization { - +declare namespace ej.datavisualization { + class SymbolPalette extends ej.Widget { static fn: SymbolPalette; - constructor(element: JQuery, options?: SymbolPalette.Model); - constructor(element: Element, options?: SymbolPalette.Model); + constructor(element: JQuery | Element, options?: SymbolPalette.Model); static Locale: any; - model:SymbolPalette.Model; - defaults:SymbolPalette.Model; + model: SymbolPalette.Model; + defaults: SymbolPalette.Model; /** Add items to Palettes at runtime * @param {string} name of the Palette @@ -42651,7 +42669,7 @@ class SymbolPalette extends ej.Widget { */ removePaletteItem(paletteName: string, node: any): void; } -export module SymbolPalette{ +export namespace SymbolPalette { export interface Model { @@ -42697,7 +42715,7 @@ export interface Model { /** An array of JSON objects, where each object represents a node/connector * @Default {[]} */ - palettes?: Array; + palettes?: Palette[]; /** Defines the preview height of the symbols * @Default {100} @@ -42725,7 +42743,7 @@ export interface Model { width?: number; /** Triggers when a palette item is selected or unselected */ - selectionChange? (e: SelectionChangeEventArgs): void; + selectionChange?(e: SelectionChangeEventArgs): void; } export interface SelectionChangeEventArgs { @@ -42767,17 +42785,16 @@ export interface Palette { /** Defines the palette items * @Default {[]} */ - items?: Array; + items?: any[]; } } class LinearGauge extends ej.Widget { static fn: LinearGauge; - constructor(element: JQuery, options?: LinearGauge.Model); - constructor(element: Element, options?: LinearGauge.Model); + constructor(element: JQuery | Element, options?: LinearGauge.Model); static Locale: any; - model:LinearGauge.Model; - defaults:LinearGauge.Model; + model: LinearGauge.Model; + defaults: LinearGauge.Model; /** destroy the linear gauge all events bound using this._on will be unbind automatically and bring the control to pre-init state. * @returns {void} @@ -43194,7 +43211,7 @@ class LinearGauge extends ej.Widget { */ setTickYDistanceFromScale(): void; } -export module LinearGauge{ +export namespace LinearGauge { export interface Model { @@ -43281,7 +43298,7 @@ export interface Model { /** Specifies the scales * @Default {null} */ - scales?: Array; + scales?: Scale[]; /** Specifies the theme for Linear gauge. See LinearGauge.Themes * @Default {flatlight} @@ -43309,43 +43326,43 @@ export interface Model { width?: number; /** Triggers while the bar pointer are being drawn on the gauge. */ - drawBarPointers? (e: DrawBarPointersEventArgs): void; + drawBarPointers?(e: DrawBarPointersEventArgs): void; /** Triggers while the customLabel are being drawn on the gauge. */ - drawCustomLabel? (e: DrawCustomLabelEventArgs): void; + drawCustomLabel?(e: DrawCustomLabelEventArgs): void; /** Triggers while the Indicator are being drawn on the gauge. */ - drawIndicators? (e: DrawIndicatorsEventArgs): void; + drawIndicators?(e: DrawIndicatorsEventArgs): void; /** Triggers while the label are being drawn on the gauge. */ - drawLabels? (e: DrawLabelsEventArgs): void; + drawLabels?(e: DrawLabelsEventArgs): void; /** Triggers while the marker are being drawn on the gauge. */ - drawMarkerPointers? (e: DrawMarkerPointersEventArgs): void; + drawMarkerPointers?(e: DrawMarkerPointersEventArgs): void; /** Triggers while the range are being drawn on the gauge. */ - drawRange? (e: DrawRangeEventArgs): void; + drawRange?(e: DrawRangeEventArgs): void; /** Triggers while the ticks are being drawn on the gauge. */ - drawTicks? (e: DrawTicksEventArgs): void; + drawTicks?(e: DrawTicksEventArgs): void; /** Triggers when the gauge is initialized. */ - init? (e: InitEventArgs): void; + init?(e: InitEventArgs): void; /** Triggers while the gauge start to Load. */ - load? (e: LoadEventArgs): void; + load?(e: LoadEventArgs): void; /** Triggers when the left mouse button is clicked. */ - mouseClick? (e: MouseClickEventArgs): void; + mouseClick?(e: MouseClickEventArgs): void; /** Triggers when clicking and dragging the mouse pointer over the gauge pointer. */ - mouseClickMove? (e: MouseClickMoveEventArgs): void; + mouseClickMove?(e: MouseClickMoveEventArgs): void; /** Triggers when the mouse click is released. */ - mouseClickUp? (e: MouseClickUpEventArgs): void; + mouseClickUp?(e: MouseClickUpEventArgs): void; /** Triggers while the rendering of the gauge completed. */ - renderComplete? (e: RenderCompleteEventArgs): void; + renderComplete?(e: RenderCompleteEventArgs): void; } export interface DrawBarPointersEventArgs { @@ -44213,7 +44230,7 @@ export interface ScalesIndicator { /** Specifies the state ranges in bar indicators * @Default {Array} */ - stateRanges?: Array; + stateRanges?: ScalesIndicatorsStateRange[]; /** Specifies the textLocation in bar indicators * @Default {null} @@ -44525,7 +44542,7 @@ export interface Scale { /** Specifies the scaleBar Gradient of bar pointer * @Default {Array} */ - barPointers?: Array; + barPointers?: ScalesBarPointer[]; /** Specifies the border of the Scale. * @Default {null} @@ -44535,7 +44552,7 @@ export interface Scale { /** Specifies the customLabel * @Default {Array} */ - customLabels?: Array; + customLabels?: ScalesCustomLabel[]; /** Specifies the scale Direction of the Scale. See Directions * @Default {CounterClockwise} @@ -44545,12 +44562,12 @@ export interface Scale { /** Specifies the indicator * @Default {Array} */ - indicators?: Array; + indicators?: ScalesIndicator[]; /** Specifies the labels. * @Default {Array} */ - labels?: Array; + labels?: ScalesLabel[]; /** Specifies the scaleBar Length. * @Default {290} @@ -44565,7 +44582,7 @@ export interface Scale { /** Specifies the markerPointers * @Default {Array} */ - markerPointers?: Array; + markerPointers?: ScalesMarkerPointer[]; /** Specifies the maximum of the Scale. * @Default {null} @@ -44595,7 +44612,7 @@ export interface Scale { /** Specifies the ranges in the tick. * @Default {Array} */ - ranges?: Array; + ranges?: ScalesRange[]; /** Specifies the shadowOffset. * @Default {0} @@ -44640,7 +44657,7 @@ export interface Scale { /** Specifies the ticks in the scale. * @Default {Array} */ - ticks?: Array; + ticks?: ScalesTick[]; /** Specifies the scaleBar type .See ScaleType * @Default {Rectangle} @@ -44671,10 +44688,8 @@ export interface Tooltip { templateID?: string; } } -module LinearGauge -{ -enum OuterCustomLabelPosition -{ +namespace LinearGauge { +enum OuterCustomLabelPosition { //string Left, //string @@ -44685,10 +44700,8 @@ Top, Bottom, } } -module LinearGauge -{ -enum FontStyle -{ +namespace LinearGauge { +enum FontStyle { //string Bold, //string @@ -44701,20 +44714,16 @@ Strikeout, Underline, } } -module LinearGauge -{ -enum Direction -{ +namespace LinearGauge { +enum Direction { //string Clockwise, //string CounterClockwise, } } -module LinearGauge -{ -enum IndicatorTypes -{ +namespace LinearGauge { +enum IndicatorTypes { //string Rectangle, //string @@ -44725,10 +44734,8 @@ RoundedRectangle, Text, } } -module LinearGauge -{ -enum PointerPlacement -{ +namespace LinearGauge { +enum PointerPlacement { //string Near, //string @@ -44737,30 +44744,24 @@ Far, Center, } } -module LinearGauge -{ -enum ScaleType -{ +namespace LinearGauge { +enum ScaleType { //string Major, //string Minor, } } -module LinearGauge -{ -enum UnitTextPlacement -{ +namespace LinearGauge { +enum UnitTextPlacement { //string Back, //string From, } } -module LinearGauge -{ -enum MarkerType -{ +namespace LinearGauge { +enum MarkerType { //string Rectangle, //string @@ -44787,20 +44788,16 @@ Trapezoid, RoundedRectangle, } } -module LinearGauge -{ -enum TicksType -{ +namespace LinearGauge { +enum TicksType { //string Majorinterval, //string Minorinterval, } } -module LinearGauge -{ -enum Themes -{ +namespace LinearGauge { +enum Themes { //string FlatLight, //string @@ -44810,11 +44807,10 @@ FlatDark, class CircularGauge extends ej.Widget { static fn: CircularGauge; - constructor(element: JQuery, options?: CircularGauge.Model); - constructor(element: Element, options?: CircularGauge.Model); + constructor(element: JQuery | Element, options?: CircularGauge.Model); static Locale: any; - model:CircularGauge.Model; - defaults:CircularGauge.Model; + model: CircularGauge.Model; + defaults: CircularGauge.Model; /** destroy the circular gauge widget. all events bound using this._on will be unbind automatically and bring the control to pre-init state. * @returns {void} @@ -45236,7 +45232,7 @@ class CircularGauge extends ej.Widget { */ setTickWidth(): void; } -export module CircularGauge{ +export namespace CircularGauge { export interface Model { @@ -45318,7 +45314,7 @@ export interface Model { /** Specify the pointers, ticks, labels, indicators, ranges of circular gauge * @Default {null} */ - scales?: Array; + scales?: Scale[]; /** Specify the theme of circular gauge. * @Default {flatlight} @@ -45341,40 +45337,40 @@ export interface Model { width?: number; /** Triggers while the custom labels are being drawn on the gauge. */ - drawCustomLabel? (e: DrawCustomLabelEventArgs): void; + drawCustomLabel?(e: DrawCustomLabelEventArgs): void; /** Triggers while the indicators are being started to drawn on the gauge. */ - drawIndicators? (e: DrawIndicatorsEventArgs): void; + drawIndicators?(e: DrawIndicatorsEventArgs): void; /** Triggers while the labels are being drawn on the gauge. */ - drawLabels? (e: DrawLabelsEventArgs): void; + drawLabels?(e: DrawLabelsEventArgs): void; /** Triggers while the pointer cap is being drawn on the gauge. */ - drawPointerCap? (e: DrawPointerCapEventArgs): void; + drawPointerCap?(e: DrawPointerCapEventArgs): void; /** Triggers while the pointers are being drawn on the gauge. */ - drawPointers? (e: DrawPointersEventArgs): void; + drawPointers?(e: DrawPointersEventArgs): void; /** Triggers when the ranges begin to be getting drawn on the gauge. */ - drawRange? (e: DrawRangeEventArgs): void; + drawRange?(e: DrawRangeEventArgs): void; /** Triggers while the ticks are being drawn on the gauge. */ - drawTicks? (e: DrawTicksEventArgs): void; + drawTicks?(e: DrawTicksEventArgs): void; /** Triggers while the gauge start to Load. */ - load? (e: LoadEventArgs): void; + load?(e: LoadEventArgs): void; /** Triggers when the left mouse button is clicked. */ - mouseClick? (e: MouseClickEventArgs): void; + mouseClick?(e: MouseClickEventArgs): void; /** Triggers when clicking and dragging the mouse pointer over the gauge pointer. */ - mouseClickMove? (e: MouseClickMoveEventArgs): void; + mouseClickMove?(e: MouseClickMoveEventArgs): void; /** Triggers when the mouse click is released. */ - mouseClickUp? (e: MouseClickUpEventArgs): void; + mouseClickUp?(e: MouseClickUpEventArgs): void; /** Triggers when the rendering of the gauge is completed. */ - renderComplete? (e: RenderCompleteEventArgs): void; + renderComplete?(e: RenderCompleteEventArgs): void; } export interface DrawCustomLabelEventArgs { @@ -46095,7 +46091,7 @@ export interface ScalesIndicator { /** Specify the various states of circular gauge * @Default {Array} */ - stateRanges?: Array; + stateRanges?: ScalesIndicatorsStateRange[]; /** Specify indicator style of circular gauge. See IndicatorType * @Default {Circle} @@ -46528,17 +46524,17 @@ export interface Scale { /** Specify the custom labels for the scales. * @Default {Array} */ - customLabels?: Array; + customLabels?: ScalesCustomLabel[]; /** Specify representing state of circular gauge * @Default {Array} */ - indicators?: Array; + indicators?: ScalesIndicator[]; /** Specify the text values displayed in a meaningful manner alongside the ticks of circular gauge * @Default {Array} */ - labels?: Array; + labels?: ScalesLabel[]; /** Specify majorIntervalValue of circular gauge * @Default {10} @@ -46573,7 +46569,7 @@ export interface Scale { /** Specify pointers value of circular gauge * @Default {Array} */ - pointers?: Array; + pointers?: ScalesPointer[]; /** Specify scale radius of circular gauge * @Default {170} @@ -46583,7 +46579,7 @@ export interface Scale { /** Specify ranges value of circular gauge * @Default {Array} */ - ranges?: Array; + ranges?: ScalesRange[]; /** Specify shadowOffset value of circular gauge * @Default {0} @@ -46633,7 +46629,7 @@ export interface Scale { /** Specify subGauge of circular gauge * @Default {Array} */ - subGauges?: Array; + subGauges?: ScalesSubGauge[]; /** Specify sweepAngle of circular gauge * @Default {310} @@ -46643,7 +46639,7 @@ export interface Scale { /** Specify ticks of circular gauge * @Default {Array} */ - ticks?: Array; + ticks?: ScalesTick[]; } export interface Tooltip { @@ -46664,20 +46660,16 @@ export interface Tooltip { templateID?: string; } } -module CircularGauge -{ -enum FrameType -{ +namespace CircularGauge { +enum FrameType { //string FullCircle, //string HalfCircle, } } -module CircularGauge -{ -enum gaugePosition -{ +namespace CircularGauge { +enum gaugePosition { //string TopLeft, //string @@ -46698,10 +46690,8 @@ BottomRight, BottomCenter, } } -module CircularGauge -{ -enum CustomLabelPositionType -{ +namespace CircularGauge { +enum CustomLabelPositionType { //string Top, //string @@ -46712,20 +46702,16 @@ Right, Left, } } -module CircularGauge -{ -enum Direction -{ +namespace CircularGauge { +enum Direction { //string Clockwise, //string CounterClockwise, } } -module CircularGauge -{ -enum IndicatorTypes -{ +namespace CircularGauge { +enum IndicatorTypes { //string Rectangle, //string @@ -46738,40 +46724,32 @@ RoundedRectangle, Image, } } -module CircularGauge -{ -enum Placement -{ +namespace CircularGauge { +enum Placement { //string Near, //string Far, } } -module CircularGauge -{ -enum LabelType -{ +namespace CircularGauge { +enum LabelType { //string Major, //string Minor, } } -module CircularGauge -{ -enum UnitTextPlacement -{ +namespace CircularGauge { +enum UnitTextPlacement { //string Back, //string Front, } } -module CircularGauge -{ -enum MarkerType -{ +namespace CircularGauge { +enum MarkerType { //string Rectangle, //string @@ -46798,10 +46776,8 @@ RoundedRectangle, Image, } } -module CircularGauge -{ -enum NeedleType -{ +namespace CircularGauge { +enum NeedleType { //string Triangle, //string @@ -46814,10 +46790,8 @@ Image, Trapezoid, } } -module CircularGauge -{ -enum PointerType -{ +namespace CircularGauge { +enum PointerType { //string Needle, //string @@ -46827,11 +46801,10 @@ Marker, class DigitalGauge extends ej.Widget { static fn: DigitalGauge; - constructor(element: JQuery, options?: DigitalGauge.Model); - constructor(element: Element, options?: DigitalGauge.Model); + constructor(element: JQuery | Element, options?: DigitalGauge.Model); static Locale: any; - model:DigitalGauge.Model; - defaults:DigitalGauge.Model; + model: DigitalGauge.Model; + defaults: DigitalGauge.Model; /** To destroy the digital gauge * @returns {void} @@ -46876,7 +46849,7 @@ class DigitalGauge extends ej.Widget { */ setValue(itemIndex: number, value: string): void; } -export module DigitalGauge{ +export namespace DigitalGauge { export interface Model { @@ -46898,7 +46871,7 @@ export interface Model { /** Specifies the items for the DigitalGauge. * @Default {null} */ - items?: Array; + items?: Item[]; /** Specifies the matrixSegmentData for the DigitalGauge. */ @@ -46924,16 +46897,16 @@ export interface Model { width?: number; /** Triggers when the gauge is initialized. */ - init? (e: InitEventArgs): void; + init?(e: InitEventArgs): void; /** Triggers when the gauge item rendering. */ - itemRendering? (e: ItemRenderingEventArgs): void; + itemRendering?(e: ItemRenderingEventArgs): void; /** Triggers when the gauge is start to load. */ - load? (e: LoadEventArgs): void; + load?(e: LoadEventArgs): void; /** Triggers when the gauge render is completed. */ - renderComplete? (e: RenderCompleteEventArgs): void; + renderComplete?(e: RenderCompleteEventArgs): void; } export interface InitEventArgs { @@ -47212,10 +47185,8 @@ export interface Item { value?: string; } } -module DigitalGauge -{ -enum CharacterType -{ +namespace DigitalGauge { +enum CharacterType { //string SevenSegment, //string @@ -47228,10 +47199,8 @@ EightCrossEightDotMatrix, EightCrossEightSquareMatrix, } } -module DigitalGauge -{ -enum FontStyle -{ +namespace DigitalGauge { +enum FontStyle { //string Normal, //string @@ -47247,14 +47216,14 @@ Strikeout, class Chart extends ej.Widget { static fn: Chart; - constructor(element: JQuery, options?: Chart.Model); - constructor(element: Element, options?: Chart.Model); + constructor(element: JQuery | Element, options?: Chart.Model); static Locale: any; - model:Chart.Model; - defaults:Chart.Model; + model: Chart.Model; + defaults: Chart.Model; /** Animates the series and/or indicators in Chart. When parameter is not passed to this method, then all the series and indicators present in Chart are animated. - * @param {any} If an array collection is passed as parameter, series and indicator objects passed in array collection are animated.ExampleIf a series or indicator object is passed to this method, then the specific series or indicator is animated.Example, + * @param {any} If an array collection is passed as parameter, series and indicator objects passed in array collection are animated.ExampleIf a series + * or indicator object is passed to this method, then the specific series or indicator is animated.Example, * @returns {void} */ animate(options: any): void; @@ -47262,7 +47231,8 @@ class Chart extends ej.Widget { /** Exports chart as an image or to an excel file. Chart can be exported as an image only when exportCanvasRendering option is set to true. * @param {string} Type of the export operation to be performed. Following are the two export types that are supported now,1. 'image'2. 'excel'Example * @param {string} URL of the service, where the chart will be exported to excel.Example, - * @param {boolean} When this parameter is true, all the chart objects initialized to the same document are exported to a single excel file. This is an optional parameter. By default, it is false.Example, + * @param {boolean} When this parameter is true, all the chart objects initialized to the same document are exported to a single excel file. + * This is an optional parameter. By default, it is false.Example, * @returns {any} */ export(type: string, URL: string, exportMultipleChart: boolean): any; @@ -47272,13 +47242,13 @@ class Chart extends ej.Widget { */ redraw(): void; } -export module Chart{ +export namespace Chart { export interface Model { /** Options for adding and customizing annotations in Chart. */ - annotations?: Array; + annotations?: Annotation[]; /** URL of the image to be used as chart background. * @Default {null} @@ -47299,7 +47269,7 @@ export interface Model { /** Options to split Chart into multiple plotting areas vertically. Each object in the collection represents a plotting area in Chart. */ - columnDefinitions?: Array; + columnDefinitions?: ColumnDefinition[]; /** Options for configuring the properties of all the series. You can also override the options for specific series by using series collection. */ @@ -47324,7 +47294,8 @@ export interface Model { */ enableCanvasRendering?: boolean; - /** Controls whether the series has to be rendered at initial loading of chart, this will be useful in scenarios where chart is placed at the bottom of the web page and we need to render the series only when the chart is visible while scrolling to the top. + /** Controls whether the series has to be rendered at initial loading of chart, this will be useful in scenarios where chart is placed at the bottom of the web page + * and we need to render the series only when the chart is visible while scrolling to the top. * @Default {true} */ initSeriesRender?: boolean; @@ -47336,7 +47307,7 @@ export interface Model { /** Options to customize the technical indicators. */ - indicators?: Array; + indicators?: Indicator[]; /** Controls whether Chart has to be responsive while resizing. * @Default {false} @@ -47347,7 +47318,8 @@ export interface Model { */ legend?: Legend; - /** Name of the culture based on which chart should be localized. Number and date time values are localized with respect to the culture name.String type properties like title text are not localized automatically. Provide localized text as value to string type properties. + /** Name of the culture based on which chart should be localized. Number and date time values are localized with respect to the culture name.String type properties like title text are + * not localized automatically. Provide localized text as value to string type properties. * @Default {en-US} */ locale?: string; @@ -47355,26 +47327,32 @@ export interface Model { /** Palette is used to store the series fill color in array and apply the color to series collection in the order of series index. * @Default {null} */ - palette?: Array; + palette?: any[]; /** Options to customize the left, right, top and bottom margins of chart area. */ Margin?: any; - /** Perspective angle of the 3D view. Chart appears closer when perspective angle is decreased, and distant when perspective angle is increased.This property is applicable only when 3D view is enabled + /** Perspective angle of the 3D view. Chart appears closer when perspective angle is decreased, and distant when perspective angle is increased. + * This property is applicable only when 3D view is enabled * @Default {90} */ perspectiveAngle?: number; - /** This is a horizontal axis that contains options to configure axis and it is the primary x axis for all the series in series array. To override x axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. Then, assign the name to the seriesĂ¢â‚¬â„¢s xAxisName property to link both axis and series. + /** This is a horizontal axis that contains options to configure axis and it is the primary x axis for all the series in series array. + * To override x axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. + * Then, assign the name to the seriesĂ¢â‚¬â„¢s xAxisName property to link both axis and series. */ primaryXAxis?: PrimaryXAxis; - /** To override x axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. Then, assign the name to the seriesĂ¢â‚¬â„¢s xAxisName property to link both axis and series. + /** To override x axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. + * Then, assign the name to the seriesĂ¢â‚¬â„¢s xAxisName property to link both axis and series. */ - axes?: Array; + axes?: Axis[]; - /** This is a vertical axis that contains options to configure axis. This is the primary y axis for all the series in series array. To override y axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. Then, assign the name to the seriesĂ¢â‚¬â„¢s yAxisName property to link both axis and series. + /** This is a vertical axis that contains options to configure axis. This is the primary y axis for all the series in series array. + * To override y axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. + * Then, assign the name to the seriesĂ¢â‚¬â„¢s yAxisName property to link both axis and series. */ primaryYAxis?: PrimaryYAxis; @@ -47385,11 +47363,11 @@ export interface Model { /** Options to split Chart into multiple plotting areas horizontally. Each object in the collection represents a plotting area in Chart. */ - rowDefinitions?: Array; + rowDefinitions?: RowDefinition[]; /** Specifies the properties used for customizing the series. */ - series?: Array; + series?: Series[]; /** Controls whether data points has to be displayed side by side or along the depth of the axis. * @Default {false} @@ -47424,115 +47402,116 @@ export interface Model { zooming?: Zooming; /** Fires after the series animation is completed. This event will be triggered for each series when animation is enabled. */ - animationComplete? (e: AnimationCompleteEventArgs): void; + animationComplete?(e: AnimationCompleteEventArgs): void; /** Fires before rendering the labels. This event is fired for each label in axis. You can use this event to add custom text to axis labels. */ - axesLabelRendering? (e: AxesLabelRenderingEventArgs): void; + axesLabelRendering?(e: AxesLabelRenderingEventArgs): void; /** Fires during the initialization of axis labels. */ - axesLabelsInitialize? (e: AxesLabelsInitializeEventArgs): void; + axesLabelsInitialize?(e: AxesLabelsInitializeEventArgs): void; /** Fires during axes range calculation. This event is fired for each axis present in Chart. You can use this event to customize axis range as required. */ - axesRangeCalculate? (e: AxesRangeCalculateEventArgs): void; + axesRangeCalculate?(e: AxesRangeCalculateEventArgs): void; /** Fires before rendering the axis title. This event is triggered for each axis with title. You can use this event to add custom text to axis title. */ - axesTitleRendering? (e: AxesTitleRenderingEventArgs): void; + axesTitleRendering?(e: AxesTitleRenderingEventArgs): void; /** Fires during the calculation of chart area bounds. You can use this event to customize the bounds of chart area. */ - chartAreaBoundsCalculate? (e: ChartAreaBoundsCalculateEventArgs): void; + chartAreaBoundsCalculate?(e: ChartAreaBoundsCalculateEventArgs): void; /** Fires after chart is created. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; /** Fires when chart is destroyed completely. */ - destroy? (e: DestroyEventArgs): void; + destroy?(e: DestroyEventArgs): void; /** Fires before rendering the data labels. This event is triggered for each data label in the series. You can use this event to add custom text in data labels. */ - displayTextRendering? (e: DisplayTextRenderingEventArgs): void; + displayTextRendering?(e: DisplayTextRenderingEventArgs): void; /** Fires during the calculation of legend bounds. You can use this event to customize the bounds of legend. */ - legendBoundsCalculate? (e: LegendBoundsCalculateEventArgs): void; + legendBoundsCalculate?(e: LegendBoundsCalculateEventArgs): void; /** Fires on clicking the legend item. */ - legendItemClick? (e: LegendItemClickEventArgs): void; + legendItemClick?(e: LegendItemClickEventArgs): void; /** Fires when moving mouse over legend item. You can use this event for hit testing on legend items. */ - legendItemMouseMove? (e: LegendItemMouseMoveEventArgs): void; + legendItemMouseMove?(e: LegendItemMouseMoveEventArgs): void; /** Fires before rendering the legend item. This event is fired for each legend item in Chart. You can use this event to customize legend item shape or add custom text to legend item. */ - legendItemRendering? (e: LegendItemRenderingEventArgs): void; + legendItemRendering?(e: LegendItemRenderingEventArgs): void; /** Fires before loading the chart. */ - load? (e: LoadEventArgs): void; + load?(e: LoadEventArgs): void; /** Fires after selected the data in chart. */ - rangeSelected? (e: RangeSelectedEventArgs): void; + rangeSelected?(e: RangeSelectedEventArgs): void; /** Fires on clicking a point in chart. You can use this event to handle clicks made on points. */ - pointRegionClick? (e: PointRegionClickEventArgs): void; + pointRegionClick?(e: PointRegionClickEventArgs): void; /** Fires when mouse is moved over a point. */ - pointRegionMouseMove? (e: PointRegionMouseMoveEventArgs): void; + pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; /** Fires before rendering chart. */ - preRender? (e: PreRenderEventArgs): void; + preRender?(e: PreRenderEventArgs): void; /** Fires after selecting a series. This event is triggered after selecting a series only if selection mode is series. */ - seriesRegionClick? (e: SeriesRegionClickEventArgs): void; + seriesRegionClick?(e: SeriesRegionClickEventArgs): void; /** Fires before rendering a series. This event is fired for each series in Chart. */ - seriesRendering? (e: SeriesRenderingEventArgs): void; + seriesRendering?(e: SeriesRenderingEventArgs): void; /** Fires before rendering the marker symbols. This event is triggered for each marker in Chart. */ - symbolRendering? (e: SymbolRenderingEventArgs): void; + symbolRendering?(e: SymbolRenderingEventArgs): void; /** Fires before rendering the Chart title. You can use this event to add custom text in Chart title. */ - titleRendering? (e: TitleRenderingEventArgs): void; + titleRendering?(e: TitleRenderingEventArgs): void; /** Fires before rendering the tooltip. This event is fired when tooltip is enabled and mouse is hovered on a Chart point. You can use this event to customize tooltip before rendering. */ - toolTipInitialize? (e: ToolTipInitializeEventArgs): void; + toolTipInitialize?(e: ToolTipInitializeEventArgs): void; /** Fires before rendering crosshair tooltip in axis. This event is fired for each axis with crosshair label enabled. You can use this event to customize crosshair label before rendering */ - trackAxisToolTip? (e: TrackAxisToolTipEventArgs): void; + trackAxisToolTip?(e: TrackAxisToolTipEventArgs): void; - /** Fires before rendering trackball tooltip. This event is fired for each series in Chart because trackball tooltip is displayed for all the series. You can use this event to customize the text displayed in trackball tooltip. */ - trackToolTip? (e: TrackToolTipEventArgs): void; + /** Fires before rendering trackball tooltip. This event is fired for each series in Chart because trackball tooltip is displayed for all the series. + * You can use this event to customize the text displayed in trackball tooltip. */ + trackToolTip?(e: TrackToolTipEventArgs): void; /** Fires, on clicking the axis label. */ - axisLabelClick? (e: AxisLabelClickEventArgs): void; + axisLabelClick?(e: AxisLabelClickEventArgs): void; /** Fires on moving mouse over the axis label. */ - axisLabelMouseMove? (e: AxisLabelMouseMoveEventArgs): void; + axisLabelMouseMove?(e: AxisLabelMouseMoveEventArgs): void; /** Fires, on the clicking the chart. */ - chartClick? (e: ChartClickEventArgs): void; + chartClick?(e: ChartClickEventArgs): void; /** Fires on moving mouse over the chart. */ - chartMouseMove? (e: ChartMouseMoveEventArgs): void; + chartMouseMove?(e: ChartMouseMoveEventArgs): void; /** Fires, on double clicking the chart. */ - chartDoubleClick? (e: ChartDoubleClickEventArgs): void; + chartDoubleClick?(e: ChartDoubleClickEventArgs): void; /** Fires on clicking the annotation. */ - annotationClick? (e: AnnotationClickEventArgs): void; + annotationClick?(e: AnnotationClickEventArgs): void; /** Fires, after the chart is resized. */ - afterResize? (e: AfterResizeEventArgs): void; + afterResize?(e: AfterResizeEventArgs): void; /** Fires, when chart size is changing. */ - beforeResize? (e: BeforeResizeEventArgs): void; + beforeResize?(e: BeforeResizeEventArgs): void; /** Fires, when error bar is rendering. */ - errorBarRendering? (e: ErrorBarRenderingEventArgs): void; + errorBarRendering?(e: ErrorBarRenderingEventArgs): void; /** Trigger, after the scrollbar position is changed. */ - scrollChanged? (e: ScrollChangedEventArgs): void; + scrollChanged?(e: ScrollChangedEventArgs): void; /** Event triggered when scroll starts */ - scrollStart? (e: ScrollStartEventArgs): void; + scrollStart?(e: ScrollStartEventArgs): void; /** Event triggered when scroll end */ - scrollEnd? (e: ScrollEndEventArgs): void; + scrollEnd?(e: ScrollEndEventArgs): void; } export interface AnimationCompleteEventArgs { @@ -47558,15 +47537,15 @@ export interface AxesLabelRenderingEventArgs { /** Instance of the corresponding axis. */ - axis?: any; + Axis?: any; /** Formatted text of the respective label. You can also add custom text to the label. */ - Text?: string; + LabelText?: string; /** Actual value of the label. */ - Value?: string; + LabelValue?: string; /** Set this option to true to cancel the event. */ @@ -47737,11 +47716,11 @@ export interface DisplayTextRenderingEventArgs { */ locationY?: number; - /** Index of the series in series Collection whose data label is being rendered + /** Index of the series in series Collection whose data label is being rendered */ seriesIndex?: number; - /** Index of the point in series whose data label is being rendered + /** Index of the point in series whose data label is being rendered */ pointIndex?: number; @@ -48061,7 +48040,7 @@ export interface SeriesRenderingEventArgs { export interface SymbolRenderingEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48084,7 +48063,7 @@ export interface SymbolRenderingEventArgs { export interface TitleRenderingEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48111,7 +48090,7 @@ export interface TitleRenderingEventArgs { export interface ToolTipInitializeEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48138,7 +48117,7 @@ export interface ToolTipInitializeEventArgs { export interface TrackAxisToolTipEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48169,7 +48148,7 @@ export interface TrackAxisToolTipEventArgs { export interface TrackToolTipEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48204,7 +48183,7 @@ export interface TrackToolTipEventArgs { export interface AxisLabelClickEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48216,7 +48195,7 @@ export interface AxisLabelClickEventArgs { */ type?: string; - /** X and Y co-ordinate of the labels in chart area. + /** X and Y co-ordinate of the labels in chart area. */ location?: any; @@ -48235,7 +48214,7 @@ export interface AxisLabelClickEventArgs { export interface AxisLabelMouseMoveEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48247,7 +48226,7 @@ export interface AxisLabelMouseMoveEventArgs { */ type?: string; - /** X and Y co-ordinate of the labels in chart area. + /** X and Y co-ordinate of the labels in chart area. */ location?: any; @@ -48266,7 +48245,7 @@ export interface AxisLabelMouseMoveEventArgs { export interface ChartClickEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48278,30 +48257,30 @@ export interface ChartClickEventArgs { */ type?: string; - /** X and Y co-ordinate of the points with respect to chart area. + /** X and Y co-ordinate of the points with respect to chart area. */ location?: any; - /** ID of the target element. + /** ID of the target element. */ id?: string; - /** Width and height of the chart. + /** Width and height of the chart. */ size?: any; - /** x-coordinate of the pointer, relative to the page + /** x-coordinate of the pointer, relative to the page */ pageX?: number; - /** y-coordinate of the pointer, relative to the page + /** y-coordinate of the pointer, relative to the page */ pageY?: number; } export interface ChartMouseMoveEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48313,30 +48292,30 @@ export interface ChartMouseMoveEventArgs { */ type?: string; - /** X and Y co-ordinate of the points with respect to chart area. + /** X and Y co-ordinate of the points with respect to chart area. */ location?: any; - /** ID of the target element. + /** ID of the target element. */ id?: string; - /** Width and height of the chart. + /** Width and height of the chart. */ size?: any; - /** x-coordinate of the pointer, relative to the page + /** x-coordinate of the pointer, relative to the page */ pageX?: number; - /** y-coordinate of the pointer, relative to the page + /** y-coordinate of the pointer, relative to the page */ pageY?: number; } export interface ChartDoubleClickEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48348,30 +48327,30 @@ export interface ChartDoubleClickEventArgs { */ type?: string; - /** X and Y co-ordinate of the points with respect to chart area. + /** X and Y co-ordinate of the points with respect to chart area. */ location?: any; - /** ID of the target element. + /** ID of the target element. */ id?: string; - /** Width and height of the chart. + /** Width and height of the chart. */ size?: any; - /** x-coordinate of the pointer, relative to the page + /** x-coordinate of the pointer, relative to the page */ pageX?: number; - /** y-coordinate of the pointer, relative to the page + /** y-coordinate of the pointer, relative to the page */ pageY?: number; } export interface AnnotationClickEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48383,26 +48362,26 @@ export interface AnnotationClickEventArgs { */ type?: string; - /** X and Y co-ordinate of the annotation in chart area. + /** X and Y co-ordinate of the annotation in chart area. */ location?: any; - /** Information about the annotation, like Coordinate unit, Region, content + /** Information about the annotation, like Coordinate unit, Region, content */ contentData?: any; - /** x-coordinate of the pointer, relative to the page + /** x-coordinate of the pointer, relative to the page */ pageX?: number; - /** y-coordinate of the pointer, relative to the page + /** y-coordinate of the pointer, relative to the page */ pageY?: number; } export interface AfterResizeEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48414,34 +48393,34 @@ export interface AfterResizeEventArgs { */ type?: string; - /** Chart width, after resize + /** Chart width, after resize */ width?: number; - /** Chart height, after resize + /** Chart height, after resize */ height?: number; - /** Chart width, before resize + /** Chart width, before resize */ prevWidth?: number; - /** Chart height, before resize + /** Chart height, before resize */ prevHeight?: number; - /** Chart width, when the chart was first rendered + /** Chart width, when the chart was first rendered */ originalWidth?: number; - /** Chart height, when the chart was first rendered + /** Chart height, when the chart was first rendered */ originalHeight?: number; } export interface BeforeResizeEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48453,26 +48432,26 @@ export interface BeforeResizeEventArgs { */ type?: string; - /** Chart width, before resize + /** Chart width, before resize */ currentWidth?: number; - /** Chart height, before resize + /** Chart height, before resize */ currentHeight?: number; - /** Chart width, after resize + /** Chart width, after resize */ newWidth?: number; - /** Chart height, after resize + /** Chart height, after resize */ newHeight?: number; } export interface ErrorBarRenderingEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -48484,7 +48463,7 @@ export interface ErrorBarRenderingEventArgs { */ type?: string; - /** Error bar Object + /** Error bar Object */ errorbar?: any; } @@ -48638,7 +48617,8 @@ export interface Annotation { */ visible?: boolean; - /** Represents the horizontal offset when coordinateUnit is pixels.when coordinateUnit is points, it represents the x-coordinate of axis bounded with xAxisName property or primary X axis when xAxisName is not provided.This property is not applicable when coordinateUnit is none. + /** Represents the horizontal offset when coordinateUnit is pixels.when coordinateUnit is points, it represents the x-coordinate of axis bounded with xAxisName property + * or primary X axis when xAxisName is not provided.This property is not applicable when coordinateUnit is none. * @Default {0} */ x?: number; @@ -48647,7 +48627,8 @@ export interface Annotation { */ xAxisName?: string; - /** Represents the vertical offset when coordinateUnit is pixels.When coordinateUnit is points, it represents the y-coordinate of axis bounded with yAxisName property or primary Y axis when yAxisName is not provided.This property is not applicable when coordinateUnit is none. + /** Represents the vertical offset when coordinateUnit is pixels.When coordinateUnit is points, it represents the y-coordinate of axis bounded with + * yAxisName property or primary Y axis when yAxisName is not provided.This property is not applicable when coordinateUnit is none. * @Default {0} */ y?: number; @@ -49765,7 +49746,7 @@ export interface CommonSeriesOptions { /** Option to add the trendlines to chart. */ - trendlines?: Array; + trendlines?: CommonSeriesOptionsTrendline[]; /** Options for customizing the appearance of the series or data point while highlighting. */ @@ -50744,7 +50725,8 @@ export interface PrimaryXAxisStripLine { */ width?: number; - /** Specifies the order where the strip line and the series have to be rendered. When Z-order is Ă¢â‚¬Å“behindĂ¢â‚¬Â, strip line is rendered under the series and when it is Ă¢â‚¬Å“overĂ¢â‚¬Â, it is rendered above the series. + /** Specifies the order where the strip line and the series have to be rendered. When Z-order is Ă¢â‚¬Å“behindĂ¢â‚¬Â, strip line is rendered + * under the series and when it is Ă¢â‚¬Å“overĂ¢â‚¬Â, it is rendered above the series. * @Default {over. See ZIndex} */ zIndex?: ej.datavisualization.Chart.ZIndex|string; @@ -50838,12 +50820,14 @@ export interface PrimaryXAxis { */ alternateGridBand?: PrimaryXAxisAlternateGridBand; - /** Specifies where horizontal axis should intersect the vertical axis or vice versa. Value should be provided in axis co-ordinates. If provided value is greater than the maximum value of crossing axis, then axis will be placed at the opposite side. + /** Specifies where horizontal axis should intersect the vertical axis or vice versa. Value should be provided in axis co-ordinates. + * If provided value is greater than the maximum value of crossing axis, then axis will be placed at the opposite side. * @Default {null} */ crossesAt?: number; - /** Name of the axis used for crossing. Vertical axis name should be provided for horizontal axis and vice versa. If the provided name does not belongs to a valid axis, then primary X axis or primary Y axis will be used for crossing + /** Name of the axis used for crossing. Vertical axis name should be provided for horizontal axis and vice versa. + * If the provided name does not belongs to a valid axis, then primary X axis or primary Y axis will be used for crossing * @Default {null} */ crossesInAxis?: string; @@ -50998,12 +50982,12 @@ export interface PrimaryXAxis { /** Options for customizing the multi level labels. * @Default {[ ]} */ - multiLevelLabels?: Array; + multiLevelLabels?: PrimaryXAxisMultiLevelLabel[]; /** Options for customizing the strip lines. * @Default {[ ]} */ - stripLine?: Array; + stripLine?: PrimaryXAxisStripLine[]; /** Specifies the position of the axis tick lines. * @Default {outside. See TickLinesPosition} @@ -51424,7 +51408,8 @@ export interface AxesStripLine { */ width?: number; - /** Specifies the order where the strip line and the series have to be rendered. When Z-order is Ă¢â‚¬Å“behindĂ¢â‚¬Â, strip line is rendered under the series and when it is Ă¢â‚¬Å“overĂ¢â‚¬Â, it is rendered above the series. + /** Specifies the order where the strip line and the series have to be rendered. When Z-order is Ă¢â‚¬Å“behindĂ¢â‚¬Â, strip line is rendered under the series and when it is Ă¢â‚¬Å“overĂ¢â‚¬Â, + * it is rendered above the series. * @Default {over. See ZIndex} */ zIndex?: ej.datavisualization.Chart.ZIndex|string; @@ -51518,7 +51503,8 @@ export interface Axis { */ alternateGridBand?: AxesAlternateGridBand; - /** Specifies where axis should intersect the vertical axis or vice versa. Value should be provided in axis co-ordinates. If provided value is greater than the maximum value of crossing axis, then axis will be placed at the opposite side. + /** Specifies where axis should intersect the vertical axis or vice versa. Value should be provided in axis co-ordinates. If provided value is greater than the maximum value of crossing axis, + * then axis will be placed at the opposite side. * @Default {null} */ crossesAt?: number; @@ -51673,12 +51659,12 @@ export interface Axis { /** Options for customizing the multi level labels. * @Default {[ ]} */ - multiLevelLabels?: Array; + multiLevelLabels?: AxesMultiLevelLabel[]; /** Options for customizing the strip lines. * @Default {[ ]} */ - stripLine?: Array; + stripLine?: AxesStripLine[]; /** Specifies the position of the axis tick lines. * @Default {outside. See TickLinesPosition} @@ -52099,7 +52085,8 @@ export interface PrimaryYAxisStripLine { */ width?: number; - /** Specifies the order in which strip line and the series have to be rendered. When Z-order is Ă¢â‚¬Å“behindĂ¢â‚¬Â, strip line is rendered below the series and when it is Ă¢â‚¬Å“overĂ¢â‚¬Â, it is rendered above the series. + /** Specifies the order in which strip line and the series have to be rendered. When Z-order is Ă¢â‚¬Å“behindĂ¢â‚¬Â, strip line is rendered below the series and + * when it is Ă¢â‚¬Å“overĂ¢â‚¬Â, it is rendered above the series. * @Default {over. See ZIndex} */ zIndex?: ej.datavisualization.Chart.ZIndex|string; @@ -52197,12 +52184,14 @@ export interface PrimaryYAxis { */ axisLine?: PrimaryYAxisAxisLine; - /** Specifies where horizontal axis should intersect the vertical axis or vice versa. Value should be provided in axis co-ordinates. If provided value is greater than the maximum value of crossing axis, then axis will be placed at the opposite side. + /** Specifies where horizontal axis should intersect the vertical axis or vice versa. Value should be provided in axis co-ordinates. + * If provided value is greater than the maximum value of crossing axis, then axis will be placed at the opposite side. * @Default {null} */ crossesAt?: number; - /** Name of the axis used for crossing. Vertical axis name should be provided for horizontal axis and vice versa. If the provided name does not belongs to a valid axis, then primary X axis or primary Y axis will be used for crossing + /** Name of the axis used for crossing. Vertical axis name should be provided for horizontal axis and vice versa. If the provided name does not belongs to a valid axis, + * then primary X axis or primary Y axis will be used for crossing * @Default {null} */ crossesInAxis?: string; @@ -52343,12 +52332,12 @@ export interface PrimaryYAxis { /** Options for customizing the multi level labels. * @Default {[ ]} */ - multiLevelLabels?: Array; + multiLevelLabels?: PrimaryYAxisMultiLevelLabel[]; /** Options for customizing the strip lines. * @Default {[ ]} */ - stripLine?: Array; + stripLine?: PrimaryYAxisStripLine[]; /** Specifies the position of the axis tick lines. * @Default {outside. See TickLinesPosition} @@ -53638,7 +53627,7 @@ export interface Series { /** Option to add data points; each point should have x and y property. Also, optionally, you can customize the points color, border, marker by using fill, border and marker options. */ - points?: Array; + points?: SeriesPoint[]; /** Specifies the mode of the pyramid series. * @Default {linear} @@ -53735,7 +53724,7 @@ export interface Series { /** Option to add trendlines to chart. */ - trendlines?: Array; + trendlines?: SeriesTrendline[]; /** Options for customizing the appearance of the series or data point while highlighting. */ @@ -53950,13 +53939,11 @@ export interface Zooming { /** To display user specified buttons in zooming toolbar. * @Default {[zoomIn, zoomOut, zoom, pan, reset]} */ - toolbarItems?: Array; + toolbarItems?: any[]; } } -module Chart -{ -enum CoordinateUnit -{ +namespace Chart { +enum CoordinateUnit { //string None, //string @@ -53965,10 +53952,8 @@ Pixels, Points, } } -module Chart -{ -enum HorizontalAlignment -{ +namespace Chart { +enum HorizontalAlignment { //string Left, //string @@ -53977,20 +53962,16 @@ Right, Middle, } } -module Chart -{ -enum Region -{ +namespace Chart { +enum Region { //string Chart, //string Series, } } -module Chart -{ -enum VerticalAlignment -{ +namespace Chart { +enum VerticalAlignment { //string Top, //string @@ -53999,10 +53980,8 @@ Bottom, Middle, } } -module Chart -{ -enum ExportingType -{ +namespace Chart { +enum ExportingType { //string PNG, //string @@ -54017,50 +53996,40 @@ XLSX, SVG, } } -module Chart -{ -enum ExportingOrientation -{ +namespace Chart { +enum ExportingOrientation { //string Portrait, //string Landscape, } } -module Chart -{ -enum ExportingMode -{ +namespace Chart { +enum ExportingMode { //string ServerSide, //string ClientSide, } } -module Chart -{ -enum Unit -{ +namespace Chart { +enum Unit { //string Percentage, //string Pixel, } } -module Chart -{ -enum ColumnFacet -{ +namespace Chart { +enum ColumnFacet { //string Rectangle, //string Cylinder, } } -module Chart -{ -enum DrawType -{ +namespace Chart { +enum DrawType { //string Line, //string @@ -54069,20 +54038,16 @@ Area, Column, } } -module Chart -{ -enum FontStyle -{ +namespace Chart { +enum FontStyle { //string Normal, //string Italic, } } -module Chart -{ -enum FontWeight -{ +namespace Chart { +enum FontWeight { //string Regular, //string @@ -54091,10 +54056,8 @@ Bold, Lighter, } } -module Chart -{ -enum LabelPosition -{ +namespace Chart { +enum LabelPosition { //string Inside, //string @@ -54103,10 +54066,8 @@ Outside, OutsideExtended, } } -module Chart -{ -enum boxPlotMode -{ +namespace Chart { +enum boxPlotMode { //string Exclusive, //string @@ -54115,10 +54076,8 @@ Inclusive, Normal, } } -module Chart -{ -enum LineCap -{ +namespace Chart { +enum LineCap { //string Butt, //string @@ -54127,10 +54086,8 @@ Round, Square, } } -module Chart -{ -enum LineJoin -{ +namespace Chart { +enum LineJoin { //string Round, //string @@ -54139,20 +54096,16 @@ Bevel, Miter, } } -module Chart -{ -enum ConnectorLineType -{ +namespace Chart { +enum ConnectorLineType { //string Line, //string Bezier, } } -module Chart -{ -enum HorizontalTextAlignment -{ +namespace Chart { +enum HorizontalTextAlignment { //string Center, //string @@ -54161,10 +54114,8 @@ Near, Far, } } -module Chart -{ -enum Shape -{ +namespace Chart { +enum Shape { //string None, //string @@ -54205,10 +54156,8 @@ Image, SeriesType, } } -module Chart -{ -enum TextPosition -{ +namespace Chart { +enum TextPosition { //string Top, //string @@ -54217,10 +54166,8 @@ Bottom, Middle, } } -module Chart -{ -enum VerticalTextAlignment -{ +namespace Chart { +enum VerticalTextAlignment { //string Center, //string @@ -54229,20 +54176,16 @@ Near, Far, } } -module Chart -{ -enum PyramidMode -{ +namespace Chart { +enum PyramidMode { //string Linear, //string Surface, } } -module Chart -{ -enum Type -{ +namespace Chart { +enum Type { //string Area, //string @@ -54299,10 +54242,8 @@ Radar, RangeArea, } } -module Chart -{ -enum EmptyPointMode -{ +namespace Chart { +enum EmptyPointMode { //string Gap, //string @@ -54311,10 +54252,8 @@ Zero, Average, } } -module Chart -{ -enum ErrorBarType -{ +namespace Chart { +enum ErrorBarType { //string FixedValue, //string @@ -54325,10 +54264,8 @@ StandardDeviation, StandardError, } } -module Chart -{ -enum ErrorBarMode -{ +namespace Chart { +enum ErrorBarMode { //string Both, //string @@ -54337,10 +54274,8 @@ Vertical, Horizontal, } } -module Chart -{ -enum ErrorBarDirection -{ +namespace Chart { +enum ErrorBarDirection { //string Both, //string @@ -54349,10 +54284,8 @@ Plus, Minus, } } -module Chart -{ -enum Mode -{ +namespace Chart { +enum Mode { //string Series, //string @@ -54363,20 +54296,16 @@ Cluster, Range, } } -module Chart -{ -enum SelectionType -{ +namespace Chart { +enum SelectionType { //string Single, //string Multiple, } } -module Chart -{ -enum RangeType -{ +namespace Chart { +enum RangeType { //string XY, //string @@ -54385,30 +54314,24 @@ X, Y, } } -module Chart -{ -enum CrosshairMode -{ +namespace Chart { +enum CrosshairMode { //string Float, //string Grouping, } } -module Chart -{ -enum CrosshairType -{ +namespace Chart { +enum CrosshairType { //string Crosshair, //string Trackball, } } -module Chart -{ -enum Alignment -{ +namespace Chart { +enum Alignment { //string Center, //string @@ -54417,10 +54340,8 @@ Near, Far, } } -module Chart -{ -enum Position -{ +namespace Chart { +enum Position { //string Left, //string @@ -54431,10 +54352,8 @@ Top, Bottom, } } -module Chart -{ -enum TextOverflow -{ +namespace Chart { +enum TextOverflow { //string None, //string @@ -54445,20 +54364,16 @@ Wrap, WrapAndTrim, } } -module Chart -{ -enum LabelPlacement -{ +namespace Chart { +enum LabelPlacement { //string OnTicks, //string BetweenTicks, } } -module Chart -{ -enum EdgeLabelPlacement -{ +namespace Chart { +enum EdgeLabelPlacement { //string None, //string @@ -54467,10 +54382,8 @@ Shift, Hide, } } -module Chart -{ -enum IntervalType -{ +namespace Chart { +enum IntervalType { //string Days, //string @@ -54487,10 +54400,8 @@ Months, Years, } } -module Chart -{ -enum LabelIntersectAction -{ +namespace Chart { +enum LabelIntersectAction { //string None, //string @@ -54509,10 +54420,8 @@ Hide, MultipleRows, } } -module Chart -{ -enum LabelAlignment -{ +namespace Chart { +enum LabelAlignment { //string Near, //string @@ -54521,10 +54430,8 @@ Far, Center, } } -module Chart -{ -enum RangePadding -{ +namespace Chart { +enum RangePadding { //string Additional, //string @@ -54535,10 +54442,8 @@ None, Round, } } -module Chart -{ -enum MultiLevelLabelsBorderType -{ +namespace Chart { +enum MultiLevelLabelsBorderType { //string Rectangle, //string @@ -54551,10 +54456,8 @@ Brace, CurlyBrace, } } -module Chart -{ -enum TextAlignment -{ +namespace Chart { +enum TextAlignment { //string MiddleTop, //string @@ -54563,30 +54466,24 @@ MiddleCenter, MiddleBottom, } } -module Chart -{ -enum ZIndex -{ +namespace Chart { +enum ZIndex { //string Inside, //string Over, } } -module Chart -{ -enum TickLinesPosition -{ +namespace Chart { +enum TickLinesPosition { //string Inside, //string Outside, } } -module Chart -{ -enum ValueType -{ +namespace Chart { +enum ValueType { //string Double, //string @@ -54597,10 +54494,8 @@ DateTime, Logarithmic, } } -module Chart -{ -enum Theme -{ +namespace Chart { +enum Theme { //string Azure, //string @@ -54626,18 +54521,17 @@ GradientDark, class RangeNavigator extends ej.Widget { static fn: RangeNavigator; - constructor(element: JQuery, options?: RangeNavigator.Model); - constructor(element: Element, options?: RangeNavigator.Model); + constructor(element: JQuery | Element, options?: RangeNavigator.Model); static Locale: any; - model:RangeNavigator.Model; - defaults:RangeNavigator.Model; + model: RangeNavigator.Model; + defaults: RangeNavigator.Model; /** destroy the range navigator widget * @returns {void} */ _destroy(): void; } -export module RangeNavigator{ +export namespace RangeNavigator { export interface Model { @@ -54656,7 +54550,7 @@ export interface Model { /** Specifies the properties used for customizing the range series. */ - series?: Array; + series?: Series[]; /** Toggles the redrawing of chart on moving the sliders. * @Default {true} @@ -54748,22 +54642,22 @@ export interface Model { yName?: any; /** Fires on load of range navigator. */ - load? (e: LoadEventArgs): void; + load?(e: LoadEventArgs): void; /** Fires after range navigator is loaded. */ - loaded? (e: LoadedEventArgs): void; + loaded?(e: LoadedEventArgs): void; /** Fires on changing the range of range navigator. */ - rangeChanged? (e: RangeChangedEventArgs): void; + rangeChanged?(e: RangeChangedEventArgs): void; /** Fires on changing the scrollbar position of range navigator. */ - scrollChanged? (e: ScrollChangedEventArgs): void; + scrollChanged?(e: ScrollChangedEventArgs): void; /** Fires on when starting to change the scrollbar position of range navigator. */ - scrollStart? (e: ScrollStartEventArgs): void; + scrollStart?(e: ScrollStartEventArgs): void; /** Fires on changes ending the scrollbar position of range navigator. */ - scrollEnd? (e: ScrollEndEventArgs): void; + scrollEnd?(e: ScrollEndEventArgs): void; } export interface LoadEventArgs { @@ -55622,10 +55516,8 @@ export interface ValueAxisSettings { visible?: boolean; } } -module RangeNavigator -{ -enum Type -{ +namespace RangeNavigator { +enum Type { //string Area, //string @@ -55640,10 +55532,8 @@ SplineArea, StepLine, } } -module RangeNavigator -{ -enum IntervalType -{ +namespace RangeNavigator { +enum IntervalType { //string Years, //string @@ -55660,30 +55550,24 @@ Hours, Minutes, } } -module RangeNavigator -{ -enum LabelPlacement -{ +namespace RangeNavigator { +enum LabelPlacement { //string Inside, //string Outside, } } -module RangeNavigator -{ -enum Position -{ +namespace RangeNavigator { +enum Position { //string Top, //string Bottom, } } -module RangeNavigator -{ -enum FontStyle -{ +namespace RangeNavigator { +enum FontStyle { //string Normal, //string @@ -55692,20 +55576,16 @@ Bold, Italic, } } -module RangeNavigator -{ -enum FontWeight -{ +namespace RangeNavigator { +enum FontWeight { //string Regular, //string Lighter, } } -module RangeNavigator -{ -enum HorizontalAlignment -{ +namespace RangeNavigator { +enum HorizontalAlignment { //string Middle, //string @@ -55714,10 +55594,8 @@ Left, Right, } } -module RangeNavigator -{ -enum RangePadding -{ +namespace RangeNavigator { +enum RangePadding { //string Additional, //string @@ -55728,10 +55606,8 @@ None, Round, } } -module RangeNavigator -{ -enum ValueType -{ +namespace RangeNavigator { +enum ValueType { //string Numeric, //string @@ -55741,11 +55617,10 @@ DateTime, class BulletGraph extends ej.Widget { static fn: BulletGraph; - constructor(element: JQuery, options?: BulletGraph.Model); - constructor(element: Element, options?: BulletGraph.Model); + constructor(element: JQuery | Element, options?: BulletGraph.Model); static Locale: any; - model:BulletGraph.Model; - defaults:BulletGraph.Model; + model: BulletGraph.Model; + defaults: BulletGraph.Model; /** To destroy the bullet graph * @returns {void} @@ -55767,7 +55642,7 @@ class BulletGraph extends ej.Widget { */ setFeatureMeasureBarValue(): void; } -export module BulletGraph{ +export namespace BulletGraph { export interface Model { @@ -55817,7 +55692,7 @@ export interface Model { /** Contains property to customize the qualitative ranges. */ - qualitativeRanges?: Array; + qualitativeRanges?: QualitativeRange[]; /** Size of the qualitative range depends up on the specified value. * @Default {32} @@ -55853,28 +55728,28 @@ export interface Model { width?: number; /** Fires on rendering the caption of bullet graph. */ - drawCaption? (e: DrawCaptionEventArgs): void; + drawCaption?(e: DrawCaptionEventArgs): void; /** Fires on rendering the category. */ - drawCategory? (e: DrawCategoryEventArgs): void; + drawCategory?(e: DrawCategoryEventArgs): void; /** Fires on rendering the comparative measure symbol. */ - drawComparativeMeasureSymbol? (e: DrawComparativeMeasureSymbolEventArgs): void; + drawComparativeMeasureSymbol?(e: DrawComparativeMeasureSymbolEventArgs): void; /** Fires on rendering the feature measure bar. */ - drawFeatureMeasureBar? (e: DrawFeatureMeasureBarEventArgs): void; + drawFeatureMeasureBar?(e: DrawFeatureMeasureBarEventArgs): void; /** Fires on rendering the indicator of bullet graph. */ - drawIndicator? (e: DrawIndicatorEventArgs): void; + drawIndicator?(e: DrawIndicatorEventArgs): void; /** Fires on rendering the labels. */ - drawLabels? (e: DrawLabelsEventArgs): void; + drawLabels?(e: DrawLabelsEventArgs): void; /** Fires on rendering the qualitative ranges. */ - drawQualitativeRanges? (e: DrawQualitativeRangesEventArgs): void; + drawQualitativeRanges?(e: DrawQualitativeRangesEventArgs): void; /** Fires on loading bullet graph. */ - load? (e: LoadEventArgs): void; + load?(e: LoadEventArgs): void; } export interface DrawCaptionEventArgs { @@ -56011,6 +55886,9 @@ export interface DrawQualitativeRangesEventArgs { } export interface LoadEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; } export interface CaptionSettingsFont { @@ -56175,7 +56053,8 @@ export interface CaptionSettingsIndicator { */ textAlignment?: ej.datavisualization.BulletGraph.TextAlignment|string; - /** Specifies where indicator text should be anchored when indicator overlaps with other caption group text. Text will be anchored when overlapping caption group text are at same position. Anchoring is not applicable for float position. + /** Specifies where indicator text should be anchored when indicator overlaps with other caption group text. Text will be anchored when overlapping caption group text are at same position. + * Anchoring is not applicable for float position. * @Default {'start'} */ textAnchor?: ej.datavisualization.BulletGraph.TextAnchor|string; @@ -56284,7 +56163,8 @@ export interface CaptionSettingsSubTitle { */ textAlignment?: ej.datavisualization.BulletGraph.TextAlignment|string; - /** Specifies where subtitle text should be anchored when sub title text overlaps with other caption group text. Text will be anchored when overlapping caption group text are at same position. Anchoring is not applicable for float position. + /** Specifies where subtitle text should be anchored when sub title text overlaps with other caption group text. Text will be anchored when overlapping + * caption group text are at same position. Anchoring is not applicable for float position. * @Default {'start'} */ textAnchor?: ej.datavisualization.BulletGraph.TextAnchor|string; @@ -56337,7 +56217,8 @@ export interface CaptionSettings { */ textAlignment?: ej.datavisualization.BulletGraph.TextAlignment|string; - /** Specifies caption text anchoring when caption text overlaps with other caption group text. Text will be anchored when overlapping caption group text are at same position. Anchoring is not applicable for float position. + /** Specifies caption text anchoring when caption text overlaps with other caption group text. + * Text will be anchored when overlapping caption group text are at same position. Anchoring is not applicable for float position. * @Default {'start'} */ textAnchor?: ej.datavisualization.BulletGraph.TextAnchor|string; @@ -56574,7 +56455,7 @@ export interface QuantitativeScaleSettings { /** Contains property to customize the featured measure. */ - featureMeasures?: Array; + featureMeasures?: QuantitativeScaleSettingsFeatureMeasure[]; /** Contains property to customize the fields. */ @@ -56650,10 +56531,8 @@ export interface TooltipSettings { visible?: boolean; } } -module BulletGraph -{ -enum FontStyle -{ +namespace BulletGraph { +enum FontStyle { //string Normal, //string @@ -56662,10 +56541,8 @@ Italic, Oblique, } } -module BulletGraph -{ -enum FontWeight -{ +namespace BulletGraph { +enum FontWeight { //string Normal, //string @@ -56676,10 +56553,8 @@ Bolder, Lighter, } } -module BulletGraph -{ -enum TextAlignment -{ +namespace BulletGraph { +enum TextAlignment { //string Near, //string @@ -56688,10 +56563,8 @@ Far, Center, } } -module BulletGraph -{ -enum TextAnchor -{ +namespace BulletGraph { +enum TextAnchor { //string Start, //string @@ -56700,10 +56573,8 @@ Middle, End, } } -module BulletGraph -{ -enum TextPosition -{ +namespace BulletGraph { +enum TextPosition { //string Top, //string @@ -56716,60 +56587,48 @@ Bottom, Float, } } -module BulletGraph -{ -enum FlowDirection -{ +namespace BulletGraph { +enum FlowDirection { //string Forward, //string Backward, } } -module BulletGraph -{ -enum Orientation -{ +namespace BulletGraph { +enum Orientation { //string Horizontal, //string Vertical, } } -module BulletGraph -{ -enum LabelPlacement -{ +namespace BulletGraph { +enum LabelPlacement { //string Inside, //string Outside, } } -module BulletGraph -{ -enum LabelPosition -{ +namespace BulletGraph { +enum LabelPosition { //string Above, //string Below, } } -module BulletGraph -{ -enum TickPlacement -{ +namespace BulletGraph { +enum TickPlacement { //string Inside, //string Outside, } } -module BulletGraph -{ -enum TickPosition -{ +namespace BulletGraph { +enum TickPosition { //string Below, //string @@ -56781,11 +56640,10 @@ Cross, class Barcode extends ej.Widget { static fn: Barcode; - constructor(element: JQuery, options?: Barcode.Model); - constructor(element: Element, options?: Barcode.Model); + constructor(element: JQuery | Element, options?: Barcode.Model); static Locale: any; - model:Barcode.Model; - defaults:Barcode.Model; + model: Barcode.Model; + defaults: Barcode.Model; /** To disable the barcode * @returns {void} @@ -56797,7 +56655,7 @@ class Barcode extends ej.Widget { */ enable(): void; } -export module Barcode{ +export namespace Barcode { export interface Model { @@ -56805,7 +56663,8 @@ export interface Model { */ barcodeToTextGapHeight?: number; - /** Specifies the height of bars in the Barcode. By modifying the barHeight, the entire barcode height can be customized. Please refer to xDimension for two dimensional barcode height customization. + /** Specifies the height of bars in the Barcode. By modifying the barHeight, the entire barcode height can be customized. + * Please refer to xDimension for two dimensional barcode height customization. */ barHeight?: number; @@ -56821,7 +56680,8 @@ export interface Model { */ enabled?: boolean; - /** Specifies the start and stop encode symbol in the Barcode. In one dimensional barcodes, an additional character is added as start and stop delimiters. These symbols are optional and the unique of the symbol allows the reader to determine the direction of the barcode being scanned. + /** Specifies the start and stop encode symbol in the Barcode. In one dimensional barcodes, an additional character is added as start and stop delimiters. + * These symbols are optional and the unique of the symbol allows the reader to determine the direction of the barcode being scanned. */ encodeStartStopSymbol?: number; @@ -56829,11 +56689,13 @@ export interface Model { */ lightBarColor?: any; - /** Specifies the width of the narrow bars in the barcode. The dark bars in the one dimensional barcode contains random narrow and wide bars based on the provided input which can be specified during initialization. + /** Specifies the width of the narrow bars in the barcode. The dark bars in the one dimensional barcode contains random narrow and wide bars based on + * the provided input which can be specified during initialization. */ narrowBarWidth?: number; - /** Specifies the width of the quiet zone. In barcode, a quiet zone is the blank margin on either side of a barcode which informs the reader where a barcode's symbology starts and stops. The purpose of a quiet zone is to prevent the reader from picking up unrelated information. + /** Specifies the width of the quiet zone. In barcode, a quiet zone is the blank margin on either side of a barcode which informs the reader where a barcode's symbology starts and stops. + * The purpose of a quiet zone is to prevent the reader from picking up unrelated information. */ quietZone?: QuietZone; @@ -56858,7 +56720,7 @@ export interface Model { xDimension?: number; /** Fires after Barcode control is loaded. */ - load? (e: LoadEventArgs): void; + load?(e: LoadEventArgs): void; } export interface LoadEventArgs { @@ -56903,10 +56765,8 @@ export interface QuietZone { top?: number; } } -module Barcode -{ -enum SymbologyType -{ +namespace Barcode { +enum SymbologyType { //Represents the QR code QRBarcode, //Represents the Data Matrix barcode @@ -56936,11 +56796,10 @@ Code128C, class Map extends ej.Widget { static fn: Map; - constructor(element: JQuery, options?: Map.Model); - constructor(element: Element, options?: Map.Model); + constructor(element: JQuery | Element, options?: Map.Model); static Locale: any; - model:Map.Model; - defaults:Map.Model; + model: Map.Model; + defaults: Map.Model; /** Method for navigating to specific shape based on latitude, longitude and zoom level. * @param {number} Pass the latitude value for map @@ -56979,7 +56838,7 @@ class Map extends ej.Widget { */ zoom(level: number, isAnimate: boolean): void; } -export module Map{ +export namespace Map { export interface Model { @@ -57028,31 +56887,31 @@ export interface Model { /** Layer for holding the map shapes */ - layers?: Array; + layers?: Layer[]; /** Triggered on selecting the map markers. */ - markerSelected? (e: MarkerSelectedEventArgs): void; + markerSelected?(e: MarkerSelectedEventArgs): void; /** Triggers while leaving the hovered map shape */ - mouseleave? (e: MouseleaveEventArgs): void; + mouseleave?(e: MouseleaveEventArgs): void; /** Triggers while hovering the map shape. */ - mouseover? (e: MouseoverEventArgs): void; + mouseover?(e: MouseoverEventArgs): void; /** Triggers once map render completed. */ - onRenderComplete? (e: OnRenderCompleteEventArgs): void; + onRenderComplete?(e: OnRenderCompleteEventArgs): void; /** Triggers when map panning ends. */ - panned? (e: PannedEventArgs): void; + panned?(e: PannedEventArgs): void; /** Triggered on selecting the map shapes. */ - shapeSelected? (e: ShapeSelectedEventArgs): void; + shapeSelected?(e: ShapeSelectedEventArgs): void; /** Triggered when map is zoomed-in. */ - zoomedIn? (e: ZoomedInEventArgs): void; + zoomedIn?(e: ZoomedInEventArgs): void; /** Triggers when map is zoomed out. */ - zoomedOut? (e: ZoomedOutEventArgs): void; + zoomedOut?(e: ZoomedOutEventArgs): void; } export interface MarkerSelectedEventArgs { @@ -57194,7 +57053,7 @@ export interface LayersBubbleSettingsColorMappingsRangeColorMapping { /** GradientColors in the bubble layer of map. */ - gradientColors?: Array; + gradientColors?: any[]; /** Color of the bubble layer. * @Default {null} @@ -57207,7 +57066,7 @@ export interface LayersBubbleSettingsColorMappings { /** Specifies the range colorMappings in the bubble layer. * @Default {null} */ - rangeColorMapping?: Array; + rangeColorMapping?: LayersBubbleSettingsColorMappingsRangeColorMapping[]; } export interface LayersBubbleSettings { @@ -57268,7 +57127,7 @@ export interface LayersLabelSettings { /** enable or disable the enableSmartLabel property * @Default {false} */ - enableSmartLabel?: Boolean; + enableSmartLabel?: boolean; /** set the labelLength property * @Default {'2'} @@ -57399,7 +57258,7 @@ export interface LayersShapeSettingsColorMappingsRangeColorMapping { /** Specifies the gradientColors in the shape layer of map. * @Default {null} */ - gradientColors?: Array; + gradientColors?: any[]; } export interface LayersShapeSettingsColorMappingsEqualColorMapping { @@ -57420,12 +57279,12 @@ export interface LayersShapeSettingsColorMappings { /** Specifies the range colorMappings in the shape layer of map. * @Default {null} */ - rangeColorMapping?: Array; + rangeColorMapping?: LayersShapeSettingsColorMappingsRangeColorMapping[]; /** Specifies the equalColorMapping in the shape layer of map. * @Default {null} */ - equalColorMapping?: Array; + equalColorMapping?: LayersShapeSettingsColorMappingsEqualColorMapping[]; } export interface LayersShapeSettings { @@ -57569,7 +57428,7 @@ export interface Layer { /** Specify markers for shape layer. * @Default {[]} */ - markers?: Array; + markers?: any[]; /** Specifies the map marker template for map layer. * @Default {null} @@ -57579,7 +57438,7 @@ export interface Layer { /** Specify selectedMapShapes for shape layer * @Default {[]} */ - selectedMapShapes?: Array; + selectedMapShapes?: any[]; /** Specifies the selection mode of the map. Accepted selection mode values are Default and Multiple. * @Default {default} @@ -57614,10 +57473,8 @@ export interface Layer { urlTemplate?: string; } } -module Map -{ -enum Position -{ +namespace Map { +enum Position { //specifies the none position None, //specifies the topleft position @@ -57640,20 +57497,16 @@ Bottomcenter, Bottomright, } } -module Map -{ -enum LabelOrientation -{ +namespace Map { +enum LabelOrientation { //specifies the horizontal position Horizontal, //specifies the vertical position Vertical, } } -module Map -{ -enum BingMapType -{ +namespace Map { +enum BingMapType { //specifies the aerial type Aerial, //specifies the aerialwithlabel type @@ -57662,30 +57515,24 @@ Aerialwithlabel, Road, } } -module Map -{ -enum LabelSize -{ +namespace Map { +enum LabelSize { //specifies the fixed size Fixed, //specifies the default size Default, } } -module Map -{ -enum GeometryType -{ +namespace Map { +enum GeometryType { //specifies the geographic view of map Geographic, //specifies the normal land view of map Normal, } } -module Map -{ -enum LayerType -{ +namespace Map { +enum LayerType { //specifies the geometry type Geometry, //specifies the osm type @@ -57694,10 +57541,8 @@ Osm, Bing, } } -module Map -{ -enum DockPosition -{ +namespace Map { +enum DockPosition { //specifies the top position Top, //specifies the bottom position @@ -57708,50 +57553,40 @@ Right, Left, } } -module Map -{ -enum LegendIcons -{ +namespace Map { +enum LegendIcons { //specifies the rectangle position Rectangle, //specifies the circle position Circle, } } -module Map -{ -enum Mode -{ +namespace Map { +enum Mode { //specifies the default mode Default, //specifies the interactive mode Interactive, } } -module Map -{ -enum LegendType -{ +namespace Map { +enum LegendType { //specifies the layers type Layers, //specifies the bubbles type Bubbles, } } -module Map -{ -enum SelectionMode -{ +namespace Map { +enum SelectionMode { //specifies the default position Default, //specifies the multiple position Multiple, } } -module Map -{ -enum ColorPalette -{ +namespace Map { +enum ColorPalette { //specifies the palette1 color Palette1, //specifies the palette2 color @@ -57765,18 +57600,17 @@ Custompalette, class TreeMap extends ej.Widget { static fn: TreeMap; - constructor(element: JQuery, options?: TreeMap.Model); - constructor(element: Element, options?: TreeMap.Model); + constructor(element: JQuery | Element, options?: TreeMap.Model); static Locale: any; - model:TreeMap.Model; - defaults:TreeMap.Model; + model: TreeMap.Model; + defaults: TreeMap.Model; /** Method to reload treemap with updated values. * @returns {void} */ refresh(): void; } -export module TreeMap{ +export namespace TreeMap { export interface Model { @@ -57865,7 +57699,7 @@ export interface Model { /** Specifies the group color mapping of the treemap * @Default {[]} */ - groupColorMapping?: Array; + groupColorMapping?: GroupColorMapping[]; /** Specifies the legend settings of the treemap */ @@ -57913,7 +57747,7 @@ export interface Model { /** Specifies the rangeColorMapping settings of the treemap * @Default {[]} */ - rangeColorMapping?: Array; + rangeColorMapping?: RangeColorMapping[]; /** Specifies the selection mode of treemap item. Accepted selection mode values are Default and Multiple. * @Default {default} @@ -57947,12 +57781,12 @@ export interface Model { /** Hold the treeMapItems to be displayed in treemap * @Default {[]} */ - treeMapItems?: Array; + treeMapItems?: any[]; /** Specify levels of treemap for grouped visualization of data * @Default {[]} */ - levels?: Array; + levels?: Level[]; /** Specifies the weight value path of the treemap * @Default {null} @@ -57960,7 +57794,7 @@ export interface Model { weightValuePath?: string; /** Triggers on treemap item selected. */ - treeMapItemSelected? (e: TreeMapItemSelectedEventArgs): void; + treeMapItemSelected?(e: TreeMapItemSelectedEventArgs): void; } export interface TreeMapItemSelectedEventArgs { @@ -58011,7 +57845,7 @@ export interface PaletteColorMapping { /** Specifies the colors of the paletteColorMapping * @Default {[]} */ - colors?: Array; + colors?: any[]; } export interface GroupColorMapping { @@ -58130,7 +57964,7 @@ export interface RangeColorMapping { /** specifies the gradient colors for th given range value * @Default {[]} */ - gradientColors?: Array; + gradientColors?: any[]; /** Specifies the from value for rangeColorMapping. * @Default {-1} @@ -58220,10 +58054,8 @@ export interface Level { showLabels?: boolean; } } -module TreeMap -{ -enum DockPosition -{ +namespace TreeMap { +enum DockPosition { //specifies the top position Top, //specifies the bottom position @@ -58234,10 +58066,8 @@ Right, Left, } } -module TreeMap -{ -enum ItemsLayoutMode -{ +namespace TreeMap { +enum ItemsLayoutMode { //specifies the squarified as layout type position Squarified, //specifies the sliceanddicehorizontal as layout type position @@ -58248,10 +58078,8 @@ Sliceanddicevertical, Sliceanddiceauto, } } -module TreeMap -{ -enum Position -{ +namespace TreeMap { +enum Position { //specifies the none position None, //specifies the topleft position @@ -58274,30 +58102,24 @@ Bottomcenter, Bottomright, } } -module TreeMap -{ -enum VisibilityMode -{ +namespace TreeMap { +enum VisibilityMode { //specifies the visible mode Top, //specifies the hide on exceeded length mode Hideonexceededlength, } } -module TreeMap -{ -enum selectionMode -{ +namespace TreeMap { +enum selectionMode { //specifies the default mode Default, //specifies the multiple mode Multiple, } } -module TreeMap -{ -enum groupSelectionMode -{ +namespace TreeMap { +enum groupSelectionMode { //specifies the default mode Default, //specifies the multiple mode @@ -58307,11 +58129,10 @@ Multiple, class Diagram extends ej.Widget { static fn: Diagram; - constructor(element: JQuery, options?: Diagram.Model); - constructor(element: Element, options?: Diagram.Model); + constructor(element: JQuery | Element, options?: Diagram.Model); static Locale: any; - model:Diagram.Model; - defaults:Diagram.Model; + model: Diagram.Model; + defaults: Diagram.Model; /** Add nodes and connectors to diagram at runtime * @param {any} a JSON to define a node/connector or an array of nodes and connector @@ -58345,7 +58166,7 @@ class Diagram extends ej.Widget { * @param {Array} a collection of ports to be added to the specified node * @returns {void} */ - addPorts(name: string, ports: Array): void; + addPorts(name: string, ports: any[]): void; /** Add the specified node to selection list * @param {any} the node to be selected @@ -58626,12 +58447,12 @@ class Diagram extends ej.Widget { upgrade(data: any): void; /** Used to zoomIn/zoomOut diagram - * @param {Diagram.Zoom} options to zoom the diagram(zoom factor, zoomIn/zoomOut) + * @param {Diagram.Zoom} options to zoom the diagram(zoom factor, zoomIn/zoomOut) * @returns {void} */ zoomTo(Zoom?: Diagram.Zoom): void; } -export module Diagram{ +export namespace Diagram { export interface Options { @@ -58674,7 +58495,7 @@ export interface Zoom { */ zoomCommand?: ej.datavisualization.Diagram.ZoomCommand; - /** Used to zoom-in or zoom-out the diagram based on the point. + /** Used to zoom-in or zoom-out the diagram based on the point. */ focusPoint?: ej.datavisualization.Diagram.ConnectorsSourcePoint; } @@ -58702,7 +58523,7 @@ export interface Model { /** A collection of JSON objects where each object represents a connector * @Default {[]} */ - connectors?: Array; + connectors?: Connector[]; /** Binds the custom JSON data with connector properties * @Default {null} @@ -58768,7 +58589,7 @@ export interface Model { /** Array of JSON objects where each object represents a node * @Default {[]} */ - nodes?: Array; + nodes?: Node[]; /** Binds the custom JSON data with node properties * @Default {null} @@ -58817,94 +58638,94 @@ export interface Model { zoomFactor?: number; /** Triggers When auto scroll is changed */ - autoScrollChange? (e: AutoScrollChangeEventArgs): void; + autoScrollChange?(e: AutoScrollChangeEventArgs): void; /** Triggers when a node, connector or diagram is clicked */ - click? (e: ClickEventArgs): void; + click?(e: ClickEventArgs): void; /** Triggers when the connection is changed */ - connectionChange? (e: ConnectionChangeEventArgs): void; + connectionChange?(e: ConnectionChangeEventArgs): void; /** Triggers when the connector collection is changed */ - connectorCollectionChange? (e: ConnectorCollectionChangeEventArgs): void; + connectorCollectionChange?(e: ConnectorCollectionChangeEventArgs): void; /** Triggers when the connectors' source point is changed */ - connectorSourceChange? (e: ConnectorSourceChangeEventArgs): void; + connectorSourceChange?(e: ConnectorSourceChangeEventArgs): void; /** Triggers when the connectors' target point is changed */ - connectorTargetChange? (e: ConnectorTargetChangeEventArgs): void; + connectorTargetChange?(e: ConnectorTargetChangeEventArgs): void; /** Triggers before opening the context menu */ - contextMenuBeforeOpen? (e: ContextMenuBeforeOpenEventArgs): void; + contextMenuBeforeOpen?(e: ContextMenuBeforeOpenEventArgs): void; /** Triggers when a context menu item is clicked */ - contextMenuClick? (e: ContextMenuClickEventArgs): void; + contextMenuClick?(e: ContextMenuClickEventArgs): void; /** Triggers when a node, connector or diagram model is clicked twice */ - doubleClick? (e: DoubleClickEventArgs): void; + doubleClick?(e: DoubleClickEventArgs): void; /** Triggers while dragging the elements in diagram */ - drag? (e: DragEventArgs): void; + drag?(e: DragEventArgs): void; /** Triggers when a symbol is dragged into diagram from symbol palette */ - dragEnter? (e: DragEnterEventArgs): void; + dragEnter?(e: DragEnterEventArgs): void; /** Triggers when a symbol is dragged outside of the diagram. */ - dragLeave? (e: DragLeaveEventArgs): void; + dragLeave?(e: DragLeaveEventArgs): void; /** Triggers when a symbol is dragged over diagram */ - dragOver? (e: DragOverEventArgs): void; + dragOver?(e: DragOverEventArgs): void; /** Triggers when a symbol is dragged and dropped from symbol palette to drawing area */ - drop? (e: DropEventArgs): void; + drop?(e: DropEventArgs): void; /** Triggers when editor got focus at the time of node's label or text node editing. */ - editorFocusChange? (e: EditorFocusChangeEventArgs): void; + editorFocusChange?(e: EditorFocusChangeEventArgs): void; /** Triggers when a child is added to or removed from a group */ - groupChange? (e: GroupChangeEventArgs): void; + groupChange?(e: GroupChangeEventArgs): void; /** Triggers when a change is reverted or restored(undo/redo) */ - historyChange? (e: HistoryChangeEventArgs): void; + historyChange?(e: HistoryChangeEventArgs): void; /** Triggers when a diagram element is clicked */ - itemClick? (e: ItemClickEventArgs): void; + itemClick?(e: ItemClickEventArgs): void; /** Triggers when mouse enters a node/connector */ - mouseEnter? (e: MouseEnterEventArgs): void; + mouseEnter?(e: MouseEnterEventArgs): void; /** Triggers when mouse leaves node/connector */ - mouseLeave? (e: MouseLeaveEventArgs): void; + mouseLeave?(e: MouseLeaveEventArgs): void; /** Triggers when mouse hovers over a node/connector */ - mouseOver? (e: MouseOverEventArgs): void; + mouseOver?(e: MouseOverEventArgs): void; /** Triggers when node collection is changed */ - nodeCollectionChange? (e: NodeCollectionChangeEventArgs): void; + nodeCollectionChange?(e: NodeCollectionChangeEventArgs): void; /** Triggers when the node properties(x, y,width and height alone) are changed using nudge commands or updateNode API. */ - propertyChange? (e: PropertyChangeEventArgs): void; + propertyChange?(e: PropertyChangeEventArgs): void; /** Triggers when the diagram elements are rotated */ - rotationChange? (e: RotationChangeEventArgs): void; + rotationChange?(e: RotationChangeEventArgs): void; /** Triggers when the diagram is zoomed or panned */ - scrollChange? (e: ScrollChangeEventArgs): void; + scrollChange?(e: ScrollChangeEventArgs): void; /** Triggers when a connector segment is edited */ - segmentChange? (e: SegmentChangeEventArgs): void; + segmentChange?(e: SegmentChangeEventArgs): void; /** Triggers when the selection is changed in diagram */ - selectionChange? (e: SelectionChangeEventArgs): void; + selectionChange?(e: SelectionChangeEventArgs): void; /** Triggers when a node is resized */ - sizeChange? (e: SizeChangeEventArgs): void; + sizeChange?(e: SizeChangeEventArgs): void; /** Triggers when label editing is ended */ - textChange? (e: TextChangeEventArgs): void; + textChange?(e: TextChangeEventArgs): void; /** Triggered when the diagram is rendered completely. */ - create? (e: CreateEventArgs): void; + create?(e: CreateEventArgs): void; } export interface AutoScrollChangeEventArgs { @@ -59234,6 +59055,9 @@ export interface DropEventArgs { } export interface EditorFocusChangeEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; } export interface GroupChangeEventArgs { @@ -59263,11 +59087,11 @@ export interface HistoryChangeEventArgs { /** An array of objects, where each object represents the changes made in last undo/redo. To explore how the changes are defined, refer [Undo Redo Changes](#undo-redo-changes) */ - changes?: Array; + changes?: any[]; /** A collection of objects that are changed in the last undo/redo */ - Source?: Array; + Source?: any[]; /** parameter returns the id of the diagram */ @@ -59477,15 +59301,15 @@ export interface SelectionChangeEventArgs { /** parameter returns the collection of nodes and connectors that have to be removed from selection list */ - oldItems?: Array; + oldItems?: any[]; /** parameter returns the collection of nodes and connectors that have to be added to selection list */ - newItems?: Array; + newItems?: any[]; /** parameter returns the collection of nodes and connectors that will be selected after selection change */ - selectedItems?: Array; + selectedItems?: any[]; /** parameter to specify whether or not to cancel the selection change event */ @@ -59590,11 +59414,11 @@ export interface CommandManagerCommands { /** A method that defines whether the command is executable at the moment or not. */ - canExecute?: Function; + canExecute?: any; /** A method that defines what to be executed when the key combination is recognized. */ - execute?: Function; + execute?: any; /** Defines a combination of keys and key modifiers, on recognition of which the command will be executed */ @@ -60014,7 +59838,7 @@ export interface Connector { /** A collection of JSON objects where each object represents a label. * @Default {[]} */ - labels?: Array; + labels?: ConnectorsLabel[]; /** Sets the stroke color of the connector * @Default {black} @@ -60076,7 +59900,7 @@ export interface Connector { /** An array of JSON objects where each object represents a segment * @Default {[ { type:straight } ]} */ - segments?: Array; + segments?: ConnectorsSegment[]; /** Defines the role/meaning of the connector * @Default {null} @@ -60175,7 +59999,7 @@ export interface ContextMenuItem { /** Defines the collection of sub items for the context menu items * @Default {[]} */ - subItems?: Array; + subItems?: any[]; } export interface ContextMenu { @@ -60183,7 +60007,7 @@ export interface ContextMenu { /** Defines the collection of context menu items * @Default {[]} */ - items?: Array; + items?: ContextMenuItem[]; /** To set whether to display the default context menu items or not * @Default {false} @@ -60244,29 +60068,29 @@ export interface HistoryManager { /** A method that takes a history entry as argument and returns whether the specific entry can be popped or not */ - canPop?: Function; + canPop?: any; /** A method that ends grouping the changes */ - closeGroupAction?: Function; + closeGroupAction?: any; /** A method that removes the history of a recent change made in diagram */ - pop?: Function; + pop?: any; /** A method that allows to track the custom changes made in diagram */ - push?: Function; + push?: any; /** Defines what should be happened while trying to restore a custom change * @Default {null} */ - redo?: Function; + redo?: any; /** The redoStack property is used to get the number of redo actions to be stored on the history manager. Its an read-only property and the collection should not be modified. * @Default {[]} */ - redoStack?: Array; + redoStack?: any[]; /** The stackLimit property used to restrict the undo and redo actions to a certain limit. * @Default {null} @@ -60275,16 +60099,16 @@ export interface HistoryManager { /** A method that starts to group the changes to revert/restore them in a single undo or redo */ - startGroupAction?: Function; + startGroupAction?: any; /** Defines what should be happened while trying to revert a custom change */ - undo?: Function; + undo?: any; /** The undoStack property is used to get the number of undo actions to be stored on the history manager. Its an read-only property and the collection should not be modified. * @Default {[]} */ - undoStack?: Array; + undoStack?: any[]; } export interface Layout { @@ -60404,12 +60228,12 @@ export interface NodesClass { /** Defines the collection of attributes * @Default {[]} */ - attributes?: Array; + attributes?: NodesClassAttribute[]; /** Defines the collection of methods of a Class. * @Default {[]} */ - methods?: Array; + methods?: NodesClassMethod[]; } export interface NodesCollapseIcon { @@ -60502,7 +60326,7 @@ export interface NodesEnumeration { /** Defines the collection of enumeration members * @Default {[]} */ - members?: Array; + members?: NodesEnumerationMember[]; } export interface NodesExpandIcon { @@ -60558,7 +60382,7 @@ export interface NodesGradientLinearGradient { /** Defines the different colors and the region of color transitions * @Default {[]} */ - stops?: Array; + stops?: any[]; /** Defines the left most position(relative to node) of the rectangular region that needs to be painted * @Default {0} @@ -60606,7 +60430,7 @@ export interface NodesGradientRadialGradient { /** Defines the different colors and the region of color transitions. * @Default {[]} */ - stops?: Array; + stops?: any[]; } export interface NodesGradientStop { @@ -60672,12 +60496,12 @@ export interface NodesInterface { /** Defines a collection of attributes of the interface * @Default {[]} */ - attributes?: Array; + attributes?: NodesInterfaceAttribute[]; /** Defines the collection of public methods of an interface * @Default {[]} */ - methods?: Array; + methods?: NodesInterfaceMethod[]; } export interface NodesLabel { @@ -60831,7 +60655,7 @@ export interface NodesLane { /** An array of objects where each object represents a child node of the lane * @Default {[]} */ - children?: Array; + children?: any[]; /** Defines the fill color of the lane * @Default {white} @@ -61036,7 +60860,7 @@ export interface NodesSubProcess { /** Defines the collection of events that need to be appended with BPMN Sub-Process */ - events?: Array; + events?: any[]; /** Defines the loop type of a sub process. * @Default {ej.datavisualization.Diagram.BPMNLoops.None} @@ -61046,7 +60870,7 @@ export interface NodesSubProcess { /** Defines the children for BPMN's SubProcess * @Default {[]} */ - Processes?: Array; + Processes?: any[]; /** Defines the type of the event trigger * @Default {ej.datavisualization.Diagram.BPMNTriggers.Message} @@ -61121,7 +60945,7 @@ export interface Node { /** Array of JSON objects where each object represents a child node/connector * @Default {[]} */ - children?: Array; + children?: any[]; /** Sets the type of UML classifier. Applicable, if the node is a UML Class Diagram shape. * @Default {ej.datavisualization.Diagram.ClassifierShapes.Class} @@ -61221,7 +61045,7 @@ export interface Node { /** A read only collection of the incoming connectors/edges of the node * @Default {[]} */ - inEdges?: Array; + inEdges?: any[]; /** Defines an interface in a UML Class Diagram * @Default {null} @@ -61241,12 +61065,12 @@ export interface Node { /** A collection of objects where each object represents a label * @Default {[]} */ - labels?: Array; + labels?: NodesLabel[]; /** An array of objects where each object represents a lane. Applicable, if the node is a swimlane. * @Default {[]} */ - lanes?: Array; + lanes?: NodesLane[]; /** Defines the minimum space to be left between the bottom of parent bounds and the node. Applicable, if the parent is a container. * @Default {0} @@ -61315,7 +61139,7 @@ export interface Node { /** A read only collection of outgoing connectors/edges of the node * @Default {[]} */ - outEdges?: Array; + outEdges?: any[]; /** Defines the minimum padding value to be left between the bottom most position of a group and its children. Applicable, if the group is a container. * @Default {0} @@ -61353,7 +61177,7 @@ export interface Node { /** An array of objects, where each object represents a smaller region(phase) of a swimlane. * @Default {[]} */ - phases?: Array; + phases?: NodesPhase[]; /** Sets the height of the phase headers * @Default {0} @@ -61368,12 +61192,12 @@ export interface Node { /** Defines a collection of points to draw a polygon. Applicable, if the shape is a polygon. * @Default {[]} */ - points?: Array; + points?: any[]; /** An array of objects where each object represents a port * @Default {[]} */ - ports?: Array; + ports?: NodesPort[]; /** Sets the angle to which the node should be rotated * @Default {0} @@ -61601,7 +61425,7 @@ export interface SelectedItems { /** A read only collection of the selected items * @Default {[]} */ - children?: Array; + children?: any[]; /** Controls the visibility of selector. * @Default {ej.datavisualization.Diagram.SelectorConstraints.All} @@ -61641,7 +61465,7 @@ export interface SelectedItems { /** A collection of frequently used commands that will be added around the selector * @Default {[]} */ - userHandles?: Array; + userHandles?: SelectedItemsUserHandle[]; /** Sets the width of the selected items * @Default {0} @@ -61663,12 +61487,12 @@ export interface SnapSettingsHorizontalGridLines { /** A pattern of lines and gaps that defines a set of horizontal gridlines * @Default {[1.25, 18.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75]} */ - linesInterval?: Array; + linesInterval?: any[]; /** Specifies a set of intervals to snap the objects * @Default {[20]} */ - snapInterval?: Array; + snapInterval?: any[]; } export interface SnapSettingsVerticalGridLines { @@ -61685,12 +61509,12 @@ export interface SnapSettingsVerticalGridLines { /** A pattern of lines and gaps that defines a set of horizontal gridlines * @Default {[1.25, 18.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75]} */ - linesInterval?: Array; + linesInterval?: any[]; /** Specifies a set of intervals to snap the objects * @Default {[20]} */ - snapInterval?: Array; + snapInterval?: any[]; } export interface SnapSettings { @@ -61757,13 +61581,11 @@ export interface Tooltip { templateId?: string; } } -module Diagram -{ -enum ImageAlignment -{ +namespace Diagram { +enum ImageAlignment { //Scales the graphic content non-uniformly to the width and height of the diagram area None, -//Used to align the image at the top left of diagram area +//Used to align the image at the top left of diagram area XMinYMin, //Used to align the image at the left center of diagram area XMinYMid, @@ -61783,10 +61605,8 @@ XMaxYMid, XMaxYMax, } } -module Diagram -{ -enum BridgeDirection -{ +namespace Diagram { +enum BridgeDirection { //Used to set the direction of line bridges as left Left, //Used to set the direction of line bridges as right @@ -61797,10 +61617,8 @@ Top, Bottom, } } -module Diagram -{ -enum Keys -{ +namespace Diagram { +enum Keys { //No key pressed. None, //The A key. @@ -61893,10 +61711,8 @@ Tab, Enter, } } -module Diagram -{ -enum KeyModifiers -{ +namespace Diagram { +enum KeyModifiers { //No modifiers are pressed. None, //The ALT key. @@ -61907,10 +61723,8 @@ Control, Shift, } } -module Diagram -{ -enum ConnectorConstraints -{ +namespace Diagram { +enum ConnectorConstraints { //Disable all connector Constraints None, //Enables connector to be selected @@ -61939,10 +61753,8 @@ CrispEdges, Default, } } -module Diagram -{ -enum HorizontalAlignment -{ +namespace Diagram { +enum HorizontalAlignment { //Used to align text horizontally on left side of node/connector Left, //Used to align text horizontally on center of node/connector @@ -61951,10 +61763,8 @@ Center, Right, } } -module Diagram -{ -enum Alignment -{ +namespace Diagram { +enum Alignment { //Used to align the label either top or left(before) of the connector segment Before, //Used to align the label at center of the connector segment @@ -61963,20 +61773,16 @@ Center, After, } } -module Diagram -{ -enum LabelRelativeMode -{ +namespace Diagram { +enum LabelRelativeMode { //Sets the relativeMode as SegmentPath SegmentPath, //Sets the relativeMode as SegmentBounds SegmentBounds, } } -module Diagram -{ -enum Segments -{ +namespace Diagram { +enum Segments { //Used to specify the lines as Straight Straight, //Used to specify the lines as Orthogonal @@ -61985,10 +61791,8 @@ Orthogonal, Bezier, } } -module Diagram -{ -enum ConnectorShapes -{ +namespace Diagram { +enum ConnectorShapes { //Used to specify connector type as BPMN BPMN, //Used to specify connector type as UMLClassifier @@ -61997,22 +61801,18 @@ UMLClassifier, UMLActivity, } } -module Diagram -{ -enum BPMNFlows -{ +namespace Diagram { +enum BPMNFlows { //Used to specify the Sequence flow in a BPMN Process Sequence, -//Used to specify the Association flow in a BPMN Process +//Used to specify the Association flow in a BPMN Process Association, //Used to specify the Message flow in a BPMN Process Message, } } -module Diagram -{ -enum AssociationFlows -{ +namespace Diagram { +enum AssociationFlows { //Used to notate default association in a BPMN Process Default, //Used to notate directional association in a BPMN Process @@ -62021,10 +61821,8 @@ Directional, BiDirectional, } } -module Diagram -{ -enum BPMNMessageFlows -{ +namespace Diagram { +enum BPMNMessageFlows { //Used to notate the default message flow in a BPMN Process Default, //Used to notate the instantiating message flow in a BPMN Process @@ -62033,10 +61831,8 @@ InitiatingMessage, NonInitiatingMessage, } } -module Diagram -{ -enum BPMNSequenceFlows -{ +namespace Diagram { +enum BPMNSequenceFlows { //Used to notate the normal sequence flow in a BPMN Process Normal, //Used to notate the conditional sequence flow in a BPMN Process @@ -62045,10 +61841,8 @@ Conditional, Default, } } -module Diagram -{ -enum ClassifierShapes -{ +namespace Diagram { +enum ClassifierShapes { //Used to define a Class Class, //Used to define an Interface @@ -62067,10 +61861,8 @@ Dependency, Inheritance, } } -module Diagram -{ -enum Multiplicity -{ +namespace Diagram { +enum Multiplicity { //Each entity instance is related to a single instance of another entity OneToOne, //An entity instance can be related to multiple instances of the other entities @@ -62081,10 +61873,8 @@ ManyToOne, ManyToMany, } } -module Diagram -{ -enum UMLActivityFlow -{ +namespace Diagram { +enum UMLActivityFlow { //Defines a activity flow as Object in UML Activity Diagram Object, //Defines a activity flow as Control in UML Activity Diagram @@ -62093,10 +61883,8 @@ Control, Exception, } } -module Diagram -{ -enum DecoratorShapes -{ +namespace Diagram { +enum DecoratorShapes { //Used to set decorator shape as none None, //Used to set decorator shape as Arrow @@ -62111,10 +61899,8 @@ Diamond, Path, } } -module Diagram -{ -enum VerticalAlignment -{ +namespace Diagram { +enum VerticalAlignment { //Used to align text Vertically on left side of node/connector Top, //Used to align text Vertically on center of node/connector @@ -62123,10 +61909,8 @@ Center, Bottom, } } -module Diagram -{ -enum DiagramConstraints -{ +namespace Diagram { +enum DiagramConstraints { //Disables all DiagramConstraints None, //Enables/Disables PageEditing @@ -62149,20 +61933,16 @@ CrispEdges, Default, } } -module Diagram -{ -enum LabelRenderingMode -{ +namespace Diagram { +enum LabelRenderingMode { //Sets the labelRenderingMode as Html Html, //Sets the labelRenderingMode as Svg Svg, } } -module Diagram -{ -enum LayoutOrientations -{ +namespace Diagram { +enum LayoutOrientations { //Used to set LayoutOrientation from top to bottom TopToBottom, //Used to set LayoutOrientation from bottom to top @@ -62173,10 +61953,8 @@ LeftToRight, RightToLeft, } } -module Diagram -{ -enum LayoutTypes -{ +namespace Diagram { +enum LayoutTypes { //Used not to set any specific layout None, //Used to set layout type as hierarchical layout @@ -62185,10 +61963,8 @@ HierarchicalTree, OrganizationalChart, } } -module Diagram -{ -enum BPMNActivity -{ +namespace Diagram { +enum BPMNActivity { //Used to set BPMN Activity as None None, //Used to set BPMN Activity as Task @@ -62197,10 +61973,8 @@ Task, SubProcess, } } -module Diagram -{ -enum BPMNAnnotationDirection -{ +namespace Diagram { +enum BPMNAnnotationDirection { //Used to set the direction of BPMN Annotation as left Left, //Used to set the direction of BPMN Annotation as right @@ -62211,10 +61985,8 @@ Top, Bottom, } } -module Diagram -{ -enum IconShapes -{ +namespace Diagram { +enum IconShapes { //Used to set collapse icon shape as none None, //Used to set collapse icon shape as Arrow(Up/Down) @@ -62231,10 +62003,8 @@ Template, Image, } } -module Diagram -{ -enum NodeConstraints -{ +namespace Diagram { +enum NodeConstraints { //Disable all node Constraints None, //Enables node to be selected @@ -62281,20 +62051,16 @@ CrispEdges, Default, } } -module Diagram -{ -enum ContainerType -{ +namespace Diagram { +enum ContainerType { //Sets the container type as Canvas Canvas, //Sets the container type as Stack Stack, } } -module Diagram -{ -enum BPMNDataObjects -{ +namespace Diagram { +enum BPMNDataObjects { //Used to notate the Input type BPMN data object Input, //Used to notate the Output type BPMN data object @@ -62303,10 +62069,8 @@ Output, None, } } -module Diagram -{ -enum BPMNEvents -{ +namespace Diagram { +enum BPMNEvents { //Used to set BPMN Event as Start Start, //Used to set BPMN Event as Intermediate @@ -62321,10 +62085,8 @@ NonInterruptingIntermediate, ThrowingIntermediate, } } -module Diagram -{ -enum BPMNGateways -{ +namespace Diagram { +enum BPMNGateways { //Used to set BPMN Gateway as None None, //Used to set BPMN Gateway as Exclusive @@ -62343,30 +62105,24 @@ ExclusiveEventBased, ParallelEventBased, } } -module Diagram -{ -enum LabelEditMode -{ +namespace Diagram { +enum LabelEditMode { //Used to set label edit mode as edit Edit, //Used to set label edit mode as view View, } } -module Diagram -{ -enum OverflowType -{ +namespace Diagram { +enum OverflowType { //Set overflow Type as ellipsis Ellipsis, //Set overflow Type as Clip Clip, } } -module Diagram -{ -enum TextAlign -{ +namespace Diagram { +enum TextAlign { //Used to align text on left side of node/connector Left, //Used to align text on center of node/connector @@ -62375,10 +62131,8 @@ Center, Right, } } -module Diagram -{ -enum TextDecorations -{ +namespace Diagram { +enum TextDecorations { //Used to set text decoration of the label as Underline Underline, //Used to set text decoration of the label as Overline @@ -62389,10 +62143,8 @@ LineThrough, None, } } -module Diagram -{ -enum TextWrapping -{ +namespace Diagram { +enum TextWrapping { //Disables wrapping NoWrap, //Enables Line-break at normal word break points @@ -62401,10 +62153,8 @@ Wrap, WrapWithOverflow, } } -module Diagram -{ -enum PortConstraints -{ +namespace Diagram { +enum PortConstraints { //Disable all constraints None, //Enables connections with connector @@ -62413,10 +62163,8 @@ Connect, ConnectOnDrag, } } -module Diagram -{ -enum PortShapes -{ +namespace Diagram { +enum PortShapes { //Used to set port shape as X X, //Used to set port shape as Circle @@ -62427,10 +62175,8 @@ Square, Path, } } -module Diagram -{ -enum PortVisibility -{ +namespace Diagram { +enum PortVisibility { //Set the port visibility as Visible Visible, //Set the port visibility as Hidden @@ -62443,10 +62189,8 @@ Connect, Default, } } -module Diagram -{ -enum BasicShapes -{ +namespace Diagram { +enum BasicShapes { //Used to specify node Shape as Rectangle Rectangle, //Used to specify node Shape as Ellipse @@ -62477,10 +62221,8 @@ RightTriangle, Cylinder, } } -module Diagram -{ -enum FlowShapes -{ +namespace Diagram { +enum FlowShapes { //Used to specify node Shape as Process Process, //Used to specify node Shape as Decision @@ -62495,7 +62237,7 @@ Terminator, PaperTap, //Used to specify node Shape as DirectData DirectData, -//Used to specify node Shape as SequentialData +//Used to specify node Shape as SequentialData SequentialData, //Used to specify node Shape as Sort Sort, @@ -62525,14 +62267,12 @@ Annotation1, Annotation2, //Used to specify node Shape as Data Data, -//Used to specify node Shape as Card +//Used to specify node Shape as Card Card, } } -module Diagram -{ -enum BPMNShapes -{ +namespace Diagram { +enum BPMNShapes { //Used to specify node Shape as Event Event, //Used to specify node Shape as Gateway @@ -62549,10 +62289,8 @@ Activity, Group, } } -module Diagram -{ -enum UMLActivityShapes -{ +namespace Diagram { +enum UMLActivityShapes { //Used to set UML ActivityShapes as Action Action, //Used to set UML ActivityShapes as Decision @@ -62581,10 +62319,8 @@ StructuredNode, Note, } } -module Diagram -{ -enum BPMNBoundary -{ +namespace Diagram { +enum BPMNBoundary { //Used to set BPMN SubProcess's Boundary as Default Default, //Used to set BPMN SubProcess's Boundary as Call @@ -62593,10 +62329,8 @@ Call, Event, } } -module Diagram -{ -enum BPMNLoops -{ +namespace Diagram { +enum BPMNLoops { //Used to set BPMN Activity's Loop as None None, //Used to set BPMN Activity's Loop as Standard @@ -62607,10 +62341,8 @@ ParallelMultiInstance, SequenceMultiInstance, } } -module Diagram -{ -enum BPMNSubProcessTypes -{ +namespace Diagram { +enum BPMNSubProcessTypes { //Used to set BPMN SubProcess type as None None, //Used to set BPMN SubProcess type as Transaction @@ -62619,10 +62351,8 @@ Transaction, Event, } } -module Diagram -{ -enum BPMNTasks -{ +namespace Diagram { +enum BPMNTasks { //Used to set BPMN Task Type as None None, //Used to set BPMN Task Type as Service @@ -62645,10 +62375,8 @@ Script, Parallel, } } -module Diagram -{ -enum BPMNTriggers -{ +namespace Diagram { +enum BPMNTriggers { //Used to set Event Trigger as None None, //Used to set Event Trigger as Message @@ -62677,10 +62405,8 @@ Termination, Cancel, } } -module Diagram -{ -enum Shapes -{ +namespace Diagram { +enum Shapes { //Used to specify node type as Text Text, //Used to specify node type as Image @@ -62701,20 +62427,16 @@ UMLClassifier, UMLActivity, } } -module Diagram -{ -enum PageOrientations -{ +namespace Diagram { +enum PageOrientations { //Used to set orientation as Landscape Landscape, //Used to set orientation as portrait Portrait, } } -module Diagram -{ -enum ScrollLimit -{ +namespace Diagram { +enum ScrollLimit { //Used to set scrollLimit as Infinite Infinite, //Used to set scrollLimit as Diagram @@ -62723,10 +62445,8 @@ Diagram, Limited, } } -module Diagram -{ -enum BoundaryConstraints -{ +namespace Diagram { +enum BoundaryConstraints { //Used to set boundaryConstraints as Infinite Infinite, //Used to set boundaryConstraints as Diagram @@ -62735,10 +62455,8 @@ Diagram, Page, } } -module Diagram -{ -enum SelectorConstraints -{ +namespace Diagram { +enum SelectorConstraints { //Hides the selector None, //Sets the visibility of rotation handle as visible @@ -62751,10 +62469,8 @@ UserHandles, All, } } -module Diagram -{ -enum UserHandlePositions -{ +namespace Diagram { +enum UserHandlePositions { //Set the position of the userhandle as topleft TopLeft, //Set the position of the userhandle as topcenter @@ -62773,10 +62489,8 @@ BottomCenter, BottomRight, } } -module Diagram -{ -enum SnapConstraints -{ +namespace Diagram { +enum SnapConstraints { //Enables node to be snapped to horizontal gridlines None, //Enables node to be snapped to vertical gridlines @@ -62795,10 +62509,8 @@ ShowLines, All, } } -module Diagram -{ -enum Tool -{ +namespace Diagram { +enum Tool { //Disables all Tools None, //Enables/Disables SingleSelect tool @@ -62813,20 +62525,16 @@ DrawOnce, ContinuesDraw, } } -module Diagram -{ -enum RelativeMode -{ +namespace Diagram { +enum RelativeMode { //Shows tooltip around the node Object, //Shows tooltip at the mouse position Mouse, } } -module Diagram -{ -enum ZoomCommand -{ +namespace Diagram { +enum ZoomCommand { //Used to zoom in the Diagram ZoomIn, //Used to zoom out the diagram @@ -62836,13 +62544,12 @@ ZoomOut, class HeatMap extends ej.Widget { static fn: HeatMap; - constructor(element: JQuery, options?: HeatMap.Model); - constructor(element: Element, options?: HeatMap.Model); + constructor(element: JQuery | Element, options?: HeatMap.Model); static Locale: any; - model:HeatMap.Model; - defaults:HeatMap.Model; + model: HeatMap.Model; + defaults: HeatMap.Model; } -export module HeatMap{ +export namespace HeatMap { export interface Model { @@ -62898,7 +62605,7 @@ export interface Model { /** Specifies the no of legends can sync with heat map. * @Default {[]} */ - legendCollection?: Array; + legendCollection?: any[]; /** Specifies the property and display value of the heat map column. * @Default {[]} @@ -62908,19 +62615,19 @@ export interface Model { /** Specifies the color values of the heat map column data. * @Default {[]} */ - colorMappingCollection?: Array; + colorMappingCollection?: ColorMappingCollection[]; /** Triggered when the mouse over on the cell. */ - cellMouseOver? (e: CellMouseOverEventArgs): void; + cellMouseOver?(e: CellMouseOverEventArgs): void; /** Triggered when the mouse over on the cell. */ - cellMouseEnter? (e: CellMouseEnterEventArgs): void; + cellMouseEnter?(e: CellMouseEnterEventArgs): void; /** Triggered when the mouse over on the cell. */ - cellMouseLeave? (e: CellMouseLeaveEventArgs): void; + cellMouseLeave?(e: CellMouseLeaveEventArgs): void; /** Triggered when the mouse over on the cell. */ - cellSelected? (e: CellSelectedEventArgs): void; + cellSelected?(e: CellSelectedEventArgs): void; } export interface CellMouseOverEventArgs { @@ -63175,7 +62882,7 @@ export interface ItemsMapping { */ column?: ItemsMappingColumn; - /** Specifies the row property and display value of the heat map. + /** Specifies the property and display value of the heat map.row * @Default {null} */ row?: ItemsMappingRow; @@ -63193,7 +62900,7 @@ export interface ItemsMapping { /** Specifies the property and display value of the collection of column. * @Default {[]} */ - columnMapping?: Array; + columnMapping?: any[]; } export interface ColorMappingCollectionLabel { @@ -63251,10 +62958,8 @@ export interface ColorMappingCollection { label?: ColorMappingCollectionLabel; } } -module HeatMap -{ -enum Associate -{ +namespace HeatMap { +enum Associate { //Used to set the associate of tooltip as Target Target, //Used to set the associate of tooltip as MouseFollow @@ -63263,10 +62968,8 @@ MouseFollow, MouseEnter, } } -module HeatMap -{ -enum Horizontal -{ +namespace HeatMap { +enum Horizontal { //Used to display the tooltip horizontally on left side of rows/columns Left, //Used to display the tooltip horizontally on center side of rows/columns @@ -63275,10 +62978,8 @@ Center, Right, } } -module HeatMap -{ -enum Vertical -{ +namespace HeatMap { +enum Vertical { //Used to display the tooltip horizontally on left side of rows/columns Top, //Used to display the tooltip horizontally on center side of rows/columns @@ -63287,20 +62988,16 @@ Center, Bottom, } } -module HeatMap -{ -enum Trigger -{ +namespace HeatMap { +enum Trigger { //Tooltip can be triggered on mouse hovers Hover, //Tooltip can be triggered on mouse click Click, } } -module HeatMap -{ -enum Effect -{ +namespace HeatMap { +enum Effect { //Sets tooltip animation as None None, //Sets tooltip animation as Fade @@ -63309,21 +63006,17 @@ Fade, Slide, } } -module HeatMap -{ -enum CellVisibility -{ -//Display the content of the cell +namespace HeatMap { +enum CellVisibility { +//Display the content of the cell Visible, -//Hide the content of the cell +//Hide the content of the cell Hidden, } } -module HeatMap -{ -enum TextDecoration -{ -//Defines a line below the text +namespace HeatMap { +enum TextDecoration { +//Defines a line below the text Underline, //Defines a line above the text Overline, @@ -63336,13 +63029,12 @@ None, class HeatMapLegend extends ej.Widget { static fn: HeatMapLegend; - constructor(element: JQuery, options?: HeatMapLegend.Model); - constructor(element: Element, options?: HeatMapLegend.Model); + constructor(element: JQuery | Element, options?: HeatMapLegend.Model); static Locale: any; - model:HeatMapLegend.Model; - defaults:HeatMapLegend.Model; + model: HeatMapLegend.Model; + defaults: HeatMapLegend.Model; } -export module HeatMapLegend{ +export namespace HeatMapLegend { export interface Model { @@ -63369,7 +63061,7 @@ export interface Model { /** Specifies the color values of the column data. * @Default {[]} */ - colorMappingCollection?: Array; + colorMappingCollection?: ColorMappingCollection[]; /** Specifies the orientation of the heatmap legend * @Default {ej.HeatMap.LegendOrientation.Horizontal} @@ -63437,41 +63129,36 @@ export interface ColorMappingCollection { label?: ColorMappingCollectionLabel; } } -module HeatMap -{ -enum LegendOrientation -{ -//Scales the graphic content non-uniformly to the width and height of the diagram area +namespace HeatMap { +enum LegendOrientation { +//Scales the graphic content non-uniformly to the width and height of the diagram area Horizontal, -//Used to align the image at the top left of diagram area +//Used to align the image at the top left of diagram area Vertical, } } -module HeatMap -{ -enum LegendMode -{ -//Scales the graphic content non-uniformly to the width and height of the diagram area +namespace HeatMap { +enum LegendMode { +//Scales the graphic content non-uniformly to the width and height of the diagram area Gradient, -//Used to align the image at the top left of diagram area +//Used to align the image at the top left of diagram area List, } } class Sparkline extends ej.Widget { static fn: Sparkline; - constructor(element: JQuery, options?: Sparkline.Model); - constructor(element: Element, options?: Sparkline.Model); + constructor(element: JQuery | Element, options?: Sparkline.Model); static Locale: any; - model:Sparkline.Model; - defaults:Sparkline.Model; + model: Sparkline.Model; + defaults: Sparkline.Model; /** Redraws the entire sparkline. You can call this method whenever you update, add or remove points from the data source or whenever you want to refresh the UI. * @returns {void} */ redraw(): void; } -export module Sparkline{ +export namespace Sparkline { export interface Model { @@ -63594,28 +63281,28 @@ export interface Model { axisLineSettings?: AxisLineSettings; /** Fires before loading the sparkline. */ - load? (e: LoadEventArgs): void; + load?(e: LoadEventArgs): void; /** Fires after loaded the sparkline. */ - loaded? (e: LoadedEventArgs): void; + loaded?(e: LoadedEventArgs): void; /** Fires before rendering trackball tooltip. You can use this event to customize the text displayed in trackball tooltip. */ - tooltipInitialize? (e: TooltipInitializeEventArgs): void; + tooltipInitialize?(e: TooltipInitializeEventArgs): void; /** Fires before rendering a series. This event is fired for each series in Sparkline. */ - seriesRendering? (e: SeriesRenderingEventArgs): void; + seriesRendering?(e: SeriesRenderingEventArgs): void; /** Fires when mouse is moved over a point. */ - pointRegionMouseMove? (e: PointRegionMouseMoveEventArgs): void; + pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; /** Fires on clicking a point in sparkline. You can use this event to handle clicks made on points. */ - pointRegionMouseClick? (e: PointRegionMouseClickEventArgs): void; + pointRegionMouseClick?(e: PointRegionMouseClickEventArgs): void; /** Fires on moving mouse over the sparkline. */ - sparklineMouseMove? (e: SparklineMouseMoveEventArgs): void; + sparklineMouseMove?(e: SparklineMouseMoveEventArgs): void; /** Fires on moving mouse outside the sparkline. */ - sparklineMouseLeave? (e: SparklineMouseLeaveEventArgs): void; + sparklineMouseLeave?(e: SparklineMouseLeaveEventArgs): void; } export interface LoadEventArgs { @@ -63650,7 +63337,7 @@ export interface LoadedEventArgs { export interface TooltipInitializeEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -63774,7 +63461,7 @@ export interface PointRegionMouseClickEventArgs { export interface SparklineMouseMoveEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -63789,7 +63476,7 @@ export interface SparklineMouseMoveEventArgs { export interface SparklineMouseLeaveEventArgs { - /** Set this option to true to cancel the event + /** Set this option to true to cancel the event */ cancel?: boolean; @@ -63990,10 +63677,8 @@ export interface AxisLineSettings { dashArray?: number; } } -module Sparkline -{ -enum Type -{ +namespace Sparkline { +enum Type { //string Area, //string @@ -64006,10 +63691,8 @@ Pie, WinLoss, } } -module Sparkline -{ -enum Theme -{ +namespace Sparkline { +enum Theme { //string Azure, //string @@ -64032,20 +63715,16 @@ GradientLight, GradientDark, } } -module Sparkline -{ -enum FontStyle -{ +namespace Sparkline { +enum FontStyle { //string Normal, //string Italic, } } -module Sparkline -{ -enum FontWeight -{ +namespace Sparkline { +enum FontWeight { //string Regular, //string @@ -64057,11 +63736,10 @@ Lighter, class SunburstChart extends ej.Widget { static fn: SunburstChart; - constructor(element: JQuery, options?: SunburstChart.Model); - constructor(element: Element, options?: SunburstChart.Model); + constructor(element: JQuery | Element, options?: SunburstChart.Model); static Locale: any; - model:SunburstChart.Model; - defaults:SunburstChart.Model; + model: SunburstChart.Model; + defaults: SunburstChart.Model; /** Redraws the entire sunburst. You can call this method whenever you update, add or remove points from the data source or whenever you want to refresh the UI. * @returns {void} @@ -64073,7 +63751,7 @@ class SunburstChart extends ej.Widget { */ _destroy(): void; } -export module SunburstChart{ +export namespace SunburstChart { export interface Model { @@ -64181,7 +63859,7 @@ export interface Model { /** Specify levels of sunburst for grouped visualization of data * @Default {[]} */ - levels?: Array; + levels?: Level[]; /** Options to customize the legend items and legend title. */ @@ -64216,40 +63894,40 @@ export interface Model { animationType?: ej.datavisualization.Sunburst.Animation|string; /** Fires before loading. */ - load? (e: LoadEventArgs): void; + load?(e: LoadEventArgs): void; /** Fires before rendering sunburst. */ - preRender? (e: PreRenderEventArgs): void; + preRender?(e: PreRenderEventArgs): void; /** Fires after rendering sunburst. */ - loaded? (e: LoadedEventArgs): void; + loaded?(e: LoadedEventArgs): void; /** Fires before rendering the datalabel */ - dataLabelRendering? (e: DataLabelRenderingEventArgs): void; + dataLabelRendering?(e: DataLabelRenderingEventArgs): void; /** Fires before rendering each segment */ - segmentRendering? (e: SegmentRenderingEventArgs): void; + segmentRendering?(e: SegmentRenderingEventArgs): void; /** Fires before rendering sunburst title. */ - titleRendering? (e: TitleRenderingEventArgs): void; + titleRendering?(e: TitleRenderingEventArgs): void; /** Fires during initialization of tooltip. */ - tooltipInitialize? (e: TooltipInitializeEventArgs): void; + tooltipInitialize?(e: TooltipInitializeEventArgs): void; /** Fires after clicking the point in sunburst */ - pointRegionClick? (e: PointRegionClickEventArgs): void; + pointRegionClick?(e: PointRegionClickEventArgs): void; /** Fires while moving the mouse over sunburst points */ - pointRegionMouseMove? (e: PointRegionMouseMoveEventArgs): void; + pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; /** Fires when clicking the point to perform drilldown. */ - drillDownClick? (e: DrillDownClickEventArgs): void; + drillDownClick?(e: DrillDownClickEventArgs): void; /** Fires when resetting drilldown points. */ - drillDownBack? (e: DrillDownBackEventArgs): void; + drillDownBack?(e: DrillDownBackEventArgs): void; /** Fires after resetting the sunburst points */ - drillDownReset? (e: DrillDownResetEventArgs): void; + drillDownReset?(e: DrillDownResetEventArgs): void; } export interface LoadEventArgs { @@ -65072,20 +64750,16 @@ export interface ZoomSettings { toolbarVerticalAlignment?: ej.datavisualization.Sunburst.SunburstVerticalAlignment|string; } } -module Sunburst -{ -enum FontStyle -{ +namespace Sunburst { +enum FontStyle { //string Normal, //string Italic, } } -module Sunburst -{ -enum FontWeight -{ +namespace Sunburst { +enum FontWeight { //string Regular, //string @@ -65094,20 +64768,16 @@ Bold, Lighter, } } -module Sunburst -{ -enum SunburstLabelRotationMode -{ +namespace Sunburst { +enum SunburstLabelRotationMode { //string Angle, //string Normal, } } -module Sunburst -{ -enum SunburstLabelOverflowMode -{ +namespace Sunburst { +enum SunburstLabelOverflowMode { //string Trim, //string @@ -65116,10 +64786,8 @@ Hide, None, } } -module Sunburst -{ -enum SunburstAlignment -{ +namespace Sunburst { +enum SunburstAlignment { //string Center, //string @@ -65128,10 +64796,8 @@ Near, Far, } } -module Sunburst -{ -enum SunburstHighlightMode -{ +namespace Sunburst { +enum SunburstHighlightMode { //string Point, //string @@ -65142,20 +64808,16 @@ Child, All, } } -module Sunburst -{ -enum SunburstHighlightType -{ +namespace Sunburst { +enum SunburstHighlightType { //string Opacity, //string Color, } } -module Sunburst -{ -enum SunburstClickAction -{ +namespace Sunburst { +enum SunburstClickAction { //string None, //string @@ -65164,10 +64826,8 @@ ToggleSegmentVisibility, ToggleSegmentSelection, } } -module Sunburst -{ -enum SunburstLegendPosition -{ +namespace Sunburst { +enum SunburstLegendPosition { //string Left, //string @@ -65178,10 +64838,8 @@ Top, Bottom, } } -module Sunburst -{ -enum SunburstLegendShape -{ +namespace Sunburst { +enum SunburstLegendShape { //string Diamond, //string @@ -65196,20 +64854,16 @@ Cross, Triangle, } } -module Sunburst -{ -enum SunburstTheme -{ +namespace Sunburst { +enum SunburstTheme { //string FlatLight, //string FlatDark, } } -module Sunburst -{ -enum SunburstHorizontalAlignment -{ +namespace Sunburst { +enum SunburstHorizontalAlignment { //string Center, //string @@ -65218,10 +64872,8 @@ Left, Right, } } -module Sunburst -{ -enum SunburstVerticalAlignment -{ +namespace Sunburst { +enum SunburstVerticalAlignment { //string Top, //string @@ -65230,10 +64882,8 @@ Bottom, Middle, } } -module Sunburst -{ -enum Animation -{ +namespace Sunburst { +enum Animation { //string Rotation, //string @@ -65243,13 +64893,12 @@ FadeIn, class Overview extends ej.Widget { static fn: Overview; - constructor(element: JQuery, options?: Overview.Model); - constructor(element: Element, options?: Overview.Model); + constructor(element: JQuery | Element, options?: Overview.Model); static Locale: any; - model:Overview.Model; - defaults:Overview.Model; + model: Overview.Model; + defaults: Overview.Model; } -export module Overview{ +export namespace Overview { export interface Model { @@ -65273,12 +64922,24 @@ export interface Model { } interface JQueryXHR { + /** Returns the cancel option value. + */ + cancel?: boolean; } interface JQueryPromise { + /** Returns the cancel option value. + */ + cancel?: boolean; } interface JQueryDeferred extends JQueryPromise { + /** Returns the cancel option value. + */ + cancel?: boolean; } interface JQueryParam { + /** Returns the cancel option value. + */ + cancel?: boolean; } interface JQuery { data(key: any): any; @@ -65288,413 +64949,332 @@ interface Window { } interface JQuery { -ejAccordion(): JQuery; ejAccordion(options?: ej.Accordion.Model): JQuery; ejAccordion(memberName: any, value?: any, param?: any): any; -data(key: "ejAccordion"): ej.Accordion; -ejAutocomplete(): JQuery; ejAutocomplete(options?: ej.Autocomplete.Model): JQuery; ejAutocomplete(memberName: any, value?: any, param?: any): any; -data(key: "ejAutocomplete"): ej.Autocomplete; -ejBarcode(): JQuery; ejBarcode(options?: ej.datavisualization.Barcode.Model): JQuery; ejBarcode(memberName: any, value?: any, param?: any): any; -data(key: "ejBarcode"): ej.datavisualization.Barcode; -ejBulletGraph(): JQuery; ejBulletGraph(options?: ej.datavisualization.BulletGraph.Model): JQuery; ejBulletGraph(memberName: any, value?: any, param?: any): any; -data(key: "ejBulletGraph"): ej.datavisualization.BulletGraph; -ejButton(): JQuery; ejButton(options?: ej.Button.Model): JQuery; ejButton(memberName: any, value?: any, param?: any): any; -data(key: "ejButton"): ej.Button; -ejCaptcha(): JQuery; ejCaptcha(options?: ej.Captcha.Model): JQuery; ejCaptcha(memberName: any, value?: any, param?: any): any; -data(key: "ejCaptcha"): ej.Captcha; -ejChart(): JQuery; ejChart(options?: ej.datavisualization.Chart.Model): JQuery; ejChart(memberName: any, value?: any, param?: any): any; -data(key: "ejChart"): ej.datavisualization.Chart; -ejCheckBox(): JQuery; ejCheckBox(options?: ej.CheckBox.Model): JQuery; ejCheckBox(memberName: any, value?: any, param?: any): any; -data(key: "ejCheckBox"): ej.CheckBox; -ejCircularGauge(): JQuery; ejCircularGauge(options?: ej.datavisualization.CircularGauge.Model): JQuery; ejCircularGauge(memberName: any, value?: any, param?: any): any; -data(key: "ejCircularGauge"): ej.datavisualization.CircularGauge; -ejColorPicker(): JQuery; ejColorPicker(options?: ej.ColorPicker.Model): JQuery; ejColorPicker(memberName: any, value?: any, param?: any): any; -data(key: "ejColorPicker"): ej.ColorPicker; -ejDatePicker(): JQuery; ejDatePicker(options?: ej.DatePicker.Model): JQuery; ejDatePicker(memberName: any, value?: any, param?: any): any; -data(key: "ejDatePicker"): ej.DatePicker; -ejDateRangePicker(): JQuery; ejDateRangePicker(options?: ej.DateRangePicker.Model): JQuery; ejDateRangePicker(memberName: any, value?: any, param?: any): any; -data(key: "ejDateRangePicker"): ej.DateRangePicker; -ejDateTimePicker(): JQuery; ejDateTimePicker(options?: ej.DateTimePicker.Model): JQuery; ejDateTimePicker(memberName: any, value?: any, param?: any): any; -data(key: "ejDateTimePicker"): ej.DateTimePicker; -ejDiagram(): JQuery; ejDiagram(options?: ej.datavisualization.Diagram.Model): JQuery; ejDiagram(memberName: any, value?: any, param?: any): any; -data(key: "ejDiagram"): ej.datavisualization.Diagram; -ejDialog(): JQuery; ejDialog(options?: ej.Dialog.Model): JQuery; ejDialog(memberName: any, value?: any, param?: any): any; -data(key: "ejDialog"): ej.Dialog; -ejDigitalGauge(): JQuery; ejDigitalGauge(options?: ej.datavisualization.DigitalGauge.Model): JQuery; ejDigitalGauge(memberName: any, value?: any, param?: any): any; -data(key: "ejDigitalGauge"): ej.datavisualization.DigitalGauge; -ejDocumentEditor(): JQuery; ejDocumentEditor(options?: ej.DocumentEditor.Model): JQuery; ejDocumentEditor(memberName: any, value?: any, param?: any): any; -data(key: "ejDocumentEditor"): ej.DocumentEditor; -ejDraggable(): JQuery; ejDraggable(options?: ej.Draggable.Model): JQuery; ejDraggable(memberName: any, value?: any, param?: any): any; -data(key: "ejDraggable"): ej.Draggable; -ejDropDownList(): JQuery; ejDropDownList(options?: ej.DropDownList.Model): JQuery; ejDropDownList(memberName: any, value?: any, param?: any): any; -data(key: "ejDropDownList"): ej.DropDownList; -ejDroppable(): JQuery; ejDroppable(options?: ej.Droppable.Model): JQuery; ejDroppable(memberName: any, value?: any, param?: any): any; -data(key: "ejDroppable"): ej.Droppable; -ejFileExplorer(): JQuery; ejFileExplorer(options?: ej.FileExplorer.Model): JQuery; ejFileExplorer(memberName: any, value?: any, param?: any): any; -data(key: "ejFileExplorer"): ej.FileExplorer; -ejGantt(): JQuery; ejGantt(options?: ej.Gantt.Model): JQuery; ejGantt(memberName: any, value?: any, param?: any): any; -data(key: "ejGantt"): ej.Gantt; -ejGrid(): JQuery; ejGrid(options?: ej.Grid.Model): JQuery; ejGrid(memberName: any, value?: any, param?: any): any; -data(key: "ejGrid"): ej.Grid; -ejGroupButton(): JQuery; ejGroupButton(options?: ej.GroupButton.Model): JQuery; ejGroupButton(memberName: any, value?: any, param?: any): any; -data(key: "ejGroupButton"): ej.GroupButton; -ejHeatMap(): JQuery; ejHeatMap(options?: ej.datavisualization.HeatMap.Model): JQuery; ejHeatMap(memberName: any, value?: any, param?: any): any; -data(key: "ejHeatMap"): ej.datavisualization.HeatMap; -ejHeatMapLegend(): JQuery; ejHeatMapLegend(options?: ej.datavisualization.HeatMapLegend.Model): JQuery; ejHeatMapLegend(memberName: any, value?: any, param?: any): any; -data(key: "ejHeatMapLegend"): ej.datavisualization.HeatMapLegend; -ejKanban(): JQuery; ejKanban(options?: ej.Kanban.Model): JQuery; ejKanban(memberName: any, value?: any, param?: any): any; -data(key: "ejKanban"): ej.Kanban; -ejLinearGauge(): JQuery; ejLinearGauge(options?: ej.datavisualization.LinearGauge.Model): JQuery; ejLinearGauge(memberName: any, value?: any, param?: any): any; -data(key: "ejLinearGauge"): ej.datavisualization.LinearGauge; -ejListBox(): JQuery; ejListBox(options?: ej.ListBox.Model): JQuery; ejListBox(memberName: any, value?: any, param?: any): any; -data(key: "ejListBox"): ej.ListBox; -ejListView(): JQuery; ejListView(options?: ej.ListView.Model): JQuery; ejListView(memberName: any, value?: any, param?: any): any; -data(key: "ejListView"): ej.ListView; -ejMap(): JQuery; ejMap(options?: ej.datavisualization.Map.Model): JQuery; ejMap(memberName: any, value?: any, param?: any): any; -data(key: "ejMap"): ej.datavisualization.Map; -ejMaskEdit(): JQuery; ejMaskEdit(options?: ej.MaskEdit.Model): JQuery; ejMaskEdit(memberName: any, value?: any, param?: any): any; -data(key: "ejMaskEdit"): ej.MaskEdit; -ejMenu(): JQuery; ejMenu(options?: ej.Menu.Model): JQuery; ejMenu(memberName: any, value?: any, param?: any): any; -data(key: "ejMenu"): ej.Menu; -ejNavigationDrawer(): JQuery; ejNavigationDrawer(options?: ej.NavigationDrawer.Model): JQuery; ejNavigationDrawer(memberName: any, value?: any, param?: any): any; -data(key: "ejNavigationDrawer"): ej.NavigationDrawer; -ejOverview(): JQuery; ejOverview(options?: ej.datavisualization.Overview.Model): JQuery; ejOverview(memberName: any, value?: any, param?: any): any; -data(key: "ejOverview"): ej.datavisualization.Overview; -ejPager(): JQuery; ejPager(options?: ej.Pager.Model): JQuery; ejPager(memberName: any, value?: any, param?: any): any; -data(key: "ejPager"): ej.Pager; -ejPdfViewer(): JQuery; ejPdfViewer(options?: ej.PdfViewer.Model): JQuery; ejPdfViewer(memberName: any, value?: any, param?: any): any; -data(key: "ejPdfViewer"): ej.PdfViewer; -ejPivotChart(): JQuery; ejPivotChart(options?: ej.PivotChart.Model): JQuery; ejPivotChart(memberName: any, value?: any, param?: any): any; -data(key: "ejPivotChart"): ej.PivotChart; -ejPivotClient(): JQuery; ejPivotClient(options?: ej.PivotClient.Model): JQuery; ejPivotClient(memberName: any, value?: any, param?: any): any; -data(key: "ejPivotClient"): ej.PivotClient; -ejPivotGauge(): JQuery; ejPivotGauge(options?: ej.PivotGauge.Model): JQuery; ejPivotGauge(memberName: any, value?: any, param?: any): any; -data(key: "ejPivotGauge"): ej.PivotGauge; -ejPivotGrid(): JQuery; ejPivotGrid(options?: ej.PivotGrid.Model): JQuery; ejPivotGrid(memberName: any, value?: any, param?: any): any; -data(key: "ejPivotGrid"): ej.PivotGrid; -ejPivotPager(): JQuery; ejPivotPager(options?: ej.PivotPager.Model): JQuery; ejPivotPager(memberName: any, value?: any, param?: any): any; -data(key: "ejPivotPager"): ej.PivotPager; -ejPivotSchemaDesigner(): JQuery; ejPivotSchemaDesigner(options?: ej.PivotSchemaDesigner.Model): JQuery; ejPivotSchemaDesigner(memberName: any, value?: any, param?: any): any; -data(key: "ejPivotSchemaDesigner"): ej.PivotSchemaDesigner; -ejPivotTreeMap(): JQuery; ejPivotTreeMap(options?: ej.PivotTreeMap.Model): JQuery; ejPivotTreeMap(memberName: any, value?: any, param?: any): any; -data(key: "ejPivotTreeMap"): ej.PivotTreeMap; -ejProgressBar(): JQuery; ejProgressBar(options?: ej.ProgressBar.Model): JQuery; ejProgressBar(memberName: any, value?: any, param?: any): any; -data(key: "ejProgressBar"): ej.ProgressBar; -ejRadialMenu(): JQuery; ejRadialMenu(options?: ej.RadialMenu.Model): JQuery; ejRadialMenu(memberName: any, value?: any, param?: any): any; -data(key: "ejRadialMenu"): ej.RadialMenu; -ejRadialSlider(): JQuery; ejRadialSlider(options?: ej.RadialSlider.Model): JQuery; ejRadialSlider(memberName: any, value?: any, param?: any): any; -data(key: "ejRadialSlider"): ej.RadialSlider; -ejRadioButton(): JQuery; ejRadioButton(options?: ej.RadioButton.Model): JQuery; ejRadioButton(memberName: any, value?: any, param?: any): any; -data(key: "ejRadioButton"): ej.RadioButton; -ejRangeNavigator(): JQuery; ejRangeNavigator(options?: ej.datavisualization.RangeNavigator.Model): JQuery; ejRangeNavigator(memberName: any, value?: any, param?: any): any; -data(key: "ejRangeNavigator"): ej.datavisualization.RangeNavigator; -ejRating(): JQuery; ejRating(options?: ej.Rating.Model): JQuery; ejRating(memberName: any, value?: any, param?: any): any; -data(key: "ejRating"): ej.Rating; -ejRecurrenceEditor(): JQuery; ejRecurrenceEditor(options?: ej.RecurrenceEditor.Model): JQuery; ejRecurrenceEditor(memberName: any, value?: any, param?: any): any; -data(key: "ejRecurrenceEditor"): ej.RecurrenceEditor; -ejReportViewer(): JQuery; ejReportViewer(options?: ej.ReportViewer.Model): JQuery; ejReportViewer(memberName: any, value?: any, param?: any): any; -data(key: "ejReportViewer"): ej.ReportViewer; -ejResizable(): JQuery; ejResizable(options?: ej.Resizable.Model): JQuery; ejResizable(memberName: any, value?: any, param?: any): any; -data(key: "ejResizable"): ej.Resizable; -ejRibbon(): JQuery; ejRibbon(options?: ej.Ribbon.Model): JQuery; ejRibbon(memberName: any, value?: any, param?: any): any; -data(key: "ejRibbon"): ej.Ribbon; -ejRotator(): JQuery; ejRotator(options?: ej.Rotator.Model): JQuery; ejRotator(memberName: any, value?: any, param?: any): any; -data(key: "ejRotator"): ej.Rotator; -ejRTE(): JQuery; ejRTE(options?: ej.RTE.Model): JQuery; ejRTE(memberName: any, value?: any, param?: any): any; -data(key: "ejRTE"): ej.RTE; -ejSchedule(): JQuery; ejSchedule(options?: ej.Schedule.Model): JQuery; ejSchedule(memberName: any, value?: any, param?: any): any; -data(key: "ejSchedule"): ej.Schedule; -ejScroller(): JQuery; ejScroller(options?: ej.Scroller.Model): JQuery; ejScroller(memberName: any, value?: any, param?: any): any; -data(key: "ejScroller"): ej.Scroller; -ejSignature(): JQuery; ejSignature(options?: ej.Signature.Model): JQuery; ejSignature(memberName: any, value?: any, param?: any): any; -data(key: "ejSignature"): ej.Signature; -ejSlider(): JQuery; ejSlider(options?: ej.Slider.Model): JQuery; ejSlider(memberName: any, value?: any, param?: any): any; -data(key: "ejSlider"): ej.Slider; -ejSparkline(): JQuery; ejSparkline(options?: ej.datavisualization.Sparkline.Model): JQuery; ejSparkline(memberName: any, value?: any, param?: any): any; -data(key: "ejSparkline"): ej.datavisualization.Sparkline; -ejSpellCheck(): JQuery; ejSpellCheck(options?: ej.SpellCheck.Model): JQuery; ejSpellCheck(memberName: any, value?: any, param?: any): any; -data(key: "ejSpellCheck"): ej.SpellCheck; -ejSplitButton(): JQuery; ejSplitButton(options?: ej.SplitButton.Model): JQuery; ejSplitButton(memberName: any, value?: any, param?: any): any; -data(key: "ejSplitButton"): ej.SplitButton; -ejSplitter(): JQuery; ejSplitter(options?: ej.Splitter.Model): JQuery; ejSplitter(memberName: any, value?: any, param?: any): any; -data(key: "ejSplitter"): ej.Splitter; -ejSpreadsheet(): JQuery; ejSpreadsheet(options?: ej.Spreadsheet.Model): JQuery; ejSpreadsheet(memberName: any, value?: any, param?: any): any; -data(key: "ejSpreadsheet"): ej.Spreadsheet; -ejSunburstChart(): JQuery; ejSunburstChart(options?: ej.datavisualization.SunburstChart.Model): JQuery; ejSunburstChart(memberName: any, value?: any, param?: any): any; -data(key: "ejSunburstChart"): ej.datavisualization.SunburstChart; -ejSymbolPalette(): JQuery; ejSymbolPalette(options?: ej.datavisualization.SymbolPalette.Model): JQuery; ejSymbolPalette(memberName: any, value?: any, param?: any): any; -data(key: "ejSymbolPalette"): ej.datavisualization.SymbolPalette; -ejTab(): JQuery; ejTab(options?: ej.Tab.Model): JQuery; ejTab(memberName: any, value?: any, param?: any): any; -data(key: "ejTab"): ej.Tab; -ejTagCloud(): JQuery; ejTagCloud(options?: ej.TagCloud.Model): JQuery; ejTagCloud(memberName: any, value?: any, param?: any): any; -data(key: "ejTagCloud"): ej.TagCloud; -ejNumericTextbox(): JQuery; ejNumericTextbox(options?: ej.Editor.Model): JQuery; ejNumericTextbox(memberName: any, value?: any, param?: any): any; -data(key: "ejNumericTextbox"): ej.NumericTextbox; -ejCurrencyTextbox(): JQuery; ejCurrencyTextbox(options?: ej.Editor.Model): JQuery; ejCurrencyTextbox(memberName: any, value?: any, param?: any): any; -data(key: "ejCurrencyTextbox"): ej.CurrencyTextbox; -ejPercentageTextbox(): JQuery; ejPercentageTextbox(options?: ej.Editor.Model): JQuery; ejPercentageTextbox(memberName: any, value?: any, param?: any): any; -data(key: "ejPercentageTextbox"): ej.PercentageTextbox; -ejTile(): JQuery; ejTile(options?: ej.Tile.Model): JQuery; ejTile(memberName: any, value?: any, param?: any): any; -data(key: "ejTile"): ej.Tile; -ejTimePicker(): JQuery; ejTimePicker(options?: ej.TimePicker.Model): JQuery; ejTimePicker(memberName: any, value?: any, param?: any): any; -data(key: "ejTimePicker"): ej.TimePicker; -ejToggleButton(): JQuery; ejToggleButton(options?: ej.ToggleButton.Model): JQuery; ejToggleButton(memberName: any, value?: any, param?: any): any; -data(key: "ejToggleButton"): ej.ToggleButton; -ejToolbar(): JQuery; ejToolbar(options?: ej.Toolbar.Model): JQuery; ejToolbar(memberName: any, value?: any, param?: any): any; -data(key: "ejToolbar"): ej.Toolbar; -ejTooltip(): JQuery; ejTooltip(options?: ej.Tooltip.Model): JQuery; ejTooltip(memberName: any, value?: any, param?: any): any; -data(key: "ejTooltip"): ej.Tooltip; -ejTreeGrid(): JQuery; ejTreeGrid(options?: ej.TreeGrid.Model): JQuery; ejTreeGrid(memberName: any, value?: any, param?: any): any; -data(key: "ejTreeGrid"): ej.TreeGrid; -ejTreeMap(): JQuery; ejTreeMap(options?: ej.datavisualization.TreeMap.Model): JQuery; ejTreeMap(memberName: any, value?: any, param?: any): any; -data(key: "ejTreeMap"): ej.datavisualization.TreeMap; -ejTreeView(): JQuery; ejTreeView(options?: ej.TreeView.Model): JQuery; ejTreeView(memberName: any, value?: any, param?: any): any; -data(key: "ejTreeView"): ej.TreeView; -ejUploadbox(): JQuery; ejUploadbox(options?: ej.Uploadbox.Model): JQuery; ejUploadbox(memberName: any, value?: any, param?: any): any; -data(key: "ejUploadbox"): ej.Uploadbox; -ejWaitingPopup(): JQuery; ejWaitingPopup(options?: ej.WaitingPopup.Model): JQuery; ejWaitingPopup(memberName: any, value?: any, param?: any): any; + +data(key: "ejAccordion"): ej.Accordion; +data(key: "ejAutocomplete"): ej.Autocomplete; +data(key: "ejBarcode"): ej.datavisualization.Barcode; +data(key: "ejBulletGraph"): ej.datavisualization.BulletGraph; +data(key: "ejButton"): ej.Button; +data(key: "ejCaptcha"): ej.Captcha; +data(key: "ejChart"): ej.datavisualization.Chart; +data(key: "ejCheckBox"): ej.CheckBox; +data(key: "ejCircularGauge"): ej.datavisualization.CircularGauge; +data(key: "ejColorPicker"): ej.ColorPicker; +data(key: "ejDatePicker"): ej.DatePicker; +data(key: "ejDateRangePicker"): ej.DateRangePicker; +data(key: "ejDateTimePicker"): ej.DateTimePicker; +data(key: "ejDiagram"): ej.datavisualization.Diagram; +data(key: "ejDialog"): ej.Dialog; +data(key: "ejDigitalGauge"): ej.datavisualization.DigitalGauge; +data(key: "ejDocumentEditor"): ej.DocumentEditor; +data(key: "ejDraggable"): ej.Draggable; +data(key: "ejDropDownList"): ej.DropDownList; +data(key: "ejDroppable"): ej.Droppable; +data(key: "ejFileExplorer"): ej.FileExplorer; +data(key: "ejGantt"): ej.Gantt; +data(key: "ejGrid"): ej.Grid; +data(key: "ejGroupButton"): ej.GroupButton; +data(key: "ejHeatMap"): ej.datavisualization.HeatMap; +data(key: "ejHeatMapLegend"): ej.datavisualization.HeatMapLegend; +data(key: "ejKanban"): ej.Kanban; +data(key: "ejLinearGauge"): ej.datavisualization.LinearGauge; +data(key: "ejListBox"): ej.ListBox; +data(key: "ejListView"): ej.ListView; +data(key: "ejMap"): ej.datavisualization.Map; +data(key: "ejMaskEdit"): ej.MaskEdit; +data(key: "ejMenu"): ej.Menu; +data(key: "ejNavigationDrawer"): ej.NavigationDrawer; +data(key: "ejOverview"): ej.datavisualization.Overview; +data(key: "ejPager"): ej.Pager; +data(key: "ejPdfViewer"): ej.PdfViewer; +data(key: "ejPivotChart"): ej.PivotChart; +data(key: "ejPivotClient"): ej.PivotClient; +data(key: "ejPivotGauge"): ej.PivotGauge; +data(key: "ejPivotGrid"): ej.PivotGrid; +data(key: "ejPivotPager"): ej.PivotPager; +data(key: "ejPivotSchemaDesigner"): ej.PivotSchemaDesigner; +data(key: "ejPivotTreeMap"): ej.PivotTreeMap; +data(key: "ejProgressBar"): ej.ProgressBar; +data(key: "ejRadialMenu"): ej.RadialMenu; +data(key: "ejRadialSlider"): ej.RadialSlider; +data(key: "ejRadioButton"): ej.RadioButton; +data(key: "ejRangeNavigator"): ej.datavisualization.RangeNavigator; +data(key: "ejRating"): ej.Rating; +data(key: "ejRecurrenceEditor"): ej.RecurrenceEditor; +data(key: "ejReportViewer"): ej.ReportViewer; +data(key: "ejResizable"): ej.Resizable; +data(key: "ejRibbon"): ej.Ribbon; +data(key: "ejRotator"): ej.Rotator; +data(key: "ejRTE"): ej.RTE; +data(key: "ejSchedule"): ej.Schedule; +data(key: "ejScroller"): ej.Scroller; +data(key: "ejSignature"): ej.Signature; +data(key: "ejSlider"): ej.Slider; +data(key: "ejSparkline"): ej.datavisualization.Sparkline; +data(key: "ejSpellCheck"): ej.SpellCheck; +data(key: "ejSplitButton"): ej.SplitButton; +data(key: "ejSplitter"): ej.Splitter; +data(key: "ejSpreadsheet"): ej.Spreadsheet; +data(key: "ejSunburstChart"): ej.datavisualization.SunburstChart; +data(key: "ejSymbolPalette"): ej.datavisualization.SymbolPalette; +data(key: "ejTab"): ej.Tab; +data(key: "ejTagCloud"): ej.TagCloud; +data(key: "ejNumericTextbox"): ej.NumericTextbox; +data(key: "ejCurrencyTextbox"): ej.CurrencyTextbox; +data(key: "ejPercentageTextbox"): ej.PercentageTextbox; +data(key: "ejTile"): ej.Tile; +data(key: "ejTimePicker"): ej.TimePicker; +data(key: "ejToggleButton"): ej.ToggleButton; +data(key: "ejToolbar"): ej.Toolbar; +data(key: "ejTooltip"): ej.Tooltip; +data(key: "ejTreeGrid"): ej.TreeGrid; +data(key: "ejTreeMap"): ej.datavisualization.TreeMap; +data(key: "ejTreeView"): ej.TreeView; +data(key: "ejUploadbox"): ej.Uploadbox; data(key: "ejWaitingPopup"): ej.WaitingPopup; } From 9324d7a560ee5b7bd3fcef0e76dd175d22ef4304 Mon Sep 17 00:00:00 2001 From: spacejack Date: Tue, 4 Apr 2017 00:53:10 -0400 Subject: [PATCH 147/844] Remove unnecessary interface types, fix some sub-module definitions, update tests. --- types/mithril/index.d.ts | 89 +++++++++++------------------- types/mithril/mount.d.ts | 4 +- types/mithril/redraw.d.ts | 14 ++++- types/mithril/render.d.ts | 13 ++++- types/mithril/request.d.ts | 14 ++++- types/mithril/test/test-jsonp.ts | 6 +- types/mithril/test/test-misc.ts | 27 +++++---- types/mithril/test/test-request.ts | 2 +- types/mithril/withAttr.d.ts | 4 +- 9 files changed, 90 insertions(+), 83 deletions(-) diff --git a/types/mithril/index.d.ts b/types/mithril/index.d.ts index 9e5a4897e5..88b3886a18 100644 --- a/types/mithril/index.d.ts +++ b/types/mithril/index.d.ts @@ -4,6 +4,32 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.2 +/** Manually triggers a redraw of mounted components. */ +declare function redraw(): void; + +/** Renders a vnode structure into a DOM element. */ +declare function render(el: Element, vnodes: Mithril.Children): void; + +/** Mounts a component to a DOM element, enabling it to autoredraw on user events. */ +declare function mount(element: Element, component: Mithril.ComponentTypes): void; +/** Unmounts a component from a DOM element. */ +declare function mount(element: Element, component: null): void; + +/** Makes an XHR request and returns a promise. */ +declare function request (options: Mithril.RequestOptions & { url: string }): Promise; +/** Makes an XHR request and returns a promise. */ +declare function request (url: string, options?: Mithril.RequestOptions): Promise; + +/** Makes a JSON-P request and returns a promise. */ +declare function jsonp(options: Mithril.JsonpOptions & { url: string }): Promise; +/** Makes a JSON-P request and returns a promise. */ +declare function jsonp(url: string, options?: Mithril.JsonpOptions): Promise; + +/** Creates an event handler which takes the value of the specified DOM element property and calls a function with it as the argument. */ +declare function withAttr(name: string, callback: (value: any) => any): (e: { currentTarget: any, [p: string]: any }) => void; +/** Creates an event handler which takes the value of the specified DOM element property and calls a function with it as the argument. */ +declare function withAttr(name: string, callback: (this: T, value: any) => any, thisArg: T): (e: { currentTarget: any, [p: string]: any }) => void; + declare namespace Mithril { export interface Lifecycle { /** The oninit hook is called before a vnode is touched by the virtual DOM engine. */ @@ -74,20 +100,6 @@ declare namespace Mithril { param(): any; } - export interface Mount { - /** Mounts a component to a DOM element, enabling it to autoredraw on user events. */ - (element: Element, component: ComponentTypes): void; - /** Unmounts a component from a DOM element. */ - (element: Element, component: null): void; - } - - export interface WithAttr { - /** Creates an event handler which takes the value of the specified DOM element property and calls a function with it as the argument. */ - (name: string, callback: (value: any) => any): (e: { currentTarget: any, [p: string]: any }) => void; - /** Creates an event handler which takes the value of the specified DOM element property and calls a function with it as the argument. */ - (name: string, callback: (this: T, value: any) => any, thisArg: T): (e: { currentTarget: any, [p: string]: any }) => void; - } - export interface RequestOptions { /** The HTTP method to use. */ method?: string; @@ -119,13 +131,6 @@ declare namespace Mithril { background?: boolean; } - export interface Request { - /** Makes an XHR request and returns a promise. */ - (options: RequestOptions & { url: string }): Promise; - /** Makes an XHR request and returns a promise. */ - (url: string, options?: RequestOptions): Promise; - } - export interface JsonpOptions { /** The data to be interpolated into the URL and serialized into the querystring. */ data?: any; @@ -139,43 +144,14 @@ declare namespace Mithril { background?: boolean; } - export interface Jsonp { - /** Makes a JSON-P request and returns a promise. */ - (options: JsonpOptions & { url: string }): Promise; - /** Makes a JSON-P request and returns a promise. */ - (url: string, options?: JsonpOptions): Promise; - } - - export interface RequestService { - request: Request; - jsonp: Jsonp; - } - - /** Renders a vnode structure into a DOM element. */ - export type Render = (el: Element, vnodes: Children) => void; - - export interface RenderService { - render: Render - } - - /** Manually triggers a redraw of mounted components. */ - export type Redraw = () => void; - - export interface RedrawService { - redraw: Redraw - render: Render - } - export interface Static extends Hyperscript { route: Route; - /** Activates a component, enabling it to autoredraw on user events. */ - mount: Mount; - /** Returns a event handler that can be bound to an element, firing with the specified property. */ - withAttr: WithAttr; - render: Render; - redraw: Redraw; - request: Request; - jsonp: Jsonp; + mount: typeof mount; + withAttr: typeof withAttr; + render: typeof render; + redraw: typeof redraw; + request: typeof request; + jsonp: typeof jsonp; /** Returns an object with key/value pairs parsed from a string of the form: ?a=1&b=2 */ parseQueryString(queryString: string): { [p: string]: any }; /** Turns the key/value pairs of an object into a string of the form: a=1&b=2 */ @@ -249,6 +225,7 @@ declare namespace Mithril { /** Components are a mechanism to encapsulate parts of a view to make code easier to organize and/or reuse. Any Javascript object that has a view method is a Mithril component. Components can be consumed via the m() utility. */ export type Comp> = Component & State; + /** Components are a mechanism to encapsulate parts of a view to make code easier to organize and/or reuse. Components can be consumed via the m() utility. */ export type ComponentTypes = Component | { new (vnode: CVnode): ClassComponent } | FactoryComponent /** This represents the attributes available for configuring virtual elements, beyond the applicable DOM attributes. */ diff --git a/types/mithril/mount.d.ts b/types/mithril/mount.d.ts index c177527f84..af79b918a9 100644 --- a/types/mithril/mount.d.ts +++ b/types/mithril/mount.d.ts @@ -1,3 +1,3 @@ -import { Mount } from "mithril"; -declare const mount: Mount; +import { mount as _mount } from "mithril"; +declare const mount: typeof _mount; export = mount; diff --git a/types/mithril/redraw.d.ts b/types/mithril/redraw.d.ts index 8206db5c0e..26c0a36b03 100644 --- a/types/mithril/redraw.d.ts +++ b/types/mithril/redraw.d.ts @@ -1,3 +1,11 @@ -import { Redraw } from "mithril"; -declare const redraw: Redraw; -export = redraw; +import { redraw, render } from "mithril"; + +declare namespace RedrawService { + export interface Static { + render: typeof render; + redraw: typeof redraw; + } +} + +declare const RedrawService: RedrawService.Static; +export = RedrawService; diff --git a/types/mithril/render.d.ts b/types/mithril/render.d.ts index 72651f42b4..d1144ced0d 100644 --- a/types/mithril/render.d.ts +++ b/types/mithril/render.d.ts @@ -1,3 +1,10 @@ -import { Render } from "mithril"; -declare const render: Render; -export = render; +import { render } from "mithril"; + +declare namespace RenderService { + export interface Static { + render: typeof render; + } +} + +declare const RenderService: RenderService.Static; +export = RenderService; diff --git a/types/mithril/request.d.ts b/types/mithril/request.d.ts index 0e737a04e9..d4483c76d2 100644 --- a/types/mithril/request.d.ts +++ b/types/mithril/request.d.ts @@ -1,3 +1,11 @@ -import { Request } from "mithril"; -declare const request: Request; -export = request; +import { request, jsonp } from "mithril"; + +declare namespace RequestService { + export interface Static { + request: typeof request; + jsonp: typeof jsonp; + } +} + +declare const RequestService: RequestService.Static; +export = RequestService; diff --git a/types/mithril/test/test-jsonp.ts b/types/mithril/test/test-jsonp.ts index 32f40ca4b6..856fe8236d 100644 --- a/types/mithril/test/test-jsonp.ts +++ b/types/mithril/test/test-jsonp.ts @@ -1,10 +1,10 @@ -import * as m from 'mithril' +import {jsonp} from 'mithril/request' interface Result { id: number } -m.jsonp('/item').then(data => { +jsonp('/item').then(data => { console.log(data.id) }) @@ -15,7 +15,7 @@ class User { } } -m.jsonp({ +jsonp({ url: '/user', data: {test: 'abc'}, type: User, diff --git a/types/mithril/test/test-misc.ts b/types/mithril/test/test-misc.ts index 75f1367de8..97ce9b5344 100644 --- a/types/mithril/test/test-misc.ts +++ b/types/mithril/test/test-misc.ts @@ -1,16 +1,23 @@ -import * as m from 'mithril' +import {trust, parseQueryString, buildQueryString} from 'mithril' +import * as h from 'mithril/hyperscript' +import {render} from 'mithril/render' +import {redraw} from 'mithril/redraw' +import * as withAttr from 'mithril/withAttr' -const vnode = m.trust('Some bold text.') +const vnode = trust('Some bold text.') -const params = m.parseQueryString('?id=123') +const params = parseQueryString('?id=123') -const qstr = m.buildQueryString({id: 123}) +const qstr = buildQueryString({id: 123}) -m.render(document.body, 'Hello') -m.render(document.body, m('h1', 'Test')) -m.render(document.body, [ - m('h1', 'Test'), "abc", null, 123, false, m('p', 'Vnode array'), - ['a', 123, undefined, m('div', 'Nested')] +render(document.body, 'Hello') +render(document.body, h('h1', 'Test')) +render(document.body, [ + h('h1', 'Test'), "abc", null, 123, false, h('p', 'Vnode array'), + ['a', 123, undefined, h('div', 'Nested')] ]) -m.redraw() +redraw() + +const handler = withAttr("value", (value) => {}) +handler({currentTarget: {value: 10}}) diff --git a/types/mithril/test/test-request.ts b/types/mithril/test/test-request.ts index 8ea24fe091..7042790427 100644 --- a/types/mithril/test/test-request.ts +++ b/types/mithril/test/test-request.ts @@ -1,4 +1,4 @@ -import * as request from 'mithril/request' +import {request} from 'mithril/request' interface Result { id: number diff --git a/types/mithril/withAttr.d.ts b/types/mithril/withAttr.d.ts index 14623971a6..7d1ea786ad 100644 --- a/types/mithril/withAttr.d.ts +++ b/types/mithril/withAttr.d.ts @@ -1,3 +1,3 @@ -import { WithAttr } from "mithril"; -declare const withAttr: WithAttr; +import { withAttr as _withAttr } from "mithril"; +declare const withAttr: typeof _withAttr; export = withAttr; From 06a42607f348ff009562f0816baf66f9e1e0869e Mon Sep 17 00:00:00 2001 From: Stefan Dobrev Date: Tue, 4 Apr 2017 10:15:39 +0300 Subject: [PATCH 148/844] [react-native] Add accessibilityLabel to Touchable Add `accessibilityLabel` property to Touchable. Fix description of the `accessible` property. --- types/react-native/index.d.ts | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/types/react-native/index.d.ts b/types/react-native/index.d.ts index 083c646be7..e3b85c77a9 100644 --- a/types/react-native/index.d.ts +++ b/types/react-native/index.d.ts @@ -3909,11 +3909,17 @@ export interface TouchableWithoutFeedbackIOSProperties { */ export interface TouchableWithoutFeedbackProperties extends TouchableWithoutFeedbackAndroidProperties, TouchableWithoutFeedbackIOSProperties { + /** + * Overrides the text that's read by the screen reader when the user interacts with the element. By default, the + * label is constructed by traversing all the children and accumulating all the Text nodes separated by space. + */ + accessibilityLabel?: string; /** - * Called when the touch is released, but not if cancelled (e.g. by a scroll that steals the responder lock). + * When true, indicates that the view is an accessibility element. + * By default, all the touchable elements are accessible. */ - accessible?: boolean + accessible?: boolean; /** * Delay in ms, from onPressIn, before onLongPress is called. From 30bd01b1ff5ec2b601fbf6b2f1248c019fd8ca58 Mon Sep 17 00:00:00 2001 From: Erik Krogh Kristensen Date: Tue, 4 Apr 2017 11:40:46 +0200 Subject: [PATCH 149/844] Leaflet: Marking the extension methods that every class should extend as non-optional. --- types/leaflet/index.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/types/leaflet/index.d.ts b/types/leaflet/index.d.ts index e6855ef870..a045b57966 100644 --- a/types/leaflet/index.d.ts +++ b/types/leaflet/index.d.ts @@ -424,8 +424,8 @@ declare namespace L { getTooltip(): Tooltip | undefined; // Extension methods - onAdd?(map: Map): this; - onRemove?(map: Map): this; + onAdd(map: Map): this; + onRemove(map: Map): this; getEvents?(): {[name: string]: (event: Event) => void}; getAttribution?(): string | null; beforeAdd?(map: Map): this; From 74939cd275c9d9845f5118e3936e2f890280bcd7 Mon Sep 17 00:00:00 2001 From: Alexander James Phillips Date: Tue, 4 Apr 2017 14:17:17 +0100 Subject: [PATCH 150/844] Update type of header object values --- types/boom/boom-tests.ts | 4 +++- types/boom/index.d.ts | 7 ++----- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/types/boom/boom-tests.ts b/types/boom/boom-tests.ts index b1e34eef55..382eb24bbd 100644 --- a/types/boom/boom-tests.ts +++ b/types/boom/boom-tests.ts @@ -1,7 +1,9 @@ import Boom = require('boom'); -Boom.wrap(new Error('test'), 400, 'some message'); +var bo = Boom.wrap(new Error('test'), 400, 'some message'); +var a: string = bo.output.headers['some header']; + Boom.create(500, 'Internal server error', { timestamp: Date.now() }); Boom.badRequest('message', {some: 'data'}); diff --git a/types/boom/index.d.ts b/types/boom/index.d.ts index 38edfd2d4b..863e2deafc 100644 --- a/types/boom/index.d.ts +++ b/types/boom/index.d.ts @@ -29,11 +29,8 @@ declare namespace Boom { export interface Output { /** statusCode - the HTTP status code (typically 4xx or 5xx). */ statusCode: number; - /** - * headers - an object containing any HTTP headers where each key is a header name and value is the header content. - * TODO can we limit value type any to string? - */ - headers: {[index: string]: any}; + /** headers - an object containing any HTTP headers where each key is a header name and value is the header content. (Limited value type to string https://github.com/hapijs/boom/issues/151 ) */ + headers: {[index: string]: string}; /** payload - the formatted object used as the response payload (stringified). Can be directly manipulated but any changes will be lost if reformat() is called. Any content allowed and by default includes the following content: */ payload: { /** statusCode - the HTTP status code, derived from error.output.statusCode. */ From 9ed0009123299b9236515e76e9aa3618a365f405 Mon Sep 17 00:00:00 2001 From: Alexander James Phillips Date: Tue, 4 Apr 2017 14:28:27 +0100 Subject: [PATCH 151/844] Correct union type for directory handler path function --- types/inert/index.d.ts | 3 +-- types/inert/inert-tests.ts | 10 +++++++++- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/types/inert/index.d.ts b/types/inert/index.d.ts index 949b3610af..cb9b8e8edb 100644 --- a/types/inert/index.d.ts +++ b/types/inert/index.d.ts @@ -42,9 +42,8 @@ declare module 'hapi' { * * a single path string used as the prefix for any resources requested by appending the request path parameter to the provided string. * * an array of path strings. Each path will be attempted in order until a match is found (by following the same process as the single path string). * * a function with the signature function(request) which returns the path string or an array of path strings. If the function returns an error, the error is passed back to the client in the response. - * TODO check what type of Error the "function returns an error" can be or is it raising an error which is caught? */ - path: string | string[] | IRequestHandler | IRequestHandler; + path: string | string[] | IRequestHandler; /** index - optional boolean|string|string[], determines if an index file will be served if found in the folder when requesting a directory. The given string or strings specify the name(s) of the index file to look for. If true, looks for 'index.html'. Any falsy value disables index file lookup. Defaults to true. */ index?: boolean | string | string[]; /** listing - optional boolean, determines if directory listing is generated when a directory is requested without an index document. Defaults to false. */ diff --git a/types/inert/inert-tests.ts b/types/inert/inert-tests.ts index 0741065d20..38830694cd 100644 --- a/types/inert/inert-tests.ts +++ b/types/inert/inert-tests.ts @@ -23,6 +23,14 @@ var fileHandler: HapiES6.IFileHandler = { } var directoryHandler: HapiES6.IDirectoryHandler = { - path: '', + path: function(){ + if(Math.random() > 0.5) { + return ''; + } + else if(Math.random() > 0) { + return ['']; + } + return new Error(''); + }, listing: true, } From 18be1bfdb36cad43d4fc9f848c2681be44936da1 Mon Sep 17 00:00:00 2001 From: Alexander James Phillips Date: Tue, 4 Apr 2017 14:50:00 +0100 Subject: [PATCH 152/844] Add tslint.json --- types/boom/tslint.json | 1 + 1 file changed, 1 insertion(+) create mode 100644 types/boom/tslint.json diff --git a/types/boom/tslint.json b/types/boom/tslint.json new file mode 100644 index 0000000000..377cc837d4 --- /dev/null +++ b/types/boom/tslint.json @@ -0,0 +1 @@ +{ "extends": "../tslint.json" } From 9a694ef256d5319e3ac8d0fa9f51aa7635677ede Mon Sep 17 00:00:00 2001 From: Oliver Joseph Ash Date: Tue, 4 Apr 2017 09:52:00 -0400 Subject: [PATCH 153/844] ramda: fix inference for mapping a functor --- types/ramda/index.d.ts | 2 +- types/ramda/ramda-tests.ts | 9 ++++++++- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/types/ramda/index.d.ts b/types/ramda/index.d.ts index aa84cad395..84d4edffce 100644 --- a/types/ramda/index.d.ts +++ b/types/ramda/index.d.ts @@ -15,7 +15,7 @@ declare namespace R { } interface Functor { - map(a: any): T; + map(fn: (t: T) => U): Functor; } interface ObjectIterator { diff --git a/types/ramda/ramda-tests.ts b/types/ramda/ramda-tests.ts index 13aeb222f7..fa0c55d156 100644 --- a/types/ramda/ramda-tests.ts +++ b/types/ramda/ramda-tests.ts @@ -668,7 +668,7 @@ interface Obj { a: number; b: number }; const stringFunctor = { map: (fn: (c: number) => number) => { var chars = "Ifmmp!Xpsme".split(""); - return chars.map((char) => String.fromCharCode(fn(char.charCodeAt(0)))).join(""); + return chars.map((char) => String.fromCharCode(fn(char.charCodeAt(0)))).join("") as any; } }; R.map((x: number) => x-1, stringFunctor); // => "Hello World" @@ -1985,3 +1985,10 @@ class Why { R.intersperse(0, [1, 2]); //=> [1, 0, 2] R.intersperse(0, [1]); //=> [1] } + +{ + const functor = { + map: (fn: (x: string) => string) => functor + } + R.map(x => x.trim(), functor) +} From e76b06fdbf7f215d8e3a551d0c3080c2b338c9b9 Mon Sep 17 00:00:00 2001 From: Alexander James Phillips Date: Tue, 4 Apr 2017 15:03:59 +0100 Subject: [PATCH 154/844] Temporarily remove tslint --- types/inert/tslint.json | 1 - 1 file changed, 1 deletion(-) delete mode 100644 types/inert/tslint.json diff --git a/types/inert/tslint.json b/types/inert/tslint.json deleted file mode 100644 index 377cc837d4..0000000000 --- a/types/inert/tslint.json +++ /dev/null @@ -1 +0,0 @@ -{ "extends": "../tslint.json" } From 2dc626ee561559176acfaa7a147b6c57a7d62642 Mon Sep 17 00:00:00 2001 From: Alexander James Phillips Date: Tue, 4 Apr 2017 15:05:40 +0100 Subject: [PATCH 155/844] Temporarily remove tslint --- types/boom/tslint.json | 1 - 1 file changed, 1 deletion(-) delete mode 100644 types/boom/tslint.json diff --git a/types/boom/tslint.json b/types/boom/tslint.json deleted file mode 100644 index 377cc837d4..0000000000 --- a/types/boom/tslint.json +++ /dev/null @@ -1 +0,0 @@ -{ "extends": "../tslint.json" } From a2881ed1c74e80a165516683027296b255d015e6 Mon Sep 17 00:00:00 2001 From: Huy Nguyen Date: Tue, 4 Apr 2017 10:16:14 -0400 Subject: [PATCH 156/844] Fix lint errors --- .../react-router-redux-tests.tsx | 30 +++++++++---------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/types/react-router-redux/react-router-redux-tests.tsx b/types/react-router-redux/react-router-redux-tests.tsx index cd2c42167d..b6927fb7bf 100644 --- a/types/react-router-redux/react-router-redux-tests.tsx +++ b/types/react-router-redux/react-router-redux-tests.tsx @@ -1,35 +1,35 @@ -import * as React from 'react' -import * as ReactDOM from 'react-dom' +import * as React from 'react'; +import * as ReactDOM from 'react-dom'; -import { createStore, combineReducers, applyMiddleware, Reducer } from 'redux' -import { Provider } from 'react-redux' +import { createStore, combineReducers, applyMiddleware, Reducer } from 'redux'; +import { Provider } from 'react-redux'; -import createHistory from 'history/createBrowserHistory' -import { Route } from 'react-router' +import createHistory from 'history/createBrowserHistory'; +import { Route } from 'react-router'; -import { ConnectedRouter, routerReducer, routerMiddleware, push, RouterState } from 'react-router-redux' +import { ConnectedRouter, routerReducer, routerMiddleware, push, RouterState } from 'react-router-redux'; // Create a history of your choosing (we're using a browser history in this case) -const history = createHistory() +const history = createHistory(); // Build the middleware for intercepting and dispatching navigation actions -const middleware = routerMiddleware(history) +const middleware = routerMiddleware(history); interface State { - router: RouterState + router: RouterState; } // For testing, assume the router reducer is the only sub-reducer: -const reducers: Reducer = combineReducers({router: routerReducer}) +const reducers: Reducer = combineReducers({router: routerReducer}); // Add the reducer to your store on the `router` key // Also apply our middleware for navigating const store = createStore( reducers, applyMiddleware(middleware) -) +); -const Home = () =>
    Home
    +const Home = () =>
    Home
    ; ReactDOM.render( { /* ConnectedRouter will use the store from Provider automatically */ } @@ -40,7 +40,7 @@ ReactDOM.render( , document.getElementById('root') -) +); // Now you can dispatch navigation actions from anywhere! -store.dispatch(push('/foo')) +store.dispatch(push('/foo')); From 2b391022e487d135afa40e6486d3f8f7824e662e Mon Sep 17 00:00:00 2001 From: Karol Janyst Date: Tue, 4 Apr 2017 23:51:20 +0900 Subject: [PATCH 157/844] =?UTF-8?q?Add=20missing=20types=20and=20interface?= =?UTF-8?q?s,=20improve=20definitions=20to=20match=206.6=20api=E2=80=A6=20?= =?UTF-8?q?(#15136)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Add missing types and interfaces, iprove definitions to match 6.5 api, remove unused definitions * Imporove types, add missing config options and actions * Change type for validate and warn * Add missing selectors, restore unnecessarily deleted actions * Add things that were added in 6.6.0 --- types/redux-form/index.d.ts | 22 +++--- types/redux-form/lib/Field.d.ts | 63 +++++++++++------- types/redux-form/lib/FieldArray.d.ts | 15 +++-- types/redux-form/lib/Fields.d.ts | 14 ++-- types/redux-form/lib/Form.d.ts | 22 ++++++ types/redux-form/lib/FormSection.d.ts | 4 +- types/redux-form/lib/actions.d.ts | 26 +++++--- types/redux-form/lib/reduxForm.d.ts | 96 +++++++++++++-------------- types/redux-form/lib/selectors.d.ts | 43 +++++++++++- types/redux-form/redux-form-tests.tsx | 21 +++--- 10 files changed, 213 insertions(+), 113 deletions(-) create mode 100644 types/redux-form/lib/Form.d.ts diff --git a/types/redux-form/index.d.ts b/types/redux-form/index.d.ts index f36162d684..a0e2a994a9 100644 --- a/types/redux-form/index.d.ts +++ b/types/redux-form/index.d.ts @@ -1,28 +1,29 @@ -// Type definitions for redux-form v6.3.3 +// Type definitions for redux-form 6.6 // Project: https://github.com/erikras/redux-form -// Definitions by: Carson Full +// Definitions by: Carson Full , Daniel Lytkin , Karol Janyst // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.1 -/// - import { ComponentClass, StatelessComponent, -} from 'react'; + ReactElement +} from "react"; export type FieldValue = any; -export type FieldType = 'Field' | 'FieldArray'; +export type FieldType = "Field" | "FieldArray"; -export type DataShape = {[fieldName:string]: FieldValue}; +export interface DataShape { + [fieldName: string]: FieldValue +} export type FormErrors = { - [P in keyof FormData]?: React.ReactElement | string; + [P in keyof FormData]?: ReactElement | string; } & { _error?: string }; export type FormWarnings = { - [P in keyof FormData]?: React.ReactElement | string; + [P in keyof FormData]?: ReactElement | string; } & { _warning?: string }; /** @@ -31,12 +32,13 @@ export type FormWarnings = { * not resolve due to a bug in TypeScript. * https://github.com/Microsoft/TypeScript/pull/8674 */ -export type ComponentConstructor = ComponentClass | StatelessComponent; +export type ComponentConstructor

    = ComponentClass

    | StatelessComponent

    ; export * from "./lib/reduxForm"; export * from "./lib/Field"; export * from "./lib/Fields"; export * from "./lib/FieldArray"; +export * from "./lib/Form"; export * from "./lib/FormSection"; export * from "./lib/actions"; export * from "./lib/reducer"; diff --git a/types/redux-form/lib/Field.d.ts b/types/redux-form/lib/Field.d.ts index b5aa10dd8e..8c75977f6c 100644 --- a/types/redux-form/lib/Field.d.ts +++ b/types/redux-form/lib/Field.d.ts @@ -1,9 +1,9 @@ import { Component, ReactElement, - DragEventHandler, - FocusEventHandler, - FormEventHandler, + ChangeEvent, + DragEvent, + FocusEvent } from "react"; import { Dispatch } from "redux"; import { ComponentConstructor, DataShape, FieldValue } from "../index"; @@ -28,15 +28,7 @@ interface BaseFieldProps { * * Required but made optional so interface can be used on decorated components. */ - component?: ComponentConstructor | "input" | "select" | "textarea", - // component?: ComponentClass

    | SFC

    | "input" | "select" | "textarea", - - /** - * If true, the rendered component will be available with the - * getRenderedComponent() method. Defaults to false. Cannot be used if your - * component is a stateless function component. - */ - withRef?: boolean; + component?: ComponentConstructor | "input" | "select" | "textarea", /** * Formats the value from the Redux store to be displayed in the field input. @@ -57,7 +49,7 @@ interface BaseFieldProps { /** * Don't use. */ - props?: Object; + props?: any; /** * Parses the value given from the field input component to the type that you want @@ -72,7 +64,7 @@ interface BaseFieldProps { * should return `undefined`, if the field is invalid, it should return an error * (usually, but not necessarily, a `String`). */ - validate?: Validator|Validator[]; + validate?: Validator | Validator[]; /** * Allows you to to provide a field-level warning rule. The function will be given the @@ -80,7 +72,14 @@ interface BaseFieldProps { * it should return the warning (usually, but not necessarily, a `String`). If the field * does not need a warning, it should return `undefined`. */ - warn?: Validator|Validator[]; + warn?: Validator | Validator[]; + + /** + * If true, the rendered component will be available with the + * getRenderedComponent() method. Defaults to false. Cannot be used if your + * component is a stateless function component. + */ + withRef?: boolean; } /** @@ -91,13 +90,13 @@ interface BaseFieldProps { * @param previousAllValues All the values in the entire form before the current change. * This will be an Immutable Map if you are using Immutable JS. */ -export type Normalizer = (value: FieldValue, previousValue?: FieldValue, allValues?: Object, previousAllValues?: Object) => FieldValue; +export type Normalizer = (value: FieldValue, previousValue?: FieldValue, allValues?: any, previousAllValues?: any) => FieldValue; export type Formatter = (value: FieldValue, name: string) => FieldValue; export type Parser = (value: FieldValue, name: string) => FieldValue; -export type Validator = (value: FieldValue, allValues?: Object) => undefined | string; +export type Validator = (value: FieldValue, allValues?: any, props?: any) => any; /** * Declare Field as this interface to specify the generic. @@ -175,7 +174,7 @@ interface WrappedFieldProps { * An object containing all the props that you will normally want to pass to * your input component. */ - input: WrappedFieldInputProps; + input?: WrappedFieldInputProps; /** * An object containing all the metadata props. @@ -186,6 +185,8 @@ interface WrappedFieldProps { /** * These props are meant to be destructured into your component. */ +type EventOrValueHandler = (eventOrValue: Event | FieldValue, newValue: FieldValue, previousValue: FieldValue) => void; + interface WrappedFieldInputProps { /** * An alias for value only when value is a boolean. Provided for @@ -202,29 +203,29 @@ interface WrappedFieldInputProps { /** * A function to call when the form field loses focus. */ - onBlur: FocusEventHandler; + onBlur: EventOrValueHandler>; /** * A function to call when the form field is changed. */ - onChange: FormEventHandler; + onChange: EventOrValueHandler>; /** * A function to call when the form field receives a 'dragStart' event. * Saves the field value in the event for giving the field it is dropped * into. */ - onDragStart: DragEventHandler; + onDragStart: EventOrValueHandler>; /** * A function to call when the form field receives a drop event. */ - onDrop: DragEventHandler; + onDrop: EventOrValueHandler>; /** * A function to call when the form field receives focus. */ - onFocus: FocusEventHandler; + onFocus: EventOrValueHandler>; /** * The value of this form field. It will be a boolean for checkboxes, and @@ -276,6 +277,11 @@ interface WrappedFieldMetaProps { */ error?: string; + /** + * The name of the form. Could be useful if you want to manually dispatch actions. + */ + form?: string; + /** * true if the field value fails validation (has a validation error). * Opposite of valid. @@ -288,6 +294,17 @@ interface WrappedFieldMetaProps { */ pristine: boolean; + /** + * true if the field is currently being submitted + */ + submitting?: boolean; + + /** + * true if the form had onSubmit called and failed to submit for any reason. + * A subsequent successful submit will set it back to false. + */ + submitFailed?: boolean; + /** * true if the field has been touched. By default this will be set when * the field is blurred. diff --git a/types/redux-form/lib/FieldArray.d.ts b/types/redux-form/lib/FieldArray.d.ts index c17f5da39d..a2f2f827cd 100644 --- a/types/redux-form/lib/FieldArray.d.ts +++ b/types/redux-form/lib/FieldArray.d.ts @@ -20,8 +20,7 @@ interface BaseFieldArrayProps { * * Required but made optional so interface can be used on decorated components. */ - component?: ComponentConstructor, - // component?: Component | StatelessComponent

    , + component?: ComponentConstructor, /** * Allows you to to provide a field-level validation rule. The function will be given the @@ -29,7 +28,7 @@ interface BaseFieldArrayProps { * should return `undefined`, if the field is invalid, it should return an error * (usually, but not necessarily, a `String`). */ - validate?: Validator|Validator[]; + validate?: Validator | Validator[]; /** * Allows you to to provide a field-level warning rule. The function will be given the @@ -37,7 +36,7 @@ interface BaseFieldArrayProps { * it should return the warning (usually, but not necessarily, a `String`). If the field * does not need a warning, it should return `undefined`. */ - warn?: Validator|Validator[]; + warn?: Validator | Validator[]; /** * If true, the rendered component will be available with the @@ -46,7 +45,7 @@ interface BaseFieldArrayProps { */ withRef?: boolean; - props?: Object; + props?: any; } /** @@ -100,7 +99,6 @@ export class FieldArray extends Component implements GenericFieldArray< */ interface WrappedFieldArrayProps { fields: FieldsProps; - meta: FieldArrayMetaProps; } @@ -182,6 +180,11 @@ interface FieldArrayMetaProps { */ error?: string; + /** + * Name of your form provided to `reduxForm()` as the `form` config property. + */ + form: string; + /** * true if the field array value fails validation (has a validation error). * Opposite of valid. diff --git a/types/redux-form/lib/Fields.d.ts b/types/redux-form/lib/Fields.d.ts index 4507f26470..d6548aeb6f 100644 --- a/types/redux-form/lib/Fields.d.ts +++ b/types/redux-form/lib/Fields.d.ts @@ -1,5 +1,5 @@ import { Component } from "react"; -import { ComponentConstructor, Formatter, Parser, FieldValue } from "../index"; +import { ComponentConstructor, Formatter, Parser, FieldValue, WrappedFieldProps } from "../index"; /** * These are the props to give to `Field`. @@ -18,7 +18,7 @@ interface BaseFieldsProps { * A Component or stateless function that will be given all the props necessary * to render the field inputs. */ - component?: ComponentConstructor | 'input' | 'select' | 'textarea'; + component?: ComponentConstructor; /** * Formats the value from the Redux store to be displayed in the field input. @@ -35,7 +35,7 @@ interface BaseFieldsProps { /** * Don't use. */ - props?: Object; + props?: any; /** * Parses the value given from the field input component to the type that you want stored in the Redux store. @@ -77,7 +77,7 @@ export interface GenericFields extends Component; } @@ -106,7 +106,11 @@ export class Fields extends Component implements GenericFields; } + +interface WrappedFieldsProps { + [name: string]: WrappedFieldsProps & WrappedFieldProps +} diff --git a/types/redux-form/lib/Form.d.ts b/types/redux-form/lib/Form.d.ts new file mode 100644 index 0000000000..062be3e1bf --- /dev/null +++ b/types/redux-form/lib/Form.d.ts @@ -0,0 +1,22 @@ +import { Component, HTMLProps, FormEvent } from "react"; +import { Dispatch } from "redux"; +import { SubmitHandler, FormProps, FormErrors } from "../index" + +interface FormSubmitHandler { + (values: any, dispatch?: Dispatch, props?: FormProps & { [prop: string]: any }): void | FormErrors | Promise; + //(e: FormEvent): void; +} + +export interface FormComponentProps extends HTMLProps { + /** + * The function to call when form submission is triggered. + */ + onSubmit: FormSubmitHandler; +} + +/** + * The Form component is a simple wrapper for the React component that + * allows the surrounding redux-form-decorated component to trigger its + * onSubmit function. + */ +export class Form extends Component {} diff --git a/types/redux-form/lib/FormSection.d.ts b/types/redux-form/lib/FormSection.d.ts index 514006ce52..9ed6c0c9b7 100644 --- a/types/redux-form/lib/FormSection.d.ts +++ b/types/redux-form/lib/FormSection.d.ts @@ -12,6 +12,4 @@ interface FormSectionProps { * multiple forms. It does this by prefixing the name of Field, Fields and FieldArray children, at any depth, * with the value specified in the name prop. */ -export class FormSection extends Component { - -} +export class FormSection extends Component {} diff --git a/types/redux-form/lib/actions.d.ts b/types/redux-form/lib/actions.d.ts index a3f0fa0b74..c96d5ffbb7 100644 --- a/types/redux-form/lib/actions.d.ts +++ b/types/redux-form/lib/actions.d.ts @@ -70,7 +70,7 @@ export function change(form: string, field: string, value: any): Action; /** * Destroys the form, removing all it's state */ -export function destroy(form: string): Action; +export function destroy(...form: string[]): Action; /** * Marks the given field as active and visited @@ -83,7 +83,12 @@ export function focus(form: string, field: string): Action; * If the keepDirty parameter is true, the values of the currently dirty fields will be retained to avoid overwriting * user edits. */ -export function initialize(form: string, data: Object, keepDirty: boolean): Action; +interface InitializeOptions { + keepDirty : boolean; + keepSubmitSucceeded: boolean; +} + +export function initialize(form: string, data: any, keepDirty?: boolean | InitializeOptions, options?: InitializeOptions): Action; /** * Registers a field with the form. @@ -100,6 +105,15 @@ export function reset(form: string): Action; */ export function startAsyncValidation(form: string): Action; +/** + * Flips the asyncValidating flag false and populates asyncError for each field. + */ +export function stopAsyncValidation(form: string, errors?: any): Action; + +export function setSubmitFailed(form: string, ...fields: string[]): Action; + +export function setSubmitSucceeded(form: string, ...fields: string[]): Action; + /** * Flips the submitting flag true. */ @@ -108,16 +122,12 @@ export function startSubmit(form: string): Action; /** * Flips the submitting flag false and populates submitError for each field. */ -export function stopSubmit(form: string, errors?: Object): Action; +export function stopSubmit(form: string, errors?: any): Action; /** * Flips the asyncValidating flag false and populates asyncError for each field. */ -export function stopAsyncValidation(form: string, errors?: Object): Action; - -export function setSubmitFailed(form: string, ...fields: string[]): Action; - -export function setSubmitSucceeded(form: string, ...fields: string[]): Action; +export function stopAsyncValidation(form: string, errors?: any): Action; /** * Triggers a submission of the specified form. diff --git a/types/redux-form/lib/reduxForm.d.ts b/types/redux-form/lib/reduxForm.d.ts index 100a708032..e4429015e1 100644 --- a/types/redux-form/lib/reduxForm.d.ts +++ b/types/redux-form/lib/reduxForm.d.ts @@ -1,12 +1,13 @@ import { Component, - StatelessComponent, + ComponentClass, ReactElement, SyntheticEvent, ReactEventHandler, + StatelessComponent } from "react"; import { Dispatch } from "redux"; -import { DataShape, FieldValue, FormErrors, FormWarnings, RegisteredFieldState } from "../index"; +import { DataShape, FieldValue, FormErrors, FormWarnings, RegisteredFieldState, ComponentConstructor } from "../index"; export function reduxForm( config: Config @@ -20,9 +21,12 @@ export function reduxForm( config: Config ): FormDecorator; +/** + * This is not entirely correct but Typescript expect input and output for decorators to be the same type. + * Because of that, React HoCs can't be fully defined. https://www.typescriptlang.org/docs/handbook/decorators.html + */ export interface FormDecorator { - )>(component: T): - T & Form; + >>(component: T): T; } export interface Config { @@ -30,16 +34,7 @@ export interface Config { * the name of your form and the key to where your form's state will be * mounted under the redux-form reducer */ - form?: string; - - /** - * An adapter function that will render a component based on a string component - * type and the props given to a Field. Remember that all you really need to hook - * up to your custom component's value and onChange. Defaults to []. - * - * See Asynchronous Blur Validation Example for more details. - */ - adapter?: (component: string, props: Object) => ReactElement; + form: string; /** * field names for which onBlur should trigger a call to the asyncValidate @@ -50,10 +45,10 @@ export interface Config { asyncBlurFields?: string[]; /** - * a function that takes all the form values, the dispatch function, - * the props given to your component and the current blurred field, - * and returns a Promise that will resolve if the validation is passed, - * or will reject with an object of validation errors in the form { field1: , field2: }. + * a function that takes all the form values, the dispatch function, and + * the props given to your component, and returns a Promise that will + * resolve if the validation is passed, or will reject with an object of + * validation errors in the form { field1: , field2: }. * * See Asynchronous Blur Validation Example for more details. */ @@ -65,9 +60,17 @@ export interface Config { */ destroyOnUnmount?: boolean; + /** + * Reinitialize the form every time the initialValues prop changes. + * Defaults to false. + */ + enableReinitialize?: boolean; + /** * Whether or not to force unregistration of fields -- use in conjunction - * with destroyOnUnmount. + * with destroyOnUnmount. Useful for wizard-type forms where you want to destroy + * fields as they unmount, but not the form's state. Defaults to false, as forms + * are normally unregistered on unmount. */ forceUnregisterOnUnmount?: boolean; @@ -87,28 +90,19 @@ export interface Config { */ keepDirtyOnReinitialize?: boolean; - /** - * If true, implements `shouldComponentUpdate` and shallowly compares _only_ - * the Redux-connected props that are needed to manage the form state. This - * prevents unnecessary updates, but assumes the component is a "pure" - * component and does not rely on any input or state other than its props and - * the selected Redux store's state. Defaults to true. - */ - pure?: boolean; - /** * The values with which to initialize your form in componentWillMount(). * Particularly useful when Editing Multiple Records, but can also be used * with single-record forms. The values should be in the form * { field1: 'value1', field2: 'value2' }. */ - initialValues?: FormData; + initialValues?: Partial; /** - * Reinitialize the form every time the initialValues prop changes. - * Defaults to false. + * A callback function that will be called with all the form values any time + * any of the form values change. */ - enableReinitialize?: boolean; + onChange?: (values: any) => void; /** * The function to call with the form data when the handleSubmit() is fired @@ -133,11 +127,6 @@ export interface Config { */ onSubmitSuccess?(result: any, dispatch: Dispatch): void; - /** - * Do not remove submit errors when the change action is fired. Defaults to false. - */ - persistentSubmitErrors?: boolean; - /** * If specified, all the props normally passed into your decorated * component directly will be passed under the key specified. Useful if @@ -147,14 +136,13 @@ export interface Config { propNamespace?: string; /** - * The use of this property is highly discouraged, but if you absolutely - * need to mount your redux-form reducer at somewhere other than form in - * your Redux state, you will need to specify the key you mounted it under - * with this property. Defaults to 'form'. - * - * See Alternate Mount Point Example for more details. + * If true, implements `shouldComponentUpdate` and shallowly compares _only_ + * the Redux-connected props that are needed to manage the form state. This + * prevents unnecessary updates, but assumes the component is a "pure" + * component and does not rely on any input or state other than its props and + * the selected Redux store's state. Defaults to true. */ - reduxMountPoint?: string; + pure?: boolean; /** * An optional function you may provide to have full control over when sync validation happens. @@ -178,6 +166,11 @@ export interface Config { */ touchOnChange?: boolean; + /** + * Do not remove submit errors when the change action is fired. Defaults to false. + */ + persistentSubmitErrors?: boolean; + /** * a synchronous validation function that takes the form values and props * passed into your component. If validation passes, it should return {}. @@ -218,12 +211,12 @@ interface ValidateCallback { /** * The next props. */ - nextProps: Object; + nextProps: any; /** * The current props. */ - props: Object; + props: any; /** * true if the form is being initially rendered. @@ -233,7 +226,7 @@ interface ValidateCallback { /** * The structure object being used internally for values. You may wish to use 'deepEqual' from the structure. */ - structure: Object; + structure: any; } interface AsyncValidateCallback { @@ -252,7 +245,7 @@ interface AsyncValidateCallback { * 'submit', depending on whether an async blur field had triggered the async * validation or if submitting the form has triggered it, respectively. */ - trigger: 'blur' | 'submit'; + trigger: "blur" | "submit"; /** * The name of the field that has triggered the async validation. May be undefined. @@ -285,7 +278,7 @@ export class SubmissionError extends Error { * The following are methods or properties that you can access on an instance * of your decorated form component (outermost component named "ReduxForm"). */ -export interface Form extends Component { +export interface FormComponent extends ComponentClass

    { /** * true if the form data has changed from its initialized values. Opposite * of pristine. @@ -497,6 +490,11 @@ export interface FormProps { */ initialize?(data: FormData): void; + /** + * The same initialValues object passed to reduxForm to initialize the form data. + */ + initialValues?: Partial; + /** * true if the form has validation errors. Opposite of valid. */ diff --git a/types/redux-form/lib/selectors.d.ts b/types/redux-form/lib/selectors.d.ts index bbefd82994..86565a5715 100644 --- a/types/redux-form/lib/selectors.d.ts +++ b/types/redux-form/lib/selectors.d.ts @@ -7,7 +7,7 @@ import { DataShape, FormErrors } from "../index"; export function formValueSelector(form: string, getFormState?: () => State): Selector; export interface Selector { - (state: State, ...field: string[]): Object + (state: State, ...field: string[]): any; } /** @@ -39,16 +39,42 @@ export interface BooleanSelector { */ export const getFormValues: DataSelector; +/** + * Gets the form's initial values. + */ +export const getFormInitialValues: DataSelector; + /** * Returns the form synchronous validation errors. */ export const getFormSyncErrors: ErrorSelector; +/** + * Returns the form asynchronous validation errors. + */ +export const getFormAsyncErrors: ErrorSelector; + +/** + * Returns the form synchronous warnings. + */ +export const getFormSyncWarnings: ErrorSelector; + /** * Returns the form submit validation errors. */ export const getFormSubmitErrors: ErrorSelector; +/** + * Gets the names of all the forms currently managed by Redux-Form. + * + * The reason that this is a function that returns a function is twofold: + * 1. symmetry with the other selectors + * 2. to allow for the getFormState parameter described at the top of this page. + * + * If you are using ImmutableJS, it will return a List. + */ +export const getFormNames: (state: State) => string[]; + /** * Returns true if the form is dirty, i.e. the values have been altered * from the original initialValues provided. The opposite of isPristine. @@ -72,3 +98,18 @@ export const isValid: BooleanSelector; * errors. The opposite of isValid. */ export const isInvalid: BooleanSelector; + +/** + * Returns true if the form is submitting. + */ +export const isSubmitting: BooleanSelector; + +/** + * Returns true if the form has previously been successfully submitted. + */ +export const hasSubmitSucceeded: BooleanSelector; + +/** + * Returns true if the form has previously fail to submit. + */ +export const hasSubmitFailed: BooleanSelector; diff --git a/types/redux-form/redux-form-tests.tsx b/types/redux-form/redux-form-tests.tsx index 396ca8df85..798327f60c 100644 --- a/types/redux-form/redux-form-tests.tsx +++ b/types/redux-form/redux-form-tests.tsx @@ -1,6 +1,6 @@ import * as React from 'react'; import { Component } from 'react'; -import { Field, GenericField, reduxForm, WrappedFieldProps, BaseFieldProps } from "redux-form"; +import { Field, GenericField, reduxForm, WrappedFieldProps, BaseFieldProps, FormProps } from "redux-form"; interface CustomComponentProps { customProp: string; @@ -8,11 +8,17 @@ interface CustomComponentProps { class CustomComponent extends Component & CustomComponentProps, {}> { render() { + const { + input, + meta : { touched }, + customProp + } = this.props + return (

    - {this.props.customProp} -

    Field: {this.props.meta.touched ? 'touched' : 'pristine'}

    - + {customProp} +

    Field: {touched ? 'touched' : 'pristine'}

    +
    ); } @@ -33,7 +39,7 @@ interface FormData { @reduxForm({ form: 'myForm' }) -class MyForm extends Component<{}, {}> { +class MyForm extends Component { render() { return (
    @@ -51,14 +57,13 @@ class MyForm extends Component<{}, {}> { } } -const MyStatelessFunctionalComponent: React.SFC = () =>
    ; +const MyStatelessFunctionalComponent: React.SFC = () =>
    ; reduxForm({ form: 'mySFCForm' })(MyStatelessFunctionalComponent); -@reduxForm({}) -class MyDynamicForm extends Component { +class MyReusableForm extends Component { render() { return (
    From 51ac7b7575bd046ea8fef9c19fcd0fec7f3ea718 Mon Sep 17 00:00:00 2001 From: Andy Hanson Date: Tue, 4 Apr 2017 07:58:49 -0700 Subject: [PATCH 158/844] xml-js: Provides its own types --- notNeededPackages.json | 6 +++ types/xml-js/index.d.ts | 82 ------------------------------------ types/xml-js/tsconfig.json | 22 ---------- types/xml-js/xml-js-tests.ts | 48 --------------------- 4 files changed, 6 insertions(+), 152 deletions(-) delete mode 100644 types/xml-js/index.d.ts delete mode 100644 types/xml-js/tsconfig.json delete mode 100644 types/xml-js/xml-js-tests.ts diff --git a/notNeededPackages.json b/notNeededPackages.json index 274f8f829b..5379649358 100644 --- a/notNeededPackages.json +++ b/notNeededPackages.json @@ -384,6 +384,12 @@ "sourceRepoURL": "https://code.google.com/p/x2js/", "asOfVersion": "3.1.0" }, + { + "libraryName": "xml-js", + "typingsPackageName": "xml-js", + "sourceRepoURL": "https://github.com/nashwaan/xml-js", + "asOfVersion": "1.0.0" + }, { "libraryName": "@xmpp/jid", "typingsPackageName": "xmpp-jid", diff --git a/types/xml-js/index.d.ts b/types/xml-js/index.d.ts deleted file mode 100644 index eb89067c86..0000000000 --- a/types/xml-js/index.d.ts +++ /dev/null @@ -1,82 +0,0 @@ -// Type definitions for xml-js 0.9.6 -// Project: https://github.com/nashwaan/xml-js -// Definitions by: Denis Carriere -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -export interface ElementCompact { - [key: string]: any - _attributes?: { - [key: string]: number | number - } - _cdata?: string | number - _comment?: string | number - _declaration?: { - _attributes?: { - version?: string | number - encoding?: string | number - } - } - _text?: string | number -} - -export interface Element { - attributes?: { - [key: string]: string | number - } - cdata?: string | number - comment?: string | number - declaration?: { - attributes?: { - version: string | number - encoding: string | number - } - } - elements?: Array - text?: string | number - type?: string | number - name?: string | number -} - -declare namespace Options { - interface XML2JS extends ChangingKeyNames, IgnoreOptions { - compact?: boolean - spaces?: number | string - trim?: boolean - sanitize?: boolean - nativeType?: boolean - addParent?: boolean - alwaysChildren?: boolean - } - - interface JS2XML extends ChangingKeyNames, IgnoreOptions { - spaces?: number | string - compact?: boolean - fullTagEmptyElement?: boolean - } - - interface IgnoreOptions { - ignoreDeclaration?: boolean - ignoreAttributes?: boolean - ignoreComment?: boolean - ignoreCdata?: boolean - ignoreText?: boolean - } - - interface ChangingKeyNames { - declarationKey?: string - attributesKey?: string - textKey?: string - cdataKey?: string - commentKey?: string - parentKey?: string - typeKey?: string - nameKey?: string - elementsKey?: string - } -} - -export function js2xml(json: Element | ElementCompact, options?: Options.JS2XML): string; -export function json2xml(json: Element | ElementCompact, options?: Options.JS2XML): string; -export function xml2json(xml: string, options?: Options.XML2JS): any; -export function xml2js(xml: string, options?: Options.XML2JS): any; - diff --git a/types/xml-js/tsconfig.json b/types/xml-js/tsconfig.json deleted file mode 100644 index 09b2ed9cff..0000000000 --- a/types/xml-js/tsconfig.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "compilerOptions": { - "module": "commonjs", - "lib": [ - "es6" - ], - "noImplicitAny": true, - "noImplicitThis": true, - "strictNullChecks": true, - "baseUrl": "../", - "typeRoots": [ - "../" - ], - "types": [], - "noEmit": true, - "forceConsistentCasingInFileNames": true - }, - "files": [ - "index.d.ts", - "xml-js-tests.ts" - ] -} \ No newline at end of file diff --git a/types/xml-js/xml-js-tests.ts b/types/xml-js/xml-js-tests.ts deleted file mode 100644 index d437ee14f4..0000000000 --- a/types/xml-js/xml-js-tests.ts +++ /dev/null @@ -1,48 +0,0 @@ -import { Element, ElementCompact } from 'xml-js' -import * as convert from 'xml-js' - -// Declaration -const declarationCompact1: ElementCompact = { _declaration: { _attributes: { version: 2 } }}; -const declarationCompact2: ElementCompact = { _declaration: { _attributes: { version: '1.0', encoding: 'utf-8' }}}; -const declaration1: Element = { declaration: { }}; -const declaration2: Element = { declaration: { attributes: { version: '1.0', encoding: 'utf-8' }}}; - -// Comment -const commentCompact: ElementCompact = { _comment : 'Hello, World!' }; -const comment: Element = { elements: [{ type: 'comment', comment: 'Hello, World!' }]}; - -// CDATA -const cdataCompact: ElementCompact = { _cdata: '' }; -const cdata: Element = { elements : [{ type: 'cdata', cdata: '' }]}; - -// Element -const elementCompact1: ElementCompact = { a: {} }; -const element1: Element = { elements:[{ type: 'element', name: 'a' }]}; - -const elementCompact2: ElementCompact = { a: { _attributes: { x: '1.234', y:'It\'s' }}}; -const element2: Element = { elements: [{ type: 'element', name: 'a', attributes: { x: '1.234', y: 'It\'s' }}]}; - -const elementCompact3: ElementCompact = { a: { _text: ' Hi ' }}; -const element3: Element = { elements:[{ type: 'element', name: 'a', elements: [{ type: 'text', text: ' Hi ' }]}]}; - -const elementCompact4: ElementCompact = { a: {}, b: {} }; -const element4: Element = { elements:[{ type: 'element', name: 'a' }, { type: 'element', name: 'b' }]}; - -const elementCompact5: ElementCompact = { a: { b: {} }}; -const element5: Element = { elements: [{ type: 'element', name: 'a', elements: [{ type: 'element', name: 'b' }]}]}; - -// xml2json -const xml = ` - - - Happy - Work - Play -`; -convert.xml2json(xml, { compact: true, spaces: 4 }); -convert.xml2json(xml, { compact: false }); - -// json2xml -convert.json2xml({ a: {} }, { compact: true, spaces: 4 }); -convert.json2xml({ elements:[{ type: 'element', name: 'a' }]}, { compact: false }); - From 0d28bd1b5f11ae810349e1d4523b5d8dbb666312 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?P=C3=A9ter=20Kov=C3=A1cs?= Date: Tue, 4 Apr 2017 17:09:17 +0200 Subject: [PATCH 159/844] [karma] Add concurrency property to config options. --- types/karma/index.d.ts | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/types/karma/index.d.ts b/types/karma/index.d.ts index 8cae4a0fa4..7755011ca6 100644 --- a/types/karma/index.d.ts +++ b/types/karma/index.d.ts @@ -205,6 +205,14 @@ declare namespace karma { * @description Enable or disable colors in the output (reporters and logs). */ colors?: boolean; + /** + * @default 'Infinity' + * @description How many browsers Karma launches in parallel. + * Especially on services like SauceLabs and Browserstack, it makes sense only to launch a limited + * amount of browsers at once, and only start more when those have finished. Using this configuration, + * you can specify how many browsers should be running at once at any given point in time. + */ + concurrency?: number; /** * @default [] * @description List of files/patterns to exclude from loaded files. From b866b863bbaf6c4d5e9575cf553f2854126e74ea Mon Sep 17 00:00:00 2001 From: Andy Hanson Date: Thu, 15 Dec 2016 12:55:19 -0800 Subject: [PATCH 160/844] tsmonad: Provides its own types --- notNeededPackages.json | 6 + types/tsmonad/index.d.ts | 697 ----------------------------- types/tsmonad/test/either-tests.ts | 45 -- types/tsmonad/test/maybe-tests.ts | 20 - types/tsmonad/test/writer-tests.ts | 8 - types/tsmonad/tsconfig.json | 25 -- 6 files changed, 6 insertions(+), 795 deletions(-) delete mode 100644 types/tsmonad/index.d.ts delete mode 100644 types/tsmonad/test/either-tests.ts delete mode 100644 types/tsmonad/test/maybe-tests.ts delete mode 100644 types/tsmonad/test/writer-tests.ts delete mode 100644 types/tsmonad/tsconfig.json diff --git a/notNeededPackages.json b/notNeededPackages.json index 274f8f829b..0c098f8fc0 100644 --- a/notNeededPackages.json +++ b/notNeededPackages.json @@ -342,6 +342,12 @@ "sourceRepoURL": "https://github.com/blakeembrey/title-case", "asOfVersion": "1.1.2" }, + { + "libraryName": "TsMonad", + "typingsPackageName": "tsmonad", + "sourceRepoURL": "https://github.com/cbowdon/TsMonad", + "asOfVersion": "0.5.0" + }, { "libraryName": "TypeScript", "typingsPackageName": "typescript", diff --git a/types/tsmonad/index.d.ts b/types/tsmonad/index.d.ts deleted file mode 100644 index c70953b483..0000000000 --- a/types/tsmonad/index.d.ts +++ /dev/null @@ -1,697 +0,0 @@ -// Type definitions for TsMonad -// Project: https://github.com/cbowdon/TsMonad -// Definitions by: Chris Bowdon -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -declare namespace TsMonad { - /** - * @name EitherType - * @description Enumerate the different types contained by an Either object. - */ - enum EitherType { - Left = 0, - Right = 1, - } - /** - * @name EitherPatterns - * @description Define a contract to unwrap Either object using callbacks - * for Left and Right. - * @see Either# - */ - interface EitherPatterns { - /** - * @name left - * @description Function to handle the Left. - * @type {(l: L) => T} - */ - left: (l: L) => T; - /** - * @name right - * @description Function to handle the Right. - * @type {(r: R) => T} - */ - right: (r: R) => T; - } - /** - * @name either - * @description Build an Either object. - * @function - * @param l The object as a Left (optional). - * @param r The object as a Right (optional). - * @returns {Either} Either object containing the input. - * @throws {TypeError} If there are both or none of left and right - * parameter. - * @see Either# - */ - function either(l?: L, r?: R): Either; - /** - * @name Either - * @class Either has exactly two sub types, Left (L) and Right (R). If an - * Either object contains an instance of L, then the Either is a - * Left. Otherwise it contains an instance of R and is a Right. By - * convention, the Left constructor is used to hold an error value and - * the Right constructor is used to hold a correct value. - */ - class Either implements Monad, Functor, Eq> { - private type; - private l; - private r; - /** - * @description Build an Either object. For internal use only. - * @constructor - * @methodOf Either# - * @param {EitherType} type Indicates if the Either content is a Left or a Right. - * @param {L} l The Left value (optional). - * @param {R} l The Right value (optional). - */ - constructor(type: EitherType, l?: L, r?: R); - /** - * @name left - * @description Helper function to build an Either with a Left. - * @methodOf Either# - * @static - * @param {L} l The Left value. - * @returns {Either} Either object containing a Left. - */ - static left(l: L): Either; - /** - * @name right - * @description Helper function to build an Either with a Right. - * @methodOf Either# - * @static - * @param {R} r The Right value. - * @returns {Either} Either object containing a Right. - */ - static right(r: R): Either; - /** - * @name unit - * @description Wrap a value inside an Either Right object. - * @methodOf Either# - * @public - * @param {T} t - * @returns {Either} Either object containing a Right. - * @see Monad#unit - */ - public unit(t: T): Either; - /** - * @name bind - * @description Apply the function passed as parameter on the object. - * @methodOf Either# - * @public - * @param {(r: R) => Either} f Function applied on the Right. - * @returns {Either} The result of the function f wrapped inside - * an Either object. - * @see Monad#bind - */ - public bind(f: (r: R) => Either): Either; - /** - * @name of - * @description Alias for unit. - * @methodOf Either# - * @public - * @see Either#unit - * @see Monad#of - */ - public of: (t: T) => Either; - /** - * @name chain - * @description Alias for bind. - * @methodOf Either# - * @public - * @see Either#bind - * @see Monad#chain - */ - public chain: (f: (r: R) => Either) => Either; - /** - * @name fmap - * @description Apply the function passed as parameter on the object. - * @methodOf Either# - * @public - * @param {(r: R) => T} f Function applied on the Right. - * @returns {Either} The result of the function f wrapped inside - * an Either object. - * @see Functor#fmap - */ - public fmap(f: (r: R) => T): Either; - /** - * @name lift - * @description Alias for fmap. - * @methodOf Either# - * @public - * @see Either#fmap - * @see Functor#lift - */ - public lift: (f: (r: R) => T) => Either; - /** - * @name map - * @description Alias for fmap. - * @methodOf Either# - * @public - * @see Either#fmap - * @see Functor#map - */ - public map: (f: (r: R) => T) => Either; - /** - * @name caseOf - * @description Execute a function depending on the Either content. - * It allows to unwrap the object for Left or Right types. - * @methodOf Either# - * @public - * @param {EitherPatterns} pattern Object containing the - * functions to applied on each Either types. - * @return {T} The returned value of the functions specified in the - * EitherPatterns interface. - * @see EitherPatterns# - */ - public caseOf(pattern: EitherPatterns): T; - /** - * @name equals - * @description Compare the type and the content of two Either - * objects. - * @methodOf Either# - * @public - * @param {Either} other The Either to compare with. - * @return {boolean} True if the type and content value are equals, - * false otherwise. - * @see Eq#equals - */ - public equals(other: Either): any; - } -} -declare namespace TsMonad { - /** - * @name eq - * @description Compare two objects : - * 1. if objects implement Eq, defer to their .equals - * 2. if are arrays, iterate and recur - * @function - * @param {any} a Any object. - * @param {any} b Any object. - * @returns {boolean} In case 1, the `.equals()` function returned value. - * In case 2, true if each elements are equals, false otherwise. - */ - function eq(a: any, b: any): any; - /** - * @name Eq - * @description Define a contract to compare (in)equalities between - * objects. - */ - interface Eq { - /** - * @name equals - * @description Determine if two objects are equals. - * @methodOf Eq - * @public - * @param {T} The object to compare with. - * @returns {boolean} True if the objects are equals, false otherwise. - */ - equals(t: T): boolean; - } - interface Monad { - /** - * @name unit - * @description Wrap an object inside a monad. - * @methodOf Monad# - * @public - * @param {U} t The object to wrap. - * @returns {Monad} A Monad with the value wrapped inside. - */ - unit(t: U): Monad; - /** - * @name bind - * @description Apply the function passed as parameter on the object. - * @methodOf Monad# - * @public - * @param {(t: T) => Monad} f Function applied on the Monad content. - * @returns {Monad} The result of the function f wrapped inside - * a Monad object. - */ - bind(f: (t: T) => Monad): Monad; - /** - * @name of - * @description Alias for unit. Fantasy Land Monad conformance. - * @methodOf Monad# - * @public - * @see Monad#unit - */ - of(t: U): Monad; - /** - * @name chain - * @description Alias for bind. Fantasy Land Monad conformance. - * @methodOf Monad# - * @public - * @see Monad#bind - */ - chain(f: (t: T) => Monad): Monad; - } - /** - * @name Functor - * @description Define a contract to add basic functor functions to an - * object. - */ - interface Functor { - /** - * @name fmap - * @description Apply the function passed as parameter on the object. - * @methodOf Functor# - * @public - * @param {(t: T) => U} f Function applied on the functor content. - * @returns {Functor} The result of the function f wrapped inside - * an Functor object. - * @see Functor#fmap - */ - fmap(f: (t: T) => U): Functor; - /** - * @name lift - * @description Alias for fmap. - * @methodOf Functor# - * @public - * @see Functor#fmap - */ - lift(f: (t: T) => U): Functor; - /** - * @name map - * @description Alias for fmap. Fantasy Land Monad conformance. - * @methodOf Functor# - * @public - * @see Functor#fmap - */ - map(f: (t: T) => U): Functor; - } -} -declare namespace TsMonad { - /** - * @name MaybeType - * @description Enumerate the different types contained by an Maybe object. - * @see Maybe# - */ - enum MaybeType { - Nothing = 0, - Just = 1, - } - /** - * @name MaybePatterns - * @description Define a contract to unwrap Maybe object using callbacks - * for Just and Nothing. - * @see Maybe# - */ - interface MaybePatterns { - /** - * @name just - * @description Function to handle the Just. - * @type {(t: T) => U} - */ - just: (t: T) => U; - /** - * @name nothing - * @description Function to handle the Nothing. - * @type {() => U} - */ - nothing: () => U; - } - // ditto, but optional - export interface OptionalMaybePatterns { - just?: (t: T) => U; - nothing?: () => U; - } - /** - * @name maybe - * @description Build a Maybe object. - * @function - * @param {T} t The object to wrap. - * @returns {Maybe} A Maybe object containing the input. If t is null - * or undefined, the Maybe object is filled with Nothing. - * @see Maybe# - */ - function maybe(t: T): Maybe; - /** - * @name Maybe - * @class Encapsulates an optional value. A value of type Maybe a either - * contains a value of type a (represented as Just a), or it is empty - * (represented as Nothing). - */ - class Maybe implements Monad, Functor, Eq> { - private type; - private value; - /** - * @description Build a Maybe object. For internal use only. - * @constructor - * @methodOf Maybe# - * @param {MaybeType} type Indicates if the Maybe content is a Just or a Nothing. - * @param {T} value The value to wrap (optional). - */ - constructor(type: MaybeType, value?: T); - /** - * @name maybe - * @description Helper function to build a Maybe object. - * @methodOf Maybe# - * @static - * @param {T} t The value to wrap. - * @returns {Maybe} A Maybe object containing the value passed in input. If t is null - * or undefined, the Maybe object is filled with Nothing. - */ - static maybe(t: T): Maybe; - /** - * @name just - * @description Helper function to build a Maybe object filled with a - * Just type. - * @methodOf Maybe# - * @static - * @param {T} t The value to wrap. - * @returns {Maybe} A Maybe object containing the value passed in input. - * @throws {TypeError} If t is null or undefined. - */ - static just(t: T): Maybe; - /** - * @name nothing - * @description Helper function to build a Maybe object filled with a - * Nothing type. - * @methodOf Maybe# - * @static - * @returns {Maybe} A Maybe with a Nothing type. - */ - static nothing(): Maybe; - /** - * @name unit - * @description Wrap an object inside a Maybe. - * @public - * @methodOf Maybe# - * @param {U} u The object to wrap. - * @returns {Monad} A Monad with the value wrapped inside. - * @see Monad#unit - */ - public unit(u: U): Maybe; - /** - * @name bind - * @description Apply the function passed as parameter on the object. - * @methodOf Maybe# - * @public - * @param {(t: T) => Maybe} f Function applied on the Maybe content. - * @returns {Maybe} The result of the function f wrapped inside - * a Maybe object. - * @see Monad#bind - */ - public bind(f: (t: T) => Maybe): Maybe; - /** - * @name of - * @description Alias for unit. - * @methodOf Maybe# - * @public - * @see Maybe#unit - * @see Monad#of - */ - public of: (u: U) => Maybe; - /** - * @name chain - * @description Alias for bind. - * @methodOf Maybe# - * @public - * @see Maybe#unit - * @see Monad#of - */ - public chain: (f: (t: T) => Maybe) => Maybe; - /** - * @name fmap - * @description Apply the function passed as parameter on the object. - * @methodOf Maybe# - * @public - * @param {(t: T) => U} f Function applied on the Maybe content. - * @returns {Maybe} The result of the function f wrapped inside - * an Maybe object. - * @see Functor#fmap - */ - public fmap(f: (t: T) => U): Maybe; - /** - * @name lift - * @description Alias for fmap. - * @methodOf Maybe# - * @public - * @see Maybe#fmap - * @see Monad#of - */ - public lift: (f: (t: T) => U) => Maybe; - /** - * @name map - * @description Alias for fmap. - * @methodOf Maybe# - * @public - * @see Maybe#fmap - * @see Monad#of - */ - public map: (f: (t: T) => U) => Maybe; - /** - * @name caseOf - * @description Execute a function depending on the Maybe content. It - * allows to unwrap the object for Just or Nothing types. - * @methodOf Maybe# - * @public - * @param {MaybePatterns} pattern Object containing the - * functions to applied on each Maybe types. - * @return {U} The returned value of the functions specified in the - * MaybePatterns interface. - * @see MaybePatterns# - */ - public caseOf(patterns: MaybePatterns): U; - /** - * @name defaulting - * @description Convert a possible Nothing into a guaranteed Maybe.Just. - * @methodOf Maybe# - * @public - * @param {T} pattern Default value to have if Nothing - * @return {Maybe} - */ - public defaulting(defaultValue: T): Maybe; - /** - * @name equals - * @description Compare the type and the content of two Maybe - * objects. - * @methodOf Maybe# - * @public - * @param {Maybe} other The Maybe to compare with. - * @return {boolean} True if the type and content value are equals, - * false otherwise. - * @see Eq#equals - */ - public equals(other: Maybe): any; - /** - * @name valueOr - * @description Unwrap a Maybe with a default value - * @methodOf Maybe# - * @public - * @param {T} defaultValue Default value to have if Nothing - * @return {T} - * Separate U type to allow Maybe.nothing().valueOr() to match - * without explicitly typing Maybe.nothing. - */ - valueOr(defaultValue: U): T | U; - /** - * @name valueOrCompute - * @description Unwrap a Maybe with a default value computed from a thunk - * @methodOf Maybe# - * @public - * @param {T} defaultValueFunction Default value to compute if Nothing - * @return {T} - * Separate U type to allow Maybe.nothing().valueOrCompute() to match - * without explicitly typing Maybe.nothing. - */ - valueOrCompute(defaultValueFunction: () => U): T | U; - /** - * @name valueOrThrow - * @description Unwrap a Maybe throwing if it is nothing - * @methodOf Maybe# - * @public - * @param {Error} [error] Optional error to throw - * @return {T} - */ - valueOrThrow(error?: Error): T; - /** - * @name do - * @description Execute a function based on the Maybe content. Returns the - * original value, so is meant for running functions with side-effects. - * @methodOf Maybe# - * @public - * @param {OptionalMaybePatterns} pattern Object containing the - * functions to applied on each Maybe type. - * @return The original Maybe value. - * @see OptionalMaybePatterns# - */ - do(patterns: OptionalMaybePatterns): Maybe; - } -} -declare namespace TsMonad { - /** - * @name WriterPatterns - * @description Define a contract to unwrap Writer object using a - * callback. - * @see Writer# - */ - interface WriterPatterns { - /** - * @name writer - * @description Function to handle the Writer content. - * @type {(story: S[], value: T) => U} - */ - writer: (story: S[], value: T) => U; - } - /** - * @name writer - * @description Build a Writer object. - * @function - * @param {S[]} story The collection to store logs. - * @param {T} value The object to wrap. - * @returns {Writer} A Writer object containing the log collection - * and the wrapped value. - * @see Writer# - */ - function writer(story: S[], value: T): Writer; - /** - * @name Writer - * @class Allow to do computations while making sure that all the log - * values are combined into one log value that then gets attached to - * the result. - */ - class Writer implements Monad, Eq> { - private story; - private value; - /** - * @description Build a Writer object. For internal use only. - * @constructor - * @methodOf Writer# - * @param {S[]} story The collection of logs. - * @param {T} value The object to wrap. - */ - constructor(story: S[], value: T); - /** - * @name writer - * @description Helper function to build a Writer object. - * @methodOf Writer# - * @static - * @param {S[]} story The collection of logs. - * @param {T} value The object to wrap. - * @returns {Writer} A Writer object containing the collection of logs - * and the wrapped value. - */ - static writer(story: S[], value: T): Writer; - /** - * @name writer - * @description Helper function to build a Writer object with the log - * passed in input only. - * @methodOf Writer# - * @static - * @param {S} s A log to store. - * @returns {Writer} A Writer object containing the collection of logs - * and a zeroed value. - */ - static tell(s: S): Writer; - /** - * @name unit - * @description Wrap an object inside a Writer. - * @public - * @methodOf Writer# - * @param {U} u The object to wrap. - * @returns {Monad} A Writer with the value wrapped inside and an - * empty collection of logs. - * @see Monad#unit - */ - public unit(u: U): Writer; - /** - * @name bind - * @description Apply the function passed as parameter on the object. - * @methodOf Writer# - * @public - * @param {(t: T) => Writer} f Function applied on the Writer content. - * @returns {Writer} The result of the function f append to the - * Writer object. - * @see Monad#bind - */ - public bind(f: (t: T) => Writer): Writer; - /** - * @name of - * @description Alias for unit. - * @methodOf Writer# - * @public - * @see Writer#unit - * @see Monad#of - */ - public of: (u: U) => Writer; - /** - * @name chain - * @description Alias for bind - * @methodOf Writer# - * @public - * @see Writer#unit - * @see Monad#of - */ - public chain: (f: (t: T) => Writer) => Writer; - /** - * @name fmap - * @description Apply the function passed as parameter on the object. - * @methodOf Writer# - * @public - * @param {(t: T) => U} f Function applied on the wrapped value. - * @returns {Writer} The result of the function f wrapped inside - * an Writer object. It has an empty collection of logs. - * @see Functor#fmap - */ - public fmap(f: (t: T) => U): Writer; - /** - * @name lift - * @description Alias for fmap - * @methodOf Writer# - * @public - * @see Writer#fmap - * @see Monad#of - */ - public lift: (f: (t: T) => U) => Writer; - /** - * @name map - * @description Alias for fmap - * @methodOf Writer# - * @public - * @see Writer#fmap - * @see Monad#of - */ - public map: (f: (t: T) => U) => Writer; - /** - * @name caseOf - * @description Execute a function on the Writer content. It allows to - * unwrap the object. - * @methodOf Writer# - * @public - * @param {WriterPatterns} pattern Object containing the - * functions to applied on the Writer content. - * @return {U} The returned value of the function specified in the - * WriterPatterns interface. - * @see WriterPatterns# - */ - public caseOf(patterns: WriterPatterns): U; - /** - * @name equals - * @description Compare the type and the content of two Writer - * objects. - * @methodOf Writer# - * @public - * @param {Writer} other The Writer to compare with. - * @return {boolean} True if the collection of logs and content value - * are equals, false otherwise. - * @see Eq#equals - */ - public equals(other: Writer): boolean; - } -} -declare var module: { - exports: any; - require(id: string): any; - id: string; - filename: string; - loaded: boolean; - parent: any; - children: any[]; -}; -/** -* @name tsmonad -* @namespace Hold functionalities related to TsMonad library. -*/ -declare module 'tsmonad' { - export = TsMonad; -} diff --git a/types/tsmonad/test/either-tests.ts b/types/tsmonad/test/either-tests.ts deleted file mode 100644 index f845f5ae15..0000000000 --- a/types/tsmonad/test/either-tests.ts +++ /dev/null @@ -1,45 +0,0 @@ - - -class User { - - private age: number; - - constructor(age?: number) { - this.age = age ? age : 0; - } - - public getAge(): TsMonad.Either { - if (this.age > 0) { - return TsMonad.Either.right(this.age); - } else { - return TsMonad.Either.left('Information withheld'); - } - } -} - -namespace Station { - - export class BusPass { - - public isValidForRoute(route: string): boolean { - return true; - } - } - - export function getBusPass(age: number): TsMonad.Either { - if (age > 18) { - return TsMonad.Either.right(new BusPass()); - } else { - return TsMonad.Either.left('Too young for a bus pass'); - } - } -} - -var user = new User(42) - -var canRideForFree = user.getAge() - .bind(age => Station.getBusPass(age)) - .caseOf({ - right: busPass => busPass.isValidForRoute('Weston'), - left: errorMessage => { console.log(errorMessage); return false; } - }); diff --git a/types/tsmonad/test/maybe-tests.ts b/types/tsmonad/test/maybe-tests.ts deleted file mode 100644 index f0c0cdaf16..0000000000 --- a/types/tsmonad/test/maybe-tests.ts +++ /dev/null @@ -1,20 +0,0 @@ - - -var turns_out_to_be_100 = TsMonad.Maybe.just(10) - .caseOf({ - just: n => n * n, - nothing: () => -1 - }); - -var turns_out_to_be_nothing = TsMonad.Maybe.nothing() - .caseOf({ - just: n => n * n, - nothing: () => -1 - }); - -var turns_out_to_be_true = TsMonad.Maybe.just(123) - .lift(n => n * 2) - .caseOf({ - just: n => n === 246, - nothing: () => false - }); \ No newline at end of file diff --git a/types/tsmonad/test/writer-tests.ts b/types/tsmonad/test/writer-tests.ts deleted file mode 100644 index dad647da95..0000000000 --- a/types/tsmonad/test/writer-tests.ts +++ /dev/null @@ -1,8 +0,0 @@ - - -var is_true = TsMonad.Writer.writer(['Started with 0'], 0) - .bind(x => TsMonad.Writer.writer(['+ 8'], x + 8)) - .bind(x => TsMonad.Writer.writer(['- 6', '* 8'], 8 * (x - 6))) - .caseOf({ - writer: (s, v) => v === 16 && s.join(', ') === 'Started with 0, + 8, - 6, * 8' - }); \ No newline at end of file diff --git a/types/tsmonad/tsconfig.json b/types/tsmonad/tsconfig.json deleted file mode 100644 index 1077fb13f0..0000000000 --- a/types/tsmonad/tsconfig.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "compilerOptions": { - "module": "commonjs", - "lib": [ - "es6", - "dom" - ], - "noImplicitAny": true, - "noImplicitThis": true, - "strictNullChecks": false, - "baseUrl": "../", - "typeRoots": [ - "../" - ], - "types": [], - "noEmit": true, - "forceConsistentCasingInFileNames": true - }, - "files": [ - "index.d.ts", - "test/maybe-tests.ts", - "test/writer-tests.ts", - "test/either-tests.ts" - ] -} \ No newline at end of file From 32f8d75fdba1c1d5666f0c6782c2d656d67febf7 Mon Sep 17 00:00:00 2001 From: Huy Nguyen Date: Tue, 4 Apr 2017 12:01:19 -0400 Subject: [PATCH 161/844] Fix tslint config --- types/react-router-redux/tslint.json | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/types/react-router-redux/tslint.json b/types/react-router-redux/tslint.json index c6a89d14c7..f9e30021f4 100644 --- a/types/react-router-redux/tslint.json +++ b/types/react-router-redux/tslint.json @@ -1,6 +1,3 @@ { - "extends": "../tslint.json", - "rules": { - "banned-types": false - } + "extends": "../tslint.json" } From 05c43d5711f37984e9c36f289aba084bc0d3f5a4 Mon Sep 17 00:00:00 2001 From: Huy Nguyen Date: Tue, 4 Apr 2017 12:17:18 -0400 Subject: [PATCH 162/844] Fix lint errors --- types/react-router-redux/v3/index.d.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/types/react-router-redux/v3/index.d.ts b/types/react-router-redux/v3/index.d.ts index be706bdcc8..19473384a1 100644 --- a/types/react-router-redux/v3/index.d.ts +++ b/types/react-router-redux/v3/index.d.ts @@ -7,7 +7,6 @@ import * as Redux from "redux"; import * as History from "history"; - export const TRANSITION: string; export const UPDATE_LOCATION: string; From fba72c75b24a3df93306e379973a61f5c480e55f Mon Sep 17 00:00:00 2001 From: Dasa Paddock Date: Tue, 4 Apr 2017 11:41:56 -0700 Subject: [PATCH 163/844] Updates for v4.3 --- types/arcgis-js-api/index.d.ts | 96 +++++++++++++++++----------------- 1 file changed, 48 insertions(+), 48 deletions(-) diff --git a/types/arcgis-js-api/index.d.ts b/types/arcgis-js-api/index.d.ts index 293c5190e9..d46dea1b81 100644 --- a/types/arcgis-js-api/index.d.ts +++ b/types/arcgis-js-api/index.d.ts @@ -667,6 +667,8 @@ declare namespace __esri { export type EasingFunction = (t: number, duration: number) => number; + export type EventHandler = (event: any) => void; + export interface PromisedWatchHandle extends IPromise { remove(): void; } @@ -1337,7 +1339,7 @@ declare namespace __esri { maxZoom?: number; snapToZoom?: boolean; rotationEnabled?: boolean; - effectiveLODs?: number; + effectiveLODs?: LOD[]; effectiveMinZoom?: number; effectiveMaxZoom?: number; effectiveMinScale?: number; @@ -1868,21 +1870,6 @@ declare namespace __esri { worldScale?: boolean; } - interface Evented { - emit(type: string, event: any): IHandle; - on(name: string, callback: Function): IHandle; - } - - interface EventedConstructor { - new(): Evented; - - - hasEventListener(type: string): boolean; - on(type: string, listener: Function): any; - } - - export const Evented: EventedConstructor; - interface Basemap extends Accessor, Loadable, JSONSupport { baseLayers: Collection; id: string; @@ -1907,11 +1894,11 @@ declare namespace __esri { export const Basemap: BasemapConstructor; interface BasemapProperties extends LoadableProperties { - baseLayers?: Collection; + baseLayers?: Collection | any[]; id?: string; loaded?: boolean; portalItem?: PortalItemProperties; - referenceLayers?: Collection; + referenceLayers?: Collection | any[]; thumbnailUrl?: string; title?: string; } @@ -2013,7 +2000,7 @@ declare namespace __esri { export const Ground: GroundConstructor; interface GroundProperties { - layers?: Collection; + layers?: Collection | any[]; } interface Map extends Accessor, LayersMixin { @@ -2029,7 +2016,7 @@ declare namespace __esri { export const Map: MapConstructor; interface MapProperties extends LayersMixinProperties { - allLayers?: Collection; + allLayers?: Collection | any[]; basemap?: BasemapProperties; ground?: GroundProperties; } @@ -2053,7 +2040,7 @@ declare namespace __esri { export const PopupTemplate: PopupTemplateConstructor; interface PopupTemplateProperties { - actions?: Collection; + actions?: Collection | any[]; content?: string | any[] | Function; fieldInfos?: PopupTemplateFieldInfos[]; overwriteActions?: boolean; @@ -2718,6 +2705,7 @@ declare namespace __esri { definitionExpression: string; elevationInfo: FeatureLayerElevationInfo; fields: Field[]; + gdbVersion: string; geometryType: string; hasAttachments: boolean; hasM: boolean; @@ -2762,6 +2750,7 @@ declare namespace __esri { definitionExpression?: string; elevationInfo?: FeatureLayerElevationInfo; fields?: FieldProperties[]; + gdbVersion?: string; geometryType?: string; hasAttachments?: boolean; hasM?: boolean; @@ -2777,7 +2766,7 @@ declare namespace __esri { renderer?: RendererProperties; returnM?: boolean; returnZ?: boolean; - source?: Collection; + source?: Collection | any[]; spatialReference?: SpatialReferenceProperties; token?: string; url?: string; @@ -2823,7 +2812,7 @@ declare namespace __esri { interface GraphicsLayerProperties extends LayerProperties, ScaleRangeLayerProperties { elevationInfo?: GraphicsLayerElevationInfo; - graphics?: Collection; + graphics?: Collection | any[]; } interface GroupLayer extends Layer, LayersMixin, JSONSupport, PortalLayer { @@ -3419,7 +3408,7 @@ declare namespace __esri { popupTemplate?: PopupTemplateProperties; renderer?: RendererProperties; source?: any | any; - sublayers?: Collection; + sublayers?: Collection | any[]; title?: string; url?: string; visible?: boolean; @@ -4506,7 +4495,7 @@ declare namespace __esri { interface Symbol3DProperties extends SymbolProperties { styleOrigin?: Symbol3DStyleOrigin; - symbolLayers?: Collection; + symbolLayers?: Collection | any[]; } interface Symbol3DLayer extends Accessor, JSONSupport { @@ -6170,7 +6159,7 @@ declare namespace __esri { goTo(target: number[] | Geometry | Geometry[] | Graphic | Graphic[] | Viewpoint | any, options?: MapViewGoToOptions): IPromise; hasEventListener(type: string): boolean; hitTest(screenPoint: MapViewHitTestScreenPoint): IPromise; - on(type: string | string[], modifiersOrHandler: string[] | Function, handler?: Function): any; + on(type: string | string[], modifiersOrHandler: string[] | EventHandler, handler?: EventHandler): IHandle; toMap(screenPoint: ScreenPoint, mapPoint?: Point): Point; toScreen(point: Point, screenPoint?: ScreenPoint): ScreenPoint; } @@ -6208,7 +6197,7 @@ declare namespace __esri { goTo(target: number[] | Geometry | Geometry[] | Graphic | Graphic[] | Viewpoint | Camera | any, options?: SceneViewGoToOptions): IPromise; hasEventListener(type: string): boolean; hitTest(screenPoint: SceneViewHitTestScreenPoint): IPromise; - on(type: string | string[], modifiersOrHandler: string[] | Function, handler?: Function): any; + on(type: string | string[], modifiersOrHandler: string[] | EventHandler, handler?: EventHandler): IHandle; toMap(screenPoint: ScreenPoint, mapPoint?: Point): Point; toScreen(point: Point, screenPoint?: ScreenPoint): ScreenPoint; } @@ -6257,11 +6246,11 @@ declare namespace __esri { export const View: ViewConstructor; interface ViewProperties extends BreakpointsOwnerProperties, DOMContainerProperties { - allLayerViews?: Collection; + allLayerViews?: Collection | any[]; animation?: ViewAnimationProperties; - graphics?: Collection; + graphics?: Collection | any[]; interacting?: boolean; - layerViews?: Collection; + layerViews?: Collection | any[]; map?: MapProperties; padding?: ViewPadding; ready?: boolean; @@ -6502,7 +6491,7 @@ declare namespace __esri { export const Presentation: PresentationConstructor; interface PresentationProperties { - slides?: Collection; + slides?: Collection | any[]; } interface Slide extends Accessor { @@ -6736,7 +6725,7 @@ declare namespace __esri { interface LayerListProperties extends WidgetProperties { createActionsFunction?: Function; - operationalItems?: Collection; + operationalItems?: Collection | any[]; view?: MapView | SceneView; viewModel?: LayerListViewModelProperties; } @@ -6813,7 +6802,6 @@ declare namespace __esri { features: Graphic[]; location: Point; promises: IPromise[]; - rendered: boolean; selectedFeature: Graphic; selectedFeatureIndex: number; title: string; @@ -6836,7 +6824,7 @@ declare namespace __esri { export const Popup: PopupConstructor; interface PopupProperties extends WidgetteProperties { - actions?: Collection; + actions?: Collection | any[]; content?: string | any; currentDockPosition?: string; dockEnabled?: boolean; @@ -6845,7 +6833,6 @@ declare namespace __esri { features?: GraphicProperties[]; location?: PointProperties; promises?: IPromise[]; - rendered?: boolean; selectedFeature?: GraphicProperties; selectedFeatureIndex?: number; title?: string; @@ -7142,7 +7129,7 @@ declare namespace __esri { interface BasemapGalleryViewModelProperties { activeBasemap?: BasemapProperties; - items?: Collection; + items?: Collection | any[]; source?: LocalBasemapsSource | PortalBasemapsSource; state?: string; view?: MapView | SceneView; @@ -7245,7 +7232,7 @@ declare namespace __esri { interface LayerListViewModelProperties { createActionsFunction?: Function; - operationalItems?: Collection; + operationalItems?: Collection | any[]; state?: string; view?: MapView | SceneView; } @@ -7356,7 +7343,7 @@ declare namespace __esri { export const PopupViewModel: PopupViewModelConstructor; interface PopupViewModelProperties { - actions?: Collection; + actions?: Collection | any[]; content?: string | any; featureCount?: number; features?: GraphicProperties[]; @@ -7491,6 +7478,17 @@ declare namespace __esri { view?: MapView | SceneView; } + interface Evented { + hasEventListener(type: string): boolean; + on(type: string, listener: EventHandler): IHandle; + } + + interface EventedConstructor { + new(): Evented; + } + + export const Evented: EventedConstructor; + interface JSONSupport { toJSON(): any; } @@ -7627,14 +7625,14 @@ declare namespace __esri { export const ArcGISDynamicMapService: ArcGISDynamicMapServiceConstructor; interface ArcGISDynamicMapServiceProperties { - allSublayers?: Collection; + allSublayers?: Collection | any[]; dpi?: number; gdbVersion?: string; imageFormat?: string; imageMaxHeight?: number; imageMaxWidth?: number; imageTransparency?: boolean; - sublayers?: Collection; + sublayers?: Collection | any[]; } interface ArcGISImageService { @@ -7809,7 +7807,7 @@ declare namespace __esri { export const LayersMixin: LayersMixinConstructor; interface LayersMixinProperties { - layers?: Collection; + layers?: Collection | any[]; } interface BreakpointsOwner { @@ -7833,7 +7831,7 @@ declare namespace __esri { } interface DOMContainer { - container: string; + container: HTMLDivElement | string; height: number; popup: Popup; resizing: boolean; @@ -7850,7 +7848,7 @@ declare namespace __esri { export const DOMContainer: DOMContainerConstructor; interface DOMContainerProperties { - container?: string; + container?: HTMLDivElement | string; height?: number; popup?: Popup; resizing?: boolean; @@ -8381,6 +8379,8 @@ declare module "esri" { export import EasingFunction = __esri.EasingFunction; + export import EventHandler = __esri.EventHandler; + export import PromisedWatchHandle = __esri.PromisedWatchHandle; export import GroundQueryElevationOptions = __esri.GroundQueryElevationOptions; @@ -8748,11 +8748,6 @@ declare module "esri" { export import sizeGetSchemesParams = __esri.sizeGetSchemesParams; } -declare module "esri/core/Evented" { - import Evented = __esri.Evented; - export = Evented; -} - declare module "esri/Basemap" { import Basemap = __esri.Basemap; export = Basemap; @@ -9833,6 +9828,11 @@ declare module "esri/widgets/Zoom/ZoomViewModel" { export = ZoomViewModel; } +declare module "esri/core/Evented" { + import Evented = __esri.Evented; + export = Evented; +} + declare module "esri/core/JSONSupport" { import JSONSupport = __esri.JSONSupport; export = JSONSupport; From 13f59a2ae31562983a7ca6b4486c8d5182ea9076 Mon Sep 17 00:00:00 2001 From: uglycoyote Date: Tue, 4 Apr 2017 12:59:24 -0700 Subject: [PATCH 164/844] Removing usage of g.matrix, since g (group) does not have a member called matrix. (the test code would print undefined) --- types/snapsvg/test/3.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/snapsvg/test/3.ts b/types/snapsvg/test/3.ts index d9195dc3d4..70381001ca 100644 --- a/types/snapsvg/test/3.ts +++ b/types/snapsvg/test/3.ts @@ -337,6 +337,6 @@ window.onload=()=>{ var myInvertedMatrix = myMatrix.invert(); g.animate({ transform: myMatrix },3000, mina.bounce, function() { g.animate({ transform: myInvertedMatrix }, 3000, mina.bounce) } ); - console.log( g.transform(), g.matrix, myMatrix.split() ); + console.log( g.transform(), myMatrix.split() ); } } From a7b3bbe98956563c2a2f965c17c2ffd96fd2e309 Mon Sep 17 00:00:00 2001 From: Michal Hruby Date: Tue, 4 Apr 2017 22:37:45 +0100 Subject: [PATCH 165/844] Added support for Promise assertions to should --- types/should/index.d.ts | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/types/should/index.d.ts b/types/should/index.d.ts index 6060fa68cc..918e82a6ba 100644 --- a/types/should/index.d.ts +++ b/types/should/index.d.ts @@ -42,6 +42,7 @@ interface ShouldAssertion { Class(): ShouldAssertion; Undefined(): ShouldAssertion; Null(): ShouldAssertion; + Promise(): ShouldAssertion; generator(): ShouldAssertion; iterable(): ShouldAssertion; iterator(): ShouldAssertion; @@ -92,6 +93,14 @@ interface ShouldAssertion { endWith(expected: string, message?: any): ShouldAssertion; throw(message?: any): ShouldAssertion; + //promises + eventually: ShouldAssertion; + finally: ShouldAssertion; + fulfilled(): Promise; + fulfilledWith(value: any): Promise + rejected(): Promise; + rejectedWith(err: Error | string | RegExp): Promise; + //http header(field: string, val?: string): ShouldAssertion; status(code: number): ShouldAssertion; From 0ef9f445a4666b66b81bf36fc853904b3c7be449 Mon Sep 17 00:00:00 2001 From: Michal Hruby Date: Tue, 4 Apr 2017 22:43:36 +0100 Subject: [PATCH 166/844] Bump version --- types/should/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/should/index.d.ts b/types/should/index.d.ts index 918e82a6ba..db78e6e087 100644 --- a/types/should/index.d.ts +++ b/types/should/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for should.js v8.1.1 +// Type definitions for should.js v8.3.0 // Project: https://github.com/shouldjs/should.js // Definitions by: Alex Varju , Maxime LUCE // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped From 0955d89cd5a35e054b0f076c7e089db8c9fe5c83 Mon Sep 17 00:00:00 2001 From: Ian Copp Date: Tue, 4 Apr 2017 15:02:01 -0700 Subject: [PATCH 167/844] Add node-common-errors --- types/node-common-errors/index.d.ts | 613 ++++++++++++++++++ .../node-common-errors-tests.ts | 54 ++ types/node-common-errors/tsconfig.json | 22 + types/node-common-errors/tslint.json | 1 + 4 files changed, 690 insertions(+) create mode 100644 types/node-common-errors/index.d.ts create mode 100644 types/node-common-errors/node-common-errors-tests.ts create mode 100644 types/node-common-errors/tsconfig.json create mode 100644 types/node-common-errors/tslint.json diff --git a/types/node-common-errors/index.d.ts b/types/node-common-errors/index.d.ts new file mode 100644 index 0000000000..69fb5323b4 --- /dev/null +++ b/types/node-common-errors/index.d.ts @@ -0,0 +1,613 @@ +import * as express from 'express'; + +// Type definitions for node-common-errors 0.4 +// Project: https://github.com/shutterstock/node-errors +// Definitions by: Ian Copp +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +type GenerateMessageMethod = () => string; + +interface ErrorConstructor { + new (...params: any[]): Error; +} + +/** + * Modifies an error's stack to include the current stack and logs it to + * stderr. Useful for logging errors received by a callback. + * + * @param err any error or error message received from a callback + * @param message any message you'd like to prepend + * @returns err + */ +export function log(err: Error, message?: string): Error; +export function logError(err: Error, cb: () => any): void; + +/** + * Modifies an error's stack to include the current stack without logging + * it. Useful for logging errors received by a callback. + * + * @param err any error or error message received from a callback + * @returns err + */ +export function prependCurrentStack(err: Error): Error; + +export namespace helpers { + /** + * Simple interface for generating a new Error class type. + * @param name The full name of the new Error class + * @param options.extends The base class for the new Error + * class. Default is Error. + * @param options.globalize Boolean (default true) to store the + * Error in global space so that the + * Error is equivalent to others included + * from other versions of the module. + * @param options.args Array of names of values to accept and + * store from the class constructor. + * Default is ['message', 'inner_error']. + * @param options.generateMessage A function for defining a custom error + * message. + */ + function generateClass( + name: string, + options?: { + extends?: Error, + globalize?: boolean, + args?: string[], + generateMessage?: GenerateMessageMethod + } + ): ErrorConstructor; +} + +export namespace middleware { + /** + * Express middleware for preventing the web server from crashing when + * an error is thrown from an asynchronous context. Any error that would + * have caused a crash is logged to stderr. + */ + function crashProtector(errorHandler: (err: Error, req: express.Request, res: express.Response) => void): void; + + /** + * Express middleware that translates common errors into HTTP status + * codes and messages. + */ + function errorHandler(err: Error, req: express.Request, res: express.Response, next: express.NextFunction): void; +} + +/** + * This is roughly the same as the native Error class. It additionally + * supports an inner_error attribute. + * + * @example throw new errors.Error("Please provide authentication.", err) + */ +export class Error extends global.Error { + /** + * @param message any message + * @param inner_error the Error instance that caused the current error. + * Stack trace will be appended. + */ + constructor(entityName: string, inner_error?: Error); +} + +/** + * Applicable when a resource is already in use, for example unique key + * constraints like a username. + * + * @example throw new errors.AlreadyInUseError('user', 'username') + */ +export class AlreadyInUseError extends global.Error { + /** + * @param entityName the entity that owns the protected resource + * @param args the fields or attributes that are already in use + */ + constructor(entityName: string, ...args: string[]); +} + +/** + * Applicable when there's a generic problem with an argument received by a + * function call. + * + * @example throw new errors.ArgumentError('username', err) + */ +export class ArgumentError extends global.Error { + /** + * @param argumentName the name of the argument that has a problem + * @param inner_error the Error instance that caused the current error. + * Stack trace will be appended. + */ + constructor(argumentName: string, inner_error?: Error); +} + +/** + * Applicable when an argument received by a function call is null/undefined + * or empty. + * + * @example throw new errors.ArgumentNullError('username', err) + */ +export class ArgumentNullError extends ArgumentError { + /** + * @param argumentName the name of the argument that is null + * @param inner_error the Error instance that caused the current error. + * Stack trace will be appended. + */ + constructor(argumentName: string, inner_error?: Error); +} + +/** + * Applicable when an operation requires authentication + * + * @example throw new errors.AuthenticationRequiredError("Please provide authentication.", err) + */ +export class AuthenticationRequiredError extends global.Error { + /** + * @param message any message + * @param inner_error the Error instance that caused the current error. + * Stack trace will be appended. + */ + constructor(message: string, inner_error?: Error); +} + +/** + * Applicable when an error occurs on a connection. + * + * @example throw new errors.ConnectionError('database connection no longer available', err) + */ +export class ConnectionError extends global.Error { + /** + * @param message any message + * @param inner_error the Error instance that caused the current error. + * Stack trace will be appended. + */ + constructor(message: string, inner_error?: Error); +} + +/** + * Represents a message and a HTTP status code. + * + * @example throw new errors.HttpStatusError(404, "Not Found") + * @example throw new errors.HttpStatusError(err, req) + */ +export class HttpStatusError extends global.Error { + /** + * Figure out a proper status code and message from a given error. To + * change the mappings, modify HttpStatusError.message_map and + * HttpStatusError.code_map + * + * @param status_code any HTTP status code integer + * @param message any message + */ + constructor(status_code: number, message?: string); + + /** + * @param err any instanceof Error + * @param req the request object + */ + constructor(err: Error, req?: express.Request); +} + +/** + * Applicable when an invalid operation occurs. + * + * @example throw new errors.InvalidOperationError('divide by zero', err) + */ +export class InvalidOperationError extends global.Error { + /** + * @param message any message + * @param inner_error the Error instance that caused the current error. + * Stack trace will be appended. + */ + constructor(message: string, inner_error?: Error); +} + +/** + * Applicable when an error occurs on a socket. + * + * @example throw new errors.SocketError('socket no longer available', err) + */ +export class SocketError extends global.Error { + /** + * @param message any message + * @param inner_error the Error instance that caused the current error. + * Stack trace will be appended. + */ + constructor(message: string, inner_error?: Error); +} + +/** + * Applicable when an attempt to retrieve data yielded no result. + * + * @example throw new errors.NotFoundError("User", err) + */ +export class NotFoundError extends global.Error { + /** + * @param entity_name a description for what was not found + * @param inner_error the Error instance that caused the current error. + * Stack trace will be appended. + */ + constructor(entity_name: string, inner_error?: Error); +} + +/** + * Applicable when a requested method or operation is not implemented. + * + * @example throw new errors.NotImplementedError("Method is not yet implemented.", err) + */ +export class NotImplementedError extends global.Error { + /** + * @param message any message + * @param inner_error the Error instance that caused the current error. + * Stack trace will be appended. + */ + constructor(message: string, inner_error?: Error); +} + +/** + * Applicable when an operation is not permitted + * + * @example throw new errors.NotPermittedError("username cannot be changed once set.", err) + */ +export class NotPermittedError extends global.Error { + /** + * @param message any message + * @param inner_error the Error instance that caused the current error. + * Stack trace will be appended. + */ + constructor(message: string, inner_error?: Error); +} + +/** + * Applicable when a certain condition is not supported by your application. + * + * @example throw new errors.NotSupportedError('Zero values', err) + */ +export class NotSupportedError extends global.Error { + /** + * @param message any message + * @param inner_error the Error instance that caused the current error. + * Stack trace will be appended. + */ + constructor(message: string, inner_error?: Error); +} + +/** + * Applicable when there is not enough memory to continue the execution of a program. + * + * @example throw new errors.OutOfMemoryError('Maximum mem size exceeded.', err) + */ +export class OutOfMemoryError extends global.Error { + /** + * @param message any message + * @param inner_error the Error instance that caused the current error. + * Stack trace will be appended. + */ + constructor(message: string, inner_error?: Error); +} + +/** + * Represents an error that occurs when a numeric variable or parameter is + * outside of its valid range. This is roughly the same as the native + * RangeError class. It additionally supports an inner_error attribute. + * + * @example throw new errors.RangeError("Value must be between " + MIN + " and " + MAX, err) + */ +export class RangeError extends global.RangeError { + /** + * @param message any message + * @param inner_error the Error instance that caused the current error. + * Stack trace will be appended. + */ + constructor(message: string, inner_error?: Error); +} + +/** + * Represents an error when a non-existent variable is referenced. This is + * roughly the same as the native ReferenceError class. It additionally + * supports an inner_error attribute. + * + * @example throw new errors.ReferenceError("x is not defined", err) + */ +export class ReferenceError extends global.ReferenceError { + /** + * @param message any message + * @param inner_error the Error instance that caused the current error. + * Stack trace will be appended. + */ + constructor(message: string, inner_error?: Error); +} + +/** + * Applicable when the execution stack overflows because it contains too + * many nested method calls. + * + * @example throw new errors.StackOverflowError('Stack overflow detected.', err) + */ +export class StackOverflowError extends global.Error { + /** + * @param message any message + * @param inner_error the Error instance that caused the current error. + * Stack trace will be appended. + */ + constructor(message: string, inner_error?: Error); +} + +/** + * Represents an error when trying to interpret syntactically invalid code. + * This is roughly the same as the native SyntaxError class. It additionally + * supports an inner_error attribute. + * + * @example throw new errors.SyntaxError("Unexpected token a", err) + */ +export class SyntaxError extends global.SyntaxError { + /** + * @param message any message + * @param inner_error the Error instance that caused the current error. + * Stack trace will be appended. + */ + constructor(message: string, inner_error?: Error); +} + +/** + * Applicable when an operation takes longer than the alloted amount. + * + * @example throw new errors.TimeoutError('100ms', err) + */ +export class TimeoutError extends global.Error { + /** + * @param time a time duration + * @param inner_error the Error instance that caused the current error. + * Stack trace will be appended. + */ + constructor(time: string, inner_error?: Error); +} + +/** + * Represents an error when a value is not of the expected type. This is + * roughly the same as the native TypeError class. It additionally supports + * an inner_error attribute. + * + * @example throw new errors.TypeError("number is not a function", err) + */ +export class TypeError extends global.TypeError { + /** + * @param message any message + * @param inner_error the Error instance that caused the current error. + * Stack trace will be appended. + */ + constructor(message: string, inner_error?: Error); +} + +/** + * Represents an error when a value is not of the expected type. This is + * roughly the same as the native URIError class. It additionally supports + * an inner_error attribute. + * + * @example throw new errors.URIError("URI malformed", err) + */ +export class URIError extends global.URIError { + /** + * @param message any message + * @param inner_error the Error instance that caused the current error. + * Stack trace will be appended. + */ + constructor(message: string, inner_error?: Error); +} + +/** + * Useful for denoting a problem with a user-defined value. Generally, you + * won't throw this error. It serializes to JSON, and it can also function + * as an envelope for multiple errors. + * + * @example + * function validateUsername(username) { + * var errors = new errors.ValidationError() + * if (username.length < 3) errors.addError(new errors.ValidationError("username must be at least two characters long", "VAL_MIN_USERNAME_LENGTH", "username")) + * if(/-%$*&!/.test(username)) errors.addError(new errors.ValidationError("username may not contain special characters", "VAL_USERNAME_SPECIALCHARS", "username")) + * return errors + * } + */ +export class ValidationError extends global.Error { + /** + * @param message any message + * @param code an optional error code + * @param field an optional description of the data + */ + constructor(message: string, code?: string, field?: string); + + /** + * add an error object to the errors array + */ + addError(error: Error): this; + + /** + * append an array of error objects to the errors array + */ + addErrors(errors: Error[]): this; +} + +export namespace data { + /** + * Applicable when an error occurs on or with an external data source. + * + * @example throw new errors.data.DataError('Too many rows returned from database', err) + */ + class DataError extends global.Error { + /** + * @param message any message + * @param inner_error the Error instance that caused the current + * error. Stack trace will be appended. + */ + constructor(message: string, inner_error?: Error); + } + + /** + * Applicable when an error occurs while using memcached. + * + * @example throw new errors.data.MemcachedError('Expected value not found', err) + */ + class MemcachedError extends DataError { + /** + * @param message any message + * @param inner_error the Error instance that caused the current + * error. Stack trace will be appended. + */ + constructor(message: string, inner_error?: Error); + } + + /** + * Applicable when an error occurs while using MongoDB. + * + * @example throw new errors.data.MongoDBError('Retrieved value not in expected format', err) + */ + class MongoDBError extends DataError { + /** + * @param message any message + * @param inner_error the Error instance that caused the current + * error. Stack trace will be appended. + */ + constructor(message: string, inner_error?: Error); + } + + /** + * Applicable when an error occurs while using redis. + * + * @example throw new errors.data.RedisError('expected value not found in redis', err) + */ + class RedisError extends DataError { + /** + * @param message any message + * @param inner_error the Error instance that caused the current + * error. Stack trace will be appended. + */ + constructor(message: string, inner_error?: Error); + } + + /** + * Applicable when a transaction was unexpectedly rolled back. + * + * @example throw new errors.data.RollbackError('database transaction was unexpectedly rolled back', err) + */ + class RollbackError extends DataError { + /** + * @param message any message + * @param inner_error the Error instance that caused the current + * error. Stack trace will be appended. + */ + constructor(message: string, inner_error?: Error); + } + + /** + * Applicable when an error occurs while using a SQL database. + * + * @example throw new errors.data.SQLError('foreign key constraint violated', err) + */ + class SQLError extends DataError { + /** + * @param message any message + * @param inner_error the Error instance that caused the current + * error. Stack trace will be appended. + */ + constructor(message: string, inner_error?: Error); + } + + /** + * Applicable when an error unexpectedly interrupts a transaction. + * + * @example throw new errors.data.TransactionError('transaction already complete', err) + */ + class TransactionError extends DataError { + /** + * @param message any message + * @param inner_error the Error instance that caused the current + * error. Stack trace will be appended. + */ + constructor(message: string, inner_error?: Error); + } +} + +export namespace io { + /** + * Base class for Errors while accessing information using streams, + * files and directories. + * + * @example throw new errors.io.IOError("Could not open file", err) + */ + class IOError extends global.Error { + /** + * @param message any message + * @param inner_error the Error instance that caused the current + * error. Stack trace will be appended. + */ + constructor(message: string, inner_error?: Error); + } + + /** + * Applicable when part of a file or directory cannot be found. + * + * @example throw new errors.io.DirectoryNotFoundError("/var/log", err) + */ + class DirectoryNotFoundError extends IOError { + /** + * @param message any message + * @param inner_error the Error instance that caused the current + * error. Stack trace will be appended. + */ + constructor(message: string, inner_error?: Error) + } + + /** + * Applicable when trying to access a drive or share that is not + * available. + * + * @example throw new errors.io.DriveNotFoundError("c", err) + */ + class DriveNotFoundError extends IOError { + /** + * @param message any message + * @param inner_error the Error instance that caused the current + * error. Stack trace will be appended. + */ + constructor(message: string, inner_error?: Error); + } + + /** + * Applicable when reading is attempted past the end of a stream. + * + * @example throw new errors.io.EndOfStreamError("EOS while reading header", err) + */ + class EndOfStreamError extends IOError { + /** + * @param message any message + * @param inner_error the Error instance that caused the current + * error. Stack trace will be appended. + */ + constructor(message: string, inner_error?: Error); + } + + /** + * Applicable when a file is found and read but cannot be loaded. + * + * @example throw new errors.io.FileLoadError("./package.json", err) + */ + class FileLoadError extends IOError { + /** + * @param file_name any message + * @param inner_error the Error instance that caused the current + * error. Stack trace will be appended. + */ + constructor(file_name: string, inner_error?: Error); + } + + /** + * Applicable when an attempt to access a file that does not exist on + * disk fails. + * + * @example throw new errors.io.FileNotFoundError("./package.json", err) + */ + class FileNotFoundError extends IOError { + /** + * @param file_name any message + * @param inner_error the Error instance that caused the current + * error. Stack trace will be appended. + */ + constructor(file_name: string, inner_error?: Error); + } +} diff --git a/types/node-common-errors/node-common-errors-tests.ts b/types/node-common-errors/node-common-errors-tests.ts new file mode 100644 index 0000000000..9554c31dff --- /dev/null +++ b/types/node-common-errors/node-common-errors-tests.ts @@ -0,0 +1,54 @@ +import * as errors from 'node-common-errors'; + +errors.log(new Error()); // $ExpectType Error +errors.log(new Error(), ''); // $ExpectType Error +errors.logError(new Error(), () => {}); // $ExpectType void + +errors.prependCurrentStack(new Error()); // $ExpectType Error + +// $ExpectType ErrorConstructor +errors.helpers.generateClass( + 'TestingError', + { + extends: new Error(), + globalize: false, + args: [], + generateMessage: () => '' + } +); + +new errors.Error('Testing'); // $ExpectType Error +new errors.AlreadyInUseError('Nobody', 'nothing'); // $ExpectType AlreadyInUseError +new errors.ArgumentNullError('nothing'); // $ExpectType ArgumentNullError +new errors.AuthenticationRequiredError('nothing'); // $ExpectType AuthenticationRequiredError +new errors.ConnectionError('nothing'); // $ExpectType ConnectionError +new errors.HttpStatusError(404); // $ExpectType HttpStatusError +new errors.InvalidOperationError('nothing'); // $ExpectType InvalidOperationError +new errors.SocketError('nothing'); // $ExpectType SocketError +new errors.NotFoundError('nothing'); // $ExpectType NotFoundError +new errors.NotImplementedError('nothing'); // $ExpectType NotImplementedError +new errors.NotPermittedError('nothing'); // $ExpectType NotPermittedError +new errors.NotSupportedError('nothing'); // $ExpectType NotSupportedError +new errors.RangeError('nothing'); // $ExpectType RangeError +new errors.ReferenceError('nothing'); // $ExpectType ReferenceError +new errors.StackOverflowError('nothing'); // $ExpectType StackOverflowError +new errors.SyntaxError('nothing'); // $ExpectType SyntaxError +new errors.TimeoutError('0ms'); // $ExpectType TimeoutError +new errors.TypeError('nothing'); // $ExpectType TypeError +new errors.URIError('nothing'); // $ExpectType URIError +new errors.ValidationError('nothing', 'no code', 'no field'); // $ExpectType ValidationError + +new errors.data.DataError('nothing'); // $ExpectType DataError +new errors.data.MemcachedError('nothing'); // $ExpectType MemcachedError +new errors.data.MongoDBError('nothing'); // $ExpectType MongoDBError +new errors.data.RedisError('nothing'); // $ExpectType RedisError +new errors.data.RollbackError('nothing'); // $ExpectType RollbackError +new errors.data.SQLError('nothing'); // $ExpectType SQLError +new errors.data.TransactionError('nothing'); // $ExpectType TransactionError + +new errors.io.IOError('nothing'); // $ExpectType IOError +new errors.io.DirectoryNotFoundError('nothing'); // $ExpectType DirectoryNotFoundError +new errors.io.DriveNotFoundError('nothing'); // $ExpectType DriveNotFoundError +new errors.io.EndOfStreamError('nothing'); // $ExpectType EndOfStreamError +new errors.io.FileLoadError('nothing'); // $ExpectType FileLoadError +new errors.io.FileNotFoundError('nothing'); // $ExpectType FileNotFoundError diff --git a/types/node-common-errors/tsconfig.json b/types/node-common-errors/tsconfig.json new file mode 100644 index 0000000000..c0221b2676 --- /dev/null +++ b/types/node-common-errors/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", + "node-common-errors-tests.ts" + ] +} diff --git a/types/node-common-errors/tslint.json b/types/node-common-errors/tslint.json new file mode 100644 index 0000000000..377cc837d4 --- /dev/null +++ b/types/node-common-errors/tslint.json @@ -0,0 +1 @@ +{ "extends": "../tslint.json" } From a83d90b89c30dbee81bd27da0c0fa9355df8e35f Mon Sep 17 00:00:00 2001 From: Brian Surowiec Date: Tue, 4 Apr 2017 18:56:23 -0400 Subject: [PATCH 168/844] Update options to use interface instead of any --- types/owlcarousel/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/owlcarousel/index.d.ts b/types/owlcarousel/index.d.ts index b7f67097a4..df2969a688 100644 --- a/types/owlcarousel/index.d.ts +++ b/types/owlcarousel/index.d.ts @@ -58,5 +58,5 @@ interface IOwlCarouselOptions { } interface JQuery { - owlCarousel(options?: any): JQuery; + owlCarousel(options?: IOwlCarouselOptions): JQuery; } From 363d8787e942b4c96962cc1c2e30222441a8653b Mon Sep 17 00:00:00 2001 From: Windz Date: Wed, 5 Apr 2017 12:12:49 +0800 Subject: [PATCH 169/844] Update index.d.ts add missing parameter `hasSeconds` to `later.parse.cron()` --- types/later/index.d.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/types/later/index.d.ts b/types/later/index.d.ts index 2e0d4de386..66bf8e5dae 100644 --- a/types/later/index.d.ts +++ b/types/later/index.d.ts @@ -152,8 +152,9 @@ declare namespace later { * Create schedule data by parsing a cron string * * @param {string} [input] - A string value to parse. + * @param {boolean} [hasSeconds] - Whether the cron expression has second part. */ - cron(input?: string): ScheduleData; + cron(input?: string, hasSeconds?: boolean): ScheduleData; /** * Create schedule data by paring a human readable string. From 61d3b0203bbdf28ce9d1e8ab2ab678013f15ce60 Mon Sep 17 00:00:00 2001 From: Wink Saville Date: Tue, 4 Apr 2017 15:43:11 -0700 Subject: [PATCH 170/844] Typescript declaration file for WebAssembly JS API --- types/webassembly-js-api/README.md | 17 +++ types/webassembly-js-api/index.d.ts | 103 ++++++++++++++++++ types/webassembly-js-api/tsconfig.json | 22 ++++ types/webassembly-js-api/tslint.json | 1 + .../webassembly-js-api-tests.ts | 75 +++++++++++++ 5 files changed, 218 insertions(+) create mode 100644 types/webassembly-js-api/README.md create mode 100644 types/webassembly-js-api/index.d.ts create mode 100644 types/webassembly-js-api/tsconfig.json create mode 100644 types/webassembly-js-api/tslint.json create mode 100644 types/webassembly-js-api/webassembly-js-api-tests.ts diff --git a/types/webassembly-js-api/README.md b/types/webassembly-js-api/README.md new file mode 100644 index 0000000000..a034040f92 --- /dev/null +++ b/types/webassembly-js-api/README.md @@ -0,0 +1,17 @@ +# WebAssembly typescript declaration file + +## Installation +``` +npm install @types/webassembly-js-api --save-dev +``` + +The WebAssembly namespace will now be available to your code TypeScript code. +See [WebAssembly JS API](http://webassembly.org/getting-started/js-api/) and the contents of +@types/webassembly-js-api/index.d.ts for more details. + +Do not use an `import * as WebAssembly from "webassembly-js-api"` as this will cause +the `tsc` to emit a `require` statement for the WebAssembly module which doesn't exist as +WebAssembly is part of the global namespace. + +Instead use a `///` statement. +Note: this `` maybe optional, but YMMV. diff --git a/types/webassembly-js-api/index.d.ts b/types/webassembly-js-api/index.d.ts new file mode 100644 index 0000000000..8912892200 --- /dev/null +++ b/types/webassembly-js-api/index.d.ts @@ -0,0 +1,103 @@ +/** + * WebAssembly v1 (MVP) declaration file for TypeScript + * Definitions by: 01alchemist (https://twitter.com/01alchemist) + * and Wink Saville + */ + +declare namespace WebAssembly { + /** + * WebAssembly.Module + */ + class Module { + constructor(bufferSource: ArrayBuffer | Uint8Array); + static customSections(module: Module, sectionName: string): ArrayBuffer[]; + static exports(module: Module): Array<{ + name: string; + kind: string; + }>; + static imports(module: Module): Array<{ + module: string; + name: string; + kind: string; + }>; + } + + /** + * WebAssembly.Instance + */ + class Instance { + readonly exports: any; + constructor(module: Module, importObject?: any); + } + + /** + * WebAssembly.Memory + * Note: A WebAssembly page has a constant size of 65,536 bytes, i.e., 64KiB. + */ + interface MemoryDescriptor { + initial: number; + maximum?: number; + } + + class Memory { + readonly buffer: ArrayBuffer; + constructor(memoryDescriptor: MemoryDescriptor); + grow(numPages: number): number; + } + + /** + * WebAssembly.Table + */ + interface TableDescriptor { + element: "anyfunc"; + initial: number; + maximum?: number; + } + + class Table { + readonly length: number; + constructor(tableDescriptor: TableDescriptor); + get(index: number): (args: any[]) => any; + grow(numElements: number): number; + set(index: number, value: (args: any[]) => any): void; + } + + /** + * Errors + */ + class CompileError extends Error { + readonly fileName: string; + readonly lineNumber: string; + readonly columnNumber: string; + constructor(message?: string, fileName?: string, lineNumber?: number); + toString(): string; + } + + class LinkError extends Error { + readonly fileName: string; + readonly lineNumber: string; + readonly columnNumber: string; + constructor(message?: string, fileName?: string, lineNumber?: number); + toString(): string; + } + + class RuntimeError extends Error { + readonly fileName: string; + readonly lineNumber: string; + readonly columnNumber: string; + constructor(message?: string, fileName?: string, lineNumber?: number); + toString(): string; + } + + function compile(bufferSource: ArrayBuffer | Uint8Array): Promise; + + interface ResultObject { + module: Module; + instance: Instance; + } + + function instantiate(bufferSource: ArrayBuffer | Uint8Array, importObject?: any): Promise; + function instantiate(module: Module, importObject?: any): Promise; + + function validate(bufferSource: ArrayBuffer | Uint8Array): boolean; +} diff --git a/types/webassembly-js-api/tsconfig.json b/types/webassembly-js-api/tsconfig.json new file mode 100644 index 0000000000..581bbbdf29 --- /dev/null +++ b/types/webassembly-js-api/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", + "webassembly-js-api-tests.ts" + ] +} diff --git a/types/webassembly-js-api/tslint.json b/types/webassembly-js-api/tslint.json new file mode 100644 index 0000000000..377cc837d4 --- /dev/null +++ b/types/webassembly-js-api/tslint.json @@ -0,0 +1 @@ +{ "extends": "../tslint.json" } diff --git a/types/webassembly-js-api/webassembly-js-api-tests.ts b/types/webassembly-js-api/webassembly-js-api-tests.ts new file mode 100644 index 0000000000..5b62354070 --- /dev/null +++ b/types/webassembly-js-api/webassembly-js-api-tests.ts @@ -0,0 +1,75 @@ +function debug(s: string) { + // debug(s) +} + +// Table +let table = new WebAssembly.Table({element: "anyfunc", initial: 1, maximum: 10}); +debug(`table.length=${table.length}`); +debug(`table.get(0)=${table.get(0)}`); +table.grow(1); + +// Memory +let memory = new WebAssembly.Memory({initial: 2, maximum: 8}); +debug(`memory.grow(6)=${memory.grow(6)}`); +let u8 = new Uint8Array(memory.buffer); +u8[0] = 1; +u8[1] = 2; +debug(`u8[0]=${u8[0]}`); +debug(`u8[1]=${u8[1]}`); + +let wasmDataU8 = new Uint8Array([0, 1, 2, 3, 4, 5, 6, 7]); +debug(`wasmDataU8.length=${wasmDataU8.length}`); +debug(`wasmDataU8[0]=${wasmDataU8[0].toString(16)}`); +debug(`wasmDataU8[1]=${wasmDataU8[1].toString(16)}`); +debug(`wasmDataU8[2]=${wasmDataU8[2].toString(16)}`); +debug(`wasmDataU8[3]=${wasmDataU8[3].toString(16)}`); +debug(`wasmDataU8[4]=${wasmDataU8[4].toString(16)}`); +debug(`wasmDataU8[5]=${wasmDataU8[5].toString(16)}`); +debug(`wasmDataU8[6]=${wasmDataU8[6].toString(16)}`); +debug(`wasmDataU8[7]=${wasmDataU8[7].toString(16)}`); + +// Validate +let valid = WebAssembly.validate(wasmDataU8); +debug("wasmDataU8 is " + (valid ? "" : "not ") + "a valid wasm wasmModule"); + +// Module +let wasmModule = new WebAssembly.Module(wasmDataU8); +debug(`wasmModule=${wasmModule}`); + +// CustomSections +let nameSections = WebAssembly.Module.customSections(wasmModule, "name"); +debug(`Module contains ${nameSections.length} name sections`); +if (nameSections.length !== 0) { + debug("Module contains a name section"); + debug(nameSections[0].toString()); +} + +// Instance +let instance = new WebAssembly.Instance(wasmModule); +debug(`instance=${instance}`); +debug(`instance.exports=${instance.exports}`); + +// Compile Asynchronously +debug("instantiateAsync compile:"); +WebAssembly.compile(wasmDataU8).then((mod: WebAssembly.Module) => { + debug(`instantiateAsync compiled: ${JSON.stringify(mod)}`); +}); + +// Instantiate +// Primary overload — taking wasm binary code +WebAssembly.instantiate(wasmDataU8).then((result: WebAssembly.ResultObject) => { + debug(`Primary overload mod=${result.module}`); + debug(`Primary overload inst=${result.instance}`); + debug(`Primary exec instance.exports.addTwo1(-1, 1)=${result.instance.exports.addTwo1(-1, 1)}`); +}); + +// Instantiate +// Secondary overload — taking a Module object +WebAssembly.instantiate(wasmModule).then((instance: WebAssembly.Instance) => { + debug(`Secondary overload instance=${instance}`); + debug(`Secondary exec instance.exports.addTwo1(0, -1)=${instance.exports.addTwo1(0, -1)}`); +}); + +// Validate +WebAssembly.validate(new ArrayBuffer(8)); +WebAssembly.validate(wasmDataU8); From be1f3e0efb5dd02f81ea25ac40a0c5c95bbb378e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?P=C3=A9ter=20Kov=C3=A1cs?= Date: Wed, 5 Apr 2017 08:37:49 +0200 Subject: [PATCH 171/844] [karma] Add constants object to karma module --- types/karma/index.d.ts | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/types/karma/index.d.ts b/types/karma/index.d.ts index 7755011ca6..59590b0a6d 100644 --- a/types/karma/index.d.ts +++ b/types/karma/index.d.ts @@ -28,8 +28,33 @@ declare namespace karma { stopper: Stopper; launcher: Launcher; VERSION: string; + constants: Constants; } + interface Constants { + VERSION: string; + DEFAULT_PORT: number; + DEFAULT_HOSTNAME: string; + DEFAULT_LISTEN_ADDR: string; + LOG_DISABLE: string; + LOG_ERROR: string; + LOG_WARN: string; + LOG_INFO: string; + LOG_DEBUG: string; + LOG_LOG: string; + LOG_PRIORITIES: string[]; + COLOR_PATTERN: string; + NO_COLOR_PATTERN: string; + CONSOLE_APPENDER: { + type: string; + layout: { + type: string; + pattern: string; + }; + }; + EXIT_CODE: string; + } + interface LauncherStatic { generateId(): string; //TODO: injector should be of type `di.Injector` From e78654cf6928b3f311b0414105db0f27e0744b5b Mon Sep 17 00:00:00 2001 From: Jan Brecka Date: Wed, 5 Apr 2017 10:34:20 +0200 Subject: [PATCH 172/844] Improve types by adding interfaces --- types/google-map-react/index.d.ts | 42 +++++++++++++++++++++++++------ 1 file changed, 34 insertions(+), 8 deletions(-) diff --git a/types/google-map-react/index.d.ts b/types/google-map-react/index.d.ts index 98fb290e5d..aedf13e13a 100644 --- a/types/google-map-react/index.d.ts +++ b/types/google-map-react/index.d.ts @@ -48,10 +48,38 @@ export interface Maps { UnitSystem: any; } +export interface Bounds { + nw: number; + ne: number; + sw: number; + se: number; +} + +export interface Point { + x: number; + y: number; +} + +export interface Coords { + lat: number; + lng: number; +} + +export interface ClickEventValue extends Point, Coords { + event: any; +} + +export interface ChangeEventValue { + center: Coords; + zoom: number; + bounds: Bounds; + marginBounds: Bounds; +} + export interface Props { bootstrapURLKeys?: BootstrapURLKeys; - defaultCenter?: [number, number] | { lat: number, lng: number }; - center?: [number, number] | { lat: number, lng: number }; + defaultCenter?: Coords; + center?: Coords; defaultZoom?: number; zoom?: number; hoverDistance?: number; @@ -59,8 +87,8 @@ 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?(value: ClickEventValue): any; + onChange?(value: ChangeEventValue): any; resetBoundsOnResize?: boolean; onChildClick?(hoverKey: any, childProps: any): void; onChildMouseEnter?(hoverKey: any, childProps: any): void; @@ -68,7 +96,7 @@ export interface Props { onZoomAnimationStart?(args: any): void; onZoomAnimationEnd?(args: any): void; onMapTypeIdChange?(args: any): void; - distanceToMouse?(pt: {x: number, y: number}, mousePos: {x: number, y: number}): void; + distanceToMouse?(pt: Point, mousePos: Point): void; googleMapLoader?(bootstrapURLKeys: any): void; onGoogleApiLoaded?({map, maps}: { map: any, maps: any }): void; yesIWantToUseGoogleMapApiInternals?: boolean; @@ -76,8 +104,6 @@ export interface Props { export default class GoogleMapReact extends React.Component {} -export interface ChildComponentProps { - lat: number; - lng: number; +export interface ChildComponentProps extends Coords { $hover?: boolean; } From 21334d2ae1046dbed8a15a3ea5b45c6cbe65db81 Mon Sep 17 00:00:00 2001 From: Stephan Classen Date: Wed, 5 Apr 2017 11:55:39 +0200 Subject: [PATCH 173/844] add types for angular-block-ui --- .../angular-block-ui-tests.ts | 41 +++++ types/angular-block-ui/index.d.ts | 171 ++++++++++++++++++ types/angular-block-ui/tsconfig.json | 23 +++ types/angular-block-ui/tslint.json | 1 + 4 files changed, 236 insertions(+) create mode 100644 types/angular-block-ui/angular-block-ui-tests.ts create mode 100644 types/angular-block-ui/index.d.ts create mode 100644 types/angular-block-ui/tsconfig.json create mode 100644 types/angular-block-ui/tslint.json diff --git a/types/angular-block-ui/angular-block-ui-tests.ts b/types/angular-block-ui/angular-block-ui-tests.ts new file mode 100644 index 0000000000..c3c69345c9 --- /dev/null +++ b/types/angular-block-ui/angular-block-ui-tests.ts @@ -0,0 +1,41 @@ +var app: angular.IModule = angular.module('at', ['blockUI']); + +app.config((blockUIConfig: angular.blockUI.IBlockUIConfig) => { + blockUIConfig.message = 'Please stop clicking!'; + blockUIConfig.delay = 100; + blockUIConfig.template = '
    {{ state | json }}
    '; + blockUIConfig.templateUrl = 'my-templates/block-ui-overlay.html'; + blockUIConfig.autoBlock = false; + blockUIConfig.resetOnException = false; + blockUIConfig.autoInjectBodyBlock = false; + blockUIConfig.cssClass = 'block-ui my-custom-class'; + blockUIConfig.blockBrowserNavigation = true; + + blockUIConfig.requestFilter = function (config) { + if (config.url.match(/^\/api\/quote($|\/).*/)) { + return false; + } + return true; + }; + + blockUIConfig.requestFilter = function (config) { + if (config.url.match(/^\/api\/quote($|\/).*/)) { + return 'Hello World'; + } + return 'Loading...'; + }; +}); + +app.controller('Ctrl', ($scope: ng.IScope, blockUI: angular.blockUI.IBlockUIService) => { + blockUI.start(); + blockUI.start('Hello'); + blockUI.start({}); + blockUI.start({message: 'World'}); + blockUI.start({delay: 100}); + + blockUI.stop(); + blockUI.reset(); + blockUI.message("Hello Types"); + blockUI.done(); + let b: boolean = blockUI.isBlocking(); +}); diff --git a/types/angular-block-ui/index.d.ts b/types/angular-block-ui/index.d.ts new file mode 100644 index 0000000000..4e67dbcb52 --- /dev/null +++ b/types/angular-block-ui/index.d.ts @@ -0,0 +1,171 @@ +// Type definitions for angular-block-ui v0.2.2 +// Project: https://github.com/McNull/angular-block-ui +// Definitions by: Lasse Nørregaard , Stephan Classen +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +/// + +import * as angular from 'angular'; + +declare module 'angular' { + export namespace blockUI { + + interface IBlockUIConfig { + /** + * Changes the default message to be used when no message + * has been provided to the start method of the service. + * + * Default value is 'Loading ...'. + */ + message?: string; + + /** + * Specifies the amount in milliseconds before the block + * is visible to the user. By delaying a visible block your + * application will appear more responsive. + * + * The default value is 250. + */ + delay?: number; + + /** + * Specifies a custom template to use as the overlay. + */ + template?: string; + + /** + * Specifies a url to retrieve the template from. + * The current release only works with pre-cached templates, + * which means that this url should be known in the + * $templateCache service of Angular. + * + * If you're using the grunt with html2js or angular-templates, + * which I highly recommend, you're already set. + */ + templateUrl?: string; + + /** + * By default the BlockUI module will start a block whenever + * the Angular $http service has an pending request. + * + * If you don't want this behaviour and want to do all the + * blocking manually you can change this value to false. + */ + autoBlock?: boolean; + + /** + * By default the BlockUI module will reset the block count and + * hide the overlay whenever an exception has occurred. + * + * You can set this value to false if you don't want this behaviour. + */ + resetOnException?: boolean; + + /** + * Allows you to specify a filter function to exclude certain ajax + * requests from blocking the user interface. + * The blockUI service will ignore requests when the function returns `false`. + * + * If the filter function returns a string it will be passed as the message + * argument to the start method of the service. + * + * @param {angular.IRequestConfig} config - the Angular request config object. + * + */ + requestFilter?: (config: angular.IRequestConfig) => (string | boolean); + + /** + * When the module is started it will inject the main block element + * by adding the block-ui directive to the body element. + */ + autoInjectBodyBlock?: boolean; + + /** + * A string containing the default css classes, separated by spaces, + * that should be applied to each block-ui element. + * + * The default value is `block-ui block-ui-anim-fade` + */ + cssClass?: string; + + /** + * Whenever a user interface block is active, because the single page + * application is still waiting for a response from the backend server, + * the user can still navigate away using the back and forward buttons + * of the browser. + * + * Callbacks registered to handle the responses from the server will + * be executed even if a different view/controller is currently active. + * By setting the blockBrowserNavigation property to true the + * angular-block-ui module will prevent navigation while a fullscreen + * block is active. + * + * Programatic location changes via the $location service are still + * allowed however. + * The navigation block is disabled by default. + */ + blockBrowserNavigation?: boolean; + } + + interface IBlockUIService { + /** + * The start method will start the user interface block. + * Because multiple user interface elements can request + * a user interface block at the same time, the service + * keeps track of the number of start calls. + * + * Each call to start() will increase the count and every + * call to stop() will decrease the value. + * Whenever the count reaches 0 the block will end. + * + * Note: By default the block is immediately active after + * calling this method, but to prevent trashing the user + * interface each time a button is pressed, the block is + * visible after a short delay. + * + * This behaviour can be modified in the configuration. + * + * @param {string|IBlockUIConfig} messageOrOptions - + * Either supply the message (string) to be show in the + * overlay or specify an IBlockUIConfig object that will be + * merged/extended into the block ui instance state. + * If no argument is specified the default text message + * from the configuration is used. + */ + start: (messageOrOptions?: (string | IBlockUIConfig)) => void; + + /** + * This will decrease the block count. + * + * The block will end if the count is 0. + */ + stop: () => void; + + /** + * The reset will force an unblock by setting the block count to 0. + */ + reset: () => void; + + /** + * Queues a callback function to be called when the block has finished. + * + * This can be useful whenever you wish to redirect the user + * to a different location while there are still pending AJAX requests. + */ + done: () => void; + + /** + * Allows the message shown in the overlay to be updated + * while to block is active. + * + * @param {string} message - The message to show in the overlay. + */ + message: (message: string) => void; + + /** + * Returns whether currently a block is shown for the instance or not. + */ + isBlocking: () => boolean; + } + } +} diff --git a/types/angular-block-ui/tsconfig.json b/types/angular-block-ui/tsconfig.json new file mode 100644 index 0000000000..b1b705a6e5 --- /dev/null +++ b/types/angular-block-ui/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", + "angular-block-ui-tests.ts" + ] +} diff --git a/types/angular-block-ui/tslint.json b/types/angular-block-ui/tslint.json new file mode 100644 index 0000000000..377cc837d4 --- /dev/null +++ b/types/angular-block-ui/tslint.json @@ -0,0 +1 @@ +{ "extends": "../tslint.json" } From 714e405e324614def731875f7831e5f6ee38b9fe Mon Sep 17 00:00:00 2001 From: Stephan Classen Date: Wed, 5 Apr 2017 12:29:52 +0200 Subject: [PATCH 174/844] fix lint warnings --- .../angular-block-ui-tests.ts | 10 ++++---- types/angular-block-ui/index.d.ts | 23 +++++++++---------- 2 files changed, 16 insertions(+), 17 deletions(-) diff --git a/types/angular-block-ui/angular-block-ui-tests.ts b/types/angular-block-ui/angular-block-ui-tests.ts index c3c69345c9..4b3903f9cc 100644 --- a/types/angular-block-ui/angular-block-ui-tests.ts +++ b/types/angular-block-ui/angular-block-ui-tests.ts @@ -1,6 +1,6 @@ -var app: angular.IModule = angular.module('at', ['blockUI']); +let app: angular.IModule = angular.module('at', ['blockUI']); -app.config((blockUIConfig: angular.blockUI.IBlockUIConfig) => { +app.config((blockUIConfig: angular.blockUI.BlockUIConfig) => { blockUIConfig.message = 'Please stop clicking!'; blockUIConfig.delay = 100; blockUIConfig.template = '
    {{ state | json }}
    '; @@ -11,14 +11,14 @@ app.config((blockUIConfig: angular.blockUI.IBlockUIConfig) => { blockUIConfig.cssClass = 'block-ui my-custom-class'; blockUIConfig.blockBrowserNavigation = true; - blockUIConfig.requestFilter = function (config) { + blockUIConfig.requestFilter = (config) => { if (config.url.match(/^\/api\/quote($|\/).*/)) { return false; } return true; }; - blockUIConfig.requestFilter = function (config) { + blockUIConfig.requestFilter = (config) => { if (config.url.match(/^\/api\/quote($|\/).*/)) { return 'Hello World'; } @@ -26,7 +26,7 @@ app.config((blockUIConfig: angular.blockUI.IBlockUIConfig) => { }; }); -app.controller('Ctrl', ($scope: ng.IScope, blockUI: angular.blockUI.IBlockUIService) => { +app.controller('Ctrl', ($scope: ng.IScope, blockUI: angular.blockUI.BlockUIService) => { blockUI.start(); blockUI.start('Hello'); blockUI.start({}); diff --git a/types/angular-block-ui/index.d.ts b/types/angular-block-ui/index.d.ts index 4e67dbcb52..6b0f59f910 100644 --- a/types/angular-block-ui/index.d.ts +++ b/types/angular-block-ui/index.d.ts @@ -5,12 +5,11 @@ /// -import * as angular from 'angular'; +import * as angular from "angular"; declare module 'angular' { - export namespace blockUI { - - interface IBlockUIConfig { + namespace blockUI { + interface BlockUIConfig { /** * Changes the default message to be used when no message * has been provided to the start method of the service. @@ -72,7 +71,7 @@ declare module 'angular' { * @param {angular.IRequestConfig} config - the Angular request config object. * */ - requestFilter?: (config: angular.IRequestConfig) => (string | boolean); + requestFilter?(config: angular.IRequestConfig): (string | boolean); /** * When the module is started it will inject the main block element @@ -107,7 +106,7 @@ declare module 'angular' { blockBrowserNavigation?: boolean; } - interface IBlockUIService { + interface BlockUIService { /** * The start method will start the user interface block. * Because multiple user interface elements can request @@ -132,19 +131,19 @@ declare module 'angular' { * If no argument is specified the default text message * from the configuration is used. */ - start: (messageOrOptions?: (string | IBlockUIConfig)) => void; + start(messageOrOptions?: (string | BlockUIConfig)): void; /** * This will decrease the block count. * * The block will end if the count is 0. */ - stop: () => void; + stop(): void; /** * The reset will force an unblock by setting the block count to 0. */ - reset: () => void; + reset(): void; /** * Queues a callback function to be called when the block has finished. @@ -152,7 +151,7 @@ declare module 'angular' { * This can be useful whenever you wish to redirect the user * to a different location while there are still pending AJAX requests. */ - done: () => void; + done(): void; /** * Allows the message shown in the overlay to be updated @@ -160,12 +159,12 @@ declare module 'angular' { * * @param {string} message - The message to show in the overlay. */ - message: (message: string) => void; + message(message: string): void; /** * Returns whether currently a block is shown for the instance or not. */ - isBlocking: () => boolean; + isBlocking(): boolean; } } } From 1b450892d170e1b18380977915d881e90279e529 Mon Sep 17 00:00:00 2001 From: ipoul Date: Wed, 5 Apr 2017 14:02:34 +0200 Subject: [PATCH 175/844] Add types for tinymce autosave plugin --- types/tinymce/index.d.ts | 12 +++++++++++- types/tinymce/tinymce-tests.ts | 8 +++++++- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/types/tinymce/index.d.ts b/types/tinymce/index.d.ts index 70d73315ea..cbb6f578b1 100644 --- a/types/tinymce/index.d.ts +++ b/types/tinymce/index.d.ts @@ -1,6 +1,6 @@ // Type definitions for TinyMCE 4.5 // Project: https://github.com/tinymce/tinymce -// Definitions by: Martin Duparc +// Definitions by: Martin Duparc , Poul Poulsen // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // Work In Progress @@ -266,6 +266,16 @@ export namespace tinymce { object_resizing?: boolean | string; type_ahead_urls?: boolean; + + autosave_ask_before_unload?: boolean; + + autosave_interval?: string; + + autosave_prefix?: string; + + autosave_restore_when_empty? : boolean; + + autosave_retention?: string; } namespace settings { diff --git a/types/tinymce/tinymce-tests.ts b/types/tinymce/tinymce-tests.ts index 7165ab25a7..98703f070d 100644 --- a/types/tinymce/tinymce-tests.ts +++ b/types/tinymce/tinymce-tests.ts @@ -7,8 +7,14 @@ tinymce.init({ plugins: [ 'advlist autolink lists link image charmap print preview anchor', 'searchreplace visualblocks code fullscreen', - 'insertdatetime media table contextmenu paste code' + 'insertdatetime media table contextmenu paste code', + 'autosave' ], + autosave_ask_before_unload: false, + autosave_interval: "20s", + autosave_prefix: "tinymce-autosave-{path}{query}-{id}-", + autosave_restore_when_empty: false, + autosave_retention: "30m", toolbar: 'undo redo | insert | styleselect | bold italic | alignleft aligncenter alignright alignjustify | bullist numlist outdent indent | link image', content_css: '//www.tinymce.com/css/codepen.min.css' }); From 483e80063c88c47c75950e6d203ed14e2106187a Mon Sep 17 00:00:00 2001 From: "s.atanasov@everybag.de" Date: Wed, 5 Apr 2017 14:09:55 +0200 Subject: [PATCH 176/844] Fixed definistions that were giving me errors on my working code. Added test cases for the changes. --- types/knex/index.d.ts | 4 ++-- types/knex/knex-tests.ts | 7 +++++++ 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/types/knex/index.d.ts b/types/knex/index.d.ts index ec5fecf95a..3d83830a70 100644 --- a/types/knex/index.d.ts +++ b/types/knex/index.d.ts @@ -345,7 +345,7 @@ declare namespace Knex { hasTable(tableName: string): Promise; hasColumn(tableName: string, columnName: string): Promise; table(tableName: string, callback: (tableBuilder: AlterTableBuilder) => any): Promise; - dropTableIfExists(tableName: string): Promise; + dropTableIfExists(tableName: string): SchemaBuilder; raw(statement: string): SchemaBuilder; withSchema(schemaName: string): SchemaBuilder; } @@ -428,7 +428,7 @@ declare namespace Knex { index(indexName?: string, indexType?: string): ColumnBuilder; } - interface ReferencingColumnBuilder { + interface ReferencingColumnBuilder extends ColumnBuilder { inTable(tableName: string): ColumnBuilder; } diff --git a/types/knex/knex-tests.ts b/types/knex/knex-tests.ts index 6e49702faf..80b6d802c5 100644 --- a/types/knex/knex-tests.ts +++ b/types/knex/knex-tests.ts @@ -667,3 +667,10 @@ knex.seed.make(name); knex.seed.run(config); knex.seed.run(); + + +knex.schema + .dropTableIfExists('A') + .createTable('A', table => { + table.integer('C').unsigned().references('B.id').notNullable(); + }); From 7a5972244cf2cbf8b67b56b489b55e7f51543c08 Mon Sep 17 00:00:00 2001 From: ipoul Date: Wed, 5 Apr 2017 14:19:34 +0200 Subject: [PATCH 177/844] Removed space before colon in property-declaration --- types/tinymce/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/tinymce/index.d.ts b/types/tinymce/index.d.ts index cbb6f578b1..14817302a8 100644 --- a/types/tinymce/index.d.ts +++ b/types/tinymce/index.d.ts @@ -273,7 +273,7 @@ export namespace tinymce { autosave_prefix?: string; - autosave_restore_when_empty? : boolean; + autosave_restore_when_empty?: boolean; autosave_retention?: string; } From c0577e2ff84694b649241166a3b9fe2569d4fa0d Mon Sep 17 00:00:00 2001 From: Matt DeKrey Date: Wed, 5 Apr 2017 07:30:50 -0500 Subject: [PATCH 178/844] Update R.sortBy to accept Ord, per documentation http://ramdajs.com/docs/#sortBy --- types/ramda/index.d.ts | 6 +++--- types/ramda/ramda-tests.ts | 18 ++++++++++++++++++ 2 files changed, 21 insertions(+), 3 deletions(-) diff --git a/types/ramda/index.d.ts b/types/ramda/index.d.ts index aa84cad395..dab9a8d0e4 100644 --- a/types/ramda/index.d.ts +++ b/types/ramda/index.d.ts @@ -1,6 +1,6 @@ // Type definitions for ramda // Project: https://github.com/donnut/typescript-ramda -// Definitions by: Erwin Poeze +// Definitions by: Erwin Poeze , Matt DeKrey // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped declare var R: R.Static; @@ -1402,8 +1402,8 @@ declare namespace R { /** * Sorts the list according to a key generated by the supplied function. */ - sortBy(fn: (a: any) => string, list: T[]): T[]; - sortBy(fn: (a: any) => string): (list: T[]) => T[]; + sortBy(fn: (a: any) => Ord, list: T[]): T[]; + sortBy(fn: (a: any) => Ord): (list: T[]) => T[]; /** * Splits a string into an array of strings based on the given diff --git a/types/ramda/ramda-tests.ts b/types/ramda/ramda-tests.ts index 13aeb222f7..b7465e1773 100644 --- a/types/ramda/ramda-tests.ts +++ b/types/ramda/ramda-tests.ts @@ -1617,6 +1617,24 @@ matchPhrases(['foo', 'bar', 'baz']); R.path(testPath)(testObj); //=> 2 } +() => { + var sortByAgeDescending = R.sortBy(R.compose(R.negate, R.prop('age'))); + var alice = { + name: 'ALICE', + age: 101 + }; + var bob = { + name: 'Bob', + age: -10 + }; + var clara = { + name: 'clara', + age: 314.159 + }; + var people = [clara, bob, alice]; + sortByAgeDescending(people); //=> [alice, bob, clara] +} + () => { var sortByNameCaseInsensitive = R.sortBy(R.compose(R.toLower, R.prop('name'))); var alice = { From ce28686a4e1e92868464c3f7e112cd01f68efa61 Mon Sep 17 00:00:00 2001 From: Sarah Scott Date: Wed, 5 Apr 2017 15:38:55 +0200 Subject: [PATCH 179/844] adds types for react native flatlist component --- types/react-native/index.d.ts | 163 ++++++++++++++++++++++++++++++++++ 1 file changed, 163 insertions(+) diff --git a/types/react-native/index.d.ts b/types/react-native/index.d.ts index e282f17191..ddc2560447 100644 --- a/types/react-native/index.d.ts +++ b/types/react-native/index.d.ts @@ -3409,6 +3409,166 @@ export interface ImageStatic extends NativeMethodsMixin, React.ComponentClass> } +/** + * @see https://facebook.github.io/react-native/docs/flatlist.html#props + */ +export interface FlatListProperties extends React.Props { + + /** + * Rendered in between each item, but not at the top or bottom + */ + ItemSeparatorComponent?: React.ComponentClass + + /** + * Rendered at the bottom of all the items. + */ + ListFooterComponent?: React.ComponentClass + + /** + * Rendered at the top of all the items. + */ + ListHeaderComponent?: React.ComponentClass + + /** + * Optional custom style for multi-item rows generated when numColumns > 1 + */ + columnWrapperStyle?: ViewStyle + + /** + * For simplicity, data is just a plain array. If you want to use something else, + * like an immutable list, use the underlying VirtualizedList directly. + */ + data?: any[] + + /** + * `getItemLayout` is an optional optimization that lets us skip measurement of dynamic + * content if you know the height of items a priori. getItemLayout is the most efficient, + * and is easy to use if you have fixed height items, for example: + * ``` + * getItemLayout={(data, index) => ( + * {length: ITEM_HEIGHT, offset: ITEM_HEIGHT * index, index} + * )} + * ``` + * Remember to include separator length (height or width) in your offset calculation if you specify + * `ItemSeparatorComponent`. + */ + getItemLayout?: (data: Array, index: number) => {length: number, offset: number, index: number} + + /** + * If true, renders items next to each other horizontally instead of stacked vertically. + */ + horizontal?: boolean + + /** + * Used to extract a unique key for a given item at the specified index. Key is used for caching + * and as the react key to track item re-ordering. The default extractor checks `item.key`, then + * falls back to using the index, like React does. + */ + keyExtractor?: (item: any, index: number) => string + + legacyImplementation?: boolean + + /** + * Multiple columns can only be rendered with `horizontal={false}` and will zig-zag like a `flexWrap` layout. + * Items should all be the same height - masonry layouts are not supported. + */ + numColumns?: number + + /** + * Called once when the scroll position gets within onEndReachedThreshold of the rendered content. + */ + onEndReached?: (info: {distanceFromEnd: number}) => void + + /** + * How far from the end (in units of visible length of the list) the bottom edge of the + * list must be from the end of the content to trigger the `onEndReached` callback. + * Thus a value of 0.5 will trigger `onEndReached` when the end of the content is + * within half the visible length of the list. + */ + onEndReachedThreshold?: number + + /** + * If provided, a standard RefreshControl will be added for "Pull to Refresh" functionality. + * Make sure to also set the refreshing prop correctly. + */ + onRefresh?: () => void + + /** + * Called when the viewability of rows changes, as defined by the `viewablePercentThreshold` prop. + */ + onViewableItemsChanged?: (info: {viewableItems: Array, changed: Array}) => void + + /** + * Set this true while waiting for new data from a refresh. + */ + refreshing?: boolean + + /** + * Takes an item from data and renders it into the list. Typical usage: + * ``` + * _renderItem = ({item}) => ( + * this._onPress(item)}> + * {item.title}} + * + * ); + * ... + * + * ``` + * Provides additional metadata like `index` if you need it. + */ + renderItem: (info: any) => React.ReactElement + + /** + * See `ViewabilityHelper` for flow type and further documentation. + */ + viewabilityConfig?: any + + ref?: React.Ref +} + +export interface FlatListStatic extends React.ComponentClass { + + /** + * Exports some data, e.g. for perf investigations or analytics. + */ + getMetrics: () => { + contentLength: number, + totalRows: number, + renderedRows: number, + visibleRows: number, + } + + /** + * Scrolls to the end of the content. May be janky without `getItemLayout` prop. + */ + scrollToEnd:(params?: {animated?: boolean}) => void + + /** + * Scrolls to the item at a the specified index such that it is positioned in the viewable area + * such that `viewPosition` 0 places it at the top, 1 at the bottom, and 0.5 centered in the middle. + * May be janky without `getItemLayout` prop. + */ + scrollToIndex:(params: {animated?: boolean, index: number, viewPosition?: number}) => void + + /** + * Requires linear scan through data - use `scrollToIndex` instead if possible. + * May be janky without `getItemLayout` prop. + */ + scrollToItem:(params: {animated?: boolean, index: number, viewPosition?: number}) => void + + /** + * Scroll to a specific content pixel offset, like a normal `ScrollView`. + */ + scrollToOffset:(params: {animated?: boolean, offset: number}) => void + + /** + * Tells the list an interaction has occured, which should trigger viewability calculations, + * e.g. if waitForInteractions is true and the user has not scrolled. This is typically called + * by taps on items or by navigation actions. + */ + recordInteraction: () => void +} + /** * @see https://facebook.github.io/react-native/docs/listview.html#props */ @@ -8154,6 +8314,9 @@ export type Image = ImageStatic export var ImagePickerIOS: ImagePickerIOSStatic export type ImagePickerIOS = ImagePickerIOSStatic +export var FlatList: FlatListStatic +export type FlatList = FlatListStatic + export var LayoutAnimation: LayoutAnimationStatic export type LayoutAnimation = LayoutAnimationStatic From 59c166a77c104d4750282e7ce59af5e0cc8b124f Mon Sep 17 00:00:00 2001 From: Andy Date: Wed, 5 Apr 2017 07:19:19 -0700 Subject: [PATCH 180/844] fast-simplex-noise: Provides its own types (#15635) --- notNeededPackages.json | 6 ++ .../fast-simplex-noise-tests.ts | 28 ------ types/fast-simplex-noise/index.d.ts | 94 ------------------- types/fast-simplex-noise/tsconfig.json | 22 ----- 4 files changed, 6 insertions(+), 144 deletions(-) delete mode 100644 types/fast-simplex-noise/fast-simplex-noise-tests.ts delete mode 100644 types/fast-simplex-noise/index.d.ts delete mode 100644 types/fast-simplex-noise/tsconfig.json diff --git a/notNeededPackages.json b/notNeededPackages.json index 274f8f829b..9c973fac3e 100644 --- a/notNeededPackages.json +++ b/notNeededPackages.json @@ -72,6 +72,12 @@ "sourceRepoURL": "https://github.com/bterlson/ecmarkup", "asOfVersion": "3.4.0" }, + { + "libraryName": "FastSimplexNoise", + "typingsPackageName": "fast-simplex-noise", + "sourceRepoURL": "https://www.npmjs.com/package/fast-simplex-noise", + "asOfVersion": "3.0.0" + }, { "libraryName": "FineUploader", "typingsPackageName": "fine-uploader", diff --git a/types/fast-simplex-noise/fast-simplex-noise-tests.ts b/types/fast-simplex-noise/fast-simplex-noise-tests.ts deleted file mode 100644 index 584ff3ad04..0000000000 --- a/types/fast-simplex-noise/fast-simplex-noise-tests.ts +++ /dev/null @@ -1,28 +0,0 @@ - -import FastSimplexNoise = require('fast-simplex-noise') - -var defaultNoiseGen: FastSimplexNoise = new FastSimplexNoise() -var emptyOptionsNoiseGen: FastSimplexNoise = new FastSimplexNoise({}) - -var noiseGen: FastSimplexNoise = new FastSimplexNoise({ - amplitude: 1, - frequency: 0.01, - max: 255, - min: 0, - octaves: 8, - persistence: 0.5, - random: Math.random -}) - -var values: number[] = [] - -values.push(noiseGen.cylindrical2D(5, 1, 1)) -values.push(noiseGen.cylindrical3D(5, 1, 1, 1)) -values.push(noiseGen.in2D(1, 1)) -values.push(noiseGen.in3D(1, 1, 1)) -values.push(noiseGen.in4D(1, 1, 1, 1)) -values.push(noiseGen.raw2D(1, 1)) -values.push(noiseGen.raw3D(1, 1, 1)) -values.push(noiseGen.raw4D(1, 1, 1, 1)) -values.push(noiseGen.spherical2D(5, 1, 1)) -values.push(noiseGen.spherical3D(5, 1, 1, 1)) diff --git a/types/fast-simplex-noise/index.d.ts b/types/fast-simplex-noise/index.d.ts deleted file mode 100644 index 14df3351ef..0000000000 --- a/types/fast-simplex-noise/index.d.ts +++ /dev/null @@ -1,94 +0,0 @@ -// Type definitions for FastSimplexNoise v2.1.1 -// Project: https://www.npmjs.com/package/fast-simplex-noise -// Definitions by: Tobias Cohen -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -/** - * A JavaScript implementation of the improved, faster Simplex algorithm outlined in Stefan Gustavson's Simplex noise demystified. - * - * Convenience functions have been added as well, in order to avoid needing to scale and handle the raw noise data directly. - */ -declare class FastSimplexNoise { - amplitude: number; - frequency: number; - max: number; - min: number; - octaves: number; - persistence: number; - random: ()=>number; - - /** - * Options is an optional object that can contain: - * - * amplitude: float - The base amplitude (default: 1.0) - * frequency: float - The base frequency (default: 1.0) - * max: float - The maximum scaled value to return (effective default: 1.0) - * min: float - The minimum scaled value to return (effective default: -1.0) - * octaves: integer - The number of octaves to sum for noise generation (default: 1) - * persistence: float - The persistence of amplitude per octave (default: 0.5) - * random: function - A function that generates random values between 0 and 1 (default: Math.random) - */ - constructor(options?: { - amplitude?: number; - frequency?: number; - max?: number; - min?: number; - octaves?: number; - persistence?: number; - random?: ()=>number; - }); - - /** - * Get a noise value between min and max for a point (x,y) on the surface of a cylinder with circumference c. - */ - cylindrical2D(c: number, x: number, y: number): number; - - /** - * Get a noise value between min and max for a point (x, y, z) on the surface of a cylinder with circumference c. - */ - cylindrical3D(c: number, x: number, y: number, z: number): number; - - /** - * Get a noise value between min and max at the 2D coordinate (x,y) in summed octaves, using amplitude, frequency, and persistence values. - */ - in2D(x: number, y: number): number; - - /** - * Get a noise value between min and max at the 3D coordinate (x,y,z) in summed octaves, using amplitude, frequency, and persistence values. - */ - in3D(x: number, y: number, z: number): number; - - /** - * Get a noise value between min and max at the 4D coordinate (x,y,z,w) in summed octaves, using amplitude, frequency, and persistence values. - */ - in4D(x: number, y: number, z: number, w: number): number; - - /** - * Get a noise value [-1, 1] at the 2D coordinate (x,y). - */ - raw2D(x: number, y: number): number; - - /** - * Get a noise value [-1, 1] at the 3D coordinate (x,y,z). - */ - raw3D(x: number, y: number, z: number): number; - - /** - * Get a noise value [-1, 1] at the 4D coordinate (x,y,z,w). - */ - raw4D(x: number, y: number, z: number, w: number): number; - - /** - * Get a noise value between min and max for a point (x, y) on the surface of a sphere with circumference c. - */ - spherical2D(c: number, x: number, y: number): number; - - /** - * Get a noise value between min and max for a point (x, y, z) on the surface of a sphere with circumference c. - */ - spherical3D(c: number, x: number, y: number, z: number): number; -} - -declare module "fast-simplex-noise" { - export = FastSimplexNoise; -} diff --git a/types/fast-simplex-noise/tsconfig.json b/types/fast-simplex-noise/tsconfig.json deleted file mode 100644 index 396315e587..0000000000 --- a/types/fast-simplex-noise/tsconfig.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "compilerOptions": { - "module": "commonjs", - "lib": [ - "es6" - ], - "noImplicitAny": true, - "noImplicitThis": true, - "strictNullChecks": false, - "baseUrl": "../", - "typeRoots": [ - "../" - ], - "types": [], - "noEmit": true, - "forceConsistentCasingInFileNames": true - }, - "files": [ - "index.d.ts", - "fast-simplex-noise-tests.ts" - ] -} \ No newline at end of file From 30cb6de3897204420de33d7d226a340e8f2c7b4a Mon Sep 17 00:00:00 2001 From: Andy Date: Wed, 5 Apr 2017 08:35:15 -0700 Subject: [PATCH 181/844] Update engine version for tests (#15622) --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 77e57cbb44..aa9eeed0ff 100644 --- a/package.json +++ b/package.json @@ -12,7 +12,7 @@ "url": "https://github.com/DefinitelyTyped/DefinitelyTyped/issues" }, "engines": { - "node": ">= 6.9.1" + "node": ">=7.8.0" }, "scripts": { "compile-scripts": "tsc -p scripts", From e2f264c1b3439adf9d3cba7b5538588b002bbb2a Mon Sep 17 00:00:00 2001 From: Andy Date: Wed, 5 Apr 2017 08:35:55 -0700 Subject: [PATCH 182/844] cheap-ruler: Provides its own types (#15643) --- notNeededPackages.json | 6 + types/cheap-ruler/cheap-ruler-tests.ts | 61 ------- types/cheap-ruler/index.d.ts | 216 ------------------------- types/cheap-ruler/tsconfig.json | 22 --- 4 files changed, 6 insertions(+), 299 deletions(-) delete mode 100644 types/cheap-ruler/cheap-ruler-tests.ts delete mode 100644 types/cheap-ruler/index.d.ts delete mode 100644 types/cheap-ruler/tsconfig.json diff --git a/notNeededPackages.json b/notNeededPackages.json index 9c973fac3e..8b83fb195e 100644 --- a/notNeededPackages.json +++ b/notNeededPackages.json @@ -36,6 +36,12 @@ "sourceRepoURL": "https://github.com/blakeembrey/change-case", "asOfVersion": "2.3.1" }, + { + "libraryName": "cheap-ruler", + "typingsPackageName": "cheap-ruler", + "sourceRepoURL": "https://github.com/mapbox/cheap-ruler", + "asOfVersion": "2.5.0" + }, { "libraryName": "constant-case", "typingsPackageName": "constant-case", diff --git a/types/cheap-ruler/cheap-ruler-tests.ts b/types/cheap-ruler/cheap-ruler-tests.ts deleted file mode 100644 index 8197622eae..0000000000 --- a/types/cheap-ruler/cheap-ruler-tests.ts +++ /dev/null @@ -1,61 +0,0 @@ -import * as cheapRuler from 'cheap-ruler' - -// -- Fixtures -- -const bbox = [30.5, 50.5, 31, 51] -const point1 = [30.5, 50.5] -const point2 = [30.51, 50.49] -const unit = 'miles' -const lineString = { - "type": "Feature", - "properties": {}, - "geometry": { - "type": "LineString", - "coordinates": [ - [-77.031669, 38.878605], - [-77.029609, 38.881946], - [-77.020339, 38.884084], - [-77.025661, 38.885821], - [-77.021884, 38.889563], - [-77.019824, 38.892368] - ] - } -} -const line = lineString.geometry.coordinates -const polygon = [[ - [-67.031, 50.458], [-67.031, 50.534], [-66.929, 50.534], - [-66.929, 50.458], [-67.031, 50.458] -]] -const points = [ - [-67.031, 50.458], [-67.031, 50.534], - [-66.929, 50.534], [-66.929, 50.458] -] - -// -- Test initiators -- -cheapRuler(35.05) -cheapRuler(35.05, 'miles') -cheapRuler(35.05, unit) -cheapRuler.fromTile(1567, 12) -cheapRuler.fromTile(1567, 12, 'miles') -cheapRuler.fromTile(1567, 12, unit) - -// -- Test units -- -cheapRuler.units -cheapRuler.units.miles -cheapRuler.units.kilometers -50 * cheapRuler.units.yards / cheapRuler.units.meters - -// -- Test cheapRuler -- -const ruler = cheapRuler(35.05) - -ruler.distance(point1, point2) -ruler.bearing(point1, point2) -ruler.destination(point1, 0.1, 90) -ruler.lineDistance(points) -ruler.area(polygon) -ruler.along(line, 2.5) -ruler.pointOnLine(line, point1).point -ruler.lineSlice(point1, point2, line) -ruler.lineSliceAlong(10, 20, line) -ruler.bufferPoint(point1, 0.01) -ruler.bufferBBox(bbox, 0.2) -ruler.insideBBox(point1, bbox) \ No newline at end of file diff --git a/types/cheap-ruler/index.d.ts b/types/cheap-ruler/index.d.ts deleted file mode 100644 index 91f417d490..0000000000 --- a/types/cheap-ruler/index.d.ts +++ /dev/null @@ -1,216 +0,0 @@ -// Type definitions for cheap-ruler 2.4.1 -// Project: https://github.com/mapbox/cheap-ruler -// Definitions by: Denis Carriere -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -declare module "cheap-ruler" { - type BBox = [number, number, number, number] | number[] - type Point = [number, number] | number[] - type Line = Array - type Points = Array - type Polygon = Array> - - interface TemplateUnits { - kilometers: number - miles: number - nauticalmiles: number - meters: number - metres: number - yards: number - feet: number - inches: number - } - interface InterfacePointOnLine { - point: Point - index: number - t: number - } - class CheapRuler { - /** - * Given two points of the form [longitude, latitude], returns the distance. - * - * @param {Point} a point [longitude, latitude] - * @param {Point} b point [longitude, latitude] - * @returns {number} distance - * @example - * var distance = ruler.distance([30.5, 50.5], [30.51, 50.49]); - * //=distance - */ - distance(a: Point, b: Point): number; - - /** - * Returns the bearing between two points in angles. - * - * @param {Point} a point [longitude, latitude] - * @param {Point} b point [longitude, latitude] - * @returns {number} bearing - * @example - * var bearing = ruler.bearing([30.5, 50.5], [30.51, 50.49]); - * //=bearing - */ - bearing(a: Point, b: Point): number; - - /** - * Returns a new point given distance and bearing from the starting point. - * - * @param {Point} p point [longitude, latitude] - * @param {number} dist distance - * @param {number} bearing - * @returns {Point} point [longitude, latitude] - * @example - * var point = ruler.destination([30.5, 50.5], 0.1, 90); - * //=point - */ - destination(p: Point, dist: number, bearing: number): Point; - - /** - * Given a line (an array of points), returns the total line distance. - * - * @param {Points} points [longitude, latitude] - * @returns {number} total line distance - * @example - * var length = ruler.lineDistance([ - * [-67.031, 50.458], [-67.031, 50.534], - * [-66.929, 50.534], [-66.929, 50.458] - * ]); - * //=length - */ - lineDistance(points: Points): number; - - /** - * Given a polygon (an array of rings, where each ring is an array of points), returns the area. - * - * @param {Polygon} polygon - * @returns {number} area value in the specified units (square kilometers by default) - * @example - * var area = ruler.area([[ - * [-67.031, 50.458], [-67.031, 50.534], [-66.929, 50.534], - * [-66.929, 50.458], [-67.031, 50.458] - * ]]); - * //=area - */ - area(polygon: Polygon): number; - - /** - * Returns the point at a specified distance along the line. - * - * @param {Line} line - * @param {number} dist distance - * @returns {Point} point [longitude, latitude] - * @example - * var point = ruler.along(line, 2.5); - * //=point - */ - along(line: Line, dist: number): Point - - /** - * Returns an object of the form {point, index} where point is closest point on the line from the given point, and index is the start index of the segment with the closest point. - * - * @pointOnLine - * @param {Line} line - * @param {Point} p point [longitude, latitude] - * @returns {Object} {point, index} - * @example - * var point = ruler.pointOnLine(line, [-67.04, 50.5]).point; - * //=point - */ - pointOnLine(line: Line, p: Point): InterfacePointOnLine - - /** - * Returns a part of the given line between the start and the stop points (or their closest points on the line). - * - * @param {Point} start point [longitude, latitude] - * @param {Point} stop point [longitude, latitude] - * @param {Line} line - * @returns {Line} line part of a line - * @example - * var line2 = ruler.lineSlice([-67.04, 50.5], [-67.05, 50.56], line1); - * //=line2 - */ - lineSlice(start: Point, stop: Point, line: Line): Line - - /** - * Returns a part of the given line between the start and the stop points indicated by distance along the line. - * - * @param {number} start distance - * @param {number} stop distance - * @param {Line} line - * @returns {Line} line part of a line - * @example - * var line2 = ruler.lineSliceAlong(10, 20, line1); - * //=line2 - */ - lineSliceAlong(start: number, stop: number, line: Line): Line - - /** - * Given a point, returns a bounding box object ([w, s, e, n]) created from the given point buffered by a given distance. - * - * @param {Point} p point [longitude, latitude] - * @param {number} buffer - * @returns {BBox} box object ([w, s, e, n]) - * @example - * var bbox = ruler.bufferPoint([30.5, 50.5], 0.01); - * //=bbox - */ - bufferPoint(p: Point, buffer: number): BBox - - /** - * Given a bounding box, returns the box buffered by a given distance. - * - * @param {BBox} box object ([w, s, e, n]) - * @param {number} buffer - * @returns {BBox} box object ([w, s, e, n]) - * @example - * var bbox = ruler.bufferBBox([30.5, 50.5, 31, 51], 0.2); - * //=bbox - */ - bufferBBox(bbox: BBox, buffer: number): BBox - - /** - * Returns true if the given point is inside in the given bounding box, otherwise false. - * - * @param {Point} p point [longitude, latitude] - * @param {Point} box object ([w, s, e, n]) - * @returns {boolean} - * @example - * var inside = ruler.insideBBox([30.5, 50.5], [30, 50, 31, 51]); - * //=inside - */ - insideBBox(p: Point, bbox: BBox): boolean - } - /** - * A collection of very fast approximations to common geodesic measurements. Useful for performance-sensitive code that measures things on a city scale. - * - * @param {number} lat latitude - * @param {string} [units='kilometers'] - * @returns {CheapRuler} - * @example - * var ruler = cheapRuler(35.05, 'miles'); - * //=ruler - */ - function cheapRuler(lat: number, units?: string): CheapRuler; - namespace cheapRuler { - /** - * Multipliers for converting between units. - * - * @example - * // convert 50 meters to yards - * 50 * cheapRuler.units.yards / cheapRuler.units.meters; - */ - const units: TemplateUnits - - /** - * Creates a ruler object from tile coordinates (y and z). Convenient in tile-reduce scripts. - * - * @param {number} y - * @param {number} z - * @param {string} [units='kilometers'] - * @returns {CheapRuler} - * @example - * var ruler = cheapRuler.fromTile(1567, 12); - * //=ruler - */ - function fromTile(y: number, z: number, units?: string): CheapRuler; - } - export = cheapRuler -} \ No newline at end of file diff --git a/types/cheap-ruler/tsconfig.json b/types/cheap-ruler/tsconfig.json deleted file mode 100644 index a693c8bcf3..0000000000 --- a/types/cheap-ruler/tsconfig.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "compilerOptions": { - "module": "commonjs", - "lib": [ - "es6" - ], - "noImplicitAny": true, - "noImplicitThis": true, - "strictNullChecks": false, - "baseUrl": "../", - "typeRoots": [ - "../" - ], - "types": [], - "noEmit": true, - "forceConsistentCasingInFileNames": true - }, - "files": [ - "index.d.ts", - "cheap-ruler-tests.ts" - ] -} \ No newline at end of file From 484d180bffb68a6b005f4f846772efe0e52b39a7 Mon Sep 17 00:00:00 2001 From: Wink Saville Date: Wed, 5 Apr 2017 08:58:42 -0700 Subject: [PATCH 183/844] Add proper header for index.d.ts --- types/webassembly-js-api/index.d.ts | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/types/webassembly-js-api/index.d.ts b/types/webassembly-js-api/index.d.ts index 8912892200..300cdaab54 100644 --- a/types/webassembly-js-api/index.d.ts +++ b/types/webassembly-js-api/index.d.ts @@ -1,9 +1,7 @@ -/** - * WebAssembly v1 (MVP) declaration file for TypeScript - * Definitions by: 01alchemist (https://twitter.com/01alchemist) - * and Wink Saville - */ - +// Type definitions for WebAssembly v1 (MVP) +// Project: https://github.com/winksaville/test-webassembly-js-ts +// Definitions by: 01alchemist (https://twitter.com/01alchemist) && Wink Saville (https://github.com/winksaville) +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped declare namespace WebAssembly { /** * WebAssembly.Module From cc4ea4af88130defe9894868cfcfc56ca1239251 Mon Sep 17 00:00:00 2001 From: Wink Saville Date: Wed, 5 Apr 2017 09:12:47 -0700 Subject: [PATCH 184/844] Remove README.md move contents ti index.d.ts Also only a single author. --- types/webassembly-js-api/README.md | 17 ----------------- types/webassembly-js-api/index.d.ts | 26 +++++++++++++++++++++++++- 2 files changed, 25 insertions(+), 18 deletions(-) delete mode 100644 types/webassembly-js-api/README.md diff --git a/types/webassembly-js-api/README.md b/types/webassembly-js-api/README.md deleted file mode 100644 index a034040f92..0000000000 --- a/types/webassembly-js-api/README.md +++ /dev/null @@ -1,17 +0,0 @@ -# WebAssembly typescript declaration file - -## Installation -``` -npm install @types/webassembly-js-api --save-dev -``` - -The WebAssembly namespace will now be available to your code TypeScript code. -See [WebAssembly JS API](http://webassembly.org/getting-started/js-api/) and the contents of -@types/webassembly-js-api/index.d.ts for more details. - -Do not use an `import * as WebAssembly from "webassembly-js-api"` as this will cause -the `tsc` to emit a `require` statement for the WebAssembly module which doesn't exist as -WebAssembly is part of the global namespace. - -Instead use a `///` statement. -Note: this `` maybe optional, but YMMV. diff --git a/types/webassembly-js-api/index.d.ts b/types/webassembly-js-api/index.d.ts index 300cdaab54..d8e7ee0932 100644 --- a/types/webassembly-js-api/index.d.ts +++ b/types/webassembly-js-api/index.d.ts @@ -1,7 +1,31 @@ // Type definitions for WebAssembly v1 (MVP) // Project: https://github.com/winksaville/test-webassembly-js-ts -// Definitions by: 01alchemist (https://twitter.com/01alchemist) && Wink Saville (https://github.com/winksaville) +// Definitions by: 01alchemist // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +/** + * WebAssembly v1 (MVP) declaration file for TypeScript + * + * Authors: 01alchemist + * and Wink Saville + * + * ## Installation + * ``` + * npm install @types/webassembly-js-api --save-dev + * ``` + * + * The WebAssembly namespace will now be available to your code TypeScript code. + * See [WebAssembly JS API](http://webassembly.org/getting-started/js-api/) and the contents of + * @types/webassembly-js-api/index.d.ts for more details. + * + * Do not use an `import * as WebAssembly from "webassembly-js-api"` as this will cause + * the `tsc` to emit a `require` statement for the WebAssembly module which doesn't exist as + * WebAssembly is part of the global namespace. + * + * Instead use a `///` statement. + * Note: this `` maybe optional, but YMMV. + */ + declare namespace WebAssembly { /** * WebAssembly.Module From 24b0340ed29086c18ddc5a336d61de8992fa69c5 Mon Sep 17 00:00:00 2001 From: Ian Copp Date: Wed, 5 Apr 2017 09:33:26 -0700 Subject: [PATCH 185/844] Fix the header --- types/node-common-errors/index.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/types/node-common-errors/index.d.ts b/types/node-common-errors/index.d.ts index 69fb5323b4..370428618c 100644 --- a/types/node-common-errors/index.d.ts +++ b/types/node-common-errors/index.d.ts @@ -1,10 +1,10 @@ -import * as express from 'express'; - // Type definitions for node-common-errors 0.4 // Project: https://github.com/shutterstock/node-errors // Definitions by: Ian Copp // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +import * as express from 'express'; + type GenerateMessageMethod = () => string; interface ErrorConstructor { From 3b4f31e155fe71a4bd50731f7201454c669ca21d Mon Sep 17 00:00:00 2001 From: Wink Saville Date: Wed, 5 Apr 2017 10:12:09 -0700 Subject: [PATCH 186/844] Use comma to separate authors and streamline second comment. --- types/webassembly-js-api/index.d.ts | 26 ++++---------------------- 1 file changed, 4 insertions(+), 22 deletions(-) diff --git a/types/webassembly-js-api/index.d.ts b/types/webassembly-js-api/index.d.ts index d8e7ee0932..4e7b0d52bf 100644 --- a/types/webassembly-js-api/index.d.ts +++ b/types/webassembly-js-api/index.d.ts @@ -1,31 +1,13 @@ // Type definitions for WebAssembly v1 (MVP) // Project: https://github.com/winksaville/test-webassembly-js-ts -// Definitions by: 01alchemist +// Definitions by: 01alchemist , Wink Saville // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped /** - * WebAssembly v1 (MVP) declaration file for TypeScript - * - * Authors: 01alchemist - * and Wink Saville - * - * ## Installation - * ``` - * npm install @types/webassembly-js-api --save-dev - * ``` - * - * The WebAssembly namespace will now be available to your code TypeScript code. - * See [WebAssembly JS API](http://webassembly.org/getting-started/js-api/) and the contents of - * @types/webassembly-js-api/index.d.ts for more details. - * - * Do not use an `import * as WebAssembly from "webassembly-js-api"` as this will cause - * the `tsc` to emit a `require` statement for the WebAssembly module which doesn't exist as - * WebAssembly is part of the global namespace. - * - * Instead use a `///` statement. - * Note: this `` maybe optional, but YMMV. + * The WebAssembly namespace, see [WebAssembly](https://github.com/webassembly) + * and [WebAssembly JS API](http://webassembly.org/getting-started/js-api/) + * for more information. */ - declare namespace WebAssembly { /** * WebAssembly.Module From 44a579f3e0fc73b2ef7c4b28875d6c4027d071b4 Mon Sep 17 00:00:00 2001 From: Libin Lu Date: Wed, 5 Apr 2017 14:15:43 -0400 Subject: [PATCH 187/844] add measure function into ui manager --- types/react-native/index.d.ts | 51 +++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) diff --git a/types/react-native/index.d.ts b/types/react-native/index.d.ts index e282f17191..f907e13481 100644 --- a/types/react-native/index.d.ts +++ b/types/react-native/index.d.ts @@ -7156,6 +7156,57 @@ export interface UIManagerStatic { quality ?: number, } ) => Promise + + /** + * Determines the location on screen, width, and height of the given view and + * returns the values via an async callback. If successful, the callback will + * be called with the following arguments: + * + * - x + * - y + * - width + * - height + * - pageX + * - pageY + * + * Note that these measurements are not available until after the rendering + * has been completed in native. If you need the measurements as soon as + * possible, consider using the [`onLayout` + * prop](docs/view.html#onlayout) instead. + */ + measure(node: number, callback: MeasureOnSuccessCallback): void; + + /** + * Determines the location of the given view in the window and returns the + * values via an async callback. If the React root view is embedded in + * another native view, this will give you the absolute coordinates. If + * successful, the callback will be called with the following + * arguments: + * + * - x + * - y + * - width + * - height + * + * Note that these measurements are not available until after the rendering + * has been completed in native. + */ + measureInWindow(node: number, callback: MeasureInWindowOnSuccessCallback): void; + + /** + * Like [`measure()`](#measure), but measures the view relative an ancestor, + * specified as `relativeToNativeNode`. This means that the returned x, y + * are relative to the origin x, y of the ancestor view. + * + * As always, to obtain a native node handle for a component, you can use + * `React.findNodeHandle(component)`. + */ + measureLayout( + node: number, + relativeToNativeNode: number, + onSuccess: MeasureLayoutOnSuccessCallback, + onFail: () => void /* currently unused */ + ): void; } export interface SwitchPropertiesIOS extends ViewProperties, React.Props { From 2804601a84d8693a891a96ec67ab057947d22c81 Mon Sep 17 00:00:00 2001 From: Fedor Nezhivoi Date: Wed, 5 Apr 2017 21:59:28 +0300 Subject: [PATCH 188/844] @types/react-native update layout props in accordance to 0.43 release and refactor them a bit --- types/react-native/index.d.ts | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/types/react-native/index.d.ts b/types/react-native/index.d.ts index e282f17191..cb8b04f5e2 100644 --- a/types/react-native/index.d.ts +++ b/types/react-native/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for react-native 0.42 +// Type definitions for react-native 0.43 // Project: https://github.com/facebook/react-native // Definitions by: Eloy DurĂ¡n // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped @@ -531,9 +531,7 @@ export interface LayoutAnimationStatic { spring: (config: LayoutAnimationConfig, onAnimationDidEnd?: () => void) => void } -export type FlexAlignType = "flex-start" | "flex-end" | "center" | "stretch" | "baseline"; -export type FlexJustifyType = "flex-start" | "flex-end" | "center" | "space-between" | "space-around"; -export type FlexDirection = "row" | "column" | "row-reverse" | "column-reverse"; +type FlexAlignType = "flex-start" | "flex-end" | "center" | "stretch" | "baseline"; /** * Flex Prop Types @@ -541,9 +539,9 @@ export type FlexDirection = "row" | "column" | "row-reverse" | "column-reverse"; * @see LayoutPropTypes.js */ export interface FlexStyle { - - alignItems?: FlexAlignType; - alignSelf?: "auto" | FlexAlignType; + alignContent?: "flex-start" | "flex-end" | "center" | "stretch" | "space-between" | "space-around" + alignItems?: FlexAlignType + alignSelf?: "auto" | FlexAlignType borderBottomWidth?: number borderLeftWidth?: number borderRightWidth?: number @@ -551,18 +549,14 @@ export interface FlexStyle { borderWidth?: number bottom?: number | string flex?: number + flexBasis?: number | string + flexDirection?: "row" | "column" | "row-reverse" | "column-reverse" flexGrow?: number flexShrink?: number - flexBasis?: number | string - flexDirection?: FlexDirection flexWrap?: "wrap" | "nowrap" height?: number | string - justifyContent?: FlexJustifyType + justifyContent?: "flex-start" | "flex-end" | "center" | "space-between" | "space-around" left?: number | string - minWidth?: number | string - maxWidth?: number | string - minHeight?: number | string - maxHeight?: number | string margin?: number | string marginBottom?: number | string marginHorizontal?: number | string @@ -570,6 +564,10 @@ export interface FlexStyle { marginRight?: number | string marginTop?: number | string marginVertical?: number | string + maxHeight?: number | string + maxWidth?: number | string + minHeight?: number | string + minWidth?: number | string overflow?: "visible" | "hidden" | "scroll" padding?: number | string paddingBottom?: number | string @@ -582,11 +580,12 @@ export interface FlexStyle { right?: number | string top?: number | string width?: number | string + zIndex?: number /** * @platform ios */ - zIndex?: number + direction?: 'inherit' | 'ltr' | 'rtl' } /** From b5d5e7bf9384a814d16b32c3b0fd3ca9c292e0e3 Mon Sep 17 00:00:00 2001 From: Wink Saville Date: Wed, 5 Apr 2017 13:32:07 -0700 Subject: [PATCH 189/844] Update README.md --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6868d116cf..5698530638 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,9 @@ Add to your `tsconfig.json`: Create `types/foo/index.d.ts` containing declarations for the module "foo". You should now be able import from `"foo"` in your code and it will route to the new type definition. Then build *and* run the code to make sure your type definition actually corresponds to what happens at runtime. -Once you've tested your definitions with real code, make a PR contributing the definition by copying `types/foo` to `DefinitelyTyped/foo` and adding a `tsconfig.json` and `foo-tests.ts`. +Once you've tested your definitions with real code, make a [PR](#make-a-pull-request) +then follow the instructions for [Edit an existing package](#edit-an-existing-package) or +[Create a new package](#create-a-new-package). ### Make a pull request @@ -83,7 +85,7 @@ First, [fork](https://guides.github.com/activities/forking/) this repository, in #### Edit an existing package -* `cd my-package-to-edit` +* `cd types/my-package-to-edit` * Make changes. Remember to edit tests. * You may also want to add yourself to "Definitions by" section of the package header. - Do this by adding your name to the end of the line, as in `// Definitions by: Alice , Bob `. From 1bf9a4e75f728e3164a6a841ecd8cef986699f19 Mon Sep 17 00:00:00 2001 From: Libin Lu Date: Wed, 5 Apr 2017 16:54:07 -0400 Subject: [PATCH 190/844] Update index.d.ts --- types/react-native/index.d.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/types/react-native/index.d.ts b/types/react-native/index.d.ts index f907e13481..677cd6bb26 100644 --- a/types/react-native/index.d.ts +++ b/types/react-native/index.d.ts @@ -7156,7 +7156,7 @@ export interface UIManagerStatic { quality ?: number, } ) => Promise - + /** * Determines the location on screen, width, and height of the given view and * returns the values via an async callback. If successful, the callback will @@ -7204,8 +7204,8 @@ export interface UIManagerStatic { measureLayout( node: number, relativeToNativeNode: number, - onSuccess: MeasureLayoutOnSuccessCallback, - onFail: () => void /* currently unused */ + onFail: () => void, /* currently unused */ + onSuccess: MeasureLayoutOnSuccessCallback ): void; } From 21290fe29e85c53aad7f9dbd1d47a2cf8a360311 Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Wed, 5 Apr 2017 18:52:03 -0700 Subject: [PATCH 191/844] Docs and some missing functions for chai.assert Bumped Chai version to 3.5.0. --- types/chai/chai-tests.ts | 1388 ++++++++++++++------------------------ types/chai/index.d.ts | 1029 +++++++++++++++++++++++++--- 2 files changed, 1431 insertions(+), 986 deletions(-) diff --git a/types/chai/chai-tests.ts b/types/chai/chai-tests.ts index 7f104d07e5..756212995d 100644 --- a/types/chai/chai-tests.ts +++ b/types/chai/chai-tests.ts @@ -1,16 +1,11 @@ +import * as chai from "chai"; -import chai = require('chai'); +const expect = chai.expect; +const assert = chai.assert; +const should = chai.should(); -// ReSharper disable WrongExpressionStatement - -var expect = chai.expect; -var assert = chai.assert; -var should = chai.should(); -declare var err: Function; - -function chaiVersion() { - expect(chai).to.have.property('version'); - (<{}>chai).should.have.property('version'); +function chaiVersion(): string { + return chai.version; } function assertion() { @@ -22,28 +17,13 @@ function assertion() { } function fail() { - err(() => { - should.fail('foo', 'bar'); - }, 'expected fail to throw an AssertionError'); - err(() => { - should.fail('foo', 'bar', 'should fail'); - }, 'expected fail to throw an AssertionError'); - err(() => { - should.fail('foo', 'bar', 'should fail', 'equal'); - }, 'expected fail to throw an AssertionError'); + should.fail('foo', 'bar'); + should.fail('foo', 'bar', 'should fail'); - err(() => { - expect.fail('foo', 'bar'); - }, 'expected fail to throw an AssertionError'); - err(() => { - expect.fail('foo', 'bar', 'should fail'); - }, 'expected fail to throw an AssertionError'); - err(() => { - expect.fail('foo', 'bar', 'should fail', 'equal'); - }, 'expected fail to throw an AssertionError'); + expect.fail('foo', 'bar'); + expect.fail('foo', 'bar', 'should fail'); } -// ReSharper disable once InconsistentNaming function _true() { expect(true).to.be.true; true.should.be.true; @@ -52,10 +32,8 @@ function _true() { expect(1).to.not.be.true; (1).should.not.be.true; - err(() => { - expect('test').to.be.true; - 'test'.should.be.true; - }, 'expected \'test\' to be true'); + expect('test').to.be.true; + 'test'.should.be.true; } function ok() { @@ -68,15 +46,11 @@ function ok() { expect(0).to.not.be.ok; (0).should.not.be.ok; - err(() => { - expect('').to.be.ok; - ''.should.be.ok; - }, 'expected \'\' to be truthy'); + expect('').to.be.ok; + ''.should.be.ok; - err(() => { - expect('test').to.not.be.ok; - 'test'.should.not.be.ok; - }, 'expected \'test\' to be falsy'); + expect('test').to.not.be.ok; + 'test'.should.not.be.ok; } function _false() { @@ -87,10 +61,8 @@ function _false() { expect(0).to.not.be.false; (0).should.not.be.false; - err(() => { - expect('').to.be.false; - ''.should.be.false; - }, 'expected \'\' to be false'); + expect('').to.be.false; + ''.should.be.false; } function _null() { @@ -99,10 +71,8 @@ function _null() { expect(false).to.not.be.null; false.should.not.be.null; - err(() => { - expect('').to.be.null; - ''.should.be.null; - }, 'expected \'\' to be null'); + expect('').to.be.null; + ''.should.be.null; } function _undefined() { @@ -111,10 +81,8 @@ function _undefined() { expect(null).to.not.be.undefined; should.not.equal(null, undefined); - err(() => { - expect('').to.be.undefined; - ''.should.be.undefined; - }, 'expected \'\' to be undefined'); + expect('').to.be.undefined; + ''.should.be.undefined; } function _NaN() { @@ -127,7 +95,7 @@ function _NaN() { } function exist() { - var foo = 'bar'; + const foo = 'bar'; expect(foo).to.exist; should.exist(foo); expect(void (0)).to.not.exist; @@ -135,7 +103,7 @@ function exist() { } function argumentsTest() { - var args = arguments; + const args = arguments; expect(args).to.be.arguments; args.should.be.arguments; expect([]).to.not.be.arguments; @@ -155,10 +123,8 @@ function _typeof() { expect('test').to.be.a('string'); 'test'.should.be.a('string'); - err(() => { - expect('test').to.not.be.a('string'); - 'test'.should.not.be.a('string'); - }, 'expected \'test\' not to be a string'); + expect('test').to.not.be.a('string'); + 'test'.should.not.be.a('string'); expect(arguments).to.be.an('arguments'); arguments.should.be.an('arguments'); @@ -185,10 +151,8 @@ function _typeof() { expect(null).to.be.a('null'); // N.B. previous line has no should equivalent - err(() => { - expect(5).to.not.be.a('number', 'blah'); - (5).should.not.be.a('number', 'blah'); - }, 'blah: expected 5 not to be a number'); + expect(5).to.not.be.a('number', 'blah'); + (5).should.not.be.a('number', 'blah'); } class Foo { } @@ -196,10 +160,8 @@ function _instanceof() { expect(new Foo()).to.be.an.instanceof(Foo); (new Foo()).should.be.an.instanceof(Foo); - err(() => { - expect(3).to.an.instanceof(Foo, 'blah'); - (3).should.an.instanceof(Foo, 'blah'); - }, 'blah: expected 3 to be an instance of Foo'); + expect(3).to.an.instanceof(Foo, 'blah'); + (3).should.an.instanceof(Foo, 'blah'); } function within() { @@ -216,25 +178,17 @@ function within() { expect([1, 2, 3]).to.have.length.within(2, 4); [1, 2, 3].should.have.length.within(2, 4); - err(() => { - expect(5).to.not.be.within(4, 6, 'blah'); - (5).should.not.be.within(4, 6, 'blah'); - }, 'blah: expected 5 to not be within 4..6', 'blah'); + expect(5).to.not.be.within(4, 6, 'blah'); + (5).should.not.be.within(4, 6, 'blah'); - err(() => { - expect(10).to.be.within(50, 100, 'blah'); - (10).should.be.within(50, 100, 'blah'); - }, 'blah: expected 10 to be within 50..100'); + expect(10).to.be.within(50, 100, 'blah'); + (10).should.be.within(50, 100, 'blah'); - err(() => { - expect('foo').to.have.length.within(5, 7, 'blah'); - 'foo'.should.have.length.within(5, 7, 'blah'); - }, 'blah: expected \'foo\' to have a length within 5..7'); + expect('foo').to.have.length.within(5, 7, 'blah'); + 'foo'.should.have.length.within(5, 7, 'blah'); - err(() => { - expect([1, 2, 3]).to.have.length.within(5, 7, 'blah'); - [1, 2, 3].should.have.length.within(5, 7, 'blah'); - }, 'blah: expected [ 1, 2, 3 ] to have a length within 5..7'); + expect([1, 2, 3]).to.have.length.within(5, 7, 'blah'); + [1, 2, 3].should.have.length.within(5, 7, 'blah'); } function above() { @@ -251,25 +205,17 @@ function above() { expect([1, 2, 3]).to.have.length.above(2); [1, 2, 3].should.have.length.above(2); - err(() => { - expect(5).to.be.above(6, 'blah'); - (5).should.be.above(6, 'blah'); - }, 'blah: expected 5 to be above 6', 'blah'); + expect(5).to.be.above(6, 'blah'); + (5).should.be.above(6, 'blah'); - err(() => { - expect(10).to.not.be.above(6, 'blah'); - (10).should.not.be.above(6, 'blah'); - }, 'blah: expected 10 to be at most 6'); + expect(10).to.not.be.above(6, 'blah'); + (10).should.not.be.above(6, 'blah'); - err(() => { - expect('foo').to.have.length.above(4, 'blah'); - 'foo'.should.have.length.above(4, 'blah'); - }, 'blah: expected \'foo\' to have a length above 4 but got 3'); + expect('foo').to.have.length.above(4, 'blah'); + 'foo'.should.have.length.above(4, 'blah'); - err(() => { - expect([1, 2, 3]).to.have.length.above(4, 'blah'); - [1, 2, 3].should.have.length.above(4, 'blah'); - }, 'blah: expected [ 1, 2, 3 ] to have a length above 4 but got 3'); + expect([1, 2, 3]).to.have.length.above(4, 'blah'); + [1, 2, 3].should.have.length.above(4, 'blah'); } function least() { @@ -284,30 +230,20 @@ function least() { expect([1, 2, 3]).to.have.length.of.at.least(2); [1, 2, 3].should.have.length.of.at.least(2); - err(() => { - expect(5).to.be.at.least(6, 'blah'); - (5).should.be.at.least(6, 'blah'); - }, 'blah: expected 5 to be at least 6', 'blah'); + expect(5).to.be.at.least(6, 'blah'); + (5).should.be.at.least(6, 'blah'); - err(() => { - expect(10).to.not.be.at.least(6, 'blah'); - (10).should.not.be.at.least(6, 'blah'); - }, 'blah: expected 10 to be below 6'); + expect(10).to.not.be.at.least(6, 'blah'); + (10).should.not.be.at.least(6, 'blah'); - err(() => { - expect('foo').to.have.length.of.at.least(4, 'blah'); - 'foo'.should.have.length.of.at.least(4, 'blah'); - }, 'blah: expected \'foo\' to have a length at least 4 but got 3'); + expect('foo').to.have.length.of.at.least(4, 'blah'); + 'foo'.should.have.length.of.at.least(4, 'blah'); - err(() => { - expect([1, 2, 3]).to.have.length.of.at.least(4, 'blah'); - [1, 2, 3].should.have.length.of.at.least(4, 'blah'); - }, 'blah: expected [ 1, 2, 3 ] to have a length at least 4 but got 3'); + expect([1, 2, 3]).to.have.length.of.at.least(4, 'blah'); + [1, 2, 3].should.have.length.of.at.least(4, 'blah'); - err(() => { - expect([1, 2, 3, 4]).to.not.have.length.of.at.least(4, 'blah'); - [1, 2, 3, 4].should.not.have.length.of.at.least(4, 'blah'); - }, 'blah: expected [ 1, 2, 3, 4 ] to have a length below 4'); + expect([1, 2, 3, 4]).to.not.have.length.of.at.least(4, 'blah'); + [1, 2, 3, 4].should.not.have.length.of.at.least(4, 'blah'); } function below() { @@ -324,25 +260,17 @@ function below() { expect([1, 2, 3]).to.have.length.below(4); [1, 2, 3].should.have.length.below(4); - err(() => { - expect(6).to.be.below(5, 'blah'); - (6).should.be.below(5, 'blah'); - }, 'blah: expected 6 to be below 5'); + expect(6).to.be.below(5, 'blah'); + (6).should.be.below(5, 'blah'); - err(() => { - expect(6).to.not.be.below(10, 'blah'); - (6).should.not.be.below(10, 'blah'); - }, 'blah: expected 6 to be at least 10'); + expect(6).to.not.be.below(10, 'blah'); + (6).should.not.be.below(10, 'blah'); - err(() => { - expect('foo').to.have.length.below(2, 'blah'); - 'foo'.should.have.length.below(2, 'blah'); - }, 'blah: expected \'foo\' to have a length below 2 but got 3'); + expect('foo').to.have.length.below(2, 'blah'); + 'foo'.should.have.length.below(2, 'blah'); - err(() => { - expect([1, 2, 3]).to.have.length.below(2, 'blah'); - [1, 2, 3].should.have.length.below(2, 'blah'); - }, 'blah: expected [ 1, 2, 3 ] to have a length below 2 but got 3'); + expect([1, 2, 3]).to.have.length.below(2, 'blah'); + [1, 2, 3].should.have.length.below(2, 'blah'); } function most() { @@ -359,30 +287,20 @@ function most() { expect([1, 2, 3]).to.have.length.of.at.most(4); [1, 2, 3].should.have.length.of.at.most(4); - err(() => { - expect(6).to.be.at.most(5, 'blah'); - (6).should.be.at.most(5, 'blah'); - }, 'blah: expected 6 to be at most 5'); + expect(6).to.be.at.most(5, 'blah'); + (6).should.be.at.most(5, 'blah'); - err(() => { - expect(6).to.not.be.at.most(10, 'blah'); - (6).should.not.be.at.most(10, 'blah'); - }, 'blah: expected 6 to be above 10'); + expect(6).to.not.be.at.most(10, 'blah'); + (6).should.not.be.at.most(10, 'blah'); - err(() => { - expect('foo').to.have.length.of.at.most(2, 'blah'); - 'foo'.should.have.length.of.at.most(2, 'blah'); - }, 'blah: expected \'foo\' to have a length at most 2 but got 3'); + expect('foo').to.have.length.of.at.most(2, 'blah'); + 'foo'.should.have.length.of.at.most(2, 'blah'); - err(() => { - expect([1, 2, 3]).to.have.length.of.at.most(2, 'blah'); - [1, 2, 3].should.have.length.of.at.most(2, 'blah'); - }, 'blah: expected [ 1, 2, 3 ] to have a length at most 2 but got 3'); + expect([1, 2, 3]).to.have.length.of.at.most(2, 'blah'); + [1, 2, 3].should.have.length.of.at.most(2, 'blah'); - err(() => { - expect([1, 2]).to.not.have.length.of.at.most(2, 'blah'); - [1, 2].should.not.have.length.of.at.most(2, 'blah'); - }, 'blah: expected [ 1, 2 ] to have a length above 2'); + expect([1, 2]).to.not.have.length.of.at.most(2, 'blah'); + [1, 2].should.not.have.length.of.at.most(2, 'blah'); } function match() { @@ -394,15 +312,11 @@ function match() { expect('foobar').matches(/^foo/); 'foobar'.should.not.matches(/^bar/); - err(() => { - expect('foobar').to.match(/^bar/i, 'blah'); - 'foobar'.should.match(/^bar/i, 'blah'); - }, 'blah: expected \'foobar\' to match /^bar/i'); + expect('foobar').to.match(/^bar/i, 'blah'); + 'foobar'.should.match(/^bar/i, 'blah'); - err(() => { - expect('foobar').to.not.match(/^foo/i, 'blah'); - 'foobar'.should.not.match(/^foo/i, 'blah'); - }, 'blah: expected \'foobar\' not to match /^foo/i'); + expect('foobar').to.not.match(/^foo/i, 'blah'); + 'foobar'.should.not.match(/^foo/i, 'blah'); } function length2() { @@ -413,15 +327,11 @@ function length2() { expect([1, 2, 3]).to.have.length(3); [1, 2, 3].should.have.length(3); - err(() => { - expect(4).to.have.length(3, 'blah'); - (4).should.have.length(3, 'blah'); - }, 'blah: expected 4 to have a property \'length\''); + expect(4).to.have.length(3, 'blah'); + (4).should.have.length(3, 'blah'); - err(() => { - expect('asd').to.not.have.length(3, 'blah'); - 'asd'.should.not.have.length(3, 'blah'); - }, 'blah: expected \'asd\' to not have a length of 3'); + expect('asd').to.not.have.length(3, 'blah'); + 'asd'.should.not.have.length(3, 'blah'); } function eql() { @@ -434,10 +344,8 @@ function eql() { expect('4').to.not.eql(4); '4'.should.not.eql(4); - err(() => { - expect(4).to.eql(3, 'blah'); - (4).should.eql(3, 'blah'); - }, 'blah: expected 4 to deeply equal 3'); + expect(4).to.eql(3, 'blah'); + (4).should.eql(3, 'blah'); } class Buffer { @@ -448,10 +356,8 @@ function buffer() { expect(new Buffer([1])).to.eql(new Buffer([1])); (new Buffer([1])).should.eql(new Buffer([1])); - err(() => { - expect(new Buffer([0])).to.eql(new Buffer([1])); - (new Buffer([0])).should.eql(new Buffer([1])); - }, 'expected to deeply equal '); + expect(new Buffer([0])).to.eql(new Buffer([1])); + (new Buffer([0])).should.eql(new Buffer([1])); } function equal2() { @@ -462,17 +368,13 @@ function equal2() { (1).should.equal(1); should.equal(1, 1); - err(() => { - expect(4).to.equal(3, 'blah'); - (4).should.equal(3, 'blah'); - should.equal(4, 3, 'blah'); - }, 'blah: expected 4 to equal 3'); + expect(4).to.equal(3, 'blah'); + (4).should.equal(3, 'blah'); + should.equal(4, 3, 'blah'); - err(() => { - expect('4').to.equal(4, 'blah'); - '4'.should.equal(4, 'blah'); - should.equal(4, 4, 'blah'); - }, 'blah: expected \'4\' to equal 4'); + expect('4').to.equal(4, 'blah'); + '4'.should.equal(4, 'blah'); + should.equal(4, 4, 'blah'); } function deepEqual() { @@ -497,10 +399,9 @@ function deepEqual2() { expect(/a/m).not.to.deep.equal(/b/m); } -// ReSharper disable once InconsistentNaming function deepEqual3() { - var a = new Date(1, 2, 3); - var b = new Date(4, 5, 6); + const a = new Date(1, 2, 3); + const b = new Date(4, 5, 6); expect(a).to.deep.equal(a); a.should.deep.equal(a); expect(a).not.to.deep.equal(b); @@ -541,46 +442,30 @@ function empty() { expect({ foo: 'bar' }).not.to.be.empty; ({ foo: 'bar' }).should.not.be.empty; - err(() => { - expect('').not.to.be.empty; - ''.should.not.be.empty; - }, 'expected \'\' not to be empty'); + expect('').not.to.be.empty; + ''.should.not.be.empty; - err(() => { - expect('foo').to.be.empty; - 'foo'.should.be.empty; - 'foo'.should.be.empty; - }, 'expected \'foo\' to be empty'); + expect('foo').to.be.empty; + 'foo'.should.be.empty; + 'foo'.should.be.empty; - err(() => { - expect([]).not.to.be.empty; - [].should.not.be.empty; - }, 'expected [] not to be empty'); + expect([]).not.to.be.empty; + [].should.not.be.empty; - err(() => { - expect(['foo']).to.be.empty; - ['foo'].should.be.empty; - }, 'expected [ \'foo\' ] to be empty'); + expect(['foo']).to.be.empty; + ['foo'].should.be.empty; - err(() => { - expect(new FakeArgs).not.to.be.empty; - (new FakeArgs).should.not.be.empty; - }, 'expected { length: 0 } not to be empty'); + expect(new FakeArgs).not.to.be.empty; + (new FakeArgs).should.not.be.empty; - err(() => { - expect({ arguments: 0 }).to.be.empty; - ({ arguments: 0 }).should.be.empty; - }, 'expected { arguments: 0 } to be empty'); + expect({ arguments: 0 }).to.be.empty; + ({ arguments: 0 }).should.be.empty; - err(() => { - expect({}).not.to.be.empty; - ({}).should.not.be.empty; - }, 'expected {} not to be empty'); + expect({}).not.to.be.empty; + ({}).should.not.be.empty; - err(() => { - expect({ foo: 'bar' }).to.be.empty; - ({ foo: 'bar' }).should.be.empty; - }, 'expected { foo: \'bar\' } to be empty'); + expect({ foo: 'bar' }).to.be.empty; + ({ foo: 'bar' }).should.be.empty; } function property() { @@ -596,15 +481,13 @@ function property() { .to.not.have.property('foo.bar'); ({ foo: { bar: 'baz' } }).should.not.have.property('foo.bar'); - err(() => { - expect('asd').to.have.property('foo'); - 'asd'.should.have.property('foo'); - }, 'expected \'asd\' to have a property \'foo\''); - err(() => { - expect({ foo: { bar: 'baz' } }) - .to.have.property('foo.bar'); - ({ foo: { bar: 'baz' } }).should.have.property('foo.bar'); - }, 'expected { foo: { bar: \'baz\' } } to have a property \'foo.bar\''); + expect('asd').to.have.property('foo'); + 'asd'.should.have.property('foo'); + + expect({ foo: { bar: 'baz' } }) + .to.have.property('foo.bar'); + + ({ foo: { bar: 'baz' } }).should.have.property('foo.bar'); } function deepProperty() { @@ -617,12 +500,10 @@ function deepProperty() { ({ foo: { bar: 'baz' } }).should .have.deep.property('foo.bar'); - err(() => { - expect({ 'foo.bar': 'baz' }) - .to.have.deep.property('foo.bar'); - ({ 'foo.bar': 'baz' }).should - .have.deep.property('foo.bar'); - }, 'expected { \'foo.bar\': \'baz\' } to have a deep property \'foo.bar\''); + expect({ 'foo.bar': 'baz' }) + .to.have.deep.property('foo.bar'); + ({ 'foo.bar': 'baz' }).should + .have.deep.property('foo.bar'); } function property2() { @@ -631,25 +512,17 @@ function property2() { expect('asd').to.have.property('constructor', String); 'asd'.should.have.property('constructor', String); - err(() => { - expect('asd').to.have.property('length', 4, 'blah'); - 'asd'.should.have.property('length', 4, 'blah'); - }, 'blah: expected \'asd\' to have a property \'length\' of 4, but got 3'); + expect('asd').to.have.property('length', 4, 'blah'); + 'asd'.should.have.property('length', 4, 'blah'); - err(() => { - expect('asd').to.not.have.property('length', 3, 'blah'); - 'asd'.should.not.have.property('length', 3, 'blah'); - }, 'blah: expected \'asd\' to not have a property \'length\' of 3'); + expect('asd').to.not.have.property('length', 3, 'blah'); + 'asd'.should.not.have.property('length', 3, 'blah'); - err(() => { - expect('asd').to.not.have.property('foo', 3, 'blah'); - 'asd'.should.not.have.property('foo', 3, 'blah'); - }, 'blah: \'asd\' has no property \'foo\''); + expect('asd').to.not.have.property('foo', 3, 'blah'); + 'asd'.should.not.have.property('foo', 3, 'blah'); - err(() => { - expect('asd').to.have.property('constructor', Number, 'blah'); - 'asd'.should.have.property('constructor', Number, 'blah'); - }, 'blah: expected \'asd\' to have a property \'constructor\' of [Function: Number], but got [Function: String]'); + expect('asd').to.have.property('constructor', Number, 'blah'); + 'asd'.should.have.property('constructor', Number, 'blah'); } function deepProperty2() { @@ -658,24 +531,18 @@ function deepProperty2() { ({ foo: { bar: 'baz' } }).should .have.deep.property('foo.bar', 'baz'); - err(() => { - expect({ foo: { bar: 'baz' } }) - .to.have.deep.property('foo.bar', 'quux', 'blah'); - ({ foo: { bar: 'baz' } }).should - .have.deep.property('foo.bar', 'quux', 'blah'); - }, 'blah: expected { foo: { bar: \'baz\' } } to have a deep property \'foo.bar\' of \'quux\', but got \'baz\''); - err(() => { - expect({ foo: { bar: 'baz' } }) - .to.not.have.deep.property('foo.bar', 'baz', 'blah'); - ({ foo: { bar: 'baz' } }).should - .not.have.deep.property('foo.bar', 'baz', 'blah'); - }, 'blah: expected { foo: { bar: \'baz\' } } to not have a deep property \'foo.bar\' of \'baz\''); - err(() => { - expect({ foo: 5 }) - .to.not.have.deep.property('foo.bar', 'baz', 'blah'); - ({ foo: 5 }).should - .not.have.deep.property('foo.bar', 'baz', 'blah'); - }, 'blah: { foo: 5 } has no deep property \'foo.bar\''); + expect({ foo: { bar: 'baz' } }) + .to.have.deep.property('foo.bar', 'quux', 'blah'); + ({ foo: { bar: 'baz' } }).should + .have.deep.property('foo.bar', 'quux', 'blah'); + expect({ foo: { bar: 'baz' } }) + .to.not.have.deep.property('foo.bar', 'baz', 'blah'); + ({ foo: { bar: 'baz' } }).should + .not.have.deep.property('foo.bar', 'baz', 'blah'); + expect({ foo: 5 }) + .to.not.have.deep.property('foo.bar', 'baz', 'blah'); + ({ foo: 5 }).should + .not.have.deep.property('foo.bar', 'baz', 'blah'); } function ownProperty() { @@ -686,10 +553,8 @@ function ownProperty() { expect({ length: 12 }).to.have.ownProperty('length'); ({ length: 12 }).should.have.ownProperty('length'); - err(() => { - expect({ length: 12 }).to.not.have.ownProperty('length', 'blah'); - ({ length: 12 }).should.not.have.ownProperty('length', 'blah'); - }, 'blah: expected { length: 12 } to not have own property \'length\''); + expect({ length: 12 }).to.not.have.ownProperty('length', 'blah'); + ({ length: 12 }).should.not.have.ownProperty('length', 'blah'); } function ownPropertyDescriptor() { @@ -714,20 +579,14 @@ function string() { expect('foobar').to.not.have.string('baz'); 'foobar'.should.not.have.string('baz'); - err(() => { - expect(3).to.have.string('baz'); - (3).should.have.string('baz'); - }, 'expected 3 to be a string'); + expect(3).to.have.string('baz'); + (3).should.have.string('baz'); - err(() => { - expect('foobar').to.have.string('baz', 'blah'); - 'foobar'.should.have.string('baz', 'blah'); - }, 'blah: expected \'foobar\' to contain \'baz\''); + expect('foobar').to.have.string('baz', 'blah'); + 'foobar'.should.have.string('baz', 'blah'); - err(() => { - expect('foobar').to.not.have.string('bar', 'blah'); - 'foobar'.should.not.have.string('bar', 'blah'); - }, 'blah: expected \'foobar\' to not contain \'bar\''); + expect('foobar').to.not.have.string('bar', 'blah'); + 'foobar'.should.not.have.string('bar', 'blah'); } function include() { @@ -743,20 +602,15 @@ function include() { ['foo', 'bar'].should.not.include('baz'); expect(['foo', 'bar']).to.not.include(1); ['foo', 'bar'].should.not.include(1); - // alias expect(['foo', 'bar']).includes('foo'); ['foo', 'bar'].should.includes('foo'); - err(() => { - expect(['foo']).to.include('bar', 'blah'); - ['foo'].should.include('bar', 'blah'); - }, 'blah: expected [ \'foo\' ] to include \'bar\''); + expect(['foo']).to.include('bar', 'blah'); + ['foo'].should.include('bar', 'blah'); - err(() => { - expect(['bar', 'foo']).to.not.include('foo', 'blah'); - ['bar', 'foo'].should.not.include('foo', 'blah'); - }, 'blah: expected [ \'bar\', \'foo\' ] to not include \'foo\''); + expect(['bar', 'foo']).to.not.include('foo', 'blah'); + ['bar', 'foo'].should.not.include('foo', 'blah'); } function keys() { @@ -803,76 +657,50 @@ function keys() { expect({ foo: 1, bar: 2 }).to.not.contain.keys('baz', 'foo'); ({ foo: 1, bar: 2 }).should.not.contain.keys('baz', 'foo'); - err(() => { - expect({ foo: 1 }).to.have.keys(); - ({ foo: 1 }).should.have.keys(); - }, 'keys required'); + expect({ foo: 1 }).to.have.keys(); + ({ foo: 1 }).should.have.keys(); - err(() => { - expect({ foo: 1 }).to.have.keys([]); - ({ foo: 1 }).should.have.keys([]); - }, 'keys required'); + expect({ foo: 1 }).to.have.keys([]); + ({ foo: 1 }).should.have.keys([]); - err(() => { - expect({ foo: 1 }).to.not.have.keys([]); - ({ foo: 1 }).should.not.have.keys([]); - }, 'keys required'); + expect({ foo: 1 }).to.not.have.keys([]); + ({ foo: 1 }).should.not.have.keys([]); - err(() => { - expect({ foo: 1 }).to.contain.keys([]); - ({ foo: 1 }).should.contain.keys([]); - }, 'keys required'); + expect({ foo: 1 }).to.contain.keys([]); + ({ foo: 1 }).should.contain.keys([]); - err(() => { - expect({ foo: 1 }).to.have.keys(['bar']); - ({ foo: 1 }).should.have.keys(['bar']); - }, 'expected { foo: 1 } to have key \'bar\''); + expect({ foo: 1 }).to.have.keys(['bar']); + ({ foo: 1 }).should.have.keys(['bar']); - err(() => { - expect({ foo: 1 }).to.have.keys(['bar', 'baz']); - ({ foo: 1 }).should.have.keys(['bar', 'baz']); - }, 'expected { foo: 1 } to have keys \'bar\', and \'baz\''); + expect({ foo: 1 }).to.have.keys(['bar', 'baz']); + ({ foo: 1 }).should.have.keys(['bar', 'baz']); - err(() => { - expect({ foo: 1 }).to.have.keys(['foo', 'bar', 'baz']); - ({ foo: 1 }).should.have.keys(['foo', 'bar', 'baz']); - }, 'expected { foo: 1 } to have keys \'foo\', \'bar\', and \'baz\''); + expect({ foo: 1 }).to.have.keys(['foo', 'bar', 'baz']); + ({ foo: 1 }).should.have.keys(['foo', 'bar', 'baz']); - err(() => { - expect({ foo: 1 }).to.not.have.keys(['foo']); - ({ foo: 1 }).should.not.have.keys(['foo']); - }, 'expected { foo: 1 } to not have key \'foo\''); + expect({ foo: 1 }).to.not.have.keys(['foo']); + ({ foo: 1 }).should.not.have.keys(['foo']); - err(() => { - expect({ foo: 1 }).to.not.have.keys(['foo']); - ({ foo: 1 }).should.not.have.keys(['foo']); - }, 'expected { foo: 1 } to not have key \'foo\''); + expect({ foo: 1 }).to.not.have.keys(['foo']); + ({ foo: 1 }).should.not.have.keys(['foo']); - err(() => { - expect({ foo: 1, bar: 2 }).to.not.have.keys(['foo', 'bar']); - ({ foo: 1, bar: 2 }).should.not.have.keys(['foo', 'bar']); - }, 'expected { foo: 1, bar: 2 } to not have keys \'foo\', and \'bar\''); + expect({ foo: 1, bar: 2 }).to.not.have.keys(['foo', 'bar']); + ({ foo: 1, bar: 2 }).should.not.have.keys(['foo', 'bar']); - err(() => { - expect({ foo: 1 }).to.not.contain.keys(['foo']); - ({ foo: 1 }).should.not.contain.keys(['foo']); - }, 'expected { foo: 1 } to not contain key \'foo\''); + expect({ foo: 1 }).to.not.contain.keys(['foo']); + ({ foo: 1 }).should.not.contain.keys(['foo']); - err(() => { - expect({ foo: 1 }).to.contain.keys('foo', 'bar'); - ({ foo: 1 }).should.contain.keys('foo', 'bar'); - }, 'expected { foo: 1 } to contain keys \'foo\', and \'bar\''); + expect({ foo: 1 }).to.contain.keys('foo', 'bar'); + ({ foo: 1 }).should.contain.keys('foo', 'bar'); } function chaining() { - var tea = { name: 'chai', extras: ['milk', 'sugar', 'smile'] }; + const tea = { name: 'chai', extras: ['milk', 'sugar', 'smile'] }; expect(tea).to.have.property('extras').with.lengthOf(3); tea.should.have.property('extras').with.lengthOf(3); - err(() => { - expect(tea).to.have.property('extras').with.lengthOf(4); - tea.should.have.property('extras').with.lengthOf(4); - }, 'expected [ \'milk\', \'sugar\', \'smile\' ] to have a length of 4 but got 3'); + expect(tea).to.have.property('extras').with.lengthOf(4); + tea.should.have.property('extras').with.lengthOf(4); expect(tea).to.be.a('object').and.have.property('name', 'chai'); tea.should.be.a('object').and.have.property('name', 'chai'); @@ -906,9 +734,9 @@ function _throw() { // only set the name inside the constructor itself. PoorlyConstructedError.prototype = Object.create(Error.prototype); - var specificError = new RangeError('boo'); + const specificError = new RangeError('boo'); - var goodFn = () => { } + const goodFn = () => { } , badFn = () => { throw new Error('testing'); } , refErrFn = () => { throw new ReferenceError('hello'); } , ickyErrFn = () => { throw new PoorlyConstructedError(); } @@ -989,116 +817,80 @@ function _throw() { badFn.should.throw(Error, 'testing'); should.throw(badFn, Error, 'testing'); - err(() => { - expect(goodFn).to.throw(); - goodFn.should.throw(); - should.throw(goodFn); - }, 'expected [Function] to throw an error'); + expect(goodFn).to.throw(); + goodFn.should.throw(); + should.throw(goodFn); - err(() => { - expect(goodFn).to.throw(ReferenceError); - goodFn.should.throw(ReferenceError); - should.throw(goodFn, ReferenceError); - }, 'expected [Function] to throw ReferenceError'); + expect(goodFn).to.throw(ReferenceError); + goodFn.should.throw(ReferenceError); + should.throw(goodFn, ReferenceError); - err(() => { - expect(goodFn).to.throw(specificError); - goodFn.should.throw(specificError); - should.throw(goodFn, specificError); - }, 'expected [Function] to throw [RangeError: boo]'); + expect(goodFn).to.throw(specificError); + goodFn.should.throw(specificError); + should.throw(goodFn, specificError); - err(() => { - expect(badFn).to.not.throw(); - badFn.should.not.throw(); - should.not.throw(badFn); - }, 'expected [Function] to not throw an error but [Error: testing] was thrown'); + expect(badFn).to.not.throw(); + badFn.should.not.throw(); + should.not.throw(badFn); - err(() => { - expect(badFn).to.throw(ReferenceError); - badFn.should.throw(ReferenceError); - should.throw(badFn, ReferenceError); - }, 'expected [Function] to throw \'ReferenceError\' but [Error: testing] was thrown'); + expect(badFn).to.throw(ReferenceError); + badFn.should.throw(ReferenceError); + should.throw(badFn, ReferenceError); - err(() => { - expect(badFn).to.throw(specificError); - badFn.should.throw(specificError); - should.throw(badFn, specificError); - }, 'expected [Function] to throw [RangeError: boo] but [Error: testing] was thrown'); + expect(badFn).to.throw(specificError); + badFn.should.throw(specificError); + should.throw(badFn, specificError); - err(() => { - expect(badFn).to.not.throw(Error); - badFn.should.not.throw(Error); - should.not.throw(badFn, Error); - }, 'expected [Function] to not throw \'Error\' but [Error: testing] was thrown'); + expect(badFn).to.not.throw(Error); + badFn.should.not.throw(Error); + should.not.throw(badFn, Error); - err(() => { - expect(refErrFn).to.not.throw(ReferenceError); - refErrFn.should.not.throw(ReferenceError); - should.not.throw(refErrFn, ReferenceError); - }, 'expected [Function] to not throw \'ReferenceError\' but [ReferenceError: hello] was thrown'); + expect(refErrFn).to.not.throw(ReferenceError); + refErrFn.should.not.throw(ReferenceError); + should.not.throw(refErrFn, ReferenceError); - err(() => { - expect(badFn).to.throw(PoorlyConstructedError); - badFn.should.throw(PoorlyConstructedError); - should.throw(badFn, PoorlyConstructedError); - }, 'expected [Function] to throw \'PoorlyConstructedError\' but [Error: testing] was thrown'); + expect(badFn).to.throw(PoorlyConstructedError); + badFn.should.throw(PoorlyConstructedError); + should.throw(badFn, PoorlyConstructedError); - err(() => { - expect(ickyErrFn).to.not.throw(PoorlyConstructedError); - ickyErrFn.should.not.throw(PoorlyConstructedError); - should.not.throw(ickyErrFn, PoorlyConstructedError); - }, /^(expected \[Function\] to not throw 'PoorlyConstructedError' but)(.*)(PoorlyConstructedError|\{ Object \()(.*)(was thrown)$/); + expect(ickyErrFn).to.not.throw(PoorlyConstructedError); + ickyErrFn.should.not.throw(PoorlyConstructedError); + should.not.throw(ickyErrFn, PoorlyConstructedError); - err(() => { - expect(ickyErrFn).to.throw(ReferenceError); - ickyErrFn.should.throw(ReferenceError); - should.throw(ickyErrFn, ReferenceError); - }, /^(expected \[Function\] to throw 'ReferenceError' but)(.*)(PoorlyConstructedError|\{ Object \()(.*)(was thrown)$/); + expect(ickyErrFn).to.throw(ReferenceError); + ickyErrFn.should.throw(ReferenceError); + should.throw(ickyErrFn, ReferenceError); - err(() => { - expect(specificErrFn).to.throw(new ReferenceError('eek')); - specificErrFn.should.throw(new ReferenceError('eek')); - should.throw(specificErrFn, new ReferenceError('eek')); - }, 'expected [Function] to throw [ReferenceError: eek] but [RangeError: boo] was thrown'); + expect(specificErrFn).to.throw(new ReferenceError('eek')); + specificErrFn.should.throw(new ReferenceError('eek')); + should.throw(specificErrFn, new ReferenceError('eek')); - err(() => { - expect(specificErrFn).to.not.throw(specificError); - specificErrFn.should.not.throw(specificError); - should.not.throw(specificErrFn, specificError); - }, 'expected [Function] to not throw [RangeError: boo]'); + expect(specificErrFn).to.not.throw(specificError); + specificErrFn.should.not.throw(specificError); + should.not.throw(specificErrFn, specificError); - err(() => { - expect(badFn).to.not.throw(/testing/); - badFn.should.not.throw(/testing/); - should.not.throw(badFn, /testing/); - }, 'expected [Function] to throw error not matching /testing/'); + expect(badFn).to.not.throw(/testing/); + badFn.should.not.throw(/testing/); + should.not.throw(badFn, /testing/); - err(() => { - expect(badFn).to.throw(/hello/); - badFn.should.throw(/hello/); - should.throw(badFn, /hello/); - }, 'expected [Function] to throw error matching /hello/ but got \'testing\''); + expect(badFn).to.throw(/hello/); + badFn.should.throw(/hello/); + should.throw(badFn, /hello/); - err(() => { - expect(badFn).to.throw(Error, /hello/, 'blah'); - badFn.should.throw(Error, /hello/, 'blah'); - should.throw(badFn, Error, /hello/, 'blah'); - }, 'blah: expected [Function] to throw error matching /hello/ but got \'testing\''); + expect(badFn).to.throw(Error, /hello/, 'blah'); + badFn.should.throw(Error, /hello/, 'blah'); + should.throw(badFn, Error, /hello/, 'blah'); - err(() => { - expect(badFn).to.throw(Error, 'hello', 'blah'); - badFn.should.throw(Error, 'hello', 'blah'); - should.throw(badFn, Error, 'hello', 'blah'); - }, 'blah: expected [Function] to throw error including \'hello\' but got \'testing\''); + expect(badFn).to.throw(Error, 'hello', 'blah'); + badFn.should.throw(Error, 'hello', 'blah'); + should.throw(badFn, Error, 'hello', 'blah'); } function use() { - // ReSharper disable once InconsistentNaming chai.use((_chai) => { _chai.can.use.any(); }); - // chain style: use mulptile plug-ins let expect = chai .use((_chai, util) => {}) .use((_chai, util) => {}) @@ -1114,7 +906,7 @@ class Klass { } function respondTo() { - var obj = new Klass(); + const obj = new Klass(); expect(Klass).to.respondTo('bar'); expect(obj).respondsTo('bar'); @@ -1128,15 +920,11 @@ function respondTo() { expect(obj).not.to.respondTo('foo'); obj.should.not.respondTo('foo'); - err(() => { - expect(Klass).to.respondTo('baz', 'constructor'); - Klass.should.respondTo('baz', 'constructor'); - }, /^(constructor: expected)(.*)(\[Function: Klass\])(.*)(to respond to \'baz\')$/); + expect(Klass).to.respondTo('baz', 'constructor'); + Klass.should.respondTo('baz', 'constructor'); - err(() => { - expect(obj).to.respondTo('baz', 'object'); - obj.should.respondTo('baz', 'object'); - }, /^(object: expected)(.*)(\{ foo: \[Function\] \}|\{ Object \()(.*)(to respond to \'baz\')$/); + expect(obj).to.respondTo('baz', 'object'); + obj.should.respondTo('baz', 'object'); } function satisfy() { @@ -1147,10 +935,8 @@ function satisfy() { expect(1).to.satisfy(matcher); (1).should.satisfy(matcher); - err(() => { - expect(2).to.satisfy(matcher, 'blah'); - (2).should.satisfy(matcher, 'blah'); - }, 'blah: expected 2 to satisfy [Function: matcher]'); + expect(2).to.satisfy(matcher, 'blah'); + (2).should.satisfy(matcher, 'blah'); } function closeTo() { @@ -1161,15 +947,11 @@ function closeTo() { expect(-10).to.be.closeTo(20, 30); (-10).should.be.closeTo(20, 30); - err(() => { - expect(2).to.be.closeTo(1.0, 0.5, 'blah'); - (2).should.be.closeTo(1.0, 0.5, 'blah'); - }, 'blah: expected 2 to be close to 1 +/- 0.5'); + expect(2).to.be.closeTo(1.0, 0.5, 'blah'); + (2).should.be.closeTo(1.0, 0.5, 'blah'); - err(() => { - expect(-10).to.be.closeTo(20, 29, 'blah'); - (-10).should.be.closeTo(20, 29, 'blah'); - }, 'blah: expected -10 to be close to 20 +/- 29'); + expect(-10).to.be.closeTo(20, 29, 'blah'); + (-10).should.be.closeTo(20, 29, 'blah'); } function approximately() { @@ -1180,15 +962,11 @@ function approximately() { expect(-10).to.be.approximately(20, 30); (-10).should.be.approximately(20, 30); - err(() => { - expect(2).to.be.approximately(1.0, 0.5, 'blah'); - (2).should.be.approximately(1.0, 0.5, 'blah'); - }, 'blah: expected 2 to be close to 1 +/- 0.5'); + expect(2).to.be.approximately(1.0, 0.5, 'blah'); + (2).should.be.approximately(1.0, 0.5, 'blah'); - err(() => { - expect(-10).to.be.approximately(20, 29, 'blah'); - (-10).should.be.approximately(20, 29, 'blah'); - }, 'blah: expected -10 to be close to 20 +/- 29'); + expect(-10).to.be.approximately(20, 29, 'blah'); + (-10).should.be.approximately(20, 29, 'blah'); } function includeMembers() { @@ -1249,10 +1027,10 @@ function members() { } function increaseDecreaseChange() { - var obj = { val: 10 }; - var inc = () => { obj.val++; }; - var dec = () => { obj.val--; }; - var same = () => { }; + const obj = { val: 10 }; + const inc = () => { obj.val++; }; + const dec = () => { obj.val--; }; + const same = () => { }; expect(inc).to.increase(obj, "val"); expect(inc).increases(obj, "val"); @@ -1281,7 +1059,7 @@ function increaseDecreaseChange() { } function oneOf() { - var obj = { z: 3 }; + const obj = { z: 3 }; expect(5).to.be.oneOf([1, 5, 4]); expect('z').to.be.oneOf(['x', 'y', 'z']); @@ -1311,28 +1089,17 @@ class CrashyObject { suite('assert', () => { test('assert', () => { - var foo = 'bar'; + const foo: string = 'bar'; assert(foo === 'bar', 'expected foo to equal `bar`'); - err(() => { - assert(foo === 'baz', 'expected foo to equal `bar`'); - }, 'expected foo to equal `bar`'); + assert(foo === 'baz', 'expected foo to equal `bar`'); }); test('isTrue', () => { assert.isTrue(true); - - err(() => { - assert.isTrue(false); - }, 'expected false to be true'); - - err(() => { - assert.isTrue(1); - }, 'expected 1 to be true'); - - err(() => { - assert.isTrue('test'); - }, 'expected \'test\' to be true'); + assert.isTrue(false); + assert.isTrue(1); + assert.isTrue('test'); }); test('ok', () => { @@ -1342,18 +1109,9 @@ suite('assert', () => { assert.isOk(true); assert.isOk(1); assert.isOk('test'); - - err(() => { - assert.ok(false); - }, 'expected false to be truthy'); - - err(() => { - assert.ok(0); - }, 'expected 0 to be truthy'); - - err(() => { - assert.ok(''); - }, 'expected \'\' to be truthy'); + assert.ok(false); + assert.ok(0); + assert.ok(''); }); test('notOk', () => { @@ -1363,30 +1121,15 @@ suite('assert', () => { assert.isNotOk(false); assert.isNotOk(0); assert.isNotOk(''); - - err(() => { - assert.notOk(true); - }, 'expected true to be falsy'); - - err(() => { - assert.notOk(1); - }, 'expected 1 to be falsy'); - - err(() => { - assert.notOk('test'); - }, 'expected \'test\' to be falsy'); + assert.notOk(true); + assert.notOk(1); + assert.notOk('test'); }); test('isFalse', () => { assert.isFalse(false); - - err(() => { - assert.isFalse(true); - }, 'expected true to be false'); - - err(() => { - assert.isFalse(0); - }, 'expected 0 to be false'); + assert.isFalse(true); + assert.isFalse(0); }); test('equal', () => { @@ -1397,387 +1140,235 @@ suite('assert', () => { assert.typeOf('test', 'string'); assert.typeOf(true, 'boolean'); assert.typeOf(5, 'number'); - - err(() => { - assert.typeOf(5, 'string'); - }, 'expected 5 to be a string'); - + assert.typeOf(5, 'string'); }); test('notTypeOf', () => { assert.notTypeOf('test', 'number'); - - err(() => { - assert.notTypeOf(5, 'number'); - }, 'expected 5 not to be a number'); + assert.notTypeOf(5, 'number'); }); test('instanceOf', () => { assert.instanceOf(new Foo(), Foo); - - err(() => { - assert.instanceOf(5, Foo); - }, 'expected 5 to be an instance of Foo'); + assert.instanceOf(5, Foo); assert.instanceOf(new CrashyObject(), CrashyObject); }); test('notInstanceOf', () => { assert.notInstanceOf(new Foo(), String); - - err(() => { - assert.notInstanceOf(new Foo(), Foo); - }, 'expected {} to not be an instance of Foo'); + assert.notInstanceOf(new Foo(), Foo); }); test('isObject', () => { assert.isObject({}); assert.isObject(new Foo()); - - err(() => { - assert.isObject(true); - }, 'expected true to be an object'); - - err(() => { - assert.isObject(Foo); - }, 'expected [Function: Foo] to be an object'); - - err(() => { - assert.isObject('foo'); - }, 'expected \'foo\' to be an object'); + assert.isObject(true); + assert.isObject(Foo); + assert.isObject('foo'); }); test('isNotObject', () => { assert.isNotObject(5); - - err(() => { - assert.isNotObject({}); - }, 'expected {} not to be an object'); + assert.isNotObject({}); }); test('notEqual', () => { assert.notEqual(3, 4); - - err(() => { - assert.notEqual(5, 5); - }, 'expected 5 to not equal 5'); + assert.notEqual(5, 5); }); test('strictEqual', () => { assert.strictEqual('foo', 'foo'); - - err(() => { - assert.strictEqual('5', 5); - }, 'expected \'5\' to equal 5'); }); test('notStrictEqual', () => { - assert.notStrictEqual(5, '5'); - - err(() => { - assert.notStrictEqual(5, 5); - }, 'expected 5 to not equal 5'); + assert.notStrictEqual(5, 5); }); test('deepEqual', () => { assert.deepEqual({ tea: 'chai' }, { tea: 'chai' }); + assert.deepEqual({ tea: 'chai' }, { tea: 'black' }); - err(() => { - assert.deepEqual({ tea: 'chai' }, { tea: 'black' }); - }, 'expected { tea: \'chai\' } to deeply equal { tea: \'black\' }'); - - var obja = Object.create({ tea: 'chai' }) + const obja = Object.create({ tea: 'chai' }) , objb = Object.create({ tea: 'chai' }); assert.deepEqual(obja, objb); - var obj1 = Object.create({ tea: 'chai' }) + const obj1 = Object.create({ tea: 'chai' }) , obj2 = Object.create({ tea: 'black' }); - err(() => { - assert.deepEqual(obj1, obj2); - }, 'expected { tea: \'chai\' } to deeply equal { tea: \'black\' }'); + assert.deepEqual(obj1, obj2); }); test('deepEqual (ordering)', () => { - var a = { a: 'b', c: 'd' } + const a = { a: 'b', c: 'd' } , b = { c: 'd', a: 'b' }; assert.deepEqual(a, b); }); test('deepEqual (circular)', () => { - var circularObject: any = {} + const circularObject: any = {} , secondCircularObject: any = {}; circularObject.field = circularObject; secondCircularObject.field = secondCircularObject; assert.deepEqual(circularObject, secondCircularObject); - err(() => { - secondCircularObject.field2 = secondCircularObject; - assert.deepEqual(circularObject, secondCircularObject); - }, 'expected { field: [Circular] } to deeply equal { Object (field, field2) }'); + secondCircularObject.field2 = secondCircularObject; + assert.deepEqual(circularObject, secondCircularObject); }); test('notDeepEqual', () => { assert.notDeepEqual({ tea: 'jasmine' }, { tea: 'chai' }); - err(() => { - assert.notDeepEqual({ tea: 'chai' }, { tea: 'chai' }); - }, 'expected { tea: \'chai\' } to not deeply equal { tea: \'chai\' }'); + assert.notDeepEqual({ tea: 'chai' }, { tea: 'chai' }); }); test('notDeepEqual (circular)', () => { - var circularObject: any = {} + const circularObject: any = {} , secondCircularObject: any = { tea: 'jasmine' }; circularObject.field = circularObject; secondCircularObject.field = secondCircularObject; assert.notDeepEqual(circularObject, secondCircularObject); - err(() => { - delete secondCircularObject.tea; - assert.notDeepEqual(circularObject, secondCircularObject); - }, 'expected { field: [Circular] } to not deeply equal { field: [Circular] }'); + delete secondCircularObject.tea; + assert.notDeepEqual(circularObject, secondCircularObject); }); test('isNull', () => { assert.isNull(null); - - err(() => { - assert.isNull(undefined); - }, 'expected undefined to equal null'); + assert.isNull(undefined); }); test('isNotNull', () => { assert.isNotNull(undefined); - - err(() => { - assert.isNotNull(null); - }, 'expected null to not equal null'); + assert.isNotNull(null); }); test('isUndefined', () => { assert.isUndefined(undefined); - - err(() => { - assert.isUndefined(null); - }, 'expected null to equal undefined'); + assert.isUndefined(null); }); test('isDefined', () => { assert.isDefined(null); - - err(() => { - assert.isDefined(undefined); - }, 'expected undefined to not equal undefined'); + assert.isDefined(undefined); }); test('isNaN', () => { assert.isNaN(NaN); - - err(() => { - assert.isNaN(12); - }, 'expected 12 to be NaN'); + assert.isNaN(12); }); test('isNotNaN', () => { assert.isNotNaN(12); - - err(() => { - assert.isNotNaN(NaN); - }, 'expected NaN to not NaN'); + assert.isNotNaN(NaN); }); test('isFunction', () => { - var func = () => { + const func = () => { }; assert.isFunction(func); - - err(() => { - assert.isFunction({}); - }, 'expected {} to be a function'); + assert.isFunction({}); }); test('isNotFunction', () => { assert.isNotFunction(5); - - err(() => { - assert.isNotFunction(() => { - }); - }, 'expected [Function] not to be a function'); + assert.isNotFunction(() => {}); }); test('isArray', () => { assert.isArray([]); assert.isArray(new Array()); - - err(() => { - assert.isArray({}); - }, 'expected {} to be an array'); + assert.isArray({}); }); test('isNotArray', () => { assert.isNotArray(3); - - err(() => { - assert.isNotArray([]); - }, 'expected [] not to be an array'); - - err(() => { - assert.isNotArray(new Array()); - }, 'expected [] not to be an array'); + assert.isNotArray([]); + assert.isNotArray(new Array()); }); test('isString', () => { assert.isString('Foo'); assert.isString(new String('foo')); - - err(() => { - assert.isString(1); - }, 'expected 1 to be a string'); + assert.isString(1); }); test('isNotString', () => { assert.isNotString(3); assert.isNotString(['hello']); - - err(() => { - assert.isNotString('hello'); - }, 'expected \'hello\' not to be a string'); + assert.isNotString('hello'); }); test('isNumber', () => { assert.isNumber(1); assert.isNumber(Number('3')); - - err(() => { - assert.isNumber('1'); - }, 'expected \'1\' to be a number'); + assert.isNumber('1'); }); test('isNotNumber', () => { assert.isNotNumber('hello'); assert.isNotNumber([5]); - - err(() => { - assert.isNotNumber(4); - }, 'expected 4 not to be a number'); + assert.isNotNumber(4); }); test('isBoolean', () => { assert.isBoolean(true); assert.isBoolean(false); - - err(() => { - assert.isBoolean('1'); - }, 'expected \'1\' to be a boolean'); + assert.isBoolean('1'); }); test('isNotBoolean', () => { assert.isNotBoolean('true'); - - err(() => { - assert.isNotBoolean(true); - }, 'expected true not to be a boolean'); - - err(() => { - assert.isNotBoolean(false); - }, 'expected false not to be a boolean'); + assert.isNotBoolean(true); + assert.isNotBoolean(false); }); test('include', () => { assert.include('foobar', 'bar'); assert.include([1, 2, 3], 3); - - err(() => { - assert.include('foobar', 'baz'); - }, 'expected \'foobar\' to contain \'baz\''); - - err(() => { - assert.include(undefined, 'bar'); - }, 'expected an array or string'); + assert.include('foobar', 'baz'); + assert.include(undefined, 'bar'); }); test('notInclude', () => { assert.notInclude('foobar', 'baz'); assert.notInclude([1, 2, 3], 4); - - err(() => { - assert.notInclude('foobar', 'bar'); - }, 'expected \'foobar\' to not contain \'bar\''); - - err(() => { - assert.notInclude(undefined, 'bar'); - }, 'expected an array or string'); + assert.notInclude('foobar', 'bar'); + assert.notInclude(undefined, 'bar'); }); test('lengthOf', () => { assert.lengthOf([1, 2, 3], 3); assert.lengthOf('foobar', 6); - - err(() => { - assert.lengthOf('foobar', 5); - }, 'expected \'foobar\' to have a length of 5 but got 6'); - - err(() => { - assert.lengthOf(1, 5); - }, 'expected 1 to have a property \'length\''); + assert.lengthOf('foobar', 5); + assert.lengthOf(1, 5); }); test('match', () => { assert.match('foobar', /^foo/); assert.notMatch('foobar', /^bar/); - - err(() => { - assert.match('foobar', /^bar/i); - }, 'expected \'foobar\' to match /^bar/i'); - - err(() => { - assert.notMatch('foobar', /^foo/i); - }, 'expected \'foobar\' not to match /^foo/i'); + assert.match('foobar', /^bar/i); + assert.notMatch('foobar', /^foo/i); }); test('property', () => { - var obj = { foo: { bar: 'baz' } }; - var simpleObj = { foo: 'bar' }; + const obj = { foo: { bar: 'baz' } }; + const simpleObj = { foo: 'bar' } as any; assert.property(obj, 'foo'); assert.deepProperty(obj, 'foo.bar'); - assert.notProperty(obj, 'baz'); - assert.notProperty(obj, 'foo.bar'); assert.notDeepProperty(obj, 'foo.baz'); assert.deepPropertyVal(obj, 'foo.bar', 'baz'); - assert.deepPropertyNotVal(obj, 'foo.bar', 'flow'); - - err(() => { - assert.property(obj, 'baz'); - }, 'expected { foo: { bar: \'baz\' } } to have a property \'baz\''); - - err(() => { - assert.deepProperty(obj, 'foo.baz'); - }, 'expected { foo: { bar: \'baz\' } } to have a deep property \'foo.baz\''); - - err(() => { - assert.notProperty(obj, 'foo'); - }, 'expected { foo: { bar: \'baz\' } } to not have property \'foo\''); - - err(() => { - assert.notDeepProperty(obj, 'foo.bar'); - }, 'expected { foo: { bar: \'baz\' } } to not have deep property \'foo.bar\''); - - err(() => { - assert.propertyVal(simpleObj, 'foo', 'ball'); - }, 'expected { foo: \'bar\' } to have a property \'foo\' of \'ball\', but got \'bar\''); - - err(() => { - assert.deepPropertyVal(obj, 'foo.bar', 'ball'); - }, 'expected { foo: { bar: \'baz\' } } to have a deep property \'foo.bar\' of \'ball\', but got \'baz\''); - - err(() => { - assert.propertyNotVal(simpleObj, 'foo', 'bar'); - }, 'expected { foo: \'bar\' } to not have a property \'foo\' of \'bar\''); - - err(() => { - assert.deepPropertyNotVal(obj, 'foo.bar', 'baz'); - }, 'expected { foo: { bar: \'baz\' } } to not have a deep property \'foo.bar\' of \'baz\''); + assert.deepPropertyNotVal(simpleObj, 'foo.bar', 'flow'); + assert.property(simpleObj, 'baz'); + assert.deepProperty(obj, 'foo.baz'); + assert.notProperty(obj, 'foo'); + assert.notDeepProperty(obj, 'foo.bar'); + assert.propertyVal(simpleObj, 'foo', 'ball'); + assert.deepPropertyVal(obj, 'foo.bar', 'ball'); + assert.propertyNotVal(simpleObj, 'foo', 'bar'); + assert.deepPropertyNotVal(simpleObj, 'foo.bar', 'baz'); }); test('throws', () => { @@ -1797,69 +1388,47 @@ suite('assert', () => { throw new Error('bar'); }, Error, 'bar'); - err(() => { - assert.throws(() => { - throw new Error('foo'); - }, TypeError); - }, 'expected [Function] to throw \'TypeError\' but [Error: foo] was thrown'); + assert.throws(() => { + throw new Error('foo'); + }, TypeError); - err(() => { - assert.throws(() => { - throw new Error('foo'); - }, 'bar'); - }, 'expected [Function] to throw error including \'bar\' but got \'foo\''); + assert.throws(() => { + throw new Error('foo'); + }, 'bar'); - err(() => { - assert.throws(() => { - throw new Error('foo'); - }, Error, 'bar'); - }, 'expected [Function] to throw error including \'bar\' but got \'foo\''); + assert.throws(() => { + throw new Error('foo'); + }, Error, 'bar'); - err(() => { - assert.throws(() => { - throw new Error('foo'); - }, TypeError, 'bar'); - }, 'expected [Function] to throw \'TypeError\' but [Error: foo] was thrown'); + assert.throws(() => { + throw new Error('foo'); + }, TypeError, 'bar'); - err(() => { - assert.throws(() => { - }); - }, 'expected [Function] to throw an error'); + assert.throws(() => {}); - err(() => { - assert.throws(() => { - throw new Error(''); - }, 'bar'); - }, 'expected [Function] to throw error including \'bar\' but got \'\''); + assert.throws(() => { + throw new Error(''); + }, 'bar'); - err(() => { - assert.throws(() => { - throw new Error(''); - }, /bar/); - }, 'expected [Function] to throw error matching /bar/ but got \'\''); + assert.throws(() => { + throw new Error(''); + }, /bar/); }); test('doesNotThrow', () => { - assert.doesNotThrow(() => { - }); - assert.doesNotThrow(() => { - }, 'foo'); + assert.doesNotThrow(() => { }); + assert.doesNotThrow(() => { }, 'foo'); - err(() => { - assert.doesNotThrow(() => { - throw new Error('foo'); - }); - }, 'expected [Function] to not throw an error but [Error: foo] was thrown'); + assert.doesNotThrow(() => { + throw new Error('foo'); + }); }); test('ifError', () => { assert.ifError(false); assert.ifError(null); assert.ifError(undefined); - - err(() => { - assert.ifError('foo'); - }, 'expected \'foo\' to be falsy'); + assert.ifError('foo'); }); test('operator', () => { @@ -1870,117 +1439,58 @@ suite('assert', () => { assert.operator(1, '>=', 1); assert.operator(1, '!=', 2); assert.operator(1, '!==', 2); - - err(() => { - assert.operator(1, '=', 2); - }, 'Invalid operator "="'); - - err(() => { - assert.operator(2, '<', 1); - }, 'expected 2 to be < 1'); - - err(() => { - assert.operator(1, '>', 2); - }, 'expected 1 to be > 2'); - - err(() => { - assert.operator(1, '==', 2); - }, 'expected 1 to be == 2'); - - err(() => { - assert.operator(2, '<=', 1); - }, 'expected 2 to be <= 1'); - - err(() => { - assert.operator(1, '>=', 2); - }, 'expected 1 to be >= 2'); - - err(() => { - assert.operator(1, '!=', 1); - }, 'expected 1 to be != 1'); - - err(() => { - assert.operator(1, '!==', '1'); - }, 'expected 1 to be !== \'1\''); + assert.operator(2, '<', 1); + assert.operator(1, '>', 2); + assert.operator(1, '==', 2); + assert.operator(2, '<=', 1); + assert.operator(1, '>=', 2); + assert.operator(1, '!=', 1); + assert.operator(1, '!==', '1'); }); test('closeTo', () => { assert.closeTo(1.5, 1.0, 0.5); assert.closeTo(10, 20, 20); assert.closeTo(-10, 20, 30); - - err(() => { - assert.closeTo(2, 1.0, 0.5); - }, 'expected 2 to be close to 1 +/- 0.5'); - - err(() => { - assert.closeTo(-10, 20, 29); - }, 'expected -10 to be close to 20 +/- 29'); + assert.closeTo(2, 1.0, 0.5); + assert.closeTo(-10, 20, 29); }); test('approximately', () => { assert.approximately(1.5, 1.0, 0.5); assert.approximately(10, 20, 20); assert.approximately(-10, 20, 30); - - err(() => { - assert.approximately(2, 1.0, 0.5); - }, 'expected 2 to be close to 1 +/- 0.5'); - - err(() => { - assert.approximately(-10, 20, 29); - }, 'expected -10 to be close to 20 +/- 29'); + assert.approximately(2, 1.0, 0.5); + assert.approximately(-10, 20, 29); }); test('members', () => { assert.includeMembers([1, 2, 3], [2, 3]); assert.includeMembers([1, 2, 3], []); assert.includeMembers([1, 2, 3], [3]); - - err(() => { - assert.includeMembers([5, 6], [7, 8]); - }, 'expected [ 5, 6 ] to be a superset of [ 7, 8 ]'); - - err(() => { - assert.includeMembers([5, 6], [5, 6, 0]); - }, 'expected [ 5, 6 ] to be a superset of [ 5, 6, 0 ]'); + assert.includeMembers([5, 6], [7, 8]); + assert.includeMembers([5, 6], [5, 6, 0]); }); test('memberEquals', () => { assert.sameMembers([], []); assert.sameMembers([1, 2, 3], [3, 2, 1]); assert.sameMembers([4, 2], [4, 2]); - - err(() => { - assert.sameMembers([], [1, 2]); - }, 'expected [] to have the same members as [ 1, 2 ]'); - - err(() => { - assert.sameMembers([1, 54], [6, 1, 54]); - }, 'expected [ 1, 54 ] to have the same members as [ 6, 1, 54 ]'); + assert.sameMembers([], [1, 2]); + assert.sameMembers([1, 54], [6, 1, 54]); }); test('isAbove', () => { assert.isAbove(10, 5); - - err(() => { - assert.isAbove(1, 5); - }, 'expected 1 to be above 5'); - err(() => { - assert.isAbove(5, 5); - }, 'expected 5 to be above 5'); + assert.isAbove(1, 5); + assert.isAbove(5, 5); }); test('isBelow', () => { assert.isBelow(5, 10); - - err(() => { - assert.isBelow(5, 1); - }, 'expected 5 to be above 1'); - err(() => { - assert.isBelow(5, 5); - }, 'expected 5 to be below 5'); + assert.isBelow(5, 1); + assert.isBelow(5, 5); }); test('extensible', () => { assert.extensible({}); }); @@ -2000,53 +1510,153 @@ suite('assert', () => { test('isNotTrue', () => { assert.isNotTrue(false); - - err(() => { - assert.isNotTrue(true); - }, 'expected true to not be true'); + assert.isNotTrue(true); }); test('isNotFalse', () => { assert.isNotFalse(true); - - err(() => { - assert.isNotFalse(false); - }, 'expected false to not be false'); + assert.isNotFalse(false); }); test('isAtLeast', () => { assert.isAtLeast(5, 3); assert.isAtLeast(5, 5); - - err(() => { - assert.isAtLeast(3, 5); - }, 'expected 3 to be greater than or equal to 5'); + assert.isAtLeast(3, 5); }); test('isAtMost', () => { assert.isAtMost(3, 5); assert.isAtMost(5, 5); - - err(() => { - assert.isAtMost(5, 3); - }, 'expected 5 to be less than or equal to 3'); + assert.isAtMost(5, 3); }); test('oneOf', () => { - var obj = { z: 3 }; + const obj = { z: 3 }; assert.oneOf(5, [1, 5, 4]); assert.oneOf('z', ['x', 'y', 'z']); assert.oneOf(obj, [obj]); - - err(() => { - assert.oneOf(5, [1, [5], 4]); - }, 'expected 5 to be one of [1, [5], 4]'); - err(() => { - assert.oneOf('z', ['w', 'x', 'y']); - }, 'expected "z" to be one of [w, x, y]'); - err(() => { - assert.oneOf(obj, [{ z: 3 }]); - }, 'expected { z: 3 } to be one of [{ z: 3 }]'); + assert.oneOf(5, [1, [5], 4]); + assert.oneOf('z', ['w', 'x', 'y']); + assert.oneOf(obj, [{ z: 3 }]); }); -}); + + test('changes', () => { + const obj = { z: 3 }; + + assert.changes(() => {}, obj, 'z'); + assert.changes(() => {}, obj, 'z', 'message'); + }); + + test('doesNotChange', () => { + const obj = { z: 3 }; + + assert.doesNotChange(() => {}, obj, 'z'); + assert.doesNotChange(() => {}, obj, 'z', 'message'); + }); + + test('increases', () => { + const obj = { z: 3 }; + + assert.increases(() => {}, obj, 'z'); + assert.increases(() => {}, obj, 'z', 'message'); + }); + + test('doesNotIncrease', () => { + const obj = { z: 3 }; + + assert.doesNotIncrease(() => {}, obj, 'z'); + assert.doesNotIncrease(() => {}, obj, 'z', 'message'); + }); + + test('decreases', () => { + const obj = { z: 3 }; + + assert.decreases(() => {}, obj, 'z'); + assert.decreases(() => {}, obj, 'z', 'message'); + }); + + test('doesNotDecrease', () => { + const obj = { z: 3 }; + + assert.doesNotDecrease(() => {}, obj, 'z'); + assert.doesNotDecrease(() => {}, obj, 'z', 'message'); + }); + + test('ifError', () => { + const obj = { z: 3 }; + + assert.ifError(obj); + assert.ifError(obj, 'message'); + }); + + test('extensible', () => { + const obj = { z: 3 }; + + assert.extensible(obj); + assert.extensible(obj, 'message'); + }); + + test('isNotExtensible', () => { + const obj = { z: 3 }; + + assert.isNotExtensible(obj); + assert.isNotExtensible(obj, 'message'); + }); + + test('isSealed', () => { + const obj = { z: 3 }; + + assert.isSealed(obj); + assert.isSealed(obj, 'message'); + }); + + test('sealed', () => { + const obj = { z: 3 }; + + assert.sealed(obj); + assert.sealed(obj, 'message'); + }); + + test('isNotSealed', () => { + const obj = { z: 3 }; + + assert.isNotSealed(obj); + assert.isNotSealed(obj, 'message'); + }); + + test('notSealed', () => { + const obj = { z: 3 }; + + assert.notSealed(obj); + assert.notSealed(obj, 'message'); + }); + + test('isFrozen', () => { + const obj = { z: 3 }; + + assert.isFrozen(obj); + assert.isFrozen(obj, 'message'); + }); + + test('frozen', () => { + const obj = { z: 3 }; + + assert.frozen(obj); + assert.frozen(obj, 'message'); + }); + + test('isNotFrozen', () => { + const obj = { z: 3 }; + + assert.isNotFrozen(obj); + assert.isNotFrozen(obj, 'message'); + }); + + test('notFrozen', () => { + const obj = { z: 3 }; + + assert.notFrozen(obj); + assert.notFrozen(obj, 'message'); + }); +}); \ No newline at end of file diff --git a/types/chai/index.d.ts b/types/chai/index.d.ts index 532aa3b579..b349be0ac4 100644 --- a/types/chai/index.d.ts +++ b/types/chai/index.d.ts @@ -1,10 +1,11 @@ -// Type definitions for chai 3.4.0 +// Type definitions for chai 3.5.0 // Project: http://chaijs.com/ // Definitions by: Jed Mao , // Bart van der Schoor , // Andrew Brown , // Olivier Chevet , -// Matt Wistrand +// Matt Wistrand , +// Josh Goldberg // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // @@ -17,14 +18,15 @@ declare namespace Chai { /** * Provides a way to extend the internals of Chai */ - use(fn: (chai: any, utils: any) => void): ChaiStatic; + use(fn: (chai: (any), utils: any) => void): ChaiStatic; assert: AssertStatic; config: Config; AssertionError: typeof AssertionError; + version: string; } export interface ExpectStatic extends AssertionStatic { - fail(actual?: any, expected?: any, message?: string, operator?: string): void; + fail(actual?: any, expected?: any, message?: string, operator?: Operator): void; } export interface AssertStatic extends Assert { @@ -34,6 +36,10 @@ declare namespace Chai { (target: any, message?: string): Assertion; } + export type Operator = string; // "==" | "===" | ">" | ">=" | "<" | "<=" | "!=" | "!=="; + + export type OperatorComparable = boolean | null | number | string | undefined | Date; + interface ShouldAssertion { equal(value1: any, value2: any, message?: string): void; Throw: ShouldThrow; @@ -43,7 +49,7 @@ declare namespace Chai { interface Should extends ShouldAssertion { not: ShouldAssertion; - fail(actual: any, expected: any, message?: string, operator?: string): void; + fail(actual: any, expected: any, message?: string, operator?: Operator): void; } interface ShouldThrow { @@ -238,146 +244,975 @@ declare namespace Chai { } interface PropertyChange { - (object: Object, prop: string, msg?: string): Assertion; + (object: Object, property: string, message?: string): Assertion; } export interface Assert { /** - * @param expression Expression to test for truthiness. - * @param message Message to display on error. + * @param expression Expression to test for truthiness. + * @param message Message to display on error. */ (expression: any, message?: string): void; - fail(actual?: any, expected?: any, msg?: string, operator?: string): void; + /** + * Throws a failure. + * + * @type T Type of the objects. + * @param actual Actual value. + * @param expected Potential expected value. + * @param message Message to display on error. + * @param operator Comparison operator, if not strict equality. + * @remarks Node.js assert module-compatible. + */ + fail(actual?: T, expected?: T, message?: string, operator?: Operator): void; - ok(val: any, msg?: string): void; - isOk(val: any, msg?: string): void; - notOk(val: any, msg?: string): void; - isNotOk(val: any, msg?: string): void; + /** + * Asserts that object is truthy. + * + * @type T Type of object. + * @param object Object to test. + * @param message Message to display on error. + */ + isOk(value: T, message?: string): void; - equal(act: any, exp: any, msg?: string): void; - notEqual(act: any, exp: any, msg?: string): void; + /** + * Asserts that object is truthy. + * + * @type T Type of object. + * @param object Object to test. + * @param message Message to display on error. + */ + ok(value: T, message?: string): void; - strictEqual(act: any, exp: any, msg?: string): void; - notStrictEqual(act: any, exp: any, msg?: string): void; + /** + * Asserts that object is falsy. + * + * @type T Type of object. + * @param object Object to test. + * @param message Message to display on error. + */ + isNotOk(value: T, message?: string): void; - deepEqual(act: any, exp: any, msg?: string): void; - notDeepEqual(act: any, exp: any, msg?: string): void; + /** + * Asserts that object is falsy. + * + * @type T Type of object. + * @param object Object to test. + * @param message Message to display on error. + */ + notOk(value: T, message?: string): void; - isTrue(val: any, msg?: string): void; - isFalse(val: any, msg?: string): void; + /** + * Asserts non-strict equality (==) of actual and expected. + * + * @type T Type of the objects. + * @param actual Actual value. + * @param expected Potential expected value. + * @param message Message to display on error. + */ + equal(actual: T, expected: T, message?: string): void; - isNotTrue(val: any, msg?: string): void; - isNotFalse(val: any, msg?: string): void; + /** + * Asserts non-strict inequality (==) of actual and expected. + * + * @type T Type of the objects. + * @param actual Actual value. + * @param expected Potential expected value. + * @param message Message to display on error. + */ + notEqual(actual: T, expected: T, message?: string): void; - isNull(val: any, msg?: string): void; - isNotNull(val: any, msg?: string): void; + /** + * Asserts strict equality (===) of actual and expected. + * + * @type T Type of the objects. + * @param actual Actual value. + * @param expected Potential expected value. + * @param message Message to display on error. + */ + strictEqual(actual: T, expected: T, message?: string): void; - isUndefined(val: any, msg?: string): void; - isDefined(val: any, msg?: string): void; + /** + * Asserts strict inequality (==) of actual and expected. + * + * @type T Type of the objects. + * @param actual Actual value. + * @param expected Potential expected value. + * @param message Message to display on error. + */ + notStrictEqual(actual: T, expected: T, message?: string): void; - isNaN(val: any, msg?: string): void; - isNotNaN(val: any, msg?: string): void; + /** + * Asserts that actual is deeply equal to expected. + * + * @type T Type of the objects. + * @param actual Actual value. + * @param expected Potential expected value. + * @param message Message to display on error. + */ + deepEqual(actual: T, expected: T, message?: string): void; - isAbove(val: number, abv: number, msg?: string): void; - isBelow(val: number, blw: number, msg?: string): void; + /** + * Asserts that actual is not deeply equal to expected. + * + * @type T Type of the objects. + * @param actual Actual value. + * @param expected Potential expected value. + * @param message Message to display on error. + */ + notDeepEqual(actual: T, expected: T, message?: string): void; - isAtLeast(val: number, atlst: number, msg?: string): void; - isAtMost(val: number, atmst: number, msg?: string): void; + /** + * Asserts valueToCheck is strictly greater than (>) valueToBeAbove. + * + * @param valueToCheck Actual value. + * @param valueToBeAbove Minimum Potential expected value. + * @param message Message to display on error. + */ + isAbove(valueToCheck: number, valueToBeAbove: number, message?: string): void; - isFunction(val: any, msg?: string): void; - isNotFunction(val: any, msg?: string): void; + /** + * Asserts valueToCheck is greater than or equal to (>=) valueToBeAtLeast. + * + * @param valueToCheck Actual value. + * @param valueToBeAtLeast Minimum Potential expected value. + * @param message Message to display on error. + */ + isAtLeast(valueToCheck: number, valueToBeAtLeast: number, message?: string): void; - isObject(val: any, msg?: string): void; - isNotObject(val: any, msg?: string): void; + /** + * Asserts valueToCheck is strictly less than (<) valueToBeBelow. + * + * @param valueToCheck Actual value. + * @param valueToBeBelow Minimum Potential expected value. + * @param message Message to display on error. + */ + isBelow(valueToCheck: number, valueToBeBelow: number, message?: string): void; - isArray(val: any, msg?: string): void; - isNotArray(val: any, msg?: string): void; + /** + * Asserts valueToCheck is greater than or equal to (>=) valueToBeAtMost. + * + * @param valueToCheck Actual value. + * @param valueToBeAtMost Minimum Potential expected value. + * @param message Message to display on error. + */ + isAtMost(valueToCheck: number, valueToBeAtMost: number, message?: string): void; - isString(val: any, msg?: string): void; - isNotString(val: any, msg?: string): void; + /** + * Asserts that value is true. + * + * @type T Type of value. + * @param value Actual value. + * @param message Message to display on error. + */ + isTrue(value: T, message?: string): void; - isNumber(val: any, msg?: string): void; - isNotNumber(val: any, msg?: string): void; + /** + * Asserts that value is false. + * + * @type T Type of value. + * @param value Actual value. + * @param message Message to display on error. + */ + isFalse(value: T, message?: string): void; - isBoolean(val: any, msg?: string): void; - isNotBoolean(val: any, msg?: string): void; + /** + * Asserts that value is not true. + * + * @type T Type of value. + * @param value Actual value. + * @param message Message to display on error. + */ + isNotTrue(value: T, message?: string): void; - typeOf(val: any, type: string, msg?: string): void; - notTypeOf(val: any, type: string, msg?: string): void; + /** + * Asserts that value is not false. + * + * @type T Type of value. + * @param value Actual value. + * @param message Message to display on error. + */ + isNotFalse(value: T, message?: string): void; - instanceOf(val: any, type: Function, msg?: string): void; - notInstanceOf(val: any, type: Function, msg?: string): void; + /** + * Asserts that value is null. + * + * @type T Type of value. + * @param value Actual value. + * @param message Message to display on error. + */ + isNull(value: T, message?: string): void; - include(exp: string, inc: any, msg?: string): void; - include(exp: any[], inc: any, msg?: string): void; + /** + * Asserts that value is not null. + * + * @type T Type of value. + * @param value Actual value. + * @param message Message to display on error. + */ + isNotNull(value: T, message?: string): void; - notInclude(exp: string, inc: any, msg?: string): void; - notInclude(exp: any[], inc: any, msg?: string): void; + /** + * Asserts that value is not null. + * + * @type T Type of value. + * @param value Actual value. + * @param message Message to display on error. + */ + isNaN(value: T, message?: string): void; - match(exp: any, re: RegExp, msg?: string): void; - notMatch(exp: any, re: RegExp, msg?: string): void; + /** + * Asserts that value is not null. + * + * @type T Type of value. + * @param value Actual value. + * @param message Message to display on error. + */ + isNotNaN(value: T, message?: string): void; - property(obj: Object, prop: string, msg?: string): void; - notProperty(obj: Object, prop: string, msg?: string): void; - deepProperty(obj: Object, prop: string, msg?: string): void; - notDeepProperty(obj: Object, prop: string, msg?: string): void; + /** + * Asserts that value is undefined. + * + * @type T Type of value. + * @param value Actual value. + * @param message Message to display on error. + */ + isUndefined(value: T, message?: string): void; - propertyVal(obj: Object, prop: string, val: any, msg?: string): void; - propertyNotVal(obj: Object, prop: string, val: any, msg?: string): void; + /** + * Asserts that value is not undefined. + * + * @type T Type of value. + * @param value Actual value. + * @param message Message to display on error. + */ + isDefined(value: T, message?: string): void; - deepPropertyVal(obj: Object, prop: string, val: any, msg?: string): void; - deepPropertyNotVal(obj: Object, prop: string, val: any, msg?: string): void; + /** + * Asserts that value is a function. + * + * @type T Type of value. + * @param value Actual value. + * @param message Message to display on error. + */ + isFunction(value: T, message?: string): void; - lengthOf(exp: any, len: number, msg?: string): void; - //alias frenzy - throw(fn: Function, msg?: string): void; + /** + * Asserts that value is not a function. + * + * @type T Type of value. + * @param value Actual value. + * @param message Message to display on error. + */ + isNotFunction(value: T, message?: string): void; + + /** + * Asserts that value is an object of type 'Object' + * (as revealed by Object.prototype.toString). + * + * @type T Type of value. + * @param value Actual value. + * @param message Message to display on error. + * @remarks The assertion does not match subclassed objects. + */ + isObject(value: T, message?: string): void; + + /** + * Asserts that value is not an object of type 'Object' + * (as revealed by Object.prototype.toString). + * + * @type T Type of value. + * @param value Actual value. + * @param message Message to display on error. + */ + isNotObject(value: T, message?: string): void; + + /** + * Asserts that value is an array. + * + * @type T Type of value. + * @param value Actual value. + * @param message Message to display on error. + */ + isArray(value: T, message?: string): void; + + /** + * Asserts that value is not an array. + * + * @type T Type of value. + * @param value Actual value. + * @param message Message to display on error. + */ + isNotArray(value: T, message?: string): void; + + /** + * Asserts that value is a string. + * + * @type T Type of value. + * @param value Actual value. + * @param message Message to display on error. + */ + isString(value: T, message?: string): void; + + /** + * Asserts that value is not a string. + * + * @type T Type of value. + * @param value Actual value. + * @param message Message to display on error. + */ + isNotString(value: T, message?: string): void; + + /** + * Asserts that value is a number. + * + * @type T Type of value. + * @param value Actual value. + * @param message Message to display on error. + */ + isNumber(value: T, message?: string): void; + + /** + * Asserts that value is not a number. + * + * @type T Type of value. + * @param value Actual value. + * @param message Message to display on error. + */ + isNotNumber(value: T, message?: string): void; + + /** + * Asserts that value is a boolean. + * + * @type T Type of value. + * @param value Actual value. + * @param message Message to display on error. + */ + isBoolean(value: T, message?: string): void; + + /** + * Asserts that value is not a boolean. + * + * @type T Type of value. + * @param value Actual value. + * @param message Message to display on error. + */ + isNotBoolean(value: T, message?: string): void; + + /** + * Asserts that value's type is name, as determined by Object.prototype.toString. + * + * @type T Type of value. + * @param value Actual value. + * @param name Potential expected type name of value. + * @param message Message to display on error. + */ + typeOf(value: T, name: string, message?: string): void; + + /** + * Asserts that value's type is not name, as determined by Object.prototype.toString. + * + * @type T Type of value. + * @param value Actual value. + * @param name Potential expected type name of value. + * @param message Message to display on error. + */ + notTypeOf(value: T, name: string, message?: string): void; + + /** + * Asserts that value is an instance of constructor. + * + * @type T Type of value. + * @param value Actual value. + * @param constructor Potential expected contructor of value. + * @param message Message to display on error. + */ + instanceOf(value: T, constructor: Function, message?: string): void; + + /** + * Asserts that value is not an instance of constructor. + * + * @type T Type of value. + * @param value Actual value. + * @param constructor Potential expected contructor of value. + * @param message Message to display on error. + */ + notInstanceOf(value: T, type: Function, message?: string): void; + + /** + * Asserts that haystack includes needle. + * + * @param haystack Container string. + * @param needle Potential expected substring of haystack. + * @param message Message to display on error. + */ + include(haystack: string, needle: string, message?: string): void; + + /** + * Asserts that haystack includes needle. + * + * @type T Type of values in haystack. + * @param haystack Container array. + * @param needle Potential value contained in haystack. + * @param message Message to display on error. + */ + include(haystack: T[], needle: T, message?: string): void; + + /** + * Asserts that haystack does not include needle. + * + * @param haystack Container string. + * @param needle Potential expected substring of haystack. + * @param message Message to display on error. + */ + notInclude(haystack: string, needle: any, message?: string): void; + + /** + * Asserts that haystack does not include needle. + * + * @type T Type of values in haystack. + * @param haystack Container array. + * @param needle Potential value contained in haystack. + * @param message Message to display on error. + */ + notInclude(haystack: any[], needle: any, message?: string): void; + + /** + * Asserts that value matches the regular expression regexp. + * + * @param value Actual value. + * @param regexp Potential match of value. + * @param message Message to display on error. + */ + match(value: string, regexp: RegExp, message?: string): void; + + /** + * Asserts that value does not match the regular expression regexp. + * + * @param value Actual value. + * @param regexp Potential match of value. + * @param message Message to display on error. + */ + notMatch(expected: any, regexp: RegExp, message?: string): void; + + /** + * Asserts that object has a property named by property. + * + * @type T Type of object. + * @param object Container object. + * @param property Potential contained property of object. + * @param message Message to display on error. + */ + property(object: T, property: keyof T, message?: string): void; + + /** + * Asserts that object has a property named by property. + * + * @type T Type of object. + * @param object Container object. + * @param property Potential contained property of object. + * @param message Message to display on error. + */ + notProperty(object: T, property: keyof T, message?: string): void; + + /** + * Asserts that object has a property named by property, which can be a string + * using dot- and bracket-notation for deep reference. + * + * @type T Type of object. + * @param object Container object. + * @param property Potential contained property of object. + * @param message Message to display on error. + */ + deepProperty(object: T, property: string, message?: string): void; + + /** + * Asserts that object does not have a property named by property, which can be a + * string using dot- and bracket-notation for deep reference. + * + * @type T Type of object. + * @param object Container object. + * @param property Potential contained property of object. + * @param message Message to display on error. + */ + notDeepProperty(object: T, property: string, message?: string): void; + + /** + * Asserts that object has a property named by property with value given by value. + * + * @type T Type of object. + * @type V Type of value. + * @param object Container object. + * @param property Potential contained property of object. + * @param value Potential expected property value. + * @param message Message to display on error. + */ + propertyVal(object: T, property: keyof T, value: V, message?: string): void; + + /** + * Asserts that object has a property named by property with value given by value. + * + * @type T Type of object. + * @type V Type of value. + * @param object Container object. + * @param property Potential contained property of object. + * @param value Potential expected property value. + * @param message Message to display on error. + */ + propertyNotVal(object: T, property: keyof T, value: V, message?: string): void; + + /** + * Asserts that object has a property named by property, which can be a string + * using dot- and bracket-notation for deep reference. + * + * @type T Type of object. + * @type V Type of value. + * @param object Container object. + * @param property Potential contained property of object. + * @param value Potential expected property value. + * @param message Message to display on error. + */ + deepPropertyVal(object: T, property: string, value: V, message?: string): void; + + /** + * Asserts that object does not have a property named by property, which can be a + * string using dot- and bracket-notation for deep reference. + * + * @type T Type of object. + * @type V Type of value. + * @param object Container object. + * @param property Potential contained property of object. + * @param value Potential expected property value. + * @param message Message to display on error. + */ + deepPropertyNotVal(object: T, property: string, value: T, message?: string): void; + + /** + * Asserts that object has a length property with the expected value. + * + * @type T Type of object. + * @param object Container object. + * @param length Potential expected length of object. + * @param message Message to display on error. + */ + lengthOf(object: T, length: number, message?: string): void; + + /** + * Asserts that fn will throw an error. + * + * @param fn Function that may throw. + * @param message Message to display on error. + */ + throw(fn: Function, message?: string): void; + + /** + * Asserts that function will throw an error with message matching regexp. + * + * @param fn Function that may throw. + * @param regExp Potential expected message match. + * @param message Message to display on error. + */ throw(fn: Function, regExp: RegExp): void; - throw(fn: Function, errType: Function, msg?: string): void; - throw(fn: Function, errType: Function, regExp: RegExp): void; - throws(fn: Function, msg?: string): void; + /** + * Asserts that function will throw an error that is an instance of constructor. + * + * @param fn Function that may throw. + * @param constructor Potential expected error constructor. + * @param message Message to display on error. + */ + throw(fn: Function, constructor: Function, message?: string): void; + + /** + * Asserts that function will throw an error that is an instance of constructor + * and an error with message matching regexp. + * + * @param fn Function that may throw. + * @param constructor Potential expected error constructor. + * @param message Message to display on error. + */ + throw(fn: Function, constructor: Function, regExp: RegExp): void; + + /** + * Asserts that fn will throw an error. + * + * @param fn Function that may throw. + * @param message Message to display on error. + */ + throws(fn: Function, message?: string): void; + + /** + * Asserts that function will throw an error with message matching regexp. + * + * @param fn Function that may throw. + * @param regExp Potential expected message match. + * @param message Message to display on error. + */ throws(fn: Function, regExp: RegExp): void; - throws(fn: Function, errType: Function, msg?: string): void; + + /** + * Asserts that function will throw an error that is an instance of constructor. + * + * @param fn Function that may throw. + * @param constructor Potential expected error constructor. + * @param message Message to display on error. + */ + throws(fn: Function, errType: Function, message?: string): void; + + /** + * Asserts that function will throw an error that is an instance of constructor + * and an error with message matching regexp. + * + * @param fn Function that may throw. + * @param constructor Potential expected error constructor. + * @param message Message to display on error. + */ throws(fn: Function, errType: Function, regExp: RegExp): void; - Throw(fn: Function, msg?: string): void; + /** + * Asserts that fn will throw an error. + * + * @param fn Function that may throw. + * @param message Message to display on error. + */ + Throw(fn: Function, message?: string): void; + + /** + * Asserts that function will throw an error with message matching regexp. + * + * @param fn Function that may throw. + * @param regExp Potential expected message match. + * @param message Message to display on error. + */ Throw(fn: Function, regExp: RegExp): void; - Throw(fn: Function, errType: Function, msg?: string): void; + + /** + * Asserts that function will throw an error that is an instance of constructor. + * + * @param fn Function that may throw. + * @param constructor Potential expected error constructor. + * @param message Message to display on error. + */ + Throw(fn: Function, errType: Function, message?: string): void; + + /** + * Asserts that function will throw an error that is an instance of constructor + * and an error with message matching regexp. + * + * @param fn Function that may throw. + * @param constructor Potential expected error constructor. + * @param message Message to display on error. + */ Throw(fn: Function, errType: Function, regExp: RegExp): void; - doesNotThrow(fn: Function, msg?: string): void; + /** + * Asserts that fn will not throw an error. + * + * @param fn Function that may throw. + * @param message Message to display on error. + */ + doesNotThrow(fn: Function, message?: string): void; + + /** + * Asserts that function will throw an error with message matching regexp. + * + * @param fn Function that may throw. + * @param regExp Potential expected message match. + * @param message Message to display on error. + */ doesNotThrow(fn: Function, regExp: RegExp): void; - doesNotThrow(fn: Function, errType: Function, msg?: string): void; + + /** + * Asserts that function will throw an error that is an instance of constructor. + * + * @param fn Function that may throw. + * @param constructor Potential expected error constructor. + * @param message Message to display on error. + */ + doesNotThrow(fn: Function, errType: Function, message?: string): void; + + /** + * Asserts that function will throw an error that is an instance of constructor + * and an error with message matching regexp. + * + * @param fn Function that may throw. + * @param constructor Potential expected error constructor. + * @param message Message to display on error. + */ doesNotThrow(fn: Function, errType: Function, regExp: RegExp): void; - operator(val: any, operator: string, val2: any, msg?: string): void; - closeTo(act: number, exp: number, delta: number, msg?: string): void; - approximately(act: number, exp: number, delta: number, msg?: string): void; + /** + * Compares two values using operator. + * + * @param val1 Left value during comparison. + * @param operator Comparison operator. + * @param val2 Right value during comparison. + * @param message Message to display on error. + */ + operator(val1: OperatorComparable, operator: Operator, val2: OperatorComparable, message?: string): void; - sameMembers(set1: any[], set2: any[], msg?: string): void; - sameDeepMembers(set1: any[], set2: any[], msg?: string): void; - includeMembers(superset: any[], subset: any[], msg?: string): void; - includeDeepMembers(superset: any[], subset: any[], msg?: string): void; + /** + * Asserts that the target is equal to expected, to within a +/- delta range. + * + * @param actual Actual value + * @param expected Potential expected value. + * @param delta Maximum differenced between values. + * @param message Message to display on error. + */ + closeTo(actual: number, expected: number, delta: number, message?: string): void; - ifError(val: any, msg?: string): void; + /** + * Asserts that the target is equal to expected, to within a +/- delta range. + * + * @param actual Actual value + * @param expected Potential expected value. + * @param delta Maximum differenced between values. + * @param message Message to display on error. + */ + approximately(act: number, exp: number, delta: number, message?: string): void; - isExtensible(obj: {}, msg?: string): void; - extensible(obj: {}, msg?: string): void; - isNotExtensible(obj: {}, msg?: string): void; - notExtensible(obj: {}, msg?: string): void; + /** + * Asserts that set1 and set2 have the same members. Order is not take into account. + * + * @type T Type of set values. + * @param set1 Actual set of values. + * @param set2 Potential expected set of values. + * @param message Message to display on error. + */ + sameMembers(set1: T[], set2: T[], message?: string): void; - isSealed(obj: {}, msg?: string): void; - sealed(obj: {}, msg?: string): void; - isNotSealed(obj: {}, msg?: string): void; - notSealed(obj: {}, msg?: string): void; + /** + * Asserts that set1 and set2 have the same members using deep equality checking. + * Order is not take into account. + * + * @type T Type of set values. + * @param set1 Actual set of values. + * @param set2 Potential expected set of values. + * @param message Message to display on error. + */ + sameDeepMembers(set1: T[], set2: T[], message?: string): void; - isFrozen(obj: Object, msg?: string): void; - frozen(obj: Object, msg?: string): void; - isNotFrozen(obj: Object, msg?: string): void; - notFrozen(obj: Object, msg?: string): void; + /** + * Asserts that subset is included in superset. Order is not take into account. + * + * @type T Type of set values. + * @param superset Actual set of values. + * @param subset Potential contained set of values. + * @param message Message to display on error. + */ + includeMembers(superset: T[], subset: T[], message?: string): void; - oneOf(inList: any, list: any[], msg?: string): void; + /** + * Asserts that subset is included in superset using deep equality checking. + * Order is not take into account. + * + * @type T Type of set values. + * @param superset Actual set of values. + * @param subset Potential contained set of values. + * @param message Message to display on error. + */ + includeDeepMembers(superset: T[], subset: T[], message?: string): void; + + /** + * Asserts that non-object, non-array value inList appears in the flat array list. + * + * @type T Type of list values. + * @param inList Value expected to be in the list. + * @param list List of values. + * @param message Message to display on error. + */ + oneOf(inList: T, list: T[], message?: string): void; + + /** + * Asserts that a function changes the value of a property. + * + * @type T Type of object. + * @param modifier Function to run. + * @param object Container object. + * @param property Property of object expected to be modified. + * @param message Message to display on error. + */ + changes(modifier: Function, object: T, property: keyof T, message?: string): void + + /** + * Asserts that a function does not change the value of a property. + * + * @type T Type of object. + * @param modifier Function to run. + * @param object Container object. + * @param property Property of object expected not to be modified. + * @param message Message to display on error. + */ + doesNotChange(modifier: Function, object: T, property: keyof T, message?: string): void + + /** + * Asserts that a function increases an object property. + * + * @type T Type of object. + * @param modifier Function to run. + * @param object Container object. + * @param property Property of object expected to be increased. + * @param message Message to display on error. + */ + increases(modifier: Function, object: T, property: keyof T, message?: string): void + + /** + * Asserts that a function does not increase an object property. + * + * @type T Type of object. + * @param modifier Function to run. + * @param object Container object. + * @param property Property of object expected not to be increased. + * @param message Message to display on error. + */ + doesNotIncrease(modifier: Function, object: T, property: keyof T, message?: string): void + + /** + * Asserts that a function decreases an object property. + * + * @type T Type of object. + * @param modifier Function to run. + * @param object Container object. + * @param property Property of object expected to be decreased. + * @param message Message to display on error. + */ + decreases(modifier: Function, object: T, property: keyof T, message?: string): void + + /** + * Asserts that a function does not decrease an object property. + * + * @type T Type of object. + * @param modifier Function to run. + * @param object Container object. + * @param property Property of object expected not to be decreased. + * @param message Message to display on error. + */ + doesNotDecrease(modifier: Function, object: T, property: keyof T, message?: string): void + + /** + * Asserts if value is not a false value, and throws if it is a true value. + * + * @type T Type of object. + * @param object Actual value. + * @param message Message to display on error. + * @remarks This is added to allow for chai to be a drop-in replacement for + * Node’s assert class. + */ + ifError(object: T, message?: string): void; + + /** + * Asserts that object is extensible (can have new properties added to it). + * + * @type T Type of object + * @param object Actual value. + * @param message Message to display on error. + */ + isExtensible(object: T, message?: string): void; + + /** + * Asserts that object is extensible (can have new properties added to it). + * + * @type T Type of object + * @param object Actual value. + * @param message Message to display on error. + */ + extensible(object: T, message?: string): void; + + /** + * Asserts that object is not extensible. + * + * @type T Type of object + * @param object Actual value. + * @param message Message to display on error. + */ + isNotExtensible(object: T, message?: string): void; + + /** + * Asserts that object is not extensible. + * + * @type T Type of object + * @param object Actual value. + * @param message Message to display on error. + */ + notExtensible(object: T, message?: string): void; + + /** + * Asserts that object is sealed (can have new properties added to it + * and its existing properties cannot be removed). + * + * @type T Type of object + * @param object Actual value. + * @param message Message to display on error. + */ + isSealed(object: T, message?: string): void; + + /** + * Asserts that object is sealed (can have new properties added to it + * and its existing properties cannot be removed). + * + * @type T Type of object + * @param object Actual value. + * @param message Message to display on error. + */ + sealed(object: T, message?: string): void; + + /** + * Asserts that object is not sealed. + * + * @type T Type of object + * @param object Actual value. + * @param message Message to display on error. + */ + isNotSealed(object: T, message?: string): void; + + /** + * Asserts that object is not sealed. + * + * @type T Type of object + * @param object Actual value. + * @param message Message to display on error. + */ + notSealed(object: T, message?: string): void; + + /** + * Asserts that object is frozen (cannot have new properties added to it + * and its existing properties cannot be removed). + * + * @type T Type of object + * @param object Actual value. + * @param message Message to display on error. + */ + isFrozen(object: T, message?: string): void; + + /** + * Asserts that object is frozen (cannot have new properties added to it + * and its existing properties cannot be removed). + * + * @type T Type of object + * @param object Actual value. + * @param message Message to display on error. + */ + frozen(object: T, message?: string): void; + + /** + * Asserts that object is not frozen (cannot have new properties added to it + * and its existing properties cannot be removed). + * + * @type T Type of object + * @param object Actual value. + * @param message Message to display on error. + */ + isNotFrozen(object: T, message?: string): void; + + /** + * Asserts that object is not frozen (cannot have new properties added to it + * and its existing properties cannot be removed). + * + * @type T Type of object + * @param object Actual value. + * @param message Message to display on error. + */ + notFrozen(object: T, message?: string): void; } export interface Config { @@ -406,7 +1241,7 @@ declare namespace Chai { } } -declare var chai: Chai.ChaiStatic; +declare const chai: Chai.ChaiStatic; declare module "chai" { export = chai; @@ -414,4 +1249,4 @@ declare module "chai" { interface Object { should: Chai.Assertion; -} +} \ No newline at end of file From 20a5a03781365eefe8bfa3c391321bfbb37bad79 Mon Sep 17 00:00:00 2001 From: Michael Zlatkovsky Date: Wed, 5 Apr 2017 18:52:05 -0700 Subject: [PATCH 192/844] Update index.d.ts --- types/js-yaml/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/js-yaml/index.d.ts b/types/js-yaml/index.d.ts index b4a5d36bae..7f19fb32eb 100644 --- a/types/js-yaml/index.d.ts +++ b/types/js-yaml/index.d.ts @@ -43,7 +43,7 @@ declare namespace jsyaml { // specifies a schema to use. schema?: any; // if true, sort keys when dumping YAML. If a function, use the function to sort the keys. (default: false) - sortKeys?: boolean; + sortKeys?: boolean | ((a: any, b: any) => number); // set max line width. (default: 80) lineWidth?: number; // if true, don't convert duplicate objects into references (default: false) From 4318786e2f26ff2ffee815faa68b4b9714b1a2fa Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Wed, 5 Apr 2017 19:06:13 -0700 Subject: [PATCH 193/844] Commented out keyof types in chai They're also not TS 2 compatible... --- types/chai/index.d.ts | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/types/chai/index.d.ts b/types/chai/index.d.ts index b349be0ac4..7444f5fd10 100644 --- a/types/chai/index.d.ts +++ b/types/chai/index.d.ts @@ -703,7 +703,7 @@ declare namespace Chai { * @param property Potential contained property of object. * @param message Message to display on error. */ - property(object: T, property: keyof T, message?: string): void; + property(object: T, property: string /* keyof T */, message?: string): void; /** * Asserts that object has a property named by property. @@ -713,7 +713,7 @@ declare namespace Chai { * @param property Potential contained property of object. * @param message Message to display on error. */ - notProperty(object: T, property: keyof T, message?: string): void; + notProperty(object: T, property: string /* keyof T */, message?: string): void; /** * Asserts that object has a property named by property, which can be a string @@ -747,7 +747,7 @@ declare namespace Chai { * @param value Potential expected property value. * @param message Message to display on error. */ - propertyVal(object: T, property: keyof T, value: V, message?: string): void; + propertyVal(object: T, property: string /* keyof T */, value: V, message?: string): void; /** * Asserts that object has a property named by property with value given by value. @@ -759,7 +759,7 @@ declare namespace Chai { * @param value Potential expected property value. * @param message Message to display on error. */ - propertyNotVal(object: T, property: keyof T, value: V, message?: string): void; + propertyNotVal(object: T, property: string /* keyof T */, value: V, message?: string): void; /** * Asserts that object has a property named by property, which can be a string @@ -1032,7 +1032,7 @@ declare namespace Chai { * @param property Property of object expected to be modified. * @param message Message to display on error. */ - changes(modifier: Function, object: T, property: keyof T, message?: string): void + changes(modifier: Function, object: T, property: string /* keyof T */, message?: string): void /** * Asserts that a function does not change the value of a property. @@ -1043,7 +1043,7 @@ declare namespace Chai { * @param property Property of object expected not to be modified. * @param message Message to display on error. */ - doesNotChange(modifier: Function, object: T, property: keyof T, message?: string): void + doesNotChange(modifier: Function, object: T, property: string /* keyof T */, message?: string): void /** * Asserts that a function increases an object property. @@ -1054,7 +1054,7 @@ declare namespace Chai { * @param property Property of object expected to be increased. * @param message Message to display on error. */ - increases(modifier: Function, object: T, property: keyof T, message?: string): void + increases(modifier: Function, object: T, property: string /* keyof T */, message?: string): void /** * Asserts that a function does not increase an object property. @@ -1065,7 +1065,7 @@ declare namespace Chai { * @param property Property of object expected not to be increased. * @param message Message to display on error. */ - doesNotIncrease(modifier: Function, object: T, property: keyof T, message?: string): void + doesNotIncrease(modifier: Function, object: T, property: string /* keyof T */, message?: string): void /** * Asserts that a function decreases an object property. @@ -1076,7 +1076,7 @@ declare namespace Chai { * @param property Property of object expected to be decreased. * @param message Message to display on error. */ - decreases(modifier: Function, object: T, property: keyof T, message?: string): void + decreases(modifier: Function, object: T, property: string /* keyof T */, message?: string): void /** * Asserts that a function does not decrease an object property. @@ -1087,7 +1087,7 @@ declare namespace Chai { * @param property Property of object expected not to be decreased. * @param message Message to display on error. */ - doesNotDecrease(modifier: Function, object: T, property: keyof T, message?: string): void + doesNotDecrease(modifier: Function, object: T, property: string /* keyof T */, message?: string): void /** * Asserts if value is not a false value, and throws if it is a true value. From 66acd43247f372ff891dfc5630b06557fb245aa3 Mon Sep 17 00:00:00 2001 From: AntiMoron Date: Thu, 6 Apr 2017 15:15:32 +0800 Subject: [PATCH 194/844] Update index.d.ts --- types/echarts/index.d.ts | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/types/echarts/index.d.ts b/types/echarts/index.d.ts index f460a9eaca..f5b8e27072 100644 --- a/types/echarts/index.d.ts +++ b/types/echarts/index.d.ts @@ -69,6 +69,25 @@ declare namespace ECharts { isDisposed():boolean dispose():void + + // 转æ¢é€»è¾‘点到åƒç´  + convertToPixel(finder: { + seriesIndex?: number, + seriesId?: string, + seriesName?: string, + geoIndex?: number, + geoId?: string, + geoName?: string, + xAxisIndex?: number, + xAxisId?: string, + xAxisName?: string, + yAxisIndex?: number, + yAxisId?: string, + yAxisName?: string, + gridIndex?: number, + gridId?: string + gridName?: string + } | string, value: string|Array): string|Array } interface EChartOption { From fbe02a0916f6acde921311a76fd54865134ca967 Mon Sep 17 00:00:00 2001 From: AntiMoron Date: Thu, 6 Apr 2017 15:19:49 +0800 Subject: [PATCH 195/844] Update index.d.ts --- types/echarts/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/echarts/index.d.ts b/types/echarts/index.d.ts index f5b8e27072..3f0889d134 100644 --- a/types/echarts/index.d.ts +++ b/types/echarts/index.d.ts @@ -1,6 +1,6 @@ // Type definitions for echarts // Project: http://echarts.baidu.com/ -// Definitions by: Xie Jingyang +// Definitions by: Xie Jingyang , AntiMoron // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped declare namespace ECharts { From 005c373632753cde709a8a053e46a7beb5a5194f Mon Sep 17 00:00:00 2001 From: Michal Hruby Date: Thu, 6 Apr 2017 09:18:33 +0100 Subject: [PATCH 196/844] Keep should and should-promised compatible --- types/should-promised/index.d.ts | 6 ++---- types/should/index.d.ts | 3 ++- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/types/should-promised/index.d.ts b/types/should-promised/index.d.ts index 75432273bf..065237f45e 100644 --- a/types/should-promised/index.d.ts +++ b/types/should-promised/index.d.ts @@ -5,10 +5,8 @@ interface ShouldAssertion { Promise: ShouldAssertion; - fulfilled(): ShouldAssertion; - rejected(): ShouldAssertion; - rejectedWith(message: (string | Function | RegExp), properties?: Object): ShouldAssertion; - rejectedWith(message: Object): ShouldAssertion; + fulfilled: Promise; + rejected: Promise; finally: ShouldAssertion; eventually: ShouldAssertion; } diff --git a/types/should/index.d.ts b/types/should/index.d.ts index db78e6e087..0a5038d027 100644 --- a/types/should/index.d.ts +++ b/types/should/index.d.ts @@ -99,7 +99,8 @@ interface ShouldAssertion { fulfilled(): Promise; fulfilledWith(value: any): Promise rejected(): Promise; - rejectedWith(err: Error | string | RegExp): Promise; + rejectedWith(message: (string | Function | RegExp), properties?: Object): Promise; + rejectedWith(errType: Object): Promise; //http header(field: string, val?: string): ShouldAssertion; From fefb9017e7f77b3ce6fc24de86b12cf37fab51ec Mon Sep 17 00:00:00 2001 From: Michal Hruby Date: Thu, 6 Apr 2017 09:50:05 +0100 Subject: [PATCH 197/844] Drop everything from should-promised --- types/should-promised/index.d.ts | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/types/should-promised/index.d.ts b/types/should-promised/index.d.ts index 065237f45e..0c17b970f7 100644 --- a/types/should-promised/index.d.ts +++ b/types/should-promised/index.d.ts @@ -4,9 +4,5 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped interface ShouldAssertion { - Promise: ShouldAssertion; - fulfilled: Promise; - rejected: Promise; - finally: ShouldAssertion; - eventually: ShouldAssertion; + // all of the extensions are now part of should itself } From 3a5fb834574cb5051d91fb6603a59e714fb12d43 Mon Sep 17 00:00:00 2001 From: grapswiz Date: Thu, 6 Apr 2017 19:07:59 +0900 Subject: [PATCH 198/844] googlemaps: add motionTracking settings on StreetViewPanorama --- types/googlemaps/googlemaps-tests.ts | 14 ++++++++++++++ types/googlemaps/index.d.ts | 9 +++++++++ 2 files changed, 23 insertions(+) diff --git a/types/googlemaps/googlemaps-tests.ts b/types/googlemaps/googlemaps-tests.ts index 6397aab58b..7c5e9d1ed4 100644 --- a/types/googlemaps/googlemaps-tests.ts +++ b/types/googlemaps/googlemaps-tests.ts @@ -290,3 +290,17 @@ var circle2 = new google.maps.Circle({ strokeOpacity: 0.5, strokeWeight: 1 }); + +/***** StreetViewPanorama *****/ +var panoramaOptions: google.maps.StreetViewPanoramaOptions = { + zoom: 0, + pano: 'reception', + scrollwheel: false, + mode: 'webgl', + disableDefaultUI: true, + linksControl: true, + visible: true, + motionTracking: true, + motionTrackingControl: true +}; +var panorama = new google.maps.StreetViewPanorama(document.createElement("div"), panoramaOptions); diff --git a/types/googlemaps/index.d.ts b/types/googlemaps/index.d.ts index 41da96d754..8816db47e3 100644 --- a/types/googlemaps/index.d.ts +++ b/types/googlemaps/index.d.ts @@ -1933,6 +1933,7 @@ declare namespace google.maps { controls: MVCArray[]; // Array> getLinks(): StreetViewLink[]; getLocation(): StreetViewLocation; + getMotionTracking(): boolean; getPano(): string; getPhotographerPov(): StreetViewPov; getPosition(): LatLng; @@ -1942,6 +1943,7 @@ declare namespace google.maps { getZoom(): number; registerPanoProvider(provider: (input: string) => StreetViewPanoramaData): void; setLinks(links: Array): void; + setMotionTracking(motionTracking: boolean): void; setOptions(options: StreetViewPanoramaOptions): void; setPano(pano: string): void; setPosition(latLng: LatLng|LatLngLiteral): void; @@ -1970,6 +1972,9 @@ declare namespace google.maps { fullscreenControlOptions?: FullscreenControlOptions; imageDateControl?: boolean; linksControl?: boolean; + motionTracking?: boolean; + motionTrackingControl?: boolean; + motionTrackingControlOptions?: MotionTrackingControlOptions; mode?: "html4" | "html5" |"webgl"; panControl?: boolean; panControlOptions?: PanControlOptions; @@ -2059,6 +2064,10 @@ declare namespace google.maps { setMap(map: Map | null): void; } + export interface MotionTrackingControlOptions { + position?: ControlPosition; + } + /***** Events *****/ export interface MapsEventListener { /** Removes the listener. Equivalent to calling google.maps.event.removeListener(listener). */ From fbc98c9d18d068a8277144cbf75d52de253b2ec9 Mon Sep 17 00:00:00 2001 From: Alessandro Vergani Date: Thu, 6 Apr 2017 12:27:36 +0200 Subject: [PATCH 199/844] Allow `null` as position in read/write --- types/node/index.d.ts | 10 +++++----- types/node/v0/index.d.ts | 8 ++++---- types/node/v4/index.d.ts | 10 +++++----- types/node/v6/index.d.ts | 10 +++++----- 4 files changed, 19 insertions(+), 19 deletions(-) diff --git a/types/node/index.d.ts b/types/node/index.d.ts index f132b2e64f..74ad1f4b32 100644 --- a/types/node/index.d.ts +++ b/types/node/index.d.ts @@ -2490,15 +2490,15 @@ declare module "fs" { export function futimesSync(fd: number, atime: Date, mtime: Date): void; export function fsync(fd: number, callback?: (err?: NodeJS.ErrnoException) => void): void; export function fsyncSync(fd: number): void; - export function write(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: (err: NodeJS.ErrnoException, written: number, buffer: Buffer) => void): void; + export function write(fd: number, buffer: Buffer, offset: number, length: number, position: number | null, callback?: (err: NodeJS.ErrnoException, written: number, buffer: Buffer) => void): void; export function write(fd: number, buffer: Buffer, offset: number, length: number, callback?: (err: NodeJS.ErrnoException, written: number, buffer: Buffer) => void): void; export function write(fd: number, data: any, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void; export function write(fd: number, data: any, offset: number, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void; export function write(fd: number, data: any, offset: number, encoding: string, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void; - export function writeSync(fd: number, buffer: Buffer, offset: number, length: number, position?: number): number; - export function writeSync(fd: number, data: any, position?: number, enconding?: string): number; - export function read(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: (err: NodeJS.ErrnoException, bytesRead: number, buffer: Buffer) => void): void; - export function readSync(fd: number, buffer: Buffer, offset: number, length: number, position: number): number; + export function writeSync(fd: number, buffer: Buffer, offset: number, length: number, position?: number | null): number; + export function writeSync(fd: number, data: any, position?: number | null, enconding?: string): number; + export function read(fd: number, buffer: Buffer, offset: number, length: number, position: number | null, callback?: (err: NodeJS.ErrnoException, bytesRead: number, buffer: Buffer) => void): void; + export function readSync(fd: number, buffer: Buffer, offset: number, length: number, position: number | null): number; /** * Asynchronous readFile - Asynchronously reads the entire contents of a file. * diff --git a/types/node/v0/index.d.ts b/types/node/v0/index.d.ts index 6e17a4e764..7f6cb0dc0b 100644 --- a/types/node/v0/index.d.ts +++ b/types/node/v0/index.d.ts @@ -1274,14 +1274,14 @@ declare module "fs" { export function futimesSync(fd: number, atime: Date, mtime: Date): void; export function fsync(fd: number, callback?: (err?: NodeJS.ErrnoException) => void): void; export function fsyncSync(fd: number): void; - export function write(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: (err: NodeJS.ErrnoException, written: number, buffer: Buffer) => void): void; + export function write(fd: number, buffer: Buffer, offset: number, length: number, position: number | null, callback?: (err: NodeJS.ErrnoException, written: number, buffer: Buffer) => void): void; export function write(fd: number, buffer: Buffer, offset: number, length: number, callback?: (err: NodeJS.ErrnoException, written: number, buffer: Buffer) => void): void; export function write(fd: number, data: any, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void; export function write(fd: number, data: any, offset: number, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void; export function write(fd: number, data: any, offset: number, encoding: string, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void; - export function writeSync(fd: number, buffer: Buffer, offset: number, length: number, position: number): number; - export function read(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: (err: NodeJS.ErrnoException, bytesRead: number, buffer: Buffer) => void): void; - export function readSync(fd: number, buffer: Buffer, offset: number, length: number, position?: number): number; + export function writeSync(fd: number, buffer: Buffer, offset: number, length: number, position: number | null): number; + export function read(fd: number, buffer: Buffer, offset: number, length: number, position: number | null, callback?: (err: NodeJS.ErrnoException, bytesRead: number, buffer: Buffer) => void): void; + export function readSync(fd: number, buffer: Buffer, offset: number, length: number, position?: number | null): number; /** * Asynchronous readFile - Asynchronously reads the entire contents of a file. * diff --git a/types/node/v4/index.d.ts b/types/node/v4/index.d.ts index deb4cdea37..febe265a41 100644 --- a/types/node/v4/index.d.ts +++ b/types/node/v4/index.d.ts @@ -1603,15 +1603,15 @@ declare module "fs" { export function futimesSync(fd: number, atime: Date, mtime: Date): void; export function fsync(fd: number, callback?: (err?: NodeJS.ErrnoException) => void): void; export function fsyncSync(fd: number): void; - export function write(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: (err: NodeJS.ErrnoException, written: number, buffer: Buffer) => void): void; + export function write(fd: number, buffer: Buffer, offset: number, length: number, position: number | null, callback?: (err: NodeJS.ErrnoException, written: number, buffer: Buffer) => void): void; export function write(fd: number, buffer: Buffer, offset: number, length: number, callback?: (err: NodeJS.ErrnoException, written: number, buffer: Buffer) => void): void; export function write(fd: number, data: any, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void; export function write(fd: number, data: any, offset: number, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void; export function write(fd: number, data: any, offset: number, encoding: string, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void; - export function writeSync(fd: number, buffer: Buffer, offset: number, length: number, position?: number): number; - export function writeSync(fd: number, data: any, position?: number, enconding?: string): number; - export function read(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: (err: NodeJS.ErrnoException, bytesRead: number, buffer: Buffer) => void): void; - export function readSync(fd: number, buffer: Buffer, offset: number, length: number, position?: number): number; + export function writeSync(fd: number, buffer: Buffer, offset: number, length: number, position?: number | null): number; + export function writeSync(fd: number, data: any, position?: number | null, enconding?: string): number; + export function read(fd: number, buffer: Buffer, offset: number, length: number, position: number | null, callback?: (err: NodeJS.ErrnoException, bytesRead: number, buffer: Buffer) => void): void; + export function readSync(fd: number, buffer: Buffer, offset: number, length: number, position?: number | null): number; /** * Asynchronous readFile - Asynchronously reads the entire contents of a file. * diff --git a/types/node/v6/index.d.ts b/types/node/v6/index.d.ts index f18f006e0c..ebd6357026 100644 --- a/types/node/v6/index.d.ts +++ b/types/node/v6/index.d.ts @@ -2401,15 +2401,15 @@ declare module "fs" { export function futimesSync(fd: number, atime: Date, mtime: Date): void; export function fsync(fd: number, callback?: (err?: NodeJS.ErrnoException) => void): void; export function fsyncSync(fd: number): void; - export function write(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: (err: NodeJS.ErrnoException, written: number, buffer: Buffer) => void): void; + export function write(fd: number, buffer: Buffer, offset: number, length: number, position: number | null, callback?: (err: NodeJS.ErrnoException, written: number, buffer: Buffer) => void): void; export function write(fd: number, buffer: Buffer, offset: number, length: number, callback?: (err: NodeJS.ErrnoException, written: number, buffer: Buffer) => void): void; export function write(fd: number, data: any, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void; export function write(fd: number, data: any, offset: number, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void; export function write(fd: number, data: any, offset: number, encoding: string, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void; - export function writeSync(fd: number, buffer: Buffer, offset: number, length: number, position?: number): number; - export function writeSync(fd: number, data: any, position?: number, enconding?: string): number; - export function read(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: (err: NodeJS.ErrnoException, bytesRead: number, buffer: Buffer) => void): void; - export function readSync(fd: number, buffer: Buffer, offset: number, length: number, position: number): number; + export function writeSync(fd: number, buffer: Buffer, offset: number, length: number, position?: number | null): number; + export function writeSync(fd: number, data: any, position?: number | null, enconding?: string): number; + export function read(fd: number, buffer: Buffer, offset: number, length: number, position: number | null, callback?: (err: NodeJS.ErrnoException, bytesRead: number, buffer: Buffer) => void): void; + export function readSync(fd: number, buffer: Buffer, offset: number, length: number, position: number | null): number; /** * Asynchronous readFile - Asynchronously reads the entire contents of a file. * From 7708cc95328d5f386bca01baf0739b33e0802135 Mon Sep 17 00:00:00 2001 From: Johan Nordberg Date: Thu, 6 Apr 2017 14:01:29 +0200 Subject: [PATCH 200/844] Correct signature for ObjectLoader::load --- types/three/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/three/index.d.ts b/types/three/index.d.ts index 064d3e8660..ea39a9c05b 100644 --- a/types/three/index.d.ts +++ b/types/three/index.d.ts @@ -2228,7 +2228,7 @@ declare namespace THREE { texturePass: string; crossOrigin: string; - load(url: string, onLoad?: (object: Object3D) => void): void; + load(url: string, onLoad?: (object: Object3D) => void, onProgress?: (event: ProgressEvent) => void, onError?: (event: Error | ErrorEvent) => void): void; setTexturePath( value: string ): void; setCrossOrigin(crossOrigin: string): void; parse(json: any, onLoad?: (object: Object3D) => void): T; From 226639d9b4fd4c8be667e0b98e9275983907973d Mon Sep 17 00:00:00 2001 From: Johan Nordberg Date: Thu, 6 Apr 2017 14:04:54 +0200 Subject: [PATCH 201/844] Typofix, metalMap should be metalnessMap --- types/three/index.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/types/three/index.d.ts b/types/three/index.d.ts index ea39a9c05b..9bc66521d2 100644 --- a/types/three/index.d.ts +++ b/types/three/index.d.ts @@ -2658,7 +2658,7 @@ declare namespace THREE { displacementScale?: number; displacementBias?: number; roughnessMap?: Texture; - metalMap?: Texture; + metalnessMap?: Texture; alphaMap?: Texture; envMap?: Texture; envMapIntensity?: number; @@ -2693,7 +2693,7 @@ declare namespace THREE { displacementScale: number; displacementBias: number; roughnessMap: Texture; - metalMap: Texture; + metalnessMap: Texture; alphaMap: Texture; envMap: Texture; envMapIntensity: number; From 2e182eaac768f4abfe3d8d008c68b23fd82c5ab3 Mon Sep 17 00:00:00 2001 From: Syncfusion-JavaScript Date: Thu, 6 Apr 2017 17:45:33 +0530 Subject: [PATCH 202/844] lint errors resolved --- types/ej.web.all/index.d.ts | 36357 +++++++++++++++++----------------- 1 file changed, 18181 insertions(+), 18176 deletions(-) diff --git a/types/ej.web.all/index.d.ts b/types/ej.web.all/index.d.ts index ae27436c9d..49c60d8a3b 100644 --- a/types/ej.web.all/index.d.ts +++ b/types/ej.web.all/index.d.ts @@ -18,121 +18,121 @@ declare namespace ej { const dataUtil: dataUtil; function isMobile(): boolean; function isIOS(): boolean; - function isAndroid(): boolean; - function isFlat(): boolean; - function isWindows(): boolean; - function isCssCalc(): boolean; - function getCurrentPage(): JQuery; - function isLowerResolution(): boolean; - function browserInfo(): browserInfoOptions; - function isTouchDevice(): boolean; - function addPrefix(style: string): string; - function animationEndEvent(): string; - function blockDefaultActions(e: any): void; - function buildTag(tag: string, innerHtml?: string, styles?: any, attrs?: any): JQuery; - function cancelEvent(): string; - function copyObject(): string; - function createObject(nameSpace: string, value: any, initIn: any): JQuery; - function createObject(element: any, eventEmitter: any, model: any): any; - function setCulture(culture: string): void; + function isAndroid(): boolean; + function isFlat(): boolean; + function isWindows(): boolean; + function isCssCalc(): boolean; + function getCurrentPage(): JQuery; + function isLowerResolution(): boolean; + function browserInfo(): browserInfoOptions; + function isTouchDevice(): boolean; + function addPrefix(style: string): string; + function animationEndEvent(): string; + function blockDefaultActions(e: any): void; + function buildTag(tag: string, innerHtml?: string, styles?: any, attrs?: any): JQuery; + function cancelEvent(): string; + function copyObject(): string; + function createObject(nameSpace: string, value: any, initIn: any): JQuery; + function createObject(element: any, eventEmitter: any, model: any): any; + function setCulture(culture: string): void; function getObject(element: string, model: any ): T; - function getObject(nameSpace: string, fromdata?: any): any; - function defineClass(className: string, constructor: any, proto: any, replace: boolean): any; - function destroyWidgets(element: any): void; - function endEvent(): string; - function event(type: string, data: any, eventProp: any): any; - function getAndroidVersion(): any; - function getAttrVal(ele: any, val: string, option: any): any; - function getBooleanVal(ele: any, val: string, option: any): any; - function getClearString(): string; - function getDimension(element: any, method: string): any; - function getFontString(fontObj: any): string; - function getFontStyle(style: string): string; - function getMaxZindex(): number; - function getNameSpace(className: string): string; - function getOffset(ele: string): any; - function getRenderMode(): string; - function getScrollableParents(element: any): void; - function getTheme(): string; - function getZindexPartial(element: any, popupEle: string): number; - function hasRenderMode(element: string): void; - function hasStyle(prop: string): boolean; - function hasTheme(element: string): string; - function hexFromRGB(color: string): string; - function ieClearRemover(element: string): void; - function isAndroidWebView(): string; - function isDevice(): boolean; - function isIOS7(): boolean; - function isIOSWebView(): boolean; - function isLowerAndroid(): boolean; - function isNullOrUndefined(value: any): boolean; - function isPlainObject(): JQuery; - function isPortrait(): any; - function isTablet(): boolean; - function isWindowsWebView(): string; - function listenEvents(selectors: any, eventTypes: any, handlers: any, remove?: any, pluginObj?: any, disableMouse?: boolean): void; - function listenTouchEvent(selectors: any, eventTypes: any, handlers: any, remove?: any, pluginObj?: any, disableMouse?: boolean): void; - function logBase(val: string, base: string): number; - function measureText(text: string, maxwidth: number, font: string): string; - function moveEvent(): string; - function print(element: string, printWindow: any): void; - function proxy(fn: any, context?: string, arg?: string): any; - function round(value: string, div: string, up: string): any; - function sendAjaxRequest(ajaxOptions: any): void; - function setCaretToPos(nput: string, pos1: string, pos2: string): void; - function setRenderMode(element: string): void; - function setTheme(): any; - function startEvent(): string; - function tapEvent(): string; - function tapHoldEvent(): string; - function throwError(): any; - function transitionEndEvent(): any; - function userAgent(): boolean; - function widget(pluginName: string, className: string, proto: any): any; - function avg(json: any, filedName: string): any; - function getGuid(prefix: string): number; - function group(jsonArray: any, field: string, agg: string, level: number, groupDs: string): any; - function isJson(jsonData: string): string; - function max(jsonArray: any, fieldName?: string, comparer?: string): any; - function min(jsonArray: any, fieldName: string, comparer: string): any; - function merge(first: string, second: string): any; - function mergeshort(jsonArray: any, fieldName: string, comparer: string): any; - function parseJson(jsonText: string): string; - function parseTable(table: number, headerOption: string, headerRowIndex: string): any; - function select(jsonArray: any, fields: string): any; - function setTransition(): boolean; - function sum(json: string, fieldName: string): string; - function swap(array: any, x: string, y: string): any; - const cssUA: string; - const serverTimezoneOffset: number; - const transform: string; - const transformOrigin: string; - const transformStyle: string; - const transition: string; - const transitionDelay: string; - const transitionDuration: string; - const transitionProperty: string; - const transitionTimingFunction: string; + function getObject(nameSpace: string, fromdata?: any): any; + function defineClass(className: string, constructor: any, proto: any, replace: boolean): any; + function destroyWidgets(element: any): void; + function endEvent(): string; + function event(type: string, data: any, eventProp: any): any; + function getAndroidVersion(): any; + function getAttrVal(ele: any, val: string, option: any): any; + function getBooleanVal(ele: any, val: string, option: any): any; + function getClearString(): string; + function getDimension(element: any, method: string): any; + function getFontString(fontObj: any): string; + function getFontStyle(style: string): string; + function getMaxZindex(): number; + function getNameSpace(className: string): string; + function getOffset(ele: string): any; + function getRenderMode(): string; + function getScrollableParents(element: any): void; + function getTheme(): string; + function getZindexPartial(element: any, popupEle: string): number; + function hasRenderMode(element: string): void; + function hasStyle(prop: string): boolean; + function hasTheme(element: string): string; + function hexFromRGB(color: string): string; + function ieClearRemover(element: string): void; + function isAndroidWebView(): string; + function isDevice(): boolean; + function isIOS7(): boolean; + function isIOSWebView(): boolean; + function isLowerAndroid(): boolean; + function isNullOrUndefined(value: any): boolean; + function isPlainObject(): JQuery; + function isPortrait(): any; + function isTablet(): boolean; + function isWindowsWebView(): string; + function listenEvents(selectors: any, eventTypes: any, handlers: any, remove?: any, pluginObj?: any, disableMouse?: boolean): void; + function listenTouchEvent(selectors: any, eventTypes: any, handlers: any, remove?: any, pluginObj?: any, disableMouse?: boolean): void; + function logBase(val: string, base: string): number; + function measureText(text: string, maxwidth: number, font: string): string; + function moveEvent(): string; + function print(element: string, printWindow: any): void; + function proxy(fn: any, context?: string, arg?: string): any; + function round(value: string, div: string, up: string): any; + function sendAjaxRequest(ajaxOptions: any): void; + function setCaretToPos(nput: string, pos1: string, pos2: string): void; + function setRenderMode(element: string): void; + function setTheme(): any; + function startEvent(): string; + function tapEvent(): string; + function tapHoldEvent(): string; + function throwError(): any; + function transitionEndEvent(): any; + function userAgent(): boolean; + function widget(pluginName: string, className: string, proto: any): any; + function avg(json: any, filedName: string): any; + function getGuid(prefix: string): number; + function group(jsonArray: any, field: string, agg: string, level: number, groupDs: string): any; + function isJson(jsonData: string): string; + function max(jsonArray: any, fieldName?: string, comparer?: string): any; + function min(jsonArray: any, fieldName: string, comparer: string): any; + function merge(first: string, second: string): any; + function mergeshort(jsonArray: any, fieldName: string, comparer: string): any; + function parseJson(jsonText: string): string; + function parseTable(table: number, headerOption: string, headerRowIndex: string): any; + function select(jsonArray: any, fields: string): any; + function setTransition(): boolean; + function sum(json: string, fieldName: string): string; + function swap(array: any, x: string, y: string): any; + const cssUA: string; + const serverTimezoneOffset: number; + const transform: string; + const transformOrigin: string; + const transformStyle: string; + const transition: string; + const transitionDelay: string; + const transitionDuration: string; + const transitionProperty: string; + const transitionTimingFunction: string; const template: any; const util: { - valueFunction(val: string): any; - }; - export namespace device { - function isAndroid(): boolean; - function isIOS(): boolean; - function isFlat(): boolean; - function isIOS7(): boolean; - function isWindows(): boolean; - } - export namespace widget { - const autoInit: boolean; - const registeredInstances: any[]; - const registeredWidgets: any[]; - function register(pluginName: string, className: string, prototype: any): void; - function destroyAll(elements: Element): void; - function init(element: Element): void; - function registerInstance(element: Element, pluginName: string, className: string, prototype: any): void; - } + valueFunction(val: string): any; + }; + export namespace device { + function isAndroid(): boolean; + function isIOS(): boolean; + function isFlat(): boolean; + function isIOS7(): boolean; + function isWindows(): boolean; + } + export namespace widget { + const autoInit: boolean; + const registeredInstances: any[]; + const registeredWidgets: any[]; + function register(pluginName: string, className: string, prototype: any): void; + function destroyAll(elements: Element): void; + function init(element: Element): void; + function registerInstance(element: Element, pluginName: string, className: string, prototype: any): void; + } interface browserInfoOptions { name: string; version: string; @@ -140,302 +140,302 @@ declare namespace ej { isMSPointerEnabled: boolean; } class WidgetBase { - destroy(): void; - element: JQuery; - setModel(options: any, forceSet?: boolean): any; - option(prop?: any, value?: any, forceSet?: boolean): any; + destroy(): void; + element: JQuery; + setModel(options: any, forceSet?: boolean): any; + option(prop?: any, value?: any, forceSet?: boolean): any; _trigger(eventName?: string, eventProp?: any): any; - _on(element: JQuery, eventType?: string, handler?: (eventObject: JQueryEventObject) => any): any; - _on(element: JQuery, eventType ?: string, selector ?: string, handler ?: (eventObject: JQueryEventObject) => any): any; - _off(element: JQuery, eventName: string, handler ?: (eventObject: JQueryEventObject) => any): any; - _off(element: JQuery, eventType ?: string, selector ?: string, handler ?: (eventObject: JQueryEventObject) => any): any; - persistState(): void; - restoreState(silent: boolean): void; - } + _on(element: JQuery, eventType?: string, handler?: (eventObject: JQueryEventObject) => any): any; + _on(element: JQuery, eventType ?: string, selector ?: string, handler ?: (eventObject: JQueryEventObject) => any): any; + _off(element: JQuery, eventName: string, handler ?: (eventObject: JQueryEventObject) => any): any; + _off(element: JQuery, eventType ?: string, selector ?: string, handler ?: (eventObject: JQueryEventObject) => any): any; + persistState(): void; + restoreState(silent: boolean): void; + } - class Widget extends WidgetBase { - constructor(pluginName: string, className: string, proto: any); - static fn: Widget; - static extend(widget: Widget): any; - register(pluginName: string, className: string, prototype: any): void; - destroyAll(elements: Element): void; - model: any; - } + class Widget extends WidgetBase { + constructor(pluginName: string, className: string, proto: any); + static fn: Widget; + static extend(widget: Widget): any; + register(pluginName: string, className: string, prototype: any): void; + destroyAll(elements: Element): void; + model: any; + } - interface BaseEvent { - cancel: boolean; - type: string; - } - class DataManager { - constructor(dataSource?: any, query?: ej.Query, adaptor?: any); - setDefaultQuery(query: ej.Query): void; - executeQuery(query?: ej.Query, done?: any, fail?: any, always?: any): JQueryPromise; - executeLocal(query?: ej.Query): ej.DataManager; - saveChanges(changes?: Changes, key?: string, tableName?: string): JQueryDeferred; - insert(data: any, tableName?: string): JQueryPromise; - remove(keyField: string, value: any, tableName?: string): any; - update(keyField: string, value: any, tableName?: string): any; - } + interface BaseEvent { + cancel: boolean; + type: string; + } + class DataManager { + constructor(dataSource?: any, query?: ej.Query, adaptor?: any); + setDefaultQuery(query: ej.Query): void; + executeQuery(query?: ej.Query, done?: any, fail?: any, always?: any): JQueryPromise; + executeLocal(query?: ej.Query): ej.DataManager; + saveChanges(changes?: Changes, key?: string, tableName?: string): JQueryDeferred; + insert(data: any, tableName?: string): JQueryPromise; + remove(keyField: string, value: any, tableName?: string): any; + update(keyField: string, value: any, tableName?: string): any; + } - class Query { - constructor(); - static fn: Query; - static extend(prototype: any): Query; - key(field: string): ej.Query; - using(dataManager: ej.DataManager): ej.Query; - execute(dataManager: ej.DataManager, done: any, fail?: string, always?: string): any; - executeLocal(dataManager: ej.DataManager): ej.DataManager; - clone(): ej.Query; - from(tableName: any): ej.Query; - addParams(key: string, value: string): ej.Query; - expand(tables: any): ej.Query; - where(fieldName: string, operator: ej.FilterOperators, value: any, ignoreCase?: boolean): ej.Query; + class Query { + constructor(); + static fn: Query; + static extend(prototype: any): Query; + key(field: string): ej.Query; + using(dataManager: ej.DataManager): ej.Query; + execute(dataManager: ej.DataManager, done: any, fail?: string, always?: string): any; + executeLocal(dataManager: ej.DataManager): ej.DataManager; + clone(): ej.Query; + from(tableName: any): ej.Query; + addParams(key: string, value: string): ej.Query; + expand(tables: any): ej.Query; + where(fieldName: string, operator: ej.FilterOperators, value: any, ignoreCase?: boolean): ej.Query; where(predicate: ej.Predicate): ej.Query; - search(searchKey: any, fieldNames?: any, operator?: string, ignoreCase?: boolean): ej.Query; - sortBy(fieldName: string, comparer?: ej.SortOrder, isFromGroup?: boolean): ej.Query; - sortByDesc(fieldName: string): ej.Query; - group(fieldName: string): ej.Query; - page(pageIndex: number, pageSize: number): ej.Query; - take(nos: number): ej.Query; - skip(nos: number): ej.Query; - select(fieldNames: any): ej.Query; - hierarchy(query: ej.Query, selectorFn: any): ej.Query; - foreignKey(key: string): ej.Query; - requiresCount(): ej.Query; - range(start: number, end: number): ej.Query; - } + search(searchKey: any, fieldNames?: any, operator?: string, ignoreCase?: boolean): ej.Query; + sortBy(fieldName: string, comparer?: ej.SortOrder, isFromGroup?: boolean): ej.Query; + sortByDesc(fieldName: string): ej.Query; + group(fieldName: string): ej.Query; + page(pageIndex: number, pageSize: number): ej.Query; + take(nos: number): ej.Query; + skip(nos: number): ej.Query; + select(fieldNames: any): ej.Query; + hierarchy(query: ej.Query, selectorFn: any): ej.Query; + foreignKey(key: string): ej.Query; + requiresCount(): ej.Query; + range(start: number, end: number): ej.Query; + } - class Adaptor { - constructor(ds: any); - pvt: any; - type: ej.Adaptor; - options: AdaptorOptions; - extend(overrides: any): ej.Adaptor; - processQuery(dm: ej.DataManager, query: ej.Query): any; - processResponse(data: any, ds: any, query: ej.Query, xhr: JQueryXHR, request?: any, changes?: Changes): any; - convertToQueryString(req: any, query: ej.Query, dm: ej.DataManager): JQueryParam; - } + class Adaptor { + constructor(ds: any); + pvt: any; + type: ej.Adaptor; + options: AdaptorOptions; + extend(overrides: any): ej.Adaptor; + processQuery(dm: ej.DataManager, query: ej.Query): any; + processResponse(data: any, ds: any, query: ej.Query, xhr: JQueryXHR, request?: any, changes?: Changes): any; + convertToQueryString(req: any, query: ej.Query, dm: ej.DataManager): JQueryParam; + } - interface AdaptorOptions { - from?: string; - requestType?: string; - sortBy?: string; - select?: string; - skip?: string; - group?: string; - take?: string; - search?: string; - count?: string; - where?: string; - aggregates?: string; - } + interface AdaptorOptions { + from?: string; + requestType?: string; + sortBy?: string; + select?: string; + skip?: string; + group?: string; + take?: string; + search?: string; + count?: string; + where?: string; + aggregates?: string; + } - class UrlAdaptor extends ej.Adaptor { - constructor(); - processQuery(dm: ej.DataManager, query: ej.Query, hierarchyFilters?: any): { - type: string; url: string; ejPvtData: any; contentType?: string; data?: any; - } - convertToQueryString(req: any, query: ej.Query, dm: ej.DataManager): JQueryParam; - processResponse(data: any, ds: any, query: ej.Query, xhr: JQueryXHR, request?: any, changes?: Changes): any; - onGroup(e: any): void; - batchRequest(dm: ej.DataManager, changes: Changes, e: any): void; - beforeSend(dm: ej.DataManager, request: any, settings?: any): void; - insert(dm: ej.DataManager, data: any, tableName: string): { url: string; data: any }; - remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data?: any }; - update(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data: any }; - getFiltersFrom(data: any, query: ej.Query): ej.Predicate; - } + class UrlAdaptor extends ej.Adaptor { + constructor(); + processQuery(dm: ej.DataManager, query: ej.Query, hierarchyFilters?: any): { + type: string; url: string; ejPvtData: any; contentType?: string; data?: any; + } + convertToQueryString(req: any, query: ej.Query, dm: ej.DataManager): JQueryParam; + processResponse(data: any, ds: any, query: ej.Query, xhr: JQueryXHR, request?: any, changes?: Changes): any; + onGroup(e: any): void; + batchRequest(dm: ej.DataManager, changes: Changes, e: any): void; + beforeSend(dm: ej.DataManager, request: any, settings?: any): void; + insert(dm: ej.DataManager, data: any, tableName: string): { url: string; data: any }; + remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data?: any }; + update(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data: any }; + getFiltersFrom(data: any, query: ej.Query): ej.Predicate; + } - class ODataAdaptor extends ej.UrlAdaptor { - constructor(); - options: UrlAdaptorOptions; - onEachWhere(filter: any, requiresCast: boolean): any; - onPredicate(pred: ej.Predicate, query: ej.Query, requiresCast: boolean): string; - onComplexPredicate(pred: ej.Predicate, requiresCast: boolean): string; - onWhere(filters: string[]): string; - onEachSearch(e: any): void; - onSearch(e: any): string; - onEachSort(e: any): string; - onSortBy(e: any): string; - onGroup(e: any): string; - onSelect(e: any): string; - onCount(e: any): string; - beforeSend(dm: ej.DataManager, request: any, settings?: any): void; - processResponse(data: any, ds: any, query: ej.Query, xhr: any, request: any, changes: Changes): { - result: any; count: number - }; - convertToQueryString(req: any, query: ej.Query, dm: ej.DataManager): JQueryParam; - insert(dm: ej.DataManager, data: any, tableName: string): { url: string; data: any; } - remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): { url: string; type: string; } - update(dm: ej.DataManager, keyField: string, value: any, tableName: string): { url: string; type: string; data: any; accept: string; } - batchRequest(dm: ej.DataManager, changes: Changes, e: any): { url: string; type: string; data: any; contentType: string; } - generateDeleteRequest(arr: any[], e: any): string; - generateInsertRequest(arr: any[], e: any): string; - generateUpdateRequest(arr: any[], e: any): string; - } - interface UrlAdaptorOptions { - requestType?: string; - accept?: string; - multipartAccept?: string; - sortBy?: string; - select?: string; - skip?: string; - take?: string; - count?: string; - where?: string; - expand?: string; - batch?: string; - changeSet?: string; - batchPre?: string; - contentId?: string; - batchContent?: string; - changeSetContent?: string; - batchChangeSetContentType?: string; - } + class ODataAdaptor extends ej.UrlAdaptor { + constructor(); + options: UrlAdaptorOptions; + onEachWhere(filter: any, requiresCast: boolean): any; + onPredicate(pred: ej.Predicate, query: ej.Query, requiresCast: boolean): string; + onComplexPredicate(pred: ej.Predicate, requiresCast: boolean): string; + onWhere(filters: string[]): string; + onEachSearch(e: any): void; + onSearch(e: any): string; + onEachSort(e: any): string; + onSortBy(e: any): string; + onGroup(e: any): string; + onSelect(e: any): string; + onCount(e: any): string; + beforeSend(dm: ej.DataManager, request: any, settings?: any): void; + processResponse(data: any, ds: any, query: ej.Query, xhr: any, request: any, changes: Changes): { + result: any; count: number + }; + convertToQueryString(req: any, query: ej.Query, dm: ej.DataManager): JQueryParam; + insert(dm: ej.DataManager, data: any, tableName: string): { url: string; data: any; } + remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): { url: string; type: string; } + update(dm: ej.DataManager, keyField: string, value: any, tableName: string): { url: string; type: string; data: any; accept: string; } + batchRequest(dm: ej.DataManager, changes: Changes, e: any): { url: string; type: string; data: any; contentType: string; } + generateDeleteRequest(arr: any[], e: any): string; + generateInsertRequest(arr: any[], e: any): string; + generateUpdateRequest(arr: any[], e: any): string; + } + interface UrlAdaptorOptions { + requestType?: string; + accept?: string; + multipartAccept?: string; + sortBy?: string; + select?: string; + skip?: string; + take?: string; + count?: string; + where?: string; + expand?: string; + batch?: string; + changeSet?: string; + batchPre?: string; + contentId?: string; + batchContent?: string; + changeSetContent?: string; + batchChangeSetContentType?: string; + } class WebApiAdaptor extends ej.ODataAdaptor { - constructor(); - insert(dm: ej.DataManager, data: any, tableName?: string): { url: string; type: string; data: any; } - remove(dm: ej.DataManager, value: any, keyField?: string, tableName?: string): { url: string; type: string; data: any; } - update(dm: ej.DataManager, value: any, keyField?: string, tableName?: string): { url: string; type: string; data: any; accept: string; } - processResponse(data: any, ds: any, query: ej.Query, xhr: any, request: any, changes: Changes): { - result: any; count: number - }; - } - class ODataV4Adaptor extends ej.ODataAdaptor { - constructor(); - options: ODataAdaptorOptions; - onCount(e: any): string; - onEachSearch(e: any): void; - onSearch(e: any): string; - beforeSend(dm: ej.DataManager, request: any, settings?: any): void; - processResponse(data: any, ds: any, query: ej.Query, xhr: any, request: any, changes: Changes): { - result: any; count: number - }; - } - interface ODataAdaptorOptions { - requestType?: string; - accept?: string; - multipartAccept?: string; - sortBy?: string; - select?: string; - skip?: string; - take?: string; - count?: string; - search?: string; - where?: string; - expand?: string; - batch?: string; - changeSet?: string; - batchPre?: string; - contentId?: string; - batchContent?: string; - changeSetContent?: string; - batchChangeSetContentType?: string; - } + constructor(); + insert(dm: ej.DataManager, data: any, tableName?: string): { url: string; type: string; data: any; } + remove(dm: ej.DataManager, value: any, keyField?: string, tableName?: string): { url: string; type: string; data: any; } + update(dm: ej.DataManager, value: any, keyField?: string, tableName?: string): { url: string; type: string; data: any; accept: string; } + processResponse(data: any, ds: any, query: ej.Query, xhr: any, request: any, changes: Changes): { + result: any; count: number + }; + } + class ODataV4Adaptor extends ej.ODataAdaptor { + constructor(); + options: ODataAdaptorOptions; + onCount(e: any): string; + onEachSearch(e: any): void; + onSearch(e: any): string; + beforeSend(dm: ej.DataManager, request: any, settings?: any): void; + processResponse(data: any, ds: any, query: ej.Query, xhr: any, request: any, changes: Changes): { + result: any; count: number + }; + } + interface ODataAdaptorOptions { + requestType?: string; + accept?: string; + multipartAccept?: string; + sortBy?: string; + select?: string; + skip?: string; + take?: string; + count?: string; + search?: string; + where?: string; + expand?: string; + batch?: string; + changeSet?: string; + batchPre?: string; + contentId?: string; + batchContent?: string; + changeSetContent?: string; + batchChangeSetContentType?: string; + } - class JsonAdaptor extends ej.Adaptor { - constructor(); - processQuery(ds: any, query: ej.Query): string; - batchRequest(dm: ej.DataManager, changes: Changes, e: any): Changes; - onWhere(ds: any, e: any): any; - onSearch(ds: any, e: any): any - onSortBy(ds: any, e: any, query: ej.Query): any; - onGroup(ds: any, e: any, query: ej.Query): any; - onPage(ds: any, e: any, query: ej.Query): any; - onRange(ds: any, e: any): any; - onTake(ds: any, e: any): any; - onSkip(ds: any, e: any): any; - onSelect(ds: any, e: any): any; - insert(dm: ej.DataManager, data: any): any; - remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): any; - update(dm: ej.DataManager, keyField: string, value: any, tableName: string): any; - } + class JsonAdaptor extends ej.Adaptor { + constructor(); + processQuery(ds: any, query: ej.Query): string; + batchRequest(dm: ej.DataManager, changes: Changes, e: any): Changes; + onWhere(ds: any, e: any): any; + onSearch(ds: any, e: any): any + onSortBy(ds: any, e: any, query: ej.Query): any; + onGroup(ds: any, e: any, query: ej.Query): any; + onPage(ds: any, e: any, query: ej.Query): any; + onRange(ds: any, e: any): any; + onTake(ds: any, e: any): any; + onSkip(ds: any, e: any): any; + onSelect(ds: any, e: any): any; + insert(dm: ej.DataManager, data: any): any; + remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): any; + update(dm: ej.DataManager, keyField: string, value: any, tableName: string): any; + } class remoteSaveAdaptor extends ej.UrlAdaptor { - constructor(); - batchRequest(dm: ej.DataManager, changes: Changes, e: any): void; - beforeSend(dm: ej.DataManager, request: any, settings?: any): void; - insert(dm: ej.DataManager, data: any, tableName: string): { url: string; data: any }; - remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data?: any }; - update(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data: any }; - } - class TableModel { - constructor(name: string, jsonArray: any[], dataManager: ej.DataManager, modelComputed: any); - on(eventName: string, handler: any): void; - off(eventName: string, handler: any): void; - setDataManager(dataManager: DataManager): void; - saveChanges(): void; - rejectChanges(): void; - insert(json: any): void; - update(value: any): void; - remove(key: string): void; - isDirty(): boolean; - getChanges(): Changes; - toArray(): any[]; - setDirty(dirty: any, model: any): void; - get(index: number): void; - length(): number; - bindTo(element: any): void; - } - class Model { - constructor(json: any, table: string, name: string); - formElements: string[]; - computes(value: any): void; - on(eventName: string, handler: any): void; - off(eventName: string, handler: any): void; - set(field: string, value: any): void; - get(field: string): any; - revert(suspendEvent: any): void; - save(dm: ej.DataManager, key: string): void; - markCommit(): void; - markDelete(): void; - changeState(state: boolean, args: any): void; - properties(): any; - bindTo(element: any): void; - unbind(element: any): void; - } - interface Changes { - changed?: any[]; - added?: any[]; - deleted?: any[]; - } - class Predicate { - constructor(); - constructor(field: string, operator: ej.FilterOperators, value: any, ignoreCase: boolean); - and(field: string, operator: any, value: any, ignoreCase: boolean): ej.Predicate; - or(field: string, operator: any, value: any, ignoreCase: boolean): ej.Predicate; + constructor(); + batchRequest(dm: ej.DataManager, changes: Changes, e: any): void; + beforeSend(dm: ej.DataManager, request: any, settings?: any): void; + insert(dm: ej.DataManager, data: any, tableName: string): { url: string; data: any }; + remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data?: any }; + update(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data: any }; + } + class TableModel { + constructor(name: string, jsonArray: any[], dataManager: ej.DataManager, modelComputed: any); + on(eventName: string, handler: any): void; + off(eventName: string, handler: any): void; + setDataManager(dataManager: DataManager): void; + saveChanges(): void; + rejectChanges(): void; + insert(json: any): void; + update(value: any): void; + remove(key: string): void; + isDirty(): boolean; + getChanges(): Changes; + toArray(): any[]; + setDirty(dirty: any, model: any): void; + get(index: number): void; + length(): number; + bindTo(element: any): void; + } + class Model { + constructor(json: any, table: string, name: string); + formElements: string[]; + computes(value: any): void; + on(eventName: string, handler: any): void; + off(eventName: string, handler: any): void; + set(field: string, value: any): void; + get(field: string): any; + revert(suspendEvent: any): void; + save(dm: ej.DataManager, key: string): void; + markCommit(): void; + markDelete(): void; + changeState(state: boolean, args: any): void; + properties(): any; + bindTo(element: any): void; + unbind(element: any): void; + } + interface Changes { + changed?: any[]; + added?: any[]; + deleted?: any[]; + } + class Predicate { + constructor(); + constructor(field: string, operator: ej.FilterOperators, value: any, ignoreCase: boolean); + and(field: string, operator: any, value: any, ignoreCase: boolean): ej.Predicate; + or(field: string, operator: any, value: any, ignoreCase: boolean): ej.Predicate; or(predicate: any[]): any; - validate(record: any): boolean; - toJSON(): { - isComplex: boolean; - field: string; - operator: string; - value: any; - ignoreCase: boolean; - condition: string; - predicates: any; - }; - } - interface dataUtil { - swap(array: any[], x: number, y: number): void; - mergeSort(jsonArray: any[], fieldName?: string, comparer?: any): any[]; - max(jsonArray: any[], fieldName?: string, comparer?: string): any[]; - min(jsonArray: any[], fieldName: string, comparer: string): any[]; - distinct(jsonArray: any[], fieldName?: string, requiresCompleteRecord?: any): any[]; - sum(json: any, fieldName: string): number; - avg(json: any, fieldName: string): number; - select(jsonArray: any[], fieldName: string, fields: string): any[]; - group(jsonArray: any[], field: string, /* internal */ level: number): any[]; - parseTable(table: string, headerOption: ej.headerOption, headerRowIndex: number): any; - } - interface AjaxSettings { - type?: string; - cache: boolean; - data?: any; - dataType?: string; - contentType?: any; - async?: boolean; - } + validate(record: any): boolean; + toJSON(): { + isComplex: boolean; + field: string; + operator: string; + value: any; + ignoreCase: boolean; + condition: string; + predicates: any; + }; + } + interface dataUtil { + swap(array: any[], x: number, y: number): void; + mergeSort(jsonArray: any[], fieldName?: string, comparer?: any): any[]; + max(jsonArray: any[], fieldName?: string, comparer?: string): any[]; + min(jsonArray: any[], fieldName: string, comparer: string): any[]; + distinct(jsonArray: any[], fieldName?: string, requiresCompleteRecord?: any): any[]; + sum(json: any, fieldName: string): number; + avg(json: any, fieldName: string): number; + select(jsonArray: any[], fieldName: string, fields: string): any[]; + group(jsonArray: any[], field: string, /* internal */ level: number): any[]; + parseTable(table: string, headerOption: ej.headerOption, headerRowIndex: number): any; + } + interface AjaxSettings { + type?: string; + cache: boolean; + data?: any; + dataType?: string; + contentType?: any; + async?: boolean; + } enum FilterOperators { contains, endsWith, @@ -518,8 +518,8 @@ class Draggable extends ej.Widget { defaults: Draggable.Model; /** destroy in the draggable. - * @returns {void} - */ + * @returns {void} + */ _destroy(): void; } export namespace Draggable { @@ -527,33 +527,33 @@ export namespace Draggable { export interface Model { /** If clone is specified. - * @Default {false} - */ + * @Default {false} + */ clone?: boolean; /** Sets the offset of the dragging helper relative to the mouse cursor. - * @Default {{ top: -1, left: -2 }} - */ + * @Default {{ top: -1, left: -2 }} + */ cursorAt?: any; /** Distance in pixels after mousedown the mouse must move before dragging should start. This option can be used to prevent unwanted drags when clicking on an element. - * @Default {1} - */ + * @Default {1} + */ distance?: number; /** The drag area is used to restrict the dragging element bounds. - * @Default {false} - */ + * @Default {false} + */ dragArea?: boolean; /** If specified, restricts drag start click to the specified element(s). - * @Default {null} - */ + * @Default {null} + */ handle?: string; /** Used to group sets of draggable and droppable items, in addition to droppable's accept option. A draggable with the same scope value as a droppable will be accepted by the droppable. - * @Default {'default'} - */ + * @Default {'default'} + */ scope?: string; /** This event is triggered when dragging element is destroyed. */ @@ -575,95 +575,95 @@ export interface Model { export interface DestroyEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the autocomplete model - */ + */ model?: ej.Draggable.Model; /** returns the name of the event - */ + */ type?: string; } export interface DragEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the draggable model - */ + */ model?: ej.Draggable.Model; /** returns the name of the event - */ + */ type?: string; /** returns the event model values - */ + */ event?: any; /** returns the exact mouse down target element - */ + */ target?: any; } export interface DragStartEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the draggable model - */ + */ model?: ej.Draggable.Model; /** returns the name of the event - */ + */ type?: string; /** returns the event model values - */ + */ event?: any; /** returns the exact mouse down target element - */ + */ target?: any; } export interface DragStopEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the draggable model - */ + */ model?: ej.Draggable.Model; /** returns the name of the event - */ + */ type?: string; /** returns the event model values - */ + */ event?: any; /** returns the exact mouse down target element - */ + */ target?: any; } export interface HelperEventArgs { /** returns the draggable element object - */ + */ element?: any; /** returns the event model values - */ + */ sender?: any; } } @@ -676,8 +676,8 @@ class Droppable extends ej.Widget { defaults: Droppable.Model; /** destroy in the Droppable. - * @returns {void} - */ + * @returns {void} + */ _destroy(): void; } export namespace Droppable { @@ -685,13 +685,13 @@ export namespace Droppable { export interface Model { /** Used to accept the specified draggable items. - * @Default {null} - */ + * @Default {null} + */ accept?: any; /** Used to group sets of droppable items, in addition to droppable's accept option. A draggable with the same scope value as a droppable will be accepted by the droppable. - * @Default {'default'} - */ + * @Default {'default'} + */ scope?: string; /** This event is triggered when the mouse up is moved during the dragging. */ @@ -707,57 +707,57 @@ export interface Model { export interface DropEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the autocomplete model - */ + */ model?: ej.Droppable.Model; /** returns the name of the event - */ + */ type?: string; /** returns the element which accepts the droppable element. - */ + */ targetElement?: any; } export interface OutEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the autocomplete model - */ + */ model?: ej.Droppable.Model; /** returns the name of the event - */ + */ type?: string; /** returns the mouse out over the element - */ + */ targetElement?: any; } export interface OverEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the autocomplete model - */ + */ model?: ej.Droppable.Model; /** returns the name of the event - */ + */ type?: string; /** returns the mouse over the element - */ + */ targetElement?: any; } } @@ -770,8 +770,8 @@ class Resizable extends ej.Widget { defaults: Resizable.Model; /** destroy in the Resizable. - * @returns {void} - */ + * @returns {void} + */ _destroy(): void; } export namespace Resizable { @@ -779,43 +779,43 @@ export namespace Resizable { export interface Model { /** Sets the offset of the resizing helper relative to the mouse cursor. - * @Default {{ top: -1, left: -2 }} - */ + * @Default {{ top: -1, left: -2 }} + */ cursorAt?: any; /** Distance in pixels after mousedown the mouse must move before resizing should start. This option can be used to prevent unwanted drags when clicking on an element. - * @Default {1} - */ + * @Default {1} + */ distance?: number; /** If specified, restricts resize start click to the specified element(s). - * @Default {null} - */ + * @Default {null} + */ handle?: string; /** Sets the max height for resizing - * @Default {null} - */ + * @Default {null} + */ maxHeight?: number; /** Sets the max width for resizing - * @Default {null} - */ + * @Default {null} + */ maxWidth?: number; /** Sets the min Height for resizing - * @Default {10} - */ + * @Default {10} + */ minHeight?: number; /** Sets the min Width for resizing - * @Default {10} - */ + * @Default {10} + */ minWidth?: number; /** Used to group sets of resizable items. - * @Default {'default'} - */ + * @Default {'default'} + */ scope?: string; /** This event is triggered when the widget destroys. */ @@ -828,30 +828,30 @@ export interface Model { export interface DestroyEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the autocomplete model - */ + */ model?: ej.Resizable.Model; /** returns the name of the event - */ + */ type?: string; } export interface HelperEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the autocomplete model - */ + */ model?: ej.Resizable.Model; /** returns the name of the event - */ + */ type?: string; } } @@ -860,82 +860,82 @@ export interface HelperEventArgs { const globalize: globalize; const cultures: culture; function addCulture(name: string, culture ?: any): void; - function preferredCulture(culture ?: string): culture; - function format(value: any, format: string, culture ?: string): string; - function parseInt(value: string, radix?: any, culture ?: string): number; - function parseFloat(value: string, radix?: any, culture ?: string): number; - function parseDate(value: string, format: string, culture ?: string): Date; - function getLocalizedConstants(controlName: string, culture ?: string): any; + function preferredCulture(culture ?: string): culture; + function format(value: any, format: string, culture ?: string): string; + function parseInt(value: string, radix?: any, culture ?: string): number; + function parseFloat(value: string, radix?: any, culture ?: string): number; + function parseDate(value: string, format: string, culture ?: string): Date; + function getLocalizedConstants(controlName: string, culture ?: string): any; interface globalize { - addCulture(name: string, culture?: any): void; - preferredCulture(culture?: string): culture; - format(value: any, format: string, culture?: string): string; - parseInt(value: string, radix?: any, culture?: string): number; - parseFloat(value: string, radix?: any, culture?: string): number; - parseDate(value: string, format: string, culture?: string): Date; - getLocalizedConstants(controlName: string, culture?: string): any; - } - interface culture { - name?: string; - englishName?: string; - namtiveName?: string; - language?: string; - isRTL: boolean; - numberFormat?: formatSettings; - calendars?: calendarsSettings; - } - interface formatSettings { - pattern: string[]; - decimals: number; - groupSizes: number[]; - percent: percentSettings; - currency: currencySettings; - } - interface percentSettings { - pattern: string[]; - decimals: number; - groupSizes: number[]; - symbol: string; - } - interface currencySettings { - pattern: string[]; - decimals: number; - groupSizes: number[]; - symbol: string; - } - interface calendarsSettings { - standard: standardSettings; - } - interface standardSettings { - firstDay: number; - days: daySettings; - months: monthSettings; - AM: string[]; - PM: string[]; - twoDigitYearMax: number; - patterns: patternSettings; - } - interface daySettings { - names: string[]; - namesAbbr: string[]; - namesShort: string[]; - } - interface monthSettings { - names: string[]; - namesAbbr: string[]; - } - interface patternSettings { - d: string; - D: string; - t: string; - T: string; - f: string; - F: string; - M: string; - Y: string; - S: string; - } + addCulture(name: string, culture?: any): void; + preferredCulture(culture?: string): culture; + format(value: any, format: string, culture?: string): string; + parseInt(value: string, radix?: any, culture?: string): number; + parseFloat(value: string, radix?: any, culture?: string): number; + parseDate(value: string, format: string, culture?: string): Date; + getLocalizedConstants(controlName: string, culture?: string): any; + } + interface culture { + name?: string; + englishName?: string; + namtiveName?: string; + language?: string; + isRTL: boolean; + numberFormat?: formatSettings; + calendars?: calendarsSettings; + } + interface formatSettings { + pattern: string[]; + decimals: number; + groupSizes: number[]; + percent: percentSettings; + currency: currencySettings; + } + interface percentSettings { + pattern: string[]; + decimals: number; + groupSizes: number[]; + symbol: string; + } + interface currencySettings { + pattern: string[]; + decimals: number; + groupSizes: number[]; + symbol: string; + } + interface calendarsSettings { + standard: standardSettings; + } + interface standardSettings { + firstDay: number; + days: daySettings; + months: monthSettings; + AM: string[]; + PM: string[]; + twoDigitYearMax: number; + patterns: patternSettings; + } + interface daySettings { + names: string[]; + namesAbbr: string[]; + namesShort: string[]; + } + interface monthSettings { + names: string[]; + namesAbbr: string[]; + } + interface patternSettings { + d: string; + D: string; + t: string; + T: string; + f: string; + F: string; + M: string; + Y: string; + S: string; + } class Scroller extends ej.Widget { static fn: Scroller; constructor(element: JQuery | Element, options?: Scroller.Model); @@ -944,49 +944,49 @@ class Scroller extends ej.Widget { defaults: Scroller.Model; /** destroy the Scroller control, unbind the all ej control related events automatically and bring the control to pre-init state. - * @returns {void} - */ + * @returns {void} + */ destroy(): void; /** User disables the Scroller control at any time. - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** User enables the Scroller control at any time. - * @returns {void} - */ + * @returns {void} + */ enable(): void; /** Returns true if horizontal scrollbar is shown, else return false. - * @returns {boolean} - */ + * @returns {boolean} + */ isHScroll(): boolean; /** Returns true if vertical scrollbar is shown, else return false. - * @returns {boolean} - */ + * @returns {boolean} + */ isVScroll(): boolean; /** User refreshes the Scroller control at any time. - * @returns {void} - */ + * @returns {void} + */ refresh(): void; /** Horizontal scroller moves to given pixel from its origin position. We can also specify the animation speed,in which the scroller has to move while re-positioning it. - * @param {number|string} Horizontal scroller moves to the specified pixel. - * @param {boolean} Specifies to enable/disable the animation. - * @param {number} Specifies the animation speed when scrolling, if animation is enabled. - * @returns {void} - */ + * @param {number|string} Horizontal scroller moves to the specified pixel. + * @param {boolean} Specifies to enable/disable the animation. + * @param {number} Specifies the animation speed when scrolling, if animation is enabled. + * @returns {void} + */ scrollX(pixel: number|string, disableAnimation: boolean, animationSpeed: number): void; /** Vertical scroller moves to given pixel from its origin position. We can also specify the animation speed,in which the scroller has to move while re-positioning it. - * @param {number|string} Vertical scroller moves to the specified pixel. - * @param {boolean} Specifies to enable/disable the animation. - * @param {number} Specifies the animation speed when scrolling, if animation is enabled. - * @returns {void} - */ + * @param {number|string} Vertical scroller moves to the specified pixel. + * @param {boolean} Specifies to enable/disable the animation. + * @param {number} Specifies the animation speed when scrolling, if animation is enabled. + * @returns {void} + */ scrollY(pixel: number|string, disableAnimation: boolean, animationSpeed: number): void; } export namespace Scroller { @@ -994,73 +994,73 @@ export namespace Scroller { export interface Model { /** Specifies the swipe scrolling speed(in millisecond). - * @Default {600} - */ + * @Default {600} + */ animationSpeed?: number; /** Set true to hides the scrollbar, when mouseout the content area. - * @Default {false} - */ + * @Default {false} + */ autoHide?: boolean; /** Specifies the height and width of button in the scrollbar. - * @Default {18} - */ + * @Default {18} + */ buttonSize?: number; /** Specifies to enable or disable the scroller - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Save current model value to browser cookies for state maintenance. While refresh the page Rating control values are retained. - * @Default {false} - */ + * @Default {false} + */ enablePersistence?: boolean; /** Indicates the Right to Left direction to scroller - * @Default {undefined} - */ + * @Default {undefined} + */ enableRTL?: boolean; /** Enables or Disable the touch Scroll - * @Default {true} - */ + * @Default {true} + */ enableTouchScroll?: boolean; /** Specifies the height of Scroll panel and scrollbars. - * @Default {250} - */ + * @Default {250} + */ height?: number|string; /** If the scrollbar has vertical it set as width, else it will set as height of the handler. - * @Default {18} - */ + * @Default {18} + */ scrollerSize?: number; /** The Scroller content and scrollbars move left with given value. - * @Default {0} - */ + * @Default {0} + */ scrollLeft?: number; /** While press on the arrow key the scrollbar position added to the given pixel value. - * @Default {57} - */ + * @Default {57} + */ scrollOneStepBy?: number; /** The Scroller content and scrollbars move to top position with specified value. - * @Default {0} - */ + * @Default {0} + */ scrollTop?: number; /** Indicates the target area to which scroller have to appear. - * @Default {null} - */ + * @Default {null} + */ targetPane?: string; /** Specifies the width of Scroll panel and scrollbars. - * @Default {0} - */ + * @Default {0} + */ width?: number|string; /** Fires when Scroller control is created. */ @@ -1091,152 +1091,152 @@ export interface Model { export interface CreateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the scroller model - */ + */ model?: ej.Scroller.Model; /** returns the name of the event. - */ + */ type?: string; } export interface DestroyEventArgs { /** returns the scroller model - */ + */ model?: ej.Scroller.Model; /** returns the name of the event. - */ + */ type?: string; } export interface ThumbMoveEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the scroller model - */ + */ model?: ej.Scroller.Model; /** returns the original event name and its event properties of the current event. - */ + */ originalEvent?: any; /** returns the current data related to the event. - */ + */ scrollData?: any; /** returns the name of the event. - */ + */ type?: string; } export interface ThumbStartEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the scroller model - */ + */ model?: ej.Scroller.Model; /** returns the original event name and its event properties of the current event. - */ + */ originalEvent?: any; /** returns the current data related to the event. - */ + */ scrollData?: any; /** returns the name of the event. - */ + */ type?: string; } export interface ThumbEndEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the scroller model - */ + */ model?: ej.Scroller.Model; /** returns the original event name and its event properties of the current event. - */ + */ originalEvent?: any; /** returns the current data related to the event. - */ + */ scrollData?: any; /** returns the name of the event. - */ + */ type?: string; } export interface WheelMoveEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the scroller model - */ + */ model?: ej.Scroller.Model; /** returns the original event name and its event properties of the current event. - */ + */ originalEvent?: any; } export interface WheelStartEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the scroller model - */ + */ model?: ej.Scroller.Model; /** returns the original event name and its event properties of the current event. - */ + */ originalEvent?: any; /** returns the current data related to the event. - */ + */ scrollData?: any; /** returns the name of the event. - */ + */ type?: string; } export interface WheelStopEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the scroller model - */ + */ model?: ej.Scroller.Model; /** returns the name of the event. - */ + */ type?: string; /** returns the original event name and its event properties of the current event. - */ + */ originalEvent?: any; } } @@ -1249,85 +1249,85 @@ class Accordion extends ej.Widget { defaults: Accordion.Model; /** AddItem method is used to add the panel in dynamically. It receives the following parameters - * @param {string} specify the name of the header - * @param {string} content of the new panel - * @param {number} insertion place of the new panel - * @param {boolean} Enable or disable the AJAX request to the added panel - * @returns {void} - */ + * @param {string} specify the name of the header + * @param {string} content of the new panel + * @param {number} insertion place of the new panel + * @param {boolean} Enable or disable the AJAX request to the added panel + * @returns {void} + */ addItem(header_name: string, content: string, index: number, isAjaxReq: boolean): void; /** This method used to collapse the all the expanded items in accordion at a time. - * @returns {void} - */ + * @returns {void} + */ collapseAll(): void; /** This method used to Collapses the specified items in accordion at a time. - * @returns {void} - */ + * @returns {void} + */ collapsePanel(): void; /** destroy the Accordion widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. - * @returns {void} - */ + * @returns {void} + */ destroy(): void; /** Disables the accordion widget includes all the headers and content panels. - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** Disable the accordion widget item based on specified header index. - * @param {Array} index values to disable the panels - * @returns {void} - */ + * @param {Array} index values to disable the panels + * @returns {void} + */ disableItems(index: any[]): void; /** Enable the accordion widget includes all the headers and content panels. - * @returns {void} - */ + * @returns {void} + */ enable(): void; /** Enable the accordion widget item based on specified header index. - * @param {Array} index values to enable the panels - * @returns {void} - */ + * @param {Array} index values to enable the panels + * @returns {void} + */ enableItems(index: any[]): void; /** To expand all the accordion widget items. - * @returns {void} - */ + * @returns {void} + */ expandAll(): void; /** This method used to Expand the specified items in accordion at a time. - * @returns {void} - */ + * @returns {void} + */ expandPanel(): void; /** Returns the total number of panels in the control. - * @returns {number} - */ + * @returns {number} + */ getItemsCount(): number; /** Hides the visible Accordion control. - * @returns {void} - */ + * @returns {void} + */ hide(): void; /** The refresh method is used to adjust the control size based on the parent element dimension. - * @returns {void} - */ + * @returns {void} + */ refresh(): void; /** RemoveItem method is used to remove the specified index panel.It receives the parameter as number. - * @param {number} specify the index value for remove the accordion panel. - * @returns {void} - */ + * @param {number} specify the index value for remove the accordion panel. + * @returns {void} + */ removeItem(index: number): void; /** Shows the hidden Accordion control. - * @returns {void} - */ + * @returns {void} + */ show(): void; } export namespace Accordion { @@ -1335,121 +1335,121 @@ export namespace Accordion { export interface Model { /** Specifies the ajaxSettings option to load the content to the accordion control. - * @Default {null} - */ + * @Default {null} + */ ajaxSettings?: AjaxSettings; /** Accordion headers can be expanded and collapsed on keyboard action. - * @Default {true} - */ + * @Default {true} + */ allowKeyboardNavigation?: boolean; /** To set the Accordion headers Collapse Speed. - * @Default {300} - */ + * @Default {300} + */ collapseSpeed?: number; /** Specifies the collapsible state of accordion control. - * @Default {false} - */ + * @Default {false} + */ collapsible?: boolean; /** Sets the root CSS class for Accordion theme, which is used customize. - */ + */ cssClass?: string; /** Allows you to set the custom header Icon. It accepts two key values Ă¢â‚¬Å“headerĂ¢â‚¬Â, Ă¢â‚¬ÂselectedHeaderĂ¢â‚¬Â. - * @Default {{ header: e-collapse, selectedHeader: e-expand }} - */ + * @Default {{ header: e-collapse, selectedHeader: e-expand }} + */ customIcon?: CustomIcon; /** Disables the specified indexed items in accordion. - * @Default {[]} - */ + * @Default {[]} + */ disabledItems?: number[]; /** Specifies the animation behavior in accordion. - * @Default {true} - */ + * @Default {true} + */ enableAnimation?: boolean; /** With this enabled property, you can enable or disable the Accordion. - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Used to enable the disabled items in accordion. - * @Default {[]} - */ + * @Default {[]} + */ enabledItems?: number[]; /** Multiple content panels to activate at a time. - * @Default {false} - */ + * @Default {false} + */ enableMultipleOpen?: boolean; /** Save current model value to browser cookies for maintaining states. When refreshing the accordion control page, the model value is applied from browser cookies or HTML 5local storage. - * @Default {false} - */ + * @Default {false} + */ enablePersistence?: boolean; /** Display headers and panel text from right-to-left. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** The events API binds the action for activating the accordion header. Users can activate the header by using mouse actions such as mouse-over, mouse-up, mouse-down, and soon. - * @Default {click} - */ + * @Default {click} + */ events?: string; /** To set the Accordion headers Expand Speed. - * @Default {300} - */ + * @Default {300} + */ expandSpeed?: number; /** Sets the height for Accordion items header. - */ + */ headerSize?: number|string; /** Specifies height of the accordion. - * @Default {null} - */ + * @Default {null} + */ height?: number|string; /** Adjusts the content panel height based on the given option (content, auto, or fill). By default, the panel heights are adjusted based on the content. - * @Default {content} - */ + * @Default {content} + */ heightAdjustMode?: ej.Accordion.HeightAdjustMode|string; /** It allows to define the characteristics of the Accordion control. It will helps to extend the capability of an HTML element. - * @Default {{}} - */ + * @Default {{}} + */ htmlAttributes?: any; /** The given index header will activate (open). If collapsible is set to true, and a negative value is given, then all headers are collapsed. Otherwise, the first panel isactivated. - * @Default {0} - */ + * @Default {0} + */ selectedItemIndex?: number; /** Activate the specified indexed items of the accordion - * @Default {[0]} - */ + * @Default {[0]} + */ selectedItems?: number[]; /** Used to determines the close button visibility an each accordion items. This close button helps to remove the accordion item from the control. - * @Default {false} - */ + * @Default {false} + */ showCloseButton?: boolean; /** Displays rounded corner borders on the Accordion control's panels and headers. - * @Default {false} - */ + * @Default {false} + */ showRoundedCorner?: boolean; /** Specifies width of the accordion. - * @Default {null} - */ + * @Default {null} + */ width?: number|string; /** Triggered after a Accordion item is active or inactive. Argument values are activeIndex, activeHeader, inActiveHeader, inActiveIndex and current model value. */ @@ -1486,256 +1486,256 @@ export interface Model { export interface ActivateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the accordion model - */ + */ model?: ej.Accordion.Model; /** returns the name of the event - */ + */ type?: string; /** returns active index - */ + */ activeIndex?: number; /** returns current active header - */ + */ activeHeader?: any; /** returns true when the Accordion index activated by user interaction otherwise returns false - */ + */ isInteraction?: boolean; } export interface AjaxBeforeLoadEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the accordion model - */ + */ model?: ej.Accordion.Model; /** returns the name of the event - */ + */ type?: string; /** returns current AJAX content location - */ + */ URL?: string; } export interface AjaxErrorEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the accordion model - */ + */ model?: ej.Accordion.Model; /** returns the name of the event - */ + */ type?: string; /** returns current AJAX content location - */ + */ URL?: string; /** returns the failed data sent. - */ + */ data?: string; } export interface AjaxLoadEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the accordion model - */ + */ model?: ej.Accordion.Model; /** returns the name of the event - */ + */ type?: string; /** returns the name of the URL - */ + */ URL?: string; } export interface AjaxSuccessEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the accordion model - */ + */ model?: ej.Accordion.Model; /** returns the name of the event - */ + */ type?: string; /** returns current AJAX content location - */ + */ URL?: string; /** returns the successful data sent. - */ + */ data?: string; /** returns the AJAX content. - */ + */ content?: string; } export interface BeforeActivateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the accordion model - */ + */ model?: ej.Accordion.Model; /** returns the name of the event - */ + */ type?: string; /** returns active index - */ + */ activeIndex?: number; /** returns true when the Accordion index activated by user interaction otherwise returns false - */ + */ isInteraction?: boolean; } export interface BeforeInactivateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the accordion model - */ + */ model?: ej.Accordion.Model; /** returns the name of the event - */ + */ type?: string; /** returns active index - */ + */ inActiveIndex?: number; /** returns true when the Accordion index activated by user interaction otherwise returns false - */ + */ isInteraction?: boolean; } export interface CreateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the accordion model - */ + */ model?: ej.Accordion.Model; /** returns the name of the event - */ + */ type?: string; } export interface DestroyEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the accordion model - */ + */ model?: ej.Accordion.Model; /** returns the name of the event - */ + */ type?: string; } export interface InActivateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the accordion model - */ + */ model?: ej.Accordion.Model; /** returns the name of the event - */ + */ type?: string; /** returns active index - */ + */ inActiveIndex?: number; /** returns in active element - */ + */ inActiveHeader?: any; /** returns true when the Accordion index activated by user interaction otherwise returns false - */ + */ isInteraction?: boolean; } export interface AjaxSettings { /** It specifies, whether to enable or disable asynchronous request. - */ + */ async?: boolean; /** It specifies the page will be cached in the web browser. - */ + */ cache?: boolean; /** It specifies the type of data is send in the query string. - */ + */ contentType?: string; /** It specifies the data as an object, will be passed in the query string. - */ + */ data?: any; /** It specifies the type of data that you're expecting back from the response. - */ + */ dataType?: string; /** It specifies the HTTP request type. - */ + */ type?: string; } export interface CustomIcon { /** This class name set to collapsing header. - */ + */ header?: string; /** This class name set to expanded (active) header. - */ + */ selectedHeader?: string; } @@ -1761,60 +1761,60 @@ class Autocomplete extends ej.Widget { defaults: Autocomplete.Model; /** Clears the text in the Autocomplete textbox. - * @returns {void} - */ + * @returns {void} + */ clearText(): void; /** Destroys the Autocomplete widget. - * @returns {void} - */ + * @returns {void} + */ destroy(): void; /** Disables the autocomplete widget. - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** Enables the autocomplete widget. - * @returns {void} - */ + * @returns {void} + */ enable(): void; /** Returns objects (data object) of all the selected items in the autocomplete textbox. - * @returns {any} - */ + * @returns {any} + */ getSelectedItems(): any; /** Returns the current selected value from the Autocomplete textbox. - * @returns {string} - */ + * @returns {string} + */ getValue(): string; /** Returns the current active text value in the Autocomplete suggestion list. - * @returns {string} - */ + * @returns {string} + */ getActiveText(): string; /** Search the entered text and show it in the suggestion list if available. - * @returns {void} - */ + * @returns {void} + */ search(): void; /** Open up the autocomplete suggestion popup with all list items. - * @returns {void} - */ + * @returns {void} + */ open(): void; /** Sets the value of the Autocomplete textbox based on the given key value. - * @param {string} The key value of the specific suggestion item. - * @returns {void} - */ + * @param {string} The key value of the specific suggestion item. + * @returns {void} + */ selectValueByKey(Key: string): void; /** Sets the value of the Autocomplete textbox based on the given input text value. - * @param {string} The text (label) value of the specific suggestion item. - * @returns {void} - */ + * @param {string} The text (label) value of the specific suggestion item. + * @returns {void} + */ selectValueByText(Text: string): void; } export namespace Autocomplete { @@ -1822,221 +1822,221 @@ export namespace Autocomplete { export interface Model { /** Customize "Add New" text (label) to be added in the autocomplete popup list for the entered text when there are no suggestions for it. - * @Default {Add New} - */ + * @Default {Add New} + */ addNewText?: boolean; /** Allows new values to be added to the autocomplete input other than the values in the suggestion list. - * Normally, when there are no suggestions it will display Ă¢â‚¬Å“No suggestionsĂ¢â‚¬Â label in the popup. - * @Default {false} - */ + * Normally, when there are no suggestions it will display Ă¢â‚¬Å“No suggestionsĂ¢â‚¬Â label in the popup. + * @Default {false} + */ allowAddNew?: boolean; /** Enables or disables the sorting of suggestion list item. The default sort order is ascending order. You customize sort order. - * @Default {true} - */ + * @Default {true} + */ allowSorting?: boolean; /** Enables or disables selecting the animation style for the popup list. Animation types can be selected through either of the following options, - * @Default {slide} - */ + * @Default {slide} + */ animateType?: ej.Autocomplete.Animation|string; /** To focus the items in the suggestion list when the popup is shown. By default first item will be focused. - * @Default {false} - */ + * @Default {false} + */ autoFocus?: boolean; /** Enables or disables the case sensitive search. - * @Default {false} - */ + * @Default {false} + */ caseSensitiveSearch?: boolean; /** The root class for the Autocomplete textbox widget which helps in customizing its theme. - * @Default {Ă¢â‚¬ÂĂ¢â‚¬Â} - */ + * @Default {Ă¢â‚¬ÂĂ¢â‚¬Â} + */ cssClass?: string; /** The data source contains the list of data for the suggestions list. It can be a string array or JSON array. - * @Default {null} - */ + * @Default {null} + */ dataSource?: any|any[]; /** The time delay (in milliseconds) after which the suggestion popup will be shown. - * @Default {200} - */ + * @Default {200} + */ delaySuggestionTimeout?: number; /** The special character which acts as a separator for the given words for multi-mode search i.e. the text after the delimiter are considered as a separate word or query for search operation. - * @Default {Ă¢â‚¬â„¢,Ă¢â‚¬â„¢} - */ + * @Default {Ă¢â‚¬â„¢,Ă¢â‚¬â„¢} + */ delimiterChar?: string; /** The text to be displayed in the popup when there are no suggestions available for the entered text. - * @Default {Ă¢â‚¬Å“No suggestionsĂ¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“No suggestionsĂ¢â‚¬Â} + */ emptyResultText?: string; /** Fills the autocomplete textbox with the first matched item from the suggestion list automatically based on the entered text when enabled. - * @Default {false} - */ + * @Default {false} + */ enableAutoFill?: boolean; /** Enables or disables the Autocomplete textbox widget. - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Enables or disables displaying the duplicate names present in the search result. - * @Default {false} - */ + * @Default {false} + */ enableDistinct?: boolean; /** Allows the current model values to be saved in local storage or browser cookies for state maintenance - * when it is set to true. - * While refreshing the page, it retains the model value from browser cookies or local storage. - * @Default {false} - */ + * when it is set to true. + * While refreshing the page, it retains the model value from browser cookies or local storage. + * @Default {false} + */ enablePersistence?: boolean; /** Displays the Autocomplete widgetĂ¢â‚¬â„¢s content from right to left when enabled. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Mapping fields for the suggestion items of the Autocomplete textbox widget. - * @Default {null} - */ + * @Default {null} + */ fields?: Fields; /** Specifies the search filter type. - * There are several types of search filter available such as Ă¢â‚¬ËœstartswithĂ¢â‚¬â„¢, - * Ă¢â‚¬ËœcontainsĂ¢â‚¬â„¢, Ă¢â‚¬ËœendswithĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœgreaterthanĂ¢â‚¬â„¢, - * Ă¢â‚¬ËœgreaterthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœnotequalĂ¢â‚¬â„¢. - * @Default {ej.filterType.StartsWith} - */ + * There are several types of search filter available such as Ă¢â‚¬ËœstartswithĂ¢â‚¬â„¢, + * Ă¢â‚¬ËœcontainsĂ¢â‚¬â„¢, Ă¢â‚¬ËœendswithĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœgreaterthanĂ¢â‚¬â„¢, + * Ă¢â‚¬ËœgreaterthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœnotequalĂ¢â‚¬â„¢. + * @Default {ej.filterType.StartsWith} + */ filterType?: string; /** The height of the Autocomplete textbox. - * @Default {null} - */ + * @Default {null} + */ height?: string|number; /** The search text can be highlighted in the AutoComplete suggestion list when enabled. - * @Default {false} - */ + * @Default {false} + */ highlightSearch?: boolean; /** Number of items to be displayed in the suggestion list. - * @Default {0} - */ + * @Default {0} + */ itemsCount?: number; /** Set the localization culture for Autocomplete Widget. - */ + */ locale?: string; /** Minimum number of character to be entered in the Autocomplete textbox to show the suggestion list. - * @Default {1} - */ + * @Default {1} + */ minCharacter?: number; /** An Autocomplete column collection can be defined and customized through the multiColumnSettings property.Column's header, field, and stringFormat can be define via multiColumnSettings properties. - */ + */ multiColumnSettings?: MultiColumnSettings; /** Enables or disables selecting multiple values from the suggestion list. Multiple values can be selected through either of the following options, - * @Default {ej.MultiSelectMode.None} - */ + * @Default {ej.MultiSelectMode.None} + */ multiSelectMode?: ej.Autocomplete.MultiSelectMode|string; /** The height of the suggestion list. - * @Default {Ă¢â‚¬Å“152pxĂ¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“152pxĂ¢â‚¬Â} + */ popupHeight?: string; /** The width of the suggestion list. - * @Default {Ă¢â‚¬Å“autoĂ¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“autoĂ¢â‚¬Â} + */ popupWidth?: string; /** The query to retrieve the data from the data source. - * @Default {null} - */ + * @Default {null} + */ query?: ej.Query; /** Indicates that the autocomplete textbox values can only be readable. - * @Default {false} - */ + * @Default {false} + */ readOnly?: boolean; /** Sets the value for the Autocomplete textbox based on the given input key value. - */ + */ selectValueByKey?: number; /** Enables or disables showing the message when there are no suggestions for the entered text. - * @Default {true} - */ + * @Default {true} + */ showEmptyResultText?: boolean; /** Enables or disables the loading icon to intimate the searching operation. The loading icon is visible when there is a time delay to perform the search. - * @Default {true} - */ + * @Default {true} + */ showLoadingIcon?: boolean; /** Enables the showPopup button in autocomplete textbox. When the showPopup button is clicked, it displays all the available data from the data source. - * @Default {false} - */ + * @Default {false} + */ showPopupButton?: boolean; /** Enables or disables rounded corner. - * @Default {false} - */ + * @Default {false} + */ showRoundedCorner?: boolean; /** Enables or disables reset icon to clear the textbox values. - * @Default {false} - */ + * @Default {false} + */ showResetIcon?: boolean; /** Sort order specifies whether the suggestion list values has to be displayed in ascending or descending order. - * @Default {ej.SortOrder.Ascending} - */ + * @Default {ej.SortOrder.Ascending} + */ sortOrder?: ej.Autocomplete.SortOrder|string; /** The template to display the suggestion list items with customized appearance. - * @Default {null} - */ + * @Default {null} + */ template?: string; /** The jQuery validation error message to be displayed on form validation. - * @Default {null} - */ + * @Default {null} + */ validationMessage?: any; /** The jQuery validation rules for form validation. - * @Default {null} - */ + * @Default {null} + */ validationRules?: any; /** The value to be displayed in the autocomplete textbox. - * @Default {null} - */ + * @Default {null} + */ value?: string; /** Enables or disables the visibility of the autocomplete textbox. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** The text to be displayed when the value of the autocomplete textbox is empty. - * @Default {null} - */ + * @Default {null} + */ watermarkText?: string; /** The width of the Autocomplete textbox. - * @Default {null} - */ + * @Default {null} + */ width?: string|number; /** Triggers when the AJAX requests Begins. */ @@ -2078,250 +2078,250 @@ export interface Model { export interface ActionBeginEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface ActionSuccessEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface ActionCompleteEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface ActionFailureEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface ChangeEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the autocomplete model object. - */ + */ model?: ej.Autocomplete.Model; /** Name of the event. - */ + */ type?: string; /** Value of the autocomplete textbox. - */ + */ value?: string; } export interface CloseEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the autocomplete model object. - */ + */ model?: ej.Autocomplete.Model; /** Name of the event. - */ + */ type?: string; } export interface CreateEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the autocomplete model object. - */ + */ model?: ej.Autocomplete.Model; /** Name of the event. - */ + */ type?: string; } export interface DestroyEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the autocomplete model object. - */ + */ model?: ej.Autocomplete.Model; /** Name of the event. - */ + */ type?: string; } export interface FocusInEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the autocomplete model object. - */ + */ model?: ej.Autocomplete.Model; /** Name of the event. - */ + */ type?: string; /** Value of the autocomplete textbox. - */ + */ value?: string; } export interface FocusOutEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the autocomplete model object. - */ + */ model?: ej.Autocomplete.Model; /** Name of the event. - */ + */ type?: string; /** Value of the autocomplete textbox. - */ + */ value?: string; } export interface OpenEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the autocomplete model object. - */ + */ model?: ej.Autocomplete.Model; /** Name of the event. - */ + */ type?: string; } export interface SelectEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the autocomplete model object. - */ + */ model?: ej.Autocomplete.Model; /** Name of the event. - */ + */ type?: string; /** Value of the autocomplete textbox. - */ + */ value?: string; /** Text of the selected item. - */ + */ text?: string; /** Key of the selected item. - */ + */ key?: string; /** Data object of the selected item. - */ + */ Item?: ej.Autocomplete.Model; } export interface Fields { /** Used to group the suggestion list items. - */ + */ groupBy?: string; /** Defines the HTML attributes such as id, class, styles for the item. - */ + */ htmlAttributes?: any; /** Defines the specific field name which contains unique key values for the list items. - */ + */ key?: string; /** Defines the specific field name in the data source to load the suggestion list with data. - */ + */ text?: string; } export interface MultiColumnSettingsColumn { /** Get or set a value that indicates to display the columns in the autocomplete mapping with column name of the dataSource. - */ + */ field?: string; /** Get or set a value that indicates to display the title of that particular column. - */ + */ headerText?: string; /** Gets or sets a value that indicates to render the multicolumn with custom theme. - */ + */ cssClass?: string; /** Specifies the search data type. There are four types of data types available such as string, Ă¢â‚¬ËœnumberĂ¢â‚¬â„¢, Ă¢â‚¬ËœbooleanĂ¢â‚¬â„¢ and Ă¢â‚¬ËœdateĂ¢â‚¬â„¢. - * @Default {ej.Type.String} - */ + * @Default {ej.Type.String} + */ type?: ej.Type|string; /** Specifies the search filter type. There are several types of search filter available such as Ă¢â‚¬ËœstartswithĂ¢â‚¬â„¢, - * Ă¢â‚¬ËœcontainsĂ¢â‚¬â„¢, Ă¢â‚¬ËœendswithĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœgreaterthanĂ¢â‚¬â„¢, - * Ă¢â‚¬ËœgreaterthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœnotequalĂ¢â‚¬â„¢. - * @Default {ej.filterType.StartsWith} - */ + * Ă¢â‚¬ËœcontainsĂ¢â‚¬â„¢, Ă¢â‚¬ËœendswithĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœgreaterthanĂ¢â‚¬â„¢, + * Ă¢â‚¬ËœgreaterthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœnotequalĂ¢â‚¬â„¢. + * @Default {ej.filterType.StartsWith} + */ filterType?: ej.filterType|string; /** This defines the text alignment of a particular column header cell value. See headerTextAlign - * @Default {ej.TextAlign.Left} - */ + * @Default {ej.TextAlign.Left} + */ headerTextAlign?: ej.TextAlign|string; /** Gets or sets a value that indicates to align the text within the column. See textAlign - * @Default {ej.TextAlign.Left} - */ + * @Default {ej.TextAlign.Left} + */ textAlign?: ej.TextAlign|string; } export interface MultiColumnSettings { /** Allow list of data to be displayed in several columns. - * @Default {false} - */ + * @Default {false} + */ enable?: boolean; /** Allow header text to be displayed in corresponding columns. - * @Default {true} - */ + * @Default {true} + */ showHeader?: boolean; /** Displayed selected value and autocomplete search based on mentioned column value specified in that format. - */ + */ stringFormat?: string; /** Field and Header Text collections can be defined and customized through columns field. - */ + */ columns?: MultiColumnSettingsColumn[]; } @@ -2367,18 +2367,18 @@ class Button extends ej.Widget { defaults: Button.Model; /** destroy the button widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. - * @returns {void} - */ + * @returns {void} + */ destroy(): void; /** To disable the button - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** To enable the button - * @returns {void} - */ + * @returns {void} + */ enable(): void; } export namespace Button { @@ -2386,90 +2386,90 @@ export namespace Button { export interface Model { /** Specifies the contentType of the Button. See below to know available ContentType - * @Default {ej.ContentType.TextOnly} - */ + * @Default {ej.ContentType.TextOnly} + */ contentType?: ej.ContentType|string; /** Sets the root CSS class for Button theme, which is used customize. - */ + */ cssClass?: string; /** Specifies the button control state. - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Specify the Right to Left direction to button - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Specifies the height of the Button. - * @Default {28} - */ + * @Default {28} + */ height?: number; /** It allows to define the characteristics of the Button control. It will helps to extend the capability of an HTML element. - * @Default {{}} - */ + * @Default {{}} + */ htmlAttributes?: any; /** Specifies the image position of the Button. This image position is applicable - * only with the textandimage contentType property. The images can be positioned in both - * imageLeft and imageRight options. See below to know about available ImagePosition - * @Default {ej.ImagePosition.ImageLeft} - */ + * only with the textandimage contentType property. The images can be positioned in both + * imageLeft and imageRight options. See below to know about available ImagePosition + * @Default {ej.ImagePosition.ImageLeft} + */ imagePosition?: ej.ImagePosition|string; /** Specifies the primary icon for Button. This icon will be displayed from the left margin of the button. - * @Default {null} - */ + * @Default {null} + */ prefixIcon?: string; /** Convert the button as repeat button. It raises the 'Click' event repeatedly from the it is pressed until it is released. - * @Default {false} - */ + * @Default {false} + */ repeatButton?: boolean; /** Displays the Button with rounded corners. - * @Default {false} - */ + * @Default {false} + */ showRoundedCorner?: boolean; /** Specifies the size of the Button. See below to know available ButtonSize - * @Default {ej.ButtonSize.Normal} - */ + * @Default {ej.ButtonSize.Normal} + */ size?: ej.ButtonSize|string; /** Specifies the secondary icon for Button. This icon will be displayed from the right margin of the button. - * @Default {null} - */ + * @Default {null} + */ suffixIcon?: string; /** Specifies the text content for Button. - * @Default {null} - */ + * @Default {null} + */ text?: string; /** Specified the time interval between two consecutive 'click' event on the button. - * @Default {150} - */ + * @Default {150} + */ timeInterval?: string; /** Specifies the Type of the Button. See below to know available ButtonType - * @Default {ej.ButtonType.Submit} - */ + * @Default {ej.ButtonType.Submit} + */ type?: ej.ButtonType|string; /** Specifies the width of the Button. - * @Default {100px} - */ + * @Default {100px} + */ width?: string|number; /** Fires when Button control is clicked successfully.Consider the scenario to perform any validation, - * modification of content or any other operations click on button,we can make use of this click event - * to achieve the scenario. - */ + * modification of content or any other operations click on button,we can make use of this click event + * to achieve the scenario. + */ click?(e: ClickEventArgs): void; /** Fires after Button control is created.If the user want to perform any operation after the button control creation then the user can make use of this create event. */ @@ -2482,53 +2482,53 @@ export interface Model { export interface ClickEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the button model - */ + */ model?: ej.Button.Model; /** returns the name of the event - */ + */ type?: string; /** return the button state - */ + */ status?: boolean; /** return the event model for sever side processing. - */ + */ e?: any; } export interface CreateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the button model - */ + */ model?: ej.Button.Model; /** returns the name of the event - */ + */ type?: string; } export interface DestroyEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the button model - */ + */ model?: ej.Button.Model; /** returns the name of the event - */ + */ type?: string; } } @@ -2587,71 +2587,71 @@ export namespace Captcha { export interface Model { /** Specifies the character set of the Captcha that will be used to generate captcha text randomly. - */ + */ characterSet?: string; /** Specifies the error message to be displayed when the Captcha mismatch. - */ + */ customErrorMessage?: string; /** Set the Captcha validation automatically. - */ + */ enableAutoValidation?: boolean; /** Specifies the case sensitivity for the characters typed in the Captcha. - */ + */ enableCaseSensitivity?: boolean; /** Specifies the background patterns for the Captcha. - */ + */ enablePattern?: boolean; /** Sets the Captcha direction as right to left alignment. - */ + */ enableRTL?: boolean; /** Specifies the background appearance for the captcha. - */ + */ hatchStyle?: ej.HatchStyle|string; /** Specifies the height of the Captcha. - */ + */ height?: number; /** Specifies the method with values to be mapped in the Captcha. - */ + */ mapper?: string; /** Specifies the maximum number of characters used in the Captcha. - */ + */ maximumLength?: number; /** Specifies the minimum number of characters used in the Captcha. - */ + */ minimumLength?: number; /** Specifies the method to map values to Captcha. - */ + */ requestMapper?: string; /** Sets the Captcha with audio support, that enables to dictate the captcha text. - */ + */ showAudioButton?: boolean; /** Sets the Captcha with a refresh button. - */ + */ showRefreshButton?: boolean; /** Specifies the target button of the Captcha to validate the entered text and captcha text. - */ + */ targetButton?: string; /** Specifies the target input element that will verify the Captcha. - */ + */ targetInput?: string; /** Specifies the width of the Captcha. - */ + */ width?: number; /** Fires when captcha refresh begins. */ @@ -2670,60 +2670,60 @@ export interface Model { export interface RefreshBeginEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Captcha model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface RefreshCompleteEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Captcha model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface RefreshFailureEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Captcha model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface RefreshSuccessEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Captcha model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } } @@ -2812,304 +2812,304 @@ class ListBox extends ej.Widget { defaults: ListBox.Model; /** Adds a given list items in the ListBox widget at a specified index. It accepts two parameters. - * @param {any|string} This can be a list item object (for JSON binding) or a string (for UL and LI rendering). - * Also we can the specify this as an array of list item object or an array of strings to add multiple items. - * @param {number} The index value to add the given items at the specified index. If index is not specified, the given items will be added at the end of the list. - * @returns {void} - */ + * @param {any|string} This can be a list item object (for JSON binding) or a string (for UL and LI rendering). + * Also we can the specify this as an array of list item object or an array of strings to add multiple items. + * @param {number} The index value to add the given items at the specified index. If index is not specified, the given items will be added at the end of the list. + * @returns {void} + */ addItem(listItem: any|string, index: number): void; /** Checks all the list items in the ListBox widget. It is dependent on showCheckbox property. - * @returns {void} - */ + * @returns {void} + */ checkAll(): void; /** Checks a list item by using its index. It is dependent on showCheckbox property. - * @param {number} Index of the listbox item to be checked. If index is not specified, the given items will be added at the end of the list. - * @returns {void} - */ + * @param {number} Index of the listbox item to be checked. If index is not specified, the given items will be added at the end of the list. + * @returns {void} + */ checkItemByIndex(index: number): void; /** Checks multiple list items by using its index values. It is dependent on showCheckbox property. - * @param {number[]} Index/Indices of the listbox items to be checked. If index is not specified, the given items will be added at the end of the list. - * @returns {void} - */ + * @param {number[]} Index/Indices of the listbox items to be checked. If index is not specified, the given items will be added at the end of the list. + * @returns {void} + */ checkItemsByIndices(indices: number[]): void; /** Disables the ListBox widget. - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** Disables a list item by passing the item text as parameter. - * @param {string} Text of the listbox item to be disabled. - * @returns {void} - */ + * @param {string} Text of the listbox item to be disabled. + * @returns {void} + */ disableItem(text: string): void; /** Disables a list Item using its index value. - * @param {number} Index of the listbox item to be disabled. - * @returns {void} - */ + * @param {number} Index of the listbox item to be disabled. + * @returns {void} + */ disableItemByIndex(index: number): void; /** Disables set of list Items using its index values. - * @param {number[]|string} Indices of the listbox items to be disabled. - * @returns {void} - */ + * @param {number[]|string} Indices of the listbox items to be disabled. + * @returns {void} + */ disableItemsByIndices(Indices: number[]|string): void; /** Enables the ListBox widget when it is disabled. - * @returns {void} - */ + * @returns {void} + */ enable(): void; /** Enables a list Item using its item text value. - * @param {string} Text of the listbox item to be enabled. - * @returns {void} - */ + * @param {string} Text of the listbox item to be enabled. + * @returns {void} + */ enableItem(text: string): void; /** Enables a list item using its index value. - * @param {number} Index of the listbox item to be enabled. - * @returns {void} - */ + * @param {number} Index of the listbox item to be enabled. + * @returns {void} + */ enableItemByIndex(index: number): void; /** Enables a set of list Items using its index values. - * @param {number[]|string} Indices of the listbox items to be enabled. - * @returns {void} - */ + * @param {number[]|string} Indices of the listbox items to be enabled. + * @returns {void} + */ enableItemsByIndices(indices: number[]|string): void; /** Returns the list of checked items in the ListBox widget. It is dependent on showCheckbox property. - * @returns {any} - */ + * @returns {any} + */ getCheckedItems(): any; /** Returns the list of selected items in the ListBox widget. - * @returns {any} - */ + * @returns {any} + */ getSelectedItems(): any; /** Returns an itemĂ¢â‚¬â„¢s index based on the given text. - * @param {string} The list item text (label) - * @returns {number} - */ + * @param {string} The list item text (label) + * @returns {number} + */ getIndexByText(text: string): number; /** Returns an itemĂ¢â‚¬â„¢s index based on the value given. - * @param {string} The list itemĂ¢â‚¬â„¢s value - * @returns {number} - */ + * @param {string} The list itemĂ¢â‚¬â„¢s value + * @returns {number} + */ getIndexByValue(indices: string): number; /** Returns an itemĂ¢â‚¬â„¢s text (label) based on the index given. - * @returns {string} - */ + * @returns {string} + */ getTextByIndex(): string; /** Returns a list itemĂ¢â‚¬â„¢s object using its index. - * @returns {any} - */ + * @returns {any} + */ getItemByIndex(): any; /** Returns a list itemĂ¢â‚¬â„¢s object based on the text given. - * @param {string} The list item text. - * @returns {any} - */ + * @param {string} The list item text. + * @returns {any} + */ getItemByText(text: string): any; /** Merges the given data with the existing data items in the listbox. - * @param {Array} Data to merge in listbox. - * @returns {void} - */ + * @param {Array} Data to merge in listbox. + * @returns {void} + */ mergeData(data: any[]): void; /** Selects the next item based on the current selection. - * @returns {void} - */ + * @returns {void} + */ moveDown(): void; /** Selects the previous item based on the current selection. - * @returns {void} - */ + * @returns {void} + */ moveUp(): void; /** Refreshes the ListBox widget. - * @param {boolean} Refreshes both the datasource and the dimensions of the ListBox widget when the parameter is passed as true, otherwise only the ListBox dimensions will be refreshed. - * @returns {void} - */ + * @param {boolean} Refreshes both the datasource and the dimensions of the ListBox widget when the parameter is passed as true, otherwise only the ListBox dimensions will be refreshed. + * @returns {void} + */ refresh(refreshData: boolean): void; /** Removes all the list items from listbox. - * @returns {void} - */ + * @returns {void} + */ removeAll(): void; /** Removes the selected list items from the listbox. - * @returns {void} - */ + * @returns {void} + */ removeSelectedItems(): void; /** Removes a list item by using its text. - * @param {string} Text of the listbox item to be removed. - * @returns {void} - */ + * @param {string} Text of the listbox item to be removed. + * @returns {void} + */ removeItemByText(text: string): void; /** Removes a list item by using its index value. - * @param {number} Index of the listbox item to be removed. - * @returns {void} - */ + * @param {number} Index of the listbox item to be removed. + * @returns {void} + */ removeItemByIndex(index: number): void; /** - * @returns {void} - */ + * @returns {void} + */ selectAll(): void; /** Selects the list item using its text value. - * @param {string} Text of the listbox item to be selected. - * @returns {void} - */ + * @param {string} Text of the listbox item to be selected. + * @returns {void} + */ selectItemByText(text: string): void; /** Selects list item using its value property. - * @param {string} Value of the listbox item to be selected. - * @returns {void} - */ + * @param {string} Value of the listbox item to be selected. + * @returns {void} + */ selectItemByValue(value: string): void; /** Selects list item using its index value. - * @param {number} Index of the listbox item to be selected. - * @returns {void} - */ + * @param {number} Index of the listbox item to be selected. + * @returns {void} + */ selectItemByIndex(index: number): void; /** Selects a set of list items through its index values. - * @param {number|number[]} Index/Indices of the listbox item to be selected. - * @returns {void} - */ + * @param {number|number[]} Index/Indices of the listbox item to be selected. + * @returns {void} + */ selectItemsByIndices(Indices: number|number[]): void; /** Unchecks all the checked list items in the ListBox widget. To use this method showCheckbox property to be set as true. - * @returns {void} - */ + * @returns {void} + */ uncheckAll(): void; /** Unchecks a checked list item using its index value. To use this method showCheckbox property to be set as true. - * @param {number} Index of the listbox item to be unchecked. - * @returns {void} - */ + * @param {number} Index of the listbox item to be unchecked. + * @returns {void} + */ uncheckItemByIndex(index: number): void; /** Unchecks the set of checked list items using its index values. To use this method showCheckbox property must be set to true. - * @param {number[]|string} Indices of the listbox item to be unchecked. - * @returns {void} - */ + * @param {number[]|string} Indices of the listbox item to be unchecked. + * @returns {void} + */ uncheckItemsByIndices(indices: number[]|string): void; /** - * @returns {void} - */ + * @returns {void} + */ unselectAll(): void; /** Unselects a selected list item using its index value - * @param {number} Index of the listbox item to be unselected. - * @returns {void} - */ + * @param {number} Index of the listbox item to be unselected. + * @returns {void} + */ unselectItemByIndex(index: number): void; /** Unselects a selected list item using its text value. - * @param {string} Text of the listbox item to be unselected. - * @returns {void} - */ + * @param {string} Text of the listbox item to be unselected. + * @returns {void} + */ unselectItemByText(text: string): void; /** Unselects a selected list item using its value. - * @param {string} Value of the listbox item to be unselected. - * @returns {void} - */ + * @param {string} Value of the listbox item to be unselected. + * @returns {void} + */ unselectItemByValue(value: string): void; /** Unselects a set of list items using its index values. - * @param {number[]|string} Indices of the listbox item to be unselected. - * @returns {void} - */ + * @param {number[]|string} Indices of the listbox item to be unselected. + * @returns {void} + */ unselectItemsByIndices(indices: number[]|string): void; /** Hides all the checked items in the listbox. - * @returns {void} - */ + * @returns {void} + */ hideCheckedItems(): void; /** Shows a set of hidden list Items using its index values. - * @param {number[]|string} Indices of the listbox items to be shown. - * @returns {void} - */ + * @param {number[]|string} Indices of the listbox items to be shown. + * @returns {void} + */ showItemByIndices(indices: number[]|string): void; /** Hides a set of list Items using its index values. - * @param {number[]|string} Indices of the listbox items to be hidden. - * @returns {void} - */ + * @param {number[]|string} Indices of the listbox items to be hidden. + * @returns {void} + */ hideItemsByIndices(indices: number[]|string): void; /** Shows the hidden list items using its values. - * @param {Array} Values of the listbox items to be shown. - * @returns {void} - */ + * @param {Array} Values of the listbox items to be shown. + * @returns {void} + */ showItemsByValues(values: any[]): void; /** Hides the list item using its values. - * @param {Array} Values of the listbox items to be hidden. - * @returns {void} - */ + * @param {Array} Values of the listbox items to be hidden. + * @returns {void} + */ hideItemsByValues(values: any[]): void; /** Shows a hidden list item using its value. - * @param {string} Value of the listbox item to be shown. - * @returns {void} - */ + * @param {string} Value of the listbox item to be shown. + * @returns {void} + */ showItemByValue(value: string): void; /** Hide a list item using its value. - * @param {string} Value of the listbox item to be hidden. - * @returns {void} - */ + * @param {string} Value of the listbox item to be hidden. + * @returns {void} + */ hideItemByValue(value: string): void; /** Shows a hidden list item using its index value. - * @param {number} Index of the listbox item to be shown. - * @returns {void} - */ + * @param {number} Index of the listbox item to be shown. + * @returns {void} + */ showItemByIndex(index: number): void; /** Hides a list item using its index value. - * @param {number} Index of the listbox item to be hidden. - * @returns {void} - */ + * @param {number} Index of the listbox item to be hidden. + * @returns {void} + */ hideItemByIndex(index: number): void; /** - * @returns {void} - */ + * @returns {void} + */ show(): void; /** Hides the listbox. - * @returns {void} - */ + * @returns {void} + */ hide(): void; /** Hides all the listbox items in the listbox. - * @returns {void} - */ + * @returns {void} + */ hideAllItems(): void; /** Shows all the listbox items in the listbox. - * @returns {void} - */ + * @returns {void} + */ showAllItems(): void; } export namespace ListBox { @@ -3117,157 +3117,157 @@ export namespace ListBox { export interface Model { /** Enables/disables the dragging behavior of the items in ListBox widget. - * @Default {false} - */ + * @Default {false} + */ allowDrag?: boolean; /** Accepts the items which are dropped in to it, when it is set to true. - * @Default {false} - */ + * @Default {false} + */ allowDrop?: boolean; /** Enables or disables multiple selection. - * @Default {false} - */ + * @Default {false} + */ allowMultiSelection?: boolean; /** Loads the list data on demand via scrolling behavior to improve the applicationĂ¢â‚¬â„¢s performance. There are two ways to load data which can be defined using Ă¢â‚¬Å“virtualScrollModeĂ¢â‚¬Â property. - * @Default {false} - */ + * @Default {false} + */ allowVirtualScrolling?: boolean; /** Enables or disables the case sensitive search for list item by typing the text (search) value. - * @Default {false} - */ + * @Default {false} + */ caseSensitiveSearch?: boolean; /** Dynamically populate data of a list box while selecting an item in another list box i.e. - * rendering child list box based on the item selection in parent list box. - * This property accepts the id of the child ListBox widget to populate the data. - * @Default {null} - */ + * rendering child list box based on the item selection in parent list box. + * This property accepts the id of the child ListBox widget to populate the data. + * @Default {null} + */ cascadeTo?: string; /** Set of list items to be checked by default using its index. It works only when the showCheckbox property is set to true. - * @Default {null} - */ + * @Default {null} + */ checkedIndices?: any[]; /** The root class for the ListBox widget to customize the existing theme. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ cssClass?: string; /** Contains the list of data for generating the list items. - * @Default {null} - */ + * @Default {null} + */ dataSource?: any; /** Enables or disables the ListBox widget. - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Enables or disables the search behavior to find the specific list item by typing the text value. - * @Default {false} - */ + * @Default {false} + */ enableIncrementalSearch?: boolean; /** Allows the current model values to be saved in local storage or browser cookies for state maintenance when it is set to true. - * @Default {false} - */ + * @Default {false} + */ enablePersistence?: boolean; /** Displays the ListBox widgetĂ¢â‚¬â„¢s content from right to left when enabled. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Specifies ellipsis ("...") representation in an overflowed list item content when it is set to false. - * @Default {true} - */ + * @Default {true} + */ enableWordWrap?: boolean; /** Mapping fields for the data items of the ListBox widget. - * @Default {null} - */ + * @Default {null} + */ fields?: Fields; /** Defines the height of the ListBox widget. - * @Default {null} - */ + * @Default {null} + */ height?: string; /** Defines the height for individual ListBox item. - * @Default {null} - */ + * @Default {null} + */ itemHeight?: string; /** The number of list items to be shown in the ListBox widget. The remaining list items will be scrollable. - * @Default {null} - */ + * @Default {null} + */ itemsCount?: number; /** The total number of list items to be rendered in the ListBox widget. - * @Default {null} - */ + * @Default {null} + */ totalItemsCount?: number; /** The number of list items to be loaded in the list box while enabling virtual scrolling and when virtualScrollMode is set to continuous. - * @Default {5} - */ + * @Default {5} + */ itemRequestCount?: number; /** Loads data for the listbox by default (i.e. on initialization) when it is set to true. It creates empty ListBox if it is set to false. - */ + */ loadDataOnInit?: boolean; /** The query to retrieve required data from the data source. - * @Default {ej.Query()} - */ + * @Default {ej.Query()} + */ query?: ej.Query; /** The list item to be selected by default using its index. - * @Default {null} - */ + * @Default {null} + */ selectedIndex?: number; /** The list items to be selected by default using its indices. To use this property allowMultiSelection should be enabled. - * @Default {[]} - */ + * @Default {[]} + */ selectedIndices?: any[]; /** Enables/Disables the multi selection option with the help of checkbox control. - * @Default {false} - */ + * @Default {false} + */ showCheckbox?: boolean; /** To display the ListBox container with rounded corners. - * @Default {false} - */ + * @Default {false} + */ showRoundedCorner?: boolean; /** The template to display the ListBox widget with customized appearance. - * @Default {null} - */ + * @Default {null} + */ template?: string; /** Holds the selected items values and used to bind value to the list item using AngularJS and KnockoutJS. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ value?: number; /** Specifies the virtual scroll mode to load the list data on demand via scrolling behavior. There are two types of mode. - */ + */ virtualScrollMode?: ej.VirtualScrollMode|string; /** Defines the width of the ListBox widget. - * @Default {null} - */ + * @Default {null} + */ width?: string; /** Specifies the targetID for the listbox items. - */ + */ targetID?: string; /** Triggers before the AJAX request begins to load data in the ListBox widget. */ @@ -3324,523 +3324,523 @@ export interface Model { export interface ActionBeginEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface ActionSuccessEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface ActionCompleteEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface ActionFailureEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface ActionBeforeSuccessEventArgs { /** Instance of the listbox model object. - */ + */ model?: ej.ListBox.Model; /** Name of the event. - */ + */ type?: string; /** List of actual object. - */ + */ actual?: any; /** Object of ListBox widget which contains DataManager arguments - */ + */ request?: any; /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** List of array object - */ + */ result?: any[]; /** ExecuteQuery object of DataManager - */ + */ xhr?: any; } export interface ChangeEventArgs { /** Instance of the listbox model object. - */ + */ model?: ej.ListBox.Model; /** Name of the event. - */ + */ type?: string; /** List item object. - */ + */ item?: any; /** The Datasource of the listbox. - */ + */ data?: any; /** List itemĂ¢â‚¬â„¢s index. - */ + */ index?: number; /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Boolean value based on whether the list item is checked or not. - */ + */ isChecked?: boolean; /** Boolean value based on whether the list item is selected or not. - */ + */ isSelected?: boolean; /** Boolean value based on the list item is enabled or not. - */ + */ isEnabled?: boolean; /** List itemĂ¢â‚¬â„¢s text (label). - */ + */ text?: string; /** List itemĂ¢â‚¬â„¢s value. - */ + */ value?: string; } export interface CheckChangeEventArgs { /** Instance of the listbox model object. - */ + */ model?: ej.ListBox.Model; /** Name of the event. - */ + */ type?: string; /** List item object. - */ + */ item?: any; /** The Datasource of the listbox. - */ + */ data?: any; /** List itemĂ¢â‚¬â„¢s index. - */ + */ index?: number; /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Boolean value based on whether the list item is checked or not. - */ + */ isChecked?: boolean; /** Boolean value based on whether the list item is selected or not. - */ + */ isSelected?: boolean; /** Boolean value based on the list item is enabled or not. - */ + */ isEnabled?: boolean; /** List itemĂ¢â‚¬â„¢s text (label). - */ + */ text?: string; /** List itemĂ¢â‚¬â„¢s value. - */ + */ value?: string; } export interface CreateEventArgs { /** Instance of the listbox model object. - */ + */ model?: ej.ListBox.Model; /** Name of the event. - */ + */ type?: string; /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; } export interface DestroyEventArgs { /** Instance of the listbox model object. - */ + */ model?: ej.ListBox.Model; /** Name of the event. - */ + */ type?: string; /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; } export interface FocusInEventArgs { /** Instance of the listbox model object. - */ + */ model?: ej.ListBox.Model; /** Name of the event. - */ + */ type?: string; /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; } export interface FocusOutEventArgs { /** Instance of the listbox model object. - */ + */ model?: ej.ListBox.Model; /** Name of the event. - */ + */ type?: string; /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; } export interface ItemDragEventArgs { /** Instance of the listbox model object. - */ + */ model?: ej.ListBox.Model; /** Name of the event. - */ + */ type?: string; /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** The Datasource of the listbox. - */ + */ data?: any; /** List itemĂ¢â‚¬â„¢s index. - */ + */ index?: number; /** Boolean value based on whether the list item is checked or not. - */ + */ isChecked?: boolean; /** Boolean value based on whether the list item is selected or not. - */ + */ isSelected?: boolean; /** Boolean value based on whether the list item is enabled or not. - */ + */ isEnabled?: boolean; /** List itemĂ¢â‚¬â„¢s text (label). - */ + */ text?: string; /** List itemĂ¢â‚¬â„¢s value. - */ + */ value?: string; } export interface ItemDragStartEventArgs { /** Instance of the listbox model object. - */ + */ model?: ej.ListBox.Model; /** Name of the event. - */ + */ type?: string; /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** The Datasource of the listbox. - */ + */ data?: any; /** List itemĂ¢â‚¬â„¢s index. - */ + */ index?: number; /** Boolean value based on whether the list item is checked or not. - */ + */ isChecked?: boolean; /** Boolean value based on whether the list item is selected or not. - */ + */ isSelected?: boolean; /** Boolean value based on whether the list item is enabled or not. - */ + */ isEnabled?: boolean; /** List itemĂ¢â‚¬â„¢s text (label). - */ + */ text?: string; /** List itemĂ¢â‚¬â„¢s value. - */ + */ value?: string; } export interface ItemDragStopEventArgs { /** Instance of the listbox model object. - */ + */ model?: ej.ListBox.Model; /** Name of the event. - */ + */ type?: string; /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** The Datasource of the listbox. - */ + */ data?: any; /** List itemĂ¢â‚¬â„¢s index. - */ + */ index?: number; /** Boolean value based on whether the list item is checked or not. - */ + */ isChecked?: boolean; /** Boolean value based on whether the list item is selected or not. - */ + */ isSelected?: boolean; /** Boolean value based on whether the list item is enabled or not. - */ + */ isEnabled?: boolean; /** List itemĂ¢â‚¬â„¢s text (label). - */ + */ text?: string; /** List itemĂ¢â‚¬â„¢s value. - */ + */ value?: string; } export interface ItemDropEventArgs { /** Instance of the listbox model object. - */ + */ model?: ej.ListBox.Model; /** Name of the event. - */ + */ type?: string; /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** The Datasource of the listbox. - */ + */ data?: any; /** List itemĂ¢â‚¬â„¢s index. - */ + */ index?: number; /** Boolean value based on whether the list item is checked or not. - */ + */ isChecked?: boolean; /** Boolean value based on whether the list item is selected or not. - */ + */ isSelected?: boolean; /** Boolean value based on whether the list item is enabled or not. - */ + */ isEnabled?: boolean; /** List itemĂ¢â‚¬â„¢s text (label). - */ + */ text?: string; /** List itemĂ¢â‚¬â„¢s value. - */ + */ value?: string; } export interface SelectEventArgs { /** Instance of the listbox model object. - */ + */ model?: ej.ListBox.Model; /** Name of the event. - */ + */ type?: string; /** List item object. - */ + */ item?: any; /** The Datasource of the listbox. - */ + */ data?: any; /** List itemĂ¢â‚¬â„¢s index. - */ + */ index?: number; /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Boolean value based on whether the list item is checked or not. - */ + */ isChecked?: boolean; /** Boolean value based on whether the list item is selected or not. - */ + */ isSelected?: boolean; /** Boolean value based on the list item is enabled or not. - */ + */ isEnabled?: boolean; /** List itemĂ¢â‚¬â„¢s text (label). - */ + */ text?: string; /** List itemĂ¢â‚¬â„¢s value. - */ + */ value?: string; } export interface UnselectEventArgs { /** Instance of the listbox model object. - */ + */ model?: ej.ListBox.Model; /** Name of the event. - */ + */ type?: string; /** List item object. - */ + */ item?: any; /** The Datasource of the listbox. - */ + */ data?: any; /** List itemĂ¢â‚¬â„¢s index. - */ + */ index?: number; /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Boolean value based on whether the list item is checked or not. - */ + */ isChecked?: boolean; /** Boolean value based on whether the list item is selected or not. - */ + */ isSelected?: boolean; /** Boolean value based on the list item is enabled or not. - */ + */ isEnabled?: boolean; /** List itemĂ¢â‚¬â„¢s text (label). - */ + */ text?: string; /** List itemĂ¢â‚¬â„¢s value. - */ + */ value?: string; } export interface Fields { /** Defines the specific field name which contains Boolean values to specify whether the list items to be checked by default or not. - */ + */ checkBy?: boolean; /** The grouping in the ListBox widget can be defined using this field. - */ + */ groupBy?: string; /** Defines the HTML attributes such as id, class, styles for the specific ListBox item. - */ + */ htmlAttributes?: any; /** Defines the specific field name which contains id values for the list items. - */ + */ id?: string; /** Defines the imageURL for the image to be displayed in the ListBox item. - */ + */ imageUrl?: string; /** Defines the image attributes such as height, width, styles and so on. - */ + */ imageAttributes?: string; /** Defines the specific field name which contains Boolean values to specify whether the list items to be selected by default or not. - */ + */ selectBy?: boolean; /** Defines the sprite CSS class for the image to be displayed. - */ + */ spriteCssClass?: string; /** Defines the table name to get the specific set of list items to be loaded in the ListBox widget while rendering with remote data. - */ + */ tableName?: string; /** Defines the specific field name in the data source to load the list with data. - */ + */ text?: string; /** Defines the specific field name in the data source to load the list with data value property. - */ + */ value?: string; } } @@ -3853,59 +3853,59 @@ class Calculate { defaults: Calculate.Model; /** Add the custom formulas with function in CalcEngine library - * @param {string} pass the formula name - * @param {string} pass the custom function name to call - * @returns {void} - */ + * @param {string} pass the formula name + * @param {string} pass the custom function name to call + * @returns {void} + */ addCustomFunction(FormulaName: string, FunctionName: string): void; /** Adds a named range to the NamedRanges collection - * @param {string} pass the namedRange's name - * @param {string} pass the cell range of NamedRange - * @returns {void} - */ + * @param {string} pass the namedRange's name + * @param {string} pass the cell range of NamedRange + * @returns {void} + */ addNamedRange(Name: string, cellRange: string): void; /** Accepts a possible parsed formula and returns the calculated value without quotes. - * @param {string} pass the cell range to adjust its range - * @returns {string} - */ + * @param {string} pass the cell range to adjust its range + * @returns {string} + */ adjustRangeArg(Name: string): string; /** When a formula cell changes, call this method to clear it from its dependent cells. - * @param {string} pass the changed cell address - * @returns {void} - */ + * @param {string} pass the changed cell address + * @returns {void} + */ clearFormulaDependentCells(Cell: string): void; /** Call this method to clear whether an exception was raised during the computation of a library function. - * @returns {void} - */ + * @returns {void} + */ clearLibraryComputationException(): void; /** Get the column index from a cell reference passed in. - * @param {string} pass the cell address - * @returns {void} - */ + * @param {string} pass the cell address + * @returns {void} + */ colIndex(Cell: string): void; /** Evaluates a parsed formula. - * @param {string} pass the parsed formula - * @returns {string} - */ + * @param {string} pass the parsed formula + * @returns {string} + */ computedValue(Formula: string): string; /** Evaluates a parsed formula. - * @param {string} pass the parsed formula - * @returns {string} - */ + * @param {string} pass the parsed formula + * @returns {string} + */ computeFormula(Formula: string): string; } export namespace Calculate { export interface Model { /** Returns the cancel option value. - */ + */ cancel?: boolean; } } @@ -3918,23 +3918,23 @@ class CheckBox extends ej.Widget { defaults: CheckBox.Model; /** Destroy the CheckBox widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. - * @returns {void} - */ + * @returns {void} + */ destroy(): void; /** Disable the CheckBox to prevent all user interactions. - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** To enable the CheckBox - * @returns {void} - */ + * @returns {void} + */ enable(): void; /** To Check the status of CheckBox - * @returns {boolean} - */ + * @returns {boolean} + */ isChecked(): boolean; } export namespace CheckBox { @@ -3942,92 +3942,92 @@ export namespace CheckBox { export interface Model { /** Specifies whether CheckBox has to be in checked or not. - * We can also specify array of string as value for this property. - * If any of the value in the specified array matches the value of the textbox, - * then it will be considered as checked. It will be useful in MVVM binding, - * specify array type to identify the values of the checked CheckBoxes. - * @Default {false} - */ + * We can also specify array of string as value for this property. + * If any of the value in the specified array matches the value of the textbox, + * then it will be considered as checked. It will be useful in MVVM binding, + * specify array type to identify the values of the checked CheckBoxes. + * @Default {false} + */ checked?: boolean|string[]; /** Specifies the State of CheckBox.See below to get available CheckState - * @Default {null} - */ + * @Default {null} + */ checkState?: ej.CheckState|string; /** Sets the root CSS class for CheckBox theme, which is used customize. - */ + */ cssClass?: string; /** Specifies the checkbox control state. - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Specifies the persist property for CheckBox while initialization. - * The persist API save current model value to browser cookies for state maintains. - * While refreshing the CheckBox control page the model value apply from browser cookies. - * @Default {false} - */ + * The persist API save current model value to browser cookies for state maintains. + * While refreshing the CheckBox control page the model value apply from browser cookies. + * @Default {false} + */ enablePersistence?: boolean; /** Specify the Right to Left direction to Checkbox - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Specifies the enable or disable Tri-State for checkbox control. - * @Default {false} - */ + * @Default {false} + */ enableTriState?: boolean; /** It allows to define the characteristics of the CheckBox control. It will helps to extend the capability of an HTML element. - * @Default {{}} - */ + * @Default {{}} + */ htmlAttributes?: any; /** Specified value to be added an id attribute of the CheckBox. - * @Default {null} - */ + * @Default {null} + */ id?: string; /** Specify the prefix value of id to be added before the current id of the CheckBox. - * @Default {ej} - */ + * @Default {ej} + */ idPrefix?: string; /** Specifies the name attribute of the CheckBox. - * @Default {null} - */ + * @Default {null} + */ name?: string; /** Displays rounded corner borders to CheckBox - * @Default {false} - */ + * @Default {false} + */ showRoundedCorner?: boolean; /** Specifies the size of the CheckBox.See below to know available CheckboxSize - * @Default {small} - */ + * @Default {small} + */ size?: ej.CheckboxSize|string; /** Specifies the text content to be displayed for CheckBox. - */ + */ text?: string; /** Set the jQuery validation error message in CheckBox. - * @Default {null} - */ + * @Default {null} + */ validationMessage?: any; /** Set the jQuery validation rules in CheckBox. - * @Default {null} - */ + * @Default {null} + */ validationRules?: any; /** Specifies the value attribute of the CheckBox. - * @Default {null} - */ + * @Default {null} + */ value?: string; /** Fires before the CheckBox is going to changed its state successfully */ @@ -4046,80 +4046,80 @@ export interface Model { export interface BeforeChangeEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the CheckBox model - */ + */ model?: ej.CheckBox.Model; /** returns the name of the event - */ + */ type?: string; /** returns the event model values - */ + */ event?: any; /** returns the status whether the element is checked or not. - */ + */ isChecked?: boolean; } export interface ChangeEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the CheckBox model - */ + */ model?: ej.CheckBox.Model; /** returns the name of the event - */ + */ type?: string; /** returns the event arguments - */ + */ event?: any; /** returns the status whether the element is checked or not. - */ + */ isChecked?: boolean; /** returns the state of the checkbox - */ + */ checkState?: string; } export interface CreateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the CheckBox model - */ + */ model?: ej.CheckBox.Model; /** returns the name of the event - */ + */ type?: string; } export interface DestroyEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the CheckBox model - */ + */ model?: ej.CheckBox.Model; /** returns the name of the event - */ + */ type?: string; } } @@ -4146,57 +4146,57 @@ class ColorPicker extends ej.Widget { defaults: ColorPicker.Model; /** Disables the color picker control - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** Enable the color picker control - * @returns {void} - */ + * @returns {void} + */ enable(): void; /** Gets the selected color in RGB format - * @returns {any} - */ + * @returns {any} + */ getColor(): any; /** Gets the selected color value as string - * @returns {string} - */ + * @returns {string} + */ getValue(): string; /** To Convert color value from hexCode to RGB - * @param {string} Specified HEX code converted to RGB - * @returns {any} - */ + * @param {string} Specified HEX code converted to RGB + * @returns {any} + */ hexCodeToRGB(colorCode: string): any; /** Hides the ColorPicker popup, if in opened state. - * @returns {void} - */ + * @returns {void} + */ hide(): void; /** Convert color value from HSV to RGB - * @param {any} Specified HSV code converted to RGB - * @returns {any} - */ + * @param {any} Specified HSV code converted to RGB + * @returns {any} + */ HSVToRGB(HSV: any): any; /** Convert color value from RGB to HEX - * @param {any} Specified RGB code converted to HEX code - * @returns {string} - */ + * @param {any} Specified RGB code converted to HEX code + * @returns {string} + */ RGBToHEX(RGB: any): string; /** Convert color value from RGB to HSV - * @param {any} Specified RGB code converted to HSV code - * @returns {any} - */ + * @param {any} Specified RGB code converted to HSV code + * @returns {any} + */ RGBToHSV(RGB: any): any; /** Open the ColorPicker popup. - * @returns {void} - */ + * @returns {void} + */ show(): void; } export namespace ColorPicker { @@ -4204,121 +4204,121 @@ export namespace ColorPicker { export interface Model { /** The ColorPicker control allows to define the customized text to displayed in button elements. Using the property to achieve the customized culture values. - * @Default {{ apply: Apply, cancel: Cancel, swatches: Swatches }} - */ + * @Default {{ apply: Apply, cancel: Cancel, swatches: Swatches }} + */ buttonText?: ButtonText; /** Allows to change the mode of the button. Please refer below to know available button mode - * @Default {ej.ButtonMode.Split} - */ + * @Default {ej.ButtonMode.Split} + */ buttonMode?: ej.ButtonMode|string; /** Specifies the number of columns to be displayed color palette model. - * @Default {10} - */ + * @Default {10} + */ columns?: number|string; /** This property allows you to customize its appearance using user-defined CSS and custom skin options such as colors and backgrounds. - */ + */ cssClass?: string; /** This property allows to define the custom colors in the palette model.Custom palettes are created by passing a comma delimited string of HEX values or an array of colors. - * @Default {empty} - */ + * @Default {empty} + */ custom?: any[]; /** This property allows to embed the popup in the order of DOM element flow . When we set the value as true, the color picker popup is always in visible state. - * @Default {false} - */ + * @Default {false} + */ displayInline?: boolean; /** This property allows to change the control in enabled or disabled state. - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** This property allows to enable or disable the opacity slider in the color picker control - * @Default {true} - */ + * @Default {true} + */ enableOpacity?: boolean; /** It allows to define the characteristics of the ColorPicker control. It will helps to extend the capability of an HTML element. - * @Default {{}} - */ + * @Default {{}} + */ htmlAttributes?: any; /** Defines the localized text values in button and tooltip. - * @Default {en-US} - */ + * @Default {en-US} + */ locale?: string; /** Specifies the model type to be rendered initially in the color picker control. See below to get available ModelType - * @Default {ej.ColorPicker.ModelType.Default} - */ + * @Default {ej.ColorPicker.ModelType.Default} + */ modelType?: ej.ColorPicker.ModelType|string; /** This property allows to change the opacity value .The selected color opacity will be adjusted by using this opacity value. - * @Default {100} - */ + * @Default {100} + */ opacityValue?: number|string; /** Specifies the palette type to be displayed at initial time in palette model.There two types of palette model available in ColorPicker control. See below available Palette - * @Default {ej.ColorPicker.Palette.BasicPalette} - */ + * @Default {ej.ColorPicker.Palette.BasicPalette} + */ palette?: ej.ColorPicker.Palette|string; /** This property allows to define the preset model to be rendered initially in palette type.It consists of 12 different types of presets. Each presets have 50 colors. - * See below available Presets - * @Default {ej.ColorPicker.Presets.Basic} - */ + * See below available Presets + * @Default {ej.ColorPicker.Presets.Basic} + */ presetType?: ej.ColorPicker.Presets|string; /** Allows to show/hides the apply and cancel buttons in ColorPicker control - * @Default {true} - */ + * @Default {true} + */ showApplyCancel?: boolean; /** Allows to show/hides the clear button in ColorPicker control - * @Default {true} - */ + * @Default {true} + */ showClearButton?: boolean; /** This property allows to provides live preview support for current cursor selection color and selected color. - * @Default {true} - */ + * @Default {true} + */ showPreview?: boolean; /** This property allows to store the color values in custom list.The ColorPicker will keep up to 11 colors in a custom list. - * By clicking the add button, the selected color from picker or palette will get added in the recent color list. - * @Default {false} - */ + * By clicking the add button, the selected color from picker or palette will get added in the recent color list. + * @Default {false} + */ showRecentColors?: boolean; /** Allows to show/hides the switcher button in ColorPicker control.It helps to switch palette or picker mode in colorpicker. - * @Default {true} - */ + * @Default {true} + */ showSwitcher?: boolean; /** This property allows to shows tooltip to notify the slider value in color picker control. - * @Default {false} - */ + * @Default {false} + */ showTooltip?: boolean; /** Specifies the toolIcon to be displayed in dropdown control color area. - * @Default {null} - */ + * @Default {null} + */ toolIcon?: string; - /** This property allows to define the customized text or content to displayed when mouse over the following elements. This property also allows to use the culture values. - * @Default {{ switcher: Switcher, addbutton: Add Color, basic: Basic, monochrome: Mono Chrome, flatcolors: Flat Color, seawolf: Sea Wolf, webcolors: Web Colors, - * sandy: Sandy, pinkshades: Pink Shades, misty: Misty, citrus: Citrus, vintage: Vintage, moonlight: Moon Light, candycrush: Candy Crush, - * currentcolor: Current Color, selectedcolor: Selected Color }} - */ + /** This property allows to define the customized text or content to displayed when mouse over the following elements. This property also allows to use the culture values. + * @Default {{ switcher: Switcher, addbutton: Add Color, basic: Basic, monochrome: Mono Chrome, flatcolors: Flat Color, seawolf: Sea Wolf, webcolors: Web Colors, + * sandy: Sandy, pinkshades: Pink Shades, misty: Misty, citrus: Citrus, vintage: Vintage, moonlight: Moon Light, candycrush: Candy Crush, + * currentcolor: Current Color, selectedcolor: Selected Color }} + */ tooltipText?: TooltipText; /** Specifies the color value for color picker control, the value is in hexadecimal form with prefix of "#". - * @Default {null} - */ + * @Default {null} + */ value?: string; /** Fires after Color value has been changed successfully.If the user want to perform any operation after the color value changed then the user can make use of this change event. */ @@ -4343,180 +4343,180 @@ export interface Model { export interface ChangeEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the color picker model - */ + */ model?: ej.ColorPicker.Model; /** returns the name of the event - */ + */ type?: string; /** return the changed color value - */ + */ value?: string; } export interface CloseEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the color picker model - */ + */ model?: ej.ColorPicker.Model; /** returns the name of the event - */ + */ type?: string; } export interface CreateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the color picker model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface DestroyEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the color picker model - */ + */ model?: ej.ColorPicker.Model; /** returns the name of the event - */ + */ type?: string; } export interface OpenEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the color picker model - */ + */ model?: ej.ColorPicker.Model; /** returns the name of the event - */ + */ type?: string; } export interface SelectEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the color picker model - */ + */ model?: ej.ColorPicker.Model; /** returns the name of the event - */ + */ type?: string; /** return the selected color value - */ + */ value?: string; } export interface ButtonText { /** Sets the text for the apply button. - */ + */ apply?: string; /** Sets the text for the cancel button. - */ + */ cancel?: string; /** Sets the header text for the swatches area. - */ + */ swatches?: string; } export interface TooltipText { /** Sets the tooltip text for the switcher button. - */ + */ switcher?: string; /** Sets the tooltip text for the add button. - */ + */ addbutton?: string; /** Sets the tooltip text for the basic preset. - */ + */ basic?: string; /** Sets the tooltip text for the mono chrome preset. - */ + */ monochrome?: string; /** Sets the tooltip text for the flat colors preset. - */ + */ flatcolors?: string; /** Sets the tooltip text for the sea wolf preset. - */ + */ seawolf?: string; /** Sets the tooltip text for the web colors preset. - */ + */ webcolors?: string; /** Sets the tooltip text for the sandy preset. - */ + */ sandy?: string; /** Sets the tooltip text for the pink shades preset. - */ + */ pinkshades?: string; /** Sets the tooltip text for the misty preset. - */ + */ misty?: string; /** Sets the tooltip text for the citrus preset. - */ + */ citrus?: string; /** Sets the tooltip text for the vintage preset. - */ + */ vintage?: string; /** Sets the tooltip text for the moon light preset. - */ + */ moonlight?: string; /** Sets the tooltip text for the candy crush preset. - */ + */ candycrush?: string; /** Sets the tooltip text for the current color area. - */ + */ currentcolor?: string; /** Sets the tooltip text for the selected color area. - */ + */ selectedcolor?: string; } @@ -4592,43 +4592,43 @@ class FileExplorer extends ej.Widget { defaults: FileExplorer.Model; /** Refresh the size of FileExplorer control. - * @returns {void} - */ + * @returns {void} + */ adjustSize(): void; /** Disable the particular context menu item. - * @param {string|HTMLElement} Id of the menu item/ Menu element to be disabled - * @returns {void} - */ + * @param {string|HTMLElement} Id of the menu item/ Menu element to be disabled + * @returns {void} + */ disableMenuItem(item: string|HTMLElement): void; /** Disable the particular toolbar item. - * @param {string|HTMLElement} Id of the toolbar item/ Tool item element to be disabled - * @returns {void} - */ + * @param {string|HTMLElement} Id of the toolbar item/ Tool item element to be disabled + * @returns {void} + */ disableToolbarItem(item: string|HTMLElement): void; /** Enable the particular context menu item. - * @param {string|HTMLElement} Id of the menu item/ Menu element to be Enabled - * @returns {void} - */ + * @param {string|HTMLElement} Id of the menu item/ Menu element to be Enabled + * @returns {void} + */ enableMenuItem(item: string|HTMLElement): void; /** Enable the particular toolbar item - * @param {string|HTMLElement} Id of the tool item/ Tool item element to be Enabled - * @returns {void} - */ + * @param {string|HTMLElement} Id of the tool item/ Tool item element to be Enabled + * @returns {void} + */ enableToolbarItem(item: string|HTMLElement): void; /** Refresh the content of the selected folder in FileExplorer control. - * @returns {void} - */ + * @returns {void} + */ refresh(): void; /** Remove the particular toolbar item. - * @param {string|HTMLElement} Id of the tool item/ tool item element to be removed - * @returns {void} - */ + * @param {string|HTMLElement} Id of the tool item/ tool item element to be removed + * @returns {void} + */ removeToolbarItem(item: string|HTMLElement): void; } export namespace FileExplorer { @@ -4636,185 +4636,185 @@ export namespace FileExplorer { export interface Model { /** Sets the URL of server side AJAX handling method that handles file operation like Read, Remove, Rename, Create, Upload, Download, Copy and Move in FileExplorer. - */ + */ ajaxAction?: string; /** Specifies the data type of server side AJAX handling method. - * @Default {json} - */ + * @Default {json} + */ ajaxDataType?: string; /** By using ajaxSettings property, you can customize the AJAX configurations. Normally you can customize the following option in AJAX handling data, URL, type, async, contentType, dataType and - * success. For upload, download and getImage API, you can only customize URL. - * @Default {{ read: {}, createFolder: {}, remove: {}, rename: {}, paste: {}, getDetails: {}, download: {}, upload: {}, getImage: {}, search: {}}} - */ + * success. For upload, download and getImage API, you can only customize URL. + * @Default {{ read: {}, createFolder: {}, remove: {}, rename: {}, paste: {}, getDetails: {}, download: {}, upload: {}, getImage: {}, search: {}}} + */ ajaxSettings?: any; /** The FileExplorer allows to move the files from one folder to another folder of FileExplorer by using drag and drop option. Also it supports to upload a file by dragging it - * from windows explorer to the necessary folder of ejFileExplorer. - * @Default {true} - */ + * from windows explorer to the necessary folder of ejFileExplorer. + * @Default {true} + */ allowDragAndDrop?: boolean; /** Gets or sets a value that indicates whether to enable keyboard support for FileExplorer actions. - * @Default {true} - */ + * @Default {true} + */ allowKeyboardNavigation?: boolean; /** The FileExplorer allows to select multiple files by enabling the allowMultiSelection property. You can perform multi selection by pressing the Ctrl key or Shift key. - * @Default {true} - */ + * @Default {true} + */ allowMultiSelection?: boolean; /** By using the contextMenuSettings property, you can customize the ContextMenu in the FileExplorer control. - */ + */ contextMenuSettings?: ContextMenuSettings; /** Sets the root class for FileExplorer theme. This cssClass API allows to use custom skinning option for File Explorer control. - * By defining the root class by using this API, you have to include this root class in CSS. - */ + * By defining the root class by using this API, you have to include this root class in CSS. + */ cssClass?: string; /** Specify the enablePersistence to FileExplorer to save the current model value in browser cookies for state maintains. - * @Default {false} - */ + * @Default {false} + */ enablePersistence?: boolean; /** Enables or disables the resize support in FileExplorer control. - * @Default {false} - */ + * @Default {false} + */ enableResize?: boolean; /** Enables or disables the Right to Left alignment support in FileExplorer control. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Enables or disables the thumbnail image compression option in FileExplorer control. By enabling this option, you can reduce the thumbnail image size while loading. - * @Default {false} - */ + * @Default {false} + */ enableThumbnailCompress?: boolean; /** Allows specified type of files only to display in FileExplorer control. - * @Default {.} - */ + * @Default {.} + */ fileTypes?: string; /** By using filterSettings property, you can customize the search functionality of the search bar in FileExplorer control. - */ + */ filterSettings?: FilterSettings; /** By using the gridSettings property, you can customize the grid behavior in the FileExplorer control. - */ + */ gridSettings?: GridSettings; /** Specifies the height of FileExplorer control. - * @Default {400} - */ + * @Default {400} + */ height?: string|number; /** Enables or disables the responsive support for FileExplorer control during the window resizing time. - * @Default {false} - */ + * @Default {false} + */ isResponsive?: boolean; /** Sets the file view type. There are three view types available such as Grid, Tile and Large icons. See layoutType. - * @Default {ej.FileExplorer.layoutType.Grid} - */ + * @Default {ej.FileExplorer.layoutType.Grid} + */ layout?: ej.FileExplorer.layoutType|string; /** Sets the culture in FileExplorer. - * @Default {en-US} - */ + * @Default {en-US} + */ locale?: string; /** Sets the maximum height of FileExplorer control. - * @Default {null} - */ + * @Default {null} + */ maxHeight?: string|number; /** Sets the maximum width of FileExplorer control. - * @Default {null} - */ + * @Default {null} + */ maxWidth?: string|number; /** Sets the minimum height of FileExplorer control. - * @Default {250px} - */ + * @Default {250px} + */ minHeight?: string|number; /** Sets the minimum width of FileExplorer control. - * @Default {400px} - */ + * @Default {400px} + */ minWidth?: string|number; /** The property path denotes the filesystem path that are to be explored. The path for the filesystem can be physical path or relative path, but it has to be relevant to where the Web API is hosted. - */ + */ path?: string; /** The selectedFolder is used to select the specified folder of FileExplorer control. - */ + */ selectedFolder?: string; /** The selectedItems is used to select the specified items (file, folder) of FileExplorer control. - */ + */ selectedItems?: string|any[]; /** Enables or disables the checkbox option in FileExplorer control. - * @Default {true} - */ + * @Default {true} + */ showCheckbox?: boolean; /** Enables or disables the context menu option in FileExplorer control. - * @Default {true} - */ + * @Default {true} + */ showContextMenu?: boolean; /** Enables or disables the footer in FileExplorer control. The footer element displays the details of the current selected files and folders. - * And also the footer having the switcher to change the layout view. - * @Default {true} - */ + * And also the footer having the switcher to change the layout view. + * @Default {true} + */ showFooter?: boolean; /** FileExplorer control is displayed with rounded corner when this property is set to true. - * @Default {false} - */ + * @Default {false} + */ showRoundedCorner?: boolean; /** FileExplorer control is rendered with thumbnail preview of images in Tile and LargeIcons layout when this property set to true. - * @Default {true} - */ + * @Default {true} + */ showThumbnail?: boolean; /** Shows or disables the toolbar in FileExplorer control. - * @Default {true} - */ + * @Default {true} + */ showToolbar?: boolean; /** Enables or disables the navigation pane in FileExplorer control. The navigation pane contains a tree view element that displays all the folders from the filesystem in a hierarchical manner. - * This is useful to a quick navigation of any folder in the filesystem. - * @Default {true} - */ + * This is useful to a quick navigation of any folder in the filesystem. + * @Default {true} + */ showNavigationPane?: boolean; - /** The tools property is used to configure and group required toolbar items in FileExplorer control. - * @Default {{ creation: [NewFolder], navigation: [Back, Forward, Upward], addressBar: [Addressbar], editing: [Refresh, Upload, Delete, Rename, Download], copyPaste: [Cut, Copy, Paste], - * getProperties: [Details], searchBar: [Searchbar], layout: [Layout], sortBy: [SortBy]}} - */ + /** The tools property is used to configure and group required toolbar items in FileExplorer control. + * @Default {{ creation: [NewFolder], navigation: [Back, Forward, Upward], addressBar: [Addressbar], editing: [Refresh, Upload, Delete, Rename, Download], copyPaste: [Cut, Copy, Paste], + * getProperties: [Details], searchBar: [Searchbar], layout: [Layout], sortBy: [SortBy]}} + */ tools?: any; /** The toolsList property is used to arrange the toolbar items in the FileExplorer control. - * @Default {[layout, creation, navigation, addressBar, editing, copyPaste, sortBy, getProperties, searchBar]} - */ + * @Default {[layout, creation, navigation, addressBar, editing, copyPaste, sortBy, getProperties, searchBar]} + */ toolsList?: any[]; /** Gets or sets an object that indicates whether to customize the upload behavior in the FileExplorer. - */ + */ uploadSettings?: UploadSettings; /** Specifies the width of FileExplorer control. - * @Default {850} - */ + * @Default {850} + */ width?: string|number; /** Fires before the AJAX request is performed. */ @@ -4824,8 +4824,8 @@ export interface Model { beforeDownload?(e: BeforeDownloadEventArgs): void; /** Fires before getting a requested image from server. Also this event will be triggered when you have enabled thumbnail image compression option in FileExplorer. - * Using this event, you can customize the image compression size. - */ + * Using this event, you can customize the image compression size. + */ beforeGetImage?(e: BeforeGetImageEventArgs): void; /** Fires before files or folders open. */ @@ -4910,860 +4910,860 @@ export interface Model { export interface BeforeAjaxRequestEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the AJAX request data - */ + */ data?: any; /** returns the FileExplorer model - */ + */ model?: ej.FileExplorer.Model; /** returns the name of the event - */ + */ type?: string; } export interface BeforeDownloadEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the downloaded file names. - */ + */ files?: string[]; /** returns the FileExplorer model. - */ + */ model?: ej.FileExplorer.Model; /** returns the path of currently opened item. - */ + */ path?: string; /** returns the selected item details. - */ + */ selectedItems?: any; /** returns the name of the event. - */ + */ type?: string; } export interface BeforeGetImageEventArgs { /** set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** enable or disable the image compress option. - */ + */ canCompress?: boolean; /** returns the FileExplorer model. - */ + */ model?: ej.FileExplorer.Model; /** returns the expected image size. - */ + */ size?: any; /** returns the selected item details. - */ + */ selectedItems?: any; /** returns the name of the event. - */ + */ type?: string; } export interface BeforeOpenEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the opened item type. - */ + */ itemType?: string; /** returns the FileExplorer model. - */ + */ model?: ej.FileExplorer.Model; /** returns the path of currently opened item. - */ + */ path?: string; /** returns the selected item details. - */ + */ selectedItems?: any; /** returns the name of the event. - */ + */ type?: string; } export interface BeforeUploadEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the FileExplorer model. - */ + */ model?: ej.FileExplorer.Model; /** returns the path of currently opened item. - */ + */ path?: string; /** returns the selected item details. - */ + */ selectedItems?: any; /** returns the upload item details. - */ + */ uploadItemDetails?: any; /** returns the name of the event. - */ + */ type?: string; } export interface CreateEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the FileExplorer model. - */ + */ model?: ej.FileExplorer.Model; /** returns the name of the event. - */ + */ type?: string; } export interface CopyEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the FileExplorer model. - */ + */ model?: ej.FileExplorer.Model; /** returns the name of copied file/folder. - */ + */ name?: string[]; /** returns the selected item details. - */ + */ selectedItems?: any; /** returns the source path. - */ + */ sourcePath?: string; /** returns the name of the event. - */ + */ type?: string; } export interface CreateFolderEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the AJAX response data - */ + */ data?: any; /** returns the FileExplorer model - */ + */ model?: ej.FileExplorer.Model; /** returns the selected item details - */ + */ selectedItems?: any; /** returns the name of the event. - */ + */ type?: string; } export interface CutEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the FileExplorer model. - */ + */ model?: ej.FileExplorer.Model; /** returns the name of moved file or folder. - */ + */ name?: string[]; /** returns the selected item details. - */ + */ selectedItems?: any; /** returns the source path. - */ + */ sourcePath?: string; /** returns the name of the event. - */ + */ type?: string; } export interface DestroyEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the FileExplorer model. - */ + */ model?: ej.FileExplorer.Model; /** returns the name of the event. - */ + */ type?: string; } export interface DragStartEventArgs { /** set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the FileExplorer model. - */ + */ model?: ej.FileExplorer.Model; /** returns the name of the event. - */ + */ type?: string; /** returns the dragging element. - */ + */ target?: any; /** returns the path of dragging element. - */ + */ targetPath?: string; /** returns the dragging file details. - */ + */ selectedItems?: any; } export interface DragEventArgs { /** set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the FileExplorer model. - */ + */ model?: ej.FileExplorer.Model; /** returns the name of the event. - */ + */ type?: string; /** returns the target element. - */ + */ target?: any; /** returns the name of target element. - */ + */ targetElementName?: string; /** returns the path of target element. - */ + */ targetPath?: string; } export interface DragStopEventArgs { /** set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the FileExplorer model. - */ + */ model?: ej.FileExplorer.Model; /** returns the name of the event. - */ + */ type?: string; /** returns the target element. - */ + */ target?: any; /** returns the path of target element. - */ + */ targetPath?: string; /** returns the name of target element - */ + */ targetElementName?: string; /** returns the action, which is performed after dropping the files (upload/ move). - */ + */ dropAction?: string; /** returns the dragging file details - */ + */ fileInfo?: any; } export interface DropEventArgs { /** set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the FileExplorer model. - */ + */ model?: ej.FileExplorer.Model; /** returns the name of the event. - */ + */ type?: string; /** returns the target element. - */ + */ target?: any; /** returns the name of target folder. - */ + */ targetFolder?: string; /** returns the path of target folder. - */ + */ targetPath?: string; /** returns the dragging element details. - */ + */ fileInfo?: any; /** returns the action, which is performed after dropping the files (upload/ move). - */ + */ dropAction?: string; } export interface GetImageEventArgs { /** set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** loaded image path. - */ + */ path?: string; /** loaded image element - */ + */ element?: any; /** returns the FileExplorer model. - */ + */ model?: ej.FileExplorer.Model; /** original arguments of image load or error event - */ + */ originalArgs?: any; /** returns the action type, which specifies thumbnail preview or opening image. - */ + */ action?: string; /** returns the name of the event. - */ + */ type?: string; } export interface KeydownEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the downed key keyCode value - */ + */ keyCode?: number; /** returns altKey value. - */ + */ altKey?: boolean; /** returns shiftKey value. - */ + */ shiftKey?: boolean; /** returns ctrlKey value. - */ + */ ctrlKey?: boolean; /** returns the event object. - */ + */ originalArgs?: any; /** returns the FileExplorer model. - */ + */ model?: ej.FileExplorer.Model; /** returns the name of the event. - */ + */ type?: string; } export interface LayoutChangeEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** return true when we change the layout via interaction, else false. - */ + */ isInteraction?: boolean; /** returns the current view type. - */ + */ layoutType?: string; /** returns the FileExplorer model. - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; } export interface MenuBeforeOpenEventArgs { /** set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the name of ContextMenu items group. - */ + */ contextMenu?: string; /** returns the dataSource of ContextMenu. - */ + */ dataSource?: any[]; /** returns the element of ContextMenu. - */ + */ element?: any; /** returns the event of ContextMenu. - */ + */ events?: any; /** returns the FileExplorer model. - */ + */ model?: ej.FileExplorer.Model; /** returns the target element. - */ + */ target?: any; /** returns the name of the event. - */ + */ type?: string; } export interface MenuClickEventArgs { /** returns the ID of clicked ContextMenu item. - */ + */ ID?: string; /** set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the name of ContextMenu items group. - */ + */ contextMenu?: string; /** returns the element of clicked ContextMenu item. - */ + */ element?: any; /** returns the event of ContextMenu. - */ + */ event?: any; /** returns the FileExplorer model. - */ + */ model?: ej.FileExplorer.Model; /** returns the parent element ID of clicked ContextMenu item. - */ + */ parentId?: string; /** returns the parent element text of clicked ContextMenu item. - */ + */ parentText?: string; /** returns the text of clicked ContextMenu item. - */ + */ text?: string; /** returns the name of the event. - */ + */ type?: string; } export interface MenuOpenEventArgs { /** set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the name of ContextMenu items group. - */ + */ contextMenu?: string; /** returns the element of ContextMenu. - */ + */ element?: any; /** returns the FileExplorer model. - */ + */ model?: ej.FileExplorer.Model; /** returns the target element. - */ + */ target?: any; /** returns the name of the event. - */ + */ type?: string; } export interface OpenEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the opened item type. - */ + */ itemType?: string; /** returns the FileExplorer model. - */ + */ model?: ej.FileExplorer.Model; /** returns the path of currently opened item. - */ + */ path?: string; /** returns the selected item details. - */ + */ selectedItems?: any; /** returns the name of the event. - */ + */ type?: string; } export interface PasteEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the FileExplorer model. - */ + */ model?: ej.FileExplorer.Model; /** returns the name of moved/copied file or folder. - */ + */ name?: string[]; /** returns the selected item details. - */ + */ selectedItems?: any; /** returns the target folder item details. - */ + */ targetFolder?: any; /** returns the target path. - */ + */ targetPath?: string; /** returns the name of the event. - */ + */ type?: string; } export interface RemoveEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the AJAX response data. - */ + */ data?: any; /** returns the FileExplorer model. - */ + */ model?: ej.FileExplorer.Model; /** returns the names of deleted items. - */ + */ name?: string; /** returns the path of deleted item. - */ + */ path?: string; /** returns the removed item details. - */ + */ selectedItems?: any; /** returns the name of the event. - */ + */ type?: string; } export interface ResizeEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the mouse move event args. - */ + */ event?: any; /** returns the FileExplorer model. - */ + */ model?: ej.FileExplorer.Model; /** returns the name of the event. - */ + */ type?: string; } export interface ResizeStartEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the mouse down event args. - */ + */ event?: any; /** returns the FileExplorer model. - */ + */ model?: ej.FileExplorer.Model; /** returns the name of the event. - */ + */ type?: string; } export interface ResizeStopEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the mouse leave event args. - */ + */ event?: any; /** returns the FileExplorer model. - */ + */ model?: ej.FileExplorer.Model; /** returns the name of the event. - */ + */ type?: string; } export interface SelectEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the FileExplorer model. - */ + */ model?: ej.FileExplorer.Model; /** returns the name of selected items. - */ + */ name?: string[]; /** returns the path of selected items. - */ + */ path?: string; /** returns the selected item details - */ + */ selectedItems?: any; /** returns the name of the event. - */ + */ type?: string; } export interface TemplateRefreshEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** Returns the cell object. - */ + */ cell?: ej.FileExplorer.Model; /** Returns the column object. - */ + */ column?: any; /** Returns the current row data. - */ + */ data?: any; /** Returns the grid model of FileExplorer. - */ + */ model?: any; /** Returns the current row index. - */ + */ rowIndex?: number; /** returns the name of the event. - */ + */ type?: string; } export interface UnselectEventArgs { /** Returns the FileExplorer model. - */ + */ model?: ej.FileExplorer.Model; /** Returns the name of unselected item. - */ + */ name?: string; /** Returns the name of unselected items. - */ + */ names?: string[]; /** Returns the type of unselected item. - */ + */ nodeType?: string; /** Returns the path of unselected item. - */ + */ path?: string; /** Returns the name of the event. - */ + */ type?: string; /** Returns the unselected item details. - */ + */ unselectedItem?: any; /** Returns the unselected items details. - */ + */ unselectedItems?: any[]; } export interface ContextMenuSettings { /** The items property is used to configure and group the required ContextMenu items in FileExplorer control. - * @Default {{% highlight javascript %}{navbar: [NewFolder, Upload, |, Delete, Rename, |, Cut, Copy, Paste, |, Getinfo],cwd: [Refresh, Paste,|, SortBy, |, NewFolder, Upload, |, - * Getinfo],files: [Open, Download, |, Upload, |, Delete, Rename, |, Cut, Copy, Paste, |, OpenFolderLocation, Getinfo]}{% endhighlight %}} - */ + * @Default {{% highlight javascript %}{navbar: [NewFolder, Upload, |, Delete, Rename, |, Cut, Copy, Paste, |, Getinfo],cwd: [Refresh, Paste,|, SortBy, |, NewFolder, Upload, |, + * Getinfo],files: [Open, Download, |, Upload, |, Delete, Rename, |, Cut, Copy, Paste, |, OpenFolderLocation, Getinfo]}{% endhighlight %}} + */ items?: any; /** The customMenuFields property is used to define custom functionality for custom ContextMenu item's which are defined in items property. - * @Default {[]} - */ + * @Default {[]} + */ customMenuFields?: any[]; } export interface FilterSettings { /** It allows to search the text given in search Textbox in every keyup event. When this property was set as false, searching will works only on Enter key and searchbar blur. - * @Default {true} - */ + * @Default {true} + */ allowSearchOnTyping?: boolean; /** Enables or disables to perform the filter operation with case sensitive. - * @Default {false} - */ + * @Default {false} + */ caseSensitiveSearch?: boolean; /** Sets the search filter type. There are several filter types available such as "startswith", "contains", "endswith". See filterType. - * @Default {ej.FileExplorer.filterType.Contains} - */ + * @Default {ej.FileExplorer.filterType.Contains} + */ filterType?: ej.FilterType|string; } export interface GridSettings { /** Allows to Resize the width of the columns by simply click and move the particular column header line. - * @Default {true} - */ + * @Default {true} + */ allowResizing?: boolean; /** Gets or sets a value that indicates whether to enable the dynamic sorting behavior on grid data. Sorting can be done through clicking on particular column header. - * @Default {true} - */ + * @Default {true} + */ allowSorting?: boolean; /** Gets or sets an object that indicates to render the grid with specified columns. You can use this property same as the column property in Grid control. - * @Default {[{ field: name, headerText: Name, width: 30% }, { field: dateModified, headerText: Date Modified, width: 30% }, { field: type, headerText: Type, width: 15% }, - * { field: size, headerText: Size, width: 12%, textAlign: right, headerTextAlign: left }]} - */ + * @Default {[{ field: name, headerText: Name, width: 30% }, { field: dateModified, headerText: Date Modified, width: 30% }, { field: type, headerText: Type, width: 15% }, + * { field: size, headerText: Size, width: 12%, textAlign: right, headerTextAlign: left }]} + */ columns?: any[]; } export interface UploadSettings { /** Specifies the maximum file size allowed to upload. It accepts the value in bytes. - * @Default {31457280} - */ + * @Default {31457280} + */ maxFileSize?: number; /** Enables or disables the multiple files upload. When it is enabled, you can upload multiple files at a time and when disabled, you can upload only one file at a time. - * @Default {true} - */ + * @Default {true} + */ allowMultipleFile?: boolean; /** Enables or disables the auto upload option while uploading files in FileExplorer control. - * @Default {false} - */ + * @Default {false} + */ autoUpload?: boolean; } @@ -5789,28 +5789,28 @@ class DatePicker extends ej.Widget { defaults: DatePicker.Model; /** Disables the DatePicker control. - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** Enable the DatePicker control, if it is in disabled state. - * @returns {void} - */ + * @returns {void} + */ enable(): void; /** Returns the current date value in the DatePicker control. - * @returns {string} - */ + * @returns {string} + */ getValue(): string; /** Close the DatePicker popup, if it is in opened state. - * @returns {void} - */ + * @returns {void} + */ hide(): void; /** Opens the DatePicker popup. - * @returns {void} - */ + * @returns {void} + */ show(): void; } export namespace DatePicker { @@ -5818,203 +5818,203 @@ export namespace DatePicker { export interface Model { /** Used to allow or restrict the editing in DatePicker input field directly. By setting false to this API, You can only pick the date from DatePicker popup. - * @Default {true} - */ + * @Default {true} + */ allowEdit?: boolean; /** allow or restrict the drill down to multiple levels of view (month/year/decade) in DatePicker calendar - * @Default {true} - */ + * @Default {true} + */ allowDrillDown?: boolean; /** Disable the list of specified date value. - * @Default {{}} - */ + * @Default {{}} + */ blackoutDates?: any; /** Sets the specified text value to the today button in the DatePicker calendar. - * @Default {Today} - */ + * @Default {Today} + */ buttonText?: string; /** Sets the root CSS class for DatePicker theme, which is used customize. - */ + */ cssClass?: string; /** Formats the value of the DatePicker in to the specified date format. If this API is not specified, dateFormat will be set based on the current culture of DatePicker. - * @Default {MM/dd/yyyy} - */ + * @Default {MM/dd/yyyy} + */ dateFormat?: string; /** Specifies the header format of days in DatePicker calendar. See below to get available Headers options - * @Default {ej.DatePicker.Header.Short} - */ + * @Default {ej.DatePicker.Header.Short} + */ dayHeaderFormat?: string | ej.DatePicker.Header; /** Specifies the navigation depth level in DatePicker calendar. This option is not applied when start level view option is lower than depth level view. - * See below to know available levels in DatePicker Calendar - */ + * See below to know available levels in DatePicker Calendar + */ depthLevel?: string | ej.DatePicker.Level; /** Allows to embed the DatePicker calendar in the page. Also associates DatePicker with div element instead of input. - * @Default {false} - */ + * @Default {false} + */ displayInline?: boolean; /** Enables or disables the animation effect with DatePicker calendar. - * @Default {true} - */ + * @Default {true} + */ enableAnimation?: boolean; /** Enable or disable the DatePicker control. - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Sustain the entire widget model of DatePicker even after form post or browser refresh - * @Default {false} - */ + * @Default {false} + */ enablePersistence?: boolean; /** Displays DatePicker calendar along with DatePicker input field in Right to Left direction. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Allows to enter valid or invalid date in input textbox and indicate as error if it is invalid value, when this API value is set to true. For false value, invalid date is not allowed - * to input field and corrected to valid date automatically, even if invalid date is given. - * @Default {false} - */ + * to input field and corrected to valid date automatically, even if invalid date is given. + * @Default {false} + */ enableStrictMode?: boolean; /** Used the required fields for special Dates in DatePicker in order to customize the special dates in a calendar. - * @Default {null} - */ + * @Default {null} + */ fields?: Fields; /** Specifies the header format to be displayed in the DatePicker calendar. - * @Default {MMMM yyyy} - */ + * @Default {MMMM yyyy} + */ headerFormat?: string; /** Specifies the height of the DatePicker input text. - * @Default {28px} - */ + * @Default {28px} + */ height?: string; /** HighlightSection is used to highlight currently selected date's month/week/workdays. See below to get available HighlightSection options - * @Default {none} - */ + * @Default {none} + */ highlightSection?: string | ej.DatePicker.HighlightSection; /** Weekend dates will be highlighted when this property is set to true. - * @Default {false} - */ + * @Default {false} + */ highlightWeekend?: boolean; /** Specifies the HTML Attributes of the DatePicker. - * @Default {{}} - */ + * @Default {{}} + */ htmlAttributes?: any; /** Change the DatePicker calendar and date format based on given culture. - * @Default {en-US} - */ + * @Default {en-US} + */ locale?: string; /** Specifies the maximum date in the calendar that the user can select. - * @Default {new Date(2099, 11, 31)} - */ + * @Default {new Date(2099, 11, 31)} + */ maxDate?: string|Date; /** Specifies the minimum date in the calendar that the user can select. - * @Default {new Date(1900, 00, 01)} - */ + * @Default {new Date(1900, 00, 01)} + */ minDate?: string|Date; /** Allows to toggles the read only state of the DatePicker. When the widget is readOnly, it doesn't allow your input. - * @Default {false} - */ + * @Default {false} + */ readOnly?: boolean; /** It allow to show/hide the disabled date ranges - * @Default {true} - */ + * @Default {true} + */ showDisabledRange?: boolean; /** It allows to display footer in DatePicker calendar. - * @Default {true} - */ + * @Default {true} + */ showFooter?: boolean; /** It allows to display/hides the other months days from the current month calendar in a DatePicker. - * @Default {true} - */ + * @Default {true} + */ showOtherMonths?: boolean; /** Shows/hides the date icon button at right side of textbox, which is used to open or close the DatePicker calendar popup. - * @Default {true} - */ + * @Default {true} + */ showPopupButton?: boolean; /** DatePicker input is displayed with rounded corner when this property is set to true. - * @Default {false} - */ + * @Default {false} + */ showRoundedCorner?: boolean; /** Used to show the tooltip when hovering on the days in the DatePicker calendar. - * @Default {true} - */ + * @Default {true} + */ showTooltip?: boolean; /** Specifies the special dates in DatePicker. - * @Default {null} - */ + * @Default {null} + */ specialDates?: any; /** Specifies the start day of the week in DatePicker calendar. - * @Default {0} - */ + * @Default {0} + */ startDay?: number; /** Specifies the start level view in DatePicker calendar. See below available Levels - * @Default {ej.DatePicker.Level.Month} - */ + * @Default {ej.DatePicker.Level.Month} + */ startLevel?: string | ej.DatePicker.Level; /** Specifies the number of months to be navigate for one click of next and previous button in a DatePicker Calendar. - * @Default {1} - */ + * @Default {1} + */ stepMonths?: number; /** Provides option to customize the tooltip format. - * @Default {ddd MMM dd yyyy} - */ + * @Default {ddd MMM dd yyyy} + */ tooltipFormat?: string; /** Sets the jQuery validation support to DatePicker Date value. See validation - * @Default {null} - */ + * @Default {null} + */ validationMessage?: any; /** Sets the jQuery validation custom rules to the DatePicker. see validation - * @Default {null} - */ + * @Default {null} + */ validationRules?: any; /** sets or returns the current value of DatePicker - * @Default {null} - */ + * @Default {null} + */ value?: string|Date; /** Specifies the water mark text to be displayed in input text. - * @Default {Select date} - */ + * @Default {Select date} + */ watermarkText?: string; /** Specifies the width of the DatePicker input text. - * @Default {160px} - */ + * @Default {160px} + */ width?: string; /** Fires before closing the DatePicker popup. */ @@ -6057,303 +6057,303 @@ export interface Model { export interface BeforeCloseEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the DatePicker model. - */ + */ model?: ej.DatePicker.Model; /** returns the name of the event. - */ + */ type?: string; /** returns the event parameters from DatePicker. - */ + */ events?: any; /** returns the DatePicker popup. - */ + */ element?: HTMLElement; } export interface BeforeDateCreateEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the DatePicker model. - */ + */ model?: ej.DatePicker.Model; /** returns the name of the event. - */ + */ type?: string; /** returns the currently created date object. - */ + */ date?: any; /** returns the current DOM object of the date from the Calendar. - */ + */ element?: HTMLElement; /** returns the currently created date as string type. - */ + */ value?: string; } export interface BeforeOpenEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the DatePicker model. - */ + */ model?: ej.DatePicker.Model; /** returns the name of the event. - */ + */ type?: string; /** returns the event parameters from DatePicker. - */ + */ events?: any; /** returns the DatePicker popup. - */ + */ element?: HTMLElement; } export interface ChangeEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the DatePicker model. - */ + */ model?: ej.DatePicker.Model; /** returns the name of the event. - */ + */ type?: string; /** returns the DatePicker input value. - */ + */ value?: string; /** returns the previously selected value. - */ + */ prevDate?: string; } export interface CloseEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the current date object. - */ + */ date?: any; /** returns the DatePicker model. - */ + */ model?: ej.DatePicker.Model; /** returns the name of the event. - */ + */ type?: string; /** returns the current date value. - */ + */ value?: string; /** returns the previously selected value. - */ + */ prevDate?: string; } export interface CreateEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the DatePicker model. - */ + */ model?: ej.DatePicker.Model; /** returns the name of the event. - */ + */ type?: string; } export interface DestroyEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the DatePicker model. - */ + */ model?: ej.DatePicker.Model; /** returns the name of the event. - */ + */ type?: string; } export interface FocusInEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the DatePicker model. - */ + */ model?: ej.DatePicker.Model; /** returns the name of the event. - */ + */ type?: string; /** returns the currently selected date value. - */ + */ value?: string; } export interface FocusOutEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the DatePicker model. - */ + */ model?: ej.DatePicker.Model; /** returns the name of the event. - */ + */ type?: string; /** returns the currently selected date value. - */ + */ value?: string; /** returns the previously selected date value. - */ + */ prevDate?: string; } export interface NavigateEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the current date object. - */ + */ date?: any; /** returns the DatePicker model. - */ + */ model?: ej.DatePicker.Model; /** returns the previous view state of calendar. - */ + */ navigateFrom?: string; /** returns the current view state of calendar. - */ + */ navigateTo?: string; /** returns the name of the event - */ + */ type?: string; /** returns the current date value. - */ + */ value?: string; } export interface OpenEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the current date object. - */ + */ date?: any; /** returns the DatePicker model. - */ + */ model?: ej.DatePicker.Model; /** returns the name of the event - */ + */ type?: string; /** returns the current date value. - */ + */ value?: string; /** returns the previously selected value. - */ + */ prevDate?: string; } export interface SelectEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the selected date object. - */ + */ date?: any; /** returns the DatePicker model. - */ + */ model?: ej.DatePicker.Model; /** returns the name of the event. - */ + */ type?: string; /** returns the current date value. - */ + */ value?: string; /** returns the previously selected value. - */ + */ prevDate?: string; /** returns whether the currently selected date is special date or not. - */ + */ isSpecialDay?: string; } export interface Fields { /** Specifies the specials dates - */ + */ date?: string; /** Specifies the icon class to special dates. - */ + */ iconClass?: string; /** Specifies the tooltip to special dates. - */ + */ tooltip?: string; /** Specifies the CSS class to customize the date. - */ + */ cssClass?: string; } @@ -6405,33 +6405,33 @@ class DateTimePicker extends ej.Widget { defaults: DateTimePicker.Model; /** Disables the DateTimePicker control. - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** Enables the DateTimePicker control. - * @returns {void} - */ + * @returns {void} + */ enable(): void; /** Returns the current datetime value in the DateTimePicker. - * @returns {string} - */ + * @returns {string} + */ getValue(): string; /** Hides or closes the DateTimePicker popup. - * @returns {void} - */ + * @returns {void} + */ hide(): void; /** Updates the current system date value and time value to the DateTimePicker. - * @returns {void} - */ + * @returns {void} + */ setCurrentDateTime(): void; /** Shows or opens the DateTimePicker popup. - * @returns {void} - */ + * @returns {void} + */ show(): void; } export namespace DateTimePicker { @@ -6439,171 +6439,171 @@ export namespace DateTimePicker { export interface Model { /** Used to allow or restrict the editing in DateTimePicker input field directly. By setting false to this API, You can only pick the date and time values from DateTimePicker popup. - * @Default {true} - */ + * @Default {true} + */ allowEdit?: boolean; /** Displays the custom text for the buttons inside the DateTimePicker popup. when the culture value changed, we can change the buttons text based on the culture. - * @Default {{ today: Today, timeNow: Time Now, done: Done, timeTitle: Time }} - */ + * @Default {{ today: Today, timeNow: Time Now, done: Done, timeTitle: Time }} + */ buttonText?: ButtonText; /** Set the root class for DateTimePicker theme. This cssClass API helps to use custom skinning option for DateTimePicker control. - */ + */ cssClass?: string; /** Defines the datetime format displayed in the DateTimePicker. The value should be a combination of date format and time format. - * @Default {M/d/yyyy h:mm tt} - */ + * @Default {M/d/yyyy h:mm tt} + */ dateTimeFormat?: string; /** Specifies the header format of the datepicker inside the DateTimePicker popup. See DatePicker.Header - * @Default {ej.DatePicker.Header.Short} - */ + * @Default {ej.DatePicker.Header.Short} + */ dayHeaderFormat?: ej.DatePicker.Header|string; /** Specifies the navigation depth level in DatePicker calendar inside DateTimePicker popup. This option is not applied - * when start level view option is lower than depth level view. See ej.DatePicker.Level - */ + * when start level view option is lower than depth level view. See ej.DatePicker.Level + */ depthLevel?: ej.DatePicker.Level|string; /** Enable or disable the animation effect in DateTimePicker. - * @Default {true} - */ + * @Default {true} + */ enableAnimation?: boolean; /** When this property is set to false, it disables the DateTimePicker control. - * @Default {false} - */ + * @Default {false} + */ enabled?: boolean; /** Enables or disables the state maintenance of DateTimePicker. - * @Default {false} - */ + * @Default {false} + */ enablePersistence?: boolean; /** Sets the DateTimePicker direction as right to left alignment. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** When enableStrictMode true it allows the value outside of the range also but it highlights the textbox with error class, otherwise it internally changed to the correct value. - * @Default {false} - */ + * @Default {false} + */ enableStrictMode?: boolean; /** Specifies the header format to be displayed in the DatePicker calendar inside the DateTimePicker popup. - * @Default {MMMM yyyy} - */ + * @Default {MMMM yyyy} + */ headerFormat?: string; /** Defines the height of the DateTimePicker textbox. - * @Default {30} - */ + * @Default {30} + */ height?: string|number; /** Specifies the HTML Attributes of the ejDateTimePicker - * @Default {{}} - */ + * @Default {{}} + */ htmlAttributes?: any; /** Sets the time interval between the two adjacent time values in the time popup. - * @Default {30} - */ + * @Default {30} + */ interval?: number; /** Defines the localization culture for DateTimePicker. - * @Default {en-US} - */ + * @Default {en-US} + */ locale?: string; /** Sets the maximum value to the DateTimePicker. Beyond the maximum value an error class is added to the wrapper element when we set true to enableStrictMode. - * @Default {new Date(12/31/2099 11:59:59 PM)} - */ + * @Default {new Date(12/31/2099 11:59:59 PM)} + */ maxDateTime?: string|Date; /** Sets the minimum value to the DateTimePicker. Behind the minimum value an error class is added to the wrapper element. - * @Default {new Date(1/1/1900 12:00:00 AM)} - */ + * @Default {new Date(1/1/1900 12:00:00 AM)} + */ minDateTime?: string|Date; /** Specifies the popup position of DateTimePicker.See below to know available popup positions - * @Default {ej.DateTimePicker.Bottom} - */ + * @Default {ej.DateTimePicker.Bottom} + */ popupPosition?: string | ej.popupPosition; /** Indicates that the DateTimePicker value can only be read and canĂ¢â‚¬â„¢t change. - * @Default {false} - */ + * @Default {false} + */ readOnly?: boolean; /** It allows showing days in other months of DatePicker calendar inside the DateTimePicker popup. - * @Default {true} - */ + * @Default {true} + */ showOtherMonths?: boolean; /** Shows or hides the arrow button from the DateTimePicker textbox. When the button disabled, the DateTimePicker popup opens while focus in the textbox and hides while focus out from the textbox. - * @Default {true} - */ + * @Default {true} + */ showPopupButton?: boolean; /** Changes the sharped edges into rounded corner for the DateTimePicker textbox and popup. - * @Default {false} - */ + * @Default {false} + */ showRoundedCorner?: boolean; /** Specifies the start day of the week in datepicker inside the DateTimePicker popup. - * @Default {1} - */ + * @Default {1} + */ startDay?: number; /** Specifies the start level view in datepicker inside the DateTimePicker popup. See DatePicker.Level - * @Default {ej.DatePicker.Level.Month or month} - */ + * @Default {ej.DatePicker.Level.Month or month} + */ startLevel?: ej.DatePicker.Level|string; /** Specifies the number of months to navigate at one click of next and previous button in datepicker inside the DateTimePicker popup. - * @Default {1} - */ + * @Default {1} + */ stepMonths?: number; /** Defines the time format displayed in the time dropdown inside the DateTimePicker popup. - * @Default {h:mm tt} - */ + * @Default {h:mm tt} + */ timeDisplayFormat?: string; /** We can drill down up to time interval on selected date with meridian details. - * @Default {{ enabled: false, interval: 5, showMeridian: false, autoClose: true }} - */ + * @Default {{ enabled: false, interval: 5, showMeridian: false, autoClose: true }} + */ timeDrillDown?: TimeDrillDown; /** Defines the width of the time dropdown inside the DateTimePicker popup. - * @Default {100} - */ + * @Default {100} + */ timePopupWidth?: string|number; /** Set the jQuery validation error message in DateTimePicker. - * @Default {null} - */ + * @Default {null} + */ validationMessage?: any; /** Set the jQuery validation rules in DateTimePicker. - * @Default {null} - */ + * @Default {null} + */ validationRules?: any; /** Sets the DateTime value to the control. - */ + */ value?: string|Date; /** Specifies the water mark text to be displayed in input text. - * @Default {Select date and time} - */ + * @Default {Select date and time} + */ watermarkText?: string; /** Defines the width of the DateTimePicker textbox. - * @Default {143} - */ + * @Default {143} + */ width?: string|number; /** Fires before the datetime popup closed in the DateTimePicker. */ @@ -6637,229 +6637,229 @@ export interface Model { export interface BeforeCloseEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the DateTimePicker model. - */ + */ model?: ej.DateTimePicker.Model; /** returns the name of the event. - */ + */ type?: string; /** returns the event parameters from DateTimePicker. - */ + */ events?: any; /** returns the DateTimePicker popup. - */ + */ element?: HTMLElement; } export interface BeforeOpenEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the DateTimePicker model. - */ + */ model?: ej.DateTimePicker.Model; /** returns the name of the event. - */ + */ type?: string; /** returns the event parameters from DateTimePicker. - */ + */ events?: any; /** returns the DateTimePicker popup. - */ + */ element?: HTMLElement; } export interface ChangeEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TimePicker model - */ + */ model?: ej.DateTimePicker.Model; /** returns the name of the event - */ + */ type?: string; /** returns the current value is valid or not - */ + */ isValidState?: boolean; /** returns the modified datetime value - */ + */ value?: string; /** returns the previously selected date time value - */ + */ prevDateTime?: string; /** returns true if change event triggered by interaction, otherwise returns false - */ + */ isInteraction?: boolean; } export interface CloseEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TimePicker model - */ + */ model?: ej.DateTimePicker.Model; /** returns the name of the event - */ + */ type?: string; /** returns the modified datetime value - */ + */ value?: string; /** returns the previously selected date time value - */ + */ prevDateTime?: string; } export interface CreateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the DateTimePicker model - */ + */ model?: ej.DateTimePicker.Model; /** returns the name of the event - */ + */ type?: string; } export interface DestroyEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the DateTimePicker model - */ + */ model?: ej.DateTimePicker.Model; /** returns the name of the event - */ + */ type?: string; } export interface FocusInEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TimePicker model - */ + */ model?: ej.DateTimePicker.Model; /** returns the name of the event - */ + */ type?: string; /** returns the datetime value, which is in text box - */ + */ value?: string; } export interface FocusOutEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TimePicker model - */ + */ model?: ej.DateTimePicker.Model; /** returns the name of the event - */ + */ type?: string; /** returns the datetime value, which is in text box - */ + */ value?: string; } export interface OpenEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TimePicker model - */ + */ model?: ej.DateTimePicker.Model; /** returns the name of the event - */ + */ type?: string; /** returns the modified datetime value - */ + */ value?: string; /** returns the previously selected date time value - */ + */ prevDateTime?: string; } export interface ButtonText { /** Sets the text for the Done button inside the datetime popup. - */ + */ done?: string; /** Sets the text for the Now button inside the datetime popup. - */ + */ timeNow?: string; /** Sets the header text for the Time dropdown. - */ + */ timeTitle?: string; /** Sets the text for the Today button inside the datetime popup. - */ + */ today?: string; } export interface TimeDrillDown { /** This is the field to show/hide the timeDrillDown in DateTimePicker. - */ + */ enabled?: boolean; /** Sets the interval time of minutes on selected date. - */ + */ interval?: number; /** Allows the user to show or hide the meridian with time in DateTimePicker. - */ + */ showMeridian?: boolean; /** After choosing the time, the popup will close automatically if we set it as true, otherwise we focus out the DateTimePicker or choose timeNow button for closing the popup. - */ + */ autoClose?: boolean; } } @@ -6878,45 +6878,45 @@ class DateRangePicker extends ej.Widget { defaults: DateRangePicker.Model; /** Add the preset ranges to DateRangePicker popup. - * @param {string} Display name - * @param {Array} StartDate and endDate of range. - * @returns {void} - */ + * @param {string} Display name + * @param {Array} StartDate and endDate of range. + * @returns {void} + */ addRanges(label: string, range: any[]): void; /** Clears the all ranges selections in DateRangePicker popup - * @returns {void} - */ + * @returns {void} + */ clearRanges(): void; /** Disables the DateRangePicker control. - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** Enable the DateRangePicker control, if it is in disabled state. - * @returns {void} - */ + * @returns {void} + */ enable(): void; /** Returns the startDate and endDate values in the selected ranges in the DateRangePicker control. - * @returns {string} - */ + * @returns {string} + */ getSelectedValue(): string; /** Close the DateRangePicker popup, if it is in opened state. - * @returns {void} - */ + * @returns {void} + */ popupHide(): void; /** Opens the DateRangePicker popup. - * @returns {void} - */ + * @returns {void} + */ popupShow(): void; /** set the preset ranges to DateRangePicker popup. - * @returns {void} - */ + * @returns {void} + */ setRange(): void; } export namespace DateRangePicker { @@ -6924,92 +6924,92 @@ export namespace DateRangePicker { export interface Model { /** Used to allow or restrict the editing in DateRangePicker input field directly. By setting false to this API, You can only pick the date ranges from DateRangePicker popup. - * @Default {true} - */ + * @Default {true} + */ allowEdit?: boolean; /** Sets the specified text value to the available buttons (Reset, Cancel, Apply) in the DateRangePicker popup. - * @Default {{ reset: Reset, cancel: Cancel, apply: Apply}} - */ + * @Default {{ reset: Reset, cancel: Cancel, apply: Apply}} + */ buttonText?: any; /** Sets the root CSS class for DateRangePicker theme, which is used to customize. - */ + */ cssClass?: string; /** Formats the date value of the DateRangePicker in to the specified date format. If this API is not specified, dateFormat will be set based on the current culture of DateRangePicker. - * @Default {MM/dd/yyyy} - */ + * @Default {MM/dd/yyyy} + */ dateFormat?: string; /** Allows to embed the Timepicker align with the calendars in the page, two timepicker will be render, for selecting start and end date. - * @Default {false} - */ + * @Default {false} + */ enableTimePicker?: boolean; /** Enable or disable the DateRangePicker control. - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Sustain the entire widget model of DateRangePicker even after form post or browser refresh - * @Default {false} - */ + * @Default {false} + */ enablePersistence?: boolean; /** Specifies the end date of the date ranges. - * @Default {null} - */ + * @Default {null} + */ endDate?: string|Date; /** Specifies the height of the DateRangePicker input. - * @Default {28px} - */ + * @Default {28px} + */ height?: string|number; /** Change the DateRangePicker calendar and date format based on given culture. - * @Default {en-US} - */ + * @Default {en-US} + */ locale?: string; /** Used to add the preset ranges. Added ranges using this, will show in popup in right side for easy selection of different preset ranges. - * @Default {null} - */ + * @Default {null} + */ ranges?: any; /** Specifies the start date of the date ranges - * @Default {null} - */ + * @Default {null} + */ startDate?: string|Date; /** Shows/hides the date icon button at right side of textbox, which is used to open or close the DateRangePicker calendar popup. - * @Default {true} - */ + * @Default {true} + */ showPopupButton?: boolean; /** DateRangePicker input and popup is displayed with rounded corner when this property is set to true. - * @Default {false} - */ + * @Default {false} + */ showRoundedCorner?: boolean; /** Formats the date value of the DateRangePicker in to the specified time format. If this API is not specified, timeFormat will be set based on the current culture of DateRangePicker. - * @Default {HH:mm tt} - */ + * @Default {HH:mm tt} + */ timeFormat?: string; /** Separated two date values in string format to sets the date ranges in calendars. - * @Default {null} - */ + * @Default {null} + */ value?: string; /** Specifies the water mark text to be displayed in input text. - * @Default {Select Range} - */ + * @Default {Select Range} + */ watermarkText?: string; /** Specifies the width of the DateRangePicker input text. - * @Default {160px} - */ + * @Default {160px} + */ width?: string|number; /** Fires before closing the DateRangePicker popup. */ @@ -7040,172 +7040,172 @@ export interface Model { export interface BeforeCloseEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the DateRangePicker model - */ + */ model?: ej.DateRangePicker.Model; /** returns the name of the event. - */ + */ type?: string; /** returns the event parameters from DateRangePicker. - */ + */ events?: any; /** returns the DateRangePicker popup. - */ + */ element?: HTMLElement; } export interface BeforeOpenEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the DateRangePicker model. - */ + */ model?: ej.DateRangePicker.Model; /** returns the name of the event. - */ + */ type?: string; /** returns the event parameters from DateRangePicker. - */ + */ events?: any; /** returns the DateRangePicker popup. - */ + */ element?: HTMLElement; } export interface OnChangeEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the DateRangePicker model. - */ + */ model?: ej.DateRangePicker.Model; /** returns the name of the event. - */ + */ type?: string; /** returns the DateRangePicker input value. - */ + */ value?: string; /** returns the startDate of DateRangePicker. - */ + */ startDate?: any; /** returns the endDate of the DateRangePicker popup. - */ + */ endDate?: any; } export interface CloseEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the current date object. - */ + */ date?: any; /** returns the DateRangePicker model. - */ + */ model?: ej.DateRangePicker.Model; /** returns the name of the event. - */ + */ type?: string; /** returns the DateRangePicker popup. - */ + */ element?: HTMLElement; } export interface CreateEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the DateRangePicker model. - */ + */ model?: ej.DateRangePicker.Model; /** returns the name of the event. - */ + */ type?: string; } export interface DestroyEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the DateRangePicker model. - */ + */ model?: ej.DateRangePicker.Model; /** returns the name of the event. - */ + */ type?: string; } export interface OpenEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the current date object. - */ + */ date?: any; /** returns the DateRangePicker model. - */ + */ model?: ej.DateRangePicker.Model; /** returns the name of the event - */ + */ type?: string; /** returns the DateRangePicker popup. - */ + */ element?: HTMLElement; } export interface SelectEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the selected date object. - */ + */ startDate?: any; /** returns the DateRangePicker model. - */ + */ model?: ej.DateRangePicker.Model; /** returns the name of the event. - */ + */ type?: string; /** returns the current date value. - */ + */ endDate?: any; } } @@ -7218,80 +7218,80 @@ class Dialog extends ej.Widget { defaults: Dialog.Model; /** Closes the dialog widget dynamically. - * @returns {any} - */ + * @returns {any} + */ close(): any; /** Collapses the content area when it is expanded. - * @returns {any} - */ + * @returns {any} + */ collapse(): any; /** Destroys the Dialog widget. - * @returns {void} - */ + * @returns {void} + */ destroy(): void; /** Expands the content area when it is collapsed. - * @returns {any} - */ + * @returns {any} + */ expand(): any; /** Checks whether the Dialog widget is opened or not. This methods returns Boolean value. - * @returns {boolean} - */ + * @returns {boolean} + */ isOpen(): boolean; /** Maximizes the Dialog widget. - * @returns {any} - */ + * @returns {any} + */ maximize(): any; /** Minimizes the Dialog widget. - * @returns {any} - */ + * @returns {any} + */ minimize(): any; /** Opens the Dialog widget. - * @returns {any} - */ + * @returns {any} + */ open(): any; /** Pins the dialog in its current position. - * @returns {any} - */ + * @returns {any} + */ pin(): any; /** Refreshes the dialog content dynamically. - * @returns {void} - */ + * @returns {void} + */ refresh(): void; /** Restores the dialog. - * @returns {any} - */ + * @returns {any} + */ restore(): any; /** Unpins the Dialog widget. - * @returns {any} - */ + * @returns {any} + */ unpin(): any; /** Sets the title for the Dialog widget. - * @param {string} The title for the dialog widget. - * @returns {any} - */ + * @param {string} The title for the dialog widget. + * @returns {any} + */ setTitle(Title: string): any; /** Sets the content for the Dialog widget dynamically. - * @param {string} The content for the dialog widget. It accepts both string and HTML string. - * @returns {any} - */ + * @param {string} The content for the dialog widget. It accepts both string and HTML string. + * @returns {any} + */ setContent(content: string): any; /** Sets the focus on the Dialog widget. - * @returns {any} - */ + * @returns {any} + */ focus(): any; } export namespace Dialog { @@ -7299,153 +7299,153 @@ export namespace Dialog { export interface Model { /** Adds action buttons like close, minimize, pin, maximize in the dialog header. - */ + */ actionButtons?: string[]; /** Specifies the ajaxSettings option to load the content to the Dialog control. - * @Default {null} - */ + * @Default {null} + */ ajaxSettings?: AjaxSettings; /** Enables or disables draggable. - */ + */ allowDraggable?: boolean; /** Enables or disables keyboard interaction. - */ + */ allowKeyboardNavigation?: boolean; /** Customizes the Dialog widget animations. The Dialog widget can be animated while opening and closing the dialog. - * In order to customize animation effects, you need to set Ă¢â‚¬Å“enableAnimationĂ¢â‚¬Â as true. It contains the following sub properties. - */ + * In order to customize animation effects, you need to set Ă¢â‚¬Å“enableAnimationĂ¢â‚¬Â as true. It contains the following sub properties. + */ animation?: any; /** Closes the dialog widget on pressing the ESC key when it is set to true. - */ + */ closeOnEscape?: boolean; /** The selector for the container element. If the property is set, then dialog will append to the selected element and it is restricted to move only within the specified container element. - */ + */ containment?: string; /** The content type to load the dialog content at run time. The possible values are null, AJAX, iframe and image. When it is null (default value), - * the content inside dialog element will be displayed as content and when it is not null, the content will be loaded from the URL specified in the contentUrl property. - */ + * the content inside dialog element will be displayed as content and when it is not null, the content will be loaded from the URL specified in the contentUrl property. + */ contentType?: string; /** The URL to load the dialog content (such as AJAX, image, and iframe). In order to load content from URL, you need to set contentType as Ă¢â‚¬ËœajaxĂ¢â‚¬â„¢ or Ă¢â‚¬ËœiframeĂ¢â‚¬â„¢ or Ă¢â‚¬ËœimageĂ¢â‚¬â„¢. - */ + */ contentUrl?: string; /** The root class for the Dialog widget to customize the existing theme. - */ + */ cssClass?: string; /** Enable or disables animation when the dialog is opened or closed. - */ + */ enableAnimation?: boolean; /** Enables or disables the Dialog widget. - */ + */ enabled?: boolean; /** Enable or disables modal dialog. The modal dialog acts like a child window that is displayed on top of the main window/screen and disables the main window interaction until it is closed. - */ + */ enableModal?: boolean; /** Allows the current model values to be saved in local storage or browser cookies for state maintenance when it is set to true. - */ + */ enablePersistence?: boolean; /** Allows the dialog to be resized. The dialog cannot be resized less than the minimum height, width values and greater than the maximum height and width. - */ + */ enableResize?: boolean; /** Displays dialog content from right to left when set to true. - */ + */ enableRTL?: boolean; /** The CSS class name to display the favicon in the dialog header. In order to display favicon, you need to setĂ‚ showHeaderĂ‚ as true since the favicon will be displayed in the dialog header. - */ + */ faviconCSS?: string; /** Sets the height for the dialog widget. It accepts both string and integer values. For example, it can accepts values like Ă¢â‚¬Å“autoĂ¢â‚¬Â, Ă¢â‚¬Å“100%Ă¢â‚¬Â, Ă¢â‚¬Å“100pxĂ¢â‚¬Â as string type - * and Ă¢â‚¬Å“100Ă¢â‚¬Â, Ă¢â‚¬Å“500Ă¢â‚¬Â as integer type. - */ + * and Ă¢â‚¬Å“100Ă¢â‚¬Â, Ă¢â‚¬Å“500Ă¢â‚¬Â as integer type. + */ height?: string|number; /** Specifies the HTML Attributes of the Dialog. - * @Default {{}} - */ + * @Default {{}} + */ htmlAttributes?: any; /** Enable or disables responsive behavior. - */ + */ isResponsive?: boolean; /** Default Value:{:.param}Ă¢â‚¬Å“en-USĂ¢â‚¬Â - */ + */ locale?: number; /** Sets the maximum height for the dialog widget. - */ + */ maxHeight?: number; /** Sets the maximum width for the dialog widget. - */ + */ maxWidth?: number; /** Sets the minimum height for the dialog widget. - */ + */ minHeight?: number; /** Sets the minimum width for the dialog widget. - */ + */ minWidth?: number; /** Displays the Dialog widget at the given X and Y position. - */ + */ position?: any; /** Shows or hides the dialog header. - */ + */ showHeader?: boolean; /** The Dialog widget can be opened by default i.e. on initialization, when it is set to true. - */ + */ showOnInit?: boolean; /** Enables or disables the rounder corner. - */ + */ showRoundedCorner?: boolean; /** The selector for the container element. If this property is set, the dialog will be displayed (positioned) based on its container. - */ + */ target?: string; /** The title text to be displayed in the dialog header. In order to set title, you need to set showHeader as true since the title will be displayed in the dialog header. - */ + */ title?: string; /** Add or configure the tooltip text for actionButtons in the dialog header. - */ + */ tooltip?: any; /** Sets the height for the dialog widget. It accepts both string and integer values. For example, it can accepts values like Ă¢â‚¬Å“autoĂ¢â‚¬Â, Ă¢â‚¬Å“100%Ă¢â‚¬Â, - * Ă¢â‚¬Å“100pxĂ¢â‚¬Â as string type and Ă¢â‚¬Å“100Ă¢â‚¬Â, Ă¢â‚¬Å“500Ă¢â‚¬Â as integer type. - */ + * Ă¢â‚¬Å“100pxĂ¢â‚¬Â as string type and Ă¢â‚¬Å“100Ă¢â‚¬Â, Ă¢â‚¬Å“500Ă¢â‚¬Â as integer type. + */ width?: string|number; /** Sets the z-index value for the Dialog widget. - */ + */ zIndex?: number; /** Sets the Footer for the Dialog widget. - */ + */ showFooter?: boolean; /** Sets the FooterTemplate for the Dialog widget. - */ + */ footerTemplateId?: string; /** This event is triggered before the dialog widgets gets open. */ @@ -7506,369 +7506,369 @@ export interface Model { export interface BeforeOpenEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the dialog model object. - */ + */ model?: ej.Dialog.Model; /** Name of the event - */ + */ type?: string; } export interface AjaxErrorEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the dialog model object. - */ + */ model?: ej.Dialog.Model; /** Name of the event. - */ + */ type?: string; /** URL of the content. - */ + */ URL?: string; /** Error page content. - */ + */ responseText?: string; /** Error code. - */ + */ status?: number; /** The corresponding error description. - */ + */ statusText?: string; } export interface AjaxSuccessEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the dialog model object. - */ + */ model?: ej.Dialog.Model; /** Name of the event. - */ + */ type?: string; /** URL of the content. - */ + */ URL?: string; /** Response content. - */ + */ data?: string; } export interface BeforeCloseEventArgs { /** Current event object. - */ + */ event?: any; /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the dialog model object. - */ + */ model?: ej.Dialog.Model; /** Name of the event. - */ + */ type?: string; } export interface CloseEventArgs { /** Current event object. - */ + */ event?: any; /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the dialog model object. - */ + */ model?: ej.Dialog.Model; /** Name of the event - */ + */ type?: string; } export interface ContentLoadEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the dialog model object. - */ + */ model?: ej.Dialog.Model; /** Name of the event. - */ + */ type?: string; /** URL of the content. - */ + */ URL?: string; /** Content type - */ + */ contentType?: any; } export interface CreateEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the dialog model object. - */ + */ model?: ej.Dialog.Model; /** Name of the event. - */ + */ type?: string; } export interface DestroyEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the dialog model object. - */ + */ model?: ej.Dialog.Model; /** Name of the event. - */ + */ type?: string; } export interface DragEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the dialog model object. - */ + */ model?: ej.Dialog.Model; /** Name of the event. - */ + */ type?: string; /** Current event object. - */ + */ event?: any; } export interface DragStartEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the dialog model object. - */ + */ model?: ej.Dialog.Model; /** Name of the event. - */ + */ type?: string; /** Current event object. - */ + */ event?: any; } export interface DragStopEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the dialog model object. - */ + */ model?: ej.Dialog.Model; /** Name of the event. - */ + */ type?: string; /** Current event object. - */ + */ event?: any; } export interface OpenEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the dialog model object. - */ + */ model?: ej.Dialog.Model; /** Name of the event. - */ + */ type?: string; } export interface ResizeEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the dialog model object. - */ + */ model?: ej.Dialog.Model; /** Name of the event. - */ + */ type?: string; /** Current event object. - */ + */ event?: any; } export interface ResizeStartEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the dialog model object. - */ + */ model?: ej.Dialog.Model; /** Name of the event - */ + */ type?: string; /** Current event object. - */ + */ event?: any; } export interface ResizeStopEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the dialog model object. - */ + */ model?: ej.Dialog.Model; /** Name of the event - */ + */ type?: string; /** Current event object. - */ + */ event?: any; } export interface ExpandEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the dialog model object. - */ + */ model?: ej.Dialog.Model; /** Name of the event. - */ + */ type?: string; } export interface CollapseEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the dialog model object. - */ + */ model?: ej.Dialog.Model; /** Name of the event. - */ + */ type?: string; } export interface ActionButtonClickEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Name of the event target attribute. - */ + */ buttonID?: string; /** Name of the event. - */ + */ type?: string; /** Instance of the dialog model object. - */ + */ model?: ej.Dialog.Model; /** Name of the event current target title. - */ + */ currentTarget?: string; } export interface AjaxSettings { /** It specifies, whether to enable or disable asynchronous request. - */ + */ async?: boolean; /** It specifies the page will be cached in the web browser. - */ + */ cache?: boolean; /** It specifies the type of data is send in the query string. - */ + */ contentType?: string; /** It specifies the data as an object, will be passed in the query string. - */ + */ data?: any; /** It specifies the type of data that you're expecting back from the response. - */ + */ dataType?: string; /** It specifies the HTTP request type. - */ + */ type?: string; } } @@ -7881,118 +7881,118 @@ class DropDownList extends ej.Widget { defaults: DropDownList.Model; /** Adding a single item or an array of items into the DropDownList allows you to specify all the field attributes such as value, template, image URL, and HTML attributes for those items. - * @param {any|Array} this parameter should have field attributes with respect to mapped field attributes and it's corresponding values to fields - * @returns {void} - */ + * @param {any|Array} this parameter should have field attributes with respect to mapped field attributes and it's corresponding values to fields + * @returns {void} + */ addItem(data: any|any[]): void; /** This method is used to select all the items in the DropDownList. - * @returns {void} - */ + * @returns {void} + */ checkAll(): void; /** Clears the text in the DropDownList textbox. - * @returns {void} - */ + * @returns {void} + */ clearText(): void; /** Destroys the DropDownList widget. - * @returns {void} - */ + * @returns {void} + */ destroy(): void; /** This property is used to disable the DropDownList widget. - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** This property disables the set of items in the DropDownList. - * @param {string|number|Array} disable the given index list items - * @returns {void} - */ + * @param {string|number|Array} disable the given index list items + * @returns {void} + */ disableItemsByIndices(index: string|number|any[]): void; /** This property enables the DropDownList control. - * @returns {void} - */ + * @returns {void} + */ enable(): void; /** Enables an Item or set of Items that are disabled in the DropDownList - * @param {string|number|Array} enable the given index list items if it's disabled - * @returns {void} - */ + * @param {string|number|Array} enable the given index list items if it's disabled + * @returns {void} + */ enableItemsByIndices(index: string|number|any[]): void; /** This method retrieves the items using given value. - * @param {string|number|any} Return the whole object of data based on given value - * @returns {Array} - */ + * @param {string|number|any} Return the whole object of data based on given value + * @returns {Array} + */ getItemDataByValue(value: string|number|any): any[]; /** This method is used to retrieve the items that are bound with the DropDownList. - * @returns {any} - */ + * @returns {any} + */ getListData(): any; /** This method is used to get the selected items in the DropDownList. - * @returns {Array} - */ + * @returns {Array} + */ getSelectedItem(): any[]; /** This method is used to retrieve the items value that are selected in the DropDownList. - * @returns {string} - */ + * @returns {string} + */ getSelectedValue(): string; /** This method hides the suggestion popup in the DropDownList. - * @returns {void} - */ + * @returns {void} + */ hidePopup(): void; /** This method is used to select the list of items in the DropDownList through the Index of the items. - * @param {string|number|Array} select the given index list items - * @returns {void} - */ + * @param {string|number|Array} select the given index list items + * @returns {void} + */ selectItemsByIndices(index: string|number|any[]): void; /** This method is used to select an item in the DropDownList by using the given text value. - * @param {string|number|Array} select the list items relates to given text - * @returns {void} - */ + * @param {string|number|Array} select the list items relates to given text + * @returns {void} + */ selectItemByText(index: string|number|any[]): void; /** This method is used to select an item in the DropDownList by using the given value. - * @param {string|number|Array} select the list items relates to given values - * @returns {void} - */ + * @param {string|number|Array} select the list items relates to given values + * @returns {void} + */ selectItemByValue(index: string|number|any[]): void; /** This method shows the DropDownList control with the suggestion popup. - * @returns {void} - */ + * @returns {void} + */ showPopup(): void; /** This method is used to unselect all the items in the DropDownList. - * @returns {void} - */ + * @returns {void} + */ unCheckAll(): void; /** This method is used to unselect the list of items in the DropDownList through Index of the items. - * @param {string|number|Array} unselect the given index list items - * @returns {void} - */ + * @param {string|number|Array} unselect the given index list items + * @returns {void} + */ unselectItemsByIndices(index: string|number|any[]): void; /** This method is used to unselect an item in the DropDownList by using the given text value. - * @param {string|number|Array} unselect the list items relates to given text - * @returns {void} - */ + * @param {string|number|Array} unselect the list items relates to given text + * @returns {void} + */ unselectItemByText(index: string|number|any[]): void; /** This method is used to unselect an item in the DropDownList by using the given value. - * @param {string|number|Array} unselect the list items relates to given values - * @returns {void} - */ + * @param {string|number|Array} unselect the list items relates to given values + * @returns {void} + */ unselectItemByValue(index: string|number|any[]): void; } export namespace DropDownList { @@ -8000,237 +8000,237 @@ export namespace DropDownList { export interface Model { /** The Virtual Scrolling(lazy loading) feature is used to display a large amount of data that you require without buffering the entire load of a huge database records in the DropDownList, - * that is, when scrolling, an AJAX request is sent to fetch some amount of data from the server dynamically. To achieve this scenario with DropDownList, set the allowVirtualScrolling to true. - * @Default {false} - */ + * that is, when scrolling, an AJAX request is sent to fetch some amount of data from the server dynamically. To achieve this scenario with DropDownList, set the allowVirtualScrolling to true. + * @Default {false} + */ allowVirtualScrolling?: boolean; /** The cascading DropDownLists is a series of two or more DropDownLists in which each DropDownList is filtered according to the previous DropDownListĂ¢â‚¬â„¢s value. - * @Default {null} - */ + * @Default {null} + */ cascadeTo?: string; /** Sets the case sensitivity of the search operation. It supports both enableFilterSearch and enableIncrementalSearch property. - * @Default {false} - */ + * @Default {false} + */ caseSensitiveSearch?: boolean; /** Dropdown widget's style and appearance can be controlled based on 13 different default built-in themes.You can customize the appearance of the dropdown by using the cssClass property. - * You need to specify a class name in the cssClass property and the same class name is used before the class definitions wherever the custom styles are applied. - */ + * You need to specify a class name in the cssClass property and the same class name is used before the class definitions wherever the custom styles are applied. + */ cssClass?: string; /** This property is used to serve data from the data services based on the query provided. To bind the data to the dropdown widget, - * the dataSource property is assigned with the instance of the ej.DataManager. - * @Default {null} - */ + * the dataSource property is assigned with the instance of the ej.DataManager. + * @Default {null} + */ dataSource?: any; /** Sets the separator when the multiSelectMode with delimiter option or checkbox is enabled with the dropdown. When you enter the delimiter value,the texts after the delimiter are considered - * as a separate word or query. The delimiter string is a single character and must be a symbol. Mostly, the delimiter symbol is used as comma (,) or semi-colon (;) or any other special character. - * @Default {','} - */ + * as a separate word or query. The delimiter string is a single character and must be a symbol. Mostly, the delimiter symbol is used as comma (,) or semi-colon (;) or any other special character. + * @Default {','} + */ delimiterChar?: string; /** The enabled Animation property uses the easeOutQuad animation to SlideDown and SlideUp the Popup list in 200 and 100 milliseconds, respectively. - * @Default {false} - */ + * @Default {false} + */ enableAnimation?: boolean; /** This property is used to indicate whether the DropDownList control responds to the user interaction or not. By default, the control is in the enabled mode - * and you can disable it by setting it to false. - * @Default {true} - */ + * and you can disable it by setting it to false. + * @Default {true} + */ enabled?: boolean; /** Specifies to perform incremental search for the selection of items from the DropDownList with the help of this property. This helps in selecting the item by using the typed character. - * @Default {true} - */ + * @Default {true} + */ enableIncrementalSearch?: boolean; /** This property selects the item in the DropDownList when the item is entered in the Search textbox. - * @Default {false} - */ + * @Default {false} + */ enableFilterSearch?: boolean; /** Saves the current model value to the browser cookies for state maintenance. While refreshing the DropDownList control page, it retains the model value and - * it is applied from the browser cookies. - * @Default {false} - */ + * it is applied from the browser cookies. + * @Default {false} + */ enablePersistence?: boolean; /** This enables the resize handler to resize the popup to any size. - * @Default {false} - */ + * @Default {false} + */ enablePopupResize?: boolean; /** Sets the DropDownList textbox direction from right to left align. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** This property is used to sort the Items in the DropDownList. By default, it sorts the items in an ascending order. - * @Default {false} - */ + * @Default {false} + */ enableSorting?: boolean; /** Specifies the mapping fields for the data items of the DropDownList. - * @Default {null} - */ + * @Default {null} + */ fields?: Fields; /** When the enableFilterSearch property value is set to true, the values in the DropDownList shows the items starting with or containing the key word/letter typed in the Search textbox. - * @Default {ej.FilterType.Contains} - */ + * @Default {ej.FilterType.Contains} + */ filterType?: ej.FilterType|string; /** Used to create visualized header for dropdown items - * @Default {null} - */ + * @Default {null} + */ headerTemplate?: string; /** Defines the height of the DropDownList textbox. - * @Default {null} - */ + * @Default {null} + */ height?: string|number; /** It sets the given HTML attributes for the DropDownList control such as ID, name, disabled, etc. - * @Default {null} - */ + * @Default {null} + */ htmlAttributes?: any; /** Data can be fetched in the DropDownList control by using the DataSource, specifying the number of items. - * @Default {5} - */ + * @Default {5} + */ itemsCount?: number; /** Allows the user to set the particular country or region language for the DropDownList. - * @Default {en-US} - */ + * @Default {en-US} + */ locale?: string; /** Defines the maximum height of the suggestion box. This property restricts the maximum height of the popup when resize is enabled. - * @Default {null} - */ + * @Default {null} + */ maxPopupHeight?: string|number; /** Defines the minimum height of the suggestion box. This property restricts the minimum height of the popup when resize is enabled. - * @Default {null} - */ + * @Default {null} + */ minPopupHeight?: string|number; /** Defines the maximum width of the suggestion box. This property restricts the maximum width of the popup when resize is enabled. - * @Default {null} - */ + * @Default {null} + */ maxPopupWidth?: string|number; /** Defines the minimum height of the suggestion box. This property restricts the minimum height of the popup when resize is enabled. - * @Default {0} - */ + * @Default {0} + */ minPopupWidth?: string|number; /** With the help of this property, you can make a single or multi selection with the DropDownList and display the text in two modes, delimiter and visual mode. - * In delimiter mode, you can separate the items by using the delimiter character such as comma (,) or semi-colon (;) or any other special character. - * In the visual mode, the items are showcased like boxes with close icon in the textbox. - * @Default {ej.MultiSelectMode.None} - */ + * In delimiter mode, you can separate the items by using the delimiter character such as comma (,) or semi-colon (;) or any other special character. + * In the visual mode, the items are showcased like boxes with close icon in the textbox. + * @Default {ej.MultiSelectMode.None} + */ multiSelectMode?: ej.MultiSelectMode|string; /** Defines the height of the suggestion popup box in the DropDownList control. - * @Default {152px} - */ + * @Default {152px} + */ popupHeight?: string|number; /** Defines the width of the suggestion popup box in the DropDownList control. - * @Default {auto} - */ + * @Default {auto} + */ popupWidth?: string|number; /** Specifies the query to retrieve the data from the DataSource. - * @Default {null} - */ + * @Default {null} + */ query?: any; /** Specifies that the DropDownList textbox values should be read-only. - * @Default {false} - */ + * @Default {false} + */ readOnly?: boolean; /** Specifies an item to be selected in the DropDownList. - * @Default {null} - */ + * @Default {null} + */ selectedIndex?: number; /** Specifies the selectedItems for the DropDownList. - * @Default {[]} - */ + * @Default {[]} + */ selectedIndices?: any[]; /** Selects multiple items in the DropDownList with the help of the checkbox control. To achieve this, enable the showCheckbox option to true. - * @Default {false} - */ + * @Default {false} + */ showCheckbox?: boolean; /** DropDownList control is displayed with the popup seen. - * @Default {false} - */ + * @Default {false} + */ showPopupOnLoad?: boolean; /** DropDownList textbox displayed with the rounded corner style. - * @Default {false} - */ + * @Default {false} + */ showRoundedCorner?: boolean; /** When the enableSorting property value is set to true, this property helps to sort the items either in ascending or descending order - * @Default {ej.SortOrder.Ascending} - */ + * @Default {ej.SortOrder.Ascending} + */ sortOrder?: ej.SortOrder|string; /** Specifies the targetID for the DropDownListĂ¢â‚¬â„¢s items. - * @Default {null} - */ + * @Default {null} + */ targetID?: string; /** By default, you can add any text or image to the DropDownList item. To customize the item layout or to create your own visualized elements, you can use this template support. - * @Default {null} - */ + * @Default {null} + */ template?: string; /** Defines the text value that is displayed in the DropDownList textbox. - * @Default {null} - */ + * @Default {null} + */ text?: string|number; /** Sets the jQuery validation error message in the DropDownList - * @Default {null} - */ + * @Default {null} + */ validationMessage?: any; /** Sets the jQuery validation rules in the Dropdownlist. - * @Default {null} - */ + * @Default {null} + */ validationRules?: any; /** Specifies the value (text content) for the DropDownList control. - * @Default {null} - */ + * @Default {null} + */ value?: string|number; /** Specifies a short hint that describes the expected value of the DropDownList control. - * @Default {null} - */ + * @Default {null} + */ watermarkText?: string; /** Defines the width of the DropDownList textbox. - * @Default {null} - */ + * @Default {null} + */ width?: string|number; - /** The Virtual Scrolling feature is used to display a large amount of records in the DropDownList, that is, when scrolling, an AJAX request is sent to fetch some amount of data from - * the server dynamically. To achieve this scenario with DropDownList, set the allowVirtualScrolling to true. - * You can set the itemsCount property that represents the number of items to be fetched from the server on every AJAX request. - * @Default {normal} - */ + /** The Virtual Scrolling feature is used to display a large amount of records in the DropDownList, that is, when scrolling, an AJAX request is sent to fetch some amount of data from + * the server dynamically. To achieve this scenario with DropDownList, set the allowVirtualScrolling to true. + * You can set the itemsCount property that represents the number of items to be fetched from the server on every AJAX request. + * @Default {normal} + */ virtualScrollMode?: ej.VirtualScrollMode|string; /** Fires the action before the XHR request. */ @@ -8300,538 +8300,538 @@ export interface Model { export interface ActionBeginEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the DropDownList model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface ActionCompleteEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns number of times trying to fetch the data - */ + */ count?: number; /** returns the DropDownList model - */ + */ model?: any; /** Returns the query for data retrieval - */ + */ query?: any; /** Returns the query for data retrieval from the Database - */ + */ request?: any; /** returns the name of the event - */ + */ type?: string; /** Returns the number of items fetched from remote data - */ + */ result?: any[]; /** Returns the requested data - */ + */ xhr?: any; } export interface ActionFailureEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the error message - */ + */ error?: any; /** returns the DropDownList model - */ + */ model?: any; /** Returns the query for data retrieval - */ + */ query?: any; /** returns the name of the event - */ + */ type?: string; } export interface ActionSuccessEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns number of times trying to fetch the data - */ + */ count?: number; /** returns the DropDownList model - */ + */ model?: any; /** Returns the query for data retrieval - */ + */ query?: any; /** Returns the query for data retrieval from the Database - */ + */ request?: any; /** returns the name of the event - */ + */ type?: string; /** Returns the number of items fetched from remote data - */ + */ result?: any[]; /** Returns the requested data - */ + */ xhr?: any; } export interface BeforePopupHideEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the DropDownList model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; /** returns the selected text - */ + */ text?: string; /** returns the selected value - */ + */ value?: string; } export interface BeforePopupShownEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the DropDownList model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; /** returns the selected text - */ + */ text?: string; /** returns the selected value - */ + */ value?: string; } export interface CascadeEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the cascading dropdown model. - */ + */ cascadeModel?: any; /** returns the current selected value in first dropdown. - */ + */ cascadeValue?: string; /** returns the DropDownList model - */ + */ model?: any; /** returns the default filter action for second dropdown data should happen or not. - */ + */ requiresDefaultFilter?: boolean; /** returns the name of the event - */ + */ type?: string; } export interface ChangeEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the selected item with checkbox checked or not. - */ + */ isChecked?: boolean; /** Returns the selected item ID. - */ + */ itemId?: string; /** returns the DropDownList model - */ + */ model?: any; /** Returns the selected item text. - */ + */ selectedText?: string; /** returns the name of the event - */ + */ type?: string; /** Returns the selected text. - */ + */ text?: string; /** Returns the selected value. - */ + */ value?: string; } export interface CheckChangeEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the selected item with checkbox checked or not. - */ + */ isChecked?: boolean; /** Returns the selected item ID. - */ + */ itemId?: string; /** returns the DropDownList model - */ + */ model?: any; /** Returns the selected item text. - */ + */ selectedText?: string; /** returns the name of the event - */ + */ type?: string; /** Returns the selected text. - */ + */ text?: string; /** Returns the selected value. - */ + */ value?: string; } export interface CreateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the DropDownList model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface DataBoundEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the DropDownList model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; /** returns the data that is bound to DropDownList - */ + */ data?: any; } export interface DestroyEventArgs { /** its value is set as true,if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the DropDownList model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface FocusInEventArgs { /** its value is set as true,if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the DropDownList model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface FocusOutEventArgs { /** its value is set as true,if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the DropDownList model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface PopupHideEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the DropDownList model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; /** returns the selected text - */ + */ text?: string; /** returns the selected value - */ + */ value?: string; } export interface PopupResizeEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the DropDownList model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; /** Returns the data from the resizable plugin. - */ + */ event?: any; } export interface PopupShownEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the DropDownList model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; /** returns the selected text - */ + */ text?: string; /** returns the selected value - */ + */ value?: string; } export interface PopupResizeStartEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the DropDownList model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; /** Returns the data from the resizable plugin. - */ + */ event?: any; } export interface PopupResizeStopEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the DropDownList model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; /** Returns the data from the resizable plugin. - */ + */ event?: any; } export interface SearchEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the data bound to the DropDownList. - */ + */ items?: any; /** returns the DropDownList model - */ + */ model?: any; /** Returns the selected item text. - */ + */ selectedText?: string; /** returns the name of the event - */ + */ type?: string; /** Returns the search string typed in search box. - */ + */ searchString?: string; } export interface SelectEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the selected item with checkbox checked or not. - */ + */ isChecked?: boolean; /** Returns the selected item ID. - */ + */ itemId?: string; /** returns the DropDownList model - */ + */ model?: any; /** Returns the selected item text. - */ + */ selectedText?: string; /** returns the name of the event - */ + */ type?: string; /** Returns the selected text. - */ + */ text?: string; /** Returns the selected value. - */ + */ value?: string; } export interface Fields { /** Used to group the items. - */ + */ groupBy?: string; /** Defines the HTML attributes such as ID, class, and styles for the item. - */ + */ htmlAttributes?: any; /** Defines the ID for the tag. - */ + */ id?: string; /** Defines the image attributes such as height, width, styles, and so on. - */ + */ imageAttributes?: string; /** Defines the imageURL for the image location. - */ + */ imageUrl?: string; /** Defines the tag value to be selected initially. - */ + */ selected?: boolean; /** Defines the sprite CSS for the image tag. - */ + */ spriteCssClass?: string; /** Defines the table name for tag value or display text while rendering remote data. - */ + */ tableName?: string; /** Defines the text content for the tag. - */ + */ text?: string; /** Defines the tag value. - */ + */ value?: string; } } @@ -8864,33 +8864,33 @@ class Tooltip extends ej.Widget { defaults: Tooltip.Model; /** Destroys the Tooltip control. - * @returns {void} - */ + * @returns {void} + */ destroy(): void; /** Disables the Tooltip control. - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** Enables the Tooltip control. - * @returns {void} - */ + * @returns {void} + */ enable(): void; /** Hide the Tooltip popup. - * @param {string} optional Determines the type of effect that takes place when hiding the tooltip. - * @param {Function} optional custom effect takes place when hiding the tooltip. - * @returns {void} - */ + * @param {string} optional Determines the type of effect that takes place when hiding the tooltip. + * @param {Function} optional custom effect takes place when hiding the tooltip. + * @returns {void} + */ hide(effect?: string, func?: any): void; /** Shows the Tooltip popup for the given target element with the specified effect. - * @param {string} optional Determines the type of effect that takes place when showing the tooltip. - * @param {Function} optional custom effect takes place when showing the tooltip. - * @param {JQuery} optional Tooltip will be shown for the given element - * @returns {void} - */ + * @param {string} optional Determines the type of effect that takes place when showing the tooltip. + * @param {Function} optional custom effect takes place when showing the tooltip. + * @param {JQuery} optional Tooltip will be shown for the given element + * @returns {void} + */ show(effect?: string, func?: any, target?: JQuery): void; } export namespace Tooltip { @@ -8898,101 +8898,101 @@ export namespace Tooltip { export interface Model { /** Tooltip control can be accessed through the keyboard shortcut keys. - * @Default {true} - */ + * @Default {true} + */ allowKeyboardNavigation?: boolean; /** Specifies the animation behavior in Tooltip. It contains the following sub properties. - */ + */ animation?: Animation; /** Sets the position related to target element, window, mouse or (x,y) co-ordinates. - * @Default {ej.Tooltip.Associate.Target} - */ + * @Default {ej.Tooltip.Associate.Target} + */ associate?: ej.Tooltip.Associate|string; /** Specified the delay to hide Tooltip when closeMode is auto. - * @Default {4000} - */ + * @Default {4000} + */ autoCloseTimeout?: number; /** Specifies the closing behavior of Tooltip popup. - * @Default {ej.Tooltip.CloseMode.None} - */ + * @Default {ej.Tooltip.CloseMode.None} + */ closeMode?: ej.Tooltip.CloseMode|string; /** Sets the Tooltip in alternate position when collision occurs. - * @Default {ej.Tooltip.Collision.FlipFit} - */ + * @Default {ej.Tooltip.Collision.FlipFit} + */ collision?: ej.Tooltip.Collision|string; /** Specified the selector for the container element. - * @Default {body} - */ + * @Default {body} + */ containment?: string; /** Specifies the text for Tooltip. - * @Default {null} - */ + * @Default {null} + */ content?: string; /** Sets the root CSS class for Tooltip for the customization. - * @Default {null} - */ + * @Default {null} + */ cssClass?: string; /** Enables or disables the Tooltip. - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Sets the Tooltip direction from right to left. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Defines the height of the Tooltip popup. - * @Default {auto} - */ + * @Default {auto} + */ height?: string|number; /** Enables the arrow in Tooltip. - * @Default {true} - */ + * @Default {true} + */ isBalloon?: boolean; /** defines various attributes of the Tooltip position - */ + */ position?: Position; /** Enables or disables rounded corner. - * @Default {false} - */ + * @Default {false} + */ showRoundedCorner?: boolean; /** Enables or disables shadow effect. - * @Default {false} - */ + * @Default {false} + */ showShadow?: boolean; /** Specified a selector for elements, within the container. - * @Default {null} - */ + * @Default {null} + */ target?: string; /** The title text to be displayed in the Tooltip header. - * @Default {null} - */ + * @Default {null} + */ title?: string; /** Specified the event action to show case the Tooltip. - * @Default {ej.Tooltip.Trigger.Hover} - */ + * @Default {ej.Tooltip.Trigger.Hover} + */ trigger?: ej.Tooltip.Trigger|string; /** Defines the width of the Tooltip popup. - * @Default {auto} - */ + * @Default {auto} + */ width?: string|number; /** This event is triggered before the Tooltip widget get closed. */ @@ -9026,213 +9026,213 @@ export interface Model { export interface BeforeCloseEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the tooltip model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; /** returns the Tooltip's content - */ + */ content?: string; } export interface BeforeOpenEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Tooltip model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; /** returns the Tooltip's content - */ + */ content?: string; } export interface ClickEventArgs { /** its value is set as true,if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Tooltip model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; /** returns the event object - */ + */ event?: any; } export interface CloseEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Tooltip model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; /** returns the Tooltip's content - */ + */ content?: string; } export interface CreateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Tooltip model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface DestroyEventArgs { /** its value is set as true,if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Tooltip model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface HoverEventArgs { /** its value is set as true,if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Tooltip model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; /** returns the event object - */ + */ event?: any; } export interface OpenEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Tooltip model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; /** returns the Tooltip's content - */ + */ content?: string; } export interface TrackingEventArgs { /** its value is set as true,if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Tooltip model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; /** returns the event object - */ + */ event?: any; } export interface Animation { /** Determines the type of effect. - * @Default {ej.Tooltip.Effect.None} - */ + * @Default {ej.Tooltip.Effect.None} + */ effect?: ej.Tooltip.effect|string; /** Sets the animation speed in milliseconds. - * @Default {4000} - */ + * @Default {4000} + */ speed?: number; } export interface PositionTarget { /** Sets the Tooltip position against target based on horizontal(x) value. - * @Default {center} - */ + * @Default {center} + */ horizontal?: string|number; /** Sets the Tooltip position against target based on vertical(y) value. - * @Default {top} - */ + * @Default {top} + */ vertical?: string|number; } export interface PositionStem { /** Sets the arrow position again popup based on horizontal(x) value - * @Default {center} - */ + * @Default {center} + */ horizontal?: string; /** Sets the arrow position again popup based on vertical(y) value - * @Default {bottom} - */ + * @Default {bottom} + */ vertical?: string; } export interface Position { /** Sets the Tooltip position against target. - */ + */ target?: PositionTarget; /** Sets the arrow position again popup. - */ + */ stem?: PositionStem; } @@ -9319,23 +9319,23 @@ class Editor extends ej.Widget { defaults: Editor.Model; /** destroy the editor widgets all events are unbind automatically and bring the control to pre-init state. - * @returns {void} - */ + * @returns {void} + */ destroy(): void; /** To disable the corresponding Editors - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** To enable the corresponding Editors - * @returns {void} - */ + * @returns {void} + */ enable(): void; /** To get value from corresponding Editors - * @returns {number} - */ + * @returns {number} + */ getValue(): number; } @@ -9352,139 +9352,139 @@ export namespace Editor { export interface Model { /** Specifies the currency symbol of currency textbox, used when the user wants to overwrite the currency symbol commonly instead of the current culture symbol. - * @Default {Based on the culture} - */ + * @Default {Based on the culture} + */ currencySymbol?: string; /** Sets the root CSS class for Editors which allow us to customize the appearance. - */ + */ cssClass?: string; /** Specifies the number of digits that should be allowed after the decimal point. - * @Default {0} - */ + * @Default {0} + */ decimalPlaces?: number; /** Specifies the editor control state. - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Specify the enablePersistence to editor to save current editor control value to browser cookies for state maintenance. - * @Default {false} - */ + * @Default {false} + */ enablePersistence?: boolean; /** Specifies the Right to Left Direction to editor. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** When enableStrictMode true it allows the value outside of the range also but it highlights the textbox with error class,otherwise it internally changed to the correct value. - * @Default {false} - */ + * @Default {false} + */ enableStrictMode?: boolean; /** Specifies the number of digits in each group to the editor. - * @Default {Based on the culture.} - */ + * @Default {Based on the culture.} + */ groupSize?: string; /** It provides the options to get the customized character to separate the digits. If not set, the separator defined by the current culture. - * @Default {Based on the culture} - */ + * @Default {Based on the culture} + */ groupSeparator?: string; /** Specifies the height of the editor. - * @Default {30} - */ + * @Default {30} + */ height?: string; /** It allows to define the characteristics of the Editors control. It will helps to extend the capability of an HTML element. - * @Default {{}} - */ + * @Default {{}} + */ htmlAttributes?: any; /** The Editor value increment or decrement based an incrementStep value. - * @Default {1} - */ + * @Default {1} + */ incrementStep?: number; /** Defines the localization culture for editor. - * @Default {en-US} - */ + * @Default {en-US} + */ locale?: string; /** Specifies the maximum value of the editor. - * @Default {Number.MAX_VALUE} - */ + * @Default {Number.MAX_VALUE} + */ maxValue?: number; /** Specifies the minimum value of the editor. - * @Default {-(Number.MAX_VALUE) and 0 for Currency Textbox.} - */ + * @Default {-(Number.MAX_VALUE) and 0 for Currency Textbox.} + */ minValue?: number; /** Specifies the name of the editor. - * @Default {Sets id as name if it is null.} - */ + * @Default {Sets id as name if it is null.} + */ name?: string; /** Specifies the pattern for formatting positive values in editor.We have maintained some standard to define the negative pattern. - * you have to specify 'n' to place the digit in your pattern.ejTextbox allows you to define a currency or percent symbol where you want to place it. - * @Default {Based on the culture} - */ + * you have to specify 'n' to place the digit in your pattern.ejTextbox allows you to define a currency or percent symbol where you want to place it. + * @Default {Based on the culture} + */ negativePattern?: string; /** Specifies the pattern for formatting positive values in editor.We have maintained some standard to define the positive pattern. - * you have to specify 'n' to place the digit in your pattern.ejTextbox allows you to define a currency or percent symbol where you want to place it. - * @Default {Based on the culture} - */ + * you have to specify 'n' to place the digit in your pattern.ejTextbox allows you to define a currency or percent symbol where you want to place it. + * @Default {Based on the culture} + */ positivePattern?: string; /** Toggles the readonly state of the editor. When the Editor is readonly it doesn't allow user interactions. - * @Default {false} - */ + * @Default {false} + */ readOnly?: boolean; /** Specifies to Change the sharped edges into rounded corner for the Editor. - * @Default {false} - */ + * @Default {false} + */ showRoundedCorner?: boolean; /** Specifies whether the up and down spin buttons should be displayed in editor. - * @Default {true} - */ + * @Default {true} + */ showSpinButton?: boolean; /** Enables decimal separator position validation on type . - * @Default {false} - */ + * @Default {false} + */ validateOnType?: boolean; /** Set the jQuery validation error message in editor. - * @Default {null} - */ + * @Default {null} + */ validationMessage?: any; /** Set the jQuery validation rules to the editor. - * @Default {null} - */ + * @Default {null} + */ validationRules?: any; /** Specifies the value of the editor. - * @Default {null} - */ + * @Default {null} + */ value?: number|string; /** Specifies the watermark text to editor. - * @Default {Based on the culture.} - */ + * @Default {Based on the culture.} + */ watermarkText?: string; /** Specifies the width of the editor. - * @Default {143} - */ + * @Default {143} + */ width?: string; /** Fires after Editor control value is changed. */ @@ -9506,91 +9506,91 @@ export interface Model { export interface ChangeEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the corresponding editor model. - */ + */ model?: ej.Editor.Model; /** returns the name of the event. - */ + */ type?: string; /** returns the corresponding editor control value. - */ + */ value?: number; /** returns true when the value changed by user interaction otherwise returns false - */ + */ isInteraction?: boolean; } export interface CreateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the editor model - */ + */ model?: ej.Editor.Model; /** returns the name of the event - */ + */ type?: string; } export interface DestroyEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the editor model - */ + */ model?: ej.Editor.Model; /** returns the name of the event - */ + */ type?: string; } export interface FocusInEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the corresponding editor model. - */ + */ model?: ej.Editor.Model; /** returns the name of the event. - */ + */ type?: string; /** returns the corresponding editor control value. - */ + */ value?: number; } export interface FocusOutEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the corresponding editor model. - */ + */ model?: ej.Editor.Model; /** returns the name of the event. - */ + */ type?: string; /** returns the corresponding editor control value. - */ + */ value?: number; } } @@ -9603,150 +9603,150 @@ class ListView extends ej.Widget { defaults: ListView.Model; /** To add item in the given index. If you have enabled grouping in ListView then you need to pass the corresponding group list title to add item in it. - * @param {any} Specifies the item to be added in ListView - * @param {number} Specifies the index where item to be added - * @param {string} optionalThis is an optional parameter. You must pass the group list title here if grouping is enabled in the ListView - * @returns {void} - */ + * @param {any} Specifies the item to be added in ListView + * @param {number} Specifies the index where item to be added + * @param {string} optionalThis is an optional parameter. You must pass the group list title here if grouping is enabled in the ListView + * @returns {void} + */ addItem(item: any, index: number, groupid: string): void; /** To check all the items. - * @returns {void} - */ + * @returns {void} + */ checkAllItem(): void; /** To check item in the given index. - * @param {number} Specifies the index of the item to be checked - * @returns {void} - */ + * @param {number} Specifies the index of the item to be checked + * @returns {void} + */ checkItem(index: number): void; /** To clear all the list item in the control before updating with new datasource. - * @returns {void} - */ + * @returns {void} + */ clear(): void; /** To make the item in the given index to be default state. - * @param {number} Specifies the index to make the item to be in default state. - * @returns {void} - */ + * @param {number} Specifies the index to make the item to be in default state. + * @returns {void} + */ deActive(index: number): void; /** To disable item in the given index. - * @param {number} Specifies the index value to be disabled. - * @returns {void} - */ + * @param {number} Specifies the index value to be disabled. + * @returns {void} + */ disableItem(index: number): void; /** To enable item in the given index. - * @param {number} Specifies the index value to be enabled. - * @returns {void} - */ + * @param {number} Specifies the index value to be enabled. + * @returns {void} + */ enableItem(index: number): void; /** To get the active item. - * @returns {HTMLElement} - */ + * @returns {HTMLElement} + */ getActiveItem(): HTMLElement; /** To get the text of the active item. - * @returns {string} - */ + * @returns {string} + */ getActiveItemText(): string; /** To get all the checked items. - * @returns {Array} - */ + * @returns {Array} + */ getCheckedItems(): any[]; /** To get the text of all the checked items. - * @returns {Array} - */ + * @returns {Array} + */ getCheckedItemsText(): any[]; /** To get the total item count. - * @returns {number} - */ + * @returns {number} + */ getItemsCount(): number; /** To get the text of the item in the given index. - * @param {string|number} Specifies the index value to get the text value. - * @returns {string} - */ + * @param {string|number} Specifies the index value to get the text value. + * @returns {string} + */ getItemText(index: string|number): string; /** To check whether the item in the given index has child item. - * @param {number} Specifies the index value to check the item has child or not. - * @returns {boolean} - */ + * @param {number} Specifies the index value to check the item has child or not. + * @returns {boolean} + */ hasChild(index: number): boolean; /** To hide the list. - * @returns {void} - */ + * @returns {void} + */ hide(): void; /** To hide item in the given index. - * @param {number} Specifies the index value to hide the item. - * @returns {void} - */ + * @param {number} Specifies the index value to hide the item. + * @returns {void} + */ hideItem(index: number): void; /** To check whether item in the given index is checked. - * @returns {boolean} - */ + * @returns {boolean} + */ isChecked(): boolean; /** To load the AJAX content while selecting the item. - * @param {string} Specifies the item to load the AJAX content. - * @returns {void} - */ + * @param {string} Specifies the item to load the AJAX content. + * @returns {void} + */ loadAjaxContent(item: string): void; /** To remove the check mark either for specific item in the given index or for all items. - * @param {number} Specifies the index value to remove the checkbox. - * @returns {void} - */ + * @param {number} Specifies the index value to remove the checkbox. + * @returns {void} + */ removeCheckMark(index: number): void; /** To remove item in the given index. - * @param {number} Specifies the index value to remove the item. - * @returns {void} - */ + * @param {number} Specifies the index value to remove the item. + * @returns {void} + */ removeItem(index: number): void; /** To select item in the given index. - * @param {number} Specifies the index value to select the item. - * @returns {void} - */ + * @param {number} Specifies the index value to select the item. + * @returns {void} + */ selectItem(index: number): void; /** To make the item in the given index to be active state. - * @param {number} Specifies the index value to make the item in active state. - * @returns {void} - */ + * @param {number} Specifies the index value to make the item in active state. + * @returns {void} + */ setActive(index: number): void; /** To show the list. - * @returns {void} - */ + * @returns {void} + */ show(): void; /** To show item in the given index. - * @param {number} Specifies the index value to show the hided item. - * @returns {void} - */ + * @param {number} Specifies the index value to show the hided item. + * @returns {void} + */ showItem(index: number): void; /** To uncheck all the items. - * @returns {void} - */ + * @returns {void} + */ unCheckAllItem(): void; /** To uncheck item in the given index. - * @param {number} Specifies the index value to uncheck the item. - * @returns {void} - */ + * @param {number} Specifies the index value to uncheck the item. + * @returns {void} + */ unCheckItem(index: number): void; } export namespace ListView { @@ -9754,126 +9754,126 @@ export namespace ListView { export interface Model { /** Specifies the ajaxSettings option to load the items to the ListView control. - * @Default {null} - */ + * @Default {null} + */ ajaxSettings?: AjaxSettings; /** Set the index values to be selected on initial loading. This works only when enableCheckMark is set true. - * @Default {[]} - */ + * @Default {[]} + */ checkedIndices?: any[]; /** Sets the root class for ListView theme. This cssClass API helps to use custom skinning option for ListView control. By defining the root class using this API, - * we need to include this root class in CSS. - */ + * we need to include this root class in CSS. + */ cssClass?: string; /** Contains the list of data for generating the ListView items. - * @Default {[]} - */ + * @Default {[]} + */ dataSource?: any[]; /** Specifies whether to load AJAX content while selecting item. - * @Default {false} - */ + * @Default {false} + */ enableAjax?: boolean; /** Specifies whether to enable caching the content. - * @Default {false} - */ + * @Default {false} + */ enableCache?: boolean; /** Specifies whether to enable check mark for the item. - * @Default {false} - */ + * @Default {false} + */ enableCheckMark?: boolean; /** Specifies whether to enable the filtering feature to filter the item. - * @Default {false} - */ + * @Default {false} + */ enableFiltering?: boolean; /** Specifies whether to group the list item. - * @Default {false} - */ + * @Default {false} + */ enableGroupList?: boolean; /** Specifies to maintain the current model value to browser cookies for state maintenance. While refresh the page, the model value will get apply to the control from browser cookies. - * @Default {false} - */ + * @Default {false} + */ enablePersistence?: boolean; /** Specifies the field settings to map the datasource. - */ + */ fieldSettings?: any; /** Contains the array of items to be added in ListView. - * @Default {[]} - */ + * @Default {[]} + */ items?: any[]; /** Specifies the text of the back button in the header. - * @Default {null} - */ + * @Default {null} + */ headerBackButtonText?: string; /** Specifies the title of the header. - * @Default {Title} - */ + * @Default {Title} + */ headerTitle?: string; /** Specifies the height. - * @Default {null} - */ + * @Default {null} + */ height?: string|number; /** Set the localization culture for ListView Widget. - */ + */ locale?: string; /** Specifies whether to retain the selection of the item. - * @Default {false} - */ + * @Default {false} + */ persistSelection?: boolean; /** Specifies whether to prevent the selection of the item. - * @Default {false} - */ + * @Default {false} + */ preventSelection?: boolean; /** Specifies the query to execute with the datasource. - * @Default {null} - */ + * @Default {null} + */ query?: any; /** Specifies whether need to render the control with the template contents. - * @Default {false} - */ + * @Default {false} + */ renderTemplate?: boolean; /** Specifies the index of item which need to be in selected state initially while loading. - * @Default {0} - */ + * @Default {0} + */ selectedItemIndex?: number; /** Specifies whether to show the header. - * @Default {true} - */ + * @Default {true} + */ showHeader?: boolean; /** Specifies whether to show the back button header. - * @Default {false} - */ + * @Default {false} + */ showHeaderBackButton?: boolean; /** Specifies ID of the element contains template contents. - * @Default {null} - */ + * @Default {null} + */ templateId?: string; /** Specifies the width. - * @Default {null} - */ + * @Default {null} + */ width?: string|number; /** Event triggers before the AJAX request happens. */ @@ -9904,247 +9904,247 @@ export interface Model { export interface AjaxBeforeLoadEventArgs { /** returns true if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the name of the event. - */ + */ type?: string; /** returns the model value of the control. - */ + */ model?: ej.ListView.Model; /** returns the AJAX settings. - */ + */ ajaxData?: any; } export interface AjaxCompleteEventArgs { /** returns true if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the name of the event. - */ + */ type?: string; /** returns the model value of the control. - */ + */ model?: ej.ListView.Model; } export interface AjaxErrorEventArgs { /** returns true if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the name of the event. - */ + */ type?: string; /** returns the model value of the control. - */ + */ model?: ej.ListView.Model; /** returns the error thrown in the AJAX post. - */ + */ errorThrown?: any; /** returns the status. - */ + */ textStatus?: any; /** returns the current list item. - */ + */ item?: any; /** returns the current item text. - */ + */ text?: string; /** returns the current item index. - */ + */ index?: number; } export interface AjaxSuccessEventArgs { /** returns true if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the name of the event. - */ + */ type?: string; /** returns the model value of the control. - */ + */ model?: ej.ListView.Model; /** returns the AJAX current content. - */ + */ content?: string; /** returns the current list item. - */ + */ item?: any; /** returns the current item text. - */ + */ text?: string; /** returns the current item index. - */ + */ index?: number; /** returns the current URL of the AJAX post. - */ + */ URL?: string; } export interface LoadEventArgs { /** returns true if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the name of the event. - */ + */ type?: string; /** returns the model value of the control. - */ + */ model?: ej.ListView.Model; } export interface LoadCompleteEventArgs { /** returns true if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the name of the event. - */ + */ type?: string; /** returns the model value of the control. - */ + */ model?: ej.ListView.Model; } export interface MouseDownEventArgs { /** returns true if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the name of the event. - */ + */ type?: string; /** returns the model value of the control. - */ + */ model?: ej.ListView.Model; /** If the child element exist return true; otherwise, false. - */ + */ hasChild?: boolean; /** returns the current list item. - */ + */ item?: string; /** returns the current text of item. - */ + */ text?: string; /** returns the current Index of the item. - */ + */ index?: number; /** If checked return true; otherwise, false. - */ + */ isChecked?: boolean; /** returns the list of checked items. - */ + */ checkedItems?: number; /** returns the current checked item text. - */ + */ checkedItemsText?: string; } export interface MouseUpEventArgs { /** returns true if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the name of the event. - */ + */ type?: string; /** returns the model value of the control. - */ + */ model?: ej.ListView.Model; /** If the child element exist return true; otherwise, false. - */ + */ hasChild?: boolean; /** returns the current list item. - */ + */ item?: string; /** returns the current text of item. - */ + */ text?: string; /** returns the current Index of the item. - */ + */ index?: number; /** If checked return true; otherwise, false. - */ + */ isChecked?: boolean; /** returns the list of checked items. - */ + */ checkedItems?: number; /** returns the current checked item text. - */ + */ checkedItemsText?: string; } export interface AjaxSettings { /** It specifies, whether to enable or disable asynchronous request. - */ + */ async?: boolean; /** It specifies the page will be cached in the web browser. - */ + */ cache?: boolean; /** It specifies the type of data is send in the query string. - */ + */ contentType?: string; /** It specifies the data as an object, will be passed in the query string. - */ + */ data?: any; /** It specifies the type of data that you're expecting back from the response. - */ + */ dataType?: string; /** It specifies the HTTP request type. - */ + */ type?: string; } } @@ -10157,28 +10157,28 @@ class MaskEdit extends ej.Widget { defaults: MaskEdit.Model; /** To clear the text in mask edit textbox control. - * @returns {void} - */ + * @returns {void} + */ clear(): void; /** To disable the mask edit textbox control. - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** To enable the mask edit textbox control. - * @returns {void} - */ + * @returns {void} + */ enable(): void; /** To obtained the pure value of the text value, removes all the symbols in mask edit textbox control. - * @returns {string} - */ + * @returns {string} + */ get_StrippedValue(): string; /** To obtained the textbox value as such that, Just replace all '_' to ' '(space) in mask edit textbox control. - * @returns {string} - */ + * @returns {string} + */ get_UnstrippedValue(): string; } export namespace MaskEdit { @@ -10186,102 +10186,102 @@ export namespace MaskEdit { export interface Model { /** Specify the cssClass to achieve custom theme. - * @Default {null} - */ + * @Default {null} + */ cssClass?: string; /** Specify the custom character allowed to entered in mask edit textbox control. - * @Default {null} - */ + * @Default {null} + */ customCharacter?: string; /** Specify the state of the mask edit textbox control. - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Specify the enablePersistence to mask edit textbox to save current model value to browser cookies for state maintains. - */ + */ enablePersistence?: boolean; /** Specifies the height for the mask edit textbox control. - * @Default {28 px} - */ + * @Default {28 px} + */ height?: string; /** Specifies whether hide the prompt characters with spaces on blur. Prompt chars will be shown again on focus the textbox. - * @Default {false} - */ + * @Default {false} + */ hidePromptOnLeave?: boolean; /** Specifies the list of HTML attributes to be added to mask edit textbox. - * @Default {{}} - */ + * @Default {{}} + */ htmlAttributes?: any; /** Specify the inputMode for mask edit textbox control. See InputMode - * @Default {ej.InputMode.Text} - */ + * @Default {ej.InputMode.Text} + */ inputMode?: ej.InputMode|string; /** Specifies the input mask. - * @Default {null} - */ + * @Default {null} + */ maskFormat?: string; /** Specifies the name attribute value for the mask edit textbox. - * @Default {null} - */ + * @Default {null} + */ name?: string; /** Toggles the readonly state of the mask edit textbox. When the mask edit textbox is readonly, it doesn't allow your input. - * @Default {false} - */ + * @Default {false} + */ readOnly?: boolean; /** Specifies whether the error will show until correct value entered in the mask edit textbox control. - * @Default {false} - */ + * @Default {false} + */ showError?: boolean; /** when showPromptChar is true, the hide the prompt characters are shown in focus of the control and hides in focus out of the control. - * @Default {true} - */ + * @Default {true} + */ showPromptChar?: boolean; /** MaskEdit input is displayed in rounded corner style when this property is set to true. - * @Default {false} - */ + * @Default {false} + */ showRoundedCorner?: boolean; /** Specify the text alignment for mask edit textbox control.See TextAlign - * @Default {left} - */ + * @Default {left} + */ textAlign?: ej.TextAlign|string; /** Sets the jQuery validation error message in mask edit. This property works when the widget is present inside the form. Include jquery.validate.min.js plugin additionally. - * @Default {null} - */ + * @Default {null} + */ validationMessage?: any; /** Sets the jQuery validation rules to the MaskEdit. This property works when the widget is present inside the form. Include jquery.validate.min.js plugin additionally. - * @Default {null} - */ + * @Default {null} + */ validationRules?: any; /** Specifies the value for the mask edit textbox control. - * @Default {null} - */ + * @Default {null} + */ value?: string; /** Specifies the water mark text to be displayed in input text. - * @Default {null} - */ + * @Default {null} + */ watermarkText?: string; /** Specifies the width for the mask edit textbox control. - * @Default {143pixel} - */ + * @Default {143pixel} + */ width?: string; /** Fires when value changed in mask edit textbox control. */ @@ -10318,214 +10318,214 @@ export interface Model { export interface ChangeEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the mask edit model - */ + */ model?: ej.MaskEdit.Model; /** returns the name of the event - */ + */ type?: string; /** returns the mask edit value - */ + */ value?: number; /** returns unstripped value in mask edit textbox control. - */ + */ unmaskedValue?: string; } export interface CreateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the MaskEdit model - */ + */ model?: ej.MaskEdit.Model; /** returns the name of the event - */ + */ type?: string; } export interface DestroyEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the MaskEdit model - */ + */ model?: ej.MaskEdit.Model; /** returns the name of the event - */ + */ type?: string; } export interface FocusInEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the mask edit model - */ + */ model?: ej.MaskEdit.Model; /** returns the name of the event - */ + */ type?: string; /** returns the mask edit value - */ + */ value?: number; /** returns unstripped value in mask edit textbox control. - */ + */ unmaskedValue?: string; } export interface FocusOutEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the mask edit model - */ + */ model?: ej.MaskEdit.Model; /** returns the name of the event - */ + */ type?: string; /** returns the mask edit value - */ + */ value?: number; /** returns unstripped value in mask edit textbox control. - */ + */ unmaskedValue?: string; } export interface KeydownEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the mask edit model - */ + */ model?: ej.MaskEdit.Model; /** returns the name of the event - */ + */ type?: string; /** returns the mask edit value - */ + */ value?: number; /** returns unstripped value in mask edit textbox control. - */ + */ unmaskedValue?: string; } export interface KeyPressEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the mask edit model - */ + */ model?: ej.MaskEdit.Model; /** returns the name of the event - */ + */ type?: string; /** returns the mask edit value - */ + */ value?: number; /** returns unstripped value in mask edit textbox control. - */ + */ unmaskedValue?: string; } export interface KeyupEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the mask edit model - */ + */ model?: ej.MaskEdit.Model; /** returns the name of the event - */ + */ type?: string; /** returns the mask edit value - */ + */ value?: number; /** returns unstripped value in mask edit textbox control. - */ + */ unmaskedValue?: string; } export interface MouseOutEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the mask edit model - */ + */ model?: ej.MaskEdit.Model; /** returns the name of the event - */ + */ type?: string; /** returns the mask edit value - */ + */ value?: number; /** returns unstripped value in mask edit textbox control. - */ + */ unmaskedValue?: string; } export interface MouseOverEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the mask edit model - */ + */ model?: ej.MaskEdit.Model; /** returns the name of the event - */ + */ type?: string; /** returns the mask edit value - */ + */ value?: number; /** returns unstripped value in mask edit textbox control. - */ + */ unmaskedValue?: string; } } @@ -10554,88 +10554,88 @@ class Menu extends ej.Widget { defaults: Menu.Model; /** Disables the Menu control. - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** Specifies the Menu Item to be disabled by using the Menu Item Text. - * @param {string} Specifies the Menu Item Text to be disabled. - * @returns {void} - */ + * @param {string} Specifies the Menu Item Text to be disabled. + * @returns {void} + */ disableItem(itemtext: string): void; /** Specifies the Menu Item to be disabled by using the Menu Item Id. - * @param {string|number} Specifies the Menu Item id to be disabled - * @returns {void} - */ + * @param {string|number} Specifies the Menu Item id to be disabled + * @returns {void} + */ disableItemByID(itemid: string|number): void; /** Enables the Menu control. - * @returns {void} - */ + * @returns {void} + */ enable(): void; /** Specifies the Menu Item to be enabled by using the Menu Item Text. - * @param {string} Specifies the Menu Item Text to be enabled. - * @returns {void} - */ + * @param {string} Specifies the Menu Item Text to be enabled. + * @returns {void} + */ enableItem(itemtext: string): void; /** Specifies the Menu Item to be enabled by using the Menu Item Id. - * @param {string|number} Specifies the Menu Item id to be enabled. - * @returns {void} - */ + * @param {string|number} Specifies the Menu Item id to be enabled. + * @returns {void} + */ enableItemByID(itemid: string|number): void; /** Hides the Context Menu control. - * @returns {void} - */ + * @returns {void} + */ hide(): void; /** Hides the specific items in Menu control. - * @returns {void} - */ + * @returns {void} + */ hideItems(): void; /** Insert the menu item as child of target node. - * @param {any} Information about Menu item. - * @param {string|any} Selector of target node or Object of target node. - * @returns {void} - */ + * @param {any} Information about Menu item. + * @param {string|any} Selector of target node or Object of target node. + * @returns {void} + */ insert(item: any, target: string|any): void; /** Insert the menu item after the target node. - * @param {any} Information about Menu item. - * @param {string|any} Selector of target node or Object of target node. - * @returns {void} - */ + * @param {any} Information about Menu item. + * @param {string|any} Selector of target node or Object of target node. + * @returns {void} + */ insertAfter(item: any, target: string|any): void; /** Insert the menu item before the target node. - * @param {any} Information about Menu item. - * @param {string|any} Selector of target node or Object of target node. - * @returns {void} - */ + * @param {any} Information about Menu item. + * @param {string|any} Selector of target node or Object of target node. + * @returns {void} + */ insertBefore(item: any, target: string|any): void; /** Remove Menu item. - * @param {any|Array} Selector of target node or Object of target node. - * @returns {void} - */ + * @param {any|Array} Selector of target node or Object of target node. + * @returns {void} + */ remove(target: any|any[]): void; /** To show the Menu control. - * @param {number} x co-ordinate position of context menu. - * @param {number} y co-ordinate position of context menu. - * @param {any} target element - * @param {any} name of the event - * @returns {void} - */ + * @param {number} x co-ordinate position of context menu. + * @param {number} y co-ordinate position of context menu. + * @param {any} target element + * @param {any} name of the event + * @returns {void} + */ show(locationX: number, locationY: number, targetElement: any, event: any): void; /** Show the specific items in Menu control. - * @returns {void} - */ + * @returns {void} + */ showItems(): void; } export namespace Menu { @@ -10643,117 +10643,117 @@ export namespace Menu { export interface Model { /** To enable or disable the Animation while hover or click an menu items.See AnimationType - * @Default {ej.AnimationType.Default} - */ + * @Default {ej.AnimationType.Default} + */ animationType?: ej.AnimationType|string; /** Specifies the target id of context menu. On right clicking the specified contextTarget element, context menu gets shown. - * @Default {null} - */ + * @Default {null} + */ contextMenuTarget?: string; /** Specify the CSS class to achieve custom theme. - */ + */ cssClass?: string; /** To enable or disable the Animation effect while hover or click an menu items. - * @Default {true} - */ + * @Default {true} + */ enableAnimation?: boolean; /** Specifies the root menu items to be aligned center in horizontal menu. - * @Default {false} - */ + * @Default {false} + */ enableCenterAlign?: boolean; /** Enable / Disable the Menu control. - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Specifies the menu items to be displayed in right to left direction. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** When this property sets to false, the menu items is displayed without any separators. - * @Default {true} - */ + * @Default {true} + */ enableSeparator?: boolean; /** Specifies the target which needs to be excluded. i.e., The context menu will not be displayed in those specified targets. - * @Default {null} - */ + * @Default {null} + */ excludeTarget?: string; /** Fields used to bind the data source and it includes following field members to make data bind easier. - * @Default {null} - */ + * @Default {null} + */ fields?: Fields; /** Specifies the height of the root menu. - * @Default {auto} - */ + * @Default {auto} + */ height?: string|number; /** Specifies the list of HTML attributes to be added to menu control. - * @Default {{}} - */ + * @Default {{}} + */ htmlAttributes?: any; /** Enables/disables responsive support for the Menu control during the window resizing time. - * @Default {true} - */ + * @Default {true} + */ isResponsive?: boolean; /** Specifies the type of the menu. Essential JavaScript Menu consists of two type of menu, they are Normal Menu and Context Menu mode.See MenuType - * @Default {ej.MenuType.NormalMenu} - */ + * @Default {ej.MenuType.NormalMenu} + */ menuType?: string|ej.MenuType; /** Specifies the sub menu items to be show or open only on click. - * @Default {false} - */ + * @Default {false} + */ openOnClick?: boolean; /** Specifies the orientation of normal menu. Normal menu can rendered in horizontal or vertical direction by using this API. See Orientation - * @Default {ej.Orientation.Horizontal} - */ + * @Default {ej.Orientation.Horizontal} + */ orientation?: ej.Orientation|string; /** Specifies the main menu items arrows only to be shown if it contains child items. - * @Default {true} - */ + * @Default {true} + */ showRootLevelArrows?: boolean; /** Specifies the sub menu items arrows only to be shown if it contains child items. - * @Default {true} - */ + * @Default {true} + */ showSubLevelArrows?: boolean; /** Specifies position of pull down submenu that will appear on mouse over.See Direction - * @Default {ej.Direction.Right} - */ + * @Default {ej.Direction.Right} + */ subMenuDirection?: string|ej.Direction; /** Specifies the title to responsive menu. - * @Default {Menu} - */ + * @Default {Menu} + */ titleText?: string; /** Specifies the width of the main menu. - * @Default {auto} - */ + * @Default {auto} + */ width?: string|number; /** Specifies the popup menu height. - * @Default {auto} - */ + * @Default {auto} + */ overflowHeight?: string|number; /** Specifies the popup menu width. - * @Default {auto} - */ + * @Default {auto} + */ overflowWidth?: string|number; /** Fires before context menu gets open. */ @@ -10793,260 +10793,260 @@ export interface Model { export interface BeforeOpenEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the menu model - */ + */ model?: ej.Menu.Model; /** returns the name of the event - */ + */ type?: string; /** returns the target element - */ + */ target?: any; } export interface ClickEventArgs { /** returns the menu model - */ + */ model?: ej.Menu.Model; /** returns the name of the event - */ + */ type?: string; /** returns clicked menu item text - */ + */ text?: string; /** returns clicked menu item element - */ + */ element?: any; /** returns the event - */ + */ event?: any; /** returns the selected item - */ + */ selectedItem?: number; } export interface CloseEventArgs { /** returns the menu model - */ + */ model?: ej.Menu.Model; /** returns the name of the event - */ + */ type?: string; /** returns the target element - */ + */ target?: any; } export interface OpenEventArgs { /** returns the menu model - */ + */ model?: ej.Menu.Model; /** returns the name of the event - */ + */ type?: string; /** returns the target element - */ + */ target?: any; } export interface CreateEventArgs { /** returns the menu model - */ + */ model?: ej.Menu.Model; /** returns the name of the event - */ + */ type?: string; } export interface DestroyEventArgs { /** returns the menu model - */ + */ model?: ej.Menu.Model; /** returns the name of the event - */ + */ type?: string; } export interface KeydownEventArgs { /** returns the menu model - */ + */ model?: ej.Menu.Model; /** returns the name of the event - */ + */ type?: string; /** returns clicked menu item text - */ + */ menuText?: string; /** returns clicked menu item element - */ + */ element?: any; /** returns the event - */ + */ event?: any; } export interface MouseoutEventArgs { /** returns the menu model - */ + */ model?: ej.Menu.Model; /** returns the name of the event - */ + */ type?: string; /** returns clicked menu item text - */ + */ text?: string; /** returns clicked menu item element - */ + */ element?: any; /** returns the event - */ + */ event?: any; } export interface MouseoverEventArgs { /** returns the menu model - */ + */ model?: ej.Menu.Model; /** returns the name of the event - */ + */ type?: string; /** returns clicked menu item text - */ + */ text?: string; /** returns clicked menu item element - */ + */ element?: any; /** returns the event - */ + */ event?: any; } export interface OverflowOpenEventArgs { /** returns the menu model - */ + */ model?: ej.Menu.Model; /** returns the name of the event - */ + */ type?: string; /** returns the event object - */ + */ e?: any; /** if the event should be cancelled ; otherwise ,false - */ + */ cancel?: boolean; } export interface OverflowCloseEventArgs { /** returns the menu model - */ + */ model?: ej.Menu.Model; /** returns the name of the event - */ + */ type?: string; /** returns the event object - */ + */ e?: any; /** if the event should be cancelled ; otherwise ,false - */ + */ cancel?: boolean; } export interface Fields { /** It receives the child data for the inner level. - */ + */ child?: any; /** It receives datasource as Essential DataManager object and JSON object. - */ + */ dataSource?: any; /** Specifies the HTML attributes to Ă¢â‚¬Å“LIĂ¢â‚¬Â item list. - */ + */ htmlAttribute?: string; /** Specifies the id to menu items list - */ + */ id?: string; /** Specifies the image attribute to Ă¢â‚¬Å“imgĂ¢â‚¬Â tag inside items list. - */ + */ imageAttribute?: string; /** Specifies the image URL to Ă¢â‚¬Å“imgĂ¢â‚¬Â tag inside item list. - */ + */ imageUrl?: string; /** Adds custom attributes like "target" to the anchor tag of the menu items. - */ + */ linkAttribute?: string; /** Specifies the parent id of the table. - */ + */ parentId?: string; /** It receives query to retrieve data from the table (query is same as SQL). - */ + */ query?: any; /** Specifies the sprite CSS class to Ă¢â‚¬Å“LIĂ¢â‚¬Â item list. - */ + */ spriteCssClass?: string; /** It receives table name to execute query on the corresponding table. - */ + */ tableName?: string; /** Specifies the text of menu items list. - */ + */ text?: string; /** Specifies the URL to the anchor tag in menu item list. - */ + */ url?: string; } } @@ -11079,14 +11079,14 @@ class Pager extends ej.Widget { defaults: Pager.Model; /** Send a paging request to specified page through the pager control. - * @param {number} Specifies the index to be navigated - * @returns {void} - */ + * @param {number} Specifies the index to be navigated + * @returns {void} + */ gotoPage(pageIndex: number): void; /** refreshPager() helps to refresh the model value of pager control. - * @returns {void} - */ + * @returns {void} + */ refreshPager(): void; } export namespace Pager { @@ -11094,62 +11094,62 @@ export namespace Pager { export interface Model { /** Gets or sets a value that indicates whether to display the custom text message in Pager. - */ + */ customText?: string; /** Gets or sets a value that indicates whether to define which page to display currently in pager. - * @Default {1} - */ + * @Default {1} + */ currentPage?: number; /** Gets or sets a value that indicates whether to display the external Message in Pager. - * @Default {false} - */ + * @Default {false} + */ enableExternalMessage?: boolean; /** Gets or sets a value that indicates whether to pass the current page information as a query string along with the URL while navigating to other page. - * @Default {false} - */ + * @Default {false} + */ enableQueryString?: boolean; /** Align content in the pager control from right to left by setting the property as true. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Gets or sets a value that indicates whether to display the external Message in Pager. - */ + */ externalMessage?: string; /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. - * in a language and culture specific to a particular country or region. - * @Default {en-US} - */ + * in a language and culture specific to a particular country or region. + * @Default {en-US} + */ locale?: string; /** Gets or sets a value that indicates whether to define the number of pages displayed in the pager for navigation. - * @Default {10} - */ + * @Default {10} + */ pageCount?: number; /** Gets or sets a value that indicates whether to define the number of records displayed per page. - * @Default {12} - */ + * @Default {12} + */ pageSize?: number; /** Get or sets a value of total number of pages in the pager. The totalPages value is calculated based on page size and total records. - * @Default {null} - */ + * @Default {null} + */ totalPages?: number; /** Get the value of total number of records which is bound to a data item. - * @Default {null} - */ + * @Default {null} + */ totalRecordsCount?: number; /** Shows or hides the current page information in pager footer. - * @Default {true} - */ + * @Default {true} + */ showPageInfo?: boolean; /** Triggered when pager numeric item is clicked in pager control. */ @@ -11159,23 +11159,23 @@ export interface Model { export interface ClickEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the current page index. - */ + */ currentPage?: number; /** Returns the pager model. - */ + */ model?: any; /** Returns the name of event - */ + */ type?: string; /** Returns current action event type and its target. - */ + */ event?: any; } } @@ -11188,28 +11188,28 @@ class ProgressBar extends ej.Widget { defaults: ProgressBar.Model; /** Destroy the progressbar widget - * @returns {void} - */ + * @returns {void} + */ destroy(): void; /** Disables the progressbar control - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** Enables the progressbar control - * @returns {void} - */ + * @returns {void} + */ enable(): void; /** Returns the current progress value in percent. - * @returns {number} - */ + * @returns {number} + */ getPercentage(): number; /** Returns the current progress value - * @returns {number} - */ + * @returns {number} + */ getValue(): number; } export namespace ProgressBar { @@ -11217,68 +11217,68 @@ export namespace ProgressBar { export interface Model { /** Sets the root CSS class for ProgressBar theme, which is used customize. - * @Default {null} - */ + * @Default {null} + */ cssClass?: string; /** When this property sets to false, it disables the ProgressBar control - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Save current model value to browser cookies for state maintains. While refresh the progressBar control page retains the model value apply from browser cookies - * @Default {false} - */ + * @Default {false} + */ enablePersistence?: boolean; /** Sets the ProgressBar direction as right to left alignment. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Defines the height of the ProgressBar. - * @Default {null} - */ + * @Default {null} + */ height?: number|string; /** It allows to define the characteristics of the progressBar control. It will helps to extend the capability of an HTML element. - * @Default {{}} - */ + * @Default {{}} + */ htmlAttributes?: any; /** Sets the maximum value of the ProgressBar. - * @Default {100} - */ + * @Default {100} + */ maxValue?: number; /** Sets the minimum value of the ProgressBar. - * @Default {0} - */ + * @Default {0} + */ minValue?: number; /** Sets the ProgressBar value in percentage. The value should be in between 0 to 100. - * @Default {0} - */ + * @Default {0} + */ percentage?: number; /** Displays rounded corner borders on the progressBar control. - * @Default {false} - */ + * @Default {false} + */ showRoundedCorner?: boolean; /** Sets the custom text for the ProgressBar. The text placed in the middle of the ProgressBar and it can be customizable using the class 'e-progress-text'. - * @Default {null} - */ + * @Default {null} + */ text?: string; /** Sets the ProgressBar value. The value should be in between min and max values. - * @Default {0} - */ + * @Default {0} + */ value?: number; /** Defines the width of the ProgressBar. - * @Default {null} - */ + * @Default {null} + */ width?: number|string; /** Event triggers when the progress value changed */ @@ -11300,99 +11300,99 @@ export interface Model { export interface ChangeEventArgs { /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the ProgressBar model - */ + */ model?: ej.ProgressBar.Model; /** returns the current progress percentage - */ + */ percentage?: any; /** returns the name of the event - */ + */ type?: string; /** returns the current progress value - */ + */ value?: string; } export interface CompleteEventArgs { /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the ProgressBar model - */ + */ model?: ej.ProgressBar.Model; /** returns the current progress percentage - */ + */ percentage?: any; /** returns the name of the event - */ + */ type?: string; /** returns the current progress value - */ + */ value?: string; } export interface CreateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the progressbar model - */ + */ model?: ej.ProgressBar.Model; /** returns the name of the event - */ + */ type?: string; } export interface DestroyEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the progressbar model - */ + */ model?: ej.ProgressBar.Model; /** returns the name of the event - */ + */ type?: string; } export interface StartEventArgs { /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the ProgressBar model - */ + */ model?: ej.ProgressBar.Model; /** returns the current progress percentage - */ + */ percentage?: any; /** returns the name of the event - */ + */ type?: string; /** returns the current progress value - */ + */ value?: string; } } @@ -11405,13 +11405,13 @@ class RadioButton extends ej.Widget { defaults: RadioButton.Model; /** To disable the RadioButton - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** To enable the RadioButton - * @returns {void} - */ + * @returns {void} + */ enable(): void; } export namespace RadioButton { @@ -11419,72 +11419,72 @@ export namespace RadioButton { export interface Model { /** Specifies the check attribute of the Radio Button. - * @Default {false} - */ + * @Default {false} + */ checked?: boolean; /** Specify the CSS class to RadioButton to achieve custom theme. - */ + */ cssClass?: string; /** Specifies the RadioButton control state. - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Specifies the enablePersistence property for RadioButton while initialization. The enablePersistence API save current model value to browser cookies for state maintains. - * While refreshing the radio button control page the model value apply from browser cookies. - * @Default {false} - */ + * While refreshing the radio button control page the model value apply from browser cookies. + * @Default {false} + */ enablePersistence?: boolean; /** Specify the Right to Left direction to RadioButton - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Specifies the HTML Attributes of the Checkbox - * @Default {{}} - */ + * @Default {{}} + */ htmlAttributes?: any; /** Specifies the id attribute for the Radio Button while initialization. - * @Default {null} - */ + * @Default {null} + */ id?: string; /** Specify the idPrefix value to be added before the current id of the RadioButton. - * @Default {ej} - */ + * @Default {ej} + */ idPrefix?: string; /** Specifies the name attribute for the Radio Button while initialization. - * @Default {Sets id as name if it is null} - */ + * @Default {Sets id as name if it is null} + */ name?: string; /** Specifies the size of the RadioButton. - * @Default {small} - */ + * @Default {small} + */ size?: ej.RadioButtonSize|string; /** Specifies the text content for RadioButton. - */ + */ text?: string; /** Set the jQuery validation error message in radio button. - * @Default {null} - */ + * @Default {null} + */ validationMessage?: any; /** Set the jQuery validation rules in radio button. - * @Default {null} - */ + * @Default {null} + */ validationRules?: any; /** Specifies the value attribute of the Radio Button. - * @Default {null} - */ + * @Default {null} + */ value?: string; /** Fires before the RadioButton is going to changed its state successfully */ @@ -11503,76 +11503,76 @@ export interface Model { export interface BeforeChangeEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the RadioButton model - */ + */ model?: ej.RadioButton.Model; /** returns the name of the event - */ + */ type?: string; /** returns true if element is checked, otherwise returns false - */ + */ isChecked?: boolean; /** returns true if change event triggered by interaction, otherwise returns false - */ + */ isInteraction?: boolean; } export interface ChangeEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the RadioButton model - */ + */ model?: ej.RadioButton.Model; /** returns the name of the event - */ + */ type?: string; /** returns true if element is checked, otherwise returns false - */ + */ isChecked?: boolean; /** returns true if change event triggered by interaction, otherwise returns false - */ + */ isInteraction?: boolean; } export interface CreateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the RadioButton model - */ + */ model?: ej.RadioButton.Model; /** returns the name of the event - */ + */ type?: string; } export interface DestroyEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the RadioButton model - */ + */ model?: ej.RadioButton.Model; /** returns the name of the event - */ + */ type?: string; } } @@ -11591,39 +11591,39 @@ class Rating extends ej.Widget { defaults: Rating.Model; /** Destroy the Rating widget all events bound will be unbind automatically and bring the control to pre-init state. - * @returns {void} - */ + * @returns {void} + */ destroy(): void; /** To get the current value of rating control. - * @returns {number} - */ + * @returns {number} + */ getValue(): number; /** To hide the rating control. - * @returns {void} - */ + * @returns {void} + */ hide(): void; /** User can refresh the rating control to identify changes. - * @returns {void} - */ + * @returns {void} + */ refresh(): void; /** To reset the rating value. - * @returns {void} - */ + * @returns {void} + */ reset(): void; /** To set the rating value. - * @param {string|number} Specifies the rating value. - * @returns {void} - */ + * @param {string|number} Specifies the rating value. + * @returns {void} + */ setValue(value: string|number): void; /** To show the rating control - * @returns {void} - */ + * @returns {void} + */ show(): void; } export namespace Rating { @@ -11631,87 +11631,87 @@ export namespace Rating { export interface Model { /** Enables the rating control with reset button.It can be used to reset the rating control value. - * @Default {true} - */ + * @Default {true} + */ allowReset?: boolean; /** Specify the CSS class to achieve custom theme. - */ + */ cssClass?: string; /** When this property is set to false, it disables the rating control. - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Save current model value to browser cookies for state maintenance. While refresh the page Rating control values are retained. - * @Default {false} - */ + * @Default {false} + */ enablePersistence?: boolean; /** Specifies the height of the Rating control wrapper. - * @Default {null} - */ + * @Default {null} + */ height?: string; /** Specifies the list of HTML attributes to be added to rating control. - * @Default {{}} - */ + * @Default {{}} + */ htmlAttributes?: any; /** Specifies the value to be increased while navigating between shapes(stars) in Rating control. - * @Default {1} - */ + * @Default {1} + */ incrementStep?: number; /** Allow to render the maximum number of Rating shape(star). - * @Default {5} - */ + * @Default {5} + */ maxValue?: number; /** Allow to render the minimum number of Rating shape(star). - * @Default {0} - */ + * @Default {0} + */ minValue?: number; /** Specifies the orientation of Rating control. See Orientation - * @Default {ej.Rating.Orientation.Horizontal} - */ + * @Default {ej.Rating.Orientation.Horizontal} + */ orientation?: ej.Orientation|string; /** Helps to provide more precise ratings.Rating control supports three precision modes - full, half, and exact. See Precision - * @Default {full} - */ + * @Default {full} + */ precision?: ej.Rating.Precision|string; /** Interaction with Rating control can be prevented by enabling this API. - * @Default {false} - */ + * @Default {false} + */ readOnly?: boolean; /** To specify the height of each shape in Rating control. - * @Default {23} - */ + * @Default {23} + */ shapeHeight?: number; /** To specify the width of each shape in Rating control. - * @Default {23} - */ + * @Default {23} + */ shapeWidth?: number; /** Enables the tooltip option.Currently selected value will be displayed in tooltip. - * @Default {true} - */ + * @Default {true} + */ showTooltip?: boolean; /** To specify the number of stars to be selected while rendering. - * @Default {1} - */ + * @Default {1} + */ value?: number; /** Specifies the width of the Rating control wrapper. - * @Default {null} - */ + * @Default {null} + */ width?: string; /** Fires when Rating value changes. */ @@ -11736,126 +11736,126 @@ export interface Model { export interface ChangeEventArgs { /** returns the current value. - */ + */ value?: number; /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the rating model - */ + */ model?: ej.Rating.Model; /** returns the name of the event - */ + */ type?: string; /** returns the mouse click event args values. - */ + */ event?: any; } export interface ClickEventArgs { /** returns the current value. - */ + */ value?: number; /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the rating model - */ + */ model?: ej.Rating.Model; /** returns the name of the event - */ + */ type?: string; /** returns the mouse click event args values. - */ + */ event?: any; } export interface CreateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the rating model - */ + */ model?: ej.Rating.Model; /** returns the name of the event. - */ + */ type?: string; } export interface DestroyEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the rating model - */ + */ model?: ej.Rating.Model; /** returns the name of the event - */ + */ type?: string; } export interface MouseoutEventArgs { /** returns the current value. - */ + */ value?: number; /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the rating model - */ + */ model?: ej.Rating.Model; /** returns the name of the event - */ + */ type?: string; /** returns the mouse click event args values. - */ + */ event?: any; } export interface MouseoverEventArgs { /** returns the current value. - */ + */ value?: number; /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the rating model - */ + */ model?: ej.Rating.Model; /** returns the name of the event - */ + */ type?: string; /** returns the mouse click event args values. - */ + */ event?: any; /** returns the current index value. - */ + */ index?: any; } @@ -11881,143 +11881,143 @@ class Ribbon extends ej.Widget { defaults: Ribbon.Model; /** Adds contextual tab or contextual tab set dynamically in the ribbon control with contextual tabs object and index position. - * When index is null, ribbon contextual tab or contextual tab set is added at the last index. - * @param {any} contextual tab or contextual tab set object. - * @param {number} index of the contextual tab or contextual tab set, this is optional. - * @returns {void} - */ + * When index is null, ribbon contextual tab or contextual tab set is added at the last index. + * @param {any} contextual tab or contextual tab set object. + * @param {number} index of the contextual tab or contextual tab set, this is optional. + * @returns {void} + */ addContextualTabs(contextualTabSet: any, index?: number): void; /** Add new option to Backstage page. - * @param {any} select the object to add the backstage item - * @param {number} index to the backstage item this is optional. - * @returns {void} - */ + * @param {any} select the object to add the backstage item + * @param {number} index to the backstage item this is optional. + * @returns {void} + */ addBackStageItem(item: any, index?: number): void; /** Adds tab dynamically in the ribbon control with given name, tab group array and index position. When index is null, ribbon tab is added at the last index. - * @param {string} ribbon tab display text. - * @param {Array} groups to be displayed in ribbon tab . - * @param {number} index of the ribbon tab,this is optional. - * @returns {void} - */ + * @param {string} ribbon tab display text. + * @param {Array} groups to be displayed in ribbon tab . + * @param {number} index of the ribbon tab,this is optional. + * @returns {void} + */ addTab(tabText: string, ribbonGroups: any[], index?: number): void; /** Adds tab group dynamically in the ribbon control with given tab index, tab group object and group index position. When group index is null, ribbon group is added at the last index. - * @param {number} ribbon tab index. - * @param {any} group to be displayed in ribbon tab . - * @param {number} index of the ribbon group,this is optional. - * @returns {void} - */ + * @param {number} ribbon tab index. + * @param {any} group to be displayed in ribbon tab . + * @param {number} index of the ribbon group,this is optional. + * @returns {void} + */ addTabGroup(tabIndex: number, tabGroup: any, groupIndex?: number): void; /** Adds group content dynamically in the ribbon control with given tab index, group index, sub group index, content and content index position. - * When content index is null, content is added at the last index. - * @param {number} ribbon tab index. - * @param {number} ribbon group index. - * @param {any} content to be displayed in the ribbon group. - * @param {number} ribbon content index. This is optional. If the value is not given, then by default contentIndex will be considered as 0. - * @param {number} sub group index in the ribbon group. This is optional. If the value is not given, then by default contentIndex will be considered as 0. - * @returns {void} - */ + * When content index is null, content is added at the last index. + * @param {number} ribbon tab index. + * @param {number} ribbon group index. + * @param {any} content to be displayed in the ribbon group. + * @param {number} ribbon content index. This is optional. If the value is not given, then by default contentIndex will be considered as 0. + * @param {number} sub group index in the ribbon group. This is optional. If the value is not given, then by default contentIndex will be considered as 0. + * @returns {void} + */ addTabGroupContent(tabIndex: number, groupIndex: number, content: any, contentIndex?: number, subGroupIndex?: number): void; /** Hides the ribbon backstage page. - * @returns {void} - */ + * @returns {void} + */ hideBackstage(): void; /** Collapses the ribbon tab content. - * @returns {void} - */ + * @returns {void} + */ collapse(): void; /** Destroys the ribbon widget. All the events bound using this._on are unbound automatically and the ribbon control is moved to pre-init state. - * @returns {void} - */ + * @returns {void} + */ destroy(): void; /** Expands the ribbon tab content. - * @returns {void} - */ + * @returns {void} + */ expand(): void; /** Gets text of the given index tab in the ribbon control. - * @param {number} index of the tab item. - * @returns {String} - */ + * @param {number} index of the tab item. + * @returns {String} + */ getTabText(index: number): string; /** Hides the given text tab in the ribbon control. - * @param {string} text of the tab item. - * @returns {void} - */ + * @param {string} text of the tab item. + * @returns {void} + */ hideTab(text: string): void; /** Checks whether the given text tab in the ribbon control is enabled or not. - * @param {string} text of the tab item. - * @returns {Boolean} - */ + * @param {string} text of the tab item. + * @returns {Boolean} + */ isEnable(text: string): boolean; /** Checks whether the given text tab in the ribbon control is visible or not. - * @param {string} text of the tab item. - * @returns {Boolean} - */ + * @param {string} text of the tab item. + * @returns {Boolean} + */ isVisible(text: string): boolean; /** Removes the given index tab item from the ribbon control. - * @param {number} index of tab item. - * @returns {void} - */ + * @param {number} index of tab item. + * @returns {void} + */ removeTab(index: number): void; /** Sets new text to the given text tab in the ribbon control. - * @param {string} current text of the tab item. - * @param {string} new text of the tab item. - * @returns {void} - */ + * @param {string} current text of the tab item. + * @param {string} new text of the tab item. + * @returns {void} + */ setTabText(tabText: string, newText: string): void; /** Displays the ribbon backstage page. - * @returns {void} - */ + * @returns {void} + */ showBackstage(): void; /** Displays the given text tab in the ribbon control. - * @param {string} text of the tab item. - * @returns {void} - */ + * @param {string} text of the tab item. + * @returns {void} + */ showTab(text: string): void; /** To customize Group alone in the inside content. - * @param {number} ribbon tab index. - * @param {string} group id to be displayed in ribbon tab . - * @param {any} contentGroup is used in the object - * @returns {void} - */ + * @param {number} ribbon tab index. + * @param {string} group id to be displayed in ribbon tab . + * @param {any} contentGroup is used in the object + * @returns {void} + */ updateGroup(tabIndex: number, groupId: string, contentGroup?: any): void; /** Update option in existing Backstage. - * @param {number} index to the backstage item - * @param {any} select the object to add the backstage item - * @returns {void} - */ + * @param {number} index to the backstage item + * @param {any} select the object to add the backstage item + * @returns {void} + */ updateBackStageItem(index: number, item?: any): void; /** To customize whole content from Tab Group. - * @param {number} ribbon tab index. - * @param {string} ribbon group text. - * @param {number} ribbon content index. This is optional. If the value is not given, all content groups will be removed. - * @param {number} sub group index in the ribbon group. This is optional. If the value is not given, all content groups will be removed. - * @returns {void} - */ + * @param {number} ribbon tab index. + * @param {string} ribbon group text. + * @param {number} ribbon content index. This is optional. If the value is not given, all content groups will be removed. + * @param {number} sub group index in the ribbon group. This is optional. If the value is not given, all content groups will be removed. + * @returns {void} + */ removeTabGroupContent(tabIndex: number, groupText: string, contentIndex?: number, subGroupIndex?: number): void; /** Remove option from Backstage. - * @param {number} index to the backstage item - * @returns {void} - */ + * @param {number} index to the backstage item + * @returns {void} + */ removeBackStageItem(index: number): void; } export namespace Ribbon { @@ -12025,91 +12025,91 @@ export namespace Ribbon { export interface Model { /** Enables the ribbon resize feature.allowResizing is a deprecated property of isResponsive. - * @Default {false} - */ + * @Default {false} + */ allowResizing?: boolean; /** When set to true, adapts the Ribbon layout to fit the screen size of devices on which it renders. - * @Default {false} - */ + * @Default {false} + */ isResponsive?: boolean; /** Specifies the height, width, enableRTL, showRoundedCorner,enabled,cssClass property to the controls in the ribbon commonly andit will work only when those properties - * are not defined in buttonSettings and content defaults. - * @Default {Object} - */ + * are not defined in buttonSettings and content defaults. + * @Default {Object} + */ buttonDefaults?: any; /** Property to enable the ribbon quick access toolbar. - * @Default {false} - */ + * @Default {false} + */ showQAT?: boolean; /** Sets custom setting to the collapsible pin in the ribbon. - * @Default {Object} - */ + * @Default {Object} + */ collapsePinSettings?: CollapsePinSettings; /** Set enableOnDemand as true to load ribbon tab and backstage contents while corresponding item clicked. - * @Default {false} - */ + * @Default {false} + */ enableOnDemand?: boolean; /** Set collapsible property as true to render ribbon in initially collapsed state. - * @Default {false} - */ + * @Default {false} + */ collapsible?: boolean; /** Align content in the ribbon control from right to left by setting the property as true. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Sets custom setting to the expandable pin in the ribbon. - * @Default {Object} - */ + * @Default {Object} + */ expandPinSettings?: ExpandPinSettings; /** Specifies the application tab to contain application menu or backstage page in the ribbon control. - * @Default {Object} - */ + * @Default {Object} + */ applicationTab?: ApplicationTab; /** Specifies the contextual tabs and tab set to the ribbon control with the background color and border color. Refer to the tabs section for adding tabs - * into the contextual tab and contextual tab set. - * @Default {Array} - */ + * into the contextual tab and contextual tab set. + * @Default {Array} + */ contextualTabs?: ContextualTab[]; /** Specifies the index or indexes to disable the given index tab or indexes tabs in the ribbon control. - * @Default {0} - */ + * @Default {0} + */ disabledItemIndex?: any[]; /** Specifies the index or indexes to enable the given index tab or indexes tabs in the ribbon control. - * @Default {null} - */ + * @Default {null} + */ enabledItemIndex?: any[]; /** Specifies the index of the ribbon tab to select the given index tab item in the ribbon control. - * @Default {1} - */ + * @Default {1} + */ selectedItemIndex?: number; /** Specifies the tabs and its groups. Also specifies the control details that has to be placed in the tab area in the ribbon control. - * @Default {Array} - */ + * @Default {Array} + */ tabs?: Tab[]; /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and culture specific - * to a particular country or region and it will need to use the user's preference. - * @Default {en-US} - */ + * to a particular country or region and it will need to use the user's preference. + * @Default {en-US} + */ locale?: string; /** Specifies the width to the ribbon control. You can set width in string or number format. - * @Default {null} - */ + * @Default {null} + */ width?: string|number; /** Triggered before the ribbon tab item is removed. */ @@ -12167,771 +12167,771 @@ export interface Model { export interface BeforeTabRemoveEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the ribbon model. - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; /** returns current tab item index in the ribbon control. - */ + */ index?: number; } export interface CreateEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the ribbon model. - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; } export interface DestroyEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the ribbon model. - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; /** returns current ribbon tab item index - */ + */ deleteIndex?: number; } export interface GroupClickEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the ribbon model. - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; /** returns the control clicked in the group. - */ + */ target?: number; } export interface GroupExpandEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the ribbon model. - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; /** returns the clicked group expander. - */ + */ target?: number; } export interface GalleryItemClickEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the ribbon model. - */ + */ model?: any; /** returns the gallery model. - */ + */ galleryModel?: any; /** returns the name of the event. - */ + */ type?: string; /** returns the item clicked in the gallery. - */ + */ target?: number; } export interface BackstageItemClickEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the ribbon model. - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; /** returns the item clicked in the gallery. - */ + */ target?: number; /** returns the id of the target item. - */ + */ id?: string; /** returns the text of the target item. - */ + */ text?: string; } export interface CollapseEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the ribbon model. - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; } export interface ExpandEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the ribbon model. - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; } export interface LoadEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the ribbon model. - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; } export interface TabAddEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the ribbon model. - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; /** returns new added tab header. - */ + */ tabHeader?: any; /** returns new added tab content panel. - */ + */ tabContent?: any; } export interface TabClickEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the ribbon model. - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; /** returns previous active tab header. - */ + */ prevActiveHeader?: any; /** returns previous active index. - */ + */ prevActiveIndex?: number; /** returns current active tab header . - */ + */ activeHeader?: any; /** returns current active index. - */ + */ activeIndex?: number; } export interface TabCreateEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the ribbon model. - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; /** returns current ribbon tab item index - */ + */ deleteIndex?: number; } export interface TabRemoveEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the ribbon model. - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; /** returns the removed index. - */ + */ removedIndex?: number; } export interface TabSelectEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the ribbon model. - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; /** returns previous active tab header. - */ + */ prevActiveHeader?: any; /** returns previous active index. - */ + */ prevActiveIndex?: number; /** returns current active tab header . - */ + */ activeHeader?: any; /** returns current active index. - */ + */ activeIndex?: number; } export interface ToggleButtonClickEventArgs { /** Set to true when the event has to be canceled, else false. - */ + */ cancel?: boolean; /** returns the ribbon model. - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; /** returns the expand/collapse button. - */ + */ target?: number; } export interface QatMenuItemClickEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the ribbon model. - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; /** returns the clicked menu item text. - */ + */ text?: string; } export interface CollapsePinSettings { /** Sets tooltip for the collapse pin . - * @Default {null} - */ + * @Default {null} + */ toolTip?: string; /** Specifies the custom tooltip for collapse pin.Refer to ejRibbon#tabs->groups->content->groups->customToolTip for its inner properties. - * @Default {Object} - */ + * @Default {Object} + */ customToolTip?: any; } export interface ExpandPinSettings { /** Sets tooltip for the expand pin. - * @Default {null} - */ + * @Default {null} + */ toolTip?: string; /** Specifies the custom tooltip for expand pin.Refer to ejRibbon#tabs->groups->content->groups->customToolTip for its inner properties. - * @Default {Object} - */ + * @Default {Object} + */ customToolTip?: any; } export interface ApplicationTabBackstageSettingsPage { /** Specifies the id for ribbon backstage page's tab and button elements. - * @Default {null} - */ + * @Default {null} + */ id?: string; /** Specifies the text for ribbon backstage page's tab header and button elements. - * @Default {null} - */ + * @Default {null} + */ text?: string; /** Specifies the type for ribbon backstage page's contents. Set "ej.Ribbon.BackStageItemType.Tab" to render the tab or " - * ej.Ribbon.BackStageItemType.Button" to render the button. - * @Default {ej.Ribbon.ItemType.Tab} - */ + * ej.Ribbon.BackStageItemType.Button" to render the button. + * @Default {ej.Ribbon.ItemType.Tab} + */ itemType?: ej.Ribbon.ItemType|string; /** Specifies the id of HTML elements like div,ul, etc., as ribbon backstage page's tab content. - * @Default {null} - */ + * @Default {null} + */ contentID?: string; /** Specifies the separator between backstage page's tab and button elements. - * @Default {false} - */ + * @Default {false} + */ enableSeparator?: boolean; } export interface ApplicationTabBackstageSettings { /** Specifies the display text of application tab. - * @Default {null} - */ + * @Default {null} + */ text?: string; /** Specifies the height of ribbon backstage page. - * @Default {null} - */ + * @Default {null} + */ height?: string|number; /** Specifies the width of ribbon backstage page. - * @Default {null} - */ + * @Default {null} + */ width?: string|number; /** Specifies the ribbon backstage page with its tab and button elements. - * @Default {Array} - */ + * @Default {Array} + */ pages?: ApplicationTabBackstageSettingsPage[]; /** Specifies the width of backstage page header that contains tabs and buttons. - * @Default {null} - */ + * @Default {null} + */ headerWidth?: string|number; } export interface ApplicationTab { /** Specifies the ribbon backstage page items. - * @Default {Object} - */ + * @Default {Object} + */ backstageSettings?: ApplicationTabBackstageSettings; /** Specifies the ID of ul list to create application menu in the ribbon control. - * @Default {null} - */ + * @Default {null} + */ menuItemID?: string; /** Specifies the menu members, events by using the menu settings for the menu in the application tab. - * @Default {Object} - */ + * @Default {Object} + */ menuSettings?: any; /** Specifies the application menu or backstage page. Specify the type of application tab as "ej.Ribbon.ApplicationTabType.Menu" to render the application menu or - * "ej.Ribbon.ApplicationTabType.Backstage" to render backstage page in the ribbon control. - * @Default {ej.Ribbon.ApplicationTabType.Menu} - */ + * "ej.Ribbon.ApplicationTabType.Backstage" to render backstage page in the ribbon control. + * @Default {ej.Ribbon.ApplicationTabType.Menu} + */ type?: ej.Ribbon.ApplicationTabType|string; } export interface ContextualTab { /** Specifies the backgroundColor of the contextual tabs and tab set in the ribbon control. - * @Default {null} - */ + * @Default {null} + */ backgroundColor?: string; /** Specifies the borderColor of the contextual tabs and tab set in the ribbon control. - * @Default {null} - */ + * @Default {null} + */ borderColor?: string; /** Specifies the tabs to present in the contextual tabs and tab set. Refer to the tabs section for adding tabs into the contextual tabs and tab set. - * @Default {Array} - */ + * @Default {Array} + */ tabs?: any[]; } export interface TabsGroupsContentDefaults { /** Specifies the controls height such as Syncfusion button,split button,dropdown list,toggle button in the subgroup of the ribbon tab. - * @Default {null} - */ + * @Default {null} + */ height?: string|number; /** Specifies the controls width such as Syncfusion button,split button,dropdown list,toggle button in the subgroup of the ribbon tab. - * @Default {null} - */ + * @Default {null} + */ width?: string|number; /** Specifies the controls type such as Syncfusion button,split button,dropdown list,toggle button in the subgroup of the ribbon tab. - * @Default {ej.Ribbon.Type.Button} - */ + * @Default {ej.Ribbon.Type.Button} + */ type?: string; /** Specifies the controls size such as Syncfusion button,split button,dropdown list,toggle button in the subgroup of the ribbon tab. - * @Default {false} - */ + * @Default {false} + */ isBig?: boolean; } export interface TabsGroupsContentGroupsCustomGalleryItem { /** Specifies the Syncfusion button members, events by using buttonSettings. - * @Default {Object} - */ + * @Default {Object} + */ buttonSettings?: any; /** Specifies the type as ej.Ribbon.CustomItemType.Menu or ej.Ribbon.CustomItemType.Button to render Syncfusion button and menu. - * @Default {ej.Ribbon.CustomItemType.Button} - */ + * @Default {ej.Ribbon.CustomItemType.Button} + */ customItemType?: ej.Ribbon.CustomItemType|string; /** Specifies the custom tooltip for gallery extra item's button. Refer to ejRibbon#tabs->groups->content->groups->customToolTip for its inner properties. - * @Default {Object} - */ + * @Default {Object} + */ customToolTip?: any; /** Specifies the UL list id to render menu as gallery extra item. - * @Default {null} - */ + * @Default {null} + */ menuId?: string; /** Specifies the Syncfusion menu members, events by using menuSettings. - * @Default {Object} - */ + * @Default {Object} + */ menuSettings?: any; /** Specifies the text for gallery extra item's button. - * @Default {null} - */ + * @Default {null} + */ text?: string; /** Specifies the tooltip for gallery extra item's button. - * @Default {null} - */ + * @Default {null} + */ toolTip?: string; } export interface TabsGroupsContentGroupsCustomToolTip { /** Sets content to the custom tooltip. Text and HTML support are provided for content. - * @Default {null} - */ + * @Default {null} + */ content?: string; /** Sets icon to the custom tooltip content. - * @Default {null} - */ + * @Default {null} + */ prefixIcon?: string; /** Sets title to the custom tooltip. Text and HTML support are provided for title and the title is in bold for text format. - * @Default {null} - */ + * @Default {null} + */ title?: string; } export interface TabsGroupsContentGroupsGalleryItem { /** Specifies the Syncfusion button members, events by using buttonSettings. - * @Default {Object} - */ + * @Default {Object} + */ buttonSettings?: any; /** Specifies the custom tooltip for gallery content. Refer to ejRibbon#tabs->groups->content->groups->customToolTip for its inner properties. - * @Default {Object} - */ + * @Default {Object} + */ customToolTip?: any; /** Sets text for the gallery content. - * @Default {null} - */ + * @Default {null} + */ text?: string; /** Sets tooltip for the gallery content. - * @Default {null} - */ + * @Default {null} + */ toolTip?: string; } export interface TabsGroupsContentGroup { /** When isMobileOnly is true,its shows in mobile toolbar.isResponsive should be true for using this property. - * @Default {false} - */ + * @Default {false} + */ isMobileOnly?: boolean; /** Specifies the Syncfusion button members, events by using this buttonSettings. - * @Default {Object} - */ + * @Default {Object} + */ buttonSettings?: any; /** It is used to set the count of gallery contents in a row. - * @Default {null} - */ + * @Default {null} + */ columns?: number; /** Specifies the custom items such as div, table, controls as custom controls with the type "ej.Ribbon.Type.Custom" in the groups. - * @Default {null} - */ + * @Default {null} + */ contentID?: string; /** Specifies the CSS class property to apply styles to the button, split, dropdown controls in the groups. - * @Default {null} - */ + * @Default {null} + */ cssClass?: string; /** Specifies the Syncfusion button and menu as gallery extra items. - * @Default {Array} - */ + * @Default {Array} + */ customGalleryItems?: TabsGroupsContentGroupsCustomGalleryItem[]; /** Provides custom tooltip for button, split button, dropdown list, toggle button, custom controls in the sub groups. Text and HTML support are also provided for title and content. - * @Default {Object} - */ + * @Default {Object} + */ customToolTip?: TabsGroupsContentGroupsCustomToolTip; /** Specifies the Syncfusion dropdown list members, events by using this dropdownSettings. - * @Default {Object} - */ + * @Default {Object} + */ dropdownSettings?: any; /** Specifies the separator to the control that is in row type group. The separator separates the control from the next control in the group. Set "true" to enable the separator. - * @Default {false} - */ + * @Default {false} + */ enableSeparator?: boolean; /** Sets the count of gallery contents in a row, when the gallery is in expanded state. - * @Default {null} - */ + * @Default {null} + */ expandedColumns?: number; /** Defines each gallery content. - * @Default {Array} - */ + * @Default {Array} + */ galleryItems?: TabsGroupsContentGroupsGalleryItem[]; /** Specifies the Id for button, split button, dropdown list, toggle button, gallery, custom controls in the sub groups. - * @Default {null} - */ + * @Default {null} + */ id?: string; /** Specifies the size for button, split button controls. Set "true" for big size and "false" for small size. - * @Default {null} - */ + * @Default {null} + */ isBig?: boolean; /** Sets the height of each gallery content. - * @Default {null} - */ + * @Default {null} + */ itemHeight?: string|number; /** Sets the width of each gallery content. - * @Default {null} - */ + * @Default {null} + */ itemWidth?: string|number; /** Specifies the Syncfusion split button members, events by using this splitButtonSettings. - * @Default {Object} - */ + * @Default {Object} + */ splitButtonSettings?: any; /** Specifies the text for button, split button, toggle button controls in the sub groups. - * @Default {null} - */ + * @Default {null} + */ text?: string; /** Specifies the Syncfusion toggle button members, events by using toggleButtonSettings. - * @Default {Object} - */ + * @Default {Object} + */ toggleButtonSettings?: any; /** Specifies the tooltip for button, split button, dropdown list, toggle button, custom controls in the sub groups. - * @Default {null} - */ + * @Default {null} + */ toolTip?: string; /** To add,show and hide controls in Quick Access toolbar. - * @Default {ej.Ribbon.QuickAccessMode.None} - */ + * @Default {ej.Ribbon.QuickAccessMode.None} + */ quickAccessMode?: ej.Ribbon.QuickAccessMode|string; /** Specifies the type as "ej.Ribbon.Type.Button" or "ej.Ribbon.Type.SplitButton" or "ej.Ribbon.Type.DropDownList" or "ej.Ribbon.Type.ToggleButton" - * or "ej.Ribbon.Type.Custom" or "ej.Ribbon.Type.Gallery" to render button, split, dropdown, toggle button, gallery, custom controls. - * @Default {ej.Ribbon.Type.Button} - */ + * or "ej.Ribbon.Type.Custom" or "ej.Ribbon.Type.Gallery" to render button, split, dropdown, toggle button, gallery, custom controls. + * @Default {ej.Ribbon.Type.Button} + */ type?: ej.Ribbon.Type|string; } export interface TabsGroupsContent { /** Specifies the height, width, type, isBig property to the controls in the group commonly. - * @Default {Object} - */ + * @Default {Object} + */ defaults?: TabsGroupsContentDefaults; /** Specifies the controls such as Syncfusion button, split button, dropdown list, toggle button, gallery, custom controls in the subgroup of the ribbon tab . - * @Default {Array} - */ + * @Default {Array} + */ groups?: TabsGroupsContentGroup[]; } export interface TabsGroupsGroupExpanderSettings { /** Sets tooltip for the group expander of the group. - * @Default {null} - */ + * @Default {null} + */ toolTip?: string; /** Specifies the custom tooltip for group expander.Refer to ejRibbon#tabs->groups->content->groups->customToolTip for its inner properties. - * @Default {Object} - */ + * @Default {Object} + */ customToolTip?: any; } export interface TabsGroup { /** Specifies the alignment of controls in the groups in 'row' type or 'column' type. Value for row type is "ej.Ribbon.AlignType.Rows" - * and for column type is "ej.Ribbon.alignType.columns". - * @Default {ej.Ribbon.AlignType.Rows} - */ + * and for column type is "ej.Ribbon.alignType.columns". + * @Default {ej.Ribbon.AlignType.Rows} + */ alignType?: ej.Ribbon.AlignType|string; /** Specifies the Syncfusion button, split button, dropdown list, toggle button, gallery, custom controls to the groups in the ribbon control. - * @Default {Array} - */ + * @Default {Array} + */ content?: TabsGroupsContent[]; /** Specifies the ID of custom items to be placed in the groups. - * @Default {null} - */ + * @Default {null} + */ contentID?: string; /** Specifies the HTML contents to place into the groups. - * @Default {null} - */ + * @Default {null} + */ customContent?: string; /** Specifies the group expander for groups in the ribbon control. Set "true" to enable the group expander. - * @Default {false} - */ + * @Default {false} + */ enableGroupExpander?: boolean; /** Sets custom setting to the groups in the ribbon control. - * @Default {Object} - */ + * @Default {Object} + */ groupExpanderSettings?: TabsGroupsGroupExpanderSettings; /** Specifies the text to the groups in the ribbon control. - * @Default {null} - */ + * @Default {null} + */ text?: string; /** Specifies the custom items such as div, table, controls by using the "custom" type. - * @Default {null} - */ + * @Default {null} + */ type?: string; } export interface Tab { /** Specifies single group or multiple groups and its contents to each tab in the ribbon control. - * @Default {Array} - */ + * @Default {Array} + */ groups?: TabsGroup[]; /** Specifies the ID for each tab's content panel. - * @Default {null} - */ + * @Default {null} + */ id?: string; /** Specifies the text of the tab in the ribbon control. - * @Default {null} - */ + * @Default {null} + */ text?: string; } @@ -13019,90 +13019,90 @@ class Kanban extends ej.Widget { defaults: Kanban.Model; /** Add or remove columns in Kanban columns collections.Default action is add. - * @param {Array|string} Pass array of columns or string of headerText to add/remove the column in Kanban - * @param {Array|string} Pass array of columns or string of key value to add/remove the column in Kanban - * @param {string} optional Pass add/remove action to be performed. By default "add" action will perform - * @returns {void} - */ + * @param {Array|string} Pass array of columns or string of headerText to add/remove the column in Kanban + * @param {Array|string} Pass array of columns or string of key value to add/remove the column in Kanban + * @param {string} optional Pass add/remove action to be performed. By default "add" action will perform + * @returns {void} + */ columns(columndetails: any[]|string, keyvalue: any[]|string, action?: string): void; /** Destroy the Kanban widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. - * @returns {void} - */ + * @returns {void} + */ destroy(): void; /** Refresh the Kanban with new data source. - * @param {Array} Pass new data source to the Kanban - * @returns {void} - */ + * @param {Array} Pass new data source to the Kanban + * @returns {void} + */ dataSource(datasource: any[]): void; /** toggleColumn based on the headerText in Kanban. - * @param {any} Pass the header text of the column to get the corresponding column object - * @returns {void} - */ + * @param {any} Pass the header text of the column to get the corresponding column object + * @returns {void} + */ toggleColumn(headerText: any): void; /** Expand or collapse the card based on the state of target "div" - * @param {string|number} Pass the id of card to be toggle - * @returns {void} - */ + * @param {string|number} Pass the id of card to be toggle + * @returns {void} + */ toggleCard(key: string|number): void; /** Used for get the names of all the visible column name collections in Kanban. - * @returns {Array} - */ + * @returns {Array} + */ getVisibleColumnNames(): any[]; /** Get the scroller object of Kanban. - * @returns {ej.Scroller} - */ + * @returns {ej.Scroller} + */ getScrollObject(): ej.Scroller; /** Get the column details based on the given header text in Kanban. - * @param {string} Pass the header text of the column to get the corresponding column object - * @returns {String} - */ + * @param {string} Pass the header text of the column to get the corresponding column object + * @returns {String} + */ getColumnByHeaderText(headerText: string): string; /** Get the table details based on the given header table in Kanban. - * @returns {String} - */ + * @returns {String} + */ getHeaderTable(): string; /** Hide columns from the Kanban based on the header text - * @param {Array|string} you can pass either array of header text of various columns or a header text of a column to hide - * @returns {void} - */ + * @param {Array|string} you can pass either array of header text of various columns or a header text of a column to hide + * @returns {void} + */ hideColumns(headerText: any[]|string): void; /** Print the Kanban Board - * @returns {void} - */ + * @returns {void} + */ print(): void; /** Refresh the template of the Kanban - * @returns {void} - */ + * @returns {void} + */ refreshTemplate(): void; /** Refresh the Kanban contents.The template refreshment is based on the argument passed along with this method - * @param {boolean} optional When templateRefresh is set true, template and Kanban contents both are refreshed in Kanban else only Kanban content is refreshed - * @returns {void} - */ + * @param {boolean} optional When templateRefresh is set true, template and Kanban contents both are refreshed in Kanban else only Kanban content is refreshed + * @returns {void} + */ refresh(templateRefresh?: boolean): void; /** Show columns in the Kanban based on the header text. - * @param {Array|string} You can pass either array of header text of various columns or a header text of a column to show - * @returns {void} - */ + * @param {Array|string} You can pass either array of header text of various columns or a header text of a column to show + * @returns {void} + */ showColumns(headerText: any[]|string): void; /** Update a card in Kanban control based on key and JSON data given. - * @param {string} Pass the key field Name of the column - * @param {Array} Pass the edited JSON data of card need to be update. - * @returns {void} - */ + * @param {string} Pass the key field Name of the column + * @param {Array} Pass the edited JSON data of card need to be update. + * @returns {void} + */ updateCard(key: string, data: any[]): void; KanbanSelection: Kanban.KanbanSelection; @@ -13118,267 +13118,267 @@ export namespace Kanban { export interface KanbanSelection { /** It is used to clear all the card selection. - * @returns {void} - */ + * @returns {void} + */ clear(): void; } export interface KanbanSwimlane { /** Expand all the swimlane rows in Kanban. - * @returns {void} - */ + * @returns {void} + */ expandAll(): void; /** Collapse all the swimlane rows in Kanban. - * @returns {void} - */ + * @returns {void} + */ collapseAll(): void; /** Expand or collapse the swimlane row based on the state of target "div" - * @param {any} Pass the div object to toggleSwimlane row based on its row state - * @returns {void} - */ + * @param {any} Pass the div object to toggleSwimlane row based on its row state + * @returns {void} + */ toggle($div: any): void; } export interface KanbanFilter { /** Method used for send a clear search request to Kanban. - * @returns {void} - */ + * @returns {void} + */ clearSearch(): void; /** Send a search request to Kanban with specified string passed in it. - * @param {string} Pass the string to search in Kanban card - * @returns {void} - */ + * @param {string} Pass the string to search in Kanban card + * @returns {void} + */ searchCards(searchString: string): void; /** Send a clear request to filter cards in the kanban. - * @returns {void} - */ + * @returns {void} + */ clearFilter(): void; /** Send a filtering request to cards in the kanban. - * @returns {void} - */ + * @returns {void} + */ filterCards(): void; } export interface KanbanEdit { /** Add a new card in Kanban control when allowAdding is set as true. If parameters are not given default dialog will be open. - * @param {string} Pass the primary key field Name of the column - * @param {Array} Pass the edited JSON data of card need to be add. - * @returns {void} - */ + * @param {string} Pass the primary key field Name of the column + * @param {Array} Pass the edited JSON data of card need to be add. + * @returns {void} + */ addCard(primaryKey: string, card: any[]): void; /** Send a cancel request of add/edit card in Kanban when allowEditing/allowAdding is set as true. - * @returns {void} - */ + * @returns {void} + */ cancelEdit(): void; /** Delete a card in Kanban control when allowAdding/allowEditing is set as true. - * @param {string|number} Pass the key of card to be delete - * @returns {void} - */ + * @param {string|number} Pass the key of card to be delete + * @returns {void} + */ deleteCard(Key: string|number): void; /** Send a save request in Kanban when any card is in edit/new add card state and allowEditing/allowAdding is set as true. - * @returns {void} - */ + * @returns {void} + */ endEdit(): void; /** Send an edit card request in Kanban when allowEditing is set as true. Parameter will be HTML element or primary key - * @param {any} Pass the div selected row element to be edited in Kanban - * @returns {void} - */ + * @param {any} Pass the div selected row element to be edited in Kanban + * @returns {void} + */ startEdit($div: any): void; /** Method used for set validation to a field during editing. - * @param {string} Specify the name of the column to set validation rules - * @param {any} Specify the validation rules for the field - * @returns {void} - */ + * @param {string} Specify the name of the column to set validation rules + * @param {any} Specify the validation rules for the field + * @returns {void} + */ setValidationToField(name: string, rules: any): void; } export interface Model { /** Gets or sets a value that indicates whether to enable allowDragAndDrop behavior on Kanban. - * @Default {true} - */ + * @Default {true} + */ allowDragAndDrop?: boolean; /** To enable or disable the title of the card. - * @Default {false} - */ + * @Default {false} + */ allowTitle?: boolean; /** Customize the settings for swim lane. - * @Default {Object} - */ + * @Default {Object} + */ swimlaneSettings?: SwimlaneSettings; /** To enable or disable the column expand /collapse. - * @Default {false} - */ + * @Default {false} + */ allowToggleColumn?: boolean; /** To enable Searching operation in Kanban. - * @Default {false} - */ + * @Default {false} + */ allowSearching?: boolean; /** To enable filtering behavior on Kanban.User can specify query in filterSettings collection after enabling allowFiltering. - * @Default {false} - */ + * @Default {false} + */ allowFiltering?: boolean; /** Gets or sets a value that indicates whether to enable allowSelection behavior on Kanban.User can select card and the selected card will be highlighted on Kanban. - * @Default {true} - */ + * @Default {true} + */ allowSelection?: boolean; /** Gets or sets a value that indicates whether to allow card hover actions. - * @Default {true} - */ + * @Default {true} + */ allowHover?: boolean; /** To allow keyboard navigation actions. - * @Default {false} - */ + * @Default {false} + */ allowKeyboardNavigation?: boolean; /** Gets or sets a value that indicates whether to enable the scrollbar in the Kanban and view the card by scroll through the Kanban manually. - * @Default {false} - */ + * @Default {false} + */ allowScrolling?: boolean; /** Gets or sets a value that indicates whether to enable printing option. - * @Default {false} - */ + * @Default {false} + */ allowPrinting?: boolean; /** Gets or sets an object that indicates whether to customize the context menu behavior of the Kanban. - * @Default {Object} - */ + * @Default {Object} + */ contextMenuSettings?: ContextMenuSettings; /** Gets or sets an object that indicates to render the Kanban with specified columns. - * @Default {Array} - */ + * @Default {Array} + */ columns?: Column[]; /** Gets or sets an object that indicates whether to Customize the card settings. - * @Default {Object} - */ + * @Default {Object} + */ cardSettings?: CardSettings; /** Gets or sets a value that indicates whether to add customToolbarItems within the toolbar to perform any action in the Kanban. - * @Default {[]} - */ + * @Default {[]} + */ customToolbarItems?: CustomToolbarItem[]; /** Gets or sets a value that indicates to render the Kanban with custom theme. - */ + */ cssClass?: string; /** Gets or sets the data to render the Kanban with cards. - * @Default {null} - */ + * @Default {null} + */ dataSource?: any; /** To perform kanban functionalities with touch interaction. - * @Default {true} - */ + * @Default {true} + */ enableTouch?: boolean; /** Align content in the Kanban control align from right to left by setting the property as true. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** To show total count of cards in each column. - * @Default {false} - */ + * @Default {false} + */ enableTotalCount?: boolean; /** Get or sets an object that indicates whether to customize the editing behavior of the Kanban. - * @Default {Object} - */ + * @Default {Object} + */ editSettings?: EditSettings; /** To customize field mappings for card , editing title and control key parameters - * @Default {Object} - */ + * @Default {Object} + */ fields?: Fields; /** To map datasource field for column values mapping - * @Default {null} - */ + * @Default {null} + */ keyField?: string; /** When set to true, adapts the Kanban layout to fit the screen size of devices on which it renders. - * @Default {false} - */ + * @Default {false} + */ isResponsive?: boolean; /** Gets or sets a value that indicates whether to set the minimum width of the responsive Kanban while isResponsive property is true. - * @Default {0} - */ + * @Default {0} + */ minWidth?: number; /** To customize the filtering behavior based on queries given. - * @Default {Array} - */ + * @Default {Array} + */ filterSettings?: FilterSetting[]; /** ej Query to query database of Kanban. - * @Default {null} - */ + * @Default {null} + */ query?: any; /** To change the key in keyboard interaction to Kanban control. - * @Default {null} - */ + * @Default {null} + */ keySettings?: any; /** Gets or sets an object that indicates whether to customize the scrolling behavior of the Kanban. - * @Default {Object} - */ + * @Default {Object} + */ scrollSettings?: ScrollSettings; /** To customize the searching behavior of the Kanban. - * @Default {Object} - */ + * @Default {Object} + */ searchSettings?: SearchSettings; /** To allow customize selection type. Accepting types are "single" and "multiple". - * @Default {ej.Kanban.SelectionType.Single} - */ + * @Default {ej.Kanban.SelectionType.Single} + */ selectionType?: ej.Kanban.SelectionType|string; /** Gets or sets an object that indicates to managing the collection of stacked header rows for the Kanban. - * @Default {Array} - */ + * @Default {Array} + */ stackedHeaderRows?: StackedHeaderRow[]; /** The tooltip allows to display card details in a tooltip while hovering on it. - */ + */ tooltipSettings?: TooltipSettings; /** Gets or sets an object that indicates to render the Kanban with specified workflows. - * @Default {Array} - */ + * @Default {Array} + */ workflows?: Workflow[]; /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and culture specific - * to a particular country or region. - * @Default {en-US} - */ + * to a particular country or region. + * @Default {en-US} + */ locale?: string; /** Triggered for every Kanban action before its starts. */ @@ -13463,1149 +13463,1149 @@ export interface Model { export interface ActionBeginEventArgs { /** Returns the Kanban model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the current action event type. - */ + */ originalEventType?: string; /** Returns primary key value. - */ + */ primaryKeyValue?: string; /** Returns request type. - */ + */ requestType?: string; /** Returns the edited row index. - */ + */ rowIndex?: number; /** Returns the card object (JSON). - */ + */ data?: any; /** Returns current filtering object field name. - */ + */ currentFilteringobject?: any; /** Returns filter details. - */ + */ filterCollection?: any; } export interface ActionCompleteEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the Kanban model. - */ + */ model?: any; /** Returns request type. - */ + */ requestType?: string; /** Returns the name of the event. - */ + */ type?: string; /** Returns current action event type. - */ + */ originalEventType?: string; /** Returns primary key. - */ + */ primaryKey?: string; /** Returns primary key value. - */ + */ primaryKeyValue?: string; /** Returns Kanban element. - */ + */ target?: any; /** Returns the card object (JSON). - */ + */ data?: any; /** Returns the selectedRow index. - */ + */ selectedRow?: number; /** Returns current filtering column field name. - */ + */ currentFilteringColumn?: string; /** Returns filter details. - */ + */ filterCollection?: any; } export interface ActionFailureEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the Kanban model. - */ + */ model?: any; /** Returns request type. - */ + */ requestType?: string; /** Returns the name of the event. - */ + */ type?: string; /** Returns the error return by server. - */ + */ error?: any; /** Returns current action event type. - */ + */ originalEventType?: string; /** Returns primary key value. - */ + */ primaryKeyValue?: string; /** Returns Kanban element. - */ + */ target?: any; /** Returns the card object (JSON). - */ + */ data?: any; /** Returns current filtering column field name. - */ + */ currentFilteringColumn?: string; /** Returns filter details. - */ + */ filterCollection?: any; } export interface BeginEditEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the Kanban model. - */ + */ model?: any; /** Returns primary key value. - */ + */ primaryKeyValue?: string; /** Returns begin edit data. - */ + */ data?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface BeginAddEventArgs { /** Returns the Kanban model. - */ + */ model?: any; /** Returns primary key value. - */ + */ primaryKeyValue?: string; /** Returns beginAdd data. - */ + */ data?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface BeforeCardSelectEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the select cell index value. - */ + */ cellIndex?: number; /** Returns the select card index value. - */ + */ cardIndex?: number; /** Returns the select cell element - */ + */ currentCell?: any; /** Returns the previously select the card element - */ + */ previousCard?: any; /** Returns the previously select card indexes - */ + */ previousRowcellindex?: any[]; /** Returns the Target item. - */ + */ Target?: any; /** Returns the Kanban model. - */ + */ model?: any; /** Returns select card data. - */ + */ data?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface CardClickEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns current record object (JSON). - */ + */ data?: any; /** Returns the current card to the Kanban. - */ + */ currentCard?: string; /** Returns Kanban element. - */ + */ target?: any; /** Returns the Kanban model. - */ + */ model?: any; /** Returns the Header text of the column corresponding to the selected card. - */ + */ columnName?: string; /** Returns the name of the event. - */ + */ type?: string; } export interface CardDragEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns drag data. - */ + */ data?: any; /** Returns drag start element. - */ + */ dragtarget?: any; /** Returns dragged element. - */ + */ draggedElement?: any; /** Returns the Kanban model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface CardDragStartEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns card drag start data. - */ + */ data?: any; /** Returns dragged element. - */ + */ draggedElement?: any; /** Returns the Kanban model. - */ + */ model?: any; /** Returns drag start element. - */ + */ dragtarget?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface CardDragStopEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns dragged element. - */ + */ draggedElement?: any; /** Returns the Kanban model. - */ + */ model?: any; /** Returns drag stop element. - */ + */ droptarget?: any; /** Returns drag stop data. - */ + */ data?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface CardDropEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns dragged element. - */ + */ draggedElement?: any; /** Returns previous parent of dragged element - */ + */ draggedParent?: any; /** Returns dragged data. - */ + */ data?: any; /** Returns the Kanban model. - */ + */ model?: any; /** Returns drop element. - */ + */ target?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface CardSelectEventArgs { /** Returns the select cell index value. - */ + */ cellIndex?: number; /** Returns the select card index value. - */ + */ cardIndex?: number; /** Returns the select cell element - */ + */ currentCell?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the previously select the card element - */ + */ previousCard?: any; /** Returns the previously select card indexes - */ + */ previousRowcellindex?: any[]; /** Returns the current item. - */ + */ currentTarget?: any; /** Returns the Kanban model. - */ + */ model?: any; /** Returns select card data. - */ + */ data?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface CardDoubleClickEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns current card object (JSON). - */ + */ data?: any; /** Returns the Kanban model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface CardSelectingEventArgs { /** Returns the selecting cell index value. - */ + */ cellIndex?: number; /** Returns the selecting card index value. - */ + */ cardIndex?: number; /** Returns the selecting cell element - */ + */ currentCell?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the previously selecting the card element - */ + */ previousCard?: any; /** Returns the previously rowcell is selecting card indexes - */ + */ previousRowcellindex?: any[]; /** Returns the current item. - */ + */ currentTarget?: any; /** Returns the Kanban model. - */ + */ model?: any; /** Returns added data. - */ + */ data?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface CreateEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the kanban model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface CellClickEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the kanban model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the select cell index value. - */ + */ cellIndex?: number; /** Returns the edited row index. - */ + */ rowIndex?: number; } export interface ContextOpenEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the Kanban model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the current item. - */ + */ currentTarget?: any; /** Returns the status of contextmenu item which denotes its enabled state. - */ + */ status?: boolean; /** Returns the target item. - */ + */ target?: any; } export interface ContextClickEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the Kanban model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the current item. - */ + */ currentTarget?: any; /** Returns the status of contextmenu item which denotes its enabled state. - */ + */ status?: boolean; /** Returns the target item. - */ + */ target?: any; } export interface DataBoundEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the Kanban model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface DestroyEventArgs { /** Returns the kanban model. - */ + */ model?: any; /** Returns deleted data. - */ + */ data?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface EndDeleteEventArgs { /** Returns the Kanban model. - */ + */ model?: any; /** Returns request type. - */ + */ requestType?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns deleted data. - */ + */ data?: any; /** Returns the name of the event. - */ + */ type?: string; /** Current action name - */ + */ action?: string; } export interface EndEditEventArgs { /** Returns the Kanban model. - */ + */ model?: any; /** Returns request type. - */ + */ requestType?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns modified data. - */ + */ data?: any; /** Returns the name of the event. - */ + */ type?: string; /** Current Action name - */ + */ action?: string; } export interface HeaderClickEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the kanban model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the select cell index value. - */ + */ cellIndex?: number; /** Returns the column object. - */ + */ columnData?: any; } export interface LoadEventArgs { /** Returns the kanban model. - */ + */ model?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the name of the event. - */ + */ type?: string; } export interface QueryCellInfoEventArgs { /** Returns Kanban card. - */ + */ card?: any; /** Returns Kanban card. - */ + */ cell?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns current row record object (JSON). - */ + */ data?: any; /** Returns the column object. - */ + */ column?: any; /** Returns the Kanban model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface ToolbarClickEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the current item. - */ + */ currentTarget?: any; /** Returns the item id of that current element. - */ + */ itemId?: string; /** Returns the item index of that current element. - */ + */ itemIndex?: number; /** Returns the item name of that current element. - */ + */ itemName?: string; /** Returns the item text of that current element. - */ + */ itemText?: string; /** Returns the Kanban model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the toolbar object of the Kanban. - */ + */ toolbarData?: any; } export interface SwimlaneSettingsUnassignedGroup { /** To enable or disable unassigned category change with swim lane key values. - * @Default {true} - */ + * @Default {true} + */ enable?: boolean; /** To set the user defined values which are need to categorized as unassigned category swim lane groups. - * @Default {[null,undefined,]} - */ + * @Default {[null,undefined,]} + */ keys?: any[]; } export interface SwimlaneSettings { /** To enable or disable items count in swim lane. - * @Default {true} - */ + * @Default {true} + */ showCount?: boolean; /** To enable or disable DragAndDrop across swim lane. - * @Default {false} - */ + * @Default {false} + */ allowDragAndDrop?: boolean; /** Customize the settings for unassigned category of swim lane. - * @Default {Object} - */ + * @Default {Object} + */ unassignedGroup?: SwimlaneSettingsUnassignedGroup; } export interface ContextMenuSettingsCustomMenuItem { /** Its sets target element to custom context menu item. - * @Default {ej.Kanban.Target.All} - */ + * @Default {ej.Kanban.Target.All} + */ target?: ej.Kanban.Target|string; /** Gets the display name to custom menu item. - * @Default {null} - */ + * @Default {null} + */ text?: string; /** Gets the template to render custom context menu item. - * @Default {null} - */ + * @Default {null} + */ template?: string; } export interface ContextMenuSettings { /** To enable context menu.All default context menu will show. - * @Default {false} - */ + * @Default {false} + */ enable?: boolean; /** Gets or sets a value that indicates the list of items needs to be disable from default context menu items. - * @Default {Array} - */ + * @Default {Array} + */ disableDefaultItems?: any[]; /** Its used to add specific default context menu items. - * @Default {Array} - */ + * @Default {Array} + */ menuItems?: any[]; /** Gets or sets a value that indicates whether to add custom contextMenu items. - * @Default {Array} - */ + * @Default {Array} + */ customMenuItems?: ContextMenuSettingsCustomMenuItem[]; } export interface ColumnsTotalCount { /** To customize the totalCount text properties. - * @Default {null} - */ + * @Default {null} + */ text?: string; } export interface ColumnsConstraints { /** It is used to specify the type of constraints as column or swimlane. - * @Default {null} - */ + * @Default {null} + */ type?: string; /** It is used to specify the minimum amount of card in particular column cell or swimlane cell can hold. - * @Default {null} - */ + * @Default {null} + */ min?: number; /** It is used to specify the maximum amount of card in particular column cell or swimlane cell can hold. - * @Default {null} - */ + * @Default {null} + */ max?: number; } export interface Column { /** Gets or sets an object that indicates to render the Kanban with specified columns header text. - * @Default {null} - */ + * @Default {null} + */ headerText?: string; /** To customize the totalCount properties. - * @Default {Object} - */ + * @Default {Object} + */ totalCount?: ColumnsTotalCount; /** Gets or sets an object that indicates to render the Kanban with specified columns key. - * @Default {null} - */ + * @Default {null} + */ key?: string|number; /** To enable/disable allowDrop for specific column wise. - * @Default {true} - */ + * @Default {true} + */ allowDrop?: boolean; /** To enable/disable allowDrag for specific column wise. - * @Default {true} - */ + * @Default {true} + */ allowDrag?: boolean; /** To set column collapse or expand state - * @Default {false} - */ + * @Default {false} + */ isCollapsed?: boolean; /** To customize the column level constraints with minimum ,maximum limit validation. - * @Default {Object} - */ + * @Default {Object} + */ constraints?: ColumnsConstraints; /** Gets or sets a value that indicates to add the template within the header element. - * @Default {null} - */ + * @Default {null} + */ headerTemplate?: string; /** Gets or sets an object that indicates to render the Kanban with specified columns width. - * @Default {null} - */ + * @Default {null} + */ width?: string|number; /** Gets or sets an object that indicates to set specific column visibility. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Gets or sets an object that indicates whether to show add new button. - * @Default {false} - */ + * @Default {false} + */ showAddButton?: boolean; } export interface CardSettings { /** Gets or sets a value that indicates to add the template for card . - * @Default {null} - */ + * @Default {null} + */ template?: string; /** To customize the card border color based on assigned task. Colors and corresponding values defined here will be mapped with colorField mapped data source column. - * @Default {Object} - */ + * @Default {Object} + */ colorMapping?: any; } export interface CustomToolbarItem { /** Gets the template to render customToolbarItems. - * @Default {null} - */ + * @Default {null} + */ template?: string; } export interface EditSettingsEditItem { /** It is used to map editing field from the data source. - * @Default {null} - */ + * @Default {null} + */ field?: string; /** It is used to set the particular editType in the card for editing. - * @Default {ej.Kanban.EditingType.String} - */ + * @Default {ej.Kanban.EditingType.String} + */ editType?: ej.Kanban.EditingType|string; /** Gets or sets a value that indicates to define constraints for saving data to the database. - * @Default {Object} - */ + * @Default {Object} + */ validationRules?: any; /** It is used to set the particular editparams in the card for editing. - * @Default {Object} - */ + * @Default {Object} + */ editParams?: any; /** It is used to specify defaultValue for the fields while adding new card. - * @Default {null} - */ + * @Default {null} + */ defaultValue?: string|number; } export interface EditSettings { /** Gets or sets a value that indicates whether to enable the editing action in cards of Kanban. - * @Default {false} - */ + * @Default {false} + */ allowEditing?: boolean; /** Gets or sets a value that indicates whether to enable the adding action in cards behavior on Kanban. - * @Default {false} - */ + * @Default {false} + */ allowAdding?: boolean; /** This specifies the id of the template which is require to be edited using the Dialog Box. - * @Default {null} - */ + * @Default {null} + */ dialogTemplate?: string; /** Get or sets an object that indicates whether to customize the editMode of the Kanban. - * @Default {ej.Kanban.EditMode.Dialog} - */ + * @Default {ej.Kanban.EditMode.Dialog} + */ editMode?: ej.Kanban.EditMode|string; /** Get or sets an object that indicates whether to customize the editing fields of Kanban card. - * @Default {Array} - */ + * @Default {Array} + */ editItems?: EditSettingsEditItem[]; /** This specifies the id of the template which is require to be edited using the External edit form. - * @Default {null} - */ + * @Default {null} + */ externalFormTemplate?: string; /** This specifies to set the position of an External edit form either in the right or bottom of the Kanban. - * @Default {ej.Kanban.FormPosition.Bottom} - */ + * @Default {ej.Kanban.FormPosition.Bottom} + */ formPosition?: ej.Kanban.FormPosition|string; } export interface Fields { /** The primarykey field is mapped to data source field. And this will used for Drag and drop and editing mainly. - * @Default {null} - */ + * @Default {null} + */ primaryKey?: string; /** To enable swimlane grouping based on the given key field from datasource mapping. - * @Default {null} - */ + * @Default {null} + */ swimlaneKey?: string; /** Priority field has been mapped data source field to maintain cards priority. - * @Default {null} - */ + * @Default {null} + */ priority?: string; /** Content field has been Mapped into card text. - * @Default {null} - */ + * @Default {null} + */ content?: string; /** Tag field has been Mapped into card tag. - * @Default {null} - */ + * @Default {null} + */ tag?: string; /** Title field has been Mapped to field in datasource for title content. If title field specified , card expand/collapse will be enabled with header and content section. - * @Default {null} - */ + * @Default {null} + */ title?: string; /** To customize the card has been Mapped into card color field. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** ImageUrl field has been Mapped into card image. - * @Default {null} - */ + * @Default {null} + */ imageUrl?: string; } export interface FilterSetting { /** Gets or sets an object of display name to filter queries. - * @Default {null} - */ + * @Default {null} + */ text?: string; /** Gets or sets an object that Queries to perform filtering - * @Default {Object} - */ + * @Default {Object} + */ query?: any; /** Gets or sets an object of tooltip to filter buttons. - * @Default {null} - */ + * @Default {null} + */ description?: string; } export interface ScrollSettings { /** Gets or sets an object that indicates to render the Kanban with specified scroll height. - * @Default {0} - */ + * @Default {0} + */ height?: string|number; /** Gets or sets an object that indicates to render the Kanban with specified scroll width. - * @Default {auto} - */ + * @Default {auto} + */ width?: string|number; /** To allow the Kanban to freeze particular swimlane at the time of scrolling , until scroll reaches next swimlane and it continues. - * @Default {false} - */ + * @Default {false} + */ allowFreezeSwimlane?: boolean; } export interface SearchSettings { /** To customize the fields the searching operation can be perform. - * @Default {Array} - */ + * @Default {Array} + */ fields?: any[]; /** To customize the searching string. - */ + */ key?: string; /** To customize the operator based on searching. - * @Default {contains} - */ + * @Default {contains} + */ operator?: string; /** To customize the ignore case based on searching. - * @Default {true} - */ + * @Default {true} + */ ignoreCase?: boolean; } export interface StackedHeaderRowsStackedHeaderColumn { /** Gets or sets a value that indicates the headerText for the particular stacked header column. - * @Default {null} - */ + * @Default {null} + */ headerText?: string; /** Gets or sets a value that indicates the column for the particular stacked header column. - * @Default {null} - */ + * @Default {null} + */ column?: string; } export interface StackedHeaderRow { /** Gets or sets a value that indicates whether to add stacked header columns into the stacked header rows. - * @Default {Array} - */ + * @Default {Array} + */ stackedHeaderColumns?: StackedHeaderRowsStackedHeaderColumn[]; } export interface TooltipSettings { /** To enable or disable the tooltip display. - * @Default {false} - */ + * @Default {false} + */ enable?: boolean; /** To customize the tooltip display based on your requirements. - * @Default {null} - */ + * @Default {null} + */ template?: string; } export interface Workflow { /** Gets or sets an object that indicates to render the Kanban with specified workflows key. - * @Default {null} - */ + * @Default {null} + */ key?: string|number; /** Gets or sets an object that indicates to render the Kanban with specified workflows allowed Transitions. - * @Default {null} - */ + * @Default {null} + */ allowedTransitions?: string; } @@ -14695,51 +14695,51 @@ class Rotator extends ej.Widget { defaults: Rotator.Model; /** Disables the Rotator control. - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** Enables the Rotator control. - * @returns {void} - */ + * @returns {void} + */ enable(): void; /** This method is used to get the current slide index. - * @returns {number} - */ + * @returns {number} + */ getIndex(): number; /** This method is used to move a slide to the specified index. - * @param {number} index of an slide - * @returns {void} - */ + * @param {number} index of an slide + * @returns {void} + */ gotoIndex(index: number): void; /** This method is used to pause autoplay. - * @returns {void} - */ + * @returns {void} + */ pause(): void; /** This method is used to move slides continuously (or start autoplay) in the specified autoplay direction. - * @returns {void} - */ + * @returns {void} + */ play(): void; /** This method is used to move to the next slide from the current slide. If the current slide is the last slide, then the first slide will be treated as the next slide. - * @returns {void} - */ + * @returns {void} + */ slideNext(): void; /** This method is used to move to the previous slide from the current slide. If the current slide is the first slide, then the last slide will be treated as the previous slide. - * @returns {void} - */ + * @returns {void} + */ slidePrevious(): void; /** This method is used to update/modify the slide content of template rotator by using id based on index value. - * @param {number} index of an slide - * @param {string} id of a new updated slide - * @returns {void} - */ + * @param {number} index of an slide + * @param {string} id of a new updated slide + * @returns {void} + */ updateTemplateById(index: number, id: string): void; } export namespace Rotator { @@ -14747,152 +14747,152 @@ export namespace Rotator { export interface Model { /** Turns on keyboard interaction with the Rotator items. You must set this property to true to access the following keyboard shortcuts: - * @Default {true} - */ + * @Default {true} + */ allowKeyboardNavigation?: boolean; /** Sets the animationSpeed of slide transition. - * @Default {600} - */ + * @Default {600} + */ animationSpeed?: string|number; /** Specifies the animationType type for the Rotator Item. animationType options include slide, fastSlide, slowSlide, and other custom easing animationTypes. - * @Default {slide} - */ + * @Default {slide} + */ animationType?: string; /** Enables the circular mode item rotation. - * @Default {true} - */ + * @Default {true} + */ circularMode?: boolean; /** Specify the CSS class to Rotator to achieve custom theme. - */ + */ cssClass?: string; /** Specify the list of data which contains a set of data fields. Each data value is used to render an item for the Rotator. - * @Default {null} - */ + * @Default {null} + */ dataSource?: any; /** Sets the delay between the Rotator Items move after the slide transition. - * @Default {500} - */ + * @Default {500} + */ delay?: number; /** Specifies the number of Rotator Items to be displayed. - * @Default {1} - */ + * @Default {1} + */ displayItemsCount?: string|number; /** Rotates the Rotator Items continuously without user interference. - * @Default {false} - */ + * @Default {false} + */ enableAutoPlay?: boolean; /** Enables or disables the Rotator control. - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Specifies right to left transition of slides. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Defines mapping fields for the data items of the Rotator. - * @Default {null} - */ + * @Default {null} + */ fields?: Fields; /** Sets the space between the Rotator Items. - */ + */ frameSpace?: string|number; /** Resizes the Rotator when the browser is resized. - * @Default {false} - */ + * @Default {false} + */ isResponsive?: boolean; /** Specifies the number of Rotator Items to navigate on a single click (next/previous/play buttons). - * The navigateSteps property value must be less than or equal to the displayItemsCount property value. - * @Default {1} - */ + * The navigateSteps property value must be less than or equal to the displayItemsCount property value. + * @Default {1} + */ navigateSteps?: string|number; /** Specifies the orientation for the Rotator control, that is, whether it must be rendered horizontally or vertically. See Orientation - * @Default {ej.Orientation.Horizontal} - */ + * @Default {ej.Orientation.Horizontal} + */ orientation?: ej.Orientation|string; /** Specifies the position of the showPager in the Rotator Item. See PagerPosition - * @Default {outside} - */ + * @Default {outside} + */ pagerPosition?: string|ej.Rotator.PagerPosition; /** Retrieves data from remote data. This property is applicable only when a remote data source is used. - * @Default {null} - */ + * @Default {null} + */ query?: string; /** If the Rotator Item is an image, you can specify a caption for the Rotator Item. The caption text for each Rotator Item must be set by using the title attribute of the respective tag. - * The caption cannot be displayed if multiple Rotator Items are present. - * @Default {false} - */ + * The caption cannot be displayed if multiple Rotator Items are present. + * @Default {false} + */ showCaption?: boolean; /** Turns on or off the slide buttons (next and previous) in the Rotator Items. Slide buttons are used to navigate the Rotator Items. - * @Default {true} - */ + * @Default {true} + */ showNavigateButton?: boolean; /** Turns on or off the pager support in the Rotator control. The Pager is used to navigate the Rotator Items. - * @Default {true} - */ + * @Default {true} + */ showPager?: boolean; /** Enable play / pause button on rotator. - * @Default {false} - */ + * @Default {false} + */ showPlayButton?: boolean; /** Turns on or off thumbnail support in the Rotator control. Thumbnail is used to navigate between slides. Thumbnail supports only single slide transition - * You must specify the source for thumbnail elements through the thumbnailSourceID property. - * @Default {false} - */ + * You must specify the source for thumbnail elements through the thumbnailSourceID property. + * @Default {false} + */ showThumbnail?: boolean; /** Sets the height of a Rotator Item. - */ + */ slideHeight?: string|number; /** Sets the width of a Rotator Item. - */ + */ slideWidth?: string|number; /** Sets the index of the slide that must be displayed first. - * @Default {0} - */ + * @Default {0} + */ startIndex?: string|number; /** Pause the auto play while hover on the rotator content. - * @Default {false} - */ + * @Default {false} + */ stopOnHover?: boolean; /** The template to display the Rotator widget with customized appearance. - * @Default {null} - */ + * @Default {null} + */ template?: string; /** The templateId enables to bind multiple customized template items in Rotator. - * @Default {null} - */ + * @Default {null} + */ templateId?: any[]; /** Specifies the source for thumbnail elements. - * @Default {null} - */ + * @Default {null} + */ thumbnailSourceID?: any; /** This event is fired when the Rotator slides are changed. */ @@ -14920,172 +14920,172 @@ export interface Model { export interface ChangeEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the rotator model - */ + */ model?: ej.Rotator.Model; /** returns the name of the event - */ + */ type?: string; /** the current rotator id. - */ + */ itemId?: string; /** returns the current slide index. - */ + */ activeItemIndex?: number; } export interface CreateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the rotator model - */ + */ model?: ej.Rotator.Model; /** returns the name of the event - */ + */ type?: string; } export interface DestroyEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the rotator model - */ + */ model?: ej.Rotator.Model; /** returns the name of the event - */ + */ type?: string; } export interface PagerClickEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the rotator model - */ + */ model?: ej.Rotator.Model; /** returns the name of the event - */ + */ type?: string; /** the current rotator id. - */ + */ itemId?: string; /** returns the current slide index. - */ + */ activeItemIndex?: number; } export interface StartEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the rotator model - */ + */ model?: ej.Rotator.Model; /** returns the name of the event - */ + */ type?: string; /** the current rotator id. - */ + */ itemId?: string; /** returns the current slide index. - */ + */ activeItemIndex?: number; } export interface StopEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the rotator model - */ + */ model?: ej.Rotator.Model; /** returns the name of the event - */ + */ type?: string; /** the current rotator id. - */ + */ itemId?: string; /** returns the current slide index. - */ + */ activeItemIndex?: number; } export interface ThumbItemClickEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the rotator model - */ + */ model?: ej.Rotator.Model; /** returns the name of the event - */ + */ type?: string; /** the current rotator id. - */ + */ itemId?: string; /** returns the current slide index. - */ + */ activeItemIndex?: number; } export interface Fields { /** Specifies a link for the image. - */ + */ linkAttribute?: string; /** Specifies where to open a given link. - */ + */ targetAttribute?: string; /** Specifies a caption for the image. - */ + */ text?: string; /** Specifies a caption for the thumbnail image. - */ + */ thumbnailText?: string; /** Specifies the URL for an thumbnail image. - */ + */ thumbnailUrl?: string; /** Specifies the URL for an image. - */ + */ url?: string; } @@ -15120,151 +15120,151 @@ class RTE extends ej.Widget { defaults: RTE.Model; /** Returns the range object. - * @returns {any} - */ + * @returns {any} + */ createRange(): any; /** Disables the RTE control. - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** Disables the corresponding tool in the RTE ToolBar. - * @returns {void} - */ + * @returns {void} + */ disableToolbarItem(): void; /** Enables the RTE control. - * @returns {void} - */ + * @returns {void} + */ enable(): void; /** Enables the corresponding tool in the toolbar when the tool is disabled. - * @returns {void} - */ + * @returns {void} + */ enableToolbarItem(): void; /** Performs the action value based on the given command. - * @returns {void} - */ + * @returns {void} + */ executeCommand(): void; /** Focuses the RTE control. - * @returns {void} - */ + * @returns {void} + */ focus(): void; /** Gets the command status of the selected text based on the given comment in the RTE control. - * @returns {boolean} - */ + * @returns {boolean} + */ getCommandStatus(): boolean; /** Gets the Document from the RTE control. - * @returns {Document} - */ + * @returns {Document} + */ getDocument(): Document; /** Gets the HTML string from the RTE control. - * @returns {HTMLElement} - */ + * @returns {HTMLElement} + */ getHtml(): HTMLElement; /** Gets the selected HTML string from the RTE control. - * @returns {HTMLElement} - */ + * @returns {HTMLElement} + */ getSelectedHtml(): HTMLElement; /** Gets the content as string from the RTE control. - * @returns {string} - */ + * @returns {string} + */ getText(): string; /** Hides the RTE control. - * @returns {void} - */ + * @returns {void} + */ hide(): void; /** Inserts new item to the target contextmenu node. - * @returns {void} - */ + * @returns {void} + */ insertMenuOption(): void; /** Add a table column at the right or left of the specified cell - * @param {boolean} If itĂ¢â‚¬â„¢s true, add a column at the left of the cell, otherwise add a column at the right of the cell - * @param {JQuery} Column will be added based on the given cell element - * @returns {HTMLElement} - */ + * @param {boolean} If itĂ¢â‚¬â„¢s true, add a column at the left of the cell, otherwise add a column at the right of the cell + * @param {JQuery} Column will be added based on the given cell element + * @returns {HTMLElement} + */ insertColumn(before?: boolean, cell?: JQuery): HTMLElement; /** To add a table row below or above the specified cell. - * @param {boolean} If itĂ¢â‚¬â„¢s true, add a row before the cell, otherwise add a row after the cell - * @param {JQuery} Row will be added based on the given cell element - * @returns {HTMLElement} - */ + * @param {boolean} If itĂ¢â‚¬â„¢s true, add a row before the cell, otherwise add a row after the cell + * @param {JQuery} Row will be added based on the given cell element + * @returns {HTMLElement} + */ insertRow(before?: boolean, cell?: JQuery): HTMLElement; /** This method helps to insert/paste the content at the current cursor (caret) position or the selected content to be replaced with our text by passing the value as parameter to the - * pasteContent method in the Editor. - * @returns {void} - */ + * pasteContent method in the Editor. + * @returns {void} + */ pasteContent(): void; /** Refreshes the RTE control. - * @returns {void} - */ + * @returns {void} + */ refresh(): void; /** Removes the specified table column. - * @param {JQuery} Remove the given column element - * @returns {void} - */ + * @param {JQuery} Remove the given column element + * @returns {void} + */ removeColumn(cell?: JQuery): void; /** Removes the specified table row. - * @param {JQuery} Remove the given row element - * @returns {void} - */ + * @param {JQuery} Remove the given row element + * @returns {void} + */ removeRow(cell?: JQuery): void; /** Deletes the specified table. - * @param {JQuery} Remove the given table - * @returns {void} - */ + * @param {JQuery} Remove the given table + * @returns {void} + */ removeTable(table?: JQuery): void; /** Removes the target menu item from the RTE contextmenu. - * @returns {void} - */ + * @returns {void} + */ removeMenuOption(): void; /** Removes the given tool from the RTE Toolbar. - * @returns {void} - */ + * @returns {void} + */ removeToolbarItem(): void; /** Selects all the contents within the RTE. - * @returns {void} - */ + * @returns {void} + */ selectAll(): void; /** Selects the contents in the given range. - * @returns {void} - */ + * @returns {void} + */ selectRange(): void; /** Sets the color picker model type rendered initially in the RTE control. - * @returns {void} - */ + * @returns {void} + */ setColorPickerType(): void; /** Sets the HTML string from the RTE control. - * @returns {void} - */ + * @returns {void} + */ setHtml(): void; /** Displays the RTE control. - * @returns {void} - */ + * @returns {void} + */ show(): void; } export namespace RTE { @@ -15272,306 +15272,306 @@ export namespace RTE { export interface Model { /** Enables/disables the editing of the content. - * @Default {True} - */ + * @Default {True} + */ allowEditing?: boolean; /** RTE control can be accessed through the keyboard shortcut keys. - * @Default {True} - */ + * @Default {True} + */ allowKeyboardNavigation?: boolean; /** When the property is set to true, it focuses the RTE at the time of rendering. - * @Default {false} - */ + * @Default {false} + */ autoFocus?: boolean; /** Based on the content size, its height is adjusted instead of adding the scrollbar. - * @Default {false} - */ + * @Default {false} + */ autoHeight?: boolean; /** Sets the colorCode to display the color of the fontColor and backgroundColor in the font tools of the RTE. - * @Default {[000000, FFFFFF, C4C4C4, ADADAD, 595959, 262626, 4f81bd, dbe5f1, b8cce4, 95b3d7, 366092, 244061, c0504d, f2dcdb, e5b9b7, d99694, 953734,632423, 9bbb59, - ebf1dd, d7e3bc, c3d69b, 76923c, 4f6128, 8064a2, e5e0ec, ccc1d9, b2a2c7, 5f497a, 3f3151, f79646, fdeada, fbd5b5, fac08f,e36c09, 974806]} - */ + * @Default {[000000, FFFFFF, C4C4C4, ADADAD, 595959, 262626, 4f81bd, dbe5f1, b8cce4, 95b3d7, 366092, 244061, c0504d, f2dcdb, e5b9b7, d99694, 953734,632423, 9bbb59, + * ebf1dd, d7e3bc, c3d69b, 76923c, 4f6128, 8064a2, e5e0ec, ccc1d9, b2a2c7, 5f497a, 3f3151, f79646, fdeada, fbd5b5, fac08f,e36c09, 974806]} + */ colorCode?: any; /** The number of columns given are rendered in the color palate popup. - * @Default {6} - */ + * @Default {6} + */ colorPaletteColumns?: number; /** The number of rows given are rendered in the color palate popup. - * @Default {6} - */ + * @Default {6} + */ colorPaletteRows?: number; /** Sets the root class for the RTE theme. This cssClass API helps the usage of custom skinning option for the RTE control by including this root class in CSS. - */ + */ cssClass?: string; /** Enables/disables the RTE controlĂ¢â‚¬â„¢s accessibility or interaction. - * @Default {True} - */ + * @Default {True} + */ enabled?: boolean; /** When the property is set to true, it returns the encrypted text. - * @Default {false} - */ + * @Default {false} + */ enableHtmlEncode?: boolean; /** Maintain the values of the RTE after page reload. - * @Default {false} - */ + * @Default {false} + */ enablePersistence?: boolean; /** Shows the resize icon and enables the resize option in the RTE. - * @Default {True} - */ + * @Default {True} + */ enableResize?: boolean; /** Shows the RTE in the RTL direction. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Formats the contents based on the XHTML rules. - * @Default {false} - */ + * @Default {false} + */ enableXHTML?: boolean; /** Enables the tab key action with the RichTextEditor content. - * @Default {True} - */ + * @Default {True} + */ enableTabKeyNavigation?: boolean; /** This API allows to enable url and fileName for pdf export. - * @Default {null} - */ + * @Default {null} + */ exportToPdfSettings?: ExportToPdfSettings; /** This API allows to enable url and fileName for word export. - * @Default {null} - */ + * @Default {null} + */ exportToWordSettings?: ExportToWordSettings; /** Load the external CSS file inside Iframe. - * @Default {null} - */ + * @Default {null} + */ externalCSS?: string; /** This API allows to enable the file browser support in the RTE control to browse, create, delete and upload the files in the specified current directory. - * @Default {null} - */ + * @Default {null} + */ fileBrowser?: FileBrowser; /** Sets the fontName in the RTE. - * @Default {{text: Segoe UI, value: Segoe UI },{text: Arial, value: Arial,Helvetica,sans-serif },{text: Courier New, value: Courier New,Courier,Monospace }, - * {text: Georgia, value: Georgia,serif },{text: Impact, value: Impact,Charcoal,sans-serif },{text: Lucida Console, value: Lucida Console,Monaco,Monospace }, - * {text: Tahoma, value: Tahoma,Geneva,sans-serif },{text: Times New Roman, value: Times New Roman },{text: Trebuchet MS, value: Trebuchet MS,Helvetica,sans-serif }, - * {text: Verdana, value: Verdana,Geneva,sans-serif}} - */ + * @Default {{text: Segoe UI, value: Segoe UI },{text: Arial, value: Arial,Helvetica,sans-serif },{text: Courier New, value: Courier New,Courier,Monospace }, + * {text: Georgia, value: Georgia,serif },{text: Impact, value: Impact,Charcoal,sans-serif },{text: Lucida Console, value: Lucida Console,Monaco,Monospace }, + * {text: Tahoma, value: Tahoma,Geneva,sans-serif },{text: Times New Roman, value: Times New Roman },{text: Trebuchet MS, value: Trebuchet MS,Helvetica,sans-serif }, + * {text: Verdana, value: Verdana,Geneva,sans-serif}} + */ fontName?: any; /** Sets the fontSize in the RTE. - * @Default {{ text: 1, value: 1 },{ text: 2 (10pt), value: 2 },{ text: 3 (12pt), value: 3 },{ text: 4 (14pt), value: 4 },{ text: 5 (18pt), value: 5 }, - * { text: 6 (24pt), value: 6 },{ text: 7 (36pt), value: 7 }} - */ + * @Default {{ text: 1, value: 1 },{ text: 2 (10pt), value: 2 },{ text: 3 (12pt), value: 3 },{ text: 4 (14pt), value: 4 },{ text: 5 (18pt), value: 5 }, + * { text: 6 (24pt), value: 6 },{ text: 7 (36pt), value: 7 }} + */ fontSize?: any; /** Sets the format in the RTE. - * @Default {{ text: Paragraph, value: <p>, spriteCssClass: e-paragraph },{ text: Quotation, value: <blockquote>, spriteCssClass: e-quotation }, - * { text: Heading 1, value: <h1>, spriteCssClass: e-h1 },{ text: Heading 2, value: <h2>, spriteCssClass: e-h2 },{ text: Heading 3, value: <h3>, spriteCssClass: e-h3 }, - * { text: Heading 4, value: <h4>, spriteCssClass: e-h4 },{ text: Heading 5, value: <h5>, spriteCssClass: e-h5 },{ text: Heading 6, value: <h6>, spriteCssClass: e-h6}} - */ + * @Default {{ text: Paragraph, value: <p>, spriteCssClass: e-paragraph },{ text: Quotation, value: <blockquote>, spriteCssClass: e-quotation }, + * { text: Heading 1, value: <h1>, spriteCssClass: e-h1 },{ text: Heading 2, value: <h2>, spriteCssClass: e-h2 },{ text: Heading 3, value: <h3>, spriteCssClass: e-h3 }, + * { text: Heading 4, value: <h4>, spriteCssClass: e-h4 },{ text: Heading 5, value: <h5>, spriteCssClass: e-h5 },{ text: Heading 6, value: <h6>, spriteCssClass: e-h6}} + */ format?: string; /** Defines the height of the RTE textbox. - * @Default {370} - */ + * @Default {370} + */ height?: string|number; /** Specifies the HTML Attributes of the ejRTE. - * @Default {{}} - */ + * @Default {{}} + */ htmlAttributes?: any; /** Sets the given attributes to the iframe body element. - * @Default {{}} - */ + * @Default {{}} + */ iframeAttributes?: any; /** This API allows the image browser to support in the RTE control to browse, create, delete, and upload the image files to the specified current directory. - * @Default {null} - */ + * @Default {null} + */ imageBrowser?: ImageBrowser; /** This API allows to enable the url for connecting to RTE import. - * @Default {null} - */ + * @Default {null} + */ importSettings?: ImportSettings; /** Enables/disables responsive support for the RTE control toolbar items during the window resizing time. - * @Default {false} - */ + * @Default {false} + */ isResponsive?: boolean; /** Sets the culture in the RTE when you set the localization values are needs to be assigned to the corresponding text as follows. - * @Default {en-US} - */ + * @Default {en-US} + */ locale?: string; /** Sets the maximum height for the RTE outer wrapper element. - * @Default {null} - */ + * @Default {null} + */ maxHeight?: string|number; /** Sets the maximum length for the RTE outer wrapper element. - * @Default {7000} - */ + * @Default {7000} + */ maxLength?: number; /** Sets the maximum width for the RTE outer wrapper element. - * @Default {null} - */ + * @Default {null} + */ maxWidth?: string|number; /** Sets the minimum height for the RTE outer wrapper element. - * @Default {280} - */ + * @Default {280} + */ minHeight?: string|number; /** Sets the minimum width for the RTE outer wrapper element. - * @Default {400} - */ + * @Default {400} + */ minWidth?: string|number; /** Sets the name in the RTE. When the name value is not initialized, the ID value is assigned to the name. - */ + */ name?: string; /** Shows ClearAll icon in the RTE footer. - * @Default {false} - */ + * @Default {false} + */ showClearAll?: boolean; /** Shows the clear format in the RTE footer. - * @Default {true} - */ + * @Default {true} + */ showClearFormat?: boolean; /** Shows the Custom Table in the RTE. - * @Default {True} - */ + * @Default {True} + */ showCustomTable?: boolean; /** The showContextMenu property helps to enable custom context menu within editor area. - * @Default {True} - */ + * @Default {True} + */ showContextMenu?: boolean; /** This API is used to set the default dimensions for the image and video. When this property is set to true, the image and video dialog displays the dimension option. - * @Default {false} - */ + * @Default {false} + */ showDimensions?: boolean; /** Shows the FontOption in the RTE. - * @Default {True} - */ + * @Default {True} + */ showFontOption?: boolean; /** Shows footer in the RTE. When the footer is enabled, it displays the HTML tag, word Count, character count, clear format, resize icon and clear all the content icons, by default. - * @Default {false} - */ + * @Default {false} + */ showFooter?: boolean; /** Shows the HtmlSource in the RTE footer. - * @Default {false} - */ + * @Default {false} + */ showHtmlSource?: boolean; /** When the cursor is placed or when the text is selected in the RTE, it displays the tag info in the footer. - * @Default {True} - */ + * @Default {True} + */ showHtmlTagInfo?: boolean; /** Shows the toolbar in the RTE. - * @Default {True} - */ + * @Default {True} + */ showToolbar?: boolean; /** Counts the total characters and displays it in the RTE footer. - * @Default {True} - */ + * @Default {True} + */ showCharCount?: boolean; /** Enables or disables rounded corner UI look for RTE. - * @Default {false} - */ + * @Default {false} + */ showRoundedCorner?: boolean; /** Counts the total words and displays it in the RTE footer. - * @Default {True} - */ + * @Default {True} + */ showWordCount?: boolean; /** The given number of columns render the insert table pop. - * @Default {10} - */ + * @Default {10} + */ tableColumns?: number; /** The given number of rows render the insert table pop. - * @Default {8} - */ + * @Default {8} + */ tableRows?: number; /** Sets the tools in the RTE and gets the inner display order of the corresponding group element. Tools are dependent on the toolsList property. - * @Default {formatStyle: [format],style: [bold, italic, underline, strikethrough],alignment: [justifyLeft, justifyCenter, justifyRight, justifyFull],lists: [unorderedList, orderedList], - * indenting: [outdent, indent],doAction: [undo, redo],links: [createLink,removeLink],images: [image],media: [video],tables: [createTable, addRowAbove, addRowBelow, - * addColumnLeft, addColumnRight, deleteRow, deleteColumn, deleteTable]],view:[Ă¢â‚¬Å“fullScreenĂ¢â‚¬Â,zoomIn,zoomOut],print:[print]} - */ + * @Default {formatStyle: [format],style: [bold, italic, underline, strikethrough],alignment: [justifyLeft, justifyCenter, justifyRight, justifyFull],lists: [unorderedList, orderedList], + * indenting: [outdent, indent],doAction: [undo, redo],links: [createLink,removeLink],images: [image],media: [video],tables: [createTable, addRowAbove, addRowBelow, + * addColumnLeft, addColumnRight, deleteRow, deleteColumn, deleteTable]],view:[Ă¢â‚¬Å“fullScreenĂ¢â‚¬Â,zoomIn,zoomOut],print:[print]} + */ tools?: Tools; /** Specifies the list of groups and order of those groups displayed in the RTE toolbar. The toolsList property is used to get the root group order and tools property is used to get the - * inner order of the corresponding groups displayed. When the value is not specified, it gets its default display order and tools. - * @Default {[formatStyle, font, style, effects, alignment, lists, indenting, clipboard, doAction, clear, links, images, media, tables, casing,view, customTools,print,edit]} - */ + * inner order of the corresponding groups displayed. When the value is not specified, it gets its default display order and tools. + * @Default {[formatStyle, font, style, effects, alignment, lists, indenting, clipboard, doAction, clear, links, images, media, tables, casing,view, customTools,print,edit]} + */ toolsList?: any[]; /** Display the hints for the tools in the Toolbar. - * @Default {{ associate: mouseenter, showShadow: true, position: { stem: { horizontal: left, vertical: top } }, tip: { size: { width: 5, height: 5 }, isBalloon: false }} - */ + * @Default {{ associate: mouseenter, showShadow: true, position: { stem: { horizontal: left, vertical: top } }, tip: { size: { width: 5, height: 5 }, isBalloon: false }} + */ tooltipSettings?: any; /** Gets the undo stack limit. - * @Default {50} - */ + * @Default {50} + */ undoStackLimit?: number; /** The given string value is displayed in the editable area. - * @Default {null} - */ + * @Default {null} + */ value?: string; /** Sets the jQuery validation rules to the Rich Text Editor. - * @Default {null} - */ + * @Default {null} + */ validationRules?: any; /** Sets the jQuery validation error message to the Rich Text Editor. - * @Default {null} - */ + * @Default {null} + */ validationMessage?: any; /** Defines the width of the RTE textbox. - * @Default {786} - */ + * @Default {786} + */ width?: string|number; /** Increases and decreases the contents zoom range in percentage - * @Default {0.05} - */ + * @Default {0.05} + */ zoomStep?: string|number; /** Fires when changed successfully. */ @@ -15605,339 +15605,339 @@ export interface Model { export interface ChangeEventArgs { /** When the event is canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the RTE model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface CreateEventArgs { /** When the event is canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the RTE model - */ + */ model?: any; /** Returns the name of the event - */ + */ type?: string; } export interface ContextMenuClickEventArgs { /** returns clicked menu item text. - */ + */ text?: string; /** returns clicked menu item element. - */ + */ element?: any; /** returns the selected item. - */ + */ selectedItem?: number; } export interface DestroyEventArgs { /** When the event is canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the RTE model - */ + */ model?: any; /** Returns the name of the event - */ + */ type?: string; } export interface ExecuteEventArgs { /** When the event is canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the RTE model - */ + */ model?: any; /** Returns the name of the event - */ + */ type?: string; } export interface KeydownEventArgs { /** When the event is canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the RTE model - */ + */ model?: any; /** Returns the name of the event - */ + */ type?: string; } export interface KeyupEventArgs { /** When the event is canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the RTE model - */ + */ model?: any; /** Returns the name of the event - */ + */ type?: string; } export interface PreRenderEventArgs { /** When the event is canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the RTE model - */ + */ model?: any; /** Returns the name of the event - */ + */ type?: string; } export interface SelectEventArgs { /** When the event is canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the RTE model - */ + */ model?: any; /** Returns the name of the event - */ + */ type?: string; /** Returns the event object - */ + */ event?: any; } export interface ExportToPdfSettings { /** This API is used to receive the server-side handler for export related operations. - */ + */ url?: string; /** Specifies the file name for the exported pdf file. - */ + */ fileName?: string; } export interface ExportToWordSettings { /** This API is used to receive the server-side handler for export related operations. - */ + */ url?: string; /** Specifies the file name for the exported word file. - */ + */ fileName?: string; } export interface FileBrowser { /** This API is used to receive the server-side handler for file related operations. - */ + */ ajaxAction?: string; /** Specifies the file type extension shown in the file browser window. - */ + */ extensionAllow?: string; /** Specifies the directory to perform operations like create, delete and rename folder and files, and upload the selected files to the current directory. - */ + */ filePath?: string; } export interface ImageBrowser { /** This API is used to receive the server-side handler for the file related operations. - */ + */ ajaxAction?: string; /** Specifies the file type extension shown in the image browser window. - */ + */ extensionAllow?: string; /** Specifies the directory to perform operations like create, delete and rename folder and files, and upload the selected images to the current directory. - */ + */ filePath?: string; } export interface ImportSettings { /** This API is used to receive the server-side handler for import operations. - */ + */ url?: string; } export interface ToolsCustomOrderedList { /** Specifies the name for customOrderedList item. - */ + */ name?: string; /** Specifies the title for customOrderedList item. - */ + */ tooltip?: string; /** Specifies the styles for customOrderedList item. - */ + */ css?: string; /** Specifies the text for customOrderedList item. - */ + */ text?: string; /** Specifies the list style for customOrderedList item. - */ + */ listStyle?: string; /** Specifies the image for customOrderedList item. - */ + */ listImage?: string; } export interface ToolsCustomUnorderedList { /** Specifies the name for customUnorderedList item. - */ + */ name?: string; /** Specifies the title for customUnorderedList item. - */ + */ tooltip?: string; /** Specifies the styles for customUnorderedList item. - */ + */ css?: string; /** Specifies the text for customUnorderedList item. - */ + */ text?: string; /** Specifies the list style for customUnorderedList item. - */ + */ listStyle?: string; /** Specifies the image for customUnorderedList item. - */ + */ listImage?: string; } export interface Tools { /** Specifies the alignment tools and the display order of this tool in the RTE toolbar. - */ + */ alignment?: any; /** Specifies the casing tools and the display order of this tool in the RTE toolbar. - */ + */ casing?: any[]; /** Specifies the clear tools and the display order of this tool in the RTE toolbar. - */ + */ clear?: any[]; /** Specifies the clipboard tools and the display order of this tool in the RTE toolbar. - */ + */ clipboard?: any[]; /** Specifies the edit tools and the displays tool in the RTE toolbar. - */ + */ edit?: any[]; /** Specifies the doAction tools and the display order of this tool in the RTE toolbar. - */ + */ doAction?: any[]; /** Specifies the effect of tools and the display order of this tool in RTE toolbar. - */ + */ effects?: any[]; /** Specifies the font tools and the display order of this tool in the RTE toolbar. - */ + */ font?: any[]; /** Specifies the formatStyle tools and the display order of this tool in the RTE toolbar. - */ + */ formatStyle?: any[]; /** Specifies the image tools and the display order of this tool in the RTE toolbar. - */ + */ images?: any[]; /** Specifies the indent tools and the display order of this tool in the RTE toolbar. - */ + */ indenting?: any[]; /** Specifies the link tools and the display order of this tool in the RTE toolbar. - */ + */ links?: any[]; /** Specifies the list tools and the display order of this tool in the RTE toolbar. - */ + */ lists?: any[]; /** Specifies the media tools and the display order of this tool in the RTE toolbar. - */ + */ media?: any[]; /** Specifies the style tools and the display order of this tool in the RTE toolbar. - */ + */ style?: any[]; /** Specifies the table tools and the display order of this tool in the RTE toolbar. - */ + */ tables?: any[]; /** Specifies the view tools and the display order of this tool in the RTE toolbar. - */ + */ view?: any[]; /** Specifies the print tools and the display order of this tool in the RTE toolbar. - */ + */ print?: any[]; /** Specifies the importExport tools and the display order of this tool in the RTE toolbar. - */ + */ importExport?: any[]; /** Specifies the customOrderedList tools and the display order of this tool in the RTE toolbar. - */ + */ customOrderedList?: ToolsCustomOrderedList[]; /** Specifies the customUnOrderedList tools and the display order of this tool in the RTE toolbar. - */ + */ customUnorderedList?: ToolsCustomUnorderedList[]; } } @@ -15950,23 +15950,23 @@ class Slider extends ej.Widget { defaults: Slider.Model; /** To disable the slider - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** To enable the slider - * @returns {void} - */ + * @returns {void} + */ enable(): void; /** To get value from slider handle - * @returns {number} - */ + * @returns {number} + */ getValue(): number; /** To set value to slider handle.By default animation is false while set the value. If you want to enable the animation, pass the enableAnimation as true to this method. - * @returns {void} - */ + * @returns {void} + */ setValue(): void; } export namespace Slider { @@ -15974,122 +15974,122 @@ export namespace Slider { export interface Model { /** Specifies the allowMouseWheel of the slider. - * @Default {false} - */ + * @Default {false} + */ allowMouseWheel?: boolean; /** Specifies the animationSpeed of the slider. - * @Default {500} - */ + * @Default {500} + */ animationSpeed?: number; /** Specify the CSS class to slider to achieve custom theme. - */ + */ cssClass?: string; /** Specifies the animation behavior of the slider. - * @Default {true} - */ + * @Default {true} + */ enableAnimation?: boolean; /** Specifies the state of the slider. - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Specify the enablePersistence to slider to save current model value to browser cookies for state maintains - * @Default {false} - */ + * @Default {false} + */ enablePersistence?: boolean; /** Specifies the Right to Left Direction of the slider. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Specifies the height of the slider. - * @Default {14} - */ + * @Default {14} + */ height?: string; /** Specifies the HTML Attributes of the ejSlider. - * @Default {{}} - */ + * @Default {{}} + */ htmlAttributes?: any; /** Specifies the incremental step value of the slider. - * @Default {1} - */ + * @Default {1} + */ incrementStep?: number; /** Specifies the distance between two major (large) ticks from the scale of the slider. - * @Default {10} - */ + * @Default {10} + */ largeStep?: number; /** Specifies the ending value of the slider. - * @Default {100} - */ + * @Default {100} + */ maxValue?: number; /** Specifies the starting value of the slider. - * @Default {0} - */ + * @Default {0} + */ minValue?: number; /** Specifies the orientation of the slider. - * @Default {ej.orientation.Horizontal} - */ + * @Default {ej.orientation.Horizontal} + */ orientation?: ej.Orientation|string; /** Specifies the readOnly of the slider. - * @Default {false} - */ + * @Default {false} + */ readOnly?: boolean; /** Specifies the rounded corner behavior for slider. - * @Default {false} - */ + * @Default {false} + */ showRoundedCorner?: boolean; /** Shows/Hide the major (large) and minor (small) ticks in the scale of the slider. - * @Default {false} - */ + * @Default {false} + */ showScale?: boolean; /** Specifies the small ticks from the scale of the slider. - * @Default {true} - */ + * @Default {true} + */ showSmallTicks?: boolean; /** Specifies the showTooltip to shows the current Slider value, while moving the Slider handle or clicking on the slider handle of the slider. - * @Default {true} - */ + * @Default {true} + */ showTooltip?: boolean; /** Specifies the sliderType of the slider. - * @Default {ej.SliderType.Default} - */ + * @Default {ej.SliderType.Default} + */ sliderType?: ej.slider.sliderType|string; /** Specifies the distance between two minor (small) ticks from the scale of the slider. - * @Default {1} - */ + * @Default {1} + */ smallStep?: number; /** Specifies the value of the slider. But it's not applicable for range slider. To range slider we can use values property. - * @Default {0} - */ + * @Default {0} + */ value?: number; /** Specifies the values of the range slider. But it's not applicable for default and minRange sliders. we can use value property for default and minRange sliders. - * @Default {[minValue,maxValue]} - */ + * @Default {[minValue,maxValue]} + */ values?: any[]; /** Specifies the width of the slider. - * @Default {100%} - */ + * @Default {100%} + */ width?: string; /** Fires once Slider control value is changed successfully. */ @@ -16117,148 +16117,148 @@ export interface Model { export interface ChangeEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns current handle number or index - */ + */ sliderIndex?: number; /** returns slider id. - */ + */ id?: string; /** returns the slider model. - */ + */ model?: ej.Slider.Model; /** returns the name of the event. - */ + */ type?: string; /** returns the slider value. - */ + */ value?: number; /** returns true if event triggered by interaction else returns false. - */ + */ isInteraction?: boolean; } export interface CreateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the slider model - */ + */ model?: ej.Slider.Model; /** returns the name of the event - */ + */ type?: string; } export interface DestroyEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the slider model - */ + */ model?: ej.Slider.Model; /** returns the name of the event - */ + */ type?: string; } export interface SlideEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns current handle number or index - */ + */ sliderIndex?: number; /** returns slider id - */ + */ id?: string; /** returns the slider model - */ + */ model?: ej.Slider.Model; /** returns the name of the event - */ + */ type?: string; /** returns the slider value - */ + */ value?: number; } export interface StartEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns current handle number or index - */ + */ sliderIndex?: number; /** returns slider id - */ + */ id?: string; /** returns the slider model - */ + */ model?: ej.Slider.Model; /** returns the name of the event - */ + */ type?: string; /** returns the slider value - */ + */ value?: number; } export interface StopEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns current handle number or index - */ + */ sliderIndex?: number; /** returns slider id - */ + */ id?: string; /** returns the slider model - */ + */ model?: ej.Slider.Model; /** returns the name of the event - */ + */ type?: string; /** returns the slider value - */ + */ value?: number; } export interface TooltipChangeEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; } } @@ -16281,28 +16281,28 @@ class SplitButton extends ej.Widget { defaults: SplitButton.Model; /** Destroy the split button widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. - * @returns {void} - */ + * @returns {void} + */ destroy(): void; /** To disable the split button - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** To Enable the split button - * @returns {void} - */ + * @returns {void} + */ enable(): void; /** To hide the list content of the split button. - * @returns {void} - */ + * @returns {void} + */ hide(): void; /** To show the list content of the split button. - * @returns {void} - */ + * @returns {void} + */ show(): void; } export namespace SplitButton { @@ -16310,78 +16310,78 @@ export namespace SplitButton { export interface Model { /** Specifies the arrowPosition of the Split or Dropdown Button.See arrowPosition - * @Default {ej.ArrowPosition.Right} - */ + * @Default {ej.ArrowPosition.Right} + */ arrowPosition?: string|ej.ArrowPosition; /** Specifies the buttonMode like Split or Dropdown Button.See ButtonMode - * @Default {ej.ButtonMode.Split} - */ + * @Default {ej.ButtonMode.Split} + */ buttonMode?: string|ej.ButtonMode; /** Specifies the contentType of the Split Button.See ContentType - * @Default {ej.ContentType.TextOnly} - */ + * @Default {ej.ContentType.TextOnly} + */ contentType?: string|ej.ContentType; /** Set the root class for Split Button control theme - */ + */ cssClass?: string; /** Specifies the disabling of Split Button if enabled is set to false. - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Specifies the enableRTL property for Split Button while initialization. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Specifies the height of the Split Button. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ height?: string|number; /** Specifies the HTML Attributes of the Split Button. - * @Default {{}} - */ + * @Default {{}} + */ htmlAttributes?: any; /** Specifies the imagePosition of the Split Button.See imagePositions - * @Default {ej.ImagePosition.ImageRight} - */ + * @Default {ej.ImagePosition.ImageRight} + */ imagePosition?: string|ej.ImagePosition; /** Specifies the image content for Split Button while initialization. - */ + */ prefixIcon?: string; /** Specifies the showRoundedCorner property for Split Button while initialization. - * @Default {false} - */ + * @Default {false} + */ showRoundedCorner?: boolean; /** Specifies the size of the Button. See ButtonSize - * @Default {ej.ButtonSize.Normal} - */ + * @Default {ej.ButtonSize.Normal} + */ size?: string|ej.ButtonSize; /** Specifies the image content for Split Button while initialization. - */ + */ suffixIcon?: string; /** Specifies the list content for Split Button while initialization - */ + */ targetID?: string; /** Specifies the text content for Split Button while initialization. - */ + */ text?: string; /** Specifies the width of the Split Button. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ width?: string|number; /** Fires before menu of the split button control is opened. */ @@ -16415,183 +16415,183 @@ export interface Model { export interface BeforeOpenEventArgs { /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the split button model - */ + */ model?: ej.SplitButton.Model; /** returns the name of the event - */ + */ type?: string; } export interface ClickEventArgs { /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the split button model - */ + */ model?: ej.SplitButton.Model; /** returns the name of the event - */ + */ type?: string; /** returns the target of the current object. - */ + */ target?: any; /** return the button state - */ + */ status?: boolean; } export interface CloseEventArgs { /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the split button model - */ + */ model?: ej.SplitButton.Model; /** returns the name of the event - */ + */ type?: string; } export interface CreateEventArgs { /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the split button model - */ + */ model?: ej.SplitButton.Model; /** returns the name of the event - */ + */ type?: string; } export interface DestroyEventArgs { /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the split button model - */ + */ model?: ej.SplitButton.Model; /** returns the name of the event - */ + */ type?: string; } export interface ItemMouseOutEventArgs { /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the split button model - */ + */ model?: ej.SplitButton.Model; /** returns the name of the event - */ + */ type?: string; /** returns the clicked menu item element - */ + */ element?: any; /** return the menu item id - */ + */ ID?: string; /** return the clicked menu item text - */ + */ Text?: string; } export interface ItemMouseOverEventArgs { /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the split button model - */ + */ model?: ej.SplitButton.Model; /** returns the name of the event - */ + */ type?: string; /** returns the clicked menu item element - */ + */ element?: any; /** return the menu item id - */ + */ ID?: string; /** return the clicked menu item text - */ + */ Text?: string; } export interface ItemSelectedEventArgs { /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the split button model - */ + */ model?: ej.SplitButton.Model; /** returns the name of the event - */ + */ type?: string; /** returns the clicked menu item element - */ + */ element?: any; /** returns the selected item - */ + */ selectedItem?: any; /** return the menu id - */ + */ menuId?: string; /** return the clicked menu item text - */ + */ menuText?: string; } export interface OpenEventArgs { /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the split button model - */ + */ model?: ej.SplitButton.Model; /** returns the name of the event - */ + */ type?: string; } } @@ -16614,34 +16614,34 @@ class Splitter extends ej.Widget { defaults: Splitter.Model; /** To add a new pane to splitter control. - * @param {string} content of pane. - * @param {any} pane properties. - * @param {number} index of pane. - * @returns {HTMLElement} - */ + * @param {string} content of pane. + * @param {any} pane properties. + * @param {number} index of pane. + * @returns {HTMLElement} + */ addItem(content: string, property: any, index: number): HTMLElement; /** To collapse the splitter control pane. - * @param {number} index number of pane. - * @returns {void} - */ + * @param {number} index number of pane. + * @returns {void} + */ collapse(paneIndex: number): void; /** To expand the splitter control pane. - * @param {number} index number of pane. - * @returns {void} - */ + * @param {number} index number of pane. + * @returns {void} + */ expand(paneIndex: number): void; /** To refresh the splitter control pane resizing. - * @returns {void} - */ + * @returns {void} + */ refresh(): void; /** To remove a specified pane from the splitter control. - * @param {number} index of pane. - * @returns {void} - */ + * @param {number} index of pane. + * @returns {void} + */ removeItem(index: number): void; } export namespace Splitter { @@ -16649,58 +16649,58 @@ export namespace Splitter { export interface Model { /** Turns on keyboard interaction with the Splitter panes. You must set this property to true to access the keyboard shortcuts of ejSplitter. - * @Default {true} - */ + * @Default {true} + */ allowKeyboardNavigation?: boolean; /** Specify animation speed for the Splitter pane movement, while collapsing and expanding. - * @Default {300} - */ + * @Default {300} + */ animationSpeed?: number; /** Specify the CSS class to splitter control to achieve custom theme. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ cssClass?: string; /** Specifies the animation behavior of the splitter. - * @Default {true} - */ + * @Default {true} + */ enableAnimation?: boolean; /** Specifies the splitter control to be displayed in right to left direction. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Specify height for splitter control. - * @Default {null} - */ + * @Default {null} + */ height?: string; /** Specifies the HTML Attributes of the Splitter. - * @Default {{}} - */ + * @Default {{}} + */ htmlAttributes?: any; /** Specify window resizing behavior for splitter control. - * @Default {false} - */ + * @Default {false} + */ isResponsive?: boolean; /** Specify the orientation for splitter control. See orientation - * @Default {ej.orientation.Horizontal or Ă¢â‚¬Å“horizontalĂ¢â‚¬Â} - */ + * @Default {ej.orientation.Horizontal or Ă¢â‚¬Å“horizontalĂ¢â‚¬Â} + */ orientation?: ej.Orientation|string; /** Specify properties for each pane like paneSize, minSize, maxSize, collapsible, expandable, resizable. - * @Default {[]} - */ + * @Default {[]} + */ properties?: any[]; /** Specify width for splitter control. - * @Default {null} - */ + * @Default {null} + */ width?: string; /** Fires before expanding / collapsing the split pane of splitter control. */ @@ -16722,111 +16722,111 @@ export interface Model { export interface BeforeExpandCollapseEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns collapsed pane details. - */ + */ collapsed?: any; /** returns expanded pane details. - */ + */ expanded?: any; /** returns the splitter model. - */ + */ model?: ej.Splitter.Model; /** returns the current split bar index. - */ + */ splitbarIndex?: number; /** returns the name of the event. - */ + */ type?: string; } export interface CreateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the splitter model. - */ + */ model?: ej.Splitter.Model; /** returns the name of the event. - */ + */ type?: string; } export interface DestroyEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the splitter model. - */ + */ model?: ej.Splitter.Model; /** returns the name of the event. - */ + */ type?: string; } export interface ExpandCollapseEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns collapsed pane details. - */ + */ collapsed?: any; /** returns expanded pane details. - */ + */ expanded?: any; /** returns the splitter model. - */ + */ model?: ej.Splitter.Model; /** returns the current split bar index. - */ + */ splitbarIndex?: number; /** returns the name of the event. - */ + */ type?: string; } export interface ResizeEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns previous pane details. - */ + */ prevPane?: any; /** returns next pane details. - */ + */ nextPane?: any; /** returns the splitter model. - */ + */ model?: ej.Splitter.Model; /** returns the current split bar index. - */ + */ splitbarIndex?: number; /** returns the name of the event. - */ + */ type?: string; } } @@ -16839,56 +16839,56 @@ class Tab extends ej.Widget { defaults: Tab.Model; /** Add new tab items with given name, URL and given index position, if index null itĂ¢â‚¬â„¢s add last item. - * @param {string} URL name / tab id. - * @param {string} Tab Display name. - * @param {number} Index position to placed , this is optional. - * @param {string} specifies cssClass, this is optional. - * @param {string} specifies id of tab, this is optional. - * @returns {void} - */ + * @param {string} URL name / tab id. + * @param {string} Tab Display name. + * @param {number} Index position to placed , this is optional. + * @param {string} specifies cssClass, this is optional. + * @param {string} specifies id of tab, this is optional. + * @returns {void} + */ addItem(URL: string, displayLabel: string, index: number, cssClass: string, id: string): void; /** To disable the tab control. - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** To enable the tab control. - * @returns {void} - */ + * @returns {void} + */ enable(): void; /** This function get the number of tab rendered - * @returns {number} - */ + * @returns {number} + */ getItemsCount(): number; /** This function hides the tab control. - * @returns {void} - */ + * @returns {void} + */ hide(): void; /** This function hides the specified item tab in tab control. - * @param {number} index of tab item. - * @returns {void} - */ + * @param {number} index of tab item. + * @returns {void} + */ hideItem(index: number): void; /** Remove the given index tab item. - * @param {number} index of tab item. - * @returns {void} - */ + * @param {number} index of tab item. + * @returns {void} + */ removeItem(index: number): void; /** This function is to show the tab control. - * @returns {void} - */ + * @returns {void} + */ show(): void; /** This function helps to show the specified hidden tab item in tab control. - * @param {number} index of tab item. - * @returns {void} - */ + * @param {number} index of tab item. + * @returns {void} + */ showItem(index: number): void; } export namespace Tab { @@ -16896,121 +16896,121 @@ export namespace Tab { export interface Model { /** Specifies the ajaxSettings option to load the content to the Tab control. - */ + */ ajaxSettings?: AjaxSettings; /** Tab items interaction with keyboard keys, like headers active navigation. - * @Default {true} - */ + * @Default {true} + */ allowKeyboardNavigation?: boolean; /** Allow to collapsing the active item, while click on the active header. - * @Default {false} - */ + * @Default {false} + */ collapsible?: boolean; /** Set the root class for Tab theme. This cssClass API helps to use custom skinning option for Tab control. - */ + */ cssClass?: string; /** Disables the given tab headers and content panels. - * @Default {[]} - */ + * @Default {[]} + */ disabledItemIndex?: number[]; /** Specifies the animation behavior of the tab. - * @Default {true} - */ + * @Default {true} + */ enableAnimation?: boolean; /** When this property is set to false, it disables the tab control. - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Enables the given tab headers and content panels. - * @Default {[]} - */ + * @Default {[]} + */ enabledItemIndex?: number[]; /** Save current model value to browser cookies for state maintains. While refresh the Tab control page the model value apply from browser cookies. - * @Default {false} - */ + * @Default {false} + */ enablePersistence?: boolean; /** Display Right to Left direction for headers and panels text of tab. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Specify to enable scrolling for Tab header. - * @Default {false} - */ + * @Default {false} + */ enableTabScroll?: boolean; /** The event API to bind the action for active the tab items. - * @Default {click} - */ + * @Default {click} + */ events?: string; /** Specifies the position of Tab header as top, bottom, left or right. See below to get available Position - * @Default {top} - */ + * @Default {top} + */ headerPosition?: string | ej.Tab.Position; /** Set the height of the tab header element. Default this property value is null, so height take content height. - * @Default {null} - */ + * @Default {null} + */ headerSize?: string|number; /** Height set the outer panel element. Default this property value is null, so height take content height. - * @Default {null} - */ + * @Default {null} + */ height?: string|number; /** Adjust the content panel height for given option (content, auto and fill), by default panels height adjust based on the content.See below to get available HeightAdjustMode - * @Default {content} - */ + * @Default {content} + */ heightAdjustMode?: string | ej.Tab.HeightAdjustMode; /** Specifies to hide a pane of Tab control. - * @Default {[]} - */ + * @Default {[]} + */ hiddenItemIndex?: any[]; /** Specifies the HTML Attributes of the Tab. - * @Default {{}} - */ + * @Default {{}} + */ htmlAttributes?: any; /** The idPrefix property appends the given string on the added tab item idĂ¢â‚¬â„¢s in runtime. - * @Default {ej-tab-} - */ + * @Default {ej-tab-} + */ idPrefix?: string; /** Specifies the Tab header in active for given index value. - * @Default {0} - */ + * @Default {0} + */ selectedItemIndex?: number; /** Display the close button for each tab items. While clicking on the close icon, particular tab item will be removed. - * @Default {false} - */ + * @Default {false} + */ showCloseButton?: boolean; /** Display the Reload button for each tab items. - * @Default {false} - */ + * @Default {false} + */ showReloadIcon?: boolean; /** Tab panels and headers to be displayed in rounded corner style. - * @Default {false} - */ + * @Default {false} + */ showRoundedCorner?: boolean; /** Set the width for outer panel element, if not itĂ¢â‚¬â„¢s take parent width. - * @Default {null} - */ + * @Default {null} + */ width?: string|number; /** Triggered after a tab item activated. */ @@ -17050,322 +17050,322 @@ export interface Model { export interface ItemActiveEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the tab model. - */ + */ model?: ej.Tab.Model; /** returns the name of the event. - */ + */ type?: string; /** returns previous active tab header. - */ + */ prevActiveHeader?: HTMLElement; /** returns previous active index. - */ + */ prevActiveIndex?: number; /** returns current active tab header . - */ + */ activeHeader?: HTMLElement; /** returns current active index. - */ + */ activeIndex?: number; /** returns, is it triggered by interaction or not. - */ + */ isInteraction?: boolean; } export interface AjaxBeforeLoadEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the tab model. - */ + */ model?: ej.Tab.Model; /** returns the name of the event. - */ + */ type?: string; /** returns previous active tab header. - */ + */ prevActiveHeader?: HTMLElement; /** returns previous active index. - */ + */ prevActiveIndex?: number; /** returns current active tab header . - */ + */ activeHeader?: HTMLElement; /** returns current active index. - */ + */ activeIndex?: number; /** returns the URL of AJAX request - */ + */ URL?: string; /** returns, is it triggered by interaction or not. - */ + */ isInteraction?: boolean; } export interface AjaxErrorEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the tab model. - */ + */ model?: ej.Tab.Model; /** returns the name of the event. - */ + */ type?: string; /** returns AJAX data details. - */ + */ data?: any; /** returns the URL of AJAX request. - */ + */ URL?: string; } export interface AjaxLoadEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the tab model. - */ + */ model?: ej.Tab.Model; /** returns the name of the event. - */ + */ type?: string; /** returns previous active tab header. - */ + */ prevActiveHeader?: HTMLElement; /** returns previous active index. - */ + */ prevActiveIndex?: number; /** returns current active tab header . - */ + */ activeHeader?: HTMLElement; /** returns current active index. - */ + */ activeIndex?: number; /** returns the URL of AJAX request - */ + */ URL?: string; /** returns, is it triggered by interaction or not. - */ + */ isInteraction?: boolean; } export interface AjaxSuccessEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the tab model. - */ + */ model?: ej.Tab.Model; /** returns the name of the event. - */ + */ type?: string; /** return AJAX data. - */ + */ data?: any; /** returns AJAX URL - */ + */ URL?: string; /** returns content of AJAX request. - */ + */ content?: any; } export interface BeforeActiveEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the tab model. - */ + */ model?: ej.Tab.Model; /** returns the name of the event. - */ + */ type?: string; /** returns previous active tab header. - */ + */ prevActiveHeader?: HTMLElement; /** returns previous active index. - */ + */ prevActiveIndex?: number; /** returns current active tab header . - */ + */ activeHeader?: HTMLElement; /** returns current active index. - */ + */ activeIndex?: number; /** returns, is it triggered by interaction or not. - */ + */ isInteraction?: boolean; } export interface BeforeItemRemoveEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the tab model. - */ + */ model?: ej.Tab.Model; /** returns the name of the event. - */ + */ type?: string; /** returns current tab item index - */ + */ index?: number; } export interface CreateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the tab model. - */ + */ model?: ej.Tab.Model; /** returns the name of the event. - */ + */ type?: string; } export interface DestroyEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the tab model. - */ + */ model?: ej.Tab.Model; /** returns the name of the event. - */ + */ type?: string; } export interface ItemAddEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the tab model. - */ + */ model?: ej.Tab.Model; /** returns the name of the event. - */ + */ type?: string; /** returns new added tab header. - */ + */ tabHeader?: HTMLElement; /** returns new added tab content panel. - */ + */ tabContent?: any; } export interface ItemRemoveEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the tab model. - */ + */ model?: ej.Tab.Model; /** returns the name of the event. - */ + */ type?: string; /** returns removed tab header. - */ + */ removedTab?: HTMLElement; } export interface AjaxSettings { /** It specifies, whether to enable or disable asynchronous request. - * @Default {true} - */ + * @Default {true} + */ async?: boolean; /** It specifies the page will be cached in the web browser. - * @Default {false} - */ + * @Default {false} + */ cache?: boolean; /** It specifies the type of data is send in the query string. - * @Default {html} - */ + * @Default {html} + */ contentType?: string; /** It specifies the data as an object, will be passed in the query string. - * @Default {{}} - */ + * @Default {{}} + */ data?: any; /** It specifies the type of data that you're expecting back from the response. - * @Default {html} - */ + * @Default {html} + */ dataType?: string; /** It specifies the HTTP request type. - * @Default {get} - */ + * @Default {get} + */ type?: string; } @@ -17410,28 +17410,28 @@ class TagCloud extends ej.Widget { defaults: TagCloud.Model; /** Inserts a new item into the TagCloud - * @param {string} Insert new item into the TagCloud - * @returns {void} - */ + * @param {string} Insert new item into the TagCloud + * @returns {void} + */ insert(name: string): void; /** Inserts a new item into the TagCloud at a particular position. - * @param {string} Inserts a new item into the TagCloud - * @param {number} Inserts a new item into the TagCloud with the specified position - * @returns {void} - */ + * @param {string} Inserts a new item into the TagCloud + * @param {number} Inserts a new item into the TagCloud with the specified position + * @returns {void} + */ insertAt(name: string, position: number): void; /** Removes the item from the TagCloud based on the name. It removes all the tags which have the corresponding name - * @param {string} name of the tag. - * @returns {void} - */ + * @param {string} name of the tag. + * @returns {void} + */ remove(name: string): void; /** Removes the item from the TagCloud based on the position. It removes the tags from the the corresponding position only. - * @param {number} position of tag item. - * @returns {void} - */ + * @param {number} position of tag item. + * @returns {void} + */ removeAt(position: number): void; } export namespace TagCloud { @@ -17439,62 +17439,62 @@ export namespace TagCloud { export interface Model { /** Specify the CSS class to button to achieve custom theme. - */ + */ cssClass?: string; /** The dataSource contains the list of data to display in a cloud format. Each data contains a link URL, frequency to categorize the font size and a display text. - * @Default {null} - */ + * @Default {null} + */ dataSource?: any; /** Sets the TagCloud and tag items direction as right to left alignment. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Defines the mapping fields for the data items of the TagCloud. - * @Default {null} - */ + * @Default {null} + */ fields?: Fields; /** Specifies the list of HTML attributes to be added to TagCloud control. - * @Default {{}} - */ + * @Default {{}} + */ htmlAttributes?: any; /** Defines the format for the TagCloud to display the tag items.See Format - * @Default {ej.Format.Cloud} - */ + * @Default {ej.Format.Cloud} + */ format?: string|ej.Format; /** Sets the maximum font size value for the tag items. The font size for the tag items will be generated in between the minimum and maximum font size values. - * @Default {40px} - */ + * @Default {40px} + */ maxFontSize?: string|number; /** Sets the minimum font size value for the tag items. The font size for the tag items will be generated in between the minimum and maximum font size values. - * @Default {10px} - */ + * @Default {10px} + */ minFontSize?: string|number; /** Define the query to retrieve the data from online server. The query is used only when the online dataSource is used. - * @Default {null} - */ + * @Default {null} + */ query?: any; /** Shows or hides the TagCloud title. When this set to false, it hides the TagCloud header. - * @Default {true} - */ + * @Default {true} + */ showTitle?: boolean; /** Sets the title image for the TagCloud. To show the title image, the showTitle property should be enabled. - * @Default {null} - */ + * @Default {null} + */ titleImage?: string; /** Sets the title text for the TagCloud. To show the title text, the showTitle property should be enabled. - * @Default {Title} - */ + * @Default {Title} + */ titleText?: string; /** Event triggers when the TagCloud items are clicked */ @@ -17516,118 +17516,118 @@ export interface Model { export interface ClickEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TagCloud model - */ + */ model?: ej.TagCloud.Model; /** returns the name of the event - */ + */ type?: string; /** return current tag name - */ + */ text?: string; /** return current URL link - */ + */ URL?: string; } export interface CreateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TagCloud model - */ + */ model?: ej.TagCloud.Model; /** returns the name of the event - */ + */ type?: string; } export interface DestroyEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TagCloud model - */ + */ model?: ej.TagCloud.Model; /** returns the name of the event - */ + */ type?: string; } export interface MouseoutEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TagCloud model - */ + */ model?: ej.TagCloud.Model; /** returns the name of the event - */ + */ type?: string; /** return current tag name - */ + */ text?: string; /** return current URL link - */ + */ URL?: string; } export interface MouseoverEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TagCloud model - */ + */ model?: ej.TagCloud.Model; /** returns the name of the event - */ + */ type?: string; /** return current tag name - */ + */ text?: string; /** return current URL link - */ + */ URL?: string; } export interface Fields { /** Defines the frequency column number to categorize the font size. - */ + */ frequency?: string; /** Defines the HTML attributes column for the anchor elements inside the each tag items. - */ + */ htmlAttributes?: string; /** Defines the tag value or display text. - */ + */ text?: string; /** Defines the URL link to navigate while click the tag. - */ + */ url?: string; } } @@ -17646,33 +17646,33 @@ class TimePicker extends ej.Widget { defaults: TimePicker.Model; /** Allows you to disable the TimePicker. - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** Allows you to enable the TimePicker. - * @returns {void} - */ + * @returns {void} + */ enable(): void; /** It returns the current time value. - * @returns {string} - */ + * @returns {string} + */ getValue(): string; /** This method will hide the TimePicker control popup. - * @returns {void} - */ + * @returns {void} + */ hide(): void; /** Updates the current system time in TimePicker. - * @returns {void} - */ + * @returns {void} + */ setCurrentTime(): void; /** This method will show the TimePicker control popup. - * @returns {void} - */ + * @returns {void} + */ show(): void; } export namespace TimePicker { @@ -17680,121 +17680,121 @@ export namespace TimePicker { export interface Model { /** Sets the root CSS class for the TimePicker theme, which is used to customize. - */ + */ cssClass?: string; /** Specifies the list of time range to be disabled. - * @Default {{}} - */ + * @Default {{}} + */ disableTimeRanges?: any; /** Specifies the animation behavior in TimePicker. - * @Default {true} - */ + * @Default {true} + */ enableAnimation?: boolean; /** When this property is set to false, it disables the TimePicker control. - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Save current model value to browser cookies for maintaining states. When refreshing the TimePicker control page, the model value is applied from browser cookies or HTML 5local storage. - * @Default {false} - */ + * @Default {false} + */ enablePersistence?: boolean; /** Displays the TimePicker as right to left alignment. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** When the enableStrictMode is set as true it allows the value outside of the range and also indicate with red color border, - * otherwise it internally changed to the min or max range value based an input value. - * @Default {false} - */ + * otherwise it internally changed to the min or max range value based an input value. + * @Default {false} + */ enableStrictMode?: boolean; /** Defines the height of the TimePicker textbox. - */ + */ height?: string|number; /** Sets the step value for increment an hour value through arrow keys or mouse scroll. - * @Default {1} - */ + * @Default {1} + */ hourInterval?: number; /** It allows to define the characteristics of the TimePicker control. It will helps to extend the capability of an HTML element. - * @Default {{}} - */ + * @Default {{}} + */ htmlAttributes?: any; /** Sets the time interval between the two adjacent time values in the popup. - * @Default {30} - */ + * @Default {30} + */ interval?: number; /** Defines the localization info used by the TimePicker. - * @Default {en-US} - */ + * @Default {en-US} + */ locale?: string; /** Sets the maximum time value to the TimePicker. - * @Default {11:59:59 PM} - */ + * @Default {11:59:59 PM} + */ maxTime?: string; /** Sets the minimum time value to the TimePicker. - * @Default {12:00:00 AM} - */ + * @Default {12:00:00 AM} + */ minTime?: string; /** Sets the step value for increment the minute value through arrow keys or mouse scroll. - * @Default {1} - */ + * @Default {1} + */ minutesInterval?: number; /** Defines the height of the TimePicker popup. - * @Default {191px} - */ + * @Default {191px} + */ popupHeight?: string|number; /** Defines the width of the TimePicker popup. - * @Default {auto} - */ + * @Default {auto} + */ popupWidth?: string|number; /** Toggles the readonly state of the TimePicker - * @Default {false} - */ + * @Default {false} + */ readOnly?: boolean; /** Sets the step value for increment the seconds value through arrow keys or mouse scroll. - * @Default {1} - */ + * @Default {1} + */ secondsInterval?: number; /** shows or hides the drop down button in TimePicker. - * @Default {true} - */ + * @Default {true} + */ showPopupButton?: boolean; /** TimePicker is displayed with rounded corner when this property is set to true. - * @Default {false} - */ + * @Default {false} + */ showRoundedCorner?: boolean; /** Defines the time format displayed in the TimePicker. - * @Default {h:mm tt} - */ + * @Default {h:mm tt} + */ timeFormat?: string; /** Sets a specified time value on the TimePicker. - * @Default {null} - */ + * @Default {null} + */ value?: string|Date; /** Defines the width of the TimePicker textbox. - */ + */ width?: string|number; /** Fires when the time value changed in the TimePicker. */ @@ -17831,214 +17831,214 @@ export interface Model { export interface BeforeChangeEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TimePicker model - */ + */ model?: ej.TimePicker.Model; /** returns the name of the event - */ + */ type?: string; /** returns the previously selected time value - */ + */ prevTime?: string; /** returns the modified time value - */ + */ value?: string; } export interface BeforeOpenEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TimePicker model - */ + */ model?: ej.TimePicker.Model; /** returns the name of the event - */ + */ type?: string; /** returns the previously selected time value - */ + */ prevTime?: string; /** returns the time value - */ + */ value?: string; } export interface ChangeEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TimePicker model - */ + */ model?: ej.TimePicker.Model; /** returns the name of the event - */ + */ type?: string; /** returns true when the value changed by user interaction otherwise returns false - */ + */ isInteraction?: boolean; /** returns the previously selected time value - */ + */ prevTime?: string; /** returns the modified time value - */ + */ value?: string; } export interface CloseEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TimePicker model - */ + */ model?: ej.TimePicker.Model; /** returns the name of the event - */ + */ type?: string; /** returns the previously selected time value - */ + */ prevTime?: string; /** returns the time value - */ + */ value?: string; } export interface CreateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TimePicker model - */ + */ model?: ej.TimePicker.Model; /** returns the name of the event - */ + */ type?: string; } export interface DestroyEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TimePicker model - */ + */ model?: ej.TimePicker.Model; /** returns the name of the event - */ + */ type?: string; } export interface FocusInEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TimePicker model - */ + */ model?: ej.TimePicker.Model; /** returns the name of the event - */ + */ type?: string; /** returns the previously selected time value - */ + */ prevTime?: string; /** returns the current time value - */ + */ value?: string; } export interface FocusOutEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TimePicker model - */ + */ model?: ej.TimePicker.Model; /** returns the name of the event - */ + */ type?: string; /** returns the previously selected time value - */ + */ prevTime?: string; /** returns the current time value - */ + */ value?: string; } export interface OpenEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TimePicker model - */ + */ model?: ej.TimePicker.Model; /** returns the name of the event - */ + */ type?: string; /** returns the time value - */ + */ value?: string; } export interface SelectEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TimePicker model - */ + */ model?: ej.TimePicker.Model; /** returns the name of the event - */ + */ type?: string; /** returns the previously selected time value - */ + */ prevTime?: string; /** returns the selected time value - */ + */ value?: string; } } @@ -18051,18 +18051,18 @@ class ToggleButton extends ej.Widget { defaults: ToggleButton.Model; /** Allows you to destroy the ToggleButton widget. - * @returns {void} - */ + * @returns {void} + */ destroy(): void; /** To disable the ToggleButton to prevent all user interactions. - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** To enable the ToggleButton. - * @returns {void} - */ + * @returns {void} + */ enable(): void; } export namespace ToggleButton { @@ -18070,98 +18070,98 @@ export namespace ToggleButton { export interface Model { /** Specify the icon in active state to the toggle button and it will be aligned from left margin of the button. - */ + */ activePrefixIcon?: string; /** Specify the icon in active state to the toggle button and it will be aligned from right margin of the button. - */ + */ activeSuffixIcon?: string; /** Sets the text when ToggleButton is in active state i.e.,checked state. - * @Default {null} - */ + * @Default {null} + */ activeText?: string; /** Specifies the contentType of the ToggleButton. See ContentType as below - * @Default {ej.ContentType.TextOnly} - */ + * @Default {ej.ContentType.TextOnly} + */ contentType?: ej.ContentType|string; /** Specify the CSS class to the ToggleButton to achieve custom theme. - */ + */ cssClass?: string; /** Specify the icon in default state to the toggle button and it will be aligned from left margin of the button. - */ + */ defaultPrefixIcon?: string; /** Specify the icon in default state to the toggle button and it will be aligned from right margin of the button. - */ + */ defaultSuffixIcon?: string; /** Specifies the text of the ToggleButton, when the control is a default state. i.e., unChecked state. - * @Default {null} - */ + * @Default {null} + */ defaultText?: string; /** Specifies the state of the ToggleButton. - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Save current model value to browser cookies for maintaining states. When refreshing the ToggleButton control page, the model value is applied from browser cookies or HTML 5local storage. - * @Default {false} - */ + * @Default {false} + */ enablePersistence?: boolean; /** Specify the Right to Left direction of the ToggleButton. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Specifies the height of the ToggleButton. - * @Default {28pixel} - */ + * @Default {28pixel} + */ height?: number|string; /** It allows to define the characteristics of the ToggleButton control. It will helps to extend the capability of an HTML element. - * @Default {{}} - */ + * @Default {{}} + */ htmlAttributes?: any; /** Specifies the image position of the ToggleButton. - * @Default {ej.ImagePosition.ImageLeft} - */ + * @Default {ej.ImagePosition.ImageLeft} + */ imagePosition?: ej.ImagePosition|string; /** Allows to prevents the control switched to checked (active) state. - * @Default {false} - */ + * @Default {false} + */ preventToggle?: boolean; /** Displays the ToggleButton with rounded corners. - * @Default {false} - */ + * @Default {false} + */ showRoundedCorner?: boolean; /** Specifies the size of the ToggleButton. See ButtonSize as below - * @Default {ej.ButtonSize.Normal} - */ + * @Default {ej.ButtonSize.Normal} + */ size?: ej.ButtonSize|string; /** It allows to define the ToggleButton state to checked(Active) or unchecked(Default) at initial time. - * @Default {false} - */ + * @Default {false} + */ toggleState?: boolean; /** Specifies the type of the ToggleButton. See ButtonType as below - * @Default {ej.ButtonType.Button} - */ + * @Default {ej.ButtonType.Button} + */ type?: ej.ButtonType|string; /** Specifies the width of the ToggleButton. - * @Default {100pixel} - */ + * @Default {100pixel} + */ width?: number|string; /** Fires when ToggleButton control state is changed successfully. */ @@ -18180,72 +18180,72 @@ export interface Model { export interface ChangeEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** return the toggle button checked state - */ + */ isChecked?: boolean; /** returns the toggle button model - */ + */ model?: ej.ToggleButton.Model; /** returns the name of the event - */ + */ type?: string; } export interface ClickEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** return the toggle button checked state - */ + */ isChecked?: boolean; /** returns the toggle button model - */ + */ model?: ej.ToggleButton.Model; /** return the toggle button state - */ + */ status?: boolean; /** returns the name of the event - */ + */ type?: string; } export interface CreateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the toggle button model - */ + */ model?: ej.ToggleButton.Model; /** returns the name of the event - */ + */ type?: string; } export interface DestroyEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the toggle button model - */ + */ model?: ej.ToggleButton.Model; /** returns the name of the event - */ + */ type?: string; } } @@ -18258,88 +18258,88 @@ class Toolbar extends ej.Widget { defaults: Toolbar.Model; /** Deselect the specified Toolbar item. - * @param {any} The element need to be deselected - * @returns {void} - */ + * @param {any} The element need to be deselected + * @returns {void} + */ deselectItem(element: any): void; /** Deselect the Toolbar item based on specified id. - * @param {string} The ID of the element need to be deselected - * @returns {void} - */ + * @param {string} The ID of the element need to be deselected + * @returns {void} + */ deselectItemByID(ID: string): void; /** Allows you to destroy the Toolbar widget. - * @returns {void} - */ + * @returns {void} + */ destroy(): void; /** To disable all items in the Toolbar control. - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** Disable the specified Toolbar item. - * @param {any} The element need to be disabled - * @returns {void} - */ + * @param {any} The element need to be disabled + * @returns {void} + */ disableItem(element: any): void; /** Disable the Toolbar item based on specified item id in the Toolbar. - * @param {string} The ID of the element need to be disabled - * @returns {void} - */ + * @param {string} The ID of the element need to be disabled + * @returns {void} + */ disableItemByID(ID: string): void; /** Enable the Toolbar if it is in disabled state. - * @returns {void} - */ + * @returns {void} + */ enable(): void; /** Enable the Toolbar item based on specified item. - * @param {any} The element need to be enabled - * @returns {void} - */ + * @param {any} The element need to be enabled + * @returns {void} + */ enableItem(element: any): void; /** Enable the Toolbar item based on specified item id in the Toolbar. - * @param {string} The ID of the element need to be enabled - * @returns {void} - */ + * @param {string} The ID of the element need to be enabled + * @returns {void} + */ enableItemByID(ID: string): void; /** To hide the Toolbar - * @returns {void} - */ + * @returns {void} + */ hide(): void; /** Remove the item from toolbar, based on specified item. - * @param {any} The element need to be removed - * @returns {void} - */ + * @param {any} The element need to be removed + * @returns {void} + */ removeItem(element: any): void; /** Remove the item from toolbar, based on specified item id in the Toolbar. - * @param {string} The ID of the element need to be removed - * @returns {void} - */ + * @param {string} The ID of the element need to be removed + * @returns {void} + */ removeItemByID(ID: string): void; /** Selects the item from toolbar, based on specified item. - * @param {any} The element need to be selected - * @returns {void} - */ + * @param {any} The element need to be selected + * @returns {void} + */ selectItem(element: any): void; /** Selects the item from toolbar, based on specified item id in the Toolbar. - * @param {string} The ID of the element need to be selected - * @returns {void} - */ + * @param {string} The ID of the element need to be selected + * @returns {void} + */ selectItemByID(ID: string): void; /** To show the Toolbar. - * @returns {void} - */ + * @returns {void} + */ show(): void; } export namespace Toolbar { @@ -18347,91 +18347,91 @@ export namespace Toolbar { export interface Model { /** Sets the root CSS class for Toolbar control to achieve the custom theme. - */ + */ cssClass?: string; /** Specifies dataSource value for the Toolbar control during initialization. - * @Default {null} - */ + * @Default {null} + */ dataSource?: any; /** Disables an Item or set of Items that are enabled in the Toolbar - * @Default {[]} - */ + * @Default {[]} + */ disabledItemIndices?: any[]; /** Specifies the Toolbar control state. - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Enables an Item or set of Items that are disabled in the Toolbar - * @Default {[]} - */ + * @Default {[]} + */ enabledItemIndices?: any[]; /** Specifies enableRTL property to align the Toolbar control from right to left direction. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Allows to separate the each UL items in the Toolbar control. - * @Default {false} - */ + * @Default {false} + */ enableSeparator?: boolean; /** Specifies the mapping fields for the data items of the Toolbar - * @Default {null} - */ + * @Default {null} + */ fields?: string; /** Specifies the height of the Toolbar. - * @Default {28} - */ + * @Default {28} + */ height?: number|string; /** Specifies the list of HTML attributes to be added to toolbar control. - * @Default {{}} - */ + * @Default {{}} + */ htmlAttributes?: any; /** Specifies whether the Toolbar control is need to be show or hide. - * @Default {false} - */ + * @Default {false} + */ hide?: boolean; /** Enables/Disables the responsive support for Toolbar items during the window resizing time. - * @Default {false} - */ + * @Default {false} + */ isResponsive?: boolean; /** Specifies the items of Toolbar - * @Default {null} - */ + * @Default {null} + */ Items?: Items; /** Specifies the Toolbar orientation. See orientation - * @Default {Horizontal} - */ + * @Default {Horizontal} + */ orientation?: ej.Orientation|string; /** Specifies the query to retrieve the data from the online server. The query is used only when the online dataSource is used. - * @Default {null} - */ + * @Default {null} + */ query?: any; /** Specifies the Toolbar responsive type. - * @Default {Popup} - */ + * @Default {Popup} + */ responsiveType?: ej.Toolbar.ResponsiveType|string; /** Displays the Toolbar with rounded corners. - * @Default {false} - */ + * @Default {false} + */ showRoundedCorner?: boolean; /** Specifies the width of the Toolbar. - */ + */ width?: number|string; /** Fires after Toolbar control is clicked. */ @@ -18462,258 +18462,258 @@ export interface Model { export interface ClickEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Toolbar model - */ + */ model?: ej.Toolbar.Model; /** returns the name of the event - */ + */ type?: string; /** returns the target of the current object. - */ + */ target?: any; /** returns the target of the current object. - */ + */ currentTarget?: any; /** return the Toolbar state - */ + */ status?: boolean; } export interface CreateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Toolbar model - */ + */ model?: ej.Toolbar.Model; /** returns the name of the event - */ + */ type?: string; } export interface FocusOutEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Toolbar model - */ + */ model?: ej.Toolbar.Model; /** returns the name of the event - */ + */ type?: string; } export interface DestroyEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Toolbar model - */ + */ model?: ej.Toolbar.Model; /** returns the name of the event - */ + */ type?: string; } export interface ItemHoverEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Toolbar model - */ + */ model?: ej.Toolbar.Model; /** returns the name of the event - */ + */ type?: string; /** returns the target of the current object. - */ + */ target?: any; /** returns the target of the current object. - */ + */ currentTarget?: any; /** return the Toolbar state - */ + */ status?: boolean; } export interface ItemLeaveEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Toolbar model - */ + */ model?: ej.Toolbar.Model; /** returns the name of the event - */ + */ type?: string; /** returns the target of the current object. - */ + */ target?: any; /** returns the target of the current object. - */ + */ currentTarget?: any; /** return the Toolbar state - */ + */ status?: boolean; } export interface OverflowOpenEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Toolbar model - */ + */ model?: ej.Toolbar.Model; /** returns the name of the event - */ + */ type?: string; /** Returns the current X position of the target . - */ + */ clientX?: number; /** Returns the current Y position of the target . - */ + */ clientY?: number; /** returns the target of the current object. - */ + */ currentTarget?: any; } export interface OverflowCloseEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Toolbar model - */ + */ model?: ej.Toolbar.Model; /** returns the name of the event - */ + */ type?: string; /** Returns the current X position of the target . - */ + */ clientX?: number; /** Returns the current Y position of the target . - */ + */ clientY?: number; /** returns the target of the current object. - */ + */ currentTarget?: any; } export interface Fields { /** Defines the group name for the item. - */ + */ group?: string; /** Defines the HTML attributes such as id, class, styles for the item to extend the capability. - */ + */ htmlAttributes?: any; /** Defines id for the tag. - */ + */ id?: string; /** Defines the image attributes such as height, width, styles and so on. - */ + */ imageAttributes?: string; /** Defines the imageURL for the image location. - */ + */ imageUrl?: string; /** Defines the sprite CSS for the image tag. - */ + */ spriteCssClass?: string; /** Defines the text content for the tag. - */ + */ text?: string; /** Defines the tooltip text for the tag. - */ + */ tooltipText?: string; /** Allows you to add template as toolbar item - */ + */ template?: string; } export interface Items { /** Defines the group name for the item. - */ + */ group?: string; /** Defines the HTML attributes such as id, class, styles for the item . - */ + */ htmlAttributes?: any; /** Defines id for the tag. - */ + */ id?: string; /** Defines the image attributes such as height, width, styles and so on. - */ + */ imageAttributes?: string; /** Defines the imageURL for the image location. - */ + */ imageUrl?: string; /** Defines the sprite CSS for the image tag. - */ + */ spriteCssClass?: string; /** Defines the text content for the tag. - */ + */ text?: string; /** Defines the tooltip text for the tag. - */ + */ tooltipText?: string; /** Allows to add template as toolbar item. - */ + */ template?: string; } @@ -18736,323 +18736,323 @@ class TreeView extends ej.Widget { defaults: TreeView.Model; /** To add a Node or collection of nodes in TreeView. If target tree node is specified, then the given nodes are added as child of target tree node, otherwise nodes are added in TreeView. - * @param {string|any} New node text or JSON object - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {void} - */ + * @param {string|any} New node text or JSON object + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {void} + */ addNode(newNodeText: string|any, target: string|any): void; /** To add a collection of nodes in TreeView. If target tree node is specified, then the given nodes are added as child of target tree node, otherwise nodes are added in TreeView. - * @param {any|Array} New node details in JSON object - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {void} - */ + * @param {any|Array} New node details in JSON object + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {void} + */ addNodes(collection: any|any[], target: string|any): void; /** To check all the nodes in TreeView. - * @returns {void} - */ + * @returns {void} + */ checkAll(): void; /** To check a node in TreeView. - * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes - * @returns {void} - */ + * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes + * @returns {void} + */ checkNode(element: string|any|any[]): void; /** This method is used to collapse all nodes in TreeView control. If you want to collapse all nodes up to the specific level in - * TreeView control then we need to pass levelUntil as argument to this method. - * @param {number} TreeView nodes will collapse until the given level - * @param {boolean} Weather exclude the hidden nodes of TreeView while collapse all nodes - * @returns {void} - */ + * TreeView control then we need to pass levelUntil as argument to this method. + * @param {number} TreeView nodes will collapse until the given level + * @param {boolean} Weather exclude the hidden nodes of TreeView while collapse all nodes + * @returns {void} + */ collapseAll(levelUntil?: number, excludeHiddenNodes?: boolean): void; /** To collapse a particular node in TreeView. - * @param {string|any|Array} ID of TreeView node|object of TreeView node/collection of ID/object of TreeView nodes - * @returns {void} - */ + * @param {string|any|Array} ID of TreeView node|object of TreeView node/collection of ID/object of TreeView nodes + * @returns {void} + */ collapseNode(element: string|any|any[]): void; /** To disable the node in the TreeView. - * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes - * @returns {void} - */ + * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes + * @returns {void} + */ disableNode(element: string|any|any[]): void; /** To enable the node in the TreeView. - * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes - * @returns {void} - */ + * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes + * @returns {void} + */ enableNode(element: string|any|any[]): void; /** To ensure that the TreeView node is visible in the TreeView. This method is useful if we need select a TreeView node dynamically. - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {boolean} - */ + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {boolean} + */ ensureVisible(element: string|any): boolean; /** This method is used to expand all nodes in TreeView control. If you want to expand all nodes up to the specific level in TreeView control - * then we need to pass levelUntil as argument to this method. - * @param {number} TreeView nodes will expand until the given level - * @param {boolean} Weather exclude the hidden nodes of TreeView while expand all nodes - * @returns {void} - */ + * then we need to pass levelUntil as argument to this method. + * @param {number} TreeView nodes will expand until the given level + * @param {boolean} Weather exclude the hidden nodes of TreeView while expand all nodes + * @returns {void} + */ expandAll(levelUntil?: number, excludeHiddenNodes?: boolean): void; /** To expandNode particular node in TreeView. - * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes - * @returns {void} - */ + * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes + * @returns {void} + */ expandNode(element: string|any|any[]): void; /** To get currently checked nodes in TreeView. - * @returns {any} - */ + * @returns {any} + */ getCheckedNodes(): any; /** To get currently checked nodes indexes in TreeView. - * @returns {Array} - */ + * @returns {Array} + */ getCheckedNodesIndex(): any[]; /** This method is used to get immediate child nodes of a node in TreeView control. If you want to get the all child nodes include nested - * child nodes then we need to pass includeNestedChild as true along with element arguments to this method. - * @param {string|any} ID of TreeView node/object of TreeView node - * @param {boolean} Weather include nested child nodes of TreeView node - * @returns {Array} - */ + * child nodes then we need to pass includeNestedChild as true along with element arguments to this method. + * @param {string|any} ID of TreeView node/object of TreeView node + * @param {boolean} Weather include nested child nodes of TreeView node + * @returns {Array} + */ getChildren(element: string|any, includeNestedChild?: boolean): any[]; /** To get number of nodes in TreeView. - * @returns {number} - */ + * @returns {number} + */ getNodeCount(): number; /** To get currently expanded nodes in TreeView. - * @returns {any} - */ + * @returns {any} + */ getExpandedNodes(): any; /** To get currently expanded nodes indexes in TreeView. - * @returns {Array} - */ + * @returns {Array} + */ getExpandedNodesIndex(): any[]; /** To get TreeView node by using index position in TreeView. - * @param {number} Index position of TreeView node - * @returns {any} - */ + * @param {number} Index position of TreeView node + * @returns {any} + */ getNodeByIndex(index: number): any; /** To get TreeView node data such as id, text, parentId, selected, checked, expanded, level, childes and index. - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {any} - */ + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {any} + */ getNode(element: string|any): any; /** To get current index position of TreeView node. - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {number} - */ + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {number} + */ getNodeIndex(element: string|any): number; /** To get immediate parent TreeView node of particular TreeView node. - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {any} - */ + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {any} + */ getParent(element: string|any): any; /** To get the currently selected node in TreeView. - * @returns {any} - */ + * @returns {any} + */ getSelectedNode(): any; /** To get the currently selected nodes in TreeView. - * @returns {Array} - */ + * @returns {Array} + */ getSelectedNodes(): any[]; /** To get the index position of currently selected node in TreeView. - * @returns {number} - */ + * @returns {number} + */ getSelectedNodeIndex(): number; /** To get the index positions of currently selected nodes in TreeView. - * @returns {Array} - */ + * @returns {Array} + */ getSelectedNodesIndex(): any[]; /** To get the text of a node in TreeView. - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {string} - */ + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {string} + */ getText(element: string|any): string; /** To get the updated datasource of TreeView after performing some operation like drag and drop, node editing, adding and removing node. - * @param {string|number} ID of TreeView node - * @returns {Array} - */ + * @param {string|number} ID of TreeView node + * @returns {Array} + */ getTreeData(id?: string|number): any[]; /** To get currently visible nodes in TreeView. - * @returns {any} - */ + * @returns {any} + */ getVisibleNodes(): any; /** To check a node having child or not. - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {boolean} - */ + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {boolean} + */ hasChildNode(element: string|any): boolean; /** To show nodes in TreeView. - * @returns {void} - */ + * @returns {void} + */ hide(): void; /** To hide particular node in TreeView. - * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes - * @returns {void} - */ + * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes + * @returns {void} + */ hideNode(element: string|any|any[]): void; /** To add a Node or collection of nodes after the particular TreeView node. - * @param {string|any} New node text or JSON object - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {void} - */ + * @param {string|any} New node text or JSON object + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {void} + */ insertAfter(newNodeText: string|any, target: string|any): void; /** To add a Node or collection of nodes before the particular TreeView node. - * @param {string|any} New node text or JSON object - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {void} - */ + * @param {string|any} New node text or JSON object + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {void} + */ insertBefore(newNodeText: string|any, target: string|any): void; /** To check the given TreeView node is checked or unchecked. - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {boolean} - */ + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {boolean} + */ isNodeChecked(element: string|any): boolean; /** To check whether the child nodes are loaded of the given TreeView node. - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {boolean} - */ + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {boolean} + */ isChildLoaded(element: string|any): boolean; /** To check the given TreeView node is disabled or enabled. - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {boolean} - */ + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {boolean} + */ isDisabled(element: string|any): boolean; /** To check the given node is exist in TreeView. - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {boolean} - */ + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {boolean} + */ isExist(element: string|any): boolean; /** To get the expand status of the given TreeView node. - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {boolean} - */ + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {boolean} + */ isExpanded(element: string|any): boolean; /** To get the select status of the given TreeView node. - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {boolean} - */ + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {boolean} + */ isSelected(element: string|any): boolean; /** To get the visibility status of the given TreeView node. - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {boolean} - */ + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {boolean} + */ isVisible(element: string|any): boolean; /** To load the TreeView nodes from the particular URL. If target tree node is specified, then the given nodes are added as child of target tree node, otherwise nodes are added in TreeView. - * @param {string} URL location, the data returned from the URL will be loaded in TreeView - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {void} - */ + * @param {string} URL location, the data returned from the URL will be loaded in TreeView + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {void} + */ loadData(URL: string, target: string|any): void; /** To move the TreeView node with in same TreeView. The new position of given TreeView node will be based on destination node and index position. - * @param {string|any} ID of TreeView node/object of TreeView node - * @param {string|any} ID of TreeView node/object of TreeView node - * @param {number} New index position of given source node - * @returns {void} - */ + * @param {string|any} ID of TreeView node/object of TreeView node + * @param {string|any} ID of TreeView node/object of TreeView node + * @param {number} New index position of given source node + * @returns {void} + */ moveNode(sourceNode: string|any, destinationNode: string|any, index: number): void; /** To refresh the TreeView - * @returns {void} - */ + * @returns {void} + */ refresh(): void; /** To remove all the nodes in TreeView. - * @returns {void} - */ + * @returns {void} + */ removeAll(): void; /** To remove a node in TreeView. - * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes - * @returns {void} - */ + * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes + * @returns {void} + */ removeNode(element: string|any|any[]): void; /** To select all the TreeView nodes when enable allowMultiSelection property. - * @returns {void} - */ + * @returns {void} + */ selectAll(): void; /** This method is used to select a node in TreeView control. If you want to select the collection of nodes in TreeView control then we need to enable allowMultiSelection property. - * @param {string|any|Array} ID of TreeView node/object of TreeView node/ collection of ID/object of TreeView nodes - * @returns {void} - */ + * @param {string|any|Array} ID of TreeView node/object of TreeView node/ collection of ID/object of TreeView nodes + * @returns {void} + */ selectNode(element: string|any|any[]): void; /** To show nodes in TreeView. - * @returns {void} - */ + * @returns {void} + */ show(): void; /** To show a node in TreeView. - * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes - * @returns {void} - */ + * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes + * @returns {void} + */ showNode(element: string|any|any[]): void; /** To uncheck all the nodes in TreeView. - * @returns {void} - */ + * @returns {void} + */ unCheckAll(): void; /** To uncheck a node in TreeView. - * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes - * @returns {void} - */ + * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes + * @returns {void} + */ uncheckNode(element: string|any|any[]): void; /** To unselect all the TreeView nodes when enable allowMultiSelection property. - * @returns {void} - */ + * @returns {void} + */ unselectAll(): void; /** This method is used to unselect a node in TreeView control. If you want to unselect the collection of nodes in TreeView control then we need to enable allowMultiSelection property. - * @param {string|any|Array} ID of TreeView node/object of TreeView node/ collection of ID/object of TreeView nodes - * @returns {void} - */ + * @param {string|any|Array} ID of TreeView node/object of TreeView node/ collection of ID/object of TreeView nodes + * @returns {void} + */ unselectNode(element: string|any|any[]): void; /** To edit or update the text of the TreeView node. - * @param {string|any} ID of TreeView node/object of TreeView node - * @param {string} New text - * @returns {void} - */ + * @param {string|any} ID of TreeView node/object of TreeView node + * @param {string} New text + * @returns {void} + */ updateText(target: string|any, newText: string): void; } export namespace TreeView { @@ -19060,146 +19060,146 @@ export namespace TreeView { export interface Model { /** Gets or sets a value that indicates whether to enable drag and drop a node within the same tree. - * @Default {false} - */ + * @Default {false} + */ allowDragAndDrop?: boolean; /** Gets or sets a value that indicates whether to enable drag and drop a node in inter ej.TreeView. - * @Default {true} - */ + * @Default {true} + */ allowDragAndDropAcrossControl?: boolean; /** Gets or sets a value that indicates whether to drop a node to a sibling of particular node. - * @Default {true} - */ + * @Default {true} + */ allowDropSibling?: boolean; /** Gets or sets a value that indicates whether to drop a node to a child of particular node. - * @Default {true} - */ + * @Default {true} + */ allowDropChild?: boolean; /** Gets or sets a value that indicates whether to enable node editing support for TreeView. - * @Default {false} - */ + * @Default {false} + */ allowEditing?: boolean; /** Gets or sets a value that indicates whether to enable keyboard support for TreeView actions like nodeSelection, nodeEditing, nodeExpand, nodeCollapse, nodeCut and Paste. - * @Default {true} - */ + * @Default {true} + */ allowKeyboardNavigation?: boolean; /** Gets or sets a value that indicates whether to enable multi selection support for TreeView. - * @Default {false} - */ + * @Default {false} + */ allowMultiSelection?: boolean; /** Allow us to specify the parent and child nodes to get auto check while we check or uncheck a node. - * @Default {true} - */ + * @Default {true} + */ autoCheck?: boolean; /** Allow us to specify the parent node to be retain in checked or unchecked state instead of going for indeterminate state. - * @Default {false} - */ + * @Default {false} + */ autoCheckParentNode?: boolean; /** Gets or sets a value that indicates the checkedNodes index collection as an array. The given array index position denotes the nodes, that are checked while rendering TreeView. - * @Default {[]} - */ + * @Default {[]} + */ checkedNodes?: any[]; /** Sets the root CSS class for TreeView which allow us to customize the appearance. - */ + */ cssClass?: string; /** Gets or sets a value that indicates whether to enable or disable the animation effect while expanding or collapsing a node. - * @Default {true} - */ + * @Default {true} + */ enableAnimation?: boolean; /** Gets or sets a value that indicates whether a TreeView can be enabled or disabled. No actions can be performed while this property is set as false - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Allow us to prevent multiple nodes to be in expanded state. If it set to false, previously expanded node will be collapsed automatically, while we expand a node. - * @Default {true} - */ + * @Default {true} + */ enableMultipleExpand?: boolean; /** Sets a value that indicates whether to persist the TreeView model state in page using applicable medium i.e., HTML5 localStorage or cookies - * @Default {false} - */ + * @Default {false} + */ enablePersistence?: boolean; /** Gets or sets a value that indicates to align content in the TreeView control from right to left by setting the property as true. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Gets or sets a array of value that indicates the expandedNodes index collection as an array. The given array index position denotes the nodes, that are expanded while rendering TreeView. - * @Default {[]} - */ + * @Default {[]} + */ expandedNodes?: any[]; /** Gets or sets a value that indicates the TreeView node can be expand or collapse by using the specified action. - * @Default {dblclick} - */ + * @Default {dblclick} + */ expandOn?: string; /** Gets or sets a fields object that allow us to map the data members with field properties in order to make the data binding easier. - * @Default {null} - */ + * @Default {null} + */ fields?: Fields; /** Gets or sets a value that indicates whether to enable full row selection support for TreeView. - * @Default {false} - */ + * @Default {false} + */ fullRowSelect?: boolean; /** Defines the height of the TreeView. - * @Default {Null} - */ + * @Default {Null} + */ height?: string|number; /** Specifies the HTML Attributes for the TreeView. Using this API we can add custom attributes in TreeView control. - * @Default {{}} - */ + * @Default {{}} + */ htmlAttributes?: any; /** Specifies the child nodes to be loaded on demand - * @Default {false} - */ + * @Default {false} + */ loadOnDemand?: boolean; /** Gets or Sets a value that indicates the index position of a tree node. The particular index tree node will be selected while rendering the TreeView. - * @Default {-1} - */ + * @Default {-1} + */ selectedNode?: number; /** Gets or sets a value that indicates the selectedNodes index collection as an array. The given array index position denotes the nodes, that are selected while rendering TreeView. - * @Default {[]} - */ + * @Default {[]} + */ selectedNodes?: any[]; /** Gets or sets a value that indicates whether to display or hide checkbox for all TreeView nodes. - * @Default {false} - */ + * @Default {false} + */ showCheckbox?: boolean; /** By using sortSettings property, you can customize the sorting option in TreeView control. - */ + */ sortSettings?: SortSettings; /** Allow us to use custom template in order to create TreeView. - * @Default {null} - */ + * @Default {null} + */ template?: string; /** Defines the width of the TreeView. - * @Default {Null} - */ + * @Default {Null} + */ width?: string|number; /** Fires before adding node to TreeView. */ @@ -19302,1112 +19302,1112 @@ export interface Model { export interface BeforeAddEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the given new node data - */ + */ data?: string|any; /** returns the parent element, the given new nodes to be appended to the given parent element - */ + */ targetParent?: any; /** returns the given parent node details - */ + */ parentDetails?: any; } export interface BeforeCollapseEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the value of the node - */ + */ value?: string; /** returns the current element of the node clicked - */ + */ currentElement?: any; /** returns the child nodes are loaded or not - */ + */ isChildLoaded?: boolean; /** returns the id of currently clicked node - */ + */ id?: string; /** returns the parent id of currently clicked node - */ + */ parentId?: string; /** returns the format asynchronous or synchronous - */ + */ async?: boolean; } export interface BeforeCutEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the event object - */ + */ event?: any; /** returns the target element, the given node to be cut - */ + */ target?: any; /** returns the given target node values - */ + */ nodeDetails?: any; /** returns the key pressed key code value - */ + */ keyCode?: number; } export interface BeforeDeleteEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the event object - */ + */ event?: any; /** returns the target element, the given node to be deleted - */ + */ target?: any; /** returns the given target node values - */ + */ nodeDetails?: any; /** returns the current parent element of the target node - */ + */ parentElement?: any; /** returns the parent node values - */ + */ parentDetails?: any; /** returns the currently removed nodes - */ + */ removedNodes?: any[]; } export interface BeforeEditEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the current element of the node clicked - */ + */ currentElement?: any; } export interface BeforeExpandEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the value of the node - */ + */ value?: string; /** if the child node is ready to expanded state; otherwise, false. - */ + */ isChildLoaded?: boolean; /** returns the current element of the node clicked - */ + */ currentElement?: any; /** returns the id of currently clicked node - */ + */ id?: string; /** returns the parent id of currently clicked node - */ + */ parentId?: string; /** returns the format asynchronous or synchronous - */ + */ async?: boolean; } export interface BeforeLoadEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the AJAX settings object - */ + */ AjaxOptions?: any; } export interface BeforePasteEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the event object - */ + */ event?: any; /** returns the target element, the given node to be pasted - */ + */ target?: any; /** returns the given target node values - */ + */ nodeDetails?: any; /** returns the key pressed key code value - */ + */ keyCode?: number; } export interface BeforeSelectEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the target element, the given node to be selected - */ + */ target?: any; /** returns the given target node values - */ + */ nodeDetails?: any; } export interface CreateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; } export interface DestroyEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; } export interface InlineEditValidationEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the new entered text for the node - */ + */ newText?: string; /** returns the current node element id - */ + */ id?: any; /** returns the old node text - */ + */ oldText?: string; } export interface KeyPressEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the event object - */ + */ event?: any; /** returns the current element of the node clicked - */ + */ currentElement?: any; /** returns the value of the node - */ + */ value?: string; /** returns node path from root element - */ + */ path?: string; /** returns the key pressed key code value - */ + */ keyCode?: number; /** it returns when the current node is in expanded state; otherwise, false. - */ + */ isExpanded?: boolean; /** returns the id of current TreeView node - */ + */ id?: string; /** returns the parentId of current TreeView node - */ + */ parentId?: string; } export interface LoadErrorEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the AJAX error object - */ + */ error?: any; } export interface LoadSuccessEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the success data from the URL - */ + */ data?: any; /** returns the target parent element, the data returned from the URL to be appended to the given parent element, else in TreeView - */ + */ targetParent?: any; /** returns the given parent node details - */ + */ parentDetails?: any; } export interface NodeAddEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the added data, that are given initially - */ + */ data?: any; /** returns the newly added elements - */ + */ nodes?: any; /** returns the target parent element of the added element - */ + */ parentElement?: any; /** returns the given parent node details - */ + */ parentDetails?: any; } export interface NodeCheckEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the event object - */ + */ event?: any; /** returns the value of the node - */ + */ value?: string; /** returns the id of the current element of the node clicked - */ + */ id?: string; /** returns the id of the parent element of current element of the node clicked - */ + */ parentId?: string; /** returns the current element of the node clicked - */ + */ currentElement?: any; /** it returns true when the node checkbox is checked; otherwise, false. - */ + */ isChecked?: boolean; /** it returns the currently checked node name - */ + */ currentNode?: any[]; /** it returns the currently checked and its child node details - */ + */ currentCheckedNodes?: any[]; } export interface NodeClickEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the event object - */ + */ event?: any; /** returns the current element of the node clicked - */ + */ currentElement?: any; /** returns the id of currently clicked TreeView node - */ + */ id?: string; /** returns the parentId of currently clicked TreeView node - */ + */ parentId?: string; } export interface NodeCollapseEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the id of the current element of the node clicked - */ + */ id?: string; /** returns the name of the event - */ + */ type?: string; /** returns the id of the parent element of current element of the node clicked - */ + */ parentId?: string; /** returns the value of the node - */ + */ value?: string; /** returns the current element of the node clicked - */ + */ currentElement?: any; /** returns the child nodes are loaded or not - */ + */ isChildLoaded?: boolean; /** returns the format asynchronous or synchronous - */ + */ async?: boolean; } export interface NodeCutEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the event object - */ + */ event?: any; /** returns the current parent element of the cut node - */ + */ parentElement?: any; /** returns the given parent node details - */ + */ parentDetails?: any; /** returns the key pressed key code value - */ + */ keyCode?: number; } export interface NodeDeleteEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the event object - */ + */ event?: any; /** returns the current parent element of the deleted node - */ + */ parentElement?: any; /** returns the given parent node details - */ + */ parentDetails?: any; /** returns the currently removed nodes - */ + */ removedNodes?: any[]; } export interface NodeDragEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the original drag target - */ + */ dragTarget?: any; /** returns the current target TreeView node - */ + */ target?: any; /** returns the current target details - */ + */ targetElementData?: any; /** returns the current parent element of the target node - */ + */ draggedElement?: any; /** returns the given parent node details - */ + */ draggedElementData?: any; /** returns the event object - */ + */ event?: any; } export interface NodeDragStartEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the original drag target - */ + */ dragTarget?: any; /** returns the current dragging parent TreeView node - */ + */ parentElement?: any; /** returns the current dragging parent TreeView node details - */ + */ parentElementData?: any; /** returns the current parent element of the dragging node - */ + */ target?: any; /** returns the given parent node details - */ + */ targetElementData?: any; /** returns the event object - */ + */ event?: any; } export interface NodeDragStopEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the original drop target - */ + */ dropTarget?: any; /** returns the current dragged TreeView node - */ + */ draggedElement?: any; /** returns the current dragged TreeView node details - */ + */ draggedElementData?: any; /** returns the current parent element of the dragged node - */ + */ target?: any; /** returns the given parent node details - */ + */ targetElementData?: any; /** returns the drop position such as before, after or over - */ + */ position?: string; /** returns the event object - */ + */ event?: any; } export interface NodeDroppedEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the original drop target - */ + */ dropTarget?: any; /** returns the current dropped TreeView node - */ + */ droppedElement?: any; /** returns the current dropped TreeView node details - */ + */ droppedElementData?: any; /** returns the current parent element of the dropped node - */ + */ target?: any; /** returns the given parent node details - */ + */ targetElementData?: any; /** returns the drop position such as before, after or over - */ + */ position?: string; /** returns the event object - */ + */ event?: any; } export interface NodeEditEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the id of the element - */ + */ id?: string; /** returns the oldText of the element - */ + */ oldText?: string; /** returns the newText of the element - */ + */ newText?: string; /** returns the event object - */ + */ event?: any; /** returns the target element, the given node to be cut - */ + */ target?: any; /** returns the given target node values - */ + */ nodeDetails?: any; } export interface NodeExpandEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the value of the node - */ + */ value?: string; /** if the child node is ready to expanded state; otherwise, false. - */ + */ isChildLoaded?: boolean; /** returns the current element of the node clicked - */ + */ currentElement?: any; /** returns the id of currently clicked node - */ + */ id?: string; /** returns the parent id of currently clicked node - */ + */ parentId?: string; /** returns the format asynchronous or synchronous - */ + */ async?: boolean; } export interface NodePasteEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the event object - */ + */ event?: any; /** returns the pasted element - */ + */ target?: any; /** returns the given target node values - */ + */ nodeDetails?: any; /** returns the key pressed key code value - */ + */ keyCode?: number; } export interface NodeSelectEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the id of the current element of the node clicked - */ + */ id?: any; /** returns the id of the parent element of current element of the node clicked - */ + */ parentId?: any; /** returns the current selected nodes index of TreeView - */ + */ selectedNodes?: any[]; /** returns the value of the node - */ + */ value?: string; /** returns the current element of the node clicked - */ + */ currentElement?: any; } export interface NodeUncheckEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; /** returns the event object - */ + */ event?: any; /** returns the id of the current element of the node clicked - */ + */ id?: any; /** returns the id of the parent element of current element of the node clicked - */ + */ parentId?: any; /** returns the value of the node - */ + */ value?: string; /** returns the current element of the node clicked - */ + */ currentElement?: any; /** it returns true when the node checkbox is checked; otherwise, false. - */ + */ isChecked?: boolean; /** it returns currently unchecked node name - */ + */ currentNode?: string; /** it returns currently unchecked node and its child node details. - */ + */ currentUncheckedNodes?: any[]; } export interface NodeUnselectEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the current element of the node unselected - */ + */ currentElement?: any; /** returns the id of the current element of the node unselected - */ + */ id?: string; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the id of the parent element of current element of the node unselected - */ + */ parentId?: string; /** returns the current selected nodes index of TreeView - */ + */ selectedNodes?: any[]; /** returns the name of the event - */ + */ type?: string; /** returns the value of the node - */ + */ value?: string; } export interface ReadyEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the TreeView model - */ + */ model?: ej.TreeView.Model; /** returns the name of the event - */ + */ type?: string; } export interface Fields { /** It receives the child level or inner level data source such as Essential DataManager object and JSON object. - */ + */ child?: any; /** It receives Essential DataManager object and JSON object. - */ + */ dataSource?: any; /** Specifies the node to be in expanded state. - */ + */ expanded?: string; /** Its allow us to indicate whether the node has child or not in load on demand - */ + */ hasChild?: string; /** Specifies the HTML Attributes to "li" item list. - */ + */ htmlAttribute?: any; /** Specifies the id to TreeView node items list. - */ + */ id?: string; /** Specifies the image attribute to Ă¢â‚¬Å“imgĂ¢â‚¬Â tag inside items list - */ + */ imageAttribute?: any; /** Specifies the HTML Attributes to "li" item list. - */ + */ imageUrl?: string; /** If its true Checkbox node will be checked when rendered with checkbox. - */ + */ isChecked?: string; /** Specifies the link attribute to Ă¢â‚¬Å“aĂ¢â‚¬Â tag in item list. - */ + */ linkAttribute?: any; /** Specifies the parent id of the node. The nodes are listed as child nodes of the specified parent node by using its parent id. - */ + */ parentId?: string; /** It receives query to retrieve data from the table (query is same as SQL). - */ + */ query?: any; /** Allow us to specify the node to be in selected state - */ + */ selected?: string; /** Specifies the sprite CSS class to "li" item list. - */ + */ spriteCssClass?: string; /** It receives the table name to execute query on the corresponding table. - */ + */ tableName?: string; /** Specifies the text of TreeView node items list. - */ + */ text?: string; } export interface SortSettings { /** Enables or disables the sorting option in TreeView control - * @Default {false} - */ + * @Default {false} + */ allowSorting?: boolean; /** Sets the sorting order type. There are two sorting types available, such as "ascending", "descending". - * @Default {ej.sortOrder.Ascending} - */ + * @Default {ej.sortOrder.Ascending} + */ sortOrder?: ej.sortOrder|string; } } @@ -20426,23 +20426,23 @@ class Uploadbox extends ej.Widget { defaults: Uploadbox.Model; /** The destroy method destroys the control and brings the control to a pre-init state. All the events of the Upload control is bound by using this._on unbinds automatically. - * @returns {void} - */ + * @returns {void} + */ destroy(): void; /** Disables the Uploadbox control - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** Enables the Uploadbox control - * @returns {void} - */ + * @returns {void} + */ enable(): void; /** Refresh the Uploadbox control - * @returns {void} - */ + * @returns {void} + */ refresh(): void; } export namespace Uploadbox { @@ -20450,142 +20450,142 @@ export namespace Uploadbox { export interface Model { /** Enables the file drag and drop support to the Uploadbox control. - * @Default {false} - */ + * @Default {false} + */ allowDragAndDrop?: boolean; /** Uploadbox supports both synchronous and asynchronous upload. This can be achieved by using the asyncUpload property. - * @Default {true} - */ + * @Default {true} + */ asyncUpload?: boolean; /** Uploadbox supports auto uploading of files after the file selection is done. - * @Default {false} - */ + * @Default {false} + */ autoUpload?: boolean; /** Sets the text for each action button. - * @Default {{browse: Browse, upload: Upload, cancel: Cancel, close: Close}} - */ + * @Default {{browse: Browse, upload: Upload, cancel: Cancel, close: Close}} + */ buttonText?: ButtonText; /** Sets the root class for the Uploadbox control theme. This cssClass API helps to use custom skinning option for the Uploadbox button and dialog content. - */ + */ cssClass?: string; /** Specifies the custom file details in the dialog popup on initialization. - * @Default {{ title:true, name:true, size:true, status:true, action:true}} - */ + * @Default {{ title:true, name:true, size:true, status:true, action:true}} + */ customFileDetails?: CustomFileDetails; /** Specifies the actions for dialog popup while initialization. - * @Default {{ modal:false, closeOnComplete:false, content:null, drag:true}} - */ + * @Default {{ modal:false, closeOnComplete:false, content:null, drag:true}} + */ dialogAction?: DialogAction; /** Displays the Uploadbox dialog at the given X and Y positions. X: Dialog sets the left position value. Y: Dialog sets the top position value. - * @Default {null} - */ + * @Default {null} + */ dialogPosition?: any; /** Property for applying the text to the Dialog title and content headers. - * @Default {{ title: Upload Box, name: Name, size: Size, status: Status}} - */ + * @Default {{ title: Upload Box, name: Name, size: Size, status: Status}} + */ dialogText?: DialogText; /** The dropAreaText is displayed when the drag and drop support is enabled in the Uploadbox control. - * @Default {Drop files or click to upload} - */ + * @Default {Drop files or click to upload} + */ dropAreaText?: string; /** Specifies the dropAreaHeight when the drag and drop support is enabled in the Uploadbox control. - * @Default {100%} - */ + * @Default {100%} + */ dropAreaHeight?: number|string; /** Specifies the dropAreaWidth when the drag and drop support is enabled in the Uploadbox control. - * @Default {100%} - */ + * @Default {100%} + */ dropAreaWidth?: number|string; /** Based on the property value, Uploadbox is enabled or disabled. - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Sets the right-to-left direction property for the Uploadbox control. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Only the files with the specified extension is allowed to upload. This is mentioned in the string format. - */ + */ extensionsAllow?: string; /** Only the files with the specified extension is denied for upload. This is mentioned in the string format. - */ + */ extensionsDeny?: string; /** Sets the maximum size limit for uploading the file. This is mentioned in the number format. - * @Default {31457280} - */ + * @Default {31457280} + */ fileSize?: number; /** Sets the height of the browse button. - * @Default {35px} - */ + * @Default {35px} + */ height?: string; /** Specifies the list of HTML attributes to be added to uploadbox control. - * @Default {{}} - */ + * @Default {{}} + */ htmlAttributes?: any; /** Configures the culture data and sets the culture to the Uploadbox. - * @Default {en-US} - */ + * @Default {en-US} + */ locale?: string; /** Enables multiple file selection for upload. - * @Default {true} - */ + * @Default {true} + */ multipleFilesSelection?: boolean; /** You can push the file to the Uploadbox in the client-side of the XHR supported browsers alone. - * @Default {null} - */ + * @Default {null} + */ pushFile?: any; /** Specifies the remove action to be performed after the file uploading is completed. Here, mention the server address for removal. - */ + */ removeUrl?: string; /** Specifies the save action to be performed after the file is pushed for uploading. Here, mention the server address to be saved. - */ + */ saveUrl?: string; /** Enables the browse button support to the Uploadbox control. - * @Default {true} - */ + * @Default {true} + */ showBrowseButton?: boolean; /** Specifies the file details to be displayed when selected for uploading. This can be done when the showFileDetails is set to true. - * @Default {true} - */ + * @Default {true} + */ showFileDetails?: boolean; /** Specifies the file details to be displayed when selected for uploading. This can be done when the showFileDetails is set to true. - * @Default {true} - */ + * @Default {true} + */ showRoundedCorner?: boolean; /** Sets the name for the Uploadbox control. This API helps to Map the action in code behind to retrieve the files. - */ + */ uploadName?: string; /** Sets the width of the browse button. - * @Default {100px} - */ + * @Default {100px} + */ width?: string; /** Fires when the upload progress beforeSend. */ @@ -20625,297 +20625,297 @@ export interface Model { export interface BeforeSendEventArgs { /** Selected FileList Object. - */ + */ files?: any; /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Uploadbox model - */ + */ model?: any; /** XHR-AJAX Object for reference. - */ + */ xhr?: any; /** returns the name of the event. - */ + */ type?: string; } export interface BeginEventArgs { /** To pass additional information to the server. - */ + */ data?: any; /** Selected FileList Object. - */ + */ files?: any; /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Uploadbox model - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; } export interface CancelEventArgs { /** Canceled FileList Object. - */ + */ fileStatus?: any; /** returns the Uploadbox model - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; } export interface CompleteEventArgs { /** AJAX event argument for reference. - */ + */ e?: any; /** Uploaded file list. - */ + */ files?: any; /** response from the server. - */ + */ responseText?: string; /** XHR-AJAX Object for reference. - */ + */ xhr?: any; /** returns the Uploadbox model - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; } export interface SuccessEventArgs { /** response from the server. - */ + */ responseText?: string; /** AJAX event argument for reference. - */ + */ e?: any; /** successfully uploaded files list. - */ + */ success?: any; /** Uploaded file list. - */ + */ files?: any; /** XHR-AJAX Object for reference. - */ + */ xhr?: any; /** returns the Uploadbox model - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; } export interface CreateEventArgs { /** returns the Uploadbox model - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; } export interface DestroyEventArgs { /** returns the Uploadbox model - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; } export interface ErrorEventArgs { /** details about the error information. - */ + */ error?: string; /** returns the name of the event. - */ + */ type?: string; /** error event action details. - */ + */ action?: string; /** returns the file details of the file uploaded - */ + */ files?: any; } export interface FileSelectEventArgs { /** returns Selected FileList objects - */ + */ files?: any; /** returns the Uploadbox model - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; } export interface InProgressEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** AJAX event argument for reference. - */ + */ e?: any; /** returns Selected FileList objects - */ + */ files?: any; /** returns the Uploadbox model - */ + */ model?: any; /** returns the current progress percentage. - */ + */ percentage?: any; /** returns the name of the event. - */ + */ type?: string; } export interface RemoveEventArgs { /** returns the Uploadbox model - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; /** returns the file details of the file object - */ + */ fileStatus?: any; } export interface ButtonText { /** Sets the text for the browse button. - */ + */ browse?: string; /** Sets the text for the cancel button. - */ + */ cancel?: string; /** Sets the text for the close button. - */ + */ Close?: string; /** Sets the text for the Upload button inside the dialog popup. - */ + */ upload?: string; } export interface CustomFileDetails { /** Enables the file upload interactions like remove/cancel in File details of the dialog popup. - */ + */ action?: boolean; /** Enables the name in the File details of the dialog popup. - */ + */ name?: boolean; /** Enables or disables the File size details of the dialog popup. - */ + */ size?: boolean; /** Enables or disables the file uploading status visibility in the dialog file details content. - */ + */ status?: boolean; /** Enables the title in File details for the dialog popup. - */ + */ title?: boolean; } export interface DialogAction { /** Once uploaded successfully, the dialog popup closes immediately. - */ + */ closeOnComplete?: boolean; /** Sets the content container option to the Uploadbox dialog popup. - */ + */ content?: string; /** Enables the drag option to the dialog popup. - */ + */ drag?: boolean; /** Enables or disables the Uploadbox dialogĂ¢â‚¬â„¢s modal property to the dialog popup. - */ + */ modal?: boolean; } export interface DialogText { /** Sets the uploaded fileĂ¢â‚¬â„¢s Name (header text) to the Dialog popup. - */ + */ name?: string; /** Sets the upload file Size (header text) to the dialog popup. - */ + */ size?: string; /** Sets the upload file Status (header text) to the dialog popup. - */ + */ status?: string; /** Sets the title text of the dialog popup. - */ + */ title?: string; } } @@ -20928,18 +20928,18 @@ class WaitingPopup extends ej.Widget { defaults: WaitingPopup.Model; /** To hide the waiting popup - * @returns {void} - */ + * @returns {void} + */ hide(): void; /** Refreshes the WaitingPopup control by resetting the pop-up panel position and content position - * @returns {void} - */ + * @returns {void} + */ refresh(): void; /** To show the waiting popup - * @returns {void} - */ + * @returns {void} + */ show(): void; } export namespace WaitingPopup { @@ -20947,43 +20947,43 @@ export namespace WaitingPopup { export interface Model { /** Sets the root class for the WaitingPopup control theme - * @Default {null} - */ + * @Default {null} + */ cssClass?: string; /** Specifies the list of HTML attributes to be added to waitingpopup control. - * @Default {{}} - */ + * @Default {{}} + */ htmlAttributes?: any; /** Enables or disables the default loading icon. - * @Default {true} - */ + * @Default {true} + */ showImage?: boolean; /** Enables the visibility of the WaitingPopup control - * @Default {false} - */ + * @Default {false} + */ showOnInit?: boolean; /** Specified a selector for elements, within the container. - * @Default {null} - */ + * @Default {null} + */ target?: string; /** Waitingpopup element append to given container element. - * @Default {null} - */ + * @Default {null} + */ appendTo?: string; /** Loads HTML content inside the popup panel instead of the default icon - * @Default {null} - */ + * @Default {null} + */ template?: any; /** Sets the custom text in the pop-up panel to notify the waiting process - * @Default {null} - */ + * @Default {null} + */ text?: string; /** Fires after Create WaitingPopup successfully */ @@ -20996,30 +20996,30 @@ export interface Model { export interface CreateEventArgs { /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the WaitingPopup model - */ + */ model?: ej.WaitingPopup.Model; /** returns the name of the event - */ + */ type?: string; } export interface DestroyEventArgs { /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the WaitingPopup model - */ + */ model?: ej.WaitingPopup.Model; /** returns the name of the event - */ + */ type?: string; } } @@ -21032,604 +21032,604 @@ class Grid extends ej.Widget { defaults: Grid.Model; /** Adds a grid model property which is to be ignored upon exporting. - * @param {Array} Pass the array of parameters which need to be ignored on exporting - * @returns {void} - */ + * @param {Array} Pass the array of parameters which need to be ignored on exporting + * @returns {void} + */ addIgnoreOnExport(propertyNames: any[]): void; /** Add a new record in grid control when allowAdding is set as true. - * @returns {void} - */ + * @returns {void} + */ //addRecord(): void; /** Add a new record in grid control when allowAdding is set as true. - * @param {Array} Pass the array of added Records - * @param {Array} optionalIf we pass serverChange as true, send post to server side for server action. - * @returns {void} - */ + * @param {Array} Pass the array of added Records + * @param {Array} optionalIf we pass serverChange as true, send post to server side for server action. + * @returns {void} + */ addRecord(data: any[], serverChange?: any[]): void; /** Cancel the modified changes in grid control when edit mode is "batch". - * @returns {void} - */ + * @returns {void} + */ batchCancel(): void; /** Save the modified changes to data source in grid control when edit mode is "batch". - * @returns {void} - */ + * @returns {void} + */ batchSave(): void; /** Send a cancel request in grid. - * @returns {void} - */ + * @returns {void} + */ cancelEdit(): void; /** Send a cancel request to the edited cell in grid. - * @returns {void} - */ + * @returns {void} + */ cancelEditCell(): void; /** It is used to clear all the cell selection. - * @returns {Boolean} - */ + * @returns {Boolean} + */ clearCellSelection(): boolean; /** It is used to clear specified cell selection based on the rowIndex and columnIndex provided. - * @param {number} It is used to pass the row index of the cell - * @param {number} It is used to pass the column index of the cell. - * @returns {Boolean} - */ + * @param {number} It is used to pass the row index of the cell + * @param {number} It is used to pass the column index of the cell. + * @returns {Boolean} + */ clearCellSelection(rowIndex: number, columnIndex: number): boolean; /** It is used to clear all the row selection or at specific row selection based on the index provided. - * @param {number} optional If index of the column is specified then it will remove the selection from the particular column else it will clears all of the column selection - * @returns {Boolean} - */ + * @param {number} optional If index of the column is specified then it will remove the selection from the particular column else it will clears all of the column selection + * @returns {Boolean} + */ clearColumnSelection(index?: number): boolean; /** It is used to clear all the filtering done. - * @param {string} If field of the column is specified then it will clear the particular filtering column - * @returns {void} - */ + * @param {string} If field of the column is specified then it will clear the particular filtering column + * @returns {void} + */ clearFiltering(field: string): void; /** Clear the searching from the grid - * @returns {void} - */ + * @returns {void} + */ clearSearching(): void; /** Clear all the row selection or at specific row selection based on the index provided - * @param {number} optional If index of the row is specified then it will remove the selection from the particular row else it will clears all of the row selection - * @returns {Boolean} - */ + * @param {number} optional If index of the row is specified then it will remove the selection from the particular row else it will clears all of the row selection + * @returns {Boolean} + */ clearSelection(index?: number): boolean; /** Clear the sorting from columns in the grid - * @returns {void} - */ + * @returns {void} + */ clearSorting(): void; /** Collapse all the group caption rows in grid - * @returns {void} - */ + * @returns {void} + */ collapseAll(): void; /** Collapse the group drop area in grid - * @returns {void} - */ + * @returns {void} + */ collapseGroupDropArea(): void; /** Add or remove columns in grid column collections - * @param {Array|string} Pass array of columns or string of field name to add/remove the column in grid - * @param {string} optional Pass add/remove action to be performed. By default "add" action will perform - * @returns {void} - */ + * @param {Array|string} Pass array of columns or string of field name to add/remove the column in grid + * @param {string} optional Pass add/remove action to be performed. By default "add" action will perform + * @returns {void} + */ columns(columnDetails: any[]|string, action?: string): void; /** Refresh the grid with new data source - * @param {Array} Pass new data source to the grid - * @param {boolean} optional When templateRefresh is set true, both header and contents get refreshed - * @returns {void} - */ + * @param {Array} Pass new data source to the grid + * @param {boolean} optional When templateRefresh is set true, both header and contents get refreshed + * @returns {void} + */ dataSource(datasource: any[], templateRefresh?: boolean): void; /** Delete a record in grid control when allowDeleting is set as true - * @param {string} Pass the primary key field Name of the column - * @param {Array} Pass the JSON data of record need to be delete. - * @returns {void} - */ + * @param {string} Pass the primary key field Name of the column + * @param {Array} Pass the JSON data of record need to be delete. + * @returns {void} + */ deleteRecord(fieldName: string, data: any[]): void; /** Delete the row based on the given tr element in grid. - * @param {JQuery} Pass the tr element in grid content to get its row index - * @returns {HTMLElement} - */ + * @param {JQuery} Pass the tr element in grid content to get its row index + * @returns {HTMLElement} + */ deleteRow($tr: JQuery): HTMLElement; /** Destroy the grid widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. - * @returns {void} - */ + * @returns {void} + */ destroy(): void; /** Edit a particular cell based on the row index and field name provided in "batch" edit mode. - * @param {number} Pass row index to edit particular cell - * @param {string} Pass the field name of the column to perform batch edit - * @returns {void} - */ + * @param {number} Pass row index to edit particular cell + * @param {string} Pass the field name of the column to perform batch edit + * @returns {void} + */ editCell(index: number, fieldName: string): void; /** It returns a value and if the input field values of edit form is not based on the validation rules then it will show the validation message. - * @returns {Boolean} - */ + * @returns {Boolean} + */ editFormValidate(): boolean; /** Send a save request in grid. - * @returns {void} - */ + * @returns {void} + */ endEdit(): void; /** Expand all the group caption rows in grid. - * @returns {void} - */ + * @returns {void} + */ expandAll(): void; /** Expand or collapse the row based on the row state in grid - * @param {JQuery} Pass the target object to expand/collapse the row based on its row state - * @returns {void} - */ + * @param {JQuery} Pass the target object to expand/collapse the row based on its row state + * @returns {void} + */ expandCollapse($target: JQuery): void; /** Expand the group drop area in grid. - * @returns {void} - */ + * @returns {void} + */ expandGroupDropArea(): void; /** Export the grid content to excel, word or PDF document. - * @param {string} Pass the controller action name corresponding to exporting - * @param {string} optionalASP server event name corresponding to exporting - * @param {boolean} optionalPass the multiple exporting value as true/false - * @param {Array} optionalPass the array of the gridIds to be filtered - * @returns {void} - */ + * @param {string} Pass the controller action name corresponding to exporting + * @param {string} optionalASP server event name corresponding to exporting + * @param {boolean} optionalPass the multiple exporting value as true/false + * @param {Array} optionalPass the array of the gridIds to be filtered + * @returns {void} + */ export(action: string, serverEvent?: string, multipleExport?: boolean, gridIds?: any[]): void; /** Send a filtering request to filter one column in grid. - * @param {Array} Pass the field name of the column - * @param {string} string/integer/dateTime operator - * @param {string} Pass the value to be filtered in a column - * @param {string} Pass the predicate as and/or - * @param {boolean} optional Pass the match case value as true/false - * @param {any} optionalactualFilterValue denote the filter object of current filtered columns.Pass the value to filtered in a column - * @returns {void} - */ + * @param {Array} Pass the field name of the column + * @param {string} string/integer/dateTime operator + * @param {string} Pass the value to be filtered in a column + * @param {string} Pass the predicate as and/or + * @param {boolean} optional Pass the match case value as true/false + * @param {any} optionalactualFilterValue denote the filter object of current filtered columns.Pass the value to filtered in a column + * @returns {void} + */ filterColumn(fieldName: any[], filterOperator: string, filterValue: string, predicate: string, matchcase?: boolean, actualFilterValue?: any): void; /** Send a filtering request to filter single or multiple column in grid. - * @param {Array} Pass array of filterColumn query for performing filter operation - * @returns {void} - */ + * @param {Array} Pass array of filterColumn query for performing filter operation + * @returns {void} + */ filterColumn(filterQueries: any[]): void; /** Get the batch changes of edit, delete and add operations of grid. - * @returns {any} - */ + * @returns {any} + */ getBatchChanges(): any; /** Get the browser details - * @returns {any} - */ + * @returns {any} + */ getBrowserDetails(): any; /** Get the column details based on the given field in grid - * @param {string} Pass the field name of the column to get the corresponding column object - * @returns {any} - */ + * @param {string} Pass the field name of the column to get the corresponding column object + * @returns {any} + */ getColumnByField(fieldName: string): any; /** Get the column details based on the given header text in grid. - * @param {string} Pass the header text of the column to get the corresponding column object - * @returns {any} - */ + * @param {string} Pass the header text of the column to get the corresponding column object + * @returns {any} + */ getColumnByHeaderText(headerText: string): any; /** Get the column details based on the given column index in grid - * @param {number} Pass the index of the column to get the corresponding column object - * @returns {any} - */ + * @param {number} Pass the index of the column to get the corresponding column object + * @returns {any} + */ getColumnByIndex(columnIndex: number): any; /** Get the list of field names from column collection in grid. - * @returns {Array} - */ + * @returns {Array} + */ getColumnFieldNames(): any[]; /** Get the column index of the given field in grid. - * @param {string} Pass the field name of the column to get the corresponding column index - * @returns {number} - */ + * @param {string} Pass the field name of the column to get the corresponding column index + * @returns {number} + */ getColumnIndexByField(fieldName: string): number; /** Get the column index of the given headerText of column in grid. - * @param {string} Pass the headerText of the column to get that column index - * @param {string} optionalOptional Pass the field name of the column. - * @returns {number} - */ + * @param {string} Pass the headerText of the column to get that column index + * @param {string} optionalOptional Pass the field name of the column. + * @returns {number} + */ getColumnIndexByHeaderText(headerText: string, field?: string): number; /** Get the content div element of grid. - * @returns {HTMLElement} - */ + * @returns {HTMLElement} + */ getContent(): HTMLElement; /** Get the content table element of grid - * @returns {Array} - */ + * @returns {Array} + */ getContentTable(): HTMLTableElement[]; /** Get the data of currently edited cell value in "batch" edit mode - * @returns {any} - */ + * @returns {any} + */ getCurrentEditCellData(): any; /** Get the current page index in grid pager. - * @returns {number} - */ + * @returns {number} + */ getCurrentIndex(): number; /** Get the current page data source of grid. - * @returns {Array} - */ + * @returns {Array} + */ getCurrentViewData(): any[]; /** Get the data of given row index in grid. - * @returns {any} - */ + * @returns {any} + */ getDataByIndex(): any; /** Get the column field name from the given header text in grid. - * @param {string} Pass header text of the column to get its corresponding field name - * @returns {String} - */ + * @param {string} Pass header text of the column to get its corresponding field name + * @returns {String} + */ getFieldNameByHeaderText(headerText: string): string; /** Get the filter bar of grid - * @returns {HTMLElement} - */ + * @returns {HTMLElement} + */ getFilterBar(): HTMLElement; /** Get the records filtered or searched in Grid - * @returns {Array} - */ + * @returns {Array} + */ getFilteredRecords(): any[]; /** Get the footer content of grid. - * @returns {HTMLElement} - */ + * @returns {HTMLElement} + */ getFooterContent(): HTMLElement; /** Get the footer table element of grid. - * @returns {HTMLElement} - */ + * @returns {HTMLElement} + */ getFooterTable(): HTMLElement; /** Get the header content div element of grid. - * @returns {HTMLElement} - */ + * @returns {HTMLElement} + */ getHeaderContent(): HTMLElement; /** Get the header table element of grid - * @returns {HTMLElement} - */ + * @returns {HTMLElement} + */ getHeaderTable(): HTMLElement; /** Get the column header text from the given field name in grid. - * @param {string} Pass field name of the column to get its corresponding header text - * @returns {String} - */ + * @param {string} Pass field name of the column to get its corresponding header text + * @returns {String} + */ getHeaderTextByFieldName(field: string): string; /** Get the names of all the hidden column collections in grid. - * @returns {Array} - */ + * @returns {Array} + */ getHiddenColumnNames(): any[]; /** Get the row index based on the given tr element in grid. - * @param {JQuery} Pass the tr element in grid content to get its row index - * @returns {number} - */ + * @param {JQuery} Pass the tr element in grid content to get its row index + * @returns {number} + */ getIndexByRow($tr: JQuery): number; /** Get the pager of grid. - * @returns {HTMLElement} - */ + * @returns {HTMLElement} + */ getPager(): HTMLElement; /** Get the names of primary key columns in Grid - * @returns {Array} - */ + * @returns {Array} + */ getPrimaryKeyFieldNames(): any[]; /** Get the rows(tr element) from the given from and to row index in grid - * @param {number} Pass the from index from which the rows to be returned - * @param {number} Pass the to index to which the rows to be returned - * @returns {HTMLElement} - */ + * @param {number} Pass the from index from which the rows to be returned + * @param {number} Pass the to index to which the rows to be returned + * @returns {HTMLElement} + */ getRowByIndex(from: number, to: number): HTMLElement; /** Get the row height of grid. - * @returns {number} - */ + * @returns {number} + */ getRowHeight(): number; /** Get the rows(tr element)of grid which is displayed in the current page. - * @returns {HTMLElement} - */ + * @returns {HTMLElement} + */ getRows(): HTMLElement; /** Get the scroller object of grid. - * @returns {ej.Scroller} - */ + * @returns {ej.Scroller} + */ getScrollObject(): ej.Scroller; /** Get the selected records details in grid. - * @returns {Array} - */ + * @returns {Array} + */ getSelectedRecords(): any[]; /** Get the selected row element details in grid. - * @returns {Array} - */ + * @returns {Array} + */ getSelectedRows(): any[]; /** It accepts the string value and returns the field and sorted direction of the column in grid. - * @param {string} Pass the field of the column to get the sorted direction of the corresponding column in Grid. - * @returns {number} - */ + * @param {string} Pass the field of the column to get the sorted direction of the corresponding column in Grid. + * @returns {number} + */ getsortColumnByField(field: string): number; /** Get the calculated summary values of JSON data passed to it - * @param {any} Pass Summary Column details - * @param {any} Pass JSON Array for which its field values to be calculated - * @returns {Number} - */ + * @param {any} Pass Summary Column details + * @param {any} Pass JSON Array for which its field values to be calculated + * @returns {Number} + */ getSummaryValues(summaryCol: any, summaryData: any): number; /** Get the names of all the visible column collections in grid - * @returns {Array} - */ + * @returns {Array} + */ getVisibleColumnNames(): any[]; /** Send a paging request to specified page in grid - * @param {number} Pass the page index to perform paging at specified page index - * @returns {void} - */ + * @param {number} Pass the page index to perform paging at specified page index + * @returns {void} + */ gotoPage(pageIndex: number): void; /** Send a column grouping request in grid. - * @param {string} Pass the field Name of the column to be grouped in grid control - * @returns {void} - */ + * @param {string} Pass the field Name of the column to be grouped in grid control + * @returns {void} + */ groupColumn(fieldName: string): void; /** Hide columns from the grid based on the header text - * @param {Array|string} you can pass either array of header text of various columns or a header text of a column to hide - * @returns {void} - */ + * @param {Array|string} you can pass either array of header text of various columns or a header text of a column to hide + * @returns {void} + */ hideColumns(headerText: any[]|string): void; /** Print the grid control - * @returns {void} - */ + * @returns {void} + */ print(): void; /** It is used to refresh and reset the changes made in "batch" edit mode - * @returns {void} - */ + * @returns {void} + */ refreshBatchEditChanges(): void; /** It is used to refresh the grid header. - * @returns {void} - */ + * @returns {void} + */ refreshHeader(): void; /** Refresh the grid contents. The template refreshment is based on the argument passed along with this method - * @param {boolean} optional When templateRefresh is set true, template and grid contents both are refreshed in grid else only grid content is refreshed - * @returns {void} - */ + * @param {boolean} optional When templateRefresh is set true, template and grid contents both are refreshed in grid else only grid content is refreshed + * @returns {void} + */ refreshContent(templateRefresh?: boolean): void; /** Refresh the template of the grid - * @returns {void} - */ + * @returns {void} + */ refreshTemplate(): void; /** Refresh the toolbar items in grid. - * @returns {void} - */ + * @returns {void} + */ refreshToolbar(): void; /** Remove a column or collection of columns from a sorted column collections in grid. - * @param {Array|string} Pass array of field names of the columns to remove a collection of sorted columns or pass a string of field name to remove a column from sorted column collections - * @returns {void} - */ + * @param {Array|string} Pass array of field names of the columns to remove a collection of sorted columns or pass a string of field name to remove a column from sorted column collections + * @returns {void} + */ removeSortedColumns(fieldName: any[]|string): void; /** Creates a grid control - * @returns {void} - */ + * @returns {void} + */ render(): void; /** Re-order the column in grid - * @param {string} Pass the from field name of the column needs to be changed - * @param {string} Pass the to field name of the column needs to be changed - * @returns {void} - */ + * @param {string} Pass the from field name of the column needs to be changed + * @param {string} Pass the to field name of the column needs to be changed + * @returns {void} + */ reorderColumns(fromFieldName: string, toFieldName: string): void; /** Re-order the row in grid - * @param {Array} Pass the indexes of the rows needs to reorder. - * @param {number} Pass the index of a row where to be reordered. - * @returns {void} - */ + * @param {Array} Pass the indexes of the rows needs to reorder. + * @param {number} Pass the index of a row where to be reordered. + * @returns {void} + */ reorderRows(indexes: any[], toindex: number): void; /** Reset the model collections like pageSettings, groupSettings, filterSettings, sortSettings and summaryRows. - * @returns {void} - */ + * @returns {void} + */ resetModelCollections(): void; /** Resize the columns by giving column name and width for the corresponding one. - * @param {string} Pass the column name that needs to be changed - * @param {string} Pass the width to resize the particular columns - * @returns {void} - */ + * @param {string} Pass the column name that needs to be changed + * @param {string} Pass the width to resize the particular columns + * @returns {void} + */ resizeColumns(column: string, width: string): void; /** Resolves row height issue when unbound column is used with FrozenColumn - * @returns {void} - */ + * @returns {void} + */ rowHeightRefresh(): void; /** Save the particular edited cell in grid. - * @returns {void} - */ + * @returns {void} + */ //saveCell(): void; /** We can prevent the client side cellSave event triggering by passing the preventSaveEvent argument as true. - * @param {boolean} optionalIf we pass preventSaveEvent as true, it prevents the client side cellSave event triggering - * @returns {void} - */ + * @param {boolean} optionalIf we pass preventSaveEvent as true, it prevents the client side cellSave event triggering + * @returns {void} + */ saveCell(preventSaveEvent: boolean): void; /** Set dimension for grid with corresponding to grid parent. - * @param {number} Pass the height of the grid container - * @param {number} Pass the width of the grid container - * @returns {void} - */ + * @param {number} Pass the height of the grid container + * @param {number} Pass the width of the grid container + * @returns {void} + */ setDimension(height: number, width: number): void; /** Send a request to grid to refresh the width set to columns - * @returns {void} - */ + * @returns {void} + */ setWidthToColumns(): void; /** Send a search request to grid with specified string passed in it - * @param {string} Pass the string to search in Grid records - * @returns {void} - */ + * @param {string} Pass the string to search in Grid records + * @returns {void} + */ search(searchString: string): void; /** Select cells in grid. - * @param {any} It is used to set the starting index of row and indexes of cells for that corresponding row for selecting cells. - * @returns {void} - */ + * @param {any} It is used to set the starting index of row and indexes of cells for that corresponding row for selecting cells. + * @returns {void} + */ selectCells(rowCellIndexes: any): void; /** Select columns in grid. - * @param {number} It is used to set the starting index of column for selecting columns. - * @returns {void} - */ + * @param {number} It is used to set the starting index of column for selecting columns. + * @returns {void} + */ selectColumns(fromIndex: number): void; /** Select the specified columns in grid based on Index provided. - * @param {number} It is used to set the starting index of column for selecting columns. - * @param {number} optionalIt is used to set the ending index of column for selecting columns. - * @returns {Boolean} - */ + * @param {number} It is used to set the starting index of column for selecting columns. + * @param {number} optionalIt is used to set the ending index of column for selecting columns. + * @returns {Boolean} + */ selectColumns(columnIndex: number, toIndex?: number): boolean; /** Select rows in grid. - * @param {number} It is used to set the starting index of row for selecting rows. - * @param {number} It is used to set the ending index of row for selecting rows. - * @returns {void} - */ + * @param {number} It is used to set the starting index of row for selecting rows. + * @param {number} It is used to set the ending index of row for selecting rows. + * @returns {void} + */ selectRows(fromIndex: number, toIndex: number): void; /** Select specified rows in grid based on Index provided. - * @param {Array|number} It is used to set the starting index of row for selecting rows. - * @param {number} optionalIt is used to set the ending index of row for selecting rows. - * @param {any} optionalTarget element which is clicked. - * @returns {void} - */ + * @param {Array|number} It is used to set the starting index of row for selecting rows. + * @param {number} optionalIt is used to set the ending index of row for selecting rows. + * @param {any} optionalTarget element which is clicked. + * @returns {void} + */ selectRows(from: any[]|number, to: number, target?: any): void; /** Select rows in grid. - * @param {Array} Pass array of rowIndexes for selecting rows - * @returns {void} - */ + * @param {Array} Pass array of rowIndexes for selecting rows + * @returns {void} + */ selectRows(rowIndexes: any[]): void; /** Used to update a particular cell value. - * @returns {void} - */ + * @returns {void} + */ setCellText(): void; /** Used to update a particular cell value based on specified row Index and the fieldName. - * @param {number} It is used to set the index for selecting the row. - * @param {string} It is used to set the field name for selecting column. - * @param {any} It is used to set the value for the selected cell. - * @returns {void} - */ + * @param {number} It is used to set the index for selecting the row. + * @param {string} It is used to set the field name for selecting column. + * @param {any} It is used to set the value for the selected cell. + * @returns {void} + */ setCellValue(Index: number, fieldName: string, value: any): void; /** It sets the default data to the column in grid during adding record in batch edit mode. - * @returns {void} - */ + * @returns {void} + */ setDefaultData(): void; /** The grid rows has to be rendered as detail view in mobile mode based on given value. - * @param {number} It is used to render grid rows as details view in mobile mode. - * @returns {void} - */ + * @param {number} It is used to render grid rows as details view in mobile mode. + * @returns {void} + */ setPhoneModeMaxWidth(Index: number): void; /** Set validation to edit form in the grid. - * @returns {void} - */ + * @returns {void} + */ setValidation(): void; /** Set validation to a particular input field in a edit form dynamically. - * @param {string} Specify the field name of the column to set validation rules - * @param {any} Specify the validation rules for the field - * @returns {void} - */ + * @param {string} Specify the field name of the column to set validation rules + * @param {any} Specify the validation rules for the field + * @returns {void} + */ setValidationToField(fieldName: string, rules: any): void; /** Show columns in the grid based on the header text - * @param {Array|string} you can pass either array of header text of various columns or a header text of a column to show - * @returns {void} - */ + * @param {Array|string} you can pass either array of header text of various columns or a header text of a column to show + * @returns {void} + */ showColumns(headerText: any[]|string): void; /** Send a sorting request in grid. - * @param {string} Pass the field name of the column as columnName for which sorting have to be performed - * @param {string} optional Pass the sort direction ascending/descending by which the column have to be sort. By default it is sorting in an ascending order - * @returns {void} - */ + * @param {string} Pass the field name of the column as columnName for which sorting have to be performed + * @param {string} optional Pass the sort direction ascending/descending by which the column have to be sort. By default it is sorting in an ascending order + * @returns {void} + */ sortColumn(columnName: string, sortingDirection?: string): void; /** Send an edit record request in grid - * @param {JQuery} Pass the tr- selected row element to be edited in grid - * @returns {void} - */ + * @param {JQuery} Pass the tr- selected row element to be edited in grid + * @returns {void} + */ startEdit($tr: JQuery): void; /** Un-group a column from grouped columns collection in grid - * @param {string} Pass the field Name of the column to be ungrouped from grouped column collection - * @returns {void} - */ + * @param {string} Pass the field Name of the column to be ungrouped from grouped column collection + * @returns {void} + */ ungroupColumn(fieldName: string): void; /** Update a edited record in grid control when allowEditing is set as true. - * @param {string} Pass the primary key field Name of the column - * @param {Array} Pass the edited JSON data of record need to be update. - * @returns {void} - */ + * @param {string} Pass the primary key field Name of the column + * @param {Array} Pass the edited JSON data of record need to be update. + * @returns {void} + */ updateRecord(fieldName: string, data: any[]): void; /** It adapts grid to its parent element or to the browsers window. - * @returns {void} - */ + * @returns {void} + */ windowonresize(): void; } export namespace Grid { @@ -21637,316 +21637,316 @@ export namespace Grid { export interface Model { /** Gets or sets a value that indicates whether to customizing cell based on our needs. - * @Default {false} - */ + * @Default {false} + */ allowCellMerging?: boolean; /** Gets or sets a value that indicates whether to enable dynamic grouping behavior. Grouping can be done by drag on drop desired columns to gridĂ¢â‚¬â„¢s GroupDropArea. - * This can be further customized through Ă¢â‚¬Å“groupSettingsĂ¢â‚¬Â property. - * @Default {false} - */ + * This can be further customized through Ă¢â‚¬Å“groupSettingsĂ¢â‚¬Â property. + * @Default {false} + */ allowGrouping?: boolean; /** Gets or sets a value that indicates whether to enable keyboard support for performing grid actions. selectionType Ă¢â‚¬â€œ Gets or sets a value that indicates whether to enable single - * row or multiple rows selection behavior in grid. Multiple selection can be done through by holding CTRL and clicking the grid rows - * @Default {true} - */ + * row or multiple rows selection behavior in grid. Multiple selection can be done through by holding CTRL and clicking the grid rows + * @Default {true} + */ allowKeyboardNavigation?: boolean; /** Gets or sets a value that indicates whether to enable dynamic filtering behavior on grid. Filtering can be used to limit the records displayed using required criteria and - * this can be further customized through Ă¢â‚¬Å“filterSettingsĂ¢â‚¬Â property - * @Default {false} - */ + * this can be further customized through Ă¢â‚¬Å“filterSettingsĂ¢â‚¬Â property + * @Default {false} + */ allowFiltering?: boolean; /** Gets or sets a value that indicates whether to enable the dynamic sorting behavior on grid data. Sorting can be done through clicking on particular column header. - * @Default {false} - */ + * @Default {false} + */ allowSorting?: boolean; /** Gets or sets a value that indicates whether to enable multi columns sorting behavior in grid. Sort multiple columns by holding CTRL and click on the corresponding column header. - * @Default {false} - */ + * @Default {false} + */ allowMultiSorting?: boolean; /** This specifies the grid to show the paginated data. Also enables pager control at the bottom of grid for dynamic navigation through data source. - * Paging can be further customized through Ă¢â‚¬Å“pageSettingsĂ¢â‚¬Â property. - * @Default {false} - */ + * Paging can be further customized through Ă¢â‚¬Å“pageSettingsĂ¢â‚¬Â property. + * @Default {false} + */ allowPaging?: boolean; /** Gets or sets a value that indicates whether to enable the columns reordering behavior in the grid. Reordering can be done through by drag and drop the particular column - * from one index to another index within the grid. - * @Default {false} - */ + * from one index to another index within the grid. + * @Default {false} + */ allowReordering?: boolean; /** Gets or sets a value that indicates whether the column is non resizable. Column width is set automatically based on the content or header text which is large. - * @Default {false} - */ + * @Default {false} + */ allowResizeToFit?: boolean; /** Gets or sets a value that indicates whether to enable dynamic resizable of columns. Resize the width of the columns by simply click and move the particular column header line - * @Default {false} - */ + * @Default {false} + */ allowResizing?: boolean; /** Gets or sets a value that indicates whether to enable the rows reordering in Grid and drag & drop rows between multiple Grid. - * @Default {false} - */ + * @Default {false} + */ allowRowDragAndDrop?: boolean; /** Gets or sets a value that indicates whether to enable the scrollbar in the grid and view the records by scroll through the grid manually - * @Default {false} - */ + * @Default {false} + */ allowScrolling?: boolean; /** Gets or sets a value that indicates whether to enable dynamic searching behavior in grid. Currently search box can be enabled through Ă¢â‚¬Å“toolbarSettingsĂ¢â‚¬Â - * @Default {false} - */ + * @Default {false} + */ allowSearching?: boolean; /** Gets or sets a value that indicates whether user can select rows on grid. On enabling feature, selected row will be highlighted. - * @Default {true} - */ + * @Default {true} + */ allowSelection?: boolean; /** Gets or sets a value that indicates whether the Content will wrap to the next line if the content exceeds the boundary of the Column Cells. - * @Default {false} - */ + * @Default {false} + */ allowTextWrap?: boolean; /** Gets or sets a value that indicates whether to enable the multiple exporting behavior on grid data. - * @Default {false} - */ + * @Default {false} + */ allowMultipleExporting?: boolean; /** Gets or sets a value that indicates to define common width for all the columns in the grid. - */ + */ commonWidth?: number; /** Gets or sets a value that indicates to enable the visibility of the grid lines. - * @Default {ej.Grid.GridLines.Both} - */ + * @Default {ej.Grid.GridLines.Both} + */ gridLines?: ej.Grid.GridLines|string; /** This specifies the grid to add the grid control inside the grid row of the parent with expand/collapse options - * @Default {null} - */ + * @Default {null} + */ childGrid?: any; /** Used to enable or disable static width settings for column. If the columnLayout is set as fixed, then column width will be static. - * @Default {ej.Grid.ColumnLayout.Auto} - */ + * @Default {ej.Grid.ColumnLayout.Auto} + */ columnLayout?: ej.Grid.ColumnLayout|string; /** Gets or sets an object that indicates to render the grid with specified columns - * @Default {[]} - */ + * @Default {[]} + */ columns?: Column[]; /** Gets or sets an object that indicates whether to customize the context menu behavior of the grid. - */ + */ contextMenuSettings?: ContextMenuSettings; /** Gets or sets a value that indicates to render the grid with custom theme. - */ + */ cssClass?: string; /** Gets or sets the data to render the grid with records - * @Default {null} - */ + * @Default {null} + */ dataSource?: any; /** Default Value: - * @Default {null} - */ + * @Default {null} + */ detailsTemplate?: string; /** Gets or sets an object that indicates whether to customize the editing behavior of the grid. - */ + */ editSettings?: EditSettings; /** Gets or sets a value that indicates whether to enable the alternative rows differentiation in the grid records based on corresponding theme. - * @Default {true} - */ + * @Default {true} + */ enableAltRow?: boolean; /** Gets or sets a value that indicates whether to enable the save action in the grid through row selection - * @Default {true} - */ + * @Default {true} + */ enableAutoSaveOnSelectionChange?: boolean; /** Gets or sets a value that indicates whether to enable mouse over effect on the corresponding column header cell of the grid - * @Default {false} - */ + * @Default {false} + */ enableHeaderHover?: boolean; /** Gets or sets a value that indicates whether to persist the grid model state in page using applicable medium i.e., HTML5 localStorage or cookies - * @Default {false} - */ + * @Default {false} + */ enablePersistence?: boolean; /** Gets or sets a value that indicates whether the grid rows has to be rendered as detail view in mobile mode - * @Default {false} - */ + * @Default {false} + */ enableResponsiveRow?: boolean; /** Gets or sets a value that indicates whether to enable mouse over effect on corresponding grid row. - * @Default {true} - */ + * @Default {true} + */ enableRowHover?: boolean; /** Align content in the grid control from right to left by setting the property as true. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** To Disable the mouse swipe property as false. - * @Default {true} - */ + * @Default {true} + */ enableTouch?: boolean; /** It sets a value that indicates whether to enable toolbar items, when allowEditing, allowAdding and allowDeleting property set as false in the grid. - * @Default {false} - */ + * @Default {false} + */ enableToolbarItems?: boolean; /** Act as mapper for the excel exporting URL. - * @Default {ExportToExcel} - */ + * @Default {ExportToExcel} + */ exportToExcelAction?: string; /** Act as mapper for the PDF exporting URL. - * @Default {ExportToPdf} - */ + * @Default {ExportToPdf} + */ exportToPdfAction?: string; /** Act as mapper for the Word exporting URL. - * @Default {ExportToWord} - */ + * @Default {ExportToWord} + */ exportToWordAction?: string; /** Gets or sets an object that indicates whether to customize the filtering behavior of the grid - */ + */ filterSettings?: FilterSettings; /** Gets or sets an object that indicates whether to customize the grouping behavior of the grid. - */ + */ groupSettings?: GroupSettings; /** Gets or sets a value that indicates whether the grid design has be to made responsive. - * @Default {false} - */ + * @Default {false} + */ isResponsive?: boolean; /** This specifies to change the key in keyboard interaction to grid control - * @Default {null} - */ + * @Default {null} + */ keySettings?: any; /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and - * culture specific to a particular country or region. - * @Default {en-US} - */ + * culture specific to a particular country or region. + * @Default {en-US} + */ locale?: string; /** Gets or sets a value that indicates whether to set the minimum width of the responsive grid while isResponsive property is true and enableResponsiveRow property is set as false. - * @Default {0} - */ + * @Default {0} + */ minWidth?: number; /** Gets or sets an object that indicates whether to modify the pager default configuration. - */ + */ pageSettings?: PageSettings; /** Query the dataSource from the table for Grid. - * @Default {null} - */ + * @Default {null} + */ query?: any; /** Gets or sets an object that indicates whether to modify the resizing behavior. - */ + */ resizeSettings?: ResizeSettings; /** Gets or sets a value that indicates to render the grid with template rows. The template row must be a table row. That table row must have the JavaScript render binding format ({{:columnName}}) - * then the grid data source binds the data to the corresponding table row of the template. - * @Default {null} - */ + * then the grid data source binds the data to the corresponding table row of the template. + * @Default {null} + */ rowTemplate?: string; /** Gets or sets an object that indicates whether to customize the drag and drop behavior of the grid rows - */ + */ rowDropSettings?: RowDropSettings; /** Gets or sets an object that indicates whether to customize the searching behavior of the grid - */ + */ searchSettings?: SearchSettings; /** Gets a value that indicates whether the grid model to hold multiple selected records . selectedRecords can be used to displayed hold the single - * or multiple selected records using Ă¢â‚¬Å“selectedRecordsĂ¢â‚¬Â property - * @Default {null} - */ + * or multiple selected records using Ă¢â‚¬Å“selectedRecordsĂ¢â‚¬Â property + * @Default {null} + */ selectedRecords?: any[]; /** Gets or sets a value that indicates to select the row while initializing the grid - * @Default {-1} - */ + * @Default {-1} + */ selectedRowIndex?: number; /** Gets or sets a value that indicates the selected rows in grid - * @Default {[]} - */ + * @Default {[]} + */ selectedRowIndices?: any[]; /** This property is used to configure the selection behavior of the grid. - */ + */ selectionSettings?: SelectionSettings; /** The row selection behavior of grid. Accepting types are "single" and "multiple". - * @Default {ej.Grid.SelectionType.Single} - */ + * @Default {ej.Grid.SelectionType.Single} + */ selectionType?: ej.Grid.SelectionType|string; /** Gets or sets an object that indicates whether to customize the scrolling behavior of the grid. - */ + */ scrollSettings?: ScrollSettings; /** Default Value: - * @Default {false} - */ + * @Default {false} + */ showColumnChooser?: boolean; /** Gets or sets a value that indicates stacked header should be shown on grid layout when the property Ă¢â‚¬Å“stackedHeaderRowsĂ¢â‚¬Â is set. - * @Default {false} - */ + * @Default {false} + */ showStackedHeader?: boolean; /** Gets or sets a value that indicates summary rows should be shown on grid layout when the property Ă¢â‚¬Å“summaryRowsĂ¢â‚¬Â is set - * @Default {false} - */ + * @Default {false} + */ showSummary?: boolean; /** Gets or sets a value that indicates whether to customize the sorting behavior of the grid. - */ + */ sortSettings?: SortSettings; /** Gets or sets an object that indicates to managing the collection of stacked header rows for the grid. - * @Default {[]} - */ + * @Default {[]} + */ stackedHeaderRows?: StackedHeaderRow[]; /** Gets or sets an object that indicates to managing the collection of summary rows for the grid. - * @Default {[]} - */ + * @Default {[]} + */ summaryRows?: SummaryRow[]; /** Gets or sets an object that indicates whether to auto wrap the grid header or content or both - */ + */ textWrapSettings?: TextWrapSettings; /** Gets or sets an object that indicates whether to enable the toolbar in the grid and add toolbar items - */ + */ toolbarSettings?: ToolbarSettings; /** Triggered for every grid action before its starts. */ @@ -22115,2622 +22115,2622 @@ export interface Model { export interface ActionBeginEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the grid model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the current selected page number. - */ + */ currentPage?: number; /** Returns the previous selected page number. - */ + */ previousPage?: number; /** Returns the end row index of that current page. - */ + */ endIndex?: number; /** Returns request type. - */ + */ requestType?: string; /** Returns the start row index of that current page. - */ + */ startIndex?: number; /** Returns the current grouped column field name. - */ + */ columnName?: string; /** Returns the column sort direction. - */ + */ columnSortDirection?: string; /** Returns current edited row. - */ + */ row?: any; /** Returns the current action event type. - */ + */ originalEventType?: string; /** Returns primary key. - */ + */ primaryKey?: string; /** Returns primary key value. - */ + */ primaryKeyValue?: string; /** Returns the edited row index. - */ + */ rowIndex?: number; /** Returns the record object (JSON). - */ + */ data?: any; /** Returns the foreign key record object (JSON). - */ + */ foreignKeyData?: any; /** Returns the selected row index. - */ + */ selectedRow?: number; /** Returns selected row for delete. - */ + */ tr?: any; /** Returns current filtering column field name. - */ + */ currentFilteringColumn?: any; /** Returns current filtering object. - */ + */ currentFilterObject?: any; /** Returns filter details. - */ + */ filterCollection?: any; /** Returns type of the column like number, string and so on. - */ + */ columnType?: string; /** Returns the excel filter model. - */ + */ filtermodel?: any; /** Returns the dataSource. - */ + */ dataSource?: any; /** Returns the query manager. - */ + */ query?: any; /** Returns the customfilter option value. - */ + */ isCustomFilter?: boolean; } export interface ActionCompleteEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the grid model. - */ + */ model?: any; /** Returns request type. - */ + */ requestType?: string; /** Returns the name of the event. - */ + */ type?: string; /** Returns the current selected page number. - */ + */ currentPage?: number; /** Returns the previous selected page number. - */ + */ previousPage?: number; /** Returns the end row index of that current page. - */ + */ endIndex?: number; /** Returns current action event type. - */ + */ originalEventType?: string; /** Returns the start row index of the current page. - */ + */ startIndex?: number; /** Returns grid element. - */ + */ target?: any; /** Returns the current sorted column field name. - */ + */ columnName?: string; /** Returns the column sort direction. - */ + */ columnSortDirection?: string; /** Returns current edited row. - */ + */ row?: any; /** Returns primary key. - */ + */ primaryKey?: string; /** Returns primary key value. - */ + */ primaryKeyValue?: string; /** Returns the edited row index. - */ + */ rowIndex?: number; /** Returns the record object (JSON). - */ + */ data?: any; /** Returns the selectedRow index. - */ + */ selectedRow?: number; /** Returns the foreign key record object (JSON). - */ + */ foreignKeyData?: any; /** Returns selected row for delete. - */ + */ tr?: any; /** Returns current filtering column field name. - */ + */ currentFilteringColumn?: string; /** Returns current filtering object. - */ + */ currentFilterObject?: any; /** Returns filter details. - */ + */ filterCollection?: any; /** Returns the dataSource. - */ + */ dataSource?: any; /** Returns the excel filter model. - */ + */ filtermodel?: any; /** Returns type of the column like number, string and so on. - */ + */ columnType?: string; /** Returns the customfilter option value. - */ + */ isCustomFilter?: boolean; } export interface ActionFailureEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the grid model. - */ + */ model?: any; /** Returns request type. - */ + */ requestType?: string; /** Returns the name of the event. - */ + */ type?: string; /** Returns the error return by server. - */ + */ error?: any; /** Returns the current selected page number. - */ + */ currentPage?: number; /** Returns the previous selected page number. - */ + */ previousPage?: number; /** Returns the end row index of that current page. - */ + */ endIndex?: number; /** Returns current action event type. - */ + */ originalEventType?: string; /** Returns the start row index of the current page. - */ + */ startIndex?: number; /** Returns grid element. - */ + */ target?: any; /** Returns the current sorted column field name. - */ + */ columnName?: string; /** Returns the column sort direction. - */ + */ columnSortDirection?: string; /** Returns current edited row. - */ + */ row?: any; /** Returns primary key. - */ + */ primaryKey?: string; /** Returns primary key value. - */ + */ primaryKeyValue?: string; /** Returns the edited row index. - */ + */ rowIndex?: number; /** Returns the record object (JSON). - */ + */ data?: any; /** Returns the selectedRow index. - */ + */ selectedRow?: number; /** Returns the foreign key record object (JSON). - */ + */ foreignKeyData?: any; /** Returns selected row for delete. - */ + */ tr?: any; /** Returns current filtering column field name. - */ + */ currentFilteringColumn?: string; /** Returns current filtering object. - */ + */ currentFilterObject?: any; /** Returns filter details. - */ + */ filterCollection?: any; } export interface BatchAddEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the grid model. - */ + */ model?: any; /** Returns deleted data. - */ + */ data?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the column object. - */ + */ columnObject?: any; /** Returns the column index. - */ + */ columnIndex?: number; /** Returns the row element. - */ + */ row?: any; /** Returns the primaryKey. - */ + */ primaryKey?: any; /** Returns the cell object. - */ + */ cell?: any; } export interface BatchDeleteEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the grid model. - */ + */ model?: any; /** Returns deleted data. - */ + */ data?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the primary key. - */ + */ primaryKey?: any; /** Returns the row Index. - */ + */ rowIndex?: number; } export interface BeforeBatchAddEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the grid model. - */ + */ model?: any; /** Returns deleted data. - */ + */ data?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the default data object. - */ + */ defaultData?: any; /** Returns the primaryKey. - */ + */ primaryKey?: any; } export interface BeforeBatchDeleteEventArgs { /** Returns the grid model. - */ + */ model?: any; /** Returns deleted data. - */ + */ data?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the primaryKey. - */ + */ primaryKey?: any; /** Returns the row index. - */ + */ rowIndex?: number; /** Returns the row data. - */ + */ rowData?: any; /** Returns the row element. - */ + */ row?: any; } export interface BeforeBatchSaveEventArgs { /** Returns the grid model. - */ + */ model?: any; /** Returns deleted data. - */ + */ data?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the changed record object. - */ + */ batchChanges?: any; } export interface BeforePrintEventArgs { /** Returns the grid model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the Grid element. - */ + */ element?: any; /** Returns the selected records. - */ + */ selectedRows?: any; } export interface BeforeRowDropEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the targeted row. - */ + */ target?: any; /** Returns the targeted row index. - */ + */ targetIndex?: any; /** Returns the dragged record details - */ + */ draggedRecords?: any; /** Returns the drop details - */ + */ dropDetails?: any; } export interface BeginEditEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the current edited row. - */ + */ row?: any; /** Returns the grid model. - */ + */ model?: any; /** Returns the primary key. - */ + */ primaryKey?: any; /** Returns the primary key value. - */ + */ primaryKeyValue?: any; /** Returns the edited row index. - */ + */ rowIndex?: number; /** Returns the name of the event. - */ + */ type?: string; } export interface CellEditEventArgs { /** Returns the grid model. - */ + */ model?: any; /** Returns deleted data. - */ + */ data?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the validation rules. - */ + */ validationRules?: any; /** Returns the column name. - */ + */ columnName?: string; /** Returns the cell value. - */ + */ value?: string; /** Returns the row data object. - */ + */ rowData?: any; /** Returns the previous value of the cell. - */ + */ previousValue?: string; /** Returns the column object. - */ + */ columnObject?: any; /** Returns the cell object. - */ + */ cell?: any; /** Returns isForeignKey option value. - */ + */ isForeignKey?: boolean; } export interface CellSaveEventArgs { /** Returns the grid model. - */ + */ model?: any; /** Returns deleted data. - */ + */ data?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the column name. - */ + */ columnName?: string; /** Returns the cell value. - */ + */ value?: string; /** Returns the row data object. - */ + */ rowData?: any; /** Returns the previous value of the cell. - */ + */ previousValue?: string; /** Returns the column object. - */ + */ columnObject?: any; /** Returns the cell object. - */ + */ cell?: any; /** Returns isForeignKey option value. - */ + */ isForeignKey?: boolean; } export interface CellSelectedEventArgs { /** Returns the selected cell index value. - */ + */ cellIndex?: number; /** Returns the previous selected cell index value. - */ + */ previousRowCellIndex?: number; /** Returns the selected cell element. - */ + */ currentCell?: any; /** Returns the previous selected cell element. - */ + */ previousRowCell?: any; /** Returns current record object (JSON). - */ + */ data?: any; /** Returns the selected row cell index values. - */ + */ selectedRowCellIndex?: any[]; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the grid model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface CellSelectingEventArgs { /** Returns the selected cell index value. - */ + */ cellIndex?: number; /** Returns the previous selected cell index value. - */ + */ previousRowCellIndex?: number; /** Returns the selected cell element. - */ + */ currentCell?: any; /** Returns the previous selected cell element. - */ + */ previousRowCell?: any; /** Returns current record object (JSON). - */ + */ data?: any; /** Returns whether the ctrl key is pressed while selecting cell - */ + */ isCtrlKeyPressed?: boolean; /** Returns whether the shift key is pressed while selecting cell - */ + */ isShiftKeyPressed?: boolean; /** Returns the grid model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface CellDeselectedEventArgs { /** Returns the deselected cell index value. - */ + */ cellIndex?: number; /** Returns the deselected cell element. - */ + */ currentCell?: any; /** Returns current record object (JSON). - */ + */ data?: any; /** Returns the grid model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface CellDeselectingEventArgs { /** Returns the deselecting cell index value. - */ + */ cellIndex?: number; /** Returns the deselecting cell element. - */ + */ currentCell?: any; /** Returns current record object (JSON). - */ + */ data?: any; /** Returns whether the ctrl key is pressed while deselecting cell - */ + */ isCtrlKeyPressed?: boolean; /** Returns whether the shift key is pressed while deselecting cell - */ + */ isShiftKeyPressed?: boolean; /** Returns the grid model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface ColumnDragEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns draggable element type. - */ + */ draggableType?: any; /** Returns the draggable column object. - */ + */ column?: any; /** Returns the grid model. - */ + */ model?: any; /** Returns target elements based on mouse move position. - */ + */ target?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface ColumnDragStartEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns draggable element type. - */ + */ draggableType?: any; /** Returns the draggable column object. - */ + */ column?: any; /** Returns the grid model. - */ + */ model?: any; /** Returns drag start element. - */ + */ target?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface ColumnDropEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns draggable element type. - */ + */ draggableType?: string; /** Returns the draggable column object. - */ + */ column?: any; /** Returns the grid model. - */ + */ model?: any; /** Returns dropped dragged element. - */ + */ target?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface RowDragEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns draggable element type. - */ + */ draggableType?: any; /** Returns the draggable row object. - */ + */ target?: any; /** Returns the grid model. - */ + */ model?: any; /** Returns target elements based on mouse move position. - */ + */ currentTarget?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns JSON data of dragged rows. - */ + */ data?: any; } export interface RowDragStartEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns draggable element type. - */ + */ draggableType?: any; /** Returns the draggable row object. - */ + */ target?: any; /** Returns the grid model. - */ + */ model?: any; /** Returns drag start element cell. - */ + */ currentTarget?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the JSON data of dragged rows. - */ + */ data?: any; } export interface RowDropEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns draggable element type. - */ + */ draggableType?: string; /** Returns the draggable row object. - */ + */ rows?: any; /** Returns the grid model. - */ + */ model?: any; /** Returns the current mouse position cell element. - */ + */ target?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the JSON data of dragged rows. - */ + */ data?: any; } export interface ColumnSelectedEventArgs { /** Returns the selected cell index value. - */ + */ columnIndex?: number; /** Returns the previous selected column index value. - */ + */ previousColumnIndex?: number; /** Returns the selected header cell element. - */ + */ headerCell?: any; /** Returns the previous selected header cell element. - */ + */ prevColumnHeaderCell?: any; /** Returns corresponding column object (JSON). - */ + */ column?: any; /** Returns the selected columns values. - */ + */ selectedColumnsIndex?: any[]; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the grid model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface ColumnSelectingEventArgs { /** Returns the selected column index value. - */ + */ columnIndex?: number; /** Returns the previous selected column index value. - */ + */ previousColumnIndex?: number; /** Returns the selected header cell element. - */ + */ headerCell?: any; /** Returns the previous selected header cell element. - */ + */ prevColumnHeaderCell?: any; /** Returns corresponding column object (JSON). - */ + */ column?: any; /** Returns whether the ctrl key is pressed while selecting cell - */ + */ isCtrlKeyPressed?: boolean; /** Returns whether the shift key is pressed while selecting cell - */ + */ isShiftKeyPressed?: boolean; /** Returns the grid model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface ColumnDeselectedEventArgs { /** Returns the Deselected column index value. - */ + */ columnIndex?: number; /** Returns the Deselected column header element. - */ + */ headerCell?: any; /** Returns corresponding column object (JSON). - */ + */ column?: any; /** Returns the grid model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface ColumnDeselectingEventArgs { /** Returns the deselecting column index value. - */ + */ columnIndex?: number; /** Returns the deselecting column header element. - */ + */ headerCell?: any; /** Returns corresponding column object (JSON). - */ + */ column?: any; /** Returns whether the ctrl key is pressed while deselecting column - */ + */ isCtrlKeyPressed?: boolean; /** Returns whether the shift key is pressed while deselecting column - */ + */ isShiftKeyPressed?: boolean; /** Returns the grid model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface ContextClickEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the current item. - */ + */ currentTarget?: any; /** Returns the grid model. - */ + */ model?: any; /** Returns the status of contextmenu item which denotes its enabled state - */ + */ status?: boolean; /** Returns the target item. - */ + */ target?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface ContextOpenEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the current item. - */ + */ currentTarget?: any; /** Returns the grid model. - */ + */ model?: any; /** Returns the status of contextmenu item which denotes its enabled state - */ + */ status?: boolean; /** Returns the target item. - */ + */ target?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface CreateEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the grid model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface DataBoundEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the grid model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface DestroyEventArgs { /** Returns the grid model. - */ + */ model?: any; /** Returns deleted data. - */ + */ data?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface DetailsCollapseEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns detail row element. - */ + */ detailsRow?: any; /** Returns master row of detail row record object (JSON). - */ + */ masterData?: any; /** Returns the foreign key record object (JSON). - */ + */ foreignKeyData?: any; /** Returns master row element. - */ + */ masterRow?: any; /** Returns the grid model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface DetailsDataBoundEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns details row element. - */ + */ detailsElement?: any; /** Returns the details row data. - */ + */ data?: any; /** Returns the grid model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface DetailsExpandEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns detail row element. - */ + */ detailsRow?: any; /** Returns master row of detail row record object (JSON). - */ + */ masterData?: any; /** Returns the foreign key record object (JSON). - */ + */ foreignKeyData?: any; /** Returns master row element. - */ + */ masterRow?: any; /** Returns the grid model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface EndAddEventArgs { /** Returns the grid model. - */ + */ model?: any; /** Returns added data. - */ + */ data?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface EndDeleteEventArgs { /** Returns the grid model. - */ + */ model?: any; /** Returns deleted data. - */ + */ data?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface EndEditEventArgs { /** Returns the grid model. - */ + */ model?: any; /** Returns modified data. - */ + */ data?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface LoadEventArgs { /** Returns the grid model. - */ + */ model?: any; /** Returns deleted data. - */ + */ data?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the name of the event. - */ + */ type?: string; } export interface MergeCellInfoEventArgs { /** Returns grid cell. - */ + */ cell?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns current row record object (JSON). - */ + */ data?: any; /** Returns the text value in the cell. - */ + */ text?: string; /** Returns the column object. - */ + */ column?: any; /** Method to merge Grid rows. - */ + */ rowMerge?: any; /** Method to merge Grid columns. - */ + */ colMerge?: any; /** Method to merge Grid rows and columns. - */ + */ merge?: any; /** Returns the grid model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface QueryCellInfoEventArgs { /** Returns grid cell. - */ + */ cell?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns current row record object (JSON). - */ + */ data?: any; /** Returns the text value in the cell. - */ + */ text?: string; /** Returns the column object. - */ + */ column?: any; /** Returns the foreign key record object (JSON). - */ + */ foreignKeyData?: any; /** Returns the grid model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface RecordClickEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns current record object (JSON). - */ + */ data?: any; /** Returns the row index of the selected row. - */ + */ rowIndex?: number; /** Returns the jQuery object of the current selected row. - */ + */ row?: any; /** Returns the current selected cell. - */ + */ cell?: any; /** Returns the grid model. - */ + */ model?: any; /** Returns the cell index value. - */ + */ cellIndex?: number; /** Returns the corresponding cell value. - */ + */ cellValue?: string; /** Returns the Header text of the column corresponding to the selected cell. - */ + */ columnName?: string; /** Returns the name of the event. - */ + */ type?: string; } export interface RecordDoubleClickEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns current record object (JSON). - */ + */ data?: any; /** Returns the row index of the selected row. - */ + */ rowIndex?: number; /** Returns the jQuery object of the current selected row. - */ + */ row?: any; /** Returns the current selected cell. - */ + */ cell?: any; /** Returns the grid model. - */ + */ model?: any; /** Returns the selected cell index value. - */ + */ cellIndex?: number; /** Returns the corresponding cell value. - */ + */ cellValue?: string; /** Returns the Header text of the column corresponding to the selected cell. - */ + */ columnName?: string; /** Returns the name of the event. - */ + */ type?: string; } export interface ResizedEventArgs { /** Returns the grid model. - */ + */ model?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns deleted data. - */ + */ data?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the column index. - */ + */ columnIndex?: number; /** Returns the column object. - */ + */ column?: any; /** Returns the grid object. - */ + */ target?: any; /** Returns the old width value. - */ + */ oldWidth?: number; /** Returns the new width value. - */ + */ newWidth?: number; } export interface ResizeEndEventArgs { /** Returns the grid model. - */ + */ model?: any; /** Returns deleted data. - */ + */ data?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the column index. - */ + */ columnIndex?: number; /** Returns the column object. - */ + */ column?: any; /** Returns the grid object. - */ + */ target?: any; /** Returns the old width value. - */ + */ oldWidth?: number; /** Returns the new width value. - */ + */ newWidth?: number; /** Returns the extra width value. - */ + */ extra?: number; } export interface ResizeStartEventArgs { /** Returns the grid model. - */ + */ model?: any; /** Returns deleted data. - */ + */ data?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the column index. - */ + */ columnIndex?: number; /** Returns the column object. - */ + */ column?: any; /** Returns the grid object. - */ + */ target?: any; /** Returns the old width value. - */ + */ oldWidth?: number; } export interface RightClickEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns current record object (JSON). - */ + */ currentData?: any; /** Returns the row index of the selected row. - */ + */ rowIndex?: number; /** Returns the current selected row. - */ + */ row?: any; /** Returns the selected row data object. - */ + */ data?: any; /** Returns the cell index of the selected cell. - */ + */ cellIndex?: number; /** Returns the cell value. - */ + */ cellValue?: string; /** Returns the cell object. - */ + */ cell?: any; /** Returns the grid model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface RowDataBoundEventArgs { /** Returns grid row. - */ + */ row?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns current row record object (JSON). - */ + */ data?: any; /** Returns the foreign key record object (JSON). - */ + */ foreignKeyData?: any; /** Returns the grid model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface RowSelectedEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns current record object (JSON). - */ + */ data?: any; /** Returns the foreign key record object (JSON). - */ + */ foreignKeyData?: any; /** Returns the row index of the selected row. - */ + */ rowIndex?: number; /** Returns the current selected row. - */ + */ row?: any; /** Returns the previous selected row element. - */ + */ prevRow?: any; /** Returns the previous selected row index. - */ + */ prevRowIndex?: number; /** Returns the grid model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface RowSelectingEventArgs { /** Returns the selected row index value. - */ + */ rowIndex?: number; /** Returns the selected row element. - */ + */ row?: any; /** Returns the previous selected row element. - */ + */ prevRow?: any; /** Returns the previous selected row index. - */ + */ prevRowIndex?: number; /** Returns current record object (JSON). - */ + */ data?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the grid model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface RowDeselectedEventArgs { /** Returns current record object (JSON). - */ + */ data?: any; /** Returns the row index of the deselected row. - */ + */ rowIndex?: number; /** Returns the current deselected row element. - */ + */ row?: any; /** Returns the grid model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface RowDeselectingEventArgs { /** Returns the deselecting row index value. - */ + */ rowIndex?: number; /** Returns the deselecting row element. - */ + */ row?: any; /** Returns current record object (JSON). - */ + */ data?: any; /** Returns whether the ctrl key is pressed while deselecting row - */ + */ isCtrlKeyPressed?: boolean; /** Returns whether the shift key is pressed while deselecting row - */ + */ isShiftKeyPressed?: boolean; /** Returns the grid model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface TemplateRefreshEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the cell object. - */ + */ cell?: any; /** Returns the column object. - */ + */ column?: any; /** Returns the current row data. - */ + */ data?: any; /** Returns the grid model. - */ + */ model?: any; /** Returns the current row index. - */ + */ rowIndex?: number; /** Returns the name of the event. - */ + */ type?: string; } export interface ToolbarClickEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the current item. - */ + */ currentTarget?: any; /** Returns the grid model. - */ + */ model?: any; /** Returns the status of toolbar item which denotes its enabled state - */ + */ status?: boolean; /** Returns the target item. - */ + */ target?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the grid model. - */ + */ gridModel?: any; /** Returns the toolbar object of the selected toolbar element. - */ + */ toolbarData?: any; /** Returns the Id of the current toolbar element. - */ + */ itemId?: string; /** Returns the index of the current toolbar element. - */ + */ itemIndex?: number; /** Returns the name of the current toolbar element. - */ + */ itemName?: string; } export interface ColumnsCommand { /** Gets or sets an object that indicates to define all the button options which are available in ejButton. - */ + */ buttonOptions?: any; /** Gets or sets a value that indicates to add the command column button. See unboundType - */ + */ type?: ej.Grid.UnboundType|string; } export interface Column { /** Sets the clip mode for Grid cell as ellipsis or clipped content(both header and content) - * @Default {ej.Grid.ClipMode.Clip} - */ + * @Default {ej.Grid.ClipMode.Clip} + */ clipMode?: ej.Grid.ClipMode|string; /** Gets or sets a value that indicates whether to enable editing behavior for particular column. - * @Default {true} - */ + * @Default {true} + */ allowEditing?: boolean; /** Gets or sets a value that indicates whether to enable dynamic filtering behavior for particular column. - * @Default {true} - */ + * @Default {true} + */ allowFiltering?: boolean; /** Gets or sets a value that indicates whether to enable dynamic grouping behavior for particular column. - * @Default {true} - */ + * @Default {true} + */ allowGrouping?: boolean; /** Gets or sets a value that indicates whether to enable dynamic sorting behavior for particular column. - * @Default {true} - */ + * @Default {true} + */ allowSorting?: boolean; /** Gets or sets a value that indicates whether to enable dynamic resizable for particular column. - * @Default {true} - */ + * @Default {true} + */ allowResizing?: boolean; /** Gets or sets an object that indicates to define a command column in the grid. - * @Default {[]} - */ + * @Default {[]} + */ commands?: ColumnsCommand[]; /** Gets or sets a value that indicates to provide custom CSS for an individual column. - */ + */ cssClass?: string; /** Gets or sets a value that indicates the attribute values to the td element of a particular column - */ + */ customAttributes?: any; /** Gets or sets a value that indicates to bind the external datasource to the particular column when column editType as dropdownedit and also it is used to bind the datasource - * to the foreign key column while editing the grid. //Where data is array of JSON objects of text and value for the drop-down and array of JSON objects for foreign key column. - * @Default {null} - */ + * to the foreign key column while editing the grid. //Where data is array of JSON objects of text and value for the drop-down and array of JSON objects for foreign key column. + * @Default {null} + */ dataSource?: any[]; /** Gets or sets a value that indicates to display the specified default value while adding a new record to the grid - */ + */ defaultValue?: string|number|boolean|Date; /** Gets or sets a value that indicates to render the grid content and header with an HTML elements - * @Default {false} - */ + * @Default {false} + */ disableHtmlEncode?: boolean; /** Gets or sets a value that indicates to display a column value as checkbox or string - * @Default {true} - */ + * @Default {true} + */ displayAsCheckBox?: boolean; /** Gets or sets a value that indicates to customize ejNumericTextbox of an editable column. See editingType - */ + */ editParams?: any; /** Gets or sets a template that displays a custom editor used to edit column values. See editTemplate - * @Default {null} - */ + * @Default {null} + */ editTemplate?: any; /** Gets or sets a value that indicates to render the element(based on edit type) for editing the grid record. See editingType - * @Default {ej.Grid.EditingType.String} - */ + * @Default {ej.Grid.EditingType.String} + */ editType?: ej.Grid.EditingType|string; /** Gets or sets a value that indicates to groups the column based on its column format. - * @Default {false} - */ + * @Default {false} + */ enableGroupByFormat?: boolean; /** Gets or sets a value that indicates to display the columns in the grid mapping with column name of the dataSource. - */ + */ field?: string; /** Gets or sets a template that customize the filter control from default . See filterBarTemplate - * @Default {null} - */ + * @Default {null} + */ filterBarTemplate?: any; /** Gets or sets a value that indicates to render the excel or menu filter dialog to the grid columns. See filterType - * @Default {null} - */ + * @Default {null} + */ filterType?: ej.Grid.FilterType|string; /** Gets or sets a value that indicates to define foreign key field name of the grid datasource. - * @Default {null} - */ + * @Default {null} + */ foreignKeyField?: string; /** Gets or sets a value that indicates to bind the field which is in foreign column datasource based on the foreignKeyField - * @Default {null} - */ + * @Default {null} + */ foreignKeyValue?: string; /** Gets or sets a value that indicates the format for the text applied on the column - */ + */ format?: string; /** Gets or sets a value that indicates to add the template within the header element of the particular column. - * @Default {null} - */ + * @Default {null} + */ headerTemplateID?: string; /** Gets or sets a value that indicates to display the title of that particular column. - */ + */ headerText?: string; /** This defines the text alignment of a particular column header cell value. See headerTextAlign - * @Default {null} - */ + * @Default {null} + */ headerTextAlign?: ej.TextAlign|string; /** It accepts the string value and shows the tooltip for the Grid column header. - * @Default {null} - */ + * @Default {null} + */ headerTooltip?: string; /** You can use this property to freeze selected columns in grid at the time of scrolling. - * @Default {false} - */ + * @Default {false} + */ isFrozen?: boolean; /** Gets or sets a value that indicates the column has an identity in the database. - * @Default {false} - */ + * @Default {false} + */ isIdentity?: boolean; /** Gets or sets a value that indicates the column is act as a primary key(read-only) of the grid. The editing is performed based on the primary key column - * @Default {false} - */ + * @Default {false} + */ isPrimaryKey?: boolean; /** Gets or sets a value that indicates the order of Column that are to be hidden or visible when Grid element is in responsive mode and could not occupy all columns. - * @Default {-1} - */ + * @Default {-1} + */ priority?: number; /** Used to hide the particular column in column chooser by giving value as false. - * @Default {true} - */ + * @Default {true} + */ showInColumnChooser?: boolean; /** Gets or sets a value that indicates whether to enables column template for a particular column. - * @Default {false} - */ + * @Default {false} + */ template?: boolean|string; /** Gets or sets a value that indicates to align the text within the column. See textAlign - * @Default {ej.TextAlign.Left} - */ + * @Default {ej.TextAlign.Left} + */ textAlign?: ej.TextAlign|string; /** Sets the template for Tooltip in Grid Columns(both header and content) - */ + */ tooltip?: string; /** Gets or sets a value that indicates to specify the data type of the specified columns. - */ + */ type?: string; /** Gets or sets a value that indicates to define constraints for saving data to the database. - */ + */ validationRules?: any; /** Gets or sets a value that indicates whether this column is visible in the grid. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Gets or sets a value that indicates to define the width for a particular column in the grid. - */ + */ width?: number; } export interface ContextMenuSettingsSubContextMenu { /** Used to get or set the corresponding custom context menu item to which the submenu to be appended. - * @Default {null} - */ + * @Default {null} + */ contextMenuItem?: string; /** Used to get or set the sub menu items to the custom context menu item. - * @Default {[]} - */ + * @Default {[]} + */ subMenu?: any[]; } export interface ContextMenuSettings { /** Gets or sets a value that indicates whether to add the default context menu actions as a context menu items If enableContextMenu is true it will show all the items related to the target, - * if you want selected items from contextmenu you have to mention in the contextMenuItems - * @Default {[]} - */ + * if you want selected items from contextmenu you have to mention in the contextMenuItems + * @Default {[]} + */ contextMenuItems?: any[]; /** Gets or sets a value that indicates whether to add custom contextMenu items within the toolbar to perform any action in the grid - * @Default {[]} - */ + * @Default {[]} + */ customContextMenuItems?: any[]; /** Gets or sets a value that indicates whether to enable the context menu action in the grid. - * @Default {false} - */ + * @Default {false} + */ enableContextMenu?: boolean; /** Used to get or set the subMenu to the corresponding custom context menu item. - */ + */ subContextMenu?: ContextMenuSettingsSubContextMenu[]; /** Gets or sets a value that indicates whether to disable the default context menu items in the grid. - * @Default {false} - */ + * @Default {false} + */ disableDefaultItems?: boolean; } export interface EditSettings { /** Gets or sets a value that indicates whether to enable insert action in the editing mode. - * @Default {false} - */ + * @Default {false} + */ allowAdding?: boolean; /** Gets or sets a value that indicates whether to enable the delete action in the editing mode. - * @Default {false} - */ + * @Default {false} + */ allowDeleting?: boolean; /** Gets or sets a value that indicates whether to enable the edit action in the editing mode. - * @Default {false} - */ + * @Default {false} + */ allowEditing?: boolean; /** Gets or sets a value that indicates whether to enable the editing action while double click on the record - * @Default {true} - */ + * @Default {true} + */ allowEditOnDblClick?: boolean; /** This specifies the id of the template. This template can be used to display the data that you require to be edited using the Dialog Box - * @Default {null} - */ + * @Default {null} + */ dialogEditorTemplateID?: string; /** Gets or sets a value that indicates whether to define the mode of editing See editMode - * @Default {ej.Grid.EditMode.Normal} - */ + * @Default {ej.Grid.EditMode.Normal} + */ editMode?: ej.Grid.EditMode|string; /** This specifies the id of the template. This template can be used to display the data that you require to be edited using the External edit form - * @Default {null} - */ + * @Default {null} + */ externalFormTemplateID?: string; /** This specifies to set the position of an External edit form either in the top-right or bottom-left of the grid - * @Default {ej.Grid.FormPosition.BottomLeft} - */ + * @Default {ej.Grid.FormPosition.BottomLeft} + */ formPosition?: ej.Grid.FormPosition|string; /** This specifies the id of the template. This template can be used to display the data that you require to be edited using the Inline edit form - * @Default {null} - */ + * @Default {null} + */ inlineFormTemplateID?: string; /** This specifies to set the position of an adding new row either in the top or bottom of the grid - * @Default {ej.Grid.RowPosition.Top} - */ + * @Default {ej.Grid.RowPosition.Top} + */ rowPosition?: ej.Grid.RowPosition|string; /** Gets or sets a value that indicates whether the confirm dialog has to be shown while saving or discarding the batch changes - * @Default {true} - */ + * @Default {true} + */ showConfirmDialog?: boolean; /** Gets or sets a value that indicates whether the confirm dialog has to be shown while deleting record - * @Default {false} - */ + * @Default {false} + */ showDeleteConfirmDialog?: boolean; /** Gets or sets a value that indicates whether the title for edit form is different from the primarykey column. - * @Default {null} - */ + * @Default {null} + */ titleColumn?: string; /** Gets or sets a value that indicates whether to display the add new form by default in the grid. - * @Default {false} - */ + * @Default {false} + */ showAddNewRow?: boolean; } export interface FilterSettingsFilteredColumn { /** Gets or sets a value that indicates whether to define the field name of the column to be filter. - */ + */ field?: string; /** Gets or sets a value that indicates whether to define the matchCase of given value to be filter. - */ + */ matchCase?: boolean; /** Gets or sets a value that indicates whether to define the filter condition to filtered column. See operator - */ + */ operator?: ej.FilterOperators|string; /** Gets or sets a value that indicates whether to define the predicate as and/or. - */ + */ predicate?: string; /** Gets or sets a value that indicates whether to define the value to be filtered in a column. - */ + */ value?: string|number; } export interface FilterSettings { /** Gets or sets a value that indicates to perform the filter operation with case sensitive in excel styled filter menu mode - * @Default {false} - */ + * @Default {false} + */ enableCaseSensitivity?: boolean; /** Gets or sets a value that indicates to define the interDeterminateState of checkbox in excel filter dialog. - * @Default {true} - */ + * @Default {true} + */ enableInterDeterminateState?: boolean; /** This specifies the grid to starts the filter action while typing in the filterBar or after pressing the enter key. based on the filterBarMode. See filterBarMode. - * @Default {ej.Grid.FilterBarMode.Immediate} - */ + * @Default {ej.Grid.FilterBarMode.Immediate} + */ filterBarMode?: ej.Grid.FilterBarMode|string; /** Gets or sets a value that indicates whether to define the filtered columns details programmatically at initial load - * @Default {[]} - */ + * @Default {[]} + */ filteredColumns?: FilterSettingsFilteredColumn[]; /** This specifies the grid to show the filterBar or filterMenu to the grid records. See filterType - * @Default {ej.Grid.FilterType.FilterBar} - */ + * @Default {ej.Grid.FilterType.FilterBar} + */ filterType?: ej.Grid.FilterType|string; /** This specifies the grid to delay the filter action while typing in the filterBar. - * @Default {1500} - */ + * @Default {1500} + */ immediateModeDelay?: number; /** Gets or sets a value that indicates the maximum number of filter choices that can be showed in the excel styled filter menu. - * @Default {1000} - */ + * @Default {1000} + */ maxFilterChoices?: number; /** This specifies the grid to show the filter text within the grid pager itself. - * @Default {true} - */ + * @Default {true} + */ showFilterBarMessage?: boolean; /** Gets or sets a value that indicates whether to enable the predicate options in the filtering menu - * @Default {false} - */ + * @Default {false} + */ showPredicate?: boolean; } export interface GroupSettings { /** Gets or sets a value that customize the group caption format. - * @Default {null} - */ + * @Default {null} + */ captionFormat?: string; /** Gets or sets a value that indicates whether to enable animation button option in the group drop area of the grid. - * @Default {false} - */ + * @Default {false} + */ enableDropAreaAutoSizing?: boolean; /** Gets or sets a value that indicates whether to add grouped columns programmatically at initial load - * @Default {[]} - */ + * @Default {[]} + */ groupedColumns?: any[]; /** Gets or sets a value that indicates whether to show the group drop area just above the column header. It can be used to avoid ungrouping the already grouped column using groupSettings. - * @Default {true} - */ + * @Default {true} + */ showDropArea?: boolean; /** Gets or sets a value that indicates whether to hide the grouped columns from the grid - * @Default {false} - */ + * @Default {false} + */ showGroupedColumn?: boolean; /** Gets or sets a value that indicates whether to show the group button image(toggle button)in the column header and also in the grouped column in the group drop area. - * It can be used to group/ungroup the columns by click on the toggle button. - * @Default {false} - */ + * It can be used to group/ungroup the columns by click on the toggle button. + * @Default {false} + */ showToggleButton?: boolean; /** Gets or sets a value that indicates whether to enable the close button in the grouped column which is in the group drop area to ungroup the grouped column - * @Default {false} - */ + * @Default {false} + */ showUngroupButton?: boolean; } export interface PageSettings { /** Gets or sets a value that indicates whether to define which page to display currently in the grid - * @Default {1} - */ + * @Default {1} + */ currentPage?: number; /** Gets or sets a value that indicates whether to pass the current page information as a query string along with the URL while navigating to other page. - * @Default {false} - */ + * @Default {false} + */ enableQueryString?: boolean; /** Gets or sets a value that indicates whether to enables pager template for the grid. - * @Default {false} - */ + * @Default {false} + */ enableTemplates?: boolean; /** Gets or sets a value that indicates whether to define the number of pages displayed in the pager for navigation - * @Default {8} - */ + * @Default {8} + */ pageCount?: number; /** Gets or sets a value that indicates whether to define the number of records displayed per page - * @Default {12} - */ + * @Default {12} + */ pageSize?: number; /** Gets or sets a value that indicates whether to enables default pager for the grid. - * @Default {false} - */ + * @Default {false} + */ showDefaults?: boolean; /** Gets or sets a value that indicates to add the template as a pager template for grid. - * @Default {null} - */ + * @Default {null} + */ template?: string; /** Get the value of total number of pages in the grid. The totalPages value is calculated based on page size and total records of grid - * @Default {null} - */ + * @Default {null} + */ totalPages?: number; /** Get the value of total number of records which is bound to the grid. The totalRecordsCount value is calculated based on dataSource bound to the grid. - * @Default {null} - */ + * @Default {null} + */ totalRecordsCount?: number; /** Gets or sets a value that indicates whether to define the number of pages to print - * @Default {ej.Grid.PrintMode.AllPages} - */ + * @Default {ej.Grid.PrintMode.AllPages} + */ printMode?: ej.Grid.PrintMode|string; } export interface ResizeSettings { /** Gets or sets a value that indicates whether to define the mode of resizing. - * @Default {ej.Grid.ResizeMode.Normal} - */ + * @Default {ej.Grid.ResizeMode.Normal} + */ resizeMode?: ej.Grid.ResizeMode|string; } export interface RowDropSettings { /** This specifies the grid to drop the grid rows only at particular target element. - * @Default {null} - */ + * @Default {null} + */ dropTargetID?: any; /** This helps in mapping server-side action when rows are dragged from Grid. - * @Default {null} - */ + * @Default {null} + */ dragMapper?: string; /** This helps in mapping server-side action when rows are dropped in Grid. - * @Default {null} - */ + * @Default {null} + */ dropMapper?: string; } export interface SearchSettings { /** This specify the grid to search for the value in particular columns that is mentioned in the field. - * @Default {[]} - */ + * @Default {[]} + */ fields?: any; /** This specifies the grid to search the particular data that is mentioned in the key. - */ + */ key?: string; /** It specifies the grid to search the records based on operator. - * @Default {contains} - */ + * @Default {contains} + */ operator?: string; /** It enables or disables case-sensitivity while searching the search key in grid. - * @Default {true} - */ + * @Default {true} + */ ignoreCase?: boolean; } export interface SelectionSettings { /** Gets or sets a value that indicates the cell selection actions based on the cell selection mode. - * @Default {flow} - */ + * @Default {flow} + */ cellSelectionMode?: string; /** Gets or sets a value that indicates whether to enable the toggle selection behavior for row, cell and column. - * @Default {false} - */ + * @Default {false} + */ enableToggle?: boolean; /** Gets or sets a value that indicates whether to add the default selection actions as a selection mode.See selectionMode - * @Default {[row]} - */ + * @Default {[row]} + */ selectionMode?: any[]; } export interface ScrollSettings { /** This specify the grid to to view data that you require without buffering the entire load of a huge database - * @Default {false} - */ + * @Default {false} + */ allowVirtualScrolling?: boolean; /** It accepts the boolean value and shows or hides the scrollbar while focus in or focus out of the Grid. - * @Default {false} - */ + * @Default {false} + */ autoHide?: boolean; /** Specifies the height and width of button in the scrollbar. - * @Default {18} - */ + * @Default {18} + */ buttonSize?: number; /** This specify the grid to enable/disable touch control for scrolling. - * @Default {true} - */ + * @Default {true} + */ enableTouchScroll?: boolean; /** This specify the grid to freeze particular columns at the time of scrolling. - * @Default {0} - */ + * @Default {0} + */ frozenColumns?: number; /** This specify the grid to freeze particular rows at the time of scrolling. - * @Default {0} - */ + * @Default {0} + */ frozenRows?: number; /** This specify the grid to show the vertical scroll bar, to scroll and view the grid contents. - * @Default {0} - */ + * @Default {0} + */ height?: string|number; /** It accepts the integer value and sets the width of scrollbar. - * @Default {18} - */ + * @Default {18} + */ scrollerSize?: number; /** This is used to define the mode of virtual scrolling in grid. See virtualScrollMode - * @Default {ej.Grid.VirtualScrollMode.Normal} - */ + * @Default {ej.Grid.VirtualScrollMode.Normal} + */ virtualScrollMode?: ej.Grid.VirtualScrollMode|string; /** This is used to enable the enhanced virtual scrolling in Grid. - * @Default {false} - */ + * @Default {false} + */ enableVirtualization?: boolean; /** This specify the grid to show the horizontal scroll bar, to scroll and view the grid contents - * @Default {250} - */ + * @Default {250} + */ width?: string|number; /** This specify the scroll down pixel of mouse wheel, to scroll mouse wheel and view the grid contents. - * @Default {57} - */ + * @Default {57} + */ scrollOneStepBy?: number; } export interface SortSettingsSortedColumn { /** Gets or sets a value that indicates whether to define the direction to sort the column. - */ + */ direction?: string; /** Gets or sets a value that indicates whether to define the field name of the column to be sort - */ + */ field?: string; } export interface SortSettings { /** Gets or sets a value that indicates whether to define the direction and field to sort the column. - */ + */ sortedColumns?: SortSettingsSortedColumn[]; } export interface StackedHeaderRowsStackedHeaderColumn { /** Gets or sets a value that indicates the header text for the particular stacked header column. - * @Default {null} - */ + * @Default {null} + */ column?: any; /** Gets or sets a value that indicates class to the corresponding stackedHeaderColumn. - * @Default {null} - */ + * @Default {null} + */ cssClass?: string; /** Gets or sets a value that indicates the header text for the particular stacked header column. - * @Default {null} - */ + * @Default {null} + */ headerText?: string; /** Gets or sets a value that indicates the text alignment of the corresponding headerText. - * @Default {ej.TextAlign.Left} - */ + * @Default {ej.TextAlign.Left} + */ textAlign?: string; /** Sets the template for tooltip for the Grid stackedHeaderColumns. - * @Default {null} - */ + * @Default {null} + */ tooltip?: string; } export interface StackedHeaderRow { /** Gets or sets a value that indicates whether to add stacked header columns into the stacked header rows - * @Default {[]} - */ + * @Default {[]} + */ stackedHeaderColumns?: StackedHeaderRowsStackedHeaderColumn[]; } export interface SummaryRowsSummaryColumn { /** Gets or sets a value that indicates the text displayed in the summary column as a value - * @Default {null} - */ + * @Default {null} + */ customSummaryValue?: string; /** This specifies summary column used to perform the summary calculation - * @Default {null} - */ + * @Default {null} + */ dataMember?: string; /** Gets or sets a value that indicates to define the target column at which to display the summary. - * @Default {null} - */ + * @Default {null} + */ displayColumn?: string; /** Gets or sets a value that indicates the format for the text applied on the column - * @Default {null} - */ + * @Default {null} + */ format?: string; /** Gets or sets a value that indicates the text displayed before the summary column value - * @Default {null} - */ + * @Default {null} + */ prefix?: string; /** Gets or sets a value that indicates the text displayed after the summary column value - * @Default {null} - */ + * @Default {null} + */ suffix?: string; /** Gets or sets a value that indicates the type of calculations to be performed for the corresponding summary column - * @Default {[]} - */ + * @Default {[]} + */ summaryType?: ej.Grid.SummaryType|string; /** Gets or sets a value that indicates to add the template for the summary value of dataMember given. - * @Default {null} - */ + * @Default {null} + */ template?: string; } export interface SummaryRow { /** Gets or sets a value that indicates whether to show the summary value within the group caption area for the corresponding summary column while grouping the column - * @Default {false} - */ + * @Default {false} + */ showCaptionSummary?: boolean; /** Gets or sets a value that indicates whether to show the group summary value for the corresponding summary column while grouping a column - * @Default {false} - */ + * @Default {false} + */ showGroupSummary?: boolean; /** Gets or sets a value that indicates whether to show the total summary value the for the corresponding summary column. The summary row is added after the grid content. - * @Default {true} - */ + * @Default {true} + */ showTotalSummary?: boolean; /** Gets or sets a value that indicates whether to add summary columns into the summary rows. - * @Default {[]} - */ + * @Default {[]} + */ summaryColumns?: SummaryRowsSummaryColumn[]; /** This specifies the grid to show the title for the summary rows. - */ + */ title?: string; /** This specifies the grid to show the title of summary row in the specified column. - * @Default {null} - */ + * @Default {null} + */ titleColumn?: string; } export interface TextWrapSettings { /** This specifies the grid to apply the auto wrap for grid content or header or both. - * @Default {ej.Grid.WrapMode.Both} - */ + * @Default {ej.Grid.WrapMode.Both} + */ wrapMode?: ej.Grid.WrapMode|string; } export interface ToolbarSettings { /** Gets or sets a value that indicates whether to add custom toolbar items within the toolbar to perform any action in the grid - * @Default {[]} - */ + * @Default {[]} + */ customToolbarItems?: any[]; /** Gets or sets a value that indicates whether to enable toolbar in the grid. - * @Default {false} - */ + * @Default {false} + */ showToolbar?: boolean; /** Gets or sets a value that indicates whether to add the default editing actions as a toolbar items - * @Default {[]} - */ + * @Default {[]} + */ toolbarItems?: Array; } @@ -25003,8 +25003,8 @@ class Sparkline extends ej.Widget { defaults: Sparkline.Model; /** Redraws the entire sparkline. You can call this method whenever you update, add or remove points from the data source or whenever you want to refresh the UI. - * @returns {void} - */ + * @returns {void} + */ redraw(): void; } export namespace Sparkline { @@ -25012,121 +25012,121 @@ export namespace Sparkline { export interface Model { /** Background color of the plot area. - * @Default {transparent} - */ + * @Default {transparent} + */ background?: string; /** Fill color for the sparkline series. - * @Default {#33ccff} - */ + * @Default {#33ccff} + */ fill?: string; /** Border color of the series. - * @Default {null} - */ + * @Default {null} + */ stroke?: string; /** Options for customizing the color, opacity and width of the sparkline border. - */ + */ border?: Border; /** Border width of the series. - * @Default {1} - */ + * @Default {1} + */ width?: number; /** Opacity of the series. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Color for series high point. - * @Default {null} - */ + * @Default {null} + */ highPointColor?: string; /** Color for series low point. - * @Default {null} - */ + * @Default {null} + */ lowPointColor?: string; /** Color for series start point. - * @Default {null} - */ + * @Default {null} + */ startPointColor?: string; /** Color for series end point. - * @Default {null} - */ + * @Default {null} + */ endPointColor?: string; /** Color for series negative point. - * @Default {null} - */ + * @Default {null} + */ negativePointColor?: string; /** Options for customizing the color, opacity of the sparkline start and end range. - */ + */ rangeBandSettings?: RangeBandSettings; /** Name of a field in data source, where the fill color for all the data points is generated. - */ + */ palette?: string; /** Controls whether sparkline has to be responsive or not. - * @Default {true} - */ + * @Default {true} + */ isResponsive?: boolean; /** Controls whether Sparkline has to be rendered as Canvas or SVG.Canvas rendering supports all functionalities in SVG rendering. - * @Default {false} - */ + * @Default {false} + */ enableCanvasRendering?: boolean; /** Specifies the dataSource for the series. It can be an array of JSON objects or an instance of ej.DataManager. - * @Default {null} - */ + * @Default {null} + */ dataSource?: any; /** Name of the property in the datasource that contains x value for the series. - * @Default {null} - */ + * @Default {null} + */ xName?: string; /** Name of the property in the datasource that contains y value for the series. - * @Default {null} - */ + * @Default {null} + */ yName?: string; /** Gap or padding for sparkline. - * @Default {8} - */ + * @Default {8} + */ padding?: number; /** Specifies the type of the series to render in sparkline. - * @Default {line. See Type} - */ + * @Default {line. See Type} + */ type?: ej.datavisualization.Sparkline.Type|string; /** Specifies the theme for Sparkline. - * @Default {Flatlight. See Theme} - */ + * @Default {Flatlight. See Theme} + */ theme?: ej.datavisualization.Sparkline.Theme|string; /** Options to customize the tooltip. - */ + */ tooltip?: Tooltip; /** Options for displaying and customizing marker for a data point. - */ + */ markerSettings?: MarkerSettings; /** Options to customize the Sparkline size. - */ + */ size?: Size; /** Options for customizing the color,dashArray and width of the axisLine. - */ + */ axisLineSettings?: AxisLineSettings; /** Fires before loading the sparkline. */ @@ -25157,372 +25157,372 @@ export interface Model { export interface LoadEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sparkline model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface LoadedEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sparkline model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface TooltipInitializeEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sparkline model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** X Location of the trackball tooltip in pixels - */ + */ locationX?: any; /** Y Location of the trackball tooltip in pixels - */ + */ locationY?: any; /** Index of the point for which trackball tooltip is displayed - */ + */ pointIndex?: number; /** Text to be displayed in trackball tooltip. Use this option to add custom text in trackball tooltip - */ + */ currentText?: string; } export interface SeriesRenderingEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sparkline model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** Minimum x value of the data point - */ + */ minX?: any; /** Minimum y value of the data point - */ + */ minY?: any; /** Maximum x value of the data point - */ + */ maxX?: any; /** Maximum y value of the data point - */ + */ maxY?: any; } export interface PointRegionMouseMoveEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sparkline model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** X-coordinate of point in pixel - */ + */ locationX?: number; /** Y-coordinate of point in pixel - */ + */ locationY?: number; /** Index of the point in series - */ + */ pointIndex?: number; /** Type of the series - */ + */ seriesType?: string; } export interface PointRegionMouseClickEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sparkline model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** X-coordinate of point in pixel - */ + */ locationX?: number; /** Y-coordinate of point in pixel - */ + */ locationY?: number; /** Index of the point in series - */ + */ pointIndex?: number; /** Type of the series - */ + */ seriesType?: string; } export interface SparklineMouseMoveEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sparkline model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface SparklineMouseLeaveEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sparkline model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface Border { /** Border color of the sparkline. - * @Default {transparent} - */ + * @Default {transparent} + */ color?: string; /** Width of the Sparkline border. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface RangeBandSettings { /** Start value of the range band. - * @Default {null} - */ + * @Default {null} + */ startRange?: number; /** End value of the range band. - * @Default {null} - */ + * @Default {null} + */ endRange?: number; /** Range band opacity of the series. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Range band color of the series. - * @Default {transparent} - */ + * @Default {transparent} + */ color?: string; } export interface TooltipBorder { /** Border color of the tooltip. - * @Default {transparent} - */ + * @Default {transparent} + */ color?: string; /** Border width of the tooltip. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface TooltipFont { /** Font color of the text in the tooltip. - * @Default {#111111} - */ + * @Default {#111111} + */ color?: string; /** Font Family for the tooltip. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Specifies the font Style for the tooltip. - * @Default {Normal} - */ + * @Default {Normal} + */ fontStyle?: ej.datavisualization.Sparkline.FontStyle|string; /** Specifies the font weight for the tooltip. - * @Default {Regular} - */ + * @Default {Regular} + */ fontWeight?: ej.datavisualization.Sparkline.FontWeight|string; /** Opacity for text in the tooltip. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font size for text in the tooltip. - * @Default {8px} - */ + * @Default {8px} + */ size?: string; } export interface Tooltip { /** Show/hides the tooltip visibility. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; /** Fill color for the sparkline tooltip. - * @Default {white} - */ + * @Default {white} + */ fill?: string; /** Custom template to the tooltip. - */ + */ template?: string; /** Options for customizing the border of the tooltip. - */ + */ border?: TooltipBorder; /** Options for customizing the font of the tooltip. - */ + */ font?: TooltipFont; } export interface MarkerSettingsBorder { /** Border color of the marker shape. - * @Default {transparent} - */ + * @Default {transparent} + */ color?: string; /** Controls the opacity of the marker border. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Border width of the marker shape. - * @Default {null} - */ + * @Default {null} + */ width?: number; } export interface MarkerSettings { /** Controls the opacity of the marker. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Controls the visibility of the marker shape. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; /** width of the marker shape. - * @Default {2} - */ + * @Default {2} + */ width?: number; /** Color of the marker shape. - * @Default {white} - */ + * @Default {white} + */ fill?: string; /** Options for customizing the border of the marker shape. - */ + */ border?: MarkerSettingsBorder; } export interface Size { /** Height of the Sparkline. Height can be specified in either pixel or percentage. - * @Default {''} - */ + * @Default {''} + */ height?: string; /** Width of the Sparkline. Width can be specified in either pixel or percentage. - * @Default {''} - */ + * @Default {''} + */ width?: string; } export interface AxisLineSettings { /** Controls the visibility of the axis. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; /** Color of the axis line. - * @Default {'#111111'} - */ + * @Default {'#111111'} + */ color?: string; /** Width of the axis line. - * @Default {1} - */ + * @Default {1} + */ width?: number; /** Dash array of the axis line. - * @Default {1} - */ + * @Default {1} + */ dashArray?: number; } } @@ -25591,13 +25591,13 @@ class SunburstChart extends ej.Widget { defaults: SunburstChart.Model; /** Redraws the entire sunburst. You can call this method whenever you update, add or remove points from the data source or whenever you want to refresh the UI. - * @returns {void} - */ + * @returns {void} + */ redraw(): void; /** destroy the sunburst - * @returns {void} - */ + * @returns {void} + */ _destroy(): void; } export namespace SunburstChart { @@ -25605,141 +25605,141 @@ export namespace SunburstChart { export interface Model { /** Background color of the plot area. - * @Default {null} - */ + * @Default {null} + */ background?: string; /** Bind the data field from the data source. - * @Default {null} - */ + * @Default {null} + */ valueMemberPath?: string; /** Options for customizing the sunburst border. - */ + */ border?: Border; /** Options for customizing the sunburst segment border. - */ + */ segmentBorder?: SegmentBorder; /** Specifies the dataSource to the sunburst. - * @Default {null} - */ + * @Default {null} + */ dataSource?: any; /** Palette color for the data points. - * @Default {null} - */ + * @Default {null} + */ palette?: string; /** Parent node of the data points. - * @Default {null} - */ + * @Default {null} + */ parentNode?: string; /** Name of the property in the datasource that contains x values. - * @Default {null} - */ + * @Default {null} + */ xName?: string; /** Name of the property in the datasource that contains y values. - * @Default {null} - */ + * @Default {null} + */ yName?: string; /** Controls whether sunburst has to be responsive or not. - * @Default {true} - */ + * @Default {true} + */ isResponsive?: boolean; /** Options to customize the Sunburst size. - */ + */ size?: Size; /** Controls the visibility of sunburst. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Options to customize the Sunburst tooltip. - */ + */ tooltip?: Tooltip; /** Options for customizing sunburst points. - */ + */ points?: Points; /** Sunburst rendering will start from the specified value - * @Default {null} - */ + * @Default {null} + */ startAngle?: number; /** Sunburst rendering will end at the specified value - * @Default {null} - */ + * @Default {null} + */ endAngle?: number; /** Sunburst outer radius value - * @Default {1} - */ + * @Default {1} + */ radius?: number; /** Sunburst inner radius value - * @Default {0.4} - */ + * @Default {0.4} + */ innerRadius?: number; /** Options to customize the Sunburst dataLabel. - */ + */ dataLabelSettings?: DataLabelSettings; /** Options for customizing the title and subtitle of sunburst. - */ + */ title?: Title; /** Options for customizing the appearance of the levels or point while highlighting. - */ + */ highlightSettings?: HighlightSettings; /** Options for customizing the appearance of the levels or data point while selection. - */ + */ selectionSettings?: SelectionSettings; /** Specify levels of sunburst for grouped visualization of data - * @Default {[]} - */ + * @Default {[]} + */ levels?: Level[]; /** Options to customize the legend items and legend title. - */ + */ legend?: Legend; /** Specifies the theme for Sunburst. - * @Default {Flatlight. See Theme} - */ + * @Default {Flatlight. See Theme} + */ theme?: ej.datavisualization.Sunburst.SunburstTheme|string; /** Options to customize the left, right, top and bottom margins of sunburst area. - */ + */ margin?: Margin; /** Enable/disable the animation for all the levels. - * @Default {false} - */ + * @Default {false} + */ enableAnimation?: boolean; /** Opacity of the levels. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Options for enable zooming feature of chart. - */ + */ zoomSettings?: ZoomSettings; /** Animation type of sunburst - * @Default {rotation. See Alignment} - */ + * @Default {rotation. See Alignment} + */ animationType?: ej.datavisualization.Sunburst.Animation|string; /** Fires before loading. */ @@ -25782,820 +25782,820 @@ export interface Model { export interface LoadEventArgs { /** Load event data - */ + */ data?: string; /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sunburst model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface PreRenderEventArgs { /** PreRender event data - */ + */ data?: string; /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sunburst model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface LoadedEventArgs { /** Loaded event data - */ + */ data?: string; /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sunburst model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface DataLabelRenderingEventArgs { /** Sunburst datalabel data - */ + */ data?: string; /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sunburst model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface SegmentRenderingEventArgs { /** Sunburst datalabel data - */ + */ data?: string; /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sunburst model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface TitleRenderingEventArgs { /** Sunburst title data - */ + */ data?: string; /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sunburst model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface TooltipInitializeEventArgs { /** Sunburst tooltip data - */ + */ data?: string; /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sunburst model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface PointRegionClickEventArgs { /** Includes clicked points region data - */ + */ data?: string; /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sunburst model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface PointRegionMouseMoveEventArgs { /** Includes data of mouse moved region - */ + */ data?: string; /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sunburst model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface DrillDownClickEventArgs { /** Clicked point data - */ + */ data?: string; /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sunburst model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface DrillDownBackEventArgs { /** Drill down data of points - */ + */ data?: string; /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sunburst model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface DrillDownResetEventArgs { /** Drill down reset data - */ + */ data?: string; /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sunburst model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface Border { /** Border color of the sunburst. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Width of the Sunburst border. - * @Default {2} - */ + * @Default {2} + */ width?: number; } export interface SegmentBorder { /** Segment Border color of the sunburst. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Width of the Sunburst segment border. - * @Default {2} - */ + * @Default {2} + */ width?: number; } export interface Size { /** Height of the Sunburst. - * @Default {''} - */ + * @Default {''} + */ height?: string; /** Width of the Sunburst. - * @Default {''} - */ + * @Default {''} + */ width?: string; } export interface TooltipBorder { /** Border color of the tooltip. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Border width of the tooltip. - * @Default {5} - */ + * @Default {5} + */ width?: number; } export interface TooltipFont { /** Font color of the text in the tooltip. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Font Family for the tooltip. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Specifies the font Style for the tooltip. - * @Default {Normal} - */ + * @Default {Normal} + */ fontStyle?: ej.datavisualization.Sunburst.FontStyle|string; /** Specifies the font weight for the tooltip. - * @Default {Regular} - */ + * @Default {Regular} + */ fontWeight?: ej.datavisualization.Sunburst.FontWeight|string; /** Opacity for text in the tooltip. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font size for text in the tooltip. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface Tooltip { /** tooltip visibility of the Sunburst. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Options for customizing the border of the sunburst tooltip. - */ + */ border?: TooltipBorder; /** Fill color for the sunburst tooltip. - * @Default {null} - */ + * @Default {null} + */ fill?: string; /** Options for customizing the font of the tooltip. - */ + */ font?: TooltipFont; /** Custom template to the tooltip. - * @Default {null} - */ + * @Default {null} + */ template?: string; } export interface Points { /** Points x value of the sunburst. - * @Default {null} - */ + * @Default {null} + */ x?: string; /** Points y value of the sunburst. - * @Default {null} - */ + * @Default {null} + */ y?: number; /** Points text of the sunburst. - * @Default {null} - */ + * @Default {null} + */ text?: string; /** Points fill color of the sunburst. - * @Default {null} - */ + * @Default {null} + */ fill?: string; } export interface DataLabelSettingsFont { /** Font family of the data label. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style of the data label. - * @Default {normal. See FontStyle} - */ + * @Default {normal. See FontStyle} + */ fontStyle?: ej.datavisualization.Sunburst.FontStyle|string; /** Font weight of the data label. - * @Default {regular. See FontWeight} - */ + * @Default {regular. See FontWeight} + */ fontWeight?: ej.datavisualization.Sunburst.FontWeight|string; /** Opacity of the text. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font color of the data label text. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Font size of the data label. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface DataLabelSettings { /** Datalabel visibility of the Sunburst. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; /** Alignment of sunburst datalabel - * @Default {Angle. See DatalabelAlignment} - */ + * @Default {Angle. See DatalabelAlignment} + */ labelRotationMode?: ej.datavisualization.Sunburst.SunburstLabelRotationMode|string; /** Options for customizing the data label font. - */ + */ font?: DataLabelSettingsFont; /** Custom template for datalabel - * @Default {null} - */ + * @Default {null} + */ template?: string; /** Fill color for the datalabel - * @Default {null} - */ + * @Default {null} + */ fill?: string; /** Datalabel overflow mode - * @Default {Trim. See LabelOverflowMode} - */ + * @Default {Trim. See LabelOverflowMode} + */ labelOverflowMode?: ej.datavisualization.Sunburst.SunburstLabelOverflowMode|string; } export interface TitleFont { /** Font family for Sunburst title. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style for Sunburst title. - * @Default {Normal. See FontStyle} - */ + * @Default {Normal. See FontStyle} + */ fontStyle?: ej.datavisualization.Sunburst.FontStyle|string; /** Font weight for Sunburst title. - * @Default {Regular. See FontWeight} - */ + * @Default {Regular. See FontWeight} + */ fontWeight?: ej.datavisualization.Sunburst.FontWeight|string; /** Opacity of the Sunburst title. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font size for Sunburst title. - * @Default {20px} - */ + * @Default {20px} + */ size?: string; } export interface TitleSubtitleFont { /** Font family of sub title. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style for sub title. - * @Default {Normal. See FontStyle} - */ + * @Default {Normal. See FontStyle} + */ fontStyle?: ej.datavisualization.Sunburst.FontStyle|string; /** Font weight for sub title. - * @Default {Regular. See FontWeight} - */ + * @Default {Regular. See FontWeight} + */ fontWeight?: ej.datavisualization.Sunburst.FontWeight|string; /** Opacity of the sub title. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font size for sub title. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface TitleSubtitle { /** Subtitle text for sunburst - */ + */ text?: string; /** Sub title text visibility for sunburst - * @Default {true} - */ + * @Default {true} + */ visible?: string; /** Sub title text alignment - * @Default {far. See TextAlignment} - */ + * @Default {far. See TextAlignment} + */ textAlignment?: ej.datavisualization.Sunburst.SunburstAlignment|string; /** Options for customizing the font of sub title. - */ + */ font?: TitleSubtitleFont; } export interface Title { /** Title text for sunburst - */ + */ text?: string; /** Title text visibility for sunburst - * @Default {true} - */ + * @Default {true} + */ visible?: string; /** Title text alignment - * @Default {center. See TextAlignment} - */ + * @Default {center. See TextAlignment} + */ textAlignment?: ej.datavisualization.Sunburst.SunburstAlignment|string; /** Options for customizing the font of sunburst title. - */ + */ font?: TitleFont; /** Options to customize the sub title of Sunburst. - */ + */ subtitle?: TitleSubtitle; } export interface HighlightSettings { /** Enables/disables the ability to highlight the levels or point interactively. - * @Default {false} - */ + * @Default {false} + */ enable?: boolean; /** Specifies whether the levels or point has to be highlighted. - * @Default {point. See Mode} - */ + * @Default {point. See Mode} + */ mode?: ej.datavisualization.Sunburst.SunburstHighlightMode|string; /** Color of the levels/point on highlight. - * @Default {red} - */ + * @Default {red} + */ color?: string; /** Opacity of the levels/point on highlight. - * @Default {0.5} - */ + * @Default {0.5} + */ opacity?: number; /** Specifies whether the levels or data point has to be highlighted. - * @Default {opacity. See Mode} - */ + * @Default {opacity. See Mode} + */ type?: ej.datavisualization.Sunburst.SunburstHighlightType|string; } export interface SelectionSettings { /** Enables/disables the ability to select the levels or data point interactively. - * @Default {false} - */ + * @Default {false} + */ enable?: boolean; /** Specifies whether the levels or data point has to be selected. - * @Default {point. See Mode} - */ + * @Default {point. See Mode} + */ mode?: ej.datavisualization.Sunburst.SunburstHighlightMode|string; /** Color of the levels/point on selection. - * @Default {green} - */ + * @Default {green} + */ color?: string; /** Opacity of the levels/point on selection. - * @Default {0.5} - */ + * @Default {0.5} + */ opacity?: number; /** Specifies whether the levels or data point has to be selected. - * @Default {opacity. See Mode} - */ + * @Default {opacity. See Mode} + */ type?: ej.datavisualization.Sunburst.SunburstHighlightType|string; } export interface Level { /** Specifies the group member path - * @Default {null} - */ + * @Default {null} + */ groupMemberPath?: string; } export interface LegendBorder { /** Border color of the legend. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Border width of the legend. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface LegendFont { /** Font family for legend item text. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style for legend item text. - * @Default {Normal. See FontStyle} - */ + * @Default {Normal. See FontStyle} + */ fontStyle?: ej.datavisualization.Sunburst.FontStyle|string; /** Font weight for legend item text. - * @Default {Regular. See FontWeight} - */ + * @Default {Regular. See FontWeight} + */ fontWeight?: ej.datavisualization.Sunburst.FontWeight|string; /** Font size for legend item text. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface LegendItemStyle { /** Height of the shape in legend items. - * @Default {10} - */ + * @Default {10} + */ height?: number; /** Width of the shape in legend items. - * @Default {10} - */ + * @Default {10} + */ width?: number; } export interface LegendLocation { /** X value or horizontal offset to position the legend in chart. - * @Default {0} - */ + * @Default {0} + */ x?: number; /** Y value or vertical offset to position the legend. - * @Default {0} - */ + * @Default {0} + */ y?: number; } export interface LegendSize { /** Height of the legend. Height can be specified in either pixel or percentage. - * @Default {null} - */ + * @Default {null} + */ height?: string; /** Width of the legend. Width can be specified in either pixel or percentage. - * @Default {null} - */ + * @Default {null} + */ width?: string; } export interface LegendTitleFont { /** Font family for the text in legend title. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style for legend title. - * @Default {normal. See FontStyle} - */ + * @Default {normal. See FontStyle} + */ fontStyle?: ej.datavisualization.Sunburst.FontStyle|string; /** Font weight for legend title. - * @Default {normal. See FontWeight} - */ + * @Default {normal. See FontWeight} + */ fontWeight?: ej.datavisualization.Sunburst.FontWeight|string; /** Font size for legend title. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface LegendTitle { /** Options to customize the font used for legend title - */ + */ font?: LegendTitleFont; /** Enables or disables the legend title. - * @Default {true} - */ + * @Default {true} + */ visible?: string; /** Text to be displayed in legend title. - */ + */ text?: string; /** Alignment of the legend title. - * @Default {center. See Alignment} - */ + * @Default {center. See Alignment} + */ textAlignment?: ej.datavisualization.Sunburst.SunburstAlignment|string; } export interface Legend { /** Visibility of the legend. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; /** Interactive action of legend items. - * @Default {toggleSegmentVisibility. See Alignment} - */ + * @Default {toggleSegmentVisibility. See Alignment} + */ clickAction?: ej.datavisualization.Sunburst.SunburstClickAction|string; /** Horizontal alignment of the legend. - * @Default {Center. See Alignment} - */ + * @Default {Center. See Alignment} + */ alignment?: ej.datavisualization.Sunburst.SunburstAlignment|string; /** Options for customizing the legend border. - */ + */ border?: LegendBorder; /** Number of columns to arrange the legend items. - * @Default {null} - */ + * @Default {null} + */ columnCount?: number; /** Number of rows to arrange the legend items. - * @Default {null} - */ + * @Default {null} + */ rowCount?: number; /** Options to customize the font used for legend item text. - */ + */ font?: LegendFont; /** Gap or padding between the legend items. - * @Default {10} - */ + * @Default {10} + */ itemPadding?: number; /** Options to customize the style of legend items. - */ + */ itemStyle?: LegendItemStyle; /** Options to customize the location of sunburst legend. Legend is placed in provided location only when value of position property is custom - */ + */ location?: LegendLocation; /** Places the legend at specified position. Legend can be placed at left, right, top or bottom of the chart area.To manually specify the location of legend, set custom as value to this property. - * @Default {Bottom. See Position} - */ + * @Default {Bottom. See Position} + */ position?: ej.datavisualization.Sunburst.SunburstLegendPosition|string; /** Shape of the legend items. - * @Default {None. See Shape} - */ + * @Default {None. See Shape} + */ shape?: ej.datavisualization.Sunburst.SunburstLegendShape|string; /** Options to customize the size of the legend. - */ + */ size?: LegendSize; /** Options to customize the legend title. - */ + */ title?: LegendTitle; } export interface Margin { /** Spacing for the left margin of chart area. Setting positive value decreases the width of the chart area from left side. - * @Default {10} - */ + * @Default {10} + */ left?: number; /** Spacing for the right margin of chart area. Setting positive value decreases the width of the chart area from right side. - * @Default {10} - */ + * @Default {10} + */ right?: number; /** Spacing for the top margin of chart area. Setting positive value decreases the height of the chart area from the top. - * @Default {10} - */ + * @Default {10} + */ top?: number; /** Spacing for the bottom margin of the chart area. Setting positive value decreases the height of the chart area from the bottom. - * @Default {10} - */ + * @Default {10} + */ bottom?: number; } export interface ZoomSettings { /** Enables or disables zooming. - * @Default {false} - */ + * @Default {false} + */ enable?: boolean; /** Toolbar horizontal alignment - * @Default {right. See Alignment} - */ + * @Default {right. See Alignment} + */ toolbarHorizontalAlignment?: ej.datavisualization.Sunburst.SunburstHorizontalAlignment|string; /** Toolbar vertical alignment - * @Default {top. See Alignment} - */ + * @Default {top. See Alignment} + */ toolbarVerticalAlignment?: ej.datavisualization.Sunburst.SunburstVerticalAlignment|string; } } @@ -26748,88 +26748,88 @@ class PivotGrid extends ej.Widget { defaults: PivotGrid.Model; /** Performs an asynchronous HTTP (AJAX) request. - * @returns {void} - */ + * @returns {void} + */ doAjaxPost(): void; /** Performs an asynchronous HTTP (FullPost) submit. - * @returns {void} - */ + * @returns {void} + */ doPostBack(): void; /** Exports the PivotGrid to the specified format. - * @returns {void} - */ + * @returns {void} + */ exportPivotGrid(): void; /** This function re-renders the PivotGrid on clicking the navigation buttons on PivotPager. - * @returns {void} - */ + * @returns {void} + */ refreshPagedPivotGrid(): void; /** This function refreshes the PivotGrid with modified data input in client-mode. - * @returns {void} - */ + * @returns {void} + */ refreshPivotGrid(): void; /** This function re-renders the control with the report available at that instant. - * @returns {void} - */ + * @returns {void} + */ refreshControl(): void; /** This function returns the height of all rows and width each and every column. - * @returns {any} - */ + * @returns {any} + */ calculateCellWidths(): any; /** This function creates the conditional formatting dialog to apply conditional formatting for PivotGrid control. - * @returns {void} - */ + * @returns {void} + */ createConditionalDialog(): void; /** This function saves the current report to the database/local storage. - * @returns {void} - */ + * @returns {void} + */ saveReport(): void; /** This function loads the specified report from the database/local storage. - * @returns {void} - */ + * @returns {void} + */ loadReport(): void; /** This function reconstructs the JSON data formed for rendering PivotGrid in excel-like layout format. - * @returns {void} - */ + * @returns {void} + */ excelLikeLayout(): void; /** Returns the OlapReport string maintained along with the axis elements information. - * @returns {string} - */ + * @returns {string} + */ getOlapReport(): string; /** Sets the OlapReport string along with the axis information. - * @returns {void} - */ + * @returns {void} + */ setOlapReport(): void; /** Returns the JSON records formed to render the control. - * @returns {Array} - */ + * @returns {Array} + */ getJSONRecords(): any[]; /** Sets the JSON records formed to render the control. - * @returns {void} - */ + * @returns {void} + */ setJSONRecords(): void; /** This function allows user to change the caption of the Pivot Item (name displayed in UI) on-demand for relational datasource in client-mode. - * @returns {void} - */ + * @returns {void} + */ refreshFieldCaption(): void; /** This function receives the JSON formatted datasource to render the PivotGrid control. - * @returns {void} - */ + * @returns {void} + */ renderControlFromJSON(): void; } export namespace PivotGrid { @@ -26837,187 +26837,187 @@ export namespace PivotGrid { export interface Model { /** Sets the mode for the PivotGrid widget for binding either OLAP or relational data source. - * @Default {ej.Pivot.AnalysisMode.Pivot} - */ + * @Default {ej.Pivot.AnalysisMode.Pivot} + */ analysisMode?: ej.Pivot.AnalysisMode|string; /** Specifies the CSS class to PivotGrid to achieve custom theme. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ cssClass?: string; /** Connects the PivotSchemaDesigner with the specified ID to the PivotGrid Control. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ pivotTableFieldListID?: string; /** Initializes the data source for the PivotGrid widget, when it functions completely on client-side. - * @Default {{}} - */ + * @Default {{}} + */ dataSource?: DataSource; /** Holds the neccessary properties for value sorting. - * @Default {{}} - */ + * @Default {{}} + */ valueSortSettings?: ValueSortSettings; /** Object that holds the settings of frozen headers. - * @Default {{}} - */ + * @Default {{}} + */ frozenHeaderSettings?: FrozenHeaderSettings; /** Object utilized to pass additional information between client-end and service-end on operating the control in server mode. - * @Default {null} - */ + * @Default {null} + */ customObject?: any; /** Allows the user to collapsed the specified members in each field by default. - * @Default {null} - */ + * @Default {null} + */ collapsedMembers?: any; /** Allows the user to access each cell on mouse right-click. - * @Default {false} - */ + * @Default {false} + */ enableCellContext?: boolean; /** Enables the cell selection for a specific range of value cells. - * @Default {false} - */ + * @Default {false} + */ enableCellSelection?: boolean; /** Enables the Drill-Through feature which retrieves the raw items that are used to create the specific cell in PivotGrid. - * @Default {false} - */ + * @Default {false} + */ enableDrillThrough?: boolean; /** Allows user to get the cell details in JSON format on double clicking the cell. - * @Default {false} - */ + * @Default {false} + */ enableCellDoubleClick?: boolean; /** Allows user to edit the value cells for write-back support in PivotGrid. This is applicable only for server-mode. - * @Default {false} - */ + * @Default {false} + */ enableCellEditing?: boolean; /** Collapses the Pivot items along rows and columns by default. It works only for relational data source. - * @Default {false} - */ + * @Default {false} + */ enableCollapseByDefault?: boolean; /** Enables/Disables the display of grand total for all the columns. - * @Default {true} - */ + * @Default {true} + */ enableColumnGrandTotal?: boolean; /** Allows the user to format a specific set of cells based on the condition. - * @Default {false} - */ + * @Default {false} + */ enableConditionalFormatting?: boolean; /** Enables the advanced filtering options Value Filtering, Label Filtering and Sorting for each fields in server mode. - * @Default {false} - */ + * @Default {false} + */ enableAdvancedFilter?: boolean; /** Allows the user to refresh the control on-demand and not during every UI operation. - * @Default {false} - */ + * @Default {false} + */ enableDeferUpdate?: boolean; /** Enables the display of GroupingBar allowing you to filter, sort and remove fields obtained from datasource. - * @Default {false} - */ + * @Default {false} + */ enableGroupingBar?: boolean; /** Enables/Disables the display of grand total for rows and columns. - * @Default {true} - */ + * @Default {true} + */ enableGrandTotal?: boolean; /** Allows the user to load PivotGrid using JSON data. - * @Default {false} - */ + * @Default {false} + */ enableJSONRendering?: boolean; /** Enables rendering of PivotGrid widget along with the PivotTable Field List, which allows UI operations. - * @Default {true} - */ + * @Default {true} + */ enablePivotFieldList?: boolean; /** Enables the display of grand total for all the rows. - * @Default {true} - */ + * @Default {true} + */ enableRowGrandTotal?: boolean; /** Allows the user to view layout of the PivotGrid from right to left. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Allows the user to enable ToolTip option. - * @Default {false} - */ + * @Default {false} + */ enableToolTip?: boolean; /** Allows the user to enable the animation effects in tooltip. - * @Default {false} - */ + * @Default {false} + */ enableToolTipAnimation?: boolean; /** Allows the user to adjust the width of the columns dynamically. - * @Default {false} - */ + * @Default {false} + */ enableColumnResizing?: boolean; /** Allows the user to view large amount of data through virtual scrolling. - * @Default {false} - */ + * @Default {false} + */ enableVirtualScrolling?: boolean; /** Allows the user to view large amount of data by applying paging. - * @Default {false} - */ + * @Default {false} + */ enablePaging?: boolean; /** Allows the user to configure hyperlink settings of PivotGrid control. - * @Default {{}} - */ + * @Default {{}} + */ hyperlinkSettings?: HyperlinkSettings; /** Allows the user to enable PivotGridĂ¢â‚¬â„¢s responsiveness in the browser layout. - * @Default {false} - */ + * @Default {false} + */ isResponsive?: boolean; /** Contains the serialized JSON string which renders PivotGrid. - */ + */ jsonRecords?: string; /** Sets the summary layout for PivotGrid.Following are the ways in which summary can be positioned: normal summary (bottom), top summary, no summary and excel-like summary. - * @Default {ej.PivotGrid.Layout.Normal} - */ + * @Default {ej.PivotGrid.Layout.Normal} + */ layout?: ej.PivotGrid.Layout|string; /** Allows the user to set the localized language for the widget. - * @Default {en-US} - */ + * @Default {en-US} + */ locale?: string; /** Sets the mode for the PivotGrid widget for binding data source either in server-side or client-side. - * @Default {ej.Pivot.OperationalMode.ClientMode} - */ + * @Default {ej.Pivot.OperationalMode.ClientMode} + */ operationalMode?: ej.Pivot.OperationalMode|string; /** Allows the user to set custom name for the methods at service-end, communicated during AJAX post. - * @Default {{}} - */ + * @Default {{}} + */ serviceMethodSettings?: ServiceMethodSettings; /** Connects the service using the specified URL for any server updates. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ url?: string; /** Triggers when it reaches client-side after any AJAX request. */ @@ -27084,746 +27084,746 @@ export interface Model { export interface AfterServiceInvokeEventArgs { /** returns the current action of PivotGrid control. - */ + */ action?: string; /** returns the custom object bound with PivotGrid control. - */ + */ customObject?: any; /** returns the HTML element of PivotGrid control. - */ + */ element?: any; } export interface BeforeServiceInvokeEventArgs { /** returns the current action of PivotGrid control. - */ + */ action?: string; /** returns the custom object bound with PivotGrid control. - */ + */ customObject?: any; /** returns the HTML element of PivotGrid control. - */ + */ element?: any; } export interface BeforePivotEnginePopulateEventArgs { /** returns the PivotGrid object - */ + */ pivotGridObject?: any; } export interface CellDoubleClickEventArgs { /** returns the JSON details of the double clicked cell. - */ + */ selectedData?: any[]; /** returns the custom object bound with PivotGrid control. - */ + */ customObject?: any; /** returns the HTML element of PivotGrid control. - */ + */ element?: any; } export interface CellContextEventArgs { /** returns the cell position (row index and column index) in table. - */ + */ cellPosition?: string; /** returns the type of the cell. - */ + */ cellType?: string; /** returns the content of the cell. - */ + */ cellValue?: string; /** returns the unique name of levels/members. - */ + */ uniqueName?: string; /** returns the role of the cell in PivotGrid. - */ + */ role?: string; /** returns JSON record corresponding to the selected cell. - */ + */ rawdata?: any; /** returns the original event object. - */ + */ args?: any; } export interface CellSelectionEventArgs { /** returns the JSON records of the selected range of cells. - */ + */ JSONRecords?: any; /** Returns the row headers corresponding to the selected value cells. - */ + */ rowheader?: any; /** Returns the column headers corresponding to the selected value cells. - */ + */ columnheader?: any; /** Returns the information about the measure associated with the selected cell. - */ + */ measureCount?: string; } export interface ColumnHeaderHyperlinkClickEventArgs { /** returns the information about the clicked cell - */ + */ args?: any; /** returns the HTML element of the control. - */ + */ element?: any; /** returns the custom object bound to the control. - */ + */ customObject?: any; } export interface DrillSuccessEventArgs { /** returns the HTML element of the control. - */ + */ args?: any; } export interface DrillThroughEventArgs { /** return the JSON records of the generated cells on drill-through operation. - */ + */ data?: any; /** returns the HTML element of PivotGrid control. - */ + */ element?: any; } export interface LoadEventArgs { /** returns the custom object bound with the control. - */ + */ customObject?: any; /** returns the HTML element of PivotGrid control. - */ + */ element?: any; } export interface RenderCompleteEventArgs { /** returns the current action of PivotGrid control. - */ + */ action?: string; /** returns the custom object bound with the control. - */ + */ customObject?: any; /** returns the HTML element of PivotGrid control. - */ + */ element?: any; } export interface RenderFailureEventArgs { /** returns the current action of PivotGrid control. - */ + */ action?: string; /** returns the custom object bound with the control. - */ + */ customObject?: any; /** returns the HTML element of PivotGrid control. - */ + */ element?: any; /** returns the error message with error code. - */ + */ message?: string; } export interface RenderSuccessEventArgs { /** returns the current action of PivotGrid control. - */ + */ action?: string; /** returns the custom object bound with the control. - */ + */ customObject?: any; /** returns the HTML element of PivotGrid control. - */ + */ element?: any; } export interface RowHeaderHyperlinkClickEventArgs { /** returns the information about the clicked cell - */ + */ args?: any; /** returns the HTML element of the control. - */ + */ element?: any; /** returns the custom object bound to the control. - */ + */ customObject?: any; } export interface SummaryCellHyperlinkClickEventArgs { /** returns the information about the clicked cell - */ + */ args?: any; /** returns the HTML element of the control. - */ + */ element?: any; /** returns the custom object bound to the control. - */ + */ customObject?: any; } export interface ValueCellHyperlinkClickEventArgs { /** returns the information about the clicked cell - */ + */ args?: any; /** returns the HTML element of the control. - */ + */ element?: any; /** returns the custom object bound to the control. - */ + */ customObject?: any; } export interface SaveReportEventArgs { /** returns the report to be stored in database. - */ + */ report?: any; } export interface LoadReportEventArgs { /** returns the PivotGrid object. - */ + */ targetControl?: any; /** returns whether the control is bound with OLAP or Relational data source. - */ + */ dataModel?: string; } export interface BeforeExportEventArgs { /** contains the url of the service responsible for exporting. - */ + */ url?: string; /** contains the name of the exporting file. - */ + */ fileName?: string; } export interface CellEditEventArgs { /** contains the array of cells selected for editing. - */ + */ editCellsInfo?: any[]; } export interface DataSourceColumnsAdvancedFilter { /** Allows the user to provide level unique name to perform advanced filtering. - */ + */ name?: string; /** Allows the user to set the operator to perform Label Filtering. - * @Default {none} - */ + * @Default {none} + */ labelFilterOperator?: string; /** Allows the user to set the operator to perform Value Filtering. - * @Default {none} - */ + * @Default {none} + */ valueFilterOperator?: string; /** Allows the user to set the filtering type while performing advanced filtering. - */ + */ advancedFilterType?: string; /** In case of value filtering, this property contains the measure name to which the filter is applied. - */ + */ measure?: string; /** Allows the user to hold the filter operand values in advanced filtering. - */ + */ values?: any[]; } export interface DataSourceColumnsFilterItems { /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ filterType?: ej.PivotAnalysis.FilterType|string; /** Contains the collection of items to be included/excluded among the field members. - * @Default {[]} - */ + * @Default {[]} + */ values?: any[]; } export interface DataSourceColumn { /** Allows the user to bind the item by using its unique name as field name. - */ + */ fieldName?: string; /** Allows the user to set the display caption for an item. - */ + */ fieldCaption?: string; /** Allows the user to filter the report by default using advanced filtering (excel-like) option for OLAP data source in client-mode. - * @Default {[]} - */ + * @Default {[]} + */ advancedFilter?: DataSourceColumnsAdvancedFilter[]; /** Allows the user to indicate whether the added item is a named set or not. - * @Default {false} - */ + * @Default {false} + */ isNamedSets?: boolean; /** Shows/Hides the sub-total of the field in PivotGrid. - * @Default {true} - */ + * @Default {true} + */ showSubTotal?: boolean; /** Allows the user to set the sorting order of the members of the field. - * @Default {ej.PivotAnalysis.SortOrder.Ascending} - */ + * @Default {ej.PivotAnalysis.SortOrder.Ascending} + */ sortOrder?: ej.PivotAnalysis.SortOrder|string; /** Contains the list of members need to be drilled down by default in the field. - * @Default {[]} - */ + * @Default {[]} + */ drilledItems?: any[]; /** Applies filter to the field members. - * @Default {null} - */ + * @Default {null} + */ filterItems?: DataSourceColumnsFilterItems; } export interface DataSourceRowsAdvancedFilter { /** Allows the user to provide level unique name to perform advanced filtering. - */ + */ name?: string; /** Allows the user to set the operator to perform Label Filtering. - * @Default {none} - */ + * @Default {none} + */ labelFilterOperator?: string; /** Allows the user to set the operator to perform Value Filtering. - * @Default {none} - */ + * @Default {none} + */ valueFilterOperator?: string; /** Allows the user to set the filtering type while performing advanced filtering. - */ + */ advancedFilterType?: string; /** In case of value filtering, this property contains the measure name to which the filter is applied. - */ + */ measure?: string; /** Allows the user to hold the filter operand values in advanced filtering. - */ + */ values?: any[]; } export interface DataSourceRowsFilterItems { /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ filterType?: ej.PivotAnalysis.FilterType|string; /** Contains the collection of items to be included/excluded among the field members. - * @Default {[]} - */ + * @Default {[]} + */ values?: any[]; } export interface DataSourceRow { /** Allows the user to bind the item by using its unique name as field name. - */ + */ fieldName?: string; /** Allows the user to set the display caption for an item. - */ + */ fieldCaption?: string; /** Allows the user to filter the report by default using advanced filtering (excel-like) option for OLAP data source in client-mode. - * @Default {[]} - */ + * @Default {[]} + */ advancedFilter?: DataSourceRowsAdvancedFilter[]; /** Allows the user to indicate whether the added item is a named set or not. - * @Default {false} - */ + * @Default {false} + */ isNamedSets?: boolean; /** Shows/Hides the sub-total of the field. - * @Default {true} - */ + * @Default {true} + */ showSubTotal?: boolean; /** Allows the user to set the sorting order of the members of the field. - * @Default {ej.PivotAnalysis.SortOrder.Ascending} - */ + * @Default {ej.PivotAnalysis.SortOrder.Ascending} + */ sortOrder?: ej.PivotAnalysis.SortOrder|string; /** Contains the list of members need to be drilled down by default in the field. - * @Default {[]} - */ + * @Default {[]} + */ drilledItems?: any[]; /** Applies filter to the field members. - * @Default {null} - */ + * @Default {null} + */ filterItems?: DataSourceRowsFilterItems; } export interface DataSourceValuesMeasure { /** Allows the user to bind the measure from OLAP datasource by using its unique name as field name. - */ + */ fieldName?: string; } export interface DataSourceValue { /** Allows the user to bind the item by using its unique name as field name for Relational datasource. - */ + */ fieldName?: string; /** Allows the user to set the display caption for an item for Relational datasource. - */ + */ fieldCaption?: string; /** This holds the list of unique names of measures to bind them from the OLAP cube. - * @Default {[]} - */ + * @Default {[]} + */ measures?: DataSourceValuesMeasure[]; /** Allows to set the axis name to place the measures items. - * @Default {rows} - */ + * @Default {rows} + */ axis?: string; /** Indicates whether the field is a calculated field or not with Relational datasource. - * @Default {false} - */ + * @Default {false} + */ isCalculatedField?: boolean; /** Allows to set the type of PivotGrid summary calculation for the value field with Relational datasource. - * @Default {ej.PivotAnalysis.SummaryType.Sum} - */ + * @Default {ej.PivotAnalysis.SummaryType.Sum} + */ summaryType?: ej.PivotAnalysis.SummaryType|string; /** Allows to set the format of the values. - */ + */ format?: string; /** This property sets type of display of date. - */ + */ formatString?: string; /** Allows to set the formula for calculation of values for calculated members in Relational datasource. - */ + */ formula?: string; } export interface DataSourceFiltersFilterItems { /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ filterType?: ej.PivotAnalysis.FilterType|string; /** Contains the collection of items to be included/excluded among the field members. - * @Default {[]} - */ + * @Default {[]} + */ values?: any[]; } export interface DataSourceFilter { /** Allows the user to bind the item by using its unique name as field name. - */ + */ fieldName?: string; /** Allows the user to set the display name for an item. - */ + */ fieldCaption?: string; /** Applies filter to the field members. - * @Default {null} - */ + * @Default {null} + */ filterItems?: DataSourceFiltersFilterItems; } export interface DataSourcePagerOptions { /** Allows to set the number of categorical columns to be displayed in each page on applying paging. - * @Default {0} - */ + * @Default {0} + */ categoricalPageSize?: number; /** Allows to set the number of series rows to be displayed in each page on applying paging. - * @Default {0} - */ + * @Default {0} + */ seriesPageSize?: number; /** Allows to set the page number in categorical axis to be loaded by default. - * @Default {1} - */ + * @Default {1} + */ categoricalCurrentPage?: number; /** Allows to set the page number in series axis to be loaded by default. - * @Default {1} - */ + * @Default {1} + */ seriesCurrentPage?: number; } export interface DataSource { /** Lists out the items to be arranged in columns section of PivotGrid. - * @Default {[]} - */ + * @Default {[]} + */ columns?: DataSourceColumn[]; /** Lists out the items to be arranged in rows section of PivotGrid. - * @Default {[]} - */ + * @Default {[]} + */ rows?: DataSourceRow[]; /** Lists out the items which supports calculation in PivotGrid. - * @Default {[]} - */ + * @Default {[]} + */ values?: DataSourceValue[]; /** Lists out the items which supports filtering of values without displaying the members in UI in PivotGrid. - * @Default {[]} - */ + * @Default {[]} + */ filters?: DataSourceFilter[]; /** Contains the respective cube name from OLAP database as string type. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ cube?: string; /** Provides the raw data source for the PivotGrid. - * @Default {null} - */ + * @Default {null} + */ data?: any; /** In connection with an OLAP database, this property contains the database name as string to fetch the data from the given connection string. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ catalog?: string; /** Allows user to filter the members (by its name and values) through advanced filtering (excel-like) option for OLAP data source in client-mode. - * @Default {false} - */ + * @Default {false} + */ enableAdvancedFilter?: boolean; /** Sets a name to the report bound to the control. - */ + */ reportName?: string; /** Allows to set the page size and current page number for each axis on applying paging. - * @Default {{}} - */ + * @Default {{}} + */ pagerOptions?: DataSourcePagerOptions; } export interface ValueSortSettings { /** Contains the headers of the specific column to which value sorting is applied. - */ + */ headerText?: string; /** Allows the user to set the string for separating column headers provided in the above property headerText. - */ + */ headerDelimiters?: string; /** Allows the user to set the sorting order of the values of the field. - * @Default {ej.PivotAnalysis.SortOrder.Ascending} - */ + * @Default {ej.PivotAnalysis.SortOrder.Ascending} + */ sortOrder?: ej.PivotAnalysis.SortOrder|string; } export interface FrozenHeaderSettings { /** Allows the user to freeze the row headers alone on scrolling the horizontal scroll bar. - * @Default {false} - */ + * @Default {false} + */ enableFrozenRowHeaders?: boolean; /** Allows the user to freeze the column headers alone on scrolling the vertical scroll bar. - * @Default {false} - */ + * @Default {false} + */ enableFrozenColumnHeaders?: boolean; /** Allows the user to freeze both the row headers and column headers on scrolling. - * @Default {false} - */ + * @Default {false} + */ enableFrozenHeaders?: boolean; } export interface HyperlinkSettings { /** Allows the user to enable/disable hyperlink for column header. - * @Default {false} - */ + * @Default {false} + */ enableColumnHeaderHyperlink?: boolean; /** Allows the user to enable/disable hyperlink for row header. - * @Default {false} - */ + * @Default {false} + */ enableRowHeaderHyperlink?: boolean; /** Allows the user to enable/disable hyperlink for summary cells. - * @Default {false} - */ + * @Default {false} + */ enableSummaryCellHyperlink?: boolean; /** Allows the user to enable/disable hyperlink for value cells. - * @Default {false} - */ + * @Default {false} + */ enableValueCellHyperlink?: boolean; } export interface ServiceMethodSettings { /** Allows the user to set the custom name for the service method responsible for drill up/down operation in PivotGrid. - * @Default {DrillGrid} - */ + * @Default {DrillGrid} + */ drillDown?: string; /** Allows the user to set the custom name for the service method responsible for exporting. - * @Default {Export} - */ + * @Default {Export} + */ exportPivotGrid?: string; /** Allows the user to set the custom name for the service method responsible for performing server-side actions on defer update. - * @Default {DeferUpdate} - */ + * @Default {DeferUpdate} + */ deferUpdate?: string; /** Allows the user to set the custom name for the service method responsible for getting the values for the tree-view inside filter dialog. - * @Default {FetchMembers} - */ + * @Default {FetchMembers} + */ fetchMembers?: string; /** Allows the user to set the custom name for the service method responsible for filtering operation in PivotGrid. - * @Default {Filtering} - */ + * @Default {Filtering} + */ filtering?: string; /** Allows the user to set the custom name for the service method responsible for initializing PivotGrid. - * @Default {InitializeGrid} - */ + * @Default {InitializeGrid} + */ initialize?: string; /** Allows the user to set the custom name for the service method responsible for the server-side action, on dropping a node from Field List. - * @Default {NodeDropped} - */ + * @Default {NodeDropped} + */ nodeDropped?: string; /** Allows the user to set the custom name for the service method responsible for the server-side action on changing the checked state of a node in Field List. - * @Default {NodeStateModified} - */ + * @Default {NodeStateModified} + */ nodeStateModified?: string; /** Allows the user to set the custom name for the service method responsible for performing paging operation in PivotGrid. - * @Default {Paging} - */ + * @Default {Paging} + */ paging?: string; /** Allows the user to set the custom name for the service method responsible for sorting operation in PivotGrid. - * @Default {Sorting} - */ + * @Default {Sorting} + */ sorting?: string; /** Allows the user to set the custom name for the service method responsible for expanding members inside member editor. - * @Default {MemberExpanded} - */ + * @Default {MemberExpanded} + */ memberExpand?: string; /** Allows the user to set the custom name for the service method responsible for editing the cells. - * @Default {CellEditing} - */ + * @Default {CellEditing} + */ cellEditing?: string; /** Allows the user to set the custom name for the service method responsible for saving the current report to database. - * @Default {SaveReport} - */ + * @Default {SaveReport} + */ saveReport?: string; /** Allows the user to set the custom name for the service method responsible for loading a report from database. - * @Default {LoadReportFromDB} - */ + * @Default {LoadReportFromDB} + */ loadReport?: string; /** Allows the user to set the custom name for the service method responsible for adding a calculated field to the report. - * @Default {CalculatedField} - */ + * @Default {CalculatedField} + */ calculatedField?: string; /** Allows the user to set the custom name for the service method responsible for performing drill through operation. - * @Default {DrillThroughHierarchies} - */ + * @Default {DrillThroughHierarchies} + */ drillThroughHierarchies?: string; /** Allows the user to set the custom name for the service method responsible for performing drill through operation in data table. - * @Default {DrillThroughDataTable} - */ + * @Default {DrillThroughDataTable} + */ drillThroughDataTable?: string; /** Allows the user to set the custom name for the service method responsible for write-back operation in OLAP Cube. This is only applicable in server-side component. - * @Default {WriteBack} - */ + * @Default {WriteBack} + */ writeBack?: string; } @@ -27900,13 +27900,13 @@ class PivotSchemaDesigner extends ej.Widget { defaults: PivotSchemaDesigner.Model; /** Performs an asynchronous HTTP (AJAX) request. - * @returns {void} - */ + * @returns {void} + */ doAjaxPost(): void; /** Re-renders the control with the data source bound to the pivot control at that instant. - * @returns {void} - */ + * @returns {void} + */ refreshControl(): void; } export namespace PivotSchemaDesigner { @@ -27914,69 +27914,69 @@ export namespace PivotSchemaDesigner { export interface Model { /** Specifies the CSS class to PivotSchemaDesigner to achieve custom theme. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ cssClass?: string; /** Object utilized to pass additional information between client-end and service-end. - * @Default {{}} - */ + * @Default {{}} + */ customObject?: any; /** For ASP.NET and MVC Wrapper, PivotSchemaDesigner will be initialized and rendered empty initially. Once the connected pivot control widget is rendered completely, - * PivotSchemaDesigner will just be populated with data source by setting this property to Ă¢â‚¬Å“trueĂ¢â‚¬Â. - * @Default {false} - */ + * PivotSchemaDesigner will just be populated with data source by setting this property to Ă¢â‚¬Å“trueĂ¢â‚¬Â. + * @Default {false} + */ enableWrapper?: boolean; /** Allows the user to view PivotTable Field List from right to left. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Sets the visibility of OLAP elements in PivotTable Field List. This is only applicable for OLAP datasource. - * @Default {null} - */ + * @Default {null} + */ olap?: Olap; /** Allows the user to enable/disable drag and drop operations within the PivotTable Field List. - * @Default {true} - */ + * @Default {true} + */ enableDragDrop?: boolean; /** Sets the height for PivotSchemaDesigner. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ height?: string; /** Allows the user to set the localized language for the widget. - * @Default {en-US} - */ + * @Default {en-US} + */ locale?: string; /** Sets the Pivot control bound with this PivotSchemaDesigner. - * @Default {null} - */ + * @Default {null} + */ pivotControl?: any; /** Allows the user to set custom name for the methods at service-end, communicated during AJAX post. - * @Default {{}} - */ + * @Default {{}} + */ serviceMethod?: ServiceMethod; /** Connects the service using the specified URL for any server updates. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ url?: string; /** Sets the width for PivotSchemaDesigner. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ width?: string; /** Sets the layout for PivotSchemaDesigner. - * @Default {ej.PivotSchemaDesigner.Layouts.Excel} - */ + * @Default {ej.PivotSchemaDesigner.Layouts.Excel} + */ layout?: ej.PivotSchemaDesigner.Layouts|string; /** Triggers when it reaches client-side after any AJAX request. */ @@ -27992,95 +27992,95 @@ export interface Model { export interface AfterServiceInvokeEventArgs { /** returns the current action of PivotSchemaDesigner control. - */ + */ action?: string; /** returns the custom object bound with PivotSchemaDesigner control. - */ + */ customObject?: any; /** returns the HTML element of PivotSchemaDesigner control. - */ + */ element?: any; } export interface BeforeServiceInvokeEventArgs { /** returns the current action of PivotSchemaDesigner control. - */ + */ action?: string; /** returns the custom object bound with PivotSchemaDesigner control. - */ + */ customObject?: any; /** returns the HTML element of PivotSchemaDesigner control. - */ + */ element?: any; } export interface DragMoveEventArgs { /** returns the HTML element of the dragged field from PivotSchemaDesigner. - */ + */ dragTarget?: any; /** return the JSON details of the dragged field. - */ + */ draggedElementData?: any; /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the PivotSchemaDesigner model - */ + */ model?: any; } export interface Olap { /** Allows the user to view the KPI elements in tree-view inside PivotTable Field List. This is only applicable for OLAP datasource. - * @Default {false} - */ + * @Default {false} + */ showKPI?: boolean; /** Allows the user to view the named sets in tree-view inside PivotTable Field List. This is only applicable for OLAP datasource. - * @Default {false} - */ + * @Default {false} + */ showNamedSets?: boolean; } export interface ServiceMethod { /** Allows the user to set the custom name for the service method responsible for getting the values for the tree-view inside filter dialog. - * @Default {FetchMembers} - */ + * @Default {FetchMembers} + */ fetchMembers?: string; /** Allows the user to set the custom name for the service method responsible for filtering operation in Field List. - * @Default {Filtering} - */ + * @Default {Filtering} + */ filtering?: string; /** Allows the user to set the custom name for the service method responsible for the server-side action, on expanding members in Field List. - * @Default {MemberExpanded} - */ + * @Default {MemberExpanded} + */ memberExpand?: string; /** Allows the user to set the custom name for the service method responsible for the server-side action, on dropping a node into Field List. - * @Default {NodeDropped} - */ + * @Default {NodeDropped} + */ nodeDropped?: string; /** Allows the user to set the custom name for the service method responsible for the server-side action on changing the checked state of a node in Field List. - * @Default {NodeStateModified} - */ + * @Default {NodeStateModified} + */ nodeStateModified?: string; /** Allows the user to set the custom name for the service method responsible for button removing operation in Field List. - * @Default {RemoveButton} - */ + * @Default {RemoveButton} + */ removeButton?: string; } @@ -28106,8 +28106,8 @@ class PivotPager extends ej.Widget { defaults: PivotPager.Model; /** This function initializes the page counts and page numbers for the PivotPager. - * @returns {void} - */ + * @returns {void} + */ initPagerProperties(): void; } export namespace PivotPager { @@ -28115,38 +28115,38 @@ export namespace PivotPager { export interface Model { /** Contains the current page number in categorical axis. - * @Default {1} - */ + * @Default {1} + */ categoricalCurrentPage?: number; /** Contains the total page count in categorical axis. - * @Default {1} - */ + * @Default {1} + */ categoricalPageCount?: number; /** Allows the user to set the localized language for the widget. - * @Default {en-US} - */ + * @Default {en-US} + */ locale?: string; /** Sets the pager mode (Only Categorical Pager/Only Series Pager/Both) for the PivotPager. - * @Default {ej.PivotPager.Mode.Both} - */ + * @Default {ej.PivotPager.Mode.Both} + */ mode?: ej.PivotPager.Mode|string; /** Contains the current page number in series axis. - * @Default {1} - */ + * @Default {1} + */ seriesCurrentPage?: number; /** Contains the total page count in series axis. - * @Default {1} - */ + * @Default {1} + */ seriesPageCount?: number; /** Contains the ID of the target element for which paging needs to be done. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ targetControlID?: string; } @@ -28172,73 +28172,73 @@ class PivotChart extends ej.Widget { defaults: PivotChart.Model; /** Performs an asynchronous HTTP (AJAX) request. - * @returns {void} - */ + * @returns {void} + */ doAjaxPost(): void; /** Perform an asynchronous HTTP (FullPost) submit. - * @returns {void} - */ + * @returns {void} + */ doPostBack(): void; /** Exports the PivotChart to the format specified in the parameter. - * @returns {void} - */ + * @returns {void} + */ exportPivotChart(): void; /** This function renders the PivotChart control with the JSON formatted datasource. - * @returns {void} - */ + * @returns {void} + */ renderChartFromJSON(): void; /** This function receives the update from service-end, which would be utilized for rendering the widget. - * @returns {void} - */ + * @returns {void} + */ renderControlSuccess(): void; /** Returns the OlapReport string maintained along with the axis elements information. - * @returns {string} - */ + * @returns {string} + */ getOlapReport(): string; /** Sets the OlapReport string along with the axis information and maintains it in a property. - * @returns {void} - */ + * @returns {void} + */ setOlapReport(): void; /** Returns the JSON records formed to render the control. - * @returns {Array} - */ + * @returns {Array} + */ getJSONRecords(): any[]; /** Sets the JSON records to render the control. - * @returns {void} - */ + * @returns {void} + */ setJSONRecords(): void; /** Returns the PivotEngine formed to render the control. - * @returns {Array} - */ + * @returns {Array} + */ getPivotEngine(): any[]; /** Sets the PivotEngine required to render the control. - * @returns {void} - */ + * @returns {void} + */ setPivotEngine(): void; /** Re-renders the control with the data source at the instant. - * @returns {void} - */ + * @returns {void} + */ refreshControl(): void; /** Renders the control with the pivot engine obtained from olap cube. - * @returns {void} - */ + * @returns {void} + */ generateJSON(): void; /** Navigates to the specified page number in specified axis. - * @returns {void} - */ + * @returns {void} + */ refreshPagedPivotChart(): void; } export namespace PivotChart { @@ -28246,97 +28246,97 @@ export namespace PivotChart { export interface Model { /** Sets the mode for the PivotChart widget for binding either OLAP or Relational data source. - * @Default {ej.Pivot.AnalysisMode.Pivot} - */ + * @Default {ej.Pivot.AnalysisMode.Pivot} + */ analysisMode?: ej.Pivot.AnalysisMode|string; /** Specifies the CSS class to PivotChart to achieve custom theme. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ cssClass?: string; /** Options for enabling zooming feature of PivotChart. - * @Default {{}} - */ + * @Default {{}} + */ zooming?: Zooming; /** Options available to configure the properties of entire series. You can also override the options for specific series by using series collection. - * @Default {{}} - */ + * @Default {{}} + */ commonSeriesOptions?: CommonSeriesOptions; /** Initializes the data source for the PivotChart widget, when it functions completely on client-side. - * @Default {{}} - */ + * @Default {{}} + */ dataSource?: DataSource; /** Object utilized to pass additional information between client-end and service-end on operating the control in server mode. - * @Default {{}} - */ + * @Default {{}} + */ customObject?: any; /** Allows the user to enable 3D view of PivotChart. - * @Default {false} - */ + * @Default {false} + */ enable3D?: boolean; /** Allows the user to view PivotChart from right to left. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Allows the user to enable PivotChartĂ¢â‚¬â„¢s responsiveness in the browser layout. - * @Default {false} - */ + * @Default {false} + */ isResponsive?: boolean; /** Lets the user to customize the legend items and their labels. - * @Default {{}} - */ + * @Default {{}} + */ legend?: any; /** Allows the user to set the localized language for the widget. - * @Default {en-US} - */ + * @Default {en-US} + */ locale?: string; /** Sets the mode for the PivotChart widget for binding data source either in server-side or client-side. - * @Default {ej.Pivot.OperationalMode.ClientMode} - */ + * @Default {ej.Pivot.OperationalMode.ClientMode} + */ operationalMode?: ej.Pivot.OperationalMode|string; /** This is a horizontal axis that contains options to configure axis and it is the primary x axis for all the series in series array. - * To override x axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. - * Then, assign the name to the seriesĂ¢â‚¬â„¢s xAxisName property to link both axis and series. - * @Default {{}} - */ + * To override x axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. + * Then, assign the name to the seriesĂ¢â‚¬â„¢s xAxisName property to link both axis and series. + * @Default {{}} + */ primaryXAxis?: any; /** This is a vertical axis that contains options to configure axis. This is the primary y axis for all the series in series array. - * To override y axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. - * Then, assign the name to the seriesĂ¢â‚¬â„¢s yAxisName property to link both axis and series. - * @Default {{}} - */ + * To override y axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. + * Then, assign the name to the seriesĂ¢â‚¬â„¢s yAxisName property to link both axis and series. + * @Default {{}} + */ primaryYAxis?: any; /** Allows the user to rotate the angle of PivotChart in 3D view. - * @Default {0} - */ + * @Default {0} + */ rotation?: number; /** Allows the user to set custom name for the methods at service-end, communicated on AJAX post. - * @Default {{}} - */ + * @Default {{}} + */ serviceMethodSettings?: ServiceMethodSettings; /** Options to customize the size of the PivotChart control. - * @Default {{}} - */ + * @Default {{}} + */ size?: any; /** Connects the service using the specified URL for any server updates on operating the control in server mode. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ url?: string; /** Triggers when PivotChart starts to render. */ @@ -28367,333 +28367,333 @@ export interface Model { export interface LoadEventArgs { /** returns the current action of PivotChart control. - */ + */ action?: string; /** returns the custom object bound with PivotChart control. - */ + */ customObject?: any; /** returns the HTML element of PivotChart control. - */ + */ element?: any; } export interface AfterServiceInvokeEventArgs { /** returns the current action of PivotChart control. - */ + */ action?: string; /** returns the custom object bound with PivotChart control. - */ + */ customObject?: any; /** returns the HTML element of PivotChart control. - */ + */ element?: any; } export interface BeforeServiceInvokeEventArgs { /** returns the current action of PivotChart control. - */ + */ action?: string; /** returns the custom object bound with PivotChart control. - */ + */ customObject?: any; /** returns the HTML element of PivotChart control. - */ + */ element?: any; } export interface DrillSuccessEventArgs { /** returns the current instance of PivotChart. - */ + */ chartObj?: any; /** returns the drill action of PivotChart. - */ + */ drillAction?: string; /** contains the name of the member drilled. - */ + */ drilledMember?: string; /** returns the event object. - */ + */ event?: any; } export interface RenderCompleteEventArgs { /** returns the current action of PivotChart control. - */ + */ action?: string; /** returns the custom object bound with PivotChart control. - */ + */ customObject?: any; /** returns the HTML element of PivotChart control. - */ + */ element?: any; } export interface RenderFailureEventArgs { /** returns the current action of PivotChart control. - */ + */ action?: string; /** returns the custom object bound with PivotChart control. - */ + */ customObject?: any; /** returns the HTML element of PivotChart control. - */ + */ element?: any; /** returns the error stack trace of the original exception. - */ + */ message?: string; } export interface RenderSuccessEventArgs { /** returns the current instance of PivotChart. - */ + */ args?: any; } export interface BeforeExportEventArgs { /** contains the url of the service responsible for exporting. - */ + */ url?: string; /** contains the name of the exporting file. - */ + */ fileName?: string; } export interface Zooming { /** Enables or disables horizontal scrollbar. - * @Default {false} - */ + * @Default {false} + */ enableScrollbar?: boolean; } export interface CommonSeriesOptions { /** Allows the user to set the specific chart type for PivotChart widget. - * @Default {ej.PivotChart.ChartTypes.Column} - */ + * @Default {ej.PivotChart.ChartTypes.Column} + */ type?: ej.PivotChart.ChartTypes|string; } export interface DataSourceColumnsFilterItems { /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ filterType?: ej.PivotAnalysis.FilterType|string; /** Contains the collection of items to be included/excluded among the field members. - * @Default {[]} - */ + * @Default {[]} + */ values?: any[]; } export interface DataSourceColumn { /** Allows the user to bind the item by using its unique name as field name. - */ + */ fieldName?: string; /** Allows the user to set the display caption for an item. - */ + */ fieldCaption?: string; /** Allows the user to indicate whether the added item is a named set or not. - * @Default {false} - */ + * @Default {false} + */ isNamedSets?: boolean; /** Allows the user to set the sorting order of the members of the field. - * @Default {ej.PivotAnalysis.SortOrder.Ascending} - */ + * @Default {ej.PivotAnalysis.SortOrder.Ascending} + */ sortOrder?: ej.PivotAnalysis.SortOrder|string; /** Applies filter to the field members. - * @Default {null} - */ + * @Default {null} + */ filterItems?: DataSourceColumnsFilterItems; } export interface DataSourceRowsFilterItems { /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ filterType?: ej.PivotAnalysis.FilterType|string; /** Contains the collection of items to be included/excluded among the field members. - * @Default {[]} - */ + * @Default {[]} + */ values?: any[]; } export interface DataSourceRow { /** Allows the user to bind the item by using its unique name as field name. - */ + */ fieldName?: string; /** Allows the user to set the display caption for an item. - */ + */ fieldCaption?: string; /** Allows the user to indicate whether the added item is a named set or not. - * @Default {false} - */ + * @Default {false} + */ isNamedSets?: boolean; /** Allows the user to set the sorting order of the members of the field. - * @Default {ej.PivotAnalysis.SortOrder.Ascending} - */ + * @Default {ej.PivotAnalysis.SortOrder.Ascending} + */ sortOrder?: ej.PivotAnalysis.SortOrder|string; /** Applies filter to the field members. - * @Default {null} - */ + * @Default {null} + */ filterItems?: DataSourceRowsFilterItems; } export interface DataSourceValuesMeasure { /** Allows the user to bind the measure from OLAP datasource by using its unique name as field name. - */ + */ fieldName?: string; } export interface DataSourceValue { /** Allows the user to bind the item by using its unique name as field name for Relational datasource. - */ + */ fieldName?: string; /** Allows the user to set the display caption for an item for Relational datasource. - */ + */ fieldCaption?: string; /** This holds the list of unique names of measures to bind them from the OLAP cube. - * @Default {[]} - */ + * @Default {[]} + */ measures?: DataSourceValuesMeasure[]; /** Allows to set the axis name to place the measures items. - * @Default {rows} - */ + * @Default {rows} + */ axis?: string; /** Indicates whether the field is a calculated field or not with Relational datasource. - * @Default {false} - */ + * @Default {false} + */ isCalculatedField?: boolean; /** Allows to set the formula for calculation of values for calculated members in Relational datasource. - */ + */ formula?: string; } export interface DataSourceFiltersFilterItems { /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ filterType?: ej.PivotAnalysis.FilterType|string; /** Contains the collection of items to be included/excluded among the field members. - * @Default {[]} - */ + * @Default {[]} + */ values?: any[]; } export interface DataSourceFilter { /** Allows the user to bind the item by using its unique name as field name. - */ + */ fieldName?: string; /** Applies filter to the field members. - * @Default {null} - */ + * @Default {null} + */ filterItems?: DataSourceFiltersFilterItems; } export interface DataSource { /** Contains the respective cube name from OLAP database as string type. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ cube?: string; /** Provides the raw data source for the PivotChart. - * @Default {null} - */ + * @Default {null} + */ data?: any; /** In connection with an OLAP database, this property contains the database name as string to fetch the data from the given connection string. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ catalog?: string; /** Lists out the items to be displayed as series of PivotChart. - * @Default {[]} - */ + * @Default {[]} + */ columns?: DataSourceColumn[]; /** Lists out the items to be displayed as segments of PivotChart. - * @Default {[]} - */ + * @Default {[]} + */ rows?: DataSourceRow[]; /** Lists out the items supports calculation in PivotChart. - * @Default {[]} - */ + * @Default {[]} + */ values?: DataSourceValue[]; /** Lists out the items which supports filtering of values without displaying the members in UI in PivotChart. - * @Default {[]} - */ + * @Default {[]} + */ filters?: DataSourceFilter[]; } export interface ServiceMethodSettings { /** Allows the user to set the custom name for the service method responsible for drilling up/down operation in PivotChart. - * @Default {DrillChart} - */ + * @Default {DrillChart} + */ drillDown?: string; /** Allows the user to set the custom name for the service method responsible for exporting. - * @Default {Export} - */ + * @Default {Export} + */ exportPivotChart?: string; /** Allows the user to set the custom name for the service method responsible for initializing PivotChart. - * @Default {InitializeChart} - */ + * @Default {InitializeChart} + */ initialize?: string; /** Allows the user to set the custom name for the service method responsible for navigating between pages in paged PivotChart. - * @Default {Paging} - */ + * @Default {Paging} + */ paging?: string; } @@ -28761,53 +28761,53 @@ class PivotClient extends ej.Widget { defaults: PivotClient.Model; /** Performs an asynchronous HTTP (AJAX) request. - * @returns {void} - */ + * @returns {void} + */ doAjaxPost(): void; /** Performs an asynchronous HTTP (FullPost) submit. - * @returns {void} - */ + * @returns {void} + */ doPostBack(): void; /** Navigates to the specified page in specified axis. - * @returns {void} - */ + * @returns {void} + */ refreshPagedPivotClient(): void; /** Updates the PivotClient component with the JSON data fetched from the service on navigating between pages. - * @returns {void} - */ + * @returns {void} + */ refreshPagedPivotClientSuccess(): void; /** Renders the PivotChart and PivotGrid with the JSON data provided. - * @returns {void} - */ + * @returns {void} + */ generateJSON(): void; /** Re-renders the control with the report at that instant. - * @returns {void} - */ + * @returns {void} + */ refreshControl(): void; /** Returns the OlapReport string maintained along with the axis elements information. - * @returns {string} - */ + * @returns {string} + */ getOlapReport(): string; /** Sets the OlapReport string along with the axis information and maintains it in a property. - * @returns {void} - */ + * @returns {void} + */ setOlapReport(): void; /** Returns the JSON records formed to render the control. - * @returns {Array} - */ + * @returns {Array} + */ getJSONRecords(): any[]; /** Sets the JSON records formed to render the control to a property. - * @returns {void} - */ + * @returns {void} + */ setJSONRecords(): void; } export namespace PivotClient { @@ -28815,126 +28815,126 @@ export namespace PivotClient { export interface Model { /** Sets the mode for the PivotClient widget for binding either OLAP or Relational data source. - * @Default {ej.Pivot.AnalysisMode.Pivot} - */ + * @Default {ej.Pivot.AnalysisMode.Pivot} + */ analysisMode?: ej.Pivot.AnalysisMode|string; /** Allows the user to set the specific chart type for PivotChart inside PivotClient widget. - * @Default {ej.PivotChart.ChartTypes.Column} - */ + * @Default {ej.PivotChart.ChartTypes.Column} + */ chartType?: ej.PivotChart.ChartTypes|string; /** Allows the user to set the content on exporting the PivotClient widget. - * @Default {ej.PivotClient.ClientExportMode.ChartAndGrid} - */ + * @Default {ej.PivotClient.ClientExportMode.ChartAndGrid} + */ clientExportMode?: ej.PivotClient.ClientExportMode|string; /** Specifies the CSS class to PivotClient to achieve custom theme. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ cssClass?: string; /** Object utilized to pass additional information between client-end and service-end when the control functions in server-mode. - * @Default {{}} - */ + * @Default {{}} + */ customObject?: any; /** Initializes the data source for the PivotClient widget, when it functions completely on client-side. - * @Default {{}} - */ + * @Default {{}} + */ dataSource?: DataSource; /** Allows the user to customize the widget's layout and appearance. - * @Default {{}} - */ + * @Default {{}} + */ displaySettings?: DisplaySettings; /** Enables the splitter option for resizing the elements inside the control. - * @Default {false} - */ + * @Default {false} + */ enableSplitter?: boolean; /** Enables the advanced filtering options Value Filtering, Label Filtering and Sorting for each dimensions on binding OLAP data in server mode. - * @Default {false} - */ + * @Default {false} + */ enableAdvancedFilter?: boolean; /** Allows the user to refresh the control on-demand and not during every UI operation. - * @Default {false} - */ + * @Default {false} + */ enableDeferUpdate?: boolean; /** Lets the user to save and load reports in a customized way with the help of events. - * @Default {false} - */ + * @Default {false} + */ enableLocalStorage?: boolean; /** Allows the user to enable paging for both the PivotChart and PivotGrid components for the ease of viewing large data. - * @Default {false} - */ + * @Default {false} + */ enablePaging?: boolean; /** Allows the user to include the PivotTreeMap component as one of the chart types. - * @Default {false} - */ + * @Default {false} + */ enablePivotTreeMap?: boolean; /** Allows the user to view the layout of PivotClient from right to left. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Enables/disables the visibility of measure group selector drop-down in Cube Browser. - * @Default {false} - */ + * @Default {false} + */ enableMeasureGroups?: boolean; /** Allows the user to enable virtual scrolling for both the PivotChart and PivotGrid components for the ease of viewing large data. - * @Default {false} - */ + * @Default {false} + */ enableVirtualScrolling?: boolean; /** Enables/Disables paging in Member Editor for viewing the large count of members in pages. - * @Default {false} - */ + * @Default {false} + */ enableMemberEditorPaging?: boolean; /** Allows the user to set the number of members to be displayed in each page of Member Editor on applying paging in it. - * @Default {100} - */ + * @Default {100} + */ memberEditorPageSize?: number; /** Sets the summary layout for PivotGrid. Following are the ways in which summary can be positioned: normal summary (bottom), top summary, no summary and excel-like summary. - * @Default {ej.PivotGrid.Layout.Normal} - */ + * @Default {ej.PivotGrid.Layout.Normal} + */ gridLayout?: ej.PivotGrid.Layout|string; /** Allows the user to enable PivotClientĂ¢â‚¬â„¢s responsiveness in the browser layout. - * @Default {false} - */ + * @Default {false} + */ isResponsive?: boolean; /** Allows the user to set the localized language for the widget. - * @Default {en-US} - */ + * @Default {en-US} + */ locale?: string; /** Sets the mode for the PivotClient widget for binding data source either in server-side or client-side. - * @Default {ej.Pivot.OperationalMode.ClientMode} - */ + * @Default {ej.Pivot.OperationalMode.ClientMode} + */ operationalMode?: ej.Pivot.OperationalMode|string; /** Allows the user to set custom name for the methods at service-end, communicated during AJAX post. - * @Default {{}} - */ + * @Default {{}} + */ serviceMethodSettings?: ServiceMethodSettings; /** Sets the title for PivotClient widget. - */ + */ title?: string; /** Connects the service using the specified URL for any server updates. - */ + */ url?: string; /** Triggers when it reaches client-side after any AJAX request. */ @@ -28977,584 +28977,584 @@ export interface Model { export interface AfterServiceInvokeEventArgs { /** returns the current action of PivotClient control. - */ + */ action?: string; /** returns the custom object bounds with PivotClient control. - */ + */ customObject?: any; /** returns the HTML element of PivotClient control. - */ + */ element?: any; } export interface BeforeServiceInvokeEventArgs { /** returns the current action of PivotClient control. - */ + */ action?: string; /** returns the custom object bounds with PivotClient control. - */ + */ customObject?: any; /** returns the HTML element of PivotClient control. - */ + */ element?: any; } export interface SaveReportEventArgs { /** returns the current instance of PivotClient control. - */ + */ targetControl?: any; /** returns the object which holds the necessary parameters required for saving the report collection. - */ + */ saveReportSetting?: any; } export interface LoadReportEventArgs { /** returns the current instance of PivotClient control. - */ + */ targetControl?: any; /** returns the object which holds the necessary parameters required for loading a report collection from database. - */ + */ loadReportSetting?: any; } export interface FetchReportEventArgs { /** returns the current instance of PivotClient control. - */ + */ targetControl?: any; /** returns the object which holds the necessary parameters required for fetching the report names stored in database. - */ + */ fetchReportSetting?: any; } export interface BeforeExportEventArgs { /** holds the url of the service method responsible for exporting the PivotClient control. - */ + */ url?: string; /** holds the name of the file to be exported. - */ + */ fileName?: string; } export interface ChartLoadEventArgs { /** returns the current action of PivotChart control. - */ + */ action?: string; /** returns the custom object bound with PivotChart control. - */ + */ customObject?: any; /** returns the HTML element of PivotChart control. - */ + */ element?: any; } export interface TreeMapLoadEventArgs { /** returns the current action of PivotTreeMap control. - */ + */ action?: string; /** returns the custom object bound with PivotTreeMap control. - */ + */ customObject?: any; /** returns the HTML element of PivotTreeMap control. - */ + */ element?: any; } export interface LoadEventArgs { /** returns the HTML element of PivotClient component. - */ + */ element?: any; /** returns the custom object bound with PivotTreeMap control. - */ + */ customObject?: any; } export interface RenderCompleteEventArgs { /** returns the HTML element of PivotClient component. - */ + */ element?: any; /** returns the custom object bound with PivotTreeMap control. - */ + */ customObject?: any; } export interface RenderFailureEventArgs { /** returns the custom object bound with the control. - */ + */ customObject?: any; /** returns the HTML element of PivotClient control. - */ + */ element?: any; /** returns the error message with error code. - */ + */ message?: string; } export interface RenderSuccessEventArgs { /** returns the object of PivotClient control at that instant. - */ + */ args?: any; } export interface DataSourceColumnsAdvancedFilter { /** Allows the user to provide level unique name to perform advanced filtering. - */ + */ name?: string; /** Allows the user to set the operator to perform Label Filtering. - * @Default {none} - */ + * @Default {none} + */ labelFilterOperator?: string; /** Allows the user to set the operator to perform Value Filtering. - * @Default {none} - */ + * @Default {none} + */ valueFilterOperator?: string; /** Allows the user to set the filtering type while performing advanced filtering. - */ + */ advancedFilterType?: string; /** In case of value filtering, this property contains the measure name to which the filter is applied. - */ + */ measure?: string; /** Allows the user to hold the filter operand values in advanced filtering. - */ + */ values?: any[]; } export interface DataSourceColumnsFilterItems { /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ filterType?: ej.PivotAnalysis.FilterType|string; /** Contains the collection of items to be included/excluded among the field members. - * @Default {[]} - */ + * @Default {[]} + */ values?: any[]; } export interface DataSourceColumn { /** Allows the user to bind the item by using its unique name as field name. - */ + */ fieldName?: string; /** Allows the user to set the display caption for an item. - */ + */ fieldCaption?: string; /** Allows the user to filter the report by default using advanced filtering (excel-like) option for OLAP data source in client-mode. - * @Default {[]} - */ + * @Default {[]} + */ advancedFilter?: DataSourceColumnsAdvancedFilter[]; /** Allows the user to indicate whether the added item is a named set or not. - * @Default {false} - */ + * @Default {false} + */ isNamedSets?: boolean; /** Shows/Hides the sub-total of the field in PivotGrid. - * @Default {true} - */ + * @Default {true} + */ showSubTotal?: boolean; /** Allows the user to set the sorting order of the members of the field. - * @Default {ej.PivotAnalysis.SortOrder.Ascending} - */ + * @Default {ej.PivotAnalysis.SortOrder.Ascending} + */ sortOrder?: ej.PivotAnalysis.SortOrder|string; /** Contains the list of members need to be drilled down by default in the field. - * @Default {[]} - */ + * @Default {[]} + */ drilledItems?: any[]; /** Applies filter to the field members. - * @Default {null} - */ + * @Default {null} + */ filterItems?: DataSourceColumnsFilterItems; } export interface DataSourceRowsAdvancedFilter { /** Allows the user to provide level unique name to perform advanced filtering. - */ + */ name?: string; /** Allows the user to set the operator to perform Label Filtering. - * @Default {none} - */ + * @Default {none} + */ labelFilterOperator?: string; /** Allows the user to set the operator to perform Value Filtering. - * @Default {none} - */ + * @Default {none} + */ valueFilterOperator?: string; /** Allows the user to set the filtering type while performing advanced filtering. - */ + */ advancedFilterType?: string; /** In case of value filtering, this property contains the measure name to which the filter is applied. - */ + */ measure?: string; /** Allows the user to hold the filter operand values in advanced filtering. - */ + */ values?: any[]; } export interface DataSourceRowsFilterItems { /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ filterType?: ej.PivotAnalysis.FilterType|string; /** Contains the collection of items to be included/excluded among the field members. - * @Default {[]} - */ + * @Default {[]} + */ values?: any[]; } export interface DataSourceRow { /** Allows the user to bind the item by using its unique name as field name. - */ + */ fieldName?: string; /** Allows the user to set the display caption for an item. - */ + */ fieldCaption?: string; /** Allows the user to filter the report by default using advanced filtering (excel-like) option for OLAP data source in client-mode. - * @Default {[]} - */ + * @Default {[]} + */ advancedFilter?: DataSourceRowsAdvancedFilter[]; /** Allows the user to indicate whether the added item is a named set or not. - * @Default {false} - */ + * @Default {false} + */ isNamedSets?: boolean; /** Shows/Hides the sub-total of the field. - * @Default {true} - */ + * @Default {true} + */ showSubTotal?: boolean; /** Allows the user to set the sorting order of the members of the field. - * @Default {ej.PivotAnalysis.SortOrder.Ascending} - */ + * @Default {ej.PivotAnalysis.SortOrder.Ascending} + */ sortOrder?: ej.PivotAnalysis.SortOrder|string; /** Contains the list of members need to be drilled down by default in the field. - * @Default {[]} - */ + * @Default {[]} + */ drilledItems?: any[]; /** Applies filter to the field members. - * @Default {null} - */ + * @Default {null} + */ filterItems?: DataSourceRowsFilterItems; } export interface DataSourceValuesMeasure { /** Allows the user to bind the measure from OLAP datasource by using its unique name as field name. - */ + */ fieldName?: string; } export interface DataSourceValue { /** Allows the user to bind the item by using its unique name as field name for Relational datasource. - */ + */ fieldName?: string; /** Allows the user to set the display caption for an item for Relational datasource. - */ + */ fieldCaption?: string; /** This holds the list of unique names of measures to bind them from the OLAP cube. - * @Default {[]} - */ + * @Default {[]} + */ measures?: DataSourceValuesMeasure[]; /** Allows to set the axis name to place the measures items. - * @Default {rows} - */ + * @Default {rows} + */ axis?: string; /** Indicates whether the field is a calculated field or not with Relational datasource. - * @Default {false} - */ + * @Default {false} + */ isCalculatedField?: boolean; /** Allows to set the type of PivotGrid summary calculation for the value field with Relational datasource. - * @Default {ej.PivotAnalysis.SummaryType.Sum} - */ + * @Default {ej.PivotAnalysis.SummaryType.Sum} + */ summaryType?: ej.PivotAnalysis.SummaryType|string; /** Allows to set the format of the values. - */ + */ format?: string; /** This property sets type of display of date. - */ + */ formatString?: string; /** Allows to set the formula for calculation of values for calculated members in Relational datasource. - */ + */ formula?: string; } export interface DataSourceFiltersFilterItems { /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ filterType?: ej.PivotAnalysis.FilterType|string; /** Contains the collection of items to be included/excluded among the field members. - * @Default {[]} - */ + * @Default {[]} + */ values?: any[]; } export interface DataSourceFilter { /** Allows the user to bind the item by using its unique name as field name. - */ + */ fieldName?: string; /** Allows the user to set the display name for an item. - */ + */ fieldCaption?: string; /** Applies filter to the field members. - * @Default {null} - */ + * @Default {null} + */ filterItems?: DataSourceFiltersFilterItems; } export interface DataSourcePagerOptions { /** Allows to set the number of categorical columns to be displayed in each page on applying paging. - * @Default {0} - */ + * @Default {0} + */ categoricalPageSize?: number; /** Allows to set the number of series rows to be displayed in each page on applying paging. - * @Default {0} - */ + * @Default {0} + */ seriesPageSize?: number; /** Allows to set the page number in categorical axis to be loaded by default. - * @Default {1} - */ + * @Default {1} + */ categoricalCurrentPage?: number; /** Allows to set the page number in series axis to be loaded by default. - * @Default {1} - */ + * @Default {1} + */ seriesCurrentPage?: number; } export interface DataSource { /** Lists out the items to be arranged in columns section of PivotClient. - * @Default {[]} - */ + * @Default {[]} + */ columns?: DataSourceColumn[]; /** Lists out the items to be arranged in rows section of PivotClient. - * @Default {[]} - */ + * @Default {[]} + */ rows?: DataSourceRow[]; /** Lists out the items which supports calculation in PivotClient. - * @Default {[]} - */ + * @Default {[]} + */ values?: DataSourceValue[]; /** Lists out the items which supports filtering of values without displaying the members in UI in PivotClient. - * @Default {[]} - */ + * @Default {[]} + */ filters?: DataSourceFilter[]; /** Contains the respective cube name from OLAP database as string type. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ cube?: string; /** Provides the raw data source for the PivotClient. - * @Default {null} - */ + * @Default {null} + */ data?: any; /** In connection with an OLAP database, this property contains the database name as string to fetch the data from the given connection string. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ catalog?: string; /** Allows user to filter the members (by its name and values) through advanced filtering (excel-like) option in client-mode. - * @Default {false} - */ + * @Default {false} + */ enableAdvancedFilter?: boolean; /** Sets a name to the report bound to the control. - */ + */ reportName?: string; /** Allows to set the page size and current page number for each axis on applying paging. - * @Default {{}} - */ + * @Default {{}} + */ pagerOptions?: DataSourcePagerOptions; } export interface DisplaySettings { /** Lets the user to customize the display of PivotChart and PivotGrid widgets, either in tabs or tiles. - * @Default {ej.PivotClient.ControlPlacement.Tab} - */ + * @Default {ej.PivotClient.ControlPlacement.Tab} + */ controlPlacement?: ej.PivotClient.ControlPlacement|string; /** Lets the user to set either Chart or Grid as the start-up widget. - * @Default {ej.PivotClient.DefaultView.Grid} - */ + * @Default {ej.PivotClient.DefaultView.Grid} + */ defaultView?: ej.PivotClient.DefaultView|string; /** Lets the user to have an option for switching to full screen view of PivotChart and PivotGrid from default view in PivotClient. - * @Default {false} - */ + * @Default {false} + */ enableFullScreen?: boolean; /** Enables an option to enhance the space for PivotGrid and PivotChart by hiding Cube Browser and Axis Element Builder. - * @Default {false} - */ + * @Default {false} + */ enableTogglePanel?: boolean; /** Sets the display mode (Only Chart/Only Grid/Both) in PivotClient. - * @Default {ej.PivotClient.DisplayMode.ChartAndGrid} - */ + * @Default {ej.PivotClient.DisplayMode.ChartAndGrid} + */ mode?: ej.PivotClient.DisplayMode|string; } export interface ServiceMethodSettings { /** Allows the user to set the custom name for the service method responsible for updating the entire report and widget, while changing the Cube. - * @Default {CubeChanged} - */ + * @Default {CubeChanged} + */ cubeChanged?: string; /** Allows the user to set the custom name for the service method responsible for exporting. - * @Default {Export} - */ + * @Default {Export} + */ exportPivotClient?: string; /** Allows the user to set the custom name for the service method responsible to get the members for the tree-view, inside member-editor dialog. - * @Default {FetchMemberTreeNodes} - */ + * @Default {FetchMemberTreeNodes} + */ fetchMemberTreeNodes?: string; /** Allows the user to set the custom name for the service method responsible for fetching the report names from the database. - * @Default {FetchReportListFromDB} - */ + * @Default {FetchReportListFromDB} + */ fetchReportList?: string; /** Allows the user to set the custom name for the service method responsible for updating report while filtering members. - * @Default {FilterElement} - */ + * @Default {FilterElement} + */ filterElement?: string; /** Allows the user to set the custom name for the service method responsible for initializing PivotClient. - * @Default {InitializeClient} - */ + * @Default {InitializeClient} + */ initialize?: string; /** Allows the user to set the custom name for the service method responsible for loading a report collection from the database. - * @Default {LoadReportFromDB} - */ + * @Default {LoadReportFromDB} + */ loadReport?: string; /** Allows the user to set the custom name for the service method responsible for retrieving the MDX query for the current report. - * @Default {GetMDXQuery} - */ + * @Default {GetMDXQuery} + */ mdxQuery?: string; /** Allows the user to set the custom name for the service method responsible for updating the tree-view inside Cube Browser, while changing the measure group. - * @Default {MeasureGroupChanged} - */ + * @Default {MeasureGroupChanged} + */ measureGroupChanged?: string; /** Allows the user to set the custom name for the service method responsible to get the child members, on tree-view node expansion. - * @Default {MemberExpanded} - */ + * @Default {MemberExpanded} + */ memberExpand?: string; /** Allows the user to set the custom name for the service method responsible for updating report while dropping a node/SplitButton inside Axis Element Builder. - * @Default {NodeDropped} - */ + * @Default {NodeDropped} + */ nodeDropped?: string; /** Allows the user to set the custom name for the service method responsible for updating report while removing SplitButton from Axis Element Builder. - * @Default {RemoveSplitButton} - */ + * @Default {RemoveSplitButton} + */ removeSplitButton?: string; /** Allows the user to set the custom name for the service method responsible for saving the report collection to database. - * @Default {SaveReportToDB} - */ + * @Default {SaveReportToDB} + */ saveReport?: string; /** Allows the user to set the custom name for the service method responsible for toggling the elements in row and column axes. - * @Default {ToggleAxis} - */ + * @Default {ToggleAxis} + */ toggleAxis?: string; /** Allows the user to set the custom name for the service method responsible for all the toolbar operations. - * @Default {ToolbarOperations} - */ + * @Default {ToolbarOperations} + */ toolbarServices?: string; /** Allows the user to set the custom name for the service method responsible for updating report collection. - * @Default {UpdateReport} - */ + * @Default {UpdateReport} + */ updateReport?: string; /** Allows the user to set the custom name for the service method responsible on navigating between pages in paged PivotClient. - * @Default {Paging} - */ + * @Default {Paging} + */ paging?: string; } @@ -29613,48 +29613,48 @@ class PivotGauge extends ej.Widget { defaults: PivotGauge.Model; /** Performs an asynchronous HTTP (AJAX) request. - * @returns {void} - */ + * @returns {void} + */ doAjaxPost(): void; /** This function is used to refresh the PivotGauge at client-side itself. - * @returns {void} - */ + * @returns {void} + */ refresh(): void; /** This function removes the KPI related images from PivotGauge on binding OLAP datasource. - * @returns {void} - */ + * @returns {void} + */ removeImg(): void; /** This function receives the JSON formatted datasource and renders the PivotGauge control. - * @returns {void} - */ + * @returns {void} + */ renderControlFromJSON(): void; /** Returns the OlapReport string maintained along with the axis elements information. - * @returns {string} - */ + * @returns {string} + */ getOlapReport(): string; /** Sets the OlapReport string along with the axis information and maintains it in a property. - * @returns {void} - */ + * @returns {void} + */ setOlapReport(): void; /** Returns the JSON records formed to render the control. - * @returns {Array} - */ + * @returns {Array} + */ getJSONRecords(): any[]; /** Sets the JSON records to render the control. - * @returns {void} - */ + * @returns {void} + */ setJSONRecords(): void; /** Returns the JSON records required to render the PivotGauge on performing any action with OLAP data source. - * @returns {void} - */ + * @returns {void} + */ getJSONData(): void; } export namespace PivotGauge { @@ -29662,88 +29662,88 @@ export namespace PivotGauge { export interface Model { /** Sets the number of columns to arrange the Pivot Gauges. - * @Default {0} - */ + * @Default {0} + */ columnsCount?: number; /** Specifies the CSS class to PivotGauge to achieve custom theme. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ cssClass?: string; /** Object utilized to pass additional information between client-end and service-end on operating in server mode. - * @Default {{}} - */ + * @Default {{}} + */ customObject?: any; /** Initializes the data source for the PivotGauge widget, when it functions completely on client-side. - * @Default {{}} - */ + * @Default {{}} + */ dataSource?: DataSource; /** Enables/disables the animation of pointer in PivotGauge. - * @Default {false} - */ + * @Default {false} + */ enableAnimation?: boolean; /** Enables/disables tooltip visibility in PivotGauge. - * @Default {false} - */ + * @Default {false} + */ enableTooltip?: boolean; /** Allows the user to view PivotGauge from right to left. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Allows the user to enable PivotGaugeĂ¢â‚¬â„¢s responsiveness in the browser layout. - * @Default {false} - */ + * @Default {false} + */ isResponsive?: boolean; /** Allows the user to change the format of the label values in PivotGauge. - * @Default {null} - */ + * @Default {null} + */ labelFormatSettings?: LabelFormatSettings; /** Allows the user to set the localized language for the widget. - * @Default {en-US} - */ + * @Default {en-US} + */ locale?: string; /** Sets the number of rows to arrange the Pivot Gauges. - * @Default {0} - */ + * @Default {0} + */ rowsCount?: number; /** Sets the scale values such as pointers, indicators, etc... for PivotGauge. - * @Default {{}} - */ + * @Default {{}} + */ scales?: any; /** Allows the user to set the custom name for the methods at service-end, communicated during AJAX post. - * @Default {{}} - */ + * @Default {{}} + */ serviceMethodSettings?: ServiceMethodSettings; /** Enables/disables the header labels in PivotGauge. - * @Default {true} - */ + * @Default {true} + */ showHeaderLabel?: boolean; /** Connects the service using the specified URL for any server updates on server mode operation. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ url?: string; /** Sets the mode for the PivotGauge widget for binding either OLAP or Relational data source. - * @Default {ej.Pivot.AnalysisMode.Pivot} - */ + * @Default {ej.Pivot.AnalysisMode.Pivot} + */ analysisMode?: ej.Pivot.AnalysisMode|string; /** Sets the mode for the PivotGauge widget for binding data source either in server-side or client-side. - * @Default {ej.Pivot.OperationalMode.ClientMode} - */ + * @Default {ej.Pivot.OperationalMode.ClientMode} + */ operationalMode?: ej.Pivot.OperationalMode|string; /** Triggers when it reaches client-side after any AJAX request. */ @@ -29771,264 +29771,264 @@ export interface Model { export interface AfterServiceInvokeEventArgs { /** returns the custom object bound with PivotGauge control. - */ + */ customObject?: any; /** returns the HTML element of PivotGauge control. - */ + */ element?: any; } export interface BeforeServiceInvokeEventArgs { /** returns the custom object bound with PivotGauge control. - */ + */ customObject?: any; /** returns the HTML element of PivotGauge control. - */ + */ element?: any; } export interface BeforePivotEnginePopulateEventArgs { /** returns the current instance of PivotGauge control. - */ + */ gaugeObject?: any; } export interface LoadEventArgs { /** returns the current action of PivotGauge control. - */ + */ action?: string; /** returns the model of PivotGauge control. - */ + */ model?: any; /** returns the HTML element of the widget. - */ + */ element?: any; /** returns the custom object bound to the control. - */ + */ customObject?: any; } export interface RenderCompleteEventArgs { /** returns the custom object bound with PivotGauge control. - */ + */ customObject?: any; /** returns the HTML element of PivotGauge control. - */ + */ element?: any; } export interface RenderFailureEventArgs { /** returns the HTML element of PivotGauge control. - */ + */ element?: any; /** returns the custom object bound with the control. - */ + */ customObject?: any; /** returns the error message with error code. - */ + */ message?: string; } export interface RenderSuccessEventArgs { /** returns the HTML element of PivotGauge control. - */ + */ element?: any; /** returns the custom object bound with the control. - */ + */ customObject?: any; } export interface DataSourceColumnsFilterItems { /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ filterType?: ej.PivotAnalysis.FilterType|string; /** Contains the collection of items to be included/excluded among the field members. - * @Default {[]} - */ + * @Default {[]} + */ values?: any[]; } export interface DataSourceColumn { /** Allows the user to bind the item by using its unique name as field name. - */ + */ fieldName?: string; /** Applies filter to the field members. - * @Default {null} - */ + * @Default {null} + */ filterItems?: DataSourceColumnsFilterItems; } export interface DataSourceRowsFilterItems { /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ filterType?: ej.PivotAnalysis.FilterType|string; /** Contains the collection of items to be included/excluded among the field members. - * @Default {[]} - */ + * @Default {[]} + */ values?: any[]; } export interface DataSourceRow { /** Allows the user to bind the item by using its unique name as field name. - */ + */ fieldName?: string; /** Applies filter to the field members. - * @Default {null} - */ + * @Default {null} + */ filterItems?: DataSourceRowsFilterItems; } export interface DataSourceValuesMeasure { /** Allows the user to bind the measure from OLAP datasource by using its unique name as field name. - */ + */ fieldName?: string; } export interface DataSourceValue { /** Allows the user to bind the item by using its unique name as field name for Relational datasource. - */ + */ fieldName?: string; /** Allows the user to set the display caption for an item for Relational datasource. - */ + */ fieldCaption?: string; /** This holds the list of unique names of measures to bind them from the OLAP cube. - * @Default {[]} - */ + * @Default {[]} + */ measures?: DataSourceValuesMeasure[]; /** Allows to set the axis name to place the measures items. - * @Default {rows} - */ + * @Default {rows} + */ axis?: string; /** Indicates whether the field is a calculated field or not with Relational datasource. - * @Default {false} - */ + * @Default {false} + */ isCalculatedField?: boolean; /** Allows to set the formula for calculation of values for calculated members in Relational datasource. - */ + */ formula?: string; } export interface DataSourceFiltersFilterItems { /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ filterType?: ej.PivotAnalysis.FilterType|string; /** Contains the collection of items to be included/excluded among the field members. - * @Default {[]} - */ + * @Default {[]} + */ values?: any[]; } export interface DataSourceFilter { /** Allows the user to bind the item by using its unique name as field name. - */ + */ fieldName?: string; /** Applies filter to the field members. - * @Default {null} - */ + * @Default {null} + */ filterItems?: DataSourceFiltersFilterItems; } export interface DataSource { /** Contains the respective cube name from OLAP database as string type. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ cube?: string; /** Provides the raw data source for the PivotGauge. - * @Default {null} - */ + * @Default {null} + */ data?: any; /** In connection with an OLAP database, this property contains the database name as string to fetch the data from the given connection string. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ catalog?: string; /** Lists out the items to bind in columns section. - * @Default {[]} - */ + * @Default {[]} + */ columns?: DataSourceColumn[]; /** Lists out the items to bind in rows section. - * @Default {[]} - */ + * @Default {[]} + */ rows?: DataSourceRow[]; /** Lists out the items supports calculation in PivotGauge. - * @Default {[]} - */ + * @Default {[]} + */ values?: DataSourceValue[]; /** Lists out the items which supports filtering of values without displaying the members in UI in PivotGauge. - * @Default {[]} - */ + * @Default {[]} + */ filters?: DataSourceFilter[]; } export interface LabelFormatSettings { /** Allows the user to change the number format of the label values in PivotGauge. - * @Default {ej.PivotGauge.NumberFormat.Default} - */ + * @Default {ej.PivotGauge.NumberFormat.Default} + */ numberFormat?: ej.PivotGauge.NumberFormat|string; /** Allows you to set the number of digits displayed after decimal point. - * @Default {5} - */ + * @Default {5} + */ decimalPlaces?: number; /** Allows you to add a text at the beginning of the label. - */ + */ prefixText?: string; /** Allows you to add text at the end of the label. - */ + */ suffixText?: string; } export interface ServiceMethodSettings { /** Allows the user to set the custom name for the service method responsible for initializing PivotGauge. - * @Default {InitializeGauge} - */ + * @Default {InitializeGauge} + */ initialize?: string; } @@ -30066,43 +30066,43 @@ class PivotTreeMap extends ej.Widget { defaults: PivotTreeMap.Model; /** Performs an asynchronous HTTP (AJAX) request. - * @returns {void} - */ + * @returns {void} + */ doAjaxPost(): void; /** Returns the OlapReport string maintained along with the axis elements information. - * @returns {string} - */ + * @returns {string} + */ getOlapReport(): string; /** Sets the OlapReport string along with the axis information and maintains it in a property. - * @returns {void} - */ + * @returns {void} + */ setOlapReport(): void; /** Returns the JSON records formed to render the control. - * @returns {Array} - */ + * @returns {Array} + */ getJSONRecords(): any[]; /** Sets the JSON records to render the control. - * @returns {void} - */ + * @returns {void} + */ setJSONRecords(): void; /** Renders the control with the pivot engine obtained from OLAP cube. - * @returns {void} - */ + * @returns {void} + */ generateJSON(): void; /** This function receives the JSON formatted datasource to render the PivotTreeMap control. - * @returns {void} - */ + * @returns {void} + */ renderTreeMapFromJSON(): void; /** This function receives the update from service-end, which would be utilized for rendering the widget. - * @returns {void} - */ + * @returns {void} + */ renderControlSuccess(): void; } export namespace PivotTreeMap { @@ -30110,43 +30110,43 @@ export namespace PivotTreeMap { export interface Model { /** Specifies the CSS class to PivotTreeMap to achieve custom theme. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ cssClass?: string; /** Initializes the data source for the PivotTreeMap widget, when it functions completely on client-side. - * @Default {{}} - */ + * @Default {{}} + */ dataSource?: DataSource; /** Object utilized to pass additional information between client-end and service-end. - * @Default {{}} - */ + * @Default {{}} + */ customObject?: any; /** Allows the user to enable PivotTreeMapĂ¢â‚¬â„¢s responsiveness in the browser layout. - * @Default {false} - */ + * @Default {false} + */ isResponsive?: boolean; /** Allows the user to set the localized language for the widget. - * @Default {en-US} - */ + * @Default {en-US} + */ locale?: string; /** Sets the mode for the PivotTreeMap widget for binding data source either in server-side or client-side. - * @Default {ej.Pivot.OperationalMode.ClientMode} - */ + * @Default {ej.Pivot.OperationalMode.ClientMode} + */ operationalMode?: ej.Pivot.OperationalMode|string; /** Allows the user to set custom name for the methods at service-end, communicated on AJAX post. - * @Default {{}} - */ + * @Default {{}} + */ serviceMethodSettings?: ServiceMethodSettings; /** Connects the service using the specified URL for any server updates. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ url?: string; /** Triggers when it reaches client-side after any AJAX request. */ @@ -30177,249 +30177,249 @@ export interface Model { export interface AfterServiceInvokeEventArgs { /** returns the current action of PivotTreeMap control. - */ + */ action?: string; /** returns the custom object bound with PivotTreeMap control. - */ + */ customObject?: any; /** returns the HTML element of PivotTreeMap control. - */ + */ element?: any; } export interface BeforeServiceInvokeEventArgs { /** returns the current action of PivotTreeMap control. - */ + */ action?: string; /** returns the custom object bound with PivotTreeMap control. - */ + */ customObject?: any; /** returns the HTML element of PivotTreeMap control. - */ + */ element?: any; } export interface LoadEventArgs { /** returns the current action of PivotTreeMap control. - */ + */ action?: string; /** returns the custom object bound with PivotTreeMap control. - */ + */ customObject?: any; /** returns the HTML element of PivotTreeMap control. - */ + */ element?: any; } export interface BeforePivotEnginePopulateEventArgs { /** returns the current instance of PivotTreeMap control. - */ + */ treeMapObject?: any; } export interface DrillSuccessEventArgs { /** return the HTML element of PivotTreeMap control. - */ + */ element?: any; } export interface RenderCompleteEventArgs { /** returns the current action of PivotTreeMap control. - */ + */ action?: string; /** returns the custom object bound with PivotTreeMap control. - */ + */ customObject?: any; /** returns the HTML element of PivotTreeMap control. - */ + */ element?: any; } export interface RenderFailureEventArgs { /** returns the current action of PivotTreeMap control. - */ + */ action?: string; /** returns the custom object bound with PivotTreeMap control. - */ + */ customObject?: any; /** returns the HTML element of PivotTreeMap control. - */ + */ element?: any; /** returns the error stack trace of the original exception. - */ + */ message?: string; } export interface RenderSuccessEventArgs { /** returns the current action of PivotTreeMap control. - */ + */ action?: string; /** returns the custom object bound with PivotTreeMap control. - */ + */ customObject?: any; /** returns the HTML element of PivotTreeMap control. - */ + */ element?: any; } export interface DataSourceColumnsFilterItems { /** Contains the collection of items to be excluded among the field members. - * @Default {[]} - */ + * @Default {[]} + */ values?: any[]; } export interface DataSourceColumn { /** Allows the user to bind the item by using its unique name as field name. - */ + */ fieldName?: string; /** Allows the user to indicate whether the added item is a named set or not. - * @Default {false} - */ + * @Default {false} + */ isNamedSets?: boolean; /** Applies filter to the field members. - * @Default {null} - */ + * @Default {null} + */ filterItems?: DataSourceColumnsFilterItems; } export interface DataSourceRowsFilterItems { /** Contains the collection of items to be excluded among the field members. - * @Default {[]} - */ + * @Default {[]} + */ values?: any[]; } export interface DataSourceRow { /** Allows the user to bind the item by using its unique name as field name. - */ + */ fieldName?: string; /** Allows the user to indicate whether the added item is a named set or not. - * @Default {false} - */ + * @Default {false} + */ isNamedSets?: boolean; /** Applies filter to the field members. - * @Default {null} - */ + * @Default {null} + */ filterItems?: DataSourceRowsFilterItems; } export interface DataSourceValuesMeasure { /** Allows the user to bind the measure from OLAP datasource by using its unique name as field name. - */ + */ fieldName?: string; } export interface DataSourceValue { /** This holds the list of unique names of measures to bind them from the OLAP cube. - * @Default {[]} - */ + * @Default {[]} + */ measures?: DataSourceValuesMeasure[]; /** Allows to set the axis name to place the measures items. - * @Default {rows} - */ + * @Default {rows} + */ axis?: string; } export interface DataSourceFiltersFilterItems { /** Contains the collection of items to be excluded among the field members. - * @Default {[]} - */ + * @Default {[]} + */ values?: any[]; } export interface DataSourceFilter { /** Allows the user to bind the item by using its unique name as field name. - */ + */ fieldName?: string; /** Applies filter to the field members. - * @Default {null} - */ + * @Default {null} + */ filterItems?: DataSourceFiltersFilterItems; } export interface DataSource { /** Provides the raw data source for the PivotTreeMap. - * @Default {null} - */ + * @Default {null} + */ data?: any; /** Contains the respective cube name from OLAP database as string type. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ cube?: string; /** In connection with an OLAP database, this property contains the database name as string to fetch the data from the given connection string. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ catalog?: string; /** Lists out the items to be displayed as series of PivotTreeMap. - * @Default {[]} - */ + * @Default {[]} + */ columns?: DataSourceColumn[]; /** Lists out the items to be displayed as segments of PivotTreeMap. - * @Default {[]} - */ + * @Default {[]} + */ rows?: DataSourceRow[]; /** Lists out the items supports calculation in PivotTreeMap. - * @Default {[]} - */ + * @Default {[]} + */ values?: DataSourceValue[]; /** Lists out the items which supports filtering of values without displaying the members in UI in PivotTreeMap. - * @Default {[]} - */ + * @Default {[]} + */ filters?: DataSourceFilter[]; } export interface ServiceMethodSettings { /** Allows the user to set the custom name for the service method responsible for initializing PivotTreeMap. - * @Default {InitializeTreemap} - */ + * @Default {InitializeTreemap} + */ initialize?: string; /** Allows the user to set the custom name for the service method responsible for drilling up/down operation in PivotTreeMap. - * @Default {DrillTreeMap} - */ + * @Default {DrillTreeMap} + */ drillDown?: string; } } @@ -30432,88 +30432,88 @@ class Schedule extends ej.Widget { defaults: Schedule.Model; /** This method is used to delete the appointment based on the guid value or the appointment data passed to it. - * @param {string|any} GUID value of an appointment element or an appointment object - * @returns {void} - */ + * @param {string|any} GUID value of an appointment element or an appointment object + * @returns {void} + */ deleteAppointment(data: string|any): void; /** Destroys the Schedule widget. All the events bound using this._on are unbound automatically and the control is moved to pre-init state. - * @returns {void} - */ + * @returns {void} + */ destroy(): void; /** Exports the appointments from the Schedule control. - * @param {string} It refers the controller action name to redirect. (For MVC) - * @param {string} It refers the server event name.(For ASP) - * @param {string|number} Pass the id of an appointment, in case if a single appointment needs to be exported. Otherwise, it takes the null value. - * @returns {void} - */ + * @param {string} It refers the controller action name to redirect. (For MVC) + * @param {string} It refers the server event name.(For ASP) + * @param {string|number} Pass the id of an appointment, in case if a single appointment needs to be exported. Otherwise, it takes the null value. + * @returns {void} + */ exportSchedule(action: string, serverEvent: string, id: string|number): void; /** Searches and filters the appointments from appointment list of Schedule control. - * @param {Array} Holds array of one or more conditional objects for filtering the appointments based on it. - * @returns {Array} - */ + * @param {Array} Holds array of one or more conditional objects for filtering the appointments based on it. + * @returns {Array} + */ filterAppointments(filterConditions: any[]): any[]; /** Gets the complete appointment list of Schedule control. - * @returns {Array} - */ + * @returns {Array} + */ getAppointments(): any[]; /** Prints the entire Scheduler or a single appointment based on the appointment data passed as an argument to it. Simply calling the print() method, - * without passing any argument will print the entire Scheduler. - * @param {any} Either accepts no arguments at all or else accepts an appointment object. - * @returns {void} - */ + * without passing any argument will print the entire Scheduler. + * @param {any} Either accepts no arguments at all or else accepts an appointment object. + * @returns {void} + */ print(data: any): void; /** Refreshes the Scroller of Scheduler while using it within some other controls or application. - * @returns {void} - */ + * @returns {void} + */ refreshScroller(): void; /** It is used to save the appointment. The appointment object is based on the argument passed to this method. - * @param {any} appointment object which includes appointment details - * @returns {void} - */ + * @param {any} appointment object which includes appointment details + * @returns {void} + */ saveAppointment(appointmentObject: any): void; /** Generate the recurrence rule as a string, based on the repeat options selected. - * @returns {string} - */ + * @returns {string} + */ getRecurrenceRule(): string; /** Retrieves the time slot information (start/end time and resource details) of the given element. - * The parameter is optional - as when no element is passed to it, the currently selected cell information will be retrieved. When multiple cells are selected in the Scheduler, - * it is not necessary to provide the parameter. - * @param {any} TD element object rendered as Scheduler work cell - * @returns {any} - */ + * The parameter is optional - as when no element is passed to it, the currently selected cell information will be retrieved. When multiple cells are selected in the Scheduler, + * it is not necessary to provide the parameter. + * @param {any} TD element object rendered as Scheduler work cell + * @returns {any} + */ getSlotByElement(element: any): any; /** Searches the appointments from the appointment list of Schedule control based on the provided search string in its argument list. - * @param {any|string} Defines the search word or the filter condition, based on which the appointments are filtered from the list. - * @param {string} Defines the field name on which the search is to be made. - * @param {ej.FilterOperators|string} Defines the filterOperator value for the search operation. - * @param {boolean} Defines the ignoreCase value for performing the search operation. - * @returns {Array} - */ + * @param {any|string} Defines the search word or the filter condition, based on which the appointments are filtered from the list. + * @param {string} Defines the field name on which the search is to be made. + * @param {ej.FilterOperators|string} Defines the filterOperator value for the search operation. + * @param {boolean} Defines the ignoreCase value for performing the search operation. + * @returns {Array} + */ searchAppointments(searchString: any|string, field: string, operator: ej.FilterOperators|string, ignoreCase: boolean): any[]; /** Refreshes the entire Schedule control. - * @returns {void} - */ + * @returns {void} + */ refresh(): void; /** Refreshes only the appointment elements within the Schedule control. - * @returns {void} - */ + * @returns {void} + */ refreshAppointments(): void; /** Passes the server-side action and data to the client-side for rendering the modified appointment list on the Schedule control. - * @returns {void} - */ + * @returns {void} + */ notifyChanges(): void; } export namespace Schedule { @@ -30521,292 +30521,292 @@ export namespace Schedule { export interface Model { /** When set to true, Schedule allows the appointments to be dragged and dropped at required time. - * @Default {true} - */ + * @Default {true} + */ allowDragAndDrop?: boolean; /** When set to true, Scheduler allows interaction through keyboard shortcut keys. - * @Default {true} - */ + * @Default {true} + */ allowKeyboardNavigation?: boolean; /** It includes the dataSource option and the fields related to Schedule appointments. The appointment fields within the appointmentSettings can accept both string and object type values. - * To apply validation rules on the appointment window fields, then the appointment fields needs to be defined with object type values. - */ + * To apply validation rules on the appointment window fields, then the appointment fields needs to be defined with object type values. + */ appointmentSettings?: AppointmentSettings; /** Template design that applies on the Schedule appointments. All the field names that are mapped from dataSource - * to the appropriate field properties within the appointmentSettings can be used within the template. - * @Default {null} - */ + * to the appropriate field properties within the appointmentSettings can be used within the template. + * @Default {null} + */ appointmentTemplateId?: string; /** Accepts the custom CSS class name that defines specific user-defined styles and themes to be applied for partial or complete elements of the Schedule. - */ + */ cssClass?: string; /** Sets various categorize colors to the Schedule appointments to differentiate it. - */ + */ categorizeSettings?: CategorizeSettings; /** Sets the height for Schedule cells. - * @Default {20px} - */ + * @Default {20px} + */ cellHeight?: string; /** Sets the width for Schedule cells. - */ + */ cellWidth?: string; /** Holds all options related to the context menu settings of Scheduler. - */ + */ contextMenuSettings?: ContextMenuSettings; /** Sets current date of the Schedule. The Schedule displays initially with the date that is provided here. - * @Default {new Date()} - */ + * @Default {new Date()} + */ currentDate?: any; /** Sets current view of the Schedule. Schedule renders initially with the view that is specified here. The available views are day, week, workweek, month, agenda and - * custom view - from which any one of the required view can be set to the Schedule. It accepts both string or enum values. The enum values that are accepted - * by currentView(ej.Schedule.CurrentView) are as follows, - * @Default {ej.Schedule.CurrentView.Week} - */ + * custom view - from which any one of the required view can be set to the Schedule. It accepts both string or enum values. The enum values that are accepted + * by currentView(ej.Schedule.CurrentView) are as follows, + * @Default {ej.Schedule.CurrentView.Week} + */ currentView?: string|ej.Schedule.CurrentView; /** Sets the date format for Schedule. - */ + */ dateFormat?: string; /** When set to true, shows the previous/next appointment navigator button on the Scheduler. - * @Default {true} - */ + * @Default {true} + */ showAppointmentNavigator?: boolean; /** When set to true, enables the resize behavior of appointments within the Schedule. - * @Default {true} - */ + * @Default {true} + */ enableAppointmentResize?: boolean; /** When set to true, enables the loading of Schedule appointments based on your demand. With this load on demand concept, the data consumption of the Schedule can be limited. - * @Default {false} - */ + * @Default {false} + */ enableLoadOnDemand?: boolean; /** Saves the current model value to browser cookies for state maintenance. When the page gets refreshed, Schedule control values are retained. - * @Default {false} - */ + * @Default {false} + */ enablePersistence?: boolean; /** When set to true, the Schedule layout and behavior changes as per the common RTL conventions. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Sets the end hour time limit to be displayed on the Schedule. - * @Default {24} - */ + * @Default {24} + */ endHour?: number; /** To configure resource grouping on the Schedule. - */ + */ group?: Group; /** Sets the height of the Schedule. Accepts both pixel and percentage values. - * @Default {1120px} - */ + * @Default {1120px} + */ height?: string; /** To define the work hours within the Schedule control. - */ + */ workHours?: WorkHours; /** When set to true, enables the Schedule to observe Daylight Saving Time for supported timezones. - * @Default {false} - */ + * @Default {false} + */ isDST?: boolean; /** When set to true, adapts the Schedule layout to fit the screen size of devices on which it renders. - * @Default {true} - */ + * @Default {true} + */ isResponsive?: boolean; /** Sets the specific culture to the Schedule. - * @Default {en-US} - */ + * @Default {en-US} + */ locale?: string; /** Sets the maximum date limit to display on the Schedule. Setting maxDate with specific date value disallows the Schedule to navigate beyond that date. - * @Default {new Date(2099, 12, 31)} - */ + * @Default {new Date(2099, 12, 31)} + */ maxDate?: any; /** Sets the minimum date limit to display on the Schedule. Setting minDate with specific date value disallows the Schedule to navigate beyond that date. - * @Default {new Date(1900, 01, 01)} - */ + * @Default {new Date(1900, 01, 01)} + */ minDate?: any; /** Sets the mode of Schedule rendering either in a vertical or horizontal direction. It accepts either string("vertical" or "horizontal") or enum values. - * The enum values that are accepted by orientation(ej.Schedule.Orientation) are as follows, - * @Default {ej.Schedule.Orientation.Vertical} - */ + * The enum values that are accepted by orientation(ej.Schedule.Orientation) are as follows, + * @Default {ej.Schedule.Orientation.Vertical} + */ orientation?: string|ej.Schedule.Orientation; /** Holds all the options related to priority settings of the Schedule. - */ + */ prioritySettings?: PrioritySettings; /** When set to true, disables the interaction with the Schedule appointments, simply allowing the date and view navigation to occur. - * @Default {false} - */ + * @Default {false} + */ readOnly?: boolean; /** Holds all the options related to reminder settings of the Schedule. - */ + */ reminderSettings?: ReminderSettings; /** Defines the specific start and end dates to be rendered in the Schedule control. To render such user-specified custom date ranges in the Schedule control, - * set the currentView property to ej.Schedule.CurrentView.CustomView. - * @Default {null} - */ + * set the currentView property to ej.Schedule.CurrentView.CustomView. + * @Default {null} + */ renderDates?: RenderDates; /** Template design that applies on the Schedule resource header. - * @Default {null} - */ + * @Default {null} + */ resourceHeaderTemplateId?: string; /** Holds all the options related to the resources settings of the Schedule. It is a collection of one or more resource objects, where the levels of resources are rendered on the Schedule - * based on the order of the resource data provided within this collection. - * @Default {null} - */ + * based on the order of the resource data provided within this collection. + * @Default {null} + */ resources?: Resource[]; /** When set to true, displays the all-day row cells on the Schedule. - * @Default {true} - */ + * @Default {true} + */ showAllDayRow?: boolean; /** When set to true, displays the current time indicator on the Schedule. - * @Default {true} - */ + * @Default {true} + */ showCurrentTimeIndicator?: boolean; /** When set to true, displays the header bar on the Schedule. - * @Default {true} - */ + * @Default {true} + */ showHeaderBar?: boolean; /** When set to true, displays the location field additionally on Schedule appointment window. - * @Default {false} - */ + * @Default {false} + */ showLocationField?: boolean; /** When set to false, doesn't render the start and end timezone fields on the Schedule appointment window. - * @Default {true} - */ + * @Default {true} + */ showTimeZoneFields?: boolean; /** When set to true, displays the quick window for every single click made on the Schedule cells or appointments. - * @Default {true} - */ + * @Default {true} + */ showQuickWindow?: boolean; /** Sets the start hour time range to be displayed on the Schedule. - * @Default {0} - */ + * @Default {0} + */ startHour?: number; /** Sets either 12 or 24 hour time mode on the Schedule. It accepts either the string value("12" or "24") or the below mentioned enum values. - * The enum values that are accepted by timeMode(ej.Schedule.TimeMode) are as follows, - * @Default {null} - */ + * The enum values that are accepted by timeMode(ej.Schedule.TimeMode) are as follows, + * @Default {null} + */ timeMode?: string|ej.Schedule.TimeMode; /** Sets the timezone for the Schedule. - * @Default {null} - */ + * @Default {null} + */ timeZone?: string; /** Sets the collection of timezone items to be bound to the Schedule. Only the items bound to this property gets listed out in the timezone field of the appointment window. - */ + */ timeZoneCollection?: TimeZoneCollection; /** Defines the view collection to be displayed on the Schedule. By default, it displays all the views namely, Day, Week, WorkWeek and Month. - * @Default {[Day, Week, WorkWeek, Month, Agenda]} - */ + * @Default {[Day, Week, WorkWeek, Month, Agenda]} + */ views?: any[]; /** Sets the width of the Schedule. Accepts both pixel and percentage values. - * @Default {100%} - */ + * @Default {100%} + */ width?: string; /** When set to true, Schedule allows the validation of recurrence pattern to take place before it is being assigned to the appointments. For example, when one of the instance of - * recurrence appointment is dragged beyond the next or previous instance of the same recurrence appointment, a pop-up is displayed with the validation message disallowing the drag functionality. - * @Default {true} - */ + * recurrence appointment is dragged beyond the next or previous instance of the same recurrence appointment, a pop-up is displayed with the validation message disallowing the drag functionality. + * @Default {true} + */ enableRecurrenceValidation?: boolean; /** Sets the week to display more than one week appointment summary. - */ + */ agendaViewSettings?: AgendaViewSettings; /** Sets specific day as the starting day of the week. - * @Default {null} - */ + * @Default {null} + */ firstDayOfWeek?: string; /** Sets different day collection within workWeek view. - * @Default {[Monday, Tuesday, Wednesday, Thursday, Friday]} - */ + * @Default {[Monday, Tuesday, Wednesday, Thursday, Friday]} + */ workWeek?: any[]; /** Allows to pop-up appointment details in a tooltip while hovering over the appointments. - */ + */ tooltipSettings?: TooltipSettings; /** Holds all the options related to the time scale of Scheduler. The timeslots either major or minor slots can be customized with this property. - */ + */ timeScale?: TimeScale; /** When set to true, shows the delete confirmation dialog before deleting an appointment. - * @Default {true} - */ + * @Default {true} + */ showDeleteConfirmationDialog?: boolean; /** Accepts the id value of the template layout defined for the all-day cells and customizes it. - * @Default {null} - */ + * @Default {null} + */ allDayCellsTemplateId?: string; /** Accepts the id value of the template layout defined for the work cells and month cells. - * @Default {null} - */ + * @Default {null} + */ workCellsTemplateId?: string; /** Accepts the id value of the template layout defined for the date header cells and customizes it. - * @Default {null} - */ + * @Default {null} + */ dateHeaderTemplateId?: string; /** when set to false, allows the height of the work-cells to adjust automatically (either expand or collapse) based on the number of appointment count it has. - * @Default {true} - */ + * @Default {true} + */ showOverflowButton?: boolean; /** Allows setting draggable area for the Scheduler appointments. Also, turns on the external drag and drop, when set with some specific external drag area name. - */ + */ appointmentDragArea?: string; /** When set to true, displays the other months days from the current month on the Schedule. - * @Default {true} - */ + * @Default {true} + */ showNextPrevMonth?: boolean; /** Blocks the user-specific time interval on the Scheduler, so that no appointments can be created on that particular time slots. - * It includes the dataSource option and also the fields related to block intervals. - */ + * It includes the dataSource option and also the fields related to block intervals. + */ blockoutSettings?: BlockoutSettings; /** Triggers on the beginning of every action that starts within the Schedule. */ @@ -30903,1219 +30903,1219 @@ export interface Model { export interface ActionBeginEventArgs { /** Returns the current date value. - */ + */ currentDate?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the current view value. - */ + */ currentView?: string; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the action begin request type. - */ + */ requestType?: string; /** Returns the target of the click. - */ + */ target?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the save appointment value. - */ + */ data?: any; /** Returns the id of delete appointment. - */ + */ id?: number; } export interface ActionCompleteEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the data about view change action. - */ + */ data?: any; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the action complete request type. - */ + */ requestType?: string; /** Returns the name of the event. - */ + */ type?: string; /** Returns the appointment data dropped. - */ + */ appointment?: any; } export interface AppointmentClickEventArgs { /** Returns the object of appointmentClick event. - */ + */ object?: any; /** Returns the clicked appointment object. - */ + */ appointment?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the name of the event. - */ + */ type?: string; } export interface BeforeAppointmentRemoveEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the deleted appointment object. - */ + */ appointment?: any; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the name of the Scheduler event. - */ + */ type?: string; } export interface BeforeAppointmentChangeEventArgs { /** Returns the edited appointment object. - */ + */ appointment?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the name of the Scheduler event. - */ + */ type?: string; } export interface AppointmentHoverEventArgs { /** Returns the object of appointmentHover event. - */ + */ object?: any; /** Returns the hovered appointment object. - */ + */ appointment?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the name of the event. - */ + */ type?: string; } export interface BeforeAppointmentCreateEventArgs { /** Returns the appointment object. - */ + */ appointment?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the name of the Scheduler event. - */ + */ type?: string; } export interface AppointmentWindowOpenEventArgs { /** returns the object of appointmentWindowOpen event while selecting the detail option from quick window or edit appointment or edit series option. - */ + */ object?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the end time of the double clicked cell. - */ + */ endTime?: any; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the action name that triggers window open. - */ + */ originalEventType?: string; /** Returns the start time of the double clicked cell. - */ + */ startTime?: any; /** Returns the target of the double clicked cell. - */ + */ target?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the edit appointment object. - */ + */ appointment?: any; /** Returns the edit occurrence option value. - */ + */ edit?: boolean; } export interface BeforeContextMenuOpenEventArgs { /** Returns the object of beforeContextMenuOpen event. - */ + */ object?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the current cell index value. - */ + */ cellIndex?: number; /** Returns the current date value. - */ + */ currentDate?: any; /** Returns the current resource details, when multiple resources are present, otherwise returns null. - */ + */ resources?: any; /** Returns the current appointment details while opening the menu from appointment. - */ + */ appointment?: any; /** Returns the object of before opening menu target. - */ + */ events?: any; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the name of the event. - */ + */ type?: string; } export interface CellClickEventArgs { /** Returns the object of cellClick event. - */ + */ object?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the end time of the clicked cell. - */ + */ endTime?: any; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the start time of the clicked cell. - */ + */ startTime?: any; /** Returns the target of the clicked cell. - */ + */ target?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface CellDoubleClickEventArgs { /** Returns the object of cellDoubleClick event. - */ + */ object?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the end time of the double clicked cell. - */ + */ endTime?: any; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the start time of the double clicked cell. - */ + */ startTime?: any; /** Returns the target of the double clicked cell. - */ + */ target?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface CellHoverEventArgs { /** Returns the object of cellHover event. - */ + */ object?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the index of the hovered cell. - */ + */ cellIndex?: any; /** Returns the current date of the hovered cell. - */ + */ currentDate?: any; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the target of the clicked cell. - */ + */ target?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface CreateEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the name of the Scheduler event. - */ + */ type?: string; } export interface DestroyEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the name of the Scheduler event. - */ + */ type?: string; } export interface DragEventArgs { /** Returns the object of dragOver event. - */ + */ object?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the target of the drag over appointment. - */ + */ target?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface DragStartEventArgs { /** Returns the object of dragStart event. - */ + */ object?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the target of the dragging appointment. - */ + */ target?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface DragStopEventArgs { /** Returns the object of dragDrop event. - */ + */ object?: any; /** Returns the dropped appointment object. - */ + */ appointment?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the name of the event. - */ + */ type?: string; } export interface MenuItemClickEventArgs { /** Returns the object of menuItemClick event. - */ + */ object?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the object of menu item event. - */ + */ events?: any; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the name of the event. - */ + */ type?: string; } export interface NavigationEventArgs { /** Returns the current date object. - */ + */ currentDate?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the current view value. - */ + */ currentView?: string; /** Returns the previous view value. - */ + */ previousView?: string; /** Returns the target of the action. - */ + */ target?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the previous date of the Schedule. - */ + */ previousDate?: any; } export interface QueryCellInfoEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the current appointment data. - */ + */ appointment?: any; /** Returns the currently rendering DOM element. - */ + */ element?: any; /** Returns the name of the currently rendering element on the scheduler. - */ + */ requestType?: string; /** Returns the cell type which is currently rendering on the Scheduler. - */ + */ cellType?: string; /** Returns the start date of the currently rendering appointment. - */ + */ currentAppointmentDate?: any; /** Returns the currently rendering cell information. - */ + */ cell?: any; /** Returns the currently rendering resource details. - */ + */ resource?: any; /** Returns the currently rendering date information. - */ + */ currentDay?: any; } export interface ReminderEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the name of the event. - */ + */ type?: string; /** Returns the appointment object for which the reminder is raised. - */ + */ reminderAppointment?: any; } export interface ResizeEventArgs { /** Returns the object of resizing event. - */ + */ object?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the resize element value. - */ + */ element?: any; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the name of the event. - */ + */ type?: string; } export interface ResizeStartEventArgs { /** Returns the object of resizeStart event. - */ + */ object?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the resize element value. - */ + */ element?: any; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the name of the event. - */ + */ type?: string; } export interface ResizeStopEventArgs { /** Returns the object of resizeStop event. - */ + */ object?: any; /** Returns the resized appointment value. - */ + */ appointment?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the target of the resized appointment. - */ + */ target?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface OverflowButtonClickEventArgs { /** Returns the object consisting of start time, end time and resource value of the underlying cell on which the clicked overflow button is present. - */ + */ object?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the object of menu item event. - */ + */ events?: any; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the name of the event. - */ + */ type?: string; } export interface OverflowButtonHoverEventArgs { /** Returns the object consisting of start time, end time and resource value of the underlying cell on which the overflow button is currently hovered. - */ + */ object?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the object of menu item event. - */ + */ events?: any; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the name of the event. - */ + */ type?: string; } export interface KeyDownEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the object of menu item event. - */ + */ events?: any; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the name of the event. - */ + */ type?: string; } export interface AppointmentCreatedEventArgs { /** Returns the appointment object. - */ + */ appointment?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the name of the Scheduler event. - */ + */ type?: string; } export interface AppointmentChangedEventArgs { /** Returns the edited appointment object. - */ + */ appointment?: any; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the name of the Scheduler event. - */ + */ type?: string; } export interface AppointmentRemovedEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the deleted appointment object. - */ + */ appointment?: any; /** Returns the Schedule model. - */ + */ model?: ej.Schedule.Model; /** Returns the name of the Scheduler event. - */ + */ type?: string; } export interface AppointmentSettings { /** The dataSource option accepts either JSON object collection or DataManager (ej.DataManager) instance that contains Schedule appointments. - * @Default {[]} - */ + * @Default {[]} + */ dataSource?: any|any[]; /** It holds either the ej.Query() object or simply the query string that retrieves the specified records from the table. - * @Default {null} - */ + * @Default {null} + */ query?: string; /** Assign the table name from where the records are to be fetched for the Schedule. - * @Default {null} - */ + * @Default {null} + */ tableName?: string; /** When set to false, doesn't consider the time difference offset calculation on appointment time. - * @Default {true} - */ + * @Default {true} + */ applyTimeOffset?: boolean; /** Binds the id field name in dataSource to the id of Schedule appointments. It denotes the unique id assigned to appointments. - * @Default {null} - */ + * @Default {null} + */ id?: string; /** Binds the name of startTime field in the dataSource with start time of the Schedule appointments. It indicates the date and Time when Schedule appointment actually starts. - * @Default {null} - */ + * @Default {null} + */ startTime?: string; /** Binds the name of endTime field in dataSource with the end time of Schedule appointments. It indicates the date and time when Schedule appointment actually ends. - * @Default {null} - */ + * @Default {null} + */ endTime?: string; /** Binds the name of subject field in the dataSource to appointment Subject. Indicates the Subject or title that gets displayed on Schedule appointments. - * @Default {null} - */ + * @Default {null} + */ subject?: string; /** Binds the description field name in dataSource. It indicates the appointment description. - * @Default {null} - */ + * @Default {null} + */ description?: string; /** Binds the name of recurrence field in dataSource. It indicates whether the appointment is a recurrence appointment or not. - * @Default {null} - */ + * @Default {null} + */ recurrence?: string; /** Binds the name of recurrenceRule field in dataSource. It indicates the recurrence pattern associated with appointments. - * @Default {null} - */ + * @Default {null} + */ recurrenceRule?: string; /** Binds the name of allDay field in dataSource. It indicates whether the appointment is an all-day appointment or not. - * @Default {null} - */ + * @Default {null} + */ allDay?: string; /** Binds one or more fields in resource collection dataSource. It maps the resource field names with appointments denoting the resource of appointments actually belongs. - * @Default {null} - */ + * @Default {null} + */ resourceFields?: string; /** Binds the name of categorize field in dataSource. It indicates the categorize value, red categorize, green, yellow and so on applied to the appointments. - * @Default {null} - */ + * @Default {null} + */ categorize?: string; /** Binds the name of location field in dataSource. It indicates the appointment location. - * @Default {null} - */ + * @Default {null} + */ location?: string; /** Binds the name of the priority field in dataSource. It indicates the priority, high, low, medium and none of the appointments. - * @Default {null} - */ + * @Default {null} + */ priority?: string; /** Binds the name of start timezone field in dataSource. It indicates the timezone of appointment start date. When startTimeZone field is not mentioned, - * the appointment uses the Schedule timeZone or System timeZone. - * @Default {null} - */ + * the appointment uses the Schedule timeZone or System timeZone. + * @Default {null} + */ startTimeZone?: string; /** Binds the name of end timezone field in dataSource. It indicates the timezone of appointment end date. When the endTimeZone field is not mentioned, - * the appointment uses the Schedule timeZone or System timeZone. - * @Default {null} - */ + * the appointment uses the Schedule timeZone or System timeZone. + * @Default {null} + */ endTimeZone?: string; } export interface CategorizeSettings { /** When set to true, enables the multiple selection of categories to be applied for the appointments. - * @Default {false} - */ + * @Default {false} + */ allowMultiple?: boolean; /** When set to true, enables the categories option to be applied for the appointments. - * @Default {false} - */ + * @Default {false} + */ enable?: boolean; /** The dataSource option accepts either the JSON object collection or DataManager [ej.DataManager] instance that contains the categorize data. - */ + */ dataSource?: any[]|any; /** Binds id field name in the dataSource to id of category data. - * @Default {id} - */ + * @Default {id} + */ id?: string; /** Binds text field name in the dataSource to category text. - * @Default {text} - */ + * @Default {text} + */ text?: string; /** Binds color field name in the dataSource to category color. - * @Default {color} - */ + * @Default {color} + */ color?: string; /** Binds fontColor field name in the dataSource to category font. - * @Default {fontColor} - */ + * @Default {fontColor} + */ fontColor?: string; } export interface ContextMenuSettingsMenuItems { /** All the appointment related context menu items are grouped under this appointment menu collection. - */ + */ appointment?: any[]; /** All the Scheduler cell related context menu items are grouped under this cells menu item collection. - */ + */ cells?: any[]; } export interface ContextMenuSettings { /** When set to true, enables the context menu options available for the Schedule cells and appointments. - * @Default {false} - */ + * @Default {false} + */ enable?: boolean; /** Contains all the default context menu options that are applicable for both Schedule cells and appointments. It also supports adding custom menu items to cells or appointment collection. - */ + */ menuItems?: ContextMenuSettingsMenuItems; } export interface Group { /** Holds the array of resource names to be grouped on the Schedule. - */ + */ resources?: any[]; } export interface WorkHours { /** When set to true, highlights the work hours of the Schedule. - * @Default {true} - */ + * @Default {true} + */ highlight?: boolean; /** Sets the start time to depict the start of working or business hour in a day. - * @Default {9} - */ + * @Default {9} + */ start?: number; /** Sets the end time to depict the end of working or business hour in a day. - * @Default {18} - */ + * @Default {18} + */ end?: number; } export interface PrioritySettings { /** When set to true, enables the priority options available for the Schedule appointments. - * @Default {false} - */ + * @Default {false} + */ enable?: boolean; /** The dataSource option can accept the JSON object collection that contains the priority related data. - * @Default {{% highlight js%}[{ text: None, value: none },{ text: High, value: high },{ text: Medium, value: medium },{ text: Low, value: low }]{% endhighlight %}} - */ + * @Default {{% highlight js%}[{ text: None, value: none },{ text: High, value: high },{ text: Medium, value: medium },{ text: Low, value: low }]{% endhighlight %}} + */ dataSource?: any|any[]; /** Binds text field name in the dataSource to prioritySettings text. These text gets listed out in priority field of the appointment window. - * @Default {text} - */ + * @Default {text} + */ text?: string; /** Binds value field name in the dataSource to prioritySettings value. These field names usually accepts four priority values by default, high, low, medium and none. - * @Default {value} - */ + * @Default {value} + */ value?: string; /** Allows priority field customization in the appointment window to add custom icons denoting the priority level for the appointments. - * @Default {null} - */ + * @Default {null} + */ template?: string; } export interface ReminderSettings { /** When set to true, enables the reminder option available for the Schedule appointments. - * @Default {false} - */ + * @Default {false} + */ enable?: boolean; /** Sets the timing, when the reminders are to be alerted for the Schedule appointments. - * @Default {5} - */ + * @Default {5} + */ alertBefore?: number; } export interface RenderDates { /** Sets the start of custom date range to be rendered in the Schedule. - * @Default {null} - */ + * @Default {null} + */ start?: any; /** Sets the end limit of the custom date range. - * @Default {null} - */ + * @Default {null} + */ end?: any; } export interface ResourcesResourceSettings { /** The dataSource option accepts either JSON object collection or DataManager (ejDataManager) instance that contains the resources related data. - * @Default {[]} - */ + * @Default {[]} + */ dataSource?: any|any[]; /** Binds text field name in the dataSource to resourceSettings text. These text gets listed out in resources field of the appointment window. - * @Default {null} - */ + * @Default {null} + */ text?: string; /** Binds id field name in the dataSource to resourceSettings id. - * @Default {null} - */ + * @Default {null} + */ id?: string; /** Binds groupId field name in the dataSource to resourceSettings groupId. - * @Default {null} - */ + * @Default {null} + */ groupId?: string; /** Binds color field name in the dataSource to resourceSettings color. The color specified here gets applied to the Schedule appointments denoting to the resource it belongs. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Binds the starting work hour field name in the dataSource. It's optional, but providing it with some numeric value will set the starting work hour for specific resources. - * @Default {null} - */ + * @Default {null} + */ start?: string; /** Binds the end work hour field name in the dataSource. It's optional, but providing it with some numeric value will set the end work hour for specific resources. - * @Default {null} - */ + * @Default {null} + */ end?: string; /** Binds the resources working days field name in the dataSource. It's optional, and accepts the array of strings (week day names). When provided with specific collection of - * days (array of day names), only those days will render for the specific resources. - * @Default {null} - */ + * days (array of day names), only those days will render for the specific resources. + * @Default {null} + */ workWeek?: string; /** Binds appointmentClass field name in the dataSource. It applies custom CSS class name to appointments depicting to the resource it belongs. - * @Default {null} - */ + * @Default {null} + */ appointmentClass?: string; } export interface Resource { /** It holds the name of the resource field to be bound to the Schedule appointments that contains the resource Id. - * @Default {null} - */ + * @Default {null} + */ field?: string; /** It holds the title name of the resource field to be displayed on the Schedule appointment window. - * @Default {null} - */ + * @Default {null} + */ title?: string; /** A unique resource name that is used for differentiating various resource objects while grouping it in various levels. - * @Default {null} - */ + * @Default {null} + */ name?: string; /** When set to true, allows multiple selection of resource names, thus creating multiple instances of same appointment for the selected resources. - * @Default {false} - */ + * @Default {false} + */ allowMultiple?: boolean; /** It holds the field names of the resources to be bound to the Schedule and also the dataSource. - */ + */ resourceSettings?: ResourcesResourceSettings; } export interface TimeZoneCollection { /** Sets the collection of timezone items to the dataSource that accepts either JSON object collection or DataManager (ej.DataManager) instance that contains Schedule timezones. - */ + */ dataSource?: any; /** Binds text field name in the dataSource to timeZoneCollection text. These text gets listed out in the timezone fields of the appointment window. - * @Default {text} - */ + * @Default {text} + */ text?: string; /** Binds id field name in the dataSource to timeZoneCollection id. - * @Default {id} - */ + * @Default {id} + */ id?: string; /** Binds value field name in the dataSource to timeZoneCollection value. - * @Default {value} - */ + * @Default {value} + */ value?: string; } export interface AgendaViewSettings { /** You can display the summary of multiple week's appointment by setting this value. - * @Default {7} - */ + * @Default {7} + */ daysInAgenda?: number; /** You can customize the Date column display based on the requirement. - * @Default {null} - */ + * @Default {null} + */ dateColumnTemplateId?: string; /** You can customize the time column display based on the requirement. - * @Default {null} - */ + * @Default {null} + */ timeColumnTemplateId?: string; } export interface TooltipSettings { /** Enables or disables the tooltip display. - * @Default {false} - */ + * @Default {false} + */ enable?: boolean; /** Template design that customizes the tooltip. All the field names that are mapped from dataSource to the appropriate field properties within - * the appointmentSettings can be accessed within the template. - * @Default {null} - */ + * the appointmentSettings can be accessed within the template. + * @Default {null} + */ templateId?: string; } export interface TimeScale { /** When set to true, displays the time slots on the Scheduler. - * @Default {true} - */ + * @Default {true} + */ enable?: boolean; /** When set with some specific value, defines the number of time divisions split per hour(as per value given for the majorTimeSlot). Those time divisions are meant to be the minor slots. - * @Default {2} - */ + * @Default {2} + */ minorSlotCount?: number; /** Accepts the value in minutes. When provided with specific value, displays the appropriate time interval on the Scheduler - * @Default {60} - */ + * @Default {60} + */ majorSlot?: number; /** Template design that customizes the timecells (minor slots) that are partitioned based on minorSlotCount. Accepts id value of the template defined for minor time slots. - * @Default {null} - */ + * @Default {null} + */ minorSlotTemplateId?: string; /** Template design that customizes the timecells (major slots). Accepts id value of the template defined for major time slots. - * @Default {null} - */ + * @Default {null} + */ majorSlotTemplateId?: string; } export interface BlockoutSettings { /** When set to true, enables the blockout option to be applied on the Scheduler cells. - * @Default {false} - */ + * @Default {false} + */ enable?: boolean; /** Template design that applies on the Schedule block intervals. All the field names that are mapped from dataSource to the appropriate field - * properties within the blockoutSettings can be used within the template. - * @Default {null} - */ + * properties within the blockoutSettings can be used within the template. + * @Default {null} + */ templateId?: string; /** The dataSource option accepts either JSON object collection or DataManager (ej.DataManager) instance that contains Schedule block intervals. - * @Default {[]} - */ + * @Default {[]} + */ dataSource?: any|any[]; /** It holds either the ej.Query() object or simply the query string that retrieves the specified records from the table. - * @Default {null} - */ + * @Default {null} + */ query?: string; /** Assign the table name from where the records are to be fetched for the Schedule. - * @Default {null} - */ + * @Default {null} + */ tableName?: string; /** Binds the id field name in dataSource to the id of block time interval. It denotes the unique id assigned to each of the block records. - * @Default {null} - */ + * @Default {null} + */ id?: string; /** Binds the name of startTime field in the dataSource with start time of block time interval. It indicates the date and time, when the block interval actually starts in the Scheduler. - * @Default {null} - */ + * @Default {null} + */ startTime?: string; /** Binds the name of endTime field in dataSource with the end time of block time interval. It indicates the date and time, when the block interval actually ends in the Scheduler. - * @Default {null} - */ + * @Default {null} + */ endTime?: string; /** Binds the name of subject field in the dataSource to block time Subject. Indicates the Subject or title that gets displayed on the Schedule block intervals. - * @Default {null} - */ + * @Default {null} + */ subject?: string; /** Binds the name of isBlockAppointment field in dataSource. When set to true, disables the appointments that lies on the blocked area and restrict to perform CRUD operations in it. - * @Default {null} - */ + * @Default {null} + */ isBlockAppointment?: string; /** Binds the name of isAllDay field in dataSource. It indicates whether an entire day is blocked or not. - * @Default {null} - */ + * @Default {null} + */ isAllDay?: string; /** Binds the name of resourceId field in dataSource. Specifies the id of the resources, to which the time intervals are needed to be blocked. - * @Default {null} - */ + * @Default {null} + */ resourceId?: string; /** Binds the name of customStyle field in dataSource. It applies the custom CSS to the block intervals. - * @Default {null} - */ + * @Default {null} + */ customStyle?: string; } @@ -32170,22 +32170,22 @@ class RecurrenceEditor extends ej.Widget { defaults: RecurrenceEditor.Model; /** Generates the recurrence rule with the options selected within the Recurrence Editor. - * @returns {String} - */ + * @returns {String} + */ getRecurrenceRule(): string; /** Generates the collection of date, that lies within the selected recurrence start and end date for which the recurrence pattern applies. - * @param {string} It refers the recurrence rule. - * @param {any} It refers the start date of the recurrence. - * @returns {any} - */ + * @param {string} It refers the recurrence rule. + * @param {any} It refers the start date of the recurrence. + * @returns {any} + */ recurrenceDateGenerator(recurrenceString: string, startDate: any): any; /** It splits and returns the recurrence rule string into object collection. - * @param {string} It refers the recurrence rule string. - * @param {any} It refers the appointment dates (ExDate) to be excluded - * @returns {any} - */ + * @param {string} It refers the recurrence rule string. + * @param {any} It refers the appointment dates (ExDate) to be excluded + * @returns {any} + */ recurrenceRuleSplit(recurrenceRule: string, exDate: any): any; } export namespace RecurrenceEditor { @@ -32193,59 +32193,59 @@ export namespace RecurrenceEditor { export interface Model { /** Defines the collection of recurrence frequencies within Recurrence Editor such as Never, Daily, Weekly, Monthly, Yearly and Every Weekday. - * @Default {[never, daily, weekly, monthly, yearly, everyweekday]} - */ + * @Default {[never, daily, weekly, monthly, yearly, everyweekday]} + */ frequencies?: any[]; /** Sets the starting day of the week. - * @Default {null} - */ + * @Default {null} + */ firstDayOfWeek?: string; /** When set to true, enables the spin button of numeric textboxes within the Recurrence Editor. - * @Default {true} - */ + * @Default {true} + */ enableSpinners?: boolean; /** Sets the start date of the recurrence. The Recurrence Editor initially displays the current date as its start date. - * @Default {new Date()} - */ + * @Default {new Date()} + */ startDate?: any; /** Sets the specific culture to the Recurrence Editor. - * @Default {en-US} - */ + * @Default {en-US} + */ locale?: string; /** Sets the date format for the datepickers available within the Recurrence Editor. - */ + */ dateFormat?: string; /** When set to true, renders the Recurrence Editor options from Right-to-Left direction. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Sets the active/current repeat type(frequency) on Recurrence Editor based on the index value provided. For example, setting the value 1 will initially set the repeat type - * as Daily and display its related options. - * @Default {0} - */ + * as Daily and display its related options. + * @Default {0} + */ selectedRecurrenceType?: number; /** Sets the minimum date limit to display on the datepickers defined within the Recurrence Editor. Setting minDate with specific date value disallows the datepickers within - * Recurrence Editor to navigate beyond that date. - * @Default {new Date(1900, 01, 01)} - */ + * Recurrence Editor to navigate beyond that date. + * @Default {new Date(1900, 01, 01)} + */ minDate?: any; /** Sets the maximum date limit to display on the datepickers used within the Recurrence Editor. Setting maxDate with specific date value disallows the - * datepickers within the Recurrence Editor to navigate beyond that date. - * @Default {new Date(2099, 12, 31)} - */ + * datepickers within the Recurrence Editor to navigate beyond that date. + * @Default {new Date(2099, 12, 31)} + */ maxDate?: any; /** Accepts the custom CSS class name, that defines user-defined styles and themes to be applied on partial or complete elements of the Recurrence Editor. - */ + */ cssClass?: string; /** Triggers whenever any of the Recurrence Editor's value is changed. */ @@ -32255,19 +32255,19 @@ export interface Model { export interface ChangeEventArgs { /** When set to true, event gets canceled. - */ + */ cancel?: boolean; /** Returns the Recurrence Editor model - */ + */ model?: ej.RecurrenceEditor.Model; /** Returns the name of the event - */ + */ type?: string; /** Returns the recurrence rule value. - */ + */ recurrenceRule?: string; } } @@ -32280,103 +32280,103 @@ class Gantt extends ej.Widget { defaults: Gantt.Model; /** To add a new item in Gantt - * @param {any} Item to add in Gantt row. - * @param {string} Defines in which position the row wants to add - * @returns {void} - */ + * @param {any} Item to add in Gantt row. + * @param {string} Defines in which position the row wants to add + * @returns {void} + */ addRecord(data: any, rowPosition: string): void; /** To select cell based on the cell and row index dynamically. - * @param {Array} array of cell indexes to be select - * @param {boolean} Defines that we need to preserve the previously selected cells of not - * @returns {void} - */ + * @param {Array} array of cell indexes to be select + * @param {boolean} Defines that we need to preserve the previously selected cells of not + * @returns {void} + */ selectCells(Indexes: any[], preservePreviousSelectedCell: boolean): void; /** Positions the splitter by the specified column index. - * @param {number} Set the splitter position based on column index. - * @returns {void} - */ + * @param {number} Set the splitter position based on column index. + * @returns {void} + */ setSplitterIndex(index: number): void; /** To cancel the edited state of an item in Gantt - * @returns {void} - */ + * @returns {void} + */ cancelEdit(): void; /** To collapse all the parent items in Gantt - * @returns {void} - */ + * @returns {void} + */ collapseAllItems(): void; /** To delete a selected item in Gantt - * @returns {void} - */ + * @returns {void} + */ deleteItem(): void; /** destroy the Gantt widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. - * @returns {void} - */ + * @returns {void} + */ destroy(): void; /** To Expand all the parent items in Gantt - * @returns {void} - */ + * @returns {void} + */ expandAllItems(): void; /** To expand and collapse an item in Gantt using item's ID - * @param {number} Expand or Collapse a record based on task id. - * @returns {void} - */ + * @param {number} Expand or Collapse a record based on task id. + * @returns {void} + */ expandCollapseRecord(taskId: number): void; /** To hide the column by using header text - * @param {string} you can pass a header text of a column to hide - * @returns {void} - */ + * @param {string} you can pass a header text of a column to hide + * @returns {void} + */ hideColumn(headerText: string): void; /** To indent a selected item in Gantt - * @returns {void} - */ + * @returns {void} + */ indentItem(): void; /** To Open the dialog to add new task to the Gantt - * @returns {void} - */ + * @returns {void} + */ openAddDialog(): void; /** To Open the dialog to edit existing task to the Gantt - * @returns {void} - */ + * @returns {void} + */ openEditDialog(): void; /** To outdent a selected item in Gantt - * @returns {void} - */ + * @returns {void} + */ outdentItem(): void; /** To save the edited state of an item in Gantt - * @returns {void} - */ + * @returns {void} + */ saveEdit(): void; /** To search an item with search string provided at the run time - * @param {string} you can pass a text to search in Gantt Control. - * @returns {void} - */ + * @param {string} you can pass a text to search in Gantt Control. + * @returns {void} + */ searchItem(searchString: string): void; /** To set the grid width in Gantt - * @param {string} you can give either percentage or pixels value - * @returns {void} - */ + * @param {string} you can give either percentage or pixels value + * @returns {void} + */ setSplitterPosition(width: string): void; /** To show the column by using header text - * @param {string} you can pass a header text of a column to show - * @returns {void} - */ + * @param {string} you can pass a header text of a column to show + * @returns {void} + */ showColumn(headerText: string): void; } export namespace Gantt { @@ -32384,495 +32384,495 @@ export namespace Gantt { export interface Model { /** Specifies the fields to be included in the add dialog in Gantt - * @Default {[]} - */ + * @Default {[]} + */ addDialogFields?: any[]; /** Enables or disables the ability to resize column. - * @Default {false} - */ + * @Default {false} + */ allowColumnResize?: boolean; /** Enables or Disables Gantt chart editing in Gantt - * @Default {true} - */ + * @Default {true} + */ allowGanttChartEditing?: boolean; /** Enables or Disables Keyboard navigation in Gantt - * @Default {true} - */ + * @Default {true} + */ allowKeyboardNavigation?: boolean; /** Specifies enabling or disabling multiple sorting for Gantt columns - * @Default {false} - */ + * @Default {false} + */ allowMultiSorting?: boolean; /** Enables or disables the option for multiple exporting - * @Default {false} - */ + * @Default {false} + */ allowMultipleExporting?: boolean; /** Enables or disables the interactive selection of a row. - * @Default {true} - */ + * @Default {true} + */ allowSelection?: boolean; /** Enables or disables sorting. When enabled, we can sort the column by clicking on the column. - * @Default {false} - */ + * @Default {false} + */ allowSorting?: boolean; /** Enables or disables the ability to drag and drop the row interactively to reorder the rows - * @Default {false} - */ + * @Default {false} + */ allowDragAndDrop?: boolean; /** Enable or disable predecessor validation. When it is true, all the task's start and end dates are aligned based on its predecessors start and end dates. - * @Default {true} - */ + * @Default {true} + */ enablePredecessorValidation?: boolean; /** Specifies the baseline background color in Gantt - * @Default {#fba41c} - */ + * @Default {#fba41c} + */ baselineColor?: string; /** Specifies the mapping property path for baseline end date in datasource - */ + */ baselineEndDateMapping?: string; /** Specifies the mapping property path for baseline start date of a task in datasource - */ + */ baselineStartDateMapping?: string; /** Specifies the mapping property path for sub tasks in datasource - */ + */ childMapping?: string; /** To Specify the column fields to be displayed in the dialog while inserting a column using column menu. - * @Default {[]} - */ + * @Default {[]} + */ columnDialogFields?: any[]; /** Specifies the background of connector lines in Gantt - */ + */ connectorLineBackground?: string; /** Specifies the width of the connector lines in Gantt - * @Default {1} - */ + * @Default {1} + */ connectorlineWidth?: number; /** Specify the CSS class for Gantt to achieve custom theme. - */ + */ cssClass?: string; /** Specifies the template for cell tooltip - * @Default {null} - */ + * @Default {null} + */ cellTooltipTemplate?: string; /** Option for customizing the drag tooltip while reordering the rows. - */ + */ dragTooltip?: DragTooltip; /** Collection of data or hierarchical data to represent in Gantt - * @Default {null} - */ + * @Default {null} + */ dataSource?: any[]; /** Specifies the dateFormat for Gantt , given format is displayed in tooltip , Grid . - * @Default {MM/dd/yyyy} - */ + * @Default {MM/dd/yyyy} + */ dateFormat?: string; /** Specifies the mapping property path for duration of a task in datasource - */ + */ durationMapping?: string; /** Specifies the duration unit for each tasks whether days or hours or minutes - * @Default {ej.Gantt.DurationUnit.Day} - */ + * @Default {ej.Gantt.DurationUnit.Day} + */ durationUnit?: ej.Gantt.DurationUnit|string; /** Specifies the fields to be included in the edit dialog in Gantt - * @Default {[]} - */ + * @Default {[]} + */ editDialogFields?: any[]; /** Enables or disables the responsiveness of Gantt - * @Default {false} - */ + * @Default {false} + */ isResponsive?: boolean; /** Option to configure the splitter position. - */ + */ splitterSettings?: SplitterSettings; /** Specifies the editSettings options in Gantt. - */ + */ editSettings?: EditSettings; /** Enables or Disables enableAltRow row effect in Gantt - * @Default {true} - */ + * @Default {true} + */ enableAltRow?: boolean; /** Enables/disables work breakdown structure column. - * @Default {false} - */ + * @Default {false} + */ enableWBS?: boolean; /** Enables/disables WBS predecessor column. - * @Default {false} - */ + * @Default {false} + */ enableWBSPredecessor?: boolean; /** Enables or disables the collapse all records when loading the Gantt. - * @Default {false} - */ + * @Default {false} + */ enableCollapseAll?: boolean; /** Specifies the data source field name to be displayed as left task label - */ + */ leftTaskLabelMapping?: string; /** Specifies the data source field name to be displayed as right task label - */ + */ rightTaskLabelMapping?: string; /** Specifies the template for left task label - */ + */ leftTaskLabelTemplate?: string; /** Specifies the template for right task label - */ + */ rightTaskLabelTemplate?: string; /** Enables or disables the contextmenu for Gantt , when enabled contextmenu appears on right clicking Gantt - * @Default {false} - */ + * @Default {false} + */ enableContextMenu?: boolean; /** Indicates whether we can edit the progress of a task interactively in Gantt. - * @Default {true} - */ + * @Default {true} + */ enableProgressBarResizing?: boolean; /** Enables or disables the option for dynamically updating the Gantt size on window resizing - * @Default {false} - */ + * @Default {false} + */ enableResize?: boolean; /** Enables or disables tooltip while editing (dragging/resizing) the taskbar. - * @Default {true} - */ + * @Default {true} + */ enableTaskbarDragTooltip?: boolean; /** Enables or disables tooltip for taskbar. - * @Default {true} - */ + * @Default {true} + */ enableTaskbarTooltip?: boolean; /** Enables/Disables virtualization for rendering Gantt items. - * @Default {false} - */ + * @Default {false} + */ enableVirtualization?: boolean; /** Specifies the mapping property path for end Date of a task in datasource - */ + */ endDateMapping?: string; /** Specifies whether to highlight the weekends in Gantt . - * @Default {true} - */ + * @Default {true} + */ highlightWeekends?: boolean; /** Collection of holidays with date, background and label information to be displayed in Gantt. - * @Default {[]} - */ + * @Default {[]} + */ holidays?: any[]; /** Specifies whether to include weekends while calculating the duration of a task. - * @Default {true} - */ + * @Default {true} + */ includeWeekend?: boolean; /** Specify the locale for Gantt - * @Default {en-US} - */ + * @Default {en-US} + */ locale?: string; /** Specifies the mapping property path for milestone in datasource - */ + */ milestoneMapping?: string; /** Enables/disables the options for inserting , deleting and renaming columns. - * @Default {false} - */ + * @Default {false} + */ showColumnOptions?: boolean; /** Specifies the template for parent taskbar - */ + */ parentTaskbarTemplate?: string; /** Specifies the nature of a task for calculating the work, and it can fixed duration, fixed work and fixed resource unit - * @Default {ej.Gantt.TaskType.FixedUnit} - */ + * @Default {ej.Gantt.TaskType.FixedUnit} + */ taskType?: ej.Gantt.TaskType|string; /** Specifies the unit for the work involved in a task and it can be day, hour or minute - * @Default {ej.Gantt.WorkUnit.Hour} - */ + * @Default {ej.Gantt.WorkUnit.Hour} + */ workUnit?: ej.Gantt.WorkUnit|string; /** Specifies the task scheduling mode for a project and this will be set to all the tasks available in the project - * @Default {ej.Gantt.TaskSchedulingMode.Auto} - */ + * @Default {ej.Gantt.TaskSchedulingMode.Auto} + */ taskSchedulingMode?: ej.Gantt.TaskSchedulingMode|string; /** Specifies the row selection type. - * @Default {ej.Gantt.SelectionType.Single} - */ + * @Default {ej.Gantt.SelectionType.Single} + */ selectionType?: ej.Gantt.SelectionType|string; /** Specifies the background of parent progressbar in Gantt - */ + */ parentProgressbarBackground?: string; /** Specifies the mapping property path for resource's percent effort involved in a task in datasource - */ + */ resourceUnitMapping?: string; /** Specifies the mapping property path for the task description in datasource - */ + */ notesMapping?: string; /** Specifies the mapping property path for the task scheduling mode for a task in datasource - * @Default {auto} - */ + * @Default {auto} + */ taskSchedulingModeMapping?: string; /** Specifies the mapping property path for task duration unit in datasource - */ + */ durationUnitMapping?: string; /** Specifies the background of parent taskbar in Gantt - */ + */ parentTaskbarBackground?: string; /** Specifies the mapping property path for parent task Id in self reference datasource - */ + */ parentTaskIdMapping?: string; /** Specifies the mapping property path for predecessors of a task in datasource - */ + */ predecessorMapping?: string; /** Specifies the background of progressbar in Gantt - */ + */ progressbarBackground?: string; /** Specified the height of the progressbar in taskbar - * @Default {100} - */ + * @Default {100} + */ progressbarHeight?: number; /** Specifies the template for tooltip on resizing progressbar - * @Default {null} - */ + * @Default {null} + */ progressbarTooltipTemplate?: string; /** Specifies the template ID for customized tooltip for progressbar editing in Gantt - * @Default {null} - */ + * @Default {null} + */ progressbarTooltipTemplateId?: string; /** Specifies the mapping property path for progress percentage of a task in datasource - */ + */ progressMapping?: string; /** It receives query to retrieve data from the table (query is same as SQL). - * @Default {null} - */ + * @Default {null} + */ query?: any; /** Enables or Disables rendering baselines in Gantt , when enabled baseline is rendered in Gantt - * @Default {false} - */ + * @Default {false} + */ renderBaseline?: boolean; /** Enables or disables the schedule date validation while connecting a manually scheduled task with predecessor - * @Default {false} - */ + * @Default {false} + */ validateManualTasksOnLinking?: boolean; /** Specifies the mapping property name for resource ID in resource Collection in Gantt - */ + */ resourceIdMapping?: string; /** Specifies the mapping property path for resources of a task in datasource - */ + */ resourceInfoMapping?: string; /** Specifies the mapping property path for resource name of a task in Gantt - */ + */ resourceNameMapping?: string; /** Collection of data regarding resources involved in entire project - * @Default {[]} - */ + * @Default {[]} + */ resources?: any[]; /** Specifies whether rounding off the day working time edits - * @Default {true} - */ + * @Default {true} + */ roundOffDayworkingTime?: boolean; /** Specifies the height of a single row in Gantt. Also, we need to set same height in the CSS style with class name e-rowcell. - * @Default {30} - */ + * @Default {30} + */ rowHeight?: number; /** Specifies end date of the Gantt schedule. By default, end date will be rounded to its next Saturday. - * @Default {null} - */ + * @Default {null} + */ scheduleEndDate?: string; /** Specifies the options for customizing schedule header. - */ + */ scheduleHeaderSettings?: ScheduleHeaderSettings; /** Specifies start date of the Gantt schedule. By default, start date will be rounded to its previous Sunday. - * @Default {null} - */ + * @Default {null} + */ scheduleStartDate?: string; /** Specifies the selected row Index in Gantt , the row with given index will highlighted - * @Default {-1} - */ + * @Default {-1} + */ selectedRowIndex?: number; /** Enables or disables the column chooser. - * @Default {false} - */ + * @Default {false} + */ showColumnChooser?: boolean; /** Specifies the template for cell tooltip - * @Default {true} - */ + * @Default {true} + */ showGridCellTooltip?: boolean; /** Specifies whether to show grid cell tooltip over expander cell alone. - * @Default {true} - */ + * @Default {true} + */ showGridExpandCellTooltip?: boolean; /** Specifies whether display task progress inside taskbar. - * @Default {true} - */ + * @Default {true} + */ showProgressStatus?: boolean; /** Specifies whether to display resource names for a task beside taskbar. - * @Default {true} - */ + * @Default {true} + */ showResourceNames?: boolean; /** Specifies whether to display task name beside task bar. - * @Default {true} - */ + * @Default {true} + */ showTaskNames?: boolean; /** Specifies the size option of Gantt control. - */ + */ sizeSettings?: SizeSettings; /** Specifies the selected cell information on rendering Gantt. - */ + */ selectedCellIndexes?: SelectedCellIndex[]; /** Specifies the sorting options for Gantt. - */ + */ sortSettings?: SortSettings; /** Specifies splitter position in Gantt. - * @Default {null} - */ + * @Default {null} + */ splitterPosition?: string; /** Specifies the mapping property path for start date of a task in datasource - */ + */ startDateMapping?: string; /** Specifies the options for striplines - * @Default {[]} - */ + * @Default {[]} + */ stripLines?: any[]; /** Specifies the background of the taskbar in Gantt - */ + */ taskbarBackground?: string; /** Specifies the template script for customized tooltip for taskbar editing in Gantt - */ + */ taskbarEditingTooltipTemplate?: string; /** Specifies the template Id for customized tooltip for taskbar editing in Gantt - */ + */ taskbarEditingTooltipTemplateId?: string; /** Specifies the template for tooltip on mouse action on taskbars - */ + */ taskbarTooltipTemplate?: string; /** To Specify the JsRender script Id to customize the task bar with our preference - */ + */ taskbarTemplate?: string; /** To Specify the JsRender script Id to customize the mile stone with our preference - */ + */ milestoneTemplate?: string; /** Enables or disables Gantt to read-only mode - * @Default {false} - */ + * @Default {false} + */ readOnly?: boolean; /** Specifies the template id for tooltip on mouse action on taskbars - */ + */ taskbarTooltipTemplateId?: string; /** Specifies the mapping property path for task Id in datasource - */ + */ taskIdMapping?: string; /** Specifies the mapping property path for task name in datasource - */ + */ taskNameMapping?: string; /** Specifies the toolbarSettings options. - */ + */ toolbarSettings?: ToolbarSettings; /** Specifies the tree expander column in Gantt - * @Default {0} - */ + * @Default {0} + */ treeColumnIndex?: number; /** Specifies the type of selection whether to select row or cell. - * @Default {ej.Gantt.SelectionMode.Row} - */ + * @Default {ej.Gantt.SelectionMode.Row} + */ selectionMode?: ej.Gantt.SelectionMode|string; /** Specifies the weekendBackground color in Gantt - * @Default {#F2F2F2} - */ + * @Default {#F2F2F2} + */ weekendBackground?: string; /** Specifies the working time schedule of day - * @Default {ej.Gantt.workingTimeScale.TimeScale8Hours} - */ + * @Default {ej.Gantt.workingTimeScale.TimeScale8Hours} + */ workingTimeScale?: ej.Gantt.workingTimeScale|string; /** Triggered for every Gantt action before its starts. */ @@ -32954,859 +32954,859 @@ export interface Model { export interface ActionBeginEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the grid model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the current grouped column field name. - */ + */ columnName?: string; /** Returns request type. - */ + */ requestType?: string; /** Returns the direction of sorting ascending or descending - */ + */ columnSortDirection?: string; /** Returns the value of searching element. - */ + */ keyValue?: string; /** Returns the data of deleting element. - */ + */ data?: string; /** Returns selected record index - */ + */ recordIndex?: number; } export interface ActionCompleteEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the grid model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the current grouped column field name. - */ + */ columnName?: string; /** Returns request type. - */ + */ requestType?: string; /** Returns the direction of sorting ascending or descending - */ + */ columnSortDirection?: string; /** Returns the value of searched element. - */ + */ keyValue?: string; /** Returns the data of deleted element. - */ + */ data?: string; /** Returns selected record index - */ + */ recordIndex?: number; } export interface BeginEditEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the row element of editing cell. - */ + */ rowElement?: any; /** Returns the Element of editing cell. - */ + */ cellElement?: any; /** Returns the data of current cell record. - */ + */ data?: any; /** Returns the column Index of cell belongs. - */ + */ columnIndex?: number; } export interface CellSelectingEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the cell index on the selection. - */ + */ cellIndex?: number; /** Returns the row index on the selection - */ + */ rowIndex?: number; /** Returns the selecting cell element - */ + */ targetCell?: any; /** Returns the selecting row element - */ + */ targetRow?: any; /** Returns the selecting record object - */ + */ data?: any; /** Returns the Gantt object Model - */ + */ model?: any; } export interface CellSelectedEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the cell index on the selection. - */ + */ cellIndex?: number; /** Returns the row index on the selection - */ + */ rowIndex?: number; /** Returns the selecting cell element - */ + */ targetCell?: any; /** Returns the selecting row element - */ + */ targetRow?: any; /** Returns the selecting record object - */ + */ data?: any; /** Returns the Gantt object Model - */ + */ model?: any; /** Returns the previously selected row data - */ + */ previousData?: any; /** Returns the previously selected cell index - */ + */ previousCellIndex?: any; /** Returns the previously selected row index - */ + */ previousRowIndex?: any; /** Returns the previously selected cell element - */ + */ previousTargetCell?: any; /** Returns the previously selected row element - */ + */ previousTargetRow?: any; } export interface RowDragEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the row which we start to drag. - */ + */ draggedRow?: any; /** Returns the row index which we start to drag. - */ + */ draggedRowIndex?: number; /** Returns the row on which we are dragging. - */ + */ targetRow?: any; /** Returns the row index on which we are dragging. - */ + */ targetRowIndex?: number; /** Returns that we can drop over that record or not. - */ + */ canDrop?: boolean; /** Returns the Gantt model. - */ + */ model?: any; /** Returns request type. - */ + */ requestType?: string; /** Returns the name of the event. - */ + */ type?: string; } export interface RowDragStartEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the row which we start to drag. - */ + */ draggedRow?: any; /** Returns the row index which we start to drag. - */ + */ draggedRowIndex?: boolean; /** Returns the Gantt model. - */ + */ model?: any; /** Returns request type. - */ + */ requestType?: string; /** Returns the name of the event. - */ + */ type?: string; } export interface RowDragStopEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the row which we start to drag. - */ + */ draggedRow?: any; /** Returns the row index which we start to drag. - */ + */ draggedRowIndex?: number; /** Returns the row which we are dropped to row. - */ + */ targetRow?: any; /** Returns the row index which we are dropped to row. - */ + */ targetRowIndex?: number; /** Returns the Gantt model. - */ + */ model?: any; /** Returns request type. - */ + */ requestType?: string; /** Returns the name of the event. - */ + */ type?: string; } export interface CollapsedEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the row index of collapsed record. - */ + */ recordIndex?: number; /** Returns the data of collapsed record. - */ + */ data?: any; /** Returns Request Type. - */ + */ requestType?: string; /** Returns state of a record whether it is in expanded or collapsed state. - */ + */ expanded?: boolean; } export interface CollapsingEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the row index of collapsing record. - */ + */ recordIndex?: number; /** Returns the data of edited cell record.. - */ + */ data?: any; /** Returns state of a record whether it is in expanded or collapsed state. - */ + */ expanded?: boolean; } export interface ContextMenuOpenEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the default context menu items to which we add custom items. - */ + */ contextMenuItems?: any[]; /** Returns the Gantt model. - */ + */ model?: any; /** Returns request type. - */ + */ requestType?: string; /** Returns the name of the event. - */ + */ type?: string; } export interface CreateEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the Gantt model - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface EndEditEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the row element of editing cell. - */ + */ rowElement?: any; /** Returns the Element of editing cell. - */ + */ cellElement?: any; /** Returns the data of edited cell record. - */ + */ data?: any; /** Returns the column name of edited cell belongs. - */ + */ columnName?: string; /** Returns the column object of edited cell belongs. - */ + */ columnObject?: any; } export interface ExpandedEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the row index of record. - */ + */ recordIndex?: number; /** Returns the data of expanded record. - */ + */ data?: any; /** Returns Request Type. - */ + */ requestType?: string; /** Returns state of a record whether it is in expanded or collapsed state. - */ + */ expanded?: boolean; } export interface ExpandingEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the row index of record. - */ + */ recordIndex?: any; /** Returns the data of edited cell record.. - */ + */ data?: any; /** Returns state of a record whether it is in expanded or collapsed state. - */ + */ expanded?: boolean; } export interface LoadEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the Gantt model - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface QueryCellInfoEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the selecting cell element. - */ + */ cellElement?: any; /** Returns the value of cell. - */ + */ cellValue?: string; /** Returns the data of current cell record. - */ + */ data?: any; /** Returns the column of cell belongs. - */ + */ column?: any; } export interface QueryTaskbarInfoEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the taskbar background of current item. - */ + */ TaskbarBackground?: string; /** Returns the progressbar background of current item. - */ + */ ProgressbarBackground?: string; /** Returns the parent taskbar background of current item. - */ + */ parentTaskbarBackground?: string; /** Returns the parent progressbar background of current item. - */ + */ parentProgressbarBackground?: string; /** Returns the data of the record. - */ + */ data?: any; } export interface RowDataBoundEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the row element of rendering row. - */ + */ rowElement?: any; /** Returns the data of rendering row record.. - */ + */ data?: any; } export interface RowSelectedEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the selecting row element. - */ + */ targetRow?: any; /** Returns the index of selecting row record. - */ + */ recordIndex?: number; /** Returns the data of selected record. - */ + */ data?: any; } export interface RowSelectingEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the data selecting record. - */ + */ data?: any; /** Returns the index of selecting row record. - */ + */ recordIndex?: string; /** Returns the selecting row chart element. - */ + */ targetChartRow?: any; /** Returns the selecting row grid element. - */ + */ targetGridRow?: any; /** Returns the previous selected data. - */ + */ previousData?: any; /** Returns the previous selected row index. - */ + */ previousIndex?: string; /** Returns the previous selected row chart element. - */ + */ previousChartRow?: any; /** Returns the previous selected row grid element. - */ + */ previousGridRow?: any; } export interface TaskbarEditedEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the data of edited record. - */ + */ data?: any; /** Returns the previous data value of edited record. - */ + */ previousData?: any; /** Returns 'true' if taskbar is dragged. - */ + */ dragging?: boolean; /** Returns 'true' if taskbar is left resized. - */ + */ leftResizing?: boolean; /** Returns 'true' if taskbar is right resized. - */ + */ rightResizing?: boolean; /** Returns 'true' if taskbar is progress resized. - */ + */ progressResizing?: boolean; /** Returns the field values of record being edited. - */ + */ editingFields?: any; /** Returns the Gantt model. - */ + */ model?: any; } export interface TaskbarEditingEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the Gantt model. - */ + */ model?: any; /** Returns the row object being edited. - */ + */ rowData?: any; /** Returns the field values of record being edited. - */ + */ editingFields?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface TaskbarClickEventArgs { /** Returns currently clicked row data - */ + */ data?: any; /** Returns the current item index. - */ + */ index?: number; /** Returns the Gantt model. - */ + */ model?: any; /** Returns the clicked row element - */ + */ taskbarElement?: any; /** Returns the target element. - */ + */ target?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface ToolbarClickEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the current item. - */ + */ currentTarget?: any; /** Returns the Gantt model. - */ + */ model?: any; /** Returns the name of the toolbar item on which mouse click has been performed - */ + */ itemName?: string; /** Returns the name of the event. - */ + */ type?: string; } export interface DragTooltip { /** Specifies option to enable/disable tooltip while drag and drop a row. - * @Default {true} - */ + * @Default {true} + */ showTooltip?: boolean; /** Specifies the data source fields to be displayed in the drag tooltip. - * @Default {[]} - */ + * @Default {[]} + */ tooltipItems?: any[]; /** Specifies the custom template for drag tooltip. - * @Default {null} - */ + * @Default {null} + */ tooltipTemplate?: string; } export interface SplitterSettings { /** Specifies position of the splitter in Gantt , splitter can be placed either based on percentage values or pixel values. - */ + */ position?: string; /** Specifies the position of splitter in Gantt, based on column index in Gantt. - */ + */ index?: string; } export interface EditSettings { /** Enables or disables add record icon in Gantt toolbar - * @Default {false} - */ + * @Default {false} + */ allowAdding?: boolean; /** Enables or disables delete icon in Gantt toolbar - * @Default {false} - */ + * @Default {false} + */ allowDeleting?: boolean; /** Specifies the option for enabling or disabling editing in Gantt grid part - * @Default {false} - */ + * @Default {false} + */ allowEditing?: boolean; /** Specifies the option for enabling or disabling indent action in Gantt. - * @Default {false} - */ + * @Default {false} + */ allowIndent?: boolean; /** Specifies the option for enabling or disabling outdent action in Gantt - * @Default {false} - */ + * @Default {false} + */ allowOutdent?: boolean; /** Specifies the mouse action whether single click or double click to begin the editing - * @Default {ej.Gantt.BeginEditAction.DblClick} - */ + * @Default {ej.Gantt.BeginEditAction.DblClick} + */ beginEditAction?: ej.Gantt.BeginEditAction|string; /** Specifies the edit mode in Gantt, "normal" is for dialog editing ,"cellEditing" is for cell type editing - * @Default {normal} - */ + * @Default {normal} + */ editMode?: string; /** Specifies the position where the new row has to be added. - * @Default {ej.Gantt.RowPosition.BelowSelectedRow} - */ + * @Default {ej.Gantt.RowPosition.BelowSelectedRow} + */ rowPosition?: ej.Gantt.RowPosition|string; } export interface ScheduleHeaderSettings { /** Specified the format for day view in schedule header - * @Default {ddd} - */ + * @Default {ddd} + */ dayHeaderFormat?: string; /** Specified the format for Hour view in schedule header - * @Default {HH} - */ + * @Default {HH} + */ hourHeaderFormat?: string; /** Specifies the number of minutes per interval - * @Default {ej.Gantt.minutesPerInterval.Auto} - */ + * @Default {ej.Gantt.minutesPerInterval.Auto} + */ minutesPerInterval?: ej.Gantt.minutesPerInterval|string; /** Specified the format for month view in schedule header - * @Default {MMM} - */ + * @Default {MMM} + */ monthHeaderFormat?: string; /** Specifies the schedule mode - * @Default {ej.Gantt.ScheduleHeaderType.Week} - */ + * @Default {ej.Gantt.ScheduleHeaderType.Week} + */ scheduleHeaderType?: ej.Gantt.ScheduleHeaderType|string; /** Specifies the round-off mode for the start date in schedule header. - * @Default {ej.Gantt.TimescaleRoundMode.Auto} - */ + * @Default {ej.Gantt.TimescaleRoundMode.Auto} + */ timescaleStartDateMode?: ej.Gantt.TimescaleRoundMode|string; /** Specified the background for weekends in Gantt - * @Default {#F2F2F2} - */ + * @Default {#F2F2F2} + */ weekendBackground?: string; /** Specified the format for week view in schedule header - * @Default {ddd} - */ + * @Default {ddd} + */ weekHeaderFormat?: string; /** Specified the format for year view in schedule header - * @Default {yyyy} - */ + * @Default {yyyy} + */ yearHeaderFormat?: string; /** Specifies the size of the lowest time unit along the timescale, with minimum value as "50%" and maximum value as "500%". It is also possible to set the value in pixels. - * @Default {100%} - */ + * @Default {100%} + */ timescaleUnitSize?: string; /** Specifies the start day of the week in week timescale mode - * @Default {0} - */ + * @Default {0} + */ weekStartDay?: number; } export interface SizeSettings { /** Specifies the height of Gantt control - * @Default {450px} - */ + * @Default {450px} + */ height?: string; /** Specifies the width of Gantt control - * @Default {1000px} - */ + * @Default {1000px} + */ width?: string; } export interface SelectedCellIndex { /** Specifies the row index of the cell to be selected Gantt control - */ + */ rowIndex?: number; /** Specifies the cell index to be selected in the row. - * @Default { } - */ + * @Default { } + */ cellIndex?: number; } export interface SortSettings { /** Specifies the sorted columns for Gantt - * @Default {[]} - */ + * @Default {[]} + */ sortedColumns?: any[]; } export interface ToolbarSettings { /** Specifies the state of enabling or disabling toolbar - * @Default {true} - */ + * @Default {true} + */ showToolbar?: boolean; /** Specifies the list of toolbar items to be rendered in Gantt toolbar - * @Default {[]} - */ + * @Default {[]} + */ toolbarItems?: any[]; } @@ -33984,73 +33984,73 @@ class ReportViewer extends ej.Widget { defaults: ReportViewer.Model; /** Export the report to the specified format. - * @returns {void} - */ + * @returns {void} + */ exportReport(): void; /** Fit the report page to the container. - * @returns {void} - */ + * @returns {void} + */ fitToPage(): void; /** Fit the report page height to the container. - * @returns {void} - */ + * @returns {void} + */ fitToPageHeight(): void; /** Fit the report page width to the container. - * @returns {void} - */ + * @returns {void} + */ fitToPageWidth(): void; /** Get the available datasets name of the rdlc report. - * @returns {void} - */ + * @returns {void} + */ getDataSetNames(): void; /** Get the available parameters of the report. - * @returns {void} - */ + * @returns {void} + */ getParameters(): void; /** Navigate to first page of report. - * @returns {void} - */ + * @returns {void} + */ gotoFirstPage(): void; /** Navigate to last page of the report. - * @returns {void} - */ + * @returns {void} + */ gotoLastPage(): void; /** Navigate to next page from the current page. - * @returns {void} - */ + * @returns {void} + */ gotoNextPage(): void; /** Go to specific page index of the report. - * @returns {void} - */ + * @returns {void} + */ gotoPageIndex(): void; /** Navigate to previous page from the current page. - * @returns {void} - */ + * @returns {void} + */ gotoPreviousPage(): void; /** Print the report. - * @returns {void} - */ + * @returns {void} + */ print(): void; /** Apply print layout to the report. - * @returns {void} - */ + * @returns {void} + */ printLayout(): void; /** Refresh the report. - * @returns {void} - */ + * @returns {void} + */ refresh(): void; } export namespace ReportViewer { @@ -34058,80 +34058,80 @@ export namespace ReportViewer { export interface Model { /** Gets or sets the list of data sources for the RDLC report. - * @Default {[]} - */ + * @Default {[]} + */ dataSources?: DataSource[]; /** Enables or disables the page cache of report. - * @Default {false} - */ + * @Default {false} + */ enablePageCache?: boolean; /** Specifies the export settings. - */ + */ exportSettings?: ExportSettings; /** When set to true, adapts the report layout to fit the screen size of devices on which it renders. - * @Default {true} - */ + * @Default {true} + */ isResponsive?: boolean; /** Specifies the locale for report viewer. - * @Default {en-US} - */ + * @Default {en-US} + */ locale?: string; /** Specifies the page settings. - */ + */ pageSettings?: PageSettings; /** Gets or sets the list of parameters associated with the report. - * @Default {[]} - */ + * @Default {[]} + */ parameters?: Parameter[]; /** Enables and disables the print mode. - * @Default {false} - */ + * @Default {false} + */ printMode?: boolean; /** Specifies the print option of the report. - * @Default {ej.ReportViewer.PrintOptions.Default} - */ + * @Default {ej.ReportViewer.PrintOptions.Default} + */ printOptions?: ej.ReportViewer.PrintOptions|string; /** Specifies the processing mode of the report. - * @Default {ej.ReportViewer.ProcessingMode.Remote} - */ + * @Default {ej.ReportViewer.ProcessingMode.Remote} + */ processingMode?: ej.ReportViewer.ProcessingMode|string; /** Specifies the render layout. - * @Default {ej.ReportViewer.RenderMode.Default} - */ + * @Default {ej.ReportViewer.RenderMode.Default} + */ renderMode?: ej.ReportViewer.RenderMode|string; /** Gets or sets the path of the report file. - * @Default {empty} - */ + * @Default {empty} + */ reportPath?: string; /** Gets or sets the reports server URL. - * @Default {empty} - */ + * @Default {empty} + */ reportServerUrl?: string; /** Specifies the report Web API service URL. - * @Default {empty} - */ + * @Default {empty} + */ reportServiceUrl?: string; /** Specifies the toolbar settings. - */ + */ toolbarSettings?: ToolbarSettings; /** Gets or sets the zoom factor for report viewer. - * @Default {1} - */ + * @Default {1} + */ zoomFactor?: number; /** Fires when the report viewer is destroyed successfully.If you want to perform any operation after destroying the reportviewer control,you can make use of the destroy event. */ @@ -34162,236 +34162,236 @@ export interface Model { export interface DestroyEventArgs { /** true if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the report model. - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; } export interface DrillThroughEventArgs { /** true if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the actionInfo's parameters bookmarkLink, hyperLink, reportName, parameters. - */ + */ actionInfo?: any; /** returns the report model. - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; } export interface RenderingBeginEventArgs { /** true if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the report model. - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; } export interface RenderingCompleteEventArgs { /** true if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the report model. - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; /** returns the collection of parameters. - */ + */ reportParameters?: any; } export interface ReportErrorEventArgs { /** true if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the error details. - */ + */ error?: string; /** returns the report model. - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; } export interface ReportExportEventArgs { /** true if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the report model. - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; } export interface ReportLoadedEventArgs { /** true if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the report model. - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; } export interface ViewReportClickEventArgs { /** true if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the parameter collection. - */ + */ parameters?: any; /** returns the report model. - */ + */ model?: any; /** returns the name of the event. - */ + */ type?: string; } export interface DataSource { /** Gets or sets the name of the data source. - * @Default {empty} - */ + * @Default {empty} + */ name?: string; /** Gets or sets the values of data source. - * @Default {[]} - */ + * @Default {[]} + */ values?: any[]; } export interface ExportSettings { /** Specifies the export formats. - * @Default {ej.ReportViewer.ExportOptions.All} - */ + * @Default {ej.ReportViewer.ExportOptions.All} + */ exportOptions?: ej.ReportViewer.ExportOptions|string; /** Specifies the excel export format. - * @Default {ej.ReportViewer.ExcelFormats.Excel97to2003} - */ + * @Default {ej.ReportViewer.ExcelFormats.Excel97to2003} + */ excelFormat?: ej.ReportViewer.ExcelFormats|string; /** Specifies the word export format. - * @Default {ej.ReportViewer.WordFormats.Doc} - */ + * @Default {ej.ReportViewer.WordFormats.Doc} + */ wordFormat?: ej.ReportViewer.WordFormats|string; } export interface PageSettings { /** Specifies the print layout orientation. - * @Default {null} - */ + * @Default {null} + */ orientation?: ej.ReportViewer.Orientation|string; /** Specifies the paper size of print layout. - * @Default {null} - */ + * @Default {null} + */ paperSize?: ej.ReportViewer.PaperSize|string; } export interface Parameter { /** Gets or sets the parameter labels. - * @Default {null} - */ + * @Default {null} + */ labels?: any[]; /** Gets or sets the name of the parameter. - * @Default {empty} - */ + * @Default {empty} + */ name?: string; /** Gets or sets whether the parameter allows nullable value or not. - * @Default {false} - */ + * @Default {false} + */ nullable?: boolean; /** Gets or sets the prompt message associated with the specified parameter. - * @Default {empty} - */ + * @Default {empty} + */ prompt?: string; /** Gets or sets the parameter values. - * @Default {[]} - */ + * @Default {[]} + */ values?: any[]; } export interface ToolbarSettings { /** Fires when user click on toolbar item in the toolbar. - * @Default {empty} - */ + * @Default {empty} + */ click?: string; /** Specifies the toolbar items. - * @Default {ej.ReportViewer.ToolbarItems.All} - */ + * @Default {ej.ReportViewer.ToolbarItems.All} + */ items?: ej.ReportViewer.ToolbarItems|string; /** Shows or hides the toolbar. - * @Default {true} - */ + * @Default {true} + */ showToolbar?: boolean; /** Shows or hides the tooltip of toolbar items. - * @Default {true} - */ + * @Default {true} + */ showTooltip?: boolean; /** Specifies the toolbar template ID. - * @Default {empty} - */ + * @Default {empty} + */ templateId?: string; } @@ -34620,110 +34620,110 @@ class TreeGrid extends ej.Widget { defaults: TreeGrid.Model; /** Add a new row in TreeGrid, while allowAdding is set to true - * @param {any} Item to add in TreeGrid row. - * @param {string} Defines in which position the row wants to be added - * @returns {void} - */ + * @param {any} Item to add in TreeGrid row. + * @param {string} Defines in which position the row wants to be added + * @returns {void} + */ addRow(data: any, rowPosition: string): void; /** To clear all the selection in TreeGrid - * @param {number} you can pass a row index to clear the row selection. - * @returns {void} - */ + * @param {number} you can pass a row index to clear the row selection. + * @returns {void} + */ clearSelection(index: number): void; /** To select cell based on the cell and row index dynamically. - * @param {Array} array of cell indexes to be select - * @param {boolean} Defines that we need to preserve the previously selected cells or not - * @returns {void} - */ + * @param {Array} array of cell indexes to be select + * @param {boolean} Defines that we need to preserve the previously selected cells or not + * @returns {void} + */ selectCells(Indexes: any[], preservePreviousSelectedCell: boolean): void; /** To rename a column with the specified name - * @param {number} Index of the column to be renamed - * @param {string} Header text of the column - * @returns {void} - */ + * @param {number} Index of the column to be renamed + * @param {string} Header text of the column + * @returns {void} + */ renameColumn(columnIndex: number, name: string): void; /** To delete the specified column - * @param {number} Index of the column to be deleted - * @returns {void} - */ + * @param {number} Index of the column to be deleted + * @returns {void} + */ deleteColumn(columnIndex: number): void; /** To collapse all the parent items in tree grid - * @returns {void} - */ + * @returns {void} + */ collapseAll(): void; /** To hide the column by using header text - * @param {string} you can pass a header text of a column to hide. - * @returns {void} - */ + * @param {string} you can pass a header text of a column to hide. + * @returns {void} + */ hideColumn(headerText: string): void; /** Expands the records at specific hierarchical level - * @param {number} you can pass the level as index number to expand - * @returns {void} - */ + * @param {number} you can pass the level as index number to expand + * @returns {void} + */ expandAtLevel(index: number): void; /** Collapses the records at specific hierarchical level - * @param {number} you can pass the particular level as index. - * @returns {void} - */ + * @param {number} you can pass the particular level as index. + * @returns {void} + */ collapseAtLevel(index: number): void; /** To refresh the changes in tree grid - * @param {Array} Pass which data source you want to show in tree grid - * @param {any} Pass which data you want to show in tree grid - * @returns {void} - */ + * @param {Array} Pass which data source you want to show in tree grid + * @param {any} Pass which data you want to show in tree grid + * @returns {void} + */ refresh(dataSource: any[], query: any): void; /** Freeze all the columns preceding to the column specified by the field name. - * @param {string} Freeze all Columns before this field column. - * @returns {void} - */ + * @param {string} Freeze all Columns before this field column. + * @returns {void} + */ freezePrecedingColumns(field: string): void; /** Freeze/unfreeze the specified column. - * @param {string} Freeze/Unfreeze this field column. - * @param {boolean} Decides to Freeze/Unfreeze this field column. - * @returns {void} - */ + * @param {string} Freeze/Unfreeze this field column. + * @param {boolean} Decides to Freeze/Unfreeze this field column. + * @returns {void} + */ freezeColumn(field: string, isFrozen: boolean): void; /** To save the edited cell in TreeGrid - * @returns {void} - */ + * @returns {void} + */ saveCell(): void; /** To search an item with search string provided at the run time - * @param {string} you can pass a searchString to search the tree grid - * @returns {void} - */ + * @param {string} you can pass a searchString to search the tree grid + * @returns {void} + */ search(searchString: string): void; /** To show the column by using header text - * @param {string} you can pass a header text of a column to show. - * @returns {void} - */ + * @param {string} you can pass a header text of a column to show. + * @returns {void} + */ showColumn(headerText: string): void; /** To sorting the data based on the particular fields - * @param {string} you can pass a name of column to sort. - * @param {string} you can pass a sort direction to sort the column. - * @returns {void} - */ + * @param {string} you can pass a name of column to sort. + * @param {string} you can pass a sort direction to sort the column. + * @returns {void} + */ sortColumn(columnName: string, columnSortDirection: string): void; /** To reorder the column with field name and target index values - * @param {string} you can pass a name of column to reorder. - * @param {string} you can pass a target column index to be inserted. - * @returns {void} - */ + * @param {string} you can pass a name of column to reorder. + * @param {string} you can pass a target column index to be inserted. + * @returns {void} + */ reorderColumn(fieldName: string, targetIndex: string): void; } export namespace TreeGrid { @@ -34731,247 +34731,247 @@ export namespace TreeGrid { export interface Model { /** Enables or disables the ability to resize the column width interactively. - * @Default {false} - */ + * @Default {false} + */ allowColumnResize?: boolean; /** Enables or disables the option for column reordering - * @Default {false} - */ + * @Default {false} + */ allowColumnReordering?: boolean; /** Enables or disables the ability to drag and drop the row interactively to reorder the rows. - * @Default {false} - */ + * @Default {false} + */ allowDragAndDrop?: boolean; /** Enables or disables the ability to filter the data on all the columns. Enabling this property will display a row with editor controls corresponding to each column. - * You can restrict filtering on particular column by disabling this property directly on that column instance itself. - * @Default {false} - */ + * You can restrict filtering on particular column by disabling this property directly on that column instance itself. + * @Default {false} + */ allowFiltering?: boolean; /** Enables or disables keyboard navigation. - * @Default {true} - */ + * @Default {true} + */ allowKeyboardNavigation?: boolean; /** Enables or disables the ability to sort the rows based on multiple columns/fields by clicking on each column header. Rows will be sorted recursively on clicking the column headers. - * @Default {false} - */ + * @Default {false} + */ allowMultiSorting?: boolean; /** Enables or disables the ability to select a row interactively. - * @Default {true} - */ + * @Default {true} + */ allowSelection?: boolean; /** Enables or disables the ability to sort the rows based on a single field/column by clicking on that column header. When enabled, rows can be sorted only by single field/column. - * @Default {false} - */ + * @Default {false} + */ allowSorting?: boolean; /** Enables/disables pagination of rows in TreeGrid - * @Default {false} - */ + * @Default {false} + */ allowPaging?: boolean; /** Specifies the id of the template that has to be applied for alternate rows. - */ + */ altRowTemplateID?: string; /** Specifies the mapping property path for sub tasks in datasource - */ + */ childMapping?: string; /** Option for adding columns; each column has the option to bind to a field in the dataSource. - */ + */ columns?: Column[]; /** To Specify the column fields to be displayed in the dialog while inserting a column using column menu. - * @Default {[]} - */ + * @Default {[]} + */ columnDialogFields?: any[]; /** Options for displaying and customizing context menu items. - */ + */ contextMenuSettings?: ContextMenuSettings; /** Specify the CSS class for TreeGrid to achieve custom theme. - */ + */ cssClass?: string; /** Specifies hierarchical or self-referential data to populate the TreeGrid. - * @Default {null} - */ + * @Default {null} + */ dataSource?: any[]; /** Specifies whether to wrap the header text when it is overflown i.e., when it exceeds the header width. - * @Default {none} - */ + * @Default {none} + */ headerTextOverflow?: string; /** Options for displaying and customizing the tooltip. This tooltip will show the preview of the row that is being dragged. - */ + */ dragTooltip?: DragTooltip; /** Options for enabling and configuring the editing related operations. - */ + */ editSettings?: EditSettings; /** Specifies whether to render alternate rows in different background colors. - * @Default {true} - */ + * @Default {true} + */ enableAltRow?: boolean; /** Specifies whether to load all the rows in collapsed state when the TreeGrid is rendered for the first time. - * @Default {false} - */ + * @Default {false} + */ enableCollapseAll?: boolean; /** Specifies whether to resize TreeGrid whenever window size changes. - * @Default {false} - */ + * @Default {false} + */ enableResize?: boolean; /** Specifies whether to render only the visual elements that are visible in the UI. When you enable this property, it will reduce the loading time for loading large number of records. - * @Default {false} - */ + * @Default {false} + */ enableVirtualization?: boolean; /** Specifies the settings for column resize - */ + */ columnResizeSettings?: ColumnResizeSettings; /** Options for filtering and customizing filter actions. - */ + */ filterSettings?: FilterSettings; /** Specifies the localization information to customize the User Interface (UI) to support regional language and culture - * @Default {en-US} - */ + * @Default {en-US} + */ locale?: string; /** Enables or disables internal parsing of a row. When disabled this property, row will be displayed using the defined template without any internal event bindings. - * @Default {true} - */ + * @Default {true} + */ parseRowTemplate?: boolean; /** Specifies the name of the field in the dataSource, which contains the id of that row. - */ + */ idMapping?: string; /** Enables or disables the responsiveness of TreeGrid - * @Default {false} - */ + * @Default {false} + */ isResponsive?: boolean; /** Specifies the name of the field in the dataSource, which contains the parent's id. This is necessary to form a parent-child hierarchy, if the dataSource contains self-referential data. - */ + */ parentIdMapping?: string; /** Specifies the options for customizing the pager. - */ + */ pageSettings?: PageSettings; /** Specifies the template for cell tooltip - * @Default {null} - */ + * @Default {null} + */ cellTooltipTemplate?: string; /** Specifies ej.Query to select data from the dataSource. This property is applicable only when the dataSource is ej.DataManager. - * @Default {null} - */ + * @Default {null} + */ query?: any; /** Specifies the height of a single row in tree grid. Also, we need to set same height in the CSS style with class name e-rowcell. - * @Default {30} - */ + * @Default {30} + */ rowHeight?: number; /** Specifies the id of the template to be applied for all the rows. - */ + */ rowTemplateID?: string; /** Specifies the index of the selected row. - * @Default {-1} - */ + * @Default {-1} + */ selectedRowIndex?: number; /** Specifies the settings for row and cell selection. - */ + */ selectionSettings?: SelectionSettings; /** Enables/disables the options for inserting , deleting and renaming columns. - * @Default {false} - */ + * @Default {false} + */ showColumnOptions?: boolean; /** Controls the visibility of the menu button, which is displayed on the column header. Clicking on this button will show a popup menu. When you choose Columns item from this popup, - * a list box with column names will be shown, from which you can select/deselect a column name to control the visibility of the respective columns. - * @Default {false} - */ + * a list box with column names will be shown, from which you can select/deselect a column name to control the visibility of the respective columns. + * @Default {false} + */ showColumnChooser?: boolean; /** Specifies the visibility of details view - * @Default {false} - */ + * @Default {false} + */ showDetailsRow?: boolean; /** Specifies the visibility of the expander column which is used to expand or collapse the details view - * @Default {false} - */ + * @Default {false} + */ showDetailsRowInfoColumn?: boolean; /** Specifies the template for details view - */ + */ detailsTemplate?: string; /** Specifies the row height of the details view - * @Default {100} - */ + * @Default {100} + */ detailsRowHeight?: number; /** Specifies the visibility of summary row - * @Default {false} - */ + * @Default {false} + */ showSummaryRow?: boolean; /** Specifies the visibility of total summary row for the corresponding summary column - * @Default {false} - */ + * @Default {false} + */ showTotalSummary?: boolean; /** Specifies the summary row collection object to be displayed - * @Default {[]} - */ + * @Default {[]} + */ summaryRows?: any[]; /** Specifies whether to show tooltip when mouse is hovered on the cell. - * @Default {true} - */ + * @Default {true} + */ showGridCellTooltip?: boolean; /** Specifies whether to show tooltip for the cells, which has expander button. - * @Default {true} - */ + * @Default {true} + */ showGridExpandCellTooltip?: boolean; /** Options for setting width and height for TreeGrid. - */ + */ sizeSettings?: SizeSettings; /** Options for sorting the rows. - */ + */ sortSettings?: SortSettings; /** Options for displaying and customizing the toolbar items. - */ + */ toolbarSettings?: ToolbarSettings; /** Specifies the index of the column that needs to have the expander button. By default, cells in the first column contain the expander button. - * @Default {0} - */ + * @Default {0} + */ treeColumnIndex?: number; /** Triggered before every success event of TreeGrid action. */ @@ -35062,1070 +35062,1070 @@ export interface Model { export interface ActionBeginEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the current grouped column field name. - */ + */ columnName?: string; /** Returns the TreeGrid model. - */ + */ model?: any; /** Returns request type. - */ + */ requestType?: string; /** Returns the name of the event. - */ + */ type?: string; /** Returns the direction of sorting ascending or descending. - */ + */ columnSortDirection?: string; /** Returns the value of expanding parent element. - */ + */ keyValue?: string; /** Returns the data or deleting element. - */ + */ data?: string; } export interface ActionCompleteEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the grid model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the current grouped column field name. - */ + */ columnName?: string; /** Returns request type. - */ + */ requestType?: string; /** Returns the direction of sorting ascending or descending - */ + */ columnSortDirection?: string; /** Returns the value of searched element. - */ + */ keyValue?: string; /** Returns the data of deleted element. - */ + */ data?: string; /** Returns selected record index - */ + */ recordIndex?: number; } export interface BeginEditEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the row element of editing cell. - */ + */ rowElement?: any; /** Returns the Element of editing cell. - */ + */ cellElement?: any; /** Returns the data of current cell record. - */ + */ data?: any; /** Returns the column Index of cell belongs. - */ + */ columnIndex?: number; } export interface CollapsedEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the row index of collapsed record. - */ + */ recordIndex?: number; /** Returns the data of collapsed record.. - */ + */ data?: any; /** Returns Request Type. - */ + */ requestType?: string; /** Returns state of a record whether it is in expanded or collapsed state. - */ + */ expanded?: boolean; /** Returns the event type. - */ + */ type?: string; } export interface CollapsingEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the row index of collapsing record. - */ + */ recordIndex?: number; /** Returns the data of collapsing record.. - */ + */ data?: any; /** Returns the event Type. - */ + */ type?: string; /** Returns state of a record whether it is in expanded or collapsing state. - */ + */ expanded?: boolean; } export interface RecordClickEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the element of clicked cell. - */ + */ cell?: any; /** Returns the index of the clicked cell. - */ + */ cellIndex?: number; /** Returns the data of clicked cell. - */ + */ cellValue?: any; /** Returns the element of the clicked row. - */ + */ row?: any; /** Returns the index of the clicked row. - */ + */ rowIndex?: number; /** Returns the column name of the clicked cell. - */ + */ columnName?: string; } export interface ColumnDragStartEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the control model values. - */ + */ model?: any; /** Returns the event Type. - */ + */ type?: string; /** Returns the column data which is dragged - */ + */ draggedColumn?: any; /** Returns the index of the column being dragged - */ + */ draggedColumnIndex?: number; } export interface ColumnDragEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the control model values. - */ + */ model?: any; /** Returns the event Type. - */ + */ type?: string; /** Returns the column data which is dragged - */ + */ draggedColumn?: any; /** Returns the index of the column being dragged - */ + */ draggedColumnIndex?: number; /** Returns the target column data - */ + */ targetColumn?: any; /** Returns the index of the target column - */ + */ targetColumnIndex?: number; /** Returns that we can drop over the column or not. - */ + */ canDrop?: boolean; } export interface ColumnDropEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the control model values. - */ + */ model?: any; /** Returns the event Type. - */ + */ type?: string; /** Returns the column data which is dragged - */ + */ draggedColumn?: any; /** Returns the index of the column being dragged - */ + */ draggedColumnIndex?: number; /** Returns the target column data - */ + */ targetColumn?: any; /** Returns the index of the target column - */ + */ targetColumnIndex?: number; } export interface ColumnResizedEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the control model values. - */ + */ model?: any; /** Returns the event Type. - */ + */ type?: string; /** Returns the column data which is resized - */ + */ column?: any; /** Returns the index of the column being resized. - */ + */ columnIndex?: number; /** Returns resized column width after resized. - */ + */ newWidth?: number; /** Returns resized column width before resizing - */ + */ oldWidth?: number; } export interface ColumnResizeStartEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the control model values. - */ + */ model?: any; /** Returns the event Type. - */ + */ type?: string; /** Returns the column data in which the resizing started - */ + */ column?: any; /** Returns the column index in which the resizing started - */ + */ columnIndex?: number; /** Returns column width before dragging - */ + */ oldWidth?: number; /** Returns initial column element object. - */ + */ target?: any; } export interface ColumnResizeEndEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the control model values. - */ + */ model?: any; /** Returns the event Type. - */ + */ type?: string; /** Returns the column data in which the resizing started - */ + */ column?: any; /** Returns the column index in which the resizing started - */ + */ columnIndex?: number; /** Returns the column width difference, before and after the resizing - */ + */ extra?: number; /** Returns the new column width after resized - */ + */ newWidth?: number; /** Returns column width before dragging - */ + */ oldWidth?: number; /** Returns initial column element object. - */ + */ target?: any; } export interface ContextMenuOpenEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the default context menu items to which we add custom items. - */ + */ contextMenuItems?: any[]; /** Returns the TreeGrid model. - */ + */ model?: any; /** Returns request type. - */ + */ requestType?: string; /** Returns the name of the event. - */ + */ type?: string; } export interface CreateEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the TreeGrid model - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface EndEditEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the row element of editing cell. - */ + */ rowElement?: any; /** Returns the Element of editing cell. - */ + */ cellElement?: any; /** Returns the data of edited cell record. - */ + */ data?: any; /** Returns the column name of edited cell belongs. - */ + */ columnName?: string; /** Returns the column object of edited cell belongs. - */ + */ columnObject?: any; } export interface ExpandedEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the row index of expanded record. - */ + */ recordIndex?: number; /** Returns the data of expanded record.. - */ + */ data?: any; /** Returns Request Type. - */ + */ requestType?: string; /** Returns state of a record whether it is in expanded or expanded state. - */ + */ expanded?: boolean; /** Returns the event type. - */ + */ type?: string; } export interface ExpandingEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the row index of expanding record. - */ + */ recordIndex?: number; /** Returns the data of expanding record.. - */ + */ data?: any; /** Returns the event Type. - */ + */ type?: string; /** Returns state of a record whether it is in expanded or collapsed state. - */ + */ expanded?: boolean; } export interface LoadEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the TreeGrid model - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface QueryCellInfoEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the selecting cell element. - */ + */ cellElement?: any; /** Returns the value of cell. - */ + */ cellValue?: string; /** Returns the data of current cell record. - */ + */ data?: any; /** Returns the column of cell belongs. - */ + */ column?: any; } export interface RowDataBoundEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the row element of rendering row. - */ + */ rowElement?: any; /** Returns the data of rendering row record. - */ + */ data?: any; } export interface RowDragEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the row which we start to drag. - */ + */ draggedRow?: any; /** Returns the row index which we start to drag. - */ + */ draggedRowIndex?: number; /** Returns the row on which we are dragging. - */ + */ targetRow?: any; /** Returns the row index on which we are dragging. - */ + */ targetRowIndex?: number; /** Returns that we can drop over that record or not. - */ + */ canDrop?: boolean; /** Returns the TreeGrid model. - */ + */ model?: any; /** Returns request type. - */ + */ requestType?: string; /** Returns the name of the event. - */ + */ type?: string; } export interface RowDragStartEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the row which we start to drag. - */ + */ draggedRow?: any; /** Returns the row index which we start to drag. - */ + */ draggedRowIndex?: boolean; /** Returns the TreeGrid model. - */ + */ model?: any; /** Returns request type. - */ + */ requestType?: string; /** Returns the name of the event. - */ + */ type?: string; } export interface RowDragStopEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the row which we start to drag. - */ + */ draggedRow?: any; /** Returns the row index which we start to drag. - */ + */ draggedRowIndex?: number; /** Returns the row which we are dropped to row. - */ + */ targetRow?: any; /** Returns the row index which we are dropped to row. - */ + */ targetRowIndex?: number; /** Returns the TreeGrid model. - */ + */ model?: any; /** Returns request type. - */ + */ requestType?: string; /** Returns the name of the event. - */ + */ type?: string; } export interface CellSelectingEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the cell index on the selection. - */ + */ cellIndex?: number; /** Returns the row index on the selection - */ + */ rowIndex?: number; /** Returns the selecting cell element - */ + */ targetCell?: any; /** Returns the selecting row element - */ + */ targetRow?: any; /** Returns the selecting record object - */ + */ data?: any; /** Returns the Gantt object Model - */ + */ model?: any; } export interface CellSelectedEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the cell index on the selection. - */ + */ cellIndex?: number; /** Returns the row index on the selection - */ + */ rowIndex?: number; /** Returns the selecting cell element - */ + */ targetCell?: any; /** Returns the selecting row element - */ + */ targetRow?: any; /** Returns the selecting record object - */ + */ data?: any; /** Returns the Gantt object Model - */ + */ model?: any; /** Returns the previously selected row data - */ + */ previousData?: any; /** Returns the previously selected cell index - */ + */ previousCellIndex?: any; /** Returns the previously selected row index - */ + */ previousRowIndex?: any; /** Returns the previously selected cell element - */ + */ previousTargetCell?: any; /** Returns the previously selected row element - */ + */ previousTargetRow?: any; } export interface RowSelectedEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the selecting row element. - */ + */ targetRow?: any; /** Returns the index of selecting row record. - */ + */ recordIndex?: number; /** Returns the data of selected record. - */ + */ data?: any; /** Returns the event type. - */ + */ type?: string; } export interface RowSelectingEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the data selecting record. - */ + */ data?: any; /** Returns the index of selecting row record. - */ + */ recordIndex?: string; /** Returns the selecting row element. - */ + */ targetRow?: any; /** Returns the previous selected data. - */ + */ previousData?: any; /** Returns the previous selected row index. - */ + */ previousIndex?: string; /** Returns the previous selected row element. - */ + */ previousTreeGridRow?: any; } export interface ToolbarClickEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the current item. - */ + */ currentTarget?: any; /** Returns the TreeGrid model. - */ + */ model?: any; /** Returns the name of the toolbar item on which mouse click has been performed - */ + */ itemName?: string; /** Returns the name of the event. - */ + */ type?: string; } export interface Column { /** Enables or disables the ability to filter the rows based on this column. - * @Default {false} - */ + * @Default {false} + */ allowFiltering?: boolean; /** Enables or disables the ability to sort the rows based on this column/field. - * @Default {false} - */ + * @Default {false} + */ allowSorting?: boolean; /** Enables/disables cell selection. - * @Default {false} - */ + * @Default {false} + */ allowCellSelection?: boolean; /** Specifies the edit type of the column. - * @Default {ej.TreeGrid.EditingType.String} - */ + * @Default {ej.TreeGrid.EditingType.String} + */ editType?: ej.TreeGrid.EditingType|string; /** Specifies the name of the field from the dataSource to bind with this column. - */ + */ field?: string; /** Specifies the type of the editor control to be used to filter the rows. - * @Default {ej.TreeGrid.EditingType.String} - */ + * @Default {ej.TreeGrid.EditingType.String} + */ filterEditType?: ej.TreeGrid.EditingType|string; /** Header text of the column. - * @Default {null} - */ + * @Default {null} + */ headerText?: string; /** Enables or disables the checkbox visibility in a column to make it as a checkbox column - * @Default {false} - */ + * @Default {false} + */ showCheckbox?: boolean; /** Controls the visibility of the column. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Gets or sets a value for treegrid column width - */ + */ width?: number; /** Specifies the header template value for the column header - */ + */ headerTemplateID?: string; /** Specifies the display format of a column - * @Default {null} - */ + * @Default {null} + */ format?: any; /** Specifies whether the column is a template column - * @Default {false} - */ + * @Default {false} + */ isTemplateColumn?: boolean; /** Specifies the alignment of the column header text - * @Default {ej.TextAlign.Left} - */ + * @Default {ej.TextAlign.Left} + */ headerTextAlign?: ej.TextAlign|string; /** Specifies whether the column is frozen - * @Default {false} - */ + * @Default {false} + */ isFrozen?: boolean; /** Specifies the text alignment for the column - * @Default {ej.TextAlign.Left} - */ + * @Default {ej.TextAlign.Left} + */ textAlign?: ej.TextAlign|string; /** Specifies the template for the TreeGrid column - */ + */ templateID?: string; /** Enables or disables the ability to edit a row or cell. - * @Default {false} - */ + * @Default {false} + */ allowEditing?: boolean; /** Enables or disables the ability to freeze/unfreeze the columns - * @Default {false} - */ + * @Default {false} + */ allowFreezing?: boolean; } export interface ContextMenuSettings { /** Option for adding items to context menu. - * @Default {[]} - */ + * @Default {[]} + */ contextMenuItems?: any[]; /** Shows/hides the context menu. - * @Default {false} - */ + * @Default {false} + */ showContextMenu?: boolean; } export interface DragTooltip { /** Specifies whether to show tooltip while dragging a row. - * @Default {true} - */ + * @Default {true} + */ showTooltip?: boolean; /** Option to add field names whose corresponding values in the dragged row needs to be shown in the preview tooltip. - * @Default {[]} - */ + * @Default {[]} + */ tooltipItems?: any[]; /** Custom template for that tooltip that is shown while dragging a row. - * @Default {null} - */ + * @Default {null} + */ tooltipTemplate?: string; } export interface EditSettings { /** Enables or disables the button to add new row in context menu as well as in toolbar. - * @Default {true} - */ + * @Default {true} + */ allowAdding?: boolean; /** Enables or disables the button to delete the selected row in context menu as well as in toolbar. - * @Default {true} - */ + * @Default {true} + */ allowDeleting?: boolean; /** Enables or disables the ability to edit a row or cell. - * @Default {false} - */ + * @Default {false} + */ allowEditing?: boolean; /** Specifies the mouse action whether single click or double click to begin the editing - * @Default {ej.TreeGrid.BeginEditAction.DblClick} - */ + * @Default {ej.TreeGrid.BeginEditAction.DblClick} + */ beginEditAction?: ej.TreeGrid.BeginEditAction|string; /** specifies the edit mode in TreeGrid , "cellEditing" is for cell type editing and "rowEditing" is for entire row. - * @Default {ej.TreeGrid.EditMode.CellEditing} - */ + * @Default {ej.TreeGrid.EditMode.CellEditing} + */ editMode?: ej.TreeGrid.EditMode|string; /** Specifies the position where the new row has to be added. - * @Default {top} - */ + * @Default {top} + */ rowPosition?: ej.TreeGrid.RowPosition|string; } export interface ColumnResizeSettings { /** Specifies the mode for column resizing - * @Default {normal} - */ + * @Default {normal} + */ columnResizeMode?: string; } export interface FilterSettings { /** Specifies the mode on which column filtering should start - * @Default {immediate} - */ + * @Default {immediate} + */ filterBarMode?: string; /** Specifies the type of column filtering. - * @Default {filterbar} - */ + * @Default {filterbar} + */ filterType?: string; /** Specifies the column collection for filtering the TreeGrid content on initial load - * @Default {[]} - */ + * @Default {[]} + */ filteredColumns?: any[]; } export interface PageSettings { /** Using this property we can specify the number of pages should pager contains, according to this count TreeGrid height will be updated. - * @Default {8} - */ + * @Default {8} + */ pageCount?: number; /** This specifies the number of rows to display in each page. - * @Default {12} - */ + * @Default {12} + */ pageSize?: number; /** Get the value of records which is bound to TreeGrid. The totalRecordsCount value is calculated based on the datasource bound to TreeGrid. - * @Default {null} - */ + * @Default {null} + */ totalRecordsCount?: number; /** Specifies the current page to display at load time. - * @Default {1} - */ + * @Default {1} + */ currentPage?: number; /** Specifies the mode of record count in a page, whether it should count all the records or the root to count zero level parent records. - * @Default {ej.TreeGrid.PageSizeMode.All} - */ + * @Default {ej.TreeGrid.PageSizeMode.All} + */ pageSizeMode?: ej.TreeGrid.PageSizeMode|string; /** Specifies the Custom template for Pager control. - * @Default {null} - */ + * @Default {null} + */ template?: string; } export interface SelectionSettings { /** Specifies the type of selection whether to select row or cell. - * @Default {ej.TreeGrid.SelectionMode.Row} - */ + * @Default {ej.TreeGrid.SelectionMode.Row} + */ selectionMode?: ej.TreeGrid.SelectionMode|string; /** Specifies the type of selection whether single, multiple or checkbox. - * @Default {ej.TreeGrid.SelectionType.Single} - */ + * @Default {ej.TreeGrid.SelectionType.Single} + */ selectionType?: ej.TreeGrid.SelectionType|string; /** Enables or disables the selection by hierarchy in check box selection - * @Default {true} - */ + * @Default {true} + */ enableHierarchySelection?: boolean; /** Toggles the visibility of the checkbox in column header, using which all the check boxes can be selected or unselected. - * @Default {true} - */ + * @Default {true} + */ enableSelectAll?: boolean; } export interface SizeSettings { /** Height of the TreeGrid. - * @Default {null} - */ + * @Default {null} + */ height?: string; /** Width of the TreeGrid. - * @Default {null} - */ + * @Default {null} + */ width?: string; } export interface SortSettings { /** Option to add columns based on which the rows have to be sorted recursively. - * @Default {[]} - */ + * @Default {[]} + */ sortedColumns?: any[]; } export interface ToolbarSettings { /** Shows/hides the toolbar. - * @Default {false} - */ + * @Default {false} + */ showToolbar?: boolean; /** Specifies the list of toolbar items to be rendered in TreeGrid toolbar - * @Default {[]} - */ + * @Default {[]} + */ toolbarItems?: any[]; } @@ -36235,85 +36235,85 @@ class GroupButton extends ej.Widget { defaults: GroupButton.Model; /** Remove the selection state of the specified the button element from the GroupButton - * @param {JQuery} Specific button element - * @returns {void} - */ + * @param {JQuery} Specific button element + * @returns {void} + */ deselectItem(element: JQuery): void; /** Destroy the GroupButton widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. - * @returns {void} - */ + * @returns {void} + */ destroy(): void; /** Disables the GroupButton control - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** Disable the specified button element from the ejGroupButton control. - * @param {JQuery} Specific button element - * @returns {void} - */ + * @param {JQuery} Specific button element + * @returns {void} + */ disableItem(element: JQuery): void; /** Enables the disabled ejGroupButton control. - * @returns {void} - */ + * @returns {void} + */ enable(): void; /** Enable the specified disabled button element from the ejGroupButton control. - * @param {JQuery} Specific button element - * @returns {void} - */ + * @param {JQuery} Specific button element + * @returns {void} + */ enableItem(element: JQuery): void; /** Returns the index value for specified button element in the GroupButton control. - * @param {JQuery} Specific button element - * @returns {number} - */ + * @param {JQuery} Specific button element + * @returns {number} + */ getIndex(element: JQuery): number; /** This method returns the list of active state button elements from the GroupButton control. - * @returns {any} - */ + * @returns {any} + */ getSelectedItem(): any; /** Hides the GroupButton control - * @returns {void} - */ + * @returns {void} + */ hide(): void; /** Hide the specified button element from the ejGroupButton control. - * @param {JQuery} Specific button element - * @returns {void} - */ + * @param {JQuery} Specific button element + * @returns {void} + */ hideItem(element: JQuery): void; /** Returns the disabled state of the specified element button element in GroupButton as Boolean. - * @returns {boolean} - */ + * @returns {boolean} + */ isDisabled(): boolean; /** Returns the state of the specified button element as Boolean. - * @returns {boolean} - */ + * @returns {boolean} + */ isSelected(): boolean; /** Public method used to select the specified button element from the ejGroupButton control. - * @param {JQuery} Specific button element - * @returns {void} - */ + * @param {JQuery} Specific button element + * @returns {void} + */ selectItem(element: JQuery): void; /** Shows the GroupButton control, if its hide. - * @returns {void} - */ + * @returns {void} + */ show(): void; /** Show the specified hidden button element from the ejGroupButton control. - * @param {JQuery} Specific button element - * @returns {void} - */ + * @param {JQuery} Specific button element + * @returns {void} + */ showItem(element: JQuery): void; } export namespace GroupButton { @@ -36321,71 +36321,71 @@ export namespace GroupButton { export interface Model { /** Sets the specified class to GroupButton wrapper element, which allows for custom skinning option in ejGroupButton control. - */ + */ cssClass?: string; /** To set the local JSON data, define a JSON array and initialize the GroupButton with dataSource property. Specify the column names in the fields property. - * @Default {null} - */ + * @Default {null} + */ dataSource?: any; /** Displays the ejGroupButton in Right to Left direction. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Used to enable or disable the ejGroupButton control. - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Gets or sets a value that indicates to display the values of the data. - * @Default {null} - */ + * @Default {null} + */ fields?: any; /** Sets the GroupButton behavior to works as Checkbox mode/ radio button mode based on the specified option. - * @Default {ej.GroupButtonMode.RadioButton} - */ + * @Default {ej.GroupButtonMode.RadioButton} + */ groupButtonMode?: ej.GroupButtonMode | string; /** Used to sets the height of the ejGroupButton control. - * @Default {28} - */ + * @Default {28} + */ height?: string|number; /** Defines the characteristics of the ejGroupButton control and extend the capability of an HTML element by adding specified attributes to element tag and by performing the related actions - * @Default {{}} - */ + * @Default {{}} + */ htmlAttributes?: any; /** Specify the orientation of the GroupButton. See below to get available orientations - * @Default {ej.Orientation.Horizontal} - */ + * @Default {ej.Orientation.Horizontal} + */ orientation?: ej.Orientation|string; /** Query the dataSource from the table for Groupbutton - * @Default {null} - */ + * @Default {null} + */ query?: any; /** Sets the list of button elements to be selected. To enable this option groupButtonMode should be in Ă¢â‚¬Å“checkboxĂ¢â‚¬Â mode. - * @Default {[]} - */ + * @Default {[]} + */ selectedItemIndex?: number[]|string[]; /** Sets the rounder corner to the GroupButton, if sets as true. - * @Default {false} - */ + * @Default {false} + */ showRoundedCorner?: boolean; /** Specifies the size of the button. See available size - * @Default {ej.ButtonSize.Normal} - */ + * @Default {ej.ButtonSize.Normal} + */ size?: ej.ButtonSize|string; /** Defines the width of the ejGroupButton control. - */ + */ width?: string|number; /** Triggered before any button element in the GroupButton get selected. */ @@ -36407,147 +36407,147 @@ export interface Model { export interface BeforeSelectEventArgs { /** Boolean value based on whether the button element is disabled or not. - */ + */ disabled?: boolean; /** Returns the selection button element. - */ + */ element?: any; /** Event object - */ + */ event?: any; /** Return the button element ID. - */ + */ id?: string; /** Button item index. - */ + */ index?: number; /** returns the button model - */ + */ model?: ej.GroupButton.Model ; /** Boolean value based on whether the button element is selected or not. - */ + */ selected?: boolean; /** returns the name of the event - */ + */ type?: string; /** return the button state - */ + */ status?: boolean; } export interface CreateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the GroupButton model - */ + */ model?: ej.GroupButton.Model; /** returns the name of the event - */ + */ type?: string; } export interface DestroyEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the GroupButton model - */ + */ model?: ej.GroupButton.Model; /** returns the name of the event - */ + */ type?: string; } export interface KeyPressEventArgs { /** Boolean value based on whether the button element is disabled or not. - */ + */ disabled?: boolean; /** Returns the selection button element. - */ + */ element?: any; /** Event object - */ + */ event?: any; /** Return the button element ID. - */ + */ id?: string; /** Button item index. - */ + */ index?: number; /** returns the button model - */ + */ model?: ej.GroupButton.Model; /** Boolean value based on whether the button element is selected or not. - */ + */ selected?: boolean; /** returns the name of the event - */ + */ type?: string; /** return the button state - */ + */ status?: boolean; } export interface SelectEventArgs { /** Boolean value based on whether the selected button element is disabled or not. - */ + */ disabled?: boolean; /** Returns the selection button element. - */ + */ element?: any; /** Event object - */ + */ event?: any; /** Return the selected button element ID. - */ + */ id?: string; /** Selected button item index. - */ + */ index?: number; /** returns the button model - */ + */ model?: ej.GroupButton.Model; /** Boolean value based on whether the button element is selected or not. - */ + */ selected?: boolean; /** returns the name of the event - */ + */ type?: string; /** return the button state - */ + */ status?: boolean; } } @@ -36566,23 +36566,23 @@ class NavigationDrawer extends ej.Widget { defaults: NavigationDrawer.Model; /** To close the navigation drawer control - * @returns {void} - */ + * @returns {void} + */ close(): void; /** To load AJAX content into NavigationDrawer container. - * @returns {void} - */ + * @returns {void} + */ loadContent(): void; /** To open the navigation drawer control - * @returns {void} - */ + * @returns {void} + */ open(): void; /** To Toggle the navigation drawer control - * @returns {void} - */ + * @returns {void} + */ toggle(): void; } export namespace NavigationDrawer { @@ -36590,61 +36590,61 @@ export namespace NavigationDrawer { export interface Model { /** Specifies the ajaxSettings option to load the content to the NavigationDrawer control. - * @Default {null} - */ + * @Default {null} + */ ajaxSettings?: AjaxSettings; /** Specifies the contentId for navigation drawer, where the AJAX content need to updated - * @Default {null} - */ + * @Default {null} + */ contentId?: string; /** Sets the root class for NavigationDrawer theme. This cssClass API helps to use custom skinning option for NavigationDrawer control. - * By defining the root class using this API, we need to include this root class in CSS. - */ + * By defining the root class using this API, we need to include this root class in CSS. + */ cssClass?: string; /** Sets the Direction for the control. See Direction - * @Default {left} - */ + * @Default {left} + */ direction?: ej.Direction|string; /** Sets the listview to be enabled or not - * @Default {false} - */ + * @Default {false} + */ enableListView?: boolean; /** Specifies the listview items as an array of object. - * @Default {[]} - */ + * @Default {[]} + */ items?: any[]; /** Sets all the properties of listview to render in navigation drawer - */ + */ listViewSettings?: any; /** Specifies position whether it is in fixed or relative to the page. See Position - * @Default {normal} - */ + * @Default {normal} + */ position?: string; /** Specifies the targetId for navigation drawer - */ + */ targetId?: string; /** Sets the rendering type of the control. See Type - * @Default {overlay} - */ + * @Default {overlay} + */ type?: string; /** Specifies the width of the control - * @Default {auto} - */ + * @Default {auto} + */ width?: number; /** Navigation pane opened initially when isPaneOpen property is true. - * @Default {false} - */ + * @Default {false} + */ isPaneOpen?: boolean; /** Event triggers after the AJAX content loaded completely. */ @@ -36669,133 +36669,133 @@ export interface Model { export interface AjaxCompleteEventArgs { /** returns true if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the name of the event. - */ + */ type?: string; /** returns the model value of the control. - */ + */ model?: ej.NavigationDrawer.Model; } export interface AjaxErrorEventArgs { /** returns true if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the name of the event. - */ + */ type?: string; /** returns the model value of the control. - */ + */ model?: ej.NavigationDrawer.Model; /** returns the error thrown in the AJAX post. - */ + */ errorThrown?: any; /** returns the status. - */ + */ textStatus?: any; } export interface AjaxSuccessEventArgs { /** returns true if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the name of the event. - */ + */ type?: string; /** returns the model value of the control. - */ + */ model?: ej.NavigationDrawer.Model; /** returns the AJAX current content. - */ + */ content?: string; /** returns the current URL of the AJAX post. - */ + */ URL?: string; } export interface BeforeCloseEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Navigation Drawer model - */ + */ model?: ej.NavigationDrawer.Model; /** returns the name of the event - */ + */ type?: string; } export interface OpenEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Navigation Drawer model - */ + */ model?: ej.NavigationDrawer.Model; /** returns the name of the event - */ + */ type?: string; } export interface SwipeEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Navigation Drawer model - */ + */ model?: ej.NavigationDrawer.Model; /** returns the name of the event - */ + */ type?: string; } export interface AjaxSettings { /** It specifies, whether to enable or disable asynchronous request. - */ + */ async?: boolean; /** It specifies the page will be cached in the web browser. - */ + */ cache?: boolean; /** It specifies the type of data is send in the query string. - */ + */ contentType?: string; /** It specifies the data as an object, will be passed in the query string. - */ + */ data?: any; /** It specifies the type of data that you're expecting back from the response. - */ + */ dataType?: string; /** It specifies the HTTP request type. - */ + */ type?: string; } } @@ -36808,90 +36808,90 @@ class RadialMenu extends ej.Widget { defaults: RadialMenu.Model; /** To hide the radialmenu - * @returns {void} - */ + * @returns {void} + */ hide(): void; /** To hide the radialmenu items - * @returns {void} - */ + * @returns {void} + */ hideMenu(): void; /** To Show the radial menu - * @returns {void} - */ + * @returns {void} + */ show(): void; /** To show menu items - * @returns {void} - */ + * @returns {void} + */ showMenu(): void; /** To enable menu item using index - * @param {number} Index of the Radialmenu to be enabled. - * @returns {void} - */ + * @param {number} Index of the Radialmenu to be enabled. + * @returns {void} + */ enableItemByIndex(itemIndex: number): void; /** To enable menu items using indices - * @param {Array} Index of the Radialmenu to be enabled. - * @returns {void} - */ + * @param {Array} Index of the Radialmenu to be enabled. + * @returns {void} + */ enableItemsByIndices(itemIndices: any[]): void; /** To disable menu item using index - * @param {number} Index of the Radialmenu to be disabled. - * @returns {void} - */ + * @param {number} Index of the Radialmenu to be disabled. + * @returns {void} + */ disableItemByIndex(itemIndex: number): void; /** To disable menu items using indices - * @param {Array} items of the Radialmenu to disable. - * @returns {void} - */ + * @param {Array} items of the Radialmenu to disable. + * @returns {void} + */ disableItemsByIndices(itemIndices: any[]): void; /** To enable menu item using item text - * @param {string} item of the Radialmenu item to enable. - * @returns {void} - */ + * @param {string} item of the Radialmenu item to enable. + * @returns {void} + */ enableItem(item: string): void; /** To disable menu item using item text - * @param {string} item of the Radialmenu item to disable. - * @returns {void} - */ + * @param {string} item of the Radialmenu item to disable. + * @returns {void} + */ disableItem(item: string): void; /** To enable menu items using item texts - * @param {Array} items of the Radialmenu item to enable. - * @returns {void} - */ + * @param {Array} items of the Radialmenu item to enable. + * @returns {void} + */ enableItems(items: any[]): void; /** To disable menu items using item texts - * @param {Array} items of the Radialmenu item to disable. - * @returns {void} - */ + * @param {Array} items of the Radialmenu item to disable. + * @returns {void} + */ disableItems(items: any[]): void; /** To update menu item badge value - * @param {number} The index value to add the given items at the specified index. If index is not specified, the given value will not be updated. - * @param {number} The Value to be updated in the badge. It will be updated based on the given index - * @returns {void} - */ + * @param {number} The index value to add the given items at the specified index. If index is not specified, the given value will not be updated. + * @param {number} The Value to be updated in the badge. It will be updated based on the given index + * @returns {void} + */ updateBadgeValue(index: number, value: number): void; /** To show menu item badge - * @param {number} Index of the Radialmenu item to be shown badge. - * @returns {void} - */ + * @param {number} Index of the Radialmenu item to be shown badge. + * @returns {void} + */ showBadge(index: number): void; /** To hide menu item badge - * @param {number} Index of the Radialmenu item to hide the badge. - * @returns {void} - */ + * @param {number} Index of the Radialmenu item to hide the badge. + * @returns {void} + */ hideBadge(index: number): void; } export namespace RadialMenu { @@ -36899,40 +36899,40 @@ export namespace RadialMenu { export interface Model { /** To show the Radial in initial render. - */ + */ autoOpen?: boolean; /** Renders the back button Image for Radial using class. - */ + */ backImageClass?: string; /** Sets the root class for RadialMenu theme. This cssClass API helps to use custom skinning option for RadialMenu control. By defining the root class using this API, - * we need to include this root class in CSS. - */ + * we need to include this root class in CSS. + */ cssClass?: string; /** To enable Animation for Radial Menu. - */ + */ enableAnimation?: boolean; /** Renders the Image for Radial using Class. - */ + */ imageClass?: string; /** Specify the items of radial menu - */ + */ items?: Item[]; /** Specifies the radius of radial menu - */ + */ radius?: number; /** To show the Radial while clicking given target element. - */ + */ targetElementId?: string; /** To set radial render position. - */ + */ position?: any; /** Event triggers when we click an item. */ @@ -36948,114 +36948,114 @@ export interface Model { export interface ClickEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Radialmenu model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; /** returns the item of element - */ + */ item?: any; /** returns the name of item - */ + */ itemName?: string; } export interface OpenEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Radialmenu model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface CloseEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Radialmenu model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface ItemsBadge { /** Specifies whether to enable radialmenu item badge or not. - */ + */ enabled?: boolean; /** Specifies the value of radial menu item badge. - */ + */ value?: number; } export interface ItemsSliderSettings { /** Specifies the sliderSettings ticks values of nested radial menu items. - */ + */ ticks?: any[]; /** Specifies the sliderSettings stroke Width value. - */ + */ strokeWidth?: number; /** Specifies the value of sliderSettings labelSpace . - */ + */ labelSpace?: number; } export interface Item { /** Specify the URL of the frame background image for radial menu item. - */ + */ imageUrl?: string; /** Specifies the text of RadialMenu item. - */ + */ text?: string; /** Specifies the enable state of RadialMenu item. - */ + */ enabled?: boolean; /** specify the click event to corresponding image/text for performing some specific action. - */ + */ click?: string; /** Specifies radialmenu item badges. - */ + */ badge?: ItemsBadge; /** Specifies the type of nested radial menu item. - */ + */ type?: string; /** Specifies the sliderSettings ticks for nested radial menu items. - */ + */ sliderSettings?: ItemsSliderSettings; /** Specifies to add sub level items . - */ + */ items?: any[]; } } @@ -37068,10 +37068,10 @@ class Tile extends ej.Widget { defaults: Tile.Model; /** Update the image template of tile item to another one. - * @param {string} UpdateTemplate by using id - * @param {number} index of the tile - * @returns {void} - */ + * @param {string} UpdateTemplate by using id + * @param {number} index of the tile + * @returns {void} + */ updateTemplate(id: string, index: number): void; } export namespace Tile { @@ -37079,78 +37079,78 @@ export namespace Tile { export interface Model { /** Section for badge specific functionalities and it represents the notification for tile items. - */ + */ badge?: Badge; /** Section for caption specific functionalities and it represents the notification for tile items. - */ + */ caption?: Caption; /** Sets the root class for Tile theme. This cssClass API helps to use custom skinning option for Tile control. By defining the root class using this API, we need to include this root class in CSS. - */ + */ cssClass?: string; /** Saves current model value to browser cookies for state maintains. While refreshing the page retains the model value applies from browser cookies. - * @Default {false} - */ + * @Default {false} + */ enablePersistence?: boolean; /** Customize the tile size height. - * @Default {null} - */ + * @Default {null} + */ height?: number; /** Specifies Tile imageClass, using this property we can give images for each tile through CSS classes. - * @Default {null} - */ + * @Default {null} + */ imageClass?: string; /** Specifies the position of tile image. - * @Default {center} - */ + * @Default {center} + */ imagePosition?: ej.Tile.ImagePosition|string; /** Specifies the tile image in outside of template content. - * @Default {null} - */ + * @Default {null} + */ imageTemplateId?: string; /** Specifies the URL of tile image. - * @Default {null} - */ + * @Default {null} + */ imageUrl?: string; /** Set the localization culture for Tile Widget. - */ + */ locale?: string; /** Section for liveTile specific functionalities. - */ + */ liveTile?: LiveTile; /** Specifies the size of a tile. See tileSize - * @Default {small} - */ + * @Default {small} + */ tileSize?: ej.Tile.TileSize|string; /** Customize the tile size width. - * @Default {null} - */ + * @Default {null} + */ width?: number; /** Sets the rounded corner to tile. - * @Default {false} - */ + * @Default {false} + */ showRoundedCorner?: boolean; /** Sets allowSelection to tile. - * @Default {false} - */ + * @Default {false} + */ allowSelection?: boolean; /** Sets the background color to tile. - * @Default {null} - */ + * @Default {null} + */ backgroundColor?: string; /** Event triggers when the mouseDown happens in the tile */ @@ -37163,145 +37163,145 @@ export interface Model { export interface MouseDownEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the tile model - */ + */ model?: boolean; /** returns the name of the event - */ + */ type?: boolean; /** returns the current tile text - */ + */ text?: string; /** returns the index of current tile item - */ + */ index?: number; } export interface MouseUpEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the tile model - */ + */ model?: boolean; /** returns the name of the event - */ + */ type?: boolean; /** returns the current tile text - */ + */ text?: boolean; /** returns the index of current tile item - */ + */ index?: number; } export interface Badge { /** Specifies whether to enable badge or not. - * @Default {false} - */ + * @Default {false} + */ enabled?: boolean; /** Specifies maximum value for tile badge. - * @Default {100} - */ + * @Default {100} + */ maxValue?: number; /** Specifies minimum value for tile badge. - * @Default {1} - */ + * @Default {1} + */ minValue?: number; /** Specifies text instead of number for tile badge. - * @Default {null} - */ + * @Default {null} + */ text?: string; /** Sets value for tile badge. - * @Default {1} - */ + * @Default {1} + */ value?: number; /** Sets position for tile badge. - * @Default {Ă¢â‚¬Å“bottomrightĂ¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“bottomrightĂ¢â‚¬Â} + */ position?: ej.Tile.BadgePosition|string; } export interface Caption { /** Specifies whether the tile text to be shown or hidden. - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Changes the text of a tile. - * @Default {Text} - */ + * @Default {Text} + */ text?: string; /** It is used to align the text of a tile. - * @Default {normal} - */ + * @Default {normal} + */ alignment?: ej.Tile.CaptionAlignment|string; /** It is used to specify the caption position like Inner top, inner bottom and outer. - * @Default {Innerbottom} - */ + * @Default {Innerbottom} + */ position?: ej.Tile.CaptionPosition|string; /** sets the icon instead of text. - * @Default {null} - */ + * @Default {null} + */ icon?: string; } export interface LiveTile { /** Specifies whether to enable liveTile or not. - * @Default {false} - */ + * @Default {false} + */ enabled?: boolean; /** Specifies liveTile images in CSS classes. - * @Default {null} - */ + * @Default {null} + */ imageClass?: any[]; /** Specifies liveTile images in templates. - * @Default {null} - */ + * @Default {null} + */ imageTemplateId?: any[]; /** Specifies liveTile images in CSS classes. - * @Default {null} - */ + * @Default {null} + */ imageUrl?: any[]; /** Specifies liveTile type for Tile. See orientation - * @Default {flip} - */ + * @Default {flip} + */ type?: ej.Tile.liveTileType|string; /** Specifies time interval between two successive liveTile animation - * @Default {2000} - */ + * @Default {2000} + */ updateInterval?: number; /** Sets the text to each living tile - * @Default {Null} - */ + * @Default {Null} + */ text?: any[]; } @@ -37416,48 +37416,48 @@ class Signature extends ej.Widget { defaults: Signature.Model; /** Clears the strokes in the signature. - * @returns {void} - */ + * @returns {void} + */ clear(): void; /** Destroys the signature widget. - * @returns {void} - */ + * @returns {void} + */ destroy(): void; /** Disables the signature widget. - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** Enables the signature widget. - * @returns {void} - */ + * @returns {void} + */ enable(): void; /** Hides the signature widget. - * @returns {void} - */ + * @returns {void} + */ hide(): void; /** redo the last drawn stroke of the signature - * @returns {void} - */ + * @returns {void} + */ redo(): void; /** used to save the drawn image. - * @returns {void} - */ + * @returns {void} + */ save(): void; /** Used to Show the signature widget, if it is already hided. - * @returns {void} - */ + * @returns {void} + */ show(): void; /** undo the last drawn stroke of the signature. - * @returns {void} - */ + * @returns {void} + */ undo(): void; } export namespace Signature { @@ -37465,56 +37465,56 @@ export namespace Signature { export interface Model { /** This property is used to set the background color for the signature. - * @Default {#ffffff} - */ + * @Default {#ffffff} + */ backgroundColor?: string; /** This property is used to set the background image for the signature. - */ + */ backgroundImage?: string; /** Enables or disables the Signature textbox widget. - * @Default {true} - */ + * @Default {true} + */ enabled?: boolean; /** Sets the height of the Signature control. - * @Default {100%} - */ + * @Default {100%} + */ height?: string; /** Enables/disables responsive support for the signature control (i.e) maintain the signature drawing during the window resizing time. - * @Default {false} - */ + * @Default {false} + */ isResponsive?: boolean; /** Allows the type of the image format to be saved when the signature image is saved. - */ + */ saveImageFormat?: ej.Signature.SaveImageFormat|string; /** Allows the signature image to be saved along with its background. - * @Default {false} - */ + * @Default {false} + */ saveWithBackground?: boolean; /** Enables or disables rounded corner. - * @Default {true} - */ + * @Default {true} + */ showRoundedCorner?: boolean; /** Sets the stroke color for the stroke of the signature. - * @Default {#000000} - */ + * @Default {#000000} + */ strokeColor?: string; /** Sets the stroke width for the stroke of the signature. - * @Default {2} - */ + * @Default {2} + */ strokeWidth?: number; /** Sets the width of the Signature control. - * @Default {100%} - */ + * @Default {100%} + */ width?: string; /** Triggers when the stroke is changed. */ @@ -37533,76 +37533,76 @@ export interface Model { export interface ChangeEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the signature model object. - */ + */ model?: ej.Signature.Model; /** Name of the event. - */ + */ type?: string; /** Gives the last stored image - */ + */ lastImage?: string; } export interface MouseDownEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the signature model object. - */ + */ model?: ej.Signature.Model; /** Name of the event. - */ + */ type?: string; /** returns all the event values - */ + */ value?: any; } export interface MouseMoveEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the signature model object. - */ + */ model?: ej.Signature.Model; /** Name of the event. - */ + */ type?: string; /** returns all the event values - */ + */ value?: any; } export interface MouseUpEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the signature model object. - */ + */ model?: ej.Signature.Model; /** Name of the event. - */ + */ type?: string; /** returns all the event values - */ + */ value?: any; } @@ -37631,13 +37631,13 @@ class RadialSlider extends ej.Widget { defaults: RadialSlider.Model; /** To show the radialslider - * @returns {void} - */ + * @returns {void} + */ show(): void; /** To hide the radialslider - * @returns {void} - */ + * @returns {void} + */ hide(): void; } export namespace RadialSlider { @@ -37645,77 +37645,77 @@ export namespace RadialSlider { export interface Model { /** To show the RadialSlider in initial render. - * @Default {false} - */ + * @Default {false} + */ autoOpen?: boolean; /** Sets the root class for RadialSlider theme. This cssClass API helps to use custom skinning option for RadialSlider control. - * By defining the root class using this API, we need to include this root class in CSS. - */ + * By defining the root class using this API, we need to include this root class in CSS. + */ cssClass?: string; /** To enable Animation for Radial Slider. - * @Default {true} - */ + * @Default {true} + */ enableAnimation?: boolean; /** Enable/Disable the Roundoff property of RadialSlider - * @Default {true} - */ + * @Default {true} + */ enableRoundOff?: boolean; /** Specifies the endAngle value for radial slider circle. - * @Default {360} - */ + * @Default {360} + */ endAngle?: number; /** Specifies the inline for label show or not on given radius. - * @Default {false} - */ + * @Default {false} + */ inline?: boolean; /** Specifies innerCircleImageClass, using this property we can give images for center radial circle through CSS classes. - * @Default {null} - */ + * @Default {null} + */ innerCircleImageClass?: string; /** Specifies the file name of center circle icon - * @Default {null} - */ + * @Default {null} + */ innerCircleImageUrl?: string; /** Specifies the Space between the radial slider element and the label. - * @Default {30} - */ + * @Default {30} + */ labelSpace?: number; /** Specifies the radius of radial slider - * @Default {200} - */ + * @Default {200} + */ radius?: number; /** To show the RadialSlider inner circle. - * @Default {true} - */ + * @Default {true} + */ showInnerCircle?: boolean; /** Specifies the endAngle value for radial slider circle. - * @Default {0} - */ + * @Default {0} + */ startAngle?: number; /** Specifies the strokeWidth for customize the needle, outer circle and inner circle. - * @Default {2} - */ + * @Default {2} + */ strokeWidth?: number; /** Specifies the ticks value of radial slider - */ + */ ticks?: any[]; /** Specifies the value of radial slider - * @Default {10} - */ + * @Default {10} + */ value?: number; /** Event triggers when the change occurs. */ @@ -37740,122 +37740,122 @@ export interface Model { export interface ChangeEventArgs { /** returns the Radialslider model - */ + */ model?: any; /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the initial value of Radial slider - */ + */ oldValue?: number; /** returns the name of the event - */ + */ type?: string; /** returns the current value of the Radial slider - */ + */ value?: number; } export interface CreateEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Radialslider model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface MouseoverEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Radialslider model - */ + */ model?: any; /** returns the value selected - */ + */ selectedValue?: number; /** returns the name of the event - */ + */ type?: string; /** returns the current value selected in Radial slider - */ + */ value?: number; } export interface SlideEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Radialslider model - */ + */ model?: any; /** returns the value selected in Radial slider - */ + */ selectedValue?: number; /** returns the name of the event - */ + */ type?: string; /** returns the currently selected value - */ + */ value?: number; } export interface StartEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Radialslider model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; /** returns the current value selected in Radial slider - */ + */ value?: number; } export interface StopEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the Radialslider model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; /** returns the current value selected in Radial slider - */ + */ value?: number; } } @@ -37868,536 +37868,536 @@ class Spreadsheet extends ej.Widget { defaults: Spreadsheet.Model; /** This method is used to add custom formulas in Spreadsheet. - * @param {string} Pass the name of the formula. - * @param {string} Pass the name of the function. - * @returns {void} - */ + * @param {string} Pass the name of the formula. + * @param {string} Pass the name of the function. + * @returns {void} + */ addCustomFormula(formulaName: string, functionName: string): void; /** This method is used to add a new sheet in the last position of the sheet container. - * @returns {void} - */ + * @returns {void} + */ addNewSheet(): void; /** It is used to clear all the data and format in the specified range of cells in Spreadsheet. - * @param {string|Array} Optional. If range is specified, then it will clear all content in the specified range else it will use the current selected range. - * @returns {void} - */ + * @param {string|Array} Optional. If range is specified, then it will clear all content in the specified range else it will use the current selected range. + * @returns {void} + */ clearAll(range?: string|any[]): void; /** This property is used to clear all the formats applied in the specified range in Spreadsheet. - * @param {string|Array} Optional. If range is specified, then it will clear all format in the specified range else it will use the current selected range. - * @returns {void} - */ + * @param {string|Array} Optional. If range is specified, then it will clear all format in the specified range else it will use the current selected range. + * @returns {void} + */ clearAllFormat(range?: string|any[]): void; /** Used to clear the applied border in the specified range in Spreadsheet. - * @param {string|Array} Optional. If range is specified, then it will clear border in the specified range else it will use the current selected range. - * @returns {void} - */ + * @param {string|Array} Optional. If range is specified, then it will clear border in the specified range else it will use the current selected range. + * @returns {void} + */ clearBorder(range?: string|any[]): void; /** This property is used to clear the contents in the specified range in Spreadsheet. - * @param {string|Array} Optional. If the range is specified, then it will clear the content in the specified range else it will use the current selected range. - * @returns {void} - */ + * @param {string|Array} Optional. If the range is specified, then it will clear the content in the specified range else it will use the current selected range. + * @returns {void} + */ clearContents(range?: string|any[]): void; /** This method is used to remove only the data in the range denoted by the specified range name. - * @param {string} Pass the defined rangeSettings property name. - * @returns {void} - */ + * @param {string} Pass the defined rangeSettings property name. + * @returns {void} + */ clearRange(rangeName: string): void; /** It is used to remove data in the specified range of cells based on the defined property. - * @param {Array|string} Optional. If range is specified, it will clear data for the specified range else it will use the current selected range. - * @param {string} Optional. If property is specified, it will remove the specified property in the range else it will remove default properties - * @param {any} Optional. - * @param {boolean} Optional. pass {{'`true`' | markdownify}}, if you want to skip the hidden rows - * @param {any} Optional. Pass the status to perform undo and redo operation. - * @param {any} Optional. It specifies whether to skip element processing or not. - * @returns {void} - */ + * @param {Array|string} Optional. If range is specified, it will clear data for the specified range else it will use the current selected range. + * @param {string} Optional. If property is specified, it will remove the specified property in the range else it will remove default properties + * @param {any} Optional. + * @param {boolean} Optional. pass {{'`true`' | markdownify}}, if you want to skip the hidden rows + * @param {any} Optional. Pass the status to perform undo and redo operation. + * @param {any} Optional. It specifies whether to skip element processing or not. + * @returns {void} + */ clearRangeData(range?: any[]|string, property?: string, cells?: any, skipHiddenRow?: boolean, status?: any, skipCell?: any): void; /** This method is used to clear undo and redo collections in the Spreadsheet. - * @returns {void} - */ + * @returns {void} + */ clearUndoRedo(): void; /** This method is used to copy or move the sheets in Spreadsheet. - * @param {number} Pass the sheet index that you want to copy or move. - * @param {number} Pass the position index where you want to copy or move. - * @param {boolean} Pass {{'`true`' | markdownify}},If you want to copy sheet or else it will move sheet. - * @returns {void} - */ + * @param {number} Pass the sheet index that you want to copy or move. + * @param {number} Pass the position index where you want to copy or move. + * @param {boolean} Pass {{'`true`' | markdownify}},If you want to copy sheet or else it will move sheet. + * @returns {void} + */ copySheet(fromIdx: number, toIdx: number, isCopySheet: boolean): void; /** This method is used to delete the entire column which is selected. - * @param {number} Pass the start column index. - * @param {number} Pass the end column index. - * @returns {void} - */ + * @param {number} Pass the start column index. + * @param {number} Pass the end column index. + * @returns {void} + */ deleteEntireColumn(startCol: number, endCol: number): void; /** This method is used to delete the entire row which is selected. - * @param {number} Pass the start row index. - * @param {number} Pass the end row index. - * @returns {void} - */ + * @param {number} Pass the start row index. + * @param {number} Pass the end row index. + * @returns {void} + */ deleteEntireRow(startRow: number, endRow: number): void; /** This method is used to delete a particular sheet in the Spreadsheet. - * @param {number} Pass the sheet index to perform delete action. - * @returns {void} - */ + * @param {number} Pass the sheet index to perform delete action. + * @returns {void} + */ deleteSheet(idx: number): void; /** This method is used to delete the selected cells and shift the remaining cells to left. - * @param {any} Row index and column index of the starting cell. - * @param {any} Row index and column index of the ending cell. - * @returns {void} - */ + * @param {any} Row index and column index of the starting cell. + * @param {any} Row index and column index of the ending cell. + * @returns {void} + */ deleteShiftLeft(startCell: any, endCell: any): void; /** This method is used to delete the selected cells and shift the remaining cells up. - * @param {any} Row index and column index of the start cell. - * @param {any} Row index and column index of the end cell. - * @returns {void} - */ + * @param {any} Row index and column index of the start cell. + * @param {any} Row index and column index of the end cell. + * @returns {void} + */ deleteShiftUp(startCell: any, endCell: any): void; /** This method is used to edit data in the specified range of cells based on its corresponding rangeSettings. - * @param {string} Pass the defined rangeSettings property name. - * @param {Function} Pass the function that you want to perform range edit. - * @returns {void} - */ + * @param {string} Pass the defined rangeSettings property name. + * @param {Function} Pass the function that you want to perform range edit. + * @returns {void} + */ editRange(rangeName: string, fn: any): void; /** This method is used to get the activation panel in the Spreadsheet. - * @returns {HTMLElement} - */ + * @returns {HTMLElement} + */ getActivationPanel(): HTMLElement; /** This method is used to get the active cell object in Spreadsheet. It will returns object which contains rowIndex and colIndex of the active cell. - * @param {number} Optional. If sheetIdx is specified, it will return the active cell object in specified sheet index else it will use the current sheet index - * @returns {any} - */ + * @param {number} Optional. If sheetIdx is specified, it will return the active cell object in specified sheet index else it will use the current sheet index + * @returns {any} + */ getActiveCell(sheetIdx?: number): any; /** This method is used to get the active cell element based on the given sheet index in the Spreadsheet. - * @param {number} Optional. If sheetIndex is specified, it will return the active cell element in specified sheet index else it will use the current active sheet index. - * @returns {HTMLElement} - */ + * @param {number} Optional. If sheetIndex is specified, it will return the active cell element in specified sheet index else it will use the current active sheet index. + * @returns {HTMLElement} + */ getActiveCellElem(sheetIdx?: number): HTMLElement; /** This method is used to get the current active sheet index in Spreadsheet. - * @returns {number} - */ + * @returns {number} + */ getActiveSheetIndex(): number; /** This method is used to get the auto fill element in Spreadsheet. - * @returns {HTMLElement} - */ + * @returns {HTMLElement} + */ getAutoFillElem(): HTMLElement; /** This method is used to get the cell element based on specified row and column index in the Spreadsheet. - * @param {number} Pass the row index. - * @param {number} Pass the column index. - * @param {number} Optional. Pass the sheet index that you want to get cell. - * @returns {HTMLElement} - */ + * @param {number} Pass the row index. + * @param {number} Pass the column index. + * @param {number} Optional. Pass the sheet index that you want to get cell. + * @returns {HTMLElement} + */ getCell(rowIdx: number, colIdx: number, sheetIdx?: number): HTMLElement; /** This method is used to get the data settings in the Spreadsheet. - * @param {number} Pass the sheet index. - * @returns {number} - */ + * @param {number} Pass the sheet index. + * @returns {number} + */ getDataSettings(sheetIdx: number): number; /** This method is used to get the frozen columns index in the Spreadsheet. - * @param {number} Pass the sheet index. - * @returns {number} - */ + * @param {number} Pass the sheet index. + * @returns {number} + */ getFrozenColumns(sheetIdx: number): number; /** This method is used to get the frozen row index in Spreadsheet. - * @param {number} Pass the sheet index. - * @returns {number} - */ + * @param {number} Pass the sheet index. + * @returns {number} + */ getFrozenRows(sheetIdx: number): number; /** This method is used to get the hyperlink data as object from the specified cell in Spreadsheet. - * @param {HTMLElement} Pass the DOM element to get hyperlink - * @returns {any} - */ + * @param {HTMLElement} Pass the DOM element to get hyperlink + * @returns {any} + */ getHyperlink(cell: HTMLElement): any; /** This method is used to get all cell elements in the specified range. - * @param {string} Pass the range that you want to get the cells. - * @param {number} Pass the index of the sheet. - * @param {boolean} Optional. Pass {{'`true`' | markdownify}}, if you want to skip the hidden rows. - * @returns {HTMLElement} - */ + * @param {string} Pass the range that you want to get the cells. + * @param {number} Pass the index of the sheet. + * @param {boolean} Optional. Pass {{'`true`' | markdownify}}, if you want to skip the hidden rows. + * @returns {HTMLElement} + */ getRange(range: string, sheetIdx: number, skipHiddenRow?: boolean): HTMLElement; /** This method is used to get the data in specified range in Spreadsheet. - * @param {any} Optional. Pass the range, property, sheetIdx, valueOnly in options. - * @returns {Array} - */ + * @param {any} Optional. Pass the range, property, sheetIdx, valueOnly in options. + * @returns {Array} + */ getRangeData(options?: any): any[]; /** This method is used to get the range indices array based on the specified alpha range in Spreadsheet. - * @param {string} Pass the alpha range that you want to get range indices. - * @returns {Array} - */ + * @param {string} Pass the alpha range that you want to get range indices. + * @returns {Array} + */ getRangeIndices(range: string): any[]; /** This method is used to get the sheet details based on the given sheet index in Spreadsheet. - * @param {number} Pass the sheet index to get the sheet object. - * @returns {any} - */ + * @param {number} Pass the sheet index to get the sheet object. + * @returns {any} + */ getSheet(sheetIdx: number): any; /** This method is used to get the sheet content div element of Spreadsheet. - * @param {number} Pass the sheet index to get the sheet content. - * @returns {HTMLElement} - */ + * @param {number} Pass the sheet index to get the sheet content. + * @returns {HTMLElement} + */ getSheetElement(sheetIdx: number): HTMLElement; /** This method is used to get all the sheets in workbook. - * @returns {Array} - */ + * @returns {Array} + */ getSheets(): any[]; /** This method is used to send a paging request to the specified sheet Index in the Spreadsheet. - * @param {number} Pass the sheet index to perform paging at specified sheet index - * @param {boolean} Pass {{'`true`' | markdownify}} to create a new sheet. If the specified sheet index is already exist, it navigate to that sheet else it create a new sheet. - * @returns {void} - */ + * @param {number} Pass the sheet index to perform paging at specified sheet index + * @param {boolean} Pass {{'`true`' | markdownify}} to create a new sheet. If the specified sheet index is already exist, it navigate to that sheet else it create a new sheet. + * @returns {void} + */ gotoPage(sheetIdx: number, newSheet: boolean): void; /** This method is used to hide the entire columns from the specified range (startCol, endCol) in Spreadsheet. - * @param {number} Index of the start column. - * @param {number} Optional. Index of the end column. - * @returns {void} - */ + * @param {number} Index of the start column. + * @param {number} Optional. Index of the end column. + * @returns {void} + */ hideColumn(startCol: number, endCol: number): void; /** This method is used to hide the formula bar in Spreadsheet. - * @returns {void} - */ + * @returns {void} + */ hideFormulaBar(): void; /** This method is used to hide the rows, based on the specified row index in Spreadsheet. - * @param {number} Index of the start row. - * @param {number} Optional. Index of the end row. - * @returns {void} - */ + * @param {number} Index of the start row. + * @param {number} Optional. Index of the end row. + * @returns {void} + */ hideRow(startRow: number, endRow: number): void; /** This method is used to hide the sheet based on the specified sheetIndex or sheet name in the Spreadsheet. - * @param {string|number} Pass the sheet name or index that you want to hide. - * @returns {void} - */ + * @param {string|number} Pass the sheet name or index that you want to hide. + * @returns {void} + */ hideSheet(sheetIdx: string|number): void; /** This method is used to hide the displayed waiting pop-up in Spreadsheet. - * @returns {void} - */ + * @returns {void} + */ hideWaitingPopUp(): void; /** This method is used to insert a column before the active cell's column in the Spreadsheet. - * @param {number} Pass start column. - * @param {number} Pass end column. - * @returns {void} - */ + * @param {number} Pass start column. + * @param {number} Pass end column. + * @returns {void} + */ insertEntireColumn(startCol: number, endCol: number): void; /** This method is used to insert a row before the active cell's row in the Spreadsheet. - * @param {number} Pass start row. - * @param {number} Pass end row. - * @returns {void} - */ + * @param {number} Pass start row. + * @param {number} Pass end row. + * @returns {void} + */ insertEntireRow(startRow: number, endRow: number): void; /** This method is used to insert a new sheet to the left of the current active sheet. - * @returns {void} - */ + * @returns {void} + */ insertSheet(): void; /** This method is used to insert cells in the selected or specified range and shift remaining cells to bottom. - * @param {any} Row index and column index of the start cell. - * @param {any} Row index and column index of the end cell. - * @returns {void} - */ + * @param {any} Row index and column index of the start cell. + * @param {any} Row index and column index of the end cell. + * @returns {void} + */ insertShiftBottom(startCell: any, endCell: any): void; /** This method is used to insert cells in the selected or specified range and shift remaining cells to right. - * @param {any} Row index and column index of the start cell. - * @param {any} Row index and column index of the end cell. - * @returns {void} - */ + * @param {any} Row index and column index of the start cell. + * @param {any} Row index and column index of the end cell. + * @returns {void} + */ insertShiftRight(startCell: any, endCell: any): void; /** This method is used to import excel file manually by using form data. - * @param {any} Pass the form data object to import files manually. - * @returns {void} - */ + * @param {any} Pass the form data object to import files manually. + * @returns {void} + */ import(importRequest: any): void; /** This method is used to load JSON data in Spreadsheet. - * @param {any} Pass the response that you want to load. - * @returns {void} - */ + * @param {any} Pass the response that you want to load. + * @returns {void} + */ loadFromJSON(response: any): void; /** This method is used to lock/unlock the range of cells in active sheet. Lock cells are activated only after the sheet is protected. Once the sheet is protected it is unable to lock/unlock cells. - * @param {string|Array} Pass the alpha range cells or array range of cells. - * @param {string} Optional. By default is {{'`true`' | markdownify}}. If it is {{'`false`' | markdownify}} locked cells are unlocked. - * @returns {void} - */ + * @param {string|Array} Pass the alpha range cells or array range of cells. + * @param {string} Optional. By default is {{'`true`' | markdownify}}. If it is {{'`false`' | markdownify}} locked cells are unlocked. + * @returns {void} + */ lockCells(range: string|any[], isLocked?: string): void; /** This method is used to merge cells by across in the Spreadsheet. - * @param {string} Optional. To pass the cell range or selected cells are process. - * @param {boolean} Optional. If pass {{'`true`' | markdownify}} it does not show alert. - * @returns {void} - */ + * @param {string} Optional. To pass the cell range or selected cells are process. + * @param {boolean} Optional. If pass {{'`true`' | markdownify}} it does not show alert. + * @returns {void} + */ mergeAcrossCells(range?: string, alertStatus?: boolean): void; /** This method is used to merge the selected cells in the Spreadsheet. - * @param {string|Array} Optional. To pass the cell range or selected cells are process. - * @param {boolean} Optional. If pass {{'`true`' | markdownify}} it does not show alert. - * @returns {void} - */ + * @param {string|Array} Optional. To pass the cell range or selected cells are process. + * @param {boolean} Optional. If pass {{'`true`' | markdownify}} it does not show alert. + * @returns {void} + */ mergeCells(range?: string|any[], alertStatus?: boolean): void; /** This method is used to select a cell or range in the Spreadsheet. - * @param {any} Pass the start cell to perform selection. - * @param {any} Pass the end cell to perform selection. - * @returns {void} - */ + * @param {any} Pass the start cell to perform selection. + * @param {any} Pass the end cell to perform selection. + * @returns {void} + */ performSelection(startCell: any, endCell: any): void; /** This method is used to protect or unprotect active sheet. - * @param {boolean} Optional. By default is {{'`true`' | markdownify}}. If it is {{'`false`' | markdownify}} active sheet is unprotected. - * @returns {void} - */ + * @param {boolean} Optional. By default is {{'`true`' | markdownify}}. If it is {{'`false`' | markdownify}} active sheet is unprotected. + * @returns {void} + */ protectSheet(isProtected?: boolean): void; /** This method is used to refresh the content in Spreadsheet. - * @param {number} Pass the index of the sheet. - * @returns {void} - */ + * @param {number} Pass the index of the sheet. + * @returns {void} + */ refreshContent(sheetIdx: number): void; /** This method is used to refresh the Spreadsheet. - * @returns {void} - */ + * @returns {void} + */ refreshSpreadsheet(): void; /** This method is used to remove custom formulae in Spreadsheet. - * @param {string} Pass the name of the formula. - * @param {string} Pass the name of the function. - * @returns {void} - */ + * @param {string} Pass the name of the formula. + * @param {string} Pass the name of the function. + * @returns {void} + */ removeCustomFormula(formulaName: string, functionName: string): void; /** This method is used to remove the hyperlink from selected cells of current sheet. - * @param {string} Hyperlink remove from the specified range. - * @param {boolean} Optional. If it is {{'`true`' | markdownify}}, It will clear link only not format. - * @param {boolean} Optional. Pass the status to perform undo and redo operations. - * @param {any} Optional. Pass the cells that you want to remove hyperlink. - * @param {boolean} Optional. Pass {{'`true`' | markdownify}}, if you want to skip the hidden rows. - * @returns {void} - */ + * @param {string} Hyperlink remove from the specified range. + * @param {boolean} Optional. If it is {{'`true`' | markdownify}}, It will clear link only not format. + * @param {boolean} Optional. Pass the status to perform undo and redo operations. + * @param {any} Optional. Pass the cells that you want to remove hyperlink. + * @param {boolean} Optional. Pass {{'`true`' | markdownify}}, if you want to skip the hidden rows. + * @returns {void} + */ removeHyperlink(range: string, isClearHLink?: boolean, status?: boolean, cells?: any, skipHiddenRow?: boolean): void; /** This method is used to remove the range data and its defined rangeSettings property based on the specified range name. - * @param {string} Pass the defined rangeSetting property name. - * @returns {void} - */ + * @param {string} Pass the defined rangeSetting property name. + * @returns {void} + */ removeRange(rangeName: string): void; /** This method is used to remove the readonly option for the specified range. - * @param {string|Array} Pass the range. - * @returns {void} - */ + * @param {string|Array} Pass the range. + * @returns {void} + */ removeReadOnly(range?: string|any[]): void; /** This method is used to save JSON data in Spreadsheet. - * @returns {any} - */ + * @returns {any} + */ saveAsJSON(): any; /** This method is used to save batch changes in Spreadsheet. - * @param {number} Pass the sheet index for Spreadsheet. - * @returns {void} - */ + * @param {number} Pass the sheet index for Spreadsheet. + * @returns {void} + */ saveBatchChanges(sheetIdx: number): void; /** This method is used to set the active cell in the Spreadsheet. - * @param {number} Pass the row index. - * @param {number} Pass the column index. - * @param {number} Pass the index of the sheet. - * @returns {void} - */ + * @param {number} Pass the row index. + * @param {number} Pass the column index. + * @param {number} Pass the index of the sheet. + * @returns {void} + */ setActiveCell(rowIdx: number, colIdx: number, sheetIdx: number): void; /** This method is used to set active sheet index for the Spreadsheet. - * @param {number} Pass the active sheet index for Spreadsheet. - * @returns {void} - */ + * @param {number} Pass the active sheet index for Spreadsheet. + * @returns {void} + */ setActiveSheetIndex(sheetIdx: number): void; /** This method is used to set border for the specified range of cells in the Spreadsheet. - * @param {any} Pass the border properties that you want to set. - * @param {string} Optional. If range is specified, it will set border for the specified range else it will use the selected range. - * @returns {void} - */ + * @param {any} Pass the border properties that you want to set. + * @param {string} Optional. If range is specified, it will set border for the specified range else it will use the selected range. + * @returns {void} + */ setBorder(property: any, range?: string): void; /** This method is used to set the height for the rows in the Spreadsheet. - * @param {Array|any} Pass the row index and height of the rows. - * @returns {void} - */ + * @param {Array|any} Pass the row index and height of the rows. + * @returns {void} + */ setHeightToRows(heightColl: any[]|any): void; /** This method is used to set the hyperlink in selected cells of the current sheet. - * @param {string|Array} If range is specified, it will set the hyperlink in range of the cells. - * @param {any} Pass cellAddress or webAddress - * @param {number} If we pass cellAddress then which sheet to be navigate in the applied link. - * @returns {void} - */ + * @param {string|Array} If range is specified, it will set the hyperlink in range of the cells. + * @param {any} Pass cellAddress or webAddress + * @param {number} If we pass cellAddress then which sheet to be navigate in the applied link. + * @returns {void} + */ setHyperlink(range: string|any[], link: any, sheetIdx: number): void; /** This method is used to set the readonly option for the specified range. - * @param {string|Array} Pass the range. - * @returns {void} - */ + * @param {string|Array} Pass the range. + * @returns {void} + */ setReadOnly(range?: string|any[]): void; /** This method is used to set the focus to the Spreadsheet. - * @returns {void} - */ + * @returns {void} + */ setSheetFocus(): void; /** This method is used to set the width for the columns in the Spreadsheet. - * @param {Array|any} Pass the column index and width of the columns. - * @returns {void} - */ + * @param {Array|any} Pass the column index and width of the columns. + * @returns {void} + */ setWidthToColumns(widthColl: any[]|any): void; /** This method is used to rename the active sheet. - * @param {string} Pass the sheet name that you want to change the current active sheet name. - * @returns {void} - */ + * @param {string} Pass the sheet name that you want to change the current active sheet name. + * @returns {void} + */ sheetRename(sheetName: string): void; /** This method is used to display the activationPanel for the specified range name. - * @param {string} Pass the range name that you want to display the activation panel. - * @returns {void} - */ + * @param {string} Pass the range name that you want to display the activation panel. + * @returns {void} + */ showActivationPanel(rangeName: string): void; /** This method is used to show the hidden columns within the specified range in the Spreadsheet. - * @param {number} Index of the start column. - * @param {number} Optional. Index of the end column. - * @returns {void} - */ + * @param {number} Index of the start column. + * @param {number} Optional. Index of the end column. + * @returns {void} + */ showColumn(startColIdx: number, endColIdx: number): void; /** This method is used to show the formula bar in Spreadsheet. - * @returns {void} - */ + * @returns {void} + */ showFormulaBar(): void; /** This method is used to show/hide gridlines in active sheet in the Spreadsheet. - * @param {boolean} Pass {{'`true`' | markdownify}} to show the gridlines - * @returns {void} - */ + * @param {boolean} Pass {{'`true`' | markdownify}} to show the gridlines + * @returns {void} + */ showGridlines(status: boolean): void; /** This method is used to show/hide the headers in active sheet in the Spreadsheet. - * @param {boolean} Pass {{'`true`' | markdownify}} to show the sheet headers. - * @returns {void} - */ + * @param {boolean} Pass {{'`true`' | markdownify}} to show the sheet headers. + * @returns {void} + */ showHeadings(startRow: boolean): void; /** This method is used to show/hide pager in the Spreadsheet. - * @param {boolean} Pass {{'`true`' | markdownify}} to show pager. - * @returns {void} - */ + * @param {boolean} Pass {{'`true`' | markdownify}} to show pager. + * @returns {void} + */ showPager(status: boolean): void; /** This method is used to show the hidden rows in the specified range in the Spreadsheet. - * @param {number} Index of the start row. - * @param {number} Optional. Index of the end row. - * @returns {void} - */ + * @param {number} Index of the start row. + * @param {number} Optional. Index of the end row. + * @returns {void} + */ showRow(startRow: number, endRow: number): void; /** This method is used to show waiting pop-up in Spreadsheet. - * @returns {void} - */ + * @returns {void} + */ showWaitingPopUp(): void; /** This method is used to unhide the sheet based on specified sheet name or sheet index. - * @param {string|number} Pass the sheet name or index that you want to unhide. - * @returns {void} - */ + * @param {string|number} Pass the sheet name or index that you want to unhide. + * @returns {void} + */ unhideSheet(sheetInfo: string|number): void; /** This method is used to unmerge the selected range of cells in the Spreadsheet. - * @param {string} Optional. If the range is specified, then it will un merge the specified range else it will use the current selected range. - * @returns {void} - */ + * @param {string} Optional. If the range is specified, then it will un merge the specified range else it will use the current selected range. + * @returns {void} + */ unmergeCells(range?: string): void; /** This method is used to unwrap the selected range of cells in the Spreadsheet. - * @param {Array|string} Optional. If the range is specified, then it will update unwrap in the specified range else it will use the current selected range. - * @returns {void} - */ + * @param {Array|string} Optional. If the range is specified, then it will update unwrap in the specified range else it will use the current selected range. + * @returns {void} + */ unWrapText(range?: any[]|string): void; /** This method is used to update the data for the specified range of cells in the Spreadsheet. - * @param {any} Pass the cells data that you want to update. - * @param {Array|string} Optional. If range is specified, it will update data for the specified range else it will use the current selected range. - * @returns {void} - */ + * @param {any} Pass the cells data that you want to update. + * @param {Array|string} Optional. If range is specified, it will update data for the specified range else it will use the current selected range. + * @returns {void} + */ updateData(data: any, range?: any[]|string): void; /** This method is used to update the formula bar in the Spreadsheet. - * @returns {void} - */ + * @returns {void} + */ updateFormulaBar(): void; /** This method is used to update the range of cells based on the specified settings which we want to update in the Spreadsheet. - * @param {number} Pass the sheet index that you want to update. - * @param {any} Pass the dataSource, startCell and showHeader values as settings. - * @returns {void} - */ + * @param {number} Pass the sheet index that you want to update. + * @param {any} Pass the dataSource, startCell and showHeader values as settings. + * @returns {void} + */ updateRange(sheetIdx: number, settings: any): void; /** This method is used to update the details for custom undo and redo operations. - * @param {any} Pass the details to update undo and redo collection - * @returns {void} - */ + * @param {any} Pass the details to update undo and redo collection + * @returns {void} + */ updateUndoRedoCollection(details: any): void; /** This method is used to update the unique data for the specified range of cells in Spreadsheet. - * @param {any} Pass the data that you want to update in the particular range - * @param {Array|string} Optional. If range is specified, it will update data for the specified range else it will use the current selected range. - * @param {any} Optional. It specifies whether to skip element processing or not. - * @returns {void} - */ + * @param {any} Pass the data that you want to update in the particular range + * @param {Array|string} Optional. If range is specified, it will update data for the specified range else it will use the current selected range. + * @param {any} Optional. It specifies whether to skip element processing or not. + * @returns {void} + */ updateUniqueData(data: any, range?: any[]|string, skipCell?: any): void; /** This method is used to wrap the selected range of cells in the Spreadsheet. - * @param {Array|string} Optional. If the range is specified, then it will update wrap in the specified range else it will use the current selected range. - * @returns {void} - */ + * @param {Array|string} Optional. If the range is specified, then it will update wrap in the specified range else it will use the current selected range. + * @returns {void} + */ wrapText(range?: any[]|string): void; XLCellType: Spreadsheet.XLCellType; @@ -38421,8 +38421,8 @@ class Spreadsheet extends ej.Widget { XLExport: Spreadsheet.XLExport; /** This method is used to get the export properties in the Spreadsheet. - * @returns {any} - */ + * @returns {any} + */ getExportProps(): any; XLFilter: Spreadsheet.XLFilter; @@ -38432,8 +38432,8 @@ class Spreadsheet extends ej.Widget { XLFreeze: Spreadsheet.XLFreeze; /** This method is used to unfreeze the frozen rows and columns in the Spreadsheet. - * @returns {void} - */ + * @returns {void} + */ unfreezePanes(): void; XLPivot: Spreadsheet.XLPivot; @@ -38459,1068 +38459,1068 @@ export namespace Spreadsheet { export interface XLCellType { /** This method is used to set a cell type from the specified range of cells in the spreadsheet. - * @param {string} Pass the range where you want apply cell type. - * @param {any} Pass type of cell type and its settings. - * @param {number} Optional. Pass sheet index. - * @returns {void} - */ + * @param {string} Pass the range where you want apply cell type. + * @param {any} Pass type of cell type and its settings. + * @param {number} Optional. Pass sheet index. + * @returns {void} + */ addCellTypes(range: string, settings: any, sheetIdx: number): void; /** This method is used to remove cell type from the specified range of cells in the Spreadsheet. - * @param {string|Array} Pass the range where you want remove cell type. - * @param {number} Optional. Pass sheet index. - * @returns {void} - */ + * @param {string|Array} Pass the range where you want remove cell type. + * @param {number} Optional. Pass sheet index. + * @returns {void} + */ removeCellTypes(range: string|any[], sheetIdx: number): void; } export interface XLCFormat { /** This method is used to clear the applied conditional formatting rules in the Spreadsheet. - * @param {Array|string} Optional. If range is specified, it will clear rules for the specified range else it will use the current selected range. - * @returns {void} - */ + * @param {Array|string} Optional. If range is specified, it will clear rules for the specified range else it will use the current selected range. + * @returns {void} + */ clearCF(range: any[] |string): void; /** This method is used to get the applied conditional formatting rules as array of objects based on the specified row Index and column Index in the Spreadsheet. - * @param {number} Pass the row index. - * @param {number} Pass the column index. - * @returns {Array} - */ + * @param {number} Pass the row index. + * @param {number} Pass the column index. + * @returns {Array} + */ getCFRule(rowIdx: number, colIdx: number): any[]; /** This method is used to set the conditional formatting rule in the Spreadsheet. - * @param {any} Pass the rule to set. - * @returns {void} - */ + * @param {any} Pass the rule to set. + * @returns {void} + */ setCFRule(rule: any): void; } export interface XLChart { /** This method is used to change the theme of the chart in the Spreadsheet. - * @param {string} Pass the chart id. - * @param {ej.datavisualization.Chart.Theme} Pass the chart theme which want to update. - * @returns {void} - */ + * @param {string} Pass the chart id. + * @param {ej.datavisualization.Chart.Theme} Pass the chart theme which want to update. + * @returns {void} + */ changeTheme(chartId: string, theme: ej.datavisualization.Chart.Theme): void; /** This method is used to change the type of the chart in the Spreadsheet. - * @param {string} Pass the chart id. - * @param {any} Pass the chart type. - * @returns {void} - */ + * @param {string} Pass the chart id. + * @param {any} Pass the chart type. + * @returns {void} + */ changeType(chartId: string, option: any): void; /** This method is used to change the data range of the chart in the Spreadsheet. - * @param {string} Pass the chart id. - * @param {string} X axis range of chart data. - * @param {string} Y axis range of chart data. - * @param {string} Legend range of chart data. - * @returns {void} - */ + * @param {string} Pass the chart id. + * @param {string} X axis range of chart data. + * @param {string} Y axis range of chart data. + * @param {string} Legend range of chart data. + * @returns {void} + */ changeDataRange(chartId: string, xRange: string, yRange: string, lRange: string): void; /** This method is used to create a chart for specified range in Spreadsheet. - * @param {string|Array} Optional. If range is specified, it will create chart for the specified range else it will use the current selected range. - * @param {any} Optional. To pass the type of chart and chart name. - * @returns {void} - */ + * @param {string|Array} Optional. If range is specified, it will create chart for the specified range else it will use the current selected range. + * @param {any} Optional. To pass the type of chart and chart name. + * @returns {void} + */ createChart(range: string|any[], options: any): void; /** This method is used to refresh the chart in the Spreadsheet. - * @param {string} To pass the chart Id. - * @param {any} To pass the type of chart and chart name. - * @returns {void} - */ + * @param {string} To pass the chart Id. + * @param {any} To pass the type of chart and chart name. + * @returns {void} + */ refreshChart(id: string, options: any): void; /** This method is used to resize the chart of specified id in the Spreadsheet. - * @param {string} To pass the chart id. - * @param {number} To pass height value. - * @param {number} To pass the width value. - * @returns {void} - */ + * @param {string} To pass the chart id. + * @param {number} To pass height value. + * @param {number} To pass the width value. + * @returns {void} + */ resizeChart(id: string, height: number, width: number): void; /** This method is used to update the chart element, such as axes, titles, data labels, grid lines and legends in the Spreadsheet. - * @param {string} Pass the chart id. - * @param {ej.Spreadsheet.ChartProperties} Pass chart element value which you want to update. - * @returns {void} - */ + * @param {string} Pass the chart id. + * @param {ej.Spreadsheet.ChartProperties} Pass chart element value which you want to update. + * @returns {void} + */ updateChartElement(chartId: string, value: ej.Spreadsheet.ChartProperties): void; /** This method is used switch row to columns and vice versa for chart in the Spreadsheet. So that the data is displayed in the chart the way you want. - * @param {string} Pass the chart id. - * @returns {void} - */ + * @param {string} Pass the chart id. + * @returns {void} + */ switchRowColumn(chartId: string): void; } export interface XLClipboard { /** This method is used to copy the selected cells in the Spreadsheet. - * @returns {void} - */ + * @returns {void} + */ copy(): void; /** This method is used to cut the selected cells in the Spreadsheet. - * @returns {void} - */ + * @returns {void} + */ cut(): void; /** This method is used to paste the cut or copied cells data in the Spreadsheet. - * @returns {void} - */ + * @returns {void} + */ paste(): void; } export interface XLComment { /** This method is used to delete the comment in the specified range in Spreadsheet. - * @param {Array|string} Optional. If range is specified, it will delete comments for the specified range else it will use the current selected range. - * @param {number} Optional. If sheetIdx is specified, it will delete comment in specified sheet else it will use active sheet. - * @param {boolean} Optional. Pass {{'`true`' | markdownify}}, if you want to skip the hidden rows data. - * @returns {void} - */ + * @param {Array|string} Optional. If range is specified, it will delete comments for the specified range else it will use the current selected range. + * @param {number} Optional. If sheetIdx is specified, it will delete comment in specified sheet else it will use active sheet. + * @param {boolean} Optional. Pass {{'`true`' | markdownify}}, if you want to skip the hidden rows data. + * @returns {void} + */ deleteComment(range: any[]|string, sheetIdx: number, skipHiddenRow: boolean): void; /** This method is used to edit the comment in the target Cell in Spreadsheet. - * @param {any} Optional. Pass the row index and column index of the cell which contains comment. - * @returns {void} - */ + * @param {any} Optional. Pass the row index and column index of the cell which contains comment. + * @returns {void} + */ editComment(targetCell: any): void; /** This method is used to find the next comment from the active cell in Spreadsheet. - * @returns {boolean} - */ + * @returns {boolean} + */ findNextComment(): boolean; /** This method is used to find the previous comment from the active cell in Spreadsheet. - * @returns {boolean} - */ + * @returns {boolean} + */ findPrevComment(): boolean; /** This method is used to get comment data for the specified cell. - * @param {HTMLElement} Pass the DOM element to get comment data as object. - * @returns {any} - */ + * @param {HTMLElement} Pass the DOM element to get comment data as object. + * @returns {any} + */ getComment(cell: HTMLElement): any; /** This method is used to set new comment in Spreadsheet. - * @param {string|Array} Optional. If we pass the range comment will set in the range otherwise it will set with selected cells. - * @param {string} Optional. Pass the comment data. - * @param {boolean} Optional. Pass {{'`true`' | markdownify}} to show comment in edit mode - * @param {boolean} Optional. Pass {{'`true`' | markdownify}} to show the user name - * @returns {void} - */ + * @param {string|Array} Optional. If we pass the range comment will set in the range otherwise it will set with selected cells. + * @param {string} Optional. Pass the comment data. + * @param {boolean} Optional. Pass {{'`true`' | markdownify}} to show comment in edit mode + * @param {boolean} Optional. Pass {{'`true`' | markdownify}} to show the user name + * @returns {void} + */ setComment(range: string|any[], data: string, showEditPanel: boolean, showUserName: boolean): void; /** This method is used to show all the comments in the Spreadsheet. - * @returns {void} - */ + * @returns {void} + */ showAllComments(): void; /** This method is used to show or hide the specific comment in the Spreadsheet. - * @param {HTMLElement} Optional. Pass the cell DOM element to show or hide its comment. If pass empty argument active cell will processed. - * @returns {void} - */ + * @param {HTMLElement} Optional. Pass the cell DOM element to show or hide its comment. If pass empty argument active cell will processed. + * @returns {void} + */ showHideComment(targetCell: HTMLElement): void; } export interface XLCMenu { /** This method is used to dynamically add items in the context menu. - * @param {string} Specifies the context menu type in which the item to be inserted. - * @param {Array} Pass the items to be inserted - * @param {string} Specifies the type of operation to be performed - * @returns {void} - */ + * @param {string} Specifies the context menu type in which the item to be inserted. + * @param {Array} Pass the items to be inserted + * @param {string} Specifies the type of operation to be performed + * @returns {void} + */ addItem(target: string, itemColl: any[], operation: string): void; /** This method is used to change data source in the context menu. - * @param {string} Specifies the context menu type to bind the data source. - * @param {Array} Pass the data source to be binded - * @returns {void} - */ + * @param {string} Specifies the context menu type to bind the data source. + * @param {Array} Pass the data source to be binded + * @returns {void} + */ changeDataSource(target: string, data: any[]): void; /** This method is used to disable the items in the context menu. - * @param {string} Specifies the context menu type in which the item to be disabled. - * @param {Array} Specifies the Menu Item id collection to be disabled - * @returns {void} - */ + * @param {string} Specifies the context menu type in which the item to be disabled. + * @param {Array} Specifies the Menu Item id collection to be disabled + * @returns {void} + */ disableItem(target: string, idxColl: any[]): void; /** This method is used to enable the items in the context menu. - * @param {string} Specifies the context menu type in which the item to be enabled. - * @param {Array} Specifies the Menu Item id collection to be enabled - * @returns {void} - */ + * @param {string} Specifies the context menu type in which the item to be enabled. + * @param {Array} Specifies the Menu Item id collection to be enabled + * @returns {void} + */ enableItem(target: string, idxColl: any[]): void; /** This method is used to remove the items in the context menu. - * @param {string} Specifies the context menu type in which the item to be removed. - * @param {Array} Specifies the Menu Item id collection to be removed - * @returns {void} - */ + * @param {string} Specifies the context menu type in which the item to be removed. + * @param {Array} Specifies the Menu Item id collection to be removed + * @returns {void} + */ removeItem(target: string, idxColl: any[]): void; } export interface XLDragDrop { /** This method is used to drag and drop the selected range of cells to destination range in the Spreadsheet. - * @param {any|Array} Pass the source range to perform drag and drop. - * @param {any|Array} Pass the destination range to drop the dragged cells. - * @returns {void} - */ + * @param {any|Array} Pass the source range to perform drag and drop. + * @param {any|Array} Pass the destination range to drop the dragged cells. + * @returns {void} + */ moveRangeTo(sourceRange: any|any[], destinationRange: any|any[]): void; } export interface XLDragFill { /** This method is used to perform auto fill in Spreadsheet. - * @param {any} Pass the options to perform auto fill in Spreadsheet. - * @returns {void} - */ + * @param {any} Pass the options to perform auto fill in Spreadsheet. + * @returns {void} + */ autoFill(options: any): void; /** This method is used to hide the auto fill element in the Spreadsheet. - * @returns {void} - */ + * @returns {void} + */ hideAutoFillElement(): void; /** This method is used to hide the auto fill options in the Spreadsheet. - * @returns {void} - */ + * @returns {void} + */ hideAutoFillOptions(): void; /** This method is used to set position of the auto fill element in the Spreadsheet. - * @param {boolean} Pass the isDragFill option as {{'`boolean`' | markdownify}} value to show auto fill options in Spreadsheet. - * @returns {void} - */ + * @param {boolean} Pass the isDragFill option as {{'`boolean`' | markdownify}} value to show auto fill options in Spreadsheet. + * @returns {void} + */ positionAutoFillElement(isDragFill: boolean): void; } export interface XLEdit { /** This method is used to calculate formulas in the specified sheet. - * @param {number} Optional. If sheet index is specified, then it will calculate formulas in the specified sheet only else it will calculate formulas in all sheets. - * @returns {void} - */ + * @param {number} Optional. If sheet index is specified, then it will calculate formulas in the specified sheet only else it will calculate formulas in all sheets. + * @returns {void} + */ calcNow(sheetIdx: number): void; /** This method is used to edit a particular cell based on the row index and column index in the Spreadsheet. - * @param {number} Pass the row index to edit particular cell. - * @param {number} Pass the column index to edit particular cell. - * @param {boolean} Pass {{'`true`' | markdownify}}, if you want to maintain previous cell value. - * @returns {void} - */ + * @param {number} Pass the row index to edit particular cell. + * @param {number} Pass the column index to edit particular cell. + * @param {boolean} Pass {{'`true`' | markdownify}}, if you want to maintain previous cell value. + * @returns {void} + */ editCell(rowIdx: number, colIdx: number, oldData: boolean): void; /** This method is used to get the property value of particular cell, based on the row and column index in the Spreadsheet. - * @param {number} Pass the row index to get the property value. - * @param {number} Pass the column index to get the property value. - * @param {string} Optional. Pass the property name that you want("value", "value2", "type", "cFormatRule", "range", "thousandSeparator", "rule", "format", "border", "picture", - * "chart", "calcValue", "align", "hyperlink", "formats", "borders", "tformats", "tborders", "isFilterHeader", "filterState", "tableName", "comment", "formatStr", - * "decimalPlaces", "cellType"). - * @param {number} Optional. Pass the index of the sheet. - * @returns {any|string|Array} - */ + * @param {number} Pass the row index to get the property value. + * @param {number} Pass the column index to get the property value. + * @param {string} Optional. Pass the property name that you want("value", "value2", "type", "cFormatRule", "range", "thousandSeparator", "rule", "format", "border", "picture", + * "chart", "calcValue", "align", "hyperlink", "formats", "borders", "tformats", "tborders", "isFilterHeader", "filterState", "tableName", "comment", "formatStr", + * "decimalPlaces", "cellType"). + * @param {number} Optional. Pass the index of the sheet. + * @returns {any|string|Array} + */ getPropertyValue(rowIdx: number, colIdx: number, prop: string, sheetIdx: number): any|string|any[]; /** This method is used to get the property value in specified cell in Spreadsheet. - * @param {HTMLElement} Pass the cell element to get property value. - * @param {string} Pass the property name that you want ("value", "value2", "type", "cFormatRule", "range", "thousandSeparator", "rule", "format", "border", - * "picture", "chart", "calcValue", "align", "hyperlink", "formats", "borders", "tformats", "tborders", "isFilterHeader", "filterState", "tableName", - * "comment", "formatStr", "decimalPlaces", "cellType"). - * @param {number} Pass the index of sheet. - * @returns {any|string|Array} - */ + * @param {HTMLElement} Pass the cell element to get property value. + * @param {string} Pass the property name that you want ("value", "value2", "type", "cFormatRule", "range", "thousandSeparator", "rule", "format", "border", + * "picture", "chart", "calcValue", "align", "hyperlink", "formats", "borders", "tformats", "tborders", "isFilterHeader", "filterState", "tableName", + * "comment", "formatStr", "decimalPlaces", "cellType"). + * @param {number} Pass the index of sheet. + * @returns {any|string|Array} + */ getPropertyValueByElem(elem: HTMLElement, property: string, sheetIdx: number): any|string|any[]; /** This method is used to save the edited cell value in the Spreadsheet. - * @returns {void} - */ + * @returns {void} + */ saveCell(): void; /** This method is used to update a particular cell value in the Spreadsheet. - * @param {any} Pass row index and column index of the cell. - * @param {string|number} Pass the cell value. - * @returns {void} - */ + * @param {any} Pass row index and column index of the cell. + * @param {string|number} Pass the cell value. + * @returns {void} + */ updateCell(cell: any, value: string|number): void; /** This method is used to update a particular cell value and its format in the Spreadsheet. - * @param {any} Pass row index and column index of the cell. - * @param {string|number} Pass the cell value. - * @param {string} Pass the class name to update format. - * @param {number} Pass sheet index. - * @returns {void} - */ + * @param {any} Pass row index and column index of the cell. + * @param {string|number} Pass the cell value. + * @param {string} Pass the class name to update format. + * @param {number} Pass sheet index. + * @returns {void} + */ updateCellValue(cellIdx: any, val: string|number, formatClass: string, sheetIdx: number): void; } export interface XLExport { /** This method is used to save the sheet data as Excel ,CSV or PDF document (.xls, .xlsx .csv, .pdf) in Spreadsheet. - * @param {string} Pass the export type that you want. - * @returns {void} - */ + * @param {string} Pass the export type that you want. + * @returns {void} + */ export(type: string): void; /** This method is used to get the export properties in the Spreadsheet. - * @returns {any} - */ + * @returns {any} + */ getExportProps(): any; } export interface XLFilter { /** This method is used to clear the filter in filtered columns in the Spreadsheet. - * @returns {void} - */ + * @returns {void} + */ clearFilter(): void; /** This method is used to apply filter for the selected range of cells in the Spreadsheet. - * @param {string|Array} Pass the range of the selected cells. - * @returns {void} - */ + * @param {string|Array} Pass the range of the selected cells. + * @returns {void} + */ filter(range: string|any[]): void; /** This method is used to apply filter for the column by active cell's value in the Spreadsheet. - * @returns {void} - */ + * @returns {void} + */ filterByActiveCell(): void; } export interface XLFormat { /** This method is used to convert table range to normal range. - * @param {any} Pass the sheet index and table id. - * @returns {void} - */ + * @param {any} Pass the sheet index and table id. + * @returns {void} + */ convertToRange(options: any): void; /** This method is used to create a table for the selected range of cells in the Spreadsheet. - * @param {any} Pass the table object. - * @param {string|Array} Optional. If the range is specified, then it will create table in the specified range else it will use the current selected range. - * @returns {string} - */ + * @param {any} Pass the table object. + * @param {string|Array} Optional. If the range is specified, then it will create table in the specified range else it will use the current selected range. + * @returns {string} + */ createTable(tableObject: any, range: string|any[]): string; /** This method is used to set format style and values in a cell or range of cells. - * @param {any} Pass the formatObject which contains style, type, format, groupSeparator and decimalPlaces. - * @param {string} Pass the range to format cells. - * @returns {void} - */ + * @param {any} Pass the formatObject which contains style, type, format, groupSeparator and decimalPlaces. + * @param {string} Pass the range to format cells. + * @returns {void} + */ format(formatObj: any, range: string): void; /** This method is used to remove the style in the specified range. - * @param {Array|string} Pass the cell range . - * @param {any} Optional. Pass the options for which the style gets removed. - * @returns {void} - */ + * @param {Array|string} Pass the cell range . + * @param {any} Optional. Pass the options for which the style gets removed. + * @returns {void} + */ removeStyle(range: any[]|string, options: any): void; /** This method is used to remove table with specified tableId in the Spreadsheet. - * @param {number} Pass the tableId that you want to remove. - * @returns {void} - */ + * @param {number} Pass the tableId that you want to remove. + * @returns {void} + */ removeTable(tableId: number): void; /** This method is used to update the decimal places for numeric value for the selected range of cells in the Spreadsheet. - * @param {string} Pass the decimal places type in increment/decrement. - * @param {string|Array} Pass the range. - * @returns {void} - */ + * @param {string} Pass the decimal places type in increment/decrement. + * @param {string|Array} Pass the range. + * @returns {void} + */ updateDecimalPlaces(type: string, range: string|any[]): void; /** This method is used to update the format for the selected range of cells in the Spreadsheet. - * @param {any} Pass the format object that you want to update. - * @param {Array} Optional. If the range is specified, then it will update format in the specified range else it will use the current selected range. - * @returns {void} - */ + * @param {any} Pass the format object that you want to update. + * @param {Array} Optional. If the range is specified, then it will update format in the specified range else it will use the current selected range. + * @returns {void} + */ updateFormat(formatObj: any, range: any[]): void; /** This method is used to update the unique format for selected range of cells in the Spreadsheet. - * @param {string} Pass the unique format class. - * @param {Array} Optional. If the range is specified, then it will update format in the specified range else it will use the current selected range. - * @returns {void} - */ + * @param {string} Pass the unique format class. + * @param {Array} Optional. If the range is specified, then it will update format in the specified range else it will use the current selected range. + * @returns {void} + */ updateUniqueFormat(formatClass: string, range: any[]): void; } export interface XLFreeze { /** This method is used to freeze columns upto the specified column index in the Spreadsheet. - * @param {number} Index of the column to be freeze. - * @returns {void} - */ + * @param {number} Index of the column to be freeze. + * @returns {void} + */ freezeColumns(colIdx: number): void; /** This method is used to freeze the first column in the Spreadsheet. - * @returns {void} - */ + * @returns {void} + */ freezeLeftColumn(): void; /** This method is used to freeze rows and columns before the specified cell in the Spreadsheet. - * @param {number} Index of the row to be freeze. - * @param {number} Index of the column to be freeze. - * @returns {void} - */ + * @param {number} Index of the row to be freeze. + * @param {number} Index of the column to be freeze. + * @returns {void} + */ freezePanes(rowIdx: number, colIdx: number): void; /** This method is used to freeze rows upto the specified row index in the Spreadsheet. - * @param {number} Index of the row to be freeze. - * @returns {void} - */ + * @param {number} Index of the row to be freeze. + * @returns {void} + */ freezeRows(rowIdx: number): void; /** This method is used to freeze the top row in the Spreadsheet. - * @returns {void} - */ + * @returns {void} + */ freezeTopRow(): void; /** This method is used to unfreeze the frozen rows and columns in the Spreadsheet. - * @returns {void} - */ + * @returns {void} + */ unfreezePanes(): void; } export interface XLPivot { /** This property is used to clear the pivot table list in Spreadsheet. - * @param {string} Pass the name of the pivot table. - * @returns {void} - */ + * @param {string} Pass the name of the pivot table. + * @returns {void} + */ clearPivotFieldList(pivotName: string): void; /** This method is used to create pivot table. - * @param {string} It specifies the range for which the pivot table is created. - * @param {string} It specifies the location in which the pivot table is created. - * @param {string} It specifies the name of the pivot table. - * @param {any} Pass the pivot table settings. - * @param {any} Pass the pivot range, sheet index, address and data source . - * @returns {string} - */ + * @param {string} It specifies the range for which the pivot table is created. + * @param {string} It specifies the location in which the pivot table is created. + * @param {string} It specifies the name of the pivot table. + * @param {any} Pass the pivot table settings. + * @param {any} Pass the pivot range, sheet index, address and data source . + * @returns {string} + */ createPivotTable(range: string, location: string, name: string, settings: any, pvt: any): string; /** This method is used to delete the pivot table which is selected. - * @param {string} Pass the name of the pivot table. - * @returns {void} - */ + * @param {string} Pass the name of the pivot table. + * @returns {void} + */ deletePivotTable(pivotName: string): void; /** This method is used to refresh data in pivot table. - * @param {string} Optional. Pass the name of the pivot table. - * @param {number} Optional. Pass the index of the sheet. - * @returns {void} - */ + * @param {string} Optional. Pass the name of the pivot table. + * @param {number} Optional. Pass the index of the sheet. + * @returns {void} + */ refreshDataSource(name: string, sheetIdx: number): void; } export interface XLPrint { /** This method is used to print the selected contents in the Spreadsheet. - * @returns {void} - */ + * @returns {void} + */ printSelection(): void; /** This method is used to print the entire contents in the active sheet. - * @returns {void} - */ + * @returns {void} + */ printSheet(): void; } export interface XLResize { /** This method is used to fit the height of rows in the Spreadsheet. - * @param {Array} Optional. Pass row index collection that you want to fit its height. - * @returns {void} - */ + * @param {Array} Optional. Pass row index collection that you want to fit its height. + * @returns {void} + */ fitHeight(rowIndexes: any[]): void; /** This method is used to fit the width of columns in the Spreadsheet. - * @param {Array} Optional. Pass column index collection that you want to fit its width. - * @returns {void} - */ + * @param {Array} Optional. Pass column index collection that you want to fit its width. + * @returns {void} + */ fitWidth(colIndexes: any[]): void; /** This method is used to get the column width of the specified column index in the Spreadsheet. - * @param {number} Pass the column index. - * @returns {number} - */ + * @param {number} Pass the column index. + * @returns {number} + */ getColWidth(colIdx: number): number; /** This method is used to get the row height of the specified row index in the Spreadsheet. - * @param {number} Pass the row index which you want to find its height. - * @returns {number} - */ + * @param {number} Pass the row index which you want to find its height. + * @returns {number} + */ getRowHeight(rowIdx: number): number; /** This method is used to set the column width of the specified column index in the Spreadsheet. - * @param {number} Pass the column index. - * @param {number} Pass the width value that you want to set. - * @returns {void} - */ + * @param {number} Pass the column index. + * @param {number} Pass the width value that you want to set. + * @returns {void} + */ setColWidth(colIdx: number, size: number): void; /** This method is used to set the row height of the specified row index in the Spreadsheet. - * @param {number} Pass the row index. - * @param {number} Pass the height value that you want to set. - * @returns {void} - */ + * @param {number} Pass the row index. + * @param {number} Pass the height value that you want to set. + * @returns {void} + */ setRowHeight(rowIdx: number, size: number): void; } export interface XLRibbon { /** This method is used to add a new item in the backstage. - * @param {any} Specifies the item to be added in the backstage. - * @param {number} pass the index of the item to be added in the backstage. - * @returns {void} - */ + * @param {any} Specifies the item to be added in the backstage. + * @param {number} pass the index of the item to be added in the backstage. + * @returns {void} + */ addBackStageItem(pageItem: any, index: number): void; /** This method is used to dynamically add the contextual tabs in the ribbon. - * @param {any} Specifies the contextual tab set object. - * @param {number} pass the index of the contextual tab. - * @returns {void} - */ + * @param {any} Specifies the contextual tab set object. + * @param {number} pass the index of the contextual tab. + * @returns {void} + */ addContextualTabs(contextualTabSet: any, index: number): void; /** This method is used to dynamically add the menu item in the file menu. - * @param {Array} Specifies the item to be added - * @param {number} pass the index of the menu item. - * @returns {void} - */ + * @param {Array} Specifies the item to be added + * @param {number} pass the index of the menu item. + * @returns {void} + */ addMenuItem(item: any[], index: number): void; /** This method is used to add a new name in the Spreadsheet name manager. - * @param {string} Pass the name that you want to define in name manager. - * @param {string} Pass the cell reference. - * @param {string} Optional. Pass comment, if you want. - * @param {number} Optional. Pass the sheet index. - * @returns {void} - */ + * @param {string} Pass the name that you want to define in name manager. + * @param {string} Pass the cell reference. + * @param {string} Optional. Pass comment, if you want. + * @param {number} Optional. Pass the sheet index. + * @returns {void} + */ addNamedRange(name: string, refersTo: string, comment: string, sheetIdx: number): void; /** This method is used to dynamically add the tab in the ribbon. - * @param {Array} Specifies the text to be displayed in the tab. - * @param {number} pass the groups to be displayed in the ribbon tab. - * @param {number} pass the index of the tab. - * @returns {void} - */ + * @param {Array} Specifies the text to be displayed in the tab. + * @param {number} pass the groups to be displayed in the ribbon tab. + * @param {number} pass the index of the tab. + * @returns {void} + */ addTab(tabText: any[], ribbonGroups: number, index: number): void; /** This method is used to dynamically add the tab group in the ribbon. - * @param {number} Specifies the ribbon tab index. - * @param {any} pass the groups to be displayed in the ribbon tab. - * @param {number} pass the index of the ribbon group. - * @returns {void} - */ + * @param {number} Specifies the ribbon tab index. + * @param {any} pass the groups to be displayed in the ribbon tab. + * @param {number} pass the index of the ribbon group. + * @returns {void} + */ addTabGroup(tabIndex: number, tabGroup: any, groupIndex: number): void; /** This method is used to insert the few type (SUM, MAX, MIN, AVG, COUNT) of formulas in the selected range of cells in the Spreadsheet. - * @param {string} To pass the type("SUM","MAX","MIN","AVG","COUNT"). - * @param {string|Array} If range is specified, it will apply auto sum for the specified range else it will use the current selected range. - * @returns {void} - */ + * @param {string} To pass the type("SUM","MAX","MIN","AVG","COUNT"). + * @param {string|Array} If range is specified, it will apply auto sum for the specified range else it will use the current selected range. + * @returns {void} + */ autoSum(type: string, range: string|any[]): void; /** This method is used to hide the file menu in the ribbon tab. - * @returns {void} - */ + * @returns {void} + */ hideMenu(): void; /** This method is used to remove the item from the backstage in the spreadsheet. - * @param {number} Specifies the index of the item to be removed from backstage. - * @returns {void} - */ + * @param {number} Specifies the index of the item to be removed from backstage. + * @returns {void} + */ removeBackStageItem(index: number): void; /** This method is used to remove the menu item form file menu in spreadsheet. - * @param {number} Specifies the index of the item to be removed from the file menu. - * @returns {void} - */ + * @param {number} Specifies the index of the item to be removed from the file menu. + * @returns {void} + */ removeMenuItem(index: number): void; /** This method is used to delete the defined name in the Spreadsheet name manager. - * @param {string} Pass the defined name that you want to remove from name manager. - * @returns {void} - */ + * @param {string} Pass the defined name that you want to remove from name manager. + * @returns {void} + */ removeNamedRange(name: string): void; /** This method is used to remove the tab form ribbon in the spreadsheet. - * @param {number} Specifies the index of the tab to be removed from the ribbon. - * @param {boolean} pass the boolean value to remove the tab from ribbon - * @returns {void} - */ + * @param {number} Specifies the index of the tab to be removed from the ribbon. + * @param {boolean} pass the boolean value to remove the tab from ribbon + * @returns {void} + */ removeTab(index: number, isRemoveMenu: boolean): void; /** This method is used to remove the tab group form ribbon in the spreadsheet. - * @param {number} Specifies the index of the tab group to be removed from the ribbon. - * @param {string} Specifies the text to be displayed in the tab group - * @returns {void} - */ + * @param {number} Specifies the index of the tab group to be removed from the ribbon. + * @param {string} Specifies the text to be displayed in the tab group + * @returns {void} + */ removeTabGroup(tabIndex: number, groupText: string): void; /** This method is used to show the file menu in the ribbon tab. - * @returns {void} - */ + * @returns {void} + */ showMenu(): void; /** This method is used to update the menu item in the file menu. - * @param {any} Specifies the menu item to be updated in the ribbon - * @param {number} pass the index of the item to be updated - * @returns {void} - */ + * @param {any} Specifies the menu item to be updated in the ribbon + * @param {number} pass the index of the item to be updated + * @returns {void} + */ updateMenuItem(item: any, index: number): void; /** This method is used to update the ribbon icons in the Spreadsheet. - * @returns {void} - */ + * @returns {void} + */ updateRibbonIcons(): void; } export interface XLSearch { /** This method is used to find and replace all data by workbook in the Spreadsheet. - * @param {string} Pass the search data. - * @param {string} Pass the replace data. - * @param {boolean} Pass {{'`true`' | markdownify}}, if you want to match with case-sensitive. - * @param {boolean} Pass {{'`true`' | markdownify}}, if you want to match with entire cell contents. - * @returns {void} - */ + * @param {string} Pass the search data. + * @param {string} Pass the replace data. + * @param {boolean} Pass {{'`true`' | markdownify}}, if you want to match with case-sensitive. + * @param {boolean} Pass {{'`true`' | markdownify}}, if you want to match with entire cell contents. + * @returns {void} + */ replaceAllByBook(findData: string, replaceData: string, isCSen: boolean, isEMatch: boolean): void; /** This method is used to find and replace all data by sheet in Spreadsheet. - * @param {string} Pass the search data. - * @param {string} Pass the replace data. - * @param {boolean} Pass {{'`true`' | markdownify}}, if you want to match with case-sensitive. - * @param {boolean} Pass {{'`true`' | markdownify}}, if you want to match with entire cell contents. - * @returns {void} - */ + * @param {string} Pass the search data. + * @param {string} Pass the replace data. + * @param {boolean} Pass {{'`true`' | markdownify}}, if you want to match with case-sensitive. + * @param {boolean} Pass {{'`true`' | markdownify}}, if you want to match with entire cell contents. + * @returns {void} + */ replaceAllBySheet(findData: string, replaceData: string, isCSen: boolean, isEMatch: boolean): void; } export interface XLSelection { /** This method is used to clear the selection of the active sheet in the Spreadsheet. - * @returns {void} - */ + * @returns {void} + */ clearAll(): void; /** This method is used to get the selected cells element based on specified sheet index in the Spreadsheet. - * @param {number} Pass the sheet index to get the cells element. - * @returns {HTMLElement} - */ + * @param {number} Pass the sheet index to get the cells element. + * @returns {HTMLElement} + */ getSelectedCells(sheetIdx: number): HTMLElement; /** This method is used to refresh the selection in the Spreadsheet. - * @param {Array|string} Optional. Pass range to refresh selection. - * @returns {void} - */ + * @param {Array|string} Optional. Pass range to refresh selection. + * @returns {void} + */ refreshSelection(range: any[]|string): void; /** This method is used to select a single column in the Spreadsheet. - * @param {number} Pass the column index value. - * @returns {void} - */ + * @param {number} Pass the column index value. + * @returns {void} + */ selectColumn(colIdx: number): void; /** This method is used to select entire columns in a specified range (start index and end index) in the Spreadsheet. - * @param {number} Pass the column start index. - * @param {number} Pass the column end index. - * @returns {void} - */ + * @param {number} Pass the column start index. + * @param {number} Pass the column end index. + * @returns {void} + */ selectColumns(startIdx: number, endIdx: number): void; /** This method is used to select the specified range of cells in the Spreadsheet. - * @param {string} Pass range which want to select. - * @returns {void} - */ + * @param {string} Pass range which want to select. + * @returns {void} + */ selectRange(range: string): void; /** This method is used to select a single row in the Spreadsheet. - * @param {number} Pass the row index value. - * @returns {void} - */ + * @param {number} Pass the row index value. + * @returns {void} + */ selectRow(rowIdx: number): void; /** This method is used to select entire rows in a specified range (start index and end index) in the Spreadsheet. - * @param {number} Pass the start row index. - * @param {number} Pass the end row index. - * @returns {void} - */ + * @param {number} Pass the start row index. + * @param {number} Pass the end row index. + * @returns {void} + */ selectRows(startIdx: number, endIdx: number): void; /** This method is used to select all cells in active sheet. - * @returns {void} - */ + * @returns {void} + */ selectSheet(): void; } export interface XLShape { /** This method is used to set a picture in the Spreadsheet. - * @param {string} Pass the range of the cell. - * @param {string} Pass the path of the specified image. - * @param {number} Optional. Pass the width of the image that you want to set. - * @param {number} Optional. Pass the height of the image that you want to set. - * @param {number} Optional. Pass the top of the image that you want to set. - * @param {number} Optional. Pass the left of the image that you want to set. - * @returns {string} - */ + * @param {string} Pass the range of the cell. + * @param {string} Pass the path of the specified image. + * @param {number} Optional. Pass the width of the image that you want to set. + * @param {number} Optional. Pass the height of the image that you want to set. + * @param {number} Optional. Pass the top of the image that you want to set. + * @param {number} Optional. Pass the left of the image that you want to set. + * @returns {string} + */ setPicture(range: string, url: string, width: number, height: number, top: number, left: number): string; } export interface XLSort { /** This method is used to sort a particular range of cells based on its cell or font color in the Spreadsheet. - * @param {string} Pass {{'`PutCellColor`' | markdownify}} to sort by cell color or {{'`PutFontColor`' | markdownify}} for sort by font color. - * @param {any} Pass the HEX color code to sort. - * @param {string} Pass the range - * @returns {void} - */ + * @param {string} Pass {{'`PutCellColor`' | markdownify}} to sort by cell color or {{'`PutFontColor`' | markdownify}} for sort by font color. + * @param {any} Pass the HEX color code to sort. + * @param {string} Pass the range + * @returns {void} + */ sortByColor(operation: string, color: any, range: string): void; /** This method is used to sort a particular range of cells based on its values in the Spreadsheet. - * @param {Array|string} Pass the range to sort. - * @param {string} Pass the column name. - * @param {any} Pass the direction to sort (ascending or descending). - * @returns {boolean} - */ + * @param {Array|string} Pass the range to sort. + * @param {string} Pass the column name. + * @param {any} Pass the direction to sort (ascending or descending). + * @returns {boolean} + */ sortByRange(range: any[]|string, columnName: string, direction: any): boolean; } export interface XLValidate { /** This method is used to apply data validation rules in a selected range of cells based on the defined condition in the Spreadsheet. - * @param {string|Array} If range is specified, it will apply rules for the specified range else it will use the current selected range. - * @param {Array} Pass the validation condition, value1 and value2. - * @param {string} Pass the data type. - * @param {boolean} Pass {{'`true`' | markdownify}} if you ignore blank values. - * @param {boolean} Pass {{'`true`' | markdownify}} if you want to show an error alert. - * @returns {void} - */ + * @param {string|Array} If range is specified, it will apply rules for the specified range else it will use the current selected range. + * @param {Array} Pass the validation condition, value1 and value2. + * @param {string} Pass the data type. + * @param {boolean} Pass {{'`true`' | markdownify}} if you ignore blank values. + * @param {boolean} Pass {{'`true`' | markdownify}} if you want to show an error alert. + * @returns {void} + */ applyDVRules(range: string|any[], values: any[], type: string, required: boolean, showErrorAlert: boolean): void; /** This method is used to clear the applied validation rules in a specified range of cells in the Spreadsheet. - * @param {string|Array} Optional. If range is specified, it will clear rules for the specified range else it will use the current selected range. - * @returns {void} - */ + * @param {string|Array} Optional. If range is specified, it will clear rules for the specified range else it will use the current selected range. + * @returns {void} + */ clearDV(range: string|any[]): void; /** This method is used to highlight invalid data in a specified range of cells in the Spreadsheet. - * @param {string|Array} Optional. If range is specified, it will clear rules for the specified range else it will use the current selected range. - * @returns {void} - */ + * @param {string|Array} Optional. If range is specified, it will clear rules for the specified range else it will use the current selected range. + * @returns {void} + */ highlightInvalidData(range: string|any[]): void; } export interface Model { /** Gets or sets an active sheet index in the Spreadsheet. By defining this value, you can specify which sheet should be active in workbook. - * @Default {1} - */ + * @Default {1} + */ activeSheetIndex?: number; /** Gets or sets a value that indicates whether to enable or disable auto rendering of cell type in the Spreadsheet. - * @Default {false} - */ + * @Default {false} + */ allowAutoCellType?: boolean; /** Gets or sets a value that indicates whether to enable or disable auto fill feature in the Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ allowAutoFill?: boolean; /** Gets or sets a value that indicates whether to enable or disable auto sum feature in the Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ allowAutoSum?: boolean; /** Gets or sets a value that indicates whether to enable or disable cell format feature in the Spreadsheet. By enabling this, you can customize styles and number formats. - * @Default {true} - */ + * @Default {true} + */ allowCellFormatting?: boolean; /** Gets or sets a value that indicates whether to enable or disable cell type feature in the Spreadsheet. - * @Default {false} - */ + * @Default {false} + */ allowCellType?: boolean; /** Gets or sets a value that indicates whether to enable or disable chart feature in the Spreadsheet. By enabling this feature, you can create and customize charts in Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ allowCharts?: boolean; /** Gets or sets a value that indicates whether to enable or disable clear feature in the Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ allowClear?: boolean; /** Gets or sets a value that indicates whether to enable or disable clipboard feature in the Spreadsheet. By enabling this feature, you can perform cut/copy and paste operations in Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ allowClipboard?: boolean; /** Gets or sets a value that indicates whether to enable or disable comment feature in the Spreadsheet. By enabling this, you can add/delete/modify comments in Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ allowComments?: boolean; /** Gets or sets a value that indicates whether to enable or disable Conditional Format feature in the Spreadsheet. By enabling this, you can apply formatting to the selected range - * of cells based on the provided conditions (Greater than, Less than, Equal, Between, Contains, etc.). - * @Default {true} - */ + * of cells based on the provided conditions (Greater than, Less than, Equal, Between, Contains, etc.). + * @Default {true} + */ allowConditionalFormats?: boolean; /** Gets or sets a value that indicates whether to enable or disable data validation feature in the Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ allowDataValidation?: boolean; /** Gets or sets a value that indicates whether to enable or disable the delete action in the Spreadsheet. By enabling this feature, you can delete existing rows, columns, cells and sheet. - * @Default {true} - */ + * @Default {true} + */ allowDelete?: boolean; /** Gets or sets a value that indicates whether to enable or disable drag and drop feature in the Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ allowDragAndDrop?: boolean; /** Gets or sets a value that indicates whether to enable or disable the edit action in the Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ allowEditing?: boolean; /** Gets or sets a value that indicates whether to enable or disable filtering feature in the Spreadsheet. Filtering can be used to limit the data displayed using required criteria. - * @Default {true} - */ + * @Default {true} + */ allowFiltering?: boolean; /** Gets or sets a value that indicates whether to enable or disable table feature in the Spreadsheet. By enabling this, you can render table in selected range. - * @Default {true} - */ + * @Default {true} + */ allowFormatAsTable?: boolean; /** Get or sets a value that indicates whether to enable or disable format painter feature in the Spreadsheet. By enabling this feature, you can copy - * the format from the selected range and apply it to another range. - * @Default {true} - */ + * the format from the selected range and apply it to another range. + * @Default {true} + */ allowFormatPainter?: boolean; /** Gets or sets a value that indicates whether to enable or disable formula bar in the Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ allowFormulaBar?: boolean; /** Gets or sets a value that indicates whether to enable or disable freeze pane support in Spreadsheet. After enabling this feature, - * you can use freeze top row, freeze first column and freeze panes options. - * @Default {false} - */ + * you can use freeze top row, freeze first column and freeze panes options. + * @Default {false} + */ allowFreezing?: boolean; /** Gets or sets a value that indicates whether to enable or disable hyperlink feature in the Spreadsheet. By enabling this feature, you can add hyperlink which is used to - * easily navigate to the cell reference from one sheet to another or a web page. - * @Default {true} - */ + * easily navigate to the cell reference from one sheet to another or a web page. + * @Default {true} + */ allowHyperlink?: boolean; /** Gets or sets a value that indicates whether to enable or disable import feature in the Spreadsheet. By enabling this feature, you can open existing Spreadsheet documents. - * @Default {true} - */ + * @Default {true} + */ allowImport?: boolean; /** Gets or sets a value that indicates whether to enable or disable the insert action in the Spreadsheet. By enabling this feature, you can insert new rows, columns, cells and sheet. - * @Default {true} - */ + * @Default {true} + */ allowInsert?: boolean; /** Gets or sets a value that indicates whether to enable or disable keyboard navigation feature in the Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ allowKeyboardNavigation?: boolean; /** Gets or sets a value that indicates whether to enable or disable lock cell feature in the Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ allowLockCell?: boolean; /** Gets or sets a value that indicates whether to enable or disable merge feature in the Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ allowMerging?: boolean; /** Gets or sets a value that indicates whether to enable or disable overflow feature in the Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ allowOverflow?: boolean; /** Gets or sets a value that indicates whether to enable or disable resizing feature in the Spreadsheet. By enabling this feature, you can change the column width and - * row height by dragging its header boundaries. - * @Default {true} - */ + * row height by dragging its header boundaries. + * @Default {true} + */ allowResizing?: boolean; /** Gets or sets a value that indicates whether to enable or disable find and replace feature in the Spreadsheet. By enabling this, you can easily find and replace - * a specific value in the sheet or workbook. By using goto behavior, you can select and highlight all cells that contains specific data or data types. - * @Default {true} - */ + * a specific value in the sheet or workbook. By using goto behavior, you can select and highlight all cells that contains specific data or data types. + * @Default {true} + */ allowSearching?: boolean; /** Gets or sets a value that indicates whether to enable or disable selection in the Spreadsheet. By enabling this feature, selected items will be highlighted. - * @Default {true} - */ + * @Default {true} + */ allowSelection?: boolean; /** Gets or sets a value that indicates whether to enable the sorting feature in the Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ allowSorting?: boolean; /** Gets or sets a value that indicates whether to enable or disable undo and redo feature in the Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ allowUndoRedo?: boolean; /** Gets or sets a value that indicates whether to enable or disable wrap text feature in the Spreadsheet. By enabling this, cell content can wrap to the next line, - * if the cell content exceeds the boundary of the cell. - * @Default {true} - */ + * if the cell content exceeds the boundary of the cell. + * @Default {true} + */ allowWrap?: boolean; /** Gets or sets a value that indicates to define the width of the activation panel in Spreadsheet. - * @Default {300} - */ + * @Default {300} + */ apWidth?: number; /** Gets or sets an object that indicates to customize the auto fill behavior in the Spreadsheet. - */ + */ autoFillSettings?: AutoFillSettings; /** Gets or sets an object that indicates to customize the chart behavior in the Spreadsheet. - */ + */ chartSettings?: ChartSettings; /** Gets or sets a value that defines the number of columns displayed in the sheet. - * @Default {21} - */ + * @Default {21} + */ columnCount?: number; /** Gets or sets a value that indicates to define the common width for each column in the Spreadsheet. - * @Default {64} - */ + * @Default {64} + */ columnWidth?: number; /** Gets or sets a value to add root CSS class for customizing Spreadsheet skins. - */ + */ cssClass?: string; /** Gets or sets a value that indicates custom formulas in Spreadsheet. - * @Default {[]} - */ + * @Default {[]} + */ customFormulas?: any[]; /** Gets or sets a value that indicates whether to enable or disable context menu in the Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ enableContextMenu?: boolean; /** Gets or sets a value that indicates whether to enable or disable pivot table in the Spreadsheet. - * @Default {false} - */ + * @Default {false} + */ enablePivotTable?: boolean; /** Gets or sets a value that indicates whether to enable or disable touch support in the Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ enableTouch?: boolean; /** Gets or sets an object that indicates to customize the exporting behavior in Spreadsheet. - */ + */ exportSettings?: ExportSettings; /** Gets or sets an object that indicates to customize the format behavior in the Spreadsheet. - */ + */ formatSettings?: FormatSettings; /** Gets or sets an object that indicates to customize the import behavior in the Spreadsheet. - */ + */ importSettings?: ImportSettings; /** Gets or sets a value that indicates whether to enable or disable readonly support in the Spreadsheet. - * @Default {false} - */ + * @Default {false} + */ isReadOnly?: boolean; /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data (i.e.) - * in a language and culture specific to a particular country or region. - * @Default {en-US} - */ + * in a language and culture specific to a particular country or region. + * @Default {en-US} + */ locale?: string; /** Gets or sets an object that indicates to customize the picture behavior in the Spreadsheet. - */ + */ pictureSettings?: PictureSettings; /** Gets or sets an object that indicates to customize the print option in Spreadsheet. - */ + */ printSettings?: PrintSettings; /** Gets or sets an object that indicates to customize the ribbon settings in Spreadsheet. - */ + */ ribbonSettings?: RibbonSettings; /** Gets or sets a value that indicates whether to define the number of rows to be displayed in the sheet. - * @Default {20} - */ + * @Default {20} + */ rowCount?: number; /** Gets or sets a value that indicates to define the common height for each row in the sheet. - * @Default {20} - */ + * @Default {20} + */ rowHeight?: number; /** Gets or sets an object that indicates to customize the scroll options in the Spreadsheet. - */ + */ scrollSettings?: ScrollSettings; /** Gets or sets an object that indicates to customize the selection options in the Spreadsheet. - */ + */ selectionSettings?: SelectionSettings; /** Gets or sets a value that indicates to define the number of sheets to be created at the initial load. - * @Default {1} - */ + * @Default {1} + */ sheetCount?: number; /** Gets or sets an object that indicates to customize the sheet behavior in Spreadsheet. - */ + */ sheets?: Sheet[]; /** Gets or sets a value that indicates whether to show or hide pager in the Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ showPager?: boolean; /** Gets or sets a value that indicates whether to show or hide ribbon in the Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ showRibbon?: boolean; /** This is used to set the number of undo-redo steps in the Spreadsheet. - * @Default {20} - */ + * @Default {20} + */ undoRedoStep?: number; /** Define the username for the Spreadsheet which is displayed in comment. - * @Default {User Name} - */ + * @Default {User Name} + */ userName?: string; /** Triggered for every action before its starts. */ @@ -39641,1649 +39641,1649 @@ export interface Model { export interface ActionBeginEventArgs { /** Returns the applied style format object. - */ + */ afterFormat?: any; /** Returns the applied style format object. - */ + */ beforeFormat?: any; /** Returns the sheet index. - */ + */ sheetIdx?: number; /** Returns the cell range. - */ + */ range?: any[]; /** Returns the action format. - */ + */ reqType?: string; /** Returns goto index while paging. - */ + */ gotoIdx?: number; /** Returns boolean value. If create new sheet it returns true. - */ + */ newSheet?: boolean; /** Return column name while sorting. - */ + */ columnName?: string; /** Returns selected columns while sorting or filtering begins. - */ + */ colSelected?: number; /** Returns sort direction while sort action begins. - */ + */ sortDirection?: string; } export interface ActionCompleteEventArgs { /** Returns Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the applied cell format object. - */ + */ selectedCell?: any[]|any; /** Returns the sheet index. - */ + */ sheetIdx?: number; /** Returns the request type. - */ + */ reqType?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the name of the event. - */ + */ type?: string; } export interface AutoFillBeginEventArgs { /** Returns auto fill begin cell range. - */ + */ dataRange?: any[]; /** Returns which direction drag the auto fill. - */ + */ direction?: string; /** Returns fill cells range. - */ + */ fillRange?: any[]; /** Returns the auto fill type. - */ + */ fillType?: string; /** Returns the sheet index. - */ + */ sheetIdx?: number; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the name of the event. - */ + */ type?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface AutoFillCompleteEventArgs { /** Returns auto fill begin cell range. - */ + */ dataRange?: any[]; /** Returns which direction to drag the auto fill. - */ + */ direction?: string; /** Returns fill cells range. - */ + */ fillRange?: any[]; /** Returns the auto fill type. - */ + */ fillType?: string; /** Returns the sheet index. - */ + */ sheetIdx?: number; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the name of the event. - */ + */ type?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface BeforeBatchSaveEventArgs { /** Returns the sheet index. - */ + */ sheetIdx?: number; /** Returns the query, primary key,batch changes for the data Source. - */ + */ dataSetting?: any; /** Returns the changed record object. - */ + */ batchChanges?: any; } export interface BeforeCellFormatEventArgs { /** Returns the sheet index. - */ + */ sheetIdx?: number; /** Returns the applied style format object. - */ + */ format?: any; /** Returns the selected cells. - */ + */ cells?: any[]|any; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the name of the event. - */ + */ type?: string; } export interface BeforeCellSelectEventArgs { /** Returns the previous cell range. - */ + */ prevRange?: any[]; /** Returns the current cell range. - */ + */ currRange?: any[]; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the name of the event. - */ + */ type?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface BeforeDropEventArgs { /** Returns the sheet index. - */ + */ sheetIdx?: number; /** Returns the current cell row and column index. - */ + */ currentCell?: any; /** Returns the drag cells range object. - */ + */ dragAndDropRange?: any; /** Returns the cell Overwriting alert option value. - */ + */ preventAlert?: boolean; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the target item. - */ + */ target?: HTMLElement; /** Returns the name of the event. - */ + */ type?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface BeforeEditCommentEventArgs { /** Returns the sheet index. - */ + */ sheetIdx?: number; /** Returns the comment cell index. - */ + */ cellIndex?: any; /** Returns the disable option value. - */ + */ disable?: boolean; /** Returns the Spreadsheet model. - */ + */ model?: any; /** Returns the value of the comment - */ + */ value?: string; /** Returns the name of the event. - */ + */ type?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface BeforeOpenEventArgs { /** Returns the target element. - */ + */ target?: HTMLElement; /** Returns the name of the event. - */ + */ type?: string; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface BeforePanelOpenEventArgs { /** Returns the sheet index. - */ + */ sheetIdx?: number; /** Returns the activation panel element. - */ + */ activationPanel?: any; /** Returns the range option value. - */ + */ range?: any; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the name of the event. - */ + */ type?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface CellClickEventArgs { /** Returns the click cell element. - */ + */ cell?: HTMLElement; /** Returns the column index of clicked cell. - */ + */ columnIndex?: number; /** Returns the row index of clicked cell. - */ + */ rowIndex?: number; /** Returns the column name of clicked cell. - */ + */ columnName?: string; /** Returns the column information. - */ + */ columnObject?: any; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the name of the event. - */ + */ type?: string; /** Returns the target element. - */ + */ target?: HTMLElement; /** Returns the value of the cell. - */ + */ value?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface CellEditEventArgs { /** Returns the click cell element. - */ + */ cell?: HTMLElement; /** Returns the columnName of clicked cell. - */ + */ columnName?: string; /** Returns the column field information. - */ + */ columnObject?: any; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the name of the event. - */ + */ type?: string; /** Returns the target element. - */ + */ target?: HTMLElement; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface CellFormattingEventArgs { /** Returns the sheet index - */ + */ SheetIdx?: number; /** Returns the applied style format object - */ + */ Format?: any; /** Returns the cell index. - */ + */ Cell?: number; /** Returns the name of the CSS theme. - */ + */ cssClass?: string; /** Returns the name of the event. - */ + */ type?: string; /** Returns the target element. - */ + */ target?: HTMLElement; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; } export interface CellHoverEventArgs { /** Returns the target element. - */ + */ target?: HTMLElement; /** Returns the name of the event. - */ + */ type?: string; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface CellSaveEventArgs { /** Returns the save cell element. - */ + */ cell?: HTMLElement; /** Returns the columnName of clicked cell. - */ + */ columnName?: string; /** Returns the column field information. - */ + */ columnObject?: any; /** Returns the index of the row. - */ + */ rowIndex?: number; /** Returns the index of the column. - */ + */ colIndex?: number; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the cell previous value. - */ + */ pValue?: string; /** Returns the name of the event. - */ + */ type?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the target element. - */ + */ target?: HTMLElement; /** Returns the cell value. - */ + */ value?: string; } export interface CellSelectedEventArgs { /** Returns the active sheet index. - */ + */ sheetIdx?: number; /** Returns the selected range. - */ + */ selectedRange?: any[]; /** Returns the target element. - */ + */ target?: HTMLElement; /** Returns Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the name of the event. - */ + */ type?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface ContextMenuClickEventArgs { /** Returns target element Id. - */ + */ Id?: string; /** Returns the target element. - */ + */ element?: HTMLElement; /** Returns event information. - */ + */ event?: any; /** Returns target element and event information. - */ + */ events?: any; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns target element parent Id. - */ + */ parentId?: string; /** Returns target element parent text. - */ + */ parentText?: string; /** Returns target element text. - */ + */ text?: string; /** Returns the name of the event. - */ + */ type?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface DragEventArgs { /** Returns the sheet index. - */ + */ sheetIdx?: number; /** Returns the current cell row and column index. - */ + */ currentCell?: any; /** Returns the drag cells range object. - */ + */ dragAndDropRange?: any; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the target item. - */ + */ target?: HTMLElement; /** Returns the name of the event. - */ + */ type?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface DragShapeEventArgs { /** Returns the Spreadsheet model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the target element. - */ + */ target?: HTMLElement; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface DragStartEventArgs { /** Returns the sheet index. - */ + */ sheetIdx?: number; /** Returns the current cell row and column index. - */ + */ currentCell?: any; /** Returns the drag cells range object. - */ + */ dragAndDropRange?: any; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the target item. - */ + */ target?: HTMLElement; /** Returns the name of the event. - */ + */ type?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface DropEventArgs { /** Returns the sheet index. - */ + */ sheetIdx?: number; /** Returns the current cell row and column index. - */ + */ currentCell?: any; /** Returns the drag cells range object. - */ + */ dragAndDropRange?: any; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the target item. - */ + */ target?: HTMLElement; /** Returns the name of the event. - */ + */ type?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface EditRangeBeginEventArgs { /** Returns the sheet index. - */ + */ sheetIdx?: number; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the range option value. - */ + */ range?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface EditRangeCompleteEventArgs { /** Returns the sheet index. - */ + */ sheetIdx?: number; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the range option value. - */ + */ range?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface KeyDownEventArgs { /** Returns the sheet index. - */ + */ sheetIndex?: number; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the boolean value. - */ + */ isCommentEdit?: boolean; /** Returns the boolean value. - */ + */ isEdit?: boolean; /** Returns the boolean value. - */ + */ isSheetRename?: boolean; /** Returns the target element. - */ + */ target?: HTMLElement; /** Returns the name of the event. - */ + */ type?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface KeyUpEventArgs { /** Returns the sheet index. - */ + */ sheetIndex?: number; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the boolean value. - */ + */ isCommentEdit?: boolean; /** Returns the boolean value. - */ + */ isEdit?: boolean; /** Returns the boolean value. - */ + */ isSheetRename?: boolean; /** Returns the target element. - */ + */ target?: HTMLElement; /** Returns the name of the event. - */ + */ type?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface LoadEventArgs { /** Returns the name of the event. - */ + */ type?: string; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the active sheet index. - */ + */ sheetIndex?: number; } export interface LoadCompleteEventArgs { /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the name of the event. - */ + */ type?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface MenuClickEventArgs { /** Returns menu click element. - */ + */ element?: HTMLElement; /** Returns the event information. - */ + */ event?: any; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns target element parent Id. - */ + */ parentId?: string; /** Returns target element parent text. - */ + */ parentText?: string; /** Returns target element text. - */ + */ text?: string; /** Returns the name of the event. - */ + */ type?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface OnImportEventArgs { /** Returns the name of the event. - */ + */ type?: string; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the imported data. - */ + */ importData?: any; } export interface OpenFailureEventArgs { /** Returns the failure type. - */ + */ failureType?: string; /** Returns the status index. - */ + */ status?: number; /** Returns the status in text. - */ + */ statusText?: string; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the name of the event. - */ + */ type?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface PagerClickEventArgs { /** Returns the active sheet index. - */ + */ activeSheet?: number; /** Returns the new sheet index. - */ + */ gotoSheet?: number; /** Returns whether new sheet icon is clicked. - */ + */ newSheet?: boolean; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the name of the event. - */ + */ type?: string; /** Returns the target element. - */ + */ target?: HTMLElement; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface ResizeStartEventArgs { /** Returns the column index which column you start to resize. - */ + */ colIndex?: number; /** Returns the row index which row you start to resize. - */ + */ rowIndex?: number; /** Returns the Spreadsheet model. - */ + */ model?: any; /** Returns type of the request. - */ + */ reqType?: string; /** Returns the name of the event. - */ + */ type?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface ResizeEndEventArgs { /** Returns the column index which you resized. - */ + */ colIndex?: number; /** Returns old width of the column or shape. - */ + */ oldWidth?: number; /** Returns new width of the column or shape. - */ + */ newWidth?: number; /** Returns the row index which you resized. - */ + */ rowIndex?: number; /** Returns old height of the row or shape. - */ + */ oldHeight?: number; /** Returns new height of the row or shape. - */ + */ newHeight?: number; /** Returns the Spreadsheet model. - */ + */ model?: any; /** Returns type of the request. - */ + */ reqType?: string; /** Returns the name of the event. - */ + */ type?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface RibbonClickEventArgs { /** Returns element Id. - */ + */ Id?: string; /** Returns target information. - */ + */ prop?: any; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns status. - */ + */ status?: boolean; /** Returns isChecked in boolean. - */ + */ isChecked?: boolean; /** Returns the name of the event. - */ + */ type?: string; /** Returns the target element. - */ + */ target?: HTMLElement; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface SeriesRenderingEventArgs { /** Returns chart data and chart information. - */ + */ data?: any; /** Returns the chart model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the name of the event. - */ + */ type?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface TabClickEventArgs { /** Returns the active tab index. - */ + */ activeIndex?: number; /** Returns active tab header element. - */ + */ activeHeader?: any; /** Returns previous active tab header element. - */ + */ prevActiveHeader?: any; /** Returns previous active tab index. - */ + */ prevActiveIndex?: number; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the name of the event. - */ + */ type?: string; /** Returns the target element. - */ + */ target?: HTMLElement; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface TabSelectEventArgs { /** Returns the active tab index. - */ + */ activeIndex?: number; /** Returns active tab header element. - */ + */ activeHeader?: any; /** Returns previous active tab header element. - */ + */ prevActiveHeader?: any; /** Returns previous active tab index. - */ + */ prevActiveIndex?: number; /** Returns the Spreadsheet model. - */ + */ model?: ej.Spreadsheet.Model; /** Returns the name of the event. - */ + */ type?: string; /** Returns the target element. - */ + */ target?: HTMLElement; /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface AutoFillSettings { /** This property is used to set fillType unit in Spreadsheet. It has five types which are CopyCells, FillSeries, FillFormattingOnly, FillWithoutFormatting and FlashFill. - * @Default {ej.Spreadsheet.AutoFillOptions.FillSeries} - */ + * @Default {ej.Spreadsheet.AutoFillOptions.FillSeries} + */ fillType?: ej.Spreadsheet.AutoFillOptions|string; /** Gets or sets a value that indicates to enable or disable auto fill options in the Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ showFillOptions?: boolean; } export interface ChartSettings { /** Gets or sets a value that defines the chart height in Spreadsheet. - * @Default {220} - */ + * @Default {220} + */ height?: number; /** Gets or sets a value that defines the chart width in the Spreadsheet. - * @Default {440} - */ + * @Default {440} + */ width?: number; } export interface ExportSettings { /** Gets or sets a value that indicates whether to enable or disable save feature in Spreadsheet. By enabling this feature, you can save existing Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ allowExporting?: boolean; /** Gets or sets a value that indicates to define csvUrl for export to CSV format. - * @Default {null} - */ + * @Default {null} + */ csvUrl?: string; /** Gets or sets a value that indicates to define excelUrl for export to excel format. - * @Default {null} - */ + * @Default {null} + */ excelUrl?: string; /** Gets or sets a value that indicates to define password while export to excel format. - * @Default {null} - */ + * @Default {null} + */ password?: string; /** Gets or sets a value that indicates to define pdfUrl for export to PDF format. - * @Default {null} - */ + * @Default {null} + */ pdfUrl?: string; } export interface FormatSettings { /** Gets or sets a value that indicates whether to enable or disable cell border feature in the Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ allowCellBorder?: boolean; /** Gets or sets a value that indicates whether to enable or disable decimal places in the Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ allowDecimalPlaces?: boolean; /** Gets or sets a value that indicates whether to enable or disable font family feature in Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ allowFontFamily?: boolean; } export interface ImportSettings { /** Sets import mapper to perform import feature in Spreadsheet. - */ + */ importMapper?: string; /** Gets or sets a value that indicates whether to enable or disable import while initial loading. - * @Default {false} - */ + * @Default {false} + */ importOnLoad?: boolean; /** Sets import URL to access the online files in the Spreadsheet. - */ + */ importUrl?: string; /** Gets or sets a value that indicates to define password while importing in the Spreadsheet. - */ + */ password?: string; } export interface PictureSettings { /** Gets or sets a value that indicates whether to enable or disable picture feature in Spreadsheet. By enabling this, you can add pictures in Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ allowPictures?: boolean; /** Gets or sets a value that indicates to define height to picture in the Spreadsheet. - * @Default {220} - */ + * @Default {220} + */ height?: number; /** Gets or sets a value that indicates to define width to picture in the Spreadsheet. - * @Default {440} - */ + * @Default {440} + */ width?: number; } export interface PrintSettings { /** Gets or sets a value that indicates whether to enable or disable page setup support for printing in Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ allowPageSetup?: boolean; /** Gets or sets a value that indicates whether to enable or disable page size support for printing in Spreadsheet. - * @Default {false} - */ + * @Default {false} + */ allowPageSize?: boolean; /** Gets or sets a value that indicates whether to enable or disable print feature in the Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ allowPrinting?: boolean; } export interface RibbonSettingsApplicationTabMenuSettings { /** Gets or sets a value that indicates whether to enable or disable isAppend property in ribbon settings. - * @Default {false} - */ + * @Default {false} + */ isAppend?: boolean; /** Specifies the data source to append in application tab. - * @Default {[]} - */ + * @Default {[]} + */ dataSource?: any[]; } export interface RibbonSettingsApplicationTab { /** Gets or sets a value that indicates to set application tab type in Spreadsheet. It has two types, Menu and Backstage. - * @Default {ej.Ribbon.ApplicationTabType.Backstage} - */ + * @Default {ej.Ribbon.ApplicationTabType.Backstage} + */ type?: ej.Ribbon.ApplicationTabType|string; /** Gets or sets an object that indicates menu settings for application tab in Spreadsheet. - */ + */ menuSettings?: RibbonSettingsApplicationTabMenuSettings; } export interface RibbonSettings { /** Gets or sets an object that indicates application tab settings in Spreadsheet. - */ + */ applicationTab?: RibbonSettingsApplicationTab; } export interface ScrollSettings { /** Gets or sets a value that indicates whether to enable or disable scrolling in Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ allowScrolling?: boolean; /** Gets or sets a value that indicates whether to enable or disable sheet on demand. By enabling this, it render only the active sheet element while paging remaining sheets are created one by one. - * @Default {false} - */ + * @Default {false} + */ allowSheetOnDemand?: boolean; /** Gets or sets a value that indicates whether to enable or disable virtual scrolling feature in the Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ allowVirtualScrolling?: boolean; /** Gets or sets the value that indicates to define the height of spreadsheet. - * @Default {100%} - */ + * @Default {100%} + */ height?: number|string; /** Gets or sets the value that indicates whether to enable or disable responsive mode in the Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ isResponsive?: boolean; /** Gets or sets a value that indicates to set scroll mode in Spreadsheet. It has two scroll modes, Normal and Infinite. - * @Default {ej.Spreadsheet.scrollMode.Infinite} - */ + * @Default {ej.Spreadsheet.scrollMode.Infinite} + */ scrollMode?: ej.Spreadsheet.scrollMode|string; /** Gets or sets the value that indicates to define the height of the spreadsheet. - * @Default {100%} - */ + * @Default {100%} + */ width?: number|string; } export interface SelectionSettings { /** Gets or sets a value that indicates to define active cell in spreadsheet. - */ + */ activeCell?: string; /** Gets or sets a value that indicates to define animation time while selection in the Spreadsheet. - * @Default {0.001} - */ + * @Default {0.001} + */ animationTime?: number; /** Gets or sets a value that indicates to enable or disable animation while selection. - * @Default {false} - */ + * @Default {false} + */ enableAnimation?: boolean; /** Gets or sets a value that indicates to set selection type in Spreadsheet. It has three types which are Column, Row and Default. - * @Default {ej.Spreadsheet.SelectionType.Default} - */ + * @Default {ej.Spreadsheet.SelectionType.Default} + */ selectionType?: ej.Spreadsheet.SelectionType|string; /** Gets or sets a value that indicates to set selection unit in Spreadsheet. It has three types which are Single, Range and MultiRange. - * @Default {ej.Spreadsheet.SelectionUnit.MultiRange} - */ + * @Default {ej.Spreadsheet.SelectionUnit.MultiRange} + */ selectionUnit?: ej.Spreadsheet.SelectionUnit|string; } export interface SheetsBorder { /** - */ + */ type?: ej.Spreadsheet.BorderType|string; /** Specifies border color for range of cells in Spreadsheet. - */ + */ color?: string; /** To apply border for the specified range of cell. - */ + */ range?: string; } export interface SheetsCFormatRule { /** Specifies the conditions to apply for the range of cells in Spreadsheet. - */ + */ action?: ej.Spreadsheet.CFormatRule|string; /** Specifies the color to apply for the range of cell while conditional formatting. - */ + */ color?: ej.Spreadsheet.CFormatHighlightColor|string; /** Specifies the inputs for conditional formatting in Spreadsheet. - * @Default {[]} - */ + * @Default {[]} + */ inputs?: any[]; /** Specifies the range for conditional formatting in Spreadsheet. - */ + */ range?: string; } export interface SheetsRangeSetting { /** Gets or sets the data to render the Spreadsheet. - * @Default {null} - */ + * @Default {null} + */ dataSource?: any; /** Specifies the header styles for the headers in datasource range. - * @Default {null} - */ + * @Default {null} + */ headerStyles?: any; /** Specifies the primary key for the datasource in Spreadsheet. - */ + */ primaryKey?: string; /** Specifies the query for the datasource in Spreadsheet. - * @Default {null} - */ + * @Default {null} + */ query?: any; /** Gets or sets a value that indicates whether to enable or disable the datasource header in Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ showHeader?: boolean; /** Specifies the start cell for the datasource range in Spreadsheet. - * @Default {A1} - */ + * @Default {A1} + */ startCell?: string; } export interface SheetsRowsCellsComment { /** Get or sets the value that indicates whether to show or hide comments in Spreadsheet. - * @Default {false} - */ + * @Default {false} + */ isVisible?: boolean; /** Specifies the value for the comment in Spreadsheet. - */ + */ value?: string; } export interface SheetsRowsCellsFormat { /** Specifies the number of decimal places for the given input. - * @Default {2} - */ + * @Default {2} + */ decimalPlaces?: number; /** Specifies the string format for the given input. - */ + */ formatStr?: string; /** Specifies the thousand separator for the given input. - * @Default {false} - */ + * @Default {false} + */ thousandSeparator?: boolean; /** Specifies the type of the format in Spreadsheet. - */ + */ type?: string; } export interface SheetsRowsCellsHyperlink { /** Specifies the web address for the hyperlink of a cell. - */ + */ webAddr?: string; /** Specifies the cell address for the hyperlink of a cell. - */ + */ cellAddr?: string; /** Specifies the sheet index to which the cell is referred. - * @Default {1} - */ + * @Default {1} + */ sheetIndex?: number; } export interface SheetsRowsCellsStyle { /** Specifies the background color of a cell in the Spreadsheet. - */ + */ backgroundColor?: string; /** Specifies the font color of a cell in the Spreadsheet. - */ + */ color?: string; /** Specifies the font weight of a cell in the Spreadsheet. - */ + */ fontWeight?: string; } export interface SheetsRowsCell { /** Specifies the comment for a cell in Spreadsheet. - * @Default {null} - */ + * @Default {null} + */ comment?: SheetsRowsCellsComment; /** Specifies the format of a cell in Spreadsheet. - * @Default {null} - */ + * @Default {null} + */ format?: SheetsRowsCellsFormat; /** Specifies the hyperlink for a cell in Spreadsheet. - * @Default {null} - */ + * @Default {null} + */ hyperlink?: SheetsRowsCellsHyperlink; /** Specifies the index of a cell in Spreadsheet. - * @Default {0} - */ + * @Default {0} + */ index?: number; /** Specifies whether to lock or unlock a particular cell. - * @Default {false} - */ + * @Default {false} + */ isLocked?: boolean; /** Specifies the styles of a cell in Spreadsheet. - * @Default {null} - */ + * @Default {null} + */ style?: SheetsRowsCellsStyle; /** Specifies the value for a cell in Spreadsheet. - */ + */ value?: string; } export interface SheetsRow { /** Gets or sets the height of a row in Spreadsheet. - * @Default {20} - */ + * @Default {20} + */ height?: number; /** Specifies the cells of a row in Spreadsheet. - * @Default {[]} - */ + * @Default {[]} + */ cells?: SheetsRowsCell[]; /** Gets or sets the index of a row in Spreadsheet. - * @Default {0} - */ + * @Default {0} + */ index?: number; } export interface Sheet { /** Specifies the border for the cell in the Spreadsheet. - * @Default {[]} - */ + * @Default {[]} + */ border?: SheetsBorder[]; /** Specifies the cell types for a cell or range in Spreadsheet. - * @Default {[]} - */ + * @Default {[]} + */ cellTypes?: any[]; /** Specifies the conditional formatting for the range of cell in Spreadsheet. - * @Default {[]} - */ + * @Default {[]} + */ cFormatRule?: SheetsCFormatRule[]; /** Gets or sets a value that indicates to define column count in the Spreadsheet. - * @Default {21} - */ + * @Default {21} + */ colCount?: number; /** Gets or sets a value that indicates to define column width in the Spreadsheet. - * @Default {64} - */ + * @Default {64} + */ columnWidth?: number; /** Gets or sets the data to render the Spreadsheet. - * @Default {null} - */ + * @Default {null} + */ dataSource?: any; /** Gets or sets a value that indicates whether to enable or disable field as column header in the Spreadsheet. - * @Default {false} - */ + * @Default {false} + */ fieldAsColumnHeader?: boolean; /** Gets or sets a value to freeze rows in the Spreadsheet. - * @Default {0} - */ + * @Default {0} + */ frozenRows?: number; /** Gets or sets a value to freeze columns in the Spreadsheet. - * @Default {0} - */ + * @Default {0} + */ frozenColumns?: number; /** Specifies the header styles for the headers in datasource range. - * @Default {null} - */ + * @Default {null} + */ headerStyles?: any; /** To hide the specified columns in Spreadsheet. - * @Default {[]} - */ + * @Default {[]} + */ hideColumns?: any[]; /** To hide the specified rows in Spreadsheet. - * @Default {[]} - */ + * @Default {[]} + */ hideRows?: any[]; /** To merge specified ranges in Spreadsheet. - * @Default {[]} - */ + * @Default {[]} + */ mergeCells?: any[]; /** Specifies the primary key for the datasource in Spreadsheet. - */ + */ primaryKey?: string; /** Specifies the query for the dataSource in Spreadsheet. - * @Default {null} - */ + * @Default {null} + */ query?: any; /** Specifies single range or multiple range settings for a sheet in Spreadsheet. - * @Default {[]} - */ + * @Default {[]} + */ rangeSettings?: SheetsRangeSetting[]; /** Gets or sets a value that indicates to define row count in the Spreadsheet. - * @Default {20} - */ + * @Default {20} + */ rowCount?: number; /** Specifies the rows for a sheet in Spreadsheet. - * @Default {[]} - */ + * @Default {[]} + */ rows?: SheetsRow[]; /** Gets or sets a value that indicates whether to show or hide grid lines in the Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ showGridlines?: boolean; /** Gets or sets a value that indicates whether to enable or disable the datasource header in Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ showHeader?: boolean; /** Gets or sets a value that indicates whether to show or hide headings in the Spreadsheet. - * @Default {true} - */ + * @Default {true} + */ showHeadings?: boolean; /** Specifies the start cell for the datasource range in Spreadsheet. - * @Default {A1} - */ + * @Default {A1} + */ startCell?: string; } @@ -41496,111 +41496,111 @@ class PdfViewer extends ej.Widget { defaults: PdfViewer.Model; /** Loads the document with the filename and displays it in PDF viewer. - * @param {string} File name to be loaded - * @returns {void} - */ + * @param {string} File name to be loaded + * @returns {void} + */ load(fileName: string): void; /** Shows/hides the toolbar in the PDF viewer. - * @param {boolean} shows/hides the toolbar - * @returns {void} - */ + * @param {boolean} shows/hides the toolbar + * @returns {void} + */ showToolbar(show: boolean): void; /** Prints the PDF document. - * @returns {void} - */ + * @returns {void} + */ print(): void; /** Abort the printing function and restores the PDF viewer. - * @returns {void} - */ + * @returns {void} + */ abortPrint(): void; /** Shows/hides the print icon in the toolbar. - * @param {boolean} shows/hides print button in the toolbar - * @returns {void} - */ + * @param {boolean} shows/hides print button in the toolbar + * @returns {void} + */ showPrintTools(show: boolean): void; /** Downloads the PDF document being loaded in the ejPdfViewer control. - * @returns {void} - */ + * @returns {void} + */ download(): void; /** Shows/hides the download tool in the toolbar. - * @param {boolean} shows/hides download button in the toolbar - * @returns {void} - */ + * @param {boolean} shows/hides download button in the toolbar + * @returns {void} + */ showDownloadTool(show: boolean): void; /** Shows/hides the page navigation tools in the toolbar - * @param {boolean} shows/hides navigation tools in the toolbar - * @returns {void} - */ + * @param {boolean} shows/hides navigation tools in the toolbar + * @returns {void} + */ showPageNavigationTools(show: boolean): void; /** Navigates to the specific page in the PDF document. If the page is not available for the given pageNumber, PDF viewer retains the existing page in view. - * @param {number} navigates to the page number in the PDF document - * @returns {void} - */ + * @param {number} navigates to the page number in the PDF document + * @returns {void} + */ goToPage(pageNumber: number): void; /** Navigates to the last page of the PDF document. - * @returns {void} - */ + * @returns {void} + */ goToLastPage(): void; /** Navigates to the first page of PDF document. - * @returns {void} - */ + * @returns {void} + */ goToFirstPage(): void; /** Navigates to the next page of the PDF document. - * @returns {void} - */ + * @returns {void} + */ goToNextPage(): void; /** Navigates to the previous page of the PDF document. - * @returns {void} - */ + * @returns {void} + */ goToPreviousPage(): void; /** Shows/hides the zoom tools in the toolbar. - * @param {boolean} shows/hides zoom tools in the toolbar - * @returns {void} - */ + * @param {boolean} shows/hides zoom tools in the toolbar + * @returns {void} + */ showMagnificationTools(show: boolean): void; /** Scales the page to fit the page in the container in the control. - * @returns {void} - */ + * @returns {void} + */ fitToPage(): void; /** Scales the page to fit the page width to the width of the container in the control. - * @returns {void} - */ + * @returns {void} + */ fitToWidth(): void; /** Magnifies the page to the next value in the zoom drop down list. - * @returns {void} - */ + * @returns {void} + */ zoomIn(): void; /** Shrinks the page to the previous value in the magnification in the drop down list. - * @returns {void} - */ + * @returns {void} + */ zoomOut(): void; /** Scales the page to the specified percentage ranging from 50 to 400. If the given zoomValue is less than 50 or greater than 400; the PDF viewer scales the page to 50 and 400 respectively. - * @param {number} zoom value for scaling the pages in the PDF Viewer - * @returns {void} - */ + * @param {number} zoom value for scaling the pages in the PDF Viewer + * @returns {void} + */ zoomTo(zoomValue: number): void; /** Unloads the PDF document being displayed in the PDF viewer. - * @returns {void} - */ + * @returns {void} + */ unload(): void; } export namespace PdfViewer { @@ -41608,67 +41608,67 @@ export namespace PdfViewer { export interface Model { /** Specifies the locale information of the PDF viewer. - */ + */ locale?: string; /** Specifies the toolbar settings. - */ + */ toolbarSettings?: ToolbarSettings; /** Specifies the name of the action method in the server. - */ + */ serverActionSettings?: ServerActionSettings; /** Sets the PDF Web API service URL - */ + */ serviceUrl?: string; /** Sets the PDF document path for initial loading. - */ + */ documentPath?: string; /** Gets the total number of pages in PDF document. - */ + */ pageCount?: number; /** Gets the number of the page being displayed in the PDF viewer. - */ + */ currentPageNumber?: number; /** Gets the current zoom percentage of the PDF document in viewer. - */ + */ zoomPercentage?: number; /** Specifies the location of the supporting PDF service - */ + */ pdfService?: ej.PdfViewer.PdfService|string; /** Specifies the open state of the hyperlink in the PDF document. - */ + */ hyperlinkOpenState?: ej.PdfViewer.LinkTarget|string; /** Enables or disables the hyperlinks in PDF document. - */ + */ enableHyperlink?: boolean; /** Enables or disables the text selection in PDF document. - */ + */ enableTextSelection?: boolean; /** Enables or disables the responsiveness of the PDF viewer control during the window resize. - */ + */ isResponsive?: boolean; /** Checks whether the PDF document is edited. - */ + */ isDocumentEdited?: boolean; /** Enables or disables the buffering of the PDF pages in the client side. - */ + */ allowClientBuffering?: boolean; /** Gets the name of the PDF document which loaded in the ejPdfViewer control for downloading. - */ + */ fileName?: string; /** Triggers when the PDF document gets loaded and is ready to view in the Control. */ @@ -41708,231 +41708,231 @@ export interface Model { export interface DocumentLoadEventArgs { /** true, if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the PDF viewer model - */ + */ model?: any; /** Returns the name of the event - */ + */ type?: string; /** Returns the PDF document name displaying in the PDF viewer. - */ + */ fileName?: string; } export interface DocumentUnloadEventArgs { /** true, if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the PDF viewer model - */ + */ model?: any; /** Returns the name of the event - */ + */ type?: string; } export interface PageChangeEventArgs { /** true, if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the PDF viewer model - */ + */ model?: any; /** Returns the name of the event - */ + */ type?: string; /** Returns the current page number in view. - */ + */ currentPageNumber?: number; } export interface ZoomChangeEventArgs { /** true, if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the PDF viewer model - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; /** Returns the previous zoom percentage of the PDF viewer control - */ + */ previousZoomPercentage?: number; /** Returns the current zoom percentage of the PDF viewer control - */ + */ currentZoomPercentage?: number; } export interface HyperlinkClickEventArgs { /** true, if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the PDF viewer model - */ + */ model?: any; /** Returns the name of the event - */ + */ type?: string; /** Returns the clicked hyperlink - */ + */ hyperlink?: string; } export interface BeforePrintEventArgs { /** True, if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the PDF viewer model - */ + */ model?: any; /** Returns the name of the event - */ + */ type?: string; } export interface AfterPrintEventArgs { /** True, if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the PDF viewer model - */ + */ model?: any; /** Returns the name of the event - */ + */ type?: string; } export interface PageClickEventArgs { /** True, if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the PDF viewer model - */ + */ model?: any; /** Returns the name of the event - */ + */ type?: string; /** Returns the current X position - */ + */ offsetX?: number; /** Returns the current Y position - */ + */ offsetY?: number; } export interface BufferStartEventArgs { /** True, if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the PDF viewer model - */ + */ model?: any; /** Returns the name of the event - */ + */ type?: string; /** Specifies the state of the buffering - */ + */ isBuffering?: boolean; } export interface BufferEndEventArgs { /** True, if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the PDF viewer model - */ + */ model?: any; /** Returns the name of the event - */ + */ type?: string; /** Specifies the state of the buffering - */ + */ isBuffering?: boolean; } export interface DestroyEventArgs { /** True, if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the PDF viewer model - */ + */ model?: any; /** Returns the name of the event - */ + */ type?: string; } export interface ToolbarSettings { /** Shows or hides the tooltip of the toolbar items. - */ + */ showToolTip?: boolean; /** Shows or hides the grouped items in the toolbar with the help of enum ej.PdfViewer.ToolbarItems - */ + */ toolbarItem?: ej.PdfViewer.ToolbarItems|string; } export interface ServerActionSettings { /** Specifies the name of the action method used for loading the PDF document. - */ + */ load?: string; /** Specifies the name of the action method used for uploading the PDF document to the PDF viewer control. - */ + */ fileUpload?: string; /** Specifies the name of the action method used for printing the PDF document in the PDF viewer control. - */ + */ print?: string; /** Specifies the name of the action method used for downloading the PDF document from the PDF viewer control. - */ + */ download?: string; } @@ -41987,58 +41987,58 @@ class SpellCheck extends ej.Widget { defaults: SpellCheck.Model; /** Open the dialog to correct the spelling of the target content. - * @returns {void} - */ + * @returns {void} + */ showInDialog(): void; /** Highlighting the error word in the target area itself and correct the spelling using the context menu. - * @returns {void} - */ + * @returns {void} + */ validate(): void; /** To get the error word highlighted string by passing the given input sentence. - * @param {string} Content to be spell check - * @param {string} Class name that contains style value to highlight the error word - * @returns {any} - */ + * @param {string} Content to be spell check + * @param {string} Class name that contains style value to highlight the error word + * @returns {any} + */ spellCheck(targetSentence: string, misspellWordCss: string): any; /** To ignore all the error word occurrences from the given input sentence. - * @param {string} Error word to ignore from the target content - * @param {string} Content to perform the ignore all operation - * @returns {any} - */ + * @param {string} Error word to ignore from the target content + * @param {string} Content to perform the ignore all operation + * @returns {any} + */ ignoreAll(word: string, targetSentence: string): any; /** To ignore the error word once from the given input sentence. - * @param {string} Error word to ignore from the target content - * @param {string} Content to perform the ignore operation - * @param {number} Index of the error word present in the target content - * @returns {any} - */ + * @param {string} Error word to ignore from the target content + * @param {string} Content to perform the ignore operation + * @param {number} Index of the error word present in the target content + * @returns {any} + */ ignore(word: string, targetSentence: string, index: number): any; /** To change the error word once from the given input sentence. - * @param {string} Error word to change from the target content - * @param {string} Content to perform the change operation - * @param {string} Word to replace with the error word - * @param {number} Index of the error word present in the target content - * @returns {any} - */ + * @param {string} Error word to change from the target content + * @param {string} Content to perform the change operation + * @param {string} Word to replace with the error word + * @param {number} Index of the error word present in the target content + * @returns {any} + */ change(word: string, targetSentence: string, changeWord: string, index: number): any; /** To change all the error word occurrences from the given input sentence. - * @param {string} Error word to change from the target content - * @param {string} Content to perform the change all operation - * @param {string} Word to replace with the error word - * @returns {any} - */ + * @param {string} Error word to change from the target content + * @param {string} Content to perform the change all operation + * @param {string} Word to replace with the error word + * @returns {any} + */ changeAll(word: string, targetSentence: string, changeWord: string): any; /** To add the words into the custom dictionary. - * @param {string} Word to add into the dictionary file - * @returns {any} - */ + * @param {string} Word to add into the dictionary file + * @returns {any} + */ addToDictionary(customWord: string): any; } export namespace SpellCheck { @@ -42046,45 +42046,45 @@ export namespace SpellCheck { export interface Model { /** It includes the service method path to find the error words and its suggestions also adding the custom word into the custom dictionary. - */ + */ dictionarySettings?: DictionarySettings; /** To display the error word in a customized style. - * @Default {e-errorword} - */ + * @Default {e-errorword} + */ misspellWordCss?: string; /** Sets the specific culture to the SpellCheck. - * @Default {en-US} - */ + * @Default {en-US} + */ locale?: string; /** To set the maximum suggestion display count. - * @Default {6} - */ + * @Default {6} + */ maxSuggestionCount?: number; /** To ignore the words from the error word consideration. - * @Default {[]} - */ + * @Default {[]} + */ ignoreWords?: any[]; /** Holds all options related to the context menu settings of SpellCheck. - */ + */ contextMenuSettings?: ContextMenuSettings; /** It helps to ignore the uppercase, mixed case words, alpha numeric words, file path and email addresses based on the property values. - */ + */ ignoreSettings?: IgnoreSettings; /** When set to true, allows the spellcheck to render based upon screen size. - * @Default {true} - */ + * @Default {true} + */ isResponsive?: boolean; /** It allows to spell check the multiple target HTML element's texts and correct its error words. - * @Default {null} - */ + * @Default {null} + */ controlsToValidate?: string; /** Triggers on the success of AJAX call request. */ @@ -42126,378 +42126,378 @@ export interface Model { export interface ActionSuccessEventArgs { /** Returns the error word highlighted string. - */ + */ resultHTML?: string; /** Returns the error word details of the given input. - */ + */ errorWordDetails?: any; /** Returns the request type value. - */ + */ requestType?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the SpellCheck model. - */ + */ model?: ej.SpellCheck.Model; /** Returns the name of the event. - */ + */ type?: string; } export interface ActionBeginEventArgs { /** Returns the input string. - */ + */ targetSentence?: string; /** Returns the misspellWordCss class name. - */ + */ misspellWordCss?: string; /** Returns the request type value. - */ + */ requestType?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the SpellCheck model. - */ + */ model?: ej.SpellCheck.Model; /** Returns the name of the event. - */ + */ type?: string; } export interface ActionFailureEventArgs { /** Returns AJAX request failure error message. - */ + */ errorMessage?: string; /** Returns the request type value. - */ + */ requestType?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the SpellCheck model. - */ + */ model?: ej.SpellCheck.Model; /** Returns the name of the event. - */ + */ type?: string; } export interface StartEventArgs { /** Returns the input string. - */ + */ targetSentence?: string; /** Returns the error words details. - */ + */ errorWords?: any; /** Returns the request type value. - */ + */ requestType?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the SpellCheck model. - */ + */ model?: ej.SpellCheck.Model; /** Returns the name of the event. - */ + */ type?: string; } export interface CompleteEventArgs { /** Returns the error word highlighted string. - */ + */ resultHTML?: string; /** Returns the request type value. - */ + */ requestType?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the SpellCheck model. - */ + */ model?: ej.SpellCheck.Model; /** Returns the name of the event. - */ + */ type?: string; } export interface ContextOpenEventArgs { /** Returns the selected error word. - */ + */ selectedErrorWord?: string; /** Returns the request type value. - */ + */ requestType?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the SpellCheck model. - */ + */ model?: ej.SpellCheck.Model; /** Returns the name of the event. - */ + */ type?: string; } export interface ContextClickEventArgs { /** Returns the selected error word. - */ + */ selectedValue?: string; /** Returns the selected option in the context menu. - */ + */ selectedOption?: string; /** Returns the input string. - */ + */ targetContent?: string; /** Returns the request type value. - */ + */ requestType?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the SpellCheck model. - */ + */ model?: ej.SpellCheck.Model; /** Returns the name of the event. - */ + */ type?: string; } export interface DialogBeforeOpenEventArgs { /** Returns the spell check window details. - */ + */ spellCheckDialog?: any; /** Returns the request type value. - */ + */ requestType?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the SpellCheck model. - */ + */ model?: ej.SpellCheck.Model; /** Returns the name of the event. - */ + */ type?: string; } export interface DialogOpenEventArgs { /** Returns the target input. - */ + */ targetText?: string; /** Returns the request type value. - */ + */ requestType?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the SpellCheck model. - */ + */ model?: ej.SpellCheck.Model; /** Returns the name of the event. - */ + */ type?: string; } export interface DialogCloseEventArgs { /** Returns the error corrected string. - */ + */ updatedText?: string; /** Returns the request type value. - */ + */ requestType?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the SpellCheck model. - */ + */ model?: ej.SpellCheck.Model; /** Returns the name of the event. - */ + */ type?: string; } export interface ValidatingEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the error word to ignore. - */ + */ ignoreWord?: string; /** Returns the target content. - */ + */ targetContent?: string; /** Returns the index of an error word. - */ + */ index?: number; /** Returns the SpellCheck model. - */ + */ model?: ej.SpellCheck.Model; /** Returns the validating request type. - */ + */ requestType?: string; /** Returns the name of the event. - */ + */ type?: string; /** Returns the error word to change. - */ + */ changeableWord?: string; /** Returns the change word to replace the error word. - */ + */ changeWord?: string; /** Returns the custom word to add into dictionary file. - */ + */ customWord?: string; } export interface TargetUpdatingEventArgs { /** Returns the previous target element value. - */ + */ previousElement?: any; /** Returns the current target element value. - */ + */ currentElement?: any; /** Returns the target html value. - */ + */ targetHtml?: string; /** Returns the cancel option value. - */ + */ cancel?: boolean; /** Returns the SpellCheck model. - */ + */ model?: ej.SpellCheck.Model; /** Returns the name of the event. - */ + */ type?: string; } export interface DictionarySettings { /** The dictionaryUrl option accepts string, which is the method path to find the error words and get the suggestions to correct the errors. - */ + */ dictionaryUrl?: string; /** The customDictionaryUrl option accepts string, which is the method path to add the error word into the custom dictionary. - */ + */ customDictionaryUrl?: string; } export interface ContextMenuSettings { /** When set to true, enables the context menu options available for the SpellCheck. - * @Default {true} - */ + * @Default {true} + */ enable?: boolean; /** Contains all the default context menu options that are applicable for SpellCheck. It also supports adding custom menu items. - * All the SpellCheck related context menu items are grouped under this menu collection. - * @Default {{% highlight javascript %}[{ id: IgnoreAll, text: Ignore All },{ id: AddToDictionary, text: Add To Dictionary }]{% endhighlight %}} - */ + * All the SpellCheck related context menu items are grouped under this menu collection. + * @Default {{% highlight javascript %}[{ id: IgnoreAll, text: Ignore All },{ id: AddToDictionary, text: Add To Dictionary }]{% endhighlight %}} + */ menuItems?: any[]; } export interface IgnoreSettings { /** When set to true, ignoring the alphanumeric words from the error word consideration. - * @Default {true} - */ + * @Default {true} + */ ignoreAlphaNumericWords?: string; /** When set to true, ignoring the Email address from the error word consideration. - * @Default {true} - */ + * @Default {true} + */ ignoreEmailAddress?: boolean; /** When set to true, ignoring the MixedCase words from the error word consideration. - * @Default {true} - */ + * @Default {true} + */ ignoreMixedCaseWords?: boolean; /** When set to true, ignoring the UpperCase words from the error word consideration. - * @Default {true} - */ + * @Default {true} + */ ignoreUpperCase?: boolean; /** When set to true, ignoring the Url from the error word consideration. - * @Default {true} - */ + * @Default {true} + */ ignoreUrl?: boolean; /** When set to true, ignoring the file address path from the error word consideration. - * @Default {true} - */ + * @Default {true} + */ ignoreFileNames?: boolean; } } @@ -42510,46 +42510,46 @@ class DocumentEditor extends ej.Widget { defaults: DocumentEditor.Model; /** Loads the document from specified path using web API provided by importUrl. - * @param {string} Specifies the file path. - * @returns {void} - */ + * @param {string} Specifies the file path. + * @returns {void} + */ load(path: string): void; /** Gets the page number of current selection in the document. - * @returns {number} - */ + * @returns {number} + */ getCurrentPageNumber(): number; /** Gets the total number of pages in the document. - * @returns {number} - */ + * @returns {number} + */ getPageCount(): number; /** Gets the text of current selection in the document. - * @returns {string} - */ + * @returns {string} + */ getSelectedText(): string; /** Gets the current zoom factor value of the document editor. - * @returns {number} - */ + * @returns {number} + */ getZoomFactor(): number; /** Scales the document editor with the specified zoom factor. The range of zoom factor should be 0.10 to 5.00 (10 - 500 %). - * @param {number} Specifies the factor for zooming. - * @returns {void} - */ + * @param {number} Specifies the factor for zooming. + * @returns {void} + */ setZoomFactor(factor: number): void; /** Prints the document content as page by page. - * @returns {void} - */ + * @returns {void} + */ print(): void; /** Finds the first occurrence of specified text from current selection and highlights the result. If the document end is reached, find operation will occur from the document start position. - * @param {string} Specifies the text to search in a document. - * @returns {void} - */ + * @param {string} Specifies the text to search in a document. + * @returns {void} + */ find(text: string): void; } export namespace DocumentEditor { @@ -42557,7 +42557,7 @@ export namespace DocumentEditor { export interface Model { /** Gets or sets an object that indicates initialization of importing and exporting documents in document editor. - */ + */ importExportSettings?: ImportExportSettings; /** Triggers when the document changes. */ @@ -42576,71 +42576,71 @@ export interface Model { export interface OnDocumentChangeEventArgs { /** True, if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the document editor model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface OnSelectionChangeEventArgs { /** True, if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the document editor model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface OnZoomFactorChangeEventArgs { /** True, if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the document editor model. - */ + */ model?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface OnRequestNavigateEventArgs { /** true, if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** Returns the document editor model. - */ + */ model?: any; /** Returns the link type and navigation link. - */ + */ hyperlink?: any; /** Returns the name of the event. - */ + */ type?: string; } export interface ImportExportSettings { /** Gets or sets URL of Web API that should be used to parse the document while loading. - */ + */ importUrl?: string; } } @@ -42656,17 +42656,17 @@ class SymbolPalette extends ej.Widget { defaults: SymbolPalette.Model; /** Add items to Palettes at runtime - * @param {string} name of the Palette - * @param {any} JSON for the new items to added in Palette - * @returns {void} - */ + * @param {string} name of the Palette + * @param {any} JSON for the new items to added in Palette + * @returns {void} + */ addPaletteItem(paletteName: string, node: any): void; /** Remove items to Palettes at runtime - * @param {string} name of the Palette - * @param {any} JSON for the new node to removed in Palette - * @returns {void} - */ + * @param {string} name of the Palette + * @param {any} JSON for the new node to removed in Palette + * @returns {void} + */ removePaletteItem(paletteName: string, node: any): void; } export namespace SymbolPalette { @@ -42674,72 +42674,72 @@ export namespace SymbolPalette { export interface Model { /** Defines whether the symbols can be dragged from palette or not - * @Default {true} - */ + * @Default {true} + */ allowDrag?: boolean; /** Customizes the style of the symbol palette - * @Default {e-symbolpalette} - */ + * @Default {e-symbolpalette} + */ cssClass?: string; /** Defines the default properties of nodes and connectors - */ + */ defaultSettings?: DefaultSettings; /** Sets the Id of the diagram, over which the symbols will be dropped - * @Default {null} - */ + * @Default {null} + */ diagramId?: string; /** Sets the height of the palette headers - * @Default {30} - */ + * @Default {30} + */ headerHeight?: number; /** Defines the height of the symbol palette - * @Default {400} - */ + * @Default {400} + */ height?: number; /** Defines the height of the palette items - * @Default {50} - */ + * @Default {50} + */ paletteItemHeight?: number; /** Defines the width of the palette items - * @Default {50} - */ + * @Default {50} + */ paletteItemWidth?: number; /** An array of JSON objects, where each object represents a node/connector - * @Default {[]} - */ + * @Default {[]} + */ palettes?: Palette[]; /** Defines the preview height of the symbols - * @Default {100} - */ + * @Default {100} + */ previewHeight?: number; /** Defines the offset value to be left between the mouse cursor and symbol previews - * @Default {(110, 110)} - */ + * @Default {(110, 110)} + */ previewOffset?: any; /** Defines the width of the symbol previews - * @Default {100} - */ + * @Default {100} + */ previewWidth?: number; /** Enable or disable the palette item text - * @Default {true} - */ + * @Default {true} + */ showPaletteItemText?: boolean; /** The width of the palette - * @Default {250} - */ + * @Default {250} + */ width?: number; /** Triggers when a palette item is selected or unselected */ @@ -42749,42 +42749,42 @@ export interface Model { export interface SelectionChangeEventArgs { /** returns whether an element is selected or unselected - */ + */ changeType?: string; /** returns the node or connector that is selected or unselected - */ + */ element?: any; } export interface DefaultSettings { /** Defines the default properties of the nodes - * @Default {null} - */ + * @Default {null} + */ node?: any; /** Defines the default properties of the connectors - * @Default {null} - */ + * @Default {null} + */ connector?: any; } export interface Palette { /** Defines the name of the palette - * @Default {null} - */ + * @Default {null} + */ name?: string; /** Defines whether the palette must be in expanded state or in collapsed state - * @Default {true} - */ + * @Default {true} + */ expanded?: boolean; /** Defines the palette items - * @Default {[]} - */ + * @Default {[]} + */ items?: any[]; } } @@ -42797,418 +42797,418 @@ class LinearGauge extends ej.Widget { defaults: LinearGauge.Model; /** destroy the linear gauge all events bound using this._on will be unbind automatically and bring the control to pre-init state. - * @returns {void} - */ + * @returns {void} + */ destroy(): void; /** To export Image - * @returns {void} - */ + * @returns {void} + */ exportImage(): void; /** To get Bar Distance From Scale in number - * @returns {any} - */ + * @returns {any} + */ getBarDistanceFromScale(): any; /** To get Bar Pointer Value in number - * @returns {any} - */ + * @returns {any} + */ getBarPointerValue(): any; /** To get Bar Width in number - * @returns {any} - */ + * @returns {any} + */ getBarWidth(): any; /** To get CustomLabel Angle in number - * @returns {any} - */ + * @returns {any} + */ getCustomLabelAngle(): any; /** To get CustomLabel Value in string - * @returns {any} - */ + * @returns {any} + */ getCustomLabelValue(): any; /** To get Label Angle in number - * @returns {any} - */ + * @returns {any} + */ getLabelAngle(): any; /** To get LabelPlacement in number - * @returns {any} - */ + * @returns {any} + */ getLabelPlacement(): any; /** To get LabelStyle in number - * @returns {any} - */ + * @returns {any} + */ getLabelStyle(): any; /** To get Label XDistance From Scale in number - * @returns {any} - */ + * @returns {any} + */ getLabelXDistanceFromScale(): any; /** To get PointerValue in number - * @returns {any} - */ + * @returns {any} + */ getLabelYDistanceFromScale(): any; /** To get Major Interval Value in number - * @returns {any} - */ + * @returns {any} + */ getMajorIntervalValue(): any; /** To get MarkerStyle in number - * @returns {any} - */ + * @returns {any} + */ getMarkerStyle(): any; /** To get Maximum Value in number - * @returns {any} - */ + * @returns {any} + */ getMaximumValue(): any; /** To get PointerValue in number - * @returns {any} - */ + * @returns {any} + */ getMinimumValue(): any; /** To get Minor Interval Value in number - * @returns {any} - */ + * @returns {any} + */ getMinorIntervalValue(): any; /** To get Pointer Distance From Scale in number - * @returns {any} - */ + * @returns {any} + */ getPointerDistanceFromScale(): any; /** To get PointerHeight in number - * @returns {any} - */ + * @returns {any} + */ getPointerHeight(): any; /** To get Pointer Placement in String - * @returns {any} - */ + * @returns {any} + */ getPointerPlacement(): any; /** To get PointerValue in number - * @returns {any} - */ + * @returns {any} + */ getPointerValue(): any; /** To get PointerWidth in number - * @returns {any} - */ + * @returns {any} + */ getPointerWidth(): any; /** To get Range Border Width in number - * @returns {any} - */ + * @returns {any} + */ getRangeBorderWidth(): any; /** To get Range Distance From Scale in number - * @returns {any} - */ + * @returns {any} + */ getRangeDistanceFromScale(): any; /** To get Range End Value in number - * @returns {any} - */ + * @returns {any} + */ getRangeEndValue(): any; /** To get Range End Width in number - * @returns {any} - */ + * @returns {any} + */ getRangeEndWidth(): any; /** To get Range Position in number - * @returns {any} - */ + * @returns {any} + */ getRangePosition(): any; /** To get Range Start Value in number - * @returns {any} - */ + * @returns {any} + */ getRangeStartValue(): any; /** To get Range Start Width in number - * @returns {any} - */ + * @returns {any} + */ getRangeStartWidth(): any; /** To get ScaleBarLength in number - * @returns {any} - */ + * @returns {any} + */ getScaleBarLength(): any; /** To get Scale Bar Size in number - * @returns {any} - */ + * @returns {any} + */ getScaleBarSize(): any; /** To get Scale Border Width in number - * @returns {any} - */ + * @returns {any} + */ getScaleBorderWidth(): any; /** To get Scale Direction in number - * @returns {any} - */ + * @returns {any} + */ getScaleDirection(): any; /** To get Scale Location in object - * @returns {any} - */ + * @returns {any} + */ getScaleLocation(): any; /** To get Scale Style in string - * @returns {any} - */ + * @returns {any} + */ getScaleStyle(): any; /** To get Tick Angle in number - * @returns {any} - */ + * @returns {any} + */ getTickAngle(): any; /** To get Tick Height in number - * @returns {any} - */ + * @returns {any} + */ getTickHeight(): any; /** To get getTickPlacement in number - * @returns {any} - */ + * @returns {any} + */ getTickPlacement(): any; /** To get Tick Style in string - * @returns {any} - */ + * @returns {any} + */ getTickStyle(): any; /** To get Tick Width in number - * @returns {any} - */ + * @returns {any} + */ getTickWidth(): any; /** To get get Tick XDistance From Scale in number - * @returns {any} - */ + * @returns {any} + */ getTickXDistanceFromScale(): any; /** To get Tick YDistance From Scale in number - * @returns {any} - */ + * @returns {any} + */ getTickYDistanceFromScale(): any; /** Specifies the scales. - * @returns {void} - */ + * @returns {void} + */ scales(): void; /** To set setBarDistanceFromScale - * @returns {void} - */ + * @returns {void} + */ setBarDistanceFromScale(): void; /** To set setBarPointerValue - * @returns {void} - */ + * @returns {void} + */ setBarPointerValue(): void; /** To set setBarWidth - * @returns {void} - */ + * @returns {void} + */ setBarWidth(): void; /** To set setCustomLabelAngle - * @returns {void} - */ + * @returns {void} + */ setCustomLabelAngle(): void; /** To set setCustomLabelValue - * @returns {void} - */ + * @returns {void} + */ setCustomLabelValue(): void; /** To set setLabelAngle - * @returns {void} - */ + * @returns {void} + */ setLabelAngle(): void; /** To set setLabelPlacement - * @returns {void} - */ + * @returns {void} + */ setLabelPlacement(): void; /** To set setLabelStyle - * @returns {void} - */ + * @returns {void} + */ setLabelStyle(): void; /** To set setLabelXDistanceFromScale - * @returns {void} - */ + * @returns {void} + */ setLabelXDistanceFromScale(): void; /** To set setLabelYDistanceFromScale - * @returns {void} - */ + * @returns {void} + */ setLabelYDistanceFromScale(): void; /** To set setMajorIntervalValue - * @returns {void} - */ + * @returns {void} + */ setMajorIntervalValue(): void; /** To set setMarkerStyle - * @returns {void} - */ + * @returns {void} + */ setMarkerStyle(): void; /** To set setMaximumValue - * @returns {void} - */ + * @returns {void} + */ setMaximumValue(): void; /** To set setMinimumValue - * @returns {void} - */ + * @returns {void} + */ setMinimumValue(): void; /** To set setMinorIntervalValue - * @returns {void} - */ + * @returns {void} + */ setMinorIntervalValue(): void; /** To set setPointerDistanceFromScale - * @returns {void} - */ + * @returns {void} + */ setPointerDistanceFromScale(): void; /** To set PointerHeight - * @returns {void} - */ + * @returns {void} + */ setPointerHeight(): void; /** To set setPointerPlacement - * @returns {void} - */ + * @returns {void} + */ setPointerPlacement(): void; /** To set PointerValue - * @returns {void} - */ + * @returns {void} + */ setPointerValue(): void; /** To set PointerWidth - * @returns {void} - */ + * @returns {void} + */ setPointerWidth(): void; /** To set setRangeBorderWidth - * @returns {void} - */ + * @returns {void} + */ setRangeBorderWidth(): void; /** To set setRangeDistanceFromScale - * @returns {void} - */ + * @returns {void} + */ setRangeDistanceFromScale(): void; /** To set setRangeEndValue - * @returns {void} - */ + * @returns {void} + */ setRangeEndValue(): void; /** To set setRangeEndWidth - * @returns {void} - */ + * @returns {void} + */ setRangeEndWidth(): void; /** To set setRangePosition - * @returns {void} - */ + * @returns {void} + */ setRangePosition(): void; /** To set setRangeStartValue - * @returns {void} - */ + * @returns {void} + */ setRangeStartValue(): void; /** To set setRangeStartWidth - * @returns {void} - */ + * @returns {void} + */ setRangeStartWidth(): void; /** To set setScaleBarLength - * @returns {void} - */ + * @returns {void} + */ setScaleBarLength(): void; /** To set setScaleBarSize - * @returns {void} - */ + * @returns {void} + */ setScaleBarSize(): void; /** To set setScaleBorderWidth - * @returns {void} - */ + * @returns {void} + */ setScaleBorderWidth(): void; /** To set setScaleDirection - * @returns {void} - */ + * @returns {void} + */ setScaleDirection(): void; /** To set setScaleLocation - * @returns {void} - */ + * @returns {void} + */ setScaleLocation(): void; /** To set setScaleStyle - * @returns {void} - */ + * @returns {void} + */ setScaleStyle(): void; /** To set setTickAngle - * @returns {void} - */ + * @returns {void} + */ setTickAngle(): void; /** To set setTickHeight - * @returns {void} - */ + * @returns {void} + */ setTickHeight(): void; /** To set setTickPlacement - * @returns {void} - */ + * @returns {void} + */ setTickPlacement(): void; /** To set setTickStyle - * @returns {void} - */ + * @returns {void} + */ setTickStyle(): void; /** To set setTickWidth - * @returns {void} - */ + * @returns {void} + */ setTickWidth(): void; /** To set setTickXDistanceFromScale - * @returns {void} - */ + * @returns {void} + */ setTickXDistanceFromScale(): void; /** To set setTickYDistanceFromScale - * @returns {void} - */ + * @returns {void} + */ setTickYDistanceFromScale(): void; } export namespace LinearGauge { @@ -43216,113 +43216,113 @@ export namespace LinearGauge { export interface Model { /** Specifies the animationSpeed - * @Default {500} - */ + * @Default {500} + */ animationSpeed?: number; /** Specifies the backgroundColor for Linear gauge. - * @Default {null} - */ + * @Default {null} + */ backgroundColor?: string; /** Specifies the borderColor for Linear gauge. - * @Default {null} - */ + * @Default {null} + */ borderColor?: string; /** Specifies the animate state - * @Default {true} - */ + * @Default {true} + */ enableAnimation?: boolean; /** Specifies the animate state for marker pointer - * @Default {true} - */ + * @Default {true} + */ enableMarkerPointerAnimation?: boolean; /** Specifies the can resize state. - * @Default {false} - */ + * @Default {false} + */ isResponsive?: boolean; /** Specify frame of linear gauge - * @Default {null} - */ + * @Default {null} + */ frame?: Frame; /** Specifies the height of Linear gauge. - * @Default {400} - */ + * @Default {400} + */ height?: number; /** Specifies the labelColor for Linear gauge. - * @Default {null} - */ + * @Default {null} + */ labelColor?: string; /** Specifies the maximum value of Linear gauge. - * @Default {100} - */ + * @Default {100} + */ maximum?: number; /** Specifies the minimum value of Linear gauge. - * @Default {0} - */ + * @Default {0} + */ minimum?: number; /** Specifies the orientation for Linear gauge. - * @Default {Vertical} - */ + * @Default {Vertical} + */ orientation?: string; /** Specify labelPosition value of Linear gauge See OuterCustomLabelPosition - * @Default {bottom} - */ + * @Default {bottom} + */ outerCustomLabelPosition?: ej.datavisualization.LinearGauge.OuterCustomLabelPosition|string; /** Specifies the pointerGradient1 for Linear gauge. - * @Default {null} - */ + * @Default {null} + */ pointerGradient1?: any; /** Specifies the pointerGradient2 for Linear gauge. - * @Default {null} - */ + * @Default {null} + */ pointerGradient2?: any; /** Specifies the read only state. - * @Default {true} - */ + * @Default {true} + */ readOnly?: boolean; /** Specifies the scales - * @Default {null} - */ + * @Default {null} + */ scales?: Scale[]; /** Specifies the theme for Linear gauge. See LinearGauge.Themes - * @Default {flatlight} - */ + * @Default {flatlight} + */ theme?: ej.datavisualization.LinearGauge.Themes|string; /** Specifies the tick Color for Linear gauge. - * @Default {null} - */ + * @Default {null} + */ tickColor?: string; /** Specify tooltip options of linear gauge - * @Default {false} - */ + * @Default {false} + */ tooltip?: Tooltip; /** Specifies the value of the Gauge. - * @Default {0} - */ + * @Default {0} + */ value?: number; /** Specifies the width of Linear gauge. - * @Default {150} - */ + * @Default {150} + */ width?: number; /** Triggers while the bar pointer are being drawn on the gauge. */ @@ -43368,1323 +43368,1323 @@ export interface Model { export interface DrawBarPointersEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the context element - */ + */ context?: any; /** returns the startX and startY of the pointer - */ + */ position?: any; /** returns the gauge model - */ + */ Model?: any; /** returns the options of the scale element. - */ + */ scaleElement?: any; /** returns the scaleIndex to which the pointer belongs. - */ + */ scaleIndex?: number; /** returns the pointer style - */ + */ style?: string; /** returns the current Bar pointer element. - */ + */ barElement?: any; /** returns the index of the bar pointer. - */ + */ barPointerIndex?: number; /** returns the value of the bar pointer. - */ + */ PointerValue?: number; /** returns the name of the event - */ + */ type?: any; } export interface DrawCustomLabelEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the context element - */ + */ context?: any; /** returns the startX and startY of the customLabel - */ + */ position?: any; /** returns the gauge model - */ + */ Model?: any; /** returns the options of the scale element. - */ + */ scaleElement?: any; /** returns the scaleIndex to which the pointer belongs. - */ + */ scaleIndex?: number; /** returns the customLabel style - */ + */ style?: any; /** returns the current customLabel element. - */ + */ customLabelElement?: any; /** returns the index of the customLabel. - */ + */ customLabelIndex?: number; /** returns the name of the event - */ + */ type?: any; } export interface DrawIndicatorsEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the context element - */ + */ context?: any; /** returns the startX and startY of the Indicator - */ + */ position?: any; /** returns the gauge model - */ + */ Model?: any; /** returns the options of the scale element. - */ + */ scaleElement?: any; /** returns the scaleIndex to which the pointer belongs. - */ + */ scaleIndex?: number; /** returns the Indicator style - */ + */ style?: string; /** returns the current Indicator element. - */ + */ IndicatorElement?: any; /** returns the index of the Indicator. - */ + */ IndicatorIndex?: number; /** returns the name of the event - */ + */ type?: any; } export interface DrawLabelsEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the context element - */ + */ context?: any; /** returns the startX and startY of the label - */ + */ position?: any; /** returns the gauge model - */ + */ Model?: any; /** returns the options of the scale element. - */ + */ scaleElement?: any; /** returns the scaleIndex to which the label belongs. - */ + */ scaleIndex?: number; /** returns the label style - */ + */ style?: string; /** returns the angle of the label. - */ + */ angle?: number; /** returns the current label element. - */ + */ element?: any; /** returns the index of the label. - */ + */ index?: number; /** returns the label value of the label. - */ + */ value?: number; /** returns the name of the event - */ + */ type?: any; } export interface DrawMarkerPointersEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the context element - */ + */ context?: any; /** returns the startX and startY of the pointer - */ + */ position?: any; /** returns the gauge model - */ + */ Model?: any; /** returns the options of the scale element. - */ + */ scaleElement?: any; /** returns the scaleIndex to which the pointer belongs. - */ + */ scaleIndex?: number; /** returns the ticks style - */ + */ style?: string; /** returns the current marker pointer element. - */ + */ markerElement?: any; /** returns the index of the marker pointer. - */ + */ markerPointerIndex?: number; /** returns the value of the marker pointer. - */ + */ pointerValue?: number; /** returns the angle of the marker pointer. - */ + */ pointerAngle?: number; /** returns the name of the event - */ + */ type?: any; } export interface DrawRangeEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the context element - */ + */ context?: any; /** returns the startX and startY of the range - */ + */ position?: any; /** returns the gauge model - */ + */ Model?: any; /** returns the options of the scale element. - */ + */ scaleElement?: any; /** returns the scaleIndex to which the pointer belongs. - */ + */ scaleIndex?: number; /** returns the range style - */ + */ style?: string; /** returns the current range element. - */ + */ rangeElement?: any; /** returns the index of the range. - */ + */ rangeIndex?: number; /** returns the name of the event - */ + */ type?: any; } export interface DrawTicksEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the context element - */ + */ context?: any; /** returns the startX and startY of the ticks - */ + */ position?: any; /** returns the gauge model - */ + */ Model?: any; /** returns the options of the scale element. - */ + */ scaleElement?: any; /** returns the scaleIndex to which the tick belongs. - */ + */ scaleIndex?: number; /** returns the ticks style - */ + */ style?: string; /** returns the angle of the tick. - */ + */ angle?: number; /** returns the current tick element. - */ + */ element?: any; /** returns the index of the tick. - */ + */ index?: number; /** returns the tick value of the tick. - */ + */ value?: number; /** returns the name of the event - */ + */ type?: any; } export interface InitEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the gauge model - */ + */ Model?: any; /** returns the entire scale element. - */ + */ scaleElement?: any; /** returns the context element - */ + */ context?: any; /** returns the name of the event - */ + */ type?: string; } export interface LoadEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the gauge model - */ + */ Model?: any; /** returns the entire scale element. - */ + */ scaleElement?: any; /** returns the context element - */ + */ context?: any; /** returns the name of the event - */ + */ type?: any; } export interface MouseClickEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the gauge model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: any; /** returns the scale element. - */ + */ scaleElement?: any; /** returns the scaleIndex to which the pointer belongs. - */ + */ scaleIndex?: number; /** returns the context element* @param {Object} args.markerpointer returns the context element - */ + */ context?: any; /** returns the pointer Index - */ + */ markerpointerindex?: number; /** returns the pointer element. - */ + */ markerpointerelement?: any; /** returns the value of the pointer. - */ + */ markerpointervalue?: number; /** returns the pointer style - */ + */ style?: string; /** returns the startX and startY of the pointer. - */ + */ position?: any; } export interface MouseClickMoveEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the gauge model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: any; /** returns the scale element. - */ + */ scaleElement?: any; /** returns the scaleIndex to which the pointer belongs. - */ + */ scaleIndex?: number; /** returns the context element - */ + */ context?: any; /** returns the pointer Index - */ + */ index?: number; /** returns the pointer element. - */ + */ element?: any; /** returns the value of the pointer. - */ + */ value?: number; /** returns the pointer style - */ + */ style?: string; /** returns the startX and startY of the pointer. - */ + */ position?: any; } export interface MouseClickUpEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the gauge model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: any; /** returns the scale element. - */ + */ scaleElement?: any; /** returns the scaleIndex to which the pointer belongs. - */ + */ scaleIndex?: number; /** returns the context element* @param {Object} args.markerpointer returns the context element - */ + */ context?: any; /** returns the pointer Index - */ + */ markerpointerIndex?: number; /** returns the pointer element. - */ + */ markerpointerElement?: any; /** returns the value of the pointer. - */ + */ markerpointerValue?: number; /** returns the pointer style - */ + */ style?: string; /** returns the startX and startY of the pointer. - */ + */ position?: any; } export interface RenderCompleteEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the gauge model - */ + */ Model?: any; /** returns the entire scale element. - */ + */ scaleElement?: any; /** returns the context element - */ + */ context?: any; /** returns the name of the event - */ + */ type?: any; } export interface Frame { /** Specifies the frame background image URL of linear gauge - * @Default {null} - */ + * @Default {null} + */ backgroundImageUrl?: string; /** Specifies the frame InnerWidth - * @Default {8} - */ + * @Default {8} + */ innerWidth?: number; /** Specifies the frame OuterWidth - * @Default {12} - */ + * @Default {12} + */ outerWidth?: number; } export interface ScalesBarPointersBorder { /** Specifies the border Color of bar pointer - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Specifies the border Width of bar pointer - * @Default {1.5} - */ + * @Default {1.5} + */ width?: number; } export interface ScalesBarPointer { /** Specifies the backgroundColor of bar pointer - * @Default {null} - */ + * @Default {null} + */ backgroundColor?: string; /** Specifies the border of bar pointer - * @Default {null} - */ + * @Default {null} + */ border?: ScalesBarPointersBorder; /** Specifies the distanceFromScale of bar pointer - * @Default {0} - */ + * @Default {0} + */ distanceFromScale?: number; /** Specifies the scaleBar Gradient of bar pointer - * @Default {null} - */ + * @Default {null} + */ gradients?: any; /** Specifies the opacity of bar pointer - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Specifies the value of bar pointer - * @Default {null} - */ + * @Default {null} + */ value?: number; /** Specifies the pointer Width of bar pointer - * @Default {width=30} - */ + * @Default {width=30} + */ width?: number; } export interface ScalesBorder { /** Specifies the border color of the Scale. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Specifies the border width of the Scale. - * @Default {1.5} - */ + * @Default {1.5} + */ width?: number; } export interface ScalesCustomLabelsFont { /** Specifies the fontFamily in customLabels - * @Default {Arial} - */ + * @Default {Arial} + */ fontFamily?: string; /** Specifies the fontStyle in customLabels. See FontStyle - * @Default {Bold} - */ + * @Default {Bold} + */ fontStyle?: ej.datavisualization.LinearGauge.FontStyle|string; /** Specifies the font size in customLabels - * @Default {11px} - */ + * @Default {11px} + */ size?: string; } export interface ScalesCustomLabelsPosition { /** Specifies the position x in customLabels - * @Default {0} - */ + * @Default {0} + */ x?: number; /** Specifies the y in customLabels - * @Default {0} - */ + * @Default {0} + */ y?: number; } export interface ScalesCustomLabel { /** Specifies the label Color in customLabels - * @Default {null} - */ + * @Default {null} + */ color?: number; /** Specifies the font in customLabels - * @Default {null} - */ + * @Default {null} + */ font?: ScalesCustomLabelsFont; /** Specifies the opacity in customLabels - * @Default {0} - */ + * @Default {0} + */ opacity?: string; /** Specifies the position in customLabels - * @Default {null} - */ + * @Default {null} + */ position?: ScalesCustomLabelsPosition; /** Specifies the positionType in customLabels.See CustomLabelPositionType - * @Default {null} - */ + * @Default {null} + */ positionType?: any; /** Specifies the textAngle in customLabels - * @Default {0} - */ + * @Default {0} + */ textAngle?: number; /** Specifies the label Value in customLabels - */ + */ value?: string; } export interface ScalesIndicatorsBorder { /** Specifies the border Color in bar indicators - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Specifies the border Width in bar indicators - * @Default {1.5} - */ + * @Default {1.5} + */ width?: number; } export interface ScalesIndicatorsFont { /** Specifies the fontFamily of font in bar indicators - * @Default {Arial} - */ + * @Default {Arial} + */ fontFamily?: string; /** Specifies the fontStyle of font in bar indicators. See FontStyle - * @Default {ej.datavisualization.LinearGauge.FontStyle.Bold} - */ + * @Default {ej.datavisualization.LinearGauge.FontStyle.Bold} + */ fontStyle?: ej.datavisualization.LinearGauge.FontStyle|string; /** Specifies the size of font in bar indicators - * @Default {11px} - */ + * @Default {11px} + */ size?: string; } export interface ScalesIndicatorsPosition { /** Specifies the x position in bar indicators - * @Default {0} - */ + * @Default {0} + */ x?: number; /** Specifies the y position in bar indicators - * @Default {0} - */ + * @Default {0} + */ y?: number; } export interface ScalesIndicatorsStateRange { /** Specifies the backgroundColor in bar indicators state ranges - * @Default {null} - */ + * @Default {null} + */ backgroundColor?: string; /** Specifies the borderColor in bar indicators state ranges - * @Default {null} - */ + * @Default {null} + */ borderColor?: string; /** Specifies the endValue in bar indicators state ranges - * @Default {60} - */ + * @Default {60} + */ endValue?: number; /** Specifies the startValue in bar indicators state ranges - * @Default {50} - */ + * @Default {50} + */ startValue?: number; /** Specifies the text in bar indicators state ranges - */ + */ text?: string; /** Specifies the textColor in bar indicators state ranges - * @Default {null} - */ + * @Default {null} + */ textColor?: string; } export interface ScalesIndicatorsTextLocation { /** Specifies the textLocation position in bar indicators - * @Default {0} - */ + * @Default {0} + */ x?: number; /** Specifies the Y position in bar indicators - * @Default {0} - */ + * @Default {0} + */ y?: number; } export interface ScalesIndicator { /** Specifies the backgroundColor in bar indicators - * @Default {null} - */ + * @Default {null} + */ backgroundColor?: string; /** Specifies the border in bar indicators - * @Default {null} - */ + * @Default {null} + */ border?: ScalesIndicatorsBorder; /** Specifies the font of bar indicators - * @Default {null} - */ + * @Default {null} + */ font?: ScalesIndicatorsFont; /** Specifies the indicator Height of bar indicators - * @Default {30} - */ + * @Default {30} + */ height?: number; /** Specifies the opacity in bar indicators - * @Default {NaN} - */ + * @Default {NaN} + */ opacity?: number; /** Specifies the position in bar indicators - * @Default {null} - */ + * @Default {null} + */ position?: ScalesIndicatorsPosition; /** Specifies the state ranges in bar indicators - * @Default {Array} - */ + * @Default {Array} + */ stateRanges?: ScalesIndicatorsStateRange[]; /** Specifies the textLocation in bar indicators - * @Default {null} - */ + * @Default {null} + */ textLocation?: ScalesIndicatorsTextLocation; /** Specifies the indicator Style of font in bar indicators - * @Default {ej.datavisualization.LinearGauge.IndicatorType.Rectangle} - */ + * @Default {ej.datavisualization.LinearGauge.IndicatorType.Rectangle} + */ type?: ej.datavisualization.LinearGauge.IndicatorTypes|string; /** Specifies the indicator Width in bar indicators - * @Default {30} - */ + * @Default {30} + */ width?: number; } export interface ScalesLabelsDistanceFromScale { /** Specifies the xDistanceFromScale of labels. - * @Default {-10} - */ + * @Default {-10} + */ x?: number; /** Specifies the yDistanceFromScale of labels. - * @Default {0} - */ + * @Default {0} + */ y?: number; } export interface ScalesLabelsFont { /** Specifies the fontFamily of font. - * @Default {Arial} - */ + * @Default {Arial} + */ fontFamily?: string; /** Specifies the fontStyle of font.See FontStyle - * @Default {ej.datavisualization.LinearGauge.FontStyle.Bold} - */ + * @Default {ej.datavisualization.LinearGauge.FontStyle.Bold} + */ fontStyle?: ej.datavisualization.LinearGauge.FontStyle|string; /** Specifies the size of font. - * @Default {11px} - */ + * @Default {11px} + */ size?: string; } export interface ScalesLabel { /** Specifies the angle of labels. - * @Default {0} - */ + * @Default {0} + */ angle?: number; /** Specifies the DistanceFromScale of labels. - * @Default {null} - */ + * @Default {null} + */ distanceFromScale?: ScalesLabelsDistanceFromScale; /** Specifies the font of labels. - * @Default {null} - */ + * @Default {null} + */ font?: ScalesLabelsFont; /** need to includeFirstValue. - * @Default {true} - */ + * @Default {true} + */ includeFirstValue?: boolean; /** Specifies the opacity of label. - * @Default {0} - */ + * @Default {0} + */ opacity?: number; /** Specifies the label Placement of label. See LabelPlacement - * @Default {Near} - */ + * @Default {Near} + */ placement?: ej.datavisualization.LinearGauge.PointerPlacement|string; /** Specifies the textColor of font. - * @Default {null} - */ + * @Default {null} + */ textColor?: string; /** Specifies the label Style of label. See LabelType - * @Default {ej.datavisualization.LinearGauge.LabelType.Major} - */ + * @Default {ej.datavisualization.LinearGauge.LabelType.Major} + */ type?: ej.datavisualization.LinearGauge.ScaleType|string; /** Specifies the unitText of label. - */ + */ unitText?: string; /** Specifies the unitText Position of label.See UnitTextPlacement - * @Default {Back} - */ + * @Default {Back} + */ unitTextPlacement?: ej.datavisualization.LinearGauge.UnitTextPlacement|string; } export interface ScalesMarkerPointersBorder { /** Specifies the border color of marker pointer - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Specifies the border of marker pointer - * @Default {number} - */ + * @Default {number} + */ width?: number; } export interface ScalesMarkerPointer { /** Specifies the backgroundColor of marker pointer - * @Default {null} - */ + * @Default {null} + */ backgroundColor?: string; /** Specifies the border of marker pointer - * @Default {null} - */ + * @Default {null} + */ border?: ScalesMarkerPointersBorder; /** Specifies the distanceFromScale of marker pointer - * @Default {0} - */ + * @Default {0} + */ distanceFromScale?: number; /** Specifies the pointer Gradient of marker pointer - * @Default {null} - */ + * @Default {null} + */ gradients?: any; /** Specifies the pointer Length of marker pointer - * @Default {30} - */ + * @Default {30} + */ length?: number; /** Specifies the opacity of marker pointer - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Specifies the pointer Placement of marker pointer See PointerPlacement - * @Default {Far} - */ + * @Default {Far} + */ placement?: ej.datavisualization.LinearGauge.PointerPlacement|string; /** Specifies the marker Style of marker pointerSee MarkerType - * @Default {Triangle} - */ + * @Default {Triangle} + */ type?: ej.datavisualization.LinearGauge.MarkerType|string; /** Specifies the value of marker pointer - * @Default {null} - */ + * @Default {null} + */ value?: number; /** Specifies the pointer Width of marker pointer - * @Default {30} - */ + * @Default {30} + */ width?: number; } export interface ScalesPosition { /** Specifies the Horizontal position - * @Default {50} - */ + * @Default {50} + */ x?: number; /** Specifies the vertical position - * @Default {50} - */ + * @Default {50} + */ y?: number; } export interface ScalesRangesBorder { /** Specifies the border color in the ranges. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Specifies the border width in the ranges. - * @Default {1.5} - */ + * @Default {1.5} + */ width?: number; } export interface ScalesRange { /** Specifies the backgroundColor in the ranges. - * @Default {null} - */ + * @Default {null} + */ backgroundColor?: string; /** Specifies the border in the ranges. - * @Default {null} - */ + * @Default {null} + */ border?: ScalesRangesBorder; /** Specifies the distanceFromScale in the ranges. - * @Default {0} - */ + * @Default {0} + */ distanceFromScale?: number; /** Specifies the endValue in the ranges. - * @Default {60} - */ + * @Default {60} + */ endValue?: number; /** Specifies the endWidth in the ranges. - * @Default {10} - */ + * @Default {10} + */ endWidth?: number; /** Specifies the range Gradient in the ranges. - * @Default {null} - */ + * @Default {null} + */ gradients?: any; /** Specifies the opacity in the ranges. - * @Default {null} - */ + * @Default {null} + */ opacity?: number; /** Specifies the range Position in the ranges. See RangePlacement - * @Default {Center} - */ + * @Default {Center} + */ placement?: ej.datavisualization.LinearGauge.PointerPlacement|string; /** Specifies the startValue in the ranges. - * @Default {20} - */ + * @Default {20} + */ startValue?: number; /** Specifies the startWidth in the ranges. - * @Default {10} - */ + * @Default {10} + */ startWidth?: number; } export interface ScalesTicksDistanceFromScale { /** Specifies the xDistanceFromScale in the tick. - * @Default {0} - */ + * @Default {0} + */ x?: number; /** Specifies the yDistanceFromScale in the tick. - * @Default {0} - */ + * @Default {0} + */ y?: number; } export interface ScalesTick { /** Specifies the angle in the tick. - * @Default {0} - */ + * @Default {0} + */ angle?: number; /** Specifies the tick Color in the tick. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Specifies the DistanceFromScale in the tick. - * @Default {null} - */ + * @Default {null} + */ distanceFromScale?: ScalesTicksDistanceFromScale; /** Specifies the tick Height in the tick. - * @Default {10} - */ + * @Default {10} + */ height?: number; /** Specifies the opacity in the tick. - * @Default {0} - */ + * @Default {0} + */ opacity?: number; /** Specifies the tick Placement in the tick. See TickPlacement - * @Default {Near} - */ + * @Default {Near} + */ placement?: ej.datavisualization.LinearGauge.PointerPlacement|string; /** Specifies the tick Style in the tick. See TickType - * @Default {MajorInterval} - */ + * @Default {MajorInterval} + */ type?: ej.datavisualization.LinearGauge.TicksType|string; /** Specifies the tick Width in the tick. - * @Default {3} - */ + * @Default {3} + */ width?: number; } export interface Scale { /** Specifies the backgroundColor of the Scale. - * @Default {null} - */ + * @Default {null} + */ backgroundColor?: string; /** Specifies the scaleBar Gradient of bar pointer - * @Default {Array} - */ + * @Default {Array} + */ barPointers?: ScalesBarPointer[]; /** Specifies the border of the Scale. - * @Default {null} - */ + * @Default {null} + */ border?: ScalesBorder; /** Specifies the customLabel - * @Default {Array} - */ + * @Default {Array} + */ customLabels?: ScalesCustomLabel[]; /** Specifies the scale Direction of the Scale. See Directions - * @Default {CounterClockwise} - */ + * @Default {CounterClockwise} + */ direction?: ej.datavisualization.LinearGauge.Direction|string; /** Specifies the indicator - * @Default {Array} - */ + * @Default {Array} + */ indicators?: ScalesIndicator[]; /** Specifies the labels. - * @Default {Array} - */ + * @Default {Array} + */ labels?: ScalesLabel[]; /** Specifies the scaleBar Length. - * @Default {290} - */ + * @Default {290} + */ length?: number; /** Specifies the majorIntervalValue of the Scale. - * @Default {10} - */ + * @Default {10} + */ majorIntervalValue?: number; /** Specifies the markerPointers - * @Default {Array} - */ + * @Default {Array} + */ markerPointers?: ScalesMarkerPointer[]; /** Specifies the maximum of the Scale. - * @Default {null} - */ + * @Default {null} + */ maximum?: number; /** Specifies the minimum of the Scale. - * @Default {null} - */ + * @Default {null} + */ minimum?: number; /** Specifies the minorIntervalValue of the Scale. - * @Default {2} - */ + * @Default {2} + */ minorIntervalValue?: number; /** Specifies the opacity of the Scale. - * @Default {NaN} - */ + * @Default {NaN} + */ opacity?: number; /** Specifies the position - * @Default {null} - */ + * @Default {null} + */ position?: ScalesPosition; /** Specifies the ranges in the tick. - * @Default {Array} - */ + * @Default {Array} + */ ranges?: ScalesRange[]; /** Specifies the shadowOffset. - * @Default {0} - */ + * @Default {0} + */ shadowOffset?: number; /** Specifies the showBarPointers state. - * @Default {true} - */ + * @Default {true} + */ showBarPointers?: boolean; /** Specifies the showCustomLabels state. - * @Default {false} - */ + * @Default {false} + */ showCustomLabels?: boolean; /** Specifies the showIndicators state. - * @Default {false} - */ + * @Default {false} + */ showIndicators?: boolean; /** Specifies the showLabels state. - * @Default {true} - */ + * @Default {true} + */ showLabels?: boolean; /** Specifies the showMarkerPointers state. - * @Default {true} - */ + * @Default {true} + */ showMarkerPointers?: boolean; /** Specifies the showRanges state. - * @Default {false} - */ + * @Default {false} + */ showRanges?: boolean; /** Specifies the showTicks state. - * @Default {true} - */ + * @Default {true} + */ showTicks?: boolean; /** Specifies the ticks in the scale. - * @Default {Array} - */ + * @Default {Array} + */ ticks?: ScalesTick[]; /** Specifies the scaleBar type .See ScaleType - * @Default {Rectangle} - */ + * @Default {Rectangle} + */ type?: ej.datavisualization.LinearGauge.ScaleType|string; /** Specifies the scaleBar width. - * @Default {30} - */ + * @Default {30} + */ width?: number; } export interface Tooltip { /** Specify showCustomLabelTooltip value of linear gauge - * @Default {false} - */ + * @Default {false} + */ showCustomLabelTooltip?: boolean; /** Specify showLabelTooltip value of linear gauge - * @Default {false} - */ + * @Default {false} + */ showLabelTooltip?: boolean; /** Specify templateID value of linear gauge - * @Default {false} - */ + * @Default {false} + */ templateID?: string; } } @@ -44813,423 +44813,423 @@ class CircularGauge extends ej.Widget { defaults: CircularGauge.Model; /** destroy the circular gauge widget. all events bound using this._on will be unbind automatically and bring the control to pre-init state. - * @returns {void} - */ + * @returns {void} + */ destroy(): void; /** To export Image - * @returns {boolean} - */ + * @returns {boolean} + */ exportImage(): boolean; /** To get BackNeedleLength - * @returns {any} - */ + * @returns {any} + */ getBackNeedleLength(): any; /** To get CustomLabelAngle - * @returns {any} - */ + * @returns {any} + */ getCustomLabelAngle(): any; /** To get CustomLabelValue - * @returns {any} - */ + * @returns {any} + */ getCustomLabelValue(): any; /** To get LabelAngle - * @returns {any} - */ + * @returns {any} + */ getLabelAngle(): any; /** To get LabelDistanceFromScale - * @returns {any} - */ + * @returns {any} + */ getLabelDistanceFromScale(): any; /** To get LabelPlacement - * @returns {any} - */ + * @returns {any} + */ getLabelPlacement(): any; /** To get LabelStyle - * @returns {any} - */ + * @returns {any} + */ getLabelStyle(): any; /** To get MajorIntervalValue - * @returns {any} - */ + * @returns {any} + */ getMajorIntervalValue(): any; /** To get MarkerDistanceFromScale - * @returns {any} - */ + * @returns {any} + */ getMarkerDistanceFromScale(): any; /** To get MarkerStyle - * @returns {any} - */ + * @returns {any} + */ getMarkerStyle(): any; /** To get MaximumValue - * @returns {any} - */ + * @returns {any} + */ getMaximumValue(): any; /** To get MinimumValue - * @returns {any} - */ + * @returns {any} + */ getMinimumValue(): any; /** To get MinorIntervalValue - * @returns {any} - */ + * @returns {any} + */ getMinorIntervalValue(): any; /** To get NeedleStyle - * @returns {any} - */ + * @returns {any} + */ getNeedleStyle(): any; /** To get PointerCapBorderWidth - * @returns {any} - */ + * @returns {any} + */ getPointerCapBorderWidth(): any; /** To get PointerCapRadius - * @returns {any} - */ + * @returns {any} + */ getPointerCapRadius(): any; /** To get PointerLength - * @returns {any} - */ + * @returns {any} + */ getPointerLength(): any; /** To get PointerNeedleType - * @returns {any} - */ + * @returns {any} + */ getPointerNeedleType(): any; /** To get PointerPlacement - * @returns {any} - */ + * @returns {any} + */ getPointerPlacement(): any; /** To get PointerValue - * @returns {any} - */ + * @returns {any} + */ getPointerValue(): any; /** To get PointerWidth - * @returns {any} - */ + * @returns {any} + */ getPointerWidth(): any; /** To get RangeBorderWidth - * @returns {any} - */ + * @returns {any} + */ getRangeBorderWidth(): any; /** To get RangeDistanceFromScale - * @returns {any} - */ + * @returns {any} + */ getRangeDistanceFromScale(): any; /** To get RangeEndValue - * @returns {any} - */ + * @returns {any} + */ getRangeEndValue(): any; /** To get RangePosition - * @returns {any} - */ + * @returns {any} + */ getRangePosition(): any; /** To get RangeSize - * @returns {any} - */ + * @returns {any} + */ getRangeSize(): any; /** To get RangeStartValue - * @returns {any} - */ + * @returns {any} + */ getRangeStartValue(): any; /** To get ScaleBarSize - * @returns {any} - */ + * @returns {any} + */ getScaleBarSize(): any; /** To get ScaleBorderWidth - * @returns {any} - */ + * @returns {any} + */ getScaleBorderWidth(): any; /** To get ScaleDirection - * @returns {any} - */ + * @returns {any} + */ getScaleDirection(): any; /** To get ScaleRadius - * @returns {any} - */ + * @returns {any} + */ getScaleRadius(): any; /** To get StartAngle - * @returns {any} - */ + * @returns {any} + */ getStartAngle(): any; /** To get SubGaugeLocation - * @returns {any} - */ + * @returns {any} + */ getSubGaugeLocation(): any; /** To get SweepAngle - * @returns {any} - */ + * @returns {any} + */ getSweepAngle(): any; /** To get TickAngle - * @returns {any} - */ + * @returns {any} + */ getTickAngle(): any; /** To get TickDistanceFromScale - * @returns {any} - */ + * @returns {any} + */ getTickDistanceFromScale(): any; /** To get TickHeight - * @returns {any} - */ + * @returns {any} + */ getTickHeight(): any; /** To get TickPlacement - * @returns {any} - */ + * @returns {any} + */ getTickPlacement(): any; /** To get TickStyle - * @returns {any} - */ + * @returns {any} + */ getTickStyle(): any; /** To get TickWidth - * @returns {any} - */ + * @returns {any} + */ getTickWidth(): any; /** To set includeFirstValue - * @returns {void} - */ + * @returns {void} + */ includeFirstValue(): void; /** Switching the redraw option for the gauge - * @returns {void} - */ + * @returns {void} + */ redraw(): void; /** To set BackNeedleLength - * @returns {void} - */ + * @returns {void} + */ setBackNeedleLength(): void; /** To set CustomLabelAngle - * @returns {void} - */ + * @returns {void} + */ setCustomLabelAngle(): void; /** To set CustomLabelValue - * @returns {void} - */ + * @returns {void} + */ setCustomLabelValue(): void; /** To set LabelAngle - * @returns {void} - */ + * @returns {void} + */ setLabelAngle(): void; /** To set LabelDistanceFromScale - * @returns {void} - */ + * @returns {void} + */ setLabelDistanceFromScale(): void; /** To set LabelPlacement - * @returns {void} - */ + * @returns {void} + */ setLabelPlacement(): void; /** To set LabelStyle - * @returns {void} - */ + * @returns {void} + */ setLabelStyle(): void; /** To set MajorIntervalValue - * @returns {void} - */ + * @returns {void} + */ setMajorIntervalValue(): void; /** To set MarkerDistanceFromScale - * @returns {void} - */ + * @returns {void} + */ setMarkerDistanceFromScale(): void; /** To set MarkerStyle - * @returns {void} - */ + * @returns {void} + */ setMarkerStyle(): void; /** To set MaximumValue - * @returns {void} - */ + * @returns {void} + */ setMaximumValue(): void; /** To set MinimumValue - * @returns {void} - */ + * @returns {void} + */ setMinimumValue(): void; /** To set MinorIntervalValue - * @returns {void} - */ + * @returns {void} + */ setMinorIntervalValue(): void; /** To set NeedleStyle - * @returns {void} - */ + * @returns {void} + */ setNeedleStyle(): void; /** To set PointerCapBorderWidth - * @returns {void} - */ + * @returns {void} + */ setPointerCapBorderWidth(): void; /** To set PointerCapRadius - * @returns {void} - */ + * @returns {void} + */ setPointerCapRadius(): void; /** To set PointerLength - * @returns {void} - */ + * @returns {void} + */ setPointerLength(): void; /** To set PointerNeedleType - * @returns {void} - */ + * @returns {void} + */ setPointerNeedleType(): void; /** To set PointerPlacement - * @returns {void} - */ + * @returns {void} + */ setPointerPlacement(): void; /** To set PointerValue - * @returns {void} - */ + * @returns {void} + */ setPointerValue(): void; /** To set PointerWidth - * @returns {void} - */ + * @returns {void} + */ setPointerWidth(): void; /** To set RangeBorderWidth - * @returns {void} - */ + * @returns {void} + */ setRangeBorderWidth(): void; /** To set RangeDistanceFromScale - * @returns {void} - */ + * @returns {void} + */ setRangeDistanceFromScale(): void; /** To set RangeEndValue - * @returns {void} - */ + * @returns {void} + */ setRangeEndValue(): void; /** To set RangePosition - * @returns {void} - */ + * @returns {void} + */ setRangePosition(): void; /** To set RangeSize - * @returns {void} - */ + * @returns {void} + */ setRangeSize(): void; /** To set RangeStartValue - * @returns {void} - */ + * @returns {void} + */ setRangeStartValue(): void; /** To set ScaleBarSize - * @returns {void} - */ + * @returns {void} + */ setScaleBarSize(): void; /** To set ScaleBorderWidth - * @returns {void} - */ + * @returns {void} + */ setScaleBorderWidth(): void; /** To set ScaleDirection - * @returns {void} - */ + * @returns {void} + */ setScaleDirection(): void; /** To set ScaleRadius - * @returns {void} - */ + * @returns {void} + */ setScaleRadius(): void; /** To set StartAngle - * @returns {void} - */ + * @returns {void} + */ setStartAngle(): void; /** To set SubGaugeLocation - * @returns {void} - */ + * @returns {void} + */ setSubGaugeLocation(): void; /** To set SweepAngle - * @returns {void} - */ + * @returns {void} + */ setSweepAngle(): void; /** To set TickAngle - * @returns {void} - */ + * @returns {void} + */ setTickAngle(): void; /** To set TickDistanceFromScale - * @returns {void} - */ + * @returns {void} + */ setTickDistanceFromScale(): void; /** To set TickHeight - * @returns {void} - */ + * @returns {void} + */ setTickHeight(): void; /** To set TickPlacement - * @returns {void} - */ + * @returns {void} + */ setTickPlacement(): void; /** To set TickStyle - * @returns {void} - */ + * @returns {void} + */ setTickStyle(): void; /** To set TickWidth - * @returns {void} - */ + * @returns {void} + */ setTickWidth(): void; } export namespace CircularGauge { @@ -45237,103 +45237,103 @@ export namespace CircularGauge { export interface Model { /** Specifies animationSpeed of circular gauge - * @Default {500} - */ + * @Default {500} + */ animationSpeed?: number; /** Specifies the background color of circular gauge. - * @Default {null} - */ + * @Default {null} + */ backgroundColor?: string; /** Specify distanceFromCorner value of circular gauge - * @Default {center} - */ + * @Default {center} + */ distanceFromCorner?: number; /** Specify animate value of circular gauge - * @Default {true} - */ + * @Default {true} + */ enableAnimation?: boolean; /** Specify the frame of circular gauge - * @Default {Object} - */ + * @Default {Object} + */ frame?: Frame; /** Specify gaugePosition value of circular gauge See GaugePosition - * @Default {center} - */ + * @Default {center} + */ gaugePosition?: ej.datavisualization.CircularGauge.gaugePosition|string; /** Specifies the height of circular gauge. - * @Default {360} - */ + * @Default {360} + */ height?: number; /** Specifies the interiorGradient of circular gauge. - * @Default {null} - */ + * @Default {null} + */ interiorGradient?: any; /** Specify isRadialGradient value of circular gauge - * @Default {false} - */ + * @Default {false} + */ isRadialGradient?: boolean; /** Specify isResponsive value of circular gauge - * @Default {false} - */ + * @Default {false} + */ isResponsive?: boolean; /** Specifies the maximum value of circular gauge. - * @Default {100} - */ + * @Default {100} + */ maximum?: number; /** Specifies the minimum value of circular gauge. - * @Default {0} - */ + * @Default {0} + */ minimum?: number; /** Specify outerCustomLabelPosition value of circular gauge See OuterCustomLabelPosition - * @Default {bottom} - */ + * @Default {bottom} + */ outerCustomLabelPosition?: ej.datavisualization.CircularGauge.CustomLabelPositionType|string; /** Specifies the radius of circular gauge. - * @Default {180} - */ + * @Default {180} + */ radius?: number; /** Specify readonly value of circular gauge - * @Default {true} - */ + * @Default {true} + */ readOnly?: boolean; /** Specify the pointers, ticks, labels, indicators, ranges of circular gauge - * @Default {null} - */ + * @Default {null} + */ scales?: Scale[]; /** Specify the theme of circular gauge. - * @Default {flatlight} - */ + * @Default {flatlight} + */ theme?: string; /** Specify tooltip option of circular gauge - * @Default {object} - */ + * @Default {object} + */ tooltip?: Tooltip; /** Specifies the value of circular gauge. - * @Default {0} - */ + * @Default {0} + */ value?: number; /** Specifies the width of circular gauge. - * @Default {360} - */ + * @Default {360} + */ width?: number; /** Triggers while the custom labels are being drawn on the gauge. */ @@ -45376,1287 +45376,1287 @@ export interface Model { export interface DrawCustomLabelEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the context element - */ + */ context?: any; /** returns the startX and startY of the custom label - */ + */ position?: any; /** returns the gauge model - */ + */ model?: any; /** returns the options of the scale element. - */ + */ scaleElement?: any; /** returns the scaleIndex to which the custom label belongs. - */ + */ scaleIndex?: number; /** returns the custom label style - */ + */ style?: string; /** returns the current custom label element. - */ + */ customLabelElement?: any; /** returns the index of the custom label. - */ + */ customLabelIndex?: number; /** returns the name of the event - */ + */ type?: string; } export interface DrawIndicatorsEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the context element - */ + */ context?: any; /** returns the startX and startY of the indicator - */ + */ position?: any; /** returns the gauge model - */ + */ model?: any; /** returns the options of the scale element. - */ + */ scaleElement?: any; /** returns the scaleIndex to which the indicator belongs. - */ + */ scaleIndex?: number; /** returns the indicator style - */ + */ style?: string; /** returns the current indicator element. - */ + */ indicatorElement?: any; /** returns the index of the indicator. - */ + */ indicatorIndex?: number; /** returns the name of the event - */ + */ type?: string; } export interface DrawLabelsEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the context element - */ + */ context?: any; /** returns the startX and startY of the labels - */ + */ position?: any; /** returns the gauge model - */ + */ model?: any; /** returns the options of the scale element. - */ + */ scaleElement?: any; /** returns the scaleIndex to which the label belongs. - */ + */ scaleIndex?: number; /** returns the label style - */ + */ style?: string; /** returns the angle of the labels. - */ + */ angle?: number; /** returns the current label element. - */ + */ element?: any; /** returns the index of the label. - */ + */ index?: number; /** returns the value of the label. - */ + */ pointerValue?: number; /** returns the name of the event - */ + */ type?: string; } export interface DrawPointerCapEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the context element - */ + */ context?: any; /** returns the options of the scale element. - */ + */ scaleElement?: any; /** returns the startX and startY of the pointer cap. - */ + */ position?: any; /** returns the gauge model - */ + */ model?: any; /** returns the pointer cap style - */ + */ style?: string; /** returns the name of the event - */ + */ type?: string; } export interface DrawPointersEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the context element - */ + */ context?: any; /** returns the startX and startY of the pointer - */ + */ position?: any; /** returns the gauge model - */ + */ model?: any; /** returns the options of the scale element. - */ + */ scaleElement?: any; /** returns the scaleIndex to which the pointer belongs. - */ + */ scaleIndex?: number; /** returns the pointer style - */ + */ style?: string; /** returns the angle of the pointer. - */ + */ angle?: number; /** returns the current pointer element. - */ + */ element?: any; /** returns the index of the pointer. - */ + */ index?: number; /** returns the value of the pointer. - */ + */ value?: number; /** returns the name of the event - */ + */ type?: string; } export interface DrawRangeEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the context element - */ + */ context?: any; /** returns the startX and startY of the range - */ + */ position?: any; /** returns the gauge model - */ + */ model?: any; /** returns the options of the scale element. - */ + */ scaleElement?: any; /** returns the scaleIndex to which the range belongs. - */ + */ scaleIndex?: number; /** returns the range style - */ + */ style?: string; /** returns the current range element. - */ + */ rangeElement?: any; /** returns the index of the range. - */ + */ rangeIndex?: number; /** returns the name of the event - */ + */ type?: string; } export interface DrawTicksEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the context element - */ + */ context?: any; /** returns the startX and startY of the ticks - */ + */ position?: any; /** returns the gauge model - */ + */ model?: any; /** returns the options of the scale element. - */ + */ scaleElement?: any; /** returns the scaleIndex to which the tick belongs. - */ + */ scaleIndex?: number; /** returns the ticks style - */ + */ style?: string; /** returns the angle of the tick. - */ + */ angle?: number; /** returns the current tick element. - */ + */ element?: any; /** returns the index of the tick. - */ + */ index?: number; /** returns the label value of the tick. - */ + */ pointerValue?: number; /** returns the name of the event - */ + */ type?: string; } export interface LoadEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the gauge model - */ + */ Model?: any; /** returns the entire scale element. - */ + */ scaleElement?: any; /** returns the context element - */ + */ context?: any; /** returns the name of the event - */ + */ type?: string; } export interface MouseClickEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the gauge model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: any; /** returns the scale element. - */ + */ scaleElement?: any; /** returns the scaleIndex to which the pointer belongs. - */ + */ scaleIndex?: number; /** returns the context element - */ + */ context?: any; /** returns the pointer Index - */ + */ index?: number; /** returns the pointer element. - */ + */ element?: any; /** returns the value of the pointer. - */ + */ value?: number; /** returns the angle of the pointer. - */ + */ angle?: number; /** returns the pointer style - */ + */ style?: string; /** returns the startX and startY of the pointer. - */ + */ position?: any; } export interface MouseClickMoveEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the gauge model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: any; /** returns the scale element. - */ + */ scaleElement?: any; /** returns the scaleIndex to which the pointer belongs. - */ + */ scaleIndex?: number; /** returns the context element - */ + */ context?: any; /** returns the pointer Index - */ + */ index?: number; /** returns the pointer element. - */ + */ element?: any; /** returns the value of the pointer. - */ + */ value?: number; /** returns the angle of the pointer. - */ + */ angle?: number; /** returns the pointer style - */ + */ style?: string; /** returns the startX and startY of the pointer. - */ + */ position?: any; } export interface MouseClickUpEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the gauge model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: any; /** returns the scale element. - */ + */ scaleElement?: any; /** returns the scaleIndex to which the pointer belongs. - */ + */ scaleIndex?: number; /** returns the context element - */ + */ context?: any; /** returns the pointer Index - */ + */ index?: number; /** returns the pointer element. - */ + */ element?: any; /** returns the value of the pointer. - */ + */ value?: number; /** returns the angle of the pointer. - */ + */ angle?: number; /** returns the pointer style - */ + */ style?: string; /** returns the startX and startY of the pointer. - */ + */ position?: any; } export interface RenderCompleteEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the context element - */ + */ context?: any; /** returns the entire scale element. - */ + */ scaleElement?: any; /** returns the gauge model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface Frame { /** Specify the URL of the frame background image for circular gauge - * @Default {null} - */ + * @Default {null} + */ backgroundImageUrl?: string; /** Specifies the frameType of circular gauge. See Frame - * @Default {FullCircle} - */ + * @Default {FullCircle} + */ frameType?: ej.datavisualization.CircularGauge.FrameType|string; /** Specifies the end angle for the half circular frame. - * @Default {360} - */ + * @Default {360} + */ halfCircleFrameEndAngle?: number; /** Specifies the start angle for the half circular frame. - * @Default {180} - */ + * @Default {180} + */ halfCircleFrameStartAngle?: number; } export interface ScalesBorder { /** Specify border color for scales of circular gauge - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Specify border width of circular gauge - * @Default {1.5} - */ + * @Default {1.5} + */ width?: number; } export interface ScalesCustomLabelsPosition { /** Specify x-axis position of label - * @Default {0} - */ + * @Default {0} + */ x?: number; /** Specify y-axis position of labels. - * @Default {0} - */ + * @Default {0} + */ y?: number; } export interface ScalesCustomLabelsFont { /** Specify font fontFamily for custom labels. - * @Default {Arial} - */ + * @Default {Arial} + */ fontFamily?: string; /** Specify font Style for custom labels. - * @Default {Bold} - */ + * @Default {Bold} + */ fontStyle?: string; /** Specify font size for custom labels. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface ScalesCustomLabel { /** Value of the custom labels. - */ + */ value?: string; /** Color of the custom labels. - */ + */ color?: string; /** Specify position of custom labels - * @Default {Object} - */ + * @Default {Object} + */ position?: ScalesCustomLabelsPosition; /** Specify font for custom labels - * @Default {Object} - */ + * @Default {Object} + */ font?: ScalesCustomLabelsFont; } export interface ScalesIndicatorsPosition { /** Specify x-axis of position of circular gauge - * @Default {0} - */ + * @Default {0} + */ x?: number; /** Specify y-axis of position of circular gauge - * @Default {0} - */ + * @Default {0} + */ y?: number; } export interface ScalesIndicatorsStateRange { /** Specify backgroundColor for indicator of circular gauge - * @Default {null} - */ + * @Default {null} + */ backgroundColor?: string; /** Specify borderColor for indicator of circular gauge - * @Default {null} - */ + * @Default {null} + */ borderColor?: string; /** Specify end value for each specified state of circular gauge - * @Default {0} - */ + * @Default {0} + */ endValue?: number; /** Specify value of the font as the indicator when the indicator style is set with the value "text" of circular gauge - * @Default {null} - */ + * @Default {null} + */ font?: any; /** Specify start value for each specified state of circular gauge - * @Default {0} - */ + * @Default {0} + */ startValue?: number; /** Specify value of the text as the indicator when the indicator style is set with the value "text" of circular gauge - */ + */ text?: string; /** Specify value of the textColor as the indicator when the indicator style is set with the value "text" of circular gauge - * @Default {null} - */ + * @Default {null} + */ textColor?: string; } export interface ScalesIndicator { /** Specify indicator height of circular gauge - * @Default {15} - */ + * @Default {15} + */ height?: number; /** Specify imageUrl of circular gauge - * @Default {null} - */ + * @Default {null} + */ imageUrl?: string; /** Specify position of circular gauge - * @Default {Object} - */ + * @Default {Object} + */ position?: ScalesIndicatorsPosition; /** Specify the various states of circular gauge - * @Default {Array} - */ + * @Default {Array} + */ stateRanges?: ScalesIndicatorsStateRange[]; /** Specify indicator style of circular gauge. See IndicatorType - * @Default {Circle} - */ + * @Default {Circle} + */ type?: ej.datavisualization.CircularGauge.IndicatorTypes|string; /** Specify indicator width of circular gauge - * @Default {15} - */ + * @Default {15} + */ width?: number; } export interface ScalesLabelsFont { /** Specify font fontFamily for labels of circular gauge - * @Default {Arial} - */ + * @Default {Arial} + */ fontFamily?: string; /** Specify font Style for labels of circular gauge - * @Default {Bold} - */ + * @Default {Bold} + */ fontStyle?: string; /** Specify font size for labels of circular gauge - * @Default {11px} - */ + * @Default {11px} + */ size?: string; } export interface ScalesLabel { /** Specify the angle for the labels of circular gauge - * @Default {0} - */ + * @Default {0} + */ angle?: number; /** Specify labels autoAngle value of circular gauge - * @Default {false} - */ + * @Default {false} + */ autoAngle?: boolean; /** Specify label color of circular gauge - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Specify distanceFromScale value for labels of circular gauge - * @Default {0} - */ + * @Default {0} + */ distanceFromScale?: number; /** Specify font for labels of circular gauge - * @Default {Object} - */ + * @Default {Object} + */ font?: ScalesLabelsFont; /** Specify includeFirstValue of circular gauge - * @Default {true} - */ + * @Default {true} + */ includeFirstValue?: boolean; /** Specify opacity value for labels of circular gauge - * @Default {null} - */ + * @Default {null} + */ opacity?: number; /** Specify label placement of circular gauge. See LabelPlacement - * @Default {Near} - */ + * @Default {Near} + */ placement?: ej.datavisualization.CircularGauge.Placement|string; /** Specify label Style of circular gauge. See LabelType - * @Default {Major} - */ + * @Default {Major} + */ type?: ej.datavisualization.CircularGauge.LabelType|string; /** Specify unitText of circular gauge - */ + */ unitText?: string; /** Specify unitTextPosition of circular gauge. See UnitTextPosition - * @Default {Back} - */ + * @Default {Back} + */ unitTextPosition?: ej.datavisualization.CircularGauge.UnitTextPlacement|string; } export interface ScalesPointerCap { /** Specify cap backgroundColor of circular gauge - * @Default {null} - */ + * @Default {null} + */ backgroundColor?: string; /** Specify cap borderColor of circular gauge - * @Default {null} - */ + * @Default {null} + */ borderColor?: string; /** Specify pointerCap borderWidth value of circular gauge - * @Default {3} - */ + * @Default {3} + */ borderWidth?: number; /** Specify cap interiorGradient value of circular gauge - * @Default {null} - */ + * @Default {null} + */ interiorGradient?: any; /** Specify pointerCap Radius value of circular gauge - * @Default {7} - */ + * @Default {7} + */ radius?: number; } export interface ScalesPointersBorder { /** Specify border color for pointer of circular gauge - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Specify border width for pointers of circular gauge - * @Default {1.5} - */ + * @Default {1.5} + */ width?: number; } export interface ScalesPointersPointerValueTextFont { /** Specify pointer value text font family of circular gauge. - * @Default {Arial} - */ + * @Default {Arial} + */ fontFamily?: string; /** Specify pointer value text font style of circular gauge. - * @Default {Bold} - */ + * @Default {Bold} + */ fontStyle?: string; /** Specify pointer value text size of circular gauge. - * @Default {11px} - */ + * @Default {11px} + */ size?: string; } export interface ScalesPointersPointerValueText { /** Specify pointer text angle of circular gauge. - * @Default {0} - */ + * @Default {0} + */ angle?: number; /** Specify pointer text auto angle of circular gauge. - * @Default {false} - */ + * @Default {false} + */ autoAngle?: boolean; /** Specify pointer value text color of circular gauge. - * @Default {#8c8c8c} - */ + * @Default {#8c8c8c} + */ color?: string; /** Specify pointer value text distance from pointer of circular gauge. - * @Default {20} - */ + * @Default {20} + */ distance?: number; /** Specify pointer value text font option of circular gauge. - * @Default {object} - */ + * @Default {object} + */ font?: ScalesPointersPointerValueTextFont; /** Specify pointer value text opacity of circular gauge. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** enable pointer value text visibility of circular gauge. - * @Default {false} - */ + * @Default {false} + */ showValue?: boolean; } export interface ScalesPointer { /** Specify backgroundColor for the pointer of circular gauge - * @Default {null} - */ + * @Default {null} + */ backgroundColor?: string; /** Specify backNeedleLength of circular gauge - * @Default {10} - */ + * @Default {10} + */ backNeedleLength?: number; /** Specify the border for pointers of circular gauge - * @Default {Object} - */ + * @Default {Object} + */ border?: ScalesPointersBorder; /** Specify distanceFromScale value for pointers of circular gauge - * @Default {0} - */ + * @Default {0} + */ distanceFromScale?: number; /** Specify pointer gradients of circular gauge - * @Default {null} - */ + * @Default {null} + */ gradients?: any; /** Specify pointer image of circular gauge.It is applicable for both marker as well as needle type pointers. - * @Default {NULL} - */ + * @Default {NULL} + */ imageUrl?: string; /** Specify pointer length of circular gauge - * @Default {150} - */ + * @Default {150} + */ length?: number; /** Specify marker Style value of circular gauge. See MarkerType - * @Default {Rectangle} - */ + * @Default {Rectangle} + */ markerType?: ej.datavisualization.CircularGauge.MarkerType|string; /** Specify needle Style value of circular gauge. See NeedleType - * @Default {Triangle} - */ + * @Default {Triangle} + */ needleType?: ej.datavisualization.CircularGauge.NeedleType|string; /** Specify opacity value for pointer of circular gauge - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Specify radius value for pointer of circular gauge - * @Default {null} - */ + * @Default {null} + */ radius?: number; /** Specify pointer Placement value of circular gauge. See PointerPlacement - * @Default {Near} - */ + * @Default {Near} + */ placement?: ej.datavisualization.CircularGauge.Placement|string; /** Specify pointer value text of circular gauge. - * @Default {Object} - */ + * @Default {Object} + */ pointerValueText?: ScalesPointersPointerValueText; /** Specify showBackNeedle value of circular gauge - * @Default {false} - */ + * @Default {false} + */ showBackNeedle?: boolean; /** Specify pointer type value of circular gauge. See PointerType - * @Default {Needle} - */ + * @Default {Needle} + */ type?: ej.datavisualization.CircularGauge.PointerType|string; /** Specify value of the pointer of circular gauge - * @Default {null} - */ + * @Default {null} + */ value?: number; /** Specify pointer width of circular gauge - * @Default {7} - */ + * @Default {7} + */ width?: number; } export interface ScalesRangesBorder { /** Specify border color for ranges of circular gauge - * @Default {#32b3c6} - */ + * @Default {#32b3c6} + */ color?: string; /** Specify border width for ranges of circular gauge - * @Default {1.5} - */ + * @Default {1.5} + */ width?: number; } export interface ScalesRange { /** Specify backgroundColor for the ranges of circular gauge - * @Default {#32b3c6} - */ + * @Default {#32b3c6} + */ backgroundColor?: string; /** Specify border for ranges of circular gauge - * @Default {Object} - */ + * @Default {Object} + */ border?: ScalesRangesBorder; /** Specify distanceFromScale value for ranges of circular gauge - * @Default {25} - */ + * @Default {25} + */ distanceFromScale?: number; /** Specify endValue for ranges of circular gauge - * @Default {null} - */ + * @Default {null} + */ endValue?: number; /** Specify endWidth for ranges of circular gauge - * @Default {10} - */ + * @Default {10} + */ endWidth?: number; /** Specify range gradients of circular gauge - * @Default {null} - */ + * @Default {null} + */ gradients?: any; /** Specify opacity value for ranges of circular gauge - * @Default {null} - */ + * @Default {null} + */ opacity?: number; /** Specify placement of circular gauge. See RangePlacement - * @Default {Near} - */ + * @Default {Near} + */ placement?: ej.datavisualization.CircularGauge.Placement|string; /** Specify size of the range value of circular gauge - * @Default {5} - */ + * @Default {5} + */ size?: number; /** Specify startValue for ranges of circular gauge - * @Default {null} - */ + * @Default {null} + */ startValue?: number; /** Specify startWidth of circular gauge - * @Default {[Array.number] scale.ranges.startWidth = 10} - */ + * @Default {[Array.number] scale.ranges.startWidth = 10} + */ startWidth?: number; } export interface ScalesSubGaugesPosition { /** Specify x-axis position for sub-gauge of circular gauge - * @Default {0} - */ + * @Default {0} + */ x?: number; /** Specify y-axis position for sub-gauge of circular gauge - * @Default {0} - */ + * @Default {0} + */ y?: number; } export interface ScalesSubGauge { /** Specify subGauge Height of circular gauge - * @Default {150} - */ + * @Default {150} + */ height?: number; /** Specify position for sub-gauge of circular gauge - * @Default {Object} - */ + * @Default {Object} + */ position?: ScalesSubGaugesPosition; /** Specify subGauge Width of circular gauge - * @Default {150} - */ + * @Default {150} + */ width?: number; } export interface ScalesTick { /** Specify the angle for the ticks of circular gauge - * @Default {0} - */ + * @Default {0} + */ angle?: number; /** Specify tick color of circular gauge - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Specify distanceFromScale value for ticks of circular gauge - * @Default {0} - */ + * @Default {0} + */ distanceFromScale?: number; /** Specify tick height of circular gauge - * @Default {16} - */ + * @Default {16} + */ height?: number; /** Specify tick placement of circular gauge. See TickPlacement - * @Default {Near} - */ + * @Default {Near} + */ placement?: ej.datavisualization.CircularGauge.Placement|string; /** Specify tick Style of circular gauge. See TickType - * @Default {Major} - */ + * @Default {Major} + */ type?: ej.datavisualization.CircularGauge.LabelType|string; /** Specify tick width of circular gauge - * @Default {3} - */ + * @Default {3} + */ width?: number; } export interface Scale { /** Specify backgroundColor for the scale of circular gauge - * @Default {null} - */ + * @Default {null} + */ backgroundColor?: string; /** Specify border for scales of circular gauge - * @Default {Object} - */ + * @Default {Object} + */ border?: ScalesBorder; /** Specify scale direction of circular gauge. See Directions - * @Default {Clockwise} - */ + * @Default {Clockwise} + */ direction?: ej.datavisualization.CircularGauge.Direction|string; /** Specify the custom labels for the scales. - * @Default {Array} - */ + * @Default {Array} + */ customLabels?: ScalesCustomLabel[]; /** Specify representing state of circular gauge - * @Default {Array} - */ + * @Default {Array} + */ indicators?: ScalesIndicator[]; /** Specify the text values displayed in a meaningful manner alongside the ticks of circular gauge - * @Default {Array} - */ + * @Default {Array} + */ labels?: ScalesLabel[]; /** Specify majorIntervalValue of circular gauge - * @Default {10} - */ + * @Default {10} + */ majorIntervalValue?: number; /** Specify maximum scale value of circular gauge - * @Default {null} - */ + * @Default {null} + */ maximum?: number; /** Specify minimum scale value of circular gauge - * @Default {null} - */ + * @Default {null} + */ minimum?: number; /** Specify minorIntervalValue of circular gauge - * @Default {2} - */ + * @Default {2} + */ minorIntervalValue?: number; /** Specify opacity value of circular gauge - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Specify pointer cap of circular gauge - * @Default {Object} - */ + * @Default {Object} + */ pointerCap?: ScalesPointerCap; /** Specify pointers value of circular gauge - * @Default {Array} - */ + * @Default {Array} + */ pointers?: ScalesPointer[]; /** Specify scale radius of circular gauge - * @Default {170} - */ + * @Default {170} + */ radius?: number; /** Specify ranges value of circular gauge - * @Default {Array} - */ + * @Default {Array} + */ ranges?: ScalesRange[]; /** Specify shadowOffset value of circular gauge - * @Default {0} - */ + * @Default {0} + */ shadowOffset?: number; /** Specify showIndicators of circular gauge - * @Default {false} - */ + * @Default {false} + */ showIndicators?: boolean; /** Specify showLabels of circular gauge - * @Default {true} - */ + * @Default {true} + */ showLabels?: boolean; /** Specify showPointers of circular gauge - * @Default {true} - */ + * @Default {true} + */ showPointers?: boolean; /** Specify showRanges of circular gauge - * @Default {false} - */ + * @Default {false} + */ showRanges?: boolean; /** Specify showScaleBar of circular gauge - * @Default {false} - */ + * @Default {false} + */ showScaleBar?: boolean; /** Specify showTicks of circular gauge - * @Default {true} - */ + * @Default {true} + */ showTicks?: boolean; /** Specify scaleBar size of circular gauge - * @Default {6} - */ + * @Default {6} + */ size?: number; /** Specify startAngle of circular gauge - * @Default {115} - */ + * @Default {115} + */ startAngle?: number; /** Specify subGauge of circular gauge - * @Default {Array} - */ + * @Default {Array} + */ subGauges?: ScalesSubGauge[]; /** Specify sweepAngle of circular gauge - * @Default {310} - */ + * @Default {310} + */ sweepAngle?: number; /** Specify ticks of circular gauge - * @Default {Array} - */ + * @Default {Array} + */ ticks?: ScalesTick[]; } export interface Tooltip { /** enable showCustomLabelTooltip of circular gauge - * @Default {false} - */ + * @Default {false} + */ showCustomLabelTooltip?: boolean; /** enable showLabelTooltip of circular gauge - * @Default {false} - */ + * @Default {false} + */ showLabelTooltip?: boolean; /** Specify tooltip templateID of circular gauge - * @Default {false} - */ + * @Default {false} + */ templateID?: string; } } @@ -46807,46 +46807,46 @@ class DigitalGauge extends ej.Widget { defaults: DigitalGauge.Model; /** To destroy the digital gauge - * @returns {void} - */ + * @returns {void} + */ destroy(): void; /** To export Digital Gauge as Image - * @param {string} fileName for the Image - * @param {string} fileType for the Image - * @returns {boolean} - */ + * @param {string} fileName for the Image + * @param {string} fileType for the Image + * @returns {boolean} + */ exportImage(fileName: string, fileType: string): boolean; /** Gets the location of an item that is displayed on the gauge. - * @param {number} Position value of an item that is displayed on the gauge. - * @returns {any} - */ + * @param {number} Position value of an item that is displayed on the gauge. + * @returns {any} + */ getPosition(itemIndex: number): any; /** ClientSideMethod getValue Gets the value of an item that is displayed on the gauge - * @param {number} Index value of an item that displayed on the gauge - * @returns {any} - */ + * @param {number} Index value of an item that displayed on the gauge + * @returns {any} + */ getValue(itemIndex: number): any; /** Refresh the digital gauge widget - * @returns {void} - */ + * @returns {void} + */ refresh(): void; /** ClientSideMethod Set Position Sets the location of an item to be displayed in the gauge - * @param {number} Index value of the digital gauge item - * @param {any} Location value of the digital gauge - * @returns {void} - */ + * @param {number} Index value of the digital gauge item + * @param {any} Location value of the digital gauge + * @returns {void} + */ setPosition(itemIndex: number, value: any): void; /** ClientSideMethod SetValue Sets the value of an item to be displayed in the gauge. - * @param {number} Index value of the digital gauge item - * @param {string} Text value to be displayed in the gaugeS - * @returns {void} - */ + * @param {number} Index value of the digital gauge item + * @param {string} Text value to be displayed in the gaugeS + * @returns {void} + */ setValue(itemIndex: number, value: string): void; } export namespace DigitalGauge { @@ -46854,46 +46854,46 @@ export namespace DigitalGauge { export interface Model { /** Specifies the frame of the Digital gauge. - * @Default {{backgroundImageUrl: null, innerWidth: 6, outerWidth: 10}} - */ + * @Default {{backgroundImageUrl: null, innerWidth: 6, outerWidth: 10}} + */ frame?: Frame; /** Specifies the height of the DigitalGauge. - * @Default {150} - */ + * @Default {150} + */ height?: number; /** Specifies the resize option of the DigitalGauge. - * @Default {false} - */ + * @Default {false} + */ isResponsive?: boolean; /** Specifies the items for the DigitalGauge. - * @Default {null} - */ + * @Default {null} + */ items?: Item[]; /** Specifies the matrixSegmentData for the DigitalGauge. - */ + */ matrixSegmentData?: any; /** Specifies the segmentData for the DigitalGauge. - */ + */ segmentData?: any; /** Specifies the themes for the Digital gauge. See Themes - * @Default {flatlight} - */ + * @Default {flatlight} + */ themes?: string; /** Specifies the value to the DigitalGauge. - * @Default {text} - */ + * @Default {text} + */ value?: string; /** Specifies the width for the Digital gauge. - * @Default {400} - */ + * @Default {400} + */ width?: number; /** Triggers when the gauge is initialized. */ @@ -46912,276 +46912,276 @@ export interface Model { export interface InitEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the all the options of the items. - */ + */ items?: any; /** returns the context element - */ + */ context?: any; /** returns the gauge model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface ItemRenderingEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the all the options of the items. - */ + */ items?: any; /** returns the context element - */ + */ context?: any; /** returns the gauge model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface LoadEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the all the options of the items. - */ + */ items?: any; /** returns the context element - */ + */ context?: any; /** returns the gauge model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface RenderCompleteEventArgs { /** returns the object of the gauge. - */ + */ object?: any; /** returns the cancel option value - */ + */ cancel?: boolean; /** returns the all the options of the items. - */ + */ items?: any; /** returns the context element - */ + */ context?: any; /** returns the gauge model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface Frame { /** Specifies the URL of an image to be displayed as background of the Digital gauge. - * @Default {null} - */ + * @Default {null} + */ backgroundImageUrl?: string; /** Specifies the inner width for the frame, when the background image has been set for the Digital gauge.. - * @Default {6} - */ + * @Default {6} + */ innerWidth?: number; /** Specifies the outer width of the frame, when the background image has been set for the Digital gauge. - * @Default {10} - */ + * @Default {10} + */ outerWidth?: number; } export interface ItemsCharacterSettings { /** Specifies the CharacterCount value for the DigitalGauge. - * @Default {4} - */ + * @Default {4} + */ count?: number; /** Specifies the opacity value for the DigitalGauge. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Specifies the value for spacing between the characters - * @Default {2} - */ + * @Default {2} + */ spacing?: number; /** Specifies the character type for the text to be displayed. - * @Default {ej.datavisualization.DigitalGauge.CharacterType.EightCrossEightDotMatrix} - */ + * @Default {ej.datavisualization.DigitalGauge.CharacterType.EightCrossEightDotMatrix} + */ type?: ej.datavisualization.DigitalGauge.CharacterType|string; } export interface ItemsFont { /** Set the font family value - * @Default {Arial} - */ + * @Default {Arial} + */ fontFamily?: string; /** Set the font style for the font - * @Default {italic} - */ + * @Default {italic} + */ fontStyle?: ej.datavisualization.DigitalGauge.FontStyle|string; /** Set the font size value - * @Default {11px} - */ + * @Default {11px} + */ size?: string; } export interface ItemsPosition { /** Set the horizontal location for the text, where it needs to be placed within the gauge. - * @Default {0} - */ + * @Default {0} + */ x?: number; /** Set the vertical location for the text, where it needs to be placed within the gauge. - * @Default {0} - */ + * @Default {0} + */ y?: number; } export interface ItemsSegmentSettings { /** Set the color for the text segments. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Set the gradient for the text segments. - * @Default {null} - */ + * @Default {null} + */ gradient?: any; /** Set the length for the text segments. - * @Default {2} - */ + * @Default {2} + */ length?: number; /** Set the opacity for the text segments. - * @Default {0} - */ + * @Default {0} + */ opacity?: number; /** Set the spacing for the text segments. - * @Default {1} - */ + * @Default {1} + */ spacing?: number; /** Set the width for the text segments. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface Item { /** Specifies the Character settings for the DigitalGauge. - * @Default {null} - */ + * @Default {null} + */ characterSettings?: ItemsCharacterSettings; /** Enable/Disable the custom font to be applied to the text in the gauge. - * @Default {false} - */ + * @Default {false} + */ enableCustomFont?: boolean; /** Set the specific font for the text, when the enableCustomFont is set to true - * @Default {null} - */ + * @Default {null} + */ font?: ItemsFont; /** Set the location for the text, where it needs to be placed within the gauge. - * @Default {null} - */ + * @Default {null} + */ position?: ItemsPosition; /** Set the segment settings for the digital gauge. - * @Default {null} - */ + * @Default {null} + */ segmentSettings?: ItemsSegmentSettings; /** Set the value for enabling/disabling the blurring effect for the shadows of the text - * @Default {0} - */ + * @Default {0} + */ shadowBlur?: number; /** Specifies the color of the text shadow. - * @Default {null} - */ + * @Default {null} + */ shadowColor?: string; /** Set the x offset value for the shadow of the text, indicating the location where it needs to be displayed. - * @Default {1} - */ + * @Default {1} + */ shadowOffsetX?: number; /** Set the y offset value for the shadow of the text, indicating the location where it needs to be displayed. - * @Default {1} - */ + * @Default {1} + */ shadowOffsetY?: number; /** Set the alignment of the text that is displayed within the gauge.See TextAlign - * @Default {left} - */ + * @Default {left} + */ textAlign?: string; /** Specifies the color of the text. - * @Default {null} - */ + * @Default {null} + */ textColor?: string; /** Specifies the text value. - * @Default {null} - */ + * @Default {null} + */ value?: string; } } @@ -47222,24 +47222,24 @@ class Chart extends ej.Widget { defaults: Chart.Model; /** Animates the series and/or indicators in Chart. When parameter is not passed to this method, then all the series and indicators present in Chart are animated. - * @param {any} If an array collection is passed as parameter, series and indicator objects passed in array collection are animated.ExampleIf a series - * or indicator object is passed to this method, then the specific series or indicator is animated.Example, - * @returns {void} - */ + * @param {any} If an array collection is passed as parameter, series and indicator objects passed in array collection are animated.ExampleIf a series + * or indicator object is passed to this method, then the specific series or indicator is animated.Example, + * @returns {void} + */ animate(options: any): void; /** Exports chart as an image or to an excel file. Chart can be exported as an image only when exportCanvasRendering option is set to true. - * @param {string} Type of the export operation to be performed. Following are the two export types that are supported now,1. 'image'2. 'excel'Example - * @param {string} URL of the service, where the chart will be exported to excel.Example, - * @param {boolean} When this parameter is true, all the chart objects initialized to the same document are exported to a single excel file. - * This is an optional parameter. By default, it is false.Example, - * @returns {any} - */ + * @param {string} Type of the export operation to be performed. Following are the two export types that are supported now,1. 'image'2. 'excel'Example + * @param {string} URL of the service, where the chart will be exported to excel.Example, + * @param {boolean} When this parameter is true, all the chart objects initialized to the same document are exported to a single excel file. + * This is an optional parameter. By default, it is false.Example, + * @returns {any} + */ export(type: string, URL: string, exportMultipleChart: boolean): any; /** Redraws the entire chart. You can call this method whenever you update, add or remove points from the data source or whenever you want to refresh the UI. - * @returns {void} - */ + * @returns {void} + */ redraw(): void; } export namespace Chart { @@ -47247,158 +47247,158 @@ export namespace Chart { export interface Model { /** Options for adding and customizing annotations in Chart. - */ + */ annotations?: Annotation[]; /** URL of the image to be used as chart background. - * @Default {null} - */ + * @Default {null} + */ backGroundImageUrl?: string; /** Options for customizing the color, opacity and width of the chart border. - */ + */ border?: Border; /** This provides options for customizing export settings - */ + */ exportSettings?: ExportSettings; /** Options for configuring the border and background of the plot area. - */ + */ chartArea?: ChartArea; /** Options to split Chart into multiple plotting areas vertically. Each object in the collection represents a plotting area in Chart. - */ + */ columnDefinitions?: ColumnDefinition[]; /** Options for configuring the properties of all the series. You can also override the options for specific series by using series collection. - */ + */ commonSeriesOptions?: CommonSeriesOptions; /** Options for displaying and customizing the crosshair. - */ + */ crosshair?: Crosshair; /** Depth of the 3D Chart from front view of series to background wall. This property is applicable only for 3D view. - * @Default {100} - */ + * @Default {100} + */ depth?: number; /** Controls whether 3D view has to be enabled or not. 3D view is supported only for column, bar. Stacking column, stacking bar, pie and doughnut series types. - * @Default {false} - */ + * @Default {false} + */ enable3D?: boolean; /** Controls whether Chart has to be rendered as Canvas or SVG. Canvas rendering supports all functionalities in SVG rendering except 3D Charts. - * @Default {false} - */ + * @Default {false} + */ enableCanvasRendering?: boolean; /** Controls whether the series has to be rendered at initial loading of chart, this will be useful in scenarios where chart is placed at the bottom of the web page - * and we need to render the series only when the chart is visible while scrolling to the top. - * @Default {true} - */ + * and we need to render the series only when the chart is visible while scrolling to the top. + * @Default {true} + */ initSeriesRender?: boolean; /** Controls whether 3D view has to be rotated on dragging. This property is applicable only for 3D view. - * @Default {false} - */ + * @Default {false} + */ enableRotation?: boolean; /** Options to customize the technical indicators. - */ + */ indicators?: Indicator[]; /** Controls whether Chart has to be responsive while resizing. - * @Default {false} - */ + * @Default {false} + */ isResponsive?: boolean; /** Options to customize the legend items and legend title. - */ + */ legend?: Legend; /** Name of the culture based on which chart should be localized. Number and date time values are localized with respect to the culture name.String type properties like title text are - * not localized automatically. Provide localized text as value to string type properties. - * @Default {en-US} - */ + * not localized automatically. Provide localized text as value to string type properties. + * @Default {en-US} + */ locale?: string; /** Palette is used to store the series fill color in array and apply the color to series collection in the order of series index. - * @Default {null} - */ + * @Default {null} + */ palette?: any[]; /** Options to customize the left, right, top and bottom margins of chart area. - */ + */ Margin?: any; /** Perspective angle of the 3D view. Chart appears closer when perspective angle is decreased, and distant when perspective angle is increased. - * This property is applicable only when 3D view is enabled - * @Default {90} - */ + * This property is applicable only when 3D view is enabled + * @Default {90} + */ perspectiveAngle?: number; /** This is a horizontal axis that contains options to configure axis and it is the primary x axis for all the series in series array. - * To override x axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. - * Then, assign the name to the seriesĂ¢â‚¬â„¢s xAxisName property to link both axis and series. - */ + * To override x axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. + * Then, assign the name to the seriesĂ¢â‚¬â„¢s xAxisName property to link both axis and series. + */ primaryXAxis?: PrimaryXAxis; /** To override x axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. - * Then, assign the name to the seriesĂ¢â‚¬â„¢s xAxisName property to link both axis and series. - */ + * Then, assign the name to the seriesĂ¢â‚¬â„¢s xAxisName property to link both axis and series. + */ axes?: Axis[]; /** This is a vertical axis that contains options to configure axis. This is the primary y axis for all the series in series array. - * To override y axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. - * Then, assign the name to the seriesĂ¢â‚¬â„¢s yAxisName property to link both axis and series. - */ + * To override y axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. + * Then, assign the name to the seriesĂ¢â‚¬â„¢s yAxisName property to link both axis and series. + */ primaryYAxis?: PrimaryYAxis; /** Rotation angle of the 3D view. This property is applicable only when 3D view is enabled. - * @Default {0} - */ + * @Default {0} + */ rotation?: number; /** Options to split Chart into multiple plotting areas horizontally. Each object in the collection represents a plotting area in Chart. - */ + */ rowDefinitions?: RowDefinition[]; /** Specifies the properties used for customizing the series. - */ + */ series?: Series[]; /** Controls whether data points has to be displayed side by side or along the depth of the axis. - * @Default {false} - */ + * @Default {false} + */ sideBySideSeriesPlacement?: boolean; /** Options to customize the Chart size. - */ + */ size?: Size; /** Specifies the theme for Chart. - * @Default {Flatlight. See Theme} - */ + * @Default {Flatlight. See Theme} + */ theme?: ej.datavisualization.Chart.Theme|string; /** Slope angle of 3D Chart. This property is applicable only when 3D view is enabled. - * @Default {0} - */ + * @Default {0} + */ tilt?: number; /** Options for customizing the title and subtitle of Chart. - */ + */ title?: Title; /** Width of the wall used in 3D Chart. Wall is present only in Cartesian type 3D series and not in 3D pie or Doughnut series. This property is applicable only when 3D view is enabled. - * @Default {2} - */ + * @Default {2} + */ wallSize?: number; /** Options for enabling zooming feature of chart. - */ + */ zooming?: Zooming; /** Fires after the series animation is completed. This event will be triggered for each series when animation is enabled. */ @@ -47473,8 +47473,9 @@ export interface Model { /** Fires before rendering crosshair tooltip in axis. This event is fired for each axis with crosshair label enabled. You can use this event to customize crosshair label before rendering */ trackAxisToolTip?(e: TrackAxisToolTipEventArgs): void; - /** Fires before rendering trackball tooltip. This event is fired for each series in Chart because trackball tooltip is displayed for all the series. - * You can use this event to customize the text displayed in trackball tooltip. */ + /** Fires before rendering trackball tooltip. This event is fired for each series in Chart because trackball tooltip is displayed for all the series. + * You can use this event to customize the text displayed in trackball tooltip. + */ trackToolTip?(e: TrackToolTipEventArgs): void; /** Fires, on clicking the axis label. */ @@ -47517,6428 +47518,6428 @@ export interface Model { export interface AnimationCompleteEventArgs { /** Instance of the series that completed has animation. - */ + */ series?: any; /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the chart model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface AxesLabelRenderingEventArgs { /** Instance of the corresponding axis. - */ + */ Axis?: any; /** Formatted text of the respective label. You can also add custom text to the label. - */ + */ LabelText?: string; /** Actual value of the label. - */ + */ LabelValue?: string; /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the chart model object. - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface AxesLabelsInitializeEventArgs { /** Collection of axes in Chart - */ + */ dataAxes?: any; /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the chart model object. - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface AxesRangeCalculateEventArgs { /** Difference between minimum and maximum value of axis range. - */ + */ delta?: number; /** Interval value of axis range. Grid lines, tick lines and axis labels are drawn based on this interval value. - */ + */ interval?: number; /** Maximum value of axis range. - */ + */ max?: number; /** Minimum value of axis range. - */ + */ min?: number; /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the chart model object. - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface AxesTitleRenderingEventArgs { /** Instance of the axis whose title is being rendered - */ + */ axes?: any; /** X-coordinate of title location - */ + */ locationX?: number; /** Y-coordinate of title location - */ + */ locationY?: number; /** Axis title text. You can add custom text to the title. - */ + */ title?: string; /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the chart model object. - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface ChartAreaBoundsCalculateEventArgs { /** Height of the chart area. - */ + */ areaBoundsHeight?: number; /** Width of the chart area. - */ + */ areaBoundsWidth?: number; /** X-coordinate of the chart area. - */ + */ areaBoundsX?: number; /** Y-coordinate of the chart area. - */ + */ areaBoundsY?: number; /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the chart model object. - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface CreateEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the chart model object. - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface DestroyEventArgs { /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the chart model object. - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface DisplayTextRenderingEventArgs { /** Text displayed in data label. You can add custom text to the data label - */ + */ text?: string; /** X-coordinate of data label location - */ + */ locationX?: number; /** Y-coordinate of data label location - */ + */ locationY?: number; /** Index of the series in series Collection whose data label is being rendered - */ + */ seriesIndex?: number; /** Index of the point in series whose data label is being rendered - */ + */ pointIndex?: number; /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the chart model object. - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface LegendBoundsCalculateEventArgs { /** Height of the legend. - */ + */ legendBoundsHeight?: number; /** Width of the legend. - */ + */ legendBoundsWidth?: number; /** Number of rows to display the legend items - */ + */ legendBoundsRows?: number; /** Set this option to true to cancel the event. - */ + */ cancel?: boolean; /** Instance of the chart model object. - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface LegendItemClickEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the chart model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** X-coordinate of legend item in pixel - */ + */ startX?: number; /** Y-coordinate of legend item in pixel - */ + */ startY?: number; /** Instance of the legend item object that is about to be rendered - */ + */ LegendItem?: any; /** Options to customize the legend item styles such as border, color, size, etcĂ¢â‚¬Â¦, - */ + */ style?: any; /** Instance that holds information about legend bounds and legend item bounds. - */ + */ Bounds?: any; /** Name of the legend item shape. Use this option to customize legend item shape before rendering - */ + */ symbolShape?: string; /** Instance of the series object corresponding to the legend item - */ + */ series?: any; } export interface LegendItemMouseMoveEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the chart model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** X-coordinate of legend item in pixel - */ + */ startX?: number; /** Y-coordinate of legend item in pixel - */ + */ startY?: number; /** Instance of the legend item object that is about to be rendered - */ + */ LegendItem?: any; /** Options to customize the legend item styles such as border, color, size, etcĂ¢â‚¬Â¦, - */ + */ style?: any; /** Options to customize the legend item styles such as border, color, size, etcĂ¢â‚¬Â¦, - */ + */ Bounds?: any; /** Name of the legend item shape. Use this option to customize legend item shape before rendering - */ + */ symbolShape?: string; /** Instance of the series object corresponding to the legend item - */ + */ series?: any; } export interface LegendItemRenderingEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the chart model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** X-coordinate of legend item in pixel - */ + */ startX?: number; /** Y-coordinate of legend item in pixel - */ + */ startY?: number; /** Instance of the legend item object that is about to be rendered - */ + */ legendItem?: any; /** Options to customize the legend item styles such as border, color, size, etc. - */ + */ style?: any; /** Name of the legend item shape. Use this option to customize legend item shape before rendering - */ + */ symbolShape?: string; } export interface LoadEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the chart model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface RangeSelectedEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the chart model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** Selected data collection of object - */ + */ data?: any; } export interface PointRegionClickEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the chart model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** X-coordinate of point in pixel - */ + */ locationX?: number; /** Y-coordinate of point in pixel - */ + */ locationY?: number; /** Index of the point in series - */ + */ pointIndex?: number; /** Index of the series in series collection to which the point belongs - */ + */ seriesIndex?: number; } export interface PointRegionMouseMoveEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the chart model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** X-coordinate of point in pixel - */ + */ locationX?: number; /** Y-coordinate of point in pixel - */ + */ locationY?: number; /** Index of the point in series - */ + */ pointIndex?: number; /** Index of the series in series collection to which the point belongs - */ + */ seriesIndex?: number; } export interface PreRenderEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the chart model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface SeriesRegionClickEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the chart model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** Instance of the selected series - */ + */ series?: any; /** Index of the selected series - */ + */ seriesIndex?: number; } export interface SeriesRenderingEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the chart model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** Instance of the series which is about to get rendered - */ + */ series?: any; } export interface SymbolRenderingEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the chart model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** Instance that holds the location of marker symbol - */ + */ location?: any; /** Options to customize the marker style such as color, border and size - */ + */ style?: any; } export interface TitleRenderingEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the chart model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** Option to customize the title location in pixels - */ + */ location?: any; /** Read-only option to find the size of the title - */ + */ size?: any; /** Use this option to add custom text in title - */ + */ title?: string; } export interface ToolTipInitializeEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the chart model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** Text to be displayed in tooltip. Set this option to customize the text displayed in tooltip - */ + */ currentText?: string; /** Index of the point on which mouse is hovered - */ + */ pointIndex?: number; /** Index of the series in series collection whose point is hovered by mouse - */ + */ seriesIndex?: number; } export interface TrackAxisToolTipEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the chart model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** Location of the crosshair label in pixels - */ + */ location?: any; /** Index of the axis for which crosshair label is displayed - */ + */ axisIndex?: number; /** Instance of the chart axis object for which cross hair label is displayed - */ + */ crossAxis?: number; /** Text to be displayed in crosshair label. Use this option to add custom text in crosshair label - */ + */ currentTrackText?: string; } export interface TrackToolTipEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the chart model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** Location of the trackball tooltip in pixels - */ + */ location?: any; /** Index of the point for which trackball tooltip is displayed - */ + */ pointIndex?: number; /** Index of the series in series collection - */ + */ seriesIndex?: number; /** Text to be displayed in trackball tooltip. Use this option to add custom text in trackball tooltip - */ + */ currentText?: string; /** Instance of the series object for which trackball tooltip is displayed. - */ + */ series?: any; } export interface AxisLabelClickEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the chart model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** X and Y co-ordinate of the labels in chart area. - */ + */ location?: any; /** Index of the label. - */ + */ index?: number; /** Instance of the corresponding axis. - */ + */ axis?: any; /** Label that is clicked. - */ + */ text?: string; } export interface AxisLabelMouseMoveEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the chart model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** X and Y co-ordinate of the labels in chart area. - */ + */ location?: any; /** Index of the label. - */ + */ index?: number; /** Instance of the corresponding axis. - */ + */ axis?: any; /** Label that is hovered. - */ + */ text?: string; } export interface ChartClickEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the chart model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** X and Y co-ordinate of the points with respect to chart area. - */ + */ location?: any; /** ID of the target element. - */ + */ id?: string; /** Width and height of the chart. - */ + */ size?: any; /** x-coordinate of the pointer, relative to the page - */ + */ pageX?: number; /** y-coordinate of the pointer, relative to the page - */ + */ pageY?: number; } export interface ChartMouseMoveEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the chart model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** X and Y co-ordinate of the points with respect to chart area. - */ + */ location?: any; /** ID of the target element. - */ + */ id?: string; /** Width and height of the chart. - */ + */ size?: any; /** x-coordinate of the pointer, relative to the page - */ + */ pageX?: number; /** y-coordinate of the pointer, relative to the page - */ + */ pageY?: number; } export interface ChartDoubleClickEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the chart model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** X and Y co-ordinate of the points with respect to chart area. - */ + */ location?: any; /** ID of the target element. - */ + */ id?: string; /** Width and height of the chart. - */ + */ size?: any; /** x-coordinate of the pointer, relative to the page - */ + */ pageX?: number; /** y-coordinate of the pointer, relative to the page - */ + */ pageY?: number; } export interface AnnotationClickEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the chart model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** X and Y co-ordinate of the annotation in chart area. - */ + */ location?: any; /** Information about the annotation, like Coordinate unit, Region, content - */ + */ contentData?: any; /** x-coordinate of the pointer, relative to the page - */ + */ pageX?: number; /** y-coordinate of the pointer, relative to the page - */ + */ pageY?: number; } export interface AfterResizeEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the chart model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** Chart width, after resize - */ + */ width?: number; /** Chart height, after resize - */ + */ height?: number; /** Chart width, before resize - */ + */ prevWidth?: number; /** Chart height, before resize - */ + */ prevHeight?: number; /** Chart width, when the chart was first rendered - */ + */ originalWidth?: number; /** Chart height, when the chart was first rendered - */ + */ originalHeight?: number; } export interface BeforeResizeEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the chart model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** Chart width, before resize - */ + */ currentWidth?: number; /** Chart height, before resize - */ + */ currentHeight?: number; /** Chart width, after resize - */ + */ newWidth?: number; /** Chart height, after resize - */ + */ newHeight?: number; } export interface ErrorBarRenderingEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the chart model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** Error bar Object - */ + */ errorbar?: any; } export interface ScrollChangedEventArgs { /** parameters from RangeNavigator - */ + */ data?: any; /** returns the scrollbar position old start and end range value on changing scrollbar - */ + */ dataoldRange?: any; /** returns the scrollbar position new start and end range value on changing scrollbar - */ + */ datanewRange?: any; /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the RangeNavigator model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface ScrollStartEventArgs { /** parameters from RangeNavigator - */ + */ data?: any; /** returns the scrollbar position starting range value on changing scrollbar - */ + */ datastartRange?: string; /** returns the scrollbar position end range value on changing scrollbar - */ + */ dataendRange?: string; /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the RangeNavigator model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface ScrollEndEventArgs { /** parameters from RangeNavigator - */ + */ data?: any; /** returns the scrollbar position old start and end range value on change end of scrollbar - */ + */ dataoldRange?: any; /** returns the scrollbar position new start and end range value on change end of scrollbar - */ + */ datanewRange?: any; /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the RangeNavigator model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface AnnotationsMargin { /** Annotation is placed at the specified value above its original position. - * @Default {0} - */ + * @Default {0} + */ bottom?: number; /** Annotation is placed at the specified value from left side of its original position. - * @Default {0} - */ + * @Default {0} + */ left?: number; /** Annotation is placed at the specified value from the right side of its original position. - * @Default {0} - */ + * @Default {0} + */ right?: number; /** Annotation is placed at the specified value under its original position. - * @Default {0} - */ + * @Default {0} + */ top?: number; } export interface Annotation { /** Angle to rotate the annotation in degrees. - * @Default {'0'} - */ + * @Default {'0'} + */ angle?: number; /** Text content or id of a HTML element to be displayed as annotation. - */ + */ content?: string; /** Specifies how annotations have to be placed in Chart. - * @Default {none. See CoordinateUnit} - */ + * @Default {none. See CoordinateUnit} + */ coordinateUnit?: ej.datavisualization.Chart.CoordinateUnit|string; /** Specifies the horizontal alignment of the annotation. - * @Default {middle. See HorizontalAlignment} - */ + * @Default {middle. See HorizontalAlignment} + */ horizontalAlignment?: ej.datavisualization.Chart.HorizontalAlignment|string; /** Options to customize the margin of annotation. - */ + */ margin?: AnnotationsMargin; /** Controls the opacity of the annotation. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Specifies whether annotation has to be placed with respect to chart or series. - * @Default {chart. See Region} - */ + * @Default {chart. See Region} + */ region?: ej.datavisualization.Chart.Region|string; /** Specifies the vertical alignment of the annotation. - * @Default {middle. See VerticalAlignment} - */ + * @Default {middle. See VerticalAlignment} + */ verticalAlignment?: ej.datavisualization.Chart.VerticalAlignment|string; /** Controls the visibility of the annotation. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; /** Represents the horizontal offset when coordinateUnit is pixels.when coordinateUnit is points, it represents the x-coordinate of axis bounded with xAxisName property - * or primary X axis when xAxisName is not provided.This property is not applicable when coordinateUnit is none. - * @Default {0} - */ + * or primary X axis when xAxisName is not provided.This property is not applicable when coordinateUnit is none. + * @Default {0} + */ x?: number; /** Name of the horizontal axis to be used for positioning the annotation. This property is applicable only when coordinateUnit is points. - */ + */ xAxisName?: string; /** Represents the vertical offset when coordinateUnit is pixels.When coordinateUnit is points, it represents the y-coordinate of axis bounded with - * yAxisName property or primary Y axis when yAxisName is not provided.This property is not applicable when coordinateUnit is none. - * @Default {0} - */ + * yAxisName property or primary Y axis when yAxisName is not provided.This property is not applicable when coordinateUnit is none. + * @Default {0} + */ y?: number; /** Name of the vertical axis to be used for positioning the annotation.This property is applicable only when coordinateUnit is points. - */ + */ yAxisName?: string; } export interface Border { /** Border color of the chart. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Opacity of the chart border. - * @Default {0.3} - */ + * @Default {0.3} + */ opacity?: number; /** Width of the Chart border. - * @Default {0} - */ + * @Default {0} + */ width?: number; } export interface ExportSettings { /** Specifies the downloading filename - * @Default {chart} - */ + * @Default {chart} + */ filename?: string; /** Specifies the name of the action URL - */ + */ action?: string; /** Specifies the angle for rotation - * @Default {0} - */ + * @Default {0} + */ angle?: number; /** Specifies the format of the file to export - * @Default {png} - */ + * @Default {png} + */ type?: ej.datavisualization.Chart.ExportingType|string; /** Specifies the orientation of the document - * @Default {portrait} - */ + * @Default {portrait} + */ orientation?: ej.datavisualization.Chart.ExportingOrientation|string; /** Specifies the mode of exporting - * @Default {client} - */ + * @Default {client} + */ mode?: ej.datavisualization.Chart.ExportingMode|string; /** Enable/ disable the multiple excel exporting - * @Default {false} - */ + * @Default {false} + */ multipleExport?: boolean; } export interface ChartAreaBorder { /** Border color of the plot area. - * @Default {Gray} - */ + * @Default {Gray} + */ color?: string; /** Opacity of the plot area border. - * @Default {0.3} - */ + * @Default {0.3} + */ opacity?: number; /** Border width of the plot area. - * @Default {0.5} - */ + * @Default {0.5} + */ width?: number; } export interface ChartArea { /** Background color of the plot area. - * @Default {transparent} - */ + * @Default {transparent} + */ background?: string; /** Options for customizing the border of the plot area. - */ + */ border?: ChartAreaBorder; } export interface ColumnDefinition { /** Specifies the unit to measure the width of the column in plotting area. - * @Default {'pixel'. See Unit} - */ + * @Default {'pixel'. See Unit} + */ unit?: ej.datavisualization.Chart.Unit|string; /** Width of the column in plotting area. Width is measured in either pixel or percentage based on the value of unit property. - * @Default {50} - */ + * @Default {50} + */ columnWidth?: number; /** Color of the line that indicates the starting point of the column in plotting area. - * @Default {transparent} - */ + * @Default {transparent} + */ lineColor?: string; /** Width of the line that indicates the starting point of the column in plot area. - * @Default {1} - */ + * @Default {1} + */ lineWidth?: number; } export interface CommonSeriesOptionsBorder { /** Border color of all series. - * @Default {transparent} - */ + * @Default {transparent} + */ color?: string; /** DashArray for border of the series. - * @Default {null} - */ + * @Default {null} + */ dashArray?: string; /** Border width of all series. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface CommonSeriesOptionsFont { /** Font color of the text in all series. - * @Default {#707070} - */ + * @Default {#707070} + */ color?: string; /** Font Family for all the series. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Specifies the font Style for all the series. - * @Default {normal} - */ + * @Default {normal} + */ fontStyle?: ej.datavisualization.Chart.FontStyle|string; /** Specifies the font weight for all the series. - * @Default {regular} - */ + * @Default {regular} + */ fontWeight?: ej.datavisualization.Chart.FontWeight|string; /** Opacity for text in all the series. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font size for text in all the series. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface CommonSeriesOptionsMarkerBorder { /** Border color of the marker shape. - * @Default {white} - */ + * @Default {white} + */ color?: string; /** Border width of the marker shape. - * @Default {3} - */ + * @Default {3} + */ width?: number; } export interface CommonSeriesOptionsMarkerDataLabelBorder { /** Border color of the data label. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Border width of the data label. - * @Default {0.1} - */ + * @Default {0.1} + */ width?: number; } export interface CommonSeriesOptionsMarkerDataLabelConnectorLine { /** Specifies when the connector has to be drawn as Bezier curve or straight line. This is applicable only for Pie and Doughnut chart types. - * @Default {line. See ConnectorLineType} - */ + * @Default {line. See ConnectorLineType} + */ type?: ej.datavisualization.Chart.ConnectorLineType|string; /** Width of the connector. - * @Default {0.5} - */ + * @Default {0.5} + */ width?: number; /** Color of the connector line. - * @Default {#565656} - */ + * @Default {#565656} + */ color?: string; /** Height of the connector line. - * @Default {null} - */ + * @Default {null} + */ height?: string; } export interface CommonSeriesOptionsMarkerDataLabelFont { /** Font family of the data label. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style of the data label. - * @Default {normal. See FontStyle} - */ + * @Default {normal. See FontStyle} + */ fontStyle?: ej.datavisualization.Chart.FontStyle|string; /** Font weight of the data label. - * @Default {regular. See FontWeight} - */ + * @Default {regular. See FontWeight} + */ fontWeight?: ej.datavisualization.Chart.FontWeight|string; /** Opacity of the text. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font color of the data label text. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Font size of the data label. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface CommonSeriesOptionsMarkerDataLabelMargin { /** Bottom margin of the text. - * @Default {5} - */ + * @Default {5} + */ bottom?: number; /** Left margin of the text. - * @Default {5} - */ + * @Default {5} + */ left?: number; /** Right margin of the text. - * @Default {5} - */ + * @Default {5} + */ right?: number; /** Top margin of the text. - * @Default {5} - */ + * @Default {5} + */ top?: number; } export interface CommonSeriesOptionsMarkerDataLabel { /** Angle of the data label in degrees. Only the text gets rotated, whereas the background and border does not rotate. - * @Default {null} - */ + * @Default {null} + */ angle?: number; /** Maximum label width of the data label. - * @Default {null} - */ + * @Default {null} + */ maximumLabelWidth?: number; /** Enable the wrap option to the data label. - * @Default {false} - */ + * @Default {false} + */ enableWrap?: boolean; /** Options for customizing the border of the data label. - */ + */ border?: CommonSeriesOptionsMarkerDataLabelBorder; /** Options for displaying and customizing the line that connects point and data label. - */ + */ connectorLine?: CommonSeriesOptionsMarkerDataLabelConnectorLine; /** Background color of the data label. - * @Default {null} - */ + * @Default {null} + */ fill?: string; /** Options for customizing the data label font. - */ + */ font?: CommonSeriesOptionsMarkerDataLabelFont; /** Horizontal alignment of the data label. - * @Default {center} - */ + * @Default {center} + */ horizontalTextAlignment?: ej.datavisualization.Chart.HorizontalTextAlignment|string; /** Margin of the text to its background shape. The size of the background shape increases based on the margin applied to its text. - */ + */ margin?: CommonSeriesOptionsMarkerDataLabelMargin; /** Opacity of the data label. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Background shape of the data label. - * @Default {none. See Shape} - */ + * @Default {none. See Shape} + */ shape?: ej.datavisualization.Chart.Shape|string; /** Custom template to format the data label content. Use Ă¢â‚¬Å“point.xĂ¢â‚¬Â and Ă¢â‚¬Å“point.yĂ¢â‚¬Â as a placeholder text to display the corresponding data pointĂ¢â‚¬â„¢s x and y value. - */ + */ template?: string; /** Name of a field in data source, where datalabel text is displayed. - */ + */ textMappingName?: string; /** Specifies the position of the data label. This property can be used only for the series such as column, bar, stacked column, stacked bar, 100% stacked column, 100% stacked bar, candle and OHLC. - * @Default {top. See TextPosition} - */ + * @Default {top. See TextPosition} + */ textPosition?: ej.datavisualization.Chart.TextPosition|string; /** Vertical alignment of the data label. - * @Default {center} - */ + * @Default {center} + */ verticalTextAlignment?: ej.datavisualization.Chart.VerticalTextAlignment|string; /** Controls the visibility of the data labels. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; } export interface CommonSeriesOptionsMarkerSize { /** Height of the marker. - * @Default {6} - */ + * @Default {6} + */ height?: number; /** Width of the marker. - * @Default {6} - */ + * @Default {6} + */ width?: number; } export interface CommonSeriesOptionsMarker { /** Options for customizing the border of the marker shape. - */ + */ border?: CommonSeriesOptionsMarkerBorder; /** Options for displaying and customizing data labels. - */ + */ dataLabel?: CommonSeriesOptionsMarkerDataLabel; /** Color of the marker shape. - * @Default {null} - */ + * @Default {null} + */ fill?: string; /** The URL for the Image to be displayed as marker. In order to display image as marker, set series.marker.shape as Ă¢â‚¬ËœimageĂ¢â‚¬â„¢. - */ + */ imageUrl?: string; /** Opacity of the marker. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Specifies the shape of the marker. - * @Default {circle. See Shape} - */ + * @Default {circle. See Shape} + */ shape?: ej.datavisualization.Chart.Shape|string; /** Options for customizing the size of the marker shape. - */ + */ size?: CommonSeriesOptionsMarkerSize; /** Controls the visibility of the marker shape. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; } export interface CommonSeriesOptionsOutlierSettingsSize { /** Height of the outlier shape. - * @Default {6} - */ + * @Default {6} + */ height?: number; /** Width of the outlier shape. - * @Default {6} - */ + * @Default {6} + */ width?: number; } export interface CommonSeriesOptionsOutlierSettings { /** Specifies the shape of the outlier. - * @Default {circle. See Shape} - */ + * @Default {circle. See Shape} + */ shape?: ej.datavisualization.Chart.Shape|string; /** Options for customizing the size of the outlier shape. - */ + */ size?: CommonSeriesOptionsOutlierSettingsSize; } export interface CommonSeriesOptionsCornerRadius { /** Specifies the radius for the top left corner. - * @Default {0} - */ + * @Default {0} + */ topLeft?: number; /** Specifies the radius for the top right corner. - * @Default {0} - */ + * @Default {0} + */ topRight?: number; /** Specifies the radius for the bottom left corner. - * @Default {0} - */ + * @Default {0} + */ bottomLeft?: number; /** Specifies the radius for the bottom right corner. - * @Default {0} - */ + * @Default {0} + */ bottomRight?: number; } export interface CommonSeriesOptionsTooltipBorder { /** Border color of the tooltip. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Border width of the tooltip. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface CommonSeriesOptionsTooltip { /** Options for customizing the border of the tooltip. - */ + */ border?: CommonSeriesOptionsTooltipBorder; /** Customize the corner radius of the tooltip rectangle. - * @Default {0} - */ + * @Default {0} + */ rx?: number; /** Customize the corner radius of the tooltip rectangle. - * @Default {0} - */ + * @Default {0} + */ ry?: number; /** Specifies the duration, the tooltip has to be displayed. - * @Default {500ms} - */ + * @Default {500ms} + */ duration?: string; /** Enables/disables the animation of the tooltip when moving from one point to other. - * @Default {true} - */ + * @Default {true} + */ enableAnimation?: boolean; /** Background color of the tooltip. - * @Default {null} - */ + * @Default {null} + */ fill?: string; /** Format of the tooltip content. - * @Default {#point.x# : #point.y#} - */ + * @Default {#point.x# : #point.y#} + */ format?: string; /** Opacity of the tooltip. - * @Default {0.5} - */ + * @Default {0.5} + */ opacity?: number; /** Custom template to format the tooltip content. Use Ă¢â‚¬Å“point.xĂ¢â‚¬Â and Ă¢â‚¬Å“point.yĂ¢â‚¬Â as a placeholder text to display the corresponding data pointĂ¢â‚¬â„¢s x and y value. - * @Default {null} - */ + * @Default {null} + */ template?: string; /** Controls the visibility of the tooltip. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; } export interface CommonSeriesOptionsEmptyPointSettingsStyleBorder { /** Border color of the empty point. - */ + */ color?: string; /** Border width of the empty point. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface CommonSeriesOptionsEmptyPointSettingsStyle { /** Color of the empty point. - */ + */ color?: string; /** Options for customizing border of the empty point in the series. - */ + */ border?: CommonSeriesOptionsEmptyPointSettingsStyleBorder; } export interface CommonSeriesOptionsEmptyPointSettings { /** Controls the visibility of the empty point. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Specifies the mode of empty point. - * @Default {gap} - */ + * @Default {gap} + */ displayMode?: ej.datavisualization.Chart.EmptyPointMode|string; /** Options for customizing the color and border of the empty point in the series. - */ + */ style?: CommonSeriesOptionsEmptyPointSettingsStyle; } export interface CommonSeriesOptionsConnectorLine { /** Width of the connector line. - * @Default {1} - */ + * @Default {1} + */ width?: number; /** Color of the connector line. - * @Default {#565656} - */ + * @Default {#565656} + */ color?: string; /** DashArray of the connector line. - * @Default {null} - */ + * @Default {null} + */ dashArray?: string; /** DashArray of the connector line. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; } export interface CommonSeriesOptionsDragSettings { /** drag/drop the series - * @Default {false} - */ + * @Default {false} + */ enable?: boolean; /** Specifies the type of drag settings. - * @Default {xy} - */ + * @Default {xy} + */ type?: string; } export interface CommonSeriesOptionsErrorBarCap { /** Show/Hides the error bar cap. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Width of the error bar cap. - * @Default {1} - */ + * @Default {1} + */ width?: number; /** Length of the error bar cap. - * @Default {1} - */ + * @Default {1} + */ length?: number; /** Color of the error bar cap. - * @Default {Ă¢â‚¬Å“#000000Ă¢â‚¬Â} - */ + * @Default {Ă¢â‚¬Å“#000000Ă¢â‚¬Â} + */ fill?: string; } export interface CommonSeriesOptionsErrorBar { /** Show/hides the error bar - * @Default {visible} - */ + * @Default {visible} + */ visibility?: boolean; /** Specifies the type of error bar. - * @Default {FixedValue} - */ + * @Default {FixedValue} + */ type?: ej.datavisualization.Chart.ErrorBarType|string; /** Specifies the mode of error bar. - * @Default {vertical} - */ + * @Default {vertical} + */ mode?: ej.datavisualization.Chart.ErrorBarMode|string; /** Specifies the direction of error bar. - * @Default {both} - */ + * @Default {both} + */ direction?: ej.datavisualization.Chart.ErrorBarDirection|string; /** Value of vertical error bar. - * @Default {3} - */ + * @Default {3} + */ verticalErrorValue?: number; /** Value of horizontal error bar. - * @Default {1} - */ + * @Default {1} + */ horizontalErrorValue?: number; /** Value of positive horizontal error bar. - * @Default {1} - */ + * @Default {1} + */ horizontalPositiveErrorValue?: number; /** Value of negative horizontal error bar. - * @Default {1} - */ + * @Default {1} + */ horizontalNegativeErrorValue?: number; /** Value of positive vertical error bar. - * @Default {5} - */ + * @Default {5} + */ verticalPositiveErrorValue?: number; /** Value of negative vertical error bar. - * @Default {5} - */ + * @Default {5} + */ verticalNegativeErrorValue?: number; /** Fill color of the error bar. - * @Default {#000000} - */ + * @Default {#000000} + */ fill?: string; /** Width of the error bar. - * @Default {1} - */ + * @Default {1} + */ width?: number; /** Options for customizing the error bar cap. - */ + */ cap?: CommonSeriesOptionsErrorBarCap; } export interface CommonSeriesOptionsTrendline { /** Show/hides the trendline. - */ + */ visibility?: boolean; /** Specifies the type of the trendline for the series. - * @Default {linear. See TrendlinesType} - */ + * @Default {linear. See TrendlinesType} + */ type?: string; /** Name for the trendlines that is to be displayed in the legend text. - * @Default {trendline} - */ + * @Default {trendline} + */ name?: string; /** Fill color of the trendlines. - * @Default {#0000FF} - */ + * @Default {#0000FF} + */ fill?: string; /** Width of the trendlines. - * @Default {1} - */ + * @Default {1} + */ width?: number; /** Opacity of the trendline. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Pattern of dashes and gaps used to stroke the trendline. - */ + */ dashArray?: string; /** Future trends of the current series. - * @Default {0} - */ + * @Default {0} + */ forwardForecast?: number; /** Past trends of the current series. - * @Default {0} - */ + * @Default {0} + */ backwardForecast?: number; /** Specifies the order of the polynomial trendlines. - * @Default {0} - */ + * @Default {0} + */ polynomialOrder?: number; /** Specifies the moving average starting period value. - * @Default {2} - */ + * @Default {2} + */ period?: number; } export interface CommonSeriesOptionsHighlightSettingsBorder { /** Border color of the series/point on highlight. - */ + */ color?: string; /** Border width of the series/point on highlight. - * @Default {2} - */ + * @Default {2} + */ width?: string; } export interface CommonSeriesOptionsHighlightSettings { /** Enables/disables the ability to highlight the series or data point interactively. - * @Default {false} - */ + * @Default {false} + */ enable?: boolean; /** Specifies whether the series or data point has to be highlighted. - * @Default {series. See Mode} - */ + * @Default {series. See Mode} + */ mode?: ej.datavisualization.Chart.Mode|string; /** Color of the series/point on highlight. - */ + */ color?: string; /** Opacity of the series/point on highlight. - * @Default {0.6} - */ + * @Default {0.6} + */ opacity?: number; /** Options for customizing the border of series on highlight. - */ + */ border?: CommonSeriesOptionsHighlightSettingsBorder; /** Specifies the pattern for the series/point on highlight. - * @Default {none. See Pattern} - */ + * @Default {none. See Pattern} + */ pattern?: string; /** Custom pattern for the series on highlight. - */ + */ customPattern?: string; } export interface CommonSeriesOptionsSelectionSettingsBorder { /** Border color of the series/point on selection. - */ + */ color?: string; /** Border width of the series/point on selection. - * @Default {2} - */ + * @Default {2} + */ width?: string; } export interface CommonSeriesOptionsSelectionSettings { /** Enables/disables the ability to select a series/data point interactively. - * @Default {false} - */ + * @Default {false} + */ enable?: boolean; /** Specifies the type of selection. - * @Default {single} - */ + * @Default {single} + */ type?: ej.datavisualization.Chart.SelectionType|string; /** Specifies whether the series or data point has to be selected. - * @Default {series. See Mode} - */ + * @Default {series. See Mode} + */ mode?: ej.datavisualization.Chart.Mode|string; /** Specifies the drawn rectangle type. - * @Default {xy} - */ + * @Default {xy} + */ rangeType?: ej.datavisualization.Chart.RangeType|string; /** Color of the series/point on selection. - */ + */ color?: string; /** Opacity of the series/point on selection. - * @Default {0.6} - */ + * @Default {0.6} + */ opacity?: number; /** Options for customizing the border of the series on selection. - */ + */ border?: CommonSeriesOptionsSelectionSettingsBorder; /** Specifies the pattern for the series/point on selection. - * @Default {none. See Pattern} - */ + * @Default {none. See Pattern} + */ pattern?: string; /** Custom pattern for the series on selection. - */ + */ customPattern?: string; } export interface CommonSeriesOptions { /** Options to customize the border of all the series. - */ + */ border?: CommonSeriesOptionsBorder; /** To render the column and bar type series in rectangle/cylinder shape. See ColumnFacet - * @Default {rectangle} - */ + * @Default {rectangle} + */ columnFacet?: ej.datavisualization.Chart.ColumnFacet|string; /** Relative width of the columns in column type series. Value ranges from 0 to 1. Width also depends upon columnSpacing property. - * @Default {0.7} - */ + * @Default {0.7} + */ columnWidth?: number; /** Spacing between columns of different series. Value ranges from 0 to 1 - * @Default {0} - */ + * @Default {0} + */ columnSpacing?: number; /** Enables or disables the visibility of legend item. - * @Default {visible} - */ + * @Default {visible} + */ visibleOnLegend?: string; /** Group of the stacking collection series. - */ + */ stackingGroup?: string; /** Pattern of dashes and gaps used to stroke all the line type series. - */ + */ dashArray?: string; /** Set the dataSource for all series. It can be an array of JSON objects or an instance of ej.DataManager. - * @Default {null} - */ + * @Default {null} + */ dataSource?: any; /** Controls the size of the hole in doughnut series. Value ranges from 0 to 1 - * @Default {0.4} - */ + * @Default {0.4} + */ doughnutCoefficient?: number; /** Controls the size of the doughnut series. Value ranges from 0 to 1. - * @Default {0.8} - */ + * @Default {0.8} + */ doughnutSize?: number; /** Specifies the type of series to be drawn in radar or polar series. - * @Default {line. See DrawType} - */ + * @Default {line. See DrawType} + */ drawType?: ej.datavisualization.Chart.DrawType|string; /** Enable/disable the animation for all the series. - * @Default {true} - */ + * @Default {true} + */ enableAnimation?: boolean; /** To avoid overlapping of data labels smartly. - * @Default {true} - */ + * @Default {true} + */ enableSmartLabels?: boolean; /** Start angle of pie/doughnut series. - * @Default {null} - */ + * @Default {null} + */ endAngle?: number; /** Explodes the pie/doughnut slices on mouse move. - * @Default {false} - */ + * @Default {false} + */ explode?: boolean; /** Explodes all the slice of pie/doughnut on render. - * @Default {false} - */ + * @Default {false} + */ explodeAll?: boolean; /** Index of the point to be exploded from pie/doughnut/pyramid/funnel. - * @Default {null} - */ + * @Default {null} + */ explodeIndex?: number; /** Specifies the distance of the slice from the center, when it is exploded. - * @Default {0.4} - */ + * @Default {0.4} + */ explodeOffset?: number; /** Fill color for all the series. - * @Default {null} - */ + * @Default {null} + */ fill?: string; /** Options for customizing the font of all the series. - */ + */ font?: CommonSeriesOptionsFont; /** Sets the height of the funnel in funnel series. Values can be either pixel or percentage. - * @Default {32.7%} - */ + * @Default {32.7%} + */ funnelHeight?: string; /** Sets the width of the funnel in funnel series. Values can be either pixel or percentage. - * @Default {11.6%} - */ + * @Default {11.6%} + */ funnelWidth?: string; /** Gap between the slices in pyramid and funnel series. - * @Default {0} - */ + * @Default {0} + */ gapRatio?: number; /** Specifies whether to join start and end point of a line/area series used in polar/radar chart to form a closed path. - * @Default {true} - */ + * @Default {true} + */ isClosed?: boolean; /** Specifies whether to stack the column series in polar/radar charts. - * @Default {false} - */ + * @Default {false} + */ isStacking?: boolean; /** Renders the chart vertically. This is applicable only for Cartesian type series. - * @Default {false} - */ + * @Default {false} + */ isTransposed?: boolean; /** Render the x mark in the center of the box and whisker series type.x represents the average value of the box and whisker series. - * @Default {true} - */ + * @Default {true} + */ showMedian?: boolean; /** Position of the data label in pie/doughnut/pyramid/funnel series. OutsideExtended position is not applicable for pyramid/funnel. - * @Default {inside. See LabelPosition} - */ + * @Default {inside. See LabelPosition} + */ labelPosition?: ej.datavisualization.Chart.LabelPosition|string; /** Quartile calculation has been performed in three different formulas to render the box and whisker series. - * @Default {exclusive} - */ + * @Default {exclusive} + */ boxPlotMode?: ej.datavisualization.Chart.boxPlotMode|string; /** Specifies the line cap of the series. - * @Default {butt. See LineCap} - */ + * @Default {butt. See LineCap} + */ lineCap?: ej.datavisualization.Chart.LineCap|string; /** Specifies the type of shape to be used where two lines meet. - * @Default {round. See LineJoin} - */ + * @Default {round. See LineJoin} + */ lineJoin?: ej.datavisualization.Chart.LineJoin|string; /** Options for displaying and customizing marker for individual point in a series. Marker contains shapes and/or data labels. - */ + */ marker?: CommonSeriesOptionsMarker; /** Opacity of the series. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Options for customizing the outlier of the series. - */ + */ outlierSettings?: CommonSeriesOptionsOutlierSettings; /** Name of a field in data source, where the fill color for all the data points is generated. - */ + */ palette?: string; /** Controls the size of pie series. Value ranges from 0 to 1. - * @Default {0.8} - */ + * @Default {0.8} + */ pieCoefficient?: number; /** Name of the property in the datasource that contains fill color for the series. - * @Default {null} - */ + * @Default {null} + */ pointColorMappingName?: string; /** Specifies the mode of the pyramid series. - * @Default {linear. See PyramidMode} - */ + * @Default {linear. See PyramidMode} + */ pyramidMode?: ej.datavisualization.Chart.PyramidMode|string; /** Start angle from where the pie/doughnut series renders. By default it starts from 0. - * @Default {null} - */ + * @Default {null} + */ startAngle?: number; /** Options for customizing the corner radius. cornerRadius property also takes the numeric input and applies it for all the four corners of the column. - */ + */ cornerRadius?: CommonSeriesOptionsCornerRadius; /** Options for customizing the tooltip of chart. - */ + */ tooltip?: CommonSeriesOptionsTooltip; /** Specifies the type of the series to render in chart. - * @Default {column. See Type} - */ + * @Default {column. See Type} + */ type?: ej.datavisualization.Chart.Type|string; /** Specifies the name of the x-axis that has to be associated with this series. Add an axis instance with this name to axes collection. - * @Default {null} - */ + * @Default {null} + */ xAxisName?: string; /** Name of the property in the datasource that contains x value for the series. - * @Default {null} - */ + * @Default {null} + */ xName?: string; /** Specifies the name of the y-axis that has to be associated with this series. Add an axis instance with this name to axes collection. - * @Default {null} - */ + * @Default {null} + */ yAxisName?: string; /** Name of the property in the datasource that contains y value for the series. - * @Default {null} - */ + * @Default {null} + */ yName?: string; /** Name of the property in the datasource that contains high value for the series. - * @Default {null} - */ + * @Default {null} + */ high?: string; /** Name of the property in the datasource that contains low value for the series. - * @Default {null} - */ + * @Default {null} + */ low?: string; /** Name of the property in the datasource that contains open value for the series. - * @Default {null} - */ + * @Default {null} + */ open?: string; /** Name of the property in the datasource that contains close value for the series. - * @Default {null} - */ + * @Default {null} + */ close?: string; /** Z-order of the series. - * @Default {0} - */ + * @Default {0} + */ zOrder?: number; /** Name of the property in the datasource that contains the size value for the bubble series. - * @Default {null} - */ + * @Default {null} + */ size?: string; /** Options for customizing the empty point in the series. - */ + */ emptyPointSettings?: CommonSeriesOptionsEmptyPointSettings; /** Fill color for the positive column of the waterfall. - * @Default {null} - */ + * @Default {null} + */ positiveFill?: string; /** Options for customizing the waterfall connector line. - */ + */ connectorLine?: CommonSeriesOptionsConnectorLine; /** Options to customize the drag and drop in series. - */ + */ dragSettings?: CommonSeriesOptionsDragSettings; /** Options to customize the error bar in series. - */ + */ errorBar?: CommonSeriesOptionsErrorBar; /** Option to add the trendlines to chart. - */ + */ trendlines?: CommonSeriesOptionsTrendline[]; /** Options for customizing the appearance of the series or data point while highlighting. - */ + */ highlightSettings?: CommonSeriesOptionsHighlightSettings; /** Options for customizing the appearance of the series/data point on selection. - */ + */ selectionSettings?: CommonSeriesOptionsSelectionSettings; } export interface CrosshairTrackballTooltipSettingsBorder { /** Border width of the trackball tooltip. - * @Default {null} - */ + * @Default {null} + */ width?: number; /** Border color of the trackball tooltip. - * @Default {null} - */ + * @Default {null} + */ color?: string; } export interface CrosshairTrackballTooltipSettings { /** Options for customizing the trackball tooltip border. - */ + */ border?: CrosshairTrackballTooltipSettingsBorder; /** Background color of the trackball tooltip. - * @Default {null} - */ + * @Default {null} + */ fill?: string; /** Rounded corner x value of the trackball tooltip. - * @Default {3} - */ + * @Default {3} + */ rx?: number; /** Rounded corner y value of the trackball tooltip. - * @Default {3} - */ + * @Default {3} + */ ry?: number; /** Opacity value of the trackball tooltip. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Specifies the mode of the trackball tooltip. - * @Default {float. See CrosshairMode} - */ + * @Default {float. See CrosshairMode} + */ mode?: ej.datavisualization.Chart.CrosshairMode|string; } export interface CrosshairMarkerBorder { /** Border width of the marker. - * @Default {3} - */ + * @Default {3} + */ width?: number; } export interface CrosshairMarkerSize { /** Height of the marker. - * @Default {10} - */ + * @Default {10} + */ height?: number; /** Width of the marker. - * @Default {10} - */ + * @Default {10} + */ width?: number; } export interface CrosshairMarker { /** Options for customizing the border. - */ + */ border?: CrosshairMarkerBorder; /** Opacity of the marker. - * @Default {true} - */ + * @Default {true} + */ opacity?: boolean; /** Options for customizing the size of the marker. - */ + */ size?: CrosshairMarkerSize; /** Show/hides the marker. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; } export interface CrosshairLine { /** Color of the crosshair line. - * @Default {transparent} - */ + * @Default {transparent} + */ color?: string; /** Width of the crosshair line. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface Crosshair { /** Options for customizing the trackball tooltip. - */ + */ trackballTooltipSettings?: CrosshairTrackballTooltipSettings; /** Options for customizing the marker in crosshair. - */ + */ marker?: CrosshairMarker; /** Options for customizing the crosshair line. - */ + */ line?: CrosshairLine; /** Specifies the type of the crosshair. It can be trackball or crosshair - * @Default {crosshair. See CrosshairType} - */ + * @Default {crosshair. See CrosshairType} + */ type?: ej.datavisualization.Chart.CrosshairType|string; /** Show/hides the crosshair/trackball visibility. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; } export interface IndicatorsHistogramBorder { /** Color of the histogram border in MACD indicator. - * @Default {#9999ff} - */ + * @Default {#9999ff} + */ color?: string; /** Controls the width of histogram border line in MACD indicator. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface IndicatorsHistogram { /** Options to customize the histogram border in MACD indicator. - */ + */ border?: IndicatorsHistogramBorder; /** Color of histogram columns in MACD indicator. - * @Default {#ccccff} - */ + * @Default {#ccccff} + */ fill?: string; /** Opacity of histogram columns in MACD indicator. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; } export interface IndicatorsLowerLine { /** Color of lower line. - * @Default {#008000} - */ + * @Default {#008000} + */ fill?: string; /** Width of the lower line. - * @Default {2} - */ + * @Default {2} + */ width?: number; } export interface IndicatorsMacdLine { /** Color of MACD line. - * @Default {#ff9933} - */ + * @Default {#ff9933} + */ fill?: string; /** Width of the MACD line. - * @Default {2} - */ + * @Default {2} + */ width?: number; } export interface IndicatorsPeriodLine { /** Color of period line in indicator. - * @Default {blue} - */ + * @Default {blue} + */ fill?: string; /** Width of the period line in indicators. - * @Default {2} - */ + * @Default {2} + */ width?: number; } export interface IndicatorsTooltipBorder { /** Border color of indicator tooltip. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Border width of indicator tooltip. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface IndicatorsTooltip { /** Option to customize the border of indicator tooltip. - */ + */ border?: IndicatorsTooltipBorder; /** Specifies the animation duration of indicator tooltip. - * @Default {500ms} - */ + * @Default {500ms} + */ duration?: string; /** Enables/disables the tooltip animation. - * @Default {true} - */ + * @Default {true} + */ enableAnimation?: boolean; /** Format of indicator tooltip. Use Ă¢â‚¬Å“point.xĂ¢â‚¬Â and Ă¢â‚¬Å“point.yĂ¢â‚¬Â as a placeholder text to display the corresponding data pointĂ¢â‚¬â„¢s x and y value. - * @Default {#point.x# : #point.y#} - */ + * @Default {#point.x# : #point.y#} + */ format?: string; /** Background color of indicator tooltip. - * @Default {null} - */ + * @Default {null} + */ fill?: string; /** Opacity of indicator tooltip. - * @Default {0.95} - */ + * @Default {0.95} + */ opacity?: number; /** Controls the visibility of indicator tooltip. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; } export interface IndicatorsUpperLine { /** Fill color of the upper line in indicators - * @Default {#ff9933} - */ + * @Default {#ff9933} + */ fill?: string; /** Width of the upper line in indicators. - * @Default {2} - */ + * @Default {2} + */ width?: number; } export interface Indicator { /** The dPeriod value for stochastic indicator. - * @Default {3} - */ + * @Default {3} + */ dPeriod?: number; /** Enables/disables the animation. - * @Default {false} - */ + * @Default {false} + */ enableAnimation?: boolean; /** Color of the technical indicator. - * @Default {#00008B} - */ + * @Default {#00008B} + */ fill?: string; /** Options to customize the histogram in MACD indicator. - */ + */ histogram?: IndicatorsHistogram; /** Specifies the k period in stochastic indicator. - * @Default {3} - */ + * @Default {3} + */ kPeriod?: number; /** Specifies the long period in MACD indicator. - * @Default {26} - */ + * @Default {26} + */ longPeriod?: number; /** Options to customize the lower line in indicators. - */ + */ lowerLine?: IndicatorsLowerLine; /** Options to customize the MACD line. - */ + */ macdLine?: IndicatorsMacdLine; /** Specifies the type of the MACD indicator. - * @Default {line. See MACDType} - */ + * @Default {line. See MACDType} + */ macdType?: string; /** Specifies period value in indicator. - * @Default {14} - */ + * @Default {14} + */ period?: number; /** Options to customize the period line in indicators. - */ + */ periodLine?: IndicatorsPeriodLine; /** Name of the series for which indicator has to be drawn. - */ + */ seriesName?: string; /** Specifies the short period in MACD indicator. - * @Default {13} - */ + * @Default {13} + */ shortPeriod?: number; /** Specifies the standard deviation value for Bollinger band indicator. - * @Default {2} - */ + * @Default {2} + */ standardDeviations?: number; /** Options to customize the tooltip. - */ + */ tooltip?: IndicatorsTooltip; /** Trigger value of MACD indicator. - * @Default {9} - */ + * @Default {9} + */ trigger?: number; /** Specifies the visibility of indicator. - * @Default {visible} - */ + * @Default {visible} + */ visibility?: string; /** Specifies the type of indicator that has to be rendered. - * @Default {sma. See IndicatorsType} - */ + * @Default {sma. See IndicatorsType} + */ type?: string; /** Options to customize the upper line in indicators - */ + */ upperLine?: IndicatorsUpperLine; /** Width of the indicator line. - * @Default {2} - */ + * @Default {2} + */ width?: number; /** Name of the horizontal axis used for indicator. Primary X axis is used when x axis name is not specified. - */ + */ xAxisName?: string; /** Name of the vertical axis used for indicator. Primary Y axis is used when y axis name is not specified - */ + */ yAxisName?: string; } export interface LegendBorder { /** Border color of the legend. - * @Default {transparent} - */ + * @Default {transparent} + */ color?: string; /** Border width of the legend. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface LegendFont { /** Font family for legend item text. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style for legend item text. - * @Default {Normal. See FontStyle} - */ + * @Default {Normal. See FontStyle} + */ fontStyle?: ej.datavisualization.Chart.FontStyle|string; /** Font weight for legend item text. - * @Default {Regular. See FontWeight} - */ + * @Default {Regular. See FontWeight} + */ fontWeight?: ej.datavisualization.Chart.FontWeight|string; /** Font size for legend item text. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface LegendItemStyleBorder { /** Border color of the legend items. - * @Default {transparent} - */ + * @Default {transparent} + */ color?: string; /** Border width of the legend items. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface LegendItemStyle { /** Options for customizing the border of legend items. - */ + */ border?: LegendItemStyleBorder; /** Height of the shape in legend items. - * @Default {10} - */ + * @Default {10} + */ height?: number; /** Width of the shape in legend items. - * @Default {10} - */ + * @Default {10} + */ width?: number; } export interface LegendLocation { /** X value or horizontal offset to position the legend in chart. - * @Default {0} - */ + * @Default {0} + */ x?: number; /** Y value or vertical offset to position the legend. - * @Default {0} - */ + * @Default {0} + */ y?: number; } export interface LegendSize { /** Height of the legend. Height can be specified in either pixel or percentage. - * @Default {null} - */ + * @Default {null} + */ height?: string; /** Width of the legend. Width can be specified in either pixel or percentage. - * @Default {null} - */ + * @Default {null} + */ width?: string; } export interface LegendTitleFont { /** Font family for the text in legend title. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style for legend title. - * @Default {normal. See FontStyle} - */ + * @Default {normal. See FontStyle} + */ fontStyle?: ej.datavisualization.Chart.FontStyle|string; /** Font weight for legend title. - * @Default {normal. See FontWeight} - */ + * @Default {normal. See FontWeight} + */ fontWeight?: ej.datavisualization.Chart.FontWeight|string; /** Font size for legend title. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface LegendTitle { /** Options to customize the font used for legend title - */ + */ font?: LegendTitleFont; /** Text to be displayed in legend title. - */ + */ text?: string; /** Alignment of the legend title. - * @Default {center. See Alignment} - */ + * @Default {center. See Alignment} + */ textAlignment?: ej.datavisualization.Chart.Alignment|string; } export interface Legend { /** Horizontal alignment of the legend. - * @Default {Center. See Alignment} - */ + * @Default {Center. See Alignment} + */ alignment?: ej.datavisualization.Chart.Alignment|string; /** Background for the legend. Use this property to add a background image or background color for the legend. - */ + */ background?: string; /** Options for customizing the legend border. - */ + */ border?: LegendBorder; /** Number of columns to arrange the legend items. - * @Default {null} - */ + * @Default {null} + */ columnCount?: number; /** Controls whether legend has to use scrollbar or not. When enabled, scroll bar appears depending upon size and position properties of legend. - * @Default {true} - */ + * @Default {true} + */ enableScrollbar?: boolean; /** Fill color for the legend items. By using this property, it displays all legend item shapes in same color.Legend items representing invisible series is displayed in gray color. - * @Default {null} - */ + * @Default {null} + */ fill?: string; /** Options to customize the font used for legend item text. - */ + */ font?: LegendFont; /** Gap or padding between the legend items. - * @Default {10} - */ + * @Default {10} + */ itemPadding?: number; /** Options to customize the style of legend items. - */ + */ itemStyle?: LegendItemStyle; /** Options to customize the location of chart legend. Legend is placed in provided location only when value of position property is custom - */ + */ location?: LegendLocation; /** Opacity of the legend. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Places the legend at specified position. Legend can be placed at left, right, top or bottom of the chart area.To manually specify the location of legend, set custom as value to this property. - * @Default {Bottom. See Position} - */ + * @Default {Bottom. See Position} + */ position?: ej.datavisualization.Chart.Position|string; /** Number of rows to arrange the legend items. - * @Default {null} - */ + * @Default {null} + */ rowCount?: number; /** Shape of the legend items. Default shape for pie and doughnut series is circle and all other series uses rectangle. - * @Default {None. See Shape} - */ + * @Default {None. See Shape} + */ shape?: ej.datavisualization.Chart.Shape|string; /** Options to customize the size of the legend. - */ + */ size?: LegendSize; /** Options to customize the legend title. - */ + */ title?: LegendTitle; /** Specifies the action taken when the legend width is more than the textWidth. - * @Default {none. See textOverflow} - */ + * @Default {none. See textOverflow} + */ textOverflow?: ej.datavisualization.Chart.TextOverflow|string; /** Text width for legend item. - * @Default {34} - */ + * @Default {34} + */ textWidth?: number; /** Controls the visibility of the legend. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; } export interface PrimaryXAxisAlternateGridBandEven { /** Fill color for the even grid bands. - * @Default {transparent} - */ + * @Default {transparent} + */ fill?: string; /** Opacity of the even grid band. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; } export interface PrimaryXAxisAlternateGridBandOdd { /** Fill color of the odd grid bands - * @Default {transparent} - */ + * @Default {transparent} + */ fill?: string; /** Opacity of odd grid band - * @Default {1} - */ + * @Default {1} + */ opacity?: number; } export interface PrimaryXAxisAlternateGridBand { /** Options for customizing even grid band. - */ + */ even?: PrimaryXAxisAlternateGridBandEven; /** Options for customizing odd grid band. - */ + */ odd?: PrimaryXAxisAlternateGridBandOdd; } export interface PrimaryXAxisAxisLine { /** Pattern of dashes and gaps to be applied to the axis line. - * @Default {null} - */ + * @Default {null} + */ dashArray?: string; /** Padding for axis line. Normally, it is used along with plotOffset to pad the plot area. - * @Default {null} - */ + * @Default {null} + */ offset?: number; /** Show/hides the axis line. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Default Value - */ + */ color?: string; /** Width of axis line. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface PrimaryXAxisCrosshairLabel { /** Show/hides the crosshair label associated with this axis. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; } export interface PrimaryXAxisFont { /** Font family of labels. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style of labels. - * @Default {ej.datavisualization.Chart.FontStyle.Normal. See FontStyle} - */ + * @Default {ej.datavisualization.Chart.FontStyle.Normal. See FontStyle} + */ fontStyle?: ej.datavisualization.Chart.FontStyle|string; /** Font weight of the label. - * @Default {ej.datavisualization.Chart.FontWeight.Regular. See FontWeight} - */ + * @Default {ej.datavisualization.Chart.FontWeight.Regular. See FontWeight} + */ fontWeight?: ej.datavisualization.Chart.FontWeight|string; /** Opacity of the axis labels. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font size of the axis labels. - * @Default {13px} - */ + * @Default {13px} + */ size?: string; } export interface PrimaryXAxisMajorGridLines { /** Pattern of dashes and gaps used to stroke the major grid lines. - * @Default {null} - */ + * @Default {null} + */ dashArray?: string; /** Color of the major grid line. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Opacity of major grid lines. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Show/hides the major grid lines. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Width of the major grid lines. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface PrimaryXAxisMajorTickLines { /** Length of the major tick lines. - * @Default {5} - */ + * @Default {5} + */ size?: number; /** Show/hides the major tick lines. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Width of the major tick lines. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface PrimaryXAxisMinorGridLines { /** Patterns of dashes and gaps used to stroke the minor grid lines. - * @Default {null} - */ + * @Default {null} + */ dashArray?: string; /** Show/hides the minor grid lines. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Width of the minorGridLines. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface PrimaryXAxisMinorTickLines { /** Length of the minor tick lines. - * @Default {5} - */ + * @Default {5} + */ size?: number; /** Show/hides the minor tick lines. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Width of the minor tick line. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface PrimaryXAxisRange { /** Minimum value of the axis range. - * @Default {null} - */ + * @Default {null} + */ min?: number; /** Maximum value of the axis range. - * @Default {null} - */ + * @Default {null} + */ max?: number; /** Interval of the axis range. - * @Default {null} - */ + * @Default {null} + */ interval?: number; } export interface PrimaryXAxisMultiLevelLabelsFont { /** Font color of the multi level labels text. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Font family of the multi level labels text. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style of the multi level labels text. - * @Default {Normal} - */ + * @Default {Normal} + */ fontStyle?: ej.datavisualization.Chart.FontStyle|string; /** Font weight of the multi level label text. - * @Default {regular} - */ + * @Default {regular} + */ fontWeight?: string; /** Opacity of the multi level label text. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font size of the multi level label text. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface PrimaryXAxisMultiLevelLabelsBorder { /** Border color of the multi level labels. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Border width of the multi level labels. - * @Default {1} - */ + * @Default {1} + */ width?: number; /** Border type of the multi level labels. - * @Default {rectangle. See Type} - */ + * @Default {rectangle. See Type} + */ type?: ej.datavisualization.Chart.MultiLevelLabelsBorderType|string; } export interface PrimaryXAxisMultiLevelLabel { /** Visibility of the multi level labels. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; /** Text of the multi level labels. - */ + */ text?: string; /** Starting value of the multi level labels. - * @Default {null} - */ + * @Default {null} + */ start?: number; /** Ending value of the multi level labels. - * @Default {null} - */ + * @Default {null} + */ end?: number; /** Specifies the level of multi level labels. - * @Default {0} - */ + * @Default {0} + */ level?: number; /** Specifies the maximum width of the text in multi level labels. - * @Default {null} - */ + * @Default {null} + */ maximumTextWidth?: number; /** Specifies the alignment of the text in multi level labels. - * @Default {center. See TextAlignment} - */ + * @Default {center. See TextAlignment} + */ textAlignment?: ej.datavisualization.Chart.TextAlignment|string; /** Specifies the handling of text over flow in multi level labels. - * @Default {center. See TextOverflow} - */ + * @Default {center. See TextOverflow} + */ textOverflow?: ej.datavisualization.Chart.TextOverflow|string; /** Options for customizing the font of the text. - */ + */ font?: PrimaryXAxisMultiLevelLabelsFont; /** Options for customizing the border of the series. - */ + */ border?: PrimaryXAxisMultiLevelLabelsBorder; } export interface PrimaryXAxisStripLineFont { /** Font color of the strip line text. - * @Default {black} - */ + * @Default {black} + */ color?: string; /** Font family of the strip line text. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style of the strip line text. - * @Default {Normal} - */ + * @Default {Normal} + */ fontStyle?: ej.datavisualization.Chart.FontStyle|string; /** Font weight of the strip line text. - * @Default {regular} - */ + * @Default {regular} + */ fontWeight?: string; /** Opacity of the strip line text. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font size of the strip line text. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface PrimaryXAxisStripLine { /** Border color of the strip line. - * @Default {gray} - */ + * @Default {gray} + */ borderColor?: string; /** Background color of the strip line. - * @Default {gray} - */ + * @Default {gray} + */ color?: string; /** End value of the strip line. - * @Default {null} - */ + * @Default {null} + */ end?: number; /** Options for customizing the font of the text. - */ + */ font?: PrimaryXAxisStripLineFont; /** Start value of the strip line. - * @Default {null} - */ + * @Default {null} + */ start?: number; /** Indicates whether to render the strip line from the minimum/start value of the axis. This property does not work when start property is set. - * @Default {false} - */ + * @Default {false} + */ startFromAxis?: boolean; /** Specifies text to be displayed inside the strip line. - * @Default {stripLine} - */ + * @Default {stripLine} + */ text?: string; /** Specifies the alignment of the text inside the strip line. - * @Default {middlecenter. See TextAlignment} - */ + * @Default {middlecenter. See TextAlignment} + */ textAlignment?: ej.datavisualization.Chart.TextAlignment|string; /** Show/hides the strip line. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; /** Width of the strip line. - * @Default {0} - */ + * @Default {0} + */ width?: number; /** Specifies the order where the strip line and the series have to be rendered. When Z-order is Ă¢â‚¬Å“behindĂ¢â‚¬Â, strip line is rendered - * under the series and when it is Ă¢â‚¬Å“overĂ¢â‚¬Â, it is rendered above the series. - * @Default {over. See ZIndex} - */ + * under the series and when it is Ă¢â‚¬Å“overĂ¢â‚¬Â, it is rendered above the series. + * @Default {over. See ZIndex} + */ zIndex?: ej.datavisualization.Chart.ZIndex|string; } export interface PrimaryXAxisLabelBorder { /** Specifies the color of the label border. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Specifies the width of the label border. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface PrimaryXAxisTitleFont { /** Font family of the title text. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style of the title text. - * @Default {ej.datavisualization.Chart.FontStyle.Normal} - */ + * @Default {ej.datavisualization.Chart.FontStyle.Normal} + */ fontStyle?: ej.datavisualization.Chart.FontStyle|string; /** Font weight of the title text. - * @Default {ej.datavisualization.Chart.FontWeight.Regular. See FontWeight} - */ + * @Default {ej.datavisualization.Chart.FontWeight.Regular. See FontWeight} + */ fontWeight?: ej.datavisualization.Chart.FontWeight|string; /** Opacity of the axis title text. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font size of the axis title. - * @Default {16px} - */ + * @Default {16px} + */ size?: string; } export interface PrimaryXAxisTitle { /** Specifies whether to trim the axis title when it exceeds the chart area or the maximum width of the title. - * @Default {false} - */ + * @Default {false} + */ enableTrim?: boolean; /** Options for customizing the title font. - */ + */ font?: PrimaryXAxisTitleFont; /** Maximum width of the title, when the title exceeds this width, the title gets trimmed, when enableTrim is true. - * @Default {34} - */ + * @Default {34} + */ maximumTitleWidth?: number; /** Title for the axis. - */ + */ text?: string; /** Controls the visibility of axis title. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** offset value for axis title. - * @Default {0} - */ + * @Default {0} + */ offset?: number; /** Specifies the position of the axis title. - * @Default {outside. See Position} - */ + * @Default {outside. See Position} + */ position?: ej.datavisualization.Chart.LabelPosition|string; /** Specifies the position of the axis title. - * @Default {center. See Alignment} - */ + * @Default {center. See Alignment} + */ alignment?: ej.datavisualization.Chart.TextAlignment|string; } export interface PrimaryXAxis { /** Options for customizing horizontal axis alternate grid band. - */ + */ alternateGridBand?: PrimaryXAxisAlternateGridBand; /** Specifies where horizontal axis should intersect the vertical axis or vice versa. Value should be provided in axis co-ordinates. - * If provided value is greater than the maximum value of crossing axis, then axis will be placed at the opposite side. - * @Default {null} - */ + * If provided value is greater than the maximum value of crossing axis, then axis will be placed at the opposite side. + * @Default {null} + */ crossesAt?: number; /** Name of the axis used for crossing. Vertical axis name should be provided for horizontal axis and vice versa. - * If the provided name does not belongs to a valid axis, then primary X axis or primary Y axis will be used for crossing - * @Default {null} - */ + * If the provided name does not belongs to a valid axis, then primary X axis or primary Y axis will be used for crossing + * @Default {null} + */ crossesInAxis?: string; /** Category axis can also plot points based on index value of data points. Index based plotting can be enabled by setting Ă¢â‚¬ËœisIndexedĂ¢â‚¬â„¢ property to true. - * @Default {false} - */ + * @Default {false} + */ isIndexed?: boolean; /** Options for customizing the axis line. - */ + */ axisLine?: PrimaryXAxisAxisLine; /** Specifies the index of the column where the axis is associated, when the chart area is divided into multiple plot areas by using columnDefinitions. - * @Default {null} - */ + * @Default {null} + */ columnIndex?: number; /** Specifies the number of columns or plot areas an axis has to span horizontally. - * @Default {null} - */ + * @Default {null} + */ columnSpan?: number; /** Options to customize the crosshair label. - */ + */ crosshairLabel?: PrimaryXAxisCrosshairLabel; /** With this setting, you can request axis to calculate intervals approximately equal to your desired interval. - * @Default {null} - */ + * @Default {null} + */ desiredIntervals?: number; /** Specifies the placement of labels. - * @Default {ej.datavisualization.Chart.LabelPlacement.BetweenTicks. See LabelPlacement} - */ + * @Default {ej.datavisualization.Chart.LabelPlacement.BetweenTicks. See LabelPlacement} + */ labelPlacement?: ej.datavisualization.Chart.LabelPlacement|string; /** Specifies the position of labels at the edge of the axis. - * @Default {ej.datavisualization.Chart.EdgeLabelPlacement.None. See EdgeLabelPlacement} - */ + * @Default {ej.datavisualization.Chart.EdgeLabelPlacement.None. See EdgeLabelPlacement} + */ edgeLabelPlacement?: ej.datavisualization.Chart.EdgeLabelPlacement|string; /** Specifies whether to trim the axis label when the width of the label exceeds the maximumLabelWidth. - * @Default {false} - */ + * @Default {false} + */ enableTrim?: boolean; /** Options for customizing the font of the axis Labels. - */ + */ font?: PrimaryXAxisFont; /** Specifies the type of interval in date time axis. - * @Default {null. See IntervalType} - */ + * @Default {null. See IntervalType} + */ intervalType?: ej.datavisualization.Chart.IntervalType|string; /** Specifies whether to inverse the axis. - * @Default {false} - */ + * @Default {false} + */ isInversed?: boolean; /** Custom formatting for axis label and supports all standard formatting type of numerical and date time values. - * @Default {null} - */ + * @Default {null} + */ labelFormat?: string; /** Specifies the action to take when the axis labels are overlapping with each other. - * @Default {ej.datavisualization.Chart.LabelIntersectAction.None. See LabelIntersectAction} - */ + * @Default {ej.datavisualization.Chart.LabelIntersectAction.None. See LabelIntersectAction} + */ labelIntersectAction?: ej.datavisualization.Chart.LabelIntersectAction|string; /** Specifies the position of the axis labels. - * @Default {outside. See LabelPosition} - */ + * @Default {outside. See LabelPosition} + */ labelPosition?: ej.datavisualization.Chart.LabelPosition|string; /** Specifies the position of the axis labels. - * @Default {center. See Alignment} - */ + * @Default {center. See Alignment} + */ alignment?: ej.datavisualization.Chart.LabelAlignment|string; /** Angle in degrees to rotate the axis labels. - * @Default {null} - */ + * @Default {null} + */ labelRotation?: number; /** Logarithmic base value. This is applicable only for logarithmic axis. - * @Default {10} - */ + * @Default {10} + */ logBase?: number; /** Options for customizing major gird lines. - */ + */ majorGridLines?: PrimaryXAxisMajorGridLines; /** Options for customizing the major tick lines. - */ + */ majorTickLines?: PrimaryXAxisMajorTickLines; /** Maximum number of labels to be displayed in every 100 pixels. - * @Default {3} - */ + * @Default {3} + */ maximumLabels?: number; /** Maximum width of the axis label. When the label exceeds the width, the label gets trimmed when the enableTrim is set to true. - * @Default {34} - */ + * @Default {34} + */ maximumLabelWidth?: number; /** Options for customizing the minor grid lines. - */ + */ minorGridLines?: PrimaryXAxisMinorGridLines; /** Options for customizing the minor tick lines. - */ + */ minorTickLines?: PrimaryXAxisMinorTickLines; /** Specifies the number of minor ticks per interval. - * @Default {null} - */ + * @Default {null} + */ minorTicksPerInterval?: number; /** Unique name of the axis. To associate an axis with the series, you have to set this name to the xAxisName/yAxisName property of the series. - * @Default {null} - */ + * @Default {null} + */ name?: string; /** Specifies whether to render the axis at the opposite side of its default position. - * @Default {false} - */ + * @Default {false} + */ opposedPosition?: boolean; /** Specifies the padding for the plot area. - * @Default {10} - */ + * @Default {10} + */ plotOffset?: number; /** Options to customize the range of the axis. - */ + */ range?: PrimaryXAxisRange; /** Specifies the padding for the axis range. - * @Default {None. See RangePadding} - */ + * @Default {None. See RangePadding} + */ rangePadding?: ej.datavisualization.Chart.RangePadding|string; /** Rounds the number to the given number of decimals. - * @Default {null} - */ + * @Default {null} + */ roundingPlaces?: number; /** Options for customizing the multi level labels. - * @Default {[ ]} - */ + * @Default {[ ]} + */ multiLevelLabels?: PrimaryXAxisMultiLevelLabel[]; /** Options for customizing the strip lines. - * @Default {[ ]} - */ + * @Default {[ ]} + */ stripLine?: PrimaryXAxisStripLine[]; /** Specifies the position of the axis tick lines. - * @Default {outside. See TickLinesPosition} - */ + * @Default {outside. See TickLinesPosition} + */ tickLinesPosition?: ej.datavisualization.Chart.TickLinesPosition|string; /** Options for customizing the border of the labels. - */ + */ labelBorder?: PrimaryXAxisLabelBorder; /** Options for customizing the axis title. - */ + */ title?: PrimaryXAxisTitle; /** Specifies the type of data the axis is handling. - * @Default {null. See ValueType} - */ + * @Default {null. See ValueType} + */ valueType?: ej.datavisualization.Chart.ValueType|string; /** Show/hides the axis. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** The axis is scaled by this factor. When zoomFactor is 0.5, the chart is scaled by 200% along this axis. Value ranges from 0 to 1. - * @Default {1} - */ + * @Default {1} + */ zoomFactor?: number; /** Position of the zoomed axis. Value ranges from 0 to 1. - * @Default {0} - */ + * @Default {0} + */ zoomPosition?: number; } export interface AxesAlternateGridBandEven { /** Fill color for the even grid bands. - * @Default {transparent} - */ + * @Default {transparent} + */ fill?: string; /** Opacity of the even grid band. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; } export interface AxesAlternateGridBandOdd { /** Fill color of the odd grid bands - * @Default {transparent} - */ + * @Default {transparent} + */ fill?: string; /** Opacity of odd grid band - * @Default {1} - */ + * @Default {1} + */ opacity?: number; } export interface AxesAlternateGridBand { /** Options for customizing even grid band. - */ + */ even?: AxesAlternateGridBandEven; /** Options for customizing odd grid band. - */ + */ odd?: AxesAlternateGridBandOdd; } export interface AxesAxisLine { /** Pattern of dashes and gaps to be applied to the axis line. - * @Default {null} - */ + * @Default {null} + */ dashArray?: string; /** Padding for axis line. Normally, it is used along with plotOffset to pad the plot area. - * @Default {null} - */ + * @Default {null} + */ offset?: number; /** Show/hides the axis line. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Color of axis line. - */ + */ color?: string; /** Width of axis line. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface AxesCrosshairLabel { /** Show/hides the crosshair label associated with this axis. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; } export interface AxesFont { /** Font family of labels. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style of labels. - * @Default {ej.datavisualization.Chart.FontStyle.Normal. See FontStyle} - */ + * @Default {ej.datavisualization.Chart.FontStyle.Normal. See FontStyle} + */ fontStyle?: ej.datavisualization.Chart.FontStyle|string; /** Font weight of the label. - * @Default {ej.datavisualization.Chart.FontWeight.Regular. See FontWeight} - */ + * @Default {ej.datavisualization.Chart.FontWeight.Regular. See FontWeight} + */ fontWeight?: ej.datavisualization.Chart.FontWeight|string; /** Opacity of the axis labels. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font size of the axis labels. - * @Default {13px} - */ + * @Default {13px} + */ size?: string; } export interface AxesMajorGridLines { /** Pattern of dashes and gaps used to stroke the major grid lines. - * @Default {null} - */ + * @Default {null} + */ dashArray?: string; /** Color of the major grid line. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Opacity of major grid lines. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Show/hides the major grid lines. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Width of the major grid lines. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface AxesMajorTickLines { /** Length of the major tick lines. - * @Default {5} - */ + * @Default {5} + */ size?: number; /** Show/hides the major tick lines. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Width of the major tick lines. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface AxesMinorGridLines { /** Patterns of dashes and gaps used to stroke the minor grid lines. - * @Default {null} - */ + * @Default {null} + */ dashArray?: string; /** Show/hides the minor grid lines. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Width of the minorGridLines. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface AxesMinorTickLines { /** Length of the minor tick lines. - * @Default {5} - */ + * @Default {5} + */ size?: number; /** Show/hides the minor tick lines. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Width of the minor tick line. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface AxesRange { /** Minimum value of the axis range. - * @Default {null} - */ + * @Default {null} + */ min?: number; /** Maximum value of the axis range. - * @Default {null} - */ + * @Default {null} + */ max?: number; /** Interval of the axis range. - * @Default {null} - */ + * @Default {null} + */ interval?: number; } export interface AxesMultiLevelLabelsFont { /** Font color of the multi level labels text. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Font family of the multi level labels text. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style of the multi level labels text. - * @Default {Normal} - */ + * @Default {Normal} + */ fontStyle?: ej.datavisualization.Chart.FontStyle|string; /** Font weight of the multi level label text. - * @Default {regular} - */ + * @Default {regular} + */ fontWeight?: string; /** Opacity of the multi level label text. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font size of the multi level label text. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface AxesMultiLevelLabelsBorder { /** Border color of the multi level labels. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Border width of the multi level labels. - * @Default {1} - */ + * @Default {1} + */ width?: number; /** Border type of the multi level labels. - * @Default {rectangle. See Type} - */ + * @Default {rectangle. See Type} + */ type?: ej.datavisualization.Chart.MultiLevelLabelsBorderType|string; } export interface AxesMultiLevelLabel { /** Visibility of the multi level labels. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; /** Text of the multi level labels. - */ + */ text?: string; /** Starting value of the multi level labels. - * @Default {null} - */ + * @Default {null} + */ start?: number; /** Ending value of the multi level labels. - * @Default {null} - */ + * @Default {null} + */ end?: number; /** Specifies the level of multi level labels. - * @Default {0} - */ + * @Default {0} + */ level?: number; /** Specifies the maximum width of the text in multi level labels. - * @Default {null} - */ + * @Default {null} + */ maximumTextWidth?: number; /** Specifies the alignment of the text in multi level labels. - * @Default {center. See TextAlignment} - */ + * @Default {center. See TextAlignment} + */ textAlignment?: ej.datavisualization.Chart.TextAlignment|string; /** Specifies the handling of text over flow in multi level labels. - * @Default {center. See TextOverflow} - */ + * @Default {center. See TextOverflow} + */ textOverflow?: ej.datavisualization.Chart.TextOverflow|string; /** Options for customizing the font of the text. - */ + */ font?: AxesMultiLevelLabelsFont; /** Options for customizing the border of the series. - */ + */ border?: AxesMultiLevelLabelsBorder; } export interface AxesStripLineFont { /** Font color of the strip line text. - * @Default {black} - */ + * @Default {black} + */ color?: string; /** Font family of the strip line text. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style of the strip line text. - * @Default {Normal} - */ + * @Default {Normal} + */ fontStyle?: ej.datavisualization.Chart.FontStyle|string; /** Font weight of the strip line text. - * @Default {regular} - */ + * @Default {regular} + */ fontWeight?: string; /** Opacity of the strip line text. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font size of the strip line text. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface AxesStripLine { /** Border color of the strip line. - * @Default {gray} - */ + * @Default {gray} + */ borderColor?: string; /** Background color of the strip line. - * @Default {gray} - */ + * @Default {gray} + */ color?: string; /** End value of the strip line. - * @Default {null} - */ + * @Default {null} + */ end?: number; /** Options for customizing the font of the text. - */ + */ font?: AxesStripLineFont; /** Start value of the strip line. - * @Default {null} - */ + * @Default {null} + */ start?: number; /** Indicates whether to render the strip line from the minimum/start value of the axis. This property does not work when start property is set. - * @Default {false} - */ + * @Default {false} + */ startFromAxis?: boolean; /** Specifies text to be displayed inside the strip line. - * @Default {stripLine} - */ + * @Default {stripLine} + */ text?: string; /** Specifies the alignment of the text inside the strip line. - * @Default {middlecenter. See TextAlignment} - */ + * @Default {middlecenter. See TextAlignment} + */ textAlignment?: ej.datavisualization.Chart.TextAlignment|string; /** Show/hides the strip line. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; /** Width of the strip line. - * @Default {0} - */ + * @Default {0} + */ width?: number; /** Specifies the order where the strip line and the series have to be rendered. When Z-order is Ă¢â‚¬Å“behindĂ¢â‚¬Â, strip line is rendered under the series and when it is Ă¢â‚¬Å“overĂ¢â‚¬Â, - * it is rendered above the series. - * @Default {over. See ZIndex} - */ + * it is rendered above the series. + * @Default {over. See ZIndex} + */ zIndex?: ej.datavisualization.Chart.ZIndex|string; } export interface AxesLabelBorder { /** Specifies the color of the label border. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Specifies the width of the label border. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface AxesTitleFont { /** Font family of the title text. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style of the title text. - * @Default {ej.datavisualization.Chart.FontStyle.Normal} - */ + * @Default {ej.datavisualization.Chart.FontStyle.Normal} + */ fontStyle?: ej.datavisualization.Chart.FontStyle|string; /** Font weight of the title text. - * @Default {ej.datavisualization.Chart.FontWeight.Regular. See FontWeight} - */ + * @Default {ej.datavisualization.Chart.FontWeight.Regular. See FontWeight} + */ fontWeight?: ej.datavisualization.Chart.FontWeight|string; /** Opacity of the axis title text. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font size of the axis title. - * @Default {16px} - */ + * @Default {16px} + */ size?: string; } export interface AxesTitle { /** Specifies whether to trim the axis title when it exceeds the chart area or the maximum width of the title. - * @Default {false} - */ + * @Default {false} + */ enableTrim?: boolean; /** Options for customizing the title font. - */ + */ font?: AxesTitleFont; /** Maximum width of the title, when the title exceeds this width, the title gets trimmed, when enableTrim is true. - * @Default {34} - */ + * @Default {34} + */ maximumTitleWidth?: number; /** Title for the axis. - */ + */ text?: string; /** Controls the visibility of axis title. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** offset value for axis title. - * @Default {0} - */ + * @Default {0} + */ offset?: number; /** Specifies the position of the axis title. - * @Default {outside. See Position} - */ + * @Default {outside. See Position} + */ position?: ej.datavisualization.Chart.LabelPosition|string; /** Specifies the position of the axis title. - * @Default {center. See Alignment} - */ + * @Default {center. See Alignment} + */ alignment?: ej.datavisualization.Chart.TextAlignment|string; } export interface Axis { /** Options for customizing axis alternate grid band. - */ + */ alternateGridBand?: AxesAlternateGridBand; /** Specifies where axis should intersect the vertical axis or vice versa. Value should be provided in axis co-ordinates. If provided value is greater than the maximum value of crossing axis, - * then axis will be placed at the opposite side. - * @Default {null} - */ + * then axis will be placed at the opposite side. + * @Default {null} + */ crossesAt?: number; /** Category axis can also plot points based on index value of data points. Index based plotting can be enabled by setting Ă¢â‚¬ËœisIndexedĂ¢â‚¬â„¢ property to true. - * @Default {false} - */ + * @Default {false} + */ isIndexed?: boolean; /** Options for customizing the axis line. - */ + */ axisLine?: AxesAxisLine; /** Specifies the index of the column where the axis is associated, when the chart area is divided into multiple plot areas by using columnDefinitions. - * @Default {null} - */ + * @Default {null} + */ columnIndex?: number; /** Specifies the number of columns or plot areas an axis has to span horizontally. - * @Default {null} - */ + * @Default {null} + */ columnSpan?: number; /** Options to customize the crosshair label. - */ + */ crosshairLabel?: AxesCrosshairLabel; /** With this setting, you can request axis to calculate intervals approximately equal to your desired interval. - * @Default {null} - */ + * @Default {null} + */ desiredIntervals?: number; /** Specifies the placement of labels. - * @Default {ej.datavisualization.Chart.LabelPlacement.BetweenTicks. See LabelPlacement} - */ + * @Default {ej.datavisualization.Chart.LabelPlacement.BetweenTicks. See LabelPlacement} + */ labelPlacement?: ej.datavisualization.Chart.LabelPlacement|string; /** Specifies the position of labels at the edge of the axis. - * @Default {ej.datavisualization.Chart.EdgeLabelPlacement.None. See EdgeLabelPlacement} - */ + * @Default {ej.datavisualization.Chart.EdgeLabelPlacement.None. See EdgeLabelPlacement} + */ edgeLabelPlacement?: ej.datavisualization.Chart.EdgeLabelPlacement|string; /** Specifies whether to trim the axis label when the width of the label exceeds the maximumLabelWidth. - * @Default {false} - */ + * @Default {false} + */ enableTrim?: boolean; /** Options for customizing the font of the axis Labels. - */ + */ font?: AxesFont; /** Specifies the type of interval in date time axis. - * @Default {null. See IntervalType} - */ + * @Default {null. See IntervalType} + */ intervalType?: ej.datavisualization.Chart.IntervalType|string; /** Specifies whether to inverse the axis. - * @Default {false} - */ + * @Default {false} + */ isInversed?: boolean; /** Custom formatting for axis label and supports all standard formatting type of numerical and date time values. - * @Default {null} - */ + * @Default {null} + */ labelFormat?: string; /** Specifies the action to take when the axis labels are overlapping with each other. - * @Default {ej.datavisualization.Chart.LabelIntersectAction.None. See LabelIntersectAction} - */ + * @Default {ej.datavisualization.Chart.LabelIntersectAction.None. See LabelIntersectAction} + */ labelIntersectAction?: ej.datavisualization.Chart.LabelIntersectAction|string; /** Specifies the position of the axis labels. - * @Default {outside. See LabelPosition} - */ + * @Default {outside. See LabelPosition} + */ labelPosition?: ej.datavisualization.Chart.LabelPosition|string; /** Specifies the position of the axis labels. - * @Default {center. See Alignment} - */ + * @Default {center. See Alignment} + */ alignment?: ej.datavisualization.Chart.LabelAlignment|string; /** Angle in degrees to rotate the axis labels. - * @Default {null} - */ + * @Default {null} + */ labelRotation?: number; /** Logarithmic base value. This is applicable only for logarithmic axis. - * @Default {10} - */ + * @Default {10} + */ logBase?: number; /** Options for customizing major gird lines. - */ + */ majorGridLines?: AxesMajorGridLines; /** Options for customizing the major tick lines. - */ + */ majorTickLines?: AxesMajorTickLines; /** Maximum number of labels to be displayed in every 100 pixels. - * @Default {3} - */ + * @Default {3} + */ maximumLabels?: number; /** Maximum width of the axis label. When the label exceeds the width, the label gets trimmed when the enableTrim is set to true. - * @Default {34} - */ + * @Default {34} + */ maximumLabelWidth?: number; /** Options for customizing the minor grid lines. - */ + */ minorGridLines?: AxesMinorGridLines; /** Options for customizing the minor tick lines. - */ + */ minorTickLines?: AxesMinorTickLines; /** Specifies the number of minor ticks per interval. - * @Default {null} - */ + * @Default {null} + */ minorTicksPerInterval?: number; /** Unique name of the axis. To associate an axis with the series, you have to set this name to the xAxisName/yAxisName property of the series. - * @Default {null} - */ + * @Default {null} + */ name?: string; /** Specifies whether to render the axis at the opposite side of its default position. - * @Default {false} - */ + * @Default {false} + */ opposedPosition?: boolean; /** Specifies the padding for the plot area. - * @Default {10} - */ + * @Default {10} + */ plotOffset?: number; /** Options to customize the range of the axis. - */ + */ range?: AxesRange; /** Specifies the padding for the axis range. - * @Default {None. See RangePadding} - */ + * @Default {None. See RangePadding} + */ rangePadding?: ej.datavisualization.Chart.RangePadding|string; /** Rounds the number to the given number of decimals. - * @Default {null} - */ + * @Default {null} + */ roundingPlaces?: number; /** Options for customizing the multi level labels. - * @Default {[ ]} - */ + * @Default {[ ]} + */ multiLevelLabels?: AxesMultiLevelLabel[]; /** Options for customizing the strip lines. - * @Default {[ ]} - */ + * @Default {[ ]} + */ stripLine?: AxesStripLine[]; /** Specifies the position of the axis tick lines. - * @Default {outside. See TickLinesPosition} - */ + * @Default {outside. See TickLinesPosition} + */ tickLinesPosition?: ej.datavisualization.Chart.TickLinesPosition|string; /** Options for customizing the border of the labels. - */ + */ labelBorder?: AxesLabelBorder; /** Options for customizing the axis title. - */ + */ title?: AxesTitle; /** Specifies the type of data the axis is handling. - * @Default {null. See ValueType} - */ + * @Default {null. See ValueType} + */ valueType?: ej.datavisualization.Chart.ValueType|string; /** Show/hides the axis. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** The axis is scaled by this factor. When zoomFactor is 0.5, the chart is scaled by 200% along this axis. Value ranges from 0 to 1. - * @Default {1} - */ + * @Default {1} + */ zoomFactor?: number; /** Position of the zoomed axis. Value ranges from 0 to 1. - * @Default {0} - */ + * @Default {0} + */ zoomPosition?: number; } export interface PrimaryYAxisAlternateGridBandEven { /** Fill color for the even grid bands. - * @Default {transparent} - */ + * @Default {transparent} + */ fill?: string; /** Opacity of the even grid band. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; } export interface PrimaryYAxisAlternateGridBandOdd { /** Fill color of the odd grid bands. - * @Default {transparent} - */ + * @Default {transparent} + */ fill?: string; /** Opacity of odd grid band. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; } export interface PrimaryYAxisAlternateGridBand { /** Options for customizing even grid band. - */ + */ even?: PrimaryYAxisAlternateGridBandEven; /** Options for customizing odd grid band. - */ + */ odd?: PrimaryYAxisAlternateGridBandOdd; } export interface PrimaryYAxisAxisLine { /** Pattern of dashes and gaps to be applied to the axis line. - * @Default {null} - */ + * @Default {null} + */ dashArray?: string; /** Padding for axis line. Normally, it is used along with plotOffset to pad the plot area. - * @Default {null} - */ + * @Default {null} + */ offset?: number; /** Show/hides the axis line. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Color of axis line. - */ + */ color?: string; /** Width of axis line. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface PrimaryYAxisCrosshairLabel { /** Show/hides the crosshair label associated with this axis. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; } export interface PrimaryYAxisFont { /** Font family of labels. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style of labels. - * @Default {ej.datavisualization.Chart.FontStyle.Normal. See FontStyle} - */ + * @Default {ej.datavisualization.Chart.FontStyle.Normal. See FontStyle} + */ fontStyle?: ej.datavisualization.Chart.FontStyle|string; /** Font weight of the label. - * @Default {ej.datavisualization.Chart.FontWeight.Regular. See FontWeight} - */ + * @Default {ej.datavisualization.Chart.FontWeight.Regular. See FontWeight} + */ fontWeight?: ej.datavisualization.Chart.FontWeight|string; /** Opacity of the axis labels. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font size of the axis labels. - * @Default {13px} - */ + * @Default {13px} + */ size?: string; } export interface PrimaryYAxisMajorGridLines { /** Pattern of dashes and gaps used to stroke the major grid lines. - * @Default {null} - */ + * @Default {null} + */ dashArray?: string; /** Color of the major grid lines. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Opacity of major grid lines. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Show/hides the major grid lines. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Width of the major grid lines. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface PrimaryYAxisMajorTickLines { /** Length of the major tick lines. - * @Default {5} - */ + * @Default {5} + */ size?: number; /** Show/hides the major tick lines. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Width of the major tick lines. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface PrimaryYAxisMinorGridLines { /** Patterns of dashes and gaps used to stroke the minor grid lines. - * @Default {null} - */ + * @Default {null} + */ dashArray?: string; /** Show/hides the minor grid lines. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Width of the minorGridLines. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface PrimaryYAxisMinorTickLines { /** Length of the minor tick lines. - * @Default {5} - */ + * @Default {5} + */ size?: number; /** Show/hides the minor tick lines. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Width of the minor tick line - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface PrimaryYAxisRange { /** Minimum value of the axis range. - * @Default {null} - */ + * @Default {null} + */ min?: number; /** Maximum value of the axis range. - * @Default {null} - */ + * @Default {null} + */ max?: number; /** Interval for the range. - * @Default {null} - */ + * @Default {null} + */ interval?: number; } export interface PrimaryYAxisMultiLevelLabelsFont { /** Font color of the multi level labels text. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Font family of the multi level labels text. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style of the multi level labels text. - * @Default {Normal} - */ + * @Default {Normal} + */ fontStyle?: ej.datavisualization.Chart.FontStyle|string; /** Font weight of the multi level label text. - * @Default {regular} - */ + * @Default {regular} + */ fontWeight?: string; /** Opacity of the multi level label text. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font size of the multi level label text. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface PrimaryYAxisMultiLevelLabelsBorder { /** Border color of the multi level labels. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Border width of the multi level labels. - * @Default {1} - */ + * @Default {1} + */ width?: number; /** Border type of the multi level labels. - * @Default {rectangle. See Type} - */ + * @Default {rectangle. See Type} + */ type?: ej.datavisualization.Chart.MultiLevelLabelsBorderType|string; } export interface PrimaryYAxisMultiLevelLabel { /** Visibility of the multi level labels. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; /** Text of the multi level labels. - */ + */ text?: string; /** Starting value of the multi level labels. - * @Default {null} - */ + * @Default {null} + */ start?: number; /** Ending value of the multi level labels. - * @Default {null} - */ + * @Default {null} + */ end?: number; /** Specifies the level of multi level labels. - * @Default {0} - */ + * @Default {0} + */ level?: number; /** Specifies the maximum width of the text in multi level labels. - * @Default {null} - */ + * @Default {null} + */ maximumTextWidth?: number; /** Specifies the alignment of the text in multi level labels. - * @Default {center. See TextAlignment} - */ + * @Default {center. See TextAlignment} + */ textAlignment?: ej.datavisualization.Chart.TextAlignment|string; /** Specifies the handling of text over flow in multi level labels. - * @Default {center. See TextOverflow} - */ + * @Default {center. See TextOverflow} + */ textOverflow?: ej.datavisualization.Chart.TextOverflow|string; /** Options for customizing the font of the text. - */ + */ font?: PrimaryYAxisMultiLevelLabelsFont; /** Options for customizing the border of the series. - */ + */ border?: PrimaryYAxisMultiLevelLabelsBorder; } export interface PrimaryYAxisStripLineFont { /** Font color of the strip line text. - * @Default {black} - */ + * @Default {black} + */ color?: string; /** Font family of the strip line text. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style of the strip line text. - * @Default {Normal} - */ + * @Default {Normal} + */ fontStyle?: ej.datavisualization.Chart.FontStyle|string; /** Font weight of the strip line text. - * @Default {regular} - */ + * @Default {regular} + */ fontWeight?: string; /** Opacity of the strip line text. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font size of the strip line text. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface PrimaryYAxisStripLine { /** Border color of the strip line. - * @Default {gray} - */ + * @Default {gray} + */ borderColor?: string; /** Background color of the strip line. - * @Default {gray} - */ + * @Default {gray} + */ color?: string; /** End value of the strip line. - * @Default {null} - */ + * @Default {null} + */ end?: number; /** Options for customizing the font of the text. - */ + */ font?: PrimaryYAxisStripLineFont; /** Start value of the strip line. - * @Default {null} - */ + * @Default {null} + */ start?: number; /** Indicates whether to render the strip line from the minimum/start value of the axis. This property wonĂ¢â‚¬â„¢t work when start property is set. - * @Default {false} - */ + * @Default {false} + */ startFromAxis?: boolean; /** Specifies text to be displayed inside the strip line. - * @Default {stripLine} - */ + * @Default {stripLine} + */ text?: string; /** Specifies the alignment of the text inside the strip line. - * @Default {middlecenter. See TextAlignment} - */ + * @Default {middlecenter. See TextAlignment} + */ textAlignment?: ej.datavisualization.Chart.TextAlignment|string; /** Show/hides the strip line. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; /** Width of the strip line. - * @Default {0} - */ + * @Default {0} + */ width?: number; /** Specifies the order in which strip line and the series have to be rendered. When Z-order is Ă¢â‚¬Å“behindĂ¢â‚¬Â, strip line is rendered below the series and - * when it is Ă¢â‚¬Å“overĂ¢â‚¬Â, it is rendered above the series. - * @Default {over. See ZIndex} - */ + * when it is Ă¢â‚¬Å“overĂ¢â‚¬Â, it is rendered above the series. + * @Default {over. See ZIndex} + */ zIndex?: ej.datavisualization.Chart.ZIndex|string; } export interface PrimaryYAxisLabelBorder { /** Specifies the color of the label border. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Specifies the width of the label border. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface PrimaryYAxisTitleFont { /** Font family of the title text. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style of the title text. - * @Default {ej.datavisualization.Chart.FontStyle.Normal} - */ + * @Default {ej.datavisualization.Chart.FontStyle.Normal} + */ fontStyle?: ej.datavisualization.Chart.FontStyle|string; /** Font weight of the title text. - * @Default {ej.datavisualization.Chart.FontWeight.Regular. See FontWeight} - */ + * @Default {ej.datavisualization.Chart.FontWeight.Regular. See FontWeight} + */ fontWeight?: ej.datavisualization.Chart.FontWeight|string; /** Opacity of the axis title text. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font size of the axis title. - * @Default {16px} - */ + * @Default {16px} + */ size?: string; } export interface PrimaryYAxisTitle { /** Specifies whether to trim the axis title when it exceeds the chart area or the maximum width of the title. - * @Default {ej.datavisualization.Chart.enableTrim} - */ + * @Default {ej.datavisualization.Chart.enableTrim} + */ enableTrim?: boolean; /** Options for customizing the title font. - */ + */ font?: PrimaryYAxisTitleFont; /** Maximum width of the title, when the title exceeds this width, the title gets trimmed, when enableTrim is true. - * @Default {ej.datavisualization.Chart.maximumTitleWidth.null} - */ + * @Default {ej.datavisualization.Chart.maximumTitleWidth.null} + */ maximumTitleWidth?: number; /** Title for the axis. - */ + */ text?: string; /** Controls the visibility of axis title. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** offset value for axis title. - * @Default {0} - */ + * @Default {0} + */ offset?: number; /** Specifies the position of the axis title. - * @Default {outside. See Position} - */ + * @Default {outside. See Position} + */ position?: ej.datavisualization.Chart.LabelPosition|string; /** Specifies the position of the axis title. - * @Default {center. See Alignment} - */ + * @Default {center. See Alignment} + */ alignment?: ej.datavisualization.Chart.TextAlignment|string; } export interface PrimaryYAxis { /** Options for customizing vertical axis alternate grid band. - */ + */ alternateGridBand?: PrimaryYAxisAlternateGridBand; /** Options for customizing the axis line. - */ + */ axisLine?: PrimaryYAxisAxisLine; /** Specifies where horizontal axis should intersect the vertical axis or vice versa. Value should be provided in axis co-ordinates. - * If provided value is greater than the maximum value of crossing axis, then axis will be placed at the opposite side. - * @Default {null} - */ + * If provided value is greater than the maximum value of crossing axis, then axis will be placed at the opposite side. + * @Default {null} + */ crossesAt?: number; /** Name of the axis used for crossing. Vertical axis name should be provided for horizontal axis and vice versa. If the provided name does not belongs to a valid axis, - * then primary X axis or primary Y axis will be used for crossing - * @Default {null} - */ + * then primary X axis or primary Y axis will be used for crossing + * @Default {null} + */ crossesInAxis?: string; /** Options to customize the crosshair label. - */ + */ crosshairLabel?: PrimaryYAxisCrosshairLabel; /** With this setting, you can request axis to calculate intervals approximately equal to your desired interval. - * @Default {null} - */ + * @Default {null} + */ desiredIntervals?: number; /** Specifies the placement of labels. - * @Default {ej.datavisualization.Chart.LabelPlacement.BetweenTicks. See LabelPlacement} - */ + * @Default {ej.datavisualization.Chart.LabelPlacement.BetweenTicks. See LabelPlacement} + */ labelPlacement?: ej.datavisualization.Chart.LabelPlacement|string; /** Specifies the position of labels at the edge of the axis. - * @Default {ej.datavisualization.Chart.EdgeLabelPlacement.None. See EdgeLabelPlacement} - */ + * @Default {ej.datavisualization.Chart.EdgeLabelPlacement.None. See EdgeLabelPlacement} + */ edgeLabelPlacement?: ej.datavisualization.Chart.EdgeLabelPlacement|string; /** Specifies whether to trim the axis label when the width of the label exceeds the maximumLabelWidth. - * @Default {false} - */ + * @Default {false} + */ enableTrim?: boolean; /** Options for customizing the font of the axis Labels. - */ + */ font?: PrimaryYAxisFont; /** Specifies the type of interval in date time axis. - * @Default {null. See IntervalType} - */ + * @Default {null. See IntervalType} + */ intervalType?: ej.datavisualization.Chart.IntervalType|string; /** Specifies whether to inverse the axis. - * @Default {false} - */ + * @Default {false} + */ isInversed?: boolean; /** Custom formatting for axis label and supports all standard formatting type of numerical and date time values. - * @Default {null} - */ + * @Default {null} + */ labelFormat?: string; /** Specifies the action to take when the axis labels are overlapping with each other. - * @Default {ej.datavisualization.Chart.LabelIntersectAction.None} - */ + * @Default {ej.datavisualization.Chart.LabelIntersectAction.None} + */ labelIntersectAction?: ej.datavisualization.Chart.LabelIntersectAction|string; /** Specifies the position of the axis labels. - * @Default {outside. See LabelPosition} - */ + * @Default {outside. See LabelPosition} + */ labelPosition?: ej.datavisualization.Chart.LabelPosition|string; /** Specifies the position of the axis labels. - * @Default {center. See Alignment} - */ + * @Default {center. See Alignment} + */ alignment?: ej.datavisualization.Chart.LabelAlignment|string; /** Logarithmic base value. This is applicable only for logarithmic axis. - * @Default {10} - */ + * @Default {10} + */ logBase?: number; /** Options for customizing major gird lines. - */ + */ majorGridLines?: PrimaryYAxisMajorGridLines; /** Options for customizing the major tick lines. - */ + */ majorTickLines?: PrimaryYAxisMajorTickLines; /** Maximum number of labels to be displayed in every 100 pixels. - * @Default {3} - */ + * @Default {3} + */ maximumLabels?: number; /** Maximum width of the axis label. When the label exceeds the width, the label gets trimmed when the enableTrim is set to true. - * @Default {ej.datavisualization.Chart.maximumLabelWidth type {int}} - */ + * @Default {ej.datavisualization.Chart.maximumLabelWidth type {int}} + */ maximumLabelWidth?: number; /** Options for customizing the minor grid lines. - */ + */ minorGridLines?: PrimaryYAxisMinorGridLines; /** Options for customizing the minor tick lines. - */ + */ minorTickLines?: PrimaryYAxisMinorTickLines; /** Specifies the number of minor ticks per interval. - * @Default {null} - */ + * @Default {null} + */ minorTicksPerInterval?: number; /** Unique name of the axis. To associate an axis with the series, you have to set this name to the xAxisName/yAxisName property of the series. - * @Default {null} - */ + * @Default {null} + */ name?: string; /** Specifies whether to render the axis at the opposite side of its default position. - * @Default {false} - */ + * @Default {false} + */ opposedPosition?: boolean; /** Specifies the padding for the plot area. - * @Default {10} - */ + * @Default {10} + */ plotOffset?: number; /** Options to customize the range of the axis. - */ + */ range?: PrimaryYAxisRange; /** Specifies the padding for the axis range. - * @Default {ej.datavisualization.Chart.RangePadding.None. See RangePadding} - */ + * @Default {ej.datavisualization.Chart.RangePadding.None. See RangePadding} + */ rangePadding?: ej.datavisualization.Chart.RangePadding|string; /** Rounds the number to the given number of decimals. - * @Default {null} - */ + * @Default {null} + */ roundingPlaces?: number; /** Specifies the index of the row to which the axis is associated, when the chart area is divided into multiple plot areas by using rowDefinitions. - * @Default {null} - */ + * @Default {null} + */ rowIndex?: number; /** Specifies the number of row or plot areas an axis has to span vertically. - * @Default {null} - */ + * @Default {null} + */ rowSpan?: number; /** Options for customizing the multi level labels. - * @Default {[ ]} - */ + * @Default {[ ]} + */ multiLevelLabels?: PrimaryYAxisMultiLevelLabel[]; /** Options for customizing the strip lines. - * @Default {[ ]} - */ + * @Default {[ ]} + */ stripLine?: PrimaryYAxisStripLine[]; /** Specifies the position of the axis tick lines. - * @Default {outside. See TickLinesPosition} - */ + * @Default {outside. See TickLinesPosition} + */ tickLinesPosition?: ej.datavisualization.Chart.TickLinesPosition|string; /** Options for customizing the border of the labels. - */ + */ labelBorder?: PrimaryYAxisLabelBorder; /** Options for customizing the axis title. - */ + */ title?: PrimaryYAxisTitle; /** Specifies the type of data the axis is handling. - * @Default {null. See ValueType} - */ + * @Default {null. See ValueType} + */ valueType?: ej.datavisualization.Chart.ValueType|string; /** Show/hides the axis. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** The axis is scaled by this factor. When zoomFactor is 0.5, the chart is scaled by 200% along this axis. Values ranges from 0 to 1. - * @Default {1} - */ + * @Default {1} + */ zoomFactor?: number; /** Position of the zoomed axis. Value ranges from 0 to 1 - * @Default {0} - */ + * @Default {0} + */ zoomPosition?: number; } export interface RowDefinition { /** Specifies the unit to measure the height of the row in plotting area. - * @Default {'pixel'. See Unit} - */ + * @Default {'pixel'. See Unit} + */ unit?: ej.datavisualization.Chart.Unit|string; /** Height of the row in plotting area. Height is measured in either pixel or percentage based on the value of unit property. - * @Default {50} - */ + * @Default {50} + */ rowHeight?: number; /** Color of the line that indicates the starting point of the row in plotting area. - * @Default {transparent} - */ + * @Default {transparent} + */ lineColor?: string; /** Width of the line that indicates the starting point of the row in plot area. - * @Default {1} - */ + * @Default {1} + */ lineWidth?: number; } export interface SeriesBorder { /** Border color of the series. - * @Default {transparent} - */ + * @Default {transparent} + */ color?: string; /** Border width of the series. - * @Default {1} - */ + * @Default {1} + */ width?: number; /** DashArray for border of the series. - * @Default {null} - */ + * @Default {null} + */ dashArray?: string; } export interface SeriesFont { /** Font color of the series text. - * @Default {#707070} - */ + * @Default {#707070} + */ color?: string; /** Font Family of the series. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font Style of the series. - * @Default {Normal} - */ + * @Default {Normal} + */ fontStyle?: ej.datavisualization.Chart.FontStyle|string; /** Font weight of the series. - * @Default {Regular} - */ + * @Default {Regular} + */ fontWeight?: ej.datavisualization.Chart.FontWeight|string; /** Opacity of series text. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Size of the series text. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface SeriesMarkerBorder { /** Border color of the marker shape. - * @Default {white} - */ + * @Default {white} + */ color?: string; /** Border width of the marker shape. - * @Default {3} - */ + * @Default {3} + */ width?: number; } export interface SeriesMarkerDataLabelBorder { /** Border color of the data label. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Border width of the data label. - * @Default {0.1} - */ + * @Default {0.1} + */ width?: number; } export interface SeriesMarkerDataLabelConnectorLine { /** Specifies when the connector has to be drawn as Bezier curve or straight line. This is applicable only for Pie and Doughnut chart types. - * @Default {line. See ConnectorLineType} - */ + * @Default {line. See ConnectorLineType} + */ type?: ej.datavisualization.Chart.Type|string; /** Width of the connector. - * @Default {0.5} - */ + * @Default {0.5} + */ width?: number; /** Color of the connector. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Height of the connector. - * @Default {null} - */ + * @Default {null} + */ height?: number; } export interface SeriesMarkerDataLabelFont { /** Font family of the data label. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font color of the data label text. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Font style of the data label. - * @Default {normal. See FontStyle} - */ + * @Default {normal. See FontStyle} + */ fontStyle?: ej.datavisualization.Chart.FontStyle|string; /** Font weight of the data label. - * @Default {regular. See FontWeight} - */ + * @Default {regular. See FontWeight} + */ fontWeight?: ej.datavisualization.Chart.FontWeight|string; /** Opacity of the text. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font size of the data label. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface SeriesMarkerDataLabelMargin { /** Bottom margin of the text. - * @Default {5} - */ + * @Default {5} + */ bottom?: number; /** Left margin of the text. - * @Default {5} - */ + * @Default {5} + */ left?: number; /** Right margin of the text. - * @Default {5} - */ + * @Default {5} + */ right?: number; /** Top margin of the text. - * @Default {5} - */ + * @Default {5} + */ top?: number; } export interface SeriesMarkerDataLabel { /** Angle of the data label in degrees. Only the text gets rotated, whereas the background and border does not rotate. - * @Default {null} - */ + * @Default {null} + */ angle?: number; /** Maximum label width of the data label. - * @Default {null} - */ + * @Default {null} + */ maximumLabelWidth?: number; /** Enable the wrap option to the data label. - * @Default {false} - */ + * @Default {false} + */ enableWrap?: boolean; /** Options for customizing the border of the data label. - */ + */ border?: SeriesMarkerDataLabelBorder; /** Options for displaying and customizing the line that connects point and data label. - */ + */ connectorLine?: SeriesMarkerDataLabelConnectorLine; /** Background color of the data label. - * @Default {null} - */ + * @Default {null} + */ fill?: string; /** Options for customizing the data label font. - */ + */ font?: SeriesMarkerDataLabelFont; /** Horizontal alignment of the data label. - * @Default {center} - */ + * @Default {center} + */ horizontalTextAlignment?: ej.datavisualization.Chart.HorizontalTextAlignment|string; /** Margin of the text to its background shape. The size of the background shape increases based on the margin applied to its text. - */ + */ margin?: SeriesMarkerDataLabelMargin; /** Opacity of the data label. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Background shape of the data label. - * @Default {No shape is rendered by default, so its value is Ă¢â‚¬ËœnoneĂ¢â‚¬â„¢. See Shape} - */ + * @Default {No shape is rendered by default, so its value is Ă¢â‚¬ËœnoneĂ¢â‚¬â„¢. See Shape} + */ shape?: ej.datavisualization.Chart.Shape|string; /** Name of a field in data source where datalabel text is displayed. - */ + */ textMappingName?: string; /** Specifies the position of the data label. This property can be used only for the series such as column, bar, stacked column, stacked bar, 100% stacked column, 100% stacked bar, candle and OHLC. - * @Default {top. See TextPosition} - */ + * @Default {top. See TextPosition} + */ textPosition?: ej.datavisualization.Chart.TextPosition|string; /** Vertical alignment of the data label. - * @Default {'center'} - */ + * @Default {'center'} + */ verticalTextAlignment?: ej.datavisualization.Chart.VerticalTextAlignment|string; /** Controls the visibility of the data labels. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; /** Custom template to format the data label content. Use Ă¢â‚¬Å“point.xĂ¢â‚¬Â and Ă¢â‚¬Å“point.yĂ¢â‚¬Â as a placeholder text to display the corresponding data pointĂ¢â‚¬â„¢s x and y value. - */ + */ template?: string; /** Moves the label vertically by some offset. - * @Default {0} - */ + * @Default {0} + */ offset?: number; } export interface SeriesMarkerSize { /** Height of the marker. - * @Default {6} - */ + * @Default {6} + */ height?: number; /** Width of the marker. - * @Default {6} - */ + * @Default {6} + */ width?: number; } export interface SeriesMarker { /** Options for customizing the border of the marker shape. - */ + */ border?: SeriesMarkerBorder; /** Options for displaying and customizing data labels. - */ + */ dataLabel?: SeriesMarkerDataLabel; /** Color of the marker shape. - * @Default {null} - */ + * @Default {null} + */ fill?: string; /** The URL for the Image that is to be displayed as marker. In order to display image as marker, set series.marker.shape as Ă¢â‚¬ËœimageĂ¢â‚¬â„¢. - */ + */ imageUrl?: string; /** Opacity of the marker. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Specifies the shape of the marker. - * @Default {circle. See Shape} - */ + * @Default {circle. See Shape} + */ shape?: ej.datavisualization.Chart.Shape|string; /** Options for customizing the size of the marker shape. - */ + */ size?: SeriesMarkerSize; /** Controls the visibility of the marker shape. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; } export interface SeriesOutlierSettingsSize { /** Height of the outlier shape. - * @Default {6} - */ + * @Default {6} + */ height?: number; /** Width of the outlier shape. - * @Default {6} - */ + * @Default {6} + */ width?: number; } export interface SeriesOutlierSettings { /** Specifies the shape of the outlier. - * @Default {circle. See Shape} - */ + * @Default {circle. See Shape} + */ shape?: ej.datavisualization.Chart.Shape|string; /** Options for customizing the size of the outlier shape. - */ + */ size?: SeriesOutlierSettingsSize; } export interface SeriesEmptyPointSettingsStyleBorder { /** Border color of the empty point. - */ + */ color?: string; /** Border width of the empty point. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface SeriesEmptyPointSettingsStyle { /** Color of the empty point. - */ + */ color?: string; /** Options for customizing border of the empty point in the series. - */ + */ border?: SeriesEmptyPointSettingsStyleBorder; } export interface SeriesEmptyPointSettings { /** Controls the visibility of the empty point. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Specifies the mode of empty point. - * @Default {gap} - */ + * @Default {gap} + */ displayMode?: ej.datavisualization.Chart.EmptyPointMode|string; /** Options for customizing the color and border of the empty point in the series. - */ + */ style?: SeriesEmptyPointSettingsStyle; } export interface SeriesConnectorLine { /** Width of the connector line. - * @Default {1} - */ + * @Default {1} + */ width?: number; /** Color of the connector line. - * @Default {#565656} - */ + * @Default {#565656} + */ color?: string; /** DashArray of the connector line. - * @Default {null} - */ + * @Default {null} + */ dashArray?: string; /** Opacity of the connector line. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; } export interface SeriesDragSettings { /** drag/drop the series - * @Default {false} - */ + * @Default {false} + */ enable?: boolean; /** Specifies the type of drag settings. - * @Default {xy} - */ + * @Default {xy} + */ type?: string; } export interface SeriesErrorBarCap { /** Show/Hides the error bar cap. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Width of the error bar cap. - * @Default {1} - */ + * @Default {1} + */ width?: number; /** Length of the error bar cap. - * @Default {1} - */ + * @Default {1} + */ length?: number; /** Color of the error bar cap. - * @Default {#000000} - */ + * @Default {#000000} + */ fill?: string; } export interface SeriesErrorBar { /** Show/hides the error bar - * @Default {visible} - */ + * @Default {visible} + */ visibility?: boolean; /** Specifies the type of error bar. - * @Default {FixedValue} - */ + * @Default {FixedValue} + */ type?: ej.datavisualization.Chart.ErrorBarType|string; /** Specifies the mode of error bar. - * @Default {vertical} - */ + * @Default {vertical} + */ mode?: ej.datavisualization.Chart.ErrorBarMode|string; /** Specifies the direction of error bar. - * @Default {both} - */ + * @Default {both} + */ direction?: ej.datavisualization.Chart.ErrorBarDirection|string; /** Value of vertical error bar. - * @Default {3} - */ + * @Default {3} + */ verticalErrorValue?: number; /** Value of horizontal error bar. - * @Default {1} - */ + * @Default {1} + */ horizontalErrorValue?: number; /** Value of positive horizontal error bar. - * @Default {1} - */ + * @Default {1} + */ horizontalPositiveErrorValue?: number; /** Value of negative horizontal error bar. - * @Default {1} - */ + * @Default {1} + */ horizontalNegativeErrorValue?: number; /** Value of positive vertical error bar. - * @Default {5} - */ + * @Default {5} + */ verticalPositiveErrorValue?: number; /** Value of negative vertical error bar. - * @Default {5} - */ + * @Default {5} + */ verticalNegativeErrorValue?: number; /** Fill color of the error bar. - * @Default {#000000} - */ + * @Default {#000000} + */ fill?: string; /** Width of the error bar. - * @Default {1} - */ + * @Default {1} + */ width?: number; /** Options for customizing the error bar cap. - */ + */ cap?: SeriesErrorBarCap; } export interface SeriesPointsBorder { /** Border color of the point. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Border width of the point. - * @Default {null} - */ + * @Default {null} + */ width?: number; } export interface SeriesPointsMarkerBorder { /** Border color of the marker shape. - * @Default {white} - */ + * @Default {white} + */ color?: string; /** Border width of the marker shape. - * @Default {3} - */ + * @Default {3} + */ width?: number; } export interface SeriesPointsMarkerDataLabelBorder { /** Border color of the data label. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Border width of the data label. - * @Default {0.1} - */ + * @Default {0.1} + */ width?: number; } export interface SeriesPointsMarkerDataLabelConnectorLine { /** Specifies when the connector has to be drawn as Bezier curve or straight line. This is applicable only for Pie and Doughnut chart types. - * @Default {line. See ConnectorLineType} - */ + * @Default {line. See ConnectorLineType} + */ type?: ej.datavisualization.Chart.ConnectorLineType|string; /** Width of the connector. - * @Default {0.5} - */ + * @Default {0.5} + */ width?: number; } export interface SeriesPointsMarkerDataLabelFont { /** Font family of the data label. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style of the data label. - * @Default {normal. See FontStyle} - */ + * @Default {normal. See FontStyle} + */ fontStyle?: ej.datavisualization.Chart.FontStyle|string; /** Font weight of the data label. - * @Default {regular. See FontWeight} - */ + * @Default {regular. See FontWeight} + */ fontWeight?: ej.datavisualization.Chart.FontWeight|string; /** Opacity of the text. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font size of the data label. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface SeriesPointsMarkerDataLabelMargin { /** Bottom margin of the text. - * @Default {5} - */ + * @Default {5} + */ bottom?: number; /** Left margin of the text. - * @Default {5} - */ + * @Default {5} + */ left?: number; /** Right margin of the text. - * @Default {5} - */ + * @Default {5} + */ right?: number; /** Top margin of the text. - * @Default {5} - */ + * @Default {5} + */ top?: number; } export interface SeriesPointsMarkerDataLabel { /** Angle of the data label in degrees. Only the text gets rotated, whereas the background and border does not rotate. - * @Default {null} - */ + * @Default {null} + */ angle?: number; /** Options for customizing the border of the data label. - */ + */ border?: SeriesPointsMarkerDataLabelBorder; /** Options for displaying and customizing the line that connects point and data label. - */ + */ connectorLine?: SeriesPointsMarkerDataLabelConnectorLine; /** Background color of the data label. - * @Default {null} - */ + * @Default {null} + */ fill?: string; /** Options for customizing the data label font. - */ + */ font?: SeriesPointsMarkerDataLabelFont; /** Horizontal alignment of the data label. - * @Default {center} - */ + * @Default {center} + */ horizontalTextAlignment?: ej.datavisualization.Chart.HorizontalTextAlignment|string; /** Margin of the text to its background shape. The size of the background shape increases based on the margin applied to its text. - */ + */ margin?: SeriesPointsMarkerDataLabelMargin; /** Opacity of the data label. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Background shape of the data label. - * @Default {No shape is rendered by default, so its value is Ă¢â‚¬ËœnoneĂ¢â‚¬â„¢. See Shape} - */ + * @Default {No shape is rendered by default, so its value is Ă¢â‚¬ËœnoneĂ¢â‚¬â„¢. See Shape} + */ shape?: ej.datavisualization.Chart.Shape|string; /** Specifies the position of the data label. This property can be used only for the series such as column, bar, stacked column, stacked bar, 100% stacked column, 100% stacked bar, candle and OHLC. - * @Default {top. See TextPosition} - */ + * @Default {top. See TextPosition} + */ textPosition?: ej.datavisualization.Chart.TextPosition|string; /** Vertical alignment of the data label. - * @Default {'center'} - */ + * @Default {'center'} + */ verticalTextAlignment?: ej.datavisualization.Chart.VerticalTextAlignment|string; /** Controls the visibility of the data labels. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; /** Custom template to format the data label content. Use Ă¢â‚¬Å“point.xĂ¢â‚¬Â and Ă¢â‚¬Å“point.yĂ¢â‚¬Â as a placeholder text to display the corresponding data pointĂ¢â‚¬â„¢s x and y value. - */ + */ template?: string; /** Moves the label vertically by specified offset. - * @Default {0} - */ + * @Default {0} + */ offset?: number; } export interface SeriesPointsMarkerSize { /** Height of the marker. - * @Default {6} - */ + * @Default {6} + */ height?: number; /** Width of the marker. - * @Default {6} - */ + * @Default {6} + */ width?: number; } export interface SeriesPointsMarker { /** Options for customizing the border of the marker shape. - */ + */ border?: SeriesPointsMarkerBorder; /** Options for displaying and customizing data label. - */ + */ dataLabel?: SeriesPointsMarkerDataLabel; /** Color of the marker shape. - * @Default {null} - */ + * @Default {null} + */ fill?: string; /** The URL for the Image that is to be displayed as marker. In order to display image as marker, set series.marker.shape as Ă¢â‚¬ËœimageĂ¢â‚¬â„¢. - */ + */ imageUrl?: string; /** Opacity of the marker. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Specifies the shape of the marker. - * @Default {circle. See Shape} - */ + * @Default {circle. See Shape} + */ shape?: ej.datavisualization.Chart.Shape|string; /** Options for customizing the size of the marker shape. - */ + */ size?: SeriesPointsMarkerSize; /** Controls the visibility of the marker shape. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; } export interface SeriesPoint { /** Options for customizing the border of a point. This is applicable only for column type series and accumulation type series. - */ + */ border?: SeriesPointsBorder; /** Enables or disables the visibility of legend item. - * @Default {visible} - */ + * @Default {visible} + */ visibleOnLegend?: string; /** To show/hide the intermediate summary from the last intermediate point. - * @Default {false} - */ + * @Default {false} + */ showIntermediateSum?: boolean; /** To show/hide the total summary of the waterfall series. - * @Default {false} - */ + * @Default {false} + */ showTotalSum?: boolean; /** Close value of the point. Close value is applicable only for financial type series. - * @Default {null} - */ + * @Default {null} + */ close?: number; /** Size of a bubble in the bubble series. This is applicable only for the bubble series. - * @Default {null} - */ + * @Default {null} + */ size?: number; /** Background color of the point. This is applicable only for column type series and accumulation type series. - * @Default {null} - */ + * @Default {null} + */ fill?: string; /** High value of the point. High value is applicable only for financial type series, range area series and range column series. - * @Default {null} - */ + * @Default {null} + */ high?: number; /** Low value of the point. Low value is applicable only for financial type series, range area series and range column series. - * @Default {null} - */ + * @Default {null} + */ low?: number; /** Options for displaying and customizing marker for a data point. Marker contains shapes and/or data labels. - */ + */ marker?: SeriesPointsMarker; /** Open value of the point. This is applicable only for financial type series. - * @Default {null} - */ + * @Default {null} + */ open?: number; /** Datalabel text for the point. - * @Default {null} - */ + * @Default {null} + */ text?: string; /** X value of the point. - * @Default {null} - */ + * @Default {null} + */ x?: number; /** Y value of the point. - * @Default {null} - */ + * @Default {null} + */ y?: number; } export interface SeriesCornerRadius { /** Specifies the radius for the top left corner. - * @Default {0} - */ + * @Default {0} + */ topLeft?: number; /** Specifies the radius for the top right corner. - * @Default {0} - */ + * @Default {0} + */ topRight?: number; /** Specifies the radius for the bottom left corner. - * @Default {0} - */ + * @Default {0} + */ bottomLeft?: number; /** Specifies the radius for the bottom right corner. - * @Default {0} - */ + * @Default {0} + */ bottomRight?: number; } export interface SeriesTooltipBorder { /** Border Color of the tooltip. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Border Width of the tooltip. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface SeriesTooltip { /** Options for customizing the border of the tooltip. - */ + */ border?: SeriesTooltipBorder; /** Customize the corner radius of the tooltip rectangle. - * @Default {0} - */ + * @Default {0} + */ rx?: number; /** Customize the corner radius of the tooltip rectangle. - * @Default {0} - */ + * @Default {0} + */ ry?: number; /** Specifies the duration, the tooltip has to be displayed. - * @Default {500ms} - */ + * @Default {500ms} + */ duration?: string; /** Enables/disables the animation of the tooltip when moving from one point to another. - * @Default {true} - */ + * @Default {true} + */ enableAnimation?: boolean; /** Background color of the tooltip. - * @Default {null} - */ + * @Default {null} + */ fill?: string; /** Format of the tooltip content. - * @Default {#point.x# : #point.y#} - */ + * @Default {#point.x# : #point.y#} + */ format?: string; /** Opacity of the tooltip. - * @Default {0.95} - */ + * @Default {0.95} + */ opacity?: number; /** Custom template to format the tooltip content. Use Ă¢â‚¬Å“point.xĂ¢â‚¬Â and Ă¢â‚¬Å“point.yĂ¢â‚¬Â as a placeholder text to display the corresponding data pointĂ¢â‚¬â„¢s x and y value. - * @Default {null} - */ + * @Default {null} + */ template?: string; /** Controls the visibility of the tooltip. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; } export interface SeriesTrendline { /** Show/hides the trendline. - */ + */ visibility?: boolean; /** Specifies the type of trendline for the series. - * @Default {linear. See TrendlinesType} - */ + * @Default {linear. See TrendlinesType} + */ type?: string; /** Name for the trendlines that is to be displayed in legend text. - * @Default {Trendline} - */ + * @Default {Trendline} + */ name?: string; /** Fill color of the trendlines. - * @Default {#0000FF} - */ + * @Default {#0000FF} + */ fill?: string; /** Width of the trendlines. - * @Default {1} - */ + * @Default {1} + */ width?: number; /** Opacity of the trendline. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Pattern of dashes and gaps used to stroke the trendline. - */ + */ dashArray?: string; /** Future trends of the current series. - * @Default {0} - */ + * @Default {0} + */ forwardForecast?: number; /** Past trends of the current series. - * @Default {0} - */ + * @Default {0} + */ backwardForecast?: number; /** Specifies the order of polynomial trendlines. - * @Default {0} - */ + * @Default {0} + */ polynomialOrder?: number; /** Specifies the moving average starting period value. - * @Default {2} - */ + * @Default {2} + */ period?: number; } export interface SeriesHighlightSettingsBorder { /** Border color of the series/point on highlight. - */ + */ color?: string; /** Border width of the series/point on highlight. - * @Default {2} - */ + * @Default {2} + */ width?: string; } export interface SeriesHighlightSettings { /** Enables/disables the ability to highlight series or data point interactively. - * @Default {false} - */ + * @Default {false} + */ enable?: boolean; /** Specifies whether series or data point has to be highlighted. - * @Default {series. See Mode} - */ + * @Default {series. See Mode} + */ mode?: ej.datavisualization.Chart.Mode|string; /** Color of the series/point on highlight. - */ + */ color?: string; /** Opacity of the series/point on highlight. - * @Default {0.6} - */ + * @Default {0.6} + */ opacity?: number; /** Options for customizing the border of series on highlight. - */ + */ border?: SeriesHighlightSettingsBorder; /** Specifies the pattern for the series/point on highlight. - * @Default {none. See Pattern} - */ + * @Default {none. See Pattern} + */ pattern?: string; /** Custom pattern for the series on highlight. - */ + */ customPattern?: string; } export interface SeriesSelectionSettingsBorder { /** Border color of the series/point on selection. - */ + */ color?: string; /** Border width of the series/point on selection. - * @Default {2} - */ + * @Default {2} + */ width?: string; } export interface SeriesSelectionSettings { /** Enables/disables the ability to select a series/data point interactively. - * @Default {false} - */ + * @Default {false} + */ enable?: boolean; /** Specifies whether series or data point has to be selected. - * @Default {series. See Mode} - */ + * @Default {series. See Mode} + */ mode?: ej.datavisualization.Chart.Mode|string; /** Specifies the type of selection. - * @Default {single} - */ + * @Default {single} + */ type?: ej.datavisualization.Chart.SelectionType|string; /** Specifies the drawn rectangle type. - * @Default {xy} - */ + * @Default {xy} + */ rangeType?: ej.datavisualization.Chart.RangeType|string; /** Color of the series/point on selection. - */ + */ color?: string; /** Opacity of the series/point on selection. - * @Default {0.6} - */ + * @Default {0.6} + */ opacity?: number; /** Options for customizing the border of series on selection. - */ + */ border?: SeriesSelectionSettingsBorder; /** Specifies the pattern for the series/point on selection. - * @Default {none. See Pattern} - */ + * @Default {none. See Pattern} + */ pattern?: string; /** Custom pattern for the series on selection. - */ + */ customPattern?: string; } export interface Series { /** Color of the point, where the close is up in financial chart. - * @Default {null} - */ + * @Default {null} + */ bearFillColor?: string; /** Options for customizing the border of the series. - */ + */ border?: SeriesBorder; /** Color of the point, where the close is down in financial chart. - * @Default {null} - */ + * @Default {null} + */ bullFillColor?: string; /** To render the column and bar type series in rectangle/cylinder shape. See ColumnFacet - * @Default {rectangle} - */ + * @Default {rectangle} + */ columnFacet?: ej.datavisualization.Chart.ColumnFacet|string; /** Relative width of the columns in column type series. Value ranges from 0 to 1. Width also depends upon columnSpacing property. - * @Default {0.7} - */ + * @Default {0.7} + */ columnWidth?: number; /** Spacing between columns of different series. Value ranges from 0 to 1 - * @Default {0} - */ + * @Default {0} + */ columnSpacing?: number; /** To group the series of stacking collection. - */ + */ stackingGroup?: string; /** Pattern of dashes and gaps used to stroke the line type series. - */ + */ dashArray?: string; /** Specifies the dataSource for the series. It can be an array of JSON objects or an instance of ej.DataManager. - * @Default {null} - */ + * @Default {null} + */ dataSource?: any; /** Controls the size of the hole in doughnut series. Value ranges from 0 to 1. - * @Default {0.4} - */ + * @Default {0.4} + */ doughnutCoefficient?: number; /** Controls the size of the doughnut series. Value ranges from 0 to 1. - * @Default {0.8} - */ + * @Default {0.8} + */ doughnutSize?: number; /** Type of series to be drawn in radar or polar series. - * @Default {line. See DrawType} - */ + * @Default {line. See DrawType} + */ drawType?: ej.datavisualization.Chart.DrawType|string; /** Enable/disable the animation of series. - * @Default {false} - */ + * @Default {false} + */ enableAnimation?: boolean; /** To avoid overlapping of data labels smartly. - * @Default {null} - */ + * @Default {null} + */ enableSmartLabels?: number; /** End angle of pie/doughnut series. For a complete circle, it has to be 360, by default. - * @Default {null} - */ + * @Default {null} + */ endAngle?: number; /** Explodes the pie/doughnut slices on mouse move. - * @Default {false} - */ + * @Default {false} + */ explode?: boolean; /** Explodes all the slice of pie/doughnut on render. - * @Default {null} - */ + * @Default {null} + */ explodeAll?: boolean; /** Index of the point to be exploded from pie/doughnut/pyramid/funnel. - * @Default {null} - */ + * @Default {null} + */ explodeIndex?: number; /** Specifies the distance of the slice from the center, when it is exploded. - * @Default {25} - */ + * @Default {25} + */ explodeOffset?: number; /** Fill color of the series. - * @Default {null} - */ + * @Default {null} + */ fill?: string; /** Options for customizing the series font. - */ + */ font?: SeriesFont; /** Specifies the height of the funnel in funnel series. Values can be in both pixel and percentage. - * @Default {32.7%} - */ + * @Default {32.7%} + */ funnelHeight?: string; /** Specifies the width of the funnel in funnel series. Values can be in both pixel and percentage. - * @Default {11.6%} - */ + * @Default {11.6%} + */ funnelWidth?: string; /** Gap between the slices of pyramid/funnel series. - * @Default {0} - */ + * @Default {0} + */ gapRatio?: number; /** Specifies whether to join start and end point of a line/area series used in polar/radar chart to form a closed path. - * @Default {true} - */ + * @Default {true} + */ isClosed?: boolean; /** Specifies whether to stack the column series in polar/radar charts. - * @Default {true} - */ + * @Default {true} + */ isStacking?: boolean; /** Renders the chart vertically. This is applicable only for Cartesian type series. - * @Default {false} - */ + * @Default {false} + */ isTransposed?: boolean; /** Render the x mark in the center of the box and whisker series type.x represents the average value of the box and whisker series. - * @Default {true} - */ + * @Default {true} + */ showMedian?: boolean; /** Position of the data label in pie/doughnut/pyramid/funnel series. OutsideExtended position is not applicable for pyramid/funnel. - * @Default {inside. See LabelPosition} - */ + * @Default {inside. See LabelPosition} + */ labelPosition?: ej.datavisualization.Chart.LabelPosition|string; /** Quartile calculation has been performed in three different formulas to render the boxplot series . - * @Default {exclusive} - */ + * @Default {exclusive} + */ boxPlotMode?: ej.datavisualization.Chart.LabelPosition|string; /** Specifies the line cap of the series. - * @Default {Butt. See LineCap} - */ + * @Default {Butt. See LineCap} + */ lineCap?: ej.datavisualization.Chart.LineCap|string; /** Specifies the type of shape to be used where two lines meet. - * @Default {Round. See LineJoin} - */ + * @Default {Round. See LineJoin} + */ lineJoin?: ej.datavisualization.Chart.LineJoin|string; /** Options for displaying and customizing marker for individual point in a series. Marker contains shapes and/or data labels. - */ + */ marker?: SeriesMarker; /** Name of the series, that is to be displayed in the legend. - * @Default {Add a comment to this line} - */ + * @Default {Add a comment to this line} + */ name?: string; /** Opacity of the series. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Options for customizing the outlier of individual series. - */ + */ outlierSettings?: SeriesOutlierSettings; /** Name of a field in data source where fill color for all the data points is generated. - */ + */ palette?: string; /** Controls the size of pie series. Value ranges from 0 to 1. - * @Default {0.8} - */ + * @Default {0.8} + */ pieCoefficient?: number; /** Options for customizing the empty point in the series. - */ + */ emptyPointSettings?: SeriesEmptyPointSettings; /** Fill color for the positive column of the waterfall. - * @Default {null} - */ + * @Default {null} + */ positiveFill?: string; /** Options for customizing the waterfall connector line. - */ + */ connectorLine?: SeriesConnectorLine; /** Options to customize the drag and drop in series. - */ + */ dragSettings?: SeriesDragSettings; /** Options to customize the error bar in series. - */ + */ errorBar?: SeriesErrorBar; /** Option to add data points; each point should have x and y property. Also, optionally, you can customize the points color, border, marker by using fill, border and marker options. - */ + */ points?: SeriesPoint[]; /** Specifies the mode of the pyramid series. - * @Default {linear} - */ + * @Default {linear} + */ pyramidMode?: ej.datavisualization.Chart.PyramidMode|string; /** Specifies ej.Query to select data from dataSource. This property is applicable only when the dataSource is ej.DataManager. - * @Default {null} - */ + * @Default {null} + */ query?: any; /** Start angle from where the pie/doughnut series renders. It starts from 0, by default. - * @Default {null} - */ + * @Default {null} + */ startAngle?: number; /** Options for customizing the corner radius. cornerRadius property also takes the numeric input and applies it for all the four corners of the column. - */ + */ cornerRadius?: SeriesCornerRadius; /** Options for customizing the tooltip of chart. - */ + */ tooltip?: SeriesTooltip; /** Specifies the type of the series to render in chart. - * @Default {column. see Type} - */ + * @Default {column. see Type} + */ type?: ej.datavisualization.Chart.Type|string; /** Controls the visibility of the series. - * @Default {visible} - */ + * @Default {visible} + */ visibility?: string; /** Enables or disables the visibility of legend item. - * @Default {visible} - */ + * @Default {visible} + */ visibleOnLegend?: string; /** Specifies the name of the x-axis that has to be associated with this series. Add an axis instance with this name to axes collection. - * @Default {null} - */ + * @Default {null} + */ xAxisName?: string; /** Name of the property in the datasource that contains x value for the series. - * @Default {null} - */ + * @Default {null} + */ xName?: string; /** Specifies the name of the y-axis that has to be associated with this series. Add an axis instance with this name to axes collection. - * @Default {null} - */ + * @Default {null} + */ yAxisName?: string; /** Name of the property in the datasource that contains y value for the series. - * @Default {null} - */ + * @Default {null} + */ yName?: string; /** Name of the property in the datasource that contains high value for the series. - * @Default {null} - */ + * @Default {null} + */ high?: string; /** Name of the property in the datasource that contains low value for the series. - * @Default {null} - */ + * @Default {null} + */ low?: string; /** Name of the property in the datasource that contains open value for the series. - * @Default {null} - */ + * @Default {null} + */ open?: string; /** Name of the property in the datasource that contains close value for the series. - * @Default {null} - */ + * @Default {null} + */ close?: string; /** Name of the property in the datasource that contains fill color for the series. - * @Default {null} - */ + * @Default {null} + */ pointColorMappingName?: string; /** Z-order of the series. - * @Default {0} - */ + * @Default {0} + */ zOrder?: number; /** Name of the property in the datasource that contains the size value for the bubble series. - * @Default {null} - */ + * @Default {null} + */ size?: string; /** Option to add trendlines to chart. - */ + */ trendlines?: SeriesTrendline[]; /** Options for customizing the appearance of the series or data point while highlighting. - */ + */ highlightSettings?: SeriesHighlightSettings; /** Options for customizing the appearance of the series/data point on selection. - */ + */ selectionSettings?: SeriesSelectionSettings; } export interface Size { /** Height of the Chart. Height can be specified in either pixel or percentage. - * @Default {'450'} - */ + * @Default {'450'} + */ height?: string; /** Width of the Chart. Width can be specified in either pixel or percentage. - * @Default {'450'} - */ + * @Default {'450'} + */ width?: string; } export interface TitleBorder { /** Width of the title border. - * @Default {1} - */ + * @Default {1} + */ width?: number; /** color of the title border. - * @Default {transparent} - */ + * @Default {transparent} + */ color?: string; /** opacity of the title border. - * @Default {0.8} - */ + * @Default {0.8} + */ opacity?: number; /** opacity of the title border. - * @Default {0.8} - */ + * @Default {0.8} + */ cornerRadius?: number; } export interface TitleFont { /** Font family for Chart title. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style for Chart title. - * @Default {Normal. See FontStyle} - */ + * @Default {Normal. See FontStyle} + */ fontStyle?: ej.datavisualization.Chart.FontStyle|string; /** Font weight for Chart title. - * @Default {Regular. See FontWeight} - */ + * @Default {Regular. See FontWeight} + */ fontWeight?: ej.datavisualization.Chart.FontWeight|string; /** Opacity of the Chart title. - * @Default {0.5} - */ + * @Default {0.5} + */ opacity?: number; /** Font size for Chart title. - * @Default {20px} - */ + * @Default {20px} + */ size?: string; } export interface TitleSubTitleFont { /** Font family of sub title. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style for sub title. - * @Default {Normal. See FontStyle} - */ + * @Default {Normal. See FontStyle} + */ fontStyle?: ej.datavisualization.Chart.FontStyle|string; /** Font weight for sub title. - * @Default {Regular. See FontWeight} - */ + * @Default {Regular. See FontWeight} + */ fontWeight?: ej.datavisualization.Chart.FontWeight|string; /** Opacity of the sub title. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font size for sub title. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface TitleSubTitleBorder { /** Width of the subtitle border. - * @Default {1} - */ + * @Default {1} + */ width?: number; /** color of the subtitle border. - * @Default {transparent} - */ + * @Default {transparent} + */ color?: string; /** opacity of the subtitle border. - * @Default {0.8} - */ + * @Default {0.8} + */ opacity?: number; /** opacity of the subtitle border. - * @Default {0.8} - */ + * @Default {0.8} + */ cornerRadius?: number; } export interface TitleSubTitle { /** Options for customizing the font of sub title. - */ + */ font?: TitleSubTitleFont; /** Background color for the chart subtitle. - * @Default {transparent} - */ + * @Default {transparent} + */ background?: string; /** Options to customize the border of the title. - */ + */ border?: TitleSubTitleBorder; /** Text to be displayed in sub title. - */ + */ text?: string; /** Alignment of sub title text. - * @Default {far. See TextAlignment} - */ + * @Default {far. See TextAlignment} + */ textAlignment?: ej.datavisualization.Chart.Alignment|string; } export interface Title { /** Background color for the chart title. - * @Default {transparent} - */ + * @Default {transparent} + */ background?: string; /** Options to customize the border of the title. - */ + */ border?: TitleBorder; /** Options for customizing the font of Chart title. - */ + */ font?: TitleFont; /** Options to customize the sub title of Chart. - */ + */ subTitle?: TitleSubTitle; /** Text to be displayed in Chart title. - */ + */ text?: string; /** Alignment of the title text. - * @Default {Center. See TextAlignment} - */ + * @Default {Center. See TextAlignment} + */ textAlignment?: ej.datavisualization.Chart.Alignment|string; } export interface Zooming { /** Enables or disables zooming. - * @Default {false} - */ + * @Default {false} + */ enable?: boolean; /** Enables or disables pinch zooming. - * @Default {true} - */ + * @Default {true} + */ enablePinching?: boolean; /** Enable or disables the differed zooming. When it is enabled, chart is updated only on mouse up action while zooming and panning. - * @Default {false} - */ + * @Default {false} + */ enableDeferredZoom?: boolean; /** Enables/disables the ability to zoom the chart on moving the mouse wheel. - * @Default {false} - */ + * @Default {false} + */ enableMouseWheel?: boolean; /** Specifies whether to allow zooming the chart vertically or horizontally or in both ways. - * @Default {'x,y'} - */ + * @Default {'x,y'} + */ type?: string; /** Toggles the visibility of the scrollbar, which will be displayed while zooming. - * @Default {false} - */ + * @Default {false} + */ enableScrollbar?: boolean; /** To display user specified buttons in zooming toolbar. - * @Default {[zoomIn, zoomOut, zoom, pan, reset]} - */ + * @Default {[zoomIn, zoomOut, zoom, pan, reset]} + */ toolbarItems?: any[]; } } @@ -54527,8 +54528,8 @@ class RangeNavigator extends ej.Widget { defaults: RangeNavigator.Model; /** destroy the range navigator widget - * @returns {void} - */ + * @returns {void} + */ _destroy(): void; } export namespace RangeNavigator { @@ -54536,109 +54537,109 @@ export namespace RangeNavigator { export interface Model { /** Toggles the placement of slider exactly on the place it left or on the nearest interval. - * @Default {false} - */ + * @Default {false} + */ allowSnapping?: boolean; /** Options for customizing the color, opacity and width of the chart border. - */ + */ border?: Border; /** Specifies the data source for range navigator. - */ + */ dataSource?: any; /** Specifies the properties used for customizing the range series. - */ + */ series?: Series[]; /** Toggles the redrawing of chart on moving the sliders. - * @Default {true} - */ + * @Default {true} + */ enableDeferredUpdate?: boolean; /** Enable the scrollbar option in the rangenavigator. - * @Default {false} - */ + * @Default {false} + */ enableScrollbar?: boolean; /** Toggles the direction of rendering the range navigator control. - * @Default {false} - */ + * @Default {false} + */ enableRTL?: boolean; /** Sets a value whether to make the range navigator responsive on resize. - * @Default {false} - */ + * @Default {false} + */ isResponsive?: boolean; /** Options for customizing the labels colors, font, style, size, horizontalAlignment and opacity. - */ + */ labelSettings?: LabelSettings; /** This property is to specify the localization of range navigator. - * @Default {en-US} - */ + * @Default {en-US} + */ locale?: string; /** Options for customizing the range navigator. - */ + */ navigatorStyleSettings?: NavigatorStyleSettings; /** Padding specifies the gap between the container and the range navigator. - * @Default {0} - */ + * @Default {0} + */ padding?: string; /** If the range is not given explicitly, range will be calculated automatically. - * @Default {none} - */ + * @Default {none} + */ rangePadding?: ej.datavisualization.RangeNavigator.RangePadding|string; /** Options for customizing the starting and ending ranges. - */ + */ rangeSettings?: RangeSettings; /** selectedData is for getting the data when the "rangeChanged" event trigger from client side. - */ + */ selectedData?: any; /** Options for customizing the start and end range values. - */ + */ selectedRangeSettings?: SelectedRangeSettings; /** Options for rendering scrollbar based on the start and end range values. - */ + */ scrollRangeSettings?: ScrollRangeSettings; /** Contains property to customize the hight and width of range navigator. - */ + */ sizeSettings?: SizeSettings; /** By specifying this property the user can change the theme of the range navigator. - * @Default {null} - */ + * @Default {null} + */ theme?: string; /** Options for customizing the tooltip in range navigator. - */ + */ tooltipSettings?: TooltipSettings; /** Options for configuring minor grid lines, major grid lines, axis line of axis. - */ + */ valueAxisSettings?: ValueAxisSettings; /** You can plot data of type date time or numeric. This property determines the type of data that this axis will handle. - * @Default {datetime} - */ + * @Default {datetime} + */ valueType?: ej.datavisualization.RangeNavigator.ValueType|string; /** Specifies the xName for dataSource. This is used to take the x values from dataSource - */ + */ xName?: any; /** Specifies the yName for dataSource. This is used to take the y values from dataSource - */ + */ yName?: any; /** Fires on load of range navigator. */ @@ -54663,856 +54664,856 @@ export interface Model { export interface LoadEventArgs { /** parameters from range navigator - */ + */ Data?: any; /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the range navigator model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface LoadedEventArgs { /** parameters from range navigator - */ + */ Data?: any; /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the range navigator model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface RangeChangedEventArgs { /** parameters from range navigator - */ + */ Data?: any; /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the range navigator model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface ScrollChangedEventArgs { /** parameters from RangeNavigator - */ + */ data?: any; /** returns the scrollbar position old start and end range value on changing scrollbar - */ + */ dataoldRange?: any; /** returns the scrollbar position new start and end range value on changing scrollbar - */ + */ datanewRange?: any; /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the RangeNavigator model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface ScrollStartEventArgs { /** parameters from RangeNavigator - */ + */ data?: any; /** returns the scrollbar position starting range value on changing scrollbar - */ + */ datastartRange?: string; /** returns the scrollbar position end range value on changing scrollbar - */ + */ dataendRange?: string; /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the RangeNavigator model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface ScrollEndEventArgs { /** parameters from RangeNavigator - */ + */ data?: any; /** returns the scrollbar position old start and end range value on change end of scrollbar - */ + */ dataoldRange?: any; /** returns the scrollbar position new start and end range value on change end of scrollbar - */ + */ datanewRange?: any; /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the RangeNavigator model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; } export interface Border { /** Border color of rangenavigator. When enable the scrollbar, the default color will be set as "#B4B4B4". - * @Default {transparent} - */ + * @Default {transparent} + */ color?: string; /** Opacity of the rangeNavigator border. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Width of the RangeNavigator border. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface Series { /** Name of the property in the datasource that contains x value for the series. - * @Default {null} - */ + * @Default {null} + */ xName?: string; /** Name of the property in the datasource that contains y value for the series. - * @Default {null} - */ + * @Default {null} + */ yName?: string; /** Specifies the dataSource for the series. It can be an array of JSON objects or an instance of ej.DataManager. - * @Default {null} - */ + * @Default {null} + */ dataSource?: any; /** Specifies the type of the series to render in chart. - * @Default {column. see Type} - */ + * @Default {column. see Type} + */ type?: ej.datavisualization.RangeNavigator.Type|string; /** Enable/disable the animation of series. - * @Default {false} - */ + * @Default {false} + */ enableAnimation?: boolean; /** Fill color of the series. - * @Default {null} - */ + * @Default {null} + */ fill?: string; } export interface LabelSettingsHigherLevelBorder { /** Specifies the border color of grid lines. - * @Default {transparent} - */ + * @Default {transparent} + */ color?: string; /** Specifies the border width of grid lines. - * @Default {0.5} - */ + * @Default {0.5} + */ width?: string; } export interface LabelSettingsHigherLevelGridLineStyle { /** Specifies the color of grid lines in higher level. - * @Default {#B5B5B5} - */ + * @Default {#B5B5B5} + */ color?: string; /** Specifies the dashArray of grid lines in higher level. - * @Default {20 5 0} - */ + * @Default {20 5 0} + */ dashArray?: string; /** Specifies the width of grid lines in higher level. - * @Default {#B5B5B5} - */ + * @Default {#B5B5B5} + */ width?: string; } export interface LabelSettingsHigherLevelStyleFont { /** Specifies the label font color. Labels render with the specified font color. - * @Default {black} - */ + * @Default {black} + */ color?: string; /** Specifies the label font family. Labels render with the specified font family. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Specifies the label font style. Labels render with the specified font style. - * @Default {Normal} - */ + * @Default {Normal} + */ fontStyle?: string; /** Specifies the label font weight. Labels render with the specified font weight. - * @Default {regular} - */ + * @Default {regular} + */ fontWeight?: string; /** Specifies the label opacity. Labels render with the specified opacity. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Specifies the label font size. Labels render with the specified font size. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface LabelSettingsHigherLevelStyle { /** Options for customizing the font properties. - */ + */ font?: LabelSettingsHigherLevelStyleFont; /** Specifies the horizontal text alignment of the text in label. - * @Default {middle} - */ + * @Default {middle} + */ horizontalAlignment?: string; } export interface LabelSettingsHigherLevel { /** Options for customizing the border of grid lines in higher level. - */ + */ border?: LabelSettingsHigherLevelBorder; /** Specifies the fill color of higher level labels. - * @Default {transparent} - */ + * @Default {transparent} + */ fill?: string; /** Options for customizing the grid line colors, width, dashArray, border. - */ + */ gridLineStyle?: LabelSettingsHigherLevelGridLineStyle; /** Specifies the intervalType for higher level labels. See IntervalType - * @Default {auto} - */ + * @Default {auto} + */ intervalType?: ej.datavisualization.RangeNavigator.IntervalType|string; /** Specifies the position of the labels to render either inside or outside of plot area - * @Default {outside} - */ + * @Default {outside} + */ labelPlacement?: ej.datavisualization.RangeNavigator.LabelPlacement|string; /** Specifies the position of the labels in higher level - * @Default {top} - */ + * @Default {top} + */ position?: ej.datavisualization.RangeNavigator.Position|string; /** Options for customizing the style of higher level labels. - */ + */ style?: LabelSettingsHigherLevelStyle; /** Toggles the visibility of higher level labels. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; } export interface LabelSettingsLowerLevelBorder { /** Specifies the border color of grid lines. - * @Default {transparent} - */ + * @Default {transparent} + */ color?: string; /** Specifies the border width of grid lines. - * @Default {0.5} - */ + * @Default {0.5} + */ width?: string; } export interface LabelSettingsLowerLevelGridLineStyle { /** Specifies the color of grid lines in lower level. - * @Default {#B5B5B5} - */ + * @Default {#B5B5B5} + */ color?: string; /** Specifies the dashArray of gridLines in lowerLevel. - * @Default {20 5 0} - */ + * @Default {20 5 0} + */ dashArray?: string; /** Specifies the width of grid lines in lower level. - * @Default {#B5B5B5} - */ + * @Default {#B5B5B5} + */ width?: string; } export interface LabelSettingsLowerLevelStyleFont { /** Specifies the color of labels. Label text render in this specified color. - * @Default {black} - */ + * @Default {black} + */ color?: string; /** Specifies the font family of labels. Label text render in this specified font family. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Specifies the font style of labels. Label text render in this specified font style. - * @Default {Normal} - */ + * @Default {Normal} + */ fontStyle?: string; /** Specifies the font weight of labels. Label text render in this specified font weight. - * @Default {regular} - */ + * @Default {regular} + */ fontWeight?: string; /** Specifies the opacity of labels. Label text render in this specified opacity. - * @Default {12px} - */ + * @Default {12px} + */ opacity?: string; /** Specifies the size of labels. Label text render in this specified size. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface LabelSettingsLowerLevelStyle { /** Options for customizing the font of labels. - */ + */ font?: LabelSettingsLowerLevelStyleFont; /** Specifies the horizontal text alignment of the text in label. - * @Default {middle} - */ + * @Default {middle} + */ horizontalAlignment?: string; } export interface LabelSettingsLowerLevel { /** Options for customizing the border of grid lines in lower level. - */ + */ border?: LabelSettingsLowerLevelBorder; /** Specifies the fill color of labels in lower level. - * @Default {transparent} - */ + * @Default {transparent} + */ fill?: string; /** Options for customizing the grid lines in lower level. - */ + */ gridLineStyle?: LabelSettingsLowerLevelGridLineStyle; /** Specifies the intervalType of the labels in lower level.See IntervalType - * @Default {auto} - */ + * @Default {auto} + */ intervalType?: ej.datavisualization.RangeNavigator.IntervalType|string; /** Specifies the position of the labels to render either inside or outside of plot area. See LabelPlacement - * @Default {outside} - */ + * @Default {outside} + */ labelPlacement?: ej.datavisualization.RangeNavigator.LabelPlacement|string; /** Specifies the position of the labels in lower level.See Position - * @Default {bottom} - */ + * @Default {bottom} + */ position?: ej.datavisualization.RangeNavigator.Position|string; /** Options for customizing the style of labels. - */ + */ style?: LabelSettingsLowerLevelStyle; /** Toggles the visibility of labels in lower level. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; } export interface LabelSettingsStyleFont { /** Specifies the label color. This color is applied to the labels in range navigator. - * @Default {#FFFFFF} - */ + * @Default {#FFFFFF} + */ color?: string; /** Specifies the label font family. Labels render with the specified font family. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ family?: string; /** Specifies the label font opacity. Labels render with the specified font opacity. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Specifies the label font size. Labels render with the specified font size. - * @Default {1px} - */ + * @Default {1px} + */ size?: string; /** Specifies the label font style. Labels render with the specified font style.. - * @Default {Normal} - */ + * @Default {Normal} + */ style?: ej.datavisualization.RangeNavigator.FontStyle|string; /** Specifies the label font weight - * @Default {regular} - */ + * @Default {regular} + */ weight?: ej.datavisualization.RangeNavigator.FontWeight|string; } export interface LabelSettingsStyle { /** Options for customizing the font of labels in range navigator. - */ + */ font?: LabelSettingsStyleFont; /** Specifies the horizontalAlignment of the label in RangeNavigator - * @Default {middle} - */ + * @Default {middle} + */ horizontalAlignment?: ej.datavisualization.RangeNavigator.HorizontalAlignment|string; } export interface LabelSettings { /** Options for customizing the higher level labels in range navigator. - */ + */ higherLevel?: LabelSettingsHigherLevel; /** Options for customizing the labels in lower level. - */ + */ lowerLevel?: LabelSettingsLowerLevel; /** Options for customizing the style of labels in range navigator. - */ + */ style?: LabelSettingsStyle; } export interface NavigatorStyleSettingsBorder { /** Specifies the border color of range navigator. - * @Default {transparent} - */ + * @Default {transparent} + */ color?: string; /** Specifies the dash array of range navigator. - * @Default {null} - */ + * @Default {null} + */ dashArray?: string; /** Specifies the border width of range navigator. - * @Default {0.5} - */ + * @Default {0.5} + */ width?: number; } export interface NavigatorStyleSettingsMajorGridLineStyle { /** Specifies the color of major grid lines in range navigator. - * @Default {#B5B5B5} - */ + * @Default {#B5B5B5} + */ color?: string; /** Toggles the visibility of major grid lines. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; } export interface NavigatorStyleSettingsMinorGridLineStyle { /** Specifies the color of minor grid lines in range navigator. - * @Default {#B5B5B5} - */ + * @Default {#B5B5B5} + */ color?: string; /** Toggles the visibility of minor grid lines. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; } export interface NavigatorStyleSettingsHighlightSettingsBorder { /** To set the border color to the highlight. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** To set the border width to the highlight. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface NavigatorStyleSettingsHighlightSettings { /** Enable the highlight settings in range navigator. - * @Default {false} - */ + * @Default {false} + */ enable?: boolean; /** To set the color to the highlight. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** To set the opacity to the highlight. - * @Default {0.5} - */ + * @Default {0.5} + */ opacity?: number; /** Contains the border properties for highlighting rectangle. - */ + */ border?: NavigatorStyleSettingsHighlightSettingsBorder; } export interface NavigatorStyleSettingsSelectionSettingsBorder { /** To set the border color to the selection. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** To set the border width to the selection. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface NavigatorStyleSettingsSelectionSettings { /** Enable the selection settings in range navigator. - * @Default {false} - */ + * @Default {false} + */ enable?: boolean; /** To set the color to the selection. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** To set the opacity to the selection. - * @Default {0.5} - */ + * @Default {0.5} + */ opacity?: number; /** Contains the border properties for selecting the rectangle. - */ + */ border?: NavigatorStyleSettingsSelectionSettingsBorder; } export interface NavigatorStyleSettings { /** Specifies the background color of range navigator. - * @Default {#dddddd} - */ + * @Default {#dddddd} + */ background?: string; /** Options for customizing the border color and width of range navigator. - */ + */ border?: NavigatorStyleSettingsBorder; /** Specifies the left side thumb template in range navigator we can give either div id or HTML string - * @Default {null} - */ + * @Default {null} + */ leftThumbTemplate?: string; /** Options for customizing the major grid lines. - */ + */ majorGridLineStyle?: NavigatorStyleSettingsMajorGridLineStyle; /** Options for customizing the minor grid lines. - */ + */ minorGridLineStyle?: NavigatorStyleSettingsMinorGridLineStyle; /** Specifies the opacity of RangeNavigator. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Specifies the right side thumb template in range navigator we can give either div id or HTML string - * @Default {null} - */ + * @Default {null} + */ rightThumbTemplate?: string; /** Specifies the color of the selected region in range navigator. - * @Default {#EFEFEF} - */ + * @Default {#EFEFEF} + */ selectedRegionColor?: string; /** Specifies the opacity of Selected Region. - * @Default {0} - */ + * @Default {0} + */ selectedRegionOpacity?: number; /** Specifies the color of the thumb in range navigator. - * @Default {#2382C3} - */ + * @Default {#2382C3} + */ thumbColor?: string; /** Specifies the radius of the thumb in range navigator. - * @Default {10} - */ + * @Default {10} + */ thumbRadius?: number; /** Specifies the stroke color of the thumb in range navigator. - * @Default {#303030} - */ + * @Default {#303030} + */ thumbStroke?: string; /** Specifies the color of the unselected region in range navigator. - * @Default {#5EABDE} - */ + * @Default {#5EABDE} + */ unselectedRegionColor?: string; /** Specifies the opacity of Unselected Region. - * @Default {0.3} - */ + * @Default {0.3} + */ unselectedRegionOpacity?: number; /** Contains the options for highlighting the range navigator on mouse over. - */ + */ highlightSettings?: NavigatorStyleSettingsHighlightSettings; /** Contains the options for selection the range navigator on mouse over. - */ + */ selectionSettings?: NavigatorStyleSettingsSelectionSettings; } export interface RangeSettings { /** Specifies the ending range of range navigator. - * @Default {null} - */ + * @Default {null} + */ end?: string; /** Specifies the starting range of range navigator. - * @Default {null} - */ + * @Default {null} + */ start?: string; } export interface SelectedRangeSettings { /** Specifies the ending range of range navigator. - * @Default {null} - */ + * @Default {null} + */ end?: string; /** Specifies the starting range of range navigator. - * @Default {null} - */ + * @Default {null} + */ start?: string; } export interface ScrollRangeSettings { /** Specifies the ending range of range navigator scrollbar and that should be greater than the rangenavigator datasource end value. - * @Default {null} - */ + * @Default {null} + */ end?: string; /** Specifies the starting range of range navigator scrollbar and that should be less than the rangenavigator datasource start value. - * @Default {null} - */ + * @Default {null} + */ start?: string; } export interface SizeSettings { /** Specifies height of the range navigator. - * @Default {null} - */ + * @Default {null} + */ height?: string; /** Specifies width of the range navigator. - * @Default {null} - */ + * @Default {null} + */ width?: string; } export interface TooltipSettingsFont { /** Specifies the color of text in tooltip. Tooltip text render in the specified color. - * @Default {#FFFFFF} - */ + * @Default {#FFFFFF} + */ color?: string; /** Specifies the font family of text in tooltip. Tooltip text render in the specified font family. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ family?: string; /** Specifies the font style of text in tooltip. Tooltip text render in the specified font style. - * @Default {ej.datavisualization.RangeNavigator.fontStyle.Normal} - */ + * @Default {ej.datavisualization.RangeNavigator.fontStyle.Normal} + */ fontStyle?: string; /** Specifies the opacity of text in tooltip. Tooltip text render in the specified opacity. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Specifies the size of text in tooltip. Tooltip text render in the specified size. - * @Default {10px} - */ + * @Default {10px} + */ size?: string; /** Specifies the weight of text in tooltip. Tooltip text render in the specified weight. - * @Default {ej.datavisualization.RangeNavigator.weight.Regular} - */ + * @Default {ej.datavisualization.RangeNavigator.weight.Regular} + */ weight?: string; } export interface TooltipSettings { /** Specifies the background color of tooltip. - * @Default {#303030} - */ + * @Default {#303030} + */ backgroundColor?: string; /** Options for customizing the font in tooltip. - */ + */ font?: TooltipSettingsFont; /** Specifies the format of text to be displayed in tooltip. - * @Default {MM/dd/yyyy} - */ + * @Default {MM/dd/yyyy} + */ labelFormat?: string; /** Specifies the mode of displaying the tooltip. Neither to display the tooltip always nor on demand. - * @Default {null} - */ + * @Default {null} + */ tooltipDisplayMode?: string; /** Toggles the visibility of tooltip. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; } export interface ValueAxisSettingsAxisLine { /** Toggles the visibility of axis line. - * @Default {none} - */ + * @Default {none} + */ visible?: string; } export interface ValueAxisSettingsFont { /** Text in axis render with the specified size. - * @Default {0px} - */ + * @Default {0px} + */ size?: string; } export interface ValueAxisSettingsMajorGridLines { /** Toggles the visibility of major grid lines. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; } export interface ValueAxisSettingsMajorTickLines { /** Specifies the size of the majorTickLines in range navigator - * @Default {0} - */ + * @Default {0} + */ size?: number; /** Toggles the visibility of major tick lines. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Specifies width of the major tick lines. - * @Default {0} - */ + * @Default {0} + */ width?: number; } export interface ValueAxisSettings { /** Options for customizing the axis line. - */ + */ axisLine?: ValueAxisSettingsAxisLine; /** Options for customizing the font of the axis. - */ + */ font?: ValueAxisSettingsFont; /** Options for customizing the major grid lines. - */ + */ majorGridLines?: ValueAxisSettingsMajorGridLines; /** Options for customizing the major tick lines in axis. - */ + */ majorTickLines?: ValueAxisSettingsMajorTickLines; /** If the range is not given explicitly, range will be calculated automatically. You can customize the automatic range calculation using rangePadding. - * @Default {none} - */ + * @Default {none} + */ rangePadding?: string; /** Toggles the visibility of axis in range navigator. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; } } @@ -55623,23 +55624,23 @@ class BulletGraph extends ej.Widget { defaults: BulletGraph.Model; /** To destroy the bullet graph - * @returns {void} - */ + * @returns {void} + */ destroy(): void; /** To redraw the bullet graph - * @returns {void} - */ + * @returns {void} + */ redraw(): void; /** To set the value for comparative measure in bullet graph. - * @returns {void} - */ + * @returns {void} + */ setComparativeMeasureSymbol(): void; /** To set the value for feature measure bar. - * @returns {void} - */ + * @returns {void} + */ setFeatureMeasureBarValue(): void; } export namespace BulletGraph { @@ -55647,84 +55648,84 @@ export namespace BulletGraph { export interface Model { /** Toggles the visibility of the range stroke color of the labels. - * @Default {false} - */ + * @Default {false} + */ applyRangeStrokeToLabels?: boolean; /** Toggles the visibility of the range stroke color of the ticks. - * @Default {false} - */ + * @Default {false} + */ applyRangeStrokeToTicks?: boolean; /** Contains property to customize the caption in bullet graph. - */ + */ captionSettings?: CaptionSettings; /** Comparative measure bar in bullet graph render till the specified value. - * @Default {0} - */ + * @Default {0} + */ comparativeMeasureValue?: number; /** Toggles the animation of bullet graph. - * @Default {true} - */ + * @Default {true} + */ enableAnimation?: boolean; /** Specifies the direction of flow in bullet graph. Neither it may be backward nor forward. - * @Default {forward} - */ + * @Default {forward} + */ flowDirection?: ej.datavisualization.BulletGraph.FlowDirection|string; /** Specifies the height of the bullet graph. - * @Default {90} - */ + * @Default {90} + */ height?: number; /** Sets a value whether to make the bullet graph responsive on resize. - * @Default {true} - */ + * @Default {true} + */ isResponsive?: boolean; /** Bullet graph will render in the specified orientation. - * @Default {horizontal} - */ + * @Default {horizontal} + */ orientation?: ej.datavisualization.BulletGraph.Orientation|string; /** Contains property to customize the qualitative ranges. - */ + */ qualitativeRanges?: QualitativeRange[]; /** Size of the qualitative range depends up on the specified value. - * @Default {32} - */ + * @Default {32} + */ qualitativeRangeSize?: number; /** Length of the quantitative range depends up on the specified value. - * @Default {475} - */ + * @Default {475} + */ quantitativeScaleLength?: number; /** Contains all the properties to customize quantitative scale. - */ + */ quantitativeScaleSettings?: QuantitativeScaleSettings; /** By specifying this property the user can change the theme of the bullet graph. - * @Default {flatlight} - */ + * @Default {flatlight} + */ theme?: string; /** Contains all the properties to customize tooltip. - */ + */ tooltipSettings?: TooltipSettings; /** Feature measure bar in bullet graph render till the specified value. - * @Default {0} - */ + * @Default {0} + */ value?: number; /** Specifies the width of the bullet graph. - * @Default {595} - */ + * @Default {595} + */ width?: number; /** Fires on rendering the caption of bullet graph. */ @@ -55755,779 +55756,779 @@ export interface Model { export interface DrawCaptionEventArgs { /** returns the object of the bullet graph. - */ + */ Object?: any; /** returns the options of the scale element. - */ + */ scaleElement?: HTMLElement; /** returns the current captionSettings element. - */ + */ captionElement?: HTMLElement; /** returns the type of the captionSettings. - */ + */ captionType?: string; } export interface DrawCategoryEventArgs { /** returns the object of the bullet graph. - */ + */ Object?: any; /** returns the options of the scale element. - */ + */ scaleElement?: HTMLElement; /** returns the options of category element. - */ + */ categoryElement?: HTMLElement; /** returns the text value of the category that is drawn. - */ + */ Value?: string; } export interface DrawComparativeMeasureSymbolEventArgs { /** returns the object of the bullet graph. - */ + */ Object?: any; /** returns the options of the scale element. - */ + */ scaleElement?: HTMLElement; /** returns the options of comparative measure element. - */ + */ targetElement?: HTMLElement; /** returns the value of the comparative measure symbol. - */ + */ Value?: number; } export interface DrawFeatureMeasureBarEventArgs { /** returns the object of the bullet graph. - */ + */ Object?: any; /** returns the options of the scale element. - */ + */ scaleElement?: HTMLElement; /** returns the options of feature measure element. - */ + */ currentElement?: HTMLElement; /** returns the value of the feature measure bar. - */ + */ Value?: number; } export interface DrawIndicatorEventArgs { /** returns an object to customize bullet graph indicator text and symbol before rendering it. - */ + */ indicatorSettings?: any; /** returns the object of bullet graph. - */ + */ model?: any; /** returns the type of event. - */ + */ type?: string; /** for canceling the event. - */ + */ cancel?: boolean; } export interface DrawLabelsEventArgs { /** returns the object of the bullet graph. - */ + */ Object?: any; /** returns the options of the scale element. - */ + */ scaleElement?: HTMLElement; /** returns the current label element. - */ + */ tickElement?: HTMLElement; /** returns the label type. - */ + */ labelType?: string; } export interface DrawQualitativeRangesEventArgs { /** returns the object of the bullet graph. - */ + */ Object?: any; /** returns the index of current range. - */ + */ rangeIndex?: number; /** returns the settings for current range. - */ + */ rangeOptions?: any; /** returns the end value of current range. - */ + */ rangeEndValue?: number; } export interface LoadEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface CaptionSettingsFont { /** Specifies the color of the text in caption. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Specifies the fontFamily of caption. Caption text render with this fontFamily - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Specifies the fontStyle of caption - * @Default {Normal} - */ + * @Default {Normal} + */ fontStyle?: ej.datavisualization.BulletGraph.FontStyle|string; /** Specifies the fontWeight of caption - * @Default {regular} - */ + * @Default {regular} + */ fontWeight?: ej.datavisualization.BulletGraph.FontWeight|string; /** Specifies the opacity of caption. Caption text render with this opacity. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Specifies the size of caption. Caption text render with this size - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface CaptionSettingsIndicatorFont { /** Specifies the color of the indicator's text. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Specifies the fontFamily of indicator. Indicator text render with this fontFamily. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Specifies the fontStyle of indicator. Indicator text render with this fontStyle. See FontStyle - * @Default {Normal} - */ + * @Default {Normal} + */ fontStyle?: ej.datavisualization.BulletGraph.FontStyle|string; /** Specifies the fontWeight of indicator. Indicator text render with this fontWeight. See FontWeight - * @Default {regular} - */ + * @Default {regular} + */ fontWeight?: ej.datavisualization.BulletGraph.FontWeight|string; /** Specifies the opacity of indicator text. Indicator text render with this Opacity. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Specifies the size of indicator. Indicator text render with this size. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface CaptionSettingsIndicatorLocation { /** Specifies the horizontal position of the indicator. - * @Default {10} - */ + * @Default {10} + */ x?: number; /** Specifies the vertical position of the indicator. - * @Default {60} - */ + * @Default {60} + */ y?: number; } export interface CaptionSettingsIndicatorSymbolBorder { /** Specifies the border color of indicator symbol. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Specifies the border width of indicator symbol. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface CaptionSettingsIndicatorSymbolSize { /** Specifies the height of indicator symbol. - * @Default {10} - */ + * @Default {10} + */ height?: number; /** Specifies the width of indicator symbol. - * @Default {10} - */ + * @Default {10} + */ width?: number; } export interface CaptionSettingsIndicatorSymbol { /** Contains property to customize the border of indicator symbol. - */ + */ border?: CaptionSettingsIndicatorSymbolBorder; /** Specifies the color of indicator symbol. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Specifies the URL of image that represents indicator symbol. - */ + */ imageURL?: string; /** Specifies the opacity of indicator symbol. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Specifies the shape of indicator symbol. - */ + */ shape?: string; /** Contains property to customize the size of indicator symbol. - */ + */ size?: CaptionSettingsIndicatorSymbolSize; } export interface CaptionSettingsIndicator { /** Contains property to customize the font of indicator. - */ + */ font?: CaptionSettingsIndicatorFont; /** Contains property to customize the location of indicator. - */ + */ location?: CaptionSettingsIndicatorLocation; /** Specifies the padding to be applied when text position is used. - * @Default {2} - */ + * @Default {2} + */ padding?: number; /** Contains property to customize the symbol of indicator. - */ + */ symbol?: CaptionSettingsIndicatorSymbol; /** Specifies the text to be displayed as indicator text. By default difference between current value and target will be displayed - */ + */ text?: string; /** Specifies the alignment of indicator with respect to scale based on text position - * @Default {'Near'} - */ + * @Default {'Near'} + */ textAlignment?: ej.datavisualization.BulletGraph.TextAlignment|string; /** Specifies where indicator text should be anchored when indicator overlaps with other caption group text. Text will be anchored when overlapping caption group text are at same position. - * Anchoring is not applicable for float position. - * @Default {'start'} - */ + * Anchoring is not applicable for float position. + * @Default {'start'} + */ textAnchor?: ej.datavisualization.BulletGraph.TextAnchor|string; /** indicator text render in the specified angle. - * @Default {0} - */ + * @Default {0} + */ textAngle?: number; /** Specifies where indicator should be placed - * @Default {'float'} - */ + * @Default {'float'} + */ textPosition?: ej.datavisualization.BulletGraph.TextPosition|string; /** Specifies the space between indicator symbol and text. - * @Default {3} - */ + * @Default {3} + */ textSpacing?: number; /** Specifies whether indicator will be visible or not. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; } export interface CaptionSettingsLocation { /** Specifies the position in horizontal direction - * @Default {17} - */ + * @Default {17} + */ x?: number; /** Specifies the position in horizontal direction - * @Default {30} - */ + * @Default {30} + */ y?: number; } export interface CaptionSettingsSubTitleFont { /** Specifies the color of the subtitle's text. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Specifies the fontFamily of subtitle. Subtitle text render with this fontFamily. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Specifies the fontStyle of subtitle. Subtitle text render with this fontStyle. See FontStyle - * @Default {Normal} - */ + * @Default {Normal} + */ fontStyle?: ej.datavisualization.BulletGraph.FontStyle|string; /** Specifies the fontWeight of subtitle. Subtitle text render with this fontWeight. See FontWeight - * @Default {regular} - */ + * @Default {regular} + */ fontWeight?: ej.datavisualization.BulletGraph.FontWeight|string; /** Specifies the opacity of subtitle. Subtitle text render with this opacity. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Specifies the size of subtitle. Subtitle text render with this size. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface CaptionSettingsSubTitleLocation { /** Specifies the horizontal position of the subtitle. - * @Default {10} - */ + * @Default {10} + */ x?: number; /** Specifies the vertical position of the subtitle. - * @Default {45} - */ + * @Default {45} + */ y?: number; } export interface CaptionSettingsSubTitle { /** Contains property to customize the font of subtitle. - */ + */ font?: CaptionSettingsSubTitleFont; /** Contains property to customize the location of subtitle. - */ + */ location?: CaptionSettingsSubTitleLocation; /** Specifies the padding to be applied when text position is used. - * @Default {5} - */ + * @Default {5} + */ padding?: number; /** Specifies the text to be displayed as subtitle. - */ + */ text?: string; /** Specifies the alignment of sub title text with respect to scale. Alignment will not be applied in float position. - * @Default {'Near'} - */ + * @Default {'Near'} + */ textAlignment?: ej.datavisualization.BulletGraph.TextAlignment|string; /** Specifies where subtitle text should be anchored when sub title text overlaps with other caption group text. Text will be anchored when overlapping - * caption group text are at same position. Anchoring is not applicable for float position. - * @Default {'start'} - */ + * caption group text are at same position. Anchoring is not applicable for float position. + * @Default {'start'} + */ textAnchor?: ej.datavisualization.BulletGraph.TextAnchor|string; /** Subtitle render in the specified angle. - * @Default {0} - */ + * @Default {0} + */ textAngle?: number; /** Specifies where sub title text should be placed. - * @Default {'float'} - */ + * @Default {'float'} + */ textPosition?: ej.datavisualization.BulletGraph.TextPosition|string; } export interface CaptionSettings { /** Specifies whether trim the labels will be true or false. - * @Default {true} - */ + * @Default {true} + */ enableTrim?: boolean; /** Contains property to customize the font of caption. - */ + */ font?: CaptionSettingsFont; /** Contains property to customize the indicator. - */ + */ indicator?: CaptionSettingsIndicator; /** Contains property to customize the location. - */ + */ location?: CaptionSettingsLocation; /** Specifies the padding to be applied when text position is used. - * @Default {5} - */ + * @Default {5} + */ padding?: number; /** Contains property to customize the subtitle. - */ + */ subTitle?: CaptionSettingsSubTitle; /** Specifies the text to be displayed on bullet graph. - */ + */ text?: string; /** Specifies the alignment of caption text with respect to scale. This property will not be applied when text position is float. - * @Default {'Near'} - */ + * @Default {'Near'} + */ textAlignment?: ej.datavisualization.BulletGraph.TextAlignment|string; /** Specifies caption text anchoring when caption text overlaps with other caption group text. - * Text will be anchored when overlapping caption group text are at same position. Anchoring is not applicable for float position. - * @Default {'start'} - */ + * Text will be anchored when overlapping caption group text are at same position. Anchoring is not applicable for float position. + * @Default {'start'} + */ textAnchor?: ej.datavisualization.BulletGraph.TextAnchor|string; /** Specifies the angel in which the caption is rendered. - * @Default {0} - */ + * @Default {0} + */ textAngle?: number; /** Specifies how caption text should be placed. - * @Default {'float'} - */ + * @Default {'float'} + */ textPosition?: ej.datavisualization.BulletGraph.TextPosition|string; } export interface QualitativeRange { /** Specifies the ending range to which the qualitative ranges will render. - * @Default {3} - */ + * @Default {3} + */ rangeEnd?: number; /** Specifies the opacity for the qualitative ranges. - * @Default {1} - */ + * @Default {1} + */ rangeOpacity?: number; /** Specifies the stroke for the qualitative ranges. - * @Default {null} - */ + * @Default {null} + */ rangeStroke?: string; } export interface QuantitativeScaleSettingsComparativeMeasureSettings { /** Specifies the stroke of the comparative measure. - * @Default {null} - */ + * @Default {null} + */ stroke?: number; /** Specifies the width of the comparative measure. - * @Default {5} - */ + * @Default {5} + */ width?: number; } export interface QuantitativeScaleSettingsFeaturedMeasureSettings { /** Specifies the Stroke of the featured measure in bullet graph. - * @Default {null} - */ + * @Default {null} + */ stroke?: number; /** Specifies the width of the featured measure in bullet graph. - * @Default {2} - */ + * @Default {2} + */ width?: number; } export interface QuantitativeScaleSettingsFeatureMeasure { /** Specifies the category of feature measure. - * @Default {null} - */ + * @Default {null} + */ category?: string; /** Comparative measure render till the specified value. - * @Default {null} - */ + * @Default {null} + */ comparativeMeasureValue?: number; /** Feature measure render till the specified value. - * @Default {null} - */ + * @Default {null} + */ value?: number; } export interface QuantitativeScaleSettingsFields { /** Specifies the category of the bullet graph. - * @Default {null} - */ + * @Default {null} + */ category?: string; /** Comparative measure render based on the values in the specified field. - * @Default {null} - */ + * @Default {null} + */ comparativeMeasure?: string; /** Specifies the dataSource for the bullet graph. - * @Default {null} - */ + * @Default {null} + */ dataSource?: any; /** Feature measure render based on the values in the specified field. - * @Default {null} - */ + * @Default {null} + */ featureMeasures?: string; /** Specifies the query for fetching the values form data source to render the bullet graph. - * @Default {null} - */ + * @Default {null} + */ query?: string; /** Specifies the name of the table. - * @Default {null} - */ + * @Default {null} + */ tableName?: string; } export interface QuantitativeScaleSettingsLabelSettingsFont { /** Specifies the fontFamily of labels in bullet graph. Labels render with this fontFamily. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Specifies the fontStyle of labels in bullet graph. Labels render with this fontStyle. See FontStyle - * @Default {Normal} - */ + * @Default {Normal} + */ fontStyle?: ej.datavisualization.BulletGraph.FontStyle|string; /** Specifies the fontWeight of labels in bullet graph. Labels render with this fontWeight. See FontWeight - * @Default {regular} - */ + * @Default {regular} + */ fontWeight?: ej.datavisualization.BulletGraph.FontWeight|string; /** Specifies the opacity of labels in bullet graph. Labels render with this opacity - * @Default {1} - */ + * @Default {1} + */ opacity?: number; } export interface QuantitativeScaleSettingsLabelSettings { /** Contains property to customize the font of the labels in bullet graph. - */ + */ font?: QuantitativeScaleSettingsLabelSettingsFont; /** Specifies the placement of labels in bullet graph scale. - * @Default {outside} - */ + * @Default {outside} + */ labelPlacement?: ej.datavisualization.BulletGraph.LabelPlacement|string; /** Specifies the prefix to be added with labels in bullet graph. - * @Default {Empty string} - */ + * @Default {Empty string} + */ labelPrefix?: string; /** Specifies the suffix to be added after labels in bullet graph. - * @Default {Empty string} - */ + * @Default {Empty string} + */ labelSuffix?: string; /** Specifies the horizontal/vertical padding of labels. - * @Default {15} - */ + * @Default {15} + */ offset?: number; /** Specifies the position of the labels to render either above or below the graph. See Position - * @Default {below} - */ + * @Default {below} + */ position?: ej.datavisualization.BulletGraph.LabelPosition|string; /** Specifies the Size of the labels. - * @Default {12} - */ + * @Default {12} + */ size?: number; /** Specifies the stroke color of the labels in bullet graph. - * @Default {null} - */ + * @Default {null} + */ stroke?: string; } export interface QuantitativeScaleSettingsLocation { /** This property specifies the x position for rendering quantitative scale. - * @Default {10} - */ + * @Default {10} + */ x?: number; /** This property specifies the y position for rendering quantitative scale. - * @Default {10} - */ + * @Default {10} + */ y?: number; } export interface QuantitativeScaleSettingsMajorTickSettings { /** Specifies the size of the major ticks. - * @Default {13} - */ + * @Default {13} + */ size?: number; /** Specifies the stroke color of the major tick lines. - * @Default {null} - */ + * @Default {null} + */ stroke?: string; /** Specifies the width of the major tick lines. - * @Default {2} - */ + * @Default {2} + */ width?: number; } export interface QuantitativeScaleSettingsMinorTickSettings { /** Specifies the size of minor ticks. - * @Default {7} - */ + * @Default {7} + */ size?: number; /** Specifies the stroke color of minor ticks in bullet graph. - * @Default {null} - */ + * @Default {null} + */ stroke?: string; /** Specifies the width of the minor ticks in bullet graph. - * @Default {2} - */ + * @Default {2} + */ width?: number; } export interface QuantitativeScaleSettings { /** Contains property to customize the comparative measure. - */ + */ comparativeMeasureSettings?: QuantitativeScaleSettingsComparativeMeasureSettings; /** Contains property to customize the featured measure. - */ + */ featuredMeasureSettings?: QuantitativeScaleSettingsFeaturedMeasureSettings; /** Contains property to customize the featured measure. - */ + */ featureMeasures?: QuantitativeScaleSettingsFeatureMeasure[]; /** Contains property to customize the fields. - */ + */ fields?: QuantitativeScaleSettingsFields; /** Specifies the interval for the Graph. - * @Default {1} - */ + * @Default {1} + */ interval?: number; /** Contains property to customize the labels. - */ + */ labelSettings?: QuantitativeScaleSettingsLabelSettings; /** Contains property to customize the position of the quantitative scale - */ + */ location?: QuantitativeScaleSettingsLocation; /** Contains property to customize the major tick lines. - */ + */ majorTickSettings?: QuantitativeScaleSettingsMajorTickSettings; /** Specifies the maximum value of the Graph. - * @Default {10} - */ + * @Default {10} + */ maximum?: number; /** Specifies the minimum value of the Graph. - * @Default {0} - */ + * @Default {0} + */ minimum?: number; /** Contains property to customize the minor ticks. - */ + */ minorTickSettings?: QuantitativeScaleSettingsMinorTickSettings; /** The specified number of minor ticks will be rendered per interval. - * @Default {4} - */ + * @Default {4} + */ minorTicksPerInterval?: number; /** Specifies the placement of ticks to render either inside or outside the scale. - * @Default {ej.datavisualization.BulletGraph.TickPlacement.Outside} - */ + * @Default {ej.datavisualization.BulletGraph.TickPlacement.Outside} + */ tickPlacement?: ej.datavisualization.BulletGraph.TickPlacement|string; /** Specifies the position of the ticks to render either above,below or inside - * @Default {ej.datavisualization.BulletGraph.TickPosition.Far} - */ + * @Default {ej.datavisualization.BulletGraph.TickPosition.Far} + */ tickPosition?: ej.datavisualization.BulletGraph.TickPosition|string; } export interface TooltipSettings { /** Specifies template for caption tooltip - * @Default {null} - */ + * @Default {null} + */ captionTemplate?: string; /** Toggles the visibility of caption tooltip - * @Default {false} - */ + * @Default {false} + */ enableCaptionTooltip?: boolean; /** Specifies the ID of a div, which is to be displayed as tooltip. - * @Default {null} - */ + * @Default {null} + */ template?: string; /** Toggles the visibility of tooltip - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; } } @@ -56646,13 +56647,13 @@ class Barcode extends ej.Widget { defaults: Barcode.Model; /** To disable the barcode - * @returns {void} - */ + * @returns {void} + */ disable(): void; /** To enable the barcode - * @returns {void} - */ + * @returns {void} + */ enable(): void; } export namespace Barcode { @@ -56660,63 +56661,63 @@ export namespace Barcode { export interface Model { /** Specifies the distance between the barcode and text below it. - */ + */ barcodeToTextGapHeight?: number; /** Specifies the height of bars in the Barcode. By modifying the barHeight, the entire barcode height can be customized. - * Please refer to xDimension for two dimensional barcode height customization. - */ + * Please refer to xDimension for two dimensional barcode height customization. + */ barHeight?: number; /** Specifies the dark bar color of the Barcode. One dimensional barcode contains a series of dark and light bars which are usually colored as black and white respectively. - */ + */ darkBarColor?: any; /** Specifies whether the text below the barcode is visible or hidden. - */ + */ displayText?: boolean; /** Specifies whether the control is enabled. - */ + */ enabled?: boolean; /** Specifies the start and stop encode symbol in the Barcode. In one dimensional barcodes, an additional character is added as start and stop delimiters. - * These symbols are optional and the unique of the symbol allows the reader to determine the direction of the barcode being scanned. - */ + * These symbols are optional and the unique of the symbol allows the reader to determine the direction of the barcode being scanned. + */ encodeStartStopSymbol?: number; /** Specifies the light bar color of the Barcode. One dimensional barcode contains a series of dark and light bars which are usually colored as black and white respectively. - */ + */ lightBarColor?: any; /** Specifies the width of the narrow bars in the barcode. The dark bars in the one dimensional barcode contains random narrow and wide bars based on - * the provided input which can be specified during initialization. - */ + * the provided input which can be specified during initialization. + */ narrowBarWidth?: number; /** Specifies the width of the quiet zone. In barcode, a quiet zone is the blank margin on either side of a barcode which informs the reader where a barcode's symbology starts and stops. - * The purpose of a quiet zone is to prevent the reader from picking up unrelated information. - */ + * The purpose of a quiet zone is to prevent the reader from picking up unrelated information. + */ quietZone?: QuietZone; /** Specifies the type of the Barcode. See SymbologyType - */ + */ symbologyType?: ej.datavisualization.Barcode.SymbologyType|string; /** Specifies the text to be encoded in the barcode. - */ + */ text?: string; /** Specifies the color of the text/data at the bottom of the barcode. - */ + */ textColor?: any; /** Specifies the width of the wide bars in the barcode. One dimensional barcode usually contains random narrow and wide bars based on the provided which can be customized during initialization. - */ + */ wideBarWidth?: number; /** Specifies the width of the narrowest element(bar or space) in a barcode. The greater the x dimension, the more easily a barcode reader will scan. - */ + */ xDimension?: number; /** Fires after Barcode control is loaded. */ @@ -56726,42 +56727,42 @@ export interface Model { export interface LoadEventArgs { /** if the event should be canceled; otherwise, false. - */ + */ cancel?: boolean; /** returns the barcode model - */ + */ model?: any; /** returns the name of the event - */ + */ type?: string; /** return the barcode state - */ + */ status?: boolean; } export interface QuietZone { /** Specifies the quiet zone around the Barcode. - */ + */ all?: number; /** Specifies the bottom quiet zone of the Barcode. - */ + */ bottom?: number; /** Specifies the left quiet zone of the Barcode. - */ + */ left?: number; /** Specifies the right quiet zone of the Barcode. - */ + */ right?: number; /** Specifies the top quiet zone of the Barcode. - */ + */ top?: number; } } @@ -56802,40 +56803,40 @@ class Map extends ej.Widget { defaults: Map.Model; /** Method for navigating to specific shape based on latitude, longitude and zoom level. - * @param {number} Pass the latitude value for map - * @param {number} Pass the longitude value for map - * @param {number} Pass the zoom level for map - * @returns {void} - */ + * @param {number} Pass the latitude value for map + * @param {number} Pass the longitude value for map + * @param {number} Pass the zoom level for map + * @returns {void} + */ navigateTo(latitude: number, longitude: number, level: number): void; /** Method to perform map panning - * @param {string} Pass the direction in which map should be panned - * @returns {void} - */ + * @param {string} Pass the direction in which map should be panned + * @returns {void} + */ pan(direction: string): void; /** Method to reload the map. - * @returns {void} - */ + * @returns {void} + */ refresh(): void; /** Method to reload the shapeLayers with updated values - * @returns {void} - */ + * @returns {void} + */ refreshLayers(): void; /** Method to reload the navigation control with updated values. - * @param {any} Pass the navigation control instance - * @returns {void} - */ + * @param {any} Pass the navigation control instance + * @returns {void} + */ refreshNavigationControl(navigation: any): void; /** Method to perform map zooming. - * @param {number} Pass the zoom level for map to be zoomed - * @param {boolean} Pass the boolean value to enable or disable animation while zooming - * @returns {void} - */ + * @param {number} Pass the zoom level for map to be zoomed + * @param {boolean} Pass the boolean value to enable or disable animation while zooming + * @returns {void} + */ zoom(level: number, isAnimate: boolean): void; } export namespace Map { @@ -56843,50 +56844,50 @@ export namespace Map { export interface Model { /** Specifies the background color for map - * @Default {transparent} - */ + * @Default {transparent} + */ background?: string; /** Specifies the index of the map to determine the shape layer to be displayed - * @Default {0} - */ + * @Default {0} + */ baseMapIndex?: number; /** Specify the center position where map should be displayed - * @Default {[0,0]} - */ + * @Default {[0,0]} + */ centerPosition?: any; /** Enables or Disables the map animation - * @Default {false} - */ + * @Default {false} + */ enableAnimation?: boolean; /** Enables or Disables the animation for layer change in map - * @Default {false} - */ + * @Default {false} + */ enableLayerChangeAnimation?: boolean; /** Enables or Disables the map panning - * @Default {true} - */ + * @Default {true} + */ enablePan?: boolean; /** Determines whether map need to resize when container is resized - * @Default {true} - */ + * @Default {true} + */ enableResize?: boolean; /** Enables or Disables the Zooming for map. - */ + */ zoomSettings?: ZoomSettings; /** Enables or Disables the navigation control for map to perform zooming and panning on map shapes. - */ + */ navigationControl?: NavigationControl; /** Layer for holding the map shapes - */ + */ layers?: Layer[]; /** Triggered on selecting the map markers. */ @@ -56917,559 +56918,559 @@ export interface Model { export interface MarkerSelectedEventArgs { /** Returns marker object. - */ + */ originalEvent?: any; } export interface MouseleaveEventArgs { /** Returns hovered map shape object. - */ + */ originalEvent?: any; } export interface MouseoverEventArgs { /** Returns hovered map shape object. - */ + */ originalEvent?: any; } export interface OnRenderCompleteEventArgs { /** Event parameters from map - */ + */ originalEvent?: any; } export interface PannedEventArgs { /** Event parameters from map - */ + */ originalEvent?: any; } export interface ShapeSelectedEventArgs { /** Returns selected shape object. - */ + */ originalEvent?: any; } export interface ZoomedInEventArgs { /** Event parameters from map - */ + */ originalEvent?: any; /** Returns zoom level value for which the map is zoomed. - */ + */ zoomLevel?: any; } export interface ZoomedOutEventArgs { /** Event parameters from map - */ + */ originalEvent?: any; /** Returns zoom level value for which the map is zoomed. - */ + */ zoomLevel?: any; } export interface ZoomSettings { /** Enables or Disables the zooming of map - * @Default {true} - */ + * @Default {true} + */ enableZoom?: boolean; /** Enables or Disables the zoom on selecting the map shape - * @Default {false} - */ + * @Default {false} + */ enableZoomOnSelection?: boolean; /** Specifies the zoom factor for map zoom value. - * @Default {1} - */ + * @Default {1} + */ factor?: number; /** Specifies the zoom level value for which map to be zoomed - * @Default {1} - */ + * @Default {1} + */ level?: number; /** Specifies the minimum zoomSettings level of the map - * @Default {1} - */ + * @Default {1} + */ minValue?: number; /** Specifies the maximum zoom level of the map - * @Default {100} - */ + * @Default {100} + */ maxValue?: number; } export interface NavigationControl { /** Set the absolutePosition for navigation control - * @Default {{x:0,y:0}} - */ + * @Default {{x:0,y:0}} + */ absolutePosition?: any; /** Specifies the navigation control template for map - * @Default {null} - */ + * @Default {null} + */ content?: string; /** Set the dockPosition value for navigation control - * @Default {centerleft} - */ + * @Default {centerleft} + */ dockPosition?: ej.datavisualization.Map.Position|string; /** Enables or Disables the Navigation for handling zooming map - * @Default {false} - */ + * @Default {false} + */ enableNavigation?: boolean; /** Set the orientation value for navigation control - * @Default {vertical} - */ + * @Default {vertical} + */ orientation?: ej.datavisualization.Map.LabelOrientation|string; } export interface LayersBubbleSettingsColorMappingsRangeColorMapping { /** Start range colorMappings in the bubble layer. - * @Default {null} - */ + * @Default {null} + */ from?: number; /** End range colorMappings in the bubble layer. - * @Default {null} - */ + * @Default {null} + */ to?: number; /** GradientColors in the bubble layer of map. - */ + */ gradientColors?: any[]; /** Color of the bubble layer. - * @Default {null} - */ + * @Default {null} + */ color?: string; } export interface LayersBubbleSettingsColorMappings { /** Specifies the range colorMappings in the bubble layer. - * @Default {null} - */ + * @Default {null} + */ rangeColorMapping?: LayersBubbleSettingsColorMappingsRangeColorMapping[]; } export interface LayersBubbleSettings { /** Specifies the bubble Opacity value of bubbles for shape layer in map - * @Default {0.9} - */ + * @Default {0.9} + */ bubbleOpacity?: number; /** Specifies the mouse hover color of the shape layer in map - * @Default {gray} - */ + * @Default {gray} + */ color?: string; /** Specifies the colorMappings of the shape layer in map - * @Default {null} - */ + * @Default {null} + */ colorMappings?: LayersBubbleSettingsColorMappings; /** Specifies the bubble color valuePath of the shape layer in map - * @Default {null} - */ + * @Default {null} + */ colorValuePath?: string; /** Specifies the maximum size value of bubbles for shape layer in map - * @Default {20} - */ + * @Default {20} + */ maxValue?: number; /** Specifies the minimum size value of bubbles for shape layer in map - * @Default {10} - */ + * @Default {10} + */ minValue?: number; /** Specifies the showBubble visibility status map - * @Default {true} - */ + * @Default {true} + */ showBubble?: boolean; /** Specifies the tooltip visibility status of the shape layer in map - * @Default {false} - */ + * @Default {false} + */ showTooltip?: boolean; /** Specifies the bubble tooltip template of the shape layer in map - * @Default {null} - */ + * @Default {null} + */ tooltipTemplate?: string; /** Specifies the bubble valuePath of the shape layer in map - * @Default {null} - */ + * @Default {null} + */ valuePath?: string; } export interface LayersLabelSettings { /** enable or disable the enableSmartLabel property - * @Default {false} - */ + * @Default {false} + */ enableSmartLabel?: boolean; /** set the labelLength property - * @Default {'2'} - */ + * @Default {'2'} + */ labelLength?: number; /** set the labelPath property - * @Default {null} - */ + * @Default {null} + */ labelPath?: string; /** The property specifies whether to show labels or not. - * @Default {false} - */ + * @Default {false} + */ showLabels?: boolean; /** set the smartLabelSize property - * @Default {fixed} - */ + * @Default {fixed} + */ smartLabelSize?: ej.datavisualization.Map.LabelSize|string; } export interface LayersLegendSettings { /** Determines whether the legend should be placed outside or inside the map bounds - * @Default {false} - */ + * @Default {false} + */ dockOnMap?: boolean; /** Determines the legend placement and it is valid only when dockOnMap is true - * @Default {top} - */ + * @Default {top} + */ dockPosition?: ej.datavisualization.Map.DockPosition|string; /** height value for legend setting - * @Default {0} - */ + * @Default {0} + */ height?: number; /** to get icon value for legend setting - * @Default {rectangle} - */ + * @Default {rectangle} + */ icon?: ej.datavisualization.Map.LegendIcons|string; /** icon height value for legend setting - * @Default {20} - */ + * @Default {20} + */ iconHeight?: number; /** icon Width value for legend setting - * @Default {20} - */ + * @Default {20} + */ iconWidth?: number; /** set the orientation of legend labels - * @Default {vertical} - */ + * @Default {vertical} + */ labelOrientation?: ej.datavisualization.Map.LabelOrientation|string; /** to get leftLabel value for legend setting - * @Default {null} - */ + * @Default {null} + */ leftLabel?: string; /** to get mode of legend setting - * @Default {default} - */ + * @Default {default} + */ mode?: ej.datavisualization.Map.Mode|string; /** set the position of legend settings - * @Default {topleft} - */ + * @Default {topleft} + */ position?: ej.datavisualization.Map.Position|string; /** x position value for legend setting - * @Default {0} - */ + * @Default {0} + */ positionX?: number; /** y position value for legend setting - * @Default {0} - */ + * @Default {0} + */ positionY?: number; /** to get rightLabel value for legend setting - * @Default {null} - */ + * @Default {null} + */ rightLabel?: string; /** Enables or Disables the showLabels - * @Default {false} - */ + * @Default {false} + */ showLabels?: boolean; /** Enables or Disables the showLegend - * @Default {false} - */ + * @Default {false} + */ showLegend?: boolean; /** to get title of legend setting - * @Default {null} - */ + * @Default {null} + */ title?: string; /** to get type of legend setting - * @Default {layers} - */ + * @Default {layers} + */ type?: ej.datavisualization.Map.LegendType|string; /** width value for legend setting - * @Default {0} - */ + * @Default {0} + */ width?: number; } export interface LayersShapeSettingsColorMappingsRangeColorMapping { /** Specifies the start range colorMappings in the shape layer of map. - * @Default {null} - */ + * @Default {null} + */ from?: number; /** Specifies the to range colorMappings in the shape layer of map. - * @Default {null} - */ + * @Default {null} + */ to?: number; /** Specifies the gradientColors in the shape layer of map. - * @Default {null} - */ + * @Default {null} + */ gradientColors?: any[]; } export interface LayersShapeSettingsColorMappingsEqualColorMapping { /** Specifies the equalColorMapping value in the shape layer of map. - * @Default {null} - */ + * @Default {null} + */ value?: string; /** Specifies the equalColorMapping color in the shape layer of map. - * @Default {null} - */ + * @Default {null} + */ color?: string; } export interface LayersShapeSettingsColorMappings { /** Specifies the range colorMappings in the shape layer of map. - * @Default {null} - */ + * @Default {null} + */ rangeColorMapping?: LayersShapeSettingsColorMappingsRangeColorMapping[]; /** Specifies the equalColorMapping in the shape layer of map. - * @Default {null} - */ + * @Default {null} + */ equalColorMapping?: LayersShapeSettingsColorMappingsEqualColorMapping[]; } export interface LayersShapeSettings { /** Enables or Disables the auto fill colors for shape layer in map. When this property value set to true, shapes will be filled with palette colors. - * @Default {false} - */ + * @Default {false} + */ autoFill?: boolean; /** Specifies the colorMappings of the shape layer in map - * @Default {null} - */ + * @Default {null} + */ colorMappings?: LayersShapeSettingsColorMappings; /** Specifies the shape color palette value of the shape layer in map. Accepted colorPalette values are palette1, palette2, palette3 and custompalette. - * @Default {palette1} - */ + * @Default {palette1} + */ colorPalette?: ej.datavisualization.Map.ColorPalette|string; /** Specifies the shape color valuePath of the shape layer in map - * @Default {null} - */ + * @Default {null} + */ colorValuePath?: string; /** Enables or Disables the gradient colors for map shapes. - * @Default {false} - */ + * @Default {false} + */ enableGradient?: boolean; /** Specifies the shape fill color of the shape layer in map - * @Default {#E5E5E5} - */ + * @Default {#E5E5E5} + */ fill?: string; /** Specifies the mouse over width of the shape layer in map - * @Default {1} - */ + * @Default {1} + */ highlightBorderWidth?: number; /** Specifies the mouse hover color of the shape layer in map - * @Default {gray} - */ + * @Default {gray} + */ highlightColor?: string; /** Specifies the mouse over stroke color of the shape layer in map - * @Default {#C1C1C1} - */ + * @Default {#C1C1C1} + */ highlightStroke?: string; /** Specifies the shape selection color of the shape layer in map - * @Default {gray} - */ + * @Default {gray} + */ selectionColor?: string; /** Specifies the shape selection stroke color of the shape layer in map - * @Default {#C1C1C1} - */ + * @Default {#C1C1C1} + */ selectionStroke?: string; /** Specifies the shape selection stroke width of the shape layer in map - * @Default {1} - */ + * @Default {1} + */ selectionStrokeWidth?: number; /** Specifies the shape stroke color of the shape layer in map - * @Default {#C1C1C1} - */ + * @Default {#C1C1C1} + */ stroke?: string; /** Specifies the shape stroke thickness value of the shape layer in map - * @Default {0.2} - */ + * @Default {0.2} + */ strokeThickness?: number; /** Specifies the shape valuePath of the shape layer in map - * @Default {null} - */ + * @Default {null} + */ valuePath?: string; } export interface Layer { /** to get the type of bing map. - * @Default {aerial} - */ + * @Default {aerial} + */ bingMapType?: ej.datavisualization.Map.BingMapType|string; /** Specifies the bubble settings for map - */ + */ bubbleSettings?: LayersBubbleSettings; /** Specifies the datasource for the shape layer - */ + */ dataSource?: any; /** Specifies the data path of shape - */ + */ shapeDataPath?: string; /** Specifies the data path of shape - */ + */ shapePropertyPath?: string; /** Enables or disables the shape mouse hover - * @Default {false} - */ + * @Default {false} + */ enableMouseHover?: boolean; /** Enables or disables the shape selection - * @Default {true} - */ + * @Default {true} + */ enableSelection?: boolean; /** to get the key of bing map - * @Default {null} - */ + * @Default {null} + */ key?: string; /** Options for enabling and configuring labelSettings labelPath, smartLabelSize, labelLength etc., - */ + */ labelSettings?: LayersLabelSettings; /** Specifies the map view type. - * @Default {'geographic'} - */ + * @Default {'geographic'} + */ geometryType?: ej.datavisualization.Map.GeometryType|string; /** Specifies the map type. - * @Default {'geometry'} - */ + * @Default {'geometry'} + */ layerType?: ej.datavisualization.Map.LayerType|string; /** Options for enabling and configuring legendSettings position, height, width, mode, type etc., - */ + */ legendSettings?: LayersLegendSettings; /** Specifies the map items template for shapes. - */ + */ mapItemsTemplate?: string; /** Specify markers for shape layer. - * @Default {[]} - */ + * @Default {[]} + */ markers?: any[]; /** Specifies the map marker template for map layer. - * @Default {null} - */ + * @Default {null} + */ markerTemplate?: string; /** Specify selectedMapShapes for shape layer - * @Default {[]} - */ + * @Default {[]} + */ selectedMapShapes?: any[]; /** Specifies the selection mode of the map. Accepted selection mode values are Default and Multiple. - * @Default {default} - */ + * @Default {default} + */ selectionMode?: ej.datavisualization.Map.SelectionMode|string; /** Specifies the shape data for the shape layer - */ + */ shapeData?: any; /** Specifies the shape settings of map layer - */ + */ shapeSettings?: LayersShapeSettings; /** Shows or hides the map items. - * @Default {false} - */ + * @Default {false} + */ showMapItems?: boolean; /** Shows or hides the tooltip for shapes - * @Default {false} - */ + * @Default {false} + */ showTooltip?: boolean; /** Specifies the tooltip template for shapes. - */ + */ tooltipTemplate?: string; /** Specifies the URL template for the OSM type map. - * @Default {'http://a.tile.openstreetmap.org/level/tileX/tileY.png'} - */ + * @Default {'http://a.tile.openstreetmap.org/level/tileX/tileY.png'} + */ urlTemplate?: string; } } @@ -57606,8 +57607,8 @@ class TreeMap extends ej.Widget { defaults: TreeMap.Model; /** Method to reload treemap with updated values. - * @returns {void} - */ + * @returns {void} + */ refresh(): void; } export namespace TreeMap { @@ -57615,182 +57616,182 @@ export namespace TreeMap { export interface Model { /** Specifies the border brush color of the treemap - * @Default {white} - */ + * @Default {white} + */ borderBrush?: string; /** Specifies the border thickness of the treemap - * @Default {1} - */ + * @Default {1} + */ borderThickness?: number; /** Specifies the uniColorMapping settings of the treemap - */ + */ uniColorMapping?: UniColorMapping; /** Specifies the desaturationColorMapping settings of the treemap - */ + */ desaturationColorMapping?: DesaturationColorMapping; /** Specifies the paletteColorMapping of the treemap - */ + */ paletteColorMapping?: PaletteColorMapping; /** Specifies the color value path of the treemap - * @Default {null} - */ + * @Default {null} + */ colorValuePath?: string; /** Specifies the datasource of the treemap - * @Default {null} - */ + * @Default {null} + */ dataSource?: any; /** Specifies the dockPosition for legend - * @Default {top} - */ + * @Default {top} + */ dockPosition?: ej.datavisualization.TreeMap.DockPosition|string; /** specifies the drillDown header color - * @Default {'null'} - */ + * @Default {'null'} + */ drillDownHeaderColor?: string; /** specifies the drillDown selection color - * @Default {'#000000'} - */ + * @Default {'#000000'} + */ drillDownSelectionColor?: string; /** Specifies whether datasource is hierarchical or not. - * @Default {false} - */ + * @Default {false} + */ isHierarchicalDatasource?: boolean; /** Specifies the header for parent item during drilldown. This is applicable only for hierarchical data source. - * @Default {null} - */ + * @Default {null} + */ header?: string; /** Enable/Disable the drillDown for treemap - * @Default {false} - */ + * @Default {false} + */ enableDrillDown?: boolean; /** Controls whether Treemap has to be responsive while resizing the window. - * @Default {true} - */ + * @Default {true} + */ isResponsive?: boolean; /** Specifies whether treemap need to resize when container is resized - * @Default {true} - */ + * @Default {true} + */ enableResize?: boolean; /** This property is used to select treemap items while clicking and dragging - * @Default {false} - */ + * @Default {false} + */ draggingOnSelection?: boolean; /** This property is used to select group of treemap items while clicking and dragging - * @Default {false} - */ + * @Default {false} + */ draggingGroupOnSelection?: boolean; /** Specifies the group color mapping of the treemap - * @Default {[]} - */ + * @Default {[]} + */ groupColorMapping?: GroupColorMapping[]; /** Specifies the legend settings of the treemap - */ + */ legendSettings?: LegendSettings; /** Specifies the highlight border brush of treemap - * @Default {gray} - */ + * @Default {gray} + */ highlightBorderBrush?: string; /** Specifies the border thickness when treemap items is highlighted in the treemap - * @Default {5} - */ + * @Default {5} + */ highlightBorderThickness?: number; /** Specifies the highlight border brush of treemap - * @Default {gray} - */ + * @Default {gray} + */ highlightGroupBorderBrush?: string; /** Specifies the border thickness when treemap items is highlighted in the treemap - * @Default {5} - */ + * @Default {5} + */ highlightGroupBorderThickness?: number; /** Specifies whether treemap item need to highlighted on selection - * @Default {false} - */ + * @Default {false} + */ highlightGroupOnSelection?: boolean; /** Specifies whether treemap item need to highlighted on selection - * @Default {false} - */ + * @Default {false} + */ highlightOnSelection?: boolean; /** Specifies the items layout mode of the treemap. Accepted itemsLayoutMode values are Squarified, SliceAndDiceHorizontal, SliceAndDiceVertical and SliceAndDiceAuto - * @Default {Squarified} - */ + * @Default {Squarified} + */ itemsLayoutMode?: ej.datavisualization.TreeMap.ItemsLayoutMode|string; /** Specifies the leaf settings of the treemap - */ + */ leafItemSettings?: LeafItemSettings; /** Specifies the rangeColorMapping settings of the treemap - * @Default {[]} - */ + * @Default {[]} + */ rangeColorMapping?: RangeColorMapping[]; /** Specifies the selection mode of treemap item. Accepted selection mode values are Default and Multiple. - * @Default {default} - */ + * @Default {default} + */ selectionMode?: ej.datavisualization.TreeMap.selectionMode|string; /** Specifies the selection mode of the treemap. Accepted selection mode values are Default and Multiple. - * @Default {default} - */ + * @Default {default} + */ groupSelectionMode?: ej.datavisualization.TreeMap.groupSelectionMode|string; /** Specifies the legend visibility status of the treemap - * @Default {false} - */ + * @Default {false} + */ showLegend?: boolean; /** Specifies whether gradient color has to be applied for treemap items - * @Default {false} - */ + * @Default {false} + */ enableGradient?: boolean; /** Specifies whether treemap showTooltip need to be visible - */ + */ showTooltip?: boolean; /** Specifies the tooltip template of the treemap - * @Default {null} - */ + * @Default {null} + */ tooltipTemplate?: string; /** Hold the treeMapItems to be displayed in treemap - * @Default {[]} - */ + * @Default {[]} + */ treeMapItems?: any[]; /** Specify levels of treemap for grouped visualization of data - * @Default {[]} - */ + * @Default {[]} + */ levels?: Level[]; /** Specifies the weight value path of the treemap - * @Default {null} - */ + * @Default {null} + */ weightValuePath?: string; /** Triggers on treemap item selected. */ @@ -57800,257 +57801,257 @@ export interface Model { export interface TreeMapItemSelectedEventArgs { /** Returns selected treeMapItem object. - */ + */ originalEvent?: any; } export interface UniColorMapping { /** Specifies the uniform color mapping of the treemap - * @Default {null} - */ + * @Default {null} + */ color?: string; } export interface DesaturationColorMapping { /** Specifies the to value for desaturation color mapping - * @Default {0} - */ + * @Default {0} + */ to?: number; /** Specifies the color for desaturationColorMapping - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Specifies the from value for desaturation color mapping - * @Default {0} - */ + * @Default {0} + */ from?: number; /** Specifies the rangeMaximum value for desaturation color mapping - * @Default {0} - */ + * @Default {0} + */ rangeMaximum?: number; /** Specifies the rangeMinimum value for desaturation color mapping - * @Default {0} - */ + * @Default {0} + */ rangeMinimum?: number; } export interface PaletteColorMapping { /** Specifies the colors of the paletteColorMapping - * @Default {[]} - */ + * @Default {[]} + */ colors?: any[]; } export interface GroupColorMapping { /** Specifies the groupID for GroupColorMapping. - * @Default {null} - */ + * @Default {null} + */ groupID?: string; } export interface LegendSettings { /** Specifies the height for legend - * @Default {30} - */ + * @Default {30} + */ height?: number; /** Specifies the width for legend - * @Default {100} - */ + * @Default {100} + */ width?: number; /** Specifies the iconHeight for legend - * @Default {15} - */ + * @Default {15} + */ iconHeight?: number; /** Specifies the iconWidth for legend - * @Default {15} - */ + * @Default {15} + */ iconWidth?: number; /** Specifies the template for legendSettings - * @Default {null} - */ + * @Default {null} + */ template?: string; /** Specifies the mode for legendSettings whether default or interactive mode - * @Default {default} - */ + * @Default {default} + */ mode?: string; /** Specifies the title text for legend - */ + */ title?: string; /** Specifies the leftLabel text for legend - */ + */ leftLabel?: string; /** Specifies the rightLabel text for legend - */ + */ rightLabel?: string; /** Specifies the dockPosition text for legend - * @Default {top} - */ + * @Default {top} + */ dockPosition?: string; /** Specifies the alignment text for legend - * @Default {near} - */ + * @Default {near} + */ alignment?: string; /** Specifies the alignment text for legend - * @Default {0} - */ + * @Default {0} + */ columnCount?: number; } export interface LeafItemSettings { /** Specifies the border brush color of the leaf item. - * @Default {white} - */ + * @Default {white} + */ borderBrush?: string; /** Specifies the border thickness of the leaf item. - * @Default {1} - */ + * @Default {1} + */ borderThickness?: number; /** Specifies the label template of the leaf item. - * @Default {null} - */ + * @Default {null} + */ itemTemplate?: string; /** Specifies the label path of the leaf item. - * @Default {null} - */ + * @Default {null} + */ labelPath?: string; /** Specifies the position of the leaf labels. - * @Default {center} - */ + * @Default {center} + */ labelPosition?: ej.datavisualization.TreeMap.Position|string; /** Specifies the mode of label visibility - * @Default {visible} - */ + * @Default {visible} + */ labelVisibilityMode?: ej.datavisualization.TreeMap.VisibilityMode|string; /** Shows or hides the label of the leaf item. - * @Default {false} - */ + * @Default {false} + */ showLabels?: boolean; } export interface RangeColorMapping { /** Specifies the color value for rangeColorMapping. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** specifies the gradient colors for th given range value - * @Default {[]} - */ + * @Default {[]} + */ gradientColors?: any[]; /** Specifies the from value for rangeColorMapping. - * @Default {-1} - */ + * @Default {-1} + */ from?: number; /** Specifies the legend label value for rangeColorMapping. - * @Default {null} - */ + * @Default {null} + */ legendLabel?: string; /** Specifies the to value for rangeColorMapping. - * @Default {-1} - */ + * @Default {-1} + */ to?: number; } export interface Level { /** specifies the group background - * @Default {null} - */ + * @Default {null} + */ groupBackground?: string; /** Specifies the group border color for tree map level. - * @Default {null} - */ + * @Default {null} + */ groupBorderColor?: string; /** Specifies the group border thickness for tree map level. - * @Default {1} - */ + * @Default {1} + */ groupBorderThickness?: number; /** Specifies the group gap for tree map level. - * @Default {1} - */ + * @Default {1} + */ groupGap?: number; /** Specifies the group padding for tree map level. - * @Default {4} - */ + * @Default {4} + */ groupPadding?: number; /** Specifies the group path for tree map level. - */ + */ groupPath?: string; /** Specifies the header height for tree map level. - * @Default {0} - */ + * @Default {0} + */ headerHeight?: number; /** Specifies the header template for tree map level. - * @Default {null} - */ + * @Default {null} + */ headerTemplate?: string; /** Specifies the mode of header visibility - * @Default {visible} - */ + * @Default {visible} + */ headerVisibilityMode?: ej.datavisualization.TreeMap.VisibilityMode|string; /** Specifies the position of the labels. - * @Default {center} - */ + * @Default {center} + */ labelPosition?: ej.datavisualization.TreeMap.Position|string; /** Specifies the label template for tree map level. - * @Default {null} - */ + * @Default {null} + */ labelTemplate?: string; /** Specifies the mode of label visibility - * @Default {visible} - */ + * @Default {visible} + */ labelVisibilityMode?: ej.datavisualization.TreeMap.VisibilityMode|string; /** Shows or hides the header for tree map level. - * @Default {false} - */ + * @Default {false} + */ showHeader?: boolean; /** Shows or hides the labels for tree map level. - * @Default {false} - */ + * @Default {false} + */ showLabels?: boolean; } } @@ -58135,321 +58136,321 @@ class Diagram extends ej.Widget { defaults: Diagram.Model; /** Add nodes and connectors to diagram at runtime - * @param {any} a JSON to define a node/connector or an array of nodes and connector - * @returns {boolean} - */ + * @param {any} a JSON to define a node/connector or an array of nodes and connector + * @returns {boolean} + */ add(node: any): boolean; /** Add a label to a node at runtime - * @param {string} name of the node to which label will be added - * @param {any} JSON for the new label to be added - * @returns {void} - */ + * @param {string} name of the node to which label will be added + * @param {any} JSON for the new label to be added + * @returns {void} + */ addLabel(nodeName: string, newLabel: any): void; /** Add dynamic Lanes to swimlane at runtime - * @param {any} JSON for the new lane to be added - * @param {number} Index value to add the lane in swimlane - * @returns {void} - */ + * @param {any} JSON for the new lane to be added + * @param {number} Index value to add the lane in swimlane + * @returns {void} + */ addLane(lane: any, index: number): void; /** Add a phase to a swimlane at runtime - * @param {string} name of the swimlane to which the phase will be added - * @param {any} JSON object to define the phase to be added - * @returns {void} - */ + * @param {string} name of the swimlane to which the phase will be added + * @param {any} JSON object to define the phase to be added + * @returns {void} + */ addPhase(name: string, options: any): void; /** Add a collection of ports to the node specified by name - * @param {string} name of the node to which the ports have to be added - * @param {Array} a collection of ports to be added to the specified node - * @returns {void} - */ + * @param {string} name of the node to which the ports have to be added + * @param {Array} a collection of ports to be added to the specified node + * @returns {void} + */ addPorts(name: string, ports: any[]): void; /** Add the specified node to selection list - * @param {any} the node to be selected - * @param {boolean} to define whether to clear the existing selection or not - * @returns {void} - */ + * @param {any} the node to be selected + * @param {boolean} to define whether to clear the existing selection or not + * @returns {void} + */ addSelection(node: any, clearSelection?: boolean): void; /** Align the selected objects based on the reference object and direction - * @param {string} to specify the direction towards which the selected objects are to be aligned("left","right",top","bottom") - * @returns {void} - */ + * @param {string} to specify the direction towards which the selected objects are to be aligned("left","right",top","bottom") + * @returns {void} + */ align(direction: string): void; /** Bring the specified portion of the diagram content to the diagram viewport - * @param {any} the rectangular region that is to be brought into diagram viewport - * @returns {void} - */ + * @param {any} the rectangular region that is to be brought into diagram viewport + * @returns {void} + */ bringIntoView(rect: any): void; /** Bring the specified portion of the diagram content to the center of the diagram viewport - * @param {any} the rectangular region that is to be brought to the center of diagram viewport - * @returns {void} - */ + * @param {any} the rectangular region that is to be brought to the center of diagram viewport + * @returns {void} + */ bringToCenter(rect: any): void; /** Visually move the selected object over all other intersected objects - * @returns {void} - */ + * @returns {void} + */ bringToFront(): void; /** Remove all the elements from diagram - * @returns {void} - */ + * @returns {void} + */ clear(): void; /** Clears the actions which is recorded to perform undo/redo operation in the diagram. - * @returns {void} - */ + * @returns {void} + */ clearHistory(): void; /** Remove the current selection in diagram - * @returns {void} - */ + * @returns {void} + */ clearSelection(): void; /** Copy the selected object to internal clipboard and get the copied object - * @returns {any} - */ + * @returns {any} + */ copy(): any; /** Cut the selected object from diagram to diagram internal clipboard - * @returns {void} - */ + * @returns {void} + */ cut(): void; /** Export the diagram as downloadable files or as data - * @param {Diagram.Options} options to export the desired region of diagram to the desired formats. - * @returns {string} - */ + * @param {Diagram.Options} options to export the desired region of diagram to the desired formats. + * @returns {string} + */ exportDiagram(options?: Diagram.Options): string; /** Read a node/connector object by its name - * @param {string} name of the node/connector that is to be identified - * @returns {any} - */ + * @param {string} name of the node/connector that is to be identified + * @returns {any} + */ findNode(name: string): any; /** Fit the diagram content into diagram viewport - * @param {string} to set the mode of fit to command. See [Fit Mode](/api/js/global#fitmode) - * @param {string} to set whether the region to be fit will be based on diagram elements or page settings [Region](/api/js/global#region) - * @param {any} to set the required margin - * @returns {void} - */ + * @param {string} to set the mode of fit to command. See [Fit Mode](/api/js/global#fitmode) + * @param {string} to set whether the region to be fit will be based on diagram elements or page settings [Region](/api/js/global#region) + * @param {any} to set the required margin + * @returns {void} + */ fitToPage(mode?: string, region?: string, margin?: any): void; /** Group the selected nodes and connectors - * @returns {void} - */ + * @returns {void} + */ group(): void; /** Insert a label into a node's label collection at runtime - * @param {string} name of the node to which the label has to be inserted - * @param {any} JSON to define the new label - * @param {number} index to insert the label into the node - * @returns {void} - */ + * @param {string} name of the node to which the label has to be inserted + * @param {any} JSON to define the new label + * @param {number} index to insert the label into the node + * @returns {void} + */ insertLabel(name: string, label: any, index?: number): void; /** Refresh the diagram with the specified layout - * @returns {void} - */ + * @returns {void} + */ layout(): void; /** Load the diagram - * @param {any} JSON data to load the diagram - * @returns {void} - */ + * @param {any} JSON data to load the diagram + * @returns {void} + */ load(data: any): void; /** Visually move the selected object over its closest intersected object - * @returns {void} - */ + * @returns {void} + */ moveForward(): void; /** Move the selected objects by either one pixel or by the pixels specified through argument - * @param {string} specifies the direction to move the selected objects ("left","right",top","bottom") - * @param {number} specifies the number of pixels by which the selected objects have to be moved - * @returns {void} - */ + * @param {string} specifies the direction to move the selected objects ("left","right",top","bottom") + * @param {number} specifies the number of pixels by which the selected objects have to be moved + * @returns {void} + */ nudge(direction: string, delta?: number): void; /** Paste the selected object from internal clipboard to diagram - * @param {any} object to be added to diagram - * @param {boolean} to define whether the specified object is to be renamed or not - * @returns {void} - */ + * @param {any} object to be added to diagram + * @param {boolean} to define whether the specified object is to be renamed or not + * @returns {void} + */ paste(object?: any, rename?: boolean): void; /** Print the diagram as image - * @returns {void} - */ + * @returns {void} + */ print(): void; /** Restore the last action that was reverted - * @returns {void} - */ + * @returns {void} + */ redo(): void; /** Refresh the diagram at runtime - * @returns {void} - */ + * @returns {void} + */ refresh(): void; /** Remove either the given node/connector or the selected element from diagram - * @param {any} the node/connector to be removed from diagram - * @returns {void} - */ + * @param {any} the node/connector to be removed from diagram + * @returns {void} + */ remove(node?: any): void; /** Remove a particular object from selection list - * @param {any} the node/connector to be removed from selection list - * @returns {void} - */ + * @param {any} the node/connector to be removed from selection list + * @returns {void} + */ removeSelection(node: any): void; /** Scale the selected objects to the height of the first selected object - * @returns {void} - */ + * @returns {void} + */ sameHeight(): void; /** Scale the selected objects to the size of the first selected object - * @returns {void} - */ + * @returns {void} + */ sameSize(): void; /** Scale the selected objects to the width of the first selected object - * @returns {void} - */ + * @returns {void} + */ sameWidth(): void; /** Returns the diagram as serialized JSON - * @returns {any} - */ + * @returns {any} + */ save(): any; /** Bring the node into view - * @param {any} the node/connector to be brought into view - * @returns {void} - */ + * @param {any} the node/connector to be brought into view + * @returns {void} + */ scrollToNode(node: any): void; /** Select all nodes and connector in diagram - * @returns {void} - */ + * @returns {void} + */ selectAll(): void; /** Visually move the selected object behind its closest intersected object - * @returns {void} - */ + * @returns {void} + */ sendBackward(): void; /** Visually move the selected object behind all other intersected objects - * @returns {void} - */ + * @returns {void} + */ sendToBack(): void; /** Update the horizontal space between the selected objects as equal and within the selection boundary - * @returns {void} - */ + * @returns {void} + */ spaceAcross(): void; /** Update the vertical space between the selected objects as equal and within the selection boundary - * @returns {void} - */ + * @returns {void} + */ spaceDown(): void; /** Move the specified label to edit mode - * @param {any} node/connector that contains the label to be edited - * @param {any} to be edited - * @returns {void} - */ + * @param {any} node/connector that contains the label to be edited + * @param {any} to be edited + * @returns {void} + */ startLabelEdit(node: any, label: any): void; /** Reverse the last action that was performed - * @returns {void} - */ + * @returns {void} + */ undo(): void; /** Ungroup the selected group - * @returns {void} - */ + * @returns {void} + */ ungroup(): void; /** Update diagram at runtime - * @param {any} JSON to specify the diagram properties that have to be modified - * @returns {void} - */ + * @param {any} JSON to specify the diagram properties that have to be modified + * @returns {void} + */ update(options: any): void; /** Update Connectors at runtime - * @param {string} name of the connector to be updated - * @param {any} JSON to specify the connector properties that have to be updated - * @returns {void} - */ + * @param {string} name of the connector to be updated + * @param {any} JSON to specify the connector properties that have to be updated + * @returns {void} + */ updateConnector(name: string, options: any): void; /** Update the given label at runtime - * @param {string} the name of node/connector which contains the label to be updated - * @param {any} the label to be modified - * @param {any} JSON to specify the label properties that have to be updated - * @returns {any} - */ + * @param {string} the name of node/connector which contains the label to be updated + * @param {any} the label to be modified + * @param {any} JSON to specify the label properties that have to be updated + * @returns {any} + */ updateLabel(nodeName: string, label: any, options: any): any; /** Update nodes at runtime - * @param {string} name of the node that is to be updated - * @param {any} JSON to specify the properties of node that have to be updated - * @returns {void} - */ + * @param {string} name of the node that is to be updated + * @param {any} JSON to specify the properties of node that have to be updated + * @returns {void} + */ updateNode(name: string, options: any): void; /** Update a port with its modified properties at runtime - * @param {string} the name of node which contains the port to be updated - * @param {any} the port to be updated - * @param {any} JSON to specify the properties of the port that have to be updated - * @returns {void} - */ + * @param {string} the name of node which contains the port to be updated + * @param {any} the port to be updated + * @param {any} JSON to specify the properties of the port that have to be updated + * @returns {void} + */ updatePort(nodeName: string, port: any, options: any): void; /** Update the specified node as selected object - * @param {string} name of the node to be updated as selected object - * @returns {void} - */ + * @param {string} name of the node to be updated as selected object + * @returns {void} + */ updateSelectedObject(name: string): void; /** Update the selection at runtime - * @param {boolean} to specify whether to show the user handles or not - * @returns {void} - */ + * @param {boolean} to specify whether to show the user handles or not + * @returns {void} + */ updateSelection(showUserHandles?: boolean): void; /** Update user handles with respect to the given node - * @param {any} node/connector with respect to which, the user handles have to be updated - * @returns {void} - */ + * @param {any} node/connector with respect to which, the user handles have to be updated + * @returns {void} + */ updateUserHandles(node: any): void; /** Update the diagram viewport at runtime - * @returns {void} - */ + * @returns {void} + */ updateViewPort(): void; /** Upgrade the diagram from old version - * @param {any} to be upgraded - * @returns {void} - */ + * @param {any} to be upgraded + * @returns {void} + */ upgrade(data: any): void; /** Used to zoomIn/zoomOut diagram - * @param {Diagram.Zoom} options to zoom the diagram(zoom factor, zoomIn/zoomOut) - * @returns {void} - */ + * @param {Diagram.Zoom} options to zoom the diagram(zoom factor, zoomIn/zoomOut) + * @returns {void} + */ zoomTo(Zoom?: Diagram.Zoom): void; } export namespace Diagram { @@ -58457,184 +58458,184 @@ export namespace Diagram { export interface Options { /** name of the file to be downloaded. - */ + */ fileName?: string; /** format of the exported file/data. See [File Formats](/api/js/global#fileformats). - */ + */ format?: string; /** to set whether to export diagram as a file or as raw data. See [Export Modes](/api/js/global#exportmodes). - */ + */ mode?: string; /** to set the region of the diagram to be exported. See [Region](/api/js/global#region). - */ + */ region?: string; /** to export any custom region of diagram. - */ + */ bounds?: any; /** to set margin to the exported data. - */ + */ margin?: any; /** to set stretch to the exported data. - */ + */ stretch?: string; } export interface Zoom { /** Used to increase the zoom-in or zoom-out based on the zoom factor value. - */ + */ zoomFactor?: number; /** Used to zoom-in or zoom-out the diagram. - */ + */ zoomCommand?: ej.datavisualization.Diagram.ZoomCommand; /** Used to zoom-in or zoom-out the diagram based on the point. - */ + */ focusPoint?: ej.datavisualization.Diagram.ConnectorsSourcePoint; } export interface Model { /** Defines the background color of diagram elements - * @Default {transparent} - */ + * @Default {transparent} + */ backgroundColor?: string; /** Defines the path of the background image of diagram elements - */ + */ backgroundImage?: string; /** Sets the direction of line bridges. - * @Default {ej.datavisualization.Diagram.BridgeDirection.Top} - */ + * @Default {ej.datavisualization.Diagram.BridgeDirection.Top} + */ bridgeDirection?: ej.datavisualization.Diagram.BridgeDirection|string; /** Defines a set of custom commands and binds them with a set of desired key gestures. - */ + */ commandManager?: CommandManager; /** A collection of JSON objects where each object represents a connector - * @Default {[]} - */ + * @Default {[]} + */ connectors?: Connector[]; /** Binds the custom JSON data with connector properties - * @Default {null} - */ + * @Default {null} + */ connectorTemplate?: any; /** Enables/Disables the default behaviors of the diagram. - * @Default {ej.datavisualization.Diagram.DiagramConstraints.All} - */ + * @Default {ej.datavisualization.Diagram.DiagramConstraints.All} + */ constraints?: ej.datavisualization.Diagram.DiagramConstraints|string; /** An object to customize the context menu of diagram - */ + */ contextMenu?: ContextMenu; /** Configures the data source that is to be bound with diagram - */ + */ dataSourceSettings?: DataSourceSettings; /** Initializes the default values for nodes and connectors - * @Default {{}} - */ + * @Default {{}} + */ defaultSettings?: DefaultSettings; /** Sets the type of JSON object to be drawn through drawing tool - * @Default {{}} - */ + * @Default {{}} + */ drawType?: any; /** Enables or disables auto scroll in diagram - * @Default {true} - */ + * @Default {true} + */ enableAutoScroll?: boolean; /** Enables or disables diagram context menu - * @Default {true} - */ + * @Default {true} + */ enableContextMenu?: boolean; /** Specifies the height of the diagram - * @Default {null} - */ + * @Default {null} + */ height?: string; /** Customizes the undo redo functionality - */ + */ historyManager?: HistoryManager; /** Defines the type of the rendering mode of label. - * @Default {Html} - */ + * @Default {Html} + */ labelRenderingMode?: ej.datavisualization.Diagram.LabelRenderingMode|string; /** Automatically arranges the nodes and connectors in a predefined manner. - */ + */ layout?: Layout; /** Defines the current culture of diagram - * @Default {en-US} - */ + * @Default {en-US} + */ locale?: string; /** Array of JSON objects where each object represents a node - * @Default {[]} - */ + * @Default {[]} + */ nodes?: Node[]; /** Binds the custom JSON data with node properties - * @Default {null} - */ + * @Default {null} + */ nodeTemplate?: any; /** Defines the size and appearance of diagram page - */ + */ pageSettings?: PageSettings; /** Defines the zoom value, zoom factor, scroll status and view port size of the diagram - */ + */ scrollSettings?: ScrollSettings; /** Defines the size and position of selected items and defines the appearance of selector - */ + */ selectedItems?: SelectedItems; /** Enables or disables tooltip of diagram - * @Default {true} - */ + * @Default {true} + */ showTooltip?: boolean; /** Defines the gridlines and defines how and when the objects have to be snapped - */ + */ snapSettings?: SnapSettings; /** Enables/Disables the interactive behaviors of diagram. - * @Default {ej.datavisualization.Diagram.Tool.All} - */ + * @Default {ej.datavisualization.Diagram.Tool.All} + */ tool?: ej.datavisualization.Diagram.Tool|string; /** An object that defines the description, appearance and alignments of tooltips - * @Default {null} - */ + * @Default {null} + */ tooltip?: Tooltip; /** Specifies the width of the diagram - * @Default {null} - */ + * @Default {null} + */ width?: string; /** Sets the factor by which we can zoom in or zoom out - * @Default {0.2} - */ + * @Default {0.2} + */ zoomFactor?: number; /** Triggers When auto scroll is changed */ @@ -58731,2853 +58732,2853 @@ export interface Model { export interface AutoScrollChangeEventArgs { /** Returns the delay between subsequent auto scrolls - */ + */ delay?: string; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface ClickEventArgs { /** parameter returns the clicked node, connector or diagram - */ + */ element?: any; /** parameter returns the object that is actually clicked - */ + */ actualObject?: number; /** parameter returns the horizontal coordinate of the mouse pointer, relative to the diagram - */ + */ offsetX?: number; /** parameter returns the vertical coordinate of the mouse pointer, relative to the diagram - */ + */ offsetY?: number; /** parameter returns the count of how many times the mouse button is pressed - */ + */ count?: number; /** parameter returns the actual click event arguments that explains which button is clicked - */ + */ event?: any; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface ConnectionChangeEventArgs { /** parameter returns the connection that is changed between nodes, ports or points - */ + */ element?: any; /** parameter returns the new source node or target node of the connector - */ + */ connection?: string; /** parameter returns the new source port or target port of the connector - */ + */ port?: any; /** parameter defines whether to cancel the change or not - */ + */ cancel?: boolean; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface ConnectorCollectionChangeEventArgs { /** parameter returns whether the connector is inserted or removed - */ + */ changeType?: string; /** parameter returns the connector that is to be added or deleted - */ + */ element?: any; /** parameter defines whether to cancel the collection change or not - */ + */ cancel?: boolean; /** triggers before and after adding the connector in the diagram which can be differentiated through `state` argument. We can cancel the event only before adding the connector. - */ + */ state?: string; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface ConnectorSourceChangeEventArgs { /** returns the connector, the source point of which is being dragged - */ + */ element?: any; /** returns the source node of the element - */ + */ node?: any; /** returns the source point of the element - */ + */ point?: any; /** returns the source port of the element - */ + */ port?: any; /** returns the state of connection end point dragging(starting, dragging, completed) - */ + */ dragState?: string; /** parameter defines whether to cancel the change or not - */ + */ cancel?: boolean; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface ConnectorTargetChangeEventArgs { /** parameter returns the connector, the target point of which is being dragged - */ + */ element?: any; /** returns the target node of the element - */ + */ node?: any; /** returns the target point of the element - */ + */ point?: any; /** returns the target port of the element - */ + */ port?: any; /** returns the state of connection end point dragging(starting, dragging, completed) - */ + */ dragState?: string; /** parameter defines whether to cancel the change or not - */ + */ cancel?: boolean; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface ContextMenuBeforeOpenEventArgs { /** parameter returns the diagram object - */ + */ diagram?: any; /** parameter returns the actual arguments from context menu - */ + */ contextmenu?: any; /** parameter returns the object that was clicked - */ + */ target?: any; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface ContextMenuClickEventArgs { /** parameter returns the id of the selected context menu item - */ + */ id?: string; /** parameter returns the text of the selected context menu item - */ + */ text?: string; /** parameter returns the parent id of the selected context menu item - */ + */ parentId?: string; /** parameter returns the parent text of the selected context menu item - */ + */ parentText?: string; /** parameter returns the object that was clicked - */ + */ target?: any; /** parameter defines whether to execute the click event or not - */ + */ canExecute?: boolean; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface DoubleClickEventArgs { /** parameter returns the object that is actually clicked - */ + */ actualObject?: any; /** parameter returns the selected object - */ + */ element?: any; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface DragEventArgs { /** parameter returns the node or connector that is being dragged - */ + */ element?: any; /** parameter returns the previous position of the node/connector - */ + */ oldValue?: any; /** parameter returns the new position of the node/connector - */ + */ newValue?: any; /** parameter returns the state of drag event (Starting, dragging, completed) - */ + */ dragState?: string; /** parameter returns whether or not to cancel the drag event - */ + */ cancel?: boolean; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface DragEnterEventArgs { /** parameter returns the node or connector that is dragged into diagram - */ + */ element?: any; /** parameter returns whether to add or remove the symbol from diagram - */ + */ cancel?: boolean; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface DragLeaveEventArgs { /** parameter returns the node or connector that is dragged outside of the diagram - */ + */ element?: any; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface DragOverEventArgs { /** parameter returns the node or connector that is dragged over diagram - */ + */ element?: any; /** parameter defines whether the symbol can be dropped at the current mouse position - */ + */ allowDrop?: boolean; /** parameter returns the node/connector over which the symbol is dragged - */ + */ target?: any; /** parameter returns the previous position of the node/connector - */ + */ oldValue?: any; /** parameter returns the new position of the node/connector - */ + */ newValue?: any; /** parameter returns whether or not to cancel the dragOver event - */ + */ cancel?: boolean; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface DropEventArgs { /** parameter returns node or connector that is being dropped - */ + */ element?: any; /** parameter returns whether or not to cancel the drop event - */ + */ cancel?: boolean; /** parameter returns the object from where the element is dragged - */ + */ source?: any; /** parameter returns the object over which the object will be dropped - */ + */ target?: any; /** parameter returns the enum which defines the type of the source - */ + */ sourceType?: string; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface EditorFocusChangeEventArgs { /** Returns the cancel option value. - */ + */ cancel?: boolean; } export interface GroupChangeEventArgs { /** parameter returns the object that is added to/removed from a group - */ + */ element?: any; /** parameter returns the old parent group(if any) of the object - */ + */ oldParent?: any; /** parameter returns the new parent group(if any) of the object - */ + */ newParent?: any; /** parameter returns the cause of group change("group", unGroup") - */ + */ cause?: string; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface HistoryChangeEventArgs { /** An array of objects, where each object represents the changes made in last undo/redo. To explore how the changes are defined, refer [Undo Redo Changes](#undo-redo-changes) - */ + */ changes?: any[]; /** A collection of objects that are changed in the last undo/redo - */ + */ Source?: any[]; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface ItemClickEventArgs { /** parameter returns the object that was actually clicked - */ + */ actualObject?: any; /** parameter returns the object that is selected - */ + */ selectedObject?: any; /** parameter returns whether or not to cancel the drop event - */ + */ cancel?: boolean; /** parameter returns the actual click event arguments that explains which button is clicked - */ + */ event?: any; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface MouseEnterEventArgs { /** parameter returns the target node or connector - */ + */ element?: any; /** parameter returns the object from where the selected object is dragged - */ + */ source?: any; /** parameter returns the target object over which the selected object is dragged - */ + */ target?: any; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface MouseLeaveEventArgs { /** parameter returns the target node or connector - */ + */ element?: any; /** parameter returns the object from where the selected object is dragged - */ + */ source?: any; /** parameter returns the target object over which the selected object is dragged - */ + */ target?: any; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface MouseOverEventArgs { /** parameter returns the target node or connector - */ + */ element?: any; /** parameter returns the object from where the element is dragged - */ + */ source?: any; /** parameter returns the object over which the element is being dragged. - */ + */ target?: any; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface NodeCollectionChangeEventArgs { /** parameter returns whether the node is to be added or removed - */ + */ changeType?: string; /** parameter returns the node which needs to be added or deleted - */ + */ element?: any; /** parameter defines whether to cancel the collection change or not - */ + */ cancel?: boolean; /** triggers before and after adding the node in the diagram which can be differentiated through `state` argument. We can cancel the event only before adding the node - */ + */ state?: string; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface PropertyChangeEventArgs { /** parameter returns the selected element - */ + */ element?: any; /** parameter returns the action is nudge or not - */ + */ cause?: string; /** parameter returns the new value of the node property that is being changed - */ + */ newValue?: any; /** parameter returns the old value of the property that is being changed - */ + */ oldValue?: any; /** parameter returns the name of the property that is changed - */ + */ propertyName?: string; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface RotationChangeEventArgs { /** parameter returns the node that is rotated - */ + */ element?: any; /** parameter returns the previous rotation angle - */ + */ oldValue?: any; /** parameter returns the new rotation angle - */ + */ newValue?: any; /** parameter to specify whether or not to cancel the event - */ + */ cancel?: boolean; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface ScrollChangeEventArgs { /** Parameter returns the new zoom value, horizontal and vertical scroll offsets. - */ + */ newValues?: any; /** parameter returns the previous zoom value, horizontal and vertical scroll offsets. - */ + */ oldValues?: any; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface SegmentChangeEventArgs { /** Parameter returns the connector that is being edited - */ + */ element?: any; /** parameter returns the state of editing (starting, dragging, completed) - */ + */ dragState?: string; /** parameter returns the current mouse position - */ + */ point?: any; /** parameter to specify whether or not to cancel the event - */ + */ cancel?: boolean; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface SelectionChangeEventArgs { /** parameter returns whether the item is selected or removed selection - */ + */ changeType?: string; /** parameter returns the item which is selected or to be selected - */ + */ element?: any; /** parameter returns the collection of nodes and connectors that have to be removed from selection list - */ + */ oldItems?: any[]; /** parameter returns the collection of nodes and connectors that have to be added to selection list - */ + */ newItems?: any[]; /** parameter returns the collection of nodes and connectors that will be selected after selection change - */ + */ selectedItems?: any[]; /** parameter to specify whether or not to cancel the selection change event - */ + */ cancel?: boolean; /** triggers before and after adding the selection to the object in the diagram which can be differentiated through `state` argument. We can cancel the event only before the selection of the object. - */ + */ state?: string; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface SizeChangeEventArgs { /** parameter returns node that was resized - */ + */ element?: any; /** parameter to cancel the size change - */ + */ cancel?: boolean; /** parameter returns the new width, height, offsetX and offsetY values of the element that is being resized - */ + */ newValue?: any; /** parameter returns the previous width,height,offsetX and offsetY values of the element that is being resized - */ + */ oldValue?: any; /** parameter returns the state of resizing(starting,resizing,completed) - */ + */ resizeState?: string; /** parameter returns the difference between new and old value - */ + */ offset?: any; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface TextChangeEventArgs { /** parameter returns the node that contains the text being edited - */ + */ element?: any; /** parameter returns the new text - */ + */ value?: string; /** parameter returns the keyCode of the key entered - */ + */ keyCode?: string; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface CreateEventArgs { /** Returns the diagram model. - */ + */ model?: any; /** Returns the name of the event - */ + */ type?: string; /** parameter returns the id of the diagram - */ + */ diagramId?: string; } export interface BackgroundImage { /** Defines how to align the background image over the diagram area. - * @Default {ej.datavisualization.Diagram.ImageAlignment.XMidYMid} - */ + * @Default {ej.datavisualization.Diagram.ImageAlignment.XMidYMid} + */ alignment?: ej.datavisualization.Diagram.ImageAlignment |string; } export interface CommandManagerCommandsGesture { /** Sets the key value, on recognition of which the command will be executed. - * @Default {ej.datavisualization.Diagram.Keys.None} - */ + * @Default {ej.datavisualization.Diagram.Keys.None} + */ key?: ej.datavisualization.Diagram.Keys|string; /** Sets a combination of key modifiers, on recognition of which the command will be executed. - * @Default {ej.datavisualization.Diagram.KeyModifiers.None} - */ + * @Default {ej.datavisualization.Diagram.KeyModifiers.None} + */ keyModifiers?: ej.datavisualization.Diagram.KeyModifiers|string; } export interface CommandManagerCommands { /** A method that defines whether the command is executable at the moment or not. - */ + */ canExecute?: any; /** A method that defines what to be executed when the key combination is recognized. - */ + */ execute?: any; /** Defines a combination of keys and key modifiers, on recognition of which the command will be executed - */ + */ gesture?: CommandManagerCommandsGesture; /** Defines any additional parameters that are required at runtime - * @Default {null} - */ + * @Default {null} + */ parameter?: any; } export interface CommandManager { /** An object that maps a set of command names with the corresponding command objects - * @Default {{}} - */ + * @Default {{}} + */ commands?: CommandManagerCommands; } export interface ConnectorsLabelsMargin { /** To set the margin of the label in right direction - * @Default {0} - */ + * @Default {0} + */ right?: number; /** To set the margin of the label in left direction - * @Default {0} - */ + * @Default {0} + */ left?: number; /** To set the margin of the label in top direction - * @Default {0} - */ + * @Default {0} + */ top?: number; /** To set the margin of the label in bottom direction - * @Default {0} - */ + * @Default {0} + */ bottom?: number; } export interface ConnectorsLabel { /** Defines how the label should be aligned with respect to the segment - * @Default {ej.datavisualization.Diagram.Alignment.Center} - */ + * @Default {ej.datavisualization.Diagram.Alignment.Center} + */ alignment?: ej.datavisualization.Diagram.Alignment|string; /** Enables/disables the bold style - * @Default {false} - */ + * @Default {false} + */ bold?: boolean; /** Sets the border color of the label - * @Default {transparent} - */ + * @Default {transparent} + */ borderColor?: string; /** Sets the border width of the label - * @Default {0} - */ + * @Default {0} + */ borderWidth?: number; /** Defines whether the label should be aligned within the connector boundaries - * @Default {true} - */ + * @Default {true} + */ boundaryConstraints?: boolean; /** Sets the fill color of the text area - * @Default {transparent} - */ + * @Default {transparent} + */ fillColor?: string; /** Sets the font color of the text - * @Default {black} - */ + * @Default {black} + */ fontColor?: string; /** Sets the font family of the text - * @Default {Arial} - */ + * @Default {Arial} + */ fontFamily?: string; /** Defines the font size of the text - * @Default {12} - */ + * @Default {12} + */ fontSize?: number; /** Sets the horizontal alignment of the label. - * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Center} - */ + * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Center} + */ horizontalAlignment?: ej.datavisualization.Diagram.HorizontalAlignment|string; /** Sets the hyperlink for the labels in the connectors. - * @Default {none} - */ + * @Default {none} + */ hyperlink?: string; /** Enables/disables the italic style - * @Default {false} - */ + * @Default {false} + */ italic?: boolean; /** Gets whether the label is currently being edited or not. - * @Default {ej.datavisualization.Diagram.LabelEditMode.Edit} - */ + * @Default {ej.datavisualization.Diagram.LabelEditMode.Edit} + */ mode?: ej.datavisualization.Diagram.LabelEditMode|string; /** Sets the unique identifier of the label - */ + */ name?: string; /** Sets the fraction/ratio(relative to connector) that defines the position of the label - * @Default {ej.datavisualization.Diagram.Point(0.5, 0.5)} - */ + * @Default {ej.datavisualization.Diagram.Point(0.5, 0.5)} + */ offset?: any; /** Sets the fraction/ratio(relative to connector) that defines the position of the label - * @Default {ej.datavisualization.Diagram.Point(0.5, 0.5)} - */ + * @Default {ej.datavisualization.Diagram.Point(0.5, 0.5)} + */ margin?: ConnectorsLabelsMargin; /** Defines the transparency of labels - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Defines whether the label is editable or not - * @Default {false} - */ + * @Default {false} + */ readOnly?: boolean; /** Defines whether the label should be positioned whether relative to segments or connector boundaries - * @Default {ej.datavisualization.Diagram.LabelRelativeMode.SegmentPath} - */ + * @Default {ej.datavisualization.Diagram.LabelRelativeMode.SegmentPath} + */ relativeMode?: ej.datavisualization.Diagram.LabelRelativeMode|string; /** Defines the angle to which the label needs to be rotated - * @Default {0} - */ + * @Default {0} + */ rotateAngle?: number; /** Sets the position of the label with respect to the total segment length - * @Default {0.5} - */ + * @Default {0.5} + */ segmentOffset?: string; /** Defines the label text - */ + */ text?: string; /** Defines how to align the text inside the label. - * @Default {ej.datavisualization.Diagram.TextAlign.Center} - */ + * @Default {ej.datavisualization.Diagram.TextAlign.Center} + */ textAlign?: ej.datavisualization.Diagram.TextAlign|string; /** Sets how to decorate the label text. - * @Default {ej.datavisualization.Diagram.TextDecorations.None} - */ + * @Default {ej.datavisualization.Diagram.TextDecorations.None} + */ textDecoration?: ej.datavisualization.Diagram.TextDecorations|string; /** Sets the vertical alignment of the label. - * @Default {ej.datavisualization.Diagram.VerticalAlignment.Center} - */ + * @Default {ej.datavisualization.Diagram.VerticalAlignment.Center} + */ verticalAlignment?: ej.datavisualization.Diagram.VerticalAlignment|string; /** Enables or disables the visibility of the label - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Sets the width of the label(the maximum value of label width and the connector width will be considered as label width) - * @Default {50} - */ + * @Default {50} + */ width?: number; /** Defines how the label text needs to be wrapped. - * @Default {ej.datavisualization.Diagram.TextWrapping.WrapWithOverflow} - */ + * @Default {ej.datavisualization.Diagram.TextWrapping.WrapWithOverflow} + */ wrapping?: ej.datavisualization.Diagram.TextWrapping|string; } export interface ConnectorsSegment { /** Sets the direction of orthogonal segment - */ + */ direction?: string; /** Describes the length of orthogonal segment - * @Default {undefined} - */ + * @Default {undefined} + */ length?: number; /** Describes the end point of bezier/straight segment - * @Default {Diagram.Point()} - */ + * @Default {Diagram.Point()} + */ point?: ej.datavisualization.Diagram.ConnectorsSourcePoint; /** Defines the first control point of the bezier segment - * @Default {null} - */ + * @Default {null} + */ point1?: ej.datavisualization.Diagram.ConnectorsSourcePoint; /** Defines the second control point of bezier segment - * @Default {null} - */ + * @Default {null} + */ point2?: ej.datavisualization.Diagram.ConnectorsSourcePoint; /** Sets the type of the segment. - * @Default {ej.datavisualization.Diagram.Segments.Straight} - */ + * @Default {ej.datavisualization.Diagram.Segments.Straight} + */ type?: ej.datavisualization.Diagram.Segments|string; /** Describes the length and angle between the first control point and the start point of bezier segment - * @Default {null} - */ + * @Default {null} + */ vector1?: any; /** Describes the length and angle between the second control point and end point of bezier segment - * @Default {null} - */ + * @Default {null} + */ vector2?: any; } export interface ConnectorsShapeMultiplicitySource { /** Defines the source label to connector. Applicable, if the connector is of type "UML" - * @Default {true} - */ + * @Default {true} + */ optional?: boolean; /** Defines the source label to connector. Applicable, if the connector is of type "UML" - * @Default {null} - */ + * @Default {null} + */ lowerBounds?: number; /** Defines the source label to connector. Applicable, if the connector is of type "UML" - * @Default {null} - */ + * @Default {null} + */ upperBounds?: number; } export interface ConnectorsShapeMultiplicity { /** Sets the type of the multiplicity. Applicable, if the connector is of type "classifier" - * @Default {ej.datavisualization.Diagram.Multiplicity.OneToOne} - */ + * @Default {ej.datavisualization.Diagram.Multiplicity.OneToOne} + */ type?: ej.datavisualization.Diagram.Multiplicity|string; /** Defines the source label to connector. Applicable, if the connector is of type "UML" - */ + */ source?: ConnectorsShapeMultiplicitySource; /** Defines the target label to connector. Applicable, if the connector is of type "UML" - * @Default {true} - */ + * @Default {true} + */ target?: ej.datavisualization.Diagram.ConnectorsShapeMultiplicitySource; } export interface ConnectorsShape { /** Sets the type of the connector - * @Default {ej.datavisualization.Diagram.ConnectorShapes.BPMN} - */ + * @Default {ej.datavisualization.Diagram.ConnectorShapes.BPMN} + */ type?: ej.datavisualization.Diagram.ConnectorShapes|string; /** Sets the type of the flow in a BPMN Process - * @Default {ej.datavisualization.Diagram.BPMNFlows.Sequence} - */ + * @Default {ej.datavisualization.Diagram.BPMNFlows.Sequence} + */ flow?: ej.datavisualization.Diagram.BPMNFlows|string; /** Sets the type of the Association in a BPMN Process - * @Default {ej.datavisualization.Diagram.AssociationFlows.Default} - */ + * @Default {ej.datavisualization.Diagram.AssociationFlows.Default} + */ association?: ej.datavisualization.Diagram.AssociationFlows|string; /** Sets the type of the message flow. Applicable, if the connector is of type "BPMN" - * @Default {ej.datavisualization.Diagram.BPMNMessageFlows.Default} - */ + * @Default {ej.datavisualization.Diagram.BPMNMessageFlows.Default} + */ message?: ej.datavisualization.Diagram.BPMNMessageFlows|string; /** Sets the type of BPMN sequence flow - * @Default {ej.datavisualization.Diagram.BPMNSequenceFlows.Normal} - */ + * @Default {ej.datavisualization.Diagram.BPMNSequenceFlows.Normal} + */ sequence?: ej.datavisualization.Diagram.BPMNSequenceFlows|string; /** Defines the role of the connector in a UML Class Diagram. Applicable, if the type of the connector is "classifier". - * @Default {ej.datavisualization.Diagram.ClassifierShapes.Association} - */ + * @Default {ej.datavisualization.Diagram.ClassifierShapes.Association} + */ relationship?: ej.datavisualization.Diagram.ClassifierShapes|string; /** Defines the multiplicity option of the connector - * @Default {null} - */ + * @Default {null} + */ multiplicity?: ConnectorsShapeMultiplicity; /** Defines the shape of UMLActivity to connector. Applicable, if the connector is of type UMLActivity - * @Default {ej.datavisualization.Diagram.UMLActivityFlow.Control} - */ + * @Default {ej.datavisualization.Diagram.UMLActivityFlow.Control} + */ ActivityFlow?: ej.datavisualization.Diagram.UMLActivityFlow|string; } export interface ConnectorsSourceDecorator { /** Sets the border color of the source decorator - * @Default {black} - */ + * @Default {black} + */ borderColor?: string; /** Sets the border width of the decorator - * @Default {1} - */ + * @Default {1} + */ borderWidth?: number; /** Sets the fill color of the source decorator - * @Default {black} - */ + * @Default {black} + */ fillColor?: string; /** Sets the height of the source decorator - * @Default {8} - */ + * @Default {8} + */ height?: number; /** Defines the custom shape of the source decorator - */ + */ pathData?: string; /** Defines the shape of the source decorator. - * @Default {ej.datavisualization.Diagram.DecoratorShapes.Arrow} - */ + * @Default {ej.datavisualization.Diagram.DecoratorShapes.Arrow} + */ shape?: ej.datavisualization.Diagram.DecoratorShapes|string; /** Defines the width of the source decorator - * @Default {8} - */ + * @Default {8} + */ width?: number; } export interface ConnectorsSourcePoint { /** Defines the x-coordinate of a position - * @Default {0} - */ + * @Default {0} + */ x?: number; /** Defines the y-coordinate of a position - * @Default {0} - */ + * @Default {0} + */ y?: number; } export interface ConnectorsTargetDecorator { /** Sets the border color of the decorator - * @Default {black} - */ + * @Default {black} + */ borderColor?: string; /** Sets the color with which the decorator will be filled - * @Default {black} - */ + * @Default {black} + */ fillColor?: string; /** Defines the height of the target decorator - * @Default {8} - */ + * @Default {8} + */ height?: number; /** Defines the custom shape of the target decorator - */ + */ pathData?: string; /** Defines the shape of the target decorator. - * @Default {ej.datavisualization.Diagram.DecoratorShapes.Arrow} - */ + * @Default {ej.datavisualization.Diagram.DecoratorShapes.Arrow} + */ shape?: ej.datavisualization.Diagram.DecoratorShapes|string; /** Defines the width of the target decorator - * @Default {8} - */ + * @Default {8} + */ width?: number; } export interface Connector { /** To maintain additional information about connectors - * @Default {null} - */ + * @Default {null} + */ addInfo?: any; /** Defines the width of the line bridges - * @Default {10} - */ + * @Default {10} + */ bridgeSpace?: number; /** Enables or disables the behaviors of connectors. - * @Default {ej.datavisualization.Diagram.ConnectorConstraints.Default} - */ + * @Default {ej.datavisualization.Diagram.ConnectorConstraints.Default} + */ constraints?: ej.datavisualization.Diagram.ConnectorConstraints|string; /** Defines the radius of the rounded corner - * @Default {0} - */ + * @Default {0} + */ cornerRadius?: number; /** Configures the styles of shapes - */ + */ cssClass?: string; /** Sets the horizontal alignment of the connector. Applicable, if the parent of the connector is a container. - * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Left} - */ + * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Left} + */ horizontalAlign?: ej.datavisualization.Diagram.HorizontalAlignment|string; /** A collection of JSON objects where each object represents a label. - * @Default {[]} - */ + * @Default {[]} + */ labels?: ConnectorsLabel[]; /** Sets the stroke color of the connector - * @Default {black} - */ + * @Default {black} + */ lineColor?: string; /** Sets the pattern of dashes and gaps used to stroke the path of the connector - */ + */ lineDashArray?: string; /** Defines the padding value to ease the interaction with connectors - * @Default {10} - */ + * @Default {10} + */ lineHitPadding?: number; /** Sets the width of the line - * @Default {1} - */ + * @Default {1} + */ lineWidth?: number; /** Defines the minimum space to be left between the bottom of parent bounds and the connector. Applicable, if the parent is a container. - * @Default {0} - */ + * @Default {0} + */ marginBottom?: number; /** Defines the minimum space to be left between the left of parent bounds and the connector. Applicable, if the parent is a container. - * @Default {0} - */ + * @Default {0} + */ marginLeft?: number; /** Defines the minimum space to be left between the right of parent bounds and the connector. Applicable, if the parent is a container. - * @Default {0} - */ + * @Default {0} + */ marginRight?: number; /** Defines the minimum space to be left between the top of parent bounds and the connector. Applicable, if the parent is a container. - * @Default {0} - */ + * @Default {0} + */ marginTop?: number; /** Sets a unique name for the connector - */ + */ name?: string; /** Defines the transparency of the connector - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Defines the size and preview size of the node to add that to symbol palette. To explore palette item, refer Palette Item - * @Default {null} - */ + * @Default {null} + */ paletteItem?: any; /** Sets the parent name of the connector. - */ + */ parent?: string; /** An array of JSON objects where each object represents a segment - * @Default {[ { type:straight } ]} - */ + * @Default {[ { type:straight } ]} + */ segments?: ConnectorsSegment[]; /** Defines the role/meaning of the connector - * @Default {null} - */ + * @Default {null} + */ shape?: ConnectorsShape; /** Defines the source decorator of the connector - * @Default {{ shape:arrow, width: 8, height:8, borderColor:black, fillColor:black }} - */ + * @Default {{ shape:arrow, width: 8, height:8, borderColor:black, fillColor:black }} + */ sourceDecorator?: ConnectorsSourceDecorator; /** Sets the source node of the connector - */ + */ sourceNode?: string; /** Defines the space to be left between the source node and the source point of a connector - * @Default {0} - */ + * @Default {0} + */ sourcePadding?: number; /** Describes the start point of the connector - * @Default {ej.datavisualization.Diagram.Point()} - */ + * @Default {ej.datavisualization.Diagram.Point()} + */ sourcePoint?: ConnectorsSourcePoint; /** Sets the source port of the connector - */ + */ sourcePort?: string; /** Defines the target decorator of the connector - * @Default {{ shape:arrow, width: 8, height:8, borderColor:black, fillColor:black }} - */ + * @Default {{ shape:arrow, width: 8, height:8, borderColor:black, fillColor:black }} + */ targetDecorator?: ConnectorsTargetDecorator; /** Sets the target node of the connector - */ + */ targetNode?: string; /** Defines the space to be left between the target node and the target point of the connector - * @Default {0} - */ + * @Default {0} + */ targetPadding?: number; /** Describes the end point of the connector - * @Default {ej.datavisualization.Diagram.Point()} - */ + * @Default {ej.datavisualization.Diagram.Point()} + */ targetPoint?: ej.datavisualization.Diagram.ConnectorsSourcePoint; /** Sets the targetPort of the connector - */ + */ targetPort?: string; /** Defines the tooltip that should be shown when the mouse hovers over connector. For tooltip properties, refer Tooltip - * @Default {null} - */ + * @Default {null} + */ tooltip?: any; /** To set the vertical alignment of connector (Applicable,if the parent is group). - * @Default {ej.datavisualization.Diagram.VerticalAlignment.Top} - */ + * @Default {ej.datavisualization.Diagram.VerticalAlignment.Top} + */ verticalAlign?: ej.datavisualization.Diagram.VerticalAlignment|string; /** Enables or disables the visibility of connector - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Sets the z-index of the connector - * @Default {0} - */ + * @Default {0} + */ zOrder?: number; } export interface ContextMenuItem { /** Defines the text for the collection of context menu item - * @Default {null} - */ + * @Default {null} + */ text?: string; /** Defines the name for the collection of context menu items - * @Default {null} - */ + * @Default {null} + */ name?: string; /** Defines the image url for the collection of context menu items - * @Default {null} - */ + * @Default {null} + */ imageUrl?: string; /** Defines the CssClass for the collection of context menu items - * @Default {null} - */ + * @Default {null} + */ cssClass?: string; /** Defines the collection of sub items for the context menu items - * @Default {[]} - */ + * @Default {[]} + */ subItems?: any[]; } export interface ContextMenu { /** Defines the collection of context menu items - * @Default {[]} - */ + * @Default {[]} + */ items?: ContextMenuItem[]; /** To set whether to display the default context menu items or not - * @Default {false} - */ + * @Default {false} + */ showCustomMenuItemsOnly?: boolean; } export interface DataSourceSettings { /** Defines the data source either as a collection of objects or as an instance of ej.DataManager - * @Default {null} - */ + * @Default {null} + */ dataSource?: any; /** Sets the unique id of the data source items - */ + */ id?: string; /** Defines the parent id of the data source item - * @Default {''} - */ + * @Default {''} + */ parent?: string; /** Describes query to retrieve a set of data from the specified datasource - * @Default {null} - */ + * @Default {null} + */ query?: string; /** Sets the unique id of the root data source item - */ + */ root?: string; /** Describes the name of the table on which the specified query has to be executed - * @Default {null} - */ + * @Default {null} + */ tableName?: string; } export interface DefaultSettings { /** Initializes the default connector properties - * @Default {null} - */ + * @Default {null} + */ connector?: any; /** Initializes the default properties of groups - * @Default {null} - */ + * @Default {null} + */ group?: any; /** Initializes the default properties for nodes - * @Default {null} - */ + * @Default {null} + */ node?: any; } export interface HistoryManager { /** A method that takes a history entry as argument and returns whether the specific entry can be popped or not - */ + */ canPop?: any; /** A method that ends grouping the changes - */ + */ closeGroupAction?: any; /** A method that removes the history of a recent change made in diagram - */ + */ pop?: any; /** A method that allows to track the custom changes made in diagram - */ + */ push?: any; /** Defines what should be happened while trying to restore a custom change - * @Default {null} - */ + * @Default {null} + */ redo?: any; /** The redoStack property is used to get the number of redo actions to be stored on the history manager. Its an read-only property and the collection should not be modified. - * @Default {[]} - */ + * @Default {[]} + */ redoStack?: any[]; /** The stackLimit property used to restrict the undo and redo actions to a certain limit. - * @Default {null} - */ + * @Default {null} + */ stackLimit?: number; /** A method that starts to group the changes to revert/restore them in a single undo or redo - */ + */ startGroupAction?: any; /** Defines what should be happened while trying to revert a custom change - */ + */ undo?: any; /** The undoStack property is used to get the number of undo actions to be stored on the history manager. Its an read-only property and the collection should not be modified. - * @Default {[]} - */ + * @Default {[]} + */ undoStack?: any[]; } export interface Layout { /** Specifies the custom bounds to arrange/align the layout - * @Default {ej.datavisualization.Diagram.Rectangle()} - */ + * @Default {ej.datavisualization.Diagram.Rectangle()} + */ bounds?: any; /** Defines the fixed node with reference to which, the layout will be arranged and fixed node will not be repositioned - */ + */ fixedNode?: string; /** Customizes the orientation of trees/sub trees. For orientations, see Chart Orientations. For chart types, see Chart Types - * @Default {null} - */ + * @Default {null} + */ getLayoutInfo?: any; /** Sets the space to be horizontally left between nodes - * @Default {30} - */ + * @Default {30} + */ horizontalSpacing?: number; /** Defines the space to be left between layout bounds and layout. - * @Default {ej.datavisualization.Diagram.Margin()} - */ + * @Default {ej.datavisualization.Diagram.Margin()} + */ margin?: any; /** Defines how to horizontally align the layout within the layout bounds - * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Center} - */ + * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Center} + */ horizontalAlignment?: ej.datavisualization.Diagram.HorizontalAlignment|string; /** Defines how to vertically align the layout within the layout bounds - * @Default {ej.datavisualization.Diagram.VerticalAlignment.Center} - */ + * @Default {ej.datavisualization.Diagram.VerticalAlignment.Center} + */ verticalAlignment?: ej.datavisualization.Diagram.VerticalAlignment|string; /** Sets the orientation/direction to arrange the diagram elements. - * @Default {ej.datavisualization.Diagram.LayoutOrientations.TopToBottom} - */ + * @Default {ej.datavisualization.Diagram.LayoutOrientations.TopToBottom} + */ orientation?: ej.datavisualization.Diagram.LayoutOrientations|string; /** Sets the type of the layout based on which the elements will be arranged. - * @Default {ej.datavisualization.Diagram.LayoutTypes.None} - */ + * @Default {ej.datavisualization.Diagram.LayoutTypes.None} + */ type?: ej.datavisualization.Diagram.LayoutTypes|string; /** Sets the space to be vertically left between nodes - * @Default {30} - */ + * @Default {30} + */ verticalSpacing?: number; } export interface NodesAnnotation { /** Sets the angle between the BPMN shape and the annotation - * @Default {0} - */ + * @Default {0} + */ angle?: number; /** Sets the direction of the text annotation - * @Default {ej.datavisualization.Diagram.BPMNAnnotationDirections.Left} - */ + * @Default {ej.datavisualization.Diagram.BPMNAnnotationDirections.Left} + */ direction?: ej.datavisualization.Diagram.BPMNAnnotationDirection|string; /** Sets the height of the text annotation - * @Default {20} - */ + * @Default {20} + */ height?: number; /** Sets the distance between the BPMN shape and the annotation - * @Default {0} - */ + * @Default {0} + */ length?: number; /** Defines the additional information about the flow object in a BPMN Process - */ + */ text?: string; /** Sets the width of the text annotation - * @Default {20} - */ + * @Default {20} + */ width?: number; } export interface NodesClassAttribute { /** Sets the name of the attribute - */ + */ name?: string; /** Sets the data type of attribute - */ + */ type?: string; /** Defines the visibility of the attribute - * @Default {ej.datavisualization.Diagram.ScopeValueDefaults.Public} - */ + * @Default {ej.datavisualization.Diagram.ScopeValueDefaults.Public} + */ scope?: string; } export interface NodesClassMethod { /** Sets the visibility of the method. - * @Default {ej.datavisualization.Diagram.ScopeValueDefaults.Public} - */ + * @Default {ej.datavisualization.Diagram.ScopeValueDefaults.Public} + */ scope?: string; } export interface NodesClass { /** Sets the name of class. - */ + */ name?: string; /** Defines the collection of attributes - * @Default {[]} - */ + * @Default {[]} + */ attributes?: NodesClassAttribute[]; /** Defines the collection of methods of a Class. - * @Default {[]} - */ + * @Default {[]} + */ methods?: NodesClassMethod[]; } export interface NodesCollapseIcon { /** Sets the border color for collapse icon of node - * @Default {black} - */ + * @Default {black} + */ borderColor?: string; /** Sets the border width for collapse icon of node - * @Default {1} - */ + * @Default {1} + */ borderWidth?: number; /** Sets the fill color for collapse icon of node - * @Default {white} - */ + * @Default {white} + */ fillColor?: string; /** Defines the height for collapse icon of node - * @Default {15} - */ + * @Default {15} + */ height?: number; /** Sets the horizontal alignment of the icon. - * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Center} - */ + * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Center} + */ horizontalAlignment?: ej.datavisualization.Diagram.HorizontalAlignment|string; /** To set the margin for the collapse icon of node - * @Default {ej.datavisualization.Diagram.Margin()} - */ + * @Default {ej.datavisualization.Diagram.Margin()} + */ margin?: any; /** Sets the fraction/ratio(relative to node) that defines the position of the icon - * @Default {ej.datavisualization.Diagram.Point(0.5, 1)} - */ + * @Default {ej.datavisualization.Diagram.Point(0.5, 1)} + */ offset?: any; /** Defines the shape of the collapsed state of the node. - * @Default {ej.datavisualization.Diagram.IconShapes.None} - */ + * @Default {ej.datavisualization.Diagram.IconShapes.None} + */ shape?: ej.datavisualization.Diagram.IconShapes|string; /** Sets the vertical alignment of the icon. - * @Default {ej.datavisualization.Diagram.VerticalAlignment.Center} - */ + * @Default {ej.datavisualization.Diagram.VerticalAlignment.Center} + */ verticalAlignment?: ej.datavisualization.Diagram.VerticalAlignment|string; } export interface NodesContainer { /** Defines the orientation of the container. Applicable, if the group is a container. - * @Default {vertical} - */ + * @Default {vertical} + */ orientation?: string; /** Sets the type of the container. Applicable if the group is a container. - * @Default {ej.datavisualization.Diagram.ContainerType.Canvas} - */ + * @Default {ej.datavisualization.Diagram.ContainerType.Canvas} + */ type?: ej.datavisualization.Diagram.ContainerType|string; } export interface NodesData { /** Sets the type of the BPMN Data object - * @Default {ej.datavisualization.Diagram.BPMNDataObjects.None} - */ + * @Default {ej.datavisualization.Diagram.BPMNDataObjects.None} + */ type?: ej.datavisualization.Diagram.BPMNDataObjects|string; /** Defines whether the BPMN data object is a collection or not - * @Default {false} - */ + * @Default {false} + */ collection?: boolean; } export interface NodesEnumerationMember { /** Sets the name of the enumeration member - */ + */ name?: string; } export interface NodesEnumeration { /** Sets the name of the Enumeration - */ + */ name?: string; /** Defines the collection of enumeration members - * @Default {[]} - */ + * @Default {[]} + */ members?: NodesEnumerationMember[]; } export interface NodesExpandIcon { /** Sets the border color for expand icon of node - * @Default {black} - */ + * @Default {black} + */ borderColor?: string; /** Sets the border width for expand icon of node - * @Default {1} - */ + * @Default {1} + */ borderWidth?: number; /** Sets the fill color for expand icon of node - * @Default {white} - */ + * @Default {white} + */ fillColor?: string; /** Defines the height for expand icon of node - * @Default {15} - */ + * @Default {15} + */ height?: number; /** Sets the horizontal alignment of the icon. - * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Center} - */ + * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Center} + */ horizontalAlignment?: ej.datavisualization.Diagram.HorizontalAlignment|string; /** To set the margin for the expand icon of node - * @Default {ej.datavisualization.Diagram.Margin()} - */ + * @Default {ej.datavisualization.Diagram.Margin()} + */ margin?: any; /** Sets the fraction/ratio(relative to node) that defines the position of the icon - * @Default {ej.datavisualization.Diagram.Point(0.5, 1)} - */ + * @Default {ej.datavisualization.Diagram.Point(0.5, 1)} + */ offset?: any; /** Defines the shape of the expanded state of the node. - * @Default {ej.datavisualization.Diagram.IconShapes.None} - */ + * @Default {ej.datavisualization.Diagram.IconShapes.None} + */ shape?: ej.datavisualization.Diagram.IconShapes|string; /** Sets the vertical alignment of the icon. - * @Default {ej.datavisualization.Diagram.VerticalAlignment.Center} - */ + * @Default {ej.datavisualization.Diagram.VerticalAlignment.Center} + */ verticalAlignment?: ej.datavisualization.Diagram.VerticalAlignment|string; } export interface NodesGradientLinearGradient { /** Defines the different colors and the region of color transitions - * @Default {[]} - */ + * @Default {[]} + */ stops?: any[]; /** Defines the left most position(relative to node) of the rectangular region that needs to be painted - * @Default {0} - */ + * @Default {0} + */ x1?: number; /** Defines the right most position(relative to node) of the rectangular region that needs to be painted - * @Default {0} - */ + * @Default {0} + */ x2?: number; /** Defines the top most position(relative to node) of the rectangular region that needs to be painted - * @Default {0} - */ + * @Default {0} + */ y1?: number; /** Defines the bottom most position(relative to node) of the rectangular region that needs to be painted - * @Default {0} - */ + * @Default {0} + */ y2?: number; } export interface NodesGradientRadialGradient { /** Defines the position of the outermost circle - * @Default {0} - */ + * @Default {0} + */ cx?: number; /** Defines the outer most circle of the radial gradient - * @Default {0} - */ + * @Default {0} + */ cy?: number; /** Defines the innermost circle of the radial gradient - * @Default {0} - */ + * @Default {0} + */ fx?: number; /** Defines the innermost circle of the radial gradient - * @Default {0} - */ + * @Default {0} + */ fy?: number; /** Defines the different colors and the region of color transitions. - * @Default {[]} - */ + * @Default {[]} + */ stops?: any[]; } export interface NodesGradientStop { /** Sets the color to be filled over the specified region - */ + */ color?: string; /** Sets the position where the previous color transition ends and a new color transition starts - * @Default {0} - */ + * @Default {0} + */ offset?: number; /** Describes the transparency level of the region - * @Default {1} - */ + * @Default {1} + */ opacity?: number; } export interface NodesGradient { /** Paints the node with linear color transitions - */ + */ LinearGradient?: NodesGradientLinearGradient; /** Paints the node with radial color transitions. A focal point defines the beginning of the gradient, and a circle defines the end point of the gradient. - */ + */ RadialGradient?: NodesGradientRadialGradient; /** Defines the color and a position where the previous color transition ends and a new color transition starts - */ + */ Stop?: NodesGradientStop; } export interface NodesInterfaceAttribute { /** Sets the name of the attribute - */ + */ name?: string; /** Sets the type of the attribute - */ + */ type?: string; /** Sets the visibility of the attribute - */ + */ scope?: string; } export interface NodesInterfaceMethod { /** Sets the visibility of the method - */ + */ scope?: string; } export interface NodesInterface { /** Sets the name of the interface - */ + */ name?: string; /** Defines a collection of attributes of the interface - * @Default {[]} - */ + * @Default {[]} + */ attributes?: NodesInterfaceAttribute[]; /** Defines the collection of public methods of an interface - * @Default {[]} - */ + * @Default {[]} + */ methods?: NodesInterfaceMethod[]; } export interface NodesLabel { /** Enables/disables the bold style - * @Default {false} - */ + * @Default {false} + */ bold?: boolean; /** Sets the border color of the label - * @Default {transparent} - */ + * @Default {transparent} + */ borderColor?: string; /** Sets the border width of the label - * @Default {0} - */ + * @Default {0} + */ borderWidth?: number; /** Sets the fill color of the text area - * @Default {transparent} - */ + * @Default {transparent} + */ fillColor?: string; /** Sets the font color of the text - * @Default {black} - */ + * @Default {black} + */ fontColor?: string; /** Sets the font family of the text - * @Default {Arial} - */ + * @Default {Arial} + */ fontFamily?: string; /** Defines the font size of the text - * @Default {12} - */ + * @Default {12} + */ fontSize?: number; /** Sets the horizontal alignment of the label. - * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Center} - */ + * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Center} + */ horizontalAlignment?: ej.datavisualization.Diagram.HorizontalAlignment|string; /** Enables/disables the italic style - * @Default {false} - */ + * @Default {false} + */ italic?: boolean; /** To set the margin of the label - * @Default {ej.datavisualization.Diagram.Margin()} - */ + * @Default {ej.datavisualization.Diagram.Margin()} + */ margin?: any; /** Gets whether the label is currently being edited or not. - * @Default {ej.datavisualization.Diagram.LabelEditMode.Edit} - */ + * @Default {ej.datavisualization.Diagram.LabelEditMode.Edit} + */ mode?: ej.datavisualization.Diagram.LabelEditMode|string; /** Sets the unique identifier of the label - */ + */ name?: string; /** Sets the fraction/ratio(relative to node) that defines the position of the label - * @Default {ej.datavisualization.Diagram.Point(0.5, 0.5)} - */ + * @Default {ej.datavisualization.Diagram.Point(0.5, 0.5)} + */ offset?: any; /** Defines the transparency of the labels - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Sets the overflowType of the labels - * @Default {ej.datavisualization.Diagram.OverflowType.Ellipsis} - */ + * @Default {ej.datavisualization.Diagram.OverflowType.Ellipsis} + */ overflowType?: ej.datavisualization.Diagram.OverflowType|string; /** Defines whether the label is editable or not - * @Default {false} - */ + * @Default {false} + */ readOnly?: boolean; /** Defines the angle to which the label needs to be rotated - * @Default {0} - */ + * @Default {0} + */ rotateAngle?: number; /** Defines the label text - */ + */ text?: string; /** Defines how to align the text inside the label. - * @Default {ej.datavisualization.Diagram.TextAlign.Center} - */ + * @Default {ej.datavisualization.Diagram.TextAlign.Center} + */ textAlign?: ej.datavisualization.Diagram.TextAlign|string; /** Sets how to decorate the label text. - * @Default {ej.datavisualization.Diagram.TextDecorations.None} - */ + * @Default {ej.datavisualization.Diagram.TextDecorations.None} + */ textDecoration?: ej.datavisualization.Diagram.TextDecorations|string; /** Defines the overflowed content is displayed or not. - * @Default {false} - */ + * @Default {false} + */ textOverflow?: boolean; /** Sets the vertical alignment of the label. - * @Default {ej.datavisualization.Diagram.VerticalAlignment.Center} - */ + * @Default {ej.datavisualization.Diagram.VerticalAlignment.Center} + */ verticalAlignment?: ej.datavisualization.Diagram.VerticalAlignment|string; /** Enables or disables the visibility of the label - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Sets the width of the label(the maximum value of label width and the node width will be considered as label width) - * @Default {50} - */ + * @Default {50} + */ width?: number; /** Defines how the label text needs to be wrapped. - * @Default {ej.datavisualization.Diagram.TextWrapping.WrapWithOverflow} - */ + * @Default {ej.datavisualization.Diagram.TextWrapping.WrapWithOverflow} + */ wrapping?: ej.datavisualization.Diagram.TextWrapping|string; } export interface NodesLane { /** Defines the width of lane - * @Default {0} - */ + * @Default {0} + */ width?: number; /** Defines the height of lane - * @Default {0} - */ + * @Default {0} + */ height?: number; /** Defines the z-index of the lane - * @Default {0} - */ + * @Default {0} + */ zorder?: number; /** Allows to maintain additional information about lane - * @Default {{}} - */ + * @Default {{}} + */ addInfo?: any; /** An array of objects where each object represents a child node of the lane - * @Default {[]} - */ + * @Default {[]} + */ children?: any[]; /** Defines the fill color of the lane - * @Default {white} - */ + * @Default {white} + */ fillColor?: string; /** Defines the header of the lane - * @Default {{ text: Function, fontSize: 11 }} - */ + * @Default {{ text: Function, fontSize: 11 }} + */ header?: any; /** Defines the object as a lane - * @Default {false} - */ + * @Default {false} + */ isLane?: boolean; /** Sets the unique identifier of the lane - */ + */ name?: string; /** Sets the orientation of the lane. - * @Default {vertical} - */ + * @Default {vertical} + */ orientation?: string; } export interface NodesPaletteItem { /** Defines whether the symbol should be drawn at its actual size regardless of precedence factors or not - * @Default {true} - */ + * @Default {true} + */ enableScale?: boolean; /** Defines the height of the symbol - * @Default {0} - */ + * @Default {0} + */ height?: number; /** Defines the margin of the symbol item - * @Default {{ left: 4, right: 4, top: 4, bottom: 4 }} - */ + * @Default {{ left: 4, right: 4, top: 4, bottom: 4 }} + */ margin?: any; /** Defines the preview height of the symbol - * @Default {undefined} - */ + * @Default {undefined} + */ previewHeight?: number; /** Defines the preview width of the symbol - * @Default {undefined} - */ + * @Default {undefined} + */ previewWidth?: number; /** Defines the width of the symbol - * @Default {0} - */ + * @Default {0} + */ width?: number; } export interface NodesPhase { /** Defines the header of the smaller regions - * @Default {null} - */ + * @Default {null} + */ label?: any; /** Defines the line color of the splitter that splits adjacent phases. - * @Default {#606060} - */ + * @Default {#606060} + */ lineColor?: string; /** Sets the dash array that used to stroke the phase splitter - * @Default {3,3} - */ + * @Default {3,3} + */ lineDashArray?: string; /** Sets the lineWidth of the phase - * @Default {1} - */ + * @Default {1} + */ lineWidth?: number; /** Sets the unique identifier of the phase - */ + */ name?: string; /** Sets the length of the smaller region(phase) of a swimlane - * @Default {100} - */ + * @Default {100} + */ offset?: number; /** Sets the orientation of the phase - * @Default {horizontal} - */ + * @Default {horizontal} + */ orientation?: string; /** Sets the type of the object as phase - * @Default {phase} - */ + * @Default {phase} + */ type?: string; } export interface NodesPort { /** Sets the border color of the port - * @Default {#1a1a1a} - */ + * @Default {#1a1a1a} + */ borderColor?: string; /** Sets the stroke width of the port - * @Default {1} - */ + * @Default {1} + */ borderWidth?: number; /** Defines the space to be left between the port bounds and its incoming and outgoing connections. - * @Default {0} - */ + * @Default {0} + */ connectorPadding?: number; /** Defines whether connections can be created with the port - * @Default {ej.datavisualization.Diagram.PortConstraints.Connect} - */ + * @Default {ej.datavisualization.Diagram.PortConstraints.Connect} + */ constraints?: ej.datavisualization.Diagram.PortConstraints|string; /** Sets the fill color of the port - * @Default {white} - */ + * @Default {white} + */ fillColor?: string; /** Sets the unique identifier of the port - */ + */ name?: string; /** Defines the position of the port as fraction/ ratio relative to node - * @Default {ej.datavisualization.Diagram.Point(0, 0)} - */ + * @Default {ej.datavisualization.Diagram.Point(0, 0)} + */ offset?: any; /** Defines the path data to draw the port. Applicable, if the port shape is path. - */ + */ pathData?: string; /** Defines the shape of the port. - * @Default {ej.datavisualization.Diagram.PortShapes.Square} - */ + * @Default {ej.datavisualization.Diagram.PortShapes.Square} + */ shape?: ej.datavisualization.Diagram.PortShapes|string; /** Defines the size of the port - * @Default {8} - */ + * @Default {8} + */ size?: number; /** Defines when the port should be visible. - * @Default {ej.datavisualization.Diagram.PortVisibility.Default} - */ + * @Default {ej.datavisualization.Diagram.PortVisibility.Default} + */ visibility?: ej.datavisualization.Diagram.PortVisibility|string; } export interface NodesShadow { /** Defines the angle of the shadow relative to node - * @Default {45} - */ + * @Default {45} + */ angle?: number; /** Sets the distance to move the shadow relative to node - * @Default {5} - */ + * @Default {5} + */ distance?: number; /** Defines the opaque of the shadow - * @Default {0.7} - */ + * @Default {0.7} + */ opacity?: number; } export interface NodesSubProcess { /** Defines whether the BPMN sub process is without any prescribed order or not - * @Default {false} - */ + * @Default {false} + */ adhoc?: boolean; /** Sets the boundary of the BPMN process - * @Default {ej.datavisualization.Diagram.BPMNBoundary.Default} - */ + * @Default {ej.datavisualization.Diagram.BPMNBoundary.Default} + */ boundary?: ej.datavisualization.Diagram.BPMNBoundary|string; /** Sets whether the BPMN subprocess is triggered as a compensation of a specific activity - * @Default {false} - */ + * @Default {false} + */ compensation?: boolean; /** Sets whether the BPMN subprocess is triggered as a collapsed of a specific activity - * @Default {true} - */ + * @Default {true} + */ collapsed?: boolean; /** Sets the type of the event by which the sub-process will be triggered - * @Default {ej.datavisualization.Diagram.BPMNEvents.Start} - */ + * @Default {ej.datavisualization.Diagram.BPMNEvents.Start} + */ event?: ej.datavisualization.Diagram.BPMNEvents|string; /** Defines the collection of events that need to be appended with BPMN Sub-Process - */ + */ events?: any[]; /** Defines the loop type of a sub process. - * @Default {ej.datavisualization.Diagram.BPMNLoops.None} - */ + * @Default {ej.datavisualization.Diagram.BPMNLoops.None} + */ loop?: ej.datavisualization.Diagram.BPMNLoops|string; /** Defines the children for BPMN's SubProcess - * @Default {[]} - */ + * @Default {[]} + */ Processes?: any[]; /** Defines the type of the event trigger - * @Default {ej.datavisualization.Diagram.BPMNTriggers.Message} - */ + * @Default {ej.datavisualization.Diagram.BPMNTriggers.Message} + */ trigger?: ej.datavisualization.Diagram.BPMNTriggers|string; /** Defines the type of a sub process - * @Default {ej.datavisualization.Diagram.BPMNSubProcessTypes.None} - */ + * @Default {ej.datavisualization.Diagram.BPMNSubProcessTypes.None} + */ type?: ej.datavisualization.Diagram.BPMNSubProcessTypes|string; } export interface NodesTask { /** To set whether the task is a global task or not - * @Default {false} - */ + * @Default {false} + */ call?: boolean; /** Sets whether the task is triggered as a compensation of another specific activity - * @Default {false} - */ + * @Default {false} + */ compensation?: boolean; /** Sets the loop type of a BPMN task. - * @Default {ej.datavisualization.Diagram.BPMNLoops.None} - */ + * @Default {ej.datavisualization.Diagram.BPMNLoops.None} + */ loop?: ej.datavisualization.Diagram.BPMNLoops|string; /** Sets the type of the BPMN task. - * @Default {ej.datavisualization.Diagram.BPMNTasks.None} - */ + * @Default {ej.datavisualization.Diagram.BPMNTasks.None} + */ type?: ej.datavisualization.Diagram.BPMNTasks|string; } export interface Node { /** Defines the type of BPMN Activity. Applicable, if the node is a BPMN activity. - * @Default {ej.datavisualization.Diagram.BPMNActivity.Task} - */ + * @Default {ej.datavisualization.Diagram.BPMNActivity.Task} + */ activity?: ej.datavisualization.Diagram.BPMNActivity|string; /** To maintain additional information about nodes - * @Default {{}} - */ + * @Default {{}} + */ addInfo?: any; /** Defines the additional information of a process. It is not directly related to the message flows or sequence flows of the process. - * @Default {ej.datavisualization.Diagram.BPMNTextAnnotation()} - */ + * @Default {ej.datavisualization.Diagram.BPMNTextAnnotation()} + */ annotation?: NodesAnnotation; /** Sets the border color of node - * @Default {black} - */ + * @Default {black} + */ borderColor?: string; /** Sets the pattern of dashes and gaps to stroke the border - */ + */ borderDashArray?: string; /** Sets the border width of the node - * @Default {1} - */ + * @Default {1} + */ borderWidth?: number; /** Defines whether the group can be ungrouped or not - * @Default {true} - */ + * @Default {true} + */ canUngroup?: boolean; /** Array of JSON objects where each object represents a child node/connector - * @Default {[]} - */ + * @Default {[]} + */ children?: any[]; /** Sets the type of UML classifier. Applicable, if the node is a UML Class Diagram shape. - * @Default {ej.datavisualization.Diagram.ClassifierShapes.Class} - */ + * @Default {ej.datavisualization.Diagram.ClassifierShapes.Class} + */ classifier?: ej.datavisualization.Diagram.ClassifierShapes|string; /** Defines the name, attributes and methods of a Class. Applicable, if the node is a Class. - * @Default {null} - */ + * @Default {null} + */ class?: NodesClass; /** Defines the state of the node is collapsed. - */ + */ collapseIcon?: NodesCollapseIcon; /** Defines the distance to be left between a node and its connections(In coming and out going connections). - * @Default {0} - */ + * @Default {0} + */ connectorPadding?: number; /** Enables or disables the default behaviors of the node. - * @Default {ej.datavisualization.Diagram.NodeConstraints.Default} - */ + * @Default {ej.datavisualization.Diagram.NodeConstraints.Default} + */ constraints?: ej.datavisualization.Diagram.NodeConstraints|string; /** Defines how the child objects need to be arranged(Either in any predefined manner or automatically). Applicable, if the node is a group. - * @Default {null} - */ + * @Default {null} + */ container?: NodesContainer; /** Defines the corner radius of rectangular shapes. - * @Default {0} - */ + * @Default {0} + */ cornerRadius?: number; /** Configures the styles of shapes - */ + */ cssClass?: string; /** Defines the BPMN data object - */ + */ data?: NodesData; /** Defines an Enumeration in a UML Class Diagram - * @Default {null} - */ + * @Default {null} + */ enumeration?: NodesEnumeration; /** Sets the type of the BPMN Events. Applicable, if the node is a BPMN event. - * @Default {ej.datavisualization.Diagram.BPMNEvents.Start} - */ + * @Default {ej.datavisualization.Diagram.BPMNEvents.Start} + */ event?: ej.datavisualization.Diagram.BPMNEvents|string; /** Defines whether the node can be automatically arranged using layout or not - * @Default {false} - */ + * @Default {false} + */ excludeFromLayout?: boolean; /** Defines the state of the node is expanded or collapsed. - */ + */ expandIcon?: NodesExpandIcon; /** Defines the fill color of the node - * @Default {white} - */ + * @Default {white} + */ fillColor?: string; /** Sets the type of the BPMN Gateway. Applicable, if the node is a BPMN gateway. - * @Default {ej.datavisualization.Diagram.BPMNGateways.None} - */ + * @Default {ej.datavisualization.Diagram.BPMNGateways.None} + */ gateway?: ej.datavisualization.Diagram.BPMNGateways|string; /** Paints the node with a smooth transition from one color to another color - */ + */ gradient?: NodesGradient; /** Sets the type of the BPMN Shapes as group. Applicable, if the node is a BPMN. - * @Default {ej.datavisualization.Diagram.BPMNShapes} - */ + * @Default {ej.datavisualization.Diagram.BPMNShapes} + */ group?: any; /** Defines the header of a swimlane/lane - * @Default {{ text: Title, fontSize: 11 }} - */ + * @Default {{ text: Title, fontSize: 11 }} + */ header?: any; /** Defines the height of the node - * @Default {0} - */ + * @Default {0} + */ height?: number; /** Sets the horizontal alignment of the node. Applicable, if the parent of the node is a container. - * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Left} - */ + * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Left} + */ horizontalAlign?: ej.datavisualization.Diagram.HorizontalAlignment|string; /** A read only collection of the incoming connectors/edges of the node - * @Default {[]} - */ + * @Default {[]} + */ inEdges?: any[]; /** Defines an interface in a UML Class Diagram - * @Default {null} - */ + * @Default {null} + */ interface?: NodesInterface; /** Defines whether the sub tree of the node is expanded or collapsed - * @Default {true} - */ + * @Default {true} + */ isExpanded?: boolean; /** Sets the node as a swimlane - * @Default {false} - */ + * @Default {false} + */ isSwimlane?: boolean; /** A collection of objects where each object represents a label - * @Default {[]} - */ + * @Default {[]} + */ labels?: NodesLabel[]; /** An array of objects where each object represents a lane. Applicable, if the node is a swimlane. - * @Default {[]} - */ + * @Default {[]} + */ lanes?: NodesLane[]; /** Defines the minimum space to be left between the bottom of parent bounds and the node. Applicable, if the parent is a container. - * @Default {0} - */ + * @Default {0} + */ marginBottom?: number; /** Defines the minimum space to be left between the left of parent bounds and the node. Applicable, if the parent is a container. - * @Default {0} - */ + * @Default {0} + */ marginLeft?: number; /** Defines the minimum space to be left between the right of the parent bounds and the node. Applicable, if the parent is a container. - * @Default {0} - */ + * @Default {0} + */ marginRight?: number; /** Defines the minimum space to be left between the top of parent bounds and the node. Applicable, if the parent is a container. - * @Default {0} - */ + * @Default {0} + */ marginTop?: number; /** Defines the maximum height limit of the node - * @Default {0} - */ + * @Default {0} + */ maxHeight?: number; /** Defines the maximum width limit of the node - * @Default {0} - */ + * @Default {0} + */ maxWidth?: number; /** Defines the minimum height limit of the node - * @Default {0} - */ + * @Default {0} + */ minHeight?: number; /** Defines the minimum width limit of the node - * @Default {0} - */ + * @Default {0} + */ minWidth?: number; /** Sets the unique identifier of the node - */ + */ name?: string; /** Defines the position of the node on X-Axis - * @Default {0} - */ + * @Default {0} + */ offsetX?: number; /** Defines the position of the node on Y-Axis - * @Default {0} - */ + * @Default {0} + */ offsetY?: number; /** Defines the opaque of the node - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Defines the orientation of nodes. Applicable, if the node is a swimlane. - * @Default {vertical} - */ + * @Default {vertical} + */ orientation?: string; /** A read only collection of outgoing connectors/edges of the node - * @Default {[]} - */ + * @Default {[]} + */ outEdges?: any[]; /** Defines the minimum padding value to be left between the bottom most position of a group and its children. Applicable, if the group is a container. - * @Default {0} - */ + * @Default {0} + */ paddingBottom?: number; /** Defines the minimum padding value to be left between the left most position of a group and its children. Applicable, if the group is a container. - * @Default {0} - */ + * @Default {0} + */ paddingLeft?: number; /** Defines the minimum padding value to be left between the right most position of a group and its children. Applicable, if the group is a container. - * @Default {0} - */ + * @Default {0} + */ paddingRight?: number; /** Defines the minimum padding value to be left between the top most position of a group and its children. Applicable, if the group is a container. - * @Default {0} - */ + * @Default {0} + */ paddingTop?: number; /** Defines the size and preview size of the node to add that to symbol palette - * @Default {null} - */ + * @Default {null} + */ paletteItem?: NodesPaletteItem; /** Sets the name of the parent group - */ + */ parent?: string; /** Sets the path geometry that defines the shape of a path node - */ + */ pathData?: string; /** An array of objects, where each object represents a smaller region(phase) of a swimlane. - * @Default {[]} - */ + * @Default {[]} + */ phases?: NodesPhase[]; /** Sets the height of the phase headers - * @Default {0} - */ + * @Default {0} + */ phaseSize?: number; /** Sets the ratio/ fractional value relative to node, based on which the node will be transformed(positioning, scaling and rotation) - * @Default {ej.datavisualization.Diagram.Points(0.5,0.5)} - */ + * @Default {ej.datavisualization.Diagram.Points(0.5,0.5)} + */ pivot?: any; /** Defines a collection of points to draw a polygon. Applicable, if the shape is a polygon. - * @Default {[]} - */ + * @Default {[]} + */ points?: any[]; /** An array of objects where each object represents a port - * @Default {[]} - */ + * @Default {[]} + */ ports?: NodesPort[]; /** Sets the angle to which the node should be rotated - * @Default {0} - */ + * @Default {0} + */ rotateAngle?: number; /** Defines the opacity and the position of shadow - * @Default {ej.datavisualization.Diagram.Shadow()} - */ + * @Default {ej.datavisualization.Diagram.Shadow()} + */ shadow?: NodesShadow; /** Sets the shape of the node. It depends upon the type of node. - * @Default {ej.datavisualization.Diagram.BasicShapes.Rectangle} - */ + * @Default {ej.datavisualization.Diagram.BasicShapes.Rectangle} + */ shape?: ej.datavisualization.Diagram.BasicShapes | ej.datavisualization.Diagram.FlowShapes | ej.datavisualization.Diagram.BPMNShapes | ej.datavisualization.Diagram.UMLActivityShapes|string; /** Sets the source path of the image. Applicable, if the type of the node is image. - */ + */ source?: string; /** Defines the sub process of a BPMN Activity. Applicable, if the type of the BPMN activity is sub process. - * @Default {ej.datavisualization.Diagram.BPMNSubProcess()} - */ + * @Default {ej.datavisualization.Diagram.BPMNSubProcess()} + */ subProcess?: NodesSubProcess; /** Defines the task of the BPMN activity. Applicable, if the type of activity is set as task. - * @Default {ej.datavisualization.Diagram.BPMNTask()} - */ + * @Default {ej.datavisualization.Diagram.BPMNTask()} + */ task?: NodesTask; /** Sets the id of svg/html templates. Applicable, if the node is HTML or native. - */ + */ templateId?: string; /** Defines the textBlock of a text node - * @Default {null} - */ + * @Default {null} + */ textBlock?: any; /** Defines the tooltip that should be shown when the mouse hovers over node. For tooltip properties, refer Tooltip - * @Default {null} - */ + * @Default {null} + */ tooltip?: any; /** Sets the type of BPMN Event Triggers. - * @Default {ej.datavisualization.Diagram.BPMNTriggers.None} - */ + * @Default {ej.datavisualization.Diagram.BPMNTriggers.None} + */ trigger?: ej.datavisualization.Diagram.BPMNTriggers|string; /** Defines the type of the node. - * @Default {ej.datavisualization.Diagram.Shapes.Basic} - */ + * @Default {ej.datavisualization.Diagram.Shapes.Basic} + */ type?: ej.datavisualization.Diagram.Shapes|string; /** Sets the vertical alignment of a node. Applicable, if the parent of a node is a container. - * @Default {ej.datavisualization.Diagram.VerticalAlignment.Top} - */ + * @Default {ej.datavisualization.Diagram.VerticalAlignment.Top} + */ verticalAlign?: ej.datavisualization.Diagram.VerticalAlignment|string; /** Defines the visibility of the node - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Defines the width of the node - * @Default {0} - */ + * @Default {0} + */ width?: number; /** Defines the z-index of the node - * @Default {0} - */ + * @Default {0} + */ zOrder?: number; } export interface PageSettings { /** Defines the maximum distance to be left between the object and the scroll bar to trigger auto scrolling - * @Default {{ left: 15, top: 15, right: 15, bottom: 15 }} - */ + * @Default {{ left: 15, top: 15, right: 15, bottom: 15 }} + */ autoScrollBorder?: any; /** Sets whether multiple pages can be created to fit all nodes and connectors - * @Default {false} - */ + * @Default {false} + */ multiplePage?: boolean; /** Defines the background color of diagram pages - * @Default {#ffffff} - */ + * @Default {#ffffff} + */ pageBackgroundColor?: string; /** Defines the page border color - * @Default {#565656} - */ + * @Default {#565656} + */ pageBorderColor?: string; /** Sets the border width of diagram pages - * @Default {0} - */ + * @Default {0} + */ pageBorderWidth?: number; /** Defines the height of a page - * @Default {null} - */ + * @Default {null} + */ pageHeight?: number; /** Defines the page margin - * @Default {24} - */ + * @Default {24} + */ pageMargin?: number; /** Sets the orientation of the page. - * @Default {ej.datavisualization.Diagram.PageOrientations.Portrait} - */ + * @Default {ej.datavisualization.Diagram.PageOrientations.Portrait} + */ pageOrientation?: ej.datavisualization.Diagram.PageOrientations|string; /** Defines the height of a diagram page - * @Default {null} - */ + * @Default {null} + */ pageWidth?: number; /** Defines the scrollable area of diagram. Applicable, if the scroll limit is "limited". - * @Default {null} - */ + * @Default {null} + */ scrollableArea?: any; /** Defines the scrollable region of diagram. - * @Default {ej.datavisualization.Diagram.ScrollLimit.Infinite} - */ + * @Default {ej.datavisualization.Diagram.ScrollLimit.Infinite} + */ scrollLimit?: ej.datavisualization.Diagram.ScrollLimit|string; /** Defines the draggable region of diagram elements. - * @Default {ej.datavisualization.Diagram.BoundaryConstraints.Infinite} - */ + * @Default {ej.datavisualization.Diagram.BoundaryConstraints.Infinite} + */ boundaryConstraints?: ej.datavisualization.Diagram.BoundaryConstraints|string; /** Enables or disables the page breaks - * @Default {false} - */ + * @Default {false} + */ showPageBreak?: boolean; } export interface ScrollSettings { /** Allows to read the zoom value of diagram - * @Default {0} - */ + * @Default {0} + */ currentZoom?: number; /** Sets the horizontal scroll offset - * @Default {0} - */ + * @Default {0} + */ horizontalOffset?: number; /** Allows to extend the scrollable region that is based on the scroll limit - * @Default {{left: 0, right: 0, top:0, bottom: 0}} - */ + * @Default {{left: 0, right: 0, top:0, bottom: 0}} + */ padding?: any; /** Sets the vertical scroll offset - * @Default {0} - */ + * @Default {0} + */ verticalOffset?: number; /** Allows to read the view port height of the diagram - * @Default {0} - */ + * @Default {0} + */ viewPortHeight?: number; /** Allows to read the view port width of the diagram - * @Default {0} - */ + * @Default {0} + */ viewPortWidth?: number; } export interface SelectedItemsUserHandle { /** Defines the background color of the user handle - * @Default {#2382c3} - */ + * @Default {#2382c3} + */ backgroundColor?: string; /** Sets the border color of the user handle - * @Default {transparent} - */ + * @Default {transparent} + */ borderColor?: string; /** Defines whether the user handle should be added, when more than one element is selected - * @Default {false} - */ + * @Default {false} + */ enableMultiSelection?: boolean; /** Sets the stroke color of the user handle - * @Default {transparent} - */ + * @Default {transparent} + */ pathColor?: string; /** Defines the custom shape of the user handle - */ + */ pathData?: string; /** Defines the position of the user handle - * @Default {ej.datavisualization.Diagram.UserHandlePositions.BottomCenter} - */ + * @Default {ej.datavisualization.Diagram.UserHandlePositions.BottomCenter} + */ position?: ej.datavisualization.Diagram.UserHandlePositions |string; /** Defines the size of the user handle - * @Default {8} - */ + * @Default {8} + */ size?: number; /** Defines the interactive behaviors of the user handle - */ + */ tool?: any; /** Defines the visibility of the user handle - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; } export interface SelectedItems { /** A read only collection of the selected items - * @Default {[]} - */ + * @Default {[]} + */ children?: any[]; /** Controls the visibility of selector. - * @Default {ej.datavisualization.Diagram.SelectorConstraints.All} - */ + * @Default {ej.datavisualization.Diagram.SelectorConstraints.All} + */ constraints?: ej.datavisualization.Diagram.SelectorConstraints|string; /** Defines a method that dynamically enables/ disables the interaction with multiple selection. - * @Default {null} - */ + * @Default {null} + */ getConstraints?: any; /** Sets the height of the selected items - * @Default {0} - */ + * @Default {0} + */ height?: number; /** Sets the x position of the selector - * @Default {0} - */ + * @Default {0} + */ offsetX?: number; /** Sets the y position of the selector - * @Default {0} - */ + * @Default {0} + */ offsetY?: number; /** Sets the angle to rotate the selected items - * @Default {0} - */ + * @Default {0} + */ rotateAngle?: number; /** Sets the angle to rotate the selected items. For tooltip properties, refer Tooltip - * @Default {ej.datavisualization.Diagram.Tooltip()} - */ + * @Default {ej.datavisualization.Diagram.Tooltip()} + */ tooltip?: any; /** A collection of frequently used commands that will be added around the selector - * @Default {[]} - */ + * @Default {[]} + */ userHandles?: SelectedItemsUserHandle[]; /** Sets the width of the selected items - * @Default {0} - */ + * @Default {0} + */ width?: number; } export interface SnapSettingsHorizontalGridLines { /** Defines the line color of horizontal grid lines - * @Default {lightgray} - */ + * @Default {lightgray} + */ lineColor?: string; /** Specifies the pattern of dashes and gaps used to stroke horizontal grid lines - */ + */ lineDashArray?: string; /** A pattern of lines and gaps that defines a set of horizontal gridlines - * @Default {[1.25, 18.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75]} - */ + * @Default {[1.25, 18.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75]} + */ linesInterval?: any[]; /** Specifies a set of intervals to snap the objects - * @Default {[20]} - */ + * @Default {[20]} + */ snapInterval?: any[]; } export interface SnapSettingsVerticalGridLines { /** Defines the line color of horizontal grid lines - * @Default {lightgray} - */ + * @Default {lightgray} + */ lineColor?: string; /** Specifies the pattern of dashes and gaps used to stroke horizontal grid lines - */ + */ lineDashArray?: string; /** A pattern of lines and gaps that defines a set of horizontal gridlines - * @Default {[1.25, 18.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75]} - */ + * @Default {[1.25, 18.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75]} + */ linesInterval?: any[]; /** Specifies a set of intervals to snap the objects - * @Default {[20]} - */ + * @Default {[20]} + */ snapInterval?: any[]; } export interface SnapSettings { /** Enables or disables snapping nodes/connectors to objects - * @Default {true} - */ + * @Default {true} + */ enableSnapToObject?: boolean; /** Defines the appearance of horizontal gridlines - */ + */ horizontalGridLines?: SnapSettingsHorizontalGridLines; /** Defines the angle by which the object needs to be snapped - * @Default {5} - */ + * @Default {5} + */ snapAngle?: number; /** Defines and sets the snapConstraints - */ + */ snapConstraints?: ej.datavisualization.Diagram.SnapConstraints|string; /** Defines the minimum distance between the selected object and the nearest object - * @Default {5} - */ + * @Default {5} + */ snapObjectDistance?: number; /** Defines the appearance of horizontal gridlines - */ + */ verticalGridLines?: SnapSettingsVerticalGridLines; } export interface TooltipAlignment { /** Defines the horizontal alignment of tooltip. - * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Center} - */ + * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Center} + */ horizontal?: ej.datavisualization.Diagram.HorizontalAlignment|string; /** Defines the vertical alignment of tooltip. - * @Default {ej.datavisualization.Diagram.VerticalAlignment.Bottom} - */ + * @Default {ej.datavisualization.Diagram.VerticalAlignment.Bottom} + */ vertical?: ej.datavisualization.Diagram.VerticalAlignment|string; } export interface Tooltip { /** Aligns the tooltip around nodes/connectors - */ + */ alignment?: TooltipAlignment; /** Sets the margin of the tooltip - * @Default {{ left: 5, right: 5, top: 5, bottom: 5 }} - */ + * @Default {{ left: 5, right: 5, top: 5, bottom: 5 }} + */ margin?: any; /** Defines whether the tooltip should be shown at the mouse position or around node. - * @Default {ej.datavisualization.Diagram.RelativeMode.Object} - */ + * @Default {ej.datavisualization.Diagram.RelativeMode.Object} + */ relativeMode?: ej.datavisualization.Diagram.RelativeMode|string; /** Sets the svg/html template to be bound with tooltip - */ + */ templateId?: string; } } @@ -62554,67 +62555,67 @@ export namespace HeatMap { export interface Model { /** Specifies the width of the heat map. - * @Default {null} - */ + * @Default {null} + */ width?: any; /** Specifies the width of the heat map. - * @Default {null} - */ + * @Default {null} + */ height?: any; /** Specifies the name of the heat map. - * @Default {null} - */ + * @Default {null} + */ id?: number; /** Enables or disables tooltip of heatmap - * @Default {true} - */ + * @Default {true} + */ showTooltip?: boolean; /** Defines the tooltip that should be shown when the mouse hovers over rows/columns. - */ + */ tooltipSettings?: TooltipSettings; /** Specifies the source data of the heat map. - * @Default {[]} - */ + * @Default {[]} + */ itemsSource?: any; /** Specifies the property of the heat map cell. - * @Default {Null} - */ + * @Default {Null} + */ heatMapCell?: HeatMapCell; /** Specifies can enable responsive mode or not for heat map. - * @Default {false} - */ + * @Default {false} + */ isResponsive?: boolean; /** Specifies whether the virtualization can be enable or not. - * @Default {false} - */ + * @Default {false} + */ enableVirtualization?: boolean; /** Specifies the default column properties for all the column style not specified in column properties. - * @Default {[]} - */ + * @Default {[]} + */ defaultColumnStyle?: DefaultColumnStyle; /** Specifies the no of legends can sync with heat map. - * @Default {[]} - */ + * @Default {[]} + */ legendCollection?: any[]; /** Specifies the property and display value of the heat map column. - * @Default {[]} - */ + * @Default {[]} + */ itemsMapping?: ItemsMapping; /** Specifies the color values of the heat map column data. - * @Default {[]} - */ + * @Default {[]} + */ colorMappingCollection?: ColorMappingCollection[]; /** Triggered when the mouse over on the cell. */ @@ -62633,328 +62634,328 @@ export interface Model { export interface CellMouseOverEventArgs { /** Value displayed on the cell - */ + */ cellValue?: string; /** Returns the HeatMap cell data - */ + */ source?: any; /** Returns the specific HeatMap cell - */ + */ cell?: any; } export interface CellMouseEnterEventArgs { /** Value displayed on the cell - */ + */ cellValue?: string; /** Returns the HeatMap cell data - */ + */ source?: any; /** Returns the specific HeatMap cell - */ + */ cell?: any; } export interface CellMouseLeaveEventArgs { /** Value displayed on the cell - */ + */ cellValue?: string; /** Returns the HeatMap cell data - */ + */ source?: any; /** Returns the specific HeatMap cell - */ + */ cell?: any; } export interface CellSelectedEventArgs { /** Value displayed on the cell - */ + */ cellValue?: string; /** Returns the HeatMap cell data - */ + */ source?: any; /** Returns the specific HeatMap cell - */ + */ cell?: any; } export interface TooltipSettingsPositionTarget { /** Sets the arrow position again popup based on horizontal(x) value - * @Default {center} - */ + * @Default {center} + */ horizontal?: ej.datavisualization.HeatMap.Horizontal|string; /** Sets the arrow position again popup based on vertical(y) value - * @Default {top} - */ + * @Default {top} + */ vertical?: ej.datavisualization.HeatMap.Vertical|string; } export interface TooltipSettingsPositionStem { /** Sets the arrow position again popup based on horizontal(x) value - * @Default {center} - */ + * @Default {center} + */ horizontal?: ej.datavisualization.HeatMap.Horizontal|string; /** Sets the arrow position again popup based on vertical(y) value - * @Default {bottom} - */ + * @Default {bottom} + */ vertical?: ej.datavisualization.HeatMap.Vertical|string; } export interface TooltipSettingsPosition { /** Sets the Tooltip position against target. - */ + */ target?: TooltipSettingsPositionTarget; /** Sets the arrow position again popup. - */ + */ stem?: TooltipSettingsPositionStem; } export interface TooltipSettingsAnimation { /** Defines the animation effect for the tooltip that should be shown when the mouse hovers over rows/columns. - * @Default {none} - */ + * @Default {none} + */ effect?: ej.datavisualization.HeatMap.Effect|string; /** Defines the animation speed for the tooltip that should be shown when the mouse hovers over rows/columns. - * @Default {0} - */ + * @Default {0} + */ speed?: number; } export interface TooltipSettings { /** Defines the tooltip that should be shown when the mouse hovers over rows/columns. - * @Default {null} - */ + * @Default {null} + */ templateId?: string; /** Defines the tooltip of associate that should be shown when the mouse hovers over rows/columns. - * @Default {mouseFollow} - */ + * @Default {mouseFollow} + */ associate?: ej.datavisualization.HeatMap.Associate|string; /** Enables/ disables the balloon for the tooltip to be shown - * @Default {true} - */ + * @Default {true} + */ isBalloon?: boolean; /** Defines various attributes of the Tooltip position - */ + */ position?: TooltipSettingsPosition; /** Defines the tooltip to be triggered. - * @Default {hover} - */ + * @Default {hover} + */ trigger?: ej.datavisualization.HeatMap.Trigger|string; /** Defines the animation for the tooltip that should be shown when the mouse hovers over rows/columns. - */ + */ animation?: TooltipSettingsAnimation; } export interface HeatMapCell { /** Specifies whether the cell content can be visible or not. - * @Default {ej.HeatMap.CellVisibility.Visible} - */ + * @Default {ej.HeatMap.CellVisibility.Visible} + */ showContent?: ej.datavisualization.HeatMap.CellVisibility|string; /** Specifies whether the cell color can be visible or not. - * @Default {true} - */ + * @Default {true} + */ showColor?: boolean; } export interface DefaultColumnStyle { /** Specifies the alignment mode of the heat map column. - * @Default {ej.HeatMap.TextAlign.Center} - */ + * @Default {ej.HeatMap.TextAlign.Center} + */ textAlign?: any; /** Specifies the template id of the heat map column header. - */ + */ headerTemplateID?: string; /** Specifies the template id of all individual cell data of the heat map. - */ + */ templateID?: string; } export interface ItemsMappingColumnStyle { /** Specifies the width of the heat map column. - * @Default {0} - */ + * @Default {0} + */ width?: number; /** Specifies the text align mode of the heat map column. - * @Default {ej.HeatMap.TextAlign.Center} - */ + * @Default {ej.HeatMap.TextAlign.Center} + */ textAlign?: string; /** Specifies the template id of the column header. - */ + */ headerTemplateID?: string; /** Specifies the template id of all individual cell data. - */ + */ templateID?: string; } export interface ItemsMappingColumn { /** Specifies the name of the column or row. - */ + */ propertyName?: string; /** Specifies the value of the column or row. - */ + */ displayName?: string; } export interface ItemsMappingRow { /** Specifies the name of the column or row. - */ + */ propertyName?: string; /** Specifies the value of the column or row. - */ + */ displayName?: string; } export interface ItemsMappingValue { /** Specifies the name of the column or row. - */ + */ propertyName?: string; /** Specifies the value of the column or row. - */ + */ displayName?: string; } export interface ItemsMappingHeaderMapping { /** Specifies the name of the column or row. - */ + */ propertyName?: string; /** Specifies the value of the column or row. - */ + */ displayName?: string; /** Specifies the property and display value of the header. - * @Default {null} - */ + * @Default {null} + */ columnStyle?: any; } export interface ItemsMapping { /** Column settings for the individual heat map column. - * @Default {null} - */ + * @Default {null} + */ columnStyle?: ItemsMappingColumnStyle; /** Specifies the property and display value of the column. - * @Default {null} - */ + * @Default {null} + */ column?: ItemsMappingColumn; /** Specifies the property and display value of the heat map.row - * @Default {null} - */ + * @Default {null} + */ row?: ItemsMappingRow; /** Specifies the property and display value of the column value. - * @Default {null} - */ + * @Default {null} + */ value?: ItemsMappingValue; /** Specifies the property and display value of the header. - * @Default {null} - */ + * @Default {null} + */ headerMapping?: ItemsMappingHeaderMapping; /** Specifies the property and display value of the collection of column. - * @Default {[]} - */ + * @Default {[]} + */ columnMapping?: any[]; } export interface ColorMappingCollectionLabel { /** Enables/disables the bold style of the heat map label. - * @Default {false} - */ + * @Default {false} + */ bold?: boolean; /** Enables/disables the italic style of the heat map label. - * @Default {false} - */ + * @Default {false} + */ italic?: boolean; /** specifies the text value of the heat map label. - */ + */ text?: string; /** Specifies the text style of the heat map label. - * @Default {ej.HeatMap.TextDecoration.None} - */ + * @Default {ej.HeatMap.TextDecoration.None} + */ textDecoration?: ej.datavisualization.HeatMap.TextDecoration |string; /** Specifies the font size of the heat map label. - * @Default {10} - */ + * @Default {10} + */ fontSize?: number; /** Specifies the font family of the heat map label. - * @Default {Arial} - */ + * @Default {Arial} + */ fontFamily?: string; /** Specifies the font color of the heat map label. - * @Default {black} - */ + * @Default {black} + */ fontColor?: string; } export interface ColorMappingCollection { /** Specifies the color of the heat map column data. - * @Default {white} - */ + * @Default {white} + */ color?: string; /** Specifies the color values of the heat map column data. - * @Default {0} - */ + * @Default {0} + */ value?: number; /** Specifies the label properties of the heat map color. - * @Default {null} - */ + * @Default {null} + */ label?: ColorMappingCollectionLabel; } } @@ -63039,93 +63040,93 @@ export namespace HeatMapLegend { export interface Model { /** Specifies the width of the heatmap legend. - * @Default {null} - */ + * @Default {null} + */ width?: any; /** Specifies the height of the heatmap legend. - * @Default {null} - */ + * @Default {null} + */ height?: any; /** Specifies can enable responsive mode or not for heatmap legend. - * @Default {false} - */ + * @Default {false} + */ isResponsive?: boolean; /** Specifies whether the cell label can be shown or not. - * @Default {false} - */ + * @Default {false} + */ showLabel?: boolean; /** Specifies the color values of the column data. - * @Default {[]} - */ + * @Default {[]} + */ colorMappingCollection?: ColorMappingCollection[]; /** Specifies the orientation of the heatmap legend - * @Default {ej.HeatMap.LegendOrientation.Horizontal} - */ + * @Default {ej.HeatMap.LegendOrientation.Horizontal} + */ orientation?: ej.datavisualization.HeatMap.LegendOrientation|string; /** Specifies the legend mode as gradient or list. - * @Default {ej.HeatMap.LegendMode.Gradient} - */ + * @Default {ej.HeatMap.LegendMode.Gradient} + */ legendMode?: ej.datavisualization.HeatMap.LegendMode|string; } export interface ColorMappingCollectionLabel { /** Enables/disables the bold style of the heatmap legend label. - * @Default {false} - */ + * @Default {false} + */ bold?: boolean; /** Enables/disables the italic style of the heatmap legend label. - * @Default {false} - */ + * @Default {false} + */ italic?: boolean; /** specifies the text value of the heatmap legend label. - */ + */ text?: string; /** Specifies the text style of the heatmap legend label. - * @Default {ej.HeatMap.TextDecoration.None} - */ + * @Default {ej.HeatMap.TextDecoration.None} + */ textDecoration?: ej.datavisualization.HeatMap.TextDecoration|string; /** Specifies the font size of the heatmap legend label. - * @Default {10} - */ + * @Default {10} + */ fontSize?: number; /** Specifies the font family of the heatmap legend label. - * @Default {Arial} - */ + * @Default {Arial} + */ fontFamily?: string; /** Specifies the font color of the heatmap legend label. - * @Default {black} - */ + * @Default {black} + */ fontColor?: string; } export interface ColorMappingCollection { /** Specifies the color of the heatmap legend data. - * @Default {white} - */ + * @Default {white} + */ color?: string; /** Specifies the color values of the heatmap legend column data. - * @Default {0} - */ + * @Default {0} + */ value?: number; /** Specifies the label properties of the heatmap legend color. - * @Default {null} - */ + * @Default {null} + */ label?: ColorMappingCollectionLabel; } } @@ -63154,8 +63155,8 @@ class Sparkline extends ej.Widget { defaults: Sparkline.Model; /** Redraws the entire sparkline. You can call this method whenever you update, add or remove points from the data source or whenever you want to refresh the UI. - * @returns {void} - */ + * @returns {void} + */ redraw(): void; } export namespace Sparkline { @@ -63163,121 +63164,121 @@ export namespace Sparkline { export interface Model { /** Background color of the plot area. - * @Default {transparent} - */ + * @Default {transparent} + */ background?: string; /** Fill color for the sparkline series. - * @Default {#33ccff} - */ + * @Default {#33ccff} + */ fill?: string; /** Border color of the series. - * @Default {null} - */ + * @Default {null} + */ stroke?: string; /** Options for customizing the color, opacity and width of the sparkline border. - */ + */ border?: Border; /** Border width of the series. - * @Default {1} - */ + * @Default {1} + */ width?: number; /** Opacity of the series. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Color for series high point. - * @Default {null} - */ + * @Default {null} + */ highPointColor?: string; /** Color for series low point. - * @Default {null} - */ + * @Default {null} + */ lowPointColor?: string; /** Color for series start point. - * @Default {null} - */ + * @Default {null} + */ startPointColor?: string; /** Color for series end point. - * @Default {null} - */ + * @Default {null} + */ endPointColor?: string; /** Color for series negative point. - * @Default {null} - */ + * @Default {null} + */ negativePointColor?: string; /** Options for customizing the color, opacity of the sparkline start and end range. - */ + */ rangeBandSettings?: RangeBandSettings; /** Name of a field in data source, where the fill color for all the data points is generated. - */ + */ palette?: string; /** Controls whether sparkline has to be responsive or not. - * @Default {true} - */ + * @Default {true} + */ isResponsive?: boolean; /** Controls whether Sparkline has to be rendered as Canvas or SVG.Canvas rendering supports all functionalities in SVG rendering. - * @Default {false} - */ + * @Default {false} + */ enableCanvasRendering?: boolean; /** Specifies the dataSource for the series. It can be an array of JSON objects or an instance of ej.DataManager. - * @Default {null} - */ + * @Default {null} + */ dataSource?: any; /** Name of the property in the datasource that contains x value for the series. - * @Default {null} - */ + * @Default {null} + */ xName?: string; /** Name of the property in the datasource that contains y value for the series. - * @Default {null} - */ + * @Default {null} + */ yName?: string; /** Gap or padding for sparkline. - * @Default {8} - */ + * @Default {8} + */ padding?: number; /** Specifies the type of the series to render in sparkline. - * @Default {line. See Type} - */ + * @Default {line. See Type} + */ type?: ej.datavisualization.Sparkline.Type|string; /** Specifies the theme for Sparkline. - * @Default {Flatlight. See Theme} - */ + * @Default {Flatlight. See Theme} + */ theme?: ej.datavisualization.Sparkline.Theme|string; /** Options to customize the tooltip. - */ + */ tooltip?: Tooltip; /** Options for displaying and customizing marker for a data point. - */ + */ markerSettings?: MarkerSettings; /** Options to customize the Sparkline size. - */ + */ size?: Size; /** Options for customizing the color,dashArray and width of the axisLine. - */ + */ axisLineSettings?: AxisLineSettings; /** Fires before loading the sparkline. */ @@ -63308,372 +63309,372 @@ export interface Model { export interface LoadEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sparkline model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface LoadedEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sparkline model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface TooltipInitializeEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sparkline model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** X Location of the trackball tooltip in pixels - */ + */ locationX?: any; /** Y Location of the trackball tooltip in pixels - */ + */ locationY?: any; /** Index of the point for which trackball tooltip is displayed - */ + */ pointIndex?: number; /** Text to be displayed in trackball tooltip. Use this option to add custom text in trackball tooltip - */ + */ currentText?: string; } export interface SeriesRenderingEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sparkline model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** Minimum x value of the data point - */ + */ minX?: any; /** Minimum y value of the data point - */ + */ minY?: any; /** Maximum x value of the data point - */ + */ maxX?: any; /** Maximum y value of the data point - */ + */ maxY?: any; } export interface PointRegionMouseMoveEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sparkline model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** X-coordinate of point in pixel - */ + */ locationX?: number; /** Y-coordinate of point in pixel - */ + */ locationY?: number; /** Index of the point in series - */ + */ pointIndex?: number; /** Type of the series - */ + */ seriesType?: string; } export interface PointRegionMouseClickEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sparkline model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; /** X-coordinate of point in pixel - */ + */ locationX?: number; /** Y-coordinate of point in pixel - */ + */ locationY?: number; /** Index of the point in series - */ + */ pointIndex?: number; /** Type of the series - */ + */ seriesType?: string; } export interface SparklineMouseMoveEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sparkline model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface SparklineMouseLeaveEventArgs { /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sparkline model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface Border { /** Border color of the sparkline. - * @Default {transparent} - */ + * @Default {transparent} + */ color?: string; /** Width of the Sparkline border. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface RangeBandSettings { /** Start value of the range band. - * @Default {null} - */ + * @Default {null} + */ startRange?: number; /** End value of the range band. - * @Default {null} - */ + * @Default {null} + */ endRange?: number; /** Range band opacity of the series. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Range band color of the series. - * @Default {transparent} - */ + * @Default {transparent} + */ color?: string; } export interface TooltipBorder { /** Border color of the tooltip. - * @Default {transparent} - */ + * @Default {transparent} + */ color?: string; /** Border width of the tooltip. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface TooltipFont { /** Font color of the text in the tooltip. - * @Default {#111111} - */ + * @Default {#111111} + */ color?: string; /** Font Family for the tooltip. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Specifies the font Style for the tooltip. - * @Default {Normal} - */ + * @Default {Normal} + */ fontStyle?: ej.datavisualization.Sparkline.FontStyle|string; /** Specifies the font weight for the tooltip. - * @Default {Regular} - */ + * @Default {Regular} + */ fontWeight?: ej.datavisualization.Sparkline.FontWeight|string; /** Opacity for text in the tooltip. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font size for text in the tooltip. - * @Default {8px} - */ + * @Default {8px} + */ size?: string; } export interface Tooltip { /** Show/hides the tooltip visibility. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; /** Fill color for the sparkline tooltip. - * @Default {white} - */ + * @Default {white} + */ fill?: string; /** Custom template to the tooltip. - */ + */ template?: string; /** Options for customizing the border of the tooltip. - */ + */ border?: TooltipBorder; /** Options for customizing the font of the tooltip. - */ + */ font?: TooltipFont; } export interface MarkerSettingsBorder { /** Border color of the marker shape. - * @Default {transparent} - */ + * @Default {transparent} + */ color?: string; /** Controls the opacity of the marker border. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Border width of the marker shape. - * @Default {null} - */ + * @Default {null} + */ width?: number; } export interface MarkerSettings { /** Controls the opacity of the marker. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Controls the visibility of the marker shape. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; /** width of the marker shape. - * @Default {2} - */ + * @Default {2} + */ width?: number; /** Color of the marker shape. - * @Default {white} - */ + * @Default {white} + */ fill?: string; /** Options for customizing the border of the marker shape. - */ + */ border?: MarkerSettingsBorder; } export interface Size { /** Height of the Sparkline. Height can be specified in either pixel or percentage. - * @Default {''} - */ + * @Default {''} + */ height?: string; /** Width of the Sparkline. Width can be specified in either pixel or percentage. - * @Default {''} - */ + * @Default {''} + */ width?: string; } export interface AxisLineSettings { /** Controls the visibility of the axis. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; /** Color of the axis line. - * @Default {'#111111'} - */ + * @Default {'#111111'} + */ color?: string; /** Width of the axis line. - * @Default {1} - */ + * @Default {1} + */ width?: number; /** Dash array of the axis line. - * @Default {1} - */ + * @Default {1} + */ dashArray?: number; } } @@ -63742,13 +63743,13 @@ class SunburstChart extends ej.Widget { defaults: SunburstChart.Model; /** Redraws the entire sunburst. You can call this method whenever you update, add or remove points from the data source or whenever you want to refresh the UI. - * @returns {void} - */ + * @returns {void} + */ redraw(): void; /** destroy the sunburst - * @returns {void} - */ + * @returns {void} + */ _destroy(): void; } export namespace SunburstChart { @@ -63756,141 +63757,141 @@ export namespace SunburstChart { export interface Model { /** Background color of the plot area. - * @Default {null} - */ + * @Default {null} + */ background?: string; /** Bind the data field from the data source. - * @Default {null} - */ + * @Default {null} + */ valueMemberPath?: string; /** Options for customizing the sunburst border. - */ + */ border?: Border; /** Options for customizing the sunburst segment border. - */ + */ segmentBorder?: SegmentBorder; /** Specifies the dataSource to the sunburst. - * @Default {null} - */ + * @Default {null} + */ dataSource?: any; /** Palette color for the data points. - * @Default {null} - */ + * @Default {null} + */ palette?: string; /** Parent node of the data points. - * @Default {null} - */ + * @Default {null} + */ parentNode?: string; /** Name of the property in the datasource that contains x values. - * @Default {null} - */ + * @Default {null} + */ xName?: string; /** Name of the property in the datasource that contains y values. - * @Default {null} - */ + * @Default {null} + */ yName?: string; /** Controls whether sunburst has to be responsive or not. - * @Default {true} - */ + * @Default {true} + */ isResponsive?: boolean; /** Options to customize the Sunburst size. - */ + */ size?: Size; /** Controls the visibility of sunburst. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Options to customize the Sunburst tooltip. - */ + */ tooltip?: Tooltip; /** Options for customizing sunburst points. - */ + */ points?: Points; /** Sunburst rendering will start from the specified value - * @Default {null} - */ + * @Default {null} + */ startAngle?: number; /** Sunburst rendering will end at the specified value - * @Default {null} - */ + * @Default {null} + */ endAngle?: number; /** Sunburst outer radius value - * @Default {1} - */ + * @Default {1} + */ radius?: number; /** Sunburst inner radius value - * @Default {0.4} - */ + * @Default {0.4} + */ innerRadius?: number; /** Options to customize the Sunburst dataLabel. - */ + */ dataLabelSettings?: DataLabelSettings; /** Options for customizing the title and subtitle of sunburst. - */ + */ title?: Title; /** Options for customizing the appearance of the levels or point while highlighting. - */ + */ highlightSettings?: HighlightSettings; /** Options for customizing the appearance of the levels or data point while selection. - */ + */ selectionSettings?: SelectionSettings; /** Specify levels of sunburst for grouped visualization of data - * @Default {[]} - */ + * @Default {[]} + */ levels?: Level[]; /** Options to customize the legend items and legend title. - */ + */ legend?: Legend; /** Specifies the theme for Sunburst. - * @Default {Flatlight. See Theme} - */ + * @Default {Flatlight. See Theme} + */ theme?: ej.datavisualization.Sunburst.SunburstTheme|string; /** Options to customize the left, right, top and bottom margins of sunburst area. - */ + */ margin?: Margin; /** Enable/disable the animation for all the levels. - * @Default {false} - */ + * @Default {false} + */ enableAnimation?: boolean; /** Opacity of the levels. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Options for enable zooming feature of chart. - */ + */ zoomSettings?: ZoomSettings; /** Animation type of sunburst - * @Default {rotation. See Alignment} - */ + * @Default {rotation. See Alignment} + */ animationType?: ej.datavisualization.Sunburst.Animation|string; /** Fires before loading. */ @@ -63933,820 +63934,820 @@ export interface Model { export interface LoadEventArgs { /** Load event data - */ + */ data?: string; /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sunburst model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface PreRenderEventArgs { /** PreRender event data - */ + */ data?: string; /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sunburst model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface LoadedEventArgs { /** Loaded event data - */ + */ data?: string; /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sunburst model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface DataLabelRenderingEventArgs { /** Sunburst datalabel data - */ + */ data?: string; /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sunburst model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface SegmentRenderingEventArgs { /** Sunburst datalabel data - */ + */ data?: string; /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sunburst model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface TitleRenderingEventArgs { /** Sunburst title data - */ + */ data?: string; /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sunburst model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface TooltipInitializeEventArgs { /** Sunburst tooltip data - */ + */ data?: string; /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sunburst model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface PointRegionClickEventArgs { /** Includes clicked points region data - */ + */ data?: string; /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sunburst model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface PointRegionMouseMoveEventArgs { /** Includes data of mouse moved region - */ + */ data?: string; /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sunburst model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface DrillDownClickEventArgs { /** Clicked point data - */ + */ data?: string; /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sunburst model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface DrillDownBackEventArgs { /** Drill down data of points - */ + */ data?: string; /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sunburst model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface DrillDownResetEventArgs { /** Drill down reset data - */ + */ data?: string; /** Set this option to true to cancel the event - */ + */ cancel?: boolean; /** Instance of the sunburst model object - */ + */ model?: any; /** Name of the event - */ + */ type?: string; } export interface Border { /** Border color of the sunburst. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Width of the Sunburst border. - * @Default {2} - */ + * @Default {2} + */ width?: number; } export interface SegmentBorder { /** Segment Border color of the sunburst. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Width of the Sunburst segment border. - * @Default {2} - */ + * @Default {2} + */ width?: number; } export interface Size { /** Height of the Sunburst. - * @Default {''} - */ + * @Default {''} + */ height?: string; /** Width of the Sunburst. - * @Default {''} - */ + * @Default {''} + */ width?: string; } export interface TooltipBorder { /** Border color of the tooltip. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Border width of the tooltip. - * @Default {5} - */ + * @Default {5} + */ width?: number; } export interface TooltipFont { /** Font color of the text in the tooltip. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Font Family for the tooltip. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Specifies the font Style for the tooltip. - * @Default {Normal} - */ + * @Default {Normal} + */ fontStyle?: ej.datavisualization.Sunburst.FontStyle|string; /** Specifies the font weight for the tooltip. - * @Default {Regular} - */ + * @Default {Regular} + */ fontWeight?: ej.datavisualization.Sunburst.FontWeight|string; /** Opacity for text in the tooltip. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font size for text in the tooltip. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface Tooltip { /** tooltip visibility of the Sunburst. - * @Default {true} - */ + * @Default {true} + */ visible?: boolean; /** Options for customizing the border of the sunburst tooltip. - */ + */ border?: TooltipBorder; /** Fill color for the sunburst tooltip. - * @Default {null} - */ + * @Default {null} + */ fill?: string; /** Options for customizing the font of the tooltip. - */ + */ font?: TooltipFont; /** Custom template to the tooltip. - * @Default {null} - */ + * @Default {null} + */ template?: string; } export interface Points { /** Points x value of the sunburst. - * @Default {null} - */ + * @Default {null} + */ x?: string; /** Points y value of the sunburst. - * @Default {null} - */ + * @Default {null} + */ y?: number; /** Points text of the sunburst. - * @Default {null} - */ + * @Default {null} + */ text?: string; /** Points fill color of the sunburst. - * @Default {null} - */ + * @Default {null} + */ fill?: string; } export interface DataLabelSettingsFont { /** Font family of the data label. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style of the data label. - * @Default {normal. See FontStyle} - */ + * @Default {normal. See FontStyle} + */ fontStyle?: ej.datavisualization.Sunburst.FontStyle|string; /** Font weight of the data label. - * @Default {regular. See FontWeight} - */ + * @Default {regular. See FontWeight} + */ fontWeight?: ej.datavisualization.Sunburst.FontWeight|string; /** Opacity of the text. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font color of the data label text. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Font size of the data label. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface DataLabelSettings { /** Datalabel visibility of the Sunburst. - * @Default {false} - */ + * @Default {false} + */ visible?: boolean; /** Alignment of sunburst datalabel - * @Default {Angle. See DatalabelAlignment} - */ + * @Default {Angle. See DatalabelAlignment} + */ labelRotationMode?: ej.datavisualization.Sunburst.SunburstLabelRotationMode|string; /** Options for customizing the data label font. - */ + */ font?: DataLabelSettingsFont; /** Custom template for datalabel - * @Default {null} - */ + * @Default {null} + */ template?: string; /** Fill color for the datalabel - * @Default {null} - */ + * @Default {null} + */ fill?: string; /** Datalabel overflow mode - * @Default {Trim. See LabelOverflowMode} - */ + * @Default {Trim. See LabelOverflowMode} + */ labelOverflowMode?: ej.datavisualization.Sunburst.SunburstLabelOverflowMode|string; } export interface TitleFont { /** Font family for Sunburst title. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style for Sunburst title. - * @Default {Normal. See FontStyle} - */ + * @Default {Normal. See FontStyle} + */ fontStyle?: ej.datavisualization.Sunburst.FontStyle|string; /** Font weight for Sunburst title. - * @Default {Regular. See FontWeight} - */ + * @Default {Regular. See FontWeight} + */ fontWeight?: ej.datavisualization.Sunburst.FontWeight|string; /** Opacity of the Sunburst title. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font size for Sunburst title. - * @Default {20px} - */ + * @Default {20px} + */ size?: string; } export interface TitleSubtitleFont { /** Font family of sub title. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style for sub title. - * @Default {Normal. See FontStyle} - */ + * @Default {Normal. See FontStyle} + */ fontStyle?: ej.datavisualization.Sunburst.FontStyle|string; /** Font weight for sub title. - * @Default {Regular. See FontWeight} - */ + * @Default {Regular. See FontWeight} + */ fontWeight?: ej.datavisualization.Sunburst.FontWeight|string; /** Opacity of the sub title. - * @Default {1} - */ + * @Default {1} + */ opacity?: number; /** Font size for sub title. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface TitleSubtitle { /** Subtitle text for sunburst - */ + */ text?: string; /** Sub title text visibility for sunburst - * @Default {true} - */ + * @Default {true} + */ visible?: string; /** Sub title text alignment - * @Default {far. See TextAlignment} - */ + * @Default {far. See TextAlignment} + */ textAlignment?: ej.datavisualization.Sunburst.SunburstAlignment|string; /** Options for customizing the font of sub title. - */ + */ font?: TitleSubtitleFont; } export interface Title { /** Title text for sunburst - */ + */ text?: string; /** Title text visibility for sunburst - * @Default {true} - */ + * @Default {true} + */ visible?: string; /** Title text alignment - * @Default {center. See TextAlignment} - */ + * @Default {center. See TextAlignment} + */ textAlignment?: ej.datavisualization.Sunburst.SunburstAlignment|string; /** Options for customizing the font of sunburst title. - */ + */ font?: TitleFont; /** Options to customize the sub title of Sunburst. - */ + */ subtitle?: TitleSubtitle; } export interface HighlightSettings { /** Enables/disables the ability to highlight the levels or point interactively. - * @Default {false} - */ + * @Default {false} + */ enable?: boolean; /** Specifies whether the levels or point has to be highlighted. - * @Default {point. See Mode} - */ + * @Default {point. See Mode} + */ mode?: ej.datavisualization.Sunburst.SunburstHighlightMode|string; /** Color of the levels/point on highlight. - * @Default {red} - */ + * @Default {red} + */ color?: string; /** Opacity of the levels/point on highlight. - * @Default {0.5} - */ + * @Default {0.5} + */ opacity?: number; /** Specifies whether the levels or data point has to be highlighted. - * @Default {opacity. See Mode} - */ + * @Default {opacity. See Mode} + */ type?: ej.datavisualization.Sunburst.SunburstHighlightType|string; } export interface SelectionSettings { /** Enables/disables the ability to select the levels or data point interactively. - * @Default {false} - */ + * @Default {false} + */ enable?: boolean; /** Specifies whether the levels or data point has to be selected. - * @Default {point. See Mode} - */ + * @Default {point. See Mode} + */ mode?: ej.datavisualization.Sunburst.SunburstHighlightMode|string; /** Color of the levels/point on selection. - * @Default {green} - */ + * @Default {green} + */ color?: string; /** Opacity of the levels/point on selection. - * @Default {0.5} - */ + * @Default {0.5} + */ opacity?: number; /** Specifies whether the levels or data point has to be selected. - * @Default {opacity. See Mode} - */ + * @Default {opacity. See Mode} + */ type?: ej.datavisualization.Sunburst.SunburstHighlightType|string; } export interface Level { /** Specifies the group member path - * @Default {null} - */ + * @Default {null} + */ groupMemberPath?: string; } export interface LegendBorder { /** Border color of the legend. - * @Default {null} - */ + * @Default {null} + */ color?: string; /** Border width of the legend. - * @Default {1} - */ + * @Default {1} + */ width?: number; } export interface LegendFont { /** Font family for legend item text. - * @Default {Segoe UI} - */ + * @Default {Segoe UI} + */ fontFamily?: string; /** Font style for legend item text. - * @Default {Normal. See FontStyle} - */ + * @Default {Normal. See FontStyle} + */ fontStyle?: ej.datavisualization.Sunburst.FontStyle|string; /** Font weight for legend item text. - * @Default {Regular. See FontWeight} - */ + * @Default {Regular. See FontWeight} + */ fontWeight?: ej.datavisualization.Sunburst.FontWeight|string; /** Font size for legend item text. - * @Default {12px} - */ + * @Default {12px} + */ size?: string; } export interface LegendItemStyle { /** Height of the shape in legend items. - * @Default {10} - */ + * @Default {10} + */ height?: number; /** Width of the shape in legend items. - * @Default {10} - */ + * @Default {10} + */ width?: number; } export interface LegendLocation { /** X value or horizontal offset to position the legend in chart. - * @Default {0} - */ + * @Default {0} + */ x?: number; /** Y value or vertical offset to position the legend. - * @Default {0} - */ + * @Default {0} + */ y?: number; } export interface LegendSize { /** Height of the legend. Height can be specified in either pixel or percentage. - * @Default {null} - */ + * @Default {null} + */ height?: string; - /** Width of the legend. Width can be specified in either pixel or percentage. - * @Default {null} - */ + /** Width of the legend. Width can be specified in either pixel or percentage. + * @Default {null} + */ width?: string; } export interface LegendTitleFont { - /** Font family for the text in legend title. - * @Default {Segoe UI} - */ + /** Font family for the text in legend title. + * @Default {Segoe UI} + */ fontFamily?: string; - /** Font style for legend title. - * @Default {normal. See FontStyle} - */ + /** Font style for legend title. + * @Default {normal. See FontStyle} + */ fontStyle?: ej.datavisualization.Sunburst.FontStyle|string; - /** Font weight for legend title. - * @Default {normal. See FontWeight} - */ + /** Font weight for legend title. + * @Default {normal. See FontWeight} + */ fontWeight?: ej.datavisualization.Sunburst.FontWeight|string; - /** Font size for legend title. - * @Default {12px} - */ + /** Font size for legend title. + * @Default {12px} + */ size?: string; } export interface LegendTitle { - /** Options to customize the font used for legend title - */ + /** Options to customize the font used for legend title + */ font?: LegendTitleFont; - /** Enables or disables the legend title. - * @Default {true} - */ + /** Enables or disables the legend title. + * @Default {true} + */ visible?: string; - /** Text to be displayed in legend title. - */ + /** Text to be displayed in legend title. + */ text?: string; - /** Alignment of the legend title. - * @Default {center. See Alignment} - */ + /** Alignment of the legend title. + * @Default {center. See Alignment} + */ textAlignment?: ej.datavisualization.Sunburst.SunburstAlignment|string; } export interface Legend { - /** Visibility of the legend. - * @Default {false} - */ + /** Visibility of the legend. + * @Default {false} + */ visible?: boolean; - /** Interactive action of legend items. - * @Default {toggleSegmentVisibility. See Alignment} - */ + /** Interactive action of legend items. + * @Default {toggleSegmentVisibility. See Alignment} + */ clickAction?: ej.datavisualization.Sunburst.SunburstClickAction|string; - /** Horizontal alignment of the legend. - * @Default {Center. See Alignment} - */ + /** Horizontal alignment of the legend. + * @Default {Center. See Alignment} + */ alignment?: ej.datavisualization.Sunburst.SunburstAlignment|string; - /** Options for customizing the legend border. - */ + /** Options for customizing the legend border. + */ border?: LegendBorder; - /** Number of columns to arrange the legend items. - * @Default {null} - */ + /** Number of columns to arrange the legend items. + * @Default {null} + */ columnCount?: number; - /** Number of rows to arrange the legend items. - * @Default {null} - */ + /** Number of rows to arrange the legend items. + * @Default {null} + */ rowCount?: number; - /** Options to customize the font used for legend item text. - */ + /** Options to customize the font used for legend item text. + */ font?: LegendFont; - /** Gap or padding between the legend items. - * @Default {10} - */ + /** Gap or padding between the legend items. + * @Default {10} + */ itemPadding?: number; - /** Options to customize the style of legend items. - */ + /** Options to customize the style of legend items. + */ itemStyle?: LegendItemStyle; - /** Options to customize the location of sunburst legend. Legend is placed in provided location only when value of position property is custom - */ + /** Options to customize the location of sunburst legend. Legend is placed in provided location only when value of position property is custom + */ location?: LegendLocation; - /** Places the legend at specified position. Legend can be placed at left, right, top or bottom of the chart area.To manually specify the location of legend, set custom as value to this property. - * @Default {Bottom. See Position} - */ + /** Places the legend at specified position. Legend can be placed at left, right, top or bottom of the chart area.To manually specify the location of legend, set custom as value to this property. + * @Default {Bottom. See Position} + */ position?: ej.datavisualization.Sunburst.SunburstLegendPosition|string; - /** Shape of the legend items. - * @Default {None. See Shape} - */ + /** Shape of the legend items. + * @Default {None. See Shape} + */ shape?: ej.datavisualization.Sunburst.SunburstLegendShape|string; - /** Options to customize the size of the legend. - */ + /** Options to customize the size of the legend. + */ size?: LegendSize; - /** Options to customize the legend title. - */ + /** Options to customize the legend title. + */ title?: LegendTitle; } export interface Margin { - /** Spacing for the left margin of chart area. Setting positive value decreases the width of the chart area from left side. - * @Default {10} - */ + /** Spacing for the left margin of chart area. Setting positive value decreases the width of the chart area from left side. + * @Default {10} + */ left?: number; - /** Spacing for the right margin of chart area. Setting positive value decreases the width of the chart area from right side. - * @Default {10} - */ + /** Spacing for the right margin of chart area. Setting positive value decreases the width of the chart area from right side. + * @Default {10} + */ right?: number; - /** Spacing for the top margin of chart area. Setting positive value decreases the height of the chart area from the top. - * @Default {10} - */ + /** Spacing for the top margin of chart area. Setting positive value decreases the height of the chart area from the top. + * @Default {10} + */ top?: number; - /** Spacing for the bottom margin of the chart area. Setting positive value decreases the height of the chart area from the bottom. - * @Default {10} - */ + /** Spacing for the bottom margin of the chart area. Setting positive value decreases the height of the chart area from the bottom. + * @Default {10} + */ bottom?: number; } export interface ZoomSettings { - /** Enables or disables zooming. - * @Default {false} - */ + /** Enables or disables zooming. + * @Default {false} + */ enable?: boolean; - /** Toolbar horizontal alignment - * @Default {right. See Alignment} - */ + /** Toolbar horizontal alignment + * @Default {right. See Alignment} + */ toolbarHorizontalAlignment?: ej.datavisualization.Sunburst.SunburstHorizontalAlignment|string; - /** Toolbar vertical alignment - * @Default {top. See Alignment} - */ + /** Toolbar vertical alignment + * @Default {top. See Alignment} + */ toolbarVerticalAlignment?: ej.datavisualization.Sunburst.SunburstVerticalAlignment|string; } } @@ -64902,19 +64903,19 @@ export namespace Overview { export interface Model { - /** The sourceId property of overview should be set with the corresponding Diagram ID for you need the overall view. - * @Default {null} - */ + /** The sourceId property of overview should be set with the corresponding Diagram ID for you need the overall view. + * @Default {null} + */ sourceID?: string; - /** Defines the height of the overview - * @Default {400} - */ + /** Defines the height of the overview + * @Default {400} + */ height?: number; - /** Defines the width of the overview - * @Default {250} - */ + /** Defines the width of the overview + * @Default {250} + */ width?: number; } } @@ -64922,30 +64923,34 @@ export interface Model { } interface JQueryXHR { - /** Returns the cancel option value. - */ + /** + * Returns the cancel option value. + */ cancel?: boolean; } interface JQueryPromise { - /** Returns the cancel option value. - */ + /** + * Returns the cancel option value. + */ cancel?: boolean; } interface JQueryDeferred extends JQueryPromise { - /** Returns the cancel option value. - */ + /** + * Returns the cancel option value. + */ cancel?: boolean; } interface JQueryParam { - /** Returns the cancel option value. - */ + /** + * Returns the cancel option value. + */ cancel?: boolean; } interface JQuery { - data(key: any): any; + data(key: any): any; } interface Window { - ej: typeof ej; + ej: typeof ej; } interface JQuery { From 47ff335aa317434f3c6ffa6db4792710756a3bfd Mon Sep 17 00:00:00 2001 From: Jaakko Hannikainen Date: Thu, 6 Apr 2017 15:55:46 +0300 Subject: [PATCH 203/844] [react-intl] Allow using JSX elements with --- types/react-intl/index.d.ts | 6 +++++- types/react-intl/react-intl-tests.tsx | 7 +++++++ 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/types/react-intl/index.d.ts b/types/react-intl/index.d.ts index d9f965602d..bbe1a49be5 100644 --- a/types/react-intl/index.d.ts +++ b/types/react-intl/index.d.ts @@ -11,6 +11,10 @@ declare namespace ReactIntl { interface Values { + [key: string]: string | JSX.Element; + } + + interface HTMLValues { [key: string]: string; } @@ -71,7 +75,7 @@ declare namespace ReactIntl { formatNumber: (value: number, options?: FormattedNumber.PropsBase) => string; formatPlural: (value: number, options?: FormattedPlural.Base) => keyof FormattedPlural.PropsBase; formatMessage: (messageDescriptor: FormattedMessage.MessageDescriptor, values?: Values) => string; - formatHTMLMessage: (messageDescriptor: FormattedMessage.MessageDescriptor, values?: Values) => string; + formatHTMLMessage: (messageDescriptor: FormattedMessage.MessageDescriptor, values?: HTMLValues) => string; locale: string; formats: any; messages: { [id: string]: string }; diff --git a/types/react-intl/react-intl-tests.tsx b/types/react-intl/react-intl-tests.tsx index 55528a385e..6ef7e5038f 100644 --- a/types/react-intl/react-intl-tests.tsx +++ b/types/react-intl/react-intl-tests.tsx @@ -87,6 +87,13 @@ class SomeComponent extends React.Component + p

    }} + tagName="div" /> + Date: Thu, 6 Apr 2017 15:01:04 +0200 Subject: [PATCH 204/844] Fix lint issues --- types/loopback/index.d.ts | 234 +++++++++++++++++++------------------- 1 file changed, 117 insertions(+), 117 deletions(-) diff --git a/types/loopback/index.d.ts b/types/loopback/index.d.ts index 5eadbb871f..adb14ae209 100644 --- a/types/loopback/index.d.ts +++ b/types/loopback/index.d.ts @@ -84,7 +84,7 @@ declare namespace l { * as the request handle * listen(cb?: () => void):http.Serve * - */ + */ // listen(port?: number, cb?: () => void): any; /** @@ -253,25 +253,25 @@ declare namespace l { // interface Send extends core.Send { } /** - * LoopBack core module. It provides static properties and - * methods to create models and data sources. The module itself is a function - * that creates loopback `app`. For example: - * - * ```js - * var loopback = require('loopback'); - * var app = loopback(); - * ``` - * - * @property {string} version Version of LoopBack framework. Static read-only property. - * @property {string} mime - * @property {boolean} isBrowser True if running in a browser environment; false otherwise. Static read-only property. - * @property {boolean} isServer True if running in a server environment; false otherwise. Static read-only property. - * @property {Registry} registry The global `Registry` object. - * @property {string} faviconFile Path to a default favicon shipped with LoopBack. - * Use as follows: `app.use(require('serve-favicon')(loopback.faviconFile));` - * @class loopback - * @header loopback - */ + * LoopBack core module. It provides static properties and + * methods to create models and data sources. The module itself is a function + * that creates loopback `app`. For example: + * + * ```js + * var loopback = require('loopback'); + * var app = loopback(); + * ``` + * + * @property {string} version Version of LoopBack framework. Static read-only property. + * @property {string} mime + * @property {boolean} isBrowser True if running in a browser environment; false otherwise. Static read-only property. + * @property {boolean} isServer True if running in a server environment; false otherwise. Static read-only property. + * @property {Registry} registry The global `Registry` object. + * @property {string} faviconFile Path to a default favicon shipped with LoopBack. + * Use as follows: `app.use(require('serve-favicon')(loopback.faviconFile));` + * @class loopback + * @header loopback + */ class loopback { /** Version of LoopBack framework. Static read-only property. */ version: string; @@ -602,30 +602,30 @@ declare namespace l { constructor(context: Context); /** - * Add a principal to the context - * @param {string} principalType The principal type - * @param {*} principalId The principal id - * @param {string} [principalName] The principal name - * @returns {boolean} - */ + * Add a principal to the context + * @param {string} principalType The principal type + * @param {*} principalId The principal id + * @param {string} [principalName] The principal name + * @returns {boolean} + */ addPrincipal(principalType: string, principalId: any, principalName?: string): boolean; /** - * Get the user id - * @returns {*} - */ + * Get the user id + * @returns {*} + */ getUserId(): any; /** - * Get the application id - * @returns {*} - */ + * Get the application id + * @returns {*} + */ getAppId(): any; /** - * Check if the access context has authenticated principals - * @returns {boolean} - */ + * Check if the access context has authenticated principals + * @returns {boolean} + */ isAuthenticated(): boolean; } @@ -648,7 +648,7 @@ declare namespace l { principals: Principal[]; /** The model class */ - model: () => void; + model(): void; /** The model name */ modelName: string; @@ -1307,30 +1307,30 @@ declare namespace l { static replicate(since?: number, targetModel?: Model, options?: any, optionsFilter?: any, callback?: (err: Error, conflicts: Conflict[], param: any) => void): void; /** - * Update multiple instances that match the where clause. - * - * Example: - * - *```js - * Employee.updateAll({managerId: 'x001'}, {managerId: 'x002'}, function(err, info) { - * ... - * }); - * ``` - * - * @param {any} [where] Optional `where` filter, like - * ``` - * { key: val, key2: {gt: 'val2'}, ...} - * ``` - *
    see - * [Where filter](docs.strongloop.com/display/LB/Where+filter#Wherefilter-Whereclauseforothermethods). - * @param {any} data any containing data to replace matching instances, if any. - * - * @callback {() => void} callback Callback function called with `(err, info)` arguments. Required. - * @param {Error} err Error object; see [Error object](docs.strongloop.com/display/LB/Error+object). - * @param {any} info Additional information about the command outcome. - * @param {number} info.count number of instances (rows, documents) updated. - * - */ + * Update multiple instances that match the where clause. + * + * Example: + * + * ```js + * Employee.updateAll({managerId: 'x001'}, {managerId: 'x002'}, function(err, info) { + * ... + * }); + * ``` + * + * @param {any} [where] Optional `where` filter, like + * ``` + * { key: val, key2: {gt: 'val2'}, ...} + * ``` + *
    see + * [Where filter](docs.strongloop.com/display/LB/Where+filter#Wherefilter-Whereclauseforothermethods). + * @param {any} data any containing data to replace matching instances, if any. + * + * @callback {() => void} callback Callback function called with `(err, info)` arguments. Required. + * @param {Error} err Error object; see [Error object](docs.strongloop.com/display/LB/Error+object). + * @param {any} info Additional information about the command outcome. + * @param {number} info.count number of instances (rows, documents) updated. + * + */ static updateAll(where?: any, data?: any, callback?: (err: Error, info: any, infoCount: number) => void): void; /** @@ -1583,7 +1583,7 @@ declare namespace l { searchDefaultTokenKeys?: boolean, enableDoublecheck?: boolean, overwriteExistingToken?: boolean, - model?: () => void|string, + model?(): void|string, currentUserLiteral?: string }): void; @@ -1640,12 +1640,12 @@ declare namespace l { static findForRequest(req: any, options?: any, callback?: (err: Error, token: AccessToken) => void): void; /** - * Validate the token. - * - * @callback {() => void} callback - * @param {Error} err - * @param {boolean} isValid - */ + * Validate the token. + * + * @callback {() => void} callback + * @param {Error} err + * @param {boolean} isValid + */ validate(callback: (err: Error, isValid: boolean) => void): void; // **NOTE** Deprecate for 3.x @@ -1700,7 +1700,7 @@ declare namespace l { * - ALLOW: Explicitly grants access to the resource. * - AUDIT: Log, in a system-dependent way, the access specified in the permissions component of the ACL entry. * - DENY: Explicitly denies access to the resource. - */ + */ permission: 'ALARM' | 'ALLOW' | 'AUDIT' | 'DENY'; /** principalType Type of the principal; one of: Application, Use, Role. */ @@ -1877,7 +1877,7 @@ declare namespace l { * pushSettings.apns.feedbackOptions.batchFeedback (APNS). * pushSettings.apns.feedbackOptions.interval (APNS). * pushSettings.gcm.serverApiKey: Google Cloud Messaging API key. - */ + */ pushSetings: { apns: { production: boolean; @@ -1947,22 +1947,22 @@ declare namespace l { } /** - * Change list entry. - * - * @property {string} id Hash of the modelName and ID. - * @property {string} rev The current model revision. - * @property {string} prev The previous model revision. - * @property {number} checkpoint The current checkpoint at time of the change. - * @property {string} modelName Model name. - * @property {string} modelId Model ID. - * @property {any} settings Extends the `Model.settings` object. - * @property {string} settings.hashAlgorithm Algorithm used to create cryptographic hash, used as argument - * to [crypto.createHash](nodejs.org/api/crypto.html#crypto_crypto_createhash_algorithm). Default is sha1. - * @property {boolean} settings.ignoreErrors By default, when changes are rectified, an error will throw an exception. - * However, if this setting is true, then errors will not throw exceptions. - * @class Change - * @inherits {PersistedModel} - */ + * Change list entry. + * + * @property {string} id Hash of the modelName and ID. + * @property {string} rev The current model revision. + * @property {string} prev The previous model revision. + * @property {number} checkpoint The current checkpoint at time of the change. + * @property {string} modelName Model name. + * @property {string} modelId Model ID. + * @property {any} settings Extends the `Model.settings` object. + * @property {string} settings.hashAlgorithm Algorithm used to create cryptographic hash, used as argument + * to [crypto.createHash](nodejs.org/api/crypto.html#crypto_crypto_createhash_algorithm). Default is sha1. + * @property {boolean} settings.ignoreErrors By default, when changes are rectified, an error will throw an exception. + * However, if this setting is true, then errors will not throw exceptions. + * @class Change + * @inherits {PersistedModel} + */ class Change extends PersistedModel { /** Hash of the modelName and ID. */ id: string; @@ -1998,34 +1998,34 @@ declare namespace l { static bothDeleted(a: Change, b: Change): void; /** - * Determine the differences for a given model since a given checkpoint. - * - * The callback will contain an error or `result`. - * - * **result** - * - * ```js - * { - * deltas: Array, - * conflicts: Array - * } - * ``` - * - * **deltas** - * - * An Array of changes that differ from `remoteChanges`. - * - * **conflicts** - * - * An Array of changes that conflict with `remoteChanges`. - * - * @param {string} modelName - * @param {number} since Compare changes after this checkpoint - * @param {Change[]} remoteChanges A set of changes to compare - * @callback {() => void} callback - * @param {Error} err - * @param {any} result See above. - */ + * Determine the differences for a given model since a given checkpoint. + * + * The callback will contain an error or `result`. + * + * **result** + * + * ```js + * { + * deltas: Array, + * conflicts: Array + * } + * ``` + * + * **deltas** + * + * An Array of changes that differ from `remoteChanges`. + * + * **conflicts** + * + * An Array of changes that conflict with `remoteChanges`. + * + * @param {string} modelName + * @param {number} since Compare changes after this checkpoint + * @param {Change[]} remoteChanges A set of changes to compare + * @callback {() => void} callback + * @param {Error} err + * @param {any} result See above. + */ // static diff(modelName: string, since: number, remoteChanges: Change[], callback: (err: Error, result: any) => void): void; /** @@ -2278,8 +2278,8 @@ declare namespace l { static send(callback: () => void, options: { from: string; to: string; subject: string; text: string; html: string; }): void; /** - * A shortcut for Email.send(this). - */ + * A shortcut for Email.send(this). + */ send(): void; } @@ -2702,7 +2702,7 @@ declare namespace l { * @callback {() => void} cb The callback function * @param {string|Error} err The error string or object * @param {AccessToken} token The generated access token object - */ + */ createAccessToken(ttl: number, options?: any, cb?: (err: string|Error, token: AccessToken) => void): void; /** @@ -2745,7 +2745,7 @@ declare namespace l { * object, instead simply execute the callback with the token! User saving * and email sending will be handled in the `verify()` method */ - verify(options: {type: string, to: string, from: string, subject: string, text: string, template: string, redirect: string, generateVerificationToken: () => void}): void; + verify(options: {type: string, to: string, from: string, subject: string, text: string, template: string, redirect: string, generateVerificationToken(): void}): void; } } From 67b7f2ef0510422a55bfbeeac01ec47f49d0cc0f Mon Sep 17 00:00:00 2001 From: Jaakko Hannikainen Date: Thu, 6 Apr 2017 16:43:50 +0300 Subject: [PATCH 205/844] [react-intl] Inline types for formatMessage, formatHTMLMessage and FormattedMessage --- types/react-intl/index.d.ts | 14 +++----------- 1 file changed, 3 insertions(+), 11 deletions(-) diff --git a/types/react-intl/index.d.ts b/types/react-intl/index.d.ts index bbe1a49be5..44480deceb 100644 --- a/types/react-intl/index.d.ts +++ b/types/react-intl/index.d.ts @@ -10,14 +10,6 @@ declare namespace ReactIntl { - interface Values { - [key: string]: string | JSX.Element; - } - - interface HTMLValues { - [key: string]: string; - } - interface Locale { locale: string; fields?: { [key: string]: string }, @@ -74,8 +66,8 @@ declare namespace ReactIntl { formatRelative: (value: number, options?: FormattedRelative.PropsBase & { now?: any }) => string; formatNumber: (value: number, options?: FormattedNumber.PropsBase) => string; formatPlural: (value: number, options?: FormattedPlural.Base) => keyof FormattedPlural.PropsBase; - formatMessage: (messageDescriptor: FormattedMessage.MessageDescriptor, values?: Values) => string; - formatHTMLMessage: (messageDescriptor: FormattedMessage.MessageDescriptor, values?: HTMLValues) => string; + formatMessage: (messageDescriptor: FormattedMessage.MessageDescriptor, values?: {[key: string]: string}) => string; + formatHTMLMessage: (messageDescriptor: FormattedMessage.MessageDescriptor, values?: {[key: string]: string}) => string; locale: string; formats: any; messages: { [id: string]: string }; @@ -143,7 +135,7 @@ declare namespace ReactIntl { } export interface Props extends MessageDescriptor { - values?: Values; + values?: {[key: string]: string | JSX.Element}; tagName?: string; } } From 528386483d99c5477eca14b0fe16802257ba85e2 Mon Sep 17 00:00:00 2001 From: slozier Date: Thu, 6 Apr 2017 10:25:56 -0400 Subject: [PATCH 206/844] Add missing props to react-datepicker Used the following doc as reference: https://github.com/Hacker0x01/react-datepicker/blob/v0.40.0/docs/datepicker.md --- types/react-datepicker/index.d.ts | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/types/react-datepicker/index.d.ts b/types/react-datepicker/index.d.ts index 0cbe0ba202..467981c2fc 100644 --- a/types/react-datepicker/index.d.ts +++ b/types/react-datepicker/index.d.ts @@ -16,21 +16,28 @@ declare module "react-datepicker" { dateFormat?: string; dateFormatCalendar?: string; disabled?: boolean; + dropdownMode?: string; endDate?: moment.Moment; excludeDates?: any[]; filterDate?(): any; fixedHeight?: boolean; + forceShowMonthNavigation?: boolean; + highlightDates?: any[]; id?: string; includeDates?: any[]; + inline?: boolean; isClearable?: boolean; locale?: string; maxDate?: moment.Moment; minDate?: moment.Moment; + monthsShown?: number; name?: string; onBlur?(event: React.FocusEvent): void; onChange(date: moment.Moment | null, event: React.SyntheticEvent | undefined): any; onChangeRaw?(event: React.FocusEvent): void; onFocus?(event: React.FocusEvent): void; + onMonthChange?(date: moment.Moment): void; + openToDate?: moment.Moment; peekNextMonth?: boolean; placeholderText?: string; popoverAttachment?: string; From f928bfb3298d7395be9971dfa481a0567b1e6887 Mon Sep 17 00:00:00 2001 From: Fedor Nezhivoi Date: Wed, 5 Apr 2017 21:59:59 +0300 Subject: [PATCH 207/844] @types/react-native add myself to the list of maintainers --- types/react-native/index.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/types/react-native/index.d.ts b/types/react-native/index.d.ts index cb8b04f5e2..1a46a65f8d 100644 --- a/types/react-native/index.d.ts +++ b/types/react-native/index.d.ts @@ -1,6 +1,7 @@ // Type definitions for react-native 0.43 // Project: https://github.com/facebook/react-native // Definitions by: Eloy DurĂ¡n +// Fedor Nezhivoi // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.1 From 30a1873b906d4b345dfbbab12ab441d4d72ac562 Mon Sep 17 00:00:00 2001 From: Fedor Nezhivoi Date: Thu, 6 Apr 2017 18:22:18 +0300 Subject: [PATCH 208/844] @types/react-native-sortable-list fix alongside update in react-native types --- .../react-native-sortable-list-tests.tsx | 21 ++++++++++--------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/types/react-native-sortable-list/react-native-sortable-list-tests.tsx b/types/react-native-sortable-list/react-native-sortable-list-tests.tsx index 57a59b8d20..91be1dfed4 100644 --- a/types/react-native-sortable-list/react-native-sortable-list-tests.tsx +++ b/types/react-native-sortable-list/react-native-sortable-list-tests.tsx @@ -8,8 +8,9 @@ import { Image, View, Dimensions, - FlexJustifyType, - FlexAlignType + ViewStyle, + TextStyle, + ImageStyle, } from 'react-native'; import SortableList, {RowProps} from 'react-native-sortable-list'; @@ -61,20 +62,20 @@ const data = { const styles = StyleSheet.create({ container: { flex: 1, - justifyContent: "center" as FlexJustifyType, - alignItems: "center" as FlexAlignType, + justifyContent: 'center', + alignItems: 'center', backgroundColor: '#eee', paddingTop: 60, - }, + } as ViewStyle, list: { flex: 1, - }, + } as ViewStyle, contentContainer: { width: window.width, paddingHorizontal: 30, - }, + } as ViewStyle, row: { flexDirection: 'row', @@ -89,18 +90,18 @@ const styles = StyleSheet.create({ shadowOpacity: 1, shadowOffset: {height: 2, width: 2}, shadowRadius: 2, - }, + } as ViewStyle, image: { width: 60, height: 60, marginRight: 30, borderRadius: 30, - }, + } as ImageStyle, text: { fontSize: 24, - }, + } as TextStyle, }); From 2807934e210e051ac9d427369b738c1e7b5a2c2b Mon Sep 17 00:00:00 2001 From: Michael Gerakis Date: Thu, 6 Apr 2017 12:03:05 -0400 Subject: [PATCH 209/844] @types/graphlib Change setParent's second parameter to optional --- types/graphlib/graphlib-tests.ts | 1 + types/graphlib/index.d.ts | 5 +++-- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/types/graphlib/graphlib-tests.ts b/types/graphlib/graphlib-tests.ts index 114deef66a..d808f1ec2e 100644 --- a/types/graphlib/graphlib-tests.ts +++ b/types/graphlib/graphlib-tests.ts @@ -23,6 +23,7 @@ function test_graph() { g.setDefaultEdgeLabel(() => 'e42'); g.setNodes(['a', 'b', 'c'], 42); g.setParent('d', 'a'); + g.setParent('d'); g.parent('d'); g.children('a'); g.filterNodes(v => true); diff --git a/types/graphlib/index.d.ts b/types/graphlib/index.d.ts index 773cb621d1..1085e55f99 100644 --- a/types/graphlib/index.d.ts +++ b/types/graphlib/index.d.ts @@ -65,7 +65,8 @@ declare module "graphlib" { setNodes(names: string[], label?: any): Graph; /** - * Sets node p as a parent for node v. Method throws an exception in case of + * Sets node p as a parent for node v if it is defined, or removes the + * parent for v if p is undefined. Method throws an exception in case of * invoking it in context of noncompound graph. * Average-case complexity: O(1). * @@ -73,7 +74,7 @@ declare module "graphlib" { * @argument p - node to be parent for v. * @returns the graph, allowing this to be chained with other functions. */ - setParent(v: string, p: string): Graph; + setParent(v: string, p?: string): Graph; /** * Gets parent node for node v. From 40354debb1db20dd93f52ffe6394bb5a310109a1 Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Thu, 6 Apr 2017 09:13:07 -0700 Subject: [PATCH 210/844] Addressed small PR feedback Added back EOF endline; removed unnecessary parenthesis. --- types/chai/index.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/types/chai/index.d.ts b/types/chai/index.d.ts index 7444f5fd10..a040c43249 100644 --- a/types/chai/index.d.ts +++ b/types/chai/index.d.ts @@ -18,7 +18,7 @@ declare namespace Chai { /** * Provides a way to extend the internals of Chai */ - use(fn: (chai: (any), utils: any) => void): ChaiStatic; + use(fn: (chai: any, utils: any) => void): ChaiStatic; assert: AssertStatic; config: Config; AssertionError: typeof AssertionError; @@ -1249,4 +1249,4 @@ declare module "chai" { interface Object { should: Chai.Assertion; -} \ No newline at end of file +} From 4c0fd95396bb7c3ee7e4d312055650e756a29261 Mon Sep 17 00:00:00 2001 From: Michael Gerakis Date: Thu, 6 Apr 2017 12:24:07 -0400 Subject: [PATCH 211/844] Update spacing. --- types/graphlib/index.d.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/types/graphlib/index.d.ts b/types/graphlib/index.d.ts index 1085e55f99..3f35b82112 100644 --- a/types/graphlib/index.d.ts +++ b/types/graphlib/index.d.ts @@ -65,8 +65,8 @@ declare module "graphlib" { setNodes(names: string[], label?: any): Graph; /** - * Sets node p as a parent for node v if it is defined, or removes the - * parent for v if p is undefined. Method throws an exception in case of + * Sets node p as a parent for node v if it is defined, or removes the + * parent for v if p is undefined. Method throws an exception in case of * invoking it in context of noncompound graph. * Average-case complexity: O(1). * @@ -74,7 +74,7 @@ declare module "graphlib" { * @argument p - node to be parent for v. * @returns the graph, allowing this to be chained with other functions. */ - setParent(v: string, p?: string): Graph; + setParent(v: string, p?: string): Graph; /** * Gets parent node for node v. From 49e2699de4b18d5916fcf0192e99ec09ac8b3e92 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Guntars=20A=C5=A1manis-Graham?= Date: Thu, 6 Apr 2017 12:32:20 -0400 Subject: [PATCH 212/844] Add missing rgb() method --- types/color/index.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/types/color/index.d.ts b/types/color/index.d.ts index 83302cc38d..0b7b505c01 100644 --- a/types/color/index.d.ts +++ b/types/color/index.d.ts @@ -66,6 +66,7 @@ declare namespace Color { keyword(): string | undefined; hex(color: string): Color; hex(): string; + rgb(): Color; rgbNumber(): number; luminosity(): number; contrast(color: Color): number; From 95a2eddf3b91174b9d3e77263cc4c17654f68c85 Mon Sep 17 00:00:00 2001 From: Huy Nguyen Date: Thu, 6 Apr 2017 18:04:02 -0400 Subject: [PATCH 213/844] Fix definition of `isActive` prop to `NavLink` --- types/react-router-dom/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/react-router-dom/index.d.ts b/types/react-router-dom/index.d.ts index 6c480d46c0..ba0ae3bd88 100644 --- a/types/react-router-dom/index.d.ts +++ b/types/react-router-dom/index.d.ts @@ -50,7 +50,7 @@ declare module 'react-router-dom' { activeStyle?: React.CSSProperties; exact?: boolean; strict?: boolean; - isActive?(location: H.Location, props: any): boolean; + isActive?

    (match: match

    , location: H.Location): boolean; } class NavLink extends React.Component {} From b80da73f6385b943e0ad57ace25c06b87396f1a7 Mon Sep 17 00:00:00 2001 From: Huy Nguyen Date: Thu, 6 Apr 2017 18:04:28 -0400 Subject: [PATCH 214/844] Expose interface `NavLinkProps` Because it's useful in case one needs to build higher-order components that wrap `NavLink`. --- types/react-router-dom/index.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/types/react-router-dom/index.d.ts b/types/react-router-dom/index.d.ts index ba0ae3bd88..66e3a5dd98 100644 --- a/types/react-router-dom/index.d.ts +++ b/types/react-router-dom/index.d.ts @@ -58,6 +58,7 @@ declare module 'react-router-dom' { BrowserRouter, HashRouter, LinkProps, // TypeScript specific, not from React Router itself + NavLinkProps, // TypeScript specific, not from React Router itself Link, NavLink, Prompt, From 121342e1754ffd6dc229e2c0acc0cb66a6fd4497 Mon Sep 17 00:00:00 2001 From: Huy Nguyen Date: Thu, 6 Apr 2017 20:21:01 -0400 Subject: [PATCH 215/844] Add test --- .../react-router-dom-tests.tsx | 21 +++++++++++++++++++ types/react-router-dom/tsconfig.json | 3 ++- 2 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 types/react-router-dom/react-router-dom-tests.tsx diff --git a/types/react-router-dom/react-router-dom-tests.tsx b/types/react-router-dom/react-router-dom-tests.tsx new file mode 100644 index 0000000000..c748405580 --- /dev/null +++ b/types/react-router-dom/react-router-dom-tests.tsx @@ -0,0 +1,21 @@ +import * as React from 'react'; +import { + NavLink, + NavLinkProps, + match +} from 'react-router-dom'; +import * as H from 'history'; + +const getIsActive = (extraProp: string) => (match: match, location: H.Location) => !!extraProp; + +interface Props extends NavLinkProps { + extraProp: string; +} + +export default function(props: Props) { + const {extraProp, ...rest} = props; + const isActive = getIsActive(extraProp); + return ( + + ); +} diff --git a/types/react-router-dom/tsconfig.json b/types/react-router-dom/tsconfig.json index 41c143c1c6..744d583267 100644 --- a/types/react-router-dom/tsconfig.json +++ b/types/react-router-dom/tsconfig.json @@ -13,6 +13,7 @@ "noEmit": true }, "files": [ - "index.d.ts" + "index.d.ts", + "react-router-dom-tests.tsx" ] } From db665dd659b09c7818013e57edb303a18f8314d8 Mon Sep 17 00:00:00 2001 From: Michael Strobel Date: Fri, 7 Apr 2017 08:37:24 +0800 Subject: [PATCH 216/844] [webpack] Add resolve.symlinks --- types/webpack/index.d.ts | 7 +++++++ types/webpack/webpack-tests.ts | 1 + 2 files changed, 8 insertions(+) diff --git a/types/webpack/index.d.ts b/types/webpack/index.d.ts index dfdfb669a1..7ebb99b10c 100644 --- a/types/webpack/index.d.ts +++ b/types/webpack/index.d.ts @@ -263,6 +263,13 @@ declare namespace webpack { * Defaults to `() => true`. */ cachePredicate?(data: { path: string, request: string }): boolean; + + /** + * Whether to resolve symlinks to their symlinked location. + * + * Defaults to `true` + */ + symlinks?: boolean; } interface OldResolve { diff --git a/types/webpack/webpack-tests.ts b/types/webpack/webpack-tests.ts index d7c4b45007..e4afc33ccc 100644 --- a/types/webpack/webpack-tests.ts +++ b/types/webpack/webpack-tests.ts @@ -578,6 +578,7 @@ configuration = { }; const resolve: webpack.Resolve = { + symlinks: false, cachePredicate: 'boo' // why does this test _not_ fail!? }; From 87e6758d43ffcb303536b866f3401363a074f41b Mon Sep 17 00:00:00 2001 From: abirkholz Date: Fri, 7 Apr 2017 00:19:55 -0500 Subject: [PATCH 217/844] Add type for react-grid-layout --- types/react-grid-layout/index.d.ts | 110 ++++++++++++++++++ .../react-grid-layout-tests.tsx | 61 ++++++++++ types/react-grid-layout/tsconfig.json | 24 ++++ types/react-grid-layout/tslint.json | 1 + 4 files changed, 196 insertions(+) create mode 100644 types/react-grid-layout/index.d.ts create mode 100644 types/react-grid-layout/react-grid-layout-tests.tsx create mode 100644 types/react-grid-layout/tsconfig.json create mode 100644 types/react-grid-layout/tslint.json diff --git a/types/react-grid-layout/index.d.ts b/types/react-grid-layout/index.d.ts new file mode 100644 index 0000000000..5ece607aa5 --- /dev/null +++ b/types/react-grid-layout/index.d.ts @@ -0,0 +1,110 @@ +// Type definitions for react-grid-layout 0.14 +// Project: https://github.com/STRML/react-grid-layout +// Definitions by: Andrew Birkholz +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +import * as React from "react"; + +export as namespace ReactGridLayout; +export = ReactGridLayout; + +declare class ReactGridLayout extends React.Component { + constructor(props: any, context: any); + + componentDidMount(): void; + componentWillReceiveProps(nextProps: any): void; + containerHeight(): any; + onDrag(i: number, x: number, y: number, _ref2: any): void; + onDragStart(i: number, x: number, y: number, _ref: any): void; + onDragStop(i: number, x: number, y: number, _ref3: any): void; + onLayoutMaybeChanged(newLayout: any[], oldLayout: any[]): void; + onResize(i: number, w: number, h: number, _ref5: any): void; + onResizeStart(i: number, w: number, h: number, _ref4: any): void; + onResizeStop(i: number, w: number, h: number, _ref6: any): void; + placeholder(): any; + processGridItem(child: any): any; + render(): JSX.Element | null; + + static WidthProvider(ComposedComponent: any, ...args: any[]): any; + static displayName: string; +} + +declare namespace ReactGridLayout { + interface CoreProps { + autoSize?: boolean; + className?: string; + isDraggable?: boolean; + isResizable?: boolean; + layout?: any[]; + margin?: number[]; + maxRows?: number; + rowHeight?: number; + useCSSTransforms?: boolean; + verticalCompact?: boolean; + width?: number; + + onDrag?(layout: any, oldItem: any, newItem: any, placeholder: any, e: MouseEvent, element: HTMLElement): any; + onDragStart?(layout: any, oldItem: any, newItem: any, placeholder: any, e: MouseEvent, element: HTMLElement): any; + onDragStop?(layout: any, oldItem: any, newItem: any, placeholder: any, e: MouseEvent, element: HTMLElement): any; + onResize?(layout: any, oldItem: any, newItem: any, placeholder: any, e: MouseEvent, element: HTMLElement): any; + onResizeStart?(layout: any, oldItem: any, newItem: any, placeholder: any, e: MouseEvent, element: HTMLElement): any; + onResizeStop?(layout: any, oldItem: any, newItem: any, placeholder: any, e: MouseEvent, element: HTMLElement): any; + } + + interface DefaultProps extends CoreProps { + cols?: number; + onLayoutChange?(layout: any): any; + } + + interface ResponsiveProps extends CoreProps { + breakpoints: {lg: number, md: number, sm: number, xs: number, xxs: number}; + cols: {lg: number, md: number, sm: number, xs: number, xxs: number}; + layouts?: {}; + + onBreakpointChange?(newBreakpoint: string, newCols: number): any; + onLayoutChange?(currentLayout: any, allLayouts: any): any; + onWidthChange?(containerWidth: number, margin: [number, number], cols: number, containerPadding: [number, number]): any; + } + + class Responsive extends React.Component { + constructor(...args: any[]); + + componentWillReceiveProps(nextProps: any): void; + generateInitialState(): any; + onWidthChange(nextProps: any): void; + render(): JSX.Element | null; + } + + namespace Responsive { + namespace utils { + function findOrGenerateResponsiveLayout(layouts: {}, breakpoints: {}, breakpoint: number, lastBreakpoint: number, cols: {}, verticalCompact: boolean): any; + function getBreakpointFromWidth(breakpoints: {}, width: number): any; + function getColsFromBreakpoint(breakpoint: number, cols: {}): any; + function sortBreakpoints(breakpoints: {}): any; + } + } + + namespace utils { + function autoBindHandlers(el: any, fns: any): any; + function bottom(layout: any): any; + function childrenEqual(a: any, b: any): any; + function cloneLayout(layout: any): any; + function cloneLayoutItem(layoutItem: any): any; + function collides(l1: any, l2: any): any; + function compact(layout: any, verticalCompact: any): any; + function compactItem(compareWith: any, l: any, verticalCompact: any): any; + function correctBounds(layout: any, bounds: any): any; + function getAllCollisions(layout: any, layoutItem: any): any; + function getFirstCollision(layout: any, layoutItem: any): any; + function getLayoutItem(layout: any, id: any): any; + function getStatics(layout: any): any; + function moveElement(layout: any, l: any, x: any, y: any, isUserAction: any): any; + function moveElementAwayFromCollision(layout: any, collidesWith: any, itemToMove: any, isUserAction: any): any; + function perc(num: any): any; + function setTopLeft(_ref2: any): any; + function setTransform(_ref: any): any; + function sortLayoutItemsByRowCol(layout: any): any; + function synchronizeLayoutWithChildren(initialLayout: any, children: any, cols: any, verticalCompact: any): any; + function validateLayout(layout: any, contextName: any): void; + } +} diff --git a/types/react-grid-layout/react-grid-layout-tests.tsx b/types/react-grid-layout/react-grid-layout-tests.tsx new file mode 100644 index 0000000000..90c716e7f6 --- /dev/null +++ b/types/react-grid-layout/react-grid-layout-tests.tsx @@ -0,0 +1,61 @@ +import * as React from 'react'; +import * as ReactGridLayout from 'react-grid-layout'; + +const ReactGridLayoutResponsive = ReactGridLayout.Responsive; +const ReactGridLayoutResponsiveWidth = ReactGridLayout.WidthProvider(ReactGridLayout.Responsive); + +class DefaultGridTest extends React.Component { + render() { + const layout = [ + {i: 'a', x: 0, y: 0, w: 1, h: 2, static: true}, + {i: 'b', x: 1, y: 0, w: 3, h: 2, minW: 2, maxW: 4}, + {i: 'c', x: 4, y: 0, w: 1, h: 2} + ]; + + return ( + +

    a
    +
    b
    +
    c
    + + ); + } +} + +class ResponsiveGridTest extends React.Component { + render() { + return ( + +
    a
    +
    b
    +
    c
    +     + ); + } +} + +class ResponsiveGridWidthProviderTest extends React.Component { + render() { + return ( + +
    a
    +
    b
    +
    c
    +     + ); + } +} diff --git a/types/react-grid-layout/tsconfig.json b/types/react-grid-layout/tsconfig.json new file mode 100644 index 0000000000..89ece1c775 --- /dev/null +++ b/types/react-grid-layout/tsconfig.json @@ -0,0 +1,24 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6", + "dom" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "jsx": "react" + }, + "files": [ + "index.d.ts", + "react-grid-layout-tests.tsx" + ] +} \ No newline at end of file diff --git a/types/react-grid-layout/tslint.json b/types/react-grid-layout/tslint.json new file mode 100644 index 0000000000..377cc837d4 --- /dev/null +++ b/types/react-grid-layout/tslint.json @@ -0,0 +1 @@ +{ "extends": "../tslint.json" } From c0c58b9f3696e60e9de9013278ed3e5c59bcfaff Mon Sep 17 00:00:00 2001 From: huhuanming Date: Fri, 7 Apr 2017 14:20:07 +0800 Subject: [PATCH 218/844] Add ShallowRendererProps Into ShallowWrapper's shallow Fn --- types/enzyme/index.d.ts | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/types/enzyme/index.d.ts b/types/enzyme/index.d.ts index c6e78fda11..9ea4264ef2 100644 --- a/types/enzyme/index.d.ts +++ b/types/enzyme/index.d.ts @@ -1,10 +1,11 @@ -// Type definitions for Enzyme 2.7 +// Type definitions for Enzyme 2.7.1 // Project: https://github.com/airbnb/enzyme // Definitions by: Marian Palkus // Cap3 // Ivo Stratev // Tom Crockett -// jwbay +// jwbay +// huhuanming // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.1 @@ -340,7 +341,7 @@ interface CommonWrapper { } export interface ShallowWrapper extends CommonWrapper { - shallow(): ShallowWrapper; + shallow(options?: ShallowRendererProps): ShallowWrapper; unmount(): ShallowWrapper; /** From 5e44abdab6edb1ea5d9a19d2ce0141366bfcddc9 Mon Sep 17 00:00:00 2001 From: Syncfusion-JavaScript Date: Fri, 7 Apr 2017 11:55:50 +0530 Subject: [PATCH 219/844] lint errors have been resolved --- types/ej.web.all/index.d.ts | 117623 +++++++++++++++++---------------- 1 file changed, 58813 insertions(+), 58810 deletions(-) diff --git a/types/ej.web.all/index.d.ts b/types/ej.web.all/index.d.ts index 49c60d8a3b..0a715f52bf 100644 --- a/types/ej.web.all/index.d.ts +++ b/types/ej.web.all/index.d.ts @@ -16,123 +16,123 @@ */ declare namespace ej { const dataUtil: dataUtil; - function isMobile(): boolean; - function isIOS(): boolean; - function isAndroid(): boolean; - function isFlat(): boolean; - function isWindows(): boolean; - function isCssCalc(): boolean; - function getCurrentPage(): JQuery; - function isLowerResolution(): boolean; - function browserInfo(): browserInfoOptions; - function isTouchDevice(): boolean; - function addPrefix(style: string): string; - function animationEndEvent(): string; - function blockDefaultActions(e: any): void; - function buildTag(tag: string, innerHtml?: string, styles?: any, attrs?: any): JQuery; - function cancelEvent(): string; - function copyObject(): string; - function createObject(nameSpace: string, value: any, initIn: any): JQuery; - function createObject(element: any, eventEmitter: any, model: any): any; - function setCulture(culture: string): void; - function getObject(element: string, model: any ): T; - function getObject(nameSpace: string, fromdata?: any): any; - function defineClass(className: string, constructor: any, proto: any, replace: boolean): any; - function destroyWidgets(element: any): void; - function endEvent(): string; - function event(type: string, data: any, eventProp: any): any; - function getAndroidVersion(): any; - function getAttrVal(ele: any, val: string, option: any): any; - function getBooleanVal(ele: any, val: string, option: any): any; - function getClearString(): string; - function getDimension(element: any, method: string): any; - function getFontString(fontObj: any): string; - function getFontStyle(style: string): string; - function getMaxZindex(): number; - function getNameSpace(className: string): string; - function getOffset(ele: string): any; - function getRenderMode(): string; - function getScrollableParents(element: any): void; - function getTheme(): string; - function getZindexPartial(element: any, popupEle: string): number; - function hasRenderMode(element: string): void; - function hasStyle(prop: string): boolean; - function hasTheme(element: string): string; - function hexFromRGB(color: string): string; - function ieClearRemover(element: string): void; - function isAndroidWebView(): string; - function isDevice(): boolean; - function isIOS7(): boolean; - function isIOSWebView(): boolean; - function isLowerAndroid(): boolean; - function isNullOrUndefined(value: any): boolean; - function isPlainObject(): JQuery; - function isPortrait(): any; - function isTablet(): boolean; - function isWindowsWebView(): string; - function listenEvents(selectors: any, eventTypes: any, handlers: any, remove?: any, pluginObj?: any, disableMouse?: boolean): void; - function listenTouchEvent(selectors: any, eventTypes: any, handlers: any, remove?: any, pluginObj?: any, disableMouse?: boolean): void; - function logBase(val: string, base: string): number; - function measureText(text: string, maxwidth: number, font: string): string; - function moveEvent(): string; - function print(element: string, printWindow: any): void; - function proxy(fn: any, context?: string, arg?: string): any; - function round(value: string, div: string, up: string): any; - function sendAjaxRequest(ajaxOptions: any): void; - function setCaretToPos(nput: string, pos1: string, pos2: string): void; - function setRenderMode(element: string): void; - function setTheme(): any; - function startEvent(): string; - function tapEvent(): string; - function tapHoldEvent(): string; - function throwError(): any; - function transitionEndEvent(): any; - function userAgent(): boolean; - function widget(pluginName: string, className: string, proto: any): any; - function avg(json: any, filedName: string): any; - function getGuid(prefix: string): number; - function group(jsonArray: any, field: string, agg: string, level: number, groupDs: string): any; - function isJson(jsonData: string): string; - function max(jsonArray: any, fieldName?: string, comparer?: string): any; - function min(jsonArray: any, fieldName: string, comparer: string): any; - function merge(first: string, second: string): any; - function mergeshort(jsonArray: any, fieldName: string, comparer: string): any; - function parseJson(jsonText: string): string; - function parseTable(table: number, headerOption: string, headerRowIndex: string): any; - function select(jsonArray: any, fields: string): any; - function setTransition(): boolean; - function sum(json: string, fieldName: string): string; - function swap(array: any, x: string, y: string): any; - const cssUA: string; - const serverTimezoneOffset: number; - const transform: string; - const transformOrigin: string; - const transformStyle: string; - const transition: string; - const transitionDelay: string; - const transitionDuration: string; - const transitionProperty: string; - const transitionTimingFunction: string; + function isMobile(): boolean; + function isIOS(): boolean; + function isAndroid(): boolean; + function isFlat(): boolean; + function isWindows(): boolean; + function isCssCalc(): boolean; + function getCurrentPage(): JQuery; + function isLowerResolution(): boolean; + function browserInfo(): browserInfoOptions; + function isTouchDevice(): boolean; + function addPrefix(style: string): string; + function animationEndEvent(): string; + function blockDefaultActions(e: any): void; + function buildTag(tag: string, innerHtml?: string, styles?: any, attrs?: any): JQuery; + function cancelEvent(): string; + function copyObject(): string; + function createObject(nameSpace: string, value: any, initIn: any): JQuery; + function createObject(element: any, eventEmitter: any, model: any): any; + function setCulture(culture: string): void; + function getObject(element: string, model: any): T; + function getObject(nameSpace: string, fromdata?: any): any; + function defineClass(className: string, constructor: any, proto: any, replace: boolean): any; + function destroyWidgets(element: any): void; + function endEvent(): string; + function event(type: string, data: any, eventProp: any): any; + function getAndroidVersion(): any; + function getAttrVal(ele: any, val: string, option: any): any; + function getBooleanVal(ele: any, val: string, option: any): any; + function getClearString(): string; + function getDimension(element: any, method: string): any; + function getFontString(fontObj: any): string; + function getFontStyle(style: string): string; + function getMaxZindex(): number; + function getNameSpace(className: string): string; + function getOffset(ele: string): any; + function getRenderMode(): string; + function getScrollableParents(element: any): void; + function getTheme(): string; + function getZindexPartial(element: any, popupEle: string): number; + function hasRenderMode(element: string): void; + function hasStyle(prop: string): boolean; + function hasTheme(element: string): string; + function hexFromRGB(color: string): string; + function ieClearRemover(element: string): void; + function isAndroidWebView(): string; + function isDevice(): boolean; + function isIOS7(): boolean; + function isIOSWebView(): boolean; + function isLowerAndroid(): boolean; + function isNullOrUndefined(value: any): boolean; + function isPlainObject(): JQuery; + function isPortrait(): any; + function isTablet(): boolean; + function isWindowsWebView(): string; + function listenEvents(selectors: any, eventTypes: any, handlers: any, remove?: any, pluginObj?: any, disableMouse?: boolean): void; + function listenTouchEvent(selectors: any, eventTypes: any, handlers: any, remove?: any, pluginObj?: any, disableMouse?: boolean): void; + function logBase(val: string, base: string): number; + function measureText(text: string, maxwidth: number, font: string): string; + function moveEvent(): string; + function print(element: string, printWindow: any): void; + function proxy(fn: any, context?: string, arg?: string): any; + function round(value: string, div: string, up: string): any; + function sendAjaxRequest(ajaxOptions: any): void; + function setCaretToPos(nput: string, pos1: string, pos2: string): void; + function setRenderMode(element: string): void; + function setTheme(): any; + function startEvent(): string; + function tapEvent(): string; + function tapHoldEvent(): string; + function throwError(): any; + function transitionEndEvent(): any; + function userAgent(): boolean; + function widget(pluginName: string, className: string, proto: any): any; + function avg(json: any, filedName: string): any; + function getGuid(prefix: string): number; + function group(jsonArray: any, field: string, agg: string, level: number, groupDs: string): any; + function isJson(jsonData: string): string; + function max(jsonArray: any, fieldName?: string, comparer?: string): any; + function min(jsonArray: any, fieldName: string, comparer: string): any; + function merge(first: string, second: string): any; + function mergeshort(jsonArray: any, fieldName: string, comparer: string): any; + function parseJson(jsonText: string): string; + function parseTable(table: number, headerOption: string, headerRowIndex: string): any; + function select(jsonArray: any, fields: string): any; + function setTransition(): boolean; + function sum(json: string, fieldName: string): string; + function swap(array: any, x: string, y: string): any; + const cssUA: string; + const serverTimezoneOffset: number; + const transform: string; + const transformOrigin: string; + const transformStyle: string; + const transition: string; + const transitionDelay: string; + const transitionDuration: string; + const transitionProperty: string; + const transitionTimingFunction: string; const template: any; const util: { - valueFunction(val: string): any; - }; - export namespace device { - function isAndroid(): boolean; - function isIOS(): boolean; - function isFlat(): boolean; - function isIOS7(): boolean; - function isWindows(): boolean; - } - export namespace widget { - const autoInit: boolean; - const registeredInstances: any[]; - const registeredWidgets: any[]; - function register(pluginName: string, className: string, prototype: any): void; - function destroyAll(elements: Element): void; - function init(element: Element): void; - function registerInstance(element: Element, pluginName: string, className: string, prototype: any): void; - } + valueFunction(val: string): any; + }; + export namespace device { + function isAndroid(): boolean; + function isIOS(): boolean; + function isFlat(): boolean; + function isIOS7(): boolean; + function isWindows(): boolean; + } + export namespace widget { + const autoInit: boolean; + const registeredInstances: any[]; + const registeredWidgets: any[]; + function register(pluginName: string, className: string, prototype: any): void; + function destroyAll(elements: Element): void; + function init(element: Element): void; + function registerInstance(element: Element, pluginName: string, className: string, prototype: any): void; + } interface browserInfoOptions { name: string; version: string; @@ -140,302 +140,302 @@ declare namespace ej { isMSPointerEnabled: boolean; } class WidgetBase { - destroy(): void; - element: JQuery; - setModel(options: any, forceSet?: boolean): any; - option(prop?: any, value?: any, forceSet?: boolean): any; + destroy(): void; + element: JQuery; + setModel(options: any, forceSet?: boolean): any; + option(prop?: any, value?: any, forceSet?: boolean): any; _trigger(eventName?: string, eventProp?: any): any; - _on(element: JQuery, eventType?: string, handler?: (eventObject: JQueryEventObject) => any): any; - _on(element: JQuery, eventType ?: string, selector ?: string, handler ?: (eventObject: JQueryEventObject) => any): any; - _off(element: JQuery, eventName: string, handler ?: (eventObject: JQueryEventObject) => any): any; - _off(element: JQuery, eventType ?: string, selector ?: string, handler ?: (eventObject: JQueryEventObject) => any): any; - persistState(): void; - restoreState(silent: boolean): void; - } + _on(element: JQuery, eventType?: string, handler?: (eventObject: JQueryEventObject) => any): any; + _on(element: JQuery, eventType?: string, selector?: string, handler?: (eventObject: JQueryEventObject) => any): any; + _off(element: JQuery, eventName: string, handler?: (eventObject: JQueryEventObject) => any): any; + _off(element: JQuery, eventType?: string, selector?: string, handler?: (eventObject: JQueryEventObject) => any): any; + persistState(): void; + restoreState(silent: boolean): void; + } - class Widget extends WidgetBase { - constructor(pluginName: string, className: string, proto: any); - static fn: Widget; - static extend(widget: Widget): any; - register(pluginName: string, className: string, prototype: any): void; - destroyAll(elements: Element): void; - model: any; - } + class Widget extends WidgetBase { + constructor(pluginName: string, className: string, proto: any); + static fn: Widget; + static extend(widget: Widget): any; + register(pluginName: string, className: string, prototype: any): void; + destroyAll(elements: Element): void; + model: any; + } - interface BaseEvent { - cancel: boolean; - type: string; - } - class DataManager { - constructor(dataSource?: any, query?: ej.Query, adaptor?: any); - setDefaultQuery(query: ej.Query): void; - executeQuery(query?: ej.Query, done?: any, fail?: any, always?: any): JQueryPromise; - executeLocal(query?: ej.Query): ej.DataManager; - saveChanges(changes?: Changes, key?: string, tableName?: string): JQueryDeferred; - insert(data: any, tableName?: string): JQueryPromise; - remove(keyField: string, value: any, tableName?: string): any; - update(keyField: string, value: any, tableName?: string): any; - } + interface BaseEvent { + cancel: boolean; + type: string; + } + class DataManager { + constructor(dataSource?: any, query?: ej.Query, adaptor?: any); + setDefaultQuery(query: ej.Query): void; + executeQuery(query?: ej.Query, done?: any, fail?: any, always?: any): JQueryPromise; + executeLocal(query?: ej.Query): ej.DataManager; + saveChanges(changes?: Changes, key?: string, tableName?: string): JQueryDeferred; + insert(data: any, tableName?: string): JQueryPromise; + remove(keyField: string, value: any, tableName?: string): any; + update(keyField: string, value: any, tableName?: string): any; + } - class Query { - constructor(); - static fn: Query; - static extend(prototype: any): Query; - key(field: string): ej.Query; - using(dataManager: ej.DataManager): ej.Query; - execute(dataManager: ej.DataManager, done: any, fail?: string, always?: string): any; - executeLocal(dataManager: ej.DataManager): ej.DataManager; - clone(): ej.Query; - from(tableName: any): ej.Query; - addParams(key: string, value: string): ej.Query; - expand(tables: any): ej.Query; - where(fieldName: string, operator: ej.FilterOperators, value: any, ignoreCase?: boolean): ej.Query; + class Query { + constructor(); + static fn: Query; + static extend(prototype: any): Query; + key(field: string): ej.Query; + using(dataManager: ej.DataManager): ej.Query; + execute(dataManager: ej.DataManager, done: any, fail?: string, always?: string): any; + executeLocal(dataManager: ej.DataManager): ej.DataManager; + clone(): ej.Query; + from(tableName: any): ej.Query; + addParams(key: string, value: string): ej.Query; + expand(tables: any): ej.Query; + where(fieldName: string, operator: ej.FilterOperators, value: any, ignoreCase?: boolean): ej.Query; where(predicate: ej.Predicate): ej.Query; - search(searchKey: any, fieldNames?: any, operator?: string, ignoreCase?: boolean): ej.Query; - sortBy(fieldName: string, comparer?: ej.SortOrder, isFromGroup?: boolean): ej.Query; - sortByDesc(fieldName: string): ej.Query; - group(fieldName: string): ej.Query; - page(pageIndex: number, pageSize: number): ej.Query; - take(nos: number): ej.Query; - skip(nos: number): ej.Query; - select(fieldNames: any): ej.Query; - hierarchy(query: ej.Query, selectorFn: any): ej.Query; - foreignKey(key: string): ej.Query; - requiresCount(): ej.Query; - range(start: number, end: number): ej.Query; - } + search(searchKey: any, fieldNames?: any, operator?: string, ignoreCase?: boolean): ej.Query; + sortBy(fieldName: string, comparer?: ej.SortOrder, isFromGroup?: boolean): ej.Query; + sortByDesc(fieldName: string): ej.Query; + group(fieldName: string): ej.Query; + page(pageIndex: number, pageSize: number): ej.Query; + take(nos: number): ej.Query; + skip(nos: number): ej.Query; + select(fieldNames: any): ej.Query; + hierarchy(query: ej.Query, selectorFn: any): ej.Query; + foreignKey(key: string): ej.Query; + requiresCount(): ej.Query; + range(start: number, end: number): ej.Query; + } - class Adaptor { - constructor(ds: any); - pvt: any; - type: ej.Adaptor; - options: AdaptorOptions; - extend(overrides: any): ej.Adaptor; - processQuery(dm: ej.DataManager, query: ej.Query): any; - processResponse(data: any, ds: any, query: ej.Query, xhr: JQueryXHR, request?: any, changes?: Changes): any; - convertToQueryString(req: any, query: ej.Query, dm: ej.DataManager): JQueryParam; - } + class Adaptor { + constructor(ds: any); + pvt: any; + type: ej.Adaptor; + options: AdaptorOptions; + extend(overrides: any): ej.Adaptor; + processQuery(dm: ej.DataManager, query: ej.Query): any; + processResponse(data: any, ds: any, query: ej.Query, xhr: JQueryXHR, request?: any, changes?: Changes): any; + convertToQueryString(req: any, query: ej.Query, dm: ej.DataManager): JQueryParam; + } - interface AdaptorOptions { - from?: string; - requestType?: string; - sortBy?: string; - select?: string; - skip?: string; - group?: string; - take?: string; - search?: string; - count?: string; - where?: string; - aggregates?: string; - } + interface AdaptorOptions { + from?: string; + requestType?: string; + sortBy?: string; + select?: string; + skip?: string; + group?: string; + take?: string; + search?: string; + count?: string; + where?: string; + aggregates?: string; + } - class UrlAdaptor extends ej.Adaptor { - constructor(); - processQuery(dm: ej.DataManager, query: ej.Query, hierarchyFilters?: any): { - type: string; url: string; ejPvtData: any; contentType?: string; data?: any; - } - convertToQueryString(req: any, query: ej.Query, dm: ej.DataManager): JQueryParam; - processResponse(data: any, ds: any, query: ej.Query, xhr: JQueryXHR, request?: any, changes?: Changes): any; - onGroup(e: any): void; - batchRequest(dm: ej.DataManager, changes: Changes, e: any): void; - beforeSend(dm: ej.DataManager, request: any, settings?: any): void; - insert(dm: ej.DataManager, data: any, tableName: string): { url: string; data: any }; - remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data?: any }; - update(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data: any }; - getFiltersFrom(data: any, query: ej.Query): ej.Predicate; - } + class UrlAdaptor extends ej.Adaptor { + constructor(); + processQuery(dm: ej.DataManager, query: ej.Query, hierarchyFilters?: any): { + type: string; url: string; ejPvtData: any; contentType?: string; data?: any; + }; + convertToQueryString(req: any, query: ej.Query, dm: ej.DataManager): JQueryParam; + processResponse(data: any, ds: any, query: ej.Query, xhr: JQueryXHR, request?: any, changes?: Changes): any; + onGroup(e: any): void; + batchRequest(dm: ej.DataManager, changes: Changes, e: any): void; + beforeSend(dm: ej.DataManager, request: any, settings?: any): void; + insert(dm: ej.DataManager, data: any, tableName: string): { url: string; data: any }; + remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data?: any }; + update(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data: any }; + getFiltersFrom(data: any, query: ej.Query): ej.Predicate; + } - class ODataAdaptor extends ej.UrlAdaptor { - constructor(); - options: UrlAdaptorOptions; - onEachWhere(filter: any, requiresCast: boolean): any; - onPredicate(pred: ej.Predicate, query: ej.Query, requiresCast: boolean): string; - onComplexPredicate(pred: ej.Predicate, requiresCast: boolean): string; - onWhere(filters: string[]): string; - onEachSearch(e: any): void; - onSearch(e: any): string; - onEachSort(e: any): string; - onSortBy(e: any): string; - onGroup(e: any): string; - onSelect(e: any): string; - onCount(e: any): string; - beforeSend(dm: ej.DataManager, request: any, settings?: any): void; - processResponse(data: any, ds: any, query: ej.Query, xhr: any, request: any, changes: Changes): { - result: any; count: number - }; - convertToQueryString(req: any, query: ej.Query, dm: ej.DataManager): JQueryParam; - insert(dm: ej.DataManager, data: any, tableName: string): { url: string; data: any; } - remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): { url: string; type: string; } - update(dm: ej.DataManager, keyField: string, value: any, tableName: string): { url: string; type: string; data: any; accept: string; } - batchRequest(dm: ej.DataManager, changes: Changes, e: any): { url: string; type: string; data: any; contentType: string; } - generateDeleteRequest(arr: any[], e: any): string; - generateInsertRequest(arr: any[], e: any): string; - generateUpdateRequest(arr: any[], e: any): string; - } - interface UrlAdaptorOptions { - requestType?: string; - accept?: string; - multipartAccept?: string; - sortBy?: string; - select?: string; - skip?: string; - take?: string; - count?: string; - where?: string; - expand?: string; - batch?: string; - changeSet?: string; - batchPre?: string; - contentId?: string; - batchContent?: string; - changeSetContent?: string; - batchChangeSetContentType?: string; - } + class ODataAdaptor extends ej.UrlAdaptor { + constructor(); + options: UrlAdaptorOptions; + onEachWhere(filter: any, requiresCast: boolean): any; + onPredicate(pred: ej.Predicate, query: ej.Query, requiresCast: boolean): string; + onComplexPredicate(pred: ej.Predicate, requiresCast: boolean): string; + onWhere(filters: string[]): string; + onEachSearch(e: any): void; + onSearch(e: any): string; + onEachSort(e: any): string; + onSortBy(e: any): string; + onGroup(e: any): string; + onSelect(e: any): string; + onCount(e: any): string; + beforeSend(dm: ej.DataManager, request: any, settings?: any): void; + processResponse(data: any, ds: any, query: ej.Query, xhr: any, request: any, changes: Changes): { + result: any; count: number + }; + convertToQueryString(req: any, query: ej.Query, dm: ej.DataManager): JQueryParam; + insert(dm: ej.DataManager, data: any, tableName: string): { url: string; data: any; }; + remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): { url: string; type: string; }; + update(dm: ej.DataManager, keyField: string, value: any, tableName: string): { url: string; type: string; data: any; accept: string; }; + batchRequest(dm: ej.DataManager, changes: Changes, e: any): { url: string; type: string; data: any; contentType: string; }; + generateDeleteRequest(arr: any[], e: any): string; + generateInsertRequest(arr: any[], e: any): string; + generateUpdateRequest(arr: any[], e: any): string; + } + interface UrlAdaptorOptions { + requestType?: string; + accept?: string; + multipartAccept?: string; + sortBy?: string; + select?: string; + skip?: string; + take?: string; + count?: string; + where?: string; + expand?: string; + batch?: string; + changeSet?: string; + batchPre?: string; + contentId?: string; + batchContent?: string; + changeSetContent?: string; + batchChangeSetContentType?: string; + } class WebApiAdaptor extends ej.ODataAdaptor { - constructor(); - insert(dm: ej.DataManager, data: any, tableName?: string): { url: string; type: string; data: any; } - remove(dm: ej.DataManager, value: any, keyField?: string, tableName?: string): { url: string; type: string; data: any; } - update(dm: ej.DataManager, value: any, keyField?: string, tableName?: string): { url: string; type: string; data: any; accept: string; } - processResponse(data: any, ds: any, query: ej.Query, xhr: any, request: any, changes: Changes): { - result: any; count: number - }; - } - class ODataV4Adaptor extends ej.ODataAdaptor { - constructor(); - options: ODataAdaptorOptions; - onCount(e: any): string; - onEachSearch(e: any): void; - onSearch(e: any): string; - beforeSend(dm: ej.DataManager, request: any, settings?: any): void; - processResponse(data: any, ds: any, query: ej.Query, xhr: any, request: any, changes: Changes): { - result: any; count: number - }; - } - interface ODataAdaptorOptions { - requestType?: string; - accept?: string; - multipartAccept?: string; - sortBy?: string; - select?: string; - skip?: string; - take?: string; - count?: string; - search?: string; - where?: string; - expand?: string; - batch?: string; - changeSet?: string; - batchPre?: string; - contentId?: string; - batchContent?: string; - changeSetContent?: string; - batchChangeSetContentType?: string; - } + constructor(); + insert(dm: ej.DataManager, data: any, tableName?: string): { url: string; type: string; data: any; }; + remove(dm: ej.DataManager, value: any, keyField?: string, tableName?: string): { url: string; type: string; data: any; }; + update(dm: ej.DataManager, value: any, keyField?: string, tableName?: string): { url: string; type: string; data: any; accept: string; }; + processResponse(data: any, ds: any, query: ej.Query, xhr: any, request: any, changes: Changes): { + result: any; count: number + }; + } + class ODataV4Adaptor extends ej.ODataAdaptor { + constructor(); + options: ODataAdaptorOptions; + onCount(e: any): string; + onEachSearch(e: any): void; + onSearch(e: any): string; + beforeSend(dm: ej.DataManager, request: any, settings?: any): void; + processResponse(data: any, ds: any, query: ej.Query, xhr: any, request: any, changes: Changes): { + result: any; count: number + }; + } + interface ODataAdaptorOptions { + requestType?: string; + accept?: string; + multipartAccept?: string; + sortBy?: string; + select?: string; + skip?: string; + take?: string; + count?: string; + search?: string; + where?: string; + expand?: string; + batch?: string; + changeSet?: string; + batchPre?: string; + contentId?: string; + batchContent?: string; + changeSetContent?: string; + batchChangeSetContentType?: string; + } - class JsonAdaptor extends ej.Adaptor { - constructor(); - processQuery(ds: any, query: ej.Query): string; - batchRequest(dm: ej.DataManager, changes: Changes, e: any): Changes; - onWhere(ds: any, e: any): any; - onSearch(ds: any, e: any): any - onSortBy(ds: any, e: any, query: ej.Query): any; - onGroup(ds: any, e: any, query: ej.Query): any; - onPage(ds: any, e: any, query: ej.Query): any; - onRange(ds: any, e: any): any; - onTake(ds: any, e: any): any; - onSkip(ds: any, e: any): any; - onSelect(ds: any, e: any): any; - insert(dm: ej.DataManager, data: any): any; - remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): any; - update(dm: ej.DataManager, keyField: string, value: any, tableName: string): any; - } + class JsonAdaptor extends ej.Adaptor { + constructor(); + processQuery(ds: any, query: ej.Query): string; + batchRequest(dm: ej.DataManager, changes: Changes, e: any): Changes; + onWhere(ds: any, e: any): any; + onSearch(ds: any, e: any): any; + onSortBy(ds: any, e: any, query: ej.Query): any; + onGroup(ds: any, e: any, query: ej.Query): any; + onPage(ds: any, e: any, query: ej.Query): any; + onRange(ds: any, e: any): any; + onTake(ds: any, e: any): any; + onSkip(ds: any, e: any): any; + onSelect(ds: any, e: any): any; + insert(dm: ej.DataManager, data: any): any; + remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): any; + update(dm: ej.DataManager, keyField: string, value: any, tableName: string): any; + } class remoteSaveAdaptor extends ej.UrlAdaptor { - constructor(); - batchRequest(dm: ej.DataManager, changes: Changes, e: any): void; - beforeSend(dm: ej.DataManager, request: any, settings?: any): void; - insert(dm: ej.DataManager, data: any, tableName: string): { url: string; data: any }; - remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data?: any }; - update(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data: any }; - } - class TableModel { - constructor(name: string, jsonArray: any[], dataManager: ej.DataManager, modelComputed: any); - on(eventName: string, handler: any): void; - off(eventName: string, handler: any): void; - setDataManager(dataManager: DataManager): void; - saveChanges(): void; - rejectChanges(): void; - insert(json: any): void; - update(value: any): void; - remove(key: string): void; - isDirty(): boolean; - getChanges(): Changes; - toArray(): any[]; - setDirty(dirty: any, model: any): void; - get(index: number): void; - length(): number; - bindTo(element: any): void; - } - class Model { - constructor(json: any, table: string, name: string); - formElements: string[]; - computes(value: any): void; - on(eventName: string, handler: any): void; - off(eventName: string, handler: any): void; - set(field: string, value: any): void; - get(field: string): any; - revert(suspendEvent: any): void; - save(dm: ej.DataManager, key: string): void; - markCommit(): void; - markDelete(): void; - changeState(state: boolean, args: any): void; - properties(): any; - bindTo(element: any): void; - unbind(element: any): void; - } - interface Changes { - changed?: any[]; - added?: any[]; - deleted?: any[]; - } - class Predicate { - constructor(); - constructor(field: string, operator: ej.FilterOperators, value: any, ignoreCase: boolean); - and(field: string, operator: any, value: any, ignoreCase: boolean): ej.Predicate; - or(field: string, operator: any, value: any, ignoreCase: boolean): ej.Predicate; + constructor(); + batchRequest(dm: ej.DataManager, changes: Changes, e: any): void; + beforeSend(dm: ej.DataManager, request: any, settings?: any): void; + insert(dm: ej.DataManager, data: any, tableName: string): { url: string; data: any }; + remove(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data?: any }; + update(dm: ej.DataManager, keyField: string, value: any, tableName: string): { type: string; url: string; data: any }; + } + class TableModel { + constructor(name: string, jsonArray: any[], dataManager: ej.DataManager, modelComputed: any); + on(eventName: string, handler: any): void; + off(eventName: string, handler: any): void; + setDataManager(dataManager: DataManager): void; + saveChanges(): void; + rejectChanges(): void; + insert(json: any): void; + update(value: any): void; + remove(key: string): void; + isDirty(): boolean; + getChanges(): Changes; + toArray(): any[]; + setDirty(dirty: any, model: any): void; + get(index: number): void; + length(): number; + bindTo(element: any): void; + } + class Model { + constructor(json: any, table: string, name: string); + formElements: string[]; + computes(value: any): void; + on(eventName: string, handler: any): void; + off(eventName: string, handler: any): void; + set(field: string, value: any): void; + get(field: string): any; + revert(suspendEvent: any): void; + save(dm: ej.DataManager, key: string): void; + markCommit(): void; + markDelete(): void; + changeState(state: boolean, args: any): void; + properties(): any; + bindTo(element: any): void; + unbind(element: any): void; + } + interface Changes { + changed?: any[]; + added?: any[]; + deleted?: any[]; + } + class Predicate { + constructor(); + constructor(field: string, operator: ej.FilterOperators, value: any, ignoreCase: boolean); + and(field: string, operator: any, value: any, ignoreCase: boolean): ej.Predicate; + or(field: string, operator: any, value: any, ignoreCase: boolean): ej.Predicate; or(predicate: any[]): any; - validate(record: any): boolean; - toJSON(): { - isComplex: boolean; - field: string; - operator: string; - value: any; - ignoreCase: boolean; - condition: string; - predicates: any; - }; - } - interface dataUtil { - swap(array: any[], x: number, y: number): void; - mergeSort(jsonArray: any[], fieldName?: string, comparer?: any): any[]; - max(jsonArray: any[], fieldName?: string, comparer?: string): any[]; - min(jsonArray: any[], fieldName: string, comparer: string): any[]; - distinct(jsonArray: any[], fieldName?: string, requiresCompleteRecord?: any): any[]; - sum(json: any, fieldName: string): number; - avg(json: any, fieldName: string): number; - select(jsonArray: any[], fieldName: string, fields: string): any[]; - group(jsonArray: any[], field: string, /* internal */ level: number): any[]; - parseTable(table: string, headerOption: ej.headerOption, headerRowIndex: number): any; - } - interface AjaxSettings { - type?: string; - cache: boolean; - data?: any; - dataType?: string; - contentType?: any; - async?: boolean; - } + validate(record: any): boolean; + toJSON(): { + isComplex: boolean; + field: string; + operator: string; + value: any; + ignoreCase: boolean; + condition: string; + predicates: any; + }; + } + interface dataUtil { + swap(array: any[], x: number, y: number): void; + mergeSort(jsonArray: any[], fieldName?: string, comparer?: any): any[]; + max(jsonArray: any[], fieldName?: string, comparer?: string): any[]; + min(jsonArray: any[], fieldName: string, comparer: string): any[]; + distinct(jsonArray: any[], fieldName?: string, requiresCompleteRecord?: any): any[]; + sum(json: any, fieldName: string): number; + avg(json: any, fieldName: string): number; + select(jsonArray: any[], fieldName: string, fields: string): any[]; + group(jsonArray: any[], field: string, /* internal */ level: number): any[]; + parseTable(table: string, headerOption: ej.headerOption, headerRowIndex: number): any; + } + interface AjaxSettings { + type?: string; + cache: boolean; + data?: any; + dataType?: string; + contentType?: any; + async?: boolean; + } enum FilterOperators { contains, endsWith, @@ -492,7 +492,7 @@ declare namespace ej { EndsWith, LessThan, GreaterThan, - LessThanOrEqual , + LessThanOrEqual, GreaterThanOrEqual, Equal, NotEqual @@ -510,64776 +510,64779 @@ declare namespace ej { Ascending, Descending } -class Draggable extends ej.Widget { - static fn: Draggable; - constructor(element: JQuery | Element, options?: Draggable.Model); - static Locale: any; - model: Draggable.Model; - defaults: Draggable.Model; + class Draggable extends ej.Widget { + static fn: Draggable; + constructor(element: JQuery | Element, options?: Draggable.Model); + static Locale: any; + model: Draggable.Model; + defaults: Draggable.Model; - /** destroy in the draggable. - * @returns {void} - */ - _destroy(): void; -} -export namespace Draggable { + /** destroy in the draggable. + * @returns {void} + */ + _destroy(): void; + } + export namespace Draggable { -export interface Model { - - /** If clone is specified. - * @Default {false} - */ - clone?: boolean; - - /** Sets the offset of the dragging helper relative to the mouse cursor. - * @Default {{ top: -1, left: -2 }} - */ - cursorAt?: any; + export interface Model { + + /** If clone is specified. + * @Default {false} + */ + clone?: boolean; + + /** Sets the offset of the dragging helper relative to the mouse cursor. + * @Default {{ top: -1, left: -2 }} + */ + cursorAt?: any; - /** Distance in pixels after mousedown the mouse must move before dragging should start. This option can be used to prevent unwanted drags when clicking on an element. - * @Default {1} - */ - distance?: number; + /** Distance in pixels after mousedown the mouse must move before dragging should start. This option can be used to prevent unwanted drags when clicking on an element. + * @Default {1} + */ + distance?: number; - /** The drag area is used to restrict the dragging element bounds. - * @Default {false} - */ - dragArea?: boolean; - - /** If specified, restricts drag start click to the specified element(s). - * @Default {null} - */ - handle?: string; + /** The drag area is used to restrict the dragging element bounds. + * @Default {false} + */ + dragArea?: boolean; + + /** If specified, restricts drag start click to the specified element(s). + * @Default {null} + */ + handle?: string; - /** Used to group sets of draggable and droppable items, in addition to droppable's accept option. A draggable with the same scope value as a droppable will be accepted by the droppable. - * @Default {'default'} - */ - scope?: string; + /** Used to group sets of draggable and droppable items, in addition to droppable's accept option. A draggable with the same scope value as a droppable will be accepted by the droppable. + * @Default {'default'} + */ + scope?: string; - /** This event is triggered when dragging element is destroyed. */ - destroy?(e: DestroyEventArgs): void; + /** This event is triggered when dragging element is destroyed. */ + destroy?(e: DestroyEventArgs): void; - /** This event is triggered when the mouse is moved during the dragging. */ - drag?(e: DragEventArgs): void; + /** This event is triggered when the mouse is moved during the dragging. */ + drag?(e: DragEventArgs): void; - /** Supply a callback function to handle the drag start event as an init option. */ - dragStart?(e: DragStartEventArgs): void; + /** Supply a callback function to handle the drag start event as an init option. */ + dragStart?(e: DragStartEventArgs): void; - /** This event is triggered when the mouse is moved during the dragging. */ - dragStop?(e: DragStopEventArgs): void; + /** This event is triggered when the mouse is moved during the dragging. */ + dragStop?(e: DragStopEventArgs): void; - /** This event is triggered when dragged. */ - helper?(e: HelperEventArgs): void; -} - -export interface DestroyEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the autocomplete model - */ - model?: ej.Draggable.Model; - - /** returns the name of the event - */ - type?: string; -} - -export interface DragEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the draggable model - */ - model?: ej.Draggable.Model; - - /** returns the name of the event - */ - type?: string; - - /** returns the event model values - */ - event?: any; - - /** returns the exact mouse down target element - */ - target?: any; -} - -export interface DragStartEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** This event is triggered when dragged. */ + helper?(e: HelperEventArgs): void; + } + + export interface DestroyEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the autocomplete model + */ + model?: ej.Draggable.Model; + + /** returns the name of the event + */ + type?: string; + } + + export interface DragEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the draggable model + */ + model?: ej.Draggable.Model; + + /** returns the name of the event + */ + type?: string; + + /** returns the event model values + */ + event?: any; + + /** returns the exact mouse down target element + */ + target?: any; + } + + export interface DragStartEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the draggable model - */ - model?: ej.Draggable.Model; + /** returns the draggable model + */ + model?: ej.Draggable.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the event model values - */ - event?: any; + /** returns the event model values + */ + event?: any; - /** returns the exact mouse down target element - */ - target?: any; -} + /** returns the exact mouse down target element + */ + target?: any; + } -export interface DragStopEventArgs { + export interface DragStopEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the draggable model - */ - model?: ej.Draggable.Model; + /** returns the draggable model + */ + model?: ej.Draggable.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the event model values - */ - event?: any; + /** returns the event model values + */ + event?: any; - /** returns the exact mouse down target element - */ - target?: any; -} + /** returns the exact mouse down target element + */ + target?: any; + } -export interface HelperEventArgs { + export interface HelperEventArgs { - /** returns the draggable element object - */ - element?: any; + /** returns the draggable element object + */ + element?: any; - /** returns the event model values - */ - sender?: any; -} -} + /** returns the event model values + */ + sender?: any; + } + } -class Droppable extends ej.Widget { - static fn: Droppable; - constructor(element: JQuery | Element, options?: Droppable.Model); - static Locale: any; - model: Droppable.Model; - defaults: Droppable.Model; - - /** destroy in the Droppable. - * @returns {void} - */ - _destroy(): void; -} -export namespace Droppable { - -export interface Model { - - /** Used to accept the specified draggable items. - * @Default {null} - */ - accept?: any; - - /** Used to group sets of droppable items, in addition to droppable's accept option. A draggable with the same scope value as a droppable will be accepted by the droppable. - * @Default {'default'} - */ - scope?: string; - - /** This event is triggered when the mouse up is moved during the dragging. */ - drop?(e: DropEventArgs): void; - - /** This event is triggered when the mouse is moved out. */ - out?(e: OutEventArgs): void; - - /** This event is triggered when the mouse is moved over. */ - over?(e: OverEventArgs): void; -} - -export interface DropEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the autocomplete model - */ - model?: ej.Droppable.Model; - - /** returns the name of the event - */ - type?: string; - - /** returns the element which accepts the droppable element. - */ - targetElement?: any; -} - -export interface OutEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the autocomplete model - */ - model?: ej.Droppable.Model; - - /** returns the name of the event - */ - type?: string; - - /** returns the mouse out over the element - */ - targetElement?: any; -} - -export interface OverEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the autocomplete model - */ - model?: ej.Droppable.Model; - - /** returns the name of the event - */ - type?: string; - - /** returns the mouse over the element - */ - targetElement?: any; -} -} - -class Resizable extends ej.Widget { - static fn: Resizable; - constructor(element: JQuery | Element, options?: Resizable.Model); - static Locale: any; - model: Resizable.Model; - defaults: Resizable.Model; - - /** destroy in the Resizable. - * @returns {void} - */ - _destroy(): void; -} -export namespace Resizable { - -export interface Model { - - /** Sets the offset of the resizing helper relative to the mouse cursor. - * @Default {{ top: -1, left: -2 }} - */ - cursorAt?: any; - - /** Distance in pixels after mousedown the mouse must move before resizing should start. This option can be used to prevent unwanted drags when clicking on an element. - * @Default {1} - */ - distance?: number; - - /** If specified, restricts resize start click to the specified element(s). - * @Default {null} - */ - handle?: string; - - /** Sets the max height for resizing - * @Default {null} - */ - maxHeight?: number; - - /** Sets the max width for resizing - * @Default {null} - */ - maxWidth?: number; - - /** Sets the min Height for resizing - * @Default {10} - */ - minHeight?: number; - - /** Sets the min Width for resizing - * @Default {10} - */ - minWidth?: number; - - /** Used to group sets of resizable items. - * @Default {'default'} - */ - scope?: string; - - /** This event is triggered when the widget destroys. */ - destroy?(e: DestroyEventArgs): void; - - /** This event is triggered when resized. */ - helper?(e: HelperEventArgs): void; -} - -export interface DestroyEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the autocomplete model - */ - model?: ej.Resizable.Model; - - /** returns the name of the event - */ - type?: string; -} - -export interface HelperEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the autocomplete model - */ - model?: ej.Resizable.Model; - - /** returns the name of the event - */ - type?: string; -} -} - - - const globalize: globalize; - const cultures: culture; - function addCulture(name: string, culture ?: any): void; - function preferredCulture(culture ?: string): culture; - function format(value: any, format: string, culture ?: string): string; - function parseInt(value: string, radix?: any, culture ?: string): number; - function parseFloat(value: string, radix?: any, culture ?: string): number; - function parseDate(value: string, format: string, culture ?: string): Date; - function getLocalizedConstants(controlName: string, culture ?: string): any; - -interface globalize { - addCulture(name: string, culture?: any): void; - preferredCulture(culture?: string): culture; - format(value: any, format: string, culture?: string): string; - parseInt(value: string, radix?: any, culture?: string): number; - parseFloat(value: string, radix?: any, culture?: string): number; - parseDate(value: string, format: string, culture?: string): Date; - getLocalizedConstants(controlName: string, culture?: string): any; - } - interface culture { - name?: string; - englishName?: string; - namtiveName?: string; - language?: string; - isRTL: boolean; - numberFormat?: formatSettings; - calendars?: calendarsSettings; - } - interface formatSettings { - pattern: string[]; - decimals: number; - groupSizes: number[]; - percent: percentSettings; - currency: currencySettings; - } - interface percentSettings { - pattern: string[]; - decimals: number; - groupSizes: number[]; - symbol: string; - } - interface currencySettings { - pattern: string[]; - decimals: number; - groupSizes: number[]; - symbol: string; - } - interface calendarsSettings { - standard: standardSettings; - } - interface standardSettings { - firstDay: number; - days: daySettings; - months: monthSettings; - AM: string[]; - PM: string[]; - twoDigitYearMax: number; - patterns: patternSettings; - } - interface daySettings { - names: string[]; - namesAbbr: string[]; - namesShort: string[]; - } - interface monthSettings { - names: string[]; - namesAbbr: string[]; - } - interface patternSettings { - d: string; - D: string; - t: string; - T: string; - f: string; - F: string; - M: string; - Y: string; - S: string; - } -class Scroller extends ej.Widget { - static fn: Scroller; - constructor(element: JQuery | Element, options?: Scroller.Model); - static Locale: any; - model: Scroller.Model; - defaults: Scroller.Model; - - /** destroy the Scroller control, unbind the all ej control related events automatically and bring the control to pre-init state. - * @returns {void} - */ - destroy(): void; - - /** User disables the Scroller control at any time. - * @returns {void} - */ - disable(): void; - - /** User enables the Scroller control at any time. - * @returns {void} - */ - enable(): void; - - /** Returns true if horizontal scrollbar is shown, else return false. - * @returns {boolean} - */ - isHScroll(): boolean; - - /** Returns true if vertical scrollbar is shown, else return false. - * @returns {boolean} - */ - isVScroll(): boolean; - - /** User refreshes the Scroller control at any time. - * @returns {void} - */ - refresh(): void; - - /** Horizontal scroller moves to given pixel from its origin position. We can also specify the animation speed,in which the scroller has to move while re-positioning it. - * @param {number|string} Horizontal scroller moves to the specified pixel. - * @param {boolean} Specifies to enable/disable the animation. - * @param {number} Specifies the animation speed when scrolling, if animation is enabled. - * @returns {void} - */ - scrollX(pixel: number|string, disableAnimation: boolean, animationSpeed: number): void; - - /** Vertical scroller moves to given pixel from its origin position. We can also specify the animation speed,in which the scroller has to move while re-positioning it. - * @param {number|string} Vertical scroller moves to the specified pixel. - * @param {boolean} Specifies to enable/disable the animation. - * @param {number} Specifies the animation speed when scrolling, if animation is enabled. - * @returns {void} - */ - scrollY(pixel: number|string, disableAnimation: boolean, animationSpeed: number): void; -} -export namespace Scroller { - -export interface Model { - - /** Specifies the swipe scrolling speed(in millisecond). - * @Default {600} - */ - animationSpeed?: number; - - /** Set true to hides the scrollbar, when mouseout the content area. - * @Default {false} - */ - autoHide?: boolean; - - /** Specifies the height and width of button in the scrollbar. - * @Default {18} - */ - buttonSize?: number; - - /** Specifies to enable or disable the scroller - * @Default {true} - */ - enabled?: boolean; - - /** Save current model value to browser cookies for state maintenance. While refresh the page Rating control values are retained. - * @Default {false} - */ - enablePersistence?: boolean; - - /** Indicates the Right to Left direction to scroller - * @Default {undefined} - */ - enableRTL?: boolean; - - /** Enables or Disable the touch Scroll - * @Default {true} - */ - enableTouchScroll?: boolean; - - /** Specifies the height of Scroll panel and scrollbars. - * @Default {250} - */ - height?: number|string; - - /** If the scrollbar has vertical it set as width, else it will set as height of the handler. - * @Default {18} - */ - scrollerSize?: number; - - /** The Scroller content and scrollbars move left with given value. - * @Default {0} - */ - scrollLeft?: number; - - /** While press on the arrow key the scrollbar position added to the given pixel value. - * @Default {57} - */ - scrollOneStepBy?: number; - - /** The Scroller content and scrollbars move to top position with specified value. - * @Default {0} - */ - scrollTop?: number; - - /** Indicates the target area to which scroller have to appear. - * @Default {null} - */ - targetPane?: string; - - /** Specifies the width of Scroll panel and scrollbars. - * @Default {0} - */ - width?: number|string; - - /** Fires when Scroller control is created. */ - create?(e: CreateEventArgs): void; - - /** Fires when Scroller control is destroyed. */ - destroy?(e: DestroyEventArgs): void; - - /** Fires when a thumb point is moved along the touch surface. */ - thumbMove?(e: ThumbMoveEventArgs): void; - - /** Fires when a thumb point is placed on the touch surface. */ - thumbStart?(e: ThumbStartEventArgs): void; - - /** Fires when a thumb point is removed from the touch surface. */ - thumbEnd?(e: ThumbEndEventArgs): void; - - /** It fires whenever the mouse wheel is rotated either in upwards or downwards. */ - wheelMove?(e: WheelMoveEventArgs): void; - - /** It will fire when mouse trackball has been start to wheel. */ - wheelStart?(e: WheelStartEventArgs): void; - - /** It will fire when mouse trackball has been stop to wheel. */ - wheelStop?(e: WheelStopEventArgs): void; -} + class Droppable extends ej.Widget { + static fn: Droppable; + constructor(element: JQuery | Element, options?: Droppable.Model); + static Locale: any; + model: Droppable.Model; + defaults: Droppable.Model; + + /** destroy in the Droppable. + * @returns {void} + */ + _destroy(): void; + } + export namespace Droppable { + + export interface Model { + + /** Used to accept the specified draggable items. + * @Default {null} + */ + accept?: any; + + /** Used to group sets of droppable items, in addition to droppable's accept option. A draggable with the same scope value as a droppable will be accepted by the droppable. + * @Default {'default'} + */ + scope?: string; + + /** This event is triggered when the mouse up is moved during the dragging. */ + drop?(e: DropEventArgs): void; + + /** This event is triggered when the mouse is moved out. */ + out?(e: OutEventArgs): void; + + /** This event is triggered when the mouse is moved over. */ + over?(e: OverEventArgs): void; + } + + export interface DropEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the autocomplete model + */ + model?: ej.Droppable.Model; + + /** returns the name of the event + */ + type?: string; + + /** returns the element which accepts the droppable element. + */ + targetElement?: any; + } + + export interface OutEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the autocomplete model + */ + model?: ej.Droppable.Model; + + /** returns the name of the event + */ + type?: string; + + /** returns the mouse out over the element + */ + targetElement?: any; + } + + export interface OverEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the autocomplete model + */ + model?: ej.Droppable.Model; + + /** returns the name of the event + */ + type?: string; + + /** returns the mouse over the element + */ + targetElement?: any; + } + } + + class Resizable extends ej.Widget { + static fn: Resizable; + constructor(element: JQuery | Element, options?: Resizable.Model); + static Locale: any; + model: Resizable.Model; + defaults: Resizable.Model; + + /** destroy in the Resizable. + * @returns {void} + */ + _destroy(): void; + } + export namespace Resizable { + + export interface Model { + + /** Sets the offset of the resizing helper relative to the mouse cursor. + * @Default {{ top: -1, left: -2 }} + */ + cursorAt?: any; + + /** Distance in pixels after mousedown the mouse must move before resizing should start. This option can be used to prevent unwanted drags when clicking on an element. + * @Default {1} + */ + distance?: number; + + /** If specified, restricts resize start click to the specified element(s). + * @Default {null} + */ + handle?: string; + + /** Sets the max height for resizing + * @Default {null} + */ + maxHeight?: number; + + /** Sets the max width for resizing + * @Default {null} + */ + maxWidth?: number; + + /** Sets the min Height for resizing + * @Default {10} + */ + minHeight?: number; + + /** Sets the min Width for resizing + * @Default {10} + */ + minWidth?: number; + + /** Used to group sets of resizable items. + * @Default {'default'} + */ + scope?: string; + + /** This event is triggered when the widget destroys. */ + destroy?(e: DestroyEventArgs): void; + + /** This event is triggered when resized. */ + helper?(e: HelperEventArgs): void; + } + + export interface DestroyEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the autocomplete model + */ + model?: ej.Resizable.Model; + + /** returns the name of the event + */ + type?: string; + } + + export interface HelperEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the autocomplete model + */ + model?: ej.Resizable.Model; + + /** returns the name of the event + */ + type?: string; + } + } + + + const globalize: globalize; + const cultures: culture; + function addCulture(name: string, culture?: any): void; + function preferredCulture(culture?: string): culture; + function format(value: any, format: string, culture?: string): string; + function parseInt(value: string, radix?: any, culture?: string): number; + function parseFloat(value: string, radix?: any, culture?: string): number; + function parseDate(value: string, format: string, culture?: string): Date; + function getLocalizedConstants(controlName: string, culture?: string): any; + + interface globalize { + addCulture(name: string, culture?: any): void; + preferredCulture(culture?: string): culture; + format(value: any, format: string, culture?: string): string; + parseInt(value: string, radix?: any, culture?: string): number; + parseFloat(value: string, radix?: any, culture?: string): number; + parseDate(value: string, format: string, culture?: string): Date; + getLocalizedConstants(controlName: string, culture?: string): any; + } + interface culture { + name?: string; + englishName?: string; + namtiveName?: string; + language?: string; + isRTL: boolean; + numberFormat?: formatSettings; + calendars?: calendarsSettings; + } + interface formatSettings { + pattern: string[]; + decimals: number; + groupSizes: number[]; + percent: percentSettings; + currency: currencySettings; + } + interface percentSettings { + pattern: string[]; + decimals: number; + groupSizes: number[]; + symbol: string; + } + interface currencySettings { + pattern: string[]; + decimals: number; + groupSizes: number[]; + symbol: string; + } + interface calendarsSettings { + standard: standardSettings; + } + interface standardSettings { + firstDay: number; + days: daySettings; + months: monthSettings; + AM: string[]; + PM: string[]; + twoDigitYearMax: number; + patterns: patternSettings; + } + interface daySettings { + names: string[]; + namesAbbr: string[]; + namesShort: string[]; + } + interface monthSettings { + names: string[]; + namesAbbr: string[]; + } + interface patternSettings { + d: string; + D: string; + t: string; + T: string; + f: string; + F: string; + M: string; + Y: string; + S: string; + } + class Scroller extends ej.Widget { + static fn: Scroller; + constructor(element: JQuery | Element, options?: Scroller.Model); + static Locale: any; + model: Scroller.Model; + defaults: Scroller.Model; + + /** destroy the Scroller control, unbind the all ej control related events automatically and bring the control to pre-init state. + * @returns {void} + */ + destroy(): void; + + /** User disables the Scroller control at any time. + * @returns {void} + */ + disable(): void; + + /** User enables the Scroller control at any time. + * @returns {void} + */ + enable(): void; + + /** Returns true if horizontal scrollbar is shown, else return false. + * @returns {boolean} + */ + isHScroll(): boolean; + + /** Returns true if vertical scrollbar is shown, else return false. + * @returns {boolean} + */ + isVScroll(): boolean; + + /** User refreshes the Scroller control at any time. + * @returns {void} + */ + refresh(): void; + + /** Horizontal scroller moves to given pixel from its origin position. We can also specify the animation speed,in which the scroller has to move while re-positioning it. + * @param {number|string} Horizontal scroller moves to the specified pixel. + * @param {boolean} Specifies to enable/disable the animation. + * @param {number} Specifies the animation speed when scrolling, if animation is enabled. + * @returns {void} + */ + scrollX(pixel: number | string, disableAnimation: boolean, animationSpeed: number): void; + + /** Vertical scroller moves to given pixel from its origin position. We can also specify the animation speed,in which the scroller has to move while re-positioning it. + * @param {number|string} Vertical scroller moves to the specified pixel. + * @param {boolean} Specifies to enable/disable the animation. + * @param {number} Specifies the animation speed when scrolling, if animation is enabled. + * @returns {void} + */ + scrollY(pixel: number | string, disableAnimation: boolean, animationSpeed: number): void; + } + export namespace Scroller { + + export interface Model { + + /** Specifies the swipe scrolling speed(in millisecond). + * @Default {600} + */ + animationSpeed?: number; + + /** Set true to hides the scrollbar, when mouseout the content area. + * @Default {false} + */ + autoHide?: boolean; + + /** Specifies the height and width of button in the scrollbar. + * @Default {18} + */ + buttonSize?: number; + + /** Specifies to enable or disable the scroller + * @Default {true} + */ + enabled?: boolean; + + /** Save current model value to browser cookies for state maintenance. While refresh the page Rating control values are retained. + * @Default {false} + */ + enablePersistence?: boolean; + + /** Indicates the Right to Left direction to scroller + * @Default {undefined} + */ + enableRTL?: boolean; + + /** Enables or Disable the touch Scroll + * @Default {true} + */ + enableTouchScroll?: boolean; + + /** Specifies the height of Scroll panel and scrollbars. + * @Default {250} + */ + height?: number | string; + + /** If the scrollbar has vertical it set as width, else it will set as height of the handler. + * @Default {18} + */ + scrollerSize?: number; + + /** The Scroller content and scrollbars move left with given value. + * @Default {0} + */ + scrollLeft?: number; + + /** While press on the arrow key the scrollbar position added to the given pixel value. + * @Default {57} + */ + scrollOneStepBy?: number; + + /** The Scroller content and scrollbars move to top position with specified value. + * @Default {0} + */ + scrollTop?: number; + + /** Indicates the target area to which scroller have to appear. + * @Default {null} + */ + targetPane?: string; + + /** Specifies the width of Scroll panel and scrollbars. + * @Default {0} + */ + width?: number | string; + + /** Fires when Scroller control is created. */ + create?(e: CreateEventArgs): void; + + /** Fires when Scroller control is destroyed. */ + destroy?(e: DestroyEventArgs): void; + + /** Fires when a thumb point is moved along the touch surface. */ + thumbMove?(e: ThumbMoveEventArgs): void; + + /** Fires when a thumb point is placed on the touch surface. */ + thumbStart?(e: ThumbStartEventArgs): void; + + /** Fires when a thumb point is removed from the touch surface. */ + thumbEnd?(e: ThumbEndEventArgs): void; + + /** It fires whenever the mouse wheel is rotated either in upwards or downwards. */ + wheelMove?(e: WheelMoveEventArgs): void; + + /** It will fire when mouse trackball has been start to wheel. */ + wheelStart?(e: WheelStartEventArgs): void; + + /** It will fire when mouse trackball has been stop to wheel. */ + wheelStop?(e: WheelStopEventArgs): void; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the scroller model - */ - model?: ej.Scroller.Model; + /** returns the scroller model + */ + model?: ej.Scroller.Model; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** returns the scroller model - */ - model?: ej.Scroller.Model; + /** returns the scroller model + */ + model?: ej.Scroller.Model; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface ThumbMoveEventArgs { + export interface ThumbMoveEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the scroller model - */ - model?: ej.Scroller.Model; + /** returns the scroller model + */ + model?: ej.Scroller.Model; - /** returns the original event name and its event properties of the current event. - */ - originalEvent?: any; + /** returns the original event name and its event properties of the current event. + */ + originalEvent?: any; - /** returns the current data related to the event. - */ - scrollData?: any; + /** returns the current data related to the event. + */ + scrollData?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface ThumbStartEventArgs { + export interface ThumbStartEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the scroller model - */ - model?: ej.Scroller.Model; + /** returns the scroller model + */ + model?: ej.Scroller.Model; - /** returns the original event name and its event properties of the current event. - */ - originalEvent?: any; + /** returns the original event name and its event properties of the current event. + */ + originalEvent?: any; - /** returns the current data related to the event. - */ - scrollData?: any; + /** returns the current data related to the event. + */ + scrollData?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface ThumbEndEventArgs { + export interface ThumbEndEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the scroller model - */ - model?: ej.Scroller.Model; + /** returns the scroller model + */ + model?: ej.Scroller.Model; - /** returns the original event name and its event properties of the current event. - */ - originalEvent?: any; + /** returns the original event name and its event properties of the current event. + */ + originalEvent?: any; - /** returns the current data related to the event. - */ - scrollData?: any; + /** returns the current data related to the event. + */ + scrollData?: any; - /** returns the name of the event. - */ - type?: string; -} - -export interface WheelMoveEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the scroller model - */ - model?: ej.Scroller.Model; - - /** returns the original event name and its event properties of the current event. - */ - originalEvent?: any; -} - -export interface WheelStartEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the scroller model - */ - model?: ej.Scroller.Model; - - /** returns the original event name and its event properties of the current event. - */ - originalEvent?: any; - - /** returns the current data related to the event. - */ - scrollData?: any; - - /** returns the name of the event. - */ - type?: string; -} - -export interface WheelStopEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the scroller model - */ - model?: ej.Scroller.Model; - - /** returns the name of the event. - */ - type?: string; - - /** returns the original event name and its event properties of the current event. - */ - originalEvent?: any; -} -} - -class Accordion extends ej.Widget { - static fn: Accordion; - constructor(element: JQuery | Element, options?: Accordion.Model); - static Locale: any; - model: Accordion.Model; - defaults: Accordion.Model; - - /** AddItem method is used to add the panel in dynamically. It receives the following parameters - * @param {string} specify the name of the header - * @param {string} content of the new panel - * @param {number} insertion place of the new panel - * @param {boolean} Enable or disable the AJAX request to the added panel - * @returns {void} - */ - addItem(header_name: string, content: string, index: number, isAjaxReq: boolean): void; - - /** This method used to collapse the all the expanded items in accordion at a time. - * @returns {void} - */ - collapseAll(): void; - - /** This method used to Collapses the specified items in accordion at a time. - * @returns {void} - */ - collapsePanel(): void; - - /** destroy the Accordion widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. - * @returns {void} - */ - destroy(): void; - - /** Disables the accordion widget includes all the headers and content panels. - * @returns {void} - */ - disable(): void; - - /** Disable the accordion widget item based on specified header index. - * @param {Array} index values to disable the panels - * @returns {void} - */ - disableItems(index: any[]): void; - - /** Enable the accordion widget includes all the headers and content panels. - * @returns {void} - */ - enable(): void; - - /** Enable the accordion widget item based on specified header index. - * @param {Array} index values to enable the panels - * @returns {void} - */ - enableItems(index: any[]): void; - - /** To expand all the accordion widget items. - * @returns {void} - */ - expandAll(): void; - - /** This method used to Expand the specified items in accordion at a time. - * @returns {void} - */ - expandPanel(): void; - - /** Returns the total number of panels in the control. - * @returns {number} - */ - getItemsCount(): number; - - /** Hides the visible Accordion control. - * @returns {void} - */ - hide(): void; - - /** The refresh method is used to adjust the control size based on the parent element dimension. - * @returns {void} - */ - refresh(): void; - - /** RemoveItem method is used to remove the specified index panel.It receives the parameter as number. - * @param {number} specify the index value for remove the accordion panel. - * @returns {void} - */ - removeItem(index: number): void; - - /** Shows the hidden Accordion control. - * @returns {void} - */ - show(): void; -} -export namespace Accordion { - -export interface Model { - - /** Specifies the ajaxSettings option to load the content to the accordion control. - * @Default {null} - */ - ajaxSettings?: AjaxSettings; - - /** Accordion headers can be expanded and collapsed on keyboard action. - * @Default {true} - */ - allowKeyboardNavigation?: boolean; - - /** To set the Accordion headers Collapse Speed. - * @Default {300} - */ - collapseSpeed?: number; - - /** Specifies the collapsible state of accordion control. - * @Default {false} - */ - collapsible?: boolean; - - /** Sets the root CSS class for Accordion theme, which is used customize. - */ - cssClass?: string; - - /** Allows you to set the custom header Icon. It accepts two key values Ă¢â‚¬Å“headerĂ¢â‚¬Â, Ă¢â‚¬ÂselectedHeaderĂ¢â‚¬Â. - * @Default {{ header: e-collapse, selectedHeader: e-expand }} - */ - customIcon?: CustomIcon; - - /** Disables the specified indexed items in accordion. - * @Default {[]} - */ - disabledItems?: number[]; - - /** Specifies the animation behavior in accordion. - * @Default {true} - */ - enableAnimation?: boolean; - - /** With this enabled property, you can enable or disable the Accordion. - * @Default {true} - */ - enabled?: boolean; - - /** Used to enable the disabled items in accordion. - * @Default {[]} - */ - enabledItems?: number[]; - - /** Multiple content panels to activate at a time. - * @Default {false} - */ - enableMultipleOpen?: boolean; - - /** Save current model value to browser cookies for maintaining states. When refreshing the accordion control page, the model value is applied from browser cookies or HTML 5local storage. - * @Default {false} - */ - enablePersistence?: boolean; - - /** Display headers and panel text from right-to-left. - * @Default {false} - */ - enableRTL?: boolean; - - /** The events API binds the action for activating the accordion header. Users can activate the header by using mouse actions such as mouse-over, mouse-up, mouse-down, and soon. - * @Default {click} - */ - events?: string; - - /** To set the Accordion headers Expand Speed. - * @Default {300} - */ - expandSpeed?: number; - - /** Sets the height for Accordion items header. - */ - headerSize?: number|string; - - /** Specifies height of the accordion. - * @Default {null} - */ - height?: number|string; - - /** Adjusts the content panel height based on the given option (content, auto, or fill). By default, the panel heights are adjusted based on the content. - * @Default {content} - */ - heightAdjustMode?: ej.Accordion.HeightAdjustMode|string; - - /** It allows to define the characteristics of the Accordion control. It will helps to extend the capability of an HTML element. - * @Default {{}} - */ - htmlAttributes?: any; - - /** The given index header will activate (open). If collapsible is set to true, and a negative value is given, then all headers are collapsed. Otherwise, the first panel isactivated. - * @Default {0} - */ - selectedItemIndex?: number; - - /** Activate the specified indexed items of the accordion - * @Default {[0]} - */ - selectedItems?: number[]; - - /** Used to determines the close button visibility an each accordion items. This close button helps to remove the accordion item from the control. - * @Default {false} - */ - showCloseButton?: boolean; - - /** Displays rounded corner borders on the Accordion control's panels and headers. - * @Default {false} - */ - showRoundedCorner?: boolean; - - /** Specifies width of the accordion. - * @Default {null} - */ - width?: number|string; - - /** Triggered after a Accordion item is active or inactive. Argument values are activeIndex, activeHeader, inActiveHeader, inActiveIndex and current model value. */ - activate?(e: ActivateEventArgs): void; - - /** Triggered before the AJAX content is loaded in a content panel. Arguments have location of the content (URL) and current model value. */ - ajaxBeforeLoad?(e: AjaxBeforeLoadEventArgs): void; + /** returns the name of the event. + */ + type?: string; + } + + export interface WheelMoveEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the scroller model + */ + model?: ej.Scroller.Model; + + /** returns the original event name and its event properties of the current event. + */ + originalEvent?: any; + } + + export interface WheelStartEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the scroller model + */ + model?: ej.Scroller.Model; + + /** returns the original event name and its event properties of the current event. + */ + originalEvent?: any; + + /** returns the current data related to the event. + */ + scrollData?: any; + + /** returns the name of the event. + */ + type?: string; + } + + export interface WheelStopEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the scroller model + */ + model?: ej.Scroller.Model; + + /** returns the name of the event. + */ + type?: string; + + /** returns the original event name and its event properties of the current event. + */ + originalEvent?: any; + } + } + + class Accordion extends ej.Widget { + static fn: Accordion; + constructor(element: JQuery | Element, options?: Accordion.Model); + static Locale: any; + model: Accordion.Model; + defaults: Accordion.Model; + + /** AddItem method is used to add the panel in dynamically. It receives the following parameters + * @param {string} specify the name of the header + * @param {string} content of the new panel + * @param {number} insertion place of the new panel + * @param {boolean} Enable or disable the AJAX request to the added panel + * @returns {void} + */ + addItem(header_name: string, content: string, index: number, isAjaxReq: boolean): void; + + /** This method used to collapse the all the expanded items in accordion at a time. + * @returns {void} + */ + collapseAll(): void; + + /** This method used to Collapses the specified items in accordion at a time. + * @returns {void} + */ + collapsePanel(): void; + + /** destroy the Accordion widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. + * @returns {void} + */ + destroy(): void; + + /** Disables the accordion widget includes all the headers and content panels. + * @returns {void} + */ + disable(): void; + + /** Disable the accordion widget item based on specified header index. + * @param {Array} index values to disable the panels + * @returns {void} + */ + disableItems(index: any[]): void; + + /** Enable the accordion widget includes all the headers and content panels. + * @returns {void} + */ + enable(): void; + + /** Enable the accordion widget item based on specified header index. + * @param {Array} index values to enable the panels + * @returns {void} + */ + enableItems(index: any[]): void; + + /** To expand all the accordion widget items. + * @returns {void} + */ + expandAll(): void; + + /** This method used to Expand the specified items in accordion at a time. + * @returns {void} + */ + expandPanel(): void; + + /** Returns the total number of panels in the control. + * @returns {number} + */ + getItemsCount(): number; + + /** Hides the visible Accordion control. + * @returns {void} + */ + hide(): void; + + /** The refresh method is used to adjust the control size based on the parent element dimension. + * @returns {void} + */ + refresh(): void; + + /** RemoveItem method is used to remove the specified index panel.It receives the parameter as number. + * @param {number} specify the index value for remove the accordion panel. + * @returns {void} + */ + removeItem(index: number): void; + + /** Shows the hidden Accordion control. + * @returns {void} + */ + show(): void; + } + export namespace Accordion { + + export interface Model { + + /** Specifies the ajaxSettings option to load the content to the accordion control. + * @Default {null} + */ + ajaxSettings?: AjaxSettings; + + /** Accordion headers can be expanded and collapsed on keyboard action. + * @Default {true} + */ + allowKeyboardNavigation?: boolean; + + /** To set the Accordion headers Collapse Speed. + * @Default {300} + */ + collapseSpeed?: number; + + /** Specifies the collapsible state of accordion control. + * @Default {false} + */ + collapsible?: boolean; + + /** Sets the root CSS class for Accordion theme, which is used customize. + */ + cssClass?: string; + + /** Allows you to set the custom header Icon. It accepts two key values Ă¢â‚¬Å“headerĂ¢â‚¬Â, Ă¢â‚¬ÂselectedHeaderĂ¢â‚¬Â. + * @Default {{ header: e-collapse, selectedHeader: e-expand }} + */ + customIcon?: CustomIcon; + + /** Disables the specified indexed items in accordion. + * @Default {[]} + */ + disabledItems?: number[]; + + /** Specifies the animation behavior in accordion. + * @Default {true} + */ + enableAnimation?: boolean; + + /** With this enabled property, you can enable or disable the Accordion. + * @Default {true} + */ + enabled?: boolean; + + /** Used to enable the disabled items in accordion. + * @Default {[]} + */ + enabledItems?: number[]; + + /** Multiple content panels to activate at a time. + * @Default {false} + */ + enableMultipleOpen?: boolean; + + /** Save current model value to browser cookies for maintaining states. When refreshing the accordion control page, the model value is applied from browser cookies or HTML 5local storage. + * @Default {false} + */ + enablePersistence?: boolean; + + /** Display headers and panel text from right-to-left. + * @Default {false} + */ + enableRTL?: boolean; + + /** The events API binds the action for activating the accordion header. Users can activate the header by using mouse actions such as mouse-over, mouse-up, mouse-down, and soon. + * @Default {click} + */ + events?: string; + + /** To set the Accordion headers Expand Speed. + * @Default {300} + */ + expandSpeed?: number; + + /** Sets the height for Accordion items header. + */ + headerSize?: number | string; + + /** Specifies height of the accordion. + * @Default {null} + */ + height?: number | string; + + /** Adjusts the content panel height based on the given option (content, auto, or fill). By default, the panel heights are adjusted based on the content. + * @Default {content} + */ + heightAdjustMode?: ej.Accordion.HeightAdjustMode | string; + + /** It allows to define the characteristics of the Accordion control. It will helps to extend the capability of an HTML element. + * @Default {{}} + */ + htmlAttributes?: any; + + /** The given index header will activate (open). If collapsible is set to true, and a negative value is given, then all headers are collapsed. Otherwise, the first panel isactivated. + * @Default {0} + */ + selectedItemIndex?: number; + + /** Activate the specified indexed items of the accordion + * @Default {[0]} + */ + selectedItems?: number[]; + + /** Used to determines the close button visibility an each accordion items. This close button helps to remove the accordion item from the control. + * @Default {false} + */ + showCloseButton?: boolean; + + /** Displays rounded corner borders on the Accordion control's panels and headers. + * @Default {false} + */ + showRoundedCorner?: boolean; + + /** Specifies width of the accordion. + * @Default {null} + */ + width?: number | string; + + /** Triggered after a Accordion item is active or inactive. Argument values are activeIndex, activeHeader, inActiveHeader, inActiveIndex and current model value. */ + activate?(e: ActivateEventArgs): void; + + /** Triggered before the AJAX content is loaded in a content panel. Arguments have location of the content (URL) and current model value. */ + ajaxBeforeLoad?(e: AjaxBeforeLoadEventArgs): void; - /** Triggered after AJAX load failed action. Arguments have URL, error message, and current model value. */ - ajaxError?(e: AjaxErrorEventArgs): void; - - /** Triggered after the AJAX content loads. Arguments have current model values. */ - ajaxLoad?(e: AjaxLoadEventArgs): void; - - /** Triggered after AJAX success action. Arguments have URL, content, and current model values. */ - ajaxSuccess?(e: AjaxSuccessEventArgs): void; + /** Triggered after AJAX load failed action. Arguments have URL, error message, and current model value. */ + ajaxError?(e: AjaxErrorEventArgs): void; + + /** Triggered after the AJAX content loads. Arguments have current model values. */ + ajaxLoad?(e: AjaxLoadEventArgs): void; + + /** Triggered after AJAX success action. Arguments have URL, content, and current model values. */ + ajaxSuccess?(e: AjaxSuccessEventArgs): void; - /** Triggered before a tab item is active. Arguments have active index and model values. */ - beforeActivate?(e: BeforeActivateEventArgs): void; - - /** Triggered after a Accordion item is active or inactive. Argument values are activeIndex, activeHeader, inActiveHeader, inActiveIndex and current model value. */ - beforeInactivate?(e: BeforeInactivateEventArgs): void; + /** Triggered before a tab item is active. Arguments have active index and model values. */ + beforeActivate?(e: BeforeActivateEventArgs): void; + + /** Triggered after a Accordion item is active or inactive. Argument values are activeIndex, activeHeader, inActiveHeader, inActiveIndex and current model value. */ + beforeInactivate?(e: BeforeInactivateEventArgs): void; - /** Triggered after Accordion control creation. */ - create?(e: CreateEventArgs): void; + /** Triggered after Accordion control creation. */ + create?(e: CreateEventArgs): void; - /** Triggered after Accordion control destroy. */ - destroy?(e: DestroyEventArgs): void; + /** Triggered after Accordion control destroy. */ + destroy?(e: DestroyEventArgs): void; - /** Triggered after a Accordion item is active or inactive. Argument values are activeIndex, activeHeader, inActiveHeader, inActiveIndex and current model value. */ - inActivate?(e: InActivateEventArgs): void; -} + /** Triggered after a Accordion item is active or inactive. Argument values are activeIndex, activeHeader, inActiveHeader, inActiveIndex and current model value. */ + inActivate?(e: InActivateEventArgs): void; + } -export interface ActivateEventArgs { + export interface ActivateEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the accordion model - */ - model?: ej.Accordion.Model; + /** returns the accordion model + */ + model?: ej.Accordion.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns active index - */ - activeIndex?: number; + /** returns active index + */ + activeIndex?: number; - /** returns current active header - */ - activeHeader?: any; + /** returns current active header + */ + activeHeader?: any; - /** returns true when the Accordion index activated by user interaction otherwise returns false - */ - isInteraction?: boolean; -} + /** returns true when the Accordion index activated by user interaction otherwise returns false + */ + isInteraction?: boolean; + } -export interface AjaxBeforeLoadEventArgs { + export interface AjaxBeforeLoadEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the accordion model - */ - model?: ej.Accordion.Model; + /** returns the accordion model + */ + model?: ej.Accordion.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns current AJAX content location - */ - URL?: string; -} + /** returns current AJAX content location + */ + URL?: string; + } -export interface AjaxErrorEventArgs { + export interface AjaxErrorEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the accordion model - */ - model?: ej.Accordion.Model; + /** returns the accordion model + */ + model?: ej.Accordion.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns current AJAX content location - */ - URL?: string; + /** returns current AJAX content location + */ + URL?: string; - /** returns the failed data sent. - */ - data?: string; -} + /** returns the failed data sent. + */ + data?: string; + } -export interface AjaxLoadEventArgs { + export interface AjaxLoadEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the accordion model - */ - model?: ej.Accordion.Model; + /** returns the accordion model + */ + model?: ej.Accordion.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the name of the URL - */ - URL?: string; -} + /** returns the name of the URL + */ + URL?: string; + } -export interface AjaxSuccessEventArgs { + export interface AjaxSuccessEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the accordion model - */ - model?: ej.Accordion.Model; + /** returns the accordion model + */ + model?: ej.Accordion.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns current AJAX content location - */ - URL?: string; + /** returns current AJAX content location + */ + URL?: string; - /** returns the successful data sent. - */ - data?: string; + /** returns the successful data sent. + */ + data?: string; - /** returns the AJAX content. - */ - content?: string; -} + /** returns the AJAX content. + */ + content?: string; + } -export interface BeforeActivateEventArgs { + export interface BeforeActivateEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the accordion model - */ - model?: ej.Accordion.Model; + /** returns the accordion model + */ + model?: ej.Accordion.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns active index - */ - activeIndex?: number; + /** returns active index + */ + activeIndex?: number; - /** returns true when the Accordion index activated by user interaction otherwise returns false - */ - isInteraction?: boolean; -} + /** returns true when the Accordion index activated by user interaction otherwise returns false + */ + isInteraction?: boolean; + } -export interface BeforeInactivateEventArgs { + export interface BeforeInactivateEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the accordion model - */ - model?: ej.Accordion.Model; + /** returns the accordion model + */ + model?: ej.Accordion.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns active index - */ - inActiveIndex?: number; + /** returns active index + */ + inActiveIndex?: number; - /** returns true when the Accordion index activated by user interaction otherwise returns false - */ - isInteraction?: boolean; -} + /** returns true when the Accordion index activated by user interaction otherwise returns false + */ + isInteraction?: boolean; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the accordion model - */ - model?: ej.Accordion.Model; + /** returns the accordion model + */ + model?: ej.Accordion.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the accordion model - */ - model?: ej.Accordion.Model; + /** returns the accordion model + */ + model?: ej.Accordion.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface InActivateEventArgs { + export interface InActivateEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the accordion model - */ - model?: ej.Accordion.Model; + /** returns the accordion model + */ + model?: ej.Accordion.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns active index - */ - inActiveIndex?: number; + /** returns active index + */ + inActiveIndex?: number; - /** returns in active element - */ - inActiveHeader?: any; + /** returns in active element + */ + inActiveHeader?: any; - /** returns true when the Accordion index activated by user interaction otherwise returns false - */ - isInteraction?: boolean; -} + /** returns true when the Accordion index activated by user interaction otherwise returns false + */ + isInteraction?: boolean; + } -export interface AjaxSettings { + export interface AjaxSettings { - /** It specifies, whether to enable or disable asynchronous request. - */ - async?: boolean; + /** It specifies, whether to enable or disable asynchronous request. + */ + async?: boolean; - /** It specifies the page will be cached in the web browser. - */ - cache?: boolean; + /** It specifies the page will be cached in the web browser. + */ + cache?: boolean; - /** It specifies the type of data is send in the query string. - */ - contentType?: string; - - /** It specifies the data as an object, will be passed in the query string. - */ - data?: any; - - /** It specifies the type of data that you're expecting back from the response. - */ - dataType?: string; - - /** It specifies the HTTP request type. - */ - type?: string; -} - -export interface CustomIcon { - - /** This class name set to collapsing header. - */ - header?: string; - - /** This class name set to expanded (active) header. - */ - selectedHeader?: string; -} - -enum HeightAdjustMode { - - ///Height fit to the content in the panel - Content, - - ///Height set to the largest content in the panel - Auto, - - ///Height filled to the content of the panel - Fill -} - -} - -class Autocomplete extends ej.Widget { - static fn: Autocomplete; - constructor(element: JQuery | Element, options?: Autocomplete.Model); - static Locale: any; - model: Autocomplete.Model; - defaults: Autocomplete.Model; - - /** Clears the text in the Autocomplete textbox. - * @returns {void} - */ - clearText(): void; - - /** Destroys the Autocomplete widget. - * @returns {void} - */ - destroy(): void; - - /** Disables the autocomplete widget. - * @returns {void} - */ - disable(): void; - - /** Enables the autocomplete widget. - * @returns {void} - */ - enable(): void; - - /** Returns objects (data object) of all the selected items in the autocomplete textbox. - * @returns {any} - */ - getSelectedItems(): any; - - /** Returns the current selected value from the Autocomplete textbox. - * @returns {string} - */ - getValue(): string; - - /** Returns the current active text value in the Autocomplete suggestion list. - * @returns {string} - */ - getActiveText(): string; - - /** Search the entered text and show it in the suggestion list if available. - * @returns {void} - */ - search(): void; - - /** Open up the autocomplete suggestion popup with all list items. - * @returns {void} - */ - open(): void; - - /** Sets the value of the Autocomplete textbox based on the given key value. - * @param {string} The key value of the specific suggestion item. - * @returns {void} - */ - selectValueByKey(Key: string): void; - - /** Sets the value of the Autocomplete textbox based on the given input text value. - * @param {string} The text (label) value of the specific suggestion item. - * @returns {void} - */ - selectValueByText(Text: string): void; -} -export namespace Autocomplete { - -export interface Model { - - /** Customize "Add New" text (label) to be added in the autocomplete popup list for the entered text when there are no suggestions for it. - * @Default {Add New} - */ - addNewText?: boolean; - - /** Allows new values to be added to the autocomplete input other than the values in the suggestion list. - * Normally, when there are no suggestions it will display Ă¢â‚¬Å“No suggestionsĂ¢â‚¬Â label in the popup. - * @Default {false} - */ - allowAddNew?: boolean; - - /** Enables or disables the sorting of suggestion list item. The default sort order is ascending order. You customize sort order. - * @Default {true} - */ - allowSorting?: boolean; - - /** Enables or disables selecting the animation style for the popup list. Animation types can be selected through either of the following options, - * @Default {slide} - */ - animateType?: ej.Autocomplete.Animation|string; - - /** To focus the items in the suggestion list when the popup is shown. By default first item will be focused. - * @Default {false} - */ - autoFocus?: boolean; - - /** Enables or disables the case sensitive search. - * @Default {false} - */ - caseSensitiveSearch?: boolean; - - /** The root class for the Autocomplete textbox widget which helps in customizing its theme. - * @Default {Ă¢â‚¬ÂĂ¢â‚¬Â} - */ - cssClass?: string; - - /** The data source contains the list of data for the suggestions list. It can be a string array or JSON array. - * @Default {null} - */ - dataSource?: any|any[]; - - /** The time delay (in milliseconds) after which the suggestion popup will be shown. - * @Default {200} - */ - delaySuggestionTimeout?: number; - - /** The special character which acts as a separator for the given words for multi-mode search i.e. the text after the delimiter are considered as a separate word or query for search operation. - * @Default {Ă¢â‚¬â„¢,Ă¢â‚¬â„¢} - */ - delimiterChar?: string; - - /** The text to be displayed in the popup when there are no suggestions available for the entered text. - * @Default {Ă¢â‚¬Å“No suggestionsĂ¢â‚¬Â} - */ - emptyResultText?: string; - - /** Fills the autocomplete textbox with the first matched item from the suggestion list automatically based on the entered text when enabled. - * @Default {false} - */ - enableAutoFill?: boolean; - - /** Enables or disables the Autocomplete textbox widget. - * @Default {true} - */ - enabled?: boolean; - - /** Enables or disables displaying the duplicate names present in the search result. - * @Default {false} - */ - enableDistinct?: boolean; - - /** Allows the current model values to be saved in local storage or browser cookies for state maintenance - * when it is set to true. - * While refreshing the page, it retains the model value from browser cookies or local storage. - * @Default {false} - */ - enablePersistence?: boolean; - - /** Displays the Autocomplete widgetĂ¢â‚¬â„¢s content from right to left when enabled. - * @Default {false} - */ - enableRTL?: boolean; - - /** Mapping fields for the suggestion items of the Autocomplete textbox widget. - * @Default {null} - */ - fields?: Fields; - - /** Specifies the search filter type. - * There are several types of search filter available such as Ă¢â‚¬ËœstartswithĂ¢â‚¬â„¢, - * Ă¢â‚¬ËœcontainsĂ¢â‚¬â„¢, Ă¢â‚¬ËœendswithĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœgreaterthanĂ¢â‚¬â„¢, - * Ă¢â‚¬ËœgreaterthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœnotequalĂ¢â‚¬â„¢. - * @Default {ej.filterType.StartsWith} - */ - filterType?: string; - - /** The height of the Autocomplete textbox. - * @Default {null} - */ - height?: string|number; - - /** The search text can be highlighted in the AutoComplete suggestion list when enabled. - * @Default {false} - */ - highlightSearch?: boolean; - - /** Number of items to be displayed in the suggestion list. - * @Default {0} - */ - itemsCount?: number; - - /** Set the localization culture for Autocomplete Widget. - */ - locale?: string; - - /** Minimum number of character to be entered in the Autocomplete textbox to show the suggestion list. - * @Default {1} - */ - minCharacter?: number; - - /** An Autocomplete column collection can be defined and customized through the multiColumnSettings property.Column's header, field, and stringFormat can be define via multiColumnSettings properties. - */ - multiColumnSettings?: MultiColumnSettings; - - /** Enables or disables selecting multiple values from the suggestion list. Multiple values can be selected through either of the following options, - * @Default {ej.MultiSelectMode.None} - */ - multiSelectMode?: ej.Autocomplete.MultiSelectMode|string; - - /** The height of the suggestion list. - * @Default {Ă¢â‚¬Å“152pxĂ¢â‚¬Â} - */ - popupHeight?: string; - - /** The width of the suggestion list. - * @Default {Ă¢â‚¬Å“autoĂ¢â‚¬Â} - */ - popupWidth?: string; - - /** The query to retrieve the data from the data source. - * @Default {null} - */ - query?: ej.Query; - - /** Indicates that the autocomplete textbox values can only be readable. - * @Default {false} - */ - readOnly?: boolean; - - /** Sets the value for the Autocomplete textbox based on the given input key value. - */ - selectValueByKey?: number; - - /** Enables or disables showing the message when there are no suggestions for the entered text. - * @Default {true} - */ - showEmptyResultText?: boolean; - - /** Enables or disables the loading icon to intimate the searching operation. The loading icon is visible when there is a time delay to perform the search. - * @Default {true} - */ - showLoadingIcon?: boolean; - - /** Enables the showPopup button in autocomplete textbox. When the showPopup button is clicked, it displays all the available data from the data source. - * @Default {false} - */ - showPopupButton?: boolean; - - /** Enables or disables rounded corner. - * @Default {false} - */ - showRoundedCorner?: boolean; - - /** Enables or disables reset icon to clear the textbox values. - * @Default {false} - */ - showResetIcon?: boolean; - - /** Sort order specifies whether the suggestion list values has to be displayed in ascending or descending order. - * @Default {ej.SortOrder.Ascending} - */ - sortOrder?: ej.Autocomplete.SortOrder|string; - - /** The template to display the suggestion list items with customized appearance. - * @Default {null} - */ - template?: string; - - /** The jQuery validation error message to be displayed on form validation. - * @Default {null} - */ - validationMessage?: any; - - /** The jQuery validation rules for form validation. - * @Default {null} - */ - validationRules?: any; - - /** The value to be displayed in the autocomplete textbox. - * @Default {null} - */ - value?: string; - - /** Enables or disables the visibility of the autocomplete textbox. - * @Default {true} - */ - visible?: boolean; - - /** The text to be displayed when the value of the autocomplete textbox is empty. - * @Default {null} - */ - watermarkText?: string; - - /** The width of the Autocomplete textbox. - * @Default {null} - */ - width?: string|number; - - /** Triggers when the AJAX requests Begins. */ - actionBegin?(e: ActionBeginEventArgs): void; - - /** Triggers when the data requested from AJAX will get successfully loaded in the Autocomplete widget. */ - actionSuccess?(e: ActionSuccessEventArgs): void; - - /** Triggers when the AJAX requests complete. The request may get failed or succeed. */ - actionComplete?(e: ActionCompleteEventArgs): void; - - /** Triggers when the data requested from AJAX get failed. */ - actionFailure?(e: ActionFailureEventArgs): void; - - /** Triggers when the text box value is changed. */ - change?(e: ChangeEventArgs): void; - - /** Triggers after the suggestion popup is closed. */ - close?(e: CloseEventArgs): void; - - /** Triggers when Autocomplete widget is created. */ - create?(e: CreateEventArgs): void; - - /** Triggers after the Autocomplete widget is destroyed. */ - destroy?(e: DestroyEventArgs): void; - - /** Triggers after the autocomplete textbox is focused. */ - focusIn?(e: FocusInEventArgs): void; - - /** Triggers after the Autocomplete textbox gets out of the focus. */ - focusOut?(e: FocusOutEventArgs): void; - - /** Triggers after the suggestion list is opened. */ - open?(e: OpenEventArgs): void; - - /** Triggers when an item has been selected from the suggestion list. */ - select?(e: SelectEventArgs): void; -} - -export interface ActionBeginEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; -} - -export interface ActionSuccessEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** It specifies the type of data is send in the query string. + */ + contentType?: string; + + /** It specifies the data as an object, will be passed in the query string. + */ + data?: any; + + /** It specifies the type of data that you're expecting back from the response. + */ + dataType?: string; + + /** It specifies the HTTP request type. + */ + type?: string; + } + + export interface CustomIcon { + + /** This class name set to collapsing header. + */ + header?: string; + + /** This class name set to expanded (active) header. + */ + selectedHeader?: string; + } + + enum HeightAdjustMode { + + ///Height fit to the content in the panel + Content, + + ///Height set to the largest content in the panel + Auto, + + ///Height filled to the content of the panel + Fill + } + + } + + class Autocomplete extends ej.Widget { + static fn: Autocomplete; + constructor(element: JQuery | Element, options?: Autocomplete.Model); + static Locale: any; + model: Autocomplete.Model; + defaults: Autocomplete.Model; + + /** Clears the text in the Autocomplete textbox. + * @returns {void} + */ + clearText(): void; + + /** Destroys the Autocomplete widget. + * @returns {void} + */ + destroy(): void; + + /** Disables the autocomplete widget. + * @returns {void} + */ + disable(): void; + + /** Enables the autocomplete widget. + * @returns {void} + */ + enable(): void; + + /** Returns objects (data object) of all the selected items in the autocomplete textbox. + * @returns {any} + */ + getSelectedItems(): any; + + /** Returns the current selected value from the Autocomplete textbox. + * @returns {string} + */ + getValue(): string; + + /** Returns the current active text value in the Autocomplete suggestion list. + * @returns {string} + */ + getActiveText(): string; + + /** Search the entered text and show it in the suggestion list if available. + * @returns {void} + */ + search(): void; + + /** Open up the autocomplete suggestion popup with all list items. + * @returns {void} + */ + open(): void; + + /** Sets the value of the Autocomplete textbox based on the given key value. + * @param {string} The key value of the specific suggestion item. + * @returns {void} + */ + selectValueByKey(Key: string): void; + + /** Sets the value of the Autocomplete textbox based on the given input text value. + * @param {string} The text (label) value of the specific suggestion item. + * @returns {void} + */ + selectValueByText(Text: string): void; + } + export namespace Autocomplete { + + export interface Model { + + /** Customize "Add New" text (label) to be added in the autocomplete popup list for the entered text when there are no suggestions for it. + * @Default {Add New} + */ + addNewText?: boolean; + + /** Allows new values to be added to the autocomplete input other than the values in the suggestion list. + * Normally, when there are no suggestions it will display Ă¢â‚¬Å“No suggestionsĂ¢â‚¬Â label in the popup. + * @Default {false} + */ + allowAddNew?: boolean; + + /** Enables or disables the sorting of suggestion list item. The default sort order is ascending order. You customize sort order. + * @Default {true} + */ + allowSorting?: boolean; + + /** Enables or disables selecting the animation style for the popup list. Animation types can be selected through either of the following options, + * @Default {slide} + */ + animateType?: ej.Autocomplete.Animation | string; + + /** To focus the items in the suggestion list when the popup is shown. By default first item will be focused. + * @Default {false} + */ + autoFocus?: boolean; + + /** Enables or disables the case sensitive search. + * @Default {false} + */ + caseSensitiveSearch?: boolean; + + /** The root class for the Autocomplete textbox widget which helps in customizing its theme. + * @Default {Ă¢â‚¬ÂĂ¢â‚¬Â} + */ + cssClass?: string; + + /** The data source contains the list of data for the suggestions list. It can be a string array or JSON array. + * @Default {null} + */ + dataSource?: any | any[]; + + /** The time delay (in milliseconds) after which the suggestion popup will be shown. + * @Default {200} + */ + delaySuggestionTimeout?: number; + + /** The special character which acts as a separator for the given words for multi-mode search i.e. the text after the delimiter are considered as a separate word or query for search operation. + * @Default {Ă¢â‚¬â„¢,Ă¢â‚¬â„¢} + */ + delimiterChar?: string; + + /** The text to be displayed in the popup when there are no suggestions available for the entered text. + * @Default {Ă¢â‚¬Å“No suggestionsĂ¢â‚¬Â} + */ + emptyResultText?: string; + + /** Fills the autocomplete textbox with the first matched item from the suggestion list automatically based on the entered text when enabled. + * @Default {false} + */ + enableAutoFill?: boolean; + + /** Enables or disables the Autocomplete textbox widget. + * @Default {true} + */ + enabled?: boolean; + + /** Enables or disables displaying the duplicate names present in the search result. + * @Default {false} + */ + enableDistinct?: boolean; + + /** Allows the current model values to be saved in local storage or browser cookies for state maintenance + * when it is set to true. + * While refreshing the page, it retains the model value from browser cookies or local storage. + * @Default {false} + */ + enablePersistence?: boolean; + + /** Displays the Autocomplete widgetĂ¢â‚¬â„¢s content from right to left when enabled. + * @Default {false} + */ + enableRTL?: boolean; + + /** Mapping fields for the suggestion items of the Autocomplete textbox widget. + * @Default {null} + */ + fields?: Fields; + + /** Specifies the search filter type. + * There are several types of search filter available such as Ă¢â‚¬ËœstartswithĂ¢â‚¬â„¢, + * Ă¢â‚¬ËœcontainsĂ¢â‚¬â„¢, Ă¢â‚¬ËœendswithĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœgreaterthanĂ¢â‚¬â„¢, + * Ă¢â‚¬ËœgreaterthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœnotequalĂ¢â‚¬â„¢. + * @Default {ej.filterType.StartsWith} + */ + filterType?: string; + + /** The height of the Autocomplete textbox. + * @Default {null} + */ + height?: string | number; + + /** The search text can be highlighted in the AutoComplete suggestion list when enabled. + * @Default {false} + */ + highlightSearch?: boolean; + + /** Number of items to be displayed in the suggestion list. + * @Default {0} + */ + itemsCount?: number; + + /** Set the localization culture for Autocomplete Widget. + */ + locale?: string; + + /** Minimum number of character to be entered in the Autocomplete textbox to show the suggestion list. + * @Default {1} + */ + minCharacter?: number; + + /** An Autocomplete column collection can be defined and customized through the multiColumnSettings property.Column's header, field, and stringFormat can be define + * via multiColumnSettings properties. + */ + multiColumnSettings?: MultiColumnSettings; + + /** Enables or disables selecting multiple values from the suggestion list. Multiple values can be selected through either of the following options, + * @Default {ej.MultiSelectMode.None} + */ + multiSelectMode?: ej.Autocomplete.MultiSelectMode | string; + + /** The height of the suggestion list. + * @Default {Ă¢â‚¬Å“152pxĂ¢â‚¬Â} + */ + popupHeight?: string; + + /** The width of the suggestion list. + * @Default {Ă¢â‚¬Å“autoĂ¢â‚¬Â} + */ + popupWidth?: string; + + /** The query to retrieve the data from the data source. + * @Default {null} + */ + query?: ej.Query; + + /** Indicates that the autocomplete textbox values can only be readable. + * @Default {false} + */ + readOnly?: boolean; + + /** Sets the value for the Autocomplete textbox based on the given input key value. + */ + selectValueByKey?: number; + + /** Enables or disables showing the message when there are no suggestions for the entered text. + * @Default {true} + */ + showEmptyResultText?: boolean; + + /** Enables or disables the loading icon to intimate the searching operation. The loading icon is visible when there is a time delay to perform the search. + * @Default {true} + */ + showLoadingIcon?: boolean; + + /** Enables the showPopup button in autocomplete textbox. When the showPopup button is clicked, it displays all the available data from the data source. + * @Default {false} + */ + showPopupButton?: boolean; + + /** Enables or disables rounded corner. + * @Default {false} + */ + showRoundedCorner?: boolean; + + /** Enables or disables reset icon to clear the textbox values. + * @Default {false} + */ + showResetIcon?: boolean; + + /** Sort order specifies whether the suggestion list values has to be displayed in ascending or descending order. + * @Default {ej.SortOrder.Ascending} + */ + sortOrder?: ej.Autocomplete.SortOrder | string; + + /** The template to display the suggestion list items with customized appearance. + * @Default {null} + */ + template?: string; + + /** The jQuery validation error message to be displayed on form validation. + * @Default {null} + */ + validationMessage?: any; + + /** The jQuery validation rules for form validation. + * @Default {null} + */ + validationRules?: any; + + /** The value to be displayed in the autocomplete textbox. + * @Default {null} + */ + value?: string; + + /** Enables or disables the visibility of the autocomplete textbox. + * @Default {true} + */ + visible?: boolean; + + /** The text to be displayed when the value of the autocomplete textbox is empty. + * @Default {null} + */ + watermarkText?: string; + + /** The width of the Autocomplete textbox. + * @Default {null} + */ + width?: string | number; + + /** Triggers when the AJAX requests Begins. */ + actionBegin?(e: ActionBeginEventArgs): void; + + /** Triggers when the data requested from AJAX will get successfully loaded in the Autocomplete widget. */ + actionSuccess?(e: ActionSuccessEventArgs): void; + + /** Triggers when the AJAX requests complete. The request may get failed or succeed. */ + actionComplete?(e: ActionCompleteEventArgs): void; + + /** Triggers when the data requested from AJAX get failed. */ + actionFailure?(e: ActionFailureEventArgs): void; + + /** Triggers when the text box value is changed. */ + change?(e: ChangeEventArgs): void; + + /** Triggers after the suggestion popup is closed. */ + close?(e: CloseEventArgs): void; + + /** Triggers when Autocomplete widget is created. */ + create?(e: CreateEventArgs): void; + + /** Triggers after the Autocomplete widget is destroyed. */ + destroy?(e: DestroyEventArgs): void; + + /** Triggers after the autocomplete textbox is focused. */ + focusIn?(e: FocusInEventArgs): void; + + /** Triggers after the Autocomplete textbox gets out of the focus. */ + focusOut?(e: FocusOutEventArgs): void; + + /** Triggers after the suggestion list is opened. */ + open?(e: OpenEventArgs): void; + + /** Triggers when an item has been selected from the suggestion list. */ + select?(e: SelectEventArgs): void; + } + + export interface ActionBeginEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; + } + + export interface ActionSuccessEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface ActionCompleteEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; -} + export interface ActionCompleteEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface ActionFailureEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; -} + export interface ActionFailureEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface ChangeEventArgs { + export interface ChangeEventArgs { - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the autocomplete model object. - */ - model?: ej.Autocomplete.Model; + /** Instance of the autocomplete model object. + */ + model?: ej.Autocomplete.Model; - /** Name of the event. - */ - type?: string; + /** Name of the event. + */ + type?: string; - /** Value of the autocomplete textbox. - */ - value?: string; -} + /** Value of the autocomplete textbox. + */ + value?: string; + } -export interface CloseEventArgs { + export interface CloseEventArgs { - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the autocomplete model object. - */ - model?: ej.Autocomplete.Model; + /** Instance of the autocomplete model object. + */ + model?: ej.Autocomplete.Model; - /** Name of the event. - */ - type?: string; -} + /** Name of the event. + */ + type?: string; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the autocomplete model object. - */ - model?: ej.Autocomplete.Model; + /** Instance of the autocomplete model object. + */ + model?: ej.Autocomplete.Model; - /** Name of the event. - */ - type?: string; -} + /** Name of the event. + */ + type?: string; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the autocomplete model object. - */ - model?: ej.Autocomplete.Model; + /** Instance of the autocomplete model object. + */ + model?: ej.Autocomplete.Model; - /** Name of the event. - */ - type?: string; -} + /** Name of the event. + */ + type?: string; + } -export interface FocusInEventArgs { + export interface FocusInEventArgs { - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the autocomplete model object. - */ - model?: ej.Autocomplete.Model; + /** Instance of the autocomplete model object. + */ + model?: ej.Autocomplete.Model; - /** Name of the event. - */ - type?: string; + /** Name of the event. + */ + type?: string; - /** Value of the autocomplete textbox. - */ - value?: string; -} + /** Value of the autocomplete textbox. + */ + value?: string; + } -export interface FocusOutEventArgs { + export interface FocusOutEventArgs { - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the autocomplete model object. - */ - model?: ej.Autocomplete.Model; + /** Instance of the autocomplete model object. + */ + model?: ej.Autocomplete.Model; - /** Name of the event. - */ - type?: string; + /** Name of the event. + */ + type?: string; - /** Value of the autocomplete textbox. - */ - value?: string; -} + /** Value of the autocomplete textbox. + */ + value?: string; + } -export interface OpenEventArgs { + export interface OpenEventArgs { - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the autocomplete model object. - */ - model?: ej.Autocomplete.Model; + /** Instance of the autocomplete model object. + */ + model?: ej.Autocomplete.Model; - /** Name of the event. - */ - type?: string; -} + /** Name of the event. + */ + type?: string; + } -export interface SelectEventArgs { + export interface SelectEventArgs { - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the autocomplete model object. - */ - model?: ej.Autocomplete.Model; + /** Instance of the autocomplete model object. + */ + model?: ej.Autocomplete.Model; - /** Name of the event. - */ - type?: string; + /** Name of the event. + */ + type?: string; - /** Value of the autocomplete textbox. - */ - value?: string; + /** Value of the autocomplete textbox. + */ + value?: string; - /** Text of the selected item. - */ - text?: string; + /** Text of the selected item. + */ + text?: string; - /** Key of the selected item. - */ - key?: string; + /** Key of the selected item. + */ + key?: string; - /** Data object of the selected item. - */ - Item?: ej.Autocomplete.Model; -} + /** Data object of the selected item. + */ + Item?: ej.Autocomplete.Model; + } -export interface Fields { + export interface Fields { - /** Used to group the suggestion list items. - */ - groupBy?: string; + /** Used to group the suggestion list items. + */ + groupBy?: string; - /** Defines the HTML attributes such as id, class, styles for the item. - */ - htmlAttributes?: any; + /** Defines the HTML attributes such as id, class, styles for the item. + */ + htmlAttributes?: any; - /** Defines the specific field name which contains unique key values for the list items. - */ - key?: string; + /** Defines the specific field name which contains unique key values for the list items. + */ + key?: string; - /** Defines the specific field name in the data source to load the suggestion list with data. - */ - text?: string; -} + /** Defines the specific field name in the data source to load the suggestion list with data. + */ + text?: string; + } -export interface MultiColumnSettingsColumn { + export interface MultiColumnSettingsColumn { - /** Get or set a value that indicates to display the columns in the autocomplete mapping with column name of the dataSource. - */ - field?: string; + /** Get or set a value that indicates to display the columns in the autocomplete mapping with column name of the dataSource. + */ + field?: string; - /** Get or set a value that indicates to display the title of that particular column. - */ - headerText?: string; + /** Get or set a value that indicates to display the title of that particular column. + */ + headerText?: string; - /** Gets or sets a value that indicates to render the multicolumn with custom theme. - */ - cssClass?: string; + /** Gets or sets a value that indicates to render the multicolumn with custom theme. + */ + cssClass?: string; - /** Specifies the search data type. There are four types of data types available such as string, Ă¢â‚¬ËœnumberĂ¢â‚¬â„¢, Ă¢â‚¬ËœbooleanĂ¢â‚¬â„¢ and Ă¢â‚¬ËœdateĂ¢â‚¬â„¢. - * @Default {ej.Type.String} - */ - type?: ej.Type|string; + /** Specifies the search data type. There are four types of data types available such as string, Ă¢â‚¬ËœnumberĂ¢â‚¬â„¢, Ă¢â‚¬ËœbooleanĂ¢â‚¬â„¢ and Ă¢â‚¬ËœdateĂ¢â‚¬â„¢. + * @Default {ej.Type.String} + */ + type?: ej.Type | string; - /** Specifies the search filter type. There are several types of search filter available such as Ă¢â‚¬ËœstartswithĂ¢â‚¬â„¢, - * Ă¢â‚¬ËœcontainsĂ¢â‚¬â„¢, Ă¢â‚¬ËœendswithĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœgreaterthanĂ¢â‚¬â„¢, - * Ă¢â‚¬ËœgreaterthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœnotequalĂ¢â‚¬â„¢. - * @Default {ej.filterType.StartsWith} - */ - filterType?: ej.filterType|string; + /** Specifies the search filter type. There are several types of search filter available such as Ă¢â‚¬ËœstartswithĂ¢â‚¬â„¢, + * Ă¢â‚¬ËœcontainsĂ¢â‚¬â„¢, Ă¢â‚¬ËœendswithĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanĂ¢â‚¬â„¢, Ă¢â‚¬ËœlessthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœgreaterthanĂ¢â‚¬â„¢, + * Ă¢â‚¬ËœgreaterthanorequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœequalĂ¢â‚¬â„¢, Ă¢â‚¬ËœnotequalĂ¢â‚¬â„¢. + * @Default {ej.filterType.StartsWith} + */ + filterType?: ej.filterType | string; - /** This defines the text alignment of a particular column header cell value. See headerTextAlign - * @Default {ej.TextAlign.Left} - */ - headerTextAlign?: ej.TextAlign|string; + /** This defines the text alignment of a particular column header cell value. See headerTextAlign + * @Default {ej.TextAlign.Left} + */ + headerTextAlign?: ej.TextAlign | string; - /** Gets or sets a value that indicates to align the text within the column. See textAlign - * @Default {ej.TextAlign.Left} - */ - textAlign?: ej.TextAlign|string; -} + /** Gets or sets a value that indicates to align the text within the column. See textAlign + * @Default {ej.TextAlign.Left} + */ + textAlign?: ej.TextAlign | string; + } -export interface MultiColumnSettings { + export interface MultiColumnSettings { - /** Allow list of data to be displayed in several columns. - * @Default {false} - */ - enable?: boolean; + /** Allow list of data to be displayed in several columns. + * @Default {false} + */ + enable?: boolean; - /** Allow header text to be displayed in corresponding columns. - * @Default {true} - */ - showHeader?: boolean; + /** Allow header text to be displayed in corresponding columns. + * @Default {true} + */ + showHeader?: boolean; - /** Displayed selected value and autocomplete search based on mentioned column value specified in that format. - */ - stringFormat?: string; - - /** Field and Header Text collections can be defined and customized through columns field. - */ - columns?: MultiColumnSettingsColumn[]; -} - -enum Animation { + /** Displayed selected value and autocomplete search based on mentioned column value specified in that format. + */ + stringFormat?: string; + + /** Field and Header Text collections can be defined and customized through columns field. + */ + columns?: MultiColumnSettingsColumn[]; + } + + enum Animation { - ///Supports to animation type with none type only. - None, - - ///Supports to animation type with slide type only. - Slide, - - ///Supports to animation type with fade type only. - Fade -} - - -enum MultiSelectMode { - - ///Multiple values are separated using a given special character. - Delimiter, - - ///Each values are displayed in separate box with close button. - VisualMode -} - - -enum SortOrder { - - ///Items to be displayed in the suggestion list in ascending order. - Ascending, - - ///Items to be displayed in the suggestion list in descending order. - Descending -} - -} - -class Button extends ej.Widget { - static fn: Button; - constructor(element: JQuery | Element, options?: Button.Model); - static Locale: any; - model: Button.Model; - defaults: Button.Model; - - /** destroy the button widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. - * @returns {void} - */ - destroy(): void; - - /** To disable the button - * @returns {void} - */ - disable(): void; - - /** To enable the button - * @returns {void} - */ - enable(): void; -} -export namespace Button { - -export interface Model { - - /** Specifies the contentType of the Button. See below to know available ContentType - * @Default {ej.ContentType.TextOnly} - */ - contentType?: ej.ContentType|string; - - /** Sets the root CSS class for Button theme, which is used customize. - */ - cssClass?: string; - - /** Specifies the button control state. - * @Default {true} - */ - enabled?: boolean; - - /** Specify the Right to Left direction to button - * @Default {false} - */ - enableRTL?: boolean; + ///Supports to animation type with none type only. + None, + + ///Supports to animation type with slide type only. + Slide, + + ///Supports to animation type with fade type only. + Fade + } + + + enum MultiSelectMode { + + ///Multiple values are separated using a given special character. + Delimiter, + + ///Each values are displayed in separate box with close button. + VisualMode + } + + + enum SortOrder { + + ///Items to be displayed in the suggestion list in ascending order. + Ascending, + + ///Items to be displayed in the suggestion list in descending order. + Descending + } + + } + + class Button extends ej.Widget { + static fn: Button; + constructor(element: JQuery | Element, options?: Button.Model); + static Locale: any; + model: Button.Model; + defaults: Button.Model; + + /** destroy the button widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. + * @returns {void} + */ + destroy(): void; + + /** To disable the button + * @returns {void} + */ + disable(): void; + + /** To enable the button + * @returns {void} + */ + enable(): void; + } + export namespace Button { + + export interface Model { + + /** Specifies the contentType of the Button. See below to know available ContentType + * @Default {ej.ContentType.TextOnly} + */ + contentType?: ej.ContentType | string; + + /** Sets the root CSS class for Button theme, which is used customize. + */ + cssClass?: string; + + /** Specifies the button control state. + * @Default {true} + */ + enabled?: boolean; + + /** Specify the Right to Left direction to button + * @Default {false} + */ + enableRTL?: boolean; - /** Specifies the height of the Button. - * @Default {28} - */ - height?: number; - - /** It allows to define the characteristics of the Button control. It will helps to extend the capability of an HTML element. - * @Default {{}} - */ - htmlAttributes?: any; - - /** Specifies the image position of the Button. This image position is applicable - * only with the textandimage contentType property. The images can be positioned in both - * imageLeft and imageRight options. See below to know about available ImagePosition - * @Default {ej.ImagePosition.ImageLeft} - */ - imagePosition?: ej.ImagePosition|string; - - /** Specifies the primary icon for Button. This icon will be displayed from the left margin of the button. - * @Default {null} - */ - prefixIcon?: string; - - /** Convert the button as repeat button. It raises the 'Click' event repeatedly from the it is pressed until it is released. - * @Default {false} - */ - repeatButton?: boolean; - - /** Displays the Button with rounded corners. - * @Default {false} - */ - showRoundedCorner?: boolean; - - /** Specifies the size of the Button. See below to know available ButtonSize - * @Default {ej.ButtonSize.Normal} - */ - size?: ej.ButtonSize|string; - - /** Specifies the secondary icon for Button. This icon will be displayed from the right margin of the button. - * @Default {null} - */ - suffixIcon?: string; - - /** Specifies the text content for Button. - * @Default {null} - */ - text?: string; - - /** Specified the time interval between two consecutive 'click' event on the button. - * @Default {150} - */ - timeInterval?: string; - - /** Specifies the Type of the Button. See below to know available ButtonType - * @Default {ej.ButtonType.Submit} - */ - type?: ej.ButtonType|string; - - /** Specifies the width of the Button. - * @Default {100px} - */ - width?: string|number; - - /** Fires when Button control is clicked successfully.Consider the scenario to perform any validation, - * modification of content or any other operations click on button,we can make use of this click event - * to achieve the scenario. - */ - click?(e: ClickEventArgs): void; - - /** Fires after Button control is created.If the user want to perform any operation after the button control creation then the user can make use of this create event. */ - create?(e: CreateEventArgs): void; - - /** Fires when the button is destroyed successfully.If the user want to perform any operation after the destroy button control then the user can make use of this destroy event. */ - destroy?(e: DestroyEventArgs): void; -} - -export interface ClickEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the button model - */ - model?: ej.Button.Model; - - /** returns the name of the event - */ - type?: string; - - /** return the button state - */ - status?: boolean; - - /** return the event model for sever side processing. - */ - e?: any; -} - -export interface CreateEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the button model - */ - model?: ej.Button.Model; - - /** returns the name of the event - */ - type?: string; -} - -export interface DestroyEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the button model - */ - model?: ej.Button.Model; - - /** returns the name of the event - */ - type?: string; -} -} -enum ContentType { -//To display the text content only in button -TextOnly, -//To display the image only in button -ImageOnly, -//Supports to display image for both ends of the button -ImageBoth, -//Supports to display image with the text content -TextAndImage, -//Supports to display image with both ends of the text -ImageTextImage, -} -enum ImagePosition { -//support for aligning text in left and image in right -ImageRight, -//support for aligning text in right and image in left -ImageLeft, -//support for aligning text in bottom and image in top. -ImageTop, -//support for aligning text in top and image in bottom -ImageBottom, -} -enum ButtonSize { -//Creates button with Built-in default size height, width specified -Normal, -//Creates button with Built-in mini size height, width specified -Mini, -//Creates button with Built-in small size height, width specified -Small, -//Creates button with Built-in medium size height, width specified -Medium, -//Creates button with Built-in large size height, width specified -Large, -} -enum ButtonType { -//Creates button with Built-in button type specified -Button, -//Creates button with Built-in reset type specified -Reset, -//Creates button with Built-in submit type specified -Submit, -} - -class Captcha extends ej.Widget { - static fn: Captcha; - constructor(element: JQuery | Element, options?: Captcha.Model); - static Locale: any; - model: Captcha.Model; - defaults: Captcha.Model; -} -export namespace Captcha { - -export interface Model { - - /** Specifies the character set of the Captcha that will be used to generate captcha text randomly. - */ - characterSet?: string; - - /** Specifies the error message to be displayed when the Captcha mismatch. - */ - customErrorMessage?: string; - - /** Set the Captcha validation automatically. - */ - enableAutoValidation?: boolean; - - /** Specifies the case sensitivity for the characters typed in the Captcha. - */ - enableCaseSensitivity?: boolean; - - /** Specifies the background patterns for the Captcha. - */ - enablePattern?: boolean; - - /** Sets the Captcha direction as right to left alignment. - */ - enableRTL?: boolean; - - /** Specifies the background appearance for the captcha. - */ - hatchStyle?: ej.HatchStyle|string; - - /** Specifies the height of the Captcha. - */ - height?: number; - - /** Specifies the method with values to be mapped in the Captcha. - */ - mapper?: string; - - /** Specifies the maximum number of characters used in the Captcha. - */ - maximumLength?: number; - - /** Specifies the minimum number of characters used in the Captcha. - */ - minimumLength?: number; - - /** Specifies the method to map values to Captcha. - */ - requestMapper?: string; - - /** Sets the Captcha with audio support, that enables to dictate the captcha text. - */ - showAudioButton?: boolean; - - /** Sets the Captcha with a refresh button. - */ - showRefreshButton?: boolean; - - /** Specifies the target button of the Captcha to validate the entered text and captcha text. - */ - targetButton?: string; - - /** Specifies the target input element that will verify the Captcha. - */ - targetInput?: string; - - /** Specifies the width of the Captcha. - */ - width?: number; - - /** Fires when captcha refresh begins. */ - refreshBegin?(e: RefreshBeginEventArgs): void; - - /** Fires after captcha refresh completed. */ - refreshComplete?(e: RefreshCompleteEventArgs): void; - - /** Fires when captcha refresh fails to load. */ - refreshFailure?(e: RefreshFailureEventArgs): void; - - /** Fires after captcha refresh succeeded. */ - refreshSuccess?(e: RefreshSuccessEventArgs): void; -} - -export interface RefreshBeginEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the Captcha model - */ - model?: any; - - /** returns the name of the event - */ - type?: string; -} - -export interface RefreshCompleteEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the Captcha model - */ - model?: any; - - /** returns the name of the event - */ - type?: string; -} - -export interface RefreshFailureEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the Captcha model - */ - model?: any; - - /** returns the name of the event - */ - type?: string; -} - -export interface RefreshSuccessEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the Captcha model - */ - model?: any; - - /** returns the name of the event - */ - type?: string; -} -} -enum HatchStyle { -//Set background as None to Captcha -None, -//Set background as BackwardDiagonal to Captcha -BackwardDiagonal, -//Set background as Cross to Captcha -Cross, -//Set background as DarkDownwardDiagonal to Captcha -DarkDownwardDiagonal, -//Set background as DarkHorizontal to Captcha -DarkHorizontal, -//Set background as DarkUpwardDiagonal to Captcha -DarkUpwardDiagonal, -//Set background as DarkVertical to Captcha -DarkVertical, -//Set background as DashedDownwardDiagonal to Captcha -DashedDownwardDiagonal, -//Set background as DashedHorizontal to Captcha -DashedHorizontal, -//Set background as DashedUpwardDiagonal to Captcha -DashedUpwardDiagonal, -//Set background as DashedVertical to Captcha -DashedVertical, -//Set background as DiagonalBrick to Captcha -DiagonalBrick, -//Set background as DiagonalCross to Captcha -DiagonalCross, -//Set background as Divot to Captcha -Divot, -//Set background as DottedDiamond to Captcha -DottedDiamond, -//Set background as DottedGrid to Captcha -DottedGrid, -//Set background as ForwardDiagonal to Captcha -ForwardDiagonal, -//Set background as Horizontal to Captcha -Horizontal, -//Set background as HorizontalBrick to Captcha -HorizontalBrick, -//Set background as LargeCheckerBoard to Captcha -LargeCheckerBoard, -//Set background as LargeConfetti to Captcha -LargeConfetti, -//Set background as LargeGrid to Captcha -LargeGrid, -//Set background as LightDownwardDiagonal to Captcha -LightDownwardDiagonal, -//Set background as LightHorizontal to Captcha -LightHorizontal, -//Set background as LightUpwardDiagonal to Captcha -LightUpwardDiagonal, -//Set background as LightVertical to Captcha -LightVertical, -//Set background as Max to Captcha -Max, -//Set background as Min to Captcha -Min, -//Set background as NarrowHorizontal to Captcha -NarrowHorizontal, -//Set background as NarrowVertical to Captcha -NarrowVertical, -//Set background as OutlinedDiamond to Captcha -OutlinedDiamond, -//Set background as Percent90 to Captcha -Percent90, -//Set background as Wave to Captcha -Wave, -//Set background as Weave to Captcha -Weave, -//Set background as WideDownwardDiagonal to Captcha -WideDownwardDiagonal, -//Set background as WideUpwardDiagonal to Captcha -WideUpwardDiagonal, -//Set background as ZigZag to Captcha -ZigZag, -} - -class ListBox extends ej.Widget { - static fn: ListBox; - constructor(element: JQuery | Element, options?: ListBox.Model); - static Locale: any; - model: ListBox.Model; - defaults: ListBox.Model; - - /** Adds a given list items in the ListBox widget at a specified index. It accepts two parameters. - * @param {any|string} This can be a list item object (for JSON binding) or a string (for UL and LI rendering). - * Also we can the specify this as an array of list item object or an array of strings to add multiple items. - * @param {number} The index value to add the given items at the specified index. If index is not specified, the given items will be added at the end of the list. - * @returns {void} - */ - addItem(listItem: any|string, index: number): void; - - /** Checks all the list items in the ListBox widget. It is dependent on showCheckbox property. - * @returns {void} - */ - checkAll(): void; - - /** Checks a list item by using its index. It is dependent on showCheckbox property. - * @param {number} Index of the listbox item to be checked. If index is not specified, the given items will be added at the end of the list. - * @returns {void} - */ - checkItemByIndex(index: number): void; - - /** Checks multiple list items by using its index values. It is dependent on showCheckbox property. - * @param {number[]} Index/Indices of the listbox items to be checked. If index is not specified, the given items will be added at the end of the list. - * @returns {void} - */ - checkItemsByIndices(indices: number[]): void; - - /** Disables the ListBox widget. - * @returns {void} - */ - disable(): void; - - /** Disables a list item by passing the item text as parameter. - * @param {string} Text of the listbox item to be disabled. - * @returns {void} - */ - disableItem(text: string): void; - - /** Disables a list Item using its index value. - * @param {number} Index of the listbox item to be disabled. - * @returns {void} - */ - disableItemByIndex(index: number): void; - - /** Disables set of list Items using its index values. - * @param {number[]|string} Indices of the listbox items to be disabled. - * @returns {void} - */ - disableItemsByIndices(Indices: number[]|string): void; - - /** Enables the ListBox widget when it is disabled. - * @returns {void} - */ - enable(): void; - - /** Enables a list Item using its item text value. - * @param {string} Text of the listbox item to be enabled. - * @returns {void} - */ - enableItem(text: string): void; - - /** Enables a list item using its index value. - * @param {number} Index of the listbox item to be enabled. - * @returns {void} - */ - enableItemByIndex(index: number): void; - - /** Enables a set of list Items using its index values. - * @param {number[]|string} Indices of the listbox items to be enabled. - * @returns {void} - */ - enableItemsByIndices(indices: number[]|string): void; - - /** Returns the list of checked items in the ListBox widget. It is dependent on showCheckbox property. - * @returns {any} - */ - getCheckedItems(): any; - - /** Returns the list of selected items in the ListBox widget. - * @returns {any} - */ - getSelectedItems(): any; - - /** Returns an itemĂ¢â‚¬â„¢s index based on the given text. - * @param {string} The list item text (label) - * @returns {number} - */ - getIndexByText(text: string): number; - - /** Returns an itemĂ¢â‚¬â„¢s index based on the value given. - * @param {string} The list itemĂ¢â‚¬â„¢s value - * @returns {number} - */ - getIndexByValue(indices: string): number; - - /** Returns an itemĂ¢â‚¬â„¢s text (label) based on the index given. - * @returns {string} - */ - getTextByIndex(): string; - - /** Returns a list itemĂ¢â‚¬â„¢s object using its index. - * @returns {any} - */ - getItemByIndex(): any; - - /** Returns a list itemĂ¢â‚¬â„¢s object based on the text given. - * @param {string} The list item text. - * @returns {any} - */ - getItemByText(text: string): any; - - /** Merges the given data with the existing data items in the listbox. - * @param {Array} Data to merge in listbox. - * @returns {void} - */ - mergeData(data: any[]): void; - - /** Selects the next item based on the current selection. - * @returns {void} - */ - moveDown(): void; - - /** Selects the previous item based on the current selection. - * @returns {void} - */ - moveUp(): void; - - /** Refreshes the ListBox widget. - * @param {boolean} Refreshes both the datasource and the dimensions of the ListBox widget when the parameter is passed as true, otherwise only the ListBox dimensions will be refreshed. - * @returns {void} - */ - refresh(refreshData: boolean): void; - - /** Removes all the list items from listbox. - * @returns {void} - */ - removeAll(): void; - - /** Removes the selected list items from the listbox. - * @returns {void} - */ - removeSelectedItems(): void; - - /** Removes a list item by using its text. - * @param {string} Text of the listbox item to be removed. - * @returns {void} - */ - removeItemByText(text: string): void; - - /** Removes a list item by using its index value. - * @param {number} Index of the listbox item to be removed. - * @returns {void} - */ - removeItemByIndex(index: number): void; - - /** - * @returns {void} - */ - selectAll(): void; - - /** Selects the list item using its text value. - * @param {string} Text of the listbox item to be selected. - * @returns {void} - */ - selectItemByText(text: string): void; - - /** Selects list item using its value property. - * @param {string} Value of the listbox item to be selected. - * @returns {void} - */ - selectItemByValue(value: string): void; - - /** Selects list item using its index value. - * @param {number} Index of the listbox item to be selected. - * @returns {void} - */ - selectItemByIndex(index: number): void; - - /** Selects a set of list items through its index values. - * @param {number|number[]} Index/Indices of the listbox item to be selected. - * @returns {void} - */ - selectItemsByIndices(Indices: number|number[]): void; - - /** Unchecks all the checked list items in the ListBox widget. To use this method showCheckbox property to be set as true. - * @returns {void} - */ - uncheckAll(): void; - - /** Unchecks a checked list item using its index value. To use this method showCheckbox property to be set as true. - * @param {number} Index of the listbox item to be unchecked. - * @returns {void} - */ - uncheckItemByIndex(index: number): void; - - /** Unchecks the set of checked list items using its index values. To use this method showCheckbox property must be set to true. - * @param {number[]|string} Indices of the listbox item to be unchecked. - * @returns {void} - */ - uncheckItemsByIndices(indices: number[]|string): void; - - /** - * @returns {void} - */ - unselectAll(): void; - - /** Unselects a selected list item using its index value - * @param {number} Index of the listbox item to be unselected. - * @returns {void} - */ - unselectItemByIndex(index: number): void; - - /** Unselects a selected list item using its text value. - * @param {string} Text of the listbox item to be unselected. - * @returns {void} - */ - unselectItemByText(text: string): void; - - /** Unselects a selected list item using its value. - * @param {string} Value of the listbox item to be unselected. - * @returns {void} - */ - unselectItemByValue(value: string): void; - - /** Unselects a set of list items using its index values. - * @param {number[]|string} Indices of the listbox item to be unselected. - * @returns {void} - */ - unselectItemsByIndices(indices: number[]|string): void; - - /** Hides all the checked items in the listbox. - * @returns {void} - */ - hideCheckedItems(): void; - - /** Shows a set of hidden list Items using its index values. - * @param {number[]|string} Indices of the listbox items to be shown. - * @returns {void} - */ - showItemByIndices(indices: number[]|string): void; - - /** Hides a set of list Items using its index values. - * @param {number[]|string} Indices of the listbox items to be hidden. - * @returns {void} - */ - hideItemsByIndices(indices: number[]|string): void; - - /** Shows the hidden list items using its values. - * @param {Array} Values of the listbox items to be shown. - * @returns {void} - */ - showItemsByValues(values: any[]): void; - - /** Hides the list item using its values. - * @param {Array} Values of the listbox items to be hidden. - * @returns {void} - */ - hideItemsByValues(values: any[]): void; - - /** Shows a hidden list item using its value. - * @param {string} Value of the listbox item to be shown. - * @returns {void} - */ - showItemByValue(value: string): void; - - /** Hide a list item using its value. - * @param {string} Value of the listbox item to be hidden. - * @returns {void} - */ - hideItemByValue(value: string): void; - - /** Shows a hidden list item using its index value. - * @param {number} Index of the listbox item to be shown. - * @returns {void} - */ - showItemByIndex(index: number): void; - - /** Hides a list item using its index value. - * @param {number} Index of the listbox item to be hidden. - * @returns {void} - */ - hideItemByIndex(index: number): void; - - /** - * @returns {void} - */ - show(): void; - - /** Hides the listbox. - * @returns {void} - */ - hide(): void; - - /** Hides all the listbox items in the listbox. - * @returns {void} - */ - hideAllItems(): void; - - /** Shows all the listbox items in the listbox. - * @returns {void} - */ - showAllItems(): void; -} -export namespace ListBox { - -export interface Model { - - /** Enables/disables the dragging behavior of the items in ListBox widget. - * @Default {false} - */ - allowDrag?: boolean; - - /** Accepts the items which are dropped in to it, when it is set to true. - * @Default {false} - */ - allowDrop?: boolean; - - /** Enables or disables multiple selection. - * @Default {false} - */ - allowMultiSelection?: boolean; - - /** Loads the list data on demand via scrolling behavior to improve the applicationĂ¢â‚¬â„¢s performance. There are two ways to load data which can be defined using Ă¢â‚¬Å“virtualScrollModeĂ¢â‚¬Â property. - * @Default {false} - */ - allowVirtualScrolling?: boolean; - - /** Enables or disables the case sensitive search for list item by typing the text (search) value. - * @Default {false} - */ - caseSensitiveSearch?: boolean; - - /** Dynamically populate data of a list box while selecting an item in another list box i.e. - * rendering child list box based on the item selection in parent list box. - * This property accepts the id of the child ListBox widget to populate the data. - * @Default {null} - */ - cascadeTo?: string; - - /** Set of list items to be checked by default using its index. It works only when the showCheckbox property is set to true. - * @Default {null} - */ - checkedIndices?: any[]; - - /** The root class for the ListBox widget to customize the existing theme. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - cssClass?: string; - - /** Contains the list of data for generating the list items. - * @Default {null} - */ - dataSource?: any; - - /** Enables or disables the ListBox widget. - * @Default {true} - */ - enabled?: boolean; - - /** Enables or disables the search behavior to find the specific list item by typing the text value. - * @Default {false} - */ - enableIncrementalSearch?: boolean; - - /** Allows the current model values to be saved in local storage or browser cookies for state maintenance when it is set to true. - * @Default {false} - */ - enablePersistence?: boolean; - - /** Displays the ListBox widgetĂ¢â‚¬â„¢s content from right to left when enabled. - * @Default {false} - */ - enableRTL?: boolean; - - /** Specifies ellipsis ("...") representation in an overflowed list item content when it is set to false. - * @Default {true} - */ - enableWordWrap?: boolean; - - /** Mapping fields for the data items of the ListBox widget. - * @Default {null} - */ - fields?: Fields; - - /** Defines the height of the ListBox widget. - * @Default {null} - */ - height?: string; - - /** Defines the height for individual ListBox item. - * @Default {null} - */ - itemHeight?: string; - - /** The number of list items to be shown in the ListBox widget. The remaining list items will be scrollable. - * @Default {null} - */ - itemsCount?: number; - - /** The total number of list items to be rendered in the ListBox widget. - * @Default {null} - */ - totalItemsCount?: number; - - /** The number of list items to be loaded in the list box while enabling virtual scrolling and when virtualScrollMode is set to continuous. - * @Default {5} - */ - itemRequestCount?: number; - - /** Loads data for the listbox by default (i.e. on initialization) when it is set to true. It creates empty ListBox if it is set to false. - */ - loadDataOnInit?: boolean; - - /** The query to retrieve required data from the data source. - * @Default {ej.Query()} - */ - query?: ej.Query; - - /** The list item to be selected by default using its index. - * @Default {null} - */ - selectedIndex?: number; - - /** The list items to be selected by default using its indices. To use this property allowMultiSelection should be enabled. - * @Default {[]} - */ - selectedIndices?: any[]; - - /** Enables/Disables the multi selection option with the help of checkbox control. - * @Default {false} - */ - showCheckbox?: boolean; - - /** To display the ListBox container with rounded corners. - * @Default {false} - */ - showRoundedCorner?: boolean; - - /** The template to display the ListBox widget with customized appearance. - * @Default {null} - */ - template?: string; - - /** Holds the selected items values and used to bind value to the list item using AngularJS and KnockoutJS. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - value?: number; - - /** Specifies the virtual scroll mode to load the list data on demand via scrolling behavior. There are two types of mode. - */ - virtualScrollMode?: ej.VirtualScrollMode|string; - - /** Defines the width of the ListBox widget. - * @Default {null} - */ - width?: string; - - /** Specifies the targetID for the listbox items. - */ - targetID?: string; - - /** Triggers before the AJAX request begins to load data in the ListBox widget. */ - actionBegin?(e: ActionBeginEventArgs): void; - - /** Triggers after the data requested via AJAX is successfully loaded in the ListBox widget. */ - actionSuccess?(e: ActionSuccessEventArgs): void; - - /** Triggers when the AJAX requests complete. The request may get failed or succeed. */ - actionComplete?(e: ActionCompleteEventArgs): void; - - /** Triggers when the data requested from AJAX get failed. */ - actionFailure?(e: ActionFailureEventArgs): void; - - /** Event will be triggered before the requested data via AJAX once loaded in successfully. */ - actionBeforeSuccess?(e: ActionBeforeSuccessEventArgs): void; - - /** Triggers when the item selection is changed. */ - change?(e: ChangeEventArgs): void; + /** Specifies the height of the Button. + * @Default {28} + */ + height?: number; + + /** It allows to define the characteristics of the Button control. It will helps to extend the capability of an HTML element. + * @Default {{}} + */ + htmlAttributes?: any; + + /** Specifies the image position of the Button. This image position is applicable + * only with the textandimage contentType property. The images can be positioned in both + * imageLeft and imageRight options. See below to know about available ImagePosition + * @Default {ej.ImagePosition.ImageLeft} + */ + imagePosition?: ej.ImagePosition | string; + + /** Specifies the primary icon for Button. This icon will be displayed from the left margin of the button. + * @Default {null} + */ + prefixIcon?: string; + + /** Convert the button as repeat button. It raises the 'Click' event repeatedly from the it is pressed until it is released. + * @Default {false} + */ + repeatButton?: boolean; + + /** Displays the Button with rounded corners. + * @Default {false} + */ + showRoundedCorner?: boolean; + + /** Specifies the size of the Button. See below to know available ButtonSize + * @Default {ej.ButtonSize.Normal} + */ + size?: ej.ButtonSize | string; + + /** Specifies the secondary icon for Button. This icon will be displayed from the right margin of the button. + * @Default {null} + */ + suffixIcon?: string; + + /** Specifies the text content for Button. + * @Default {null} + */ + text?: string; + + /** Specified the time interval between two consecutive 'click' event on the button. + * @Default {150} + */ + timeInterval?: string; + + /** Specifies the Type of the Button. See below to know available ButtonType + * @Default {ej.ButtonType.Submit} + */ + type?: ej.ButtonType | string; + + /** Specifies the width of the Button. + * @Default {100px} + */ + width?: string | number; + + /** Fires when Button control is clicked successfully.Consider the scenario to perform any validation, + * modification of content or any other operations click on button,we can make use of this click event + * to achieve the scenario. + */ + click?(e: ClickEventArgs): void; + + /** Fires after Button control is created.If the user want to perform any operation after the button control creation then the user can make use of this create event. */ + create?(e: CreateEventArgs): void; + + /** Fires when the button is destroyed successfully.If the user want to perform any operation after the destroy button control then the user can make use of this destroy event. */ + destroy?(e: DestroyEventArgs): void; + } + + export interface ClickEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the button model + */ + model?: ej.Button.Model; + + /** returns the name of the event + */ + type?: string; + + /** return the button state + */ + status?: boolean; + + /** return the event model for sever side processing. + */ + e?: any; + } + + export interface CreateEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the button model + */ + model?: ej.Button.Model; + + /** returns the name of the event + */ + type?: string; + } + + export interface DestroyEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the button model + */ + model?: ej.Button.Model; + + /** returns the name of the event + */ + type?: string; + } + } + enum ContentType { + //To display the text content only in button + TextOnly, + //To display the image only in button + ImageOnly, + //Supports to display image for both ends of the button + ImageBoth, + //Supports to display image with the text content + TextAndImage, + //Supports to display image with both ends of the text + ImageTextImage, + } + enum ImagePosition { + //support for aligning text in left and image in right + ImageRight, + //support for aligning text in right and image in left + ImageLeft, + //support for aligning text in bottom and image in top. + ImageTop, + //support for aligning text in top and image in bottom + ImageBottom, + } + enum ButtonSize { + //Creates button with Built-in default size height, width specified + Normal, + //Creates button with Built-in mini size height, width specified + Mini, + //Creates button with Built-in small size height, width specified + Small, + //Creates button with Built-in medium size height, width specified + Medium, + //Creates button with Built-in large size height, width specified + Large, + } + enum ButtonType { + //Creates button with Built-in button type specified + Button, + //Creates button with Built-in reset type specified + Reset, + //Creates button with Built-in submit type specified + Submit, + } + + class Captcha extends ej.Widget { + static fn: Captcha; + constructor(element: JQuery | Element, options?: Captcha.Model); + static Locale: any; + model: Captcha.Model; + defaults: Captcha.Model; + } + export namespace Captcha { + + export interface Model { + + /** Specifies the character set of the Captcha that will be used to generate captcha text randomly. + */ + characterSet?: string; + + /** Specifies the error message to be displayed when the Captcha mismatch. + */ + customErrorMessage?: string; + + /** Set the Captcha validation automatically. + */ + enableAutoValidation?: boolean; + + /** Specifies the case sensitivity for the characters typed in the Captcha. + */ + enableCaseSensitivity?: boolean; + + /** Specifies the background patterns for the Captcha. + */ + enablePattern?: boolean; + + /** Sets the Captcha direction as right to left alignment. + */ + enableRTL?: boolean; + + /** Specifies the background appearance for the captcha. + */ + hatchStyle?: ej.HatchStyle | string; + + /** Specifies the height of the Captcha. + */ + height?: number; + + /** Specifies the method with values to be mapped in the Captcha. + */ + mapper?: string; + + /** Specifies the maximum number of characters used in the Captcha. + */ + maximumLength?: number; + + /** Specifies the minimum number of characters used in the Captcha. + */ + minimumLength?: number; + + /** Specifies the method to map values to Captcha. + */ + requestMapper?: string; + + /** Sets the Captcha with audio support, that enables to dictate the captcha text. + */ + showAudioButton?: boolean; + + /** Sets the Captcha with a refresh button. + */ + showRefreshButton?: boolean; + + /** Specifies the target button of the Captcha to validate the entered text and captcha text. + */ + targetButton?: string; + + /** Specifies the target input element that will verify the Captcha. + */ + targetInput?: string; + + /** Specifies the width of the Captcha. + */ + width?: number; + + /** Fires when captcha refresh begins. */ + refreshBegin?(e: RefreshBeginEventArgs): void; + + /** Fires after captcha refresh completed. */ + refreshComplete?(e: RefreshCompleteEventArgs): void; + + /** Fires when captcha refresh fails to load. */ + refreshFailure?(e: RefreshFailureEventArgs): void; + + /** Fires after captcha refresh succeeded. */ + refreshSuccess?(e: RefreshSuccessEventArgs): void; + } + + export interface RefreshBeginEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the Captcha model + */ + model?: any; + + /** returns the name of the event + */ + type?: string; + } + + export interface RefreshCompleteEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the Captcha model + */ + model?: any; + + /** returns the name of the event + */ + type?: string; + } + + export interface RefreshFailureEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the Captcha model + */ + model?: any; + + /** returns the name of the event + */ + type?: string; + } + + export interface RefreshSuccessEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the Captcha model + */ + model?: any; + + /** returns the name of the event + */ + type?: string; + } + } + enum HatchStyle { + //Set background as None to Captcha + None, + //Set background as BackwardDiagonal to Captcha + BackwardDiagonal, + //Set background as Cross to Captcha + Cross, + //Set background as DarkDownwardDiagonal to Captcha + DarkDownwardDiagonal, + //Set background as DarkHorizontal to Captcha + DarkHorizontal, + //Set background as DarkUpwardDiagonal to Captcha + DarkUpwardDiagonal, + //Set background as DarkVertical to Captcha + DarkVertical, + //Set background as DashedDownwardDiagonal to Captcha + DashedDownwardDiagonal, + //Set background as DashedHorizontal to Captcha + DashedHorizontal, + //Set background as DashedUpwardDiagonal to Captcha + DashedUpwardDiagonal, + //Set background as DashedVertical to Captcha + DashedVertical, + //Set background as DiagonalBrick to Captcha + DiagonalBrick, + //Set background as DiagonalCross to Captcha + DiagonalCross, + //Set background as Divot to Captcha + Divot, + //Set background as DottedDiamond to Captcha + DottedDiamond, + //Set background as DottedGrid to Captcha + DottedGrid, + //Set background as ForwardDiagonal to Captcha + ForwardDiagonal, + //Set background as Horizontal to Captcha + Horizontal, + //Set background as HorizontalBrick to Captcha + HorizontalBrick, + //Set background as LargeCheckerBoard to Captcha + LargeCheckerBoard, + //Set background as LargeConfetti to Captcha + LargeConfetti, + //Set background as LargeGrid to Captcha + LargeGrid, + //Set background as LightDownwardDiagonal to Captcha + LightDownwardDiagonal, + //Set background as LightHorizontal to Captcha + LightHorizontal, + //Set background as LightUpwardDiagonal to Captcha + LightUpwardDiagonal, + //Set background as LightVertical to Captcha + LightVertical, + //Set background as Max to Captcha + Max, + //Set background as Min to Captcha + Min, + //Set background as NarrowHorizontal to Captcha + NarrowHorizontal, + //Set background as NarrowVertical to Captcha + NarrowVertical, + //Set background as OutlinedDiamond to Captcha + OutlinedDiamond, + //Set background as Percent90 to Captcha + Percent90, + //Set background as Wave to Captcha + Wave, + //Set background as Weave to Captcha + Weave, + //Set background as WideDownwardDiagonal to Captcha + WideDownwardDiagonal, + //Set background as WideUpwardDiagonal to Captcha + WideUpwardDiagonal, + //Set background as ZigZag to Captcha + ZigZag, + } + + class ListBox extends ej.Widget { + static fn: ListBox; + constructor(element: JQuery | Element, options?: ListBox.Model); + static Locale: any; + model: ListBox.Model; + defaults: ListBox.Model; + + /** Adds a given list items in the ListBox widget at a specified index. It accepts two parameters. + * @param {any|string} This can be a list item object (for JSON binding) or a string (for UL and LI rendering). + * Also we can the specify this as an array of list item object or an array of strings to add multiple items. + * @param {number} The index value to add the given items at the specified index. If index is not specified, the given items will be added at the end of the list. + * @returns {void} + */ + addItem(listItem: any | string, index: number): void; + + /** Checks all the list items in the ListBox widget. It is dependent on showCheckbox property. + * @returns {void} + */ + checkAll(): void; + + /** Checks a list item by using its index. It is dependent on showCheckbox property. + * @param {number} Index of the listbox item to be checked. If index is not specified, the given items will be added at the end of the list. + * @returns {void} + */ + checkItemByIndex(index: number): void; + + /** Checks multiple list items by using its index values. It is dependent on showCheckbox property. + * @param {number[]} Index/Indices of the listbox items to be checked. If index is not specified, the given items will be added at the end of the list. + * @returns {void} + */ + checkItemsByIndices(indices: number[]): void; + + /** Disables the ListBox widget. + * @returns {void} + */ + disable(): void; + + /** Disables a list item by passing the item text as parameter. + * @param {string} Text of the listbox item to be disabled. + * @returns {void} + */ + disableItem(text: string): void; + + /** Disables a list Item using its index value. + * @param {number} Index of the listbox item to be disabled. + * @returns {void} + */ + disableItemByIndex(index: number): void; + + /** Disables set of list Items using its index values. + * @param {number[]|string} Indices of the listbox items to be disabled. + * @returns {void} + */ + disableItemsByIndices(Indices: number[] | string): void; + + /** Enables the ListBox widget when it is disabled. + * @returns {void} + */ + enable(): void; + + /** Enables a list Item using its item text value. + * @param {string} Text of the listbox item to be enabled. + * @returns {void} + */ + enableItem(text: string): void; + + /** Enables a list item using its index value. + * @param {number} Index of the listbox item to be enabled. + * @returns {void} + */ + enableItemByIndex(index: number): void; + + /** Enables a set of list Items using its index values. + * @param {number[]|string} Indices of the listbox items to be enabled. + * @returns {void} + */ + enableItemsByIndices(indices: number[] | string): void; + + /** Returns the list of checked items in the ListBox widget. It is dependent on showCheckbox property. + * @returns {any} + */ + getCheckedItems(): any; + + /** Returns the list of selected items in the ListBox widget. + * @returns {any} + */ + getSelectedItems(): any; + + /** Returns an itemĂ¢â‚¬â„¢s index based on the given text. + * @param {string} The list item text (label) + * @returns {number} + */ + getIndexByText(text: string): number; + + /** Returns an itemĂ¢â‚¬â„¢s index based on the value given. + * @param {string} The list itemĂ¢â‚¬â„¢s value + * @returns {number} + */ + getIndexByValue(indices: string): number; + + /** Returns an itemĂ¢â‚¬â„¢s text (label) based on the index given. + * @returns {string} + */ + getTextByIndex(): string; + + /** Returns a list itemĂ¢â‚¬â„¢s object using its index. + * @returns {any} + */ + getItemByIndex(): any; + + /** Returns a list itemĂ¢â‚¬â„¢s object based on the text given. + * @param {string} The list item text. + * @returns {any} + */ + getItemByText(text: string): any; + + /** Merges the given data with the existing data items in the listbox. + * @param {Array} Data to merge in listbox. + * @returns {void} + */ + mergeData(data: any[]): void; + + /** Selects the next item based on the current selection. + * @returns {void} + */ + moveDown(): void; + + /** Selects the previous item based on the current selection. + * @returns {void} + */ + moveUp(): void; + + /** Refreshes the ListBox widget. + * @param {boolean} Refreshes both the datasource and the dimensions of the ListBox widget when the parameter is passed as true, otherwise only the ListBox dimensions will be refreshed. + * @returns {void} + */ + refresh(refreshData: boolean): void; + + /** Removes all the list items from listbox. + * @returns {void} + */ + removeAll(): void; + + /** Removes the selected list items from the listbox. + * @returns {void} + */ + removeSelectedItems(): void; + + /** Removes a list item by using its text. + * @param {string} Text of the listbox item to be removed. + * @returns {void} + */ + removeItemByText(text: string): void; + + /** Removes a list item by using its index value. + * @param {number} Index of the listbox item to be removed. + * @returns {void} + */ + removeItemByIndex(index: number): void; + + /** + * @returns {void} + */ + selectAll(): void; + + /** Selects the list item using its text value. + * @param {string} Text of the listbox item to be selected. + * @returns {void} + */ + selectItemByText(text: string): void; + + /** Selects list item using its value property. + * @param {string} Value of the listbox item to be selected. + * @returns {void} + */ + selectItemByValue(value: string): void; + + /** Selects list item using its index value. + * @param {number} Index of the listbox item to be selected. + * @returns {void} + */ + selectItemByIndex(index: number): void; + + /** Selects a set of list items through its index values. + * @param {number|number[]} Index/Indices of the listbox item to be selected. + * @returns {void} + */ + selectItemsByIndices(Indices: number | number[]): void; + + /** Unchecks all the checked list items in the ListBox widget. To use this method showCheckbox property to be set as true. + * @returns {void} + */ + uncheckAll(): void; + + /** Unchecks a checked list item using its index value. To use this method showCheckbox property to be set as true. + * @param {number} Index of the listbox item to be unchecked. + * @returns {void} + */ + uncheckItemByIndex(index: number): void; + + /** Unchecks the set of checked list items using its index values. To use this method showCheckbox property must be set to true. + * @param {number[]|string} Indices of the listbox item to be unchecked. + * @returns {void} + */ + uncheckItemsByIndices(indices: number[] | string): void; + + /** + * @returns {void} + */ + unselectAll(): void; + + /** Unselects a selected list item using its index value + * @param {number} Index of the listbox item to be unselected. + * @returns {void} + */ + unselectItemByIndex(index: number): void; + + /** Unselects a selected list item using its text value. + * @param {string} Text of the listbox item to be unselected. + * @returns {void} + */ + unselectItemByText(text: string): void; + + /** Unselects a selected list item using its value. + * @param {string} Value of the listbox item to be unselected. + * @returns {void} + */ + unselectItemByValue(value: string): void; + + /** Unselects a set of list items using its index values. + * @param {number[]|string} Indices of the listbox item to be unselected. + * @returns {void} + */ + unselectItemsByIndices(indices: number[] | string): void; + + /** Hides all the checked items in the listbox. + * @returns {void} + */ + hideCheckedItems(): void; + + /** Shows a set of hidden list Items using its index values. + * @param {number[]|string} Indices of the listbox items to be shown. + * @returns {void} + */ + showItemByIndices(indices: number[] | string): void; + + /** Hides a set of list Items using its index values. + * @param {number[]|string} Indices of the listbox items to be hidden. + * @returns {void} + */ + hideItemsByIndices(indices: number[] | string): void; + + /** Shows the hidden list items using its values. + * @param {Array} Values of the listbox items to be shown. + * @returns {void} + */ + showItemsByValues(values: any[]): void; + + /** Hides the list item using its values. + * @param {Array} Values of the listbox items to be hidden. + * @returns {void} + */ + hideItemsByValues(values: any[]): void; + + /** Shows a hidden list item using its value. + * @param {string} Value of the listbox item to be shown. + * @returns {void} + */ + showItemByValue(value: string): void; + + /** Hide a list item using its value. + * @param {string} Value of the listbox item to be hidden. + * @returns {void} + */ + hideItemByValue(value: string): void; + + /** Shows a hidden list item using its index value. + * @param {number} Index of the listbox item to be shown. + * @returns {void} + */ + showItemByIndex(index: number): void; + + /** Hides a list item using its index value. + * @param {number} Index of the listbox item to be hidden. + * @returns {void} + */ + hideItemByIndex(index: number): void; + + /** + * @returns {void} + */ + show(): void; + + /** Hides the listbox. + * @returns {void} + */ + hide(): void; + + /** Hides all the listbox items in the listbox. + * @returns {void} + */ + hideAllItems(): void; + + /** Shows all the listbox items in the listbox. + * @returns {void} + */ + showAllItems(): void; + } + export namespace ListBox { + + export interface Model { + + /** Enables/disables the dragging behavior of the items in ListBox widget. + * @Default {false} + */ + allowDrag?: boolean; + + /** Accepts the items which are dropped in to it, when it is set to true. + * @Default {false} + */ + allowDrop?: boolean; + + /** Enables or disables multiple selection. + * @Default {false} + */ + allowMultiSelection?: boolean; + + /** Loads the list data on demand via scrolling behavior to improve the applicationĂ¢â‚¬â„¢s performance. There are two ways to load data which can be defined using Ă¢â‚¬Å“virtualScrollModeĂ¢â‚¬Â property. + * @Default {false} + */ + allowVirtualScrolling?: boolean; + + /** Enables or disables the case sensitive search for list item by typing the text (search) value. + * @Default {false} + */ + caseSensitiveSearch?: boolean; + + /** Dynamically populate data of a list box while selecting an item in another list box i.e. + * rendering child list box based on the item selection in parent list box. + * This property accepts the id of the child ListBox widget to populate the data. + * @Default {null} + */ + cascadeTo?: string; + + /** Set of list items to be checked by default using its index. It works only when the showCheckbox property is set to true. + * @Default {null} + */ + checkedIndices?: any[]; + + /** The root class for the ListBox widget to customize the existing theme. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + cssClass?: string; + + /** Contains the list of data for generating the list items. + * @Default {null} + */ + dataSource?: any; + + /** Enables or disables the ListBox widget. + * @Default {true} + */ + enabled?: boolean; + + /** Enables or disables the search behavior to find the specific list item by typing the text value. + * @Default {false} + */ + enableIncrementalSearch?: boolean; + + /** Allows the current model values to be saved in local storage or browser cookies for state maintenance when it is set to true. + * @Default {false} + */ + enablePersistence?: boolean; + + /** Displays the ListBox widgetĂ¢â‚¬â„¢s content from right to left when enabled. + * @Default {false} + */ + enableRTL?: boolean; + + /** Specifies ellipsis ("...") representation in an overflowed list item content when it is set to false. + * @Default {true} + */ + enableWordWrap?: boolean; + + /** Mapping fields for the data items of the ListBox widget. + * @Default {null} + */ + fields?: Fields; + + /** Defines the height of the ListBox widget. + * @Default {null} + */ + height?: string; + + /** Defines the height for individual ListBox item. + * @Default {null} + */ + itemHeight?: string; + + /** The number of list items to be shown in the ListBox widget. The remaining list items will be scrollable. + * @Default {null} + */ + itemsCount?: number; + + /** The total number of list items to be rendered in the ListBox widget. + * @Default {null} + */ + totalItemsCount?: number; + + /** The number of list items to be loaded in the list box while enabling virtual scrolling and when virtualScrollMode is set to continuous. + * @Default {5} + */ + itemRequestCount?: number; + + /** Loads data for the listbox by default (i.e. on initialization) when it is set to true. It creates empty ListBox if it is set to false. + */ + loadDataOnInit?: boolean; + + /** The query to retrieve required data from the data source. + * @Default {ej.Query()} + */ + query?: ej.Query; + + /** The list item to be selected by default using its index. + * @Default {null} + */ + selectedIndex?: number; + + /** The list items to be selected by default using its indices. To use this property allowMultiSelection should be enabled. + * @Default {[]} + */ + selectedIndices?: any[]; + + /** Enables/Disables the multi selection option with the help of checkbox control. + * @Default {false} + */ + showCheckbox?: boolean; + + /** To display the ListBox container with rounded corners. + * @Default {false} + */ + showRoundedCorner?: boolean; + + /** The template to display the ListBox widget with customized appearance. + * @Default {null} + */ + template?: string; + + /** Holds the selected items values and used to bind value to the list item using AngularJS and KnockoutJS. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + value?: number; + + /** Specifies the virtual scroll mode to load the list data on demand via scrolling behavior. There are two types of mode. + */ + virtualScrollMode?: ej.VirtualScrollMode | string; + + /** Defines the width of the ListBox widget. + * @Default {null} + */ + width?: string; + + /** Specifies the targetID for the listbox items. + */ + targetID?: string; + + /** Triggers before the AJAX request begins to load data in the ListBox widget. */ + actionBegin?(e: ActionBeginEventArgs): void; + + /** Triggers after the data requested via AJAX is successfully loaded in the ListBox widget. */ + actionSuccess?(e: ActionSuccessEventArgs): void; + + /** Triggers when the AJAX requests complete. The request may get failed or succeed. */ + actionComplete?(e: ActionCompleteEventArgs): void; + + /** Triggers when the data requested from AJAX get failed. */ + actionFailure?(e: ActionFailureEventArgs): void; + + /** Event will be triggered before the requested data via AJAX once loaded in successfully. */ + actionBeforeSuccess?(e: ActionBeforeSuccessEventArgs): void; + + /** Triggers when the item selection is changed. */ + change?(e: ChangeEventArgs): void; - /** Triggers when the list item is checked or unchecked. */ - checkChange?(e: CheckChangeEventArgs): void; + /** Triggers when the list item is checked or unchecked. */ + checkChange?(e: CheckChangeEventArgs): void; - /** Triggers when the ListBox widget is created successfully. */ - create?(e: CreateEventArgs): void; - - /** Triggers when the ListBox widget is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; + /** Triggers when the ListBox widget is created successfully. */ + create?(e: CreateEventArgs): void; + + /** Triggers when the ListBox widget is destroyed successfully. */ + destroy?(e: DestroyEventArgs): void; - /** Triggers when focus the listbox items. */ - focusIn?(e: FocusInEventArgs): void; + /** Triggers when focus the listbox items. */ + focusIn?(e: FocusInEventArgs): void; - /** Triggers when focus out from listbox items. */ - focusOut?(e: FocusOutEventArgs): void; + /** Triggers when focus out from listbox items. */ + focusOut?(e: FocusOutEventArgs): void; - /** Triggers when the list item is being dragged. */ - itemDrag?(e: ItemDragEventArgs): void; + /** Triggers when the list item is being dragged. */ + itemDrag?(e: ItemDragEventArgs): void; - /** Triggers when the list item is ready to be dragged. */ - itemDragStart?(e: ItemDragStartEventArgs): void; + /** Triggers when the list item is ready to be dragged. */ + itemDragStart?(e: ItemDragStartEventArgs): void; - /** Triggers when the list item stops dragging. */ - itemDragStop?(e: ItemDragStopEventArgs): void; + /** Triggers when the list item stops dragging. */ + itemDragStop?(e: ItemDragStopEventArgs): void; - /** Triggers when the list item is dropped. */ - itemDrop?(e: ItemDropEventArgs): void; + /** Triggers when the list item is dropped. */ + itemDrop?(e: ItemDropEventArgs): void; - /** Triggers when a list item gets selected. */ - select?(e: SelectEventArgs): void; + /** Triggers when a list item gets selected. */ + select?(e: SelectEventArgs): void; - /** Triggers when a list item gets unselected. */ - unselect?(e: UnselectEventArgs): void; -} + /** Triggers when a list item gets unselected. */ + unselect?(e: UnselectEventArgs): void; + } -export interface ActionBeginEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; -} + export interface ActionBeginEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface ActionSuccessEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; -} + export interface ActionSuccessEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface ActionCompleteEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; -} + export interface ActionCompleteEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface ActionFailureEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; -} + export interface ActionFailureEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface ActionBeforeSuccessEventArgs { + export interface ActionBeforeSuccessEventArgs { - /** Instance of the listbox model object. - */ - model?: ej.ListBox.Model; + /** Instance of the listbox model object. + */ + model?: ej.ListBox.Model; - /** Name of the event. - */ - type?: string; + /** Name of the event. + */ + type?: string; - /** List of actual object. - */ - actual?: any; + /** List of actual object. + */ + actual?: any; - /** Object of ListBox widget which contains DataManager arguments - */ - request?: any; + /** Object of ListBox widget which contains DataManager arguments + */ + request?: any; - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** List of array object - */ - result?: any[]; + /** List of array object + */ + result?: any[]; - /** ExecuteQuery object of DataManager - */ - xhr?: any; -} + /** ExecuteQuery object of DataManager + */ + xhr?: any; + } -export interface ChangeEventArgs { + export interface ChangeEventArgs { - /** Instance of the listbox model object. - */ - model?: ej.ListBox.Model; + /** Instance of the listbox model object. + */ + model?: ej.ListBox.Model; - /** Name of the event. - */ - type?: string; + /** Name of the event. + */ + type?: string; - /** List item object. - */ - item?: any; + /** List item object. + */ + item?: any; - /** The Datasource of the listbox. - */ - data?: any; + /** The Datasource of the listbox. + */ + data?: any; - /** List itemĂ¢â‚¬â„¢s index. - */ - index?: number; + /** List itemĂ¢â‚¬â„¢s index. + */ + index?: number; - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Boolean value based on whether the list item is checked or not. - */ - isChecked?: boolean; + /** Boolean value based on whether the list item is checked or not. + */ + isChecked?: boolean; - /** Boolean value based on whether the list item is selected or not. - */ - isSelected?: boolean; + /** Boolean value based on whether the list item is selected or not. + */ + isSelected?: boolean; - /** Boolean value based on the list item is enabled or not. - */ - isEnabled?: boolean; + /** Boolean value based on the list item is enabled or not. + */ + isEnabled?: boolean; - /** List itemĂ¢â‚¬â„¢s text (label). - */ - text?: string; + /** List itemĂ¢â‚¬â„¢s text (label). + */ + text?: string; - /** List itemĂ¢â‚¬â„¢s value. - */ - value?: string; -} + /** List itemĂ¢â‚¬â„¢s value. + */ + value?: string; + } -export interface CheckChangeEventArgs { + export interface CheckChangeEventArgs { - /** Instance of the listbox model object. - */ - model?: ej.ListBox.Model; + /** Instance of the listbox model object. + */ + model?: ej.ListBox.Model; - /** Name of the event. - */ - type?: string; + /** Name of the event. + */ + type?: string; - /** List item object. - */ - item?: any; + /** List item object. + */ + item?: any; - /** The Datasource of the listbox. - */ - data?: any; + /** The Datasource of the listbox. + */ + data?: any; - /** List itemĂ¢â‚¬â„¢s index. - */ - index?: number; + /** List itemĂ¢â‚¬â„¢s index. + */ + index?: number; - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Boolean value based on whether the list item is checked or not. - */ - isChecked?: boolean; + /** Boolean value based on whether the list item is checked or not. + */ + isChecked?: boolean; - /** Boolean value based on whether the list item is selected or not. - */ - isSelected?: boolean; + /** Boolean value based on whether the list item is selected or not. + */ + isSelected?: boolean; - /** Boolean value based on the list item is enabled or not. - */ - isEnabled?: boolean; + /** Boolean value based on the list item is enabled or not. + */ + isEnabled?: boolean; - /** List itemĂ¢â‚¬â„¢s text (label). - */ - text?: string; + /** List itemĂ¢â‚¬â„¢s text (label). + */ + text?: string; - /** List itemĂ¢â‚¬â„¢s value. - */ - value?: string; -} + /** List itemĂ¢â‚¬â„¢s value. + */ + value?: string; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** Instance of the listbox model object. - */ - model?: ej.ListBox.Model; + /** Instance of the listbox model object. + */ + model?: ej.ListBox.Model; - /** Name of the event. - */ - type?: string; + /** Name of the event. + */ + type?: string; - /** Set this option to true to cancel the event. - */ - cancel?: boolean; -} + /** Set this option to true to cancel the event. + */ + cancel?: boolean; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** Instance of the listbox model object. - */ - model?: ej.ListBox.Model; + /** Instance of the listbox model object. + */ + model?: ej.ListBox.Model; - /** Name of the event. - */ - type?: string; + /** Name of the event. + */ + type?: string; - /** Set this option to true to cancel the event. - */ - cancel?: boolean; -} + /** Set this option to true to cancel the event. + */ + cancel?: boolean; + } -export interface FocusInEventArgs { + export interface FocusInEventArgs { - /** Instance of the listbox model object. - */ - model?: ej.ListBox.Model; + /** Instance of the listbox model object. + */ + model?: ej.ListBox.Model; - /** Name of the event. - */ - type?: string; + /** Name of the event. + */ + type?: string; - /** Set this option to true to cancel the event. - */ - cancel?: boolean; -} + /** Set this option to true to cancel the event. + */ + cancel?: boolean; + } -export interface FocusOutEventArgs { + export interface FocusOutEventArgs { - /** Instance of the listbox model object. - */ - model?: ej.ListBox.Model; + /** Instance of the listbox model object. + */ + model?: ej.ListBox.Model; - /** Name of the event. - */ - type?: string; + /** Name of the event. + */ + type?: string; - /** Set this option to true to cancel the event. - */ - cancel?: boolean; -} + /** Set this option to true to cancel the event. + */ + cancel?: boolean; + } -export interface ItemDragEventArgs { + export interface ItemDragEventArgs { - /** Instance of the listbox model object. - */ - model?: ej.ListBox.Model; + /** Instance of the listbox model object. + */ + model?: ej.ListBox.Model; - /** Name of the event. - */ - type?: string; + /** Name of the event. + */ + type?: string; - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** The Datasource of the listbox. - */ - data?: any; + /** The Datasource of the listbox. + */ + data?: any; - /** List itemĂ¢â‚¬â„¢s index. - */ - index?: number; + /** List itemĂ¢â‚¬â„¢s index. + */ + index?: number; - /** Boolean value based on whether the list item is checked or not. - */ - isChecked?: boolean; + /** Boolean value based on whether the list item is checked or not. + */ + isChecked?: boolean; - /** Boolean value based on whether the list item is selected or not. - */ - isSelected?: boolean; + /** Boolean value based on whether the list item is selected or not. + */ + isSelected?: boolean; - /** Boolean value based on whether the list item is enabled or not. - */ - isEnabled?: boolean; + /** Boolean value based on whether the list item is enabled or not. + */ + isEnabled?: boolean; - /** List itemĂ¢â‚¬â„¢s text (label). - */ - text?: string; + /** List itemĂ¢â‚¬â„¢s text (label). + */ + text?: string; - /** List itemĂ¢â‚¬â„¢s value. - */ - value?: string; -} + /** List itemĂ¢â‚¬â„¢s value. + */ + value?: string; + } -export interface ItemDragStartEventArgs { + export interface ItemDragStartEventArgs { - /** Instance of the listbox model object. - */ - model?: ej.ListBox.Model; + /** Instance of the listbox model object. + */ + model?: ej.ListBox.Model; - /** Name of the event. - */ - type?: string; + /** Name of the event. + */ + type?: string; - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** The Datasource of the listbox. - */ - data?: any; + /** The Datasource of the listbox. + */ + data?: any; - /** List itemĂ¢â‚¬â„¢s index. - */ - index?: number; + /** List itemĂ¢â‚¬â„¢s index. + */ + index?: number; - /** Boolean value based on whether the list item is checked or not. - */ - isChecked?: boolean; + /** Boolean value based on whether the list item is checked or not. + */ + isChecked?: boolean; - /** Boolean value based on whether the list item is selected or not. - */ - isSelected?: boolean; + /** Boolean value based on whether the list item is selected or not. + */ + isSelected?: boolean; - /** Boolean value based on whether the list item is enabled or not. - */ - isEnabled?: boolean; + /** Boolean value based on whether the list item is enabled or not. + */ + isEnabled?: boolean; - /** List itemĂ¢â‚¬â„¢s text (label). - */ - text?: string; + /** List itemĂ¢â‚¬â„¢s text (label). + */ + text?: string; - /** List itemĂ¢â‚¬â„¢s value. - */ - value?: string; -} + /** List itemĂ¢â‚¬â„¢s value. + */ + value?: string; + } -export interface ItemDragStopEventArgs { + export interface ItemDragStopEventArgs { - /** Instance of the listbox model object. - */ - model?: ej.ListBox.Model; + /** Instance of the listbox model object. + */ + model?: ej.ListBox.Model; - /** Name of the event. - */ - type?: string; + /** Name of the event. + */ + type?: string; - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** The Datasource of the listbox. - */ - data?: any; + /** The Datasource of the listbox. + */ + data?: any; - /** List itemĂ¢â‚¬â„¢s index. - */ - index?: number; + /** List itemĂ¢â‚¬â„¢s index. + */ + index?: number; - /** Boolean value based on whether the list item is checked or not. - */ - isChecked?: boolean; + /** Boolean value based on whether the list item is checked or not. + */ + isChecked?: boolean; - /** Boolean value based on whether the list item is selected or not. - */ - isSelected?: boolean; + /** Boolean value based on whether the list item is selected or not. + */ + isSelected?: boolean; - /** Boolean value based on whether the list item is enabled or not. - */ - isEnabled?: boolean; + /** Boolean value based on whether the list item is enabled or not. + */ + isEnabled?: boolean; - /** List itemĂ¢â‚¬â„¢s text (label). - */ - text?: string; + /** List itemĂ¢â‚¬â„¢s text (label). + */ + text?: string; - /** List itemĂ¢â‚¬â„¢s value. - */ - value?: string; -} + /** List itemĂ¢â‚¬â„¢s value. + */ + value?: string; + } -export interface ItemDropEventArgs { + export interface ItemDropEventArgs { - /** Instance of the listbox model object. - */ - model?: ej.ListBox.Model; + /** Instance of the listbox model object. + */ + model?: ej.ListBox.Model; - /** Name of the event. - */ - type?: string; + /** Name of the event. + */ + type?: string; - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** The Datasource of the listbox. - */ - data?: any; + /** The Datasource of the listbox. + */ + data?: any; - /** List itemĂ¢â‚¬â„¢s index. - */ - index?: number; + /** List itemĂ¢â‚¬â„¢s index. + */ + index?: number; - /** Boolean value based on whether the list item is checked or not. - */ - isChecked?: boolean; + /** Boolean value based on whether the list item is checked or not. + */ + isChecked?: boolean; - /** Boolean value based on whether the list item is selected or not. - */ - isSelected?: boolean; + /** Boolean value based on whether the list item is selected or not. + */ + isSelected?: boolean; - /** Boolean value based on whether the list item is enabled or not. - */ - isEnabled?: boolean; + /** Boolean value based on whether the list item is enabled or not. + */ + isEnabled?: boolean; - /** List itemĂ¢â‚¬â„¢s text (label). - */ - text?: string; + /** List itemĂ¢â‚¬â„¢s text (label). + */ + text?: string; - /** List itemĂ¢â‚¬â„¢s value. - */ - value?: string; -} + /** List itemĂ¢â‚¬â„¢s value. + */ + value?: string; + } -export interface SelectEventArgs { + export interface SelectEventArgs { - /** Instance of the listbox model object. - */ - model?: ej.ListBox.Model; + /** Instance of the listbox model object. + */ + model?: ej.ListBox.Model; - /** Name of the event. - */ - type?: string; + /** Name of the event. + */ + type?: string; - /** List item object. - */ - item?: any; + /** List item object. + */ + item?: any; - /** The Datasource of the listbox. - */ - data?: any; + /** The Datasource of the listbox. + */ + data?: any; - /** List itemĂ¢â‚¬â„¢s index. - */ - index?: number; + /** List itemĂ¢â‚¬â„¢s index. + */ + index?: number; - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Boolean value based on whether the list item is checked or not. - */ - isChecked?: boolean; + /** Boolean value based on whether the list item is checked or not. + */ + isChecked?: boolean; - /** Boolean value based on whether the list item is selected or not. - */ - isSelected?: boolean; + /** Boolean value based on whether the list item is selected or not. + */ + isSelected?: boolean; - /** Boolean value based on the list item is enabled or not. - */ - isEnabled?: boolean; + /** Boolean value based on the list item is enabled or not. + */ + isEnabled?: boolean; - /** List itemĂ¢â‚¬â„¢s text (label). - */ - text?: string; + /** List itemĂ¢â‚¬â„¢s text (label). + */ + text?: string; - /** List itemĂ¢â‚¬â„¢s value. - */ - value?: string; -} + /** List itemĂ¢â‚¬â„¢s value. + */ + value?: string; + } -export interface UnselectEventArgs { + export interface UnselectEventArgs { - /** Instance of the listbox model object. - */ - model?: ej.ListBox.Model; - - /** Name of the event. - */ - type?: string; + /** Instance of the listbox model object. + */ + model?: ej.ListBox.Model; + + /** Name of the event. + */ + type?: string; - /** List item object. - */ - item?: any; - - /** The Datasource of the listbox. - */ - data?: any; - - /** List itemĂ¢â‚¬â„¢s index. - */ - index?: number; - - /** Set this option to true to cancel the event. - */ - cancel?: boolean; - - /** Boolean value based on whether the list item is checked or not. - */ - isChecked?: boolean; - - /** Boolean value based on whether the list item is selected or not. - */ - isSelected?: boolean; - - /** Boolean value based on the list item is enabled or not. - */ - isEnabled?: boolean; - - /** List itemĂ¢â‚¬â„¢s text (label). - */ - text?: string; - - /** List itemĂ¢â‚¬â„¢s value. - */ - value?: string; -} - -export interface Fields { - - /** Defines the specific field name which contains Boolean values to specify whether the list items to be checked by default or not. - */ - checkBy?: boolean; - - /** The grouping in the ListBox widget can be defined using this field. - */ - groupBy?: string; - - /** Defines the HTML attributes such as id, class, styles for the specific ListBox item. - */ - htmlAttributes?: any; - - /** Defines the specific field name which contains id values for the list items. - */ - id?: string; - - /** Defines the imageURL for the image to be displayed in the ListBox item. - */ - imageUrl?: string; - - /** Defines the image attributes such as height, width, styles and so on. - */ - imageAttributes?: string; - - /** Defines the specific field name which contains Boolean values to specify whether the list items to be selected by default or not. - */ - selectBy?: boolean; - - /** Defines the sprite CSS class for the image to be displayed. - */ - spriteCssClass?: string; - - /** Defines the table name to get the specific set of list items to be loaded in the ListBox widget while rendering with remote data. - */ - tableName?: string; - - /** Defines the specific field name in the data source to load the list with data. - */ - text?: string; - - /** Defines the specific field name in the data source to load the list with data value property. - */ - value?: string; -} -} - -class Calculate { - static fn: Calculate; - constructor(element: JQuery | Element, options?: Calculate.Model); - static Locale: any; - model: Calculate.Model; - defaults: Calculate.Model; - - /** Add the custom formulas with function in CalcEngine library - * @param {string} pass the formula name - * @param {string} pass the custom function name to call - * @returns {void} - */ - addCustomFunction(FormulaName: string, FunctionName: string): void; - - /** Adds a named range to the NamedRanges collection - * @param {string} pass the namedRange's name - * @param {string} pass the cell range of NamedRange - * @returns {void} - */ - addNamedRange(Name: string, cellRange: string): void; - - /** Accepts a possible parsed formula and returns the calculated value without quotes. - * @param {string} pass the cell range to adjust its range - * @returns {string} - */ - adjustRangeArg(Name: string): string; - - /** When a formula cell changes, call this method to clear it from its dependent cells. - * @param {string} pass the changed cell address - * @returns {void} - */ - clearFormulaDependentCells(Cell: string): void; - - /** Call this method to clear whether an exception was raised during the computation of a library function. - * @returns {void} - */ - clearLibraryComputationException(): void; - - /** Get the column index from a cell reference passed in. - * @param {string} pass the cell address - * @returns {void} - */ - colIndex(Cell: string): void; - - /** Evaluates a parsed formula. - * @param {string} pass the parsed formula - * @returns {string} - */ - computedValue(Formula: string): string; - - /** Evaluates a parsed formula. - * @param {string} pass the parsed formula - * @returns {string} - */ - computeFormula(Formula: string): string; -} -export namespace Calculate { - -export interface Model { - /** Returns the cancel option value. - */ - cancel?: boolean; -} -} - -class CheckBox extends ej.Widget { - static fn: CheckBox; - constructor(element: JQuery | Element, options?: CheckBox.Model); - static Locale: any; - model: CheckBox.Model; - defaults: CheckBox.Model; - - /** Destroy the CheckBox widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. - * @returns {void} - */ - destroy(): void; - - /** Disable the CheckBox to prevent all user interactions. - * @returns {void} - */ - disable(): void; - - /** To enable the CheckBox - * @returns {void} - */ - enable(): void; - - /** To Check the status of CheckBox - * @returns {boolean} - */ - isChecked(): boolean; -} -export namespace CheckBox { - -export interface Model { - - /** Specifies whether CheckBox has to be in checked or not. - * We can also specify array of string as value for this property. - * If any of the value in the specified array matches the value of the textbox, - * then it will be considered as checked. It will be useful in MVVM binding, - * specify array type to identify the values of the checked CheckBoxes. - * @Default {false} - */ - checked?: boolean|string[]; - - /** Specifies the State of CheckBox.See below to get available CheckState - * @Default {null} - */ - checkState?: ej.CheckState|string; - - /** Sets the root CSS class for CheckBox theme, which is used customize. - */ - cssClass?: string; - - /** Specifies the checkbox control state. - * @Default {true} - */ - enabled?: boolean; - - /** Specifies the persist property for CheckBox while initialization. - * The persist API save current model value to browser cookies for state maintains. - * While refreshing the CheckBox control page the model value apply from browser cookies. - * @Default {false} - */ - enablePersistence?: boolean; - - /** Specify the Right to Left direction to Checkbox - * @Default {false} - */ - enableRTL?: boolean; - - /** Specifies the enable or disable Tri-State for checkbox control. - * @Default {false} - */ - enableTriState?: boolean; - - /** It allows to define the characteristics of the CheckBox control. It will helps to extend the capability of an HTML element. - * @Default {{}} - */ - htmlAttributes?: any; - - /** Specified value to be added an id attribute of the CheckBox. - * @Default {null} - */ - id?: string; - - /** Specify the prefix value of id to be added before the current id of the CheckBox. - * @Default {ej} - */ - idPrefix?: string; - - /** Specifies the name attribute of the CheckBox. - * @Default {null} - */ - name?: string; - - /** Displays rounded corner borders to CheckBox - * @Default {false} - */ - showRoundedCorner?: boolean; - - /** Specifies the size of the CheckBox.See below to know available CheckboxSize - * @Default {small} - */ - size?: ej.CheckboxSize|string; - - /** Specifies the text content to be displayed for CheckBox. - */ - text?: string; - - /** Set the jQuery validation error message in CheckBox. - * @Default {null} - */ - validationMessage?: any; - - /** Set the jQuery validation rules in CheckBox. - * @Default {null} - */ - validationRules?: any; - - /** Specifies the value attribute of the CheckBox. - * @Default {null} - */ - value?: string; - - /** Fires before the CheckBox is going to changed its state successfully */ - beforeChange?(e: BeforeChangeEventArgs): void; - - /** Fires when the CheckBox state is changed successfully */ - change?(e: ChangeEventArgs): void; - - /** Fires when the CheckBox state is created successfully */ - create?(e: CreateEventArgs): void; - - /** Fires when the CheckBox state is destroyed successfully */ - destroy?(e: DestroyEventArgs): void; -} - -export interface BeforeChangeEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the CheckBox model - */ - model?: ej.CheckBox.Model; - - /** returns the name of the event - */ - type?: string; - - /** returns the event model values - */ - event?: any; - - /** returns the status whether the element is checked or not. - */ - isChecked?: boolean; -} - -export interface ChangeEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the CheckBox model - */ - model?: ej.CheckBox.Model; - - /** returns the name of the event - */ - type?: string; - - /** returns the event arguments - */ - event?: any; - - /** returns the status whether the element is checked or not. - */ - isChecked?: boolean; - - /** returns the state of the checkbox - */ - checkState?: string; -} - -export interface CreateEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the CheckBox model - */ - model?: ej.CheckBox.Model; - - /** returns the name of the event - */ - type?: string; -} - -export interface DestroyEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the CheckBox model - */ - model?: ej.CheckBox.Model; - - /** returns the name of the event - */ - type?: string; -} -} -enum CheckState { -//string -Uncheck, -//string -Check, -//string -Indeterminate, -} -enum CheckboxSize { -//Displays the CheckBox in medium size -Medium, -//Displays the CheckBox in small size -Small, -} - -class ColorPicker extends ej.Widget { - static fn: ColorPicker; - constructor(element: JQuery | Element, options?: ColorPicker.Model); - static Locale: any; - model: ColorPicker.Model; - defaults: ColorPicker.Model; - - /** Disables the color picker control - * @returns {void} - */ - disable(): void; - - /** Enable the color picker control - * @returns {void} - */ - enable(): void; - - /** Gets the selected color in RGB format - * @returns {any} - */ - getColor(): any; - - /** Gets the selected color value as string - * @returns {string} - */ - getValue(): string; - - /** To Convert color value from hexCode to RGB - * @param {string} Specified HEX code converted to RGB - * @returns {any} - */ - hexCodeToRGB(colorCode: string): any; - - /** Hides the ColorPicker popup, if in opened state. - * @returns {void} - */ - hide(): void; - - /** Convert color value from HSV to RGB - * @param {any} Specified HSV code converted to RGB - * @returns {any} - */ - HSVToRGB(HSV: any): any; - - /** Convert color value from RGB to HEX - * @param {any} Specified RGB code converted to HEX code - * @returns {string} - */ - RGBToHEX(RGB: any): string; - - /** Convert color value from RGB to HSV - * @param {any} Specified RGB code converted to HSV code - * @returns {any} - */ - RGBToHSV(RGB: any): any; - - /** Open the ColorPicker popup. - * @returns {void} - */ - show(): void; -} -export namespace ColorPicker { - -export interface Model { - - /** The ColorPicker control allows to define the customized text to displayed in button elements. Using the property to achieve the customized culture values. - * @Default {{ apply: Apply, cancel: Cancel, swatches: Swatches }} - */ - buttonText?: ButtonText; - - /** Allows to change the mode of the button. Please refer below to know available button mode - * @Default {ej.ButtonMode.Split} - */ - buttonMode?: ej.ButtonMode|string; - - /** Specifies the number of columns to be displayed color palette model. - * @Default {10} - */ - columns?: number|string; - - /** This property allows you to customize its appearance using user-defined CSS and custom skin options such as colors and backgrounds. - */ - cssClass?: string; - - /** This property allows to define the custom colors in the palette model.Custom palettes are created by passing a comma delimited string of HEX values or an array of colors. - * @Default {empty} - */ - custom?: any[]; - - /** This property allows to embed the popup in the order of DOM element flow . When we set the value as true, the color picker popup is always in visible state. - * @Default {false} - */ - displayInline?: boolean; - - /** This property allows to change the control in enabled or disabled state. - * @Default {true} - */ - enabled?: boolean; - - /** This property allows to enable or disable the opacity slider in the color picker control - * @Default {true} - */ - enableOpacity?: boolean; - - /** It allows to define the characteristics of the ColorPicker control. It will helps to extend the capability of an HTML element. - * @Default {{}} - */ - htmlAttributes?: any; - - /** Defines the localized text values in button and tooltip. - * @Default {en-US} - */ - locale?: string; - - /** Specifies the model type to be rendered initially in the color picker control. See below to get available ModelType - * @Default {ej.ColorPicker.ModelType.Default} - */ - modelType?: ej.ColorPicker.ModelType|string; - - /** This property allows to change the opacity value .The selected color opacity will be adjusted by using this opacity value. - * @Default {100} - */ - opacityValue?: number|string; - - /** Specifies the palette type to be displayed at initial time in palette model.There two types of palette model available in ColorPicker control. See below available Palette - * @Default {ej.ColorPicker.Palette.BasicPalette} - */ - palette?: ej.ColorPicker.Palette|string; - - /** This property allows to define the preset model to be rendered initially in palette type.It consists of 12 different types of presets. Each presets have 50 colors. - * See below available Presets - * @Default {ej.ColorPicker.Presets.Basic} - */ - presetType?: ej.ColorPicker.Presets|string; - - /** Allows to show/hides the apply and cancel buttons in ColorPicker control - * @Default {true} - */ - showApplyCancel?: boolean; - - /** Allows to show/hides the clear button in ColorPicker control - * @Default {true} - */ - showClearButton?: boolean; - - /** This property allows to provides live preview support for current cursor selection color and selected color. - * @Default {true} - */ - showPreview?: boolean; - - /** This property allows to store the color values in custom list.The ColorPicker will keep up to 11 colors in a custom list. - * By clicking the add button, the selected color from picker or palette will get added in the recent color list. - * @Default {false} - */ - showRecentColors?: boolean; - - /** Allows to show/hides the switcher button in ColorPicker control.It helps to switch palette or picker mode in colorpicker. - * @Default {true} - */ - showSwitcher?: boolean; - - /** This property allows to shows tooltip to notify the slider value in color picker control. - * @Default {false} - */ - showTooltip?: boolean; - - /** Specifies the toolIcon to be displayed in dropdown control color area. - * @Default {null} - */ - toolIcon?: string; - - /** This property allows to define the customized text or content to displayed when mouse over the following elements. This property also allows to use the culture values. - * @Default {{ switcher: Switcher, addbutton: Add Color, basic: Basic, monochrome: Mono Chrome, flatcolors: Flat Color, seawolf: Sea Wolf, webcolors: Web Colors, - * sandy: Sandy, pinkshades: Pink Shades, misty: Misty, citrus: Citrus, vintage: Vintage, moonlight: Moon Light, candycrush: Candy Crush, - * currentcolor: Current Color, selectedcolor: Selected Color }} - */ - tooltipText?: TooltipText; - - /** Specifies the color value for color picker control, the value is in hexadecimal form with prefix of "#". - * @Default {null} - */ - value?: string; - - /** Fires after Color value has been changed successfully.If the user want to perform any operation after the color value changed then the user can make use of this change event. */ - change?(e: ChangeEventArgs): void; - - /** Fires after closing the color picker popup. */ - close?(e: CloseEventArgs): void; - - /** Fires after Color picker control is created. If the user want to perform any operation after the color picker control creation then the user can make use of this create event. */ - create?(e: CreateEventArgs): void; - - /** Fires after Color picker control is destroyed. If the user want to perform any operation after the color picker control destroyed then the user can make use of this destroy event. */ - destroy?(e: DestroyEventArgs): void; - - /** Fires after opening the color picker popup */ - open?(e: OpenEventArgs): void; - - /** Fires after Color value has been selected successfully. If the user want to perform any operation after the color value selected then the user can make use of this select event. */ - select?(e: SelectEventArgs): void; -} - -export interface ChangeEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the color picker model - */ - model?: ej.ColorPicker.Model; - - /** returns the name of the event - */ - type?: string; - - /** return the changed color value - */ - value?: string; -} + /** List item object. + */ + item?: any; + + /** The Datasource of the listbox. + */ + data?: any; + + /** List itemĂ¢â‚¬â„¢s index. + */ + index?: number; + + /** Set this option to true to cancel the event. + */ + cancel?: boolean; + + /** Boolean value based on whether the list item is checked or not. + */ + isChecked?: boolean; + + /** Boolean value based on whether the list item is selected or not. + */ + isSelected?: boolean; + + /** Boolean value based on the list item is enabled or not. + */ + isEnabled?: boolean; + + /** List itemĂ¢â‚¬â„¢s text (label). + */ + text?: string; + + /** List itemĂ¢â‚¬â„¢s value. + */ + value?: string; + } + + export interface Fields { + + /** Defines the specific field name which contains Boolean values to specify whether the list items to be checked by default or not. + */ + checkBy?: boolean; + + /** The grouping in the ListBox widget can be defined using this field. + */ + groupBy?: string; + + /** Defines the HTML attributes such as id, class, styles for the specific ListBox item. + */ + htmlAttributes?: any; + + /** Defines the specific field name which contains id values for the list items. + */ + id?: string; + + /** Defines the imageURL for the image to be displayed in the ListBox item. + */ + imageUrl?: string; + + /** Defines the image attributes such as height, width, styles and so on. + */ + imageAttributes?: string; + + /** Defines the specific field name which contains Boolean values to specify whether the list items to be selected by default or not. + */ + selectBy?: boolean; + + /** Defines the sprite CSS class for the image to be displayed. + */ + spriteCssClass?: string; + + /** Defines the table name to get the specific set of list items to be loaded in the ListBox widget while rendering with remote data. + */ + tableName?: string; + + /** Defines the specific field name in the data source to load the list with data. + */ + text?: string; + + /** Defines the specific field name in the data source to load the list with data value property. + */ + value?: string; + } + } + + class Calculate { + static fn: Calculate; + constructor(element: JQuery | Element, options?: Calculate.Model); + static Locale: any; + model: Calculate.Model; + defaults: Calculate.Model; + + /** Add the custom formulas with function in CalcEngine library + * @param {string} pass the formula name + * @param {string} pass the custom function name to call + * @returns {void} + */ + addCustomFunction(FormulaName: string, FunctionName: string): void; + + /** Adds a named range to the NamedRanges collection + * @param {string} pass the namedRange's name + * @param {string} pass the cell range of NamedRange + * @returns {void} + */ + addNamedRange(Name: string, cellRange: string): void; + + /** Accepts a possible parsed formula and returns the calculated value without quotes. + * @param {string} pass the cell range to adjust its range + * @returns {string} + */ + adjustRangeArg(Name: string): string; + + /** When a formula cell changes, call this method to clear it from its dependent cells. + * @param {string} pass the changed cell address + * @returns {void} + */ + clearFormulaDependentCells(Cell: string): void; + + /** Call this method to clear whether an exception was raised during the computation of a library function. + * @returns {void} + */ + clearLibraryComputationException(): void; + + /** Get the column index from a cell reference passed in. + * @param {string} pass the cell address + * @returns {void} + */ + colIndex(Cell: string): void; + + /** Evaluates a parsed formula. + * @param {string} pass the parsed formula + * @returns {string} + */ + computedValue(Formula: string): string; + + /** Evaluates a parsed formula. + * @param {string} pass the parsed formula + * @returns {string} + */ + computeFormula(Formula: string): string; + } + export namespace Calculate { + + export interface Model { + /** Returns the cancel option value. + */ + cancel?: boolean; + } + } + + class CheckBox extends ej.Widget { + static fn: CheckBox; + constructor(element: JQuery | Element, options?: CheckBox.Model); + static Locale: any; + model: CheckBox.Model; + defaults: CheckBox.Model; + + /** Destroy the CheckBox widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. + * @returns {void} + */ + destroy(): void; + + /** Disable the CheckBox to prevent all user interactions. + * @returns {void} + */ + disable(): void; + + /** To enable the CheckBox + * @returns {void} + */ + enable(): void; + + /** To Check the status of CheckBox + * @returns {boolean} + */ + isChecked(): boolean; + } + export namespace CheckBox { + + export interface Model { + + /** Specifies whether CheckBox has to be in checked or not. + * We can also specify array of string as value for this property. + * If any of the value in the specified array matches the value of the textbox, + * then it will be considered as checked. It will be useful in MVVM binding, + * specify array type to identify the values of the checked CheckBoxes. + * @Default {false} + */ + checked?: boolean | string[]; + + /** Specifies the State of CheckBox.See below to get available CheckState + * @Default {null} + */ + checkState?: ej.CheckState | string; + + /** Sets the root CSS class for CheckBox theme, which is used customize. + */ + cssClass?: string; + + /** Specifies the checkbox control state. + * @Default {true} + */ + enabled?: boolean; + + /** Specifies the persist property for CheckBox while initialization. + * The persist API save current model value to browser cookies for state maintains. + * While refreshing the CheckBox control page the model value apply from browser cookies. + * @Default {false} + */ + enablePersistence?: boolean; + + /** Specify the Right to Left direction to Checkbox + * @Default {false} + */ + enableRTL?: boolean; + + /** Specifies the enable or disable Tri-State for checkbox control. + * @Default {false} + */ + enableTriState?: boolean; + + /** It allows to define the characteristics of the CheckBox control. It will helps to extend the capability of an HTML element. + * @Default {{}} + */ + htmlAttributes?: any; + + /** Specified value to be added an id attribute of the CheckBox. + * @Default {null} + */ + id?: string; + + /** Specify the prefix value of id to be added before the current id of the CheckBox. + * @Default {ej} + */ + idPrefix?: string; + + /** Specifies the name attribute of the CheckBox. + * @Default {null} + */ + name?: string; + + /** Displays rounded corner borders to CheckBox + * @Default {false} + */ + showRoundedCorner?: boolean; + + /** Specifies the size of the CheckBox.See below to know available CheckboxSize + * @Default {small} + */ + size?: ej.CheckboxSize | string; + + /** Specifies the text content to be displayed for CheckBox. + */ + text?: string; + + /** Set the jQuery validation error message in CheckBox. + * @Default {null} + */ + validationMessage?: any; + + /** Set the jQuery validation rules in CheckBox. + * @Default {null} + */ + validationRules?: any; + + /** Specifies the value attribute of the CheckBox. + * @Default {null} + */ + value?: string; + + /** Fires before the CheckBox is going to changed its state successfully */ + beforeChange?(e: BeforeChangeEventArgs): void; + + /** Fires when the CheckBox state is changed successfully */ + change?(e: ChangeEventArgs): void; + + /** Fires when the CheckBox state is created successfully */ + create?(e: CreateEventArgs): void; + + /** Fires when the CheckBox state is destroyed successfully */ + destroy?(e: DestroyEventArgs): void; + } + + export interface BeforeChangeEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the CheckBox model + */ + model?: ej.CheckBox.Model; + + /** returns the name of the event + */ + type?: string; + + /** returns the event model values + */ + event?: any; + + /** returns the status whether the element is checked or not. + */ + isChecked?: boolean; + } + + export interface ChangeEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the CheckBox model + */ + model?: ej.CheckBox.Model; + + /** returns the name of the event + */ + type?: string; + + /** returns the event arguments + */ + event?: any; + + /** returns the status whether the element is checked or not. + */ + isChecked?: boolean; + + /** returns the state of the checkbox + */ + checkState?: string; + } + + export interface CreateEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the CheckBox model + */ + model?: ej.CheckBox.Model; + + /** returns the name of the event + */ + type?: string; + } + + export interface DestroyEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the CheckBox model + */ + model?: ej.CheckBox.Model; + + /** returns the name of the event + */ + type?: string; + } + } + enum CheckState { + //string + Uncheck, + //string + Check, + //string + Indeterminate, + } + enum CheckboxSize { + //Displays the CheckBox in medium size + Medium, + //Displays the CheckBox in small size + Small, + } + + class ColorPicker extends ej.Widget { + static fn: ColorPicker; + constructor(element: JQuery | Element, options?: ColorPicker.Model); + static Locale: any; + model: ColorPicker.Model; + defaults: ColorPicker.Model; + + /** Disables the color picker control + * @returns {void} + */ + disable(): void; + + /** Enable the color picker control + * @returns {void} + */ + enable(): void; + + /** Gets the selected color in RGB format + * @returns {any} + */ + getColor(): any; + + /** Gets the selected color value as string + * @returns {string} + */ + getValue(): string; + + /** To Convert color value from hexCode to RGB + * @param {string} Specified HEX code converted to RGB + * @returns {any} + */ + hexCodeToRGB(colorCode: string): any; + + /** Hides the ColorPicker popup, if in opened state. + * @returns {void} + */ + hide(): void; + + /** Convert color value from HSV to RGB + * @param {any} Specified HSV code converted to RGB + * @returns {any} + */ + HSVToRGB(HSV: any): any; + + /** Convert color value from RGB to HEX + * @param {any} Specified RGB code converted to HEX code + * @returns {string} + */ + RGBToHEX(RGB: any): string; + + /** Convert color value from RGB to HSV + * @param {any} Specified RGB code converted to HSV code + * @returns {any} + */ + RGBToHSV(RGB: any): any; + + /** Open the ColorPicker popup. + * @returns {void} + */ + show(): void; + } + export namespace ColorPicker { + + export interface Model { + + /** The ColorPicker control allows to define the customized text to displayed in button elements. Using the property to achieve the customized culture values. + * @Default {{ apply: Apply, cancel: Cancel, swatches: Swatches }} + */ + buttonText?: ButtonText; + + /** Allows to change the mode of the button. Please refer below to know available button mode + * @Default {ej.ButtonMode.Split} + */ + buttonMode?: ej.ButtonMode | string; + + /** Specifies the number of columns to be displayed color palette model. + * @Default {10} + */ + columns?: number | string; + + /** This property allows you to customize its appearance using user-defined CSS and custom skin options such as colors and backgrounds. + */ + cssClass?: string; + + /** This property allows to define the custom colors in the palette model.Custom palettes are created by passing a comma delimited string of HEX values or an array of colors. + * @Default {empty} + */ + custom?: any[]; + + /** This property allows to embed the popup in the order of DOM element flow . When we set the value as true, the color picker popup is always in visible state. + * @Default {false} + */ + displayInline?: boolean; + + /** This property allows to change the control in enabled or disabled state. + * @Default {true} + */ + enabled?: boolean; + + /** This property allows to enable or disable the opacity slider in the color picker control + * @Default {true} + */ + enableOpacity?: boolean; + + /** It allows to define the characteristics of the ColorPicker control. It will helps to extend the capability of an HTML element. + * @Default {{}} + */ + htmlAttributes?: any; + + /** Defines the localized text values in button and tooltip. + * @Default {en-US} + */ + locale?: string; + + /** Specifies the model type to be rendered initially in the color picker control. See below to get available ModelType + * @Default {ej.ColorPicker.ModelType.Default} + */ + modelType?: ej.ColorPicker.ModelType | string; + + /** This property allows to change the opacity value .The selected color opacity will be adjusted by using this opacity value. + * @Default {100} + */ + opacityValue?: number | string; + + /** Specifies the palette type to be displayed at initial time in palette model.There two types of palette model available in ColorPicker control. See below available Palette + * @Default {ej.ColorPicker.Palette.BasicPalette} + */ + palette?: ej.ColorPicker.Palette | string; + + /** This property allows to define the preset model to be rendered initially in palette type.It consists of 12 different types of presets. Each presets have 50 colors. + * See below available Presets + * @Default {ej.ColorPicker.Presets.Basic} + */ + presetType?: ej.ColorPicker.Presets | string; + + /** Allows to show/hides the apply and cancel buttons in ColorPicker control + * @Default {true} + */ + showApplyCancel?: boolean; + + /** Allows to show/hides the clear button in ColorPicker control + * @Default {true} + */ + showClearButton?: boolean; + + /** This property allows to provides live preview support for current cursor selection color and selected color. + * @Default {true} + */ + showPreview?: boolean; + + /** This property allows to store the color values in custom list.The ColorPicker will keep up to 11 colors in a custom list. + * By clicking the add button, the selected color from picker or palette will get added in the recent color list. + * @Default {false} + */ + showRecentColors?: boolean; + + /** Allows to show/hides the switcher button in ColorPicker control.It helps to switch palette or picker mode in colorpicker. + * @Default {true} + */ + showSwitcher?: boolean; + + /** This property allows to shows tooltip to notify the slider value in color picker control. + * @Default {false} + */ + showTooltip?: boolean; + + /** Specifies the toolIcon to be displayed in dropdown control color area. + * @Default {null} + */ + toolIcon?: string; + + /** This property allows to define the customized text or content to displayed when mouse over the following elements. This property also allows to use the culture values. + * @Default {{ switcher: Switcher, addbutton: Add Color, basic: Basic, monochrome: Mono Chrome, flatcolors: Flat Color, seawolf: Sea Wolf, webcolors: Web Colors, + * sandy: Sandy, pinkshades: Pink Shades, misty: Misty, citrus: Citrus, vintage: Vintage, moonlight: Moon Light, candycrush: Candy Crush, + * currentcolor: Current Color, selectedcolor: Selected Color }} + */ + tooltipText?: TooltipText; + + /** Specifies the color value for color picker control, the value is in hexadecimal form with prefix of "#". + * @Default {null} + */ + value?: string; + + /** Fires after Color value has been changed successfully.If the user want to perform any operation after the color value changed then the user can make use of this change event. */ + change?(e: ChangeEventArgs): void; + + /** Fires after closing the color picker popup. */ + close?(e: CloseEventArgs): void; + + /** Fires after Color picker control is created. If the user want to perform any operation after the color picker control creation then the user can make use of this create event. */ + create?(e: CreateEventArgs): void; + + /** Fires after Color picker control is destroyed. If the user want to perform any operation after the color picker control destroyed then the user can make use of this destroy event. */ + destroy?(e: DestroyEventArgs): void; + + /** Fires after opening the color picker popup */ + open?(e: OpenEventArgs): void; + + /** Fires after Color value has been selected successfully. If the user want to perform any operation after the color value selected then the user can make use of this select event. */ + select?(e: SelectEventArgs): void; + } + + export interface ChangeEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the color picker model + */ + model?: ej.ColorPicker.Model; + + /** returns the name of the event + */ + type?: string; + + /** return the changed color value + */ + value?: string; + } -export interface CloseEventArgs { + export interface CloseEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the color picker model - */ - model?: ej.ColorPicker.Model; + /** returns the color picker model + */ + model?: ej.ColorPicker.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the color picker model - */ - model?: any; + /** returns the color picker model + */ + model?: any; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the color picker model - */ - model?: ej.ColorPicker.Model; + /** returns the color picker model + */ + model?: ej.ColorPicker.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface OpenEventArgs { + export interface OpenEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the color picker model - */ - model?: ej.ColorPicker.Model; + /** returns the color picker model + */ + model?: ej.ColorPicker.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface SelectEventArgs { + export interface SelectEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the color picker model - */ - model?: ej.ColorPicker.Model; + /** returns the color picker model + */ + model?: ej.ColorPicker.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** return the selected color value - */ - value?: string; -} + /** return the selected color value + */ + value?: string; + } -export interface ButtonText { + export interface ButtonText { - /** Sets the text for the apply button. - */ - apply?: string; + /** Sets the text for the apply button. + */ + apply?: string; - /** Sets the text for the cancel button. - */ - cancel?: string; + /** Sets the text for the cancel button. + */ + cancel?: string; - /** Sets the header text for the swatches area. - */ - swatches?: string; -} + /** Sets the header text for the swatches area. + */ + swatches?: string; + } -export interface TooltipText { + export interface TooltipText { - /** Sets the tooltip text for the switcher button. - */ - switcher?: string; + /** Sets the tooltip text for the switcher button. + */ + switcher?: string; - /** Sets the tooltip text for the add button. - */ - addbutton?: string; + /** Sets the tooltip text for the add button. + */ + addbutton?: string; - /** Sets the tooltip text for the basic preset. - */ - basic?: string; + /** Sets the tooltip text for the basic preset. + */ + basic?: string; - /** Sets the tooltip text for the mono chrome preset. - */ - monochrome?: string; + /** Sets the tooltip text for the mono chrome preset. + */ + monochrome?: string; - /** Sets the tooltip text for the flat colors preset. - */ - flatcolors?: string; + /** Sets the tooltip text for the flat colors preset. + */ + flatcolors?: string; - /** Sets the tooltip text for the sea wolf preset. - */ - seawolf?: string; + /** Sets the tooltip text for the sea wolf preset. + */ + seawolf?: string; - /** Sets the tooltip text for the web colors preset. - */ - webcolors?: string; + /** Sets the tooltip text for the web colors preset. + */ + webcolors?: string; - /** Sets the tooltip text for the sandy preset. - */ - sandy?: string; + /** Sets the tooltip text for the sandy preset. + */ + sandy?: string; - /** Sets the tooltip text for the pink shades preset. - */ - pinkshades?: string; + /** Sets the tooltip text for the pink shades preset. + */ + pinkshades?: string; - /** Sets the tooltip text for the misty preset. - */ - misty?: string; + /** Sets the tooltip text for the misty preset. + */ + misty?: string; - /** Sets the tooltip text for the citrus preset. - */ - citrus?: string; + /** Sets the tooltip text for the citrus preset. + */ + citrus?: string; - /** Sets the tooltip text for the vintage preset. - */ - vintage?: string; + /** Sets the tooltip text for the vintage preset. + */ + vintage?: string; - /** Sets the tooltip text for the moon light preset. - */ - moonlight?: string; + /** Sets the tooltip text for the moon light preset. + */ + moonlight?: string; - /** Sets the tooltip text for the candy crush preset. - */ - candycrush?: string; + /** Sets the tooltip text for the candy crush preset. + */ + candycrush?: string; - /** Sets the tooltip text for the current color area. - */ - currentcolor?: string; + /** Sets the tooltip text for the current color area. + */ + currentcolor?: string; - /** Sets the tooltip text for the selected color area. - */ - selectedcolor?: string; -} + /** Sets the tooltip text for the selected color area. + */ + selectedcolor?: string; + } -enum ModelType { + enum ModelType { - ///support palette type mode in color picker. - Palette, + ///support palette type mode in color picker. + Palette, - ///support palette type mode in color picker. - Picker -} + ///support palette type mode in color picker. + Picker + } -enum Palette { + enum Palette { - ///used to show the basic palette - BasicPalette, + ///used to show the basic palette + BasicPalette, - ///used to show the custompalette - CustomPalette -} + ///used to show the custompalette + CustomPalette + } -enum Presets { + enum Presets { - ///used to show the basic presets - Basic, + ///used to show the basic presets + Basic, - ///used to show the CandyCrush colors presets - CandyCrush, + ///used to show the CandyCrush colors presets + CandyCrush, - ///used to show the Citrus colors presets - Citrus, + ///used to show the Citrus colors presets + Citrus, - ///used to show the FlatColors presets - FlatColors, + ///used to show the FlatColors presets + FlatColors, - ///used to show the Misty presets - Misty, + ///used to show the Misty presets + Misty, - ///used to show the MoonLight presets - MoonLight, - - ///used to show the PinkShades presets - PinkShades, + ///used to show the MoonLight presets + MoonLight, + + ///used to show the PinkShades presets + PinkShades, - ///used to show the Sandy presets - Sandy, + ///used to show the Sandy presets + Sandy, - ///used to show the Seawolf presets - SeaWolf, - - ///used to show the Vintage presets - Vintage, - - ///used to show the WebColors presets - WebColors -} - -} -enum ButtonMode { -//Displays the button in split mode -Split, -//Displays the button in Dropdown mode -Dropdown, -} - -class FileExplorer extends ej.Widget { - static fn: FileExplorer; - constructor(element: JQuery | Element, options?: FileExplorer.Model); - static Locale: any; - model: FileExplorer.Model; - defaults: FileExplorer.Model; - - /** Refresh the size of FileExplorer control. - * @returns {void} - */ - adjustSize(): void; - - /** Disable the particular context menu item. - * @param {string|HTMLElement} Id of the menu item/ Menu element to be disabled - * @returns {void} - */ - disableMenuItem(item: string|HTMLElement): void; - - /** Disable the particular toolbar item. - * @param {string|HTMLElement} Id of the toolbar item/ Tool item element to be disabled - * @returns {void} - */ - disableToolbarItem(item: string|HTMLElement): void; - - /** Enable the particular context menu item. - * @param {string|HTMLElement} Id of the menu item/ Menu element to be Enabled - * @returns {void} - */ - enableMenuItem(item: string|HTMLElement): void; - - /** Enable the particular toolbar item - * @param {string|HTMLElement} Id of the tool item/ Tool item element to be Enabled - * @returns {void} - */ - enableToolbarItem(item: string|HTMLElement): void; - - /** Refresh the content of the selected folder in FileExplorer control. - * @returns {void} - */ - refresh(): void; - - /** Remove the particular toolbar item. - * @param {string|HTMLElement} Id of the tool item/ tool item element to be removed - * @returns {void} - */ - removeToolbarItem(item: string|HTMLElement): void; -} -export namespace FileExplorer { - -export interface Model { - - /** Sets the URL of server side AJAX handling method that handles file operation like Read, Remove, Rename, Create, Upload, Download, Copy and Move in FileExplorer. - */ - ajaxAction?: string; - - /** Specifies the data type of server side AJAX handling method. - * @Default {json} - */ - ajaxDataType?: string; - - /** By using ajaxSettings property, you can customize the AJAX configurations. Normally you can customize the following option in AJAX handling data, URL, type, async, contentType, dataType and - * success. For upload, download and getImage API, you can only customize URL. - * @Default {{ read: {}, createFolder: {}, remove: {}, rename: {}, paste: {}, getDetails: {}, download: {}, upload: {}, getImage: {}, search: {}}} - */ - ajaxSettings?: any; - - /** The FileExplorer allows to move the files from one folder to another folder of FileExplorer by using drag and drop option. Also it supports to upload a file by dragging it - * from windows explorer to the necessary folder of ejFileExplorer. - * @Default {true} - */ - allowDragAndDrop?: boolean; - - /** Gets or sets a value that indicates whether to enable keyboard support for FileExplorer actions. - * @Default {true} - */ - allowKeyboardNavigation?: boolean; - - /** The FileExplorer allows to select multiple files by enabling the allowMultiSelection property. You can perform multi selection by pressing the Ctrl key or Shift key. - * @Default {true} - */ - allowMultiSelection?: boolean; - - /** By using the contextMenuSettings property, you can customize the ContextMenu in the FileExplorer control. - */ - contextMenuSettings?: ContextMenuSettings; - - /** Sets the root class for FileExplorer theme. This cssClass API allows to use custom skinning option for File Explorer control. - * By defining the root class by using this API, you have to include this root class in CSS. - */ - cssClass?: string; - - /** Specify the enablePersistence to FileExplorer to save the current model value in browser cookies for state maintains. - * @Default {false} - */ - enablePersistence?: boolean; - - /** Enables or disables the resize support in FileExplorer control. - * @Default {false} - */ - enableResize?: boolean; - - /** Enables or disables the Right to Left alignment support in FileExplorer control. - * @Default {false} - */ - enableRTL?: boolean; - - /** Enables or disables the thumbnail image compression option in FileExplorer control. By enabling this option, you can reduce the thumbnail image size while loading. - * @Default {false} - */ - enableThumbnailCompress?: boolean; - - /** Allows specified type of files only to display in FileExplorer control. - * @Default {.} - */ - fileTypes?: string; - - /** By using filterSettings property, you can customize the search functionality of the search bar in FileExplorer control. - */ - filterSettings?: FilterSettings; - - /** By using the gridSettings property, you can customize the grid behavior in the FileExplorer control. - */ - gridSettings?: GridSettings; - - /** Specifies the height of FileExplorer control. - * @Default {400} - */ - height?: string|number; - - /** Enables or disables the responsive support for FileExplorer control during the window resizing time. - * @Default {false} - */ - isResponsive?: boolean; - - /** Sets the file view type. There are three view types available such as Grid, Tile and Large icons. See layoutType. - * @Default {ej.FileExplorer.layoutType.Grid} - */ - layout?: ej.FileExplorer.layoutType|string; - - /** Sets the culture in FileExplorer. - * @Default {en-US} - */ - locale?: string; - - /** Sets the maximum height of FileExplorer control. - * @Default {null} - */ - maxHeight?: string|number; - - /** Sets the maximum width of FileExplorer control. - * @Default {null} - */ - maxWidth?: string|number; - - /** Sets the minimum height of FileExplorer control. - * @Default {250px} - */ - minHeight?: string|number; - - /** Sets the minimum width of FileExplorer control. - * @Default {400px} - */ - minWidth?: string|number; - - /** The property path denotes the filesystem path that are to be explored. The path for the filesystem can be physical path or relative path, but it has to be relevant to where the Web API is hosted. - */ - path?: string; - - /** The selectedFolder is used to select the specified folder of FileExplorer control. - */ - selectedFolder?: string; - - /** The selectedItems is used to select the specified items (file, folder) of FileExplorer control. - */ - selectedItems?: string|any[]; - - /** Enables or disables the checkbox option in FileExplorer control. - * @Default {true} - */ - showCheckbox?: boolean; - - /** Enables or disables the context menu option in FileExplorer control. - * @Default {true} - */ - showContextMenu?: boolean; - - /** Enables or disables the footer in FileExplorer control. The footer element displays the details of the current selected files and folders. - * And also the footer having the switcher to change the layout view. - * @Default {true} - */ - showFooter?: boolean; - - /** FileExplorer control is displayed with rounded corner when this property is set to true. - * @Default {false} - */ - showRoundedCorner?: boolean; - - /** FileExplorer control is rendered with thumbnail preview of images in Tile and LargeIcons layout when this property set to true. - * @Default {true} - */ - showThumbnail?: boolean; - - /** Shows or disables the toolbar in FileExplorer control. - * @Default {true} - */ - showToolbar?: boolean; + ///used to show the Seawolf presets + SeaWolf, + + ///used to show the Vintage presets + Vintage, + + ///used to show the WebColors presets + WebColors + } + + } + enum ButtonMode { + //Displays the button in split mode + Split, + //Displays the button in Dropdown mode + Dropdown, + } + + class FileExplorer extends ej.Widget { + static fn: FileExplorer; + constructor(element: JQuery | Element, options?: FileExplorer.Model); + static Locale: any; + model: FileExplorer.Model; + defaults: FileExplorer.Model; + + /** Refresh the size of FileExplorer control. + * @returns {void} + */ + adjustSize(): void; + + /** Disable the particular context menu item. + * @param {string|HTMLElement} Id of the menu item/ Menu element to be disabled + * @returns {void} + */ + disableMenuItem(item: string | HTMLElement): void; + + /** Disable the particular toolbar item. + * @param {string|HTMLElement} Id of the toolbar item/ Tool item element to be disabled + * @returns {void} + */ + disableToolbarItem(item: string | HTMLElement): void; + + /** Enable the particular context menu item. + * @param {string|HTMLElement} Id of the menu item/ Menu element to be Enabled + * @returns {void} + */ + enableMenuItem(item: string | HTMLElement): void; + + /** Enable the particular toolbar item + * @param {string|HTMLElement} Id of the tool item/ Tool item element to be Enabled + * @returns {void} + */ + enableToolbarItem(item: string | HTMLElement): void; + + /** Refresh the content of the selected folder in FileExplorer control. + * @returns {void} + */ + refresh(): void; + + /** Remove the particular toolbar item. + * @param {string|HTMLElement} Id of the tool item/ tool item element to be removed + * @returns {void} + */ + removeToolbarItem(item: string | HTMLElement): void; + } + export namespace FileExplorer { + + export interface Model { + + /** Sets the URL of server side AJAX handling method that handles file operation like Read, Remove, Rename, Create, Upload, Download, Copy and Move in FileExplorer. + */ + ajaxAction?: string; + + /** Specifies the data type of server side AJAX handling method. + * @Default {json} + */ + ajaxDataType?: string; + + /** By using ajaxSettings property, you can customize the AJAX configurations. Normally you can customize the following option in AJAX handling data, URL, type, async, contentType, dataType and + * success. For upload, download and getImage API, you can only customize URL. + * @Default {{ read: {}, createFolder: {}, remove: {}, rename: {}, paste: {}, getDetails: {}, download: {}, upload: {}, getImage: {}, search: {}}} + */ + ajaxSettings?: any; + + /** The FileExplorer allows to move the files from one folder to another folder of FileExplorer by using drag and drop option. Also it supports to upload a file by dragging it + * from windows explorer to the necessary folder of ejFileExplorer. + * @Default {true} + */ + allowDragAndDrop?: boolean; + + /** Gets or sets a value that indicates whether to enable keyboard support for FileExplorer actions. + * @Default {true} + */ + allowKeyboardNavigation?: boolean; + + /** The FileExplorer allows to select multiple files by enabling the allowMultiSelection property. You can perform multi selection by pressing the Ctrl key or Shift key. + * @Default {true} + */ + allowMultiSelection?: boolean; + + /** By using the contextMenuSettings property, you can customize the ContextMenu in the FileExplorer control. + */ + contextMenuSettings?: ContextMenuSettings; + + /** Sets the root class for FileExplorer theme. This cssClass API allows to use custom skinning option for File Explorer control. + * By defining the root class by using this API, you have to include this root class in CSS. + */ + cssClass?: string; + + /** Specify the enablePersistence to FileExplorer to save the current model value in browser cookies for state maintains. + * @Default {false} + */ + enablePersistence?: boolean; + + /** Enables or disables the resize support in FileExplorer control. + * @Default {false} + */ + enableResize?: boolean; + + /** Enables or disables the Right to Left alignment support in FileExplorer control. + * @Default {false} + */ + enableRTL?: boolean; + + /** Enables or disables the thumbnail image compression option in FileExplorer control. By enabling this option, you can reduce the thumbnail image size while loading. + * @Default {false} + */ + enableThumbnailCompress?: boolean; + + /** Allows specified type of files only to display in FileExplorer control. + * @Default {.} + */ + fileTypes?: string; + + /** By using filterSettings property, you can customize the search functionality of the search bar in FileExplorer control. + */ + filterSettings?: FilterSettings; + + /** By using the gridSettings property, you can customize the grid behavior in the FileExplorer control. + */ + gridSettings?: GridSettings; + + /** Specifies the height of FileExplorer control. + * @Default {400} + */ + height?: string | number; + + /** Enables or disables the responsive support for FileExplorer control during the window resizing time. + * @Default {false} + */ + isResponsive?: boolean; + + /** Sets the file view type. There are three view types available such as Grid, Tile and Large icons. See layoutType. + * @Default {ej.FileExplorer.layoutType.Grid} + */ + layout?: ej.FileExplorer.layoutType | string; + + /** Sets the culture in FileExplorer. + * @Default {en-US} + */ + locale?: string; + + /** Sets the maximum height of FileExplorer control. + * @Default {null} + */ + maxHeight?: string | number; + + /** Sets the maximum width of FileExplorer control. + * @Default {null} + */ + maxWidth?: string | number; + + /** Sets the minimum height of FileExplorer control. + * @Default {250px} + */ + minHeight?: string | number; + + /** Sets the minimum width of FileExplorer control. + * @Default {400px} + */ + minWidth?: string | number; + + /** The property path denotes the filesystem path that are to be explored. The path for the filesystem can be physical path or relative path, + * but it has to be relevant to where the Web API is hosted. + */ + path?: string; + + /** The selectedFolder is used to select the specified folder of FileExplorer control. + */ + selectedFolder?: string; + + /** The selectedItems is used to select the specified items (file, folder) of FileExplorer control. + */ + selectedItems?: string | any[]; + + /** Enables or disables the checkbox option in FileExplorer control. + * @Default {true} + */ + showCheckbox?: boolean; + + /** Enables or disables the context menu option in FileExplorer control. + * @Default {true} + */ + showContextMenu?: boolean; + + /** Enables or disables the footer in FileExplorer control. The footer element displays the details of the current selected files and folders. + * And also the footer having the switcher to change the layout view. + * @Default {true} + */ + showFooter?: boolean; + + /** FileExplorer control is displayed with rounded corner when this property is set to true. + * @Default {false} + */ + showRoundedCorner?: boolean; + + /** FileExplorer control is rendered with thumbnail preview of images in Tile and LargeIcons layout when this property set to true. + * @Default {true} + */ + showThumbnail?: boolean; + + /** Shows or disables the toolbar in FileExplorer control. + * @Default {true} + */ + showToolbar?: boolean; - /** Enables or disables the navigation pane in FileExplorer control. The navigation pane contains a tree view element that displays all the folders from the filesystem in a hierarchical manner. - * This is useful to a quick navigation of any folder in the filesystem. - * @Default {true} - */ - showNavigationPane?: boolean; + /** Enables or disables the navigation pane in FileExplorer control. The navigation pane contains a tree view element that displays all the folders from the filesystem in a hierarchical manner. + * This is useful to a quick navigation of any folder in the filesystem. + * @Default {true} + */ + showNavigationPane?: boolean; - /** The tools property is used to configure and group required toolbar items in FileExplorer control. - * @Default {{ creation: [NewFolder], navigation: [Back, Forward, Upward], addressBar: [Addressbar], editing: [Refresh, Upload, Delete, Rename, Download], copyPaste: [Cut, Copy, Paste], - * getProperties: [Details], searchBar: [Searchbar], layout: [Layout], sortBy: [SortBy]}} - */ - tools?: any; + /** The tools property is used to configure and group required toolbar items in FileExplorer control. + * @Default {{ creation: [NewFolder], navigation: [Back, Forward, Upward], addressBar: [Addressbar], editing: [Refresh, Upload, Delete, Rename, Download], copyPaste: [Cut, Copy, Paste], + * getProperties: [Details], searchBar: [Searchbar], layout: [Layout], sortBy: [SortBy]}} + */ + tools?: any; - /** The toolsList property is used to arrange the toolbar items in the FileExplorer control. - * @Default {[layout, creation, navigation, addressBar, editing, copyPaste, sortBy, getProperties, searchBar]} - */ - toolsList?: any[]; + /** The toolsList property is used to arrange the toolbar items in the FileExplorer control. + * @Default {[layout, creation, navigation, addressBar, editing, copyPaste, sortBy, getProperties, searchBar]} + */ + toolsList?: any[]; - /** Gets or sets an object that indicates whether to customize the upload behavior in the FileExplorer. - */ - uploadSettings?: UploadSettings; + /** Gets or sets an object that indicates whether to customize the upload behavior in the FileExplorer. + */ + uploadSettings?: UploadSettings; - /** Specifies the width of FileExplorer control. - * @Default {850} - */ - width?: string|number; + /** Specifies the width of FileExplorer control. + * @Default {850} + */ + width?: string | number; - /** Fires before the AJAX request is performed. */ - beforeAjaxRequest?(e: BeforeAjaxRequestEventArgs): void; + /** Fires before the AJAX request is performed. */ + beforeAjaxRequest?(e: BeforeAjaxRequestEventArgs): void; - /** Fires before downloading the files. */ - beforeDownload?(e: BeforeDownloadEventArgs): void; + /** Fires before downloading the files. */ + beforeDownload?(e: BeforeDownloadEventArgs): void; - /** Fires before getting a requested image from server. Also this event will be triggered when you have enabled thumbnail image compression option in FileExplorer. - * Using this event, you can customize the image compression size. - */ - beforeGetImage?(e: BeforeGetImageEventArgs): void; + /** Fires before getting a requested image from server. Also this event will be triggered when you have enabled thumbnail image compression option in FileExplorer. + * Using this event, you can customize the image compression size. + */ + beforeGetImage?(e: BeforeGetImageEventArgs): void; - /** Fires before files or folders open. */ - beforeOpen?(e: BeforeOpenEventArgs): void; + /** Fires before files or folders open. */ + beforeOpen?(e: BeforeOpenEventArgs): void; - /** Fires before uploading the files. */ - beforeUpload?(e: BeforeUploadEventArgs): void; + /** Fires before uploading the files. */ + beforeUpload?(e: BeforeUploadEventArgs): void; - /** Fires when FileExplorer control was created */ - create?(e: CreateEventArgs): void; + /** Fires when FileExplorer control was created */ + create?(e: CreateEventArgs): void; - /** Fires when file or folder is copied successfully. */ - copy?(e: CopyEventArgs): void; + /** Fires when file or folder is copied successfully. */ + copy?(e: CopyEventArgs): void; - /** Fires when new folder is created successfully in file system. */ - createFolder?(e: CreateFolderEventArgs): void; + /** Fires when new folder is created successfully in file system. */ + createFolder?(e: CreateFolderEventArgs): void; - /** Fires when file or folder is cut successfully. */ - cut?(e: CutEventArgs): void; + /** Fires when file or folder is cut successfully. */ + cut?(e: CutEventArgs): void; - /** Fires when the FileExplorer is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; + /** Fires when the FileExplorer is destroyed successfully. */ + destroy?(e: DestroyEventArgs): void; - /** Fires when the files or directory has been started to drag over on the FileExplorer */ - dragStart?(e: DragStartEventArgs): void; + /** Fires when the files or directory has been started to drag over on the FileExplorer */ + dragStart?(e: DragStartEventArgs): void; - /** Fires when the files or directory is dragging over on the FileExplorer. */ - drag?(e: DragEventArgs): void; + /** Fires when the files or directory is dragging over on the FileExplorer. */ + drag?(e: DragEventArgs): void; - /** Fires when the files or directory has been stopped to drag over on FileExplorer */ - dragStop?(e: DragStopEventArgs): void; + /** Fires when the files or directory has been stopped to drag over on FileExplorer */ + dragStop?(e: DragStopEventArgs): void; - /** Fires when the files or directory is dropped to the target folder of FileExplorer */ - drop?(e: DropEventArgs): void; + /** Fires when the files or directory is dropped to the target folder of FileExplorer */ + drop?(e: DropEventArgs): void; - /** Fires after loading the requested image from server. Using this event, you can get the details of loaded image. */ - getImage?(e: GetImageEventArgs): void; + /** Fires after loading the requested image from server. Using this event, you can get the details of loaded image. */ + getImage?(e: GetImageEventArgs): void; - /** Fires when keydown in FileExplorer control. */ - keydown?(e: KeydownEventArgs): void; + /** Fires when keydown in FileExplorer control. */ + keydown?(e: KeydownEventArgs): void; - /** Fires when the file view type is changed. */ - layoutChange?(e: LayoutChangeEventArgs): void; + /** Fires when the file view type is changed. */ + layoutChange?(e: LayoutChangeEventArgs): void; - /** Fires when before the ContextMenu opening. */ - menuBeforeOpen?(e: MenuBeforeOpenEventArgs): void; + /** Fires when before the ContextMenu opening. */ + menuBeforeOpen?(e: MenuBeforeOpenEventArgs): void; - /** Fires when click the ContextMenu item. */ - menuClick?(e: MenuClickEventArgs): void; + /** Fires when click the ContextMenu item. */ + menuClick?(e: MenuClickEventArgs): void; - /** Fires when ContextMenu is successfully opened. */ - menuOpen?(e: MenuOpenEventArgs): void; + /** Fires when ContextMenu is successfully opened. */ + menuOpen?(e: MenuOpenEventArgs): void; - /** Fires when files are successfully opened. */ - open?(e: OpenEventArgs): void; + /** Fires when files are successfully opened. */ + open?(e: OpenEventArgs): void; - /** Fires when a file or folder is pasted successfully. */ - paste?(e: PasteEventArgs): void; + /** Fires when a file or folder is pasted successfully. */ + paste?(e: PasteEventArgs): void; - /** Fires when file or folder is deleted successfully. */ - remove?(e: RemoveEventArgs): void; + /** Fires when file or folder is deleted successfully. */ + remove?(e: RemoveEventArgs): void; - /** Fires when resizing is performed for FileExplorer. */ - resize?(e: ResizeEventArgs): void; + /** Fires when resizing is performed for FileExplorer. */ + resize?(e: ResizeEventArgs): void; - /** Fires when resizing is started for FileExplorer. */ - resizeStart?(e: ResizeStartEventArgs): void; + /** Fires when resizing is started for FileExplorer. */ + resizeStart?(e: ResizeStartEventArgs): void; - /** Fires this event when the resizing is stopped for FileExplorer. */ - resizeStop?(e: ResizeStopEventArgs): void; + /** Fires this event when the resizing is stopped for FileExplorer. */ + resizeStop?(e: ResizeStopEventArgs): void; - /** Fires when the items from grid view or tile view of FileExplorer control is selected. */ - select?(e: SelectEventArgs): void; + /** Fires when the items from grid view or tile view of FileExplorer control is selected. */ + select?(e: SelectEventArgs): void; - /** Triggered when refresh the template column elements in the grid view of FileExplorer control. */ - templateRefresh?(e: TemplateRefreshEventArgs): void; + /** Triggered when refresh the template column elements in the grid view of FileExplorer control. */ + templateRefresh?(e: TemplateRefreshEventArgs): void; - /** Fires when the items from grid view or tile view or large icons view of FileExplorer control is unselected. */ - unselect?(e: UnselectEventArgs): void; -} + /** Fires when the items from grid view or tile view or large icons view of FileExplorer control is unselected. */ + unselect?(e: UnselectEventArgs): void; + } -export interface BeforeAjaxRequestEventArgs { + export interface BeforeAjaxRequestEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the AJAX request data - */ - data?: any; + /** returns the AJAX request data + */ + data?: any; - /** returns the FileExplorer model - */ - model?: ej.FileExplorer.Model; + /** returns the FileExplorer model + */ + model?: ej.FileExplorer.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface BeforeDownloadEventArgs { + export interface BeforeDownloadEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the downloaded file names. - */ - files?: string[]; + /** returns the downloaded file names. + */ + files?: string[]; - /** returns the FileExplorer model. - */ - model?: ej.FileExplorer.Model; + /** returns the FileExplorer model. + */ + model?: ej.FileExplorer.Model; - /** returns the path of currently opened item. - */ - path?: string; + /** returns the path of currently opened item. + */ + path?: string; - /** returns the selected item details. - */ - selectedItems?: any; + /** returns the selected item details. + */ + selectedItems?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface BeforeGetImageEventArgs { + export interface BeforeGetImageEventArgs { - /** set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** enable or disable the image compress option. - */ - canCompress?: boolean; + /** enable or disable the image compress option. + */ + canCompress?: boolean; - /** returns the FileExplorer model. - */ - model?: ej.FileExplorer.Model; + /** returns the FileExplorer model. + */ + model?: ej.FileExplorer.Model; - /** returns the expected image size. - */ - size?: any; + /** returns the expected image size. + */ + size?: any; - /** returns the selected item details. - */ - selectedItems?: any; + /** returns the selected item details. + */ + selectedItems?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface BeforeOpenEventArgs { + export interface BeforeOpenEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the opened item type. - */ - itemType?: string; + /** returns the opened item type. + */ + itemType?: string; - /** returns the FileExplorer model. - */ - model?: ej.FileExplorer.Model; + /** returns the FileExplorer model. + */ + model?: ej.FileExplorer.Model; - /** returns the path of currently opened item. - */ - path?: string; + /** returns the path of currently opened item. + */ + path?: string; - /** returns the selected item details. - */ - selectedItems?: any; + /** returns the selected item details. + */ + selectedItems?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface BeforeUploadEventArgs { + export interface BeforeUploadEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the FileExplorer model. - */ - model?: ej.FileExplorer.Model; + /** returns the FileExplorer model. + */ + model?: ej.FileExplorer.Model; - /** returns the path of currently opened item. - */ - path?: string; + /** returns the path of currently opened item. + */ + path?: string; - /** returns the selected item details. - */ - selectedItems?: any; + /** returns the selected item details. + */ + selectedItems?: any; - /** returns the upload item details. - */ - uploadItemDetails?: any; + /** returns the upload item details. + */ + uploadItemDetails?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the FileExplorer model. - */ - model?: ej.FileExplorer.Model; + /** returns the FileExplorer model. + */ + model?: ej.FileExplorer.Model; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface CopyEventArgs { + export interface CopyEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the FileExplorer model. - */ - model?: ej.FileExplorer.Model; + /** returns the FileExplorer model. + */ + model?: ej.FileExplorer.Model; - /** returns the name of copied file/folder. - */ - name?: string[]; + /** returns the name of copied file/folder. + */ + name?: string[]; - /** returns the selected item details. - */ - selectedItems?: any; + /** returns the selected item details. + */ + selectedItems?: any; - /** returns the source path. - */ - sourcePath?: string; + /** returns the source path. + */ + sourcePath?: string; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface CreateFolderEventArgs { + export interface CreateFolderEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the AJAX response data - */ - data?: any; + /** returns the AJAX response data + */ + data?: any; - /** returns the FileExplorer model - */ - model?: ej.FileExplorer.Model; + /** returns the FileExplorer model + */ + model?: ej.FileExplorer.Model; - /** returns the selected item details - */ - selectedItems?: any; + /** returns the selected item details + */ + selectedItems?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface CutEventArgs { + export interface CutEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the FileExplorer model. - */ - model?: ej.FileExplorer.Model; + /** returns the FileExplorer model. + */ + model?: ej.FileExplorer.Model; - /** returns the name of moved file or folder. - */ - name?: string[]; + /** returns the name of moved file or folder. + */ + name?: string[]; - /** returns the selected item details. - */ - selectedItems?: any; + /** returns the selected item details. + */ + selectedItems?: any; - /** returns the source path. - */ - sourcePath?: string; + /** returns the source path. + */ + sourcePath?: string; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the FileExplorer model. - */ - model?: ej.FileExplorer.Model; + /** returns the FileExplorer model. + */ + model?: ej.FileExplorer.Model; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface DragStartEventArgs { + export interface DragStartEventArgs { - /** set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the FileExplorer model. - */ - model?: ej.FileExplorer.Model; + /** returns the FileExplorer model. + */ + model?: ej.FileExplorer.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the dragging element. - */ - target?: any; + /** returns the dragging element. + */ + target?: any; - /** returns the path of dragging element. - */ - targetPath?: string; + /** returns the path of dragging element. + */ + targetPath?: string; - /** returns the dragging file details. - */ - selectedItems?: any; -} + /** returns the dragging file details. + */ + selectedItems?: any; + } -export interface DragEventArgs { + export interface DragEventArgs { - /** set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the FileExplorer model. - */ - model?: ej.FileExplorer.Model; + /** returns the FileExplorer model. + */ + model?: ej.FileExplorer.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the target element. - */ - target?: any; + /** returns the target element. + */ + target?: any; - /** returns the name of target element. - */ - targetElementName?: string; + /** returns the name of target element. + */ + targetElementName?: string; - /** returns the path of target element. - */ - targetPath?: string; -} + /** returns the path of target element. + */ + targetPath?: string; + } -export interface DragStopEventArgs { + export interface DragStopEventArgs { - /** set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the FileExplorer model. - */ - model?: ej.FileExplorer.Model; + /** returns the FileExplorer model. + */ + model?: ej.FileExplorer.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the target element. - */ - target?: any; + /** returns the target element. + */ + target?: any; - /** returns the path of target element. - */ - targetPath?: string; + /** returns the path of target element. + */ + targetPath?: string; - /** returns the name of target element - */ - targetElementName?: string; + /** returns the name of target element + */ + targetElementName?: string; - /** returns the action, which is performed after dropping the files (upload/ move). - */ - dropAction?: string; + /** returns the action, which is performed after dropping the files (upload/ move). + */ + dropAction?: string; - /** returns the dragging file details - */ - fileInfo?: any; -} + /** returns the dragging file details + */ + fileInfo?: any; + } -export interface DropEventArgs { + export interface DropEventArgs { - /** set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the FileExplorer model. - */ - model?: ej.FileExplorer.Model; + /** returns the FileExplorer model. + */ + model?: ej.FileExplorer.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the target element. - */ - target?: any; + /** returns the target element. + */ + target?: any; - /** returns the name of target folder. - */ - targetFolder?: string; + /** returns the name of target folder. + */ + targetFolder?: string; - /** returns the path of target folder. - */ - targetPath?: string; + /** returns the path of target folder. + */ + targetPath?: string; - /** returns the dragging element details. - */ - fileInfo?: any; + /** returns the dragging element details. + */ + fileInfo?: any; - /** returns the action, which is performed after dropping the files (upload/ move). - */ - dropAction?: string; -} + /** returns the action, which is performed after dropping the files (upload/ move). + */ + dropAction?: string; + } -export interface GetImageEventArgs { + export interface GetImageEventArgs { - /** set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** loaded image path. - */ - path?: string; + /** loaded image path. + */ + path?: string; - /** loaded image element - */ - element?: any; + /** loaded image element + */ + element?: any; - /** returns the FileExplorer model. - */ - model?: ej.FileExplorer.Model; + /** returns the FileExplorer model. + */ + model?: ej.FileExplorer.Model; - /** original arguments of image load or error event - */ - originalArgs?: any; + /** original arguments of image load or error event + */ + originalArgs?: any; - /** returns the action type, which specifies thumbnail preview or opening image. - */ - action?: string; + /** returns the action type, which specifies thumbnail preview or opening image. + */ + action?: string; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface KeydownEventArgs { + export interface KeydownEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the downed key keyCode value - */ - keyCode?: number; + /** returns the downed key keyCode value + */ + keyCode?: number; - /** returns altKey value. - */ - altKey?: boolean; + /** returns altKey value. + */ + altKey?: boolean; - /** returns shiftKey value. - */ - shiftKey?: boolean; + /** returns shiftKey value. + */ + shiftKey?: boolean; - /** returns ctrlKey value. - */ - ctrlKey?: boolean; + /** returns ctrlKey value. + */ + ctrlKey?: boolean; - /** returns the event object. - */ - originalArgs?: any; + /** returns the event object. + */ + originalArgs?: any; - /** returns the FileExplorer model. - */ - model?: ej.FileExplorer.Model; + /** returns the FileExplorer model. + */ + model?: ej.FileExplorer.Model; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface LayoutChangeEventArgs { + export interface LayoutChangeEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** return true when we change the layout via interaction, else false. - */ - isInteraction?: boolean; + /** return true when we change the layout via interaction, else false. + */ + isInteraction?: boolean; - /** returns the current view type. - */ - layoutType?: string; + /** returns the current view type. + */ + layoutType?: string; - /** returns the FileExplorer model. - */ - model?: any; + /** returns the FileExplorer model. + */ + model?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface MenuBeforeOpenEventArgs { + export interface MenuBeforeOpenEventArgs { - /** set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the name of ContextMenu items group. - */ - contextMenu?: string; + /** returns the name of ContextMenu items group. + */ + contextMenu?: string; - /** returns the dataSource of ContextMenu. - */ - dataSource?: any[]; + /** returns the dataSource of ContextMenu. + */ + dataSource?: any[]; - /** returns the element of ContextMenu. - */ - element?: any; + /** returns the element of ContextMenu. + */ + element?: any; - /** returns the event of ContextMenu. - */ - events?: any; + /** returns the event of ContextMenu. + */ + events?: any; - /** returns the FileExplorer model. - */ - model?: ej.FileExplorer.Model; + /** returns the FileExplorer model. + */ + model?: ej.FileExplorer.Model; - /** returns the target element. - */ - target?: any; + /** returns the target element. + */ + target?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface MenuClickEventArgs { + export interface MenuClickEventArgs { - /** returns the ID of clicked ContextMenu item. - */ - ID?: string; + /** returns the ID of clicked ContextMenu item. + */ + ID?: string; - /** set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the name of ContextMenu items group. - */ - contextMenu?: string; + /** returns the name of ContextMenu items group. + */ + contextMenu?: string; - /** returns the element of clicked ContextMenu item. - */ - element?: any; + /** returns the element of clicked ContextMenu item. + */ + element?: any; - /** returns the event of ContextMenu. - */ - event?: any; + /** returns the event of ContextMenu. + */ + event?: any; - /** returns the FileExplorer model. - */ - model?: ej.FileExplorer.Model; + /** returns the FileExplorer model. + */ + model?: ej.FileExplorer.Model; - /** returns the parent element ID of clicked ContextMenu item. - */ - parentId?: string; + /** returns the parent element ID of clicked ContextMenu item. + */ + parentId?: string; - /** returns the parent element text of clicked ContextMenu item. - */ - parentText?: string; + /** returns the parent element text of clicked ContextMenu item. + */ + parentText?: string; - /** returns the text of clicked ContextMenu item. - */ - text?: string; + /** returns the text of clicked ContextMenu item. + */ + text?: string; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface MenuOpenEventArgs { + export interface MenuOpenEventArgs { - /** set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the name of ContextMenu items group. - */ - contextMenu?: string; + /** returns the name of ContextMenu items group. + */ + contextMenu?: string; - /** returns the element of ContextMenu. - */ - element?: any; + /** returns the element of ContextMenu. + */ + element?: any; - /** returns the FileExplorer model. - */ - model?: ej.FileExplorer.Model; + /** returns the FileExplorer model. + */ + model?: ej.FileExplorer.Model; - /** returns the target element. - */ - target?: any; + /** returns the target element. + */ + target?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface OpenEventArgs { + export interface OpenEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the opened item type. - */ - itemType?: string; + /** returns the opened item type. + */ + itemType?: string; - /** returns the FileExplorer model. - */ - model?: ej.FileExplorer.Model; + /** returns the FileExplorer model. + */ + model?: ej.FileExplorer.Model; - /** returns the path of currently opened item. - */ - path?: string; + /** returns the path of currently opened item. + */ + path?: string; - /** returns the selected item details. - */ - selectedItems?: any; + /** returns the selected item details. + */ + selectedItems?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface PasteEventArgs { + export interface PasteEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the FileExplorer model. - */ - model?: ej.FileExplorer.Model; + /** returns the FileExplorer model. + */ + model?: ej.FileExplorer.Model; - /** returns the name of moved/copied file or folder. - */ - name?: string[]; + /** returns the name of moved/copied file or folder. + */ + name?: string[]; - /** returns the selected item details. - */ - selectedItems?: any; + /** returns the selected item details. + */ + selectedItems?: any; - /** returns the target folder item details. - */ - targetFolder?: any; + /** returns the target folder item details. + */ + targetFolder?: any; - /** returns the target path. - */ - targetPath?: string; + /** returns the target path. + */ + targetPath?: string; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface RemoveEventArgs { + export interface RemoveEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the AJAX response data. - */ - data?: any; + /** returns the AJAX response data. + */ + data?: any; - /** returns the FileExplorer model. - */ - model?: ej.FileExplorer.Model; + /** returns the FileExplorer model. + */ + model?: ej.FileExplorer.Model; - /** returns the names of deleted items. - */ - name?: string; + /** returns the names of deleted items. + */ + name?: string; - /** returns the path of deleted item. - */ - path?: string; + /** returns the path of deleted item. + */ + path?: string; - /** returns the removed item details. - */ - selectedItems?: any; + /** returns the removed item details. + */ + selectedItems?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface ResizeEventArgs { + export interface ResizeEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the mouse move event args. - */ - event?: any; + /** returns the mouse move event args. + */ + event?: any; - /** returns the FileExplorer model. - */ - model?: ej.FileExplorer.Model; + /** returns the FileExplorer model. + */ + model?: ej.FileExplorer.Model; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface ResizeStartEventArgs { + export interface ResizeStartEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the mouse down event args. - */ - event?: any; + /** returns the mouse down event args. + */ + event?: any; - /** returns the FileExplorer model. - */ - model?: ej.FileExplorer.Model; + /** returns the FileExplorer model. + */ + model?: ej.FileExplorer.Model; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface ResizeStopEventArgs { + export interface ResizeStopEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the mouse leave event args. - */ - event?: any; + /** returns the mouse leave event args. + */ + event?: any; - /** returns the FileExplorer model. - */ - model?: ej.FileExplorer.Model; + /** returns the FileExplorer model. + */ + model?: ej.FileExplorer.Model; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface SelectEventArgs { + export interface SelectEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the FileExplorer model. - */ - model?: ej.FileExplorer.Model; + /** returns the FileExplorer model. + */ + model?: ej.FileExplorer.Model; - /** returns the name of selected items. - */ - name?: string[]; + /** returns the name of selected items. + */ + name?: string[]; - /** returns the path of selected items. - */ - path?: string; + /** returns the path of selected items. + */ + path?: string; - /** returns the selected item details - */ - selectedItems?: any; + /** returns the selected item details + */ + selectedItems?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface TemplateRefreshEventArgs { + export interface TemplateRefreshEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** Returns the cell object. - */ - cell?: ej.FileExplorer.Model; + /** Returns the cell object. + */ + cell?: ej.FileExplorer.Model; - /** Returns the column object. - */ - column?: any; + /** Returns the column object. + */ + column?: any; - /** Returns the current row data. - */ - data?: any; + /** Returns the current row data. + */ + data?: any; - /** Returns the grid model of FileExplorer. - */ - model?: any; + /** Returns the grid model of FileExplorer. + */ + model?: any; - /** Returns the current row index. - */ - rowIndex?: number; + /** Returns the current row index. + */ + rowIndex?: number; - /** returns the name of the event. - */ - type?: string; -} - -export interface UnselectEventArgs { - - /** Returns the FileExplorer model. - */ - model?: ej.FileExplorer.Model; + /** returns the name of the event. + */ + type?: string; + } + + export interface UnselectEventArgs { + + /** Returns the FileExplorer model. + */ + model?: ej.FileExplorer.Model; - /** Returns the name of unselected item. - */ - name?: string; + /** Returns the name of unselected item. + */ + name?: string; - /** Returns the name of unselected items. - */ - names?: string[]; + /** Returns the name of unselected items. + */ + names?: string[]; - /** Returns the type of unselected item. - */ - nodeType?: string; + /** Returns the type of unselected item. + */ + nodeType?: string; - /** Returns the path of unselected item. - */ - path?: string; + /** Returns the path of unselected item. + */ + path?: string; - /** Returns the name of the event. - */ - type?: string; - - /** Returns the unselected item details. - */ - unselectedItem?: any; - - /** Returns the unselected items details. - */ - unselectedItems?: any[]; -} - -export interface ContextMenuSettings { - - /** The items property is used to configure and group the required ContextMenu items in FileExplorer control. - * @Default {{% highlight javascript %}{navbar: [NewFolder, Upload, |, Delete, Rename, |, Cut, Copy, Paste, |, Getinfo],cwd: [Refresh, Paste,|, SortBy, |, NewFolder, Upload, |, - * Getinfo],files: [Open, Download, |, Upload, |, Delete, Rename, |, Cut, Copy, Paste, |, OpenFolderLocation, Getinfo]}{% endhighlight %}} - */ - items?: any; - - /** The customMenuFields property is used to define custom functionality for custom ContextMenu item's which are defined in items property. - * @Default {[]} - */ - customMenuFields?: any[]; -} - -export interface FilterSettings { - - /** It allows to search the text given in search Textbox in every keyup event. When this property was set as false, searching will works only on Enter key and searchbar blur. - * @Default {true} - */ - allowSearchOnTyping?: boolean; - - /** Enables or disables to perform the filter operation with case sensitive. - * @Default {false} - */ - caseSensitiveSearch?: boolean; - - /** Sets the search filter type. There are several filter types available such as "startswith", "contains", "endswith". See filterType. - * @Default {ej.FileExplorer.filterType.Contains} - */ - filterType?: ej.FilterType|string; -} - -export interface GridSettings { - - /** Allows to Resize the width of the columns by simply click and move the particular column header line. - * @Default {true} - */ - allowResizing?: boolean; - - /** Gets or sets a value that indicates whether to enable the dynamic sorting behavior on grid data. Sorting can be done through clicking on particular column header. - * @Default {true} - */ - allowSorting?: boolean; - - /** Gets or sets an object that indicates to render the grid with specified columns. You can use this property same as the column property in Grid control. - * @Default {[{ field: name, headerText: Name, width: 30% }, { field: dateModified, headerText: Date Modified, width: 30% }, { field: type, headerText: Type, width: 15% }, - * { field: size, headerText: Size, width: 12%, textAlign: right, headerTextAlign: left }]} - */ - columns?: any[]; -} - -export interface UploadSettings { - - /** Specifies the maximum file size allowed to upload. It accepts the value in bytes. - * @Default {31457280} - */ - maxFileSize?: number; - - /** Enables or disables the multiple files upload. When it is enabled, you can upload multiple files at a time and when disabled, you can upload only one file at a time. - * @Default {true} - */ - allowMultipleFile?: boolean; - - /** Enables or disables the auto upload option while uploading files in FileExplorer control. - * @Default {false} - */ - autoUpload?: boolean; -} - -enum layoutType { - - ///Supports to display files in tile view - Tile, - - ///Supports to display files in grid view - Grid, - - ///Supports to display files as large icons - LargeIcons -} - -} - -class DatePicker extends ej.Widget { - static fn: DatePicker; - constructor(element: JQuery | Element, options?: DatePicker.Model); - static Locale: any; - model: DatePicker.Model; - defaults: DatePicker.Model; - - /** Disables the DatePicker control. - * @returns {void} - */ - disable(): void; - - /** Enable the DatePicker control, if it is in disabled state. - * @returns {void} - */ - enable(): void; - - /** Returns the current date value in the DatePicker control. - * @returns {string} - */ - getValue(): string; - - /** Close the DatePicker popup, if it is in opened state. - * @returns {void} - */ - hide(): void; - - /** Opens the DatePicker popup. - * @returns {void} - */ - show(): void; -} -export namespace DatePicker { - -export interface Model { - - /** Used to allow or restrict the editing in DatePicker input field directly. By setting false to this API, You can only pick the date from DatePicker popup. - * @Default {true} - */ - allowEdit?: boolean; - - /** allow or restrict the drill down to multiple levels of view (month/year/decade) in DatePicker calendar - * @Default {true} - */ - allowDrillDown?: boolean; - - /** Disable the list of specified date value. - * @Default {{}} - */ - blackoutDates?: any; - - /** Sets the specified text value to the today button in the DatePicker calendar. - * @Default {Today} - */ - buttonText?: string; - - /** Sets the root CSS class for DatePicker theme, which is used customize. - */ - cssClass?: string; - - /** Formats the value of the DatePicker in to the specified date format. If this API is not specified, dateFormat will be set based on the current culture of DatePicker. - * @Default {MM/dd/yyyy} - */ - dateFormat?: string; - - /** Specifies the header format of days in DatePicker calendar. See below to get available Headers options - * @Default {ej.DatePicker.Header.Short} - */ - dayHeaderFormat?: string | ej.DatePicker.Header; - - /** Specifies the navigation depth level in DatePicker calendar. This option is not applied when start level view option is lower than depth level view. - * See below to know available levels in DatePicker Calendar - */ - depthLevel?: string | ej.DatePicker.Level; - - /** Allows to embed the DatePicker calendar in the page. Also associates DatePicker with div element instead of input. - * @Default {false} - */ - displayInline?: boolean; - - /** Enables or disables the animation effect with DatePicker calendar. - * @Default {true} - */ - enableAnimation?: boolean; - - /** Enable or disable the DatePicker control. - * @Default {true} - */ - enabled?: boolean; - - /** Sustain the entire widget model of DatePicker even after form post or browser refresh - * @Default {false} - */ - enablePersistence?: boolean; - - /** Displays DatePicker calendar along with DatePicker input field in Right to Left direction. - * @Default {false} - */ - enableRTL?: boolean; - - /** Allows to enter valid or invalid date in input textbox and indicate as error if it is invalid value, when this API value is set to true. For false value, invalid date is not allowed - * to input field and corrected to valid date automatically, even if invalid date is given. - * @Default {false} - */ - enableStrictMode?: boolean; - - /** Used the required fields for special Dates in DatePicker in order to customize the special dates in a calendar. - * @Default {null} - */ - fields?: Fields; - - /** Specifies the header format to be displayed in the DatePicker calendar. - * @Default {MMMM yyyy} - */ - headerFormat?: string; - - /** Specifies the height of the DatePicker input text. - * @Default {28px} - */ - height?: string; - - /** HighlightSection is used to highlight currently selected date's month/week/workdays. See below to get available HighlightSection options - * @Default {none} - */ - highlightSection?: string | ej.DatePicker.HighlightSection; - - /** Weekend dates will be highlighted when this property is set to true. - * @Default {false} - */ - highlightWeekend?: boolean; - - /** Specifies the HTML Attributes of the DatePicker. - * @Default {{}} - */ - htmlAttributes?: any; - - /** Change the DatePicker calendar and date format based on given culture. - * @Default {en-US} - */ - locale?: string; - - /** Specifies the maximum date in the calendar that the user can select. - * @Default {new Date(2099, 11, 31)} - */ - maxDate?: string|Date; - - /** Specifies the minimum date in the calendar that the user can select. - * @Default {new Date(1900, 00, 01)} - */ - minDate?: string|Date; - - /** Allows to toggles the read only state of the DatePicker. When the widget is readOnly, it doesn't allow your input. - * @Default {false} - */ - readOnly?: boolean; - - /** It allow to show/hide the disabled date ranges - * @Default {true} - */ - showDisabledRange?: boolean; - - /** It allows to display footer in DatePicker calendar. - * @Default {true} - */ - showFooter?: boolean; - - /** It allows to display/hides the other months days from the current month calendar in a DatePicker. - * @Default {true} - */ - showOtherMonths?: boolean; - - /** Shows/hides the date icon button at right side of textbox, which is used to open or close the DatePicker calendar popup. - * @Default {true} - */ - showPopupButton?: boolean; - - /** DatePicker input is displayed with rounded corner when this property is set to true. - * @Default {false} - */ - showRoundedCorner?: boolean; - - /** Used to show the tooltip when hovering on the days in the DatePicker calendar. - * @Default {true} - */ - showTooltip?: boolean; - - /** Specifies the special dates in DatePicker. - * @Default {null} - */ - specialDates?: any; - - /** Specifies the start day of the week in DatePicker calendar. - * @Default {0} - */ - startDay?: number; - - /** Specifies the start level view in DatePicker calendar. See below available Levels - * @Default {ej.DatePicker.Level.Month} - */ - startLevel?: string | ej.DatePicker.Level; - - /** Specifies the number of months to be navigate for one click of next and previous button in a DatePicker Calendar. - * @Default {1} - */ - stepMonths?: number; - - /** Provides option to customize the tooltip format. - * @Default {ddd MMM dd yyyy} - */ - tooltipFormat?: string; - - /** Sets the jQuery validation support to DatePicker Date value. See validation - * @Default {null} - */ - validationMessage?: any; - - /** Sets the jQuery validation custom rules to the DatePicker. see validation - * @Default {null} - */ - validationRules?: any; - - /** sets or returns the current value of DatePicker - * @Default {null} - */ - value?: string|Date; - - /** Specifies the water mark text to be displayed in input text. - * @Default {Select date} - */ - watermarkText?: string; - - /** Specifies the width of the DatePicker input text. - * @Default {160px} - */ - width?: string; - - /** Fires before closing the DatePicker popup. */ - beforeClose?(e: BeforeCloseEventArgs): void; - - /** Fires when each date is created in the DatePicker popup calendar. */ - beforeDateCreate?(e: BeforeDateCreateEventArgs): void; - - /** Fires before opening the DatePicker popup. */ - beforeOpen?(e: BeforeOpenEventArgs): void; - - /** Fires when the DatePicker input value is changed. */ - change?(e: ChangeEventArgs): void; + /** Returns the name of the event. + */ + type?: string; + + /** Returns the unselected item details. + */ + unselectedItem?: any; + + /** Returns the unselected items details. + */ + unselectedItems?: any[]; + } + + export interface ContextMenuSettings { + + /** The items property is used to configure and group the required ContextMenu items in FileExplorer control. + * @Default {{% highlight javascript %}{navbar: [NewFolder, Upload, |, Delete, Rename, |, Cut, Copy, Paste, |, Getinfo],cwd: [Refresh, Paste,|, SortBy, |, NewFolder, Upload, |, + * Getinfo],files: [Open, Download, |, Upload, |, Delete, Rename, |, Cut, Copy, Paste, |, OpenFolderLocation, Getinfo]}{% endhighlight %}} + */ + items?: any; + + /** The customMenuFields property is used to define custom functionality for custom ContextMenu item's which are defined in items property. + * @Default {[]} + */ + customMenuFields?: any[]; + } + + export interface FilterSettings { + + /** It allows to search the text given in search Textbox in every keyup event. When this property was set as false, searching will works only on Enter key and searchbar blur. + * @Default {true} + */ + allowSearchOnTyping?: boolean; + + /** Enables or disables to perform the filter operation with case sensitive. + * @Default {false} + */ + caseSensitiveSearch?: boolean; + + /** Sets the search filter type. There are several filter types available such as "startswith", "contains", "endswith". See filterType. + * @Default {ej.FileExplorer.filterType.Contains} + */ + filterType?: ej.FilterType | string; + } + + export interface GridSettings { + + /** Allows to Resize the width of the columns by simply click and move the particular column header line. + * @Default {true} + */ + allowResizing?: boolean; + + /** Gets or sets a value that indicates whether to enable the dynamic sorting behavior on grid data. Sorting can be done through clicking on particular column header. + * @Default {true} + */ + allowSorting?: boolean; + + /** Gets or sets an object that indicates to render the grid with specified columns. You can use this property same as the column property in Grid control. + * @Default {[{ field: name, headerText: Name, width: 30% }, { field: dateModified, headerText: Date Modified, width: 30% }, { field: type, headerText: Type, width: 15% }, + * { field: size, headerText: Size, width: 12%, textAlign: right, headerTextAlign: left }]} + */ + columns?: any[]; + } + + export interface UploadSettings { + + /** Specifies the maximum file size allowed to upload. It accepts the value in bytes. + * @Default {31457280} + */ + maxFileSize?: number; + + /** Enables or disables the multiple files upload. When it is enabled, you can upload multiple files at a time and when disabled, you can upload only one file at a time. + * @Default {true} + */ + allowMultipleFile?: boolean; + + /** Enables or disables the auto upload option while uploading files in FileExplorer control. + * @Default {false} + */ + autoUpload?: boolean; + } + + enum layoutType { + + ///Supports to display files in tile view + Tile, + + ///Supports to display files in grid view + Grid, + + ///Supports to display files as large icons + LargeIcons + } + + } + + class DatePicker extends ej.Widget { + static fn: DatePicker; + constructor(element: JQuery | Element, options?: DatePicker.Model); + static Locale: any; + model: DatePicker.Model; + defaults: DatePicker.Model; + + /** Disables the DatePicker control. + * @returns {void} + */ + disable(): void; + + /** Enable the DatePicker control, if it is in disabled state. + * @returns {void} + */ + enable(): void; + + /** Returns the current date value in the DatePicker control. + * @returns {string} + */ + getValue(): string; + + /** Close the DatePicker popup, if it is in opened state. + * @returns {void} + */ + hide(): void; + + /** Opens the DatePicker popup. + * @returns {void} + */ + show(): void; + } + export namespace DatePicker { + + export interface Model { + + /** Used to allow or restrict the editing in DatePicker input field directly. By setting false to this API, You can only pick the date from DatePicker popup. + * @Default {true} + */ + allowEdit?: boolean; + + /** allow or restrict the drill down to multiple levels of view (month/year/decade) in DatePicker calendar + * @Default {true} + */ + allowDrillDown?: boolean; + + /** Disable the list of specified date value. + * @Default {{}} + */ + blackoutDates?: any; + + /** Sets the specified text value to the today button in the DatePicker calendar. + * @Default {Today} + */ + buttonText?: string; + + /** Sets the root CSS class for DatePicker theme, which is used customize. + */ + cssClass?: string; + + /** Formats the value of the DatePicker in to the specified date format. If this API is not specified, dateFormat will be set based on the current culture of DatePicker. + * @Default {MM/dd/yyyy} + */ + dateFormat?: string; + + /** Specifies the header format of days in DatePicker calendar. See below to get available Headers options + * @Default {ej.DatePicker.Header.Short} + */ + dayHeaderFormat?: string | ej.DatePicker.Header; + + /** Specifies the navigation depth level in DatePicker calendar. This option is not applied when start level view option is lower than depth level view. + * See below to know available levels in DatePicker Calendar + */ + depthLevel?: string | ej.DatePicker.Level; + + /** Allows to embed the DatePicker calendar in the page. Also associates DatePicker with div element instead of input. + * @Default {false} + */ + displayInline?: boolean; + + /** Enables or disables the animation effect with DatePicker calendar. + * @Default {true} + */ + enableAnimation?: boolean; + + /** Enable or disable the DatePicker control. + * @Default {true} + */ + enabled?: boolean; + + /** Sustain the entire widget model of DatePicker even after form post or browser refresh + * @Default {false} + */ + enablePersistence?: boolean; + + /** Displays DatePicker calendar along with DatePicker input field in Right to Left direction. + * @Default {false} + */ + enableRTL?: boolean; + + /** Allows to enter valid or invalid date in input textbox and indicate as error if it is invalid value, when this API value is set to true. For false value, invalid date is not allowed + * to input field and corrected to valid date automatically, even if invalid date is given. + * @Default {false} + */ + enableStrictMode?: boolean; + + /** Used the required fields for special Dates in DatePicker in order to customize the special dates in a calendar. + * @Default {null} + */ + fields?: Fields; + + /** Specifies the header format to be displayed in the DatePicker calendar. + * @Default {MMMM yyyy} + */ + headerFormat?: string; + + /** Specifies the height of the DatePicker input text. + * @Default {28px} + */ + height?: string; + + /** HighlightSection is used to highlight currently selected date's month/week/workdays. See below to get available HighlightSection options + * @Default {none} + */ + highlightSection?: string | ej.DatePicker.HighlightSection; + + /** Weekend dates will be highlighted when this property is set to true. + * @Default {false} + */ + highlightWeekend?: boolean; + + /** Specifies the HTML Attributes of the DatePicker. + * @Default {{}} + */ + htmlAttributes?: any; + + /** Change the DatePicker calendar and date format based on given culture. + * @Default {en-US} + */ + locale?: string; + + /** Specifies the maximum date in the calendar that the user can select. + * @Default {new Date(2099, 11, 31)} + */ + maxDate?: string | Date; + + /** Specifies the minimum date in the calendar that the user can select. + * @Default {new Date(1900, 00, 01)} + */ + minDate?: string | Date; + + /** Allows to toggles the read only state of the DatePicker. When the widget is readOnly, it doesn't allow your input. + * @Default {false} + */ + readOnly?: boolean; + + /** It allow to show/hide the disabled date ranges + * @Default {true} + */ + showDisabledRange?: boolean; + + /** It allows to display footer in DatePicker calendar. + * @Default {true} + */ + showFooter?: boolean; + + /** It allows to display/hides the other months days from the current month calendar in a DatePicker. + * @Default {true} + */ + showOtherMonths?: boolean; + + /** Shows/hides the date icon button at right side of textbox, which is used to open or close the DatePicker calendar popup. + * @Default {true} + */ + showPopupButton?: boolean; + + /** DatePicker input is displayed with rounded corner when this property is set to true. + * @Default {false} + */ + showRoundedCorner?: boolean; + + /** Used to show the tooltip when hovering on the days in the DatePicker calendar. + * @Default {true} + */ + showTooltip?: boolean; + + /** Specifies the special dates in DatePicker. + * @Default {null} + */ + specialDates?: any; + + /** Specifies the start day of the week in DatePicker calendar. + * @Default {0} + */ + startDay?: number; + + /** Specifies the start level view in DatePicker calendar. See below available Levels + * @Default {ej.DatePicker.Level.Month} + */ + startLevel?: string | ej.DatePicker.Level; + + /** Specifies the number of months to be navigate for one click of next and previous button in a DatePicker Calendar. + * @Default {1} + */ + stepMonths?: number; + + /** Provides option to customize the tooltip format. + * @Default {ddd MMM dd yyyy} + */ + tooltipFormat?: string; + + /** Sets the jQuery validation support to DatePicker Date value. See validation + * @Default {null} + */ + validationMessage?: any; + + /** Sets the jQuery validation custom rules to the DatePicker. see validation + * @Default {null} + */ + validationRules?: any; + + /** sets or returns the current value of DatePicker + * @Default {null} + */ + value?: string | Date; + + /** Specifies the water mark text to be displayed in input text. + * @Default {Select date} + */ + watermarkText?: string; + + /** Specifies the width of the DatePicker input text. + * @Default {160px} + */ + width?: string; + + /** Fires before closing the DatePicker popup. */ + beforeClose?(e: BeforeCloseEventArgs): void; + + /** Fires when each date is created in the DatePicker popup calendar. */ + beforeDateCreate?(e: BeforeDateCreateEventArgs): void; + + /** Fires before opening the DatePicker popup. */ + beforeOpen?(e: BeforeOpenEventArgs): void; + + /** Fires when the DatePicker input value is changed. */ + change?(e: ChangeEventArgs): void; - /** Fires when DatePicker popup is closed. */ - close?(e: CloseEventArgs): void; + /** Fires when DatePicker popup is closed. */ + close?(e: CloseEventArgs): void; - /** Fires when the DatePicker is created successfully. */ - create?(e: CreateEventArgs): void; + /** Fires when the DatePicker is created successfully. */ + create?(e: CreateEventArgs): void; - /** Fires when the DatePicker is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; + /** Fires when the DatePicker is destroyed successfully. */ + destroy?(e: DestroyEventArgs): void; - /** Fires when DatePicker input gets focus. */ - focusIn?(e: FocusInEventArgs): void; + /** Fires when DatePicker input gets focus. */ + focusIn?(e: FocusInEventArgs): void; - /** Fires when DatePicker input loses the focus. */ - focusOut?(e: FocusOutEventArgs): void; + /** Fires when DatePicker input loses the focus. */ + focusOut?(e: FocusOutEventArgs): void; - /** Fires when calender view navigates to month/year/decade/century. */ - navigate?(e: NavigateEventArgs): void; + /** Fires when calender view navigates to month/year/decade/century. */ + navigate?(e: NavigateEventArgs): void; - /** Fires when DatePicker popup is opened. */ - open?(e: OpenEventArgs): void; + /** Fires when DatePicker popup is opened. */ + open?(e: OpenEventArgs): void; - /** Fires when a date is selected from the DatePicker popup. */ - select?(e: SelectEventArgs): void; -} + /** Fires when a date is selected from the DatePicker popup. */ + select?(e: SelectEventArgs): void; + } -export interface BeforeCloseEventArgs { + export interface BeforeCloseEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the DatePicker model. - */ - model?: ej.DatePicker.Model; + /** returns the DatePicker model. + */ + model?: ej.DatePicker.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the event parameters from DatePicker. - */ - events?: any; + /** returns the event parameters from DatePicker. + */ + events?: any; - /** returns the DatePicker popup. - */ - element?: HTMLElement; -} + /** returns the DatePicker popup. + */ + element?: HTMLElement; + } -export interface BeforeDateCreateEventArgs { + export interface BeforeDateCreateEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the DatePicker model. - */ - model?: ej.DatePicker.Model; + /** returns the DatePicker model. + */ + model?: ej.DatePicker.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the currently created date object. - */ - date?: any; + /** returns the currently created date object. + */ + date?: any; - /** returns the current DOM object of the date from the Calendar. - */ - element?: HTMLElement; + /** returns the current DOM object of the date from the Calendar. + */ + element?: HTMLElement; - /** returns the currently created date as string type. - */ - value?: string; -} + /** returns the currently created date as string type. + */ + value?: string; + } -export interface BeforeOpenEventArgs { + export interface BeforeOpenEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the DatePicker model. - */ - model?: ej.DatePicker.Model; + /** returns the DatePicker model. + */ + model?: ej.DatePicker.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the event parameters from DatePicker. - */ - events?: any; + /** returns the event parameters from DatePicker. + */ + events?: any; - /** returns the DatePicker popup. - */ - element?: HTMLElement; -} + /** returns the DatePicker popup. + */ + element?: HTMLElement; + } -export interface ChangeEventArgs { + export interface ChangeEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the DatePicker model. - */ - model?: ej.DatePicker.Model; + /** returns the DatePicker model. + */ + model?: ej.DatePicker.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the DatePicker input value. - */ - value?: string; + /** returns the DatePicker input value. + */ + value?: string; - /** returns the previously selected value. - */ - prevDate?: string; -} + /** returns the previously selected value. + */ + prevDate?: string; + } -export interface CloseEventArgs { + export interface CloseEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the current date object. - */ - date?: any; + /** returns the current date object. + */ + date?: any; - /** returns the DatePicker model. - */ - model?: ej.DatePicker.Model; + /** returns the DatePicker model. + */ + model?: ej.DatePicker.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the current date value. - */ - value?: string; + /** returns the current date value. + */ + value?: string; - /** returns the previously selected value. - */ - prevDate?: string; -} + /** returns the previously selected value. + */ + prevDate?: string; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the DatePicker model. - */ - model?: ej.DatePicker.Model; + /** returns the DatePicker model. + */ + model?: ej.DatePicker.Model; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the DatePicker model. - */ - model?: ej.DatePicker.Model; + /** returns the DatePicker model. + */ + model?: ej.DatePicker.Model; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface FocusInEventArgs { + export interface FocusInEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the DatePicker model. - */ - model?: ej.DatePicker.Model; + /** returns the DatePicker model. + */ + model?: ej.DatePicker.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the currently selected date value. - */ - value?: string; -} + /** returns the currently selected date value. + */ + value?: string; + } -export interface FocusOutEventArgs { + export interface FocusOutEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the DatePicker model. - */ - model?: ej.DatePicker.Model; + /** returns the DatePicker model. + */ + model?: ej.DatePicker.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the currently selected date value. - */ - value?: string; + /** returns the currently selected date value. + */ + value?: string; - /** returns the previously selected date value. - */ - prevDate?: string; -} + /** returns the previously selected date value. + */ + prevDate?: string; + } -export interface NavigateEventArgs { + export interface NavigateEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the current date object. - */ - date?: any; + /** returns the current date object. + */ + date?: any; - /** returns the DatePicker model. - */ - model?: ej.DatePicker.Model; + /** returns the DatePicker model. + */ + model?: ej.DatePicker.Model; - /** returns the previous view state of calendar. - */ - navigateFrom?: string; + /** returns the previous view state of calendar. + */ + navigateFrom?: string; - /** returns the current view state of calendar. - */ - navigateTo?: string; + /** returns the current view state of calendar. + */ + navigateTo?: string; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the current date value. - */ - value?: string; -} + /** returns the current date value. + */ + value?: string; + } -export interface OpenEventArgs { + export interface OpenEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the current date object. - */ - date?: any; + /** returns the current date object. + */ + date?: any; - /** returns the DatePicker model. - */ - model?: ej.DatePicker.Model; + /** returns the DatePicker model. + */ + model?: ej.DatePicker.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the current date value. - */ - value?: string; + /** returns the current date value. + */ + value?: string; - /** returns the previously selected value. - */ - prevDate?: string; -} + /** returns the previously selected value. + */ + prevDate?: string; + } -export interface SelectEventArgs { + export interface SelectEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the selected date object. - */ - date?: any; + /** returns the selected date object. + */ + date?: any; - /** returns the DatePicker model. - */ - model?: ej.DatePicker.Model; + /** returns the DatePicker model. + */ + model?: ej.DatePicker.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the current date value. - */ - value?: string; + /** returns the current date value. + */ + value?: string; - /** returns the previously selected value. - */ - prevDate?: string; + /** returns the previously selected value. + */ + prevDate?: string; - /** returns whether the currently selected date is special date or not. - */ - isSpecialDay?: string; -} + /** returns whether the currently selected date is special date or not. + */ + isSpecialDay?: string; + } -export interface Fields { + export interface Fields { - /** Specifies the specials dates - */ - date?: string; + /** Specifies the specials dates + */ + date?: string; - /** Specifies the icon class to special dates. - */ - iconClass?: string; + /** Specifies the icon class to special dates. + */ + iconClass?: string; - /** Specifies the tooltip to special dates. - */ - tooltip?: string; + /** Specifies the tooltip to special dates. + */ + tooltip?: string; - /** Specifies the CSS class to customize the date. - */ - cssClass?: string; -} + /** Specifies the CSS class to customize the date. + */ + cssClass?: string; + } -enum Header { + enum Header { - ///Removes day header in DatePicker - None, + ///Removes day header in DatePicker + None, - ///sets the short format of day name (like Sun) in header in DatePicker - Short, + ///sets the short format of day name (like Sun) in header in DatePicker + Short, - ///sets the Min format of day name (like su) in header format DatePicker - Min -} + ///sets the Min format of day name (like su) in header format DatePicker + Min + } -enum Level { + enum Level { - ///allow navigation upto year level in DatePicker - Year, + ///allow navigation upto year level in DatePicker + Year, - ///allow navigation upto decade level in DatePicker - Decade, + ///allow navigation upto decade level in DatePicker + Decade, - ///allow navigation upto Century level in DatePicker - Century -} + ///allow navigation upto Century level in DatePicker + Century + } -enum HighlightSection { + enum HighlightSection { - ///Highlight the week of the currently selected date in DatePicker popup calendar - Week, + ///Highlight the week of the currently selected date in DatePicker popup calendar + Week, - ///Highlight the workdays in a currently selected date's week in DatePicker popup calendar - WorkDays, + ///Highlight the workdays in a currently selected date's week in DatePicker popup calendar + WorkDays, - ///Nothing will be highlighted, remove highlights from DatePicker popup calendar if already exists - None -} + ///Nothing will be highlighted, remove highlights from DatePicker popup calendar if already exists + None + } -} + } -class DateTimePicker extends ej.Widget { - static fn: DateTimePicker; - constructor(element: JQuery | Element, options?: DateTimePicker.Model); - static Locale: any; - model: DateTimePicker.Model; - defaults: DateTimePicker.Model; + class DateTimePicker extends ej.Widget { + static fn: DateTimePicker; + constructor(element: JQuery | Element, options?: DateTimePicker.Model); + static Locale: any; + model: DateTimePicker.Model; + defaults: DateTimePicker.Model; - /** Disables the DateTimePicker control. - * @returns {void} - */ - disable(): void; + /** Disables the DateTimePicker control. + * @returns {void} + */ + disable(): void; - /** Enables the DateTimePicker control. - * @returns {void} - */ - enable(): void; - - /** Returns the current datetime value in the DateTimePicker. - * @returns {string} - */ - getValue(): string; - - /** Hides or closes the DateTimePicker popup. - * @returns {void} - */ - hide(): void; - - /** Updates the current system date value and time value to the DateTimePicker. - * @returns {void} - */ - setCurrentDateTime(): void; - - /** Shows or opens the DateTimePicker popup. - * @returns {void} - */ - show(): void; -} -export namespace DateTimePicker { - -export interface Model { - - /** Used to allow or restrict the editing in DateTimePicker input field directly. By setting false to this API, You can only pick the date and time values from DateTimePicker popup. - * @Default {true} - */ - allowEdit?: boolean; - - /** Displays the custom text for the buttons inside the DateTimePicker popup. when the culture value changed, we can change the buttons text based on the culture. - * @Default {{ today: Today, timeNow: Time Now, done: Done, timeTitle: Time }} - */ - buttonText?: ButtonText; - - /** Set the root class for DateTimePicker theme. This cssClass API helps to use custom skinning option for DateTimePicker control. - */ - cssClass?: string; - - /** Defines the datetime format displayed in the DateTimePicker. The value should be a combination of date format and time format. - * @Default {M/d/yyyy h:mm tt} - */ - dateTimeFormat?: string; - - /** Specifies the header format of the datepicker inside the DateTimePicker popup. See DatePicker.Header - * @Default {ej.DatePicker.Header.Short} - */ - dayHeaderFormat?: ej.DatePicker.Header|string; - - /** Specifies the navigation depth level in DatePicker calendar inside DateTimePicker popup. This option is not applied - * when start level view option is lower than depth level view. See ej.DatePicker.Level - */ - depthLevel?: ej.DatePicker.Level|string; - - /** Enable or disable the animation effect in DateTimePicker. - * @Default {true} - */ - enableAnimation?: boolean; - - /** When this property is set to false, it disables the DateTimePicker control. - * @Default {false} - */ - enabled?: boolean; - - /** Enables or disables the state maintenance of DateTimePicker. - * @Default {false} - */ - enablePersistence?: boolean; - - /** Sets the DateTimePicker direction as right to left alignment. - * @Default {false} - */ - enableRTL?: boolean; - - /** When enableStrictMode true it allows the value outside of the range also but it highlights the textbox with error class, otherwise it internally changed to the correct value. - * @Default {false} - */ - enableStrictMode?: boolean; - - /** Specifies the header format to be displayed in the DatePicker calendar inside the DateTimePicker popup. - * @Default {MMMM yyyy} - */ - headerFormat?: string; - - /** Defines the height of the DateTimePicker textbox. - * @Default {30} - */ - height?: string|number; - - /** Specifies the HTML Attributes of the ejDateTimePicker - * @Default {{}} - */ - htmlAttributes?: any; - - /** Sets the time interval between the two adjacent time values in the time popup. - * @Default {30} - */ - interval?: number; - - /** Defines the localization culture for DateTimePicker. - * @Default {en-US} - */ - locale?: string; - - /** Sets the maximum value to the DateTimePicker. Beyond the maximum value an error class is added to the wrapper element when we set true to enableStrictMode. - * @Default {new Date(12/31/2099 11:59:59 PM)} - */ - maxDateTime?: string|Date; - - /** Sets the minimum value to the DateTimePicker. Behind the minimum value an error class is added to the wrapper element. - * @Default {new Date(1/1/1900 12:00:00 AM)} - */ - minDateTime?: string|Date; - - /** Specifies the popup position of DateTimePicker.See below to know available popup positions - * @Default {ej.DateTimePicker.Bottom} - */ - popupPosition?: string | ej.popupPosition; - - /** Indicates that the DateTimePicker value can only be read and canĂ¢â‚¬â„¢t change. - * @Default {false} - */ - readOnly?: boolean; - - /** It allows showing days in other months of DatePicker calendar inside the DateTimePicker popup. - * @Default {true} - */ - showOtherMonths?: boolean; - - /** Shows or hides the arrow button from the DateTimePicker textbox. When the button disabled, the DateTimePicker popup opens while focus in the textbox and hides while focus out from the textbox. - * @Default {true} - */ - showPopupButton?: boolean; - - /** Changes the sharped edges into rounded corner for the DateTimePicker textbox and popup. - * @Default {false} - */ - showRoundedCorner?: boolean; - - /** Specifies the start day of the week in datepicker inside the DateTimePicker popup. - * @Default {1} - */ - startDay?: number; - - /** Specifies the start level view in datepicker inside the DateTimePicker popup. See DatePicker.Level - * @Default {ej.DatePicker.Level.Month or month} - */ - startLevel?: ej.DatePicker.Level|string; - - /** Specifies the number of months to navigate at one click of next and previous button in datepicker inside the DateTimePicker popup. - * @Default {1} - */ - stepMonths?: number; - - /** Defines the time format displayed in the time dropdown inside the DateTimePicker popup. - * @Default {h:mm tt} - */ - timeDisplayFormat?: string; - - /** We can drill down up to time interval on selected date with meridian details. - * @Default {{ enabled: false, interval: 5, showMeridian: false, autoClose: true }} - */ - timeDrillDown?: TimeDrillDown; - - /** Defines the width of the time dropdown inside the DateTimePicker popup. - * @Default {100} - */ - timePopupWidth?: string|number; - - /** Set the jQuery validation error message in DateTimePicker. - * @Default {null} - */ - validationMessage?: any; - - /** Set the jQuery validation rules in DateTimePicker. - * @Default {null} - */ - validationRules?: any; - - /** Sets the DateTime value to the control. - */ - value?: string|Date; - - /** Specifies the water mark text to be displayed in input text. - * @Default {Select date and time} - */ - watermarkText?: string; - - /** Defines the width of the DateTimePicker textbox. - * @Default {143} - */ - width?: string|number; - - /** Fires before the datetime popup closed in the DateTimePicker. */ - beforeClose?(e: BeforeCloseEventArgs): void; - - /** Fires before the datetime popup open in the DateTimePicker. */ - beforeOpen?(e: BeforeOpenEventArgs): void; - - /** Fires when the datetime value changed in the DateTimePicker textbox. */ - change?(e: ChangeEventArgs): void; - - /** Fires when DateTimePicker popup closes. */ - close?(e: CloseEventArgs): void; - - /** Fires after DateTimePicker control is created. */ - create?(e: CreateEventArgs): void; + /** Enables the DateTimePicker control. + * @returns {void} + */ + enable(): void; + + /** Returns the current datetime value in the DateTimePicker. + * @returns {string} + */ + getValue(): string; + + /** Hides or closes the DateTimePicker popup. + * @returns {void} + */ + hide(): void; + + /** Updates the current system date value and time value to the DateTimePicker. + * @returns {void} + */ + setCurrentDateTime(): void; + + /** Shows or opens the DateTimePicker popup. + * @returns {void} + */ + show(): void; + } + export namespace DateTimePicker { + + export interface Model { + + /** Used to allow or restrict the editing in DateTimePicker input field directly. By setting false to this API, You can only pick the date and time values from DateTimePicker popup. + * @Default {true} + */ + allowEdit?: boolean; + + /** Displays the custom text for the buttons inside the DateTimePicker popup. when the culture value changed, we can change the buttons text based on the culture. + * @Default {{ today: Today, timeNow: Time Now, done: Done, timeTitle: Time }} + */ + buttonText?: ButtonText; + + /** Set the root class for DateTimePicker theme. This cssClass API helps to use custom skinning option for DateTimePicker control. + */ + cssClass?: string; + + /** Defines the datetime format displayed in the DateTimePicker. The value should be a combination of date format and time format. + * @Default {M/d/yyyy h:mm tt} + */ + dateTimeFormat?: string; + + /** Specifies the header format of the datepicker inside the DateTimePicker popup. See DatePicker.Header + * @Default {ej.DatePicker.Header.Short} + */ + dayHeaderFormat?: ej.DatePicker.Header | string; + + /** Specifies the navigation depth level in DatePicker calendar inside DateTimePicker popup. This option is not applied + * when start level view option is lower than depth level view. See ej.DatePicker.Level + */ + depthLevel?: ej.DatePicker.Level | string; + + /** Enable or disable the animation effect in DateTimePicker. + * @Default {true} + */ + enableAnimation?: boolean; + + /** When this property is set to false, it disables the DateTimePicker control. + * @Default {false} + */ + enabled?: boolean; + + /** Enables or disables the state maintenance of DateTimePicker. + * @Default {false} + */ + enablePersistence?: boolean; + + /** Sets the DateTimePicker direction as right to left alignment. + * @Default {false} + */ + enableRTL?: boolean; + + /** When enableStrictMode true it allows the value outside of the range also but it highlights the textbox with error class, otherwise it internally changed to the correct value. + * @Default {false} + */ + enableStrictMode?: boolean; + + /** Specifies the header format to be displayed in the DatePicker calendar inside the DateTimePicker popup. + * @Default {MMMM yyyy} + */ + headerFormat?: string; + + /** Defines the height of the DateTimePicker textbox. + * @Default {30} + */ + height?: string | number; + + /** Specifies the HTML Attributes of the ejDateTimePicker + * @Default {{}} + */ + htmlAttributes?: any; + + /** Sets the time interval between the two adjacent time values in the time popup. + * @Default {30} + */ + interval?: number; + + /** Defines the localization culture for DateTimePicker. + * @Default {en-US} + */ + locale?: string; + + /** Sets the maximum value to the DateTimePicker. Beyond the maximum value an error class is added to the wrapper element when we set true to enableStrictMode. + * @Default {new Date(12/31/2099 11:59:59 PM)} + */ + maxDateTime?: string | Date; + + /** Sets the minimum value to the DateTimePicker. Behind the minimum value an error class is added to the wrapper element. + * @Default {new Date(1/1/1900 12:00:00 AM)} + */ + minDateTime?: string | Date; + + /** Specifies the popup position of DateTimePicker.See below to know available popup positions + * @Default {ej.DateTimePicker.Bottom} + */ + popupPosition?: string | ej.popupPosition; + + /** Indicates that the DateTimePicker value can only be read and canĂ¢â‚¬â„¢t change. + * @Default {false} + */ + readOnly?: boolean; + + /** It allows showing days in other months of DatePicker calendar inside the DateTimePicker popup. + * @Default {true} + */ + showOtherMonths?: boolean; + + /** Shows or hides the arrow button from the DateTimePicker textbox. When the button disabled, the DateTimePicker popup opens while focus in the textbox and hides while focus out from the textbox. + * @Default {true} + */ + showPopupButton?: boolean; + + /** Changes the sharped edges into rounded corner for the DateTimePicker textbox and popup. + * @Default {false} + */ + showRoundedCorner?: boolean; + + /** Specifies the start day of the week in datepicker inside the DateTimePicker popup. + * @Default {1} + */ + startDay?: number; + + /** Specifies the start level view in datepicker inside the DateTimePicker popup. See DatePicker.Level + * @Default {ej.DatePicker.Level.Month or month} + */ + startLevel?: ej.DatePicker.Level | string; + + /** Specifies the number of months to navigate at one click of next and previous button in datepicker inside the DateTimePicker popup. + * @Default {1} + */ + stepMonths?: number; + + /** Defines the time format displayed in the time dropdown inside the DateTimePicker popup. + * @Default {h:mm tt} + */ + timeDisplayFormat?: string; + + /** We can drill down up to time interval on selected date with meridian details. + * @Default {{ enabled: false, interval: 5, showMeridian: false, autoClose: true }} + */ + timeDrillDown?: TimeDrillDown; + + /** Defines the width of the time dropdown inside the DateTimePicker popup. + * @Default {100} + */ + timePopupWidth?: string | number; + + /** Set the jQuery validation error message in DateTimePicker. + * @Default {null} + */ + validationMessage?: any; + + /** Set the jQuery validation rules in DateTimePicker. + * @Default {null} + */ + validationRules?: any; + + /** Sets the DateTime value to the control. + */ + value?: string | Date; + + /** Specifies the water mark text to be displayed in input text. + * @Default {Select date and time} + */ + watermarkText?: string; + + /** Defines the width of the DateTimePicker textbox. + * @Default {143} + */ + width?: string | number; + + /** Fires before the datetime popup closed in the DateTimePicker. */ + beforeClose?(e: BeforeCloseEventArgs): void; + + /** Fires before the datetime popup open in the DateTimePicker. */ + beforeOpen?(e: BeforeOpenEventArgs): void; + + /** Fires when the datetime value changed in the DateTimePicker textbox. */ + change?(e: ChangeEventArgs): void; + + /** Fires when DateTimePicker popup closes. */ + close?(e: CloseEventArgs): void; + + /** Fires after DateTimePicker control is created. */ + create?(e: CreateEventArgs): void; - /** Fires when the DateTimePicker is destroyed successfully */ - destroy?(e: DestroyEventArgs): void; - - /** Fires when the focus-in happens in the DateTimePicker textbox. */ - focusIn?(e: FocusInEventArgs): void; + /** Fires when the DateTimePicker is destroyed successfully */ + destroy?(e: DestroyEventArgs): void; + + /** Fires when the focus-in happens in the DateTimePicker textbox. */ + focusIn?(e: FocusInEventArgs): void; - /** Fires when the focus-out happens in the DateTimePicker textbox. */ - focusOut?(e: FocusOutEventArgs): void; + /** Fires when the focus-out happens in the DateTimePicker textbox. */ + focusOut?(e: FocusOutEventArgs): void; - /** Fires when DateTimePicker popup opens. */ - open?(e: OpenEventArgs): void; -} + /** Fires when DateTimePicker popup opens. */ + open?(e: OpenEventArgs): void; + } -export interface BeforeCloseEventArgs { + export interface BeforeCloseEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the DateTimePicker model. - */ - model?: ej.DateTimePicker.Model; + /** returns the DateTimePicker model. + */ + model?: ej.DateTimePicker.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the event parameters from DateTimePicker. - */ - events?: any; + /** returns the event parameters from DateTimePicker. + */ + events?: any; - /** returns the DateTimePicker popup. - */ - element?: HTMLElement; -} + /** returns the DateTimePicker popup. + */ + element?: HTMLElement; + } -export interface BeforeOpenEventArgs { + export interface BeforeOpenEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the DateTimePicker model. - */ - model?: ej.DateTimePicker.Model; + /** returns the DateTimePicker model. + */ + model?: ej.DateTimePicker.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the event parameters from DateTimePicker. - */ - events?: any; + /** returns the event parameters from DateTimePicker. + */ + events?: any; - /** returns the DateTimePicker popup. - */ - element?: HTMLElement; -} + /** returns the DateTimePicker popup. + */ + element?: HTMLElement; + } -export interface ChangeEventArgs { + export interface ChangeEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TimePicker model - */ - model?: ej.DateTimePicker.Model; + /** returns the TimePicker model + */ + model?: ej.DateTimePicker.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the current value is valid or not - */ - isValidState?: boolean; + /** returns the current value is valid or not + */ + isValidState?: boolean; - /** returns the modified datetime value - */ - value?: string; + /** returns the modified datetime value + */ + value?: string; - /** returns the previously selected date time value - */ - prevDateTime?: string; + /** returns the previously selected date time value + */ + prevDateTime?: string; - /** returns true if change event triggered by interaction, otherwise returns false - */ - isInteraction?: boolean; -} + /** returns true if change event triggered by interaction, otherwise returns false + */ + isInteraction?: boolean; + } -export interface CloseEventArgs { + export interface CloseEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TimePicker model - */ - model?: ej.DateTimePicker.Model; + /** returns the TimePicker model + */ + model?: ej.DateTimePicker.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the modified datetime value - */ - value?: string; + /** returns the modified datetime value + */ + value?: string; - /** returns the previously selected date time value - */ - prevDateTime?: string; -} + /** returns the previously selected date time value + */ + prevDateTime?: string; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the DateTimePicker model - */ - model?: ej.DateTimePicker.Model; + /** returns the DateTimePicker model + */ + model?: ej.DateTimePicker.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the DateTimePicker model - */ - model?: ej.DateTimePicker.Model; + /** returns the DateTimePicker model + */ + model?: ej.DateTimePicker.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface FocusInEventArgs { + export interface FocusInEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TimePicker model - */ - model?: ej.DateTimePicker.Model; + /** returns the TimePicker model + */ + model?: ej.DateTimePicker.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the datetime value, which is in text box - */ - value?: string; -} - -export interface FocusOutEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the TimePicker model - */ - model?: ej.DateTimePicker.Model; - - /** returns the name of the event - */ - type?: string; - - /** returns the datetime value, which is in text box - */ - value?: string; -} - -export interface OpenEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the TimePicker model - */ - model?: ej.DateTimePicker.Model; - - /** returns the name of the event - */ - type?: string; - - /** returns the modified datetime value - */ - value?: string; - - /** returns the previously selected date time value - */ - prevDateTime?: string; -} - -export interface ButtonText { - - /** Sets the text for the Done button inside the datetime popup. - */ - done?: string; - - /** Sets the text for the Now button inside the datetime popup. - */ - timeNow?: string; - - /** Sets the header text for the Time dropdown. - */ - timeTitle?: string; - - /** Sets the text for the Today button inside the datetime popup. - */ - today?: string; -} - -export interface TimeDrillDown { - - /** This is the field to show/hide the timeDrillDown in DateTimePicker. - */ - enabled?: boolean; - - /** Sets the interval time of minutes on selected date. - */ - interval?: number; - - /** Allows the user to show or hide the meridian with time in DateTimePicker. - */ - showMeridian?: boolean; - - /** After choosing the time, the popup will close automatically if we set it as true, otherwise we focus out the DateTimePicker or choose timeNow button for closing the popup. - */ - autoClose?: boolean; -} -} -enum popupPosition { -//Opens the DateTimePicker popup below to the DateTimePicker input box -Bottom, -//Opens the DateTimePicker popup above to the DateTimePicker input box -Top, -} - -class DateRangePicker extends ej.Widget { - static fn: DateRangePicker; - constructor(element: JQuery | Element, options?: DateRangePicker.Model); - static Locale: any; - model: DateRangePicker.Model; - defaults: DateRangePicker.Model; - - /** Add the preset ranges to DateRangePicker popup. - * @param {string} Display name - * @param {Array} StartDate and endDate of range. - * @returns {void} - */ - addRanges(label: string, range: any[]): void; - - /** Clears the all ranges selections in DateRangePicker popup - * @returns {void} - */ - clearRanges(): void; - - /** Disables the DateRangePicker control. - * @returns {void} - */ - disable(): void; - - /** Enable the DateRangePicker control, if it is in disabled state. - * @returns {void} - */ - enable(): void; - - /** Returns the startDate and endDate values in the selected ranges in the DateRangePicker control. - * @returns {string} - */ - getSelectedValue(): string; - - /** Close the DateRangePicker popup, if it is in opened state. - * @returns {void} - */ - popupHide(): void; - - /** Opens the DateRangePicker popup. - * @returns {void} - */ - popupShow(): void; - - /** set the preset ranges to DateRangePicker popup. - * @returns {void} - */ - setRange(): void; -} -export namespace DateRangePicker { - -export interface Model { - - /** Used to allow or restrict the editing in DateRangePicker input field directly. By setting false to this API, You can only pick the date ranges from DateRangePicker popup. - * @Default {true} - */ - allowEdit?: boolean; - - /** Sets the specified text value to the available buttons (Reset, Cancel, Apply) in the DateRangePicker popup. - * @Default {{ reset: Reset, cancel: Cancel, apply: Apply}} - */ - buttonText?: any; - - /** Sets the root CSS class for DateRangePicker theme, which is used to customize. - */ - cssClass?: string; - - /** Formats the date value of the DateRangePicker in to the specified date format. If this API is not specified, dateFormat will be set based on the current culture of DateRangePicker. - * @Default {MM/dd/yyyy} - */ - dateFormat?: string; - - /** Allows to embed the Timepicker align with the calendars in the page, two timepicker will be render, for selecting start and end date. - * @Default {false} - */ - enableTimePicker?: boolean; - - /** Enable or disable the DateRangePicker control. - * @Default {true} - */ - enabled?: boolean; - - /** Sustain the entire widget model of DateRangePicker even after form post or browser refresh - * @Default {false} - */ - enablePersistence?: boolean; - - /** Specifies the end date of the date ranges. - * @Default {null} - */ - endDate?: string|Date; - - /** Specifies the height of the DateRangePicker input. - * @Default {28px} - */ - height?: string|number; - - /** Change the DateRangePicker calendar and date format based on given culture. - * @Default {en-US} - */ - locale?: string; - - /** Used to add the preset ranges. Added ranges using this, will show in popup in right side for easy selection of different preset ranges. - * @Default {null} - */ - ranges?: any; - - /** Specifies the start date of the date ranges - * @Default {null} - */ - startDate?: string|Date; - - /** Shows/hides the date icon button at right side of textbox, which is used to open or close the DateRangePicker calendar popup. - * @Default {true} - */ - showPopupButton?: boolean; - - /** DateRangePicker input and popup is displayed with rounded corner when this property is set to true. - * @Default {false} - */ - showRoundedCorner?: boolean; - - /** Formats the date value of the DateRangePicker in to the specified time format. If this API is not specified, timeFormat will be set based on the current culture of DateRangePicker. - * @Default {HH:mm tt} - */ - timeFormat?: string; - - /** Separated two date values in string format to sets the date ranges in calendars. - * @Default {null} - */ - value?: string; - - /** Specifies the water mark text to be displayed in input text. - * @Default {Select Range} - */ - watermarkText?: string; - - /** Specifies the width of the DateRangePicker input text. - * @Default {160px} - */ - width?: string|number; - - /** Fires before closing the DateRangePicker popup. */ - beforeClose?(e: BeforeCloseEventArgs): void; - - /** Fires before opening the DateRangePicker popup. */ - beforeOpen?(e: BeforeOpenEventArgs): void; - - /** Fires when the DateRangePicker values get changed. */ - onChange?(e: OnChangeEventArgs): void; + /** returns the datetime value, which is in text box + */ + value?: string; + } + + export interface FocusOutEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the TimePicker model + */ + model?: ej.DateTimePicker.Model; + + /** returns the name of the event + */ + type?: string; + + /** returns the datetime value, which is in text box + */ + value?: string; + } + + export interface OpenEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the TimePicker model + */ + model?: ej.DateTimePicker.Model; + + /** returns the name of the event + */ + type?: string; + + /** returns the modified datetime value + */ + value?: string; + + /** returns the previously selected date time value + */ + prevDateTime?: string; + } + + export interface ButtonText { + + /** Sets the text for the Done button inside the datetime popup. + */ + done?: string; + + /** Sets the text for the Now button inside the datetime popup. + */ + timeNow?: string; + + /** Sets the header text for the Time dropdown. + */ + timeTitle?: string; + + /** Sets the text for the Today button inside the datetime popup. + */ + today?: string; + } + + export interface TimeDrillDown { + + /** This is the field to show/hide the timeDrillDown in DateTimePicker. + */ + enabled?: boolean; + + /** Sets the interval time of minutes on selected date. + */ + interval?: number; + + /** Allows the user to show or hide the meridian with time in DateTimePicker. + */ + showMeridian?: boolean; + + /** After choosing the time, the popup will close automatically if we set it as true, otherwise we focus out the DateTimePicker or choose timeNow button for closing the popup. + */ + autoClose?: boolean; + } + } + enum popupPosition { + //Opens the DateTimePicker popup below to the DateTimePicker input box + Bottom, + //Opens the DateTimePicker popup above to the DateTimePicker input box + Top, + } + + class DateRangePicker extends ej.Widget { + static fn: DateRangePicker; + constructor(element: JQuery | Element, options?: DateRangePicker.Model); + static Locale: any; + model: DateRangePicker.Model; + defaults: DateRangePicker.Model; + + /** Add the preset ranges to DateRangePicker popup. + * @param {string} Display name + * @param {Array} StartDate and endDate of range. + * @returns {void} + */ + addRanges(label: string, range: any[]): void; + + /** Clears the all ranges selections in DateRangePicker popup + * @returns {void} + */ + clearRanges(): void; + + /** Disables the DateRangePicker control. + * @returns {void} + */ + disable(): void; + + /** Enable the DateRangePicker control, if it is in disabled state. + * @returns {void} + */ + enable(): void; + + /** Returns the startDate and endDate values in the selected ranges in the DateRangePicker control. + * @returns {string} + */ + getSelectedValue(): string; + + /** Close the DateRangePicker popup, if it is in opened state. + * @returns {void} + */ + popupHide(): void; + + /** Opens the DateRangePicker popup. + * @returns {void} + */ + popupShow(): void; + + /** set the preset ranges to DateRangePicker popup. + * @returns {void} + */ + setRange(): void; + } + export namespace DateRangePicker { + + export interface Model { + + /** Used to allow or restrict the editing in DateRangePicker input field directly. By setting false to this API, You can only pick the date ranges from DateRangePicker popup. + * @Default {true} + */ + allowEdit?: boolean; + + /** Sets the specified text value to the available buttons (Reset, Cancel, Apply) in the DateRangePicker popup. + * @Default {{ reset: Reset, cancel: Cancel, apply: Apply}} + */ + buttonText?: any; + + /** Sets the root CSS class for DateRangePicker theme, which is used to customize. + */ + cssClass?: string; + + /** Formats the date value of the DateRangePicker in to the specified date format. If this API is not specified, dateFormat will be set based on the current culture of DateRangePicker. + * @Default {MM/dd/yyyy} + */ + dateFormat?: string; + + /** Allows to embed the Timepicker align with the calendars in the page, two timepicker will be render, for selecting start and end date. + * @Default {false} + */ + enableTimePicker?: boolean; + + /** Enable or disable the DateRangePicker control. + * @Default {true} + */ + enabled?: boolean; + + /** Sustain the entire widget model of DateRangePicker even after form post or browser refresh + * @Default {false} + */ + enablePersistence?: boolean; + + /** Specifies the end date of the date ranges. + * @Default {null} + */ + endDate?: string | Date; + + /** Specifies the height of the DateRangePicker input. + * @Default {28px} + */ + height?: string | number; + + /** Change the DateRangePicker calendar and date format based on given culture. + * @Default {en-US} + */ + locale?: string; + + /** Used to add the preset ranges. Added ranges using this, will show in popup in right side for easy selection of different preset ranges. + * @Default {null} + */ + ranges?: any; + + /** Specifies the start date of the date ranges + * @Default {null} + */ + startDate?: string | Date; + + /** Shows/hides the date icon button at right side of textbox, which is used to open or close the DateRangePicker calendar popup. + * @Default {true} + */ + showPopupButton?: boolean; + + /** DateRangePicker input and popup is displayed with rounded corner when this property is set to true. + * @Default {false} + */ + showRoundedCorner?: boolean; + + /** Formats the date value of the DateRangePicker in to the specified time format. If this API is not specified, timeFormat will be set based on the current culture of DateRangePicker. + * @Default {HH:mm tt} + */ + timeFormat?: string; + + /** Separated two date values in string format to sets the date ranges in calendars. + * @Default {null} + */ + value?: string; + + /** Specifies the water mark text to be displayed in input text. + * @Default {Select Range} + */ + watermarkText?: string; + + /** Specifies the width of the DateRangePicker input text. + * @Default {160px} + */ + width?: string | number; + + /** Fires before closing the DateRangePicker popup. */ + beforeClose?(e: BeforeCloseEventArgs): void; + + /** Fires before opening the DateRangePicker popup. */ + beforeOpen?(e: BeforeOpenEventArgs): void; + + /** Fires when the DateRangePicker values get changed. */ + onChange?(e: OnChangeEventArgs): void; - /** Fires when DateRangePicker popup is closed. */ - close?(e: CloseEventArgs): void; - - /** Fires when the DateRangePicker is created successfully. */ - create?(e: CreateEventArgs): void; - - /** Fires when the DateRangePicker is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; - - /** Fires when DateRangePicker popup is opened. */ - open?(e: OpenEventArgs): void; + /** Fires when DateRangePicker popup is closed. */ + close?(e: CloseEventArgs): void; + + /** Fires when the DateRangePicker is created successfully. */ + create?(e: CreateEventArgs): void; + + /** Fires when the DateRangePicker is destroyed successfully. */ + destroy?(e: DestroyEventArgs): void; + + /** Fires when DateRangePicker popup is opened. */ + open?(e: OpenEventArgs): void; - /** Fires when a date ranges is selected from the DateRangePicker popup. */ - select?(e: SelectEventArgs): void; -} + /** Fires when a date ranges is selected from the DateRangePicker popup. */ + select?(e: SelectEventArgs): void; + } -export interface BeforeCloseEventArgs { + export interface BeforeCloseEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the DateRangePicker model - */ - model?: ej.DateRangePicker.Model; + /** returns the DateRangePicker model + */ + model?: ej.DateRangePicker.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the event parameters from DateRangePicker. - */ - events?: any; + /** returns the event parameters from DateRangePicker. + */ + events?: any; - /** returns the DateRangePicker popup. - */ - element?: HTMLElement; -} + /** returns the DateRangePicker popup. + */ + element?: HTMLElement; + } -export interface BeforeOpenEventArgs { + export interface BeforeOpenEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the DateRangePicker model. - */ - model?: ej.DateRangePicker.Model; + /** returns the DateRangePicker model. + */ + model?: ej.DateRangePicker.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the event parameters from DateRangePicker. - */ - events?: any; + /** returns the event parameters from DateRangePicker. + */ + events?: any; - /** returns the DateRangePicker popup. - */ - element?: HTMLElement; -} + /** returns the DateRangePicker popup. + */ + element?: HTMLElement; + } -export interface OnChangeEventArgs { + export interface OnChangeEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the DateRangePicker model. - */ - model?: ej.DateRangePicker.Model; + /** returns the DateRangePicker model. + */ + model?: ej.DateRangePicker.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the DateRangePicker input value. - */ - value?: string; + /** returns the DateRangePicker input value. + */ + value?: string; - /** returns the startDate of DateRangePicker. - */ - startDate?: any; + /** returns the startDate of DateRangePicker. + */ + startDate?: any; - /** returns the endDate of the DateRangePicker popup. - */ - endDate?: any; -} + /** returns the endDate of the DateRangePicker popup. + */ + endDate?: any; + } -export interface CloseEventArgs { + export interface CloseEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the current date object. - */ - date?: any; + /** returns the current date object. + */ + date?: any; - /** returns the DateRangePicker model. - */ - model?: ej.DateRangePicker.Model; + /** returns the DateRangePicker model. + */ + model?: ej.DateRangePicker.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the DateRangePicker popup. - */ - element?: HTMLElement; -} + /** returns the DateRangePicker popup. + */ + element?: HTMLElement; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the DateRangePicker model. - */ - model?: ej.DateRangePicker.Model; + /** returns the DateRangePicker model. + */ + model?: ej.DateRangePicker.Model; - /** returns the name of the event. - */ - type?: string; -} - -export interface DestroyEventArgs { - - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; - - /** returns the DateRangePicker model. - */ - model?: ej.DateRangePicker.Model; - - /** returns the name of the event. - */ - type?: string; -} - -export interface OpenEventArgs { - - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; - - /** returns the current date object. - */ - date?: any; - - /** returns the DateRangePicker model. - */ - model?: ej.DateRangePicker.Model; - - /** returns the name of the event - */ - type?: string; - - /** returns the DateRangePicker popup. - */ - element?: HTMLElement; -} - -export interface SelectEventArgs { - - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; - - /** returns the selected date object. - */ - startDate?: any; - - /** returns the DateRangePicker model. - */ - model?: ej.DateRangePicker.Model; - - /** returns the name of the event. - */ - type?: string; - - /** returns the current date value. - */ - endDate?: any; -} -} - -class Dialog extends ej.Widget { - static fn: Dialog; - constructor(element: JQuery | Element, options?: Dialog.Model); - static Locale: any; - model: Dialog.Model; - defaults: Dialog.Model; - - /** Closes the dialog widget dynamically. - * @returns {any} - */ - close(): any; - - /** Collapses the content area when it is expanded. - * @returns {any} - */ - collapse(): any; - - /** Destroys the Dialog widget. - * @returns {void} - */ - destroy(): void; - - /** Expands the content area when it is collapsed. - * @returns {any} - */ - expand(): any; - - /** Checks whether the Dialog widget is opened or not. This methods returns Boolean value. - * @returns {boolean} - */ - isOpen(): boolean; - - /** Maximizes the Dialog widget. - * @returns {any} - */ - maximize(): any; - - /** Minimizes the Dialog widget. - * @returns {any} - */ - minimize(): any; - - /** Opens the Dialog widget. - * @returns {any} - */ - open(): any; - - /** Pins the dialog in its current position. - * @returns {any} - */ - pin(): any; - - /** Refreshes the dialog content dynamically. - * @returns {void} - */ - refresh(): void; - - /** Restores the dialog. - * @returns {any} - */ - restore(): any; - - /** Unpins the Dialog widget. - * @returns {any} - */ - unpin(): any; - - /** Sets the title for the Dialog widget. - * @param {string} The title for the dialog widget. - * @returns {any} - */ - setTitle(Title: string): any; - - /** Sets the content for the Dialog widget dynamically. - * @param {string} The content for the dialog widget. It accepts both string and HTML string. - * @returns {any} - */ - setContent(content: string): any; - - /** Sets the focus on the Dialog widget. - * @returns {any} - */ - focus(): any; -} -export namespace Dialog { - -export interface Model { - - /** Adds action buttons like close, minimize, pin, maximize in the dialog header. - */ - actionButtons?: string[]; - - /** Specifies the ajaxSettings option to load the content to the Dialog control. - * @Default {null} - */ - ajaxSettings?: AjaxSettings; - - /** Enables or disables draggable. - */ - allowDraggable?: boolean; - - /** Enables or disables keyboard interaction. - */ - allowKeyboardNavigation?: boolean; - - /** Customizes the Dialog widget animations. The Dialog widget can be animated while opening and closing the dialog. - * In order to customize animation effects, you need to set Ă¢â‚¬Å“enableAnimationĂ¢â‚¬Â as true. It contains the following sub properties. - */ - animation?: any; - - /** Closes the dialog widget on pressing the ESC key when it is set to true. - */ - closeOnEscape?: boolean; - - /** The selector for the container element. If the property is set, then dialog will append to the selected element and it is restricted to move only within the specified container element. - */ - containment?: string; - - /** The content type to load the dialog content at run time. The possible values are null, AJAX, iframe and image. When it is null (default value), - * the content inside dialog element will be displayed as content and when it is not null, the content will be loaded from the URL specified in the contentUrl property. - */ - contentType?: string; - - /** The URL to load the dialog content (such as AJAX, image, and iframe). In order to load content from URL, you need to set contentType as Ă¢â‚¬ËœajaxĂ¢â‚¬â„¢ or Ă¢â‚¬ËœiframeĂ¢â‚¬â„¢ or Ă¢â‚¬ËœimageĂ¢â‚¬â„¢. - */ - contentUrl?: string; - - /** The root class for the Dialog widget to customize the existing theme. - */ - cssClass?: string; - - /** Enable or disables animation when the dialog is opened or closed. - */ - enableAnimation?: boolean; - - /** Enables or disables the Dialog widget. - */ - enabled?: boolean; - - /** Enable or disables modal dialog. The modal dialog acts like a child window that is displayed on top of the main window/screen and disables the main window interaction until it is closed. - */ - enableModal?: boolean; - - /** Allows the current model values to be saved in local storage or browser cookies for state maintenance when it is set to true. - */ - enablePersistence?: boolean; - - /** Allows the dialog to be resized. The dialog cannot be resized less than the minimum height, width values and greater than the maximum height and width. - */ - enableResize?: boolean; - - /** Displays dialog content from right to left when set to true. - */ - enableRTL?: boolean; - - /** The CSS class name to display the favicon in the dialog header. In order to display favicon, you need to setĂ‚ showHeaderĂ‚ as true since the favicon will be displayed in the dialog header. - */ - faviconCSS?: string; - - /** Sets the height for the dialog widget. It accepts both string and integer values. For example, it can accepts values like Ă¢â‚¬Å“autoĂ¢â‚¬Â, Ă¢â‚¬Å“100%Ă¢â‚¬Â, Ă¢â‚¬Å“100pxĂ¢â‚¬Â as string type - * and Ă¢â‚¬Å“100Ă¢â‚¬Â, Ă¢â‚¬Å“500Ă¢â‚¬Â as integer type. - */ - height?: string|number; - - /** Specifies the HTML Attributes of the Dialog. - * @Default {{}} - */ - htmlAttributes?: any; + /** returns the name of the event. + */ + type?: string; + } + + export interface DestroyEventArgs { + + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; + + /** returns the DateRangePicker model. + */ + model?: ej.DateRangePicker.Model; + + /** returns the name of the event. + */ + type?: string; + } + + export interface OpenEventArgs { + + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; + + /** returns the current date object. + */ + date?: any; + + /** returns the DateRangePicker model. + */ + model?: ej.DateRangePicker.Model; + + /** returns the name of the event + */ + type?: string; + + /** returns the DateRangePicker popup. + */ + element?: HTMLElement; + } + + export interface SelectEventArgs { + + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; + + /** returns the selected date object. + */ + startDate?: any; + + /** returns the DateRangePicker model. + */ + model?: ej.DateRangePicker.Model; + + /** returns the name of the event. + */ + type?: string; + + /** returns the current date value. + */ + endDate?: any; + } + } + + class Dialog extends ej.Widget { + static fn: Dialog; + constructor(element: JQuery | Element, options?: Dialog.Model); + static Locale: any; + model: Dialog.Model; + defaults: Dialog.Model; + + /** Closes the dialog widget dynamically. + * @returns {any} + */ + close(): any; + + /** Collapses the content area when it is expanded. + * @returns {any} + */ + collapse(): any; + + /** Destroys the Dialog widget. + * @returns {void} + */ + destroy(): void; + + /** Expands the content area when it is collapsed. + * @returns {any} + */ + expand(): any; + + /** Checks whether the Dialog widget is opened or not. This methods returns Boolean value. + * @returns {boolean} + */ + isOpen(): boolean; + + /** Maximizes the Dialog widget. + * @returns {any} + */ + maximize(): any; + + /** Minimizes the Dialog widget. + * @returns {any} + */ + minimize(): any; + + /** Opens the Dialog widget. + * @returns {any} + */ + open(): any; + + /** Pins the dialog in its current position. + * @returns {any} + */ + pin(): any; + + /** Refreshes the dialog content dynamically. + * @returns {void} + */ + refresh(): void; + + /** Restores the dialog. + * @returns {any} + */ + restore(): any; + + /** Unpins the Dialog widget. + * @returns {any} + */ + unpin(): any; + + /** Sets the title for the Dialog widget. + * @param {string} The title for the dialog widget. + * @returns {any} + */ + setTitle(Title: string): any; + + /** Sets the content for the Dialog widget dynamically. + * @param {string} The content for the dialog widget. It accepts both string and HTML string. + * @returns {any} + */ + setContent(content: string): any; + + /** Sets the focus on the Dialog widget. + * @returns {any} + */ + focus(): any; + } + export namespace Dialog { + + export interface Model { + + /** Adds action buttons like close, minimize, pin, maximize in the dialog header. + */ + actionButtons?: string[]; + + /** Specifies the ajaxSettings option to load the content to the Dialog control. + * @Default {null} + */ + ajaxSettings?: AjaxSettings; + + /** Enables or disables draggable. + */ + allowDraggable?: boolean; + + /** Enables or disables keyboard interaction. + */ + allowKeyboardNavigation?: boolean; + + /** Customizes the Dialog widget animations. The Dialog widget can be animated while opening and closing the dialog. + * In order to customize animation effects, you need to set Ă¢â‚¬Å“enableAnimationĂ¢â‚¬Â as true. It contains the following sub properties. + */ + animation?: any; + + /** Closes the dialog widget on pressing the ESC key when it is set to true. + */ + closeOnEscape?: boolean; + + /** The selector for the container element. If the property is set, then dialog will append to the selected element and it is restricted to move only within the specified container element. + */ + containment?: string; + + /** The content type to load the dialog content at run time. The possible values are null, AJAX, iframe and image. When it is null (default value), + * the content inside dialog element will be displayed as content and when it is not null, the content will be loaded from the URL specified in the contentUrl property. + */ + contentType?: string; + + /** The URL to load the dialog content (such as AJAX, image, and iframe). In order to load content from URL, you need to set contentType as Ă¢â‚¬ËœajaxĂ¢â‚¬â„¢ or Ă¢â‚¬ËœiframeĂ¢â‚¬â„¢ or Ă¢â‚¬ËœimageĂ¢â‚¬â„¢. + */ + contentUrl?: string; + + /** The root class for the Dialog widget to customize the existing theme. + */ + cssClass?: string; + + /** Enable or disables animation when the dialog is opened or closed. + */ + enableAnimation?: boolean; + + /** Enables or disables the Dialog widget. + */ + enabled?: boolean; + + /** Enable or disables modal dialog. The modal dialog acts like a child window that is displayed on top of the main window/screen and disables the main window interaction until it is closed. + */ + enableModal?: boolean; + + /** Allows the current model values to be saved in local storage or browser cookies for state maintenance when it is set to true. + */ + enablePersistence?: boolean; + + /** Allows the dialog to be resized. The dialog cannot be resized less than the minimum height, width values and greater than the maximum height and width. + */ + enableResize?: boolean; + + /** Displays dialog content from right to left when set to true. + */ + enableRTL?: boolean; + + /** The CSS class name to display the favicon in the dialog header. In order to display favicon, you need to setĂ‚ showHeaderĂ‚ as true since the favicon will be displayed in the dialog header. + */ + faviconCSS?: string; + + /** Sets the height for the dialog widget. It accepts both string and integer values. For example, it can accepts values like Ă¢â‚¬Å“autoĂ¢â‚¬Â, Ă¢â‚¬Å“100%Ă¢â‚¬Â, Ă¢â‚¬Å“100pxĂ¢â‚¬Â as string type + * and Ă¢â‚¬Å“100Ă¢â‚¬Â, Ă¢â‚¬Å“500Ă¢â‚¬Â as integer type. + */ + height?: string | number; + + /** Specifies the HTML Attributes of the Dialog. + * @Default {{}} + */ + htmlAttributes?: any; - /** Enable or disables responsive behavior. - */ - isResponsive?: boolean; + /** Enable or disables responsive behavior. + */ + isResponsive?: boolean; - /** Default Value:{:.param}Ă¢â‚¬Å“en-USĂ¢â‚¬Â - */ - locale?: number; + /** Default Value:{:.param}Ă¢â‚¬Å“en-USĂ¢â‚¬Â + */ + locale?: number; - /** Sets the maximum height for the dialog widget. - */ - maxHeight?: number; + /** Sets the maximum height for the dialog widget. + */ + maxHeight?: number; - /** Sets the maximum width for the dialog widget. - */ - maxWidth?: number; + /** Sets the maximum width for the dialog widget. + */ + maxWidth?: number; - /** Sets the minimum height for the dialog widget. - */ - minHeight?: number; + /** Sets the minimum height for the dialog widget. + */ + minHeight?: number; - /** Sets the minimum width for the dialog widget. - */ - minWidth?: number; + /** Sets the minimum width for the dialog widget. + */ + minWidth?: number; - /** Displays the Dialog widget at the given X and Y position. - */ - position?: any; + /** Displays the Dialog widget at the given X and Y position. + */ + position?: any; - /** Shows or hides the dialog header. - */ - showHeader?: boolean; + /** Shows or hides the dialog header. + */ + showHeader?: boolean; - /** The Dialog widget can be opened by default i.e. on initialization, when it is set to true. - */ - showOnInit?: boolean; + /** The Dialog widget can be opened by default i.e. on initialization, when it is set to true. + */ + showOnInit?: boolean; - /** Enables or disables the rounder corner. - */ - showRoundedCorner?: boolean; + /** Enables or disables the rounder corner. + */ + showRoundedCorner?: boolean; - /** The selector for the container element. If this property is set, the dialog will be displayed (positioned) based on its container. - */ - target?: string; + /** The selector for the container element. If this property is set, the dialog will be displayed (positioned) based on its container. + */ + target?: string; - /** The title text to be displayed in the dialog header. In order to set title, you need to set showHeader as true since the title will be displayed in the dialog header. - */ - title?: string; + /** The title text to be displayed in the dialog header. In order to set title, you need to set showHeader as true since the title will be displayed in the dialog header. + */ + title?: string; - /** Add or configure the tooltip text for actionButtons in the dialog header. - */ - tooltip?: any; + /** Add or configure the tooltip text for actionButtons in the dialog header. + */ + tooltip?: any; - /** Sets the height for the dialog widget. It accepts both string and integer values. For example, it can accepts values like Ă¢â‚¬Å“autoĂ¢â‚¬Â, Ă¢â‚¬Å“100%Ă¢â‚¬Â, - * Ă¢â‚¬Å“100pxĂ¢â‚¬Â as string type and Ă¢â‚¬Å“100Ă¢â‚¬Â, Ă¢â‚¬Å“500Ă¢â‚¬Â as integer type. - */ - width?: string|number; + /** Sets the height for the dialog widget. It accepts both string and integer values. For example, it can accepts values like Ă¢â‚¬Å“autoĂ¢â‚¬Â, Ă¢â‚¬Å“100%Ă¢â‚¬Â, + * Ă¢â‚¬Å“100pxĂ¢â‚¬Â as string type and Ă¢â‚¬Å“100Ă¢â‚¬Â, Ă¢â‚¬Å“500Ă¢â‚¬Â as integer type. + */ + width?: string | number; - /** Sets the z-index value for the Dialog widget. - */ - zIndex?: number; + /** Sets the z-index value for the Dialog widget. + */ + zIndex?: number; - /** Sets the Footer for the Dialog widget. - */ - showFooter?: boolean; + /** Sets the Footer for the Dialog widget. + */ + showFooter?: boolean; - /** Sets the FooterTemplate for the Dialog widget. - */ - footerTemplateId?: string; + /** Sets the FooterTemplate for the Dialog widget. + */ + footerTemplateId?: string; - /** This event is triggered before the dialog widgets gets open. */ - beforeOpen?(e: BeforeOpenEventArgs): void; + /** This event is triggered before the dialog widgets gets open. */ + beforeOpen?(e: BeforeOpenEventArgs): void; - /** This event is triggered whenever the AJAX request fails to retrieve the dialog content. */ - ajaxError?(e: AjaxErrorEventArgs): void; + /** This event is triggered whenever the AJAX request fails to retrieve the dialog content. */ + ajaxError?(e: AjaxErrorEventArgs): void; - /** This event is triggered whenever the AJAX request to retrieve the dialog content, gets succeed. */ - ajaxSuccess?(e: AjaxSuccessEventArgs): void; + /** This event is triggered whenever the AJAX request to retrieve the dialog content, gets succeed. */ + ajaxSuccess?(e: AjaxSuccessEventArgs): void; - /** This event is triggered before the dialog widgets get closed. */ - beforeClose?(e: BeforeCloseEventArgs): void; + /** This event is triggered before the dialog widgets get closed. */ + beforeClose?(e: BeforeCloseEventArgs): void; - /** This event is triggered after the dialog widget is closed. */ - close?(e: CloseEventArgs): void; + /** This event is triggered after the dialog widget is closed. */ + close?(e: CloseEventArgs): void; - /** Triggered after the dialog content is loaded in DOM. */ - contentLoad?(e: ContentLoadEventArgs): void; + /** Triggered after the dialog content is loaded in DOM. */ + contentLoad?(e: ContentLoadEventArgs): void; - /** Triggered after the dialog is created successfully */ - create?(e: CreateEventArgs): void; + /** Triggered after the dialog is created successfully */ + create?(e: CreateEventArgs): void; - /** Triggered after the dialog widget is destroyed successfully */ - destroy?(e: DestroyEventArgs): void; + /** Triggered after the dialog widget is destroyed successfully */ + destroy?(e: DestroyEventArgs): void; - /** Triggered while the dialog is dragged. */ - drag?(e: DragEventArgs): void; + /** Triggered while the dialog is dragged. */ + drag?(e: DragEventArgs): void; - /** Triggered when the user starts dragging the dialog. */ - dragStart?(e: DragStartEventArgs): void; + /** Triggered when the user starts dragging the dialog. */ + dragStart?(e: DragStartEventArgs): void; - /** Triggered when the user stops dragging the dialog. */ - dragStop?(e: DragStopEventArgs): void; + /** Triggered when the user stops dragging the dialog. */ + dragStop?(e: DragStopEventArgs): void; - /** Triggered after the dialog is opened. */ - open?(e: OpenEventArgs): void; + /** Triggered after the dialog is opened. */ + open?(e: OpenEventArgs): void; - /** Triggered while the dialog is resized. */ - resize?(e: ResizeEventArgs): void; + /** Triggered while the dialog is resized. */ + resize?(e: ResizeEventArgs): void; - /** Triggered when the user starts resizing the dialog. */ - resizeStart?(e: ResizeStartEventArgs): void; + /** Triggered when the user starts resizing the dialog. */ + resizeStart?(e: ResizeStartEventArgs): void; - /** Triggered when the user stops resizing the dialog. */ - resizeStop?(e: ResizeStopEventArgs): void; + /** Triggered when the user stops resizing the dialog. */ + resizeStop?(e: ResizeStopEventArgs): void; - /** Triggered when the dialog content is expanded. */ - expand?(e: ExpandEventArgs): void; + /** Triggered when the dialog content is expanded. */ + expand?(e: ExpandEventArgs): void; - /** Triggered when the dialog content is collapsed. */ - collapse?(e: CollapseEventArgs): void; + /** Triggered when the dialog content is collapsed. */ + collapse?(e: CollapseEventArgs): void; - /** Triggered when the custom action button clicked. */ - actionButtonClick?(e: ActionButtonClickEventArgs): void; -} + /** Triggered when the custom action button clicked. */ + actionButtonClick?(e: ActionButtonClickEventArgs): void; + } -export interface BeforeOpenEventArgs { + export interface BeforeOpenEventArgs { - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the dialog model object. - */ - model?: ej.Dialog.Model; + /** Instance of the dialog model object. + */ + model?: ej.Dialog.Model; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface AjaxErrorEventArgs { + export interface AjaxErrorEventArgs { - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the dialog model object. - */ - model?: ej.Dialog.Model; + /** Instance of the dialog model object. + */ + model?: ej.Dialog.Model; - /** Name of the event. - */ - type?: string; + /** Name of the event. + */ + type?: string; - /** URL of the content. - */ - URL?: string; + /** URL of the content. + */ + URL?: string; - /** Error page content. - */ - responseText?: string; + /** Error page content. + */ + responseText?: string; - /** Error code. - */ - status?: number; + /** Error code. + */ + status?: number; - /** The corresponding error description. - */ - statusText?: string; -} + /** The corresponding error description. + */ + statusText?: string; + } -export interface AjaxSuccessEventArgs { + export interface AjaxSuccessEventArgs { - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the dialog model object. - */ - model?: ej.Dialog.Model; + /** Instance of the dialog model object. + */ + model?: ej.Dialog.Model; - /** Name of the event. - */ - type?: string; + /** Name of the event. + */ + type?: string; - /** URL of the content. - */ - URL?: string; + /** URL of the content. + */ + URL?: string; - /** Response content. - */ - data?: string; -} + /** Response content. + */ + data?: string; + } -export interface BeforeCloseEventArgs { + export interface BeforeCloseEventArgs { - /** Current event object. - */ - event?: any; + /** Current event object. + */ + event?: any; - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the dialog model object. - */ - model?: ej.Dialog.Model; + /** Instance of the dialog model object. + */ + model?: ej.Dialog.Model; - /** Name of the event. - */ - type?: string; -} + /** Name of the event. + */ + type?: string; + } -export interface CloseEventArgs { + export interface CloseEventArgs { - /** Current event object. - */ - event?: any; + /** Current event object. + */ + event?: any; - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the dialog model object. - */ - model?: ej.Dialog.Model; + /** Instance of the dialog model object. + */ + model?: ej.Dialog.Model; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface ContentLoadEventArgs { + export interface ContentLoadEventArgs { - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the dialog model object. - */ - model?: ej.Dialog.Model; + /** Instance of the dialog model object. + */ + model?: ej.Dialog.Model; - /** Name of the event. - */ - type?: string; + /** Name of the event. + */ + type?: string; - /** URL of the content. - */ - URL?: string; + /** URL of the content. + */ + URL?: string; - /** Content type - */ - contentType?: any; -} + /** Content type + */ + contentType?: any; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the dialog model object. - */ - model?: ej.Dialog.Model; + /** Instance of the dialog model object. + */ + model?: ej.Dialog.Model; - /** Name of the event. - */ - type?: string; -} + /** Name of the event. + */ + type?: string; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the dialog model object. - */ - model?: ej.Dialog.Model; + /** Instance of the dialog model object. + */ + model?: ej.Dialog.Model; - /** Name of the event. - */ - type?: string; -} + /** Name of the event. + */ + type?: string; + } -export interface DragEventArgs { + export interface DragEventArgs { - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the dialog model object. - */ - model?: ej.Dialog.Model; + /** Instance of the dialog model object. + */ + model?: ej.Dialog.Model; - /** Name of the event. - */ - type?: string; + /** Name of the event. + */ + type?: string; - /** Current event object. - */ - event?: any; -} + /** Current event object. + */ + event?: any; + } -export interface DragStartEventArgs { + export interface DragStartEventArgs { - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the dialog model object. - */ - model?: ej.Dialog.Model; + /** Instance of the dialog model object. + */ + model?: ej.Dialog.Model; - /** Name of the event. - */ - type?: string; + /** Name of the event. + */ + type?: string; - /** Current event object. - */ - event?: any; -} + /** Current event object. + */ + event?: any; + } -export interface DragStopEventArgs { + export interface DragStopEventArgs { - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the dialog model object. - */ - model?: ej.Dialog.Model; + /** Instance of the dialog model object. + */ + model?: ej.Dialog.Model; - /** Name of the event. - */ - type?: string; + /** Name of the event. + */ + type?: string; - /** Current event object. - */ - event?: any; -} + /** Current event object. + */ + event?: any; + } -export interface OpenEventArgs { + export interface OpenEventArgs { - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the dialog model object. - */ - model?: ej.Dialog.Model; + /** Instance of the dialog model object. + */ + model?: ej.Dialog.Model; - /** Name of the event. - */ - type?: string; -} + /** Name of the event. + */ + type?: string; + } -export interface ResizeEventArgs { + export interface ResizeEventArgs { - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the dialog model object. - */ - model?: ej.Dialog.Model; + /** Instance of the dialog model object. + */ + model?: ej.Dialog.Model; - /** Name of the event. - */ - type?: string; + /** Name of the event. + */ + type?: string; - /** Current event object. - */ - event?: any; -} + /** Current event object. + */ + event?: any; + } -export interface ResizeStartEventArgs { + export interface ResizeStartEventArgs { - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the dialog model object. - */ - model?: ej.Dialog.Model; + /** Instance of the dialog model object. + */ + model?: ej.Dialog.Model; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** Current event object. - */ - event?: any; -} + /** Current event object. + */ + event?: any; + } -export interface ResizeStopEventArgs { + export interface ResizeStopEventArgs { - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the dialog model object. - */ - model?: ej.Dialog.Model; + /** Instance of the dialog model object. + */ + model?: ej.Dialog.Model; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** Current event object. - */ - event?: any; -} + /** Current event object. + */ + event?: any; + } -export interface ExpandEventArgs { + export interface ExpandEventArgs { - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the dialog model object. - */ - model?: ej.Dialog.Model; + /** Instance of the dialog model object. + */ + model?: ej.Dialog.Model; - /** Name of the event. - */ - type?: string; -} + /** Name of the event. + */ + type?: string; + } -export interface CollapseEventArgs { - - /** Set this option to true to cancel the event. - */ - cancel?: boolean; - - /** Instance of the dialog model object. - */ - model?: ej.Dialog.Model; - - /** Name of the event. - */ - type?: string; -} - -export interface ActionButtonClickEventArgs { - - /** Set this option to true to cancel the event. - */ - cancel?: boolean; - - /** Name of the event target attribute. - */ - buttonID?: string; - - /** Name of the event. - */ - type?: string; - - /** Instance of the dialog model object. - */ - model?: ej.Dialog.Model; - - /** Name of the event current target title. - */ - currentTarget?: string; -} - -export interface AjaxSettings { - - /** It specifies, whether to enable or disable asynchronous request. - */ - async?: boolean; - - /** It specifies the page will be cached in the web browser. - */ - cache?: boolean; - - /** It specifies the type of data is send in the query string. - */ - contentType?: string; - - /** It specifies the data as an object, will be passed in the query string. - */ - data?: any; - - /** It specifies the type of data that you're expecting back from the response. - */ - dataType?: string; - - /** It specifies the HTTP request type. - */ - type?: string; -} -} - -class DropDownList extends ej.Widget { - static fn: DropDownList; - constructor(element: JQuery | Element, options?: DropDownList.Model); - static Locale: any; - model: DropDownList.Model; - defaults: DropDownList.Model; - - /** Adding a single item or an array of items into the DropDownList allows you to specify all the field attributes such as value, template, image URL, and HTML attributes for those items. - * @param {any|Array} this parameter should have field attributes with respect to mapped field attributes and it's corresponding values to fields - * @returns {void} - */ - addItem(data: any|any[]): void; - - /** This method is used to select all the items in the DropDownList. - * @returns {void} - */ - checkAll(): void; - - /** Clears the text in the DropDownList textbox. - * @returns {void} - */ - clearText(): void; - - /** Destroys the DropDownList widget. - * @returns {void} - */ - destroy(): void; - - /** This property is used to disable the DropDownList widget. - * @returns {void} - */ - disable(): void; - - /** This property disables the set of items in the DropDownList. - * @param {string|number|Array} disable the given index list items - * @returns {void} - */ - disableItemsByIndices(index: string|number|any[]): void; - - /** This property enables the DropDownList control. - * @returns {void} - */ - enable(): void; - - /** Enables an Item or set of Items that are disabled in the DropDownList - * @param {string|number|Array} enable the given index list items if it's disabled - * @returns {void} - */ - enableItemsByIndices(index: string|number|any[]): void; - - /** This method retrieves the items using given value. - * @param {string|number|any} Return the whole object of data based on given value - * @returns {Array} - */ - getItemDataByValue(value: string|number|any): any[]; - - /** This method is used to retrieve the items that are bound with the DropDownList. - * @returns {any} - */ - getListData(): any; - - /** This method is used to get the selected items in the DropDownList. - * @returns {Array} - */ - getSelectedItem(): any[]; - - /** This method is used to retrieve the items value that are selected in the DropDownList. - * @returns {string} - */ - getSelectedValue(): string; - - /** This method hides the suggestion popup in the DropDownList. - * @returns {void} - */ - hidePopup(): void; - - /** This method is used to select the list of items in the DropDownList through the Index of the items. - * @param {string|number|Array} select the given index list items - * @returns {void} - */ - selectItemsByIndices(index: string|number|any[]): void; - - /** This method is used to select an item in the DropDownList by using the given text value. - * @param {string|number|Array} select the list items relates to given text - * @returns {void} - */ - selectItemByText(index: string|number|any[]): void; - - /** This method is used to select an item in the DropDownList by using the given value. - * @param {string|number|Array} select the list items relates to given values - * @returns {void} - */ - selectItemByValue(index: string|number|any[]): void; - - /** This method shows the DropDownList control with the suggestion popup. - * @returns {void} - */ - showPopup(): void; - - /** This method is used to unselect all the items in the DropDownList. - * @returns {void} - */ - unCheckAll(): void; - - /** This method is used to unselect the list of items in the DropDownList through Index of the items. - * @param {string|number|Array} unselect the given index list items - * @returns {void} - */ - unselectItemsByIndices(index: string|number|any[]): void; - - /** This method is used to unselect an item in the DropDownList by using the given text value. - * @param {string|number|Array} unselect the list items relates to given text - * @returns {void} - */ - unselectItemByText(index: string|number|any[]): void; - - /** This method is used to unselect an item in the DropDownList by using the given value. - * @param {string|number|Array} unselect the list items relates to given values - * @returns {void} - */ - unselectItemByValue(index: string|number|any[]): void; -} -export namespace DropDownList { - -export interface Model { - - /** The Virtual Scrolling(lazy loading) feature is used to display a large amount of data that you require without buffering the entire load of a huge database records in the DropDownList, - * that is, when scrolling, an AJAX request is sent to fetch some amount of data from the server dynamically. To achieve this scenario with DropDownList, set the allowVirtualScrolling to true. - * @Default {false} - */ - allowVirtualScrolling?: boolean; - - /** The cascading DropDownLists is a series of two or more DropDownLists in which each DropDownList is filtered according to the previous DropDownListĂ¢â‚¬â„¢s value. - * @Default {null} - */ - cascadeTo?: string; - - /** Sets the case sensitivity of the search operation. It supports both enableFilterSearch and enableIncrementalSearch property. - * @Default {false} - */ - caseSensitiveSearch?: boolean; - - /** Dropdown widget's style and appearance can be controlled based on 13 different default built-in themes.You can customize the appearance of the dropdown by using the cssClass property. - * You need to specify a class name in the cssClass property and the same class name is used before the class definitions wherever the custom styles are applied. - */ - cssClass?: string; - - /** This property is used to serve data from the data services based on the query provided. To bind the data to the dropdown widget, - * the dataSource property is assigned with the instance of the ej.DataManager. - * @Default {null} - */ - dataSource?: any; - - /** Sets the separator when the multiSelectMode with delimiter option or checkbox is enabled with the dropdown. When you enter the delimiter value,the texts after the delimiter are considered - * as a separate word or query. The delimiter string is a single character and must be a symbol. Mostly, the delimiter symbol is used as comma (,) or semi-colon (;) or any other special character. - * @Default {','} - */ - delimiterChar?: string; - - /** The enabled Animation property uses the easeOutQuad animation to SlideDown and SlideUp the Popup list in 200 and 100 milliseconds, respectively. - * @Default {false} - */ - enableAnimation?: boolean; - - /** This property is used to indicate whether the DropDownList control responds to the user interaction or not. By default, the control is in the enabled mode - * and you can disable it by setting it to false. - * @Default {true} - */ - enabled?: boolean; - - /** Specifies to perform incremental search for the selection of items from the DropDownList with the help of this property. This helps in selecting the item by using the typed character. - * @Default {true} - */ - enableIncrementalSearch?: boolean; - - /** This property selects the item in the DropDownList when the item is entered in the Search textbox. - * @Default {false} - */ - enableFilterSearch?: boolean; - - /** Saves the current model value to the browser cookies for state maintenance. While refreshing the DropDownList control page, it retains the model value and - * it is applied from the browser cookies. - * @Default {false} - */ - enablePersistence?: boolean; - - /** This enables the resize handler to resize the popup to any size. - * @Default {false} - */ - enablePopupResize?: boolean; - - /** Sets the DropDownList textbox direction from right to left align. - * @Default {false} - */ - enableRTL?: boolean; - - /** This property is used to sort the Items in the DropDownList. By default, it sorts the items in an ascending order. - * @Default {false} - */ - enableSorting?: boolean; - - /** Specifies the mapping fields for the data items of the DropDownList. - * @Default {null} - */ - fields?: Fields; - - /** When the enableFilterSearch property value is set to true, the values in the DropDownList shows the items starting with or containing the key word/letter typed in the Search textbox. - * @Default {ej.FilterType.Contains} - */ - filterType?: ej.FilterType|string; - - /** Used to create visualized header for dropdown items - * @Default {null} - */ - headerTemplate?: string; - - /** Defines the height of the DropDownList textbox. - * @Default {null} - */ - height?: string|number; - - /** It sets the given HTML attributes for the DropDownList control such as ID, name, disabled, etc. - * @Default {null} - */ - htmlAttributes?: any; - - /** Data can be fetched in the DropDownList control by using the DataSource, specifying the number of items. - * @Default {5} - */ - itemsCount?: number; - - /** Allows the user to set the particular country or region language for the DropDownList. - * @Default {en-US} - */ - locale?: string; - - /** Defines the maximum height of the suggestion box. This property restricts the maximum height of the popup when resize is enabled. - * @Default {null} - */ - maxPopupHeight?: string|number; - - /** Defines the minimum height of the suggestion box. This property restricts the minimum height of the popup when resize is enabled. - * @Default {null} - */ - minPopupHeight?: string|number; - - /** Defines the maximum width of the suggestion box. This property restricts the maximum width of the popup when resize is enabled. - * @Default {null} - */ - maxPopupWidth?: string|number; - - /** Defines the minimum height of the suggestion box. This property restricts the minimum height of the popup when resize is enabled. - * @Default {0} - */ - minPopupWidth?: string|number; - - /** With the help of this property, you can make a single or multi selection with the DropDownList and display the text in two modes, delimiter and visual mode. - * In delimiter mode, you can separate the items by using the delimiter character such as comma (,) or semi-colon (;) or any other special character. - * In the visual mode, the items are showcased like boxes with close icon in the textbox. - * @Default {ej.MultiSelectMode.None} - */ - multiSelectMode?: ej.MultiSelectMode|string; - - /** Defines the height of the suggestion popup box in the DropDownList control. - * @Default {152px} - */ - popupHeight?: string|number; - - /** Defines the width of the suggestion popup box in the DropDownList control. - * @Default {auto} - */ - popupWidth?: string|number; - - /** Specifies the query to retrieve the data from the DataSource. - * @Default {null} - */ - query?: any; - - /** Specifies that the DropDownList textbox values should be read-only. - * @Default {false} - */ - readOnly?: boolean; - - /** Specifies an item to be selected in the DropDownList. - * @Default {null} - */ - selectedIndex?: number; - - /** Specifies the selectedItems for the DropDownList. - * @Default {[]} - */ - selectedIndices?: any[]; - - /** Selects multiple items in the DropDownList with the help of the checkbox control. To achieve this, enable the showCheckbox option to true. - * @Default {false} - */ - showCheckbox?: boolean; - - /** DropDownList control is displayed with the popup seen. - * @Default {false} - */ - showPopupOnLoad?: boolean; - - /** DropDownList textbox displayed with the rounded corner style. - * @Default {false} - */ - showRoundedCorner?: boolean; - - /** When the enableSorting property value is set to true, this property helps to sort the items either in ascending or descending order - * @Default {ej.SortOrder.Ascending} - */ - sortOrder?: ej.SortOrder|string; - - /** Specifies the targetID for the DropDownListĂ¢â‚¬â„¢s items. - * @Default {null} - */ - targetID?: string; - - /** By default, you can add any text or image to the DropDownList item. To customize the item layout or to create your own visualized elements, you can use this template support. - * @Default {null} - */ - template?: string; - - /** Defines the text value that is displayed in the DropDownList textbox. - * @Default {null} - */ - text?: string|number; - - /** Sets the jQuery validation error message in the DropDownList - * @Default {null} - */ - validationMessage?: any; - - /** Sets the jQuery validation rules in the Dropdownlist. - * @Default {null} - */ - validationRules?: any; - - /** Specifies the value (text content) for the DropDownList control. - * @Default {null} - */ - value?: string|number; - - /** Specifies a short hint that describes the expected value of the DropDownList control. - * @Default {null} - */ - watermarkText?: string; - - /** Defines the width of the DropDownList textbox. - * @Default {null} - */ - width?: string|number; + export interface CollapseEventArgs { + + /** Set this option to true to cancel the event. + */ + cancel?: boolean; + + /** Instance of the dialog model object. + */ + model?: ej.Dialog.Model; + + /** Name of the event. + */ + type?: string; + } + + export interface ActionButtonClickEventArgs { + + /** Set this option to true to cancel the event. + */ + cancel?: boolean; + + /** Name of the event target attribute. + */ + buttonID?: string; + + /** Name of the event. + */ + type?: string; + + /** Instance of the dialog model object. + */ + model?: ej.Dialog.Model; + + /** Name of the event current target title. + */ + currentTarget?: string; + } + + export interface AjaxSettings { + + /** It specifies, whether to enable or disable asynchronous request. + */ + async?: boolean; + + /** It specifies the page will be cached in the web browser. + */ + cache?: boolean; + + /** It specifies the type of data is send in the query string. + */ + contentType?: string; + + /** It specifies the data as an object, will be passed in the query string. + */ + data?: any; + + /** It specifies the type of data that you're expecting back from the response. + */ + dataType?: string; + + /** It specifies the HTTP request type. + */ + type?: string; + } + } + + class DropDownList extends ej.Widget { + static fn: DropDownList; + constructor(element: JQuery | Element, options?: DropDownList.Model); + static Locale: any; + model: DropDownList.Model; + defaults: DropDownList.Model; + + /** Adding a single item or an array of items into the DropDownList allows you to specify all the field attributes such as value, template, image URL, and HTML attributes for those items. + * @param {any|Array} this parameter should have field attributes with respect to mapped field attributes and it's corresponding values to fields + * @returns {void} + */ + addItem(data: any | any[]): void; + + /** This method is used to select all the items in the DropDownList. + * @returns {void} + */ + checkAll(): void; + + /** Clears the text in the DropDownList textbox. + * @returns {void} + */ + clearText(): void; + + /** Destroys the DropDownList widget. + * @returns {void} + */ + destroy(): void; + + /** This property is used to disable the DropDownList widget. + * @returns {void} + */ + disable(): void; + + /** This property disables the set of items in the DropDownList. + * @param {string|number|Array} disable the given index list items + * @returns {void} + */ + disableItemsByIndices(index: string | number | any[]): void; + + /** This property enables the DropDownList control. + * @returns {void} + */ + enable(): void; + + /** Enables an Item or set of Items that are disabled in the DropDownList + * @param {string|number|Array} enable the given index list items if it's disabled + * @returns {void} + */ + enableItemsByIndices(index: string | number | any[]): void; + + /** This method retrieves the items using given value. + * @param {string|number|any} Return the whole object of data based on given value + * @returns {Array} + */ + getItemDataByValue(value: string | number | any): any[]; + + /** This method is used to retrieve the items that are bound with the DropDownList. + * @returns {any} + */ + getListData(): any; + + /** This method is used to get the selected items in the DropDownList. + * @returns {Array} + */ + getSelectedItem(): any[]; + + /** This method is used to retrieve the items value that are selected in the DropDownList. + * @returns {string} + */ + getSelectedValue(): string; + + /** This method hides the suggestion popup in the DropDownList. + * @returns {void} + */ + hidePopup(): void; + + /** This method is used to select the list of items in the DropDownList through the Index of the items. + * @param {string|number|Array} select the given index list items + * @returns {void} + */ + selectItemsByIndices(index: string | number | any[]): void; + + /** This method is used to select an item in the DropDownList by using the given text value. + * @param {string|number|Array} select the list items relates to given text + * @returns {void} + */ + selectItemByText(index: string | number | any[]): void; + + /** This method is used to select an item in the DropDownList by using the given value. + * @param {string|number|Array} select the list items relates to given values + * @returns {void} + */ + selectItemByValue(index: string | number | any[]): void; + + /** This method shows the DropDownList control with the suggestion popup. + * @returns {void} + */ + showPopup(): void; + + /** This method is used to unselect all the items in the DropDownList. + * @returns {void} + */ + unCheckAll(): void; + + /** This method is used to unselect the list of items in the DropDownList through Index of the items. + * @param {string|number|Array} unselect the given index list items + * @returns {void} + */ + unselectItemsByIndices(index: string | number | any[]): void; + + /** This method is used to unselect an item in the DropDownList by using the given text value. + * @param {string|number|Array} unselect the list items relates to given text + * @returns {void} + */ + unselectItemByText(index: string | number | any[]): void; + + /** This method is used to unselect an item in the DropDownList by using the given value. + * @param {string|number|Array} unselect the list items relates to given values + * @returns {void} + */ + unselectItemByValue(index: string | number | any[]): void; + } + export namespace DropDownList { + + export interface Model { + + /** The Virtual Scrolling(lazy loading) feature is used to display a large amount of data that you require without buffering the entire load of a huge database records in the DropDownList, + * that is, when scrolling, an AJAX request is sent to fetch some amount of data from the server dynamically. To achieve this scenario with DropDownList, set the allowVirtualScrolling to true. + * @Default {false} + */ + allowVirtualScrolling?: boolean; + + /** The cascading DropDownLists is a series of two or more DropDownLists in which each DropDownList is filtered according to the previous DropDownListĂ¢â‚¬â„¢s value. + * @Default {null} + */ + cascadeTo?: string; + + /** Sets the case sensitivity of the search operation. It supports both enableFilterSearch and enableIncrementalSearch property. + * @Default {false} + */ + caseSensitiveSearch?: boolean; + + /** Dropdown widget's style and appearance can be controlled based on 13 different default built-in themes.You can customize the appearance of the dropdown by using the cssClass property. + * You need to specify a class name in the cssClass property and the same class name is used before the class definitions wherever the custom styles are applied. + */ + cssClass?: string; + + /** This property is used to serve data from the data services based on the query provided. To bind the data to the dropdown widget, + * the dataSource property is assigned with the instance of the ej.DataManager. + * @Default {null} + */ + dataSource?: any; + + /** Sets the separator when the multiSelectMode with delimiter option or checkbox is enabled with the dropdown. When you enter the delimiter value,the texts after the delimiter are considered + * as a separate word or query. The delimiter string is a single character and must be a symbol. Mostly, the delimiter symbol is used as comma (,) or semi-colon (;) or any other special character. + * @Default {','} + */ + delimiterChar?: string; + + /** The enabled Animation property uses the easeOutQuad animation to SlideDown and SlideUp the Popup list in 200 and 100 milliseconds, respectively. + * @Default {false} + */ + enableAnimation?: boolean; + + /** This property is used to indicate whether the DropDownList control responds to the user interaction or not. By default, the control is in the enabled mode + * and you can disable it by setting it to false. + * @Default {true} + */ + enabled?: boolean; + + /** Specifies to perform incremental search for the selection of items from the DropDownList with the help of this property. This helps in selecting the item by using the typed character. + * @Default {true} + */ + enableIncrementalSearch?: boolean; + + /** This property selects the item in the DropDownList when the item is entered in the Search textbox. + * @Default {false} + */ + enableFilterSearch?: boolean; + + /** Saves the current model value to the browser cookies for state maintenance. While refreshing the DropDownList control page, it retains the model value and + * it is applied from the browser cookies. + * @Default {false} + */ + enablePersistence?: boolean; + + /** This enables the resize handler to resize the popup to any size. + * @Default {false} + */ + enablePopupResize?: boolean; + + /** Sets the DropDownList textbox direction from right to left align. + * @Default {false} + */ + enableRTL?: boolean; + + /** This property is used to sort the Items in the DropDownList. By default, it sorts the items in an ascending order. + * @Default {false} + */ + enableSorting?: boolean; + + /** Specifies the mapping fields for the data items of the DropDownList. + * @Default {null} + */ + fields?: Fields; + + /** When the enableFilterSearch property value is set to true, the values in the DropDownList shows the items starting with or containing the key word/letter typed in the Search textbox. + * @Default {ej.FilterType.Contains} + */ + filterType?: ej.FilterType | string; + + /** Used to create visualized header for dropdown items + * @Default {null} + */ + headerTemplate?: string; + + /** Defines the height of the DropDownList textbox. + * @Default {null} + */ + height?: string | number; + + /** It sets the given HTML attributes for the DropDownList control such as ID, name, disabled, etc. + * @Default {null} + */ + htmlAttributes?: any; + + /** Data can be fetched in the DropDownList control by using the DataSource, specifying the number of items. + * @Default {5} + */ + itemsCount?: number; + + /** Allows the user to set the particular country or region language for the DropDownList. + * @Default {en-US} + */ + locale?: string; + + /** Defines the maximum height of the suggestion box. This property restricts the maximum height of the popup when resize is enabled. + * @Default {null} + */ + maxPopupHeight?: string | number; + + /** Defines the minimum height of the suggestion box. This property restricts the minimum height of the popup when resize is enabled. + * @Default {null} + */ + minPopupHeight?: string | number; + + /** Defines the maximum width of the suggestion box. This property restricts the maximum width of the popup when resize is enabled. + * @Default {null} + */ + maxPopupWidth?: string | number; + + /** Defines the minimum height of the suggestion box. This property restricts the minimum height of the popup when resize is enabled. + * @Default {0} + */ + minPopupWidth?: string | number; + + /** With the help of this property, you can make a single or multi selection with the DropDownList and display the text in two modes, delimiter and visual mode. + * In delimiter mode, you can separate the items by using the delimiter character such as comma (,) or semi-colon (;) or any other special character. + * In the visual mode, the items are showcased like boxes with close icon in the textbox. + * @Default {ej.MultiSelectMode.None} + */ + multiSelectMode?: ej.MultiSelectMode | string; + + /** Defines the height of the suggestion popup box in the DropDownList control. + * @Default {152px} + */ + popupHeight?: string | number; + + /** Defines the width of the suggestion popup box in the DropDownList control. + * @Default {auto} + */ + popupWidth?: string | number; + + /** Specifies the query to retrieve the data from the DataSource. + * @Default {null} + */ + query?: any; + + /** Specifies that the DropDownList textbox values should be read-only. + * @Default {false} + */ + readOnly?: boolean; + + /** Specifies an item to be selected in the DropDownList. + * @Default {null} + */ + selectedIndex?: number; + + /** Specifies the selectedItems for the DropDownList. + * @Default {[]} + */ + selectedIndices?: any[]; + + /** Selects multiple items in the DropDownList with the help of the checkbox control. To achieve this, enable the showCheckbox option to true. + * @Default {false} + */ + showCheckbox?: boolean; + + /** DropDownList control is displayed with the popup seen. + * @Default {false} + */ + showPopupOnLoad?: boolean; + + /** DropDownList textbox displayed with the rounded corner style. + * @Default {false} + */ + showRoundedCorner?: boolean; + + /** When the enableSorting property value is set to true, this property helps to sort the items either in ascending or descending order + * @Default {ej.SortOrder.Ascending} + */ + sortOrder?: ej.SortOrder | string; + + /** Specifies the targetID for the DropDownListĂ¢â‚¬â„¢s items. + * @Default {null} + */ + targetID?: string; + + /** By default, you can add any text or image to the DropDownList item. To customize the item layout or to create your own visualized elements, you can use this template support. + * @Default {null} + */ + template?: string; + + /** Defines the text value that is displayed in the DropDownList textbox. + * @Default {null} + */ + text?: string | number; + + /** Sets the jQuery validation error message in the DropDownList + * @Default {null} + */ + validationMessage?: any; + + /** Sets the jQuery validation rules in the Dropdownlist. + * @Default {null} + */ + validationRules?: any; + + /** Specifies the value (text content) for the DropDownList control. + * @Default {null} + */ + value?: string | number; + + /** Specifies a short hint that describes the expected value of the DropDownList control. + * @Default {null} + */ + watermarkText?: string; + + /** Defines the width of the DropDownList textbox. + * @Default {null} + */ + width?: string | number; - /** The Virtual Scrolling feature is used to display a large amount of records in the DropDownList, that is, when scrolling, an AJAX request is sent to fetch some amount of data from - * the server dynamically. To achieve this scenario with DropDownList, set the allowVirtualScrolling to true. - * You can set the itemsCount property that represents the number of items to be fetched from the server on every AJAX request. - * @Default {normal} - */ - virtualScrollMode?: ej.VirtualScrollMode|string; + /** The Virtual Scrolling feature is used to display a large amount of records in the DropDownList, that is, when scrolling, an AJAX request is sent to fetch some amount of data from + * the server dynamically. To achieve this scenario with DropDownList, set the allowVirtualScrolling to true. + * You can set the itemsCount property that represents the number of items to be fetched from the server on every AJAX request. + * @Default {normal} + */ + virtualScrollMode?: ej.VirtualScrollMode | string; - /** Fires the action before the XHR request. */ - actionBegin?(e: ActionBeginEventArgs): void; + /** Fires the action before the XHR request. */ + actionBegin?(e: ActionBeginEventArgs): void; - /** Fires the action when the list of items is bound to the DropDownList by xhr post calling */ - actionComplete?(e: ActionCompleteEventArgs): void; + /** Fires the action when the list of items is bound to the DropDownList by xhr post calling */ + actionComplete?(e: ActionCompleteEventArgs): void; - /** Fires the action when the xhr post calling failed on remote data binding with the DropDownList control. */ - actionFailure?(e: ActionFailureEventArgs): void; + /** Fires the action when the xhr post calling failed on remote data binding with the DropDownList control. */ + actionFailure?(e: ActionFailureEventArgs): void; - /** Fires the action when the xhr post calling succeed on remote data binding with the DropDownList control */ - actionSuccess?(e: ActionSuccessEventArgs): void; + /** Fires the action when the xhr post calling succeed on remote data binding with the DropDownList control */ + actionSuccess?(e: ActionSuccessEventArgs): void; - /** Fires the action before the popup is ready to hide. */ - beforePopupHide?(e: BeforePopupHideEventArgs): void; + /** Fires the action before the popup is ready to hide. */ + beforePopupHide?(e: BeforePopupHideEventArgs): void; - /** Fires the action before the popup is ready to be displayed. */ - beforePopupShown?(e: BeforePopupShownEventArgs): void; + /** Fires the action before the popup is ready to be displayed. */ + beforePopupShown?(e: BeforePopupShownEventArgs): void; - /** Fires when the cascading happens between two DropDownList exactly after the value changes in the first dropdown and before filtering in the second Dropdown. */ - cascade?(e: CascadeEventArgs): void; + /** Fires when the cascading happens between two DropDownList exactly after the value changes in the first dropdown and before filtering in the second Dropdown. */ + cascade?(e: CascadeEventArgs): void; - /** Fires the action when the DropDownList controlĂ¢â‚¬â„¢s value is changed. */ - change?(e: ChangeEventArgs): void; + /** Fires the action when the DropDownList controlĂ¢â‚¬â„¢s value is changed. */ + change?(e: ChangeEventArgs): void; - /** Fires the action when the list item checkbox value is changed. */ - checkChange?(e: CheckChangeEventArgs): void; + /** Fires the action when the list item checkbox value is changed. */ + checkChange?(e: CheckChangeEventArgs): void; - /** Fires the action once the DropDownList is created. */ - create?(e: CreateEventArgs): void; + /** Fires the action once the DropDownList is created. */ + create?(e: CreateEventArgs): void; - /** Fires the action when the list items is bound to the DropDownList. */ - dataBound?(e: DataBoundEventArgs): void; + /** Fires the action when the list items is bound to the DropDownList. */ + dataBound?(e: DataBoundEventArgs): void; - /** Fires the action when the DropDownList is destroyed. */ - destroy?(e: DestroyEventArgs): void; + /** Fires the action when the DropDownList is destroyed. */ + destroy?(e: DestroyEventArgs): void; - /** Fires the action when the DropDownList is focused. */ - focusIn?(e: FocusInEventArgs): void; + /** Fires the action when the DropDownList is focused. */ + focusIn?(e: FocusInEventArgs): void; - /** Fires the action when the DropDownList is about to lose focus. */ - focusOut?(e: FocusOutEventArgs): void; + /** Fires the action when the DropDownList is about to lose focus. */ + focusOut?(e: FocusOutEventArgs): void; - /** Fires the action, once the popup is closed */ - popupHide?(e: PopupHideEventArgs): void; + /** Fires the action, once the popup is closed */ + popupHide?(e: PopupHideEventArgs): void; - /** Fires the action, when the popup is resized. */ - popupResize?(e: PopupResizeEventArgs): void; + /** Fires the action, when the popup is resized. */ + popupResize?(e: PopupResizeEventArgs): void; - /** Fires the action, once the popup is opened. */ - popupShown?(e: PopupShownEventArgs): void; + /** Fires the action, once the popup is opened. */ + popupShown?(e: PopupShownEventArgs): void; - /** Fires the action, when resizing a popup starts. */ - popupResizeStart?(e: PopupResizeStartEventArgs): void; + /** Fires the action, when resizing a popup starts. */ + popupResizeStart?(e: PopupResizeStartEventArgs): void; - /** Fires the action, when the popup resizing is stopped. */ - popupResizeStop?(e: PopupResizeStopEventArgs): void; + /** Fires the action, when the popup resizing is stopped. */ + popupResizeStop?(e: PopupResizeStopEventArgs): void; - /** Fires the action before filtering the list items that starts in the DropDownList when the enableFilterSearch is enabled. */ - search?(e: SearchEventArgs): void; + /** Fires the action before filtering the list items that starts in the DropDownList when the enableFilterSearch is enabled. */ + search?(e: SearchEventArgs): void; - /** Fires the action, when the list of item is selected. */ - select?(e: SelectEventArgs): void; -} + /** Fires the action, when the list of item is selected. */ + select?(e: SelectEventArgs): void; + } -export interface ActionBeginEventArgs { + export interface ActionBeginEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the DropDownList model - */ - model?: any; + /** returns the DropDownList model + */ + model?: any; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface ActionCompleteEventArgs { + export interface ActionCompleteEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns number of times trying to fetch the data - */ - count?: number; + /** Returns number of times trying to fetch the data + */ + count?: number; - /** returns the DropDownList model - */ - model?: any; + /** returns the DropDownList model + */ + model?: any; - /** Returns the query for data retrieval - */ - query?: any; + /** Returns the query for data retrieval + */ + query?: any; - /** Returns the query for data retrieval from the Database - */ - request?: any; + /** Returns the query for data retrieval from the Database + */ + request?: any; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** Returns the number of items fetched from remote data - */ - result?: any[]; + /** Returns the number of items fetched from remote data + */ + result?: any[]; - /** Returns the requested data - */ - xhr?: any; -} + /** Returns the requested data + */ + xhr?: any; + } -export interface ActionFailureEventArgs { + export interface ActionFailureEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the error message - */ - error?: any; + /** Returns the error message + */ + error?: any; - /** returns the DropDownList model - */ - model?: any; + /** returns the DropDownList model + */ + model?: any; - /** Returns the query for data retrieval - */ - query?: any; + /** Returns the query for data retrieval + */ + query?: any; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface ActionSuccessEventArgs { + export interface ActionSuccessEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns number of times trying to fetch the data - */ - count?: number; + /** Returns number of times trying to fetch the data + */ + count?: number; - /** returns the DropDownList model - */ - model?: any; + /** returns the DropDownList model + */ + model?: any; - /** Returns the query for data retrieval - */ - query?: any; + /** Returns the query for data retrieval + */ + query?: any; - /** Returns the query for data retrieval from the Database - */ - request?: any; + /** Returns the query for data retrieval from the Database + */ + request?: any; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** Returns the number of items fetched from remote data - */ - result?: any[]; + /** Returns the number of items fetched from remote data + */ + result?: any[]; - /** Returns the requested data - */ - xhr?: any; -} + /** Returns the requested data + */ + xhr?: any; + } -export interface BeforePopupHideEventArgs { + export interface BeforePopupHideEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the DropDownList model - */ - model?: any; + /** returns the DropDownList model + */ + model?: any; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the selected text - */ - text?: string; + /** returns the selected text + */ + text?: string; - /** returns the selected value - */ - value?: string; -} + /** returns the selected value + */ + value?: string; + } -export interface BeforePopupShownEventArgs { + export interface BeforePopupShownEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the DropDownList model - */ - model?: any; + /** returns the DropDownList model + */ + model?: any; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the selected text - */ - text?: string; + /** returns the selected text + */ + text?: string; - /** returns the selected value - */ - value?: string; -} + /** returns the selected value + */ + value?: string; + } -export interface CascadeEventArgs { + export interface CascadeEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the cascading dropdown model. - */ - cascadeModel?: any; + /** Returns the cascading dropdown model. + */ + cascadeModel?: any; - /** returns the current selected value in first dropdown. - */ - cascadeValue?: string; + /** returns the current selected value in first dropdown. + */ + cascadeValue?: string; - /** returns the DropDownList model - */ - model?: any; + /** returns the DropDownList model + */ + model?: any; - /** returns the default filter action for second dropdown data should happen or not. - */ - requiresDefaultFilter?: boolean; + /** returns the default filter action for second dropdown data should happen or not. + */ + requiresDefaultFilter?: boolean; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface ChangeEventArgs { + export interface ChangeEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the selected item with checkbox checked or not. - */ - isChecked?: boolean; + /** Returns the selected item with checkbox checked or not. + */ + isChecked?: boolean; - /** Returns the selected item ID. - */ - itemId?: string; + /** Returns the selected item ID. + */ + itemId?: string; - /** returns the DropDownList model - */ - model?: any; + /** returns the DropDownList model + */ + model?: any; - /** Returns the selected item text. - */ - selectedText?: string; + /** Returns the selected item text. + */ + selectedText?: string; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** Returns the selected text. - */ - text?: string; + /** Returns the selected text. + */ + text?: string; - /** Returns the selected value. - */ - value?: string; -} + /** Returns the selected value. + */ + value?: string; + } -export interface CheckChangeEventArgs { + export interface CheckChangeEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the selected item with checkbox checked or not. - */ - isChecked?: boolean; + /** Returns the selected item with checkbox checked or not. + */ + isChecked?: boolean; - /** Returns the selected item ID. - */ - itemId?: string; + /** Returns the selected item ID. + */ + itemId?: string; - /** returns the DropDownList model - */ - model?: any; + /** returns the DropDownList model + */ + model?: any; - /** Returns the selected item text. - */ - selectedText?: string; + /** Returns the selected item text. + */ + selectedText?: string; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** Returns the selected text. - */ - text?: string; + /** Returns the selected text. + */ + text?: string; - /** Returns the selected value. - */ - value?: string; -} + /** Returns the selected value. + */ + value?: string; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the DropDownList model - */ - model?: any; + /** returns the DropDownList model + */ + model?: any; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface DataBoundEventArgs { + export interface DataBoundEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the DropDownList model - */ - model?: any; + /** returns the DropDownList model + */ + model?: any; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the data that is bound to DropDownList - */ - data?: any; -} + /** returns the data that is bound to DropDownList + */ + data?: any; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** its value is set as true,if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** its value is set as true,if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the DropDownList model - */ - model?: any; + /** returns the DropDownList model + */ + model?: any; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface FocusInEventArgs { + export interface FocusInEventArgs { - /** its value is set as true,if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** its value is set as true,if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the DropDownList model - */ - model?: any; + /** returns the DropDownList model + */ + model?: any; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface FocusOutEventArgs { + export interface FocusOutEventArgs { - /** its value is set as true,if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** its value is set as true,if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the DropDownList model - */ - model?: any; + /** returns the DropDownList model + */ + model?: any; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface PopupHideEventArgs { + export interface PopupHideEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the DropDownList model - */ - model?: any; + /** returns the DropDownList model + */ + model?: any; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the selected text - */ - text?: string; + /** returns the selected text + */ + text?: string; - /** returns the selected value - */ - value?: string; -} + /** returns the selected value + */ + value?: string; + } -export interface PopupResizeEventArgs { + export interface PopupResizeEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the DropDownList model - */ - model?: any; + /** returns the DropDownList model + */ + model?: any; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** Returns the data from the resizable plugin. - */ - event?: any; -} + /** Returns the data from the resizable plugin. + */ + event?: any; + } -export interface PopupShownEventArgs { + export interface PopupShownEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the DropDownList model - */ - model?: any; + /** returns the DropDownList model + */ + model?: any; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the selected text - */ - text?: string; + /** returns the selected text + */ + text?: string; - /** returns the selected value - */ - value?: string; -} + /** returns the selected value + */ + value?: string; + } -export interface PopupResizeStartEventArgs { + export interface PopupResizeStartEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the DropDownList model - */ - model?: any; + /** returns the DropDownList model + */ + model?: any; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** Returns the data from the resizable plugin. - */ - event?: any; -} + /** Returns the data from the resizable plugin. + */ + event?: any; + } -export interface PopupResizeStopEventArgs { + export interface PopupResizeStopEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the DropDownList model - */ - model?: any; + /** returns the DropDownList model + */ + model?: any; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** Returns the data from the resizable plugin. - */ - event?: any; -} + /** Returns the data from the resizable plugin. + */ + event?: any; + } -export interface SearchEventArgs { + export interface SearchEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the data bound to the DropDownList. - */ - items?: any; + /** Returns the data bound to the DropDownList. + */ + items?: any; - /** returns the DropDownList model - */ - model?: any; - - /** Returns the selected item text. - */ - selectedText?: string; - - /** returns the name of the event - */ - type?: string; - - /** Returns the search string typed in search box. - */ - searchString?: string; -} - -export interface SelectEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** Returns the selected item with checkbox checked or not. - */ - isChecked?: boolean; - - /** Returns the selected item ID. - */ - itemId?: string; - - /** returns the DropDownList model - */ - model?: any; - - /** Returns the selected item text. - */ - selectedText?: string; - - /** returns the name of the event - */ - type?: string; - - /** Returns the selected text. - */ - text?: string; - - /** Returns the selected value. - */ - value?: string; -} - -export interface Fields { - - /** Used to group the items. - */ - groupBy?: string; - - /** Defines the HTML attributes such as ID, class, and styles for the item. - */ - htmlAttributes?: any; - - /** Defines the ID for the tag. - */ - id?: string; - - /** Defines the image attributes such as height, width, styles, and so on. - */ - imageAttributes?: string; - - /** Defines the imageURL for the image location. - */ - imageUrl?: string; - - /** Defines the tag value to be selected initially. - */ - selected?: boolean; - - /** Defines the sprite CSS for the image tag. - */ - spriteCssClass?: string; - - /** Defines the table name for tag value or display text while rendering remote data. - */ - tableName?: string; - - /** Defines the text content for the tag. - */ - text?: string; - - /** Defines the tag value. - */ - value?: string; -} -} -enum FilterType { -//filter the data wherever contains search key -Contains, -//filter the data based on search key present at start position -StartsWith, -} -enum MultiSelectMode { -// can select only single item in DropDownList -None, -//can select multiple items and it's separated by delimiterChar -Delimiter, -// can select multiple items and it's show's like visual box in textbox -VisualMode, -} -enum VirtualScrollMode { -// The data is loaded only to the corresponding page (display items). When scrolling some other position, it enables the load on demand with the DropDownList. -Normal, -//The data items are loaded from the remote when scroll handle reaches the end of the scrollbar like infinity scrolling. -Continuous, -} - -class Tooltip extends ej.Widget { - static fn: Tooltip; - constructor(element: JQuery | Element, options?: Tooltip.Model); - static Locale: any; - model: Tooltip.Model; - defaults: Tooltip.Model; - - /** Destroys the Tooltip control. - * @returns {void} - */ - destroy(): void; - - /** Disables the Tooltip control. - * @returns {void} - */ - disable(): void; - - /** Enables the Tooltip control. - * @returns {void} - */ - enable(): void; - - /** Hide the Tooltip popup. - * @param {string} optional Determines the type of effect that takes place when hiding the tooltip. - * @param {Function} optional custom effect takes place when hiding the tooltip. - * @returns {void} - */ - hide(effect?: string, func?: any): void; - - /** Shows the Tooltip popup for the given target element with the specified effect. - * @param {string} optional Determines the type of effect that takes place when showing the tooltip. - * @param {Function} optional custom effect takes place when showing the tooltip. - * @param {JQuery} optional Tooltip will be shown for the given element - * @returns {void} - */ - show(effect?: string, func?: any, target?: JQuery): void; -} -export namespace Tooltip { - -export interface Model { - - /** Tooltip control can be accessed through the keyboard shortcut keys. - * @Default {true} - */ - allowKeyboardNavigation?: boolean; - - /** Specifies the animation behavior in Tooltip. It contains the following sub properties. - */ - animation?: Animation; - - /** Sets the position related to target element, window, mouse or (x,y) co-ordinates. - * @Default {ej.Tooltip.Associate.Target} - */ - associate?: ej.Tooltip.Associate|string; - - /** Specified the delay to hide Tooltip when closeMode is auto. - * @Default {4000} - */ - autoCloseTimeout?: number; - - /** Specifies the closing behavior of Tooltip popup. - * @Default {ej.Tooltip.CloseMode.None} - */ - closeMode?: ej.Tooltip.CloseMode|string; - - /** Sets the Tooltip in alternate position when collision occurs. - * @Default {ej.Tooltip.Collision.FlipFit} - */ - collision?: ej.Tooltip.Collision|string; - - /** Specified the selector for the container element. - * @Default {body} - */ - containment?: string; - - /** Specifies the text for Tooltip. - * @Default {null} - */ - content?: string; - - /** Sets the root CSS class for Tooltip for the customization. - * @Default {null} - */ - cssClass?: string; - - /** Enables or disables the Tooltip. - * @Default {true} - */ - enabled?: boolean; - - /** Sets the Tooltip direction from right to left. - * @Default {false} - */ - enableRTL?: boolean; - - /** Defines the height of the Tooltip popup. - * @Default {auto} - */ - height?: string|number; - - /** Enables the arrow in Tooltip. - * @Default {true} - */ - isBalloon?: boolean; - - /** defines various attributes of the Tooltip position - */ - position?: Position; - - /** Enables or disables rounded corner. - * @Default {false} - */ - showRoundedCorner?: boolean; - - /** Enables or disables shadow effect. - * @Default {false} - */ - showShadow?: boolean; - - /** Specified a selector for elements, within the container. - * @Default {null} - */ - target?: string; - - /** The title text to be displayed in the Tooltip header. - * @Default {null} - */ - title?: string; - - /** Specified the event action to show case the Tooltip. - * @Default {ej.Tooltip.Trigger.Hover} - */ - trigger?: ej.Tooltip.Trigger|string; - - /** Defines the width of the Tooltip popup. - * @Default {auto} - */ - width?: string|number; + /** returns the DropDownList model + */ + model?: any; + + /** Returns the selected item text. + */ + selectedText?: string; + + /** returns the name of the event + */ + type?: string; + + /** Returns the search string typed in search box. + */ + searchString?: string; + } + + export interface SelectEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** Returns the selected item with checkbox checked or not. + */ + isChecked?: boolean; + + /** Returns the selected item ID. + */ + itemId?: string; + + /** returns the DropDownList model + */ + model?: any; + + /** Returns the selected item text. + */ + selectedText?: string; + + /** returns the name of the event + */ + type?: string; + + /** Returns the selected text. + */ + text?: string; + + /** Returns the selected value. + */ + value?: string; + } + + export interface Fields { + + /** Used to group the items. + */ + groupBy?: string; + + /** Defines the HTML attributes such as ID, class, and styles for the item. + */ + htmlAttributes?: any; + + /** Defines the ID for the tag. + */ + id?: string; + + /** Defines the image attributes such as height, width, styles, and so on. + */ + imageAttributes?: string; + + /** Defines the imageURL for the image location. + */ + imageUrl?: string; + + /** Defines the tag value to be selected initially. + */ + selected?: boolean; + + /** Defines the sprite CSS for the image tag. + */ + spriteCssClass?: string; + + /** Defines the table name for tag value or display text while rendering remote data. + */ + tableName?: string; + + /** Defines the text content for the tag. + */ + text?: string; + + /** Defines the tag value. + */ + value?: string; + } + } + enum FilterType { + //filter the data wherever contains search key + Contains, + //filter the data based on search key present at start position + StartsWith, + } + enum MultiSelectMode { + // can select only single item in DropDownList + None, + //can select multiple items and it's separated by delimiterChar + Delimiter, + // can select multiple items and it's show's like visual box in textbox + VisualMode, + } + enum VirtualScrollMode { + // The data is loaded only to the corresponding page (display items). When scrolling some other position, it enables the load on demand with the DropDownList. + Normal, + //The data items are loaded from the remote when scroll handle reaches the end of the scrollbar like infinity scrolling. + Continuous, + } + + class Tooltip extends ej.Widget { + static fn: Tooltip; + constructor(element: JQuery | Element, options?: Tooltip.Model); + static Locale: any; + model: Tooltip.Model; + defaults: Tooltip.Model; + + /** Destroys the Tooltip control. + * @returns {void} + */ + destroy(): void; + + /** Disables the Tooltip control. + * @returns {void} + */ + disable(): void; + + /** Enables the Tooltip control. + * @returns {void} + */ + enable(): void; + + /** Hide the Tooltip popup. + * @param {string} optional Determines the type of effect that takes place when hiding the tooltip. + * @param {Function} optional custom effect takes place when hiding the tooltip. + * @returns {void} + */ + hide(effect?: string, func?: any): void; + + /** Shows the Tooltip popup for the given target element with the specified effect. + * @param {string} optional Determines the type of effect that takes place when showing the tooltip. + * @param {Function} optional custom effect takes place when showing the tooltip. + * @param {JQuery} optional Tooltip will be shown for the given element + * @returns {void} + */ + show(effect?: string, func?: any, target?: JQuery): void; + } + export namespace Tooltip { + + export interface Model { + + /** Tooltip control can be accessed through the keyboard shortcut keys. + * @Default {true} + */ + allowKeyboardNavigation?: boolean; + + /** Specifies the animation behavior in Tooltip. It contains the following sub properties. + */ + animation?: Animation; + + /** Sets the position related to target element, window, mouse or (x,y) co-ordinates. + * @Default {ej.Tooltip.Associate.Target} + */ + associate?: ej.Tooltip.Associate | string; + + /** Specified the delay to hide Tooltip when closeMode is auto. + * @Default {4000} + */ + autoCloseTimeout?: number; + + /** Specifies the closing behavior of Tooltip popup. + * @Default {ej.Tooltip.CloseMode.None} + */ + closeMode?: ej.Tooltip.CloseMode | string; + + /** Sets the Tooltip in alternate position when collision occurs. + * @Default {ej.Tooltip.Collision.FlipFit} + */ + collision?: ej.Tooltip.Collision | string; + + /** Specified the selector for the container element. + * @Default {body} + */ + containment?: string; + + /** Specifies the text for Tooltip. + * @Default {null} + */ + content?: string; + + /** Sets the root CSS class for Tooltip for the customization. + * @Default {null} + */ + cssClass?: string; + + /** Enables or disables the Tooltip. + * @Default {true} + */ + enabled?: boolean; + + /** Sets the Tooltip direction from right to left. + * @Default {false} + */ + enableRTL?: boolean; + + /** Defines the height of the Tooltip popup. + * @Default {auto} + */ + height?: string | number; + + /** Enables the arrow in Tooltip. + * @Default {true} + */ + isBalloon?: boolean; + + /** defines various attributes of the Tooltip position + */ + position?: Position; + + /** Enables or disables rounded corner. + * @Default {false} + */ + showRoundedCorner?: boolean; + + /** Enables or disables shadow effect. + * @Default {false} + */ + showShadow?: boolean; + + /** Specified a selector for elements, within the container. + * @Default {null} + */ + target?: string; + + /** The title text to be displayed in the Tooltip header. + * @Default {null} + */ + title?: string; + + /** Specified the event action to show case the Tooltip. + * @Default {ej.Tooltip.Trigger.Hover} + */ + trigger?: ej.Tooltip.Trigger | string; + + /** Defines the width of the Tooltip popup. + * @Default {auto} + */ + width?: string | number; - /** This event is triggered before the Tooltip widget get closed. */ - beforeClose?(e: BeforeCloseEventArgs): void; - - /** This event is triggered before the Tooltip widget gets open. */ - beforeOpen?(e: BeforeOpenEventArgs): void; + /** This event is triggered before the Tooltip widget get closed. */ + beforeClose?(e: BeforeCloseEventArgs): void; + + /** This event is triggered before the Tooltip widget gets open. */ + beforeOpen?(e: BeforeOpenEventArgs): void; - /** Fires on clicking to the target element. */ - click?(e: ClickEventArgs): void; - - /** This event is triggered after the Tooltip widget is closed. */ - close?(e: CloseEventArgs): void; - - /** This event is triggered after the Tooltip is created successfully. */ - create?(e: CreateEventArgs): void; + /** Fires on clicking to the target element. */ + click?(e: ClickEventArgs): void; + + /** This event is triggered after the Tooltip widget is closed. */ + close?(e: CloseEventArgs): void; + + /** This event is triggered after the Tooltip is created successfully. */ + create?(e: CreateEventArgs): void; - /** This event is triggered after the Tooltip widget is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; - - /** This event is triggered while hovering the target element, when tooltip positioning relates to target element. */ - hover?(e: HoverEventArgs): void; + /** This event is triggered after the Tooltip widget is destroyed successfully. */ + destroy?(e: DestroyEventArgs): void; + + /** This event is triggered while hovering the target element, when tooltip positioning relates to target element. */ + hover?(e: HoverEventArgs): void; - /** This event is triggered after the Tooltip is opened. */ - open?(e: OpenEventArgs): void; + /** This event is triggered after the Tooltip is opened. */ + open?(e: OpenEventArgs): void; - /** This event is triggered while hover the target element, when the tooltip positioning is relates to the mouse. */ - tracking?(e: TrackingEventArgs): void; -} + /** This event is triggered while hover the target element, when the tooltip positioning is relates to the mouse. */ + tracking?(e: TrackingEventArgs): void; + } -export interface BeforeCloseEventArgs { + export interface BeforeCloseEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the tooltip model - */ - model?: any; + /** returns the tooltip model + */ + model?: any; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the Tooltip's content - */ - content?: string; -} + /** returns the Tooltip's content + */ + content?: string; + } -export interface BeforeOpenEventArgs { + export interface BeforeOpenEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the Tooltip model - */ - model?: any; + /** returns the Tooltip model + */ + model?: any; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the Tooltip's content - */ - content?: string; -} + /** returns the Tooltip's content + */ + content?: string; + } -export interface ClickEventArgs { + export interface ClickEventArgs { - /** its value is set as true,if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** its value is set as true,if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the Tooltip model - */ - model?: any; + /** returns the Tooltip model + */ + model?: any; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the event object - */ - event?: any; -} + /** returns the event object + */ + event?: any; + } -export interface CloseEventArgs { + export interface CloseEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the Tooltip model - */ - model?: any; + /** returns the Tooltip model + */ + model?: any; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the Tooltip's content - */ - content?: string; -} + /** returns the Tooltip's content + */ + content?: string; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the Tooltip model - */ - model?: any; + /** returns the Tooltip model + */ + model?: any; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** its value is set as true,if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** its value is set as true,if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the Tooltip model - */ - model?: any; + /** returns the Tooltip model + */ + model?: any; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface HoverEventArgs { + export interface HoverEventArgs { - /** its value is set as true,if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** its value is set as true,if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the Tooltip model - */ - model?: any; + /** returns the Tooltip model + */ + model?: any; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the event object - */ - event?: any; -} + /** returns the event object + */ + event?: any; + } -export interface OpenEventArgs { + export interface OpenEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the Tooltip model - */ - model?: any; + /** returns the Tooltip model + */ + model?: any; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the Tooltip's content - */ - content?: string; -} + /** returns the Tooltip's content + */ + content?: string; + } -export interface TrackingEventArgs { + export interface TrackingEventArgs { - /** its value is set as true,if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** its value is set as true,if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the Tooltip model - */ - model?: any; + /** returns the Tooltip model + */ + model?: any; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the event object - */ - event?: any; -} + /** returns the event object + */ + event?: any; + } -export interface Animation { + export interface Animation { - /** Determines the type of effect. - * @Default {ej.Tooltip.Effect.None} - */ - effect?: ej.Tooltip.effect|string; + /** Determines the type of effect. + * @Default {ej.Tooltip.Effect.None} + */ + effect?: ej.Tooltip.effect | string; - /** Sets the animation speed in milliseconds. - * @Default {4000} - */ - speed?: number; -} + /** Sets the animation speed in milliseconds. + * @Default {4000} + */ + speed?: number; + } -export interface PositionTarget { + export interface PositionTarget { - /** Sets the Tooltip position against target based on horizontal(x) value. - * @Default {center} - */ - horizontal?: string|number; + /** Sets the Tooltip position against target based on horizontal(x) value. + * @Default {center} + */ + horizontal?: string | number; - /** Sets the Tooltip position against target based on vertical(y) value. - * @Default {top} - */ - vertical?: string|number; -} + /** Sets the Tooltip position against target based on vertical(y) value. + * @Default {top} + */ + vertical?: string | number; + } -export interface PositionStem { + export interface PositionStem { - /** Sets the arrow position again popup based on horizontal(x) value - * @Default {center} - */ - horizontal?: string; + /** Sets the arrow position again popup based on horizontal(x) value + * @Default {center} + */ + horizontal?: string; - /** Sets the arrow position again popup based on vertical(y) value - * @Default {bottom} - */ - vertical?: string; -} + /** Sets the arrow position again popup based on vertical(y) value + * @Default {bottom} + */ + vertical?: string; + } -export interface Position { + export interface Position { - /** Sets the Tooltip position against target. - */ - target?: PositionTarget; + /** Sets the Tooltip position against target. + */ + target?: PositionTarget; - /** Sets the arrow position again popup. - */ - stem?: PositionStem; -} + /** Sets the arrow position again popup. + */ + stem?: PositionStem; + } -enum effect { + enum effect { - ///No animation takes place when showing/hiding the Tooltip - None, + ///No animation takes place when showing/hiding the Tooltip + None, - ///Sliding effect takes place when showing/hiding the Tooltip - Slide, + ///Sliding effect takes place when showing/hiding the Tooltip + Slide, - ///Fade the Tooltip in and out of visibility. - Fade -} + ///Fade the Tooltip in and out of visibility. + Fade + } -enum Associate { + enum Associate { - ///Sets the position related to target element. - Target, + ///Sets the position related to target element. + Target, - ///Sets the position related to mouse. - MouseFollow, + ///Sets the position related to mouse. + MouseFollow, - ///Sets the position related to mouse, first entry to the target element. - MouseEnter, + ///Sets the position related to mouse, first entry to the target element. + MouseEnter, - ///Sets the position related to (x,y) co-ordinates. - Axis, + ///Sets the position related to (x,y) co-ordinates. + Axis, - ///Sets the position related to browser window. - Window -} + ///Sets the position related to browser window. + Window + } -enum CloseMode { + enum CloseMode { - ///Enables close button in Tooltip. - Sticky, + ///Enables close button in Tooltip. + Sticky, - ///Sets the delay for Tooltip close - Auto, + ///Sets the delay for Tooltip close + Auto, - ///The Tooltip will be display normally. - None -} + ///The Tooltip will be display normally. + None + } -enum Collision { + enum Collision { - ///Flips the Tooltip to the opposite side of the target, if collision is occurs. - Flip, + ///Flips the Tooltip to the opposite side of the target, if collision is occurs. + Flip, - ///Shift the Tooltip popup away from the edge of the window(collision side) that means adjacent position. - Fit, + ///Shift the Tooltip popup away from the edge of the window(collision side) that means adjacent position. + Fit, - ///Ensure as much of the element is visible as possible to showcase. - FlipFit, + ///Ensure as much of the element is visible as possible to showcase. + FlipFit, - ///No collision detection is take place - None -} + ///No collision detection is take place + None + } -enum Trigger { + enum Trigger { - ///The Tooltip to be shown when the target element is clicked. - Click, + ///The Tooltip to be shown when the target element is clicked. + Click, - ///Enables the Tooltip when hover on the target element. - Hover, + ///Enables the Tooltip when hover on the target element. + Hover, - ///Enables the Tooltip when focus is set to target element. - Focus -} + ///Enables the Tooltip when focus is set to target element. + Focus + } -} + } -class Editor extends ej.Widget { - static fn: Editor; - constructor(element: JQuery | Element, options?: Editor.Model); - static Locale: any; - model: Editor.Model; - defaults: Editor.Model; + class Editor extends ej.Widget { + static fn: Editor; + constructor(element: JQuery | Element, options?: Editor.Model); + static Locale: any; + model: Editor.Model; + defaults: Editor.Model; - /** destroy the editor widgets all events are unbind automatically and bring the control to pre-init state. - * @returns {void} - */ - destroy(): void; + /** destroy the editor widgets all events are unbind automatically and bring the control to pre-init state. + * @returns {void} + */ + destroy(): void; - /** To disable the corresponding Editors - * @returns {void} - */ - disable(): void; + /** To disable the corresponding Editors + * @returns {void} + */ + disable(): void; - /** To enable the corresponding Editors - * @returns {void} - */ - enable(): void; + /** To enable the corresponding Editors + * @returns {void} + */ + enable(): void; - /** To get value from corresponding Editors - * @returns {number} - */ - getValue(): number; -} + /** To get value from corresponding Editors + * @returns {number} + */ + getValue(): number; + } - class NumericTextbox extends Editor { -} + class NumericTextbox extends Editor { + } - class CurrencyTextbox extends Editor { -} + class CurrencyTextbox extends Editor { + } - class PercentageTextbox extends Editor { -} -export namespace Editor { + class PercentageTextbox extends Editor { + } + export namespace Editor { -export interface Model { + export interface Model { - /** Specifies the currency symbol of currency textbox, used when the user wants to overwrite the currency symbol commonly instead of the current culture symbol. - * @Default {Based on the culture} - */ - currencySymbol?: string; + /** Specifies the currency symbol of currency textbox, used when the user wants to overwrite the currency symbol commonly instead of the current culture symbol. + * @Default {Based on the culture} + */ + currencySymbol?: string; - /** Sets the root CSS class for Editors which allow us to customize the appearance. - */ - cssClass?: string; + /** Sets the root CSS class for Editors which allow us to customize the appearance. + */ + cssClass?: string; - /** Specifies the number of digits that should be allowed after the decimal point. - * @Default {0} - */ - decimalPlaces?: number; - - /** Specifies the editor control state. - * @Default {true} - */ - enabled?: boolean; - - /** Specify the enablePersistence to editor to save current editor control value to browser cookies for state maintenance. - * @Default {false} - */ - enablePersistence?: boolean; - - /** Specifies the Right to Left Direction to editor. - * @Default {false} - */ - enableRTL?: boolean; - - /** When enableStrictMode true it allows the value outside of the range also but it highlights the textbox with error class,otherwise it internally changed to the correct value. - * @Default {false} - */ - enableStrictMode?: boolean; - - /** Specifies the number of digits in each group to the editor. - * @Default {Based on the culture.} - */ - groupSize?: string; - - /** It provides the options to get the customized character to separate the digits. If not set, the separator defined by the current culture. - * @Default {Based on the culture} - */ - groupSeparator?: string; - - /** Specifies the height of the editor. - * @Default {30} - */ - height?: string; - - /** It allows to define the characteristics of the Editors control. It will helps to extend the capability of an HTML element. - * @Default {{}} - */ - htmlAttributes?: any; - - /** The Editor value increment or decrement based an incrementStep value. - * @Default {1} - */ - incrementStep?: number; - - /** Defines the localization culture for editor. - * @Default {en-US} - */ - locale?: string; - - /** Specifies the maximum value of the editor. - * @Default {Number.MAX_VALUE} - */ - maxValue?: number; - - /** Specifies the minimum value of the editor. - * @Default {-(Number.MAX_VALUE) and 0 for Currency Textbox.} - */ - minValue?: number; - - /** Specifies the name of the editor. - * @Default {Sets id as name if it is null.} - */ - name?: string; - - /** Specifies the pattern for formatting positive values in editor.We have maintained some standard to define the negative pattern. - * you have to specify 'n' to place the digit in your pattern.ejTextbox allows you to define a currency or percent symbol where you want to place it. - * @Default {Based on the culture} - */ - negativePattern?: string; - - /** Specifies the pattern for formatting positive values in editor.We have maintained some standard to define the positive pattern. - * you have to specify 'n' to place the digit in your pattern.ejTextbox allows you to define a currency or percent symbol where you want to place it. - * @Default {Based on the culture} - */ - positivePattern?: string; - - /** Toggles the readonly state of the editor. When the Editor is readonly it doesn't allow user interactions. - * @Default {false} - */ - readOnly?: boolean; - - /** Specifies to Change the sharped edges into rounded corner for the Editor. - * @Default {false} - */ - showRoundedCorner?: boolean; - - /** Specifies whether the up and down spin buttons should be displayed in editor. - * @Default {true} - */ - showSpinButton?: boolean; - - /** Enables decimal separator position validation on type . - * @Default {false} - */ - validateOnType?: boolean; - - /** Set the jQuery validation error message in editor. - * @Default {null} - */ - validationMessage?: any; - - /** Set the jQuery validation rules to the editor. - * @Default {null} - */ - validationRules?: any; - - /** Specifies the value of the editor. - * @Default {null} - */ - value?: number|string; - - /** Specifies the watermark text to editor. - * @Default {Based on the culture.} - */ - watermarkText?: string; - - /** Specifies the width of the editor. - * @Default {143} - */ - width?: string; - - /** Fires after Editor control value is changed. */ - change?(e: ChangeEventArgs): void; - - /** Fires after Editor control is created. */ - create?(e: CreateEventArgs): void; - - /** Fires when the Editor is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; - - /** Fires after Editor control is focused. */ - focusIn?(e: FocusInEventArgs): void; - - /** Fires after Editor control is loss the focus. */ - focusOut?(e: FocusOutEventArgs): void; -} - -export interface ChangeEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the corresponding editor model. - */ - model?: ej.Editor.Model; - - /** returns the name of the event. - */ - type?: string; - - /** returns the corresponding editor control value. - */ - value?: number; - - /** returns true when the value changed by user interaction otherwise returns false - */ - isInteraction?: boolean; -} - -export interface CreateEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the editor model - */ - model?: ej.Editor.Model; - - /** returns the name of the event - */ - type?: string; -} - -export interface DestroyEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the editor model - */ - model?: ej.Editor.Model; - - /** returns the name of the event - */ - type?: string; -} - -export interface FocusInEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the corresponding editor model. - */ - model?: ej.Editor.Model; - - /** returns the name of the event. - */ - type?: string; - - /** returns the corresponding editor control value. - */ - value?: number; -} - -export interface FocusOutEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the corresponding editor model. - */ - model?: ej.Editor.Model; - - /** returns the name of the event. - */ - type?: string; - - /** returns the corresponding editor control value. - */ - value?: number; -} -} - -class ListView extends ej.Widget { - static fn: ListView; - constructor(element: JQuery | Element, options?: ListView.Model); - static Locale: any; - model: ListView.Model; - defaults: ListView.Model; - - /** To add item in the given index. If you have enabled grouping in ListView then you need to pass the corresponding group list title to add item in it. - * @param {any} Specifies the item to be added in ListView - * @param {number} Specifies the index where item to be added - * @param {string} optionalThis is an optional parameter. You must pass the group list title here if grouping is enabled in the ListView - * @returns {void} - */ - addItem(item: any, index: number, groupid: string): void; - - /** To check all the items. - * @returns {void} - */ - checkAllItem(): void; - - /** To check item in the given index. - * @param {number} Specifies the index of the item to be checked - * @returns {void} - */ - checkItem(index: number): void; - - /** To clear all the list item in the control before updating with new datasource. - * @returns {void} - */ - clear(): void; - - /** To make the item in the given index to be default state. - * @param {number} Specifies the index to make the item to be in default state. - * @returns {void} - */ - deActive(index: number): void; - - /** To disable item in the given index. - * @param {number} Specifies the index value to be disabled. - * @returns {void} - */ - disableItem(index: number): void; - - /** To enable item in the given index. - * @param {number} Specifies the index value to be enabled. - * @returns {void} - */ - enableItem(index: number): void; - - /** To get the active item. - * @returns {HTMLElement} - */ - getActiveItem(): HTMLElement; - - /** To get the text of the active item. - * @returns {string} - */ - getActiveItemText(): string; - - /** To get all the checked items. - * @returns {Array} - */ - getCheckedItems(): any[]; - - /** To get the text of all the checked items. - * @returns {Array} - */ - getCheckedItemsText(): any[]; - - /** To get the total item count. - * @returns {number} - */ - getItemsCount(): number; - - /** To get the text of the item in the given index. - * @param {string|number} Specifies the index value to get the text value. - * @returns {string} - */ - getItemText(index: string|number): string; - - /** To check whether the item in the given index has child item. - * @param {number} Specifies the index value to check the item has child or not. - * @returns {boolean} - */ - hasChild(index: number): boolean; - - /** To hide the list. - * @returns {void} - */ - hide(): void; - - /** To hide item in the given index. - * @param {number} Specifies the index value to hide the item. - * @returns {void} - */ - hideItem(index: number): void; - - /** To check whether item in the given index is checked. - * @returns {boolean} - */ - isChecked(): boolean; - - /** To load the AJAX content while selecting the item. - * @param {string} Specifies the item to load the AJAX content. - * @returns {void} - */ - loadAjaxContent(item: string): void; - - /** To remove the check mark either for specific item in the given index or for all items. - * @param {number} Specifies the index value to remove the checkbox. - * @returns {void} - */ - removeCheckMark(index: number): void; - - /** To remove item in the given index. - * @param {number} Specifies the index value to remove the item. - * @returns {void} - */ - removeItem(index: number): void; - - /** To select item in the given index. - * @param {number} Specifies the index value to select the item. - * @returns {void} - */ - selectItem(index: number): void; - - /** To make the item in the given index to be active state. - * @param {number} Specifies the index value to make the item in active state. - * @returns {void} - */ - setActive(index: number): void; - - /** To show the list. - * @returns {void} - */ - show(): void; - - /** To show item in the given index. - * @param {number} Specifies the index value to show the hided item. - * @returns {void} - */ - showItem(index: number): void; - - /** To uncheck all the items. - * @returns {void} - */ - unCheckAllItem(): void; - - /** To uncheck item in the given index. - * @param {number} Specifies the index value to uncheck the item. - * @returns {void} - */ - unCheckItem(index: number): void; -} -export namespace ListView { - -export interface Model { - - /** Specifies the ajaxSettings option to load the items to the ListView control. - * @Default {null} - */ - ajaxSettings?: AjaxSettings; - - /** Set the index values to be selected on initial loading. This works only when enableCheckMark is set true. - * @Default {[]} - */ - checkedIndices?: any[]; - - /** Sets the root class for ListView theme. This cssClass API helps to use custom skinning option for ListView control. By defining the root class using this API, - * we need to include this root class in CSS. - */ - cssClass?: string; - - /** Contains the list of data for generating the ListView items. - * @Default {[]} - */ - dataSource?: any[]; - - /** Specifies whether to load AJAX content while selecting item. - * @Default {false} - */ - enableAjax?: boolean; - - /** Specifies whether to enable caching the content. - * @Default {false} - */ - enableCache?: boolean; - - /** Specifies whether to enable check mark for the item. - * @Default {false} - */ - enableCheckMark?: boolean; - - /** Specifies whether to enable the filtering feature to filter the item. - * @Default {false} - */ - enableFiltering?: boolean; - - /** Specifies whether to group the list item. - * @Default {false} - */ - enableGroupList?: boolean; - - /** Specifies to maintain the current model value to browser cookies for state maintenance. While refresh the page, the model value will get apply to the control from browser cookies. - * @Default {false} - */ - enablePersistence?: boolean; - - /** Specifies the field settings to map the datasource. - */ - fieldSettings?: any; - - /** Contains the array of items to be added in ListView. - * @Default {[]} - */ - items?: any[]; - - /** Specifies the text of the back button in the header. - * @Default {null} - */ - headerBackButtonText?: string; - - /** Specifies the title of the header. - * @Default {Title} - */ - headerTitle?: string; - - /** Specifies the height. - * @Default {null} - */ - height?: string|number; - - /** Set the localization culture for ListView Widget. - */ - locale?: string; - - /** Specifies whether to retain the selection of the item. - * @Default {false} - */ - persistSelection?: boolean; - - /** Specifies whether to prevent the selection of the item. - * @Default {false} - */ - preventSelection?: boolean; - - /** Specifies the query to execute with the datasource. - * @Default {null} - */ - query?: any; - - /** Specifies whether need to render the control with the template contents. - * @Default {false} - */ - renderTemplate?: boolean; - - /** Specifies the index of item which need to be in selected state initially while loading. - * @Default {0} - */ - selectedItemIndex?: number; - - /** Specifies whether to show the header. - * @Default {true} - */ - showHeader?: boolean; - - /** Specifies whether to show the back button header. - * @Default {false} - */ - showHeaderBackButton?: boolean; - - /** Specifies ID of the element contains template contents. - * @Default {null} - */ - templateId?: string; - - /** Specifies the width. - * @Default {null} - */ - width?: string|number; - - /** Event triggers before the AJAX request happens. */ - ajaxBeforeLoad?(e: AjaxBeforeLoadEventArgs): void; - - /** Event triggers after the AJAX content loaded completely. */ - ajaxComplete?(e: AjaxCompleteEventArgs): void; - - /** Event triggers when the AJAX request failed. */ - ajaxError?(e: AjaxErrorEventArgs): void; - - /** Event triggers after the AJAX content loaded successfully. */ - ajaxSuccess?(e: AjaxSuccessEventArgs): void; + /** Specifies the number of digits that should be allowed after the decimal point. + * @Default {0} + */ + decimalPlaces?: number; + + /** Specifies the editor control state. + * @Default {true} + */ + enabled?: boolean; + + /** Specify the enablePersistence to editor to save current editor control value to browser cookies for state maintenance. + * @Default {false} + */ + enablePersistence?: boolean; + + /** Specifies the Right to Left Direction to editor. + * @Default {false} + */ + enableRTL?: boolean; + + /** When enableStrictMode true it allows the value outside of the range also but it highlights the textbox with error class,otherwise it internally changed to the correct value. + * @Default {false} + */ + enableStrictMode?: boolean; + + /** Specifies the number of digits in each group to the editor. + * @Default {Based on the culture.} + */ + groupSize?: string; + + /** It provides the options to get the customized character to separate the digits. If not set, the separator defined by the current culture. + * @Default {Based on the culture} + */ + groupSeparator?: string; + + /** Specifies the height of the editor. + * @Default {30} + */ + height?: string; + + /** It allows to define the characteristics of the Editors control. It will helps to extend the capability of an HTML element. + * @Default {{}} + */ + htmlAttributes?: any; + + /** The Editor value increment or decrement based an incrementStep value. + * @Default {1} + */ + incrementStep?: number; + + /** Defines the localization culture for editor. + * @Default {en-US} + */ + locale?: string; + + /** Specifies the maximum value of the editor. + * @Default {Number.MAX_VALUE} + */ + maxValue?: number; + + /** Specifies the minimum value of the editor. + * @Default {-(Number.MAX_VALUE) and 0 for Currency Textbox.} + */ + minValue?: number; + + /** Specifies the name of the editor. + * @Default {Sets id as name if it is null.} + */ + name?: string; + + /** Specifies the pattern for formatting positive values in editor.We have maintained some standard to define the negative pattern. + * you have to specify 'n' to place the digit in your pattern.ejTextbox allows you to define a currency or percent symbol where you want to place it. + * @Default {Based on the culture} + */ + negativePattern?: string; + + /** Specifies the pattern for formatting positive values in editor.We have maintained some standard to define the positive pattern. + * you have to specify 'n' to place the digit in your pattern.ejTextbox allows you to define a currency or percent symbol where you want to place it. + * @Default {Based on the culture} + */ + positivePattern?: string; + + /** Toggles the readonly state of the editor. When the Editor is readonly it doesn't allow user interactions. + * @Default {false} + */ + readOnly?: boolean; + + /** Specifies to Change the sharped edges into rounded corner for the Editor. + * @Default {false} + */ + showRoundedCorner?: boolean; + + /** Specifies whether the up and down spin buttons should be displayed in editor. + * @Default {true} + */ + showSpinButton?: boolean; + + /** Enables decimal separator position validation on type . + * @Default {false} + */ + validateOnType?: boolean; + + /** Set the jQuery validation error message in editor. + * @Default {null} + */ + validationMessage?: any; + + /** Set the jQuery validation rules to the editor. + * @Default {null} + */ + validationRules?: any; + + /** Specifies the value of the editor. + * @Default {null} + */ + value?: number | string; + + /** Specifies the watermark text to editor. + * @Default {Based on the culture.} + */ + watermarkText?: string; + + /** Specifies the width of the editor. + * @Default {143} + */ + width?: string; + + /** Fires after Editor control value is changed. */ + change?(e: ChangeEventArgs): void; + + /** Fires after Editor control is created. */ + create?(e: CreateEventArgs): void; + + /** Fires when the Editor is destroyed successfully. */ + destroy?(e: DestroyEventArgs): void; + + /** Fires after Editor control is focused. */ + focusIn?(e: FocusInEventArgs): void; + + /** Fires after Editor control is loss the focus. */ + focusOut?(e: FocusOutEventArgs): void; + } + + export interface ChangeEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the corresponding editor model. + */ + model?: ej.Editor.Model; + + /** returns the name of the event. + */ + type?: string; + + /** returns the corresponding editor control value. + */ + value?: number; + + /** returns true when the value changed by user interaction otherwise returns false + */ + isInteraction?: boolean; + } + + export interface CreateEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the editor model + */ + model?: ej.Editor.Model; + + /** returns the name of the event + */ + type?: string; + } + + export interface DestroyEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the editor model + */ + model?: ej.Editor.Model; + + /** returns the name of the event + */ + type?: string; + } + + export interface FocusInEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the corresponding editor model. + */ + model?: ej.Editor.Model; + + /** returns the name of the event. + */ + type?: string; + + /** returns the corresponding editor control value. + */ + value?: number; + } + + export interface FocusOutEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the corresponding editor model. + */ + model?: ej.Editor.Model; + + /** returns the name of the event. + */ + type?: string; + + /** returns the corresponding editor control value. + */ + value?: number; + } + } + + class ListView extends ej.Widget { + static fn: ListView; + constructor(element: JQuery | Element, options?: ListView.Model); + static Locale: any; + model: ListView.Model; + defaults: ListView.Model; + + /** To add item in the given index. If you have enabled grouping in ListView then you need to pass the corresponding group list title to add item in it. + * @param {any} Specifies the item to be added in ListView + * @param {number} Specifies the index where item to be added + * @param {string} optionalThis is an optional parameter. You must pass the group list title here if grouping is enabled in the ListView + * @returns {void} + */ + addItem(item: any, index: number, groupid: string): void; + + /** To check all the items. + * @returns {void} + */ + checkAllItem(): void; + + /** To check item in the given index. + * @param {number} Specifies the index of the item to be checked + * @returns {void} + */ + checkItem(index: number): void; + + /** To clear all the list item in the control before updating with new datasource. + * @returns {void} + */ + clear(): void; + + /** To make the item in the given index to be default state. + * @param {number} Specifies the index to make the item to be in default state. + * @returns {void} + */ + deActive(index: number): void; + + /** To disable item in the given index. + * @param {number} Specifies the index value to be disabled. + * @returns {void} + */ + disableItem(index: number): void; + + /** To enable item in the given index. + * @param {number} Specifies the index value to be enabled. + * @returns {void} + */ + enableItem(index: number): void; + + /** To get the active item. + * @returns {HTMLElement} + */ + getActiveItem(): HTMLElement; + + /** To get the text of the active item. + * @returns {string} + */ + getActiveItemText(): string; + + /** To get all the checked items. + * @returns {Array} + */ + getCheckedItems(): any[]; + + /** To get the text of all the checked items. + * @returns {Array} + */ + getCheckedItemsText(): any[]; + + /** To get the total item count. + * @returns {number} + */ + getItemsCount(): number; + + /** To get the text of the item in the given index. + * @param {string|number} Specifies the index value to get the text value. + * @returns {string} + */ + getItemText(index: string | number): string; + + /** To check whether the item in the given index has child item. + * @param {number} Specifies the index value to check the item has child or not. + * @returns {boolean} + */ + hasChild(index: number): boolean; + + /** To hide the list. + * @returns {void} + */ + hide(): void; + + /** To hide item in the given index. + * @param {number} Specifies the index value to hide the item. + * @returns {void} + */ + hideItem(index: number): void; + + /** To check whether item in the given index is checked. + * @returns {boolean} + */ + isChecked(): boolean; + + /** To load the AJAX content while selecting the item. + * @param {string} Specifies the item to load the AJAX content. + * @returns {void} + */ + loadAjaxContent(item: string): void; + + /** To remove the check mark either for specific item in the given index or for all items. + * @param {number} Specifies the index value to remove the checkbox. + * @returns {void} + */ + removeCheckMark(index: number): void; + + /** To remove item in the given index. + * @param {number} Specifies the index value to remove the item. + * @returns {void} + */ + removeItem(index: number): void; + + /** To select item in the given index. + * @param {number} Specifies the index value to select the item. + * @returns {void} + */ + selectItem(index: number): void; + + /** To make the item in the given index to be active state. + * @param {number} Specifies the index value to make the item in active state. + * @returns {void} + */ + setActive(index: number): void; + + /** To show the list. + * @returns {void} + */ + show(): void; + + /** To show item in the given index. + * @param {number} Specifies the index value to show the hided item. + * @returns {void} + */ + showItem(index: number): void; + + /** To uncheck all the items. + * @returns {void} + */ + unCheckAllItem(): void; + + /** To uncheck item in the given index. + * @param {number} Specifies the index value to uncheck the item. + * @returns {void} + */ + unCheckItem(index: number): void; + } + export namespace ListView { + + export interface Model { + + /** Specifies the ajaxSettings option to load the items to the ListView control. + * @Default {null} + */ + ajaxSettings?: AjaxSettings; + + /** Set the index values to be selected on initial loading. This works only when enableCheckMark is set true. + * @Default {[]} + */ + checkedIndices?: any[]; + + /** Sets the root class for ListView theme. This cssClass API helps to use custom skinning option for ListView control. By defining the root class using this API, + * we need to include this root class in CSS. + */ + cssClass?: string; + + /** Contains the list of data for generating the ListView items. + * @Default {[]} + */ + dataSource?: any[]; + + /** Specifies whether to load AJAX content while selecting item. + * @Default {false} + */ + enableAjax?: boolean; + + /** Specifies whether to enable caching the content. + * @Default {false} + */ + enableCache?: boolean; + + /** Specifies whether to enable check mark for the item. + * @Default {false} + */ + enableCheckMark?: boolean; + + /** Specifies whether to enable the filtering feature to filter the item. + * @Default {false} + */ + enableFiltering?: boolean; + + /** Specifies whether to group the list item. + * @Default {false} + */ + enableGroupList?: boolean; + + /** Specifies to maintain the current model value to browser cookies for state maintenance. While refresh the page, the model value will get apply to the control from browser cookies. + * @Default {false} + */ + enablePersistence?: boolean; + + /** Specifies the field settings to map the datasource. + */ + fieldSettings?: any; + + /** Contains the array of items to be added in ListView. + * @Default {[]} + */ + items?: any[]; + + /** Specifies the text of the back button in the header. + * @Default {null} + */ + headerBackButtonText?: string; + + /** Specifies the title of the header. + * @Default {Title} + */ + headerTitle?: string; + + /** Specifies the height. + * @Default {null} + */ + height?: string | number; + + /** Set the localization culture for ListView Widget. + */ + locale?: string; + + /** Specifies whether to retain the selection of the item. + * @Default {false} + */ + persistSelection?: boolean; + + /** Specifies whether to prevent the selection of the item. + * @Default {false} + */ + preventSelection?: boolean; + + /** Specifies the query to execute with the datasource. + * @Default {null} + */ + query?: any; + + /** Specifies whether need to render the control with the template contents. + * @Default {false} + */ + renderTemplate?: boolean; + + /** Specifies the index of item which need to be in selected state initially while loading. + * @Default {0} + */ + selectedItemIndex?: number; + + /** Specifies whether to show the header. + * @Default {true} + */ + showHeader?: boolean; + + /** Specifies whether to show the back button header. + * @Default {false} + */ + showHeaderBackButton?: boolean; + + /** Specifies ID of the element contains template contents. + * @Default {null} + */ + templateId?: string; + + /** Specifies the width. + * @Default {null} + */ + width?: string | number; + + /** Event triggers before the AJAX request happens. */ + ajaxBeforeLoad?(e: AjaxBeforeLoadEventArgs): void; + + /** Event triggers after the AJAX content loaded completely. */ + ajaxComplete?(e: AjaxCompleteEventArgs): void; + + /** Event triggers when the AJAX request failed. */ + ajaxError?(e: AjaxErrorEventArgs): void; + + /** Event triggers after the AJAX content loaded successfully. */ + ajaxSuccess?(e: AjaxSuccessEventArgs): void; - /** Event triggers before the items loaded. */ - load?(e: LoadEventArgs): void; - - /** Event triggers after the items loaded. */ - loadComplete?(e: LoadCompleteEventArgs): void; - - /** Event triggers when mouse down happens on the item. */ - mouseDown?(e: MouseDownEventArgs): void; + /** Event triggers before the items loaded. */ + load?(e: LoadEventArgs): void; + + /** Event triggers after the items loaded. */ + loadComplete?(e: LoadCompleteEventArgs): void; + + /** Event triggers when mouse down happens on the item. */ + mouseDown?(e: MouseDownEventArgs): void; - /** Event triggers when mouse up happens on the item. */ - mouseUp?(e: MouseUpEventArgs): void; -} + /** Event triggers when mouse up happens on the item. */ + mouseUp?(e: MouseUpEventArgs): void; + } -export interface AjaxBeforeLoadEventArgs { + export interface AjaxBeforeLoadEventArgs { - /** returns true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns true if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the model value of the control. - */ - model?: ej.ListView.Model; + /** returns the model value of the control. + */ + model?: ej.ListView.Model; - /** returns the AJAX settings. - */ - ajaxData?: any; -} + /** returns the AJAX settings. + */ + ajaxData?: any; + } -export interface AjaxCompleteEventArgs { + export interface AjaxCompleteEventArgs { - /** returns true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns true if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the model value of the control. - */ - model?: ej.ListView.Model; -} + /** returns the model value of the control. + */ + model?: ej.ListView.Model; + } -export interface AjaxErrorEventArgs { + export interface AjaxErrorEventArgs { - /** returns true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns true if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the model value of the control. - */ - model?: ej.ListView.Model; + /** returns the model value of the control. + */ + model?: ej.ListView.Model; - /** returns the error thrown in the AJAX post. - */ - errorThrown?: any; + /** returns the error thrown in the AJAX post. + */ + errorThrown?: any; - /** returns the status. - */ - textStatus?: any; + /** returns the status. + */ + textStatus?: any; - /** returns the current list item. - */ - item?: any; + /** returns the current list item. + */ + item?: any; - /** returns the current item text. - */ - text?: string; + /** returns the current item text. + */ + text?: string; - /** returns the current item index. - */ - index?: number; -} + /** returns the current item index. + */ + index?: number; + } -export interface AjaxSuccessEventArgs { + export interface AjaxSuccessEventArgs { - /** returns true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns true if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the model value of the control. - */ - model?: ej.ListView.Model; + /** returns the model value of the control. + */ + model?: ej.ListView.Model; - /** returns the AJAX current content. - */ - content?: string; + /** returns the AJAX current content. + */ + content?: string; - /** returns the current list item. - */ - item?: any; + /** returns the current list item. + */ + item?: any; - /** returns the current item text. - */ - text?: string; + /** returns the current item text. + */ + text?: string; - /** returns the current item index. - */ - index?: number; + /** returns the current item index. + */ + index?: number; - /** returns the current URL of the AJAX post. - */ - URL?: string; -} + /** returns the current URL of the AJAX post. + */ + URL?: string; + } -export interface LoadEventArgs { + export interface LoadEventArgs { - /** returns true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns true if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the model value of the control. - */ - model?: ej.ListView.Model; -} + /** returns the model value of the control. + */ + model?: ej.ListView.Model; + } -export interface LoadCompleteEventArgs { + export interface LoadCompleteEventArgs { - /** returns true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns true if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the model value of the control. - */ - model?: ej.ListView.Model; -} + /** returns the model value of the control. + */ + model?: ej.ListView.Model; + } -export interface MouseDownEventArgs { + export interface MouseDownEventArgs { - /** returns true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns true if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the model value of the control. - */ - model?: ej.ListView.Model; + /** returns the model value of the control. + */ + model?: ej.ListView.Model; - /** If the child element exist return true; otherwise, false. - */ - hasChild?: boolean; + /** If the child element exist return true; otherwise, false. + */ + hasChild?: boolean; - /** returns the current list item. - */ - item?: string; + /** returns the current list item. + */ + item?: string; - /** returns the current text of item. - */ - text?: string; + /** returns the current text of item. + */ + text?: string; - /** returns the current Index of the item. - */ - index?: number; + /** returns the current Index of the item. + */ + index?: number; - /** If checked return true; otherwise, false. - */ - isChecked?: boolean; + /** If checked return true; otherwise, false. + */ + isChecked?: boolean; - /** returns the list of checked items. - */ - checkedItems?: number; - - /** returns the current checked item text. - */ - checkedItemsText?: string; -} - -export interface MouseUpEventArgs { - - /** returns true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the name of the event. - */ - type?: string; - - /** returns the model value of the control. - */ - model?: ej.ListView.Model; - - /** If the child element exist return true; otherwise, false. - */ - hasChild?: boolean; - - /** returns the current list item. - */ - item?: string; - - /** returns the current text of item. - */ - text?: string; - - /** returns the current Index of the item. - */ - index?: number; - - /** If checked return true; otherwise, false. - */ - isChecked?: boolean; - - /** returns the list of checked items. - */ - checkedItems?: number; - - /** returns the current checked item text. - */ - checkedItemsText?: string; -} - -export interface AjaxSettings { - - /** It specifies, whether to enable or disable asynchronous request. - */ - async?: boolean; - - /** It specifies the page will be cached in the web browser. - */ - cache?: boolean; - - /** It specifies the type of data is send in the query string. - */ - contentType?: string; - - /** It specifies the data as an object, will be passed in the query string. - */ - data?: any; - - /** It specifies the type of data that you're expecting back from the response. - */ - dataType?: string; - - /** It specifies the HTTP request type. - */ - type?: string; -} -} - -class MaskEdit extends ej.Widget { - static fn: MaskEdit; - constructor(element: JQuery | Element, options?: MaskEdit.Model); - static Locale: any; - model: MaskEdit.Model; - defaults: MaskEdit.Model; - - /** To clear the text in mask edit textbox control. - * @returns {void} - */ - clear(): void; - - /** To disable the mask edit textbox control. - * @returns {void} - */ - disable(): void; - - /** To enable the mask edit textbox control. - * @returns {void} - */ - enable(): void; - - /** To obtained the pure value of the text value, removes all the symbols in mask edit textbox control. - * @returns {string} - */ - get_StrippedValue(): string; - - /** To obtained the textbox value as such that, Just replace all '_' to ' '(space) in mask edit textbox control. - * @returns {string} - */ - get_UnstrippedValue(): string; -} -export namespace MaskEdit { - -export interface Model { - - /** Specify the cssClass to achieve custom theme. - * @Default {null} - */ - cssClass?: string; - - /** Specify the custom character allowed to entered in mask edit textbox control. - * @Default {null} - */ - customCharacter?: string; - - /** Specify the state of the mask edit textbox control. - * @Default {true} - */ - enabled?: boolean; - - /** Specify the enablePersistence to mask edit textbox to save current model value to browser cookies for state maintains. - */ - enablePersistence?: boolean; - - /** Specifies the height for the mask edit textbox control. - * @Default {28 px} - */ - height?: string; - - /** Specifies whether hide the prompt characters with spaces on blur. Prompt chars will be shown again on focus the textbox. - * @Default {false} - */ - hidePromptOnLeave?: boolean; - - /** Specifies the list of HTML attributes to be added to mask edit textbox. - * @Default {{}} - */ - htmlAttributes?: any; - - /** Specify the inputMode for mask edit textbox control. See InputMode - * @Default {ej.InputMode.Text} - */ - inputMode?: ej.InputMode|string; - - /** Specifies the input mask. - * @Default {null} - */ - maskFormat?: string; - - /** Specifies the name attribute value for the mask edit textbox. - * @Default {null} - */ - name?: string; - - /** Toggles the readonly state of the mask edit textbox. When the mask edit textbox is readonly, it doesn't allow your input. - * @Default {false} - */ - readOnly?: boolean; - - /** Specifies whether the error will show until correct value entered in the mask edit textbox control. - * @Default {false} - */ - showError?: boolean; - - /** when showPromptChar is true, the hide the prompt characters are shown in focus of the control and hides in focus out of the control. - * @Default {true} - */ - showPromptChar?: boolean; - - /** MaskEdit input is displayed in rounded corner style when this property is set to true. - * @Default {false} - */ - showRoundedCorner?: boolean; - - /** Specify the text alignment for mask edit textbox control.See TextAlign - * @Default {left} - */ - textAlign?: ej.TextAlign|string; - - /** Sets the jQuery validation error message in mask edit. This property works when the widget is present inside the form. Include jquery.validate.min.js plugin additionally. - * @Default {null} - */ - validationMessage?: any; - - /** Sets the jQuery validation rules to the MaskEdit. This property works when the widget is present inside the form. Include jquery.validate.min.js plugin additionally. - * @Default {null} - */ - validationRules?: any; - - /** Specifies the value for the mask edit textbox control. - * @Default {null} - */ - value?: string; - - /** Specifies the water mark text to be displayed in input text. - * @Default {null} - */ - watermarkText?: string; - - /** Specifies the width for the mask edit textbox control. - * @Default {143pixel} - */ - width?: string; - - /** Fires when value changed in mask edit textbox control. */ - change?(e: ChangeEventArgs): void; - - /** Fires after MaskEdit control is created. */ - create?(e: CreateEventArgs): void; - - /** Fires when the MaskEdit is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; + /** returns the list of checked items. + */ + checkedItems?: number; + + /** returns the current checked item text. + */ + checkedItemsText?: string; + } + + export interface MouseUpEventArgs { + + /** returns true if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the name of the event. + */ + type?: string; + + /** returns the model value of the control. + */ + model?: ej.ListView.Model; + + /** If the child element exist return true; otherwise, false. + */ + hasChild?: boolean; + + /** returns the current list item. + */ + item?: string; + + /** returns the current text of item. + */ + text?: string; + + /** returns the current Index of the item. + */ + index?: number; + + /** If checked return true; otherwise, false. + */ + isChecked?: boolean; + + /** returns the list of checked items. + */ + checkedItems?: number; + + /** returns the current checked item text. + */ + checkedItemsText?: string; + } + + export interface AjaxSettings { + + /** It specifies, whether to enable or disable asynchronous request. + */ + async?: boolean; + + /** It specifies the page will be cached in the web browser. + */ + cache?: boolean; + + /** It specifies the type of data is send in the query string. + */ + contentType?: string; + + /** It specifies the data as an object, will be passed in the query string. + */ + data?: any; + + /** It specifies the type of data that you're expecting back from the response. + */ + dataType?: string; + + /** It specifies the HTTP request type. + */ + type?: string; + } + } + + class MaskEdit extends ej.Widget { + static fn: MaskEdit; + constructor(element: JQuery | Element, options?: MaskEdit.Model); + static Locale: any; + model: MaskEdit.Model; + defaults: MaskEdit.Model; + + /** To clear the text in mask edit textbox control. + * @returns {void} + */ + clear(): void; + + /** To disable the mask edit textbox control. + * @returns {void} + */ + disable(): void; + + /** To enable the mask edit textbox control. + * @returns {void} + */ + enable(): void; + + /** To obtained the pure value of the text value, removes all the symbols in mask edit textbox control. + * @returns {string} + */ + get_StrippedValue(): string; + + /** To obtained the textbox value as such that, Just replace all '_' to ' '(space) in mask edit textbox control. + * @returns {string} + */ + get_UnstrippedValue(): string; + } + export namespace MaskEdit { + + export interface Model { + + /** Specify the cssClass to achieve custom theme. + * @Default {null} + */ + cssClass?: string; + + /** Specify the custom character allowed to entered in mask edit textbox control. + * @Default {null} + */ + customCharacter?: string; + + /** Specify the state of the mask edit textbox control. + * @Default {true} + */ + enabled?: boolean; + + /** Specify the enablePersistence to mask edit textbox to save current model value to browser cookies for state maintains. + */ + enablePersistence?: boolean; + + /** Specifies the height for the mask edit textbox control. + * @Default {28 px} + */ + height?: string; + + /** Specifies whether hide the prompt characters with spaces on blur. Prompt chars will be shown again on focus the textbox. + * @Default {false} + */ + hidePromptOnLeave?: boolean; + + /** Specifies the list of HTML attributes to be added to mask edit textbox. + * @Default {{}} + */ + htmlAttributes?: any; + + /** Specify the inputMode for mask edit textbox control. See InputMode + * @Default {ej.InputMode.Text} + */ + inputMode?: ej.InputMode | string; + + /** Specifies the input mask. + * @Default {null} + */ + maskFormat?: string; + + /** Specifies the name attribute value for the mask edit textbox. + * @Default {null} + */ + name?: string; + + /** Toggles the readonly state of the mask edit textbox. When the mask edit textbox is readonly, it doesn't allow your input. + * @Default {false} + */ + readOnly?: boolean; + + /** Specifies whether the error will show until correct value entered in the mask edit textbox control. + * @Default {false} + */ + showError?: boolean; + + /** when showPromptChar is true, the hide the prompt characters are shown in focus of the control and hides in focus out of the control. + * @Default {true} + */ + showPromptChar?: boolean; + + /** MaskEdit input is displayed in rounded corner style when this property is set to true. + * @Default {false} + */ + showRoundedCorner?: boolean; + + /** Specify the text alignment for mask edit textbox control.See TextAlign + * @Default {left} + */ + textAlign?: ej.TextAlign | string; + + /** Sets the jQuery validation error message in mask edit. This property works when the widget is present inside the form. Include jquery.validate.min.js plugin additionally. + * @Default {null} + */ + validationMessage?: any; + + /** Sets the jQuery validation rules to the MaskEdit. This property works when the widget is present inside the form. Include jquery.validate.min.js plugin additionally. + * @Default {null} + */ + validationRules?: any; + + /** Specifies the value for the mask edit textbox control. + * @Default {null} + */ + value?: string; + + /** Specifies the water mark text to be displayed in input text. + * @Default {null} + */ + watermarkText?: string; + + /** Specifies the width for the mask edit textbox control. + * @Default {143pixel} + */ + width?: string; + + /** Fires when value changed in mask edit textbox control. */ + change?(e: ChangeEventArgs): void; + + /** Fires after MaskEdit control is created. */ + create?(e: CreateEventArgs): void; + + /** Fires when the MaskEdit is destroyed successfully. */ + destroy?(e: DestroyEventArgs): void; - /** Fires when focused in mask edit textbox control. */ - focusIn?(e: FocusInEventArgs): void; - - /** Fires when focused out in mask edit textbox control. */ - focusOut?(e: FocusOutEventArgs): void; + /** Fires when focused in mask edit textbox control. */ + focusIn?(e: FocusInEventArgs): void; + + /** Fires when focused out in mask edit textbox control. */ + focusOut?(e: FocusOutEventArgs): void; - /** Fires when keydown in mask edit textbox control. */ - keydown?(e: KeydownEventArgs): void; + /** Fires when keydown in mask edit textbox control. */ + keydown?(e: KeydownEventArgs): void; - /** Fires when key press in mask edit textbox control. */ - keyPress?(e: KeyPressEventArgs): void; + /** Fires when key press in mask edit textbox control. */ + keyPress?(e: KeyPressEventArgs): void; - /** Fires when keyup in mask edit textbox control. */ - keyup?(e: KeyupEventArgs): void; + /** Fires when keyup in mask edit textbox control. */ + keyup?(e: KeyupEventArgs): void; - /** Fires when mouse out in mask edit textbox control. */ - mouseOut?(e: MouseOutEventArgs): void; + /** Fires when mouse out in mask edit textbox control. */ + mouseOut?(e: MouseOutEventArgs): void; - /** Fires when mouse over in mask edit textbox control. */ - mouseOver?(e: MouseOverEventArgs): void; -} + /** Fires when mouse over in mask edit textbox control. */ + mouseOver?(e: MouseOverEventArgs): void; + } -export interface ChangeEventArgs { + export interface ChangeEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the mask edit model - */ - model?: ej.MaskEdit.Model; + /** returns the mask edit model + */ + model?: ej.MaskEdit.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the mask edit value - */ - value?: number; + /** returns the mask edit value + */ + value?: number; - /** returns unstripped value in mask edit textbox control. - */ - unmaskedValue?: string; -} + /** returns unstripped value in mask edit textbox control. + */ + unmaskedValue?: string; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the MaskEdit model - */ - model?: ej.MaskEdit.Model; + /** returns the MaskEdit model + */ + model?: ej.MaskEdit.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the MaskEdit model - */ - model?: ej.MaskEdit.Model; + /** returns the MaskEdit model + */ + model?: ej.MaskEdit.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface FocusInEventArgs { + export interface FocusInEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the mask edit model - */ - model?: ej.MaskEdit.Model; + /** returns the mask edit model + */ + model?: ej.MaskEdit.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the mask edit value - */ - value?: number; + /** returns the mask edit value + */ + value?: number; - /** returns unstripped value in mask edit textbox control. - */ - unmaskedValue?: string; -} + /** returns unstripped value in mask edit textbox control. + */ + unmaskedValue?: string; + } -export interface FocusOutEventArgs { + export interface FocusOutEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the mask edit model - */ - model?: ej.MaskEdit.Model; + /** returns the mask edit model + */ + model?: ej.MaskEdit.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the mask edit value - */ - value?: number; + /** returns the mask edit value + */ + value?: number; - /** returns unstripped value in mask edit textbox control. - */ - unmaskedValue?: string; -} + /** returns unstripped value in mask edit textbox control. + */ + unmaskedValue?: string; + } -export interface KeydownEventArgs { + export interface KeydownEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the mask edit model - */ - model?: ej.MaskEdit.Model; + /** returns the mask edit model + */ + model?: ej.MaskEdit.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the mask edit value - */ - value?: number; + /** returns the mask edit value + */ + value?: number; - /** returns unstripped value in mask edit textbox control. - */ - unmaskedValue?: string; -} + /** returns unstripped value in mask edit textbox control. + */ + unmaskedValue?: string; + } -export interface KeyPressEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the mask edit model - */ - model?: ej.MaskEdit.Model; - - /** returns the name of the event - */ - type?: string; - - /** returns the mask edit value - */ - value?: number; - - /** returns unstripped value in mask edit textbox control. - */ - unmaskedValue?: string; -} - -export interface KeyupEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the mask edit model - */ - model?: ej.MaskEdit.Model; - - /** returns the name of the event - */ - type?: string; - - /** returns the mask edit value - */ - value?: number; - - /** returns unstripped value in mask edit textbox control. - */ - unmaskedValue?: string; -} - -export interface MouseOutEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the mask edit model - */ - model?: ej.MaskEdit.Model; - - /** returns the name of the event - */ - type?: string; - - /** returns the mask edit value - */ - value?: number; - - /** returns unstripped value in mask edit textbox control. - */ - unmaskedValue?: string; -} - -export interface MouseOverEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the mask edit model - */ - model?: ej.MaskEdit.Model; - - /** returns the name of the event - */ - type?: string; - - /** returns the mask edit value - */ - value?: number; - - /** returns unstripped value in mask edit textbox control. - */ - unmaskedValue?: string; -} -} -enum InputMode { -//string -Password, -//string -Text, -} -enum TextAlign { -//string -Center, -//string -Justify, -//string -Left, -//string -Right, -} - -class Menu extends ej.Widget { - static fn: Menu; - constructor(element: JQuery | Element, options?: Menu.Model); - static Locale: any; - model: Menu.Model; - defaults: Menu.Model; - - /** Disables the Menu control. - * @returns {void} - */ - disable(): void; - - /** Specifies the Menu Item to be disabled by using the Menu Item Text. - * @param {string} Specifies the Menu Item Text to be disabled. - * @returns {void} - */ - disableItem(itemtext: string): void; - - /** Specifies the Menu Item to be disabled by using the Menu Item Id. - * @param {string|number} Specifies the Menu Item id to be disabled - * @returns {void} - */ - disableItemByID(itemid: string|number): void; - - /** Enables the Menu control. - * @returns {void} - */ - enable(): void; - - /** Specifies the Menu Item to be enabled by using the Menu Item Text. - * @param {string} Specifies the Menu Item Text to be enabled. - * @returns {void} - */ - enableItem(itemtext: string): void; - - /** Specifies the Menu Item to be enabled by using the Menu Item Id. - * @param {string|number} Specifies the Menu Item id to be enabled. - * @returns {void} - */ - enableItemByID(itemid: string|number): void; - - /** Hides the Context Menu control. - * @returns {void} - */ - hide(): void; - - /** Hides the specific items in Menu control. - * @returns {void} - */ - hideItems(): void; - - /** Insert the menu item as child of target node. - * @param {any} Information about Menu item. - * @param {string|any} Selector of target node or Object of target node. - * @returns {void} - */ - insert(item: any, target: string|any): void; - - /** Insert the menu item after the target node. - * @param {any} Information about Menu item. - * @param {string|any} Selector of target node or Object of target node. - * @returns {void} - */ - insertAfter(item: any, target: string|any): void; - - /** Insert the menu item before the target node. - * @param {any} Information about Menu item. - * @param {string|any} Selector of target node or Object of target node. - * @returns {void} - */ - insertBefore(item: any, target: string|any): void; - - /** Remove Menu item. - * @param {any|Array} Selector of target node or Object of target node. - * @returns {void} - */ - remove(target: any|any[]): void; - - /** To show the Menu control. - * @param {number} x co-ordinate position of context menu. - * @param {number} y co-ordinate position of context menu. - * @param {any} target element - * @param {any} name of the event - * @returns {void} - */ - show(locationX: number, locationY: number, targetElement: any, event: any): void; - - /** Show the specific items in Menu control. - * @returns {void} - */ - showItems(): void; -} -export namespace Menu { - -export interface Model { - - /** To enable or disable the Animation while hover or click an menu items.See AnimationType - * @Default {ej.AnimationType.Default} - */ - animationType?: ej.AnimationType|string; - - /** Specifies the target id of context menu. On right clicking the specified contextTarget element, context menu gets shown. - * @Default {null} - */ - contextMenuTarget?: string; - - /** Specify the CSS class to achieve custom theme. - */ - cssClass?: string; - - /** To enable or disable the Animation effect while hover or click an menu items. - * @Default {true} - */ - enableAnimation?: boolean; - - /** Specifies the root menu items to be aligned center in horizontal menu. - * @Default {false} - */ - enableCenterAlign?: boolean; - - /** Enable / Disable the Menu control. - * @Default {true} - */ - enabled?: boolean; - - /** Specifies the menu items to be displayed in right to left direction. - * @Default {false} - */ - enableRTL?: boolean; - - /** When this property sets to false, the menu items is displayed without any separators. - * @Default {true} - */ - enableSeparator?: boolean; - - /** Specifies the target which needs to be excluded. i.e., The context menu will not be displayed in those specified targets. - * @Default {null} - */ - excludeTarget?: string; - - /** Fields used to bind the data source and it includes following field members to make data bind easier. - * @Default {null} - */ - fields?: Fields; - - /** Specifies the height of the root menu. - * @Default {auto} - */ - height?: string|number; - - /** Specifies the list of HTML attributes to be added to menu control. - * @Default {{}} - */ - htmlAttributes?: any; - - /** Enables/disables responsive support for the Menu control during the window resizing time. - * @Default {true} - */ - isResponsive?: boolean; - - /** Specifies the type of the menu. Essential JavaScript Menu consists of two type of menu, they are Normal Menu and Context Menu mode.See MenuType - * @Default {ej.MenuType.NormalMenu} - */ - menuType?: string|ej.MenuType; - - /** Specifies the sub menu items to be show or open only on click. - * @Default {false} - */ - openOnClick?: boolean; - - /** Specifies the orientation of normal menu. Normal menu can rendered in horizontal or vertical direction by using this API. See Orientation - * @Default {ej.Orientation.Horizontal} - */ - orientation?: ej.Orientation|string; - - /** Specifies the main menu items arrows only to be shown if it contains child items. - * @Default {true} - */ - showRootLevelArrows?: boolean; - - /** Specifies the sub menu items arrows only to be shown if it contains child items. - * @Default {true} - */ - showSubLevelArrows?: boolean; - - /** Specifies position of pull down submenu that will appear on mouse over.See Direction - * @Default {ej.Direction.Right} - */ - subMenuDirection?: string|ej.Direction; - - /** Specifies the title to responsive menu. - * @Default {Menu} - */ - titleText?: string; - - /** Specifies the width of the main menu. - * @Default {auto} - */ - width?: string|number; - - /** Specifies the popup menu height. - * @Default {auto} - */ - overflowHeight?: string|number; - - /** Specifies the popup menu width. - * @Default {auto} - */ - overflowWidth?: string|number; - - /** Fires before context menu gets open. */ - beforeOpen?(e: BeforeOpenEventArgs): void; - - /** Fires when mouse click on menu items. */ - click?(e: ClickEventArgs): void; - - /** Fire when context menu on close. */ - close?(e: CloseEventArgs): void; - - /** Fires when context menu on open. */ - open?(e: OpenEventArgs): void; + export interface KeyPressEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the mask edit model + */ + model?: ej.MaskEdit.Model; + + /** returns the name of the event + */ + type?: string; + + /** returns the mask edit value + */ + value?: number; + + /** returns unstripped value in mask edit textbox control. + */ + unmaskedValue?: string; + } + + export interface KeyupEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the mask edit model + */ + model?: ej.MaskEdit.Model; + + /** returns the name of the event + */ + type?: string; + + /** returns the mask edit value + */ + value?: number; + + /** returns unstripped value in mask edit textbox control. + */ + unmaskedValue?: string; + } + + export interface MouseOutEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the mask edit model + */ + model?: ej.MaskEdit.Model; + + /** returns the name of the event + */ + type?: string; + + /** returns the mask edit value + */ + value?: number; + + /** returns unstripped value in mask edit textbox control. + */ + unmaskedValue?: string; + } + + export interface MouseOverEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the mask edit model + */ + model?: ej.MaskEdit.Model; + + /** returns the name of the event + */ + type?: string; + + /** returns the mask edit value + */ + value?: number; + + /** returns unstripped value in mask edit textbox control. + */ + unmaskedValue?: string; + } + } + enum InputMode { + //string + Password, + //string + Text, + } + enum TextAlign { + //string + Center, + //string + Justify, + //string + Left, + //string + Right, + } + + class Menu extends ej.Widget { + static fn: Menu; + constructor(element: JQuery | Element, options?: Menu.Model); + static Locale: any; + model: Menu.Model; + defaults: Menu.Model; + + /** Disables the Menu control. + * @returns {void} + */ + disable(): void; + + /** Specifies the Menu Item to be disabled by using the Menu Item Text. + * @param {string} Specifies the Menu Item Text to be disabled. + * @returns {void} + */ + disableItem(itemtext: string): void; + + /** Specifies the Menu Item to be disabled by using the Menu Item Id. + * @param {string|number} Specifies the Menu Item id to be disabled + * @returns {void} + */ + disableItemByID(itemid: string | number): void; + + /** Enables the Menu control. + * @returns {void} + */ + enable(): void; + + /** Specifies the Menu Item to be enabled by using the Menu Item Text. + * @param {string} Specifies the Menu Item Text to be enabled. + * @returns {void} + */ + enableItem(itemtext: string): void; + + /** Specifies the Menu Item to be enabled by using the Menu Item Id. + * @param {string|number} Specifies the Menu Item id to be enabled. + * @returns {void} + */ + enableItemByID(itemid: string | number): void; + + /** Hides the Context Menu control. + * @returns {void} + */ + hide(): void; + + /** Hides the specific items in Menu control. + * @returns {void} + */ + hideItems(): void; + + /** Insert the menu item as child of target node. + * @param {any} Information about Menu item. + * @param {string|any} Selector of target node or Object of target node. + * @returns {void} + */ + insert(item: any, target: string | any): void; + + /** Insert the menu item after the target node. + * @param {any} Information about Menu item. + * @param {string|any} Selector of target node or Object of target node. + * @returns {void} + */ + insertAfter(item: any, target: string | any): void; + + /** Insert the menu item before the target node. + * @param {any} Information about Menu item. + * @param {string|any} Selector of target node or Object of target node. + * @returns {void} + */ + insertBefore(item: any, target: string | any): void; + + /** Remove Menu item. + * @param {any|Array} Selector of target node or Object of target node. + * @returns {void} + */ + remove(target: any | any[]): void; + + /** To show the Menu control. + * @param {number} x co-ordinate position of context menu. + * @param {number} y co-ordinate position of context menu. + * @param {any} target element + * @param {any} name of the event + * @returns {void} + */ + show(locationX: number, locationY: number, targetElement: any, event: any): void; + + /** Show the specific items in Menu control. + * @returns {void} + */ + showItems(): void; + } + export namespace Menu { + + export interface Model { + + /** To enable or disable the Animation while hover or click an menu items.See AnimationType + * @Default {ej.AnimationType.Default} + */ + animationType?: ej.AnimationType | string; + + /** Specifies the target id of context menu. On right clicking the specified contextTarget element, context menu gets shown. + * @Default {null} + */ + contextMenuTarget?: string; + + /** Specify the CSS class to achieve custom theme. + */ + cssClass?: string; + + /** To enable or disable the Animation effect while hover or click an menu items. + * @Default {true} + */ + enableAnimation?: boolean; + + /** Specifies the root menu items to be aligned center in horizontal menu. + * @Default {false} + */ + enableCenterAlign?: boolean; + + /** Enable / Disable the Menu control. + * @Default {true} + */ + enabled?: boolean; + + /** Specifies the menu items to be displayed in right to left direction. + * @Default {false} + */ + enableRTL?: boolean; + + /** When this property sets to false, the menu items is displayed without any separators. + * @Default {true} + */ + enableSeparator?: boolean; + + /** Specifies the target which needs to be excluded. i.e., The context menu will not be displayed in those specified targets. + * @Default {null} + */ + excludeTarget?: string; + + /** Fields used to bind the data source and it includes following field members to make data bind easier. + * @Default {null} + */ + fields?: Fields; + + /** Specifies the height of the root menu. + * @Default {auto} + */ + height?: string | number; + + /** Specifies the list of HTML attributes to be added to menu control. + * @Default {{}} + */ + htmlAttributes?: any; + + /** Enables/disables responsive support for the Menu control during the window resizing time. + * @Default {true} + */ + isResponsive?: boolean; + + /** Specifies the type of the menu. Essential JavaScript Menu consists of two type of menu, they are Normal Menu and Context Menu mode.See MenuType + * @Default {ej.MenuType.NormalMenu} + */ + menuType?: string | ej.MenuType; + + /** Specifies the sub menu items to be show or open only on click. + * @Default {false} + */ + openOnClick?: boolean; + + /** Specifies the orientation of normal menu. Normal menu can rendered in horizontal or vertical direction by using this API. See Orientation + * @Default {ej.Orientation.Horizontal} + */ + orientation?: ej.Orientation | string; + + /** Specifies the main menu items arrows only to be shown if it contains child items. + * @Default {true} + */ + showRootLevelArrows?: boolean; + + /** Specifies the sub menu items arrows only to be shown if it contains child items. + * @Default {true} + */ + showSubLevelArrows?: boolean; + + /** Specifies position of pull down submenu that will appear on mouse over.See Direction + * @Default {ej.Direction.Right} + */ + subMenuDirection?: string | ej.Direction; + + /** Specifies the title to responsive menu. + * @Default {Menu} + */ + titleText?: string; + + /** Specifies the width of the main menu. + * @Default {auto} + */ + width?: string | number; + + /** Specifies the popup menu height. + * @Default {auto} + */ + overflowHeight?: string | number; + + /** Specifies the popup menu width. + * @Default {auto} + */ + overflowWidth?: string | number; + + /** Fires before context menu gets open. */ + beforeOpen?(e: BeforeOpenEventArgs): void; + + /** Fires when mouse click on menu items. */ + click?(e: ClickEventArgs): void; + + /** Fire when context menu on close. */ + close?(e: CloseEventArgs): void; + + /** Fires when context menu on open. */ + open?(e: OpenEventArgs): void; - /** Fires to create menu items. */ - create?(e: CreateEventArgs): void; + /** Fires to create menu items. */ + create?(e: CreateEventArgs): void; - /** Fires to destroy menu items. */ - destroy?(e: DestroyEventArgs): void; + /** Fires to destroy menu items. */ + destroy?(e: DestroyEventArgs): void; - /** Fires when key down on menu items. */ - keydown?(e: KeydownEventArgs): void; + /** Fires when key down on menu items. */ + keydown?(e: KeydownEventArgs): void; - /** Fires when mouse out from menu items. */ - mouseout?(e: MouseoutEventArgs): void; + /** Fires when mouse out from menu items. */ + mouseout?(e: MouseoutEventArgs): void; - /** Fires when mouse over the Menu items. */ - mouseover?(e: MouseoverEventArgs): void; + /** Fires when mouse over the Menu items. */ + mouseover?(e: MouseoverEventArgs): void; - /** Fires when overflow popup menu opens. */ - overflowOpen?(e: OverflowOpenEventArgs): void; + /** Fires when overflow popup menu opens. */ + overflowOpen?(e: OverflowOpenEventArgs): void; - /** Fires when overflow popup menu closes. */ - overflowClose?(e: OverflowCloseEventArgs): void; -} + /** Fires when overflow popup menu closes. */ + overflowClose?(e: OverflowCloseEventArgs): void; + } -export interface BeforeOpenEventArgs { + export interface BeforeOpenEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the menu model - */ - model?: ej.Menu.Model; + /** returns the menu model + */ + model?: ej.Menu.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the target element - */ - target?: any; -} + /** returns the target element + */ + target?: any; + } -export interface ClickEventArgs { + export interface ClickEventArgs { - /** returns the menu model - */ - model?: ej.Menu.Model; + /** returns the menu model + */ + model?: ej.Menu.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns clicked menu item text - */ - text?: string; + /** returns clicked menu item text + */ + text?: string; - /** returns clicked menu item element - */ - element?: any; + /** returns clicked menu item element + */ + element?: any; - /** returns the event - */ - event?: any; + /** returns the event + */ + event?: any; - /** returns the selected item - */ - selectedItem?: number; -} + /** returns the selected item + */ + selectedItem?: number; + } -export interface CloseEventArgs { + export interface CloseEventArgs { - /** returns the menu model - */ - model?: ej.Menu.Model; + /** returns the menu model + */ + model?: ej.Menu.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the target element - */ - target?: any; -} + /** returns the target element + */ + target?: any; + } -export interface OpenEventArgs { + export interface OpenEventArgs { - /** returns the menu model - */ - model?: ej.Menu.Model; + /** returns the menu model + */ + model?: ej.Menu.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the target element - */ - target?: any; -} + /** returns the target element + */ + target?: any; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** returns the menu model - */ - model?: ej.Menu.Model; + /** returns the menu model + */ + model?: ej.Menu.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** returns the menu model - */ - model?: ej.Menu.Model; + /** returns the menu model + */ + model?: ej.Menu.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface KeydownEventArgs { + export interface KeydownEventArgs { - /** returns the menu model - */ - model?: ej.Menu.Model; + /** returns the menu model + */ + model?: ej.Menu.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns clicked menu item text - */ - menuText?: string; + /** returns clicked menu item text + */ + menuText?: string; - /** returns clicked menu item element - */ - element?: any; + /** returns clicked menu item element + */ + element?: any; - /** returns the event - */ - event?: any; -} + /** returns the event + */ + event?: any; + } -export interface MouseoutEventArgs { + export interface MouseoutEventArgs { - /** returns the menu model - */ - model?: ej.Menu.Model; + /** returns the menu model + */ + model?: ej.Menu.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns clicked menu item text - */ - text?: string; + /** returns clicked menu item text + */ + text?: string; - /** returns clicked menu item element - */ - element?: any; + /** returns clicked menu item element + */ + element?: any; - /** returns the event - */ - event?: any; -} + /** returns the event + */ + event?: any; + } -export interface MouseoverEventArgs { + export interface MouseoverEventArgs { - /** returns the menu model - */ - model?: ej.Menu.Model; + /** returns the menu model + */ + model?: ej.Menu.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns clicked menu item text - */ - text?: string; + /** returns clicked menu item text + */ + text?: string; - /** returns clicked menu item element - */ - element?: any; + /** returns clicked menu item element + */ + element?: any; - /** returns the event - */ - event?: any; -} + /** returns the event + */ + event?: any; + } -export interface OverflowOpenEventArgs { - - /** returns the menu model - */ - model?: ej.Menu.Model; - - /** returns the name of the event - */ - type?: string; - - /** returns the event object - */ - e?: any; - - /** if the event should be cancelled ; otherwise ,false - */ - cancel?: boolean; -} - -export interface OverflowCloseEventArgs { - - /** returns the menu model - */ - model?: ej.Menu.Model; - - /** returns the name of the event - */ - type?: string; - - /** returns the event object - */ - e?: any; - - /** if the event should be cancelled ; otherwise ,false - */ - cancel?: boolean; -} - -export interface Fields { - - /** It receives the child data for the inner level. - */ - child?: any; - - /** It receives datasource as Essential DataManager object and JSON object. - */ - dataSource?: any; - - /** Specifies the HTML attributes to Ă¢â‚¬Å“LIĂ¢â‚¬Â item list. - */ - htmlAttribute?: string; - - /** Specifies the id to menu items list - */ - id?: string; - - /** Specifies the image attribute to Ă¢â‚¬Å“imgĂ¢â‚¬Â tag inside items list. - */ - imageAttribute?: string; - - /** Specifies the image URL to Ă¢â‚¬Å“imgĂ¢â‚¬Â tag inside item list. - */ - imageUrl?: string; - - /** Adds custom attributes like "target" to the anchor tag of the menu items. - */ - linkAttribute?: string; - - /** Specifies the parent id of the table. - */ - parentId?: string; - - /** It receives query to retrieve data from the table (query is same as SQL). - */ - query?: any; - - /** Specifies the sprite CSS class to Ă¢â‚¬Å“LIĂ¢â‚¬Â item list. - */ - spriteCssClass?: string; - - /** It receives table name to execute query on the corresponding table. - */ - tableName?: string; - - /** Specifies the text of menu items list. - */ - text?: string; - - /** Specifies the URL to the anchor tag in menu item list. - */ - url?: string; -} -} -enum AnimationType { -//string -Default, -//string -None, -} -enum MenuType { -//string -ContextMenu, -//string -NormalMenu, -} -enum Direction { -//string -Left, -//string -None, -//string -Right, -} - -class Pager extends ej.Widget { - static fn: Pager; - constructor(element: JQuery | Element, options?: Pager.Model); - static Locale: any; - model: Pager.Model; - defaults: Pager.Model; - - /** Send a paging request to specified page through the pager control. - * @param {number} Specifies the index to be navigated - * @returns {void} - */ - gotoPage(pageIndex: number): void; - - /** refreshPager() helps to refresh the model value of pager control. - * @returns {void} - */ - refreshPager(): void; -} -export namespace Pager { - -export interface Model { - - /** Gets or sets a value that indicates whether to display the custom text message in Pager. - */ - customText?: string; - - /** Gets or sets a value that indicates whether to define which page to display currently in pager. - * @Default {1} - */ - currentPage?: number; - - /** Gets or sets a value that indicates whether to display the external Message in Pager. - * @Default {false} - */ - enableExternalMessage?: boolean; - - /** Gets or sets a value that indicates whether to pass the current page information as a query string along with the URL while navigating to other page. - * @Default {false} - */ - enableQueryString?: boolean; - - /** Align content in the pager control from right to left by setting the property as true. - * @Default {false} - */ - enableRTL?: boolean; - - /** Gets or sets a value that indicates whether to display the external Message in Pager. - */ - externalMessage?: string; - - /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. - * in a language and culture specific to a particular country or region. - * @Default {en-US} - */ - locale?: string; - - /** Gets or sets a value that indicates whether to define the number of pages displayed in the pager for navigation. - * @Default {10} - */ - pageCount?: number; - - /** Gets or sets a value that indicates whether to define the number of records displayed per page. - * @Default {12} - */ - pageSize?: number; - - /** Get or sets a value of total number of pages in the pager. The totalPages value is calculated based on page size and total records. - * @Default {null} - */ - totalPages?: number; - - /** Get the value of total number of records which is bound to a data item. - * @Default {null} - */ - totalRecordsCount?: number; - - /** Shows or hides the current page information in pager footer. - * @Default {true} - */ - showPageInfo?: boolean; - - /** Triggered when pager numeric item is clicked in pager control. */ - click?(e: ClickEventArgs): void; -} - -export interface ClickEventArgs { - - /** Returns the cancel option value. - */ - cancel?: boolean; - - /** Returns the current page index. - */ - currentPage?: number; - - /** Returns the pager model. - */ - model?: any; - - /** Returns the name of event - */ - type?: string; - - /** Returns current action event type and its target. - */ - event?: any; -} -} - -class ProgressBar extends ej.Widget { - static fn: ProgressBar; - constructor(element: JQuery | Element, options?: ProgressBar.Model); - static Locale: any; - model: ProgressBar.Model; - defaults: ProgressBar.Model; - - /** Destroy the progressbar widget - * @returns {void} - */ - destroy(): void; - - /** Disables the progressbar control - * @returns {void} - */ - disable(): void; - - /** Enables the progressbar control - * @returns {void} - */ - enable(): void; - - /** Returns the current progress value in percent. - * @returns {number} - */ - getPercentage(): number; - - /** Returns the current progress value - * @returns {number} - */ - getValue(): number; -} -export namespace ProgressBar { - -export interface Model { - - /** Sets the root CSS class for ProgressBar theme, which is used customize. - * @Default {null} - */ - cssClass?: string; - - /** When this property sets to false, it disables the ProgressBar control - * @Default {true} - */ - enabled?: boolean; - - /** Save current model value to browser cookies for state maintains. While refresh the progressBar control page retains the model value apply from browser cookies - * @Default {false} - */ - enablePersistence?: boolean; - - /** Sets the ProgressBar direction as right to left alignment. - * @Default {false} - */ - enableRTL?: boolean; - - /** Defines the height of the ProgressBar. - * @Default {null} - */ - height?: number|string; - - /** It allows to define the characteristics of the progressBar control. It will helps to extend the capability of an HTML element. - * @Default {{}} - */ - htmlAttributes?: any; - - /** Sets the maximum value of the ProgressBar. - * @Default {100} - */ - maxValue?: number; - - /** Sets the minimum value of the ProgressBar. - * @Default {0} - */ - minValue?: number; - - /** Sets the ProgressBar value in percentage. The value should be in between 0 to 100. - * @Default {0} - */ - percentage?: number; - - /** Displays rounded corner borders on the progressBar control. - * @Default {false} - */ - showRoundedCorner?: boolean; - - /** Sets the custom text for the ProgressBar. The text placed in the middle of the ProgressBar and it can be customizable using the class 'e-progress-text'. - * @Default {null} - */ - text?: string; - - /** Sets the ProgressBar value. The value should be in between min and max values. - * @Default {0} - */ - value?: number; - - /** Defines the width of the ProgressBar. - * @Default {null} - */ - width?: number|string; - - /** Event triggers when the progress value changed */ - change?(e: ChangeEventArgs): void; - - /** Event triggers when the process completes (at 100%) */ - complete?(e: CompleteEventArgs): void; - - /** Event triggers when the progressbar are created */ - create?(e: CreateEventArgs): void; - - /** Event triggers when the progressbar are destroyed */ - destroy?(e: DestroyEventArgs): void; - - /** Event triggers when the process starts (from 0%) */ - start?(e: StartEventArgs): void; -} - -export interface ChangeEventArgs { - - /** returns the cancel option value - */ - cancel?: boolean; - - /** returns the ProgressBar model - */ - model?: ej.ProgressBar.Model; - - /** returns the current progress percentage - */ - percentage?: any; - - /** returns the name of the event - */ - type?: string; - - /** returns the current progress value - */ - value?: string; -} - -export interface CompleteEventArgs { - - /** returns the cancel option value - */ - cancel?: boolean; - - /** returns the ProgressBar model - */ - model?: ej.ProgressBar.Model; - - /** returns the current progress percentage - */ - percentage?: any; - - /** returns the name of the event - */ - type?: string; - - /** returns the current progress value - */ - value?: string; -} - -export interface CreateEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the progressbar model - */ - model?: ej.ProgressBar.Model; - - /** returns the name of the event - */ - type?: string; -} - -export interface DestroyEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the progressbar model - */ - model?: ej.ProgressBar.Model; - - /** returns the name of the event - */ - type?: string; -} - -export interface StartEventArgs { - - /** returns the cancel option value - */ - cancel?: boolean; - - /** returns the ProgressBar model - */ - model?: ej.ProgressBar.Model; - - /** returns the current progress percentage - */ - percentage?: any; - - /** returns the name of the event - */ - type?: string; - - /** returns the current progress value - */ - value?: string; -} -} - -class RadioButton extends ej.Widget { - static fn: RadioButton; - constructor(element: JQuery | Element, options?: RadioButton.Model); - static Locale: any; - model: RadioButton.Model; - defaults: RadioButton.Model; - - /** To disable the RadioButton - * @returns {void} - */ - disable(): void; - - /** To enable the RadioButton - * @returns {void} - */ - enable(): void; -} -export namespace RadioButton { - -export interface Model { - - /** Specifies the check attribute of the Radio Button. - * @Default {false} - */ - checked?: boolean; - - /** Specify the CSS class to RadioButton to achieve custom theme. - */ - cssClass?: string; - - /** Specifies the RadioButton control state. - * @Default {true} - */ - enabled?: boolean; - - /** Specifies the enablePersistence property for RadioButton while initialization. The enablePersistence API save current model value to browser cookies for state maintains. - * While refreshing the radio button control page the model value apply from browser cookies. - * @Default {false} - */ - enablePersistence?: boolean; - - /** Specify the Right to Left direction to RadioButton - * @Default {false} - */ - enableRTL?: boolean; - - /** Specifies the HTML Attributes of the Checkbox - * @Default {{}} - */ - htmlAttributes?: any; - - /** Specifies the id attribute for the Radio Button while initialization. - * @Default {null} - */ - id?: string; - - /** Specify the idPrefix value to be added before the current id of the RadioButton. - * @Default {ej} - */ - idPrefix?: string; - - /** Specifies the name attribute for the Radio Button while initialization. - * @Default {Sets id as name if it is null} - */ - name?: string; - - /** Specifies the size of the RadioButton. - * @Default {small} - */ - size?: ej.RadioButtonSize|string; - - /** Specifies the text content for RadioButton. - */ - text?: string; - - /** Set the jQuery validation error message in radio button. - * @Default {null} - */ - validationMessage?: any; - - /** Set the jQuery validation rules in radio button. - * @Default {null} - */ - validationRules?: any; - - /** Specifies the value attribute of the Radio Button. - * @Default {null} - */ - value?: string; - - /** Fires before the RadioButton is going to changed its state successfully */ - beforeChange?(e: BeforeChangeEventArgs): void; - - /** Fires when the RadioButton state is changed successfully */ - change?(e: ChangeEventArgs): void; - - /** Fires when the RadioButton created successfully */ - create?(e: CreateEventArgs): void; - - /** Fires when the RadioButton destroyed successfully */ - destroy?(e: DestroyEventArgs): void; -} - -export interface BeforeChangeEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the RadioButton model - */ - model?: ej.RadioButton.Model; - - /** returns the name of the event - */ - type?: string; - - /** returns true if element is checked, otherwise returns false - */ - isChecked?: boolean; - - /** returns true if change event triggered by interaction, otherwise returns false - */ - isInteraction?: boolean; -} - -export interface ChangeEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the RadioButton model - */ - model?: ej.RadioButton.Model; - - /** returns the name of the event - */ - type?: string; - - /** returns true if element is checked, otherwise returns false - */ - isChecked?: boolean; - - /** returns true if change event triggered by interaction, otherwise returns false - */ - isInteraction?: boolean; -} - -export interface CreateEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the RadioButton model - */ - model?: ej.RadioButton.Model; - - /** returns the name of the event - */ - type?: string; -} - -export interface DestroyEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the RadioButton model - */ - model?: ej.RadioButton.Model; - - /** returns the name of the event - */ - type?: string; -} -} -enum RadioButtonSize { -//Shows small size radio button -Small, -//Shows medium size radio button -Medium, -} - -class Rating extends ej.Widget { - static fn: Rating; - constructor(element: JQuery | Element, options?: Rating.Model); - static Locale: any; - model: Rating.Model; - defaults: Rating.Model; - - /** Destroy the Rating widget all events bound will be unbind automatically and bring the control to pre-init state. - * @returns {void} - */ - destroy(): void; - - /** To get the current value of rating control. - * @returns {number} - */ - getValue(): number; - - /** To hide the rating control. - * @returns {void} - */ - hide(): void; - - /** User can refresh the rating control to identify changes. - * @returns {void} - */ - refresh(): void; - - /** To reset the rating value. - * @returns {void} - */ - reset(): void; - - /** To set the rating value. - * @param {string|number} Specifies the rating value. - * @returns {void} - */ - setValue(value: string|number): void; - - /** To show the rating control - * @returns {void} - */ - show(): void; -} -export namespace Rating { - -export interface Model { - - /** Enables the rating control with reset button.It can be used to reset the rating control value. - * @Default {true} - */ - allowReset?: boolean; - - /** Specify the CSS class to achieve custom theme. - */ - cssClass?: string; - - /** When this property is set to false, it disables the rating control. - * @Default {true} - */ - enabled?: boolean; - - /** Save current model value to browser cookies for state maintenance. While refresh the page Rating control values are retained. - * @Default {false} - */ - enablePersistence?: boolean; - - /** Specifies the height of the Rating control wrapper. - * @Default {null} - */ - height?: string; - - /** Specifies the list of HTML attributes to be added to rating control. - * @Default {{}} - */ - htmlAttributes?: any; - - /** Specifies the value to be increased while navigating between shapes(stars) in Rating control. - * @Default {1} - */ - incrementStep?: number; - - /** Allow to render the maximum number of Rating shape(star). - * @Default {5} - */ - maxValue?: number; - - /** Allow to render the minimum number of Rating shape(star). - * @Default {0} - */ - minValue?: number; - - /** Specifies the orientation of Rating control. See Orientation - * @Default {ej.Rating.Orientation.Horizontal} - */ - orientation?: ej.Orientation|string; - - /** Helps to provide more precise ratings.Rating control supports three precision modes - full, half, and exact. See Precision - * @Default {full} - */ - precision?: ej.Rating.Precision|string; - - /** Interaction with Rating control can be prevented by enabling this API. - * @Default {false} - */ - readOnly?: boolean; - - /** To specify the height of each shape in Rating control. - * @Default {23} - */ - shapeHeight?: number; - - /** To specify the width of each shape in Rating control. - * @Default {23} - */ - shapeWidth?: number; - - /** Enables the tooltip option.Currently selected value will be displayed in tooltip. - * @Default {true} - */ - showTooltip?: boolean; - - /** To specify the number of stars to be selected while rendering. - * @Default {1} - */ - value?: number; - - /** Specifies the width of the Rating control wrapper. - * @Default {null} - */ - width?: string; - - /** Fires when Rating value changes. */ - change?(e: ChangeEventArgs): void; - - /** Fires when Rating control is clicked successfully. */ - click?(e: ClickEventArgs): void; - - /** Fires when Rating control is created. */ - create?(e: CreateEventArgs): void; - - /** Fires when Rating control is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; - - /** Fires when mouse hover is removed from Rating control. */ - mouseout?(e: MouseoutEventArgs): void; - - /** Fires when mouse hovered over the Rating control. */ - mouseover?(e: MouseoverEventArgs): void; -} - -export interface ChangeEventArgs { + export interface OverflowOpenEventArgs { + + /** returns the menu model + */ + model?: ej.Menu.Model; + + /** returns the name of the event + */ + type?: string; + + /** returns the event object + */ + e?: any; + + /** if the event should be cancelled ; otherwise ,false + */ + cancel?: boolean; + } + + export interface OverflowCloseEventArgs { + + /** returns the menu model + */ + model?: ej.Menu.Model; + + /** returns the name of the event + */ + type?: string; + + /** returns the event object + */ + e?: any; + + /** if the event should be cancelled ; otherwise ,false + */ + cancel?: boolean; + } + + export interface Fields { + + /** It receives the child data for the inner level. + */ + child?: any; + + /** It receives datasource as Essential DataManager object and JSON object. + */ + dataSource?: any; + + /** Specifies the HTML attributes to Ă¢â‚¬Å“LIĂ¢â‚¬Â item list. + */ + htmlAttribute?: string; + + /** Specifies the id to menu items list + */ + id?: string; + + /** Specifies the image attribute to Ă¢â‚¬Å“imgĂ¢â‚¬Â tag inside items list. + */ + imageAttribute?: string; + + /** Specifies the image URL to Ă¢â‚¬Å“imgĂ¢â‚¬Â tag inside item list. + */ + imageUrl?: string; + + /** Adds custom attributes like "target" to the anchor tag of the menu items. + */ + linkAttribute?: string; + + /** Specifies the parent id of the table. + */ + parentId?: string; + + /** It receives query to retrieve data from the table (query is same as SQL). + */ + query?: any; + + /** Specifies the sprite CSS class to Ă¢â‚¬Å“LIĂ¢â‚¬Â item list. + */ + spriteCssClass?: string; + + /** It receives table name to execute query on the corresponding table. + */ + tableName?: string; + + /** Specifies the text of menu items list. + */ + text?: string; + + /** Specifies the URL to the anchor tag in menu item list. + */ + url?: string; + } + } + enum AnimationType { + //string + Default, + //string + None, + } + enum MenuType { + //string + ContextMenu, + //string + NormalMenu, + } + enum Direction { + //string + Left, + //string + None, + //string + Right, + } + + class Pager extends ej.Widget { + static fn: Pager; + constructor(element: JQuery | Element, options?: Pager.Model); + static Locale: any; + model: Pager.Model; + defaults: Pager.Model; + + /** Send a paging request to specified page through the pager control. + * @param {number} Specifies the index to be navigated + * @returns {void} + */ + gotoPage(pageIndex: number): void; + + /** refreshPager() helps to refresh the model value of pager control. + * @returns {void} + */ + refreshPager(): void; + } + export namespace Pager { + + export interface Model { + + /** Gets or sets a value that indicates whether to display the custom text message in Pager. + */ + customText?: string; + + /** Gets or sets a value that indicates whether to define which page to display currently in pager. + * @Default {1} + */ + currentPage?: number; + + /** Gets or sets a value that indicates whether to display the external Message in Pager. + * @Default {false} + */ + enableExternalMessage?: boolean; + + /** Gets or sets a value that indicates whether to pass the current page information as a query string along with the URL while navigating to other page. + * @Default {false} + */ + enableQueryString?: boolean; + + /** Align content in the pager control from right to left by setting the property as true. + * @Default {false} + */ + enableRTL?: boolean; + + /** Gets or sets a value that indicates whether to display the external Message in Pager. + */ + externalMessage?: string; + + /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. + * in a language and culture specific to a particular country or region. + * @Default {en-US} + */ + locale?: string; + + /** Gets or sets a value that indicates whether to define the number of pages displayed in the pager for navigation. + * @Default {10} + */ + pageCount?: number; + + /** Gets or sets a value that indicates whether to define the number of records displayed per page. + * @Default {12} + */ + pageSize?: number; + + /** Get or sets a value of total number of pages in the pager. The totalPages value is calculated based on page size and total records. + * @Default {null} + */ + totalPages?: number; + + /** Get the value of total number of records which is bound to a data item. + * @Default {null} + */ + totalRecordsCount?: number; + + /** Shows or hides the current page information in pager footer. + * @Default {true} + */ + showPageInfo?: boolean; + + /** Triggered when pager numeric item is clicked in pager control. */ + click?(e: ClickEventArgs): void; + } + + export interface ClickEventArgs { + + /** Returns the cancel option value. + */ + cancel?: boolean; + + /** Returns the current page index. + */ + currentPage?: number; + + /** Returns the pager model. + */ + model?: any; + + /** Returns the name of event + */ + type?: string; + + /** Returns current action event type and its target. + */ + event?: any; + } + } + + class ProgressBar extends ej.Widget { + static fn: ProgressBar; + constructor(element: JQuery | Element, options?: ProgressBar.Model); + static Locale: any; + model: ProgressBar.Model; + defaults: ProgressBar.Model; + + /** Destroy the progressbar widget + * @returns {void} + */ + destroy(): void; + + /** Disables the progressbar control + * @returns {void} + */ + disable(): void; + + /** Enables the progressbar control + * @returns {void} + */ + enable(): void; + + /** Returns the current progress value in percent. + * @returns {number} + */ + getPercentage(): number; + + /** Returns the current progress value + * @returns {number} + */ + getValue(): number; + } + export namespace ProgressBar { + + export interface Model { + + /** Sets the root CSS class for ProgressBar theme, which is used customize. + * @Default {null} + */ + cssClass?: string; + + /** When this property sets to false, it disables the ProgressBar control + * @Default {true} + */ + enabled?: boolean; + + /** Save current model value to browser cookies for state maintains. While refresh the progressBar control page retains the model value apply from browser cookies + * @Default {false} + */ + enablePersistence?: boolean; + + /** Sets the ProgressBar direction as right to left alignment. + * @Default {false} + */ + enableRTL?: boolean; + + /** Defines the height of the ProgressBar. + * @Default {null} + */ + height?: number | string; + + /** It allows to define the characteristics of the progressBar control. It will helps to extend the capability of an HTML element. + * @Default {{}} + */ + htmlAttributes?: any; + + /** Sets the maximum value of the ProgressBar. + * @Default {100} + */ + maxValue?: number; + + /** Sets the minimum value of the ProgressBar. + * @Default {0} + */ + minValue?: number; + + /** Sets the ProgressBar value in percentage. The value should be in between 0 to 100. + * @Default {0} + */ + percentage?: number; + + /** Displays rounded corner borders on the progressBar control. + * @Default {false} + */ + showRoundedCorner?: boolean; + + /** Sets the custom text for the ProgressBar. The text placed in the middle of the ProgressBar and it can be customizable using the class 'e-progress-text'. + * @Default {null} + */ + text?: string; + + /** Sets the ProgressBar value. The value should be in between min and max values. + * @Default {0} + */ + value?: number; + + /** Defines the width of the ProgressBar. + * @Default {null} + */ + width?: number | string; + + /** Event triggers when the progress value changed */ + change?(e: ChangeEventArgs): void; + + /** Event triggers when the process completes (at 100%) */ + complete?(e: CompleteEventArgs): void; + + /** Event triggers when the progressbar are created */ + create?(e: CreateEventArgs): void; + + /** Event triggers when the progressbar are destroyed */ + destroy?(e: DestroyEventArgs): void; + + /** Event triggers when the process starts (from 0%) */ + start?(e: StartEventArgs): void; + } + + export interface ChangeEventArgs { + + /** returns the cancel option value + */ + cancel?: boolean; + + /** returns the ProgressBar model + */ + model?: ej.ProgressBar.Model; + + /** returns the current progress percentage + */ + percentage?: any; + + /** returns the name of the event + */ + type?: string; + + /** returns the current progress value + */ + value?: string; + } + + export interface CompleteEventArgs { + + /** returns the cancel option value + */ + cancel?: boolean; + + /** returns the ProgressBar model + */ + model?: ej.ProgressBar.Model; + + /** returns the current progress percentage + */ + percentage?: any; + + /** returns the name of the event + */ + type?: string; + + /** returns the current progress value + */ + value?: string; + } + + export interface CreateEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the progressbar model + */ + model?: ej.ProgressBar.Model; + + /** returns the name of the event + */ + type?: string; + } + + export interface DestroyEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the progressbar model + */ + model?: ej.ProgressBar.Model; + + /** returns the name of the event + */ + type?: string; + } + + export interface StartEventArgs { + + /** returns the cancel option value + */ + cancel?: boolean; + + /** returns the ProgressBar model + */ + model?: ej.ProgressBar.Model; + + /** returns the current progress percentage + */ + percentage?: any; + + /** returns the name of the event + */ + type?: string; + + /** returns the current progress value + */ + value?: string; + } + } + + class RadioButton extends ej.Widget { + static fn: RadioButton; + constructor(element: JQuery | Element, options?: RadioButton.Model); + static Locale: any; + model: RadioButton.Model; + defaults: RadioButton.Model; + + /** To disable the RadioButton + * @returns {void} + */ + disable(): void; + + /** To enable the RadioButton + * @returns {void} + */ + enable(): void; + } + export namespace RadioButton { + + export interface Model { + + /** Specifies the check attribute of the Radio Button. + * @Default {false} + */ + checked?: boolean; + + /** Specify the CSS class to RadioButton to achieve custom theme. + */ + cssClass?: string; + + /** Specifies the RadioButton control state. + * @Default {true} + */ + enabled?: boolean; + + /** Specifies the enablePersistence property for RadioButton while initialization. The enablePersistence API save current model value to browser cookies for state maintains. + * While refreshing the radio button control page the model value apply from browser cookies. + * @Default {false} + */ + enablePersistence?: boolean; + + /** Specify the Right to Left direction to RadioButton + * @Default {false} + */ + enableRTL?: boolean; + + /** Specifies the HTML Attributes of the Checkbox + * @Default {{}} + */ + htmlAttributes?: any; + + /** Specifies the id attribute for the Radio Button while initialization. + * @Default {null} + */ + id?: string; + + /** Specify the idPrefix value to be added before the current id of the RadioButton. + * @Default {ej} + */ + idPrefix?: string; + + /** Specifies the name attribute for the Radio Button while initialization. + * @Default {Sets id as name if it is null} + */ + name?: string; + + /** Specifies the size of the RadioButton. + * @Default {small} + */ + size?: ej.RadioButtonSize | string; + + /** Specifies the text content for RadioButton. + */ + text?: string; + + /** Set the jQuery validation error message in radio button. + * @Default {null} + */ + validationMessage?: any; + + /** Set the jQuery validation rules in radio button. + * @Default {null} + */ + validationRules?: any; + + /** Specifies the value attribute of the Radio Button. + * @Default {null} + */ + value?: string; + + /** Fires before the RadioButton is going to changed its state successfully */ + beforeChange?(e: BeforeChangeEventArgs): void; + + /** Fires when the RadioButton state is changed successfully */ + change?(e: ChangeEventArgs): void; + + /** Fires when the RadioButton created successfully */ + create?(e: CreateEventArgs): void; + + /** Fires when the RadioButton destroyed successfully */ + destroy?(e: DestroyEventArgs): void; + } + + export interface BeforeChangeEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the RadioButton model + */ + model?: ej.RadioButton.Model; + + /** returns the name of the event + */ + type?: string; + + /** returns true if element is checked, otherwise returns false + */ + isChecked?: boolean; + + /** returns true if change event triggered by interaction, otherwise returns false + */ + isInteraction?: boolean; + } + + export interface ChangeEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the RadioButton model + */ + model?: ej.RadioButton.Model; + + /** returns the name of the event + */ + type?: string; + + /** returns true if element is checked, otherwise returns false + */ + isChecked?: boolean; + + /** returns true if change event triggered by interaction, otherwise returns false + */ + isInteraction?: boolean; + } + + export interface CreateEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the RadioButton model + */ + model?: ej.RadioButton.Model; + + /** returns the name of the event + */ + type?: string; + } + + export interface DestroyEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the RadioButton model + */ + model?: ej.RadioButton.Model; + + /** returns the name of the event + */ + type?: string; + } + } + enum RadioButtonSize { + //Shows small size radio button + Small, + //Shows medium size radio button + Medium, + } + + class Rating extends ej.Widget { + static fn: Rating; + constructor(element: JQuery | Element, options?: Rating.Model); + static Locale: any; + model: Rating.Model; + defaults: Rating.Model; + + /** Destroy the Rating widget all events bound will be unbind automatically and bring the control to pre-init state. + * @returns {void} + */ + destroy(): void; + + /** To get the current value of rating control. + * @returns {number} + */ + getValue(): number; + + /** To hide the rating control. + * @returns {void} + */ + hide(): void; + + /** User can refresh the rating control to identify changes. + * @returns {void} + */ + refresh(): void; + + /** To reset the rating value. + * @returns {void} + */ + reset(): void; + + /** To set the rating value. + * @param {string|number} Specifies the rating value. + * @returns {void} + */ + setValue(value: string | number): void; + + /** To show the rating control + * @returns {void} + */ + show(): void; + } + export namespace Rating { + + export interface Model { + + /** Enables the rating control with reset button.It can be used to reset the rating control value. + * @Default {true} + */ + allowReset?: boolean; + + /** Specify the CSS class to achieve custom theme. + */ + cssClass?: string; + + /** When this property is set to false, it disables the rating control. + * @Default {true} + */ + enabled?: boolean; + + /** Save current model value to browser cookies for state maintenance. While refresh the page Rating control values are retained. + * @Default {false} + */ + enablePersistence?: boolean; + + /** Specifies the height of the Rating control wrapper. + * @Default {null} + */ + height?: string; + + /** Specifies the list of HTML attributes to be added to rating control. + * @Default {{}} + */ + htmlAttributes?: any; + + /** Specifies the value to be increased while navigating between shapes(stars) in Rating control. + * @Default {1} + */ + incrementStep?: number; + + /** Allow to render the maximum number of Rating shape(star). + * @Default {5} + */ + maxValue?: number; + + /** Allow to render the minimum number of Rating shape(star). + * @Default {0} + */ + minValue?: number; + + /** Specifies the orientation of Rating control. See Orientation + * @Default {ej.Rating.Orientation.Horizontal} + */ + orientation?: ej.Orientation | string; + + /** Helps to provide more precise ratings.Rating control supports three precision modes - full, half, and exact. See Precision + * @Default {full} + */ + precision?: ej.Rating.Precision | string; + + /** Interaction with Rating control can be prevented by enabling this API. + * @Default {false} + */ + readOnly?: boolean; + + /** To specify the height of each shape in Rating control. + * @Default {23} + */ + shapeHeight?: number; + + /** To specify the width of each shape in Rating control. + * @Default {23} + */ + shapeWidth?: number; + + /** Enables the tooltip option.Currently selected value will be displayed in tooltip. + * @Default {true} + */ + showTooltip?: boolean; + + /** To specify the number of stars to be selected while rendering. + * @Default {1} + */ + value?: number; + + /** Specifies the width of the Rating control wrapper. + * @Default {null} + */ + width?: string; + + /** Fires when Rating value changes. */ + change?(e: ChangeEventArgs): void; + + /** Fires when Rating control is clicked successfully. */ + click?(e: ClickEventArgs): void; + + /** Fires when Rating control is created. */ + create?(e: CreateEventArgs): void; + + /** Fires when Rating control is destroyed successfully. */ + destroy?(e: DestroyEventArgs): void; + + /** Fires when mouse hover is removed from Rating control. */ + mouseout?(e: MouseoutEventArgs): void; + + /** Fires when mouse hovered over the Rating control. */ + mouseover?(e: MouseoverEventArgs): void; + } + + export interface ChangeEventArgs { - /** returns the current value. - */ - value?: number; + /** returns the current value. + */ + value?: number; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the rating model - */ - model?: ej.Rating.Model; + /** returns the rating model + */ + model?: ej.Rating.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the mouse click event args values. - */ - event?: any; -} + /** returns the mouse click event args values. + */ + event?: any; + } -export interface ClickEventArgs { + export interface ClickEventArgs { - /** returns the current value. - */ - value?: number; + /** returns the current value. + */ + value?: number; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the rating model - */ - model?: ej.Rating.Model; + /** returns the rating model + */ + model?: ej.Rating.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the mouse click event args values. - */ - event?: any; -} + /** returns the mouse click event args values. + */ + event?: any; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the rating model - */ - model?: ej.Rating.Model; + /** returns the rating model + */ + model?: ej.Rating.Model; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the rating model - */ - model?: ej.Rating.Model; + /** returns the rating model + */ + model?: ej.Rating.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface MouseoutEventArgs { + export interface MouseoutEventArgs { - /** returns the current value. - */ - value?: number; - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the rating model - */ - model?: ej.Rating.Model; - - /** returns the name of the event - */ - type?: string; - - /** returns the mouse click event args values. - */ - event?: any; -} - -export interface MouseoverEventArgs { - - /** returns the current value. - */ - value?: number; - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the rating model - */ - model?: ej.Rating.Model; - - /** returns the name of the event - */ - type?: string; - - /** returns the mouse click event args values. - */ - event?: any; - - /** returns the current index value. - */ - index?: any; -} - -enum Precision { - - ///string - Exact, - - ///string - Full, - - ///string - Half -} - -} - -class Ribbon extends ej.Widget { - static fn: Ribbon; - constructor(element: JQuery | Element, options?: Ribbon.Model); - static Locale: any; - model: Ribbon.Model; - defaults: Ribbon.Model; - - /** Adds contextual tab or contextual tab set dynamically in the ribbon control with contextual tabs object and index position. - * When index is null, ribbon contextual tab or contextual tab set is added at the last index. - * @param {any} contextual tab or contextual tab set object. - * @param {number} index of the contextual tab or contextual tab set, this is optional. - * @returns {void} - */ - addContextualTabs(contextualTabSet: any, index?: number): void; - - /** Add new option to Backstage page. - * @param {any} select the object to add the backstage item - * @param {number} index to the backstage item this is optional. - * @returns {void} - */ - addBackStageItem(item: any, index?: number): void; - - /** Adds tab dynamically in the ribbon control with given name, tab group array and index position. When index is null, ribbon tab is added at the last index. - * @param {string} ribbon tab display text. - * @param {Array} groups to be displayed in ribbon tab . - * @param {number} index of the ribbon tab,this is optional. - * @returns {void} - */ - addTab(tabText: string, ribbonGroups: any[], index?: number): void; - - /** Adds tab group dynamically in the ribbon control with given tab index, tab group object and group index position. When group index is null, ribbon group is added at the last index. - * @param {number} ribbon tab index. - * @param {any} group to be displayed in ribbon tab . - * @param {number} index of the ribbon group,this is optional. - * @returns {void} - */ - addTabGroup(tabIndex: number, tabGroup: any, groupIndex?: number): void; - - /** Adds group content dynamically in the ribbon control with given tab index, group index, sub group index, content and content index position. - * When content index is null, content is added at the last index. - * @param {number} ribbon tab index. - * @param {number} ribbon group index. - * @param {any} content to be displayed in the ribbon group. - * @param {number} ribbon content index. This is optional. If the value is not given, then by default contentIndex will be considered as 0. - * @param {number} sub group index in the ribbon group. This is optional. If the value is not given, then by default contentIndex will be considered as 0. - * @returns {void} - */ - addTabGroupContent(tabIndex: number, groupIndex: number, content: any, contentIndex?: number, subGroupIndex?: number): void; - - /** Hides the ribbon backstage page. - * @returns {void} - */ - hideBackstage(): void; - - /** Collapses the ribbon tab content. - * @returns {void} - */ - collapse(): void; - - /** Destroys the ribbon widget. All the events bound using this._on are unbound automatically and the ribbon control is moved to pre-init state. - * @returns {void} - */ - destroy(): void; - - /** Expands the ribbon tab content. - * @returns {void} - */ - expand(): void; - - /** Gets text of the given index tab in the ribbon control. - * @param {number} index of the tab item. - * @returns {String} - */ - getTabText(index: number): string; - - /** Hides the given text tab in the ribbon control. - * @param {string} text of the tab item. - * @returns {void} - */ - hideTab(text: string): void; - - /** Checks whether the given text tab in the ribbon control is enabled or not. - * @param {string} text of the tab item. - * @returns {Boolean} - */ - isEnable(text: string): boolean; - - /** Checks whether the given text tab in the ribbon control is visible or not. - * @param {string} text of the tab item. - * @returns {Boolean} - */ - isVisible(text: string): boolean; - - /** Removes the given index tab item from the ribbon control. - * @param {number} index of tab item. - * @returns {void} - */ - removeTab(index: number): void; - - /** Sets new text to the given text tab in the ribbon control. - * @param {string} current text of the tab item. - * @param {string} new text of the tab item. - * @returns {void} - */ - setTabText(tabText: string, newText: string): void; - - /** Displays the ribbon backstage page. - * @returns {void} - */ - showBackstage(): void; - - /** Displays the given text tab in the ribbon control. - * @param {string} text of the tab item. - * @returns {void} - */ - showTab(text: string): void; - - /** To customize Group alone in the inside content. - * @param {number} ribbon tab index. - * @param {string} group id to be displayed in ribbon tab . - * @param {any} contentGroup is used in the object - * @returns {void} - */ - updateGroup(tabIndex: number, groupId: string, contentGroup?: any): void; - - /** Update option in existing Backstage. - * @param {number} index to the backstage item - * @param {any} select the object to add the backstage item - * @returns {void} - */ - updateBackStageItem(index: number, item?: any): void; - - /** To customize whole content from Tab Group. - * @param {number} ribbon tab index. - * @param {string} ribbon group text. - * @param {number} ribbon content index. This is optional. If the value is not given, all content groups will be removed. - * @param {number} sub group index in the ribbon group. This is optional. If the value is not given, all content groups will be removed. - * @returns {void} - */ - removeTabGroupContent(tabIndex: number, groupText: string, contentIndex?: number, subGroupIndex?: number): void; - - /** Remove option from Backstage. - * @param {number} index to the backstage item - * @returns {void} - */ - removeBackStageItem(index: number): void; -} -export namespace Ribbon { - -export interface Model { - - /** Enables the ribbon resize feature.allowResizing is a deprecated property of isResponsive. - * @Default {false} - */ - allowResizing?: boolean; - - /** When set to true, adapts the Ribbon layout to fit the screen size of devices on which it renders. - * @Default {false} - */ - isResponsive?: boolean; - - /** Specifies the height, width, enableRTL, showRoundedCorner,enabled,cssClass property to the controls in the ribbon commonly andit will work only when those properties - * are not defined in buttonSettings and content defaults. - * @Default {Object} - */ - buttonDefaults?: any; - - /** Property to enable the ribbon quick access toolbar. - * @Default {false} - */ - showQAT?: boolean; - - /** Sets custom setting to the collapsible pin in the ribbon. - * @Default {Object} - */ - collapsePinSettings?: CollapsePinSettings; - - /** Set enableOnDemand as true to load ribbon tab and backstage contents while corresponding item clicked. - * @Default {false} - */ - enableOnDemand?: boolean; - - /** Set collapsible property as true to render ribbon in initially collapsed state. - * @Default {false} - */ - collapsible?: boolean; - - /** Align content in the ribbon control from right to left by setting the property as true. - * @Default {false} - */ - enableRTL?: boolean; - - /** Sets custom setting to the expandable pin in the ribbon. - * @Default {Object} - */ - expandPinSettings?: ExpandPinSettings; - - /** Specifies the application tab to contain application menu or backstage page in the ribbon control. - * @Default {Object} - */ - applicationTab?: ApplicationTab; - - /** Specifies the contextual tabs and tab set to the ribbon control with the background color and border color. Refer to the tabs section for adding tabs - * into the contextual tab and contextual tab set. - * @Default {Array} - */ - contextualTabs?: ContextualTab[]; - - /** Specifies the index or indexes to disable the given index tab or indexes tabs in the ribbon control. - * @Default {0} - */ - disabledItemIndex?: any[]; - - /** Specifies the index or indexes to enable the given index tab or indexes tabs in the ribbon control. - * @Default {null} - */ - enabledItemIndex?: any[]; - - /** Specifies the index of the ribbon tab to select the given index tab item in the ribbon control. - * @Default {1} - */ - selectedItemIndex?: number; - - /** Specifies the tabs and its groups. Also specifies the control details that has to be placed in the tab area in the ribbon control. - * @Default {Array} - */ - tabs?: Tab[]; - - /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and culture specific - * to a particular country or region and it will need to use the user's preference. - * @Default {en-US} - */ - locale?: string; - - /** Specifies the width to the ribbon control. You can set width in string or number format. - * @Default {null} - */ - width?: string|number; + /** returns the current value. + */ + value?: number; + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the rating model + */ + model?: ej.Rating.Model; + + /** returns the name of the event + */ + type?: string; + + /** returns the mouse click event args values. + */ + event?: any; + } + + export interface MouseoverEventArgs { + + /** returns the current value. + */ + value?: number; + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the rating model + */ + model?: ej.Rating.Model; + + /** returns the name of the event + */ + type?: string; + + /** returns the mouse click event args values. + */ + event?: any; + + /** returns the current index value. + */ + index?: any; + } + + enum Precision { + + ///string + Exact, + + ///string + Full, + + ///string + Half + } + + } + + class Ribbon extends ej.Widget { + static fn: Ribbon; + constructor(element: JQuery | Element, options?: Ribbon.Model); + static Locale: any; + model: Ribbon.Model; + defaults: Ribbon.Model; + + /** Adds contextual tab or contextual tab set dynamically in the ribbon control with contextual tabs object and index position. + * When index is null, ribbon contextual tab or contextual tab set is added at the last index. + * @param {any} contextual tab or contextual tab set object. + * @param {number} index of the contextual tab or contextual tab set, this is optional. + * @returns {void} + */ + addContextualTabs(contextualTabSet: any, index?: number): void; + + /** Add new option to Backstage page. + * @param {any} select the object to add the backstage item + * @param {number} index to the backstage item this is optional. + * @returns {void} + */ + addBackStageItem(item: any, index?: number): void; + + /** Adds tab dynamically in the ribbon control with given name, tab group array and index position. When index is null, ribbon tab is added at the last index. + * @param {string} ribbon tab display text. + * @param {Array} groups to be displayed in ribbon tab . + * @param {number} index of the ribbon tab,this is optional. + * @returns {void} + */ + addTab(tabText: string, ribbonGroups: any[], index?: number): void; + + /** Adds tab group dynamically in the ribbon control with given tab index, tab group object and group index position. When group index is null, ribbon group is added at the last index. + * @param {number} ribbon tab index. + * @param {any} group to be displayed in ribbon tab . + * @param {number} index of the ribbon group,this is optional. + * @returns {void} + */ + addTabGroup(tabIndex: number, tabGroup: any, groupIndex?: number): void; + + /** Adds group content dynamically in the ribbon control with given tab index, group index, sub group index, content and content index position. + * When content index is null, content is added at the last index. + * @param {number} ribbon tab index. + * @param {number} ribbon group index. + * @param {any} content to be displayed in the ribbon group. + * @param {number} ribbon content index. This is optional. If the value is not given, then by default contentIndex will be considered as 0. + * @param {number} sub group index in the ribbon group. This is optional. If the value is not given, then by default contentIndex will be considered as 0. + * @returns {void} + */ + addTabGroupContent(tabIndex: number, groupIndex: number, content: any, contentIndex?: number, subGroupIndex?: number): void; + + /** Hides the ribbon backstage page. + * @returns {void} + */ + hideBackstage(): void; + + /** Collapses the ribbon tab content. + * @returns {void} + */ + collapse(): void; + + /** Destroys the ribbon widget. All the events bound using this._on are unbound automatically and the ribbon control is moved to pre-init state. + * @returns {void} + */ + destroy(): void; + + /** Expands the ribbon tab content. + * @returns {void} + */ + expand(): void; + + /** Gets text of the given index tab in the ribbon control. + * @param {number} index of the tab item. + * @returns {String} + */ + getTabText(index: number): string; + + /** Hides the given text tab in the ribbon control. + * @param {string} text of the tab item. + * @returns {void} + */ + hideTab(text: string): void; + + /** Checks whether the given text tab in the ribbon control is enabled or not. + * @param {string} text of the tab item. + * @returns {Boolean} + */ + isEnable(text: string): boolean; + + /** Checks whether the given text tab in the ribbon control is visible or not. + * @param {string} text of the tab item. + * @returns {Boolean} + */ + isVisible(text: string): boolean; + + /** Removes the given index tab item from the ribbon control. + * @param {number} index of tab item. + * @returns {void} + */ + removeTab(index: number): void; + + /** Sets new text to the given text tab in the ribbon control. + * @param {string} current text of the tab item. + * @param {string} new text of the tab item. + * @returns {void} + */ + setTabText(tabText: string, newText: string): void; + + /** Displays the ribbon backstage page. + * @returns {void} + */ + showBackstage(): void; + + /** Displays the given text tab in the ribbon control. + * @param {string} text of the tab item. + * @returns {void} + */ + showTab(text: string): void; + + /** To customize Group alone in the inside content. + * @param {number} ribbon tab index. + * @param {string} group id to be displayed in ribbon tab . + * @param {any} contentGroup is used in the object + * @returns {void} + */ + updateGroup(tabIndex: number, groupId: string, contentGroup?: any): void; + + /** Update option in existing Backstage. + * @param {number} index to the backstage item + * @param {any} select the object to add the backstage item + * @returns {void} + */ + updateBackStageItem(index: number, item?: any): void; + + /** To customize whole content from Tab Group. + * @param {number} ribbon tab index. + * @param {string} ribbon group text. + * @param {number} ribbon content index. This is optional. If the value is not given, all content groups will be removed. + * @param {number} sub group index in the ribbon group. This is optional. If the value is not given, all content groups will be removed. + * @returns {void} + */ + removeTabGroupContent(tabIndex: number, groupText: string, contentIndex?: number, subGroupIndex?: number): void; + + /** Remove option from Backstage. + * @param {number} index to the backstage item + * @returns {void} + */ + removeBackStageItem(index: number): void; + } + export namespace Ribbon { + + export interface Model { + + /** Enables the ribbon resize feature.allowResizing is a deprecated property of isResponsive. + * @Default {false} + */ + allowResizing?: boolean; + + /** When set to true, adapts the Ribbon layout to fit the screen size of devices on which it renders. + * @Default {false} + */ + isResponsive?: boolean; + + /** Specifies the height, width, enableRTL, showRoundedCorner,enabled,cssClass property to the controls in the ribbon commonly andit will work only when those properties + * are not defined in buttonSettings and content defaults. + * @Default {Object} + */ + buttonDefaults?: any; + + /** Property to enable the ribbon quick access toolbar. + * @Default {false} + */ + showQAT?: boolean; + + /** Sets custom setting to the collapsible pin in the ribbon. + * @Default {Object} + */ + collapsePinSettings?: CollapsePinSettings; + + /** Set enableOnDemand as true to load ribbon tab and backstage contents while corresponding item clicked. + * @Default {false} + */ + enableOnDemand?: boolean; + + /** Set collapsible property as true to render ribbon in initially collapsed state. + * @Default {false} + */ + collapsible?: boolean; + + /** Align content in the ribbon control from right to left by setting the property as true. + * @Default {false} + */ + enableRTL?: boolean; + + /** Sets custom setting to the expandable pin in the ribbon. + * @Default {Object} + */ + expandPinSettings?: ExpandPinSettings; + + /** Specifies the application tab to contain application menu or backstage page in the ribbon control. + * @Default {Object} + */ + applicationTab?: ApplicationTab; + + /** Specifies the contextual tabs and tab set to the ribbon control with the background color and border color. Refer to the tabs section for adding tabs + * into the contextual tab and contextual tab set. + * @Default {Array} + */ + contextualTabs?: ContextualTab[]; + + /** Specifies the index or indexes to disable the given index tab or indexes tabs in the ribbon control. + * @Default {0} + */ + disabledItemIndex?: any[]; + + /** Specifies the index or indexes to enable the given index tab or indexes tabs in the ribbon control. + * @Default {null} + */ + enabledItemIndex?: any[]; + + /** Specifies the index of the ribbon tab to select the given index tab item in the ribbon control. + * @Default {1} + */ + selectedItemIndex?: number; + + /** Specifies the tabs and its groups. Also specifies the control details that has to be placed in the tab area in the ribbon control. + * @Default {Array} + */ + tabs?: Tab[]; + + /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and culture specific + * to a particular country or region and it will need to use the user's preference. + * @Default {en-US} + */ + locale?: string; + + /** Specifies the width to the ribbon control. You can set width in string or number format. + * @Default {null} + */ + width?: string | number; - /** Triggered before the ribbon tab item is removed. */ - beforeTabRemove?(e: BeforeTabRemoveEventArgs): void; - - /** Triggered before the ribbon control is created. */ - create?(e: CreateEventArgs): void; + /** Triggered before the ribbon tab item is removed. */ + beforeTabRemove?(e: BeforeTabRemoveEventArgs): void; + + /** Triggered before the ribbon control is created. */ + create?(e: CreateEventArgs): void; - /** Triggered before the ribbon control is destroyed. */ - destroy?(e: DestroyEventArgs): void; + /** Triggered before the ribbon control is destroyed. */ + destroy?(e: DestroyEventArgs): void; - /** Triggered when the control in the group is clicked successfully. */ - groupClick?(e: GroupClickEventArgs): void; + /** Triggered when the control in the group is clicked successfully. */ + groupClick?(e: GroupClickEventArgs): void; - /** Triggered when the group expander in the group is clicked successfully. */ - groupExpand?(e: GroupExpandEventArgs): void; + /** Triggered when the group expander in the group is clicked successfully. */ + groupExpand?(e: GroupExpandEventArgs): void; - /** Triggered when an item in the Gallery control is clicked successfully. */ - galleryItemClick?(e: GalleryItemClickEventArgs): void; + /** Triggered when an item in the Gallery control is clicked successfully. */ + galleryItemClick?(e: GalleryItemClickEventArgs): void; - /** Triggered when a tab or button in the backstage page is clicked successfully. */ - backstageItemClick?(e: BackstageItemClickEventArgs): void; + /** Triggered when a tab or button in the backstage page is clicked successfully. */ + backstageItemClick?(e: BackstageItemClickEventArgs): void; - /** Triggered when the ribbon control is collapsed. */ - collapse?(e: CollapseEventArgs): void; + /** Triggered when the ribbon control is collapsed. */ + collapse?(e: CollapseEventArgs): void; - /** Triggered when the ribbon control is expanded. */ - expand?(e: ExpandEventArgs): void; + /** Triggered when the ribbon control is expanded. */ + expand?(e: ExpandEventArgs): void; - /** Triggered before the ribbon control is load. */ - load?(e: LoadEventArgs): void; + /** Triggered before the ribbon control is load. */ + load?(e: LoadEventArgs): void; - /** Triggered after adding the new ribbon tab item. */ - tabAdd?(e: TabAddEventArgs): void; + /** Triggered after adding the new ribbon tab item. */ + tabAdd?(e: TabAddEventArgs): void; - /** Triggered when tab is clicked successfully in the ribbon control. */ - tabClick?(e: TabClickEventArgs): void; + /** Triggered when tab is clicked successfully in the ribbon control. */ + tabClick?(e: TabClickEventArgs): void; - /** Triggered before the ribbon tab is created. */ - tabCreate?(e: TabCreateEventArgs): void; + /** Triggered before the ribbon tab is created. */ + tabCreate?(e: TabCreateEventArgs): void; - /** Triggered after the tab item is removed from the ribbon control. */ - tabRemove?(e: TabRemoveEventArgs): void; + /** Triggered after the tab item is removed from the ribbon control. */ + tabRemove?(e: TabRemoveEventArgs): void; - /** Triggered after the ribbon tab item is selected in the ribbon control. */ - tabSelect?(e: TabSelectEventArgs): void; + /** Triggered after the ribbon tab item is selected in the ribbon control. */ + tabSelect?(e: TabSelectEventArgs): void; - /** Triggered when the expand/collapse button is clicked successfully . */ - toggleButtonClick?(e: ToggleButtonClickEventArgs): void; + /** Triggered when the expand/collapse button is clicked successfully . */ + toggleButtonClick?(e: ToggleButtonClickEventArgs): void; - /** Triggered when the QAT menu item is clicked successfully . */ - qatMenuItemClick?(e: QatMenuItemClickEventArgs): void; -} + /** Triggered when the QAT menu item is clicked successfully . */ + qatMenuItemClick?(e: QatMenuItemClickEventArgs): void; + } -export interface BeforeTabRemoveEventArgs { + export interface BeforeTabRemoveEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the ribbon model. - */ - model?: any; + /** returns the ribbon model. + */ + model?: any; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns current tab item index in the ribbon control. - */ - index?: number; -} + /** returns current tab item index in the ribbon control. + */ + index?: number; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the ribbon model. - */ - model?: any; + /** returns the ribbon model. + */ + model?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the ribbon model. - */ - model?: any; + /** returns the ribbon model. + */ + model?: any; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns current ribbon tab item index - */ - deleteIndex?: number; -} + /** returns current ribbon tab item index + */ + deleteIndex?: number; + } -export interface GroupClickEventArgs { + export interface GroupClickEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the ribbon model. - */ - model?: any; + /** returns the ribbon model. + */ + model?: any; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the control clicked in the group. - */ - target?: number; -} + /** returns the control clicked in the group. + */ + target?: number; + } -export interface GroupExpandEventArgs { + export interface GroupExpandEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the ribbon model. - */ - model?: any; + /** returns the ribbon model. + */ + model?: any; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the clicked group expander. - */ - target?: number; -} + /** returns the clicked group expander. + */ + target?: number; + } -export interface GalleryItemClickEventArgs { + export interface GalleryItemClickEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the ribbon model. - */ - model?: any; + /** returns the ribbon model. + */ + model?: any; - /** returns the gallery model. - */ - galleryModel?: any; + /** returns the gallery model. + */ + galleryModel?: any; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the item clicked in the gallery. - */ - target?: number; -} + /** returns the item clicked in the gallery. + */ + target?: number; + } -export interface BackstageItemClickEventArgs { + export interface BackstageItemClickEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the ribbon model. - */ - model?: any; + /** returns the ribbon model. + */ + model?: any; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the item clicked in the gallery. - */ - target?: number; + /** returns the item clicked in the gallery. + */ + target?: number; - /** returns the id of the target item. - */ - id?: string; + /** returns the id of the target item. + */ + id?: string; - /** returns the text of the target item. - */ - text?: string; -} + /** returns the text of the target item. + */ + text?: string; + } -export interface CollapseEventArgs { + export interface CollapseEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the ribbon model. - */ - model?: any; + /** returns the ribbon model. + */ + model?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface ExpandEventArgs { + export interface ExpandEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the ribbon model. - */ - model?: any; + /** returns the ribbon model. + */ + model?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface LoadEventArgs { + export interface LoadEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the ribbon model. - */ - model?: any; + /** returns the ribbon model. + */ + model?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface TabAddEventArgs { + export interface TabAddEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the ribbon model. - */ - model?: any; + /** returns the ribbon model. + */ + model?: any; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns new added tab header. - */ - tabHeader?: any; + /** returns new added tab header. + */ + tabHeader?: any; - /** returns new added tab content panel. - */ - tabContent?: any; -} + /** returns new added tab content panel. + */ + tabContent?: any; + } -export interface TabClickEventArgs { + export interface TabClickEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the ribbon model. - */ - model?: any; + /** returns the ribbon model. + */ + model?: any; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns previous active tab header. - */ - prevActiveHeader?: any; + /** returns previous active tab header. + */ + prevActiveHeader?: any; - /** returns previous active index. - */ - prevActiveIndex?: number; + /** returns previous active index. + */ + prevActiveIndex?: number; - /** returns current active tab header . - */ - activeHeader?: any; + /** returns current active tab header . + */ + activeHeader?: any; - /** returns current active index. - */ - activeIndex?: number; -} + /** returns current active index. + */ + activeIndex?: number; + } -export interface TabCreateEventArgs { + export interface TabCreateEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the ribbon model. - */ - model?: any; + /** returns the ribbon model. + */ + model?: any; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns current ribbon tab item index - */ - deleteIndex?: number; -} + /** returns current ribbon tab item index + */ + deleteIndex?: number; + } -export interface TabRemoveEventArgs { + export interface TabRemoveEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the ribbon model. - */ - model?: any; + /** returns the ribbon model. + */ + model?: any; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the removed index. - */ - removedIndex?: number; -} + /** returns the removed index. + */ + removedIndex?: number; + } -export interface TabSelectEventArgs { + export interface TabSelectEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the ribbon model. - */ - model?: any; + /** returns the ribbon model. + */ + model?: any; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns previous active tab header. - */ - prevActiveHeader?: any; + /** returns previous active tab header. + */ + prevActiveHeader?: any; - /** returns previous active index. - */ - prevActiveIndex?: number; + /** returns previous active index. + */ + prevActiveIndex?: number; - /** returns current active tab header . - */ - activeHeader?: any; + /** returns current active tab header . + */ + activeHeader?: any; - /** returns current active index. - */ - activeIndex?: number; -} + /** returns current active index. + */ + activeIndex?: number; + } -export interface ToggleButtonClickEventArgs { + export interface ToggleButtonClickEventArgs { - /** Set to true when the event has to be canceled, else false. - */ - cancel?: boolean; + /** Set to true when the event has to be canceled, else false. + */ + cancel?: boolean; - /** returns the ribbon model. - */ - model?: any; + /** returns the ribbon model. + */ + model?: any; - /** returns the name of the event. - */ - type?: string; - - /** returns the expand/collapse button. - */ - target?: number; -} - -export interface QatMenuItemClickEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the ribbon model. - */ - model?: any; - - /** returns the name of the event. - */ - type?: string; - - /** returns the clicked menu item text. - */ - text?: string; -} - -export interface CollapsePinSettings { - - /** Sets tooltip for the collapse pin . - * @Default {null} - */ - toolTip?: string; - - /** Specifies the custom tooltip for collapse pin.Refer to ejRibbon#tabs->groups->content->groups->customToolTip for its inner properties. - * @Default {Object} - */ - customToolTip?: any; -} - -export interface ExpandPinSettings { - - /** Sets tooltip for the expand pin. - * @Default {null} - */ - toolTip?: string; - - /** Specifies the custom tooltip for expand pin.Refer to ejRibbon#tabs->groups->content->groups->customToolTip for its inner properties. - * @Default {Object} - */ - customToolTip?: any; -} - -export interface ApplicationTabBackstageSettingsPage { - - /** Specifies the id for ribbon backstage page's tab and button elements. - * @Default {null} - */ - id?: string; - - /** Specifies the text for ribbon backstage page's tab header and button elements. - * @Default {null} - */ - text?: string; - - /** Specifies the type for ribbon backstage page's contents. Set "ej.Ribbon.BackStageItemType.Tab" to render the tab or " - * ej.Ribbon.BackStageItemType.Button" to render the button. - * @Default {ej.Ribbon.ItemType.Tab} - */ - itemType?: ej.Ribbon.ItemType|string; - - /** Specifies the id of HTML elements like div,ul, etc., as ribbon backstage page's tab content. - * @Default {null} - */ - contentID?: string; - - /** Specifies the separator between backstage page's tab and button elements. - * @Default {false} - */ - enableSeparator?: boolean; -} - -export interface ApplicationTabBackstageSettings { - - /** Specifies the display text of application tab. - * @Default {null} - */ - text?: string; - - /** Specifies the height of ribbon backstage page. - * @Default {null} - */ - height?: string|number; - - /** Specifies the width of ribbon backstage page. - * @Default {null} - */ - width?: string|number; - - /** Specifies the ribbon backstage page with its tab and button elements. - * @Default {Array} - */ - pages?: ApplicationTabBackstageSettingsPage[]; - - /** Specifies the width of backstage page header that contains tabs and buttons. - * @Default {null} - */ - headerWidth?: string|number; -} - -export interface ApplicationTab { - - /** Specifies the ribbon backstage page items. - * @Default {Object} - */ - backstageSettings?: ApplicationTabBackstageSettings; - - /** Specifies the ID of ul list to create application menu in the ribbon control. - * @Default {null} - */ - menuItemID?: string; - - /** Specifies the menu members, events by using the menu settings for the menu in the application tab. - * @Default {Object} - */ - menuSettings?: any; - - /** Specifies the application menu or backstage page. Specify the type of application tab as "ej.Ribbon.ApplicationTabType.Menu" to render the application menu or - * "ej.Ribbon.ApplicationTabType.Backstage" to render backstage page in the ribbon control. - * @Default {ej.Ribbon.ApplicationTabType.Menu} - */ - type?: ej.Ribbon.ApplicationTabType|string; -} - -export interface ContextualTab { - - /** Specifies the backgroundColor of the contextual tabs and tab set in the ribbon control. - * @Default {null} - */ - backgroundColor?: string; - - /** Specifies the borderColor of the contextual tabs and tab set in the ribbon control. - * @Default {null} - */ - borderColor?: string; - - /** Specifies the tabs to present in the contextual tabs and tab set. Refer to the tabs section for adding tabs into the contextual tabs and tab set. - * @Default {Array} - */ - tabs?: any[]; -} - -export interface TabsGroupsContentDefaults { - - /** Specifies the controls height such as Syncfusion button,split button,dropdown list,toggle button in the subgroup of the ribbon tab. - * @Default {null} - */ - height?: string|number; - - /** Specifies the controls width such as Syncfusion button,split button,dropdown list,toggle button in the subgroup of the ribbon tab. - * @Default {null} - */ - width?: string|number; - - /** Specifies the controls type such as Syncfusion button,split button,dropdown list,toggle button in the subgroup of the ribbon tab. - * @Default {ej.Ribbon.Type.Button} - */ - type?: string; - - /** Specifies the controls size such as Syncfusion button,split button,dropdown list,toggle button in the subgroup of the ribbon tab. - * @Default {false} - */ - isBig?: boolean; -} - -export interface TabsGroupsContentGroupsCustomGalleryItem { - - /** Specifies the Syncfusion button members, events by using buttonSettings. - * @Default {Object} - */ - buttonSettings?: any; - - /** Specifies the type as ej.Ribbon.CustomItemType.Menu or ej.Ribbon.CustomItemType.Button to render Syncfusion button and menu. - * @Default {ej.Ribbon.CustomItemType.Button} - */ - customItemType?: ej.Ribbon.CustomItemType|string; - - /** Specifies the custom tooltip for gallery extra item's button. Refer to ejRibbon#tabs->groups->content->groups->customToolTip for its inner properties. - * @Default {Object} - */ - customToolTip?: any; - - /** Specifies the UL list id to render menu as gallery extra item. - * @Default {null} - */ - menuId?: string; - - /** Specifies the Syncfusion menu members, events by using menuSettings. - * @Default {Object} - */ - menuSettings?: any; - - /** Specifies the text for gallery extra item's button. - * @Default {null} - */ - text?: string; - - /** Specifies the tooltip for gallery extra item's button. - * @Default {null} - */ - toolTip?: string; -} - -export interface TabsGroupsContentGroupsCustomToolTip { - - /** Sets content to the custom tooltip. Text and HTML support are provided for content. - * @Default {null} - */ - content?: string; - - /** Sets icon to the custom tooltip content. - * @Default {null} - */ - prefixIcon?: string; - - /** Sets title to the custom tooltip. Text and HTML support are provided for title and the title is in bold for text format. - * @Default {null} - */ - title?: string; -} - -export interface TabsGroupsContentGroupsGalleryItem { - - /** Specifies the Syncfusion button members, events by using buttonSettings. - * @Default {Object} - */ - buttonSettings?: any; - - /** Specifies the custom tooltip for gallery content. Refer to ejRibbon#tabs->groups->content->groups->customToolTip for its inner properties. - * @Default {Object} - */ - customToolTip?: any; - - /** Sets text for the gallery content. - * @Default {null} - */ - text?: string; - - /** Sets tooltip for the gallery content. - * @Default {null} - */ - toolTip?: string; -} - -export interface TabsGroupsContentGroup { - - /** When isMobileOnly is true,its shows in mobile toolbar.isResponsive should be true for using this property. - * @Default {false} - */ - isMobileOnly?: boolean; - - /** Specifies the Syncfusion button members, events by using this buttonSettings. - * @Default {Object} - */ - buttonSettings?: any; - - /** It is used to set the count of gallery contents in a row. - * @Default {null} - */ - columns?: number; - - /** Specifies the custom items such as div, table, controls as custom controls with the type "ej.Ribbon.Type.Custom" in the groups. - * @Default {null} - */ - contentID?: string; - - /** Specifies the CSS class property to apply styles to the button, split, dropdown controls in the groups. - * @Default {null} - */ - cssClass?: string; - - /** Specifies the Syncfusion button and menu as gallery extra items. - * @Default {Array} - */ - customGalleryItems?: TabsGroupsContentGroupsCustomGalleryItem[]; - - /** Provides custom tooltip for button, split button, dropdown list, toggle button, custom controls in the sub groups. Text and HTML support are also provided for title and content. - * @Default {Object} - */ - customToolTip?: TabsGroupsContentGroupsCustomToolTip; - - /** Specifies the Syncfusion dropdown list members, events by using this dropdownSettings. - * @Default {Object} - */ - dropdownSettings?: any; - - /** Specifies the separator to the control that is in row type group. The separator separates the control from the next control in the group. Set "true" to enable the separator. - * @Default {false} - */ - enableSeparator?: boolean; - - /** Sets the count of gallery contents in a row, when the gallery is in expanded state. - * @Default {null} - */ - expandedColumns?: number; - - /** Defines each gallery content. - * @Default {Array} - */ - galleryItems?: TabsGroupsContentGroupsGalleryItem[]; - - /** Specifies the Id for button, split button, dropdown list, toggle button, gallery, custom controls in the sub groups. - * @Default {null} - */ - id?: string; - - /** Specifies the size for button, split button controls. Set "true" for big size and "false" for small size. - * @Default {null} - */ - isBig?: boolean; - - /** Sets the height of each gallery content. - * @Default {null} - */ - itemHeight?: string|number; - - /** Sets the width of each gallery content. - * @Default {null} - */ - itemWidth?: string|number; - - /** Specifies the Syncfusion split button members, events by using this splitButtonSettings. - * @Default {Object} - */ - splitButtonSettings?: any; - - /** Specifies the text for button, split button, toggle button controls in the sub groups. - * @Default {null} - */ - text?: string; - - /** Specifies the Syncfusion toggle button members, events by using toggleButtonSettings. - * @Default {Object} - */ - toggleButtonSettings?: any; - - /** Specifies the tooltip for button, split button, dropdown list, toggle button, custom controls in the sub groups. - * @Default {null} - */ - toolTip?: string; - - /** To add,show and hide controls in Quick Access toolbar. - * @Default {ej.Ribbon.QuickAccessMode.None} - */ - quickAccessMode?: ej.Ribbon.QuickAccessMode|string; - - /** Specifies the type as "ej.Ribbon.Type.Button" or "ej.Ribbon.Type.SplitButton" or "ej.Ribbon.Type.DropDownList" or "ej.Ribbon.Type.ToggleButton" - * or "ej.Ribbon.Type.Custom" or "ej.Ribbon.Type.Gallery" to render button, split, dropdown, toggle button, gallery, custom controls. - * @Default {ej.Ribbon.Type.Button} - */ - type?: ej.Ribbon.Type|string; -} - -export interface TabsGroupsContent { - - /** Specifies the height, width, type, isBig property to the controls in the group commonly. - * @Default {Object} - */ - defaults?: TabsGroupsContentDefaults; - - /** Specifies the controls such as Syncfusion button, split button, dropdown list, toggle button, gallery, custom controls in the subgroup of the ribbon tab . - * @Default {Array} - */ - groups?: TabsGroupsContentGroup[]; -} - -export interface TabsGroupsGroupExpanderSettings { - - /** Sets tooltip for the group expander of the group. - * @Default {null} - */ - toolTip?: string; - - /** Specifies the custom tooltip for group expander.Refer to ejRibbon#tabs->groups->content->groups->customToolTip for its inner properties. - * @Default {Object} - */ - customToolTip?: any; -} - -export interface TabsGroup { + /** returns the name of the event. + */ + type?: string; + + /** returns the expand/collapse button. + */ + target?: number; + } + + export interface QatMenuItemClickEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the ribbon model. + */ + model?: any; + + /** returns the name of the event. + */ + type?: string; + + /** returns the clicked menu item text. + */ + text?: string; + } + + export interface CollapsePinSettings { + + /** Sets tooltip for the collapse pin . + * @Default {null} + */ + toolTip?: string; + + /** Specifies the custom tooltip for collapse pin.Refer to ejRibbon#tabs->groups->content->groups->customToolTip for its inner properties. + * @Default {Object} + */ + customToolTip?: any; + } + + export interface ExpandPinSettings { + + /** Sets tooltip for the expand pin. + * @Default {null} + */ + toolTip?: string; + + /** Specifies the custom tooltip for expand pin.Refer to ejRibbon#tabs->groups->content->groups->customToolTip for its inner properties. + * @Default {Object} + */ + customToolTip?: any; + } + + export interface ApplicationTabBackstageSettingsPage { + + /** Specifies the id for ribbon backstage page's tab and button elements. + * @Default {null} + */ + id?: string; + + /** Specifies the text for ribbon backstage page's tab header and button elements. + * @Default {null} + */ + text?: string; + + /** Specifies the type for ribbon backstage page's contents. Set "ej.Ribbon.BackStageItemType.Tab" to render the tab or " + * ej.Ribbon.BackStageItemType.Button" to render the button. + * @Default {ej.Ribbon.ItemType.Tab} + */ + itemType?: ej.Ribbon.ItemType | string; + + /** Specifies the id of HTML elements like div,ul, etc., as ribbon backstage page's tab content. + * @Default {null} + */ + contentID?: string; + + /** Specifies the separator between backstage page's tab and button elements. + * @Default {false} + */ + enableSeparator?: boolean; + } + + export interface ApplicationTabBackstageSettings { + + /** Specifies the display text of application tab. + * @Default {null} + */ + text?: string; + + /** Specifies the height of ribbon backstage page. + * @Default {null} + */ + height?: string | number; + + /** Specifies the width of ribbon backstage page. + * @Default {null} + */ + width?: string | number; + + /** Specifies the ribbon backstage page with its tab and button elements. + * @Default {Array} + */ + pages?: ApplicationTabBackstageSettingsPage[]; + + /** Specifies the width of backstage page header that contains tabs and buttons. + * @Default {null} + */ + headerWidth?: string | number; + } + + export interface ApplicationTab { + + /** Specifies the ribbon backstage page items. + * @Default {Object} + */ + backstageSettings?: ApplicationTabBackstageSettings; + + /** Specifies the ID of ul list to create application menu in the ribbon control. + * @Default {null} + */ + menuItemID?: string; + + /** Specifies the menu members, events by using the menu settings for the menu in the application tab. + * @Default {Object} + */ + menuSettings?: any; + + /** Specifies the application menu or backstage page. Specify the type of application tab as "ej.Ribbon.ApplicationTabType.Menu" to render the application menu or + * "ej.Ribbon.ApplicationTabType.Backstage" to render backstage page in the ribbon control. + * @Default {ej.Ribbon.ApplicationTabType.Menu} + */ + type?: ej.Ribbon.ApplicationTabType | string; + } + + export interface ContextualTab { + + /** Specifies the backgroundColor of the contextual tabs and tab set in the ribbon control. + * @Default {null} + */ + backgroundColor?: string; + + /** Specifies the borderColor of the contextual tabs and tab set in the ribbon control. + * @Default {null} + */ + borderColor?: string; + + /** Specifies the tabs to present in the contextual tabs and tab set. Refer to the tabs section for adding tabs into the contextual tabs and tab set. + * @Default {Array} + */ + tabs?: any[]; + } + + export interface TabsGroupsContentDefaults { + + /** Specifies the controls height such as Syncfusion button,split button,dropdown list,toggle button in the subgroup of the ribbon tab. + * @Default {null} + */ + height?: string | number; + + /** Specifies the controls width such as Syncfusion button,split button,dropdown list,toggle button in the subgroup of the ribbon tab. + * @Default {null} + */ + width?: string | number; + + /** Specifies the controls type such as Syncfusion button,split button,dropdown list,toggle button in the subgroup of the ribbon tab. + * @Default {ej.Ribbon.Type.Button} + */ + type?: string; + + /** Specifies the controls size such as Syncfusion button,split button,dropdown list,toggle button in the subgroup of the ribbon tab. + * @Default {false} + */ + isBig?: boolean; + } + + export interface TabsGroupsContentGroupsCustomGalleryItem { + + /** Specifies the Syncfusion button members, events by using buttonSettings. + * @Default {Object} + */ + buttonSettings?: any; + + /** Specifies the type as ej.Ribbon.CustomItemType.Menu or ej.Ribbon.CustomItemType.Button to render Syncfusion button and menu. + * @Default {ej.Ribbon.CustomItemType.Button} + */ + customItemType?: ej.Ribbon.CustomItemType | string; + + /** Specifies the custom tooltip for gallery extra item's button. Refer to ejRibbon#tabs->groups->content->groups->customToolTip for its inner properties. + * @Default {Object} + */ + customToolTip?: any; + + /** Specifies the UL list id to render menu as gallery extra item. + * @Default {null} + */ + menuId?: string; + + /** Specifies the Syncfusion menu members, events by using menuSettings. + * @Default {Object} + */ + menuSettings?: any; + + /** Specifies the text for gallery extra item's button. + * @Default {null} + */ + text?: string; + + /** Specifies the tooltip for gallery extra item's button. + * @Default {null} + */ + toolTip?: string; + } + + export interface TabsGroupsContentGroupsCustomToolTip { + + /** Sets content to the custom tooltip. Text and HTML support are provided for content. + * @Default {null} + */ + content?: string; + + /** Sets icon to the custom tooltip content. + * @Default {null} + */ + prefixIcon?: string; + + /** Sets title to the custom tooltip. Text and HTML support are provided for title and the title is in bold for text format. + * @Default {null} + */ + title?: string; + } + + export interface TabsGroupsContentGroupsGalleryItem { + + /** Specifies the Syncfusion button members, events by using buttonSettings. + * @Default {Object} + */ + buttonSettings?: any; + + /** Specifies the custom tooltip for gallery content. Refer to ejRibbon#tabs->groups->content->groups->customToolTip for its inner properties. + * @Default {Object} + */ + customToolTip?: any; + + /** Sets text for the gallery content. + * @Default {null} + */ + text?: string; + + /** Sets tooltip for the gallery content. + * @Default {null} + */ + toolTip?: string; + } + + export interface TabsGroupsContentGroup { + + /** When isMobileOnly is true,its shows in mobile toolbar.isResponsive should be true for using this property. + * @Default {false} + */ + isMobileOnly?: boolean; + + /** Specifies the Syncfusion button members, events by using this buttonSettings. + * @Default {Object} + */ + buttonSettings?: any; + + /** It is used to set the count of gallery contents in a row. + * @Default {null} + */ + columns?: number; + + /** Specifies the custom items such as div, table, controls as custom controls with the type "ej.Ribbon.Type.Custom" in the groups. + * @Default {null} + */ + contentID?: string; + + /** Specifies the CSS class property to apply styles to the button, split, dropdown controls in the groups. + * @Default {null} + */ + cssClass?: string; + + /** Specifies the Syncfusion button and menu as gallery extra items. + * @Default {Array} + */ + customGalleryItems?: TabsGroupsContentGroupsCustomGalleryItem[]; + + /** Provides custom tooltip for button, split button, dropdown list, toggle button, custom controls in the sub groups. Text and HTML support are also provided for title and content. + * @Default {Object} + */ + customToolTip?: TabsGroupsContentGroupsCustomToolTip; + + /** Specifies the Syncfusion dropdown list members, events by using this dropdownSettings. + * @Default {Object} + */ + dropdownSettings?: any; + + /** Specifies the separator to the control that is in row type group. The separator separates the control from the next control in the group. Set "true" to enable the separator. + * @Default {false} + */ + enableSeparator?: boolean; + + /** Sets the count of gallery contents in a row, when the gallery is in expanded state. + * @Default {null} + */ + expandedColumns?: number; + + /** Defines each gallery content. + * @Default {Array} + */ + galleryItems?: TabsGroupsContentGroupsGalleryItem[]; + + /** Specifies the Id for button, split button, dropdown list, toggle button, gallery, custom controls in the sub groups. + * @Default {null} + */ + id?: string; + + /** Specifies the size for button, split button controls. Set "true" for big size and "false" for small size. + * @Default {null} + */ + isBig?: boolean; + + /** Sets the height of each gallery content. + * @Default {null} + */ + itemHeight?: string | number; + + /** Sets the width of each gallery content. + * @Default {null} + */ + itemWidth?: string | number; + + /** Specifies the Syncfusion split button members, events by using this splitButtonSettings. + * @Default {Object} + */ + splitButtonSettings?: any; + + /** Specifies the text for button, split button, toggle button controls in the sub groups. + * @Default {null} + */ + text?: string; + + /** Specifies the Syncfusion toggle button members, events by using toggleButtonSettings. + * @Default {Object} + */ + toggleButtonSettings?: any; + + /** Specifies the tooltip for button, split button, dropdown list, toggle button, custom controls in the sub groups. + * @Default {null} + */ + toolTip?: string; + + /** To add,show and hide controls in Quick Access toolbar. + * @Default {ej.Ribbon.QuickAccessMode.None} + */ + quickAccessMode?: ej.Ribbon.QuickAccessMode | string; + + /** Specifies the type as "ej.Ribbon.Type.Button" or "ej.Ribbon.Type.SplitButton" or "ej.Ribbon.Type.DropDownList" or "ej.Ribbon.Type.ToggleButton" + * or "ej.Ribbon.Type.Custom" or "ej.Ribbon.Type.Gallery" to render button, split, dropdown, toggle button, gallery, custom controls. + * @Default {ej.Ribbon.Type.Button} + */ + type?: ej.Ribbon.Type | string; + } + + export interface TabsGroupsContent { + + /** Specifies the height, width, type, isBig property to the controls in the group commonly. + * @Default {Object} + */ + defaults?: TabsGroupsContentDefaults; + + /** Specifies the controls such as Syncfusion button, split button, dropdown list, toggle button, gallery, custom controls in the subgroup of the ribbon tab . + * @Default {Array} + */ + groups?: TabsGroupsContentGroup[]; + } + + export interface TabsGroupsGroupExpanderSettings { + + /** Sets tooltip for the group expander of the group. + * @Default {null} + */ + toolTip?: string; + + /** Specifies the custom tooltip for group expander.Refer to ejRibbon#tabs->groups->content->groups->customToolTip for its inner properties. + * @Default {Object} + */ + customToolTip?: any; + } + + export interface TabsGroup { - /** Specifies the alignment of controls in the groups in 'row' type or 'column' type. Value for row type is "ej.Ribbon.AlignType.Rows" - * and for column type is "ej.Ribbon.alignType.columns". - * @Default {ej.Ribbon.AlignType.Rows} - */ - alignType?: ej.Ribbon.AlignType|string; + /** Specifies the alignment of controls in the groups in 'row' type or 'column' type. Value for row type is "ej.Ribbon.AlignType.Rows" + * and for column type is "ej.Ribbon.alignType.columns". + * @Default {ej.Ribbon.AlignType.Rows} + */ + alignType?: ej.Ribbon.AlignType | string; - /** Specifies the Syncfusion button, split button, dropdown list, toggle button, gallery, custom controls to the groups in the ribbon control. - * @Default {Array} - */ - content?: TabsGroupsContent[]; + /** Specifies the Syncfusion button, split button, dropdown list, toggle button, gallery, custom controls to the groups in the ribbon control. + * @Default {Array} + */ + content?: TabsGroupsContent[]; - /** Specifies the ID of custom items to be placed in the groups. - * @Default {null} - */ - contentID?: string; + /** Specifies the ID of custom items to be placed in the groups. + * @Default {null} + */ + contentID?: string; - /** Specifies the HTML contents to place into the groups. - * @Default {null} - */ - customContent?: string; + /** Specifies the HTML contents to place into the groups. + * @Default {null} + */ + customContent?: string; - /** Specifies the group expander for groups in the ribbon control. Set "true" to enable the group expander. - * @Default {false} - */ - enableGroupExpander?: boolean; + /** Specifies the group expander for groups in the ribbon control. Set "true" to enable the group expander. + * @Default {false} + */ + enableGroupExpander?: boolean; - /** Sets custom setting to the groups in the ribbon control. - * @Default {Object} - */ - groupExpanderSettings?: TabsGroupsGroupExpanderSettings; + /** Sets custom setting to the groups in the ribbon control. + * @Default {Object} + */ + groupExpanderSettings?: TabsGroupsGroupExpanderSettings; - /** Specifies the text to the groups in the ribbon control. - * @Default {null} - */ - text?: string; + /** Specifies the text to the groups in the ribbon control. + * @Default {null} + */ + text?: string; - /** Specifies the custom items such as div, table, controls by using the "custom" type. - * @Default {null} - */ - type?: string; -} + /** Specifies the custom items such as div, table, controls by using the "custom" type. + * @Default {null} + */ + type?: string; + } -export interface Tab { + export interface Tab { - /** Specifies single group or multiple groups and its contents to each tab in the ribbon control. - * @Default {Array} - */ - groups?: TabsGroup[]; + /** Specifies single group or multiple groups and its contents to each tab in the ribbon control. + * @Default {Array} + */ + groups?: TabsGroup[]; - /** Specifies the ID for each tab's content panel. - * @Default {null} - */ - id?: string; + /** Specifies the ID for each tab's content panel. + * @Default {null} + */ + id?: string; - /** Specifies the text of the tab in the ribbon control. - * @Default {null} - */ - text?: string; -} + /** Specifies the text of the tab in the ribbon control. + * @Default {null} + */ + text?: string; + } -enum ItemType { + enum ItemType { - ///To render the button for ribbon backstage pageĂ¢â‚¬â„¢s contents - Button, + ///To render the button for ribbon backstage pageĂ¢â‚¬â„¢s contents + Button, - ///To render the tab for ribbon backstage pageĂ¢â‚¬â„¢s contents - Tab -} + ///To render the tab for ribbon backstage pageĂ¢â‚¬â„¢s contents + Tab + } -enum ApplicationTabType { + enum ApplicationTabType { - ///applicationTab display as menu - Menu, + ///applicationTab display as menu + Menu, - ///applicationTab display as backstage - Backstage -} + ///applicationTab display as backstage + Backstage + } -enum AlignType { + enum AlignType { - ///To align the group content's in row - Rows, + ///To align the group content's in row + Rows, - ///To align group content's in columns - Columns -} + ///To align group content's in columns + Columns + } -enum CustomItemType { + enum CustomItemType { - ///Specifies the button type in customGalleryItems - Button, + ///Specifies the button type in customGalleryItems + Button, - ///Specifies the menu type in customGalleryItems - Menu -} + ///Specifies the menu type in customGalleryItems + Menu + } -enum QuickAccessMode { + enum QuickAccessMode { - ///Controls are hidden in Quick Access toolbar - None, + ///Controls are hidden in Quick Access toolbar + None, - ///Add controls in toolBar - ToolBar, + ///Add controls in toolBar + ToolBar, - ///Add controls in menu - Menu -} + ///Add controls in menu + Menu + } -enum Type { + enum Type { - ///Specifies the button control - Button, + ///Specifies the button control + Button, - ///Specifies the split button - SplitButton, + ///Specifies the split button + SplitButton, - ///Specifies the dropDown - DropDownList, + ///Specifies the dropDown + DropDownList, - ///To append external element's - Custom, + ///To append external element's + Custom, - ///Specifies the toggle button - ToggleButton, + ///Specifies the toggle button + ToggleButton, - ///Specifies the ribbon gallery - Gallery -} + ///Specifies the ribbon gallery + Gallery + } -} + } -class Kanban extends ej.Widget { - static fn: Kanban; - constructor(element: JQuery | Element, options?: Kanban.Model); - static Locale: any; - model: Kanban.Model; - defaults: Kanban.Model; + class Kanban extends ej.Widget { + static fn: Kanban; + constructor(element: JQuery | Element, options?: Kanban.Model); + static Locale: any; + model: Kanban.Model; + defaults: Kanban.Model; - /** Add or remove columns in Kanban columns collections.Default action is add. - * @param {Array|string} Pass array of columns or string of headerText to add/remove the column in Kanban - * @param {Array|string} Pass array of columns or string of key value to add/remove the column in Kanban - * @param {string} optional Pass add/remove action to be performed. By default "add" action will perform - * @returns {void} - */ - columns(columndetails: any[]|string, keyvalue: any[]|string, action?: string): void; + /** Add or remove columns in Kanban columns collections.Default action is add. + * @param {Array|string} Pass array of columns or string of headerText to add/remove the column in Kanban + * @param {Array|string} Pass array of columns or string of key value to add/remove the column in Kanban + * @param {string} optional Pass add/remove action to be performed. By default "add" action will perform + * @returns {void} + */ + columns(columndetails: any[] | string, keyvalue: any[] | string, action?: string): void; - /** Destroy the Kanban widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. - * @returns {void} - */ - destroy(): void; + /** Destroy the Kanban widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. + * @returns {void} + */ + destroy(): void; - /** Refresh the Kanban with new data source. - * @param {Array} Pass new data source to the Kanban - * @returns {void} - */ - dataSource(datasource: any[]): void; + /** Refresh the Kanban with new data source. + * @param {Array} Pass new data source to the Kanban + * @returns {void} + */ + dataSource(datasource: any[]): void; - /** toggleColumn based on the headerText in Kanban. - * @param {any} Pass the header text of the column to get the corresponding column object - * @returns {void} - */ - toggleColumn(headerText: any): void; + /** toggleColumn based on the headerText in Kanban. + * @param {any} Pass the header text of the column to get the corresponding column object + * @returns {void} + */ + toggleColumn(headerText: any): void; - /** Expand or collapse the card based on the state of target "div" - * @param {string|number} Pass the id of card to be toggle - * @returns {void} - */ - toggleCard(key: string|number): void; + /** Expand or collapse the card based on the state of target "div" + * @param {string|number} Pass the id of card to be toggle + * @returns {void} + */ + toggleCard(key: string | number): void; - /** Used for get the names of all the visible column name collections in Kanban. - * @returns {Array} - */ - getVisibleColumnNames(): any[]; + /** Used for get the names of all the visible column name collections in Kanban. + * @returns {Array} + */ + getVisibleColumnNames(): any[]; - /** Get the scroller object of Kanban. - * @returns {ej.Scroller} - */ - getScrollObject(): ej.Scroller; - - /** Get the column details based on the given header text in Kanban. - * @param {string} Pass the header text of the column to get the corresponding column object - * @returns {String} - */ - getColumnByHeaderText(headerText: string): string; - - /** Get the table details based on the given header table in Kanban. - * @returns {String} - */ - getHeaderTable(): string; - - /** Hide columns from the Kanban based on the header text - * @param {Array|string} you can pass either array of header text of various columns or a header text of a column to hide - * @returns {void} - */ - hideColumns(headerText: any[]|string): void; - - /** Print the Kanban Board - * @returns {void} - */ - print(): void; - - /** Refresh the template of the Kanban - * @returns {void} - */ - refreshTemplate(): void; - - /** Refresh the Kanban contents.The template refreshment is based on the argument passed along with this method - * @param {boolean} optional When templateRefresh is set true, template and Kanban contents both are refreshed in Kanban else only Kanban content is refreshed - * @returns {void} - */ - refresh(templateRefresh?: boolean): void; - - /** Show columns in the Kanban based on the header text. - * @param {Array|string} You can pass either array of header text of various columns or a header text of a column to show - * @returns {void} - */ - showColumns(headerText: any[]|string): void; - - /** Update a card in Kanban control based on key and JSON data given. - * @param {string} Pass the key field Name of the column - * @param {Array} Pass the edited JSON data of card need to be update. - * @returns {void} - */ - updateCard(key: string, data: any[]): void; - - KanbanSelection: Kanban.KanbanSelection; - - KanbanSwimlane: Kanban.KanbanSwimlane; - - KanbanFilter: Kanban.KanbanFilter; - - KanbanEdit: Kanban.KanbanEdit; -} -export namespace Kanban { - -export interface KanbanSelection { - - /** It is used to clear all the card selection. - * @returns {void} - */ - clear(): void; -} - -export interface KanbanSwimlane { - - /** Expand all the swimlane rows in Kanban. - * @returns {void} - */ - expandAll(): void; - - /** Collapse all the swimlane rows in Kanban. - * @returns {void} - */ - collapseAll(): void; - - /** Expand or collapse the swimlane row based on the state of target "div" - * @param {any} Pass the div object to toggleSwimlane row based on its row state - * @returns {void} - */ - toggle($div: any): void; -} - -export interface KanbanFilter { - - /** Method used for send a clear search request to Kanban. - * @returns {void} - */ - clearSearch(): void; - - /** Send a search request to Kanban with specified string passed in it. - * @param {string} Pass the string to search in Kanban card - * @returns {void} - */ - searchCards(searchString: string): void; - - /** Send a clear request to filter cards in the kanban. - * @returns {void} - */ - clearFilter(): void; - - /** Send a filtering request to cards in the kanban. - * @returns {void} - */ - filterCards(): void; -} - -export interface KanbanEdit { - - /** Add a new card in Kanban control when allowAdding is set as true. If parameters are not given default dialog will be open. - * @param {string} Pass the primary key field Name of the column - * @param {Array} Pass the edited JSON data of card need to be add. - * @returns {void} - */ - addCard(primaryKey: string, card: any[]): void; - - /** Send a cancel request of add/edit card in Kanban when allowEditing/allowAdding is set as true. - * @returns {void} - */ - cancelEdit(): void; - - /** Delete a card in Kanban control when allowAdding/allowEditing is set as true. - * @param {string|number} Pass the key of card to be delete - * @returns {void} - */ - deleteCard(Key: string|number): void; - - /** Send a save request in Kanban when any card is in edit/new add card state and allowEditing/allowAdding is set as true. - * @returns {void} - */ - endEdit(): void; - - /** Send an edit card request in Kanban when allowEditing is set as true. Parameter will be HTML element or primary key - * @param {any} Pass the div selected row element to be edited in Kanban - * @returns {void} - */ - startEdit($div: any): void; - - /** Method used for set validation to a field during editing. - * @param {string} Specify the name of the column to set validation rules - * @param {any} Specify the validation rules for the field - * @returns {void} - */ - setValidationToField(name: string, rules: any): void; -} - -export interface Model { - - /** Gets or sets a value that indicates whether to enable allowDragAndDrop behavior on Kanban. - * @Default {true} - */ - allowDragAndDrop?: boolean; - - /** To enable or disable the title of the card. - * @Default {false} - */ - allowTitle?: boolean; - - /** Customize the settings for swim lane. - * @Default {Object} - */ - swimlaneSettings?: SwimlaneSettings; - - /** To enable or disable the column expand /collapse. - * @Default {false} - */ - allowToggleColumn?: boolean; - - /** To enable Searching operation in Kanban. - * @Default {false} - */ - allowSearching?: boolean; - - /** To enable filtering behavior on Kanban.User can specify query in filterSettings collection after enabling allowFiltering. - * @Default {false} - */ - allowFiltering?: boolean; - - /** Gets or sets a value that indicates whether to enable allowSelection behavior on Kanban.User can select card and the selected card will be highlighted on Kanban. - * @Default {true} - */ - allowSelection?: boolean; - - /** Gets or sets a value that indicates whether to allow card hover actions. - * @Default {true} - */ - allowHover?: boolean; - - /** To allow keyboard navigation actions. - * @Default {false} - */ - allowKeyboardNavigation?: boolean; - - /** Gets or sets a value that indicates whether to enable the scrollbar in the Kanban and view the card by scroll through the Kanban manually. - * @Default {false} - */ - allowScrolling?: boolean; - - /** Gets or sets a value that indicates whether to enable printing option. - * @Default {false} - */ - allowPrinting?: boolean; - - /** Gets or sets an object that indicates whether to customize the context menu behavior of the Kanban. - * @Default {Object} - */ - contextMenuSettings?: ContextMenuSettings; - - /** Gets or sets an object that indicates to render the Kanban with specified columns. - * @Default {Array} - */ - columns?: Column[]; - - /** Gets or sets an object that indicates whether to Customize the card settings. - * @Default {Object} - */ - cardSettings?: CardSettings; - - /** Gets or sets a value that indicates whether to add customToolbarItems within the toolbar to perform any action in the Kanban. - * @Default {[]} - */ - customToolbarItems?: CustomToolbarItem[]; - - /** Gets or sets a value that indicates to render the Kanban with custom theme. - */ - cssClass?: string; - - /** Gets or sets the data to render the Kanban with cards. - * @Default {null} - */ - dataSource?: any; - - /** To perform kanban functionalities with touch interaction. - * @Default {true} - */ - enableTouch?: boolean; - - /** Align content in the Kanban control align from right to left by setting the property as true. - * @Default {false} - */ - enableRTL?: boolean; - - /** To show total count of cards in each column. - * @Default {false} - */ - enableTotalCount?: boolean; - - /** Get or sets an object that indicates whether to customize the editing behavior of the Kanban. - * @Default {Object} - */ - editSettings?: EditSettings; - - /** To customize field mappings for card , editing title and control key parameters - * @Default {Object} - */ - fields?: Fields; - - /** To map datasource field for column values mapping - * @Default {null} - */ - keyField?: string; - - /** When set to true, adapts the Kanban layout to fit the screen size of devices on which it renders. - * @Default {false} - */ - isResponsive?: boolean; - - /** Gets or sets a value that indicates whether to set the minimum width of the responsive Kanban while isResponsive property is true. - * @Default {0} - */ - minWidth?: number; - - /** To customize the filtering behavior based on queries given. - * @Default {Array} - */ - filterSettings?: FilterSetting[]; - - /** ej Query to query database of Kanban. - * @Default {null} - */ - query?: any; - - /** To change the key in keyboard interaction to Kanban control. - * @Default {null} - */ - keySettings?: any; - - /** Gets or sets an object that indicates whether to customize the scrolling behavior of the Kanban. - * @Default {Object} - */ - scrollSettings?: ScrollSettings; + /** Get the scroller object of Kanban. + * @returns {ej.Scroller} + */ + getScrollObject(): ej.Scroller; + + /** Get the column details based on the given header text in Kanban. + * @param {string} Pass the header text of the column to get the corresponding column object + * @returns {String} + */ + getColumnByHeaderText(headerText: string): string; + + /** Get the table details based on the given header table in Kanban. + * @returns {String} + */ + getHeaderTable(): string; + + /** Hide columns from the Kanban based on the header text + * @param {Array|string} you can pass either array of header text of various columns or a header text of a column to hide + * @returns {void} + */ + hideColumns(headerText: any[] | string): void; + + /** Print the Kanban Board + * @returns {void} + */ + print(): void; + + /** Refresh the template of the Kanban + * @returns {void} + */ + refreshTemplate(): void; + + /** Refresh the Kanban contents.The template refreshment is based on the argument passed along with this method + * @param {boolean} optional When templateRefresh is set true, template and Kanban contents both are refreshed in Kanban else only Kanban content is refreshed + * @returns {void} + */ + refresh(templateRefresh?: boolean): void; + + /** Show columns in the Kanban based on the header text. + * @param {Array|string} You can pass either array of header text of various columns or a header text of a column to show + * @returns {void} + */ + showColumns(headerText: any[] | string): void; + + /** Update a card in Kanban control based on key and JSON data given. + * @param {string} Pass the key field Name of the column + * @param {Array} Pass the edited JSON data of card need to be update. + * @returns {void} + */ + updateCard(key: string, data: any[]): void; + + KanbanSelection: Kanban.KanbanSelection; + + KanbanSwimlane: Kanban.KanbanSwimlane; + + KanbanFilter: Kanban.KanbanFilter; + + KanbanEdit: Kanban.KanbanEdit; + } + export namespace Kanban { + + export interface KanbanSelection { + + /** It is used to clear all the card selection. + * @returns {void} + */ + clear(): void; + } + + export interface KanbanSwimlane { + + /** Expand all the swimlane rows in Kanban. + * @returns {void} + */ + expandAll(): void; + + /** Collapse all the swimlane rows in Kanban. + * @returns {void} + */ + collapseAll(): void; + + /** Expand or collapse the swimlane row based on the state of target "div" + * @param {any} Pass the div object to toggleSwimlane row based on its row state + * @returns {void} + */ + toggle($div: any): void; + } + + export interface KanbanFilter { + + /** Method used for send a clear search request to Kanban. + * @returns {void} + */ + clearSearch(): void; + + /** Send a search request to Kanban with specified string passed in it. + * @param {string} Pass the string to search in Kanban card + * @returns {void} + */ + searchCards(searchString: string): void; + + /** Send a clear request to filter cards in the kanban. + * @returns {void} + */ + clearFilter(): void; + + /** Send a filtering request to cards in the kanban. + * @returns {void} + */ + filterCards(): void; + } + + export interface KanbanEdit { + + /** Add a new card in Kanban control when allowAdding is set as true. If parameters are not given default dialog will be open. + * @param {string} Pass the primary key field Name of the column + * @param {Array} Pass the edited JSON data of card need to be add. + * @returns {void} + */ + addCard(primaryKey: string, card: any[]): void; + + /** Send a cancel request of add/edit card in Kanban when allowEditing/allowAdding is set as true. + * @returns {void} + */ + cancelEdit(): void; + + /** Delete a card in Kanban control when allowAdding/allowEditing is set as true. + * @param {string|number} Pass the key of card to be delete + * @returns {void} + */ + deleteCard(Key: string | number): void; + + /** Send a save request in Kanban when any card is in edit/new add card state and allowEditing/allowAdding is set as true. + * @returns {void} + */ + endEdit(): void; + + /** Send an edit card request in Kanban when allowEditing is set as true. Parameter will be HTML element or primary key + * @param {any} Pass the div selected row element to be edited in Kanban + * @returns {void} + */ + startEdit($div: any): void; + + /** Method used for set validation to a field during editing. + * @param {string} Specify the name of the column to set validation rules + * @param {any} Specify the validation rules for the field + * @returns {void} + */ + setValidationToField(name: string, rules: any): void; + } + + export interface Model { + + /** Gets or sets a value that indicates whether to enable allowDragAndDrop behavior on Kanban. + * @Default {true} + */ + allowDragAndDrop?: boolean; + + /** To enable or disable the title of the card. + * @Default {false} + */ + allowTitle?: boolean; + + /** Customize the settings for swim lane. + * @Default {Object} + */ + swimlaneSettings?: SwimlaneSettings; + + /** To enable or disable the column expand /collapse. + * @Default {false} + */ + allowToggleColumn?: boolean; + + /** To enable Searching operation in Kanban. + * @Default {false} + */ + allowSearching?: boolean; + + /** To enable filtering behavior on Kanban.User can specify query in filterSettings collection after enabling allowFiltering. + * @Default {false} + */ + allowFiltering?: boolean; + + /** Gets or sets a value that indicates whether to enable allowSelection behavior on Kanban.User can select card and the selected card will be highlighted on Kanban. + * @Default {true} + */ + allowSelection?: boolean; + + /** Gets or sets a value that indicates whether to allow card hover actions. + * @Default {true} + */ + allowHover?: boolean; + + /** To allow keyboard navigation actions. + * @Default {false} + */ + allowKeyboardNavigation?: boolean; + + /** Gets or sets a value that indicates whether to enable the scrollbar in the Kanban and view the card by scroll through the Kanban manually. + * @Default {false} + */ + allowScrolling?: boolean; + + /** Gets or sets a value that indicates whether to enable printing option. + * @Default {false} + */ + allowPrinting?: boolean; + + /** Gets or sets an object that indicates whether to customize the context menu behavior of the Kanban. + * @Default {Object} + */ + contextMenuSettings?: ContextMenuSettings; + + /** Gets or sets an object that indicates to render the Kanban with specified columns. + * @Default {Array} + */ + columns?: Column[]; + + /** Gets or sets an object that indicates whether to Customize the card settings. + * @Default {Object} + */ + cardSettings?: CardSettings; + + /** Gets or sets a value that indicates whether to add customToolbarItems within the toolbar to perform any action in the Kanban. + * @Default {[]} + */ + customToolbarItems?: CustomToolbarItem[]; + + /** Gets or sets a value that indicates to render the Kanban with custom theme. + */ + cssClass?: string; + + /** Gets or sets the data to render the Kanban with cards. + * @Default {null} + */ + dataSource?: any; + + /** To perform kanban functionalities with touch interaction. + * @Default {true} + */ + enableTouch?: boolean; + + /** Align content in the Kanban control align from right to left by setting the property as true. + * @Default {false} + */ + enableRTL?: boolean; + + /** To show total count of cards in each column. + * @Default {false} + */ + enableTotalCount?: boolean; + + /** Get or sets an object that indicates whether to customize the editing behavior of the Kanban. + * @Default {Object} + */ + editSettings?: EditSettings; + + /** To customize field mappings for card , editing title and control key parameters + * @Default {Object} + */ + fields?: Fields; + + /** To map datasource field for column values mapping + * @Default {null} + */ + keyField?: string; + + /** When set to true, adapts the Kanban layout to fit the screen size of devices on which it renders. + * @Default {false} + */ + isResponsive?: boolean; + + /** Gets or sets a value that indicates whether to set the minimum width of the responsive Kanban while isResponsive property is true. + * @Default {0} + */ + minWidth?: number; + + /** To customize the filtering behavior based on queries given. + * @Default {Array} + */ + filterSettings?: FilterSetting[]; + + /** ej Query to query database of Kanban. + * @Default {null} + */ + query?: any; + + /** To change the key in keyboard interaction to Kanban control. + * @Default {null} + */ + keySettings?: any; + + /** Gets or sets an object that indicates whether to customize the scrolling behavior of the Kanban. + * @Default {Object} + */ + scrollSettings?: ScrollSettings; - /** To customize the searching behavior of the Kanban. - * @Default {Object} - */ - searchSettings?: SearchSettings; + /** To customize the searching behavior of the Kanban. + * @Default {Object} + */ + searchSettings?: SearchSettings; - /** To allow customize selection type. Accepting types are "single" and "multiple". - * @Default {ej.Kanban.SelectionType.Single} - */ - selectionType?: ej.Kanban.SelectionType|string; + /** To allow customize selection type. Accepting types are "single" and "multiple". + * @Default {ej.Kanban.SelectionType.Single} + */ + selectionType?: ej.Kanban.SelectionType | string; - /** Gets or sets an object that indicates to managing the collection of stacked header rows for the Kanban. - * @Default {Array} - */ - stackedHeaderRows?: StackedHeaderRow[]; + /** Gets or sets an object that indicates to managing the collection of stacked header rows for the Kanban. + * @Default {Array} + */ + stackedHeaderRows?: StackedHeaderRow[]; - /** The tooltip allows to display card details in a tooltip while hovering on it. - */ - tooltipSettings?: TooltipSettings; + /** The tooltip allows to display card details in a tooltip while hovering on it. + */ + tooltipSettings?: TooltipSettings; - /** Gets or sets an object that indicates to render the Kanban with specified workflows. - * @Default {Array} - */ - workflows?: Workflow[]; + /** Gets or sets an object that indicates to render the Kanban with specified workflows. + * @Default {Array} + */ + workflows?: Workflow[]; - /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and culture specific - * to a particular country or region. - * @Default {en-US} - */ - locale?: string; + /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and culture specific + * to a particular country or region. + * @Default {en-US} + */ + locale?: string; - /** Triggered for every Kanban action before its starts. */ - actionBegin?(e: ActionBeginEventArgs): void; + /** Triggered for every Kanban action before its starts. */ + actionBegin?(e: ActionBeginEventArgs): void; - /** Triggered for every Kanban action success event. */ - actionComplete?(e: ActionCompleteEventArgs): void; + /** Triggered for every Kanban action success event. */ + actionComplete?(e: ActionCompleteEventArgs): void; - /** Triggered for every Kanban action server failure event. */ - actionFailure?(e: ActionFailureEventArgs): void; + /** Triggered for every Kanban action server failure event. */ + actionFailure?(e: ActionFailureEventArgs): void; - /** Triggered before the task is going to be edited. */ - beginEdit?(e: BeginEditEventArgs): void; + /** Triggered before the task is going to be edited. */ + beginEdit?(e: BeginEditEventArgs): void; - /** Triggered before the card is going to be added */ - beginAdd?(e: BeginAddEventArgs): void; + /** Triggered before the card is going to be added */ + beginAdd?(e: BeginAddEventArgs): void; - /** Triggered before the card is selected. */ - beforeCardSelect?(e: BeforeCardSelectEventArgs): void; + /** Triggered before the card is selected. */ + beforeCardSelect?(e: BeforeCardSelectEventArgs): void; - /** Trigger after the card is clicked. */ - cardClick?(e: CardClickEventArgs): void; + /** Trigger after the card is clicked. */ + cardClick?(e: CardClickEventArgs): void; - /** Triggered when the card is being dragged. */ - cardDrag?(e: CardDragEventArgs): void; + /** Triggered when the card is being dragged. */ + cardDrag?(e: CardDragEventArgs): void; - /** Triggered when card dragging start. */ - cardDragStart?(e: CardDragStartEventArgs): void; + /** Triggered when card dragging start. */ + cardDragStart?(e: CardDragStartEventArgs): void; - /** Triggered when card dragging stops. */ - cardDragStop?(e: CardDragStopEventArgs): void; + /** Triggered when card dragging stops. */ + cardDragStop?(e: CardDragStopEventArgs): void; - /** Triggered when the card is Dropped. */ - cardDrop?(e: CardDropEventArgs): void; + /** Triggered when the card is Dropped. */ + cardDrop?(e: CardDropEventArgs): void; - /** Triggered after the card is selected. */ - cardSelect?(e: CardSelectEventArgs): void; + /** Triggered after the card is selected. */ + cardSelect?(e: CardSelectEventArgs): void; - /** Triggered when card is double clicked. */ - cardDoubleClick?(e: CardDoubleClickEventArgs): void; + /** Triggered when card is double clicked. */ + cardDoubleClick?(e: CardDoubleClickEventArgs): void; - /** Triggered before the card is selected. */ - cardSelecting?(e: CardSelectingEventArgs): void; + /** Triggered before the card is selected. */ + cardSelecting?(e: CardSelectingEventArgs): void; - /** Triggered when the Kanban is rendered completely */ - create?(e: CreateEventArgs): void; + /** Triggered when the Kanban is rendered completely */ + create?(e: CreateEventArgs): void; - /** Triggers after the cell is clicked. */ - cellClick?(e: CellClickEventArgs): void; + /** Triggers after the cell is clicked. */ + cellClick?(e: CellClickEventArgs): void; - /** Triggered before the context menu is opened. */ - contextOpen?(e: ContextOpenEventArgs): void; + /** Triggered before the context menu is opened. */ + contextOpen?(e: ContextOpenEventArgs): void; - /** Triggered when context menu item is clicked in Kanban */ - contextClick?(e: ContextClickEventArgs): void; + /** Triggered when context menu item is clicked in Kanban */ + contextClick?(e: ContextClickEventArgs): void; - /** Triggered the Kanban is bound with data during initial rendering. */ - dataBound?(e: DataBoundEventArgs): void; + /** Triggered the Kanban is bound with data during initial rendering. */ + dataBound?(e: DataBoundEventArgs): void; - /** Triggered when Kanban going to destroy. */ - destroy?(e: DestroyEventArgs): void; + /** Triggered when Kanban going to destroy. */ + destroy?(e: DestroyEventArgs): void; - /** Triggered after the card is deleted. */ - endDelete?(e: EndDeleteEventArgs): void; + /** Triggered after the card is deleted. */ + endDelete?(e: EndDeleteEventArgs): void; - /** Triggered after the card is edited. */ - endEdit?(e: EndEditEventArgs): void; + /** Triggered after the card is edited. */ + endEdit?(e: EndEditEventArgs): void; - /** Triggers after the header is clicked. */ - headerClick?(e: HeaderClickEventArgs): void; + /** Triggers after the header is clicked. */ + headerClick?(e: HeaderClickEventArgs): void; - /** Triggered initial load. */ - load?(e: LoadEventArgs): void; + /** Triggered initial load. */ + load?(e: LoadEventArgs): void; - /** Triggered every time a single card rendered request is made to access particular card information. */ - queryCellInfo?(e: QueryCellInfoEventArgs): void; + /** Triggered every time a single card rendered request is made to access particular card information. */ + queryCellInfo?(e: QueryCellInfoEventArgs): void; - /** Triggered when toolbar item is clicked in Kanban. */ - toolbarClick?(e: ToolbarClickEventArgs): void; -} + /** Triggered when toolbar item is clicked in Kanban. */ + toolbarClick?(e: ToolbarClickEventArgs): void; + } -export interface ActionBeginEventArgs { + export interface ActionBeginEventArgs { - /** Returns the Kanban model. - */ - model?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the current action event type. - */ - originalEventType?: string; + /** Returns the current action event type. + */ + originalEventType?: string; - /** Returns primary key value. - */ - primaryKeyValue?: string; + /** Returns primary key value. + */ + primaryKeyValue?: string; - /** Returns request type. - */ - requestType?: string; + /** Returns request type. + */ + requestType?: string; - /** Returns the edited row index. - */ - rowIndex?: number; + /** Returns the edited row index. + */ + rowIndex?: number; - /** Returns the card object (JSON). - */ - data?: any; + /** Returns the card object (JSON). + */ + data?: any; - /** Returns current filtering object field name. - */ - currentFilteringobject?: any; + /** Returns current filtering object field name. + */ + currentFilteringobject?: any; - /** Returns filter details. - */ - filterCollection?: any; -} + /** Returns filter details. + */ + filterCollection?: any; + } -export interface ActionCompleteEventArgs { + export interface ActionCompleteEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Kanban model. - */ - model?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns request type. - */ - requestType?: string; + /** Returns request type. + */ + requestType?: string; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns current action event type. - */ - originalEventType?: string; + /** Returns current action event type. + */ + originalEventType?: string; - /** Returns primary key. - */ - primaryKey?: string; + /** Returns primary key. + */ + primaryKey?: string; - /** Returns primary key value. - */ - primaryKeyValue?: string; + /** Returns primary key value. + */ + primaryKeyValue?: string; - /** Returns Kanban element. - */ - target?: any; + /** Returns Kanban element. + */ + target?: any; - /** Returns the card object (JSON). - */ - data?: any; + /** Returns the card object (JSON). + */ + data?: any; - /** Returns the selectedRow index. - */ - selectedRow?: number; + /** Returns the selectedRow index. + */ + selectedRow?: number; - /** Returns current filtering column field name. - */ - currentFilteringColumn?: string; + /** Returns current filtering column field name. + */ + currentFilteringColumn?: string; - /** Returns filter details. - */ - filterCollection?: any; -} + /** Returns filter details. + */ + filterCollection?: any; + } -export interface ActionFailureEventArgs { + export interface ActionFailureEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Kanban model. - */ - model?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns request type. - */ - requestType?: string; + /** Returns request type. + */ + requestType?: string; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the error return by server. - */ - error?: any; + /** Returns the error return by server. + */ + error?: any; - /** Returns current action event type. - */ - originalEventType?: string; + /** Returns current action event type. + */ + originalEventType?: string; - /** Returns primary key value. - */ - primaryKeyValue?: string; + /** Returns primary key value. + */ + primaryKeyValue?: string; - /** Returns Kanban element. - */ - target?: any; + /** Returns Kanban element. + */ + target?: any; - /** Returns the card object (JSON). - */ - data?: any; + /** Returns the card object (JSON). + */ + data?: any; - /** Returns current filtering column field name. - */ - currentFilteringColumn?: string; + /** Returns current filtering column field name. + */ + currentFilteringColumn?: string; - /** Returns filter details. - */ - filterCollection?: any; -} + /** Returns filter details. + */ + filterCollection?: any; + } -export interface BeginEditEventArgs { + export interface BeginEditEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Kanban model. - */ - model?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns primary key value. - */ - primaryKeyValue?: string; + /** Returns primary key value. + */ + primaryKeyValue?: string; - /** Returns begin edit data. - */ - data?: any; + /** Returns begin edit data. + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface BeginAddEventArgs { + export interface BeginAddEventArgs { - /** Returns the Kanban model. - */ - model?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns primary key value. - */ - primaryKeyValue?: string; + /** Returns primary key value. + */ + primaryKeyValue?: string; - /** Returns beginAdd data. - */ - data?: any; + /** Returns beginAdd data. + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface BeforeCardSelectEventArgs { + export interface BeforeCardSelectEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the select cell index value. - */ - cellIndex?: number; + /** Returns the select cell index value. + */ + cellIndex?: number; - /** Returns the select card index value. - */ - cardIndex?: number; + /** Returns the select card index value. + */ + cardIndex?: number; - /** Returns the select cell element - */ - currentCell?: any; + /** Returns the select cell element + */ + currentCell?: any; - /** Returns the previously select the card element - */ - previousCard?: any; + /** Returns the previously select the card element + */ + previousCard?: any; - /** Returns the previously select card indexes - */ - previousRowcellindex?: any[]; + /** Returns the previously select card indexes + */ + previousRowcellindex?: any[]; - /** Returns the Target item. - */ - Target?: any; + /** Returns the Target item. + */ + Target?: any; - /** Returns the Kanban model. - */ - model?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns select card data. - */ - data?: any; + /** Returns select card data. + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface CardClickEventArgs { + export interface CardClickEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns current record object (JSON). - */ - data?: any; + /** Returns current record object (JSON). + */ + data?: any; - /** Returns the current card to the Kanban. - */ - currentCard?: string; + /** Returns the current card to the Kanban. + */ + currentCard?: string; - /** Returns Kanban element. - */ - target?: any; + /** Returns Kanban element. + */ + target?: any; - /** Returns the Kanban model. - */ - model?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns the Header text of the column corresponding to the selected card. - */ - columnName?: string; + /** Returns the Header text of the column corresponding to the selected card. + */ + columnName?: string; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface CardDragEventArgs { + export interface CardDragEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns drag data. - */ - data?: any; + /** Returns drag data. + */ + data?: any; - /** Returns drag start element. - */ - dragtarget?: any; + /** Returns drag start element. + */ + dragtarget?: any; - /** Returns dragged element. - */ - draggedElement?: any; + /** Returns dragged element. + */ + draggedElement?: any; - /** Returns the Kanban model. - */ - model?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface CardDragStartEventArgs { + export interface CardDragStartEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns card drag start data. - */ - data?: any; + /** Returns card drag start data. + */ + data?: any; - /** Returns dragged element. - */ - draggedElement?: any; + /** Returns dragged element. + */ + draggedElement?: any; - /** Returns the Kanban model. - */ - model?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns drag start element. - */ - dragtarget?: any; + /** Returns drag start element. + */ + dragtarget?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface CardDragStopEventArgs { + export interface CardDragStopEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns dragged element. - */ - draggedElement?: any; + /** Returns dragged element. + */ + draggedElement?: any; - /** Returns the Kanban model. - */ - model?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns drag stop element. - */ - droptarget?: any; + /** Returns drag stop element. + */ + droptarget?: any; - /** Returns drag stop data. - */ - data?: any; + /** Returns drag stop data. + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface CardDropEventArgs { + export interface CardDropEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns dragged element. - */ - draggedElement?: any; + /** Returns dragged element. + */ + draggedElement?: any; - /** Returns previous parent of dragged element - */ - draggedParent?: any; + /** Returns previous parent of dragged element + */ + draggedParent?: any; - /** Returns dragged data. - */ - data?: any; + /** Returns dragged data. + */ + data?: any; - /** Returns the Kanban model. - */ - model?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns drop element. - */ - target?: any; + /** Returns drop element. + */ + target?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface CardSelectEventArgs { + export interface CardSelectEventArgs { - /** Returns the select cell index value. - */ - cellIndex?: number; + /** Returns the select cell index value. + */ + cellIndex?: number; - /** Returns the select card index value. - */ - cardIndex?: number; + /** Returns the select card index value. + */ + cardIndex?: number; - /** Returns the select cell element - */ - currentCell?: any; + /** Returns the select cell element + */ + currentCell?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the previously select the card element - */ - previousCard?: any; + /** Returns the previously select the card element + */ + previousCard?: any; - /** Returns the previously select card indexes - */ - previousRowcellindex?: any[]; + /** Returns the previously select card indexes + */ + previousRowcellindex?: any[]; - /** Returns the current item. - */ - currentTarget?: any; + /** Returns the current item. + */ + currentTarget?: any; - /** Returns the Kanban model. - */ - model?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns select card data. - */ - data?: any; + /** Returns select card data. + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface CardDoubleClickEventArgs { + export interface CardDoubleClickEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns current card object (JSON). - */ - data?: any; + /** Returns current card object (JSON). + */ + data?: any; - /** Returns the Kanban model. - */ - model?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface CardSelectingEventArgs { + export interface CardSelectingEventArgs { - /** Returns the selecting cell index value. - */ - cellIndex?: number; + /** Returns the selecting cell index value. + */ + cellIndex?: number; - /** Returns the selecting card index value. - */ - cardIndex?: number; + /** Returns the selecting card index value. + */ + cardIndex?: number; - /** Returns the selecting cell element - */ - currentCell?: any; + /** Returns the selecting cell element + */ + currentCell?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the previously selecting the card element - */ - previousCard?: any; + /** Returns the previously selecting the card element + */ + previousCard?: any; - /** Returns the previously rowcell is selecting card indexes - */ - previousRowcellindex?: any[]; + /** Returns the previously rowcell is selecting card indexes + */ + previousRowcellindex?: any[]; - /** Returns the current item. - */ - currentTarget?: any; + /** Returns the current item. + */ + currentTarget?: any; - /** Returns the Kanban model. - */ - model?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns added data. - */ - data?: any; + /** Returns added data. + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the kanban model. - */ - model?: any; + /** Returns the kanban model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface CellClickEventArgs { + export interface CellClickEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the kanban model. - */ - model?: any; + /** Returns the kanban model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the select cell index value. - */ - cellIndex?: number; + /** Returns the select cell index value. + */ + cellIndex?: number; - /** Returns the edited row index. - */ - rowIndex?: number; -} + /** Returns the edited row index. + */ + rowIndex?: number; + } -export interface ContextOpenEventArgs { + export interface ContextOpenEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Kanban model. - */ - model?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the current item. - */ - currentTarget?: any; + /** Returns the current item. + */ + currentTarget?: any; - /** Returns the status of contextmenu item which denotes its enabled state. - */ - status?: boolean; + /** Returns the status of contextmenu item which denotes its enabled state. + */ + status?: boolean; - /** Returns the target item. - */ - target?: any; -} + /** Returns the target item. + */ + target?: any; + } -export interface ContextClickEventArgs { + export interface ContextClickEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Kanban model. - */ - model?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the current item. - */ - currentTarget?: any; + /** Returns the current item. + */ + currentTarget?: any; - /** Returns the status of contextmenu item which denotes its enabled state. - */ - status?: boolean; + /** Returns the status of contextmenu item which denotes its enabled state. + */ + status?: boolean; - /** Returns the target item. - */ - target?: any; -} + /** Returns the target item. + */ + target?: any; + } -export interface DataBoundEventArgs { + export interface DataBoundEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Kanban model. - */ - model?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** Returns the kanban model. - */ - model?: any; + /** Returns the kanban model. + */ + model?: any; - /** Returns deleted data. - */ - data?: any; + /** Returns deleted data. + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface EndDeleteEventArgs { + export interface EndDeleteEventArgs { - /** Returns the Kanban model. - */ - model?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns request type. - */ - requestType?: string; + /** Returns request type. + */ + requestType?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns deleted data. - */ - data?: any; + /** Returns deleted data. + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Current action name - */ - action?: string; -} + /** Current action name + */ + action?: string; + } -export interface EndEditEventArgs { + export interface EndEditEventArgs { - /** Returns the Kanban model. - */ - model?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns request type. - */ - requestType?: string; + /** Returns request type. + */ + requestType?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns modified data. - */ - data?: any; + /** Returns modified data. + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Current Action name - */ - action?: string; -} + /** Current Action name + */ + action?: string; + } -export interface HeaderClickEventArgs { + export interface HeaderClickEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the kanban model. - */ - model?: any; + /** Returns the kanban model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the select cell index value. - */ - cellIndex?: number; + /** Returns the select cell index value. + */ + cellIndex?: number; - /** Returns the column object. - */ - columnData?: any; -} + /** Returns the column object. + */ + columnData?: any; + } -export interface LoadEventArgs { + export interface LoadEventArgs { - /** Returns the kanban model. - */ - model?: any; + /** Returns the kanban model. + */ + model?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface QueryCellInfoEventArgs { + export interface QueryCellInfoEventArgs { - /** Returns Kanban card. - */ - card?: any; + /** Returns Kanban card. + */ + card?: any; - /** Returns Kanban card. - */ - cell?: any; + /** Returns Kanban card. + */ + cell?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns current row record object (JSON). - */ - data?: any; + /** Returns current row record object (JSON). + */ + data?: any; - /** Returns the column object. - */ - column?: any; + /** Returns the column object. + */ + column?: any; - /** Returns the Kanban model. - */ - model?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface ToolbarClickEventArgs { + export interface ToolbarClickEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the current item. - */ - currentTarget?: any; - - /** Returns the item id of that current element. - */ - itemId?: string; + /** Returns the current item. + */ + currentTarget?: any; + + /** Returns the item id of that current element. + */ + itemId?: string; - /** Returns the item index of that current element. - */ - itemIndex?: number; - - /** Returns the item name of that current element. - */ - itemName?: string; + /** Returns the item index of that current element. + */ + itemIndex?: number; + + /** Returns the item name of that current element. + */ + itemName?: string; - /** Returns the item text of that current element. - */ - itemText?: string; + /** Returns the item text of that current element. + */ + itemText?: string; - /** Returns the Kanban model. - */ - model?: any; - - /** Returns the name of the event. - */ - type?: string; - - /** Returns the toolbar object of the Kanban. - */ - toolbarData?: any; -} - -export interface SwimlaneSettingsUnassignedGroup { - - /** To enable or disable unassigned category change with swim lane key values. - * @Default {true} - */ - enable?: boolean; - - /** To set the user defined values which are need to categorized as unassigned category swim lane groups. - * @Default {[null,undefined,]} - */ - keys?: any[]; -} - -export interface SwimlaneSettings { - - /** To enable or disable items count in swim lane. - * @Default {true} - */ - showCount?: boolean; - - /** To enable or disable DragAndDrop across swim lane. - * @Default {false} - */ - allowDragAndDrop?: boolean; - - /** Customize the settings for unassigned category of swim lane. - * @Default {Object} - */ - unassignedGroup?: SwimlaneSettingsUnassignedGroup; -} - -export interface ContextMenuSettingsCustomMenuItem { - - /** Its sets target element to custom context menu item. - * @Default {ej.Kanban.Target.All} - */ - target?: ej.Kanban.Target|string; - - /** Gets the display name to custom menu item. - * @Default {null} - */ - text?: string; - - /** Gets the template to render custom context menu item. - * @Default {null} - */ - template?: string; -} - -export interface ContextMenuSettings { - - /** To enable context menu.All default context menu will show. - * @Default {false} - */ - enable?: boolean; - - /** Gets or sets a value that indicates the list of items needs to be disable from default context menu items. - * @Default {Array} - */ - disableDefaultItems?: any[]; - - /** Its used to add specific default context menu items. - * @Default {Array} - */ - menuItems?: any[]; - - /** Gets or sets a value that indicates whether to add custom contextMenu items. - * @Default {Array} - */ - customMenuItems?: ContextMenuSettingsCustomMenuItem[]; -} - -export interface ColumnsTotalCount { - - /** To customize the totalCount text properties. - * @Default {null} - */ - text?: string; -} - -export interface ColumnsConstraints { - - /** It is used to specify the type of constraints as column or swimlane. - * @Default {null} - */ - type?: string; - - /** It is used to specify the minimum amount of card in particular column cell or swimlane cell can hold. - * @Default {null} - */ - min?: number; - - /** It is used to specify the maximum amount of card in particular column cell or swimlane cell can hold. - * @Default {null} - */ - max?: number; -} - -export interface Column { - - /** Gets or sets an object that indicates to render the Kanban with specified columns header text. - * @Default {null} - */ - headerText?: string; - - /** To customize the totalCount properties. - * @Default {Object} - */ - totalCount?: ColumnsTotalCount; - - /** Gets or sets an object that indicates to render the Kanban with specified columns key. - * @Default {null} - */ - key?: string|number; - - /** To enable/disable allowDrop for specific column wise. - * @Default {true} - */ - allowDrop?: boolean; - - /** To enable/disable allowDrag for specific column wise. - * @Default {true} - */ - allowDrag?: boolean; - - /** To set column collapse or expand state - * @Default {false} - */ - isCollapsed?: boolean; - - /** To customize the column level constraints with minimum ,maximum limit validation. - * @Default {Object} - */ - constraints?: ColumnsConstraints; - - /** Gets or sets a value that indicates to add the template within the header element. - * @Default {null} - */ - headerTemplate?: string; - - /** Gets or sets an object that indicates to render the Kanban with specified columns width. - * @Default {null} - */ - width?: string|number; - - /** Gets or sets an object that indicates to set specific column visibility. - * @Default {true} - */ - visible?: boolean; - - /** Gets or sets an object that indicates whether to show add new button. - * @Default {false} - */ - showAddButton?: boolean; -} - -export interface CardSettings { - - /** Gets or sets a value that indicates to add the template for card . - * @Default {null} - */ - template?: string; - - /** To customize the card border color based on assigned task. Colors and corresponding values defined here will be mapped with colorField mapped data source column. - * @Default {Object} - */ - colorMapping?: any; -} - -export interface CustomToolbarItem { - - /** Gets the template to render customToolbarItems. - * @Default {null} - */ - template?: string; -} - -export interface EditSettingsEditItem { - - /** It is used to map editing field from the data source. - * @Default {null} - */ - field?: string; - - /** It is used to set the particular editType in the card for editing. - * @Default {ej.Kanban.EditingType.String} - */ - editType?: ej.Kanban.EditingType|string; - - /** Gets or sets a value that indicates to define constraints for saving data to the database. - * @Default {Object} - */ - validationRules?: any; - - /** It is used to set the particular editparams in the card for editing. - * @Default {Object} - */ - editParams?: any; - - /** It is used to specify defaultValue for the fields while adding new card. - * @Default {null} - */ - defaultValue?: string|number; -} - -export interface EditSettings { - - /** Gets or sets a value that indicates whether to enable the editing action in cards of Kanban. - * @Default {false} - */ - allowEditing?: boolean; - - /** Gets or sets a value that indicates whether to enable the adding action in cards behavior on Kanban. - * @Default {false} - */ - allowAdding?: boolean; - - /** This specifies the id of the template which is require to be edited using the Dialog Box. - * @Default {null} - */ - dialogTemplate?: string; - - /** Get or sets an object that indicates whether to customize the editMode of the Kanban. - * @Default {ej.Kanban.EditMode.Dialog} - */ - editMode?: ej.Kanban.EditMode|string; - - /** Get or sets an object that indicates whether to customize the editing fields of Kanban card. - * @Default {Array} - */ - editItems?: EditSettingsEditItem[]; - - /** This specifies the id of the template which is require to be edited using the External edit form. - * @Default {null} - */ - externalFormTemplate?: string; - - /** This specifies to set the position of an External edit form either in the right or bottom of the Kanban. - * @Default {ej.Kanban.FormPosition.Bottom} - */ - formPosition?: ej.Kanban.FormPosition|string; -} - -export interface Fields { - - /** The primarykey field is mapped to data source field. And this will used for Drag and drop and editing mainly. - * @Default {null} - */ - primaryKey?: string; - - /** To enable swimlane grouping based on the given key field from datasource mapping. - * @Default {null} - */ - swimlaneKey?: string; - - /** Priority field has been mapped data source field to maintain cards priority. - * @Default {null} - */ - priority?: string; - - /** Content field has been Mapped into card text. - * @Default {null} - */ - content?: string; - - /** Tag field has been Mapped into card tag. - * @Default {null} - */ - tag?: string; - - /** Title field has been Mapped to field in datasource for title content. If title field specified , card expand/collapse will be enabled with header and content section. - * @Default {null} - */ - title?: string; - - /** To customize the card has been Mapped into card color field. - * @Default {null} - */ - color?: string; - - /** ImageUrl field has been Mapped into card image. - * @Default {null} - */ - imageUrl?: string; -} - -export interface FilterSetting { - - /** Gets or sets an object of display name to filter queries. - * @Default {null} - */ - text?: string; - - /** Gets or sets an object that Queries to perform filtering - * @Default {Object} - */ - query?: any; - - /** Gets or sets an object of tooltip to filter buttons. - * @Default {null} - */ - description?: string; -} - -export interface ScrollSettings { - - /** Gets or sets an object that indicates to render the Kanban with specified scroll height. - * @Default {0} - */ - height?: string|number; - - /** Gets or sets an object that indicates to render the Kanban with specified scroll width. - * @Default {auto} - */ - width?: string|number; - - /** To allow the Kanban to freeze particular swimlane at the time of scrolling , until scroll reaches next swimlane and it continues. - * @Default {false} - */ - allowFreezeSwimlane?: boolean; -} - -export interface SearchSettings { - - /** To customize the fields the searching operation can be perform. - * @Default {Array} - */ - fields?: any[]; + /** Returns the Kanban model. + */ + model?: any; + + /** Returns the name of the event. + */ + type?: string; + + /** Returns the toolbar object of the Kanban. + */ + toolbarData?: any; + } + + export interface SwimlaneSettingsUnassignedGroup { + + /** To enable or disable unassigned category change with swim lane key values. + * @Default {true} + */ + enable?: boolean; + + /** To set the user defined values which are need to categorized as unassigned category swim lane groups. + * @Default {[null,undefined,]} + */ + keys?: any[]; + } + + export interface SwimlaneSettings { + + /** To enable or disable items count in swim lane. + * @Default {true} + */ + showCount?: boolean; + + /** To enable or disable DragAndDrop across swim lane. + * @Default {false} + */ + allowDragAndDrop?: boolean; + + /** Customize the settings for unassigned category of swim lane. + * @Default {Object} + */ + unassignedGroup?: SwimlaneSettingsUnassignedGroup; + } + + export interface ContextMenuSettingsCustomMenuItem { + + /** Its sets target element to custom context menu item. + * @Default {ej.Kanban.Target.All} + */ + target?: ej.Kanban.Target | string; + + /** Gets the display name to custom menu item. + * @Default {null} + */ + text?: string; + + /** Gets the template to render custom context menu item. + * @Default {null} + */ + template?: string; + } + + export interface ContextMenuSettings { + + /** To enable context menu.All default context menu will show. + * @Default {false} + */ + enable?: boolean; + + /** Gets or sets a value that indicates the list of items needs to be disable from default context menu items. + * @Default {Array} + */ + disableDefaultItems?: any[]; + + /** Its used to add specific default context menu items. + * @Default {Array} + */ + menuItems?: any[]; + + /** Gets or sets a value that indicates whether to add custom contextMenu items. + * @Default {Array} + */ + customMenuItems?: ContextMenuSettingsCustomMenuItem[]; + } + + export interface ColumnsTotalCount { + + /** To customize the totalCount text properties. + * @Default {null} + */ + text?: string; + } + + export interface ColumnsConstraints { + + /** It is used to specify the type of constraints as column or swimlane. + * @Default {null} + */ + type?: string; + + /** It is used to specify the minimum amount of card in particular column cell or swimlane cell can hold. + * @Default {null} + */ + min?: number; + + /** It is used to specify the maximum amount of card in particular column cell or swimlane cell can hold. + * @Default {null} + */ + max?: number; + } + + export interface Column { + + /** Gets or sets an object that indicates to render the Kanban with specified columns header text. + * @Default {null} + */ + headerText?: string; + + /** To customize the totalCount properties. + * @Default {Object} + */ + totalCount?: ColumnsTotalCount; + + /** Gets or sets an object that indicates to render the Kanban with specified columns key. + * @Default {null} + */ + key?: string | number; + + /** To enable/disable allowDrop for specific column wise. + * @Default {true} + */ + allowDrop?: boolean; + + /** To enable/disable allowDrag for specific column wise. + * @Default {true} + */ + allowDrag?: boolean; + + /** To set column collapse or expand state + * @Default {false} + */ + isCollapsed?: boolean; + + /** To customize the column level constraints with minimum ,maximum limit validation. + * @Default {Object} + */ + constraints?: ColumnsConstraints; + + /** Gets or sets a value that indicates to add the template within the header element. + * @Default {null} + */ + headerTemplate?: string; + + /** Gets or sets an object that indicates to render the Kanban with specified columns width. + * @Default {null} + */ + width?: string | number; + + /** Gets or sets an object that indicates to set specific column visibility. + * @Default {true} + */ + visible?: boolean; + + /** Gets or sets an object that indicates whether to show add new button. + * @Default {false} + */ + showAddButton?: boolean; + } + + export interface CardSettings { + + /** Gets or sets a value that indicates to add the template for card . + * @Default {null} + */ + template?: string; + + /** To customize the card border color based on assigned task. Colors and corresponding values defined here will be mapped with colorField mapped data source column. + * @Default {Object} + */ + colorMapping?: any; + } + + export interface CustomToolbarItem { + + /** Gets the template to render customToolbarItems. + * @Default {null} + */ + template?: string; + } + + export interface EditSettingsEditItem { + + /** It is used to map editing field from the data source. + * @Default {null} + */ + field?: string; + + /** It is used to set the particular editType in the card for editing. + * @Default {ej.Kanban.EditingType.String} + */ + editType?: ej.Kanban.EditingType | string; + + /** Gets or sets a value that indicates to define constraints for saving data to the database. + * @Default {Object} + */ + validationRules?: any; + + /** It is used to set the particular editparams in the card for editing. + * @Default {Object} + */ + editParams?: any; + + /** It is used to specify defaultValue for the fields while adding new card. + * @Default {null} + */ + defaultValue?: string | number; + } + + export interface EditSettings { + + /** Gets or sets a value that indicates whether to enable the editing action in cards of Kanban. + * @Default {false} + */ + allowEditing?: boolean; + + /** Gets or sets a value that indicates whether to enable the adding action in cards behavior on Kanban. + * @Default {false} + */ + allowAdding?: boolean; + + /** This specifies the id of the template which is require to be edited using the Dialog Box. + * @Default {null} + */ + dialogTemplate?: string; + + /** Get or sets an object that indicates whether to customize the editMode of the Kanban. + * @Default {ej.Kanban.EditMode.Dialog} + */ + editMode?: ej.Kanban.EditMode | string; + + /** Get or sets an object that indicates whether to customize the editing fields of Kanban card. + * @Default {Array} + */ + editItems?: EditSettingsEditItem[]; + + /** This specifies the id of the template which is require to be edited using the External edit form. + * @Default {null} + */ + externalFormTemplate?: string; + + /** This specifies to set the position of an External edit form either in the right or bottom of the Kanban. + * @Default {ej.Kanban.FormPosition.Bottom} + */ + formPosition?: ej.Kanban.FormPosition | string; + } + + export interface Fields { + + /** The primarykey field is mapped to data source field. And this will used for Drag and drop and editing mainly. + * @Default {null} + */ + primaryKey?: string; + + /** To enable swimlane grouping based on the given key field from datasource mapping. + * @Default {null} + */ + swimlaneKey?: string; + + /** Priority field has been mapped data source field to maintain cards priority. + * @Default {null} + */ + priority?: string; + + /** Content field has been Mapped into card text. + * @Default {null} + */ + content?: string; + + /** Tag field has been Mapped into card tag. + * @Default {null} + */ + tag?: string; + + /** Title field has been Mapped to field in datasource for title content. If title field specified , card expand/collapse will be enabled with header and content section. + * @Default {null} + */ + title?: string; + + /** To customize the card has been Mapped into card color field. + * @Default {null} + */ + color?: string; + + /** ImageUrl field has been Mapped into card image. + * @Default {null} + */ + imageUrl?: string; + } + + export interface FilterSetting { + + /** Gets or sets an object of display name to filter queries. + * @Default {null} + */ + text?: string; + + /** Gets or sets an object that Queries to perform filtering + * @Default {Object} + */ + query?: any; + + /** Gets or sets an object of tooltip to filter buttons. + * @Default {null} + */ + description?: string; + } + + export interface ScrollSettings { + + /** Gets or sets an object that indicates to render the Kanban with specified scroll height. + * @Default {0} + */ + height?: string | number; + + /** Gets or sets an object that indicates to render the Kanban with specified scroll width. + * @Default {auto} + */ + width?: string | number; + + /** To allow the Kanban to freeze particular swimlane at the time of scrolling , until scroll reaches next swimlane and it continues. + * @Default {false} + */ + allowFreezeSwimlane?: boolean; + } + + export interface SearchSettings { + + /** To customize the fields the searching operation can be perform. + * @Default {Array} + */ + fields?: any[]; - /** To customize the searching string. - */ - key?: string; + /** To customize the searching string. + */ + key?: string; - /** To customize the operator based on searching. - * @Default {contains} - */ - operator?: string; + /** To customize the operator based on searching. + * @Default {contains} + */ + operator?: string; - /** To customize the ignore case based on searching. - * @Default {true} - */ - ignoreCase?: boolean; -} + /** To customize the ignore case based on searching. + * @Default {true} + */ + ignoreCase?: boolean; + } -export interface StackedHeaderRowsStackedHeaderColumn { + export interface StackedHeaderRowsStackedHeaderColumn { - /** Gets or sets a value that indicates the headerText for the particular stacked header column. - * @Default {null} - */ - headerText?: string; + /** Gets or sets a value that indicates the headerText for the particular stacked header column. + * @Default {null} + */ + headerText?: string; - /** Gets or sets a value that indicates the column for the particular stacked header column. - * @Default {null} - */ - column?: string; -} + /** Gets or sets a value that indicates the column for the particular stacked header column. + * @Default {null} + */ + column?: string; + } -export interface StackedHeaderRow { + export interface StackedHeaderRow { - /** Gets or sets a value that indicates whether to add stacked header columns into the stacked header rows. - * @Default {Array} - */ - stackedHeaderColumns?: StackedHeaderRowsStackedHeaderColumn[]; -} + /** Gets or sets a value that indicates whether to add stacked header columns into the stacked header rows. + * @Default {Array} + */ + stackedHeaderColumns?: StackedHeaderRowsStackedHeaderColumn[]; + } -export interface TooltipSettings { + export interface TooltipSettings { - /** To enable or disable the tooltip display. - * @Default {false} - */ - enable?: boolean; + /** To enable or disable the tooltip display. + * @Default {false} + */ + enable?: boolean; - /** To customize the tooltip display based on your requirements. - * @Default {null} - */ - template?: string; -} + /** To customize the tooltip display based on your requirements. + * @Default {null} + */ + template?: string; + } -export interface Workflow { + export interface Workflow { - /** Gets or sets an object that indicates to render the Kanban with specified workflows key. - * @Default {null} - */ - key?: string|number; + /** Gets or sets an object that indicates to render the Kanban with specified workflows key. + * @Default {null} + */ + key?: string | number; - /** Gets or sets an object that indicates to render the Kanban with specified workflows allowed Transitions. - * @Default {null} - */ - allowedTransitions?: string; -} + /** Gets or sets an object that indicates to render the Kanban with specified workflows allowed Transitions. + * @Default {null} + */ + allowedTransitions?: string; + } -enum Target { + enum Target { - ///Sets context menu to Kanban header - Header, + ///Sets context menu to Kanban header + Header, - ///Sets context menu to Kanban content - Content, + ///Sets context menu to Kanban content + Content, - ///Sets context menu to Kanban card - Card, + ///Sets context menu to Kanban card + Card, - ///Sets context menu to Kanban - All -} + ///Sets context menu to Kanban + All + } -enum EditMode { + enum EditMode { - ///Creates Kanban with editMode as Dialog - Dialog, + ///Creates Kanban with editMode as Dialog + Dialog, - ///Creates Kanban with editMode as DialogTemplate - DialogTemplate, + ///Creates Kanban with editMode as DialogTemplate + DialogTemplate, - ///Creates Kanban with editMode as ExternalForm - ExternalForm, + ///Creates Kanban with editMode as ExternalForm + ExternalForm, - ///Creates Kanban with editMode as ExternalFormTemplate - ExternalFormTemplate -} + ///Creates Kanban with editMode as ExternalFormTemplate + ExternalFormTemplate + } -enum EditingType { + enum EditingType { - ///Allows to set edit type as string edit type - String, + ///Allows to set edit type as string edit type + String, - ///Allows to set edit type as numeric edit type - Numeric, + ///Allows to set edit type as numeric edit type + Numeric, - ///Allows to set edit type as drop down edit type - Dropdown, + ///Allows to set edit type as drop down edit type + Dropdown, - ///Allows to set edit type as date picker edit type - DatePicker, + ///Allows to set edit type as date picker edit type + DatePicker, - ///Allows to set edit type as date time picker edit type - DateTimePicker, + ///Allows to set edit type as date time picker edit type + DateTimePicker, - ///Allows to set edit type as text area edit type - TextArea, + ///Allows to set edit type as text area edit type + TextArea, - ///Allows to set edit type as RTE edit type - RTE -} + ///Allows to set edit type as RTE edit type + RTE + } -enum FormPosition { + enum FormPosition { - ///Form position is bottom. - Bottom, + ///Form position is bottom. + Bottom, - ///Form position is right. - Right -} + ///Form position is right. + Right + } -enum SelectionType { + enum SelectionType { - ///Support for Single selection in Kanban - Single, + ///Support for Single selection in Kanban + Single, - ///Support for multiple selections in Kanban - Multiple -} + ///Support for multiple selections in Kanban + Multiple + } -} + } -class Rotator extends ej.Widget { - static fn: Rotator; - constructor(element: JQuery | Element, options?: Rotator.Model); - static Locale: any; - model: Rotator.Model; - defaults: Rotator.Model; + class Rotator extends ej.Widget { + static fn: Rotator; + constructor(element: JQuery | Element, options?: Rotator.Model); + static Locale: any; + model: Rotator.Model; + defaults: Rotator.Model; - /** Disables the Rotator control. - * @returns {void} - */ - disable(): void; + /** Disables the Rotator control. + * @returns {void} + */ + disable(): void; - /** Enables the Rotator control. - * @returns {void} - */ - enable(): void; + /** Enables the Rotator control. + * @returns {void} + */ + enable(): void; - /** This method is used to get the current slide index. - * @returns {number} - */ - getIndex(): number; + /** This method is used to get the current slide index. + * @returns {number} + */ + getIndex(): number; - /** This method is used to move a slide to the specified index. - * @param {number} index of an slide - * @returns {void} - */ - gotoIndex(index: number): void; + /** This method is used to move a slide to the specified index. + * @param {number} index of an slide + * @returns {void} + */ + gotoIndex(index: number): void; - /** This method is used to pause autoplay. - * @returns {void} - */ - pause(): void; + /** This method is used to pause autoplay. + * @returns {void} + */ + pause(): void; - /** This method is used to move slides continuously (or start autoplay) in the specified autoplay direction. - * @returns {void} - */ - play(): void; + /** This method is used to move slides continuously (or start autoplay) in the specified autoplay direction. + * @returns {void} + */ + play(): void; - /** This method is used to move to the next slide from the current slide. If the current slide is the last slide, then the first slide will be treated as the next slide. - * @returns {void} - */ - slideNext(): void; + /** This method is used to move to the next slide from the current slide. If the current slide is the last slide, then the first slide will be treated as the next slide. + * @returns {void} + */ + slideNext(): void; - /** This method is used to move to the previous slide from the current slide. If the current slide is the first slide, then the last slide will be treated as the previous slide. - * @returns {void} - */ - slidePrevious(): void; - - /** This method is used to update/modify the slide content of template rotator by using id based on index value. - * @param {number} index of an slide - * @param {string} id of a new updated slide - * @returns {void} - */ - updateTemplateById(index: number, id: string): void; -} -export namespace Rotator { - -export interface Model { - - /** Turns on keyboard interaction with the Rotator items. You must set this property to true to access the following keyboard shortcuts: - * @Default {true} - */ - allowKeyboardNavigation?: boolean; - - /** Sets the animationSpeed of slide transition. - * @Default {600} - */ - animationSpeed?: string|number; - - /** Specifies the animationType type for the Rotator Item. animationType options include slide, fastSlide, slowSlide, and other custom easing animationTypes. - * @Default {slide} - */ - animationType?: string; - - /** Enables the circular mode item rotation. - * @Default {true} - */ - circularMode?: boolean; - - /** Specify the CSS class to Rotator to achieve custom theme. - */ - cssClass?: string; - - /** Specify the list of data which contains a set of data fields. Each data value is used to render an item for the Rotator. - * @Default {null} - */ - dataSource?: any; - - /** Sets the delay between the Rotator Items move after the slide transition. - * @Default {500} - */ - delay?: number; - - /** Specifies the number of Rotator Items to be displayed. - * @Default {1} - */ - displayItemsCount?: string|number; - - /** Rotates the Rotator Items continuously without user interference. - * @Default {false} - */ - enableAutoPlay?: boolean; - - /** Enables or disables the Rotator control. - * @Default {true} - */ - enabled?: boolean; - - /** Specifies right to left transition of slides. - * @Default {false} - */ - enableRTL?: boolean; - - /** Defines mapping fields for the data items of the Rotator. - * @Default {null} - */ - fields?: Fields; - - /** Sets the space between the Rotator Items. - */ - frameSpace?: string|number; - - /** Resizes the Rotator when the browser is resized. - * @Default {false} - */ - isResponsive?: boolean; - - /** Specifies the number of Rotator Items to navigate on a single click (next/previous/play buttons). - * The navigateSteps property value must be less than or equal to the displayItemsCount property value. - * @Default {1} - */ - navigateSteps?: string|number; - - /** Specifies the orientation for the Rotator control, that is, whether it must be rendered horizontally or vertically. See Orientation - * @Default {ej.Orientation.Horizontal} - */ - orientation?: ej.Orientation|string; - - /** Specifies the position of the showPager in the Rotator Item. See PagerPosition - * @Default {outside} - */ - pagerPosition?: string|ej.Rotator.PagerPosition; - - /** Retrieves data from remote data. This property is applicable only when a remote data source is used. - * @Default {null} - */ - query?: string; - - /** If the Rotator Item is an image, you can specify a caption for the Rotator Item. The caption text for each Rotator Item must be set by using the title attribute of the respective tag. - * The caption cannot be displayed if multiple Rotator Items are present. - * @Default {false} - */ - showCaption?: boolean; - - /** Turns on or off the slide buttons (next and previous) in the Rotator Items. Slide buttons are used to navigate the Rotator Items. - * @Default {true} - */ - showNavigateButton?: boolean; - - /** Turns on or off the pager support in the Rotator control. The Pager is used to navigate the Rotator Items. - * @Default {true} - */ - showPager?: boolean; - - /** Enable play / pause button on rotator. - * @Default {false} - */ - showPlayButton?: boolean; - - /** Turns on or off thumbnail support in the Rotator control. Thumbnail is used to navigate between slides. Thumbnail supports only single slide transition - * You must specify the source for thumbnail elements through the thumbnailSourceID property. - * @Default {false} - */ - showThumbnail?: boolean; - - /** Sets the height of a Rotator Item. - */ - slideHeight?: string|number; - - /** Sets the width of a Rotator Item. - */ - slideWidth?: string|number; - - /** Sets the index of the slide that must be displayed first. - * @Default {0} - */ - startIndex?: string|number; - - /** Pause the auto play while hover on the rotator content. - * @Default {false} - */ - stopOnHover?: boolean; - - /** The template to display the Rotator widget with customized appearance. - * @Default {null} - */ - template?: string; - - /** The templateId enables to bind multiple customized template items in Rotator. - * @Default {null} - */ - templateId?: any[]; - - /** Specifies the source for thumbnail elements. - * @Default {null} - */ - thumbnailSourceID?: any; - - /** This event is fired when the Rotator slides are changed. */ - change?(e: ChangeEventArgs): void; - - /** This event is fired when the Rotator control is initialized. */ - create?(e: CreateEventArgs): void; - - /** This event is fired when the Rotator control is destroyed. */ - destroy?(e: DestroyEventArgs): void; - - /** This event is fired when a pager is clicked. */ - pagerClick?(e: PagerClickEventArgs): void; - - /** This event is fired when enableAutoPlay is started. */ - start?(e: StartEventArgs): void; - - /** This event is fired when autoplay is stopped or paused. */ - stop?(e: StopEventArgs): void; - - /** This event is fired when a thumbnail pager is clicked. */ - thumbItemClick?(e: ThumbItemClickEventArgs): void; -} - -export interface ChangeEventArgs { + /** This method is used to move to the previous slide from the current slide. If the current slide is the first slide, then the last slide will be treated as the previous slide. + * @returns {void} + */ + slidePrevious(): void; + + /** This method is used to update/modify the slide content of template rotator by using id based on index value. + * @param {number} index of an slide + * @param {string} id of a new updated slide + * @returns {void} + */ + updateTemplateById(index: number, id: string): void; + } + export namespace Rotator { + + export interface Model { + + /** Turns on keyboard interaction with the Rotator items. You must set this property to true to access the following keyboard shortcuts: + * @Default {true} + */ + allowKeyboardNavigation?: boolean; + + /** Sets the animationSpeed of slide transition. + * @Default {600} + */ + animationSpeed?: string | number; + + /** Specifies the animationType type for the Rotator Item. animationType options include slide, fastSlide, slowSlide, and other custom easing animationTypes. + * @Default {slide} + */ + animationType?: string; + + /** Enables the circular mode item rotation. + * @Default {true} + */ + circularMode?: boolean; + + /** Specify the CSS class to Rotator to achieve custom theme. + */ + cssClass?: string; + + /** Specify the list of data which contains a set of data fields. Each data value is used to render an item for the Rotator. + * @Default {null} + */ + dataSource?: any; + + /** Sets the delay between the Rotator Items move after the slide transition. + * @Default {500} + */ + delay?: number; + + /** Specifies the number of Rotator Items to be displayed. + * @Default {1} + */ + displayItemsCount?: string | number; + + /** Rotates the Rotator Items continuously without user interference. + * @Default {false} + */ + enableAutoPlay?: boolean; + + /** Enables or disables the Rotator control. + * @Default {true} + */ + enabled?: boolean; + + /** Specifies right to left transition of slides. + * @Default {false} + */ + enableRTL?: boolean; + + /** Defines mapping fields for the data items of the Rotator. + * @Default {null} + */ + fields?: Fields; + + /** Sets the space between the Rotator Items. + */ + frameSpace?: string | number; + + /** Resizes the Rotator when the browser is resized. + * @Default {false} + */ + isResponsive?: boolean; + + /** Specifies the number of Rotator Items to navigate on a single click (next/previous/play buttons). + * The navigateSteps property value must be less than or equal to the displayItemsCount property value. + * @Default {1} + */ + navigateSteps?: string | number; + + /** Specifies the orientation for the Rotator control, that is, whether it must be rendered horizontally or vertically. See Orientation + * @Default {ej.Orientation.Horizontal} + */ + orientation?: ej.Orientation | string; + + /** Specifies the position of the showPager in the Rotator Item. See PagerPosition + * @Default {outside} + */ + pagerPosition?: string | ej.Rotator.PagerPosition; + + /** Retrieves data from remote data. This property is applicable only when a remote data source is used. + * @Default {null} + */ + query?: string; + + /** If the Rotator Item is an image, you can specify a caption for the Rotator Item. The caption text for each Rotator Item must be set by using the title attribute of the respective tag. + * The caption cannot be displayed if multiple Rotator Items are present. + * @Default {false} + */ + showCaption?: boolean; + + /** Turns on or off the slide buttons (next and previous) in the Rotator Items. Slide buttons are used to navigate the Rotator Items. + * @Default {true} + */ + showNavigateButton?: boolean; + + /** Turns on or off the pager support in the Rotator control. The Pager is used to navigate the Rotator Items. + * @Default {true} + */ + showPager?: boolean; + + /** Enable play / pause button on rotator. + * @Default {false} + */ + showPlayButton?: boolean; + + /** Turns on or off thumbnail support in the Rotator control. Thumbnail is used to navigate between slides. Thumbnail supports only single slide transition + * You must specify the source for thumbnail elements through the thumbnailSourceID property. + * @Default {false} + */ + showThumbnail?: boolean; + + /** Sets the height of a Rotator Item. + */ + slideHeight?: string | number; + + /** Sets the width of a Rotator Item. + */ + slideWidth?: string | number; + + /** Sets the index of the slide that must be displayed first. + * @Default {0} + */ + startIndex?: string | number; + + /** Pause the auto play while hover on the rotator content. + * @Default {false} + */ + stopOnHover?: boolean; + + /** The template to display the Rotator widget with customized appearance. + * @Default {null} + */ + template?: string; + + /** The templateId enables to bind multiple customized template items in Rotator. + * @Default {null} + */ + templateId?: any[]; + + /** Specifies the source for thumbnail elements. + * @Default {null} + */ + thumbnailSourceID?: any; + + /** This event is fired when the Rotator slides are changed. */ + change?(e: ChangeEventArgs): void; + + /** This event is fired when the Rotator control is initialized. */ + create?(e: CreateEventArgs): void; + + /** This event is fired when the Rotator control is destroyed. */ + destroy?(e: DestroyEventArgs): void; + + /** This event is fired when a pager is clicked. */ + pagerClick?(e: PagerClickEventArgs): void; + + /** This event is fired when enableAutoPlay is started. */ + start?(e: StartEventArgs): void; + + /** This event is fired when autoplay is stopped or paused. */ + stop?(e: StopEventArgs): void; + + /** This event is fired when a thumbnail pager is clicked. */ + thumbItemClick?(e: ThumbItemClickEventArgs): void; + } + + export interface ChangeEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the rotator model - */ - model?: ej.Rotator.Model; + /** returns the rotator model + */ + model?: ej.Rotator.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** the current rotator id. - */ - itemId?: string; + /** the current rotator id. + */ + itemId?: string; - /** returns the current slide index. - */ - activeItemIndex?: number; -} + /** returns the current slide index. + */ + activeItemIndex?: number; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the rotator model - */ - model?: ej.Rotator.Model; + /** returns the rotator model + */ + model?: ej.Rotator.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the rotator model - */ - model?: ej.Rotator.Model; + /** returns the rotator model + */ + model?: ej.Rotator.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface PagerClickEventArgs { + export interface PagerClickEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the rotator model - */ - model?: ej.Rotator.Model; + /** returns the rotator model + */ + model?: ej.Rotator.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** the current rotator id. - */ - itemId?: string; + /** the current rotator id. + */ + itemId?: string; - /** returns the current slide index. - */ - activeItemIndex?: number; -} + /** returns the current slide index. + */ + activeItemIndex?: number; + } -export interface StartEventArgs { + export interface StartEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the rotator model - */ - model?: ej.Rotator.Model; + /** returns the rotator model + */ + model?: ej.Rotator.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** the current rotator id. - */ - itemId?: string; + /** the current rotator id. + */ + itemId?: string; - /** returns the current slide index. - */ - activeItemIndex?: number; -} + /** returns the current slide index. + */ + activeItemIndex?: number; + } -export interface StopEventArgs { + export interface StopEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the rotator model - */ - model?: ej.Rotator.Model; + /** returns the rotator model + */ + model?: ej.Rotator.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** the current rotator id. - */ - itemId?: string; + /** the current rotator id. + */ + itemId?: string; - /** returns the current slide index. - */ - activeItemIndex?: number; -} + /** returns the current slide index. + */ + activeItemIndex?: number; + } -export interface ThumbItemClickEventArgs { + export interface ThumbItemClickEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the rotator model - */ - model?: ej.Rotator.Model; + /** returns the rotator model + */ + model?: ej.Rotator.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** the current rotator id. - */ - itemId?: string; + /** the current rotator id. + */ + itemId?: string; - /** returns the current slide index. - */ - activeItemIndex?: number; -} + /** returns the current slide index. + */ + activeItemIndex?: number; + } -export interface Fields { + export interface Fields { - /** Specifies a link for the image. - */ - linkAttribute?: string; + /** Specifies a link for the image. + */ + linkAttribute?: string; - /** Specifies where to open a given link. - */ - targetAttribute?: string; + /** Specifies where to open a given link. + */ + targetAttribute?: string; - /** Specifies a caption for the image. - */ - text?: string; + /** Specifies a caption for the image. + */ + text?: string; - /** Specifies a caption for the thumbnail image. - */ - thumbnailText?: string; + /** Specifies a caption for the thumbnail image. + */ + thumbnailText?: string; - /** Specifies the URL for an thumbnail image. - */ - thumbnailUrl?: string; + /** Specifies the URL for an thumbnail image. + */ + thumbnailUrl?: string; - /** Specifies the URL for an image. - */ - url?: string; -} - -enum PagerPosition { - - ///string - BottomLeft, - - ///string - BottomRight, - - ///string - Outside, - - ///string - TopCenter, - - ///string - TopLeft, - - ///string - TopRight -} - -} - -class RTE extends ej.Widget { - static fn: RTE; - constructor(element: JQuery | Element, options?: RTE.Model); - static Locale: any; - model: RTE.Model; - defaults: RTE.Model; - - /** Returns the range object. - * @returns {any} - */ - createRange(): any; - - /** Disables the RTE control. - * @returns {void} - */ - disable(): void; - - /** Disables the corresponding tool in the RTE ToolBar. - * @returns {void} - */ - disableToolbarItem(): void; - - /** Enables the RTE control. - * @returns {void} - */ - enable(): void; - - /** Enables the corresponding tool in the toolbar when the tool is disabled. - * @returns {void} - */ - enableToolbarItem(): void; - - /** Performs the action value based on the given command. - * @returns {void} - */ - executeCommand(): void; - - /** Focuses the RTE control. - * @returns {void} - */ - focus(): void; - - /** Gets the command status of the selected text based on the given comment in the RTE control. - * @returns {boolean} - */ - getCommandStatus(): boolean; - - /** Gets the Document from the RTE control. - * @returns {Document} - */ - getDocument(): Document; - - /** Gets the HTML string from the RTE control. - * @returns {HTMLElement} - */ - getHtml(): HTMLElement; - - /** Gets the selected HTML string from the RTE control. - * @returns {HTMLElement} - */ - getSelectedHtml(): HTMLElement; - - /** Gets the content as string from the RTE control. - * @returns {string} - */ - getText(): string; - - /** Hides the RTE control. - * @returns {void} - */ - hide(): void; - - /** Inserts new item to the target contextmenu node. - * @returns {void} - */ - insertMenuOption(): void; - - /** Add a table column at the right or left of the specified cell - * @param {boolean} If itĂ¢â‚¬â„¢s true, add a column at the left of the cell, otherwise add a column at the right of the cell - * @param {JQuery} Column will be added based on the given cell element - * @returns {HTMLElement} - */ - insertColumn(before?: boolean, cell?: JQuery): HTMLElement; - - /** To add a table row below or above the specified cell. - * @param {boolean} If itĂ¢â‚¬â„¢s true, add a row before the cell, otherwise add a row after the cell - * @param {JQuery} Row will be added based on the given cell element - * @returns {HTMLElement} - */ - insertRow(before?: boolean, cell?: JQuery): HTMLElement; - - /** This method helps to insert/paste the content at the current cursor (caret) position or the selected content to be replaced with our text by passing the value as parameter to the - * pasteContent method in the Editor. - * @returns {void} - */ - pasteContent(): void; - - /** Refreshes the RTE control. - * @returns {void} - */ - refresh(): void; - - /** Removes the specified table column. - * @param {JQuery} Remove the given column element - * @returns {void} - */ - removeColumn(cell?: JQuery): void; - - /** Removes the specified table row. - * @param {JQuery} Remove the given row element - * @returns {void} - */ - removeRow(cell?: JQuery): void; - - /** Deletes the specified table. - * @param {JQuery} Remove the given table - * @returns {void} - */ - removeTable(table?: JQuery): void; - - /** Removes the target menu item from the RTE contextmenu. - * @returns {void} - */ - removeMenuOption(): void; - - /** Removes the given tool from the RTE Toolbar. - * @returns {void} - */ - removeToolbarItem(): void; - - /** Selects all the contents within the RTE. - * @returns {void} - */ - selectAll(): void; - - /** Selects the contents in the given range. - * @returns {void} - */ - selectRange(): void; - - /** Sets the color picker model type rendered initially in the RTE control. - * @returns {void} - */ - setColorPickerType(): void; - - /** Sets the HTML string from the RTE control. - * @returns {void} - */ - setHtml(): void; - - /** Displays the RTE control. - * @returns {void} - */ - show(): void; -} -export namespace RTE { - -export interface Model { - - /** Enables/disables the editing of the content. - * @Default {True} - */ - allowEditing?: boolean; - - /** RTE control can be accessed through the keyboard shortcut keys. - * @Default {True} - */ - allowKeyboardNavigation?: boolean; - - /** When the property is set to true, it focuses the RTE at the time of rendering. - * @Default {false} - */ - autoFocus?: boolean; - - /** Based on the content size, its height is adjusted instead of adding the scrollbar. - * @Default {false} - */ - autoHeight?: boolean; - - /** Sets the colorCode to display the color of the fontColor and backgroundColor in the font tools of the RTE. - * @Default {[000000, FFFFFF, C4C4C4, ADADAD, 595959, 262626, 4f81bd, dbe5f1, b8cce4, 95b3d7, 366092, 244061, c0504d, f2dcdb, e5b9b7, d99694, 953734,632423, 9bbb59, - * ebf1dd, d7e3bc, c3d69b, 76923c, 4f6128, 8064a2, e5e0ec, ccc1d9, b2a2c7, 5f497a, 3f3151, f79646, fdeada, fbd5b5, fac08f,e36c09, 974806]} - */ - colorCode?: any; - - /** The number of columns given are rendered in the color palate popup. - * @Default {6} - */ - colorPaletteColumns?: number; - - /** The number of rows given are rendered in the color palate popup. - * @Default {6} - */ - colorPaletteRows?: number; - - /** Sets the root class for the RTE theme. This cssClass API helps the usage of custom skinning option for the RTE control by including this root class in CSS. - */ - cssClass?: string; - - /** Enables/disables the RTE controlĂ¢â‚¬â„¢s accessibility or interaction. - * @Default {True} - */ - enabled?: boolean; - - /** When the property is set to true, it returns the encrypted text. - * @Default {false} - */ - enableHtmlEncode?: boolean; - - /** Maintain the values of the RTE after page reload. - * @Default {false} - */ - enablePersistence?: boolean; - - /** Shows the resize icon and enables the resize option in the RTE. - * @Default {True} - */ - enableResize?: boolean; - - /** Shows the RTE in the RTL direction. - * @Default {false} - */ - enableRTL?: boolean; - - /** Formats the contents based on the XHTML rules. - * @Default {false} - */ - enableXHTML?: boolean; - - /** Enables the tab key action with the RichTextEditor content. - * @Default {True} - */ - enableTabKeyNavigation?: boolean; - - /** This API allows to enable url and fileName for pdf export. - * @Default {null} - */ - exportToPdfSettings?: ExportToPdfSettings; - - /** This API allows to enable url and fileName for word export. - * @Default {null} - */ - exportToWordSettings?: ExportToWordSettings; - - /** Load the external CSS file inside Iframe. - * @Default {null} - */ - externalCSS?: string; - - /** This API allows to enable the file browser support in the RTE control to browse, create, delete and upload the files in the specified current directory. - * @Default {null} - */ - fileBrowser?: FileBrowser; - - /** Sets the fontName in the RTE. - * @Default {{text: Segoe UI, value: Segoe UI },{text: Arial, value: Arial,Helvetica,sans-serif },{text: Courier New, value: Courier New,Courier,Monospace }, - * {text: Georgia, value: Georgia,serif },{text: Impact, value: Impact,Charcoal,sans-serif },{text: Lucida Console, value: Lucida Console,Monaco,Monospace }, - * {text: Tahoma, value: Tahoma,Geneva,sans-serif },{text: Times New Roman, value: Times New Roman },{text: Trebuchet MS, value: Trebuchet MS,Helvetica,sans-serif }, - * {text: Verdana, value: Verdana,Geneva,sans-serif}} - */ - fontName?: any; - - /** Sets the fontSize in the RTE. - * @Default {{ text: 1, value: 1 },{ text: 2 (10pt), value: 2 },{ text: 3 (12pt), value: 3 },{ text: 4 (14pt), value: 4 },{ text: 5 (18pt), value: 5 }, - * { text: 6 (24pt), value: 6 },{ text: 7 (36pt), value: 7 }} - */ - fontSize?: any; - - /** Sets the format in the RTE. - * @Default {{ text: Paragraph, value: <p>, spriteCssClass: e-paragraph },{ text: Quotation, value: <blockquote>, spriteCssClass: e-quotation }, - * { text: Heading 1, value: <h1>, spriteCssClass: e-h1 },{ text: Heading 2, value: <h2>, spriteCssClass: e-h2 },{ text: Heading 3, value: <h3>, spriteCssClass: e-h3 }, - * { text: Heading 4, value: <h4>, spriteCssClass: e-h4 },{ text: Heading 5, value: <h5>, spriteCssClass: e-h5 },{ text: Heading 6, value: <h6>, spriteCssClass: e-h6}} - */ - format?: string; - - /** Defines the height of the RTE textbox. - * @Default {370} - */ - height?: string|number; - - /** Specifies the HTML Attributes of the ejRTE. - * @Default {{}} - */ - htmlAttributes?: any; - - /** Sets the given attributes to the iframe body element. - * @Default {{}} - */ - iframeAttributes?: any; - - /** This API allows the image browser to support in the RTE control to browse, create, delete, and upload the image files to the specified current directory. - * @Default {null} - */ - imageBrowser?: ImageBrowser; - - /** This API allows to enable the url for connecting to RTE import. - * @Default {null} - */ - importSettings?: ImportSettings; - - /** Enables/disables responsive support for the RTE control toolbar items during the window resizing time. - * @Default {false} - */ - isResponsive?: boolean; - - /** Sets the culture in the RTE when you set the localization values are needs to be assigned to the corresponding text as follows. - * @Default {en-US} - */ - locale?: string; - - /** Sets the maximum height for the RTE outer wrapper element. - * @Default {null} - */ - maxHeight?: string|number; - - /** Sets the maximum length for the RTE outer wrapper element. - * @Default {7000} - */ - maxLength?: number; - - /** Sets the maximum width for the RTE outer wrapper element. - * @Default {null} - */ - maxWidth?: string|number; - - /** Sets the minimum height for the RTE outer wrapper element. - * @Default {280} - */ - minHeight?: string|number; - - /** Sets the minimum width for the RTE outer wrapper element. - * @Default {400} - */ - minWidth?: string|number; - - /** Sets the name in the RTE. When the name value is not initialized, the ID value is assigned to the name. - */ - name?: string; - - /** Shows ClearAll icon in the RTE footer. - * @Default {false} - */ - showClearAll?: boolean; - - /** Shows the clear format in the RTE footer. - * @Default {true} - */ - showClearFormat?: boolean; - - /** Shows the Custom Table in the RTE. - * @Default {True} - */ - showCustomTable?: boolean; - - /** The showContextMenu property helps to enable custom context menu within editor area. - * @Default {True} - */ - showContextMenu?: boolean; - - /** This API is used to set the default dimensions for the image and video. When this property is set to true, the image and video dialog displays the dimension option. - * @Default {false} - */ - showDimensions?: boolean; - - /** Shows the FontOption in the RTE. - * @Default {True} - */ - showFontOption?: boolean; - - /** Shows footer in the RTE. When the footer is enabled, it displays the HTML tag, word Count, character count, clear format, resize icon and clear all the content icons, by default. - * @Default {false} - */ - showFooter?: boolean; - - /** Shows the HtmlSource in the RTE footer. - * @Default {false} - */ - showHtmlSource?: boolean; - - /** When the cursor is placed or when the text is selected in the RTE, it displays the tag info in the footer. - * @Default {True} - */ - showHtmlTagInfo?: boolean; - - /** Shows the toolbar in the RTE. - * @Default {True} - */ - showToolbar?: boolean; - - /** Counts the total characters and displays it in the RTE footer. - * @Default {True} - */ - showCharCount?: boolean; - - /** Enables or disables rounded corner UI look for RTE. - * @Default {false} - */ - showRoundedCorner?: boolean; - - /** Counts the total words and displays it in the RTE footer. - * @Default {True} - */ - showWordCount?: boolean; - - /** The given number of columns render the insert table pop. - * @Default {10} - */ - tableColumns?: number; - - /** The given number of rows render the insert table pop. - * @Default {8} - */ - tableRows?: number; - - /** Sets the tools in the RTE and gets the inner display order of the corresponding group element. Tools are dependent on the toolsList property. - * @Default {formatStyle: [format],style: [bold, italic, underline, strikethrough],alignment: [justifyLeft, justifyCenter, justifyRight, justifyFull],lists: [unorderedList, orderedList], - * indenting: [outdent, indent],doAction: [undo, redo],links: [createLink,removeLink],images: [image],media: [video],tables: [createTable, addRowAbove, addRowBelow, - * addColumnLeft, addColumnRight, deleteRow, deleteColumn, deleteTable]],view:[Ă¢â‚¬Å“fullScreenĂ¢â‚¬Â,zoomIn,zoomOut],print:[print]} - */ - tools?: Tools; - - /** Specifies the list of groups and order of those groups displayed in the RTE toolbar. The toolsList property is used to get the root group order and tools property is used to get the - * inner order of the corresponding groups displayed. When the value is not specified, it gets its default display order and tools. - * @Default {[formatStyle, font, style, effects, alignment, lists, indenting, clipboard, doAction, clear, links, images, media, tables, casing,view, customTools,print,edit]} - */ - toolsList?: any[]; - - /** Display the hints for the tools in the Toolbar. - * @Default {{ associate: mouseenter, showShadow: true, position: { stem: { horizontal: left, vertical: top } }, tip: { size: { width: 5, height: 5 }, isBalloon: false }} - */ - tooltipSettings?: any; - - /** Gets the undo stack limit. - * @Default {50} - */ - undoStackLimit?: number; - - /** The given string value is displayed in the editable area. - * @Default {null} - */ - value?: string; - - /** Sets the jQuery validation rules to the Rich Text Editor. - * @Default {null} - */ - validationRules?: any; - - /** Sets the jQuery validation error message to the Rich Text Editor. - * @Default {null} - */ - validationMessage?: any; - - /** Defines the width of the RTE textbox. - * @Default {786} - */ - width?: string|number; - - /** Increases and decreases the contents zoom range in percentage - * @Default {0.05} - */ - zoomStep?: string|number; - - /** Fires when changed successfully. */ - change?(e: ChangeEventArgs): void; - - /** Fires when the RTE is created successfully */ - create?(e: CreateEventArgs): void; - - /** Fires when mouse click on menu items. */ - contextMenuClick?(e: ContextMenuClickEventArgs): void; - - /** Fires before the RTE is destroyed. */ - destroy?(e: DestroyEventArgs): void; - - /** Fires when the commands are executed successfully. */ - execute?(e: ExecuteEventArgs): void; - - /** Fires when the keydown action is successful. */ - keydown?(e: KeydownEventArgs): void; - - /** Fires when the keyup action is successful. */ - keyup?(e: KeyupEventArgs): void; + /** Specifies the URL for an image. + */ + url?: string; + } + + enum PagerPosition { + + ///string + BottomLeft, + + ///string + BottomRight, + + ///string + Outside, + + ///string + TopCenter, + + ///string + TopLeft, + + ///string + TopRight + } + + } + + class RTE extends ej.Widget { + static fn: RTE; + constructor(element: JQuery | Element, options?: RTE.Model); + static Locale: any; + model: RTE.Model; + defaults: RTE.Model; + + /** Returns the range object. + * @returns {any} + */ + createRange(): any; + + /** Disables the RTE control. + * @returns {void} + */ + disable(): void; + + /** Disables the corresponding tool in the RTE ToolBar. + * @returns {void} + */ + disableToolbarItem(): void; + + /** Enables the RTE control. + * @returns {void} + */ + enable(): void; + + /** Enables the corresponding tool in the toolbar when the tool is disabled. + * @returns {void} + */ + enableToolbarItem(): void; + + /** Performs the action value based on the given command. + * @returns {void} + */ + executeCommand(): void; + + /** Focuses the RTE control. + * @returns {void} + */ + focus(): void; + + /** Gets the command status of the selected text based on the given comment in the RTE control. + * @returns {boolean} + */ + getCommandStatus(): boolean; + + /** Gets the Document from the RTE control. + * @returns {Document} + */ + getDocument(): Document; + + /** Gets the HTML string from the RTE control. + * @returns {HTMLElement} + */ + getHtml(): HTMLElement; + + /** Gets the selected HTML string from the RTE control. + * @returns {HTMLElement} + */ + getSelectedHtml(): HTMLElement; + + /** Gets the content as string from the RTE control. + * @returns {string} + */ + getText(): string; + + /** Hides the RTE control. + * @returns {void} + */ + hide(): void; + + /** Inserts new item to the target contextmenu node. + * @returns {void} + */ + insertMenuOption(): void; + + /** Add a table column at the right or left of the specified cell + * @param {boolean} If itĂ¢â‚¬â„¢s true, add a column at the left of the cell, otherwise add a column at the right of the cell + * @param {JQuery} Column will be added based on the given cell element + * @returns {HTMLElement} + */ + insertColumn(before?: boolean, cell?: JQuery): HTMLElement; + + /** To add a table row below or above the specified cell. + * @param {boolean} If itĂ¢â‚¬â„¢s true, add a row before the cell, otherwise add a row after the cell + * @param {JQuery} Row will be added based on the given cell element + * @returns {HTMLElement} + */ + insertRow(before?: boolean, cell?: JQuery): HTMLElement; + + /** This method helps to insert/paste the content at the current cursor (caret) position or the selected content to be replaced with our text by passing the value as parameter to the + * pasteContent method in the Editor. + * @returns {void} + */ + pasteContent(): void; + + /** Refreshes the RTE control. + * @returns {void} + */ + refresh(): void; + + /** Removes the specified table column. + * @param {JQuery} Remove the given column element + * @returns {void} + */ + removeColumn(cell?: JQuery): void; + + /** Removes the specified table row. + * @param {JQuery} Remove the given row element + * @returns {void} + */ + removeRow(cell?: JQuery): void; + + /** Deletes the specified table. + * @param {JQuery} Remove the given table + * @returns {void} + */ + removeTable(table?: JQuery): void; + + /** Removes the target menu item from the RTE contextmenu. + * @returns {void} + */ + removeMenuOption(): void; + + /** Removes the given tool from the RTE Toolbar. + * @returns {void} + */ + removeToolbarItem(): void; + + /** Selects all the contents within the RTE. + * @returns {void} + */ + selectAll(): void; + + /** Selects the contents in the given range. + * @returns {void} + */ + selectRange(): void; + + /** Sets the color picker model type rendered initially in the RTE control. + * @returns {void} + */ + setColorPickerType(): void; + + /** Sets the HTML string from the RTE control. + * @returns {void} + */ + setHtml(): void; + + /** Displays the RTE control. + * @returns {void} + */ + show(): void; + } + export namespace RTE { + + export interface Model { + + /** Enables/disables the editing of the content. + * @Default {True} + */ + allowEditing?: boolean; + + /** RTE control can be accessed through the keyboard shortcut keys. + * @Default {True} + */ + allowKeyboardNavigation?: boolean; + + /** When the property is set to true, it focuses the RTE at the time of rendering. + * @Default {false} + */ + autoFocus?: boolean; + + /** Based on the content size, its height is adjusted instead of adding the scrollbar. + * @Default {false} + */ + autoHeight?: boolean; + + /** Sets the colorCode to display the color of the fontColor and backgroundColor in the font tools of the RTE. + * @Default {[000000, FFFFFF, C4C4C4, ADADAD, 595959, 262626, 4f81bd, dbe5f1, b8cce4, 95b3d7, 366092, 244061, c0504d, f2dcdb, e5b9b7, d99694, 953734,632423, 9bbb59, + * ebf1dd, d7e3bc, c3d69b, 76923c, 4f6128, 8064a2, e5e0ec, ccc1d9, b2a2c7, 5f497a, 3f3151, f79646, fdeada, fbd5b5, fac08f,e36c09, 974806]} + */ + colorCode?: any; + + /** The number of columns given are rendered in the color palate popup. + * @Default {6} + */ + colorPaletteColumns?: number; + + /** The number of rows given are rendered in the color palate popup. + * @Default {6} + */ + colorPaletteRows?: number; + + /** Sets the root class for the RTE theme. This cssClass API helps the usage of custom skinning option for the RTE control by including this root class in CSS. + */ + cssClass?: string; + + /** Enables/disables the RTE controlĂ¢â‚¬â„¢s accessibility or interaction. + * @Default {True} + */ + enabled?: boolean; + + /** When the property is set to true, it returns the encrypted text. + * @Default {false} + */ + enableHtmlEncode?: boolean; + + /** Maintain the values of the RTE after page reload. + * @Default {false} + */ + enablePersistence?: boolean; + + /** Shows the resize icon and enables the resize option in the RTE. + * @Default {True} + */ + enableResize?: boolean; + + /** Shows the RTE in the RTL direction. + * @Default {false} + */ + enableRTL?: boolean; + + /** Formats the contents based on the XHTML rules. + * @Default {false} + */ + enableXHTML?: boolean; + + /** Enables the tab key action with the RichTextEditor content. + * @Default {True} + */ + enableTabKeyNavigation?: boolean; + + /** This API allows to enable url and fileName for pdf export. + * @Default {null} + */ + exportToPdfSettings?: ExportToPdfSettings; + + /** This API allows to enable url and fileName for word export. + * @Default {null} + */ + exportToWordSettings?: ExportToWordSettings; + + /** Load the external CSS file inside Iframe. + * @Default {null} + */ + externalCSS?: string; + + /** This API allows to enable the file browser support in the RTE control to browse, create, delete and upload the files in the specified current directory. + * @Default {null} + */ + fileBrowser?: FileBrowser; + + /** Sets the fontName in the RTE. + * @Default {{text: Segoe UI, value: Segoe UI },{text: Arial, value: Arial,Helvetica,sans-serif },{text: Courier New, value: Courier New,Courier,Monospace }, + * {text: Georgia, value: Georgia,serif },{text: Impact, value: Impact,Charcoal,sans-serif },{text: Lucida Console, value: Lucida Console,Monaco,Monospace }, + * {text: Tahoma, value: Tahoma,Geneva,sans-serif },{text: Times New Roman, value: Times New Roman },{text: Trebuchet MS, value: Trebuchet MS,Helvetica,sans-serif }, + * {text: Verdana, value: Verdana,Geneva,sans-serif}} + */ + fontName?: any; + + /** Sets the fontSize in the RTE. + * @Default {{ text: 1, value: 1 },{ text: 2 (10pt), value: 2 },{ text: 3 (12pt), value: 3 },{ text: 4 (14pt), value: 4 },{ text: 5 (18pt), value: 5 }, + * { text: 6 (24pt), value: 6 },{ text: 7 (36pt), value: 7 }} + */ + fontSize?: any; + + /** Sets the format in the RTE. + * @Default {{ text: Paragraph, value: <p>, spriteCssClass: e-paragraph },{ text: Quotation, value: <blockquote>, spriteCssClass: e-quotation }, + * { text: Heading 1, value: <h1>, spriteCssClass: e-h1 },{ text: Heading 2, value: <h2>, spriteCssClass: e-h2 },{ text: Heading 3, value: <h3>, spriteCssClass: e-h3 }, + * { text: Heading 4, value: <h4>, spriteCssClass: e-h4 },{ text: Heading 5, value: <h5>, spriteCssClass: e-h5 },{ text: Heading 6, value: <h6>, spriteCssClass: e-h6}} + */ + format?: string; + + /** Defines the height of the RTE textbox. + * @Default {370} + */ + height?: string | number; + + /** Specifies the HTML Attributes of the ejRTE. + * @Default {{}} + */ + htmlAttributes?: any; + + /** Sets the given attributes to the iframe body element. + * @Default {{}} + */ + iframeAttributes?: any; + + /** This API allows the image browser to support in the RTE control to browse, create, delete, and upload the image files to the specified current directory. + * @Default {null} + */ + imageBrowser?: ImageBrowser; + + /** This API allows to enable the url for connecting to RTE import. + * @Default {null} + */ + importSettings?: ImportSettings; + + /** Enables/disables responsive support for the RTE control toolbar items during the window resizing time. + * @Default {false} + */ + isResponsive?: boolean; + + /** Sets the culture in the RTE when you set the localization values are needs to be assigned to the corresponding text as follows. + * @Default {en-US} + */ + locale?: string; + + /** Sets the maximum height for the RTE outer wrapper element. + * @Default {null} + */ + maxHeight?: string | number; + + /** Sets the maximum length for the RTE outer wrapper element. + * @Default {7000} + */ + maxLength?: number; + + /** Sets the maximum width for the RTE outer wrapper element. + * @Default {null} + */ + maxWidth?: string | number; + + /** Sets the minimum height for the RTE outer wrapper element. + * @Default {280} + */ + minHeight?: string | number; + + /** Sets the minimum width for the RTE outer wrapper element. + * @Default {400} + */ + minWidth?: string | number; + + /** Sets the name in the RTE. When the name value is not initialized, the ID value is assigned to the name. + */ + name?: string; + + /** Shows ClearAll icon in the RTE footer. + * @Default {false} + */ + showClearAll?: boolean; + + /** Shows the clear format in the RTE footer. + * @Default {true} + */ + showClearFormat?: boolean; + + /** Shows the Custom Table in the RTE. + * @Default {True} + */ + showCustomTable?: boolean; + + /** The showContextMenu property helps to enable custom context menu within editor area. + * @Default {True} + */ + showContextMenu?: boolean; + + /** This API is used to set the default dimensions for the image and video. When this property is set to true, the image and video dialog displays the dimension option. + * @Default {false} + */ + showDimensions?: boolean; + + /** Shows the FontOption in the RTE. + * @Default {True} + */ + showFontOption?: boolean; + + /** Shows footer in the RTE. When the footer is enabled, it displays the HTML tag, word Count, character count, clear format, resize icon and clear all the content icons, by default. + * @Default {false} + */ + showFooter?: boolean; + + /** Shows the HtmlSource in the RTE footer. + * @Default {false} + */ + showHtmlSource?: boolean; + + /** When the cursor is placed or when the text is selected in the RTE, it displays the tag info in the footer. + * @Default {True} + */ + showHtmlTagInfo?: boolean; + + /** Shows the toolbar in the RTE. + * @Default {True} + */ + showToolbar?: boolean; + + /** Counts the total characters and displays it in the RTE footer. + * @Default {True} + */ + showCharCount?: boolean; + + /** Enables or disables rounded corner UI look for RTE. + * @Default {false} + */ + showRoundedCorner?: boolean; + + /** Counts the total words and displays it in the RTE footer. + * @Default {True} + */ + showWordCount?: boolean; + + /** The given number of columns render the insert table pop. + * @Default {10} + */ + tableColumns?: number; + + /** The given number of rows render the insert table pop. + * @Default {8} + */ + tableRows?: number; + + /** Sets the tools in the RTE and gets the inner display order of the corresponding group element. Tools are dependent on the toolsList property. + * @Default {formatStyle: [format],style: [bold, italic, underline, strikethrough],alignment: [justifyLeft, justifyCenter, justifyRight, justifyFull],lists: [unorderedList, orderedList], + * indenting: [outdent, indent],doAction: [undo, redo],links: [createLink,removeLink],images: [image],media: [video],tables: [createTable, addRowAbove, addRowBelow, + * addColumnLeft, addColumnRight, deleteRow, deleteColumn, deleteTable]],view:[Ă¢â‚¬Å“fullScreenĂ¢â‚¬Â,zoomIn,zoomOut],print:[print]} + */ + tools?: Tools; + + /** Specifies the list of groups and order of those groups displayed in the RTE toolbar. The toolsList property is used to get the root group order and tools property is used to get the + * inner order of the corresponding groups displayed. When the value is not specified, it gets its default display order and tools. + * @Default {[formatStyle, font, style, effects, alignment, lists, indenting, clipboard, doAction, clear, links, images, media, tables, casing,view, customTools,print,edit]} + */ + toolsList?: any[]; + + /** Display the hints for the tools in the Toolbar. + * @Default {{ associate: mouseenter, showShadow: true, position: { stem: { horizontal: left, vertical: top } }, tip: { size: { width: 5, height: 5 }, isBalloon: false }} + */ + tooltipSettings?: any; + + /** Gets the undo stack limit. + * @Default {50} + */ + undoStackLimit?: number; + + /** The given string value is displayed in the editable area. + * @Default {null} + */ + value?: string; + + /** Sets the jQuery validation rules to the Rich Text Editor. + * @Default {null} + */ + validationRules?: any; + + /** Sets the jQuery validation error message to the Rich Text Editor. + * @Default {null} + */ + validationMessage?: any; + + /** Defines the width of the RTE textbox. + * @Default {786} + */ + width?: string | number; + + /** Increases and decreases the contents zoom range in percentage + * @Default {0.05} + */ + zoomStep?: string | number; + + /** Fires when changed successfully. */ + change?(e: ChangeEventArgs): void; + + /** Fires when the RTE is created successfully */ + create?(e: CreateEventArgs): void; + + /** Fires when mouse click on menu items. */ + contextMenuClick?(e: ContextMenuClickEventArgs): void; + + /** Fires before the RTE is destroyed. */ + destroy?(e: DestroyEventArgs): void; + + /** Fires when the commands are executed successfully. */ + execute?(e: ExecuteEventArgs): void; + + /** Fires when the keydown action is successful. */ + keydown?(e: KeydownEventArgs): void; + + /** Fires when the keyup action is successful. */ + keyup?(e: KeyupEventArgs): void; - /** Fires before the RTE Edit area is rendered and after the toolbar is rendered. */ - preRender?(e: PreRenderEventArgs): void; + /** Fires before the RTE Edit area is rendered and after the toolbar is rendered. */ + preRender?(e: PreRenderEventArgs): void; - /** Fires when the text is selected in the text area */ - select?(e: SelectEventArgs): void; -} + /** Fires when the text is selected in the text area */ + select?(e: SelectEventArgs): void; + } -export interface ChangeEventArgs { + export interface ChangeEventArgs { - /** When the event is canceled; otherwise, false. - */ - cancel?: boolean; + /** When the event is canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the RTE model - */ - model?: any; + /** returns the RTE model + */ + model?: any; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** When the event is canceled; otherwise, false. - */ - cancel?: boolean; + /** When the event is canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the RTE model - */ - model?: any; + /** Returns the RTE model + */ + model?: any; - /** Returns the name of the event - */ - type?: string; -} + /** Returns the name of the event + */ + type?: string; + } -export interface ContextMenuClickEventArgs { + export interface ContextMenuClickEventArgs { - /** returns clicked menu item text. - */ - text?: string; + /** returns clicked menu item text. + */ + text?: string; - /** returns clicked menu item element. - */ - element?: any; + /** returns clicked menu item element. + */ + element?: any; - /** returns the selected item. - */ - selectedItem?: number; -} + /** returns the selected item. + */ + selectedItem?: number; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** When the event is canceled; otherwise, false. - */ - cancel?: boolean; + /** When the event is canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the RTE model - */ - model?: any; + /** Returns the RTE model + */ + model?: any; - /** Returns the name of the event - */ - type?: string; -} + /** Returns the name of the event + */ + type?: string; + } -export interface ExecuteEventArgs { + export interface ExecuteEventArgs { - /** When the event is canceled; otherwise, false. - */ - cancel?: boolean; + /** When the event is canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the RTE model - */ - model?: any; + /** Returns the RTE model + */ + model?: any; - /** Returns the name of the event - */ - type?: string; -} + /** Returns the name of the event + */ + type?: string; + } -export interface KeydownEventArgs { + export interface KeydownEventArgs { - /** When the event is canceled; otherwise, false. - */ - cancel?: boolean; + /** When the event is canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the RTE model - */ - model?: any; + /** Returns the RTE model + */ + model?: any; - /** Returns the name of the event - */ - type?: string; -} + /** Returns the name of the event + */ + type?: string; + } -export interface KeyupEventArgs { + export interface KeyupEventArgs { - /** When the event is canceled; otherwise, false. - */ - cancel?: boolean; + /** When the event is canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the RTE model - */ - model?: any; + /** Returns the RTE model + */ + model?: any; - /** Returns the name of the event - */ - type?: string; -} + /** Returns the name of the event + */ + type?: string; + } -export interface PreRenderEventArgs { + export interface PreRenderEventArgs { - /** When the event is canceled; otherwise, false. - */ - cancel?: boolean; + /** When the event is canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the RTE model - */ - model?: any; + /** Returns the RTE model + */ + model?: any; - /** Returns the name of the event - */ - type?: string; -} + /** Returns the name of the event + */ + type?: string; + } -export interface SelectEventArgs { + export interface SelectEventArgs { - /** When the event is canceled; otherwise, false. - */ - cancel?: boolean; + /** When the event is canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the RTE model - */ - model?: any; + /** Returns the RTE model + */ + model?: any; - /** Returns the name of the event - */ - type?: string; + /** Returns the name of the event + */ + type?: string; - /** Returns the event object - */ - event?: any; -} + /** Returns the event object + */ + event?: any; + } -export interface ExportToPdfSettings { + export interface ExportToPdfSettings { - /** This API is used to receive the server-side handler for export related operations. - */ - url?: string; + /** This API is used to receive the server-side handler for export related operations. + */ + url?: string; - /** Specifies the file name for the exported pdf file. - */ - fileName?: string; -} + /** Specifies the file name for the exported pdf file. + */ + fileName?: string; + } -export interface ExportToWordSettings { + export interface ExportToWordSettings { - /** This API is used to receive the server-side handler for export related operations. - */ - url?: string; + /** This API is used to receive the server-side handler for export related operations. + */ + url?: string; - /** Specifies the file name for the exported word file. - */ - fileName?: string; -} + /** Specifies the file name for the exported word file. + */ + fileName?: string; + } -export interface FileBrowser { + export interface FileBrowser { - /** This API is used to receive the server-side handler for file related operations. - */ - ajaxAction?: string; + /** This API is used to receive the server-side handler for file related operations. + */ + ajaxAction?: string; - /** Specifies the file type extension shown in the file browser window. - */ - extensionAllow?: string; + /** Specifies the file type extension shown in the file browser window. + */ + extensionAllow?: string; - /** Specifies the directory to perform operations like create, delete and rename folder and files, and upload the selected files to the current directory. - */ - filePath?: string; -} + /** Specifies the directory to perform operations like create, delete and rename folder and files, and upload the selected files to the current directory. + */ + filePath?: string; + } -export interface ImageBrowser { + export interface ImageBrowser { - /** This API is used to receive the server-side handler for the file related operations. - */ - ajaxAction?: string; + /** This API is used to receive the server-side handler for the file related operations. + */ + ajaxAction?: string; - /** Specifies the file type extension shown in the image browser window. - */ - extensionAllow?: string; + /** Specifies the file type extension shown in the image browser window. + */ + extensionAllow?: string; - /** Specifies the directory to perform operations like create, delete and rename folder and files, and upload the selected images to the current directory. - */ - filePath?: string; -} + /** Specifies the directory to perform operations like create, delete and rename folder and files, and upload the selected images to the current directory. + */ + filePath?: string; + } -export interface ImportSettings { + export interface ImportSettings { - /** This API is used to receive the server-side handler for import operations. - */ - url?: string; -} + /** This API is used to receive the server-side handler for import operations. + */ + url?: string; + } -export interface ToolsCustomOrderedList { + export interface ToolsCustomOrderedList { - /** Specifies the name for customOrderedList item. - */ - name?: string; + /** Specifies the name for customOrderedList item. + */ + name?: string; - /** Specifies the title for customOrderedList item. - */ - tooltip?: string; + /** Specifies the title for customOrderedList item. + */ + tooltip?: string; - /** Specifies the styles for customOrderedList item. - */ - css?: string; + /** Specifies the styles for customOrderedList item. + */ + css?: string; - /** Specifies the text for customOrderedList item. - */ - text?: string; + /** Specifies the text for customOrderedList item. + */ + text?: string; - /** Specifies the list style for customOrderedList item. - */ - listStyle?: string; + /** Specifies the list style for customOrderedList item. + */ + listStyle?: string; - /** Specifies the image for customOrderedList item. - */ - listImage?: string; -} + /** Specifies the image for customOrderedList item. + */ + listImage?: string; + } -export interface ToolsCustomUnorderedList { + export interface ToolsCustomUnorderedList { - /** Specifies the name for customUnorderedList item. - */ - name?: string; + /** Specifies the name for customUnorderedList item. + */ + name?: string; - /** Specifies the title for customUnorderedList item. - */ - tooltip?: string; + /** Specifies the title for customUnorderedList item. + */ + tooltip?: string; - /** Specifies the styles for customUnorderedList item. - */ - css?: string; + /** Specifies the styles for customUnorderedList item. + */ + css?: string; - /** Specifies the text for customUnorderedList item. - */ - text?: string; + /** Specifies the text for customUnorderedList item. + */ + text?: string; - /** Specifies the list style for customUnorderedList item. - */ - listStyle?: string; + /** Specifies the list style for customUnorderedList item. + */ + listStyle?: string; - /** Specifies the image for customUnorderedList item. - */ - listImage?: string; -} + /** Specifies the image for customUnorderedList item. + */ + listImage?: string; + } -export interface Tools { + export interface Tools { - /** Specifies the alignment tools and the display order of this tool in the RTE toolbar. - */ - alignment?: any; + /** Specifies the alignment tools and the display order of this tool in the RTE toolbar. + */ + alignment?: any; - /** Specifies the casing tools and the display order of this tool in the RTE toolbar. - */ - casing?: any[]; + /** Specifies the casing tools and the display order of this tool in the RTE toolbar. + */ + casing?: any[]; - /** Specifies the clear tools and the display order of this tool in the RTE toolbar. - */ - clear?: any[]; - - /** Specifies the clipboard tools and the display order of this tool in the RTE toolbar. - */ - clipboard?: any[]; - - /** Specifies the edit tools and the displays tool in the RTE toolbar. - */ - edit?: any[]; - - /** Specifies the doAction tools and the display order of this tool in the RTE toolbar. - */ - doAction?: any[]; - - /** Specifies the effect of tools and the display order of this tool in RTE toolbar. - */ - effects?: any[]; - - /** Specifies the font tools and the display order of this tool in the RTE toolbar. - */ - font?: any[]; - - /** Specifies the formatStyle tools and the display order of this tool in the RTE toolbar. - */ - formatStyle?: any[]; - - /** Specifies the image tools and the display order of this tool in the RTE toolbar. - */ - images?: any[]; - - /** Specifies the indent tools and the display order of this tool in the RTE toolbar. - */ - indenting?: any[]; - - /** Specifies the link tools and the display order of this tool in the RTE toolbar. - */ - links?: any[]; - - /** Specifies the list tools and the display order of this tool in the RTE toolbar. - */ - lists?: any[]; - - /** Specifies the media tools and the display order of this tool in the RTE toolbar. - */ - media?: any[]; - - /** Specifies the style tools and the display order of this tool in the RTE toolbar. - */ - style?: any[]; - - /** Specifies the table tools and the display order of this tool in the RTE toolbar. - */ - tables?: any[]; - - /** Specifies the view tools and the display order of this tool in the RTE toolbar. - */ - view?: any[]; - - /** Specifies the print tools and the display order of this tool in the RTE toolbar. - */ - print?: any[]; - - /** Specifies the importExport tools and the display order of this tool in the RTE toolbar. - */ - importExport?: any[]; - - /** Specifies the customOrderedList tools and the display order of this tool in the RTE toolbar. - */ - customOrderedList?: ToolsCustomOrderedList[]; - - /** Specifies the customUnOrderedList tools and the display order of this tool in the RTE toolbar. - */ - customUnorderedList?: ToolsCustomUnorderedList[]; -} -} - -class Slider extends ej.Widget { - static fn: Slider; - constructor(element: JQuery | Element, options?: Slider.Model); - static Locale: any; - model: Slider.Model; - defaults: Slider.Model; - - /** To disable the slider - * @returns {void} - */ - disable(): void; - - /** To enable the slider - * @returns {void} - */ - enable(): void; - - /** To get value from slider handle - * @returns {number} - */ - getValue(): number; - - /** To set value to slider handle.By default animation is false while set the value. If you want to enable the animation, pass the enableAnimation as true to this method. - * @returns {void} - */ - setValue(): void; -} -export namespace Slider { - -export interface Model { - - /** Specifies the allowMouseWheel of the slider. - * @Default {false} - */ - allowMouseWheel?: boolean; - - /** Specifies the animationSpeed of the slider. - * @Default {500} - */ - animationSpeed?: number; - - /** Specify the CSS class to slider to achieve custom theme. - */ - cssClass?: string; - - /** Specifies the animation behavior of the slider. - * @Default {true} - */ - enableAnimation?: boolean; - - /** Specifies the state of the slider. - * @Default {true} - */ - enabled?: boolean; - - /** Specify the enablePersistence to slider to save current model value to browser cookies for state maintains - * @Default {false} - */ - enablePersistence?: boolean; - - /** Specifies the Right to Left Direction of the slider. - * @Default {false} - */ - enableRTL?: boolean; - - /** Specifies the height of the slider. - * @Default {14} - */ - height?: string; - - /** Specifies the HTML Attributes of the ejSlider. - * @Default {{}} - */ - htmlAttributes?: any; - - /** Specifies the incremental step value of the slider. - * @Default {1} - */ - incrementStep?: number; - - /** Specifies the distance between two major (large) ticks from the scale of the slider. - * @Default {10} - */ - largeStep?: number; - - /** Specifies the ending value of the slider. - * @Default {100} - */ - maxValue?: number; - - /** Specifies the starting value of the slider. - * @Default {0} - */ - minValue?: number; - - /** Specifies the orientation of the slider. - * @Default {ej.orientation.Horizontal} - */ - orientation?: ej.Orientation|string; - - /** Specifies the readOnly of the slider. - * @Default {false} - */ - readOnly?: boolean; - - /** Specifies the rounded corner behavior for slider. - * @Default {false} - */ - showRoundedCorner?: boolean; - - /** Shows/Hide the major (large) and minor (small) ticks in the scale of the slider. - * @Default {false} - */ - showScale?: boolean; - - /** Specifies the small ticks from the scale of the slider. - * @Default {true} - */ - showSmallTicks?: boolean; - - /** Specifies the showTooltip to shows the current Slider value, while moving the Slider handle or clicking on the slider handle of the slider. - * @Default {true} - */ - showTooltip?: boolean; - - /** Specifies the sliderType of the slider. - * @Default {ej.SliderType.Default} - */ - sliderType?: ej.slider.sliderType|string; - - /** Specifies the distance between two minor (small) ticks from the scale of the slider. - * @Default {1} - */ - smallStep?: number; - - /** Specifies the value of the slider. But it's not applicable for range slider. To range slider we can use values property. - * @Default {0} - */ - value?: number; - - /** Specifies the values of the range slider. But it's not applicable for default and minRange sliders. we can use value property for default and minRange sliders. - * @Default {[minValue,maxValue]} - */ - values?: any[]; - - /** Specifies the width of the slider. - * @Default {100%} - */ - width?: string; - - /** Fires once Slider control value is changed successfully. */ - change?(e: ChangeEventArgs): void; - - /** Fires once Slider control has been created successfully. */ - create?(e: CreateEventArgs): void; - - /** Fires when Slider control has been destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; - - /** Fires once Slider control is sliding successfully. */ - slide?(e: SlideEventArgs): void; - - /** Fires once Slider control is started successfully. */ - start?(e: StartEventArgs): void; - - /** Fires when Slider control is stopped successfully. */ - stop?(e: StopEventArgs): void; - - /** Fires when display the custom tooltip */ - tooltipChange?(e: TooltipChangeEventArgs): void; -} - -export interface ChangeEventArgs { + /** Specifies the clear tools and the display order of this tool in the RTE toolbar. + */ + clear?: any[]; + + /** Specifies the clipboard tools and the display order of this tool in the RTE toolbar. + */ + clipboard?: any[]; + + /** Specifies the edit tools and the displays tool in the RTE toolbar. + */ + edit?: any[]; + + /** Specifies the doAction tools and the display order of this tool in the RTE toolbar. + */ + doAction?: any[]; + + /** Specifies the effect of tools and the display order of this tool in RTE toolbar. + */ + effects?: any[]; + + /** Specifies the font tools and the display order of this tool in the RTE toolbar. + */ + font?: any[]; + + /** Specifies the formatStyle tools and the display order of this tool in the RTE toolbar. + */ + formatStyle?: any[]; + + /** Specifies the image tools and the display order of this tool in the RTE toolbar. + */ + images?: any[]; + + /** Specifies the indent tools and the display order of this tool in the RTE toolbar. + */ + indenting?: any[]; + + /** Specifies the link tools and the display order of this tool in the RTE toolbar. + */ + links?: any[]; + + /** Specifies the list tools and the display order of this tool in the RTE toolbar. + */ + lists?: any[]; + + /** Specifies the media tools and the display order of this tool in the RTE toolbar. + */ + media?: any[]; + + /** Specifies the style tools and the display order of this tool in the RTE toolbar. + */ + style?: any[]; + + /** Specifies the table tools and the display order of this tool in the RTE toolbar. + */ + tables?: any[]; + + /** Specifies the view tools and the display order of this tool in the RTE toolbar. + */ + view?: any[]; + + /** Specifies the print tools and the display order of this tool in the RTE toolbar. + */ + print?: any[]; + + /** Specifies the importExport tools and the display order of this tool in the RTE toolbar. + */ + importExport?: any[]; + + /** Specifies the customOrderedList tools and the display order of this tool in the RTE toolbar. + */ + customOrderedList?: ToolsCustomOrderedList[]; + + /** Specifies the customUnOrderedList tools and the display order of this tool in the RTE toolbar. + */ + customUnorderedList?: ToolsCustomUnorderedList[]; + } + } + + class Slider extends ej.Widget { + static fn: Slider; + constructor(element: JQuery | Element, options?: Slider.Model); + static Locale: any; + model: Slider.Model; + defaults: Slider.Model; + + /** To disable the slider + * @returns {void} + */ + disable(): void; + + /** To enable the slider + * @returns {void} + */ + enable(): void; + + /** To get value from slider handle + * @returns {number} + */ + getValue(): number; + + /** To set value to slider handle.By default animation is false while set the value. If you want to enable the animation, pass the enableAnimation as true to this method. + * @returns {void} + */ + setValue(): void; + } + export namespace Slider { + + export interface Model { + + /** Specifies the allowMouseWheel of the slider. + * @Default {false} + */ + allowMouseWheel?: boolean; + + /** Specifies the animationSpeed of the slider. + * @Default {500} + */ + animationSpeed?: number; + + /** Specify the CSS class to slider to achieve custom theme. + */ + cssClass?: string; + + /** Specifies the animation behavior of the slider. + * @Default {true} + */ + enableAnimation?: boolean; + + /** Specifies the state of the slider. + * @Default {true} + */ + enabled?: boolean; + + /** Specify the enablePersistence to slider to save current model value to browser cookies for state maintains + * @Default {false} + */ + enablePersistence?: boolean; + + /** Specifies the Right to Left Direction of the slider. + * @Default {false} + */ + enableRTL?: boolean; + + /** Specifies the height of the slider. + * @Default {14} + */ + height?: string; + + /** Specifies the HTML Attributes of the ejSlider. + * @Default {{}} + */ + htmlAttributes?: any; + + /** Specifies the incremental step value of the slider. + * @Default {1} + */ + incrementStep?: number; + + /** Specifies the distance between two major (large) ticks from the scale of the slider. + * @Default {10} + */ + largeStep?: number; + + /** Specifies the ending value of the slider. + * @Default {100} + */ + maxValue?: number; + + /** Specifies the starting value of the slider. + * @Default {0} + */ + minValue?: number; + + /** Specifies the orientation of the slider. + * @Default {ej.orientation.Horizontal} + */ + orientation?: ej.Orientation | string; + + /** Specifies the readOnly of the slider. + * @Default {false} + */ + readOnly?: boolean; + + /** Specifies the rounded corner behavior for slider. + * @Default {false} + */ + showRoundedCorner?: boolean; + + /** Shows/Hide the major (large) and minor (small) ticks in the scale of the slider. + * @Default {false} + */ + showScale?: boolean; + + /** Specifies the small ticks from the scale of the slider. + * @Default {true} + */ + showSmallTicks?: boolean; + + /** Specifies the showTooltip to shows the current Slider value, while moving the Slider handle or clicking on the slider handle of the slider. + * @Default {true} + */ + showTooltip?: boolean; + + /** Specifies the sliderType of the slider. + * @Default {ej.SliderType.Default} + */ + sliderType?: ej.slider.sliderType | string; + + /** Specifies the distance between two minor (small) ticks from the scale of the slider. + * @Default {1} + */ + smallStep?: number; + + /** Specifies the value of the slider. But it's not applicable for range slider. To range slider we can use values property. + * @Default {0} + */ + value?: number; + + /** Specifies the values of the range slider. But it's not applicable for default and minRange sliders. we can use value property for default and minRange sliders. + * @Default {[minValue,maxValue]} + */ + values?: any[]; + + /** Specifies the width of the slider. + * @Default {100%} + */ + width?: string; + + /** Fires once Slider control value is changed successfully. */ + change?(e: ChangeEventArgs): void; + + /** Fires once Slider control has been created successfully. */ + create?(e: CreateEventArgs): void; + + /** Fires when Slider control has been destroyed successfully. */ + destroy?(e: DestroyEventArgs): void; + + /** Fires once Slider control is sliding successfully. */ + slide?(e: SlideEventArgs): void; + + /** Fires once Slider control is started successfully. */ + start?(e: StartEventArgs): void; + + /** Fires when Slider control is stopped successfully. */ + stop?(e: StopEventArgs): void; + + /** Fires when display the custom tooltip */ + tooltipChange?(e: TooltipChangeEventArgs): void; + } + + export interface ChangeEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns current handle number or index - */ - sliderIndex?: number; + /** returns current handle number or index + */ + sliderIndex?: number; - /** returns slider id. - */ - id?: string; - - /** returns the slider model. - */ - model?: ej.Slider.Model; + /** returns slider id. + */ + id?: string; + + /** returns the slider model. + */ + model?: ej.Slider.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the slider value. - */ - value?: number; + /** returns the slider value. + */ + value?: number; - /** returns true if event triggered by interaction else returns false. - */ - isInteraction?: boolean; -} + /** returns true if event triggered by interaction else returns false. + */ + isInteraction?: boolean; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the slider model - */ - model?: ej.Slider.Model; + /** returns the slider model + */ + model?: ej.Slider.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the slider model - */ - model?: ej.Slider.Model; - - /** returns the name of the event - */ - type?: string; -} - -export interface SlideEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns current handle number or index - */ - sliderIndex?: number; - - /** returns slider id - */ - id?: string; - - /** returns the slider model - */ - model?: ej.Slider.Model; - - /** returns the name of the event - */ - type?: string; - - /** returns the slider value - */ - value?: number; -} - -export interface StartEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns current handle number or index - */ - sliderIndex?: number; - - /** returns slider id - */ - id?: string; - - /** returns the slider model - */ - model?: ej.Slider.Model; - - /** returns the name of the event - */ - type?: string; - - /** returns the slider value - */ - value?: number; -} - -export interface StopEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns current handle number or index - */ - sliderIndex?: number; - - /** returns slider id - */ - id?: string; - - /** returns the slider model - */ - model?: ej.Slider.Model; - - /** returns the name of the event - */ - type?: string; - - /** returns the slider value - */ - value?: number; -} - -export interface TooltipChangeEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; -} -} -namespace slider { -enum sliderType { -//Shows default slider -Default, -//Shows minRange slider -MinRange, -//Shows Range slider -Range, -} -} - -class SplitButton extends ej.Widget { - static fn: SplitButton; - constructor(element: JQuery | Element, options?: SplitButton.Model); - static Locale: any; - model: SplitButton.Model; - defaults: SplitButton.Model; - - /** Destroy the split button widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. - * @returns {void} - */ - destroy(): void; - - /** To disable the split button - * @returns {void} - */ - disable(): void; - - /** To Enable the split button - * @returns {void} - */ - enable(): void; - - /** To hide the list content of the split button. - * @returns {void} - */ - hide(): void; - - /** To show the list content of the split button. - * @returns {void} - */ - show(): void; -} -export namespace SplitButton { - -export interface Model { - - /** Specifies the arrowPosition of the Split or Dropdown Button.See arrowPosition - * @Default {ej.ArrowPosition.Right} - */ - arrowPosition?: string|ej.ArrowPosition; - - /** Specifies the buttonMode like Split or Dropdown Button.See ButtonMode - * @Default {ej.ButtonMode.Split} - */ - buttonMode?: string|ej.ButtonMode; - - /** Specifies the contentType of the Split Button.See ContentType - * @Default {ej.ContentType.TextOnly} - */ - contentType?: string|ej.ContentType; - - /** Set the root class for Split Button control theme - */ - cssClass?: string; - - /** Specifies the disabling of Split Button if enabled is set to false. - * @Default {true} - */ - enabled?: boolean; - - /** Specifies the enableRTL property for Split Button while initialization. - * @Default {false} - */ - enableRTL?: boolean; - - /** Specifies the height of the Split Button. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - height?: string|number; - - /** Specifies the HTML Attributes of the Split Button. - * @Default {{}} - */ - htmlAttributes?: any; - - /** Specifies the imagePosition of the Split Button.See imagePositions - * @Default {ej.ImagePosition.ImageRight} - */ - imagePosition?: string|ej.ImagePosition; - - /** Specifies the image content for Split Button while initialization. - */ - prefixIcon?: string; - - /** Specifies the showRoundedCorner property for Split Button while initialization. - * @Default {false} - */ - showRoundedCorner?: boolean; - - /** Specifies the size of the Button. See ButtonSize - * @Default {ej.ButtonSize.Normal} - */ - size?: string|ej.ButtonSize; - - /** Specifies the image content for Split Button while initialization. - */ - suffixIcon?: string; - - /** Specifies the list content for Split Button while initialization - */ - targetID?: string; - - /** Specifies the text content for Split Button while initialization. - */ - text?: string; - - /** Specifies the width of the Split Button. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - width?: string|number; + /** returns the slider model + */ + model?: ej.Slider.Model; + + /** returns the name of the event + */ + type?: string; + } + + export interface SlideEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns current handle number or index + */ + sliderIndex?: number; + + /** returns slider id + */ + id?: string; + + /** returns the slider model + */ + model?: ej.Slider.Model; + + /** returns the name of the event + */ + type?: string; + + /** returns the slider value + */ + value?: number; + } + + export interface StartEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns current handle number or index + */ + sliderIndex?: number; + + /** returns slider id + */ + id?: string; + + /** returns the slider model + */ + model?: ej.Slider.Model; + + /** returns the name of the event + */ + type?: string; + + /** returns the slider value + */ + value?: number; + } + + export interface StopEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns current handle number or index + */ + sliderIndex?: number; + + /** returns slider id + */ + id?: string; + + /** returns the slider model + */ + model?: ej.Slider.Model; + + /** returns the name of the event + */ + type?: string; + + /** returns the slider value + */ + value?: number; + } + + export interface TooltipChangeEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; + } + } + namespace slider { + enum sliderType { + //Shows default slider + Default, + //Shows minRange slider + MinRange, + //Shows Range slider + Range, + } + } + + class SplitButton extends ej.Widget { + static fn: SplitButton; + constructor(element: JQuery | Element, options?: SplitButton.Model); + static Locale: any; + model: SplitButton.Model; + defaults: SplitButton.Model; + + /** Destroy the split button widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. + * @returns {void} + */ + destroy(): void; + + /** To disable the split button + * @returns {void} + */ + disable(): void; + + /** To Enable the split button + * @returns {void} + */ + enable(): void; + + /** To hide the list content of the split button. + * @returns {void} + */ + hide(): void; + + /** To show the list content of the split button. + * @returns {void} + */ + show(): void; + } + export namespace SplitButton { + + export interface Model { + + /** Specifies the arrowPosition of the Split or Dropdown Button.See arrowPosition + * @Default {ej.ArrowPosition.Right} + */ + arrowPosition?: string | ej.ArrowPosition; + + /** Specifies the buttonMode like Split or Dropdown Button.See ButtonMode + * @Default {ej.ButtonMode.Split} + */ + buttonMode?: string | ej.ButtonMode; + + /** Specifies the contentType of the Split Button.See ContentType + * @Default {ej.ContentType.TextOnly} + */ + contentType?: string | ej.ContentType; + + /** Set the root class for Split Button control theme + */ + cssClass?: string; + + /** Specifies the disabling of Split Button if enabled is set to false. + * @Default {true} + */ + enabled?: boolean; + + /** Specifies the enableRTL property for Split Button while initialization. + * @Default {false} + */ + enableRTL?: boolean; + + /** Specifies the height of the Split Button. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + height?: string | number; + + /** Specifies the HTML Attributes of the Split Button. + * @Default {{}} + */ + htmlAttributes?: any; + + /** Specifies the imagePosition of the Split Button.See imagePositions + * @Default {ej.ImagePosition.ImageRight} + */ + imagePosition?: string | ej.ImagePosition; + + /** Specifies the image content for Split Button while initialization. + */ + prefixIcon?: string; + + /** Specifies the showRoundedCorner property for Split Button while initialization. + * @Default {false} + */ + showRoundedCorner?: boolean; + + /** Specifies the size of the Button. See ButtonSize + * @Default {ej.ButtonSize.Normal} + */ + size?: string | ej.ButtonSize; + + /** Specifies the image content for Split Button while initialization. + */ + suffixIcon?: string; + + /** Specifies the list content for Split Button while initialization + */ + targetID?: string; + + /** Specifies the text content for Split Button while initialization. + */ + text?: string; + + /** Specifies the width of the Split Button. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + width?: string | number; - /** Fires before menu of the split button control is opened. */ - beforeOpen?(e: BeforeOpenEventArgs): void; + /** Fires before menu of the split button control is opened. */ + beforeOpen?(e: BeforeOpenEventArgs): void; - /** Fires when Button control is clicked successfully */ - click?(e: ClickEventArgs): void; + /** Fires when Button control is clicked successfully */ + click?(e: ClickEventArgs): void; - /** Fires before the list content of Button control is closed */ - close?(e: CloseEventArgs): void; + /** Fires before the list content of Button control is closed */ + close?(e: CloseEventArgs): void; - /** Fires after Split Button control is created. */ - create?(e: CreateEventArgs): void; + /** Fires after Split Button control is created. */ + create?(e: CreateEventArgs): void; - /** Fires when the Split Button is destroyed successfully */ - destroy?(e: DestroyEventArgs): void; + /** Fires when the Split Button is destroyed successfully */ + destroy?(e: DestroyEventArgs): void; - /** Fires when a menu item is Hovered out successfully */ - itemMouseOut?(e: ItemMouseOutEventArgs): void; + /** Fires when a menu item is Hovered out successfully */ + itemMouseOut?(e: ItemMouseOutEventArgs): void; - /** Fires when a menu item is Hovered in successfully */ - itemMouseOver?(e: ItemMouseOverEventArgs): void; + /** Fires when a menu item is Hovered in successfully */ + itemMouseOver?(e: ItemMouseOverEventArgs): void; - /** Fires when a menu item is clicked successfully */ - itemSelected?(e: ItemSelectedEventArgs): void; + /** Fires when a menu item is clicked successfully */ + itemSelected?(e: ItemSelectedEventArgs): void; - /** Fires before the list content of Button control is opened */ - open?(e: OpenEventArgs): void; -} + /** Fires before the list content of Button control is opened */ + open?(e: OpenEventArgs): void; + } -export interface BeforeOpenEventArgs { + export interface BeforeOpenEventArgs { - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the split button model - */ - model?: ej.SplitButton.Model; + /** returns the split button model + */ + model?: ej.SplitButton.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface ClickEventArgs { + export interface ClickEventArgs { - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the split button model - */ - model?: ej.SplitButton.Model; + /** returns the split button model + */ + model?: ej.SplitButton.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the target of the current object. - */ - target?: any; + /** returns the target of the current object. + */ + target?: any; - /** return the button state - */ - status?: boolean; -} + /** return the button state + */ + status?: boolean; + } -export interface CloseEventArgs { + export interface CloseEventArgs { - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the split button model - */ - model?: ej.SplitButton.Model; + /** returns the split button model + */ + model?: ej.SplitButton.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the split button model - */ - model?: ej.SplitButton.Model; + /** returns the split button model + */ + model?: ej.SplitButton.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the split button model - */ - model?: ej.SplitButton.Model; + /** returns the split button model + */ + model?: ej.SplitButton.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface ItemMouseOutEventArgs { + export interface ItemMouseOutEventArgs { - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the split button model - */ - model?: ej.SplitButton.Model; + /** returns the split button model + */ + model?: ej.SplitButton.Model; - /** returns the name of the event - */ - type?: string; - - /** returns the clicked menu item element - */ - element?: any; - - /** return the menu item id - */ - ID?: string; - - /** return the clicked menu item text - */ - Text?: string; -} - -export interface ItemMouseOverEventArgs { - - /** returns the cancel option value - */ - cancel?: boolean; - - /** returns the split button model - */ - model?: ej.SplitButton.Model; - - /** returns the name of the event - */ - type?: string; - - /** returns the clicked menu item element - */ - element?: any; - - /** return the menu item id - */ - ID?: string; - - /** return the clicked menu item text - */ - Text?: string; -} - -export interface ItemSelectedEventArgs { - - /** returns the cancel option value - */ - cancel?: boolean; - - /** returns the split button model - */ - model?: ej.SplitButton.Model; - - /** returns the name of the event - */ - type?: string; - - /** returns the clicked menu item element - */ - element?: any; - - /** returns the selected item - */ - selectedItem?: any; - - /** return the menu id - */ - menuId?: string; - - /** return the clicked menu item text - */ - menuText?: string; -} - -export interface OpenEventArgs { - - /** returns the cancel option value - */ - cancel?: boolean; - - /** returns the split button model - */ - model?: ej.SplitButton.Model; - - /** returns the name of the event - */ - type?: string; -} -} -enum ArrowPosition { -//To set Left arrowPosition of the split button -Left, -//To set Right arrowPosition of the split button -Right, -//To set Top arrowPosition of the split button -Top, -//To set Bottom arrowPosition of the split button -Bottom, -} - -class Splitter extends ej.Widget { - static fn: Splitter; - constructor(element: JQuery | Element, options?: Splitter.Model); - static Locale: any; - model: Splitter.Model; - defaults: Splitter.Model; - - /** To add a new pane to splitter control. - * @param {string} content of pane. - * @param {any} pane properties. - * @param {number} index of pane. - * @returns {HTMLElement} - */ - addItem(content: string, property: any, index: number): HTMLElement; - - /** To collapse the splitter control pane. - * @param {number} index number of pane. - * @returns {void} - */ - collapse(paneIndex: number): void; - - /** To expand the splitter control pane. - * @param {number} index number of pane. - * @returns {void} - */ - expand(paneIndex: number): void; - - /** To refresh the splitter control pane resizing. - * @returns {void} - */ - refresh(): void; - - /** To remove a specified pane from the splitter control. - * @param {number} index of pane. - * @returns {void} - */ - removeItem(index: number): void; -} -export namespace Splitter { - -export interface Model { - - /** Turns on keyboard interaction with the Splitter panes. You must set this property to true to access the keyboard shortcuts of ejSplitter. - * @Default {true} - */ - allowKeyboardNavigation?: boolean; - - /** Specify animation speed for the Splitter pane movement, while collapsing and expanding. - * @Default {300} - */ - animationSpeed?: number; - - /** Specify the CSS class to splitter control to achieve custom theme. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - cssClass?: string; - - /** Specifies the animation behavior of the splitter. - * @Default {true} - */ - enableAnimation?: boolean; - - /** Specifies the splitter control to be displayed in right to left direction. - * @Default {false} - */ - enableRTL?: boolean; - - /** Specify height for splitter control. - * @Default {null} - */ - height?: string; - - /** Specifies the HTML Attributes of the Splitter. - * @Default {{}} - */ - htmlAttributes?: any; - - /** Specify window resizing behavior for splitter control. - * @Default {false} - */ - isResponsive?: boolean; - - /** Specify the orientation for splitter control. See orientation - * @Default {ej.orientation.Horizontal or Ă¢â‚¬Å“horizontalĂ¢â‚¬Â} - */ - orientation?: ej.Orientation|string; - - /** Specify properties for each pane like paneSize, minSize, maxSize, collapsible, expandable, resizable. - * @Default {[]} - */ - properties?: any[]; - - /** Specify width for splitter control. - * @Default {null} - */ - width?: string; - - /** Fires before expanding / collapsing the split pane of splitter control. */ - beforeExpandCollapse?(e: BeforeExpandCollapseEventArgs): void; - - /** Fires when splitter control pane has been created. */ - create?(e: CreateEventArgs): void; - - /** Fires when splitter control pane has been destroyed. */ - destroy?(e: DestroyEventArgs): void; - - /** Fires when expand / collapse operation in splitter control pane has been performed successfully. */ - expandCollapse?(e: ExpandCollapseEventArgs): void; - - /** Fires when resize in splitter control pane. */ - resize?(e: ResizeEventArgs): void; -} - -export interface BeforeExpandCollapseEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns collapsed pane details. - */ - collapsed?: any; - - /** returns expanded pane details. - */ - expanded?: any; - - /** returns the splitter model. - */ - model?: ej.Splitter.Model; - - /** returns the current split bar index. - */ - splitbarIndex?: number; - - /** returns the name of the event. - */ - type?: string; -} - -export interface CreateEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the splitter model. - */ - model?: ej.Splitter.Model; - - /** returns the name of the event. - */ - type?: string; -} - -export interface DestroyEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the splitter model. - */ - model?: ej.Splitter.Model; - - /** returns the name of the event. - */ - type?: string; -} - -export interface ExpandCollapseEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns collapsed pane details. - */ - collapsed?: any; - - /** returns expanded pane details. - */ - expanded?: any; - - /** returns the splitter model. - */ - model?: ej.Splitter.Model; - - /** returns the current split bar index. - */ - splitbarIndex?: number; - - /** returns the name of the event. - */ - type?: string; -} - -export interface ResizeEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns previous pane details. - */ - prevPane?: any; - - /** returns next pane details. - */ - nextPane?: any; - - /** returns the splitter model. - */ - model?: ej.Splitter.Model; - - /** returns the current split bar index. - */ - splitbarIndex?: number; - - /** returns the name of the event. - */ - type?: string; -} -} - -class Tab extends ej.Widget { - static fn: Tab; - constructor(element: JQuery | Element, options?: Tab.Model); - static Locale: any; - model: Tab.Model; - defaults: Tab.Model; - - /** Add new tab items with given name, URL and given index position, if index null itĂ¢â‚¬â„¢s add last item. - * @param {string} URL name / tab id. - * @param {string} Tab Display name. - * @param {number} Index position to placed , this is optional. - * @param {string} specifies cssClass, this is optional. - * @param {string} specifies id of tab, this is optional. - * @returns {void} - */ - addItem(URL: string, displayLabel: string, index: number, cssClass: string, id: string): void; - - /** To disable the tab control. - * @returns {void} - */ - disable(): void; - - /** To enable the tab control. - * @returns {void} - */ - enable(): void; - - /** This function get the number of tab rendered - * @returns {number} - */ - getItemsCount(): number; - - /** This function hides the tab control. - * @returns {void} - */ - hide(): void; - - /** This function hides the specified item tab in tab control. - * @param {number} index of tab item. - * @returns {void} - */ - hideItem(index: number): void; - - /** Remove the given index tab item. - * @param {number} index of tab item. - * @returns {void} - */ - removeItem(index: number): void; - - /** This function is to show the tab control. - * @returns {void} - */ - show(): void; - - /** This function helps to show the specified hidden tab item in tab control. - * @param {number} index of tab item. - * @returns {void} - */ - showItem(index: number): void; -} -export namespace Tab { - -export interface Model { - - /** Specifies the ajaxSettings option to load the content to the Tab control. - */ - ajaxSettings?: AjaxSettings; - - /** Tab items interaction with keyboard keys, like headers active navigation. - * @Default {true} - */ - allowKeyboardNavigation?: boolean; - - /** Allow to collapsing the active item, while click on the active header. - * @Default {false} - */ - collapsible?: boolean; - - /** Set the root class for Tab theme. This cssClass API helps to use custom skinning option for Tab control. - */ - cssClass?: string; - - /** Disables the given tab headers and content panels. - * @Default {[]} - */ - disabledItemIndex?: number[]; - - /** Specifies the animation behavior of the tab. - * @Default {true} - */ - enableAnimation?: boolean; - - /** When this property is set to false, it disables the tab control. - * @Default {true} - */ - enabled?: boolean; - - /** Enables the given tab headers and content panels. - * @Default {[]} - */ - enabledItemIndex?: number[]; - - /** Save current model value to browser cookies for state maintains. While refresh the Tab control page the model value apply from browser cookies. - * @Default {false} - */ - enablePersistence?: boolean; - - /** Display Right to Left direction for headers and panels text of tab. - * @Default {false} - */ - enableRTL?: boolean; - - /** Specify to enable scrolling for Tab header. - * @Default {false} - */ - enableTabScroll?: boolean; - - /** The event API to bind the action for active the tab items. - * @Default {click} - */ - events?: string; - - /** Specifies the position of Tab header as top, bottom, left or right. See below to get available Position - * @Default {top} - */ - headerPosition?: string | ej.Tab.Position; - - /** Set the height of the tab header element. Default this property value is null, so height take content height. - * @Default {null} - */ - headerSize?: string|number; - - /** Height set the outer panel element. Default this property value is null, so height take content height. - * @Default {null} - */ - height?: string|number; - - /** Adjust the content panel height for given option (content, auto and fill), by default panels height adjust based on the content.See below to get available HeightAdjustMode - * @Default {content} - */ - heightAdjustMode?: string | ej.Tab.HeightAdjustMode; - - /** Specifies to hide a pane of Tab control. - * @Default {[]} - */ - hiddenItemIndex?: any[]; - - /** Specifies the HTML Attributes of the Tab. - * @Default {{}} - */ - htmlAttributes?: any; - - /** The idPrefix property appends the given string on the added tab item idĂ¢â‚¬â„¢s in runtime. - * @Default {ej-tab-} - */ - idPrefix?: string; - - /** Specifies the Tab header in active for given index value. - * @Default {0} - */ - selectedItemIndex?: number; - - /** Display the close button for each tab items. While clicking on the close icon, particular tab item will be removed. - * @Default {false} - */ - showCloseButton?: boolean; - - /** Display the Reload button for each tab items. - * @Default {false} - */ - showReloadIcon?: boolean; - - /** Tab panels and headers to be displayed in rounded corner style. - * @Default {false} - */ - showRoundedCorner?: boolean; - - /** Set the width for outer panel element, if not itĂ¢â‚¬â„¢s take parent width. - * @Default {null} - */ - width?: string|number; - - /** Triggered after a tab item activated. */ - itemActive?(e: ItemActiveEventArgs): void; - - /** Triggered before AJAX content has been loaded. */ - ajaxBeforeLoad?(e: AjaxBeforeLoadEventArgs): void; - - /** Triggered if error occurs in AJAX request. */ - ajaxError?(e: AjaxErrorEventArgs): void; - - /** Triggered after AJAX content load action. */ - ajaxLoad?(e: AjaxLoadEventArgs): void; - - /** Triggered after a tab item activated. */ - ajaxSuccess?(e: AjaxSuccessEventArgs): void; + /** returns the name of the event + */ + type?: string; + + /** returns the clicked menu item element + */ + element?: any; + + /** return the menu item id + */ + ID?: string; + + /** return the clicked menu item text + */ + Text?: string; + } + + export interface ItemMouseOverEventArgs { + + /** returns the cancel option value + */ + cancel?: boolean; + + /** returns the split button model + */ + model?: ej.SplitButton.Model; + + /** returns the name of the event + */ + type?: string; + + /** returns the clicked menu item element + */ + element?: any; + + /** return the menu item id + */ + ID?: string; + + /** return the clicked menu item text + */ + Text?: string; + } + + export interface ItemSelectedEventArgs { + + /** returns the cancel option value + */ + cancel?: boolean; + + /** returns the split button model + */ + model?: ej.SplitButton.Model; + + /** returns the name of the event + */ + type?: string; + + /** returns the clicked menu item element + */ + element?: any; + + /** returns the selected item + */ + selectedItem?: any; + + /** return the menu id + */ + menuId?: string; + + /** return the clicked menu item text + */ + menuText?: string; + } + + export interface OpenEventArgs { + + /** returns the cancel option value + */ + cancel?: boolean; + + /** returns the split button model + */ + model?: ej.SplitButton.Model; + + /** returns the name of the event + */ + type?: string; + } + } + enum ArrowPosition { + //To set Left arrowPosition of the split button + Left, + //To set Right arrowPosition of the split button + Right, + //To set Top arrowPosition of the split button + Top, + //To set Bottom arrowPosition of the split button + Bottom, + } + + class Splitter extends ej.Widget { + static fn: Splitter; + constructor(element: JQuery | Element, options?: Splitter.Model); + static Locale: any; + model: Splitter.Model; + defaults: Splitter.Model; + + /** To add a new pane to splitter control. + * @param {string} content of pane. + * @param {any} pane properties. + * @param {number} index of pane. + * @returns {HTMLElement} + */ + addItem(content: string, property: any, index: number): HTMLElement; + + /** To collapse the splitter control pane. + * @param {number} index number of pane. + * @returns {void} + */ + collapse(paneIndex: number): void; + + /** To expand the splitter control pane. + * @param {number} index number of pane. + * @returns {void} + */ + expand(paneIndex: number): void; + + /** To refresh the splitter control pane resizing. + * @returns {void} + */ + refresh(): void; + + /** To remove a specified pane from the splitter control. + * @param {number} index of pane. + * @returns {void} + */ + removeItem(index: number): void; + } + export namespace Splitter { + + export interface Model { + + /** Turns on keyboard interaction with the Splitter panes. You must set this property to true to access the keyboard shortcuts of ejSplitter. + * @Default {true} + */ + allowKeyboardNavigation?: boolean; + + /** Specify animation speed for the Splitter pane movement, while collapsing and expanding. + * @Default {300} + */ + animationSpeed?: number; + + /** Specify the CSS class to splitter control to achieve custom theme. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + cssClass?: string; + + /** Specifies the animation behavior of the splitter. + * @Default {true} + */ + enableAnimation?: boolean; + + /** Specifies the splitter control to be displayed in right to left direction. + * @Default {false} + */ + enableRTL?: boolean; + + /** Specify height for splitter control. + * @Default {null} + */ + height?: string; + + /** Specifies the HTML Attributes of the Splitter. + * @Default {{}} + */ + htmlAttributes?: any; + + /** Specify window resizing behavior for splitter control. + * @Default {false} + */ + isResponsive?: boolean; + + /** Specify the orientation for splitter control. See orientation + * @Default {ej.orientation.Horizontal or Ă¢â‚¬Å“horizontalĂ¢â‚¬Â} + */ + orientation?: ej.Orientation | string; + + /** Specify properties for each pane like paneSize, minSize, maxSize, collapsible, expandable, resizable. + * @Default {[]} + */ + properties?: any[]; + + /** Specify width for splitter control. + * @Default {null} + */ + width?: string; + + /** Fires before expanding / collapsing the split pane of splitter control. */ + beforeExpandCollapse?(e: BeforeExpandCollapseEventArgs): void; + + /** Fires when splitter control pane has been created. */ + create?(e: CreateEventArgs): void; + + /** Fires when splitter control pane has been destroyed. */ + destroy?(e: DestroyEventArgs): void; + + /** Fires when expand / collapse operation in splitter control pane has been performed successfully. */ + expandCollapse?(e: ExpandCollapseEventArgs): void; + + /** Fires when resize in splitter control pane. */ + resize?(e: ResizeEventArgs): void; + } + + export interface BeforeExpandCollapseEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns collapsed pane details. + */ + collapsed?: any; + + /** returns expanded pane details. + */ + expanded?: any; + + /** returns the splitter model. + */ + model?: ej.Splitter.Model; + + /** returns the current split bar index. + */ + splitbarIndex?: number; + + /** returns the name of the event. + */ + type?: string; + } + + export interface CreateEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the splitter model. + */ + model?: ej.Splitter.Model; + + /** returns the name of the event. + */ + type?: string; + } + + export interface DestroyEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the splitter model. + */ + model?: ej.Splitter.Model; + + /** returns the name of the event. + */ + type?: string; + } + + export interface ExpandCollapseEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns collapsed pane details. + */ + collapsed?: any; + + /** returns expanded pane details. + */ + expanded?: any; + + /** returns the splitter model. + */ + model?: ej.Splitter.Model; + + /** returns the current split bar index. + */ + splitbarIndex?: number; + + /** returns the name of the event. + */ + type?: string; + } + + export interface ResizeEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns previous pane details. + */ + prevPane?: any; + + /** returns next pane details. + */ + nextPane?: any; + + /** returns the splitter model. + */ + model?: ej.Splitter.Model; + + /** returns the current split bar index. + */ + splitbarIndex?: number; + + /** returns the name of the event. + */ + type?: string; + } + } + + class Tab extends ej.Widget { + static fn: Tab; + constructor(element: JQuery | Element, options?: Tab.Model); + static Locale: any; + model: Tab.Model; + defaults: Tab.Model; + + /** Add new tab items with given name, URL and given index position, if index null itĂ¢â‚¬â„¢s add last item. + * @param {string} URL name / tab id. + * @param {string} Tab Display name. + * @param {number} Index position to placed , this is optional. + * @param {string} specifies cssClass, this is optional. + * @param {string} specifies id of tab, this is optional. + * @returns {void} + */ + addItem(URL: string, displayLabel: string, index: number, cssClass: string, id: string): void; + + /** To disable the tab control. + * @returns {void} + */ + disable(): void; + + /** To enable the tab control. + * @returns {void} + */ + enable(): void; + + /** This function get the number of tab rendered + * @returns {number} + */ + getItemsCount(): number; + + /** This function hides the tab control. + * @returns {void} + */ + hide(): void; + + /** This function hides the specified item tab in tab control. + * @param {number} index of tab item. + * @returns {void} + */ + hideItem(index: number): void; + + /** Remove the given index tab item. + * @param {number} index of tab item. + * @returns {void} + */ + removeItem(index: number): void; + + /** This function is to show the tab control. + * @returns {void} + */ + show(): void; + + /** This function helps to show the specified hidden tab item in tab control. + * @param {number} index of tab item. + * @returns {void} + */ + showItem(index: number): void; + } + export namespace Tab { + + export interface Model { + + /** Specifies the ajaxSettings option to load the content to the Tab control. + */ + ajaxSettings?: AjaxSettings; + + /** Tab items interaction with keyboard keys, like headers active navigation. + * @Default {true} + */ + allowKeyboardNavigation?: boolean; + + /** Allow to collapsing the active item, while click on the active header. + * @Default {false} + */ + collapsible?: boolean; + + /** Set the root class for Tab theme. This cssClass API helps to use custom skinning option for Tab control. + */ + cssClass?: string; + + /** Disables the given tab headers and content panels. + * @Default {[]} + */ + disabledItemIndex?: number[]; + + /** Specifies the animation behavior of the tab. + * @Default {true} + */ + enableAnimation?: boolean; + + /** When this property is set to false, it disables the tab control. + * @Default {true} + */ + enabled?: boolean; + + /** Enables the given tab headers and content panels. + * @Default {[]} + */ + enabledItemIndex?: number[]; + + /** Save current model value to browser cookies for state maintains. While refresh the Tab control page the model value apply from browser cookies. + * @Default {false} + */ + enablePersistence?: boolean; + + /** Display Right to Left direction for headers and panels text of tab. + * @Default {false} + */ + enableRTL?: boolean; + + /** Specify to enable scrolling for Tab header. + * @Default {false} + */ + enableTabScroll?: boolean; + + /** The event API to bind the action for active the tab items. + * @Default {click} + */ + events?: string; + + /** Specifies the position of Tab header as top, bottom, left or right. See below to get available Position + * @Default {top} + */ + headerPosition?: string | ej.Tab.Position; + + /** Set the height of the tab header element. Default this property value is null, so height take content height. + * @Default {null} + */ + headerSize?: string | number; + + /** Height set the outer panel element. Default this property value is null, so height take content height. + * @Default {null} + */ + height?: string | number; + + /** Adjust the content panel height for given option (content, auto and fill), by default panels height adjust based on the content.See below to get available HeightAdjustMode + * @Default {content} + */ + heightAdjustMode?: string | ej.Tab.HeightAdjustMode; + + /** Specifies to hide a pane of Tab control. + * @Default {[]} + */ + hiddenItemIndex?: any[]; + + /** Specifies the HTML Attributes of the Tab. + * @Default {{}} + */ + htmlAttributes?: any; + + /** The idPrefix property appends the given string on the added tab item idĂ¢â‚¬â„¢s in runtime. + * @Default {ej-tab-} + */ + idPrefix?: string; + + /** Specifies the Tab header in active for given index value. + * @Default {0} + */ + selectedItemIndex?: number; + + /** Display the close button for each tab items. While clicking on the close icon, particular tab item will be removed. + * @Default {false} + */ + showCloseButton?: boolean; + + /** Display the Reload button for each tab items. + * @Default {false} + */ + showReloadIcon?: boolean; + + /** Tab panels and headers to be displayed in rounded corner style. + * @Default {false} + */ + showRoundedCorner?: boolean; + + /** Set the width for outer panel element, if not itĂ¢â‚¬â„¢s take parent width. + * @Default {null} + */ + width?: string | number; + + /** Triggered after a tab item activated. */ + itemActive?(e: ItemActiveEventArgs): void; + + /** Triggered before AJAX content has been loaded. */ + ajaxBeforeLoad?(e: AjaxBeforeLoadEventArgs): void; + + /** Triggered if error occurs in AJAX request. */ + ajaxError?(e: AjaxErrorEventArgs): void; + + /** Triggered after AJAX content load action. */ + ajaxLoad?(e: AjaxLoadEventArgs): void; + + /** Triggered after a tab item activated. */ + ajaxSuccess?(e: AjaxSuccessEventArgs): void; - /** Triggered before a tab item activated. */ - beforeActive?(e: BeforeActiveEventArgs): void; + /** Triggered before a tab item activated. */ + beforeActive?(e: BeforeActiveEventArgs): void; - /** Triggered before a tab item remove. */ - beforeItemRemove?(e: BeforeItemRemoveEventArgs): void; - - /** Triggered before a tab item Create. */ - create?(e: CreateEventArgs): void; + /** Triggered before a tab item remove. */ + beforeItemRemove?(e: BeforeItemRemoveEventArgs): void; + + /** Triggered before a tab item Create. */ + create?(e: CreateEventArgs): void; - /** Triggered before a tab item destroy. */ - destroy?(e: DestroyEventArgs): void; + /** Triggered before a tab item destroy. */ + destroy?(e: DestroyEventArgs): void; - /** Triggered after new tab item add */ - itemAdd?(e: ItemAddEventArgs): void; + /** Triggered after new tab item add */ + itemAdd?(e: ItemAddEventArgs): void; - /** Triggered after tab item removed. */ - itemRemove?(e: ItemRemoveEventArgs): void; -} + /** Triggered after tab item removed. */ + itemRemove?(e: ItemRemoveEventArgs): void; + } -export interface ItemActiveEventArgs { + export interface ItemActiveEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the tab model. - */ - model?: ej.Tab.Model; + /** returns the tab model. + */ + model?: ej.Tab.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns previous active tab header. - */ - prevActiveHeader?: HTMLElement; + /** returns previous active tab header. + */ + prevActiveHeader?: HTMLElement; - /** returns previous active index. - */ - prevActiveIndex?: number; + /** returns previous active index. + */ + prevActiveIndex?: number; - /** returns current active tab header . - */ - activeHeader?: HTMLElement; + /** returns current active tab header . + */ + activeHeader?: HTMLElement; - /** returns current active index. - */ - activeIndex?: number; + /** returns current active index. + */ + activeIndex?: number; - /** returns, is it triggered by interaction or not. - */ - isInteraction?: boolean; -} + /** returns, is it triggered by interaction or not. + */ + isInteraction?: boolean; + } -export interface AjaxBeforeLoadEventArgs { + export interface AjaxBeforeLoadEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the tab model. - */ - model?: ej.Tab.Model; + /** returns the tab model. + */ + model?: ej.Tab.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns previous active tab header. - */ - prevActiveHeader?: HTMLElement; + /** returns previous active tab header. + */ + prevActiveHeader?: HTMLElement; - /** returns previous active index. - */ - prevActiveIndex?: number; + /** returns previous active index. + */ + prevActiveIndex?: number; - /** returns current active tab header . - */ - activeHeader?: HTMLElement; + /** returns current active tab header . + */ + activeHeader?: HTMLElement; - /** returns current active index. - */ - activeIndex?: number; + /** returns current active index. + */ + activeIndex?: number; - /** returns the URL of AJAX request - */ - URL?: string; + /** returns the URL of AJAX request + */ + URL?: string; - /** returns, is it triggered by interaction or not. - */ - isInteraction?: boolean; -} + /** returns, is it triggered by interaction or not. + */ + isInteraction?: boolean; + } -export interface AjaxErrorEventArgs { + export interface AjaxErrorEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the tab model. - */ - model?: ej.Tab.Model; + /** returns the tab model. + */ + model?: ej.Tab.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns AJAX data details. - */ - data?: any; + /** returns AJAX data details. + */ + data?: any; - /** returns the URL of AJAX request. - */ - URL?: string; -} + /** returns the URL of AJAX request. + */ + URL?: string; + } -export interface AjaxLoadEventArgs { + export interface AjaxLoadEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the tab model. - */ - model?: ej.Tab.Model; + /** returns the tab model. + */ + model?: ej.Tab.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns previous active tab header. - */ - prevActiveHeader?: HTMLElement; + /** returns previous active tab header. + */ + prevActiveHeader?: HTMLElement; - /** returns previous active index. - */ - prevActiveIndex?: number; + /** returns previous active index. + */ + prevActiveIndex?: number; - /** returns current active tab header . - */ - activeHeader?: HTMLElement; + /** returns current active tab header . + */ + activeHeader?: HTMLElement; - /** returns current active index. - */ - activeIndex?: number; + /** returns current active index. + */ + activeIndex?: number; - /** returns the URL of AJAX request - */ - URL?: string; + /** returns the URL of AJAX request + */ + URL?: string; - /** returns, is it triggered by interaction or not. - */ - isInteraction?: boolean; -} + /** returns, is it triggered by interaction or not. + */ + isInteraction?: boolean; + } -export interface AjaxSuccessEventArgs { + export interface AjaxSuccessEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the tab model. - */ - model?: ej.Tab.Model; + /** returns the tab model. + */ + model?: ej.Tab.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** return AJAX data. - */ - data?: any; + /** return AJAX data. + */ + data?: any; - /** returns AJAX URL - */ - URL?: string; + /** returns AJAX URL + */ + URL?: string; - /** returns content of AJAX request. - */ - content?: any; -} + /** returns content of AJAX request. + */ + content?: any; + } -export interface BeforeActiveEventArgs { + export interface BeforeActiveEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the tab model. - */ - model?: ej.Tab.Model; + /** returns the tab model. + */ + model?: ej.Tab.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns previous active tab header. - */ - prevActiveHeader?: HTMLElement; + /** returns previous active tab header. + */ + prevActiveHeader?: HTMLElement; - /** returns previous active index. - */ - prevActiveIndex?: number; + /** returns previous active index. + */ + prevActiveIndex?: number; - /** returns current active tab header . - */ - activeHeader?: HTMLElement; + /** returns current active tab header . + */ + activeHeader?: HTMLElement; - /** returns current active index. - */ - activeIndex?: number; + /** returns current active index. + */ + activeIndex?: number; - /** returns, is it triggered by interaction or not. - */ - isInteraction?: boolean; -} + /** returns, is it triggered by interaction or not. + */ + isInteraction?: boolean; + } -export interface BeforeItemRemoveEventArgs { + export interface BeforeItemRemoveEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the tab model. - */ - model?: ej.Tab.Model; + /** returns the tab model. + */ + model?: ej.Tab.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns current tab item index - */ - index?: number; -} + /** returns current tab item index + */ + index?: number; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the tab model. - */ - model?: ej.Tab.Model; + /** returns the tab model. + */ + model?: ej.Tab.Model; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the tab model. - */ - model?: ej.Tab.Model; + /** returns the tab model. + */ + model?: ej.Tab.Model; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface ItemAddEventArgs { + export interface ItemAddEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the tab model. - */ - model?: ej.Tab.Model; + /** returns the tab model. + */ + model?: ej.Tab.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns new added tab header. - */ - tabHeader?: HTMLElement; + /** returns new added tab header. + */ + tabHeader?: HTMLElement; - /** returns new added tab content panel. - */ - tabContent?: any; -} + /** returns new added tab content panel. + */ + tabContent?: any; + } -export interface ItemRemoveEventArgs { + export interface ItemRemoveEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the tab model. - */ - model?: ej.Tab.Model; + /** returns the tab model. + */ + model?: ej.Tab.Model; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns removed tab header. - */ - removedTab?: HTMLElement; -} + /** returns removed tab header. + */ + removedTab?: HTMLElement; + } -export interface AjaxSettings { + export interface AjaxSettings { - /** It specifies, whether to enable or disable asynchronous request. - * @Default {true} - */ - async?: boolean; + /** It specifies, whether to enable or disable asynchronous request. + * @Default {true} + */ + async?: boolean; - /** It specifies the page will be cached in the web browser. - * @Default {false} - */ - cache?: boolean; + /** It specifies the page will be cached in the web browser. + * @Default {false} + */ + cache?: boolean; - /** It specifies the type of data is send in the query string. - * @Default {html} - */ - contentType?: string; + /** It specifies the type of data is send in the query string. + * @Default {html} + */ + contentType?: string; - /** It specifies the data as an object, will be passed in the query string. - * @Default {{}} - */ - data?: any; + /** It specifies the data as an object, will be passed in the query string. + * @Default {{}} + */ + data?: any; - /** It specifies the type of data that you're expecting back from the response. - * @Default {html} - */ - dataType?: string; + /** It specifies the type of data that you're expecting back from the response. + * @Default {html} + */ + dataType?: string; - /** It specifies the HTTP request type. - * @Default {get} - */ - type?: string; -} - -enum Position { - - ///Tab headers display to top position - Top, - - ///Tab headers display to bottom position - Bottom, - - ///Tab headers display to left position. - Left, - - ///Tab headers display to right position. - Right -} - - -enum HeightAdjustMode { - - ///string - None, - - ///string - Content, - - ///string - Auto, - - ///string - Fill -} - -} - -class TagCloud extends ej.Widget { - static fn: TagCloud; - constructor(element: JQuery | Element, options?: TagCloud.Model); - static Locale: any; - model: TagCloud.Model; - defaults: TagCloud.Model; - - /** Inserts a new item into the TagCloud - * @param {string} Insert new item into the TagCloud - * @returns {void} - */ - insert(name: string): void; - - /** Inserts a new item into the TagCloud at a particular position. - * @param {string} Inserts a new item into the TagCloud - * @param {number} Inserts a new item into the TagCloud with the specified position - * @returns {void} - */ - insertAt(name: string, position: number): void; - - /** Removes the item from the TagCloud based on the name. It removes all the tags which have the corresponding name - * @param {string} name of the tag. - * @returns {void} - */ - remove(name: string): void; - - /** Removes the item from the TagCloud based on the position. It removes the tags from the the corresponding position only. - * @param {number} position of tag item. - * @returns {void} - */ - removeAt(position: number): void; -} -export namespace TagCloud { - -export interface Model { - - /** Specify the CSS class to button to achieve custom theme. - */ - cssClass?: string; - - /** The dataSource contains the list of data to display in a cloud format. Each data contains a link URL, frequency to categorize the font size and a display text. - * @Default {null} - */ - dataSource?: any; - - /** Sets the TagCloud and tag items direction as right to left alignment. - * @Default {false} - */ - enableRTL?: boolean; - - /** Defines the mapping fields for the data items of the TagCloud. - * @Default {null} - */ - fields?: Fields; + /** It specifies the HTTP request type. + * @Default {get} + */ + type?: string; + } + + enum Position { + + ///Tab headers display to top position + Top, + + ///Tab headers display to bottom position + Bottom, + + ///Tab headers display to left position. + Left, + + ///Tab headers display to right position. + Right + } + + + enum HeightAdjustMode { + + ///string + None, + + ///string + Content, + + ///string + Auto, + + ///string + Fill + } + + } + + class TagCloud extends ej.Widget { + static fn: TagCloud; + constructor(element: JQuery | Element, options?: TagCloud.Model); + static Locale: any; + model: TagCloud.Model; + defaults: TagCloud.Model; + + /** Inserts a new item into the TagCloud + * @param {string} Insert new item into the TagCloud + * @returns {void} + */ + insert(name: string): void; + + /** Inserts a new item into the TagCloud at a particular position. + * @param {string} Inserts a new item into the TagCloud + * @param {number} Inserts a new item into the TagCloud with the specified position + * @returns {void} + */ + insertAt(name: string, position: number): void; + + /** Removes the item from the TagCloud based on the name. It removes all the tags which have the corresponding name + * @param {string} name of the tag. + * @returns {void} + */ + remove(name: string): void; + + /** Removes the item from the TagCloud based on the position. It removes the tags from the the corresponding position only. + * @param {number} position of tag item. + * @returns {void} + */ + removeAt(position: number): void; + } + export namespace TagCloud { + + export interface Model { + + /** Specify the CSS class to button to achieve custom theme. + */ + cssClass?: string; + + /** The dataSource contains the list of data to display in a cloud format. Each data contains a link URL, frequency to categorize the font size and a display text. + * @Default {null} + */ + dataSource?: any; + + /** Sets the TagCloud and tag items direction as right to left alignment. + * @Default {false} + */ + enableRTL?: boolean; + + /** Defines the mapping fields for the data items of the TagCloud. + * @Default {null} + */ + fields?: Fields; - /** Specifies the list of HTML attributes to be added to TagCloud control. - * @Default {{}} - */ - htmlAttributes?: any; + /** Specifies the list of HTML attributes to be added to TagCloud control. + * @Default {{}} + */ + htmlAttributes?: any; - /** Defines the format for the TagCloud to display the tag items.See Format - * @Default {ej.Format.Cloud} - */ - format?: string|ej.Format; + /** Defines the format for the TagCloud to display the tag items.See Format + * @Default {ej.Format.Cloud} + */ + format?: string | ej.Format; - /** Sets the maximum font size value for the tag items. The font size for the tag items will be generated in between the minimum and maximum font size values. - * @Default {40px} - */ - maxFontSize?: string|number; + /** Sets the maximum font size value for the tag items. The font size for the tag items will be generated in between the minimum and maximum font size values. + * @Default {40px} + */ + maxFontSize?: string | number; - /** Sets the minimum font size value for the tag items. The font size for the tag items will be generated in between the minimum and maximum font size values. - * @Default {10px} - */ - minFontSize?: string|number; + /** Sets the minimum font size value for the tag items. The font size for the tag items will be generated in between the minimum and maximum font size values. + * @Default {10px} + */ + minFontSize?: string | number; - /** Define the query to retrieve the data from online server. The query is used only when the online dataSource is used. - * @Default {null} - */ - query?: any; - - /** Shows or hides the TagCloud title. When this set to false, it hides the TagCloud header. - * @Default {true} - */ - showTitle?: boolean; - - /** Sets the title image for the TagCloud. To show the title image, the showTitle property should be enabled. - * @Default {null} - */ - titleImage?: string; - - /** Sets the title text for the TagCloud. To show the title text, the showTitle property should be enabled. - * @Default {Title} - */ - titleText?: string; - - /** Event triggers when the TagCloud items are clicked */ - click?(e: ClickEventArgs): void; - - /** Event triggers when the TagCloud are created */ - create?(e: CreateEventArgs): void; - - /** Event triggers when the TagCloud are destroyed */ - destroy?(e: DestroyEventArgs): void; - - /** Event triggers when the cursor leaves out from a tag item */ - mouseout?(e: MouseoutEventArgs): void; - - /** Event triggers when the cursor hovers on a tag item */ - mouseover?(e: MouseoverEventArgs): void; -} - -export interface ClickEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the TagCloud model - */ - model?: ej.TagCloud.Model; - - /** returns the name of the event - */ - type?: string; + /** Define the query to retrieve the data from online server. The query is used only when the online dataSource is used. + * @Default {null} + */ + query?: any; + + /** Shows or hides the TagCloud title. When this set to false, it hides the TagCloud header. + * @Default {true} + */ + showTitle?: boolean; + + /** Sets the title image for the TagCloud. To show the title image, the showTitle property should be enabled. + * @Default {null} + */ + titleImage?: string; + + /** Sets the title text for the TagCloud. To show the title text, the showTitle property should be enabled. + * @Default {Title} + */ + titleText?: string; + + /** Event triggers when the TagCloud items are clicked */ + click?(e: ClickEventArgs): void; + + /** Event triggers when the TagCloud are created */ + create?(e: CreateEventArgs): void; + + /** Event triggers when the TagCloud are destroyed */ + destroy?(e: DestroyEventArgs): void; + + /** Event triggers when the cursor leaves out from a tag item */ + mouseout?(e: MouseoutEventArgs): void; + + /** Event triggers when the cursor hovers on a tag item */ + mouseover?(e: MouseoverEventArgs): void; + } + + export interface ClickEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the TagCloud model + */ + model?: ej.TagCloud.Model; + + /** returns the name of the event + */ + type?: string; - /** return current tag name - */ - text?: string; - - /** return current URL link - */ - URL?: string; -} - -export interface CreateEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the TagCloud model - */ - model?: ej.TagCloud.Model; - - /** returns the name of the event - */ - type?: string; -} - -export interface DestroyEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the TagCloud model - */ - model?: ej.TagCloud.Model; - - /** returns the name of the event - */ - type?: string; -} - -export interface MouseoutEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the TagCloud model - */ - model?: ej.TagCloud.Model; - - /** returns the name of the event - */ - type?: string; - - /** return current tag name - */ - text?: string; - - /** return current URL link - */ - URL?: string; -} - -export interface MouseoverEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the TagCloud model - */ - model?: ej.TagCloud.Model; - - /** returns the name of the event - */ - type?: string; - - /** return current tag name - */ - text?: string; - - /** return current URL link - */ - URL?: string; -} - -export interface Fields { - - /** Defines the frequency column number to categorize the font size. - */ - frequency?: string; - - /** Defines the HTML attributes column for the anchor elements inside the each tag items. - */ - htmlAttributes?: string; - - /** Defines the tag value or display text. - */ - text?: string; - - /** Defines the URL link to navigate while click the tag. - */ - url?: string; -} -} -enum Format { -//To render the TagCloud items in cloud format -Cloud, -//To render the TagCloud items in list format -List, -} - -class TimePicker extends ej.Widget { - static fn: TimePicker; - constructor(element: JQuery | Element, options?: TimePicker.Model); - static Locale: any; - model: TimePicker.Model; - defaults: TimePicker.Model; - - /** Allows you to disable the TimePicker. - * @returns {void} - */ - disable(): void; - - /** Allows you to enable the TimePicker. - * @returns {void} - */ - enable(): void; - - /** It returns the current time value. - * @returns {string} - */ - getValue(): string; - - /** This method will hide the TimePicker control popup. - * @returns {void} - */ - hide(): void; - - /** Updates the current system time in TimePicker. - * @returns {void} - */ - setCurrentTime(): void; - - /** This method will show the TimePicker control popup. - * @returns {void} - */ - show(): void; -} -export namespace TimePicker { - -export interface Model { - - /** Sets the root CSS class for the TimePicker theme, which is used to customize. - */ - cssClass?: string; - - /** Specifies the list of time range to be disabled. - * @Default {{}} - */ - disableTimeRanges?: any; - - /** Specifies the animation behavior in TimePicker. - * @Default {true} - */ - enableAnimation?: boolean; - - /** When this property is set to false, it disables the TimePicker control. - * @Default {true} - */ - enabled?: boolean; - - /** Save current model value to browser cookies for maintaining states. When refreshing the TimePicker control page, the model value is applied from browser cookies or HTML 5local storage. - * @Default {false} - */ - enablePersistence?: boolean; - - /** Displays the TimePicker as right to left alignment. - * @Default {false} - */ - enableRTL?: boolean; - - /** When the enableStrictMode is set as true it allows the value outside of the range and also indicate with red color border, - * otherwise it internally changed to the min or max range value based an input value. - * @Default {false} - */ - enableStrictMode?: boolean; - - /** Defines the height of the TimePicker textbox. - */ - height?: string|number; - - /** Sets the step value for increment an hour value through arrow keys or mouse scroll. - * @Default {1} - */ - hourInterval?: number; - - /** It allows to define the characteristics of the TimePicker control. It will helps to extend the capability of an HTML element. - * @Default {{}} - */ - htmlAttributes?: any; - - /** Sets the time interval between the two adjacent time values in the popup. - * @Default {30} - */ - interval?: number; - - /** Defines the localization info used by the TimePicker. - * @Default {en-US} - */ - locale?: string; - - /** Sets the maximum time value to the TimePicker. - * @Default {11:59:59 PM} - */ - maxTime?: string; - - /** Sets the minimum time value to the TimePicker. - * @Default {12:00:00 AM} - */ - minTime?: string; - - /** Sets the step value for increment the minute value through arrow keys or mouse scroll. - * @Default {1} - */ - minutesInterval?: number; - - /** Defines the height of the TimePicker popup. - * @Default {191px} - */ - popupHeight?: string|number; - - /** Defines the width of the TimePicker popup. - * @Default {auto} - */ - popupWidth?: string|number; - - /** Toggles the readonly state of the TimePicker - * @Default {false} - */ - readOnly?: boolean; - - /** Sets the step value for increment the seconds value through arrow keys or mouse scroll. - * @Default {1} - */ - secondsInterval?: number; - - /** shows or hides the drop down button in TimePicker. - * @Default {true} - */ - showPopupButton?: boolean; - - /** TimePicker is displayed with rounded corner when this property is set to true. - * @Default {false} - */ - showRoundedCorner?: boolean; - - /** Defines the time format displayed in the TimePicker. - * @Default {h:mm tt} - */ - timeFormat?: string; - - /** Sets a specified time value on the TimePicker. - * @Default {null} - */ - value?: string|Date; - - /** Defines the width of the TimePicker textbox. - */ - width?: string|number; - - /** Fires when the time value changed in the TimePicker. */ - beforeChange?(e: BeforeChangeEventArgs): void; - - /** Fires when the TimePicker popup before opened. */ - beforeOpen?(e: BeforeOpenEventArgs): void; + /** return current tag name + */ + text?: string; + + /** return current URL link + */ + URL?: string; + } + + export interface CreateEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the TagCloud model + */ + model?: ej.TagCloud.Model; + + /** returns the name of the event + */ + type?: string; + } + + export interface DestroyEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the TagCloud model + */ + model?: ej.TagCloud.Model; + + /** returns the name of the event + */ + type?: string; + } + + export interface MouseoutEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the TagCloud model + */ + model?: ej.TagCloud.Model; + + /** returns the name of the event + */ + type?: string; + + /** return current tag name + */ + text?: string; + + /** return current URL link + */ + URL?: string; + } + + export interface MouseoverEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the TagCloud model + */ + model?: ej.TagCloud.Model; + + /** returns the name of the event + */ + type?: string; + + /** return current tag name + */ + text?: string; + + /** return current URL link + */ + URL?: string; + } + + export interface Fields { + + /** Defines the frequency column number to categorize the font size. + */ + frequency?: string; + + /** Defines the HTML attributes column for the anchor elements inside the each tag items. + */ + htmlAttributes?: string; + + /** Defines the tag value or display text. + */ + text?: string; + + /** Defines the URL link to navigate while click the tag. + */ + url?: string; + } + } + enum Format { + //To render the TagCloud items in cloud format + Cloud, + //To render the TagCloud items in list format + List, + } + + class TimePicker extends ej.Widget { + static fn: TimePicker; + constructor(element: JQuery | Element, options?: TimePicker.Model); + static Locale: any; + model: TimePicker.Model; + defaults: TimePicker.Model; + + /** Allows you to disable the TimePicker. + * @returns {void} + */ + disable(): void; + + /** Allows you to enable the TimePicker. + * @returns {void} + */ + enable(): void; + + /** It returns the current time value. + * @returns {string} + */ + getValue(): string; + + /** This method will hide the TimePicker control popup. + * @returns {void} + */ + hide(): void; + + /** Updates the current system time in TimePicker. + * @returns {void} + */ + setCurrentTime(): void; + + /** This method will show the TimePicker control popup. + * @returns {void} + */ + show(): void; + } + export namespace TimePicker { + + export interface Model { + + /** Sets the root CSS class for the TimePicker theme, which is used to customize. + */ + cssClass?: string; + + /** Specifies the list of time range to be disabled. + * @Default {{}} + */ + disableTimeRanges?: any; + + /** Specifies the animation behavior in TimePicker. + * @Default {true} + */ + enableAnimation?: boolean; + + /** When this property is set to false, it disables the TimePicker control. + * @Default {true} + */ + enabled?: boolean; + + /** Save current model value to browser cookies for maintaining states. When refreshing the TimePicker control page, the model value is applied from browser cookies or HTML 5local storage. + * @Default {false} + */ + enablePersistence?: boolean; + + /** Displays the TimePicker as right to left alignment. + * @Default {false} + */ + enableRTL?: boolean; + + /** When the enableStrictMode is set as true it allows the value outside of the range and also indicate with red color border, + * otherwise it internally changed to the min or max range value based an input value. + * @Default {false} + */ + enableStrictMode?: boolean; + + /** Defines the height of the TimePicker textbox. + */ + height?: string | number; + + /** Sets the step value for increment an hour value through arrow keys or mouse scroll. + * @Default {1} + */ + hourInterval?: number; + + /** It allows to define the characteristics of the TimePicker control. It will helps to extend the capability of an HTML element. + * @Default {{}} + */ + htmlAttributes?: any; + + /** Sets the time interval between the two adjacent time values in the popup. + * @Default {30} + */ + interval?: number; + + /** Defines the localization info used by the TimePicker. + * @Default {en-US} + */ + locale?: string; + + /** Sets the maximum time value to the TimePicker. + * @Default {11:59:59 PM} + */ + maxTime?: string; + + /** Sets the minimum time value to the TimePicker. + * @Default {12:00:00 AM} + */ + minTime?: string; + + /** Sets the step value for increment the minute value through arrow keys or mouse scroll. + * @Default {1} + */ + minutesInterval?: number; + + /** Defines the height of the TimePicker popup. + * @Default {191px} + */ + popupHeight?: string | number; + + /** Defines the width of the TimePicker popup. + * @Default {auto} + */ + popupWidth?: string | number; + + /** Toggles the readonly state of the TimePicker + * @Default {false} + */ + readOnly?: boolean; + + /** Sets the step value for increment the seconds value through arrow keys or mouse scroll. + * @Default {1} + */ + secondsInterval?: number; + + /** shows or hides the drop down button in TimePicker. + * @Default {true} + */ + showPopupButton?: boolean; + + /** TimePicker is displayed with rounded corner when this property is set to true. + * @Default {false} + */ + showRoundedCorner?: boolean; + + /** Defines the time format displayed in the TimePicker. + * @Default {h:mm tt} + */ + timeFormat?: string; + + /** Sets a specified time value on the TimePicker. + * @Default {null} + */ + value?: string | Date; + + /** Defines the width of the TimePicker textbox. + */ + width?: string | number; + + /** Fires when the time value changed in the TimePicker. */ + beforeChange?(e: BeforeChangeEventArgs): void; + + /** Fires when the TimePicker popup before opened. */ + beforeOpen?(e: BeforeOpenEventArgs): void; - /** Fires when the time value changed in the TimePicker. */ - change?(e: ChangeEventArgs): void; - - /** Fires when the TimePicker popup closed. */ - close?(e: CloseEventArgs): void; - - /** Fires when create TimePicker successfully. */ - create?(e: CreateEventArgs): void; + /** Fires when the time value changed in the TimePicker. */ + change?(e: ChangeEventArgs): void; + + /** Fires when the TimePicker popup closed. */ + close?(e: CloseEventArgs): void; + + /** Fires when create TimePicker successfully. */ + create?(e: CreateEventArgs): void; - /** Fires when the TimePicker is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; + /** Fires when the TimePicker is destroyed successfully. */ + destroy?(e: DestroyEventArgs): void; - /** Fires when the TimePicker control gets focus. */ - focusIn?(e: FocusInEventArgs): void; + /** Fires when the TimePicker control gets focus. */ + focusIn?(e: FocusInEventArgs): void; - /** Fires when the TimePicker control get lost focus. */ - focusOut?(e: FocusOutEventArgs): void; + /** Fires when the TimePicker control get lost focus. */ + focusOut?(e: FocusOutEventArgs): void; - /** Fires when the TimePicker popup opened. */ - open?(e: OpenEventArgs): void; + /** Fires when the TimePicker popup opened. */ + open?(e: OpenEventArgs): void; - /** Fires when the value is selected from the TimePicker dropdown list. */ - select?(e: SelectEventArgs): void; -} + /** Fires when the value is selected from the TimePicker dropdown list. */ + select?(e: SelectEventArgs): void; + } -export interface BeforeChangeEventArgs { + export interface BeforeChangeEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TimePicker model - */ - model?: ej.TimePicker.Model; + /** returns the TimePicker model + */ + model?: ej.TimePicker.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the previously selected time value - */ - prevTime?: string; + /** returns the previously selected time value + */ + prevTime?: string; - /** returns the modified time value - */ - value?: string; -} + /** returns the modified time value + */ + value?: string; + } -export interface BeforeOpenEventArgs { + export interface BeforeOpenEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TimePicker model - */ - model?: ej.TimePicker.Model; + /** returns the TimePicker model + */ + model?: ej.TimePicker.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the previously selected time value - */ - prevTime?: string; + /** returns the previously selected time value + */ + prevTime?: string; - /** returns the time value - */ - value?: string; -} + /** returns the time value + */ + value?: string; + } -export interface ChangeEventArgs { + export interface ChangeEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TimePicker model - */ - model?: ej.TimePicker.Model; + /** returns the TimePicker model + */ + model?: ej.TimePicker.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns true when the value changed by user interaction otherwise returns false - */ - isInteraction?: boolean; + /** returns true when the value changed by user interaction otherwise returns false + */ + isInteraction?: boolean; - /** returns the previously selected time value - */ - prevTime?: string; + /** returns the previously selected time value + */ + prevTime?: string; - /** returns the modified time value - */ - value?: string; -} + /** returns the modified time value + */ + value?: string; + } -export interface CloseEventArgs { + export interface CloseEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TimePicker model - */ - model?: ej.TimePicker.Model; + /** returns the TimePicker model + */ + model?: ej.TimePicker.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the previously selected time value - */ - prevTime?: string; + /** returns the previously selected time value + */ + prevTime?: string; - /** returns the time value - */ - value?: string; -} + /** returns the time value + */ + value?: string; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TimePicker model - */ - model?: ej.TimePicker.Model; + /** returns the TimePicker model + */ + model?: ej.TimePicker.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TimePicker model - */ - model?: ej.TimePicker.Model; + /** returns the TimePicker model + */ + model?: ej.TimePicker.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface FocusInEventArgs { + export interface FocusInEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TimePicker model - */ - model?: ej.TimePicker.Model; + /** returns the TimePicker model + */ + model?: ej.TimePicker.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the previously selected time value - */ - prevTime?: string; + /** returns the previously selected time value + */ + prevTime?: string; - /** returns the current time value - */ - value?: string; -} + /** returns the current time value + */ + value?: string; + } -export interface FocusOutEventArgs { + export interface FocusOutEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TimePicker model - */ - model?: ej.TimePicker.Model; + /** returns the TimePicker model + */ + model?: ej.TimePicker.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the previously selected time value - */ - prevTime?: string; + /** returns the previously selected time value + */ + prevTime?: string; - /** returns the current time value - */ - value?: string; -} + /** returns the current time value + */ + value?: string; + } -export interface OpenEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the TimePicker model - */ - model?: ej.TimePicker.Model; - - /** returns the name of the event - */ - type?: string; - - /** returns the time value - */ - value?: string; -} - -export interface SelectEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the TimePicker model - */ - model?: ej.TimePicker.Model; - - /** returns the name of the event - */ - type?: string; - - /** returns the previously selected time value - */ - prevTime?: string; - - /** returns the selected time value - */ - value?: string; -} -} - -class ToggleButton extends ej.Widget { - static fn: ToggleButton; - constructor(element: JQuery | Element, options?: ToggleButton.Model); - static Locale: any; - model: ToggleButton.Model; - defaults: ToggleButton.Model; - - /** Allows you to destroy the ToggleButton widget. - * @returns {void} - */ - destroy(): void; - - /** To disable the ToggleButton to prevent all user interactions. - * @returns {void} - */ - disable(): void; - - /** To enable the ToggleButton. - * @returns {void} - */ - enable(): void; -} -export namespace ToggleButton { - -export interface Model { - - /** Specify the icon in active state to the toggle button and it will be aligned from left margin of the button. - */ - activePrefixIcon?: string; - - /** Specify the icon in active state to the toggle button and it will be aligned from right margin of the button. - */ - activeSuffixIcon?: string; - - /** Sets the text when ToggleButton is in active state i.e.,checked state. - * @Default {null} - */ - activeText?: string; - - /** Specifies the contentType of the ToggleButton. See ContentType as below - * @Default {ej.ContentType.TextOnly} - */ - contentType?: ej.ContentType|string; - - /** Specify the CSS class to the ToggleButton to achieve custom theme. - */ - cssClass?: string; - - /** Specify the icon in default state to the toggle button and it will be aligned from left margin of the button. - */ - defaultPrefixIcon?: string; - - /** Specify the icon in default state to the toggle button and it will be aligned from right margin of the button. - */ - defaultSuffixIcon?: string; - - /** Specifies the text of the ToggleButton, when the control is a default state. i.e., unChecked state. - * @Default {null} - */ - defaultText?: string; - - /** Specifies the state of the ToggleButton. - * @Default {true} - */ - enabled?: boolean; - - /** Save current model value to browser cookies for maintaining states. When refreshing the ToggleButton control page, the model value is applied from browser cookies or HTML 5local storage. - * @Default {false} - */ - enablePersistence?: boolean; - - /** Specify the Right to Left direction of the ToggleButton. - * @Default {false} - */ - enableRTL?: boolean; - - /** Specifies the height of the ToggleButton. - * @Default {28pixel} - */ - height?: number|string; - - /** It allows to define the characteristics of the ToggleButton control. It will helps to extend the capability of an HTML element. - * @Default {{}} - */ - htmlAttributes?: any; - - /** Specifies the image position of the ToggleButton. - * @Default {ej.ImagePosition.ImageLeft} - */ - imagePosition?: ej.ImagePosition|string; - - /** Allows to prevents the control switched to checked (active) state. - * @Default {false} - */ - preventToggle?: boolean; - - /** Displays the ToggleButton with rounded corners. - * @Default {false} - */ - showRoundedCorner?: boolean; - - /** Specifies the size of the ToggleButton. See ButtonSize as below - * @Default {ej.ButtonSize.Normal} - */ - size?: ej.ButtonSize|string; - - /** It allows to define the ToggleButton state to checked(Active) or unchecked(Default) at initial time. - * @Default {false} - */ - toggleState?: boolean; - - /** Specifies the type of the ToggleButton. See ButtonType as below - * @Default {ej.ButtonType.Button} - */ - type?: ej.ButtonType|string; - - /** Specifies the width of the ToggleButton. - * @Default {100pixel} - */ - width?: number|string; - - /** Fires when ToggleButton control state is changed successfully. */ - change?(e: ChangeEventArgs): void; - - /** Fires when ToggleButton control is clicked successfully. */ - click?(e: ClickEventArgs): void; - - /** Fires when ToggleButton control is created successfully. */ - create?(e: CreateEventArgs): void; - - /** Fires when ToggleButton control is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; -} - -export interface ChangeEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** return the toggle button checked state - */ - isChecked?: boolean; - - /** returns the toggle button model - */ - model?: ej.ToggleButton.Model; - - /** returns the name of the event - */ - type?: string; -} - -export interface ClickEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** return the toggle button checked state - */ - isChecked?: boolean; - - /** returns the toggle button model - */ - model?: ej.ToggleButton.Model; - - /** return the toggle button state - */ - status?: boolean; - - /** returns the name of the event - */ - type?: string; -} - -export interface CreateEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the toggle button model - */ - model?: ej.ToggleButton.Model; - - /** returns the name of the event - */ - type?: string; -} - -export interface DestroyEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the toggle button model - */ - model?: ej.ToggleButton.Model; - - /** returns the name of the event - */ - type?: string; -} -} - -class Toolbar extends ej.Widget { - static fn: Toolbar; - constructor(element: JQuery | Element, options?: Toolbar.Model); - static Locale: any; - model: Toolbar.Model; - defaults: Toolbar.Model; - - /** Deselect the specified Toolbar item. - * @param {any} The element need to be deselected - * @returns {void} - */ - deselectItem(element: any): void; - - /** Deselect the Toolbar item based on specified id. - * @param {string} The ID of the element need to be deselected - * @returns {void} - */ - deselectItemByID(ID: string): void; - - /** Allows you to destroy the Toolbar widget. - * @returns {void} - */ - destroy(): void; - - /** To disable all items in the Toolbar control. - * @returns {void} - */ - disable(): void; - - /** Disable the specified Toolbar item. - * @param {any} The element need to be disabled - * @returns {void} - */ - disableItem(element: any): void; - - /** Disable the Toolbar item based on specified item id in the Toolbar. - * @param {string} The ID of the element need to be disabled - * @returns {void} - */ - disableItemByID(ID: string): void; - - /** Enable the Toolbar if it is in disabled state. - * @returns {void} - */ - enable(): void; - - /** Enable the Toolbar item based on specified item. - * @param {any} The element need to be enabled - * @returns {void} - */ - enableItem(element: any): void; - - /** Enable the Toolbar item based on specified item id in the Toolbar. - * @param {string} The ID of the element need to be enabled - * @returns {void} - */ - enableItemByID(ID: string): void; - - /** To hide the Toolbar - * @returns {void} - */ - hide(): void; - - /** Remove the item from toolbar, based on specified item. - * @param {any} The element need to be removed - * @returns {void} - */ - removeItem(element: any): void; - - /** Remove the item from toolbar, based on specified item id in the Toolbar. - * @param {string} The ID of the element need to be removed - * @returns {void} - */ - removeItemByID(ID: string): void; - - /** Selects the item from toolbar, based on specified item. - * @param {any} The element need to be selected - * @returns {void} - */ - selectItem(element: any): void; - - /** Selects the item from toolbar, based on specified item id in the Toolbar. - * @param {string} The ID of the element need to be selected - * @returns {void} - */ - selectItemByID(ID: string): void; - - /** To show the Toolbar. - * @returns {void} - */ - show(): void; -} -export namespace Toolbar { - -export interface Model { - - /** Sets the root CSS class for Toolbar control to achieve the custom theme. - */ - cssClass?: string; - - /** Specifies dataSource value for the Toolbar control during initialization. - * @Default {null} - */ - dataSource?: any; - - /** Disables an Item or set of Items that are enabled in the Toolbar - * @Default {[]} - */ - disabledItemIndices?: any[]; - - /** Specifies the Toolbar control state. - * @Default {true} - */ - enabled?: boolean; - - /** Enables an Item or set of Items that are disabled in the Toolbar - * @Default {[]} - */ - enabledItemIndices?: any[]; - - /** Specifies enableRTL property to align the Toolbar control from right to left direction. - * @Default {false} - */ - enableRTL?: boolean; - - /** Allows to separate the each UL items in the Toolbar control. - * @Default {false} - */ - enableSeparator?: boolean; - - /** Specifies the mapping fields for the data items of the Toolbar - * @Default {null} - */ - fields?: string; - - /** Specifies the height of the Toolbar. - * @Default {28} - */ - height?: number|string; - - /** Specifies the list of HTML attributes to be added to toolbar control. - * @Default {{}} - */ - htmlAttributes?: any; - - /** Specifies whether the Toolbar control is need to be show or hide. - * @Default {false} - */ - hide?: boolean; - - /** Enables/Disables the responsive support for Toolbar items during the window resizing time. - * @Default {false} - */ - isResponsive?: boolean; - - /** Specifies the items of Toolbar - * @Default {null} - */ - Items?: Items; - - /** Specifies the Toolbar orientation. See orientation - * @Default {Horizontal} - */ - orientation?: ej.Orientation|string; - - /** Specifies the query to retrieve the data from the online server. The query is used only when the online dataSource is used. - * @Default {null} - */ - query?: any; - - /** Specifies the Toolbar responsive type. - * @Default {Popup} - */ - responsiveType?: ej.Toolbar.ResponsiveType|string; - - /** Displays the Toolbar with rounded corners. - * @Default {false} - */ - showRoundedCorner?: boolean; - - /** Specifies the width of the Toolbar. - */ - width?: number|string; - - /** Fires after Toolbar control is clicked. */ - click?(e: ClickEventArgs): void; + export interface OpenEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the TimePicker model + */ + model?: ej.TimePicker.Model; + + /** returns the name of the event + */ + type?: string; + + /** returns the time value + */ + value?: string; + } + + export interface SelectEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the TimePicker model + */ + model?: ej.TimePicker.Model; + + /** returns the name of the event + */ + type?: string; + + /** returns the previously selected time value + */ + prevTime?: string; + + /** returns the selected time value + */ + value?: string; + } + } + + class ToggleButton extends ej.Widget { + static fn: ToggleButton; + constructor(element: JQuery | Element, options?: ToggleButton.Model); + static Locale: any; + model: ToggleButton.Model; + defaults: ToggleButton.Model; + + /** Allows you to destroy the ToggleButton widget. + * @returns {void} + */ + destroy(): void; + + /** To disable the ToggleButton to prevent all user interactions. + * @returns {void} + */ + disable(): void; + + /** To enable the ToggleButton. + * @returns {void} + */ + enable(): void; + } + export namespace ToggleButton { + + export interface Model { + + /** Specify the icon in active state to the toggle button and it will be aligned from left margin of the button. + */ + activePrefixIcon?: string; + + /** Specify the icon in active state to the toggle button and it will be aligned from right margin of the button. + */ + activeSuffixIcon?: string; + + /** Sets the text when ToggleButton is in active state i.e.,checked state. + * @Default {null} + */ + activeText?: string; + + /** Specifies the contentType of the ToggleButton. See ContentType as below + * @Default {ej.ContentType.TextOnly} + */ + contentType?: ej.ContentType | string; + + /** Specify the CSS class to the ToggleButton to achieve custom theme. + */ + cssClass?: string; + + /** Specify the icon in default state to the toggle button and it will be aligned from left margin of the button. + */ + defaultPrefixIcon?: string; + + /** Specify the icon in default state to the toggle button and it will be aligned from right margin of the button. + */ + defaultSuffixIcon?: string; + + /** Specifies the text of the ToggleButton, when the control is a default state. i.e., unChecked state. + * @Default {null} + */ + defaultText?: string; + + /** Specifies the state of the ToggleButton. + * @Default {true} + */ + enabled?: boolean; + + /** Save current model value to browser cookies for maintaining states. When refreshing the ToggleButton control page, the model value is applied from browser cookies or HTML 5local storage. + * @Default {false} + */ + enablePersistence?: boolean; + + /** Specify the Right to Left direction of the ToggleButton. + * @Default {false} + */ + enableRTL?: boolean; + + /** Specifies the height of the ToggleButton. + * @Default {28pixel} + */ + height?: number | string; + + /** It allows to define the characteristics of the ToggleButton control. It will helps to extend the capability of an HTML element. + * @Default {{}} + */ + htmlAttributes?: any; + + /** Specifies the image position of the ToggleButton. + * @Default {ej.ImagePosition.ImageLeft} + */ + imagePosition?: ej.ImagePosition | string; + + /** Allows to prevents the control switched to checked (active) state. + * @Default {false} + */ + preventToggle?: boolean; + + /** Displays the ToggleButton with rounded corners. + * @Default {false} + */ + showRoundedCorner?: boolean; + + /** Specifies the size of the ToggleButton. See ButtonSize as below + * @Default {ej.ButtonSize.Normal} + */ + size?: ej.ButtonSize | string; + + /** It allows to define the ToggleButton state to checked(Active) or unchecked(Default) at initial time. + * @Default {false} + */ + toggleState?: boolean; + + /** Specifies the type of the ToggleButton. See ButtonType as below + * @Default {ej.ButtonType.Button} + */ + type?: ej.ButtonType | string; + + /** Specifies the width of the ToggleButton. + * @Default {100pixel} + */ + width?: number | string; + + /** Fires when ToggleButton control state is changed successfully. */ + change?(e: ChangeEventArgs): void; + + /** Fires when ToggleButton control is clicked successfully. */ + click?(e: ClickEventArgs): void; + + /** Fires when ToggleButton control is created successfully. */ + create?(e: CreateEventArgs): void; + + /** Fires when ToggleButton control is destroyed successfully. */ + destroy?(e: DestroyEventArgs): void; + } + + export interface ChangeEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** return the toggle button checked state + */ + isChecked?: boolean; + + /** returns the toggle button model + */ + model?: ej.ToggleButton.Model; + + /** returns the name of the event + */ + type?: string; + } + + export interface ClickEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** return the toggle button checked state + */ + isChecked?: boolean; + + /** returns the toggle button model + */ + model?: ej.ToggleButton.Model; + + /** return the toggle button state + */ + status?: boolean; + + /** returns the name of the event + */ + type?: string; + } + + export interface CreateEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the toggle button model + */ + model?: ej.ToggleButton.Model; + + /** returns the name of the event + */ + type?: string; + } + + export interface DestroyEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the toggle button model + */ + model?: ej.ToggleButton.Model; + + /** returns the name of the event + */ + type?: string; + } + } + + class Toolbar extends ej.Widget { + static fn: Toolbar; + constructor(element: JQuery | Element, options?: Toolbar.Model); + static Locale: any; + model: Toolbar.Model; + defaults: Toolbar.Model; + + /** Deselect the specified Toolbar item. + * @param {any} The element need to be deselected + * @returns {void} + */ + deselectItem(element: any): void; + + /** Deselect the Toolbar item based on specified id. + * @param {string} The ID of the element need to be deselected + * @returns {void} + */ + deselectItemByID(ID: string): void; + + /** Allows you to destroy the Toolbar widget. + * @returns {void} + */ + destroy(): void; + + /** To disable all items in the Toolbar control. + * @returns {void} + */ + disable(): void; + + /** Disable the specified Toolbar item. + * @param {any} The element need to be disabled + * @returns {void} + */ + disableItem(element: any): void; + + /** Disable the Toolbar item based on specified item id in the Toolbar. + * @param {string} The ID of the element need to be disabled + * @returns {void} + */ + disableItemByID(ID: string): void; + + /** Enable the Toolbar if it is in disabled state. + * @returns {void} + */ + enable(): void; + + /** Enable the Toolbar item based on specified item. + * @param {any} The element need to be enabled + * @returns {void} + */ + enableItem(element: any): void; + + /** Enable the Toolbar item based on specified item id in the Toolbar. + * @param {string} The ID of the element need to be enabled + * @returns {void} + */ + enableItemByID(ID: string): void; + + /** To hide the Toolbar + * @returns {void} + */ + hide(): void; + + /** Remove the item from toolbar, based on specified item. + * @param {any} The element need to be removed + * @returns {void} + */ + removeItem(element: any): void; + + /** Remove the item from toolbar, based on specified item id in the Toolbar. + * @param {string} The ID of the element need to be removed + * @returns {void} + */ + removeItemByID(ID: string): void; + + /** Selects the item from toolbar, based on specified item. + * @param {any} The element need to be selected + * @returns {void} + */ + selectItem(element: any): void; + + /** Selects the item from toolbar, based on specified item id in the Toolbar. + * @param {string} The ID of the element need to be selected + * @returns {void} + */ + selectItemByID(ID: string): void; + + /** To show the Toolbar. + * @returns {void} + */ + show(): void; + } + export namespace Toolbar { + + export interface Model { + + /** Sets the root CSS class for Toolbar control to achieve the custom theme. + */ + cssClass?: string; + + /** Specifies dataSource value for the Toolbar control during initialization. + * @Default {null} + */ + dataSource?: any; + + /** Disables an Item or set of Items that are enabled in the Toolbar + * @Default {[]} + */ + disabledItemIndices?: any[]; + + /** Specifies the Toolbar control state. + * @Default {true} + */ + enabled?: boolean; + + /** Enables an Item or set of Items that are disabled in the Toolbar + * @Default {[]} + */ + enabledItemIndices?: any[]; + + /** Specifies enableRTL property to align the Toolbar control from right to left direction. + * @Default {false} + */ + enableRTL?: boolean; + + /** Allows to separate the each UL items in the Toolbar control. + * @Default {false} + */ + enableSeparator?: boolean; + + /** Specifies the mapping fields for the data items of the Toolbar + * @Default {null} + */ + fields?: string; + + /** Specifies the height of the Toolbar. + * @Default {28} + */ + height?: number | string; + + /** Specifies the list of HTML attributes to be added to toolbar control. + * @Default {{}} + */ + htmlAttributes?: any; + + /** Specifies whether the Toolbar control is need to be show or hide. + * @Default {false} + */ + hide?: boolean; + + /** Enables/Disables the responsive support for Toolbar items during the window resizing time. + * @Default {false} + */ + isResponsive?: boolean; + + /** Specifies the items of Toolbar + * @Default {null} + */ + Items?: Items; + + /** Specifies the Toolbar orientation. See orientation + * @Default {Horizontal} + */ + orientation?: ej.Orientation | string; + + /** Specifies the query to retrieve the data from the online server. The query is used only when the online dataSource is used. + * @Default {null} + */ + query?: any; + + /** Specifies the Toolbar responsive type. + * @Default {Popup} + */ + responsiveType?: ej.Toolbar.ResponsiveType | string; + + /** Displays the Toolbar with rounded corners. + * @Default {false} + */ + showRoundedCorner?: boolean; + + /** Specifies the width of the Toolbar. + */ + width?: number | string; + + /** Fires after Toolbar control is clicked. */ + click?(e: ClickEventArgs): void; - /** Fires after Toolbar control is created. */ - create?(e: CreateEventArgs): void; - - /** Fires after Toolbar control is focused. */ - focusOut?(e: FocusOutEventArgs): void; + /** Fires after Toolbar control is created. */ + create?(e: CreateEventArgs): void; + + /** Fires after Toolbar control is focused. */ + focusOut?(e: FocusOutEventArgs): void; - /** Fires when the Toolbar is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; + /** Fires when the Toolbar is destroyed successfully. */ + destroy?(e: DestroyEventArgs): void; - /** Fires after Toolbar control item is hovered. */ - itemHover?(e: ItemHoverEventArgs): void; + /** Fires after Toolbar control item is hovered. */ + itemHover?(e: ItemHoverEventArgs): void; - /** Fires after mouse leave from Toolbar control item. */ - itemLeave?(e: ItemLeaveEventArgs): void; - - /** Fires when the overflow popup of toolbar is opened. */ - overflowOpen?(e: OverflowOpenEventArgs): void; + /** Fires after mouse leave from Toolbar control item. */ + itemLeave?(e: ItemLeaveEventArgs): void; + + /** Fires when the overflow popup of toolbar is opened. */ + overflowOpen?(e: OverflowOpenEventArgs): void; - /** Fires when the overflow popup of toolbar is closed. */ - overflowClose?(e: OverflowCloseEventArgs): void; -} + /** Fires when the overflow popup of toolbar is closed. */ + overflowClose?(e: OverflowCloseEventArgs): void; + } -export interface ClickEventArgs { + export interface ClickEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the Toolbar model - */ - model?: ej.Toolbar.Model; + /** returns the Toolbar model + */ + model?: ej.Toolbar.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the target of the current object. - */ - target?: any; + /** returns the target of the current object. + */ + target?: any; - /** returns the target of the current object. - */ - currentTarget?: any; + /** returns the target of the current object. + */ + currentTarget?: any; - /** return the Toolbar state - */ - status?: boolean; -} + /** return the Toolbar state + */ + status?: boolean; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the Toolbar model - */ - model?: ej.Toolbar.Model; + /** returns the Toolbar model + */ + model?: ej.Toolbar.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface FocusOutEventArgs { + export interface FocusOutEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the Toolbar model - */ - model?: ej.Toolbar.Model; + /** returns the Toolbar model + */ + model?: ej.Toolbar.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the Toolbar model - */ - model?: ej.Toolbar.Model; + /** returns the Toolbar model + */ + model?: ej.Toolbar.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface ItemHoverEventArgs { + export interface ItemHoverEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the Toolbar model - */ - model?: ej.Toolbar.Model; + /** returns the Toolbar model + */ + model?: ej.Toolbar.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the target of the current object. - */ - target?: any; + /** returns the target of the current object. + */ + target?: any; - /** returns the target of the current object. - */ - currentTarget?: any; + /** returns the target of the current object. + */ + currentTarget?: any; - /** return the Toolbar state - */ - status?: boolean; -} + /** return the Toolbar state + */ + status?: boolean; + } -export interface ItemLeaveEventArgs { + export interface ItemLeaveEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the Toolbar model - */ - model?: ej.Toolbar.Model; + /** returns the Toolbar model + */ + model?: ej.Toolbar.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the target of the current object. - */ - target?: any; + /** returns the target of the current object. + */ + target?: any; - /** returns the target of the current object. - */ - currentTarget?: any; + /** returns the target of the current object. + */ + currentTarget?: any; - /** return the Toolbar state - */ - status?: boolean; -} + /** return the Toolbar state + */ + status?: boolean; + } -export interface OverflowOpenEventArgs { + export interface OverflowOpenEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the Toolbar model - */ - model?: ej.Toolbar.Model; + /** returns the Toolbar model + */ + model?: ej.Toolbar.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** Returns the current X position of the target . - */ - clientX?: number; + /** Returns the current X position of the target . + */ + clientX?: number; - /** Returns the current Y position of the target . - */ - clientY?: number; + /** Returns the current Y position of the target . + */ + clientY?: number; - /** returns the target of the current object. - */ - currentTarget?: any; -} + /** returns the target of the current object. + */ + currentTarget?: any; + } -export interface OverflowCloseEventArgs { + export interface OverflowCloseEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the Toolbar model - */ - model?: ej.Toolbar.Model; + /** returns the Toolbar model + */ + model?: ej.Toolbar.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** Returns the current X position of the target . - */ - clientX?: number; + /** Returns the current X position of the target . + */ + clientX?: number; - /** Returns the current Y position of the target . - */ - clientY?: number; + /** Returns the current Y position of the target . + */ + clientY?: number; - /** returns the target of the current object. - */ - currentTarget?: any; -} + /** returns the target of the current object. + */ + currentTarget?: any; + } -export interface Fields { + export interface Fields { - /** Defines the group name for the item. - */ - group?: string; + /** Defines the group name for the item. + */ + group?: string; - /** Defines the HTML attributes such as id, class, styles for the item to extend the capability. - */ - htmlAttributes?: any; + /** Defines the HTML attributes such as id, class, styles for the item to extend the capability. + */ + htmlAttributes?: any; - /** Defines id for the tag. - */ - id?: string; + /** Defines id for the tag. + */ + id?: string; - /** Defines the image attributes such as height, width, styles and so on. - */ - imageAttributes?: string; + /** Defines the image attributes such as height, width, styles and so on. + */ + imageAttributes?: string; - /** Defines the imageURL for the image location. - */ - imageUrl?: string; - - /** Defines the sprite CSS for the image tag. - */ - spriteCssClass?: string; - - /** Defines the text content for the tag. - */ - text?: string; - - /** Defines the tooltip text for the tag. - */ - tooltipText?: string; - - /** Allows you to add template as toolbar item - */ - template?: string; -} - -export interface Items { - - /** Defines the group name for the item. - */ - group?: string; - - /** Defines the HTML attributes such as id, class, styles for the item . - */ - htmlAttributes?: any; - - /** Defines id for the tag. - */ - id?: string; - - /** Defines the image attributes such as height, width, styles and so on. - */ - imageAttributes?: string; - - /** Defines the imageURL for the image location. - */ - imageUrl?: string; - - /** Defines the sprite CSS for the image tag. - */ - spriteCssClass?: string; - - /** Defines the text content for the tag. - */ - text?: string; - - /** Defines the tooltip text for the tag. - */ - tooltipText?: string; - - /** Allows to add template as toolbar item. - */ - template?: string; -} - -enum ResponsiveType { - - ///To display the toolbar overflow items as popup - Popup, - - ///To display the toolbar overflow items as inline toolbar - Inline -} - -} - -class TreeView extends ej.Widget { - static fn: TreeView; - constructor(element: JQuery | Element, options?: TreeView.Model); - static Locale: any; - model: TreeView.Model; - defaults: TreeView.Model; - - /** To add a Node or collection of nodes in TreeView. If target tree node is specified, then the given nodes are added as child of target tree node, otherwise nodes are added in TreeView. - * @param {string|any} New node text or JSON object - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {void} - */ - addNode(newNodeText: string|any, target: string|any): void; - - /** To add a collection of nodes in TreeView. If target tree node is specified, then the given nodes are added as child of target tree node, otherwise nodes are added in TreeView. - * @param {any|Array} New node details in JSON object - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {void} - */ - addNodes(collection: any|any[], target: string|any): void; - - /** To check all the nodes in TreeView. - * @returns {void} - */ - checkAll(): void; - - /** To check a node in TreeView. - * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes - * @returns {void} - */ - checkNode(element: string|any|any[]): void; - - /** This method is used to collapse all nodes in TreeView control. If you want to collapse all nodes up to the specific level in - * TreeView control then we need to pass levelUntil as argument to this method. - * @param {number} TreeView nodes will collapse until the given level - * @param {boolean} Weather exclude the hidden nodes of TreeView while collapse all nodes - * @returns {void} - */ - collapseAll(levelUntil?: number, excludeHiddenNodes?: boolean): void; - - /** To collapse a particular node in TreeView. - * @param {string|any|Array} ID of TreeView node|object of TreeView node/collection of ID/object of TreeView nodes - * @returns {void} - */ - collapseNode(element: string|any|any[]): void; - - /** To disable the node in the TreeView. - * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes - * @returns {void} - */ - disableNode(element: string|any|any[]): void; - - /** To enable the node in the TreeView. - * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes - * @returns {void} - */ - enableNode(element: string|any|any[]): void; - - /** To ensure that the TreeView node is visible in the TreeView. This method is useful if we need select a TreeView node dynamically. - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {boolean} - */ - ensureVisible(element: string|any): boolean; - - /** This method is used to expand all nodes in TreeView control. If you want to expand all nodes up to the specific level in TreeView control - * then we need to pass levelUntil as argument to this method. - * @param {number} TreeView nodes will expand until the given level - * @param {boolean} Weather exclude the hidden nodes of TreeView while expand all nodes - * @returns {void} - */ - expandAll(levelUntil?: number, excludeHiddenNodes?: boolean): void; - - /** To expandNode particular node in TreeView. - * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes - * @returns {void} - */ - expandNode(element: string|any|any[]): void; - - /** To get currently checked nodes in TreeView. - * @returns {any} - */ - getCheckedNodes(): any; - - /** To get currently checked nodes indexes in TreeView. - * @returns {Array} - */ - getCheckedNodesIndex(): any[]; - - /** This method is used to get immediate child nodes of a node in TreeView control. If you want to get the all child nodes include nested - * child nodes then we need to pass includeNestedChild as true along with element arguments to this method. - * @param {string|any} ID of TreeView node/object of TreeView node - * @param {boolean} Weather include nested child nodes of TreeView node - * @returns {Array} - */ - getChildren(element: string|any, includeNestedChild?: boolean): any[]; - - /** To get number of nodes in TreeView. - * @returns {number} - */ - getNodeCount(): number; - - /** To get currently expanded nodes in TreeView. - * @returns {any} - */ - getExpandedNodes(): any; - - /** To get currently expanded nodes indexes in TreeView. - * @returns {Array} - */ - getExpandedNodesIndex(): any[]; - - /** To get TreeView node by using index position in TreeView. - * @param {number} Index position of TreeView node - * @returns {any} - */ - getNodeByIndex(index: number): any; - - /** To get TreeView node data such as id, text, parentId, selected, checked, expanded, level, childes and index. - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {any} - */ - getNode(element: string|any): any; - - /** To get current index position of TreeView node. - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {number} - */ - getNodeIndex(element: string|any): number; - - /** To get immediate parent TreeView node of particular TreeView node. - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {any} - */ - getParent(element: string|any): any; - - /** To get the currently selected node in TreeView. - * @returns {any} - */ - getSelectedNode(): any; - - /** To get the currently selected nodes in TreeView. - * @returns {Array} - */ - getSelectedNodes(): any[]; - - /** To get the index position of currently selected node in TreeView. - * @returns {number} - */ - getSelectedNodeIndex(): number; - - /** To get the index positions of currently selected nodes in TreeView. - * @returns {Array} - */ - getSelectedNodesIndex(): any[]; - - /** To get the text of a node in TreeView. - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {string} - */ - getText(element: string|any): string; - - /** To get the updated datasource of TreeView after performing some operation like drag and drop, node editing, adding and removing node. - * @param {string|number} ID of TreeView node - * @returns {Array} - */ - getTreeData(id?: string|number): any[]; - - /** To get currently visible nodes in TreeView. - * @returns {any} - */ - getVisibleNodes(): any; - - /** To check a node having child or not. - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {boolean} - */ - hasChildNode(element: string|any): boolean; - - /** To show nodes in TreeView. - * @returns {void} - */ - hide(): void; - - /** To hide particular node in TreeView. - * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes - * @returns {void} - */ - hideNode(element: string|any|any[]): void; - - /** To add a Node or collection of nodes after the particular TreeView node. - * @param {string|any} New node text or JSON object - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {void} - */ - insertAfter(newNodeText: string|any, target: string|any): void; - - /** To add a Node or collection of nodes before the particular TreeView node. - * @param {string|any} New node text or JSON object - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {void} - */ - insertBefore(newNodeText: string|any, target: string|any): void; - - /** To check the given TreeView node is checked or unchecked. - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {boolean} - */ - isNodeChecked(element: string|any): boolean; - - /** To check whether the child nodes are loaded of the given TreeView node. - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {boolean} - */ - isChildLoaded(element: string|any): boolean; - - /** To check the given TreeView node is disabled or enabled. - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {boolean} - */ - isDisabled(element: string|any): boolean; - - /** To check the given node is exist in TreeView. - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {boolean} - */ - isExist(element: string|any): boolean; - - /** To get the expand status of the given TreeView node. - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {boolean} - */ - isExpanded(element: string|any): boolean; - - /** To get the select status of the given TreeView node. - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {boolean} - */ - isSelected(element: string|any): boolean; - - /** To get the visibility status of the given TreeView node. - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {boolean} - */ - isVisible(element: string|any): boolean; - - /** To load the TreeView nodes from the particular URL. If target tree node is specified, then the given nodes are added as child of target tree node, otherwise nodes are added in TreeView. - * @param {string} URL location, the data returned from the URL will be loaded in TreeView - * @param {string|any} ID of TreeView node/object of TreeView node - * @returns {void} - */ - loadData(URL: string, target: string|any): void; - - /** To move the TreeView node with in same TreeView. The new position of given TreeView node will be based on destination node and index position. - * @param {string|any} ID of TreeView node/object of TreeView node - * @param {string|any} ID of TreeView node/object of TreeView node - * @param {number} New index position of given source node - * @returns {void} - */ - moveNode(sourceNode: string|any, destinationNode: string|any, index: number): void; - - /** To refresh the TreeView - * @returns {void} - */ - refresh(): void; - - /** To remove all the nodes in TreeView. - * @returns {void} - */ - removeAll(): void; - - /** To remove a node in TreeView. - * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes - * @returns {void} - */ - removeNode(element: string|any|any[]): void; - - /** To select all the TreeView nodes when enable allowMultiSelection property. - * @returns {void} - */ - selectAll(): void; - - /** This method is used to select a node in TreeView control. If you want to select the collection of nodes in TreeView control then we need to enable allowMultiSelection property. - * @param {string|any|Array} ID of TreeView node/object of TreeView node/ collection of ID/object of TreeView nodes - * @returns {void} - */ - selectNode(element: string|any|any[]): void; - - /** To show nodes in TreeView. - * @returns {void} - */ - show(): void; - - /** To show a node in TreeView. - * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes - * @returns {void} - */ - showNode(element: string|any|any[]): void; - - /** To uncheck all the nodes in TreeView. - * @returns {void} - */ - unCheckAll(): void; - - /** To uncheck a node in TreeView. - * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes - * @returns {void} - */ - uncheckNode(element: string|any|any[]): void; - - /** To unselect all the TreeView nodes when enable allowMultiSelection property. - * @returns {void} - */ - unselectAll(): void; - - /** This method is used to unselect a node in TreeView control. If you want to unselect the collection of nodes in TreeView control then we need to enable allowMultiSelection property. - * @param {string|any|Array} ID of TreeView node/object of TreeView node/ collection of ID/object of TreeView nodes - * @returns {void} - */ - unselectNode(element: string|any|any[]): void; - - /** To edit or update the text of the TreeView node. - * @param {string|any} ID of TreeView node/object of TreeView node - * @param {string} New text - * @returns {void} - */ - updateText(target: string|any, newText: string): void; -} -export namespace TreeView { - -export interface Model { - - /** Gets or sets a value that indicates whether to enable drag and drop a node within the same tree. - * @Default {false} - */ - allowDragAndDrop?: boolean; - - /** Gets or sets a value that indicates whether to enable drag and drop a node in inter ej.TreeView. - * @Default {true} - */ - allowDragAndDropAcrossControl?: boolean; - - /** Gets or sets a value that indicates whether to drop a node to a sibling of particular node. - * @Default {true} - */ - allowDropSibling?: boolean; - - /** Gets or sets a value that indicates whether to drop a node to a child of particular node. - * @Default {true} - */ - allowDropChild?: boolean; - - /** Gets or sets a value that indicates whether to enable node editing support for TreeView. - * @Default {false} - */ - allowEditing?: boolean; - - /** Gets or sets a value that indicates whether to enable keyboard support for TreeView actions like nodeSelection, nodeEditing, nodeExpand, nodeCollapse, nodeCut and Paste. - * @Default {true} - */ - allowKeyboardNavigation?: boolean; - - /** Gets or sets a value that indicates whether to enable multi selection support for TreeView. - * @Default {false} - */ - allowMultiSelection?: boolean; - - /** Allow us to specify the parent and child nodes to get auto check while we check or uncheck a node. - * @Default {true} - */ - autoCheck?: boolean; - - /** Allow us to specify the parent node to be retain in checked or unchecked state instead of going for indeterminate state. - * @Default {false} - */ - autoCheckParentNode?: boolean; - - /** Gets or sets a value that indicates the checkedNodes index collection as an array. The given array index position denotes the nodes, that are checked while rendering TreeView. - * @Default {[]} - */ - checkedNodes?: any[]; - - /** Sets the root CSS class for TreeView which allow us to customize the appearance. - */ - cssClass?: string; - - /** Gets or sets a value that indicates whether to enable or disable the animation effect while expanding or collapsing a node. - * @Default {true} - */ - enableAnimation?: boolean; - - /** Gets or sets a value that indicates whether a TreeView can be enabled or disabled. No actions can be performed while this property is set as false - * @Default {true} - */ - enabled?: boolean; - - /** Allow us to prevent multiple nodes to be in expanded state. If it set to false, previously expanded node will be collapsed automatically, while we expand a node. - * @Default {true} - */ - enableMultipleExpand?: boolean; - - /** Sets a value that indicates whether to persist the TreeView model state in page using applicable medium i.e., HTML5 localStorage or cookies - * @Default {false} - */ - enablePersistence?: boolean; - - /** Gets or sets a value that indicates to align content in the TreeView control from right to left by setting the property as true. - * @Default {false} - */ - enableRTL?: boolean; - - /** Gets or sets a array of value that indicates the expandedNodes index collection as an array. The given array index position denotes the nodes, that are expanded while rendering TreeView. - * @Default {[]} - */ - expandedNodes?: any[]; - - /** Gets or sets a value that indicates the TreeView node can be expand or collapse by using the specified action. - * @Default {dblclick} - */ - expandOn?: string; - - /** Gets or sets a fields object that allow us to map the data members with field properties in order to make the data binding easier. - * @Default {null} - */ - fields?: Fields; - - /** Gets or sets a value that indicates whether to enable full row selection support for TreeView. - * @Default {false} - */ - fullRowSelect?: boolean; - - /** Defines the height of the TreeView. - * @Default {Null} - */ - height?: string|number; - - /** Specifies the HTML Attributes for the TreeView. Using this API we can add custom attributes in TreeView control. - * @Default {{}} - */ - htmlAttributes?: any; + /** Defines the imageURL for the image location. + */ + imageUrl?: string; + + /** Defines the sprite CSS for the image tag. + */ + spriteCssClass?: string; + + /** Defines the text content for the tag. + */ + text?: string; + + /** Defines the tooltip text for the tag. + */ + tooltipText?: string; + + /** Allows you to add template as toolbar item + */ + template?: string; + } + + export interface Items { + + /** Defines the group name for the item. + */ + group?: string; + + /** Defines the HTML attributes such as id, class, styles for the item . + */ + htmlAttributes?: any; + + /** Defines id for the tag. + */ + id?: string; + + /** Defines the image attributes such as height, width, styles and so on. + */ + imageAttributes?: string; + + /** Defines the imageURL for the image location. + */ + imageUrl?: string; + + /** Defines the sprite CSS for the image tag. + */ + spriteCssClass?: string; + + /** Defines the text content for the tag. + */ + text?: string; + + /** Defines the tooltip text for the tag. + */ + tooltipText?: string; + + /** Allows to add template as toolbar item. + */ + template?: string; + } + + enum ResponsiveType { + + ///To display the toolbar overflow items as popup + Popup, + + ///To display the toolbar overflow items as inline toolbar + Inline + } + + } + + class TreeView extends ej.Widget { + static fn: TreeView; + constructor(element: JQuery | Element, options?: TreeView.Model); + static Locale: any; + model: TreeView.Model; + defaults: TreeView.Model; + + /** To add a Node or collection of nodes in TreeView. If target tree node is specified, then the given nodes are added as child of target tree node, otherwise nodes are added in TreeView. + * @param {string|any} New node text or JSON object + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {void} + */ + addNode(newNodeText: string | any, target: string | any): void; + + /** To add a collection of nodes in TreeView. If target tree node is specified, then the given nodes are added as child of target tree node, otherwise nodes are added in TreeView. + * @param {any|Array} New node details in JSON object + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {void} + */ + addNodes(collection: any | any[], target: string | any): void; + + /** To check all the nodes in TreeView. + * @returns {void} + */ + checkAll(): void; + + /** To check a node in TreeView. + * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes + * @returns {void} + */ + checkNode(element: string | any | any[]): void; + + /** This method is used to collapse all nodes in TreeView control. If you want to collapse all nodes up to the specific level in + * TreeView control then we need to pass levelUntil as argument to this method. + * @param {number} TreeView nodes will collapse until the given level + * @param {boolean} Weather exclude the hidden nodes of TreeView while collapse all nodes + * @returns {void} + */ + collapseAll(levelUntil?: number, excludeHiddenNodes?: boolean): void; + + /** To collapse a particular node in TreeView. + * @param {string|any|Array} ID of TreeView node|object of TreeView node/collection of ID/object of TreeView nodes + * @returns {void} + */ + collapseNode(element: string | any | any[]): void; + + /** To disable the node in the TreeView. + * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes + * @returns {void} + */ + disableNode(element: string | any | any[]): void; + + /** To enable the node in the TreeView. + * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes + * @returns {void} + */ + enableNode(element: string | any | any[]): void; + + /** To ensure that the TreeView node is visible in the TreeView. This method is useful if we need select a TreeView node dynamically. + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {boolean} + */ + ensureVisible(element: string | any): boolean; + + /** This method is used to expand all nodes in TreeView control. If you want to expand all nodes up to the specific level in TreeView control + * then we need to pass levelUntil as argument to this method. + * @param {number} TreeView nodes will expand until the given level + * @param {boolean} Weather exclude the hidden nodes of TreeView while expand all nodes + * @returns {void} + */ + expandAll(levelUntil?: number, excludeHiddenNodes?: boolean): void; + + /** To expandNode particular node in TreeView. + * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes + * @returns {void} + */ + expandNode(element: string | any | any[]): void; + + /** To get currently checked nodes in TreeView. + * @returns {any} + */ + getCheckedNodes(): any; + + /** To get currently checked nodes indexes in TreeView. + * @returns {Array} + */ + getCheckedNodesIndex(): any[]; + + /** This method is used to get immediate child nodes of a node in TreeView control. If you want to get the all child nodes include nested + * child nodes then we need to pass includeNestedChild as true along with element arguments to this method. + * @param {string|any} ID of TreeView node/object of TreeView node + * @param {boolean} Weather include nested child nodes of TreeView node + * @returns {Array} + */ + getChildren(element: string | any, includeNestedChild?: boolean): any[]; + + /** To get number of nodes in TreeView. + * @returns {number} + */ + getNodeCount(): number; + + /** To get currently expanded nodes in TreeView. + * @returns {any} + */ + getExpandedNodes(): any; + + /** To get currently expanded nodes indexes in TreeView. + * @returns {Array} + */ + getExpandedNodesIndex(): any[]; + + /** To get TreeView node by using index position in TreeView. + * @param {number} Index position of TreeView node + * @returns {any} + */ + getNodeByIndex(index: number): any; + + /** To get TreeView node data such as id, text, parentId, selected, checked, expanded, level, childes and index. + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {any} + */ + getNode(element: string | any): any; + + /** To get current index position of TreeView node. + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {number} + */ + getNodeIndex(element: string | any): number; + + /** To get immediate parent TreeView node of particular TreeView node. + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {any} + */ + getParent(element: string | any): any; + + /** To get the currently selected node in TreeView. + * @returns {any} + */ + getSelectedNode(): any; + + /** To get the currently selected nodes in TreeView. + * @returns {Array} + */ + getSelectedNodes(): any[]; + + /** To get the index position of currently selected node in TreeView. + * @returns {number} + */ + getSelectedNodeIndex(): number; + + /** To get the index positions of currently selected nodes in TreeView. + * @returns {Array} + */ + getSelectedNodesIndex(): any[]; + + /** To get the text of a node in TreeView. + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {string} + */ + getText(element: string | any): string; + + /** To get the updated datasource of TreeView after performing some operation like drag and drop, node editing, adding and removing node. + * @param {string|number} ID of TreeView node + * @returns {Array} + */ + getTreeData(id?: string | number): any[]; + + /** To get currently visible nodes in TreeView. + * @returns {any} + */ + getVisibleNodes(): any; + + /** To check a node having child or not. + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {boolean} + */ + hasChildNode(element: string | any): boolean; + + /** To show nodes in TreeView. + * @returns {void} + */ + hide(): void; + + /** To hide particular node in TreeView. + * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes + * @returns {void} + */ + hideNode(element: string | any | any[]): void; + + /** To add a Node or collection of nodes after the particular TreeView node. + * @param {string|any} New node text or JSON object + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {void} + */ + insertAfter(newNodeText: string | any, target: string | any): void; + + /** To add a Node or collection of nodes before the particular TreeView node. + * @param {string|any} New node text or JSON object + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {void} + */ + insertBefore(newNodeText: string | any, target: string | any): void; + + /** To check the given TreeView node is checked or unchecked. + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {boolean} + */ + isNodeChecked(element: string | any): boolean; + + /** To check whether the child nodes are loaded of the given TreeView node. + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {boolean} + */ + isChildLoaded(element: string | any): boolean; + + /** To check the given TreeView node is disabled or enabled. + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {boolean} + */ + isDisabled(element: string | any): boolean; + + /** To check the given node is exist in TreeView. + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {boolean} + */ + isExist(element: string | any): boolean; + + /** To get the expand status of the given TreeView node. + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {boolean} + */ + isExpanded(element: string | any): boolean; + + /** To get the select status of the given TreeView node. + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {boolean} + */ + isSelected(element: string | any): boolean; + + /** To get the visibility status of the given TreeView node. + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {boolean} + */ + isVisible(element: string | any): boolean; + + /** To load the TreeView nodes from the particular URL. If target tree node is specified, then the given nodes are added as child of target tree node, otherwise nodes are added in TreeView. + * @param {string} URL location, the data returned from the URL will be loaded in TreeView + * @param {string|any} ID of TreeView node/object of TreeView node + * @returns {void} + */ + loadData(URL: string, target: string | any): void; + + /** To move the TreeView node with in same TreeView. The new position of given TreeView node will be based on destination node and index position. + * @param {string|any} ID of TreeView node/object of TreeView node + * @param {string|any} ID of TreeView node/object of TreeView node + * @param {number} New index position of given source node + * @returns {void} + */ + moveNode(sourceNode: string | any, destinationNode: string | any, index: number): void; + + /** To refresh the TreeView + * @returns {void} + */ + refresh(): void; + + /** To remove all the nodes in TreeView. + * @returns {void} + */ + removeAll(): void; + + /** To remove a node in TreeView. + * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes + * @returns {void} + */ + removeNode(element: string | any | any[]): void; + + /** To select all the TreeView nodes when enable allowMultiSelection property. + * @returns {void} + */ + selectAll(): void; + + /** This method is used to select a node in TreeView control. If you want to select the collection of nodes in TreeView control then we need to enable allowMultiSelection property. + * @param {string|any|Array} ID of TreeView node/object of TreeView node/ collection of ID/object of TreeView nodes + * @returns {void} + */ + selectNode(element: string | any | any[]): void; + + /** To show nodes in TreeView. + * @returns {void} + */ + show(): void; + + /** To show a node in TreeView. + * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes + * @returns {void} + */ + showNode(element: string | any | any[]): void; + + /** To uncheck all the nodes in TreeView. + * @returns {void} + */ + unCheckAll(): void; + + /** To uncheck a node in TreeView. + * @param {string|any|Array} ID of TreeView node/object of TreeView node/collection of ID/object of TreeView nodes + * @returns {void} + */ + uncheckNode(element: string | any | any[]): void; + + /** To unselect all the TreeView nodes when enable allowMultiSelection property. + * @returns {void} + */ + unselectAll(): void; + + /** This method is used to unselect a node in TreeView control. If you want to unselect the collection of nodes in TreeView control then we need to enable allowMultiSelection property. + * @param {string|any|Array} ID of TreeView node/object of TreeView node/ collection of ID/object of TreeView nodes + * @returns {void} + */ + unselectNode(element: string | any | any[]): void; + + /** To edit or update the text of the TreeView node. + * @param {string|any} ID of TreeView node/object of TreeView node + * @param {string} New text + * @returns {void} + */ + updateText(target: string | any, newText: string): void; + } + export namespace TreeView { + + export interface Model { + + /** Gets or sets a value that indicates whether to enable drag and drop a node within the same tree. + * @Default {false} + */ + allowDragAndDrop?: boolean; + + /** Gets or sets a value that indicates whether to enable drag and drop a node in inter ej.TreeView. + * @Default {true} + */ + allowDragAndDropAcrossControl?: boolean; + + /** Gets or sets a value that indicates whether to drop a node to a sibling of particular node. + * @Default {true} + */ + allowDropSibling?: boolean; + + /** Gets or sets a value that indicates whether to drop a node to a child of particular node. + * @Default {true} + */ + allowDropChild?: boolean; + + /** Gets or sets a value that indicates whether to enable node editing support for TreeView. + * @Default {false} + */ + allowEditing?: boolean; + + /** Gets or sets a value that indicates whether to enable keyboard support for TreeView actions like nodeSelection, nodeEditing, nodeExpand, nodeCollapse, nodeCut and Paste. + * @Default {true} + */ + allowKeyboardNavigation?: boolean; + + /** Gets or sets a value that indicates whether to enable multi selection support for TreeView. + * @Default {false} + */ + allowMultiSelection?: boolean; + + /** Allow us to specify the parent and child nodes to get auto check while we check or uncheck a node. + * @Default {true} + */ + autoCheck?: boolean; + + /** Allow us to specify the parent node to be retain in checked or unchecked state instead of going for indeterminate state. + * @Default {false} + */ + autoCheckParentNode?: boolean; + + /** Gets or sets a value that indicates the checkedNodes index collection as an array. The given array index position denotes the nodes, that are checked while rendering TreeView. + * @Default {[]} + */ + checkedNodes?: any[]; + + /** Sets the root CSS class for TreeView which allow us to customize the appearance. + */ + cssClass?: string; + + /** Gets or sets a value that indicates whether to enable or disable the animation effect while expanding or collapsing a node. + * @Default {true} + */ + enableAnimation?: boolean; + + /** Gets or sets a value that indicates whether a TreeView can be enabled or disabled. No actions can be performed while this property is set as false + * @Default {true} + */ + enabled?: boolean; + + /** Allow us to prevent multiple nodes to be in expanded state. If it set to false, previously expanded node will be collapsed automatically, while we expand a node. + * @Default {true} + */ + enableMultipleExpand?: boolean; + + /** Sets a value that indicates whether to persist the TreeView model state in page using applicable medium i.e., HTML5 localStorage or cookies + * @Default {false} + */ + enablePersistence?: boolean; + + /** Gets or sets a value that indicates to align content in the TreeView control from right to left by setting the property as true. + * @Default {false} + */ + enableRTL?: boolean; + + /** Gets or sets a array of value that indicates the expandedNodes index collection as an array. The given array index position denotes the nodes, that are expanded while rendering TreeView. + * @Default {[]} + */ + expandedNodes?: any[]; + + /** Gets or sets a value that indicates the TreeView node can be expand or collapse by using the specified action. + * @Default {dblclick} + */ + expandOn?: string; + + /** Gets or sets a fields object that allow us to map the data members with field properties in order to make the data binding easier. + * @Default {null} + */ + fields?: Fields; + + /** Gets or sets a value that indicates whether to enable full row selection support for TreeView. + * @Default {false} + */ + fullRowSelect?: boolean; + + /** Defines the height of the TreeView. + * @Default {Null} + */ + height?: string | number; + + /** Specifies the HTML Attributes for the TreeView. Using this API we can add custom attributes in TreeView control. + * @Default {{}} + */ + htmlAttributes?: any; - /** Specifies the child nodes to be loaded on demand - * @Default {false} - */ - loadOnDemand?: boolean; + /** Specifies the child nodes to be loaded on demand + * @Default {false} + */ + loadOnDemand?: boolean; - /** Gets or Sets a value that indicates the index position of a tree node. The particular index tree node will be selected while rendering the TreeView. - * @Default {-1} - */ - selectedNode?: number; + /** Gets or Sets a value that indicates the index position of a tree node. The particular index tree node will be selected while rendering the TreeView. + * @Default {-1} + */ + selectedNode?: number; - /** Gets or sets a value that indicates the selectedNodes index collection as an array. The given array index position denotes the nodes, that are selected while rendering TreeView. - * @Default {[]} - */ - selectedNodes?: any[]; + /** Gets or sets a value that indicates the selectedNodes index collection as an array. The given array index position denotes the nodes, that are selected while rendering TreeView. + * @Default {[]} + */ + selectedNodes?: any[]; - /** Gets or sets a value that indicates whether to display or hide checkbox for all TreeView nodes. - * @Default {false} - */ - showCheckbox?: boolean; + /** Gets or sets a value that indicates whether to display or hide checkbox for all TreeView nodes. + * @Default {false} + */ + showCheckbox?: boolean; - /** By using sortSettings property, you can customize the sorting option in TreeView control. - */ - sortSettings?: SortSettings; + /** By using sortSettings property, you can customize the sorting option in TreeView control. + */ + sortSettings?: SortSettings; - /** Allow us to use custom template in order to create TreeView. - * @Default {null} - */ - template?: string; + /** Allow us to use custom template in order to create TreeView. + * @Default {null} + */ + template?: string; - /** Defines the width of the TreeView. - * @Default {Null} - */ - width?: string|number; + /** Defines the width of the TreeView. + * @Default {Null} + */ + width?: string | number; - /** Fires before adding node to TreeView. */ - beforeAdd?(e: BeforeAddEventArgs): void; + /** Fires before adding node to TreeView. */ + beforeAdd?(e: BeforeAddEventArgs): void; - /** Fires before collapse a node. */ - beforeCollapse?(e: BeforeCollapseEventArgs): void; + /** Fires before collapse a node. */ + beforeCollapse?(e: BeforeCollapseEventArgs): void; - /** Fires before cut node in TreeView. */ - beforeCut?(e: BeforeCutEventArgs): void; + /** Fires before cut node in TreeView. */ + beforeCut?(e: BeforeCutEventArgs): void; - /** Fires before deleting node in TreeView. */ - beforeDelete?(e: BeforeDeleteEventArgs): void; + /** Fires before deleting node in TreeView. */ + beforeDelete?(e: BeforeDeleteEventArgs): void; - /** Fires before editing the node in TreeView. */ - beforeEdit?(e: BeforeEditEventArgs): void; + /** Fires before editing the node in TreeView. */ + beforeEdit?(e: BeforeEditEventArgs): void; - /** Fires before expanding the node. */ - beforeExpand?(e: BeforeExpandEventArgs): void; + /** Fires before expanding the node. */ + beforeExpand?(e: BeforeExpandEventArgs): void; - /** Fires before loading nodes to TreeView. */ - beforeLoad?(e: BeforeLoadEventArgs): void; + /** Fires before loading nodes to TreeView. */ + beforeLoad?(e: BeforeLoadEventArgs): void; - /** Fires before paste node in TreeView. */ - beforePaste?(e: BeforePasteEventArgs): void; + /** Fires before paste node in TreeView. */ + beforePaste?(e: BeforePasteEventArgs): void; - /** Fires before selecting node in TreeView. */ - beforeSelect?(e: BeforeSelectEventArgs): void; + /** Fires before selecting node in TreeView. */ + beforeSelect?(e: BeforeSelectEventArgs): void; - /** Fires when TreeView created successfully. */ - create?(e: CreateEventArgs): void; + /** Fires when TreeView created successfully. */ + create?(e: CreateEventArgs): void; - /** Fires when TreeView destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; + /** Fires when TreeView destroyed successfully. */ + destroy?(e: DestroyEventArgs): void; - /** Fires before nodeEdit Successful. */ - inlineEditValidation?(e: InlineEditValidationEventArgs): void; + /** Fires before nodeEdit Successful. */ + inlineEditValidation?(e: InlineEditValidationEventArgs): void; - /** Fires when key pressed successfully. */ - keyPress?(e: KeyPressEventArgs): void; + /** Fires when key pressed successfully. */ + keyPress?(e: KeyPressEventArgs): void; - /** Fires when data load fails. */ - loadError?(e: LoadErrorEventArgs): void; + /** Fires when data load fails. */ + loadError?(e: LoadErrorEventArgs): void; - /** Fires when data loaded successfully. */ - loadSuccess?(e: LoadSuccessEventArgs): void; + /** Fires when data loaded successfully. */ + loadSuccess?(e: LoadSuccessEventArgs): void; - /** Fires once node added successfully. */ - nodeAdd?(e: NodeAddEventArgs): void; + /** Fires once node added successfully. */ + nodeAdd?(e: NodeAddEventArgs): void; - /** Fires once node checked successfully. */ - nodeCheck?(e: NodeCheckEventArgs): void; + /** Fires once node checked successfully. */ + nodeCheck?(e: NodeCheckEventArgs): void; - /** Fires when node clicked successfully. */ - nodeClick?(e: NodeClickEventArgs): void; + /** Fires when node clicked successfully. */ + nodeClick?(e: NodeClickEventArgs): void; - /** Fires when node collapsed successfully. */ - nodeCollapse?(e: NodeCollapseEventArgs): void; + /** Fires when node collapsed successfully. */ + nodeCollapse?(e: NodeCollapseEventArgs): void; - /** Fires when node cut successfully. */ - nodeCut?(e: NodeCutEventArgs): void; + /** Fires when node cut successfully. */ + nodeCut?(e: NodeCutEventArgs): void; - /** Fires when node deleted successfully. */ - nodeDelete?(e: NodeDeleteEventArgs): void; + /** Fires when node deleted successfully. */ + nodeDelete?(e: NodeDeleteEventArgs): void; - /** Fires when node dragging. */ - nodeDrag?(e: NodeDragEventArgs): void; + /** Fires when node dragging. */ + nodeDrag?(e: NodeDragEventArgs): void; - /** Fires once node drag start successfully. */ - nodeDragStart?(e: NodeDragStartEventArgs): void; + /** Fires once node drag start successfully. */ + nodeDragStart?(e: NodeDragStartEventArgs): void; - /** Fires before the dragged node to be dropped. */ - nodeDragStop?(e: NodeDragStopEventArgs): void; + /** Fires before the dragged node to be dropped. */ + nodeDragStop?(e: NodeDragStopEventArgs): void; - /** Fires once node dropped successfully. */ - nodeDropped?(e: NodeDroppedEventArgs): void; + /** Fires once node dropped successfully. */ + nodeDropped?(e: NodeDroppedEventArgs): void; - /** Fires once node edited successfully. */ - nodeEdit?(e: NodeEditEventArgs): void; + /** Fires once node edited successfully. */ + nodeEdit?(e: NodeEditEventArgs): void; - /** Fires once node expanded successfully. */ - nodeExpand?(e: NodeExpandEventArgs): void; + /** Fires once node expanded successfully. */ + nodeExpand?(e: NodeExpandEventArgs): void; - /** Fires once node pasted successfully. */ - nodePaste?(e: NodePasteEventArgs): void; + /** Fires once node pasted successfully. */ + nodePaste?(e: NodePasteEventArgs): void; - /** Fires when node selected successfully. */ - nodeSelect?(e: NodeSelectEventArgs): void; + /** Fires when node selected successfully. */ + nodeSelect?(e: NodeSelectEventArgs): void; - /** Fires once node unchecked successfully. */ - nodeUncheck?(e: NodeUncheckEventArgs): void; + /** Fires once node unchecked successfully. */ + nodeUncheck?(e: NodeUncheckEventArgs): void; - /** Fires once node unselected successfully. */ - nodeUnselect?(e: NodeUnselectEventArgs): void; + /** Fires once node unselected successfully. */ + nodeUnselect?(e: NodeUnselectEventArgs): void; - /** Fires when TreeView nodes are loaded successfully */ - ready?(e: ReadyEventArgs): void; -} + /** Fires when TreeView nodes are loaded successfully */ + ready?(e: ReadyEventArgs): void; + } -export interface BeforeAddEventArgs { + export interface BeforeAddEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the given new node data - */ - data?: string|any; + /** returns the given new node data + */ + data?: string | any; - /** returns the parent element, the given new nodes to be appended to the given parent element - */ - targetParent?: any; + /** returns the parent element, the given new nodes to be appended to the given parent element + */ + targetParent?: any; - /** returns the given parent node details - */ - parentDetails?: any; -} + /** returns the given parent node details + */ + parentDetails?: any; + } -export interface BeforeCollapseEventArgs { + export interface BeforeCollapseEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the value of the node - */ - value?: string; + /** returns the value of the node + */ + value?: string; - /** returns the current element of the node clicked - */ - currentElement?: any; + /** returns the current element of the node clicked + */ + currentElement?: any; - /** returns the child nodes are loaded or not - */ - isChildLoaded?: boolean; + /** returns the child nodes are loaded or not + */ + isChildLoaded?: boolean; - /** returns the id of currently clicked node - */ - id?: string; + /** returns the id of currently clicked node + */ + id?: string; - /** returns the parent id of currently clicked node - */ - parentId?: string; + /** returns the parent id of currently clicked node + */ + parentId?: string; - /** returns the format asynchronous or synchronous - */ - async?: boolean; -} + /** returns the format asynchronous or synchronous + */ + async?: boolean; + } -export interface BeforeCutEventArgs { + export interface BeforeCutEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the event object - */ - event?: any; + /** returns the event object + */ + event?: any; - /** returns the target element, the given node to be cut - */ - target?: any; + /** returns the target element, the given node to be cut + */ + target?: any; - /** returns the given target node values - */ - nodeDetails?: any; + /** returns the given target node values + */ + nodeDetails?: any; - /** returns the key pressed key code value - */ - keyCode?: number; -} + /** returns the key pressed key code value + */ + keyCode?: number; + } -export interface BeforeDeleteEventArgs { + export interface BeforeDeleteEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the event object - */ - event?: any; + /** returns the event object + */ + event?: any; - /** returns the target element, the given node to be deleted - */ - target?: any; + /** returns the target element, the given node to be deleted + */ + target?: any; - /** returns the given target node values - */ - nodeDetails?: any; + /** returns the given target node values + */ + nodeDetails?: any; - /** returns the current parent element of the target node - */ - parentElement?: any; + /** returns the current parent element of the target node + */ + parentElement?: any; - /** returns the parent node values - */ - parentDetails?: any; + /** returns the parent node values + */ + parentDetails?: any; - /** returns the currently removed nodes - */ - removedNodes?: any[]; -} + /** returns the currently removed nodes + */ + removedNodes?: any[]; + } -export interface BeforeEditEventArgs { + export interface BeforeEditEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the current element of the node clicked - */ - currentElement?: any; -} + /** returns the current element of the node clicked + */ + currentElement?: any; + } -export interface BeforeExpandEventArgs { + export interface BeforeExpandEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the value of the node - */ - value?: string; + /** returns the value of the node + */ + value?: string; - /** if the child node is ready to expanded state; otherwise, false. - */ - isChildLoaded?: boolean; + /** if the child node is ready to expanded state; otherwise, false. + */ + isChildLoaded?: boolean; - /** returns the current element of the node clicked - */ - currentElement?: any; + /** returns the current element of the node clicked + */ + currentElement?: any; - /** returns the id of currently clicked node - */ - id?: string; + /** returns the id of currently clicked node + */ + id?: string; - /** returns the parent id of currently clicked node - */ - parentId?: string; + /** returns the parent id of currently clicked node + */ + parentId?: string; - /** returns the format asynchronous or synchronous - */ - async?: boolean; -} + /** returns the format asynchronous or synchronous + */ + async?: boolean; + } -export interface BeforeLoadEventArgs { + export interface BeforeLoadEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the AJAX settings object - */ - AjaxOptions?: any; -} + /** returns the AJAX settings object + */ + AjaxOptions?: any; + } -export interface BeforePasteEventArgs { + export interface BeforePasteEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the event object - */ - event?: any; + /** returns the event object + */ + event?: any; - /** returns the target element, the given node to be pasted - */ - target?: any; + /** returns the target element, the given node to be pasted + */ + target?: any; - /** returns the given target node values - */ - nodeDetails?: any; + /** returns the given target node values + */ + nodeDetails?: any; - /** returns the key pressed key code value - */ - keyCode?: number; -} + /** returns the key pressed key code value + */ + keyCode?: number; + } -export interface BeforeSelectEventArgs { + export interface BeforeSelectEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the target element, the given node to be selected - */ - target?: any; + /** returns the target element, the given node to be selected + */ + target?: any; - /** returns the given target node values - */ - nodeDetails?: any; -} + /** returns the given target node values + */ + nodeDetails?: any; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface InlineEditValidationEventArgs { + export interface InlineEditValidationEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the new entered text for the node - */ - newText?: string; + /** returns the new entered text for the node + */ + newText?: string; - /** returns the current node element id - */ - id?: any; + /** returns the current node element id + */ + id?: any; - /** returns the old node text - */ - oldText?: string; -} + /** returns the old node text + */ + oldText?: string; + } -export interface KeyPressEventArgs { + export interface KeyPressEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the event object - */ - event?: any; + /** returns the event object + */ + event?: any; - /** returns the current element of the node clicked - */ - currentElement?: any; + /** returns the current element of the node clicked + */ + currentElement?: any; - /** returns the value of the node - */ - value?: string; + /** returns the value of the node + */ + value?: string; - /** returns node path from root element - */ - path?: string; + /** returns node path from root element + */ + path?: string; - /** returns the key pressed key code value - */ - keyCode?: number; + /** returns the key pressed key code value + */ + keyCode?: number; - /** it returns when the current node is in expanded state; otherwise, false. - */ - isExpanded?: boolean; + /** it returns when the current node is in expanded state; otherwise, false. + */ + isExpanded?: boolean; - /** returns the id of current TreeView node - */ - id?: string; + /** returns the id of current TreeView node + */ + id?: string; - /** returns the parentId of current TreeView node - */ - parentId?: string; -} + /** returns the parentId of current TreeView node + */ + parentId?: string; + } -export interface LoadErrorEventArgs { + export interface LoadErrorEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the AJAX error object - */ - error?: any; -} + /** returns the AJAX error object + */ + error?: any; + } -export interface LoadSuccessEventArgs { + export interface LoadSuccessEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the success data from the URL - */ - data?: any; + /** returns the success data from the URL + */ + data?: any; - /** returns the target parent element, the data returned from the URL to be appended to the given parent element, else in TreeView - */ - targetParent?: any; + /** returns the target parent element, the data returned from the URL to be appended to the given parent element, else in TreeView + */ + targetParent?: any; - /** returns the given parent node details - */ - parentDetails?: any; -} + /** returns the given parent node details + */ + parentDetails?: any; + } -export interface NodeAddEventArgs { + export interface NodeAddEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the added data, that are given initially - */ - data?: any; + /** returns the added data, that are given initially + */ + data?: any; - /** returns the newly added elements - */ - nodes?: any; + /** returns the newly added elements + */ + nodes?: any; - /** returns the target parent element of the added element - */ - parentElement?: any; + /** returns the target parent element of the added element + */ + parentElement?: any; - /** returns the given parent node details - */ - parentDetails?: any; -} + /** returns the given parent node details + */ + parentDetails?: any; + } -export interface NodeCheckEventArgs { + export interface NodeCheckEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the event object - */ - event?: any; + /** returns the event object + */ + event?: any; - /** returns the value of the node - */ - value?: string; + /** returns the value of the node + */ + value?: string; - /** returns the id of the current element of the node clicked - */ - id?: string; + /** returns the id of the current element of the node clicked + */ + id?: string; - /** returns the id of the parent element of current element of the node clicked - */ - parentId?: string; + /** returns the id of the parent element of current element of the node clicked + */ + parentId?: string; - /** returns the current element of the node clicked - */ - currentElement?: any; + /** returns the current element of the node clicked + */ + currentElement?: any; - /** it returns true when the node checkbox is checked; otherwise, false. - */ - isChecked?: boolean; + /** it returns true when the node checkbox is checked; otherwise, false. + */ + isChecked?: boolean; - /** it returns the currently checked node name - */ - currentNode?: any[]; + /** it returns the currently checked node name + */ + currentNode?: any[]; - /** it returns the currently checked and its child node details - */ - currentCheckedNodes?: any[]; -} + /** it returns the currently checked and its child node details + */ + currentCheckedNodes?: any[]; + } -export interface NodeClickEventArgs { + export interface NodeClickEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the event object - */ - event?: any; + /** returns the event object + */ + event?: any; - /** returns the current element of the node clicked - */ - currentElement?: any; + /** returns the current element of the node clicked + */ + currentElement?: any; - /** returns the id of currently clicked TreeView node - */ - id?: string; + /** returns the id of currently clicked TreeView node + */ + id?: string; - /** returns the parentId of currently clicked TreeView node - */ - parentId?: string; -} + /** returns the parentId of currently clicked TreeView node + */ + parentId?: string; + } -export interface NodeCollapseEventArgs { + export interface NodeCollapseEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the id of the current element of the node clicked - */ - id?: string; + /** returns the id of the current element of the node clicked + */ + id?: string; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the id of the parent element of current element of the node clicked - */ - parentId?: string; + /** returns the id of the parent element of current element of the node clicked + */ + parentId?: string; - /** returns the value of the node - */ - value?: string; + /** returns the value of the node + */ + value?: string; - /** returns the current element of the node clicked - */ - currentElement?: any; + /** returns the current element of the node clicked + */ + currentElement?: any; - /** returns the child nodes are loaded or not - */ - isChildLoaded?: boolean; + /** returns the child nodes are loaded or not + */ + isChildLoaded?: boolean; - /** returns the format asynchronous or synchronous - */ - async?: boolean; -} + /** returns the format asynchronous or synchronous + */ + async?: boolean; + } -export interface NodeCutEventArgs { + export interface NodeCutEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the event object - */ - event?: any; + /** returns the event object + */ + event?: any; - /** returns the current parent element of the cut node - */ - parentElement?: any; + /** returns the current parent element of the cut node + */ + parentElement?: any; - /** returns the given parent node details - */ - parentDetails?: any; + /** returns the given parent node details + */ + parentDetails?: any; - /** returns the key pressed key code value - */ - keyCode?: number; -} + /** returns the key pressed key code value + */ + keyCode?: number; + } -export interface NodeDeleteEventArgs { + export interface NodeDeleteEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the event object - */ - event?: any; + /** returns the event object + */ + event?: any; - /** returns the current parent element of the deleted node - */ - parentElement?: any; + /** returns the current parent element of the deleted node + */ + parentElement?: any; - /** returns the given parent node details - */ - parentDetails?: any; + /** returns the given parent node details + */ + parentDetails?: any; - /** returns the currently removed nodes - */ - removedNodes?: any[]; -} + /** returns the currently removed nodes + */ + removedNodes?: any[]; + } -export interface NodeDragEventArgs { + export interface NodeDragEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the original drag target - */ - dragTarget?: any; + /** returns the original drag target + */ + dragTarget?: any; - /** returns the current target TreeView node - */ - target?: any; + /** returns the current target TreeView node + */ + target?: any; - /** returns the current target details - */ - targetElementData?: any; + /** returns the current target details + */ + targetElementData?: any; - /** returns the current parent element of the target node - */ - draggedElement?: any; + /** returns the current parent element of the target node + */ + draggedElement?: any; - /** returns the given parent node details - */ - draggedElementData?: any; + /** returns the given parent node details + */ + draggedElementData?: any; - /** returns the event object - */ - event?: any; -} + /** returns the event object + */ + event?: any; + } -export interface NodeDragStartEventArgs { + export interface NodeDragStartEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the original drag target - */ - dragTarget?: any; + /** returns the original drag target + */ + dragTarget?: any; - /** returns the current dragging parent TreeView node - */ - parentElement?: any; + /** returns the current dragging parent TreeView node + */ + parentElement?: any; - /** returns the current dragging parent TreeView node details - */ - parentElementData?: any; + /** returns the current dragging parent TreeView node details + */ + parentElementData?: any; - /** returns the current parent element of the dragging node - */ - target?: any; + /** returns the current parent element of the dragging node + */ + target?: any; - /** returns the given parent node details - */ - targetElementData?: any; + /** returns the given parent node details + */ + targetElementData?: any; - /** returns the event object - */ - event?: any; -} + /** returns the event object + */ + event?: any; + } -export interface NodeDragStopEventArgs { + export interface NodeDragStopEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the original drop target - */ - dropTarget?: any; + /** returns the original drop target + */ + dropTarget?: any; - /** returns the current dragged TreeView node - */ - draggedElement?: any; + /** returns the current dragged TreeView node + */ + draggedElement?: any; - /** returns the current dragged TreeView node details - */ - draggedElementData?: any; + /** returns the current dragged TreeView node details + */ + draggedElementData?: any; - /** returns the current parent element of the dragged node - */ - target?: any; + /** returns the current parent element of the dragged node + */ + target?: any; - /** returns the given parent node details - */ - targetElementData?: any; + /** returns the given parent node details + */ + targetElementData?: any; - /** returns the drop position such as before, after or over - */ - position?: string; + /** returns the drop position such as before, after or over + */ + position?: string; - /** returns the event object - */ - event?: any; -} + /** returns the event object + */ + event?: any; + } -export interface NodeDroppedEventArgs { + export interface NodeDroppedEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the original drop target - */ - dropTarget?: any; + /** returns the original drop target + */ + dropTarget?: any; - /** returns the current dropped TreeView node - */ - droppedElement?: any; + /** returns the current dropped TreeView node + */ + droppedElement?: any; - /** returns the current dropped TreeView node details - */ - droppedElementData?: any; + /** returns the current dropped TreeView node details + */ + droppedElementData?: any; - /** returns the current parent element of the dropped node - */ - target?: any; + /** returns the current parent element of the dropped node + */ + target?: any; - /** returns the given parent node details - */ - targetElementData?: any; + /** returns the given parent node details + */ + targetElementData?: any; - /** returns the drop position such as before, after or over - */ - position?: string; + /** returns the drop position such as before, after or over + */ + position?: string; - /** returns the event object - */ - event?: any; -} + /** returns the event object + */ + event?: any; + } -export interface NodeEditEventArgs { + export interface NodeEditEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the id of the element - */ - id?: string; + /** returns the id of the element + */ + id?: string; - /** returns the oldText of the element - */ - oldText?: string; + /** returns the oldText of the element + */ + oldText?: string; - /** returns the newText of the element - */ - newText?: string; + /** returns the newText of the element + */ + newText?: string; - /** returns the event object - */ - event?: any; + /** returns the event object + */ + event?: any; - /** returns the target element, the given node to be cut - */ - target?: any; + /** returns the target element, the given node to be cut + */ + target?: any; - /** returns the given target node values - */ - nodeDetails?: any; -} + /** returns the given target node values + */ + nodeDetails?: any; + } -export interface NodeExpandEventArgs { + export interface NodeExpandEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the value of the node - */ - value?: string; + /** returns the value of the node + */ + value?: string; - /** if the child node is ready to expanded state; otherwise, false. - */ - isChildLoaded?: boolean; + /** if the child node is ready to expanded state; otherwise, false. + */ + isChildLoaded?: boolean; - /** returns the current element of the node clicked - */ - currentElement?: any; + /** returns the current element of the node clicked + */ + currentElement?: any; - /** returns the id of currently clicked node - */ - id?: string; + /** returns the id of currently clicked node + */ + id?: string; - /** returns the parent id of currently clicked node - */ - parentId?: string; + /** returns the parent id of currently clicked node + */ + parentId?: string; - /** returns the format asynchronous or synchronous - */ - async?: boolean; -} + /** returns the format asynchronous or synchronous + */ + async?: boolean; + } -export interface NodePasteEventArgs { + export interface NodePasteEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the event object - */ - event?: any; + /** returns the event object + */ + event?: any; - /** returns the pasted element - */ - target?: any; + /** returns the pasted element + */ + target?: any; - /** returns the given target node values - */ - nodeDetails?: any; + /** returns the given target node values + */ + nodeDetails?: any; - /** returns the key pressed key code value - */ - keyCode?: number; -} + /** returns the key pressed key code value + */ + keyCode?: number; + } -export interface NodeSelectEventArgs { + export interface NodeSelectEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the id of the current element of the node clicked - */ - id?: any; + /** returns the id of the current element of the node clicked + */ + id?: any; - /** returns the id of the parent element of current element of the node clicked - */ - parentId?: any; + /** returns the id of the parent element of current element of the node clicked + */ + parentId?: any; - /** returns the current selected nodes index of TreeView - */ - selectedNodes?: any[]; + /** returns the current selected nodes index of TreeView + */ + selectedNodes?: any[]; - /** returns the value of the node - */ - value?: string; + /** returns the value of the node + */ + value?: string; - /** returns the current element of the node clicked - */ - currentElement?: any; -} + /** returns the current element of the node clicked + */ + currentElement?: any; + } -export interface NodeUncheckEventArgs { + export interface NodeUncheckEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the event object - */ - event?: any; + /** returns the event object + */ + event?: any; - /** returns the id of the current element of the node clicked - */ - id?: any; + /** returns the id of the current element of the node clicked + */ + id?: any; - /** returns the id of the parent element of current element of the node clicked - */ - parentId?: any; + /** returns the id of the parent element of current element of the node clicked + */ + parentId?: any; - /** returns the value of the node - */ - value?: string; + /** returns the value of the node + */ + value?: string; - /** returns the current element of the node clicked - */ - currentElement?: any; + /** returns the current element of the node clicked + */ + currentElement?: any; - /** it returns true when the node checkbox is checked; otherwise, false. - */ - isChecked?: boolean; + /** it returns true when the node checkbox is checked; otherwise, false. + */ + isChecked?: boolean; - /** it returns currently unchecked node name - */ - currentNode?: string; + /** it returns currently unchecked node name + */ + currentNode?: string; - /** it returns currently unchecked node and its child node details. - */ - currentUncheckedNodes?: any[]; -} + /** it returns currently unchecked node and its child node details. + */ + currentUncheckedNodes?: any[]; + } -export interface NodeUnselectEventArgs { + export interface NodeUnselectEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the current element of the node unselected - */ - currentElement?: any; + /** returns the current element of the node unselected + */ + currentElement?: any; - /** returns the id of the current element of the node unselected - */ - id?: string; + /** returns the id of the current element of the node unselected + */ + id?: string; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the id of the parent element of current element of the node unselected - */ - parentId?: string; + /** returns the id of the parent element of current element of the node unselected + */ + parentId?: string; - /** returns the current selected nodes index of TreeView - */ - selectedNodes?: any[]; + /** returns the current selected nodes index of TreeView + */ + selectedNodes?: any[]; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the value of the node - */ - value?: string; -} - -export interface ReadyEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the TreeView model - */ - model?: ej.TreeView.Model; - - /** returns the name of the event - */ - type?: string; -} - -export interface Fields { - - /** It receives the child level or inner level data source such as Essential DataManager object and JSON object. - */ - child?: any; - - /** It receives Essential DataManager object and JSON object. - */ - dataSource?: any; - - /** Specifies the node to be in expanded state. - */ - expanded?: string; - - /** Its allow us to indicate whether the node has child or not in load on demand - */ - hasChild?: string; - - /** Specifies the HTML Attributes to "li" item list. - */ - htmlAttribute?: any; - - /** Specifies the id to TreeView node items list. - */ - id?: string; - - /** Specifies the image attribute to Ă¢â‚¬Å“imgĂ¢â‚¬Â tag inside items list - */ - imageAttribute?: any; - - /** Specifies the HTML Attributes to "li" item list. - */ - imageUrl?: string; - - /** If its true Checkbox node will be checked when rendered with checkbox. - */ - isChecked?: string; - - /** Specifies the link attribute to Ă¢â‚¬Å“aĂ¢â‚¬Â tag in item list. - */ - linkAttribute?: any; - - /** Specifies the parent id of the node. The nodes are listed as child nodes of the specified parent node by using its parent id. - */ - parentId?: string; - - /** It receives query to retrieve data from the table (query is same as SQL). - */ - query?: any; - - /** Allow us to specify the node to be in selected state - */ - selected?: string; - - /** Specifies the sprite CSS class to "li" item list. - */ - spriteCssClass?: string; - - /** It receives the table name to execute query on the corresponding table. - */ - tableName?: string; - - /** Specifies the text of TreeView node items list. - */ - text?: string; -} - -export interface SortSettings { - - /** Enables or disables the sorting option in TreeView control - * @Default {false} - */ - allowSorting?: boolean; - - /** Sets the sorting order type. There are two sorting types available, such as "ascending", "descending". - * @Default {ej.sortOrder.Ascending} - */ - sortOrder?: ej.sortOrder|string; -} -} -enum sortOrder { -//Enum for Ascending sort order -Ascending, -//Enum for Descending sort order -Descending, -} - -class Uploadbox extends ej.Widget { - static fn: Uploadbox; - constructor(element: JQuery | Element, options?: Uploadbox.Model); - static Locale: any; - model: Uploadbox.Model; - defaults: Uploadbox.Model; - - /** The destroy method destroys the control and brings the control to a pre-init state. All the events of the Upload control is bound by using this._on unbinds automatically. - * @returns {void} - */ - destroy(): void; - - /** Disables the Uploadbox control - * @returns {void} - */ - disable(): void; - - /** Enables the Uploadbox control - * @returns {void} - */ - enable(): void; - - /** Refresh the Uploadbox control - * @returns {void} - */ - refresh(): void; -} -export namespace Uploadbox { - -export interface Model { - - /** Enables the file drag and drop support to the Uploadbox control. - * @Default {false} - */ - allowDragAndDrop?: boolean; - - /** Uploadbox supports both synchronous and asynchronous upload. This can be achieved by using the asyncUpload property. - * @Default {true} - */ - asyncUpload?: boolean; - - /** Uploadbox supports auto uploading of files after the file selection is done. - * @Default {false} - */ - autoUpload?: boolean; - - /** Sets the text for each action button. - * @Default {{browse: Browse, upload: Upload, cancel: Cancel, close: Close}} - */ - buttonText?: ButtonText; - - /** Sets the root class for the Uploadbox control theme. This cssClass API helps to use custom skinning option for the Uploadbox button and dialog content. - */ - cssClass?: string; - - /** Specifies the custom file details in the dialog popup on initialization. - * @Default {{ title:true, name:true, size:true, status:true, action:true}} - */ - customFileDetails?: CustomFileDetails; - - /** Specifies the actions for dialog popup while initialization. - * @Default {{ modal:false, closeOnComplete:false, content:null, drag:true}} - */ - dialogAction?: DialogAction; - - /** Displays the Uploadbox dialog at the given X and Y positions. X: Dialog sets the left position value. Y: Dialog sets the top position value. - * @Default {null} - */ - dialogPosition?: any; - - /** Property for applying the text to the Dialog title and content headers. - * @Default {{ title: Upload Box, name: Name, size: Size, status: Status}} - */ - dialogText?: DialogText; - - /** The dropAreaText is displayed when the drag and drop support is enabled in the Uploadbox control. - * @Default {Drop files or click to upload} - */ - dropAreaText?: string; - - /** Specifies the dropAreaHeight when the drag and drop support is enabled in the Uploadbox control. - * @Default {100%} - */ - dropAreaHeight?: number|string; - - /** Specifies the dropAreaWidth when the drag and drop support is enabled in the Uploadbox control. - * @Default {100%} - */ - dropAreaWidth?: number|string; - - /** Based on the property value, Uploadbox is enabled or disabled. - * @Default {true} - */ - enabled?: boolean; - - /** Sets the right-to-left direction property for the Uploadbox control. - * @Default {false} - */ - enableRTL?: boolean; - - /** Only the files with the specified extension is allowed to upload. This is mentioned in the string format. - */ - extensionsAllow?: string; - - /** Only the files with the specified extension is denied for upload. This is mentioned in the string format. - */ - extensionsDeny?: string; - - /** Sets the maximum size limit for uploading the file. This is mentioned in the number format. - * @Default {31457280} - */ - fileSize?: number; - - /** Sets the height of the browse button. - * @Default {35px} - */ - height?: string; - - /** Specifies the list of HTML attributes to be added to uploadbox control. - * @Default {{}} - */ - htmlAttributes?: any; - - /** Configures the culture data and sets the culture to the Uploadbox. - * @Default {en-US} - */ - locale?: string; - - /** Enables multiple file selection for upload. - * @Default {true} - */ - multipleFilesSelection?: boolean; - - /** You can push the file to the Uploadbox in the client-side of the XHR supported browsers alone. - * @Default {null} - */ - pushFile?: any; - - /** Specifies the remove action to be performed after the file uploading is completed. Here, mention the server address for removal. - */ - removeUrl?: string; - - /** Specifies the save action to be performed after the file is pushed for uploading. Here, mention the server address to be saved. - */ - saveUrl?: string; - - /** Enables the browse button support to the Uploadbox control. - * @Default {true} - */ - showBrowseButton?: boolean; - - /** Specifies the file details to be displayed when selected for uploading. This can be done when the showFileDetails is set to true. - * @Default {true} - */ - showFileDetails?: boolean; - - /** Specifies the file details to be displayed when selected for uploading. This can be done when the showFileDetails is set to true. - * @Default {true} - */ - showRoundedCorner?: boolean; - - /** Sets the name for the Uploadbox control. This API helps to Map the action in code behind to retrieve the files. - */ - uploadName?: string; + /** returns the value of the node + */ + value?: string; + } + + export interface ReadyEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the TreeView model + */ + model?: ej.TreeView.Model; + + /** returns the name of the event + */ + type?: string; + } + + export interface Fields { + + /** It receives the child level or inner level data source such as Essential DataManager object and JSON object. + */ + child?: any; + + /** It receives Essential DataManager object and JSON object. + */ + dataSource?: any; + + /** Specifies the node to be in expanded state. + */ + expanded?: string; + + /** Its allow us to indicate whether the node has child or not in load on demand + */ + hasChild?: string; + + /** Specifies the HTML Attributes to "li" item list. + */ + htmlAttribute?: any; + + /** Specifies the id to TreeView node items list. + */ + id?: string; + + /** Specifies the image attribute to Ă¢â‚¬Å“imgĂ¢â‚¬Â tag inside items list + */ + imageAttribute?: any; + + /** Specifies the HTML Attributes to "li" item list. + */ + imageUrl?: string; + + /** If its true Checkbox node will be checked when rendered with checkbox. + */ + isChecked?: string; + + /** Specifies the link attribute to Ă¢â‚¬Å“aĂ¢â‚¬Â tag in item list. + */ + linkAttribute?: any; + + /** Specifies the parent id of the node. The nodes are listed as child nodes of the specified parent node by using its parent id. + */ + parentId?: string; + + /** It receives query to retrieve data from the table (query is same as SQL). + */ + query?: any; + + /** Allow us to specify the node to be in selected state + */ + selected?: string; + + /** Specifies the sprite CSS class to "li" item list. + */ + spriteCssClass?: string; + + /** It receives the table name to execute query on the corresponding table. + */ + tableName?: string; + + /** Specifies the text of TreeView node items list. + */ + text?: string; + } + + export interface SortSettings { + + /** Enables or disables the sorting option in TreeView control + * @Default {false} + */ + allowSorting?: boolean; + + /** Sets the sorting order type. There are two sorting types available, such as "ascending", "descending". + * @Default {ej.sortOrder.Ascending} + */ + sortOrder?: ej.sortOrder | string; + } + } + enum sortOrder { + //Enum for Ascending sort order + Ascending, + //Enum for Descending sort order + Descending, + } + + class Uploadbox extends ej.Widget { + static fn: Uploadbox; + constructor(element: JQuery | Element, options?: Uploadbox.Model); + static Locale: any; + model: Uploadbox.Model; + defaults: Uploadbox.Model; + + /** The destroy method destroys the control and brings the control to a pre-init state. All the events of the Upload control is bound by using this._on unbinds automatically. + * @returns {void} + */ + destroy(): void; + + /** Disables the Uploadbox control + * @returns {void} + */ + disable(): void; + + /** Enables the Uploadbox control + * @returns {void} + */ + enable(): void; + + /** Refresh the Uploadbox control + * @returns {void} + */ + refresh(): void; + } + export namespace Uploadbox { + + export interface Model { + + /** Enables the file drag and drop support to the Uploadbox control. + * @Default {false} + */ + allowDragAndDrop?: boolean; + + /** Uploadbox supports both synchronous and asynchronous upload. This can be achieved by using the asyncUpload property. + * @Default {true} + */ + asyncUpload?: boolean; + + /** Uploadbox supports auto uploading of files after the file selection is done. + * @Default {false} + */ + autoUpload?: boolean; + + /** Sets the text for each action button. + * @Default {{browse: Browse, upload: Upload, cancel: Cancel, close: Close}} + */ + buttonText?: ButtonText; + + /** Sets the root class for the Uploadbox control theme. This cssClass API helps to use custom skinning option for the Uploadbox button and dialog content. + */ + cssClass?: string; + + /** Specifies the custom file details in the dialog popup on initialization. + * @Default {{ title:true, name:true, size:true, status:true, action:true}} + */ + customFileDetails?: CustomFileDetails; + + /** Specifies the actions for dialog popup while initialization. + * @Default {{ modal:false, closeOnComplete:false, content:null, drag:true}} + */ + dialogAction?: DialogAction; + + /** Displays the Uploadbox dialog at the given X and Y positions. X: Dialog sets the left position value. Y: Dialog sets the top position value. + * @Default {null} + */ + dialogPosition?: any; + + /** Property for applying the text to the Dialog title and content headers. + * @Default {{ title: Upload Box, name: Name, size: Size, status: Status}} + */ + dialogText?: DialogText; + + /** The dropAreaText is displayed when the drag and drop support is enabled in the Uploadbox control. + * @Default {Drop files or click to upload} + */ + dropAreaText?: string; + + /** Specifies the dropAreaHeight when the drag and drop support is enabled in the Uploadbox control. + * @Default {100%} + */ + dropAreaHeight?: number | string; + + /** Specifies the dropAreaWidth when the drag and drop support is enabled in the Uploadbox control. + * @Default {100%} + */ + dropAreaWidth?: number | string; + + /** Based on the property value, Uploadbox is enabled or disabled. + * @Default {true} + */ + enabled?: boolean; + + /** Sets the right-to-left direction property for the Uploadbox control. + * @Default {false} + */ + enableRTL?: boolean; + + /** Only the files with the specified extension is allowed to upload. This is mentioned in the string format. + */ + extensionsAllow?: string; + + /** Only the files with the specified extension is denied for upload. This is mentioned in the string format. + */ + extensionsDeny?: string; + + /** Sets the maximum size limit for uploading the file. This is mentioned in the number format. + * @Default {31457280} + */ + fileSize?: number; + + /** Sets the height of the browse button. + * @Default {35px} + */ + height?: string; + + /** Specifies the list of HTML attributes to be added to uploadbox control. + * @Default {{}} + */ + htmlAttributes?: any; + + /** Configures the culture data and sets the culture to the Uploadbox. + * @Default {en-US} + */ + locale?: string; + + /** Enables multiple file selection for upload. + * @Default {true} + */ + multipleFilesSelection?: boolean; + + /** You can push the file to the Uploadbox in the client-side of the XHR supported browsers alone. + * @Default {null} + */ + pushFile?: any; + + /** Specifies the remove action to be performed after the file uploading is completed. Here, mention the server address for removal. + */ + removeUrl?: string; + + /** Specifies the save action to be performed after the file is pushed for uploading. Here, mention the server address to be saved. + */ + saveUrl?: string; + + /** Enables the browse button support to the Uploadbox control. + * @Default {true} + */ + showBrowseButton?: boolean; + + /** Specifies the file details to be displayed when selected for uploading. This can be done when the showFileDetails is set to true. + * @Default {true} + */ + showFileDetails?: boolean; + + /** Specifies the file details to be displayed when selected for uploading. This can be done when the showFileDetails is set to true. + * @Default {true} + */ + showRoundedCorner?: boolean; + + /** Sets the name for the Uploadbox control. This API helps to Map the action in code behind to retrieve the files. + */ + uploadName?: string; - /** Sets the width of the browse button. - * @Default {100px} - */ - width?: string; + /** Sets the width of the browse button. + * @Default {100px} + */ + width?: string; - /** Fires when the upload progress beforeSend. */ - beforeSend?(e: BeforeSendEventArgs): void; + /** Fires when the upload progress beforeSend. */ + beforeSend?(e: BeforeSendEventArgs): void; - /** Fires when the upload progress begins. */ - begin?(e: BeginEventArgs): void; + /** Fires when the upload progress begins. */ + begin?(e: BeginEventArgs): void; - /** Fires when the upload progress is cancelled. */ - cancel?(e: CancelEventArgs): void; + /** Fires when the upload progress is cancelled. */ + cancel?(e: CancelEventArgs): void; - /** Fires when the file upload progress is completed. */ - complete?(e: CompleteEventArgs): void; + /** Fires when the file upload progress is completed. */ + complete?(e: CompleteEventArgs): void; - /** Fires when the file upload progress is succeeded. */ - success?(e: SuccessEventArgs): void; + /** Fires when the file upload progress is succeeded. */ + success?(e: SuccessEventArgs): void; - /** Fires when the Uploadbox control is created. */ - create?(e: CreateEventArgs): void; + /** Fires when the Uploadbox control is created. */ + create?(e: CreateEventArgs): void; - /** Fires when the Uploadbox control is destroyed. */ - destroy?(e: DestroyEventArgs): void; + /** Fires when the Uploadbox control is destroyed. */ + destroy?(e: DestroyEventArgs): void; - /** Fires when the Upload process ends in Error. */ - error?(e: ErrorEventArgs): void; + /** Fires when the Upload process ends in Error. */ + error?(e: ErrorEventArgs): void; - /** Fires when the file is selected for upload successfully. */ - fileSelect?(e: FileSelectEventArgs): void; + /** Fires when the file is selected for upload successfully. */ + fileSelect?(e: FileSelectEventArgs): void; - /** Fires when the file is uploading. */ - inProgress?(e: InProgressEventArgs): void; + /** Fires when the file is uploading. */ + inProgress?(e: InProgressEventArgs): void; - /** Fires when the uploaded file is removed successfully. */ - remove?(e: RemoveEventArgs): void; -} + /** Fires when the uploaded file is removed successfully. */ + remove?(e: RemoveEventArgs): void; + } -export interface BeforeSendEventArgs { + export interface BeforeSendEventArgs { - /** Selected FileList Object. - */ - files?: any; + /** Selected FileList Object. + */ + files?: any; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the Uploadbox model - */ - model?: any; + /** returns the Uploadbox model + */ + model?: any; - /** XHR-AJAX Object for reference. - */ - xhr?: any; + /** XHR-AJAX Object for reference. + */ + xhr?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface BeginEventArgs { + export interface BeginEventArgs { - /** To pass additional information to the server. - */ - data?: any; + /** To pass additional information to the server. + */ + data?: any; - /** Selected FileList Object. - */ - files?: any; + /** Selected FileList Object. + */ + files?: any; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the Uploadbox model - */ - model?: any; + /** returns the Uploadbox model + */ + model?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface CancelEventArgs { + export interface CancelEventArgs { - /** Canceled FileList Object. - */ - fileStatus?: any; + /** Canceled FileList Object. + */ + fileStatus?: any; - /** returns the Uploadbox model - */ - model?: any; + /** returns the Uploadbox model + */ + model?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface CompleteEventArgs { + export interface CompleteEventArgs { - /** AJAX event argument for reference. - */ - e?: any; + /** AJAX event argument for reference. + */ + e?: any; - /** Uploaded file list. - */ - files?: any; + /** Uploaded file list. + */ + files?: any; - /** response from the server. - */ - responseText?: string; + /** response from the server. + */ + responseText?: string; - /** XHR-AJAX Object for reference. - */ - xhr?: any; + /** XHR-AJAX Object for reference. + */ + xhr?: any; - /** returns the Uploadbox model - */ - model?: any; + /** returns the Uploadbox model + */ + model?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface SuccessEventArgs { + export interface SuccessEventArgs { - /** response from the server. - */ - responseText?: string; + /** response from the server. + */ + responseText?: string; - /** AJAX event argument for reference. - */ - e?: any; + /** AJAX event argument for reference. + */ + e?: any; - /** successfully uploaded files list. - */ - success?: any; + /** successfully uploaded files list. + */ + success?: any; - /** Uploaded file list. - */ - files?: any; + /** Uploaded file list. + */ + files?: any; - /** XHR-AJAX Object for reference. - */ - xhr?: any; + /** XHR-AJAX Object for reference. + */ + xhr?: any; - /** returns the Uploadbox model - */ - model?: any; + /** returns the Uploadbox model + */ + model?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** returns the Uploadbox model - */ - model?: any; + /** returns the Uploadbox model + */ + model?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** returns the Uploadbox model - */ - model?: any; + /** returns the Uploadbox model + */ + model?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface ErrorEventArgs { + export interface ErrorEventArgs { - /** details about the error information. - */ - error?: string; + /** details about the error information. + */ + error?: string; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** error event action details. - */ - action?: string; + /** error event action details. + */ + action?: string; - /** returns the file details of the file uploaded - */ - files?: any; -} + /** returns the file details of the file uploaded + */ + files?: any; + } -export interface FileSelectEventArgs { + export interface FileSelectEventArgs { - /** returns Selected FileList objects - */ - files?: any; + /** returns Selected FileList objects + */ + files?: any; - /** returns the Uploadbox model - */ - model?: any; + /** returns the Uploadbox model + */ + model?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface InProgressEventArgs { + export interface InProgressEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** AJAX event argument for reference. - */ - e?: any; + /** AJAX event argument for reference. + */ + e?: any; - /** returns Selected FileList objects - */ - files?: any; + /** returns Selected FileList objects + */ + files?: any; - /** returns the Uploadbox model - */ - model?: any; + /** returns the Uploadbox model + */ + model?: any; - /** returns the current progress percentage. - */ - percentage?: any; + /** returns the current progress percentage. + */ + percentage?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface RemoveEventArgs { + export interface RemoveEventArgs { - /** returns the Uploadbox model - */ - model?: any; + /** returns the Uploadbox model + */ + model?: any; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the file details of the file object - */ - fileStatus?: any; -} + /** returns the file details of the file object + */ + fileStatus?: any; + } -export interface ButtonText { + export interface ButtonText { - /** Sets the text for the browse button. - */ - browse?: string; + /** Sets the text for the browse button. + */ + browse?: string; - /** Sets the text for the cancel button. - */ - cancel?: string; + /** Sets the text for the cancel button. + */ + cancel?: string; - /** Sets the text for the close button. - */ - Close?: string; + /** Sets the text for the close button. + */ + Close?: string; - /** Sets the text for the Upload button inside the dialog popup. - */ - upload?: string; -} + /** Sets the text for the Upload button inside the dialog popup. + */ + upload?: string; + } -export interface CustomFileDetails { - - /** Enables the file upload interactions like remove/cancel in File details of the dialog popup. - */ - action?: boolean; - - /** Enables the name in the File details of the dialog popup. - */ - name?: boolean; - - /** Enables or disables the File size details of the dialog popup. - */ - size?: boolean; - - /** Enables or disables the file uploading status visibility in the dialog file details content. - */ - status?: boolean; - - /** Enables the title in File details for the dialog popup. - */ - title?: boolean; -} - -export interface DialogAction { - - /** Once uploaded successfully, the dialog popup closes immediately. - */ - closeOnComplete?: boolean; - - /** Sets the content container option to the Uploadbox dialog popup. - */ - content?: string; - - /** Enables the drag option to the dialog popup. - */ - drag?: boolean; - - /** Enables or disables the Uploadbox dialogĂ¢â‚¬â„¢s modal property to the dialog popup. - */ - modal?: boolean; -} - -export interface DialogText { - - /** Sets the uploaded fileĂ¢â‚¬â„¢s Name (header text) to the Dialog popup. - */ - name?: string; - - /** Sets the upload file Size (header text) to the dialog popup. - */ - size?: string; - - /** Sets the upload file Status (header text) to the dialog popup. - */ - status?: string; - - /** Sets the title text of the dialog popup. - */ - title?: string; -} -} - -class WaitingPopup extends ej.Widget { - static fn: WaitingPopup; - constructor(element: JQuery | Element, options?: WaitingPopup.Model); - static Locale: any; - model: WaitingPopup.Model; - defaults: WaitingPopup.Model; - - /** To hide the waiting popup - * @returns {void} - */ - hide(): void; - - /** Refreshes the WaitingPopup control by resetting the pop-up panel position and content position - * @returns {void} - */ - refresh(): void; - - /** To show the waiting popup - * @returns {void} - */ - show(): void; -} -export namespace WaitingPopup { - -export interface Model { - - /** Sets the root class for the WaitingPopup control theme - * @Default {null} - */ - cssClass?: string; - - /** Specifies the list of HTML attributes to be added to waitingpopup control. - * @Default {{}} - */ - htmlAttributes?: any; - - /** Enables or disables the default loading icon. - * @Default {true} - */ - showImage?: boolean; - - /** Enables the visibility of the WaitingPopup control - * @Default {false} - */ - showOnInit?: boolean; - - /** Specified a selector for elements, within the container. - * @Default {null} - */ - target?: string; - - /** Waitingpopup element append to given container element. - * @Default {null} - */ - appendTo?: string; - - /** Loads HTML content inside the popup panel instead of the default icon - * @Default {null} - */ - template?: any; - - /** Sets the custom text in the pop-up panel to notify the waiting process - * @Default {null} - */ - text?: string; - - /** Fires after Create WaitingPopup successfully */ - create?(e: CreateEventArgs): void; - - /** Fires after Destroy WaitingPopup successfully */ - destroy?(e: DestroyEventArgs): void; -} - -export interface CreateEventArgs { - - /** returns the cancel option value - */ - cancel?: boolean; - - /** returns the WaitingPopup model - */ - model?: ej.WaitingPopup.Model; - - /** returns the name of the event - */ - type?: string; -} - -export interface DestroyEventArgs { - - /** returns the cancel option value - */ - cancel?: boolean; - - /** returns the WaitingPopup model - */ - model?: ej.WaitingPopup.Model; - - /** returns the name of the event - */ - type?: string; -} -} - -class Grid extends ej.Widget { - static fn: Grid; - constructor(element: JQuery | Element, options?: Grid.Model); - static Locale: any; - model: Grid.Model; - defaults: Grid.Model; - - /** Adds a grid model property which is to be ignored upon exporting. - * @param {Array} Pass the array of parameters which need to be ignored on exporting - * @returns {void} - */ - addIgnoreOnExport(propertyNames: any[]): void; - - /** Add a new record in grid control when allowAdding is set as true. - * @returns {void} - */ - //addRecord(): void; - - /** Add a new record in grid control when allowAdding is set as true. - * @param {Array} Pass the array of added Records - * @param {Array} optionalIf we pass serverChange as true, send post to server side for server action. - * @returns {void} - */ - addRecord(data: any[], serverChange?: any[]): void; - - /** Cancel the modified changes in grid control when edit mode is "batch". - * @returns {void} - */ - batchCancel(): void; - - /** Save the modified changes to data source in grid control when edit mode is "batch". - * @returns {void} - */ - batchSave(): void; - - /** Send a cancel request in grid. - * @returns {void} - */ - cancelEdit(): void; - - /** Send a cancel request to the edited cell in grid. - * @returns {void} - */ - cancelEditCell(): void; - - /** It is used to clear all the cell selection. - * @returns {Boolean} - */ - clearCellSelection(): boolean; - - /** It is used to clear specified cell selection based on the rowIndex and columnIndex provided. - * @param {number} It is used to pass the row index of the cell - * @param {number} It is used to pass the column index of the cell. - * @returns {Boolean} - */ - clearCellSelection(rowIndex: number, columnIndex: number): boolean; - - /** It is used to clear all the row selection or at specific row selection based on the index provided. - * @param {number} optional If index of the column is specified then it will remove the selection from the particular column else it will clears all of the column selection - * @returns {Boolean} - */ - clearColumnSelection(index?: number): boolean; - - /** It is used to clear all the filtering done. - * @param {string} If field of the column is specified then it will clear the particular filtering column - * @returns {void} - */ - clearFiltering(field: string): void; - - /** Clear the searching from the grid - * @returns {void} - */ - clearSearching(): void; - - /** Clear all the row selection or at specific row selection based on the index provided - * @param {number} optional If index of the row is specified then it will remove the selection from the particular row else it will clears all of the row selection - * @returns {Boolean} - */ - clearSelection(index?: number): boolean; - - /** Clear the sorting from columns in the grid - * @returns {void} - */ - clearSorting(): void; - - /** Collapse all the group caption rows in grid - * @returns {void} - */ - collapseAll(): void; - - /** Collapse the group drop area in grid - * @returns {void} - */ - collapseGroupDropArea(): void; - - /** Add or remove columns in grid column collections - * @param {Array|string} Pass array of columns or string of field name to add/remove the column in grid - * @param {string} optional Pass add/remove action to be performed. By default "add" action will perform - * @returns {void} - */ - columns(columnDetails: any[]|string, action?: string): void; - - /** Refresh the grid with new data source - * @param {Array} Pass new data source to the grid - * @param {boolean} optional When templateRefresh is set true, both header and contents get refreshed - * @returns {void} - */ - dataSource(datasource: any[], templateRefresh?: boolean): void; - - /** Delete a record in grid control when allowDeleting is set as true - * @param {string} Pass the primary key field Name of the column - * @param {Array} Pass the JSON data of record need to be delete. - * @returns {void} - */ - deleteRecord(fieldName: string, data: any[]): void; - - /** Delete the row based on the given tr element in grid. - * @param {JQuery} Pass the tr element in grid content to get its row index - * @returns {HTMLElement} - */ - deleteRow($tr: JQuery): HTMLElement; - - /** Destroy the grid widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. - * @returns {void} - */ - destroy(): void; - - /** Edit a particular cell based on the row index and field name provided in "batch" edit mode. - * @param {number} Pass row index to edit particular cell - * @param {string} Pass the field name of the column to perform batch edit - * @returns {void} - */ - editCell(index: number, fieldName: string): void; - - /** It returns a value and if the input field values of edit form is not based on the validation rules then it will show the validation message. - * @returns {Boolean} - */ - editFormValidate(): boolean; - - /** Send a save request in grid. - * @returns {void} - */ - endEdit(): void; - - /** Expand all the group caption rows in grid. - * @returns {void} - */ - expandAll(): void; - - /** Expand or collapse the row based on the row state in grid - * @param {JQuery} Pass the target object to expand/collapse the row based on its row state - * @returns {void} - */ - expandCollapse($target: JQuery): void; - - /** Expand the group drop area in grid. - * @returns {void} - */ - expandGroupDropArea(): void; - - /** Export the grid content to excel, word or PDF document. - * @param {string} Pass the controller action name corresponding to exporting - * @param {string} optionalASP server event name corresponding to exporting - * @param {boolean} optionalPass the multiple exporting value as true/false - * @param {Array} optionalPass the array of the gridIds to be filtered - * @returns {void} - */ - export(action: string, serverEvent?: string, multipleExport?: boolean, gridIds?: any[]): void; - - /** Send a filtering request to filter one column in grid. - * @param {Array} Pass the field name of the column - * @param {string} string/integer/dateTime operator - * @param {string} Pass the value to be filtered in a column - * @param {string} Pass the predicate as and/or - * @param {boolean} optional Pass the match case value as true/false - * @param {any} optionalactualFilterValue denote the filter object of current filtered columns.Pass the value to filtered in a column - * @returns {void} - */ - filterColumn(fieldName: any[], filterOperator: string, filterValue: string, predicate: string, matchcase?: boolean, actualFilterValue?: any): void; - - /** Send a filtering request to filter single or multiple column in grid. - * @param {Array} Pass array of filterColumn query for performing filter operation - * @returns {void} - */ - filterColumn(filterQueries: any[]): void; - - /** Get the batch changes of edit, delete and add operations of grid. - * @returns {any} - */ - getBatchChanges(): any; - - /** Get the browser details - * @returns {any} - */ - getBrowserDetails(): any; - - /** Get the column details based on the given field in grid - * @param {string} Pass the field name of the column to get the corresponding column object - * @returns {any} - */ - getColumnByField(fieldName: string): any; - - /** Get the column details based on the given header text in grid. - * @param {string} Pass the header text of the column to get the corresponding column object - * @returns {any} - */ - getColumnByHeaderText(headerText: string): any; - - /** Get the column details based on the given column index in grid - * @param {number} Pass the index of the column to get the corresponding column object - * @returns {any} - */ - getColumnByIndex(columnIndex: number): any; - - /** Get the list of field names from column collection in grid. - * @returns {Array} - */ - getColumnFieldNames(): any[]; - - /** Get the column index of the given field in grid. - * @param {string} Pass the field name of the column to get the corresponding column index - * @returns {number} - */ - getColumnIndexByField(fieldName: string): number; - - /** Get the column index of the given headerText of column in grid. - * @param {string} Pass the headerText of the column to get that column index - * @param {string} optionalOptional Pass the field name of the column. - * @returns {number} - */ - getColumnIndexByHeaderText(headerText: string, field?: string): number; - - /** Get the content div element of grid. - * @returns {HTMLElement} - */ - getContent(): HTMLElement; - - /** Get the content table element of grid - * @returns {Array} - */ - getContentTable(): HTMLTableElement[]; - - /** Get the data of currently edited cell value in "batch" edit mode - * @returns {any} - */ - getCurrentEditCellData(): any; - - /** Get the current page index in grid pager. - * @returns {number} - */ - getCurrentIndex(): number; - - /** Get the current page data source of grid. - * @returns {Array} - */ - getCurrentViewData(): any[]; - - /** Get the data of given row index in grid. - * @returns {any} - */ - getDataByIndex(): any; - - /** Get the column field name from the given header text in grid. - * @param {string} Pass header text of the column to get its corresponding field name - * @returns {String} - */ - getFieldNameByHeaderText(headerText: string): string; - - /** Get the filter bar of grid - * @returns {HTMLElement} - */ - getFilterBar(): HTMLElement; - - /** Get the records filtered or searched in Grid - * @returns {Array} - */ - getFilteredRecords(): any[]; - - /** Get the footer content of grid. - * @returns {HTMLElement} - */ - getFooterContent(): HTMLElement; - - /** Get the footer table element of grid. - * @returns {HTMLElement} - */ - getFooterTable(): HTMLElement; - - /** Get the header content div element of grid. - * @returns {HTMLElement} - */ - getHeaderContent(): HTMLElement; - - /** Get the header table element of grid - * @returns {HTMLElement} - */ - getHeaderTable(): HTMLElement; - - /** Get the column header text from the given field name in grid. - * @param {string} Pass field name of the column to get its corresponding header text - * @returns {String} - */ - getHeaderTextByFieldName(field: string): string; - - /** Get the names of all the hidden column collections in grid. - * @returns {Array} - */ - getHiddenColumnNames(): any[]; - - /** Get the row index based on the given tr element in grid. - * @param {JQuery} Pass the tr element in grid content to get its row index - * @returns {number} - */ - getIndexByRow($tr: JQuery): number; - - /** Get the pager of grid. - * @returns {HTMLElement} - */ - getPager(): HTMLElement; - - /** Get the names of primary key columns in Grid - * @returns {Array} - */ - getPrimaryKeyFieldNames(): any[]; - - /** Get the rows(tr element) from the given from and to row index in grid - * @param {number} Pass the from index from which the rows to be returned - * @param {number} Pass the to index to which the rows to be returned - * @returns {HTMLElement} - */ - getRowByIndex(from: number, to: number): HTMLElement; - - /** Get the row height of grid. - * @returns {number} - */ - getRowHeight(): number; - - /** Get the rows(tr element)of grid which is displayed in the current page. - * @returns {HTMLElement} - */ - getRows(): HTMLElement; - - /** Get the scroller object of grid. - * @returns {ej.Scroller} - */ - getScrollObject(): ej.Scroller; - - /** Get the selected records details in grid. - * @returns {Array} - */ - getSelectedRecords(): any[]; - - /** Get the selected row element details in grid. - * @returns {Array} - */ - getSelectedRows(): any[]; - - /** It accepts the string value and returns the field and sorted direction of the column in grid. - * @param {string} Pass the field of the column to get the sorted direction of the corresponding column in Grid. - * @returns {number} - */ - getsortColumnByField(field: string): number; - - /** Get the calculated summary values of JSON data passed to it - * @param {any} Pass Summary Column details - * @param {any} Pass JSON Array for which its field values to be calculated - * @returns {Number} - */ - getSummaryValues(summaryCol: any, summaryData: any): number; - - /** Get the names of all the visible column collections in grid - * @returns {Array} - */ - getVisibleColumnNames(): any[]; - - /** Send a paging request to specified page in grid - * @param {number} Pass the page index to perform paging at specified page index - * @returns {void} - */ - gotoPage(pageIndex: number): void; - - /** Send a column grouping request in grid. - * @param {string} Pass the field Name of the column to be grouped in grid control - * @returns {void} - */ - groupColumn(fieldName: string): void; - - /** Hide columns from the grid based on the header text - * @param {Array|string} you can pass either array of header text of various columns or a header text of a column to hide - * @returns {void} - */ - hideColumns(headerText: any[]|string): void; - - /** Print the grid control - * @returns {void} - */ - print(): void; - - /** It is used to refresh and reset the changes made in "batch" edit mode - * @returns {void} - */ - refreshBatchEditChanges(): void; - - /** It is used to refresh the grid header. - * @returns {void} - */ - refreshHeader(): void; - - /** Refresh the grid contents. The template refreshment is based on the argument passed along with this method - * @param {boolean} optional When templateRefresh is set true, template and grid contents both are refreshed in grid else only grid content is refreshed - * @returns {void} - */ - refreshContent(templateRefresh?: boolean): void; - - /** Refresh the template of the grid - * @returns {void} - */ - refreshTemplate(): void; - - /** Refresh the toolbar items in grid. - * @returns {void} - */ - refreshToolbar(): void; - - /** Remove a column or collection of columns from a sorted column collections in grid. - * @param {Array|string} Pass array of field names of the columns to remove a collection of sorted columns or pass a string of field name to remove a column from sorted column collections - * @returns {void} - */ - removeSortedColumns(fieldName: any[]|string): void; - - /** Creates a grid control - * @returns {void} - */ - render(): void; - - /** Re-order the column in grid - * @param {string} Pass the from field name of the column needs to be changed - * @param {string} Pass the to field name of the column needs to be changed - * @returns {void} - */ - reorderColumns(fromFieldName: string, toFieldName: string): void; - - /** Re-order the row in grid - * @param {Array} Pass the indexes of the rows needs to reorder. - * @param {number} Pass the index of a row where to be reordered. - * @returns {void} - */ - reorderRows(indexes: any[], toindex: number): void; - - /** Reset the model collections like pageSettings, groupSettings, filterSettings, sortSettings and summaryRows. - * @returns {void} - */ - resetModelCollections(): void; - - /** Resize the columns by giving column name and width for the corresponding one. - * @param {string} Pass the column name that needs to be changed - * @param {string} Pass the width to resize the particular columns - * @returns {void} - */ - resizeColumns(column: string, width: string): void; - - /** Resolves row height issue when unbound column is used with FrozenColumn - * @returns {void} - */ - rowHeightRefresh(): void; - - /** Save the particular edited cell in grid. - * @returns {void} - */ - //saveCell(): void; - - /** We can prevent the client side cellSave event triggering by passing the preventSaveEvent argument as true. - * @param {boolean} optionalIf we pass preventSaveEvent as true, it prevents the client side cellSave event triggering - * @returns {void} - */ - saveCell(preventSaveEvent: boolean): void; - - /** Set dimension for grid with corresponding to grid parent. - * @param {number} Pass the height of the grid container - * @param {number} Pass the width of the grid container - * @returns {void} - */ - setDimension(height: number, width: number): void; - - /** Send a request to grid to refresh the width set to columns - * @returns {void} - */ - setWidthToColumns(): void; - - /** Send a search request to grid with specified string passed in it - * @param {string} Pass the string to search in Grid records - * @returns {void} - */ - search(searchString: string): void; - - /** Select cells in grid. - * @param {any} It is used to set the starting index of row and indexes of cells for that corresponding row for selecting cells. - * @returns {void} - */ - selectCells(rowCellIndexes: any): void; - - /** Select columns in grid. - * @param {number} It is used to set the starting index of column for selecting columns. - * @returns {void} - */ - selectColumns(fromIndex: number): void; - - /** Select the specified columns in grid based on Index provided. - * @param {number} It is used to set the starting index of column for selecting columns. - * @param {number} optionalIt is used to set the ending index of column for selecting columns. - * @returns {Boolean} - */ - selectColumns(columnIndex: number, toIndex?: number): boolean; - - /** Select rows in grid. - * @param {number} It is used to set the starting index of row for selecting rows. - * @param {number} It is used to set the ending index of row for selecting rows. - * @returns {void} - */ - selectRows(fromIndex: number, toIndex: number): void; - - /** Select specified rows in grid based on Index provided. - * @param {Array|number} It is used to set the starting index of row for selecting rows. - * @param {number} optionalIt is used to set the ending index of row for selecting rows. - * @param {any} optionalTarget element which is clicked. - * @returns {void} - */ - selectRows(from: any[]|number, to: number, target?: any): void; - - /** Select rows in grid. - * @param {Array} Pass array of rowIndexes for selecting rows - * @returns {void} - */ - selectRows(rowIndexes: any[]): void; - - /** Used to update a particular cell value. - * @returns {void} - */ - setCellText(): void; - - /** Used to update a particular cell value based on specified row Index and the fieldName. - * @param {number} It is used to set the index for selecting the row. - * @param {string} It is used to set the field name for selecting column. - * @param {any} It is used to set the value for the selected cell. - * @returns {void} - */ - setCellValue(Index: number, fieldName: string, value: any): void; - - /** It sets the default data to the column in grid during adding record in batch edit mode. - * @returns {void} - */ - setDefaultData(): void; - - /** The grid rows has to be rendered as detail view in mobile mode based on given value. - * @param {number} It is used to render grid rows as details view in mobile mode. - * @returns {void} - */ - setPhoneModeMaxWidth(Index: number): void; - - /** Set validation to edit form in the grid. - * @returns {void} - */ - setValidation(): void; - - /** Set validation to a particular input field in a edit form dynamically. - * @param {string} Specify the field name of the column to set validation rules - * @param {any} Specify the validation rules for the field - * @returns {void} - */ - setValidationToField(fieldName: string, rules: any): void; - - /** Show columns in the grid based on the header text - * @param {Array|string} you can pass either array of header text of various columns or a header text of a column to show - * @returns {void} - */ - showColumns(headerText: any[]|string): void; - - /** Send a sorting request in grid. - * @param {string} Pass the field name of the column as columnName for which sorting have to be performed - * @param {string} optional Pass the sort direction ascending/descending by which the column have to be sort. By default it is sorting in an ascending order - * @returns {void} - */ - sortColumn(columnName: string, sortingDirection?: string): void; - - /** Send an edit record request in grid - * @param {JQuery} Pass the tr- selected row element to be edited in grid - * @returns {void} - */ - startEdit($tr: JQuery): void; - - /** Un-group a column from grouped columns collection in grid - * @param {string} Pass the field Name of the column to be ungrouped from grouped column collection - * @returns {void} - */ - ungroupColumn(fieldName: string): void; - - /** Update a edited record in grid control when allowEditing is set as true. - * @param {string} Pass the primary key field Name of the column - * @param {Array} Pass the edited JSON data of record need to be update. - * @returns {void} - */ - updateRecord(fieldName: string, data: any[]): void; - - /** It adapts grid to its parent element or to the browsers window. - * @returns {void} - */ - windowonresize(): void; -} -export namespace Grid { - -export interface Model { - - /** Gets or sets a value that indicates whether to customizing cell based on our needs. - * @Default {false} - */ - allowCellMerging?: boolean; - - /** Gets or sets a value that indicates whether to enable dynamic grouping behavior. Grouping can be done by drag on drop desired columns to gridĂ¢â‚¬â„¢s GroupDropArea. - * This can be further customized through Ă¢â‚¬Å“groupSettingsĂ¢â‚¬Â property. - * @Default {false} - */ - allowGrouping?: boolean; - - /** Gets or sets a value that indicates whether to enable keyboard support for performing grid actions. selectionType Ă¢â‚¬â€œ Gets or sets a value that indicates whether to enable single - * row or multiple rows selection behavior in grid. Multiple selection can be done through by holding CTRL and clicking the grid rows - * @Default {true} - */ - allowKeyboardNavigation?: boolean; - - /** Gets or sets a value that indicates whether to enable dynamic filtering behavior on grid. Filtering can be used to limit the records displayed using required criteria and - * this can be further customized through Ă¢â‚¬Å“filterSettingsĂ¢â‚¬Â property - * @Default {false} - */ - allowFiltering?: boolean; - - /** Gets or sets a value that indicates whether to enable the dynamic sorting behavior on grid data. Sorting can be done through clicking on particular column header. - * @Default {false} - */ - allowSorting?: boolean; - - /** Gets or sets a value that indicates whether to enable multi columns sorting behavior in grid. Sort multiple columns by holding CTRL and click on the corresponding column header. - * @Default {false} - */ - allowMultiSorting?: boolean; - - /** This specifies the grid to show the paginated data. Also enables pager control at the bottom of grid for dynamic navigation through data source. - * Paging can be further customized through Ă¢â‚¬Å“pageSettingsĂ¢â‚¬Â property. - * @Default {false} - */ - allowPaging?: boolean; - - /** Gets or sets a value that indicates whether to enable the columns reordering behavior in the grid. Reordering can be done through by drag and drop the particular column - * from one index to another index within the grid. - * @Default {false} - */ - allowReordering?: boolean; - - /** Gets or sets a value that indicates whether the column is non resizable. Column width is set automatically based on the content or header text which is large. - * @Default {false} - */ - allowResizeToFit?: boolean; - - /** Gets or sets a value that indicates whether to enable dynamic resizable of columns. Resize the width of the columns by simply click and move the particular column header line - * @Default {false} - */ - allowResizing?: boolean; - - /** Gets or sets a value that indicates whether to enable the rows reordering in Grid and drag & drop rows between multiple Grid. - * @Default {false} - */ - allowRowDragAndDrop?: boolean; - - /** Gets or sets a value that indicates whether to enable the scrollbar in the grid and view the records by scroll through the grid manually - * @Default {false} - */ - allowScrolling?: boolean; - - /** Gets or sets a value that indicates whether to enable dynamic searching behavior in grid. Currently search box can be enabled through Ă¢â‚¬Å“toolbarSettingsĂ¢â‚¬Â - * @Default {false} - */ - allowSearching?: boolean; - - /** Gets or sets a value that indicates whether user can select rows on grid. On enabling feature, selected row will be highlighted. - * @Default {true} - */ - allowSelection?: boolean; - - /** Gets or sets a value that indicates whether the Content will wrap to the next line if the content exceeds the boundary of the Column Cells. - * @Default {false} - */ - allowTextWrap?: boolean; - - /** Gets or sets a value that indicates whether to enable the multiple exporting behavior on grid data. - * @Default {false} - */ - allowMultipleExporting?: boolean; - - /** Gets or sets a value that indicates to define common width for all the columns in the grid. - */ - commonWidth?: number; - - /** Gets or sets a value that indicates to enable the visibility of the grid lines. - * @Default {ej.Grid.GridLines.Both} - */ - gridLines?: ej.Grid.GridLines|string; - - /** This specifies the grid to add the grid control inside the grid row of the parent with expand/collapse options - * @Default {null} - */ - childGrid?: any; - - /** Used to enable or disable static width settings for column. If the columnLayout is set as fixed, then column width will be static. - * @Default {ej.Grid.ColumnLayout.Auto} - */ - columnLayout?: ej.Grid.ColumnLayout|string; - - /** Gets or sets an object that indicates to render the grid with specified columns - * @Default {[]} - */ - columns?: Column[]; - - /** Gets or sets an object that indicates whether to customize the context menu behavior of the grid. - */ - contextMenuSettings?: ContextMenuSettings; - - /** Gets or sets a value that indicates to render the grid with custom theme. - */ - cssClass?: string; - - /** Gets or sets the data to render the grid with records - * @Default {null} - */ - dataSource?: any; - - /** Default Value: - * @Default {null} - */ - detailsTemplate?: string; - - /** Gets or sets an object that indicates whether to customize the editing behavior of the grid. - */ - editSettings?: EditSettings; - - /** Gets or sets a value that indicates whether to enable the alternative rows differentiation in the grid records based on corresponding theme. - * @Default {true} - */ - enableAltRow?: boolean; - - /** Gets or sets a value that indicates whether to enable the save action in the grid through row selection - * @Default {true} - */ - enableAutoSaveOnSelectionChange?: boolean; - - /** Gets or sets a value that indicates whether to enable mouse over effect on the corresponding column header cell of the grid - * @Default {false} - */ - enableHeaderHover?: boolean; - - /** Gets or sets a value that indicates whether to persist the grid model state in page using applicable medium i.e., HTML5 localStorage or cookies - * @Default {false} - */ - enablePersistence?: boolean; - - /** Gets or sets a value that indicates whether the grid rows has to be rendered as detail view in mobile mode - * @Default {false} - */ - enableResponsiveRow?: boolean; - - /** Gets or sets a value that indicates whether to enable mouse over effect on corresponding grid row. - * @Default {true} - */ - enableRowHover?: boolean; - - /** Align content in the grid control from right to left by setting the property as true. - * @Default {false} - */ - enableRTL?: boolean; - - /** To Disable the mouse swipe property as false. - * @Default {true} - */ - enableTouch?: boolean; - - /** It sets a value that indicates whether to enable toolbar items, when allowEditing, allowAdding and allowDeleting property set as false in the grid. - * @Default {false} - */ - enableToolbarItems?: boolean; - - /** Act as mapper for the excel exporting URL. - * @Default {ExportToExcel} - */ - exportToExcelAction?: string; - - /** Act as mapper for the PDF exporting URL. - * @Default {ExportToPdf} - */ - exportToPdfAction?: string; - - /** Act as mapper for the Word exporting URL. - * @Default {ExportToWord} - */ - exportToWordAction?: string; - - /** Gets or sets an object that indicates whether to customize the filtering behavior of the grid - */ - filterSettings?: FilterSettings; - - /** Gets or sets an object that indicates whether to customize the grouping behavior of the grid. - */ - groupSettings?: GroupSettings; - - /** Gets or sets a value that indicates whether the grid design has be to made responsive. - * @Default {false} - */ - isResponsive?: boolean; - - /** This specifies to change the key in keyboard interaction to grid control - * @Default {null} - */ - keySettings?: any; - - /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and - * culture specific to a particular country or region. - * @Default {en-US} - */ - locale?: string; - - /** Gets or sets a value that indicates whether to set the minimum width of the responsive grid while isResponsive property is true and enableResponsiveRow property is set as false. - * @Default {0} - */ - minWidth?: number; - - /** Gets or sets an object that indicates whether to modify the pager default configuration. - */ - pageSettings?: PageSettings; - - /** Query the dataSource from the table for Grid. - * @Default {null} - */ - query?: any; - - /** Gets or sets an object that indicates whether to modify the resizing behavior. - */ - resizeSettings?: ResizeSettings; - - /** Gets or sets a value that indicates to render the grid with template rows. The template row must be a table row. That table row must have the JavaScript render binding format ({{:columnName}}) - * then the grid data source binds the data to the corresponding table row of the template. - * @Default {null} - */ - rowTemplate?: string; - - /** Gets or sets an object that indicates whether to customize the drag and drop behavior of the grid rows - */ - rowDropSettings?: RowDropSettings; - - /** Gets or sets an object that indicates whether to customize the searching behavior of the grid - */ - searchSettings?: SearchSettings; - - /** Gets a value that indicates whether the grid model to hold multiple selected records . selectedRecords can be used to displayed hold the single - * or multiple selected records using Ă¢â‚¬Å“selectedRecordsĂ¢â‚¬Â property - * @Default {null} - */ - selectedRecords?: any[]; - - /** Gets or sets a value that indicates to select the row while initializing the grid - * @Default {-1} - */ - selectedRowIndex?: number; - - /** Gets or sets a value that indicates the selected rows in grid - * @Default {[]} - */ - selectedRowIndices?: any[]; - - /** This property is used to configure the selection behavior of the grid. - */ - selectionSettings?: SelectionSettings; - - /** The row selection behavior of grid. Accepting types are "single" and "multiple". - * @Default {ej.Grid.SelectionType.Single} - */ - selectionType?: ej.Grid.SelectionType|string; - - /** Gets or sets an object that indicates whether to customize the scrolling behavior of the grid. - */ - scrollSettings?: ScrollSettings; + export interface CustomFileDetails { + + /** Enables the file upload interactions like remove/cancel in File details of the dialog popup. + */ + action?: boolean; + + /** Enables the name in the File details of the dialog popup. + */ + name?: boolean; + + /** Enables or disables the File size details of the dialog popup. + */ + size?: boolean; + + /** Enables or disables the file uploading status visibility in the dialog file details content. + */ + status?: boolean; + + /** Enables the title in File details for the dialog popup. + */ + title?: boolean; + } + + export interface DialogAction { + + /** Once uploaded successfully, the dialog popup closes immediately. + */ + closeOnComplete?: boolean; + + /** Sets the content container option to the Uploadbox dialog popup. + */ + content?: string; + + /** Enables the drag option to the dialog popup. + */ + drag?: boolean; + + /** Enables or disables the Uploadbox dialogĂ¢â‚¬â„¢s modal property to the dialog popup. + */ + modal?: boolean; + } + + export interface DialogText { + + /** Sets the uploaded fileĂ¢â‚¬â„¢s Name (header text) to the Dialog popup. + */ + name?: string; + + /** Sets the upload file Size (header text) to the dialog popup. + */ + size?: string; + + /** Sets the upload file Status (header text) to the dialog popup. + */ + status?: string; + + /** Sets the title text of the dialog popup. + */ + title?: string; + } + } + + class WaitingPopup extends ej.Widget { + static fn: WaitingPopup; + constructor(element: JQuery | Element, options?: WaitingPopup.Model); + static Locale: any; + model: WaitingPopup.Model; + defaults: WaitingPopup.Model; + + /** To hide the waiting popup + * @returns {void} + */ + hide(): void; + + /** Refreshes the WaitingPopup control by resetting the pop-up panel position and content position + * @returns {void} + */ + refresh(): void; + + /** To show the waiting popup + * @returns {void} + */ + show(): void; + } + export namespace WaitingPopup { + + export interface Model { + + /** Sets the root class for the WaitingPopup control theme + * @Default {null} + */ + cssClass?: string; + + /** Specifies the list of HTML attributes to be added to waitingpopup control. + * @Default {{}} + */ + htmlAttributes?: any; + + /** Enables or disables the default loading icon. + * @Default {true} + */ + showImage?: boolean; + + /** Enables the visibility of the WaitingPopup control + * @Default {false} + */ + showOnInit?: boolean; + + /** Specified a selector for elements, within the container. + * @Default {null} + */ + target?: string; + + /** Waitingpopup element append to given container element. + * @Default {null} + */ + appendTo?: string; + + /** Loads HTML content inside the popup panel instead of the default icon + * @Default {null} + */ + template?: any; + + /** Sets the custom text in the pop-up panel to notify the waiting process + * @Default {null} + */ + text?: string; + + /** Fires after Create WaitingPopup successfully */ + create?(e: CreateEventArgs): void; + + /** Fires after Destroy WaitingPopup successfully */ + destroy?(e: DestroyEventArgs): void; + } + + export interface CreateEventArgs { + + /** returns the cancel option value + */ + cancel?: boolean; + + /** returns the WaitingPopup model + */ + model?: ej.WaitingPopup.Model; + + /** returns the name of the event + */ + type?: string; + } + + export interface DestroyEventArgs { + + /** returns the cancel option value + */ + cancel?: boolean; + + /** returns the WaitingPopup model + */ + model?: ej.WaitingPopup.Model; + + /** returns the name of the event + */ + type?: string; + } + } + + class Grid extends ej.Widget { + static fn: Grid; + constructor(element: JQuery | Element, options?: Grid.Model); + static Locale: any; + model: Grid.Model; + defaults: Grid.Model; + + /** Adds a grid model property which is to be ignored upon exporting. + * @param {Array} Pass the array of parameters which need to be ignored on exporting + * @returns {void} + */ + addIgnoreOnExport(propertyNames: any[]): void; + + /** Add a new record in grid control when allowAdding is set as true. + * @returns {void} + */ + //addRecord(): void; + + /** Add a new record in grid control when allowAdding is set as true. + * @param {Array} Pass the array of added Records + * @param {Array} optionalIf we pass serverChange as true, send post to server side for server action. + * @returns {void} + */ + addRecord(data: any[], serverChange?: any[]): void; + + /** Cancel the modified changes in grid control when edit mode is "batch". + * @returns {void} + */ + batchCancel(): void; + + /** Save the modified changes to data source in grid control when edit mode is "batch". + * @returns {void} + */ + batchSave(): void; + + /** Send a cancel request in grid. + * @returns {void} + */ + cancelEdit(): void; + + /** Send a cancel request to the edited cell in grid. + * @returns {void} + */ + cancelEditCell(): void; + + /** It is used to clear all the cell selection. + * @returns {Boolean} + */ + clearCellSelection(): boolean; + + /** It is used to clear specified cell selection based on the rowIndex and columnIndex provided. + * @param {number} It is used to pass the row index of the cell + * @param {number} It is used to pass the column index of the cell. + * @returns {Boolean} + */ + clearCellSelection(rowIndex: number, columnIndex: number): boolean; + + /** It is used to clear all the row selection or at specific row selection based on the index provided. + * @param {number} optional If index of the column is specified then it will remove the selection from the particular column else it will clears all of the column selection + * @returns {Boolean} + */ + clearColumnSelection(index?: number): boolean; + + /** It is used to clear all the filtering done. + * @param {string} If field of the column is specified then it will clear the particular filtering column + * @returns {void} + */ + clearFiltering(field: string): void; + + /** Clear the searching from the grid + * @returns {void} + */ + clearSearching(): void; + + /** Clear all the row selection or at specific row selection based on the index provided + * @param {number} optional If index of the row is specified then it will remove the selection from the particular row else it will clears all of the row selection + * @returns {Boolean} + */ + clearSelection(index?: number): boolean; + + /** Clear the sorting from columns in the grid + * @returns {void} + */ + clearSorting(): void; + + /** Collapse all the group caption rows in grid + * @returns {void} + */ + collapseAll(): void; + + /** Collapse the group drop area in grid + * @returns {void} + */ + collapseGroupDropArea(): void; + + /** Add or remove columns in grid column collections + * @param {Array|string} Pass array of columns or string of field name to add/remove the column in grid + * @param {string} optional Pass add/remove action to be performed. By default "add" action will perform + * @returns {void} + */ + columns(columnDetails: any[] | string, action?: string): void; + + /** Refresh the grid with new data source + * @param {Array} Pass new data source to the grid + * @param {boolean} optional When templateRefresh is set true, both header and contents get refreshed + * @returns {void} + */ + dataSource(datasource: any[], templateRefresh?: boolean): void; + + /** Delete a record in grid control when allowDeleting is set as true + * @param {string} Pass the primary key field Name of the column + * @param {Array} Pass the JSON data of record need to be delete. + * @returns {void} + */ + deleteRecord(fieldName: string, data: any[]): void; + + /** Delete the row based on the given tr element in grid. + * @param {JQuery} Pass the tr element in grid content to get its row index + * @returns {HTMLElement} + */ + deleteRow($tr: JQuery): HTMLElement; + + /** Destroy the grid widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. + * @returns {void} + */ + destroy(): void; + + /** Edit a particular cell based on the row index and field name provided in "batch" edit mode. + * @param {number} Pass row index to edit particular cell + * @param {string} Pass the field name of the column to perform batch edit + * @returns {void} + */ + editCell(index: number, fieldName: string): void; + + /** It returns a value and if the input field values of edit form is not based on the validation rules then it will show the validation message. + * @returns {Boolean} + */ + editFormValidate(): boolean; + + /** Send a save request in grid. + * @returns {void} + */ + endEdit(): void; + + /** Expand all the group caption rows in grid. + * @returns {void} + */ + expandAll(): void; + + /** Expand or collapse the row based on the row state in grid + * @param {JQuery} Pass the target object to expand/collapse the row based on its row state + * @returns {void} + */ + expandCollapse($target: JQuery): void; + + /** Expand the group drop area in grid. + * @returns {void} + */ + expandGroupDropArea(): void; + + /** Export the grid content to excel, word or PDF document. + * @param {string} Pass the controller action name corresponding to exporting + * @param {string} optionalASP server event name corresponding to exporting + * @param {boolean} optionalPass the multiple exporting value as true/false + * @param {Array} optionalPass the array of the gridIds to be filtered + * @returns {void} + */ + export(action: string, serverEvent?: string, multipleExport?: boolean, gridIds?: any[]): void; + + /** Send a filtering request to filter one column in grid. + * @param {Array} Pass the field name of the column + * @param {string} string/integer/dateTime operator + * @param {string} Pass the value to be filtered in a column + * @param {string} Pass the predicate as and/or + * @param {boolean} optional Pass the match case value as true/false + * @param {any} optionalactualFilterValue denote the filter object of current filtered columns.Pass the value to filtered in a column + * @returns {void} + */ + filterColumn(fieldName: any[], filterOperator: string, filterValue: string, predicate: string, matchcase?: boolean, actualFilterValue?: any): void; + + /** Send a filtering request to filter single or multiple column in grid. + * @param {Array} Pass array of filterColumn query for performing filter operation + * @returns {void} + */ + filterColumn(filterQueries: any[]): void; + + /** Get the batch changes of edit, delete and add operations of grid. + * @returns {any} + */ + getBatchChanges(): any; + + /** Get the browser details + * @returns {any} + */ + getBrowserDetails(): any; + + /** Get the column details based on the given field in grid + * @param {string} Pass the field name of the column to get the corresponding column object + * @returns {any} + */ + getColumnByField(fieldName: string): any; + + /** Get the column details based on the given header text in grid. + * @param {string} Pass the header text of the column to get the corresponding column object + * @returns {any} + */ + getColumnByHeaderText(headerText: string): any; + + /** Get the column details based on the given column index in grid + * @param {number} Pass the index of the column to get the corresponding column object + * @returns {any} + */ + getColumnByIndex(columnIndex: number): any; + + /** Get the list of field names from column collection in grid. + * @returns {Array} + */ + getColumnFieldNames(): any[]; + + /** Get the column index of the given field in grid. + * @param {string} Pass the field name of the column to get the corresponding column index + * @returns {number} + */ + getColumnIndexByField(fieldName: string): number; + + /** Get the column index of the given headerText of column in grid. + * @param {string} Pass the headerText of the column to get that column index + * @param {string} optionalOptional Pass the field name of the column. + * @returns {number} + */ + getColumnIndexByHeaderText(headerText: string, field?: string): number; + + /** Get the content div element of grid. + * @returns {HTMLElement} + */ + getContent(): HTMLElement; + + /** Get the content table element of grid + * @returns {Array} + */ + getContentTable(): HTMLTableElement[]; + + /** Get the data of currently edited cell value in "batch" edit mode + * @returns {any} + */ + getCurrentEditCellData(): any; + + /** Get the current page index in grid pager. + * @returns {number} + */ + getCurrentIndex(): number; + + /** Get the current page data source of grid. + * @returns {Array} + */ + getCurrentViewData(): any[]; + + /** Get the data of given row index in grid. + * @returns {any} + */ + getDataByIndex(): any; + + /** Get the column field name from the given header text in grid. + * @param {string} Pass header text of the column to get its corresponding field name + * @returns {String} + */ + getFieldNameByHeaderText(headerText: string): string; + + /** Get the filter bar of grid + * @returns {HTMLElement} + */ + getFilterBar(): HTMLElement; + + /** Get the records filtered or searched in Grid + * @returns {Array} + */ + getFilteredRecords(): any[]; + + /** Get the footer content of grid. + * @returns {HTMLElement} + */ + getFooterContent(): HTMLElement; + + /** Get the footer table element of grid. + * @returns {HTMLElement} + */ + getFooterTable(): HTMLElement; + + /** Get the header content div element of grid. + * @returns {HTMLElement} + */ + getHeaderContent(): HTMLElement; + + /** Get the header table element of grid + * @returns {HTMLElement} + */ + getHeaderTable(): HTMLElement; + + /** Get the column header text from the given field name in grid. + * @param {string} Pass field name of the column to get its corresponding header text + * @returns {String} + */ + getHeaderTextByFieldName(field: string): string; + + /** Get the names of all the hidden column collections in grid. + * @returns {Array} + */ + getHiddenColumnNames(): any[]; + + /** Get the row index based on the given tr element in grid. + * @param {JQuery} Pass the tr element in grid content to get its row index + * @returns {number} + */ + getIndexByRow($tr: JQuery): number; + + /** Get the pager of grid. + * @returns {HTMLElement} + */ + getPager(): HTMLElement; + + /** Get the names of primary key columns in Grid + * @returns {Array} + */ + getPrimaryKeyFieldNames(): any[]; + + /** Get the rows(tr element) from the given from and to row index in grid + * @param {number} Pass the from index from which the rows to be returned + * @param {number} Pass the to index to which the rows to be returned + * @returns {HTMLElement} + */ + getRowByIndex(from: number, to: number): HTMLElement; + + /** Get the row height of grid. + * @returns {number} + */ + getRowHeight(): number; + + /** Get the rows(tr element)of grid which is displayed in the current page. + * @returns {HTMLElement} + */ + getRows(): HTMLElement; + + /** Get the scroller object of grid. + * @returns {ej.Scroller} + */ + getScrollObject(): ej.Scroller; + + /** Get the selected records details in grid. + * @returns {Array} + */ + getSelectedRecords(): any[]; + + /** Get the selected row element details in grid. + * @returns {Array} + */ + getSelectedRows(): any[]; + + /** It accepts the string value and returns the field and sorted direction of the column in grid. + * @param {string} Pass the field of the column to get the sorted direction of the corresponding column in Grid. + * @returns {number} + */ + getsortColumnByField(field: string): number; + + /** Get the calculated summary values of JSON data passed to it + * @param {any} Pass Summary Column details + * @param {any} Pass JSON Array for which its field values to be calculated + * @returns {Number} + */ + getSummaryValues(summaryCol: any, summaryData: any): number; + + /** Get the names of all the visible column collections in grid + * @returns {Array} + */ + getVisibleColumnNames(): any[]; + + /** Send a paging request to specified page in grid + * @param {number} Pass the page index to perform paging at specified page index + * @returns {void} + */ + gotoPage(pageIndex: number): void; + + /** Send a column grouping request in grid. + * @param {string} Pass the field Name of the column to be grouped in grid control + * @returns {void} + */ + groupColumn(fieldName: string): void; + + /** Hide columns from the grid based on the header text + * @param {Array|string} you can pass either array of header text of various columns or a header text of a column to hide + * @returns {void} + */ + hideColumns(headerText: any[] | string): void; + + /** Print the grid control + * @returns {void} + */ + print(): void; + + /** It is used to refresh and reset the changes made in "batch" edit mode + * @returns {void} + */ + refreshBatchEditChanges(): void; + + /** It is used to refresh the grid header. + * @returns {void} + */ + refreshHeader(): void; + + /** Refresh the grid contents. The template refreshment is based on the argument passed along with this method + * @param {boolean} optional When templateRefresh is set true, template and grid contents both are refreshed in grid else only grid content is refreshed + * @returns {void} + */ + refreshContent(templateRefresh?: boolean): void; + + /** Refresh the template of the grid + * @returns {void} + */ + refreshTemplate(): void; + + /** Refresh the toolbar items in grid. + * @returns {void} + */ + refreshToolbar(): void; + + /** Remove a column or collection of columns from a sorted column collections in grid. + * @param {Array|string} Pass array of field names of the columns to remove a collection of sorted columns or pass a string of field name to remove a column from sorted column collections + * @returns {void} + */ + removeSortedColumns(fieldName: any[] | string): void; + + /** Creates a grid control + * @returns {void} + */ + render(): void; + + /** Re-order the column in grid + * @param {string} Pass the from field name of the column needs to be changed + * @param {string} Pass the to field name of the column needs to be changed + * @returns {void} + */ + reorderColumns(fromFieldName: string, toFieldName: string): void; + + /** Re-order the row in grid + * @param {Array} Pass the indexes of the rows needs to reorder. + * @param {number} Pass the index of a row where to be reordered. + * @returns {void} + */ + reorderRows(indexes: any[], toindex: number): void; + + /** Reset the model collections like pageSettings, groupSettings, filterSettings, sortSettings and summaryRows. + * @returns {void} + */ + resetModelCollections(): void; + + /** Resize the columns by giving column name and width for the corresponding one. + * @param {string} Pass the column name that needs to be changed + * @param {string} Pass the width to resize the particular columns + * @returns {void} + */ + resizeColumns(column: string, width: string): void; + + /** Resolves row height issue when unbound column is used with FrozenColumn + * @returns {void} + */ + rowHeightRefresh(): void; + + /** Save the particular edited cell in grid. + * @returns {void} + */ + //saveCell(): void; + + /** We can prevent the client side cellSave event triggering by passing the preventSaveEvent argument as true. + * @param {boolean} optionalIf we pass preventSaveEvent as true, it prevents the client side cellSave event triggering + * @returns {void} + */ + saveCell(preventSaveEvent: boolean): void; + + /** Set dimension for grid with corresponding to grid parent. + * @param {number} Pass the height of the grid container + * @param {number} Pass the width of the grid container + * @returns {void} + */ + setDimension(height: number, width: number): void; + + /** Send a request to grid to refresh the width set to columns + * @returns {void} + */ + setWidthToColumns(): void; + + /** Send a search request to grid with specified string passed in it + * @param {string} Pass the string to search in Grid records + * @returns {void} + */ + search(searchString: string): void; + + /** Select cells in grid. + * @param {any} It is used to set the starting index of row and indexes of cells for that corresponding row for selecting cells. + * @returns {void} + */ + selectCells(rowCellIndexes: any): void; + + /** Select columns in grid. + * @param {number} It is used to set the starting index of column for selecting columns. + * @returns {void} + */ + selectColumns(fromIndex: number): void; + + /** Select the specified columns in grid based on Index provided. + * @param {number} It is used to set the starting index of column for selecting columns. + * @param {number} optionalIt is used to set the ending index of column for selecting columns. + * @returns {Boolean} + */ + selectColumns(columnIndex: number, toIndex?: number): boolean; + + /** Select rows in grid. + * @param {number} It is used to set the starting index of row for selecting rows. + * @param {number} It is used to set the ending index of row for selecting rows. + * @returns {void} + */ + selectRows(fromIndex: number, toIndex: number): void; + + /** Select specified rows in grid based on Index provided. + * @param {Array|number} It is used to set the starting index of row for selecting rows. + * @param {number} optionalIt is used to set the ending index of row for selecting rows. + * @param {any} optionalTarget element which is clicked. + * @returns {void} + */ + selectRows(from: any[] | number, to: number, target?: any): void; + + /** Select rows in grid. + * @param {Array} Pass array of rowIndexes for selecting rows + * @returns {void} + */ + selectRows(rowIndexes: any[]): void; + + /** Used to update a particular cell value. + * @returns {void} + */ + setCellText(): void; + + /** Used to update a particular cell value based on specified row Index and the fieldName. + * @param {number} It is used to set the index for selecting the row. + * @param {string} It is used to set the field name for selecting column. + * @param {any} It is used to set the value for the selected cell. + * @returns {void} + */ + setCellValue(Index: number, fieldName: string, value: any): void; + + /** It sets the default data to the column in grid during adding record in batch edit mode. + * @returns {void} + */ + setDefaultData(): void; + + /** The grid rows has to be rendered as detail view in mobile mode based on given value. + * @param {number} It is used to render grid rows as details view in mobile mode. + * @returns {void} + */ + setPhoneModeMaxWidth(Index: number): void; + + /** Set validation to edit form in the grid. + * @returns {void} + */ + setValidation(): void; + + /** Set validation to a particular input field in a edit form dynamically. + * @param {string} Specify the field name of the column to set validation rules + * @param {any} Specify the validation rules for the field + * @returns {void} + */ + setValidationToField(fieldName: string, rules: any): void; + + /** Show columns in the grid based on the header text + * @param {Array|string} you can pass either array of header text of various columns or a header text of a column to show + * @returns {void} + */ + showColumns(headerText: any[] | string): void; + + /** Send a sorting request in grid. + * @param {string} Pass the field name of the column as columnName for which sorting have to be performed + * @param {string} optional Pass the sort direction ascending/descending by which the column have to be sort. By default it is sorting in an ascending order + * @returns {void} + */ + sortColumn(columnName: string, sortingDirection?: string): void; + + /** Send an edit record request in grid + * @param {JQuery} Pass the tr- selected row element to be edited in grid + * @returns {void} + */ + startEdit($tr: JQuery): void; + + /** Un-group a column from grouped columns collection in grid + * @param {string} Pass the field Name of the column to be ungrouped from grouped column collection + * @returns {void} + */ + ungroupColumn(fieldName: string): void; + + /** Update a edited record in grid control when allowEditing is set as true. + * @param {string} Pass the primary key field Name of the column + * @param {Array} Pass the edited JSON data of record need to be update. + * @returns {void} + */ + updateRecord(fieldName: string, data: any[]): void; + + /** It adapts grid to its parent element or to the browsers window. + * @returns {void} + */ + windowonresize(): void; + } + export namespace Grid { + + export interface Model { + + /** Gets or sets a value that indicates whether to customizing cell based on our needs. + * @Default {false} + */ + allowCellMerging?: boolean; + + /** Gets or sets a value that indicates whether to enable dynamic grouping behavior. Grouping can be done by drag on drop desired columns to gridĂ¢â‚¬â„¢s GroupDropArea. + * This can be further customized through Ă¢â‚¬Å“groupSettingsĂ¢â‚¬Â property. + * @Default {false} + */ + allowGrouping?: boolean; + + /** Gets or sets a value that indicates whether to enable keyboard support for performing grid actions. selectionType Ă¢â‚¬â€œ Gets or sets a value that indicates whether to enable single + * row or multiple rows selection behavior in grid. Multiple selection can be done through by holding CTRL and clicking the grid rows + * @Default {true} + */ + allowKeyboardNavigation?: boolean; + + /** Gets or sets a value that indicates whether to enable dynamic filtering behavior on grid. Filtering can be used to limit the records displayed using required criteria and + * this can be further customized through Ă¢â‚¬Å“filterSettingsĂ¢â‚¬Â property + * @Default {false} + */ + allowFiltering?: boolean; + + /** Gets or sets a value that indicates whether to enable the dynamic sorting behavior on grid data. Sorting can be done through clicking on particular column header. + * @Default {false} + */ + allowSorting?: boolean; + + /** Gets or sets a value that indicates whether to enable multi columns sorting behavior in grid. Sort multiple columns by holding CTRL and click on the corresponding column header. + * @Default {false} + */ + allowMultiSorting?: boolean; + + /** This specifies the grid to show the paginated data. Also enables pager control at the bottom of grid for dynamic navigation through data source. + * Paging can be further customized through Ă¢â‚¬Å“pageSettingsĂ¢â‚¬Â property. + * @Default {false} + */ + allowPaging?: boolean; + + /** Gets or sets a value that indicates whether to enable the columns reordering behavior in the grid. Reordering can be done through by drag and drop the particular column + * from one index to another index within the grid. + * @Default {false} + */ + allowReordering?: boolean; + + /** Gets or sets a value that indicates whether the column is non resizable. Column width is set automatically based on the content or header text which is large. + * @Default {false} + */ + allowResizeToFit?: boolean; + + /** Gets or sets a value that indicates whether to enable dynamic resizable of columns. Resize the width of the columns by simply click and move the particular column header line + * @Default {false} + */ + allowResizing?: boolean; + + /** Gets or sets a value that indicates whether to enable the rows reordering in Grid and drag & drop rows between multiple Grid. + * @Default {false} + */ + allowRowDragAndDrop?: boolean; + + /** Gets or sets a value that indicates whether to enable the scrollbar in the grid and view the records by scroll through the grid manually + * @Default {false} + */ + allowScrolling?: boolean; + + /** Gets or sets a value that indicates whether to enable dynamic searching behavior in grid. Currently search box can be enabled through Ă¢â‚¬Å“toolbarSettingsĂ¢â‚¬Â + * @Default {false} + */ + allowSearching?: boolean; + + /** Gets or sets a value that indicates whether user can select rows on grid. On enabling feature, selected row will be highlighted. + * @Default {true} + */ + allowSelection?: boolean; + + /** Gets or sets a value that indicates whether the Content will wrap to the next line if the content exceeds the boundary of the Column Cells. + * @Default {false} + */ + allowTextWrap?: boolean; + + /** Gets or sets a value that indicates whether to enable the multiple exporting behavior on grid data. + * @Default {false} + */ + allowMultipleExporting?: boolean; + + /** Gets or sets a value that indicates to define common width for all the columns in the grid. + */ + commonWidth?: number; + + /** Gets or sets a value that indicates to enable the visibility of the grid lines. + * @Default {ej.Grid.GridLines.Both} + */ + gridLines?: ej.Grid.GridLines | string; + + /** This specifies the grid to add the grid control inside the grid row of the parent with expand/collapse options + * @Default {null} + */ + childGrid?: any; + + /** Used to enable or disable static width settings for column. If the columnLayout is set as fixed, then column width will be static. + * @Default {ej.Grid.ColumnLayout.Auto} + */ + columnLayout?: ej.Grid.ColumnLayout | string; + + /** Gets or sets an object that indicates to render the grid with specified columns + * @Default {[]} + */ + columns?: Column[]; + + /** Gets or sets an object that indicates whether to customize the context menu behavior of the grid. + */ + contextMenuSettings?: ContextMenuSettings; + + /** Gets or sets a value that indicates to render the grid with custom theme. + */ + cssClass?: string; + + /** Gets or sets the data to render the grid with records + * @Default {null} + */ + dataSource?: any; + + /** Default Value: + * @Default {null} + */ + detailsTemplate?: string; + + /** Gets or sets an object that indicates whether to customize the editing behavior of the grid. + */ + editSettings?: EditSettings; + + /** Gets or sets a value that indicates whether to enable the alternative rows differentiation in the grid records based on corresponding theme. + * @Default {true} + */ + enableAltRow?: boolean; + + /** Gets or sets a value that indicates whether to enable the save action in the grid through row selection + * @Default {true} + */ + enableAutoSaveOnSelectionChange?: boolean; + + /** Gets or sets a value that indicates whether to enable mouse over effect on the corresponding column header cell of the grid + * @Default {false} + */ + enableHeaderHover?: boolean; + + /** Gets or sets a value that indicates whether to persist the grid model state in page using applicable medium i.e., HTML5 localStorage or cookies + * @Default {false} + */ + enablePersistence?: boolean; + + /** Gets or sets a value that indicates whether the grid rows has to be rendered as detail view in mobile mode + * @Default {false} + */ + enableResponsiveRow?: boolean; + + /** Gets or sets a value that indicates whether to enable mouse over effect on corresponding grid row. + * @Default {true} + */ + enableRowHover?: boolean; + + /** Align content in the grid control from right to left by setting the property as true. + * @Default {false} + */ + enableRTL?: boolean; + + /** To Disable the mouse swipe property as false. + * @Default {true} + */ + enableTouch?: boolean; + + /** It sets a value that indicates whether to enable toolbar items, when allowEditing, allowAdding and allowDeleting property set as false in the grid. + * @Default {false} + */ + enableToolbarItems?: boolean; + + /** Act as mapper for the excel exporting URL. + * @Default {ExportToExcel} + */ + exportToExcelAction?: string; + + /** Act as mapper for the PDF exporting URL. + * @Default {ExportToPdf} + */ + exportToPdfAction?: string; + + /** Act as mapper for the Word exporting URL. + * @Default {ExportToWord} + */ + exportToWordAction?: string; + + /** Gets or sets an object that indicates whether to customize the filtering behavior of the grid + */ + filterSettings?: FilterSettings; + + /** Gets or sets an object that indicates whether to customize the grouping behavior of the grid. + */ + groupSettings?: GroupSettings; + + /** Gets or sets a value that indicates whether the grid design has be to made responsive. + * @Default {false} + */ + isResponsive?: boolean; + + /** This specifies to change the key in keyboard interaction to grid control + * @Default {null} + */ + keySettings?: any; + + /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data i.e. in a language and + * culture specific to a particular country or region. + * @Default {en-US} + */ + locale?: string; + + /** Gets or sets a value that indicates whether to set the minimum width of the responsive grid while isResponsive property is true and enableResponsiveRow property is set as false. + * @Default {0} + */ + minWidth?: number; + + /** Gets or sets an object that indicates whether to modify the pager default configuration. + */ + pageSettings?: PageSettings; + + /** Query the dataSource from the table for Grid. + * @Default {null} + */ + query?: any; + + /** Gets or sets an object that indicates whether to modify the resizing behavior. + */ + resizeSettings?: ResizeSettings; + + /** Gets or sets a value that indicates to render the grid with template rows. The template row must be a table row. That table row must have the JavaScript render binding format ({{:columnName}}) + * then the grid data source binds the data to the corresponding table row of the template. + * @Default {null} + */ + rowTemplate?: string; + + /** Gets or sets an object that indicates whether to customize the drag and drop behavior of the grid rows + */ + rowDropSettings?: RowDropSettings; + + /** Gets or sets an object that indicates whether to customize the searching behavior of the grid + */ + searchSettings?: SearchSettings; + + /** Gets a value that indicates whether the grid model to hold multiple selected records . selectedRecords can be used to displayed hold the single + * or multiple selected records using Ă¢â‚¬Å“selectedRecordsĂ¢â‚¬Â property + * @Default {null} + */ + selectedRecords?: any[]; + + /** Gets or sets a value that indicates to select the row while initializing the grid + * @Default {-1} + */ + selectedRowIndex?: number; + + /** Gets or sets a value that indicates the selected rows in grid + * @Default {[]} + */ + selectedRowIndices?: any[]; + + /** This property is used to configure the selection behavior of the grid. + */ + selectionSettings?: SelectionSettings; + + /** The row selection behavior of grid. Accepting types are "single" and "multiple". + * @Default {ej.Grid.SelectionType.Single} + */ + selectionType?: ej.Grid.SelectionType | string; + + /** Gets or sets an object that indicates whether to customize the scrolling behavior of the grid. + */ + scrollSettings?: ScrollSettings; - /** Default Value: - * @Default {false} - */ - showColumnChooser?: boolean; + /** Default Value: + * @Default {false} + */ + showColumnChooser?: boolean; - /** Gets or sets a value that indicates stacked header should be shown on grid layout when the property Ă¢â‚¬Å“stackedHeaderRowsĂ¢â‚¬Â is set. - * @Default {false} - */ - showStackedHeader?: boolean; + /** Gets or sets a value that indicates stacked header should be shown on grid layout when the property Ă¢â‚¬Å“stackedHeaderRowsĂ¢â‚¬Â is set. + * @Default {false} + */ + showStackedHeader?: boolean; - /** Gets or sets a value that indicates summary rows should be shown on grid layout when the property Ă¢â‚¬Å“summaryRowsĂ¢â‚¬Â is set - * @Default {false} - */ - showSummary?: boolean; + /** Gets or sets a value that indicates summary rows should be shown on grid layout when the property Ă¢â‚¬Å“summaryRowsĂ¢â‚¬Â is set + * @Default {false} + */ + showSummary?: boolean; - /** Gets or sets a value that indicates whether to customize the sorting behavior of the grid. - */ - sortSettings?: SortSettings; + /** Gets or sets a value that indicates whether to customize the sorting behavior of the grid. + */ + sortSettings?: SortSettings; - /** Gets or sets an object that indicates to managing the collection of stacked header rows for the grid. - * @Default {[]} - */ - stackedHeaderRows?: StackedHeaderRow[]; + /** Gets or sets an object that indicates to managing the collection of stacked header rows for the grid. + * @Default {[]} + */ + stackedHeaderRows?: StackedHeaderRow[]; - /** Gets or sets an object that indicates to managing the collection of summary rows for the grid. - * @Default {[]} - */ - summaryRows?: SummaryRow[]; + /** Gets or sets an object that indicates to managing the collection of summary rows for the grid. + * @Default {[]} + */ + summaryRows?: SummaryRow[]; - /** Gets or sets an object that indicates whether to auto wrap the grid header or content or both - */ - textWrapSettings?: TextWrapSettings; + /** Gets or sets an object that indicates whether to auto wrap the grid header or content or both + */ + textWrapSettings?: TextWrapSettings; - /** Gets or sets an object that indicates whether to enable the toolbar in the grid and add toolbar items - */ - toolbarSettings?: ToolbarSettings; + /** Gets or sets an object that indicates whether to enable the toolbar in the grid and add toolbar items + */ + toolbarSettings?: ToolbarSettings; - /** Triggered for every grid action before its starts. */ - actionBegin?(e: ActionBeginEventArgs): void; + /** Triggered for every grid action before its starts. */ + actionBegin?(e: ActionBeginEventArgs): void; - /** Triggered for every grid action success event. */ - actionComplete?(e: ActionCompleteEventArgs): void; + /** Triggered for every grid action success event. */ + actionComplete?(e: ActionCompleteEventArgs): void; - /** Triggered for every grid action server failure event. */ - actionFailure?(e: ActionFailureEventArgs): void; + /** Triggered for every grid action server failure event. */ + actionFailure?(e: ActionFailureEventArgs): void; - /** Triggered when record batch add. */ - batchAdd?(e: BatchAddEventArgs): void; + /** Triggered when record batch add. */ + batchAdd?(e: BatchAddEventArgs): void; - /** Triggered when record batch delete. */ - batchDelete?(e: BatchDeleteEventArgs): void; + /** Triggered when record batch delete. */ + batchDelete?(e: BatchDeleteEventArgs): void; - /** Triggered before the batch add. */ - beforeBatchAdd?(e: BeforeBatchAddEventArgs): void; + /** Triggered before the batch add. */ + beforeBatchAdd?(e: BeforeBatchAddEventArgs): void; - /** Triggered before the batch delete. */ - beforeBatchDelete?(e: BeforeBatchDeleteEventArgs): void; + /** Triggered before the batch delete. */ + beforeBatchDelete?(e: BeforeBatchDeleteEventArgs): void; - /** Triggered before the batch save. */ - beforeBatchSave?(e: BeforeBatchSaveEventArgs): void; + /** Triggered before the batch save. */ + beforeBatchSave?(e: BeforeBatchSaveEventArgs): void; - /** Triggered before the print. */ - beforePrint?(e: BeforePrintEventArgs): void; + /** Triggered before the print. */ + beforePrint?(e: BeforePrintEventArgs): void; - /** Triggered before row drop in the grid */ - beforeRowDrop?(e: BeforeRowDropEventArgs): void; + /** Triggered before row drop in the grid */ + beforeRowDrop?(e: BeforeRowDropEventArgs): void; - /** Triggered before the record is going to be edited. */ - beginEdit?(e: BeginEditEventArgs): void; + /** Triggered before the record is going to be edited. */ + beginEdit?(e: BeginEditEventArgs): void; - /** Triggered when record cell edit. */ - cellEdit?(e: CellEditEventArgs): void; + /** Triggered when record cell edit. */ + cellEdit?(e: CellEditEventArgs): void; - /** Triggered when record cell save. */ - cellSave?(e: CellSaveEventArgs): void; + /** Triggered when record cell save. */ + cellSave?(e: CellSaveEventArgs): void; - /** Triggered after the cell is selected. */ - cellSelected?(e: CellSelectedEventArgs): void; + /** Triggered after the cell is selected. */ + cellSelected?(e: CellSelectedEventArgs): void; - /** Triggered before the cell is going to be selected. */ - cellSelecting?(e: CellSelectingEventArgs): void; + /** Triggered before the cell is going to be selected. */ + cellSelecting?(e: CellSelectingEventArgs): void; - /** Triggered after the cell is deselected. */ - cellDeselected?(e: CellDeselectedEventArgs): void; + /** Triggered after the cell is deselected. */ + cellDeselected?(e: CellDeselectedEventArgs): void; - /** Triggered before the cell is going to be deselected. */ - cellDeselecting?(e: CellDeselectingEventArgs): void; + /** Triggered before the cell is going to be deselected. */ + cellDeselecting?(e: CellDeselectingEventArgs): void; - /** Triggered when the column is being dragged. */ - columnDrag?(e: ColumnDragEventArgs): void; + /** Triggered when the column is being dragged. */ + columnDrag?(e: ColumnDragEventArgs): void; - /** Triggered when column dragging begins. */ - columnDragStart?(e: ColumnDragStartEventArgs): void; + /** Triggered when column dragging begins. */ + columnDragStart?(e: ColumnDragStartEventArgs): void; - /** Triggered when the column is dropped. */ - columnDrop?(e: ColumnDropEventArgs): void; + /** Triggered when the column is dropped. */ + columnDrop?(e: ColumnDropEventArgs): void; - /** Triggered when the row is being dragged. */ - rowDrag?(e: RowDragEventArgs): void; + /** Triggered when the row is being dragged. */ + rowDrag?(e: RowDragEventArgs): void; - /** Triggered when row dragging begins. */ - rowDragStart?(e: RowDragStartEventArgs): void; + /** Triggered when row dragging begins. */ + rowDragStart?(e: RowDragStartEventArgs): void; - /** Triggered when the row is dropped. */ - rowDrop?(e: RowDropEventArgs): void; + /** Triggered when the row is dropped. */ + rowDrop?(e: RowDropEventArgs): void; - /** Triggered after the column is selected. */ - columnSelected?(e: ColumnSelectedEventArgs): void; + /** Triggered after the column is selected. */ + columnSelected?(e: ColumnSelectedEventArgs): void; - /** Triggered before the column is going to be selected. */ - columnSelecting?(e: ColumnSelectingEventArgs): void; + /** Triggered before the column is going to be selected. */ + columnSelecting?(e: ColumnSelectingEventArgs): void; - /** Triggered after the column is deselected. */ - columnDeselected?(e: ColumnDeselectedEventArgs): void; + /** Triggered after the column is deselected. */ + columnDeselected?(e: ColumnDeselectedEventArgs): void; - /** Triggered before the column is going to be deselected. */ - columnDeselecting?(e: ColumnDeselectingEventArgs): void; + /** Triggered before the column is going to be deselected. */ + columnDeselecting?(e: ColumnDeselectingEventArgs): void; - /** Triggered when context menu item is clicked */ - contextClick?(e: ContextClickEventArgs): void; + /** Triggered when context menu item is clicked */ + contextClick?(e: ContextClickEventArgs): void; - /** Triggered before the context menu is opened. */ - contextOpen?(e: ContextOpenEventArgs): void; + /** Triggered before the context menu is opened. */ + contextOpen?(e: ContextOpenEventArgs): void; - /** Triggered when the grid is rendered completely. */ - create?(e: CreateEventArgs): void; + /** Triggered when the grid is rendered completely. */ + create?(e: CreateEventArgs): void; - /** Triggered when the grid is bound with data during initial rendering. */ - dataBound?(e: DataBoundEventArgs): void; + /** Triggered when the grid is bound with data during initial rendering. */ + dataBound?(e: DataBoundEventArgs): void; - /** Triggered when grid going to destroy. */ - destroy?(e: DestroyEventArgs): void; + /** Triggered when grid going to destroy. */ + destroy?(e: DestroyEventArgs): void; - /** Triggered when detail template row is clicked to collapse. */ - detailsCollapse?(e: DetailsCollapseEventArgs): void; + /** Triggered when detail template row is clicked to collapse. */ + detailsCollapse?(e: DetailsCollapseEventArgs): void; - /** Triggered detail template row is initialized. */ - detailsDataBound?(e: DetailsDataBoundEventArgs): void; + /** Triggered detail template row is initialized. */ + detailsDataBound?(e: DetailsDataBoundEventArgs): void; - /** Triggered when detail template row is clicked to expand. */ - detailsExpand?(e: DetailsExpandEventArgs): void; + /** Triggered when detail template row is clicked to expand. */ + detailsExpand?(e: DetailsExpandEventArgs): void; - /** Triggered after the record is added. */ - endAdd?(e: EndAddEventArgs): void; + /** Triggered after the record is added. */ + endAdd?(e: EndAddEventArgs): void; - /** Triggered after the record is deleted. */ - endDelete?(e: EndDeleteEventArgs): void; + /** Triggered after the record is deleted. */ + endDelete?(e: EndDeleteEventArgs): void; - /** Triggered after the record is edited. */ - endEdit?(e: EndEditEventArgs): void; + /** Triggered after the record is edited. */ + endEdit?(e: EndEditEventArgs): void; - /** Triggered initial load. */ - load?(e: LoadEventArgs): void; + /** Triggered initial load. */ + load?(e: LoadEventArgs): void; - /** Triggered every time a request is made to access particular cell information, element and data. */ - mergeCellInfo?(e: MergeCellInfoEventArgs): void; + /** Triggered every time a request is made to access particular cell information, element and data. */ + mergeCellInfo?(e: MergeCellInfoEventArgs): void; - /** Triggered every time a request is made to access particular cell information, element and data. */ - queryCellInfo?(e: QueryCellInfoEventArgs): void; + /** Triggered every time a request is made to access particular cell information, element and data. */ + queryCellInfo?(e: QueryCellInfoEventArgs): void; - /** Triggered when record is clicked. */ - recordClick?(e: RecordClickEventArgs): void; + /** Triggered when record is clicked. */ + recordClick?(e: RecordClickEventArgs): void; - /** Triggered when record is double clicked. */ - recordDoubleClick?(e: RecordDoubleClickEventArgs): void; + /** Triggered when record is double clicked. */ + recordDoubleClick?(e: RecordDoubleClickEventArgs): void; - /** Triggered after column resized. */ - resized?(e: ResizedEventArgs): void; + /** Triggered after column resized. */ + resized?(e: ResizedEventArgs): void; - /** Triggered when column resize end. */ - resizeEnd?(e: ResizeEndEventArgs): void; + /** Triggered when column resize end. */ + resizeEnd?(e: ResizeEndEventArgs): void; - /** Triggered when column resize start. */ - resizeStart?(e: ResizeStartEventArgs): void; + /** Triggered when column resize start. */ + resizeStart?(e: ResizeStartEventArgs): void; - /** Triggered when right clicked on grid element. */ - rightClick?(e: RightClickEventArgs): void; + /** Triggered when right clicked on grid element. */ + rightClick?(e: RightClickEventArgs): void; - /** Triggered every time a request is made to access row information, element and data. */ - rowDataBound?(e: RowDataBoundEventArgs): void; + /** Triggered every time a request is made to access row information, element and data. */ + rowDataBound?(e: RowDataBoundEventArgs): void; - /** Triggered after the row is selected. */ - rowSelected?(e: RowSelectedEventArgs): void; + /** Triggered after the row is selected. */ + rowSelected?(e: RowSelectedEventArgs): void; - /** Triggered before the row is going to be selected. */ - rowSelecting?(e: RowSelectingEventArgs): void; + /** Triggered before the row is going to be selected. */ + rowSelecting?(e: RowSelectingEventArgs): void; - /** Triggered after the row is deselected. */ - rowDeselected?(e: RowDeselectedEventArgs): void; + /** Triggered after the row is deselected. */ + rowDeselected?(e: RowDeselectedEventArgs): void; - /** Triggered before the row is going to be deselected. */ - rowDeselecting?(e: RowDeselectingEventArgs): void; + /** Triggered before the row is going to be deselected. */ + rowDeselecting?(e: RowDeselectingEventArgs): void; - /** Triggered when refresh the template column elements in the Grid. */ - templateRefresh?(e: TemplateRefreshEventArgs): void; + /** Triggered when refresh the template column elements in the Grid. */ + templateRefresh?(e: TemplateRefreshEventArgs): void; - /** Triggered when toolbar item is clicked in grid. */ - toolbarClick?(e: ToolbarClickEventArgs): void; -} + /** Triggered when toolbar item is clicked in grid. */ + toolbarClick?(e: ToolbarClickEventArgs): void; + } -export interface ActionBeginEventArgs { + export interface ActionBeginEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the current selected page number. - */ - currentPage?: number; + /** Returns the current selected page number. + */ + currentPage?: number; - /** Returns the previous selected page number. - */ - previousPage?: number; + /** Returns the previous selected page number. + */ + previousPage?: number; - /** Returns the end row index of that current page. - */ - endIndex?: number; + /** Returns the end row index of that current page. + */ + endIndex?: number; - /** Returns request type. - */ - requestType?: string; + /** Returns request type. + */ + requestType?: string; - /** Returns the start row index of that current page. - */ - startIndex?: number; + /** Returns the start row index of that current page. + */ + startIndex?: number; - /** Returns the current grouped column field name. - */ - columnName?: string; + /** Returns the current grouped column field name. + */ + columnName?: string; - /** Returns the column sort direction. - */ - columnSortDirection?: string; + /** Returns the column sort direction. + */ + columnSortDirection?: string; - /** Returns current edited row. - */ - row?: any; + /** Returns current edited row. + */ + row?: any; - /** Returns the current action event type. - */ - originalEventType?: string; + /** Returns the current action event type. + */ + originalEventType?: string; - /** Returns primary key. - */ - primaryKey?: string; + /** Returns primary key. + */ + primaryKey?: string; - /** Returns primary key value. - */ - primaryKeyValue?: string; + /** Returns primary key value. + */ + primaryKeyValue?: string; - /** Returns the edited row index. - */ - rowIndex?: number; + /** Returns the edited row index. + */ + rowIndex?: number; - /** Returns the record object (JSON). - */ - data?: any; + /** Returns the record object (JSON). + */ + data?: any; - /** Returns the foreign key record object (JSON). - */ - foreignKeyData?: any; + /** Returns the foreign key record object (JSON). + */ + foreignKeyData?: any; - /** Returns the selected row index. - */ - selectedRow?: number; + /** Returns the selected row index. + */ + selectedRow?: number; - /** Returns selected row for delete. - */ - tr?: any; + /** Returns selected row for delete. + */ + tr?: any; - /** Returns current filtering column field name. - */ - currentFilteringColumn?: any; + /** Returns current filtering column field name. + */ + currentFilteringColumn?: any; - /** Returns current filtering object. - */ - currentFilterObject?: any; + /** Returns current filtering object. + */ + currentFilterObject?: any; - /** Returns filter details. - */ - filterCollection?: any; + /** Returns filter details. + */ + filterCollection?: any; - /** Returns type of the column like number, string and so on. - */ - columnType?: string; + /** Returns type of the column like number, string and so on. + */ + columnType?: string; - /** Returns the excel filter model. - */ - filtermodel?: any; + /** Returns the excel filter model. + */ + filtermodel?: any; - /** Returns the dataSource. - */ - dataSource?: any; + /** Returns the dataSource. + */ + dataSource?: any; - /** Returns the query manager. - */ - query?: any; + /** Returns the query manager. + */ + query?: any; - /** Returns the customfilter option value. - */ - isCustomFilter?: boolean; -} + /** Returns the customfilter option value. + */ + isCustomFilter?: boolean; + } -export interface ActionCompleteEventArgs { + export interface ActionCompleteEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns request type. - */ - requestType?: string; + /** Returns request type. + */ + requestType?: string; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the current selected page number. - */ - currentPage?: number; + /** Returns the current selected page number. + */ + currentPage?: number; - /** Returns the previous selected page number. - */ - previousPage?: number; + /** Returns the previous selected page number. + */ + previousPage?: number; - /** Returns the end row index of that current page. - */ - endIndex?: number; + /** Returns the end row index of that current page. + */ + endIndex?: number; - /** Returns current action event type. - */ - originalEventType?: string; + /** Returns current action event type. + */ + originalEventType?: string; - /** Returns the start row index of the current page. - */ - startIndex?: number; + /** Returns the start row index of the current page. + */ + startIndex?: number; - /** Returns grid element. - */ - target?: any; + /** Returns grid element. + */ + target?: any; - /** Returns the current sorted column field name. - */ - columnName?: string; + /** Returns the current sorted column field name. + */ + columnName?: string; - /** Returns the column sort direction. - */ - columnSortDirection?: string; + /** Returns the column sort direction. + */ + columnSortDirection?: string; - /** Returns current edited row. - */ - row?: any; + /** Returns current edited row. + */ + row?: any; - /** Returns primary key. - */ - primaryKey?: string; + /** Returns primary key. + */ + primaryKey?: string; - /** Returns primary key value. - */ - primaryKeyValue?: string; + /** Returns primary key value. + */ + primaryKeyValue?: string; - /** Returns the edited row index. - */ - rowIndex?: number; + /** Returns the edited row index. + */ + rowIndex?: number; - /** Returns the record object (JSON). - */ - data?: any; + /** Returns the record object (JSON). + */ + data?: any; - /** Returns the selectedRow index. - */ - selectedRow?: number; + /** Returns the selectedRow index. + */ + selectedRow?: number; - /** Returns the foreign key record object (JSON). - */ - foreignKeyData?: any; + /** Returns the foreign key record object (JSON). + */ + foreignKeyData?: any; - /** Returns selected row for delete. - */ - tr?: any; + /** Returns selected row for delete. + */ + tr?: any; - /** Returns current filtering column field name. - */ - currentFilteringColumn?: string; + /** Returns current filtering column field name. + */ + currentFilteringColumn?: string; - /** Returns current filtering object. - */ - currentFilterObject?: any; + /** Returns current filtering object. + */ + currentFilterObject?: any; - /** Returns filter details. - */ - filterCollection?: any; + /** Returns filter details. + */ + filterCollection?: any; - /** Returns the dataSource. - */ - dataSource?: any; + /** Returns the dataSource. + */ + dataSource?: any; - /** Returns the excel filter model. - */ - filtermodel?: any; + /** Returns the excel filter model. + */ + filtermodel?: any; - /** Returns type of the column like number, string and so on. - */ - columnType?: string; + /** Returns type of the column like number, string and so on. + */ + columnType?: string; - /** Returns the customfilter option value. - */ - isCustomFilter?: boolean; -} + /** Returns the customfilter option value. + */ + isCustomFilter?: boolean; + } -export interface ActionFailureEventArgs { + export interface ActionFailureEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns request type. - */ - requestType?: string; + /** Returns request type. + */ + requestType?: string; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the error return by server. - */ - error?: any; + /** Returns the error return by server. + */ + error?: any; - /** Returns the current selected page number. - */ - currentPage?: number; + /** Returns the current selected page number. + */ + currentPage?: number; - /** Returns the previous selected page number. - */ - previousPage?: number; + /** Returns the previous selected page number. + */ + previousPage?: number; - /** Returns the end row index of that current page. - */ - endIndex?: number; + /** Returns the end row index of that current page. + */ + endIndex?: number; - /** Returns current action event type. - */ - originalEventType?: string; + /** Returns current action event type. + */ + originalEventType?: string; - /** Returns the start row index of the current page. - */ - startIndex?: number; + /** Returns the start row index of the current page. + */ + startIndex?: number; - /** Returns grid element. - */ - target?: any; + /** Returns grid element. + */ + target?: any; - /** Returns the current sorted column field name. - */ - columnName?: string; + /** Returns the current sorted column field name. + */ + columnName?: string; - /** Returns the column sort direction. - */ - columnSortDirection?: string; + /** Returns the column sort direction. + */ + columnSortDirection?: string; - /** Returns current edited row. - */ - row?: any; + /** Returns current edited row. + */ + row?: any; - /** Returns primary key. - */ - primaryKey?: string; + /** Returns primary key. + */ + primaryKey?: string; - /** Returns primary key value. - */ - primaryKeyValue?: string; + /** Returns primary key value. + */ + primaryKeyValue?: string; - /** Returns the edited row index. - */ - rowIndex?: number; + /** Returns the edited row index. + */ + rowIndex?: number; - /** Returns the record object (JSON). - */ - data?: any; + /** Returns the record object (JSON). + */ + data?: any; - /** Returns the selectedRow index. - */ - selectedRow?: number; + /** Returns the selectedRow index. + */ + selectedRow?: number; - /** Returns the foreign key record object (JSON). - */ - foreignKeyData?: any; + /** Returns the foreign key record object (JSON). + */ + foreignKeyData?: any; - /** Returns selected row for delete. - */ - tr?: any; + /** Returns selected row for delete. + */ + tr?: any; - /** Returns current filtering column field name. - */ - currentFilteringColumn?: string; + /** Returns current filtering column field name. + */ + currentFilteringColumn?: string; - /** Returns current filtering object. - */ - currentFilterObject?: any; + /** Returns current filtering object. + */ + currentFilterObject?: any; - /** Returns filter details. - */ - filterCollection?: any; -} + /** Returns filter details. + */ + filterCollection?: any; + } -export interface BatchAddEventArgs { + export interface BatchAddEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns deleted data. - */ - data?: any; + /** Returns deleted data. + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the column object. - */ - columnObject?: any; + /** Returns the column object. + */ + columnObject?: any; - /** Returns the column index. - */ - columnIndex?: number; + /** Returns the column index. + */ + columnIndex?: number; - /** Returns the row element. - */ - row?: any; + /** Returns the row element. + */ + row?: any; - /** Returns the primaryKey. - */ - primaryKey?: any; + /** Returns the primaryKey. + */ + primaryKey?: any; - /** Returns the cell object. - */ - cell?: any; -} + /** Returns the cell object. + */ + cell?: any; + } -export interface BatchDeleteEventArgs { + export interface BatchDeleteEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns deleted data. - */ - data?: any; + /** Returns deleted data. + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the primary key. - */ - primaryKey?: any; + /** Returns the primary key. + */ + primaryKey?: any; - /** Returns the row Index. - */ - rowIndex?: number; -} + /** Returns the row Index. + */ + rowIndex?: number; + } -export interface BeforeBatchAddEventArgs { + export interface BeforeBatchAddEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns deleted data. - */ - data?: any; + /** Returns deleted data. + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the default data object. - */ - defaultData?: any; + /** Returns the default data object. + */ + defaultData?: any; - /** Returns the primaryKey. - */ - primaryKey?: any; -} + /** Returns the primaryKey. + */ + primaryKey?: any; + } -export interface BeforeBatchDeleteEventArgs { + export interface BeforeBatchDeleteEventArgs { - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns deleted data. - */ - data?: any; + /** Returns deleted data. + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the primaryKey. - */ - primaryKey?: any; + /** Returns the primaryKey. + */ + primaryKey?: any; - /** Returns the row index. - */ - rowIndex?: number; + /** Returns the row index. + */ + rowIndex?: number; - /** Returns the row data. - */ - rowData?: any; + /** Returns the row data. + */ + rowData?: any; - /** Returns the row element. - */ - row?: any; -} + /** Returns the row element. + */ + row?: any; + } -export interface BeforeBatchSaveEventArgs { + export interface BeforeBatchSaveEventArgs { - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns deleted data. - */ - data?: any; + /** Returns deleted data. + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the changed record object. - */ - batchChanges?: any; -} + /** Returns the changed record object. + */ + batchChanges?: any; + } -export interface BeforePrintEventArgs { + export interface BeforePrintEventArgs { - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the Grid element. - */ - element?: any; + /** Returns the Grid element. + */ + element?: any; - /** Returns the selected records. - */ - selectedRows?: any; -} + /** Returns the selected records. + */ + selectedRows?: any; + } -export interface BeforeRowDropEventArgs { + export interface BeforeRowDropEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the targeted row. - */ - target?: any; + /** Returns the targeted row. + */ + target?: any; - /** Returns the targeted row index. - */ - targetIndex?: any; + /** Returns the targeted row index. + */ + targetIndex?: any; - /** Returns the dragged record details - */ - draggedRecords?: any; + /** Returns the dragged record details + */ + draggedRecords?: any; - /** Returns the drop details - */ - dropDetails?: any; -} + /** Returns the drop details + */ + dropDetails?: any; + } -export interface BeginEditEventArgs { + export interface BeginEditEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the current edited row. - */ - row?: any; + /** Returns the current edited row. + */ + row?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the primary key. - */ - primaryKey?: any; + /** Returns the primary key. + */ + primaryKey?: any; - /** Returns the primary key value. - */ - primaryKeyValue?: any; + /** Returns the primary key value. + */ + primaryKeyValue?: any; - /** Returns the edited row index. - */ - rowIndex?: number; + /** Returns the edited row index. + */ + rowIndex?: number; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface CellEditEventArgs { + export interface CellEditEventArgs { - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns deleted data. - */ - data?: any; + /** Returns deleted data. + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the validation rules. - */ - validationRules?: any; + /** Returns the validation rules. + */ + validationRules?: any; - /** Returns the column name. - */ - columnName?: string; + /** Returns the column name. + */ + columnName?: string; - /** Returns the cell value. - */ - value?: string; + /** Returns the cell value. + */ + value?: string; - /** Returns the row data object. - */ - rowData?: any; + /** Returns the row data object. + */ + rowData?: any; - /** Returns the previous value of the cell. - */ - previousValue?: string; + /** Returns the previous value of the cell. + */ + previousValue?: string; - /** Returns the column object. - */ - columnObject?: any; + /** Returns the column object. + */ + columnObject?: any; - /** Returns the cell object. - */ - cell?: any; + /** Returns the cell object. + */ + cell?: any; - /** Returns isForeignKey option value. - */ - isForeignKey?: boolean; -} + /** Returns isForeignKey option value. + */ + isForeignKey?: boolean; + } -export interface CellSaveEventArgs { + export interface CellSaveEventArgs { - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns deleted data. - */ - data?: any; + /** Returns deleted data. + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the column name. - */ - columnName?: string; + /** Returns the column name. + */ + columnName?: string; - /** Returns the cell value. - */ - value?: string; + /** Returns the cell value. + */ + value?: string; - /** Returns the row data object. - */ - rowData?: any; + /** Returns the row data object. + */ + rowData?: any; - /** Returns the previous value of the cell. - */ - previousValue?: string; + /** Returns the previous value of the cell. + */ + previousValue?: string; - /** Returns the column object. - */ - columnObject?: any; + /** Returns the column object. + */ + columnObject?: any; - /** Returns the cell object. - */ - cell?: any; + /** Returns the cell object. + */ + cell?: any; - /** Returns isForeignKey option value. - */ - isForeignKey?: boolean; -} + /** Returns isForeignKey option value. + */ + isForeignKey?: boolean; + } -export interface CellSelectedEventArgs { + export interface CellSelectedEventArgs { - /** Returns the selected cell index value. - */ - cellIndex?: number; + /** Returns the selected cell index value. + */ + cellIndex?: number; - /** Returns the previous selected cell index value. - */ - previousRowCellIndex?: number; + /** Returns the previous selected cell index value. + */ + previousRowCellIndex?: number; - /** Returns the selected cell element. - */ - currentCell?: any; + /** Returns the selected cell element. + */ + currentCell?: any; - /** Returns the previous selected cell element. - */ - previousRowCell?: any; + /** Returns the previous selected cell element. + */ + previousRowCell?: any; - /** Returns current record object (JSON). - */ - data?: any; + /** Returns current record object (JSON). + */ + data?: any; - /** Returns the selected row cell index values. - */ - selectedRowCellIndex?: any[]; + /** Returns the selected row cell index values. + */ + selectedRowCellIndex?: any[]; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface CellSelectingEventArgs { + export interface CellSelectingEventArgs { - /** Returns the selected cell index value. - */ - cellIndex?: number; + /** Returns the selected cell index value. + */ + cellIndex?: number; - /** Returns the previous selected cell index value. - */ - previousRowCellIndex?: number; + /** Returns the previous selected cell index value. + */ + previousRowCellIndex?: number; - /** Returns the selected cell element. - */ - currentCell?: any; + /** Returns the selected cell element. + */ + currentCell?: any; - /** Returns the previous selected cell element. - */ - previousRowCell?: any; + /** Returns the previous selected cell element. + */ + previousRowCell?: any; - /** Returns current record object (JSON). - */ - data?: any; + /** Returns current record object (JSON). + */ + data?: any; - /** Returns whether the ctrl key is pressed while selecting cell - */ - isCtrlKeyPressed?: boolean; + /** Returns whether the ctrl key is pressed while selecting cell + */ + isCtrlKeyPressed?: boolean; - /** Returns whether the shift key is pressed while selecting cell - */ - isShiftKeyPressed?: boolean; + /** Returns whether the shift key is pressed while selecting cell + */ + isShiftKeyPressed?: boolean; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface CellDeselectedEventArgs { + export interface CellDeselectedEventArgs { - /** Returns the deselected cell index value. - */ - cellIndex?: number; + /** Returns the deselected cell index value. + */ + cellIndex?: number; - /** Returns the deselected cell element. - */ - currentCell?: any; + /** Returns the deselected cell element. + */ + currentCell?: any; - /** Returns current record object (JSON). - */ - data?: any; + /** Returns current record object (JSON). + */ + data?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface CellDeselectingEventArgs { + export interface CellDeselectingEventArgs { - /** Returns the deselecting cell index value. - */ - cellIndex?: number; + /** Returns the deselecting cell index value. + */ + cellIndex?: number; - /** Returns the deselecting cell element. - */ - currentCell?: any; + /** Returns the deselecting cell element. + */ + currentCell?: any; - /** Returns current record object (JSON). - */ - data?: any; + /** Returns current record object (JSON). + */ + data?: any; - /** Returns whether the ctrl key is pressed while deselecting cell - */ - isCtrlKeyPressed?: boolean; + /** Returns whether the ctrl key is pressed while deselecting cell + */ + isCtrlKeyPressed?: boolean; - /** Returns whether the shift key is pressed while deselecting cell - */ - isShiftKeyPressed?: boolean; + /** Returns whether the shift key is pressed while deselecting cell + */ + isShiftKeyPressed?: boolean; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface ColumnDragEventArgs { + export interface ColumnDragEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns draggable element type. - */ - draggableType?: any; + /** Returns draggable element type. + */ + draggableType?: any; - /** Returns the draggable column object. - */ - column?: any; + /** Returns the draggable column object. + */ + column?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns target elements based on mouse move position. - */ - target?: any; + /** Returns target elements based on mouse move position. + */ + target?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface ColumnDragStartEventArgs { + export interface ColumnDragStartEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns draggable element type. - */ - draggableType?: any; + /** Returns draggable element type. + */ + draggableType?: any; - /** Returns the draggable column object. - */ - column?: any; + /** Returns the draggable column object. + */ + column?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns drag start element. - */ - target?: any; + /** Returns drag start element. + */ + target?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface ColumnDropEventArgs { + export interface ColumnDropEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns draggable element type. - */ - draggableType?: string; + /** Returns draggable element type. + */ + draggableType?: string; - /** Returns the draggable column object. - */ - column?: any; + /** Returns the draggable column object. + */ + column?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns dropped dragged element. - */ - target?: any; + /** Returns dropped dragged element. + */ + target?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface RowDragEventArgs { + export interface RowDragEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns draggable element type. - */ - draggableType?: any; + /** Returns draggable element type. + */ + draggableType?: any; - /** Returns the draggable row object. - */ - target?: any; + /** Returns the draggable row object. + */ + target?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns target elements based on mouse move position. - */ - currentTarget?: any; + /** Returns target elements based on mouse move position. + */ + currentTarget?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns JSON data of dragged rows. - */ - data?: any; -} + /** Returns JSON data of dragged rows. + */ + data?: any; + } -export interface RowDragStartEventArgs { + export interface RowDragStartEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns draggable element type. - */ - draggableType?: any; + /** Returns draggable element type. + */ + draggableType?: any; - /** Returns the draggable row object. - */ - target?: any; + /** Returns the draggable row object. + */ + target?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns drag start element cell. - */ - currentTarget?: any; + /** Returns drag start element cell. + */ + currentTarget?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the JSON data of dragged rows. - */ - data?: any; -} + /** Returns the JSON data of dragged rows. + */ + data?: any; + } -export interface RowDropEventArgs { + export interface RowDropEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns draggable element type. - */ - draggableType?: string; + /** Returns draggable element type. + */ + draggableType?: string; - /** Returns the draggable row object. - */ - rows?: any; + /** Returns the draggable row object. + */ + rows?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the current mouse position cell element. - */ - target?: any; + /** Returns the current mouse position cell element. + */ + target?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the JSON data of dragged rows. - */ - data?: any; -} + /** Returns the JSON data of dragged rows. + */ + data?: any; + } -export interface ColumnSelectedEventArgs { + export interface ColumnSelectedEventArgs { - /** Returns the selected cell index value. - */ - columnIndex?: number; + /** Returns the selected cell index value. + */ + columnIndex?: number; - /** Returns the previous selected column index value. - */ - previousColumnIndex?: number; + /** Returns the previous selected column index value. + */ + previousColumnIndex?: number; - /** Returns the selected header cell element. - */ - headerCell?: any; + /** Returns the selected header cell element. + */ + headerCell?: any; - /** Returns the previous selected header cell element. - */ - prevColumnHeaderCell?: any; + /** Returns the previous selected header cell element. + */ + prevColumnHeaderCell?: any; - /** Returns corresponding column object (JSON). - */ - column?: any; + /** Returns corresponding column object (JSON). + */ + column?: any; - /** Returns the selected columns values. - */ - selectedColumnsIndex?: any[]; + /** Returns the selected columns values. + */ + selectedColumnsIndex?: any[]; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface ColumnSelectingEventArgs { + export interface ColumnSelectingEventArgs { - /** Returns the selected column index value. - */ - columnIndex?: number; + /** Returns the selected column index value. + */ + columnIndex?: number; - /** Returns the previous selected column index value. - */ - previousColumnIndex?: number; + /** Returns the previous selected column index value. + */ + previousColumnIndex?: number; - /** Returns the selected header cell element. - */ - headerCell?: any; + /** Returns the selected header cell element. + */ + headerCell?: any; - /** Returns the previous selected header cell element. - */ - prevColumnHeaderCell?: any; + /** Returns the previous selected header cell element. + */ + prevColumnHeaderCell?: any; - /** Returns corresponding column object (JSON). - */ - column?: any; + /** Returns corresponding column object (JSON). + */ + column?: any; - /** Returns whether the ctrl key is pressed while selecting cell - */ - isCtrlKeyPressed?: boolean; + /** Returns whether the ctrl key is pressed while selecting cell + */ + isCtrlKeyPressed?: boolean; - /** Returns whether the shift key is pressed while selecting cell - */ - isShiftKeyPressed?: boolean; + /** Returns whether the shift key is pressed while selecting cell + */ + isShiftKeyPressed?: boolean; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface ColumnDeselectedEventArgs { + export interface ColumnDeselectedEventArgs { - /** Returns the Deselected column index value. - */ - columnIndex?: number; + /** Returns the Deselected column index value. + */ + columnIndex?: number; - /** Returns the Deselected column header element. - */ - headerCell?: any; + /** Returns the Deselected column header element. + */ + headerCell?: any; - /** Returns corresponding column object (JSON). - */ - column?: any; + /** Returns corresponding column object (JSON). + */ + column?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface ColumnDeselectingEventArgs { + export interface ColumnDeselectingEventArgs { - /** Returns the deselecting column index value. - */ - columnIndex?: number; + /** Returns the deselecting column index value. + */ + columnIndex?: number; - /** Returns the deselecting column header element. - */ - headerCell?: any; + /** Returns the deselecting column header element. + */ + headerCell?: any; - /** Returns corresponding column object (JSON). - */ - column?: any; + /** Returns corresponding column object (JSON). + */ + column?: any; - /** Returns whether the ctrl key is pressed while deselecting column - */ - isCtrlKeyPressed?: boolean; + /** Returns whether the ctrl key is pressed while deselecting column + */ + isCtrlKeyPressed?: boolean; - /** Returns whether the shift key is pressed while deselecting column - */ - isShiftKeyPressed?: boolean; + /** Returns whether the shift key is pressed while deselecting column + */ + isShiftKeyPressed?: boolean; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface ContextClickEventArgs { + export interface ContextClickEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the current item. - */ - currentTarget?: any; + /** Returns the current item. + */ + currentTarget?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the status of contextmenu item which denotes its enabled state - */ - status?: boolean; + /** Returns the status of contextmenu item which denotes its enabled state + */ + status?: boolean; - /** Returns the target item. - */ - target?: any; + /** Returns the target item. + */ + target?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface ContextOpenEventArgs { + export interface ContextOpenEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the current item. - */ - currentTarget?: any; + /** Returns the current item. + */ + currentTarget?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the status of contextmenu item which denotes its enabled state - */ - status?: boolean; + /** Returns the status of contextmenu item which denotes its enabled state + */ + status?: boolean; - /** Returns the target item. - */ - target?: any; + /** Returns the target item. + */ + target?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface DataBoundEventArgs { + export interface DataBoundEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns deleted data. - */ - data?: any; + /** Returns deleted data. + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface DetailsCollapseEventArgs { + export interface DetailsCollapseEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns detail row element. - */ - detailsRow?: any; + /** Returns detail row element. + */ + detailsRow?: any; - /** Returns master row of detail row record object (JSON). - */ - masterData?: any; + /** Returns master row of detail row record object (JSON). + */ + masterData?: any; - /** Returns the foreign key record object (JSON). - */ - foreignKeyData?: any; + /** Returns the foreign key record object (JSON). + */ + foreignKeyData?: any; - /** Returns master row element. - */ - masterRow?: any; + /** Returns master row element. + */ + masterRow?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface DetailsDataBoundEventArgs { + export interface DetailsDataBoundEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns details row element. - */ - detailsElement?: any; + /** Returns details row element. + */ + detailsElement?: any; - /** Returns the details row data. - */ - data?: any; + /** Returns the details row data. + */ + data?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface DetailsExpandEventArgs { + export interface DetailsExpandEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns detail row element. - */ - detailsRow?: any; + /** Returns detail row element. + */ + detailsRow?: any; - /** Returns master row of detail row record object (JSON). - */ - masterData?: any; + /** Returns master row of detail row record object (JSON). + */ + masterData?: any; - /** Returns the foreign key record object (JSON). - */ - foreignKeyData?: any; + /** Returns the foreign key record object (JSON). + */ + foreignKeyData?: any; - /** Returns master row element. - */ - masterRow?: any; + /** Returns master row element. + */ + masterRow?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface EndAddEventArgs { + export interface EndAddEventArgs { - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns added data. - */ - data?: any; + /** Returns added data. + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface EndDeleteEventArgs { + export interface EndDeleteEventArgs { - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns deleted data. - */ - data?: any; + /** Returns deleted data. + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface EndEditEventArgs { + export interface EndEditEventArgs { - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns modified data. - */ - data?: any; + /** Returns modified data. + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface LoadEventArgs { + export interface LoadEventArgs { - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns deleted data. - */ - data?: any; + /** Returns deleted data. + */ + data?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface MergeCellInfoEventArgs { + export interface MergeCellInfoEventArgs { - /** Returns grid cell. - */ - cell?: any; + /** Returns grid cell. + */ + cell?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns current row record object (JSON). - */ - data?: any; + /** Returns current row record object (JSON). + */ + data?: any; - /** Returns the text value in the cell. - */ - text?: string; + /** Returns the text value in the cell. + */ + text?: string; - /** Returns the column object. - */ - column?: any; + /** Returns the column object. + */ + column?: any; - /** Method to merge Grid rows. - */ - rowMerge?: any; + /** Method to merge Grid rows. + */ + rowMerge?: any; - /** Method to merge Grid columns. - */ - colMerge?: any; + /** Method to merge Grid columns. + */ + colMerge?: any; - /** Method to merge Grid rows and columns. - */ - merge?: any; + /** Method to merge Grid rows and columns. + */ + merge?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface QueryCellInfoEventArgs { + export interface QueryCellInfoEventArgs { - /** Returns grid cell. - */ - cell?: any; + /** Returns grid cell. + */ + cell?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns current row record object (JSON). - */ - data?: any; + /** Returns current row record object (JSON). + */ + data?: any; - /** Returns the text value in the cell. - */ - text?: string; + /** Returns the text value in the cell. + */ + text?: string; - /** Returns the column object. - */ - column?: any; + /** Returns the column object. + */ + column?: any; - /** Returns the foreign key record object (JSON). - */ - foreignKeyData?: any; + /** Returns the foreign key record object (JSON). + */ + foreignKeyData?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface RecordClickEventArgs { + export interface RecordClickEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns current record object (JSON). - */ - data?: any; + /** Returns current record object (JSON). + */ + data?: any; - /** Returns the row index of the selected row. - */ - rowIndex?: number; + /** Returns the row index of the selected row. + */ + rowIndex?: number; - /** Returns the jQuery object of the current selected row. - */ - row?: any; + /** Returns the jQuery object of the current selected row. + */ + row?: any; - /** Returns the current selected cell. - */ - cell?: any; + /** Returns the current selected cell. + */ + cell?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the cell index value. - */ - cellIndex?: number; + /** Returns the cell index value. + */ + cellIndex?: number; - /** Returns the corresponding cell value. - */ - cellValue?: string; + /** Returns the corresponding cell value. + */ + cellValue?: string; - /** Returns the Header text of the column corresponding to the selected cell. - */ - columnName?: string; + /** Returns the Header text of the column corresponding to the selected cell. + */ + columnName?: string; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface RecordDoubleClickEventArgs { + export interface RecordDoubleClickEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns current record object (JSON). - */ - data?: any; + /** Returns current record object (JSON). + */ + data?: any; - /** Returns the row index of the selected row. - */ - rowIndex?: number; + /** Returns the row index of the selected row. + */ + rowIndex?: number; - /** Returns the jQuery object of the current selected row. - */ - row?: any; + /** Returns the jQuery object of the current selected row. + */ + row?: any; - /** Returns the current selected cell. - */ - cell?: any; + /** Returns the current selected cell. + */ + cell?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the selected cell index value. - */ - cellIndex?: number; + /** Returns the selected cell index value. + */ + cellIndex?: number; - /** Returns the corresponding cell value. - */ - cellValue?: string; + /** Returns the corresponding cell value. + */ + cellValue?: string; - /** Returns the Header text of the column corresponding to the selected cell. - */ - columnName?: string; + /** Returns the Header text of the column corresponding to the selected cell. + */ + columnName?: string; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface ResizedEventArgs { + export interface ResizedEventArgs { - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns deleted data. - */ - data?: any; + /** Returns deleted data. + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the column index. - */ - columnIndex?: number; + /** Returns the column index. + */ + columnIndex?: number; - /** Returns the column object. - */ - column?: any; + /** Returns the column object. + */ + column?: any; - /** Returns the grid object. - */ - target?: any; + /** Returns the grid object. + */ + target?: any; - /** Returns the old width value. - */ - oldWidth?: number; + /** Returns the old width value. + */ + oldWidth?: number; - /** Returns the new width value. - */ - newWidth?: number; -} + /** Returns the new width value. + */ + newWidth?: number; + } -export interface ResizeEndEventArgs { + export interface ResizeEndEventArgs { - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns deleted data. - */ - data?: any; + /** Returns deleted data. + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the column index. - */ - columnIndex?: number; + /** Returns the column index. + */ + columnIndex?: number; - /** Returns the column object. - */ - column?: any; + /** Returns the column object. + */ + column?: any; - /** Returns the grid object. - */ - target?: any; + /** Returns the grid object. + */ + target?: any; - /** Returns the old width value. - */ - oldWidth?: number; + /** Returns the old width value. + */ + oldWidth?: number; - /** Returns the new width value. - */ - newWidth?: number; + /** Returns the new width value. + */ + newWidth?: number; - /** Returns the extra width value. - */ - extra?: number; -} + /** Returns the extra width value. + */ + extra?: number; + } -export interface ResizeStartEventArgs { + export interface ResizeStartEventArgs { - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns deleted data. - */ - data?: any; + /** Returns deleted data. + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the column index. - */ - columnIndex?: number; + /** Returns the column index. + */ + columnIndex?: number; - /** Returns the column object. - */ - column?: any; + /** Returns the column object. + */ + column?: any; - /** Returns the grid object. - */ - target?: any; + /** Returns the grid object. + */ + target?: any; - /** Returns the old width value. - */ - oldWidth?: number; -} + /** Returns the old width value. + */ + oldWidth?: number; + } -export interface RightClickEventArgs { + export interface RightClickEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns current record object (JSON). - */ - currentData?: any; + /** Returns current record object (JSON). + */ + currentData?: any; - /** Returns the row index of the selected row. - */ - rowIndex?: number; + /** Returns the row index of the selected row. + */ + rowIndex?: number; - /** Returns the current selected row. - */ - row?: any; + /** Returns the current selected row. + */ + row?: any; - /** Returns the selected row data object. - */ - data?: any; + /** Returns the selected row data object. + */ + data?: any; - /** Returns the cell index of the selected cell. - */ - cellIndex?: number; + /** Returns the cell index of the selected cell. + */ + cellIndex?: number; - /** Returns the cell value. - */ - cellValue?: string; + /** Returns the cell value. + */ + cellValue?: string; - /** Returns the cell object. - */ - cell?: any; + /** Returns the cell object. + */ + cell?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface RowDataBoundEventArgs { + export interface RowDataBoundEventArgs { - /** Returns grid row. - */ - row?: any; + /** Returns grid row. + */ + row?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns current row record object (JSON). - */ - data?: any; + /** Returns current row record object (JSON). + */ + data?: any; - /** Returns the foreign key record object (JSON). - */ - foreignKeyData?: any; + /** Returns the foreign key record object (JSON). + */ + foreignKeyData?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface RowSelectedEventArgs { + export interface RowSelectedEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns current record object (JSON). - */ - data?: any; + /** Returns current record object (JSON). + */ + data?: any; - /** Returns the foreign key record object (JSON). - */ - foreignKeyData?: any; + /** Returns the foreign key record object (JSON). + */ + foreignKeyData?: any; - /** Returns the row index of the selected row. - */ - rowIndex?: number; + /** Returns the row index of the selected row. + */ + rowIndex?: number; - /** Returns the current selected row. - */ - row?: any; + /** Returns the current selected row. + */ + row?: any; - /** Returns the previous selected row element. - */ - prevRow?: any; + /** Returns the previous selected row element. + */ + prevRow?: any; - /** Returns the previous selected row index. - */ - prevRowIndex?: number; + /** Returns the previous selected row index. + */ + prevRowIndex?: number; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface RowSelectingEventArgs { + export interface RowSelectingEventArgs { - /** Returns the selected row index value. - */ - rowIndex?: number; + /** Returns the selected row index value. + */ + rowIndex?: number; - /** Returns the selected row element. - */ - row?: any; + /** Returns the selected row element. + */ + row?: any; - /** Returns the previous selected row element. - */ - prevRow?: any; + /** Returns the previous selected row element. + */ + prevRow?: any; - /** Returns the previous selected row index. - */ - prevRowIndex?: number; + /** Returns the previous selected row index. + */ + prevRowIndex?: number; - /** Returns current record object (JSON). - */ - data?: any; + /** Returns current record object (JSON). + */ + data?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface RowDeselectedEventArgs { + export interface RowDeselectedEventArgs { - /** Returns current record object (JSON). - */ - data?: any; + /** Returns current record object (JSON). + */ + data?: any; - /** Returns the row index of the deselected row. - */ - rowIndex?: number; + /** Returns the row index of the deselected row. + */ + rowIndex?: number; - /** Returns the current deselected row element. - */ - row?: any; + /** Returns the current deselected row element. + */ + row?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface RowDeselectingEventArgs { + export interface RowDeselectingEventArgs { - /** Returns the deselecting row index value. - */ - rowIndex?: number; + /** Returns the deselecting row index value. + */ + rowIndex?: number; - /** Returns the deselecting row element. - */ - row?: any; + /** Returns the deselecting row element. + */ + row?: any; - /** Returns current record object (JSON). - */ - data?: any; + /** Returns current record object (JSON). + */ + data?: any; - /** Returns whether the ctrl key is pressed while deselecting row - */ - isCtrlKeyPressed?: boolean; + /** Returns whether the ctrl key is pressed while deselecting row + */ + isCtrlKeyPressed?: boolean; - /** Returns whether the shift key is pressed while deselecting row - */ - isShiftKeyPressed?: boolean; + /** Returns whether the shift key is pressed while deselecting row + */ + isShiftKeyPressed?: boolean; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface TemplateRefreshEventArgs { + export interface TemplateRefreshEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the cell object. - */ - cell?: any; + /** Returns the cell object. + */ + cell?: any; - /** Returns the column object. - */ - column?: any; + /** Returns the column object. + */ + column?: any; - /** Returns the current row data. - */ - data?: any; + /** Returns the current row data. + */ + data?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the current row index. - */ - rowIndex?: number; + /** Returns the current row index. + */ + rowIndex?: number; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface ToolbarClickEventArgs { + export interface ToolbarClickEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the current item. - */ - currentTarget?: any; + /** Returns the current item. + */ + currentTarget?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the status of toolbar item which denotes its enabled state - */ - status?: boolean; - - /** Returns the target item. - */ - target?: any; - - /** Returns the name of the event. - */ - type?: string; - - /** Returns the grid model. - */ - gridModel?: any; - - /** Returns the toolbar object of the selected toolbar element. - */ - toolbarData?: any; - - /** Returns the Id of the current toolbar element. - */ - itemId?: string; - - /** Returns the index of the current toolbar element. - */ - itemIndex?: number; - - /** Returns the name of the current toolbar element. - */ - itemName?: string; -} - -export interface ColumnsCommand { - - /** Gets or sets an object that indicates to define all the button options which are available in ejButton. - */ - buttonOptions?: any; - - /** Gets or sets a value that indicates to add the command column button. See unboundType - */ - type?: ej.Grid.UnboundType|string; -} - -export interface Column { - - /** Sets the clip mode for Grid cell as ellipsis or clipped content(both header and content) - * @Default {ej.Grid.ClipMode.Clip} - */ - clipMode?: ej.Grid.ClipMode|string; - - /** Gets or sets a value that indicates whether to enable editing behavior for particular column. - * @Default {true} - */ - allowEditing?: boolean; - - /** Gets or sets a value that indicates whether to enable dynamic filtering behavior for particular column. - * @Default {true} - */ - allowFiltering?: boolean; - - /** Gets or sets a value that indicates whether to enable dynamic grouping behavior for particular column. - * @Default {true} - */ - allowGrouping?: boolean; - - /** Gets or sets a value that indicates whether to enable dynamic sorting behavior for particular column. - * @Default {true} - */ - allowSorting?: boolean; - - /** Gets or sets a value that indicates whether to enable dynamic resizable for particular column. - * @Default {true} - */ - allowResizing?: boolean; - - /** Gets or sets an object that indicates to define a command column in the grid. - * @Default {[]} - */ - commands?: ColumnsCommand[]; - - /** Gets or sets a value that indicates to provide custom CSS for an individual column. - */ - cssClass?: string; - - /** Gets or sets a value that indicates the attribute values to the td element of a particular column - */ - customAttributes?: any; - - /** Gets or sets a value that indicates to bind the external datasource to the particular column when column editType as dropdownedit and also it is used to bind the datasource - * to the foreign key column while editing the grid. //Where data is array of JSON objects of text and value for the drop-down and array of JSON objects for foreign key column. - * @Default {null} - */ - dataSource?: any[]; - - /** Gets or sets a value that indicates to display the specified default value while adding a new record to the grid - */ - defaultValue?: string|number|boolean|Date; - - /** Gets or sets a value that indicates to render the grid content and header with an HTML elements - * @Default {false} - */ - disableHtmlEncode?: boolean; - - /** Gets or sets a value that indicates to display a column value as checkbox or string - * @Default {true} - */ - displayAsCheckBox?: boolean; - - /** Gets or sets a value that indicates to customize ejNumericTextbox of an editable column. See editingType - */ - editParams?: any; - - /** Gets or sets a template that displays a custom editor used to edit column values. See editTemplate - * @Default {null} - */ - editTemplate?: any; - - /** Gets or sets a value that indicates to render the element(based on edit type) for editing the grid record. See editingType - * @Default {ej.Grid.EditingType.String} - */ - editType?: ej.Grid.EditingType|string; - - /** Gets or sets a value that indicates to groups the column based on its column format. - * @Default {false} - */ - enableGroupByFormat?: boolean; - - /** Gets or sets a value that indicates to display the columns in the grid mapping with column name of the dataSource. - */ - field?: string; - - /** Gets or sets a template that customize the filter control from default . See filterBarTemplate - * @Default {null} - */ - filterBarTemplate?: any; - - /** Gets or sets a value that indicates to render the excel or menu filter dialog to the grid columns. See filterType - * @Default {null} - */ - filterType?: ej.Grid.FilterType|string; - - /** Gets or sets a value that indicates to define foreign key field name of the grid datasource. - * @Default {null} - */ - foreignKeyField?: string; - - /** Gets or sets a value that indicates to bind the field which is in foreign column datasource based on the foreignKeyField - * @Default {null} - */ - foreignKeyValue?: string; - - /** Gets or sets a value that indicates the format for the text applied on the column - */ - format?: string; - - /** Gets or sets a value that indicates to add the template within the header element of the particular column. - * @Default {null} - */ - headerTemplateID?: string; - - /** Gets or sets a value that indicates to display the title of that particular column. - */ - headerText?: string; - - /** This defines the text alignment of a particular column header cell value. See headerTextAlign - * @Default {null} - */ - headerTextAlign?: ej.TextAlign|string; - - /** It accepts the string value and shows the tooltip for the Grid column header. - * @Default {null} - */ - headerTooltip?: string; - - /** You can use this property to freeze selected columns in grid at the time of scrolling. - * @Default {false} - */ - isFrozen?: boolean; - - /** Gets or sets a value that indicates the column has an identity in the database. - * @Default {false} - */ - isIdentity?: boolean; - - /** Gets or sets a value that indicates the column is act as a primary key(read-only) of the grid. The editing is performed based on the primary key column - * @Default {false} - */ - isPrimaryKey?: boolean; - - /** Gets or sets a value that indicates the order of Column that are to be hidden or visible when Grid element is in responsive mode and could not occupy all columns. - * @Default {-1} - */ - priority?: number; - - /** Used to hide the particular column in column chooser by giving value as false. - * @Default {true} - */ - showInColumnChooser?: boolean; - - /** Gets or sets a value that indicates whether to enables column template for a particular column. - * @Default {false} - */ - template?: boolean|string; - - /** Gets or sets a value that indicates to align the text within the column. See textAlign - * @Default {ej.TextAlign.Left} - */ - textAlign?: ej.TextAlign|string; - - /** Sets the template for Tooltip in Grid Columns(both header and content) - */ - tooltip?: string; - - /** Gets or sets a value that indicates to specify the data type of the specified columns. - */ - type?: string; - - /** Gets or sets a value that indicates to define constraints for saving data to the database. - */ - validationRules?: any; - - /** Gets or sets a value that indicates whether this column is visible in the grid. - * @Default {true} - */ - visible?: boolean; - - /** Gets or sets a value that indicates to define the width for a particular column in the grid. - */ - width?: number; -} - -export interface ContextMenuSettingsSubContextMenu { - - /** Used to get or set the corresponding custom context menu item to which the submenu to be appended. - * @Default {null} - */ - contextMenuItem?: string; - - /** Used to get or set the sub menu items to the custom context menu item. - * @Default {[]} - */ - subMenu?: any[]; -} - -export interface ContextMenuSettings { - - /** Gets or sets a value that indicates whether to add the default context menu actions as a context menu items If enableContextMenu is true it will show all the items related to the target, - * if you want selected items from contextmenu you have to mention in the contextMenuItems - * @Default {[]} - */ - contextMenuItems?: any[]; - - /** Gets or sets a value that indicates whether to add custom contextMenu items within the toolbar to perform any action in the grid - * @Default {[]} - */ - customContextMenuItems?: any[]; - - /** Gets or sets a value that indicates whether to enable the context menu action in the grid. - * @Default {false} - */ - enableContextMenu?: boolean; - - /** Used to get or set the subMenu to the corresponding custom context menu item. - */ - subContextMenu?: ContextMenuSettingsSubContextMenu[]; - - /** Gets or sets a value that indicates whether to disable the default context menu items in the grid. - * @Default {false} - */ - disableDefaultItems?: boolean; -} - -export interface EditSettings { - - /** Gets or sets a value that indicates whether to enable insert action in the editing mode. - * @Default {false} - */ - allowAdding?: boolean; - - /** Gets or sets a value that indicates whether to enable the delete action in the editing mode. - * @Default {false} - */ - allowDeleting?: boolean; - - /** Gets or sets a value that indicates whether to enable the edit action in the editing mode. - * @Default {false} - */ - allowEditing?: boolean; - - /** Gets or sets a value that indicates whether to enable the editing action while double click on the record - * @Default {true} - */ - allowEditOnDblClick?: boolean; - - /** This specifies the id of the template. This template can be used to display the data that you require to be edited using the Dialog Box - * @Default {null} - */ - dialogEditorTemplateID?: string; - - /** Gets or sets a value that indicates whether to define the mode of editing See editMode - * @Default {ej.Grid.EditMode.Normal} - */ - editMode?: ej.Grid.EditMode|string; - - /** This specifies the id of the template. This template can be used to display the data that you require to be edited using the External edit form - * @Default {null} - */ - externalFormTemplateID?: string; - - /** This specifies to set the position of an External edit form either in the top-right or bottom-left of the grid - * @Default {ej.Grid.FormPosition.BottomLeft} - */ - formPosition?: ej.Grid.FormPosition|string; - - /** This specifies the id of the template. This template can be used to display the data that you require to be edited using the Inline edit form - * @Default {null} - */ - inlineFormTemplateID?: string; - - /** This specifies to set the position of an adding new row either in the top or bottom of the grid - * @Default {ej.Grid.RowPosition.Top} - */ - rowPosition?: ej.Grid.RowPosition|string; - - /** Gets or sets a value that indicates whether the confirm dialog has to be shown while saving or discarding the batch changes - * @Default {true} - */ - showConfirmDialog?: boolean; - - /** Gets or sets a value that indicates whether the confirm dialog has to be shown while deleting record - * @Default {false} - */ - showDeleteConfirmDialog?: boolean; - - /** Gets or sets a value that indicates whether the title for edit form is different from the primarykey column. - * @Default {null} - */ - titleColumn?: string; - - /** Gets or sets a value that indicates whether to display the add new form by default in the grid. - * @Default {false} - */ - showAddNewRow?: boolean; -} - -export interface FilterSettingsFilteredColumn { - - /** Gets or sets a value that indicates whether to define the field name of the column to be filter. - */ - field?: string; - - /** Gets or sets a value that indicates whether to define the matchCase of given value to be filter. - */ - matchCase?: boolean; - - /** Gets or sets a value that indicates whether to define the filter condition to filtered column. See operator - */ - operator?: ej.FilterOperators|string; - - /** Gets or sets a value that indicates whether to define the predicate as and/or. - */ - predicate?: string; - - /** Gets or sets a value that indicates whether to define the value to be filtered in a column. - */ - value?: string|number; -} - -export interface FilterSettings { - - /** Gets or sets a value that indicates to perform the filter operation with case sensitive in excel styled filter menu mode - * @Default {false} - */ - enableCaseSensitivity?: boolean; - - /** Gets or sets a value that indicates to define the interDeterminateState of checkbox in excel filter dialog. - * @Default {true} - */ - enableInterDeterminateState?: boolean; - - /** This specifies the grid to starts the filter action while typing in the filterBar or after pressing the enter key. based on the filterBarMode. See filterBarMode. - * @Default {ej.Grid.FilterBarMode.Immediate} - */ - filterBarMode?: ej.Grid.FilterBarMode|string; - - /** Gets or sets a value that indicates whether to define the filtered columns details programmatically at initial load - * @Default {[]} - */ - filteredColumns?: FilterSettingsFilteredColumn[]; - - /** This specifies the grid to show the filterBar or filterMenu to the grid records. See filterType - * @Default {ej.Grid.FilterType.FilterBar} - */ - filterType?: ej.Grid.FilterType|string; - - /** This specifies the grid to delay the filter action while typing in the filterBar. - * @Default {1500} - */ - immediateModeDelay?: number; - - /** Gets or sets a value that indicates the maximum number of filter choices that can be showed in the excel styled filter menu. - * @Default {1000} - */ - maxFilterChoices?: number; - - /** This specifies the grid to show the filter text within the grid pager itself. - * @Default {true} - */ - showFilterBarMessage?: boolean; - - /** Gets or sets a value that indicates whether to enable the predicate options in the filtering menu - * @Default {false} - */ - showPredicate?: boolean; -} - -export interface GroupSettings { - - /** Gets or sets a value that customize the group caption format. - * @Default {null} - */ - captionFormat?: string; - - /** Gets or sets a value that indicates whether to enable animation button option in the group drop area of the grid. - * @Default {false} - */ - enableDropAreaAutoSizing?: boolean; - - /** Gets or sets a value that indicates whether to add grouped columns programmatically at initial load - * @Default {[]} - */ - groupedColumns?: any[]; - - /** Gets or sets a value that indicates whether to show the group drop area just above the column header. It can be used to avoid ungrouping the already grouped column using groupSettings. - * @Default {true} - */ - showDropArea?: boolean; - - /** Gets or sets a value that indicates whether to hide the grouped columns from the grid - * @Default {false} - */ - showGroupedColumn?: boolean; - - /** Gets or sets a value that indicates whether to show the group button image(toggle button)in the column header and also in the grouped column in the group drop area. - * It can be used to group/ungroup the columns by click on the toggle button. - * @Default {false} - */ - showToggleButton?: boolean; - - /** Gets or sets a value that indicates whether to enable the close button in the grouped column which is in the group drop area to ungroup the grouped column - * @Default {false} - */ - showUngroupButton?: boolean; -} - -export interface PageSettings { - - /** Gets or sets a value that indicates whether to define which page to display currently in the grid - * @Default {1} - */ - currentPage?: number; - - /** Gets or sets a value that indicates whether to pass the current page information as a query string along with the URL while navigating to other page. - * @Default {false} - */ - enableQueryString?: boolean; - - /** Gets or sets a value that indicates whether to enables pager template for the grid. - * @Default {false} - */ - enableTemplates?: boolean; - - /** Gets or sets a value that indicates whether to define the number of pages displayed in the pager for navigation - * @Default {8} - */ - pageCount?: number; - - /** Gets or sets a value that indicates whether to define the number of records displayed per page - * @Default {12} - */ - pageSize?: number; - - /** Gets or sets a value that indicates whether to enables default pager for the grid. - * @Default {false} - */ - showDefaults?: boolean; - - /** Gets or sets a value that indicates to add the template as a pager template for grid. - * @Default {null} - */ - template?: string; - - /** Get the value of total number of pages in the grid. The totalPages value is calculated based on page size and total records of grid - * @Default {null} - */ - totalPages?: number; - - /** Get the value of total number of records which is bound to the grid. The totalRecordsCount value is calculated based on dataSource bound to the grid. - * @Default {null} - */ - totalRecordsCount?: number; - - /** Gets or sets a value that indicates whether to define the number of pages to print - * @Default {ej.Grid.PrintMode.AllPages} - */ - printMode?: ej.Grid.PrintMode|string; -} - -export interface ResizeSettings { - - /** Gets or sets a value that indicates whether to define the mode of resizing. - * @Default {ej.Grid.ResizeMode.Normal} - */ - resizeMode?: ej.Grid.ResizeMode|string; -} - -export interface RowDropSettings { - - /** This specifies the grid to drop the grid rows only at particular target element. - * @Default {null} - */ - dropTargetID?: any; - - /** This helps in mapping server-side action when rows are dragged from Grid. - * @Default {null} - */ - dragMapper?: string; - - /** This helps in mapping server-side action when rows are dropped in Grid. - * @Default {null} - */ - dropMapper?: string; -} - -export interface SearchSettings { - - /** This specify the grid to search for the value in particular columns that is mentioned in the field. - * @Default {[]} - */ - fields?: any; - - /** This specifies the grid to search the particular data that is mentioned in the key. - */ - key?: string; - - /** It specifies the grid to search the records based on operator. - * @Default {contains} - */ - operator?: string; - - /** It enables or disables case-sensitivity while searching the search key in grid. - * @Default {true} - */ - ignoreCase?: boolean; -} - -export interface SelectionSettings { - - /** Gets or sets a value that indicates the cell selection actions based on the cell selection mode. - * @Default {flow} - */ - cellSelectionMode?: string; - - /** Gets or sets a value that indicates whether to enable the toggle selection behavior for row, cell and column. - * @Default {false} - */ - enableToggle?: boolean; - - /** Gets or sets a value that indicates whether to add the default selection actions as a selection mode.See selectionMode - * @Default {[row]} - */ - selectionMode?: any[]; -} - -export interface ScrollSettings { - - /** This specify the grid to to view data that you require without buffering the entire load of a huge database - * @Default {false} - */ - allowVirtualScrolling?: boolean; - - /** It accepts the boolean value and shows or hides the scrollbar while focus in or focus out of the Grid. - * @Default {false} - */ - autoHide?: boolean; - - /** Specifies the height and width of button in the scrollbar. - * @Default {18} - */ - buttonSize?: number; - - /** This specify the grid to enable/disable touch control for scrolling. - * @Default {true} - */ - enableTouchScroll?: boolean; - - /** This specify the grid to freeze particular columns at the time of scrolling. - * @Default {0} - */ - frozenColumns?: number; - - /** This specify the grid to freeze particular rows at the time of scrolling. - * @Default {0} - */ - frozenRows?: number; - - /** This specify the grid to show the vertical scroll bar, to scroll and view the grid contents. - * @Default {0} - */ - height?: string|number; - - /** It accepts the integer value and sets the width of scrollbar. - * @Default {18} - */ - scrollerSize?: number; - - /** This is used to define the mode of virtual scrolling in grid. See virtualScrollMode - * @Default {ej.Grid.VirtualScrollMode.Normal} - */ - virtualScrollMode?: ej.Grid.VirtualScrollMode|string; - - /** This is used to enable the enhanced virtual scrolling in Grid. - * @Default {false} - */ - enableVirtualization?: boolean; - - /** This specify the grid to show the horizontal scroll bar, to scroll and view the grid contents - * @Default {250} - */ - width?: string|number; - - /** This specify the scroll down pixel of mouse wheel, to scroll mouse wheel and view the grid contents. - * @Default {57} - */ - scrollOneStepBy?: number; -} - -export interface SortSettingsSortedColumn { - - /** Gets or sets a value that indicates whether to define the direction to sort the column. - */ - direction?: string; - - /** Gets or sets a value that indicates whether to define the field name of the column to be sort - */ - field?: string; -} - -export interface SortSettings { - - /** Gets or sets a value that indicates whether to define the direction and field to sort the column. - */ - sortedColumns?: SortSettingsSortedColumn[]; -} - -export interface StackedHeaderRowsStackedHeaderColumn { - - /** Gets or sets a value that indicates the header text for the particular stacked header column. - * @Default {null} - */ - column?: any; - - /** Gets or sets a value that indicates class to the corresponding stackedHeaderColumn. - * @Default {null} - */ - cssClass?: string; - - /** Gets or sets a value that indicates the header text for the particular stacked header column. - * @Default {null} - */ - headerText?: string; - - /** Gets or sets a value that indicates the text alignment of the corresponding headerText. - * @Default {ej.TextAlign.Left} - */ - textAlign?: string; - - /** Sets the template for tooltip for the Grid stackedHeaderColumns. - * @Default {null} - */ - tooltip?: string; -} - -export interface StackedHeaderRow { - - /** Gets or sets a value that indicates whether to add stacked header columns into the stacked header rows - * @Default {[]} - */ - stackedHeaderColumns?: StackedHeaderRowsStackedHeaderColumn[]; -} - -export interface SummaryRowsSummaryColumn { - - /** Gets or sets a value that indicates the text displayed in the summary column as a value - * @Default {null} - */ - customSummaryValue?: string; - - /** This specifies summary column used to perform the summary calculation - * @Default {null} - */ - dataMember?: string; - - /** Gets or sets a value that indicates to define the target column at which to display the summary. - * @Default {null} - */ - displayColumn?: string; - - /** Gets or sets a value that indicates the format for the text applied on the column - * @Default {null} - */ - format?: string; - - /** Gets or sets a value that indicates the text displayed before the summary column value - * @Default {null} - */ - prefix?: string; - - /** Gets or sets a value that indicates the text displayed after the summary column value - * @Default {null} - */ - suffix?: string; + /** Returns the status of toolbar item which denotes its enabled state + */ + status?: boolean; + + /** Returns the target item. + */ + target?: any; + + /** Returns the name of the event. + */ + type?: string; + + /** Returns the grid model. + */ + gridModel?: any; + + /** Returns the toolbar object of the selected toolbar element. + */ + toolbarData?: any; + + /** Returns the Id of the current toolbar element. + */ + itemId?: string; + + /** Returns the index of the current toolbar element. + */ + itemIndex?: number; + + /** Returns the name of the current toolbar element. + */ + itemName?: string; + } + + export interface ColumnsCommand { + + /** Gets or sets an object that indicates to define all the button options which are available in ejButton. + */ + buttonOptions?: any; + + /** Gets or sets a value that indicates to add the command column button. See unboundType + */ + type?: ej.Grid.UnboundType | string; + } + + export interface Column { + + /** Sets the clip mode for Grid cell as ellipsis or clipped content(both header and content) + * @Default {ej.Grid.ClipMode.Clip} + */ + clipMode?: ej.Grid.ClipMode | string; + + /** Gets or sets a value that indicates whether to enable editing behavior for particular column. + * @Default {true} + */ + allowEditing?: boolean; + + /** Gets or sets a value that indicates whether to enable dynamic filtering behavior for particular column. + * @Default {true} + */ + allowFiltering?: boolean; + + /** Gets or sets a value that indicates whether to enable dynamic grouping behavior for particular column. + * @Default {true} + */ + allowGrouping?: boolean; + + /** Gets or sets a value that indicates whether to enable dynamic sorting behavior for particular column. + * @Default {true} + */ + allowSorting?: boolean; + + /** Gets or sets a value that indicates whether to enable dynamic resizable for particular column. + * @Default {true} + */ + allowResizing?: boolean; + + /** Gets or sets an object that indicates to define a command column in the grid. + * @Default {[]} + */ + commands?: ColumnsCommand[]; + + /** Gets or sets a value that indicates to provide custom CSS for an individual column. + */ + cssClass?: string; + + /** Gets or sets a value that indicates the attribute values to the td element of a particular column + */ + customAttributes?: any; + + /** Gets or sets a value that indicates to bind the external datasource to the particular column when column editType as dropdownedit and also it is used to bind the datasource + * to the foreign key column while editing the grid. //Where data is array of JSON objects of text and value for the drop-down and array of JSON objects for foreign key column. + * @Default {null} + */ + dataSource?: any[]; + + /** Gets or sets a value that indicates to display the specified default value while adding a new record to the grid + */ + defaultValue?: string | number | boolean | Date; + + /** Gets or sets a value that indicates to render the grid content and header with an HTML elements + * @Default {false} + */ + disableHtmlEncode?: boolean; + + /** Gets or sets a value that indicates to display a column value as checkbox or string + * @Default {true} + */ + displayAsCheckBox?: boolean; + + /** Gets or sets a value that indicates to customize ejNumericTextbox of an editable column. See editingType + */ + editParams?: any; + + /** Gets or sets a template that displays a custom editor used to edit column values. See editTemplate + * @Default {null} + */ + editTemplate?: any; + + /** Gets or sets a value that indicates to render the element(based on edit type) for editing the grid record. See editingType + * @Default {ej.Grid.EditingType.String} + */ + editType?: ej.Grid.EditingType | string; + + /** Gets or sets a value that indicates to groups the column based on its column format. + * @Default {false} + */ + enableGroupByFormat?: boolean; + + /** Gets or sets a value that indicates to display the columns in the grid mapping with column name of the dataSource. + */ + field?: string; + + /** Gets or sets a template that customize the filter control from default . See filterBarTemplate + * @Default {null} + */ + filterBarTemplate?: any; + + /** Gets or sets a value that indicates to render the excel or menu filter dialog to the grid columns. See filterType + * @Default {null} + */ + filterType?: ej.Grid.FilterType | string; + + /** Gets or sets a value that indicates to define foreign key field name of the grid datasource. + * @Default {null} + */ + foreignKeyField?: string; + + /** Gets or sets a value that indicates to bind the field which is in foreign column datasource based on the foreignKeyField + * @Default {null} + */ + foreignKeyValue?: string; + + /** Gets or sets a value that indicates the format for the text applied on the column + */ + format?: string; + + /** Gets or sets a value that indicates to add the template within the header element of the particular column. + * @Default {null} + */ + headerTemplateID?: string; + + /** Gets or sets a value that indicates to display the title of that particular column. + */ + headerText?: string; + + /** This defines the text alignment of a particular column header cell value. See headerTextAlign + * @Default {null} + */ + headerTextAlign?: ej.TextAlign | string; + + /** It accepts the string value and shows the tooltip for the Grid column header. + * @Default {null} + */ + headerTooltip?: string; + + /** You can use this property to freeze selected columns in grid at the time of scrolling. + * @Default {false} + */ + isFrozen?: boolean; + + /** Gets or sets a value that indicates the column has an identity in the database. + * @Default {false} + */ + isIdentity?: boolean; + + /** Gets or sets a value that indicates the column is act as a primary key(read-only) of the grid. The editing is performed based on the primary key column + * @Default {false} + */ + isPrimaryKey?: boolean; + + /** Gets or sets a value that indicates the order of Column that are to be hidden or visible when Grid element is in responsive mode and could not occupy all columns. + * @Default {-1} + */ + priority?: number; + + /** Used to hide the particular column in column chooser by giving value as false. + * @Default {true} + */ + showInColumnChooser?: boolean; + + /** Gets or sets a value that indicates whether to enables column template for a particular column. + * @Default {false} + */ + template?: boolean | string; + + /** Gets or sets a value that indicates to align the text within the column. See textAlign + * @Default {ej.TextAlign.Left} + */ + textAlign?: ej.TextAlign | string; + + /** Sets the template for Tooltip in Grid Columns(both header and content) + */ + tooltip?: string; + + /** Gets or sets a value that indicates to specify the data type of the specified columns. + */ + type?: string; + + /** Gets or sets a value that indicates to define constraints for saving data to the database. + */ + validationRules?: any; + + /** Gets or sets a value that indicates whether this column is visible in the grid. + * @Default {true} + */ + visible?: boolean; + + /** Gets or sets a value that indicates to define the width for a particular column in the grid. + */ + width?: number; + } + + export interface ContextMenuSettingsSubContextMenu { + + /** Used to get or set the corresponding custom context menu item to which the submenu to be appended. + * @Default {null} + */ + contextMenuItem?: string; + + /** Used to get or set the sub menu items to the custom context menu item. + * @Default {[]} + */ + subMenu?: any[]; + } + + export interface ContextMenuSettings { + + /** Gets or sets a value that indicates whether to add the default context menu actions as a context menu items If enableContextMenu is true it will show all the items related to the target, + * if you want selected items from contextmenu you have to mention in the contextMenuItems + * @Default {[]} + */ + contextMenuItems?: any[]; + + /** Gets or sets a value that indicates whether to add custom contextMenu items within the toolbar to perform any action in the grid + * @Default {[]} + */ + customContextMenuItems?: any[]; + + /** Gets or sets a value that indicates whether to enable the context menu action in the grid. + * @Default {false} + */ + enableContextMenu?: boolean; + + /** Used to get or set the subMenu to the corresponding custom context menu item. + */ + subContextMenu?: ContextMenuSettingsSubContextMenu[]; + + /** Gets or sets a value that indicates whether to disable the default context menu items in the grid. + * @Default {false} + */ + disableDefaultItems?: boolean; + } + + export interface EditSettings { + + /** Gets or sets a value that indicates whether to enable insert action in the editing mode. + * @Default {false} + */ + allowAdding?: boolean; + + /** Gets or sets a value that indicates whether to enable the delete action in the editing mode. + * @Default {false} + */ + allowDeleting?: boolean; + + /** Gets or sets a value that indicates whether to enable the edit action in the editing mode. + * @Default {false} + */ + allowEditing?: boolean; + + /** Gets or sets a value that indicates whether to enable the editing action while double click on the record + * @Default {true} + */ + allowEditOnDblClick?: boolean; + + /** This specifies the id of the template. This template can be used to display the data that you require to be edited using the Dialog Box + * @Default {null} + */ + dialogEditorTemplateID?: string; + + /** Gets or sets a value that indicates whether to define the mode of editing See editMode + * @Default {ej.Grid.EditMode.Normal} + */ + editMode?: ej.Grid.EditMode | string; + + /** This specifies the id of the template. This template can be used to display the data that you require to be edited using the External edit form + * @Default {null} + */ + externalFormTemplateID?: string; + + /** This specifies to set the position of an External edit form either in the top-right or bottom-left of the grid + * @Default {ej.Grid.FormPosition.BottomLeft} + */ + formPosition?: ej.Grid.FormPosition | string; + + /** This specifies the id of the template. This template can be used to display the data that you require to be edited using the Inline edit form + * @Default {null} + */ + inlineFormTemplateID?: string; + + /** This specifies to set the position of an adding new row either in the top or bottom of the grid + * @Default {ej.Grid.RowPosition.Top} + */ + rowPosition?: ej.Grid.RowPosition | string; + + /** Gets or sets a value that indicates whether the confirm dialog has to be shown while saving or discarding the batch changes + * @Default {true} + */ + showConfirmDialog?: boolean; + + /** Gets or sets a value that indicates whether the confirm dialog has to be shown while deleting record + * @Default {false} + */ + showDeleteConfirmDialog?: boolean; + + /** Gets or sets a value that indicates whether the title for edit form is different from the primarykey column. + * @Default {null} + */ + titleColumn?: string; + + /** Gets or sets a value that indicates whether to display the add new form by default in the grid. + * @Default {false} + */ + showAddNewRow?: boolean; + } + + export interface FilterSettingsFilteredColumn { + + /** Gets or sets a value that indicates whether to define the field name of the column to be filter. + */ + field?: string; + + /** Gets or sets a value that indicates whether to define the matchCase of given value to be filter. + */ + matchCase?: boolean; + + /** Gets or sets a value that indicates whether to define the filter condition to filtered column. See operator + */ + operator?: ej.FilterOperators | string; + + /** Gets or sets a value that indicates whether to define the predicate as and/or. + */ + predicate?: string; + + /** Gets or sets a value that indicates whether to define the value to be filtered in a column. + */ + value?: string | number; + } + + export interface FilterSettings { + + /** Gets or sets a value that indicates to perform the filter operation with case sensitive in excel styled filter menu mode + * @Default {false} + */ + enableCaseSensitivity?: boolean; + + /** Gets or sets a value that indicates to define the interDeterminateState of checkbox in excel filter dialog. + * @Default {true} + */ + enableInterDeterminateState?: boolean; + + /** This specifies the grid to starts the filter action while typing in the filterBar or after pressing the enter key. based on the filterBarMode. See filterBarMode. + * @Default {ej.Grid.FilterBarMode.Immediate} + */ + filterBarMode?: ej.Grid.FilterBarMode | string; + + /** Gets or sets a value that indicates whether to define the filtered columns details programmatically at initial load + * @Default {[]} + */ + filteredColumns?: FilterSettingsFilteredColumn[]; + + /** This specifies the grid to show the filterBar or filterMenu to the grid records. See filterType + * @Default {ej.Grid.FilterType.FilterBar} + */ + filterType?: ej.Grid.FilterType | string; + + /** This specifies the grid to delay the filter action while typing in the filterBar. + * @Default {1500} + */ + immediateModeDelay?: number; + + /** Gets or sets a value that indicates the maximum number of filter choices that can be showed in the excel styled filter menu. + * @Default {1000} + */ + maxFilterChoices?: number; + + /** This specifies the grid to show the filter text within the grid pager itself. + * @Default {true} + */ + showFilterBarMessage?: boolean; + + /** Gets or sets a value that indicates whether to enable the predicate options in the filtering menu + * @Default {false} + */ + showPredicate?: boolean; + } + + export interface GroupSettings { + + /** Gets or sets a value that customize the group caption format. + * @Default {null} + */ + captionFormat?: string; + + /** Gets or sets a value that indicates whether to enable animation button option in the group drop area of the grid. + * @Default {false} + */ + enableDropAreaAutoSizing?: boolean; + + /** Gets or sets a value that indicates whether to add grouped columns programmatically at initial load + * @Default {[]} + */ + groupedColumns?: any[]; + + /** Gets or sets a value that indicates whether to show the group drop area just above the column header. It can be used to avoid ungrouping the already grouped column using groupSettings. + * @Default {true} + */ + showDropArea?: boolean; + + /** Gets or sets a value that indicates whether to hide the grouped columns from the grid + * @Default {false} + */ + showGroupedColumn?: boolean; + + /** Gets or sets a value that indicates whether to show the group button image(toggle button)in the column header and also in the grouped column in the group drop area. + * It can be used to group/ungroup the columns by click on the toggle button. + * @Default {false} + */ + showToggleButton?: boolean; + + /** Gets or sets a value that indicates whether to enable the close button in the grouped column which is in the group drop area to ungroup the grouped column + * @Default {false} + */ + showUngroupButton?: boolean; + } + + export interface PageSettings { + + /** Gets or sets a value that indicates whether to define which page to display currently in the grid + * @Default {1} + */ + currentPage?: number; + + /** Gets or sets a value that indicates whether to pass the current page information as a query string along with the URL while navigating to other page. + * @Default {false} + */ + enableQueryString?: boolean; + + /** Gets or sets a value that indicates whether to enables pager template for the grid. + * @Default {false} + */ + enableTemplates?: boolean; + + /** Gets or sets a value that indicates whether to define the number of pages displayed in the pager for navigation + * @Default {8} + */ + pageCount?: number; + + /** Gets or sets a value that indicates whether to define the number of records displayed per page + * @Default {12} + */ + pageSize?: number; + + /** Gets or sets a value that indicates whether to enables default pager for the grid. + * @Default {false} + */ + showDefaults?: boolean; + + /** Gets or sets a value that indicates to add the template as a pager template for grid. + * @Default {null} + */ + template?: string; + + /** Get the value of total number of pages in the grid. The totalPages value is calculated based on page size and total records of grid + * @Default {null} + */ + totalPages?: number; + + /** Get the value of total number of records which is bound to the grid. The totalRecordsCount value is calculated based on dataSource bound to the grid. + * @Default {null} + */ + totalRecordsCount?: number; + + /** Gets or sets a value that indicates whether to define the number of pages to print + * @Default {ej.Grid.PrintMode.AllPages} + */ + printMode?: ej.Grid.PrintMode | string; + } + + export interface ResizeSettings { + + /** Gets or sets a value that indicates whether to define the mode of resizing. + * @Default {ej.Grid.ResizeMode.Normal} + */ + resizeMode?: ej.Grid.ResizeMode | string; + } + + export interface RowDropSettings { + + /** This specifies the grid to drop the grid rows only at particular target element. + * @Default {null} + */ + dropTargetID?: any; + + /** This helps in mapping server-side action when rows are dragged from Grid. + * @Default {null} + */ + dragMapper?: string; + + /** This helps in mapping server-side action when rows are dropped in Grid. + * @Default {null} + */ + dropMapper?: string; + } + + export interface SearchSettings { + + /** This specify the grid to search for the value in particular columns that is mentioned in the field. + * @Default {[]} + */ + fields?: any; + + /** This specifies the grid to search the particular data that is mentioned in the key. + */ + key?: string; + + /** It specifies the grid to search the records based on operator. + * @Default {contains} + */ + operator?: string; + + /** It enables or disables case-sensitivity while searching the search key in grid. + * @Default {true} + */ + ignoreCase?: boolean; + } + + export interface SelectionSettings { + + /** Gets or sets a value that indicates the cell selection actions based on the cell selection mode. + * @Default {flow} + */ + cellSelectionMode?: string; + + /** Gets or sets a value that indicates whether to enable the toggle selection behavior for row, cell and column. + * @Default {false} + */ + enableToggle?: boolean; + + /** Gets or sets a value that indicates whether to add the default selection actions as a selection mode.See selectionMode + * @Default {[row]} + */ + selectionMode?: any[]; + } + + export interface ScrollSettings { + + /** This specify the grid to to view data that you require without buffering the entire load of a huge database + * @Default {false} + */ + allowVirtualScrolling?: boolean; + + /** It accepts the boolean value and shows or hides the scrollbar while focus in or focus out of the Grid. + * @Default {false} + */ + autoHide?: boolean; + + /** Specifies the height and width of button in the scrollbar. + * @Default {18} + */ + buttonSize?: number; + + /** This specify the grid to enable/disable touch control for scrolling. + * @Default {true} + */ + enableTouchScroll?: boolean; + + /** This specify the grid to freeze particular columns at the time of scrolling. + * @Default {0} + */ + frozenColumns?: number; + + /** This specify the grid to freeze particular rows at the time of scrolling. + * @Default {0} + */ + frozenRows?: number; + + /** This specify the grid to show the vertical scroll bar, to scroll and view the grid contents. + * @Default {0} + */ + height?: string | number; + + /** It accepts the integer value and sets the width of scrollbar. + * @Default {18} + */ + scrollerSize?: number; + + /** This is used to define the mode of virtual scrolling in grid. See virtualScrollMode + * @Default {ej.Grid.VirtualScrollMode.Normal} + */ + virtualScrollMode?: ej.Grid.VirtualScrollMode | string; + + /** This is used to enable the enhanced virtual scrolling in Grid. + * @Default {false} + */ + enableVirtualization?: boolean; + + /** This specify the grid to show the horizontal scroll bar, to scroll and view the grid contents + * @Default {250} + */ + width?: string | number; + + /** This specify the scroll down pixel of mouse wheel, to scroll mouse wheel and view the grid contents. + * @Default {57} + */ + scrollOneStepBy?: number; + } + + export interface SortSettingsSortedColumn { + + /** Gets or sets a value that indicates whether to define the direction to sort the column. + */ + direction?: string; + + /** Gets or sets a value that indicates whether to define the field name of the column to be sort + */ + field?: string; + } + + export interface SortSettings { + + /** Gets or sets a value that indicates whether to define the direction and field to sort the column. + */ + sortedColumns?: SortSettingsSortedColumn[]; + } + + export interface StackedHeaderRowsStackedHeaderColumn { + + /** Gets or sets a value that indicates the header text for the particular stacked header column. + * @Default {null} + */ + column?: any; + + /** Gets or sets a value that indicates class to the corresponding stackedHeaderColumn. + * @Default {null} + */ + cssClass?: string; + + /** Gets or sets a value that indicates the header text for the particular stacked header column. + * @Default {null} + */ + headerText?: string; + + /** Gets or sets a value that indicates the text alignment of the corresponding headerText. + * @Default {ej.TextAlign.Left} + */ + textAlign?: string; + + /** Sets the template for tooltip for the Grid stackedHeaderColumns. + * @Default {null} + */ + tooltip?: string; + } + + export interface StackedHeaderRow { + + /** Gets or sets a value that indicates whether to add stacked header columns into the stacked header rows + * @Default {[]} + */ + stackedHeaderColumns?: StackedHeaderRowsStackedHeaderColumn[]; + } + + export interface SummaryRowsSummaryColumn { + + /** Gets or sets a value that indicates the text displayed in the summary column as a value + * @Default {null} + */ + customSummaryValue?: string; + + /** This specifies summary column used to perform the summary calculation + * @Default {null} + */ + dataMember?: string; + + /** Gets or sets a value that indicates to define the target column at which to display the summary. + * @Default {null} + */ + displayColumn?: string; + + /** Gets or sets a value that indicates the format for the text applied on the column + * @Default {null} + */ + format?: string; + + /** Gets or sets a value that indicates the text displayed before the summary column value + * @Default {null} + */ + prefix?: string; + + /** Gets or sets a value that indicates the text displayed after the summary column value + * @Default {null} + */ + suffix?: string; - /** Gets or sets a value that indicates the type of calculations to be performed for the corresponding summary column - * @Default {[]} - */ - summaryType?: ej.Grid.SummaryType|string; + /** Gets or sets a value that indicates the type of calculations to be performed for the corresponding summary column + * @Default {[]} + */ + summaryType?: ej.Grid.SummaryType | string; - /** Gets or sets a value that indicates to add the template for the summary value of dataMember given. - * @Default {null} - */ - template?: string; -} + /** Gets or sets a value that indicates to add the template for the summary value of dataMember given. + * @Default {null} + */ + template?: string; + } -export interface SummaryRow { + export interface SummaryRow { - /** Gets or sets a value that indicates whether to show the summary value within the group caption area for the corresponding summary column while grouping the column - * @Default {false} - */ - showCaptionSummary?: boolean; + /** Gets or sets a value that indicates whether to show the summary value within the group caption area for the corresponding summary column while grouping the column + * @Default {false} + */ + showCaptionSummary?: boolean; - /** Gets or sets a value that indicates whether to show the group summary value for the corresponding summary column while grouping a column - * @Default {false} - */ - showGroupSummary?: boolean; + /** Gets or sets a value that indicates whether to show the group summary value for the corresponding summary column while grouping a column + * @Default {false} + */ + showGroupSummary?: boolean; - /** Gets or sets a value that indicates whether to show the total summary value the for the corresponding summary column. The summary row is added after the grid content. - * @Default {true} - */ - showTotalSummary?: boolean; + /** Gets or sets a value that indicates whether to show the total summary value the for the corresponding summary column. The summary row is added after the grid content. + * @Default {true} + */ + showTotalSummary?: boolean; - /** Gets or sets a value that indicates whether to add summary columns into the summary rows. - * @Default {[]} - */ - summaryColumns?: SummaryRowsSummaryColumn[]; + /** Gets or sets a value that indicates whether to add summary columns into the summary rows. + * @Default {[]} + */ + summaryColumns?: SummaryRowsSummaryColumn[]; - /** This specifies the grid to show the title for the summary rows. - */ - title?: string; + /** This specifies the grid to show the title for the summary rows. + */ + title?: string; - /** This specifies the grid to show the title of summary row in the specified column. - * @Default {null} - */ - titleColumn?: string; -} + /** This specifies the grid to show the title of summary row in the specified column. + * @Default {null} + */ + titleColumn?: string; + } -export interface TextWrapSettings { + export interface TextWrapSettings { - /** This specifies the grid to apply the auto wrap for grid content or header or both. - * @Default {ej.Grid.WrapMode.Both} - */ - wrapMode?: ej.Grid.WrapMode|string; -} + /** This specifies the grid to apply the auto wrap for grid content or header or both. + * @Default {ej.Grid.WrapMode.Both} + */ + wrapMode?: ej.Grid.WrapMode | string; + } -export interface ToolbarSettings { + export interface ToolbarSettings { - /** Gets or sets a value that indicates whether to add custom toolbar items within the toolbar to perform any action in the grid - * @Default {[]} - */ - customToolbarItems?: any[]; + /** Gets or sets a value that indicates whether to add custom toolbar items within the toolbar to perform any action in the grid + * @Default {[]} + */ + customToolbarItems?: any[]; - /** Gets or sets a value that indicates whether to enable toolbar in the grid. - * @Default {false} - */ - showToolbar?: boolean; + /** Gets or sets a value that indicates whether to enable toolbar in the grid. + * @Default {false} + */ + showToolbar?: boolean; - /** Gets or sets a value that indicates whether to add the default editing actions as a toolbar items - * @Default {[]} - */ - toolbarItems?: Array; -} + /** Gets or sets a value that indicates whether to add the default editing actions as a toolbar items + * @Default {[]} + */ + toolbarItems?: Array; + } -enum GridLines { + enum GridLines { - ///Displays both the horizontal and vertical grid lines. - Both, + ///Displays both the horizontal and vertical grid lines. + Both, - ///Displays the horizontal grid lines only. - Horizontal, + ///Displays the horizontal grid lines only. + Horizontal, - ///Displays the vertical grid lines only. - Vertical, + ///Displays the vertical grid lines only. + Vertical, - ///No grid lines are displayed. - None -} + ///No grid lines are displayed. + None + } -enum ClipMode { + enum ClipMode { - ///Shows ellipsis for the overflown cell. - Ellipsis, + ///Shows ellipsis for the overflown cell. + Ellipsis, - ///Truncate the text in the cell - Clip, + ///Truncate the text in the cell + Clip, - ///Shows ellipsis and tooltip for the overflown cell. - EllipsisWithTooltip -} + ///Shows ellipsis and tooltip for the overflown cell. + EllipsisWithTooltip + } -enum ColumnLayout { + enum ColumnLayout { - ///Column layout is auto(based on width). - Auto, + ///Column layout is auto(based on width). + Auto, - ///Column layout is fixed(based on width). - Fixed -} + ///Column layout is fixed(based on width). + Fixed + } -enum UnboundType { + enum UnboundType { - ///Unbound type is edit. - Edit, + ///Unbound type is edit. + Edit, - ///Unbound type is save. - Save, + ///Unbound type is save. + Save, - ///Unbound type is delete. - Delete, + ///Unbound type is delete. + Delete, - ///Unbound type is cancel. - Cancel -} + ///Unbound type is cancel. + Cancel + } -enum EditingType { + enum EditingType { - ///Specifies editing type as string edit. - String, + ///Specifies editing type as string edit. + String, - ///Specifies editing type as boolean edit. - Boolean, + ///Specifies editing type as boolean edit. + Boolean, - ///Specifies editing type as numeric edit. - Numeric, + ///Specifies editing type as numeric edit. + Numeric, - ///Specifies editing type as dropdown edit. - Dropdown, + ///Specifies editing type as dropdown edit. + Dropdown, - ///Specifies editing type as datepicker. - DatePicker, + ///Specifies editing type as datepicker. + DatePicker, - ///Specifies editing type as datetime picker. - DateTimePicker -} + ///Specifies editing type as datetime picker. + DateTimePicker + } -enum FilterType { + enum FilterType { - ///Specifies the filter type as menu. - Menu, + ///Specifies the filter type as menu. + Menu, - ///Specifies the filter type as excel. - Excel -} + ///Specifies the filter type as excel. + Excel + } -enum EditMode { + enum EditMode { - ///Edit mode is normal. - Normal, + ///Edit mode is normal. + Normal, - ///Edit mode is dialog. - Dialog, + ///Edit mode is dialog. + Dialog, - ///Edit mode is dialog template. - DialogTemplate, + ///Edit mode is dialog template. + DialogTemplate, - ///Edit mode is batch. - Batch, + ///Edit mode is batch. + Batch, - ///Edit mode is inline form. - InlineForm, + ///Edit mode is inline form. + InlineForm, - ///Edit mode is inline template form. - InlineTemplateForm, + ///Edit mode is inline template form. + InlineTemplateForm, - ///Edit mode is external form. - ExternalForm, + ///Edit mode is external form. + ExternalForm, - ///Edit mode is external form template. - ExternalFormTemplate -} + ///Edit mode is external form template. + ExternalFormTemplate + } -enum FormPosition { + enum FormPosition { - ///Form position is bottomleft. - BottomLeft, + ///Form position is bottomleft. + BottomLeft, - ///Form position is topright. - TopRight -} + ///Form position is topright. + TopRight + } -enum RowPosition { + enum RowPosition { - ///Specifies position of add new row as top. - Top, + ///Specifies position of add new row as top. + Top, - ///Specifies position of add new row as bottom. - Bottom -} + ///Specifies position of add new row as bottom. + Bottom + } -enum FilterBarMode { + enum FilterBarMode { - ///Initiate filter operation on typing the filter query. - Immediate, + ///Initiate filter operation on typing the filter query. + Immediate, - ///Initiate filter operation after Enter key is pressed. - OnEnter -} + ///Initiate filter operation after Enter key is pressed. + OnEnter + } -enum PrintMode { + enum PrintMode { - ///Prints all pages. - AllPages, + ///Prints all pages. + AllPages, - ///Prints current page. - CurrentPage -} + ///Prints current page. + CurrentPage + } -enum ResizeMode { + enum ResizeMode { - ///New column size will be adjusted by all other Columns - Normal, + ///New column size will be adjusted by all other Columns + Normal, - ///New column Size will be adjusted using next column. - NextColumn, + ///New column Size will be adjusted using next column. + NextColumn, - ///New column Size will be adjusted using entire control - Control -} + ///New column Size will be adjusted using entire control + Control + } -enum SelectionType { + enum SelectionType { - ///Specifies the selection type as single. - Single, + ///Specifies the selection type as single. + Single, - ///Specifies the selection type as multiple. - Multiple -} + ///Specifies the selection type as multiple. + Multiple + } -enum VirtualScrollMode { + enum VirtualScrollMode { - ///virtual scroll mode is normal. - Normal, + ///virtual scroll mode is normal. + Normal, - ///virtual scroll mode is continuous. - Continuous -} + ///virtual scroll mode is continuous. + Continuous + } -enum SummaryType { + enum SummaryType { - ///Summary type is average. - Average, + ///Summary type is average. + Average, - ///Summary type is minimum. - Minimum, + ///Summary type is minimum. + Minimum, - ///Summary type is maximum. - Maximum, + ///Summary type is maximum. + Maximum, - ///Summary type is count. - Count, + ///Summary type is count. + Count, - ///Summary type is sum. - Sum, + ///Summary type is sum. + Sum, - ///Summary type is custom. - Custom, + ///Summary type is custom. + Custom, - ///Summary type is true count. - TrueCount, + ///Summary type is true count. + TrueCount, - ///Summary type is false count. - FalseCount -} + ///Summary type is false count. + FalseCount + } -enum WrapMode { + enum WrapMode { - ///Auto wrap is applied for both content and header. - Both, + ///Auto wrap is applied for both content and header. + Both, - ///Auto wrap is applied only for content. - Content, + ///Auto wrap is applied only for content. + Content, - ///Auto wrap is applied only for header. - Header -} + ///Auto wrap is applied only for header. + Header + } -enum ToolBarItems { + enum ToolBarItems { - ///Toolbar item is add. - Add, + ///Toolbar item is add. + Add, - ///Toolbar item is edit. - Edit, + ///Toolbar item is edit. + Edit, - ///Toolbar item is delete. - Delete, + ///Toolbar item is delete. + Delete, - ///Toolbar item is update. - Update, + ///Toolbar item is update. + Update, - ///Toolbar item is cancel. - Cancel, + ///Toolbar item is cancel. + Cancel, - ///Toolbar item is search. - Search, + ///Toolbar item is search. + Search, - ///Toolbar item is pdfExport. - PdfExport, + ///Toolbar item is pdfExport. + PdfExport, - ///Toolbar item is printGrid. - PrintGrid, + ///Toolbar item is printGrid. + PrintGrid, - ///Toolbar item is wordExport. - WordExport -} + ///Toolbar item is wordExport. + WordExport + } -} + } -class Sparkline extends ej.Widget { - static fn: Sparkline; - constructor(element: JQuery | Element, options?: Sparkline.Model); - static Locale: any; - model: Sparkline.Model; - defaults: Sparkline.Model; + class Sparkline extends ej.Widget { + static fn: Sparkline; + constructor(element: JQuery | Element, options?: Sparkline.Model); + static Locale: any; + model: Sparkline.Model; + defaults: Sparkline.Model; - /** Redraws the entire sparkline. You can call this method whenever you update, add or remove points from the data source or whenever you want to refresh the UI. - * @returns {void} - */ - redraw(): void; -} -export namespace Sparkline { + /** Redraws the entire sparkline. You can call this method whenever you update, add or remove points from the data source or whenever you want to refresh the UI. + * @returns {void} + */ + redraw(): void; + } + export namespace Sparkline { -export interface Model { + export interface Model { - /** Background color of the plot area. - * @Default {transparent} - */ - background?: string; + /** Background color of the plot area. + * @Default {transparent} + */ + background?: string; - /** Fill color for the sparkline series. - * @Default {#33ccff} - */ - fill?: string; + /** Fill color for the sparkline series. + * @Default {#33ccff} + */ + fill?: string; - /** Border color of the series. - * @Default {null} - */ - stroke?: string; + /** Border color of the series. + * @Default {null} + */ + stroke?: string; - /** Options for customizing the color, opacity and width of the sparkline border. - */ - border?: Border; + /** Options for customizing the color, opacity and width of the sparkline border. + */ + border?: Border; - /** Border width of the series. - * @Default {1} - */ - width?: number; + /** Border width of the series. + * @Default {1} + */ + width?: number; - /** Opacity of the series. - * @Default {1} - */ - opacity?: number; + /** Opacity of the series. + * @Default {1} + */ + opacity?: number; - /** Color for series high point. - * @Default {null} - */ - highPointColor?: string; + /** Color for series high point. + * @Default {null} + */ + highPointColor?: string; - /** Color for series low point. - * @Default {null} - */ - lowPointColor?: string; + /** Color for series low point. + * @Default {null} + */ + lowPointColor?: string; - /** Color for series start point. - * @Default {null} - */ - startPointColor?: string; + /** Color for series start point. + * @Default {null} + */ + startPointColor?: string; - /** Color for series end point. - * @Default {null} - */ - endPointColor?: string; + /** Color for series end point. + * @Default {null} + */ + endPointColor?: string; - /** Color for series negative point. - * @Default {null} - */ - negativePointColor?: string; + /** Color for series negative point. + * @Default {null} + */ + negativePointColor?: string; - /** Options for customizing the color, opacity of the sparkline start and end range. - */ - rangeBandSettings?: RangeBandSettings; - - /** Name of a field in data source, where the fill color for all the data points is generated. - */ - palette?: string; - - /** Controls whether sparkline has to be responsive or not. - * @Default {true} - */ - isResponsive?: boolean; - - /** Controls whether Sparkline has to be rendered as Canvas or SVG.Canvas rendering supports all functionalities in SVG rendering. - * @Default {false} - */ - enableCanvasRendering?: boolean; - - /** Specifies the dataSource for the series. It can be an array of JSON objects or an instance of ej.DataManager. - * @Default {null} - */ - dataSource?: any; - - /** Name of the property in the datasource that contains x value for the series. - * @Default {null} - */ - xName?: string; - - /** Name of the property in the datasource that contains y value for the series. - * @Default {null} - */ - yName?: string; - - /** Gap or padding for sparkline. - * @Default {8} - */ - padding?: number; - - /** Specifies the type of the series to render in sparkline. - * @Default {line. See Type} - */ - type?: ej.datavisualization.Sparkline.Type|string; - - /** Specifies the theme for Sparkline. - * @Default {Flatlight. See Theme} - */ - theme?: ej.datavisualization.Sparkline.Theme|string; - - /** Options to customize the tooltip. - */ - tooltip?: Tooltip; - - /** Options for displaying and customizing marker for a data point. - */ - markerSettings?: MarkerSettings; + /** Options for customizing the color, opacity of the sparkline start and end range. + */ + rangeBandSettings?: RangeBandSettings; + + /** Name of a field in data source, where the fill color for all the data points is generated. + */ + palette?: string; + + /** Controls whether sparkline has to be responsive or not. + * @Default {true} + */ + isResponsive?: boolean; + + /** Controls whether Sparkline has to be rendered as Canvas or SVG.Canvas rendering supports all functionalities in SVG rendering. + * @Default {false} + */ + enableCanvasRendering?: boolean; + + /** Specifies the dataSource for the series. It can be an array of JSON objects or an instance of ej.DataManager. + * @Default {null} + */ + dataSource?: any; + + /** Name of the property in the datasource that contains x value for the series. + * @Default {null} + */ + xName?: string; + + /** Name of the property in the datasource that contains y value for the series. + * @Default {null} + */ + yName?: string; + + /** Gap or padding for sparkline. + * @Default {8} + */ + padding?: number; + + /** Specifies the type of the series to render in sparkline. + * @Default {line. See Type} + */ + type?: ej.datavisualization.Sparkline.Type | string; + + /** Specifies the theme for Sparkline. + * @Default {Flatlight. See Theme} + */ + theme?: ej.datavisualization.Sparkline.Theme | string; + + /** Options to customize the tooltip. + */ + tooltip?: Tooltip; + + /** Options for displaying and customizing marker for a data point. + */ + markerSettings?: MarkerSettings; - /** Options to customize the Sparkline size. - */ - size?: Size; + /** Options to customize the Sparkline size. + */ + size?: Size; - /** Options for customizing the color,dashArray and width of the axisLine. - */ - axisLineSettings?: AxisLineSettings; + /** Options for customizing the color,dashArray and width of the axisLine. + */ + axisLineSettings?: AxisLineSettings; - /** Fires before loading the sparkline. */ - load?(e: LoadEventArgs): void; - - /** Fires after loaded the sparkline. */ - loaded?(e: LoadedEventArgs): void; + /** Fires before loading the sparkline. */ + load?(e: LoadEventArgs): void; + + /** Fires after loaded the sparkline. */ + loaded?(e: LoadedEventArgs): void; - /** Fires before rendering trackball tooltip. You can use this event to customize the text displayed in trackball tooltip. */ - tooltipInitialize?(e: TooltipInitializeEventArgs): void; + /** Fires before rendering trackball tooltip. You can use this event to customize the text displayed in trackball tooltip. */ + tooltipInitialize?(e: TooltipInitializeEventArgs): void; - /** Fires before rendering a series. This event is fired for each series in Sparkline. */ - seriesRendering?(e: SeriesRenderingEventArgs): void; + /** Fires before rendering a series. This event is fired for each series in Sparkline. */ + seriesRendering?(e: SeriesRenderingEventArgs): void; - /** Fires when mouse is moved over a point. */ - pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; + /** Fires when mouse is moved over a point. */ + pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; - /** Fires on clicking a point in sparkline. You can use this event to handle clicks made on points. */ - pointRegionMouseClick?(e: PointRegionMouseClickEventArgs): void; + /** Fires on clicking a point in sparkline. You can use this event to handle clicks made on points. */ + pointRegionMouseClick?(e: PointRegionMouseClickEventArgs): void; - /** Fires on moving mouse over the sparkline. */ - sparklineMouseMove?(e: SparklineMouseMoveEventArgs): void; + /** Fires on moving mouse over the sparkline. */ + sparklineMouseMove?(e: SparklineMouseMoveEventArgs): void; - /** Fires on moving mouse outside the sparkline. */ - sparklineMouseLeave?(e: SparklineMouseLeaveEventArgs): void; -} + /** Fires on moving mouse outside the sparkline. */ + sparklineMouseLeave?(e: SparklineMouseLeaveEventArgs): void; + } -export interface LoadEventArgs { + export interface LoadEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the sparkline model object - */ - model?: any; + /** Instance of the sparkline model object + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface LoadedEventArgs { + export interface LoadedEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the sparkline model object - */ - model?: any; + /** Instance of the sparkline model object + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface TooltipInitializeEventArgs { + export interface TooltipInitializeEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the sparkline model object - */ - model?: any; + /** Instance of the sparkline model object + */ + model?: any; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** X Location of the trackball tooltip in pixels - */ - locationX?: any; + /** X Location of the trackball tooltip in pixels + */ + locationX?: any; - /** Y Location of the trackball tooltip in pixels - */ - locationY?: any; + /** Y Location of the trackball tooltip in pixels + */ + locationY?: any; - /** Index of the point for which trackball tooltip is displayed - */ - pointIndex?: number; + /** Index of the point for which trackball tooltip is displayed + */ + pointIndex?: number; - /** Text to be displayed in trackball tooltip. Use this option to add custom text in trackball tooltip - */ - currentText?: string; -} + /** Text to be displayed in trackball tooltip. Use this option to add custom text in trackball tooltip + */ + currentText?: string; + } -export interface SeriesRenderingEventArgs { + export interface SeriesRenderingEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the sparkline model object - */ - model?: any; + /** Instance of the sparkline model object + */ + model?: any; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** Minimum x value of the data point - */ - minX?: any; + /** Minimum x value of the data point + */ + minX?: any; - /** Minimum y value of the data point - */ - minY?: any; + /** Minimum y value of the data point + */ + minY?: any; - /** Maximum x value of the data point - */ - maxX?: any; + /** Maximum x value of the data point + */ + maxX?: any; - /** Maximum y value of the data point - */ - maxY?: any; -} + /** Maximum y value of the data point + */ + maxY?: any; + } -export interface PointRegionMouseMoveEventArgs { + export interface PointRegionMouseMoveEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the sparkline model object - */ - model?: any; + /** Instance of the sparkline model object + */ + model?: any; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** X-coordinate of point in pixel - */ - locationX?: number; + /** X-coordinate of point in pixel + */ + locationX?: number; - /** Y-coordinate of point in pixel - */ - locationY?: number; + /** Y-coordinate of point in pixel + */ + locationY?: number; - /** Index of the point in series - */ - pointIndex?: number; + /** Index of the point in series + */ + pointIndex?: number; - /** Type of the series - */ - seriesType?: string; -} + /** Type of the series + */ + seriesType?: string; + } -export interface PointRegionMouseClickEventArgs { + export interface PointRegionMouseClickEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the sparkline model object - */ - model?: any; + /** Instance of the sparkline model object + */ + model?: any; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** X-coordinate of point in pixel - */ - locationX?: number; + /** X-coordinate of point in pixel + */ + locationX?: number; - /** Y-coordinate of point in pixel - */ - locationY?: number; + /** Y-coordinate of point in pixel + */ + locationY?: number; - /** Index of the point in series - */ - pointIndex?: number; - - /** Type of the series - */ - seriesType?: string; -} - -export interface SparklineMouseMoveEventArgs { + /** Index of the point in series + */ + pointIndex?: number; + + /** Type of the series + */ + seriesType?: string; + } + + export interface SparklineMouseMoveEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the sparkline model object - */ - model?: any; - - /** Name of the event - */ - type?: string; -} - -export interface SparklineMouseLeaveEventArgs { - - /** Set this option to true to cancel the event - */ - cancel?: boolean; - - /** Instance of the sparkline model object - */ - model?: any; - - /** Name of the event - */ - type?: string; -} - -export interface Border { - - /** Border color of the sparkline. - * @Default {transparent} - */ - color?: string; - - /** Width of the Sparkline border. - * @Default {1} - */ - width?: number; -} - -export interface RangeBandSettings { - - /** Start value of the range band. - * @Default {null} - */ - startRange?: number; - - /** End value of the range band. - * @Default {null} - */ - endRange?: number; - - /** Range band opacity of the series. - * @Default {1} - */ - opacity?: number; - - /** Range band color of the series. - * @Default {transparent} - */ - color?: string; -} - -export interface TooltipBorder { - - /** Border color of the tooltip. - * @Default {transparent} - */ - color?: string; - - /** Border width of the tooltip. - * @Default {1} - */ - width?: number; -} - -export interface TooltipFont { - - /** Font color of the text in the tooltip. - * @Default {#111111} - */ - color?: string; - - /** Font Family for the tooltip. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Specifies the font Style for the tooltip. - * @Default {Normal} - */ - fontStyle?: ej.datavisualization.Sparkline.FontStyle|string; - - /** Specifies the font weight for the tooltip. - * @Default {Regular} - */ - fontWeight?: ej.datavisualization.Sparkline.FontWeight|string; - - /** Opacity for text in the tooltip. - * @Default {1} - */ - opacity?: number; - - /** Font size for text in the tooltip. - * @Default {8px} - */ - size?: string; -} - -export interface Tooltip { - - /** Show/hides the tooltip visibility. - * @Default {false} - */ - visible?: boolean; - - /** Fill color for the sparkline tooltip. - * @Default {white} - */ - fill?: string; - - /** Custom template to the tooltip. - */ - template?: string; - - /** Options for customizing the border of the tooltip. - */ - border?: TooltipBorder; - - /** Options for customizing the font of the tooltip. - */ - font?: TooltipFont; -} - -export interface MarkerSettingsBorder { - - /** Border color of the marker shape. - * @Default {transparent} - */ - color?: string; - - /** Controls the opacity of the marker border. - * @Default {1} - */ - opacity?: number; - - /** Border width of the marker shape. - * @Default {null} - */ - width?: number; -} - -export interface MarkerSettings { - - /** Controls the opacity of the marker. - * @Default {1} - */ - opacity?: number; - - /** Controls the visibility of the marker shape. - * @Default {false} - */ - visible?: boolean; - - /** width of the marker shape. - * @Default {2} - */ - width?: number; - - /** Color of the marker shape. - * @Default {white} - */ - fill?: string; - - /** Options for customizing the border of the marker shape. - */ - border?: MarkerSettingsBorder; -} - -export interface Size { - - /** Height of the Sparkline. Height can be specified in either pixel or percentage. - * @Default {''} - */ - height?: string; - - /** Width of the Sparkline. Width can be specified in either pixel or percentage. - * @Default {''} - */ - width?: string; -} - -export interface AxisLineSettings { - - /** Controls the visibility of the axis. - * @Default {false} - */ - visible?: boolean; - - /** Color of the axis line. - * @Default {'#111111'} - */ - color?: string; - - /** Width of the axis line. - * @Default {1} - */ - width?: number; - - /** Dash array of the axis line. - * @Default {1} - */ - dashArray?: number; -} -} -namespace Sparkline { -enum Type { -//string -Area, -//string -Line, -//string -Column, -//string -Pie, -//string -WinLoss, -} -} -namespace Sparkline { -enum Theme { -//string -Azure, -//string -FlatLight, -//string -FlatDark, -//string -Azuredark, -//string -Lime, -//string -LimeDark, -//string -Saffron, -//string -SaffronDark, -//string -GradientLight, -//string -GradientDark, -} -} -namespace Sparkline { -enum FontStyle { -//string -Normal, -//string -Italic, -} -} -namespace Sparkline { -enum FontWeight { -//string -Regular, -//string -Bold, -//string -Lighter, -} -} - -class SunburstChart extends ej.Widget { - static fn: SunburstChart; - constructor(element: JQuery | Element, options?: SunburstChart.Model); - static Locale: any; - model: SunburstChart.Model; - defaults: SunburstChart.Model; - - /** Redraws the entire sunburst. You can call this method whenever you update, add or remove points from the data source or whenever you want to refresh the UI. - * @returns {void} - */ - redraw(): void; - - /** destroy the sunburst - * @returns {void} - */ - _destroy(): void; -} -export namespace SunburstChart { - -export interface Model { - - /** Background color of the plot area. - * @Default {null} - */ - background?: string; - - /** Bind the data field from the data source. - * @Default {null} - */ - valueMemberPath?: string; - - /** Options for customizing the sunburst border. - */ - border?: Border; - - /** Options for customizing the sunburst segment border. - */ - segmentBorder?: SegmentBorder; - - /** Specifies the dataSource to the sunburst. - * @Default {null} - */ - dataSource?: any; - - /** Palette color for the data points. - * @Default {null} - */ - palette?: string; - - /** Parent node of the data points. - * @Default {null} - */ - parentNode?: string; - - /** Name of the property in the datasource that contains x values. - * @Default {null} - */ - xName?: string; - - /** Name of the property in the datasource that contains y values. - * @Default {null} - */ - yName?: string; - - /** Controls whether sunburst has to be responsive or not. - * @Default {true} - */ - isResponsive?: boolean; - - /** Options to customize the Sunburst size. - */ - size?: Size; - - /** Controls the visibility of sunburst. - * @Default {true} - */ - visible?: boolean; - - /** Options to customize the Sunburst tooltip. - */ - tooltip?: Tooltip; - - /** Options for customizing sunburst points. - */ - points?: Points; - - /** Sunburst rendering will start from the specified value - * @Default {null} - */ - startAngle?: number; - - /** Sunburst rendering will end at the specified value - * @Default {null} - */ - endAngle?: number; - - /** Sunburst outer radius value - * @Default {1} - */ - radius?: number; - - /** Sunburst inner radius value - * @Default {0.4} - */ - innerRadius?: number; - - /** Options to customize the Sunburst dataLabel. - */ - dataLabelSettings?: DataLabelSettings; - - /** Options for customizing the title and subtitle of sunburst. - */ - title?: Title; - - /** Options for customizing the appearance of the levels or point while highlighting. - */ - highlightSettings?: HighlightSettings; + /** Instance of the sparkline model object + */ + model?: any; + + /** Name of the event + */ + type?: string; + } + + export interface SparklineMouseLeaveEventArgs { + + /** Set this option to true to cancel the event + */ + cancel?: boolean; + + /** Instance of the sparkline model object + */ + model?: any; + + /** Name of the event + */ + type?: string; + } + + export interface Border { + + /** Border color of the sparkline. + * @Default {transparent} + */ + color?: string; + + /** Width of the Sparkline border. + * @Default {1} + */ + width?: number; + } + + export interface RangeBandSettings { + + /** Start value of the range band. + * @Default {null} + */ + startRange?: number; + + /** End value of the range band. + * @Default {null} + */ + endRange?: number; + + /** Range band opacity of the series. + * @Default {1} + */ + opacity?: number; + + /** Range band color of the series. + * @Default {transparent} + */ + color?: string; + } + + export interface TooltipBorder { + + /** Border color of the tooltip. + * @Default {transparent} + */ + color?: string; + + /** Border width of the tooltip. + * @Default {1} + */ + width?: number; + } + + export interface TooltipFont { + + /** Font color of the text in the tooltip. + * @Default {#111111} + */ + color?: string; + + /** Font Family for the tooltip. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Specifies the font Style for the tooltip. + * @Default {Normal} + */ + fontStyle?: ej.datavisualization.Sparkline.FontStyle | string; + + /** Specifies the font weight for the tooltip. + * @Default {Regular} + */ + fontWeight?: ej.datavisualization.Sparkline.FontWeight | string; + + /** Opacity for text in the tooltip. + * @Default {1} + */ + opacity?: number; + + /** Font size for text in the tooltip. + * @Default {8px} + */ + size?: string; + } + + export interface Tooltip { + + /** Show/hides the tooltip visibility. + * @Default {false} + */ + visible?: boolean; + + /** Fill color for the sparkline tooltip. + * @Default {white} + */ + fill?: string; + + /** Custom template to the tooltip. + */ + template?: string; + + /** Options for customizing the border of the tooltip. + */ + border?: TooltipBorder; + + /** Options for customizing the font of the tooltip. + */ + font?: TooltipFont; + } + + export interface MarkerSettingsBorder { + + /** Border color of the marker shape. + * @Default {transparent} + */ + color?: string; + + /** Controls the opacity of the marker border. + * @Default {1} + */ + opacity?: number; + + /** Border width of the marker shape. + * @Default {null} + */ + width?: number; + } + + export interface MarkerSettings { + + /** Controls the opacity of the marker. + * @Default {1} + */ + opacity?: number; + + /** Controls the visibility of the marker shape. + * @Default {false} + */ + visible?: boolean; + + /** width of the marker shape. + * @Default {2} + */ + width?: number; + + /** Color of the marker shape. + * @Default {white} + */ + fill?: string; + + /** Options for customizing the border of the marker shape. + */ + border?: MarkerSettingsBorder; + } + + export interface Size { + + /** Height of the Sparkline. Height can be specified in either pixel or percentage. + * @Default {''} + */ + height?: string; + + /** Width of the Sparkline. Width can be specified in either pixel or percentage. + * @Default {''} + */ + width?: string; + } + + export interface AxisLineSettings { + + /** Controls the visibility of the axis. + * @Default {false} + */ + visible?: boolean; + + /** Color of the axis line. + * @Default {'#111111'} + */ + color?: string; + + /** Width of the axis line. + * @Default {1} + */ + width?: number; + + /** Dash array of the axis line. + * @Default {1} + */ + dashArray?: number; + } + } + namespace Sparkline { + enum Type { + //string + Area, + //string + Line, + //string + Column, + //string + Pie, + //string + WinLoss, + } + } + namespace Sparkline { + enum Theme { + //string + Azure, + //string + FlatLight, + //string + FlatDark, + //string + Azuredark, + //string + Lime, + //string + LimeDark, + //string + Saffron, + //string + SaffronDark, + //string + GradientLight, + //string + GradientDark, + } + } + namespace Sparkline { + enum FontStyle { + //string + Normal, + //string + Italic, + } + } + namespace Sparkline { + enum FontWeight { + //string + Regular, + //string + Bold, + //string + Lighter, + } + } + + class SunburstChart extends ej.Widget { + static fn: SunburstChart; + constructor(element: JQuery | Element, options?: SunburstChart.Model); + static Locale: any; + model: SunburstChart.Model; + defaults: SunburstChart.Model; + + /** Redraws the entire sunburst. You can call this method whenever you update, add or remove points from the data source or whenever you want to refresh the UI. + * @returns {void} + */ + redraw(): void; + + /** destroy the sunburst + * @returns {void} + */ + _destroy(): void; + } + export namespace SunburstChart { + + export interface Model { + + /** Background color of the plot area. + * @Default {null} + */ + background?: string; + + /** Bind the data field from the data source. + * @Default {null} + */ + valueMemberPath?: string; + + /** Options for customizing the sunburst border. + */ + border?: Border; + + /** Options for customizing the sunburst segment border. + */ + segmentBorder?: SegmentBorder; + + /** Specifies the dataSource to the sunburst. + * @Default {null} + */ + dataSource?: any; + + /** Palette color for the data points. + * @Default {null} + */ + palette?: string; + + /** Parent node of the data points. + * @Default {null} + */ + parentNode?: string; + + /** Name of the property in the datasource that contains x values. + * @Default {null} + */ + xName?: string; + + /** Name of the property in the datasource that contains y values. + * @Default {null} + */ + yName?: string; + + /** Controls whether sunburst has to be responsive or not. + * @Default {true} + */ + isResponsive?: boolean; + + /** Options to customize the Sunburst size. + */ + size?: Size; + + /** Controls the visibility of sunburst. + * @Default {true} + */ + visible?: boolean; + + /** Options to customize the Sunburst tooltip. + */ + tooltip?: Tooltip; + + /** Options for customizing sunburst points. + */ + points?: Points; + + /** Sunburst rendering will start from the specified value + * @Default {null} + */ + startAngle?: number; + + /** Sunburst rendering will end at the specified value + * @Default {null} + */ + endAngle?: number; + + /** Sunburst outer radius value + * @Default {1} + */ + radius?: number; + + /** Sunburst inner radius value + * @Default {0.4} + */ + innerRadius?: number; + + /** Options to customize the Sunburst dataLabel. + */ + dataLabelSettings?: DataLabelSettings; + + /** Options for customizing the title and subtitle of sunburst. + */ + title?: Title; + + /** Options for customizing the appearance of the levels or point while highlighting. + */ + highlightSettings?: HighlightSettings; - /** Options for customizing the appearance of the levels or data point while selection. - */ - selectionSettings?: SelectionSettings; - - /** Specify levels of sunburst for grouped visualization of data - * @Default {[]} - */ - levels?: Level[]; - - /** Options to customize the legend items and legend title. - */ - legend?: Legend; + /** Options for customizing the appearance of the levels or data point while selection. + */ + selectionSettings?: SelectionSettings; + + /** Specify levels of sunburst for grouped visualization of data + * @Default {[]} + */ + levels?: Level[]; + + /** Options to customize the legend items and legend title. + */ + legend?: Legend; - /** Specifies the theme for Sunburst. - * @Default {Flatlight. See Theme} - */ - theme?: ej.datavisualization.Sunburst.SunburstTheme|string; + /** Specifies the theme for Sunburst. + * @Default {Flatlight. See Theme} + */ + theme?: ej.datavisualization.Sunburst.SunburstTheme | string; - /** Options to customize the left, right, top and bottom margins of sunburst area. - */ - margin?: Margin; + /** Options to customize the left, right, top and bottom margins of sunburst area. + */ + margin?: Margin; - /** Enable/disable the animation for all the levels. - * @Default {false} - */ - enableAnimation?: boolean; + /** Enable/disable the animation for all the levels. + * @Default {false} + */ + enableAnimation?: boolean; - /** Opacity of the levels. - * @Default {1} - */ - opacity?: number; + /** Opacity of the levels. + * @Default {1} + */ + opacity?: number; - /** Options for enable zooming feature of chart. - */ - zoomSettings?: ZoomSettings; + /** Options for enable zooming feature of chart. + */ + zoomSettings?: ZoomSettings; - /** Animation type of sunburst - * @Default {rotation. See Alignment} - */ - animationType?: ej.datavisualization.Sunburst.Animation|string; + /** Animation type of sunburst + * @Default {rotation. See Alignment} + */ + animationType?: ej.datavisualization.Sunburst.Animation | string; - /** Fires before loading. */ - load?(e: LoadEventArgs): void; + /** Fires before loading. */ + load?(e: LoadEventArgs): void; - /** Fires before rendering sunburst. */ - preRender?(e: PreRenderEventArgs): void; + /** Fires before rendering sunburst. */ + preRender?(e: PreRenderEventArgs): void; - /** Fires after rendering sunburst. */ - loaded?(e: LoadedEventArgs): void; + /** Fires after rendering sunburst. */ + loaded?(e: LoadedEventArgs): void; - /** Fires before rendering the datalabel */ - dataLabelRendering?(e: DataLabelRenderingEventArgs): void; + /** Fires before rendering the datalabel */ + dataLabelRendering?(e: DataLabelRenderingEventArgs): void; - /** Fires before rendering each segment */ - segmentRendering?(e: SegmentRenderingEventArgs): void; + /** Fires before rendering each segment */ + segmentRendering?(e: SegmentRenderingEventArgs): void; - /** Fires before rendering sunburst title. */ - titleRendering?(e: TitleRenderingEventArgs): void; + /** Fires before rendering sunburst title. */ + titleRendering?(e: TitleRenderingEventArgs): void; - /** Fires during initialization of tooltip. */ - tooltipInitialize?(e: TooltipInitializeEventArgs): void; + /** Fires during initialization of tooltip. */ + tooltipInitialize?(e: TooltipInitializeEventArgs): void; - /** Fires after clicking the point in sunburst */ - pointRegionClick?(e: PointRegionClickEventArgs): void; + /** Fires after clicking the point in sunburst */ + pointRegionClick?(e: PointRegionClickEventArgs): void; - /** Fires while moving the mouse over sunburst points */ - pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; + /** Fires while moving the mouse over sunburst points */ + pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; - /** Fires when clicking the point to perform drilldown. */ - drillDownClick?(e: DrillDownClickEventArgs): void; + /** Fires when clicking the point to perform drilldown. */ + drillDownClick?(e: DrillDownClickEventArgs): void; - /** Fires when resetting drilldown points. */ - drillDownBack?(e: DrillDownBackEventArgs): void; + /** Fires when resetting drilldown points. */ + drillDownBack?(e: DrillDownBackEventArgs): void; - /** Fires after resetting the sunburst points */ - drillDownReset?(e: DrillDownResetEventArgs): void; -} + /** Fires after resetting the sunburst points */ + drillDownReset?(e: DrillDownResetEventArgs): void; + } -export interface LoadEventArgs { + export interface LoadEventArgs { - /** Load event data - */ - data?: string; + /** Load event data + */ + data?: string; - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the sunburst model object - */ - model?: any; + /** Instance of the sunburst model object + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface PreRenderEventArgs { + export interface PreRenderEventArgs { - /** PreRender event data - */ - data?: string; + /** PreRender event data + */ + data?: string; - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the sunburst model object - */ - model?: any; + /** Instance of the sunburst model object + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface LoadedEventArgs { + export interface LoadedEventArgs { - /** Loaded event data - */ - data?: string; + /** Loaded event data + */ + data?: string; - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the sunburst model object - */ - model?: any; + /** Instance of the sunburst model object + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface DataLabelRenderingEventArgs { + export interface DataLabelRenderingEventArgs { - /** Sunburst datalabel data - */ - data?: string; + /** Sunburst datalabel data + */ + data?: string; - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the sunburst model object - */ - model?: any; + /** Instance of the sunburst model object + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface SegmentRenderingEventArgs { + export interface SegmentRenderingEventArgs { - /** Sunburst datalabel data - */ - data?: string; + /** Sunburst datalabel data + */ + data?: string; - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the sunburst model object - */ - model?: any; + /** Instance of the sunburst model object + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface TitleRenderingEventArgs { + export interface TitleRenderingEventArgs { - /** Sunburst title data - */ - data?: string; + /** Sunburst title data + */ + data?: string; - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the sunburst model object - */ - model?: any; + /** Instance of the sunburst model object + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface TooltipInitializeEventArgs { + export interface TooltipInitializeEventArgs { - /** Sunburst tooltip data - */ - data?: string; + /** Sunburst tooltip data + */ + data?: string; - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the sunburst model object - */ - model?: any; + /** Instance of the sunburst model object + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface PointRegionClickEventArgs { + export interface PointRegionClickEventArgs { - /** Includes clicked points region data - */ - data?: string; + /** Includes clicked points region data + */ + data?: string; - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the sunburst model object - */ - model?: any; + /** Instance of the sunburst model object + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface PointRegionMouseMoveEventArgs { + export interface PointRegionMouseMoveEventArgs { - /** Includes data of mouse moved region - */ - data?: string; + /** Includes data of mouse moved region + */ + data?: string; - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the sunburst model object - */ - model?: any; + /** Instance of the sunburst model object + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface DrillDownClickEventArgs { + export interface DrillDownClickEventArgs { - /** Clicked point data - */ - data?: string; + /** Clicked point data + */ + data?: string; - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the sunburst model object - */ - model?: any; + /** Instance of the sunburst model object + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface DrillDownBackEventArgs { + export interface DrillDownBackEventArgs { - /** Drill down data of points - */ - data?: string; + /** Drill down data of points + */ + data?: string; - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the sunburst model object - */ - model?: any; + /** Instance of the sunburst model object + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface DrillDownResetEventArgs { - - /** Drill down reset data - */ - data?: string; + export interface DrillDownResetEventArgs { + + /** Drill down reset data + */ + data?: string; - /** Set this option to true to cancel the event - */ - cancel?: boolean; - - /** Instance of the sunburst model object - */ - model?: any; - - /** Name of the event - */ - type?: string; -} - -export interface Border { - - /** Border color of the sunburst. - * @Default {null} - */ - color?: string; - - /** Width of the Sunburst border. - * @Default {2} - */ - width?: number; -} - -export interface SegmentBorder { - - /** Segment Border color of the sunburst. - * @Default {null} - */ - color?: string; - - /** Width of the Sunburst segment border. - * @Default {2} - */ - width?: number; -} - -export interface Size { - - /** Height of the Sunburst. - * @Default {''} - */ - height?: string; - - /** Width of the Sunburst. - * @Default {''} - */ - width?: string; -} - -export interface TooltipBorder { - - /** Border color of the tooltip. - * @Default {null} - */ - color?: string; - - /** Border width of the tooltip. - * @Default {5} - */ - width?: number; -} - -export interface TooltipFont { - - /** Font color of the text in the tooltip. - * @Default {null} - */ - color?: string; - - /** Font Family for the tooltip. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Specifies the font Style for the tooltip. - * @Default {Normal} - */ - fontStyle?: ej.datavisualization.Sunburst.FontStyle|string; - - /** Specifies the font weight for the tooltip. - * @Default {Regular} - */ - fontWeight?: ej.datavisualization.Sunburst.FontWeight|string; - - /** Opacity for text in the tooltip. - * @Default {1} - */ - opacity?: number; - - /** Font size for text in the tooltip. - * @Default {12px} - */ - size?: string; -} - -export interface Tooltip { - - /** tooltip visibility of the Sunburst. - * @Default {true} - */ - visible?: boolean; - - /** Options for customizing the border of the sunburst tooltip. - */ - border?: TooltipBorder; - - /** Fill color for the sunburst tooltip. - * @Default {null} - */ - fill?: string; - - /** Options for customizing the font of the tooltip. - */ - font?: TooltipFont; - - /** Custom template to the tooltip. - * @Default {null} - */ - template?: string; -} - -export interface Points { - - /** Points x value of the sunburst. - * @Default {null} - */ - x?: string; - - /** Points y value of the sunburst. - * @Default {null} - */ - y?: number; - - /** Points text of the sunburst. - * @Default {null} - */ - text?: string; - - /** Points fill color of the sunburst. - * @Default {null} - */ - fill?: string; -} - -export interface DataLabelSettingsFont { - - /** Font family of the data label. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style of the data label. - * @Default {normal. See FontStyle} - */ - fontStyle?: ej.datavisualization.Sunburst.FontStyle|string; - - /** Font weight of the data label. - * @Default {regular. See FontWeight} - */ - fontWeight?: ej.datavisualization.Sunburst.FontWeight|string; - - /** Opacity of the text. - * @Default {1} - */ - opacity?: number; - - /** Font color of the data label text. - * @Default {null} - */ - color?: string; - - /** Font size of the data label. - * @Default {12px} - */ - size?: string; -} - -export interface DataLabelSettings { - - /** Datalabel visibility of the Sunburst. - * @Default {false} - */ - visible?: boolean; - - /** Alignment of sunburst datalabel - * @Default {Angle. See DatalabelAlignment} - */ - labelRotationMode?: ej.datavisualization.Sunburst.SunburstLabelRotationMode|string; - - /** Options for customizing the data label font. - */ - font?: DataLabelSettingsFont; - - /** Custom template for datalabel - * @Default {null} - */ - template?: string; - - /** Fill color for the datalabel - * @Default {null} - */ - fill?: string; - - /** Datalabel overflow mode - * @Default {Trim. See LabelOverflowMode} - */ - labelOverflowMode?: ej.datavisualization.Sunburst.SunburstLabelOverflowMode|string; -} - -export interface TitleFont { - - /** Font family for Sunburst title. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style for Sunburst title. - * @Default {Normal. See FontStyle} - */ - fontStyle?: ej.datavisualization.Sunburst.FontStyle|string; - - /** Font weight for Sunburst title. - * @Default {Regular. See FontWeight} - */ - fontWeight?: ej.datavisualization.Sunburst.FontWeight|string; - - /** Opacity of the Sunburst title. - * @Default {1} - */ - opacity?: number; - - /** Font size for Sunburst title. - * @Default {20px} - */ - size?: string; -} - -export interface TitleSubtitleFont { - - /** Font family of sub title. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style for sub title. - * @Default {Normal. See FontStyle} - */ - fontStyle?: ej.datavisualization.Sunburst.FontStyle|string; - - /** Font weight for sub title. - * @Default {Regular. See FontWeight} - */ - fontWeight?: ej.datavisualization.Sunburst.FontWeight|string; - - /** Opacity of the sub title. - * @Default {1} - */ - opacity?: number; - - /** Font size for sub title. - * @Default {12px} - */ - size?: string; -} - -export interface TitleSubtitle { - - /** Subtitle text for sunburst - */ - text?: string; - - /** Sub title text visibility for sunburst - * @Default {true} - */ - visible?: string; - - /** Sub title text alignment - * @Default {far. See TextAlignment} - */ - textAlignment?: ej.datavisualization.Sunburst.SunburstAlignment|string; - - /** Options for customizing the font of sub title. - */ - font?: TitleSubtitleFont; -} - -export interface Title { - - /** Title text for sunburst - */ - text?: string; - - /** Title text visibility for sunburst - * @Default {true} - */ - visible?: string; - - /** Title text alignment - * @Default {center. See TextAlignment} - */ - textAlignment?: ej.datavisualization.Sunburst.SunburstAlignment|string; - - /** Options for customizing the font of sunburst title. - */ - font?: TitleFont; - - /** Options to customize the sub title of Sunburst. - */ - subtitle?: TitleSubtitle; -} - -export interface HighlightSettings { - - /** Enables/disables the ability to highlight the levels or point interactively. - * @Default {false} - */ - enable?: boolean; - - /** Specifies whether the levels or point has to be highlighted. - * @Default {point. See Mode} - */ - mode?: ej.datavisualization.Sunburst.SunburstHighlightMode|string; - - /** Color of the levels/point on highlight. - * @Default {red} - */ - color?: string; - - /** Opacity of the levels/point on highlight. - * @Default {0.5} - */ - opacity?: number; - - /** Specifies whether the levels or data point has to be highlighted. - * @Default {opacity. See Mode} - */ - type?: ej.datavisualization.Sunburst.SunburstHighlightType|string; -} - -export interface SelectionSettings { - - /** Enables/disables the ability to select the levels or data point interactively. - * @Default {false} - */ - enable?: boolean; - - /** Specifies whether the levels or data point has to be selected. - * @Default {point. See Mode} - */ - mode?: ej.datavisualization.Sunburst.SunburstHighlightMode|string; - - /** Color of the levels/point on selection. - * @Default {green} - */ - color?: string; - - /** Opacity of the levels/point on selection. - * @Default {0.5} - */ - opacity?: number; - - /** Specifies whether the levels or data point has to be selected. - * @Default {opacity. See Mode} - */ - type?: ej.datavisualization.Sunburst.SunburstHighlightType|string; -} - -export interface Level { - - /** Specifies the group member path - * @Default {null} - */ - groupMemberPath?: string; -} - -export interface LegendBorder { - - /** Border color of the legend. - * @Default {null} - */ - color?: string; - - /** Border width of the legend. - * @Default {1} - */ - width?: number; -} - -export interface LegendFont { - - /** Font family for legend item text. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style for legend item text. - * @Default {Normal. See FontStyle} - */ - fontStyle?: ej.datavisualization.Sunburst.FontStyle|string; - - /** Font weight for legend item text. - * @Default {Regular. See FontWeight} - */ - fontWeight?: ej.datavisualization.Sunburst.FontWeight|string; - - /** Font size for legend item text. - * @Default {12px} - */ - size?: string; -} - -export interface LegendItemStyle { - - /** Height of the shape in legend items. - * @Default {10} - */ - height?: number; - - /** Width of the shape in legend items. - * @Default {10} - */ - width?: number; -} - -export interface LegendLocation { - - /** X value or horizontal offset to position the legend in chart. - * @Default {0} - */ - x?: number; - - /** Y value or vertical offset to position the legend. - * @Default {0} - */ - y?: number; -} - -export interface LegendSize { - - /** Height of the legend. Height can be specified in either pixel or percentage. - * @Default {null} - */ - height?: string; - - /** Width of the legend. Width can be specified in either pixel or percentage. - * @Default {null} - */ - width?: string; -} - -export interface LegendTitleFont { - - /** Font family for the text in legend title. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style for legend title. - * @Default {normal. See FontStyle} - */ - fontStyle?: ej.datavisualization.Sunburst.FontStyle|string; - - /** Font weight for legend title. - * @Default {normal. See FontWeight} - */ - fontWeight?: ej.datavisualization.Sunburst.FontWeight|string; - - /** Font size for legend title. - * @Default {12px} - */ - size?: string; -} - -export interface LegendTitle { - - /** Options to customize the font used for legend title - */ - font?: LegendTitleFont; - - /** Enables or disables the legend title. - * @Default {true} - */ - visible?: string; - - /** Text to be displayed in legend title. - */ - text?: string; - - /** Alignment of the legend title. - * @Default {center. See Alignment} - */ - textAlignment?: ej.datavisualization.Sunburst.SunburstAlignment|string; -} - -export interface Legend { - - /** Visibility of the legend. - * @Default {false} - */ - visible?: boolean; - - /** Interactive action of legend items. - * @Default {toggleSegmentVisibility. See Alignment} - */ - clickAction?: ej.datavisualization.Sunburst.SunburstClickAction|string; - - /** Horizontal alignment of the legend. - * @Default {Center. See Alignment} - */ - alignment?: ej.datavisualization.Sunburst.SunburstAlignment|string; - - /** Options for customizing the legend border. - */ - border?: LegendBorder; - - /** Number of columns to arrange the legend items. - * @Default {null} - */ - columnCount?: number; - - /** Number of rows to arrange the legend items. - * @Default {null} - */ - rowCount?: number; - - /** Options to customize the font used for legend item text. - */ - font?: LegendFont; - - /** Gap or padding between the legend items. - * @Default {10} - */ - itemPadding?: number; - - /** Options to customize the style of legend items. - */ - itemStyle?: LegendItemStyle; - - /** Options to customize the location of sunburst legend. Legend is placed in provided location only when value of position property is custom - */ - location?: LegendLocation; - - /** Places the legend at specified position. Legend can be placed at left, right, top or bottom of the chart area.To manually specify the location of legend, set custom as value to this property. - * @Default {Bottom. See Position} - */ - position?: ej.datavisualization.Sunburst.SunburstLegendPosition|string; - - /** Shape of the legend items. - * @Default {None. See Shape} - */ - shape?: ej.datavisualization.Sunburst.SunburstLegendShape|string; - - /** Options to customize the size of the legend. - */ - size?: LegendSize; - - /** Options to customize the legend title. - */ - title?: LegendTitle; -} - -export interface Margin { - - /** Spacing for the left margin of chart area. Setting positive value decreases the width of the chart area from left side. - * @Default {10} - */ - left?: number; - - /** Spacing for the right margin of chart area. Setting positive value decreases the width of the chart area from right side. - * @Default {10} - */ - right?: number; - - /** Spacing for the top margin of chart area. Setting positive value decreases the height of the chart area from the top. - * @Default {10} - */ - top?: number; - - /** Spacing for the bottom margin of the chart area. Setting positive value decreases the height of the chart area from the bottom. - * @Default {10} - */ - bottom?: number; -} - -export interface ZoomSettings { - - /** Enables or disables zooming. - * @Default {false} - */ - enable?: boolean; - - /** Toolbar horizontal alignment - * @Default {right. See Alignment} - */ - toolbarHorizontalAlignment?: ej.datavisualization.Sunburst.SunburstHorizontalAlignment|string; - - /** Toolbar vertical alignment - * @Default {top. See Alignment} - */ - toolbarVerticalAlignment?: ej.datavisualization.Sunburst.SunburstVerticalAlignment|string; -} -} -namespace Sunburst { -enum FontStyle { -//string -Normal, -//string -Italic, -} -} -namespace Sunburst { -enum FontWeight { -//string -Regular, -//string -Bold, -//string -Lighter, -} -} -namespace Sunburst { -enum SunburstLabelRotationMode { -//string -Angle, -//string -Normal, -} -} -namespace Sunburst { -enum SunburstLabelOverflowMode { -//string -Trim, -//string -Hide, -//string -None, -} -} -namespace Sunburst { -enum SunburstAlignment { -//string -Center, -//string -Near, -//string -Far, -} -} -namespace Sunburst { -enum SunburstHighlightMode { -//string -Point, -//string -Parent, -//string -Child, -//string -All, -} -} -namespace Sunburst { -enum SunburstHighlightType { -//string -Opacity, -//string -Color, -} -} -namespace Sunburst { -enum SunburstClickAction { -//string -None, -//string -ToggleSegmentVisibility, -//string -ToggleSegmentSelection, -} -} -namespace Sunburst { -enum SunburstLegendPosition { -//string -Left, -//string -Right, -//string -Top, -//string -Bottom, -} -} -namespace Sunburst { -enum SunburstLegendShape { -//string -Diamond, -//string -Pentagon, -//string -Rectangle, -//string -Circle, -//string -Cross, -//string -Triangle, -} -} -namespace Sunburst { -enum SunburstTheme { -//string -FlatLight, -//string -FlatDark, -} -} -namespace Sunburst { -enum SunburstHorizontalAlignment { -//string -Center, -//string -Left, -//string -Right, -} -} -namespace Sunburst { -enum SunburstVerticalAlignment { -//string -Top, -//string -Bottom, -//string -Middle, -} -} -namespace Sunburst { -enum Animation { -//string -Rotation, -//string -FadeIn, -} -} - -class PivotGrid extends ej.Widget { - static fn: PivotGrid; - constructor(element: JQuery | Element, options?: PivotGrid.Model); - static Locale: any; - model: PivotGrid.Model; - defaults: PivotGrid.Model; - - /** Performs an asynchronous HTTP (AJAX) request. - * @returns {void} - */ - doAjaxPost(): void; - - /** Performs an asynchronous HTTP (FullPost) submit. - * @returns {void} - */ - doPostBack(): void; - - /** Exports the PivotGrid to the specified format. - * @returns {void} - */ - exportPivotGrid(): void; - - /** This function re-renders the PivotGrid on clicking the navigation buttons on PivotPager. - * @returns {void} - */ - refreshPagedPivotGrid(): void; - - /** This function refreshes the PivotGrid with modified data input in client-mode. - * @returns {void} - */ - refreshPivotGrid(): void; - - /** This function re-renders the control with the report available at that instant. - * @returns {void} - */ - refreshControl(): void; - - /** This function returns the height of all rows and width each and every column. - * @returns {any} - */ - calculateCellWidths(): any; - - /** This function creates the conditional formatting dialog to apply conditional formatting for PivotGrid control. - * @returns {void} - */ - createConditionalDialog(): void; - - /** This function saves the current report to the database/local storage. - * @returns {void} - */ - saveReport(): void; - - /** This function loads the specified report from the database/local storage. - * @returns {void} - */ - loadReport(): void; - - /** This function reconstructs the JSON data formed for rendering PivotGrid in excel-like layout format. - * @returns {void} - */ - excelLikeLayout(): void; - - /** Returns the OlapReport string maintained along with the axis elements information. - * @returns {string} - */ - getOlapReport(): string; - - /** Sets the OlapReport string along with the axis information. - * @returns {void} - */ - setOlapReport(): void; - - /** Returns the JSON records formed to render the control. - * @returns {Array} - */ - getJSONRecords(): any[]; - - /** Sets the JSON records formed to render the control. - * @returns {void} - */ - setJSONRecords(): void; - - /** This function allows user to change the caption of the Pivot Item (name displayed in UI) on-demand for relational datasource in client-mode. - * @returns {void} - */ - refreshFieldCaption(): void; - - /** This function receives the JSON formatted datasource to render the PivotGrid control. - * @returns {void} - */ - renderControlFromJSON(): void; -} -export namespace PivotGrid { - -export interface Model { - - /** Sets the mode for the PivotGrid widget for binding either OLAP or relational data source. - * @Default {ej.Pivot.AnalysisMode.Pivot} - */ - analysisMode?: ej.Pivot.AnalysisMode|string; - - /** Specifies the CSS class to PivotGrid to achieve custom theme. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - cssClass?: string; - - /** Connects the PivotSchemaDesigner with the specified ID to the PivotGrid Control. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - pivotTableFieldListID?: string; - - /** Initializes the data source for the PivotGrid widget, when it functions completely on client-side. - * @Default {{}} - */ - dataSource?: DataSource; - - /** Holds the neccessary properties for value sorting. - * @Default {{}} - */ - valueSortSettings?: ValueSortSettings; - - /** Object that holds the settings of frozen headers. - * @Default {{}} - */ - frozenHeaderSettings?: FrozenHeaderSettings; - - /** Object utilized to pass additional information between client-end and service-end on operating the control in server mode. - * @Default {null} - */ - customObject?: any; - - /** Allows the user to collapsed the specified members in each field by default. - * @Default {null} - */ - collapsedMembers?: any; - - /** Allows the user to access each cell on mouse right-click. - * @Default {false} - */ - enableCellContext?: boolean; - - /** Enables the cell selection for a specific range of value cells. - * @Default {false} - */ - enableCellSelection?: boolean; - - /** Enables the Drill-Through feature which retrieves the raw items that are used to create the specific cell in PivotGrid. - * @Default {false} - */ - enableDrillThrough?: boolean; - - /** Allows user to get the cell details in JSON format on double clicking the cell. - * @Default {false} - */ - enableCellDoubleClick?: boolean; - - /** Allows user to edit the value cells for write-back support in PivotGrid. This is applicable only for server-mode. - * @Default {false} - */ - enableCellEditing?: boolean; - - /** Collapses the Pivot items along rows and columns by default. It works only for relational data source. - * @Default {false} - */ - enableCollapseByDefault?: boolean; - - /** Enables/Disables the display of grand total for all the columns. - * @Default {true} - */ - enableColumnGrandTotal?: boolean; - - /** Allows the user to format a specific set of cells based on the condition. - * @Default {false} - */ - enableConditionalFormatting?: boolean; - - /** Enables the advanced filtering options Value Filtering, Label Filtering and Sorting for each fields in server mode. - * @Default {false} - */ - enableAdvancedFilter?: boolean; - - /** Allows the user to refresh the control on-demand and not during every UI operation. - * @Default {false} - */ - enableDeferUpdate?: boolean; - - /** Enables the display of GroupingBar allowing you to filter, sort and remove fields obtained from datasource. - * @Default {false} - */ - enableGroupingBar?: boolean; - - /** Enables/Disables the display of grand total for rows and columns. - * @Default {true} - */ - enableGrandTotal?: boolean; - - /** Allows the user to load PivotGrid using JSON data. - * @Default {false} - */ - enableJSONRendering?: boolean; - - /** Enables rendering of PivotGrid widget along with the PivotTable Field List, which allows UI operations. - * @Default {true} - */ - enablePivotFieldList?: boolean; - - /** Enables the display of grand total for all the rows. - * @Default {true} - */ - enableRowGrandTotal?: boolean; - - /** Allows the user to view layout of the PivotGrid from right to left. - * @Default {false} - */ - enableRTL?: boolean; - - /** Allows the user to enable ToolTip option. - * @Default {false} - */ - enableToolTip?: boolean; - - /** Allows the user to enable the animation effects in tooltip. - * @Default {false} - */ - enableToolTipAnimation?: boolean; - - /** Allows the user to adjust the width of the columns dynamically. - * @Default {false} - */ - enableColumnResizing?: boolean; - - /** Allows the user to view large amount of data through virtual scrolling. - * @Default {false} - */ - enableVirtualScrolling?: boolean; - - /** Allows the user to view large amount of data by applying paging. - * @Default {false} - */ - enablePaging?: boolean; - - /** Allows the user to configure hyperlink settings of PivotGrid control. - * @Default {{}} - */ - hyperlinkSettings?: HyperlinkSettings; - - /** Allows the user to enable PivotGridĂ¢â‚¬â„¢s responsiveness in the browser layout. - * @Default {false} - */ - isResponsive?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; + + /** Instance of the sunburst model object + */ + model?: any; + + /** Name of the event + */ + type?: string; + } + + export interface Border { + + /** Border color of the sunburst. + * @Default {null} + */ + color?: string; + + /** Width of the Sunburst border. + * @Default {2} + */ + width?: number; + } + + export interface SegmentBorder { + + /** Segment Border color of the sunburst. + * @Default {null} + */ + color?: string; + + /** Width of the Sunburst segment border. + * @Default {2} + */ + width?: number; + } + + export interface Size { + + /** Height of the Sunburst. + * @Default {''} + */ + height?: string; + + /** Width of the Sunburst. + * @Default {''} + */ + width?: string; + } + + export interface TooltipBorder { + + /** Border color of the tooltip. + * @Default {null} + */ + color?: string; + + /** Border width of the tooltip. + * @Default {5} + */ + width?: number; + } + + export interface TooltipFont { + + /** Font color of the text in the tooltip. + * @Default {null} + */ + color?: string; + + /** Font Family for the tooltip. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Specifies the font Style for the tooltip. + * @Default {Normal} + */ + fontStyle?: ej.datavisualization.Sunburst.FontStyle | string; + + /** Specifies the font weight for the tooltip. + * @Default {Regular} + */ + fontWeight?: ej.datavisualization.Sunburst.FontWeight | string; + + /** Opacity for text in the tooltip. + * @Default {1} + */ + opacity?: number; + + /** Font size for text in the tooltip. + * @Default {12px} + */ + size?: string; + } + + export interface Tooltip { + + /** tooltip visibility of the Sunburst. + * @Default {true} + */ + visible?: boolean; + + /** Options for customizing the border of the sunburst tooltip. + */ + border?: TooltipBorder; + + /** Fill color for the sunburst tooltip. + * @Default {null} + */ + fill?: string; + + /** Options for customizing the font of the tooltip. + */ + font?: TooltipFont; + + /** Custom template to the tooltip. + * @Default {null} + */ + template?: string; + } + + export interface Points { + + /** Points x value of the sunburst. + * @Default {null} + */ + x?: string; + + /** Points y value of the sunburst. + * @Default {null} + */ + y?: number; + + /** Points text of the sunburst. + * @Default {null} + */ + text?: string; + + /** Points fill color of the sunburst. + * @Default {null} + */ + fill?: string; + } + + export interface DataLabelSettingsFont { + + /** Font family of the data label. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style of the data label. + * @Default {normal. See FontStyle} + */ + fontStyle?: ej.datavisualization.Sunburst.FontStyle | string; + + /** Font weight of the data label. + * @Default {regular. See FontWeight} + */ + fontWeight?: ej.datavisualization.Sunburst.FontWeight | string; + + /** Opacity of the text. + * @Default {1} + */ + opacity?: number; + + /** Font color of the data label text. + * @Default {null} + */ + color?: string; + + /** Font size of the data label. + * @Default {12px} + */ + size?: string; + } + + export interface DataLabelSettings { + + /** Datalabel visibility of the Sunburst. + * @Default {false} + */ + visible?: boolean; + + /** Alignment of sunburst datalabel + * @Default {Angle. See DatalabelAlignment} + */ + labelRotationMode?: ej.datavisualization.Sunburst.SunburstLabelRotationMode | string; + + /** Options for customizing the data label font. + */ + font?: DataLabelSettingsFont; + + /** Custom template for datalabel + * @Default {null} + */ + template?: string; + + /** Fill color for the datalabel + * @Default {null} + */ + fill?: string; + + /** Datalabel overflow mode + * @Default {Trim. See LabelOverflowMode} + */ + labelOverflowMode?: ej.datavisualization.Sunburst.SunburstLabelOverflowMode | string; + } + + export interface TitleFont { + + /** Font family for Sunburst title. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style for Sunburst title. + * @Default {Normal. See FontStyle} + */ + fontStyle?: ej.datavisualization.Sunburst.FontStyle | string; + + /** Font weight for Sunburst title. + * @Default {Regular. See FontWeight} + */ + fontWeight?: ej.datavisualization.Sunburst.FontWeight | string; + + /** Opacity of the Sunburst title. + * @Default {1} + */ + opacity?: number; + + /** Font size for Sunburst title. + * @Default {20px} + */ + size?: string; + } + + export interface TitleSubtitleFont { + + /** Font family of sub title. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style for sub title. + * @Default {Normal. See FontStyle} + */ + fontStyle?: ej.datavisualization.Sunburst.FontStyle | string; + + /** Font weight for sub title. + * @Default {Regular. See FontWeight} + */ + fontWeight?: ej.datavisualization.Sunburst.FontWeight | string; + + /** Opacity of the sub title. + * @Default {1} + */ + opacity?: number; + + /** Font size for sub title. + * @Default {12px} + */ + size?: string; + } + + export interface TitleSubtitle { + + /** Subtitle text for sunburst + */ + text?: string; + + /** Sub title text visibility for sunburst + * @Default {true} + */ + visible?: string; + + /** Sub title text alignment + * @Default {far. See TextAlignment} + */ + textAlignment?: ej.datavisualization.Sunburst.SunburstAlignment | string; + + /** Options for customizing the font of sub title. + */ + font?: TitleSubtitleFont; + } + + export interface Title { + + /** Title text for sunburst + */ + text?: string; + + /** Title text visibility for sunburst + * @Default {true} + */ + visible?: string; + + /** Title text alignment + * @Default {center. See TextAlignment} + */ + textAlignment?: ej.datavisualization.Sunburst.SunburstAlignment | string; + + /** Options for customizing the font of sunburst title. + */ + font?: TitleFont; + + /** Options to customize the sub title of Sunburst. + */ + subtitle?: TitleSubtitle; + } + + export interface HighlightSettings { + + /** Enables/disables the ability to highlight the levels or point interactively. + * @Default {false} + */ + enable?: boolean; + + /** Specifies whether the levels or point has to be highlighted. + * @Default {point. See Mode} + */ + mode?: ej.datavisualization.Sunburst.SunburstHighlightMode | string; + + /** Color of the levels/point on highlight. + * @Default {red} + */ + color?: string; + + /** Opacity of the levels/point on highlight. + * @Default {0.5} + */ + opacity?: number; + + /** Specifies whether the levels or data point has to be highlighted. + * @Default {opacity. See Mode} + */ + type?: ej.datavisualization.Sunburst.SunburstHighlightType | string; + } + + export interface SelectionSettings { + + /** Enables/disables the ability to select the levels or data point interactively. + * @Default {false} + */ + enable?: boolean; + + /** Specifies whether the levels or data point has to be selected. + * @Default {point. See Mode} + */ + mode?: ej.datavisualization.Sunburst.SunburstHighlightMode | string; + + /** Color of the levels/point on selection. + * @Default {green} + */ + color?: string; + + /** Opacity of the levels/point on selection. + * @Default {0.5} + */ + opacity?: number; + + /** Specifies whether the levels or data point has to be selected. + * @Default {opacity. See Mode} + */ + type?: ej.datavisualization.Sunburst.SunburstHighlightType | string; + } + + export interface Level { + + /** Specifies the group member path + * @Default {null} + */ + groupMemberPath?: string; + } + + export interface LegendBorder { + + /** Border color of the legend. + * @Default {null} + */ + color?: string; + + /** Border width of the legend. + * @Default {1} + */ + width?: number; + } + + export interface LegendFont { + + /** Font family for legend item text. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style for legend item text. + * @Default {Normal. See FontStyle} + */ + fontStyle?: ej.datavisualization.Sunburst.FontStyle | string; + + /** Font weight for legend item text. + * @Default {Regular. See FontWeight} + */ + fontWeight?: ej.datavisualization.Sunburst.FontWeight | string; + + /** Font size for legend item text. + * @Default {12px} + */ + size?: string; + } + + export interface LegendItemStyle { + + /** Height of the shape in legend items. + * @Default {10} + */ + height?: number; + + /** Width of the shape in legend items. + * @Default {10} + */ + width?: number; + } + + export interface LegendLocation { + + /** X value or horizontal offset to position the legend in chart. + * @Default {0} + */ + x?: number; + + /** Y value or vertical offset to position the legend. + * @Default {0} + */ + y?: number; + } + + export interface LegendSize { + + /** Height of the legend. Height can be specified in either pixel or percentage. + * @Default {null} + */ + height?: string; + + /** Width of the legend. Width can be specified in either pixel or percentage. + * @Default {null} + */ + width?: string; + } + + export interface LegendTitleFont { + + /** Font family for the text in legend title. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style for legend title. + * @Default {normal. See FontStyle} + */ + fontStyle?: ej.datavisualization.Sunburst.FontStyle | string; + + /** Font weight for legend title. + * @Default {normal. See FontWeight} + */ + fontWeight?: ej.datavisualization.Sunburst.FontWeight | string; + + /** Font size for legend title. + * @Default {12px} + */ + size?: string; + } + + export interface LegendTitle { + + /** Options to customize the font used for legend title + */ + font?: LegendTitleFont; + + /** Enables or disables the legend title. + * @Default {true} + */ + visible?: string; + + /** Text to be displayed in legend title. + */ + text?: string; + + /** Alignment of the legend title. + * @Default {center. See Alignment} + */ + textAlignment?: ej.datavisualization.Sunburst.SunburstAlignment | string; + } + + export interface Legend { + + /** Visibility of the legend. + * @Default {false} + */ + visible?: boolean; + + /** Interactive action of legend items. + * @Default {toggleSegmentVisibility. See Alignment} + */ + clickAction?: ej.datavisualization.Sunburst.SunburstClickAction | string; + + /** Horizontal alignment of the legend. + * @Default {Center. See Alignment} + */ + alignment?: ej.datavisualization.Sunburst.SunburstAlignment | string; + + /** Options for customizing the legend border. + */ + border?: LegendBorder; + + /** Number of columns to arrange the legend items. + * @Default {null} + */ + columnCount?: number; + + /** Number of rows to arrange the legend items. + * @Default {null} + */ + rowCount?: number; + + /** Options to customize the font used for legend item text. + */ + font?: LegendFont; + + /** Gap or padding between the legend items. + * @Default {10} + */ + itemPadding?: number; + + /** Options to customize the style of legend items. + */ + itemStyle?: LegendItemStyle; + + /** Options to customize the location of sunburst legend. Legend is placed in provided location only when value of position property is custom + */ + location?: LegendLocation; + + /** Places the legend at specified position. Legend can be placed at left, right, top or bottom of the chart area.To manually specify the location of legend, set custom as value to this property. + * @Default {Bottom. See Position} + */ + position?: ej.datavisualization.Sunburst.SunburstLegendPosition | string; + + /** Shape of the legend items. + * @Default {None. See Shape} + */ + shape?: ej.datavisualization.Sunburst.SunburstLegendShape | string; + + /** Options to customize the size of the legend. + */ + size?: LegendSize; + + /** Options to customize the legend title. + */ + title?: LegendTitle; + } + + export interface Margin { + + /** Spacing for the left margin of chart area. Setting positive value decreases the width of the chart area from left side. + * @Default {10} + */ + left?: number; + + /** Spacing for the right margin of chart area. Setting positive value decreases the width of the chart area from right side. + * @Default {10} + */ + right?: number; + + /** Spacing for the top margin of chart area. Setting positive value decreases the height of the chart area from the top. + * @Default {10} + */ + top?: number; + + /** Spacing for the bottom margin of the chart area. Setting positive value decreases the height of the chart area from the bottom. + * @Default {10} + */ + bottom?: number; + } + + export interface ZoomSettings { + + /** Enables or disables zooming. + * @Default {false} + */ + enable?: boolean; + + /** Toolbar horizontal alignment + * @Default {right. See Alignment} + */ + toolbarHorizontalAlignment?: ej.datavisualization.Sunburst.SunburstHorizontalAlignment | string; + + /** Toolbar vertical alignment + * @Default {top. See Alignment} + */ + toolbarVerticalAlignment?: ej.datavisualization.Sunburst.SunburstVerticalAlignment | string; + } + } + namespace Sunburst { + enum FontStyle { + //string + Normal, + //string + Italic, + } + } + namespace Sunburst { + enum FontWeight { + //string + Regular, + //string + Bold, + //string + Lighter, + } + } + namespace Sunburst { + enum SunburstLabelRotationMode { + //string + Angle, + //string + Normal, + } + } + namespace Sunburst { + enum SunburstLabelOverflowMode { + //string + Trim, + //string + Hide, + //string + None, + } + } + namespace Sunburst { + enum SunburstAlignment { + //string + Center, + //string + Near, + //string + Far, + } + } + namespace Sunburst { + enum SunburstHighlightMode { + //string + Point, + //string + Parent, + //string + Child, + //string + All, + } + } + namespace Sunburst { + enum SunburstHighlightType { + //string + Opacity, + //string + Color, + } + } + namespace Sunburst { + enum SunburstClickAction { + //string + None, + //string + ToggleSegmentVisibility, + //string + ToggleSegmentSelection, + } + } + namespace Sunburst { + enum SunburstLegendPosition { + //string + Left, + //string + Right, + //string + Top, + //string + Bottom, + } + } + namespace Sunburst { + enum SunburstLegendShape { + //string + Diamond, + //string + Pentagon, + //string + Rectangle, + //string + Circle, + //string + Cross, + //string + Triangle, + } + } + namespace Sunburst { + enum SunburstTheme { + //string + FlatLight, + //string + FlatDark, + } + } + namespace Sunburst { + enum SunburstHorizontalAlignment { + //string + Center, + //string + Left, + //string + Right, + } + } + namespace Sunburst { + enum SunburstVerticalAlignment { + //string + Top, + //string + Bottom, + //string + Middle, + } + } + namespace Sunburst { + enum Animation { + //string + Rotation, + //string + FadeIn, + } + } + + class PivotGrid extends ej.Widget { + static fn: PivotGrid; + constructor(element: JQuery | Element, options?: PivotGrid.Model); + static Locale: any; + model: PivotGrid.Model; + defaults: PivotGrid.Model; + + /** Performs an asynchronous HTTP (AJAX) request. + * @returns {void} + */ + doAjaxPost(): void; + + /** Performs an asynchronous HTTP (FullPost) submit. + * @returns {void} + */ + doPostBack(): void; + + /** Exports the PivotGrid to the specified format. + * @returns {void} + */ + exportPivotGrid(): void; + + /** This function re-renders the PivotGrid on clicking the navigation buttons on PivotPager. + * @returns {void} + */ + refreshPagedPivotGrid(): void; + + /** This function refreshes the PivotGrid with modified data input in client-mode. + * @returns {void} + */ + refreshPivotGrid(): void; + + /** This function re-renders the control with the report available at that instant. + * @returns {void} + */ + refreshControl(): void; + + /** This function returns the height of all rows and width each and every column. + * @returns {any} + */ + calculateCellWidths(): any; + + /** This function creates the conditional formatting dialog to apply conditional formatting for PivotGrid control. + * @returns {void} + */ + createConditionalDialog(): void; + + /** This function saves the current report to the database/local storage. + * @returns {void} + */ + saveReport(): void; + + /** This function loads the specified report from the database/local storage. + * @returns {void} + */ + loadReport(): void; + + /** This function reconstructs the JSON data formed for rendering PivotGrid in excel-like layout format. + * @returns {void} + */ + excelLikeLayout(): void; + + /** Returns the OlapReport string maintained along with the axis elements information. + * @returns {string} + */ + getOlapReport(): string; + + /** Sets the OlapReport string along with the axis information. + * @returns {void} + */ + setOlapReport(): void; + + /** Returns the JSON records formed to render the control. + * @returns {Array} + */ + getJSONRecords(): any[]; + + /** Sets the JSON records formed to render the control. + * @returns {void} + */ + setJSONRecords(): void; + + /** This function allows user to change the caption of the Pivot Item (name displayed in UI) on-demand for relational datasource in client-mode. + * @returns {void} + */ + refreshFieldCaption(): void; + + /** This function receives the JSON formatted datasource to render the PivotGrid control. + * @returns {void} + */ + renderControlFromJSON(): void; + } + export namespace PivotGrid { + + export interface Model { + + /** Sets the mode for the PivotGrid widget for binding either OLAP or relational data source. + * @Default {ej.Pivot.AnalysisMode.Pivot} + */ + analysisMode?: ej.Pivot.AnalysisMode | string; + + /** Specifies the CSS class to PivotGrid to achieve custom theme. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + cssClass?: string; + + /** Connects the PivotSchemaDesigner with the specified ID to the PivotGrid Control. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + pivotTableFieldListID?: string; + + /** Initializes the data source for the PivotGrid widget, when it functions completely on client-side. + * @Default {{}} + */ + dataSource?: DataSource; + + /** Holds the neccessary properties for value sorting. + * @Default {{}} + */ + valueSortSettings?: ValueSortSettings; + + /** Object that holds the settings of frozen headers. + * @Default {{}} + */ + frozenHeaderSettings?: FrozenHeaderSettings; + + /** Object utilized to pass additional information between client-end and service-end on operating the control in server mode. + * @Default {null} + */ + customObject?: any; + + /** Allows the user to collapsed the specified members in each field by default. + * @Default {null} + */ + collapsedMembers?: any; + + /** Allows the user to access each cell on mouse right-click. + * @Default {false} + */ + enableCellContext?: boolean; + + /** Enables the cell selection for a specific range of value cells. + * @Default {false} + */ + enableCellSelection?: boolean; + + /** Enables the Drill-Through feature which retrieves the raw items that are used to create the specific cell in PivotGrid. + * @Default {false} + */ + enableDrillThrough?: boolean; + + /** Allows user to get the cell details in JSON format on double clicking the cell. + * @Default {false} + */ + enableCellDoubleClick?: boolean; + + /** Allows user to edit the value cells for write-back support in PivotGrid. This is applicable only for server-mode. + * @Default {false} + */ + enableCellEditing?: boolean; + + /** Collapses the Pivot items along rows and columns by default. It works only for relational data source. + * @Default {false} + */ + enableCollapseByDefault?: boolean; + + /** Enables/Disables the display of grand total for all the columns. + * @Default {true} + */ + enableColumnGrandTotal?: boolean; + + /** Allows the user to format a specific set of cells based on the condition. + * @Default {false} + */ + enableConditionalFormatting?: boolean; + + /** Enables the advanced filtering options Value Filtering, Label Filtering and Sorting for each fields in server mode. + * @Default {false} + */ + enableAdvancedFilter?: boolean; + + /** Allows the user to refresh the control on-demand and not during every UI operation. + * @Default {false} + */ + enableDeferUpdate?: boolean; + + /** Enables the display of GroupingBar allowing you to filter, sort and remove fields obtained from datasource. + * @Default {false} + */ + enableGroupingBar?: boolean; + + /** Enables/Disables the display of grand total for rows and columns. + * @Default {true} + */ + enableGrandTotal?: boolean; + + /** Allows the user to load PivotGrid using JSON data. + * @Default {false} + */ + enableJSONRendering?: boolean; + + /** Enables rendering of PivotGrid widget along with the PivotTable Field List, which allows UI operations. + * @Default {true} + */ + enablePivotFieldList?: boolean; + + /** Enables the display of grand total for all the rows. + * @Default {true} + */ + enableRowGrandTotal?: boolean; + + /** Allows the user to view layout of the PivotGrid from right to left. + * @Default {false} + */ + enableRTL?: boolean; + + /** Allows the user to enable ToolTip option. + * @Default {false} + */ + enableToolTip?: boolean; + + /** Allows the user to enable the animation effects in tooltip. + * @Default {false} + */ + enableToolTipAnimation?: boolean; + + /** Allows the user to adjust the width of the columns dynamically. + * @Default {false} + */ + enableColumnResizing?: boolean; + + /** Allows the user to view large amount of data through virtual scrolling. + * @Default {false} + */ + enableVirtualScrolling?: boolean; + + /** Allows the user to view large amount of data by applying paging. + * @Default {false} + */ + enablePaging?: boolean; + + /** Allows the user to configure hyperlink settings of PivotGrid control. + * @Default {{}} + */ + hyperlinkSettings?: HyperlinkSettings; + + /** Allows the user to enable PivotGridĂ¢â‚¬â„¢s responsiveness in the browser layout. + * @Default {false} + */ + isResponsive?: boolean; - /** Contains the serialized JSON string which renders PivotGrid. - */ - jsonRecords?: string; - - /** Sets the summary layout for PivotGrid.Following are the ways in which summary can be positioned: normal summary (bottom), top summary, no summary and excel-like summary. - * @Default {ej.PivotGrid.Layout.Normal} - */ - layout?: ej.PivotGrid.Layout|string; + /** Contains the serialized JSON string which renders PivotGrid. + */ + jsonRecords?: string; + + /** Sets the summary layout for PivotGrid.Following are the ways in which summary can be positioned: normal summary (bottom), top summary, no summary and excel-like summary. + * @Default {ej.PivotGrid.Layout.Normal} + */ + layout?: ej.PivotGrid.Layout | string; - /** Allows the user to set the localized language for the widget. - * @Default {en-US} - */ - locale?: string; + /** Allows the user to set the localized language for the widget. + * @Default {en-US} + */ + locale?: string; - /** Sets the mode for the PivotGrid widget for binding data source either in server-side or client-side. - * @Default {ej.Pivot.OperationalMode.ClientMode} - */ - operationalMode?: ej.Pivot.OperationalMode|string; + /** Sets the mode for the PivotGrid widget for binding data source either in server-side or client-side. + * @Default {ej.Pivot.OperationalMode.ClientMode} + */ + operationalMode?: ej.Pivot.OperationalMode | string; - /** Allows the user to set custom name for the methods at service-end, communicated during AJAX post. - * @Default {{}} - */ - serviceMethodSettings?: ServiceMethodSettings; + /** Allows the user to set custom name for the methods at service-end, communicated during AJAX post. + * @Default {{}} + */ + serviceMethodSettings?: ServiceMethodSettings; - /** Connects the service using the specified URL for any server updates. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - url?: string; + /** Connects the service using the specified URL for any server updates. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + url?: string; - /** Triggers when it reaches client-side after any AJAX request. */ - afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; + /** Triggers when it reaches client-side after any AJAX request. */ + afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; - /** Triggers before any AJAX request is passed from PivotGrid to service methods. */ - beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; + /** Triggers before any AJAX request is passed from PivotGrid to service methods. */ + beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; - /** Triggers before Pivot Engine starts to populate. */ - beforePivotEnginePopulate?(e: BeforePivotEnginePopulateEventArgs): void; + /** Triggers before Pivot Engine starts to populate. */ + beforePivotEnginePopulate?(e: BeforePivotEnginePopulateEventArgs): void; - /** Triggers when double click action is performed over a cell. */ - cellDoubleClick?(e: CellDoubleClickEventArgs): void; + /** Triggers when double click action is performed over a cell. */ + cellDoubleClick?(e: CellDoubleClickEventArgs): void; - /** Triggers when right-click action is performed on a cell. */ - cellContext?(e: CellContextEventArgs): void; + /** Triggers when right-click action is performed on a cell. */ + cellContext?(e: CellContextEventArgs): void; - /** Triggers when a specific range of value cells are selected. */ - cellSelection?(e: CellSelectionEventArgs): void; + /** Triggers when a specific range of value cells are selected. */ + cellSelection?(e: CellSelectionEventArgs): void; - /** Triggers when the hyperlink of column header is clicked. */ - columnHeaderHyperlinkClick?(e: ColumnHeaderHyperlinkClickEventArgs): void; + /** Triggers when the hyperlink of column header is clicked. */ + columnHeaderHyperlinkClick?(e: ColumnHeaderHyperlinkClickEventArgs): void; - /** Triggers after performing drill operation in PivotGrid. */ - drillSuccess?(e: DrillSuccessEventArgs): void; + /** Triggers after performing drill operation in PivotGrid. */ + drillSuccess?(e: DrillSuccessEventArgs): void; - /** Triggers while clicking "OK" button in the drill-through dialog. */ - drillThrough?(e: DrillThroughEventArgs): void; + /** Triggers while clicking "OK" button in the drill-through dialog. */ + drillThrough?(e: DrillThroughEventArgs): void; - /** Triggers when PivotGrid loading is initiated. */ - load?(e: LoadEventArgs): void; + /** Triggers when PivotGrid loading is initiated. */ + load?(e: LoadEventArgs): void; - /** Triggers when PivotGrid widget completes all operations at client-side after any AJAX request. */ - renderComplete?(e: RenderCompleteEventArgs): void; + /** Triggers when PivotGrid widget completes all operations at client-side after any AJAX request. */ + renderComplete?(e: RenderCompleteEventArgs): void; - /** Triggers when any error occurred during AJAX request. */ - renderFailure?(e: RenderFailureEventArgs): void; + /** Triggers when any error occurred during AJAX request. */ + renderFailure?(e: RenderFailureEventArgs): void; - /** Triggers when PivotGrid successfully reaches client-side after any AJAX request. */ - renderSuccess?(e: RenderSuccessEventArgs): void; + /** Triggers when PivotGrid successfully reaches client-side after any AJAX request. */ + renderSuccess?(e: RenderSuccessEventArgs): void; - /** Triggers when the hyperlink of row header is clicked. */ - rowHeaderHyperlinkClick?(e: RowHeaderHyperlinkClickEventArgs): void; + /** Triggers when the hyperlink of row header is clicked. */ + rowHeaderHyperlinkClick?(e: RowHeaderHyperlinkClickEventArgs): void; - /** Triggers when the hyperlink of summary cell is clicked. */ - summaryCellHyperlinkClick?(e: SummaryCellHyperlinkClickEventArgs): void; + /** Triggers when the hyperlink of summary cell is clicked. */ + summaryCellHyperlinkClick?(e: SummaryCellHyperlinkClickEventArgs): void; - /** Triggers when the hyperlink of value cell is clicked. */ - valueCellHyperlinkClick?(e: ValueCellHyperlinkClickEventArgs): void; + /** Triggers when the hyperlink of value cell is clicked. */ + valueCellHyperlinkClick?(e: ValueCellHyperlinkClickEventArgs): void; - /** Triggers before saving the current report to database. */ - saveReport?(e: SaveReportEventArgs): void; + /** Triggers before saving the current report to database. */ + saveReport?(e: SaveReportEventArgs): void; - /** Triggers before loading a report from database. */ - loadReport?(e: LoadReportEventArgs): void; + /** Triggers before loading a report from database. */ + loadReport?(e: LoadReportEventArgs): void; - /** Triggers before performing exporting in pivot grid. */ - beforeExport?(e: BeforeExportEventArgs): void; + /** Triggers before performing exporting in pivot grid. */ + beforeExport?(e: BeforeExportEventArgs): void; - /** Triggers before editing the cells. */ - cellEdit?(e: CellEditEventArgs): void; -} + /** Triggers before editing the cells. */ + cellEdit?(e: CellEditEventArgs): void; + } -export interface AfterServiceInvokeEventArgs { + export interface AfterServiceInvokeEventArgs { - /** returns the current action of PivotGrid control. - */ - action?: string; + /** returns the current action of PivotGrid control. + */ + action?: string; - /** returns the custom object bound with PivotGrid control. - */ - customObject?: any; + /** returns the custom object bound with PivotGrid control. + */ + customObject?: any; - /** returns the HTML element of PivotGrid control. - */ - element?: any; -} + /** returns the HTML element of PivotGrid control. + */ + element?: any; + } -export interface BeforeServiceInvokeEventArgs { + export interface BeforeServiceInvokeEventArgs { - /** returns the current action of PivotGrid control. - */ - action?: string; + /** returns the current action of PivotGrid control. + */ + action?: string; - /** returns the custom object bound with PivotGrid control. - */ - customObject?: any; + /** returns the custom object bound with PivotGrid control. + */ + customObject?: any; - /** returns the HTML element of PivotGrid control. - */ - element?: any; -} + /** returns the HTML element of PivotGrid control. + */ + element?: any; + } -export interface BeforePivotEnginePopulateEventArgs { + export interface BeforePivotEnginePopulateEventArgs { - /** returns the PivotGrid object - */ - pivotGridObject?: any; -} + /** returns the PivotGrid object + */ + pivotGridObject?: any; + } -export interface CellDoubleClickEventArgs { + export interface CellDoubleClickEventArgs { - /** returns the JSON details of the double clicked cell. - */ - selectedData?: any[]; + /** returns the JSON details of the double clicked cell. + */ + selectedData?: any[]; - /** returns the custom object bound with PivotGrid control. - */ - customObject?: any; + /** returns the custom object bound with PivotGrid control. + */ + customObject?: any; - /** returns the HTML element of PivotGrid control. - */ - element?: any; -} + /** returns the HTML element of PivotGrid control. + */ + element?: any; + } -export interface CellContextEventArgs { + export interface CellContextEventArgs { - /** returns the cell position (row index and column index) in table. - */ - cellPosition?: string; + /** returns the cell position (row index and column index) in table. + */ + cellPosition?: string; - /** returns the type of the cell. - */ - cellType?: string; + /** returns the type of the cell. + */ + cellType?: string; - /** returns the content of the cell. - */ - cellValue?: string; + /** returns the content of the cell. + */ + cellValue?: string; - /** returns the unique name of levels/members. - */ - uniqueName?: string; + /** returns the unique name of levels/members. + */ + uniqueName?: string; - /** returns the role of the cell in PivotGrid. - */ - role?: string; + /** returns the role of the cell in PivotGrid. + */ + role?: string; - /** returns JSON record corresponding to the selected cell. - */ - rawdata?: any; + /** returns JSON record corresponding to the selected cell. + */ + rawdata?: any; - /** returns the original event object. - */ - args?: any; -} + /** returns the original event object. + */ + args?: any; + } -export interface CellSelectionEventArgs { + export interface CellSelectionEventArgs { - /** returns the JSON records of the selected range of cells. - */ - JSONRecords?: any; + /** returns the JSON records of the selected range of cells. + */ + JSONRecords?: any; - /** Returns the row headers corresponding to the selected value cells. - */ - rowheader?: any; + /** Returns the row headers corresponding to the selected value cells. + */ + rowheader?: any; - /** Returns the column headers corresponding to the selected value cells. - */ - columnheader?: any; + /** Returns the column headers corresponding to the selected value cells. + */ + columnheader?: any; - /** Returns the information about the measure associated with the selected cell. - */ - measureCount?: string; -} + /** Returns the information about the measure associated with the selected cell. + */ + measureCount?: string; + } -export interface ColumnHeaderHyperlinkClickEventArgs { + export interface ColumnHeaderHyperlinkClickEventArgs { - /** returns the information about the clicked cell - */ - args?: any; + /** returns the information about the clicked cell + */ + args?: any; - /** returns the HTML element of the control. - */ - element?: any; + /** returns the HTML element of the control. + */ + element?: any; - /** returns the custom object bound to the control. - */ - customObject?: any; -} + /** returns the custom object bound to the control. + */ + customObject?: any; + } -export interface DrillSuccessEventArgs { + export interface DrillSuccessEventArgs { - /** returns the HTML element of the control. - */ - args?: any; -} + /** returns the HTML element of the control. + */ + args?: any; + } -export interface DrillThroughEventArgs { + export interface DrillThroughEventArgs { - /** return the JSON records of the generated cells on drill-through operation. - */ - data?: any; + /** return the JSON records of the generated cells on drill-through operation. + */ + data?: any; - /** returns the HTML element of PivotGrid control. - */ - element?: any; -} + /** returns the HTML element of PivotGrid control. + */ + element?: any; + } -export interface LoadEventArgs { + export interface LoadEventArgs { - /** returns the custom object bound with the control. - */ - customObject?: any; + /** returns the custom object bound with the control. + */ + customObject?: any; - /** returns the HTML element of PivotGrid control. - */ - element?: any; -} + /** returns the HTML element of PivotGrid control. + */ + element?: any; + } -export interface RenderCompleteEventArgs { + export interface RenderCompleteEventArgs { - /** returns the current action of PivotGrid control. - */ - action?: string; + /** returns the current action of PivotGrid control. + */ + action?: string; - /** returns the custom object bound with the control. - */ - customObject?: any; + /** returns the custom object bound with the control. + */ + customObject?: any; - /** returns the HTML element of PivotGrid control. - */ - element?: any; -} + /** returns the HTML element of PivotGrid control. + */ + element?: any; + } -export interface RenderFailureEventArgs { + export interface RenderFailureEventArgs { - /** returns the current action of PivotGrid control. - */ - action?: string; + /** returns the current action of PivotGrid control. + */ + action?: string; - /** returns the custom object bound with the control. - */ - customObject?: any; + /** returns the custom object bound with the control. + */ + customObject?: any; - /** returns the HTML element of PivotGrid control. - */ - element?: any; + /** returns the HTML element of PivotGrid control. + */ + element?: any; - /** returns the error message with error code. - */ - message?: string; -} + /** returns the error message with error code. + */ + message?: string; + } -export interface RenderSuccessEventArgs { + export interface RenderSuccessEventArgs { - /** returns the current action of PivotGrid control. - */ - action?: string; + /** returns the current action of PivotGrid control. + */ + action?: string; - /** returns the custom object bound with the control. - */ - customObject?: any; + /** returns the custom object bound with the control. + */ + customObject?: any; - /** returns the HTML element of PivotGrid control. - */ - element?: any; -} + /** returns the HTML element of PivotGrid control. + */ + element?: any; + } -export interface RowHeaderHyperlinkClickEventArgs { + export interface RowHeaderHyperlinkClickEventArgs { - /** returns the information about the clicked cell - */ - args?: any; + /** returns the information about the clicked cell + */ + args?: any; - /** returns the HTML element of the control. - */ - element?: any; + /** returns the HTML element of the control. + */ + element?: any; - /** returns the custom object bound to the control. - */ - customObject?: any; -} + /** returns the custom object bound to the control. + */ + customObject?: any; + } -export interface SummaryCellHyperlinkClickEventArgs { + export interface SummaryCellHyperlinkClickEventArgs { - /** returns the information about the clicked cell - */ - args?: any; + /** returns the information about the clicked cell + */ + args?: any; - /** returns the HTML element of the control. - */ - element?: any; + /** returns the HTML element of the control. + */ + element?: any; - /** returns the custom object bound to the control. - */ - customObject?: any; -} + /** returns the custom object bound to the control. + */ + customObject?: any; + } -export interface ValueCellHyperlinkClickEventArgs { + export interface ValueCellHyperlinkClickEventArgs { - /** returns the information about the clicked cell - */ - args?: any; + /** returns the information about the clicked cell + */ + args?: any; - /** returns the HTML element of the control. - */ - element?: any; + /** returns the HTML element of the control. + */ + element?: any; - /** returns the custom object bound to the control. - */ - customObject?: any; -} + /** returns the custom object bound to the control. + */ + customObject?: any; + } -export interface SaveReportEventArgs { + export interface SaveReportEventArgs { - /** returns the report to be stored in database. - */ - report?: any; -} + /** returns the report to be stored in database. + */ + report?: any; + } -export interface LoadReportEventArgs { + export interface LoadReportEventArgs { - /** returns the PivotGrid object. - */ - targetControl?: any; + /** returns the PivotGrid object. + */ + targetControl?: any; - /** returns whether the control is bound with OLAP or Relational data source. - */ - dataModel?: string; -} + /** returns whether the control is bound with OLAP or Relational data source. + */ + dataModel?: string; + } -export interface BeforeExportEventArgs { + export interface BeforeExportEventArgs { - /** contains the url of the service responsible for exporting. - */ - url?: string; + /** contains the url of the service responsible for exporting. + */ + url?: string; - /** contains the name of the exporting file. - */ - fileName?: string; -} + /** contains the name of the exporting file. + */ + fileName?: string; + } -export interface CellEditEventArgs { + export interface CellEditEventArgs { - /** contains the array of cells selected for editing. - */ - editCellsInfo?: any[]; -} + /** contains the array of cells selected for editing. + */ + editCellsInfo?: any[]; + } -export interface DataSourceColumnsAdvancedFilter { + export interface DataSourceColumnsAdvancedFilter { - /** Allows the user to provide level unique name to perform advanced filtering. - */ - name?: string; + /** Allows the user to provide level unique name to perform advanced filtering. + */ + name?: string; - /** Allows the user to set the operator to perform Label Filtering. - * @Default {none} - */ - labelFilterOperator?: string; - - /** Allows the user to set the operator to perform Value Filtering. - * @Default {none} - */ - valueFilterOperator?: string; + /** Allows the user to set the operator to perform Label Filtering. + * @Default {none} + */ + labelFilterOperator?: string; + + /** Allows the user to set the operator to perform Value Filtering. + * @Default {none} + */ + valueFilterOperator?: string; - /** Allows the user to set the filtering type while performing advanced filtering. - */ - advancedFilterType?: string; + /** Allows the user to set the filtering type while performing advanced filtering. + */ + advancedFilterType?: string; - /** In case of value filtering, this property contains the measure name to which the filter is applied. - */ - measure?: string; - - /** Allows the user to hold the filter operand values in advanced filtering. - */ - values?: any[]; -} + /** In case of value filtering, this property contains the measure name to which the filter is applied. + */ + measure?: string; + + /** Allows the user to hold the filter operand values in advanced filtering. + */ + values?: any[]; + } -export interface DataSourceColumnsFilterItems { + export interface DataSourceColumnsFilterItems { - /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ - filterType?: ej.PivotAnalysis.FilterType|string; + /** Sets the type of filter whether to include/exclude the mentioned values. + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ + filterType?: ej.PivotAnalysis.FilterType | string; - /** Contains the collection of items to be included/excluded among the field members. - * @Default {[]} - */ - values?: any[]; -} - -export interface DataSourceColumn { - - /** Allows the user to bind the item by using its unique name as field name. - */ - fieldName?: string; - - /** Allows the user to set the display caption for an item. - */ - fieldCaption?: string; - - /** Allows the user to filter the report by default using advanced filtering (excel-like) option for OLAP data source in client-mode. - * @Default {[]} - */ - advancedFilter?: DataSourceColumnsAdvancedFilter[]; - - /** Allows the user to indicate whether the added item is a named set or not. - * @Default {false} - */ - isNamedSets?: boolean; - - /** Shows/Hides the sub-total of the field in PivotGrid. - * @Default {true} - */ - showSubTotal?: boolean; - - /** Allows the user to set the sorting order of the members of the field. - * @Default {ej.PivotAnalysis.SortOrder.Ascending} - */ - sortOrder?: ej.PivotAnalysis.SortOrder|string; - - /** Contains the list of members need to be drilled down by default in the field. - * @Default {[]} - */ - drilledItems?: any[]; - - /** Applies filter to the field members. - * @Default {null} - */ - filterItems?: DataSourceColumnsFilterItems; -} - -export interface DataSourceRowsAdvancedFilter { - - /** Allows the user to provide level unique name to perform advanced filtering. - */ - name?: string; - - /** Allows the user to set the operator to perform Label Filtering. - * @Default {none} - */ - labelFilterOperator?: string; - - /** Allows the user to set the operator to perform Value Filtering. - * @Default {none} - */ - valueFilterOperator?: string; - - /** Allows the user to set the filtering type while performing advanced filtering. - */ - advancedFilterType?: string; - - /** In case of value filtering, this property contains the measure name to which the filter is applied. - */ - measure?: string; - - /** Allows the user to hold the filter operand values in advanced filtering. - */ - values?: any[]; -} - -export interface DataSourceRowsFilterItems { - - /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ - filterType?: ej.PivotAnalysis.FilterType|string; - - /** Contains the collection of items to be included/excluded among the field members. - * @Default {[]} - */ - values?: any[]; -} - -export interface DataSourceRow { - - /** Allows the user to bind the item by using its unique name as field name. - */ - fieldName?: string; - - /** Allows the user to set the display caption for an item. - */ - fieldCaption?: string; - - /** Allows the user to filter the report by default using advanced filtering (excel-like) option for OLAP data source in client-mode. - * @Default {[]} - */ - advancedFilter?: DataSourceRowsAdvancedFilter[]; - - /** Allows the user to indicate whether the added item is a named set or not. - * @Default {false} - */ - isNamedSets?: boolean; - - /** Shows/Hides the sub-total of the field. - * @Default {true} - */ - showSubTotal?: boolean; - - /** Allows the user to set the sorting order of the members of the field. - * @Default {ej.PivotAnalysis.SortOrder.Ascending} - */ - sortOrder?: ej.PivotAnalysis.SortOrder|string; - - /** Contains the list of members need to be drilled down by default in the field. - * @Default {[]} - */ - drilledItems?: any[]; - - /** Applies filter to the field members. - * @Default {null} - */ - filterItems?: DataSourceRowsFilterItems; -} - -export interface DataSourceValuesMeasure { - - /** Allows the user to bind the measure from OLAP datasource by using its unique name as field name. - */ - fieldName?: string; -} - -export interface DataSourceValue { - - /** Allows the user to bind the item by using its unique name as field name for Relational datasource. - */ - fieldName?: string; - - /** Allows the user to set the display caption for an item for Relational datasource. - */ - fieldCaption?: string; - - /** This holds the list of unique names of measures to bind them from the OLAP cube. - * @Default {[]} - */ - measures?: DataSourceValuesMeasure[]; - - /** Allows to set the axis name to place the measures items. - * @Default {rows} - */ - axis?: string; - - /** Indicates whether the field is a calculated field or not with Relational datasource. - * @Default {false} - */ - isCalculatedField?: boolean; - - /** Allows to set the type of PivotGrid summary calculation for the value field with Relational datasource. - * @Default {ej.PivotAnalysis.SummaryType.Sum} - */ - summaryType?: ej.PivotAnalysis.SummaryType|string; - - /** Allows to set the format of the values. - */ - format?: string; - - /** This property sets type of display of date. - */ - formatString?: string; - - /** Allows to set the formula for calculation of values for calculated members in Relational datasource. - */ - formula?: string; -} - -export interface DataSourceFiltersFilterItems { - - /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ - filterType?: ej.PivotAnalysis.FilterType|string; - - /** Contains the collection of items to be included/excluded among the field members. - * @Default {[]} - */ - values?: any[]; -} - -export interface DataSourceFilter { - - /** Allows the user to bind the item by using its unique name as field name. - */ - fieldName?: string; - - /** Allows the user to set the display name for an item. - */ - fieldCaption?: string; - - /** Applies filter to the field members. - * @Default {null} - */ - filterItems?: DataSourceFiltersFilterItems; -} - -export interface DataSourcePagerOptions { - - /** Allows to set the number of categorical columns to be displayed in each page on applying paging. - * @Default {0} - */ - categoricalPageSize?: number; - - /** Allows to set the number of series rows to be displayed in each page on applying paging. - * @Default {0} - */ - seriesPageSize?: number; - - /** Allows to set the page number in categorical axis to be loaded by default. - * @Default {1} - */ - categoricalCurrentPage?: number; - - /** Allows to set the page number in series axis to be loaded by default. - * @Default {1} - */ - seriesCurrentPage?: number; -} - -export interface DataSource { - - /** Lists out the items to be arranged in columns section of PivotGrid. - * @Default {[]} - */ - columns?: DataSourceColumn[]; - - /** Lists out the items to be arranged in rows section of PivotGrid. - * @Default {[]} - */ - rows?: DataSourceRow[]; - - /** Lists out the items which supports calculation in PivotGrid. - * @Default {[]} - */ - values?: DataSourceValue[]; - - /** Lists out the items which supports filtering of values without displaying the members in UI in PivotGrid. - * @Default {[]} - */ - filters?: DataSourceFilter[]; - - /** Contains the respective cube name from OLAP database as string type. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - cube?: string; - - /** Provides the raw data source for the PivotGrid. - * @Default {null} - */ - data?: any; - - /** In connection with an OLAP database, this property contains the database name as string to fetch the data from the given connection string. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - catalog?: string; - - /** Allows user to filter the members (by its name and values) through advanced filtering (excel-like) option for OLAP data source in client-mode. - * @Default {false} - */ - enableAdvancedFilter?: boolean; - - /** Sets a name to the report bound to the control. - */ - reportName?: string; - - /** Allows to set the page size and current page number for each axis on applying paging. - * @Default {{}} - */ - pagerOptions?: DataSourcePagerOptions; -} - -export interface ValueSortSettings { - - /** Contains the headers of the specific column to which value sorting is applied. - */ - headerText?: string; - - /** Allows the user to set the string for separating column headers provided in the above property headerText. - */ - headerDelimiters?: string; - - /** Allows the user to set the sorting order of the values of the field. - * @Default {ej.PivotAnalysis.SortOrder.Ascending} - */ - sortOrder?: ej.PivotAnalysis.SortOrder|string; -} - -export interface FrozenHeaderSettings { - - /** Allows the user to freeze the row headers alone on scrolling the horizontal scroll bar. - * @Default {false} - */ - enableFrozenRowHeaders?: boolean; - - /** Allows the user to freeze the column headers alone on scrolling the vertical scroll bar. - * @Default {false} - */ - enableFrozenColumnHeaders?: boolean; - - /** Allows the user to freeze both the row headers and column headers on scrolling. - * @Default {false} - */ - enableFrozenHeaders?: boolean; -} - -export interface HyperlinkSettings { - - /** Allows the user to enable/disable hyperlink for column header. - * @Default {false} - */ - enableColumnHeaderHyperlink?: boolean; - - /** Allows the user to enable/disable hyperlink for row header. - * @Default {false} - */ - enableRowHeaderHyperlink?: boolean; - - /** Allows the user to enable/disable hyperlink for summary cells. - * @Default {false} - */ - enableSummaryCellHyperlink?: boolean; - - /** Allows the user to enable/disable hyperlink for value cells. - * @Default {false} - */ - enableValueCellHyperlink?: boolean; -} - -export interface ServiceMethodSettings { - - /** Allows the user to set the custom name for the service method responsible for drill up/down operation in PivotGrid. - * @Default {DrillGrid} - */ - drillDown?: string; - - /** Allows the user to set the custom name for the service method responsible for exporting. - * @Default {Export} - */ - exportPivotGrid?: string; - - /** Allows the user to set the custom name for the service method responsible for performing server-side actions on defer update. - * @Default {DeferUpdate} - */ - deferUpdate?: string; - - /** Allows the user to set the custom name for the service method responsible for getting the values for the tree-view inside filter dialog. - * @Default {FetchMembers} - */ - fetchMembers?: string; - - /** Allows the user to set the custom name for the service method responsible for filtering operation in PivotGrid. - * @Default {Filtering} - */ - filtering?: string; - - /** Allows the user to set the custom name for the service method responsible for initializing PivotGrid. - * @Default {InitializeGrid} - */ - initialize?: string; - - /** Allows the user to set the custom name for the service method responsible for the server-side action, on dropping a node from Field List. - * @Default {NodeDropped} - */ - nodeDropped?: string; - - /** Allows the user to set the custom name for the service method responsible for the server-side action on changing the checked state of a node in Field List. - * @Default {NodeStateModified} - */ - nodeStateModified?: string; - - /** Allows the user to set the custom name for the service method responsible for performing paging operation in PivotGrid. - * @Default {Paging} - */ - paging?: string; - - /** Allows the user to set the custom name for the service method responsible for sorting operation in PivotGrid. - * @Default {Sorting} - */ - sorting?: string; - - /** Allows the user to set the custom name for the service method responsible for expanding members inside member editor. - * @Default {MemberExpanded} - */ - memberExpand?: string; - - /** Allows the user to set the custom name for the service method responsible for editing the cells. - * @Default {CellEditing} - */ - cellEditing?: string; - - /** Allows the user to set the custom name for the service method responsible for saving the current report to database. - * @Default {SaveReport} - */ - saveReport?: string; - - /** Allows the user to set the custom name for the service method responsible for loading a report from database. - * @Default {LoadReportFromDB} - */ - loadReport?: string; - - /** Allows the user to set the custom name for the service method responsible for adding a calculated field to the report. - * @Default {CalculatedField} - */ - calculatedField?: string; - - /** Allows the user to set the custom name for the service method responsible for performing drill through operation. - * @Default {DrillThroughHierarchies} - */ - drillThroughHierarchies?: string; - - /** Allows the user to set the custom name for the service method responsible for performing drill through operation in data table. - * @Default {DrillThroughDataTable} - */ - drillThroughDataTable?: string; - - /** Allows the user to set the custom name for the service method responsible for write-back operation in OLAP Cube. This is only applicable in server-side component. - * @Default {WriteBack} - */ - writeBack?: string; -} - -enum Layout { - - ///To set normal summary layout in PivotGrid. - Normal, - - ///To set layout with summaries at the top in PivotGrid. - NormalTopSummary, - - ///To set layout without summaries in PivotGrid. - NoSummaries, - - ///To set excel-like layout in PivotGrid. - ExcelLikeLayout -} - -} -namespace Pivot { -enum AnalysisMode { -//To bind an OLAP data source to PivotGrid. -OLAP, -//To bind a relational data source to PivotGrid. -Pivot, -} -} -namespace PivotAnalysis { -enum SortOrder { -//Sorts the members of the field in ascending order. -Ascending, -//Sorts the members of the field in descending order. -Descending, -//Displays the members without sorting in any order. -None, -} -} -namespace PivotAnalysis { -enum FilterType { -//Excludes the specified values among the members of the field. -Exclude, -//Includes the specified values alone among the members of the field. -Include, -} -} -namespace PivotAnalysis { -enum SummaryType { -//Calculates the summary as the total of all values. -Sum, -//Displays the average of all values as the summaries. -Average, -//Displays the count of items in summaries. -Count, -//Displays the minimum value of all the items in the summary. -Min, -//Displays the maximum value of all the items in the summary. -Max, -} -} -namespace Pivot { -enum OperationalMode { -//To bind data source completely from client-side. -ClientMode, -//To bind data source completely from server-side. -ServerMode, -} -} - -class PivotSchemaDesigner extends ej.Widget { - static fn: PivotSchemaDesigner; - constructor(element: JQuery | Element, options?: PivotSchemaDesigner.Model); - static Locale: any; - model: PivotSchemaDesigner.Model; - defaults: PivotSchemaDesigner.Model; - - /** Performs an asynchronous HTTP (AJAX) request. - * @returns {void} - */ - doAjaxPost(): void; - - /** Re-renders the control with the data source bound to the pivot control at that instant. - * @returns {void} - */ - refreshControl(): void; -} -export namespace PivotSchemaDesigner { - -export interface Model { - - /** Specifies the CSS class to PivotSchemaDesigner to achieve custom theme. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - cssClass?: string; - - /** Object utilized to pass additional information between client-end and service-end. - * @Default {{}} - */ - customObject?: any; - - /** For ASP.NET and MVC Wrapper, PivotSchemaDesigner will be initialized and rendered empty initially. Once the connected pivot control widget is rendered completely, - * PivotSchemaDesigner will just be populated with data source by setting this property to Ă¢â‚¬Å“trueĂ¢â‚¬Â. - * @Default {false} - */ - enableWrapper?: boolean; - - /** Allows the user to view PivotTable Field List from right to left. - * @Default {false} - */ - enableRTL?: boolean; - - /** Sets the visibility of OLAP elements in PivotTable Field List. This is only applicable for OLAP datasource. - * @Default {null} - */ - olap?: Olap; - - /** Allows the user to enable/disable drag and drop operations within the PivotTable Field List. - * @Default {true} - */ - enableDragDrop?: boolean; - - /** Sets the height for PivotSchemaDesigner. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - height?: string; - - /** Allows the user to set the localized language for the widget. - * @Default {en-US} - */ - locale?: string; - - /** Sets the Pivot control bound with this PivotSchemaDesigner. - * @Default {null} - */ - pivotControl?: any; - - /** Allows the user to set custom name for the methods at service-end, communicated during AJAX post. - * @Default {{}} - */ - serviceMethod?: ServiceMethod; - - /** Connects the service using the specified URL for any server updates. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - url?: string; - - /** Sets the width for PivotSchemaDesigner. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - width?: string; - - /** Sets the layout for PivotSchemaDesigner. - * @Default {ej.PivotSchemaDesigner.Layouts.Excel} - */ - layout?: ej.PivotSchemaDesigner.Layouts|string; - - /** Triggers when it reaches client-side after any AJAX request. */ - afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; - - /** Triggers before any AJAX request is passed from PivotSchemaDesigner to service methods. */ - beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; - - /** Triggers when we start dragging any field from PivotSchemaDesigner. */ - dragMove?(e: DragMoveEventArgs): void; -} - -export interface AfterServiceInvokeEventArgs { - - /** returns the current action of PivotSchemaDesigner control. - */ - action?: string; - - /** returns the custom object bound with PivotSchemaDesigner control. - */ - customObject?: any; - - /** returns the HTML element of PivotSchemaDesigner control. - */ - element?: any; -} - -export interface BeforeServiceInvokeEventArgs { - - /** returns the current action of PivotSchemaDesigner control. - */ - action?: string; - - /** returns the custom object bound with PivotSchemaDesigner control. - */ - customObject?: any; - - /** returns the HTML element of PivotSchemaDesigner control. - */ - element?: any; -} - -export interface DragMoveEventArgs { - - /** returns the HTML element of the dragged field from PivotSchemaDesigner. - */ - dragTarget?: any; - - /** return the JSON details of the dragged field. - */ - draggedElementData?: any; - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the PivotSchemaDesigner model - */ - model?: any; -} - -export interface Olap { - - /** Allows the user to view the KPI elements in tree-view inside PivotTable Field List. This is only applicable for OLAP datasource. - * @Default {false} - */ - showKPI?: boolean; - - /** Allows the user to view the named sets in tree-view inside PivotTable Field List. This is only applicable for OLAP datasource. - * @Default {false} - */ - showNamedSets?: boolean; -} - -export interface ServiceMethod { - - /** Allows the user to set the custom name for the service method responsible for getting the values for the tree-view inside filter dialog. - * @Default {FetchMembers} - */ - fetchMembers?: string; - - /** Allows the user to set the custom name for the service method responsible for filtering operation in Field List. - * @Default {Filtering} - */ - filtering?: string; - - /** Allows the user to set the custom name for the service method responsible for the server-side action, on expanding members in Field List. - * @Default {MemberExpanded} - */ - memberExpand?: string; - - /** Allows the user to set the custom name for the service method responsible for the server-side action, on dropping a node into Field List. - * @Default {NodeDropped} - */ - nodeDropped?: string; - - /** Allows the user to set the custom name for the service method responsible for the server-side action on changing the checked state of a node in Field List. - * @Default {NodeStateModified} - */ - nodeStateModified?: string; - - /** Allows the user to set the custom name for the service method responsible for button removing operation in Field List. - * @Default {RemoveButton} - */ - removeButton?: string; -} - -enum Layouts { - - ///To set the layout as same in the Excel. - Excel, - - ///To set normal layout for Field List. - Normal, - - ///To set layout with the axes one above the other. - OneByOne -} - -} - -class PivotPager extends ej.Widget { - static fn: PivotPager; - constructor(element: JQuery | Element, options?: PivotPager.Model); - static Locale: any; - model: PivotPager.Model; - defaults: PivotPager.Model; - - /** This function initializes the page counts and page numbers for the PivotPager. - * @returns {void} - */ - initPagerProperties(): void; -} -export namespace PivotPager { - -export interface Model { - - /** Contains the current page number in categorical axis. - * @Default {1} - */ - categoricalCurrentPage?: number; - - /** Contains the total page count in categorical axis. - * @Default {1} - */ - categoricalPageCount?: number; - - /** Allows the user to set the localized language for the widget. - * @Default {en-US} - */ - locale?: string; - - /** Sets the pager mode (Only Categorical Pager/Only Series Pager/Both) for the PivotPager. - * @Default {ej.PivotPager.Mode.Both} - */ - mode?: ej.PivotPager.Mode|string; - - /** Contains the current page number in series axis. - * @Default {1} - */ - seriesCurrentPage?: number; - - /** Contains the total page count in series axis. - * @Default {1} - */ - seriesPageCount?: number; - - /** Contains the ID of the target element for which paging needs to be done. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - targetControlID?: string; -} - -enum Mode { - - ///To set both categorical and series pager for paging. - Both, - - ///To set only categorical pager for paging. - Categorical, - - ///To set only series pager for paging. - Series -} - -} - -class PivotChart extends ej.Widget { - static fn: PivotChart; - constructor(element: JQuery | Element, options?: PivotChart.Model); - static Locale: any; - model: PivotChart.Model; - defaults: PivotChart.Model; - - /** Performs an asynchronous HTTP (AJAX) request. - * @returns {void} - */ - doAjaxPost(): void; - - /** Perform an asynchronous HTTP (FullPost) submit. - * @returns {void} - */ - doPostBack(): void; - - /** Exports the PivotChart to the format specified in the parameter. - * @returns {void} - */ - exportPivotChart(): void; - - /** This function renders the PivotChart control with the JSON formatted datasource. - * @returns {void} - */ - renderChartFromJSON(): void; - - /** This function receives the update from service-end, which would be utilized for rendering the widget. - * @returns {void} - */ - renderControlSuccess(): void; - - /** Returns the OlapReport string maintained along with the axis elements information. - * @returns {string} - */ - getOlapReport(): string; - - /** Sets the OlapReport string along with the axis information and maintains it in a property. - * @returns {void} - */ - setOlapReport(): void; - - /** Returns the JSON records formed to render the control. - * @returns {Array} - */ - getJSONRecords(): any[]; - - /** Sets the JSON records to render the control. - * @returns {void} - */ - setJSONRecords(): void; - - /** Returns the PivotEngine formed to render the control. - * @returns {Array} - */ - getPivotEngine(): any[]; - - /** Sets the PivotEngine required to render the control. - * @returns {void} - */ - setPivotEngine(): void; - - /** Re-renders the control with the data source at the instant. - * @returns {void} - */ - refreshControl(): void; - - /** Renders the control with the pivot engine obtained from olap cube. - * @returns {void} - */ - generateJSON(): void; - - /** Navigates to the specified page number in specified axis. - * @returns {void} - */ - refreshPagedPivotChart(): void; -} -export namespace PivotChart { - -export interface Model { - - /** Sets the mode for the PivotChart widget for binding either OLAP or Relational data source. - * @Default {ej.Pivot.AnalysisMode.Pivot} - */ - analysisMode?: ej.Pivot.AnalysisMode|string; - - /** Specifies the CSS class to PivotChart to achieve custom theme. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - cssClass?: string; - - /** Options for enabling zooming feature of PivotChart. - * @Default {{}} - */ - zooming?: Zooming; - - /** Options available to configure the properties of entire series. You can also override the options for specific series by using series collection. - * @Default {{}} - */ - commonSeriesOptions?: CommonSeriesOptions; - - /** Initializes the data source for the PivotChart widget, when it functions completely on client-side. - * @Default {{}} - */ - dataSource?: DataSource; - - /** Object utilized to pass additional information between client-end and service-end on operating the control in server mode. - * @Default {{}} - */ - customObject?: any; - - /** Allows the user to enable 3D view of PivotChart. - * @Default {false} - */ - enable3D?: boolean; - - /** Allows the user to view PivotChart from right to left. - * @Default {false} - */ - enableRTL?: boolean; - - /** Allows the user to enable PivotChartĂ¢â‚¬â„¢s responsiveness in the browser layout. - * @Default {false} - */ - isResponsive?: boolean; - - /** Lets the user to customize the legend items and their labels. - * @Default {{}} - */ - legend?: any; - - /** Allows the user to set the localized language for the widget. - * @Default {en-US} - */ - locale?: string; - - /** Sets the mode for the PivotChart widget for binding data source either in server-side or client-side. - * @Default {ej.Pivot.OperationalMode.ClientMode} - */ - operationalMode?: ej.Pivot.OperationalMode|string; - - /** This is a horizontal axis that contains options to configure axis and it is the primary x axis for all the series in series array. - * To override x axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. - * Then, assign the name to the seriesĂ¢â‚¬â„¢s xAxisName property to link both axis and series. - * @Default {{}} - */ - primaryXAxis?: any; - - /** This is a vertical axis that contains options to configure axis. This is the primary y axis for all the series in series array. - * To override y axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. - * Then, assign the name to the seriesĂ¢â‚¬â„¢s yAxisName property to link both axis and series. - * @Default {{}} - */ - primaryYAxis?: any; - - /** Allows the user to rotate the angle of PivotChart in 3D view. - * @Default {0} - */ - rotation?: number; - - /** Allows the user to set custom name for the methods at service-end, communicated on AJAX post. - * @Default {{}} - */ - serviceMethodSettings?: ServiceMethodSettings; - - /** Options to customize the size of the PivotChart control. - * @Default {{}} - */ - size?: any; - - /** Connects the service using the specified URL for any server updates on operating the control in server mode. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - url?: string; - - /** Triggers when PivotChart starts to render. */ - load?(e: LoadEventArgs): void; - - /** Triggers when it reaches client-side after any AJAX request. */ - afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; - - /** Triggers before any AJAX request is passed from PivotChart to service methods. */ - beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; - - /** Triggers on performing drill up/down in PivotChart control. */ - drillSuccess?(e: DrillSuccessEventArgs): void; - - /** Triggers when PivotChart widget completes all operations at client-side after any AJAX request. */ - renderComplete?(e: RenderCompleteEventArgs): void; - - /** Triggers when any error occurred during AJAX request. */ - renderFailure?(e: RenderFailureEventArgs): void; - - /** Triggers when PivotChart successfully reaches client-side after any AJAX request. */ - renderSuccess?(e: RenderSuccessEventArgs): void; - - /** Triggers before performing exporting in pivot chart. */ - beforeExport?(e: BeforeExportEventArgs): void; -} + /** Contains the collection of items to be included/excluded among the field members. + * @Default {[]} + */ + values?: any[]; + } + + export interface DataSourceColumn { + + /** Allows the user to bind the item by using its unique name as field name. + */ + fieldName?: string; + + /** Allows the user to set the display caption for an item. + */ + fieldCaption?: string; + + /** Allows the user to filter the report by default using advanced filtering (excel-like) option for OLAP data source in client-mode. + * @Default {[]} + */ + advancedFilter?: DataSourceColumnsAdvancedFilter[]; + + /** Allows the user to indicate whether the added item is a named set or not. + * @Default {false} + */ + isNamedSets?: boolean; + + /** Shows/Hides the sub-total of the field in PivotGrid. + * @Default {true} + */ + showSubTotal?: boolean; + + /** Allows the user to set the sorting order of the members of the field. + * @Default {ej.PivotAnalysis.SortOrder.Ascending} + */ + sortOrder?: ej.PivotAnalysis.SortOrder | string; + + /** Contains the list of members need to be drilled down by default in the field. + * @Default {[]} + */ + drilledItems?: any[]; + + /** Applies filter to the field members. + * @Default {null} + */ + filterItems?: DataSourceColumnsFilterItems; + } + + export interface DataSourceRowsAdvancedFilter { + + /** Allows the user to provide level unique name to perform advanced filtering. + */ + name?: string; + + /** Allows the user to set the operator to perform Label Filtering. + * @Default {none} + */ + labelFilterOperator?: string; + + /** Allows the user to set the operator to perform Value Filtering. + * @Default {none} + */ + valueFilterOperator?: string; + + /** Allows the user to set the filtering type while performing advanced filtering. + */ + advancedFilterType?: string; + + /** In case of value filtering, this property contains the measure name to which the filter is applied. + */ + measure?: string; + + /** Allows the user to hold the filter operand values in advanced filtering. + */ + values?: any[]; + } + + export interface DataSourceRowsFilterItems { + + /** Sets the type of filter whether to include/exclude the mentioned values. + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ + filterType?: ej.PivotAnalysis.FilterType | string; + + /** Contains the collection of items to be included/excluded among the field members. + * @Default {[]} + */ + values?: any[]; + } + + export interface DataSourceRow { + + /** Allows the user to bind the item by using its unique name as field name. + */ + fieldName?: string; + + /** Allows the user to set the display caption for an item. + */ + fieldCaption?: string; + + /** Allows the user to filter the report by default using advanced filtering (excel-like) option for OLAP data source in client-mode. + * @Default {[]} + */ + advancedFilter?: DataSourceRowsAdvancedFilter[]; + + /** Allows the user to indicate whether the added item is a named set or not. + * @Default {false} + */ + isNamedSets?: boolean; + + /** Shows/Hides the sub-total of the field. + * @Default {true} + */ + showSubTotal?: boolean; + + /** Allows the user to set the sorting order of the members of the field. + * @Default {ej.PivotAnalysis.SortOrder.Ascending} + */ + sortOrder?: ej.PivotAnalysis.SortOrder | string; + + /** Contains the list of members need to be drilled down by default in the field. + * @Default {[]} + */ + drilledItems?: any[]; + + /** Applies filter to the field members. + * @Default {null} + */ + filterItems?: DataSourceRowsFilterItems; + } + + export interface DataSourceValuesMeasure { + + /** Allows the user to bind the measure from OLAP datasource by using its unique name as field name. + */ + fieldName?: string; + } + + export interface DataSourceValue { + + /** Allows the user to bind the item by using its unique name as field name for Relational datasource. + */ + fieldName?: string; + + /** Allows the user to set the display caption for an item for Relational datasource. + */ + fieldCaption?: string; + + /** This holds the list of unique names of measures to bind them from the OLAP cube. + * @Default {[]} + */ + measures?: DataSourceValuesMeasure[]; + + /** Allows to set the axis name to place the measures items. + * @Default {rows} + */ + axis?: string; + + /** Indicates whether the field is a calculated field or not with Relational datasource. + * @Default {false} + */ + isCalculatedField?: boolean; + + /** Allows to set the type of PivotGrid summary calculation for the value field with Relational datasource. + * @Default {ej.PivotAnalysis.SummaryType.Sum} + */ + summaryType?: ej.PivotAnalysis.SummaryType | string; + + /** Allows to set the format of the values. + */ + format?: string; + + /** This property sets type of display of date. + */ + formatString?: string; + + /** Allows to set the formula for calculation of values for calculated members in Relational datasource. + */ + formula?: string; + } + + export interface DataSourceFiltersFilterItems { + + /** Sets the type of filter whether to include/exclude the mentioned values. + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ + filterType?: ej.PivotAnalysis.FilterType | string; + + /** Contains the collection of items to be included/excluded among the field members. + * @Default {[]} + */ + values?: any[]; + } + + export interface DataSourceFilter { + + /** Allows the user to bind the item by using its unique name as field name. + */ + fieldName?: string; + + /** Allows the user to set the display name for an item. + */ + fieldCaption?: string; + + /** Applies filter to the field members. + * @Default {null} + */ + filterItems?: DataSourceFiltersFilterItems; + } + + export interface DataSourcePagerOptions { + + /** Allows to set the number of categorical columns to be displayed in each page on applying paging. + * @Default {0} + */ + categoricalPageSize?: number; + + /** Allows to set the number of series rows to be displayed in each page on applying paging. + * @Default {0} + */ + seriesPageSize?: number; + + /** Allows to set the page number in categorical axis to be loaded by default. + * @Default {1} + */ + categoricalCurrentPage?: number; + + /** Allows to set the page number in series axis to be loaded by default. + * @Default {1} + */ + seriesCurrentPage?: number; + } + + export interface DataSource { + + /** Lists out the items to be arranged in columns section of PivotGrid. + * @Default {[]} + */ + columns?: DataSourceColumn[]; + + /** Lists out the items to be arranged in rows section of PivotGrid. + * @Default {[]} + */ + rows?: DataSourceRow[]; + + /** Lists out the items which supports calculation in PivotGrid. + * @Default {[]} + */ + values?: DataSourceValue[]; + + /** Lists out the items which supports filtering of values without displaying the members in UI in PivotGrid. + * @Default {[]} + */ + filters?: DataSourceFilter[]; + + /** Contains the respective cube name from OLAP database as string type. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + cube?: string; + + /** Provides the raw data source for the PivotGrid. + * @Default {null} + */ + data?: any; + + /** In connection with an OLAP database, this property contains the database name as string to fetch the data from the given connection string. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + catalog?: string; + + /** Allows user to filter the members (by its name and values) through advanced filtering (excel-like) option for OLAP data source in client-mode. + * @Default {false} + */ + enableAdvancedFilter?: boolean; + + /** Sets a name to the report bound to the control. + */ + reportName?: string; + + /** Allows to set the page size and current page number for each axis on applying paging. + * @Default {{}} + */ + pagerOptions?: DataSourcePagerOptions; + } + + export interface ValueSortSettings { + + /** Contains the headers of the specific column to which value sorting is applied. + */ + headerText?: string; + + /** Allows the user to set the string for separating column headers provided in the above property headerText. + */ + headerDelimiters?: string; + + /** Allows the user to set the sorting order of the values of the field. + * @Default {ej.PivotAnalysis.SortOrder.Ascending} + */ + sortOrder?: ej.PivotAnalysis.SortOrder | string; + } + + export interface FrozenHeaderSettings { + + /** Allows the user to freeze the row headers alone on scrolling the horizontal scroll bar. + * @Default {false} + */ + enableFrozenRowHeaders?: boolean; + + /** Allows the user to freeze the column headers alone on scrolling the vertical scroll bar. + * @Default {false} + */ + enableFrozenColumnHeaders?: boolean; + + /** Allows the user to freeze both the row headers and column headers on scrolling. + * @Default {false} + */ + enableFrozenHeaders?: boolean; + } + + export interface HyperlinkSettings { + + /** Allows the user to enable/disable hyperlink for column header. + * @Default {false} + */ + enableColumnHeaderHyperlink?: boolean; + + /** Allows the user to enable/disable hyperlink for row header. + * @Default {false} + */ + enableRowHeaderHyperlink?: boolean; + + /** Allows the user to enable/disable hyperlink for summary cells. + * @Default {false} + */ + enableSummaryCellHyperlink?: boolean; + + /** Allows the user to enable/disable hyperlink for value cells. + * @Default {false} + */ + enableValueCellHyperlink?: boolean; + } + + export interface ServiceMethodSettings { + + /** Allows the user to set the custom name for the service method responsible for drill up/down operation in PivotGrid. + * @Default {DrillGrid} + */ + drillDown?: string; + + /** Allows the user to set the custom name for the service method responsible for exporting. + * @Default {Export} + */ + exportPivotGrid?: string; + + /** Allows the user to set the custom name for the service method responsible for performing server-side actions on defer update. + * @Default {DeferUpdate} + */ + deferUpdate?: string; + + /** Allows the user to set the custom name for the service method responsible for getting the values for the tree-view inside filter dialog. + * @Default {FetchMembers} + */ + fetchMembers?: string; + + /** Allows the user to set the custom name for the service method responsible for filtering operation in PivotGrid. + * @Default {Filtering} + */ + filtering?: string; + + /** Allows the user to set the custom name for the service method responsible for initializing PivotGrid. + * @Default {InitializeGrid} + */ + initialize?: string; + + /** Allows the user to set the custom name for the service method responsible for the server-side action, on dropping a node from Field List. + * @Default {NodeDropped} + */ + nodeDropped?: string; + + /** Allows the user to set the custom name for the service method responsible for the server-side action on changing the checked state of a node in Field List. + * @Default {NodeStateModified} + */ + nodeStateModified?: string; + + /** Allows the user to set the custom name for the service method responsible for performing paging operation in PivotGrid. + * @Default {Paging} + */ + paging?: string; + + /** Allows the user to set the custom name for the service method responsible for sorting operation in PivotGrid. + * @Default {Sorting} + */ + sorting?: string; + + /** Allows the user to set the custom name for the service method responsible for expanding members inside member editor. + * @Default {MemberExpanded} + */ + memberExpand?: string; + + /** Allows the user to set the custom name for the service method responsible for editing the cells. + * @Default {CellEditing} + */ + cellEditing?: string; + + /** Allows the user to set the custom name for the service method responsible for saving the current report to database. + * @Default {SaveReport} + */ + saveReport?: string; + + /** Allows the user to set the custom name for the service method responsible for loading a report from database. + * @Default {LoadReportFromDB} + */ + loadReport?: string; + + /** Allows the user to set the custom name for the service method responsible for adding a calculated field to the report. + * @Default {CalculatedField} + */ + calculatedField?: string; + + /** Allows the user to set the custom name for the service method responsible for performing drill through operation. + * @Default {DrillThroughHierarchies} + */ + drillThroughHierarchies?: string; + + /** Allows the user to set the custom name for the service method responsible for performing drill through operation in data table. + * @Default {DrillThroughDataTable} + */ + drillThroughDataTable?: string; + + /** Allows the user to set the custom name for the service method responsible for write-back operation in OLAP Cube. This is only applicable in server-side component. + * @Default {WriteBack} + */ + writeBack?: string; + } + + enum Layout { + + ///To set normal summary layout in PivotGrid. + Normal, + + ///To set layout with summaries at the top in PivotGrid. + NormalTopSummary, + + ///To set layout without summaries in PivotGrid. + NoSummaries, + + ///To set excel-like layout in PivotGrid. + ExcelLikeLayout + } + + } + namespace Pivot { + enum AnalysisMode { + //To bind an OLAP data source to PivotGrid. + OLAP, + //To bind a relational data source to PivotGrid. + Pivot, + } + } + namespace PivotAnalysis { + enum SortOrder { + //Sorts the members of the field in ascending order. + Ascending, + //Sorts the members of the field in descending order. + Descending, + //Displays the members without sorting in any order. + None, + } + } + namespace PivotAnalysis { + enum FilterType { + //Excludes the specified values among the members of the field. + Exclude, + //Includes the specified values alone among the members of the field. + Include, + } + } + namespace PivotAnalysis { + enum SummaryType { + //Calculates the summary as the total of all values. + Sum, + //Displays the average of all values as the summaries. + Average, + //Displays the count of items in summaries. + Count, + //Displays the minimum value of all the items in the summary. + Min, + //Displays the maximum value of all the items in the summary. + Max, + } + } + namespace Pivot { + enum OperationalMode { + //To bind data source completely from client-side. + ClientMode, + //To bind data source completely from server-side. + ServerMode, + } + } + + class PivotSchemaDesigner extends ej.Widget { + static fn: PivotSchemaDesigner; + constructor(element: JQuery | Element, options?: PivotSchemaDesigner.Model); + static Locale: any; + model: PivotSchemaDesigner.Model; + defaults: PivotSchemaDesigner.Model; + + /** Performs an asynchronous HTTP (AJAX) request. + * @returns {void} + */ + doAjaxPost(): void; + + /** Re-renders the control with the data source bound to the pivot control at that instant. + * @returns {void} + */ + refreshControl(): void; + } + export namespace PivotSchemaDesigner { + + export interface Model { + + /** Specifies the CSS class to PivotSchemaDesigner to achieve custom theme. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + cssClass?: string; + + /** Object utilized to pass additional information between client-end and service-end. + * @Default {{}} + */ + customObject?: any; + + /** For ASP.NET and MVC Wrapper, PivotSchemaDesigner will be initialized and rendered empty initially. Once the connected pivot control widget is rendered completely, + * PivotSchemaDesigner will just be populated with data source by setting this property to Ă¢â‚¬Å“trueĂ¢â‚¬Â. + * @Default {false} + */ + enableWrapper?: boolean; + + /** Allows the user to view PivotTable Field List from right to left. + * @Default {false} + */ + enableRTL?: boolean; + + /** Sets the visibility of OLAP elements in PivotTable Field List. This is only applicable for OLAP datasource. + * @Default {null} + */ + olap?: Olap; + + /** Allows the user to enable/disable drag and drop operations within the PivotTable Field List. + * @Default {true} + */ + enableDragDrop?: boolean; + + /** Sets the height for PivotSchemaDesigner. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + height?: string; + + /** Allows the user to set the localized language for the widget. + * @Default {en-US} + */ + locale?: string; + + /** Sets the Pivot control bound with this PivotSchemaDesigner. + * @Default {null} + */ + pivotControl?: any; + + /** Allows the user to set custom name for the methods at service-end, communicated during AJAX post. + * @Default {{}} + */ + serviceMethod?: ServiceMethod; + + /** Connects the service using the specified URL for any server updates. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + url?: string; + + /** Sets the width for PivotSchemaDesigner. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + width?: string; + + /** Sets the layout for PivotSchemaDesigner. + * @Default {ej.PivotSchemaDesigner.Layouts.Excel} + */ + layout?: ej.PivotSchemaDesigner.Layouts | string; + + /** Triggers when it reaches client-side after any AJAX request. */ + afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; + + /** Triggers before any AJAX request is passed from PivotSchemaDesigner to service methods. */ + beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; + + /** Triggers when we start dragging any field from PivotSchemaDesigner. */ + dragMove?(e: DragMoveEventArgs): void; + } + + export interface AfterServiceInvokeEventArgs { + + /** returns the current action of PivotSchemaDesigner control. + */ + action?: string; + + /** returns the custom object bound with PivotSchemaDesigner control. + */ + customObject?: any; + + /** returns the HTML element of PivotSchemaDesigner control. + */ + element?: any; + } + + export interface BeforeServiceInvokeEventArgs { + + /** returns the current action of PivotSchemaDesigner control. + */ + action?: string; + + /** returns the custom object bound with PivotSchemaDesigner control. + */ + customObject?: any; + + /** returns the HTML element of PivotSchemaDesigner control. + */ + element?: any; + } + + export interface DragMoveEventArgs { + + /** returns the HTML element of the dragged field from PivotSchemaDesigner. + */ + dragTarget?: any; + + /** return the JSON details of the dragged field. + */ + draggedElementData?: any; + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the PivotSchemaDesigner model + */ + model?: any; + } + + export interface Olap { + + /** Allows the user to view the KPI elements in tree-view inside PivotTable Field List. This is only applicable for OLAP datasource. + * @Default {false} + */ + showKPI?: boolean; + + /** Allows the user to view the named sets in tree-view inside PivotTable Field List. This is only applicable for OLAP datasource. + * @Default {false} + */ + showNamedSets?: boolean; + } + + export interface ServiceMethod { + + /** Allows the user to set the custom name for the service method responsible for getting the values for the tree-view inside filter dialog. + * @Default {FetchMembers} + */ + fetchMembers?: string; + + /** Allows the user to set the custom name for the service method responsible for filtering operation in Field List. + * @Default {Filtering} + */ + filtering?: string; + + /** Allows the user to set the custom name for the service method responsible for the server-side action, on expanding members in Field List. + * @Default {MemberExpanded} + */ + memberExpand?: string; + + /** Allows the user to set the custom name for the service method responsible for the server-side action, on dropping a node into Field List. + * @Default {NodeDropped} + */ + nodeDropped?: string; + + /** Allows the user to set the custom name for the service method responsible for the server-side action on changing the checked state of a node in Field List. + * @Default {NodeStateModified} + */ + nodeStateModified?: string; + + /** Allows the user to set the custom name for the service method responsible for button removing operation in Field List. + * @Default {RemoveButton} + */ + removeButton?: string; + } + + enum Layouts { + + ///To set the layout as same in the Excel. + Excel, + + ///To set normal layout for Field List. + Normal, + + ///To set layout with the axes one above the other. + OneByOne + } + + } + + class PivotPager extends ej.Widget { + static fn: PivotPager; + constructor(element: JQuery | Element, options?: PivotPager.Model); + static Locale: any; + model: PivotPager.Model; + defaults: PivotPager.Model; + + /** This function initializes the page counts and page numbers for the PivotPager. + * @returns {void} + */ + initPagerProperties(): void; + } + export namespace PivotPager { + + export interface Model { + + /** Contains the current page number in categorical axis. + * @Default {1} + */ + categoricalCurrentPage?: number; + + /** Contains the total page count in categorical axis. + * @Default {1} + */ + categoricalPageCount?: number; + + /** Allows the user to set the localized language for the widget. + * @Default {en-US} + */ + locale?: string; + + /** Sets the pager mode (Only Categorical Pager/Only Series Pager/Both) for the PivotPager. + * @Default {ej.PivotPager.Mode.Both} + */ + mode?: ej.PivotPager.Mode | string; + + /** Contains the current page number in series axis. + * @Default {1} + */ + seriesCurrentPage?: number; + + /** Contains the total page count in series axis. + * @Default {1} + */ + seriesPageCount?: number; + + /** Contains the ID of the target element for which paging needs to be done. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + targetControlID?: string; + } + + enum Mode { + + ///To set both categorical and series pager for paging. + Both, + + ///To set only categorical pager for paging. + Categorical, + + ///To set only series pager for paging. + Series + } + + } + + class PivotChart extends ej.Widget { + static fn: PivotChart; + constructor(element: JQuery | Element, options?: PivotChart.Model); + static Locale: any; + model: PivotChart.Model; + defaults: PivotChart.Model; + + /** Performs an asynchronous HTTP (AJAX) request. + * @returns {void} + */ + doAjaxPost(): void; + + /** Perform an asynchronous HTTP (FullPost) submit. + * @returns {void} + */ + doPostBack(): void; + + /** Exports the PivotChart to the format specified in the parameter. + * @returns {void} + */ + exportPivotChart(): void; + + /** This function renders the PivotChart control with the JSON formatted datasource. + * @returns {void} + */ + renderChartFromJSON(): void; + + /** This function receives the update from service-end, which would be utilized for rendering the widget. + * @returns {void} + */ + renderControlSuccess(): void; + + /** Returns the OlapReport string maintained along with the axis elements information. + * @returns {string} + */ + getOlapReport(): string; + + /** Sets the OlapReport string along with the axis information and maintains it in a property. + * @returns {void} + */ + setOlapReport(): void; + + /** Returns the JSON records formed to render the control. + * @returns {Array} + */ + getJSONRecords(): any[]; + + /** Sets the JSON records to render the control. + * @returns {void} + */ + setJSONRecords(): void; + + /** Returns the PivotEngine formed to render the control. + * @returns {Array} + */ + getPivotEngine(): any[]; + + /** Sets the PivotEngine required to render the control. + * @returns {void} + */ + setPivotEngine(): void; + + /** Re-renders the control with the data source at the instant. + * @returns {void} + */ + refreshControl(): void; + + /** Renders the control with the pivot engine obtained from olap cube. + * @returns {void} + */ + generateJSON(): void; + + /** Navigates to the specified page number in specified axis. + * @returns {void} + */ + refreshPagedPivotChart(): void; + } + export namespace PivotChart { + + export interface Model { + + /** Sets the mode for the PivotChart widget for binding either OLAP or Relational data source. + * @Default {ej.Pivot.AnalysisMode.Pivot} + */ + analysisMode?: ej.Pivot.AnalysisMode | string; + + /** Specifies the CSS class to PivotChart to achieve custom theme. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + cssClass?: string; + + /** Options for enabling zooming feature of PivotChart. + * @Default {{}} + */ + zooming?: Zooming; + + /** Options available to configure the properties of entire series. You can also override the options for specific series by using series collection. + * @Default {{}} + */ + commonSeriesOptions?: CommonSeriesOptions; + + /** Initializes the data source for the PivotChart widget, when it functions completely on client-side. + * @Default {{}} + */ + dataSource?: DataSource; + + /** Object utilized to pass additional information between client-end and service-end on operating the control in server mode. + * @Default {{}} + */ + customObject?: any; + + /** Allows the user to enable 3D view of PivotChart. + * @Default {false} + */ + enable3D?: boolean; + + /** Allows the user to view PivotChart from right to left. + * @Default {false} + */ + enableRTL?: boolean; + + /** Allows the user to enable PivotChartĂ¢â‚¬â„¢s responsiveness in the browser layout. + * @Default {false} + */ + isResponsive?: boolean; + + /** Lets the user to customize the legend items and their labels. + * @Default {{}} + */ + legend?: any; + + /** Allows the user to set the localized language for the widget. + * @Default {en-US} + */ + locale?: string; + + /** Sets the mode for the PivotChart widget for binding data source either in server-side or client-side. + * @Default {ej.Pivot.OperationalMode.ClientMode} + */ + operationalMode?: ej.Pivot.OperationalMode | string; + + /** This is a horizontal axis that contains options to configure axis and it is the primary x axis for all the series in series array. + * To override x axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. + * Then, assign the name to the seriesĂ¢â‚¬â„¢s xAxisName property to link both axis and series. + * @Default {{}} + */ + primaryXAxis?: any; + + /** This is a vertical axis that contains options to configure axis. This is the primary y axis for all the series in series array. + * To override y axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. + * Then, assign the name to the seriesĂ¢â‚¬â„¢s yAxisName property to link both axis and series. + * @Default {{}} + */ + primaryYAxis?: any; + + /** Allows the user to rotate the angle of PivotChart in 3D view. + * @Default {0} + */ + rotation?: number; + + /** Allows the user to set custom name for the methods at service-end, communicated on AJAX post. + * @Default {{}} + */ + serviceMethodSettings?: ServiceMethodSettings; + + /** Options to customize the size of the PivotChart control. + * @Default {{}} + */ + size?: any; + + /** Connects the service using the specified URL for any server updates on operating the control in server mode. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + url?: string; + + /** Triggers when PivotChart starts to render. */ + load?(e: LoadEventArgs): void; + + /** Triggers when it reaches client-side after any AJAX request. */ + afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; + + /** Triggers before any AJAX request is passed from PivotChart to service methods. */ + beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; + + /** Triggers on performing drill up/down in PivotChart control. */ + drillSuccess?(e: DrillSuccessEventArgs): void; + + /** Triggers when PivotChart widget completes all operations at client-side after any AJAX request. */ + renderComplete?(e: RenderCompleteEventArgs): void; + + /** Triggers when any error occurred during AJAX request. */ + renderFailure?(e: RenderFailureEventArgs): void; + + /** Triggers when PivotChart successfully reaches client-side after any AJAX request. */ + renderSuccess?(e: RenderSuccessEventArgs): void; + + /** Triggers before performing exporting in pivot chart. */ + beforeExport?(e: BeforeExportEventArgs): void; + } -export interface LoadEventArgs { - - /** returns the current action of PivotChart control. - */ - action?: string; + export interface LoadEventArgs { + + /** returns the current action of PivotChart control. + */ + action?: string; - /** returns the custom object bound with PivotChart control. - */ - customObject?: any; + /** returns the custom object bound with PivotChart control. + */ + customObject?: any; - /** returns the HTML element of PivotChart control. - */ - element?: any; -} + /** returns the HTML element of PivotChart control. + */ + element?: any; + } -export interface AfterServiceInvokeEventArgs { + export interface AfterServiceInvokeEventArgs { - /** returns the current action of PivotChart control. - */ - action?: string; + /** returns the current action of PivotChart control. + */ + action?: string; - /** returns the custom object bound with PivotChart control. - */ - customObject?: any; + /** returns the custom object bound with PivotChart control. + */ + customObject?: any; - /** returns the HTML element of PivotChart control. - */ - element?: any; -} + /** returns the HTML element of PivotChart control. + */ + element?: any; + } -export interface BeforeServiceInvokeEventArgs { + export interface BeforeServiceInvokeEventArgs { - /** returns the current action of PivotChart control. - */ - action?: string; + /** returns the current action of PivotChart control. + */ + action?: string; - /** returns the custom object bound with PivotChart control. - */ - customObject?: any; + /** returns the custom object bound with PivotChart control. + */ + customObject?: any; - /** returns the HTML element of PivotChart control. - */ - element?: any; -} + /** returns the HTML element of PivotChart control. + */ + element?: any; + } -export interface DrillSuccessEventArgs { + export interface DrillSuccessEventArgs { - /** returns the current instance of PivotChart. - */ - chartObj?: any; + /** returns the current instance of PivotChart. + */ + chartObj?: any; - /** returns the drill action of PivotChart. - */ - drillAction?: string; + /** returns the drill action of PivotChart. + */ + drillAction?: string; - /** contains the name of the member drilled. - */ - drilledMember?: string; + /** contains the name of the member drilled. + */ + drilledMember?: string; - /** returns the event object. - */ - event?: any; -} + /** returns the event object. + */ + event?: any; + } -export interface RenderCompleteEventArgs { + export interface RenderCompleteEventArgs { - /** returns the current action of PivotChart control. - */ - action?: string; + /** returns the current action of PivotChart control. + */ + action?: string; - /** returns the custom object bound with PivotChart control. - */ - customObject?: any; + /** returns the custom object bound with PivotChart control. + */ + customObject?: any; - /** returns the HTML element of PivotChart control. - */ - element?: any; -} + /** returns the HTML element of PivotChart control. + */ + element?: any; + } -export interface RenderFailureEventArgs { + export interface RenderFailureEventArgs { - /** returns the current action of PivotChart control. - */ - action?: string; + /** returns the current action of PivotChart control. + */ + action?: string; - /** returns the custom object bound with PivotChart control. - */ - customObject?: any; + /** returns the custom object bound with PivotChart control. + */ + customObject?: any; - /** returns the HTML element of PivotChart control. - */ - element?: any; + /** returns the HTML element of PivotChart control. + */ + element?: any; - /** returns the error stack trace of the original exception. - */ - message?: string; -} + /** returns the error stack trace of the original exception. + */ + message?: string; + } -export interface RenderSuccessEventArgs { + export interface RenderSuccessEventArgs { - /** returns the current instance of PivotChart. - */ - args?: any; -} + /** returns the current instance of PivotChart. + */ + args?: any; + } -export interface BeforeExportEventArgs { + export interface BeforeExportEventArgs { - /** contains the url of the service responsible for exporting. - */ - url?: string; + /** contains the url of the service responsible for exporting. + */ + url?: string; - /** contains the name of the exporting file. - */ - fileName?: string; -} + /** contains the name of the exporting file. + */ + fileName?: string; + } -export interface Zooming { + export interface Zooming { - /** Enables or disables horizontal scrollbar. - * @Default {false} - */ - enableScrollbar?: boolean; -} + /** Enables or disables horizontal scrollbar. + * @Default {false} + */ + enableScrollbar?: boolean; + } -export interface CommonSeriesOptions { + export interface CommonSeriesOptions { - /** Allows the user to set the specific chart type for PivotChart widget. - * @Default {ej.PivotChart.ChartTypes.Column} - */ - type?: ej.PivotChart.ChartTypes|string; -} + /** Allows the user to set the specific chart type for PivotChart widget. + * @Default {ej.PivotChart.ChartTypes.Column} + */ + type?: ej.PivotChart.ChartTypes | string; + } -export interface DataSourceColumnsFilterItems { + export interface DataSourceColumnsFilterItems { - /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ - filterType?: ej.PivotAnalysis.FilterType|string; + /** Sets the type of filter whether to include/exclude the mentioned values. + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ + filterType?: ej.PivotAnalysis.FilterType | string; - /** Contains the collection of items to be included/excluded among the field members. - * @Default {[]} - */ - values?: any[]; -} + /** Contains the collection of items to be included/excluded among the field members. + * @Default {[]} + */ + values?: any[]; + } -export interface DataSourceColumn { + export interface DataSourceColumn { - /** Allows the user to bind the item by using its unique name as field name. - */ - fieldName?: string; + /** Allows the user to bind the item by using its unique name as field name. + */ + fieldName?: string; - /** Allows the user to set the display caption for an item. - */ - fieldCaption?: string; + /** Allows the user to set the display caption for an item. + */ + fieldCaption?: string; - /** Allows the user to indicate whether the added item is a named set or not. - * @Default {false} - */ - isNamedSets?: boolean; - - /** Allows the user to set the sorting order of the members of the field. - * @Default {ej.PivotAnalysis.SortOrder.Ascending} - */ - sortOrder?: ej.PivotAnalysis.SortOrder|string; - - /** Applies filter to the field members. - * @Default {null} - */ - filterItems?: DataSourceColumnsFilterItems; -} - -export interface DataSourceRowsFilterItems { - - /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ - filterType?: ej.PivotAnalysis.FilterType|string; - - /** Contains the collection of items to be included/excluded among the field members. - * @Default {[]} - */ - values?: any[]; -} - -export interface DataSourceRow { - - /** Allows the user to bind the item by using its unique name as field name. - */ - fieldName?: string; - - /** Allows the user to set the display caption for an item. - */ - fieldCaption?: string; - - /** Allows the user to indicate whether the added item is a named set or not. - * @Default {false} - */ - isNamedSets?: boolean; - - /** Allows the user to set the sorting order of the members of the field. - * @Default {ej.PivotAnalysis.SortOrder.Ascending} - */ - sortOrder?: ej.PivotAnalysis.SortOrder|string; - - /** Applies filter to the field members. - * @Default {null} - */ - filterItems?: DataSourceRowsFilterItems; -} - -export interface DataSourceValuesMeasure { - - /** Allows the user to bind the measure from OLAP datasource by using its unique name as field name. - */ - fieldName?: string; -} - -export interface DataSourceValue { - - /** Allows the user to bind the item by using its unique name as field name for Relational datasource. - */ - fieldName?: string; - - /** Allows the user to set the display caption for an item for Relational datasource. - */ - fieldCaption?: string; - - /** This holds the list of unique names of measures to bind them from the OLAP cube. - * @Default {[]} - */ - measures?: DataSourceValuesMeasure[]; - - /** Allows to set the axis name to place the measures items. - * @Default {rows} - */ - axis?: string; - - /** Indicates whether the field is a calculated field or not with Relational datasource. - * @Default {false} - */ - isCalculatedField?: boolean; - - /** Allows to set the formula for calculation of values for calculated members in Relational datasource. - */ - formula?: string; -} - -export interface DataSourceFiltersFilterItems { - - /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ - filterType?: ej.PivotAnalysis.FilterType|string; - - /** Contains the collection of items to be included/excluded among the field members. - * @Default {[]} - */ - values?: any[]; -} - -export interface DataSourceFilter { - - /** Allows the user to bind the item by using its unique name as field name. - */ - fieldName?: string; - - /** Applies filter to the field members. - * @Default {null} - */ - filterItems?: DataSourceFiltersFilterItems; -} + /** Allows the user to indicate whether the added item is a named set or not. + * @Default {false} + */ + isNamedSets?: boolean; + + /** Allows the user to set the sorting order of the members of the field. + * @Default {ej.PivotAnalysis.SortOrder.Ascending} + */ + sortOrder?: ej.PivotAnalysis.SortOrder | string; + + /** Applies filter to the field members. + * @Default {null} + */ + filterItems?: DataSourceColumnsFilterItems; + } + + export interface DataSourceRowsFilterItems { + + /** Sets the type of filter whether to include/exclude the mentioned values. + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ + filterType?: ej.PivotAnalysis.FilterType | string; + + /** Contains the collection of items to be included/excluded among the field members. + * @Default {[]} + */ + values?: any[]; + } + + export interface DataSourceRow { + + /** Allows the user to bind the item by using its unique name as field name. + */ + fieldName?: string; + + /** Allows the user to set the display caption for an item. + */ + fieldCaption?: string; + + /** Allows the user to indicate whether the added item is a named set or not. + * @Default {false} + */ + isNamedSets?: boolean; + + /** Allows the user to set the sorting order of the members of the field. + * @Default {ej.PivotAnalysis.SortOrder.Ascending} + */ + sortOrder?: ej.PivotAnalysis.SortOrder | string; + + /** Applies filter to the field members. + * @Default {null} + */ + filterItems?: DataSourceRowsFilterItems; + } + + export interface DataSourceValuesMeasure { + + /** Allows the user to bind the measure from OLAP datasource by using its unique name as field name. + */ + fieldName?: string; + } + + export interface DataSourceValue { + + /** Allows the user to bind the item by using its unique name as field name for Relational datasource. + */ + fieldName?: string; + + /** Allows the user to set the display caption for an item for Relational datasource. + */ + fieldCaption?: string; + + /** This holds the list of unique names of measures to bind them from the OLAP cube. + * @Default {[]} + */ + measures?: DataSourceValuesMeasure[]; + + /** Allows to set the axis name to place the measures items. + * @Default {rows} + */ + axis?: string; + + /** Indicates whether the field is a calculated field or not with Relational datasource. + * @Default {false} + */ + isCalculatedField?: boolean; + + /** Allows to set the formula for calculation of values for calculated members in Relational datasource. + */ + formula?: string; + } + + export interface DataSourceFiltersFilterItems { + + /** Sets the type of filter whether to include/exclude the mentioned values. + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ + filterType?: ej.PivotAnalysis.FilterType | string; + + /** Contains the collection of items to be included/excluded among the field members. + * @Default {[]} + */ + values?: any[]; + } + + export interface DataSourceFilter { + + /** Allows the user to bind the item by using its unique name as field name. + */ + fieldName?: string; + + /** Applies filter to the field members. + * @Default {null} + */ + filterItems?: DataSourceFiltersFilterItems; + } -export interface DataSource { + export interface DataSource { - /** Contains the respective cube name from OLAP database as string type. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - cube?: string; + /** Contains the respective cube name from OLAP database as string type. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + cube?: string; - /** Provides the raw data source for the PivotChart. - * @Default {null} - */ - data?: any; + /** Provides the raw data source for the PivotChart. + * @Default {null} + */ + data?: any; - /** In connection with an OLAP database, this property contains the database name as string to fetch the data from the given connection string. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - catalog?: string; + /** In connection with an OLAP database, this property contains the database name as string to fetch the data from the given connection string. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + catalog?: string; - /** Lists out the items to be displayed as series of PivotChart. - * @Default {[]} - */ - columns?: DataSourceColumn[]; + /** Lists out the items to be displayed as series of PivotChart. + * @Default {[]} + */ + columns?: DataSourceColumn[]; - /** Lists out the items to be displayed as segments of PivotChart. - * @Default {[]} - */ - rows?: DataSourceRow[]; + /** Lists out the items to be displayed as segments of PivotChart. + * @Default {[]} + */ + rows?: DataSourceRow[]; - /** Lists out the items supports calculation in PivotChart. - * @Default {[]} - */ - values?: DataSourceValue[]; + /** Lists out the items supports calculation in PivotChart. + * @Default {[]} + */ + values?: DataSourceValue[]; - /** Lists out the items which supports filtering of values without displaying the members in UI in PivotChart. - * @Default {[]} - */ - filters?: DataSourceFilter[]; -} + /** Lists out the items which supports filtering of values without displaying the members in UI in PivotChart. + * @Default {[]} + */ + filters?: DataSourceFilter[]; + } -export interface ServiceMethodSettings { + export interface ServiceMethodSettings { - /** Allows the user to set the custom name for the service method responsible for drilling up/down operation in PivotChart. - * @Default {DrillChart} - */ - drillDown?: string; + /** Allows the user to set the custom name for the service method responsible for drilling up/down operation in PivotChart. + * @Default {DrillChart} + */ + drillDown?: string; - /** Allows the user to set the custom name for the service method responsible for exporting. - * @Default {Export} - */ - exportPivotChart?: string; + /** Allows the user to set the custom name for the service method responsible for exporting. + * @Default {Export} + */ + exportPivotChart?: string; - /** Allows the user to set the custom name for the service method responsible for initializing PivotChart. - * @Default {InitializeChart} - */ - initialize?: string; + /** Allows the user to set the custom name for the service method responsible for initializing PivotChart. + * @Default {InitializeChart} + */ + initialize?: string; - /** Allows the user to set the custom name for the service method responsible for navigating between pages in paged PivotChart. - * @Default {Paging} - */ - paging?: string; -} - -enum ChartTypes { - - ///To render a Line type PivotChart. - Line, - - ///To render a Spline type PivotChart. - Spline, + /** Allows the user to set the custom name for the service method responsible for navigating between pages in paged PivotChart. + * @Default {Paging} + */ + paging?: string; + } + + enum ChartTypes { + + ///To render a Line type PivotChart. + Line, + + ///To render a Spline type PivotChart. + Spline, - ///To render a Column type PivotChart. - Column, - - ///To render an Area type PivotChart. - Area, - - ///To render a SplineArea type PivotChart. - SplineArea, - - ///To render a StepLine type PivotChart. - StepLine, - - ///To render a StepArea type PivotChart. - StepArea, - - ///To render a Pie type PivotChart. - Pie, - - ///To render a Bar type PivotChart. - Bar, - - ///To render a StackingArea type PivotChart. - StackingArea, - - ///To render a StackingColumn type PivotChart. - StackingColumn, - - ///To render a StackingBar type PivotChart. - StackingBar, - - ///To render a Pyramid type PivotChart. - Pyramid, - - ///To render a Funnel type PivotChart. - Funnel, - - ///To render a Doughnut type PivotChart. - Doughnut, - - ///To render a Scatter type PivotChart. - Scatter, - - ///To render a Bubble type PivotChart. - Bubble -} - -} - -class PivotClient extends ej.Widget { - static fn: PivotClient; - constructor(element: JQuery | Element, options?: PivotClient.Model); - static Locale: any; - model: PivotClient.Model; - defaults: PivotClient.Model; - - /** Performs an asynchronous HTTP (AJAX) request. - * @returns {void} - */ - doAjaxPost(): void; - - /** Performs an asynchronous HTTP (FullPost) submit. - * @returns {void} - */ - doPostBack(): void; - - /** Navigates to the specified page in specified axis. - * @returns {void} - */ - refreshPagedPivotClient(): void; - - /** Updates the PivotClient component with the JSON data fetched from the service on navigating between pages. - * @returns {void} - */ - refreshPagedPivotClientSuccess(): void; - - /** Renders the PivotChart and PivotGrid with the JSON data provided. - * @returns {void} - */ - generateJSON(): void; - - /** Re-renders the control with the report at that instant. - * @returns {void} - */ - refreshControl(): void; - - /** Returns the OlapReport string maintained along with the axis elements information. - * @returns {string} - */ - getOlapReport(): string; - - /** Sets the OlapReport string along with the axis information and maintains it in a property. - * @returns {void} - */ - setOlapReport(): void; - - /** Returns the JSON records formed to render the control. - * @returns {Array} - */ - getJSONRecords(): any[]; - - /** Sets the JSON records formed to render the control to a property. - * @returns {void} - */ - setJSONRecords(): void; -} -export namespace PivotClient { - -export interface Model { - - /** Sets the mode for the PivotClient widget for binding either OLAP or Relational data source. - * @Default {ej.Pivot.AnalysisMode.Pivot} - */ - analysisMode?: ej.Pivot.AnalysisMode|string; - - /** Allows the user to set the specific chart type for PivotChart inside PivotClient widget. - * @Default {ej.PivotChart.ChartTypes.Column} - */ - chartType?: ej.PivotChart.ChartTypes|string; - - /** Allows the user to set the content on exporting the PivotClient widget. - * @Default {ej.PivotClient.ClientExportMode.ChartAndGrid} - */ - clientExportMode?: ej.PivotClient.ClientExportMode|string; - - /** Specifies the CSS class to PivotClient to achieve custom theme. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - cssClass?: string; - - /** Object utilized to pass additional information between client-end and service-end when the control functions in server-mode. - * @Default {{}} - */ - customObject?: any; - - /** Initializes the data source for the PivotClient widget, when it functions completely on client-side. - * @Default {{}} - */ - dataSource?: DataSource; - - /** Allows the user to customize the widget's layout and appearance. - * @Default {{}} - */ - displaySettings?: DisplaySettings; - - /** Enables the splitter option for resizing the elements inside the control. - * @Default {false} - */ - enableSplitter?: boolean; - - /** Enables the advanced filtering options Value Filtering, Label Filtering and Sorting for each dimensions on binding OLAP data in server mode. - * @Default {false} - */ - enableAdvancedFilter?: boolean; - - /** Allows the user to refresh the control on-demand and not during every UI operation. - * @Default {false} - */ - enableDeferUpdate?: boolean; - - /** Lets the user to save and load reports in a customized way with the help of events. - * @Default {false} - */ - enableLocalStorage?: boolean; - - /** Allows the user to enable paging for both the PivotChart and PivotGrid components for the ease of viewing large data. - * @Default {false} - */ - enablePaging?: boolean; - - /** Allows the user to include the PivotTreeMap component as one of the chart types. - * @Default {false} - */ - enablePivotTreeMap?: boolean; - - /** Allows the user to view the layout of PivotClient from right to left. - * @Default {false} - */ - enableRTL?: boolean; - - /** Enables/disables the visibility of measure group selector drop-down in Cube Browser. - * @Default {false} - */ - enableMeasureGroups?: boolean; - - /** Allows the user to enable virtual scrolling for both the PivotChart and PivotGrid components for the ease of viewing large data. - * @Default {false} - */ - enableVirtualScrolling?: boolean; - - /** Enables/Disables paging in Member Editor for viewing the large count of members in pages. - * @Default {false} - */ - enableMemberEditorPaging?: boolean; - - /** Allows the user to set the number of members to be displayed in each page of Member Editor on applying paging in it. - * @Default {100} - */ - memberEditorPageSize?: number; - - /** Sets the summary layout for PivotGrid. Following are the ways in which summary can be positioned: normal summary (bottom), top summary, no summary and excel-like summary. - * @Default {ej.PivotGrid.Layout.Normal} - */ - gridLayout?: ej.PivotGrid.Layout|string; - - /** Allows the user to enable PivotClientĂ¢â‚¬â„¢s responsiveness in the browser layout. - * @Default {false} - */ - isResponsive?: boolean; - - /** Allows the user to set the localized language for the widget. - * @Default {en-US} - */ - locale?: string; - - /** Sets the mode for the PivotClient widget for binding data source either in server-side or client-side. - * @Default {ej.Pivot.OperationalMode.ClientMode} - */ - operationalMode?: ej.Pivot.OperationalMode|string; - - /** Allows the user to set custom name for the methods at service-end, communicated during AJAX post. - * @Default {{}} - */ - serviceMethodSettings?: ServiceMethodSettings; + ///To render a Column type PivotChart. + Column, + + ///To render an Area type PivotChart. + Area, + + ///To render a SplineArea type PivotChart. + SplineArea, + + ///To render a StepLine type PivotChart. + StepLine, + + ///To render a StepArea type PivotChart. + StepArea, + + ///To render a Pie type PivotChart. + Pie, + + ///To render a Bar type PivotChart. + Bar, + + ///To render a StackingArea type PivotChart. + StackingArea, + + ///To render a StackingColumn type PivotChart. + StackingColumn, + + ///To render a StackingBar type PivotChart. + StackingBar, + + ///To render a Pyramid type PivotChart. + Pyramid, + + ///To render a Funnel type PivotChart. + Funnel, + + ///To render a Doughnut type PivotChart. + Doughnut, + + ///To render a Scatter type PivotChart. + Scatter, + + ///To render a Bubble type PivotChart. + Bubble + } + + } + + class PivotClient extends ej.Widget { + static fn: PivotClient; + constructor(element: JQuery | Element, options?: PivotClient.Model); + static Locale: any; + model: PivotClient.Model; + defaults: PivotClient.Model; + + /** Performs an asynchronous HTTP (AJAX) request. + * @returns {void} + */ + doAjaxPost(): void; + + /** Performs an asynchronous HTTP (FullPost) submit. + * @returns {void} + */ + doPostBack(): void; + + /** Navigates to the specified page in specified axis. + * @returns {void} + */ + refreshPagedPivotClient(): void; + + /** Updates the PivotClient component with the JSON data fetched from the service on navigating between pages. + * @returns {void} + */ + refreshPagedPivotClientSuccess(): void; + + /** Renders the PivotChart and PivotGrid with the JSON data provided. + * @returns {void} + */ + generateJSON(): void; + + /** Re-renders the control with the report at that instant. + * @returns {void} + */ + refreshControl(): void; + + /** Returns the OlapReport string maintained along with the axis elements information. + * @returns {string} + */ + getOlapReport(): string; + + /** Sets the OlapReport string along with the axis information and maintains it in a property. + * @returns {void} + */ + setOlapReport(): void; + + /** Returns the JSON records formed to render the control. + * @returns {Array} + */ + getJSONRecords(): any[]; + + /** Sets the JSON records formed to render the control to a property. + * @returns {void} + */ + setJSONRecords(): void; + } + export namespace PivotClient { + + export interface Model { + + /** Sets the mode for the PivotClient widget for binding either OLAP or Relational data source. + * @Default {ej.Pivot.AnalysisMode.Pivot} + */ + analysisMode?: ej.Pivot.AnalysisMode | string; + + /** Allows the user to set the specific chart type for PivotChart inside PivotClient widget. + * @Default {ej.PivotChart.ChartTypes.Column} + */ + chartType?: ej.PivotChart.ChartTypes | string; + + /** Allows the user to set the content on exporting the PivotClient widget. + * @Default {ej.PivotClient.ClientExportMode.ChartAndGrid} + */ + clientExportMode?: ej.PivotClient.ClientExportMode | string; + + /** Specifies the CSS class to PivotClient to achieve custom theme. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + cssClass?: string; + + /** Object utilized to pass additional information between client-end and service-end when the control functions in server-mode. + * @Default {{}} + */ + customObject?: any; + + /** Initializes the data source for the PivotClient widget, when it functions completely on client-side. + * @Default {{}} + */ + dataSource?: DataSource; + + /** Allows the user to customize the widget's layout and appearance. + * @Default {{}} + */ + displaySettings?: DisplaySettings; + + /** Enables the splitter option for resizing the elements inside the control. + * @Default {false} + */ + enableSplitter?: boolean; + + /** Enables the advanced filtering options Value Filtering, Label Filtering and Sorting for each dimensions on binding OLAP data in server mode. + * @Default {false} + */ + enableAdvancedFilter?: boolean; + + /** Allows the user to refresh the control on-demand and not during every UI operation. + * @Default {false} + */ + enableDeferUpdate?: boolean; + + /** Lets the user to save and load reports in a customized way with the help of events. + * @Default {false} + */ + enableLocalStorage?: boolean; + + /** Allows the user to enable paging for both the PivotChart and PivotGrid components for the ease of viewing large data. + * @Default {false} + */ + enablePaging?: boolean; + + /** Allows the user to include the PivotTreeMap component as one of the chart types. + * @Default {false} + */ + enablePivotTreeMap?: boolean; + + /** Allows the user to view the layout of PivotClient from right to left. + * @Default {false} + */ + enableRTL?: boolean; + + /** Enables/disables the visibility of measure group selector drop-down in Cube Browser. + * @Default {false} + */ + enableMeasureGroups?: boolean; + + /** Allows the user to enable virtual scrolling for both the PivotChart and PivotGrid components for the ease of viewing large data. + * @Default {false} + */ + enableVirtualScrolling?: boolean; + + /** Enables/Disables paging in Member Editor for viewing the large count of members in pages. + * @Default {false} + */ + enableMemberEditorPaging?: boolean; + + /** Allows the user to set the number of members to be displayed in each page of Member Editor on applying paging in it. + * @Default {100} + */ + memberEditorPageSize?: number; + + /** Sets the summary layout for PivotGrid. Following are the ways in which summary can be positioned: normal summary (bottom), top summary, no summary and excel-like summary. + * @Default {ej.PivotGrid.Layout.Normal} + */ + gridLayout?: ej.PivotGrid.Layout | string; + + /** Allows the user to enable PivotClientĂ¢â‚¬â„¢s responsiveness in the browser layout. + * @Default {false} + */ + isResponsive?: boolean; + + /** Allows the user to set the localized language for the widget. + * @Default {en-US} + */ + locale?: string; + + /** Sets the mode for the PivotClient widget for binding data source either in server-side or client-side. + * @Default {ej.Pivot.OperationalMode.ClientMode} + */ + operationalMode?: ej.Pivot.OperationalMode | string; + + /** Allows the user to set custom name for the methods at service-end, communicated during AJAX post. + * @Default {{}} + */ + serviceMethodSettings?: ServiceMethodSettings; - /** Sets the title for PivotClient widget. - */ - title?: string; + /** Sets the title for PivotClient widget. + */ + title?: string; - /** Connects the service using the specified URL for any server updates. - */ - url?: string; + /** Connects the service using the specified URL for any server updates. + */ + url?: string; - /** Triggers when it reaches client-side after any AJAX request. */ - afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; + /** Triggers when it reaches client-side after any AJAX request. */ + afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; - /** Triggers before any AJAX request is passed from client-side to service methods. */ - beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; + /** Triggers before any AJAX request is passed from client-side to service methods. */ + beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; - /** Triggers before saving the current collection of reports. */ - saveReport?(e: SaveReportEventArgs): void; + /** Triggers before saving the current collection of reports. */ + saveReport?(e: SaveReportEventArgs): void; - /** Triggers before loading a saved collection of reports. */ - loadReport?(e: LoadReportEventArgs): void; + /** Triggers before loading a saved collection of reports. */ + loadReport?(e: LoadReportEventArgs): void; - /** Triggers before fetching the report collection from storage. */ - fetchReport?(e: FetchReportEventArgs): void; + /** Triggers before fetching the report collection from storage. */ + fetchReport?(e: FetchReportEventArgs): void; - /** Triggers before exporting the control. */ - beforeExport?(e: BeforeExportEventArgs): void; + /** Triggers before exporting the control. */ + beforeExport?(e: BeforeExportEventArgs): void; - /** Triggers before rendering the PivotChart. */ - chartLoad?(e: ChartLoadEventArgs): void; + /** Triggers before rendering the PivotChart. */ + chartLoad?(e: ChartLoadEventArgs): void; - /** Triggers before rendering the PivotTreeMap. */ - treeMapLoad?(e: TreeMapLoadEventArgs): void; + /** Triggers before rendering the PivotTreeMap. */ + treeMapLoad?(e: TreeMapLoadEventArgs): void; - /** Triggers while we initiate loading of the widget. */ - load?(e: LoadEventArgs): void; + /** Triggers while we initiate loading of the widget. */ + load?(e: LoadEventArgs): void; - /** Triggers when PivotClient widget completes all operations at client-end after any AJAX request. */ - renderComplete?(e: RenderCompleteEventArgs): void; + /** Triggers when PivotClient widget completes all operations at client-end after any AJAX request. */ + renderComplete?(e: RenderCompleteEventArgs): void; - /** Triggers when any error occurred during AJAX request. */ - renderFailure?(e: RenderFailureEventArgs): void; + /** Triggers when any error occurred during AJAX request. */ + renderFailure?(e: RenderFailureEventArgs): void; - /** Triggers when PivotClient successfully completes rendering. */ - renderSuccess?(e: RenderSuccessEventArgs): void; -} + /** Triggers when PivotClient successfully completes rendering. */ + renderSuccess?(e: RenderSuccessEventArgs): void; + } -export interface AfterServiceInvokeEventArgs { + export interface AfterServiceInvokeEventArgs { - /** returns the current action of PivotClient control. - */ - action?: string; + /** returns the current action of PivotClient control. + */ + action?: string; - /** returns the custom object bounds with PivotClient control. - */ - customObject?: any; + /** returns the custom object bounds with PivotClient control. + */ + customObject?: any; - /** returns the HTML element of PivotClient control. - */ - element?: any; -} + /** returns the HTML element of PivotClient control. + */ + element?: any; + } -export interface BeforeServiceInvokeEventArgs { + export interface BeforeServiceInvokeEventArgs { - /** returns the current action of PivotClient control. - */ - action?: string; + /** returns the current action of PivotClient control. + */ + action?: string; - /** returns the custom object bounds with PivotClient control. - */ - customObject?: any; + /** returns the custom object bounds with PivotClient control. + */ + customObject?: any; - /** returns the HTML element of PivotClient control. - */ - element?: any; -} + /** returns the HTML element of PivotClient control. + */ + element?: any; + } -export interface SaveReportEventArgs { + export interface SaveReportEventArgs { - /** returns the current instance of PivotClient control. - */ - targetControl?: any; + /** returns the current instance of PivotClient control. + */ + targetControl?: any; - /** returns the object which holds the necessary parameters required for saving the report collection. - */ - saveReportSetting?: any; -} + /** returns the object which holds the necessary parameters required for saving the report collection. + */ + saveReportSetting?: any; + } -export interface LoadReportEventArgs { + export interface LoadReportEventArgs { - /** returns the current instance of PivotClient control. - */ - targetControl?: any; + /** returns the current instance of PivotClient control. + */ + targetControl?: any; - /** returns the object which holds the necessary parameters required for loading a report collection from database. - */ - loadReportSetting?: any; -} + /** returns the object which holds the necessary parameters required for loading a report collection from database. + */ + loadReportSetting?: any; + } -export interface FetchReportEventArgs { + export interface FetchReportEventArgs { - /** returns the current instance of PivotClient control. - */ - targetControl?: any; + /** returns the current instance of PivotClient control. + */ + targetControl?: any; - /** returns the object which holds the necessary parameters required for fetching the report names stored in database. - */ - fetchReportSetting?: any; -} + /** returns the object which holds the necessary parameters required for fetching the report names stored in database. + */ + fetchReportSetting?: any; + } -export interface BeforeExportEventArgs { + export interface BeforeExportEventArgs { - /** holds the url of the service method responsible for exporting the PivotClient control. - */ - url?: string; + /** holds the url of the service method responsible for exporting the PivotClient control. + */ + url?: string; - /** holds the name of the file to be exported. - */ - fileName?: string; -} + /** holds the name of the file to be exported. + */ + fileName?: string; + } -export interface ChartLoadEventArgs { + export interface ChartLoadEventArgs { - /** returns the current action of PivotChart control. - */ - action?: string; + /** returns the current action of PivotChart control. + */ + action?: string; - /** returns the custom object bound with PivotChart control. - */ - customObject?: any; + /** returns the custom object bound with PivotChart control. + */ + customObject?: any; - /** returns the HTML element of PivotChart control. - */ - element?: any; -} + /** returns the HTML element of PivotChart control. + */ + element?: any; + } -export interface TreeMapLoadEventArgs { + export interface TreeMapLoadEventArgs { - /** returns the current action of PivotTreeMap control. - */ - action?: string; + /** returns the current action of PivotTreeMap control. + */ + action?: string; - /** returns the custom object bound with PivotTreeMap control. - */ - customObject?: any; + /** returns the custom object bound with PivotTreeMap control. + */ + customObject?: any; - /** returns the HTML element of PivotTreeMap control. - */ - element?: any; -} + /** returns the HTML element of PivotTreeMap control. + */ + element?: any; + } -export interface LoadEventArgs { + export interface LoadEventArgs { - /** returns the HTML element of PivotClient component. - */ - element?: any; + /** returns the HTML element of PivotClient component. + */ + element?: any; - /** returns the custom object bound with PivotTreeMap control. - */ - customObject?: any; -} + /** returns the custom object bound with PivotTreeMap control. + */ + customObject?: any; + } -export interface RenderCompleteEventArgs { + export interface RenderCompleteEventArgs { - /** returns the HTML element of PivotClient component. - */ - element?: any; + /** returns the HTML element of PivotClient component. + */ + element?: any; - /** returns the custom object bound with PivotTreeMap control. - */ - customObject?: any; -} + /** returns the custom object bound with PivotTreeMap control. + */ + customObject?: any; + } -export interface RenderFailureEventArgs { + export interface RenderFailureEventArgs { - /** returns the custom object bound with the control. - */ - customObject?: any; + /** returns the custom object bound with the control. + */ + customObject?: any; - /** returns the HTML element of PivotClient control. - */ - element?: any; + /** returns the HTML element of PivotClient control. + */ + element?: any; - /** returns the error message with error code. - */ - message?: string; -} + /** returns the error message with error code. + */ + message?: string; + } -export interface RenderSuccessEventArgs { + export interface RenderSuccessEventArgs { - /** returns the object of PivotClient control at that instant. - */ - args?: any; -} + /** returns the object of PivotClient control at that instant. + */ + args?: any; + } -export interface DataSourceColumnsAdvancedFilter { + export interface DataSourceColumnsAdvancedFilter { - /** Allows the user to provide level unique name to perform advanced filtering. - */ - name?: string; + /** Allows the user to provide level unique name to perform advanced filtering. + */ + name?: string; - /** Allows the user to set the operator to perform Label Filtering. - * @Default {none} - */ - labelFilterOperator?: string; - - /** Allows the user to set the operator to perform Value Filtering. - * @Default {none} - */ - valueFilterOperator?: string; + /** Allows the user to set the operator to perform Label Filtering. + * @Default {none} + */ + labelFilterOperator?: string; + + /** Allows the user to set the operator to perform Value Filtering. + * @Default {none} + */ + valueFilterOperator?: string; - /** Allows the user to set the filtering type while performing advanced filtering. - */ - advancedFilterType?: string; + /** Allows the user to set the filtering type while performing advanced filtering. + */ + advancedFilterType?: string; - /** In case of value filtering, this property contains the measure name to which the filter is applied. - */ - measure?: string; - - /** Allows the user to hold the filter operand values in advanced filtering. - */ - values?: any[]; -} - -export interface DataSourceColumnsFilterItems { + /** In case of value filtering, this property contains the measure name to which the filter is applied. + */ + measure?: string; + + /** Allows the user to hold the filter operand values in advanced filtering. + */ + values?: any[]; + } + + export interface DataSourceColumnsFilterItems { - /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ - filterType?: ej.PivotAnalysis.FilterType|string; + /** Sets the type of filter whether to include/exclude the mentioned values. + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ + filterType?: ej.PivotAnalysis.FilterType | string; - /** Contains the collection of items to be included/excluded among the field members. - * @Default {[]} - */ - values?: any[]; -} - -export interface DataSourceColumn { - - /** Allows the user to bind the item by using its unique name as field name. - */ - fieldName?: string; - - /** Allows the user to set the display caption for an item. - */ - fieldCaption?: string; - - /** Allows the user to filter the report by default using advanced filtering (excel-like) option for OLAP data source in client-mode. - * @Default {[]} - */ - advancedFilter?: DataSourceColumnsAdvancedFilter[]; - - /** Allows the user to indicate whether the added item is a named set or not. - * @Default {false} - */ - isNamedSets?: boolean; - - /** Shows/Hides the sub-total of the field in PivotGrid. - * @Default {true} - */ - showSubTotal?: boolean; - - /** Allows the user to set the sorting order of the members of the field. - * @Default {ej.PivotAnalysis.SortOrder.Ascending} - */ - sortOrder?: ej.PivotAnalysis.SortOrder|string; - - /** Contains the list of members need to be drilled down by default in the field. - * @Default {[]} - */ - drilledItems?: any[]; - - /** Applies filter to the field members. - * @Default {null} - */ - filterItems?: DataSourceColumnsFilterItems; -} - -export interface DataSourceRowsAdvancedFilter { - - /** Allows the user to provide level unique name to perform advanced filtering. - */ - name?: string; - - /** Allows the user to set the operator to perform Label Filtering. - * @Default {none} - */ - labelFilterOperator?: string; - - /** Allows the user to set the operator to perform Value Filtering. - * @Default {none} - */ - valueFilterOperator?: string; - - /** Allows the user to set the filtering type while performing advanced filtering. - */ - advancedFilterType?: string; - - /** In case of value filtering, this property contains the measure name to which the filter is applied. - */ - measure?: string; - - /** Allows the user to hold the filter operand values in advanced filtering. - */ - values?: any[]; -} - -export interface DataSourceRowsFilterItems { - - /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ - filterType?: ej.PivotAnalysis.FilterType|string; - - /** Contains the collection of items to be included/excluded among the field members. - * @Default {[]} - */ - values?: any[]; -} - -export interface DataSourceRow { - - /** Allows the user to bind the item by using its unique name as field name. - */ - fieldName?: string; - - /** Allows the user to set the display caption for an item. - */ - fieldCaption?: string; - - /** Allows the user to filter the report by default using advanced filtering (excel-like) option for OLAP data source in client-mode. - * @Default {[]} - */ - advancedFilter?: DataSourceRowsAdvancedFilter[]; - - /** Allows the user to indicate whether the added item is a named set or not. - * @Default {false} - */ - isNamedSets?: boolean; - - /** Shows/Hides the sub-total of the field. - * @Default {true} - */ - showSubTotal?: boolean; - - /** Allows the user to set the sorting order of the members of the field. - * @Default {ej.PivotAnalysis.SortOrder.Ascending} - */ - sortOrder?: ej.PivotAnalysis.SortOrder|string; - - /** Contains the list of members need to be drilled down by default in the field. - * @Default {[]} - */ - drilledItems?: any[]; - - /** Applies filter to the field members. - * @Default {null} - */ - filterItems?: DataSourceRowsFilterItems; -} - -export interface DataSourceValuesMeasure { - - /** Allows the user to bind the measure from OLAP datasource by using its unique name as field name. - */ - fieldName?: string; -} - -export interface DataSourceValue { - - /** Allows the user to bind the item by using its unique name as field name for Relational datasource. - */ - fieldName?: string; - - /** Allows the user to set the display caption for an item for Relational datasource. - */ - fieldCaption?: string; - - /** This holds the list of unique names of measures to bind them from the OLAP cube. - * @Default {[]} - */ - measures?: DataSourceValuesMeasure[]; - - /** Allows to set the axis name to place the measures items. - * @Default {rows} - */ - axis?: string; - - /** Indicates whether the field is a calculated field or not with Relational datasource. - * @Default {false} - */ - isCalculatedField?: boolean; - - /** Allows to set the type of PivotGrid summary calculation for the value field with Relational datasource. - * @Default {ej.PivotAnalysis.SummaryType.Sum} - */ - summaryType?: ej.PivotAnalysis.SummaryType|string; - - /** Allows to set the format of the values. - */ - format?: string; - - /** This property sets type of display of date. - */ - formatString?: string; - - /** Allows to set the formula for calculation of values for calculated members in Relational datasource. - */ - formula?: string; -} - -export interface DataSourceFiltersFilterItems { - - /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ - filterType?: ej.PivotAnalysis.FilterType|string; - - /** Contains the collection of items to be included/excluded among the field members. - * @Default {[]} - */ - values?: any[]; -} - -export interface DataSourceFilter { - - /** Allows the user to bind the item by using its unique name as field name. - */ - fieldName?: string; - - /** Allows the user to set the display name for an item. - */ - fieldCaption?: string; - - /** Applies filter to the field members. - * @Default {null} - */ - filterItems?: DataSourceFiltersFilterItems; -} - -export interface DataSourcePagerOptions { - - /** Allows to set the number of categorical columns to be displayed in each page on applying paging. - * @Default {0} - */ - categoricalPageSize?: number; - - /** Allows to set the number of series rows to be displayed in each page on applying paging. - * @Default {0} - */ - seriesPageSize?: number; - - /** Allows to set the page number in categorical axis to be loaded by default. - * @Default {1} - */ - categoricalCurrentPage?: number; - - /** Allows to set the page number in series axis to be loaded by default. - * @Default {1} - */ - seriesCurrentPage?: number; -} - -export interface DataSource { - - /** Lists out the items to be arranged in columns section of PivotClient. - * @Default {[]} - */ - columns?: DataSourceColumn[]; - - /** Lists out the items to be arranged in rows section of PivotClient. - * @Default {[]} - */ - rows?: DataSourceRow[]; - - /** Lists out the items which supports calculation in PivotClient. - * @Default {[]} - */ - values?: DataSourceValue[]; - - /** Lists out the items which supports filtering of values without displaying the members in UI in PivotClient. - * @Default {[]} - */ - filters?: DataSourceFilter[]; - - /** Contains the respective cube name from OLAP database as string type. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - cube?: string; - - /** Provides the raw data source for the PivotClient. - * @Default {null} - */ - data?: any; - - /** In connection with an OLAP database, this property contains the database name as string to fetch the data from the given connection string. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - catalog?: string; - - /** Allows user to filter the members (by its name and values) through advanced filtering (excel-like) option in client-mode. - * @Default {false} - */ - enableAdvancedFilter?: boolean; - - /** Sets a name to the report bound to the control. - */ - reportName?: string; - - /** Allows to set the page size and current page number for each axis on applying paging. - * @Default {{}} - */ - pagerOptions?: DataSourcePagerOptions; -} - -export interface DisplaySettings { - - /** Lets the user to customize the display of PivotChart and PivotGrid widgets, either in tabs or tiles. - * @Default {ej.PivotClient.ControlPlacement.Tab} - */ - controlPlacement?: ej.PivotClient.ControlPlacement|string; - - /** Lets the user to set either Chart or Grid as the start-up widget. - * @Default {ej.PivotClient.DefaultView.Grid} - */ - defaultView?: ej.PivotClient.DefaultView|string; - - /** Lets the user to have an option for switching to full screen view of PivotChart and PivotGrid from default view in PivotClient. - * @Default {false} - */ - enableFullScreen?: boolean; - - /** Enables an option to enhance the space for PivotGrid and PivotChart by hiding Cube Browser and Axis Element Builder. - * @Default {false} - */ - enableTogglePanel?: boolean; - - /** Sets the display mode (Only Chart/Only Grid/Both) in PivotClient. - * @Default {ej.PivotClient.DisplayMode.ChartAndGrid} - */ - mode?: ej.PivotClient.DisplayMode|string; -} - -export interface ServiceMethodSettings { - - /** Allows the user to set the custom name for the service method responsible for updating the entire report and widget, while changing the Cube. - * @Default {CubeChanged} - */ - cubeChanged?: string; - - /** Allows the user to set the custom name for the service method responsible for exporting. - * @Default {Export} - */ - exportPivotClient?: string; - - /** Allows the user to set the custom name for the service method responsible to get the members for the tree-view, inside member-editor dialog. - * @Default {FetchMemberTreeNodes} - */ - fetchMemberTreeNodes?: string; - - /** Allows the user to set the custom name for the service method responsible for fetching the report names from the database. - * @Default {FetchReportListFromDB} - */ - fetchReportList?: string; - - /** Allows the user to set the custom name for the service method responsible for updating report while filtering members. - * @Default {FilterElement} - */ - filterElement?: string; - - /** Allows the user to set the custom name for the service method responsible for initializing PivotClient. - * @Default {InitializeClient} - */ - initialize?: string; - - /** Allows the user to set the custom name for the service method responsible for loading a report collection from the database. - * @Default {LoadReportFromDB} - */ - loadReport?: string; + /** Contains the collection of items to be included/excluded among the field members. + * @Default {[]} + */ + values?: any[]; + } + + export interface DataSourceColumn { + + /** Allows the user to bind the item by using its unique name as field name. + */ + fieldName?: string; + + /** Allows the user to set the display caption for an item. + */ + fieldCaption?: string; + + /** Allows the user to filter the report by default using advanced filtering (excel-like) option for OLAP data source in client-mode. + * @Default {[]} + */ + advancedFilter?: DataSourceColumnsAdvancedFilter[]; + + /** Allows the user to indicate whether the added item is a named set or not. + * @Default {false} + */ + isNamedSets?: boolean; + + /** Shows/Hides the sub-total of the field in PivotGrid. + * @Default {true} + */ + showSubTotal?: boolean; + + /** Allows the user to set the sorting order of the members of the field. + * @Default {ej.PivotAnalysis.SortOrder.Ascending} + */ + sortOrder?: ej.PivotAnalysis.SortOrder | string; + + /** Contains the list of members need to be drilled down by default in the field. + * @Default {[]} + */ + drilledItems?: any[]; + + /** Applies filter to the field members. + * @Default {null} + */ + filterItems?: DataSourceColumnsFilterItems; + } + + export interface DataSourceRowsAdvancedFilter { + + /** Allows the user to provide level unique name to perform advanced filtering. + */ + name?: string; + + /** Allows the user to set the operator to perform Label Filtering. + * @Default {none} + */ + labelFilterOperator?: string; + + /** Allows the user to set the operator to perform Value Filtering. + * @Default {none} + */ + valueFilterOperator?: string; + + /** Allows the user to set the filtering type while performing advanced filtering. + */ + advancedFilterType?: string; + + /** In case of value filtering, this property contains the measure name to which the filter is applied. + */ + measure?: string; + + /** Allows the user to hold the filter operand values in advanced filtering. + */ + values?: any[]; + } + + export interface DataSourceRowsFilterItems { + + /** Sets the type of filter whether to include/exclude the mentioned values. + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ + filterType?: ej.PivotAnalysis.FilterType | string; + + /** Contains the collection of items to be included/excluded among the field members. + * @Default {[]} + */ + values?: any[]; + } + + export interface DataSourceRow { + + /** Allows the user to bind the item by using its unique name as field name. + */ + fieldName?: string; + + /** Allows the user to set the display caption for an item. + */ + fieldCaption?: string; + + /** Allows the user to filter the report by default using advanced filtering (excel-like) option for OLAP data source in client-mode. + * @Default {[]} + */ + advancedFilter?: DataSourceRowsAdvancedFilter[]; + + /** Allows the user to indicate whether the added item is a named set or not. + * @Default {false} + */ + isNamedSets?: boolean; + + /** Shows/Hides the sub-total of the field. + * @Default {true} + */ + showSubTotal?: boolean; + + /** Allows the user to set the sorting order of the members of the field. + * @Default {ej.PivotAnalysis.SortOrder.Ascending} + */ + sortOrder?: ej.PivotAnalysis.SortOrder | string; + + /** Contains the list of members need to be drilled down by default in the field. + * @Default {[]} + */ + drilledItems?: any[]; + + /** Applies filter to the field members. + * @Default {null} + */ + filterItems?: DataSourceRowsFilterItems; + } + + export interface DataSourceValuesMeasure { + + /** Allows the user to bind the measure from OLAP datasource by using its unique name as field name. + */ + fieldName?: string; + } + + export interface DataSourceValue { + + /** Allows the user to bind the item by using its unique name as field name for Relational datasource. + */ + fieldName?: string; + + /** Allows the user to set the display caption for an item for Relational datasource. + */ + fieldCaption?: string; + + /** This holds the list of unique names of measures to bind them from the OLAP cube. + * @Default {[]} + */ + measures?: DataSourceValuesMeasure[]; + + /** Allows to set the axis name to place the measures items. + * @Default {rows} + */ + axis?: string; + + /** Indicates whether the field is a calculated field or not with Relational datasource. + * @Default {false} + */ + isCalculatedField?: boolean; + + /** Allows to set the type of PivotGrid summary calculation for the value field with Relational datasource. + * @Default {ej.PivotAnalysis.SummaryType.Sum} + */ + summaryType?: ej.PivotAnalysis.SummaryType | string; + + /** Allows to set the format of the values. + */ + format?: string; + + /** This property sets type of display of date. + */ + formatString?: string; + + /** Allows to set the formula for calculation of values for calculated members in Relational datasource. + */ + formula?: string; + } + + export interface DataSourceFiltersFilterItems { + + /** Sets the type of filter whether to include/exclude the mentioned values. + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ + filterType?: ej.PivotAnalysis.FilterType | string; + + /** Contains the collection of items to be included/excluded among the field members. + * @Default {[]} + */ + values?: any[]; + } + + export interface DataSourceFilter { + + /** Allows the user to bind the item by using its unique name as field name. + */ + fieldName?: string; + + /** Allows the user to set the display name for an item. + */ + fieldCaption?: string; + + /** Applies filter to the field members. + * @Default {null} + */ + filterItems?: DataSourceFiltersFilterItems; + } + + export interface DataSourcePagerOptions { + + /** Allows to set the number of categorical columns to be displayed in each page on applying paging. + * @Default {0} + */ + categoricalPageSize?: number; + + /** Allows to set the number of series rows to be displayed in each page on applying paging. + * @Default {0} + */ + seriesPageSize?: number; + + /** Allows to set the page number in categorical axis to be loaded by default. + * @Default {1} + */ + categoricalCurrentPage?: number; + + /** Allows to set the page number in series axis to be loaded by default. + * @Default {1} + */ + seriesCurrentPage?: number; + } + + export interface DataSource { + + /** Lists out the items to be arranged in columns section of PivotClient. + * @Default {[]} + */ + columns?: DataSourceColumn[]; + + /** Lists out the items to be arranged in rows section of PivotClient. + * @Default {[]} + */ + rows?: DataSourceRow[]; + + /** Lists out the items which supports calculation in PivotClient. + * @Default {[]} + */ + values?: DataSourceValue[]; + + /** Lists out the items which supports filtering of values without displaying the members in UI in PivotClient. + * @Default {[]} + */ + filters?: DataSourceFilter[]; + + /** Contains the respective cube name from OLAP database as string type. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + cube?: string; + + /** Provides the raw data source for the PivotClient. + * @Default {null} + */ + data?: any; + + /** In connection with an OLAP database, this property contains the database name as string to fetch the data from the given connection string. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + catalog?: string; + + /** Allows user to filter the members (by its name and values) through advanced filtering (excel-like) option in client-mode. + * @Default {false} + */ + enableAdvancedFilter?: boolean; + + /** Sets a name to the report bound to the control. + */ + reportName?: string; + + /** Allows to set the page size and current page number for each axis on applying paging. + * @Default {{}} + */ + pagerOptions?: DataSourcePagerOptions; + } + + export interface DisplaySettings { + + /** Lets the user to customize the display of PivotChart and PivotGrid widgets, either in tabs or tiles. + * @Default {ej.PivotClient.ControlPlacement.Tab} + */ + controlPlacement?: ej.PivotClient.ControlPlacement | string; + + /** Lets the user to set either Chart or Grid as the start-up widget. + * @Default {ej.PivotClient.DefaultView.Grid} + */ + defaultView?: ej.PivotClient.DefaultView | string; + + /** Lets the user to have an option for switching to full screen view of PivotChart and PivotGrid from default view in PivotClient. + * @Default {false} + */ + enableFullScreen?: boolean; + + /** Enables an option to enhance the space for PivotGrid and PivotChart by hiding Cube Browser and Axis Element Builder. + * @Default {false} + */ + enableTogglePanel?: boolean; + + /** Sets the display mode (Only Chart/Only Grid/Both) in PivotClient. + * @Default {ej.PivotClient.DisplayMode.ChartAndGrid} + */ + mode?: ej.PivotClient.DisplayMode | string; + } + + export interface ServiceMethodSettings { + + /** Allows the user to set the custom name for the service method responsible for updating the entire report and widget, while changing the Cube. + * @Default {CubeChanged} + */ + cubeChanged?: string; + + /** Allows the user to set the custom name for the service method responsible for exporting. + * @Default {Export} + */ + exportPivotClient?: string; + + /** Allows the user to set the custom name for the service method responsible to get the members for the tree-view, inside member-editor dialog. + * @Default {FetchMemberTreeNodes} + */ + fetchMemberTreeNodes?: string; + + /** Allows the user to set the custom name for the service method responsible for fetching the report names from the database. + * @Default {FetchReportListFromDB} + */ + fetchReportList?: string; + + /** Allows the user to set the custom name for the service method responsible for updating report while filtering members. + * @Default {FilterElement} + */ + filterElement?: string; + + /** Allows the user to set the custom name for the service method responsible for initializing PivotClient. + * @Default {InitializeClient} + */ + initialize?: string; + + /** Allows the user to set the custom name for the service method responsible for loading a report collection from the database. + * @Default {LoadReportFromDB} + */ + loadReport?: string; - /** Allows the user to set the custom name for the service method responsible for retrieving the MDX query for the current report. - * @Default {GetMDXQuery} - */ - mdxQuery?: string; + /** Allows the user to set the custom name for the service method responsible for retrieving the MDX query for the current report. + * @Default {GetMDXQuery} + */ + mdxQuery?: string; - /** Allows the user to set the custom name for the service method responsible for updating the tree-view inside Cube Browser, while changing the measure group. - * @Default {MeasureGroupChanged} - */ - measureGroupChanged?: string; + /** Allows the user to set the custom name for the service method responsible for updating the tree-view inside Cube Browser, while changing the measure group. + * @Default {MeasureGroupChanged} + */ + measureGroupChanged?: string; - /** Allows the user to set the custom name for the service method responsible to get the child members, on tree-view node expansion. - * @Default {MemberExpanded} - */ - memberExpand?: string; + /** Allows the user to set the custom name for the service method responsible to get the child members, on tree-view node expansion. + * @Default {MemberExpanded} + */ + memberExpand?: string; - /** Allows the user to set the custom name for the service method responsible for updating report while dropping a node/SplitButton inside Axis Element Builder. - * @Default {NodeDropped} - */ - nodeDropped?: string; + /** Allows the user to set the custom name for the service method responsible for updating report while dropping a node/SplitButton inside Axis Element Builder. + * @Default {NodeDropped} + */ + nodeDropped?: string; - /** Allows the user to set the custom name for the service method responsible for updating report while removing SplitButton from Axis Element Builder. - * @Default {RemoveSplitButton} - */ - removeSplitButton?: string; + /** Allows the user to set the custom name for the service method responsible for updating report while removing SplitButton from Axis Element Builder. + * @Default {RemoveSplitButton} + */ + removeSplitButton?: string; - /** Allows the user to set the custom name for the service method responsible for saving the report collection to database. - * @Default {SaveReportToDB} - */ - saveReport?: string; - - /** Allows the user to set the custom name for the service method responsible for toggling the elements in row and column axes. - * @Default {ToggleAxis} - */ - toggleAxis?: string; + /** Allows the user to set the custom name for the service method responsible for saving the report collection to database. + * @Default {SaveReportToDB} + */ + saveReport?: string; + + /** Allows the user to set the custom name for the service method responsible for toggling the elements in row and column axes. + * @Default {ToggleAxis} + */ + toggleAxis?: string; - /** Allows the user to set the custom name for the service method responsible for all the toolbar operations. - * @Default {ToolbarOperations} - */ - toolbarServices?: string; - - /** Allows the user to set the custom name for the service method responsible for updating report collection. - * @Default {UpdateReport} - */ - updateReport?: string; - - /** Allows the user to set the custom name for the service method responsible on navigating between pages in paged PivotClient. - * @Default {Paging} - */ - paging?: string; -} - -enum ClientExportMode { - - ///Exports both the PivotChart and PivotGrid on exporting. - ChartAndGrid, - - ///Exports the PivotChart control alone on exporting. - ChartOnly, - - ///Exports the PivotGrid control alone on exporting. - GridOnly -} - - -enum ControlPlacement { - - ///Displays PivotChart and PivotGrid widgets in separate tabs. - Tab, - - ///Displays PivotChart and PivotGrid widgets one above the other. - Tile -} - - -enum DefaultView { - - ///To set PivotChart as a default control in view. - Chart, - - ///To set PivotGrid as a default control in view. - Grid -} - - -enum DisplayMode { - - ///To display only PivotChart widget. - ChartOnly, - - ///To display only PivotGrid widget. - GridOnly, - - ///To display both PivotChart and PivotGrid widgets. - ChartAndGrid -} - -} - -class PivotGauge extends ej.Widget { - static fn: PivotGauge; - constructor(element: JQuery | Element, options?: PivotGauge.Model); - static Locale: any; - model: PivotGauge.Model; - defaults: PivotGauge.Model; - - /** Performs an asynchronous HTTP (AJAX) request. - * @returns {void} - */ - doAjaxPost(): void; - - /** This function is used to refresh the PivotGauge at client-side itself. - * @returns {void} - */ - refresh(): void; - - /** This function removes the KPI related images from PivotGauge on binding OLAP datasource. - * @returns {void} - */ - removeImg(): void; - - /** This function receives the JSON formatted datasource and renders the PivotGauge control. - * @returns {void} - */ - renderControlFromJSON(): void; - - /** Returns the OlapReport string maintained along with the axis elements information. - * @returns {string} - */ - getOlapReport(): string; - - /** Sets the OlapReport string along with the axis information and maintains it in a property. - * @returns {void} - */ - setOlapReport(): void; - - /** Returns the JSON records formed to render the control. - * @returns {Array} - */ - getJSONRecords(): any[]; - - /** Sets the JSON records to render the control. - * @returns {void} - */ - setJSONRecords(): void; + /** Allows the user to set the custom name for the service method responsible for all the toolbar operations. + * @Default {ToolbarOperations} + */ + toolbarServices?: string; + + /** Allows the user to set the custom name for the service method responsible for updating report collection. + * @Default {UpdateReport} + */ + updateReport?: string; + + /** Allows the user to set the custom name for the service method responsible on navigating between pages in paged PivotClient. + * @Default {Paging} + */ + paging?: string; + } + + enum ClientExportMode { + + ///Exports both the PivotChart and PivotGrid on exporting. + ChartAndGrid, + + ///Exports the PivotChart control alone on exporting. + ChartOnly, + + ///Exports the PivotGrid control alone on exporting. + GridOnly + } + + + enum ControlPlacement { + + ///Displays PivotChart and PivotGrid widgets in separate tabs. + Tab, + + ///Displays PivotChart and PivotGrid widgets one above the other. + Tile + } + + + enum DefaultView { + + ///To set PivotChart as a default control in view. + Chart, + + ///To set PivotGrid as a default control in view. + Grid + } + + + enum DisplayMode { + + ///To display only PivotChart widget. + ChartOnly, + + ///To display only PivotGrid widget. + GridOnly, + + ///To display both PivotChart and PivotGrid widgets. + ChartAndGrid + } + + } + + class PivotGauge extends ej.Widget { + static fn: PivotGauge; + constructor(element: JQuery | Element, options?: PivotGauge.Model); + static Locale: any; + model: PivotGauge.Model; + defaults: PivotGauge.Model; + + /** Performs an asynchronous HTTP (AJAX) request. + * @returns {void} + */ + doAjaxPost(): void; + + /** This function is used to refresh the PivotGauge at client-side itself. + * @returns {void} + */ + refresh(): void; + + /** This function removes the KPI related images from PivotGauge on binding OLAP datasource. + * @returns {void} + */ + removeImg(): void; + + /** This function receives the JSON formatted datasource and renders the PivotGauge control. + * @returns {void} + */ + renderControlFromJSON(): void; + + /** Returns the OlapReport string maintained along with the axis elements information. + * @returns {string} + */ + getOlapReport(): string; + + /** Sets the OlapReport string along with the axis information and maintains it in a property. + * @returns {void} + */ + setOlapReport(): void; + + /** Returns the JSON records formed to render the control. + * @returns {Array} + */ + getJSONRecords(): any[]; + + /** Sets the JSON records to render the control. + * @returns {void} + */ + setJSONRecords(): void; - /** Returns the JSON records required to render the PivotGauge on performing any action with OLAP data source. - * @returns {void} - */ - getJSONData(): void; -} -export namespace PivotGauge { + /** Returns the JSON records required to render the PivotGauge on performing any action with OLAP data source. + * @returns {void} + */ + getJSONData(): void; + } + export namespace PivotGauge { -export interface Model { + export interface Model { - /** Sets the number of columns to arrange the Pivot Gauges. - * @Default {0} - */ - columnsCount?: number; + /** Sets the number of columns to arrange the Pivot Gauges. + * @Default {0} + */ + columnsCount?: number; - /** Specifies the CSS class to PivotGauge to achieve custom theme. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - cssClass?: string; + /** Specifies the CSS class to PivotGauge to achieve custom theme. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + cssClass?: string; - /** Object utilized to pass additional information between client-end and service-end on operating in server mode. - * @Default {{}} - */ - customObject?: any; - - /** Initializes the data source for the PivotGauge widget, when it functions completely on client-side. - * @Default {{}} - */ - dataSource?: DataSource; - - /** Enables/disables the animation of pointer in PivotGauge. - * @Default {false} - */ - enableAnimation?: boolean; - - /** Enables/disables tooltip visibility in PivotGauge. - * @Default {false} - */ - enableTooltip?: boolean; - - /** Allows the user to view PivotGauge from right to left. - * @Default {false} - */ - enableRTL?: boolean; - - /** Allows the user to enable PivotGaugeĂ¢â‚¬â„¢s responsiveness in the browser layout. - * @Default {false} - */ - isResponsive?: boolean; - - /** Allows the user to change the format of the label values in PivotGauge. - * @Default {null} - */ - labelFormatSettings?: LabelFormatSettings; - - /** Allows the user to set the localized language for the widget. - * @Default {en-US} - */ - locale?: string; - - /** Sets the number of rows to arrange the Pivot Gauges. - * @Default {0} - */ - rowsCount?: number; - - /** Sets the scale values such as pointers, indicators, etc... for PivotGauge. - * @Default {{}} - */ - scales?: any; - - /** Allows the user to set the custom name for the methods at service-end, communicated during AJAX post. - * @Default {{}} - */ - serviceMethodSettings?: ServiceMethodSettings; - - /** Enables/disables the header labels in PivotGauge. - * @Default {true} - */ - showHeaderLabel?: boolean; - - /** Connects the service using the specified URL for any server updates on server mode operation. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - url?: string; - - /** Sets the mode for the PivotGauge widget for binding either OLAP or Relational data source. - * @Default {ej.Pivot.AnalysisMode.Pivot} - */ - analysisMode?: ej.Pivot.AnalysisMode|string; - - /** Sets the mode for the PivotGauge widget for binding data source either in server-side or client-side. - * @Default {ej.Pivot.OperationalMode.ClientMode} - */ - operationalMode?: ej.Pivot.OperationalMode|string; - - /** Triggers when it reaches client-side after any AJAX request. */ - afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; - - /** Triggers before any AJAX request is passed from PivotGauge to service methods. */ - beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; - - /** Triggers before populating the pivot engine on operating in client mode. */ - beforePivotEnginePopulate?(e: BeforePivotEnginePopulateEventArgs): void; + /** Object utilized to pass additional information between client-end and service-end on operating in server mode. + * @Default {{}} + */ + customObject?: any; + + /** Initializes the data source for the PivotGauge widget, when it functions completely on client-side. + * @Default {{}} + */ + dataSource?: DataSource; + + /** Enables/disables the animation of pointer in PivotGauge. + * @Default {false} + */ + enableAnimation?: boolean; + + /** Enables/disables tooltip visibility in PivotGauge. + * @Default {false} + */ + enableTooltip?: boolean; + + /** Allows the user to view PivotGauge from right to left. + * @Default {false} + */ + enableRTL?: boolean; + + /** Allows the user to enable PivotGaugeĂ¢â‚¬â„¢s responsiveness in the browser layout. + * @Default {false} + */ + isResponsive?: boolean; + + /** Allows the user to change the format of the label values in PivotGauge. + * @Default {null} + */ + labelFormatSettings?: LabelFormatSettings; + + /** Allows the user to set the localized language for the widget. + * @Default {en-US} + */ + locale?: string; + + /** Sets the number of rows to arrange the Pivot Gauges. + * @Default {0} + */ + rowsCount?: number; + + /** Sets the scale values such as pointers, indicators, etc... for PivotGauge. + * @Default {{}} + */ + scales?: any; + + /** Allows the user to set the custom name for the methods at service-end, communicated during AJAX post. + * @Default {{}} + */ + serviceMethodSettings?: ServiceMethodSettings; + + /** Enables/disables the header labels in PivotGauge. + * @Default {true} + */ + showHeaderLabel?: boolean; + + /** Connects the service using the specified URL for any server updates on server mode operation. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + url?: string; + + /** Sets the mode for the PivotGauge widget for binding either OLAP or Relational data source. + * @Default {ej.Pivot.AnalysisMode.Pivot} + */ + analysisMode?: ej.Pivot.AnalysisMode | string; + + /** Sets the mode for the PivotGauge widget for binding data source either in server-side or client-side. + * @Default {ej.Pivot.OperationalMode.ClientMode} + */ + operationalMode?: ej.Pivot.OperationalMode | string; + + /** Triggers when it reaches client-side after any AJAX request. */ + afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; + + /** Triggers before any AJAX request is passed from PivotGauge to service methods. */ + beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; + + /** Triggers before populating the pivot engine on operating in client mode. */ + beforePivotEnginePopulate?(e: BeforePivotEnginePopulateEventArgs): void; - /** Triggers when PivotGauge started loading at client-side. */ - load?(e: LoadEventArgs): void; + /** Triggers when PivotGauge started loading at client-side. */ + load?(e: LoadEventArgs): void; - /** Triggers when PivotGauge widget completes all operations at client-side after any AJAX request. */ - renderComplete?(e: RenderCompleteEventArgs): void; + /** Triggers when PivotGauge widget completes all operations at client-side after any AJAX request. */ + renderComplete?(e: RenderCompleteEventArgs): void; - /** Triggers when any error occurred during AJAX request. */ - renderFailure?(e: RenderFailureEventArgs): void; - - /** Triggers when PivotGauge successfully reaches client-side after any AJAX request. */ - renderSuccess?(e: RenderSuccessEventArgs): void; -} + /** Triggers when any error occurred during AJAX request. */ + renderFailure?(e: RenderFailureEventArgs): void; + + /** Triggers when PivotGauge successfully reaches client-side after any AJAX request. */ + renderSuccess?(e: RenderSuccessEventArgs): void; + } -export interface AfterServiceInvokeEventArgs { + export interface AfterServiceInvokeEventArgs { - /** returns the custom object bound with PivotGauge control. - */ - customObject?: any; + /** returns the custom object bound with PivotGauge control. + */ + customObject?: any; - /** returns the HTML element of PivotGauge control. - */ - element?: any; -} + /** returns the HTML element of PivotGauge control. + */ + element?: any; + } -export interface BeforeServiceInvokeEventArgs { + export interface BeforeServiceInvokeEventArgs { - /** returns the custom object bound with PivotGauge control. - */ - customObject?: any; + /** returns the custom object bound with PivotGauge control. + */ + customObject?: any; - /** returns the HTML element of PivotGauge control. - */ - element?: any; -} + /** returns the HTML element of PivotGauge control. + */ + element?: any; + } -export interface BeforePivotEnginePopulateEventArgs { + export interface BeforePivotEnginePopulateEventArgs { - /** returns the current instance of PivotGauge control. - */ - gaugeObject?: any; -} + /** returns the current instance of PivotGauge control. + */ + gaugeObject?: any; + } -export interface LoadEventArgs { + export interface LoadEventArgs { - /** returns the current action of PivotGauge control. - */ - action?: string; + /** returns the current action of PivotGauge control. + */ + action?: string; - /** returns the model of PivotGauge control. - */ - model?: any; + /** returns the model of PivotGauge control. + */ + model?: any; - /** returns the HTML element of the widget. - */ - element?: any; + /** returns the HTML element of the widget. + */ + element?: any; - /** returns the custom object bound to the control. - */ - customObject?: any; -} + /** returns the custom object bound to the control. + */ + customObject?: any; + } -export interface RenderCompleteEventArgs { + export interface RenderCompleteEventArgs { - /** returns the custom object bound with PivotGauge control. - */ - customObject?: any; + /** returns the custom object bound with PivotGauge control. + */ + customObject?: any; - /** returns the HTML element of PivotGauge control. - */ - element?: any; -} + /** returns the HTML element of PivotGauge control. + */ + element?: any; + } -export interface RenderFailureEventArgs { + export interface RenderFailureEventArgs { - /** returns the HTML element of PivotGauge control. - */ - element?: any; + /** returns the HTML element of PivotGauge control. + */ + element?: any; - /** returns the custom object bound with the control. - */ - customObject?: any; + /** returns the custom object bound with the control. + */ + customObject?: any; - /** returns the error message with error code. - */ - message?: string; -} + /** returns the error message with error code. + */ + message?: string; + } -export interface RenderSuccessEventArgs { + export interface RenderSuccessEventArgs { - /** returns the HTML element of PivotGauge control. - */ - element?: any; + /** returns the HTML element of PivotGauge control. + */ + element?: any; - /** returns the custom object bound with the control. - */ - customObject?: any; -} + /** returns the custom object bound with the control. + */ + customObject?: any; + } -export interface DataSourceColumnsFilterItems { + export interface DataSourceColumnsFilterItems { - /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ - filterType?: ej.PivotAnalysis.FilterType|string; + /** Sets the type of filter whether to include/exclude the mentioned values. + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ + filterType?: ej.PivotAnalysis.FilterType | string; - /** Contains the collection of items to be included/excluded among the field members. - * @Default {[]} - */ - values?: any[]; -} + /** Contains the collection of items to be included/excluded among the field members. + * @Default {[]} + */ + values?: any[]; + } -export interface DataSourceColumn { + export interface DataSourceColumn { - /** Allows the user to bind the item by using its unique name as field name. - */ - fieldName?: string; + /** Allows the user to bind the item by using its unique name as field name. + */ + fieldName?: string; - /** Applies filter to the field members. - * @Default {null} - */ - filterItems?: DataSourceColumnsFilterItems; -} + /** Applies filter to the field members. + * @Default {null} + */ + filterItems?: DataSourceColumnsFilterItems; + } -export interface DataSourceRowsFilterItems { + export interface DataSourceRowsFilterItems { - /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ - filterType?: ej.PivotAnalysis.FilterType|string; + /** Sets the type of filter whether to include/exclude the mentioned values. + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ + filterType?: ej.PivotAnalysis.FilterType | string; - /** Contains the collection of items to be included/excluded among the field members. - * @Default {[]} - */ - values?: any[]; -} - -export interface DataSourceRow { - - /** Allows the user to bind the item by using its unique name as field name. - */ - fieldName?: string; + /** Contains the collection of items to be included/excluded among the field members. + * @Default {[]} + */ + values?: any[]; + } + + export interface DataSourceRow { + + /** Allows the user to bind the item by using its unique name as field name. + */ + fieldName?: string; - /** Applies filter to the field members. - * @Default {null} - */ - filterItems?: DataSourceRowsFilterItems; -} - -export interface DataSourceValuesMeasure { - - /** Allows the user to bind the measure from OLAP datasource by using its unique name as field name. - */ - fieldName?: string; -} - -export interface DataSourceValue { - - /** Allows the user to bind the item by using its unique name as field name for Relational datasource. - */ - fieldName?: string; - - /** Allows the user to set the display caption for an item for Relational datasource. - */ - fieldCaption?: string; - - /** This holds the list of unique names of measures to bind them from the OLAP cube. - * @Default {[]} - */ - measures?: DataSourceValuesMeasure[]; - - /** Allows to set the axis name to place the measures items. - * @Default {rows} - */ - axis?: string; - - /** Indicates whether the field is a calculated field or not with Relational datasource. - * @Default {false} - */ - isCalculatedField?: boolean; - - /** Allows to set the formula for calculation of values for calculated members in Relational datasource. - */ - formula?: string; -} - -export interface DataSourceFiltersFilterItems { - - /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ - filterType?: ej.PivotAnalysis.FilterType|string; - - /** Contains the collection of items to be included/excluded among the field members. - * @Default {[]} - */ - values?: any[]; -} + /** Applies filter to the field members. + * @Default {null} + */ + filterItems?: DataSourceRowsFilterItems; + } + + export interface DataSourceValuesMeasure { + + /** Allows the user to bind the measure from OLAP datasource by using its unique name as field name. + */ + fieldName?: string; + } + + export interface DataSourceValue { + + /** Allows the user to bind the item by using its unique name as field name for Relational datasource. + */ + fieldName?: string; + + /** Allows the user to set the display caption for an item for Relational datasource. + */ + fieldCaption?: string; + + /** This holds the list of unique names of measures to bind them from the OLAP cube. + * @Default {[]} + */ + measures?: DataSourceValuesMeasure[]; + + /** Allows to set the axis name to place the measures items. + * @Default {rows} + */ + axis?: string; + + /** Indicates whether the field is a calculated field or not with Relational datasource. + * @Default {false} + */ + isCalculatedField?: boolean; + + /** Allows to set the formula for calculation of values for calculated members in Relational datasource. + */ + formula?: string; + } + + export interface DataSourceFiltersFilterItems { + + /** Sets the type of filter whether to include/exclude the mentioned values. + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ + filterType?: ej.PivotAnalysis.FilterType | string; + + /** Contains the collection of items to be included/excluded among the field members. + * @Default {[]} + */ + values?: any[]; + } -export interface DataSourceFilter { - - /** Allows the user to bind the item by using its unique name as field name. - */ - fieldName?: string; + export interface DataSourceFilter { + + /** Allows the user to bind the item by using its unique name as field name. + */ + fieldName?: string; - /** Applies filter to the field members. - * @Default {null} - */ - filterItems?: DataSourceFiltersFilterItems; -} + /** Applies filter to the field members. + * @Default {null} + */ + filterItems?: DataSourceFiltersFilterItems; + } -export interface DataSource { - - /** Contains the respective cube name from OLAP database as string type. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - cube?: string; - - /** Provides the raw data source for the PivotGauge. - * @Default {null} - */ - data?: any; - - /** In connection with an OLAP database, this property contains the database name as string to fetch the data from the given connection string. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - catalog?: string; - - /** Lists out the items to bind in columns section. - * @Default {[]} - */ - columns?: DataSourceColumn[]; - - /** Lists out the items to bind in rows section. - * @Default {[]} - */ - rows?: DataSourceRow[]; - - /** Lists out the items supports calculation in PivotGauge. - * @Default {[]} - */ - values?: DataSourceValue[]; - - /** Lists out the items which supports filtering of values without displaying the members in UI in PivotGauge. - * @Default {[]} - */ - filters?: DataSourceFilter[]; -} - -export interface LabelFormatSettings { - - /** Allows the user to change the number format of the label values in PivotGauge. - * @Default {ej.PivotGauge.NumberFormat.Default} - */ - numberFormat?: ej.PivotGauge.NumberFormat|string; - - /** Allows you to set the number of digits displayed after decimal point. - * @Default {5} - */ - decimalPlaces?: number; - - /** Allows you to add a text at the beginning of the label. - */ - prefixText?: string; - - /** Allows you to add text at the end of the label. - */ - suffixText?: string; -} - -export interface ServiceMethodSettings { - - /** Allows the user to set the custom name for the service method responsible for initializing PivotGauge. - * @Default {InitializeGauge} - */ - initialize?: string; -} - -enum NumberFormat { - - ///To set default format for label values. - Default, - - ///To set currency format for label values. - Currency, - - ///To set percentage format for label values. - Percentage, - - ///To set fraction format for label values. - Fraction, - - ///To set scientific format for label values. - Scientific, - - ///To set text format for label values. - Text, - - ///To set notation format for label values. - Notation -} - -} - -class PivotTreeMap extends ej.Widget { - static fn: PivotTreeMap; - constructor(element: JQuery | Element, options?: PivotTreeMap.Model); - static Locale: any; - model: PivotTreeMap.Model; - defaults: PivotTreeMap.Model; - - /** Performs an asynchronous HTTP (AJAX) request. - * @returns {void} - */ - doAjaxPost(): void; - - /** Returns the OlapReport string maintained along with the axis elements information. - * @returns {string} - */ - getOlapReport(): string; - - /** Sets the OlapReport string along with the axis information and maintains it in a property. - * @returns {void} - */ - setOlapReport(): void; - - /** Returns the JSON records formed to render the control. - * @returns {Array} - */ - getJSONRecords(): any[]; - - /** Sets the JSON records to render the control. - * @returns {void} - */ - setJSONRecords(): void; - - /** Renders the control with the pivot engine obtained from OLAP cube. - * @returns {void} - */ - generateJSON(): void; + export interface DataSource { + + /** Contains the respective cube name from OLAP database as string type. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + cube?: string; + + /** Provides the raw data source for the PivotGauge. + * @Default {null} + */ + data?: any; + + /** In connection with an OLAP database, this property contains the database name as string to fetch the data from the given connection string. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + catalog?: string; + + /** Lists out the items to bind in columns section. + * @Default {[]} + */ + columns?: DataSourceColumn[]; + + /** Lists out the items to bind in rows section. + * @Default {[]} + */ + rows?: DataSourceRow[]; + + /** Lists out the items supports calculation in PivotGauge. + * @Default {[]} + */ + values?: DataSourceValue[]; + + /** Lists out the items which supports filtering of values without displaying the members in UI in PivotGauge. + * @Default {[]} + */ + filters?: DataSourceFilter[]; + } + + export interface LabelFormatSettings { + + /** Allows the user to change the number format of the label values in PivotGauge. + * @Default {ej.PivotGauge.NumberFormat.Default} + */ + numberFormat?: ej.PivotGauge.NumberFormat | string; + + /** Allows you to set the number of digits displayed after decimal point. + * @Default {5} + */ + decimalPlaces?: number; + + /** Allows you to add a text at the beginning of the label. + */ + prefixText?: string; + + /** Allows you to add text at the end of the label. + */ + suffixText?: string; + } + + export interface ServiceMethodSettings { + + /** Allows the user to set the custom name for the service method responsible for initializing PivotGauge. + * @Default {InitializeGauge} + */ + initialize?: string; + } + + enum NumberFormat { + + ///To set default format for label values. + Default, + + ///To set currency format for label values. + Currency, + + ///To set percentage format for label values. + Percentage, + + ///To set fraction format for label values. + Fraction, + + ///To set scientific format for label values. + Scientific, + + ///To set text format for label values. + Text, + + ///To set notation format for label values. + Notation + } + + } + + class PivotTreeMap extends ej.Widget { + static fn: PivotTreeMap; + constructor(element: JQuery | Element, options?: PivotTreeMap.Model); + static Locale: any; + model: PivotTreeMap.Model; + defaults: PivotTreeMap.Model; + + /** Performs an asynchronous HTTP (AJAX) request. + * @returns {void} + */ + doAjaxPost(): void; + + /** Returns the OlapReport string maintained along with the axis elements information. + * @returns {string} + */ + getOlapReport(): string; + + /** Sets the OlapReport string along with the axis information and maintains it in a property. + * @returns {void} + */ + setOlapReport(): void; + + /** Returns the JSON records formed to render the control. + * @returns {Array} + */ + getJSONRecords(): any[]; + + /** Sets the JSON records to render the control. + * @returns {void} + */ + setJSONRecords(): void; + + /** Renders the control with the pivot engine obtained from OLAP cube. + * @returns {void} + */ + generateJSON(): void; - /** This function receives the JSON formatted datasource to render the PivotTreeMap control. - * @returns {void} - */ - renderTreeMapFromJSON(): void; + /** This function receives the JSON formatted datasource to render the PivotTreeMap control. + * @returns {void} + */ + renderTreeMapFromJSON(): void; - /** This function receives the update from service-end, which would be utilized for rendering the widget. - * @returns {void} - */ - renderControlSuccess(): void; -} -export namespace PivotTreeMap { + /** This function receives the update from service-end, which would be utilized for rendering the widget. + * @returns {void} + */ + renderControlSuccess(): void; + } + export namespace PivotTreeMap { -export interface Model { + export interface Model { - /** Specifies the CSS class to PivotTreeMap to achieve custom theme. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - cssClass?: string; + /** Specifies the CSS class to PivotTreeMap to achieve custom theme. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + cssClass?: string; - /** Initializes the data source for the PivotTreeMap widget, when it functions completely on client-side. - * @Default {{}} - */ - dataSource?: DataSource; + /** Initializes the data source for the PivotTreeMap widget, when it functions completely on client-side. + * @Default {{}} + */ + dataSource?: DataSource; - /** Object utilized to pass additional information between client-end and service-end. - * @Default {{}} - */ - customObject?: any; + /** Object utilized to pass additional information between client-end and service-end. + * @Default {{}} + */ + customObject?: any; - /** Allows the user to enable PivotTreeMapĂ¢â‚¬â„¢s responsiveness in the browser layout. - * @Default {false} - */ - isResponsive?: boolean; + /** Allows the user to enable PivotTreeMapĂ¢â‚¬â„¢s responsiveness in the browser layout. + * @Default {false} + */ + isResponsive?: boolean; - /** Allows the user to set the localized language for the widget. - * @Default {en-US} - */ - locale?: string; + /** Allows the user to set the localized language for the widget. + * @Default {en-US} + */ + locale?: string; - /** Sets the mode for the PivotTreeMap widget for binding data source either in server-side or client-side. - * @Default {ej.Pivot.OperationalMode.ClientMode} - */ - operationalMode?: ej.Pivot.OperationalMode|string; + /** Sets the mode for the PivotTreeMap widget for binding data source either in server-side or client-side. + * @Default {ej.Pivot.OperationalMode.ClientMode} + */ + operationalMode?: ej.Pivot.OperationalMode | string; - /** Allows the user to set custom name for the methods at service-end, communicated on AJAX post. - * @Default {{}} - */ - serviceMethodSettings?: ServiceMethodSettings; + /** Allows the user to set custom name for the methods at service-end, communicated on AJAX post. + * @Default {{}} + */ + serviceMethodSettings?: ServiceMethodSettings; - /** Connects the service using the specified URL for any server updates. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - url?: string; + /** Connects the service using the specified URL for any server updates. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + url?: string; - /** Triggers when it reaches client-side after any AJAX request. */ - afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; + /** Triggers when it reaches client-side after any AJAX request. */ + afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; - /** Triggers before any AJAX request is passed from PivotTreeMap to service methods. */ - beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; + /** Triggers before any AJAX request is passed from PivotTreeMap to service methods. */ + beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; - /** Triggers when PivotTreeMap starts to render. */ - load?(e: LoadEventArgs): void; + /** Triggers when PivotTreeMap starts to render. */ + load?(e: LoadEventArgs): void; - /** Triggers before populating the pivot engine from datasource. */ - beforePivotEnginePopulate?(e: BeforePivotEnginePopulateEventArgs): void; - - /** Triggers when drill up/down happens in PivotTreeMap control. And it returns the outer HTML of PivotTreeMap control. */ - drillSuccess?(e: DrillSuccessEventArgs): void; + /** Triggers before populating the pivot engine from datasource. */ + beforePivotEnginePopulate?(e: BeforePivotEnginePopulateEventArgs): void; + + /** Triggers when drill up/down happens in PivotTreeMap control. And it returns the outer HTML of PivotTreeMap control. */ + drillSuccess?(e: DrillSuccessEventArgs): void; - /** Triggers when PivotTreeMap widget completes all operations at client-side after any AJAX request. */ - renderComplete?(e: RenderCompleteEventArgs): void; + /** Triggers when PivotTreeMap widget completes all operations at client-side after any AJAX request. */ + renderComplete?(e: RenderCompleteEventArgs): void; - /** Triggers when any error occurred during AJAX request. */ - renderFailure?(e: RenderFailureEventArgs): void; + /** Triggers when any error occurred during AJAX request. */ + renderFailure?(e: RenderFailureEventArgs): void; - /** Triggers when PivotTreeMap successfully reaches client-side after any AJAX request. */ - renderSuccess?(e: RenderSuccessEventArgs): void; -} + /** Triggers when PivotTreeMap successfully reaches client-side after any AJAX request. */ + renderSuccess?(e: RenderSuccessEventArgs): void; + } -export interface AfterServiceInvokeEventArgs { + export interface AfterServiceInvokeEventArgs { - /** returns the current action of PivotTreeMap control. - */ - action?: string; + /** returns the current action of PivotTreeMap control. + */ + action?: string; - /** returns the custom object bound with PivotTreeMap control. - */ - customObject?: any; + /** returns the custom object bound with PivotTreeMap control. + */ + customObject?: any; - /** returns the HTML element of PivotTreeMap control. - */ - element?: any; -} + /** returns the HTML element of PivotTreeMap control. + */ + element?: any; + } -export interface BeforeServiceInvokeEventArgs { + export interface BeforeServiceInvokeEventArgs { - /** returns the current action of PivotTreeMap control. - */ - action?: string; + /** returns the current action of PivotTreeMap control. + */ + action?: string; - /** returns the custom object bound with PivotTreeMap control. - */ - customObject?: any; + /** returns the custom object bound with PivotTreeMap control. + */ + customObject?: any; - /** returns the HTML element of PivotTreeMap control. - */ - element?: any; -} + /** returns the HTML element of PivotTreeMap control. + */ + element?: any; + } -export interface LoadEventArgs { + export interface LoadEventArgs { - /** returns the current action of PivotTreeMap control. - */ - action?: string; + /** returns the current action of PivotTreeMap control. + */ + action?: string; - /** returns the custom object bound with PivotTreeMap control. - */ - customObject?: any; + /** returns the custom object bound with PivotTreeMap control. + */ + customObject?: any; - /** returns the HTML element of PivotTreeMap control. - */ - element?: any; -} + /** returns the HTML element of PivotTreeMap control. + */ + element?: any; + } -export interface BeforePivotEnginePopulateEventArgs { + export interface BeforePivotEnginePopulateEventArgs { - /** returns the current instance of PivotTreeMap control. - */ - treeMapObject?: any; -} + /** returns the current instance of PivotTreeMap control. + */ + treeMapObject?: any; + } -export interface DrillSuccessEventArgs { + export interface DrillSuccessEventArgs { - /** return the HTML element of PivotTreeMap control. - */ - element?: any; -} + /** return the HTML element of PivotTreeMap control. + */ + element?: any; + } -export interface RenderCompleteEventArgs { + export interface RenderCompleteEventArgs { - /** returns the current action of PivotTreeMap control. - */ - action?: string; + /** returns the current action of PivotTreeMap control. + */ + action?: string; - /** returns the custom object bound with PivotTreeMap control. - */ - customObject?: any; + /** returns the custom object bound with PivotTreeMap control. + */ + customObject?: any; - /** returns the HTML element of PivotTreeMap control. - */ - element?: any; -} + /** returns the HTML element of PivotTreeMap control. + */ + element?: any; + } -export interface RenderFailureEventArgs { + export interface RenderFailureEventArgs { - /** returns the current action of PivotTreeMap control. - */ - action?: string; + /** returns the current action of PivotTreeMap control. + */ + action?: string; - /** returns the custom object bound with PivotTreeMap control. - */ - customObject?: any; + /** returns the custom object bound with PivotTreeMap control. + */ + customObject?: any; - /** returns the HTML element of PivotTreeMap control. - */ - element?: any; + /** returns the HTML element of PivotTreeMap control. + */ + element?: any; - /** returns the error stack trace of the original exception. - */ - message?: string; -} + /** returns the error stack trace of the original exception. + */ + message?: string; + } -export interface RenderSuccessEventArgs { + export interface RenderSuccessEventArgs { - /** returns the current action of PivotTreeMap control. - */ - action?: string; + /** returns the current action of PivotTreeMap control. + */ + action?: string; - /** returns the custom object bound with PivotTreeMap control. - */ - customObject?: any; + /** returns the custom object bound with PivotTreeMap control. + */ + customObject?: any; - /** returns the HTML element of PivotTreeMap control. - */ - element?: any; -} + /** returns the HTML element of PivotTreeMap control. + */ + element?: any; + } -export interface DataSourceColumnsFilterItems { + export interface DataSourceColumnsFilterItems { - /** Contains the collection of items to be excluded among the field members. - * @Default {[]} - */ - values?: any[]; -} + /** Contains the collection of items to be excluded among the field members. + * @Default {[]} + */ + values?: any[]; + } -export interface DataSourceColumn { + export interface DataSourceColumn { - /** Allows the user to bind the item by using its unique name as field name. - */ - fieldName?: string; + /** Allows the user to bind the item by using its unique name as field name. + */ + fieldName?: string; - /** Allows the user to indicate whether the added item is a named set or not. - * @Default {false} - */ - isNamedSets?: boolean; + /** Allows the user to indicate whether the added item is a named set or not. + * @Default {false} + */ + isNamedSets?: boolean; - /** Applies filter to the field members. - * @Default {null} - */ - filterItems?: DataSourceColumnsFilterItems; -} - -export interface DataSourceRowsFilterItems { - - /** Contains the collection of items to be excluded among the field members. - * @Default {[]} - */ - values?: any[]; -} - -export interface DataSourceRow { + /** Applies filter to the field members. + * @Default {null} + */ + filterItems?: DataSourceColumnsFilterItems; + } + + export interface DataSourceRowsFilterItems { + + /** Contains the collection of items to be excluded among the field members. + * @Default {[]} + */ + values?: any[]; + } + + export interface DataSourceRow { - /** Allows the user to bind the item by using its unique name as field name. - */ - fieldName?: string; - - /** Allows the user to indicate whether the added item is a named set or not. - * @Default {false} - */ - isNamedSets?: boolean; - - /** Applies filter to the field members. - * @Default {null} - */ - filterItems?: DataSourceRowsFilterItems; -} - -export interface DataSourceValuesMeasure { - - /** Allows the user to bind the measure from OLAP datasource by using its unique name as field name. - */ - fieldName?: string; -} - -export interface DataSourceValue { - - /** This holds the list of unique names of measures to bind them from the OLAP cube. - * @Default {[]} - */ - measures?: DataSourceValuesMeasure[]; - - /** Allows to set the axis name to place the measures items. - * @Default {rows} - */ - axis?: string; -} - -export interface DataSourceFiltersFilterItems { - - /** Contains the collection of items to be excluded among the field members. - * @Default {[]} - */ - values?: any[]; -} - -export interface DataSourceFilter { - - /** Allows the user to bind the item by using its unique name as field name. - */ - fieldName?: string; - - /** Applies filter to the field members. - * @Default {null} - */ - filterItems?: DataSourceFiltersFilterItems; -} - -export interface DataSource { - - /** Provides the raw data source for the PivotTreeMap. - * @Default {null} - */ - data?: any; - - /** Contains the respective cube name from OLAP database as string type. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - cube?: string; - - /** In connection with an OLAP database, this property contains the database name as string to fetch the data from the given connection string. - * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} - */ - catalog?: string; - - /** Lists out the items to be displayed as series of PivotTreeMap. - * @Default {[]} - */ - columns?: DataSourceColumn[]; - - /** Lists out the items to be displayed as segments of PivotTreeMap. - * @Default {[]} - */ - rows?: DataSourceRow[]; - - /** Lists out the items supports calculation in PivotTreeMap. - * @Default {[]} - */ - values?: DataSourceValue[]; - - /** Lists out the items which supports filtering of values without displaying the members in UI in PivotTreeMap. - * @Default {[]} - */ - filters?: DataSourceFilter[]; -} - -export interface ServiceMethodSettings { - - /** Allows the user to set the custom name for the service method responsible for initializing PivotTreeMap. - * @Default {InitializeTreemap} - */ - initialize?: string; - - /** Allows the user to set the custom name for the service method responsible for drilling up/down operation in PivotTreeMap. - * @Default {DrillTreeMap} - */ - drillDown?: string; -} -} - -class Schedule extends ej.Widget { - static fn: Schedule; - constructor(element: JQuery | Element, options?: Schedule.Model); - static Locale: any; - model: Schedule.Model; - defaults: Schedule.Model; - - /** This method is used to delete the appointment based on the guid value or the appointment data passed to it. - * @param {string|any} GUID value of an appointment element or an appointment object - * @returns {void} - */ - deleteAppointment(data: string|any): void; - - /** Destroys the Schedule widget. All the events bound using this._on are unbound automatically and the control is moved to pre-init state. - * @returns {void} - */ - destroy(): void; - - /** Exports the appointments from the Schedule control. - * @param {string} It refers the controller action name to redirect. (For MVC) - * @param {string} It refers the server event name.(For ASP) - * @param {string|number} Pass the id of an appointment, in case if a single appointment needs to be exported. Otherwise, it takes the null value. - * @returns {void} - */ - exportSchedule(action: string, serverEvent: string, id: string|number): void; - - /** Searches and filters the appointments from appointment list of Schedule control. - * @param {Array} Holds array of one or more conditional objects for filtering the appointments based on it. - * @returns {Array} - */ - filterAppointments(filterConditions: any[]): any[]; - - /** Gets the complete appointment list of Schedule control. - * @returns {Array} - */ - getAppointments(): any[]; - - /** Prints the entire Scheduler or a single appointment based on the appointment data passed as an argument to it. Simply calling the print() method, - * without passing any argument will print the entire Scheduler. - * @param {any} Either accepts no arguments at all or else accepts an appointment object. - * @returns {void} - */ - print(data: any): void; - - /** Refreshes the Scroller of Scheduler while using it within some other controls or application. - * @returns {void} - */ - refreshScroller(): void; - - /** It is used to save the appointment. The appointment object is based on the argument passed to this method. - * @param {any} appointment object which includes appointment details - * @returns {void} - */ - saveAppointment(appointmentObject: any): void; - - /** Generate the recurrence rule as a string, based on the repeat options selected. - * @returns {string} - */ - getRecurrenceRule(): string; - - /** Retrieves the time slot information (start/end time and resource details) of the given element. - * The parameter is optional - as when no element is passed to it, the currently selected cell information will be retrieved. When multiple cells are selected in the Scheduler, - * it is not necessary to provide the parameter. - * @param {any} TD element object rendered as Scheduler work cell - * @returns {any} - */ - getSlotByElement(element: any): any; - - /** Searches the appointments from the appointment list of Schedule control based on the provided search string in its argument list. - * @param {any|string} Defines the search word or the filter condition, based on which the appointments are filtered from the list. - * @param {string} Defines the field name on which the search is to be made. - * @param {ej.FilterOperators|string} Defines the filterOperator value for the search operation. - * @param {boolean} Defines the ignoreCase value for performing the search operation. - * @returns {Array} - */ - searchAppointments(searchString: any|string, field: string, operator: ej.FilterOperators|string, ignoreCase: boolean): any[]; - - /** Refreshes the entire Schedule control. - * @returns {void} - */ - refresh(): void; - - /** Refreshes only the appointment elements within the Schedule control. - * @returns {void} - */ - refreshAppointments(): void; - - /** Passes the server-side action and data to the client-side for rendering the modified appointment list on the Schedule control. - * @returns {void} - */ - notifyChanges(): void; -} -export namespace Schedule { - -export interface Model { - - /** When set to true, Schedule allows the appointments to be dragged and dropped at required time. - * @Default {true} - */ - allowDragAndDrop?: boolean; - - /** When set to true, Scheduler allows interaction through keyboard shortcut keys. - * @Default {true} - */ - allowKeyboardNavigation?: boolean; - - /** It includes the dataSource option and the fields related to Schedule appointments. The appointment fields within the appointmentSettings can accept both string and object type values. - * To apply validation rules on the appointment window fields, then the appointment fields needs to be defined with object type values. - */ - appointmentSettings?: AppointmentSettings; - - /** Template design that applies on the Schedule appointments. All the field names that are mapped from dataSource - * to the appropriate field properties within the appointmentSettings can be used within the template. - * @Default {null} - */ - appointmentTemplateId?: string; - - /** Accepts the custom CSS class name that defines specific user-defined styles and themes to be applied for partial or complete elements of the Schedule. - */ - cssClass?: string; - - /** Sets various categorize colors to the Schedule appointments to differentiate it. - */ - categorizeSettings?: CategorizeSettings; - - /** Sets the height for Schedule cells. - * @Default {20px} - */ - cellHeight?: string; - - /** Sets the width for Schedule cells. - */ - cellWidth?: string; - - /** Holds all options related to the context menu settings of Scheduler. - */ - contextMenuSettings?: ContextMenuSettings; - - /** Sets current date of the Schedule. The Schedule displays initially with the date that is provided here. - * @Default {new Date()} - */ - currentDate?: any; - - /** Sets current view of the Schedule. Schedule renders initially with the view that is specified here. The available views are day, week, workweek, month, agenda and - * custom view - from which any one of the required view can be set to the Schedule. It accepts both string or enum values. The enum values that are accepted - * by currentView(ej.Schedule.CurrentView) are as follows, - * @Default {ej.Schedule.CurrentView.Week} - */ - currentView?: string|ej.Schedule.CurrentView; - - /** Sets the date format for Schedule. - */ - dateFormat?: string; - - /** When set to true, shows the previous/next appointment navigator button on the Scheduler. - * @Default {true} - */ - showAppointmentNavigator?: boolean; - - /** When set to true, enables the resize behavior of appointments within the Schedule. - * @Default {true} - */ - enableAppointmentResize?: boolean; - - /** When set to true, enables the loading of Schedule appointments based on your demand. With this load on demand concept, the data consumption of the Schedule can be limited. - * @Default {false} - */ - enableLoadOnDemand?: boolean; - - /** Saves the current model value to browser cookies for state maintenance. When the page gets refreshed, Schedule control values are retained. - * @Default {false} - */ - enablePersistence?: boolean; - - /** When set to true, the Schedule layout and behavior changes as per the common RTL conventions. - * @Default {false} - */ - enableRTL?: boolean; - - /** Sets the end hour time limit to be displayed on the Schedule. - * @Default {24} - */ - endHour?: number; - - /** To configure resource grouping on the Schedule. - */ - group?: Group; - - /** Sets the height of the Schedule. Accepts both pixel and percentage values. - * @Default {1120px} - */ - height?: string; - - /** To define the work hours within the Schedule control. - */ - workHours?: WorkHours; - - /** When set to true, enables the Schedule to observe Daylight Saving Time for supported timezones. - * @Default {false} - */ - isDST?: boolean; - - /** When set to true, adapts the Schedule layout to fit the screen size of devices on which it renders. - * @Default {true} - */ - isResponsive?: boolean; - - /** Sets the specific culture to the Schedule. - * @Default {en-US} - */ - locale?: string; - - /** Sets the maximum date limit to display on the Schedule. Setting maxDate with specific date value disallows the Schedule to navigate beyond that date. - * @Default {new Date(2099, 12, 31)} - */ - maxDate?: any; - - /** Sets the minimum date limit to display on the Schedule. Setting minDate with specific date value disallows the Schedule to navigate beyond that date. - * @Default {new Date(1900, 01, 01)} - */ - minDate?: any; - - /** Sets the mode of Schedule rendering either in a vertical or horizontal direction. It accepts either string("vertical" or "horizontal") or enum values. - * The enum values that are accepted by orientation(ej.Schedule.Orientation) are as follows, - * @Default {ej.Schedule.Orientation.Vertical} - */ - orientation?: string|ej.Schedule.Orientation; - - /** Holds all the options related to priority settings of the Schedule. - */ - prioritySettings?: PrioritySettings; - - /** When set to true, disables the interaction with the Schedule appointments, simply allowing the date and view navigation to occur. - * @Default {false} - */ - readOnly?: boolean; - - /** Holds all the options related to reminder settings of the Schedule. - */ - reminderSettings?: ReminderSettings; - - /** Defines the specific start and end dates to be rendered in the Schedule control. To render such user-specified custom date ranges in the Schedule control, - * set the currentView property to ej.Schedule.CurrentView.CustomView. - * @Default {null} - */ - renderDates?: RenderDates; - - /** Template design that applies on the Schedule resource header. - * @Default {null} - */ - resourceHeaderTemplateId?: string; - - /** Holds all the options related to the resources settings of the Schedule. It is a collection of one or more resource objects, where the levels of resources are rendered on the Schedule - * based on the order of the resource data provided within this collection. - * @Default {null} - */ - resources?: Resource[]; - - /** When set to true, displays the all-day row cells on the Schedule. - * @Default {true} - */ - showAllDayRow?: boolean; - - /** When set to true, displays the current time indicator on the Schedule. - * @Default {true} - */ - showCurrentTimeIndicator?: boolean; - - /** When set to true, displays the header bar on the Schedule. - * @Default {true} - */ - showHeaderBar?: boolean; - - /** When set to true, displays the location field additionally on Schedule appointment window. - * @Default {false} - */ - showLocationField?: boolean; - - /** When set to false, doesn't render the start and end timezone fields on the Schedule appointment window. - * @Default {true} - */ - showTimeZoneFields?: boolean; - - /** When set to true, displays the quick window for every single click made on the Schedule cells or appointments. - * @Default {true} - */ - showQuickWindow?: boolean; - - /** Sets the start hour time range to be displayed on the Schedule. - * @Default {0} - */ - startHour?: number; - - /** Sets either 12 or 24 hour time mode on the Schedule. It accepts either the string value("12" or "24") or the below mentioned enum values. - * The enum values that are accepted by timeMode(ej.Schedule.TimeMode) are as follows, - * @Default {null} - */ - timeMode?: string|ej.Schedule.TimeMode; - - /** Sets the timezone for the Schedule. - * @Default {null} - */ - timeZone?: string; - - /** Sets the collection of timezone items to be bound to the Schedule. Only the items bound to this property gets listed out in the timezone field of the appointment window. - */ - timeZoneCollection?: TimeZoneCollection; - - /** Defines the view collection to be displayed on the Schedule. By default, it displays all the views namely, Day, Week, WorkWeek and Month. - * @Default {[Day, Week, WorkWeek, Month, Agenda]} - */ - views?: any[]; - - /** Sets the width of the Schedule. Accepts both pixel and percentage values. - * @Default {100%} - */ - width?: string; - - /** When set to true, Schedule allows the validation of recurrence pattern to take place before it is being assigned to the appointments. For example, when one of the instance of - * recurrence appointment is dragged beyond the next or previous instance of the same recurrence appointment, a pop-up is displayed with the validation message disallowing the drag functionality. - * @Default {true} - */ - enableRecurrenceValidation?: boolean; - - /** Sets the week to display more than one week appointment summary. - */ - agendaViewSettings?: AgendaViewSettings; - - /** Sets specific day as the starting day of the week. - * @Default {null} - */ - firstDayOfWeek?: string; - - /** Sets different day collection within workWeek view. - * @Default {[Monday, Tuesday, Wednesday, Thursday, Friday]} - */ - workWeek?: any[]; - - /** Allows to pop-up appointment details in a tooltip while hovering over the appointments. - */ - tooltipSettings?: TooltipSettings; - - /** Holds all the options related to the time scale of Scheduler. The timeslots either major or minor slots can be customized with this property. - */ - timeScale?: TimeScale; - - /** When set to true, shows the delete confirmation dialog before deleting an appointment. - * @Default {true} - */ - showDeleteConfirmationDialog?: boolean; + /** Allows the user to bind the item by using its unique name as field name. + */ + fieldName?: string; + + /** Allows the user to indicate whether the added item is a named set or not. + * @Default {false} + */ + isNamedSets?: boolean; + + /** Applies filter to the field members. + * @Default {null} + */ + filterItems?: DataSourceRowsFilterItems; + } + + export interface DataSourceValuesMeasure { + + /** Allows the user to bind the measure from OLAP datasource by using its unique name as field name. + */ + fieldName?: string; + } + + export interface DataSourceValue { + + /** This holds the list of unique names of measures to bind them from the OLAP cube. + * @Default {[]} + */ + measures?: DataSourceValuesMeasure[]; + + /** Allows to set the axis name to place the measures items. + * @Default {rows} + */ + axis?: string; + } + + export interface DataSourceFiltersFilterItems { + + /** Contains the collection of items to be excluded among the field members. + * @Default {[]} + */ + values?: any[]; + } + + export interface DataSourceFilter { + + /** Allows the user to bind the item by using its unique name as field name. + */ + fieldName?: string; + + /** Applies filter to the field members. + * @Default {null} + */ + filterItems?: DataSourceFiltersFilterItems; + } + + export interface DataSource { + + /** Provides the raw data source for the PivotTreeMap. + * @Default {null} + */ + data?: any; + + /** Contains the respective cube name from OLAP database as string type. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + cube?: string; + + /** In connection with an OLAP database, this property contains the database name as string to fetch the data from the given connection string. + * @Default {Ă¢â‚¬Å“Ă¢â‚¬Â} + */ + catalog?: string; + + /** Lists out the items to be displayed as series of PivotTreeMap. + * @Default {[]} + */ + columns?: DataSourceColumn[]; + + /** Lists out the items to be displayed as segments of PivotTreeMap. + * @Default {[]} + */ + rows?: DataSourceRow[]; + + /** Lists out the items supports calculation in PivotTreeMap. + * @Default {[]} + */ + values?: DataSourceValue[]; + + /** Lists out the items which supports filtering of values without displaying the members in UI in PivotTreeMap. + * @Default {[]} + */ + filters?: DataSourceFilter[]; + } + + export interface ServiceMethodSettings { + + /** Allows the user to set the custom name for the service method responsible for initializing PivotTreeMap. + * @Default {InitializeTreemap} + */ + initialize?: string; + + /** Allows the user to set the custom name for the service method responsible for drilling up/down operation in PivotTreeMap. + * @Default {DrillTreeMap} + */ + drillDown?: string; + } + } + + class Schedule extends ej.Widget { + static fn: Schedule; + constructor(element: JQuery | Element, options?: Schedule.Model); + static Locale: any; + model: Schedule.Model; + defaults: Schedule.Model; + + /** This method is used to delete the appointment based on the guid value or the appointment data passed to it. + * @param {string|any} GUID value of an appointment element or an appointment object + * @returns {void} + */ + deleteAppointment(data: string | any): void; + + /** Destroys the Schedule widget. All the events bound using this._on are unbound automatically and the control is moved to pre-init state. + * @returns {void} + */ + destroy(): void; + + /** Exports the appointments from the Schedule control. + * @param {string} It refers the controller action name to redirect. (For MVC) + * @param {string} It refers the server event name.(For ASP) + * @param {string|number} Pass the id of an appointment, in case if a single appointment needs to be exported. Otherwise, it takes the null value. + * @returns {void} + */ + exportSchedule(action: string, serverEvent: string, id: string | number): void; + + /** Searches and filters the appointments from appointment list of Schedule control. + * @param {Array} Holds array of one or more conditional objects for filtering the appointments based on it. + * @returns {Array} + */ + filterAppointments(filterConditions: any[]): any[]; + + /** Gets the complete appointment list of Schedule control. + * @returns {Array} + */ + getAppointments(): any[]; + + /** Prints the entire Scheduler or a single appointment based on the appointment data passed as an argument to it. Simply calling the print() method, + * without passing any argument will print the entire Scheduler. + * @param {any} Either accepts no arguments at all or else accepts an appointment object. + * @returns {void} + */ + print(data: any): void; + + /** Refreshes the Scroller of Scheduler while using it within some other controls or application. + * @returns {void} + */ + refreshScroller(): void; + + /** It is used to save the appointment. The appointment object is based on the argument passed to this method. + * @param {any} appointment object which includes appointment details + * @returns {void} + */ + saveAppointment(appointmentObject: any): void; + + /** Generate the recurrence rule as a string, based on the repeat options selected. + * @returns {string} + */ + getRecurrenceRule(): string; + + /** Retrieves the time slot information (start/end time and resource details) of the given element. + * The parameter is optional - as when no element is passed to it, the currently selected cell information will be retrieved. When multiple cells are selected in the Scheduler, + * it is not necessary to provide the parameter. + * @param {any} TD element object rendered as Scheduler work cell + * @returns {any} + */ + getSlotByElement(element: any): any; + + /** Searches the appointments from the appointment list of Schedule control based on the provided search string in its argument list. + * @param {any|string} Defines the search word or the filter condition, based on which the appointments are filtered from the list. + * @param {string} Defines the field name on which the search is to be made. + * @param {ej.FilterOperators|string} Defines the filterOperator value for the search operation. + * @param {boolean} Defines the ignoreCase value for performing the search operation. + * @returns {Array} + */ + searchAppointments(searchString: any | string, field: string, operator: ej.FilterOperators | string, ignoreCase: boolean): any[]; + + /** Refreshes the entire Schedule control. + * @returns {void} + */ + refresh(): void; + + /** Refreshes only the appointment elements within the Schedule control. + * @returns {void} + */ + refreshAppointments(): void; + + /** Passes the server-side action and data to the client-side for rendering the modified appointment list on the Schedule control. + * @returns {void} + */ + notifyChanges(): void; + } + export namespace Schedule { + + export interface Model { + + /** When set to true, Schedule allows the appointments to be dragged and dropped at required time. + * @Default {true} + */ + allowDragAndDrop?: boolean; + + /** When set to true, Scheduler allows interaction through keyboard shortcut keys. + * @Default {true} + */ + allowKeyboardNavigation?: boolean; + + /** It includes the dataSource option and the fields related to Schedule appointments. The appointment fields within the appointmentSettings can accept both string and object type values. + * To apply validation rules on the appointment window fields, then the appointment fields needs to be defined with object type values. + */ + appointmentSettings?: AppointmentSettings; + + /** Template design that applies on the Schedule appointments. All the field names that are mapped from dataSource + * to the appropriate field properties within the appointmentSettings can be used within the template. + * @Default {null} + */ + appointmentTemplateId?: string; + + /** Accepts the custom CSS class name that defines specific user-defined styles and themes to be applied for partial or complete elements of the Schedule. + */ + cssClass?: string; + + /** Sets various categorize colors to the Schedule appointments to differentiate it. + */ + categorizeSettings?: CategorizeSettings; + + /** Sets the height for Schedule cells. + * @Default {20px} + */ + cellHeight?: string; + + /** Sets the width for Schedule cells. + */ + cellWidth?: string; + + /** Holds all options related to the context menu settings of Scheduler. + */ + contextMenuSettings?: ContextMenuSettings; + + /** Sets current date of the Schedule. The Schedule displays initially with the date that is provided here. + * @Default {new Date()} + */ + currentDate?: any; + + /** Sets current view of the Schedule. Schedule renders initially with the view that is specified here. The available views are day, week, workweek, month, agenda and + * custom view - from which any one of the required view can be set to the Schedule. It accepts both string or enum values. The enum values that are accepted + * by currentView(ej.Schedule.CurrentView) are as follows, + * @Default {ej.Schedule.CurrentView.Week} + */ + currentView?: string | ej.Schedule.CurrentView; + + /** Sets the date format for Schedule. + */ + dateFormat?: string; + + /** When set to true, shows the previous/next appointment navigator button on the Scheduler. + * @Default {true} + */ + showAppointmentNavigator?: boolean; + + /** When set to true, enables the resize behavior of appointments within the Schedule. + * @Default {true} + */ + enableAppointmentResize?: boolean; + + /** When set to true, enables the loading of Schedule appointments based on your demand. With this load on demand concept, the data consumption of the Schedule can be limited. + * @Default {false} + */ + enableLoadOnDemand?: boolean; + + /** Saves the current model value to browser cookies for state maintenance. When the page gets refreshed, Schedule control values are retained. + * @Default {false} + */ + enablePersistence?: boolean; + + /** When set to true, the Schedule layout and behavior changes as per the common RTL conventions. + * @Default {false} + */ + enableRTL?: boolean; + + /** Sets the end hour time limit to be displayed on the Schedule. + * @Default {24} + */ + endHour?: number; + + /** To configure resource grouping on the Schedule. + */ + group?: Group; + + /** Sets the height of the Schedule. Accepts both pixel and percentage values. + * @Default {1120px} + */ + height?: string; + + /** To define the work hours within the Schedule control. + */ + workHours?: WorkHours; + + /** When set to true, enables the Schedule to observe Daylight Saving Time for supported timezones. + * @Default {false} + */ + isDST?: boolean; + + /** When set to true, adapts the Schedule layout to fit the screen size of devices on which it renders. + * @Default {true} + */ + isResponsive?: boolean; + + /** Sets the specific culture to the Schedule. + * @Default {en-US} + */ + locale?: string; + + /** Sets the maximum date limit to display on the Schedule. Setting maxDate with specific date value disallows the Schedule to navigate beyond that date. + * @Default {new Date(2099, 12, 31)} + */ + maxDate?: any; + + /** Sets the minimum date limit to display on the Schedule. Setting minDate with specific date value disallows the Schedule to navigate beyond that date. + * @Default {new Date(1900, 01, 01)} + */ + minDate?: any; + + /** Sets the mode of Schedule rendering either in a vertical or horizontal direction. It accepts either string("vertical" or "horizontal") or enum values. + * The enum values that are accepted by orientation(ej.Schedule.Orientation) are as follows, + * @Default {ej.Schedule.Orientation.Vertical} + */ + orientation?: string | ej.Schedule.Orientation; + + /** Holds all the options related to priority settings of the Schedule. + */ + prioritySettings?: PrioritySettings; + + /** When set to true, disables the interaction with the Schedule appointments, simply allowing the date and view navigation to occur. + * @Default {false} + */ + readOnly?: boolean; + + /** Holds all the options related to reminder settings of the Schedule. + */ + reminderSettings?: ReminderSettings; + + /** Defines the specific start and end dates to be rendered in the Schedule control. To render such user-specified custom date ranges in the Schedule control, + * set the currentView property to ej.Schedule.CurrentView.CustomView. + * @Default {null} + */ + renderDates?: RenderDates; + + /** Template design that applies on the Schedule resource header. + * @Default {null} + */ + resourceHeaderTemplateId?: string; + + /** Holds all the options related to the resources settings of the Schedule. It is a collection of one or more resource objects, where the levels of resources are rendered on the Schedule + * based on the order of the resource data provided within this collection. + * @Default {null} + */ + resources?: Resource[]; + + /** When set to true, displays the all-day row cells on the Schedule. + * @Default {true} + */ + showAllDayRow?: boolean; + + /** When set to true, displays the current time indicator on the Schedule. + * @Default {true} + */ + showCurrentTimeIndicator?: boolean; + + /** When set to true, displays the header bar on the Schedule. + * @Default {true} + */ + showHeaderBar?: boolean; + + /** When set to true, displays the location field additionally on Schedule appointment window. + * @Default {false} + */ + showLocationField?: boolean; + + /** When set to false, doesn't render the start and end timezone fields on the Schedule appointment window. + * @Default {true} + */ + showTimeZoneFields?: boolean; + + /** When set to true, displays the quick window for every single click made on the Schedule cells or appointments. + * @Default {true} + */ + showQuickWindow?: boolean; + + /** Sets the start hour time range to be displayed on the Schedule. + * @Default {0} + */ + startHour?: number; + + /** Sets either 12 or 24 hour time mode on the Schedule. It accepts either the string value("12" or "24") or the below mentioned enum values. + * The enum values that are accepted by timeMode(ej.Schedule.TimeMode) are as follows, + * @Default {null} + */ + timeMode?: string | ej.Schedule.TimeMode; + + /** Sets the timezone for the Schedule. + * @Default {null} + */ + timeZone?: string; + + /** Sets the collection of timezone items to be bound to the Schedule. Only the items bound to this property gets listed out in the timezone field of the appointment window. + */ + timeZoneCollection?: TimeZoneCollection; + + /** Defines the view collection to be displayed on the Schedule. By default, it displays all the views namely, Day, Week, WorkWeek and Month. + * @Default {[Day, Week, WorkWeek, Month, Agenda]} + */ + views?: any[]; + + /** Sets the width of the Schedule. Accepts both pixel and percentage values. + * @Default {100%} + */ + width?: string; + + /** When set to true, Schedule allows the validation of recurrence pattern to take place before it is being assigned to the appointments. For example, when one of the instance of + * recurrence appointment is dragged beyond the next or previous instance of the same recurrence appointment, a pop-up is displayed with the validation message disallowing the drag functionality. + * @Default {true} + */ + enableRecurrenceValidation?: boolean; + + /** Sets the week to display more than one week appointment summary. + */ + agendaViewSettings?: AgendaViewSettings; + + /** Sets specific day as the starting day of the week. + * @Default {null} + */ + firstDayOfWeek?: string; + + /** Sets different day collection within workWeek view. + * @Default {[Monday, Tuesday, Wednesday, Thursday, Friday]} + */ + workWeek?: any[]; + + /** Allows to pop-up appointment details in a tooltip while hovering over the appointments. + */ + tooltipSettings?: TooltipSettings; + + /** Holds all the options related to the time scale of Scheduler. The timeslots either major or minor slots can be customized with this property. + */ + timeScale?: TimeScale; + + /** When set to true, shows the delete confirmation dialog before deleting an appointment. + * @Default {true} + */ + showDeleteConfirmationDialog?: boolean; - /** Accepts the id value of the template layout defined for the all-day cells and customizes it. - * @Default {null} - */ - allDayCellsTemplateId?: string; + /** Accepts the id value of the template layout defined for the all-day cells and customizes it. + * @Default {null} + */ + allDayCellsTemplateId?: string; - /** Accepts the id value of the template layout defined for the work cells and month cells. - * @Default {null} - */ - workCellsTemplateId?: string; + /** Accepts the id value of the template layout defined for the work cells and month cells. + * @Default {null} + */ + workCellsTemplateId?: string; - /** Accepts the id value of the template layout defined for the date header cells and customizes it. - * @Default {null} - */ - dateHeaderTemplateId?: string; + /** Accepts the id value of the template layout defined for the date header cells and customizes it. + * @Default {null} + */ + dateHeaderTemplateId?: string; - /** when set to false, allows the height of the work-cells to adjust automatically (either expand or collapse) based on the number of appointment count it has. - * @Default {true} - */ - showOverflowButton?: boolean; + /** when set to false, allows the height of the work-cells to adjust automatically (either expand or collapse) based on the number of appointment count it has. + * @Default {true} + */ + showOverflowButton?: boolean; - /** Allows setting draggable area for the Scheduler appointments. Also, turns on the external drag and drop, when set with some specific external drag area name. - */ - appointmentDragArea?: string; + /** Allows setting draggable area for the Scheduler appointments. Also, turns on the external drag and drop, when set with some specific external drag area name. + */ + appointmentDragArea?: string; - /** When set to true, displays the other months days from the current month on the Schedule. - * @Default {true} - */ - showNextPrevMonth?: boolean; + /** When set to true, displays the other months days from the current month on the Schedule. + * @Default {true} + */ + showNextPrevMonth?: boolean; - /** Blocks the user-specific time interval on the Scheduler, so that no appointments can be created on that particular time slots. - * It includes the dataSource option and also the fields related to block intervals. - */ - blockoutSettings?: BlockoutSettings; + /** Blocks the user-specific time interval on the Scheduler, so that no appointments can be created on that particular time slots. + * It includes the dataSource option and also the fields related to block intervals. + */ + blockoutSettings?: BlockoutSettings; - /** Triggers on the beginning of every action that starts within the Schedule. */ - actionBegin?(e: ActionBeginEventArgs): void; + /** Triggers on the beginning of every action that starts within the Schedule. */ + actionBegin?(e: ActionBeginEventArgs): void; - /** Triggers after the completion of every action within the Schedule. */ - actionComplete?(e: ActionCompleteEventArgs): void; + /** Triggers after the completion of every action within the Schedule. */ + actionComplete?(e: ActionCompleteEventArgs): void; - /** Triggers after an appointment is clicked. */ - appointmentClick?(e: AppointmentClickEventArgs): void; + /** Triggers after an appointment is clicked. */ + appointmentClick?(e: AppointmentClickEventArgs): void; - /** Triggers before the appointment is being removed from the Scheduler. */ - beforeAppointmentRemove?(e: BeforeAppointmentRemoveEventArgs): void; + /** Triggers before the appointment is being removed from the Scheduler. */ + beforeAppointmentRemove?(e: BeforeAppointmentRemoveEventArgs): void; - /** Triggers before the edited appointment is being saved. */ - beforeAppointmentChange?(e: BeforeAppointmentChangeEventArgs): void; + /** Triggers before the edited appointment is being saved. */ + beforeAppointmentChange?(e: BeforeAppointmentChangeEventArgs): void; - /** Triggers on hovering the mouse over the appointments. */ - appointmentHover?(e: AppointmentHoverEventArgs): void; + /** Triggers on hovering the mouse over the appointments. */ + appointmentHover?(e: AppointmentHoverEventArgs): void; - /** Triggers before the new appointment gets saved. */ - beforeAppointmentCreate?(e: BeforeAppointmentCreateEventArgs): void; + /** Triggers before the new appointment gets saved. */ + beforeAppointmentCreate?(e: BeforeAppointmentCreateEventArgs): void; - /** Triggers before the appointment window opens. */ - appointmentWindowOpen?(e: AppointmentWindowOpenEventArgs): void; + /** Triggers before the appointment window opens. */ + appointmentWindowOpen?(e: AppointmentWindowOpenEventArgs): void; - /** Triggers before the context menu opens. */ - beforeContextMenuOpen?(e: BeforeContextMenuOpenEventArgs): void; + /** Triggers before the context menu opens. */ + beforeContextMenuOpen?(e: BeforeContextMenuOpenEventArgs): void; - /** Triggers after the cell is clicked. */ - cellClick?(e: CellClickEventArgs): void; + /** Triggers after the cell is clicked. */ + cellClick?(e: CellClickEventArgs): void; - /** Triggers after the cell is clicked twice. */ - cellDoubleClick?(e: CellDoubleClickEventArgs): void; + /** Triggers after the cell is clicked twice. */ + cellDoubleClick?(e: CellDoubleClickEventArgs): void; - /** Triggers on hovering the mouse overs the cells. */ - cellHover?(e: CellHoverEventArgs): void; + /** Triggers on hovering the mouse overs the cells. */ + cellHover?(e: CellHoverEventArgs): void; - /** Triggers when the Scheduler completely renders on the page. */ - create?(e: CreateEventArgs): void; + /** Triggers when the Scheduler completely renders on the page. */ + create?(e: CreateEventArgs): void; - /** Triggers when the Scheduler and all its sub-components gets destroyed. */ - destroy?(e: DestroyEventArgs): void; + /** Triggers when the Scheduler and all its sub-components gets destroyed. */ + destroy?(e: DestroyEventArgs): void; - /** Triggers while the appointment is being dragged over the work cells. */ - drag?(e: DragEventArgs): void; + /** Triggers while the appointment is being dragged over the work cells. */ + drag?(e: DragEventArgs): void; - /** Triggers when the appointment dragging begins. */ - dragStart?(e: DragStartEventArgs): void; + /** Triggers when the appointment dragging begins. */ + dragStart?(e: DragStartEventArgs): void; - /** Triggers when the appointment is dropped. */ - dragStop?(e: DragStopEventArgs): void; + /** Triggers when the appointment is dropped. */ + dragStop?(e: DragStopEventArgs): void; - /** Triggers after the menu/sub-menu items within the context menu is clicked. */ - menuItemClick?(e: MenuItemClickEventArgs): void; + /** Triggers after the menu/sub-menu items within the context menu is clicked. */ + menuItemClick?(e: MenuItemClickEventArgs): void; - /** Triggers after the Schedule view or date is navigated. */ - navigation?(e: NavigationEventArgs): void; + /** Triggers after the Schedule view or date is navigated. */ + navigation?(e: NavigationEventArgs): void; - /** Triggers every time before the elements of the scheduler such as work cells, time cells or header cells and so on renders or re-renders on a page. */ - queryCellInfo?(e: QueryCellInfoEventArgs): void; + /** Triggers every time before the elements of the scheduler such as work cells, time cells or header cells and so on renders or re-renders on a page. */ + queryCellInfo?(e: QueryCellInfoEventArgs): void; - /** Triggers when the reminder is raised for an appointment based on the alertBefore value. */ - reminder?(e: ReminderEventArgs): void; + /** Triggers when the reminder is raised for an appointment based on the alertBefore value. */ + reminder?(e: ReminderEventArgs): void; - /** Triggers while resizing the appointment. */ - resize?(e: ResizeEventArgs): void; + /** Triggers while resizing the appointment. */ + resize?(e: ResizeEventArgs): void; - /** Triggers when the appointment resizing begins. */ - resizeStart?(e: ResizeStartEventArgs): void; + /** Triggers when the appointment resizing begins. */ + resizeStart?(e: ResizeStartEventArgs): void; - /** Triggers when an appointment resizing stops. */ - resizeStop?(e: ResizeStopEventArgs): void; + /** Triggers when an appointment resizing stops. */ + resizeStop?(e: ResizeStopEventArgs): void; - /** Triggers when the overflow button is clicked. */ - overflowButtonClick?(e: OverflowButtonClickEventArgs): void; + /** Triggers when the overflow button is clicked. */ + overflowButtonClick?(e: OverflowButtonClickEventArgs): void; - /** Triggers while mouse hovering on the overflow button. */ - overflowButtonHover?(e: OverflowButtonHoverEventArgs): void; + /** Triggers while mouse hovering on the overflow button. */ + overflowButtonHover?(e: OverflowButtonHoverEventArgs): void; - /** Triggers when any of the keyboard keys are pressed. */ - keyDown?(e: KeyDownEventArgs): void; + /** Triggers when any of the keyboard keys are pressed. */ + keyDown?(e: KeyDownEventArgs): void; - /** Triggers after the new appointment is saved. */ - appointmentCreated?(e: AppointmentCreatedEventArgs): void; + /** Triggers after the new appointment is saved. */ + appointmentCreated?(e: AppointmentCreatedEventArgs): void; - /** Triggers after an existing appointment is edited. */ - appointmentChanged?(e: AppointmentChangedEventArgs): void; + /** Triggers after an existing appointment is edited. */ + appointmentChanged?(e: AppointmentChangedEventArgs): void; - /** Triggers after the appointment is deleted. */ - appointmentRemoved?(e: AppointmentRemovedEventArgs): void; -} + /** Triggers after the appointment is deleted. */ + appointmentRemoved?(e: AppointmentRemovedEventArgs): void; + } -export interface ActionBeginEventArgs { + export interface ActionBeginEventArgs { - /** Returns the current date value. - */ - currentDate?: any; + /** Returns the current date value. + */ + currentDate?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the current view value. - */ - currentView?: string; + /** Returns the current view value. + */ + currentView?: string; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the action begin request type. - */ - requestType?: string; + /** Returns the action begin request type. + */ + requestType?: string; - /** Returns the target of the click. - */ - target?: any; + /** Returns the target of the click. + */ + target?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the save appointment value. - */ - data?: any; + /** Returns the save appointment value. + */ + data?: any; - /** Returns the id of delete appointment. - */ - id?: number; -} + /** Returns the id of delete appointment. + */ + id?: number; + } -export interface ActionCompleteEventArgs { + export interface ActionCompleteEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the data about view change action. - */ - data?: any; + /** Returns the data about view change action. + */ + data?: any; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the action complete request type. - */ - requestType?: string; + /** Returns the action complete request type. + */ + requestType?: string; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the appointment data dropped. - */ - appointment?: any; -} + /** Returns the appointment data dropped. + */ + appointment?: any; + } -export interface AppointmentClickEventArgs { + export interface AppointmentClickEventArgs { - /** Returns the object of appointmentClick event. - */ - object?: any; + /** Returns the object of appointmentClick event. + */ + object?: any; - /** Returns the clicked appointment object. - */ - appointment?: any; + /** Returns the clicked appointment object. + */ + appointment?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface BeforeAppointmentRemoveEventArgs { + export interface BeforeAppointmentRemoveEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the deleted appointment object. - */ - appointment?: any; + /** Returns the deleted appointment object. + */ + appointment?: any; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the name of the Scheduler event. - */ - type?: string; -} + /** Returns the name of the Scheduler event. + */ + type?: string; + } -export interface BeforeAppointmentChangeEventArgs { + export interface BeforeAppointmentChangeEventArgs { - /** Returns the edited appointment object. - */ - appointment?: any; + /** Returns the edited appointment object. + */ + appointment?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the name of the Scheduler event. - */ - type?: string; -} + /** Returns the name of the Scheduler event. + */ + type?: string; + } -export interface AppointmentHoverEventArgs { + export interface AppointmentHoverEventArgs { - /** Returns the object of appointmentHover event. - */ - object?: any; + /** Returns the object of appointmentHover event. + */ + object?: any; - /** Returns the hovered appointment object. - */ - appointment?: any; + /** Returns the hovered appointment object. + */ + appointment?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface BeforeAppointmentCreateEventArgs { + export interface BeforeAppointmentCreateEventArgs { - /** Returns the appointment object. - */ - appointment?: any; + /** Returns the appointment object. + */ + appointment?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the name of the Scheduler event. - */ - type?: string; -} + /** Returns the name of the Scheduler event. + */ + type?: string; + } -export interface AppointmentWindowOpenEventArgs { + export interface AppointmentWindowOpenEventArgs { - /** returns the object of appointmentWindowOpen event while selecting the detail option from quick window or edit appointment or edit series option. - */ - object?: any; + /** returns the object of appointmentWindowOpen event while selecting the detail option from quick window or edit appointment or edit series option. + */ + object?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the end time of the double clicked cell. - */ - endTime?: any; + /** Returns the end time of the double clicked cell. + */ + endTime?: any; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the action name that triggers window open. - */ - originalEventType?: string; + /** Returns the action name that triggers window open. + */ + originalEventType?: string; - /** Returns the start time of the double clicked cell. - */ - startTime?: any; + /** Returns the start time of the double clicked cell. + */ + startTime?: any; - /** Returns the target of the double clicked cell. - */ - target?: any; + /** Returns the target of the double clicked cell. + */ + target?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the edit appointment object. - */ - appointment?: any; + /** Returns the edit appointment object. + */ + appointment?: any; - /** Returns the edit occurrence option value. - */ - edit?: boolean; -} + /** Returns the edit occurrence option value. + */ + edit?: boolean; + } -export interface BeforeContextMenuOpenEventArgs { + export interface BeforeContextMenuOpenEventArgs { - /** Returns the object of beforeContextMenuOpen event. - */ - object?: any; + /** Returns the object of beforeContextMenuOpen event. + */ + object?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the current cell index value. - */ - cellIndex?: number; + /** Returns the current cell index value. + */ + cellIndex?: number; - /** Returns the current date value. - */ - currentDate?: any; + /** Returns the current date value. + */ + currentDate?: any; - /** Returns the current resource details, when multiple resources are present, otherwise returns null. - */ - resources?: any; + /** Returns the current resource details, when multiple resources are present, otherwise returns null. + */ + resources?: any; - /** Returns the current appointment details while opening the menu from appointment. - */ - appointment?: any; + /** Returns the current appointment details while opening the menu from appointment. + */ + appointment?: any; - /** Returns the object of before opening menu target. - */ - events?: any; + /** Returns the object of before opening menu target. + */ + events?: any; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface CellClickEventArgs { + export interface CellClickEventArgs { - /** Returns the object of cellClick event. - */ - object?: any; + /** Returns the object of cellClick event. + */ + object?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the end time of the clicked cell. - */ - endTime?: any; + /** Returns the end time of the clicked cell. + */ + endTime?: any; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the start time of the clicked cell. - */ - startTime?: any; + /** Returns the start time of the clicked cell. + */ + startTime?: any; - /** Returns the target of the clicked cell. - */ - target?: any; + /** Returns the target of the clicked cell. + */ + target?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface CellDoubleClickEventArgs { + export interface CellDoubleClickEventArgs { - /** Returns the object of cellDoubleClick event. - */ - object?: any; + /** Returns the object of cellDoubleClick event. + */ + object?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the end time of the double clicked cell. - */ - endTime?: any; + /** Returns the end time of the double clicked cell. + */ + endTime?: any; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the start time of the double clicked cell. - */ - startTime?: any; + /** Returns the start time of the double clicked cell. + */ + startTime?: any; - /** Returns the target of the double clicked cell. - */ - target?: any; + /** Returns the target of the double clicked cell. + */ + target?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface CellHoverEventArgs { + export interface CellHoverEventArgs { - /** Returns the object of cellHover event. - */ - object?: any; + /** Returns the object of cellHover event. + */ + object?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the index of the hovered cell. - */ - cellIndex?: any; + /** Returns the index of the hovered cell. + */ + cellIndex?: any; - /** Returns the current date of the hovered cell. - */ - currentDate?: any; + /** Returns the current date of the hovered cell. + */ + currentDate?: any; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the target of the clicked cell. - */ - target?: any; + /** Returns the target of the clicked cell. + */ + target?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the name of the Scheduler event. - */ - type?: string; -} + /** Returns the name of the Scheduler event. + */ + type?: string; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the name of the Scheduler event. - */ - type?: string; -} + /** Returns the name of the Scheduler event. + */ + type?: string; + } -export interface DragEventArgs { + export interface DragEventArgs { - /** Returns the object of dragOver event. - */ - object?: any; + /** Returns the object of dragOver event. + */ + object?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the target of the drag over appointment. - */ - target?: any; + /** Returns the target of the drag over appointment. + */ + target?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface DragStartEventArgs { + export interface DragStartEventArgs { - /** Returns the object of dragStart event. - */ - object?: any; + /** Returns the object of dragStart event. + */ + object?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the target of the dragging appointment. - */ - target?: any; + /** Returns the target of the dragging appointment. + */ + target?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface DragStopEventArgs { + export interface DragStopEventArgs { - /** Returns the object of dragDrop event. - */ - object?: any; + /** Returns the object of dragDrop event. + */ + object?: any; - /** Returns the dropped appointment object. - */ - appointment?: any; + /** Returns the dropped appointment object. + */ + appointment?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface MenuItemClickEventArgs { + export interface MenuItemClickEventArgs { - /** Returns the object of menuItemClick event. - */ - object?: any; + /** Returns the object of menuItemClick event. + */ + object?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the object of menu item event. - */ - events?: any; + /** Returns the object of menu item event. + */ + events?: any; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface NavigationEventArgs { + export interface NavigationEventArgs { - /** Returns the current date object. - */ - currentDate?: any; + /** Returns the current date object. + */ + currentDate?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the current view value. - */ - currentView?: string; + /** Returns the current view value. + */ + currentView?: string; - /** Returns the previous view value. - */ - previousView?: string; + /** Returns the previous view value. + */ + previousView?: string; - /** Returns the target of the action. - */ - target?: any; + /** Returns the target of the action. + */ + target?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the previous date of the Schedule. - */ - previousDate?: any; -} + /** Returns the previous date of the Schedule. + */ + previousDate?: any; + } -export interface QueryCellInfoEventArgs { + export interface QueryCellInfoEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the current appointment data. - */ - appointment?: any; + /** Returns the current appointment data. + */ + appointment?: any; - /** Returns the currently rendering DOM element. - */ - element?: any; + /** Returns the currently rendering DOM element. + */ + element?: any; - /** Returns the name of the currently rendering element on the scheduler. - */ - requestType?: string; + /** Returns the name of the currently rendering element on the scheduler. + */ + requestType?: string; - /** Returns the cell type which is currently rendering on the Scheduler. - */ - cellType?: string; + /** Returns the cell type which is currently rendering on the Scheduler. + */ + cellType?: string; - /** Returns the start date of the currently rendering appointment. - */ - currentAppointmentDate?: any; + /** Returns the start date of the currently rendering appointment. + */ + currentAppointmentDate?: any; - /** Returns the currently rendering cell information. - */ - cell?: any; + /** Returns the currently rendering cell information. + */ + cell?: any; - /** Returns the currently rendering resource details. - */ - resource?: any; + /** Returns the currently rendering resource details. + */ + resource?: any; - /** Returns the currently rendering date information. - */ - currentDay?: any; -} + /** Returns the currently rendering date information. + */ + currentDay?: any; + } -export interface ReminderEventArgs { + export interface ReminderEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the appointment object for which the reminder is raised. - */ - reminderAppointment?: any; -} + /** Returns the appointment object for which the reminder is raised. + */ + reminderAppointment?: any; + } -export interface ResizeEventArgs { + export interface ResizeEventArgs { - /** Returns the object of resizing event. - */ - object?: any; + /** Returns the object of resizing event. + */ + object?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the resize element value. - */ - element?: any; + /** Returns the resize element value. + */ + element?: any; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface ResizeStartEventArgs { + export interface ResizeStartEventArgs { - /** Returns the object of resizeStart event. - */ - object?: any; + /** Returns the object of resizeStart event. + */ + object?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the resize element value. - */ - element?: any; + /** Returns the resize element value. + */ + element?: any; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface ResizeStopEventArgs { + export interface ResizeStopEventArgs { - /** Returns the object of resizeStop event. - */ - object?: any; + /** Returns the object of resizeStop event. + */ + object?: any; - /** Returns the resized appointment value. - */ - appointment?: any; + /** Returns the resized appointment value. + */ + appointment?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the target of the resized appointment. - */ - target?: any; + /** Returns the target of the resized appointment. + */ + target?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface OverflowButtonClickEventArgs { + export interface OverflowButtonClickEventArgs { - /** Returns the object consisting of start time, end time and resource value of the underlying cell on which the clicked overflow button is present. - */ - object?: any; + /** Returns the object consisting of start time, end time and resource value of the underlying cell on which the clicked overflow button is present. + */ + object?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the object of menu item event. - */ - events?: any; + /** Returns the object of menu item event. + */ + events?: any; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface OverflowButtonHoverEventArgs { + export interface OverflowButtonHoverEventArgs { - /** Returns the object consisting of start time, end time and resource value of the underlying cell on which the overflow button is currently hovered. - */ - object?: any; + /** Returns the object consisting of start time, end time and resource value of the underlying cell on which the overflow button is currently hovered. + */ + object?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the object of menu item event. - */ - events?: any; + /** Returns the object of menu item event. + */ + events?: any; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface KeyDownEventArgs { + export interface KeyDownEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the object of menu item event. - */ - events?: any; + /** Returns the object of menu item event. + */ + events?: any; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface AppointmentCreatedEventArgs { + export interface AppointmentCreatedEventArgs { - /** Returns the appointment object. - */ - appointment?: any; + /** Returns the appointment object. + */ + appointment?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the name of the Scheduler event. - */ - type?: string; -} - -export interface AppointmentChangedEventArgs { - - /** Returns the edited appointment object. - */ - appointment?: any; - - /** Returns the cancel option value. - */ - cancel?: boolean; - - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; - - /** Returns the name of the Scheduler event. - */ - type?: string; -} - -export interface AppointmentRemovedEventArgs { - - /** Returns the cancel option value. - */ - cancel?: boolean; - - /** Returns the deleted appointment object. - */ - appointment?: any; - - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; - - /** Returns the name of the Scheduler event. - */ - type?: string; -} - -export interface AppointmentSettings { - - /** The dataSource option accepts either JSON object collection or DataManager (ej.DataManager) instance that contains Schedule appointments. - * @Default {[]} - */ - dataSource?: any|any[]; - - /** It holds either the ej.Query() object or simply the query string that retrieves the specified records from the table. - * @Default {null} - */ - query?: string; - - /** Assign the table name from where the records are to be fetched for the Schedule. - * @Default {null} - */ - tableName?: string; - - /** When set to false, doesn't consider the time difference offset calculation on appointment time. - * @Default {true} - */ - applyTimeOffset?: boolean; - - /** Binds the id field name in dataSource to the id of Schedule appointments. It denotes the unique id assigned to appointments. - * @Default {null} - */ - id?: string; - - /** Binds the name of startTime field in the dataSource with start time of the Schedule appointments. It indicates the date and Time when Schedule appointment actually starts. - * @Default {null} - */ - startTime?: string; - - /** Binds the name of endTime field in dataSource with the end time of Schedule appointments. It indicates the date and time when Schedule appointment actually ends. - * @Default {null} - */ - endTime?: string; - - /** Binds the name of subject field in the dataSource to appointment Subject. Indicates the Subject or title that gets displayed on Schedule appointments. - * @Default {null} - */ - subject?: string; - - /** Binds the description field name in dataSource. It indicates the appointment description. - * @Default {null} - */ - description?: string; - - /** Binds the name of recurrence field in dataSource. It indicates whether the appointment is a recurrence appointment or not. - * @Default {null} - */ - recurrence?: string; - - /** Binds the name of recurrenceRule field in dataSource. It indicates the recurrence pattern associated with appointments. - * @Default {null} - */ - recurrenceRule?: string; - - /** Binds the name of allDay field in dataSource. It indicates whether the appointment is an all-day appointment or not. - * @Default {null} - */ - allDay?: string; - - /** Binds one or more fields in resource collection dataSource. It maps the resource field names with appointments denoting the resource of appointments actually belongs. - * @Default {null} - */ - resourceFields?: string; - - /** Binds the name of categorize field in dataSource. It indicates the categorize value, red categorize, green, yellow and so on applied to the appointments. - * @Default {null} - */ - categorize?: string; - - /** Binds the name of location field in dataSource. It indicates the appointment location. - * @Default {null} - */ - location?: string; - - /** Binds the name of the priority field in dataSource. It indicates the priority, high, low, medium and none of the appointments. - * @Default {null} - */ - priority?: string; - - /** Binds the name of start timezone field in dataSource. It indicates the timezone of appointment start date. When startTimeZone field is not mentioned, - * the appointment uses the Schedule timeZone or System timeZone. - * @Default {null} - */ - startTimeZone?: string; - - /** Binds the name of end timezone field in dataSource. It indicates the timezone of appointment end date. When the endTimeZone field is not mentioned, - * the appointment uses the Schedule timeZone or System timeZone. - * @Default {null} - */ - endTimeZone?: string; -} - -export interface CategorizeSettings { - - /** When set to true, enables the multiple selection of categories to be applied for the appointments. - * @Default {false} - */ - allowMultiple?: boolean; - - /** When set to true, enables the categories option to be applied for the appointments. - * @Default {false} - */ - enable?: boolean; - - /** The dataSource option accepts either the JSON object collection or DataManager [ej.DataManager] instance that contains the categorize data. - */ - dataSource?: any[]|any; - - /** Binds id field name in the dataSource to id of category data. - * @Default {id} - */ - id?: string; - - /** Binds text field name in the dataSource to category text. - * @Default {text} - */ - text?: string; - - /** Binds color field name in the dataSource to category color. - * @Default {color} - */ - color?: string; - - /** Binds fontColor field name in the dataSource to category font. - * @Default {fontColor} - */ - fontColor?: string; -} - -export interface ContextMenuSettingsMenuItems { - - /** All the appointment related context menu items are grouped under this appointment menu collection. - */ - appointment?: any[]; - - /** All the Scheduler cell related context menu items are grouped under this cells menu item collection. - */ - cells?: any[]; -} - -export interface ContextMenuSettings { - - /** When set to true, enables the context menu options available for the Schedule cells and appointments. - * @Default {false} - */ - enable?: boolean; - - /** Contains all the default context menu options that are applicable for both Schedule cells and appointments. It also supports adding custom menu items to cells or appointment collection. - */ - menuItems?: ContextMenuSettingsMenuItems; -} - -export interface Group { - - /** Holds the array of resource names to be grouped on the Schedule. - */ - resources?: any[]; -} - -export interface WorkHours { - - /** When set to true, highlights the work hours of the Schedule. - * @Default {true} - */ - highlight?: boolean; - - /** Sets the start time to depict the start of working or business hour in a day. - * @Default {9} - */ - start?: number; - - /** Sets the end time to depict the end of working or business hour in a day. - * @Default {18} - */ - end?: number; -} - -export interface PrioritySettings { - - /** When set to true, enables the priority options available for the Schedule appointments. - * @Default {false} - */ - enable?: boolean; - - /** The dataSource option can accept the JSON object collection that contains the priority related data. - * @Default {{% highlight js%}[{ text: None, value: none },{ text: High, value: high },{ text: Medium, value: medium },{ text: Low, value: low }]{% endhighlight %}} - */ - dataSource?: any|any[]; - - /** Binds text field name in the dataSource to prioritySettings text. These text gets listed out in priority field of the appointment window. - * @Default {text} - */ - text?: string; - - /** Binds value field name in the dataSource to prioritySettings value. These field names usually accepts four priority values by default, high, low, medium and none. - * @Default {value} - */ - value?: string; - - /** Allows priority field customization in the appointment window to add custom icons denoting the priority level for the appointments. - * @Default {null} - */ - template?: string; -} - -export interface ReminderSettings { - - /** When set to true, enables the reminder option available for the Schedule appointments. - * @Default {false} - */ - enable?: boolean; - - /** Sets the timing, when the reminders are to be alerted for the Schedule appointments. - * @Default {5} - */ - alertBefore?: number; -} - -export interface RenderDates { - - /** Sets the start of custom date range to be rendered in the Schedule. - * @Default {null} - */ - start?: any; - - /** Sets the end limit of the custom date range. - * @Default {null} - */ - end?: any; -} - -export interface ResourcesResourceSettings { - - /** The dataSource option accepts either JSON object collection or DataManager (ejDataManager) instance that contains the resources related data. - * @Default {[]} - */ - dataSource?: any|any[]; - - /** Binds text field name in the dataSource to resourceSettings text. These text gets listed out in resources field of the appointment window. - * @Default {null} - */ - text?: string; - - /** Binds id field name in the dataSource to resourceSettings id. - * @Default {null} - */ - id?: string; - - /** Binds groupId field name in the dataSource to resourceSettings groupId. - * @Default {null} - */ - groupId?: string; - - /** Binds color field name in the dataSource to resourceSettings color. The color specified here gets applied to the Schedule appointments denoting to the resource it belongs. - * @Default {null} - */ - color?: string; - - /** Binds the starting work hour field name in the dataSource. It's optional, but providing it with some numeric value will set the starting work hour for specific resources. - * @Default {null} - */ - start?: string; - - /** Binds the end work hour field name in the dataSource. It's optional, but providing it with some numeric value will set the end work hour for specific resources. - * @Default {null} - */ - end?: string; - - /** Binds the resources working days field name in the dataSource. It's optional, and accepts the array of strings (week day names). When provided with specific collection of - * days (array of day names), only those days will render for the specific resources. - * @Default {null} - */ - workWeek?: string; - - /** Binds appointmentClass field name in the dataSource. It applies custom CSS class name to appointments depicting to the resource it belongs. - * @Default {null} - */ - appointmentClass?: string; -} - -export interface Resource { - - /** It holds the name of the resource field to be bound to the Schedule appointments that contains the resource Id. - * @Default {null} - */ - field?: string; - - /** It holds the title name of the resource field to be displayed on the Schedule appointment window. - * @Default {null} - */ - title?: string; - - /** A unique resource name that is used for differentiating various resource objects while grouping it in various levels. - * @Default {null} - */ - name?: string; - - /** When set to true, allows multiple selection of resource names, thus creating multiple instances of same appointment for the selected resources. - * @Default {false} - */ - allowMultiple?: boolean; - - /** It holds the field names of the resources to be bound to the Schedule and also the dataSource. - */ - resourceSettings?: ResourcesResourceSettings; -} - -export interface TimeZoneCollection { - - /** Sets the collection of timezone items to the dataSource that accepts either JSON object collection or DataManager (ej.DataManager) instance that contains Schedule timezones. - */ - dataSource?: any; - - /** Binds text field name in the dataSource to timeZoneCollection text. These text gets listed out in the timezone fields of the appointment window. - * @Default {text} - */ - text?: string; - - /** Binds id field name in the dataSource to timeZoneCollection id. - * @Default {id} - */ - id?: string; - - /** Binds value field name in the dataSource to timeZoneCollection value. - * @Default {value} - */ - value?: string; -} - -export interface AgendaViewSettings { - - /** You can display the summary of multiple week's appointment by setting this value. - * @Default {7} - */ - daysInAgenda?: number; - - /** You can customize the Date column display based on the requirement. - * @Default {null} - */ - dateColumnTemplateId?: string; - - /** You can customize the time column display based on the requirement. - * @Default {null} - */ - timeColumnTemplateId?: string; -} - -export interface TooltipSettings { - - /** Enables or disables the tooltip display. - * @Default {false} - */ - enable?: boolean; - - /** Template design that customizes the tooltip. All the field names that are mapped from dataSource to the appropriate field properties within - * the appointmentSettings can be accessed within the template. - * @Default {null} - */ - templateId?: string; -} - -export interface TimeScale { - - /** When set to true, displays the time slots on the Scheduler. - * @Default {true} - */ - enable?: boolean; - - /** When set with some specific value, defines the number of time divisions split per hour(as per value given for the majorTimeSlot). Those time divisions are meant to be the minor slots. - * @Default {2} - */ - minorSlotCount?: number; - - /** Accepts the value in minutes. When provided with specific value, displays the appropriate time interval on the Scheduler - * @Default {60} - */ - majorSlot?: number; - - /** Template design that customizes the timecells (minor slots) that are partitioned based on minorSlotCount. Accepts id value of the template defined for minor time slots. - * @Default {null} - */ - minorSlotTemplateId?: string; - - /** Template design that customizes the timecells (major slots). Accepts id value of the template defined for major time slots. - * @Default {null} - */ - majorSlotTemplateId?: string; -} - -export interface BlockoutSettings { - - /** When set to true, enables the blockout option to be applied on the Scheduler cells. - * @Default {false} - */ - enable?: boolean; - - /** Template design that applies on the Schedule block intervals. All the field names that are mapped from dataSource to the appropriate field - * properties within the blockoutSettings can be used within the template. - * @Default {null} - */ - templateId?: string; + /** Returns the name of the Scheduler event. + */ + type?: string; + } + + export interface AppointmentChangedEventArgs { + + /** Returns the edited appointment object. + */ + appointment?: any; + + /** Returns the cancel option value. + */ + cancel?: boolean; + + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; + + /** Returns the name of the Scheduler event. + */ + type?: string; + } + + export interface AppointmentRemovedEventArgs { + + /** Returns the cancel option value. + */ + cancel?: boolean; + + /** Returns the deleted appointment object. + */ + appointment?: any; + + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; + + /** Returns the name of the Scheduler event. + */ + type?: string; + } + + export interface AppointmentSettings { + + /** The dataSource option accepts either JSON object collection or DataManager (ej.DataManager) instance that contains Schedule appointments. + * @Default {[]} + */ + dataSource?: any | any[]; + + /** It holds either the ej.Query() object or simply the query string that retrieves the specified records from the table. + * @Default {null} + */ + query?: string; + + /** Assign the table name from where the records are to be fetched for the Schedule. + * @Default {null} + */ + tableName?: string; + + /** When set to false, doesn't consider the time difference offset calculation on appointment time. + * @Default {true} + */ + applyTimeOffset?: boolean; + + /** Binds the id field name in dataSource to the id of Schedule appointments. It denotes the unique id assigned to appointments. + * @Default {null} + */ + id?: string; + + /** Binds the name of startTime field in the dataSource with start time of the Schedule appointments. It indicates the date and Time when Schedule appointment actually starts. + * @Default {null} + */ + startTime?: string; + + /** Binds the name of endTime field in dataSource with the end time of Schedule appointments. It indicates the date and time when Schedule appointment actually ends. + * @Default {null} + */ + endTime?: string; + + /** Binds the name of subject field in the dataSource to appointment Subject. Indicates the Subject or title that gets displayed on Schedule appointments. + * @Default {null} + */ + subject?: string; + + /** Binds the description field name in dataSource. It indicates the appointment description. + * @Default {null} + */ + description?: string; + + /** Binds the name of recurrence field in dataSource. It indicates whether the appointment is a recurrence appointment or not. + * @Default {null} + */ + recurrence?: string; + + /** Binds the name of recurrenceRule field in dataSource. It indicates the recurrence pattern associated with appointments. + * @Default {null} + */ + recurrenceRule?: string; + + /** Binds the name of allDay field in dataSource. It indicates whether the appointment is an all-day appointment or not. + * @Default {null} + */ + allDay?: string; + + /** Binds one or more fields in resource collection dataSource. It maps the resource field names with appointments denoting the resource of appointments actually belongs. + * @Default {null} + */ + resourceFields?: string; + + /** Binds the name of categorize field in dataSource. It indicates the categorize value, red categorize, green, yellow and so on applied to the appointments. + * @Default {null} + */ + categorize?: string; + + /** Binds the name of location field in dataSource. It indicates the appointment location. + * @Default {null} + */ + location?: string; + + /** Binds the name of the priority field in dataSource. It indicates the priority, high, low, medium and none of the appointments. + * @Default {null} + */ + priority?: string; + + /** Binds the name of start timezone field in dataSource. It indicates the timezone of appointment start date. When startTimeZone field is not mentioned, + * the appointment uses the Schedule timeZone or System timeZone. + * @Default {null} + */ + startTimeZone?: string; + + /** Binds the name of end timezone field in dataSource. It indicates the timezone of appointment end date. When the endTimeZone field is not mentioned, + * the appointment uses the Schedule timeZone or System timeZone. + * @Default {null} + */ + endTimeZone?: string; + } + + export interface CategorizeSettings { + + /** When set to true, enables the multiple selection of categories to be applied for the appointments. + * @Default {false} + */ + allowMultiple?: boolean; + + /** When set to true, enables the categories option to be applied for the appointments. + * @Default {false} + */ + enable?: boolean; + + /** The dataSource option accepts either the JSON object collection or DataManager [ej.DataManager] instance that contains the categorize data. + */ + dataSource?: any[] | any; + + /** Binds id field name in the dataSource to id of category data. + * @Default {id} + */ + id?: string; + + /** Binds text field name in the dataSource to category text. + * @Default {text} + */ + text?: string; + + /** Binds color field name in the dataSource to category color. + * @Default {color} + */ + color?: string; + + /** Binds fontColor field name in the dataSource to category font. + * @Default {fontColor} + */ + fontColor?: string; + } + + export interface ContextMenuSettingsMenuItems { + + /** All the appointment related context menu items are grouped under this appointment menu collection. + */ + appointment?: any[]; + + /** All the Scheduler cell related context menu items are grouped under this cells menu item collection. + */ + cells?: any[]; + } + + export interface ContextMenuSettings { + + /** When set to true, enables the context menu options available for the Schedule cells and appointments. + * @Default {false} + */ + enable?: boolean; + + /** Contains all the default context menu options that are applicable for both Schedule cells and appointments. It also supports adding custom menu items to cells or appointment collection. + */ + menuItems?: ContextMenuSettingsMenuItems; + } + + export interface Group { + + /** Holds the array of resource names to be grouped on the Schedule. + */ + resources?: any[]; + } + + export interface WorkHours { + + /** When set to true, highlights the work hours of the Schedule. + * @Default {true} + */ + highlight?: boolean; + + /** Sets the start time to depict the start of working or business hour in a day. + * @Default {9} + */ + start?: number; + + /** Sets the end time to depict the end of working or business hour in a day. + * @Default {18} + */ + end?: number; + } + + export interface PrioritySettings { + + /** When set to true, enables the priority options available for the Schedule appointments. + * @Default {false} + */ + enable?: boolean; + + /** The dataSource option can accept the JSON object collection that contains the priority related data. + * @Default {{% highlight js%}[{ text: None, value: none },{ text: High, value: high },{ text: Medium, value: medium },{ text: Low, value: low }]{% endhighlight %}} + */ + dataSource?: any | any[]; + + /** Binds text field name in the dataSource to prioritySettings text. These text gets listed out in priority field of the appointment window. + * @Default {text} + */ + text?: string; + + /** Binds value field name in the dataSource to prioritySettings value. These field names usually accepts four priority values by default, high, low, medium and none. + * @Default {value} + */ + value?: string; + + /** Allows priority field customization in the appointment window to add custom icons denoting the priority level for the appointments. + * @Default {null} + */ + template?: string; + } + + export interface ReminderSettings { + + /** When set to true, enables the reminder option available for the Schedule appointments. + * @Default {false} + */ + enable?: boolean; + + /** Sets the timing, when the reminders are to be alerted for the Schedule appointments. + * @Default {5} + */ + alertBefore?: number; + } + + export interface RenderDates { + + /** Sets the start of custom date range to be rendered in the Schedule. + * @Default {null} + */ + start?: any; + + /** Sets the end limit of the custom date range. + * @Default {null} + */ + end?: any; + } + + export interface ResourcesResourceSettings { + + /** The dataSource option accepts either JSON object collection or DataManager (ejDataManager) instance that contains the resources related data. + * @Default {[]} + */ + dataSource?: any | any[]; + + /** Binds text field name in the dataSource to resourceSettings text. These text gets listed out in resources field of the appointment window. + * @Default {null} + */ + text?: string; + + /** Binds id field name in the dataSource to resourceSettings id. + * @Default {null} + */ + id?: string; + + /** Binds groupId field name in the dataSource to resourceSettings groupId. + * @Default {null} + */ + groupId?: string; + + /** Binds color field name in the dataSource to resourceSettings color. The color specified here gets applied to the Schedule appointments denoting to the resource it belongs. + * @Default {null} + */ + color?: string; + + /** Binds the starting work hour field name in the dataSource. It's optional, but providing it with some numeric value will set the starting work hour for specific resources. + * @Default {null} + */ + start?: string; + + /** Binds the end work hour field name in the dataSource. It's optional, but providing it with some numeric value will set the end work hour for specific resources. + * @Default {null} + */ + end?: string; + + /** Binds the resources working days field name in the dataSource. It's optional, and accepts the array of strings (week day names). When provided with specific collection of + * days (array of day names), only those days will render for the specific resources. + * @Default {null} + */ + workWeek?: string; + + /** Binds appointmentClass field name in the dataSource. It applies custom CSS class name to appointments depicting to the resource it belongs. + * @Default {null} + */ + appointmentClass?: string; + } + + export interface Resource { + + /** It holds the name of the resource field to be bound to the Schedule appointments that contains the resource Id. + * @Default {null} + */ + field?: string; + + /** It holds the title name of the resource field to be displayed on the Schedule appointment window. + * @Default {null} + */ + title?: string; + + /** A unique resource name that is used for differentiating various resource objects while grouping it in various levels. + * @Default {null} + */ + name?: string; + + /** When set to true, allows multiple selection of resource names, thus creating multiple instances of same appointment for the selected resources. + * @Default {false} + */ + allowMultiple?: boolean; + + /** It holds the field names of the resources to be bound to the Schedule and also the dataSource. + */ + resourceSettings?: ResourcesResourceSettings; + } + + export interface TimeZoneCollection { + + /** Sets the collection of timezone items to the dataSource that accepts either JSON object collection or DataManager (ej.DataManager) instance that contains Schedule timezones. + */ + dataSource?: any; + + /** Binds text field name in the dataSource to timeZoneCollection text. These text gets listed out in the timezone fields of the appointment window. + * @Default {text} + */ + text?: string; + + /** Binds id field name in the dataSource to timeZoneCollection id. + * @Default {id} + */ + id?: string; + + /** Binds value field name in the dataSource to timeZoneCollection value. + * @Default {value} + */ + value?: string; + } + + export interface AgendaViewSettings { + + /** You can display the summary of multiple week's appointment by setting this value. + * @Default {7} + */ + daysInAgenda?: number; + + /** You can customize the Date column display based on the requirement. + * @Default {null} + */ + dateColumnTemplateId?: string; + + /** You can customize the time column display based on the requirement. + * @Default {null} + */ + timeColumnTemplateId?: string; + } + + export interface TooltipSettings { + + /** Enables or disables the tooltip display. + * @Default {false} + */ + enable?: boolean; + + /** Template design that customizes the tooltip. All the field names that are mapped from dataSource to the appropriate field properties within + * the appointmentSettings can be accessed within the template. + * @Default {null} + */ + templateId?: string; + } + + export interface TimeScale { + + /** When set to true, displays the time slots on the Scheduler. + * @Default {true} + */ + enable?: boolean; + + /** When set with some specific value, defines the number of time divisions split per hour(as per value given for the majorTimeSlot). Those time divisions are meant to be the minor slots. + * @Default {2} + */ + minorSlotCount?: number; + + /** Accepts the value in minutes. When provided with specific value, displays the appropriate time interval on the Scheduler + * @Default {60} + */ + majorSlot?: number; + + /** Template design that customizes the timecells (minor slots) that are partitioned based on minorSlotCount. Accepts id value of the template defined for minor time slots. + * @Default {null} + */ + minorSlotTemplateId?: string; + + /** Template design that customizes the timecells (major slots). Accepts id value of the template defined for major time slots. + * @Default {null} + */ + majorSlotTemplateId?: string; + } + + export interface BlockoutSettings { + + /** When set to true, enables the blockout option to be applied on the Scheduler cells. + * @Default {false} + */ + enable?: boolean; + + /** Template design that applies on the Schedule block intervals. All the field names that are mapped from dataSource to the appropriate field + * properties within the blockoutSettings can be used within the template. + * @Default {null} + */ + templateId?: string; - /** The dataSource option accepts either JSON object collection or DataManager (ej.DataManager) instance that contains Schedule block intervals. - * @Default {[]} - */ - dataSource?: any|any[]; - - /** It holds either the ej.Query() object or simply the query string that retrieves the specified records from the table. - * @Default {null} - */ - query?: string; - - /** Assign the table name from where the records are to be fetched for the Schedule. - * @Default {null} - */ - tableName?: string; - - /** Binds the id field name in dataSource to the id of block time interval. It denotes the unique id assigned to each of the block records. - * @Default {null} - */ - id?: string; - - /** Binds the name of startTime field in the dataSource with start time of block time interval. It indicates the date and time, when the block interval actually starts in the Scheduler. - * @Default {null} - */ - startTime?: string; - - /** Binds the name of endTime field in dataSource with the end time of block time interval. It indicates the date and time, when the block interval actually ends in the Scheduler. - * @Default {null} - */ - endTime?: string; - - /** Binds the name of subject field in the dataSource to block time Subject. Indicates the Subject or title that gets displayed on the Schedule block intervals. - * @Default {null} - */ - subject?: string; - - /** Binds the name of isBlockAppointment field in dataSource. When set to true, disables the appointments that lies on the blocked area and restrict to perform CRUD operations in it. - * @Default {null} - */ - isBlockAppointment?: string; - - /** Binds the name of isAllDay field in dataSource. It indicates whether an entire day is blocked or not. - * @Default {null} - */ - isAllDay?: string; - - /** Binds the name of resourceId field in dataSource. Specifies the id of the resources, to which the time intervals are needed to be blocked. - * @Default {null} - */ - resourceId?: string; - - /** Binds the name of customStyle field in dataSource. It applies the custom CSS to the block intervals. - * @Default {null} - */ - customStyle?: string; -} - -enum CurrentView { - - ///Sets currentView of the Scheduler as Day - Day, - - ///Sets currentView of the Scheduler as Week - Week, - - ///Sets currentView of the Scheduler as WorkWeek - Workweek, - - ///Sets currentView of the Scheduler as Month - Month, - - ///Sets currentView of the Scheduler as Agenda - Agenda, - - ///Sets currentView of the Scheduler as CustomView with user-specified date range. - CustomView -} - - -enum Orientation { - - ///Set orientation as vertical to Scheduler - Vertical, - - ///Set orientation as horizontal to Scheduler - Horizontal -} - - -enum TimeMode { - - ///Sets 12 hour time mode to Scheduler - Hour12, - - ///Sets 24 hour time mode to Scheduler - Hour24 -} - -} - -class RecurrenceEditor extends ej.Widget { - static fn: RecurrenceEditor; - constructor(element: JQuery | Element, options?: RecurrenceEditor.Model); - static Locale: any; - model: RecurrenceEditor.Model; - defaults: RecurrenceEditor.Model; - - /** Generates the recurrence rule with the options selected within the Recurrence Editor. - * @returns {String} - */ - getRecurrenceRule(): string; - - /** Generates the collection of date, that lies within the selected recurrence start and end date for which the recurrence pattern applies. - * @param {string} It refers the recurrence rule. - * @param {any} It refers the start date of the recurrence. - * @returns {any} - */ - recurrenceDateGenerator(recurrenceString: string, startDate: any): any; - - /** It splits and returns the recurrence rule string into object collection. - * @param {string} It refers the recurrence rule string. - * @param {any} It refers the appointment dates (ExDate) to be excluded - * @returns {any} - */ - recurrenceRuleSplit(recurrenceRule: string, exDate: any): any; -} -export namespace RecurrenceEditor { - -export interface Model { - - /** Defines the collection of recurrence frequencies within Recurrence Editor such as Never, Daily, Weekly, Monthly, Yearly and Every Weekday. - * @Default {[never, daily, weekly, monthly, yearly, everyweekday]} - */ - frequencies?: any[]; - - /** Sets the starting day of the week. - * @Default {null} - */ - firstDayOfWeek?: string; - - /** When set to true, enables the spin button of numeric textboxes within the Recurrence Editor. - * @Default {true} - */ - enableSpinners?: boolean; - - /** Sets the start date of the recurrence. The Recurrence Editor initially displays the current date as its start date. - * @Default {new Date()} - */ - startDate?: any; - - /** Sets the specific culture to the Recurrence Editor. - * @Default {en-US} - */ - locale?: string; - - /** Sets the date format for the datepickers available within the Recurrence Editor. - */ - dateFormat?: string; - - /** When set to true, renders the Recurrence Editor options from Right-to-Left direction. - * @Default {false} - */ - enableRTL?: boolean; - - /** Sets the active/current repeat type(frequency) on Recurrence Editor based on the index value provided. For example, setting the value 1 will initially set the repeat type - * as Daily and display its related options. - * @Default {0} - */ - selectedRecurrenceType?: number; - - /** Sets the minimum date limit to display on the datepickers defined within the Recurrence Editor. Setting minDate with specific date value disallows the datepickers within - * Recurrence Editor to navigate beyond that date. - * @Default {new Date(1900, 01, 01)} - */ - minDate?: any; - - /** Sets the maximum date limit to display on the datepickers used within the Recurrence Editor. Setting maxDate with specific date value disallows the - * datepickers within the Recurrence Editor to navigate beyond that date. - * @Default {new Date(2099, 12, 31)} - */ - maxDate?: any; - - /** Accepts the custom CSS class name, that defines user-defined styles and themes to be applied on partial or complete elements of the Recurrence Editor. - */ - cssClass?: string; - - /** Triggers whenever any of the Recurrence Editor's value is changed. */ - change?(e: ChangeEventArgs): void; -} - -export interface ChangeEventArgs { - - /** When set to true, event gets canceled. - */ - cancel?: boolean; - - /** Returns the Recurrence Editor model - */ - model?: ej.RecurrenceEditor.Model; - - /** Returns the name of the event - */ - type?: string; - - /** Returns the recurrence rule value. - */ - recurrenceRule?: string; -} -} - -class Gantt extends ej.Widget { - static fn: Gantt; - constructor(element: JQuery | Element, options?: Gantt.Model); - static Locale: any; - model: Gantt.Model; - defaults: Gantt.Model; - - /** To add a new item in Gantt - * @param {any} Item to add in Gantt row. - * @param {string} Defines in which position the row wants to add - * @returns {void} - */ - addRecord(data: any, rowPosition: string): void; - - /** To select cell based on the cell and row index dynamically. - * @param {Array} array of cell indexes to be select - * @param {boolean} Defines that we need to preserve the previously selected cells of not - * @returns {void} - */ - selectCells(Indexes: any[], preservePreviousSelectedCell: boolean): void; - - /** Positions the splitter by the specified column index. - * @param {number} Set the splitter position based on column index. - * @returns {void} - */ - setSplitterIndex(index: number): void; - - /** To cancel the edited state of an item in Gantt - * @returns {void} - */ - cancelEdit(): void; - - /** To collapse all the parent items in Gantt - * @returns {void} - */ - collapseAllItems(): void; - - /** To delete a selected item in Gantt - * @returns {void} - */ - deleteItem(): void; - - /** destroy the Gantt widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. - * @returns {void} - */ - destroy(): void; - - /** To Expand all the parent items in Gantt - * @returns {void} - */ - expandAllItems(): void; - - /** To expand and collapse an item in Gantt using item's ID - * @param {number} Expand or Collapse a record based on task id. - * @returns {void} - */ - expandCollapseRecord(taskId: number): void; - - /** To hide the column by using header text - * @param {string} you can pass a header text of a column to hide - * @returns {void} - */ - hideColumn(headerText: string): void; - - /** To indent a selected item in Gantt - * @returns {void} - */ - indentItem(): void; - - /** To Open the dialog to add new task to the Gantt - * @returns {void} - */ - openAddDialog(): void; - - /** To Open the dialog to edit existing task to the Gantt - * @returns {void} - */ - openEditDialog(): void; - - /** To outdent a selected item in Gantt - * @returns {void} - */ - outdentItem(): void; - - /** To save the edited state of an item in Gantt - * @returns {void} - */ - saveEdit(): void; - - /** To search an item with search string provided at the run time - * @param {string} you can pass a text to search in Gantt Control. - * @returns {void} - */ - searchItem(searchString: string): void; - - /** To set the grid width in Gantt - * @param {string} you can give either percentage or pixels value - * @returns {void} - */ - setSplitterPosition(width: string): void; - - /** To show the column by using header text - * @param {string} you can pass a header text of a column to show - * @returns {void} - */ - showColumn(headerText: string): void; -} -export namespace Gantt { - -export interface Model { - - /** Specifies the fields to be included in the add dialog in Gantt - * @Default {[]} - */ - addDialogFields?: any[]; - - /** Enables or disables the ability to resize column. - * @Default {false} - */ - allowColumnResize?: boolean; - - /** Enables or Disables Gantt chart editing in Gantt - * @Default {true} - */ - allowGanttChartEditing?: boolean; - - /** Enables or Disables Keyboard navigation in Gantt - * @Default {true} - */ - allowKeyboardNavigation?: boolean; - - /** Specifies enabling or disabling multiple sorting for Gantt columns - * @Default {false} - */ - allowMultiSorting?: boolean; - - /** Enables or disables the option for multiple exporting - * @Default {false} - */ - allowMultipleExporting?: boolean; - - /** Enables or disables the interactive selection of a row. - * @Default {true} - */ - allowSelection?: boolean; - - /** Enables or disables sorting. When enabled, we can sort the column by clicking on the column. - * @Default {false} - */ - allowSorting?: boolean; - - /** Enables or disables the ability to drag and drop the row interactively to reorder the rows - * @Default {false} - */ - allowDragAndDrop?: boolean; - - /** Enable or disable predecessor validation. When it is true, all the task's start and end dates are aligned based on its predecessors start and end dates. - * @Default {true} - */ - enablePredecessorValidation?: boolean; - - /** Specifies the baseline background color in Gantt - * @Default {#fba41c} - */ - baselineColor?: string; - - /** Specifies the mapping property path for baseline end date in datasource - */ - baselineEndDateMapping?: string; - - /** Specifies the mapping property path for baseline start date of a task in datasource - */ - baselineStartDateMapping?: string; - - /** Specifies the mapping property path for sub tasks in datasource - */ - childMapping?: string; - - /** To Specify the column fields to be displayed in the dialog while inserting a column using column menu. - * @Default {[]} - */ - columnDialogFields?: any[]; - - /** Specifies the background of connector lines in Gantt - */ - connectorLineBackground?: string; - - /** Specifies the width of the connector lines in Gantt - * @Default {1} - */ - connectorlineWidth?: number; - - /** Specify the CSS class for Gantt to achieve custom theme. - */ - cssClass?: string; - - /** Specifies the template for cell tooltip - * @Default {null} - */ - cellTooltipTemplate?: string; - - /** Option for customizing the drag tooltip while reordering the rows. - */ - dragTooltip?: DragTooltip; - - /** Collection of data or hierarchical data to represent in Gantt - * @Default {null} - */ - dataSource?: any[]; - - /** Specifies the dateFormat for Gantt , given format is displayed in tooltip , Grid . - * @Default {MM/dd/yyyy} - */ - dateFormat?: string; - - /** Specifies the mapping property path for duration of a task in datasource - */ - durationMapping?: string; - - /** Specifies the duration unit for each tasks whether days or hours or minutes - * @Default {ej.Gantt.DurationUnit.Day} - */ - durationUnit?: ej.Gantt.DurationUnit|string; - - /** Specifies the fields to be included in the edit dialog in Gantt - * @Default {[]} - */ - editDialogFields?: any[]; - - /** Enables or disables the responsiveness of Gantt - * @Default {false} - */ - isResponsive?: boolean; - - /** Option to configure the splitter position. - */ - splitterSettings?: SplitterSettings; - - /** Specifies the editSettings options in Gantt. - */ - editSettings?: EditSettings; - - /** Enables or Disables enableAltRow row effect in Gantt - * @Default {true} - */ - enableAltRow?: boolean; - - /** Enables/disables work breakdown structure column. - * @Default {false} - */ - enableWBS?: boolean; - - /** Enables/disables WBS predecessor column. - * @Default {false} - */ - enableWBSPredecessor?: boolean; - - /** Enables or disables the collapse all records when loading the Gantt. - * @Default {false} - */ - enableCollapseAll?: boolean; - - /** Specifies the data source field name to be displayed as left task label - */ - leftTaskLabelMapping?: string; - - /** Specifies the data source field name to be displayed as right task label - */ - rightTaskLabelMapping?: string; - - /** Specifies the template for left task label - */ - leftTaskLabelTemplate?: string; - - /** Specifies the template for right task label - */ - rightTaskLabelTemplate?: string; - - /** Enables or disables the contextmenu for Gantt , when enabled contextmenu appears on right clicking Gantt - * @Default {false} - */ - enableContextMenu?: boolean; - - /** Indicates whether we can edit the progress of a task interactively in Gantt. - * @Default {true} - */ - enableProgressBarResizing?: boolean; - - /** Enables or disables the option for dynamically updating the Gantt size on window resizing - * @Default {false} - */ - enableResize?: boolean; - - /** Enables or disables tooltip while editing (dragging/resizing) the taskbar. - * @Default {true} - */ - enableTaskbarDragTooltip?: boolean; - - /** Enables or disables tooltip for taskbar. - * @Default {true} - */ - enableTaskbarTooltip?: boolean; - - /** Enables/Disables virtualization for rendering Gantt items. - * @Default {false} - */ - enableVirtualization?: boolean; - - /** Specifies the mapping property path for end Date of a task in datasource - */ - endDateMapping?: string; - - /** Specifies whether to highlight the weekends in Gantt . - * @Default {true} - */ - highlightWeekends?: boolean; - - /** Collection of holidays with date, background and label information to be displayed in Gantt. - * @Default {[]} - */ - holidays?: any[]; - - /** Specifies whether to include weekends while calculating the duration of a task. - * @Default {true} - */ - includeWeekend?: boolean; - - /** Specify the locale for Gantt - * @Default {en-US} - */ - locale?: string; - - /** Specifies the mapping property path for milestone in datasource - */ - milestoneMapping?: string; - - /** Enables/disables the options for inserting , deleting and renaming columns. - * @Default {false} - */ - showColumnOptions?: boolean; - - /** Specifies the template for parent taskbar - */ - parentTaskbarTemplate?: string; - - /** Specifies the nature of a task for calculating the work, and it can fixed duration, fixed work and fixed resource unit - * @Default {ej.Gantt.TaskType.FixedUnit} - */ - taskType?: ej.Gantt.TaskType|string; - - /** Specifies the unit for the work involved in a task and it can be day, hour or minute - * @Default {ej.Gantt.WorkUnit.Hour} - */ - workUnit?: ej.Gantt.WorkUnit|string; - - /** Specifies the task scheduling mode for a project and this will be set to all the tasks available in the project - * @Default {ej.Gantt.TaskSchedulingMode.Auto} - */ - taskSchedulingMode?: ej.Gantt.TaskSchedulingMode|string; - - /** Specifies the row selection type. - * @Default {ej.Gantt.SelectionType.Single} - */ - selectionType?: ej.Gantt.SelectionType|string; - - /** Specifies the background of parent progressbar in Gantt - */ - parentProgressbarBackground?: string; - - /** Specifies the mapping property path for resource's percent effort involved in a task in datasource - */ - resourceUnitMapping?: string; - - /** Specifies the mapping property path for the task description in datasource - */ - notesMapping?: string; - - /** Specifies the mapping property path for the task scheduling mode for a task in datasource - * @Default {auto} - */ - taskSchedulingModeMapping?: string; - - /** Specifies the mapping property path for task duration unit in datasource - */ - durationUnitMapping?: string; - - /** Specifies the background of parent taskbar in Gantt - */ - parentTaskbarBackground?: string; - - /** Specifies the mapping property path for parent task Id in self reference datasource - */ - parentTaskIdMapping?: string; - - /** Specifies the mapping property path for predecessors of a task in datasource - */ - predecessorMapping?: string; - - /** Specifies the background of progressbar in Gantt - */ - progressbarBackground?: string; - - /** Specified the height of the progressbar in taskbar - * @Default {100} - */ - progressbarHeight?: number; - - /** Specifies the template for tooltip on resizing progressbar - * @Default {null} - */ - progressbarTooltipTemplate?: string; - - /** Specifies the template ID for customized tooltip for progressbar editing in Gantt - * @Default {null} - */ - progressbarTooltipTemplateId?: string; - - /** Specifies the mapping property path for progress percentage of a task in datasource - */ - progressMapping?: string; - - /** It receives query to retrieve data from the table (query is same as SQL). - * @Default {null} - */ - query?: any; - - /** Enables or Disables rendering baselines in Gantt , when enabled baseline is rendered in Gantt - * @Default {false} - */ - renderBaseline?: boolean; - - /** Enables or disables the schedule date validation while connecting a manually scheduled task with predecessor - * @Default {false} - */ - validateManualTasksOnLinking?: boolean; - - /** Specifies the mapping property name for resource ID in resource Collection in Gantt - */ - resourceIdMapping?: string; - - /** Specifies the mapping property path for resources of a task in datasource - */ - resourceInfoMapping?: string; - - /** Specifies the mapping property path for resource name of a task in Gantt - */ - resourceNameMapping?: string; - - /** Collection of data regarding resources involved in entire project - * @Default {[]} - */ - resources?: any[]; - - /** Specifies whether rounding off the day working time edits - * @Default {true} - */ - roundOffDayworkingTime?: boolean; - - /** Specifies the height of a single row in Gantt. Also, we need to set same height in the CSS style with class name e-rowcell. - * @Default {30} - */ - rowHeight?: number; - - /** Specifies end date of the Gantt schedule. By default, end date will be rounded to its next Saturday. - * @Default {null} - */ - scheduleEndDate?: string; - - /** Specifies the options for customizing schedule header. - */ - scheduleHeaderSettings?: ScheduleHeaderSettings; - - /** Specifies start date of the Gantt schedule. By default, start date will be rounded to its previous Sunday. - * @Default {null} - */ - scheduleStartDate?: string; - - /** Specifies the selected row Index in Gantt , the row with given index will highlighted - * @Default {-1} - */ - selectedRowIndex?: number; - - /** Enables or disables the column chooser. - * @Default {false} - */ - showColumnChooser?: boolean; - - /** Specifies the template for cell tooltip - * @Default {true} - */ - showGridCellTooltip?: boolean; - - /** Specifies whether to show grid cell tooltip over expander cell alone. - * @Default {true} - */ - showGridExpandCellTooltip?: boolean; - - /** Specifies whether display task progress inside taskbar. - * @Default {true} - */ - showProgressStatus?: boolean; - - /** Specifies whether to display resource names for a task beside taskbar. - * @Default {true} - */ - showResourceNames?: boolean; - - /** Specifies whether to display task name beside task bar. - * @Default {true} - */ - showTaskNames?: boolean; - - /** Specifies the size option of Gantt control. - */ - sizeSettings?: SizeSettings; - - /** Specifies the selected cell information on rendering Gantt. - */ - selectedCellIndexes?: SelectedCellIndex[]; - - /** Specifies the sorting options for Gantt. - */ - sortSettings?: SortSettings; - - /** Specifies splitter position in Gantt. - * @Default {null} - */ - splitterPosition?: string; - - /** Specifies the mapping property path for start date of a task in datasource - */ - startDateMapping?: string; - - /** Specifies the options for striplines - * @Default {[]} - */ - stripLines?: any[]; - - /** Specifies the background of the taskbar in Gantt - */ - taskbarBackground?: string; - - /** Specifies the template script for customized tooltip for taskbar editing in Gantt - */ - taskbarEditingTooltipTemplate?: string; - - /** Specifies the template Id for customized tooltip for taskbar editing in Gantt - */ - taskbarEditingTooltipTemplateId?: string; - - /** Specifies the template for tooltip on mouse action on taskbars - */ - taskbarTooltipTemplate?: string; + /** The dataSource option accepts either JSON object collection or DataManager (ej.DataManager) instance that contains Schedule block intervals. + * @Default {[]} + */ + dataSource?: any | any[]; + + /** It holds either the ej.Query() object or simply the query string that retrieves the specified records from the table. + * @Default {null} + */ + query?: string; + + /** Assign the table name from where the records are to be fetched for the Schedule. + * @Default {null} + */ + tableName?: string; + + /** Binds the id field name in dataSource to the id of block time interval. It denotes the unique id assigned to each of the block records. + * @Default {null} + */ + id?: string; + + /** Binds the name of startTime field in the dataSource with start time of block time interval. It indicates the date and time, when the block interval actually starts in the Scheduler. + * @Default {null} + */ + startTime?: string; + + /** Binds the name of endTime field in dataSource with the end time of block time interval. It indicates the date and time, when the block interval actually ends in the Scheduler. + * @Default {null} + */ + endTime?: string; + + /** Binds the name of subject field in the dataSource to block time Subject. Indicates the Subject or title that gets displayed on the Schedule block intervals. + * @Default {null} + */ + subject?: string; + + /** Binds the name of isBlockAppointment field in dataSource. When set to true, disables the appointments that lies on the blocked area and restrict to perform CRUD operations in it. + * @Default {null} + */ + isBlockAppointment?: string; + + /** Binds the name of isAllDay field in dataSource. It indicates whether an entire day is blocked or not. + * @Default {null} + */ + isAllDay?: string; + + /** Binds the name of resourceId field in dataSource. Specifies the id of the resources, to which the time intervals are needed to be blocked. + * @Default {null} + */ + resourceId?: string; + + /** Binds the name of customStyle field in dataSource. It applies the custom CSS to the block intervals. + * @Default {null} + */ + customStyle?: string; + } + + enum CurrentView { + + ///Sets currentView of the Scheduler as Day + Day, + + ///Sets currentView of the Scheduler as Week + Week, + + ///Sets currentView of the Scheduler as WorkWeek + Workweek, + + ///Sets currentView of the Scheduler as Month + Month, + + ///Sets currentView of the Scheduler as Agenda + Agenda, + + ///Sets currentView of the Scheduler as CustomView with user-specified date range. + CustomView + } + + + enum Orientation { + + ///Set orientation as vertical to Scheduler + Vertical, + + ///Set orientation as horizontal to Scheduler + Horizontal + } + + + enum TimeMode { + + ///Sets 12 hour time mode to Scheduler + Hour12, + + ///Sets 24 hour time mode to Scheduler + Hour24 + } + + } + + class RecurrenceEditor extends ej.Widget { + static fn: RecurrenceEditor; + constructor(element: JQuery | Element, options?: RecurrenceEditor.Model); + static Locale: any; + model: RecurrenceEditor.Model; + defaults: RecurrenceEditor.Model; + + /** Generates the recurrence rule with the options selected within the Recurrence Editor. + * @returns {String} + */ + getRecurrenceRule(): string; + + /** Generates the collection of date, that lies within the selected recurrence start and end date for which the recurrence pattern applies. + * @param {string} It refers the recurrence rule. + * @param {any} It refers the start date of the recurrence. + * @returns {any} + */ + recurrenceDateGenerator(recurrenceString: string, startDate: any): any; + + /** It splits and returns the recurrence rule string into object collection. + * @param {string} It refers the recurrence rule string. + * @param {any} It refers the appointment dates (ExDate) to be excluded + * @returns {any} + */ + recurrenceRuleSplit(recurrenceRule: string, exDate: any): any; + } + export namespace RecurrenceEditor { + + export interface Model { + + /** Defines the collection of recurrence frequencies within Recurrence Editor such as Never, Daily, Weekly, Monthly, Yearly and Every Weekday. + * @Default {[never, daily, weekly, monthly, yearly, everyweekday]} + */ + frequencies?: any[]; + + /** Sets the starting day of the week. + * @Default {null} + */ + firstDayOfWeek?: string; + + /** When set to true, enables the spin button of numeric textboxes within the Recurrence Editor. + * @Default {true} + */ + enableSpinners?: boolean; + + /** Sets the start date of the recurrence. The Recurrence Editor initially displays the current date as its start date. + * @Default {new Date()} + */ + startDate?: any; + + /** Sets the specific culture to the Recurrence Editor. + * @Default {en-US} + */ + locale?: string; + + /** Sets the date format for the datepickers available within the Recurrence Editor. + */ + dateFormat?: string; + + /** When set to true, renders the Recurrence Editor options from Right-to-Left direction. + * @Default {false} + */ + enableRTL?: boolean; + + /** Sets the active/current repeat type(frequency) on Recurrence Editor based on the index value provided. For example, setting the value 1 will initially set the repeat type + * as Daily and display its related options. + * @Default {0} + */ + selectedRecurrenceType?: number; + + /** Sets the minimum date limit to display on the datepickers defined within the Recurrence Editor. Setting minDate with specific date value disallows the datepickers within + * Recurrence Editor to navigate beyond that date. + * @Default {new Date(1900, 01, 01)} + */ + minDate?: any; + + /** Sets the maximum date limit to display on the datepickers used within the Recurrence Editor. Setting maxDate with specific date value disallows the + * datepickers within the Recurrence Editor to navigate beyond that date. + * @Default {new Date(2099, 12, 31)} + */ + maxDate?: any; + + /** Accepts the custom CSS class name, that defines user-defined styles and themes to be applied on partial or complete elements of the Recurrence Editor. + */ + cssClass?: string; + + /** Triggers whenever any of the Recurrence Editor's value is changed. */ + change?(e: ChangeEventArgs): void; + } + + export interface ChangeEventArgs { + + /** When set to true, event gets canceled. + */ + cancel?: boolean; + + /** Returns the Recurrence Editor model + */ + model?: ej.RecurrenceEditor.Model; + + /** Returns the name of the event + */ + type?: string; + + /** Returns the recurrence rule value. + */ + recurrenceRule?: string; + } + } + + class Gantt extends ej.Widget { + static fn: Gantt; + constructor(element: JQuery | Element, options?: Gantt.Model); + static Locale: any; + model: Gantt.Model; + defaults: Gantt.Model; + + /** To add a new item in Gantt + * @param {any} Item to add in Gantt row. + * @param {string} Defines in which position the row wants to add + * @returns {void} + */ + addRecord(data: any, rowPosition: string): void; + + /** To select cell based on the cell and row index dynamically. + * @param {Array} array of cell indexes to be select + * @param {boolean} Defines that we need to preserve the previously selected cells of not + * @returns {void} + */ + selectCells(Indexes: any[], preservePreviousSelectedCell: boolean): void; + + /** Positions the splitter by the specified column index. + * @param {number} Set the splitter position based on column index. + * @returns {void} + */ + setSplitterIndex(index: number): void; + + /** To cancel the edited state of an item in Gantt + * @returns {void} + */ + cancelEdit(): void; + + /** To collapse all the parent items in Gantt + * @returns {void} + */ + collapseAllItems(): void; + + /** To delete a selected item in Gantt + * @returns {void} + */ + deleteItem(): void; + + /** destroy the Gantt widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. + * @returns {void} + */ + destroy(): void; + + /** To Expand all the parent items in Gantt + * @returns {void} + */ + expandAllItems(): void; + + /** To expand and collapse an item in Gantt using item's ID + * @param {number} Expand or Collapse a record based on task id. + * @returns {void} + */ + expandCollapseRecord(taskId: number): void; + + /** To hide the column by using header text + * @param {string} you can pass a header text of a column to hide + * @returns {void} + */ + hideColumn(headerText: string): void; + + /** To indent a selected item in Gantt + * @returns {void} + */ + indentItem(): void; + + /** To Open the dialog to add new task to the Gantt + * @returns {void} + */ + openAddDialog(): void; + + /** To Open the dialog to edit existing task to the Gantt + * @returns {void} + */ + openEditDialog(): void; + + /** To outdent a selected item in Gantt + * @returns {void} + */ + outdentItem(): void; + + /** To save the edited state of an item in Gantt + * @returns {void} + */ + saveEdit(): void; + + /** To search an item with search string provided at the run time + * @param {string} you can pass a text to search in Gantt Control. + * @returns {void} + */ + searchItem(searchString: string): void; + + /** To set the grid width in Gantt + * @param {string} you can give either percentage or pixels value + * @returns {void} + */ + setSplitterPosition(width: string): void; + + /** To show the column by using header text + * @param {string} you can pass a header text of a column to show + * @returns {void} + */ + showColumn(headerText: string): void; + } + export namespace Gantt { + + export interface Model { + + /** Specifies the fields to be included in the add dialog in Gantt + * @Default {[]} + */ + addDialogFields?: any[]; + + /** Enables or disables the ability to resize column. + * @Default {false} + */ + allowColumnResize?: boolean; + + /** Enables or Disables Gantt chart editing in Gantt + * @Default {true} + */ + allowGanttChartEditing?: boolean; + + /** Enables or Disables Keyboard navigation in Gantt + * @Default {true} + */ + allowKeyboardNavigation?: boolean; + + /** Specifies enabling or disabling multiple sorting for Gantt columns + * @Default {false} + */ + allowMultiSorting?: boolean; + + /** Enables or disables the option for multiple exporting + * @Default {false} + */ + allowMultipleExporting?: boolean; + + /** Enables or disables the interactive selection of a row. + * @Default {true} + */ + allowSelection?: boolean; + + /** Enables or disables sorting. When enabled, we can sort the column by clicking on the column. + * @Default {false} + */ + allowSorting?: boolean; + + /** Enables or disables the ability to drag and drop the row interactively to reorder the rows + * @Default {false} + */ + allowDragAndDrop?: boolean; + + /** Enable or disable predecessor validation. When it is true, all the task's start and end dates are aligned based on its predecessors start and end dates. + * @Default {true} + */ + enablePredecessorValidation?: boolean; + + /** Specifies the baseline background color in Gantt + * @Default {#fba41c} + */ + baselineColor?: string; + + /** Specifies the mapping property path for baseline end date in datasource + */ + baselineEndDateMapping?: string; + + /** Specifies the mapping property path for baseline start date of a task in datasource + */ + baselineStartDateMapping?: string; + + /** Specifies the mapping property path for sub tasks in datasource + */ + childMapping?: string; + + /** To Specify the column fields to be displayed in the dialog while inserting a column using column menu. + * @Default {[]} + */ + columnDialogFields?: any[]; + + /** Specifies the background of connector lines in Gantt + */ + connectorLineBackground?: string; + + /** Specifies the width of the connector lines in Gantt + * @Default {1} + */ + connectorlineWidth?: number; + + /** Specify the CSS class for Gantt to achieve custom theme. + */ + cssClass?: string; + + /** Specifies the template for cell tooltip + * @Default {null} + */ + cellTooltipTemplate?: string; + + /** Option for customizing the drag tooltip while reordering the rows. + */ + dragTooltip?: DragTooltip; + + /** Collection of data or hierarchical data to represent in Gantt + * @Default {null} + */ + dataSource?: any[]; + + /** Specifies the dateFormat for Gantt , given format is displayed in tooltip , Grid . + * @Default {MM/dd/yyyy} + */ + dateFormat?: string; + + /** Specifies the mapping property path for duration of a task in datasource + */ + durationMapping?: string; + + /** Specifies the duration unit for each tasks whether days or hours or minutes + * @Default {ej.Gantt.DurationUnit.Day} + */ + durationUnit?: ej.Gantt.DurationUnit | string; + + /** Specifies the fields to be included in the edit dialog in Gantt + * @Default {[]} + */ + editDialogFields?: any[]; + + /** Enables or disables the responsiveness of Gantt + * @Default {false} + */ + isResponsive?: boolean; + + /** Option to configure the splitter position. + */ + splitterSettings?: SplitterSettings; + + /** Specifies the editSettings options in Gantt. + */ + editSettings?: EditSettings; + + /** Enables or Disables enableAltRow row effect in Gantt + * @Default {true} + */ + enableAltRow?: boolean; + + /** Enables/disables work breakdown structure column. + * @Default {false} + */ + enableWBS?: boolean; + + /** Enables/disables WBS predecessor column. + * @Default {false} + */ + enableWBSPredecessor?: boolean; + + /** Enables or disables the collapse all records when loading the Gantt. + * @Default {false} + */ + enableCollapseAll?: boolean; + + /** Specifies the data source field name to be displayed as left task label + */ + leftTaskLabelMapping?: string; + + /** Specifies the data source field name to be displayed as right task label + */ + rightTaskLabelMapping?: string; + + /** Specifies the template for left task label + */ + leftTaskLabelTemplate?: string; + + /** Specifies the template for right task label + */ + rightTaskLabelTemplate?: string; + + /** Enables or disables the contextmenu for Gantt , when enabled contextmenu appears on right clicking Gantt + * @Default {false} + */ + enableContextMenu?: boolean; + + /** Indicates whether we can edit the progress of a task interactively in Gantt. + * @Default {true} + */ + enableProgressBarResizing?: boolean; + + /** Enables or disables the option for dynamically updating the Gantt size on window resizing + * @Default {false} + */ + enableResize?: boolean; + + /** Enables or disables tooltip while editing (dragging/resizing) the taskbar. + * @Default {true} + */ + enableTaskbarDragTooltip?: boolean; + + /** Enables or disables tooltip for taskbar. + * @Default {true} + */ + enableTaskbarTooltip?: boolean; + + /** Enables/Disables virtualization for rendering Gantt items. + * @Default {false} + */ + enableVirtualization?: boolean; + + /** Specifies the mapping property path for end Date of a task in datasource + */ + endDateMapping?: string; + + /** Specifies whether to highlight the weekends in Gantt . + * @Default {true} + */ + highlightWeekends?: boolean; + + /** Collection of holidays with date, background and label information to be displayed in Gantt. + * @Default {[]} + */ + holidays?: any[]; + + /** Specifies whether to include weekends while calculating the duration of a task. + * @Default {true} + */ + includeWeekend?: boolean; + + /** Specify the locale for Gantt + * @Default {en-US} + */ + locale?: string; + + /** Specifies the mapping property path for milestone in datasource + */ + milestoneMapping?: string; + + /** Enables/disables the options for inserting , deleting and renaming columns. + * @Default {false} + */ + showColumnOptions?: boolean; + + /** Specifies the template for parent taskbar + */ + parentTaskbarTemplate?: string; + + /** Specifies the nature of a task for calculating the work, and it can fixed duration, fixed work and fixed resource unit + * @Default {ej.Gantt.TaskType.FixedUnit} + */ + taskType?: ej.Gantt.TaskType | string; + + /** Specifies the unit for the work involved in a task and it can be day, hour or minute + * @Default {ej.Gantt.WorkUnit.Hour} + */ + workUnit?: ej.Gantt.WorkUnit | string; + + /** Specifies the task scheduling mode for a project and this will be set to all the tasks available in the project + * @Default {ej.Gantt.TaskSchedulingMode.Auto} + */ + taskSchedulingMode?: ej.Gantt.TaskSchedulingMode | string; + + /** Specifies the row selection type. + * @Default {ej.Gantt.SelectionType.Single} + */ + selectionType?: ej.Gantt.SelectionType | string; + + /** Specifies the background of parent progressbar in Gantt + */ + parentProgressbarBackground?: string; + + /** Specifies the mapping property path for resource's percent effort involved in a task in datasource + */ + resourceUnitMapping?: string; + + /** Specifies the mapping property path for the task description in datasource + */ + notesMapping?: string; + + /** Specifies the mapping property path for the task scheduling mode for a task in datasource + * @Default {auto} + */ + taskSchedulingModeMapping?: string; + + /** Specifies the mapping property path for task duration unit in datasource + */ + durationUnitMapping?: string; + + /** Specifies the background of parent taskbar in Gantt + */ + parentTaskbarBackground?: string; + + /** Specifies the mapping property path for parent task Id in self reference datasource + */ + parentTaskIdMapping?: string; + + /** Specifies the mapping property path for predecessors of a task in datasource + */ + predecessorMapping?: string; + + /** Specifies the background of progressbar in Gantt + */ + progressbarBackground?: string; + + /** Specified the height of the progressbar in taskbar + * @Default {100} + */ + progressbarHeight?: number; + + /** Specifies the template for tooltip on resizing progressbar + * @Default {null} + */ + progressbarTooltipTemplate?: string; + + /** Specifies the template ID for customized tooltip for progressbar editing in Gantt + * @Default {null} + */ + progressbarTooltipTemplateId?: string; + + /** Specifies the mapping property path for progress percentage of a task in datasource + */ + progressMapping?: string; + + /** It receives query to retrieve data from the table (query is same as SQL). + * @Default {null} + */ + query?: any; + + /** Enables or Disables rendering baselines in Gantt , when enabled baseline is rendered in Gantt + * @Default {false} + */ + renderBaseline?: boolean; + + /** Enables or disables the schedule date validation while connecting a manually scheduled task with predecessor + * @Default {false} + */ + validateManualTasksOnLinking?: boolean; + + /** Specifies the mapping property name for resource ID in resource Collection in Gantt + */ + resourceIdMapping?: string; + + /** Specifies the mapping property path for resources of a task in datasource + */ + resourceInfoMapping?: string; + + /** Specifies the mapping property path for resource name of a task in Gantt + */ + resourceNameMapping?: string; + + /** Collection of data regarding resources involved in entire project + * @Default {[]} + */ + resources?: any[]; + + /** Specifies whether rounding off the day working time edits + * @Default {true} + */ + roundOffDayworkingTime?: boolean; + + /** Specifies the height of a single row in Gantt. Also, we need to set same height in the CSS style with class name e-rowcell. + * @Default {30} + */ + rowHeight?: number; + + /** Specifies end date of the Gantt schedule. By default, end date will be rounded to its next Saturday. + * @Default {null} + */ + scheduleEndDate?: string; + + /** Specifies the options for customizing schedule header. + */ + scheduleHeaderSettings?: ScheduleHeaderSettings; + + /** Specifies start date of the Gantt schedule. By default, start date will be rounded to its previous Sunday. + * @Default {null} + */ + scheduleStartDate?: string; + + /** Specifies the selected row Index in Gantt , the row with given index will highlighted + * @Default {-1} + */ + selectedRowIndex?: number; + + /** Enables or disables the column chooser. + * @Default {false} + */ + showColumnChooser?: boolean; + + /** Specifies the template for cell tooltip + * @Default {true} + */ + showGridCellTooltip?: boolean; + + /** Specifies whether to show grid cell tooltip over expander cell alone. + * @Default {true} + */ + showGridExpandCellTooltip?: boolean; + + /** Specifies whether display task progress inside taskbar. + * @Default {true} + */ + showProgressStatus?: boolean; + + /** Specifies whether to display resource names for a task beside taskbar. + * @Default {true} + */ + showResourceNames?: boolean; + + /** Specifies whether to display task name beside task bar. + * @Default {true} + */ + showTaskNames?: boolean; + + /** Specifies the size option of Gantt control. + */ + sizeSettings?: SizeSettings; + + /** Specifies the selected cell information on rendering Gantt. + */ + selectedCellIndexes?: SelectedCellIndex[]; + + /** Specifies the sorting options for Gantt. + */ + sortSettings?: SortSettings; + + /** Specifies splitter position in Gantt. + * @Default {null} + */ + splitterPosition?: string; + + /** Specifies the mapping property path for start date of a task in datasource + */ + startDateMapping?: string; + + /** Specifies the options for striplines + * @Default {[]} + */ + stripLines?: any[]; + + /** Specifies the background of the taskbar in Gantt + */ + taskbarBackground?: string; + + /** Specifies the template script for customized tooltip for taskbar editing in Gantt + */ + taskbarEditingTooltipTemplate?: string; + + /** Specifies the template Id for customized tooltip for taskbar editing in Gantt + */ + taskbarEditingTooltipTemplateId?: string; + + /** Specifies the template for tooltip on mouse action on taskbars + */ + taskbarTooltipTemplate?: string; - /** To Specify the JsRender script Id to customize the task bar with our preference - */ - taskbarTemplate?: string; + /** To Specify the JsRender script Id to customize the task bar with our preference + */ + taskbarTemplate?: string; - /** To Specify the JsRender script Id to customize the mile stone with our preference - */ - milestoneTemplate?: string; + /** To Specify the JsRender script Id to customize the mile stone with our preference + */ + milestoneTemplate?: string; - /** Enables or disables Gantt to read-only mode - * @Default {false} - */ - readOnly?: boolean; + /** Enables or disables Gantt to read-only mode + * @Default {false} + */ + readOnly?: boolean; - /** Specifies the template id for tooltip on mouse action on taskbars - */ - taskbarTooltipTemplateId?: string; + /** Specifies the template id for tooltip on mouse action on taskbars + */ + taskbarTooltipTemplateId?: string; - /** Specifies the mapping property path for task Id in datasource - */ - taskIdMapping?: string; + /** Specifies the mapping property path for task Id in datasource + */ + taskIdMapping?: string; - /** Specifies the mapping property path for task name in datasource - */ - taskNameMapping?: string; + /** Specifies the mapping property path for task name in datasource + */ + taskNameMapping?: string; - /** Specifies the toolbarSettings options. - */ - toolbarSettings?: ToolbarSettings; + /** Specifies the toolbarSettings options. + */ + toolbarSettings?: ToolbarSettings; - /** Specifies the tree expander column in Gantt - * @Default {0} - */ - treeColumnIndex?: number; + /** Specifies the tree expander column in Gantt + * @Default {0} + */ + treeColumnIndex?: number; - /** Specifies the type of selection whether to select row or cell. - * @Default {ej.Gantt.SelectionMode.Row} - */ - selectionMode?: ej.Gantt.SelectionMode|string; + /** Specifies the type of selection whether to select row or cell. + * @Default {ej.Gantt.SelectionMode.Row} + */ + selectionMode?: ej.Gantt.SelectionMode | string; - /** Specifies the weekendBackground color in Gantt - * @Default {#F2F2F2} - */ - weekendBackground?: string; + /** Specifies the weekendBackground color in Gantt + * @Default {#F2F2F2} + */ + weekendBackground?: string; - /** Specifies the working time schedule of day - * @Default {ej.Gantt.workingTimeScale.TimeScale8Hours} - */ - workingTimeScale?: ej.Gantt.workingTimeScale|string; + /** Specifies the working time schedule of day + * @Default {ej.Gantt.workingTimeScale.TimeScale8Hours} + */ + workingTimeScale?: ej.Gantt.workingTimeScale | string; - /** Triggered for every Gantt action before its starts. */ - actionBegin?(e: ActionBeginEventArgs): void; + /** Triggered for every Gantt action before its starts. */ + actionBegin?(e: ActionBeginEventArgs): void; - /** Triggered for every Gantt action success event. */ - actionComplete?(e: ActionCompleteEventArgs): void; + /** Triggered for every Gantt action success event. */ + actionComplete?(e: ActionCompleteEventArgs): void; - /** Triggered while enter the edit mode in the TreeGrid cell */ - beginEdit?(e: BeginEditEventArgs): void; + /** Triggered while enter the edit mode in the TreeGrid cell */ + beginEdit?(e: BeginEditEventArgs): void; - /** Triggered before selecting a cell */ - cellSelecting?(e: CellSelectingEventArgs): void; + /** Triggered before selecting a cell */ + cellSelecting?(e: CellSelectingEventArgs): void; - /** Triggered after selected a cell */ - cellSelected?(e: CellSelectedEventArgs): void; + /** Triggered after selected a cell */ + cellSelected?(e: CellSelectedEventArgs): void; - /** Triggered while dragging a row in Gantt control */ - rowDrag?(e: RowDragEventArgs): void; + /** Triggered while dragging a row in Gantt control */ + rowDrag?(e: RowDragEventArgs): void; - /** Triggered while start to drag row in Gantt control */ - rowDragStart?(e: RowDragStartEventArgs): void; + /** Triggered while start to drag row in Gantt control */ + rowDragStart?(e: RowDragStartEventArgs): void; - /** Triggered while drop a row in Gantt control */ - rowDragStop?(e: RowDragStopEventArgs): void; + /** Triggered while drop a row in Gantt control */ + rowDragStop?(e: RowDragStopEventArgs): void; - /** Triggered after collapsed the Gantt record */ - collapsed?(e: CollapsedEventArgs): void; + /** Triggered after collapsed the Gantt record */ + collapsed?(e: CollapsedEventArgs): void; - /** Triggered while collapsing the Gantt record */ - collapsing?(e: CollapsingEventArgs): void; + /** Triggered while collapsing the Gantt record */ + collapsing?(e: CollapsingEventArgs): void; - /** Triggered while Context Menu is rendered in Gantt control */ - contextMenuOpen?(e: ContextMenuOpenEventArgs): void; + /** Triggered while Context Menu is rendered in Gantt control */ + contextMenuOpen?(e: ContextMenuOpenEventArgs): void; - /** Triggered when Gantt is rendered completely. */ - create?(e: CreateEventArgs): void; + /** Triggered when Gantt is rendered completely. */ + create?(e: CreateEventArgs): void; - /** Triggered after save the modified cellValue in Gantt. */ - endEdit?(e: EndEditEventArgs): void; + /** Triggered after save the modified cellValue in Gantt. */ + endEdit?(e: EndEditEventArgs): void; - /** Triggered after expand the record */ - expanded?(e: ExpandedEventArgs): void; + /** Triggered after expand the record */ + expanded?(e: ExpandedEventArgs): void; - /** Triggered while expanding the Gantt record */ - expanding?(e: ExpandingEventArgs): void; + /** Triggered while expanding the Gantt record */ + expanding?(e: ExpandingEventArgs): void; - /** Triggered while Gantt is loaded */ - load?(e: LoadEventArgs): void; + /** Triggered while Gantt is loaded */ + load?(e: LoadEventArgs): void; - /** Triggered while rendering each cell in the TreeGrid */ - queryCellInfo?(e: QueryCellInfoEventArgs): void; + /** Triggered while rendering each cell in the TreeGrid */ + queryCellInfo?(e: QueryCellInfoEventArgs): void; - /** Triggered while rendering each taskbar in the Gantt */ - queryTaskbarInfo?(e: QueryTaskbarInfoEventArgs): void; + /** Triggered while rendering each taskbar in the Gantt */ + queryTaskbarInfo?(e: QueryTaskbarInfoEventArgs): void; - /** Triggered while rendering each row */ - rowDataBound?(e: RowDataBoundEventArgs): void; + /** Triggered while rendering each row */ + rowDataBound?(e: RowDataBoundEventArgs): void; - /** Triggered after the row is selected. */ - rowSelected?(e: RowSelectedEventArgs): void; + /** Triggered after the row is selected. */ + rowSelected?(e: RowSelectedEventArgs): void; - /** Triggered before the row is going to be selected. */ - rowSelecting?(e: RowSelectingEventArgs): void; + /** Triggered before the row is going to be selected. */ + rowSelecting?(e: RowSelectingEventArgs): void; - /** Triggered after completing the editing operation in taskbar */ - taskbarEdited?(e: TaskbarEditedEventArgs): void; + /** Triggered after completing the editing operation in taskbar */ + taskbarEdited?(e: TaskbarEditedEventArgs): void; - /** Triggered while editing the Gantt chart (dragging, resizing the taskbar ) */ - taskbarEditing?(e: TaskbarEditingEventArgs): void; + /** Triggered while editing the Gantt chart (dragging, resizing the taskbar ) */ + taskbarEditing?(e: TaskbarEditingEventArgs): void; - /** Triggered when taskbar item is clicked in Gantt. */ - taskbarClick?(e: TaskbarClickEventArgs): void; + /** Triggered when taskbar item is clicked in Gantt. */ + taskbarClick?(e: TaskbarClickEventArgs): void; - /** Triggered when toolbar item is clicked in Gantt. */ - toolbarClick?(e: ToolbarClickEventArgs): void; -} + /** Triggered when toolbar item is clicked in Gantt. */ + toolbarClick?(e: ToolbarClickEventArgs): void; + } -export interface ActionBeginEventArgs { + export interface ActionBeginEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the current grouped column field name. - */ - columnName?: string; + /** Returns the current grouped column field name. + */ + columnName?: string; - /** Returns request type. - */ - requestType?: string; + /** Returns request type. + */ + requestType?: string; - /** Returns the direction of sorting ascending or descending - */ - columnSortDirection?: string; + /** Returns the direction of sorting ascending or descending + */ + columnSortDirection?: string; - /** Returns the value of searching element. - */ - keyValue?: string; + /** Returns the value of searching element. + */ + keyValue?: string; - /** Returns the data of deleting element. - */ - data?: string; + /** Returns the data of deleting element. + */ + data?: string; - /** Returns selected record index - */ - recordIndex?: number; -} + /** Returns selected record index + */ + recordIndex?: number; + } -export interface ActionCompleteEventArgs { + export interface ActionCompleteEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the current grouped column field name. - */ - columnName?: string; + /** Returns the current grouped column field name. + */ + columnName?: string; - /** Returns request type. - */ - requestType?: string; + /** Returns request type. + */ + requestType?: string; - /** Returns the direction of sorting ascending or descending - */ - columnSortDirection?: string; + /** Returns the direction of sorting ascending or descending + */ + columnSortDirection?: string; - /** Returns the value of searched element. - */ - keyValue?: string; + /** Returns the value of searched element. + */ + keyValue?: string; - /** Returns the data of deleted element. - */ - data?: string; + /** Returns the data of deleted element. + */ + data?: string; - /** Returns selected record index - */ - recordIndex?: number; -} + /** Returns selected record index + */ + recordIndex?: number; + } -export interface BeginEditEventArgs { + export interface BeginEditEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the row element of editing cell. - */ - rowElement?: any; + /** Returns the row element of editing cell. + */ + rowElement?: any; - /** Returns the Element of editing cell. - */ - cellElement?: any; + /** Returns the Element of editing cell. + */ + cellElement?: any; - /** Returns the data of current cell record. - */ - data?: any; + /** Returns the data of current cell record. + */ + data?: any; - /** Returns the column Index of cell belongs. - */ - columnIndex?: number; -} + /** Returns the column Index of cell belongs. + */ + columnIndex?: number; + } -export interface CellSelectingEventArgs { + export interface CellSelectingEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the cell index on the selection. - */ - cellIndex?: number; + /** Returns the cell index on the selection. + */ + cellIndex?: number; - /** Returns the row index on the selection - */ - rowIndex?: number; + /** Returns the row index on the selection + */ + rowIndex?: number; - /** Returns the selecting cell element - */ - targetCell?: any; + /** Returns the selecting cell element + */ + targetCell?: any; - /** Returns the selecting row element - */ - targetRow?: any; + /** Returns the selecting row element + */ + targetRow?: any; - /** Returns the selecting record object - */ - data?: any; + /** Returns the selecting record object + */ + data?: any; - /** Returns the Gantt object Model - */ - model?: any; -} + /** Returns the Gantt object Model + */ + model?: any; + } -export interface CellSelectedEventArgs { + export interface CellSelectedEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the cell index on the selection. - */ - cellIndex?: number; + /** Returns the cell index on the selection. + */ + cellIndex?: number; - /** Returns the row index on the selection - */ - rowIndex?: number; + /** Returns the row index on the selection + */ + rowIndex?: number; - /** Returns the selecting cell element - */ - targetCell?: any; + /** Returns the selecting cell element + */ + targetCell?: any; - /** Returns the selecting row element - */ - targetRow?: any; + /** Returns the selecting row element + */ + targetRow?: any; - /** Returns the selecting record object - */ - data?: any; + /** Returns the selecting record object + */ + data?: any; - /** Returns the Gantt object Model - */ - model?: any; + /** Returns the Gantt object Model + */ + model?: any; - /** Returns the previously selected row data - */ - previousData?: any; + /** Returns the previously selected row data + */ + previousData?: any; - /** Returns the previously selected cell index - */ - previousCellIndex?: any; + /** Returns the previously selected cell index + */ + previousCellIndex?: any; - /** Returns the previously selected row index - */ - previousRowIndex?: any; + /** Returns the previously selected row index + */ + previousRowIndex?: any; - /** Returns the previously selected cell element - */ - previousTargetCell?: any; + /** Returns the previously selected cell element + */ + previousTargetCell?: any; - /** Returns the previously selected row element - */ - previousTargetRow?: any; -} + /** Returns the previously selected row element + */ + previousTargetRow?: any; + } -export interface RowDragEventArgs { + export interface RowDragEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the row which we start to drag. - */ - draggedRow?: any; + /** Returns the row which we start to drag. + */ + draggedRow?: any; - /** Returns the row index which we start to drag. - */ - draggedRowIndex?: number; + /** Returns the row index which we start to drag. + */ + draggedRowIndex?: number; - /** Returns the row on which we are dragging. - */ - targetRow?: any; + /** Returns the row on which we are dragging. + */ + targetRow?: any; - /** Returns the row index on which we are dragging. - */ - targetRowIndex?: number; + /** Returns the row index on which we are dragging. + */ + targetRowIndex?: number; - /** Returns that we can drop over that record or not. - */ - canDrop?: boolean; + /** Returns that we can drop over that record or not. + */ + canDrop?: boolean; - /** Returns the Gantt model. - */ - model?: any; + /** Returns the Gantt model. + */ + model?: any; - /** Returns request type. - */ - requestType?: string; + /** Returns request type. + */ + requestType?: string; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface RowDragStartEventArgs { + export interface RowDragStartEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the row which we start to drag. - */ - draggedRow?: any; + /** Returns the row which we start to drag. + */ + draggedRow?: any; - /** Returns the row index which we start to drag. - */ - draggedRowIndex?: boolean; + /** Returns the row index which we start to drag. + */ + draggedRowIndex?: boolean; - /** Returns the Gantt model. - */ - model?: any; + /** Returns the Gantt model. + */ + model?: any; - /** Returns request type. - */ - requestType?: string; + /** Returns request type. + */ + requestType?: string; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface RowDragStopEventArgs { + export interface RowDragStopEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the row which we start to drag. - */ - draggedRow?: any; + /** Returns the row which we start to drag. + */ + draggedRow?: any; - /** Returns the row index which we start to drag. - */ - draggedRowIndex?: number; + /** Returns the row index which we start to drag. + */ + draggedRowIndex?: number; - /** Returns the row which we are dropped to row. - */ - targetRow?: any; + /** Returns the row which we are dropped to row. + */ + targetRow?: any; - /** Returns the row index which we are dropped to row. - */ - targetRowIndex?: number; + /** Returns the row index which we are dropped to row. + */ + targetRowIndex?: number; - /** Returns the Gantt model. - */ - model?: any; + /** Returns the Gantt model. + */ + model?: any; - /** Returns request type. - */ - requestType?: string; + /** Returns request type. + */ + requestType?: string; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface CollapsedEventArgs { + export interface CollapsedEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the row index of collapsed record. - */ - recordIndex?: number; + /** Returns the row index of collapsed record. + */ + recordIndex?: number; - /** Returns the data of collapsed record. - */ - data?: any; + /** Returns the data of collapsed record. + */ + data?: any; - /** Returns Request Type. - */ - requestType?: string; + /** Returns Request Type. + */ + requestType?: string; - /** Returns state of a record whether it is in expanded or collapsed state. - */ - expanded?: boolean; -} + /** Returns state of a record whether it is in expanded or collapsed state. + */ + expanded?: boolean; + } -export interface CollapsingEventArgs { + export interface CollapsingEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the row index of collapsing record. - */ - recordIndex?: number; + /** Returns the row index of collapsing record. + */ + recordIndex?: number; - /** Returns the data of edited cell record.. - */ - data?: any; + /** Returns the data of edited cell record.. + */ + data?: any; - /** Returns state of a record whether it is in expanded or collapsed state. - */ - expanded?: boolean; -} + /** Returns state of a record whether it is in expanded or collapsed state. + */ + expanded?: boolean; + } -export interface ContextMenuOpenEventArgs { + export interface ContextMenuOpenEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the default context menu items to which we add custom items. - */ - contextMenuItems?: any[]; + /** Returns the default context menu items to which we add custom items. + */ + contextMenuItems?: any[]; - /** Returns the Gantt model. - */ - model?: any; + /** Returns the Gantt model. + */ + model?: any; - /** Returns request type. - */ - requestType?: string; + /** Returns request type. + */ + requestType?: string; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Gantt model - */ - model?: any; + /** Returns the Gantt model + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface EndEditEventArgs { + export interface EndEditEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the row element of editing cell. - */ - rowElement?: any; + /** Returns the row element of editing cell. + */ + rowElement?: any; - /** Returns the Element of editing cell. - */ - cellElement?: any; + /** Returns the Element of editing cell. + */ + cellElement?: any; - /** Returns the data of edited cell record. - */ - data?: any; + /** Returns the data of edited cell record. + */ + data?: any; - /** Returns the column name of edited cell belongs. - */ - columnName?: string; + /** Returns the column name of edited cell belongs. + */ + columnName?: string; - /** Returns the column object of edited cell belongs. - */ - columnObject?: any; -} + /** Returns the column object of edited cell belongs. + */ + columnObject?: any; + } -export interface ExpandedEventArgs { + export interface ExpandedEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the row index of record. - */ - recordIndex?: number; + /** Returns the row index of record. + */ + recordIndex?: number; - /** Returns the data of expanded record. - */ - data?: any; + /** Returns the data of expanded record. + */ + data?: any; - /** Returns Request Type. - */ - requestType?: string; + /** Returns Request Type. + */ + requestType?: string; - /** Returns state of a record whether it is in expanded or collapsed state. - */ - expanded?: boolean; -} + /** Returns state of a record whether it is in expanded or collapsed state. + */ + expanded?: boolean; + } -export interface ExpandingEventArgs { + export interface ExpandingEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the row index of record. - */ - recordIndex?: any; + /** Returns the row index of record. + */ + recordIndex?: any; - /** Returns the data of edited cell record.. - */ - data?: any; + /** Returns the data of edited cell record.. + */ + data?: any; - /** Returns state of a record whether it is in expanded or collapsed state. - */ - expanded?: boolean; -} + /** Returns state of a record whether it is in expanded or collapsed state. + */ + expanded?: boolean; + } -export interface LoadEventArgs { + export interface LoadEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Gantt model - */ - model?: any; + /** Returns the Gantt model + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface QueryCellInfoEventArgs { + export interface QueryCellInfoEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the selecting cell element. - */ - cellElement?: any; + /** Returns the selecting cell element. + */ + cellElement?: any; - /** Returns the value of cell. - */ - cellValue?: string; + /** Returns the value of cell. + */ + cellValue?: string; - /** Returns the data of current cell record. - */ - data?: any; + /** Returns the data of current cell record. + */ + data?: any; - /** Returns the column of cell belongs. - */ - column?: any; -} + /** Returns the column of cell belongs. + */ + column?: any; + } -export interface QueryTaskbarInfoEventArgs { + export interface QueryTaskbarInfoEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the taskbar background of current item. - */ - TaskbarBackground?: string; + /** Returns the taskbar background of current item. + */ + TaskbarBackground?: string; - /** Returns the progressbar background of current item. - */ - ProgressbarBackground?: string; + /** Returns the progressbar background of current item. + */ + ProgressbarBackground?: string; - /** Returns the parent taskbar background of current item. - */ - parentTaskbarBackground?: string; + /** Returns the parent taskbar background of current item. + */ + parentTaskbarBackground?: string; - /** Returns the parent progressbar background of current item. - */ - parentProgressbarBackground?: string; + /** Returns the parent progressbar background of current item. + */ + parentProgressbarBackground?: string; - /** Returns the data of the record. - */ - data?: any; -} + /** Returns the data of the record. + */ + data?: any; + } -export interface RowDataBoundEventArgs { + export interface RowDataBoundEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the row element of rendering row. - */ - rowElement?: any; + /** Returns the row element of rendering row. + */ + rowElement?: any; - /** Returns the data of rendering row record.. - */ - data?: any; -} + /** Returns the data of rendering row record.. + */ + data?: any; + } -export interface RowSelectedEventArgs { + export interface RowSelectedEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the selecting row element. - */ - targetRow?: any; + /** Returns the selecting row element. + */ + targetRow?: any; - /** Returns the index of selecting row record. - */ - recordIndex?: number; + /** Returns the index of selecting row record. + */ + recordIndex?: number; - /** Returns the data of selected record. - */ - data?: any; -} + /** Returns the data of selected record. + */ + data?: any; + } -export interface RowSelectingEventArgs { + export interface RowSelectingEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the data selecting record. - */ - data?: any; + /** Returns the data selecting record. + */ + data?: any; - /** Returns the index of selecting row record. - */ - recordIndex?: string; + /** Returns the index of selecting row record. + */ + recordIndex?: string; - /** Returns the selecting row chart element. - */ - targetChartRow?: any; + /** Returns the selecting row chart element. + */ + targetChartRow?: any; - /** Returns the selecting row grid element. - */ - targetGridRow?: any; + /** Returns the selecting row grid element. + */ + targetGridRow?: any; - /** Returns the previous selected data. - */ - previousData?: any; + /** Returns the previous selected data. + */ + previousData?: any; - /** Returns the previous selected row index. - */ - previousIndex?: string; + /** Returns the previous selected row index. + */ + previousIndex?: string; - /** Returns the previous selected row chart element. - */ - previousChartRow?: any; + /** Returns the previous selected row chart element. + */ + previousChartRow?: any; - /** Returns the previous selected row grid element. - */ - previousGridRow?: any; -} + /** Returns the previous selected row grid element. + */ + previousGridRow?: any; + } -export interface TaskbarEditedEventArgs { + export interface TaskbarEditedEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the data of edited record. - */ - data?: any; + /** Returns the data of edited record. + */ + data?: any; - /** Returns the previous data value of edited record. - */ - previousData?: any; + /** Returns the previous data value of edited record. + */ + previousData?: any; - /** Returns 'true' if taskbar is dragged. - */ - dragging?: boolean; + /** Returns 'true' if taskbar is dragged. + */ + dragging?: boolean; - /** Returns 'true' if taskbar is left resized. - */ - leftResizing?: boolean; + /** Returns 'true' if taskbar is left resized. + */ + leftResizing?: boolean; - /** Returns 'true' if taskbar is right resized. - */ - rightResizing?: boolean; + /** Returns 'true' if taskbar is right resized. + */ + rightResizing?: boolean; - /** Returns 'true' if taskbar is progress resized. - */ - progressResizing?: boolean; + /** Returns 'true' if taskbar is progress resized. + */ + progressResizing?: boolean; - /** Returns the field values of record being edited. - */ - editingFields?: any; + /** Returns the field values of record being edited. + */ + editingFields?: any; - /** Returns the Gantt model. - */ - model?: any; -} + /** Returns the Gantt model. + */ + model?: any; + } -export interface TaskbarEditingEventArgs { + export interface TaskbarEditingEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Gantt model. - */ - model?: any; + /** Returns the Gantt model. + */ + model?: any; - /** Returns the row object being edited. - */ - rowData?: any; + /** Returns the row object being edited. + */ + rowData?: any; - /** Returns the field values of record being edited. - */ - editingFields?: any; + /** Returns the field values of record being edited. + */ + editingFields?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface TaskbarClickEventArgs { + export interface TaskbarClickEventArgs { - /** Returns currently clicked row data - */ - data?: any; + /** Returns currently clicked row data + */ + data?: any; - /** Returns the current item index. - */ - index?: number; - - /** Returns the Gantt model. - */ - model?: any; - - /** Returns the clicked row element - */ - taskbarElement?: any; - - /** Returns the target element. - */ - target?: any; - - /** Returns the name of the event. - */ - type?: string; -} - -export interface ToolbarClickEventArgs { + /** Returns the current item index. + */ + index?: number; + + /** Returns the Gantt model. + */ + model?: any; + + /** Returns the clicked row element + */ + taskbarElement?: any; + + /** Returns the target element. + */ + target?: any; + + /** Returns the name of the event. + */ + type?: string; + } + + export interface ToolbarClickEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; - - /** Returns the current item. - */ - currentTarget?: any; - - /** Returns the Gantt model. - */ - model?: any; - - /** Returns the name of the toolbar item on which mouse click has been performed - */ - itemName?: string; - - /** Returns the name of the event. - */ - type?: string; -} - -export interface DragTooltip { - - /** Specifies option to enable/disable tooltip while drag and drop a row. - * @Default {true} - */ - showTooltip?: boolean; - - /** Specifies the data source fields to be displayed in the drag tooltip. - * @Default {[]} - */ - tooltipItems?: any[]; - - /** Specifies the custom template for drag tooltip. - * @Default {null} - */ - tooltipTemplate?: string; -} - -export interface SplitterSettings { - - /** Specifies position of the splitter in Gantt , splitter can be placed either based on percentage values or pixel values. - */ - position?: string; - - /** Specifies the position of splitter in Gantt, based on column index in Gantt. - */ - index?: string; -} - -export interface EditSettings { - - /** Enables or disables add record icon in Gantt toolbar - * @Default {false} - */ - allowAdding?: boolean; - - /** Enables or disables delete icon in Gantt toolbar - * @Default {false} - */ - allowDeleting?: boolean; - - /** Specifies the option for enabling or disabling editing in Gantt grid part - * @Default {false} - */ - allowEditing?: boolean; - - /** Specifies the option for enabling or disabling indent action in Gantt. - * @Default {false} - */ - allowIndent?: boolean; - - /** Specifies the option for enabling or disabling outdent action in Gantt - * @Default {false} - */ - allowOutdent?: boolean; - - /** Specifies the mouse action whether single click or double click to begin the editing - * @Default {ej.Gantt.BeginEditAction.DblClick} - */ - beginEditAction?: ej.Gantt.BeginEditAction|string; - - /** Specifies the edit mode in Gantt, "normal" is for dialog editing ,"cellEditing" is for cell type editing - * @Default {normal} - */ - editMode?: string; - - /** Specifies the position where the new row has to be added. - * @Default {ej.Gantt.RowPosition.BelowSelectedRow} - */ - rowPosition?: ej.Gantt.RowPosition|string; -} - -export interface ScheduleHeaderSettings { - - /** Specified the format for day view in schedule header - * @Default {ddd} - */ - dayHeaderFormat?: string; - - /** Specified the format for Hour view in schedule header - * @Default {HH} - */ - hourHeaderFormat?: string; - - /** Specifies the number of minutes per interval - * @Default {ej.Gantt.minutesPerInterval.Auto} - */ - minutesPerInterval?: ej.Gantt.minutesPerInterval|string; - - /** Specified the format for month view in schedule header - * @Default {MMM} - */ - monthHeaderFormat?: string; - - /** Specifies the schedule mode - * @Default {ej.Gantt.ScheduleHeaderType.Week} - */ - scheduleHeaderType?: ej.Gantt.ScheduleHeaderType|string; - - /** Specifies the round-off mode for the start date in schedule header. - * @Default {ej.Gantt.TimescaleRoundMode.Auto} - */ - timescaleStartDateMode?: ej.Gantt.TimescaleRoundMode|string; - - /** Specified the background for weekends in Gantt - * @Default {#F2F2F2} - */ - weekendBackground?: string; - - /** Specified the format for week view in schedule header - * @Default {ddd} - */ - weekHeaderFormat?: string; + /** Returns the cancel option value. + */ + cancel?: boolean; + + /** Returns the current item. + */ + currentTarget?: any; + + /** Returns the Gantt model. + */ + model?: any; + + /** Returns the name of the toolbar item on which mouse click has been performed + */ + itemName?: string; + + /** Returns the name of the event. + */ + type?: string; + } + + export interface DragTooltip { + + /** Specifies option to enable/disable tooltip while drag and drop a row. + * @Default {true} + */ + showTooltip?: boolean; + + /** Specifies the data source fields to be displayed in the drag tooltip. + * @Default {[]} + */ + tooltipItems?: any[]; + + /** Specifies the custom template for drag tooltip. + * @Default {null} + */ + tooltipTemplate?: string; + } + + export interface SplitterSettings { + + /** Specifies position of the splitter in Gantt , splitter can be placed either based on percentage values or pixel values. + */ + position?: string; + + /** Specifies the position of splitter in Gantt, based on column index in Gantt. + */ + index?: string; + } + + export interface EditSettings { + + /** Enables or disables add record icon in Gantt toolbar + * @Default {false} + */ + allowAdding?: boolean; + + /** Enables or disables delete icon in Gantt toolbar + * @Default {false} + */ + allowDeleting?: boolean; + + /** Specifies the option for enabling or disabling editing in Gantt grid part + * @Default {false} + */ + allowEditing?: boolean; + + /** Specifies the option for enabling or disabling indent action in Gantt. + * @Default {false} + */ + allowIndent?: boolean; + + /** Specifies the option for enabling or disabling outdent action in Gantt + * @Default {false} + */ + allowOutdent?: boolean; + + /** Specifies the mouse action whether single click or double click to begin the editing + * @Default {ej.Gantt.BeginEditAction.DblClick} + */ + beginEditAction?: ej.Gantt.BeginEditAction | string; + + /** Specifies the edit mode in Gantt, "normal" is for dialog editing ,"cellEditing" is for cell type editing + * @Default {normal} + */ + editMode?: string; + + /** Specifies the position where the new row has to be added. + * @Default {ej.Gantt.RowPosition.BelowSelectedRow} + */ + rowPosition?: ej.Gantt.RowPosition | string; + } + + export interface ScheduleHeaderSettings { + + /** Specified the format for day view in schedule header + * @Default {ddd} + */ + dayHeaderFormat?: string; + + /** Specified the format for Hour view in schedule header + * @Default {HH} + */ + hourHeaderFormat?: string; + + /** Specifies the number of minutes per interval + * @Default {ej.Gantt.minutesPerInterval.Auto} + */ + minutesPerInterval?: ej.Gantt.minutesPerInterval | string; + + /** Specified the format for month view in schedule header + * @Default {MMM} + */ + monthHeaderFormat?: string; + + /** Specifies the schedule mode + * @Default {ej.Gantt.ScheduleHeaderType.Week} + */ + scheduleHeaderType?: ej.Gantt.ScheduleHeaderType | string; + + /** Specifies the round-off mode for the start date in schedule header. + * @Default {ej.Gantt.TimescaleRoundMode.Auto} + */ + timescaleStartDateMode?: ej.Gantt.TimescaleRoundMode | string; + + /** Specified the background for weekends in Gantt + * @Default {#F2F2F2} + */ + weekendBackground?: string; + + /** Specified the format for week view in schedule header + * @Default {ddd} + */ + weekHeaderFormat?: string; - /** Specified the format for year view in schedule header - * @Default {yyyy} - */ - yearHeaderFormat?: string; + /** Specified the format for year view in schedule header + * @Default {yyyy} + */ + yearHeaderFormat?: string; - /** Specifies the size of the lowest time unit along the timescale, with minimum value as "50%" and maximum value as "500%". It is also possible to set the value in pixels. - * @Default {100%} - */ - timescaleUnitSize?: string; + /** Specifies the size of the lowest time unit along the timescale, with minimum value as "50%" and maximum value as "500%". It is also possible to set the value in pixels. + * @Default {100%} + */ + timescaleUnitSize?: string; - /** Specifies the start day of the week in week timescale mode - * @Default {0} - */ - weekStartDay?: number; -} + /** Specifies the start day of the week in week timescale mode + * @Default {0} + */ + weekStartDay?: number; + } -export interface SizeSettings { + export interface SizeSettings { - /** Specifies the height of Gantt control - * @Default {450px} - */ - height?: string; + /** Specifies the height of Gantt control + * @Default {450px} + */ + height?: string; - /** Specifies the width of Gantt control - * @Default {1000px} - */ - width?: string; -} + /** Specifies the width of Gantt control + * @Default {1000px} + */ + width?: string; + } -export interface SelectedCellIndex { + export interface SelectedCellIndex { - /** Specifies the row index of the cell to be selected Gantt control - */ - rowIndex?: number; + /** Specifies the row index of the cell to be selected Gantt control + */ + rowIndex?: number; - /** Specifies the cell index to be selected in the row. - * @Default { } - */ - cellIndex?: number; -} + /** Specifies the cell index to be selected in the row. + * @Default { } + */ + cellIndex?: number; + } -export interface SortSettings { + export interface SortSettings { - /** Specifies the sorted columns for Gantt - * @Default {[]} - */ - sortedColumns?: any[]; -} + /** Specifies the sorted columns for Gantt + * @Default {[]} + */ + sortedColumns?: any[]; + } -export interface ToolbarSettings { + export interface ToolbarSettings { - /** Specifies the state of enabling or disabling toolbar - * @Default {true} - */ - showToolbar?: boolean; + /** Specifies the state of enabling or disabling toolbar + * @Default {true} + */ + showToolbar?: boolean; - /** Specifies the list of toolbar items to be rendered in Gantt toolbar - * @Default {[]} - */ - toolbarItems?: any[]; -} + /** Specifies the list of toolbar items to be rendered in Gantt toolbar + * @Default {[]} + */ + toolbarItems?: any[]; + } -enum DurationUnit { + enum DurationUnit { - ///Sets the Duration Unit as day. - Day, + ///Sets the Duration Unit as day. + Day, - ///Sets the Duration Unit as hour. - Hour, + ///Sets the Duration Unit as hour. + Hour, - ///Sets the Duration Unit as minute. - Minute -} + ///Sets the Duration Unit as minute. + Minute + } -enum BeginEditAction { + enum BeginEditAction { - ///you can begin the editing at double click - DblClick, + ///you can begin the editing at double click + DblClick, - ///you can begin the editing at single click - Click -} + ///you can begin the editing at single click + Click + } -enum RowPosition { + enum RowPosition { - ///you can add a new row at top. - Top, + ///you can add a new row at top. + Top, - ///you can add a new row at bottom. - Bottom, + ///you can add a new row at bottom. + Bottom, - ///you can add a new row to above selected row. - AboveSelectedRow, + ///you can add a new row to above selected row. + AboveSelectedRow, - ///you can add a new row to below selected row. - BelowSelectedRow, + ///you can add a new row to below selected row. + BelowSelectedRow, - ///you can add a new row as a child for selected row. - Child -} + ///you can add a new row as a child for selected row. + Child + } -enum TaskType { + enum TaskType { - ///Resource unit remains constant while editing the work and duration values. - FixedUnit, + ///Resource unit remains constant while editing the work and duration values. + FixedUnit, - ///Work value of a task remains constant while editing duration and resource unit values. - FixedWork, + ///Work value of a task remains constant while editing duration and resource unit values. + FixedWork, - ///Duration value remains constant while editing work and resource unit values. - FixedDuration -} + ///Duration value remains constant while editing work and resource unit values. + FixedDuration + } -enum WorkUnit { + enum WorkUnit { - ///Displays the work involved in a task in days. - Day, + ///Displays the work involved in a task in days. + Day, - ///Displays the work involved in a task in hours. - Hour, + ///Displays the work involved in a task in hours. + Hour, - ///Displays the work involved in a task in minutes - Minute -} + ///Displays the work involved in a task in minutes + Minute + } -enum TaskSchedulingMode { + enum TaskSchedulingMode { - ///All the tasks in the project will be displayed in auto scheduled mode, where the tasks are scheduled automatically over non-working days and holidays. - Auto, + ///All the tasks in the project will be displayed in auto scheduled mode, where the tasks are scheduled automatically over non-working days and holidays. + Auto, - ///All the tasks in the project will be displayed in manually scheduled mode. - Manual, + ///All the tasks in the project will be displayed in manually scheduled mode. + Manual, - ///Project consists of tasks with both auto and manually scheduled modes, based on the datasource values - Custom -} + ///Project consists of tasks with both auto and manually scheduled modes, based on the datasource values + Custom + } -enum SelectionType { + enum SelectionType { - ///you can select a single row. - Single, + ///you can select a single row. + Single, - ///you can select a multiple row. - Multiple -} + ///you can select a multiple row. + Multiple + } -enum minutesPerInterval { + enum minutesPerInterval { - ///Sets the interval automatically according with schedule start and end date. - Auto, + ///Sets the interval automatically according with schedule start and end date. + Auto, - ///Sets one minute intervals per hour. - OneMinute, + ///Sets one minute intervals per hour. + OneMinute, - ///Sets Five minute intervals per hour. - FiveMinutes, + ///Sets Five minute intervals per hour. + FiveMinutes, - ///Sets fifteen minute intervals per hour. - FifteenMinutes, + ///Sets fifteen minute intervals per hour. + FifteenMinutes, - ///Sets thirty minute intervals per hour. - ThirtyMinutes -} + ///Sets thirty minute intervals per hour. + ThirtyMinutes + } -enum ScheduleHeaderType { + enum ScheduleHeaderType { - ///Sets year Schedule Mode. - Year, + ///Sets year Schedule Mode. + Year, - ///Sets month Schedule Mode. - Month, + ///Sets month Schedule Mode. + Month, - ///Sets week Schedule Mode. - Week, + ///Sets week Schedule Mode. + Week, - ///Sets day Schedule Mode. - Day, + ///Sets day Schedule Mode. + Day, - ///Sets hour Schedule Mode. - Hour -} + ///Sets hour Schedule Mode. + Hour + } -enum TimescaleRoundMode { + enum TimescaleRoundMode { - ///The round-off value will be automatically calculated based on the data source values. - Auto, + ///The round-off value will be automatically calculated based on the data source values. + Auto, - ///Schedule header start date will round-off to the immediate week. - Week, + ///Schedule header start date will round-off to the immediate week. + Week, - ///Schedule headers start date will round off to the immediate month - Month, + ///Schedule headers start date will round off to the immediate month + Month, - ///Schedule headers start date will round off to the immediate year - Year -} + ///Schedule headers start date will round off to the immediate year + Year + } -enum SelectionMode { + enum SelectionMode { - ///you can select a row. - Row, + ///you can select a row. + Row, - ///you can select a cell. - Cell -} + ///you can select a cell. + Cell + } -enum workingTimeScale { + enum workingTimeScale { - ///Sets eight hour timescale. - TimeScale8Hours, + ///Sets eight hour timescale. + TimeScale8Hours, - ///Sets twenty four hour timescale. - TimeScale24Hours -} + ///Sets twenty four hour timescale. + TimeScale24Hours + } -} + } -class ReportViewer extends ej.Widget { - static fn: ReportViewer; - constructor(element: JQuery | Element, options?: ReportViewer.Model); - static Locale: any; - model: ReportViewer.Model; - defaults: ReportViewer.Model; + class ReportViewer extends ej.Widget { + static fn: ReportViewer; + constructor(element: JQuery | Element, options?: ReportViewer.Model); + static Locale: any; + model: ReportViewer.Model; + defaults: ReportViewer.Model; - /** Export the report to the specified format. - * @returns {void} - */ - exportReport(): void; + /** Export the report to the specified format. + * @returns {void} + */ + exportReport(): void; - /** Fit the report page to the container. - * @returns {void} - */ - fitToPage(): void; + /** Fit the report page to the container. + * @returns {void} + */ + fitToPage(): void; - /** Fit the report page height to the container. - * @returns {void} - */ - fitToPageHeight(): void; + /** Fit the report page height to the container. + * @returns {void} + */ + fitToPageHeight(): void; - /** Fit the report page width to the container. - * @returns {void} - */ - fitToPageWidth(): void; + /** Fit the report page width to the container. + * @returns {void} + */ + fitToPageWidth(): void; - /** Get the available datasets name of the rdlc report. - * @returns {void} - */ - getDataSetNames(): void; + /** Get the available datasets name of the rdlc report. + * @returns {void} + */ + getDataSetNames(): void; - /** Get the available parameters of the report. - * @returns {void} - */ - getParameters(): void; + /** Get the available parameters of the report. + * @returns {void} + */ + getParameters(): void; - /** Navigate to first page of report. - * @returns {void} - */ - gotoFirstPage(): void; + /** Navigate to first page of report. + * @returns {void} + */ + gotoFirstPage(): void; - /** Navigate to last page of the report. - * @returns {void} - */ - gotoLastPage(): void; - - /** Navigate to next page from the current page. - * @returns {void} - */ - gotoNextPage(): void; - - /** Go to specific page index of the report. - * @returns {void} - */ - gotoPageIndex(): void; - - /** Navigate to previous page from the current page. - * @returns {void} - */ - gotoPreviousPage(): void; - - /** Print the report. - * @returns {void} - */ - print(): void; - - /** Apply print layout to the report. - * @returns {void} - */ - printLayout(): void; - - /** Refresh the report. - * @returns {void} - */ - refresh(): void; -} -export namespace ReportViewer { - -export interface Model { - - /** Gets or sets the list of data sources for the RDLC report. - * @Default {[]} - */ - dataSources?: DataSource[]; - - /** Enables or disables the page cache of report. - * @Default {false} - */ - enablePageCache?: boolean; - - /** Specifies the export settings. - */ - exportSettings?: ExportSettings; - - /** When set to true, adapts the report layout to fit the screen size of devices on which it renders. - * @Default {true} - */ - isResponsive?: boolean; - - /** Specifies the locale for report viewer. - * @Default {en-US} - */ - locale?: string; - - /** Specifies the page settings. - */ - pageSettings?: PageSettings; - - /** Gets or sets the list of parameters associated with the report. - * @Default {[]} - */ - parameters?: Parameter[]; - - /** Enables and disables the print mode. - * @Default {false} - */ - printMode?: boolean; - - /** Specifies the print option of the report. - * @Default {ej.ReportViewer.PrintOptions.Default} - */ - printOptions?: ej.ReportViewer.PrintOptions|string; - - /** Specifies the processing mode of the report. - * @Default {ej.ReportViewer.ProcessingMode.Remote} - */ - processingMode?: ej.ReportViewer.ProcessingMode|string; - - /** Specifies the render layout. - * @Default {ej.ReportViewer.RenderMode.Default} - */ - renderMode?: ej.ReportViewer.RenderMode|string; - - /** Gets or sets the path of the report file. - * @Default {empty} - */ - reportPath?: string; - - /** Gets or sets the reports server URL. - * @Default {empty} - */ - reportServerUrl?: string; - - /** Specifies the report Web API service URL. - * @Default {empty} - */ - reportServiceUrl?: string; - - /** Specifies the toolbar settings. - */ - toolbarSettings?: ToolbarSettings; - - /** Gets or sets the zoom factor for report viewer. - * @Default {1} - */ - zoomFactor?: number; - - /** Fires when the report viewer is destroyed successfully.If you want to perform any operation after destroying the reportviewer control,you can make use of the destroy event. */ - destroy?(e: DestroyEventArgs): void; + /** Navigate to last page of the report. + * @returns {void} + */ + gotoLastPage(): void; + + /** Navigate to next page from the current page. + * @returns {void} + */ + gotoNextPage(): void; + + /** Go to specific page index of the report. + * @returns {void} + */ + gotoPageIndex(): void; + + /** Navigate to previous page from the current page. + * @returns {void} + */ + gotoPreviousPage(): void; + + /** Print the report. + * @returns {void} + */ + print(): void; + + /** Apply print layout to the report. + * @returns {void} + */ + printLayout(): void; + + /** Refresh the report. + * @returns {void} + */ + refresh(): void; + } + export namespace ReportViewer { + + export interface Model { + + /** Gets or sets the list of data sources for the RDLC report. + * @Default {[]} + */ + dataSources?: DataSource[]; + + /** Enables or disables the page cache of report. + * @Default {false} + */ + enablePageCache?: boolean; + + /** Specifies the export settings. + */ + exportSettings?: ExportSettings; + + /** When set to true, adapts the report layout to fit the screen size of devices on which it renders. + * @Default {true} + */ + isResponsive?: boolean; + + /** Specifies the locale for report viewer. + * @Default {en-US} + */ + locale?: string; + + /** Specifies the page settings. + */ + pageSettings?: PageSettings; + + /** Gets or sets the list of parameters associated with the report. + * @Default {[]} + */ + parameters?: Parameter[]; + + /** Enables and disables the print mode. + * @Default {false} + */ + printMode?: boolean; + + /** Specifies the print option of the report. + * @Default {ej.ReportViewer.PrintOptions.Default} + */ + printOptions?: ej.ReportViewer.PrintOptions | string; + + /** Specifies the processing mode of the report. + * @Default {ej.ReportViewer.ProcessingMode.Remote} + */ + processingMode?: ej.ReportViewer.ProcessingMode | string; + + /** Specifies the render layout. + * @Default {ej.ReportViewer.RenderMode.Default} + */ + renderMode?: ej.ReportViewer.RenderMode | string; + + /** Gets or sets the path of the report file. + * @Default {empty} + */ + reportPath?: string; + + /** Gets or sets the reports server URL. + * @Default {empty} + */ + reportServerUrl?: string; + + /** Specifies the report Web API service URL. + * @Default {empty} + */ + reportServiceUrl?: string; + + /** Specifies the toolbar settings. + */ + toolbarSettings?: ToolbarSettings; + + /** Gets or sets the zoom factor for report viewer. + * @Default {1} + */ + zoomFactor?: number; + + /** Fires when the report viewer is destroyed successfully.If you want to perform any operation after destroying the reportviewer control,you can make use of the destroy event. */ + destroy?(e: DestroyEventArgs): void; - /** Fires during drill through action done in report.If you want to perform any operation when a drill through action is performed, you can make use of the drillThrough event. */ - drillThrough?(e: DrillThroughEventArgs): void; - - /** Fires before report rendering is completed.If you want to perform any operation before the rendering of report,you can make use of the renderingBegin event. */ - renderingBegin?(e: RenderingBeginEventArgs): void; + /** Fires during drill through action done in report.If you want to perform any operation when a drill through action is performed, you can make use of the drillThrough event. */ + drillThrough?(e: DrillThroughEventArgs): void; + + /** Fires before report rendering is completed.If you want to perform any operation before the rendering of report,you can make use of the renderingBegin event. */ + renderingBegin?(e: RenderingBeginEventArgs): void; - /** Fires after report rendering completed.If you want to perform any operation after the rendering of report,you can make use of this renderingComplete event. */ - renderingComplete?(e: RenderingCompleteEventArgs): void; + /** Fires after report rendering completed.If you want to perform any operation after the rendering of report,you can make use of this renderingComplete event. */ + renderingComplete?(e: RenderingCompleteEventArgs): void; - /** Fires when any error occurred while rendering the report.If you want to perform any operation when an error occurs in the report, you can make use of the reportError event. */ - reportError?(e: ReportErrorEventArgs): void; + /** Fires when any error occurred while rendering the report.If you want to perform any operation when an error occurs in the report, you can make use of the reportError event. */ + reportError?(e: ReportErrorEventArgs): void; - /** Fires when the report is being exported.If you want to perform any operation before exporting of report, you can make use of the reportExport event. */ - reportExport?(e: ReportExportEventArgs): void; + /** Fires when the report is being exported.If you want to perform any operation before exporting of report, you can make use of the reportExport event. */ + reportExport?(e: ReportExportEventArgs): void; - /** Fires when the report is loaded.If you want to perform any operation after the successful loading of report, you can make use of the reportLoaded event. */ - reportLoaded?(e: ReportLoadedEventArgs): void; + /** Fires when the report is loaded.If you want to perform any operation after the successful loading of report, you can make use of the reportLoaded event. */ + reportLoaded?(e: ReportLoadedEventArgs): void; - /** Fires when click the View Report Button. */ - viewReportClick?(e: ViewReportClickEventArgs): void; -} + /** Fires when click the View Report Button. */ + viewReportClick?(e: ViewReportClickEventArgs): void; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** true if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the report model. - */ - model?: any; + /** returns the report model. + */ + model?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface DrillThroughEventArgs { + export interface DrillThroughEventArgs { - /** true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** true if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the actionInfo's parameters bookmarkLink, hyperLink, reportName, parameters. - */ - actionInfo?: any; + /** returns the actionInfo's parameters bookmarkLink, hyperLink, reportName, parameters. + */ + actionInfo?: any; - /** returns the report model. - */ - model?: any; + /** returns the report model. + */ + model?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface RenderingBeginEventArgs { + export interface RenderingBeginEventArgs { - /** true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** true if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the report model. - */ - model?: any; + /** returns the report model. + */ + model?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface RenderingCompleteEventArgs { + export interface RenderingCompleteEventArgs { - /** true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** true if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the report model. - */ - model?: any; + /** returns the report model. + */ + model?: any; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the collection of parameters. - */ - reportParameters?: any; -} + /** returns the collection of parameters. + */ + reportParameters?: any; + } -export interface ReportErrorEventArgs { + export interface ReportErrorEventArgs { - /** true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** true if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the error details. - */ - error?: string; + /** returns the error details. + */ + error?: string; - /** returns the report model. - */ - model?: any; + /** returns the report model. + */ + model?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface ReportExportEventArgs { + export interface ReportExportEventArgs { - /** true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** true if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the report model. - */ - model?: any; + /** returns the report model. + */ + model?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface ReportLoadedEventArgs { + export interface ReportLoadedEventArgs { - /** true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** true if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the report model. - */ - model?: any; + /** returns the report model. + */ + model?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the name of the event. + */ + type?: string; + } -export interface ViewReportClickEventArgs { - - /** true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the parameter collection. - */ - parameters?: any; - - /** returns the report model. - */ - model?: any; - - /** returns the name of the event. - */ - type?: string; -} - -export interface DataSource { - - /** Gets or sets the name of the data source. - * @Default {empty} - */ - name?: string; - - /** Gets or sets the values of data source. - * @Default {[]} - */ - values?: any[]; -} + export interface ViewReportClickEventArgs { + + /** true if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the parameter collection. + */ + parameters?: any; + + /** returns the report model. + */ + model?: any; + + /** returns the name of the event. + */ + type?: string; + } + + export interface DataSource { + + /** Gets or sets the name of the data source. + * @Default {empty} + */ + name?: string; + + /** Gets or sets the values of data source. + * @Default {[]} + */ + values?: any[]; + } -export interface ExportSettings { + export interface ExportSettings { - /** Specifies the export formats. - * @Default {ej.ReportViewer.ExportOptions.All} - */ - exportOptions?: ej.ReportViewer.ExportOptions|string; + /** Specifies the export formats. + * @Default {ej.ReportViewer.ExportOptions.All} + */ + exportOptions?: ej.ReportViewer.ExportOptions | string; - /** Specifies the excel export format. - * @Default {ej.ReportViewer.ExcelFormats.Excel97to2003} - */ - excelFormat?: ej.ReportViewer.ExcelFormats|string; + /** Specifies the excel export format. + * @Default {ej.ReportViewer.ExcelFormats.Excel97to2003} + */ + excelFormat?: ej.ReportViewer.ExcelFormats | string; - /** Specifies the word export format. - * @Default {ej.ReportViewer.WordFormats.Doc} - */ - wordFormat?: ej.ReportViewer.WordFormats|string; -} + /** Specifies the word export format. + * @Default {ej.ReportViewer.WordFormats.Doc} + */ + wordFormat?: ej.ReportViewer.WordFormats | string; + } -export interface PageSettings { + export interface PageSettings { - /** Specifies the print layout orientation. - * @Default {null} - */ - orientation?: ej.ReportViewer.Orientation|string; + /** Specifies the print layout orientation. + * @Default {null} + */ + orientation?: ej.ReportViewer.Orientation | string; - /** Specifies the paper size of print layout. - * @Default {null} - */ - paperSize?: ej.ReportViewer.PaperSize|string; -} + /** Specifies the paper size of print layout. + * @Default {null} + */ + paperSize?: ej.ReportViewer.PaperSize | string; + } -export interface Parameter { + export interface Parameter { - /** Gets or sets the parameter labels. - * @Default {null} - */ - labels?: any[]; + /** Gets or sets the parameter labels. + * @Default {null} + */ + labels?: any[]; - /** Gets or sets the name of the parameter. - * @Default {empty} - */ - name?: string; + /** Gets or sets the name of the parameter. + * @Default {empty} + */ + name?: string; - /** Gets or sets whether the parameter allows nullable value or not. - * @Default {false} - */ - nullable?: boolean; + /** Gets or sets whether the parameter allows nullable value or not. + * @Default {false} + */ + nullable?: boolean; - /** Gets or sets the prompt message associated with the specified parameter. - * @Default {empty} - */ - prompt?: string; + /** Gets or sets the prompt message associated with the specified parameter. + * @Default {empty} + */ + prompt?: string; - /** Gets or sets the parameter values. - * @Default {[]} - */ - values?: any[]; -} + /** Gets or sets the parameter values. + * @Default {[]} + */ + values?: any[]; + } -export interface ToolbarSettings { + export interface ToolbarSettings { - /** Fires when user click on toolbar item in the toolbar. - * @Default {empty} - */ - click?: string; + /** Fires when user click on toolbar item in the toolbar. + * @Default {empty} + */ + click?: string; - /** Specifies the toolbar items. - * @Default {ej.ReportViewer.ToolbarItems.All} - */ - items?: ej.ReportViewer.ToolbarItems|string; + /** Specifies the toolbar items. + * @Default {ej.ReportViewer.ToolbarItems.All} + */ + items?: ej.ReportViewer.ToolbarItems | string; - /** Shows or hides the toolbar. - * @Default {true} - */ - showToolbar?: boolean; + /** Shows or hides the toolbar. + * @Default {true} + */ + showToolbar?: boolean; - /** Shows or hides the tooltip of toolbar items. - * @Default {true} - */ - showTooltip?: boolean; + /** Shows or hides the tooltip of toolbar items. + * @Default {true} + */ + showTooltip?: boolean; - /** Specifies the toolbar template ID. - * @Default {empty} - */ - templateId?: string; -} + /** Specifies the toolbar template ID. + * @Default {empty} + */ + templateId?: string; + } -enum ExportOptions { + enum ExportOptions { - ///Specifies the All property in ExportOptions to get all available options. - All, + ///Specifies the All property in ExportOptions to get all available options. + All, - ///Specifies the PDF property in ExportOptions to get PDF option. - PDF, + ///Specifies the PDF property in ExportOptions to get PDF option. + PDF, - ///Specifies the Word property in ExportOptions to get Word option. - Word, + ///Specifies the Word property in ExportOptions to get Word option. + Word, - ///Specifies the Excel property in ExportOptions to get Excel option. - Excel, + ///Specifies the Excel property in ExportOptions to get Excel option. + Excel, - ///Specifies the HTML property in ExportOptions to get HTML option. - HTML -} + ///Specifies the HTML property in ExportOptions to get HTML option. + HTML + } -enum ExcelFormats { + enum ExcelFormats { - ///Specifies the Excel97to2003 property in ExcelFormats to get specified version of exported format. - Excel97to2003, + ///Specifies the Excel97to2003 property in ExcelFormats to get specified version of exported format. + Excel97to2003, - ///Specifies the Excel2007 property in ExcelFormats to get specified version of exported format. - Excel2007, + ///Specifies the Excel2007 property in ExcelFormats to get specified version of exported format. + Excel2007, - ///Specifies the Excel2010 property in ExcelFormats to get specified version of exported format. - Excel2010, + ///Specifies the Excel2010 property in ExcelFormats to get specified version of exported format. + Excel2010, - ///Specifies the Excel2013 property in ExcelFormats to get specified version of exported format. - Excel2013 -} + ///Specifies the Excel2013 property in ExcelFormats to get specified version of exported format. + Excel2013 + } -enum WordFormats { + enum WordFormats { - ///Specifies the Doc property in WordFormats to get specified version of exported format. - Doc, + ///Specifies the Doc property in WordFormats to get specified version of exported format. + Doc, - ///Specifies the Dot property in WordFormats to get specified version of exported format. - Dot, + ///Specifies the Dot property in WordFormats to get specified version of exported format. + Dot, - ///Specifies the DOCX property in WordFormats to get specified version of exported format. - DOCX, + ///Specifies the DOCX property in WordFormats to get specified version of exported format. + DOCX, - ///Specifies the Word2007 property in WordFormats to get specified version of exported format. - Word2007, + ///Specifies the Word2007 property in WordFormats to get specified version of exported format. + Word2007, - ///Specifies the Word2010 property in WordFormats to get specified version of exported format. - Word2010, + ///Specifies the Word2010 property in WordFormats to get specified version of exported format. + Word2010, - ///Specifies the Word2013 property in WordFormats to get specified version of exported format. - Word2013, + ///Specifies the Word2013 property in WordFormats to get specified version of exported format. + Word2013, - ///Specifies the Word2007Dotx property in WordFormats to get specified version of exported format. - Word2007Dotx, + ///Specifies the Word2007Dotx property in WordFormats to get specified version of exported format. + Word2007Dotx, - ///Specifies the Word2010Dotx property in WordFormats to get specified version of exported format. - Word2010Dotx, + ///Specifies the Word2010Dotx property in WordFormats to get specified version of exported format. + Word2010Dotx, - ///Specifies the Word2013Dotx property in WordFormats to get specified version of exported format. - Word2013Dotx, + ///Specifies the Word2013Dotx property in WordFormats to get specified version of exported format. + Word2013Dotx, - ///Specifies the Word2007Docm property in WordFormats to get specified version of exported format. - Word2007Docm, + ///Specifies the Word2007Docm property in WordFormats to get specified version of exported format. + Word2007Docm, - ///Specifies the Word2010Docm property in WordFormats to get specified version of exported format. - Word2010Docm, + ///Specifies the Word2010Docm property in WordFormats to get specified version of exported format. + Word2010Docm, - ///Specifies the Word2013Docm property in WordFormats to get specified version of exported format. - Word2013Docm, + ///Specifies the Word2013Docm property in WordFormats to get specified version of exported format. + Word2013Docm, - ///Specifies the Word2007Dotm property in WordFormats to get specified version of exported format. - Word2007Dotm, + ///Specifies the Word2007Dotm property in WordFormats to get specified version of exported format. + Word2007Dotm, - ///Specifies the Word2010Dotm property in WordFormats to get specified version of exported format. - Word2010Dotm, + ///Specifies the Word2010Dotm property in WordFormats to get specified version of exported format. + Word2010Dotm, - ///Specifies the Word2013Dotm property in WordFormats to get specified version of exported format. - Word2013Dotm, + ///Specifies the Word2013Dotm property in WordFormats to get specified version of exported format. + Word2013Dotm, - ///Specifies the RTF property in WordFormats to get specified version of exported format. - RTF, + ///Specifies the RTF property in WordFormats to get specified version of exported format. + RTF, - ///Specifies the Txt property in WordFormats to get specified version of exported format. - Txt, + ///Specifies the Txt property in WordFormats to get specified version of exported format. + Txt, - ///Specifies the EPUB property in WordFormats to get specified version of exported format. - EPUB, + ///Specifies the EPUB property in WordFormats to get specified version of exported format. + EPUB, - ///Specifies the HTML property in WordFormats to get specified version of exported format. - HTML, + ///Specifies the HTML property in WordFormats to get specified version of exported format. + HTML, - ///Specifies the XML property in WordFormats to get specified version of exported format. - XML, + ///Specifies the XML property in WordFormats to get specified version of exported format. + XML, - ///Specifies the Automatic property in WordFormats to get specified version of exported format. - Automatic -} + ///Specifies the Automatic property in WordFormats to get specified version of exported format. + Automatic + } -enum Orientation { + enum Orientation { - ///Specifies the Landscape property in pageSettings.orientation to get specified layout. - Landscape, + ///Specifies the Landscape property in pageSettings.orientation to get specified layout. + Landscape, - ///Specifies the portrait property in pageSettings.orientation to get specified layout. - Portrait -} + ///Specifies the portrait property in pageSettings.orientation to get specified layout. + Portrait + } -enum PaperSize { + enum PaperSize { - ///Specifies the A3 as value in pageSettings.paperSize to get specified size. - A3, + ///Specifies the A3 as value in pageSettings.paperSize to get specified size. + A3, - ///Specifies the A4 as value in pageSettings.paperSize to get specified size. - Portrait, + ///Specifies the A4 as value in pageSettings.paperSize to get specified size. + Portrait, - ///Specifies the B4(JIS) as value in pageSettings.paperSize to get specified size. - B4_JIS, + ///Specifies the B4(JIS) as value in pageSettings.paperSize to get specified size. + B4_JIS, - ///Specifies the B5(JIS) as value in pageSettings.paperSize to get specified size. - B5_JIS, + ///Specifies the B5(JIS) as value in pageSettings.paperSize to get specified size. + B5_JIS, - ///Specifies the Envelope #10 as value in pageSettings.paperSize to get specified size. - Envelope_10, + ///Specifies the Envelope #10 as value in pageSettings.paperSize to get specified size. + Envelope_10, - ///Specifies the Envelope as value in pageSettings.paperSize to get specified size. - Envelope_Monarch, + ///Specifies the Envelope as value in pageSettings.paperSize to get specified size. + Envelope_Monarch, - ///Specifies the Executive as value in pageSettings.paperSize to get specified size. - Executive, + ///Specifies the Executive as value in pageSettings.paperSize to get specified size. + Executive, - ///Specifies the Legal as value in pageSettings.paperSize to get specified size. - Legal, + ///Specifies the Legal as value in pageSettings.paperSize to get specified size. + Legal, - ///Specifies the Letter as value in pageSettings.paperSize to get specified size. - Letter, + ///Specifies the Letter as value in pageSettings.paperSize to get specified size. + Letter, - ///Specifies the Tabloid as value in pageSettings.paperSize to get specified size. - Tabloid, + ///Specifies the Tabloid as value in pageSettings.paperSize to get specified size. + Tabloid, - ///Specifies the Custom as value in pageSettings.paperSize to get specified size. - Custom -} + ///Specifies the Custom as value in pageSettings.paperSize to get specified size. + Custom + } -enum PrintOptions { + enum PrintOptions { - ///Specifies the Default property in printOptions. - Default, + ///Specifies the Default property in printOptions. + Default, - ///Specifies the NewTab property in printOptions. - NewTab, + ///Specifies the NewTab property in printOptions. + NewTab, - ///Specifies the None property in printOptions. - None -} + ///Specifies the None property in printOptions. + None + } -enum ProcessingMode { + enum ProcessingMode { - ///Specifies the Remote property in processingMode. - Remote, + ///Specifies the Remote property in processingMode. + Remote, - ///Specifies the Local property in processingMode. - Local -} + ///Specifies the Local property in processingMode. + Local + } -enum RenderMode { + enum RenderMode { - ///Specifies the Default property in RenderMode to get default output. - Default, + ///Specifies the Default property in RenderMode to get default output. + Default, - ///Specifies the Mobile property in RenderMode to get specified output. - Mobile, + ///Specifies the Mobile property in RenderMode to get specified output. + Mobile, - ///Specifies the Desktop property in RenderMode to get specified output. - Desktop -} + ///Specifies the Desktop property in RenderMode to get specified output. + Desktop + } -enum ToolbarItems { + enum ToolbarItems { - ///Specifies the Print as value in ToolbarItems to get specified item. - Print, + ///Specifies the Print as value in ToolbarItems to get specified item. + Print, - ///Specifies the Refresh as value in ToolbarItems to get specified item. - Refresh, + ///Specifies the Refresh as value in ToolbarItems to get specified item. + Refresh, - ///Specifies the Zoom as value in ToolbarItems to get specified item. - Zoom, + ///Specifies the Zoom as value in ToolbarItems to get specified item. + Zoom, - ///Specifies the FittoPage as value in ToolbarItems to get specified item. - FittoPage, + ///Specifies the FittoPage as value in ToolbarItems to get specified item. + FittoPage, - ///Specifies the Export as value in ToolbarItems to get specified item. - Export, + ///Specifies the Export as value in ToolbarItems to get specified item. + Export, - ///Specifies the PageNavigation as value in ToolbarItems to get specified item. - PageNavigation, + ///Specifies the PageNavigation as value in ToolbarItems to get specified item. + PageNavigation, - ///Specifies the Parameters as value in ToolbarItems to get specified item. - Parameters, + ///Specifies the Parameters as value in ToolbarItems to get specified item. + Parameters, - ///Specifies the PrintLayout as value in ToolbarItems to get specified item. - PrintLayout, + ///Specifies the PrintLayout as value in ToolbarItems to get specified item. + PrintLayout, - ///Specifies the PageSetup as value in ToolbarItems to get specified item. - PageSetup -} + ///Specifies the PageSetup as value in ToolbarItems to get specified item. + PageSetup + } -} + } -class TreeGrid extends ej.Widget { - static fn: TreeGrid; - constructor(element: JQuery | Element, options?: TreeGrid.Model); - static Locale: any; - model: TreeGrid.Model; - defaults: TreeGrid.Model; + class TreeGrid extends ej.Widget { + static fn: TreeGrid; + constructor(element: JQuery | Element, options?: TreeGrid.Model); + static Locale: any; + model: TreeGrid.Model; + defaults: TreeGrid.Model; - /** Add a new row in TreeGrid, while allowAdding is set to true - * @param {any} Item to add in TreeGrid row. - * @param {string} Defines in which position the row wants to be added - * @returns {void} - */ - addRow(data: any, rowPosition: string): void; - - /** To clear all the selection in TreeGrid - * @param {number} you can pass a row index to clear the row selection. - * @returns {void} - */ - clearSelection(index: number): void; - - /** To select cell based on the cell and row index dynamically. - * @param {Array} array of cell indexes to be select - * @param {boolean} Defines that we need to preserve the previously selected cells or not - * @returns {void} - */ - selectCells(Indexes: any[], preservePreviousSelectedCell: boolean): void; - - /** To rename a column with the specified name - * @param {number} Index of the column to be renamed - * @param {string} Header text of the column - * @returns {void} - */ - renameColumn(columnIndex: number, name: string): void; - - /** To delete the specified column - * @param {number} Index of the column to be deleted - * @returns {void} - */ - deleteColumn(columnIndex: number): void; - - /** To collapse all the parent items in tree grid - * @returns {void} - */ - collapseAll(): void; - - /** To hide the column by using header text - * @param {string} you can pass a header text of a column to hide. - * @returns {void} - */ - hideColumn(headerText: string): void; - - /** Expands the records at specific hierarchical level - * @param {number} you can pass the level as index number to expand - * @returns {void} - */ - expandAtLevel(index: number): void; - - /** Collapses the records at specific hierarchical level - * @param {number} you can pass the particular level as index. - * @returns {void} - */ - collapseAtLevel(index: number): void; - - /** To refresh the changes in tree grid - * @param {Array} Pass which data source you want to show in tree grid - * @param {any} Pass which data you want to show in tree grid - * @returns {void} - */ - refresh(dataSource: any[], query: any): void; - - /** Freeze all the columns preceding to the column specified by the field name. - * @param {string} Freeze all Columns before this field column. - * @returns {void} - */ - freezePrecedingColumns(field: string): void; - - /** Freeze/unfreeze the specified column. - * @param {string} Freeze/Unfreeze this field column. - * @param {boolean} Decides to Freeze/Unfreeze this field column. - * @returns {void} - */ - freezeColumn(field: string, isFrozen: boolean): void; - - /** To save the edited cell in TreeGrid - * @returns {void} - */ - saveCell(): void; - - /** To search an item with search string provided at the run time - * @param {string} you can pass a searchString to search the tree grid - * @returns {void} - */ - search(searchString: string): void; - - /** To show the column by using header text - * @param {string} you can pass a header text of a column to show. - * @returns {void} - */ - showColumn(headerText: string): void; - - /** To sorting the data based on the particular fields - * @param {string} you can pass a name of column to sort. - * @param {string} you can pass a sort direction to sort the column. - * @returns {void} - */ - sortColumn(columnName: string, columnSortDirection: string): void; - - /** To reorder the column with field name and target index values - * @param {string} you can pass a name of column to reorder. - * @param {string} you can pass a target column index to be inserted. - * @returns {void} - */ - reorderColumn(fieldName: string, targetIndex: string): void; -} -export namespace TreeGrid { - -export interface Model { - - /** Enables or disables the ability to resize the column width interactively. - * @Default {false} - */ - allowColumnResize?: boolean; - - /** Enables or disables the option for column reordering - * @Default {false} - */ - allowColumnReordering?: boolean; - - /** Enables or disables the ability to drag and drop the row interactively to reorder the rows. - * @Default {false} - */ - allowDragAndDrop?: boolean; - - /** Enables or disables the ability to filter the data on all the columns. Enabling this property will display a row with editor controls corresponding to each column. - * You can restrict filtering on particular column by disabling this property directly on that column instance itself. - * @Default {false} - */ - allowFiltering?: boolean; - - /** Enables or disables keyboard navigation. - * @Default {true} - */ - allowKeyboardNavigation?: boolean; - - /** Enables or disables the ability to sort the rows based on multiple columns/fields by clicking on each column header. Rows will be sorted recursively on clicking the column headers. - * @Default {false} - */ - allowMultiSorting?: boolean; - - /** Enables or disables the ability to select a row interactively. - * @Default {true} - */ - allowSelection?: boolean; - - /** Enables or disables the ability to sort the rows based on a single field/column by clicking on that column header. When enabled, rows can be sorted only by single field/column. - * @Default {false} - */ - allowSorting?: boolean; - - /** Enables/disables pagination of rows in TreeGrid - * @Default {false} - */ - allowPaging?: boolean; - - /** Specifies the id of the template that has to be applied for alternate rows. - */ - altRowTemplateID?: string; - - /** Specifies the mapping property path for sub tasks in datasource - */ - childMapping?: string; - - /** Option for adding columns; each column has the option to bind to a field in the dataSource. - */ - columns?: Column[]; - - /** To Specify the column fields to be displayed in the dialog while inserting a column using column menu. - * @Default {[]} - */ - columnDialogFields?: any[]; - - /** Options for displaying and customizing context menu items. - */ - contextMenuSettings?: ContextMenuSettings; - - /** Specify the CSS class for TreeGrid to achieve custom theme. - */ - cssClass?: string; - - /** Specifies hierarchical or self-referential data to populate the TreeGrid. - * @Default {null} - */ - dataSource?: any[]; - - /** Specifies whether to wrap the header text when it is overflown i.e., when it exceeds the header width. - * @Default {none} - */ - headerTextOverflow?: string; - - /** Options for displaying and customizing the tooltip. This tooltip will show the preview of the row that is being dragged. - */ - dragTooltip?: DragTooltip; - - /** Options for enabling and configuring the editing related operations. - */ - editSettings?: EditSettings; - - /** Specifies whether to render alternate rows in different background colors. - * @Default {true} - */ - enableAltRow?: boolean; - - /** Specifies whether to load all the rows in collapsed state when the TreeGrid is rendered for the first time. - * @Default {false} - */ - enableCollapseAll?: boolean; - - /** Specifies whether to resize TreeGrid whenever window size changes. - * @Default {false} - */ - enableResize?: boolean; - - /** Specifies whether to render only the visual elements that are visible in the UI. When you enable this property, it will reduce the loading time for loading large number of records. - * @Default {false} - */ - enableVirtualization?: boolean; - - /** Specifies the settings for column resize - */ - columnResizeSettings?: ColumnResizeSettings; - - /** Options for filtering and customizing filter actions. - */ - filterSettings?: FilterSettings; - - /** Specifies the localization information to customize the User Interface (UI) to support regional language and culture - * @Default {en-US} - */ - locale?: string; - - /** Enables or disables internal parsing of a row. When disabled this property, row will be displayed using the defined template without any internal event bindings. - * @Default {true} - */ - parseRowTemplate?: boolean; - - /** Specifies the name of the field in the dataSource, which contains the id of that row. - */ - idMapping?: string; - - /** Enables or disables the responsiveness of TreeGrid - * @Default {false} - */ - isResponsive?: boolean; - - /** Specifies the name of the field in the dataSource, which contains the parent's id. This is necessary to form a parent-child hierarchy, if the dataSource contains self-referential data. - */ - parentIdMapping?: string; - - /** Specifies the options for customizing the pager. - */ - pageSettings?: PageSettings; - - /** Specifies the template for cell tooltip - * @Default {null} - */ - cellTooltipTemplate?: string; - - /** Specifies ej.Query to select data from the dataSource. This property is applicable only when the dataSource is ej.DataManager. - * @Default {null} - */ - query?: any; - - /** Specifies the height of a single row in tree grid. Also, we need to set same height in the CSS style with class name e-rowcell. - * @Default {30} - */ - rowHeight?: number; - - /** Specifies the id of the template to be applied for all the rows. - */ - rowTemplateID?: string; - - /** Specifies the index of the selected row. - * @Default {-1} - */ - selectedRowIndex?: number; - - /** Specifies the settings for row and cell selection. - */ - selectionSettings?: SelectionSettings; - - /** Enables/disables the options for inserting , deleting and renaming columns. - * @Default {false} - */ - showColumnOptions?: boolean; - - /** Controls the visibility of the menu button, which is displayed on the column header. Clicking on this button will show a popup menu. When you choose Columns item from this popup, - * a list box with column names will be shown, from which you can select/deselect a column name to control the visibility of the respective columns. - * @Default {false} - */ - showColumnChooser?: boolean; - - /** Specifies the visibility of details view - * @Default {false} - */ - showDetailsRow?: boolean; - - /** Specifies the visibility of the expander column which is used to expand or collapse the details view - * @Default {false} - */ - showDetailsRowInfoColumn?: boolean; - - /** Specifies the template for details view - */ - detailsTemplate?: string; - - /** Specifies the row height of the details view - * @Default {100} - */ - detailsRowHeight?: number; + /** Add a new row in TreeGrid, while allowAdding is set to true + * @param {any} Item to add in TreeGrid row. + * @param {string} Defines in which position the row wants to be added + * @returns {void} + */ + addRow(data: any, rowPosition: string): void; + + /** To clear all the selection in TreeGrid + * @param {number} you can pass a row index to clear the row selection. + * @returns {void} + */ + clearSelection(index: number): void; + + /** To select cell based on the cell and row index dynamically. + * @param {Array} array of cell indexes to be select + * @param {boolean} Defines that we need to preserve the previously selected cells or not + * @returns {void} + */ + selectCells(Indexes: any[], preservePreviousSelectedCell: boolean): void; + + /** To rename a column with the specified name + * @param {number} Index of the column to be renamed + * @param {string} Header text of the column + * @returns {void} + */ + renameColumn(columnIndex: number, name: string): void; + + /** To delete the specified column + * @param {number} Index of the column to be deleted + * @returns {void} + */ + deleteColumn(columnIndex: number): void; + + /** To collapse all the parent items in tree grid + * @returns {void} + */ + collapseAll(): void; + + /** To hide the column by using header text + * @param {string} you can pass a header text of a column to hide. + * @returns {void} + */ + hideColumn(headerText: string): void; + + /** Expands the records at specific hierarchical level + * @param {number} you can pass the level as index number to expand + * @returns {void} + */ + expandAtLevel(index: number): void; + + /** Collapses the records at specific hierarchical level + * @param {number} you can pass the particular level as index. + * @returns {void} + */ + collapseAtLevel(index: number): void; + + /** To refresh the changes in tree grid + * @param {Array} Pass which data source you want to show in tree grid + * @param {any} Pass which data you want to show in tree grid + * @returns {void} + */ + refresh(dataSource: any[], query: any): void; + + /** Freeze all the columns preceding to the column specified by the field name. + * @param {string} Freeze all Columns before this field column. + * @returns {void} + */ + freezePrecedingColumns(field: string): void; + + /** Freeze/unfreeze the specified column. + * @param {string} Freeze/Unfreeze this field column. + * @param {boolean} Decides to Freeze/Unfreeze this field column. + * @returns {void} + */ + freezeColumn(field: string, isFrozen: boolean): void; + + /** To save the edited cell in TreeGrid + * @returns {void} + */ + saveCell(): void; + + /** To search an item with search string provided at the run time + * @param {string} you can pass a searchString to search the tree grid + * @returns {void} + */ + search(searchString: string): void; + + /** To show the column by using header text + * @param {string} you can pass a header text of a column to show. + * @returns {void} + */ + showColumn(headerText: string): void; + + /** To sorting the data based on the particular fields + * @param {string} you can pass a name of column to sort. + * @param {string} you can pass a sort direction to sort the column. + * @returns {void} + */ + sortColumn(columnName: string, columnSortDirection: string): void; + + /** To reorder the column with field name and target index values + * @param {string} you can pass a name of column to reorder. + * @param {string} you can pass a target column index to be inserted. + * @returns {void} + */ + reorderColumn(fieldName: string, targetIndex: string): void; + } + export namespace TreeGrid { + + export interface Model { + + /** Enables or disables the ability to resize the column width interactively. + * @Default {false} + */ + allowColumnResize?: boolean; + + /** Enables or disables the option for column reordering + * @Default {false} + */ + allowColumnReordering?: boolean; + + /** Enables or disables the ability to drag and drop the row interactively to reorder the rows. + * @Default {false} + */ + allowDragAndDrop?: boolean; + + /** Enables or disables the ability to filter the data on all the columns. Enabling this property will display a row with editor controls corresponding to each column. + * You can restrict filtering on particular column by disabling this property directly on that column instance itself. + * @Default {false} + */ + allowFiltering?: boolean; + + /** Enables or disables keyboard navigation. + * @Default {true} + */ + allowKeyboardNavigation?: boolean; + + /** Enables or disables the ability to sort the rows based on multiple columns/fields by clicking on each column header. Rows will be sorted recursively on clicking the column headers. + * @Default {false} + */ + allowMultiSorting?: boolean; + + /** Enables or disables the ability to select a row interactively. + * @Default {true} + */ + allowSelection?: boolean; + + /** Enables or disables the ability to sort the rows based on a single field/column by clicking on that column header. When enabled, rows can be sorted only by single field/column. + * @Default {false} + */ + allowSorting?: boolean; + + /** Enables/disables pagination of rows in TreeGrid + * @Default {false} + */ + allowPaging?: boolean; + + /** Specifies the id of the template that has to be applied for alternate rows. + */ + altRowTemplateID?: string; + + /** Specifies the mapping property path for sub tasks in datasource + */ + childMapping?: string; + + /** Option for adding columns; each column has the option to bind to a field in the dataSource. + */ + columns?: Column[]; + + /** To Specify the column fields to be displayed in the dialog while inserting a column using column menu. + * @Default {[]} + */ + columnDialogFields?: any[]; + + /** Options for displaying and customizing context menu items. + */ + contextMenuSettings?: ContextMenuSettings; + + /** Specify the CSS class for TreeGrid to achieve custom theme. + */ + cssClass?: string; + + /** Specifies hierarchical or self-referential data to populate the TreeGrid. + * @Default {null} + */ + dataSource?: any[]; + + /** Specifies whether to wrap the header text when it is overflown i.e., when it exceeds the header width. + * @Default {none} + */ + headerTextOverflow?: string; + + /** Options for displaying and customizing the tooltip. This tooltip will show the preview of the row that is being dragged. + */ + dragTooltip?: DragTooltip; + + /** Options for enabling and configuring the editing related operations. + */ + editSettings?: EditSettings; + + /** Specifies whether to render alternate rows in different background colors. + * @Default {true} + */ + enableAltRow?: boolean; + + /** Specifies whether to load all the rows in collapsed state when the TreeGrid is rendered for the first time. + * @Default {false} + */ + enableCollapseAll?: boolean; + + /** Specifies whether to resize TreeGrid whenever window size changes. + * @Default {false} + */ + enableResize?: boolean; + + /** Specifies whether to render only the visual elements that are visible in the UI. When you enable this property, it will reduce the loading time for loading large number of records. + * @Default {false} + */ + enableVirtualization?: boolean; + + /** Specifies the settings for column resize + */ + columnResizeSettings?: ColumnResizeSettings; + + /** Options for filtering and customizing filter actions. + */ + filterSettings?: FilterSettings; + + /** Specifies the localization information to customize the User Interface (UI) to support regional language and culture + * @Default {en-US} + */ + locale?: string; + + /** Enables or disables internal parsing of a row. When disabled this property, row will be displayed using the defined template without any internal event bindings. + * @Default {true} + */ + parseRowTemplate?: boolean; + + /** Specifies the name of the field in the dataSource, which contains the id of that row. + */ + idMapping?: string; + + /** Enables or disables the responsiveness of TreeGrid + * @Default {false} + */ + isResponsive?: boolean; + + /** Specifies the name of the field in the dataSource, which contains the parent's id. This is necessary to form a parent-child hierarchy, if the dataSource contains self-referential data. + */ + parentIdMapping?: string; + + /** Specifies the options for customizing the pager. + */ + pageSettings?: PageSettings; + + /** Specifies the template for cell tooltip + * @Default {null} + */ + cellTooltipTemplate?: string; + + /** Specifies ej.Query to select data from the dataSource. This property is applicable only when the dataSource is ej.DataManager. + * @Default {null} + */ + query?: any; + + /** Specifies the height of a single row in tree grid. Also, we need to set same height in the CSS style with class name e-rowcell. + * @Default {30} + */ + rowHeight?: number; + + /** Specifies the id of the template to be applied for all the rows. + */ + rowTemplateID?: string; + + /** Specifies the index of the selected row. + * @Default {-1} + */ + selectedRowIndex?: number; + + /** Specifies the settings for row and cell selection. + */ + selectionSettings?: SelectionSettings; + + /** Enables/disables the options for inserting , deleting and renaming columns. + * @Default {false} + */ + showColumnOptions?: boolean; + + /** Controls the visibility of the menu button, which is displayed on the column header. Clicking on this button will show a popup menu. When you choose Columns item from this popup, + * a list box with column names will be shown, from which you can select/deselect a column name to control the visibility of the respective columns. + * @Default {false} + */ + showColumnChooser?: boolean; + + /** Specifies the visibility of details view + * @Default {false} + */ + showDetailsRow?: boolean; + + /** Specifies the visibility of the expander column which is used to expand or collapse the details view + * @Default {false} + */ + showDetailsRowInfoColumn?: boolean; + + /** Specifies the template for details view + */ + detailsTemplate?: string; + + /** Specifies the row height of the details view + * @Default {100} + */ + detailsRowHeight?: number; - /** Specifies the visibility of summary row - * @Default {false} - */ - showSummaryRow?: boolean; + /** Specifies the visibility of summary row + * @Default {false} + */ + showSummaryRow?: boolean; - /** Specifies the visibility of total summary row for the corresponding summary column - * @Default {false} - */ - showTotalSummary?: boolean; + /** Specifies the visibility of total summary row for the corresponding summary column + * @Default {false} + */ + showTotalSummary?: boolean; - /** Specifies the summary row collection object to be displayed - * @Default {[]} - */ - summaryRows?: any[]; + /** Specifies the summary row collection object to be displayed + * @Default {[]} + */ + summaryRows?: any[]; - /** Specifies whether to show tooltip when mouse is hovered on the cell. - * @Default {true} - */ - showGridCellTooltip?: boolean; + /** Specifies whether to show tooltip when mouse is hovered on the cell. + * @Default {true} + */ + showGridCellTooltip?: boolean; - /** Specifies whether to show tooltip for the cells, which has expander button. - * @Default {true} - */ - showGridExpandCellTooltip?: boolean; + /** Specifies whether to show tooltip for the cells, which has expander button. + * @Default {true} + */ + showGridExpandCellTooltip?: boolean; - /** Options for setting width and height for TreeGrid. - */ - sizeSettings?: SizeSettings; + /** Options for setting width and height for TreeGrid. + */ + sizeSettings?: SizeSettings; - /** Options for sorting the rows. - */ - sortSettings?: SortSettings; + /** Options for sorting the rows. + */ + sortSettings?: SortSettings; - /** Options for displaying and customizing the toolbar items. - */ - toolbarSettings?: ToolbarSettings; + /** Options for displaying and customizing the toolbar items. + */ + toolbarSettings?: ToolbarSettings; - /** Specifies the index of the column that needs to have the expander button. By default, cells in the first column contain the expander button. - * @Default {0} - */ - treeColumnIndex?: number; + /** Specifies the index of the column that needs to have the expander button. By default, cells in the first column contain the expander button. + * @Default {0} + */ + treeColumnIndex?: number; - /** Triggered before every success event of TreeGrid action. */ - actionBegin?(e: ActionBeginEventArgs): void; + /** Triggered before every success event of TreeGrid action. */ + actionBegin?(e: ActionBeginEventArgs): void; - /** Triggered for every TreeGrid action success event. */ - actionComplete?(e: ActionCompleteEventArgs): void; + /** Triggered for every TreeGrid action success event. */ + actionComplete?(e: ActionCompleteEventArgs): void; - /** Triggered while enter the edit mode in the TreeGrid cell */ - beginEdit?(e: BeginEditEventArgs): void; + /** Triggered while enter the edit mode in the TreeGrid cell */ + beginEdit?(e: BeginEditEventArgs): void; - /** Triggered after collapsed the TreeGrid record */ - collapsed?(e: CollapsedEventArgs): void; + /** Triggered after collapsed the TreeGrid record */ + collapsed?(e: CollapsedEventArgs): void; - /** Triggered while collapsing the TreeGrid record */ - collapsing?(e: CollapsingEventArgs): void; + /** Triggered while collapsing the TreeGrid record */ + collapsing?(e: CollapsingEventArgs): void; - /** Triggered while clicking a row, even when allowSelection property is disabled. */ - recordClick?(e: RecordClickEventArgs): void; + /** Triggered while clicking a row, even when allowSelection property is disabled. */ + recordClick?(e: RecordClickEventArgs): void; - /** Triggered when you start to drag a column */ - columnDragStart?(e: ColumnDragStartEventArgs): void; + /** Triggered when you start to drag a column */ + columnDragStart?(e: ColumnDragStartEventArgs): void; - /** Triggered while dragging a column */ - columnDrag?(e: ColumnDragEventArgs): void; + /** Triggered while dragging a column */ + columnDrag?(e: ColumnDragEventArgs): void; - /** Triggered when a column is dropped */ - columnDrop?(e: ColumnDropEventArgs): void; + /** Triggered when a column is dropped */ + columnDrop?(e: ColumnDropEventArgs): void; - /** Triggered after a column resized */ - columnResized?(e: ColumnResizedEventArgs): void; + /** Triggered after a column resized */ + columnResized?(e: ColumnResizedEventArgs): void; - /** Triggered while start to resize a column */ - columnResizeStart?(e: ColumnResizeStartEventArgs): void; + /** Triggered while start to resize a column */ + columnResizeStart?(e: ColumnResizeStartEventArgs): void; - /** Triggered when a column has been resized */ - columnResizeEnd?(e: ColumnResizeEndEventArgs): void; + /** Triggered when a column has been resized */ + columnResizeEnd?(e: ColumnResizeEndEventArgs): void; - /** Triggered while Context Menu is rendered in TreeGrid control */ - contextMenuOpen?(e: ContextMenuOpenEventArgs): void; + /** Triggered while Context Menu is rendered in TreeGrid control */ + contextMenuOpen?(e: ContextMenuOpenEventArgs): void; - /** Triggered when TreeGrid is rendered completely */ - create?(e: CreateEventArgs): void; + /** Triggered when TreeGrid is rendered completely */ + create?(e: CreateEventArgs): void; - /** Triggered after saved the modified cellValue in TreeGrid */ - endEdit?(e: EndEditEventArgs): void; + /** Triggered after saved the modified cellValue in TreeGrid */ + endEdit?(e: EndEditEventArgs): void; - /** Triggered after expand the record */ - expanded?(e: ExpandedEventArgs): void; + /** Triggered after expand the record */ + expanded?(e: ExpandedEventArgs): void; - /** Triggered while expanding the TreeGrid record */ - expanding?(e: ExpandingEventArgs): void; + /** Triggered while expanding the TreeGrid record */ + expanding?(e: ExpandingEventArgs): void; - /** Triggered while Treegrid is loaded */ - load?(e: LoadEventArgs): void; + /** Triggered while Treegrid is loaded */ + load?(e: LoadEventArgs): void; - /** Triggered while rendering each cell in the TreeGrid */ - queryCellInfo?(e: QueryCellInfoEventArgs): void; + /** Triggered while rendering each cell in the TreeGrid */ + queryCellInfo?(e: QueryCellInfoEventArgs): void; - /** Triggered while rendering each row */ - rowDataBound?(e: RowDataBoundEventArgs): void; + /** Triggered while rendering each row */ + rowDataBound?(e: RowDataBoundEventArgs): void; - /** Triggered while dragging a row in TreeGrid control */ - rowDrag?(e: RowDragEventArgs): void; + /** Triggered while dragging a row in TreeGrid control */ + rowDrag?(e: RowDragEventArgs): void; - /** Triggered while start to drag row in TreeGrid control */ - rowDragStart?(e: RowDragStartEventArgs): void; + /** Triggered while start to drag row in TreeGrid control */ + rowDragStart?(e: RowDragStartEventArgs): void; - /** Triggered while drop a row in TreeGrid control */ - rowDragStop?(e: RowDragStopEventArgs): void; + /** Triggered while drop a row in TreeGrid control */ + rowDragStop?(e: RowDragStopEventArgs): void; - /** Triggered before selecting a cell */ - cellSelecting?(e: CellSelectingEventArgs): void; + /** Triggered before selecting a cell */ + cellSelecting?(e: CellSelectingEventArgs): void; - /** Triggered after selected a cell */ - cellSelected?(e: CellSelectedEventArgs): void; + /** Triggered after selected a cell */ + cellSelected?(e: CellSelectedEventArgs): void; - /** Triggered after the row is selected. */ - rowSelected?(e: RowSelectedEventArgs): void; + /** Triggered after the row is selected. */ + rowSelected?(e: RowSelectedEventArgs): void; - /** Triggered before the row is going to be selected. */ - rowSelecting?(e: RowSelectingEventArgs): void; + /** Triggered before the row is going to be selected. */ + rowSelecting?(e: RowSelectingEventArgs): void; - /** Triggered when toolbar item is clicked in TreeGrid. */ - toolbarClick?(e: ToolbarClickEventArgs): void; -} + /** Triggered when toolbar item is clicked in TreeGrid. */ + toolbarClick?(e: ToolbarClickEventArgs): void; + } -export interface ActionBeginEventArgs { + export interface ActionBeginEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the current grouped column field name. - */ - columnName?: string; + /** Returns the current grouped column field name. + */ + columnName?: string; - /** Returns the TreeGrid model. - */ - model?: any; + /** Returns the TreeGrid model. + */ + model?: any; - /** Returns request type. - */ - requestType?: string; + /** Returns request type. + */ + requestType?: string; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the direction of sorting ascending or descending. - */ - columnSortDirection?: string; + /** Returns the direction of sorting ascending or descending. + */ + columnSortDirection?: string; - /** Returns the value of expanding parent element. - */ - keyValue?: string; + /** Returns the value of expanding parent element. + */ + keyValue?: string; - /** Returns the data or deleting element. - */ - data?: string; -} + /** Returns the data or deleting element. + */ + data?: string; + } -export interface ActionCompleteEventArgs { + export interface ActionCompleteEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the current grouped column field name. - */ - columnName?: string; + /** Returns the current grouped column field name. + */ + columnName?: string; - /** Returns request type. - */ - requestType?: string; + /** Returns request type. + */ + requestType?: string; - /** Returns the direction of sorting ascending or descending - */ - columnSortDirection?: string; + /** Returns the direction of sorting ascending or descending + */ + columnSortDirection?: string; - /** Returns the value of searched element. - */ - keyValue?: string; + /** Returns the value of searched element. + */ + keyValue?: string; - /** Returns the data of deleted element. - */ - data?: string; + /** Returns the data of deleted element. + */ + data?: string; - /** Returns selected record index - */ - recordIndex?: number; -} + /** Returns selected record index + */ + recordIndex?: number; + } -export interface BeginEditEventArgs { + export interface BeginEditEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the row element of editing cell. - */ - rowElement?: any; + /** Returns the row element of editing cell. + */ + rowElement?: any; - /** Returns the Element of editing cell. - */ - cellElement?: any; + /** Returns the Element of editing cell. + */ + cellElement?: any; - /** Returns the data of current cell record. - */ - data?: any; + /** Returns the data of current cell record. + */ + data?: any; - /** Returns the column Index of cell belongs. - */ - columnIndex?: number; -} + /** Returns the column Index of cell belongs. + */ + columnIndex?: number; + } -export interface CollapsedEventArgs { + export interface CollapsedEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the row index of collapsed record. - */ - recordIndex?: number; + /** Returns the row index of collapsed record. + */ + recordIndex?: number; - /** Returns the data of collapsed record.. - */ - data?: any; + /** Returns the data of collapsed record.. + */ + data?: any; - /** Returns Request Type. - */ - requestType?: string; + /** Returns Request Type. + */ + requestType?: string; - /** Returns state of a record whether it is in expanded or collapsed state. - */ - expanded?: boolean; + /** Returns state of a record whether it is in expanded or collapsed state. + */ + expanded?: boolean; - /** Returns the event type. - */ - type?: string; -} + /** Returns the event type. + */ + type?: string; + } -export interface CollapsingEventArgs { + export interface CollapsingEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the row index of collapsing record. - */ - recordIndex?: number; + /** Returns the row index of collapsing record. + */ + recordIndex?: number; - /** Returns the data of collapsing record.. - */ - data?: any; + /** Returns the data of collapsing record.. + */ + data?: any; - /** Returns the event Type. - */ - type?: string; + /** Returns the event Type. + */ + type?: string; - /** Returns state of a record whether it is in expanded or collapsing state. - */ - expanded?: boolean; -} + /** Returns state of a record whether it is in expanded or collapsing state. + */ + expanded?: boolean; + } -export interface RecordClickEventArgs { + export interface RecordClickEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the element of clicked cell. - */ - cell?: any; + /** Returns the element of clicked cell. + */ + cell?: any; - /** Returns the index of the clicked cell. - */ - cellIndex?: number; + /** Returns the index of the clicked cell. + */ + cellIndex?: number; - /** Returns the data of clicked cell. - */ - cellValue?: any; + /** Returns the data of clicked cell. + */ + cellValue?: any; - /** Returns the element of the clicked row. - */ - row?: any; + /** Returns the element of the clicked row. + */ + row?: any; - /** Returns the index of the clicked row. - */ - rowIndex?: number; + /** Returns the index of the clicked row. + */ + rowIndex?: number; - /** Returns the column name of the clicked cell. - */ - columnName?: string; -} + /** Returns the column name of the clicked cell. + */ + columnName?: string; + } -export interface ColumnDragStartEventArgs { + export interface ColumnDragStartEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the control model values. - */ - model?: any; + /** Returns the control model values. + */ + model?: any; - /** Returns the event Type. - */ - type?: string; + /** Returns the event Type. + */ + type?: string; - /** Returns the column data which is dragged - */ - draggedColumn?: any; + /** Returns the column data which is dragged + */ + draggedColumn?: any; - /** Returns the index of the column being dragged - */ - draggedColumnIndex?: number; -} + /** Returns the index of the column being dragged + */ + draggedColumnIndex?: number; + } -export interface ColumnDragEventArgs { + export interface ColumnDragEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the control model values. - */ - model?: any; + /** Returns the control model values. + */ + model?: any; - /** Returns the event Type. - */ - type?: string; + /** Returns the event Type. + */ + type?: string; - /** Returns the column data which is dragged - */ - draggedColumn?: any; + /** Returns the column data which is dragged + */ + draggedColumn?: any; - /** Returns the index of the column being dragged - */ - draggedColumnIndex?: number; + /** Returns the index of the column being dragged + */ + draggedColumnIndex?: number; - /** Returns the target column data - */ - targetColumn?: any; + /** Returns the target column data + */ + targetColumn?: any; - /** Returns the index of the target column - */ - targetColumnIndex?: number; + /** Returns the index of the target column + */ + targetColumnIndex?: number; - /** Returns that we can drop over the column or not. - */ - canDrop?: boolean; -} + /** Returns that we can drop over the column or not. + */ + canDrop?: boolean; + } -export interface ColumnDropEventArgs { + export interface ColumnDropEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the control model values. - */ - model?: any; + /** Returns the control model values. + */ + model?: any; - /** Returns the event Type. - */ - type?: string; + /** Returns the event Type. + */ + type?: string; - /** Returns the column data which is dragged - */ - draggedColumn?: any; + /** Returns the column data which is dragged + */ + draggedColumn?: any; - /** Returns the index of the column being dragged - */ - draggedColumnIndex?: number; + /** Returns the index of the column being dragged + */ + draggedColumnIndex?: number; - /** Returns the target column data - */ - targetColumn?: any; + /** Returns the target column data + */ + targetColumn?: any; - /** Returns the index of the target column - */ - targetColumnIndex?: number; -} + /** Returns the index of the target column + */ + targetColumnIndex?: number; + } -export interface ColumnResizedEventArgs { + export interface ColumnResizedEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the control model values. - */ - model?: any; + /** Returns the control model values. + */ + model?: any; - /** Returns the event Type. - */ - type?: string; + /** Returns the event Type. + */ + type?: string; - /** Returns the column data which is resized - */ - column?: any; + /** Returns the column data which is resized + */ + column?: any; - /** Returns the index of the column being resized. - */ - columnIndex?: number; + /** Returns the index of the column being resized. + */ + columnIndex?: number; - /** Returns resized column width after resized. - */ - newWidth?: number; + /** Returns resized column width after resized. + */ + newWidth?: number; - /** Returns resized column width before resizing - */ - oldWidth?: number; -} + /** Returns resized column width before resizing + */ + oldWidth?: number; + } -export interface ColumnResizeStartEventArgs { + export interface ColumnResizeStartEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the control model values. - */ - model?: any; + /** Returns the control model values. + */ + model?: any; - /** Returns the event Type. - */ - type?: string; + /** Returns the event Type. + */ + type?: string; - /** Returns the column data in which the resizing started - */ - column?: any; + /** Returns the column data in which the resizing started + */ + column?: any; - /** Returns the column index in which the resizing started - */ - columnIndex?: number; + /** Returns the column index in which the resizing started + */ + columnIndex?: number; - /** Returns column width before dragging - */ - oldWidth?: number; + /** Returns column width before dragging + */ + oldWidth?: number; - /** Returns initial column element object. - */ - target?: any; -} + /** Returns initial column element object. + */ + target?: any; + } -export interface ColumnResizeEndEventArgs { + export interface ColumnResizeEndEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the control model values. - */ - model?: any; + /** Returns the control model values. + */ + model?: any; - /** Returns the event Type. - */ - type?: string; + /** Returns the event Type. + */ + type?: string; - /** Returns the column data in which the resizing started - */ - column?: any; + /** Returns the column data in which the resizing started + */ + column?: any; - /** Returns the column index in which the resizing started - */ - columnIndex?: number; + /** Returns the column index in which the resizing started + */ + columnIndex?: number; - /** Returns the column width difference, before and after the resizing - */ - extra?: number; + /** Returns the column width difference, before and after the resizing + */ + extra?: number; - /** Returns the new column width after resized - */ - newWidth?: number; + /** Returns the new column width after resized + */ + newWidth?: number; - /** Returns column width before dragging - */ - oldWidth?: number; + /** Returns column width before dragging + */ + oldWidth?: number; - /** Returns initial column element object. - */ - target?: any; -} + /** Returns initial column element object. + */ + target?: any; + } -export interface ContextMenuOpenEventArgs { + export interface ContextMenuOpenEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the default context menu items to which we add custom items. - */ - contextMenuItems?: any[]; + /** Returns the default context menu items to which we add custom items. + */ + contextMenuItems?: any[]; - /** Returns the TreeGrid model. - */ - model?: any; + /** Returns the TreeGrid model. + */ + model?: any; - /** Returns request type. - */ - requestType?: string; + /** Returns request type. + */ + requestType?: string; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the TreeGrid model - */ - model?: any; + /** Returns the TreeGrid model + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface EndEditEventArgs { + export interface EndEditEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the row element of editing cell. - */ - rowElement?: any; + /** Returns the row element of editing cell. + */ + rowElement?: any; - /** Returns the Element of editing cell. - */ - cellElement?: any; + /** Returns the Element of editing cell. + */ + cellElement?: any; - /** Returns the data of edited cell record. - */ - data?: any; + /** Returns the data of edited cell record. + */ + data?: any; - /** Returns the column name of edited cell belongs. - */ - columnName?: string; + /** Returns the column name of edited cell belongs. + */ + columnName?: string; - /** Returns the column object of edited cell belongs. - */ - columnObject?: any; -} + /** Returns the column object of edited cell belongs. + */ + columnObject?: any; + } -export interface ExpandedEventArgs { + export interface ExpandedEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the row index of expanded record. - */ - recordIndex?: number; + /** Returns the row index of expanded record. + */ + recordIndex?: number; - /** Returns the data of expanded record.. - */ - data?: any; + /** Returns the data of expanded record.. + */ + data?: any; - /** Returns Request Type. - */ - requestType?: string; + /** Returns Request Type. + */ + requestType?: string; - /** Returns state of a record whether it is in expanded or expanded state. - */ - expanded?: boolean; + /** Returns state of a record whether it is in expanded or expanded state. + */ + expanded?: boolean; - /** Returns the event type. - */ - type?: string; -} + /** Returns the event type. + */ + type?: string; + } -export interface ExpandingEventArgs { + export interface ExpandingEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the row index of expanding record. - */ - recordIndex?: number; + /** Returns the row index of expanding record. + */ + recordIndex?: number; - /** Returns the data of expanding record.. - */ - data?: any; + /** Returns the data of expanding record.. + */ + data?: any; - /** Returns the event Type. - */ - type?: string; + /** Returns the event Type. + */ + type?: string; - /** Returns state of a record whether it is in expanded or collapsed state. - */ - expanded?: boolean; -} + /** Returns state of a record whether it is in expanded or collapsed state. + */ + expanded?: boolean; + } -export interface LoadEventArgs { + export interface LoadEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the TreeGrid model - */ - model?: any; + /** Returns the TreeGrid model + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface QueryCellInfoEventArgs { + export interface QueryCellInfoEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the selecting cell element. - */ - cellElement?: any; + /** Returns the selecting cell element. + */ + cellElement?: any; - /** Returns the value of cell. - */ - cellValue?: string; + /** Returns the value of cell. + */ + cellValue?: string; - /** Returns the data of current cell record. - */ - data?: any; + /** Returns the data of current cell record. + */ + data?: any; - /** Returns the column of cell belongs. - */ - column?: any; -} + /** Returns the column of cell belongs. + */ + column?: any; + } -export interface RowDataBoundEventArgs { + export interface RowDataBoundEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the row element of rendering row. - */ - rowElement?: any; + /** Returns the row element of rendering row. + */ + rowElement?: any; - /** Returns the data of rendering row record. - */ - data?: any; -} + /** Returns the data of rendering row record. + */ + data?: any; + } -export interface RowDragEventArgs { + export interface RowDragEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the row which we start to drag. - */ - draggedRow?: any; + /** Returns the row which we start to drag. + */ + draggedRow?: any; - /** Returns the row index which we start to drag. - */ - draggedRowIndex?: number; + /** Returns the row index which we start to drag. + */ + draggedRowIndex?: number; - /** Returns the row on which we are dragging. - */ - targetRow?: any; + /** Returns the row on which we are dragging. + */ + targetRow?: any; - /** Returns the row index on which we are dragging. - */ - targetRowIndex?: number; + /** Returns the row index on which we are dragging. + */ + targetRowIndex?: number; - /** Returns that we can drop over that record or not. - */ - canDrop?: boolean; + /** Returns that we can drop over that record or not. + */ + canDrop?: boolean; - /** Returns the TreeGrid model. - */ - model?: any; + /** Returns the TreeGrid model. + */ + model?: any; - /** Returns request type. - */ - requestType?: string; + /** Returns request type. + */ + requestType?: string; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface RowDragStartEventArgs { + export interface RowDragStartEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the row which we start to drag. - */ - draggedRow?: any; + /** Returns the row which we start to drag. + */ + draggedRow?: any; - /** Returns the row index which we start to drag. - */ - draggedRowIndex?: boolean; + /** Returns the row index which we start to drag. + */ + draggedRowIndex?: boolean; - /** Returns the TreeGrid model. - */ - model?: any; + /** Returns the TreeGrid model. + */ + model?: any; - /** Returns request type. - */ - requestType?: string; + /** Returns request type. + */ + requestType?: string; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface RowDragStopEventArgs { + export interface RowDragStopEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the row which we start to drag. - */ - draggedRow?: any; + /** Returns the row which we start to drag. + */ + draggedRow?: any; - /** Returns the row index which we start to drag. - */ - draggedRowIndex?: number; + /** Returns the row index which we start to drag. + */ + draggedRowIndex?: number; - /** Returns the row which we are dropped to row. - */ - targetRow?: any; + /** Returns the row which we are dropped to row. + */ + targetRow?: any; - /** Returns the row index which we are dropped to row. - */ - targetRowIndex?: number; + /** Returns the row index which we are dropped to row. + */ + targetRowIndex?: number; - /** Returns the TreeGrid model. - */ - model?: any; + /** Returns the TreeGrid model. + */ + model?: any; - /** Returns request type. - */ - requestType?: string; + /** Returns request type. + */ + requestType?: string; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface CellSelectingEventArgs { + export interface CellSelectingEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the cell index on the selection. - */ - cellIndex?: number; + /** Returns the cell index on the selection. + */ + cellIndex?: number; - /** Returns the row index on the selection - */ - rowIndex?: number; + /** Returns the row index on the selection + */ + rowIndex?: number; - /** Returns the selecting cell element - */ - targetCell?: any; + /** Returns the selecting cell element + */ + targetCell?: any; - /** Returns the selecting row element - */ - targetRow?: any; + /** Returns the selecting row element + */ + targetRow?: any; - /** Returns the selecting record object - */ - data?: any; + /** Returns the selecting record object + */ + data?: any; - /** Returns the Gantt object Model - */ - model?: any; -} + /** Returns the Gantt object Model + */ + model?: any; + } -export interface CellSelectedEventArgs { + export interface CellSelectedEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the cell index on the selection. - */ - cellIndex?: number; + /** Returns the cell index on the selection. + */ + cellIndex?: number; - /** Returns the row index on the selection - */ - rowIndex?: number; + /** Returns the row index on the selection + */ + rowIndex?: number; - /** Returns the selecting cell element - */ - targetCell?: any; + /** Returns the selecting cell element + */ + targetCell?: any; - /** Returns the selecting row element - */ - targetRow?: any; + /** Returns the selecting row element + */ + targetRow?: any; - /** Returns the selecting record object - */ - data?: any; + /** Returns the selecting record object + */ + data?: any; - /** Returns the Gantt object Model - */ - model?: any; + /** Returns the Gantt object Model + */ + model?: any; - /** Returns the previously selected row data - */ - previousData?: any; + /** Returns the previously selected row data + */ + previousData?: any; - /** Returns the previously selected cell index - */ - previousCellIndex?: any; + /** Returns the previously selected cell index + */ + previousCellIndex?: any; - /** Returns the previously selected row index - */ - previousRowIndex?: any; + /** Returns the previously selected row index + */ + previousRowIndex?: any; - /** Returns the previously selected cell element - */ - previousTargetCell?: any; + /** Returns the previously selected cell element + */ + previousTargetCell?: any; - /** Returns the previously selected row element - */ - previousTargetRow?: any; -} + /** Returns the previously selected row element + */ + previousTargetRow?: any; + } -export interface RowSelectedEventArgs { + export interface RowSelectedEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the selecting row element. - */ - targetRow?: any; + /** Returns the selecting row element. + */ + targetRow?: any; - /** Returns the index of selecting row record. - */ - recordIndex?: number; + /** Returns the index of selecting row record. + */ + recordIndex?: number; - /** Returns the data of selected record. - */ - data?: any; + /** Returns the data of selected record. + */ + data?: any; - /** Returns the event type. - */ - type?: string; -} + /** Returns the event type. + */ + type?: string; + } -export interface RowSelectingEventArgs { - - /** Returns the cancel option value. - */ - cancel?: boolean; - - /** Returns the data selecting record. - */ - data?: any; - - /** Returns the index of selecting row record. - */ - recordIndex?: string; - - /** Returns the selecting row element. - */ - targetRow?: any; - - /** Returns the previous selected data. - */ - previousData?: any; - - /** Returns the previous selected row index. - */ - previousIndex?: string; - - /** Returns the previous selected row element. - */ - previousTreeGridRow?: any; -} - -export interface ToolbarClickEventArgs { - - /** Returns the cancel option value. - */ - cancel?: boolean; - - /** Returns the current item. - */ - currentTarget?: any; - - /** Returns the TreeGrid model. - */ - model?: any; - - /** Returns the name of the toolbar item on which mouse click has been performed - */ - itemName?: string; - - /** Returns the name of the event. - */ - type?: string; -} - -export interface Column { - - /** Enables or disables the ability to filter the rows based on this column. - * @Default {false} - */ - allowFiltering?: boolean; - - /** Enables or disables the ability to sort the rows based on this column/field. - * @Default {false} - */ - allowSorting?: boolean; - - /** Enables/disables cell selection. - * @Default {false} - */ - allowCellSelection?: boolean; - - /** Specifies the edit type of the column. - * @Default {ej.TreeGrid.EditingType.String} - */ - editType?: ej.TreeGrid.EditingType|string; - - /** Specifies the name of the field from the dataSource to bind with this column. - */ - field?: string; - - /** Specifies the type of the editor control to be used to filter the rows. - * @Default {ej.TreeGrid.EditingType.String} - */ - filterEditType?: ej.TreeGrid.EditingType|string; - - /** Header text of the column. - * @Default {null} - */ - headerText?: string; - - /** Enables or disables the checkbox visibility in a column to make it as a checkbox column - * @Default {false} - */ - showCheckbox?: boolean; - - /** Controls the visibility of the column. - * @Default {true} - */ - visible?: boolean; - - /** Gets or sets a value for treegrid column width - */ - width?: number; - - /** Specifies the header template value for the column header - */ - headerTemplateID?: string; - - /** Specifies the display format of a column - * @Default {null} - */ - format?: any; - - /** Specifies whether the column is a template column - * @Default {false} - */ - isTemplateColumn?: boolean; - - /** Specifies the alignment of the column header text - * @Default {ej.TextAlign.Left} - */ - headerTextAlign?: ej.TextAlign|string; - - /** Specifies whether the column is frozen - * @Default {false} - */ - isFrozen?: boolean; - - /** Specifies the text alignment for the column - * @Default {ej.TextAlign.Left} - */ - textAlign?: ej.TextAlign|string; - - /** Specifies the template for the TreeGrid column - */ - templateID?: string; - - /** Enables or disables the ability to edit a row or cell. - * @Default {false} - */ - allowEditing?: boolean; - - /** Enables or disables the ability to freeze/unfreeze the columns - * @Default {false} - */ - allowFreezing?: boolean; -} - -export interface ContextMenuSettings { - - /** Option for adding items to context menu. - * @Default {[]} - */ - contextMenuItems?: any[]; - - /** Shows/hides the context menu. - * @Default {false} - */ - showContextMenu?: boolean; -} - -export interface DragTooltip { - - /** Specifies whether to show tooltip while dragging a row. - * @Default {true} - */ - showTooltip?: boolean; - - /** Option to add field names whose corresponding values in the dragged row needs to be shown in the preview tooltip. - * @Default {[]} - */ - tooltipItems?: any[]; - - /** Custom template for that tooltip that is shown while dragging a row. - * @Default {null} - */ - tooltipTemplate?: string; -} - -export interface EditSettings { - - /** Enables or disables the button to add new row in context menu as well as in toolbar. - * @Default {true} - */ - allowAdding?: boolean; - - /** Enables or disables the button to delete the selected row in context menu as well as in toolbar. - * @Default {true} - */ - allowDeleting?: boolean; - - /** Enables or disables the ability to edit a row or cell. - * @Default {false} - */ - allowEditing?: boolean; - - /** Specifies the mouse action whether single click or double click to begin the editing - * @Default {ej.TreeGrid.BeginEditAction.DblClick} - */ - beginEditAction?: ej.TreeGrid.BeginEditAction|string; - - /** specifies the edit mode in TreeGrid , "cellEditing" is for cell type editing and "rowEditing" is for entire row. - * @Default {ej.TreeGrid.EditMode.CellEditing} - */ - editMode?: ej.TreeGrid.EditMode|string; - - /** Specifies the position where the new row has to be added. - * @Default {top} - */ - rowPosition?: ej.TreeGrid.RowPosition|string; -} - -export interface ColumnResizeSettings { - - /** Specifies the mode for column resizing - * @Default {normal} - */ - columnResizeMode?: string; -} - -export interface FilterSettings { - - /** Specifies the mode on which column filtering should start - * @Default {immediate} - */ - filterBarMode?: string; - - /** Specifies the type of column filtering. - * @Default {filterbar} - */ - filterType?: string; - - /** Specifies the column collection for filtering the TreeGrid content on initial load - * @Default {[]} - */ - filteredColumns?: any[]; -} - -export interface PageSettings { - - /** Using this property we can specify the number of pages should pager contains, according to this count TreeGrid height will be updated. - * @Default {8} - */ - pageCount?: number; - - /** This specifies the number of rows to display in each page. - * @Default {12} - */ - pageSize?: number; - - /** Get the value of records which is bound to TreeGrid. The totalRecordsCount value is calculated based on the datasource bound to TreeGrid. - * @Default {null} - */ - totalRecordsCount?: number; - - /** Specifies the current page to display at load time. - * @Default {1} - */ - currentPage?: number; - - /** Specifies the mode of record count in a page, whether it should count all the records or the root to count zero level parent records. - * @Default {ej.TreeGrid.PageSizeMode.All} - */ - pageSizeMode?: ej.TreeGrid.PageSizeMode|string; + export interface RowSelectingEventArgs { + + /** Returns the cancel option value. + */ + cancel?: boolean; + + /** Returns the data selecting record. + */ + data?: any; + + /** Returns the index of selecting row record. + */ + recordIndex?: string; + + /** Returns the selecting row element. + */ + targetRow?: any; + + /** Returns the previous selected data. + */ + previousData?: any; + + /** Returns the previous selected row index. + */ + previousIndex?: string; + + /** Returns the previous selected row element. + */ + previousTreeGridRow?: any; + } + + export interface ToolbarClickEventArgs { + + /** Returns the cancel option value. + */ + cancel?: boolean; + + /** Returns the current item. + */ + currentTarget?: any; + + /** Returns the TreeGrid model. + */ + model?: any; + + /** Returns the name of the toolbar item on which mouse click has been performed + */ + itemName?: string; + + /** Returns the name of the event. + */ + type?: string; + } + + export interface Column { + + /** Enables or disables the ability to filter the rows based on this column. + * @Default {false} + */ + allowFiltering?: boolean; + + /** Enables or disables the ability to sort the rows based on this column/field. + * @Default {false} + */ + allowSorting?: boolean; + + /** Enables/disables cell selection. + * @Default {false} + */ + allowCellSelection?: boolean; + + /** Specifies the edit type of the column. + * @Default {ej.TreeGrid.EditingType.String} + */ + editType?: ej.TreeGrid.EditingType | string; + + /** Specifies the name of the field from the dataSource to bind with this column. + */ + field?: string; + + /** Specifies the type of the editor control to be used to filter the rows. + * @Default {ej.TreeGrid.EditingType.String} + */ + filterEditType?: ej.TreeGrid.EditingType | string; + + /** Header text of the column. + * @Default {null} + */ + headerText?: string; + + /** Enables or disables the checkbox visibility in a column to make it as a checkbox column + * @Default {false} + */ + showCheckbox?: boolean; + + /** Controls the visibility of the column. + * @Default {true} + */ + visible?: boolean; + + /** Gets or sets a value for treegrid column width + */ + width?: number; + + /** Specifies the header template value for the column header + */ + headerTemplateID?: string; + + /** Specifies the display format of a column + * @Default {null} + */ + format?: any; + + /** Specifies whether the column is a template column + * @Default {false} + */ + isTemplateColumn?: boolean; + + /** Specifies the alignment of the column header text + * @Default {ej.TextAlign.Left} + */ + headerTextAlign?: ej.TextAlign | string; + + /** Specifies whether the column is frozen + * @Default {false} + */ + isFrozen?: boolean; + + /** Specifies the text alignment for the column + * @Default {ej.TextAlign.Left} + */ + textAlign?: ej.TextAlign | string; + + /** Specifies the template for the TreeGrid column + */ + templateID?: string; + + /** Enables or disables the ability to edit a row or cell. + * @Default {false} + */ + allowEditing?: boolean; + + /** Enables or disables the ability to freeze/unfreeze the columns + * @Default {false} + */ + allowFreezing?: boolean; + } + + export interface ContextMenuSettings { + + /** Option for adding items to context menu. + * @Default {[]} + */ + contextMenuItems?: any[]; + + /** Shows/hides the context menu. + * @Default {false} + */ + showContextMenu?: boolean; + } + + export interface DragTooltip { + + /** Specifies whether to show tooltip while dragging a row. + * @Default {true} + */ + showTooltip?: boolean; + + /** Option to add field names whose corresponding values in the dragged row needs to be shown in the preview tooltip. + * @Default {[]} + */ + tooltipItems?: any[]; + + /** Custom template for that tooltip that is shown while dragging a row. + * @Default {null} + */ + tooltipTemplate?: string; + } + + export interface EditSettings { + + /** Enables or disables the button to add new row in context menu as well as in toolbar. + * @Default {true} + */ + allowAdding?: boolean; + + /** Enables or disables the button to delete the selected row in context menu as well as in toolbar. + * @Default {true} + */ + allowDeleting?: boolean; + + /** Enables or disables the ability to edit a row or cell. + * @Default {false} + */ + allowEditing?: boolean; + + /** Specifies the mouse action whether single click or double click to begin the editing + * @Default {ej.TreeGrid.BeginEditAction.DblClick} + */ + beginEditAction?: ej.TreeGrid.BeginEditAction | string; + + /** specifies the edit mode in TreeGrid , "cellEditing" is for cell type editing and "rowEditing" is for entire row. + * @Default {ej.TreeGrid.EditMode.CellEditing} + */ + editMode?: ej.TreeGrid.EditMode | string; + + /** Specifies the position where the new row has to be added. + * @Default {top} + */ + rowPosition?: ej.TreeGrid.RowPosition | string; + } + + export interface ColumnResizeSettings { + + /** Specifies the mode for column resizing + * @Default {normal} + */ + columnResizeMode?: string; + } + + export interface FilterSettings { + + /** Specifies the mode on which column filtering should start + * @Default {immediate} + */ + filterBarMode?: string; + + /** Specifies the type of column filtering. + * @Default {filterbar} + */ + filterType?: string; + + /** Specifies the column collection for filtering the TreeGrid content on initial load + * @Default {[]} + */ + filteredColumns?: any[]; + } + + export interface PageSettings { + + /** Using this property we can specify the number of pages should pager contains, according to this count TreeGrid height will be updated. + * @Default {8} + */ + pageCount?: number; + + /** This specifies the number of rows to display in each page. + * @Default {12} + */ + pageSize?: number; + + /** Get the value of records which is bound to TreeGrid. The totalRecordsCount value is calculated based on the datasource bound to TreeGrid. + * @Default {null} + */ + totalRecordsCount?: number; + + /** Specifies the current page to display at load time. + * @Default {1} + */ + currentPage?: number; + + /** Specifies the mode of record count in a page, whether it should count all the records or the root to count zero level parent records. + * @Default {ej.TreeGrid.PageSizeMode.All} + */ + pageSizeMode?: ej.TreeGrid.PageSizeMode | string; - /** Specifies the Custom template for Pager control. - * @Default {null} - */ - template?: string; -} + /** Specifies the Custom template for Pager control. + * @Default {null} + */ + template?: string; + } -export interface SelectionSettings { + export interface SelectionSettings { - /** Specifies the type of selection whether to select row or cell. - * @Default {ej.TreeGrid.SelectionMode.Row} - */ - selectionMode?: ej.TreeGrid.SelectionMode|string; + /** Specifies the type of selection whether to select row or cell. + * @Default {ej.TreeGrid.SelectionMode.Row} + */ + selectionMode?: ej.TreeGrid.SelectionMode | string; - /** Specifies the type of selection whether single, multiple or checkbox. - * @Default {ej.TreeGrid.SelectionType.Single} - */ - selectionType?: ej.TreeGrid.SelectionType|string; + /** Specifies the type of selection whether single, multiple or checkbox. + * @Default {ej.TreeGrid.SelectionType.Single} + */ + selectionType?: ej.TreeGrid.SelectionType | string; - /** Enables or disables the selection by hierarchy in check box selection - * @Default {true} - */ - enableHierarchySelection?: boolean; + /** Enables or disables the selection by hierarchy in check box selection + * @Default {true} + */ + enableHierarchySelection?: boolean; - /** Toggles the visibility of the checkbox in column header, using which all the check boxes can be selected or unselected. - * @Default {true} - */ - enableSelectAll?: boolean; -} + /** Toggles the visibility of the checkbox in column header, using which all the check boxes can be selected or unselected. + * @Default {true} + */ + enableSelectAll?: boolean; + } -export interface SizeSettings { + export interface SizeSettings { - /** Height of the TreeGrid. - * @Default {null} - */ - height?: string; + /** Height of the TreeGrid. + * @Default {null} + */ + height?: string; - /** Width of the TreeGrid. - * @Default {null} - */ - width?: string; -} + /** Width of the TreeGrid. + * @Default {null} + */ + width?: string; + } -export interface SortSettings { + export interface SortSettings { - /** Option to add columns based on which the rows have to be sorted recursively. - * @Default {[]} - */ - sortedColumns?: any[]; -} + /** Option to add columns based on which the rows have to be sorted recursively. + * @Default {[]} + */ + sortedColumns?: any[]; + } -export interface ToolbarSettings { + export interface ToolbarSettings { - /** Shows/hides the toolbar. - * @Default {false} - */ - showToolbar?: boolean; + /** Shows/hides the toolbar. + * @Default {false} + */ + showToolbar?: boolean; - /** Specifies the list of toolbar items to be rendered in TreeGrid toolbar - * @Default {[]} - */ - toolbarItems?: any[]; -} + /** Specifies the list of toolbar items to be rendered in TreeGrid toolbar + * @Default {[]} + */ + toolbarItems?: any[]; + } -enum EditingType { + enum EditingType { - ///It Specifies String edit type. - String, + ///It Specifies String edit type. + String, - ///It Specifies Boolean edit type. - Boolean, + ///It Specifies Boolean edit type. + Boolean, - ///It Specifies Numeric edit type. - Numeric, + ///It Specifies Numeric edit type. + Numeric, - ///It Specifies Dropdown edit type. - Dropdown, + ///It Specifies Dropdown edit type. + Dropdown, - ///It Specifies DatePicker edit type. - DatePicker, + ///It Specifies DatePicker edit type. + DatePicker, - ///It Specifies DateTimePicker edit type. - DateTimePicker, + ///It Specifies DateTimePicker edit type. + DateTimePicker, - ///It Specifies Maskedit edit type. - Maskedit -} + ///It Specifies Maskedit edit type. + Maskedit + } -enum BeginEditAction { + enum BeginEditAction { - ///you can begin the editing at double click - DblClick, + ///you can begin the editing at double click + DblClick, - ///you can begin the editing at single click - Click -} + ///you can begin the editing at single click + Click + } -enum EditMode { + enum EditMode { - ///you can edit a cell. - CellEditing, + ///you can edit a cell. + CellEditing, - ///you can edit a row. - RowEditing -} + ///you can edit a row. + RowEditing + } -enum RowPosition { + enum RowPosition { - ///you can add a new row at top. - Top, + ///you can add a new row at top. + Top, - ///you can add a new row at bottom. - Bottom, + ///you can add a new row at bottom. + Bottom, - ///you can add a new row to above selected row. - Above, + ///you can add a new row to above selected row. + Above, - ///you can add a new row to below selected row. - Below, + ///you can add a new row to below selected row. + Below, - ///you can add a new row as a child for selected row. - Child -} + ///you can add a new row as a child for selected row. + Child + } -enum PageSizeMode { + enum PageSizeMode { - ///To count all the parent and child records. - All, + ///To count all the parent and child records. + All, - ///To count the Zeroth level parent records. - Root -} + ///To count the Zeroth level parent records. + Root + } -enum SelectionMode { + enum SelectionMode { - ///you can select a row. - Row, + ///you can select a row. + Row, - ///you can select a cell. - Cell -} + ///you can select a cell. + Cell + } -enum SelectionType { + enum SelectionType { - ///you can select a single row. - Single, + ///you can select a single row. + Single, - ///you can select a multiple row. - Multiple, + ///you can select a multiple row. + Multiple, - ///you can select rows using checkbox. - Checkbox -} + ///you can select rows using checkbox. + Checkbox + } -} + } -class GroupButton extends ej.Widget { - static fn: GroupButton; - constructor(element: JQuery | Element, options?: GroupButton.Model); - static Locale: any; - model: GroupButton.Model; - defaults: GroupButton.Model; + class GroupButton extends ej.Widget { + static fn: GroupButton; + constructor(element: JQuery | Element, options?: GroupButton.Model); + static Locale: any; + model: GroupButton.Model; + defaults: GroupButton.Model; - /** Remove the selection state of the specified the button element from the GroupButton - * @param {JQuery} Specific button element - * @returns {void} - */ - deselectItem(element: JQuery): void; + /** Remove the selection state of the specified the button element from the GroupButton + * @param {JQuery} Specific button element + * @returns {void} + */ + deselectItem(element: JQuery): void; - /** Destroy the GroupButton widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. - * @returns {void} - */ - destroy(): void; + /** Destroy the GroupButton widget all events bound using this._on will be unbind automatically and bring the control to pre-init state. + * @returns {void} + */ + destroy(): void; - /** Disables the GroupButton control - * @returns {void} - */ - disable(): void; + /** Disables the GroupButton control + * @returns {void} + */ + disable(): void; - /** Disable the specified button element from the ejGroupButton control. - * @param {JQuery} Specific button element - * @returns {void} - */ - disableItem(element: JQuery): void; + /** Disable the specified button element from the ejGroupButton control. + * @param {JQuery} Specific button element + * @returns {void} + */ + disableItem(element: JQuery): void; - /** Enables the disabled ejGroupButton control. - * @returns {void} - */ - enable(): void; + /** Enables the disabled ejGroupButton control. + * @returns {void} + */ + enable(): void; - /** Enable the specified disabled button element from the ejGroupButton control. - * @param {JQuery} Specific button element - * @returns {void} - */ - enableItem(element: JQuery): void; - - /** Returns the index value for specified button element in the GroupButton control. - * @param {JQuery} Specific button element - * @returns {number} - */ - getIndex(element: JQuery): number; - - /** This method returns the list of active state button elements from the GroupButton control. - * @returns {any} - */ - getSelectedItem(): any; - - /** Hides the GroupButton control - * @returns {void} - */ - hide(): void; - - /** Hide the specified button element from the ejGroupButton control. - * @param {JQuery} Specific button element - * @returns {void} - */ - hideItem(element: JQuery): void; - - /** Returns the disabled state of the specified element button element in GroupButton as Boolean. - * @returns {boolean} - */ - isDisabled(): boolean; - - /** Returns the state of the specified button element as Boolean. - * @returns {boolean} - */ - isSelected(): boolean; - - /** Public method used to select the specified button element from the ejGroupButton control. - * @param {JQuery} Specific button element - * @returns {void} - */ - selectItem(element: JQuery): void; - - /** Shows the GroupButton control, if its hide. - * @returns {void} - */ - show(): void; - - /** Show the specified hidden button element from the ejGroupButton control. - * @param {JQuery} Specific button element - * @returns {void} - */ - showItem(element: JQuery): void; -} -export namespace GroupButton { - -export interface Model { - - /** Sets the specified class to GroupButton wrapper element, which allows for custom skinning option in ejGroupButton control. - */ - cssClass?: string; - - /** To set the local JSON data, define a JSON array and initialize the GroupButton with dataSource property. Specify the column names in the fields property. - * @Default {null} - */ - dataSource?: any; - - /** Displays the ejGroupButton in Right to Left direction. - * @Default {false} - */ - enableRTL?: boolean; - - /** Used to enable or disable the ejGroupButton control. - * @Default {true} - */ - enabled?: boolean; - - /** Gets or sets a value that indicates to display the values of the data. - * @Default {null} - */ - fields?: any; - - /** Sets the GroupButton behavior to works as Checkbox mode/ radio button mode based on the specified option. - * @Default {ej.GroupButtonMode.RadioButton} - */ - groupButtonMode?: ej.GroupButtonMode | string; - - /** Used to sets the height of the ejGroupButton control. - * @Default {28} - */ - height?: string|number; - - /** Defines the characteristics of the ejGroupButton control and extend the capability of an HTML element by adding specified attributes to element tag and by performing the related actions - * @Default {{}} - */ - htmlAttributes?: any; - - /** Specify the orientation of the GroupButton. See below to get available orientations - * @Default {ej.Orientation.Horizontal} - */ - orientation?: ej.Orientation|string; - - /** Query the dataSource from the table for Groupbutton - * @Default {null} - */ - query?: any; - - /** Sets the list of button elements to be selected. To enable this option groupButtonMode should be in Ă¢â‚¬Å“checkboxĂ¢â‚¬Â mode. - * @Default {[]} - */ - selectedItemIndex?: number[]|string[]; - - /** Sets the rounder corner to the GroupButton, if sets as true. - * @Default {false} - */ - showRoundedCorner?: boolean; - - /** Specifies the size of the button. See available size - * @Default {ej.ButtonSize.Normal} - */ - size?: ej.ButtonSize|string; - - /** Defines the width of the ejGroupButton control. - */ - width?: string|number; - - /** Triggered before any button element in the GroupButton get selected. */ - beforeSelect?(e: BeforeSelectEventArgs): void; - - /** Fires after GroupButton control is created.If the user want to perform any operation after the button control creation then the user can make use of this create event. */ - create?(e: CreateEventArgs): void; - - /** Fires when the GroupButton is destroyed successfully.If the user want to perform any operation after the destroy button control then the user can make use of this destroy event. */ - destroy?(e: DestroyEventArgs): void; - - /** Triggered once the key is pressed, when the control is in focused state. */ - keyPress?(e: KeyPressEventArgs): void; - - /** Triggered when the button element get selected. */ - select?(e: SelectEventArgs): void; -} - -export interface BeforeSelectEventArgs { - - /** Boolean value based on whether the button element is disabled or not. - */ - disabled?: boolean; - - /** Returns the selection button element. - */ - element?: any; + /** Enable the specified disabled button element from the ejGroupButton control. + * @param {JQuery} Specific button element + * @returns {void} + */ + enableItem(element: JQuery): void; + + /** Returns the index value for specified button element in the GroupButton control. + * @param {JQuery} Specific button element + * @returns {number} + */ + getIndex(element: JQuery): number; + + /** This method returns the list of active state button elements from the GroupButton control. + * @returns {any} + */ + getSelectedItem(): any; + + /** Hides the GroupButton control + * @returns {void} + */ + hide(): void; + + /** Hide the specified button element from the ejGroupButton control. + * @param {JQuery} Specific button element + * @returns {void} + */ + hideItem(element: JQuery): void; + + /** Returns the disabled state of the specified element button element in GroupButton as Boolean. + * @returns {boolean} + */ + isDisabled(): boolean; + + /** Returns the state of the specified button element as Boolean. + * @returns {boolean} + */ + isSelected(): boolean; + + /** Public method used to select the specified button element from the ejGroupButton control. + * @param {JQuery} Specific button element + * @returns {void} + */ + selectItem(element: JQuery): void; + + /** Shows the GroupButton control, if its hide. + * @returns {void} + */ + show(): void; + + /** Show the specified hidden button element from the ejGroupButton control. + * @param {JQuery} Specific button element + * @returns {void} + */ + showItem(element: JQuery): void; + } + export namespace GroupButton { + + export interface Model { + + /** Sets the specified class to GroupButton wrapper element, which allows for custom skinning option in ejGroupButton control. + */ + cssClass?: string; + + /** To set the local JSON data, define a JSON array and initialize the GroupButton with dataSource property. Specify the column names in the fields property. + * @Default {null} + */ + dataSource?: any; + + /** Displays the ejGroupButton in Right to Left direction. + * @Default {false} + */ + enableRTL?: boolean; + + /** Used to enable or disable the ejGroupButton control. + * @Default {true} + */ + enabled?: boolean; + + /** Gets or sets a value that indicates to display the values of the data. + * @Default {null} + */ + fields?: any; + + /** Sets the GroupButton behavior to works as Checkbox mode/ radio button mode based on the specified option. + * @Default {ej.GroupButtonMode.RadioButton} + */ + groupButtonMode?: ej.GroupButtonMode | string; + + /** Used to sets the height of the ejGroupButton control. + * @Default {28} + */ + height?: string | number; + + /** Defines the characteristics of the ejGroupButton control and extend the capability of an HTML element by adding specified attributes to element tag and by performing the related actions + * @Default {{}} + */ + htmlAttributes?: any; + + /** Specify the orientation of the GroupButton. See below to get available orientations + * @Default {ej.Orientation.Horizontal} + */ + orientation?: ej.Orientation | string; + + /** Query the dataSource from the table for Groupbutton + * @Default {null} + */ + query?: any; + + /** Sets the list of button elements to be selected. To enable this option groupButtonMode should be in Ă¢â‚¬Å“checkboxĂ¢â‚¬Â mode. + * @Default {[]} + */ + selectedItemIndex?: number[] | string[]; + + /** Sets the rounder corner to the GroupButton, if sets as true. + * @Default {false} + */ + showRoundedCorner?: boolean; + + /** Specifies the size of the button. See available size + * @Default {ej.ButtonSize.Normal} + */ + size?: ej.ButtonSize | string; + + /** Defines the width of the ejGroupButton control. + */ + width?: string | number; + + /** Triggered before any button element in the GroupButton get selected. */ + beforeSelect?(e: BeforeSelectEventArgs): void; + + /** Fires after GroupButton control is created.If the user want to perform any operation after the button control creation then the user can make use of this create event. */ + create?(e: CreateEventArgs): void; + + /** Fires when the GroupButton is destroyed successfully.If the user want to perform any operation after the destroy button control then the user can make use of this destroy event. */ + destroy?(e: DestroyEventArgs): void; + + /** Triggered once the key is pressed, when the control is in focused state. */ + keyPress?(e: KeyPressEventArgs): void; + + /** Triggered when the button element get selected. */ + select?(e: SelectEventArgs): void; + } + + export interface BeforeSelectEventArgs { + + /** Boolean value based on whether the button element is disabled or not. + */ + disabled?: boolean; + + /** Returns the selection button element. + */ + element?: any; - /** Event object - */ - event?: any; + /** Event object + */ + event?: any; - /** Return the button element ID. - */ - id?: string; + /** Return the button element ID. + */ + id?: string; - /** Button item index. - */ - index?: number; + /** Button item index. + */ + index?: number; - /** returns the button model - */ - model?: ej.GroupButton.Model ; + /** returns the button model + */ + model?: ej.GroupButton.Model; - /** Boolean value based on whether the button element is selected or not. - */ - selected?: boolean; + /** Boolean value based on whether the button element is selected or not. + */ + selected?: boolean; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** return the button state - */ - status?: boolean; -} + /** return the button state + */ + status?: boolean; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the GroupButton model - */ - model?: ej.GroupButton.Model; + /** returns the GroupButton model + */ + model?: ej.GroupButton.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface DestroyEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the GroupButton model - */ - model?: ej.GroupButton.Model; - - /** returns the name of the event - */ - type?: string; -} - -export interface KeyPressEventArgs { - - /** Boolean value based on whether the button element is disabled or not. - */ - disabled?: boolean; - - /** Returns the selection button element. - */ - element?: any; - - /** Event object - */ - event?: any; - - /** Return the button element ID. - */ - id?: string; - - /** Button item index. - */ - index?: number; - - /** returns the button model - */ - model?: ej.GroupButton.Model; - - /** Boolean value based on whether the button element is selected or not. - */ - selected?: boolean; - - /** returns the name of the event - */ - type?: string; - - /** return the button state - */ - status?: boolean; -} - -export interface SelectEventArgs { - - /** Boolean value based on whether the selected button element is disabled or not. - */ - disabled?: boolean; - - /** Returns the selection button element. - */ - element?: any; - - /** Event object - */ - event?: any; - - /** Return the selected button element ID. - */ - id?: string; - - /** Selected button item index. - */ - index?: number; - - /** returns the button model - */ - model?: ej.GroupButton.Model; - - /** Boolean value based on whether the button element is selected or not. - */ - selected?: boolean; - - /** returns the name of the event - */ - type?: string; - - /** return the button state - */ - status?: boolean; -} -} -enum GroupButtonMode { -//Sets the GroupButton to work as checkbox mode -CheckBox, -//Sets the RadioButton to work as radio button mode -RadioButton, -} - -class NavigationDrawer extends ej.Widget { - static fn: NavigationDrawer; - constructor(element: JQuery | Element, options?: NavigationDrawer.Model); - static Locale: any; - model: NavigationDrawer.Model; - defaults: NavigationDrawer.Model; - - /** To close the navigation drawer control - * @returns {void} - */ - close(): void; - - /** To load AJAX content into NavigationDrawer container. - * @returns {void} - */ - loadContent(): void; - - /** To open the navigation drawer control - * @returns {void} - */ - open(): void; - - /** To Toggle the navigation drawer control - * @returns {void} - */ - toggle(): void; -} -export namespace NavigationDrawer { - -export interface Model { - - /** Specifies the ajaxSettings option to load the content to the NavigationDrawer control. - * @Default {null} - */ - ajaxSettings?: AjaxSettings; - - /** Specifies the contentId for navigation drawer, where the AJAX content need to updated - * @Default {null} - */ - contentId?: string; - - /** Sets the root class for NavigationDrawer theme. This cssClass API helps to use custom skinning option for NavigationDrawer control. - * By defining the root class using this API, we need to include this root class in CSS. - */ - cssClass?: string; - - /** Sets the Direction for the control. See Direction - * @Default {left} - */ - direction?: ej.Direction|string; - - /** Sets the listview to be enabled or not - * @Default {false} - */ - enableListView?: boolean; - - /** Specifies the listview items as an array of object. - * @Default {[]} - */ - items?: any[]; - - /** Sets all the properties of listview to render in navigation drawer - */ - listViewSettings?: any; - - /** Specifies position whether it is in fixed or relative to the page. See Position - * @Default {normal} - */ - position?: string; - - /** Specifies the targetId for navigation drawer - */ - targetId?: string; - - /** Sets the rendering type of the control. See Type - * @Default {overlay} - */ - type?: string; - - /** Specifies the width of the control - * @Default {auto} - */ - width?: number; - - /** Navigation pane opened initially when isPaneOpen property is true. - * @Default {false} - */ - isPaneOpen?: boolean; - - /** Event triggers after the AJAX content loaded completely. */ - ajaxComplete?(e: AjaxCompleteEventArgs): void; - - /** Event triggers when the AJAX request failed. */ - ajaxError?(e: AjaxErrorEventArgs): void; - - /** Event triggers after the AJAX content loaded successfully. */ - ajaxSuccess?(e: AjaxSuccessEventArgs): void; - - /** Event triggers before the control gets closed. */ - beforeClose?(e: BeforeCloseEventArgs): void; - - /** Event triggers when the control open. */ - open?(e: OpenEventArgs): void; - - /** Event triggers when the Swipe happens. */ - swipe?(e: SwipeEventArgs): void; -} - -export interface AjaxCompleteEventArgs { + export interface DestroyEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the GroupButton model + */ + model?: ej.GroupButton.Model; + + /** returns the name of the event + */ + type?: string; + } + + export interface KeyPressEventArgs { + + /** Boolean value based on whether the button element is disabled or not. + */ + disabled?: boolean; + + /** Returns the selection button element. + */ + element?: any; + + /** Event object + */ + event?: any; + + /** Return the button element ID. + */ + id?: string; + + /** Button item index. + */ + index?: number; + + /** returns the button model + */ + model?: ej.GroupButton.Model; + + /** Boolean value based on whether the button element is selected or not. + */ + selected?: boolean; + + /** returns the name of the event + */ + type?: string; + + /** return the button state + */ + status?: boolean; + } + + export interface SelectEventArgs { + + /** Boolean value based on whether the selected button element is disabled or not. + */ + disabled?: boolean; + + /** Returns the selection button element. + */ + element?: any; + + /** Event object + */ + event?: any; + + /** Return the selected button element ID. + */ + id?: string; + + /** Selected button item index. + */ + index?: number; + + /** returns the button model + */ + model?: ej.GroupButton.Model; + + /** Boolean value based on whether the button element is selected or not. + */ + selected?: boolean; + + /** returns the name of the event + */ + type?: string; + + /** return the button state + */ + status?: boolean; + } + } + enum GroupButtonMode { + //Sets the GroupButton to work as checkbox mode + CheckBox, + //Sets the RadioButton to work as radio button mode + RadioButton, + } + + class NavigationDrawer extends ej.Widget { + static fn: NavigationDrawer; + constructor(element: JQuery | Element, options?: NavigationDrawer.Model); + static Locale: any; + model: NavigationDrawer.Model; + defaults: NavigationDrawer.Model; + + /** To close the navigation drawer control + * @returns {void} + */ + close(): void; + + /** To load AJAX content into NavigationDrawer container. + * @returns {void} + */ + loadContent(): void; + + /** To open the navigation drawer control + * @returns {void} + */ + open(): void; + + /** To Toggle the navigation drawer control + * @returns {void} + */ + toggle(): void; + } + export namespace NavigationDrawer { + + export interface Model { + + /** Specifies the ajaxSettings option to load the content to the NavigationDrawer control. + * @Default {null} + */ + ajaxSettings?: AjaxSettings; + + /** Specifies the contentId for navigation drawer, where the AJAX content need to updated + * @Default {null} + */ + contentId?: string; + + /** Sets the root class for NavigationDrawer theme. This cssClass API helps to use custom skinning option for NavigationDrawer control. + * By defining the root class using this API, we need to include this root class in CSS. + */ + cssClass?: string; + + /** Sets the Direction for the control. See Direction + * @Default {left} + */ + direction?: ej.Direction | string; + + /** Sets the listview to be enabled or not + * @Default {false} + */ + enableListView?: boolean; + + /** Specifies the listview items as an array of object. + * @Default {[]} + */ + items?: any[]; + + /** Sets all the properties of listview to render in navigation drawer + */ + listViewSettings?: any; + + /** Specifies position whether it is in fixed or relative to the page. See Position + * @Default {normal} + */ + position?: string; + + /** Specifies the targetId for navigation drawer + */ + targetId?: string; + + /** Sets the rendering type of the control. See Type + * @Default {overlay} + */ + type?: string; + + /** Specifies the width of the control + * @Default {auto} + */ + width?: number; + + /** Navigation pane opened initially when isPaneOpen property is true. + * @Default {false} + */ + isPaneOpen?: boolean; + + /** Event triggers after the AJAX content loaded completely. */ + ajaxComplete?(e: AjaxCompleteEventArgs): void; + + /** Event triggers when the AJAX request failed. */ + ajaxError?(e: AjaxErrorEventArgs): void; + + /** Event triggers after the AJAX content loaded successfully. */ + ajaxSuccess?(e: AjaxSuccessEventArgs): void; + + /** Event triggers before the control gets closed. */ + beforeClose?(e: BeforeCloseEventArgs): void; + + /** Event triggers when the control open. */ + open?(e: OpenEventArgs): void; + + /** Event triggers when the Swipe happens. */ + swipe?(e: SwipeEventArgs): void; + } + + export interface AjaxCompleteEventArgs { - /** returns true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns true if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the model value of the control. - */ - model?: ej.NavigationDrawer.Model; -} + /** returns the model value of the control. + */ + model?: ej.NavigationDrawer.Model; + } -export interface AjaxErrorEventArgs { + export interface AjaxErrorEventArgs { - /** returns true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns true if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the model value of the control. - */ - model?: ej.NavigationDrawer.Model; + /** returns the model value of the control. + */ + model?: ej.NavigationDrawer.Model; - /** returns the error thrown in the AJAX post. - */ - errorThrown?: any; + /** returns the error thrown in the AJAX post. + */ + errorThrown?: any; - /** returns the status. - */ - textStatus?: any; -} + /** returns the status. + */ + textStatus?: any; + } -export interface AjaxSuccessEventArgs { + export interface AjaxSuccessEventArgs { - /** returns true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns true if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; - /** returns the model value of the control. - */ - model?: ej.NavigationDrawer.Model; + /** returns the model value of the control. + */ + model?: ej.NavigationDrawer.Model; - /** returns the AJAX current content. - */ - content?: string; + /** returns the AJAX current content. + */ + content?: string; - /** returns the current URL of the AJAX post. - */ - URL?: string; -} + /** returns the current URL of the AJAX post. + */ + URL?: string; + } -export interface BeforeCloseEventArgs { + export interface BeforeCloseEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the Navigation Drawer model - */ - model?: ej.NavigationDrawer.Model; + /** returns the Navigation Drawer model + */ + model?: ej.NavigationDrawer.Model; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface OpenEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the Navigation Drawer model - */ - model?: ej.NavigationDrawer.Model; - - /** returns the name of the event - */ - type?: string; -} - -export interface SwipeEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the Navigation Drawer model - */ - model?: ej.NavigationDrawer.Model; - - /** returns the name of the event - */ - type?: string; -} - -export interface AjaxSettings { - - /** It specifies, whether to enable or disable asynchronous request. - */ - async?: boolean; - - /** It specifies the page will be cached in the web browser. - */ - cache?: boolean; - - /** It specifies the type of data is send in the query string. - */ - contentType?: string; - - /** It specifies the data as an object, will be passed in the query string. - */ - data?: any; - - /** It specifies the type of data that you're expecting back from the response. - */ - dataType?: string; - - /** It specifies the HTTP request type. - */ - type?: string; -} -} - -class RadialMenu extends ej.Widget { - static fn: RadialMenu; - constructor(element: JQuery | Element, options?: RadialMenu.Model); - static Locale: any; - model: RadialMenu.Model; - defaults: RadialMenu.Model; - - /** To hide the radialmenu - * @returns {void} - */ - hide(): void; - - /** To hide the radialmenu items - * @returns {void} - */ - hideMenu(): void; - - /** To Show the radial menu - * @returns {void} - */ - show(): void; - - /** To show menu items - * @returns {void} - */ - showMenu(): void; - - /** To enable menu item using index - * @param {number} Index of the Radialmenu to be enabled. - * @returns {void} - */ - enableItemByIndex(itemIndex: number): void; - - /** To enable menu items using indices - * @param {Array} Index of the Radialmenu to be enabled. - * @returns {void} - */ - enableItemsByIndices(itemIndices: any[]): void; - - /** To disable menu item using index - * @param {number} Index of the Radialmenu to be disabled. - * @returns {void} - */ - disableItemByIndex(itemIndex: number): void; - - /** To disable menu items using indices - * @param {Array} items of the Radialmenu to disable. - * @returns {void} - */ - disableItemsByIndices(itemIndices: any[]): void; - - /** To enable menu item using item text - * @param {string} item of the Radialmenu item to enable. - * @returns {void} - */ - enableItem(item: string): void; - - /** To disable menu item using item text - * @param {string} item of the Radialmenu item to disable. - * @returns {void} - */ - disableItem(item: string): void; - - /** To enable menu items using item texts - * @param {Array} items of the Radialmenu item to enable. - * @returns {void} - */ - enableItems(items: any[]): void; - - /** To disable menu items using item texts - * @param {Array} items of the Radialmenu item to disable. - * @returns {void} - */ - disableItems(items: any[]): void; - - /** To update menu item badge value - * @param {number} The index value to add the given items at the specified index. If index is not specified, the given value will not be updated. - * @param {number} The Value to be updated in the badge. It will be updated based on the given index - * @returns {void} - */ - updateBadgeValue(index: number, value: number): void; - - /** To show menu item badge - * @param {number} Index of the Radialmenu item to be shown badge. - * @returns {void} - */ - showBadge(index: number): void; - - /** To hide menu item badge - * @param {number} Index of the Radialmenu item to hide the badge. - * @returns {void} - */ - hideBadge(index: number): void; -} -export namespace RadialMenu { - -export interface Model { - - /** To show the Radial in initial render. - */ - autoOpen?: boolean; - - /** Renders the back button Image for Radial using class. - */ - backImageClass?: string; - - /** Sets the root class for RadialMenu theme. This cssClass API helps to use custom skinning option for RadialMenu control. By defining the root class using this API, - * we need to include this root class in CSS. - */ - cssClass?: string; - - /** To enable Animation for Radial Menu. - */ - enableAnimation?: boolean; - - /** Renders the Image for Radial using Class. - */ - imageClass?: string; - - /** Specify the items of radial menu - */ - items?: Item[]; - - /** Specifies the radius of radial menu - */ - radius?: number; - - /** To show the Radial while clicking given target element. - */ - targetElementId?: string; - - /** To set radial render position. - */ - position?: any; - - /** Event triggers when we click an item. */ - click?(e: ClickEventArgs): void; - - /** Event triggers when the menu is opened. */ - open?(e: OpenEventArgs): void; - - /** Event triggers when the menu is closed. */ - close?(e: CloseEventArgs): void; -} - -export interface ClickEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the Radialmenu model - */ - model?: any; - - /** returns the name of the event - */ - type?: string; - - /** returns the item of element - */ - item?: any; - - /** returns the name of item - */ - itemName?: string; -} - -export interface OpenEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the Radialmenu model - */ - model?: any; - - /** returns the name of the event - */ - type?: string; -} - -export interface CloseEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the Radialmenu model - */ - model?: any; + export interface OpenEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the Navigation Drawer model + */ + model?: ej.NavigationDrawer.Model; + + /** returns the name of the event + */ + type?: string; + } + + export interface SwipeEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the Navigation Drawer model + */ + model?: ej.NavigationDrawer.Model; + + /** returns the name of the event + */ + type?: string; + } + + export interface AjaxSettings { + + /** It specifies, whether to enable or disable asynchronous request. + */ + async?: boolean; + + /** It specifies the page will be cached in the web browser. + */ + cache?: boolean; + + /** It specifies the type of data is send in the query string. + */ + contentType?: string; + + /** It specifies the data as an object, will be passed in the query string. + */ + data?: any; + + /** It specifies the type of data that you're expecting back from the response. + */ + dataType?: string; + + /** It specifies the HTTP request type. + */ + type?: string; + } + } + + class RadialMenu extends ej.Widget { + static fn: RadialMenu; + constructor(element: JQuery | Element, options?: RadialMenu.Model); + static Locale: any; + model: RadialMenu.Model; + defaults: RadialMenu.Model; + + /** To hide the radialmenu + * @returns {void} + */ + hide(): void; + + /** To hide the radialmenu items + * @returns {void} + */ + hideMenu(): void; + + /** To Show the radial menu + * @returns {void} + */ + show(): void; + + /** To show menu items + * @returns {void} + */ + showMenu(): void; + + /** To enable menu item using index + * @param {number} Index of the Radialmenu to be enabled. + * @returns {void} + */ + enableItemByIndex(itemIndex: number): void; + + /** To enable menu items using indices + * @param {Array} Index of the Radialmenu to be enabled. + * @returns {void} + */ + enableItemsByIndices(itemIndices: any[]): void; + + /** To disable menu item using index + * @param {number} Index of the Radialmenu to be disabled. + * @returns {void} + */ + disableItemByIndex(itemIndex: number): void; + + /** To disable menu items using indices + * @param {Array} items of the Radialmenu to disable. + * @returns {void} + */ + disableItemsByIndices(itemIndices: any[]): void; + + /** To enable menu item using item text + * @param {string} item of the Radialmenu item to enable. + * @returns {void} + */ + enableItem(item: string): void; + + /** To disable menu item using item text + * @param {string} item of the Radialmenu item to disable. + * @returns {void} + */ + disableItem(item: string): void; + + /** To enable menu items using item texts + * @param {Array} items of the Radialmenu item to enable. + * @returns {void} + */ + enableItems(items: any[]): void; + + /** To disable menu items using item texts + * @param {Array} items of the Radialmenu item to disable. + * @returns {void} + */ + disableItems(items: any[]): void; + + /** To update menu item badge value + * @param {number} The index value to add the given items at the specified index. If index is not specified, the given value will not be updated. + * @param {number} The Value to be updated in the badge. It will be updated based on the given index + * @returns {void} + */ + updateBadgeValue(index: number, value: number): void; + + /** To show menu item badge + * @param {number} Index of the Radialmenu item to be shown badge. + * @returns {void} + */ + showBadge(index: number): void; + + /** To hide menu item badge + * @param {number} Index of the Radialmenu item to hide the badge. + * @returns {void} + */ + hideBadge(index: number): void; + } + export namespace RadialMenu { + + export interface Model { + + /** To show the Radial in initial render. + */ + autoOpen?: boolean; + + /** Renders the back button Image for Radial using class. + */ + backImageClass?: string; + + /** Sets the root class for RadialMenu theme. This cssClass API helps to use custom skinning option for RadialMenu control. By defining the root class using this API, + * we need to include this root class in CSS. + */ + cssClass?: string; + + /** To enable Animation for Radial Menu. + */ + enableAnimation?: boolean; + + /** Renders the Image for Radial using Class. + */ + imageClass?: string; + + /** Specify the items of radial menu + */ + items?: Item[]; + + /** Specifies the radius of radial menu + */ + radius?: number; + + /** To show the Radial while clicking given target element. + */ + targetElementId?: string; + + /** To set radial render position. + */ + position?: any; + + /** Event triggers when we click an item. */ + click?(e: ClickEventArgs): void; + + /** Event triggers when the menu is opened. */ + open?(e: OpenEventArgs): void; + + /** Event triggers when the menu is closed. */ + close?(e: CloseEventArgs): void; + } + + export interface ClickEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the Radialmenu model + */ + model?: any; + + /** returns the name of the event + */ + type?: string; + + /** returns the item of element + */ + item?: any; + + /** returns the name of item + */ + itemName?: string; + } + + export interface OpenEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the Radialmenu model + */ + model?: any; + + /** returns the name of the event + */ + type?: string; + } + + export interface CloseEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the Radialmenu model + */ + model?: any; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface ItemsBadge { + export interface ItemsBadge { - /** Specifies whether to enable radialmenu item badge or not. - */ - enabled?: boolean; - - /** Specifies the value of radial menu item badge. - */ - value?: number; -} - -export interface ItemsSliderSettings { + /** Specifies whether to enable radialmenu item badge or not. + */ + enabled?: boolean; + + /** Specifies the value of radial menu item badge. + */ + value?: number; + } + + export interface ItemsSliderSettings { - /** Specifies the sliderSettings ticks values of nested radial menu items. - */ - ticks?: any[]; + /** Specifies the sliderSettings ticks values of nested radial menu items. + */ + ticks?: any[]; - /** Specifies the sliderSettings stroke Width value. - */ - strokeWidth?: number; - - /** Specifies the value of sliderSettings labelSpace . - */ - labelSpace?: number; -} - -export interface Item { - - /** Specify the URL of the frame background image for radial menu item. - */ - imageUrl?: string; - - /** Specifies the text of RadialMenu item. - */ - text?: string; - - /** Specifies the enable state of RadialMenu item. - */ - enabled?: boolean; - - /** specify the click event to corresponding image/text for performing some specific action. - */ - click?: string; - - /** Specifies radialmenu item badges. - */ - badge?: ItemsBadge; - - /** Specifies the type of nested radial menu item. - */ - type?: string; - - /** Specifies the sliderSettings ticks for nested radial menu items. - */ - sliderSettings?: ItemsSliderSettings; - - /** Specifies to add sub level items . - */ - items?: any[]; -} -} - -class Tile extends ej.Widget { - static fn: Tile; - constructor(element: JQuery | Element, options?: Tile.Model); - static Locale: any; - model: Tile.Model; - defaults: Tile.Model; - - /** Update the image template of tile item to another one. - * @param {string} UpdateTemplate by using id - * @param {number} index of the tile - * @returns {void} - */ - updateTemplate(id: string, index: number): void; -} -export namespace Tile { - -export interface Model { - - /** Section for badge specific functionalities and it represents the notification for tile items. - */ - badge?: Badge; - - /** Section for caption specific functionalities and it represents the notification for tile items. - */ - caption?: Caption; - - /** Sets the root class for Tile theme. This cssClass API helps to use custom skinning option for Tile control. By defining the root class using this API, we need to include this root class in CSS. - */ - cssClass?: string; - - /** Saves current model value to browser cookies for state maintains. While refreshing the page retains the model value applies from browser cookies. - * @Default {false} - */ - enablePersistence?: boolean; - - /** Customize the tile size height. - * @Default {null} - */ - height?: number; - - /** Specifies Tile imageClass, using this property we can give images for each tile through CSS classes. - * @Default {null} - */ - imageClass?: string; - - /** Specifies the position of tile image. - * @Default {center} - */ - imagePosition?: ej.Tile.ImagePosition|string; - - /** Specifies the tile image in outside of template content. - * @Default {null} - */ - imageTemplateId?: string; - - /** Specifies the URL of tile image. - * @Default {null} - */ - imageUrl?: string; - - /** Set the localization culture for Tile Widget. - */ - locale?: string; - - /** Section for liveTile specific functionalities. - */ - liveTile?: LiveTile; - - /** Specifies the size of a tile. See tileSize - * @Default {small} - */ - tileSize?: ej.Tile.TileSize|string; - - /** Customize the tile size width. - * @Default {null} - */ - width?: number; - - /** Sets the rounded corner to tile. - * @Default {false} - */ - showRoundedCorner?: boolean; - - /** Sets allowSelection to tile. - * @Default {false} - */ - allowSelection?: boolean; - - /** Sets the background color to tile. - * @Default {null} - */ - backgroundColor?: string; - - /** Event triggers when the mouseDown happens in the tile */ - mouseDown?(e: MouseDownEventArgs): void; - - /** Event triggers when the mouseUp happens in the tile */ - mouseUp?(e: MouseUpEventArgs): void; -} - -export interface MouseDownEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the tile model - */ - model?: boolean; - - /** returns the name of the event - */ - type?: boolean; - - /** returns the current tile text - */ - text?: string; - - /** returns the index of current tile item - */ - index?: number; -} - -export interface MouseUpEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the tile model - */ - model?: boolean; - - /** returns the name of the event - */ - type?: boolean; - - /** returns the current tile text - */ - text?: boolean; - - /** returns the index of current tile item - */ - index?: number; -} - -export interface Badge { - - /** Specifies whether to enable badge or not. - * @Default {false} - */ - enabled?: boolean; - - /** Specifies maximum value for tile badge. - * @Default {100} - */ - maxValue?: number; - - /** Specifies minimum value for tile badge. - * @Default {1} - */ - minValue?: number; - - /** Specifies text instead of number for tile badge. - * @Default {null} - */ - text?: string; - - /** Sets value for tile badge. - * @Default {1} - */ - value?: number; + /** Specifies the sliderSettings stroke Width value. + */ + strokeWidth?: number; + + /** Specifies the value of sliderSettings labelSpace . + */ + labelSpace?: number; + } + + export interface Item { + + /** Specify the URL of the frame background image for radial menu item. + */ + imageUrl?: string; + + /** Specifies the text of RadialMenu item. + */ + text?: string; + + /** Specifies the enable state of RadialMenu item. + */ + enabled?: boolean; + + /** specify the click event to corresponding image/text for performing some specific action. + */ + click?: string; + + /** Specifies radialmenu item badges. + */ + badge?: ItemsBadge; + + /** Specifies the type of nested radial menu item. + */ + type?: string; + + /** Specifies the sliderSettings ticks for nested radial menu items. + */ + sliderSettings?: ItemsSliderSettings; + + /** Specifies to add sub level items . + */ + items?: any[]; + } + } + + class Tile extends ej.Widget { + static fn: Tile; + constructor(element: JQuery | Element, options?: Tile.Model); + static Locale: any; + model: Tile.Model; + defaults: Tile.Model; + + /** Update the image template of tile item to another one. + * @param {string} UpdateTemplate by using id + * @param {number} index of the tile + * @returns {void} + */ + updateTemplate(id: string, index: number): void; + } + export namespace Tile { + + export interface Model { + + /** Section for badge specific functionalities and it represents the notification for tile items. + */ + badge?: Badge; + + /** Section for caption specific functionalities and it represents the notification for tile items. + */ + caption?: Caption; + + /** Sets the root class for Tile theme. This cssClass API helps to use custom skinning option for Tile control. By defining the root class using this API, we need to include this root class in CSS. + */ + cssClass?: string; + + /** Saves current model value to browser cookies for state maintains. While refreshing the page retains the model value applies from browser cookies. + * @Default {false} + */ + enablePersistence?: boolean; + + /** Customize the tile size height. + * @Default {null} + */ + height?: number; + + /** Specifies Tile imageClass, using this property we can give images for each tile through CSS classes. + * @Default {null} + */ + imageClass?: string; + + /** Specifies the position of tile image. + * @Default {center} + */ + imagePosition?: ej.Tile.ImagePosition | string; + + /** Specifies the tile image in outside of template content. + * @Default {null} + */ + imageTemplateId?: string; + + /** Specifies the URL of tile image. + * @Default {null} + */ + imageUrl?: string; + + /** Set the localization culture for Tile Widget. + */ + locale?: string; + + /** Section for liveTile specific functionalities. + */ + liveTile?: LiveTile; + + /** Specifies the size of a tile. See tileSize + * @Default {small} + */ + tileSize?: ej.Tile.TileSize | string; + + /** Customize the tile size width. + * @Default {null} + */ + width?: number; + + /** Sets the rounded corner to tile. + * @Default {false} + */ + showRoundedCorner?: boolean; + + /** Sets allowSelection to tile. + * @Default {false} + */ + allowSelection?: boolean; + + /** Sets the background color to tile. + * @Default {null} + */ + backgroundColor?: string; + + /** Event triggers when the mouseDown happens in the tile */ + mouseDown?(e: MouseDownEventArgs): void; + + /** Event triggers when the mouseUp happens in the tile */ + mouseUp?(e: MouseUpEventArgs): void; + } + + export interface MouseDownEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the tile model + */ + model?: boolean; + + /** returns the name of the event + */ + type?: boolean; + + /** returns the current tile text + */ + text?: string; + + /** returns the index of current tile item + */ + index?: number; + } + + export interface MouseUpEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the tile model + */ + model?: boolean; + + /** returns the name of the event + */ + type?: boolean; + + /** returns the current tile text + */ + text?: boolean; + + /** returns the index of current tile item + */ + index?: number; + } + + export interface Badge { + + /** Specifies whether to enable badge or not. + * @Default {false} + */ + enabled?: boolean; + + /** Specifies maximum value for tile badge. + * @Default {100} + */ + maxValue?: number; + + /** Specifies minimum value for tile badge. + * @Default {1} + */ + minValue?: number; + + /** Specifies text instead of number for tile badge. + * @Default {null} + */ + text?: string; + + /** Sets value for tile badge. + * @Default {1} + */ + value?: number; - /** Sets position for tile badge. - * @Default {Ă¢â‚¬Å“bottomrightĂ¢â‚¬Â} - */ - position?: ej.Tile.BadgePosition|string; -} + /** Sets position for tile badge. + * @Default {Ă¢â‚¬Å“bottomrightĂ¢â‚¬Â} + */ + position?: ej.Tile.BadgePosition | string; + } -export interface Caption { + export interface Caption { - /** Specifies whether the tile text to be shown or hidden. - * @Default {true} - */ - enabled?: boolean; + /** Specifies whether the tile text to be shown or hidden. + * @Default {true} + */ + enabled?: boolean; - /** Changes the text of a tile. - * @Default {Text} - */ - text?: string; + /** Changes the text of a tile. + * @Default {Text} + */ + text?: string; - /** It is used to align the text of a tile. - * @Default {normal} - */ - alignment?: ej.Tile.CaptionAlignment|string; + /** It is used to align the text of a tile. + * @Default {normal} + */ + alignment?: ej.Tile.CaptionAlignment | string; - /** It is used to specify the caption position like Inner top, inner bottom and outer. - * @Default {Innerbottom} - */ - position?: ej.Tile.CaptionPosition|string; + /** It is used to specify the caption position like Inner top, inner bottom and outer. + * @Default {Innerbottom} + */ + position?: ej.Tile.CaptionPosition | string; - /** sets the icon instead of text. - * @Default {null} - */ - icon?: string; -} + /** sets the icon instead of text. + * @Default {null} + */ + icon?: string; + } -export interface LiveTile { + export interface LiveTile { - /** Specifies whether to enable liveTile or not. - * @Default {false} - */ - enabled?: boolean; + /** Specifies whether to enable liveTile or not. + * @Default {false} + */ + enabled?: boolean; - /** Specifies liveTile images in CSS classes. - * @Default {null} - */ - imageClass?: any[]; + /** Specifies liveTile images in CSS classes. + * @Default {null} + */ + imageClass?: any[]; - /** Specifies liveTile images in templates. - * @Default {null} - */ - imageTemplateId?: any[]; + /** Specifies liveTile images in templates. + * @Default {null} + */ + imageTemplateId?: any[]; - /** Specifies liveTile images in CSS classes. - * @Default {null} - */ - imageUrl?: any[]; + /** Specifies liveTile images in CSS classes. + * @Default {null} + */ + imageUrl?: any[]; - /** Specifies liveTile type for Tile. See orientation - * @Default {flip} - */ - type?: ej.Tile.liveTileType|string; + /** Specifies liveTile type for Tile. See orientation + * @Default {flip} + */ + type?: ej.Tile.liveTileType | string; - /** Specifies time interval between two successive liveTile animation - * @Default {2000} - */ - updateInterval?: number; + /** Specifies time interval between two successive liveTile animation + * @Default {2000} + */ + updateInterval?: number; - /** Sets the text to each living tile - * @Default {Null} - */ - text?: any[]; -} + /** Sets the text to each living tile + * @Default {Null} + */ + text?: any[]; + } -enum BadgePosition { + enum BadgePosition { - ///To set the topright position of tile badge - Topright, + ///To set the topright position of tile badge + Topright, - ///To set the bottomright of tile badge - Bottomright -} + ///To set the bottomright of tile badge + Bottomright + } -enum CaptionAlignment { + enum CaptionAlignment { - ///To set the normal alignment of text in tile control - Normal, + ///To set the normal alignment of text in tile control + Normal, - ///To set the left alignment of text in tile control - Left, + ///To set the left alignment of text in tile control + Left, - ///To set the right alignment of text in tile control - Right, + ///To set the right alignment of text in tile control + Right, - ///To set the center alignment of text in tile control - Center -} + ///To set the center alignment of text in tile control + Center + } -enum CaptionPosition { + enum CaptionPosition { - ///To set the inner top position of the tile text - Innertop, + ///To set the inner top position of the tile text + Innertop, - ///To set the inner bottom position of the tile text - Innerbottom, + ///To set the inner bottom position of the tile text + Innerbottom, - ///To set the outer position of the tile text - Outer -} + ///To set the outer position of the tile text + Outer + } -enum ImagePosition { + enum ImagePosition { - ///To set the center position of tile image - Center, + ///To set the center position of tile image + Center, - ///To set the top center position of tile image - TopCenter, + ///To set the top center position of tile image + TopCenter, - ///To set the bottom center position of tile image - BottomCenter, + ///To set the bottom center position of tile image + BottomCenter, - ///To set the right center position of tile image - RightCenter, + ///To set the right center position of tile image + RightCenter, - ///To set the left center position of tile image - LeftCenter, + ///To set the left center position of tile image + LeftCenter, - ///To set the topleft position of tile image - TopLeft, + ///To set the topleft position of tile image + TopLeft, - ///To set the topright position of tile image - TopRight, + ///To set the topright position of tile image + TopRight, - ///To set the bottomright position of tile image - BottomRight, + ///To set the bottomright position of tile image + BottomRight, - ///To set the bottomleft position of tile image - BottomLeft, + ///To set the bottomleft position of tile image + BottomLeft, - ///To set the fill position of tile image - Fill -} + ///To set the fill position of tile image + Fill + } -enum liveTileType { + enum liveTileType { - ///To set flip type of liveTile for tile control - Flip, + ///To set flip type of liveTile for tile control + Flip, - ///To set slide type of liveTile for tile control - Slide, + ///To set slide type of liveTile for tile control + Slide, - ///To set carousel type of liveTile for tile control - Carousel -} + ///To set carousel type of liveTile for tile control + Carousel + } -enum TileSize { + enum TileSize { - ///To set the medium size for tile control - Medium, + ///To set the medium size for tile control + Medium, - ///To set the small size for tile control - Small, + ///To set the small size for tile control + Small, - ///To set the large size for tile control - Large, + ///To set the large size for tile control + Large, - ///To set the wide size for tile control - Wide -} + ///To set the wide size for tile control + Wide + } -} + } -class Signature extends ej.Widget { - static fn: Signature; - constructor(element: JQuery | Element, options?: Signature.Model); - static Locale: any; - model: Signature.Model; - defaults: Signature.Model; + class Signature extends ej.Widget { + static fn: Signature; + constructor(element: JQuery | Element, options?: Signature.Model); + static Locale: any; + model: Signature.Model; + defaults: Signature.Model; - /** Clears the strokes in the signature. - * @returns {void} - */ - clear(): void; + /** Clears the strokes in the signature. + * @returns {void} + */ + clear(): void; - /** Destroys the signature widget. - * @returns {void} - */ - destroy(): void; + /** Destroys the signature widget. + * @returns {void} + */ + destroy(): void; - /** Disables the signature widget. - * @returns {void} - */ - disable(): void; + /** Disables the signature widget. + * @returns {void} + */ + disable(): void; - /** Enables the signature widget. - * @returns {void} - */ - enable(): void; + /** Enables the signature widget. + * @returns {void} + */ + enable(): void; - /** Hides the signature widget. - * @returns {void} - */ - hide(): void; + /** Hides the signature widget. + * @returns {void} + */ + hide(): void; - /** redo the last drawn stroke of the signature - * @returns {void} - */ - redo(): void; + /** redo the last drawn stroke of the signature + * @returns {void} + */ + redo(): void; - /** used to save the drawn image. - * @returns {void} - */ - save(): void; + /** used to save the drawn image. + * @returns {void} + */ + save(): void; - /** Used to Show the signature widget, if it is already hided. - * @returns {void} - */ - show(): void; + /** Used to Show the signature widget, if it is already hided. + * @returns {void} + */ + show(): void; - /** undo the last drawn stroke of the signature. - * @returns {void} - */ - undo(): void; -} -export namespace Signature { + /** undo the last drawn stroke of the signature. + * @returns {void} + */ + undo(): void; + } + export namespace Signature { -export interface Model { + export interface Model { - /** This property is used to set the background color for the signature. - * @Default {#ffffff} - */ - backgroundColor?: string; + /** This property is used to set the background color for the signature. + * @Default {#ffffff} + */ + backgroundColor?: string; - /** This property is used to set the background image for the signature. - */ - backgroundImage?: string; + /** This property is used to set the background image for the signature. + */ + backgroundImage?: string; - /** Enables or disables the Signature textbox widget. - * @Default {true} - */ - enabled?: boolean; + /** Enables or disables the Signature textbox widget. + * @Default {true} + */ + enabled?: boolean; - /** Sets the height of the Signature control. - * @Default {100%} - */ - height?: string; + /** Sets the height of the Signature control. + * @Default {100%} + */ + height?: string; - /** Enables/disables responsive support for the signature control (i.e) maintain the signature drawing during the window resizing time. - * @Default {false} - */ - isResponsive?: boolean; - - /** Allows the type of the image format to be saved when the signature image is saved. - */ - saveImageFormat?: ej.Signature.SaveImageFormat|string; - - /** Allows the signature image to be saved along with its background. - * @Default {false} - */ - saveWithBackground?: boolean; - - /** Enables or disables rounded corner. - * @Default {true} - */ - showRoundedCorner?: boolean; - - /** Sets the stroke color for the stroke of the signature. - * @Default {#000000} - */ - strokeColor?: string; - - /** Sets the stroke width for the stroke of the signature. - * @Default {2} - */ - strokeWidth?: number; - - /** Sets the width of the Signature control. - * @Default {100%} - */ - width?: string; - - /** Triggers when the stroke is changed. */ - change?(e: ChangeEventArgs): void; - - /** Triggered when the pointer is clicked or touched in the signature canvas. */ - mouseDown?(e: MouseDownEventArgs): void; + /** Enables/disables responsive support for the signature control (i.e) maintain the signature drawing during the window resizing time. + * @Default {false} + */ + isResponsive?: boolean; + + /** Allows the type of the image format to be saved when the signature image is saved. + */ + saveImageFormat?: ej.Signature.SaveImageFormat | string; + + /** Allows the signature image to be saved along with its background. + * @Default {false} + */ + saveWithBackground?: boolean; + + /** Enables or disables rounded corner. + * @Default {true} + */ + showRoundedCorner?: boolean; + + /** Sets the stroke color for the stroke of the signature. + * @Default {#000000} + */ + strokeColor?: string; + + /** Sets the stroke width for the stroke of the signature. + * @Default {2} + */ + strokeWidth?: number; + + /** Sets the width of the Signature control. + * @Default {100%} + */ + width?: string; + + /** Triggers when the stroke is changed. */ + change?(e: ChangeEventArgs): void; + + /** Triggered when the pointer is clicked or touched in the signature canvas. */ + mouseDown?(e: MouseDownEventArgs): void; - /** Triggered when the pointer is moved in the signature canvas. */ - mouseMove?(e: MouseMoveEventArgs): void; - - /** Triggered when the pointer is released after click or touch in the signature canvas. */ - mouseUp?(e: MouseUpEventArgs): void; -} + /** Triggered when the pointer is moved in the signature canvas. */ + mouseMove?(e: MouseMoveEventArgs): void; + + /** Triggered when the pointer is released after click or touch in the signature canvas. */ + mouseUp?(e: MouseUpEventArgs): void; + } -export interface ChangeEventArgs { - - /** Set this option to true to cancel the event. - */ - cancel?: boolean; - - /** Instance of the signature model object. - */ - model?: ej.Signature.Model; - - /** Name of the event. - */ - type?: string; + export interface ChangeEventArgs { + + /** Set this option to true to cancel the event. + */ + cancel?: boolean; + + /** Instance of the signature model object. + */ + model?: ej.Signature.Model; + + /** Name of the event. + */ + type?: string; - /** Gives the last stored image - */ - lastImage?: string; -} + /** Gives the last stored image + */ + lastImage?: string; + } -export interface MouseDownEventArgs { - - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + export interface MouseDownEventArgs { + + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the signature model object. - */ - model?: ej.Signature.Model; + /** Instance of the signature model object. + */ + model?: ej.Signature.Model; - /** Name of the event. - */ - type?: string; - - /** returns all the event values - */ - value?: any; -} - -export interface MouseMoveEventArgs { - - /** Set this option to true to cancel the event. - */ - cancel?: boolean; - - /** Instance of the signature model object. - */ - model?: ej.Signature.Model; - - /** Name of the event. - */ - type?: string; - - /** returns all the event values - */ - value?: any; -} - -export interface MouseUpEventArgs { - - /** Set this option to true to cancel the event. - */ - cancel?: boolean; - - /** Instance of the signature model object. - */ - model?: ej.Signature.Model; - - /** Name of the event. - */ - type?: string; - - /** returns all the event values - */ - value?: any; -} - -enum SaveImageFormat { - - ///To save the signature image with PNG format only. - PNG, - - ///To save the signature image with JPG format only. - JPG, - - ///To save the signature image with BMP format only. - BMP, - - ///To save the signature image with TIFF format only. - TIFF -} - -} - -class RadialSlider extends ej.Widget { - static fn: RadialSlider; - constructor(element: JQuery | Element, options?: RadialSlider.Model); - static Locale: any; - model: RadialSlider.Model; - defaults: RadialSlider.Model; + /** Name of the event. + */ + type?: string; + + /** returns all the event values + */ + value?: any; + } + + export interface MouseMoveEventArgs { + + /** Set this option to true to cancel the event. + */ + cancel?: boolean; + + /** Instance of the signature model object. + */ + model?: ej.Signature.Model; + + /** Name of the event. + */ + type?: string; + + /** returns all the event values + */ + value?: any; + } + + export interface MouseUpEventArgs { + + /** Set this option to true to cancel the event. + */ + cancel?: boolean; + + /** Instance of the signature model object. + */ + model?: ej.Signature.Model; + + /** Name of the event. + */ + type?: string; + + /** returns all the event values + */ + value?: any; + } + + enum SaveImageFormat { + + ///To save the signature image with PNG format only. + PNG, + + ///To save the signature image with JPG format only. + JPG, + + ///To save the signature image with BMP format only. + BMP, + + ///To save the signature image with TIFF format only. + TIFF + } + + } + + class RadialSlider extends ej.Widget { + static fn: RadialSlider; + constructor(element: JQuery | Element, options?: RadialSlider.Model); + static Locale: any; + model: RadialSlider.Model; + defaults: RadialSlider.Model; - /** To show the radialslider - * @returns {void} - */ - show(): void; - - /** To hide the radialslider - * @returns {void} - */ - hide(): void; -} -export namespace RadialSlider { - -export interface Model { + /** To show the radialslider + * @returns {void} + */ + show(): void; + + /** To hide the radialslider + * @returns {void} + */ + hide(): void; + } + export namespace RadialSlider { + + export interface Model { - /** To show the RadialSlider in initial render. - * @Default {false} - */ - autoOpen?: boolean; + /** To show the RadialSlider in initial render. + * @Default {false} + */ + autoOpen?: boolean; - /** Sets the root class for RadialSlider theme. This cssClass API helps to use custom skinning option for RadialSlider control. - * By defining the root class using this API, we need to include this root class in CSS. - */ - cssClass?: string; - - /** To enable Animation for Radial Slider. - * @Default {true} - */ - enableAnimation?: boolean; - - /** Enable/Disable the Roundoff property of RadialSlider - * @Default {true} - */ - enableRoundOff?: boolean; - - /** Specifies the endAngle value for radial slider circle. - * @Default {360} - */ - endAngle?: number; - - /** Specifies the inline for label show or not on given radius. - * @Default {false} - */ - inline?: boolean; - - /** Specifies innerCircleImageClass, using this property we can give images for center radial circle through CSS classes. - * @Default {null} - */ - innerCircleImageClass?: string; - - /** Specifies the file name of center circle icon - * @Default {null} - */ - innerCircleImageUrl?: string; - - /** Specifies the Space between the radial slider element and the label. - * @Default {30} - */ - labelSpace?: number; + /** Sets the root class for RadialSlider theme. This cssClass API helps to use custom skinning option for RadialSlider control. + * By defining the root class using this API, we need to include this root class in CSS. + */ + cssClass?: string; + + /** To enable Animation for Radial Slider. + * @Default {true} + */ + enableAnimation?: boolean; + + /** Enable/Disable the Roundoff property of RadialSlider + * @Default {true} + */ + enableRoundOff?: boolean; + + /** Specifies the endAngle value for radial slider circle. + * @Default {360} + */ + endAngle?: number; + + /** Specifies the inline for label show or not on given radius. + * @Default {false} + */ + inline?: boolean; + + /** Specifies innerCircleImageClass, using this property we can give images for center radial circle through CSS classes. + * @Default {null} + */ + innerCircleImageClass?: string; + + /** Specifies the file name of center circle icon + * @Default {null} + */ + innerCircleImageUrl?: string; + + /** Specifies the Space between the radial slider element and the label. + * @Default {30} + */ + labelSpace?: number; - /** Specifies the radius of radial slider - * @Default {200} - */ - radius?: number; - - /** To show the RadialSlider inner circle. - * @Default {true} - */ - showInnerCircle?: boolean; - - /** Specifies the endAngle value for radial slider circle. - * @Default {0} - */ - startAngle?: number; + /** Specifies the radius of radial slider + * @Default {200} + */ + radius?: number; + + /** To show the RadialSlider inner circle. + * @Default {true} + */ + showInnerCircle?: boolean; + + /** Specifies the endAngle value for radial slider circle. + * @Default {0} + */ + startAngle?: number; - /** Specifies the strokeWidth for customize the needle, outer circle and inner circle. - * @Default {2} - */ - strokeWidth?: number; - - /** Specifies the ticks value of radial slider - */ - ticks?: any[]; - - /** Specifies the value of radial slider - * @Default {10} - */ - value?: number; - - /** Event triggers when the change occurs. */ - change?(e: ChangeEventArgs): void; - - /** Event triggers when the radial slider is created. */ - create?(e: CreateEventArgs): void; - - /** Event triggers when the mouse pointer is dragged over the radial slider. */ - mouseover?(e: MouseoverEventArgs): void; - - /** Event triggers when the Radial slider slides. */ - slide?(e: SlideEventArgs): void; - - /** Event triggers when the radial slider starts. */ - start?(e: StartEventArgs): void; - - /** Event triggers when the radial slider stops. */ - stop?(e: StopEventArgs): void; -} - -export interface ChangeEventArgs { - - /** returns the Radialslider model - */ - model?: any; + /** Specifies the strokeWidth for customize the needle, outer circle and inner circle. + * @Default {2} + */ + strokeWidth?: number; + + /** Specifies the ticks value of radial slider + */ + ticks?: any[]; + + /** Specifies the value of radial slider + * @Default {10} + */ + value?: number; + + /** Event triggers when the change occurs. */ + change?(e: ChangeEventArgs): void; + + /** Event triggers when the radial slider is created. */ + create?(e: CreateEventArgs): void; + + /** Event triggers when the mouse pointer is dragged over the radial slider. */ + mouseover?(e: MouseoverEventArgs): void; + + /** Event triggers when the Radial slider slides. */ + slide?(e: SlideEventArgs): void; + + /** Event triggers when the radial slider starts. */ + start?(e: StartEventArgs): void; + + /** Event triggers when the radial slider stops. */ + stop?(e: StopEventArgs): void; + } + + export interface ChangeEventArgs { + + /** returns the Radialslider model + */ + model?: any; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the initial value of Radial slider - */ - oldValue?: number; + /** returns the initial value of Radial slider + */ + oldValue?: number; - /** returns the name of the event - */ - type?: string; + /** returns the name of the event + */ + type?: string; - /** returns the current value of the Radial slider - */ - value?: number; -} + /** returns the current value of the Radial slider + */ + value?: number; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the Radialslider model - */ - model?: any; - - /** returns the name of the event - */ - type?: string; -} - -export interface MouseoverEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the Radialslider model - */ - model?: any; - - /** returns the value selected - */ - selectedValue?: number; - - /** returns the name of the event - */ - type?: string; - - /** returns the current value selected in Radial slider - */ - value?: number; -} - -export interface SlideEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the Radialslider model - */ - model?: any; - - /** returns the value selected in Radial slider - */ - selectedValue?: number; - - /** returns the name of the event - */ - type?: string; - - /** returns the currently selected value - */ - value?: number; -} - -export interface StartEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the Radialslider model - */ - model?: any; - - /** returns the name of the event - */ - type?: string; - - /** returns the current value selected in Radial slider - */ - value?: number; -} - -export interface StopEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the Radialslider model - */ - model?: any; - - /** returns the name of the event - */ - type?: string; - - /** returns the current value selected in Radial slider - */ - value?: number; -} -} - -class Spreadsheet extends ej.Widget { - static fn: Spreadsheet; - constructor(element: JQuery | Element, options?: Spreadsheet.Model); - static Locale: any; - model: Spreadsheet.Model; - defaults: Spreadsheet.Model; - - /** This method is used to add custom formulas in Spreadsheet. - * @param {string} Pass the name of the formula. - * @param {string} Pass the name of the function. - * @returns {void} - */ - addCustomFormula(formulaName: string, functionName: string): void; - - /** This method is used to add a new sheet in the last position of the sheet container. - * @returns {void} - */ - addNewSheet(): void; - - /** It is used to clear all the data and format in the specified range of cells in Spreadsheet. - * @param {string|Array} Optional. If range is specified, then it will clear all content in the specified range else it will use the current selected range. - * @returns {void} - */ - clearAll(range?: string|any[]): void; - - /** This property is used to clear all the formats applied in the specified range in Spreadsheet. - * @param {string|Array} Optional. If range is specified, then it will clear all format in the specified range else it will use the current selected range. - * @returns {void} - */ - clearAllFormat(range?: string|any[]): void; - - /** Used to clear the applied border in the specified range in Spreadsheet. - * @param {string|Array} Optional. If range is specified, then it will clear border in the specified range else it will use the current selected range. - * @returns {void} - */ - clearBorder(range?: string|any[]): void; - - /** This property is used to clear the contents in the specified range in Spreadsheet. - * @param {string|Array} Optional. If the range is specified, then it will clear the content in the specified range else it will use the current selected range. - * @returns {void} - */ - clearContents(range?: string|any[]): void; - - /** This method is used to remove only the data in the range denoted by the specified range name. - * @param {string} Pass the defined rangeSettings property name. - * @returns {void} - */ - clearRange(rangeName: string): void; - - /** It is used to remove data in the specified range of cells based on the defined property. - * @param {Array|string} Optional. If range is specified, it will clear data for the specified range else it will use the current selected range. - * @param {string} Optional. If property is specified, it will remove the specified property in the range else it will remove default properties - * @param {any} Optional. - * @param {boolean} Optional. pass {{'`true`' | markdownify}}, if you want to skip the hidden rows - * @param {any} Optional. Pass the status to perform undo and redo operation. - * @param {any} Optional. It specifies whether to skip element processing or not. - * @returns {void} - */ - clearRangeData(range?: any[]|string, property?: string, cells?: any, skipHiddenRow?: boolean, status?: any, skipCell?: any): void; - - /** This method is used to clear undo and redo collections in the Spreadsheet. - * @returns {void} - */ - clearUndoRedo(): void; - - /** This method is used to copy or move the sheets in Spreadsheet. - * @param {number} Pass the sheet index that you want to copy or move. - * @param {number} Pass the position index where you want to copy or move. - * @param {boolean} Pass {{'`true`' | markdownify}},If you want to copy sheet or else it will move sheet. - * @returns {void} - */ - copySheet(fromIdx: number, toIdx: number, isCopySheet: boolean): void; - - /** This method is used to delete the entire column which is selected. - * @param {number} Pass the start column index. - * @param {number} Pass the end column index. - * @returns {void} - */ - deleteEntireColumn(startCol: number, endCol: number): void; - - /** This method is used to delete the entire row which is selected. - * @param {number} Pass the start row index. - * @param {number} Pass the end row index. - * @returns {void} - */ - deleteEntireRow(startRow: number, endRow: number): void; - - /** This method is used to delete a particular sheet in the Spreadsheet. - * @param {number} Pass the sheet index to perform delete action. - * @returns {void} - */ - deleteSheet(idx: number): void; - - /** This method is used to delete the selected cells and shift the remaining cells to left. - * @param {any} Row index and column index of the starting cell. - * @param {any} Row index and column index of the ending cell. - * @returns {void} - */ - deleteShiftLeft(startCell: any, endCell: any): void; - - /** This method is used to delete the selected cells and shift the remaining cells up. - * @param {any} Row index and column index of the start cell. - * @param {any} Row index and column index of the end cell. - * @returns {void} - */ - deleteShiftUp(startCell: any, endCell: any): void; - - /** This method is used to edit data in the specified range of cells based on its corresponding rangeSettings. - * @param {string} Pass the defined rangeSettings property name. - * @param {Function} Pass the function that you want to perform range edit. - * @returns {void} - */ - editRange(rangeName: string, fn: any): void; - - /** This method is used to get the activation panel in the Spreadsheet. - * @returns {HTMLElement} - */ - getActivationPanel(): HTMLElement; - - /** This method is used to get the active cell object in Spreadsheet. It will returns object which contains rowIndex and colIndex of the active cell. - * @param {number} Optional. If sheetIdx is specified, it will return the active cell object in specified sheet index else it will use the current sheet index - * @returns {any} - */ - getActiveCell(sheetIdx?: number): any; - - /** This method is used to get the active cell element based on the given sheet index in the Spreadsheet. - * @param {number} Optional. If sheetIndex is specified, it will return the active cell element in specified sheet index else it will use the current active sheet index. - * @returns {HTMLElement} - */ - getActiveCellElem(sheetIdx?: number): HTMLElement; - - /** This method is used to get the current active sheet index in Spreadsheet. - * @returns {number} - */ - getActiveSheetIndex(): number; - - /** This method is used to get the auto fill element in Spreadsheet. - * @returns {HTMLElement} - */ - getAutoFillElem(): HTMLElement; - - /** This method is used to get the cell element based on specified row and column index in the Spreadsheet. - * @param {number} Pass the row index. - * @param {number} Pass the column index. - * @param {number} Optional. Pass the sheet index that you want to get cell. - * @returns {HTMLElement} - */ - getCell(rowIdx: number, colIdx: number, sheetIdx?: number): HTMLElement; - - /** This method is used to get the data settings in the Spreadsheet. - * @param {number} Pass the sheet index. - * @returns {number} - */ - getDataSettings(sheetIdx: number): number; - - /** This method is used to get the frozen columns index in the Spreadsheet. - * @param {number} Pass the sheet index. - * @returns {number} - */ - getFrozenColumns(sheetIdx: number): number; - - /** This method is used to get the frozen row index in Spreadsheet. - * @param {number} Pass the sheet index. - * @returns {number} - */ - getFrozenRows(sheetIdx: number): number; - - /** This method is used to get the hyperlink data as object from the specified cell in Spreadsheet. - * @param {HTMLElement} Pass the DOM element to get hyperlink - * @returns {any} - */ - getHyperlink(cell: HTMLElement): any; - - /** This method is used to get all cell elements in the specified range. - * @param {string} Pass the range that you want to get the cells. - * @param {number} Pass the index of the sheet. - * @param {boolean} Optional. Pass {{'`true`' | markdownify}}, if you want to skip the hidden rows. - * @returns {HTMLElement} - */ - getRange(range: string, sheetIdx: number, skipHiddenRow?: boolean): HTMLElement; - - /** This method is used to get the data in specified range in Spreadsheet. - * @param {any} Optional. Pass the range, property, sheetIdx, valueOnly in options. - * @returns {Array} - */ - getRangeData(options?: any): any[]; - - /** This method is used to get the range indices array based on the specified alpha range in Spreadsheet. - * @param {string} Pass the alpha range that you want to get range indices. - * @returns {Array} - */ - getRangeIndices(range: string): any[]; - - /** This method is used to get the sheet details based on the given sheet index in Spreadsheet. - * @param {number} Pass the sheet index to get the sheet object. - * @returns {any} - */ - getSheet(sheetIdx: number): any; - - /** This method is used to get the sheet content div element of Spreadsheet. - * @param {number} Pass the sheet index to get the sheet content. - * @returns {HTMLElement} - */ - getSheetElement(sheetIdx: number): HTMLElement; - - /** This method is used to get all the sheets in workbook. - * @returns {Array} - */ - getSheets(): any[]; - - /** This method is used to send a paging request to the specified sheet Index in the Spreadsheet. - * @param {number} Pass the sheet index to perform paging at specified sheet index - * @param {boolean} Pass {{'`true`' | markdownify}} to create a new sheet. If the specified sheet index is already exist, it navigate to that sheet else it create a new sheet. - * @returns {void} - */ - gotoPage(sheetIdx: number, newSheet: boolean): void; - - /** This method is used to hide the entire columns from the specified range (startCol, endCol) in Spreadsheet. - * @param {number} Index of the start column. - * @param {number} Optional. Index of the end column. - * @returns {void} - */ - hideColumn(startCol: number, endCol: number): void; - - /** This method is used to hide the formula bar in Spreadsheet. - * @returns {void} - */ - hideFormulaBar(): void; - - /** This method is used to hide the rows, based on the specified row index in Spreadsheet. - * @param {number} Index of the start row. - * @param {number} Optional. Index of the end row. - * @returns {void} - */ - hideRow(startRow: number, endRow: number): void; - - /** This method is used to hide the sheet based on the specified sheetIndex or sheet name in the Spreadsheet. - * @param {string|number} Pass the sheet name or index that you want to hide. - * @returns {void} - */ - hideSheet(sheetIdx: string|number): void; - - /** This method is used to hide the displayed waiting pop-up in Spreadsheet. - * @returns {void} - */ - hideWaitingPopUp(): void; - - /** This method is used to insert a column before the active cell's column in the Spreadsheet. - * @param {number} Pass start column. - * @param {number} Pass end column. - * @returns {void} - */ - insertEntireColumn(startCol: number, endCol: number): void; - - /** This method is used to insert a row before the active cell's row in the Spreadsheet. - * @param {number} Pass start row. - * @param {number} Pass end row. - * @returns {void} - */ - insertEntireRow(startRow: number, endRow: number): void; - - /** This method is used to insert a new sheet to the left of the current active sheet. - * @returns {void} - */ - insertSheet(): void; - - /** This method is used to insert cells in the selected or specified range and shift remaining cells to bottom. - * @param {any} Row index and column index of the start cell. - * @param {any} Row index and column index of the end cell. - * @returns {void} - */ - insertShiftBottom(startCell: any, endCell: any): void; - - /** This method is used to insert cells in the selected or specified range and shift remaining cells to right. - * @param {any} Row index and column index of the start cell. - * @param {any} Row index and column index of the end cell. - * @returns {void} - */ - insertShiftRight(startCell: any, endCell: any): void; - - /** This method is used to import excel file manually by using form data. - * @param {any} Pass the form data object to import files manually. - * @returns {void} - */ - import(importRequest: any): void; - - /** This method is used to load JSON data in Spreadsheet. - * @param {any} Pass the response that you want to load. - * @returns {void} - */ - loadFromJSON(response: any): void; - - /** This method is used to lock/unlock the range of cells in active sheet. Lock cells are activated only after the sheet is protected. Once the sheet is protected it is unable to lock/unlock cells. - * @param {string|Array} Pass the alpha range cells or array range of cells. - * @param {string} Optional. By default is {{'`true`' | markdownify}}. If it is {{'`false`' | markdownify}} locked cells are unlocked. - * @returns {void} - */ - lockCells(range: string|any[], isLocked?: string): void; - - /** This method is used to merge cells by across in the Spreadsheet. - * @param {string} Optional. To pass the cell range or selected cells are process. - * @param {boolean} Optional. If pass {{'`true`' | markdownify}} it does not show alert. - * @returns {void} - */ - mergeAcrossCells(range?: string, alertStatus?: boolean): void; - - /** This method is used to merge the selected cells in the Spreadsheet. - * @param {string|Array} Optional. To pass the cell range or selected cells are process. - * @param {boolean} Optional. If pass {{'`true`' | markdownify}} it does not show alert. - * @returns {void} - */ - mergeCells(range?: string|any[], alertStatus?: boolean): void; - - /** This method is used to select a cell or range in the Spreadsheet. - * @param {any} Pass the start cell to perform selection. - * @param {any} Pass the end cell to perform selection. - * @returns {void} - */ - performSelection(startCell: any, endCell: any): void; - - /** This method is used to protect or unprotect active sheet. - * @param {boolean} Optional. By default is {{'`true`' | markdownify}}. If it is {{'`false`' | markdownify}} active sheet is unprotected. - * @returns {void} - */ - protectSheet(isProtected?: boolean): void; - - /** This method is used to refresh the content in Spreadsheet. - * @param {number} Pass the index of the sheet. - * @returns {void} - */ - refreshContent(sheetIdx: number): void; - - /** This method is used to refresh the Spreadsheet. - * @returns {void} - */ - refreshSpreadsheet(): void; - - /** This method is used to remove custom formulae in Spreadsheet. - * @param {string} Pass the name of the formula. - * @param {string} Pass the name of the function. - * @returns {void} - */ - removeCustomFormula(formulaName: string, functionName: string): void; - - /** This method is used to remove the hyperlink from selected cells of current sheet. - * @param {string} Hyperlink remove from the specified range. - * @param {boolean} Optional. If it is {{'`true`' | markdownify}}, It will clear link only not format. - * @param {boolean} Optional. Pass the status to perform undo and redo operations. - * @param {any} Optional. Pass the cells that you want to remove hyperlink. - * @param {boolean} Optional. Pass {{'`true`' | markdownify}}, if you want to skip the hidden rows. - * @returns {void} - */ - removeHyperlink(range: string, isClearHLink?: boolean, status?: boolean, cells?: any, skipHiddenRow?: boolean): void; - - /** This method is used to remove the range data and its defined rangeSettings property based on the specified range name. - * @param {string} Pass the defined rangeSetting property name. - * @returns {void} - */ - removeRange(rangeName: string): void; - - /** This method is used to remove the readonly option for the specified range. - * @param {string|Array} Pass the range. - * @returns {void} - */ - removeReadOnly(range?: string|any[]): void; - - /** This method is used to save JSON data in Spreadsheet. - * @returns {any} - */ - saveAsJSON(): any; - - /** This method is used to save batch changes in Spreadsheet. - * @param {number} Pass the sheet index for Spreadsheet. - * @returns {void} - */ - saveBatchChanges(sheetIdx: number): void; - - /** This method is used to set the active cell in the Spreadsheet. - * @param {number} Pass the row index. - * @param {number} Pass the column index. - * @param {number} Pass the index of the sheet. - * @returns {void} - */ - setActiveCell(rowIdx: number, colIdx: number, sheetIdx: number): void; - - /** This method is used to set active sheet index for the Spreadsheet. - * @param {number} Pass the active sheet index for Spreadsheet. - * @returns {void} - */ - setActiveSheetIndex(sheetIdx: number): void; - - /** This method is used to set border for the specified range of cells in the Spreadsheet. - * @param {any} Pass the border properties that you want to set. - * @param {string} Optional. If range is specified, it will set border for the specified range else it will use the selected range. - * @returns {void} - */ - setBorder(property: any, range?: string): void; - - /** This method is used to set the height for the rows in the Spreadsheet. - * @param {Array|any} Pass the row index and height of the rows. - * @returns {void} - */ - setHeightToRows(heightColl: any[]|any): void; - - /** This method is used to set the hyperlink in selected cells of the current sheet. - * @param {string|Array} If range is specified, it will set the hyperlink in range of the cells. - * @param {any} Pass cellAddress or webAddress - * @param {number} If we pass cellAddress then which sheet to be navigate in the applied link. - * @returns {void} - */ - setHyperlink(range: string|any[], link: any, sheetIdx: number): void; - - /** This method is used to set the readonly option for the specified range. - * @param {string|Array} Pass the range. - * @returns {void} - */ - setReadOnly(range?: string|any[]): void; - - /** This method is used to set the focus to the Spreadsheet. - * @returns {void} - */ - setSheetFocus(): void; - - /** This method is used to set the width for the columns in the Spreadsheet. - * @param {Array|any} Pass the column index and width of the columns. - * @returns {void} - */ - setWidthToColumns(widthColl: any[]|any): void; - - /** This method is used to rename the active sheet. - * @param {string} Pass the sheet name that you want to change the current active sheet name. - * @returns {void} - */ - sheetRename(sheetName: string): void; - - /** This method is used to display the activationPanel for the specified range name. - * @param {string} Pass the range name that you want to display the activation panel. - * @returns {void} - */ - showActivationPanel(rangeName: string): void; - - /** This method is used to show the hidden columns within the specified range in the Spreadsheet. - * @param {number} Index of the start column. - * @param {number} Optional. Index of the end column. - * @returns {void} - */ - showColumn(startColIdx: number, endColIdx: number): void; - - /** This method is used to show the formula bar in Spreadsheet. - * @returns {void} - */ - showFormulaBar(): void; - - /** This method is used to show/hide gridlines in active sheet in the Spreadsheet. - * @param {boolean} Pass {{'`true`' | markdownify}} to show the gridlines - * @returns {void} - */ - showGridlines(status: boolean): void; - - /** This method is used to show/hide the headers in active sheet in the Spreadsheet. - * @param {boolean} Pass {{'`true`' | markdownify}} to show the sheet headers. - * @returns {void} - */ - showHeadings(startRow: boolean): void; - - /** This method is used to show/hide pager in the Spreadsheet. - * @param {boolean} Pass {{'`true`' | markdownify}} to show pager. - * @returns {void} - */ - showPager(status: boolean): void; - - /** This method is used to show the hidden rows in the specified range in the Spreadsheet. - * @param {number} Index of the start row. - * @param {number} Optional. Index of the end row. - * @returns {void} - */ - showRow(startRow: number, endRow: number): void; - - /** This method is used to show waiting pop-up in Spreadsheet. - * @returns {void} - */ - showWaitingPopUp(): void; - - /** This method is used to unhide the sheet based on specified sheet name or sheet index. - * @param {string|number} Pass the sheet name or index that you want to unhide. - * @returns {void} - */ - unhideSheet(sheetInfo: string|number): void; - - /** This method is used to unmerge the selected range of cells in the Spreadsheet. - * @param {string} Optional. If the range is specified, then it will un merge the specified range else it will use the current selected range. - * @returns {void} - */ - unmergeCells(range?: string): void; - - /** This method is used to unwrap the selected range of cells in the Spreadsheet. - * @param {Array|string} Optional. If the range is specified, then it will update unwrap in the specified range else it will use the current selected range. - * @returns {void} - */ - unWrapText(range?: any[]|string): void; - - /** This method is used to update the data for the specified range of cells in the Spreadsheet. - * @param {any} Pass the cells data that you want to update. - * @param {Array|string} Optional. If range is specified, it will update data for the specified range else it will use the current selected range. - * @returns {void} - */ - updateData(data: any, range?: any[]|string): void; - - /** This method is used to update the formula bar in the Spreadsheet. - * @returns {void} - */ - updateFormulaBar(): void; - - /** This method is used to update the range of cells based on the specified settings which we want to update in the Spreadsheet. - * @param {number} Pass the sheet index that you want to update. - * @param {any} Pass the dataSource, startCell and showHeader values as settings. - * @returns {void} - */ - updateRange(sheetIdx: number, settings: any): void; - - /** This method is used to update the details for custom undo and redo operations. - * @param {any} Pass the details to update undo and redo collection - * @returns {void} - */ - updateUndoRedoCollection(details: any): void; - - /** This method is used to update the unique data for the specified range of cells in Spreadsheet. - * @param {any} Pass the data that you want to update in the particular range - * @param {Array|string} Optional. If range is specified, it will update data for the specified range else it will use the current selected range. - * @param {any} Optional. It specifies whether to skip element processing or not. - * @returns {void} - */ - updateUniqueData(data: any, range?: any[]|string, skipCell?: any): void; - - /** This method is used to wrap the selected range of cells in the Spreadsheet. - * @param {Array|string} Optional. If the range is specified, then it will update wrap in the specified range else it will use the current selected range. - * @returns {void} - */ - wrapText(range?: any[]|string): void; - - XLCellType: Spreadsheet.XLCellType; - - XLCFormat: Spreadsheet.XLCFormat; - - XLChart: Spreadsheet.XLChart; - - XLClipboard: Spreadsheet.XLClipboard; - - XLComment: Spreadsheet.XLComment; - - XLCMenu: Spreadsheet.XLCMenu; - - XLDragDrop: Spreadsheet.XLDragDrop; - - XLDragFill: Spreadsheet.XLDragFill; - - XLEdit: Spreadsheet.XLEdit; - - XLExport: Spreadsheet.XLExport; - - /** This method is used to get the export properties in the Spreadsheet. - * @returns {any} - */ - getExportProps(): any; - - XLFilter: Spreadsheet.XLFilter; - - XLFormat: Spreadsheet.XLFormat; - - XLFreeze: Spreadsheet.XLFreeze; - - /** This method is used to unfreeze the frozen rows and columns in the Spreadsheet. - * @returns {void} - */ - unfreezePanes(): void; - - XLPivot: Spreadsheet.XLPivot; - - XLPrint: Spreadsheet.XLPrint; - - XLResize: Spreadsheet.XLResize; - - XLRibbon: Spreadsheet.XLRibbon; - - XLSearch: Spreadsheet.XLSearch; - - XLSelection: Spreadsheet.XLSelection; - - XLShape: Spreadsheet.XLShape; - - XLSort: Spreadsheet.XLSort; - - XLValidate: Spreadsheet.XLValidate; -} -export namespace Spreadsheet { - -export interface XLCellType { - - /** This method is used to set a cell type from the specified range of cells in the spreadsheet. - * @param {string} Pass the range where you want apply cell type. - * @param {any} Pass type of cell type and its settings. - * @param {number} Optional. Pass sheet index. - * @returns {void} - */ - addCellTypes(range: string, settings: any, sheetIdx: number): void; - - /** This method is used to remove cell type from the specified range of cells in the Spreadsheet. - * @param {string|Array} Pass the range where you want remove cell type. - * @param {number} Optional. Pass sheet index. - * @returns {void} - */ - removeCellTypes(range: string|any[], sheetIdx: number): void; -} - -export interface XLCFormat { - - /** This method is used to clear the applied conditional formatting rules in the Spreadsheet. - * @param {Array|string} Optional. If range is specified, it will clear rules for the specified range else it will use the current selected range. - * @returns {void} - */ - clearCF(range: any[] |string): void; - - /** This method is used to get the applied conditional formatting rules as array of objects based on the specified row Index and column Index in the Spreadsheet. - * @param {number} Pass the row index. - * @param {number} Pass the column index. - * @returns {Array} - */ - getCFRule(rowIdx: number, colIdx: number): any[]; - - /** This method is used to set the conditional formatting rule in the Spreadsheet. - * @param {any} Pass the rule to set. - * @returns {void} - */ - setCFRule(rule: any): void; -} - -export interface XLChart { - - /** This method is used to change the theme of the chart in the Spreadsheet. - * @param {string} Pass the chart id. - * @param {ej.datavisualization.Chart.Theme} Pass the chart theme which want to update. - * @returns {void} - */ - changeTheme(chartId: string, theme: ej.datavisualization.Chart.Theme): void; - - /** This method is used to change the type of the chart in the Spreadsheet. - * @param {string} Pass the chart id. - * @param {any} Pass the chart type. - * @returns {void} - */ - changeType(chartId: string, option: any): void; - - /** This method is used to change the data range of the chart in the Spreadsheet. - * @param {string} Pass the chart id. - * @param {string} X axis range of chart data. - * @param {string} Y axis range of chart data. - * @param {string} Legend range of chart data. - * @returns {void} - */ - changeDataRange(chartId: string, xRange: string, yRange: string, lRange: string): void; - - /** This method is used to create a chart for specified range in Spreadsheet. - * @param {string|Array} Optional. If range is specified, it will create chart for the specified range else it will use the current selected range. - * @param {any} Optional. To pass the type of chart and chart name. - * @returns {void} - */ - createChart(range: string|any[], options: any): void; - - /** This method is used to refresh the chart in the Spreadsheet. - * @param {string} To pass the chart Id. - * @param {any} To pass the type of chart and chart name. - * @returns {void} - */ - refreshChart(id: string, options: any): void; - - /** This method is used to resize the chart of specified id in the Spreadsheet. - * @param {string} To pass the chart id. - * @param {number} To pass height value. - * @param {number} To pass the width value. - * @returns {void} - */ - resizeChart(id: string, height: number, width: number): void; - - /** This method is used to update the chart element, such as axes, titles, data labels, grid lines and legends in the Spreadsheet. - * @param {string} Pass the chart id. - * @param {ej.Spreadsheet.ChartProperties} Pass chart element value which you want to update. - * @returns {void} - */ - updateChartElement(chartId: string, value: ej.Spreadsheet.ChartProperties): void; - - /** This method is used switch row to columns and vice versa for chart in the Spreadsheet. So that the data is displayed in the chart the way you want. - * @param {string} Pass the chart id. - * @returns {void} - */ - switchRowColumn(chartId: string): void; -} - -export interface XLClipboard { - - /** This method is used to copy the selected cells in the Spreadsheet. - * @returns {void} - */ - copy(): void; - - /** This method is used to cut the selected cells in the Spreadsheet. - * @returns {void} - */ - cut(): void; - - /** This method is used to paste the cut or copied cells data in the Spreadsheet. - * @returns {void} - */ - paste(): void; -} - -export interface XLComment { - - /** This method is used to delete the comment in the specified range in Spreadsheet. - * @param {Array|string} Optional. If range is specified, it will delete comments for the specified range else it will use the current selected range. - * @param {number} Optional. If sheetIdx is specified, it will delete comment in specified sheet else it will use active sheet. - * @param {boolean} Optional. Pass {{'`true`' | markdownify}}, if you want to skip the hidden rows data. - * @returns {void} - */ - deleteComment(range: any[]|string, sheetIdx: number, skipHiddenRow: boolean): void; - - /** This method is used to edit the comment in the target Cell in Spreadsheet. - * @param {any} Optional. Pass the row index and column index of the cell which contains comment. - * @returns {void} - */ - editComment(targetCell: any): void; - - /** This method is used to find the next comment from the active cell in Spreadsheet. - * @returns {boolean} - */ - findNextComment(): boolean; - - /** This method is used to find the previous comment from the active cell in Spreadsheet. - * @returns {boolean} - */ - findPrevComment(): boolean; - - /** This method is used to get comment data for the specified cell. - * @param {HTMLElement} Pass the DOM element to get comment data as object. - * @returns {any} - */ - getComment(cell: HTMLElement): any; - - /** This method is used to set new comment in Spreadsheet. - * @param {string|Array} Optional. If we pass the range comment will set in the range otherwise it will set with selected cells. - * @param {string} Optional. Pass the comment data. - * @param {boolean} Optional. Pass {{'`true`' | markdownify}} to show comment in edit mode - * @param {boolean} Optional. Pass {{'`true`' | markdownify}} to show the user name - * @returns {void} - */ - setComment(range: string|any[], data: string, showEditPanel: boolean, showUserName: boolean): void; - - /** This method is used to show all the comments in the Spreadsheet. - * @returns {void} - */ - showAllComments(): void; - - /** This method is used to show or hide the specific comment in the Spreadsheet. - * @param {HTMLElement} Optional. Pass the cell DOM element to show or hide its comment. If pass empty argument active cell will processed. - * @returns {void} - */ - showHideComment(targetCell: HTMLElement): void; -} - -export interface XLCMenu { - - /** This method is used to dynamically add items in the context menu. - * @param {string} Specifies the context menu type in which the item to be inserted. - * @param {Array} Pass the items to be inserted - * @param {string} Specifies the type of operation to be performed - * @returns {void} - */ - addItem(target: string, itemColl: any[], operation: string): void; - - /** This method is used to change data source in the context menu. - * @param {string} Specifies the context menu type to bind the data source. - * @param {Array} Pass the data source to be binded - * @returns {void} - */ - changeDataSource(target: string, data: any[]): void; - - /** This method is used to disable the items in the context menu. - * @param {string} Specifies the context menu type in which the item to be disabled. - * @param {Array} Specifies the Menu Item id collection to be disabled - * @returns {void} - */ - disableItem(target: string, idxColl: any[]): void; - - /** This method is used to enable the items in the context menu. - * @param {string} Specifies the context menu type in which the item to be enabled. - * @param {Array} Specifies the Menu Item id collection to be enabled - * @returns {void} - */ - enableItem(target: string, idxColl: any[]): void; - - /** This method is used to remove the items in the context menu. - * @param {string} Specifies the context menu type in which the item to be removed. - * @param {Array} Specifies the Menu Item id collection to be removed - * @returns {void} - */ - removeItem(target: string, idxColl: any[]): void; -} - -export interface XLDragDrop { - - /** This method is used to drag and drop the selected range of cells to destination range in the Spreadsheet. - * @param {any|Array} Pass the source range to perform drag and drop. - * @param {any|Array} Pass the destination range to drop the dragged cells. - * @returns {void} - */ - moveRangeTo(sourceRange: any|any[], destinationRange: any|any[]): void; -} - -export interface XLDragFill { - - /** This method is used to perform auto fill in Spreadsheet. - * @param {any} Pass the options to perform auto fill in Spreadsheet. - * @returns {void} - */ - autoFill(options: any): void; - - /** This method is used to hide the auto fill element in the Spreadsheet. - * @returns {void} - */ - hideAutoFillElement(): void; - - /** This method is used to hide the auto fill options in the Spreadsheet. - * @returns {void} - */ - hideAutoFillOptions(): void; - - /** This method is used to set position of the auto fill element in the Spreadsheet. - * @param {boolean} Pass the isDragFill option as {{'`boolean`' | markdownify}} value to show auto fill options in Spreadsheet. - * @returns {void} - */ - positionAutoFillElement(isDragFill: boolean): void; -} - -export interface XLEdit { - - /** This method is used to calculate formulas in the specified sheet. - * @param {number} Optional. If sheet index is specified, then it will calculate formulas in the specified sheet only else it will calculate formulas in all sheets. - * @returns {void} - */ - calcNow(sheetIdx: number): void; - - /** This method is used to edit a particular cell based on the row index and column index in the Spreadsheet. - * @param {number} Pass the row index to edit particular cell. - * @param {number} Pass the column index to edit particular cell. - * @param {boolean} Pass {{'`true`' | markdownify}}, if you want to maintain previous cell value. - * @returns {void} - */ - editCell(rowIdx: number, colIdx: number, oldData: boolean): void; - - /** This method is used to get the property value of particular cell, based on the row and column index in the Spreadsheet. - * @param {number} Pass the row index to get the property value. - * @param {number} Pass the column index to get the property value. - * @param {string} Optional. Pass the property name that you want("value", "value2", "type", "cFormatRule", "range", "thousandSeparator", "rule", "format", "border", "picture", - * "chart", "calcValue", "align", "hyperlink", "formats", "borders", "tformats", "tborders", "isFilterHeader", "filterState", "tableName", "comment", "formatStr", - * "decimalPlaces", "cellType"). - * @param {number} Optional. Pass the index of the sheet. - * @returns {any|string|Array} - */ - getPropertyValue(rowIdx: number, colIdx: number, prop: string, sheetIdx: number): any|string|any[]; - - /** This method is used to get the property value in specified cell in Spreadsheet. - * @param {HTMLElement} Pass the cell element to get property value. - * @param {string} Pass the property name that you want ("value", "value2", "type", "cFormatRule", "range", "thousandSeparator", "rule", "format", "border", - * "picture", "chart", "calcValue", "align", "hyperlink", "formats", "borders", "tformats", "tborders", "isFilterHeader", "filterState", "tableName", - * "comment", "formatStr", "decimalPlaces", "cellType"). - * @param {number} Pass the index of sheet. - * @returns {any|string|Array} - */ - getPropertyValueByElem(elem: HTMLElement, property: string, sheetIdx: number): any|string|any[]; - - /** This method is used to save the edited cell value in the Spreadsheet. - * @returns {void} - */ - saveCell(): void; - - /** This method is used to update a particular cell value in the Spreadsheet. - * @param {any} Pass row index and column index of the cell. - * @param {string|number} Pass the cell value. - * @returns {void} - */ - updateCell(cell: any, value: string|number): void; - - /** This method is used to update a particular cell value and its format in the Spreadsheet. - * @param {any} Pass row index and column index of the cell. - * @param {string|number} Pass the cell value. - * @param {string} Pass the class name to update format. - * @param {number} Pass sheet index. - * @returns {void} - */ - updateCellValue(cellIdx: any, val: string|number, formatClass: string, sheetIdx: number): void; -} - -export interface XLExport { - - /** This method is used to save the sheet data as Excel ,CSV or PDF document (.xls, .xlsx .csv, .pdf) in Spreadsheet. - * @param {string} Pass the export type that you want. - * @returns {void} - */ - export(type: string): void; - - /** This method is used to get the export properties in the Spreadsheet. - * @returns {any} - */ - getExportProps(): any; -} - -export interface XLFilter { - - /** This method is used to clear the filter in filtered columns in the Spreadsheet. - * @returns {void} - */ - clearFilter(): void; - - /** This method is used to apply filter for the selected range of cells in the Spreadsheet. - * @param {string|Array} Pass the range of the selected cells. - * @returns {void} - */ - filter(range: string|any[]): void; - - /** This method is used to apply filter for the column by active cell's value in the Spreadsheet. - * @returns {void} - */ - filterByActiveCell(): void; -} - -export interface XLFormat { - - /** This method is used to convert table range to normal range. - * @param {any} Pass the sheet index and table id. - * @returns {void} - */ - convertToRange(options: any): void; - - /** This method is used to create a table for the selected range of cells in the Spreadsheet. - * @param {any} Pass the table object. - * @param {string|Array} Optional. If the range is specified, then it will create table in the specified range else it will use the current selected range. - * @returns {string} - */ - createTable(tableObject: any, range: string|any[]): string; - - /** This method is used to set format style and values in a cell or range of cells. - * @param {any} Pass the formatObject which contains style, type, format, groupSeparator and decimalPlaces. - * @param {string} Pass the range to format cells. - * @returns {void} - */ - format(formatObj: any, range: string): void; - - /** This method is used to remove the style in the specified range. - * @param {Array|string} Pass the cell range . - * @param {any} Optional. Pass the options for which the style gets removed. - * @returns {void} - */ - removeStyle(range: any[]|string, options: any): void; - - /** This method is used to remove table with specified tableId in the Spreadsheet. - * @param {number} Pass the tableId that you want to remove. - * @returns {void} - */ - removeTable(tableId: number): void; - - /** This method is used to update the decimal places for numeric value for the selected range of cells in the Spreadsheet. - * @param {string} Pass the decimal places type in increment/decrement. - * @param {string|Array} Pass the range. - * @returns {void} - */ - updateDecimalPlaces(type: string, range: string|any[]): void; - - /** This method is used to update the format for the selected range of cells in the Spreadsheet. - * @param {any} Pass the format object that you want to update. - * @param {Array} Optional. If the range is specified, then it will update format in the specified range else it will use the current selected range. - * @returns {void} - */ - updateFormat(formatObj: any, range: any[]): void; - - /** This method is used to update the unique format for selected range of cells in the Spreadsheet. - * @param {string} Pass the unique format class. - * @param {Array} Optional. If the range is specified, then it will update format in the specified range else it will use the current selected range. - * @returns {void} - */ - updateUniqueFormat(formatClass: string, range: any[]): void; -} - -export interface XLFreeze { - - /** This method is used to freeze columns upto the specified column index in the Spreadsheet. - * @param {number} Index of the column to be freeze. - * @returns {void} - */ - freezeColumns(colIdx: number): void; - - /** This method is used to freeze the first column in the Spreadsheet. - * @returns {void} - */ - freezeLeftColumn(): void; - - /** This method is used to freeze rows and columns before the specified cell in the Spreadsheet. - * @param {number} Index of the row to be freeze. - * @param {number} Index of the column to be freeze. - * @returns {void} - */ - freezePanes(rowIdx: number, colIdx: number): void; - - /** This method is used to freeze rows upto the specified row index in the Spreadsheet. - * @param {number} Index of the row to be freeze. - * @returns {void} - */ - freezeRows(rowIdx: number): void; - - /** This method is used to freeze the top row in the Spreadsheet. - * @returns {void} - */ - freezeTopRow(): void; - - /** This method is used to unfreeze the frozen rows and columns in the Spreadsheet. - * @returns {void} - */ - unfreezePanes(): void; -} - -export interface XLPivot { - - /** This property is used to clear the pivot table list in Spreadsheet. - * @param {string} Pass the name of the pivot table. - * @returns {void} - */ - clearPivotFieldList(pivotName: string): void; - - /** This method is used to create pivot table. - * @param {string} It specifies the range for which the pivot table is created. - * @param {string} It specifies the location in which the pivot table is created. - * @param {string} It specifies the name of the pivot table. - * @param {any} Pass the pivot table settings. - * @param {any} Pass the pivot range, sheet index, address and data source . - * @returns {string} - */ - createPivotTable(range: string, location: string, name: string, settings: any, pvt: any): string; - - /** This method is used to delete the pivot table which is selected. - * @param {string} Pass the name of the pivot table. - * @returns {void} - */ - deletePivotTable(pivotName: string): void; - - /** This method is used to refresh data in pivot table. - * @param {string} Optional. Pass the name of the pivot table. - * @param {number} Optional. Pass the index of the sheet. - * @returns {void} - */ - refreshDataSource(name: string, sheetIdx: number): void; -} - -export interface XLPrint { - - /** This method is used to print the selected contents in the Spreadsheet. - * @returns {void} - */ - printSelection(): void; - - /** This method is used to print the entire contents in the active sheet. - * @returns {void} - */ - printSheet(): void; -} - -export interface XLResize { - - /** This method is used to fit the height of rows in the Spreadsheet. - * @param {Array} Optional. Pass row index collection that you want to fit its height. - * @returns {void} - */ - fitHeight(rowIndexes: any[]): void; - - /** This method is used to fit the width of columns in the Spreadsheet. - * @param {Array} Optional. Pass column index collection that you want to fit its width. - * @returns {void} - */ - fitWidth(colIndexes: any[]): void; - - /** This method is used to get the column width of the specified column index in the Spreadsheet. - * @param {number} Pass the column index. - * @returns {number} - */ - getColWidth(colIdx: number): number; - - /** This method is used to get the row height of the specified row index in the Spreadsheet. - * @param {number} Pass the row index which you want to find its height. - * @returns {number} - */ - getRowHeight(rowIdx: number): number; - - /** This method is used to set the column width of the specified column index in the Spreadsheet. - * @param {number} Pass the column index. - * @param {number} Pass the width value that you want to set. - * @returns {void} - */ - setColWidth(colIdx: number, size: number): void; - - /** This method is used to set the row height of the specified row index in the Spreadsheet. - * @param {number} Pass the row index. - * @param {number} Pass the height value that you want to set. - * @returns {void} - */ - setRowHeight(rowIdx: number, size: number): void; -} - -export interface XLRibbon { - - /** This method is used to add a new item in the backstage. - * @param {any} Specifies the item to be added in the backstage. - * @param {number} pass the index of the item to be added in the backstage. - * @returns {void} - */ - addBackStageItem(pageItem: any, index: number): void; - - /** This method is used to dynamically add the contextual tabs in the ribbon. - * @param {any} Specifies the contextual tab set object. - * @param {number} pass the index of the contextual tab. - * @returns {void} - */ - addContextualTabs(contextualTabSet: any, index: number): void; - - /** This method is used to dynamically add the menu item in the file menu. - * @param {Array} Specifies the item to be added - * @param {number} pass the index of the menu item. - * @returns {void} - */ - addMenuItem(item: any[], index: number): void; - - /** This method is used to add a new name in the Spreadsheet name manager. - * @param {string} Pass the name that you want to define in name manager. - * @param {string} Pass the cell reference. - * @param {string} Optional. Pass comment, if you want. - * @param {number} Optional. Pass the sheet index. - * @returns {void} - */ - addNamedRange(name: string, refersTo: string, comment: string, sheetIdx: number): void; - - /** This method is used to dynamically add the tab in the ribbon. - * @param {Array} Specifies the text to be displayed in the tab. - * @param {number} pass the groups to be displayed in the ribbon tab. - * @param {number} pass the index of the tab. - * @returns {void} - */ - addTab(tabText: any[], ribbonGroups: number, index: number): void; - - /** This method is used to dynamically add the tab group in the ribbon. - * @param {number} Specifies the ribbon tab index. - * @param {any} pass the groups to be displayed in the ribbon tab. - * @param {number} pass the index of the ribbon group. - * @returns {void} - */ - addTabGroup(tabIndex: number, tabGroup: any, groupIndex: number): void; - - /** This method is used to insert the few type (SUM, MAX, MIN, AVG, COUNT) of formulas in the selected range of cells in the Spreadsheet. - * @param {string} To pass the type("SUM","MAX","MIN","AVG","COUNT"). - * @param {string|Array} If range is specified, it will apply auto sum for the specified range else it will use the current selected range. - * @returns {void} - */ - autoSum(type: string, range: string|any[]): void; - - /** This method is used to hide the file menu in the ribbon tab. - * @returns {void} - */ - hideMenu(): void; - - /** This method is used to remove the item from the backstage in the spreadsheet. - * @param {number} Specifies the index of the item to be removed from backstage. - * @returns {void} - */ - removeBackStageItem(index: number): void; - - /** This method is used to remove the menu item form file menu in spreadsheet. - * @param {number} Specifies the index of the item to be removed from the file menu. - * @returns {void} - */ - removeMenuItem(index: number): void; - - /** This method is used to delete the defined name in the Spreadsheet name manager. - * @param {string} Pass the defined name that you want to remove from name manager. - * @returns {void} - */ - removeNamedRange(name: string): void; - - /** This method is used to remove the tab form ribbon in the spreadsheet. - * @param {number} Specifies the index of the tab to be removed from the ribbon. - * @param {boolean} pass the boolean value to remove the tab from ribbon - * @returns {void} - */ - removeTab(index: number, isRemoveMenu: boolean): void; - - /** This method is used to remove the tab group form ribbon in the spreadsheet. - * @param {number} Specifies the index of the tab group to be removed from the ribbon. - * @param {string} Specifies the text to be displayed in the tab group - * @returns {void} - */ - removeTabGroup(tabIndex: number, groupText: string): void; - - /** This method is used to show the file menu in the ribbon tab. - * @returns {void} - */ - showMenu(): void; - - /** This method is used to update the menu item in the file menu. - * @param {any} Specifies the menu item to be updated in the ribbon - * @param {number} pass the index of the item to be updated - * @returns {void} - */ - updateMenuItem(item: any, index: number): void; - - /** This method is used to update the ribbon icons in the Spreadsheet. - * @returns {void} - */ - updateRibbonIcons(): void; -} - -export interface XLSearch { - - /** This method is used to find and replace all data by workbook in the Spreadsheet. - * @param {string} Pass the search data. - * @param {string} Pass the replace data. - * @param {boolean} Pass {{'`true`' | markdownify}}, if you want to match with case-sensitive. - * @param {boolean} Pass {{'`true`' | markdownify}}, if you want to match with entire cell contents. - * @returns {void} - */ - replaceAllByBook(findData: string, replaceData: string, isCSen: boolean, isEMatch: boolean): void; - - /** This method is used to find and replace all data by sheet in Spreadsheet. - * @param {string} Pass the search data. - * @param {string} Pass the replace data. - * @param {boolean} Pass {{'`true`' | markdownify}}, if you want to match with case-sensitive. - * @param {boolean} Pass {{'`true`' | markdownify}}, if you want to match with entire cell contents. - * @returns {void} - */ - replaceAllBySheet(findData: string, replaceData: string, isCSen: boolean, isEMatch: boolean): void; -} - -export interface XLSelection { - - /** This method is used to clear the selection of the active sheet in the Spreadsheet. - * @returns {void} - */ - clearAll(): void; - - /** This method is used to get the selected cells element based on specified sheet index in the Spreadsheet. - * @param {number} Pass the sheet index to get the cells element. - * @returns {HTMLElement} - */ - getSelectedCells(sheetIdx: number): HTMLElement; - - /** This method is used to refresh the selection in the Spreadsheet. - * @param {Array|string} Optional. Pass range to refresh selection. - * @returns {void} - */ - refreshSelection(range: any[]|string): void; - - /** This method is used to select a single column in the Spreadsheet. - * @param {number} Pass the column index value. - * @returns {void} - */ - selectColumn(colIdx: number): void; - - /** This method is used to select entire columns in a specified range (start index and end index) in the Spreadsheet. - * @param {number} Pass the column start index. - * @param {number} Pass the column end index. - * @returns {void} - */ - selectColumns(startIdx: number, endIdx: number): void; - - /** This method is used to select the specified range of cells in the Spreadsheet. - * @param {string} Pass range which want to select. - * @returns {void} - */ - selectRange(range: string): void; - - /** This method is used to select a single row in the Spreadsheet. - * @param {number} Pass the row index value. - * @returns {void} - */ - selectRow(rowIdx: number): void; - - /** This method is used to select entire rows in a specified range (start index and end index) in the Spreadsheet. - * @param {number} Pass the start row index. - * @param {number} Pass the end row index. - * @returns {void} - */ - selectRows(startIdx: number, endIdx: number): void; - - /** This method is used to select all cells in active sheet. - * @returns {void} - */ - selectSheet(): void; -} - -export interface XLShape { - - /** This method is used to set a picture in the Spreadsheet. - * @param {string} Pass the range of the cell. - * @param {string} Pass the path of the specified image. - * @param {number} Optional. Pass the width of the image that you want to set. - * @param {number} Optional. Pass the height of the image that you want to set. - * @param {number} Optional. Pass the top of the image that you want to set. - * @param {number} Optional. Pass the left of the image that you want to set. - * @returns {string} - */ - setPicture(range: string, url: string, width: number, height: number, top: number, left: number): string; -} - -export interface XLSort { - - /** This method is used to sort a particular range of cells based on its cell or font color in the Spreadsheet. - * @param {string} Pass {{'`PutCellColor`' | markdownify}} to sort by cell color or {{'`PutFontColor`' | markdownify}} for sort by font color. - * @param {any} Pass the HEX color code to sort. - * @param {string} Pass the range - * @returns {void} - */ - sortByColor(operation: string, color: any, range: string): void; - - /** This method is used to sort a particular range of cells based on its values in the Spreadsheet. - * @param {Array|string} Pass the range to sort. - * @param {string} Pass the column name. - * @param {any} Pass the direction to sort (ascending or descending). - * @returns {boolean} - */ - sortByRange(range: any[]|string, columnName: string, direction: any): boolean; -} - -export interface XLValidate { - - /** This method is used to apply data validation rules in a selected range of cells based on the defined condition in the Spreadsheet. - * @param {string|Array} If range is specified, it will apply rules for the specified range else it will use the current selected range. - * @param {Array} Pass the validation condition, value1 and value2. - * @param {string} Pass the data type. - * @param {boolean} Pass {{'`true`' | markdownify}} if you ignore blank values. - * @param {boolean} Pass {{'`true`' | markdownify}} if you want to show an error alert. - * @returns {void} - */ - applyDVRules(range: string|any[], values: any[], type: string, required: boolean, showErrorAlert: boolean): void; - - /** This method is used to clear the applied validation rules in a specified range of cells in the Spreadsheet. - * @param {string|Array} Optional. If range is specified, it will clear rules for the specified range else it will use the current selected range. - * @returns {void} - */ - clearDV(range: string|any[]): void; - - /** This method is used to highlight invalid data in a specified range of cells in the Spreadsheet. - * @param {string|Array} Optional. If range is specified, it will clear rules for the specified range else it will use the current selected range. - * @returns {void} - */ - highlightInvalidData(range: string|any[]): void; -} - -export interface Model { - - /** Gets or sets an active sheet index in the Spreadsheet. By defining this value, you can specify which sheet should be active in workbook. - * @Default {1} - */ - activeSheetIndex?: number; - - /** Gets or sets a value that indicates whether to enable or disable auto rendering of cell type in the Spreadsheet. - * @Default {false} - */ - allowAutoCellType?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable auto fill feature in the Spreadsheet. - * @Default {true} - */ - allowAutoFill?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable auto sum feature in the Spreadsheet. - * @Default {true} - */ - allowAutoSum?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable cell format feature in the Spreadsheet. By enabling this, you can customize styles and number formats. - * @Default {true} - */ - allowCellFormatting?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable cell type feature in the Spreadsheet. - * @Default {false} - */ - allowCellType?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable chart feature in the Spreadsheet. By enabling this feature, you can create and customize charts in Spreadsheet. - * @Default {true} - */ - allowCharts?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable clear feature in the Spreadsheet. - * @Default {true} - */ - allowClear?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable clipboard feature in the Spreadsheet. By enabling this feature, you can perform cut/copy and paste operations in Spreadsheet. - * @Default {true} - */ - allowClipboard?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable comment feature in the Spreadsheet. By enabling this, you can add/delete/modify comments in Spreadsheet. - * @Default {true} - */ - allowComments?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable Conditional Format feature in the Spreadsheet. By enabling this, you can apply formatting to the selected range - * of cells based on the provided conditions (Greater than, Less than, Equal, Between, Contains, etc.). - * @Default {true} - */ - allowConditionalFormats?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable data validation feature in the Spreadsheet. - * @Default {true} - */ - allowDataValidation?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable the delete action in the Spreadsheet. By enabling this feature, you can delete existing rows, columns, cells and sheet. - * @Default {true} - */ - allowDelete?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable drag and drop feature in the Spreadsheet. - * @Default {true} - */ - allowDragAndDrop?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable the edit action in the Spreadsheet. - * @Default {true} - */ - allowEditing?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable filtering feature in the Spreadsheet. Filtering can be used to limit the data displayed using required criteria. - * @Default {true} - */ - allowFiltering?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable table feature in the Spreadsheet. By enabling this, you can render table in selected range. - * @Default {true} - */ - allowFormatAsTable?: boolean; - - /** Get or sets a value that indicates whether to enable or disable format painter feature in the Spreadsheet. By enabling this feature, you can copy - * the format from the selected range and apply it to another range. - * @Default {true} - */ - allowFormatPainter?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable formula bar in the Spreadsheet. - * @Default {true} - */ - allowFormulaBar?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable freeze pane support in Spreadsheet. After enabling this feature, - * you can use freeze top row, freeze first column and freeze panes options. - * @Default {false} - */ - allowFreezing?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable hyperlink feature in the Spreadsheet. By enabling this feature, you can add hyperlink which is used to - * easily navigate to the cell reference from one sheet to another or a web page. - * @Default {true} - */ - allowHyperlink?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable import feature in the Spreadsheet. By enabling this feature, you can open existing Spreadsheet documents. - * @Default {true} - */ - allowImport?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable the insert action in the Spreadsheet. By enabling this feature, you can insert new rows, columns, cells and sheet. - * @Default {true} - */ - allowInsert?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable keyboard navigation feature in the Spreadsheet. - * @Default {true} - */ - allowKeyboardNavigation?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable lock cell feature in the Spreadsheet. - * @Default {true} - */ - allowLockCell?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable merge feature in the Spreadsheet. - * @Default {true} - */ - allowMerging?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable overflow feature in the Spreadsheet. - * @Default {true} - */ - allowOverflow?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable resizing feature in the Spreadsheet. By enabling this feature, you can change the column width and - * row height by dragging its header boundaries. - * @Default {true} - */ - allowResizing?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable find and replace feature in the Spreadsheet. By enabling this, you can easily find and replace - * a specific value in the sheet or workbook. By using goto behavior, you can select and highlight all cells that contains specific data or data types. - * @Default {true} - */ - allowSearching?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable selection in the Spreadsheet. By enabling this feature, selected items will be highlighted. - * @Default {true} - */ - allowSelection?: boolean; - - /** Gets or sets a value that indicates whether to enable the sorting feature in the Spreadsheet. - * @Default {true} - */ - allowSorting?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable undo and redo feature in the Spreadsheet. - * @Default {true} - */ - allowUndoRedo?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable wrap text feature in the Spreadsheet. By enabling this, cell content can wrap to the next line, - * if the cell content exceeds the boundary of the cell. - * @Default {true} - */ - allowWrap?: boolean; - - /** Gets or sets a value that indicates to define the width of the activation panel in Spreadsheet. - * @Default {300} - */ - apWidth?: number; - - /** Gets or sets an object that indicates to customize the auto fill behavior in the Spreadsheet. - */ - autoFillSettings?: AutoFillSettings; - - /** Gets or sets an object that indicates to customize the chart behavior in the Spreadsheet. - */ - chartSettings?: ChartSettings; - - /** Gets or sets a value that defines the number of columns displayed in the sheet. - * @Default {21} - */ - columnCount?: number; - - /** Gets or sets a value that indicates to define the common width for each column in the Spreadsheet. - * @Default {64} - */ - columnWidth?: number; - - /** Gets or sets a value to add root CSS class for customizing Spreadsheet skins. - */ - cssClass?: string; - - /** Gets or sets a value that indicates custom formulas in Spreadsheet. - * @Default {[]} - */ - customFormulas?: any[]; - - /** Gets or sets a value that indicates whether to enable or disable context menu in the Spreadsheet. - * @Default {true} - */ - enableContextMenu?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable pivot table in the Spreadsheet. - * @Default {false} - */ - enablePivotTable?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable touch support in the Spreadsheet. - * @Default {true} - */ - enableTouch?: boolean; - - /** Gets or sets an object that indicates to customize the exporting behavior in Spreadsheet. - */ - exportSettings?: ExportSettings; - - /** Gets or sets an object that indicates to customize the format behavior in the Spreadsheet. - */ - formatSettings?: FormatSettings; - - /** Gets or sets an object that indicates to customize the import behavior in the Spreadsheet. - */ - importSettings?: ImportSettings; - - /** Gets or sets a value that indicates whether to enable or disable readonly support in the Spreadsheet. - * @Default {false} - */ - isReadOnly?: boolean; - - /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data (i.e.) - * in a language and culture specific to a particular country or region. - * @Default {en-US} - */ - locale?: string; - - /** Gets or sets an object that indicates to customize the picture behavior in the Spreadsheet. - */ - pictureSettings?: PictureSettings; - - /** Gets or sets an object that indicates to customize the print option in Spreadsheet. - */ - printSettings?: PrintSettings; - - /** Gets or sets an object that indicates to customize the ribbon settings in Spreadsheet. - */ - ribbonSettings?: RibbonSettings; - - /** Gets or sets a value that indicates whether to define the number of rows to be displayed in the sheet. - * @Default {20} - */ - rowCount?: number; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the Radialslider model + */ + model?: any; + + /** returns the name of the event + */ + type?: string; + } + + export interface MouseoverEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the Radialslider model + */ + model?: any; + + /** returns the value selected + */ + selectedValue?: number; + + /** returns the name of the event + */ + type?: string; + + /** returns the current value selected in Radial slider + */ + value?: number; + } + + export interface SlideEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the Radialslider model + */ + model?: any; + + /** returns the value selected in Radial slider + */ + selectedValue?: number; + + /** returns the name of the event + */ + type?: string; + + /** returns the currently selected value + */ + value?: number; + } + + export interface StartEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the Radialslider model + */ + model?: any; + + /** returns the name of the event + */ + type?: string; + + /** returns the current value selected in Radial slider + */ + value?: number; + } + + export interface StopEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the Radialslider model + */ + model?: any; + + /** returns the name of the event + */ + type?: string; + + /** returns the current value selected in Radial slider + */ + value?: number; + } + } + + class Spreadsheet extends ej.Widget { + static fn: Spreadsheet; + constructor(element: JQuery | Element, options?: Spreadsheet.Model); + static Locale: any; + model: Spreadsheet.Model; + defaults: Spreadsheet.Model; + + /** This method is used to add custom formulas in Spreadsheet. + * @param {string} Pass the name of the formula. + * @param {string} Pass the name of the function. + * @returns {void} + */ + addCustomFormula(formulaName: string, functionName: string): void; + + /** This method is used to add a new sheet in the last position of the sheet container. + * @returns {void} + */ + addNewSheet(): void; + + /** It is used to clear all the data and format in the specified range of cells in Spreadsheet. + * @param {string|Array} Optional. If range is specified, then it will clear all content in the specified range else it will use the current selected range. + * @returns {void} + */ + clearAll(range?: string | any[]): void; + + /** This property is used to clear all the formats applied in the specified range in Spreadsheet. + * @param {string|Array} Optional. If range is specified, then it will clear all format in the specified range else it will use the current selected range. + * @returns {void} + */ + clearAllFormat(range?: string | any[]): void; + + /** Used to clear the applied border in the specified range in Spreadsheet. + * @param {string|Array} Optional. If range is specified, then it will clear border in the specified range else it will use the current selected range. + * @returns {void} + */ + clearBorder(range?: string | any[]): void; + + /** This property is used to clear the contents in the specified range in Spreadsheet. + * @param {string|Array} Optional. If the range is specified, then it will clear the content in the specified range else it will use the current selected range. + * @returns {void} + */ + clearContents(range?: string | any[]): void; + + /** This method is used to remove only the data in the range denoted by the specified range name. + * @param {string} Pass the defined rangeSettings property name. + * @returns {void} + */ + clearRange(rangeName: string): void; + + /** It is used to remove data in the specified range of cells based on the defined property. + * @param {Array|string} Optional. If range is specified, it will clear data for the specified range else it will use the current selected range. + * @param {string} Optional. If property is specified, it will remove the specified property in the range else it will remove default properties + * @param {any} Optional. + * @param {boolean} Optional. pass {{'`true`' | markdownify}}, if you want to skip the hidden rows + * @param {any} Optional. Pass the status to perform undo and redo operation. + * @param {any} Optional. It specifies whether to skip element processing or not. + * @returns {void} + */ + clearRangeData(range?: any[] | string, property?: string, cells?: any, skipHiddenRow?: boolean, status?: any, skipCell?: any): void; + + /** This method is used to clear undo and redo collections in the Spreadsheet. + * @returns {void} + */ + clearUndoRedo(): void; + + /** This method is used to copy or move the sheets in Spreadsheet. + * @param {number} Pass the sheet index that you want to copy or move. + * @param {number} Pass the position index where you want to copy or move. + * @param {boolean} Pass {{'`true`' | markdownify}},If you want to copy sheet or else it will move sheet. + * @returns {void} + */ + copySheet(fromIdx: number, toIdx: number, isCopySheet: boolean): void; + + /** This method is used to delete the entire column which is selected. + * @param {number} Pass the start column index. + * @param {number} Pass the end column index. + * @returns {void} + */ + deleteEntireColumn(startCol: number, endCol: number): void; + + /** This method is used to delete the entire row which is selected. + * @param {number} Pass the start row index. + * @param {number} Pass the end row index. + * @returns {void} + */ + deleteEntireRow(startRow: number, endRow: number): void; + + /** This method is used to delete a particular sheet in the Spreadsheet. + * @param {number} Pass the sheet index to perform delete action. + * @returns {void} + */ + deleteSheet(idx: number): void; + + /** This method is used to delete the selected cells and shift the remaining cells to left. + * @param {any} Row index and column index of the starting cell. + * @param {any} Row index and column index of the ending cell. + * @returns {void} + */ + deleteShiftLeft(startCell: any, endCell: any): void; + + /** This method is used to delete the selected cells and shift the remaining cells up. + * @param {any} Row index and column index of the start cell. + * @param {any} Row index and column index of the end cell. + * @returns {void} + */ + deleteShiftUp(startCell: any, endCell: any): void; + + /** This method is used to edit data in the specified range of cells based on its corresponding rangeSettings. + * @param {string} Pass the defined rangeSettings property name. + * @param {Function} Pass the function that you want to perform range edit. + * @returns {void} + */ + editRange(rangeName: string, fn: any): void; + + /** This method is used to get the activation panel in the Spreadsheet. + * @returns {HTMLElement} + */ + getActivationPanel(): HTMLElement; + + /** This method is used to get the active cell object in Spreadsheet. It will returns object which contains rowIndex and colIndex of the active cell. + * @param {number} Optional. If sheetIdx is specified, it will return the active cell object in specified sheet index else it will use the current sheet index + * @returns {any} + */ + getActiveCell(sheetIdx?: number): any; + + /** This method is used to get the active cell element based on the given sheet index in the Spreadsheet. + * @param {number} Optional. If sheetIndex is specified, it will return the active cell element in specified sheet index else it will use the current active sheet index. + * @returns {HTMLElement} + */ + getActiveCellElem(sheetIdx?: number): HTMLElement; + + /** This method is used to get the current active sheet index in Spreadsheet. + * @returns {number} + */ + getActiveSheetIndex(): number; + + /** This method is used to get the auto fill element in Spreadsheet. + * @returns {HTMLElement} + */ + getAutoFillElem(): HTMLElement; + + /** This method is used to get the cell element based on specified row and column index in the Spreadsheet. + * @param {number} Pass the row index. + * @param {number} Pass the column index. + * @param {number} Optional. Pass the sheet index that you want to get cell. + * @returns {HTMLElement} + */ + getCell(rowIdx: number, colIdx: number, sheetIdx?: number): HTMLElement; + + /** This method is used to get the data settings in the Spreadsheet. + * @param {number} Pass the sheet index. + * @returns {number} + */ + getDataSettings(sheetIdx: number): number; + + /** This method is used to get the frozen columns index in the Spreadsheet. + * @param {number} Pass the sheet index. + * @returns {number} + */ + getFrozenColumns(sheetIdx: number): number; + + /** This method is used to get the frozen row index in Spreadsheet. + * @param {number} Pass the sheet index. + * @returns {number} + */ + getFrozenRows(sheetIdx: number): number; + + /** This method is used to get the hyperlink data as object from the specified cell in Spreadsheet. + * @param {HTMLElement} Pass the DOM element to get hyperlink + * @returns {any} + */ + getHyperlink(cell: HTMLElement): any; + + /** This method is used to get all cell elements in the specified range. + * @param {string} Pass the range that you want to get the cells. + * @param {number} Pass the index of the sheet. + * @param {boolean} Optional. Pass {{'`true`' | markdownify}}, if you want to skip the hidden rows. + * @returns {HTMLElement} + */ + getRange(range: string, sheetIdx: number, skipHiddenRow?: boolean): HTMLElement; + + /** This method is used to get the data in specified range in Spreadsheet. + * @param {any} Optional. Pass the range, property, sheetIdx, valueOnly in options. + * @returns {Array} + */ + getRangeData(options?: any): any[]; + + /** This method is used to get the range indices array based on the specified alpha range in Spreadsheet. + * @param {string} Pass the alpha range that you want to get range indices. + * @returns {Array} + */ + getRangeIndices(range: string): any[]; + + /** This method is used to get the sheet details based on the given sheet index in Spreadsheet. + * @param {number} Pass the sheet index to get the sheet object. + * @returns {any} + */ + getSheet(sheetIdx: number): any; + + /** This method is used to get the sheet content div element of Spreadsheet. + * @param {number} Pass the sheet index to get the sheet content. + * @returns {HTMLElement} + */ + getSheetElement(sheetIdx: number): HTMLElement; + + /** This method is used to get all the sheets in workbook. + * @returns {Array} + */ + getSheets(): any[]; + + /** This method is used to send a paging request to the specified sheet Index in the Spreadsheet. + * @param {number} Pass the sheet index to perform paging at specified sheet index + * @param {boolean} Pass {{'`true`' | markdownify}} to create a new sheet. If the specified sheet index is already exist, it navigate to that sheet else it create a new sheet. + * @returns {void} + */ + gotoPage(sheetIdx: number, newSheet: boolean): void; + + /** This method is used to hide the entire columns from the specified range (startCol, endCol) in Spreadsheet. + * @param {number} Index of the start column. + * @param {number} Optional. Index of the end column. + * @returns {void} + */ + hideColumn(startCol: number, endCol: number): void; + + /** This method is used to hide the formula bar in Spreadsheet. + * @returns {void} + */ + hideFormulaBar(): void; + + /** This method is used to hide the rows, based on the specified row index in Spreadsheet. + * @param {number} Index of the start row. + * @param {number} Optional. Index of the end row. + * @returns {void} + */ + hideRow(startRow: number, endRow: number): void; + + /** This method is used to hide the sheet based on the specified sheetIndex or sheet name in the Spreadsheet. + * @param {string|number} Pass the sheet name or index that you want to hide. + * @returns {void} + */ + hideSheet(sheetIdx: string | number): void; + + /** This method is used to hide the displayed waiting pop-up in Spreadsheet. + * @returns {void} + */ + hideWaitingPopUp(): void; + + /** This method is used to insert a column before the active cell's column in the Spreadsheet. + * @param {number} Pass start column. + * @param {number} Pass end column. + * @returns {void} + */ + insertEntireColumn(startCol: number, endCol: number): void; + + /** This method is used to insert a row before the active cell's row in the Spreadsheet. + * @param {number} Pass start row. + * @param {number} Pass end row. + * @returns {void} + */ + insertEntireRow(startRow: number, endRow: number): void; + + /** This method is used to insert a new sheet to the left of the current active sheet. + * @returns {void} + */ + insertSheet(): void; + + /** This method is used to insert cells in the selected or specified range and shift remaining cells to bottom. + * @param {any} Row index and column index of the start cell. + * @param {any} Row index and column index of the end cell. + * @returns {void} + */ + insertShiftBottom(startCell: any, endCell: any): void; + + /** This method is used to insert cells in the selected or specified range and shift remaining cells to right. + * @param {any} Row index and column index of the start cell. + * @param {any} Row index and column index of the end cell. + * @returns {void} + */ + insertShiftRight(startCell: any, endCell: any): void; + + /** This method is used to import excel file manually by using form data. + * @param {any} Pass the form data object to import files manually. + * @returns {void} + */ + import(importRequest: any): void; + + /** This method is used to load JSON data in Spreadsheet. + * @param {any} Pass the response that you want to load. + * @returns {void} + */ + loadFromJSON(response: any): void; + + /** This method is used to lock/unlock the range of cells in active sheet. Lock cells are activated only after the sheet is protected. Once the sheet is protected it is unable to lock/unlock cells. + * @param {string|Array} Pass the alpha range cells or array range of cells. + * @param {string} Optional. By default is {{'`true`' | markdownify}}. If it is {{'`false`' | markdownify}} locked cells are unlocked. + * @returns {void} + */ + lockCells(range: string | any[], isLocked?: string): void; + + /** This method is used to merge cells by across in the Spreadsheet. + * @param {string} Optional. To pass the cell range or selected cells are process. + * @param {boolean} Optional. If pass {{'`true`' | markdownify}} it does not show alert. + * @returns {void} + */ + mergeAcrossCells(range?: string, alertStatus?: boolean): void; + + /** This method is used to merge the selected cells in the Spreadsheet. + * @param {string|Array} Optional. To pass the cell range or selected cells are process. + * @param {boolean} Optional. If pass {{'`true`' | markdownify}} it does not show alert. + * @returns {void} + */ + mergeCells(range?: string | any[], alertStatus?: boolean): void; + + /** This method is used to select a cell or range in the Spreadsheet. + * @param {any} Pass the start cell to perform selection. + * @param {any} Pass the end cell to perform selection. + * @returns {void} + */ + performSelection(startCell: any, endCell: any): void; + + /** This method is used to protect or unprotect active sheet. + * @param {boolean} Optional. By default is {{'`true`' | markdownify}}. If it is {{'`false`' | markdownify}} active sheet is unprotected. + * @returns {void} + */ + protectSheet(isProtected?: boolean): void; + + /** This method is used to refresh the content in Spreadsheet. + * @param {number} Pass the index of the sheet. + * @returns {void} + */ + refreshContent(sheetIdx: number): void; + + /** This method is used to refresh the Spreadsheet. + * @returns {void} + */ + refreshSpreadsheet(): void; + + /** This method is used to remove custom formulae in Spreadsheet. + * @param {string} Pass the name of the formula. + * @param {string} Pass the name of the function. + * @returns {void} + */ + removeCustomFormula(formulaName: string, functionName: string): void; + + /** This method is used to remove the hyperlink from selected cells of current sheet. + * @param {string} Hyperlink remove from the specified range. + * @param {boolean} Optional. If it is {{'`true`' | markdownify}}, It will clear link only not format. + * @param {boolean} Optional. Pass the status to perform undo and redo operations. + * @param {any} Optional. Pass the cells that you want to remove hyperlink. + * @param {boolean} Optional. Pass {{'`true`' | markdownify}}, if you want to skip the hidden rows. + * @returns {void} + */ + removeHyperlink(range: string, isClearHLink?: boolean, status?: boolean, cells?: any, skipHiddenRow?: boolean): void; + + /** This method is used to remove the range data and its defined rangeSettings property based on the specified range name. + * @param {string} Pass the defined rangeSetting property name. + * @returns {void} + */ + removeRange(rangeName: string): void; + + /** This method is used to remove the readonly option for the specified range. + * @param {string|Array} Pass the range. + * @returns {void} + */ + removeReadOnly(range?: string | any[]): void; + + /** This method is used to save JSON data in Spreadsheet. + * @returns {any} + */ + saveAsJSON(): any; + + /** This method is used to save batch changes in Spreadsheet. + * @param {number} Pass the sheet index for Spreadsheet. + * @returns {void} + */ + saveBatchChanges(sheetIdx: number): void; + + /** This method is used to set the active cell in the Spreadsheet. + * @param {number} Pass the row index. + * @param {number} Pass the column index. + * @param {number} Pass the index of the sheet. + * @returns {void} + */ + setActiveCell(rowIdx: number, colIdx: number, sheetIdx: number): void; + + /** This method is used to set active sheet index for the Spreadsheet. + * @param {number} Pass the active sheet index for Spreadsheet. + * @returns {void} + */ + setActiveSheetIndex(sheetIdx: number): void; + + /** This method is used to set border for the specified range of cells in the Spreadsheet. + * @param {any} Pass the border properties that you want to set. + * @param {string} Optional. If range is specified, it will set border for the specified range else it will use the selected range. + * @returns {void} + */ + setBorder(property: any, range?: string): void; + + /** This method is used to set the height for the rows in the Spreadsheet. + * @param {Array|any} Pass the row index and height of the rows. + * @returns {void} + */ + setHeightToRows(heightColl: any[] | any): void; + + /** This method is used to set the hyperlink in selected cells of the current sheet. + * @param {string|Array} If range is specified, it will set the hyperlink in range of the cells. + * @param {any} Pass cellAddress or webAddress + * @param {number} If we pass cellAddress then which sheet to be navigate in the applied link. + * @returns {void} + */ + setHyperlink(range: string | any[], link: any, sheetIdx: number): void; + + /** This method is used to set the readonly option for the specified range. + * @param {string|Array} Pass the range. + * @returns {void} + */ + setReadOnly(range?: string | any[]): void; + + /** This method is used to set the focus to the Spreadsheet. + * @returns {void} + */ + setSheetFocus(): void; + + /** This method is used to set the width for the columns in the Spreadsheet. + * @param {Array|any} Pass the column index and width of the columns. + * @returns {void} + */ + setWidthToColumns(widthColl: any[] | any): void; + + /** This method is used to rename the active sheet. + * @param {string} Pass the sheet name that you want to change the current active sheet name. + * @returns {void} + */ + sheetRename(sheetName: string): void; + + /** This method is used to display the activationPanel for the specified range name. + * @param {string} Pass the range name that you want to display the activation panel. + * @returns {void} + */ + showActivationPanel(rangeName: string): void; + + /** This method is used to show the hidden columns within the specified range in the Spreadsheet. + * @param {number} Index of the start column. + * @param {number} Optional. Index of the end column. + * @returns {void} + */ + showColumn(startColIdx: number, endColIdx: number): void; + + /** This method is used to show the formula bar in Spreadsheet. + * @returns {void} + */ + showFormulaBar(): void; + + /** This method is used to show/hide gridlines in active sheet in the Spreadsheet. + * @param {boolean} Pass {{'`true`' | markdownify}} to show the gridlines + * @returns {void} + */ + showGridlines(status: boolean): void; + + /** This method is used to show/hide the headers in active sheet in the Spreadsheet. + * @param {boolean} Pass {{'`true`' | markdownify}} to show the sheet headers. + * @returns {void} + */ + showHeadings(startRow: boolean): void; + + /** This method is used to show/hide pager in the Spreadsheet. + * @param {boolean} Pass {{'`true`' | markdownify}} to show pager. + * @returns {void} + */ + showPager(status: boolean): void; + + /** This method is used to show the hidden rows in the specified range in the Spreadsheet. + * @param {number} Index of the start row. + * @param {number} Optional. Index of the end row. + * @returns {void} + */ + showRow(startRow: number, endRow: number): void; + + /** This method is used to show waiting pop-up in Spreadsheet. + * @returns {void} + */ + showWaitingPopUp(): void; + + /** This method is used to unhide the sheet based on specified sheet name or sheet index. + * @param {string|number} Pass the sheet name or index that you want to unhide. + * @returns {void} + */ + unhideSheet(sheetInfo: string | number): void; + + /** This method is used to unmerge the selected range of cells in the Spreadsheet. + * @param {string} Optional. If the range is specified, then it will un merge the specified range else it will use the current selected range. + * @returns {void} + */ + unmergeCells(range?: string): void; + + /** This method is used to unwrap the selected range of cells in the Spreadsheet. + * @param {Array|string} Optional. If the range is specified, then it will update unwrap in the specified range else it will use the current selected range. + * @returns {void} + */ + unWrapText(range?: any[] | string): void; + + /** This method is used to update the data for the specified range of cells in the Spreadsheet. + * @param {any} Pass the cells data that you want to update. + * @param {Array|string} Optional. If range is specified, it will update data for the specified range else it will use the current selected range. + * @returns {void} + */ + updateData(data: any, range?: any[] | string): void; + + /** This method is used to update the formula bar in the Spreadsheet. + * @returns {void} + */ + updateFormulaBar(): void; + + /** This method is used to update the range of cells based on the specified settings which we want to update in the Spreadsheet. + * @param {number} Pass the sheet index that you want to update. + * @param {any} Pass the dataSource, startCell and showHeader values as settings. + * @returns {void} + */ + updateRange(sheetIdx: number, settings: any): void; + + /** This method is used to update the details for custom undo and redo operations. + * @param {any} Pass the details to update undo and redo collection + * @returns {void} + */ + updateUndoRedoCollection(details: any): void; + + /** This method is used to update the unique data for the specified range of cells in Spreadsheet. + * @param {any} Pass the data that you want to update in the particular range + * @param {Array|string} Optional. If range is specified, it will update data for the specified range else it will use the current selected range. + * @param {any} Optional. It specifies whether to skip element processing or not. + * @returns {void} + */ + updateUniqueData(data: any, range?: any[] | string, skipCell?: any): void; + + /** This method is used to wrap the selected range of cells in the Spreadsheet. + * @param {Array|string} Optional. If the range is specified, then it will update wrap in the specified range else it will use the current selected range. + * @returns {void} + */ + wrapText(range?: any[] | string): void; + + XLCellType: Spreadsheet.XLCellType; + + XLCFormat: Spreadsheet.XLCFormat; + + XLChart: Spreadsheet.XLChart; + + XLClipboard: Spreadsheet.XLClipboard; + + XLComment: Spreadsheet.XLComment; + + XLCMenu: Spreadsheet.XLCMenu; + + XLDragDrop: Spreadsheet.XLDragDrop; + + XLDragFill: Spreadsheet.XLDragFill; + + XLEdit: Spreadsheet.XLEdit; + + XLExport: Spreadsheet.XLExport; + + /** This method is used to get the export properties in the Spreadsheet. + * @returns {any} + */ + getExportProps(): any; + + XLFilter: Spreadsheet.XLFilter; + + XLFormat: Spreadsheet.XLFormat; + + XLFreeze: Spreadsheet.XLFreeze; + + /** This method is used to unfreeze the frozen rows and columns in the Spreadsheet. + * @returns {void} + */ + unfreezePanes(): void; + + XLPivot: Spreadsheet.XLPivot; + + XLPrint: Spreadsheet.XLPrint; + + XLResize: Spreadsheet.XLResize; + + XLRibbon: Spreadsheet.XLRibbon; + + XLSearch: Spreadsheet.XLSearch; + + XLSelection: Spreadsheet.XLSelection; + + XLShape: Spreadsheet.XLShape; + + XLSort: Spreadsheet.XLSort; + + XLValidate: Spreadsheet.XLValidate; + } + export namespace Spreadsheet { + + export interface XLCellType { + + /** This method is used to set a cell type from the specified range of cells in the spreadsheet. + * @param {string} Pass the range where you want apply cell type. + * @param {any} Pass type of cell type and its settings. + * @param {number} Optional. Pass sheet index. + * @returns {void} + */ + addCellTypes(range: string, settings: any, sheetIdx: number): void; + + /** This method is used to remove cell type from the specified range of cells in the Spreadsheet. + * @param {string|Array} Pass the range where you want remove cell type. + * @param {number} Optional. Pass sheet index. + * @returns {void} + */ + removeCellTypes(range: string | any[], sheetIdx: number): void; + } + + export interface XLCFormat { + + /** This method is used to clear the applied conditional formatting rules in the Spreadsheet. + * @param {Array|string} Optional. If range is specified, it will clear rules for the specified range else it will use the current selected range. + * @returns {void} + */ + clearCF(range: any[] | string): void; + + /** This method is used to get the applied conditional formatting rules as array of objects based on the specified row Index and column Index in the Spreadsheet. + * @param {number} Pass the row index. + * @param {number} Pass the column index. + * @returns {Array} + */ + getCFRule(rowIdx: number, colIdx: number): any[]; + + /** This method is used to set the conditional formatting rule in the Spreadsheet. + * @param {any} Pass the rule to set. + * @returns {void} + */ + setCFRule(rule: any): void; + } + + export interface XLChart { + + /** This method is used to change the theme of the chart in the Spreadsheet. + * @param {string} Pass the chart id. + * @param {ej.datavisualization.Chart.Theme} Pass the chart theme which want to update. + * @returns {void} + */ + changeTheme(chartId: string, theme: ej.datavisualization.Chart.Theme): void; + + /** This method is used to change the type of the chart in the Spreadsheet. + * @param {string} Pass the chart id. + * @param {any} Pass the chart type. + * @returns {void} + */ + changeType(chartId: string, option: any): void; + + /** This method is used to change the data range of the chart in the Spreadsheet. + * @param {string} Pass the chart id. + * @param {string} X axis range of chart data. + * @param {string} Y axis range of chart data. + * @param {string} Legend range of chart data. + * @returns {void} + */ + changeDataRange(chartId: string, xRange: string, yRange: string, lRange: string): void; + + /** This method is used to create a chart for specified range in Spreadsheet. + * @param {string|Array} Optional. If range is specified, it will create chart for the specified range else it will use the current selected range. + * @param {any} Optional. To pass the type of chart and chart name. + * @returns {void} + */ + createChart(range: string | any[], options: any): void; + + /** This method is used to refresh the chart in the Spreadsheet. + * @param {string} To pass the chart Id. + * @param {any} To pass the type of chart and chart name. + * @returns {void} + */ + refreshChart(id: string, options: any): void; + + /** This method is used to resize the chart of specified id in the Spreadsheet. + * @param {string} To pass the chart id. + * @param {number} To pass height value. + * @param {number} To pass the width value. + * @returns {void} + */ + resizeChart(id: string, height: number, width: number): void; + + /** This method is used to update the chart element, such as axes, titles, data labels, grid lines and legends in the Spreadsheet. + * @param {string} Pass the chart id. + * @param {ej.Spreadsheet.ChartProperties} Pass chart element value which you want to update. + * @returns {void} + */ + updateChartElement(chartId: string, value: ej.Spreadsheet.ChartProperties): void; + + /** This method is used switch row to columns and vice versa for chart in the Spreadsheet. So that the data is displayed in the chart the way you want. + * @param {string} Pass the chart id. + * @returns {void} + */ + switchRowColumn(chartId: string): void; + } + + export interface XLClipboard { + + /** This method is used to copy the selected cells in the Spreadsheet. + * @returns {void} + */ + copy(): void; + + /** This method is used to cut the selected cells in the Spreadsheet. + * @returns {void} + */ + cut(): void; + + /** This method is used to paste the cut or copied cells data in the Spreadsheet. + * @returns {void} + */ + paste(): void; + } + + export interface XLComment { + + /** This method is used to delete the comment in the specified range in Spreadsheet. + * @param {Array|string} Optional. If range is specified, it will delete comments for the specified range else it will use the current selected range. + * @param {number} Optional. If sheetIdx is specified, it will delete comment in specified sheet else it will use active sheet. + * @param {boolean} Optional. Pass {{'`true`' | markdownify}}, if you want to skip the hidden rows data. + * @returns {void} + */ + deleteComment(range: any[] | string, sheetIdx: number, skipHiddenRow: boolean): void; + + /** This method is used to edit the comment in the target Cell in Spreadsheet. + * @param {any} Optional. Pass the row index and column index of the cell which contains comment. + * @returns {void} + */ + editComment(targetCell: any): void; + + /** This method is used to find the next comment from the active cell in Spreadsheet. + * @returns {boolean} + */ + findNextComment(): boolean; + + /** This method is used to find the previous comment from the active cell in Spreadsheet. + * @returns {boolean} + */ + findPrevComment(): boolean; + + /** This method is used to get comment data for the specified cell. + * @param {HTMLElement} Pass the DOM element to get comment data as object. + * @returns {any} + */ + getComment(cell: HTMLElement): any; + + /** This method is used to set new comment in Spreadsheet. + * @param {string|Array} Optional. If we pass the range comment will set in the range otherwise it will set with selected cells. + * @param {string} Optional. Pass the comment data. + * @param {boolean} Optional. Pass {{'`true`' | markdownify}} to show comment in edit mode + * @param {boolean} Optional. Pass {{'`true`' | markdownify}} to show the user name + * @returns {void} + */ + setComment(range: string | any[], data: string, showEditPanel: boolean, showUserName: boolean): void; + + /** This method is used to show all the comments in the Spreadsheet. + * @returns {void} + */ + showAllComments(): void; + + /** This method is used to show or hide the specific comment in the Spreadsheet. + * @param {HTMLElement} Optional. Pass the cell DOM element to show or hide its comment. If pass empty argument active cell will processed. + * @returns {void} + */ + showHideComment(targetCell: HTMLElement): void; + } + + export interface XLCMenu { + + /** This method is used to dynamically add items in the context menu. + * @param {string} Specifies the context menu type in which the item to be inserted. + * @param {Array} Pass the items to be inserted + * @param {string} Specifies the type of operation to be performed + * @returns {void} + */ + addItem(target: string, itemColl: any[], operation: string): void; + + /** This method is used to change data source in the context menu. + * @param {string} Specifies the context menu type to bind the data source. + * @param {Array} Pass the data source to be binded + * @returns {void} + */ + changeDataSource(target: string, data: any[]): void; + + /** This method is used to disable the items in the context menu. + * @param {string} Specifies the context menu type in which the item to be disabled. + * @param {Array} Specifies the Menu Item id collection to be disabled + * @returns {void} + */ + disableItem(target: string, idxColl: any[]): void; + + /** This method is used to enable the items in the context menu. + * @param {string} Specifies the context menu type in which the item to be enabled. + * @param {Array} Specifies the Menu Item id collection to be enabled + * @returns {void} + */ + enableItem(target: string, idxColl: any[]): void; + + /** This method is used to remove the items in the context menu. + * @param {string} Specifies the context menu type in which the item to be removed. + * @param {Array} Specifies the Menu Item id collection to be removed + * @returns {void} + */ + removeItem(target: string, idxColl: any[]): void; + } + + export interface XLDragDrop { + + /** This method is used to drag and drop the selected range of cells to destination range in the Spreadsheet. + * @param {any|Array} Pass the source range to perform drag and drop. + * @param {any|Array} Pass the destination range to drop the dragged cells. + * @returns {void} + */ + moveRangeTo(sourceRange: any | any[], destinationRange: any | any[]): void; + } + + export interface XLDragFill { + + /** This method is used to perform auto fill in Spreadsheet. + * @param {any} Pass the options to perform auto fill in Spreadsheet. + * @returns {void} + */ + autoFill(options: any): void; + + /** This method is used to hide the auto fill element in the Spreadsheet. + * @returns {void} + */ + hideAutoFillElement(): void; + + /** This method is used to hide the auto fill options in the Spreadsheet. + * @returns {void} + */ + hideAutoFillOptions(): void; + + /** This method is used to set position of the auto fill element in the Spreadsheet. + * @param {boolean} Pass the isDragFill option as {{'`boolean`' | markdownify}} value to show auto fill options in Spreadsheet. + * @returns {void} + */ + positionAutoFillElement(isDragFill: boolean): void; + } + + export interface XLEdit { + + /** This method is used to calculate formulas in the specified sheet. + * @param {number} Optional. If sheet index is specified, then it will calculate formulas in the specified sheet only else it will calculate formulas in all sheets. + * @returns {void} + */ + calcNow(sheetIdx: number): void; + + /** This method is used to edit a particular cell based on the row index and column index in the Spreadsheet. + * @param {number} Pass the row index to edit particular cell. + * @param {number} Pass the column index to edit particular cell. + * @param {boolean} Pass {{'`true`' | markdownify}}, if you want to maintain previous cell value. + * @returns {void} + */ + editCell(rowIdx: number, colIdx: number, oldData: boolean): void; + + /** This method is used to get the property value of particular cell, based on the row and column index in the Spreadsheet. + * @param {number} Pass the row index to get the property value. + * @param {number} Pass the column index to get the property value. + * @param {string} Optional. Pass the property name that you want("value", "value2", "type", "cFormatRule", "range", "thousandSeparator", "rule", "format", "border", "picture", + * "chart", "calcValue", "align", "hyperlink", "formats", "borders", "tformats", "tborders", "isFilterHeader", "filterState", "tableName", "comment", "formatStr", + * "decimalPlaces", "cellType"). + * @param {number} Optional. Pass the index of the sheet. + * @returns {any|string|Array} + */ + getPropertyValue(rowIdx: number, colIdx: number, prop: string, sheetIdx: number): any | string | any[]; + + /** This method is used to get the property value in specified cell in Spreadsheet. + * @param {HTMLElement} Pass the cell element to get property value. + * @param {string} Pass the property name that you want ("value", "value2", "type", "cFormatRule", "range", "thousandSeparator", "rule", "format", "border", + * "picture", "chart", "calcValue", "align", "hyperlink", "formats", "borders", "tformats", "tborders", "isFilterHeader", "filterState", "tableName", + * "comment", "formatStr", "decimalPlaces", "cellType"). + * @param {number} Pass the index of sheet. + * @returns {any|string|Array} + */ + getPropertyValueByElem(elem: HTMLElement, property: string, sheetIdx: number): any | string | any[]; + + /** This method is used to save the edited cell value in the Spreadsheet. + * @returns {void} + */ + saveCell(): void; + + /** This method is used to update a particular cell value in the Spreadsheet. + * @param {any} Pass row index and column index of the cell. + * @param {string|number} Pass the cell value. + * @returns {void} + */ + updateCell(cell: any, value: string | number): void; + + /** This method is used to update a particular cell value and its format in the Spreadsheet. + * @param {any} Pass row index and column index of the cell. + * @param {string|number} Pass the cell value. + * @param {string} Pass the class name to update format. + * @param {number} Pass sheet index. + * @returns {void} + */ + updateCellValue(cellIdx: any, val: string | number, formatClass: string, sheetIdx: number): void; + } + + export interface XLExport { + + /** This method is used to save the sheet data as Excel ,CSV or PDF document (.xls, .xlsx .csv, .pdf) in Spreadsheet. + * @param {string} Pass the export type that you want. + * @returns {void} + */ + export(type: string): void; + + /** This method is used to get the export properties in the Spreadsheet. + * @returns {any} + */ + getExportProps(): any; + } + + export interface XLFilter { + + /** This method is used to clear the filter in filtered columns in the Spreadsheet. + * @returns {void} + */ + clearFilter(): void; + + /** This method is used to apply filter for the selected range of cells in the Spreadsheet. + * @param {string|Array} Pass the range of the selected cells. + * @returns {void} + */ + filter(range: string | any[]): void; + + /** This method is used to apply filter for the column by active cell's value in the Spreadsheet. + * @returns {void} + */ + filterByActiveCell(): void; + } + + export interface XLFormat { + + /** This method is used to convert table range to normal range. + * @param {any} Pass the sheet index and table id. + * @returns {void} + */ + convertToRange(options: any): void; + + /** This method is used to create a table for the selected range of cells in the Spreadsheet. + * @param {any} Pass the table object. + * @param {string|Array} Optional. If the range is specified, then it will create table in the specified range else it will use the current selected range. + * @returns {string} + */ + createTable(tableObject: any, range: string | any[]): string; + + /** This method is used to set format style and values in a cell or range of cells. + * @param {any} Pass the formatObject which contains style, type, format, groupSeparator and decimalPlaces. + * @param {string} Pass the range to format cells. + * @returns {void} + */ + format(formatObj: any, range: string): void; + + /** This method is used to remove the style in the specified range. + * @param {Array|string} Pass the cell range . + * @param {any} Optional. Pass the options for which the style gets removed. + * @returns {void} + */ + removeStyle(range: any[] | string, options: any): void; + + /** This method is used to remove table with specified tableId in the Spreadsheet. + * @param {number} Pass the tableId that you want to remove. + * @returns {void} + */ + removeTable(tableId: number): void; + + /** This method is used to update the decimal places for numeric value for the selected range of cells in the Spreadsheet. + * @param {string} Pass the decimal places type in increment/decrement. + * @param {string|Array} Pass the range. + * @returns {void} + */ + updateDecimalPlaces(type: string, range: string | any[]): void; + + /** This method is used to update the format for the selected range of cells in the Spreadsheet. + * @param {any} Pass the format object that you want to update. + * @param {Array} Optional. If the range is specified, then it will update format in the specified range else it will use the current selected range. + * @returns {void} + */ + updateFormat(formatObj: any, range: any[]): void; + + /** This method is used to update the unique format for selected range of cells in the Spreadsheet. + * @param {string} Pass the unique format class. + * @param {Array} Optional. If the range is specified, then it will update format in the specified range else it will use the current selected range. + * @returns {void} + */ + updateUniqueFormat(formatClass: string, range: any[]): void; + } + + export interface XLFreeze { + + /** This method is used to freeze columns upto the specified column index in the Spreadsheet. + * @param {number} Index of the column to be freeze. + * @returns {void} + */ + freezeColumns(colIdx: number): void; + + /** This method is used to freeze the first column in the Spreadsheet. + * @returns {void} + */ + freezeLeftColumn(): void; + + /** This method is used to freeze rows and columns before the specified cell in the Spreadsheet. + * @param {number} Index of the row to be freeze. + * @param {number} Index of the column to be freeze. + * @returns {void} + */ + freezePanes(rowIdx: number, colIdx: number): void; + + /** This method is used to freeze rows upto the specified row index in the Spreadsheet. + * @param {number} Index of the row to be freeze. + * @returns {void} + */ + freezeRows(rowIdx: number): void; + + /** This method is used to freeze the top row in the Spreadsheet. + * @returns {void} + */ + freezeTopRow(): void; + + /** This method is used to unfreeze the frozen rows and columns in the Spreadsheet. + * @returns {void} + */ + unfreezePanes(): void; + } + + export interface XLPivot { + + /** This property is used to clear the pivot table list in Spreadsheet. + * @param {string} Pass the name of the pivot table. + * @returns {void} + */ + clearPivotFieldList(pivotName: string): void; + + /** This method is used to create pivot table. + * @param {string} It specifies the range for which the pivot table is created. + * @param {string} It specifies the location in which the pivot table is created. + * @param {string} It specifies the name of the pivot table. + * @param {any} Pass the pivot table settings. + * @param {any} Pass the pivot range, sheet index, address and data source . + * @returns {string} + */ + createPivotTable(range: string, location: string, name: string, settings: any, pvt: any): string; + + /** This method is used to delete the pivot table which is selected. + * @param {string} Pass the name of the pivot table. + * @returns {void} + */ + deletePivotTable(pivotName: string): void; + + /** This method is used to refresh data in pivot table. + * @param {string} Optional. Pass the name of the pivot table. + * @param {number} Optional. Pass the index of the sheet. + * @returns {void} + */ + refreshDataSource(name: string, sheetIdx: number): void; + } + + export interface XLPrint { + + /** This method is used to print the selected contents in the Spreadsheet. + * @returns {void} + */ + printSelection(): void; + + /** This method is used to print the entire contents in the active sheet. + * @returns {void} + */ + printSheet(): void; + } + + export interface XLResize { + + /** This method is used to fit the height of rows in the Spreadsheet. + * @param {Array} Optional. Pass row index collection that you want to fit its height. + * @returns {void} + */ + fitHeight(rowIndexes: any[]): void; + + /** This method is used to fit the width of columns in the Spreadsheet. + * @param {Array} Optional. Pass column index collection that you want to fit its width. + * @returns {void} + */ + fitWidth(colIndexes: any[]): void; + + /** This method is used to get the column width of the specified column index in the Spreadsheet. + * @param {number} Pass the column index. + * @returns {number} + */ + getColWidth(colIdx: number): number; + + /** This method is used to get the row height of the specified row index in the Spreadsheet. + * @param {number} Pass the row index which you want to find its height. + * @returns {number} + */ + getRowHeight(rowIdx: number): number; + + /** This method is used to set the column width of the specified column index in the Spreadsheet. + * @param {number} Pass the column index. + * @param {number} Pass the width value that you want to set. + * @returns {void} + */ + setColWidth(colIdx: number, size: number): void; + + /** This method is used to set the row height of the specified row index in the Spreadsheet. + * @param {number} Pass the row index. + * @param {number} Pass the height value that you want to set. + * @returns {void} + */ + setRowHeight(rowIdx: number, size: number): void; + } + + export interface XLRibbon { + + /** This method is used to add a new item in the backstage. + * @param {any} Specifies the item to be added in the backstage. + * @param {number} pass the index of the item to be added in the backstage. + * @returns {void} + */ + addBackStageItem(pageItem: any, index: number): void; + + /** This method is used to dynamically add the contextual tabs in the ribbon. + * @param {any} Specifies the contextual tab set object. + * @param {number} pass the index of the contextual tab. + * @returns {void} + */ + addContextualTabs(contextualTabSet: any, index: number): void; + + /** This method is used to dynamically add the menu item in the file menu. + * @param {Array} Specifies the item to be added + * @param {number} pass the index of the menu item. + * @returns {void} + */ + addMenuItem(item: any[], index: number): void; + + /** This method is used to add a new name in the Spreadsheet name manager. + * @param {string} Pass the name that you want to define in name manager. + * @param {string} Pass the cell reference. + * @param {string} Optional. Pass comment, if you want. + * @param {number} Optional. Pass the sheet index. + * @returns {void} + */ + addNamedRange(name: string, refersTo: string, comment: string, sheetIdx: number): void; + + /** This method is used to dynamically add the tab in the ribbon. + * @param {Array} Specifies the text to be displayed in the tab. + * @param {number} pass the groups to be displayed in the ribbon tab. + * @param {number} pass the index of the tab. + * @returns {void} + */ + addTab(tabText: any[], ribbonGroups: number, index: number): void; + + /** This method is used to dynamically add the tab group in the ribbon. + * @param {number} Specifies the ribbon tab index. + * @param {any} pass the groups to be displayed in the ribbon tab. + * @param {number} pass the index of the ribbon group. + * @returns {void} + */ + addTabGroup(tabIndex: number, tabGroup: any, groupIndex: number): void; + + /** This method is used to insert the few type (SUM, MAX, MIN, AVG, COUNT) of formulas in the selected range of cells in the Spreadsheet. + * @param {string} To pass the type("SUM","MAX","MIN","AVG","COUNT"). + * @param {string|Array} If range is specified, it will apply auto sum for the specified range else it will use the current selected range. + * @returns {void} + */ + autoSum(type: string, range: string | any[]): void; + + /** This method is used to hide the file menu in the ribbon tab. + * @returns {void} + */ + hideMenu(): void; + + /** This method is used to remove the item from the backstage in the spreadsheet. + * @param {number} Specifies the index of the item to be removed from backstage. + * @returns {void} + */ + removeBackStageItem(index: number): void; + + /** This method is used to remove the menu item form file menu in spreadsheet. + * @param {number} Specifies the index of the item to be removed from the file menu. + * @returns {void} + */ + removeMenuItem(index: number): void; + + /** This method is used to delete the defined name in the Spreadsheet name manager. + * @param {string} Pass the defined name that you want to remove from name manager. + * @returns {void} + */ + removeNamedRange(name: string): void; + + /** This method is used to remove the tab form ribbon in the spreadsheet. + * @param {number} Specifies the index of the tab to be removed from the ribbon. + * @param {boolean} pass the boolean value to remove the tab from ribbon + * @returns {void} + */ + removeTab(index: number, isRemoveMenu: boolean): void; + + /** This method is used to remove the tab group form ribbon in the spreadsheet. + * @param {number} Specifies the index of the tab group to be removed from the ribbon. + * @param {string} Specifies the text to be displayed in the tab group + * @returns {void} + */ + removeTabGroup(tabIndex: number, groupText: string): void; + + /** This method is used to show the file menu in the ribbon tab. + * @returns {void} + */ + showMenu(): void; + + /** This method is used to update the menu item in the file menu. + * @param {any} Specifies the menu item to be updated in the ribbon + * @param {number} pass the index of the item to be updated + * @returns {void} + */ + updateMenuItem(item: any, index: number): void; + + /** This method is used to update the ribbon icons in the Spreadsheet. + * @returns {void} + */ + updateRibbonIcons(): void; + } + + export interface XLSearch { + + /** This method is used to find and replace all data by workbook in the Spreadsheet. + * @param {string} Pass the search data. + * @param {string} Pass the replace data. + * @param {boolean} Pass {{'`true`' | markdownify}}, if you want to match with case-sensitive. + * @param {boolean} Pass {{'`true`' | markdownify}}, if you want to match with entire cell contents. + * @returns {void} + */ + replaceAllByBook(findData: string, replaceData: string, isCSen: boolean, isEMatch: boolean): void; + + /** This method is used to find and replace all data by sheet in Spreadsheet. + * @param {string} Pass the search data. + * @param {string} Pass the replace data. + * @param {boolean} Pass {{'`true`' | markdownify}}, if you want to match with case-sensitive. + * @param {boolean} Pass {{'`true`' | markdownify}}, if you want to match with entire cell contents. + * @returns {void} + */ + replaceAllBySheet(findData: string, replaceData: string, isCSen: boolean, isEMatch: boolean): void; + } + + export interface XLSelection { + + /** This method is used to clear the selection of the active sheet in the Spreadsheet. + * @returns {void} + */ + clearAll(): void; + + /** This method is used to get the selected cells element based on specified sheet index in the Spreadsheet. + * @param {number} Pass the sheet index to get the cells element. + * @returns {HTMLElement} + */ + getSelectedCells(sheetIdx: number): HTMLElement; + + /** This method is used to refresh the selection in the Spreadsheet. + * @param {Array|string} Optional. Pass range to refresh selection. + * @returns {void} + */ + refreshSelection(range: any[] | string): void; + + /** This method is used to select a single column in the Spreadsheet. + * @param {number} Pass the column index value. + * @returns {void} + */ + selectColumn(colIdx: number): void; + + /** This method is used to select entire columns in a specified range (start index and end index) in the Spreadsheet. + * @param {number} Pass the column start index. + * @param {number} Pass the column end index. + * @returns {void} + */ + selectColumns(startIdx: number, endIdx: number): void; + + /** This method is used to select the specified range of cells in the Spreadsheet. + * @param {string} Pass range which want to select. + * @returns {void} + */ + selectRange(range: string): void; + + /** This method is used to select a single row in the Spreadsheet. + * @param {number} Pass the row index value. + * @returns {void} + */ + selectRow(rowIdx: number): void; + + /** This method is used to select entire rows in a specified range (start index and end index) in the Spreadsheet. + * @param {number} Pass the start row index. + * @param {number} Pass the end row index. + * @returns {void} + */ + selectRows(startIdx: number, endIdx: number): void; + + /** This method is used to select all cells in active sheet. + * @returns {void} + */ + selectSheet(): void; + } + + export interface XLShape { + + /** This method is used to set a picture in the Spreadsheet. + * @param {string} Pass the range of the cell. + * @param {string} Pass the path of the specified image. + * @param {number} Optional. Pass the width of the image that you want to set. + * @param {number} Optional. Pass the height of the image that you want to set. + * @param {number} Optional. Pass the top of the image that you want to set. + * @param {number} Optional. Pass the left of the image that you want to set. + * @returns {string} + */ + setPicture(range: string, url: string, width: number, height: number, top: number, left: number): string; + } + + export interface XLSort { + + /** This method is used to sort a particular range of cells based on its cell or font color in the Spreadsheet. + * @param {string} Pass {{'`PutCellColor`' | markdownify}} to sort by cell color or {{'`PutFontColor`' | markdownify}} for sort by font color. + * @param {any} Pass the HEX color code to sort. + * @param {string} Pass the range + * @returns {void} + */ + sortByColor(operation: string, color: any, range: string): void; + + /** This method is used to sort a particular range of cells based on its values in the Spreadsheet. + * @param {Array|string} Pass the range to sort. + * @param {string} Pass the column name. + * @param {any} Pass the direction to sort (ascending or descending). + * @returns {boolean} + */ + sortByRange(range: any[] | string, columnName: string, direction: any): boolean; + } + + export interface XLValidate { + + /** This method is used to apply data validation rules in a selected range of cells based on the defined condition in the Spreadsheet. + * @param {string|Array} If range is specified, it will apply rules for the specified range else it will use the current selected range. + * @param {Array} Pass the validation condition, value1 and value2. + * @param {string} Pass the data type. + * @param {boolean} Pass {{'`true`' | markdownify}} if you ignore blank values. + * @param {boolean} Pass {{'`true`' | markdownify}} if you want to show an error alert. + * @returns {void} + */ + applyDVRules(range: string | any[], values: any[], type: string, required: boolean, showErrorAlert: boolean): void; + + /** This method is used to clear the applied validation rules in a specified range of cells in the Spreadsheet. + * @param {string|Array} Optional. If range is specified, it will clear rules for the specified range else it will use the current selected range. + * @returns {void} + */ + clearDV(range: string | any[]): void; + + /** This method is used to highlight invalid data in a specified range of cells in the Spreadsheet. + * @param {string|Array} Optional. If range is specified, it will clear rules for the specified range else it will use the current selected range. + * @returns {void} + */ + highlightInvalidData(range: string | any[]): void; + } + + export interface Model { + + /** Gets or sets an active sheet index in the Spreadsheet. By defining this value, you can specify which sheet should be active in workbook. + * @Default {1} + */ + activeSheetIndex?: number; + + /** Gets or sets a value that indicates whether to enable or disable auto rendering of cell type in the Spreadsheet. + * @Default {false} + */ + allowAutoCellType?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable auto fill feature in the Spreadsheet. + * @Default {true} + */ + allowAutoFill?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable auto sum feature in the Spreadsheet. + * @Default {true} + */ + allowAutoSum?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable cell format feature in the Spreadsheet. By enabling this, you can customize styles and number formats. + * @Default {true} + */ + allowCellFormatting?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable cell type feature in the Spreadsheet. + * @Default {false} + */ + allowCellType?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable chart feature in the Spreadsheet. By enabling this feature, you can create and customize charts in Spreadsheet. + * @Default {true} + */ + allowCharts?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable clear feature in the Spreadsheet. + * @Default {true} + */ + allowClear?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable clipboard feature in the Spreadsheet. By enabling this feature, you can perform cut/copy and paste operations in Spreadsheet. + * @Default {true} + */ + allowClipboard?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable comment feature in the Spreadsheet. By enabling this, you can add/delete/modify comments in Spreadsheet. + * @Default {true} + */ + allowComments?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable Conditional Format feature in the Spreadsheet. By enabling this, you can apply formatting to the selected range + * of cells based on the provided conditions (Greater than, Less than, Equal, Between, Contains, etc.). + * @Default {true} + */ + allowConditionalFormats?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable data validation feature in the Spreadsheet. + * @Default {true} + */ + allowDataValidation?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable the delete action in the Spreadsheet. By enabling this feature, you can delete existing rows, columns, cells and sheet. + * @Default {true} + */ + allowDelete?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable drag and drop feature in the Spreadsheet. + * @Default {true} + */ + allowDragAndDrop?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable the edit action in the Spreadsheet. + * @Default {true} + */ + allowEditing?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable filtering feature in the Spreadsheet. Filtering can be used to limit the data displayed using required criteria. + * @Default {true} + */ + allowFiltering?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable table feature in the Spreadsheet. By enabling this, you can render table in selected range. + * @Default {true} + */ + allowFormatAsTable?: boolean; + + /** Get or sets a value that indicates whether to enable or disable format painter feature in the Spreadsheet. By enabling this feature, you can copy + * the format from the selected range and apply it to another range. + * @Default {true} + */ + allowFormatPainter?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable formula bar in the Spreadsheet. + * @Default {true} + */ + allowFormulaBar?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable freeze pane support in Spreadsheet. After enabling this feature, + * you can use freeze top row, freeze first column and freeze panes options. + * @Default {false} + */ + allowFreezing?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable hyperlink feature in the Spreadsheet. By enabling this feature, you can add hyperlink which is used to + * easily navigate to the cell reference from one sheet to another or a web page. + * @Default {true} + */ + allowHyperlink?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable import feature in the Spreadsheet. By enabling this feature, you can open existing Spreadsheet documents. + * @Default {true} + */ + allowImport?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable the insert action in the Spreadsheet. By enabling this feature, you can insert new rows, columns, cells and sheet. + * @Default {true} + */ + allowInsert?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable keyboard navigation feature in the Spreadsheet. + * @Default {true} + */ + allowKeyboardNavigation?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable lock cell feature in the Spreadsheet. + * @Default {true} + */ + allowLockCell?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable merge feature in the Spreadsheet. + * @Default {true} + */ + allowMerging?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable overflow feature in the Spreadsheet. + * @Default {true} + */ + allowOverflow?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable resizing feature in the Spreadsheet. By enabling this feature, you can change the column width and + * row height by dragging its header boundaries. + * @Default {true} + */ + allowResizing?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable find and replace feature in the Spreadsheet. By enabling this, you can easily find and replace + * a specific value in the sheet or workbook. By using goto behavior, you can select and highlight all cells that contains specific data or data types. + * @Default {true} + */ + allowSearching?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable selection in the Spreadsheet. By enabling this feature, selected items will be highlighted. + * @Default {true} + */ + allowSelection?: boolean; + + /** Gets or sets a value that indicates whether to enable the sorting feature in the Spreadsheet. + * @Default {true} + */ + allowSorting?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable undo and redo feature in the Spreadsheet. + * @Default {true} + */ + allowUndoRedo?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable wrap text feature in the Spreadsheet. By enabling this, cell content can wrap to the next line, + * if the cell content exceeds the boundary of the cell. + * @Default {true} + */ + allowWrap?: boolean; + + /** Gets or sets a value that indicates to define the width of the activation panel in Spreadsheet. + * @Default {300} + */ + apWidth?: number; + + /** Gets or sets an object that indicates to customize the auto fill behavior in the Spreadsheet. + */ + autoFillSettings?: AutoFillSettings; + + /** Gets or sets an object that indicates to customize the chart behavior in the Spreadsheet. + */ + chartSettings?: ChartSettings; + + /** Gets or sets a value that defines the number of columns displayed in the sheet. + * @Default {21} + */ + columnCount?: number; + + /** Gets or sets a value that indicates to define the common width for each column in the Spreadsheet. + * @Default {64} + */ + columnWidth?: number; + + /** Gets or sets a value to add root CSS class for customizing Spreadsheet skins. + */ + cssClass?: string; + + /** Gets or sets a value that indicates custom formulas in Spreadsheet. + * @Default {[]} + */ + customFormulas?: any[]; + + /** Gets or sets a value that indicates whether to enable or disable context menu in the Spreadsheet. + * @Default {true} + */ + enableContextMenu?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable pivot table in the Spreadsheet. + * @Default {false} + */ + enablePivotTable?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable touch support in the Spreadsheet. + * @Default {true} + */ + enableTouch?: boolean; + + /** Gets or sets an object that indicates to customize the exporting behavior in Spreadsheet. + */ + exportSettings?: ExportSettings; + + /** Gets or sets an object that indicates to customize the format behavior in the Spreadsheet. + */ + formatSettings?: FormatSettings; + + /** Gets or sets an object that indicates to customize the import behavior in the Spreadsheet. + */ + importSettings?: ImportSettings; + + /** Gets or sets a value that indicates whether to enable or disable readonly support in the Spreadsheet. + * @Default {false} + */ + isReadOnly?: boolean; + + /** Gets or sets a value that indicates whether to customizing the user interface (UI) as locale-specific in order to display regional data (i.e.) + * in a language and culture specific to a particular country or region. + * @Default {en-US} + */ + locale?: string; + + /** Gets or sets an object that indicates to customize the picture behavior in the Spreadsheet. + */ + pictureSettings?: PictureSettings; + + /** Gets or sets an object that indicates to customize the print option in Spreadsheet. + */ + printSettings?: PrintSettings; + + /** Gets or sets an object that indicates to customize the ribbon settings in Spreadsheet. + */ + ribbonSettings?: RibbonSettings; + + /** Gets or sets a value that indicates whether to define the number of rows to be displayed in the sheet. + * @Default {20} + */ + rowCount?: number; - /** Gets or sets a value that indicates to define the common height for each row in the sheet. - * @Default {20} - */ - rowHeight?: number; + /** Gets or sets a value that indicates to define the common height for each row in the sheet. + * @Default {20} + */ + rowHeight?: number; - /** Gets or sets an object that indicates to customize the scroll options in the Spreadsheet. - */ - scrollSettings?: ScrollSettings; + /** Gets or sets an object that indicates to customize the scroll options in the Spreadsheet. + */ + scrollSettings?: ScrollSettings; - /** Gets or sets an object that indicates to customize the selection options in the Spreadsheet. - */ - selectionSettings?: SelectionSettings; + /** Gets or sets an object that indicates to customize the selection options in the Spreadsheet. + */ + selectionSettings?: SelectionSettings; - /** Gets or sets a value that indicates to define the number of sheets to be created at the initial load. - * @Default {1} - */ - sheetCount?: number; + /** Gets or sets a value that indicates to define the number of sheets to be created at the initial load. + * @Default {1} + */ + sheetCount?: number; - /** Gets or sets an object that indicates to customize the sheet behavior in Spreadsheet. - */ - sheets?: Sheet[]; + /** Gets or sets an object that indicates to customize the sheet behavior in Spreadsheet. + */ + sheets?: Sheet[]; - /** Gets or sets a value that indicates whether to show or hide pager in the Spreadsheet. - * @Default {true} - */ - showPager?: boolean; + /** Gets or sets a value that indicates whether to show or hide pager in the Spreadsheet. + * @Default {true} + */ + showPager?: boolean; - /** Gets or sets a value that indicates whether to show or hide ribbon in the Spreadsheet. - * @Default {true} - */ - showRibbon?: boolean; + /** Gets or sets a value that indicates whether to show or hide ribbon in the Spreadsheet. + * @Default {true} + */ + showRibbon?: boolean; - /** This is used to set the number of undo-redo steps in the Spreadsheet. - * @Default {20} - */ - undoRedoStep?: number; + /** This is used to set the number of undo-redo steps in the Spreadsheet. + * @Default {20} + */ + undoRedoStep?: number; - /** Define the username for the Spreadsheet which is displayed in comment. - * @Default {User Name} - */ - userName?: string; + /** Define the username for the Spreadsheet which is displayed in comment. + * @Default {User Name} + */ + userName?: string; - /** Triggered for every action before its starts. */ - actionBegin?(e: ActionBeginEventArgs): void; + /** Triggered for every action before its starts. */ + actionBegin?(e: ActionBeginEventArgs): void; - /** Triggered for every action complete. */ - actionComplete?(e: ActionCompleteEventArgs): void; + /** Triggered for every action complete. */ + actionComplete?(e: ActionCompleteEventArgs): void; - /** Triggered when the auto fill operation begins. */ - autoFillBegin?(e: AutoFillBeginEventArgs): void; + /** Triggered when the auto fill operation begins. */ + autoFillBegin?(e: AutoFillBeginEventArgs): void; - /** Triggered when the auto fill operation completes. */ - autoFillComplete?(e: AutoFillCompleteEventArgs): void; + /** Triggered when the auto fill operation completes. */ + autoFillComplete?(e: AutoFillCompleteEventArgs): void; - /** Triggered before the batch save. */ - beforeBatchSave?(e: BeforeBatchSaveEventArgs): void; + /** Triggered before the batch save. */ + beforeBatchSave?(e: BeforeBatchSaveEventArgs): void; - /** Triggered before the cells to be formatted. */ - beforeCellFormat?(e: BeforeCellFormatEventArgs): void; + /** Triggered before the cells to be formatted. */ + beforeCellFormat?(e: BeforeCellFormatEventArgs): void; - /** Triggered before the cell selection. */ - beforeCellSelect?(e: BeforeCellSelectEventArgs): void; + /** Triggered before the cell selection. */ + beforeCellSelect?(e: BeforeCellSelectEventArgs): void; - /** Triggered before the selected cells are dropped. */ - beforeDrop?(e: BeforeDropEventArgs): void; + /** Triggered before the selected cells are dropped. */ + beforeDrop?(e: BeforeDropEventArgs): void; - /** Triggered while start to edit the comment. */ - beforeEditComment?(e: BeforeEditCommentEventArgs): void; + /** Triggered while start to edit the comment. */ + beforeEditComment?(e: BeforeEditCommentEventArgs): void; - /** Triggered before the contextmenu is open. */ - beforeOpen?(e: BeforeOpenEventArgs): void; + /** Triggered before the contextmenu is open. */ + beforeOpen?(e: BeforeOpenEventArgs): void; - /** Triggered before the activation panel is open. */ - beforePanelOpen?(e: BeforePanelOpenEventArgs): void; + /** Triggered before the activation panel is open. */ + beforePanelOpen?(e: BeforePanelOpenEventArgs): void; - /** Triggered when click on sheet cell. */ - cellClick?(e: CellClickEventArgs): void; + /** Triggered when click on sheet cell. */ + cellClick?(e: CellClickEventArgs): void; - /** Triggered when the cell is edited. */ - cellEdit?(e: CellEditEventArgs): void; + /** Triggered when the cell is edited. */ + cellEdit?(e: CellEditEventArgs): void; - /** Triggered while cell is formatting. */ - cellFormatting?(e: CellFormattingEventArgs): void; + /** Triggered while cell is formatting. */ + cellFormatting?(e: CellFormattingEventArgs): void; - /** Triggered when mouse hover on cell in sheets. */ - cellHover?(e: CellHoverEventArgs): void; + /** Triggered when mouse hover on cell in sheets. */ + cellHover?(e: CellHoverEventArgs): void; - /** Triggered when save the edited cell. */ - cellSave?(e: CellSaveEventArgs): void; + /** Triggered when save the edited cell. */ + cellSave?(e: CellSaveEventArgs): void; - /** Triggered when the cell is selected. */ - cellSelected?(e: CellSelectedEventArgs): void; + /** Triggered when the cell is selected. */ + cellSelected?(e: CellSelectedEventArgs): void; - /** Triggered when click the contextmenu items. */ - contextMenuClick?(e: ContextMenuClickEventArgs): void; + /** Triggered when click the contextmenu items. */ + contextMenuClick?(e: ContextMenuClickEventArgs): void; - /** Triggered when the selected cells are being dragged. */ - drag?(e: DragEventArgs): void; + /** Triggered when the selected cells are being dragged. */ + drag?(e: DragEventArgs): void; - /** Triggered when you start to drag the picture or chart. */ - dragShape?(e: DragShapeEventArgs): void; + /** Triggered when you start to drag the picture or chart. */ + dragShape?(e: DragShapeEventArgs): void; - /** Triggered when the selected cells are initiated to drag. */ - dragStart?(e: DragStartEventArgs): void; + /** Triggered when the selected cells are initiated to drag. */ + dragStart?(e: DragStartEventArgs): void; - /** Triggered when the selected cells are dropped. */ - drop?(e: DropEventArgs): void; + /** Triggered when the selected cells are dropped. */ + drop?(e: DropEventArgs): void; - /** Triggered before the range editing starts. */ - editRangeBegin?(e: EditRangeBeginEventArgs): void; + /** Triggered before the range editing starts. */ + editRangeBegin?(e: EditRangeBeginEventArgs): void; - /** Triggered after range editing completes. */ - editRangeComplete?(e: EditRangeCompleteEventArgs): void; + /** Triggered after range editing completes. */ + editRangeComplete?(e: EditRangeCompleteEventArgs): void; - /** Triggered when the key is pressed down. */ - keyDown?(e: KeyDownEventArgs): void; + /** Triggered when the key is pressed down. */ + keyDown?(e: KeyDownEventArgs): void; - /** Triggered when the key is released. */ - keyUp?(e: KeyUpEventArgs): void; + /** Triggered when the key is released. */ + keyUp?(e: KeyUpEventArgs): void; - /** Triggered before the sheet is loaded. */ - load?(e: LoadEventArgs): void; + /** Triggered before the sheet is loaded. */ + load?(e: LoadEventArgs): void; - /** Triggered after the sheet is loaded. */ - loadComplete?(e: LoadCompleteEventArgs): void; + /** Triggered after the sheet is loaded. */ + loadComplete?(e: LoadCompleteEventArgs): void; - /** Triggered every click of the menu item. */ - menuClick?(e: MenuClickEventArgs): void; + /** Triggered every click of the menu item. */ + menuClick?(e: MenuClickEventArgs): void; - /** Triggered when a file is imported. */ - onImport?(e: OnImportEventArgs): void; + /** Triggered when a file is imported. */ + onImport?(e: OnImportEventArgs): void; - /** Triggered when import sheet is failed to open. */ - openFailure?(e: OpenFailureEventArgs): void; + /** Triggered when import sheet is failed to open. */ + openFailure?(e: OpenFailureEventArgs): void; - /** Triggered when pager item is clicked in the Spreadsheet. */ - pagerClick?(e: PagerClickEventArgs): void; + /** Triggered when pager item is clicked in the Spreadsheet. */ + pagerClick?(e: PagerClickEventArgs): void; - /** Triggered when you start resizing the chart, picture, row and column. */ - resizeStart?(e: ResizeStartEventArgs): void; + /** Triggered when you start resizing the chart, picture, row and column. */ + resizeStart?(e: ResizeStartEventArgs): void; - /** Triggered after end of resizing the chart, picture, row and column. */ - resizeEnd?(e: ResizeEndEventArgs): void; + /** Triggered after end of resizing the chart, picture, row and column. */ + resizeEnd?(e: ResizeEndEventArgs): void; - /** Triggered when click on the ribbon. */ - ribbonClick?(e: RibbonClickEventArgs): void; + /** Triggered when click on the ribbon. */ + ribbonClick?(e: RibbonClickEventArgs): void; - /** Triggered when the chart series rendering. */ - seriesRendering?(e: SeriesRenderingEventArgs): void; + /** Triggered when the chart series rendering. */ + seriesRendering?(e: SeriesRenderingEventArgs): void; - /** Triggered when click the ribbon tab. */ - tabClick?(e: TabClickEventArgs): void; + /** Triggered when click the ribbon tab. */ + tabClick?(e: TabClickEventArgs): void; - /** Triggered when select the ribbon tab. */ - tabSelect?(e: TabSelectEventArgs): void; -} + /** Triggered when select the ribbon tab. */ + tabSelect?(e: TabSelectEventArgs): void; + } -export interface ActionBeginEventArgs { + export interface ActionBeginEventArgs { - /** Returns the applied style format object. - */ - afterFormat?: any; + /** Returns the applied style format object. + */ + afterFormat?: any; - /** Returns the applied style format object. - */ - beforeFormat?: any; + /** Returns the applied style format object. + */ + beforeFormat?: any; - /** Returns the sheet index. - */ - sheetIdx?: number; + /** Returns the sheet index. + */ + sheetIdx?: number; - /** Returns the cell range. - */ - range?: any[]; + /** Returns the cell range. + */ + range?: any[]; - /** Returns the action format. - */ - reqType?: string; + /** Returns the action format. + */ + reqType?: string; - /** Returns goto index while paging. - */ - gotoIdx?: number; + /** Returns goto index while paging. + */ + gotoIdx?: number; - /** Returns boolean value. If create new sheet it returns true. - */ - newSheet?: boolean; + /** Returns boolean value. If create new sheet it returns true. + */ + newSheet?: boolean; - /** Return column name while sorting. - */ - columnName?: string; + /** Return column name while sorting. + */ + columnName?: string; - /** Returns selected columns while sorting or filtering begins. - */ - colSelected?: number; + /** Returns selected columns while sorting or filtering begins. + */ + colSelected?: number; - /** Returns sort direction while sort action begins. - */ - sortDirection?: string; -} + /** Returns sort direction while sort action begins. + */ + sortDirection?: string; + } -export interface ActionCompleteEventArgs { + export interface ActionCompleteEventArgs { - /** Returns Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the applied cell format object. - */ - selectedCell?: any[]|any; + /** Returns the applied cell format object. + */ + selectedCell?: any[] | any; - /** Returns the sheet index. - */ - sheetIdx?: number; + /** Returns the sheet index. + */ + sheetIdx?: number; - /** Returns the request type. - */ - reqType?: string; + /** Returns the request type. + */ + reqType?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface AutoFillBeginEventArgs { + export interface AutoFillBeginEventArgs { - /** Returns auto fill begin cell range. - */ - dataRange?: any[]; + /** Returns auto fill begin cell range. + */ + dataRange?: any[]; - /** Returns which direction drag the auto fill. - */ - direction?: string; + /** Returns which direction drag the auto fill. + */ + direction?: string; - /** Returns fill cells range. - */ - fillRange?: any[]; + /** Returns fill cells range. + */ + fillRange?: any[]; - /** Returns the auto fill type. - */ - fillType?: string; + /** Returns the auto fill type. + */ + fillType?: string; - /** Returns the sheet index. - */ - sheetIdx?: number; + /** Returns the sheet index. + */ + sheetIdx?: number; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface AutoFillCompleteEventArgs { + export interface AutoFillCompleteEventArgs { - /** Returns auto fill begin cell range. - */ - dataRange?: any[]; + /** Returns auto fill begin cell range. + */ + dataRange?: any[]; - /** Returns which direction to drag the auto fill. - */ - direction?: string; + /** Returns which direction to drag the auto fill. + */ + direction?: string; - /** Returns fill cells range. - */ - fillRange?: any[]; + /** Returns fill cells range. + */ + fillRange?: any[]; - /** Returns the auto fill type. - */ - fillType?: string; + /** Returns the auto fill type. + */ + fillType?: string; - /** Returns the sheet index. - */ - sheetIdx?: number; + /** Returns the sheet index. + */ + sheetIdx?: number; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface BeforeBatchSaveEventArgs { + export interface BeforeBatchSaveEventArgs { - /** Returns the sheet index. - */ - sheetIdx?: number; + /** Returns the sheet index. + */ + sheetIdx?: number; - /** Returns the query, primary key,batch changes for the data Source. - */ - dataSetting?: any; + /** Returns the query, primary key,batch changes for the data Source. + */ + dataSetting?: any; - /** Returns the changed record object. - */ - batchChanges?: any; -} + /** Returns the changed record object. + */ + batchChanges?: any; + } -export interface BeforeCellFormatEventArgs { + export interface BeforeCellFormatEventArgs { - /** Returns the sheet index. - */ - sheetIdx?: number; + /** Returns the sheet index. + */ + sheetIdx?: number; - /** Returns the applied style format object. - */ - format?: any; + /** Returns the applied style format object. + */ + format?: any; - /** Returns the selected cells. - */ - cells?: any[]|any; + /** Returns the selected cells. + */ + cells?: any[] | any; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface BeforeCellSelectEventArgs { + export interface BeforeCellSelectEventArgs { - /** Returns the previous cell range. - */ - prevRange?: any[]; + /** Returns the previous cell range. + */ + prevRange?: any[]; - /** Returns the current cell range. - */ - currRange?: any[]; + /** Returns the current cell range. + */ + currRange?: any[]; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface BeforeDropEventArgs { + export interface BeforeDropEventArgs { - /** Returns the sheet index. - */ - sheetIdx?: number; + /** Returns the sheet index. + */ + sheetIdx?: number; - /** Returns the current cell row and column index. - */ - currentCell?: any; + /** Returns the current cell row and column index. + */ + currentCell?: any; - /** Returns the drag cells range object. - */ - dragAndDropRange?: any; + /** Returns the drag cells range object. + */ + dragAndDropRange?: any; - /** Returns the cell Overwriting alert option value. - */ - preventAlert?: boolean; + /** Returns the cell Overwriting alert option value. + */ + preventAlert?: boolean; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the target item. - */ - target?: HTMLElement; + /** Returns the target item. + */ + target?: HTMLElement; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface BeforeEditCommentEventArgs { + export interface BeforeEditCommentEventArgs { - /** Returns the sheet index. - */ - sheetIdx?: number; + /** Returns the sheet index. + */ + sheetIdx?: number; - /** Returns the comment cell index. - */ - cellIndex?: any; + /** Returns the comment cell index. + */ + cellIndex?: any; - /** Returns the disable option value. - */ - disable?: boolean; + /** Returns the disable option value. + */ + disable?: boolean; - /** Returns the Spreadsheet model. - */ - model?: any; + /** Returns the Spreadsheet model. + */ + model?: any; - /** Returns the value of the comment - */ - value?: string; + /** Returns the value of the comment + */ + value?: string; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface BeforeOpenEventArgs { + export interface BeforeOpenEventArgs { - /** Returns the target element. - */ - target?: HTMLElement; + /** Returns the target element. + */ + target?: HTMLElement; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface BeforePanelOpenEventArgs { + export interface BeforePanelOpenEventArgs { - /** Returns the sheet index. - */ - sheetIdx?: number; + /** Returns the sheet index. + */ + sheetIdx?: number; - /** Returns the activation panel element. - */ - activationPanel?: any; + /** Returns the activation panel element. + */ + activationPanel?: any; - /** Returns the range option value. - */ - range?: any; + /** Returns the range option value. + */ + range?: any; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface CellClickEventArgs { + export interface CellClickEventArgs { - /** Returns the click cell element. - */ - cell?: HTMLElement; + /** Returns the click cell element. + */ + cell?: HTMLElement; - /** Returns the column index of clicked cell. - */ - columnIndex?: number; + /** Returns the column index of clicked cell. + */ + columnIndex?: number; - /** Returns the row index of clicked cell. - */ - rowIndex?: number; + /** Returns the row index of clicked cell. + */ + rowIndex?: number; - /** Returns the column name of clicked cell. - */ - columnName?: string; + /** Returns the column name of clicked cell. + */ + columnName?: string; - /** Returns the column information. - */ - columnObject?: any; + /** Returns the column information. + */ + columnObject?: any; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the target element. - */ - target?: HTMLElement; + /** Returns the target element. + */ + target?: HTMLElement; - /** Returns the value of the cell. - */ - value?: string; + /** Returns the value of the cell. + */ + value?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface CellEditEventArgs { + export interface CellEditEventArgs { - /** Returns the click cell element. - */ - cell?: HTMLElement; + /** Returns the click cell element. + */ + cell?: HTMLElement; - /** Returns the columnName of clicked cell. - */ - columnName?: string; + /** Returns the columnName of clicked cell. + */ + columnName?: string; - /** Returns the column field information. - */ - columnObject?: any; + /** Returns the column field information. + */ + columnObject?: any; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the target element. - */ - target?: HTMLElement; + /** Returns the target element. + */ + target?: HTMLElement; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface CellFormattingEventArgs { + export interface CellFormattingEventArgs { - /** Returns the sheet index - */ - SheetIdx?: number; + /** Returns the sheet index + */ + SheetIdx?: number; - /** Returns the applied style format object - */ - Format?: any; + /** Returns the applied style format object + */ + Format?: any; - /** Returns the cell index. - */ - Cell?: number; + /** Returns the cell index. + */ + Cell?: number; - /** Returns the name of the CSS theme. - */ - cssClass?: string; + /** Returns the name of the CSS theme. + */ + cssClass?: string; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the target element. - */ - target?: HTMLElement; + /** Returns the target element. + */ + target?: HTMLElement; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; -} + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; + } -export interface CellHoverEventArgs { + export interface CellHoverEventArgs { - /** Returns the target element. - */ - target?: HTMLElement; + /** Returns the target element. + */ + target?: HTMLElement; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface CellSaveEventArgs { + export interface CellSaveEventArgs { - /** Returns the save cell element. - */ - cell?: HTMLElement; + /** Returns the save cell element. + */ + cell?: HTMLElement; - /** Returns the columnName of clicked cell. - */ - columnName?: string; + /** Returns the columnName of clicked cell. + */ + columnName?: string; - /** Returns the column field information. - */ - columnObject?: any; + /** Returns the column field information. + */ + columnObject?: any; - /** Returns the index of the row. - */ - rowIndex?: number; + /** Returns the index of the row. + */ + rowIndex?: number; - /** Returns the index of the column. - */ - colIndex?: number; + /** Returns the index of the column. + */ + colIndex?: number; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the cell previous value. - */ - pValue?: string; + /** Returns the cell previous value. + */ + pValue?: string; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the target element. - */ - target?: HTMLElement; + /** Returns the target element. + */ + target?: HTMLElement; - /** Returns the cell value. - */ - value?: string; -} + /** Returns the cell value. + */ + value?: string; + } -export interface CellSelectedEventArgs { + export interface CellSelectedEventArgs { - /** Returns the active sheet index. - */ - sheetIdx?: number; + /** Returns the active sheet index. + */ + sheetIdx?: number; - /** Returns the selected range. - */ - selectedRange?: any[]; + /** Returns the selected range. + */ + selectedRange?: any[]; - /** Returns the target element. - */ - target?: HTMLElement; + /** Returns the target element. + */ + target?: HTMLElement; - /** Returns Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface ContextMenuClickEventArgs { + export interface ContextMenuClickEventArgs { - /** Returns target element Id. - */ - Id?: string; + /** Returns target element Id. + */ + Id?: string; - /** Returns the target element. - */ - element?: HTMLElement; + /** Returns the target element. + */ + element?: HTMLElement; - /** Returns event information. - */ - event?: any; + /** Returns event information. + */ + event?: any; - /** Returns target element and event information. - */ - events?: any; + /** Returns target element and event information. + */ + events?: any; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns target element parent Id. - */ - parentId?: string; + /** Returns target element parent Id. + */ + parentId?: string; - /** Returns target element parent text. - */ - parentText?: string; + /** Returns target element parent text. + */ + parentText?: string; - /** Returns target element text. - */ - text?: string; + /** Returns target element text. + */ + text?: string; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface DragEventArgs { + export interface DragEventArgs { - /** Returns the sheet index. - */ - sheetIdx?: number; + /** Returns the sheet index. + */ + sheetIdx?: number; - /** Returns the current cell row and column index. - */ - currentCell?: any; + /** Returns the current cell row and column index. + */ + currentCell?: any; - /** Returns the drag cells range object. - */ - dragAndDropRange?: any; + /** Returns the drag cells range object. + */ + dragAndDropRange?: any; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the target item. - */ - target?: HTMLElement; + /** Returns the target item. + */ + target?: HTMLElement; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface DragShapeEventArgs { + export interface DragShapeEventArgs { - /** Returns the Spreadsheet model. - */ - model?: any; + /** Returns the Spreadsheet model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the target element. - */ - target?: HTMLElement; + /** Returns the target element. + */ + target?: HTMLElement; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface DragStartEventArgs { + export interface DragStartEventArgs { - /** Returns the sheet index. - */ - sheetIdx?: number; + /** Returns the sheet index. + */ + sheetIdx?: number; - /** Returns the current cell row and column index. - */ - currentCell?: any; + /** Returns the current cell row and column index. + */ + currentCell?: any; - /** Returns the drag cells range object. - */ - dragAndDropRange?: any; + /** Returns the drag cells range object. + */ + dragAndDropRange?: any; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the target item. - */ - target?: HTMLElement; + /** Returns the target item. + */ + target?: HTMLElement; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface DropEventArgs { + export interface DropEventArgs { - /** Returns the sheet index. - */ - sheetIdx?: number; + /** Returns the sheet index. + */ + sheetIdx?: number; - /** Returns the current cell row and column index. - */ - currentCell?: any; + /** Returns the current cell row and column index. + */ + currentCell?: any; - /** Returns the drag cells range object. - */ - dragAndDropRange?: any; + /** Returns the drag cells range object. + */ + dragAndDropRange?: any; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the target item. - */ - target?: HTMLElement; + /** Returns the target item. + */ + target?: HTMLElement; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface EditRangeBeginEventArgs { + export interface EditRangeBeginEventArgs { - /** Returns the sheet index. - */ - sheetIdx?: number; + /** Returns the sheet index. + */ + sheetIdx?: number; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the range option value. - */ - range?: any; + /** Returns the range option value. + */ + range?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface EditRangeCompleteEventArgs { + export interface EditRangeCompleteEventArgs { - /** Returns the sheet index. - */ - sheetIdx?: number; + /** Returns the sheet index. + */ + sheetIdx?: number; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the range option value. - */ - range?: any; + /** Returns the range option value. + */ + range?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface KeyDownEventArgs { + export interface KeyDownEventArgs { - /** Returns the sheet index. - */ - sheetIndex?: number; + /** Returns the sheet index. + */ + sheetIndex?: number; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the boolean value. - */ - isCommentEdit?: boolean; + /** Returns the boolean value. + */ + isCommentEdit?: boolean; - /** Returns the boolean value. - */ - isEdit?: boolean; + /** Returns the boolean value. + */ + isEdit?: boolean; - /** Returns the boolean value. - */ - isSheetRename?: boolean; + /** Returns the boolean value. + */ + isSheetRename?: boolean; - /** Returns the target element. - */ - target?: HTMLElement; + /** Returns the target element. + */ + target?: HTMLElement; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface KeyUpEventArgs { + export interface KeyUpEventArgs { - /** Returns the sheet index. - */ - sheetIndex?: number; + /** Returns the sheet index. + */ + sheetIndex?: number; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the boolean value. - */ - isCommentEdit?: boolean; + /** Returns the boolean value. + */ + isCommentEdit?: boolean; - /** Returns the boolean value. - */ - isEdit?: boolean; + /** Returns the boolean value. + */ + isEdit?: boolean; - /** Returns the boolean value. - */ - isSheetRename?: boolean; + /** Returns the boolean value. + */ + isSheetRename?: boolean; - /** Returns the target element. - */ - target?: HTMLElement; + /** Returns the target element. + */ + target?: HTMLElement; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface LoadEventArgs { + export interface LoadEventArgs { - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the active sheet index. - */ - sheetIndex?: number; -} + /** Returns the active sheet index. + */ + sheetIndex?: number; + } -export interface LoadCompleteEventArgs { + export interface LoadCompleteEventArgs { - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface MenuClickEventArgs { + export interface MenuClickEventArgs { - /** Returns menu click element. - */ - element?: HTMLElement; + /** Returns menu click element. + */ + element?: HTMLElement; - /** Returns the event information. - */ - event?: any; + /** Returns the event information. + */ + event?: any; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns target element parent Id. - */ - parentId?: string; + /** Returns target element parent Id. + */ + parentId?: string; - /** Returns target element parent text. - */ - parentText?: string; + /** Returns target element parent text. + */ + parentText?: string; - /** Returns target element text. - */ - text?: string; + /** Returns target element text. + */ + text?: string; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface OnImportEventArgs { + export interface OnImportEventArgs { - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the imported data. - */ - importData?: any; -} + /** Returns the imported data. + */ + importData?: any; + } -export interface OpenFailureEventArgs { + export interface OpenFailureEventArgs { - /** Returns the failure type. - */ - failureType?: string; + /** Returns the failure type. + */ + failureType?: string; - /** Returns the status index. - */ - status?: number; + /** Returns the status index. + */ + status?: number; - /** Returns the status in text. - */ - statusText?: string; + /** Returns the status in text. + */ + statusText?: string; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface PagerClickEventArgs { + export interface PagerClickEventArgs { - /** Returns the active sheet index. - */ - activeSheet?: number; + /** Returns the active sheet index. + */ + activeSheet?: number; - /** Returns the new sheet index. - */ - gotoSheet?: number; + /** Returns the new sheet index. + */ + gotoSheet?: number; - /** Returns whether new sheet icon is clicked. - */ - newSheet?: boolean; + /** Returns whether new sheet icon is clicked. + */ + newSheet?: boolean; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the target element. - */ - target?: HTMLElement; + /** Returns the target element. + */ + target?: HTMLElement; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface ResizeStartEventArgs { + export interface ResizeStartEventArgs { - /** Returns the column index which column you start to resize. - */ - colIndex?: number; + /** Returns the column index which column you start to resize. + */ + colIndex?: number; - /** Returns the row index which row you start to resize. - */ - rowIndex?: number; + /** Returns the row index which row you start to resize. + */ + rowIndex?: number; - /** Returns the Spreadsheet model. - */ - model?: any; + /** Returns the Spreadsheet model. + */ + model?: any; - /** Returns type of the request. - */ - reqType?: string; + /** Returns type of the request. + */ + reqType?: string; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface ResizeEndEventArgs { + export interface ResizeEndEventArgs { - /** Returns the column index which you resized. - */ - colIndex?: number; + /** Returns the column index which you resized. + */ + colIndex?: number; - /** Returns old width of the column or shape. - */ - oldWidth?: number; + /** Returns old width of the column or shape. + */ + oldWidth?: number; - /** Returns new width of the column or shape. - */ - newWidth?: number; + /** Returns new width of the column or shape. + */ + newWidth?: number; - /** Returns the row index which you resized. - */ - rowIndex?: number; + /** Returns the row index which you resized. + */ + rowIndex?: number; - /** Returns old height of the row or shape. - */ - oldHeight?: number; + /** Returns old height of the row or shape. + */ + oldHeight?: number; - /** Returns new height of the row or shape. - */ - newHeight?: number; + /** Returns new height of the row or shape. + */ + newHeight?: number; - /** Returns the Spreadsheet model. - */ - model?: any; + /** Returns the Spreadsheet model. + */ + model?: any; - /** Returns type of the request. - */ - reqType?: string; + /** Returns type of the request. + */ + reqType?: string; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface RibbonClickEventArgs { + export interface RibbonClickEventArgs { - /** Returns element Id. - */ - Id?: string; + /** Returns element Id. + */ + Id?: string; - /** Returns target information. - */ - prop?: any; + /** Returns target information. + */ + prop?: any; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns status. - */ - status?: boolean; + /** Returns status. + */ + status?: boolean; - /** Returns isChecked in boolean. - */ - isChecked?: boolean; + /** Returns isChecked in boolean. + */ + isChecked?: boolean; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the target element. - */ - target?: HTMLElement; + /** Returns the target element. + */ + target?: HTMLElement; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface SeriesRenderingEventArgs { + export interface SeriesRenderingEventArgs { - /** Returns chart data and chart information. - */ - data?: any; + /** Returns chart data and chart information. + */ + data?: any; - /** Returns the chart model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the chart model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface TabClickEventArgs { + export interface TabClickEventArgs { - /** Returns the active tab index. - */ - activeIndex?: number; + /** Returns the active tab index. + */ + activeIndex?: number; - /** Returns active tab header element. - */ - activeHeader?: any; + /** Returns active tab header element. + */ + activeHeader?: any; - /** Returns previous active tab header element. - */ - prevActiveHeader?: any; + /** Returns previous active tab header element. + */ + prevActiveHeader?: any; - /** Returns previous active tab index. - */ - prevActiveIndex?: number; + /** Returns previous active tab index. + */ + prevActiveIndex?: number; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; - - /** Returns the name of the event. - */ - type?: string; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; + + /** Returns the name of the event. + */ + type?: string; - /** Returns the target element. - */ - target?: HTMLElement; - - /** Returns the cancel option value. - */ - cancel?: boolean; -} - -export interface TabSelectEventArgs { + /** Returns the target element. + */ + target?: HTMLElement; + + /** Returns the cancel option value. + */ + cancel?: boolean; + } + + export interface TabSelectEventArgs { - /** Returns the active tab index. - */ - activeIndex?: number; - - /** Returns active tab header element. - */ - activeHeader?: any; + /** Returns the active tab index. + */ + activeIndex?: number; + + /** Returns active tab header element. + */ + activeHeader?: any; - /** Returns previous active tab header element. - */ - prevActiveHeader?: any; - - /** Returns previous active tab index. - */ - prevActiveIndex?: number; - - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; - - /** Returns the name of the event. - */ - type?: string; - - /** Returns the target element. - */ - target?: HTMLElement; - - /** Returns the cancel option value. - */ - cancel?: boolean; -} - -export interface AutoFillSettings { - - /** This property is used to set fillType unit in Spreadsheet. It has five types which are CopyCells, FillSeries, FillFormattingOnly, FillWithoutFormatting and FlashFill. - * @Default {ej.Spreadsheet.AutoFillOptions.FillSeries} - */ - fillType?: ej.Spreadsheet.AutoFillOptions|string; - - /** Gets or sets a value that indicates to enable or disable auto fill options in the Spreadsheet. - * @Default {true} - */ - showFillOptions?: boolean; -} - -export interface ChartSettings { - - /** Gets or sets a value that defines the chart height in Spreadsheet. - * @Default {220} - */ - height?: number; - - /** Gets or sets a value that defines the chart width in the Spreadsheet. - * @Default {440} - */ - width?: number; -} - -export interface ExportSettings { - - /** Gets or sets a value that indicates whether to enable or disable save feature in Spreadsheet. By enabling this feature, you can save existing Spreadsheet. - * @Default {true} - */ - allowExporting?: boolean; - - /** Gets or sets a value that indicates to define csvUrl for export to CSV format. - * @Default {null} - */ - csvUrl?: string; - - /** Gets or sets a value that indicates to define excelUrl for export to excel format. - * @Default {null} - */ - excelUrl?: string; - - /** Gets or sets a value that indicates to define password while export to excel format. - * @Default {null} - */ - password?: string; - - /** Gets or sets a value that indicates to define pdfUrl for export to PDF format. - * @Default {null} - */ - pdfUrl?: string; -} - -export interface FormatSettings { - - /** Gets or sets a value that indicates whether to enable or disable cell border feature in the Spreadsheet. - * @Default {true} - */ - allowCellBorder?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable decimal places in the Spreadsheet. - * @Default {true} - */ - allowDecimalPlaces?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable font family feature in Spreadsheet. - * @Default {true} - */ - allowFontFamily?: boolean; -} - -export interface ImportSettings { - - /** Sets import mapper to perform import feature in Spreadsheet. - */ - importMapper?: string; - - /** Gets or sets a value that indicates whether to enable or disable import while initial loading. - * @Default {false} - */ - importOnLoad?: boolean; - - /** Sets import URL to access the online files in the Spreadsheet. - */ - importUrl?: string; - - /** Gets or sets a value that indicates to define password while importing in the Spreadsheet. - */ - password?: string; -} - -export interface PictureSettings { - - /** Gets or sets a value that indicates whether to enable or disable picture feature in Spreadsheet. By enabling this, you can add pictures in Spreadsheet. - * @Default {true} - */ - allowPictures?: boolean; - - /** Gets or sets a value that indicates to define height to picture in the Spreadsheet. - * @Default {220} - */ - height?: number; - - /** Gets or sets a value that indicates to define width to picture in the Spreadsheet. - * @Default {440} - */ - width?: number; -} - -export interface PrintSettings { - - /** Gets or sets a value that indicates whether to enable or disable page setup support for printing in Spreadsheet. - * @Default {true} - */ - allowPageSetup?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable page size support for printing in Spreadsheet. - * @Default {false} - */ - allowPageSize?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable print feature in the Spreadsheet. - * @Default {true} - */ - allowPrinting?: boolean; -} - -export interface RibbonSettingsApplicationTabMenuSettings { - - /** Gets or sets a value that indicates whether to enable or disable isAppend property in ribbon settings. - * @Default {false} - */ - isAppend?: boolean; - - /** Specifies the data source to append in application tab. - * @Default {[]} - */ - dataSource?: any[]; -} - -export interface RibbonSettingsApplicationTab { - - /** Gets or sets a value that indicates to set application tab type in Spreadsheet. It has two types, Menu and Backstage. - * @Default {ej.Ribbon.ApplicationTabType.Backstage} - */ - type?: ej.Ribbon.ApplicationTabType|string; - - /** Gets or sets an object that indicates menu settings for application tab in Spreadsheet. - */ - menuSettings?: RibbonSettingsApplicationTabMenuSettings; -} - -export interface RibbonSettings { - - /** Gets or sets an object that indicates application tab settings in Spreadsheet. - */ - applicationTab?: RibbonSettingsApplicationTab; -} - -export interface ScrollSettings { - - /** Gets or sets a value that indicates whether to enable or disable scrolling in Spreadsheet. - * @Default {true} - */ - allowScrolling?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable sheet on demand. By enabling this, it render only the active sheet element while paging remaining sheets are created one by one. - * @Default {false} - */ - allowSheetOnDemand?: boolean; - - /** Gets or sets a value that indicates whether to enable or disable virtual scrolling feature in the Spreadsheet. - * @Default {true} - */ - allowVirtualScrolling?: boolean; - - /** Gets or sets the value that indicates to define the height of spreadsheet. - * @Default {100%} - */ - height?: number|string; - - /** Gets or sets the value that indicates whether to enable or disable responsive mode in the Spreadsheet. - * @Default {true} - */ - isResponsive?: boolean; - - /** Gets or sets a value that indicates to set scroll mode in Spreadsheet. It has two scroll modes, Normal and Infinite. - * @Default {ej.Spreadsheet.scrollMode.Infinite} - */ - scrollMode?: ej.Spreadsheet.scrollMode|string; - - /** Gets or sets the value that indicates to define the height of the spreadsheet. - * @Default {100%} - */ - width?: number|string; -} - -export interface SelectionSettings { - - /** Gets or sets a value that indicates to define active cell in spreadsheet. - */ - activeCell?: string; - - /** Gets or sets a value that indicates to define animation time while selection in the Spreadsheet. - * @Default {0.001} - */ - animationTime?: number; - - /** Gets or sets a value that indicates to enable or disable animation while selection. - * @Default {false} - */ - enableAnimation?: boolean; - - /** Gets or sets a value that indicates to set selection type in Spreadsheet. It has three types which are Column, Row and Default. - * @Default {ej.Spreadsheet.SelectionType.Default} - */ - selectionType?: ej.Spreadsheet.SelectionType|string; - - /** Gets or sets a value that indicates to set selection unit in Spreadsheet. It has three types which are Single, Range and MultiRange. - * @Default {ej.Spreadsheet.SelectionUnit.MultiRange} - */ - selectionUnit?: ej.Spreadsheet.SelectionUnit|string; -} - -export interface SheetsBorder { - - /** - */ - type?: ej.Spreadsheet.BorderType|string; - - /** Specifies border color for range of cells in Spreadsheet. - */ - color?: string; - - /** To apply border for the specified range of cell. - */ - range?: string; -} - -export interface SheetsCFormatRule { - - /** Specifies the conditions to apply for the range of cells in Spreadsheet. - */ - action?: ej.Spreadsheet.CFormatRule|string; - - /** Specifies the color to apply for the range of cell while conditional formatting. - */ - color?: ej.Spreadsheet.CFormatHighlightColor|string; - - /** Specifies the inputs for conditional formatting in Spreadsheet. - * @Default {[]} - */ - inputs?: any[]; - - /** Specifies the range for conditional formatting in Spreadsheet. - */ - range?: string; -} - -export interface SheetsRangeSetting { - - /** Gets or sets the data to render the Spreadsheet. - * @Default {null} - */ - dataSource?: any; - - /** Specifies the header styles for the headers in datasource range. - * @Default {null} - */ - headerStyles?: any; - - /** Specifies the primary key for the datasource in Spreadsheet. - */ - primaryKey?: string; - - /** Specifies the query for the datasource in Spreadsheet. - * @Default {null} - */ - query?: any; - - /** Gets or sets a value that indicates whether to enable or disable the datasource header in Spreadsheet. - * @Default {true} - */ - showHeader?: boolean; - - /** Specifies the start cell for the datasource range in Spreadsheet. - * @Default {A1} - */ - startCell?: string; -} - -export interface SheetsRowsCellsComment { - - /** Get or sets the value that indicates whether to show or hide comments in Spreadsheet. - * @Default {false} - */ - isVisible?: boolean; - - /** Specifies the value for the comment in Spreadsheet. - */ - value?: string; -} - -export interface SheetsRowsCellsFormat { - - /** Specifies the number of decimal places for the given input. - * @Default {2} - */ - decimalPlaces?: number; - - /** Specifies the string format for the given input. - */ - formatStr?: string; - - /** Specifies the thousand separator for the given input. - * @Default {false} - */ - thousandSeparator?: boolean; - - /** Specifies the type of the format in Spreadsheet. - */ - type?: string; -} - -export interface SheetsRowsCellsHyperlink { - - /** Specifies the web address for the hyperlink of a cell. - */ - webAddr?: string; - - /** Specifies the cell address for the hyperlink of a cell. - */ - cellAddr?: string; - - /** Specifies the sheet index to which the cell is referred. - * @Default {1} - */ - sheetIndex?: number; -} - -export interface SheetsRowsCellsStyle { - - /** Specifies the background color of a cell in the Spreadsheet. - */ - backgroundColor?: string; - - /** Specifies the font color of a cell in the Spreadsheet. - */ - color?: string; - - /** Specifies the font weight of a cell in the Spreadsheet. - */ - fontWeight?: string; -} - -export interface SheetsRowsCell { - - /** Specifies the comment for a cell in Spreadsheet. - * @Default {null} - */ - comment?: SheetsRowsCellsComment; - - /** Specifies the format of a cell in Spreadsheet. - * @Default {null} - */ - format?: SheetsRowsCellsFormat; - - /** Specifies the hyperlink for a cell in Spreadsheet. - * @Default {null} - */ - hyperlink?: SheetsRowsCellsHyperlink; - - /** Specifies the index of a cell in Spreadsheet. - * @Default {0} - */ - index?: number; - - /** Specifies whether to lock or unlock a particular cell. - * @Default {false} - */ - isLocked?: boolean; - - /** Specifies the styles of a cell in Spreadsheet. - * @Default {null} - */ - style?: SheetsRowsCellsStyle; - - /** Specifies the value for a cell in Spreadsheet. - */ - value?: string; -} - -export interface SheetsRow { - - /** Gets or sets the height of a row in Spreadsheet. - * @Default {20} - */ - height?: number; - - /** Specifies the cells of a row in Spreadsheet. - * @Default {[]} - */ - cells?: SheetsRowsCell[]; - - /** Gets or sets the index of a row in Spreadsheet. - * @Default {0} - */ - index?: number; -} - -export interface Sheet { - - /** Specifies the border for the cell in the Spreadsheet. - * @Default {[]} - */ - border?: SheetsBorder[]; - - /** Specifies the cell types for a cell or range in Spreadsheet. - * @Default {[]} - */ - cellTypes?: any[]; - - /** Specifies the conditional formatting for the range of cell in Spreadsheet. - * @Default {[]} - */ - cFormatRule?: SheetsCFormatRule[]; - - /** Gets or sets a value that indicates to define column count in the Spreadsheet. - * @Default {21} - */ - colCount?: number; - - /** Gets or sets a value that indicates to define column width in the Spreadsheet. - * @Default {64} - */ - columnWidth?: number; - - /** Gets or sets the data to render the Spreadsheet. - * @Default {null} - */ - dataSource?: any; - - /** Gets or sets a value that indicates whether to enable or disable field as column header in the Spreadsheet. - * @Default {false} - */ - fieldAsColumnHeader?: boolean; - - /** Gets or sets a value to freeze rows in the Spreadsheet. - * @Default {0} - */ - frozenRows?: number; - - /** Gets or sets a value to freeze columns in the Spreadsheet. - * @Default {0} - */ - frozenColumns?: number; - - /** Specifies the header styles for the headers in datasource range. - * @Default {null} - */ - headerStyles?: any; - - /** To hide the specified columns in Spreadsheet. - * @Default {[]} - */ - hideColumns?: any[]; + /** Returns previous active tab header element. + */ + prevActiveHeader?: any; + + /** Returns previous active tab index. + */ + prevActiveIndex?: number; + + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; + + /** Returns the name of the event. + */ + type?: string; + + /** Returns the target element. + */ + target?: HTMLElement; + + /** Returns the cancel option value. + */ + cancel?: boolean; + } + + export interface AutoFillSettings { + + /** This property is used to set fillType unit in Spreadsheet. It has five types which are CopyCells, FillSeries, FillFormattingOnly, FillWithoutFormatting and FlashFill. + * @Default {ej.Spreadsheet.AutoFillOptions.FillSeries} + */ + fillType?: ej.Spreadsheet.AutoFillOptions | string; + + /** Gets or sets a value that indicates to enable or disable auto fill options in the Spreadsheet. + * @Default {true} + */ + showFillOptions?: boolean; + } + + export interface ChartSettings { + + /** Gets or sets a value that defines the chart height in Spreadsheet. + * @Default {220} + */ + height?: number; + + /** Gets or sets a value that defines the chart width in the Spreadsheet. + * @Default {440} + */ + width?: number; + } + + export interface ExportSettings { + + /** Gets or sets a value that indicates whether to enable or disable save feature in Spreadsheet. By enabling this feature, you can save existing Spreadsheet. + * @Default {true} + */ + allowExporting?: boolean; + + /** Gets or sets a value that indicates to define csvUrl for export to CSV format. + * @Default {null} + */ + csvUrl?: string; + + /** Gets or sets a value that indicates to define excelUrl for export to excel format. + * @Default {null} + */ + excelUrl?: string; + + /** Gets or sets a value that indicates to define password while export to excel format. + * @Default {null} + */ + password?: string; + + /** Gets or sets a value that indicates to define pdfUrl for export to PDF format. + * @Default {null} + */ + pdfUrl?: string; + } + + export interface FormatSettings { + + /** Gets or sets a value that indicates whether to enable or disable cell border feature in the Spreadsheet. + * @Default {true} + */ + allowCellBorder?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable decimal places in the Spreadsheet. + * @Default {true} + */ + allowDecimalPlaces?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable font family feature in Spreadsheet. + * @Default {true} + */ + allowFontFamily?: boolean; + } + + export interface ImportSettings { + + /** Sets import mapper to perform import feature in Spreadsheet. + */ + importMapper?: string; + + /** Gets or sets a value that indicates whether to enable or disable import while initial loading. + * @Default {false} + */ + importOnLoad?: boolean; + + /** Sets import URL to access the online files in the Spreadsheet. + */ + importUrl?: string; + + /** Gets or sets a value that indicates to define password while importing in the Spreadsheet. + */ + password?: string; + } + + export interface PictureSettings { + + /** Gets or sets a value that indicates whether to enable or disable picture feature in Spreadsheet. By enabling this, you can add pictures in Spreadsheet. + * @Default {true} + */ + allowPictures?: boolean; + + /** Gets or sets a value that indicates to define height to picture in the Spreadsheet. + * @Default {220} + */ + height?: number; + + /** Gets or sets a value that indicates to define width to picture in the Spreadsheet. + * @Default {440} + */ + width?: number; + } + + export interface PrintSettings { + + /** Gets or sets a value that indicates whether to enable or disable page setup support for printing in Spreadsheet. + * @Default {true} + */ + allowPageSetup?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable page size support for printing in Spreadsheet. + * @Default {false} + */ + allowPageSize?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable print feature in the Spreadsheet. + * @Default {true} + */ + allowPrinting?: boolean; + } + + export interface RibbonSettingsApplicationTabMenuSettings { + + /** Gets or sets a value that indicates whether to enable or disable isAppend property in ribbon settings. + * @Default {false} + */ + isAppend?: boolean; + + /** Specifies the data source to append in application tab. + * @Default {[]} + */ + dataSource?: any[]; + } + + export interface RibbonSettingsApplicationTab { + + /** Gets or sets a value that indicates to set application tab type in Spreadsheet. It has two types, Menu and Backstage. + * @Default {ej.Ribbon.ApplicationTabType.Backstage} + */ + type?: ej.Ribbon.ApplicationTabType | string; + + /** Gets or sets an object that indicates menu settings for application tab in Spreadsheet. + */ + menuSettings?: RibbonSettingsApplicationTabMenuSettings; + } + + export interface RibbonSettings { + + /** Gets or sets an object that indicates application tab settings in Spreadsheet. + */ + applicationTab?: RibbonSettingsApplicationTab; + } + + export interface ScrollSettings { + + /** Gets or sets a value that indicates whether to enable or disable scrolling in Spreadsheet. + * @Default {true} + */ + allowScrolling?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable sheet on demand. By enabling this, it render only the active sheet element while paging remaining sheets are created one by one. + * @Default {false} + */ + allowSheetOnDemand?: boolean; + + /** Gets or sets a value that indicates whether to enable or disable virtual scrolling feature in the Spreadsheet. + * @Default {true} + */ + allowVirtualScrolling?: boolean; + + /** Gets or sets the value that indicates to define the height of spreadsheet. + * @Default {100%} + */ + height?: number | string; + + /** Gets or sets the value that indicates whether to enable or disable responsive mode in the Spreadsheet. + * @Default {true} + */ + isResponsive?: boolean; + + /** Gets or sets a value that indicates to set scroll mode in Spreadsheet. It has two scroll modes, Normal and Infinite. + * @Default {ej.Spreadsheet.scrollMode.Infinite} + */ + scrollMode?: ej.Spreadsheet.scrollMode | string; + + /** Gets or sets the value that indicates to define the height of the spreadsheet. + * @Default {100%} + */ + width?: number | string; + } + + export interface SelectionSettings { + + /** Gets or sets a value that indicates to define active cell in spreadsheet. + */ + activeCell?: string; + + /** Gets or sets a value that indicates to define animation time while selection in the Spreadsheet. + * @Default {0.001} + */ + animationTime?: number; + + /** Gets or sets a value that indicates to enable or disable animation while selection. + * @Default {false} + */ + enableAnimation?: boolean; + + /** Gets or sets a value that indicates to set selection type in Spreadsheet. It has three types which are Column, Row and Default. + * @Default {ej.Spreadsheet.SelectionType.Default} + */ + selectionType?: ej.Spreadsheet.SelectionType | string; + + /** Gets or sets a value that indicates to set selection unit in Spreadsheet. It has three types which are Single, Range and MultiRange. + * @Default {ej.Spreadsheet.SelectionUnit.MultiRange} + */ + selectionUnit?: ej.Spreadsheet.SelectionUnit | string; + } + + export interface SheetsBorder { + + /** + */ + type?: ej.Spreadsheet.BorderType | string; + + /** Specifies border color for range of cells in Spreadsheet. + */ + color?: string; + + /** To apply border for the specified range of cell. + */ + range?: string; + } + + export interface SheetsCFormatRule { + + /** Specifies the conditions to apply for the range of cells in Spreadsheet. + */ + action?: ej.Spreadsheet.CFormatRule | string; + + /** Specifies the color to apply for the range of cell while conditional formatting. + */ + color?: ej.Spreadsheet.CFormatHighlightColor | string; + + /** Specifies the inputs for conditional formatting in Spreadsheet. + * @Default {[]} + */ + inputs?: any[]; + + /** Specifies the range for conditional formatting in Spreadsheet. + */ + range?: string; + } + + export interface SheetsRangeSetting { + + /** Gets or sets the data to render the Spreadsheet. + * @Default {null} + */ + dataSource?: any; + + /** Specifies the header styles for the headers in datasource range. + * @Default {null} + */ + headerStyles?: any; + + /** Specifies the primary key for the datasource in Spreadsheet. + */ + primaryKey?: string; + + /** Specifies the query for the datasource in Spreadsheet. + * @Default {null} + */ + query?: any; + + /** Gets or sets a value that indicates whether to enable or disable the datasource header in Spreadsheet. + * @Default {true} + */ + showHeader?: boolean; + + /** Specifies the start cell for the datasource range in Spreadsheet. + * @Default {A1} + */ + startCell?: string; + } + + export interface SheetsRowsCellsComment { + + /** Get or sets the value that indicates whether to show or hide comments in Spreadsheet. + * @Default {false} + */ + isVisible?: boolean; + + /** Specifies the value for the comment in Spreadsheet. + */ + value?: string; + } + + export interface SheetsRowsCellsFormat { + + /** Specifies the number of decimal places for the given input. + * @Default {2} + */ + decimalPlaces?: number; + + /** Specifies the string format for the given input. + */ + formatStr?: string; + + /** Specifies the thousand separator for the given input. + * @Default {false} + */ + thousandSeparator?: boolean; + + /** Specifies the type of the format in Spreadsheet. + */ + type?: string; + } + + export interface SheetsRowsCellsHyperlink { + + /** Specifies the web address for the hyperlink of a cell. + */ + webAddr?: string; + + /** Specifies the cell address for the hyperlink of a cell. + */ + cellAddr?: string; + + /** Specifies the sheet index to which the cell is referred. + * @Default {1} + */ + sheetIndex?: number; + } + + export interface SheetsRowsCellsStyle { + + /** Specifies the background color of a cell in the Spreadsheet. + */ + backgroundColor?: string; + + /** Specifies the font color of a cell in the Spreadsheet. + */ + color?: string; + + /** Specifies the font weight of a cell in the Spreadsheet. + */ + fontWeight?: string; + } + + export interface SheetsRowsCell { + + /** Specifies the comment for a cell in Spreadsheet. + * @Default {null} + */ + comment?: SheetsRowsCellsComment; + + /** Specifies the format of a cell in Spreadsheet. + * @Default {null} + */ + format?: SheetsRowsCellsFormat; + + /** Specifies the hyperlink for a cell in Spreadsheet. + * @Default {null} + */ + hyperlink?: SheetsRowsCellsHyperlink; + + /** Specifies the index of a cell in Spreadsheet. + * @Default {0} + */ + index?: number; + + /** Specifies whether to lock or unlock a particular cell. + * @Default {false} + */ + isLocked?: boolean; + + /** Specifies the styles of a cell in Spreadsheet. + * @Default {null} + */ + style?: SheetsRowsCellsStyle; + + /** Specifies the value for a cell in Spreadsheet. + */ + value?: string; + } + + export interface SheetsRow { + + /** Gets or sets the height of a row in Spreadsheet. + * @Default {20} + */ + height?: number; + + /** Specifies the cells of a row in Spreadsheet. + * @Default {[]} + */ + cells?: SheetsRowsCell[]; + + /** Gets or sets the index of a row in Spreadsheet. + * @Default {0} + */ + index?: number; + } + + export interface Sheet { + + /** Specifies the border for the cell in the Spreadsheet. + * @Default {[]} + */ + border?: SheetsBorder[]; + + /** Specifies the cell types for a cell or range in Spreadsheet. + * @Default {[]} + */ + cellTypes?: any[]; + + /** Specifies the conditional formatting for the range of cell in Spreadsheet. + * @Default {[]} + */ + cFormatRule?: SheetsCFormatRule[]; + + /** Gets or sets a value that indicates to define column count in the Spreadsheet. + * @Default {21} + */ + colCount?: number; + + /** Gets or sets a value that indicates to define column width in the Spreadsheet. + * @Default {64} + */ + columnWidth?: number; + + /** Gets or sets the data to render the Spreadsheet. + * @Default {null} + */ + dataSource?: any; + + /** Gets or sets a value that indicates whether to enable or disable field as column header in the Spreadsheet. + * @Default {false} + */ + fieldAsColumnHeader?: boolean; + + /** Gets or sets a value to freeze rows in the Spreadsheet. + * @Default {0} + */ + frozenRows?: number; + + /** Gets or sets a value to freeze columns in the Spreadsheet. + * @Default {0} + */ + frozenColumns?: number; + + /** Specifies the header styles for the headers in datasource range. + * @Default {null} + */ + headerStyles?: any; + + /** To hide the specified columns in Spreadsheet. + * @Default {[]} + */ + hideColumns?: any[]; - /** To hide the specified rows in Spreadsheet. - * @Default {[]} - */ - hideRows?: any[]; + /** To hide the specified rows in Spreadsheet. + * @Default {[]} + */ + hideRows?: any[]; - /** To merge specified ranges in Spreadsheet. - * @Default {[]} - */ - mergeCells?: any[]; + /** To merge specified ranges in Spreadsheet. + * @Default {[]} + */ + mergeCells?: any[]; - /** Specifies the primary key for the datasource in Spreadsheet. - */ - primaryKey?: string; + /** Specifies the primary key for the datasource in Spreadsheet. + */ + primaryKey?: string; - /** Specifies the query for the dataSource in Spreadsheet. - * @Default {null} - */ - query?: any; + /** Specifies the query for the dataSource in Spreadsheet. + * @Default {null} + */ + query?: any; - /** Specifies single range or multiple range settings for a sheet in Spreadsheet. - * @Default {[]} - */ - rangeSettings?: SheetsRangeSetting[]; + /** Specifies single range or multiple range settings for a sheet in Spreadsheet. + * @Default {[]} + */ + rangeSettings?: SheetsRangeSetting[]; - /** Gets or sets a value that indicates to define row count in the Spreadsheet. - * @Default {20} - */ - rowCount?: number; + /** Gets or sets a value that indicates to define row count in the Spreadsheet. + * @Default {20} + */ + rowCount?: number; - /** Specifies the rows for a sheet in Spreadsheet. - * @Default {[]} - */ - rows?: SheetsRow[]; + /** Specifies the rows for a sheet in Spreadsheet. + * @Default {[]} + */ + rows?: SheetsRow[]; - /** Gets or sets a value that indicates whether to show or hide grid lines in the Spreadsheet. - * @Default {true} - */ - showGridlines?: boolean; + /** Gets or sets a value that indicates whether to show or hide grid lines in the Spreadsheet. + * @Default {true} + */ + showGridlines?: boolean; - /** Gets or sets a value that indicates whether to enable or disable the datasource header in Spreadsheet. - * @Default {true} - */ - showHeader?: boolean; + /** Gets or sets a value that indicates whether to enable or disable the datasource header in Spreadsheet. + * @Default {true} + */ + showHeader?: boolean; - /** Gets or sets a value that indicates whether to show or hide headings in the Spreadsheet. - * @Default {true} - */ - showHeadings?: boolean; + /** Gets or sets a value that indicates whether to show or hide headings in the Spreadsheet. + * @Default {true} + */ + showHeadings?: boolean; - /** Specifies the start cell for the datasource range in Spreadsheet. - * @Default {A1} - */ - startCell?: string; -} + /** Specifies the start cell for the datasource range in Spreadsheet. + * @Default {A1} + */ + startCell?: string; + } -enum AutoFillOptions { + enum AutoFillOptions { - ///Specifies the CopyCells property in AutoFillOptions. - CopyCells, + ///Specifies the CopyCells property in AutoFillOptions. + CopyCells, - ///Specifies the FillSeries property in AutoFillOptions. - FillSeries, + ///Specifies the FillSeries property in AutoFillOptions. + FillSeries, - ///Specifies the FillFormattingOnly property in AutoFillOptions. - FillFormattingOnly, + ///Specifies the FillFormattingOnly property in AutoFillOptions. + FillFormattingOnly, - ///Specifies the FillWithoutFormatting property in AutoFillOptions. - FillWithoutFormatting, + ///Specifies the FillWithoutFormatting property in AutoFillOptions. + FillWithoutFormatting, - ///Specifies the FlashFill property in AutoFillOptions. - FlashFill -} + ///Specifies the FlashFill property in AutoFillOptions. + FlashFill + } -enum scrollMode { + enum scrollMode { - ///To enable Infinite scroll mode for Spreadsheet. - Infinite, + ///To enable Infinite scroll mode for Spreadsheet. + Infinite, - ///To enable Normal scroll mode for Spreadsheet. - Normal -} + ///To enable Normal scroll mode for Spreadsheet. + Normal + } -enum SelectionType { + enum SelectionType { - ///To select only Column in Spreadsheet. - Column, + ///To select only Column in Spreadsheet. + Column, - ///To select only Row in Spreadsheet. - Row, + ///To select only Row in Spreadsheet. + Row, - ///To select both Column/Row in Spreadsheet. - Default -} + ///To select both Column/Row in Spreadsheet. + Default + } -enum SelectionUnit { + enum SelectionUnit { - ///To enable Single selection in Spreadsheet - Single, + ///To enable Single selection in Spreadsheet + Single, - ///To enable Range selection in Spreadsheet - Range, + ///To enable Range selection in Spreadsheet + Range, - ///To enable MultiRange selection in Spreadsheet - MultiRange -} + ///To enable MultiRange selection in Spreadsheet + MultiRange + } -enum BorderType { + enum BorderType { - ///To apply top border for the given range of cell. - Top, + ///To apply top border for the given range of cell. + Top, - ///To apply left border for the given range of cell. - Left, + ///To apply left border for the given range of cell. + Left, - ///To apply right border for the given range of cell. - Right, + ///To apply right border for the given range of cell. + Right, - ///To apply bottom border for the given range of cell. - Bottom, + ///To apply bottom border for the given range of cell. + Bottom, - ///To apply outside border for the given range of cell. - OutSide, + ///To apply outside border for the given range of cell. + OutSide, - ///To apply all border for the given range of cell. - AllBorder, + ///To apply all border for the given range of cell. + AllBorder, - ///To apply thick box border for the given range of cell. - ThickBox, + ///To apply thick box border for the given range of cell. + ThickBox, - ///To apply thick bottom border for the given range of cell. - ThickBottom, + ///To apply thick bottom border for the given range of cell. + ThickBottom, - ///To apply top and bottom border for the given range of cell. - TopandBottom, + ///To apply top and bottom border for the given range of cell. + TopandBottom, - ///To apply top and thick bottom border for the given range of cell. - TopandThickBottom -} + ///To apply top and thick bottom border for the given range of cell. + TopandThickBottom + } -enum CFormatRule { + enum CFormatRule { - ///To identify greater than values in the given range of cells. - GreaterThan, + ///To identify greater than values in the given range of cells. + GreaterThan, - ///To identify less than values in the given range of cells. - LessThan, + ///To identify less than values in the given range of cells. + LessThan, - ///To identify in between values in the given range of cells. - Between, + ///To identify in between values in the given range of cells. + Between, - ///To identify the equal values in the given range of cells. - EqualTo, + ///To identify the equal values in the given range of cells. + EqualTo, - ///To identify the specified text in the range of cells. - TextContains, + ///To identify the specified text in the range of cells. + TextContains, - ///To identify the specified date in the range of cells. - DateOccurs -} + ///To identify the specified date in the range of cells. + DateOccurs + } -enum CFormatHighlightColor { + enum CFormatHighlightColor { - ///Highlights red with dark red text color. - RedFillwithDarkRedText, + ///Highlights red with dark red text color. + RedFillwithDarkRedText, - ///Highlights yellow with dark yellow text color. - YellowFillwithDarkYellowText, + ///Highlights yellow with dark yellow text color. + YellowFillwithDarkYellowText, - ///Highlights green with dark green text color. - GreenFillwithDarkGreenText, + ///Highlights green with dark green text color. + GreenFillwithDarkGreenText, - ///Highlights with red fill. - RedFill, + ///Highlights with red fill. + RedFill, - ///Highlights with red text. - RedText -} + ///Highlights with red text. + RedText + } -enum ChartProperties { + enum ChartProperties { - ///Specifies to make the data label center of the chart. - DataLabelCenter, + ///Specifies to make the data label center of the chart. + DataLabelCenter, - ///Specifies to make the data label inside base of the chart. - DataLabelInsideBase, + ///Specifies to make the data label inside base of the chart. + DataLabelInsideBase, - ///Specifies to make the data label inside end of the chart. - DataLabelInsideEnd, + ///Specifies to make the data label inside end of the chart. + DataLabelInsideEnd, - ///Specifies to make the data label none of the chart. - DataLabelNone, + ///Specifies to make the data label none of the chart. + DataLabelNone, - ///Specifies to make the data label outside end of the chart. - DataLabelOutsideEnd, + ///Specifies to make the data label outside end of the chart. + DataLabelOutsideEnd, - ///Specifies to make the legends to bottom of the chart. - LegendsBottom, + ///Specifies to make the legends to bottom of the chart. + LegendsBottom, - ///Specifies to make the legends to left of the chart. - LegendsLeft, + ///Specifies to make the legends to left of the chart. + LegendsLeft, - ///Specifies to make the legends to none of the chart. - LegendsNone, + ///Specifies to make the legends to none of the chart. + LegendsNone, - ///Specifies to make the legends to right of the chart. - LegendsRight, + ///Specifies to make the legends to right of the chart. + LegendsRight, - ///Specifies to make the legends to top of the chart. - LegendsTop, + ///Specifies to make the legends to top of the chart. + LegendsTop, - ///To set the primary horizontal of the chart. - PrimaryHorizontal, + ///To set the primary horizontal of the chart. + PrimaryHorizontal, - ///To set the primary horizontal axis title of the chart. - PrimaryHorizontalAxisTitle, + ///To set the primary horizontal axis title of the chart. + PrimaryHorizontalAxisTitle, - ///To set the primary major horizontal of the chart. - PrimaryMajorHorizontal, + ///To set the primary major horizontal of the chart. + PrimaryMajorHorizontal, - ///To set the primary major vertical of the chart. - PrimaryMajorVertical, + ///To set the primary major vertical of the chart. + PrimaryMajorVertical, - ///To set the primary minor horizontal of the chart. - PrimaryMinorHorizontal, + ///To set the primary minor horizontal of the chart. + PrimaryMinorHorizontal, - ///To set the primary minor vertical of the chart. - PrimaryMinorVertical, + ///To set the primary minor vertical of the chart. + PrimaryMinorVertical, - ///To set the primary vertical of the chart. - PrimaryVertical, + ///To set the primary vertical of the chart. + PrimaryVertical, - ///To set the primary vertical axis title of the chart. - PrimaryVerticalAxisTitle, + ///To set the primary vertical axis title of the chart. + PrimaryVerticalAxisTitle, - ///Specifies to make the title to center of the chart. - TitleCenter, + ///Specifies to make the title to center of the chart. + TitleCenter, - ///Specifies to make the title to far of the chart. - TitleFar, + ///Specifies to make the title to far of the chart. + TitleFar, - ///Specifies to make the title to near of the chart. - TitleNear, + ///Specifies to make the title to near of the chart. + TitleNear, - ///Specifies to make the title to none of the chart. - TitleNone -} + ///Specifies to make the title to none of the chart. + TitleNone + } -} + } -class PdfViewer extends ej.Widget { - static fn: PdfViewer; - constructor(element: JQuery | Element, options?: PdfViewer.Model); - static Locale: any; - model: PdfViewer.Model; - defaults: PdfViewer.Model; + class PdfViewer extends ej.Widget { + static fn: PdfViewer; + constructor(element: JQuery | Element, options?: PdfViewer.Model); + static Locale: any; + model: PdfViewer.Model; + defaults: PdfViewer.Model; - /** Loads the document with the filename and displays it in PDF viewer. - * @param {string} File name to be loaded - * @returns {void} - */ - load(fileName: string): void; + /** Loads the document with the filename and displays it in PDF viewer. + * @param {string} File name to be loaded + * @returns {void} + */ + load(fileName: string): void; - /** Shows/hides the toolbar in the PDF viewer. - * @param {boolean} shows/hides the toolbar - * @returns {void} - */ - showToolbar(show: boolean): void; + /** Shows/hides the toolbar in the PDF viewer. + * @param {boolean} shows/hides the toolbar + * @returns {void} + */ + showToolbar(show: boolean): void; - /** Prints the PDF document. - * @returns {void} - */ - print(): void; + /** Prints the PDF document. + * @returns {void} + */ + print(): void; - /** Abort the printing function and restores the PDF viewer. - * @returns {void} - */ - abortPrint(): void; - - /** Shows/hides the print icon in the toolbar. - * @param {boolean} shows/hides print button in the toolbar - * @returns {void} - */ - showPrintTools(show: boolean): void; - - /** Downloads the PDF document being loaded in the ejPdfViewer control. - * @returns {void} - */ - download(): void; - - /** Shows/hides the download tool in the toolbar. - * @param {boolean} shows/hides download button in the toolbar - * @returns {void} - */ - showDownloadTool(show: boolean): void; - - /** Shows/hides the page navigation tools in the toolbar - * @param {boolean} shows/hides navigation tools in the toolbar - * @returns {void} - */ - showPageNavigationTools(show: boolean): void; - - /** Navigates to the specific page in the PDF document. If the page is not available for the given pageNumber, PDF viewer retains the existing page in view. - * @param {number} navigates to the page number in the PDF document - * @returns {void} - */ - goToPage(pageNumber: number): void; - - /** Navigates to the last page of the PDF document. - * @returns {void} - */ - goToLastPage(): void; - - /** Navigates to the first page of PDF document. - * @returns {void} - */ - goToFirstPage(): void; - - /** Navigates to the next page of the PDF document. - * @returns {void} - */ - goToNextPage(): void; - - /** Navigates to the previous page of the PDF document. - * @returns {void} - */ - goToPreviousPage(): void; - - /** Shows/hides the zoom tools in the toolbar. - * @param {boolean} shows/hides zoom tools in the toolbar - * @returns {void} - */ - showMagnificationTools(show: boolean): void; - - /** Scales the page to fit the page in the container in the control. - * @returns {void} - */ - fitToPage(): void; - - /** Scales the page to fit the page width to the width of the container in the control. - * @returns {void} - */ - fitToWidth(): void; - - /** Magnifies the page to the next value in the zoom drop down list. - * @returns {void} - */ - zoomIn(): void; - - /** Shrinks the page to the previous value in the magnification in the drop down list. - * @returns {void} - */ - zoomOut(): void; - - /** Scales the page to the specified percentage ranging from 50 to 400. If the given zoomValue is less than 50 or greater than 400; the PDF viewer scales the page to 50 and 400 respectively. - * @param {number} zoom value for scaling the pages in the PDF Viewer - * @returns {void} - */ - zoomTo(zoomValue: number): void; - - /** Unloads the PDF document being displayed in the PDF viewer. - * @returns {void} - */ - unload(): void; -} -export namespace PdfViewer { - -export interface Model { - - /** Specifies the locale information of the PDF viewer. - */ - locale?: string; - - /** Specifies the toolbar settings. - */ - toolbarSettings?: ToolbarSettings; - - /** Specifies the name of the action method in the server. - */ - serverActionSettings?: ServerActionSettings; - - /** Sets the PDF Web API service URL - */ - serviceUrl?: string; - - /** Sets the PDF document path for initial loading. - */ - documentPath?: string; - - /** Gets the total number of pages in PDF document. - */ - pageCount?: number; - - /** Gets the number of the page being displayed in the PDF viewer. - */ - currentPageNumber?: number; - - /** Gets the current zoom percentage of the PDF document in viewer. - */ - zoomPercentage?: number; + /** Abort the printing function and restores the PDF viewer. + * @returns {void} + */ + abortPrint(): void; + + /** Shows/hides the print icon in the toolbar. + * @param {boolean} shows/hides print button in the toolbar + * @returns {void} + */ + showPrintTools(show: boolean): void; + + /** Downloads the PDF document being loaded in the ejPdfViewer control. + * @returns {void} + */ + download(): void; + + /** Shows/hides the download tool in the toolbar. + * @param {boolean} shows/hides download button in the toolbar + * @returns {void} + */ + showDownloadTool(show: boolean): void; + + /** Shows/hides the page navigation tools in the toolbar + * @param {boolean} shows/hides navigation tools in the toolbar + * @returns {void} + */ + showPageNavigationTools(show: boolean): void; + + /** Navigates to the specific page in the PDF document. If the page is not available for the given pageNumber, PDF viewer retains the existing page in view. + * @param {number} navigates to the page number in the PDF document + * @returns {void} + */ + goToPage(pageNumber: number): void; + + /** Navigates to the last page of the PDF document. + * @returns {void} + */ + goToLastPage(): void; + + /** Navigates to the first page of PDF document. + * @returns {void} + */ + goToFirstPage(): void; + + /** Navigates to the next page of the PDF document. + * @returns {void} + */ + goToNextPage(): void; + + /** Navigates to the previous page of the PDF document. + * @returns {void} + */ + goToPreviousPage(): void; + + /** Shows/hides the zoom tools in the toolbar. + * @param {boolean} shows/hides zoom tools in the toolbar + * @returns {void} + */ + showMagnificationTools(show: boolean): void; + + /** Scales the page to fit the page in the container in the control. + * @returns {void} + */ + fitToPage(): void; + + /** Scales the page to fit the page width to the width of the container in the control. + * @returns {void} + */ + fitToWidth(): void; + + /** Magnifies the page to the next value in the zoom drop down list. + * @returns {void} + */ + zoomIn(): void; + + /** Shrinks the page to the previous value in the magnification in the drop down list. + * @returns {void} + */ + zoomOut(): void; + + /** Scales the page to the specified percentage ranging from 50 to 400. If the given zoomValue is less than 50 or greater than 400; the PDF viewer scales the page to 50 and 400 respectively. + * @param {number} zoom value for scaling the pages in the PDF Viewer + * @returns {void} + */ + zoomTo(zoomValue: number): void; + + /** Unloads the PDF document being displayed in the PDF viewer. + * @returns {void} + */ + unload(): void; + } + export namespace PdfViewer { + + export interface Model { + + /** Specifies the locale information of the PDF viewer. + */ + locale?: string; + + /** Specifies the toolbar settings. + */ + toolbarSettings?: ToolbarSettings; + + /** Specifies the name of the action method in the server. + */ + serverActionSettings?: ServerActionSettings; + + /** Sets the PDF Web API service URL + */ + serviceUrl?: string; + + /** Sets the PDF document path for initial loading. + */ + documentPath?: string; + + /** Gets the total number of pages in PDF document. + */ + pageCount?: number; + + /** Gets the number of the page being displayed in the PDF viewer. + */ + currentPageNumber?: number; + + /** Gets the current zoom percentage of the PDF document in viewer. + */ + zoomPercentage?: number; - /** Specifies the location of the supporting PDF service - */ - pdfService?: ej.PdfViewer.PdfService|string; + /** Specifies the location of the supporting PDF service + */ + pdfService?: ej.PdfViewer.PdfService | string; - /** Specifies the open state of the hyperlink in the PDF document. - */ - hyperlinkOpenState?: ej.PdfViewer.LinkTarget|string; + /** Specifies the open state of the hyperlink in the PDF document. + */ + hyperlinkOpenState?: ej.PdfViewer.LinkTarget | string; - /** Enables or disables the hyperlinks in PDF document. - */ - enableHyperlink?: boolean; + /** Enables or disables the hyperlinks in PDF document. + */ + enableHyperlink?: boolean; - /** Enables or disables the text selection in PDF document. - */ - enableTextSelection?: boolean; + /** Enables or disables the text selection in PDF document. + */ + enableTextSelection?: boolean; - /** Enables or disables the responsiveness of the PDF viewer control during the window resize. - */ - isResponsive?: boolean; + /** Enables or disables the responsiveness of the PDF viewer control during the window resize. + */ + isResponsive?: boolean; - /** Checks whether the PDF document is edited. - */ - isDocumentEdited?: boolean; + /** Checks whether the PDF document is edited. + */ + isDocumentEdited?: boolean; - /** Enables or disables the buffering of the PDF pages in the client side. - */ - allowClientBuffering?: boolean; + /** Enables or disables the buffering of the PDF pages in the client side. + */ + allowClientBuffering?: boolean; - /** Gets the name of the PDF document which loaded in the ejPdfViewer control for downloading. - */ - fileName?: string; + /** Gets the name of the PDF document which loaded in the ejPdfViewer control for downloading. + */ + fileName?: string; - /** Triggers when the PDF document gets loaded and is ready to view in the Control. */ - documentLoad?(e: DocumentLoadEventArgs): void; + /** Triggers when the PDF document gets loaded and is ready to view in the Control. */ + documentLoad?(e: DocumentLoadEventArgs): void; - /** Triggers when the PDF document gets unloaded from the PDF viewer. */ - documentUnload?(e: DocumentUnloadEventArgs): void; + /** Triggers when the PDF document gets unloaded from the PDF viewer. */ + documentUnload?(e: DocumentUnloadEventArgs): void; - /** Triggers when there is change in current page number. */ - pageChange?(e: PageChangeEventArgs): void; + /** Triggers when there is change in current page number. */ + pageChange?(e: PageChangeEventArgs): void; - /** Triggers when there is change in the magnification value. */ - zoomChange?(e: ZoomChangeEventArgs): void; + /** Triggers when there is change in the magnification value. */ + zoomChange?(e: ZoomChangeEventArgs): void; - /** Triggers when hyperlink in the PDF Document is clicked */ - hyperlinkClick?(e: HyperlinkClickEventArgs): void; + /** Triggers when hyperlink in the PDF Document is clicked */ + hyperlinkClick?(e: HyperlinkClickEventArgs): void; - /** Triggers before the printing starts. */ - beforePrint?(e: BeforePrintEventArgs): void; + /** Triggers before the printing starts. */ + beforePrint?(e: BeforePrintEventArgs): void; - /** Triggers after the printing is completed. */ - afterPrint?(e: AfterPrintEventArgs): void; + /** Triggers after the printing is completed. */ + afterPrint?(e: AfterPrintEventArgs): void; - /** Triggers when the mouse click is performed over the page of the PDF document. */ - pageClick?(e: PageClickEventArgs): void; + /** Triggers when the mouse click is performed over the page of the PDF document. */ + pageClick?(e: PageClickEventArgs): void; - /** Triggers when the client buffering process starts. */ - bufferStart?(e: BufferStartEventArgs): void; + /** Triggers when the client buffering process starts. */ + bufferStart?(e: BufferStartEventArgs): void; - /** Triggers when the client buffering process ends. */ - bufferEnd?(e: BufferEndEventArgs): void; + /** Triggers when the client buffering process ends. */ + bufferEnd?(e: BufferEndEventArgs): void; - /** Triggers when PDF viewer control is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; -} + /** Triggers when PDF viewer control is destroyed successfully. */ + destroy?(e: DestroyEventArgs): void; + } -export interface DocumentLoadEventArgs { + export interface DocumentLoadEventArgs { - /** true, if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** true, if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the PDF viewer model - */ - model?: any; + /** Returns the PDF viewer model + */ + model?: any; - /** Returns the name of the event - */ - type?: string; + /** Returns the name of the event + */ + type?: string; - /** Returns the PDF document name displaying in the PDF viewer. - */ - fileName?: string; -} + /** Returns the PDF document name displaying in the PDF viewer. + */ + fileName?: string; + } -export interface DocumentUnloadEventArgs { + export interface DocumentUnloadEventArgs { - /** true, if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** true, if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the PDF viewer model - */ - model?: any; + /** Returns the PDF viewer model + */ + model?: any; - /** Returns the name of the event - */ - type?: string; -} + /** Returns the name of the event + */ + type?: string; + } -export interface PageChangeEventArgs { + export interface PageChangeEventArgs { - /** true, if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** true, if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the PDF viewer model - */ - model?: any; + /** Returns the PDF viewer model + */ + model?: any; - /** Returns the name of the event - */ - type?: string; + /** Returns the name of the event + */ + type?: string; - /** Returns the current page number in view. - */ - currentPageNumber?: number; -} + /** Returns the current page number in view. + */ + currentPageNumber?: number; + } -export interface ZoomChangeEventArgs { + export interface ZoomChangeEventArgs { - /** true, if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** true, if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the PDF viewer model - */ - model?: any; + /** Returns the PDF viewer model + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the previous zoom percentage of the PDF viewer control - */ - previousZoomPercentage?: number; + /** Returns the previous zoom percentage of the PDF viewer control + */ + previousZoomPercentage?: number; - /** Returns the current zoom percentage of the PDF viewer control - */ - currentZoomPercentage?: number; -} + /** Returns the current zoom percentage of the PDF viewer control + */ + currentZoomPercentage?: number; + } -export interface HyperlinkClickEventArgs { + export interface HyperlinkClickEventArgs { - /** true, if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** true, if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the PDF viewer model - */ - model?: any; + /** Returns the PDF viewer model + */ + model?: any; - /** Returns the name of the event - */ - type?: string; + /** Returns the name of the event + */ + type?: string; - /** Returns the clicked hyperlink - */ - hyperlink?: string; -} + /** Returns the clicked hyperlink + */ + hyperlink?: string; + } -export interface BeforePrintEventArgs { + export interface BeforePrintEventArgs { - /** True, if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** True, if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the PDF viewer model - */ - model?: any; + /** Returns the PDF viewer model + */ + model?: any; - /** Returns the name of the event - */ - type?: string; -} + /** Returns the name of the event + */ + type?: string; + } -export interface AfterPrintEventArgs { + export interface AfterPrintEventArgs { - /** True, if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** True, if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the PDF viewer model - */ - model?: any; + /** Returns the PDF viewer model + */ + model?: any; - /** Returns the name of the event - */ - type?: string; -} + /** Returns the name of the event + */ + type?: string; + } -export interface PageClickEventArgs { + export interface PageClickEventArgs { - /** True, if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** True, if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the PDF viewer model - */ - model?: any; + /** Returns the PDF viewer model + */ + model?: any; - /** Returns the name of the event - */ - type?: string; + /** Returns the name of the event + */ + type?: string; - /** Returns the current X position - */ - offsetX?: number; + /** Returns the current X position + */ + offsetX?: number; - /** Returns the current Y position - */ - offsetY?: number; -} + /** Returns the current Y position + */ + offsetY?: number; + } -export interface BufferStartEventArgs { + export interface BufferStartEventArgs { - /** True, if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** True, if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the PDF viewer model - */ - model?: any; + /** Returns the PDF viewer model + */ + model?: any; - /** Returns the name of the event - */ - type?: string; + /** Returns the name of the event + */ + type?: string; - /** Specifies the state of the buffering - */ - isBuffering?: boolean; -} + /** Specifies the state of the buffering + */ + isBuffering?: boolean; + } -export interface BufferEndEventArgs { + export interface BufferEndEventArgs { - /** True, if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** True, if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the PDF viewer model - */ - model?: any; + /** Returns the PDF viewer model + */ + model?: any; - /** Returns the name of the event - */ - type?: string; + /** Returns the name of the event + */ + type?: string; - /** Specifies the state of the buffering - */ - isBuffering?: boolean; -} + /** Specifies the state of the buffering + */ + isBuffering?: boolean; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** True, if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** True, if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the PDF viewer model - */ - model?: any; + /** Returns the PDF viewer model + */ + model?: any; - /** Returns the name of the event - */ - type?: string; -} + /** Returns the name of the event + */ + type?: string; + } -export interface ToolbarSettings { + export interface ToolbarSettings { - /** Shows or hides the tooltip of the toolbar items. - */ - showToolTip?: boolean; + /** Shows or hides the tooltip of the toolbar items. + */ + showToolTip?: boolean; - /** Shows or hides the grouped items in the toolbar with the help of enum ej.PdfViewer.ToolbarItems - */ - toolbarItem?: ej.PdfViewer.ToolbarItems|string; -} + /** Shows or hides the grouped items in the toolbar with the help of enum ej.PdfViewer.ToolbarItems + */ + toolbarItem?: ej.PdfViewer.ToolbarItems | string; + } -export interface ServerActionSettings { + export interface ServerActionSettings { - /** Specifies the name of the action method used for loading the PDF document. - */ - load?: string; + /** Specifies the name of the action method used for loading the PDF document. + */ + load?: string; - /** Specifies the name of the action method used for uploading the PDF document to the PDF viewer control. - */ - fileUpload?: string; + /** Specifies the name of the action method used for uploading the PDF document to the PDF viewer control. + */ + fileUpload?: string; - /** Specifies the name of the action method used for printing the PDF document in the PDF viewer control. - */ - print?: string; + /** Specifies the name of the action method used for printing the PDF document in the PDF viewer control. + */ + print?: string; - /** Specifies the name of the action method used for downloading the PDF document from the PDF viewer control. - */ - download?: string; -} + /** Specifies the name of the action method used for downloading the PDF document from the PDF viewer control. + */ + download?: string; + } -enum ToolbarItems { + enum ToolbarItems { - ///Shows only magnification tools in the toolbar. - MagnificationTools, - - ///Shows only page navigation tools in the toolbar. - PageNavigationTools, + ///Shows only magnification tools in the toolbar. + MagnificationTools, + + ///Shows only page navigation tools in the toolbar. + PageNavigationTools, - ///Shows only print tool in the toolbar. - PrintTools, + ///Shows only print tool in the toolbar. + PrintTools, - ///Shows only download tool in the toolbar. - DownloadTool, + ///Shows only download tool in the toolbar. + DownloadTool, - ///Shows all the toolbar items. - All -} + ///Shows all the toolbar items. + All + } -enum PdfService { - - ///Denotes that the service is located in the local project - Local, - - ///Denotes that the service is hosted in the remote server - Remote -} - - -enum LinkTarget { - - ///Opens the hyperlink in the same tab of the browser. - Default, - - ///Opens the hyperlink in a new tab of the browser. - NewTab, - - ///Opens the hyperlink in a new window of the browser. - NewWindow -} - -} - -class SpellCheck extends ej.Widget { - static fn: SpellCheck; - constructor(element: JQuery | Element, options?: SpellCheck.Model); - static Locale: any; - model: SpellCheck.Model; - defaults: SpellCheck.Model; - - /** Open the dialog to correct the spelling of the target content. - * @returns {void} - */ - showInDialog(): void; - - /** Highlighting the error word in the target area itself and correct the spelling using the context menu. - * @returns {void} - */ - validate(): void; - - /** To get the error word highlighted string by passing the given input sentence. - * @param {string} Content to be spell check - * @param {string} Class name that contains style value to highlight the error word - * @returns {any} - */ - spellCheck(targetSentence: string, misspellWordCss: string): any; - - /** To ignore all the error word occurrences from the given input sentence. - * @param {string} Error word to ignore from the target content - * @param {string} Content to perform the ignore all operation - * @returns {any} - */ - ignoreAll(word: string, targetSentence: string): any; - - /** To ignore the error word once from the given input sentence. - * @param {string} Error word to ignore from the target content - * @param {string} Content to perform the ignore operation - * @param {number} Index of the error word present in the target content - * @returns {any} - */ - ignore(word: string, targetSentence: string, index: number): any; - - /** To change the error word once from the given input sentence. - * @param {string} Error word to change from the target content - * @param {string} Content to perform the change operation - * @param {string} Word to replace with the error word - * @param {number} Index of the error word present in the target content - * @returns {any} - */ - change(word: string, targetSentence: string, changeWord: string, index: number): any; + enum PdfService { + + ///Denotes that the service is located in the local project + Local, + + ///Denotes that the service is hosted in the remote server + Remote + } + + + enum LinkTarget { + + ///Opens the hyperlink in the same tab of the browser. + Default, + + ///Opens the hyperlink in a new tab of the browser. + NewTab, + + ///Opens the hyperlink in a new window of the browser. + NewWindow + } + + } + + class SpellCheck extends ej.Widget { + static fn: SpellCheck; + constructor(element: JQuery | Element, options?: SpellCheck.Model); + static Locale: any; + model: SpellCheck.Model; + defaults: SpellCheck.Model; + + /** Open the dialog to correct the spelling of the target content. + * @returns {void} + */ + showInDialog(): void; + + /** Highlighting the error word in the target area itself and correct the spelling using the context menu. + * @returns {void} + */ + validate(): void; + + /** To get the error word highlighted string by passing the given input sentence. + * @param {string} Content to be spell check + * @param {string} Class name that contains style value to highlight the error word + * @returns {any} + */ + spellCheck(targetSentence: string, misspellWordCss: string): any; + + /** To ignore all the error word occurrences from the given input sentence. + * @param {string} Error word to ignore from the target content + * @param {string} Content to perform the ignore all operation + * @returns {any} + */ + ignoreAll(word: string, targetSentence: string): any; + + /** To ignore the error word once from the given input sentence. + * @param {string} Error word to ignore from the target content + * @param {string} Content to perform the ignore operation + * @param {number} Index of the error word present in the target content + * @returns {any} + */ + ignore(word: string, targetSentence: string, index: number): any; + + /** To change the error word once from the given input sentence. + * @param {string} Error word to change from the target content + * @param {string} Content to perform the change operation + * @param {string} Word to replace with the error word + * @param {number} Index of the error word present in the target content + * @returns {any} + */ + change(word: string, targetSentence: string, changeWord: string, index: number): any; - /** To change all the error word occurrences from the given input sentence. - * @param {string} Error word to change from the target content - * @param {string} Content to perform the change all operation - * @param {string} Word to replace with the error word - * @returns {any} - */ - changeAll(word: string, targetSentence: string, changeWord: string): any; + /** To change all the error word occurrences from the given input sentence. + * @param {string} Error word to change from the target content + * @param {string} Content to perform the change all operation + * @param {string} Word to replace with the error word + * @returns {any} + */ + changeAll(word: string, targetSentence: string, changeWord: string): any; - /** To add the words into the custom dictionary. - * @param {string} Word to add into the dictionary file - * @returns {any} - */ - addToDictionary(customWord: string): any; -} -export namespace SpellCheck { - -export interface Model { - - /** It includes the service method path to find the error words and its suggestions also adding the custom word into the custom dictionary. - */ - dictionarySettings?: DictionarySettings; - - /** To display the error word in a customized style. - * @Default {e-errorword} - */ - misspellWordCss?: string; - - /** Sets the specific culture to the SpellCheck. - * @Default {en-US} - */ - locale?: string; - - /** To set the maximum suggestion display count. - * @Default {6} - */ - maxSuggestionCount?: number; - - /** To ignore the words from the error word consideration. - * @Default {[]} - */ - ignoreWords?: any[]; - - /** Holds all options related to the context menu settings of SpellCheck. - */ - contextMenuSettings?: ContextMenuSettings; - - /** It helps to ignore the uppercase, mixed case words, alpha numeric words, file path and email addresses based on the property values. - */ - ignoreSettings?: IgnoreSettings; - - /** When set to true, allows the spellcheck to render based upon screen size. - * @Default {true} - */ - isResponsive?: boolean; - - /** It allows to spell check the multiple target HTML element's texts and correct its error words. - * @Default {null} - */ - controlsToValidate?: string; - - /** Triggers on the success of AJAX call request. */ - actionSuccess?(e: ActionSuccessEventArgs): void; - - /** Triggers on the AJAX call request beginning. */ - actionBegin?(e: ActionBeginEventArgs): void; - - /** Triggers when the AJAX call request failure. */ - actionFailure?(e: ActionFailureEventArgs): void; - - /** Triggers when the dialog mode spell check starting. */ - start?(e: StartEventArgs): void; - - /** Triggers when the spell check operations completed through dialog mode. */ - complete?(e: CompleteEventArgs): void; - - /** Triggers before context menu opening. */ - contextOpen?(e: ContextOpenEventArgs): void; - - /** Triggers when the context menu item clicked. */ - contextClick?(e: ContextClickEventArgs): void; - - /** Triggers before the spell check dialog opens. */ - dialogBeforeOpen?(e: DialogBeforeOpenEventArgs): void; - /** Triggers after the spell check dialog opens. */ - dialogOpen?(e: DialogOpenEventArgs): void; - - /** Triggers when the spell check dialog closed. */ - dialogClose?(e: DialogCloseEventArgs): void; - - /** Triggers when the spell check control performing the spell check operations such as ignore, ignoreAll, change, changeAll and addToDictionary. */ - validating?(e: ValidatingEventArgs): void; - - /** Triggers before loading the target HTML element text into the dialog sentence area. */ - targetUpdating?(e: TargetUpdatingEventArgs): void; -} + /** To add the words into the custom dictionary. + * @param {string} Word to add into the dictionary file + * @returns {any} + */ + addToDictionary(customWord: string): any; + } + export namespace SpellCheck { + + export interface Model { + + /** It includes the service method path to find the error words and its suggestions also adding the custom word into the custom dictionary. + */ + dictionarySettings?: DictionarySettings; + + /** To display the error word in a customized style. + * @Default {e-errorword} + */ + misspellWordCss?: string; + + /** Sets the specific culture to the SpellCheck. + * @Default {en-US} + */ + locale?: string; + + /** To set the maximum suggestion display count. + * @Default {6} + */ + maxSuggestionCount?: number; + + /** To ignore the words from the error word consideration. + * @Default {[]} + */ + ignoreWords?: any[]; + + /** Holds all options related to the context menu settings of SpellCheck. + */ + contextMenuSettings?: ContextMenuSettings; + + /** It helps to ignore the uppercase, mixed case words, alpha numeric words, file path and email addresses based on the property values. + */ + ignoreSettings?: IgnoreSettings; + + /** When set to true, allows the spellcheck to render based upon screen size. + * @Default {true} + */ + isResponsive?: boolean; + + /** It allows to spell check the multiple target HTML element's texts and correct its error words. + * @Default {null} + */ + controlsToValidate?: string; + + /** Triggers on the success of AJAX call request. */ + actionSuccess?(e: ActionSuccessEventArgs): void; + + /** Triggers on the AJAX call request beginning. */ + actionBegin?(e: ActionBeginEventArgs): void; + + /** Triggers when the AJAX call request failure. */ + actionFailure?(e: ActionFailureEventArgs): void; + + /** Triggers when the dialog mode spell check starting. */ + start?(e: StartEventArgs): void; + + /** Triggers when the spell check operations completed through dialog mode. */ + complete?(e: CompleteEventArgs): void; + + /** Triggers before context menu opening. */ + contextOpen?(e: ContextOpenEventArgs): void; + + /** Triggers when the context menu item clicked. */ + contextClick?(e: ContextClickEventArgs): void; + + /** Triggers before the spell check dialog opens. */ + dialogBeforeOpen?(e: DialogBeforeOpenEventArgs): void; + /** Triggers after the spell check dialog opens. */ + dialogOpen?(e: DialogOpenEventArgs): void; + + /** Triggers when the spell check dialog closed. */ + dialogClose?(e: DialogCloseEventArgs): void; + + /** Triggers when the spell check control performing the spell check operations such as ignore, ignoreAll, change, changeAll and addToDictionary. */ + validating?(e: ValidatingEventArgs): void; + + /** Triggers before loading the target HTML element text into the dialog sentence area. */ + targetUpdating?(e: TargetUpdatingEventArgs): void; + } -export interface ActionSuccessEventArgs { + export interface ActionSuccessEventArgs { - /** Returns the error word highlighted string. - */ - resultHTML?: string; + /** Returns the error word highlighted string. + */ + resultHTML?: string; - /** Returns the error word details of the given input. - */ - errorWordDetails?: any; + /** Returns the error word details of the given input. + */ + errorWordDetails?: any; - /** Returns the request type value. - */ - requestType?: string; + /** Returns the request type value. + */ + requestType?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the SpellCheck model. - */ - model?: ej.SpellCheck.Model; + /** Returns the SpellCheck model. + */ + model?: ej.SpellCheck.Model; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface ActionBeginEventArgs { + export interface ActionBeginEventArgs { - /** Returns the input string. - */ - targetSentence?: string; + /** Returns the input string. + */ + targetSentence?: string; - /** Returns the misspellWordCss class name. - */ - misspellWordCss?: string; + /** Returns the misspellWordCss class name. + */ + misspellWordCss?: string; - /** Returns the request type value. - */ - requestType?: string; + /** Returns the request type value. + */ + requestType?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the SpellCheck model. - */ - model?: ej.SpellCheck.Model; + /** Returns the SpellCheck model. + */ + model?: ej.SpellCheck.Model; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface ActionFailureEventArgs { + export interface ActionFailureEventArgs { - /** Returns AJAX request failure error message. - */ - errorMessage?: string; + /** Returns AJAX request failure error message. + */ + errorMessage?: string; - /** Returns the request type value. - */ - requestType?: string; + /** Returns the request type value. + */ + requestType?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the SpellCheck model. - */ - model?: ej.SpellCheck.Model; + /** Returns the SpellCheck model. + */ + model?: ej.SpellCheck.Model; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface StartEventArgs { + export interface StartEventArgs { - /** Returns the input string. - */ - targetSentence?: string; + /** Returns the input string. + */ + targetSentence?: string; - /** Returns the error words details. - */ - errorWords?: any; + /** Returns the error words details. + */ + errorWords?: any; - /** Returns the request type value. - */ - requestType?: string; + /** Returns the request type value. + */ + requestType?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the SpellCheck model. - */ - model?: ej.SpellCheck.Model; + /** Returns the SpellCheck model. + */ + model?: ej.SpellCheck.Model; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface CompleteEventArgs { + export interface CompleteEventArgs { - /** Returns the error word highlighted string. - */ - resultHTML?: string; + /** Returns the error word highlighted string. + */ + resultHTML?: string; - /** Returns the request type value. - */ - requestType?: string; + /** Returns the request type value. + */ + requestType?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the SpellCheck model. - */ - model?: ej.SpellCheck.Model; + /** Returns the SpellCheck model. + */ + model?: ej.SpellCheck.Model; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface ContextOpenEventArgs { + export interface ContextOpenEventArgs { - /** Returns the selected error word. - */ - selectedErrorWord?: string; + /** Returns the selected error word. + */ + selectedErrorWord?: string; - /** Returns the request type value. - */ - requestType?: string; + /** Returns the request type value. + */ + requestType?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the SpellCheck model. - */ - model?: ej.SpellCheck.Model; + /** Returns the SpellCheck model. + */ + model?: ej.SpellCheck.Model; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface ContextClickEventArgs { + export interface ContextClickEventArgs { - /** Returns the selected error word. - */ - selectedValue?: string; + /** Returns the selected error word. + */ + selectedValue?: string; - /** Returns the selected option in the context menu. - */ - selectedOption?: string; + /** Returns the selected option in the context menu. + */ + selectedOption?: string; - /** Returns the input string. - */ - targetContent?: string; + /** Returns the input string. + */ + targetContent?: string; - /** Returns the request type value. - */ - requestType?: string; + /** Returns the request type value. + */ + requestType?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the SpellCheck model. - */ - model?: ej.SpellCheck.Model; + /** Returns the SpellCheck model. + */ + model?: ej.SpellCheck.Model; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface DialogBeforeOpenEventArgs { + export interface DialogBeforeOpenEventArgs { - /** Returns the spell check window details. - */ - spellCheckDialog?: any; + /** Returns the spell check window details. + */ + spellCheckDialog?: any; - /** Returns the request type value. - */ - requestType?: string; + /** Returns the request type value. + */ + requestType?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the SpellCheck model. - */ - model?: ej.SpellCheck.Model; + /** Returns the SpellCheck model. + */ + model?: ej.SpellCheck.Model; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface DialogOpenEventArgs { + export interface DialogOpenEventArgs { - /** Returns the target input. - */ - targetText?: string; + /** Returns the target input. + */ + targetText?: string; - /** Returns the request type value. - */ - requestType?: string; + /** Returns the request type value. + */ + requestType?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the SpellCheck model. - */ - model?: ej.SpellCheck.Model; + /** Returns the SpellCheck model. + */ + model?: ej.SpellCheck.Model; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface DialogCloseEventArgs { + export interface DialogCloseEventArgs { - /** Returns the error corrected string. - */ - updatedText?: string; + /** Returns the error corrected string. + */ + updatedText?: string; - /** Returns the request type value. - */ - requestType?: string; + /** Returns the request type value. + */ + requestType?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the SpellCheck model. - */ - model?: ej.SpellCheck.Model; + /** Returns the SpellCheck model. + */ + model?: ej.SpellCheck.Model; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface ValidatingEventArgs { + export interface ValidatingEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the error word to ignore. - */ - ignoreWord?: string; + /** Returns the error word to ignore. + */ + ignoreWord?: string; - /** Returns the target content. - */ - targetContent?: string; + /** Returns the target content. + */ + targetContent?: string; - /** Returns the index of an error word. - */ - index?: number; + /** Returns the index of an error word. + */ + index?: number; - /** Returns the SpellCheck model. - */ - model?: ej.SpellCheck.Model; + /** Returns the SpellCheck model. + */ + model?: ej.SpellCheck.Model; - /** Returns the validating request type. - */ - requestType?: string; + /** Returns the validating request type. + */ + requestType?: string; - /** Returns the name of the event. - */ - type?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the error word to change. - */ - changeableWord?: string; - - /** Returns the change word to replace the error word. - */ - changeWord?: string; - - /** Returns the custom word to add into dictionary file. - */ - customWord?: string; -} - -export interface TargetUpdatingEventArgs { - - /** Returns the previous target element value. - */ - previousElement?: any; - - /** Returns the current target element value. - */ - currentElement?: any; - - /** Returns the target html value. - */ - targetHtml?: string; - - /** Returns the cancel option value. - */ - cancel?: boolean; - - /** Returns the SpellCheck model. - */ - model?: ej.SpellCheck.Model; - - /** Returns the name of the event. - */ - type?: string; -} - -export interface DictionarySettings { - - /** The dictionaryUrl option accepts string, which is the method path to find the error words and get the suggestions to correct the errors. - */ - dictionaryUrl?: string; - - /** The customDictionaryUrl option accepts string, which is the method path to add the error word into the custom dictionary. - */ - customDictionaryUrl?: string; -} - -export interface ContextMenuSettings { - - /** When set to true, enables the context menu options available for the SpellCheck. - * @Default {true} - */ - enable?: boolean; - - /** Contains all the default context menu options that are applicable for SpellCheck. It also supports adding custom menu items. - * All the SpellCheck related context menu items are grouped under this menu collection. - * @Default {{% highlight javascript %}[{ id: IgnoreAll, text: Ignore All },{ id: AddToDictionary, text: Add To Dictionary }]{% endhighlight %}} - */ - menuItems?: any[]; -} - -export interface IgnoreSettings { - - /** When set to true, ignoring the alphanumeric words from the error word consideration. - * @Default {true} - */ - ignoreAlphaNumericWords?: string; - - /** When set to true, ignoring the Email address from the error word consideration. - * @Default {true} - */ - ignoreEmailAddress?: boolean; - - /** When set to true, ignoring the MixedCase words from the error word consideration. - * @Default {true} - */ - ignoreMixedCaseWords?: boolean; - - /** When set to true, ignoring the UpperCase words from the error word consideration. - * @Default {true} - */ - ignoreUpperCase?: boolean; - - /** When set to true, ignoring the Url from the error word consideration. - * @Default {true} - */ - ignoreUrl?: boolean; - - /** When set to true, ignoring the file address path from the error word consideration. - * @Default {true} - */ - ignoreFileNames?: boolean; -} -} - -class DocumentEditor extends ej.Widget { - static fn: DocumentEditor; - constructor(element: JQuery | Element, options?: DocumentEditor.Model); - static Locale: any; - model: DocumentEditor.Model; - defaults: DocumentEditor.Model; - - /** Loads the document from specified path using web API provided by importUrl. - * @param {string} Specifies the file path. - * @returns {void} - */ - load(path: string): void; - - /** Gets the page number of current selection in the document. - * @returns {number} - */ - getCurrentPageNumber(): number; - - /** Gets the total number of pages in the document. - * @returns {number} - */ - getPageCount(): number; - - /** Gets the text of current selection in the document. - * @returns {string} - */ - getSelectedText(): string; - - /** Gets the current zoom factor value of the document editor. - * @returns {number} - */ - getZoomFactor(): number; - - /** Scales the document editor with the specified zoom factor. The range of zoom factor should be 0.10 to 5.00 (10 - 500 %). - * @param {number} Specifies the factor for zooming. - * @returns {void} - */ - setZoomFactor(factor: number): void; - - /** Prints the document content as page by page. - * @returns {void} - */ - print(): void; - - /** Finds the first occurrence of specified text from current selection and highlights the result. If the document end is reached, find operation will occur from the document start position. - * @param {string} Specifies the text to search in a document. - * @returns {void} - */ - find(text: string): void; -} -export namespace DocumentEditor { - -export interface Model { - - /** Gets or sets an object that indicates initialization of importing and exporting documents in document editor. - */ - importExportSettings?: ImportExportSettings; - - /** Triggers when the document changes. */ - onDocumentChange?(e: OnDocumentChangeEventArgs): void; - - /** Triggers when the selection changes. */ - onSelectionChange?(e: OnSelectionChangeEventArgs): void; - - /** Triggers when the zoom factor changes. */ - onZoomFactorChange?(e: OnZoomFactorChangeEventArgs): void; - - /** Triggers when the hyperlink is clicked. */ - onRequestNavigate?(e: OnRequestNavigateEventArgs): void; -} - -export interface OnDocumentChangeEventArgs { - - /** True, if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** Returns the document editor model. - */ - model?: any; - - /** Returns the name of the event. - */ - type?: string; -} - -export interface OnSelectionChangeEventArgs { - - /** True, if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** Returns the document editor model. - */ - model?: any; - - /** Returns the name of the event. - */ - type?: string; -} - -export interface OnZoomFactorChangeEventArgs { - - /** True, if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** Returns the document editor model. - */ - model?: any; - - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the error word to change. + */ + changeableWord?: string; + + /** Returns the change word to replace the error word. + */ + changeWord?: string; + + /** Returns the custom word to add into dictionary file. + */ + customWord?: string; + } + + export interface TargetUpdatingEventArgs { + + /** Returns the previous target element value. + */ + previousElement?: any; + + /** Returns the current target element value. + */ + currentElement?: any; + + /** Returns the target html value. + */ + targetHtml?: string; + + /** Returns the cancel option value. + */ + cancel?: boolean; + + /** Returns the SpellCheck model. + */ + model?: ej.SpellCheck.Model; + + /** Returns the name of the event. + */ + type?: string; + } + + export interface DictionarySettings { + + /** The dictionaryUrl option accepts string, which is the method path to find the error words and get the suggestions to correct the errors. + */ + dictionaryUrl?: string; + + /** The customDictionaryUrl option accepts string, which is the method path to add the error word into the custom dictionary. + */ + customDictionaryUrl?: string; + } + + export interface ContextMenuSettings { + + /** When set to true, enables the context menu options available for the SpellCheck. + * @Default {true} + */ + enable?: boolean; + + /** Contains all the default context menu options that are applicable for SpellCheck. It also supports adding custom menu items. + * All the SpellCheck related context menu items are grouped under this menu collection. + * @Default {{% highlight javascript %}[{ id: IgnoreAll, text: Ignore All },{ id: AddToDictionary, text: Add To Dictionary }]{% endhighlight %}} + */ + menuItems?: any[]; + } + + export interface IgnoreSettings { + + /** When set to true, ignoring the alphanumeric words from the error word consideration. + * @Default {true} + */ + ignoreAlphaNumericWords?: string; + + /** When set to true, ignoring the Email address from the error word consideration. + * @Default {true} + */ + ignoreEmailAddress?: boolean; + + /** When set to true, ignoring the MixedCase words from the error word consideration. + * @Default {true} + */ + ignoreMixedCaseWords?: boolean; + + /** When set to true, ignoring the UpperCase words from the error word consideration. + * @Default {true} + */ + ignoreUpperCase?: boolean; + + /** When set to true, ignoring the Url from the error word consideration. + * @Default {true} + */ + ignoreUrl?: boolean; + + /** When set to true, ignoring the file address path from the error word consideration. + * @Default {true} + */ + ignoreFileNames?: boolean; + } + } + + class DocumentEditor extends ej.Widget { + static fn: DocumentEditor; + constructor(element: JQuery | Element, options?: DocumentEditor.Model); + static Locale: any; + model: DocumentEditor.Model; + defaults: DocumentEditor.Model; + + /** Loads the document from specified path using web API provided by importUrl. + * @param {string} Specifies the file path. + * @returns {void} + */ + load(path: string): void; + + /** Gets the page number of current selection in the document. + * @returns {number} + */ + getCurrentPageNumber(): number; + + /** Gets the total number of pages in the document. + * @returns {number} + */ + getPageCount(): number; + + /** Gets the text of current selection in the document. + * @returns {string} + */ + getSelectedText(): string; + + /** Gets the current zoom factor value of the document editor. + * @returns {number} + */ + getZoomFactor(): number; + + /** Scales the document editor with the specified zoom factor. The range of zoom factor should be 0.10 to 5.00 (10 - 500 %). + * @param {number} Specifies the factor for zooming. + * @returns {void} + */ + setZoomFactor(factor: number): void; + + /** Prints the document content as page by page. + * @returns {void} + */ + print(): void; + + /** Finds the first occurrence of specified text from current selection and highlights the result. If the document end is reached, find operation will occur from the document start position. + * @param {string} Specifies the text to search in a document. + * @returns {void} + */ + find(text: string): void; + } + export namespace DocumentEditor { + + export interface Model { + + /** Gets or sets an object that indicates initialization of importing and exporting documents in document editor. + */ + importExportSettings?: ImportExportSettings; + + /** Triggers when the document changes. */ + onDocumentChange?(e: OnDocumentChangeEventArgs): void; + + /** Triggers when the selection changes. */ + onSelectionChange?(e: OnSelectionChangeEventArgs): void; + + /** Triggers when the zoom factor changes. */ + onZoomFactorChange?(e: OnZoomFactorChangeEventArgs): void; + + /** Triggers when the hyperlink is clicked. */ + onRequestNavigate?(e: OnRequestNavigateEventArgs): void; + } + + export interface OnDocumentChangeEventArgs { + + /** True, if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** Returns the document editor model. + */ + model?: any; + + /** Returns the name of the event. + */ + type?: string; + } + + export interface OnSelectionChangeEventArgs { + + /** True, if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** Returns the document editor model. + */ + model?: any; + + /** Returns the name of the event. + */ + type?: string; + } + + export interface OnZoomFactorChangeEventArgs { + + /** True, if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** Returns the document editor model. + */ + model?: any; + + /** Returns the name of the event. + */ + type?: string; + } -export interface OnRequestNavigateEventArgs { + export interface OnRequestNavigateEventArgs { - /** true, if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** true, if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the document editor model. - */ - model?: any; + /** Returns the document editor model. + */ + model?: any; - /** Returns the link type and navigation link. - */ - hyperlink?: any; + /** Returns the link type and navigation link. + */ + hyperlink?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface ImportExportSettings { + export interface ImportExportSettings { - /** Gets or sets URL of Web API that should be used to parse the document while loading. - */ - importUrl?: string; -} -} + /** Gets or sets URL of Web API that should be used to parse the document while loading. + */ + importUrl?: string; + } + } } declare namespace ej.datavisualization { -class SymbolPalette extends ej.Widget { - static fn: SymbolPalette; - constructor(element: JQuery | Element, options?: SymbolPalette.Model); - static Locale: any; - model: SymbolPalette.Model; - defaults: SymbolPalette.Model; - - /** Add items to Palettes at runtime - * @param {string} name of the Palette - * @param {any} JSON for the new items to added in Palette - * @returns {void} - */ - addPaletteItem(paletteName: string, node: any): void; - - /** Remove items to Palettes at runtime - * @param {string} name of the Palette - * @param {any} JSON for the new node to removed in Palette - * @returns {void} - */ - removePaletteItem(paletteName: string, node: any): void; -} -export namespace SymbolPalette { - -export interface Model { - - /** Defines whether the symbols can be dragged from palette or not - * @Default {true} - */ - allowDrag?: boolean; - - /** Customizes the style of the symbol palette - * @Default {e-symbolpalette} - */ - cssClass?: string; - - /** Defines the default properties of nodes and connectors - */ - defaultSettings?: DefaultSettings; - - /** Sets the Id of the diagram, over which the symbols will be dropped - * @Default {null} - */ - diagramId?: string; - - /** Sets the height of the palette headers - * @Default {30} - */ - headerHeight?: number; - - /** Defines the height of the symbol palette - * @Default {400} - */ - height?: number; - - /** Defines the height of the palette items - * @Default {50} - */ - paletteItemHeight?: number; - - /** Defines the width of the palette items - * @Default {50} - */ - paletteItemWidth?: number; - - /** An array of JSON objects, where each object represents a node/connector - * @Default {[]} - */ - palettes?: Palette[]; - - /** Defines the preview height of the symbols - * @Default {100} - */ - previewHeight?: number; - - /** Defines the offset value to be left between the mouse cursor and symbol previews - * @Default {(110, 110)} - */ - previewOffset?: any; - - /** Defines the width of the symbol previews - * @Default {100} - */ - previewWidth?: number; - - /** Enable or disable the palette item text - * @Default {true} - */ - showPaletteItemText?: boolean; - - /** The width of the palette - * @Default {250} - */ - width?: number; - - /** Triggers when a palette item is selected or unselected */ - selectionChange?(e: SelectionChangeEventArgs): void; -} - -export interface SelectionChangeEventArgs { - - /** returns whether an element is selected or unselected - */ - changeType?: string; - - /** returns the node or connector that is selected or unselected - */ - element?: any; -} - -export interface DefaultSettings { - - /** Defines the default properties of the nodes - * @Default {null} - */ - node?: any; - - /** Defines the default properties of the connectors - * @Default {null} - */ - connector?: any; -} - -export interface Palette { - - /** Defines the name of the palette - * @Default {null} - */ - name?: string; - - /** Defines whether the palette must be in expanded state or in collapsed state - * @Default {true} - */ - expanded?: boolean; - - /** Defines the palette items - * @Default {[]} - */ - items?: any[]; -} -} - -class LinearGauge extends ej.Widget { - static fn: LinearGauge; - constructor(element: JQuery | Element, options?: LinearGauge.Model); - static Locale: any; - model: LinearGauge.Model; - defaults: LinearGauge.Model; - - /** destroy the linear gauge all events bound using this._on will be unbind automatically and bring the control to pre-init state. - * @returns {void} - */ - destroy(): void; - - /** To export Image - * @returns {void} - */ - exportImage(): void; - - /** To get Bar Distance From Scale in number - * @returns {any} - */ - getBarDistanceFromScale(): any; - - /** To get Bar Pointer Value in number - * @returns {any} - */ - getBarPointerValue(): any; - - /** To get Bar Width in number - * @returns {any} - */ - getBarWidth(): any; - - /** To get CustomLabel Angle in number - * @returns {any} - */ - getCustomLabelAngle(): any; - - /** To get CustomLabel Value in string - * @returns {any} - */ - getCustomLabelValue(): any; - - /** To get Label Angle in number - * @returns {any} - */ - getLabelAngle(): any; - - /** To get LabelPlacement in number - * @returns {any} - */ - getLabelPlacement(): any; - - /** To get LabelStyle in number - * @returns {any} - */ - getLabelStyle(): any; - - /** To get Label XDistance From Scale in number - * @returns {any} - */ - getLabelXDistanceFromScale(): any; - - /** To get PointerValue in number - * @returns {any} - */ - getLabelYDistanceFromScale(): any; - - /** To get Major Interval Value in number - * @returns {any} - */ - getMajorIntervalValue(): any; - - /** To get MarkerStyle in number - * @returns {any} - */ - getMarkerStyle(): any; - - /** To get Maximum Value in number - * @returns {any} - */ - getMaximumValue(): any; - - /** To get PointerValue in number - * @returns {any} - */ - getMinimumValue(): any; - - /** To get Minor Interval Value in number - * @returns {any} - */ - getMinorIntervalValue(): any; - - /** To get Pointer Distance From Scale in number - * @returns {any} - */ - getPointerDistanceFromScale(): any; - - /** To get PointerHeight in number - * @returns {any} - */ - getPointerHeight(): any; - - /** To get Pointer Placement in String - * @returns {any} - */ - getPointerPlacement(): any; - - /** To get PointerValue in number - * @returns {any} - */ - getPointerValue(): any; - - /** To get PointerWidth in number - * @returns {any} - */ - getPointerWidth(): any; - - /** To get Range Border Width in number - * @returns {any} - */ - getRangeBorderWidth(): any; - - /** To get Range Distance From Scale in number - * @returns {any} - */ - getRangeDistanceFromScale(): any; - - /** To get Range End Value in number - * @returns {any} - */ - getRangeEndValue(): any; - - /** To get Range End Width in number - * @returns {any} - */ - getRangeEndWidth(): any; - - /** To get Range Position in number - * @returns {any} - */ - getRangePosition(): any; - - /** To get Range Start Value in number - * @returns {any} - */ - getRangeStartValue(): any; - - /** To get Range Start Width in number - * @returns {any} - */ - getRangeStartWidth(): any; - - /** To get ScaleBarLength in number - * @returns {any} - */ - getScaleBarLength(): any; - - /** To get Scale Bar Size in number - * @returns {any} - */ - getScaleBarSize(): any; - - /** To get Scale Border Width in number - * @returns {any} - */ - getScaleBorderWidth(): any; - - /** To get Scale Direction in number - * @returns {any} - */ - getScaleDirection(): any; - - /** To get Scale Location in object - * @returns {any} - */ - getScaleLocation(): any; - - /** To get Scale Style in string - * @returns {any} - */ - getScaleStyle(): any; - - /** To get Tick Angle in number - * @returns {any} - */ - getTickAngle(): any; - - /** To get Tick Height in number - * @returns {any} - */ - getTickHeight(): any; - - /** To get getTickPlacement in number - * @returns {any} - */ - getTickPlacement(): any; - - /** To get Tick Style in string - * @returns {any} - */ - getTickStyle(): any; - - /** To get Tick Width in number - * @returns {any} - */ - getTickWidth(): any; - - /** To get get Tick XDistance From Scale in number - * @returns {any} - */ - getTickXDistanceFromScale(): any; - - /** To get Tick YDistance From Scale in number - * @returns {any} - */ - getTickYDistanceFromScale(): any; - - /** Specifies the scales. - * @returns {void} - */ - scales(): void; - - /** To set setBarDistanceFromScale - * @returns {void} - */ - setBarDistanceFromScale(): void; - - /** To set setBarPointerValue - * @returns {void} - */ - setBarPointerValue(): void; - - /** To set setBarWidth - * @returns {void} - */ - setBarWidth(): void; - - /** To set setCustomLabelAngle - * @returns {void} - */ - setCustomLabelAngle(): void; - - /** To set setCustomLabelValue - * @returns {void} - */ - setCustomLabelValue(): void; - - /** To set setLabelAngle - * @returns {void} - */ - setLabelAngle(): void; - - /** To set setLabelPlacement - * @returns {void} - */ - setLabelPlacement(): void; - - /** To set setLabelStyle - * @returns {void} - */ - setLabelStyle(): void; - - /** To set setLabelXDistanceFromScale - * @returns {void} - */ - setLabelXDistanceFromScale(): void; - - /** To set setLabelYDistanceFromScale - * @returns {void} - */ - setLabelYDistanceFromScale(): void; - - /** To set setMajorIntervalValue - * @returns {void} - */ - setMajorIntervalValue(): void; - - /** To set setMarkerStyle - * @returns {void} - */ - setMarkerStyle(): void; - - /** To set setMaximumValue - * @returns {void} - */ - setMaximumValue(): void; - - /** To set setMinimumValue - * @returns {void} - */ - setMinimumValue(): void; - - /** To set setMinorIntervalValue - * @returns {void} - */ - setMinorIntervalValue(): void; - - /** To set setPointerDistanceFromScale - * @returns {void} - */ - setPointerDistanceFromScale(): void; - - /** To set PointerHeight - * @returns {void} - */ - setPointerHeight(): void; - - /** To set setPointerPlacement - * @returns {void} - */ - setPointerPlacement(): void; - - /** To set PointerValue - * @returns {void} - */ - setPointerValue(): void; - - /** To set PointerWidth - * @returns {void} - */ - setPointerWidth(): void; - - /** To set setRangeBorderWidth - * @returns {void} - */ - setRangeBorderWidth(): void; - - /** To set setRangeDistanceFromScale - * @returns {void} - */ - setRangeDistanceFromScale(): void; - - /** To set setRangeEndValue - * @returns {void} - */ - setRangeEndValue(): void; - - /** To set setRangeEndWidth - * @returns {void} - */ - setRangeEndWidth(): void; - - /** To set setRangePosition - * @returns {void} - */ - setRangePosition(): void; - - /** To set setRangeStartValue - * @returns {void} - */ - setRangeStartValue(): void; - - /** To set setRangeStartWidth - * @returns {void} - */ - setRangeStartWidth(): void; - - /** To set setScaleBarLength - * @returns {void} - */ - setScaleBarLength(): void; - - /** To set setScaleBarSize - * @returns {void} - */ - setScaleBarSize(): void; - - /** To set setScaleBorderWidth - * @returns {void} - */ - setScaleBorderWidth(): void; - - /** To set setScaleDirection - * @returns {void} - */ - setScaleDirection(): void; - - /** To set setScaleLocation - * @returns {void} - */ - setScaleLocation(): void; - - /** To set setScaleStyle - * @returns {void} - */ - setScaleStyle(): void; - - /** To set setTickAngle - * @returns {void} - */ - setTickAngle(): void; - - /** To set setTickHeight - * @returns {void} - */ - setTickHeight(): void; - - /** To set setTickPlacement - * @returns {void} - */ - setTickPlacement(): void; - - /** To set setTickStyle - * @returns {void} - */ - setTickStyle(): void; - - /** To set setTickWidth - * @returns {void} - */ - setTickWidth(): void; - - /** To set setTickXDistanceFromScale - * @returns {void} - */ - setTickXDistanceFromScale(): void; - - /** To set setTickYDistanceFromScale - * @returns {void} - */ - setTickYDistanceFromScale(): void; -} -export namespace LinearGauge { - -export interface Model { - - /** Specifies the animationSpeed - * @Default {500} - */ - animationSpeed?: number; - - /** Specifies the backgroundColor for Linear gauge. - * @Default {null} - */ - backgroundColor?: string; - - /** Specifies the borderColor for Linear gauge. - * @Default {null} - */ - borderColor?: string; - - /** Specifies the animate state - * @Default {true} - */ - enableAnimation?: boolean; - - /** Specifies the animate state for marker pointer - * @Default {true} - */ - enableMarkerPointerAnimation?: boolean; - - /** Specifies the can resize state. - * @Default {false} - */ - isResponsive?: boolean; - - /** Specify frame of linear gauge - * @Default {null} - */ - frame?: Frame; - - /** Specifies the height of Linear gauge. - * @Default {400} - */ - height?: number; - - /** Specifies the labelColor for Linear gauge. - * @Default {null} - */ - labelColor?: string; - - /** Specifies the maximum value of Linear gauge. - * @Default {100} - */ - maximum?: number; - - /** Specifies the minimum value of Linear gauge. - * @Default {0} - */ - minimum?: number; - - /** Specifies the orientation for Linear gauge. - * @Default {Vertical} - */ - orientation?: string; - - /** Specify labelPosition value of Linear gauge See OuterCustomLabelPosition - * @Default {bottom} - */ - outerCustomLabelPosition?: ej.datavisualization.LinearGauge.OuterCustomLabelPosition|string; - - /** Specifies the pointerGradient1 for Linear gauge. - * @Default {null} - */ - pointerGradient1?: any; - - /** Specifies the pointerGradient2 for Linear gauge. - * @Default {null} - */ - pointerGradient2?: any; - - /** Specifies the read only state. - * @Default {true} - */ - readOnly?: boolean; - - /** Specifies the scales - * @Default {null} - */ - scales?: Scale[]; - - /** Specifies the theme for Linear gauge. See LinearGauge.Themes - * @Default {flatlight} - */ - theme?: ej.datavisualization.LinearGauge.Themes|string; - - /** Specifies the tick Color for Linear gauge. - * @Default {null} - */ - tickColor?: string; - - /** Specify tooltip options of linear gauge - * @Default {false} - */ - tooltip?: Tooltip; - - /** Specifies the value of the Gauge. - * @Default {0} - */ - value?: number; - - /** Specifies the width of Linear gauge. - * @Default {150} - */ - width?: number; - - /** Triggers while the bar pointer are being drawn on the gauge. */ - drawBarPointers?(e: DrawBarPointersEventArgs): void; - - /** Triggers while the customLabel are being drawn on the gauge. */ - drawCustomLabel?(e: DrawCustomLabelEventArgs): void; - - /** Triggers while the Indicator are being drawn on the gauge. */ - drawIndicators?(e: DrawIndicatorsEventArgs): void; + class SymbolPalette extends ej.Widget { + static fn: SymbolPalette; + constructor(element: JQuery | Element, options?: SymbolPalette.Model); + static Locale: any; + model: SymbolPalette.Model; + defaults: SymbolPalette.Model; + + /** Add items to Palettes at runtime + * @param {string} name of the Palette + * @param {any} JSON for the new items to added in Palette + * @returns {void} + */ + addPaletteItem(paletteName: string, node: any): void; + + /** Remove items to Palettes at runtime + * @param {string} name of the Palette + * @param {any} JSON for the new node to removed in Palette + * @returns {void} + */ + removePaletteItem(paletteName: string, node: any): void; + } + export namespace SymbolPalette { + + export interface Model { + + /** Defines whether the symbols can be dragged from palette or not + * @Default {true} + */ + allowDrag?: boolean; + + /** Customizes the style of the symbol palette + * @Default {e-symbolpalette} + */ + cssClass?: string; + + /** Defines the default properties of nodes and connectors + */ + defaultSettings?: DefaultSettings; + + /** Sets the Id of the diagram, over which the symbols will be dropped + * @Default {null} + */ + diagramId?: string; + + /** Sets the height of the palette headers + * @Default {30} + */ + headerHeight?: number; + + /** Defines the height of the symbol palette + * @Default {400} + */ + height?: number; + + /** Defines the height of the palette items + * @Default {50} + */ + paletteItemHeight?: number; + + /** Defines the width of the palette items + * @Default {50} + */ + paletteItemWidth?: number; + + /** An array of JSON objects, where each object represents a node/connector + * @Default {[]} + */ + palettes?: Palette[]; + + /** Defines the preview height of the symbols + * @Default {100} + */ + previewHeight?: number; + + /** Defines the offset value to be left between the mouse cursor and symbol previews + * @Default {(110, 110)} + */ + previewOffset?: any; + + /** Defines the width of the symbol previews + * @Default {100} + */ + previewWidth?: number; + + /** Enable or disable the palette item text + * @Default {true} + */ + showPaletteItemText?: boolean; + + /** The width of the palette + * @Default {250} + */ + width?: number; + + /** Triggers when a palette item is selected or unselected */ + selectionChange?(e: SelectionChangeEventArgs): void; + } + + export interface SelectionChangeEventArgs { + + /** returns whether an element is selected or unselected + */ + changeType?: string; + + /** returns the node or connector that is selected or unselected + */ + element?: any; + } + + export interface DefaultSettings { + + /** Defines the default properties of the nodes + * @Default {null} + */ + node?: any; + + /** Defines the default properties of the connectors + * @Default {null} + */ + connector?: any; + } + + export interface Palette { + + /** Defines the name of the palette + * @Default {null} + */ + name?: string; + + /** Defines whether the palette must be in expanded state or in collapsed state + * @Default {true} + */ + expanded?: boolean; + + /** Defines the palette items + * @Default {[]} + */ + items?: any[]; + } + } + + class LinearGauge extends ej.Widget { + static fn: LinearGauge; + constructor(element: JQuery | Element, options?: LinearGauge.Model); + static Locale: any; + model: LinearGauge.Model; + defaults: LinearGauge.Model; + + /** destroy the linear gauge all events bound using this._on will be unbind automatically and bring the control to pre-init state. + * @returns {void} + */ + destroy(): void; + + /** To export Image + * @returns {void} + */ + exportImage(): void; + + /** To get Bar Distance From Scale in number + * @returns {any} + */ + getBarDistanceFromScale(): any; + + /** To get Bar Pointer Value in number + * @returns {any} + */ + getBarPointerValue(): any; + + /** To get Bar Width in number + * @returns {any} + */ + getBarWidth(): any; + + /** To get CustomLabel Angle in number + * @returns {any} + */ + getCustomLabelAngle(): any; + + /** To get CustomLabel Value in string + * @returns {any} + */ + getCustomLabelValue(): any; + + /** To get Label Angle in number + * @returns {any} + */ + getLabelAngle(): any; + + /** To get LabelPlacement in number + * @returns {any} + */ + getLabelPlacement(): any; + + /** To get LabelStyle in number + * @returns {any} + */ + getLabelStyle(): any; + + /** To get Label XDistance From Scale in number + * @returns {any} + */ + getLabelXDistanceFromScale(): any; + + /** To get PointerValue in number + * @returns {any} + */ + getLabelYDistanceFromScale(): any; + + /** To get Major Interval Value in number + * @returns {any} + */ + getMajorIntervalValue(): any; + + /** To get MarkerStyle in number + * @returns {any} + */ + getMarkerStyle(): any; + + /** To get Maximum Value in number + * @returns {any} + */ + getMaximumValue(): any; + + /** To get PointerValue in number + * @returns {any} + */ + getMinimumValue(): any; + + /** To get Minor Interval Value in number + * @returns {any} + */ + getMinorIntervalValue(): any; + + /** To get Pointer Distance From Scale in number + * @returns {any} + */ + getPointerDistanceFromScale(): any; + + /** To get PointerHeight in number + * @returns {any} + */ + getPointerHeight(): any; + + /** To get Pointer Placement in String + * @returns {any} + */ + getPointerPlacement(): any; + + /** To get PointerValue in number + * @returns {any} + */ + getPointerValue(): any; + + /** To get PointerWidth in number + * @returns {any} + */ + getPointerWidth(): any; + + /** To get Range Border Width in number + * @returns {any} + */ + getRangeBorderWidth(): any; + + /** To get Range Distance From Scale in number + * @returns {any} + */ + getRangeDistanceFromScale(): any; + + /** To get Range End Value in number + * @returns {any} + */ + getRangeEndValue(): any; + + /** To get Range End Width in number + * @returns {any} + */ + getRangeEndWidth(): any; + + /** To get Range Position in number + * @returns {any} + */ + getRangePosition(): any; + + /** To get Range Start Value in number + * @returns {any} + */ + getRangeStartValue(): any; + + /** To get Range Start Width in number + * @returns {any} + */ + getRangeStartWidth(): any; + + /** To get ScaleBarLength in number + * @returns {any} + */ + getScaleBarLength(): any; + + /** To get Scale Bar Size in number + * @returns {any} + */ + getScaleBarSize(): any; + + /** To get Scale Border Width in number + * @returns {any} + */ + getScaleBorderWidth(): any; + + /** To get Scale Direction in number + * @returns {any} + */ + getScaleDirection(): any; + + /** To get Scale Location in object + * @returns {any} + */ + getScaleLocation(): any; + + /** To get Scale Style in string + * @returns {any} + */ + getScaleStyle(): any; + + /** To get Tick Angle in number + * @returns {any} + */ + getTickAngle(): any; + + /** To get Tick Height in number + * @returns {any} + */ + getTickHeight(): any; + + /** To get getTickPlacement in number + * @returns {any} + */ + getTickPlacement(): any; + + /** To get Tick Style in string + * @returns {any} + */ + getTickStyle(): any; + + /** To get Tick Width in number + * @returns {any} + */ + getTickWidth(): any; + + /** To get get Tick XDistance From Scale in number + * @returns {any} + */ + getTickXDistanceFromScale(): any; + + /** To get Tick YDistance From Scale in number + * @returns {any} + */ + getTickYDistanceFromScale(): any; + + /** Specifies the scales. + * @returns {void} + */ + scales(): void; + + /** To set setBarDistanceFromScale + * @returns {void} + */ + setBarDistanceFromScale(): void; + + /** To set setBarPointerValue + * @returns {void} + */ + setBarPointerValue(): void; + + /** To set setBarWidth + * @returns {void} + */ + setBarWidth(): void; + + /** To set setCustomLabelAngle + * @returns {void} + */ + setCustomLabelAngle(): void; + + /** To set setCustomLabelValue + * @returns {void} + */ + setCustomLabelValue(): void; + + /** To set setLabelAngle + * @returns {void} + */ + setLabelAngle(): void; + + /** To set setLabelPlacement + * @returns {void} + */ + setLabelPlacement(): void; + + /** To set setLabelStyle + * @returns {void} + */ + setLabelStyle(): void; + + /** To set setLabelXDistanceFromScale + * @returns {void} + */ + setLabelXDistanceFromScale(): void; + + /** To set setLabelYDistanceFromScale + * @returns {void} + */ + setLabelYDistanceFromScale(): void; + + /** To set setMajorIntervalValue + * @returns {void} + */ + setMajorIntervalValue(): void; + + /** To set setMarkerStyle + * @returns {void} + */ + setMarkerStyle(): void; + + /** To set setMaximumValue + * @returns {void} + */ + setMaximumValue(): void; + + /** To set setMinimumValue + * @returns {void} + */ + setMinimumValue(): void; + + /** To set setMinorIntervalValue + * @returns {void} + */ + setMinorIntervalValue(): void; + + /** To set setPointerDistanceFromScale + * @returns {void} + */ + setPointerDistanceFromScale(): void; + + /** To set PointerHeight + * @returns {void} + */ + setPointerHeight(): void; + + /** To set setPointerPlacement + * @returns {void} + */ + setPointerPlacement(): void; + + /** To set PointerValue + * @returns {void} + */ + setPointerValue(): void; + + /** To set PointerWidth + * @returns {void} + */ + setPointerWidth(): void; + + /** To set setRangeBorderWidth + * @returns {void} + */ + setRangeBorderWidth(): void; + + /** To set setRangeDistanceFromScale + * @returns {void} + */ + setRangeDistanceFromScale(): void; + + /** To set setRangeEndValue + * @returns {void} + */ + setRangeEndValue(): void; + + /** To set setRangeEndWidth + * @returns {void} + */ + setRangeEndWidth(): void; + + /** To set setRangePosition + * @returns {void} + */ + setRangePosition(): void; + + /** To set setRangeStartValue + * @returns {void} + */ + setRangeStartValue(): void; + + /** To set setRangeStartWidth + * @returns {void} + */ + setRangeStartWidth(): void; + + /** To set setScaleBarLength + * @returns {void} + */ + setScaleBarLength(): void; + + /** To set setScaleBarSize + * @returns {void} + */ + setScaleBarSize(): void; + + /** To set setScaleBorderWidth + * @returns {void} + */ + setScaleBorderWidth(): void; + + /** To set setScaleDirection + * @returns {void} + */ + setScaleDirection(): void; + + /** To set setScaleLocation + * @returns {void} + */ + setScaleLocation(): void; + + /** To set setScaleStyle + * @returns {void} + */ + setScaleStyle(): void; + + /** To set setTickAngle + * @returns {void} + */ + setTickAngle(): void; + + /** To set setTickHeight + * @returns {void} + */ + setTickHeight(): void; + + /** To set setTickPlacement + * @returns {void} + */ + setTickPlacement(): void; + + /** To set setTickStyle + * @returns {void} + */ + setTickStyle(): void; + + /** To set setTickWidth + * @returns {void} + */ + setTickWidth(): void; + + /** To set setTickXDistanceFromScale + * @returns {void} + */ + setTickXDistanceFromScale(): void; + + /** To set setTickYDistanceFromScale + * @returns {void} + */ + setTickYDistanceFromScale(): void; + } + export namespace LinearGauge { + + export interface Model { + + /** Specifies the animationSpeed + * @Default {500} + */ + animationSpeed?: number; + + /** Specifies the backgroundColor for Linear gauge. + * @Default {null} + */ + backgroundColor?: string; + + /** Specifies the borderColor for Linear gauge. + * @Default {null} + */ + borderColor?: string; + + /** Specifies the animate state + * @Default {true} + */ + enableAnimation?: boolean; + + /** Specifies the animate state for marker pointer + * @Default {true} + */ + enableMarkerPointerAnimation?: boolean; + + /** Specifies the can resize state. + * @Default {false} + */ + isResponsive?: boolean; + + /** Specify frame of linear gauge + * @Default {null} + */ + frame?: Frame; + + /** Specifies the height of Linear gauge. + * @Default {400} + */ + height?: number; + + /** Specifies the labelColor for Linear gauge. + * @Default {null} + */ + labelColor?: string; + + /** Specifies the maximum value of Linear gauge. + * @Default {100} + */ + maximum?: number; + + /** Specifies the minimum value of Linear gauge. + * @Default {0} + */ + minimum?: number; + + /** Specifies the orientation for Linear gauge. + * @Default {Vertical} + */ + orientation?: string; + + /** Specify labelPosition value of Linear gauge See OuterCustomLabelPosition + * @Default {bottom} + */ + outerCustomLabelPosition?: ej.datavisualization.LinearGauge.OuterCustomLabelPosition | string; + + /** Specifies the pointerGradient1 for Linear gauge. + * @Default {null} + */ + pointerGradient1?: any; + + /** Specifies the pointerGradient2 for Linear gauge. + * @Default {null} + */ + pointerGradient2?: any; + + /** Specifies the read only state. + * @Default {true} + */ + readOnly?: boolean; + + /** Specifies the scales + * @Default {null} + */ + scales?: Scale[]; + + /** Specifies the theme for Linear gauge. See LinearGauge.Themes + * @Default {flatlight} + */ + theme?: ej.datavisualization.LinearGauge.Themes | string; + + /** Specifies the tick Color for Linear gauge. + * @Default {null} + */ + tickColor?: string; + + /** Specify tooltip options of linear gauge + * @Default {false} + */ + tooltip?: Tooltip; + + /** Specifies the value of the Gauge. + * @Default {0} + */ + value?: number; + + /** Specifies the width of Linear gauge. + * @Default {150} + */ + width?: number; + + /** Triggers while the bar pointer are being drawn on the gauge. */ + drawBarPointers?(e: DrawBarPointersEventArgs): void; + + /** Triggers while the customLabel are being drawn on the gauge. */ + drawCustomLabel?(e: DrawCustomLabelEventArgs): void; + + /** Triggers while the Indicator are being drawn on the gauge. */ + drawIndicators?(e: DrawIndicatorsEventArgs): void; - /** Triggers while the label are being drawn on the gauge. */ - drawLabels?(e: DrawLabelsEventArgs): void; - - /** Triggers while the marker are being drawn on the gauge. */ - drawMarkerPointers?(e: DrawMarkerPointersEventArgs): void; + /** Triggers while the label are being drawn on the gauge. */ + drawLabels?(e: DrawLabelsEventArgs): void; + + /** Triggers while the marker are being drawn on the gauge. */ + drawMarkerPointers?(e: DrawMarkerPointersEventArgs): void; - /** Triggers while the range are being drawn on the gauge. */ - drawRange?(e: DrawRangeEventArgs): void; + /** Triggers while the range are being drawn on the gauge. */ + drawRange?(e: DrawRangeEventArgs): void; - /** Triggers while the ticks are being drawn on the gauge. */ - drawTicks?(e: DrawTicksEventArgs): void; + /** Triggers while the ticks are being drawn on the gauge. */ + drawTicks?(e: DrawTicksEventArgs): void; - /** Triggers when the gauge is initialized. */ - init?(e: InitEventArgs): void; + /** Triggers when the gauge is initialized. */ + init?(e: InitEventArgs): void; - /** Triggers while the gauge start to Load. */ - load?(e: LoadEventArgs): void; + /** Triggers while the gauge start to Load. */ + load?(e: LoadEventArgs): void; - /** Triggers when the left mouse button is clicked. */ - mouseClick?(e: MouseClickEventArgs): void; + /** Triggers when the left mouse button is clicked. */ + mouseClick?(e: MouseClickEventArgs): void; - /** Triggers when clicking and dragging the mouse pointer over the gauge pointer. */ - mouseClickMove?(e: MouseClickMoveEventArgs): void; + /** Triggers when clicking and dragging the mouse pointer over the gauge pointer. */ + mouseClickMove?(e: MouseClickMoveEventArgs): void; - /** Triggers when the mouse click is released. */ - mouseClickUp?(e: MouseClickUpEventArgs): void; + /** Triggers when the mouse click is released. */ + mouseClickUp?(e: MouseClickUpEventArgs): void; - /** Triggers while the rendering of the gauge completed. */ - renderComplete?(e: RenderCompleteEventArgs): void; -} + /** Triggers while the rendering of the gauge completed. */ + renderComplete?(e: RenderCompleteEventArgs): void; + } -export interface DrawBarPointersEventArgs { + export interface DrawBarPointersEventArgs { - /** returns the object of the gauge. - */ - object?: any; + /** returns the object of the gauge. + */ + object?: any; - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the context element - */ - context?: any; + /** returns the context element + */ + context?: any; - /** returns the startX and startY of the pointer - */ - position?: any; + /** returns the startX and startY of the pointer + */ + position?: any; - /** returns the gauge model - */ - Model?: any; + /** returns the gauge model + */ + Model?: any; - /** returns the options of the scale element. - */ - scaleElement?: any; + /** returns the options of the scale element. + */ + scaleElement?: any; - /** returns the scaleIndex to which the pointer belongs. - */ - scaleIndex?: number; + /** returns the scaleIndex to which the pointer belongs. + */ + scaleIndex?: number; - /** returns the pointer style - */ - style?: string; + /** returns the pointer style + */ + style?: string; - /** returns the current Bar pointer element. - */ - barElement?: any; + /** returns the current Bar pointer element. + */ + barElement?: any; - /** returns the index of the bar pointer. - */ - barPointerIndex?: number; + /** returns the index of the bar pointer. + */ + barPointerIndex?: number; - /** returns the value of the bar pointer. - */ - PointerValue?: number; + /** returns the value of the bar pointer. + */ + PointerValue?: number; - /** returns the name of the event - */ - type?: any; -} + /** returns the name of the event + */ + type?: any; + } -export interface DrawCustomLabelEventArgs { + export interface DrawCustomLabelEventArgs { - /** returns the object of the gauge. - */ - object?: any; + /** returns the object of the gauge. + */ + object?: any; - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the context element - */ - context?: any; + /** returns the context element + */ + context?: any; - /** returns the startX and startY of the customLabel - */ - position?: any; + /** returns the startX and startY of the customLabel + */ + position?: any; - /** returns the gauge model - */ - Model?: any; + /** returns the gauge model + */ + Model?: any; - /** returns the options of the scale element. - */ - scaleElement?: any; + /** returns the options of the scale element. + */ + scaleElement?: any; - /** returns the scaleIndex to which the pointer belongs. - */ - scaleIndex?: number; + /** returns the scaleIndex to which the pointer belongs. + */ + scaleIndex?: number; - /** returns the customLabel style - */ - style?: any; + /** returns the customLabel style + */ + style?: any; - /** returns the current customLabel element. - */ - customLabelElement?: any; + /** returns the current customLabel element. + */ + customLabelElement?: any; - /** returns the index of the customLabel. - */ - customLabelIndex?: number; + /** returns the index of the customLabel. + */ + customLabelIndex?: number; - /** returns the name of the event - */ - type?: any; -} + /** returns the name of the event + */ + type?: any; + } -export interface DrawIndicatorsEventArgs { + export interface DrawIndicatorsEventArgs { - /** returns the object of the gauge. - */ - object?: any; + /** returns the object of the gauge. + */ + object?: any; - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the context element - */ - context?: any; + /** returns the context element + */ + context?: any; - /** returns the startX and startY of the Indicator - */ - position?: any; + /** returns the startX and startY of the Indicator + */ + position?: any; - /** returns the gauge model - */ - Model?: any; + /** returns the gauge model + */ + Model?: any; - /** returns the options of the scale element. - */ - scaleElement?: any; + /** returns the options of the scale element. + */ + scaleElement?: any; - /** returns the scaleIndex to which the pointer belongs. - */ - scaleIndex?: number; + /** returns the scaleIndex to which the pointer belongs. + */ + scaleIndex?: number; - /** returns the Indicator style - */ - style?: string; + /** returns the Indicator style + */ + style?: string; - /** returns the current Indicator element. - */ - IndicatorElement?: any; + /** returns the current Indicator element. + */ + IndicatorElement?: any; - /** returns the index of the Indicator. - */ - IndicatorIndex?: number; + /** returns the index of the Indicator. + */ + IndicatorIndex?: number; - /** returns the name of the event - */ - type?: any; -} + /** returns the name of the event + */ + type?: any; + } -export interface DrawLabelsEventArgs { + export interface DrawLabelsEventArgs { - /** returns the object of the gauge. - */ - object?: any; + /** returns the object of the gauge. + */ + object?: any; - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the context element - */ - context?: any; + /** returns the context element + */ + context?: any; - /** returns the startX and startY of the label - */ - position?: any; + /** returns the startX and startY of the label + */ + position?: any; - /** returns the gauge model - */ - Model?: any; + /** returns the gauge model + */ + Model?: any; - /** returns the options of the scale element. - */ - scaleElement?: any; + /** returns the options of the scale element. + */ + scaleElement?: any; - /** returns the scaleIndex to which the label belongs. - */ - scaleIndex?: number; + /** returns the scaleIndex to which the label belongs. + */ + scaleIndex?: number; - /** returns the label style - */ - style?: string; + /** returns the label style + */ + style?: string; - /** returns the angle of the label. - */ - angle?: number; + /** returns the angle of the label. + */ + angle?: number; - /** returns the current label element. - */ - element?: any; + /** returns the current label element. + */ + element?: any; - /** returns the index of the label. - */ - index?: number; + /** returns the index of the label. + */ + index?: number; - /** returns the label value of the label. - */ - value?: number; + /** returns the label value of the label. + */ + value?: number; - /** returns the name of the event - */ - type?: any; -} + /** returns the name of the event + */ + type?: any; + } -export interface DrawMarkerPointersEventArgs { + export interface DrawMarkerPointersEventArgs { - /** returns the object of the gauge. - */ - object?: any; + /** returns the object of the gauge. + */ + object?: any; - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the context element - */ - context?: any; + /** returns the context element + */ + context?: any; - /** returns the startX and startY of the pointer - */ - position?: any; + /** returns the startX and startY of the pointer + */ + position?: any; - /** returns the gauge model - */ - Model?: any; + /** returns the gauge model + */ + Model?: any; - /** returns the options of the scale element. - */ - scaleElement?: any; + /** returns the options of the scale element. + */ + scaleElement?: any; - /** returns the scaleIndex to which the pointer belongs. - */ - scaleIndex?: number; + /** returns the scaleIndex to which the pointer belongs. + */ + scaleIndex?: number; - /** returns the ticks style - */ - style?: string; + /** returns the ticks style + */ + style?: string; - /** returns the current marker pointer element. - */ - markerElement?: any; + /** returns the current marker pointer element. + */ + markerElement?: any; - /** returns the index of the marker pointer. - */ - markerPointerIndex?: number; + /** returns the index of the marker pointer. + */ + markerPointerIndex?: number; - /** returns the value of the marker pointer. - */ - pointerValue?: number; + /** returns the value of the marker pointer. + */ + pointerValue?: number; - /** returns the angle of the marker pointer. - */ - pointerAngle?: number; + /** returns the angle of the marker pointer. + */ + pointerAngle?: number; - /** returns the name of the event - */ - type?: any; -} + /** returns the name of the event + */ + type?: any; + } -export interface DrawRangeEventArgs { + export interface DrawRangeEventArgs { - /** returns the object of the gauge. - */ - object?: any; + /** returns the object of the gauge. + */ + object?: any; - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the context element - */ - context?: any; + /** returns the context element + */ + context?: any; - /** returns the startX and startY of the range - */ - position?: any; + /** returns the startX and startY of the range + */ + position?: any; - /** returns the gauge model - */ - Model?: any; + /** returns the gauge model + */ + Model?: any; - /** returns the options of the scale element. - */ - scaleElement?: any; + /** returns the options of the scale element. + */ + scaleElement?: any; - /** returns the scaleIndex to which the pointer belongs. - */ - scaleIndex?: number; + /** returns the scaleIndex to which the pointer belongs. + */ + scaleIndex?: number; - /** returns the range style - */ - style?: string; + /** returns the range style + */ + style?: string; - /** returns the current range element. - */ - rangeElement?: any; + /** returns the current range element. + */ + rangeElement?: any; - /** returns the index of the range. - */ - rangeIndex?: number; + /** returns the index of the range. + */ + rangeIndex?: number; - /** returns the name of the event - */ - type?: any; -} + /** returns the name of the event + */ + type?: any; + } -export interface DrawTicksEventArgs { + export interface DrawTicksEventArgs { - /** returns the object of the gauge. - */ - object?: any; + /** returns the object of the gauge. + */ + object?: any; - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the context element - */ - context?: any; + /** returns the context element + */ + context?: any; - /** returns the startX and startY of the ticks - */ - position?: any; + /** returns the startX and startY of the ticks + */ + position?: any; - /** returns the gauge model - */ - Model?: any; + /** returns the gauge model + */ + Model?: any; - /** returns the options of the scale element. - */ - scaleElement?: any; + /** returns the options of the scale element. + */ + scaleElement?: any; - /** returns the scaleIndex to which the tick belongs. - */ - scaleIndex?: number; + /** returns the scaleIndex to which the tick belongs. + */ + scaleIndex?: number; - /** returns the ticks style - */ - style?: string; + /** returns the ticks style + */ + style?: string; - /** returns the angle of the tick. - */ - angle?: number; + /** returns the angle of the tick. + */ + angle?: number; - /** returns the current tick element. - */ - element?: any; + /** returns the current tick element. + */ + element?: any; - /** returns the index of the tick. - */ - index?: number; + /** returns the index of the tick. + */ + index?: number; - /** returns the tick value of the tick. - */ - value?: number; + /** returns the tick value of the tick. + */ + value?: number; - /** returns the name of the event - */ - type?: any; -} + /** returns the name of the event + */ + type?: any; + } -export interface InitEventArgs { + export interface InitEventArgs { - /** returns the object of the gauge. - */ - object?: any; + /** returns the object of the gauge. + */ + object?: any; - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the gauge model - */ - Model?: any; + /** returns the gauge model + */ + Model?: any; - /** returns the entire scale element. - */ - scaleElement?: any; + /** returns the entire scale element. + */ + scaleElement?: any; - /** returns the context element - */ - context?: any; + /** returns the context element + */ + context?: any; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface LoadEventArgs { + export interface LoadEventArgs { - /** returns the object of the gauge. - */ - object?: any; + /** returns the object of the gauge. + */ + object?: any; - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the gauge model - */ - Model?: any; + /** returns the gauge model + */ + Model?: any; - /** returns the entire scale element. - */ - scaleElement?: any; + /** returns the entire scale element. + */ + scaleElement?: any; - /** returns the context element - */ - context?: any; + /** returns the context element + */ + context?: any; - /** returns the name of the event - */ - type?: any; -} + /** returns the name of the event + */ + type?: any; + } -export interface MouseClickEventArgs { + export interface MouseClickEventArgs { - /** returns the object of the gauge. - */ - object?: any; + /** returns the object of the gauge. + */ + object?: any; - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the gauge model - */ - model?: any; + /** returns the gauge model + */ + model?: any; - /** returns the name of the event - */ - type?: any; + /** returns the name of the event + */ + type?: any; - /** returns the scale element. - */ - scaleElement?: any; + /** returns the scale element. + */ + scaleElement?: any; - /** returns the scaleIndex to which the pointer belongs. - */ - scaleIndex?: number; + /** returns the scaleIndex to which the pointer belongs. + */ + scaleIndex?: number; - /** returns the context element* @param {Object} args.markerpointer returns the context element - */ - context?: any; + /** returns the context element* @param {Object} args.markerpointer returns the context element + */ + context?: any; - /** returns the pointer Index - */ - markerpointerindex?: number; + /** returns the pointer Index + */ + markerpointerindex?: number; - /** returns the pointer element. - */ - markerpointerelement?: any; + /** returns the pointer element. + */ + markerpointerelement?: any; - /** returns the value of the pointer. - */ - markerpointervalue?: number; + /** returns the value of the pointer. + */ + markerpointervalue?: number; - /** returns the pointer style - */ - style?: string; + /** returns the pointer style + */ + style?: string; - /** returns the startX and startY of the pointer. - */ - position?: any; -} + /** returns the startX and startY of the pointer. + */ + position?: any; + } -export interface MouseClickMoveEventArgs { + export interface MouseClickMoveEventArgs { - /** returns the object of the gauge. - */ - object?: any; + /** returns the object of the gauge. + */ + object?: any; - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the gauge model - */ - model?: any; + /** returns the gauge model + */ + model?: any; - /** returns the name of the event - */ - type?: any; + /** returns the name of the event + */ + type?: any; - /** returns the scale element. - */ - scaleElement?: any; + /** returns the scale element. + */ + scaleElement?: any; - /** returns the scaleIndex to which the pointer belongs. - */ - scaleIndex?: number; + /** returns the scaleIndex to which the pointer belongs. + */ + scaleIndex?: number; - /** returns the context element - */ - context?: any; + /** returns the context element + */ + context?: any; - /** returns the pointer Index - */ - index?: number; + /** returns the pointer Index + */ + index?: number; - /** returns the pointer element. - */ - element?: any; + /** returns the pointer element. + */ + element?: any; - /** returns the value of the pointer. - */ - value?: number; + /** returns the value of the pointer. + */ + value?: number; - /** returns the pointer style - */ - style?: string; + /** returns the pointer style + */ + style?: string; - /** returns the startX and startY of the pointer. - */ - position?: any; -} + /** returns the startX and startY of the pointer. + */ + position?: any; + } -export interface MouseClickUpEventArgs { + export interface MouseClickUpEventArgs { - /** returns the object of the gauge. - */ - object?: any; + /** returns the object of the gauge. + */ + object?: any; - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the gauge model - */ - model?: any; + /** returns the gauge model + */ + model?: any; - /** returns the name of the event - */ - type?: any; + /** returns the name of the event + */ + type?: any; - /** returns the scale element. - */ - scaleElement?: any; + /** returns the scale element. + */ + scaleElement?: any; - /** returns the scaleIndex to which the pointer belongs. - */ - scaleIndex?: number; + /** returns the scaleIndex to which the pointer belongs. + */ + scaleIndex?: number; - /** returns the context element* @param {Object} args.markerpointer returns the context element - */ - context?: any; - - /** returns the pointer Index - */ - markerpointerIndex?: number; - - /** returns the pointer element. - */ - markerpointerElement?: any; - - /** returns the value of the pointer. - */ - markerpointerValue?: number; - - /** returns the pointer style - */ - style?: string; - - /** returns the startX and startY of the pointer. - */ - position?: any; -} - -export interface RenderCompleteEventArgs { - - /** returns the object of the gauge. - */ - object?: any; - - /** returns the cancel option value - */ - cancel?: boolean; - - /** returns the gauge model - */ - Model?: any; - - /** returns the entire scale element. - */ - scaleElement?: any; - - /** returns the context element - */ - context?: any; - - /** returns the name of the event - */ - type?: any; -} - -export interface Frame { - - /** Specifies the frame background image URL of linear gauge - * @Default {null} - */ - backgroundImageUrl?: string; - - /** Specifies the frame InnerWidth - * @Default {8} - */ - innerWidth?: number; - - /** Specifies the frame OuterWidth - * @Default {12} - */ - outerWidth?: number; -} - -export interface ScalesBarPointersBorder { - - /** Specifies the border Color of bar pointer - * @Default {null} - */ - color?: string; - - /** Specifies the border Width of bar pointer - * @Default {1.5} - */ - width?: number; -} - -export interface ScalesBarPointer { - - /** Specifies the backgroundColor of bar pointer - * @Default {null} - */ - backgroundColor?: string; - - /** Specifies the border of bar pointer - * @Default {null} - */ - border?: ScalesBarPointersBorder; - - /** Specifies the distanceFromScale of bar pointer - * @Default {0} - */ - distanceFromScale?: number; - - /** Specifies the scaleBar Gradient of bar pointer - * @Default {null} - */ - gradients?: any; - - /** Specifies the opacity of bar pointer - * @Default {1} - */ - opacity?: number; - - /** Specifies the value of bar pointer - * @Default {null} - */ - value?: number; - - /** Specifies the pointer Width of bar pointer - * @Default {width=30} - */ - width?: number; -} - -export interface ScalesBorder { - - /** Specifies the border color of the Scale. - * @Default {null} - */ - color?: string; - - /** Specifies the border width of the Scale. - * @Default {1.5} - */ - width?: number; -} - -export interface ScalesCustomLabelsFont { - - /** Specifies the fontFamily in customLabels - * @Default {Arial} - */ - fontFamily?: string; - - /** Specifies the fontStyle in customLabels. See FontStyle - * @Default {Bold} - */ - fontStyle?: ej.datavisualization.LinearGauge.FontStyle|string; - - /** Specifies the font size in customLabels - * @Default {11px} - */ - size?: string; -} - -export interface ScalesCustomLabelsPosition { - - /** Specifies the position x in customLabels - * @Default {0} - */ - x?: number; - - /** Specifies the y in customLabels - * @Default {0} - */ - y?: number; -} - -export interface ScalesCustomLabel { - - /** Specifies the label Color in customLabels - * @Default {null} - */ - color?: number; - - /** Specifies the font in customLabels - * @Default {null} - */ - font?: ScalesCustomLabelsFont; - - /** Specifies the opacity in customLabels - * @Default {0} - */ - opacity?: string; - - /** Specifies the position in customLabels - * @Default {null} - */ - position?: ScalesCustomLabelsPosition; - - /** Specifies the positionType in customLabels.See CustomLabelPositionType - * @Default {null} - */ - positionType?: any; - - /** Specifies the textAngle in customLabels - * @Default {0} - */ - textAngle?: number; - - /** Specifies the label Value in customLabels - */ - value?: string; -} - -export interface ScalesIndicatorsBorder { - - /** Specifies the border Color in bar indicators - * @Default {null} - */ - color?: string; - - /** Specifies the border Width in bar indicators - * @Default {1.5} - */ - width?: number; -} - -export interface ScalesIndicatorsFont { - - /** Specifies the fontFamily of font in bar indicators - * @Default {Arial} - */ - fontFamily?: string; - - /** Specifies the fontStyle of font in bar indicators. See FontStyle - * @Default {ej.datavisualization.LinearGauge.FontStyle.Bold} - */ - fontStyle?: ej.datavisualization.LinearGauge.FontStyle|string; - - /** Specifies the size of font in bar indicators - * @Default {11px} - */ - size?: string; -} - -export interface ScalesIndicatorsPosition { - - /** Specifies the x position in bar indicators - * @Default {0} - */ - x?: number; - - /** Specifies the y position in bar indicators - * @Default {0} - */ - y?: number; -} - -export interface ScalesIndicatorsStateRange { - - /** Specifies the backgroundColor in bar indicators state ranges - * @Default {null} - */ - backgroundColor?: string; - - /** Specifies the borderColor in bar indicators state ranges - * @Default {null} - */ - borderColor?: string; - - /** Specifies the endValue in bar indicators state ranges - * @Default {60} - */ - endValue?: number; - - /** Specifies the startValue in bar indicators state ranges - * @Default {50} - */ - startValue?: number; - - /** Specifies the text in bar indicators state ranges - */ - text?: string; - - /** Specifies the textColor in bar indicators state ranges - * @Default {null} - */ - textColor?: string; -} - -export interface ScalesIndicatorsTextLocation { - - /** Specifies the textLocation position in bar indicators - * @Default {0} - */ - x?: number; - - /** Specifies the Y position in bar indicators - * @Default {0} - */ - y?: number; -} - -export interface ScalesIndicator { - - /** Specifies the backgroundColor in bar indicators - * @Default {null} - */ - backgroundColor?: string; - - /** Specifies the border in bar indicators - * @Default {null} - */ - border?: ScalesIndicatorsBorder; - - /** Specifies the font of bar indicators - * @Default {null} - */ - font?: ScalesIndicatorsFont; - - /** Specifies the indicator Height of bar indicators - * @Default {30} - */ - height?: number; - - /** Specifies the opacity in bar indicators - * @Default {NaN} - */ - opacity?: number; - - /** Specifies the position in bar indicators - * @Default {null} - */ - position?: ScalesIndicatorsPosition; - - /** Specifies the state ranges in bar indicators - * @Default {Array} - */ - stateRanges?: ScalesIndicatorsStateRange[]; - - /** Specifies the textLocation in bar indicators - * @Default {null} - */ - textLocation?: ScalesIndicatorsTextLocation; - - /** Specifies the indicator Style of font in bar indicators - * @Default {ej.datavisualization.LinearGauge.IndicatorType.Rectangle} - */ - type?: ej.datavisualization.LinearGauge.IndicatorTypes|string; - - /** Specifies the indicator Width in bar indicators - * @Default {30} - */ - width?: number; -} - -export interface ScalesLabelsDistanceFromScale { - - /** Specifies the xDistanceFromScale of labels. - * @Default {-10} - */ - x?: number; - - /** Specifies the yDistanceFromScale of labels. - * @Default {0} - */ - y?: number; -} - -export interface ScalesLabelsFont { - - /** Specifies the fontFamily of font. - * @Default {Arial} - */ - fontFamily?: string; - - /** Specifies the fontStyle of font.See FontStyle - * @Default {ej.datavisualization.LinearGauge.FontStyle.Bold} - */ - fontStyle?: ej.datavisualization.LinearGauge.FontStyle|string; - - /** Specifies the size of font. - * @Default {11px} - */ - size?: string; -} - -export interface ScalesLabel { - - /** Specifies the angle of labels. - * @Default {0} - */ - angle?: number; - - /** Specifies the DistanceFromScale of labels. - * @Default {null} - */ - distanceFromScale?: ScalesLabelsDistanceFromScale; - - /** Specifies the font of labels. - * @Default {null} - */ - font?: ScalesLabelsFont; - - /** need to includeFirstValue. - * @Default {true} - */ - includeFirstValue?: boolean; - - /** Specifies the opacity of label. - * @Default {0} - */ - opacity?: number; - - /** Specifies the label Placement of label. See LabelPlacement - * @Default {Near} - */ - placement?: ej.datavisualization.LinearGauge.PointerPlacement|string; - - /** Specifies the textColor of font. - * @Default {null} - */ - textColor?: string; - - /** Specifies the label Style of label. See LabelType - * @Default {ej.datavisualization.LinearGauge.LabelType.Major} - */ - type?: ej.datavisualization.LinearGauge.ScaleType|string; - - /** Specifies the unitText of label. - */ - unitText?: string; - - /** Specifies the unitText Position of label.See UnitTextPlacement - * @Default {Back} - */ - unitTextPlacement?: ej.datavisualization.LinearGauge.UnitTextPlacement|string; -} - -export interface ScalesMarkerPointersBorder { - - /** Specifies the border color of marker pointer - * @Default {null} - */ - color?: string; - - /** Specifies the border of marker pointer - * @Default {number} - */ - width?: number; -} - -export interface ScalesMarkerPointer { - - /** Specifies the backgroundColor of marker pointer - * @Default {null} - */ - backgroundColor?: string; - - /** Specifies the border of marker pointer - * @Default {null} - */ - border?: ScalesMarkerPointersBorder; - - /** Specifies the distanceFromScale of marker pointer - * @Default {0} - */ - distanceFromScale?: number; - - /** Specifies the pointer Gradient of marker pointer - * @Default {null} - */ - gradients?: any; - - /** Specifies the pointer Length of marker pointer - * @Default {30} - */ - length?: number; - - /** Specifies the opacity of marker pointer - * @Default {1} - */ - opacity?: number; - - /** Specifies the pointer Placement of marker pointer See PointerPlacement - * @Default {Far} - */ - placement?: ej.datavisualization.LinearGauge.PointerPlacement|string; - - /** Specifies the marker Style of marker pointerSee MarkerType - * @Default {Triangle} - */ - type?: ej.datavisualization.LinearGauge.MarkerType|string; - - /** Specifies the value of marker pointer - * @Default {null} - */ - value?: number; - - /** Specifies the pointer Width of marker pointer - * @Default {30} - */ - width?: number; -} - -export interface ScalesPosition { - - /** Specifies the Horizontal position - * @Default {50} - */ - x?: number; - - /** Specifies the vertical position - * @Default {50} - */ - y?: number; -} - -export interface ScalesRangesBorder { - - /** Specifies the border color in the ranges. - * @Default {null} - */ - color?: string; - - /** Specifies the border width in the ranges. - * @Default {1.5} - */ - width?: number; -} - -export interface ScalesRange { - - /** Specifies the backgroundColor in the ranges. - * @Default {null} - */ - backgroundColor?: string; - - /** Specifies the border in the ranges. - * @Default {null} - */ - border?: ScalesRangesBorder; - - /** Specifies the distanceFromScale in the ranges. - * @Default {0} - */ - distanceFromScale?: number; - - /** Specifies the endValue in the ranges. - * @Default {60} - */ - endValue?: number; - - /** Specifies the endWidth in the ranges. - * @Default {10} - */ - endWidth?: number; - - /** Specifies the range Gradient in the ranges. - * @Default {null} - */ - gradients?: any; - - /** Specifies the opacity in the ranges. - * @Default {null} - */ - opacity?: number; - - /** Specifies the range Position in the ranges. See RangePlacement - * @Default {Center} - */ - placement?: ej.datavisualization.LinearGauge.PointerPlacement|string; - - /** Specifies the startValue in the ranges. - * @Default {20} - */ - startValue?: number; - - /** Specifies the startWidth in the ranges. - * @Default {10} - */ - startWidth?: number; -} - -export interface ScalesTicksDistanceFromScale { - - /** Specifies the xDistanceFromScale in the tick. - * @Default {0} - */ - x?: number; - - /** Specifies the yDistanceFromScale in the tick. - * @Default {0} - */ - y?: number; -} - -export interface ScalesTick { - - /** Specifies the angle in the tick. - * @Default {0} - */ - angle?: number; - - /** Specifies the tick Color in the tick. - * @Default {null} - */ - color?: string; - - /** Specifies the DistanceFromScale in the tick. - * @Default {null} - */ - distanceFromScale?: ScalesTicksDistanceFromScale; - - /** Specifies the tick Height in the tick. - * @Default {10} - */ - height?: number; - - /** Specifies the opacity in the tick. - * @Default {0} - */ - opacity?: number; - - /** Specifies the tick Placement in the tick. See TickPlacement - * @Default {Near} - */ - placement?: ej.datavisualization.LinearGauge.PointerPlacement|string; - - /** Specifies the tick Style in the tick. See TickType - * @Default {MajorInterval} - */ - type?: ej.datavisualization.LinearGauge.TicksType|string; - - /** Specifies the tick Width in the tick. - * @Default {3} - */ - width?: number; -} - -export interface Scale { - - /** Specifies the backgroundColor of the Scale. - * @Default {null} - */ - backgroundColor?: string; - - /** Specifies the scaleBar Gradient of bar pointer - * @Default {Array} - */ - barPointers?: ScalesBarPointer[]; - - /** Specifies the border of the Scale. - * @Default {null} - */ - border?: ScalesBorder; - - /** Specifies the customLabel - * @Default {Array} - */ - customLabels?: ScalesCustomLabel[]; - - /** Specifies the scale Direction of the Scale. See Directions - * @Default {CounterClockwise} - */ - direction?: ej.datavisualization.LinearGauge.Direction|string; - - /** Specifies the indicator - * @Default {Array} - */ - indicators?: ScalesIndicator[]; - - /** Specifies the labels. - * @Default {Array} - */ - labels?: ScalesLabel[]; - - /** Specifies the scaleBar Length. - * @Default {290} - */ - length?: number; - - /** Specifies the majorIntervalValue of the Scale. - * @Default {10} - */ - majorIntervalValue?: number; - - /** Specifies the markerPointers - * @Default {Array} - */ - markerPointers?: ScalesMarkerPointer[]; - - /** Specifies the maximum of the Scale. - * @Default {null} - */ - maximum?: number; - - /** Specifies the minimum of the Scale. - * @Default {null} - */ - minimum?: number; - - /** Specifies the minorIntervalValue of the Scale. - * @Default {2} - */ - minorIntervalValue?: number; - - /** Specifies the opacity of the Scale. - * @Default {NaN} - */ - opacity?: number; - - /** Specifies the position - * @Default {null} - */ - position?: ScalesPosition; - - /** Specifies the ranges in the tick. - * @Default {Array} - */ - ranges?: ScalesRange[]; - - /** Specifies the shadowOffset. - * @Default {0} - */ - shadowOffset?: number; - - /** Specifies the showBarPointers state. - * @Default {true} - */ - showBarPointers?: boolean; - - /** Specifies the showCustomLabels state. - * @Default {false} - */ - showCustomLabels?: boolean; - - /** Specifies the showIndicators state. - * @Default {false} - */ - showIndicators?: boolean; - - /** Specifies the showLabels state. - * @Default {true} - */ - showLabels?: boolean; - - /** Specifies the showMarkerPointers state. - * @Default {true} - */ - showMarkerPointers?: boolean; - - /** Specifies the showRanges state. - * @Default {false} - */ - showRanges?: boolean; - - /** Specifies the showTicks state. - * @Default {true} - */ - showTicks?: boolean; - - /** Specifies the ticks in the scale. - * @Default {Array} - */ - ticks?: ScalesTick[]; - - /** Specifies the scaleBar type .See ScaleType - * @Default {Rectangle} - */ - type?: ej.datavisualization.LinearGauge.ScaleType|string; - - /** Specifies the scaleBar width. - * @Default {30} - */ - width?: number; -} - -export interface Tooltip { - - /** Specify showCustomLabelTooltip value of linear gauge - * @Default {false} - */ - showCustomLabelTooltip?: boolean; - - /** Specify showLabelTooltip value of linear gauge - * @Default {false} - */ - showLabelTooltip?: boolean; - - /** Specify templateID value of linear gauge - * @Default {false} - */ - templateID?: string; -} -} -namespace LinearGauge { -enum OuterCustomLabelPosition { -//string -Left, -//string -Right, -//string -Top, -//string -Bottom, -} -} -namespace LinearGauge { -enum FontStyle { -//string -Bold, -//string -Italic, -//string -Regular, -//string -Strikeout, -//string -Underline, -} -} -namespace LinearGauge { -enum Direction { -//string -Clockwise, -//string -CounterClockwise, -} -} -namespace LinearGauge { -enum IndicatorTypes { -//string -Rectangle, -//string -Circle, -//string -RoundedRectangle, -//string -Text, -} -} -namespace LinearGauge { -enum PointerPlacement { -//string -Near, -//string -Far, -//string -Center, -} -} -namespace LinearGauge { -enum ScaleType { -//string -Major, -//string -Minor, -} -} -namespace LinearGauge { -enum UnitTextPlacement { -//string -Back, -//string -From, -} -} -namespace LinearGauge { -enum MarkerType { -//string -Rectangle, -//string -Triangle, -//string -Ellipse, -//string -Diamond, -//string -Pentagon, -//string -Circle, -//string -Star, -//string -Slider, -//string -Pointer, -//string -Wedge, -//string -Trapezoid, -//string -RoundedRectangle, -} -} -namespace LinearGauge { -enum TicksType { -//string -Majorinterval, -//string -Minorinterval, -} -} -namespace LinearGauge { -enum Themes { -//string -FlatLight, -//string -FlatDark, -} -} - -class CircularGauge extends ej.Widget { - static fn: CircularGauge; - constructor(element: JQuery | Element, options?: CircularGauge.Model); - static Locale: any; - model: CircularGauge.Model; - defaults: CircularGauge.Model; - - /** destroy the circular gauge widget. all events bound using this._on will be unbind automatically and bring the control to pre-init state. - * @returns {void} - */ - destroy(): void; - - /** To export Image - * @returns {boolean} - */ - exportImage(): boolean; - - /** To get BackNeedleLength - * @returns {any} - */ - getBackNeedleLength(): any; - - /** To get CustomLabelAngle - * @returns {any} - */ - getCustomLabelAngle(): any; - - /** To get CustomLabelValue - * @returns {any} - */ - getCustomLabelValue(): any; - - /** To get LabelAngle - * @returns {any} - */ - getLabelAngle(): any; - - /** To get LabelDistanceFromScale - * @returns {any} - */ - getLabelDistanceFromScale(): any; - - /** To get LabelPlacement - * @returns {any} - */ - getLabelPlacement(): any; - - /** To get LabelStyle - * @returns {any} - */ - getLabelStyle(): any; - - /** To get MajorIntervalValue - * @returns {any} - */ - getMajorIntervalValue(): any; - - /** To get MarkerDistanceFromScale - * @returns {any} - */ - getMarkerDistanceFromScale(): any; - - /** To get MarkerStyle - * @returns {any} - */ - getMarkerStyle(): any; - - /** To get MaximumValue - * @returns {any} - */ - getMaximumValue(): any; - - /** To get MinimumValue - * @returns {any} - */ - getMinimumValue(): any; - - /** To get MinorIntervalValue - * @returns {any} - */ - getMinorIntervalValue(): any; - - /** To get NeedleStyle - * @returns {any} - */ - getNeedleStyle(): any; - - /** To get PointerCapBorderWidth - * @returns {any} - */ - getPointerCapBorderWidth(): any; - - /** To get PointerCapRadius - * @returns {any} - */ - getPointerCapRadius(): any; - - /** To get PointerLength - * @returns {any} - */ - getPointerLength(): any; - - /** To get PointerNeedleType - * @returns {any} - */ - getPointerNeedleType(): any; - - /** To get PointerPlacement - * @returns {any} - */ - getPointerPlacement(): any; - - /** To get PointerValue - * @returns {any} - */ - getPointerValue(): any; - - /** To get PointerWidth - * @returns {any} - */ - getPointerWidth(): any; - - /** To get RangeBorderWidth - * @returns {any} - */ - getRangeBorderWidth(): any; - - /** To get RangeDistanceFromScale - * @returns {any} - */ - getRangeDistanceFromScale(): any; - - /** To get RangeEndValue - * @returns {any} - */ - getRangeEndValue(): any; - - /** To get RangePosition - * @returns {any} - */ - getRangePosition(): any; - - /** To get RangeSize - * @returns {any} - */ - getRangeSize(): any; - - /** To get RangeStartValue - * @returns {any} - */ - getRangeStartValue(): any; - - /** To get ScaleBarSize - * @returns {any} - */ - getScaleBarSize(): any; - - /** To get ScaleBorderWidth - * @returns {any} - */ - getScaleBorderWidth(): any; - - /** To get ScaleDirection - * @returns {any} - */ - getScaleDirection(): any; - - /** To get ScaleRadius - * @returns {any} - */ - getScaleRadius(): any; - - /** To get StartAngle - * @returns {any} - */ - getStartAngle(): any; - - /** To get SubGaugeLocation - * @returns {any} - */ - getSubGaugeLocation(): any; - - /** To get SweepAngle - * @returns {any} - */ - getSweepAngle(): any; - - /** To get TickAngle - * @returns {any} - */ - getTickAngle(): any; - - /** To get TickDistanceFromScale - * @returns {any} - */ - getTickDistanceFromScale(): any; - - /** To get TickHeight - * @returns {any} - */ - getTickHeight(): any; - - /** To get TickPlacement - * @returns {any} - */ - getTickPlacement(): any; - - /** To get TickStyle - * @returns {any} - */ - getTickStyle(): any; - - /** To get TickWidth - * @returns {any} - */ - getTickWidth(): any; - - /** To set includeFirstValue - * @returns {void} - */ - includeFirstValue(): void; - - /** Switching the redraw option for the gauge - * @returns {void} - */ - redraw(): void; - - /** To set BackNeedleLength - * @returns {void} - */ - setBackNeedleLength(): void; - - /** To set CustomLabelAngle - * @returns {void} - */ - setCustomLabelAngle(): void; - - /** To set CustomLabelValue - * @returns {void} - */ - setCustomLabelValue(): void; - - /** To set LabelAngle - * @returns {void} - */ - setLabelAngle(): void; - - /** To set LabelDistanceFromScale - * @returns {void} - */ - setLabelDistanceFromScale(): void; - - /** To set LabelPlacement - * @returns {void} - */ - setLabelPlacement(): void; - - /** To set LabelStyle - * @returns {void} - */ - setLabelStyle(): void; - - /** To set MajorIntervalValue - * @returns {void} - */ - setMajorIntervalValue(): void; - - /** To set MarkerDistanceFromScale - * @returns {void} - */ - setMarkerDistanceFromScale(): void; - - /** To set MarkerStyle - * @returns {void} - */ - setMarkerStyle(): void; - - /** To set MaximumValue - * @returns {void} - */ - setMaximumValue(): void; - - /** To set MinimumValue - * @returns {void} - */ - setMinimumValue(): void; - - /** To set MinorIntervalValue - * @returns {void} - */ - setMinorIntervalValue(): void; - - /** To set NeedleStyle - * @returns {void} - */ - setNeedleStyle(): void; - - /** To set PointerCapBorderWidth - * @returns {void} - */ - setPointerCapBorderWidth(): void; - - /** To set PointerCapRadius - * @returns {void} - */ - setPointerCapRadius(): void; - - /** To set PointerLength - * @returns {void} - */ - setPointerLength(): void; - - /** To set PointerNeedleType - * @returns {void} - */ - setPointerNeedleType(): void; - - /** To set PointerPlacement - * @returns {void} - */ - setPointerPlacement(): void; - - /** To set PointerValue - * @returns {void} - */ - setPointerValue(): void; - - /** To set PointerWidth - * @returns {void} - */ - setPointerWidth(): void; - - /** To set RangeBorderWidth - * @returns {void} - */ - setRangeBorderWidth(): void; - - /** To set RangeDistanceFromScale - * @returns {void} - */ - setRangeDistanceFromScale(): void; - - /** To set RangeEndValue - * @returns {void} - */ - setRangeEndValue(): void; - - /** To set RangePosition - * @returns {void} - */ - setRangePosition(): void; - - /** To set RangeSize - * @returns {void} - */ - setRangeSize(): void; - - /** To set RangeStartValue - * @returns {void} - */ - setRangeStartValue(): void; - - /** To set ScaleBarSize - * @returns {void} - */ - setScaleBarSize(): void; - - /** To set ScaleBorderWidth - * @returns {void} - */ - setScaleBorderWidth(): void; - - /** To set ScaleDirection - * @returns {void} - */ - setScaleDirection(): void; - - /** To set ScaleRadius - * @returns {void} - */ - setScaleRadius(): void; - - /** To set StartAngle - * @returns {void} - */ - setStartAngle(): void; - - /** To set SubGaugeLocation - * @returns {void} - */ - setSubGaugeLocation(): void; - - /** To set SweepAngle - * @returns {void} - */ - setSweepAngle(): void; - - /** To set TickAngle - * @returns {void} - */ - setTickAngle(): void; - - /** To set TickDistanceFromScale - * @returns {void} - */ - setTickDistanceFromScale(): void; - - /** To set TickHeight - * @returns {void} - */ - setTickHeight(): void; - - /** To set TickPlacement - * @returns {void} - */ - setTickPlacement(): void; - - /** To set TickStyle - * @returns {void} - */ - setTickStyle(): void; - - /** To set TickWidth - * @returns {void} - */ - setTickWidth(): void; -} -export namespace CircularGauge { - -export interface Model { - - /** Specifies animationSpeed of circular gauge - * @Default {500} - */ - animationSpeed?: number; - - /** Specifies the background color of circular gauge. - * @Default {null} - */ - backgroundColor?: string; - - /** Specify distanceFromCorner value of circular gauge - * @Default {center} - */ - distanceFromCorner?: number; - - /** Specify animate value of circular gauge - * @Default {true} - */ - enableAnimation?: boolean; - - /** Specify the frame of circular gauge - * @Default {Object} - */ - frame?: Frame; - - /** Specify gaugePosition value of circular gauge See GaugePosition - * @Default {center} - */ - gaugePosition?: ej.datavisualization.CircularGauge.gaugePosition|string; - - /** Specifies the height of circular gauge. - * @Default {360} - */ - height?: number; - - /** Specifies the interiorGradient of circular gauge. - * @Default {null} - */ - interiorGradient?: any; - - /** Specify isRadialGradient value of circular gauge - * @Default {false} - */ - isRadialGradient?: boolean; - - /** Specify isResponsive value of circular gauge - * @Default {false} - */ - isResponsive?: boolean; - - /** Specifies the maximum value of circular gauge. - * @Default {100} - */ - maximum?: number; - - /** Specifies the minimum value of circular gauge. - * @Default {0} - */ - minimum?: number; - - /** Specify outerCustomLabelPosition value of circular gauge See OuterCustomLabelPosition - * @Default {bottom} - */ - outerCustomLabelPosition?: ej.datavisualization.CircularGauge.CustomLabelPositionType|string; - - /** Specifies the radius of circular gauge. - * @Default {180} - */ - radius?: number; - - /** Specify readonly value of circular gauge - * @Default {true} - */ - readOnly?: boolean; - - /** Specify the pointers, ticks, labels, indicators, ranges of circular gauge - * @Default {null} - */ - scales?: Scale[]; - - /** Specify the theme of circular gauge. - * @Default {flatlight} - */ - theme?: string; - - /** Specify tooltip option of circular gauge - * @Default {object} - */ - tooltip?: Tooltip; - - /** Specifies the value of circular gauge. - * @Default {0} - */ - value?: number; - - /** Specifies the width of circular gauge. - * @Default {360} - */ - width?: number; - - /** Triggers while the custom labels are being drawn on the gauge. */ - drawCustomLabel?(e: DrawCustomLabelEventArgs): void; - - /** Triggers while the indicators are being started to drawn on the gauge. */ - drawIndicators?(e: DrawIndicatorsEventArgs): void; - - /** Triggers while the labels are being drawn on the gauge. */ - drawLabels?(e: DrawLabelsEventArgs): void; - - /** Triggers while the pointer cap is being drawn on the gauge. */ - drawPointerCap?(e: DrawPointerCapEventArgs): void; - - /** Triggers while the pointers are being drawn on the gauge. */ - drawPointers?(e: DrawPointersEventArgs): void; + /** returns the context element* @param {Object} args.markerpointer returns the context element + */ + context?: any; + + /** returns the pointer Index + */ + markerpointerIndex?: number; + + /** returns the pointer element. + */ + markerpointerElement?: any; + + /** returns the value of the pointer. + */ + markerpointerValue?: number; + + /** returns the pointer style + */ + style?: string; + + /** returns the startX and startY of the pointer. + */ + position?: any; + } + + export interface RenderCompleteEventArgs { + + /** returns the object of the gauge. + */ + object?: any; + + /** returns the cancel option value + */ + cancel?: boolean; + + /** returns the gauge model + */ + Model?: any; + + /** returns the entire scale element. + */ + scaleElement?: any; + + /** returns the context element + */ + context?: any; + + /** returns the name of the event + */ + type?: any; + } + + export interface Frame { + + /** Specifies the frame background image URL of linear gauge + * @Default {null} + */ + backgroundImageUrl?: string; + + /** Specifies the frame InnerWidth + * @Default {8} + */ + innerWidth?: number; + + /** Specifies the frame OuterWidth + * @Default {12} + */ + outerWidth?: number; + } + + export interface ScalesBarPointersBorder { + + /** Specifies the border Color of bar pointer + * @Default {null} + */ + color?: string; + + /** Specifies the border Width of bar pointer + * @Default {1.5} + */ + width?: number; + } + + export interface ScalesBarPointer { + + /** Specifies the backgroundColor of bar pointer + * @Default {null} + */ + backgroundColor?: string; + + /** Specifies the border of bar pointer + * @Default {null} + */ + border?: ScalesBarPointersBorder; + + /** Specifies the distanceFromScale of bar pointer + * @Default {0} + */ + distanceFromScale?: number; + + /** Specifies the scaleBar Gradient of bar pointer + * @Default {null} + */ + gradients?: any; + + /** Specifies the opacity of bar pointer + * @Default {1} + */ + opacity?: number; + + /** Specifies the value of bar pointer + * @Default {null} + */ + value?: number; + + /** Specifies the pointer Width of bar pointer + * @Default {width=30} + */ + width?: number; + } + + export interface ScalesBorder { + + /** Specifies the border color of the Scale. + * @Default {null} + */ + color?: string; + + /** Specifies the border width of the Scale. + * @Default {1.5} + */ + width?: number; + } + + export interface ScalesCustomLabelsFont { + + /** Specifies the fontFamily in customLabels + * @Default {Arial} + */ + fontFamily?: string; + + /** Specifies the fontStyle in customLabels. See FontStyle + * @Default {Bold} + */ + fontStyle?: ej.datavisualization.LinearGauge.FontStyle | string; + + /** Specifies the font size in customLabels + * @Default {11px} + */ + size?: string; + } + + export interface ScalesCustomLabelsPosition { + + /** Specifies the position x in customLabels + * @Default {0} + */ + x?: number; + + /** Specifies the y in customLabels + * @Default {0} + */ + y?: number; + } + + export interface ScalesCustomLabel { + + /** Specifies the label Color in customLabels + * @Default {null} + */ + color?: number; + + /** Specifies the font in customLabels + * @Default {null} + */ + font?: ScalesCustomLabelsFont; + + /** Specifies the opacity in customLabels + * @Default {0} + */ + opacity?: string; + + /** Specifies the position in customLabels + * @Default {null} + */ + position?: ScalesCustomLabelsPosition; + + /** Specifies the positionType in customLabels.See CustomLabelPositionType + * @Default {null} + */ + positionType?: any; + + /** Specifies the textAngle in customLabels + * @Default {0} + */ + textAngle?: number; + + /** Specifies the label Value in customLabels + */ + value?: string; + } + + export interface ScalesIndicatorsBorder { + + /** Specifies the border Color in bar indicators + * @Default {null} + */ + color?: string; + + /** Specifies the border Width in bar indicators + * @Default {1.5} + */ + width?: number; + } + + export interface ScalesIndicatorsFont { + + /** Specifies the fontFamily of font in bar indicators + * @Default {Arial} + */ + fontFamily?: string; + + /** Specifies the fontStyle of font in bar indicators. See FontStyle + * @Default {ej.datavisualization.LinearGauge.FontStyle.Bold} + */ + fontStyle?: ej.datavisualization.LinearGauge.FontStyle | string; + + /** Specifies the size of font in bar indicators + * @Default {11px} + */ + size?: string; + } + + export interface ScalesIndicatorsPosition { + + /** Specifies the x position in bar indicators + * @Default {0} + */ + x?: number; + + /** Specifies the y position in bar indicators + * @Default {0} + */ + y?: number; + } + + export interface ScalesIndicatorsStateRange { + + /** Specifies the backgroundColor in bar indicators state ranges + * @Default {null} + */ + backgroundColor?: string; + + /** Specifies the borderColor in bar indicators state ranges + * @Default {null} + */ + borderColor?: string; + + /** Specifies the endValue in bar indicators state ranges + * @Default {60} + */ + endValue?: number; + + /** Specifies the startValue in bar indicators state ranges + * @Default {50} + */ + startValue?: number; + + /** Specifies the text in bar indicators state ranges + */ + text?: string; + + /** Specifies the textColor in bar indicators state ranges + * @Default {null} + */ + textColor?: string; + } + + export interface ScalesIndicatorsTextLocation { + + /** Specifies the textLocation position in bar indicators + * @Default {0} + */ + x?: number; + + /** Specifies the Y position in bar indicators + * @Default {0} + */ + y?: number; + } + + export interface ScalesIndicator { + + /** Specifies the backgroundColor in bar indicators + * @Default {null} + */ + backgroundColor?: string; + + /** Specifies the border in bar indicators + * @Default {null} + */ + border?: ScalesIndicatorsBorder; + + /** Specifies the font of bar indicators + * @Default {null} + */ + font?: ScalesIndicatorsFont; + + /** Specifies the indicator Height of bar indicators + * @Default {30} + */ + height?: number; + + /** Specifies the opacity in bar indicators + * @Default {NaN} + */ + opacity?: number; + + /** Specifies the position in bar indicators + * @Default {null} + */ + position?: ScalesIndicatorsPosition; + + /** Specifies the state ranges in bar indicators + * @Default {Array} + */ + stateRanges?: ScalesIndicatorsStateRange[]; + + /** Specifies the textLocation in bar indicators + * @Default {null} + */ + textLocation?: ScalesIndicatorsTextLocation; + + /** Specifies the indicator Style of font in bar indicators + * @Default {ej.datavisualization.LinearGauge.IndicatorType.Rectangle} + */ + type?: ej.datavisualization.LinearGauge.IndicatorTypes | string; + + /** Specifies the indicator Width in bar indicators + * @Default {30} + */ + width?: number; + } + + export interface ScalesLabelsDistanceFromScale { + + /** Specifies the xDistanceFromScale of labels. + * @Default {-10} + */ + x?: number; + + /** Specifies the yDistanceFromScale of labels. + * @Default {0} + */ + y?: number; + } + + export interface ScalesLabelsFont { + + /** Specifies the fontFamily of font. + * @Default {Arial} + */ + fontFamily?: string; + + /** Specifies the fontStyle of font.See FontStyle + * @Default {ej.datavisualization.LinearGauge.FontStyle.Bold} + */ + fontStyle?: ej.datavisualization.LinearGauge.FontStyle | string; + + /** Specifies the size of font. + * @Default {11px} + */ + size?: string; + } + + export interface ScalesLabel { + + /** Specifies the angle of labels. + * @Default {0} + */ + angle?: number; + + /** Specifies the DistanceFromScale of labels. + * @Default {null} + */ + distanceFromScale?: ScalesLabelsDistanceFromScale; + + /** Specifies the font of labels. + * @Default {null} + */ + font?: ScalesLabelsFont; + + /** need to includeFirstValue. + * @Default {true} + */ + includeFirstValue?: boolean; + + /** Specifies the opacity of label. + * @Default {0} + */ + opacity?: number; + + /** Specifies the label Placement of label. See LabelPlacement + * @Default {Near} + */ + placement?: ej.datavisualization.LinearGauge.PointerPlacement | string; + + /** Specifies the textColor of font. + * @Default {null} + */ + textColor?: string; + + /** Specifies the label Style of label. See LabelType + * @Default {ej.datavisualization.LinearGauge.LabelType.Major} + */ + type?: ej.datavisualization.LinearGauge.ScaleType | string; + + /** Specifies the unitText of label. + */ + unitText?: string; + + /** Specifies the unitText Position of label.See UnitTextPlacement + * @Default {Back} + */ + unitTextPlacement?: ej.datavisualization.LinearGauge.UnitTextPlacement | string; + } + + export interface ScalesMarkerPointersBorder { + + /** Specifies the border color of marker pointer + * @Default {null} + */ + color?: string; + + /** Specifies the border of marker pointer + * @Default {number} + */ + width?: number; + } + + export interface ScalesMarkerPointer { + + /** Specifies the backgroundColor of marker pointer + * @Default {null} + */ + backgroundColor?: string; + + /** Specifies the border of marker pointer + * @Default {null} + */ + border?: ScalesMarkerPointersBorder; + + /** Specifies the distanceFromScale of marker pointer + * @Default {0} + */ + distanceFromScale?: number; + + /** Specifies the pointer Gradient of marker pointer + * @Default {null} + */ + gradients?: any; + + /** Specifies the pointer Length of marker pointer + * @Default {30} + */ + length?: number; + + /** Specifies the opacity of marker pointer + * @Default {1} + */ + opacity?: number; + + /** Specifies the pointer Placement of marker pointer See PointerPlacement + * @Default {Far} + */ + placement?: ej.datavisualization.LinearGauge.PointerPlacement | string; + + /** Specifies the marker Style of marker pointerSee MarkerType + * @Default {Triangle} + */ + type?: ej.datavisualization.LinearGauge.MarkerType | string; + + /** Specifies the value of marker pointer + * @Default {null} + */ + value?: number; + + /** Specifies the pointer Width of marker pointer + * @Default {30} + */ + width?: number; + } + + export interface ScalesPosition { + + /** Specifies the Horizontal position + * @Default {50} + */ + x?: number; + + /** Specifies the vertical position + * @Default {50} + */ + y?: number; + } + + export interface ScalesRangesBorder { + + /** Specifies the border color in the ranges. + * @Default {null} + */ + color?: string; + + /** Specifies the border width in the ranges. + * @Default {1.5} + */ + width?: number; + } + + export interface ScalesRange { + + /** Specifies the backgroundColor in the ranges. + * @Default {null} + */ + backgroundColor?: string; + + /** Specifies the border in the ranges. + * @Default {null} + */ + border?: ScalesRangesBorder; + + /** Specifies the distanceFromScale in the ranges. + * @Default {0} + */ + distanceFromScale?: number; + + /** Specifies the endValue in the ranges. + * @Default {60} + */ + endValue?: number; + + /** Specifies the endWidth in the ranges. + * @Default {10} + */ + endWidth?: number; + + /** Specifies the range Gradient in the ranges. + * @Default {null} + */ + gradients?: any; + + /** Specifies the opacity in the ranges. + * @Default {null} + */ + opacity?: number; + + /** Specifies the range Position in the ranges. See RangePlacement + * @Default {Center} + */ + placement?: ej.datavisualization.LinearGauge.PointerPlacement | string; + + /** Specifies the startValue in the ranges. + * @Default {20} + */ + startValue?: number; + + /** Specifies the startWidth in the ranges. + * @Default {10} + */ + startWidth?: number; + } + + export interface ScalesTicksDistanceFromScale { + + /** Specifies the xDistanceFromScale in the tick. + * @Default {0} + */ + x?: number; + + /** Specifies the yDistanceFromScale in the tick. + * @Default {0} + */ + y?: number; + } + + export interface ScalesTick { + + /** Specifies the angle in the tick. + * @Default {0} + */ + angle?: number; + + /** Specifies the tick Color in the tick. + * @Default {null} + */ + color?: string; + + /** Specifies the DistanceFromScale in the tick. + * @Default {null} + */ + distanceFromScale?: ScalesTicksDistanceFromScale; + + /** Specifies the tick Height in the tick. + * @Default {10} + */ + height?: number; + + /** Specifies the opacity in the tick. + * @Default {0} + */ + opacity?: number; + + /** Specifies the tick Placement in the tick. See TickPlacement + * @Default {Near} + */ + placement?: ej.datavisualization.LinearGauge.PointerPlacement | string; + + /** Specifies the tick Style in the tick. See TickType + * @Default {MajorInterval} + */ + type?: ej.datavisualization.LinearGauge.TicksType | string; + + /** Specifies the tick Width in the tick. + * @Default {3} + */ + width?: number; + } + + export interface Scale { + + /** Specifies the backgroundColor of the Scale. + * @Default {null} + */ + backgroundColor?: string; + + /** Specifies the scaleBar Gradient of bar pointer + * @Default {Array} + */ + barPointers?: ScalesBarPointer[]; + + /** Specifies the border of the Scale. + * @Default {null} + */ + border?: ScalesBorder; + + /** Specifies the customLabel + * @Default {Array} + */ + customLabels?: ScalesCustomLabel[]; + + /** Specifies the scale Direction of the Scale. See Directions + * @Default {CounterClockwise} + */ + direction?: ej.datavisualization.LinearGauge.Direction | string; + + /** Specifies the indicator + * @Default {Array} + */ + indicators?: ScalesIndicator[]; + + /** Specifies the labels. + * @Default {Array} + */ + labels?: ScalesLabel[]; + + /** Specifies the scaleBar Length. + * @Default {290} + */ + length?: number; + + /** Specifies the majorIntervalValue of the Scale. + * @Default {10} + */ + majorIntervalValue?: number; + + /** Specifies the markerPointers + * @Default {Array} + */ + markerPointers?: ScalesMarkerPointer[]; + + /** Specifies the maximum of the Scale. + * @Default {null} + */ + maximum?: number; + + /** Specifies the minimum of the Scale. + * @Default {null} + */ + minimum?: number; + + /** Specifies the minorIntervalValue of the Scale. + * @Default {2} + */ + minorIntervalValue?: number; + + /** Specifies the opacity of the Scale. + * @Default {NaN} + */ + opacity?: number; + + /** Specifies the position + * @Default {null} + */ + position?: ScalesPosition; + + /** Specifies the ranges in the tick. + * @Default {Array} + */ + ranges?: ScalesRange[]; + + /** Specifies the shadowOffset. + * @Default {0} + */ + shadowOffset?: number; + + /** Specifies the showBarPointers state. + * @Default {true} + */ + showBarPointers?: boolean; + + /** Specifies the showCustomLabels state. + * @Default {false} + */ + showCustomLabels?: boolean; + + /** Specifies the showIndicators state. + * @Default {false} + */ + showIndicators?: boolean; + + /** Specifies the showLabels state. + * @Default {true} + */ + showLabels?: boolean; + + /** Specifies the showMarkerPointers state. + * @Default {true} + */ + showMarkerPointers?: boolean; + + /** Specifies the showRanges state. + * @Default {false} + */ + showRanges?: boolean; + + /** Specifies the showTicks state. + * @Default {true} + */ + showTicks?: boolean; + + /** Specifies the ticks in the scale. + * @Default {Array} + */ + ticks?: ScalesTick[]; + + /** Specifies the scaleBar type .See ScaleType + * @Default {Rectangle} + */ + type?: ej.datavisualization.LinearGauge.ScaleType | string; + + /** Specifies the scaleBar width. + * @Default {30} + */ + width?: number; + } + + export interface Tooltip { + + /** Specify showCustomLabelTooltip value of linear gauge + * @Default {false} + */ + showCustomLabelTooltip?: boolean; + + /** Specify showLabelTooltip value of linear gauge + * @Default {false} + */ + showLabelTooltip?: boolean; + + /** Specify templateID value of linear gauge + * @Default {false} + */ + templateID?: string; + } + } + namespace LinearGauge { + enum OuterCustomLabelPosition { + //string + Left, + //string + Right, + //string + Top, + //string + Bottom, + } + } + namespace LinearGauge { + enum FontStyle { + //string + Bold, + //string + Italic, + //string + Regular, + //string + Strikeout, + //string + Underline, + } + } + namespace LinearGauge { + enum Direction { + //string + Clockwise, + //string + CounterClockwise, + } + } + namespace LinearGauge { + enum IndicatorTypes { + //string + Rectangle, + //string + Circle, + //string + RoundedRectangle, + //string + Text, + } + } + namespace LinearGauge { + enum PointerPlacement { + //string + Near, + //string + Far, + //string + Center, + } + } + namespace LinearGauge { + enum ScaleType { + //string + Major, + //string + Minor, + } + } + namespace LinearGauge { + enum UnitTextPlacement { + //string + Back, + //string + From, + } + } + namespace LinearGauge { + enum MarkerType { + //string + Rectangle, + //string + Triangle, + //string + Ellipse, + //string + Diamond, + //string + Pentagon, + //string + Circle, + //string + Star, + //string + Slider, + //string + Pointer, + //string + Wedge, + //string + Trapezoid, + //string + RoundedRectangle, + } + } + namespace LinearGauge { + enum TicksType { + //string + Majorinterval, + //string + Minorinterval, + } + } + namespace LinearGauge { + enum Themes { + //string + FlatLight, + //string + FlatDark, + } + } + + class CircularGauge extends ej.Widget { + static fn: CircularGauge; + constructor(element: JQuery | Element, options?: CircularGauge.Model); + static Locale: any; + model: CircularGauge.Model; + defaults: CircularGauge.Model; + + /** destroy the circular gauge widget. all events bound using this._on will be unbind automatically and bring the control to pre-init state. + * @returns {void} + */ + destroy(): void; + + /** To export Image + * @returns {boolean} + */ + exportImage(): boolean; + + /** To get BackNeedleLength + * @returns {any} + */ + getBackNeedleLength(): any; + + /** To get CustomLabelAngle + * @returns {any} + */ + getCustomLabelAngle(): any; + + /** To get CustomLabelValue + * @returns {any} + */ + getCustomLabelValue(): any; + + /** To get LabelAngle + * @returns {any} + */ + getLabelAngle(): any; + + /** To get LabelDistanceFromScale + * @returns {any} + */ + getLabelDistanceFromScale(): any; + + /** To get LabelPlacement + * @returns {any} + */ + getLabelPlacement(): any; + + /** To get LabelStyle + * @returns {any} + */ + getLabelStyle(): any; + + /** To get MajorIntervalValue + * @returns {any} + */ + getMajorIntervalValue(): any; + + /** To get MarkerDistanceFromScale + * @returns {any} + */ + getMarkerDistanceFromScale(): any; + + /** To get MarkerStyle + * @returns {any} + */ + getMarkerStyle(): any; + + /** To get MaximumValue + * @returns {any} + */ + getMaximumValue(): any; + + /** To get MinimumValue + * @returns {any} + */ + getMinimumValue(): any; + + /** To get MinorIntervalValue + * @returns {any} + */ + getMinorIntervalValue(): any; + + /** To get NeedleStyle + * @returns {any} + */ + getNeedleStyle(): any; + + /** To get PointerCapBorderWidth + * @returns {any} + */ + getPointerCapBorderWidth(): any; + + /** To get PointerCapRadius + * @returns {any} + */ + getPointerCapRadius(): any; + + /** To get PointerLength + * @returns {any} + */ + getPointerLength(): any; + + /** To get PointerNeedleType + * @returns {any} + */ + getPointerNeedleType(): any; + + /** To get PointerPlacement + * @returns {any} + */ + getPointerPlacement(): any; + + /** To get PointerValue + * @returns {any} + */ + getPointerValue(): any; + + /** To get PointerWidth + * @returns {any} + */ + getPointerWidth(): any; + + /** To get RangeBorderWidth + * @returns {any} + */ + getRangeBorderWidth(): any; + + /** To get RangeDistanceFromScale + * @returns {any} + */ + getRangeDistanceFromScale(): any; + + /** To get RangeEndValue + * @returns {any} + */ + getRangeEndValue(): any; + + /** To get RangePosition + * @returns {any} + */ + getRangePosition(): any; + + /** To get RangeSize + * @returns {any} + */ + getRangeSize(): any; + + /** To get RangeStartValue + * @returns {any} + */ + getRangeStartValue(): any; + + /** To get ScaleBarSize + * @returns {any} + */ + getScaleBarSize(): any; + + /** To get ScaleBorderWidth + * @returns {any} + */ + getScaleBorderWidth(): any; + + /** To get ScaleDirection + * @returns {any} + */ + getScaleDirection(): any; + + /** To get ScaleRadius + * @returns {any} + */ + getScaleRadius(): any; + + /** To get StartAngle + * @returns {any} + */ + getStartAngle(): any; + + /** To get SubGaugeLocation + * @returns {any} + */ + getSubGaugeLocation(): any; + + /** To get SweepAngle + * @returns {any} + */ + getSweepAngle(): any; + + /** To get TickAngle + * @returns {any} + */ + getTickAngle(): any; + + /** To get TickDistanceFromScale + * @returns {any} + */ + getTickDistanceFromScale(): any; + + /** To get TickHeight + * @returns {any} + */ + getTickHeight(): any; + + /** To get TickPlacement + * @returns {any} + */ + getTickPlacement(): any; + + /** To get TickStyle + * @returns {any} + */ + getTickStyle(): any; + + /** To get TickWidth + * @returns {any} + */ + getTickWidth(): any; + + /** To set includeFirstValue + * @returns {void} + */ + includeFirstValue(): void; + + /** Switching the redraw option for the gauge + * @returns {void} + */ + redraw(): void; + + /** To set BackNeedleLength + * @returns {void} + */ + setBackNeedleLength(): void; + + /** To set CustomLabelAngle + * @returns {void} + */ + setCustomLabelAngle(): void; + + /** To set CustomLabelValue + * @returns {void} + */ + setCustomLabelValue(): void; + + /** To set LabelAngle + * @returns {void} + */ + setLabelAngle(): void; + + /** To set LabelDistanceFromScale + * @returns {void} + */ + setLabelDistanceFromScale(): void; + + /** To set LabelPlacement + * @returns {void} + */ + setLabelPlacement(): void; + + /** To set LabelStyle + * @returns {void} + */ + setLabelStyle(): void; + + /** To set MajorIntervalValue + * @returns {void} + */ + setMajorIntervalValue(): void; + + /** To set MarkerDistanceFromScale + * @returns {void} + */ + setMarkerDistanceFromScale(): void; + + /** To set MarkerStyle + * @returns {void} + */ + setMarkerStyle(): void; + + /** To set MaximumValue + * @returns {void} + */ + setMaximumValue(): void; + + /** To set MinimumValue + * @returns {void} + */ + setMinimumValue(): void; + + /** To set MinorIntervalValue + * @returns {void} + */ + setMinorIntervalValue(): void; + + /** To set NeedleStyle + * @returns {void} + */ + setNeedleStyle(): void; + + /** To set PointerCapBorderWidth + * @returns {void} + */ + setPointerCapBorderWidth(): void; + + /** To set PointerCapRadius + * @returns {void} + */ + setPointerCapRadius(): void; + + /** To set PointerLength + * @returns {void} + */ + setPointerLength(): void; + + /** To set PointerNeedleType + * @returns {void} + */ + setPointerNeedleType(): void; + + /** To set PointerPlacement + * @returns {void} + */ + setPointerPlacement(): void; + + /** To set PointerValue + * @returns {void} + */ + setPointerValue(): void; + + /** To set PointerWidth + * @returns {void} + */ + setPointerWidth(): void; + + /** To set RangeBorderWidth + * @returns {void} + */ + setRangeBorderWidth(): void; + + /** To set RangeDistanceFromScale + * @returns {void} + */ + setRangeDistanceFromScale(): void; + + /** To set RangeEndValue + * @returns {void} + */ + setRangeEndValue(): void; + + /** To set RangePosition + * @returns {void} + */ + setRangePosition(): void; + + /** To set RangeSize + * @returns {void} + */ + setRangeSize(): void; + + /** To set RangeStartValue + * @returns {void} + */ + setRangeStartValue(): void; + + /** To set ScaleBarSize + * @returns {void} + */ + setScaleBarSize(): void; + + /** To set ScaleBorderWidth + * @returns {void} + */ + setScaleBorderWidth(): void; + + /** To set ScaleDirection + * @returns {void} + */ + setScaleDirection(): void; + + /** To set ScaleRadius + * @returns {void} + */ + setScaleRadius(): void; + + /** To set StartAngle + * @returns {void} + */ + setStartAngle(): void; + + /** To set SubGaugeLocation + * @returns {void} + */ + setSubGaugeLocation(): void; + + /** To set SweepAngle + * @returns {void} + */ + setSweepAngle(): void; + + /** To set TickAngle + * @returns {void} + */ + setTickAngle(): void; + + /** To set TickDistanceFromScale + * @returns {void} + */ + setTickDistanceFromScale(): void; + + /** To set TickHeight + * @returns {void} + */ + setTickHeight(): void; + + /** To set TickPlacement + * @returns {void} + */ + setTickPlacement(): void; + + /** To set TickStyle + * @returns {void} + */ + setTickStyle(): void; + + /** To set TickWidth + * @returns {void} + */ + setTickWidth(): void; + } + export namespace CircularGauge { + + export interface Model { + + /** Specifies animationSpeed of circular gauge + * @Default {500} + */ + animationSpeed?: number; + + /** Specifies the background color of circular gauge. + * @Default {null} + */ + backgroundColor?: string; + + /** Specify distanceFromCorner value of circular gauge + * @Default {center} + */ + distanceFromCorner?: number; + + /** Specify animate value of circular gauge + * @Default {true} + */ + enableAnimation?: boolean; + + /** Specify the frame of circular gauge + * @Default {Object} + */ + frame?: Frame; + + /** Specify gaugePosition value of circular gauge See GaugePosition + * @Default {center} + */ + gaugePosition?: ej.datavisualization.CircularGauge.gaugePosition | string; + + /** Specifies the height of circular gauge. + * @Default {360} + */ + height?: number; + + /** Specifies the interiorGradient of circular gauge. + * @Default {null} + */ + interiorGradient?: any; + + /** Specify isRadialGradient value of circular gauge + * @Default {false} + */ + isRadialGradient?: boolean; + + /** Specify isResponsive value of circular gauge + * @Default {false} + */ + isResponsive?: boolean; + + /** Specifies the maximum value of circular gauge. + * @Default {100} + */ + maximum?: number; + + /** Specifies the minimum value of circular gauge. + * @Default {0} + */ + minimum?: number; + + /** Specify outerCustomLabelPosition value of circular gauge See OuterCustomLabelPosition + * @Default {bottom} + */ + outerCustomLabelPosition?: ej.datavisualization.CircularGauge.CustomLabelPositionType | string; + + /** Specifies the radius of circular gauge. + * @Default {180} + */ + radius?: number; + + /** Specify readonly value of circular gauge + * @Default {true} + */ + readOnly?: boolean; + + /** Specify the pointers, ticks, labels, indicators, ranges of circular gauge + * @Default {null} + */ + scales?: Scale[]; + + /** Specify the theme of circular gauge. + * @Default {flatlight} + */ + theme?: string; + + /** Specify tooltip option of circular gauge + * @Default {object} + */ + tooltip?: Tooltip; + + /** Specifies the value of circular gauge. + * @Default {0} + */ + value?: number; + + /** Specifies the width of circular gauge. + * @Default {360} + */ + width?: number; + + /** Triggers while the custom labels are being drawn on the gauge. */ + drawCustomLabel?(e: DrawCustomLabelEventArgs): void; + + /** Triggers while the indicators are being started to drawn on the gauge. */ + drawIndicators?(e: DrawIndicatorsEventArgs): void; + + /** Triggers while the labels are being drawn on the gauge. */ + drawLabels?(e: DrawLabelsEventArgs): void; + + /** Triggers while the pointer cap is being drawn on the gauge. */ + drawPointerCap?(e: DrawPointerCapEventArgs): void; + + /** Triggers while the pointers are being drawn on the gauge. */ + drawPointers?(e: DrawPointersEventArgs): void; - /** Triggers when the ranges begin to be getting drawn on the gauge. */ - drawRange?(e: DrawRangeEventArgs): void; + /** Triggers when the ranges begin to be getting drawn on the gauge. */ + drawRange?(e: DrawRangeEventArgs): void; - /** Triggers while the ticks are being drawn on the gauge. */ - drawTicks?(e: DrawTicksEventArgs): void; - - /** Triggers while the gauge start to Load. */ - load?(e: LoadEventArgs): void; + /** Triggers while the ticks are being drawn on the gauge. */ + drawTicks?(e: DrawTicksEventArgs): void; + + /** Triggers while the gauge start to Load. */ + load?(e: LoadEventArgs): void; - /** Triggers when the left mouse button is clicked. */ - mouseClick?(e: MouseClickEventArgs): void; + /** Triggers when the left mouse button is clicked. */ + mouseClick?(e: MouseClickEventArgs): void; - /** Triggers when clicking and dragging the mouse pointer over the gauge pointer. */ - mouseClickMove?(e: MouseClickMoveEventArgs): void; + /** Triggers when clicking and dragging the mouse pointer over the gauge pointer. */ + mouseClickMove?(e: MouseClickMoveEventArgs): void; - /** Triggers when the mouse click is released. */ - mouseClickUp?(e: MouseClickUpEventArgs): void; + /** Triggers when the mouse click is released. */ + mouseClickUp?(e: MouseClickUpEventArgs): void; - /** Triggers when the rendering of the gauge is completed. */ - renderComplete?(e: RenderCompleteEventArgs): void; -} + /** Triggers when the rendering of the gauge is completed. */ + renderComplete?(e: RenderCompleteEventArgs): void; + } -export interface DrawCustomLabelEventArgs { + export interface DrawCustomLabelEventArgs { - /** returns the object of the gauge. - */ - object?: any; + /** returns the object of the gauge. + */ + object?: any; - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the context element - */ - context?: any; + /** returns the context element + */ + context?: any; - /** returns the startX and startY of the custom label - */ - position?: any; + /** returns the startX and startY of the custom label + */ + position?: any; - /** returns the gauge model - */ - model?: any; + /** returns the gauge model + */ + model?: any; - /** returns the options of the scale element. - */ - scaleElement?: any; + /** returns the options of the scale element. + */ + scaleElement?: any; - /** returns the scaleIndex to which the custom label belongs. - */ - scaleIndex?: number; + /** returns the scaleIndex to which the custom label belongs. + */ + scaleIndex?: number; - /** returns the custom label style - */ - style?: string; + /** returns the custom label style + */ + style?: string; - /** returns the current custom label element. - */ - customLabelElement?: any; + /** returns the current custom label element. + */ + customLabelElement?: any; - /** returns the index of the custom label. - */ - customLabelIndex?: number; + /** returns the index of the custom label. + */ + customLabelIndex?: number; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface DrawIndicatorsEventArgs { + export interface DrawIndicatorsEventArgs { - /** returns the object of the gauge. - */ - object?: any; + /** returns the object of the gauge. + */ + object?: any; - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the context element - */ - context?: any; + /** returns the context element + */ + context?: any; - /** returns the startX and startY of the indicator - */ - position?: any; + /** returns the startX and startY of the indicator + */ + position?: any; - /** returns the gauge model - */ - model?: any; + /** returns the gauge model + */ + model?: any; - /** returns the options of the scale element. - */ - scaleElement?: any; + /** returns the options of the scale element. + */ + scaleElement?: any; - /** returns the scaleIndex to which the indicator belongs. - */ - scaleIndex?: number; + /** returns the scaleIndex to which the indicator belongs. + */ + scaleIndex?: number; - /** returns the indicator style - */ - style?: string; + /** returns the indicator style + */ + style?: string; - /** returns the current indicator element. - */ - indicatorElement?: any; + /** returns the current indicator element. + */ + indicatorElement?: any; - /** returns the index of the indicator. - */ - indicatorIndex?: number; + /** returns the index of the indicator. + */ + indicatorIndex?: number; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface DrawLabelsEventArgs { + export interface DrawLabelsEventArgs { - /** returns the object of the gauge. - */ - object?: any; + /** returns the object of the gauge. + */ + object?: any; - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the context element - */ - context?: any; + /** returns the context element + */ + context?: any; - /** returns the startX and startY of the labels - */ - position?: any; + /** returns the startX and startY of the labels + */ + position?: any; - /** returns the gauge model - */ - model?: any; + /** returns the gauge model + */ + model?: any; - /** returns the options of the scale element. - */ - scaleElement?: any; + /** returns the options of the scale element. + */ + scaleElement?: any; - /** returns the scaleIndex to which the label belongs. - */ - scaleIndex?: number; + /** returns the scaleIndex to which the label belongs. + */ + scaleIndex?: number; - /** returns the label style - */ - style?: string; + /** returns the label style + */ + style?: string; - /** returns the angle of the labels. - */ - angle?: number; + /** returns the angle of the labels. + */ + angle?: number; - /** returns the current label element. - */ - element?: any; + /** returns the current label element. + */ + element?: any; - /** returns the index of the label. - */ - index?: number; + /** returns the index of the label. + */ + index?: number; - /** returns the value of the label. - */ - pointerValue?: number; + /** returns the value of the label. + */ + pointerValue?: number; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface DrawPointerCapEventArgs { + export interface DrawPointerCapEventArgs { - /** returns the object of the gauge. - */ - object?: any; + /** returns the object of the gauge. + */ + object?: any; - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the context element - */ - context?: any; + /** returns the context element + */ + context?: any; - /** returns the options of the scale element. - */ - scaleElement?: any; + /** returns the options of the scale element. + */ + scaleElement?: any; - /** returns the startX and startY of the pointer cap. - */ - position?: any; + /** returns the startX and startY of the pointer cap. + */ + position?: any; - /** returns the gauge model - */ - model?: any; + /** returns the gauge model + */ + model?: any; - /** returns the pointer cap style - */ - style?: string; + /** returns the pointer cap style + */ + style?: string; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface DrawPointersEventArgs { + export interface DrawPointersEventArgs { - /** returns the object of the gauge. - */ - object?: any; + /** returns the object of the gauge. + */ + object?: any; - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the context element - */ - context?: any; + /** returns the context element + */ + context?: any; - /** returns the startX and startY of the pointer - */ - position?: any; + /** returns the startX and startY of the pointer + */ + position?: any; - /** returns the gauge model - */ - model?: any; + /** returns the gauge model + */ + model?: any; - /** returns the options of the scale element. - */ - scaleElement?: any; + /** returns the options of the scale element. + */ + scaleElement?: any; - /** returns the scaleIndex to which the pointer belongs. - */ - scaleIndex?: number; + /** returns the scaleIndex to which the pointer belongs. + */ + scaleIndex?: number; - /** returns the pointer style - */ - style?: string; + /** returns the pointer style + */ + style?: string; - /** returns the angle of the pointer. - */ - angle?: number; + /** returns the angle of the pointer. + */ + angle?: number; - /** returns the current pointer element. - */ - element?: any; + /** returns the current pointer element. + */ + element?: any; - /** returns the index of the pointer. - */ - index?: number; + /** returns the index of the pointer. + */ + index?: number; - /** returns the value of the pointer. - */ - value?: number; + /** returns the value of the pointer. + */ + value?: number; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface DrawRangeEventArgs { + export interface DrawRangeEventArgs { - /** returns the object of the gauge. - */ - object?: any; + /** returns the object of the gauge. + */ + object?: any; - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the context element - */ - context?: any; + /** returns the context element + */ + context?: any; - /** returns the startX and startY of the range - */ - position?: any; + /** returns the startX and startY of the range + */ + position?: any; - /** returns the gauge model - */ - model?: any; + /** returns the gauge model + */ + model?: any; - /** returns the options of the scale element. - */ - scaleElement?: any; + /** returns the options of the scale element. + */ + scaleElement?: any; - /** returns the scaleIndex to which the range belongs. - */ - scaleIndex?: number; + /** returns the scaleIndex to which the range belongs. + */ + scaleIndex?: number; - /** returns the range style - */ - style?: string; + /** returns the range style + */ + style?: string; - /** returns the current range element. - */ - rangeElement?: any; + /** returns the current range element. + */ + rangeElement?: any; - /** returns the index of the range. - */ - rangeIndex?: number; + /** returns the index of the range. + */ + rangeIndex?: number; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface DrawTicksEventArgs { + export interface DrawTicksEventArgs { - /** returns the object of the gauge. - */ - object?: any; + /** returns the object of the gauge. + */ + object?: any; - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the context element - */ - context?: any; + /** returns the context element + */ + context?: any; - /** returns the startX and startY of the ticks - */ - position?: any; + /** returns the startX and startY of the ticks + */ + position?: any; - /** returns the gauge model - */ - model?: any; + /** returns the gauge model + */ + model?: any; - /** returns the options of the scale element. - */ - scaleElement?: any; + /** returns the options of the scale element. + */ + scaleElement?: any; - /** returns the scaleIndex to which the tick belongs. - */ - scaleIndex?: number; + /** returns the scaleIndex to which the tick belongs. + */ + scaleIndex?: number; - /** returns the ticks style - */ - style?: string; + /** returns the ticks style + */ + style?: string; - /** returns the angle of the tick. - */ - angle?: number; + /** returns the angle of the tick. + */ + angle?: number; - /** returns the current tick element. - */ - element?: any; + /** returns the current tick element. + */ + element?: any; - /** returns the index of the tick. - */ - index?: number; + /** returns the index of the tick. + */ + index?: number; - /** returns the label value of the tick. - */ - pointerValue?: number; + /** returns the label value of the tick. + */ + pointerValue?: number; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface LoadEventArgs { + export interface LoadEventArgs { - /** returns the object of the gauge. - */ - object?: any; + /** returns the object of the gauge. + */ + object?: any; - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the gauge model - */ - Model?: any; + /** returns the gauge model + */ + Model?: any; - /** returns the entire scale element. - */ - scaleElement?: any; + /** returns the entire scale element. + */ + scaleElement?: any; - /** returns the context element - */ - context?: any; + /** returns the context element + */ + context?: any; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface MouseClickEventArgs { + export interface MouseClickEventArgs { - /** returns the object of the gauge. - */ - object?: any; + /** returns the object of the gauge. + */ + object?: any; - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the gauge model - */ - model?: any; + /** returns the gauge model + */ + model?: any; - /** returns the name of the event - */ - type?: any; + /** returns the name of the event + */ + type?: any; - /** returns the scale element. - */ - scaleElement?: any; + /** returns the scale element. + */ + scaleElement?: any; - /** returns the scaleIndex to which the pointer belongs. - */ - scaleIndex?: number; + /** returns the scaleIndex to which the pointer belongs. + */ + scaleIndex?: number; - /** returns the context element - */ - context?: any; + /** returns the context element + */ + context?: any; - /** returns the pointer Index - */ - index?: number; + /** returns the pointer Index + */ + index?: number; - /** returns the pointer element. - */ - element?: any; + /** returns the pointer element. + */ + element?: any; - /** returns the value of the pointer. - */ - value?: number; + /** returns the value of the pointer. + */ + value?: number; - /** returns the angle of the pointer. - */ - angle?: number; + /** returns the angle of the pointer. + */ + angle?: number; - /** returns the pointer style - */ - style?: string; + /** returns the pointer style + */ + style?: string; - /** returns the startX and startY of the pointer. - */ - position?: any; -} + /** returns the startX and startY of the pointer. + */ + position?: any; + } -export interface MouseClickMoveEventArgs { + export interface MouseClickMoveEventArgs { - /** returns the object of the gauge. - */ - object?: any; + /** returns the object of the gauge. + */ + object?: any; - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the gauge model - */ - model?: any; + /** returns the gauge model + */ + model?: any; - /** returns the name of the event - */ - type?: any; + /** returns the name of the event + */ + type?: any; - /** returns the scale element. - */ - scaleElement?: any; + /** returns the scale element. + */ + scaleElement?: any; - /** returns the scaleIndex to which the pointer belongs. - */ - scaleIndex?: number; + /** returns the scaleIndex to which the pointer belongs. + */ + scaleIndex?: number; - /** returns the context element - */ - context?: any; + /** returns the context element + */ + context?: any; - /** returns the pointer Index - */ - index?: number; + /** returns the pointer Index + */ + index?: number; - /** returns the pointer element. - */ - element?: any; + /** returns the pointer element. + */ + element?: any; - /** returns the value of the pointer. - */ - value?: number; + /** returns the value of the pointer. + */ + value?: number; - /** returns the angle of the pointer. - */ - angle?: number; + /** returns the angle of the pointer. + */ + angle?: number; - /** returns the pointer style - */ - style?: string; + /** returns the pointer style + */ + style?: string; - /** returns the startX and startY of the pointer. - */ - position?: any; -} + /** returns the startX and startY of the pointer. + */ + position?: any; + } -export interface MouseClickUpEventArgs { + export interface MouseClickUpEventArgs { - /** returns the object of the gauge. - */ - object?: any; + /** returns the object of the gauge. + */ + object?: any; - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the gauge model - */ - model?: any; + /** returns the gauge model + */ + model?: any; - /** returns the name of the event - */ - type?: any; + /** returns the name of the event + */ + type?: any; - /** returns the scale element. - */ - scaleElement?: any; + /** returns the scale element. + */ + scaleElement?: any; - /** returns the scaleIndex to which the pointer belongs. - */ - scaleIndex?: number; + /** returns the scaleIndex to which the pointer belongs. + */ + scaleIndex?: number; - /** returns the context element - */ - context?: any; - - /** returns the pointer Index - */ - index?: number; + /** returns the context element + */ + context?: any; + + /** returns the pointer Index + */ + index?: number; - /** returns the pointer element. - */ - element?: any; + /** returns the pointer element. + */ + element?: any; - /** returns the value of the pointer. - */ - value?: number; - - /** returns the angle of the pointer. - */ - angle?: number; - - /** returns the pointer style - */ - style?: string; - - /** returns the startX and startY of the pointer. - */ - position?: any; -} + /** returns the value of the pointer. + */ + value?: number; + + /** returns the angle of the pointer. + */ + angle?: number; + + /** returns the pointer style + */ + style?: string; + + /** returns the startX and startY of the pointer. + */ + position?: any; + } -export interface RenderCompleteEventArgs { - - /** returns the object of the gauge. - */ - object?: any; - - /** returns the cancel option value - */ - cancel?: boolean; - - /** returns the context element - */ - context?: any; - - /** returns the entire scale element. - */ - scaleElement?: any; - - /** returns the gauge model - */ - model?: any; - - /** returns the name of the event - */ - type?: string; -} - -export interface Frame { - - /** Specify the URL of the frame background image for circular gauge - * @Default {null} - */ - backgroundImageUrl?: string; - - /** Specifies the frameType of circular gauge. See Frame - * @Default {FullCircle} - */ - frameType?: ej.datavisualization.CircularGauge.FrameType|string; - - /** Specifies the end angle for the half circular frame. - * @Default {360} - */ - halfCircleFrameEndAngle?: number; - - /** Specifies the start angle for the half circular frame. - * @Default {180} - */ - halfCircleFrameStartAngle?: number; -} - -export interface ScalesBorder { - - /** Specify border color for scales of circular gauge - * @Default {null} - */ - color?: string; - - /** Specify border width of circular gauge - * @Default {1.5} - */ - width?: number; -} - -export interface ScalesCustomLabelsPosition { - - /** Specify x-axis position of label - * @Default {0} - */ - x?: number; - - /** Specify y-axis position of labels. - * @Default {0} - */ - y?: number; -} - -export interface ScalesCustomLabelsFont { - - /** Specify font fontFamily for custom labels. - * @Default {Arial} - */ - fontFamily?: string; - - /** Specify font Style for custom labels. - * @Default {Bold} - */ - fontStyle?: string; - - /** Specify font size for custom labels. - * @Default {12px} - */ - size?: string; -} - -export interface ScalesCustomLabel { - - /** Value of the custom labels. - */ - value?: string; - - /** Color of the custom labels. - */ - color?: string; - - /** Specify position of custom labels - * @Default {Object} - */ - position?: ScalesCustomLabelsPosition; - - /** Specify font for custom labels - * @Default {Object} - */ - font?: ScalesCustomLabelsFont; -} - -export interface ScalesIndicatorsPosition { - - /** Specify x-axis of position of circular gauge - * @Default {0} - */ - x?: number; - - /** Specify y-axis of position of circular gauge - * @Default {0} - */ - y?: number; -} - -export interface ScalesIndicatorsStateRange { - - /** Specify backgroundColor for indicator of circular gauge - * @Default {null} - */ - backgroundColor?: string; - - /** Specify borderColor for indicator of circular gauge - * @Default {null} - */ - borderColor?: string; - - /** Specify end value for each specified state of circular gauge - * @Default {0} - */ - endValue?: number; - - /** Specify value of the font as the indicator when the indicator style is set with the value "text" of circular gauge - * @Default {null} - */ - font?: any; - - /** Specify start value for each specified state of circular gauge - * @Default {0} - */ - startValue?: number; - - /** Specify value of the text as the indicator when the indicator style is set with the value "text" of circular gauge - */ - text?: string; - - /** Specify value of the textColor as the indicator when the indicator style is set with the value "text" of circular gauge - * @Default {null} - */ - textColor?: string; -} - -export interface ScalesIndicator { - - /** Specify indicator height of circular gauge - * @Default {15} - */ - height?: number; - - /** Specify imageUrl of circular gauge - * @Default {null} - */ - imageUrl?: string; - - /** Specify position of circular gauge - * @Default {Object} - */ - position?: ScalesIndicatorsPosition; - - /** Specify the various states of circular gauge - * @Default {Array} - */ - stateRanges?: ScalesIndicatorsStateRange[]; - - /** Specify indicator style of circular gauge. See IndicatorType - * @Default {Circle} - */ - type?: ej.datavisualization.CircularGauge.IndicatorTypes|string; - - /** Specify indicator width of circular gauge - * @Default {15} - */ - width?: number; -} - -export interface ScalesLabelsFont { - - /** Specify font fontFamily for labels of circular gauge - * @Default {Arial} - */ - fontFamily?: string; - - /** Specify font Style for labels of circular gauge - * @Default {Bold} - */ - fontStyle?: string; - - /** Specify font size for labels of circular gauge - * @Default {11px} - */ - size?: string; -} - -export interface ScalesLabel { - - /** Specify the angle for the labels of circular gauge - * @Default {0} - */ - angle?: number; - - /** Specify labels autoAngle value of circular gauge - * @Default {false} - */ - autoAngle?: boolean; - - /** Specify label color of circular gauge - * @Default {null} - */ - color?: string; - - /** Specify distanceFromScale value for labels of circular gauge - * @Default {0} - */ - distanceFromScale?: number; - - /** Specify font for labels of circular gauge - * @Default {Object} - */ - font?: ScalesLabelsFont; - - /** Specify includeFirstValue of circular gauge - * @Default {true} - */ - includeFirstValue?: boolean; - - /** Specify opacity value for labels of circular gauge - * @Default {null} - */ - opacity?: number; - - /** Specify label placement of circular gauge. See LabelPlacement - * @Default {Near} - */ - placement?: ej.datavisualization.CircularGauge.Placement|string; - - /** Specify label Style of circular gauge. See LabelType - * @Default {Major} - */ - type?: ej.datavisualization.CircularGauge.LabelType|string; - - /** Specify unitText of circular gauge - */ - unitText?: string; - - /** Specify unitTextPosition of circular gauge. See UnitTextPosition - * @Default {Back} - */ - unitTextPosition?: ej.datavisualization.CircularGauge.UnitTextPlacement|string; -} - -export interface ScalesPointerCap { - - /** Specify cap backgroundColor of circular gauge - * @Default {null} - */ - backgroundColor?: string; - - /** Specify cap borderColor of circular gauge - * @Default {null} - */ - borderColor?: string; - - /** Specify pointerCap borderWidth value of circular gauge - * @Default {3} - */ - borderWidth?: number; - - /** Specify cap interiorGradient value of circular gauge - * @Default {null} - */ - interiorGradient?: any; - - /** Specify pointerCap Radius value of circular gauge - * @Default {7} - */ - radius?: number; -} - -export interface ScalesPointersBorder { - - /** Specify border color for pointer of circular gauge - * @Default {null} - */ - color?: string; - - /** Specify border width for pointers of circular gauge - * @Default {1.5} - */ - width?: number; -} - -export interface ScalesPointersPointerValueTextFont { - - /** Specify pointer value text font family of circular gauge. - * @Default {Arial} - */ - fontFamily?: string; - - /** Specify pointer value text font style of circular gauge. - * @Default {Bold} - */ - fontStyle?: string; - - /** Specify pointer value text size of circular gauge. - * @Default {11px} - */ - size?: string; -} - -export interface ScalesPointersPointerValueText { - - /** Specify pointer text angle of circular gauge. - * @Default {0} - */ - angle?: number; - - /** Specify pointer text auto angle of circular gauge. - * @Default {false} - */ - autoAngle?: boolean; - - /** Specify pointer value text color of circular gauge. - * @Default {#8c8c8c} - */ - color?: string; - - /** Specify pointer value text distance from pointer of circular gauge. - * @Default {20} - */ - distance?: number; - - /** Specify pointer value text font option of circular gauge. - * @Default {object} - */ - font?: ScalesPointersPointerValueTextFont; - - /** Specify pointer value text opacity of circular gauge. - * @Default {1} - */ - opacity?: number; - - /** enable pointer value text visibility of circular gauge. - * @Default {false} - */ - showValue?: boolean; -} - -export interface ScalesPointer { - - /** Specify backgroundColor for the pointer of circular gauge - * @Default {null} - */ - backgroundColor?: string; - - /** Specify backNeedleLength of circular gauge - * @Default {10} - */ - backNeedleLength?: number; - - /** Specify the border for pointers of circular gauge - * @Default {Object} - */ - border?: ScalesPointersBorder; - - /** Specify distanceFromScale value for pointers of circular gauge - * @Default {0} - */ - distanceFromScale?: number; - - /** Specify pointer gradients of circular gauge - * @Default {null} - */ - gradients?: any; - - /** Specify pointer image of circular gauge.It is applicable for both marker as well as needle type pointers. - * @Default {NULL} - */ - imageUrl?: string; - - /** Specify pointer length of circular gauge - * @Default {150} - */ - length?: number; - - /** Specify marker Style value of circular gauge. See MarkerType - * @Default {Rectangle} - */ - markerType?: ej.datavisualization.CircularGauge.MarkerType|string; - - /** Specify needle Style value of circular gauge. See NeedleType - * @Default {Triangle} - */ - needleType?: ej.datavisualization.CircularGauge.NeedleType|string; - - /** Specify opacity value for pointer of circular gauge - * @Default {1} - */ - opacity?: number; - - /** Specify radius value for pointer of circular gauge - * @Default {null} - */ - radius?: number; - - /** Specify pointer Placement value of circular gauge. See PointerPlacement - * @Default {Near} - */ - placement?: ej.datavisualization.CircularGauge.Placement|string; - - /** Specify pointer value text of circular gauge. - * @Default {Object} - */ - pointerValueText?: ScalesPointersPointerValueText; - - /** Specify showBackNeedle value of circular gauge - * @Default {false} - */ - showBackNeedle?: boolean; - - /** Specify pointer type value of circular gauge. See PointerType - * @Default {Needle} - */ - type?: ej.datavisualization.CircularGauge.PointerType|string; - - /** Specify value of the pointer of circular gauge - * @Default {null} - */ - value?: number; - - /** Specify pointer width of circular gauge - * @Default {7} - */ - width?: number; -} - -export interface ScalesRangesBorder { - - /** Specify border color for ranges of circular gauge - * @Default {#32b3c6} - */ - color?: string; - - /** Specify border width for ranges of circular gauge - * @Default {1.5} - */ - width?: number; -} - -export interface ScalesRange { - - /** Specify backgroundColor for the ranges of circular gauge - * @Default {#32b3c6} - */ - backgroundColor?: string; - - /** Specify border for ranges of circular gauge - * @Default {Object} - */ - border?: ScalesRangesBorder; - - /** Specify distanceFromScale value for ranges of circular gauge - * @Default {25} - */ - distanceFromScale?: number; - - /** Specify endValue for ranges of circular gauge - * @Default {null} - */ - endValue?: number; - - /** Specify endWidth for ranges of circular gauge - * @Default {10} - */ - endWidth?: number; - - /** Specify range gradients of circular gauge - * @Default {null} - */ - gradients?: any; - - /** Specify opacity value for ranges of circular gauge - * @Default {null} - */ - opacity?: number; - - /** Specify placement of circular gauge. See RangePlacement - * @Default {Near} - */ - placement?: ej.datavisualization.CircularGauge.Placement|string; - - /** Specify size of the range value of circular gauge - * @Default {5} - */ - size?: number; - - /** Specify startValue for ranges of circular gauge - * @Default {null} - */ - startValue?: number; - - /** Specify startWidth of circular gauge - * @Default {[Array.number] scale.ranges.startWidth = 10} - */ - startWidth?: number; -} - -export interface ScalesSubGaugesPosition { - - /** Specify x-axis position for sub-gauge of circular gauge - * @Default {0} - */ - x?: number; - - /** Specify y-axis position for sub-gauge of circular gauge - * @Default {0} - */ - y?: number; -} - -export interface ScalesSubGauge { - - /** Specify subGauge Height of circular gauge - * @Default {150} - */ - height?: number; - - /** Specify position for sub-gauge of circular gauge - * @Default {Object} - */ - position?: ScalesSubGaugesPosition; - - /** Specify subGauge Width of circular gauge - * @Default {150} - */ - width?: number; -} - -export interface ScalesTick { - - /** Specify the angle for the ticks of circular gauge - * @Default {0} - */ - angle?: number; - - /** Specify tick color of circular gauge - * @Default {null} - */ - color?: string; - - /** Specify distanceFromScale value for ticks of circular gauge - * @Default {0} - */ - distanceFromScale?: number; - - /** Specify tick height of circular gauge - * @Default {16} - */ - height?: number; - - /** Specify tick placement of circular gauge. See TickPlacement - * @Default {Near} - */ - placement?: ej.datavisualization.CircularGauge.Placement|string; - - /** Specify tick Style of circular gauge. See TickType - * @Default {Major} - */ - type?: ej.datavisualization.CircularGauge.LabelType|string; - - /** Specify tick width of circular gauge - * @Default {3} - */ - width?: number; -} - -export interface Scale { - - /** Specify backgroundColor for the scale of circular gauge - * @Default {null} - */ - backgroundColor?: string; - - /** Specify border for scales of circular gauge - * @Default {Object} - */ - border?: ScalesBorder; - - /** Specify scale direction of circular gauge. See Directions - * @Default {Clockwise} - */ - direction?: ej.datavisualization.CircularGauge.Direction|string; - - /** Specify the custom labels for the scales. - * @Default {Array} - */ - customLabels?: ScalesCustomLabel[]; - - /** Specify representing state of circular gauge - * @Default {Array} - */ - indicators?: ScalesIndicator[]; - - /** Specify the text values displayed in a meaningful manner alongside the ticks of circular gauge - * @Default {Array} - */ - labels?: ScalesLabel[]; - - /** Specify majorIntervalValue of circular gauge - * @Default {10} - */ - majorIntervalValue?: number; - - /** Specify maximum scale value of circular gauge - * @Default {null} - */ - maximum?: number; - - /** Specify minimum scale value of circular gauge - * @Default {null} - */ - minimum?: number; - - /** Specify minorIntervalValue of circular gauge - * @Default {2} - */ - minorIntervalValue?: number; - - /** Specify opacity value of circular gauge - * @Default {1} - */ - opacity?: number; - - /** Specify pointer cap of circular gauge - * @Default {Object} - */ - pointerCap?: ScalesPointerCap; - - /** Specify pointers value of circular gauge - * @Default {Array} - */ - pointers?: ScalesPointer[]; - - /** Specify scale radius of circular gauge - * @Default {170} - */ - radius?: number; - - /** Specify ranges value of circular gauge - * @Default {Array} - */ - ranges?: ScalesRange[]; - - /** Specify shadowOffset value of circular gauge - * @Default {0} - */ - shadowOffset?: number; - - /** Specify showIndicators of circular gauge - * @Default {false} - */ - showIndicators?: boolean; - - /** Specify showLabels of circular gauge - * @Default {true} - */ - showLabels?: boolean; - - /** Specify showPointers of circular gauge - * @Default {true} - */ - showPointers?: boolean; - - /** Specify showRanges of circular gauge - * @Default {false} - */ - showRanges?: boolean; - - /** Specify showScaleBar of circular gauge - * @Default {false} - */ - showScaleBar?: boolean; - - /** Specify showTicks of circular gauge - * @Default {true} - */ - showTicks?: boolean; - - /** Specify scaleBar size of circular gauge - * @Default {6} - */ - size?: number; - - /** Specify startAngle of circular gauge - * @Default {115} - */ - startAngle?: number; - - /** Specify subGauge of circular gauge - * @Default {Array} - */ - subGauges?: ScalesSubGauge[]; - - /** Specify sweepAngle of circular gauge - * @Default {310} - */ - sweepAngle?: number; - - /** Specify ticks of circular gauge - * @Default {Array} - */ - ticks?: ScalesTick[]; -} - -export interface Tooltip { - - /** enable showCustomLabelTooltip of circular gauge - * @Default {false} - */ - showCustomLabelTooltip?: boolean; - - /** enable showLabelTooltip of circular gauge - * @Default {false} - */ - showLabelTooltip?: boolean; - - /** Specify tooltip templateID of circular gauge - * @Default {false} - */ - templateID?: string; -} -} -namespace CircularGauge { -enum FrameType { -//string -FullCircle, -//string -HalfCircle, -} -} -namespace CircularGauge { -enum gaugePosition { -//string -TopLeft, -//string -TopRight, -//string -TopCenter, -//string -MiddleLeft, -//string -MiddleRight, -//string -Center, -//string -BottomLeft, -//string -BottomRight, -//string -BottomCenter, -} -} -namespace CircularGauge { -enum CustomLabelPositionType { -//string -Top, -//string -Bottom, -//string -Right, -//string -Left, -} -} -namespace CircularGauge { -enum Direction { -//string -Clockwise, -//string -CounterClockwise, -} -} -namespace CircularGauge { -enum IndicatorTypes { -//string -Rectangle, -//string -Circle, -//string -Text, -//string -RoundedRectangle, -//string -Image, -} -} -namespace CircularGauge { -enum Placement { -//string -Near, -//string -Far, -} -} -namespace CircularGauge { -enum LabelType { -//string -Major, -//string -Minor, -} -} -namespace CircularGauge { -enum UnitTextPlacement { -//string -Back, -//string -Front, -} -} -namespace CircularGauge { -enum MarkerType { -//string -Rectangle, -//string -Circle, -//string -Triangle, -//string -Ellipse, -//string -Diamond, -//string -Pentagon, -//string -Slider, -//string -Pointer, -//string -Wedge, -//string -Trapezoid, -//string -RoundedRectangle, -//string -Image, -} -} -namespace CircularGauge { -enum NeedleType { -//string -Triangle, -//string -Rectangle, -//string -Arrow, -//string -Image, -//string -Trapezoid, -} -} -namespace CircularGauge { -enum PointerType { -//string -Needle, -//string -Marker, -} -} - -class DigitalGauge extends ej.Widget { - static fn: DigitalGauge; - constructor(element: JQuery | Element, options?: DigitalGauge.Model); - static Locale: any; - model: DigitalGauge.Model; - defaults: DigitalGauge.Model; - - /** To destroy the digital gauge - * @returns {void} - */ - destroy(): void; - - /** To export Digital Gauge as Image - * @param {string} fileName for the Image - * @param {string} fileType for the Image - * @returns {boolean} - */ - exportImage(fileName: string, fileType: string): boolean; - - /** Gets the location of an item that is displayed on the gauge. - * @param {number} Position value of an item that is displayed on the gauge. - * @returns {any} - */ - getPosition(itemIndex: number): any; - - /** ClientSideMethod getValue Gets the value of an item that is displayed on the gauge - * @param {number} Index value of an item that displayed on the gauge - * @returns {any} - */ - getValue(itemIndex: number): any; - - /** Refresh the digital gauge widget - * @returns {void} - */ - refresh(): void; - - /** ClientSideMethod Set Position Sets the location of an item to be displayed in the gauge - * @param {number} Index value of the digital gauge item - * @param {any} Location value of the digital gauge - * @returns {void} - */ - setPosition(itemIndex: number, value: any): void; - - /** ClientSideMethod SetValue Sets the value of an item to be displayed in the gauge. - * @param {number} Index value of the digital gauge item - * @param {string} Text value to be displayed in the gaugeS - * @returns {void} - */ - setValue(itemIndex: number, value: string): void; -} -export namespace DigitalGauge { - -export interface Model { - - /** Specifies the frame of the Digital gauge. - * @Default {{backgroundImageUrl: null, innerWidth: 6, outerWidth: 10}} - */ - frame?: Frame; - - /** Specifies the height of the DigitalGauge. - * @Default {150} - */ - height?: number; - - /** Specifies the resize option of the DigitalGauge. - * @Default {false} - */ - isResponsive?: boolean; - - /** Specifies the items for the DigitalGauge. - * @Default {null} - */ - items?: Item[]; - - /** Specifies the matrixSegmentData for the DigitalGauge. - */ - matrixSegmentData?: any; - - /** Specifies the segmentData for the DigitalGauge. - */ - segmentData?: any; - - /** Specifies the themes for the Digital gauge. See Themes - * @Default {flatlight} - */ - themes?: string; - - /** Specifies the value to the DigitalGauge. - * @Default {text} - */ - value?: string; - - /** Specifies the width for the Digital gauge. - * @Default {400} - */ - width?: number; - - /** Triggers when the gauge is initialized. */ - init?(e: InitEventArgs): void; - - /** Triggers when the gauge item rendering. */ - itemRendering?(e: ItemRenderingEventArgs): void; - - /** Triggers when the gauge is start to load. */ - load?(e: LoadEventArgs): void; - - /** Triggers when the gauge render is completed. */ - renderComplete?(e: RenderCompleteEventArgs): void; -} - -export interface InitEventArgs { - - /** returns the object of the gauge. - */ - object?: any; - - /** returns the cancel option value - */ - cancel?: boolean; - - /** returns the all the options of the items. - */ - items?: any; - - /** returns the context element - */ - context?: any; - - /** returns the gauge model - */ - model?: any; - - /** returns the name of the event - */ - type?: string; -} - -export interface ItemRenderingEventArgs { - - /** returns the object of the gauge. - */ - object?: any; + export interface RenderCompleteEventArgs { + + /** returns the object of the gauge. + */ + object?: any; + + /** returns the cancel option value + */ + cancel?: boolean; + + /** returns the context element + */ + context?: any; + + /** returns the entire scale element. + */ + scaleElement?: any; + + /** returns the gauge model + */ + model?: any; + + /** returns the name of the event + */ + type?: string; + } + + export interface Frame { + + /** Specify the URL of the frame background image for circular gauge + * @Default {null} + */ + backgroundImageUrl?: string; + + /** Specifies the frameType of circular gauge. See Frame + * @Default {FullCircle} + */ + frameType?: ej.datavisualization.CircularGauge.FrameType | string; + + /** Specifies the end angle for the half circular frame. + * @Default {360} + */ + halfCircleFrameEndAngle?: number; + + /** Specifies the start angle for the half circular frame. + * @Default {180} + */ + halfCircleFrameStartAngle?: number; + } + + export interface ScalesBorder { + + /** Specify border color for scales of circular gauge + * @Default {null} + */ + color?: string; + + /** Specify border width of circular gauge + * @Default {1.5} + */ + width?: number; + } + + export interface ScalesCustomLabelsPosition { + + /** Specify x-axis position of label + * @Default {0} + */ + x?: number; + + /** Specify y-axis position of labels. + * @Default {0} + */ + y?: number; + } + + export interface ScalesCustomLabelsFont { + + /** Specify font fontFamily for custom labels. + * @Default {Arial} + */ + fontFamily?: string; + + /** Specify font Style for custom labels. + * @Default {Bold} + */ + fontStyle?: string; + + /** Specify font size for custom labels. + * @Default {12px} + */ + size?: string; + } + + export interface ScalesCustomLabel { + + /** Value of the custom labels. + */ + value?: string; + + /** Color of the custom labels. + */ + color?: string; + + /** Specify position of custom labels + * @Default {Object} + */ + position?: ScalesCustomLabelsPosition; + + /** Specify font for custom labels + * @Default {Object} + */ + font?: ScalesCustomLabelsFont; + } + + export interface ScalesIndicatorsPosition { + + /** Specify x-axis of position of circular gauge + * @Default {0} + */ + x?: number; + + /** Specify y-axis of position of circular gauge + * @Default {0} + */ + y?: number; + } + + export interface ScalesIndicatorsStateRange { + + /** Specify backgroundColor for indicator of circular gauge + * @Default {null} + */ + backgroundColor?: string; + + /** Specify borderColor for indicator of circular gauge + * @Default {null} + */ + borderColor?: string; + + /** Specify end value for each specified state of circular gauge + * @Default {0} + */ + endValue?: number; + + /** Specify value of the font as the indicator when the indicator style is set with the value "text" of circular gauge + * @Default {null} + */ + font?: any; + + /** Specify start value for each specified state of circular gauge + * @Default {0} + */ + startValue?: number; + + /** Specify value of the text as the indicator when the indicator style is set with the value "text" of circular gauge + */ + text?: string; + + /** Specify value of the textColor as the indicator when the indicator style is set with the value "text" of circular gauge + * @Default {null} + */ + textColor?: string; + } + + export interface ScalesIndicator { + + /** Specify indicator height of circular gauge + * @Default {15} + */ + height?: number; + + /** Specify imageUrl of circular gauge + * @Default {null} + */ + imageUrl?: string; + + /** Specify position of circular gauge + * @Default {Object} + */ + position?: ScalesIndicatorsPosition; + + /** Specify the various states of circular gauge + * @Default {Array} + */ + stateRanges?: ScalesIndicatorsStateRange[]; + + /** Specify indicator style of circular gauge. See IndicatorType + * @Default {Circle} + */ + type?: ej.datavisualization.CircularGauge.IndicatorTypes | string; + + /** Specify indicator width of circular gauge + * @Default {15} + */ + width?: number; + } + + export interface ScalesLabelsFont { + + /** Specify font fontFamily for labels of circular gauge + * @Default {Arial} + */ + fontFamily?: string; + + /** Specify font Style for labels of circular gauge + * @Default {Bold} + */ + fontStyle?: string; + + /** Specify font size for labels of circular gauge + * @Default {11px} + */ + size?: string; + } + + export interface ScalesLabel { + + /** Specify the angle for the labels of circular gauge + * @Default {0} + */ + angle?: number; + + /** Specify labels autoAngle value of circular gauge + * @Default {false} + */ + autoAngle?: boolean; + + /** Specify label color of circular gauge + * @Default {null} + */ + color?: string; + + /** Specify distanceFromScale value for labels of circular gauge + * @Default {0} + */ + distanceFromScale?: number; + + /** Specify font for labels of circular gauge + * @Default {Object} + */ + font?: ScalesLabelsFont; + + /** Specify includeFirstValue of circular gauge + * @Default {true} + */ + includeFirstValue?: boolean; + + /** Specify opacity value for labels of circular gauge + * @Default {null} + */ + opacity?: number; + + /** Specify label placement of circular gauge. See LabelPlacement + * @Default {Near} + */ + placement?: ej.datavisualization.CircularGauge.Placement | string; + + /** Specify label Style of circular gauge. See LabelType + * @Default {Major} + */ + type?: ej.datavisualization.CircularGauge.LabelType | string; + + /** Specify unitText of circular gauge + */ + unitText?: string; + + /** Specify unitTextPosition of circular gauge. See UnitTextPosition + * @Default {Back} + */ + unitTextPosition?: ej.datavisualization.CircularGauge.UnitTextPlacement | string; + } + + export interface ScalesPointerCap { + + /** Specify cap backgroundColor of circular gauge + * @Default {null} + */ + backgroundColor?: string; + + /** Specify cap borderColor of circular gauge + * @Default {null} + */ + borderColor?: string; + + /** Specify pointerCap borderWidth value of circular gauge + * @Default {3} + */ + borderWidth?: number; + + /** Specify cap interiorGradient value of circular gauge + * @Default {null} + */ + interiorGradient?: any; + + /** Specify pointerCap Radius value of circular gauge + * @Default {7} + */ + radius?: number; + } + + export interface ScalesPointersBorder { + + /** Specify border color for pointer of circular gauge + * @Default {null} + */ + color?: string; + + /** Specify border width for pointers of circular gauge + * @Default {1.5} + */ + width?: number; + } + + export interface ScalesPointersPointerValueTextFont { + + /** Specify pointer value text font family of circular gauge. + * @Default {Arial} + */ + fontFamily?: string; + + /** Specify pointer value text font style of circular gauge. + * @Default {Bold} + */ + fontStyle?: string; + + /** Specify pointer value text size of circular gauge. + * @Default {11px} + */ + size?: string; + } + + export interface ScalesPointersPointerValueText { + + /** Specify pointer text angle of circular gauge. + * @Default {0} + */ + angle?: number; + + /** Specify pointer text auto angle of circular gauge. + * @Default {false} + */ + autoAngle?: boolean; + + /** Specify pointer value text color of circular gauge. + * @Default {#8c8c8c} + */ + color?: string; + + /** Specify pointer value text distance from pointer of circular gauge. + * @Default {20} + */ + distance?: number; + + /** Specify pointer value text font option of circular gauge. + * @Default {object} + */ + font?: ScalesPointersPointerValueTextFont; + + /** Specify pointer value text opacity of circular gauge. + * @Default {1} + */ + opacity?: number; + + /** enable pointer value text visibility of circular gauge. + * @Default {false} + */ + showValue?: boolean; + } + + export interface ScalesPointer { + + /** Specify backgroundColor for the pointer of circular gauge + * @Default {null} + */ + backgroundColor?: string; + + /** Specify backNeedleLength of circular gauge + * @Default {10} + */ + backNeedleLength?: number; + + /** Specify the border for pointers of circular gauge + * @Default {Object} + */ + border?: ScalesPointersBorder; + + /** Specify distanceFromScale value for pointers of circular gauge + * @Default {0} + */ + distanceFromScale?: number; + + /** Specify pointer gradients of circular gauge + * @Default {null} + */ + gradients?: any; + + /** Specify pointer image of circular gauge.It is applicable for both marker as well as needle type pointers. + * @Default {NULL} + */ + imageUrl?: string; + + /** Specify pointer length of circular gauge + * @Default {150} + */ + length?: number; + + /** Specify marker Style value of circular gauge. See MarkerType + * @Default {Rectangle} + */ + markerType?: ej.datavisualization.CircularGauge.MarkerType | string; + + /** Specify needle Style value of circular gauge. See NeedleType + * @Default {Triangle} + */ + needleType?: ej.datavisualization.CircularGauge.NeedleType | string; + + /** Specify opacity value for pointer of circular gauge + * @Default {1} + */ + opacity?: number; + + /** Specify radius value for pointer of circular gauge + * @Default {null} + */ + radius?: number; + + /** Specify pointer Placement value of circular gauge. See PointerPlacement + * @Default {Near} + */ + placement?: ej.datavisualization.CircularGauge.Placement | string; + + /** Specify pointer value text of circular gauge. + * @Default {Object} + */ + pointerValueText?: ScalesPointersPointerValueText; + + /** Specify showBackNeedle value of circular gauge + * @Default {false} + */ + showBackNeedle?: boolean; + + /** Specify pointer type value of circular gauge. See PointerType + * @Default {Needle} + */ + type?: ej.datavisualization.CircularGauge.PointerType | string; + + /** Specify value of the pointer of circular gauge + * @Default {null} + */ + value?: number; + + /** Specify pointer width of circular gauge + * @Default {7} + */ + width?: number; + } + + export interface ScalesRangesBorder { + + /** Specify border color for ranges of circular gauge + * @Default {#32b3c6} + */ + color?: string; + + /** Specify border width for ranges of circular gauge + * @Default {1.5} + */ + width?: number; + } + + export interface ScalesRange { + + /** Specify backgroundColor for the ranges of circular gauge + * @Default {#32b3c6} + */ + backgroundColor?: string; + + /** Specify border for ranges of circular gauge + * @Default {Object} + */ + border?: ScalesRangesBorder; + + /** Specify distanceFromScale value for ranges of circular gauge + * @Default {25} + */ + distanceFromScale?: number; + + /** Specify endValue for ranges of circular gauge + * @Default {null} + */ + endValue?: number; + + /** Specify endWidth for ranges of circular gauge + * @Default {10} + */ + endWidth?: number; + + /** Specify range gradients of circular gauge + * @Default {null} + */ + gradients?: any; + + /** Specify opacity value for ranges of circular gauge + * @Default {null} + */ + opacity?: number; + + /** Specify placement of circular gauge. See RangePlacement + * @Default {Near} + */ + placement?: ej.datavisualization.CircularGauge.Placement | string; + + /** Specify size of the range value of circular gauge + * @Default {5} + */ + size?: number; + + /** Specify startValue for ranges of circular gauge + * @Default {null} + */ + startValue?: number; + + /** Specify startWidth of circular gauge + * @Default {[Array.number] scale.ranges.startWidth = 10} + */ + startWidth?: number; + } + + export interface ScalesSubGaugesPosition { + + /** Specify x-axis position for sub-gauge of circular gauge + * @Default {0} + */ + x?: number; + + /** Specify y-axis position for sub-gauge of circular gauge + * @Default {0} + */ + y?: number; + } + + export interface ScalesSubGauge { + + /** Specify subGauge Height of circular gauge + * @Default {150} + */ + height?: number; + + /** Specify position for sub-gauge of circular gauge + * @Default {Object} + */ + position?: ScalesSubGaugesPosition; + + /** Specify subGauge Width of circular gauge + * @Default {150} + */ + width?: number; + } + + export interface ScalesTick { + + /** Specify the angle for the ticks of circular gauge + * @Default {0} + */ + angle?: number; + + /** Specify tick color of circular gauge + * @Default {null} + */ + color?: string; + + /** Specify distanceFromScale value for ticks of circular gauge + * @Default {0} + */ + distanceFromScale?: number; + + /** Specify tick height of circular gauge + * @Default {16} + */ + height?: number; + + /** Specify tick placement of circular gauge. See TickPlacement + * @Default {Near} + */ + placement?: ej.datavisualization.CircularGauge.Placement | string; + + /** Specify tick Style of circular gauge. See TickType + * @Default {Major} + */ + type?: ej.datavisualization.CircularGauge.LabelType | string; + + /** Specify tick width of circular gauge + * @Default {3} + */ + width?: number; + } + + export interface Scale { + + /** Specify backgroundColor for the scale of circular gauge + * @Default {null} + */ + backgroundColor?: string; + + /** Specify border for scales of circular gauge + * @Default {Object} + */ + border?: ScalesBorder; + + /** Specify scale direction of circular gauge. See Directions + * @Default {Clockwise} + */ + direction?: ej.datavisualization.CircularGauge.Direction | string; + + /** Specify the custom labels for the scales. + * @Default {Array} + */ + customLabels?: ScalesCustomLabel[]; + + /** Specify representing state of circular gauge + * @Default {Array} + */ + indicators?: ScalesIndicator[]; + + /** Specify the text values displayed in a meaningful manner alongside the ticks of circular gauge + * @Default {Array} + */ + labels?: ScalesLabel[]; + + /** Specify majorIntervalValue of circular gauge + * @Default {10} + */ + majorIntervalValue?: number; + + /** Specify maximum scale value of circular gauge + * @Default {null} + */ + maximum?: number; + + /** Specify minimum scale value of circular gauge + * @Default {null} + */ + minimum?: number; + + /** Specify minorIntervalValue of circular gauge + * @Default {2} + */ + minorIntervalValue?: number; + + /** Specify opacity value of circular gauge + * @Default {1} + */ + opacity?: number; + + /** Specify pointer cap of circular gauge + * @Default {Object} + */ + pointerCap?: ScalesPointerCap; + + /** Specify pointers value of circular gauge + * @Default {Array} + */ + pointers?: ScalesPointer[]; + + /** Specify scale radius of circular gauge + * @Default {170} + */ + radius?: number; + + /** Specify ranges value of circular gauge + * @Default {Array} + */ + ranges?: ScalesRange[]; + + /** Specify shadowOffset value of circular gauge + * @Default {0} + */ + shadowOffset?: number; + + /** Specify showIndicators of circular gauge + * @Default {false} + */ + showIndicators?: boolean; + + /** Specify showLabels of circular gauge + * @Default {true} + */ + showLabels?: boolean; + + /** Specify showPointers of circular gauge + * @Default {true} + */ + showPointers?: boolean; + + /** Specify showRanges of circular gauge + * @Default {false} + */ + showRanges?: boolean; + + /** Specify showScaleBar of circular gauge + * @Default {false} + */ + showScaleBar?: boolean; + + /** Specify showTicks of circular gauge + * @Default {true} + */ + showTicks?: boolean; + + /** Specify scaleBar size of circular gauge + * @Default {6} + */ + size?: number; + + /** Specify startAngle of circular gauge + * @Default {115} + */ + startAngle?: number; + + /** Specify subGauge of circular gauge + * @Default {Array} + */ + subGauges?: ScalesSubGauge[]; + + /** Specify sweepAngle of circular gauge + * @Default {310} + */ + sweepAngle?: number; + + /** Specify ticks of circular gauge + * @Default {Array} + */ + ticks?: ScalesTick[]; + } + + export interface Tooltip { + + /** enable showCustomLabelTooltip of circular gauge + * @Default {false} + */ + showCustomLabelTooltip?: boolean; + + /** enable showLabelTooltip of circular gauge + * @Default {false} + */ + showLabelTooltip?: boolean; + + /** Specify tooltip templateID of circular gauge + * @Default {false} + */ + templateID?: string; + } + } + namespace CircularGauge { + enum FrameType { + //string + FullCircle, + //string + HalfCircle, + } + } + namespace CircularGauge { + enum gaugePosition { + //string + TopLeft, + //string + TopRight, + //string + TopCenter, + //string + MiddleLeft, + //string + MiddleRight, + //string + Center, + //string + BottomLeft, + //string + BottomRight, + //string + BottomCenter, + } + } + namespace CircularGauge { + enum CustomLabelPositionType { + //string + Top, + //string + Bottom, + //string + Right, + //string + Left, + } + } + namespace CircularGauge { + enum Direction { + //string + Clockwise, + //string + CounterClockwise, + } + } + namespace CircularGauge { + enum IndicatorTypes { + //string + Rectangle, + //string + Circle, + //string + Text, + //string + RoundedRectangle, + //string + Image, + } + } + namespace CircularGauge { + enum Placement { + //string + Near, + //string + Far, + } + } + namespace CircularGauge { + enum LabelType { + //string + Major, + //string + Minor, + } + } + namespace CircularGauge { + enum UnitTextPlacement { + //string + Back, + //string + Front, + } + } + namespace CircularGauge { + enum MarkerType { + //string + Rectangle, + //string + Circle, + //string + Triangle, + //string + Ellipse, + //string + Diamond, + //string + Pentagon, + //string + Slider, + //string + Pointer, + //string + Wedge, + //string + Trapezoid, + //string + RoundedRectangle, + //string + Image, + } + } + namespace CircularGauge { + enum NeedleType { + //string + Triangle, + //string + Rectangle, + //string + Arrow, + //string + Image, + //string + Trapezoid, + } + } + namespace CircularGauge { + enum PointerType { + //string + Needle, + //string + Marker, + } + } + + class DigitalGauge extends ej.Widget { + static fn: DigitalGauge; + constructor(element: JQuery | Element, options?: DigitalGauge.Model); + static Locale: any; + model: DigitalGauge.Model; + defaults: DigitalGauge.Model; + + /** To destroy the digital gauge + * @returns {void} + */ + destroy(): void; + + /** To export Digital Gauge as Image + * @param {string} fileName for the Image + * @param {string} fileType for the Image + * @returns {boolean} + */ + exportImage(fileName: string, fileType: string): boolean; + + /** Gets the location of an item that is displayed on the gauge. + * @param {number} Position value of an item that is displayed on the gauge. + * @returns {any} + */ + getPosition(itemIndex: number): any; + + /** ClientSideMethod getValue Gets the value of an item that is displayed on the gauge + * @param {number} Index value of an item that displayed on the gauge + * @returns {any} + */ + getValue(itemIndex: number): any; + + /** Refresh the digital gauge widget + * @returns {void} + */ + refresh(): void; + + /** ClientSideMethod Set Position Sets the location of an item to be displayed in the gauge + * @param {number} Index value of the digital gauge item + * @param {any} Location value of the digital gauge + * @returns {void} + */ + setPosition(itemIndex: number, value: any): void; + + /** ClientSideMethod SetValue Sets the value of an item to be displayed in the gauge. + * @param {number} Index value of the digital gauge item + * @param {string} Text value to be displayed in the gaugeS + * @returns {void} + */ + setValue(itemIndex: number, value: string): void; + } + export namespace DigitalGauge { + + export interface Model { + + /** Specifies the frame of the Digital gauge. + * @Default {{backgroundImageUrl: null, innerWidth: 6, outerWidth: 10}} + */ + frame?: Frame; + + /** Specifies the height of the DigitalGauge. + * @Default {150} + */ + height?: number; + + /** Specifies the resize option of the DigitalGauge. + * @Default {false} + */ + isResponsive?: boolean; + + /** Specifies the items for the DigitalGauge. + * @Default {null} + */ + items?: Item[]; + + /** Specifies the matrixSegmentData for the DigitalGauge. + */ + matrixSegmentData?: any; + + /** Specifies the segmentData for the DigitalGauge. + */ + segmentData?: any; + + /** Specifies the themes for the Digital gauge. See Themes + * @Default {flatlight} + */ + themes?: string; + + /** Specifies the value to the DigitalGauge. + * @Default {text} + */ + value?: string; + + /** Specifies the width for the Digital gauge. + * @Default {400} + */ + width?: number; + + /** Triggers when the gauge is initialized. */ + init?(e: InitEventArgs): void; + + /** Triggers when the gauge item rendering. */ + itemRendering?(e: ItemRenderingEventArgs): void; + + /** Triggers when the gauge is start to load. */ + load?(e: LoadEventArgs): void; + + /** Triggers when the gauge render is completed. */ + renderComplete?(e: RenderCompleteEventArgs): void; + } + + export interface InitEventArgs { + + /** returns the object of the gauge. + */ + object?: any; + + /** returns the cancel option value + */ + cancel?: boolean; + + /** returns the all the options of the items. + */ + items?: any; + + /** returns the context element + */ + context?: any; + + /** returns the gauge model + */ + model?: any; + + /** returns the name of the event + */ + type?: string; + } + + export interface ItemRenderingEventArgs { + + /** returns the object of the gauge. + */ + object?: any; - /** returns the cancel option value - */ - cancel?: boolean; - - /** returns the all the options of the items. - */ - items?: any; + /** returns the cancel option value + */ + cancel?: boolean; + + /** returns the all the options of the items. + */ + items?: any; - /** returns the context element - */ - context?: any; - - /** returns the gauge model - */ - model?: any; + /** returns the context element + */ + context?: any; + + /** returns the gauge model + */ + model?: any; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface LoadEventArgs { + export interface LoadEventArgs { - /** returns the object of the gauge. - */ - object?: any; - - /** returns the cancel option value - */ - cancel?: boolean; + /** returns the object of the gauge. + */ + object?: any; + + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the all the options of the items. - */ - items?: any; + /** returns the all the options of the items. + */ + items?: any; - /** returns the context element - */ - context?: any; + /** returns the context element + */ + context?: any; - /** returns the gauge model - */ - model?: any; + /** returns the gauge model + */ + model?: any; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface RenderCompleteEventArgs { + export interface RenderCompleteEventArgs { - /** returns the object of the gauge. - */ - object?: any; + /** returns the object of the gauge. + */ + object?: any; - /** returns the cancel option value - */ - cancel?: boolean; - - /** returns the all the options of the items. - */ - items?: any; - - /** returns the context element - */ - context?: any; - - /** returns the gauge model - */ - model?: any; - - /** returns the name of the event - */ - type?: string; -} - -export interface Frame { - - /** Specifies the URL of an image to be displayed as background of the Digital gauge. - * @Default {null} - */ - backgroundImageUrl?: string; - - /** Specifies the inner width for the frame, when the background image has been set for the Digital gauge.. - * @Default {6} - */ - innerWidth?: number; - - /** Specifies the outer width of the frame, when the background image has been set for the Digital gauge. - * @Default {10} - */ - outerWidth?: number; -} - -export interface ItemsCharacterSettings { - - /** Specifies the CharacterCount value for the DigitalGauge. - * @Default {4} - */ - count?: number; - - /** Specifies the opacity value for the DigitalGauge. - * @Default {1} - */ - opacity?: number; - - /** Specifies the value for spacing between the characters - * @Default {2} - */ - spacing?: number; - - /** Specifies the character type for the text to be displayed. - * @Default {ej.datavisualization.DigitalGauge.CharacterType.EightCrossEightDotMatrix} - */ - type?: ej.datavisualization.DigitalGauge.CharacterType|string; -} - -export interface ItemsFont { - - /** Set the font family value - * @Default {Arial} - */ - fontFamily?: string; - - /** Set the font style for the font - * @Default {italic} - */ - fontStyle?: ej.datavisualization.DigitalGauge.FontStyle|string; - - /** Set the font size value - * @Default {11px} - */ - size?: string; -} - -export interface ItemsPosition { - - /** Set the horizontal location for the text, where it needs to be placed within the gauge. - * @Default {0} - */ - x?: number; - - /** Set the vertical location for the text, where it needs to be placed within the gauge. - * @Default {0} - */ - y?: number; -} - -export interface ItemsSegmentSettings { - - /** Set the color for the text segments. - * @Default {null} - */ - color?: string; - - /** Set the gradient for the text segments. - * @Default {null} - */ - gradient?: any; - - /** Set the length for the text segments. - * @Default {2} - */ - length?: number; - - /** Set the opacity for the text segments. - * @Default {0} - */ - opacity?: number; - - /** Set the spacing for the text segments. - * @Default {1} - */ - spacing?: number; - - /** Set the width for the text segments. - * @Default {1} - */ - width?: number; -} - -export interface Item { - - /** Specifies the Character settings for the DigitalGauge. - * @Default {null} - */ - characterSettings?: ItemsCharacterSettings; - - /** Enable/Disable the custom font to be applied to the text in the gauge. - * @Default {false} - */ - enableCustomFont?: boolean; - - /** Set the specific font for the text, when the enableCustomFont is set to true - * @Default {null} - */ - font?: ItemsFont; - - /** Set the location for the text, where it needs to be placed within the gauge. - * @Default {null} - */ - position?: ItemsPosition; - - /** Set the segment settings for the digital gauge. - * @Default {null} - */ - segmentSettings?: ItemsSegmentSettings; - - /** Set the value for enabling/disabling the blurring effect for the shadows of the text - * @Default {0} - */ - shadowBlur?: number; - - /** Specifies the color of the text shadow. - * @Default {null} - */ - shadowColor?: string; - - /** Set the x offset value for the shadow of the text, indicating the location where it needs to be displayed. - * @Default {1} - */ - shadowOffsetX?: number; - - /** Set the y offset value for the shadow of the text, indicating the location where it needs to be displayed. - * @Default {1} - */ - shadowOffsetY?: number; - - /** Set the alignment of the text that is displayed within the gauge.See TextAlign - * @Default {left} - */ - textAlign?: string; - - /** Specifies the color of the text. - * @Default {null} - */ - textColor?: string; - - /** Specifies the text value. - * @Default {null} - */ - value?: string; -} -} -namespace DigitalGauge { -enum CharacterType { -//string -SevenSegment, -//string -FourteenSegment, -//string -SixteenSegment, -//string -EightCrossEightDotMatrix, -//string -EightCrossEightSquareMatrix, -} -} -namespace DigitalGauge { -enum FontStyle { -//string -Normal, -//string -Bold, -//string -Italic, -//string -Underline, -//string -Strikeout, -} -} - -class Chart extends ej.Widget { - static fn: Chart; - constructor(element: JQuery | Element, options?: Chart.Model); - static Locale: any; - model: Chart.Model; - defaults: Chart.Model; - - /** Animates the series and/or indicators in Chart. When parameter is not passed to this method, then all the series and indicators present in Chart are animated. - * @param {any} If an array collection is passed as parameter, series and indicator objects passed in array collection are animated.ExampleIf a series - * or indicator object is passed to this method, then the specific series or indicator is animated.Example, - * @returns {void} - */ - animate(options: any): void; - - /** Exports chart as an image or to an excel file. Chart can be exported as an image only when exportCanvasRendering option is set to true. - * @param {string} Type of the export operation to be performed. Following are the two export types that are supported now,1. 'image'2. 'excel'Example - * @param {string} URL of the service, where the chart will be exported to excel.Example, - * @param {boolean} When this parameter is true, all the chart objects initialized to the same document are exported to a single excel file. - * This is an optional parameter. By default, it is false.Example, - * @returns {any} - */ - export(type: string, URL: string, exportMultipleChart: boolean): any; - - /** Redraws the entire chart. You can call this method whenever you update, add or remove points from the data source or whenever you want to refresh the UI. - * @returns {void} - */ - redraw(): void; -} -export namespace Chart { - -export interface Model { - - /** Options for adding and customizing annotations in Chart. - */ - annotations?: Annotation[]; - - /** URL of the image to be used as chart background. - * @Default {null} - */ - backGroundImageUrl?: string; - - /** Options for customizing the color, opacity and width of the chart border. - */ - border?: Border; - - /** This provides options for customizing export settings - */ - exportSettings?: ExportSettings; - - /** Options for configuring the border and background of the plot area. - */ - chartArea?: ChartArea; - - /** Options to split Chart into multiple plotting areas vertically. Each object in the collection represents a plotting area in Chart. - */ - columnDefinitions?: ColumnDefinition[]; - - /** Options for configuring the properties of all the series. You can also override the options for specific series by using series collection. - */ - commonSeriesOptions?: CommonSeriesOptions; - - /** Options for displaying and customizing the crosshair. - */ - crosshair?: Crosshair; - - /** Depth of the 3D Chart from front view of series to background wall. This property is applicable only for 3D view. - * @Default {100} - */ - depth?: number; - - /** Controls whether 3D view has to be enabled or not. 3D view is supported only for column, bar. Stacking column, stacking bar, pie and doughnut series types. - * @Default {false} - */ - enable3D?: boolean; - - /** Controls whether Chart has to be rendered as Canvas or SVG. Canvas rendering supports all functionalities in SVG rendering except 3D Charts. - * @Default {false} - */ - enableCanvasRendering?: boolean; - - /** Controls whether the series has to be rendered at initial loading of chart, this will be useful in scenarios where chart is placed at the bottom of the web page - * and we need to render the series only when the chart is visible while scrolling to the top. - * @Default {true} - */ - initSeriesRender?: boolean; - - /** Controls whether 3D view has to be rotated on dragging. This property is applicable only for 3D view. - * @Default {false} - */ - enableRotation?: boolean; - - /** Options to customize the technical indicators. - */ - indicators?: Indicator[]; - - /** Controls whether Chart has to be responsive while resizing. - * @Default {false} - */ - isResponsive?: boolean; - - /** Options to customize the legend items and legend title. - */ - legend?: Legend; - - /** Name of the culture based on which chart should be localized. Number and date time values are localized with respect to the culture name.String type properties like title text are - * not localized automatically. Provide localized text as value to string type properties. - * @Default {en-US} - */ - locale?: string; - - /** Palette is used to store the series fill color in array and apply the color to series collection in the order of series index. - * @Default {null} - */ - palette?: any[]; - - /** Options to customize the left, right, top and bottom margins of chart area. - */ - Margin?: any; - - /** Perspective angle of the 3D view. Chart appears closer when perspective angle is decreased, and distant when perspective angle is increased. - * This property is applicable only when 3D view is enabled - * @Default {90} - */ - perspectiveAngle?: number; - - /** This is a horizontal axis that contains options to configure axis and it is the primary x axis for all the series in series array. - * To override x axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. - * Then, assign the name to the seriesĂ¢â‚¬â„¢s xAxisName property to link both axis and series. - */ - primaryXAxis?: PrimaryXAxis; - - /** To override x axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. - * Then, assign the name to the seriesĂ¢â‚¬â„¢s xAxisName property to link both axis and series. - */ - axes?: Axis[]; - - /** This is a vertical axis that contains options to configure axis. This is the primary y axis for all the series in series array. - * To override y axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. - * Then, assign the name to the seriesĂ¢â‚¬â„¢s yAxisName property to link both axis and series. - */ - primaryYAxis?: PrimaryYAxis; - - /** Rotation angle of the 3D view. This property is applicable only when 3D view is enabled. - * @Default {0} - */ - rotation?: number; + /** returns the cancel option value + */ + cancel?: boolean; + + /** returns the all the options of the items. + */ + items?: any; + + /** returns the context element + */ + context?: any; + + /** returns the gauge model + */ + model?: any; + + /** returns the name of the event + */ + type?: string; + } + + export interface Frame { + + /** Specifies the URL of an image to be displayed as background of the Digital gauge. + * @Default {null} + */ + backgroundImageUrl?: string; + + /** Specifies the inner width for the frame, when the background image has been set for the Digital gauge.. + * @Default {6} + */ + innerWidth?: number; + + /** Specifies the outer width of the frame, when the background image has been set for the Digital gauge. + * @Default {10} + */ + outerWidth?: number; + } + + export interface ItemsCharacterSettings { + + /** Specifies the CharacterCount value for the DigitalGauge. + * @Default {4} + */ + count?: number; + + /** Specifies the opacity value for the DigitalGauge. + * @Default {1} + */ + opacity?: number; + + /** Specifies the value for spacing between the characters + * @Default {2} + */ + spacing?: number; + + /** Specifies the character type for the text to be displayed. + * @Default {ej.datavisualization.DigitalGauge.CharacterType.EightCrossEightDotMatrix} + */ + type?: ej.datavisualization.DigitalGauge.CharacterType | string; + } + + export interface ItemsFont { + + /** Set the font family value + * @Default {Arial} + */ + fontFamily?: string; + + /** Set the font style for the font + * @Default {italic} + */ + fontStyle?: ej.datavisualization.DigitalGauge.FontStyle | string; + + /** Set the font size value + * @Default {11px} + */ + size?: string; + } + + export interface ItemsPosition { + + /** Set the horizontal location for the text, where it needs to be placed within the gauge. + * @Default {0} + */ + x?: number; + + /** Set the vertical location for the text, where it needs to be placed within the gauge. + * @Default {0} + */ + y?: number; + } + + export interface ItemsSegmentSettings { + + /** Set the color for the text segments. + * @Default {null} + */ + color?: string; + + /** Set the gradient for the text segments. + * @Default {null} + */ + gradient?: any; + + /** Set the length for the text segments. + * @Default {2} + */ + length?: number; + + /** Set the opacity for the text segments. + * @Default {0} + */ + opacity?: number; + + /** Set the spacing for the text segments. + * @Default {1} + */ + spacing?: number; + + /** Set the width for the text segments. + * @Default {1} + */ + width?: number; + } + + export interface Item { + + /** Specifies the Character settings for the DigitalGauge. + * @Default {null} + */ + characterSettings?: ItemsCharacterSettings; + + /** Enable/Disable the custom font to be applied to the text in the gauge. + * @Default {false} + */ + enableCustomFont?: boolean; + + /** Set the specific font for the text, when the enableCustomFont is set to true + * @Default {null} + */ + font?: ItemsFont; + + /** Set the location for the text, where it needs to be placed within the gauge. + * @Default {null} + */ + position?: ItemsPosition; + + /** Set the segment settings for the digital gauge. + * @Default {null} + */ + segmentSettings?: ItemsSegmentSettings; + + /** Set the value for enabling/disabling the blurring effect for the shadows of the text + * @Default {0} + */ + shadowBlur?: number; + + /** Specifies the color of the text shadow. + * @Default {null} + */ + shadowColor?: string; + + /** Set the x offset value for the shadow of the text, indicating the location where it needs to be displayed. + * @Default {1} + */ + shadowOffsetX?: number; + + /** Set the y offset value for the shadow of the text, indicating the location where it needs to be displayed. + * @Default {1} + */ + shadowOffsetY?: number; + + /** Set the alignment of the text that is displayed within the gauge.See TextAlign + * @Default {left} + */ + textAlign?: string; + + /** Specifies the color of the text. + * @Default {null} + */ + textColor?: string; + + /** Specifies the text value. + * @Default {null} + */ + value?: string; + } + } + namespace DigitalGauge { + enum CharacterType { + //string + SevenSegment, + //string + FourteenSegment, + //string + SixteenSegment, + //string + EightCrossEightDotMatrix, + //string + EightCrossEightSquareMatrix, + } + } + namespace DigitalGauge { + enum FontStyle { + //string + Normal, + //string + Bold, + //string + Italic, + //string + Underline, + //string + Strikeout, + } + } + + class Chart extends ej.Widget { + static fn: Chart; + constructor(element: JQuery | Element, options?: Chart.Model); + static Locale: any; + model: Chart.Model; + defaults: Chart.Model; + + /** Animates the series and/or indicators in Chart. When parameter is not passed to this method, then all the series and indicators present in Chart are animated. + * @param {any} If an array collection is passed as parameter, series and indicator objects passed in array collection are animated.ExampleIf a series + * or indicator object is passed to this method, then the specific series or indicator is animated.Example, + * @returns {void} + */ + animate(options: any): void; + + /** Exports chart as an image or to an excel file. Chart can be exported as an image only when exportCanvasRendering option is set to true. + * @param {string} Type of the export operation to be performed. Following are the two export types that are supported now,1. 'image'2. 'excel'Example + * @param {string} URL of the service, where the chart will be exported to excel.Example, + * @param {boolean} When this parameter is true, all the chart objects initialized to the same document are exported to a single excel file. + * This is an optional parameter. By default, it is false.Example, + * @returns {any} + */ + export(type: string, URL: string, exportMultipleChart: boolean): any; + + /** Redraws the entire chart. You can call this method whenever you update, add or remove points from the data source or whenever you want to refresh the UI. + * @returns {void} + */ + redraw(): void; + } + export namespace Chart { + + export interface Model { + + /** Options for adding and customizing annotations in Chart. + */ + annotations?: Annotation[]; + + /** URL of the image to be used as chart background. + * @Default {null} + */ + backGroundImageUrl?: string; + + /** Options for customizing the color, opacity and width of the chart border. + */ + border?: Border; + + /** This provides options for customizing export settings + */ + exportSettings?: ExportSettings; + + /** Options for configuring the border and background of the plot area. + */ + chartArea?: ChartArea; + + /** Options to split Chart into multiple plotting areas vertically. Each object in the collection represents a plotting area in Chart. + */ + columnDefinitions?: ColumnDefinition[]; + + /** Options for configuring the properties of all the series. You can also override the options for specific series by using series collection. + */ + commonSeriesOptions?: CommonSeriesOptions; + + /** Options for displaying and customizing the crosshair. + */ + crosshair?: Crosshair; + + /** Depth of the 3D Chart from front view of series to background wall. This property is applicable only for 3D view. + * @Default {100} + */ + depth?: number; + + /** Controls whether 3D view has to be enabled or not. 3D view is supported only for column, bar. Stacking column, stacking bar, pie and doughnut series types. + * @Default {false} + */ + enable3D?: boolean; + + /** Controls whether Chart has to be rendered as Canvas or SVG. Canvas rendering supports all functionalities in SVG rendering except 3D Charts. + * @Default {false} + */ + enableCanvasRendering?: boolean; + + /** Controls whether the series has to be rendered at initial loading of chart, this will be useful in scenarios where chart is placed at the bottom of the web page + * and we need to render the series only when the chart is visible while scrolling to the top. + * @Default {true} + */ + initSeriesRender?: boolean; + + /** Controls whether 3D view has to be rotated on dragging. This property is applicable only for 3D view. + * @Default {false} + */ + enableRotation?: boolean; + + /** Options to customize the technical indicators. + */ + indicators?: Indicator[]; + + /** Controls whether Chart has to be responsive while resizing. + * @Default {false} + */ + isResponsive?: boolean; + + /** Options to customize the legend items and legend title. + */ + legend?: Legend; + + /** Name of the culture based on which chart should be localized. Number and date time values are localized with respect to the culture name.String type properties like title text are + * not localized automatically. Provide localized text as value to string type properties. + * @Default {en-US} + */ + locale?: string; + + /** Palette is used to store the series fill color in array and apply the color to series collection in the order of series index. + * @Default {null} + */ + palette?: any[]; + + /** Options to customize the left, right, top and bottom margins of chart area. + */ + Margin?: any; + + /** Perspective angle of the 3D view. Chart appears closer when perspective angle is decreased, and distant when perspective angle is increased. + * This property is applicable only when 3D view is enabled + * @Default {90} + */ + perspectiveAngle?: number; + + /** This is a horizontal axis that contains options to configure axis and it is the primary x axis for all the series in series array. + * To override x axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. + * Then, assign the name to the seriesĂ¢â‚¬â„¢s xAxisName property to link both axis and series. + */ + primaryXAxis?: PrimaryXAxis; + + /** To override x axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. + * Then, assign the name to the seriesĂ¢â‚¬â„¢s xAxisName property to link both axis and series. + */ + axes?: Axis[]; + + /** This is a vertical axis that contains options to configure axis. This is the primary y axis for all the series in series array. + * To override y axis for particular series, create an axis object by providing unique name by using name property and add it to axes array. + * Then, assign the name to the seriesĂ¢â‚¬â„¢s yAxisName property to link both axis and series. + */ + primaryYAxis?: PrimaryYAxis; + + /** Rotation angle of the 3D view. This property is applicable only when 3D view is enabled. + * @Default {0} + */ + rotation?: number; - /** Options to split Chart into multiple plotting areas horizontally. Each object in the collection represents a plotting area in Chart. - */ - rowDefinitions?: RowDefinition[]; + /** Options to split Chart into multiple plotting areas horizontally. Each object in the collection represents a plotting area in Chart. + */ + rowDefinitions?: RowDefinition[]; - /** Specifies the properties used for customizing the series. - */ - series?: Series[]; + /** Specifies the properties used for customizing the series. + */ + series?: Series[]; - /** Controls whether data points has to be displayed side by side or along the depth of the axis. - * @Default {false} - */ - sideBySideSeriesPlacement?: boolean; + /** Controls whether data points has to be displayed side by side or along the depth of the axis. + * @Default {false} + */ + sideBySideSeriesPlacement?: boolean; - /** Options to customize the Chart size. - */ - size?: Size; + /** Options to customize the Chart size. + */ + size?: Size; - /** Specifies the theme for Chart. - * @Default {Flatlight. See Theme} - */ - theme?: ej.datavisualization.Chart.Theme|string; + /** Specifies the theme for Chart. + * @Default {Flatlight. See Theme} + */ + theme?: ej.datavisualization.Chart.Theme | string; - /** Slope angle of 3D Chart. This property is applicable only when 3D view is enabled. - * @Default {0} - */ - tilt?: number; + /** Slope angle of 3D Chart. This property is applicable only when 3D view is enabled. + * @Default {0} + */ + tilt?: number; - /** Options for customizing the title and subtitle of Chart. - */ - title?: Title; + /** Options for customizing the title and subtitle of Chart. + */ + title?: Title; - /** Width of the wall used in 3D Chart. Wall is present only in Cartesian type 3D series and not in 3D pie or Doughnut series. This property is applicable only when 3D view is enabled. - * @Default {2} - */ - wallSize?: number; + /** Width of the wall used in 3D Chart. Wall is present only in Cartesian type 3D series and not in 3D pie or Doughnut series. This property is applicable only when 3D view is enabled. + * @Default {2} + */ + wallSize?: number; - /** Options for enabling zooming feature of chart. - */ - zooming?: Zooming; + /** Options for enabling zooming feature of chart. + */ + zooming?: Zooming; - /** Fires after the series animation is completed. This event will be triggered for each series when animation is enabled. */ - animationComplete?(e: AnimationCompleteEventArgs): void; + /** Fires after the series animation is completed. This event will be triggered for each series when animation is enabled. */ + animationComplete?(e: AnimationCompleteEventArgs): void; - /** Fires before rendering the labels. This event is fired for each label in axis. You can use this event to add custom text to axis labels. */ - axesLabelRendering?(e: AxesLabelRenderingEventArgs): void; + /** Fires before rendering the labels. This event is fired for each label in axis. You can use this event to add custom text to axis labels. */ + axesLabelRendering?(e: AxesLabelRenderingEventArgs): void; - /** Fires during the initialization of axis labels. */ - axesLabelsInitialize?(e: AxesLabelsInitializeEventArgs): void; + /** Fires during the initialization of axis labels. */ + axesLabelsInitialize?(e: AxesLabelsInitializeEventArgs): void; - /** Fires during axes range calculation. This event is fired for each axis present in Chart. You can use this event to customize axis range as required. */ - axesRangeCalculate?(e: AxesRangeCalculateEventArgs): void; + /** Fires during axes range calculation. This event is fired for each axis present in Chart. You can use this event to customize axis range as required. */ + axesRangeCalculate?(e: AxesRangeCalculateEventArgs): void; - /** Fires before rendering the axis title. This event is triggered for each axis with title. You can use this event to add custom text to axis title. */ - axesTitleRendering?(e: AxesTitleRenderingEventArgs): void; + /** Fires before rendering the axis title. This event is triggered for each axis with title. You can use this event to add custom text to axis title. */ + axesTitleRendering?(e: AxesTitleRenderingEventArgs): void; - /** Fires during the calculation of chart area bounds. You can use this event to customize the bounds of chart area. */ - chartAreaBoundsCalculate?(e: ChartAreaBoundsCalculateEventArgs): void; + /** Fires during the calculation of chart area bounds. You can use this event to customize the bounds of chart area. */ + chartAreaBoundsCalculate?(e: ChartAreaBoundsCalculateEventArgs): void; - /** Fires after chart is created. */ - create?(e: CreateEventArgs): void; + /** Fires after chart is created. */ + create?(e: CreateEventArgs): void; - /** Fires when chart is destroyed completely. */ - destroy?(e: DestroyEventArgs): void; + /** Fires when chart is destroyed completely. */ + destroy?(e: DestroyEventArgs): void; - /** Fires before rendering the data labels. This event is triggered for each data label in the series. You can use this event to add custom text in data labels. */ - displayTextRendering?(e: DisplayTextRenderingEventArgs): void; + /** Fires before rendering the data labels. This event is triggered for each data label in the series. You can use this event to add custom text in data labels. */ + displayTextRendering?(e: DisplayTextRenderingEventArgs): void; - /** Fires during the calculation of legend bounds. You can use this event to customize the bounds of legend. */ - legendBoundsCalculate?(e: LegendBoundsCalculateEventArgs): void; + /** Fires during the calculation of legend bounds. You can use this event to customize the bounds of legend. */ + legendBoundsCalculate?(e: LegendBoundsCalculateEventArgs): void; - /** Fires on clicking the legend item. */ - legendItemClick?(e: LegendItemClickEventArgs): void; + /** Fires on clicking the legend item. */ + legendItemClick?(e: LegendItemClickEventArgs): void; - /** Fires when moving mouse over legend item. You can use this event for hit testing on legend items. */ - legendItemMouseMove?(e: LegendItemMouseMoveEventArgs): void; + /** Fires when moving mouse over legend item. You can use this event for hit testing on legend items. */ + legendItemMouseMove?(e: LegendItemMouseMoveEventArgs): void; - /** Fires before rendering the legend item. This event is fired for each legend item in Chart. You can use this event to customize legend item shape or add custom text to legend item. */ - legendItemRendering?(e: LegendItemRenderingEventArgs): void; + /** Fires before rendering the legend item. This event is fired for each legend item in Chart. You can use this event to customize legend item shape or add custom text to legend item. */ + legendItemRendering?(e: LegendItemRenderingEventArgs): void; - /** Fires before loading the chart. */ - load?(e: LoadEventArgs): void; + /** Fires before loading the chart. */ + load?(e: LoadEventArgs): void; - /** Fires after selected the data in chart. */ - rangeSelected?(e: RangeSelectedEventArgs): void; + /** Fires after selected the data in chart. */ + rangeSelected?(e: RangeSelectedEventArgs): void; - /** Fires on clicking a point in chart. You can use this event to handle clicks made on points. */ - pointRegionClick?(e: PointRegionClickEventArgs): void; + /** Fires on clicking a point in chart. You can use this event to handle clicks made on points. */ + pointRegionClick?(e: PointRegionClickEventArgs): void; - /** Fires when mouse is moved over a point. */ - pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; + /** Fires when mouse is moved over a point. */ + pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; - /** Fires before rendering chart. */ - preRender?(e: PreRenderEventArgs): void; + /** Fires before rendering chart. */ + preRender?(e: PreRenderEventArgs): void; - /** Fires after selecting a series. This event is triggered after selecting a series only if selection mode is series. */ - seriesRegionClick?(e: SeriesRegionClickEventArgs): void; + /** Fires after selecting a series. This event is triggered after selecting a series only if selection mode is series. */ + seriesRegionClick?(e: SeriesRegionClickEventArgs): void; - /** Fires before rendering a series. This event is fired for each series in Chart. */ - seriesRendering?(e: SeriesRenderingEventArgs): void; + /** Fires before rendering a series. This event is fired for each series in Chart. */ + seriesRendering?(e: SeriesRenderingEventArgs): void; - /** Fires before rendering the marker symbols. This event is triggered for each marker in Chart. */ - symbolRendering?(e: SymbolRenderingEventArgs): void; + /** Fires before rendering the marker symbols. This event is triggered for each marker in Chart. */ + symbolRendering?(e: SymbolRenderingEventArgs): void; - /** Fires before rendering the Chart title. You can use this event to add custom text in Chart title. */ - titleRendering?(e: TitleRenderingEventArgs): void; + /** Fires before rendering the Chart title. You can use this event to add custom text in Chart title. */ + titleRendering?(e: TitleRenderingEventArgs): void; - /** Fires before rendering the tooltip. This event is fired when tooltip is enabled and mouse is hovered on a Chart point. You can use this event to customize tooltip before rendering. */ - toolTipInitialize?(e: ToolTipInitializeEventArgs): void; + /** Fires before rendering the tooltip. This event is fired when tooltip is enabled and mouse is hovered on a Chart point. You can use this event to customize tooltip before rendering. */ + toolTipInitialize?(e: ToolTipInitializeEventArgs): void; - /** Fires before rendering crosshair tooltip in axis. This event is fired for each axis with crosshair label enabled. You can use this event to customize crosshair label before rendering */ - trackAxisToolTip?(e: TrackAxisToolTipEventArgs): void; + /** Fires before rendering crosshair tooltip in axis. This event is fired for each axis with crosshair label enabled. You can use this event to customize crosshair label before rendering */ + trackAxisToolTip?(e: TrackAxisToolTipEventArgs): void; - /** Fires before rendering trackball tooltip. This event is fired for each series in Chart because trackball tooltip is displayed for all the series. - * You can use this event to customize the text displayed in trackball tooltip. - */ - trackToolTip?(e: TrackToolTipEventArgs): void; + /** Fires before rendering trackball tooltip. This event is fired for each series in Chart because trackball tooltip is displayed for all the series. + * You can use this event to customize the text displayed in trackball tooltip. + */ + trackToolTip?(e: TrackToolTipEventArgs): void; - /** Fires, on clicking the axis label. */ - axisLabelClick?(e: AxisLabelClickEventArgs): void; + /** Fires, on clicking the axis label. */ + axisLabelClick?(e: AxisLabelClickEventArgs): void; - /** Fires on moving mouse over the axis label. */ - axisLabelMouseMove?(e: AxisLabelMouseMoveEventArgs): void; + /** Fires on moving mouse over the axis label. */ + axisLabelMouseMove?(e: AxisLabelMouseMoveEventArgs): void; - /** Fires, on the clicking the chart. */ - chartClick?(e: ChartClickEventArgs): void; + /** Fires, on the clicking the chart. */ + chartClick?(e: ChartClickEventArgs): void; - /** Fires on moving mouse over the chart. */ - chartMouseMove?(e: ChartMouseMoveEventArgs): void; + /** Fires on moving mouse over the chart. */ + chartMouseMove?(e: ChartMouseMoveEventArgs): void; - /** Fires, on double clicking the chart. */ - chartDoubleClick?(e: ChartDoubleClickEventArgs): void; + /** Fires, on double clicking the chart. */ + chartDoubleClick?(e: ChartDoubleClickEventArgs): void; - /** Fires on clicking the annotation. */ - annotationClick?(e: AnnotationClickEventArgs): void; + /** Fires on clicking the annotation. */ + annotationClick?(e: AnnotationClickEventArgs): void; - /** Fires, after the chart is resized. */ - afterResize?(e: AfterResizeEventArgs): void; + /** Fires, after the chart is resized. */ + afterResize?(e: AfterResizeEventArgs): void; - /** Fires, when chart size is changing. */ - beforeResize?(e: BeforeResizeEventArgs): void; + /** Fires, when chart size is changing. */ + beforeResize?(e: BeforeResizeEventArgs): void; - /** Fires, when error bar is rendering. */ - errorBarRendering?(e: ErrorBarRenderingEventArgs): void; + /** Fires, when error bar is rendering. */ + errorBarRendering?(e: ErrorBarRenderingEventArgs): void; - /** Trigger, after the scrollbar position is changed. */ - scrollChanged?(e: ScrollChangedEventArgs): void; + /** Trigger, after the scrollbar position is changed. */ + scrollChanged?(e: ScrollChangedEventArgs): void; - /** Event triggered when scroll starts */ - scrollStart?(e: ScrollStartEventArgs): void; + /** Event triggered when scroll starts */ + scrollStart?(e: ScrollStartEventArgs): void; - /** Event triggered when scroll end */ - scrollEnd?(e: ScrollEndEventArgs): void; -} + /** Event triggered when scroll end */ + scrollEnd?(e: ScrollEndEventArgs): void; + } -export interface AnimationCompleteEventArgs { + export interface AnimationCompleteEventArgs { - /** Instance of the series that completed has animation. - */ - series?: any; + /** Instance of the series that completed has animation. + */ + series?: any; - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the chart model object - */ - model?: any; + /** Instance of the chart model object + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface AxesLabelRenderingEventArgs { + export interface AxesLabelRenderingEventArgs { - /** Instance of the corresponding axis. - */ - Axis?: any; + /** Instance of the corresponding axis. + */ + Axis?: any; - /** Formatted text of the respective label. You can also add custom text to the label. - */ - LabelText?: string; + /** Formatted text of the respective label. You can also add custom text to the label. + */ + LabelText?: string; - /** Actual value of the label. - */ - LabelValue?: string; + /** Actual value of the label. + */ + LabelValue?: string; - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the chart model object. - */ - model?: any; + /** Instance of the chart model object. + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface AxesLabelsInitializeEventArgs { + export interface AxesLabelsInitializeEventArgs { - /** Collection of axes in Chart - */ - dataAxes?: any; + /** Collection of axes in Chart + */ + dataAxes?: any; - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the chart model object. - */ - model?: any; + /** Instance of the chart model object. + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface AxesRangeCalculateEventArgs { + export interface AxesRangeCalculateEventArgs { - /** Difference between minimum and maximum value of axis range. - */ - delta?: number; + /** Difference between minimum and maximum value of axis range. + */ + delta?: number; - /** Interval value of axis range. Grid lines, tick lines and axis labels are drawn based on this interval value. - */ - interval?: number; + /** Interval value of axis range. Grid lines, tick lines and axis labels are drawn based on this interval value. + */ + interval?: number; - /** Maximum value of axis range. - */ - max?: number; + /** Maximum value of axis range. + */ + max?: number; - /** Minimum value of axis range. - */ - min?: number; + /** Minimum value of axis range. + */ + min?: number; - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the chart model object. - */ - model?: any; + /** Instance of the chart model object. + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface AxesTitleRenderingEventArgs { + export interface AxesTitleRenderingEventArgs { - /** Instance of the axis whose title is being rendered - */ - axes?: any; + /** Instance of the axis whose title is being rendered + */ + axes?: any; - /** X-coordinate of title location - */ - locationX?: number; + /** X-coordinate of title location + */ + locationX?: number; - /** Y-coordinate of title location - */ - locationY?: number; + /** Y-coordinate of title location + */ + locationY?: number; - /** Axis title text. You can add custom text to the title. - */ - title?: string; + /** Axis title text. You can add custom text to the title. + */ + title?: string; - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the chart model object. - */ - model?: any; + /** Instance of the chart model object. + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface ChartAreaBoundsCalculateEventArgs { + export interface ChartAreaBoundsCalculateEventArgs { - /** Height of the chart area. - */ - areaBoundsHeight?: number; + /** Height of the chart area. + */ + areaBoundsHeight?: number; - /** Width of the chart area. - */ - areaBoundsWidth?: number; + /** Width of the chart area. + */ + areaBoundsWidth?: number; - /** X-coordinate of the chart area. - */ - areaBoundsX?: number; + /** X-coordinate of the chart area. + */ + areaBoundsX?: number; - /** Y-coordinate of the chart area. - */ - areaBoundsY?: number; + /** Y-coordinate of the chart area. + */ + areaBoundsY?: number; - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the chart model object. - */ - model?: any; + /** Instance of the chart model object. + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface CreateEventArgs { + export interface CreateEventArgs { - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the chart model object. - */ - model?: any; + /** Instance of the chart model object. + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface DestroyEventArgs { + export interface DestroyEventArgs { - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the chart model object. - */ - model?: any; + /** Instance of the chart model object. + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface DisplayTextRenderingEventArgs { + export interface DisplayTextRenderingEventArgs { - /** Text displayed in data label. You can add custom text to the data label - */ - text?: string; + /** Text displayed in data label. You can add custom text to the data label + */ + text?: string; - /** X-coordinate of data label location - */ - locationX?: number; + /** X-coordinate of data label location + */ + locationX?: number; - /** Y-coordinate of data label location - */ - locationY?: number; + /** Y-coordinate of data label location + */ + locationY?: number; - /** Index of the series in series Collection whose data label is being rendered - */ - seriesIndex?: number; + /** Index of the series in series Collection whose data label is being rendered + */ + seriesIndex?: number; - /** Index of the point in series whose data label is being rendered - */ - pointIndex?: number; + /** Index of the point in series whose data label is being rendered + */ + pointIndex?: number; - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the chart model object. - */ - model?: any; + /** Instance of the chart model object. + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface LegendBoundsCalculateEventArgs { + export interface LegendBoundsCalculateEventArgs { - /** Height of the legend. - */ - legendBoundsHeight?: number; + /** Height of the legend. + */ + legendBoundsHeight?: number; - /** Width of the legend. - */ - legendBoundsWidth?: number; + /** Width of the legend. + */ + legendBoundsWidth?: number; - /** Number of rows to display the legend items - */ - legendBoundsRows?: number; + /** Number of rows to display the legend items + */ + legendBoundsRows?: number; - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** Instance of the chart model object. - */ - model?: any; + /** Instance of the chart model object. + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface LegendItemClickEventArgs { + export interface LegendItemClickEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the chart model object - */ - model?: any; + /** Instance of the chart model object + */ + model?: any; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** X-coordinate of legend item in pixel - */ - startX?: number; + /** X-coordinate of legend item in pixel + */ + startX?: number; - /** Y-coordinate of legend item in pixel - */ - startY?: number; + /** Y-coordinate of legend item in pixel + */ + startY?: number; - /** Instance of the legend item object that is about to be rendered - */ - LegendItem?: any; + /** Instance of the legend item object that is about to be rendered + */ + LegendItem?: any; - /** Options to customize the legend item styles such as border, color, size, etcĂ¢â‚¬Â¦, - */ - style?: any; + /** Options to customize the legend item styles such as border, color, size, etcĂ¢â‚¬Â¦, + */ + style?: any; - /** Instance that holds information about legend bounds and legend item bounds. - */ - Bounds?: any; + /** Instance that holds information about legend bounds and legend item bounds. + */ + Bounds?: any; - /** Name of the legend item shape. Use this option to customize legend item shape before rendering - */ - symbolShape?: string; + /** Name of the legend item shape. Use this option to customize legend item shape before rendering + */ + symbolShape?: string; - /** Instance of the series object corresponding to the legend item - */ - series?: any; -} + /** Instance of the series object corresponding to the legend item + */ + series?: any; + } -export interface LegendItemMouseMoveEventArgs { + export interface LegendItemMouseMoveEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the chart model object - */ - model?: any; + /** Instance of the chart model object + */ + model?: any; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** X-coordinate of legend item in pixel - */ - startX?: number; + /** X-coordinate of legend item in pixel + */ + startX?: number; - /** Y-coordinate of legend item in pixel - */ - startY?: number; + /** Y-coordinate of legend item in pixel + */ + startY?: number; - /** Instance of the legend item object that is about to be rendered - */ - LegendItem?: any; + /** Instance of the legend item object that is about to be rendered + */ + LegendItem?: any; - /** Options to customize the legend item styles such as border, color, size, etcĂ¢â‚¬Â¦, - */ - style?: any; + /** Options to customize the legend item styles such as border, color, size, etcĂ¢â‚¬Â¦, + */ + style?: any; - /** Options to customize the legend item styles such as border, color, size, etcĂ¢â‚¬Â¦, - */ - Bounds?: any; + /** Options to customize the legend item styles such as border, color, size, etcĂ¢â‚¬Â¦, + */ + Bounds?: any; - /** Name of the legend item shape. Use this option to customize legend item shape before rendering - */ - symbolShape?: string; + /** Name of the legend item shape. Use this option to customize legend item shape before rendering + */ + symbolShape?: string; - /** Instance of the series object corresponding to the legend item - */ - series?: any; -} + /** Instance of the series object corresponding to the legend item + */ + series?: any; + } -export interface LegendItemRenderingEventArgs { + export interface LegendItemRenderingEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the chart model object - */ - model?: any; + /** Instance of the chart model object + */ + model?: any; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** X-coordinate of legend item in pixel - */ - startX?: number; + /** X-coordinate of legend item in pixel + */ + startX?: number; - /** Y-coordinate of legend item in pixel - */ - startY?: number; + /** Y-coordinate of legend item in pixel + */ + startY?: number; - /** Instance of the legend item object that is about to be rendered - */ - legendItem?: any; + /** Instance of the legend item object that is about to be rendered + */ + legendItem?: any; - /** Options to customize the legend item styles such as border, color, size, etc. - */ - style?: any; + /** Options to customize the legend item styles such as border, color, size, etc. + */ + style?: any; - /** Name of the legend item shape. Use this option to customize legend item shape before rendering - */ - symbolShape?: string; -} + /** Name of the legend item shape. Use this option to customize legend item shape before rendering + */ + symbolShape?: string; + } -export interface LoadEventArgs { + export interface LoadEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the chart model object - */ - model?: any; + /** Instance of the chart model object + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface RangeSelectedEventArgs { + export interface RangeSelectedEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the chart model object - */ - model?: any; + /** Instance of the chart model object + */ + model?: any; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** Selected data collection of object - */ - data?: any; -} + /** Selected data collection of object + */ + data?: any; + } -export interface PointRegionClickEventArgs { + export interface PointRegionClickEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the chart model object - */ - model?: any; + /** Instance of the chart model object + */ + model?: any; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** X-coordinate of point in pixel - */ - locationX?: number; + /** X-coordinate of point in pixel + */ + locationX?: number; - /** Y-coordinate of point in pixel - */ - locationY?: number; + /** Y-coordinate of point in pixel + */ + locationY?: number; - /** Index of the point in series - */ - pointIndex?: number; + /** Index of the point in series + */ + pointIndex?: number; - /** Index of the series in series collection to which the point belongs - */ - seriesIndex?: number; -} + /** Index of the series in series collection to which the point belongs + */ + seriesIndex?: number; + } -export interface PointRegionMouseMoveEventArgs { + export interface PointRegionMouseMoveEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the chart model object - */ - model?: any; + /** Instance of the chart model object + */ + model?: any; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** X-coordinate of point in pixel - */ - locationX?: number; + /** X-coordinate of point in pixel + */ + locationX?: number; - /** Y-coordinate of point in pixel - */ - locationY?: number; + /** Y-coordinate of point in pixel + */ + locationY?: number; - /** Index of the point in series - */ - pointIndex?: number; + /** Index of the point in series + */ + pointIndex?: number; - /** Index of the series in series collection to which the point belongs - */ - seriesIndex?: number; -} + /** Index of the series in series collection to which the point belongs + */ + seriesIndex?: number; + } -export interface PreRenderEventArgs { + export interface PreRenderEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the chart model object - */ - model?: any; + /** Instance of the chart model object + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface SeriesRegionClickEventArgs { + export interface SeriesRegionClickEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the chart model object - */ - model?: any; + /** Instance of the chart model object + */ + model?: any; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** Instance of the selected series - */ - series?: any; + /** Instance of the selected series + */ + series?: any; - /** Index of the selected series - */ - seriesIndex?: number; -} + /** Index of the selected series + */ + seriesIndex?: number; + } -export interface SeriesRenderingEventArgs { + export interface SeriesRenderingEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the chart model object - */ - model?: any; + /** Instance of the chart model object + */ + model?: any; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** Instance of the series which is about to get rendered - */ - series?: any; -} + /** Instance of the series which is about to get rendered + */ + series?: any; + } -export interface SymbolRenderingEventArgs { + export interface SymbolRenderingEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the chart model object - */ - model?: any; + /** Instance of the chart model object + */ + model?: any; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** Instance that holds the location of marker symbol - */ - location?: any; + /** Instance that holds the location of marker symbol + */ + location?: any; - /** Options to customize the marker style such as color, border and size - */ - style?: any; -} + /** Options to customize the marker style such as color, border and size + */ + style?: any; + } -export interface TitleRenderingEventArgs { + export interface TitleRenderingEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the chart model object - */ - model?: any; + /** Instance of the chart model object + */ + model?: any; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** Option to customize the title location in pixels - */ - location?: any; + /** Option to customize the title location in pixels + */ + location?: any; - /** Read-only option to find the size of the title - */ - size?: any; + /** Read-only option to find the size of the title + */ + size?: any; - /** Use this option to add custom text in title - */ - title?: string; -} + /** Use this option to add custom text in title + */ + title?: string; + } -export interface ToolTipInitializeEventArgs { + export interface ToolTipInitializeEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the chart model object - */ - model?: any; + /** Instance of the chart model object + */ + model?: any; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** Text to be displayed in tooltip. Set this option to customize the text displayed in tooltip - */ - currentText?: string; + /** Text to be displayed in tooltip. Set this option to customize the text displayed in tooltip + */ + currentText?: string; - /** Index of the point on which mouse is hovered - */ - pointIndex?: number; + /** Index of the point on which mouse is hovered + */ + pointIndex?: number; - /** Index of the series in series collection whose point is hovered by mouse - */ - seriesIndex?: number; -} + /** Index of the series in series collection whose point is hovered by mouse + */ + seriesIndex?: number; + } -export interface TrackAxisToolTipEventArgs { + export interface TrackAxisToolTipEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the chart model object - */ - model?: any; + /** Instance of the chart model object + */ + model?: any; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** Location of the crosshair label in pixels - */ - location?: any; + /** Location of the crosshair label in pixels + */ + location?: any; - /** Index of the axis for which crosshair label is displayed - */ - axisIndex?: number; + /** Index of the axis for which crosshair label is displayed + */ + axisIndex?: number; - /** Instance of the chart axis object for which cross hair label is displayed - */ - crossAxis?: number; + /** Instance of the chart axis object for which cross hair label is displayed + */ + crossAxis?: number; - /** Text to be displayed in crosshair label. Use this option to add custom text in crosshair label - */ - currentTrackText?: string; -} + /** Text to be displayed in crosshair label. Use this option to add custom text in crosshair label + */ + currentTrackText?: string; + } -export interface TrackToolTipEventArgs { + export interface TrackToolTipEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the chart model object - */ - model?: any; + /** Instance of the chart model object + */ + model?: any; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** Location of the trackball tooltip in pixels - */ - location?: any; + /** Location of the trackball tooltip in pixels + */ + location?: any; - /** Index of the point for which trackball tooltip is displayed - */ - pointIndex?: number; + /** Index of the point for which trackball tooltip is displayed + */ + pointIndex?: number; - /** Index of the series in series collection - */ - seriesIndex?: number; + /** Index of the series in series collection + */ + seriesIndex?: number; - /** Text to be displayed in trackball tooltip. Use this option to add custom text in trackball tooltip - */ - currentText?: string; + /** Text to be displayed in trackball tooltip. Use this option to add custom text in trackball tooltip + */ + currentText?: string; - /** Instance of the series object for which trackball tooltip is displayed. - */ - series?: any; -} + /** Instance of the series object for which trackball tooltip is displayed. + */ + series?: any; + } -export interface AxisLabelClickEventArgs { + export interface AxisLabelClickEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the chart model object - */ - model?: any; + /** Instance of the chart model object + */ + model?: any; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** X and Y co-ordinate of the labels in chart area. - */ - location?: any; + /** X and Y co-ordinate of the labels in chart area. + */ + location?: any; - /** Index of the label. - */ - index?: number; + /** Index of the label. + */ + index?: number; - /** Instance of the corresponding axis. - */ - axis?: any; + /** Instance of the corresponding axis. + */ + axis?: any; - /** Label that is clicked. - */ - text?: string; -} + /** Label that is clicked. + */ + text?: string; + } -export interface AxisLabelMouseMoveEventArgs { + export interface AxisLabelMouseMoveEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the chart model object - */ - model?: any; + /** Instance of the chart model object + */ + model?: any; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** X and Y co-ordinate of the labels in chart area. - */ - location?: any; + /** X and Y co-ordinate of the labels in chart area. + */ + location?: any; - /** Index of the label. - */ - index?: number; + /** Index of the label. + */ + index?: number; - /** Instance of the corresponding axis. - */ - axis?: any; + /** Instance of the corresponding axis. + */ + axis?: any; - /** Label that is hovered. - */ - text?: string; -} + /** Label that is hovered. + */ + text?: string; + } -export interface ChartClickEventArgs { + export interface ChartClickEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the chart model object - */ - model?: any; + /** Instance of the chart model object + */ + model?: any; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** X and Y co-ordinate of the points with respect to chart area. - */ - location?: any; + /** X and Y co-ordinate of the points with respect to chart area. + */ + location?: any; - /** ID of the target element. - */ - id?: string; + /** ID of the target element. + */ + id?: string; - /** Width and height of the chart. - */ - size?: any; + /** Width and height of the chart. + */ + size?: any; - /** x-coordinate of the pointer, relative to the page - */ - pageX?: number; + /** x-coordinate of the pointer, relative to the page + */ + pageX?: number; - /** y-coordinate of the pointer, relative to the page - */ - pageY?: number; -} + /** y-coordinate of the pointer, relative to the page + */ + pageY?: number; + } -export interface ChartMouseMoveEventArgs { + export interface ChartMouseMoveEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the chart model object - */ - model?: any; + /** Instance of the chart model object + */ + model?: any; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** X and Y co-ordinate of the points with respect to chart area. - */ - location?: any; + /** X and Y co-ordinate of the points with respect to chart area. + */ + location?: any; - /** ID of the target element. - */ - id?: string; + /** ID of the target element. + */ + id?: string; - /** Width and height of the chart. - */ - size?: any; + /** Width and height of the chart. + */ + size?: any; - /** x-coordinate of the pointer, relative to the page - */ - pageX?: number; + /** x-coordinate of the pointer, relative to the page + */ + pageX?: number; - /** y-coordinate of the pointer, relative to the page - */ - pageY?: number; -} + /** y-coordinate of the pointer, relative to the page + */ + pageY?: number; + } -export interface ChartDoubleClickEventArgs { + export interface ChartDoubleClickEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the chart model object - */ - model?: any; + /** Instance of the chart model object + */ + model?: any; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** X and Y co-ordinate of the points with respect to chart area. - */ - location?: any; + /** X and Y co-ordinate of the points with respect to chart area. + */ + location?: any; - /** ID of the target element. - */ - id?: string; + /** ID of the target element. + */ + id?: string; - /** Width and height of the chart. - */ - size?: any; + /** Width and height of the chart. + */ + size?: any; - /** x-coordinate of the pointer, relative to the page - */ - pageX?: number; + /** x-coordinate of the pointer, relative to the page + */ + pageX?: number; - /** y-coordinate of the pointer, relative to the page - */ - pageY?: number; -} + /** y-coordinate of the pointer, relative to the page + */ + pageY?: number; + } -export interface AnnotationClickEventArgs { + export interface AnnotationClickEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the chart model object - */ - model?: any; + /** Instance of the chart model object + */ + model?: any; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** X and Y co-ordinate of the annotation in chart area. - */ - location?: any; + /** X and Y co-ordinate of the annotation in chart area. + */ + location?: any; - /** Information about the annotation, like Coordinate unit, Region, content - */ - contentData?: any; + /** Information about the annotation, like Coordinate unit, Region, content + */ + contentData?: any; - /** x-coordinate of the pointer, relative to the page - */ - pageX?: number; + /** x-coordinate of the pointer, relative to the page + */ + pageX?: number; - /** y-coordinate of the pointer, relative to the page - */ - pageY?: number; -} + /** y-coordinate of the pointer, relative to the page + */ + pageY?: number; + } -export interface AfterResizeEventArgs { + export interface AfterResizeEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the chart model object - */ - model?: any; + /** Instance of the chart model object + */ + model?: any; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** Chart width, after resize - */ - width?: number; + /** Chart width, after resize + */ + width?: number; - /** Chart height, after resize - */ - height?: number; + /** Chart height, after resize + */ + height?: number; - /** Chart width, before resize - */ - prevWidth?: number; + /** Chart width, before resize + */ + prevWidth?: number; - /** Chart height, before resize - */ - prevHeight?: number; + /** Chart height, before resize + */ + prevHeight?: number; - /** Chart width, when the chart was first rendered - */ - originalWidth?: number; + /** Chart width, when the chart was first rendered + */ + originalWidth?: number; - /** Chart height, when the chart was first rendered - */ - originalHeight?: number; -} + /** Chart height, when the chart was first rendered + */ + originalHeight?: number; + } -export interface BeforeResizeEventArgs { + export interface BeforeResizeEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the chart model object - */ - model?: any; + /** Instance of the chart model object + */ + model?: any; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** Chart width, before resize - */ - currentWidth?: number; + /** Chart width, before resize + */ + currentWidth?: number; - /** Chart height, before resize - */ - currentHeight?: number; + /** Chart height, before resize + */ + currentHeight?: number; - /** Chart width, after resize - */ - newWidth?: number; + /** Chart width, after resize + */ + newWidth?: number; - /** Chart height, after resize - */ - newHeight?: number; -} + /** Chart height, after resize + */ + newHeight?: number; + } -export interface ErrorBarRenderingEventArgs { + export interface ErrorBarRenderingEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the chart model object - */ - model?: any; + /** Instance of the chart model object + */ + model?: any; - /** Name of the event - */ - type?: string; + /** Name of the event + */ + type?: string; - /** Error bar Object - */ - errorbar?: any; -} + /** Error bar Object + */ + errorbar?: any; + } -export interface ScrollChangedEventArgs { + export interface ScrollChangedEventArgs { - /** parameters from RangeNavigator - */ - data?: any; + /** parameters from RangeNavigator + */ + data?: any; - /** returns the scrollbar position old start and end range value on changing scrollbar - */ - dataoldRange?: any; + /** returns the scrollbar position old start and end range value on changing scrollbar + */ + dataoldRange?: any; - /** returns the scrollbar position new start and end range value on changing scrollbar - */ - datanewRange?: any; + /** returns the scrollbar position new start and end range value on changing scrollbar + */ + datanewRange?: any; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the RangeNavigator model - */ - model?: any; + /** returns the RangeNavigator model + */ + model?: any; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface ScrollStartEventArgs { + export interface ScrollStartEventArgs { - /** parameters from RangeNavigator - */ - data?: any; + /** parameters from RangeNavigator + */ + data?: any; - /** returns the scrollbar position starting range value on changing scrollbar - */ - datastartRange?: string; + /** returns the scrollbar position starting range value on changing scrollbar + */ + datastartRange?: string; - /** returns the scrollbar position end range value on changing scrollbar - */ - dataendRange?: string; + /** returns the scrollbar position end range value on changing scrollbar + */ + dataendRange?: string; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the RangeNavigator model - */ - model?: any; + /** returns the RangeNavigator model + */ + model?: any; - /** returns the name of the event - */ - type?: string; -} - -export interface ScrollEndEventArgs { - - /** parameters from RangeNavigator - */ - data?: any; - - /** returns the scrollbar position old start and end range value on change end of scrollbar - */ - dataoldRange?: any; - - /** returns the scrollbar position new start and end range value on change end of scrollbar - */ - datanewRange?: any; - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the RangeNavigator model - */ - model?: any; - - /** returns the name of the event - */ - type?: string; -} - -export interface AnnotationsMargin { - - /** Annotation is placed at the specified value above its original position. - * @Default {0} - */ - bottom?: number; - - /** Annotation is placed at the specified value from left side of its original position. - * @Default {0} - */ - left?: number; - - /** Annotation is placed at the specified value from the right side of its original position. - * @Default {0} - */ - right?: number; - - /** Annotation is placed at the specified value under its original position. - * @Default {0} - */ - top?: number; -} - -export interface Annotation { - - /** Angle to rotate the annotation in degrees. - * @Default {'0'} - */ - angle?: number; - - /** Text content or id of a HTML element to be displayed as annotation. - */ - content?: string; - - /** Specifies how annotations have to be placed in Chart. - * @Default {none. See CoordinateUnit} - */ - coordinateUnit?: ej.datavisualization.Chart.CoordinateUnit|string; - - /** Specifies the horizontal alignment of the annotation. - * @Default {middle. See HorizontalAlignment} - */ - horizontalAlignment?: ej.datavisualization.Chart.HorizontalAlignment|string; - - /** Options to customize the margin of annotation. - */ - margin?: AnnotationsMargin; - - /** Controls the opacity of the annotation. - * @Default {1} - */ - opacity?: number; - - /** Specifies whether annotation has to be placed with respect to chart or series. - * @Default {chart. See Region} - */ - region?: ej.datavisualization.Chart.Region|string; - - /** Specifies the vertical alignment of the annotation. - * @Default {middle. See VerticalAlignment} - */ - verticalAlignment?: ej.datavisualization.Chart.VerticalAlignment|string; - - /** Controls the visibility of the annotation. - * @Default {false} - */ - visible?: boolean; - - /** Represents the horizontal offset when coordinateUnit is pixels.when coordinateUnit is points, it represents the x-coordinate of axis bounded with xAxisName property - * or primary X axis when xAxisName is not provided.This property is not applicable when coordinateUnit is none. - * @Default {0} - */ - x?: number; - - /** Name of the horizontal axis to be used for positioning the annotation. This property is applicable only when coordinateUnit is points. - */ - xAxisName?: string; - - /** Represents the vertical offset when coordinateUnit is pixels.When coordinateUnit is points, it represents the y-coordinate of axis bounded with - * yAxisName property or primary Y axis when yAxisName is not provided.This property is not applicable when coordinateUnit is none. - * @Default {0} - */ - y?: number; - - /** Name of the vertical axis to be used for positioning the annotation.This property is applicable only when coordinateUnit is points. - */ - yAxisName?: string; -} - -export interface Border { - - /** Border color of the chart. - * @Default {null} - */ - color?: string; - - /** Opacity of the chart border. - * @Default {0.3} - */ - opacity?: number; - - /** Width of the Chart border. - * @Default {0} - */ - width?: number; -} - -export interface ExportSettings { - - /** Specifies the downloading filename - * @Default {chart} - */ - filename?: string; - - /** Specifies the name of the action URL - */ - action?: string; - - /** Specifies the angle for rotation - * @Default {0} - */ - angle?: number; - - /** Specifies the format of the file to export - * @Default {png} - */ - type?: ej.datavisualization.Chart.ExportingType|string; - - /** Specifies the orientation of the document - * @Default {portrait} - */ - orientation?: ej.datavisualization.Chart.ExportingOrientation|string; - - /** Specifies the mode of exporting - * @Default {client} - */ - mode?: ej.datavisualization.Chart.ExportingMode|string; - - /** Enable/ disable the multiple excel exporting - * @Default {false} - */ - multipleExport?: boolean; -} - -export interface ChartAreaBorder { - - /** Border color of the plot area. - * @Default {Gray} - */ - color?: string; - - /** Opacity of the plot area border. - * @Default {0.3} - */ - opacity?: number; - - /** Border width of the plot area. - * @Default {0.5} - */ - width?: number; -} - -export interface ChartArea { - - /** Background color of the plot area. - * @Default {transparent} - */ - background?: string; - - /** Options for customizing the border of the plot area. - */ - border?: ChartAreaBorder; -} - -export interface ColumnDefinition { - - /** Specifies the unit to measure the width of the column in plotting area. - * @Default {'pixel'. See Unit} - */ - unit?: ej.datavisualization.Chart.Unit|string; - - /** Width of the column in plotting area. Width is measured in either pixel or percentage based on the value of unit property. - * @Default {50} - */ - columnWidth?: number; - - /** Color of the line that indicates the starting point of the column in plotting area. - * @Default {transparent} - */ - lineColor?: string; - - /** Width of the line that indicates the starting point of the column in plot area. - * @Default {1} - */ - lineWidth?: number; -} - -export interface CommonSeriesOptionsBorder { - - /** Border color of all series. - * @Default {transparent} - */ - color?: string; - - /** DashArray for border of the series. - * @Default {null} - */ - dashArray?: string; - - /** Border width of all series. - * @Default {1} - */ - width?: number; -} - -export interface CommonSeriesOptionsFont { - - /** Font color of the text in all series. - * @Default {#707070} - */ - color?: string; - - /** Font Family for all the series. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Specifies the font Style for all the series. - * @Default {normal} - */ - fontStyle?: ej.datavisualization.Chart.FontStyle|string; - - /** Specifies the font weight for all the series. - * @Default {regular} - */ - fontWeight?: ej.datavisualization.Chart.FontWeight|string; - - /** Opacity for text in all the series. - * @Default {1} - */ - opacity?: number; - - /** Font size for text in all the series. - * @Default {12px} - */ - size?: string; -} - -export interface CommonSeriesOptionsMarkerBorder { - - /** Border color of the marker shape. - * @Default {white} - */ - color?: string; - - /** Border width of the marker shape. - * @Default {3} - */ - width?: number; -} - -export interface CommonSeriesOptionsMarkerDataLabelBorder { - - /** Border color of the data label. - * @Default {null} - */ - color?: string; - - /** Border width of the data label. - * @Default {0.1} - */ - width?: number; -} - -export interface CommonSeriesOptionsMarkerDataLabelConnectorLine { - - /** Specifies when the connector has to be drawn as Bezier curve or straight line. This is applicable only for Pie and Doughnut chart types. - * @Default {line. See ConnectorLineType} - */ - type?: ej.datavisualization.Chart.ConnectorLineType|string; - - /** Width of the connector. - * @Default {0.5} - */ - width?: number; - - /** Color of the connector line. - * @Default {#565656} - */ - color?: string; - - /** Height of the connector line. - * @Default {null} - */ - height?: string; -} - -export interface CommonSeriesOptionsMarkerDataLabelFont { - - /** Font family of the data label. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style of the data label. - * @Default {normal. See FontStyle} - */ - fontStyle?: ej.datavisualization.Chart.FontStyle|string; - - /** Font weight of the data label. - * @Default {regular. See FontWeight} - */ - fontWeight?: ej.datavisualization.Chart.FontWeight|string; - - /** Opacity of the text. - * @Default {1} - */ - opacity?: number; - - /** Font color of the data label text. - * @Default {null} - */ - color?: string; - - /** Font size of the data label. - * @Default {12px} - */ - size?: string; -} - -export interface CommonSeriesOptionsMarkerDataLabelMargin { - - /** Bottom margin of the text. - * @Default {5} - */ - bottom?: number; - - /** Left margin of the text. - * @Default {5} - */ - left?: number; - - /** Right margin of the text. - * @Default {5} - */ - right?: number; - - /** Top margin of the text. - * @Default {5} - */ - top?: number; -} - -export interface CommonSeriesOptionsMarkerDataLabel { - - /** Angle of the data label in degrees. Only the text gets rotated, whereas the background and border does not rotate. - * @Default {null} - */ - angle?: number; - - /** Maximum label width of the data label. - * @Default {null} - */ - maximumLabelWidth?: number; - - /** Enable the wrap option to the data label. - * @Default {false} - */ - enableWrap?: boolean; - - /** Options for customizing the border of the data label. - */ - border?: CommonSeriesOptionsMarkerDataLabelBorder; - - /** Options for displaying and customizing the line that connects point and data label. - */ - connectorLine?: CommonSeriesOptionsMarkerDataLabelConnectorLine; - - /** Background color of the data label. - * @Default {null} - */ - fill?: string; - - /** Options for customizing the data label font. - */ - font?: CommonSeriesOptionsMarkerDataLabelFont; - - /** Horizontal alignment of the data label. - * @Default {center} - */ - horizontalTextAlignment?: ej.datavisualization.Chart.HorizontalTextAlignment|string; - - /** Margin of the text to its background shape. The size of the background shape increases based on the margin applied to its text. - */ - margin?: CommonSeriesOptionsMarkerDataLabelMargin; - - /** Opacity of the data label. - * @Default {1} - */ - opacity?: number; - - /** Background shape of the data label. - * @Default {none. See Shape} - */ - shape?: ej.datavisualization.Chart.Shape|string; - - /** Custom template to format the data label content. Use Ă¢â‚¬Å“point.xĂ¢â‚¬Â and Ă¢â‚¬Å“point.yĂ¢â‚¬Â as a placeholder text to display the corresponding data pointĂ¢â‚¬â„¢s x and y value. - */ - template?: string; - - /** Name of a field in data source, where datalabel text is displayed. - */ - textMappingName?: string; - - /** Specifies the position of the data label. This property can be used only for the series such as column, bar, stacked column, stacked bar, 100% stacked column, 100% stacked bar, candle and OHLC. - * @Default {top. See TextPosition} - */ - textPosition?: ej.datavisualization.Chart.TextPosition|string; - - /** Vertical alignment of the data label. - * @Default {center} - */ - verticalTextAlignment?: ej.datavisualization.Chart.VerticalTextAlignment|string; - - /** Controls the visibility of the data labels. - * @Default {false} - */ - visible?: boolean; -} - -export interface CommonSeriesOptionsMarkerSize { - - /** Height of the marker. - * @Default {6} - */ - height?: number; - - /** Width of the marker. - * @Default {6} - */ - width?: number; -} - -export interface CommonSeriesOptionsMarker { - - /** Options for customizing the border of the marker shape. - */ - border?: CommonSeriesOptionsMarkerBorder; - - /** Options for displaying and customizing data labels. - */ - dataLabel?: CommonSeriesOptionsMarkerDataLabel; - - /** Color of the marker shape. - * @Default {null} - */ - fill?: string; - - /** The URL for the Image to be displayed as marker. In order to display image as marker, set series.marker.shape as Ă¢â‚¬ËœimageĂ¢â‚¬â„¢. - */ - imageUrl?: string; - - /** Opacity of the marker. - * @Default {1} - */ - opacity?: number; - - /** Specifies the shape of the marker. - * @Default {circle. See Shape} - */ - shape?: ej.datavisualization.Chart.Shape|string; - - /** Options for customizing the size of the marker shape. - */ - size?: CommonSeriesOptionsMarkerSize; - - /** Controls the visibility of the marker shape. - * @Default {false} - */ - visible?: boolean; -} - -export interface CommonSeriesOptionsOutlierSettingsSize { - - /** Height of the outlier shape. - * @Default {6} - */ - height?: number; - - /** Width of the outlier shape. - * @Default {6} - */ - width?: number; -} - -export interface CommonSeriesOptionsOutlierSettings { - - /** Specifies the shape of the outlier. - * @Default {circle. See Shape} - */ - shape?: ej.datavisualization.Chart.Shape|string; - - /** Options for customizing the size of the outlier shape. - */ - size?: CommonSeriesOptionsOutlierSettingsSize; -} - -export interface CommonSeriesOptionsCornerRadius { - - /** Specifies the radius for the top left corner. - * @Default {0} - */ - topLeft?: number; - - /** Specifies the radius for the top right corner. - * @Default {0} - */ - topRight?: number; - - /** Specifies the radius for the bottom left corner. - * @Default {0} - */ - bottomLeft?: number; - - /** Specifies the radius for the bottom right corner. - * @Default {0} - */ - bottomRight?: number; -} - -export interface CommonSeriesOptionsTooltipBorder { - - /** Border color of the tooltip. - * @Default {null} - */ - color?: string; - - /** Border width of the tooltip. - * @Default {1} - */ - width?: number; -} - -export interface CommonSeriesOptionsTooltip { - - /** Options for customizing the border of the tooltip. - */ - border?: CommonSeriesOptionsTooltipBorder; - - /** Customize the corner radius of the tooltip rectangle. - * @Default {0} - */ - rx?: number; - - /** Customize the corner radius of the tooltip rectangle. - * @Default {0} - */ - ry?: number; - - /** Specifies the duration, the tooltip has to be displayed. - * @Default {500ms} - */ - duration?: string; - - /** Enables/disables the animation of the tooltip when moving from one point to other. - * @Default {true} - */ - enableAnimation?: boolean; - - /** Background color of the tooltip. - * @Default {null} - */ - fill?: string; - - /** Format of the tooltip content. - * @Default {#point.x# : #point.y#} - */ - format?: string; - - /** Opacity of the tooltip. - * @Default {0.5} - */ - opacity?: number; - - /** Custom template to format the tooltip content. Use Ă¢â‚¬Å“point.xĂ¢â‚¬Â and Ă¢â‚¬Å“point.yĂ¢â‚¬Â as a placeholder text to display the corresponding data pointĂ¢â‚¬â„¢s x and y value. - * @Default {null} - */ - template?: string; - - /** Controls the visibility of the tooltip. - * @Default {false} - */ - visible?: boolean; -} - -export interface CommonSeriesOptionsEmptyPointSettingsStyleBorder { - - /** Border color of the empty point. - */ - color?: string; - - /** Border width of the empty point. - * @Default {1} - */ - width?: number; -} - -export interface CommonSeriesOptionsEmptyPointSettingsStyle { - - /** Color of the empty point. - */ - color?: string; - - /** Options for customizing border of the empty point in the series. - */ - border?: CommonSeriesOptionsEmptyPointSettingsStyleBorder; -} - -export interface CommonSeriesOptionsEmptyPointSettings { - - /** Controls the visibility of the empty point. - * @Default {true} - */ - visible?: boolean; - - /** Specifies the mode of empty point. - * @Default {gap} - */ - displayMode?: ej.datavisualization.Chart.EmptyPointMode|string; - - /** Options for customizing the color and border of the empty point in the series. - */ - style?: CommonSeriesOptionsEmptyPointSettingsStyle; -} - -export interface CommonSeriesOptionsConnectorLine { - - /** Width of the connector line. - * @Default {1} - */ - width?: number; - - /** Color of the connector line. - * @Default {#565656} - */ - color?: string; - - /** DashArray of the connector line. - * @Default {null} - */ - dashArray?: string; - - /** DashArray of the connector line. - * @Default {1} - */ - opacity?: number; -} - -export interface CommonSeriesOptionsDragSettings { - - /** drag/drop the series - * @Default {false} - */ - enable?: boolean; - - /** Specifies the type of drag settings. - * @Default {xy} - */ - type?: string; -} - -export interface CommonSeriesOptionsErrorBarCap { - - /** Show/Hides the error bar cap. - * @Default {true} - */ - visible?: boolean; - - /** Width of the error bar cap. - * @Default {1} - */ - width?: number; - - /** Length of the error bar cap. - * @Default {1} - */ - length?: number; - - /** Color of the error bar cap. - * @Default {Ă¢â‚¬Å“#000000Ă¢â‚¬Â} - */ - fill?: string; -} - -export interface CommonSeriesOptionsErrorBar { - - /** Show/hides the error bar - * @Default {visible} - */ - visibility?: boolean; - - /** Specifies the type of error bar. - * @Default {FixedValue} - */ - type?: ej.datavisualization.Chart.ErrorBarType|string; - - /** Specifies the mode of error bar. - * @Default {vertical} - */ - mode?: ej.datavisualization.Chart.ErrorBarMode|string; - - /** Specifies the direction of error bar. - * @Default {both} - */ - direction?: ej.datavisualization.Chart.ErrorBarDirection|string; - - /** Value of vertical error bar. - * @Default {3} - */ - verticalErrorValue?: number; - - /** Value of horizontal error bar. - * @Default {1} - */ - horizontalErrorValue?: number; - - /** Value of positive horizontal error bar. - * @Default {1} - */ - horizontalPositiveErrorValue?: number; - - /** Value of negative horizontal error bar. - * @Default {1} - */ - horizontalNegativeErrorValue?: number; - - /** Value of positive vertical error bar. - * @Default {5} - */ - verticalPositiveErrorValue?: number; - - /** Value of negative vertical error bar. - * @Default {5} - */ - verticalNegativeErrorValue?: number; - - /** Fill color of the error bar. - * @Default {#000000} - */ - fill?: string; - - /** Width of the error bar. - * @Default {1} - */ - width?: number; - - /** Options for customizing the error bar cap. - */ - cap?: CommonSeriesOptionsErrorBarCap; -} - -export interface CommonSeriesOptionsTrendline { - - /** Show/hides the trendline. - */ - visibility?: boolean; - - /** Specifies the type of the trendline for the series. - * @Default {linear. See TrendlinesType} - */ - type?: string; - - /** Name for the trendlines that is to be displayed in the legend text. - * @Default {trendline} - */ - name?: string; - - /** Fill color of the trendlines. - * @Default {#0000FF} - */ - fill?: string; - - /** Width of the trendlines. - * @Default {1} - */ - width?: number; - - /** Opacity of the trendline. - * @Default {1} - */ - opacity?: number; - - /** Pattern of dashes and gaps used to stroke the trendline. - */ - dashArray?: string; - - /** Future trends of the current series. - * @Default {0} - */ - forwardForecast?: number; - - /** Past trends of the current series. - * @Default {0} - */ - backwardForecast?: number; - - /** Specifies the order of the polynomial trendlines. - * @Default {0} - */ - polynomialOrder?: number; - - /** Specifies the moving average starting period value. - * @Default {2} - */ - period?: number; -} - -export interface CommonSeriesOptionsHighlightSettingsBorder { - - /** Border color of the series/point on highlight. - */ - color?: string; - - /** Border width of the series/point on highlight. - * @Default {2} - */ - width?: string; -} - -export interface CommonSeriesOptionsHighlightSettings { - - /** Enables/disables the ability to highlight the series or data point interactively. - * @Default {false} - */ - enable?: boolean; - - /** Specifies whether the series or data point has to be highlighted. - * @Default {series. See Mode} - */ - mode?: ej.datavisualization.Chart.Mode|string; - - /** Color of the series/point on highlight. - */ - color?: string; - - /** Opacity of the series/point on highlight. - * @Default {0.6} - */ - opacity?: number; - - /** Options for customizing the border of series on highlight. - */ - border?: CommonSeriesOptionsHighlightSettingsBorder; - - /** Specifies the pattern for the series/point on highlight. - * @Default {none. See Pattern} - */ - pattern?: string; - - /** Custom pattern for the series on highlight. - */ - customPattern?: string; -} - -export interface CommonSeriesOptionsSelectionSettingsBorder { - - /** Border color of the series/point on selection. - */ - color?: string; - - /** Border width of the series/point on selection. - * @Default {2} - */ - width?: string; -} - -export interface CommonSeriesOptionsSelectionSettings { - - /** Enables/disables the ability to select a series/data point interactively. - * @Default {false} - */ - enable?: boolean; - - /** Specifies the type of selection. - * @Default {single} - */ - type?: ej.datavisualization.Chart.SelectionType|string; - - /** Specifies whether the series or data point has to be selected. - * @Default {series. See Mode} - */ - mode?: ej.datavisualization.Chart.Mode|string; - - /** Specifies the drawn rectangle type. - * @Default {xy} - */ - rangeType?: ej.datavisualization.Chart.RangeType|string; - - /** Color of the series/point on selection. - */ - color?: string; - - /** Opacity of the series/point on selection. - * @Default {0.6} - */ - opacity?: number; - - /** Options for customizing the border of the series on selection. - */ - border?: CommonSeriesOptionsSelectionSettingsBorder; - - /** Specifies the pattern for the series/point on selection. - * @Default {none. See Pattern} - */ - pattern?: string; - - /** Custom pattern for the series on selection. - */ - customPattern?: string; -} - -export interface CommonSeriesOptions { - - /** Options to customize the border of all the series. - */ - border?: CommonSeriesOptionsBorder; - - /** To render the column and bar type series in rectangle/cylinder shape. See ColumnFacet - * @Default {rectangle} - */ - columnFacet?: ej.datavisualization.Chart.ColumnFacet|string; - - /** Relative width of the columns in column type series. Value ranges from 0 to 1. Width also depends upon columnSpacing property. - * @Default {0.7} - */ - columnWidth?: number; - - /** Spacing between columns of different series. Value ranges from 0 to 1 - * @Default {0} - */ - columnSpacing?: number; - - /** Enables or disables the visibility of legend item. - * @Default {visible} - */ - visibleOnLegend?: string; - - /** Group of the stacking collection series. - */ - stackingGroup?: string; - - /** Pattern of dashes and gaps used to stroke all the line type series. - */ - dashArray?: string; - - /** Set the dataSource for all series. It can be an array of JSON objects or an instance of ej.DataManager. - * @Default {null} - */ - dataSource?: any; - - /** Controls the size of the hole in doughnut series. Value ranges from 0 to 1 - * @Default {0.4} - */ - doughnutCoefficient?: number; - - /** Controls the size of the doughnut series. Value ranges from 0 to 1. - * @Default {0.8} - */ - doughnutSize?: number; - - /** Specifies the type of series to be drawn in radar or polar series. - * @Default {line. See DrawType} - */ - drawType?: ej.datavisualization.Chart.DrawType|string; - - /** Enable/disable the animation for all the series. - * @Default {true} - */ - enableAnimation?: boolean; - - /** To avoid overlapping of data labels smartly. - * @Default {true} - */ - enableSmartLabels?: boolean; - - /** Start angle of pie/doughnut series. - * @Default {null} - */ - endAngle?: number; - - /** Explodes the pie/doughnut slices on mouse move. - * @Default {false} - */ - explode?: boolean; - - /** Explodes all the slice of pie/doughnut on render. - * @Default {false} - */ - explodeAll?: boolean; - - /** Index of the point to be exploded from pie/doughnut/pyramid/funnel. - * @Default {null} - */ - explodeIndex?: number; - - /** Specifies the distance of the slice from the center, when it is exploded. - * @Default {0.4} - */ - explodeOffset?: number; - - /** Fill color for all the series. - * @Default {null} - */ - fill?: string; - - /** Options for customizing the font of all the series. - */ - font?: CommonSeriesOptionsFont; - - /** Sets the height of the funnel in funnel series. Values can be either pixel or percentage. - * @Default {32.7%} - */ - funnelHeight?: string; - - /** Sets the width of the funnel in funnel series. Values can be either pixel or percentage. - * @Default {11.6%} - */ - funnelWidth?: string; - - /** Gap between the slices in pyramid and funnel series. - * @Default {0} - */ - gapRatio?: number; - - /** Specifies whether to join start and end point of a line/area series used in polar/radar chart to form a closed path. - * @Default {true} - */ - isClosed?: boolean; - - /** Specifies whether to stack the column series in polar/radar charts. - * @Default {false} - */ - isStacking?: boolean; - - /** Renders the chart vertically. This is applicable only for Cartesian type series. - * @Default {false} - */ - isTransposed?: boolean; - - /** Render the x mark in the center of the box and whisker series type.x represents the average value of the box and whisker series. - * @Default {true} - */ - showMedian?: boolean; - - /** Position of the data label in pie/doughnut/pyramid/funnel series. OutsideExtended position is not applicable for pyramid/funnel. - * @Default {inside. See LabelPosition} - */ - labelPosition?: ej.datavisualization.Chart.LabelPosition|string; - - /** Quartile calculation has been performed in three different formulas to render the box and whisker series. - * @Default {exclusive} - */ - boxPlotMode?: ej.datavisualization.Chart.boxPlotMode|string; - - /** Specifies the line cap of the series. - * @Default {butt. See LineCap} - */ - lineCap?: ej.datavisualization.Chart.LineCap|string; - - /** Specifies the type of shape to be used where two lines meet. - * @Default {round. See LineJoin} - */ - lineJoin?: ej.datavisualization.Chart.LineJoin|string; - - /** Options for displaying and customizing marker for individual point in a series. Marker contains shapes and/or data labels. - */ - marker?: CommonSeriesOptionsMarker; - - /** Opacity of the series. - * @Default {1} - */ - opacity?: number; - - /** Options for customizing the outlier of the series. - */ - outlierSettings?: CommonSeriesOptionsOutlierSettings; - - /** Name of a field in data source, where the fill color for all the data points is generated. - */ - palette?: string; - - /** Controls the size of pie series. Value ranges from 0 to 1. - * @Default {0.8} - */ - pieCoefficient?: number; - - /** Name of the property in the datasource that contains fill color for the series. - * @Default {null} - */ - pointColorMappingName?: string; - - /** Specifies the mode of the pyramid series. - * @Default {linear. See PyramidMode} - */ - pyramidMode?: ej.datavisualization.Chart.PyramidMode|string; - - /** Start angle from where the pie/doughnut series renders. By default it starts from 0. - * @Default {null} - */ - startAngle?: number; - - /** Options for customizing the corner radius. cornerRadius property also takes the numeric input and applies it for all the four corners of the column. - */ - cornerRadius?: CommonSeriesOptionsCornerRadius; - - /** Options for customizing the tooltip of chart. - */ - tooltip?: CommonSeriesOptionsTooltip; - - /** Specifies the type of the series to render in chart. - * @Default {column. See Type} - */ - type?: ej.datavisualization.Chart.Type|string; - - /** Specifies the name of the x-axis that has to be associated with this series. Add an axis instance with this name to axes collection. - * @Default {null} - */ - xAxisName?: string; - - /** Name of the property in the datasource that contains x value for the series. - * @Default {null} - */ - xName?: string; - - /** Specifies the name of the y-axis that has to be associated with this series. Add an axis instance with this name to axes collection. - * @Default {null} - */ - yAxisName?: string; - - /** Name of the property in the datasource that contains y value for the series. - * @Default {null} - */ - yName?: string; - - /** Name of the property in the datasource that contains high value for the series. - * @Default {null} - */ - high?: string; - - /** Name of the property in the datasource that contains low value for the series. - * @Default {null} - */ - low?: string; - - /** Name of the property in the datasource that contains open value for the series. - * @Default {null} - */ - open?: string; - - /** Name of the property in the datasource that contains close value for the series. - * @Default {null} - */ - close?: string; - - /** Z-order of the series. - * @Default {0} - */ - zOrder?: number; - - /** Name of the property in the datasource that contains the size value for the bubble series. - * @Default {null} - */ - size?: string; - - /** Options for customizing the empty point in the series. - */ - emptyPointSettings?: CommonSeriesOptionsEmptyPointSettings; - - /** Fill color for the positive column of the waterfall. - * @Default {null} - */ - positiveFill?: string; - - /** Options for customizing the waterfall connector line. - */ - connectorLine?: CommonSeriesOptionsConnectorLine; - - /** Options to customize the drag and drop in series. - */ - dragSettings?: CommonSeriesOptionsDragSettings; - - /** Options to customize the error bar in series. - */ - errorBar?: CommonSeriesOptionsErrorBar; - - /** Option to add the trendlines to chart. - */ - trendlines?: CommonSeriesOptionsTrendline[]; - - /** Options for customizing the appearance of the series or data point while highlighting. - */ - highlightSettings?: CommonSeriesOptionsHighlightSettings; - - /** Options for customizing the appearance of the series/data point on selection. - */ - selectionSettings?: CommonSeriesOptionsSelectionSettings; -} - -export interface CrosshairTrackballTooltipSettingsBorder { - - /** Border width of the trackball tooltip. - * @Default {null} - */ - width?: number; - - /** Border color of the trackball tooltip. - * @Default {null} - */ - color?: string; -} - -export interface CrosshairTrackballTooltipSettings { - - /** Options for customizing the trackball tooltip border. - */ - border?: CrosshairTrackballTooltipSettingsBorder; - - /** Background color of the trackball tooltip. - * @Default {null} - */ - fill?: string; - - /** Rounded corner x value of the trackball tooltip. - * @Default {3} - */ - rx?: number; - - /** Rounded corner y value of the trackball tooltip. - * @Default {3} - */ - ry?: number; - - /** Opacity value of the trackball tooltip. - * @Default {1} - */ - opacity?: number; - - /** Specifies the mode of the trackball tooltip. - * @Default {float. See CrosshairMode} - */ - mode?: ej.datavisualization.Chart.CrosshairMode|string; -} - -export interface CrosshairMarkerBorder { - - /** Border width of the marker. - * @Default {3} - */ - width?: number; -} - -export interface CrosshairMarkerSize { - - /** Height of the marker. - * @Default {10} - */ - height?: number; - - /** Width of the marker. - * @Default {10} - */ - width?: number; -} - -export interface CrosshairMarker { - - /** Options for customizing the border. - */ - border?: CrosshairMarkerBorder; - - /** Opacity of the marker. - * @Default {true} - */ - opacity?: boolean; - - /** Options for customizing the size of the marker. - */ - size?: CrosshairMarkerSize; - - /** Show/hides the marker. - * @Default {true} - */ - visible?: boolean; -} - -export interface CrosshairLine { - - /** Color of the crosshair line. - * @Default {transparent} - */ - color?: string; - - /** Width of the crosshair line. - * @Default {1} - */ - width?: number; -} - -export interface Crosshair { - - /** Options for customizing the trackball tooltip. - */ - trackballTooltipSettings?: CrosshairTrackballTooltipSettings; - - /** Options for customizing the marker in crosshair. - */ - marker?: CrosshairMarker; - - /** Options for customizing the crosshair line. - */ - line?: CrosshairLine; - - /** Specifies the type of the crosshair. It can be trackball or crosshair - * @Default {crosshair. See CrosshairType} - */ - type?: ej.datavisualization.Chart.CrosshairType|string; - - /** Show/hides the crosshair/trackball visibility. - * @Default {false} - */ - visible?: boolean; -} - -export interface IndicatorsHistogramBorder { - - /** Color of the histogram border in MACD indicator. - * @Default {#9999ff} - */ - color?: string; - - /** Controls the width of histogram border line in MACD indicator. - * @Default {1} - */ - width?: number; -} - -export interface IndicatorsHistogram { - - /** Options to customize the histogram border in MACD indicator. - */ - border?: IndicatorsHistogramBorder; - - /** Color of histogram columns in MACD indicator. - * @Default {#ccccff} - */ - fill?: string; - - /** Opacity of histogram columns in MACD indicator. - * @Default {1} - */ - opacity?: number; -} - -export interface IndicatorsLowerLine { - - /** Color of lower line. - * @Default {#008000} - */ - fill?: string; - - /** Width of the lower line. - * @Default {2} - */ - width?: number; -} - -export interface IndicatorsMacdLine { - - /** Color of MACD line. - * @Default {#ff9933} - */ - fill?: string; - - /** Width of the MACD line. - * @Default {2} - */ - width?: number; -} - -export interface IndicatorsPeriodLine { - - /** Color of period line in indicator. - * @Default {blue} - */ - fill?: string; - - /** Width of the period line in indicators. - * @Default {2} - */ - width?: number; -} - -export interface IndicatorsTooltipBorder { - - /** Border color of indicator tooltip. - * @Default {null} - */ - color?: string; - - /** Border width of indicator tooltip. - * @Default {1} - */ - width?: number; -} - -export interface IndicatorsTooltip { - - /** Option to customize the border of indicator tooltip. - */ - border?: IndicatorsTooltipBorder; - - /** Specifies the animation duration of indicator tooltip. - * @Default {500ms} - */ - duration?: string; - - /** Enables/disables the tooltip animation. - * @Default {true} - */ - enableAnimation?: boolean; - - /** Format of indicator tooltip. Use Ă¢â‚¬Å“point.xĂ¢â‚¬Â and Ă¢â‚¬Å“point.yĂ¢â‚¬Â as a placeholder text to display the corresponding data pointĂ¢â‚¬â„¢s x and y value. - * @Default {#point.x# : #point.y#} - */ - format?: string; - - /** Background color of indicator tooltip. - * @Default {null} - */ - fill?: string; - - /** Opacity of indicator tooltip. - * @Default {0.95} - */ - opacity?: number; - - /** Controls the visibility of indicator tooltip. - * @Default {false} - */ - visible?: boolean; -} - -export interface IndicatorsUpperLine { - - /** Fill color of the upper line in indicators - * @Default {#ff9933} - */ - fill?: string; - - /** Width of the upper line in indicators. - * @Default {2} - */ - width?: number; -} - -export interface Indicator { - - /** The dPeriod value for stochastic indicator. - * @Default {3} - */ - dPeriod?: number; - - /** Enables/disables the animation. - * @Default {false} - */ - enableAnimation?: boolean; - - /** Color of the technical indicator. - * @Default {#00008B} - */ - fill?: string; - - /** Options to customize the histogram in MACD indicator. - */ - histogram?: IndicatorsHistogram; - - /** Specifies the k period in stochastic indicator. - * @Default {3} - */ - kPeriod?: number; - - /** Specifies the long period in MACD indicator. - * @Default {26} - */ - longPeriod?: number; - - /** Options to customize the lower line in indicators. - */ - lowerLine?: IndicatorsLowerLine; - - /** Options to customize the MACD line. - */ - macdLine?: IndicatorsMacdLine; - - /** Specifies the type of the MACD indicator. - * @Default {line. See MACDType} - */ - macdType?: string; - - /** Specifies period value in indicator. - * @Default {14} - */ - period?: number; - - /** Options to customize the period line in indicators. - */ - periodLine?: IndicatorsPeriodLine; - - /** Name of the series for which indicator has to be drawn. - */ - seriesName?: string; - - /** Specifies the short period in MACD indicator. - * @Default {13} - */ - shortPeriod?: number; - - /** Specifies the standard deviation value for Bollinger band indicator. - * @Default {2} - */ - standardDeviations?: number; - - /** Options to customize the tooltip. - */ - tooltip?: IndicatorsTooltip; - - /** Trigger value of MACD indicator. - * @Default {9} - */ - trigger?: number; - - /** Specifies the visibility of indicator. - * @Default {visible} - */ - visibility?: string; - - /** Specifies the type of indicator that has to be rendered. - * @Default {sma. See IndicatorsType} - */ - type?: string; - - /** Options to customize the upper line in indicators - */ - upperLine?: IndicatorsUpperLine; - - /** Width of the indicator line. - * @Default {2} - */ - width?: number; - - /** Name of the horizontal axis used for indicator. Primary X axis is used when x axis name is not specified. - */ - xAxisName?: string; - - /** Name of the vertical axis used for indicator. Primary Y axis is used when y axis name is not specified - */ - yAxisName?: string; -} - -export interface LegendBorder { - - /** Border color of the legend. - * @Default {transparent} - */ - color?: string; - - /** Border width of the legend. - * @Default {1} - */ - width?: number; -} - -export interface LegendFont { - - /** Font family for legend item text. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style for legend item text. - * @Default {Normal. See FontStyle} - */ - fontStyle?: ej.datavisualization.Chart.FontStyle|string; - - /** Font weight for legend item text. - * @Default {Regular. See FontWeight} - */ - fontWeight?: ej.datavisualization.Chart.FontWeight|string; - - /** Font size for legend item text. - * @Default {12px} - */ - size?: string; -} - -export interface LegendItemStyleBorder { - - /** Border color of the legend items. - * @Default {transparent} - */ - color?: string; - - /** Border width of the legend items. - * @Default {1} - */ - width?: number; -} - -export interface LegendItemStyle { - - /** Options for customizing the border of legend items. - */ - border?: LegendItemStyleBorder; - - /** Height of the shape in legend items. - * @Default {10} - */ - height?: number; - - /** Width of the shape in legend items. - * @Default {10} - */ - width?: number; -} - -export interface LegendLocation { - - /** X value or horizontal offset to position the legend in chart. - * @Default {0} - */ - x?: number; - - /** Y value or vertical offset to position the legend. - * @Default {0} - */ - y?: number; -} - -export interface LegendSize { - - /** Height of the legend. Height can be specified in either pixel or percentage. - * @Default {null} - */ - height?: string; - - /** Width of the legend. Width can be specified in either pixel or percentage. - * @Default {null} - */ - width?: string; -} - -export interface LegendTitleFont { - - /** Font family for the text in legend title. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style for legend title. - * @Default {normal. See FontStyle} - */ - fontStyle?: ej.datavisualization.Chart.FontStyle|string; - - /** Font weight for legend title. - * @Default {normal. See FontWeight} - */ - fontWeight?: ej.datavisualization.Chart.FontWeight|string; - - /** Font size for legend title. - * @Default {12px} - */ - size?: string; -} - -export interface LegendTitle { - - /** Options to customize the font used for legend title - */ - font?: LegendTitleFont; - - /** Text to be displayed in legend title. - */ - text?: string; - - /** Alignment of the legend title. - * @Default {center. See Alignment} - */ - textAlignment?: ej.datavisualization.Chart.Alignment|string; -} - -export interface Legend { - - /** Horizontal alignment of the legend. - * @Default {Center. See Alignment} - */ - alignment?: ej.datavisualization.Chart.Alignment|string; - - /** Background for the legend. Use this property to add a background image or background color for the legend. - */ - background?: string; - - /** Options for customizing the legend border. - */ - border?: LegendBorder; - - /** Number of columns to arrange the legend items. - * @Default {null} - */ - columnCount?: number; - - /** Controls whether legend has to use scrollbar or not. When enabled, scroll bar appears depending upon size and position properties of legend. - * @Default {true} - */ - enableScrollbar?: boolean; - - /** Fill color for the legend items. By using this property, it displays all legend item shapes in same color.Legend items representing invisible series is displayed in gray color. - * @Default {null} - */ - fill?: string; - - /** Options to customize the font used for legend item text. - */ - font?: LegendFont; - - /** Gap or padding between the legend items. - * @Default {10} - */ - itemPadding?: number; - - /** Options to customize the style of legend items. - */ - itemStyle?: LegendItemStyle; - - /** Options to customize the location of chart legend. Legend is placed in provided location only when value of position property is custom - */ - location?: LegendLocation; - - /** Opacity of the legend. - * @Default {1} - */ - opacity?: number; - - /** Places the legend at specified position. Legend can be placed at left, right, top or bottom of the chart area.To manually specify the location of legend, set custom as value to this property. - * @Default {Bottom. See Position} - */ - position?: ej.datavisualization.Chart.Position|string; - - /** Number of rows to arrange the legend items. - * @Default {null} - */ - rowCount?: number; - - /** Shape of the legend items. Default shape for pie and doughnut series is circle and all other series uses rectangle. - * @Default {None. See Shape} - */ - shape?: ej.datavisualization.Chart.Shape|string; - - /** Options to customize the size of the legend. - */ - size?: LegendSize; - - /** Options to customize the legend title. - */ - title?: LegendTitle; - - /** Specifies the action taken when the legend width is more than the textWidth. - * @Default {none. See textOverflow} - */ - textOverflow?: ej.datavisualization.Chart.TextOverflow|string; - - /** Text width for legend item. - * @Default {34} - */ - textWidth?: number; - - /** Controls the visibility of the legend. - * @Default {true} - */ - visible?: boolean; -} - -export interface PrimaryXAxisAlternateGridBandEven { - - /** Fill color for the even grid bands. - * @Default {transparent} - */ - fill?: string; - - /** Opacity of the even grid band. - * @Default {1} - */ - opacity?: number; -} - -export interface PrimaryXAxisAlternateGridBandOdd { - - /** Fill color of the odd grid bands - * @Default {transparent} - */ - fill?: string; - - /** Opacity of odd grid band - * @Default {1} - */ - opacity?: number; -} - -export interface PrimaryXAxisAlternateGridBand { - - /** Options for customizing even grid band. - */ - even?: PrimaryXAxisAlternateGridBandEven; - - /** Options for customizing odd grid band. - */ - odd?: PrimaryXAxisAlternateGridBandOdd; -} - -export interface PrimaryXAxisAxisLine { - - /** Pattern of dashes and gaps to be applied to the axis line. - * @Default {null} - */ - dashArray?: string; - - /** Padding for axis line. Normally, it is used along with plotOffset to pad the plot area. - * @Default {null} - */ - offset?: number; - - /** Show/hides the axis line. - * @Default {true} - */ - visible?: boolean; - - /** Default Value - */ - color?: string; - - /** Width of axis line. - * @Default {1} - */ - width?: number; -} - -export interface PrimaryXAxisCrosshairLabel { - - /** Show/hides the crosshair label associated with this axis. - * @Default {false} - */ - visible?: boolean; -} - -export interface PrimaryXAxisFont { - - /** Font family of labels. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style of labels. - * @Default {ej.datavisualization.Chart.FontStyle.Normal. See FontStyle} - */ - fontStyle?: ej.datavisualization.Chart.FontStyle|string; - - /** Font weight of the label. - * @Default {ej.datavisualization.Chart.FontWeight.Regular. See FontWeight} - */ - fontWeight?: ej.datavisualization.Chart.FontWeight|string; - - /** Opacity of the axis labels. - * @Default {1} - */ - opacity?: number; - - /** Font size of the axis labels. - * @Default {13px} - */ - size?: string; -} - -export interface PrimaryXAxisMajorGridLines { - - /** Pattern of dashes and gaps used to stroke the major grid lines. - * @Default {null} - */ - dashArray?: string; - - /** Color of the major grid line. - * @Default {null} - */ - color?: string; - - /** Opacity of major grid lines. - * @Default {1} - */ - opacity?: number; - - /** Show/hides the major grid lines. - * @Default {true} - */ - visible?: boolean; - - /** Width of the major grid lines. - * @Default {1} - */ - width?: number; -} - -export interface PrimaryXAxisMajorTickLines { - - /** Length of the major tick lines. - * @Default {5} - */ - size?: number; - - /** Show/hides the major tick lines. - * @Default {true} - */ - visible?: boolean; - - /** Width of the major tick lines. - * @Default {1} - */ - width?: number; -} - -export interface PrimaryXAxisMinorGridLines { - - /** Patterns of dashes and gaps used to stroke the minor grid lines. - * @Default {null} - */ - dashArray?: string; - - /** Show/hides the minor grid lines. - * @Default {true} - */ - visible?: boolean; - - /** Width of the minorGridLines. - * @Default {1} - */ - width?: number; -} - -export interface PrimaryXAxisMinorTickLines { - - /** Length of the minor tick lines. - * @Default {5} - */ - size?: number; - - /** Show/hides the minor tick lines. - * @Default {true} - */ - visible?: boolean; - - /** Width of the minor tick line. - * @Default {1} - */ - width?: number; -} - -export interface PrimaryXAxisRange { - - /** Minimum value of the axis range. - * @Default {null} - */ - min?: number; - - /** Maximum value of the axis range. - * @Default {null} - */ - max?: number; - - /** Interval of the axis range. - * @Default {null} - */ - interval?: number; -} - -export interface PrimaryXAxisMultiLevelLabelsFont { - - /** Font color of the multi level labels text. - * @Default {null} - */ - color?: string; - - /** Font family of the multi level labels text. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style of the multi level labels text. - * @Default {Normal} - */ - fontStyle?: ej.datavisualization.Chart.FontStyle|string; - - /** Font weight of the multi level label text. - * @Default {regular} - */ - fontWeight?: string; - - /** Opacity of the multi level label text. - * @Default {1} - */ - opacity?: number; - - /** Font size of the multi level label text. - * @Default {12px} - */ - size?: string; -} - -export interface PrimaryXAxisMultiLevelLabelsBorder { - - /** Border color of the multi level labels. - * @Default {null} - */ - color?: string; - - /** Border width of the multi level labels. - * @Default {1} - */ - width?: number; - - /** Border type of the multi level labels. - * @Default {rectangle. See Type} - */ - type?: ej.datavisualization.Chart.MultiLevelLabelsBorderType|string; -} - -export interface PrimaryXAxisMultiLevelLabel { - - /** Visibility of the multi level labels. - * @Default {false} - */ - visible?: boolean; - - /** Text of the multi level labels. - */ - text?: string; - - /** Starting value of the multi level labels. - * @Default {null} - */ - start?: number; - - /** Ending value of the multi level labels. - * @Default {null} - */ - end?: number; - - /** Specifies the level of multi level labels. - * @Default {0} - */ - level?: number; - - /** Specifies the maximum width of the text in multi level labels. - * @Default {null} - */ - maximumTextWidth?: number; - - /** Specifies the alignment of the text in multi level labels. - * @Default {center. See TextAlignment} - */ - textAlignment?: ej.datavisualization.Chart.TextAlignment|string; - - /** Specifies the handling of text over flow in multi level labels. - * @Default {center. See TextOverflow} - */ - textOverflow?: ej.datavisualization.Chart.TextOverflow|string; - - /** Options for customizing the font of the text. - */ - font?: PrimaryXAxisMultiLevelLabelsFont; - - /** Options for customizing the border of the series. - */ - border?: PrimaryXAxisMultiLevelLabelsBorder; -} - -export interface PrimaryXAxisStripLineFont { - - /** Font color of the strip line text. - * @Default {black} - */ - color?: string; - - /** Font family of the strip line text. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style of the strip line text. - * @Default {Normal} - */ - fontStyle?: ej.datavisualization.Chart.FontStyle|string; - - /** Font weight of the strip line text. - * @Default {regular} - */ - fontWeight?: string; - - /** Opacity of the strip line text. - * @Default {1} - */ - opacity?: number; - - /** Font size of the strip line text. - * @Default {12px} - */ - size?: string; -} - -export interface PrimaryXAxisStripLine { - - /** Border color of the strip line. - * @Default {gray} - */ - borderColor?: string; - - /** Background color of the strip line. - * @Default {gray} - */ - color?: string; - - /** End value of the strip line. - * @Default {null} - */ - end?: number; - - /** Options for customizing the font of the text. - */ - font?: PrimaryXAxisStripLineFont; - - /** Start value of the strip line. - * @Default {null} - */ - start?: number; - - /** Indicates whether to render the strip line from the minimum/start value of the axis. This property does not work when start property is set. - * @Default {false} - */ - startFromAxis?: boolean; - - /** Specifies text to be displayed inside the strip line. - * @Default {stripLine} - */ - text?: string; - - /** Specifies the alignment of the text inside the strip line. - * @Default {middlecenter. See TextAlignment} - */ - textAlignment?: ej.datavisualization.Chart.TextAlignment|string; - - /** Show/hides the strip line. - * @Default {false} - */ - visible?: boolean; - - /** Width of the strip line. - * @Default {0} - */ - width?: number; - - /** Specifies the order where the strip line and the series have to be rendered. When Z-order is Ă¢â‚¬Å“behindĂ¢â‚¬Â, strip line is rendered - * under the series and when it is Ă¢â‚¬Å“overĂ¢â‚¬Â, it is rendered above the series. - * @Default {over. See ZIndex} - */ - zIndex?: ej.datavisualization.Chart.ZIndex|string; -} - -export interface PrimaryXAxisLabelBorder { - - /** Specifies the color of the label border. - * @Default {null} - */ - color?: string; - - /** Specifies the width of the label border. - * @Default {1} - */ - width?: number; -} - -export interface PrimaryXAxisTitleFont { - - /** Font family of the title text. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style of the title text. - * @Default {ej.datavisualization.Chart.FontStyle.Normal} - */ - fontStyle?: ej.datavisualization.Chart.FontStyle|string; - - /** Font weight of the title text. - * @Default {ej.datavisualization.Chart.FontWeight.Regular. See FontWeight} - */ - fontWeight?: ej.datavisualization.Chart.FontWeight|string; - - /** Opacity of the axis title text. - * @Default {1} - */ - opacity?: number; - - /** Font size of the axis title. - * @Default {16px} - */ - size?: string; -} - -export interface PrimaryXAxisTitle { - - /** Specifies whether to trim the axis title when it exceeds the chart area or the maximum width of the title. - * @Default {false} - */ - enableTrim?: boolean; - - /** Options for customizing the title font. - */ - font?: PrimaryXAxisTitleFont; - - /** Maximum width of the title, when the title exceeds this width, the title gets trimmed, when enableTrim is true. - * @Default {34} - */ - maximumTitleWidth?: number; - - /** Title for the axis. - */ - text?: string; - - /** Controls the visibility of axis title. - * @Default {true} - */ - visible?: boolean; - - /** offset value for axis title. - * @Default {0} - */ - offset?: number; - - /** Specifies the position of the axis title. - * @Default {outside. See Position} - */ - position?: ej.datavisualization.Chart.LabelPosition|string; - - /** Specifies the position of the axis title. - * @Default {center. See Alignment} - */ - alignment?: ej.datavisualization.Chart.TextAlignment|string; -} - -export interface PrimaryXAxis { - - /** Options for customizing horizontal axis alternate grid band. - */ - alternateGridBand?: PrimaryXAxisAlternateGridBand; - - /** Specifies where horizontal axis should intersect the vertical axis or vice versa. Value should be provided in axis co-ordinates. - * If provided value is greater than the maximum value of crossing axis, then axis will be placed at the opposite side. - * @Default {null} - */ - crossesAt?: number; - - /** Name of the axis used for crossing. Vertical axis name should be provided for horizontal axis and vice versa. - * If the provided name does not belongs to a valid axis, then primary X axis or primary Y axis will be used for crossing - * @Default {null} - */ - crossesInAxis?: string; - - /** Category axis can also plot points based on index value of data points. Index based plotting can be enabled by setting Ă¢â‚¬ËœisIndexedĂ¢â‚¬â„¢ property to true. - * @Default {false} - */ - isIndexed?: boolean; - - /** Options for customizing the axis line. - */ - axisLine?: PrimaryXAxisAxisLine; - - /** Specifies the index of the column where the axis is associated, when the chart area is divided into multiple plot areas by using columnDefinitions. - * @Default {null} - */ - columnIndex?: number; - - /** Specifies the number of columns or plot areas an axis has to span horizontally. - * @Default {null} - */ - columnSpan?: number; - - /** Options to customize the crosshair label. - */ - crosshairLabel?: PrimaryXAxisCrosshairLabel; - - /** With this setting, you can request axis to calculate intervals approximately equal to your desired interval. - * @Default {null} - */ - desiredIntervals?: number; - - /** Specifies the placement of labels. - * @Default {ej.datavisualization.Chart.LabelPlacement.BetweenTicks. See LabelPlacement} - */ - labelPlacement?: ej.datavisualization.Chart.LabelPlacement|string; - - /** Specifies the position of labels at the edge of the axis. - * @Default {ej.datavisualization.Chart.EdgeLabelPlacement.None. See EdgeLabelPlacement} - */ - edgeLabelPlacement?: ej.datavisualization.Chart.EdgeLabelPlacement|string; - - /** Specifies whether to trim the axis label when the width of the label exceeds the maximumLabelWidth. - * @Default {false} - */ - enableTrim?: boolean; - - /** Options for customizing the font of the axis Labels. - */ - font?: PrimaryXAxisFont; - - /** Specifies the type of interval in date time axis. - * @Default {null. See IntervalType} - */ - intervalType?: ej.datavisualization.Chart.IntervalType|string; - - /** Specifies whether to inverse the axis. - * @Default {false} - */ - isInversed?: boolean; - - /** Custom formatting for axis label and supports all standard formatting type of numerical and date time values. - * @Default {null} - */ - labelFormat?: string; - - /** Specifies the action to take when the axis labels are overlapping with each other. - * @Default {ej.datavisualization.Chart.LabelIntersectAction.None. See LabelIntersectAction} - */ - labelIntersectAction?: ej.datavisualization.Chart.LabelIntersectAction|string; - - /** Specifies the position of the axis labels. - * @Default {outside. See LabelPosition} - */ - labelPosition?: ej.datavisualization.Chart.LabelPosition|string; - - /** Specifies the position of the axis labels. - * @Default {center. See Alignment} - */ - alignment?: ej.datavisualization.Chart.LabelAlignment|string; - - /** Angle in degrees to rotate the axis labels. - * @Default {null} - */ - labelRotation?: number; - - /** Logarithmic base value. This is applicable only for logarithmic axis. - * @Default {10} - */ - logBase?: number; - - /** Options for customizing major gird lines. - */ - majorGridLines?: PrimaryXAxisMajorGridLines; - - /** Options for customizing the major tick lines. - */ - majorTickLines?: PrimaryXAxisMajorTickLines; - - /** Maximum number of labels to be displayed in every 100 pixels. - * @Default {3} - */ - maximumLabels?: number; - - /** Maximum width of the axis label. When the label exceeds the width, the label gets trimmed when the enableTrim is set to true. - * @Default {34} - */ - maximumLabelWidth?: number; - - /** Options for customizing the minor grid lines. - */ - minorGridLines?: PrimaryXAxisMinorGridLines; - - /** Options for customizing the minor tick lines. - */ - minorTickLines?: PrimaryXAxisMinorTickLines; - - /** Specifies the number of minor ticks per interval. - * @Default {null} - */ - minorTicksPerInterval?: number; - - /** Unique name of the axis. To associate an axis with the series, you have to set this name to the xAxisName/yAxisName property of the series. - * @Default {null} - */ - name?: string; - - /** Specifies whether to render the axis at the opposite side of its default position. - * @Default {false} - */ - opposedPosition?: boolean; - - /** Specifies the padding for the plot area. - * @Default {10} - */ - plotOffset?: number; - - /** Options to customize the range of the axis. - */ - range?: PrimaryXAxisRange; - - /** Specifies the padding for the axis range. - * @Default {None. See RangePadding} - */ - rangePadding?: ej.datavisualization.Chart.RangePadding|string; - - /** Rounds the number to the given number of decimals. - * @Default {null} - */ - roundingPlaces?: number; - - /** Options for customizing the multi level labels. - * @Default {[ ]} - */ - multiLevelLabels?: PrimaryXAxisMultiLevelLabel[]; - - /** Options for customizing the strip lines. - * @Default {[ ]} - */ - stripLine?: PrimaryXAxisStripLine[]; - - /** Specifies the position of the axis tick lines. - * @Default {outside. See TickLinesPosition} - */ - tickLinesPosition?: ej.datavisualization.Chart.TickLinesPosition|string; - - /** Options for customizing the border of the labels. - */ - labelBorder?: PrimaryXAxisLabelBorder; - - /** Options for customizing the axis title. - */ - title?: PrimaryXAxisTitle; - - /** Specifies the type of data the axis is handling. - * @Default {null. See ValueType} - */ - valueType?: ej.datavisualization.Chart.ValueType|string; - - /** Show/hides the axis. - * @Default {true} - */ - visible?: boolean; - - /** The axis is scaled by this factor. When zoomFactor is 0.5, the chart is scaled by 200% along this axis. Value ranges from 0 to 1. - * @Default {1} - */ - zoomFactor?: number; - - /** Position of the zoomed axis. Value ranges from 0 to 1. - * @Default {0} - */ - zoomPosition?: number; -} - -export interface AxesAlternateGridBandEven { - - /** Fill color for the even grid bands. - * @Default {transparent} - */ - fill?: string; - - /** Opacity of the even grid band. - * @Default {1} - */ - opacity?: number; -} - -export interface AxesAlternateGridBandOdd { - - /** Fill color of the odd grid bands - * @Default {transparent} - */ - fill?: string; - - /** Opacity of odd grid band - * @Default {1} - */ - opacity?: number; -} - -export interface AxesAlternateGridBand { - - /** Options for customizing even grid band. - */ - even?: AxesAlternateGridBandEven; - - /** Options for customizing odd grid band. - */ - odd?: AxesAlternateGridBandOdd; -} - -export interface AxesAxisLine { - - /** Pattern of dashes and gaps to be applied to the axis line. - * @Default {null} - */ - dashArray?: string; - - /** Padding for axis line. Normally, it is used along with plotOffset to pad the plot area. - * @Default {null} - */ - offset?: number; - - /** Show/hides the axis line. - * @Default {true} - */ - visible?: boolean; - - /** Color of axis line. - */ - color?: string; - - /** Width of axis line. - * @Default {1} - */ - width?: number; -} - -export interface AxesCrosshairLabel { - - /** Show/hides the crosshair label associated with this axis. - * @Default {false} - */ - visible?: boolean; -} - -export interface AxesFont { - - /** Font family of labels. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style of labels. - * @Default {ej.datavisualization.Chart.FontStyle.Normal. See FontStyle} - */ - fontStyle?: ej.datavisualization.Chart.FontStyle|string; - - /** Font weight of the label. - * @Default {ej.datavisualization.Chart.FontWeight.Regular. See FontWeight} - */ - fontWeight?: ej.datavisualization.Chart.FontWeight|string; - - /** Opacity of the axis labels. - * @Default {1} - */ - opacity?: number; - - /** Font size of the axis labels. - * @Default {13px} - */ - size?: string; -} - -export interface AxesMajorGridLines { - - /** Pattern of dashes and gaps used to stroke the major grid lines. - * @Default {null} - */ - dashArray?: string; - - /** Color of the major grid line. - * @Default {null} - */ - color?: string; - - /** Opacity of major grid lines. - * @Default {1} - */ - opacity?: number; - - /** Show/hides the major grid lines. - * @Default {true} - */ - visible?: boolean; - - /** Width of the major grid lines. - * @Default {1} - */ - width?: number; -} - -export interface AxesMajorTickLines { - - /** Length of the major tick lines. - * @Default {5} - */ - size?: number; - - /** Show/hides the major tick lines. - * @Default {true} - */ - visible?: boolean; - - /** Width of the major tick lines. - * @Default {1} - */ - width?: number; -} - -export interface AxesMinorGridLines { - - /** Patterns of dashes and gaps used to stroke the minor grid lines. - * @Default {null} - */ - dashArray?: string; - - /** Show/hides the minor grid lines. - * @Default {true} - */ - visible?: boolean; - - /** Width of the minorGridLines. - * @Default {1} - */ - width?: number; -} - -export interface AxesMinorTickLines { - - /** Length of the minor tick lines. - * @Default {5} - */ - size?: number; - - /** Show/hides the minor tick lines. - * @Default {true} - */ - visible?: boolean; - - /** Width of the minor tick line. - * @Default {1} - */ - width?: number; -} - -export interface AxesRange { - - /** Minimum value of the axis range. - * @Default {null} - */ - min?: number; - - /** Maximum value of the axis range. - * @Default {null} - */ - max?: number; - - /** Interval of the axis range. - * @Default {null} - */ - interval?: number; -} - -export interface AxesMultiLevelLabelsFont { - - /** Font color of the multi level labels text. - * @Default {null} - */ - color?: string; - - /** Font family of the multi level labels text. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style of the multi level labels text. - * @Default {Normal} - */ - fontStyle?: ej.datavisualization.Chart.FontStyle|string; - - /** Font weight of the multi level label text. - * @Default {regular} - */ - fontWeight?: string; - - /** Opacity of the multi level label text. - * @Default {1} - */ - opacity?: number; - - /** Font size of the multi level label text. - * @Default {12px} - */ - size?: string; -} - -export interface AxesMultiLevelLabelsBorder { - - /** Border color of the multi level labels. - * @Default {null} - */ - color?: string; - - /** Border width of the multi level labels. - * @Default {1} - */ - width?: number; - - /** Border type of the multi level labels. - * @Default {rectangle. See Type} - */ - type?: ej.datavisualization.Chart.MultiLevelLabelsBorderType|string; -} - -export interface AxesMultiLevelLabel { - - /** Visibility of the multi level labels. - * @Default {false} - */ - visible?: boolean; - - /** Text of the multi level labels. - */ - text?: string; - - /** Starting value of the multi level labels. - * @Default {null} - */ - start?: number; - - /** Ending value of the multi level labels. - * @Default {null} - */ - end?: number; - - /** Specifies the level of multi level labels. - * @Default {0} - */ - level?: number; - - /** Specifies the maximum width of the text in multi level labels. - * @Default {null} - */ - maximumTextWidth?: number; - - /** Specifies the alignment of the text in multi level labels. - * @Default {center. See TextAlignment} - */ - textAlignment?: ej.datavisualization.Chart.TextAlignment|string; - - /** Specifies the handling of text over flow in multi level labels. - * @Default {center. See TextOverflow} - */ - textOverflow?: ej.datavisualization.Chart.TextOverflow|string; - - /** Options for customizing the font of the text. - */ - font?: AxesMultiLevelLabelsFont; - - /** Options for customizing the border of the series. - */ - border?: AxesMultiLevelLabelsBorder; -} - -export interface AxesStripLineFont { - - /** Font color of the strip line text. - * @Default {black} - */ - color?: string; - - /** Font family of the strip line text. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style of the strip line text. - * @Default {Normal} - */ - fontStyle?: ej.datavisualization.Chart.FontStyle|string; - - /** Font weight of the strip line text. - * @Default {regular} - */ - fontWeight?: string; - - /** Opacity of the strip line text. - * @Default {1} - */ - opacity?: number; - - /** Font size of the strip line text. - * @Default {12px} - */ - size?: string; -} - -export interface AxesStripLine { - - /** Border color of the strip line. - * @Default {gray} - */ - borderColor?: string; - - /** Background color of the strip line. - * @Default {gray} - */ - color?: string; - - /** End value of the strip line. - * @Default {null} - */ - end?: number; - - /** Options for customizing the font of the text. - */ - font?: AxesStripLineFont; - - /** Start value of the strip line. - * @Default {null} - */ - start?: number; - - /** Indicates whether to render the strip line from the minimum/start value of the axis. This property does not work when start property is set. - * @Default {false} - */ - startFromAxis?: boolean; - - /** Specifies text to be displayed inside the strip line. - * @Default {stripLine} - */ - text?: string; - - /** Specifies the alignment of the text inside the strip line. - * @Default {middlecenter. See TextAlignment} - */ - textAlignment?: ej.datavisualization.Chart.TextAlignment|string; - - /** Show/hides the strip line. - * @Default {false} - */ - visible?: boolean; - - /** Width of the strip line. - * @Default {0} - */ - width?: number; - - /** Specifies the order where the strip line and the series have to be rendered. When Z-order is Ă¢â‚¬Å“behindĂ¢â‚¬Â, strip line is rendered under the series and when it is Ă¢â‚¬Å“overĂ¢â‚¬Â, - * it is rendered above the series. - * @Default {over. See ZIndex} - */ - zIndex?: ej.datavisualization.Chart.ZIndex|string; -} - -export interface AxesLabelBorder { - - /** Specifies the color of the label border. - * @Default {null} - */ - color?: string; - - /** Specifies the width of the label border. - * @Default {1} - */ - width?: number; -} - -export interface AxesTitleFont { - - /** Font family of the title text. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style of the title text. - * @Default {ej.datavisualization.Chart.FontStyle.Normal} - */ - fontStyle?: ej.datavisualization.Chart.FontStyle|string; - - /** Font weight of the title text. - * @Default {ej.datavisualization.Chart.FontWeight.Regular. See FontWeight} - */ - fontWeight?: ej.datavisualization.Chart.FontWeight|string; - - /** Opacity of the axis title text. - * @Default {1} - */ - opacity?: number; - - /** Font size of the axis title. - * @Default {16px} - */ - size?: string; -} - -export interface AxesTitle { - - /** Specifies whether to trim the axis title when it exceeds the chart area or the maximum width of the title. - * @Default {false} - */ - enableTrim?: boolean; - - /** Options for customizing the title font. - */ - font?: AxesTitleFont; - - /** Maximum width of the title, when the title exceeds this width, the title gets trimmed, when enableTrim is true. - * @Default {34} - */ - maximumTitleWidth?: number; - - /** Title for the axis. - */ - text?: string; - - /** Controls the visibility of axis title. - * @Default {true} - */ - visible?: boolean; - - /** offset value for axis title. - * @Default {0} - */ - offset?: number; - - /** Specifies the position of the axis title. - * @Default {outside. See Position} - */ - position?: ej.datavisualization.Chart.LabelPosition|string; - - /** Specifies the position of the axis title. - * @Default {center. See Alignment} - */ - alignment?: ej.datavisualization.Chart.TextAlignment|string; -} - -export interface Axis { - - /** Options for customizing axis alternate grid band. - */ - alternateGridBand?: AxesAlternateGridBand; - - /** Specifies where axis should intersect the vertical axis or vice versa. Value should be provided in axis co-ordinates. If provided value is greater than the maximum value of crossing axis, - * then axis will be placed at the opposite side. - * @Default {null} - */ - crossesAt?: number; - - /** Category axis can also plot points based on index value of data points. Index based plotting can be enabled by setting Ă¢â‚¬ËœisIndexedĂ¢â‚¬â„¢ property to true. - * @Default {false} - */ - isIndexed?: boolean; - - /** Options for customizing the axis line. - */ - axisLine?: AxesAxisLine; - - /** Specifies the index of the column where the axis is associated, when the chart area is divided into multiple plot areas by using columnDefinitions. - * @Default {null} - */ - columnIndex?: number; - - /** Specifies the number of columns or plot areas an axis has to span horizontally. - * @Default {null} - */ - columnSpan?: number; - - /** Options to customize the crosshair label. - */ - crosshairLabel?: AxesCrosshairLabel; - - /** With this setting, you can request axis to calculate intervals approximately equal to your desired interval. - * @Default {null} - */ - desiredIntervals?: number; - - /** Specifies the placement of labels. - * @Default {ej.datavisualization.Chart.LabelPlacement.BetweenTicks. See LabelPlacement} - */ - labelPlacement?: ej.datavisualization.Chart.LabelPlacement|string; - - /** Specifies the position of labels at the edge of the axis. - * @Default {ej.datavisualization.Chart.EdgeLabelPlacement.None. See EdgeLabelPlacement} - */ - edgeLabelPlacement?: ej.datavisualization.Chart.EdgeLabelPlacement|string; - - /** Specifies whether to trim the axis label when the width of the label exceeds the maximumLabelWidth. - * @Default {false} - */ - enableTrim?: boolean; - - /** Options for customizing the font of the axis Labels. - */ - font?: AxesFont; - - /** Specifies the type of interval in date time axis. - * @Default {null. See IntervalType} - */ - intervalType?: ej.datavisualization.Chart.IntervalType|string; - - /** Specifies whether to inverse the axis. - * @Default {false} - */ - isInversed?: boolean; - - /** Custom formatting for axis label and supports all standard formatting type of numerical and date time values. - * @Default {null} - */ - labelFormat?: string; - - /** Specifies the action to take when the axis labels are overlapping with each other. - * @Default {ej.datavisualization.Chart.LabelIntersectAction.None. See LabelIntersectAction} - */ - labelIntersectAction?: ej.datavisualization.Chart.LabelIntersectAction|string; - - /** Specifies the position of the axis labels. - * @Default {outside. See LabelPosition} - */ - labelPosition?: ej.datavisualization.Chart.LabelPosition|string; - - /** Specifies the position of the axis labels. - * @Default {center. See Alignment} - */ - alignment?: ej.datavisualization.Chart.LabelAlignment|string; - - /** Angle in degrees to rotate the axis labels. - * @Default {null} - */ - labelRotation?: number; - - /** Logarithmic base value. This is applicable only for logarithmic axis. - * @Default {10} - */ - logBase?: number; - - /** Options for customizing major gird lines. - */ - majorGridLines?: AxesMajorGridLines; - - /** Options for customizing the major tick lines. - */ - majorTickLines?: AxesMajorTickLines; - - /** Maximum number of labels to be displayed in every 100 pixels. - * @Default {3} - */ - maximumLabels?: number; - - /** Maximum width of the axis label. When the label exceeds the width, the label gets trimmed when the enableTrim is set to true. - * @Default {34} - */ - maximumLabelWidth?: number; - - /** Options for customizing the minor grid lines. - */ - minorGridLines?: AxesMinorGridLines; - - /** Options for customizing the minor tick lines. - */ - minorTickLines?: AxesMinorTickLines; - - /** Specifies the number of minor ticks per interval. - * @Default {null} - */ - minorTicksPerInterval?: number; - - /** Unique name of the axis. To associate an axis with the series, you have to set this name to the xAxisName/yAxisName property of the series. - * @Default {null} - */ - name?: string; - - /** Specifies whether to render the axis at the opposite side of its default position. - * @Default {false} - */ - opposedPosition?: boolean; - - /** Specifies the padding for the plot area. - * @Default {10} - */ - plotOffset?: number; - - /** Options to customize the range of the axis. - */ - range?: AxesRange; - - /** Specifies the padding for the axis range. - * @Default {None. See RangePadding} - */ - rangePadding?: ej.datavisualization.Chart.RangePadding|string; - - /** Rounds the number to the given number of decimals. - * @Default {null} - */ - roundingPlaces?: number; - - /** Options for customizing the multi level labels. - * @Default {[ ]} - */ - multiLevelLabels?: AxesMultiLevelLabel[]; - - /** Options for customizing the strip lines. - * @Default {[ ]} - */ - stripLine?: AxesStripLine[]; - - /** Specifies the position of the axis tick lines. - * @Default {outside. See TickLinesPosition} - */ - tickLinesPosition?: ej.datavisualization.Chart.TickLinesPosition|string; - - /** Options for customizing the border of the labels. - */ - labelBorder?: AxesLabelBorder; - - /** Options for customizing the axis title. - */ - title?: AxesTitle; - - /** Specifies the type of data the axis is handling. - * @Default {null. See ValueType} - */ - valueType?: ej.datavisualization.Chart.ValueType|string; - - /** Show/hides the axis. - * @Default {true} - */ - visible?: boolean; - - /** The axis is scaled by this factor. When zoomFactor is 0.5, the chart is scaled by 200% along this axis. Value ranges from 0 to 1. - * @Default {1} - */ - zoomFactor?: number; - - /** Position of the zoomed axis. Value ranges from 0 to 1. - * @Default {0} - */ - zoomPosition?: number; -} - -export interface PrimaryYAxisAlternateGridBandEven { - - /** Fill color for the even grid bands. - * @Default {transparent} - */ - fill?: string; - - /** Opacity of the even grid band. - * @Default {1} - */ - opacity?: number; -} - -export interface PrimaryYAxisAlternateGridBandOdd { - - /** Fill color of the odd grid bands. - * @Default {transparent} - */ - fill?: string; - - /** Opacity of odd grid band. - * @Default {1} - */ - opacity?: number; -} - -export interface PrimaryYAxisAlternateGridBand { - - /** Options for customizing even grid band. - */ - even?: PrimaryYAxisAlternateGridBandEven; - - /** Options for customizing odd grid band. - */ - odd?: PrimaryYAxisAlternateGridBandOdd; -} - -export interface PrimaryYAxisAxisLine { - - /** Pattern of dashes and gaps to be applied to the axis line. - * @Default {null} - */ - dashArray?: string; - - /** Padding for axis line. Normally, it is used along with plotOffset to pad the plot area. - * @Default {null} - */ - offset?: number; - - /** Show/hides the axis line. - * @Default {true} - */ - visible?: boolean; - - /** Color of axis line. - */ - color?: string; - - /** Width of axis line. - * @Default {1} - */ - width?: number; -} - -export interface PrimaryYAxisCrosshairLabel { - - /** Show/hides the crosshair label associated with this axis. - * @Default {false} - */ - visible?: boolean; -} - -export interface PrimaryYAxisFont { - - /** Font family of labels. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style of labels. - * @Default {ej.datavisualization.Chart.FontStyle.Normal. See FontStyle} - */ - fontStyle?: ej.datavisualization.Chart.FontStyle|string; - - /** Font weight of the label. - * @Default {ej.datavisualization.Chart.FontWeight.Regular. See FontWeight} - */ - fontWeight?: ej.datavisualization.Chart.FontWeight|string; - - /** Opacity of the axis labels. - * @Default {1} - */ - opacity?: number; - - /** Font size of the axis labels. - * @Default {13px} - */ - size?: string; -} - -export interface PrimaryYAxisMajorGridLines { - - /** Pattern of dashes and gaps used to stroke the major grid lines. - * @Default {null} - */ - dashArray?: string; - - /** Color of the major grid lines. - * @Default {null} - */ - color?: string; - - /** Opacity of major grid lines. - * @Default {1} - */ - opacity?: number; - - /** Show/hides the major grid lines. - * @Default {true} - */ - visible?: boolean; - - /** Width of the major grid lines. - * @Default {1} - */ - width?: number; -} - -export interface PrimaryYAxisMajorTickLines { - - /** Length of the major tick lines. - * @Default {5} - */ - size?: number; - - /** Show/hides the major tick lines. - * @Default {true} - */ - visible?: boolean; - - /** Width of the major tick lines. - * @Default {1} - */ - width?: number; -} - -export interface PrimaryYAxisMinorGridLines { - - /** Patterns of dashes and gaps used to stroke the minor grid lines. - * @Default {null} - */ - dashArray?: string; - - /** Show/hides the minor grid lines. - * @Default {true} - */ - visible?: boolean; - - /** Width of the minorGridLines. - * @Default {1} - */ - width?: number; -} - -export interface PrimaryYAxisMinorTickLines { - - /** Length of the minor tick lines. - * @Default {5} - */ - size?: number; - - /** Show/hides the minor tick lines. - * @Default {true} - */ - visible?: boolean; - - /** Width of the minor tick line - * @Default {1} - */ - width?: number; -} - -export interface PrimaryYAxisRange { - - /** Minimum value of the axis range. - * @Default {null} - */ - min?: number; - - /** Maximum value of the axis range. - * @Default {null} - */ - max?: number; - - /** Interval for the range. - * @Default {null} - */ - interval?: number; -} - -export interface PrimaryYAxisMultiLevelLabelsFont { - - /** Font color of the multi level labels text. - * @Default {null} - */ - color?: string; - - /** Font family of the multi level labels text. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style of the multi level labels text. - * @Default {Normal} - */ - fontStyle?: ej.datavisualization.Chart.FontStyle|string; - - /** Font weight of the multi level label text. - * @Default {regular} - */ - fontWeight?: string; - - /** Opacity of the multi level label text. - * @Default {1} - */ - opacity?: number; - - /** Font size of the multi level label text. - * @Default {12px} - */ - size?: string; -} - -export interface PrimaryYAxisMultiLevelLabelsBorder { - - /** Border color of the multi level labels. - * @Default {null} - */ - color?: string; - - /** Border width of the multi level labels. - * @Default {1} - */ - width?: number; - - /** Border type of the multi level labels. - * @Default {rectangle. See Type} - */ - type?: ej.datavisualization.Chart.MultiLevelLabelsBorderType|string; -} - -export interface PrimaryYAxisMultiLevelLabel { - - /** Visibility of the multi level labels. - * @Default {false} - */ - visible?: boolean; - - /** Text of the multi level labels. - */ - text?: string; - - /** Starting value of the multi level labels. - * @Default {null} - */ - start?: number; - - /** Ending value of the multi level labels. - * @Default {null} - */ - end?: number; - - /** Specifies the level of multi level labels. - * @Default {0} - */ - level?: number; - - /** Specifies the maximum width of the text in multi level labels. - * @Default {null} - */ - maximumTextWidth?: number; - - /** Specifies the alignment of the text in multi level labels. - * @Default {center. See TextAlignment} - */ - textAlignment?: ej.datavisualization.Chart.TextAlignment|string; - - /** Specifies the handling of text over flow in multi level labels. - * @Default {center. See TextOverflow} - */ - textOverflow?: ej.datavisualization.Chart.TextOverflow|string; - - /** Options for customizing the font of the text. - */ - font?: PrimaryYAxisMultiLevelLabelsFont; - - /** Options for customizing the border of the series. - */ - border?: PrimaryYAxisMultiLevelLabelsBorder; -} - -export interface PrimaryYAxisStripLineFont { - - /** Font color of the strip line text. - * @Default {black} - */ - color?: string; - - /** Font family of the strip line text. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style of the strip line text. - * @Default {Normal} - */ - fontStyle?: ej.datavisualization.Chart.FontStyle|string; - - /** Font weight of the strip line text. - * @Default {regular} - */ - fontWeight?: string; - - /** Opacity of the strip line text. - * @Default {1} - */ - opacity?: number; - - /** Font size of the strip line text. - * @Default {12px} - */ - size?: string; -} - -export interface PrimaryYAxisStripLine { - - /** Border color of the strip line. - * @Default {gray} - */ - borderColor?: string; - - /** Background color of the strip line. - * @Default {gray} - */ - color?: string; - - /** End value of the strip line. - * @Default {null} - */ - end?: number; - - /** Options for customizing the font of the text. - */ - font?: PrimaryYAxisStripLineFont; - - /** Start value of the strip line. - * @Default {null} - */ - start?: number; - - /** Indicates whether to render the strip line from the minimum/start value of the axis. This property wonĂ¢â‚¬â„¢t work when start property is set. - * @Default {false} - */ - startFromAxis?: boolean; - - /** Specifies text to be displayed inside the strip line. - * @Default {stripLine} - */ - text?: string; - - /** Specifies the alignment of the text inside the strip line. - * @Default {middlecenter. See TextAlignment} - */ - textAlignment?: ej.datavisualization.Chart.TextAlignment|string; - - /** Show/hides the strip line. - * @Default {false} - */ - visible?: boolean; - - /** Width of the strip line. - * @Default {0} - */ - width?: number; - - /** Specifies the order in which strip line and the series have to be rendered. When Z-order is Ă¢â‚¬Å“behindĂ¢â‚¬Â, strip line is rendered below the series and - * when it is Ă¢â‚¬Å“overĂ¢â‚¬Â, it is rendered above the series. - * @Default {over. See ZIndex} - */ - zIndex?: ej.datavisualization.Chart.ZIndex|string; -} - -export interface PrimaryYAxisLabelBorder { - - /** Specifies the color of the label border. - * @Default {null} - */ - color?: string; - - /** Specifies the width of the label border. - * @Default {1} - */ - width?: number; -} - -export interface PrimaryYAxisTitleFont { - - /** Font family of the title text. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style of the title text. - * @Default {ej.datavisualization.Chart.FontStyle.Normal} - */ - fontStyle?: ej.datavisualization.Chart.FontStyle|string; - - /** Font weight of the title text. - * @Default {ej.datavisualization.Chart.FontWeight.Regular. See FontWeight} - */ - fontWeight?: ej.datavisualization.Chart.FontWeight|string; - - /** Opacity of the axis title text. - * @Default {1} - */ - opacity?: number; - - /** Font size of the axis title. - * @Default {16px} - */ - size?: string; -} - -export interface PrimaryYAxisTitle { - - /** Specifies whether to trim the axis title when it exceeds the chart area or the maximum width of the title. - * @Default {ej.datavisualization.Chart.enableTrim} - */ - enableTrim?: boolean; - - /** Options for customizing the title font. - */ - font?: PrimaryYAxisTitleFont; - - /** Maximum width of the title, when the title exceeds this width, the title gets trimmed, when enableTrim is true. - * @Default {ej.datavisualization.Chart.maximumTitleWidth.null} - */ - maximumTitleWidth?: number; - - /** Title for the axis. - */ - text?: string; - - /** Controls the visibility of axis title. - * @Default {true} - */ - visible?: boolean; - - /** offset value for axis title. - * @Default {0} - */ - offset?: number; - - /** Specifies the position of the axis title. - * @Default {outside. See Position} - */ - position?: ej.datavisualization.Chart.LabelPosition|string; - - /** Specifies the position of the axis title. - * @Default {center. See Alignment} - */ - alignment?: ej.datavisualization.Chart.TextAlignment|string; -} - -export interface PrimaryYAxis { - - /** Options for customizing vertical axis alternate grid band. - */ - alternateGridBand?: PrimaryYAxisAlternateGridBand; - - /** Options for customizing the axis line. - */ - axisLine?: PrimaryYAxisAxisLine; - - /** Specifies where horizontal axis should intersect the vertical axis or vice versa. Value should be provided in axis co-ordinates. - * If provided value is greater than the maximum value of crossing axis, then axis will be placed at the opposite side. - * @Default {null} - */ - crossesAt?: number; - - /** Name of the axis used for crossing. Vertical axis name should be provided for horizontal axis and vice versa. If the provided name does not belongs to a valid axis, - * then primary X axis or primary Y axis will be used for crossing - * @Default {null} - */ - crossesInAxis?: string; - - /** Options to customize the crosshair label. - */ - crosshairLabel?: PrimaryYAxisCrosshairLabel; - - /** With this setting, you can request axis to calculate intervals approximately equal to your desired interval. - * @Default {null} - */ - desiredIntervals?: number; - - /** Specifies the placement of labels. - * @Default {ej.datavisualization.Chart.LabelPlacement.BetweenTicks. See LabelPlacement} - */ - labelPlacement?: ej.datavisualization.Chart.LabelPlacement|string; - - /** Specifies the position of labels at the edge of the axis. - * @Default {ej.datavisualization.Chart.EdgeLabelPlacement.None. See EdgeLabelPlacement} - */ - edgeLabelPlacement?: ej.datavisualization.Chart.EdgeLabelPlacement|string; - - /** Specifies whether to trim the axis label when the width of the label exceeds the maximumLabelWidth. - * @Default {false} - */ - enableTrim?: boolean; - - /** Options for customizing the font of the axis Labels. - */ - font?: PrimaryYAxisFont; - - /** Specifies the type of interval in date time axis. - * @Default {null. See IntervalType} - */ - intervalType?: ej.datavisualization.Chart.IntervalType|string; - - /** Specifies whether to inverse the axis. - * @Default {false} - */ - isInversed?: boolean; - - /** Custom formatting for axis label and supports all standard formatting type of numerical and date time values. - * @Default {null} - */ - labelFormat?: string; - - /** Specifies the action to take when the axis labels are overlapping with each other. - * @Default {ej.datavisualization.Chart.LabelIntersectAction.None} - */ - labelIntersectAction?: ej.datavisualization.Chart.LabelIntersectAction|string; - - /** Specifies the position of the axis labels. - * @Default {outside. See LabelPosition} - */ - labelPosition?: ej.datavisualization.Chart.LabelPosition|string; - - /** Specifies the position of the axis labels. - * @Default {center. See Alignment} - */ - alignment?: ej.datavisualization.Chart.LabelAlignment|string; - - /** Logarithmic base value. This is applicable only for logarithmic axis. - * @Default {10} - */ - logBase?: number; - - /** Options for customizing major gird lines. - */ - majorGridLines?: PrimaryYAxisMajorGridLines; - - /** Options for customizing the major tick lines. - */ - majorTickLines?: PrimaryYAxisMajorTickLines; - - /** Maximum number of labels to be displayed in every 100 pixels. - * @Default {3} - */ - maximumLabels?: number; - - /** Maximum width of the axis label. When the label exceeds the width, the label gets trimmed when the enableTrim is set to true. - * @Default {ej.datavisualization.Chart.maximumLabelWidth type {int}} - */ - maximumLabelWidth?: number; - - /** Options for customizing the minor grid lines. - */ - minorGridLines?: PrimaryYAxisMinorGridLines; - - /** Options for customizing the minor tick lines. - */ - minorTickLines?: PrimaryYAxisMinorTickLines; - - /** Specifies the number of minor ticks per interval. - * @Default {null} - */ - minorTicksPerInterval?: number; - - /** Unique name of the axis. To associate an axis with the series, you have to set this name to the xAxisName/yAxisName property of the series. - * @Default {null} - */ - name?: string; - - /** Specifies whether to render the axis at the opposite side of its default position. - * @Default {false} - */ - opposedPosition?: boolean; - - /** Specifies the padding for the plot area. - * @Default {10} - */ - plotOffset?: number; - - /** Options to customize the range of the axis. - */ - range?: PrimaryYAxisRange; - - /** Specifies the padding for the axis range. - * @Default {ej.datavisualization.Chart.RangePadding.None. See RangePadding} - */ - rangePadding?: ej.datavisualization.Chart.RangePadding|string; - - /** Rounds the number to the given number of decimals. - * @Default {null} - */ - roundingPlaces?: number; - - /** Specifies the index of the row to which the axis is associated, when the chart area is divided into multiple plot areas by using rowDefinitions. - * @Default {null} - */ - rowIndex?: number; - - /** Specifies the number of row or plot areas an axis has to span vertically. - * @Default {null} - */ - rowSpan?: number; - - /** Options for customizing the multi level labels. - * @Default {[ ]} - */ - multiLevelLabels?: PrimaryYAxisMultiLevelLabel[]; - - /** Options for customizing the strip lines. - * @Default {[ ]} - */ - stripLine?: PrimaryYAxisStripLine[]; - - /** Specifies the position of the axis tick lines. - * @Default {outside. See TickLinesPosition} - */ - tickLinesPosition?: ej.datavisualization.Chart.TickLinesPosition|string; - - /** Options for customizing the border of the labels. - */ - labelBorder?: PrimaryYAxisLabelBorder; - - /** Options for customizing the axis title. - */ - title?: PrimaryYAxisTitle; - - /** Specifies the type of data the axis is handling. - * @Default {null. See ValueType} - */ - valueType?: ej.datavisualization.Chart.ValueType|string; - - /** Show/hides the axis. - * @Default {true} - */ - visible?: boolean; - - /** The axis is scaled by this factor. When zoomFactor is 0.5, the chart is scaled by 200% along this axis. Values ranges from 0 to 1. - * @Default {1} - */ - zoomFactor?: number; - - /** Position of the zoomed axis. Value ranges from 0 to 1 - * @Default {0} - */ - zoomPosition?: number; -} - -export interface RowDefinition { - - /** Specifies the unit to measure the height of the row in plotting area. - * @Default {'pixel'. See Unit} - */ - unit?: ej.datavisualization.Chart.Unit|string; - - /** Height of the row in plotting area. Height is measured in either pixel or percentage based on the value of unit property. - * @Default {50} - */ - rowHeight?: number; - - /** Color of the line that indicates the starting point of the row in plotting area. - * @Default {transparent} - */ - lineColor?: string; - - /** Width of the line that indicates the starting point of the row in plot area. - * @Default {1} - */ - lineWidth?: number; -} - -export interface SeriesBorder { - - /** Border color of the series. - * @Default {transparent} - */ - color?: string; - - /** Border width of the series. - * @Default {1} - */ - width?: number; - - /** DashArray for border of the series. - * @Default {null} - */ - dashArray?: string; -} - -export interface SeriesFont { - - /** Font color of the series text. - * @Default {#707070} - */ - color?: string; - - /** Font Family of the series. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font Style of the series. - * @Default {Normal} - */ - fontStyle?: ej.datavisualization.Chart.FontStyle|string; - - /** Font weight of the series. - * @Default {Regular} - */ - fontWeight?: ej.datavisualization.Chart.FontWeight|string; - - /** Opacity of series text. - * @Default {1} - */ - opacity?: number; - - /** Size of the series text. - * @Default {12px} - */ - size?: string; -} - -export interface SeriesMarkerBorder { - - /** Border color of the marker shape. - * @Default {white} - */ - color?: string; - - /** Border width of the marker shape. - * @Default {3} - */ - width?: number; -} - -export interface SeriesMarkerDataLabelBorder { - - /** Border color of the data label. - * @Default {null} - */ - color?: string; - - /** Border width of the data label. - * @Default {0.1} - */ - width?: number; -} - -export interface SeriesMarkerDataLabelConnectorLine { - - /** Specifies when the connector has to be drawn as Bezier curve or straight line. This is applicable only for Pie and Doughnut chart types. - * @Default {line. See ConnectorLineType} - */ - type?: ej.datavisualization.Chart.Type|string; - - /** Width of the connector. - * @Default {0.5} - */ - width?: number; - - /** Color of the connector. - * @Default {null} - */ - color?: string; - - /** Height of the connector. - * @Default {null} - */ - height?: number; -} - -export interface SeriesMarkerDataLabelFont { - - /** Font family of the data label. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font color of the data label text. - * @Default {null} - */ - color?: string; - - /** Font style of the data label. - * @Default {normal. See FontStyle} - */ - fontStyle?: ej.datavisualization.Chart.FontStyle|string; - - /** Font weight of the data label. - * @Default {regular. See FontWeight} - */ - fontWeight?: ej.datavisualization.Chart.FontWeight|string; - - /** Opacity of the text. - * @Default {1} - */ - opacity?: number; - - /** Font size of the data label. - * @Default {12px} - */ - size?: string; -} - -export interface SeriesMarkerDataLabelMargin { - - /** Bottom margin of the text. - * @Default {5} - */ - bottom?: number; - - /** Left margin of the text. - * @Default {5} - */ - left?: number; - - /** Right margin of the text. - * @Default {5} - */ - right?: number; - - /** Top margin of the text. - * @Default {5} - */ - top?: number; -} - -export interface SeriesMarkerDataLabel { - - /** Angle of the data label in degrees. Only the text gets rotated, whereas the background and border does not rotate. - * @Default {null} - */ - angle?: number; - - /** Maximum label width of the data label. - * @Default {null} - */ - maximumLabelWidth?: number; - - /** Enable the wrap option to the data label. - * @Default {false} - */ - enableWrap?: boolean; - - /** Options for customizing the border of the data label. - */ - border?: SeriesMarkerDataLabelBorder; - - /** Options for displaying and customizing the line that connects point and data label. - */ - connectorLine?: SeriesMarkerDataLabelConnectorLine; - - /** Background color of the data label. - * @Default {null} - */ - fill?: string; - - /** Options for customizing the data label font. - */ - font?: SeriesMarkerDataLabelFont; - - /** Horizontal alignment of the data label. - * @Default {center} - */ - horizontalTextAlignment?: ej.datavisualization.Chart.HorizontalTextAlignment|string; - - /** Margin of the text to its background shape. The size of the background shape increases based on the margin applied to its text. - */ - margin?: SeriesMarkerDataLabelMargin; - - /** Opacity of the data label. - * @Default {1} - */ - opacity?: number; - - /** Background shape of the data label. - * @Default {No shape is rendered by default, so its value is Ă¢â‚¬ËœnoneĂ¢â‚¬â„¢. See Shape} - */ - shape?: ej.datavisualization.Chart.Shape|string; - - /** Name of a field in data source where datalabel text is displayed. - */ - textMappingName?: string; - - /** Specifies the position of the data label. This property can be used only for the series such as column, bar, stacked column, stacked bar, 100% stacked column, 100% stacked bar, candle and OHLC. - * @Default {top. See TextPosition} - */ - textPosition?: ej.datavisualization.Chart.TextPosition|string; - - /** Vertical alignment of the data label. - * @Default {'center'} - */ - verticalTextAlignment?: ej.datavisualization.Chart.VerticalTextAlignment|string; - - /** Controls the visibility of the data labels. - * @Default {false} - */ - visible?: boolean; - - /** Custom template to format the data label content. Use Ă¢â‚¬Å“point.xĂ¢â‚¬Â and Ă¢â‚¬Å“point.yĂ¢â‚¬Â as a placeholder text to display the corresponding data pointĂ¢â‚¬â„¢s x and y value. - */ - template?: string; - - /** Moves the label vertically by some offset. - * @Default {0} - */ - offset?: number; -} - -export interface SeriesMarkerSize { - - /** Height of the marker. - * @Default {6} - */ - height?: number; - - /** Width of the marker. - * @Default {6} - */ - width?: number; -} - -export interface SeriesMarker { - - /** Options for customizing the border of the marker shape. - */ - border?: SeriesMarkerBorder; - - /** Options for displaying and customizing data labels. - */ - dataLabel?: SeriesMarkerDataLabel; - - /** Color of the marker shape. - * @Default {null} - */ - fill?: string; - - /** The URL for the Image that is to be displayed as marker. In order to display image as marker, set series.marker.shape as Ă¢â‚¬ËœimageĂ¢â‚¬â„¢. - */ - imageUrl?: string; - - /** Opacity of the marker. - * @Default {1} - */ - opacity?: number; - - /** Specifies the shape of the marker. - * @Default {circle. See Shape} - */ - shape?: ej.datavisualization.Chart.Shape|string; - - /** Options for customizing the size of the marker shape. - */ - size?: SeriesMarkerSize; - - /** Controls the visibility of the marker shape. - * @Default {false} - */ - visible?: boolean; -} - -export interface SeriesOutlierSettingsSize { - - /** Height of the outlier shape. - * @Default {6} - */ - height?: number; - - /** Width of the outlier shape. - * @Default {6} - */ - width?: number; -} - -export interface SeriesOutlierSettings { - - /** Specifies the shape of the outlier. - * @Default {circle. See Shape} - */ - shape?: ej.datavisualization.Chart.Shape|string; - - /** Options for customizing the size of the outlier shape. - */ - size?: SeriesOutlierSettingsSize; -} - -export interface SeriesEmptyPointSettingsStyleBorder { - - /** Border color of the empty point. - */ - color?: string; - - /** Border width of the empty point. - * @Default {1} - */ - width?: number; -} - -export interface SeriesEmptyPointSettingsStyle { - - /** Color of the empty point. - */ - color?: string; - - /** Options for customizing border of the empty point in the series. - */ - border?: SeriesEmptyPointSettingsStyleBorder; -} - -export interface SeriesEmptyPointSettings { - - /** Controls the visibility of the empty point. - * @Default {true} - */ - visible?: boolean; - - /** Specifies the mode of empty point. - * @Default {gap} - */ - displayMode?: ej.datavisualization.Chart.EmptyPointMode|string; - - /** Options for customizing the color and border of the empty point in the series. - */ - style?: SeriesEmptyPointSettingsStyle; -} - -export interface SeriesConnectorLine { - - /** Width of the connector line. - * @Default {1} - */ - width?: number; - - /** Color of the connector line. - * @Default {#565656} - */ - color?: string; - - /** DashArray of the connector line. - * @Default {null} - */ - dashArray?: string; - - /** Opacity of the connector line. - * @Default {1} - */ - opacity?: number; -} - -export interface SeriesDragSettings { - - /** drag/drop the series - * @Default {false} - */ - enable?: boolean; - - /** Specifies the type of drag settings. - * @Default {xy} - */ - type?: string; -} - -export interface SeriesErrorBarCap { - - /** Show/Hides the error bar cap. - * @Default {true} - */ - visible?: boolean; - - /** Width of the error bar cap. - * @Default {1} - */ - width?: number; - - /** Length of the error bar cap. - * @Default {1} - */ - length?: number; - - /** Color of the error bar cap. - * @Default {#000000} - */ - fill?: string; -} - -export interface SeriesErrorBar { - - /** Show/hides the error bar - * @Default {visible} - */ - visibility?: boolean; - - /** Specifies the type of error bar. - * @Default {FixedValue} - */ - type?: ej.datavisualization.Chart.ErrorBarType|string; - - /** Specifies the mode of error bar. - * @Default {vertical} - */ - mode?: ej.datavisualization.Chart.ErrorBarMode|string; - - /** Specifies the direction of error bar. - * @Default {both} - */ - direction?: ej.datavisualization.Chart.ErrorBarDirection|string; - - /** Value of vertical error bar. - * @Default {3} - */ - verticalErrorValue?: number; - - /** Value of horizontal error bar. - * @Default {1} - */ - horizontalErrorValue?: number; - - /** Value of positive horizontal error bar. - * @Default {1} - */ - horizontalPositiveErrorValue?: number; - - /** Value of negative horizontal error bar. - * @Default {1} - */ - horizontalNegativeErrorValue?: number; - - /** Value of positive vertical error bar. - * @Default {5} - */ - verticalPositiveErrorValue?: number; - - /** Value of negative vertical error bar. - * @Default {5} - */ - verticalNegativeErrorValue?: number; - - /** Fill color of the error bar. - * @Default {#000000} - */ - fill?: string; - - /** Width of the error bar. - * @Default {1} - */ - width?: number; - - /** Options for customizing the error bar cap. - */ - cap?: SeriesErrorBarCap; -} - -export interface SeriesPointsBorder { - - /** Border color of the point. - * @Default {null} - */ - color?: string; - - /** Border width of the point. - * @Default {null} - */ - width?: number; -} - -export interface SeriesPointsMarkerBorder { - - /** Border color of the marker shape. - * @Default {white} - */ - color?: string; - - /** Border width of the marker shape. - * @Default {3} - */ - width?: number; -} - -export interface SeriesPointsMarkerDataLabelBorder { - - /** Border color of the data label. - * @Default {null} - */ - color?: string; - - /** Border width of the data label. - * @Default {0.1} - */ - width?: number; -} - -export interface SeriesPointsMarkerDataLabelConnectorLine { - - /** Specifies when the connector has to be drawn as Bezier curve or straight line. This is applicable only for Pie and Doughnut chart types. - * @Default {line. See ConnectorLineType} - */ - type?: ej.datavisualization.Chart.ConnectorLineType|string; - - /** Width of the connector. - * @Default {0.5} - */ - width?: number; -} - -export interface SeriesPointsMarkerDataLabelFont { - - /** Font family of the data label. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style of the data label. - * @Default {normal. See FontStyle} - */ - fontStyle?: ej.datavisualization.Chart.FontStyle|string; - - /** Font weight of the data label. - * @Default {regular. See FontWeight} - */ - fontWeight?: ej.datavisualization.Chart.FontWeight|string; - - /** Opacity of the text. - * @Default {1} - */ - opacity?: number; - - /** Font size of the data label. - * @Default {12px} - */ - size?: string; -} - -export interface SeriesPointsMarkerDataLabelMargin { - - /** Bottom margin of the text. - * @Default {5} - */ - bottom?: number; - - /** Left margin of the text. - * @Default {5} - */ - left?: number; - - /** Right margin of the text. - * @Default {5} - */ - right?: number; - - /** Top margin of the text. - * @Default {5} - */ - top?: number; -} - -export interface SeriesPointsMarkerDataLabel { - - /** Angle of the data label in degrees. Only the text gets rotated, whereas the background and border does not rotate. - * @Default {null} - */ - angle?: number; - - /** Options for customizing the border of the data label. - */ - border?: SeriesPointsMarkerDataLabelBorder; - - /** Options for displaying and customizing the line that connects point and data label. - */ - connectorLine?: SeriesPointsMarkerDataLabelConnectorLine; - - /** Background color of the data label. - * @Default {null} - */ - fill?: string; - - /** Options for customizing the data label font. - */ - font?: SeriesPointsMarkerDataLabelFont; - - /** Horizontal alignment of the data label. - * @Default {center} - */ - horizontalTextAlignment?: ej.datavisualization.Chart.HorizontalTextAlignment|string; - - /** Margin of the text to its background shape. The size of the background shape increases based on the margin applied to its text. - */ - margin?: SeriesPointsMarkerDataLabelMargin; - - /** Opacity of the data label. - * @Default {1} - */ - opacity?: number; - - /** Background shape of the data label. - * @Default {No shape is rendered by default, so its value is Ă¢â‚¬ËœnoneĂ¢â‚¬â„¢. See Shape} - */ - shape?: ej.datavisualization.Chart.Shape|string; - - /** Specifies the position of the data label. This property can be used only for the series such as column, bar, stacked column, stacked bar, 100% stacked column, 100% stacked bar, candle and OHLC. - * @Default {top. See TextPosition} - */ - textPosition?: ej.datavisualization.Chart.TextPosition|string; - - /** Vertical alignment of the data label. - * @Default {'center'} - */ - verticalTextAlignment?: ej.datavisualization.Chart.VerticalTextAlignment|string; - - /** Controls the visibility of the data labels. - * @Default {false} - */ - visible?: boolean; - - /** Custom template to format the data label content. Use Ă¢â‚¬Å“point.xĂ¢â‚¬Â and Ă¢â‚¬Å“point.yĂ¢â‚¬Â as a placeholder text to display the corresponding data pointĂ¢â‚¬â„¢s x and y value. - */ - template?: string; - - /** Moves the label vertically by specified offset. - * @Default {0} - */ - offset?: number; -} - -export interface SeriesPointsMarkerSize { - - /** Height of the marker. - * @Default {6} - */ - height?: number; - - /** Width of the marker. - * @Default {6} - */ - width?: number; -} - -export interface SeriesPointsMarker { - - /** Options for customizing the border of the marker shape. - */ - border?: SeriesPointsMarkerBorder; - - /** Options for displaying and customizing data label. - */ - dataLabel?: SeriesPointsMarkerDataLabel; - - /** Color of the marker shape. - * @Default {null} - */ - fill?: string; - - /** The URL for the Image that is to be displayed as marker. In order to display image as marker, set series.marker.shape as Ă¢â‚¬ËœimageĂ¢â‚¬â„¢. - */ - imageUrl?: string; - - /** Opacity of the marker. - * @Default {1} - */ - opacity?: number; - - /** Specifies the shape of the marker. - * @Default {circle. See Shape} - */ - shape?: ej.datavisualization.Chart.Shape|string; - - /** Options for customizing the size of the marker shape. - */ - size?: SeriesPointsMarkerSize; - - /** Controls the visibility of the marker shape. - * @Default {false} - */ - visible?: boolean; -} - -export interface SeriesPoint { - - /** Options for customizing the border of a point. This is applicable only for column type series and accumulation type series. - */ - border?: SeriesPointsBorder; - - /** Enables or disables the visibility of legend item. - * @Default {visible} - */ - visibleOnLegend?: string; - - /** To show/hide the intermediate summary from the last intermediate point. - * @Default {false} - */ - showIntermediateSum?: boolean; - - /** To show/hide the total summary of the waterfall series. - * @Default {false} - */ - showTotalSum?: boolean; - - /** Close value of the point. Close value is applicable only for financial type series. - * @Default {null} - */ - close?: number; - - /** Size of a bubble in the bubble series. This is applicable only for the bubble series. - * @Default {null} - */ - size?: number; - - /** Background color of the point. This is applicable only for column type series and accumulation type series. - * @Default {null} - */ - fill?: string; - - /** High value of the point. High value is applicable only for financial type series, range area series and range column series. - * @Default {null} - */ - high?: number; - - /** Low value of the point. Low value is applicable only for financial type series, range area series and range column series. - * @Default {null} - */ - low?: number; - - /** Options for displaying and customizing marker for a data point. Marker contains shapes and/or data labels. - */ - marker?: SeriesPointsMarker; - - /** Open value of the point. This is applicable only for financial type series. - * @Default {null} - */ - open?: number; - - /** Datalabel text for the point. - * @Default {null} - */ - text?: string; - - /** X value of the point. - * @Default {null} - */ - x?: number; - - /** Y value of the point. - * @Default {null} - */ - y?: number; -} - -export interface SeriesCornerRadius { - - /** Specifies the radius for the top left corner. - * @Default {0} - */ - topLeft?: number; - - /** Specifies the radius for the top right corner. - * @Default {0} - */ - topRight?: number; - - /** Specifies the radius for the bottom left corner. - * @Default {0} - */ - bottomLeft?: number; - - /** Specifies the radius for the bottom right corner. - * @Default {0} - */ - bottomRight?: number; -} - -export interface SeriesTooltipBorder { - - /** Border Color of the tooltip. - * @Default {null} - */ - color?: string; - - /** Border Width of the tooltip. - * @Default {1} - */ - width?: number; -} - -export interface SeriesTooltip { - - /** Options for customizing the border of the tooltip. - */ - border?: SeriesTooltipBorder; - - /** Customize the corner radius of the tooltip rectangle. - * @Default {0} - */ - rx?: number; - - /** Customize the corner radius of the tooltip rectangle. - * @Default {0} - */ - ry?: number; - - /** Specifies the duration, the tooltip has to be displayed. - * @Default {500ms} - */ - duration?: string; - - /** Enables/disables the animation of the tooltip when moving from one point to another. - * @Default {true} - */ - enableAnimation?: boolean; - - /** Background color of the tooltip. - * @Default {null} - */ - fill?: string; - - /** Format of the tooltip content. - * @Default {#point.x# : #point.y#} - */ - format?: string; - - /** Opacity of the tooltip. - * @Default {0.95} - */ - opacity?: number; - - /** Custom template to format the tooltip content. Use Ă¢â‚¬Å“point.xĂ¢â‚¬Â and Ă¢â‚¬Å“point.yĂ¢â‚¬Â as a placeholder text to display the corresponding data pointĂ¢â‚¬â„¢s x and y value. - * @Default {null} - */ - template?: string; - - /** Controls the visibility of the tooltip. - * @Default {false} - */ - visible?: boolean; -} - -export interface SeriesTrendline { - - /** Show/hides the trendline. - */ - visibility?: boolean; - - /** Specifies the type of trendline for the series. - * @Default {linear. See TrendlinesType} - */ - type?: string; - - /** Name for the trendlines that is to be displayed in legend text. - * @Default {Trendline} - */ - name?: string; - - /** Fill color of the trendlines. - * @Default {#0000FF} - */ - fill?: string; - - /** Width of the trendlines. - * @Default {1} - */ - width?: number; - - /** Opacity of the trendline. - * @Default {1} - */ - opacity?: number; - - /** Pattern of dashes and gaps used to stroke the trendline. - */ - dashArray?: string; - - /** Future trends of the current series. - * @Default {0} - */ - forwardForecast?: number; - - /** Past trends of the current series. - * @Default {0} - */ - backwardForecast?: number; - - /** Specifies the order of polynomial trendlines. - * @Default {0} - */ - polynomialOrder?: number; - - /** Specifies the moving average starting period value. - * @Default {2} - */ - period?: number; -} - -export interface SeriesHighlightSettingsBorder { - - /** Border color of the series/point on highlight. - */ - color?: string; - - /** Border width of the series/point on highlight. - * @Default {2} - */ - width?: string; -} - -export interface SeriesHighlightSettings { - - /** Enables/disables the ability to highlight series or data point interactively. - * @Default {false} - */ - enable?: boolean; - - /** Specifies whether series or data point has to be highlighted. - * @Default {series. See Mode} - */ - mode?: ej.datavisualization.Chart.Mode|string; - - /** Color of the series/point on highlight. - */ - color?: string; - - /** Opacity of the series/point on highlight. - * @Default {0.6} - */ - opacity?: number; - - /** Options for customizing the border of series on highlight. - */ - border?: SeriesHighlightSettingsBorder; - - /** Specifies the pattern for the series/point on highlight. - * @Default {none. See Pattern} - */ - pattern?: string; - - /** Custom pattern for the series on highlight. - */ - customPattern?: string; -} - -export interface SeriesSelectionSettingsBorder { - - /** Border color of the series/point on selection. - */ - color?: string; - - /** Border width of the series/point on selection. - * @Default {2} - */ - width?: string; -} - -export interface SeriesSelectionSettings { - - /** Enables/disables the ability to select a series/data point interactively. - * @Default {false} - */ - enable?: boolean; - - /** Specifies whether series or data point has to be selected. - * @Default {series. See Mode} - */ - mode?: ej.datavisualization.Chart.Mode|string; - - /** Specifies the type of selection. - * @Default {single} - */ - type?: ej.datavisualization.Chart.SelectionType|string; - - /** Specifies the drawn rectangle type. - * @Default {xy} - */ - rangeType?: ej.datavisualization.Chart.RangeType|string; - - /** Color of the series/point on selection. - */ - color?: string; - - /** Opacity of the series/point on selection. - * @Default {0.6} - */ - opacity?: number; - - /** Options for customizing the border of series on selection. - */ - border?: SeriesSelectionSettingsBorder; - - /** Specifies the pattern for the series/point on selection. - * @Default {none. See Pattern} - */ - pattern?: string; - - /** Custom pattern for the series on selection. - */ - customPattern?: string; -} - -export interface Series { - - /** Color of the point, where the close is up in financial chart. - * @Default {null} - */ - bearFillColor?: string; - - /** Options for customizing the border of the series. - */ - border?: SeriesBorder; - - /** Color of the point, where the close is down in financial chart. - * @Default {null} - */ - bullFillColor?: string; - - /** To render the column and bar type series in rectangle/cylinder shape. See ColumnFacet - * @Default {rectangle} - */ - columnFacet?: ej.datavisualization.Chart.ColumnFacet|string; - - /** Relative width of the columns in column type series. Value ranges from 0 to 1. Width also depends upon columnSpacing property. - * @Default {0.7} - */ - columnWidth?: number; - - /** Spacing between columns of different series. Value ranges from 0 to 1 - * @Default {0} - */ - columnSpacing?: number; - - /** To group the series of stacking collection. - */ - stackingGroup?: string; - - /** Pattern of dashes and gaps used to stroke the line type series. - */ - dashArray?: string; - - /** Specifies the dataSource for the series. It can be an array of JSON objects or an instance of ej.DataManager. - * @Default {null} - */ - dataSource?: any; - - /** Controls the size of the hole in doughnut series. Value ranges from 0 to 1. - * @Default {0.4} - */ - doughnutCoefficient?: number; - - /** Controls the size of the doughnut series. Value ranges from 0 to 1. - * @Default {0.8} - */ - doughnutSize?: number; - - /** Type of series to be drawn in radar or polar series. - * @Default {line. See DrawType} - */ - drawType?: ej.datavisualization.Chart.DrawType|string; - - /** Enable/disable the animation of series. - * @Default {false} - */ - enableAnimation?: boolean; - - /** To avoid overlapping of data labels smartly. - * @Default {null} - */ - enableSmartLabels?: number; - - /** End angle of pie/doughnut series. For a complete circle, it has to be 360, by default. - * @Default {null} - */ - endAngle?: number; - - /** Explodes the pie/doughnut slices on mouse move. - * @Default {false} - */ - explode?: boolean; - - /** Explodes all the slice of pie/doughnut on render. - * @Default {null} - */ - explodeAll?: boolean; - - /** Index of the point to be exploded from pie/doughnut/pyramid/funnel. - * @Default {null} - */ - explodeIndex?: number; - - /** Specifies the distance of the slice from the center, when it is exploded. - * @Default {25} - */ - explodeOffset?: number; - - /** Fill color of the series. - * @Default {null} - */ - fill?: string; - - /** Options for customizing the series font. - */ - font?: SeriesFont; - - /** Specifies the height of the funnel in funnel series. Values can be in both pixel and percentage. - * @Default {32.7%} - */ - funnelHeight?: string; - - /** Specifies the width of the funnel in funnel series. Values can be in both pixel and percentage. - * @Default {11.6%} - */ - funnelWidth?: string; - - /** Gap between the slices of pyramid/funnel series. - * @Default {0} - */ - gapRatio?: number; - - /** Specifies whether to join start and end point of a line/area series used in polar/radar chart to form a closed path. - * @Default {true} - */ - isClosed?: boolean; - - /** Specifies whether to stack the column series in polar/radar charts. - * @Default {true} - */ - isStacking?: boolean; - - /** Renders the chart vertically. This is applicable only for Cartesian type series. - * @Default {false} - */ - isTransposed?: boolean; - - /** Render the x mark in the center of the box and whisker series type.x represents the average value of the box and whisker series. - * @Default {true} - */ - showMedian?: boolean; - - /** Position of the data label in pie/doughnut/pyramid/funnel series. OutsideExtended position is not applicable for pyramid/funnel. - * @Default {inside. See LabelPosition} - */ - labelPosition?: ej.datavisualization.Chart.LabelPosition|string; - - /** Quartile calculation has been performed in three different formulas to render the boxplot series . - * @Default {exclusive} - */ - boxPlotMode?: ej.datavisualization.Chart.LabelPosition|string; - - /** Specifies the line cap of the series. - * @Default {Butt. See LineCap} - */ - lineCap?: ej.datavisualization.Chart.LineCap|string; - - /** Specifies the type of shape to be used where two lines meet. - * @Default {Round. See LineJoin} - */ - lineJoin?: ej.datavisualization.Chart.LineJoin|string; - - /** Options for displaying and customizing marker for individual point in a series. Marker contains shapes and/or data labels. - */ - marker?: SeriesMarker; - - /** Name of the series, that is to be displayed in the legend. - * @Default {Add a comment to this line} - */ - name?: string; - - /** Opacity of the series. - * @Default {1} - */ - opacity?: number; - - /** Options for customizing the outlier of individual series. - */ - outlierSettings?: SeriesOutlierSettings; - - /** Name of a field in data source where fill color for all the data points is generated. - */ - palette?: string; - - /** Controls the size of pie series. Value ranges from 0 to 1. - * @Default {0.8} - */ - pieCoefficient?: number; - - /** Options for customizing the empty point in the series. - */ - emptyPointSettings?: SeriesEmptyPointSettings; - - /** Fill color for the positive column of the waterfall. - * @Default {null} - */ - positiveFill?: string; - - /** Options for customizing the waterfall connector line. - */ - connectorLine?: SeriesConnectorLine; - - /** Options to customize the drag and drop in series. - */ - dragSettings?: SeriesDragSettings; - - /** Options to customize the error bar in series. - */ - errorBar?: SeriesErrorBar; - - /** Option to add data points; each point should have x and y property. Also, optionally, you can customize the points color, border, marker by using fill, border and marker options. - */ - points?: SeriesPoint[]; - - /** Specifies the mode of the pyramid series. - * @Default {linear} - */ - pyramidMode?: ej.datavisualization.Chart.PyramidMode|string; - - /** Specifies ej.Query to select data from dataSource. This property is applicable only when the dataSource is ej.DataManager. - * @Default {null} - */ - query?: any; - - /** Start angle from where the pie/doughnut series renders. It starts from 0, by default. - * @Default {null} - */ - startAngle?: number; - - /** Options for customizing the corner radius. cornerRadius property also takes the numeric input and applies it for all the four corners of the column. - */ - cornerRadius?: SeriesCornerRadius; - - /** Options for customizing the tooltip of chart. - */ - tooltip?: SeriesTooltip; - - /** Specifies the type of the series to render in chart. - * @Default {column. see Type} - */ - type?: ej.datavisualization.Chart.Type|string; - - /** Controls the visibility of the series. - * @Default {visible} - */ - visibility?: string; - - /** Enables or disables the visibility of legend item. - * @Default {visible} - */ - visibleOnLegend?: string; - - /** Specifies the name of the x-axis that has to be associated with this series. Add an axis instance with this name to axes collection. - * @Default {null} - */ - xAxisName?: string; - - /** Name of the property in the datasource that contains x value for the series. - * @Default {null} - */ - xName?: string; - - /** Specifies the name of the y-axis that has to be associated with this series. Add an axis instance with this name to axes collection. - * @Default {null} - */ - yAxisName?: string; - - /** Name of the property in the datasource that contains y value for the series. - * @Default {null} - */ - yName?: string; - - /** Name of the property in the datasource that contains high value for the series. - * @Default {null} - */ - high?: string; - - /** Name of the property in the datasource that contains low value for the series. - * @Default {null} - */ - low?: string; - - /** Name of the property in the datasource that contains open value for the series. - * @Default {null} - */ - open?: string; - - /** Name of the property in the datasource that contains close value for the series. - * @Default {null} - */ - close?: string; - - /** Name of the property in the datasource that contains fill color for the series. - * @Default {null} - */ - pointColorMappingName?: string; - - /** Z-order of the series. - * @Default {0} - */ - zOrder?: number; - - /** Name of the property in the datasource that contains the size value for the bubble series. - * @Default {null} - */ - size?: string; - - /** Option to add trendlines to chart. - */ - trendlines?: SeriesTrendline[]; - - /** Options for customizing the appearance of the series or data point while highlighting. - */ - highlightSettings?: SeriesHighlightSettings; - - /** Options for customizing the appearance of the series/data point on selection. - */ - selectionSettings?: SeriesSelectionSettings; -} - -export interface Size { - - /** Height of the Chart. Height can be specified in either pixel or percentage. - * @Default {'450'} - */ - height?: string; - - /** Width of the Chart. Width can be specified in either pixel or percentage. - * @Default {'450'} - */ - width?: string; -} - -export interface TitleBorder { - - /** Width of the title border. - * @Default {1} - */ - width?: number; - - /** color of the title border. - * @Default {transparent} - */ - color?: string; - - /** opacity of the title border. - * @Default {0.8} - */ - opacity?: number; - - /** opacity of the title border. - * @Default {0.8} - */ - cornerRadius?: number; -} - -export interface TitleFont { - - /** Font family for Chart title. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style for Chart title. - * @Default {Normal. See FontStyle} - */ - fontStyle?: ej.datavisualization.Chart.FontStyle|string; - - /** Font weight for Chart title. - * @Default {Regular. See FontWeight} - */ - fontWeight?: ej.datavisualization.Chart.FontWeight|string; - - /** Opacity of the Chart title. - * @Default {0.5} - */ - opacity?: number; - - /** Font size for Chart title. - * @Default {20px} - */ - size?: string; -} - -export interface TitleSubTitleFont { - - /** Font family of sub title. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style for sub title. - * @Default {Normal. See FontStyle} - */ - fontStyle?: ej.datavisualization.Chart.FontStyle|string; - - /** Font weight for sub title. - * @Default {Regular. See FontWeight} - */ - fontWeight?: ej.datavisualization.Chart.FontWeight|string; - - /** Opacity of the sub title. - * @Default {1} - */ - opacity?: number; - - /** Font size for sub title. - * @Default {12px} - */ - size?: string; -} - -export interface TitleSubTitleBorder { - - /** Width of the subtitle border. - * @Default {1} - */ - width?: number; - - /** color of the subtitle border. - * @Default {transparent} - */ - color?: string; - - /** opacity of the subtitle border. - * @Default {0.8} - */ - opacity?: number; - - /** opacity of the subtitle border. - * @Default {0.8} - */ - cornerRadius?: number; -} - -export interface TitleSubTitle { - - /** Options for customizing the font of sub title. - */ - font?: TitleSubTitleFont; - - /** Background color for the chart subtitle. - * @Default {transparent} - */ - background?: string; - - /** Options to customize the border of the title. - */ - border?: TitleSubTitleBorder; - - /** Text to be displayed in sub title. - */ - text?: string; - - /** Alignment of sub title text. - * @Default {far. See TextAlignment} - */ - textAlignment?: ej.datavisualization.Chart.Alignment|string; -} - -export interface Title { - - /** Background color for the chart title. - * @Default {transparent} - */ - background?: string; - - /** Options to customize the border of the title. - */ - border?: TitleBorder; - - /** Options for customizing the font of Chart title. - */ - font?: TitleFont; - - /** Options to customize the sub title of Chart. - */ - subTitle?: TitleSubTitle; - - /** Text to be displayed in Chart title. - */ - text?: string; - - /** Alignment of the title text. - * @Default {Center. See TextAlignment} - */ - textAlignment?: ej.datavisualization.Chart.Alignment|string; -} - -export interface Zooming { - - /** Enables or disables zooming. - * @Default {false} - */ - enable?: boolean; - - /** Enables or disables pinch zooming. - * @Default {true} - */ - enablePinching?: boolean; - - /** Enable or disables the differed zooming. When it is enabled, chart is updated only on mouse up action while zooming and panning. - * @Default {false} - */ - enableDeferredZoom?: boolean; - - /** Enables/disables the ability to zoom the chart on moving the mouse wheel. - * @Default {false} - */ - enableMouseWheel?: boolean; - - /** Specifies whether to allow zooming the chart vertically or horizontally or in both ways. - * @Default {'x,y'} - */ - type?: string; - - /** Toggles the visibility of the scrollbar, which will be displayed while zooming. - * @Default {false} - */ - enableScrollbar?: boolean; - - /** To display user specified buttons in zooming toolbar. - * @Default {[zoomIn, zoomOut, zoom, pan, reset]} - */ - toolbarItems?: any[]; -} -} -namespace Chart { -enum CoordinateUnit { -//string -None, -//string -Pixels, -//string -Points, -} -} -namespace Chart { -enum HorizontalAlignment { -//string -Left, -//string -Right, -//string -Middle, -} -} -namespace Chart { -enum Region { -//string -Chart, -//string -Series, -} -} -namespace Chart { -enum VerticalAlignment { -//string -Top, -//string -Bottom, -//string -Middle, -} -} -namespace Chart { -enum ExportingType { -//string -PNG, -//string -JPG, -//string -PDF, -//string -DOCX, -//string -XLSX, -//string -SVG, -} -} -namespace Chart { -enum ExportingOrientation { -//string -Portrait, -//string -Landscape, -} -} -namespace Chart { -enum ExportingMode { -//string -ServerSide, -//string -ClientSide, -} -} -namespace Chart { -enum Unit { -//string -Percentage, -//string -Pixel, -} -} -namespace Chart { -enum ColumnFacet { -//string -Rectangle, -//string -Cylinder, -} -} -namespace Chart { -enum DrawType { -//string -Line, -//string -Area, -//string -Column, -} -} -namespace Chart { -enum FontStyle { -//string -Normal, -//string -Italic, -} -} -namespace Chart { -enum FontWeight { -//string -Regular, -//string -Bold, -//string -Lighter, -} -} -namespace Chart { -enum LabelPosition { -//string -Inside, -//string -Outside, -//string -OutsideExtended, -} -} -namespace Chart { -enum boxPlotMode { -//string -Exclusive, -//string -Inclusive, -//string -Normal, -} -} -namespace Chart { -enum LineCap { -//string -Butt, -//string -Round, -//string -Square, -} -} -namespace Chart { -enum LineJoin { -//string -Round, -//string -Bevel, -//string -Miter, -} -} -namespace Chart { -enum ConnectorLineType { -//string -Line, -//string -Bezier, -} -} -namespace Chart { -enum HorizontalTextAlignment { -//string -Center, -//string -Near, -//string -Far, -} -} -namespace Chart { -enum Shape { -//string -None, -//string -LeftArrow, -//string -RightArrow, -//string -Circle, -//string -Cross, -//string -HorizLine, -//string -VertLine, -//string -Diamond, -//string -Rectangle, -//string -Triangle, -//string -Hexagon, -//string -Pentagon, -//string -Star, -//string -Ellipse, -//string -Trapezoid, -//string -UpArrow, -//string -DownArrow, -//string -Image, -//string -SeriesType, -} -} -namespace Chart { -enum TextPosition { -//string -Top, -//string -Bottom, -//string -Middle, -} -} -namespace Chart { -enum VerticalTextAlignment { -//string -Center, -//string -Near, -//string -Far, -} -} -namespace Chart { -enum PyramidMode { -//string -Linear, -//string -Surface, -} -} -namespace Chart { -enum Type { -//string -Area, -//string -Line, -//string -Spline, -//string -Column, -//string -Scatter, -//string -Bubble, -//string -SplineArea, -//string -StepArea, -//string -StepLine, -//string -Pie, -//string -HiLo, -//string -HiLoOpenClose, -//string -Candle, -//string -Bar, -//string -StackingArea, -//string -StackingArea100, -//string -RangeColumn, -//string -StackingColumn, -//string -StackingColumn100, -//string -StackingBar, -//string -StackingBar100, -//string -Pyramid, -//string -Funnel, -//string -Doughnut, -//string -Polar, -//string -Radar, -//string -RangeArea, -} -} -namespace Chart { -enum EmptyPointMode { -//string -Gap, -//string -Zero, -//string -Average, -} -} -namespace Chart { -enum ErrorBarType { -//string -FixedValue, -//string -Percentage, -//string -StandardDeviation, -//string -StandardError, -} -} -namespace Chart { -enum ErrorBarMode { -//string -Both, -//string -Vertical, -//string -Horizontal, -} -} -namespace Chart { -enum ErrorBarDirection { -//string -Both, -//string -Plus, -//string -Minus, -} -} -namespace Chart { -enum Mode { -//string -Series, -//string -Point, -//string -Cluster, -//string -Range, -} -} -namespace Chart { -enum SelectionType { -//string -Single, -//string -Multiple, -} -} -namespace Chart { -enum RangeType { -//string -XY, -//string -X, -//string -Y, -} -} -namespace Chart { -enum CrosshairMode { -//string -Float, -//string -Grouping, -} -} -namespace Chart { -enum CrosshairType { -//string -Crosshair, -//string -Trackball, -} -} -namespace Chart { -enum Alignment { -//string -Center, -//string -Near, -//string -Far, -} -} -namespace Chart { -enum Position { -//string -Left, -//string -Right, -//string -Top, -//string -Bottom, -} -} -namespace Chart { -enum TextOverflow { -//string -None, -//string -Trim, -//string -Wrap, -//string -WrapAndTrim, -} -} -namespace Chart { -enum LabelPlacement { -//string -OnTicks, -//string -BetweenTicks, -} -} -namespace Chart { -enum EdgeLabelPlacement { -//string -None, -//string -Shift, -//string -Hide, -} -} -namespace Chart { -enum IntervalType { -//string -Days, -//string -Hours, -//string -Seconds, -//string -Milliseconds, -//string -Minutes, -//string -Months, -//string -Years, -} -} -namespace Chart { -enum LabelIntersectAction { -//string -None, -//string -Rotate90, -//string -Rotate45, -//string -Wrap, -//string -WrapByword, -//string -Trim, -//string -Hide, -//string -MultipleRows, -} -} -namespace Chart { -enum LabelAlignment { -//string -Near, -//string -Far, -//string -Center, -} -} -namespace Chart { -enum RangePadding { -//string -Additional, -//string -Normal, -//string -None, -//string -Round, -} -} -namespace Chart { -enum MultiLevelLabelsBorderType { -//string -Rectangle, -//string -None, -//string -WithoutTopAndBottom, -//string -Brace, -//string -CurlyBrace, -} -} -namespace Chart { -enum TextAlignment { -//string -MiddleTop, -//string -MiddleCenter, -//string -MiddleBottom, -} -} -namespace Chart { -enum ZIndex { -//string -Inside, -//string -Over, -} -} -namespace Chart { -enum TickLinesPosition { -//string -Inside, -//string -Outside, -} -} -namespace Chart { -enum ValueType { -//string -Double, -//string -Category, -//string -DateTime, -//string -Logarithmic, -} -} -namespace Chart { -enum Theme { -//string -Azure, -//string -FlatLight, -//string -FlatDark, -//string -Azuredark, -//string -Lime, -//string -LimeDark, -//string -Saffron, -//string -SaffronDark, -//string -GradientLight, -//string -GradientDark, -} -} - -class RangeNavigator extends ej.Widget { - static fn: RangeNavigator; - constructor(element: JQuery | Element, options?: RangeNavigator.Model); - static Locale: any; - model: RangeNavigator.Model; - defaults: RangeNavigator.Model; - - /** destroy the range navigator widget - * @returns {void} - */ - _destroy(): void; -} -export namespace RangeNavigator { - -export interface Model { - - /** Toggles the placement of slider exactly on the place it left or on the nearest interval. - * @Default {false} - */ - allowSnapping?: boolean; - - /** Options for customizing the color, opacity and width of the chart border. - */ - border?: Border; - - /** Specifies the data source for range navigator. - */ - dataSource?: any; - - /** Specifies the properties used for customizing the range series. - */ - series?: Series[]; - - /** Toggles the redrawing of chart on moving the sliders. - * @Default {true} - */ - enableDeferredUpdate?: boolean; - - /** Enable the scrollbar option in the rangenavigator. - * @Default {false} - */ - enableScrollbar?: boolean; - - /** Toggles the direction of rendering the range navigator control. - * @Default {false} - */ - enableRTL?: boolean; - - /** Sets a value whether to make the range navigator responsive on resize. - * @Default {false} - */ - isResponsive?: boolean; - - /** Options for customizing the labels colors, font, style, size, horizontalAlignment and opacity. - */ - labelSettings?: LabelSettings; - - /** This property is to specify the localization of range navigator. - * @Default {en-US} - */ - locale?: string; - - /** Options for customizing the range navigator. - */ - navigatorStyleSettings?: NavigatorStyleSettings; - - /** Padding specifies the gap between the container and the range navigator. - * @Default {0} - */ - padding?: string; - - /** If the range is not given explicitly, range will be calculated automatically. - * @Default {none} - */ - rangePadding?: ej.datavisualization.RangeNavigator.RangePadding|string; - - /** Options for customizing the starting and ending ranges. - */ - rangeSettings?: RangeSettings; - - /** selectedData is for getting the data when the "rangeChanged" event trigger from client side. - */ - selectedData?: any; - - /** Options for customizing the start and end range values. - */ - selectedRangeSettings?: SelectedRangeSettings; - - /** Options for rendering scrollbar based on the start and end range values. - */ - scrollRangeSettings?: ScrollRangeSettings; - - /** Contains property to customize the hight and width of range navigator. - */ - sizeSettings?: SizeSettings; - - /** By specifying this property the user can change the theme of the range navigator. - * @Default {null} - */ - theme?: string; - - /** Options for customizing the tooltip in range navigator. - */ - tooltipSettings?: TooltipSettings; + /** returns the name of the event + */ + type?: string; + } + + export interface ScrollEndEventArgs { + + /** parameters from RangeNavigator + */ + data?: any; + + /** returns the scrollbar position old start and end range value on change end of scrollbar + */ + dataoldRange?: any; + + /** returns the scrollbar position new start and end range value on change end of scrollbar + */ + datanewRange?: any; + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the RangeNavigator model + */ + model?: any; + + /** returns the name of the event + */ + type?: string; + } + + export interface AnnotationsMargin { + + /** Annotation is placed at the specified value above its original position. + * @Default {0} + */ + bottom?: number; + + /** Annotation is placed at the specified value from left side of its original position. + * @Default {0} + */ + left?: number; + + /** Annotation is placed at the specified value from the right side of its original position. + * @Default {0} + */ + right?: number; + + /** Annotation is placed at the specified value under its original position. + * @Default {0} + */ + top?: number; + } + + export interface Annotation { + + /** Angle to rotate the annotation in degrees. + * @Default {'0'} + */ + angle?: number; + + /** Text content or id of a HTML element to be displayed as annotation. + */ + content?: string; + + /** Specifies how annotations have to be placed in Chart. + * @Default {none. See CoordinateUnit} + */ + coordinateUnit?: ej.datavisualization.Chart.CoordinateUnit | string; + + /** Specifies the horizontal alignment of the annotation. + * @Default {middle. See HorizontalAlignment} + */ + horizontalAlignment?: ej.datavisualization.Chart.HorizontalAlignment | string; + + /** Options to customize the margin of annotation. + */ + margin?: AnnotationsMargin; + + /** Controls the opacity of the annotation. + * @Default {1} + */ + opacity?: number; + + /** Specifies whether annotation has to be placed with respect to chart or series. + * @Default {chart. See Region} + */ + region?: ej.datavisualization.Chart.Region | string; + + /** Specifies the vertical alignment of the annotation. + * @Default {middle. See VerticalAlignment} + */ + verticalAlignment?: ej.datavisualization.Chart.VerticalAlignment | string; + + /** Controls the visibility of the annotation. + * @Default {false} + */ + visible?: boolean; + + /** Represents the horizontal offset when coordinateUnit is pixels.when coordinateUnit is points, it represents the x-coordinate of axis bounded with xAxisName property + * or primary X axis when xAxisName is not provided.This property is not applicable when coordinateUnit is none. + * @Default {0} + */ + x?: number; + + /** Name of the horizontal axis to be used for positioning the annotation. This property is applicable only when coordinateUnit is points. + */ + xAxisName?: string; + + /** Represents the vertical offset when coordinateUnit is pixels.When coordinateUnit is points, it represents the y-coordinate of axis bounded with + * yAxisName property or primary Y axis when yAxisName is not provided.This property is not applicable when coordinateUnit is none. + * @Default {0} + */ + y?: number; + + /** Name of the vertical axis to be used for positioning the annotation.This property is applicable only when coordinateUnit is points. + */ + yAxisName?: string; + } + + export interface Border { + + /** Border color of the chart. + * @Default {null} + */ + color?: string; + + /** Opacity of the chart border. + * @Default {0.3} + */ + opacity?: number; + + /** Width of the Chart border. + * @Default {0} + */ + width?: number; + } + + export interface ExportSettings { + + /** Specifies the downloading filename + * @Default {chart} + */ + filename?: string; + + /** Specifies the name of the action URL + */ + action?: string; + + /** Specifies the angle for rotation + * @Default {0} + */ + angle?: number; + + /** Specifies the format of the file to export + * @Default {png} + */ + type?: ej.datavisualization.Chart.ExportingType | string; + + /** Specifies the orientation of the document + * @Default {portrait} + */ + orientation?: ej.datavisualization.Chart.ExportingOrientation | string; + + /** Specifies the mode of exporting + * @Default {client} + */ + mode?: ej.datavisualization.Chart.ExportingMode | string; + + /** Enable/ disable the multiple excel exporting + * @Default {false} + */ + multipleExport?: boolean; + } + + export interface ChartAreaBorder { + + /** Border color of the plot area. + * @Default {Gray} + */ + color?: string; + + /** Opacity of the plot area border. + * @Default {0.3} + */ + opacity?: number; + + /** Border width of the plot area. + * @Default {0.5} + */ + width?: number; + } + + export interface ChartArea { + + /** Background color of the plot area. + * @Default {transparent} + */ + background?: string; + + /** Options for customizing the border of the plot area. + */ + border?: ChartAreaBorder; + } + + export interface ColumnDefinition { + + /** Specifies the unit to measure the width of the column in plotting area. + * @Default {'pixel'. See Unit} + */ + unit?: ej.datavisualization.Chart.Unit | string; + + /** Width of the column in plotting area. Width is measured in either pixel or percentage based on the value of unit property. + * @Default {50} + */ + columnWidth?: number; + + /** Color of the line that indicates the starting point of the column in plotting area. + * @Default {transparent} + */ + lineColor?: string; + + /** Width of the line that indicates the starting point of the column in plot area. + * @Default {1} + */ + lineWidth?: number; + } + + export interface CommonSeriesOptionsBorder { + + /** Border color of all series. + * @Default {transparent} + */ + color?: string; + + /** DashArray for border of the series. + * @Default {null} + */ + dashArray?: string; + + /** Border width of all series. + * @Default {1} + */ + width?: number; + } + + export interface CommonSeriesOptionsFont { + + /** Font color of the text in all series. + * @Default {#707070} + */ + color?: string; + + /** Font Family for all the series. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Specifies the font Style for all the series. + * @Default {normal} + */ + fontStyle?: ej.datavisualization.Chart.FontStyle | string; + + /** Specifies the font weight for all the series. + * @Default {regular} + */ + fontWeight?: ej.datavisualization.Chart.FontWeight | string; + + /** Opacity for text in all the series. + * @Default {1} + */ + opacity?: number; + + /** Font size for text in all the series. + * @Default {12px} + */ + size?: string; + } + + export interface CommonSeriesOptionsMarkerBorder { + + /** Border color of the marker shape. + * @Default {white} + */ + color?: string; + + /** Border width of the marker shape. + * @Default {3} + */ + width?: number; + } + + export interface CommonSeriesOptionsMarkerDataLabelBorder { + + /** Border color of the data label. + * @Default {null} + */ + color?: string; + + /** Border width of the data label. + * @Default {0.1} + */ + width?: number; + } + + export interface CommonSeriesOptionsMarkerDataLabelConnectorLine { + + /** Specifies when the connector has to be drawn as Bezier curve or straight line. This is applicable only for Pie and Doughnut chart types. + * @Default {line. See ConnectorLineType} + */ + type?: ej.datavisualization.Chart.ConnectorLineType | string; + + /** Width of the connector. + * @Default {0.5} + */ + width?: number; + + /** Color of the connector line. + * @Default {#565656} + */ + color?: string; + + /** Height of the connector line. + * @Default {null} + */ + height?: string; + } + + export interface CommonSeriesOptionsMarkerDataLabelFont { + + /** Font family of the data label. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style of the data label. + * @Default {normal. See FontStyle} + */ + fontStyle?: ej.datavisualization.Chart.FontStyle | string; + + /** Font weight of the data label. + * @Default {regular. See FontWeight} + */ + fontWeight?: ej.datavisualization.Chart.FontWeight | string; + + /** Opacity of the text. + * @Default {1} + */ + opacity?: number; + + /** Font color of the data label text. + * @Default {null} + */ + color?: string; + + /** Font size of the data label. + * @Default {12px} + */ + size?: string; + } + + export interface CommonSeriesOptionsMarkerDataLabelMargin { + + /** Bottom margin of the text. + * @Default {5} + */ + bottom?: number; + + /** Left margin of the text. + * @Default {5} + */ + left?: number; + + /** Right margin of the text. + * @Default {5} + */ + right?: number; + + /** Top margin of the text. + * @Default {5} + */ + top?: number; + } + + export interface CommonSeriesOptionsMarkerDataLabel { + + /** Angle of the data label in degrees. Only the text gets rotated, whereas the background and border does not rotate. + * @Default {null} + */ + angle?: number; + + /** Maximum label width of the data label. + * @Default {null} + */ + maximumLabelWidth?: number; + + /** Enable the wrap option to the data label. + * @Default {false} + */ + enableWrap?: boolean; + + /** Options for customizing the border of the data label. + */ + border?: CommonSeriesOptionsMarkerDataLabelBorder; + + /** Options for displaying and customizing the line that connects point and data label. + */ + connectorLine?: CommonSeriesOptionsMarkerDataLabelConnectorLine; + + /** Background color of the data label. + * @Default {null} + */ + fill?: string; + + /** Options for customizing the data label font. + */ + font?: CommonSeriesOptionsMarkerDataLabelFont; + + /** Horizontal alignment of the data label. + * @Default {center} + */ + horizontalTextAlignment?: ej.datavisualization.Chart.HorizontalTextAlignment | string; + + /** Margin of the text to its background shape. The size of the background shape increases based on the margin applied to its text. + */ + margin?: CommonSeriesOptionsMarkerDataLabelMargin; + + /** Opacity of the data label. + * @Default {1} + */ + opacity?: number; + + /** Background shape of the data label. + * @Default {none. See Shape} + */ + shape?: ej.datavisualization.Chart.Shape | string; + + /** Custom template to format the data label content. Use Ă¢â‚¬Å“point.xĂ¢â‚¬Â and Ă¢â‚¬Å“point.yĂ¢â‚¬Â as a placeholder text to display the corresponding data pointĂ¢â‚¬â„¢s x and y value. + */ + template?: string; + + /** Name of a field in data source, where datalabel text is displayed. + */ + textMappingName?: string; + + /** Specifies the position of the data label. This property can be used only for the series such as column, bar, stacked column, stacked bar, 100% stacked column, 100% stacked bar, candle and OHLC. + * @Default {top. See TextPosition} + */ + textPosition?: ej.datavisualization.Chart.TextPosition | string; + + /** Vertical alignment of the data label. + * @Default {center} + */ + verticalTextAlignment?: ej.datavisualization.Chart.VerticalTextAlignment | string; + + /** Controls the visibility of the data labels. + * @Default {false} + */ + visible?: boolean; + } + + export interface CommonSeriesOptionsMarkerSize { + + /** Height of the marker. + * @Default {6} + */ + height?: number; + + /** Width of the marker. + * @Default {6} + */ + width?: number; + } + + export interface CommonSeriesOptionsMarker { + + /** Options for customizing the border of the marker shape. + */ + border?: CommonSeriesOptionsMarkerBorder; + + /** Options for displaying and customizing data labels. + */ + dataLabel?: CommonSeriesOptionsMarkerDataLabel; + + /** Color of the marker shape. + * @Default {null} + */ + fill?: string; + + /** The URL for the Image to be displayed as marker. In order to display image as marker, set series.marker.shape as Ă¢â‚¬ËœimageĂ¢â‚¬â„¢. + */ + imageUrl?: string; + + /** Opacity of the marker. + * @Default {1} + */ + opacity?: number; + + /** Specifies the shape of the marker. + * @Default {circle. See Shape} + */ + shape?: ej.datavisualization.Chart.Shape | string; + + /** Options for customizing the size of the marker shape. + */ + size?: CommonSeriesOptionsMarkerSize; + + /** Controls the visibility of the marker shape. + * @Default {false} + */ + visible?: boolean; + } + + export interface CommonSeriesOptionsOutlierSettingsSize { + + /** Height of the outlier shape. + * @Default {6} + */ + height?: number; + + /** Width of the outlier shape. + * @Default {6} + */ + width?: number; + } + + export interface CommonSeriesOptionsOutlierSettings { + + /** Specifies the shape of the outlier. + * @Default {circle. See Shape} + */ + shape?: ej.datavisualization.Chart.Shape | string; + + /** Options for customizing the size of the outlier shape. + */ + size?: CommonSeriesOptionsOutlierSettingsSize; + } + + export interface CommonSeriesOptionsCornerRadius { + + /** Specifies the radius for the top left corner. + * @Default {0} + */ + topLeft?: number; + + /** Specifies the radius for the top right corner. + * @Default {0} + */ + topRight?: number; + + /** Specifies the radius for the bottom left corner. + * @Default {0} + */ + bottomLeft?: number; + + /** Specifies the radius for the bottom right corner. + * @Default {0} + */ + bottomRight?: number; + } + + export interface CommonSeriesOptionsTooltipBorder { + + /** Border color of the tooltip. + * @Default {null} + */ + color?: string; + + /** Border width of the tooltip. + * @Default {1} + */ + width?: number; + } + + export interface CommonSeriesOptionsTooltip { + + /** Options for customizing the border of the tooltip. + */ + border?: CommonSeriesOptionsTooltipBorder; + + /** Customize the corner radius of the tooltip rectangle. + * @Default {0} + */ + rx?: number; + + /** Customize the corner radius of the tooltip rectangle. + * @Default {0} + */ + ry?: number; + + /** Specifies the duration, the tooltip has to be displayed. + * @Default {500ms} + */ + duration?: string; + + /** Enables/disables the animation of the tooltip when moving from one point to other. + * @Default {true} + */ + enableAnimation?: boolean; + + /** Background color of the tooltip. + * @Default {null} + */ + fill?: string; + + /** Format of the tooltip content. + * @Default {#point.x# : #point.y#} + */ + format?: string; + + /** Opacity of the tooltip. + * @Default {0.5} + */ + opacity?: number; + + /** Custom template to format the tooltip content. Use Ă¢â‚¬Å“point.xĂ¢â‚¬Â and Ă¢â‚¬Å“point.yĂ¢â‚¬Â as a placeholder text to display the corresponding data pointĂ¢â‚¬â„¢s x and y value. + * @Default {null} + */ + template?: string; + + /** Controls the visibility of the tooltip. + * @Default {false} + */ + visible?: boolean; + } + + export interface CommonSeriesOptionsEmptyPointSettingsStyleBorder { + + /** Border color of the empty point. + */ + color?: string; + + /** Border width of the empty point. + * @Default {1} + */ + width?: number; + } + + export interface CommonSeriesOptionsEmptyPointSettingsStyle { + + /** Color of the empty point. + */ + color?: string; + + /** Options for customizing border of the empty point in the series. + */ + border?: CommonSeriesOptionsEmptyPointSettingsStyleBorder; + } + + export interface CommonSeriesOptionsEmptyPointSettings { + + /** Controls the visibility of the empty point. + * @Default {true} + */ + visible?: boolean; + + /** Specifies the mode of empty point. + * @Default {gap} + */ + displayMode?: ej.datavisualization.Chart.EmptyPointMode | string; + + /** Options for customizing the color and border of the empty point in the series. + */ + style?: CommonSeriesOptionsEmptyPointSettingsStyle; + } + + export interface CommonSeriesOptionsConnectorLine { + + /** Width of the connector line. + * @Default {1} + */ + width?: number; + + /** Color of the connector line. + * @Default {#565656} + */ + color?: string; + + /** DashArray of the connector line. + * @Default {null} + */ + dashArray?: string; + + /** DashArray of the connector line. + * @Default {1} + */ + opacity?: number; + } + + export interface CommonSeriesOptionsDragSettings { + + /** drag/drop the series + * @Default {false} + */ + enable?: boolean; + + /** Specifies the type of drag settings. + * @Default {xy} + */ + type?: string; + } + + export interface CommonSeriesOptionsErrorBarCap { + + /** Show/Hides the error bar cap. + * @Default {true} + */ + visible?: boolean; + + /** Width of the error bar cap. + * @Default {1} + */ + width?: number; + + /** Length of the error bar cap. + * @Default {1} + */ + length?: number; + + /** Color of the error bar cap. + * @Default {Ă¢â‚¬Å“#000000Ă¢â‚¬Â} + */ + fill?: string; + } + + export interface CommonSeriesOptionsErrorBar { + + /** Show/hides the error bar + * @Default {visible} + */ + visibility?: boolean; + + /** Specifies the type of error bar. + * @Default {FixedValue} + */ + type?: ej.datavisualization.Chart.ErrorBarType | string; + + /** Specifies the mode of error bar. + * @Default {vertical} + */ + mode?: ej.datavisualization.Chart.ErrorBarMode | string; + + /** Specifies the direction of error bar. + * @Default {both} + */ + direction?: ej.datavisualization.Chart.ErrorBarDirection | string; + + /** Value of vertical error bar. + * @Default {3} + */ + verticalErrorValue?: number; + + /** Value of horizontal error bar. + * @Default {1} + */ + horizontalErrorValue?: number; + + /** Value of positive horizontal error bar. + * @Default {1} + */ + horizontalPositiveErrorValue?: number; + + /** Value of negative horizontal error bar. + * @Default {1} + */ + horizontalNegativeErrorValue?: number; + + /** Value of positive vertical error bar. + * @Default {5} + */ + verticalPositiveErrorValue?: number; + + /** Value of negative vertical error bar. + * @Default {5} + */ + verticalNegativeErrorValue?: number; + + /** Fill color of the error bar. + * @Default {#000000} + */ + fill?: string; + + /** Width of the error bar. + * @Default {1} + */ + width?: number; + + /** Options for customizing the error bar cap. + */ + cap?: CommonSeriesOptionsErrorBarCap; + } + + export interface CommonSeriesOptionsTrendline { + + /** Show/hides the trendline. + */ + visibility?: boolean; + + /** Specifies the type of the trendline for the series. + * @Default {linear. See TrendlinesType} + */ + type?: string; + + /** Name for the trendlines that is to be displayed in the legend text. + * @Default {trendline} + */ + name?: string; + + /** Fill color of the trendlines. + * @Default {#0000FF} + */ + fill?: string; + + /** Width of the trendlines. + * @Default {1} + */ + width?: number; + + /** Opacity of the trendline. + * @Default {1} + */ + opacity?: number; + + /** Pattern of dashes and gaps used to stroke the trendline. + */ + dashArray?: string; + + /** Future trends of the current series. + * @Default {0} + */ + forwardForecast?: number; + + /** Past trends of the current series. + * @Default {0} + */ + backwardForecast?: number; + + /** Specifies the order of the polynomial trendlines. + * @Default {0} + */ + polynomialOrder?: number; + + /** Specifies the moving average starting period value. + * @Default {2} + */ + period?: number; + } + + export interface CommonSeriesOptionsHighlightSettingsBorder { + + /** Border color of the series/point on highlight. + */ + color?: string; + + /** Border width of the series/point on highlight. + * @Default {2} + */ + width?: string; + } + + export interface CommonSeriesOptionsHighlightSettings { + + /** Enables/disables the ability to highlight the series or data point interactively. + * @Default {false} + */ + enable?: boolean; + + /** Specifies whether the series or data point has to be highlighted. + * @Default {series. See Mode} + */ + mode?: ej.datavisualization.Chart.Mode | string; + + /** Color of the series/point on highlight. + */ + color?: string; + + /** Opacity of the series/point on highlight. + * @Default {0.6} + */ + opacity?: number; + + /** Options for customizing the border of series on highlight. + */ + border?: CommonSeriesOptionsHighlightSettingsBorder; + + /** Specifies the pattern for the series/point on highlight. + * @Default {none. See Pattern} + */ + pattern?: string; + + /** Custom pattern for the series on highlight. + */ + customPattern?: string; + } + + export interface CommonSeriesOptionsSelectionSettingsBorder { + + /** Border color of the series/point on selection. + */ + color?: string; + + /** Border width of the series/point on selection. + * @Default {2} + */ + width?: string; + } + + export interface CommonSeriesOptionsSelectionSettings { + + /** Enables/disables the ability to select a series/data point interactively. + * @Default {false} + */ + enable?: boolean; + + /** Specifies the type of selection. + * @Default {single} + */ + type?: ej.datavisualization.Chart.SelectionType | string; + + /** Specifies whether the series or data point has to be selected. + * @Default {series. See Mode} + */ + mode?: ej.datavisualization.Chart.Mode | string; + + /** Specifies the drawn rectangle type. + * @Default {xy} + */ + rangeType?: ej.datavisualization.Chart.RangeType | string; + + /** Color of the series/point on selection. + */ + color?: string; + + /** Opacity of the series/point on selection. + * @Default {0.6} + */ + opacity?: number; + + /** Options for customizing the border of the series on selection. + */ + border?: CommonSeriesOptionsSelectionSettingsBorder; + + /** Specifies the pattern for the series/point on selection. + * @Default {none. See Pattern} + */ + pattern?: string; + + /** Custom pattern for the series on selection. + */ + customPattern?: string; + } + + export interface CommonSeriesOptions { + + /** Options to customize the border of all the series. + */ + border?: CommonSeriesOptionsBorder; + + /** To render the column and bar type series in rectangle/cylinder shape. See ColumnFacet + * @Default {rectangle} + */ + columnFacet?: ej.datavisualization.Chart.ColumnFacet | string; + + /** Relative width of the columns in column type series. Value ranges from 0 to 1. Width also depends upon columnSpacing property. + * @Default {0.7} + */ + columnWidth?: number; + + /** Spacing between columns of different series. Value ranges from 0 to 1 + * @Default {0} + */ + columnSpacing?: number; + + /** Enables or disables the visibility of legend item. + * @Default {visible} + */ + visibleOnLegend?: string; + + /** Group of the stacking collection series. + */ + stackingGroup?: string; + + /** Pattern of dashes and gaps used to stroke all the line type series. + */ + dashArray?: string; + + /** Set the dataSource for all series. It can be an array of JSON objects or an instance of ej.DataManager. + * @Default {null} + */ + dataSource?: any; + + /** Controls the size of the hole in doughnut series. Value ranges from 0 to 1 + * @Default {0.4} + */ + doughnutCoefficient?: number; + + /** Controls the size of the doughnut series. Value ranges from 0 to 1. + * @Default {0.8} + */ + doughnutSize?: number; + + /** Specifies the type of series to be drawn in radar or polar series. + * @Default {line. See DrawType} + */ + drawType?: ej.datavisualization.Chart.DrawType | string; + + /** Enable/disable the animation for all the series. + * @Default {true} + */ + enableAnimation?: boolean; + + /** To avoid overlapping of data labels smartly. + * @Default {true} + */ + enableSmartLabels?: boolean; + + /** Start angle of pie/doughnut series. + * @Default {null} + */ + endAngle?: number; + + /** Explodes the pie/doughnut slices on mouse move. + * @Default {false} + */ + explode?: boolean; + + /** Explodes all the slice of pie/doughnut on render. + * @Default {false} + */ + explodeAll?: boolean; + + /** Index of the point to be exploded from pie/doughnut/pyramid/funnel. + * @Default {null} + */ + explodeIndex?: number; + + /** Specifies the distance of the slice from the center, when it is exploded. + * @Default {0.4} + */ + explodeOffset?: number; + + /** Fill color for all the series. + * @Default {null} + */ + fill?: string; + + /** Options for customizing the font of all the series. + */ + font?: CommonSeriesOptionsFont; + + /** Sets the height of the funnel in funnel series. Values can be either pixel or percentage. + * @Default {32.7%} + */ + funnelHeight?: string; + + /** Sets the width of the funnel in funnel series. Values can be either pixel or percentage. + * @Default {11.6%} + */ + funnelWidth?: string; + + /** Gap between the slices in pyramid and funnel series. + * @Default {0} + */ + gapRatio?: number; + + /** Specifies whether to join start and end point of a line/area series used in polar/radar chart to form a closed path. + * @Default {true} + */ + isClosed?: boolean; + + /** Specifies whether to stack the column series in polar/radar charts. + * @Default {false} + */ + isStacking?: boolean; + + /** Renders the chart vertically. This is applicable only for Cartesian type series. + * @Default {false} + */ + isTransposed?: boolean; + + /** Render the x mark in the center of the box and whisker series type.x represents the average value of the box and whisker series. + * @Default {true} + */ + showMedian?: boolean; + + /** Position of the data label in pie/doughnut/pyramid/funnel series. OutsideExtended position is not applicable for pyramid/funnel. + * @Default {inside. See LabelPosition} + */ + labelPosition?: ej.datavisualization.Chart.LabelPosition | string; + + /** Quartile calculation has been performed in three different formulas to render the box and whisker series. + * @Default {exclusive} + */ + boxPlotMode?: ej.datavisualization.Chart.boxPlotMode | string; + + /** Specifies the line cap of the series. + * @Default {butt. See LineCap} + */ + lineCap?: ej.datavisualization.Chart.LineCap | string; + + /** Specifies the type of shape to be used where two lines meet. + * @Default {round. See LineJoin} + */ + lineJoin?: ej.datavisualization.Chart.LineJoin | string; + + /** Options for displaying and customizing marker for individual point in a series. Marker contains shapes and/or data labels. + */ + marker?: CommonSeriesOptionsMarker; + + /** Opacity of the series. + * @Default {1} + */ + opacity?: number; + + /** Options for customizing the outlier of the series. + */ + outlierSettings?: CommonSeriesOptionsOutlierSettings; + + /** Name of a field in data source, where the fill color for all the data points is generated. + */ + palette?: string; + + /** Controls the size of pie series. Value ranges from 0 to 1. + * @Default {0.8} + */ + pieCoefficient?: number; + + /** Name of the property in the datasource that contains fill color for the series. + * @Default {null} + */ + pointColorMappingName?: string; + + /** Specifies the mode of the pyramid series. + * @Default {linear. See PyramidMode} + */ + pyramidMode?: ej.datavisualization.Chart.PyramidMode | string; + + /** Start angle from where the pie/doughnut series renders. By default it starts from 0. + * @Default {null} + */ + startAngle?: number; + + /** Options for customizing the corner radius. cornerRadius property also takes the numeric input and applies it for all the four corners of the column. + */ + cornerRadius?: CommonSeriesOptionsCornerRadius; + + /** Options for customizing the tooltip of chart. + */ + tooltip?: CommonSeriesOptionsTooltip; + + /** Specifies the type of the series to render in chart. + * @Default {column. See Type} + */ + type?: ej.datavisualization.Chart.Type | string; + + /** Specifies the name of the x-axis that has to be associated with this series. Add an axis instance with this name to axes collection. + * @Default {null} + */ + xAxisName?: string; + + /** Name of the property in the datasource that contains x value for the series. + * @Default {null} + */ + xName?: string; + + /** Specifies the name of the y-axis that has to be associated with this series. Add an axis instance with this name to axes collection. + * @Default {null} + */ + yAxisName?: string; + + /** Name of the property in the datasource that contains y value for the series. + * @Default {null} + */ + yName?: string; + + /** Name of the property in the datasource that contains high value for the series. + * @Default {null} + */ + high?: string; + + /** Name of the property in the datasource that contains low value for the series. + * @Default {null} + */ + low?: string; + + /** Name of the property in the datasource that contains open value for the series. + * @Default {null} + */ + open?: string; + + /** Name of the property in the datasource that contains close value for the series. + * @Default {null} + */ + close?: string; + + /** Z-order of the series. + * @Default {0} + */ + zOrder?: number; + + /** Name of the property in the datasource that contains the size value for the bubble series. + * @Default {null} + */ + size?: string; + + /** Options for customizing the empty point in the series. + */ + emptyPointSettings?: CommonSeriesOptionsEmptyPointSettings; + + /** Fill color for the positive column of the waterfall. + * @Default {null} + */ + positiveFill?: string; + + /** Options for customizing the waterfall connector line. + */ + connectorLine?: CommonSeriesOptionsConnectorLine; + + /** Options to customize the drag and drop in series. + */ + dragSettings?: CommonSeriesOptionsDragSettings; + + /** Options to customize the error bar in series. + */ + errorBar?: CommonSeriesOptionsErrorBar; + + /** Option to add the trendlines to chart. + */ + trendlines?: CommonSeriesOptionsTrendline[]; + + /** Options for customizing the appearance of the series or data point while highlighting. + */ + highlightSettings?: CommonSeriesOptionsHighlightSettings; + + /** Options for customizing the appearance of the series/data point on selection. + */ + selectionSettings?: CommonSeriesOptionsSelectionSettings; + } + + export interface CrosshairTrackballTooltipSettingsBorder { + + /** Border width of the trackball tooltip. + * @Default {null} + */ + width?: number; + + /** Border color of the trackball tooltip. + * @Default {null} + */ + color?: string; + } + + export interface CrosshairTrackballTooltipSettings { + + /** Options for customizing the trackball tooltip border. + */ + border?: CrosshairTrackballTooltipSettingsBorder; + + /** Background color of the trackball tooltip. + * @Default {null} + */ + fill?: string; + + /** Rounded corner x value of the trackball tooltip. + * @Default {3} + */ + rx?: number; + + /** Rounded corner y value of the trackball tooltip. + * @Default {3} + */ + ry?: number; + + /** Opacity value of the trackball tooltip. + * @Default {1} + */ + opacity?: number; + + /** Specifies the mode of the trackball tooltip. + * @Default {float. See CrosshairMode} + */ + mode?: ej.datavisualization.Chart.CrosshairMode | string; + } + + export interface CrosshairMarkerBorder { + + /** Border width of the marker. + * @Default {3} + */ + width?: number; + } + + export interface CrosshairMarkerSize { + + /** Height of the marker. + * @Default {10} + */ + height?: number; + + /** Width of the marker. + * @Default {10} + */ + width?: number; + } + + export interface CrosshairMarker { + + /** Options for customizing the border. + */ + border?: CrosshairMarkerBorder; + + /** Opacity of the marker. + * @Default {true} + */ + opacity?: boolean; + + /** Options for customizing the size of the marker. + */ + size?: CrosshairMarkerSize; + + /** Show/hides the marker. + * @Default {true} + */ + visible?: boolean; + } + + export interface CrosshairLine { + + /** Color of the crosshair line. + * @Default {transparent} + */ + color?: string; + + /** Width of the crosshair line. + * @Default {1} + */ + width?: number; + } + + export interface Crosshair { + + /** Options for customizing the trackball tooltip. + */ + trackballTooltipSettings?: CrosshairTrackballTooltipSettings; + + /** Options for customizing the marker in crosshair. + */ + marker?: CrosshairMarker; + + /** Options for customizing the crosshair line. + */ + line?: CrosshairLine; + + /** Specifies the type of the crosshair. It can be trackball or crosshair + * @Default {crosshair. See CrosshairType} + */ + type?: ej.datavisualization.Chart.CrosshairType | string; + + /** Show/hides the crosshair/trackball visibility. + * @Default {false} + */ + visible?: boolean; + } + + export interface IndicatorsHistogramBorder { + + /** Color of the histogram border in MACD indicator. + * @Default {#9999ff} + */ + color?: string; + + /** Controls the width of histogram border line in MACD indicator. + * @Default {1} + */ + width?: number; + } + + export interface IndicatorsHistogram { + + /** Options to customize the histogram border in MACD indicator. + */ + border?: IndicatorsHistogramBorder; + + /** Color of histogram columns in MACD indicator. + * @Default {#ccccff} + */ + fill?: string; + + /** Opacity of histogram columns in MACD indicator. + * @Default {1} + */ + opacity?: number; + } + + export interface IndicatorsLowerLine { + + /** Color of lower line. + * @Default {#008000} + */ + fill?: string; + + /** Width of the lower line. + * @Default {2} + */ + width?: number; + } + + export interface IndicatorsMacdLine { + + /** Color of MACD line. + * @Default {#ff9933} + */ + fill?: string; + + /** Width of the MACD line. + * @Default {2} + */ + width?: number; + } + + export interface IndicatorsPeriodLine { + + /** Color of period line in indicator. + * @Default {blue} + */ + fill?: string; + + /** Width of the period line in indicators. + * @Default {2} + */ + width?: number; + } + + export interface IndicatorsTooltipBorder { + + /** Border color of indicator tooltip. + * @Default {null} + */ + color?: string; + + /** Border width of indicator tooltip. + * @Default {1} + */ + width?: number; + } + + export interface IndicatorsTooltip { + + /** Option to customize the border of indicator tooltip. + */ + border?: IndicatorsTooltipBorder; + + /** Specifies the animation duration of indicator tooltip. + * @Default {500ms} + */ + duration?: string; + + /** Enables/disables the tooltip animation. + * @Default {true} + */ + enableAnimation?: boolean; + + /** Format of indicator tooltip. Use Ă¢â‚¬Å“point.xĂ¢â‚¬Â and Ă¢â‚¬Å“point.yĂ¢â‚¬Â as a placeholder text to display the corresponding data pointĂ¢â‚¬â„¢s x and y value. + * @Default {#point.x# : #point.y#} + */ + format?: string; + + /** Background color of indicator tooltip. + * @Default {null} + */ + fill?: string; + + /** Opacity of indicator tooltip. + * @Default {0.95} + */ + opacity?: number; + + /** Controls the visibility of indicator tooltip. + * @Default {false} + */ + visible?: boolean; + } + + export interface IndicatorsUpperLine { + + /** Fill color of the upper line in indicators + * @Default {#ff9933} + */ + fill?: string; + + /** Width of the upper line in indicators. + * @Default {2} + */ + width?: number; + } + + export interface Indicator { + + /** The dPeriod value for stochastic indicator. + * @Default {3} + */ + dPeriod?: number; + + /** Enables/disables the animation. + * @Default {false} + */ + enableAnimation?: boolean; + + /** Color of the technical indicator. + * @Default {#00008B} + */ + fill?: string; + + /** Options to customize the histogram in MACD indicator. + */ + histogram?: IndicatorsHistogram; + + /** Specifies the k period in stochastic indicator. + * @Default {3} + */ + kPeriod?: number; + + /** Specifies the long period in MACD indicator. + * @Default {26} + */ + longPeriod?: number; + + /** Options to customize the lower line in indicators. + */ + lowerLine?: IndicatorsLowerLine; + + /** Options to customize the MACD line. + */ + macdLine?: IndicatorsMacdLine; + + /** Specifies the type of the MACD indicator. + * @Default {line. See MACDType} + */ + macdType?: string; + + /** Specifies period value in indicator. + * @Default {14} + */ + period?: number; + + /** Options to customize the period line in indicators. + */ + periodLine?: IndicatorsPeriodLine; + + /** Name of the series for which indicator has to be drawn. + */ + seriesName?: string; + + /** Specifies the short period in MACD indicator. + * @Default {13} + */ + shortPeriod?: number; + + /** Specifies the standard deviation value for Bollinger band indicator. + * @Default {2} + */ + standardDeviations?: number; + + /** Options to customize the tooltip. + */ + tooltip?: IndicatorsTooltip; + + /** Trigger value of MACD indicator. + * @Default {9} + */ + trigger?: number; + + /** Specifies the visibility of indicator. + * @Default {visible} + */ + visibility?: string; + + /** Specifies the type of indicator that has to be rendered. + * @Default {sma. See IndicatorsType} + */ + type?: string; + + /** Options to customize the upper line in indicators + */ + upperLine?: IndicatorsUpperLine; + + /** Width of the indicator line. + * @Default {2} + */ + width?: number; + + /** Name of the horizontal axis used for indicator. Primary X axis is used when x axis name is not specified. + */ + xAxisName?: string; + + /** Name of the vertical axis used for indicator. Primary Y axis is used when y axis name is not specified + */ + yAxisName?: string; + } + + export interface LegendBorder { + + /** Border color of the legend. + * @Default {transparent} + */ + color?: string; + + /** Border width of the legend. + * @Default {1} + */ + width?: number; + } + + export interface LegendFont { + + /** Font family for legend item text. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style for legend item text. + * @Default {Normal. See FontStyle} + */ + fontStyle?: ej.datavisualization.Chart.FontStyle | string; + + /** Font weight for legend item text. + * @Default {Regular. See FontWeight} + */ + fontWeight?: ej.datavisualization.Chart.FontWeight | string; + + /** Font size for legend item text. + * @Default {12px} + */ + size?: string; + } + + export interface LegendItemStyleBorder { + + /** Border color of the legend items. + * @Default {transparent} + */ + color?: string; + + /** Border width of the legend items. + * @Default {1} + */ + width?: number; + } + + export interface LegendItemStyle { + + /** Options for customizing the border of legend items. + */ + border?: LegendItemStyleBorder; + + /** Height of the shape in legend items. + * @Default {10} + */ + height?: number; + + /** Width of the shape in legend items. + * @Default {10} + */ + width?: number; + } + + export interface LegendLocation { + + /** X value or horizontal offset to position the legend in chart. + * @Default {0} + */ + x?: number; + + /** Y value or vertical offset to position the legend. + * @Default {0} + */ + y?: number; + } + + export interface LegendSize { + + /** Height of the legend. Height can be specified in either pixel or percentage. + * @Default {null} + */ + height?: string; + + /** Width of the legend. Width can be specified in either pixel or percentage. + * @Default {null} + */ + width?: string; + } + + export interface LegendTitleFont { + + /** Font family for the text in legend title. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style for legend title. + * @Default {normal. See FontStyle} + */ + fontStyle?: ej.datavisualization.Chart.FontStyle | string; + + /** Font weight for legend title. + * @Default {normal. See FontWeight} + */ + fontWeight?: ej.datavisualization.Chart.FontWeight | string; + + /** Font size for legend title. + * @Default {12px} + */ + size?: string; + } + + export interface LegendTitle { + + /** Options to customize the font used for legend title + */ + font?: LegendTitleFont; + + /** Text to be displayed in legend title. + */ + text?: string; + + /** Alignment of the legend title. + * @Default {center. See Alignment} + */ + textAlignment?: ej.datavisualization.Chart.Alignment | string; + } + + export interface Legend { + + /** Horizontal alignment of the legend. + * @Default {Center. See Alignment} + */ + alignment?: ej.datavisualization.Chart.Alignment | string; + + /** Background for the legend. Use this property to add a background image or background color for the legend. + */ + background?: string; + + /** Options for customizing the legend border. + */ + border?: LegendBorder; + + /** Number of columns to arrange the legend items. + * @Default {null} + */ + columnCount?: number; + + /** Controls whether legend has to use scrollbar or not. When enabled, scroll bar appears depending upon size and position properties of legend. + * @Default {true} + */ + enableScrollbar?: boolean; + + /** Fill color for the legend items. By using this property, it displays all legend item shapes in same color.Legend items representing invisible series is displayed in gray color. + * @Default {null} + */ + fill?: string; + + /** Options to customize the font used for legend item text. + */ + font?: LegendFont; + + /** Gap or padding between the legend items. + * @Default {10} + */ + itemPadding?: number; + + /** Options to customize the style of legend items. + */ + itemStyle?: LegendItemStyle; + + /** Options to customize the location of chart legend. Legend is placed in provided location only when value of position property is custom + */ + location?: LegendLocation; + + /** Opacity of the legend. + * @Default {1} + */ + opacity?: number; + + /** Places the legend at specified position. Legend can be placed at left, right, top or bottom of the chart area.To manually specify the location of legend, set custom as value to this property. + * @Default {Bottom. See Position} + */ + position?: ej.datavisualization.Chart.Position | string; + + /** Number of rows to arrange the legend items. + * @Default {null} + */ + rowCount?: number; + + /** Shape of the legend items. Default shape for pie and doughnut series is circle and all other series uses rectangle. + * @Default {None. See Shape} + */ + shape?: ej.datavisualization.Chart.Shape | string; + + /** Options to customize the size of the legend. + */ + size?: LegendSize; + + /** Options to customize the legend title. + */ + title?: LegendTitle; + + /** Specifies the action taken when the legend width is more than the textWidth. + * @Default {none. See textOverflow} + */ + textOverflow?: ej.datavisualization.Chart.TextOverflow | string; + + /** Text width for legend item. + * @Default {34} + */ + textWidth?: number; + + /** Controls the visibility of the legend. + * @Default {true} + */ + visible?: boolean; + } + + export interface PrimaryXAxisAlternateGridBandEven { + + /** Fill color for the even grid bands. + * @Default {transparent} + */ + fill?: string; + + /** Opacity of the even grid band. + * @Default {1} + */ + opacity?: number; + } + + export interface PrimaryXAxisAlternateGridBandOdd { + + /** Fill color of the odd grid bands + * @Default {transparent} + */ + fill?: string; + + /** Opacity of odd grid band + * @Default {1} + */ + opacity?: number; + } + + export interface PrimaryXAxisAlternateGridBand { + + /** Options for customizing even grid band. + */ + even?: PrimaryXAxisAlternateGridBandEven; + + /** Options for customizing odd grid band. + */ + odd?: PrimaryXAxisAlternateGridBandOdd; + } + + export interface PrimaryXAxisAxisLine { + + /** Pattern of dashes and gaps to be applied to the axis line. + * @Default {null} + */ + dashArray?: string; + + /** Padding for axis line. Normally, it is used along with plotOffset to pad the plot area. + * @Default {null} + */ + offset?: number; + + /** Show/hides the axis line. + * @Default {true} + */ + visible?: boolean; + + /** Default Value + */ + color?: string; + + /** Width of axis line. + * @Default {1} + */ + width?: number; + } + + export interface PrimaryXAxisCrosshairLabel { + + /** Show/hides the crosshair label associated with this axis. + * @Default {false} + */ + visible?: boolean; + } + + export interface PrimaryXAxisFont { + + /** Font family of labels. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style of labels. + * @Default {ej.datavisualization.Chart.FontStyle.Normal. See FontStyle} + */ + fontStyle?: ej.datavisualization.Chart.FontStyle | string; + + /** Font weight of the label. + * @Default {ej.datavisualization.Chart.FontWeight.Regular. See FontWeight} + */ + fontWeight?: ej.datavisualization.Chart.FontWeight | string; + + /** Opacity of the axis labels. + * @Default {1} + */ + opacity?: number; + + /** Font size of the axis labels. + * @Default {13px} + */ + size?: string; + } + + export interface PrimaryXAxisMajorGridLines { + + /** Pattern of dashes and gaps used to stroke the major grid lines. + * @Default {null} + */ + dashArray?: string; + + /** Color of the major grid line. + * @Default {null} + */ + color?: string; + + /** Opacity of major grid lines. + * @Default {1} + */ + opacity?: number; + + /** Show/hides the major grid lines. + * @Default {true} + */ + visible?: boolean; + + /** Width of the major grid lines. + * @Default {1} + */ + width?: number; + } + + export interface PrimaryXAxisMajorTickLines { + + /** Length of the major tick lines. + * @Default {5} + */ + size?: number; + + /** Show/hides the major tick lines. + * @Default {true} + */ + visible?: boolean; + + /** Width of the major tick lines. + * @Default {1} + */ + width?: number; + } + + export interface PrimaryXAxisMinorGridLines { + + /** Patterns of dashes and gaps used to stroke the minor grid lines. + * @Default {null} + */ + dashArray?: string; + + /** Show/hides the minor grid lines. + * @Default {true} + */ + visible?: boolean; + + /** Width of the minorGridLines. + * @Default {1} + */ + width?: number; + } + + export interface PrimaryXAxisMinorTickLines { + + /** Length of the minor tick lines. + * @Default {5} + */ + size?: number; + + /** Show/hides the minor tick lines. + * @Default {true} + */ + visible?: boolean; + + /** Width of the minor tick line. + * @Default {1} + */ + width?: number; + } + + export interface PrimaryXAxisRange { + + /** Minimum value of the axis range. + * @Default {null} + */ + min?: number; + + /** Maximum value of the axis range. + * @Default {null} + */ + max?: number; + + /** Interval of the axis range. + * @Default {null} + */ + interval?: number; + } + + export interface PrimaryXAxisMultiLevelLabelsFont { + + /** Font color of the multi level labels text. + * @Default {null} + */ + color?: string; + + /** Font family of the multi level labels text. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style of the multi level labels text. + * @Default {Normal} + */ + fontStyle?: ej.datavisualization.Chart.FontStyle | string; + + /** Font weight of the multi level label text. + * @Default {regular} + */ + fontWeight?: string; + + /** Opacity of the multi level label text. + * @Default {1} + */ + opacity?: number; + + /** Font size of the multi level label text. + * @Default {12px} + */ + size?: string; + } + + export interface PrimaryXAxisMultiLevelLabelsBorder { + + /** Border color of the multi level labels. + * @Default {null} + */ + color?: string; + + /** Border width of the multi level labels. + * @Default {1} + */ + width?: number; + + /** Border type of the multi level labels. + * @Default {rectangle. See Type} + */ + type?: ej.datavisualization.Chart.MultiLevelLabelsBorderType | string; + } + + export interface PrimaryXAxisMultiLevelLabel { + + /** Visibility of the multi level labels. + * @Default {false} + */ + visible?: boolean; + + /** Text of the multi level labels. + */ + text?: string; + + /** Starting value of the multi level labels. + * @Default {null} + */ + start?: number; + + /** Ending value of the multi level labels. + * @Default {null} + */ + end?: number; + + /** Specifies the level of multi level labels. + * @Default {0} + */ + level?: number; + + /** Specifies the maximum width of the text in multi level labels. + * @Default {null} + */ + maximumTextWidth?: number; + + /** Specifies the alignment of the text in multi level labels. + * @Default {center. See TextAlignment} + */ + textAlignment?: ej.datavisualization.Chart.TextAlignment | string; + + /** Specifies the handling of text over flow in multi level labels. + * @Default {center. See TextOverflow} + */ + textOverflow?: ej.datavisualization.Chart.TextOverflow | string; + + /** Options for customizing the font of the text. + */ + font?: PrimaryXAxisMultiLevelLabelsFont; + + /** Options for customizing the border of the series. + */ + border?: PrimaryXAxisMultiLevelLabelsBorder; + } + + export interface PrimaryXAxisStripLineFont { + + /** Font color of the strip line text. + * @Default {black} + */ + color?: string; + + /** Font family of the strip line text. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style of the strip line text. + * @Default {Normal} + */ + fontStyle?: ej.datavisualization.Chart.FontStyle | string; + + /** Font weight of the strip line text. + * @Default {regular} + */ + fontWeight?: string; + + /** Opacity of the strip line text. + * @Default {1} + */ + opacity?: number; + + /** Font size of the strip line text. + * @Default {12px} + */ + size?: string; + } + + export interface PrimaryXAxisStripLine { + + /** Border color of the strip line. + * @Default {gray} + */ + borderColor?: string; + + /** Background color of the strip line. + * @Default {gray} + */ + color?: string; + + /** End value of the strip line. + * @Default {null} + */ + end?: number; + + /** Options for customizing the font of the text. + */ + font?: PrimaryXAxisStripLineFont; + + /** Start value of the strip line. + * @Default {null} + */ + start?: number; + + /** Indicates whether to render the strip line from the minimum/start value of the axis. This property does not work when start property is set. + * @Default {false} + */ + startFromAxis?: boolean; + + /** Specifies text to be displayed inside the strip line. + * @Default {stripLine} + */ + text?: string; + + /** Specifies the alignment of the text inside the strip line. + * @Default {middlecenter. See TextAlignment} + */ + textAlignment?: ej.datavisualization.Chart.TextAlignment | string; + + /** Show/hides the strip line. + * @Default {false} + */ + visible?: boolean; + + /** Width of the strip line. + * @Default {0} + */ + width?: number; + + /** Specifies the order where the strip line and the series have to be rendered. When Z-order is Ă¢â‚¬Å“behindĂ¢â‚¬Â, strip line is rendered + * under the series and when it is Ă¢â‚¬Å“overĂ¢â‚¬Â, it is rendered above the series. + * @Default {over. See ZIndex} + */ + zIndex?: ej.datavisualization.Chart.ZIndex | string; + } + + export interface PrimaryXAxisLabelBorder { + + /** Specifies the color of the label border. + * @Default {null} + */ + color?: string; + + /** Specifies the width of the label border. + * @Default {1} + */ + width?: number; + } + + export interface PrimaryXAxisTitleFont { + + /** Font family of the title text. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style of the title text. + * @Default {ej.datavisualization.Chart.FontStyle.Normal} + */ + fontStyle?: ej.datavisualization.Chart.FontStyle | string; + + /** Font weight of the title text. + * @Default {ej.datavisualization.Chart.FontWeight.Regular. See FontWeight} + */ + fontWeight?: ej.datavisualization.Chart.FontWeight | string; + + /** Opacity of the axis title text. + * @Default {1} + */ + opacity?: number; + + /** Font size of the axis title. + * @Default {16px} + */ + size?: string; + } + + export interface PrimaryXAxisTitle { + + /** Specifies whether to trim the axis title when it exceeds the chart area or the maximum width of the title. + * @Default {false} + */ + enableTrim?: boolean; + + /** Options for customizing the title font. + */ + font?: PrimaryXAxisTitleFont; + + /** Maximum width of the title, when the title exceeds this width, the title gets trimmed, when enableTrim is true. + * @Default {34} + */ + maximumTitleWidth?: number; + + /** Title for the axis. + */ + text?: string; + + /** Controls the visibility of axis title. + * @Default {true} + */ + visible?: boolean; + + /** offset value for axis title. + * @Default {0} + */ + offset?: number; + + /** Specifies the position of the axis title. + * @Default {outside. See Position} + */ + position?: ej.datavisualization.Chart.LabelPosition | string; + + /** Specifies the position of the axis title. + * @Default {center. See Alignment} + */ + alignment?: ej.datavisualization.Chart.TextAlignment | string; + } + + export interface PrimaryXAxis { + + /** Options for customizing horizontal axis alternate grid band. + */ + alternateGridBand?: PrimaryXAxisAlternateGridBand; + + /** Specifies where horizontal axis should intersect the vertical axis or vice versa. Value should be provided in axis co-ordinates. + * If provided value is greater than the maximum value of crossing axis, then axis will be placed at the opposite side. + * @Default {null} + */ + crossesAt?: number; + + /** Name of the axis used for crossing. Vertical axis name should be provided for horizontal axis and vice versa. + * If the provided name does not belongs to a valid axis, then primary X axis or primary Y axis will be used for crossing + * @Default {null} + */ + crossesInAxis?: string; + + /** Category axis can also plot points based on index value of data points. Index based plotting can be enabled by setting Ă¢â‚¬ËœisIndexedĂ¢â‚¬â„¢ property to true. + * @Default {false} + */ + isIndexed?: boolean; + + /** Options for customizing the axis line. + */ + axisLine?: PrimaryXAxisAxisLine; + + /** Specifies the index of the column where the axis is associated, when the chart area is divided into multiple plot areas by using columnDefinitions. + * @Default {null} + */ + columnIndex?: number; + + /** Specifies the number of columns or plot areas an axis has to span horizontally. + * @Default {null} + */ + columnSpan?: number; + + /** Options to customize the crosshair label. + */ + crosshairLabel?: PrimaryXAxisCrosshairLabel; + + /** With this setting, you can request axis to calculate intervals approximately equal to your desired interval. + * @Default {null} + */ + desiredIntervals?: number; + + /** Specifies the placement of labels. + * @Default {ej.datavisualization.Chart.LabelPlacement.BetweenTicks. See LabelPlacement} + */ + labelPlacement?: ej.datavisualization.Chart.LabelPlacement | string; + + /** Specifies the position of labels at the edge of the axis. + * @Default {ej.datavisualization.Chart.EdgeLabelPlacement.None. See EdgeLabelPlacement} + */ + edgeLabelPlacement?: ej.datavisualization.Chart.EdgeLabelPlacement | string; + + /** Specifies whether to trim the axis label when the width of the label exceeds the maximumLabelWidth. + * @Default {false} + */ + enableTrim?: boolean; + + /** Options for customizing the font of the axis Labels. + */ + font?: PrimaryXAxisFont; + + /** Specifies the type of interval in date time axis. + * @Default {null. See IntervalType} + */ + intervalType?: ej.datavisualization.Chart.IntervalType | string; + + /** Specifies whether to inverse the axis. + * @Default {false} + */ + isInversed?: boolean; + + /** Custom formatting for axis label and supports all standard formatting type of numerical and date time values. + * @Default {null} + */ + labelFormat?: string; + + /** Specifies the action to take when the axis labels are overlapping with each other. + * @Default {ej.datavisualization.Chart.LabelIntersectAction.None. See LabelIntersectAction} + */ + labelIntersectAction?: ej.datavisualization.Chart.LabelIntersectAction | string; + + /** Specifies the position of the axis labels. + * @Default {outside. See LabelPosition} + */ + labelPosition?: ej.datavisualization.Chart.LabelPosition | string; + + /** Specifies the position of the axis labels. + * @Default {center. See Alignment} + */ + alignment?: ej.datavisualization.Chart.LabelAlignment | string; + + /** Angle in degrees to rotate the axis labels. + * @Default {null} + */ + labelRotation?: number; + + /** Logarithmic base value. This is applicable only for logarithmic axis. + * @Default {10} + */ + logBase?: number; + + /** Options for customizing major gird lines. + */ + majorGridLines?: PrimaryXAxisMajorGridLines; + + /** Options for customizing the major tick lines. + */ + majorTickLines?: PrimaryXAxisMajorTickLines; + + /** Maximum number of labels to be displayed in every 100 pixels. + * @Default {3} + */ + maximumLabels?: number; + + /** Maximum width of the axis label. When the label exceeds the width, the label gets trimmed when the enableTrim is set to true. + * @Default {34} + */ + maximumLabelWidth?: number; + + /** Options for customizing the minor grid lines. + */ + minorGridLines?: PrimaryXAxisMinorGridLines; + + /** Options for customizing the minor tick lines. + */ + minorTickLines?: PrimaryXAxisMinorTickLines; + + /** Specifies the number of minor ticks per interval. + * @Default {null} + */ + minorTicksPerInterval?: number; + + /** Unique name of the axis. To associate an axis with the series, you have to set this name to the xAxisName/yAxisName property of the series. + * @Default {null} + */ + name?: string; + + /** Specifies whether to render the axis at the opposite side of its default position. + * @Default {false} + */ + opposedPosition?: boolean; + + /** Specifies the padding for the plot area. + * @Default {10} + */ + plotOffset?: number; + + /** Options to customize the range of the axis. + */ + range?: PrimaryXAxisRange; + + /** Specifies the padding for the axis range. + * @Default {None. See RangePadding} + */ + rangePadding?: ej.datavisualization.Chart.RangePadding | string; + + /** Rounds the number to the given number of decimals. + * @Default {null} + */ + roundingPlaces?: number; + + /** Options for customizing the multi level labels. + * @Default {[ ]} + */ + multiLevelLabels?: PrimaryXAxisMultiLevelLabel[]; + + /** Options for customizing the strip lines. + * @Default {[ ]} + */ + stripLine?: PrimaryXAxisStripLine[]; + + /** Specifies the position of the axis tick lines. + * @Default {outside. See TickLinesPosition} + */ + tickLinesPosition?: ej.datavisualization.Chart.TickLinesPosition | string; + + /** Options for customizing the border of the labels. + */ + labelBorder?: PrimaryXAxisLabelBorder; + + /** Options for customizing the axis title. + */ + title?: PrimaryXAxisTitle; + + /** Specifies the type of data the axis is handling. + * @Default {null. See ValueType} + */ + valueType?: ej.datavisualization.Chart.ValueType | string; + + /** Show/hides the axis. + * @Default {true} + */ + visible?: boolean; + + /** The axis is scaled by this factor. When zoomFactor is 0.5, the chart is scaled by 200% along this axis. Value ranges from 0 to 1. + * @Default {1} + */ + zoomFactor?: number; + + /** Position of the zoomed axis. Value ranges from 0 to 1. + * @Default {0} + */ + zoomPosition?: number; + } + + export interface AxesAlternateGridBandEven { + + /** Fill color for the even grid bands. + * @Default {transparent} + */ + fill?: string; + + /** Opacity of the even grid band. + * @Default {1} + */ + opacity?: number; + } + + export interface AxesAlternateGridBandOdd { + + /** Fill color of the odd grid bands + * @Default {transparent} + */ + fill?: string; + + /** Opacity of odd grid band + * @Default {1} + */ + opacity?: number; + } + + export interface AxesAlternateGridBand { + + /** Options for customizing even grid band. + */ + even?: AxesAlternateGridBandEven; + + /** Options for customizing odd grid band. + */ + odd?: AxesAlternateGridBandOdd; + } + + export interface AxesAxisLine { + + /** Pattern of dashes and gaps to be applied to the axis line. + * @Default {null} + */ + dashArray?: string; + + /** Padding for axis line. Normally, it is used along with plotOffset to pad the plot area. + * @Default {null} + */ + offset?: number; + + /** Show/hides the axis line. + * @Default {true} + */ + visible?: boolean; + + /** Color of axis line. + */ + color?: string; + + /** Width of axis line. + * @Default {1} + */ + width?: number; + } + + export interface AxesCrosshairLabel { + + /** Show/hides the crosshair label associated with this axis. + * @Default {false} + */ + visible?: boolean; + } + + export interface AxesFont { + + /** Font family of labels. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style of labels. + * @Default {ej.datavisualization.Chart.FontStyle.Normal. See FontStyle} + */ + fontStyle?: ej.datavisualization.Chart.FontStyle | string; + + /** Font weight of the label. + * @Default {ej.datavisualization.Chart.FontWeight.Regular. See FontWeight} + */ + fontWeight?: ej.datavisualization.Chart.FontWeight | string; + + /** Opacity of the axis labels. + * @Default {1} + */ + opacity?: number; + + /** Font size of the axis labels. + * @Default {13px} + */ + size?: string; + } + + export interface AxesMajorGridLines { + + /** Pattern of dashes and gaps used to stroke the major grid lines. + * @Default {null} + */ + dashArray?: string; + + /** Color of the major grid line. + * @Default {null} + */ + color?: string; + + /** Opacity of major grid lines. + * @Default {1} + */ + opacity?: number; + + /** Show/hides the major grid lines. + * @Default {true} + */ + visible?: boolean; + + /** Width of the major grid lines. + * @Default {1} + */ + width?: number; + } + + export interface AxesMajorTickLines { + + /** Length of the major tick lines. + * @Default {5} + */ + size?: number; + + /** Show/hides the major tick lines. + * @Default {true} + */ + visible?: boolean; + + /** Width of the major tick lines. + * @Default {1} + */ + width?: number; + } + + export interface AxesMinorGridLines { + + /** Patterns of dashes and gaps used to stroke the minor grid lines. + * @Default {null} + */ + dashArray?: string; + + /** Show/hides the minor grid lines. + * @Default {true} + */ + visible?: boolean; + + /** Width of the minorGridLines. + * @Default {1} + */ + width?: number; + } + + export interface AxesMinorTickLines { + + /** Length of the minor tick lines. + * @Default {5} + */ + size?: number; + + /** Show/hides the minor tick lines. + * @Default {true} + */ + visible?: boolean; + + /** Width of the minor tick line. + * @Default {1} + */ + width?: number; + } + + export interface AxesRange { + + /** Minimum value of the axis range. + * @Default {null} + */ + min?: number; + + /** Maximum value of the axis range. + * @Default {null} + */ + max?: number; + + /** Interval of the axis range. + * @Default {null} + */ + interval?: number; + } + + export interface AxesMultiLevelLabelsFont { + + /** Font color of the multi level labels text. + * @Default {null} + */ + color?: string; + + /** Font family of the multi level labels text. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style of the multi level labels text. + * @Default {Normal} + */ + fontStyle?: ej.datavisualization.Chart.FontStyle | string; + + /** Font weight of the multi level label text. + * @Default {regular} + */ + fontWeight?: string; + + /** Opacity of the multi level label text. + * @Default {1} + */ + opacity?: number; + + /** Font size of the multi level label text. + * @Default {12px} + */ + size?: string; + } + + export interface AxesMultiLevelLabelsBorder { + + /** Border color of the multi level labels. + * @Default {null} + */ + color?: string; + + /** Border width of the multi level labels. + * @Default {1} + */ + width?: number; + + /** Border type of the multi level labels. + * @Default {rectangle. See Type} + */ + type?: ej.datavisualization.Chart.MultiLevelLabelsBorderType | string; + } + + export interface AxesMultiLevelLabel { + + /** Visibility of the multi level labels. + * @Default {false} + */ + visible?: boolean; + + /** Text of the multi level labels. + */ + text?: string; + + /** Starting value of the multi level labels. + * @Default {null} + */ + start?: number; + + /** Ending value of the multi level labels. + * @Default {null} + */ + end?: number; + + /** Specifies the level of multi level labels. + * @Default {0} + */ + level?: number; + + /** Specifies the maximum width of the text in multi level labels. + * @Default {null} + */ + maximumTextWidth?: number; + + /** Specifies the alignment of the text in multi level labels. + * @Default {center. See TextAlignment} + */ + textAlignment?: ej.datavisualization.Chart.TextAlignment | string; + + /** Specifies the handling of text over flow in multi level labels. + * @Default {center. See TextOverflow} + */ + textOverflow?: ej.datavisualization.Chart.TextOverflow | string; + + /** Options for customizing the font of the text. + */ + font?: AxesMultiLevelLabelsFont; + + /** Options for customizing the border of the series. + */ + border?: AxesMultiLevelLabelsBorder; + } + + export interface AxesStripLineFont { + + /** Font color of the strip line text. + * @Default {black} + */ + color?: string; + + /** Font family of the strip line text. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style of the strip line text. + * @Default {Normal} + */ + fontStyle?: ej.datavisualization.Chart.FontStyle | string; + + /** Font weight of the strip line text. + * @Default {regular} + */ + fontWeight?: string; + + /** Opacity of the strip line text. + * @Default {1} + */ + opacity?: number; + + /** Font size of the strip line text. + * @Default {12px} + */ + size?: string; + } + + export interface AxesStripLine { + + /** Border color of the strip line. + * @Default {gray} + */ + borderColor?: string; + + /** Background color of the strip line. + * @Default {gray} + */ + color?: string; + + /** End value of the strip line. + * @Default {null} + */ + end?: number; + + /** Options for customizing the font of the text. + */ + font?: AxesStripLineFont; + + /** Start value of the strip line. + * @Default {null} + */ + start?: number; + + /** Indicates whether to render the strip line from the minimum/start value of the axis. This property does not work when start property is set. + * @Default {false} + */ + startFromAxis?: boolean; + + /** Specifies text to be displayed inside the strip line. + * @Default {stripLine} + */ + text?: string; + + /** Specifies the alignment of the text inside the strip line. + * @Default {middlecenter. See TextAlignment} + */ + textAlignment?: ej.datavisualization.Chart.TextAlignment | string; + + /** Show/hides the strip line. + * @Default {false} + */ + visible?: boolean; + + /** Width of the strip line. + * @Default {0} + */ + width?: number; + + /** Specifies the order where the strip line and the series have to be rendered. When Z-order is Ă¢â‚¬Å“behindĂ¢â‚¬Â, strip line is rendered under the series and when it is Ă¢â‚¬Å“overĂ¢â‚¬Â, + * it is rendered above the series. + * @Default {over. See ZIndex} + */ + zIndex?: ej.datavisualization.Chart.ZIndex | string; + } + + export interface AxesLabelBorder { + + /** Specifies the color of the label border. + * @Default {null} + */ + color?: string; + + /** Specifies the width of the label border. + * @Default {1} + */ + width?: number; + } + + export interface AxesTitleFont { + + /** Font family of the title text. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style of the title text. + * @Default {ej.datavisualization.Chart.FontStyle.Normal} + */ + fontStyle?: ej.datavisualization.Chart.FontStyle | string; + + /** Font weight of the title text. + * @Default {ej.datavisualization.Chart.FontWeight.Regular. See FontWeight} + */ + fontWeight?: ej.datavisualization.Chart.FontWeight | string; + + /** Opacity of the axis title text. + * @Default {1} + */ + opacity?: number; + + /** Font size of the axis title. + * @Default {16px} + */ + size?: string; + } + + export interface AxesTitle { + + /** Specifies whether to trim the axis title when it exceeds the chart area or the maximum width of the title. + * @Default {false} + */ + enableTrim?: boolean; + + /** Options for customizing the title font. + */ + font?: AxesTitleFont; + + /** Maximum width of the title, when the title exceeds this width, the title gets trimmed, when enableTrim is true. + * @Default {34} + */ + maximumTitleWidth?: number; + + /** Title for the axis. + */ + text?: string; + + /** Controls the visibility of axis title. + * @Default {true} + */ + visible?: boolean; + + /** offset value for axis title. + * @Default {0} + */ + offset?: number; + + /** Specifies the position of the axis title. + * @Default {outside. See Position} + */ + position?: ej.datavisualization.Chart.LabelPosition | string; + + /** Specifies the position of the axis title. + * @Default {center. See Alignment} + */ + alignment?: ej.datavisualization.Chart.TextAlignment | string; + } + + export interface Axis { + + /** Options for customizing axis alternate grid band. + */ + alternateGridBand?: AxesAlternateGridBand; + + /** Specifies where axis should intersect the vertical axis or vice versa. Value should be provided in axis co-ordinates. If provided value is greater than the maximum value of crossing axis, + * then axis will be placed at the opposite side. + * @Default {null} + */ + crossesAt?: number; + + /** Category axis can also plot points based on index value of data points. Index based plotting can be enabled by setting Ă¢â‚¬ËœisIndexedĂ¢â‚¬â„¢ property to true. + * @Default {false} + */ + isIndexed?: boolean; + + /** Options for customizing the axis line. + */ + axisLine?: AxesAxisLine; + + /** Specifies the index of the column where the axis is associated, when the chart area is divided into multiple plot areas by using columnDefinitions. + * @Default {null} + */ + columnIndex?: number; + + /** Specifies the number of columns or plot areas an axis has to span horizontally. + * @Default {null} + */ + columnSpan?: number; + + /** Options to customize the crosshair label. + */ + crosshairLabel?: AxesCrosshairLabel; + + /** With this setting, you can request axis to calculate intervals approximately equal to your desired interval. + * @Default {null} + */ + desiredIntervals?: number; + + /** Specifies the placement of labels. + * @Default {ej.datavisualization.Chart.LabelPlacement.BetweenTicks. See LabelPlacement} + */ + labelPlacement?: ej.datavisualization.Chart.LabelPlacement | string; + + /** Specifies the position of labels at the edge of the axis. + * @Default {ej.datavisualization.Chart.EdgeLabelPlacement.None. See EdgeLabelPlacement} + */ + edgeLabelPlacement?: ej.datavisualization.Chart.EdgeLabelPlacement | string; + + /** Specifies whether to trim the axis label when the width of the label exceeds the maximumLabelWidth. + * @Default {false} + */ + enableTrim?: boolean; + + /** Options for customizing the font of the axis Labels. + */ + font?: AxesFont; + + /** Specifies the type of interval in date time axis. + * @Default {null. See IntervalType} + */ + intervalType?: ej.datavisualization.Chart.IntervalType | string; + + /** Specifies whether to inverse the axis. + * @Default {false} + */ + isInversed?: boolean; + + /** Custom formatting for axis label and supports all standard formatting type of numerical and date time values. + * @Default {null} + */ + labelFormat?: string; + + /** Specifies the action to take when the axis labels are overlapping with each other. + * @Default {ej.datavisualization.Chart.LabelIntersectAction.None. See LabelIntersectAction} + */ + labelIntersectAction?: ej.datavisualization.Chart.LabelIntersectAction | string; + + /** Specifies the position of the axis labels. + * @Default {outside. See LabelPosition} + */ + labelPosition?: ej.datavisualization.Chart.LabelPosition | string; + + /** Specifies the position of the axis labels. + * @Default {center. See Alignment} + */ + alignment?: ej.datavisualization.Chart.LabelAlignment | string; + + /** Angle in degrees to rotate the axis labels. + * @Default {null} + */ + labelRotation?: number; + + /** Logarithmic base value. This is applicable only for logarithmic axis. + * @Default {10} + */ + logBase?: number; + + /** Options for customizing major gird lines. + */ + majorGridLines?: AxesMajorGridLines; + + /** Options for customizing the major tick lines. + */ + majorTickLines?: AxesMajorTickLines; + + /** Maximum number of labels to be displayed in every 100 pixels. + * @Default {3} + */ + maximumLabels?: number; + + /** Maximum width of the axis label. When the label exceeds the width, the label gets trimmed when the enableTrim is set to true. + * @Default {34} + */ + maximumLabelWidth?: number; + + /** Options for customizing the minor grid lines. + */ + minorGridLines?: AxesMinorGridLines; + + /** Options for customizing the minor tick lines. + */ + minorTickLines?: AxesMinorTickLines; + + /** Specifies the number of minor ticks per interval. + * @Default {null} + */ + minorTicksPerInterval?: number; + + /** Unique name of the axis. To associate an axis with the series, you have to set this name to the xAxisName/yAxisName property of the series. + * @Default {null} + */ + name?: string; + + /** Specifies whether to render the axis at the opposite side of its default position. + * @Default {false} + */ + opposedPosition?: boolean; + + /** Specifies the padding for the plot area. + * @Default {10} + */ + plotOffset?: number; + + /** Options to customize the range of the axis. + */ + range?: AxesRange; + + /** Specifies the padding for the axis range. + * @Default {None. See RangePadding} + */ + rangePadding?: ej.datavisualization.Chart.RangePadding | string; + + /** Rounds the number to the given number of decimals. + * @Default {null} + */ + roundingPlaces?: number; + + /** Options for customizing the multi level labels. + * @Default {[ ]} + */ + multiLevelLabels?: AxesMultiLevelLabel[]; + + /** Options for customizing the strip lines. + * @Default {[ ]} + */ + stripLine?: AxesStripLine[]; + + /** Specifies the position of the axis tick lines. + * @Default {outside. See TickLinesPosition} + */ + tickLinesPosition?: ej.datavisualization.Chart.TickLinesPosition | string; + + /** Options for customizing the border of the labels. + */ + labelBorder?: AxesLabelBorder; + + /** Options for customizing the axis title. + */ + title?: AxesTitle; + + /** Specifies the type of data the axis is handling. + * @Default {null. See ValueType} + */ + valueType?: ej.datavisualization.Chart.ValueType | string; + + /** Show/hides the axis. + * @Default {true} + */ + visible?: boolean; + + /** The axis is scaled by this factor. When zoomFactor is 0.5, the chart is scaled by 200% along this axis. Value ranges from 0 to 1. + * @Default {1} + */ + zoomFactor?: number; + + /** Position of the zoomed axis. Value ranges from 0 to 1. + * @Default {0} + */ + zoomPosition?: number; + } + + export interface PrimaryYAxisAlternateGridBandEven { + + /** Fill color for the even grid bands. + * @Default {transparent} + */ + fill?: string; + + /** Opacity of the even grid band. + * @Default {1} + */ + opacity?: number; + } + + export interface PrimaryYAxisAlternateGridBandOdd { + + /** Fill color of the odd grid bands. + * @Default {transparent} + */ + fill?: string; + + /** Opacity of odd grid band. + * @Default {1} + */ + opacity?: number; + } + + export interface PrimaryYAxisAlternateGridBand { + + /** Options for customizing even grid band. + */ + even?: PrimaryYAxisAlternateGridBandEven; + + /** Options for customizing odd grid band. + */ + odd?: PrimaryYAxisAlternateGridBandOdd; + } + + export interface PrimaryYAxisAxisLine { + + /** Pattern of dashes and gaps to be applied to the axis line. + * @Default {null} + */ + dashArray?: string; + + /** Padding for axis line. Normally, it is used along with plotOffset to pad the plot area. + * @Default {null} + */ + offset?: number; + + /** Show/hides the axis line. + * @Default {true} + */ + visible?: boolean; + + /** Color of axis line. + */ + color?: string; + + /** Width of axis line. + * @Default {1} + */ + width?: number; + } + + export interface PrimaryYAxisCrosshairLabel { + + /** Show/hides the crosshair label associated with this axis. + * @Default {false} + */ + visible?: boolean; + } + + export interface PrimaryYAxisFont { + + /** Font family of labels. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style of labels. + * @Default {ej.datavisualization.Chart.FontStyle.Normal. See FontStyle} + */ + fontStyle?: ej.datavisualization.Chart.FontStyle | string; + + /** Font weight of the label. + * @Default {ej.datavisualization.Chart.FontWeight.Regular. See FontWeight} + */ + fontWeight?: ej.datavisualization.Chart.FontWeight | string; + + /** Opacity of the axis labels. + * @Default {1} + */ + opacity?: number; + + /** Font size of the axis labels. + * @Default {13px} + */ + size?: string; + } + + export interface PrimaryYAxisMajorGridLines { + + /** Pattern of dashes and gaps used to stroke the major grid lines. + * @Default {null} + */ + dashArray?: string; + + /** Color of the major grid lines. + * @Default {null} + */ + color?: string; + + /** Opacity of major grid lines. + * @Default {1} + */ + opacity?: number; + + /** Show/hides the major grid lines. + * @Default {true} + */ + visible?: boolean; + + /** Width of the major grid lines. + * @Default {1} + */ + width?: number; + } + + export interface PrimaryYAxisMajorTickLines { + + /** Length of the major tick lines. + * @Default {5} + */ + size?: number; + + /** Show/hides the major tick lines. + * @Default {true} + */ + visible?: boolean; + + /** Width of the major tick lines. + * @Default {1} + */ + width?: number; + } + + export interface PrimaryYAxisMinorGridLines { + + /** Patterns of dashes and gaps used to stroke the minor grid lines. + * @Default {null} + */ + dashArray?: string; + + /** Show/hides the minor grid lines. + * @Default {true} + */ + visible?: boolean; + + /** Width of the minorGridLines. + * @Default {1} + */ + width?: number; + } + + export interface PrimaryYAxisMinorTickLines { + + /** Length of the minor tick lines. + * @Default {5} + */ + size?: number; + + /** Show/hides the minor tick lines. + * @Default {true} + */ + visible?: boolean; + + /** Width of the minor tick line + * @Default {1} + */ + width?: number; + } + + export interface PrimaryYAxisRange { + + /** Minimum value of the axis range. + * @Default {null} + */ + min?: number; + + /** Maximum value of the axis range. + * @Default {null} + */ + max?: number; + + /** Interval for the range. + * @Default {null} + */ + interval?: number; + } + + export interface PrimaryYAxisMultiLevelLabelsFont { + + /** Font color of the multi level labels text. + * @Default {null} + */ + color?: string; + + /** Font family of the multi level labels text. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style of the multi level labels text. + * @Default {Normal} + */ + fontStyle?: ej.datavisualization.Chart.FontStyle | string; + + /** Font weight of the multi level label text. + * @Default {regular} + */ + fontWeight?: string; + + /** Opacity of the multi level label text. + * @Default {1} + */ + opacity?: number; + + /** Font size of the multi level label text. + * @Default {12px} + */ + size?: string; + } + + export interface PrimaryYAxisMultiLevelLabelsBorder { + + /** Border color of the multi level labels. + * @Default {null} + */ + color?: string; + + /** Border width of the multi level labels. + * @Default {1} + */ + width?: number; + + /** Border type of the multi level labels. + * @Default {rectangle. See Type} + */ + type?: ej.datavisualization.Chart.MultiLevelLabelsBorderType | string; + } + + export interface PrimaryYAxisMultiLevelLabel { + + /** Visibility of the multi level labels. + * @Default {false} + */ + visible?: boolean; + + /** Text of the multi level labels. + */ + text?: string; + + /** Starting value of the multi level labels. + * @Default {null} + */ + start?: number; + + /** Ending value of the multi level labels. + * @Default {null} + */ + end?: number; + + /** Specifies the level of multi level labels. + * @Default {0} + */ + level?: number; + + /** Specifies the maximum width of the text in multi level labels. + * @Default {null} + */ + maximumTextWidth?: number; + + /** Specifies the alignment of the text in multi level labels. + * @Default {center. See TextAlignment} + */ + textAlignment?: ej.datavisualization.Chart.TextAlignment | string; + + /** Specifies the handling of text over flow in multi level labels. + * @Default {center. See TextOverflow} + */ + textOverflow?: ej.datavisualization.Chart.TextOverflow | string; + + /** Options for customizing the font of the text. + */ + font?: PrimaryYAxisMultiLevelLabelsFont; + + /** Options for customizing the border of the series. + */ + border?: PrimaryYAxisMultiLevelLabelsBorder; + } + + export interface PrimaryYAxisStripLineFont { + + /** Font color of the strip line text. + * @Default {black} + */ + color?: string; + + /** Font family of the strip line text. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style of the strip line text. + * @Default {Normal} + */ + fontStyle?: ej.datavisualization.Chart.FontStyle | string; + + /** Font weight of the strip line text. + * @Default {regular} + */ + fontWeight?: string; + + /** Opacity of the strip line text. + * @Default {1} + */ + opacity?: number; + + /** Font size of the strip line text. + * @Default {12px} + */ + size?: string; + } + + export interface PrimaryYAxisStripLine { + + /** Border color of the strip line. + * @Default {gray} + */ + borderColor?: string; + + /** Background color of the strip line. + * @Default {gray} + */ + color?: string; + + /** End value of the strip line. + * @Default {null} + */ + end?: number; + + /** Options for customizing the font of the text. + */ + font?: PrimaryYAxisStripLineFont; + + /** Start value of the strip line. + * @Default {null} + */ + start?: number; + + /** Indicates whether to render the strip line from the minimum/start value of the axis. This property wonĂ¢â‚¬â„¢t work when start property is set. + * @Default {false} + */ + startFromAxis?: boolean; + + /** Specifies text to be displayed inside the strip line. + * @Default {stripLine} + */ + text?: string; + + /** Specifies the alignment of the text inside the strip line. + * @Default {middlecenter. See TextAlignment} + */ + textAlignment?: ej.datavisualization.Chart.TextAlignment | string; + + /** Show/hides the strip line. + * @Default {false} + */ + visible?: boolean; + + /** Width of the strip line. + * @Default {0} + */ + width?: number; + + /** Specifies the order in which strip line and the series have to be rendered. When Z-order is Ă¢â‚¬Å“behindĂ¢â‚¬Â, strip line is rendered below the series and + * when it is Ă¢â‚¬Å“overĂ¢â‚¬Â, it is rendered above the series. + * @Default {over. See ZIndex} + */ + zIndex?: ej.datavisualization.Chart.ZIndex | string; + } + + export interface PrimaryYAxisLabelBorder { + + /** Specifies the color of the label border. + * @Default {null} + */ + color?: string; + + /** Specifies the width of the label border. + * @Default {1} + */ + width?: number; + } + + export interface PrimaryYAxisTitleFont { + + /** Font family of the title text. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style of the title text. + * @Default {ej.datavisualization.Chart.FontStyle.Normal} + */ + fontStyle?: ej.datavisualization.Chart.FontStyle | string; + + /** Font weight of the title text. + * @Default {ej.datavisualization.Chart.FontWeight.Regular. See FontWeight} + */ + fontWeight?: ej.datavisualization.Chart.FontWeight | string; + + /** Opacity of the axis title text. + * @Default {1} + */ + opacity?: number; + + /** Font size of the axis title. + * @Default {16px} + */ + size?: string; + } + + export interface PrimaryYAxisTitle { + + /** Specifies whether to trim the axis title when it exceeds the chart area or the maximum width of the title. + * @Default {ej.datavisualization.Chart.enableTrim} + */ + enableTrim?: boolean; + + /** Options for customizing the title font. + */ + font?: PrimaryYAxisTitleFont; + + /** Maximum width of the title, when the title exceeds this width, the title gets trimmed, when enableTrim is true. + * @Default {ej.datavisualization.Chart.maximumTitleWidth.null} + */ + maximumTitleWidth?: number; + + /** Title for the axis. + */ + text?: string; + + /** Controls the visibility of axis title. + * @Default {true} + */ + visible?: boolean; + + /** offset value for axis title. + * @Default {0} + */ + offset?: number; + + /** Specifies the position of the axis title. + * @Default {outside. See Position} + */ + position?: ej.datavisualization.Chart.LabelPosition | string; + + /** Specifies the position of the axis title. + * @Default {center. See Alignment} + */ + alignment?: ej.datavisualization.Chart.TextAlignment | string; + } + + export interface PrimaryYAxis { + + /** Options for customizing vertical axis alternate grid band. + */ + alternateGridBand?: PrimaryYAxisAlternateGridBand; + + /** Options for customizing the axis line. + */ + axisLine?: PrimaryYAxisAxisLine; + + /** Specifies where horizontal axis should intersect the vertical axis or vice versa. Value should be provided in axis co-ordinates. + * If provided value is greater than the maximum value of crossing axis, then axis will be placed at the opposite side. + * @Default {null} + */ + crossesAt?: number; + + /** Name of the axis used for crossing. Vertical axis name should be provided for horizontal axis and vice versa. If the provided name does not belongs to a valid axis, + * then primary X axis or primary Y axis will be used for crossing + * @Default {null} + */ + crossesInAxis?: string; + + /** Options to customize the crosshair label. + */ + crosshairLabel?: PrimaryYAxisCrosshairLabel; + + /** With this setting, you can request axis to calculate intervals approximately equal to your desired interval. + * @Default {null} + */ + desiredIntervals?: number; + + /** Specifies the placement of labels. + * @Default {ej.datavisualization.Chart.LabelPlacement.BetweenTicks. See LabelPlacement} + */ + labelPlacement?: ej.datavisualization.Chart.LabelPlacement | string; + + /** Specifies the position of labels at the edge of the axis. + * @Default {ej.datavisualization.Chart.EdgeLabelPlacement.None. See EdgeLabelPlacement} + */ + edgeLabelPlacement?: ej.datavisualization.Chart.EdgeLabelPlacement | string; + + /** Specifies whether to trim the axis label when the width of the label exceeds the maximumLabelWidth. + * @Default {false} + */ + enableTrim?: boolean; + + /** Options for customizing the font of the axis Labels. + */ + font?: PrimaryYAxisFont; + + /** Specifies the type of interval in date time axis. + * @Default {null. See IntervalType} + */ + intervalType?: ej.datavisualization.Chart.IntervalType | string; + + /** Specifies whether to inverse the axis. + * @Default {false} + */ + isInversed?: boolean; + + /** Custom formatting for axis label and supports all standard formatting type of numerical and date time values. + * @Default {null} + */ + labelFormat?: string; + + /** Specifies the action to take when the axis labels are overlapping with each other. + * @Default {ej.datavisualization.Chart.LabelIntersectAction.None} + */ + labelIntersectAction?: ej.datavisualization.Chart.LabelIntersectAction | string; + + /** Specifies the position of the axis labels. + * @Default {outside. See LabelPosition} + */ + labelPosition?: ej.datavisualization.Chart.LabelPosition | string; + + /** Specifies the position of the axis labels. + * @Default {center. See Alignment} + */ + alignment?: ej.datavisualization.Chart.LabelAlignment | string; + + /** Logarithmic base value. This is applicable only for logarithmic axis. + * @Default {10} + */ + logBase?: number; + + /** Options for customizing major gird lines. + */ + majorGridLines?: PrimaryYAxisMajorGridLines; + + /** Options for customizing the major tick lines. + */ + majorTickLines?: PrimaryYAxisMajorTickLines; + + /** Maximum number of labels to be displayed in every 100 pixels. + * @Default {3} + */ + maximumLabels?: number; + + /** Maximum width of the axis label. When the label exceeds the width, the label gets trimmed when the enableTrim is set to true. + * @Default {ej.datavisualization.Chart.maximumLabelWidth type {int}} + */ + maximumLabelWidth?: number; + + /** Options for customizing the minor grid lines. + */ + minorGridLines?: PrimaryYAxisMinorGridLines; + + /** Options for customizing the minor tick lines. + */ + minorTickLines?: PrimaryYAxisMinorTickLines; + + /** Specifies the number of minor ticks per interval. + * @Default {null} + */ + minorTicksPerInterval?: number; + + /** Unique name of the axis. To associate an axis with the series, you have to set this name to the xAxisName/yAxisName property of the series. + * @Default {null} + */ + name?: string; + + /** Specifies whether to render the axis at the opposite side of its default position. + * @Default {false} + */ + opposedPosition?: boolean; + + /** Specifies the padding for the plot area. + * @Default {10} + */ + plotOffset?: number; + + /** Options to customize the range of the axis. + */ + range?: PrimaryYAxisRange; + + /** Specifies the padding for the axis range. + * @Default {ej.datavisualization.Chart.RangePadding.None. See RangePadding} + */ + rangePadding?: ej.datavisualization.Chart.RangePadding | string; + + /** Rounds the number to the given number of decimals. + * @Default {null} + */ + roundingPlaces?: number; + + /** Specifies the index of the row to which the axis is associated, when the chart area is divided into multiple plot areas by using rowDefinitions. + * @Default {null} + */ + rowIndex?: number; + + /** Specifies the number of row or plot areas an axis has to span vertically. + * @Default {null} + */ + rowSpan?: number; + + /** Options for customizing the multi level labels. + * @Default {[ ]} + */ + multiLevelLabels?: PrimaryYAxisMultiLevelLabel[]; + + /** Options for customizing the strip lines. + * @Default {[ ]} + */ + stripLine?: PrimaryYAxisStripLine[]; + + /** Specifies the position of the axis tick lines. + * @Default {outside. See TickLinesPosition} + */ + tickLinesPosition?: ej.datavisualization.Chart.TickLinesPosition | string; + + /** Options for customizing the border of the labels. + */ + labelBorder?: PrimaryYAxisLabelBorder; + + /** Options for customizing the axis title. + */ + title?: PrimaryYAxisTitle; + + /** Specifies the type of data the axis is handling. + * @Default {null. See ValueType} + */ + valueType?: ej.datavisualization.Chart.ValueType | string; + + /** Show/hides the axis. + * @Default {true} + */ + visible?: boolean; + + /** The axis is scaled by this factor. When zoomFactor is 0.5, the chart is scaled by 200% along this axis. Values ranges from 0 to 1. + * @Default {1} + */ + zoomFactor?: number; + + /** Position of the zoomed axis. Value ranges from 0 to 1 + * @Default {0} + */ + zoomPosition?: number; + } + + export interface RowDefinition { + + /** Specifies the unit to measure the height of the row in plotting area. + * @Default {'pixel'. See Unit} + */ + unit?: ej.datavisualization.Chart.Unit | string; + + /** Height of the row in plotting area. Height is measured in either pixel or percentage based on the value of unit property. + * @Default {50} + */ + rowHeight?: number; + + /** Color of the line that indicates the starting point of the row in plotting area. + * @Default {transparent} + */ + lineColor?: string; + + /** Width of the line that indicates the starting point of the row in plot area. + * @Default {1} + */ + lineWidth?: number; + } + + export interface SeriesBorder { + + /** Border color of the series. + * @Default {transparent} + */ + color?: string; + + /** Border width of the series. + * @Default {1} + */ + width?: number; + + /** DashArray for border of the series. + * @Default {null} + */ + dashArray?: string; + } + + export interface SeriesFont { + + /** Font color of the series text. + * @Default {#707070} + */ + color?: string; + + /** Font Family of the series. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font Style of the series. + * @Default {Normal} + */ + fontStyle?: ej.datavisualization.Chart.FontStyle | string; + + /** Font weight of the series. + * @Default {Regular} + */ + fontWeight?: ej.datavisualization.Chart.FontWeight | string; + + /** Opacity of series text. + * @Default {1} + */ + opacity?: number; + + /** Size of the series text. + * @Default {12px} + */ + size?: string; + } + + export interface SeriesMarkerBorder { + + /** Border color of the marker shape. + * @Default {white} + */ + color?: string; + + /** Border width of the marker shape. + * @Default {3} + */ + width?: number; + } + + export interface SeriesMarkerDataLabelBorder { + + /** Border color of the data label. + * @Default {null} + */ + color?: string; + + /** Border width of the data label. + * @Default {0.1} + */ + width?: number; + } + + export interface SeriesMarkerDataLabelConnectorLine { + + /** Specifies when the connector has to be drawn as Bezier curve or straight line. This is applicable only for Pie and Doughnut chart types. + * @Default {line. See ConnectorLineType} + */ + type?: ej.datavisualization.Chart.Type | string; + + /** Width of the connector. + * @Default {0.5} + */ + width?: number; + + /** Color of the connector. + * @Default {null} + */ + color?: string; + + /** Height of the connector. + * @Default {null} + */ + height?: number; + } + + export interface SeriesMarkerDataLabelFont { + + /** Font family of the data label. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font color of the data label text. + * @Default {null} + */ + color?: string; + + /** Font style of the data label. + * @Default {normal. See FontStyle} + */ + fontStyle?: ej.datavisualization.Chart.FontStyle | string; + + /** Font weight of the data label. + * @Default {regular. See FontWeight} + */ + fontWeight?: ej.datavisualization.Chart.FontWeight | string; + + /** Opacity of the text. + * @Default {1} + */ + opacity?: number; + + /** Font size of the data label. + * @Default {12px} + */ + size?: string; + } + + export interface SeriesMarkerDataLabelMargin { + + /** Bottom margin of the text. + * @Default {5} + */ + bottom?: number; + + /** Left margin of the text. + * @Default {5} + */ + left?: number; + + /** Right margin of the text. + * @Default {5} + */ + right?: number; + + /** Top margin of the text. + * @Default {5} + */ + top?: number; + } + + export interface SeriesMarkerDataLabel { + + /** Angle of the data label in degrees. Only the text gets rotated, whereas the background and border does not rotate. + * @Default {null} + */ + angle?: number; + + /** Maximum label width of the data label. + * @Default {null} + */ + maximumLabelWidth?: number; + + /** Enable the wrap option to the data label. + * @Default {false} + */ + enableWrap?: boolean; + + /** Options for customizing the border of the data label. + */ + border?: SeriesMarkerDataLabelBorder; + + /** Options for displaying and customizing the line that connects point and data label. + */ + connectorLine?: SeriesMarkerDataLabelConnectorLine; + + /** Background color of the data label. + * @Default {null} + */ + fill?: string; + + /** Options for customizing the data label font. + */ + font?: SeriesMarkerDataLabelFont; + + /** Horizontal alignment of the data label. + * @Default {center} + */ + horizontalTextAlignment?: ej.datavisualization.Chart.HorizontalTextAlignment | string; + + /** Margin of the text to its background shape. The size of the background shape increases based on the margin applied to its text. + */ + margin?: SeriesMarkerDataLabelMargin; + + /** Opacity of the data label. + * @Default {1} + */ + opacity?: number; + + /** Background shape of the data label. + * @Default {No shape is rendered by default, so its value is Ă¢â‚¬ËœnoneĂ¢â‚¬â„¢. See Shape} + */ + shape?: ej.datavisualization.Chart.Shape | string; + + /** Name of a field in data source where datalabel text is displayed. + */ + textMappingName?: string; + + /** Specifies the position of the data label. This property can be used only for the series such as column, bar, stacked column, stacked bar, 100% stacked column, 100% stacked bar, candle and OHLC. + * @Default {top. See TextPosition} + */ + textPosition?: ej.datavisualization.Chart.TextPosition | string; + + /** Vertical alignment of the data label. + * @Default {'center'} + */ + verticalTextAlignment?: ej.datavisualization.Chart.VerticalTextAlignment | string; + + /** Controls the visibility of the data labels. + * @Default {false} + */ + visible?: boolean; + + /** Custom template to format the data label content. Use Ă¢â‚¬Å“point.xĂ¢â‚¬Â and Ă¢â‚¬Å“point.yĂ¢â‚¬Â as a placeholder text to display the corresponding data pointĂ¢â‚¬â„¢s x and y value. + */ + template?: string; + + /** Moves the label vertically by some offset. + * @Default {0} + */ + offset?: number; + } + + export interface SeriesMarkerSize { + + /** Height of the marker. + * @Default {6} + */ + height?: number; + + /** Width of the marker. + * @Default {6} + */ + width?: number; + } + + export interface SeriesMarker { + + /** Options for customizing the border of the marker shape. + */ + border?: SeriesMarkerBorder; + + /** Options for displaying and customizing data labels. + */ + dataLabel?: SeriesMarkerDataLabel; + + /** Color of the marker shape. + * @Default {null} + */ + fill?: string; + + /** The URL for the Image that is to be displayed as marker. In order to display image as marker, set series.marker.shape as Ă¢â‚¬ËœimageĂ¢â‚¬â„¢. + */ + imageUrl?: string; + + /** Opacity of the marker. + * @Default {1} + */ + opacity?: number; + + /** Specifies the shape of the marker. + * @Default {circle. See Shape} + */ + shape?: ej.datavisualization.Chart.Shape | string; + + /** Options for customizing the size of the marker shape. + */ + size?: SeriesMarkerSize; + + /** Controls the visibility of the marker shape. + * @Default {false} + */ + visible?: boolean; + } + + export interface SeriesOutlierSettingsSize { + + /** Height of the outlier shape. + * @Default {6} + */ + height?: number; + + /** Width of the outlier shape. + * @Default {6} + */ + width?: number; + } + + export interface SeriesOutlierSettings { + + /** Specifies the shape of the outlier. + * @Default {circle. See Shape} + */ + shape?: ej.datavisualization.Chart.Shape | string; + + /** Options for customizing the size of the outlier shape. + */ + size?: SeriesOutlierSettingsSize; + } + + export interface SeriesEmptyPointSettingsStyleBorder { + + /** Border color of the empty point. + */ + color?: string; + + /** Border width of the empty point. + * @Default {1} + */ + width?: number; + } + + export interface SeriesEmptyPointSettingsStyle { + + /** Color of the empty point. + */ + color?: string; + + /** Options for customizing border of the empty point in the series. + */ + border?: SeriesEmptyPointSettingsStyleBorder; + } + + export interface SeriesEmptyPointSettings { + + /** Controls the visibility of the empty point. + * @Default {true} + */ + visible?: boolean; + + /** Specifies the mode of empty point. + * @Default {gap} + */ + displayMode?: ej.datavisualization.Chart.EmptyPointMode | string; + + /** Options for customizing the color and border of the empty point in the series. + */ + style?: SeriesEmptyPointSettingsStyle; + } + + export interface SeriesConnectorLine { + + /** Width of the connector line. + * @Default {1} + */ + width?: number; + + /** Color of the connector line. + * @Default {#565656} + */ + color?: string; + + /** DashArray of the connector line. + * @Default {null} + */ + dashArray?: string; + + /** Opacity of the connector line. + * @Default {1} + */ + opacity?: number; + } + + export interface SeriesDragSettings { + + /** drag/drop the series + * @Default {false} + */ + enable?: boolean; + + /** Specifies the type of drag settings. + * @Default {xy} + */ + type?: string; + } + + export interface SeriesErrorBarCap { + + /** Show/Hides the error bar cap. + * @Default {true} + */ + visible?: boolean; + + /** Width of the error bar cap. + * @Default {1} + */ + width?: number; + + /** Length of the error bar cap. + * @Default {1} + */ + length?: number; + + /** Color of the error bar cap. + * @Default {#000000} + */ + fill?: string; + } + + export interface SeriesErrorBar { + + /** Show/hides the error bar + * @Default {visible} + */ + visibility?: boolean; + + /** Specifies the type of error bar. + * @Default {FixedValue} + */ + type?: ej.datavisualization.Chart.ErrorBarType | string; + + /** Specifies the mode of error bar. + * @Default {vertical} + */ + mode?: ej.datavisualization.Chart.ErrorBarMode | string; + + /** Specifies the direction of error bar. + * @Default {both} + */ + direction?: ej.datavisualization.Chart.ErrorBarDirection | string; + + /** Value of vertical error bar. + * @Default {3} + */ + verticalErrorValue?: number; + + /** Value of horizontal error bar. + * @Default {1} + */ + horizontalErrorValue?: number; + + /** Value of positive horizontal error bar. + * @Default {1} + */ + horizontalPositiveErrorValue?: number; + + /** Value of negative horizontal error bar. + * @Default {1} + */ + horizontalNegativeErrorValue?: number; + + /** Value of positive vertical error bar. + * @Default {5} + */ + verticalPositiveErrorValue?: number; + + /** Value of negative vertical error bar. + * @Default {5} + */ + verticalNegativeErrorValue?: number; + + /** Fill color of the error bar. + * @Default {#000000} + */ + fill?: string; + + /** Width of the error bar. + * @Default {1} + */ + width?: number; + + /** Options for customizing the error bar cap. + */ + cap?: SeriesErrorBarCap; + } + + export interface SeriesPointsBorder { + + /** Border color of the point. + * @Default {null} + */ + color?: string; + + /** Border width of the point. + * @Default {null} + */ + width?: number; + } + + export interface SeriesPointsMarkerBorder { + + /** Border color of the marker shape. + * @Default {white} + */ + color?: string; + + /** Border width of the marker shape. + * @Default {3} + */ + width?: number; + } + + export interface SeriesPointsMarkerDataLabelBorder { + + /** Border color of the data label. + * @Default {null} + */ + color?: string; + + /** Border width of the data label. + * @Default {0.1} + */ + width?: number; + } + + export interface SeriesPointsMarkerDataLabelConnectorLine { + + /** Specifies when the connector has to be drawn as Bezier curve or straight line. This is applicable only for Pie and Doughnut chart types. + * @Default {line. See ConnectorLineType} + */ + type?: ej.datavisualization.Chart.ConnectorLineType | string; + + /** Width of the connector. + * @Default {0.5} + */ + width?: number; + } + + export interface SeriesPointsMarkerDataLabelFont { + + /** Font family of the data label. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style of the data label. + * @Default {normal. See FontStyle} + */ + fontStyle?: ej.datavisualization.Chart.FontStyle | string; + + /** Font weight of the data label. + * @Default {regular. See FontWeight} + */ + fontWeight?: ej.datavisualization.Chart.FontWeight | string; + + /** Opacity of the text. + * @Default {1} + */ + opacity?: number; + + /** Font size of the data label. + * @Default {12px} + */ + size?: string; + } + + export interface SeriesPointsMarkerDataLabelMargin { + + /** Bottom margin of the text. + * @Default {5} + */ + bottom?: number; + + /** Left margin of the text. + * @Default {5} + */ + left?: number; + + /** Right margin of the text. + * @Default {5} + */ + right?: number; + + /** Top margin of the text. + * @Default {5} + */ + top?: number; + } + + export interface SeriesPointsMarkerDataLabel { + + /** Angle of the data label in degrees. Only the text gets rotated, whereas the background and border does not rotate. + * @Default {null} + */ + angle?: number; + + /** Options for customizing the border of the data label. + */ + border?: SeriesPointsMarkerDataLabelBorder; + + /** Options for displaying and customizing the line that connects point and data label. + */ + connectorLine?: SeriesPointsMarkerDataLabelConnectorLine; + + /** Background color of the data label. + * @Default {null} + */ + fill?: string; + + /** Options for customizing the data label font. + */ + font?: SeriesPointsMarkerDataLabelFont; + + /** Horizontal alignment of the data label. + * @Default {center} + */ + horizontalTextAlignment?: ej.datavisualization.Chart.HorizontalTextAlignment | string; + + /** Margin of the text to its background shape. The size of the background shape increases based on the margin applied to its text. + */ + margin?: SeriesPointsMarkerDataLabelMargin; + + /** Opacity of the data label. + * @Default {1} + */ + opacity?: number; + + /** Background shape of the data label. + * @Default {No shape is rendered by default, so its value is Ă¢â‚¬ËœnoneĂ¢â‚¬â„¢. See Shape} + */ + shape?: ej.datavisualization.Chart.Shape | string; + + /** Specifies the position of the data label. This property can be used only for the series such as column, bar, stacked column, stacked bar, 100% stacked column, 100% stacked bar, candle and OHLC. + * @Default {top. See TextPosition} + */ + textPosition?: ej.datavisualization.Chart.TextPosition | string; + + /** Vertical alignment of the data label. + * @Default {'center'} + */ + verticalTextAlignment?: ej.datavisualization.Chart.VerticalTextAlignment | string; + + /** Controls the visibility of the data labels. + * @Default {false} + */ + visible?: boolean; + + /** Custom template to format the data label content. Use Ă¢â‚¬Å“point.xĂ¢â‚¬Â and Ă¢â‚¬Å“point.yĂ¢â‚¬Â as a placeholder text to display the corresponding data pointĂ¢â‚¬â„¢s x and y value. + */ + template?: string; + + /** Moves the label vertically by specified offset. + * @Default {0} + */ + offset?: number; + } + + export interface SeriesPointsMarkerSize { + + /** Height of the marker. + * @Default {6} + */ + height?: number; + + /** Width of the marker. + * @Default {6} + */ + width?: number; + } + + export interface SeriesPointsMarker { + + /** Options for customizing the border of the marker shape. + */ + border?: SeriesPointsMarkerBorder; + + /** Options for displaying and customizing data label. + */ + dataLabel?: SeriesPointsMarkerDataLabel; + + /** Color of the marker shape. + * @Default {null} + */ + fill?: string; + + /** The URL for the Image that is to be displayed as marker. In order to display image as marker, set series.marker.shape as Ă¢â‚¬ËœimageĂ¢â‚¬â„¢. + */ + imageUrl?: string; + + /** Opacity of the marker. + * @Default {1} + */ + opacity?: number; + + /** Specifies the shape of the marker. + * @Default {circle. See Shape} + */ + shape?: ej.datavisualization.Chart.Shape | string; + + /** Options for customizing the size of the marker shape. + */ + size?: SeriesPointsMarkerSize; + + /** Controls the visibility of the marker shape. + * @Default {false} + */ + visible?: boolean; + } + + export interface SeriesPoint { + + /** Options for customizing the border of a point. This is applicable only for column type series and accumulation type series. + */ + border?: SeriesPointsBorder; + + /** Enables or disables the visibility of legend item. + * @Default {visible} + */ + visibleOnLegend?: string; + + /** To show/hide the intermediate summary from the last intermediate point. + * @Default {false} + */ + showIntermediateSum?: boolean; + + /** To show/hide the total summary of the waterfall series. + * @Default {false} + */ + showTotalSum?: boolean; + + /** Close value of the point. Close value is applicable only for financial type series. + * @Default {null} + */ + close?: number; + + /** Size of a bubble in the bubble series. This is applicable only for the bubble series. + * @Default {null} + */ + size?: number; + + /** Background color of the point. This is applicable only for column type series and accumulation type series. + * @Default {null} + */ + fill?: string; + + /** High value of the point. High value is applicable only for financial type series, range area series and range column series. + * @Default {null} + */ + high?: number; + + /** Low value of the point. Low value is applicable only for financial type series, range area series and range column series. + * @Default {null} + */ + low?: number; + + /** Options for displaying and customizing marker for a data point. Marker contains shapes and/or data labels. + */ + marker?: SeriesPointsMarker; + + /** Open value of the point. This is applicable only for financial type series. + * @Default {null} + */ + open?: number; + + /** Datalabel text for the point. + * @Default {null} + */ + text?: string; + + /** X value of the point. + * @Default {null} + */ + x?: number; + + /** Y value of the point. + * @Default {null} + */ + y?: number; + } + + export interface SeriesCornerRadius { + + /** Specifies the radius for the top left corner. + * @Default {0} + */ + topLeft?: number; + + /** Specifies the radius for the top right corner. + * @Default {0} + */ + topRight?: number; + + /** Specifies the radius for the bottom left corner. + * @Default {0} + */ + bottomLeft?: number; + + /** Specifies the radius for the bottom right corner. + * @Default {0} + */ + bottomRight?: number; + } + + export interface SeriesTooltipBorder { + + /** Border Color of the tooltip. + * @Default {null} + */ + color?: string; + + /** Border Width of the tooltip. + * @Default {1} + */ + width?: number; + } + + export interface SeriesTooltip { + + /** Options for customizing the border of the tooltip. + */ + border?: SeriesTooltipBorder; + + /** Customize the corner radius of the tooltip rectangle. + * @Default {0} + */ + rx?: number; + + /** Customize the corner radius of the tooltip rectangle. + * @Default {0} + */ + ry?: number; + + /** Specifies the duration, the tooltip has to be displayed. + * @Default {500ms} + */ + duration?: string; + + /** Enables/disables the animation of the tooltip when moving from one point to another. + * @Default {true} + */ + enableAnimation?: boolean; + + /** Background color of the tooltip. + * @Default {null} + */ + fill?: string; + + /** Format of the tooltip content. + * @Default {#point.x# : #point.y#} + */ + format?: string; + + /** Opacity of the tooltip. + * @Default {0.95} + */ + opacity?: number; + + /** Custom template to format the tooltip content. Use Ă¢â‚¬Å“point.xĂ¢â‚¬Â and Ă¢â‚¬Å“point.yĂ¢â‚¬Â as a placeholder text to display the corresponding data pointĂ¢â‚¬â„¢s x and y value. + * @Default {null} + */ + template?: string; + + /** Controls the visibility of the tooltip. + * @Default {false} + */ + visible?: boolean; + } + + export interface SeriesTrendline { + + /** Show/hides the trendline. + */ + visibility?: boolean; + + /** Specifies the type of trendline for the series. + * @Default {linear. See TrendlinesType} + */ + type?: string; + + /** Name for the trendlines that is to be displayed in legend text. + * @Default {Trendline} + */ + name?: string; + + /** Fill color of the trendlines. + * @Default {#0000FF} + */ + fill?: string; + + /** Width of the trendlines. + * @Default {1} + */ + width?: number; + + /** Opacity of the trendline. + * @Default {1} + */ + opacity?: number; + + /** Pattern of dashes and gaps used to stroke the trendline. + */ + dashArray?: string; + + /** Future trends of the current series. + * @Default {0} + */ + forwardForecast?: number; + + /** Past trends of the current series. + * @Default {0} + */ + backwardForecast?: number; + + /** Specifies the order of polynomial trendlines. + * @Default {0} + */ + polynomialOrder?: number; + + /** Specifies the moving average starting period value. + * @Default {2} + */ + period?: number; + } + + export interface SeriesHighlightSettingsBorder { + + /** Border color of the series/point on highlight. + */ + color?: string; + + /** Border width of the series/point on highlight. + * @Default {2} + */ + width?: string; + } + + export interface SeriesHighlightSettings { + + /** Enables/disables the ability to highlight series or data point interactively. + * @Default {false} + */ + enable?: boolean; + + /** Specifies whether series or data point has to be highlighted. + * @Default {series. See Mode} + */ + mode?: ej.datavisualization.Chart.Mode | string; + + /** Color of the series/point on highlight. + */ + color?: string; + + /** Opacity of the series/point on highlight. + * @Default {0.6} + */ + opacity?: number; + + /** Options for customizing the border of series on highlight. + */ + border?: SeriesHighlightSettingsBorder; + + /** Specifies the pattern for the series/point on highlight. + * @Default {none. See Pattern} + */ + pattern?: string; + + /** Custom pattern for the series on highlight. + */ + customPattern?: string; + } + + export interface SeriesSelectionSettingsBorder { + + /** Border color of the series/point on selection. + */ + color?: string; + + /** Border width of the series/point on selection. + * @Default {2} + */ + width?: string; + } + + export interface SeriesSelectionSettings { + + /** Enables/disables the ability to select a series/data point interactively. + * @Default {false} + */ + enable?: boolean; + + /** Specifies whether series or data point has to be selected. + * @Default {series. See Mode} + */ + mode?: ej.datavisualization.Chart.Mode | string; + + /** Specifies the type of selection. + * @Default {single} + */ + type?: ej.datavisualization.Chart.SelectionType | string; + + /** Specifies the drawn rectangle type. + * @Default {xy} + */ + rangeType?: ej.datavisualization.Chart.RangeType | string; + + /** Color of the series/point on selection. + */ + color?: string; + + /** Opacity of the series/point on selection. + * @Default {0.6} + */ + opacity?: number; + + /** Options for customizing the border of series on selection. + */ + border?: SeriesSelectionSettingsBorder; + + /** Specifies the pattern for the series/point on selection. + * @Default {none. See Pattern} + */ + pattern?: string; + + /** Custom pattern for the series on selection. + */ + customPattern?: string; + } + + export interface Series { + + /** Color of the point, where the close is up in financial chart. + * @Default {null} + */ + bearFillColor?: string; + + /** Options for customizing the border of the series. + */ + border?: SeriesBorder; + + /** Color of the point, where the close is down in financial chart. + * @Default {null} + */ + bullFillColor?: string; + + /** To render the column and bar type series in rectangle/cylinder shape. See ColumnFacet + * @Default {rectangle} + */ + columnFacet?: ej.datavisualization.Chart.ColumnFacet | string; + + /** Relative width of the columns in column type series. Value ranges from 0 to 1. Width also depends upon columnSpacing property. + * @Default {0.7} + */ + columnWidth?: number; + + /** Spacing between columns of different series. Value ranges from 0 to 1 + * @Default {0} + */ + columnSpacing?: number; + + /** To group the series of stacking collection. + */ + stackingGroup?: string; + + /** Pattern of dashes and gaps used to stroke the line type series. + */ + dashArray?: string; + + /** Specifies the dataSource for the series. It can be an array of JSON objects or an instance of ej.DataManager. + * @Default {null} + */ + dataSource?: any; + + /** Controls the size of the hole in doughnut series. Value ranges from 0 to 1. + * @Default {0.4} + */ + doughnutCoefficient?: number; + + /** Controls the size of the doughnut series. Value ranges from 0 to 1. + * @Default {0.8} + */ + doughnutSize?: number; + + /** Type of series to be drawn in radar or polar series. + * @Default {line. See DrawType} + */ + drawType?: ej.datavisualization.Chart.DrawType | string; + + /** Enable/disable the animation of series. + * @Default {false} + */ + enableAnimation?: boolean; + + /** To avoid overlapping of data labels smartly. + * @Default {null} + */ + enableSmartLabels?: number; + + /** End angle of pie/doughnut series. For a complete circle, it has to be 360, by default. + * @Default {null} + */ + endAngle?: number; + + /** Explodes the pie/doughnut slices on mouse move. + * @Default {false} + */ + explode?: boolean; + + /** Explodes all the slice of pie/doughnut on render. + * @Default {null} + */ + explodeAll?: boolean; + + /** Index of the point to be exploded from pie/doughnut/pyramid/funnel. + * @Default {null} + */ + explodeIndex?: number; + + /** Specifies the distance of the slice from the center, when it is exploded. + * @Default {25} + */ + explodeOffset?: number; + + /** Fill color of the series. + * @Default {null} + */ + fill?: string; + + /** Options for customizing the series font. + */ + font?: SeriesFont; + + /** Specifies the height of the funnel in funnel series. Values can be in both pixel and percentage. + * @Default {32.7%} + */ + funnelHeight?: string; + + /** Specifies the width of the funnel in funnel series. Values can be in both pixel and percentage. + * @Default {11.6%} + */ + funnelWidth?: string; + + /** Gap between the slices of pyramid/funnel series. + * @Default {0} + */ + gapRatio?: number; + + /** Specifies whether to join start and end point of a line/area series used in polar/radar chart to form a closed path. + * @Default {true} + */ + isClosed?: boolean; + + /** Specifies whether to stack the column series in polar/radar charts. + * @Default {true} + */ + isStacking?: boolean; + + /** Renders the chart vertically. This is applicable only for Cartesian type series. + * @Default {false} + */ + isTransposed?: boolean; + + /** Render the x mark in the center of the box and whisker series type.x represents the average value of the box and whisker series. + * @Default {true} + */ + showMedian?: boolean; + + /** Position of the data label in pie/doughnut/pyramid/funnel series. OutsideExtended position is not applicable for pyramid/funnel. + * @Default {inside. See LabelPosition} + */ + labelPosition?: ej.datavisualization.Chart.LabelPosition | string; + + /** Quartile calculation has been performed in three different formulas to render the boxplot series . + * @Default {exclusive} + */ + boxPlotMode?: ej.datavisualization.Chart.LabelPosition | string; + + /** Specifies the line cap of the series. + * @Default {Butt. See LineCap} + */ + lineCap?: ej.datavisualization.Chart.LineCap | string; + + /** Specifies the type of shape to be used where two lines meet. + * @Default {Round. See LineJoin} + */ + lineJoin?: ej.datavisualization.Chart.LineJoin | string; + + /** Options for displaying and customizing marker for individual point in a series. Marker contains shapes and/or data labels. + */ + marker?: SeriesMarker; + + /** Name of the series, that is to be displayed in the legend. + * @Default {Add a comment to this line} + */ + name?: string; + + /** Opacity of the series. + * @Default {1} + */ + opacity?: number; + + /** Options for customizing the outlier of individual series. + */ + outlierSettings?: SeriesOutlierSettings; + + /** Name of a field in data source where fill color for all the data points is generated. + */ + palette?: string; + + /** Controls the size of pie series. Value ranges from 0 to 1. + * @Default {0.8} + */ + pieCoefficient?: number; + + /** Options for customizing the empty point in the series. + */ + emptyPointSettings?: SeriesEmptyPointSettings; + + /** Fill color for the positive column of the waterfall. + * @Default {null} + */ + positiveFill?: string; + + /** Options for customizing the waterfall connector line. + */ + connectorLine?: SeriesConnectorLine; + + /** Options to customize the drag and drop in series. + */ + dragSettings?: SeriesDragSettings; + + /** Options to customize the error bar in series. + */ + errorBar?: SeriesErrorBar; + + /** Option to add data points; each point should have x and y property. Also, optionally, you can customize the points color, border, marker by using fill, border and marker options. + */ + points?: SeriesPoint[]; + + /** Specifies the mode of the pyramid series. + * @Default {linear} + */ + pyramidMode?: ej.datavisualization.Chart.PyramidMode | string; + + /** Specifies ej.Query to select data from dataSource. This property is applicable only when the dataSource is ej.DataManager. + * @Default {null} + */ + query?: any; + + /** Start angle from where the pie/doughnut series renders. It starts from 0, by default. + * @Default {null} + */ + startAngle?: number; + + /** Options for customizing the corner radius. cornerRadius property also takes the numeric input and applies it for all the four corners of the column. + */ + cornerRadius?: SeriesCornerRadius; + + /** Options for customizing the tooltip of chart. + */ + tooltip?: SeriesTooltip; + + /** Specifies the type of the series to render in chart. + * @Default {column. see Type} + */ + type?: ej.datavisualization.Chart.Type | string; + + /** Controls the visibility of the series. + * @Default {visible} + */ + visibility?: string; + + /** Enables or disables the visibility of legend item. + * @Default {visible} + */ + visibleOnLegend?: string; + + /** Specifies the name of the x-axis that has to be associated with this series. Add an axis instance with this name to axes collection. + * @Default {null} + */ + xAxisName?: string; + + /** Name of the property in the datasource that contains x value for the series. + * @Default {null} + */ + xName?: string; + + /** Specifies the name of the y-axis that has to be associated with this series. Add an axis instance with this name to axes collection. + * @Default {null} + */ + yAxisName?: string; + + /** Name of the property in the datasource that contains y value for the series. + * @Default {null} + */ + yName?: string; + + /** Name of the property in the datasource that contains high value for the series. + * @Default {null} + */ + high?: string; + + /** Name of the property in the datasource that contains low value for the series. + * @Default {null} + */ + low?: string; + + /** Name of the property in the datasource that contains open value for the series. + * @Default {null} + */ + open?: string; + + /** Name of the property in the datasource that contains close value for the series. + * @Default {null} + */ + close?: string; + + /** Name of the property in the datasource that contains fill color for the series. + * @Default {null} + */ + pointColorMappingName?: string; + + /** Z-order of the series. + * @Default {0} + */ + zOrder?: number; + + /** Name of the property in the datasource that contains the size value for the bubble series. + * @Default {null} + */ + size?: string; + + /** Option to add trendlines to chart. + */ + trendlines?: SeriesTrendline[]; + + /** Options for customizing the appearance of the series or data point while highlighting. + */ + highlightSettings?: SeriesHighlightSettings; + + /** Options for customizing the appearance of the series/data point on selection. + */ + selectionSettings?: SeriesSelectionSettings; + } + + export interface Size { + + /** Height of the Chart. Height can be specified in either pixel or percentage. + * @Default {'450'} + */ + height?: string; + + /** Width of the Chart. Width can be specified in either pixel or percentage. + * @Default {'450'} + */ + width?: string; + } + + export interface TitleBorder { + + /** Width of the title border. + * @Default {1} + */ + width?: number; + + /** color of the title border. + * @Default {transparent} + */ + color?: string; + + /** opacity of the title border. + * @Default {0.8} + */ + opacity?: number; + + /** opacity of the title border. + * @Default {0.8} + */ + cornerRadius?: number; + } + + export interface TitleFont { + + /** Font family for Chart title. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style for Chart title. + * @Default {Normal. See FontStyle} + */ + fontStyle?: ej.datavisualization.Chart.FontStyle | string; + + /** Font weight for Chart title. + * @Default {Regular. See FontWeight} + */ + fontWeight?: ej.datavisualization.Chart.FontWeight | string; + + /** Opacity of the Chart title. + * @Default {0.5} + */ + opacity?: number; + + /** Font size for Chart title. + * @Default {20px} + */ + size?: string; + } + + export interface TitleSubTitleFont { + + /** Font family of sub title. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style for sub title. + * @Default {Normal. See FontStyle} + */ + fontStyle?: ej.datavisualization.Chart.FontStyle | string; + + /** Font weight for sub title. + * @Default {Regular. See FontWeight} + */ + fontWeight?: ej.datavisualization.Chart.FontWeight | string; + + /** Opacity of the sub title. + * @Default {1} + */ + opacity?: number; + + /** Font size for sub title. + * @Default {12px} + */ + size?: string; + } + + export interface TitleSubTitleBorder { + + /** Width of the subtitle border. + * @Default {1} + */ + width?: number; + + /** color of the subtitle border. + * @Default {transparent} + */ + color?: string; + + /** opacity of the subtitle border. + * @Default {0.8} + */ + opacity?: number; + + /** opacity of the subtitle border. + * @Default {0.8} + */ + cornerRadius?: number; + } + + export interface TitleSubTitle { + + /** Options for customizing the font of sub title. + */ + font?: TitleSubTitleFont; + + /** Background color for the chart subtitle. + * @Default {transparent} + */ + background?: string; + + /** Options to customize the border of the title. + */ + border?: TitleSubTitleBorder; + + /** Text to be displayed in sub title. + */ + text?: string; + + /** Alignment of sub title text. + * @Default {far. See TextAlignment} + */ + textAlignment?: ej.datavisualization.Chart.Alignment | string; + } + + export interface Title { + + /** Background color for the chart title. + * @Default {transparent} + */ + background?: string; + + /** Options to customize the border of the title. + */ + border?: TitleBorder; + + /** Options for customizing the font of Chart title. + */ + font?: TitleFont; + + /** Options to customize the sub title of Chart. + */ + subTitle?: TitleSubTitle; + + /** Text to be displayed in Chart title. + */ + text?: string; + + /** Alignment of the title text. + * @Default {Center. See TextAlignment} + */ + textAlignment?: ej.datavisualization.Chart.Alignment | string; + } + + export interface Zooming { + + /** Enables or disables zooming. + * @Default {false} + */ + enable?: boolean; + + /** Enables or disables pinch zooming. + * @Default {true} + */ + enablePinching?: boolean; + + /** Enable or disables the differed zooming. When it is enabled, chart is updated only on mouse up action while zooming and panning. + * @Default {false} + */ + enableDeferredZoom?: boolean; + + /** Enables/disables the ability to zoom the chart on moving the mouse wheel. + * @Default {false} + */ + enableMouseWheel?: boolean; + + /** Specifies whether to allow zooming the chart vertically or horizontally or in both ways. + * @Default {'x,y'} + */ + type?: string; + + /** Toggles the visibility of the scrollbar, which will be displayed while zooming. + * @Default {false} + */ + enableScrollbar?: boolean; + + /** To display user specified buttons in zooming toolbar. + * @Default {[zoomIn, zoomOut, zoom, pan, reset]} + */ + toolbarItems?: any[]; + } + } + namespace Chart { + enum CoordinateUnit { + //string + None, + //string + Pixels, + //string + Points, + } + } + namespace Chart { + enum HorizontalAlignment { + //string + Left, + //string + Right, + //string + Middle, + } + } + namespace Chart { + enum Region { + //string + Chart, + //string + Series, + } + } + namespace Chart { + enum VerticalAlignment { + //string + Top, + //string + Bottom, + //string + Middle, + } + } + namespace Chart { + enum ExportingType { + //string + PNG, + //string + JPG, + //string + PDF, + //string + DOCX, + //string + XLSX, + //string + SVG, + } + } + namespace Chart { + enum ExportingOrientation { + //string + Portrait, + //string + Landscape, + } + } + namespace Chart { + enum ExportingMode { + //string + ServerSide, + //string + ClientSide, + } + } + namespace Chart { + enum Unit { + //string + Percentage, + //string + Pixel, + } + } + namespace Chart { + enum ColumnFacet { + //string + Rectangle, + //string + Cylinder, + } + } + namespace Chart { + enum DrawType { + //string + Line, + //string + Area, + //string + Column, + } + } + namespace Chart { + enum FontStyle { + //string + Normal, + //string + Italic, + } + } + namespace Chart { + enum FontWeight { + //string + Regular, + //string + Bold, + //string + Lighter, + } + } + namespace Chart { + enum LabelPosition { + //string + Inside, + //string + Outside, + //string + OutsideExtended, + } + } + namespace Chart { + enum boxPlotMode { + //string + Exclusive, + //string + Inclusive, + //string + Normal, + } + } + namespace Chart { + enum LineCap { + //string + Butt, + //string + Round, + //string + Square, + } + } + namespace Chart { + enum LineJoin { + //string + Round, + //string + Bevel, + //string + Miter, + } + } + namespace Chart { + enum ConnectorLineType { + //string + Line, + //string + Bezier, + } + } + namespace Chart { + enum HorizontalTextAlignment { + //string + Center, + //string + Near, + //string + Far, + } + } + namespace Chart { + enum Shape { + //string + None, + //string + LeftArrow, + //string + RightArrow, + //string + Circle, + //string + Cross, + //string + HorizLine, + //string + VertLine, + //string + Diamond, + //string + Rectangle, + //string + Triangle, + //string + Hexagon, + //string + Pentagon, + //string + Star, + //string + Ellipse, + //string + Trapezoid, + //string + UpArrow, + //string + DownArrow, + //string + Image, + //string + SeriesType, + } + } + namespace Chart { + enum TextPosition { + //string + Top, + //string + Bottom, + //string + Middle, + } + } + namespace Chart { + enum VerticalTextAlignment { + //string + Center, + //string + Near, + //string + Far, + } + } + namespace Chart { + enum PyramidMode { + //string + Linear, + //string + Surface, + } + } + namespace Chart { + enum Type { + //string + Area, + //string + Line, + //string + Spline, + //string + Column, + //string + Scatter, + //string + Bubble, + //string + SplineArea, + //string + StepArea, + //string + StepLine, + //string + Pie, + //string + HiLo, + //string + HiLoOpenClose, + //string + Candle, + //string + Bar, + //string + StackingArea, + //string + StackingArea100, + //string + RangeColumn, + //string + StackingColumn, + //string + StackingColumn100, + //string + StackingBar, + //string + StackingBar100, + //string + Pyramid, + //string + Funnel, + //string + Doughnut, + //string + Polar, + //string + Radar, + //string + RangeArea, + } + } + namespace Chart { + enum EmptyPointMode { + //string + Gap, + //string + Zero, + //string + Average, + } + } + namespace Chart { + enum ErrorBarType { + //string + FixedValue, + //string + Percentage, + //string + StandardDeviation, + //string + StandardError, + } + } + namespace Chart { + enum ErrorBarMode { + //string + Both, + //string + Vertical, + //string + Horizontal, + } + } + namespace Chart { + enum ErrorBarDirection { + //string + Both, + //string + Plus, + //string + Minus, + } + } + namespace Chart { + enum Mode { + //string + Series, + //string + Point, + //string + Cluster, + //string + Range, + } + } + namespace Chart { + enum SelectionType { + //string + Single, + //string + Multiple, + } + } + namespace Chart { + enum RangeType { + //string + XY, + //string + X, + //string + Y, + } + } + namespace Chart { + enum CrosshairMode { + //string + Float, + //string + Grouping, + } + } + namespace Chart { + enum CrosshairType { + //string + Crosshair, + //string + Trackball, + } + } + namespace Chart { + enum Alignment { + //string + Center, + //string + Near, + //string + Far, + } + } + namespace Chart { + enum Position { + //string + Left, + //string + Right, + //string + Top, + //string + Bottom, + } + } + namespace Chart { + enum TextOverflow { + //string + None, + //string + Trim, + //string + Wrap, + //string + WrapAndTrim, + } + } + namespace Chart { + enum LabelPlacement { + //string + OnTicks, + //string + BetweenTicks, + } + } + namespace Chart { + enum EdgeLabelPlacement { + //string + None, + //string + Shift, + //string + Hide, + } + } + namespace Chart { + enum IntervalType { + //string + Days, + //string + Hours, + //string + Seconds, + //string + Milliseconds, + //string + Minutes, + //string + Months, + //string + Years, + } + } + namespace Chart { + enum LabelIntersectAction { + //string + None, + //string + Rotate90, + //string + Rotate45, + //string + Wrap, + //string + WrapByword, + //string + Trim, + //string + Hide, + //string + MultipleRows, + } + } + namespace Chart { + enum LabelAlignment { + //string + Near, + //string + Far, + //string + Center, + } + } + namespace Chart { + enum RangePadding { + //string + Additional, + //string + Normal, + //string + None, + //string + Round, + } + } + namespace Chart { + enum MultiLevelLabelsBorderType { + //string + Rectangle, + //string + None, + //string + WithoutTopAndBottom, + //string + Brace, + //string + CurlyBrace, + } + } + namespace Chart { + enum TextAlignment { + //string + MiddleTop, + //string + MiddleCenter, + //string + MiddleBottom, + } + } + namespace Chart { + enum ZIndex { + //string + Inside, + //string + Over, + } + } + namespace Chart { + enum TickLinesPosition { + //string + Inside, + //string + Outside, + } + } + namespace Chart { + enum ValueType { + //string + Double, + //string + Category, + //string + DateTime, + //string + Logarithmic, + } + } + namespace Chart { + enum Theme { + //string + Azure, + //string + FlatLight, + //string + FlatDark, + //string + Azuredark, + //string + Lime, + //string + LimeDark, + //string + Saffron, + //string + SaffronDark, + //string + GradientLight, + //string + GradientDark, + } + } + + class RangeNavigator extends ej.Widget { + static fn: RangeNavigator; + constructor(element: JQuery | Element, options?: RangeNavigator.Model); + static Locale: any; + model: RangeNavigator.Model; + defaults: RangeNavigator.Model; + + /** destroy the range navigator widget + * @returns {void} + */ + _destroy(): void; + } + export namespace RangeNavigator { + + export interface Model { + + /** Toggles the placement of slider exactly on the place it left or on the nearest interval. + * @Default {false} + */ + allowSnapping?: boolean; + + /** Options for customizing the color, opacity and width of the chart border. + */ + border?: Border; + + /** Specifies the data source for range navigator. + */ + dataSource?: any; + + /** Specifies the properties used for customizing the range series. + */ + series?: Series[]; + + /** Toggles the redrawing of chart on moving the sliders. + * @Default {true} + */ + enableDeferredUpdate?: boolean; + + /** Enable the scrollbar option in the rangenavigator. + * @Default {false} + */ + enableScrollbar?: boolean; + + /** Toggles the direction of rendering the range navigator control. + * @Default {false} + */ + enableRTL?: boolean; + + /** Sets a value whether to make the range navigator responsive on resize. + * @Default {false} + */ + isResponsive?: boolean; + + /** Options for customizing the labels colors, font, style, size, horizontalAlignment and opacity. + */ + labelSettings?: LabelSettings; + + /** This property is to specify the localization of range navigator. + * @Default {en-US} + */ + locale?: string; + + /** Options for customizing the range navigator. + */ + navigatorStyleSettings?: NavigatorStyleSettings; + + /** Padding specifies the gap between the container and the range navigator. + * @Default {0} + */ + padding?: string; + + /** If the range is not given explicitly, range will be calculated automatically. + * @Default {none} + */ + rangePadding?: ej.datavisualization.RangeNavigator.RangePadding | string; + + /** Options for customizing the starting and ending ranges. + */ + rangeSettings?: RangeSettings; + + /** selectedData is for getting the data when the "rangeChanged" event trigger from client side. + */ + selectedData?: any; + + /** Options for customizing the start and end range values. + */ + selectedRangeSettings?: SelectedRangeSettings; + + /** Options for rendering scrollbar based on the start and end range values. + */ + scrollRangeSettings?: ScrollRangeSettings; + + /** Contains property to customize the hight and width of range navigator. + */ + sizeSettings?: SizeSettings; + + /** By specifying this property the user can change the theme of the range navigator. + * @Default {null} + */ + theme?: string; + + /** Options for customizing the tooltip in range navigator. + */ + tooltipSettings?: TooltipSettings; - /** Options for configuring minor grid lines, major grid lines, axis line of axis. - */ - valueAxisSettings?: ValueAxisSettings; + /** Options for configuring minor grid lines, major grid lines, axis line of axis. + */ + valueAxisSettings?: ValueAxisSettings; - /** You can plot data of type date time or numeric. This property determines the type of data that this axis will handle. - * @Default {datetime} - */ - valueType?: ej.datavisualization.RangeNavigator.ValueType|string; + /** You can plot data of type date time or numeric. This property determines the type of data that this axis will handle. + * @Default {datetime} + */ + valueType?: ej.datavisualization.RangeNavigator.ValueType | string; - /** Specifies the xName for dataSource. This is used to take the x values from dataSource - */ - xName?: any; + /** Specifies the xName for dataSource. This is used to take the x values from dataSource + */ + xName?: any; - /** Specifies the yName for dataSource. This is used to take the y values from dataSource - */ - yName?: any; + /** Specifies the yName for dataSource. This is used to take the y values from dataSource + */ + yName?: any; - /** Fires on load of range navigator. */ - load?(e: LoadEventArgs): void; + /** Fires on load of range navigator. */ + load?(e: LoadEventArgs): void; - /** Fires after range navigator is loaded. */ - loaded?(e: LoadedEventArgs): void; + /** Fires after range navigator is loaded. */ + loaded?(e: LoadedEventArgs): void; - /** Fires on changing the range of range navigator. */ - rangeChanged?(e: RangeChangedEventArgs): void; + /** Fires on changing the range of range navigator. */ + rangeChanged?(e: RangeChangedEventArgs): void; - /** Fires on changing the scrollbar position of range navigator. */ - scrollChanged?(e: ScrollChangedEventArgs): void; + /** Fires on changing the scrollbar position of range navigator. */ + scrollChanged?(e: ScrollChangedEventArgs): void; - /** Fires on when starting to change the scrollbar position of range navigator. */ - scrollStart?(e: ScrollStartEventArgs): void; + /** Fires on when starting to change the scrollbar position of range navigator. */ + scrollStart?(e: ScrollStartEventArgs): void; - /** Fires on changes ending the scrollbar position of range navigator. */ - scrollEnd?(e: ScrollEndEventArgs): void; -} + /** Fires on changes ending the scrollbar position of range navigator. */ + scrollEnd?(e: ScrollEndEventArgs): void; + } -export interface LoadEventArgs { + export interface LoadEventArgs { - /** parameters from range navigator - */ - Data?: any; + /** parameters from range navigator + */ + Data?: any; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the range navigator model - */ - model?: any; + /** returns the range navigator model + */ + model?: any; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface LoadedEventArgs { + export interface LoadedEventArgs { - /** parameters from range navigator - */ - Data?: any; + /** parameters from range navigator + */ + Data?: any; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the range navigator model - */ - model?: any; + /** returns the range navigator model + */ + model?: any; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface RangeChangedEventArgs { + export interface RangeChangedEventArgs { - /** parameters from range navigator - */ - Data?: any; + /** parameters from range navigator + */ + Data?: any; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the range navigator model - */ - model?: any; + /** returns the range navigator model + */ + model?: any; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface ScrollChangedEventArgs { + export interface ScrollChangedEventArgs { - /** parameters from RangeNavigator - */ - data?: any; + /** parameters from RangeNavigator + */ + data?: any; - /** returns the scrollbar position old start and end range value on changing scrollbar - */ - dataoldRange?: any; + /** returns the scrollbar position old start and end range value on changing scrollbar + */ + dataoldRange?: any; - /** returns the scrollbar position new start and end range value on changing scrollbar - */ - datanewRange?: any; + /** returns the scrollbar position new start and end range value on changing scrollbar + */ + datanewRange?: any; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the RangeNavigator model - */ - model?: any; + /** returns the RangeNavigator model + */ + model?: any; - /** returns the name of the event - */ - type?: string; -} + /** returns the name of the event + */ + type?: string; + } -export interface ScrollStartEventArgs { + export interface ScrollStartEventArgs { - /** parameters from RangeNavigator - */ - data?: any; + /** parameters from RangeNavigator + */ + data?: any; - /** returns the scrollbar position starting range value on changing scrollbar - */ - datastartRange?: string; + /** returns the scrollbar position starting range value on changing scrollbar + */ + datastartRange?: string; - /** returns the scrollbar position end range value on changing scrollbar - */ - dataendRange?: string; + /** returns the scrollbar position end range value on changing scrollbar + */ + dataendRange?: string; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the RangeNavigator model - */ - model?: any; + /** returns the RangeNavigator model + */ + model?: any; - /** returns the name of the event - */ - type?: string; -} - -export interface ScrollEndEventArgs { - - /** parameters from RangeNavigator - */ - data?: any; - - /** returns the scrollbar position old start and end range value on change end of scrollbar - */ - dataoldRange?: any; - - /** returns the scrollbar position new start and end range value on change end of scrollbar - */ - datanewRange?: any; - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the RangeNavigator model - */ - model?: any; - - /** returns the name of the event - */ - type?: string; -} - -export interface Border { - - /** Border color of rangenavigator. When enable the scrollbar, the default color will be set as "#B4B4B4". - * @Default {transparent} - */ - color?: string; - - /** Opacity of the rangeNavigator border. - * @Default {1} - */ - opacity?: number; - - /** Width of the RangeNavigator border. - * @Default {1} - */ - width?: number; -} - -export interface Series { - - /** Name of the property in the datasource that contains x value for the series. - * @Default {null} - */ - xName?: string; - - /** Name of the property in the datasource that contains y value for the series. - * @Default {null} - */ - yName?: string; - - /** Specifies the dataSource for the series. It can be an array of JSON objects or an instance of ej.DataManager. - * @Default {null} - */ - dataSource?: any; - - /** Specifies the type of the series to render in chart. - * @Default {column. see Type} - */ - type?: ej.datavisualization.RangeNavigator.Type|string; - - /** Enable/disable the animation of series. - * @Default {false} - */ - enableAnimation?: boolean; - - /** Fill color of the series. - * @Default {null} - */ - fill?: string; -} - -export interface LabelSettingsHigherLevelBorder { - - /** Specifies the border color of grid lines. - * @Default {transparent} - */ - color?: string; - - /** Specifies the border width of grid lines. - * @Default {0.5} - */ - width?: string; -} - -export interface LabelSettingsHigherLevelGridLineStyle { - - /** Specifies the color of grid lines in higher level. - * @Default {#B5B5B5} - */ - color?: string; - - /** Specifies the dashArray of grid lines in higher level. - * @Default {20 5 0} - */ - dashArray?: string; - - /** Specifies the width of grid lines in higher level. - * @Default {#B5B5B5} - */ - width?: string; -} - -export interface LabelSettingsHigherLevelStyleFont { - - /** Specifies the label font color. Labels render with the specified font color. - * @Default {black} - */ - color?: string; - - /** Specifies the label font family. Labels render with the specified font family. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Specifies the label font style. Labels render with the specified font style. - * @Default {Normal} - */ - fontStyle?: string; - - /** Specifies the label font weight. Labels render with the specified font weight. - * @Default {regular} - */ - fontWeight?: string; - - /** Specifies the label opacity. Labels render with the specified opacity. - * @Default {1} - */ - opacity?: number; - - /** Specifies the label font size. Labels render with the specified font size. - * @Default {12px} - */ - size?: string; -} - -export interface LabelSettingsHigherLevelStyle { - - /** Options for customizing the font properties. - */ - font?: LabelSettingsHigherLevelStyleFont; - - /** Specifies the horizontal text alignment of the text in label. - * @Default {middle} - */ - horizontalAlignment?: string; -} - -export interface LabelSettingsHigherLevel { - - /** Options for customizing the border of grid lines in higher level. - */ - border?: LabelSettingsHigherLevelBorder; - - /** Specifies the fill color of higher level labels. - * @Default {transparent} - */ - fill?: string; - - /** Options for customizing the grid line colors, width, dashArray, border. - */ - gridLineStyle?: LabelSettingsHigherLevelGridLineStyle; - - /** Specifies the intervalType for higher level labels. See IntervalType - * @Default {auto} - */ - intervalType?: ej.datavisualization.RangeNavigator.IntervalType|string; - - /** Specifies the position of the labels to render either inside or outside of plot area - * @Default {outside} - */ - labelPlacement?: ej.datavisualization.RangeNavigator.LabelPlacement|string; - - /** Specifies the position of the labels in higher level - * @Default {top} - */ - position?: ej.datavisualization.RangeNavigator.Position|string; - - /** Options for customizing the style of higher level labels. - */ - style?: LabelSettingsHigherLevelStyle; - - /** Toggles the visibility of higher level labels. - * @Default {true} - */ - visible?: boolean; -} - -export interface LabelSettingsLowerLevelBorder { - - /** Specifies the border color of grid lines. - * @Default {transparent} - */ - color?: string; - - /** Specifies the border width of grid lines. - * @Default {0.5} - */ - width?: string; -} - -export interface LabelSettingsLowerLevelGridLineStyle { - - /** Specifies the color of grid lines in lower level. - * @Default {#B5B5B5} - */ - color?: string; - - /** Specifies the dashArray of gridLines in lowerLevel. - * @Default {20 5 0} - */ - dashArray?: string; - - /** Specifies the width of grid lines in lower level. - * @Default {#B5B5B5} - */ - width?: string; -} - -export interface LabelSettingsLowerLevelStyleFont { - - /** Specifies the color of labels. Label text render in this specified color. - * @Default {black} - */ - color?: string; - - /** Specifies the font family of labels. Label text render in this specified font family. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Specifies the font style of labels. Label text render in this specified font style. - * @Default {Normal} - */ - fontStyle?: string; - - /** Specifies the font weight of labels. Label text render in this specified font weight. - * @Default {regular} - */ - fontWeight?: string; - - /** Specifies the opacity of labels. Label text render in this specified opacity. - * @Default {12px} - */ - opacity?: string; - - /** Specifies the size of labels. Label text render in this specified size. - * @Default {12px} - */ - size?: string; -} - -export interface LabelSettingsLowerLevelStyle { - - /** Options for customizing the font of labels. - */ - font?: LabelSettingsLowerLevelStyleFont; - - /** Specifies the horizontal text alignment of the text in label. - * @Default {middle} - */ - horizontalAlignment?: string; -} - -export interface LabelSettingsLowerLevel { - - /** Options for customizing the border of grid lines in lower level. - */ - border?: LabelSettingsLowerLevelBorder; - - /** Specifies the fill color of labels in lower level. - * @Default {transparent} - */ - fill?: string; - - /** Options for customizing the grid lines in lower level. - */ - gridLineStyle?: LabelSettingsLowerLevelGridLineStyle; - - /** Specifies the intervalType of the labels in lower level.See IntervalType - * @Default {auto} - */ - intervalType?: ej.datavisualization.RangeNavigator.IntervalType|string; - - /** Specifies the position of the labels to render either inside or outside of plot area. See LabelPlacement - * @Default {outside} - */ - labelPlacement?: ej.datavisualization.RangeNavigator.LabelPlacement|string; - - /** Specifies the position of the labels in lower level.See Position - * @Default {bottom} - */ - position?: ej.datavisualization.RangeNavigator.Position|string; - - /** Options for customizing the style of labels. - */ - style?: LabelSettingsLowerLevelStyle; - - /** Toggles the visibility of labels in lower level. - * @Default {true} - */ - visible?: boolean; -} - -export interface LabelSettingsStyleFont { - - /** Specifies the label color. This color is applied to the labels in range navigator. - * @Default {#FFFFFF} - */ - color?: string; - - /** Specifies the label font family. Labels render with the specified font family. - * @Default {Segoe UI} - */ - family?: string; - - /** Specifies the label font opacity. Labels render with the specified font opacity. - * @Default {1} - */ - opacity?: number; - - /** Specifies the label font size. Labels render with the specified font size. - * @Default {1px} - */ - size?: string; - - /** Specifies the label font style. Labels render with the specified font style.. - * @Default {Normal} - */ - style?: ej.datavisualization.RangeNavigator.FontStyle|string; - - /** Specifies the label font weight - * @Default {regular} - */ - weight?: ej.datavisualization.RangeNavigator.FontWeight|string; -} - -export interface LabelSettingsStyle { - - /** Options for customizing the font of labels in range navigator. - */ - font?: LabelSettingsStyleFont; - - /** Specifies the horizontalAlignment of the label in RangeNavigator - * @Default {middle} - */ - horizontalAlignment?: ej.datavisualization.RangeNavigator.HorizontalAlignment|string; -} - -export interface LabelSettings { - - /** Options for customizing the higher level labels in range navigator. - */ - higherLevel?: LabelSettingsHigherLevel; - - /** Options for customizing the labels in lower level. - */ - lowerLevel?: LabelSettingsLowerLevel; - - /** Options for customizing the style of labels in range navigator. - */ - style?: LabelSettingsStyle; -} - -export interface NavigatorStyleSettingsBorder { - - /** Specifies the border color of range navigator. - * @Default {transparent} - */ - color?: string; - - /** Specifies the dash array of range navigator. - * @Default {null} - */ - dashArray?: string; - - /** Specifies the border width of range navigator. - * @Default {0.5} - */ - width?: number; -} - -export interface NavigatorStyleSettingsMajorGridLineStyle { - - /** Specifies the color of major grid lines in range navigator. - * @Default {#B5B5B5} - */ - color?: string; - - /** Toggles the visibility of major grid lines. - * @Default {true} - */ - visible?: boolean; -} - -export interface NavigatorStyleSettingsMinorGridLineStyle { - - /** Specifies the color of minor grid lines in range navigator. - * @Default {#B5B5B5} - */ - color?: string; - - /** Toggles the visibility of minor grid lines. - * @Default {true} - */ - visible?: boolean; -} - -export interface NavigatorStyleSettingsHighlightSettingsBorder { - - /** To set the border color to the highlight. - * @Default {null} - */ - color?: string; - - /** To set the border width to the highlight. - * @Default {1} - */ - width?: number; -} - -export interface NavigatorStyleSettingsHighlightSettings { - - /** Enable the highlight settings in range navigator. - * @Default {false} - */ - enable?: boolean; - - /** To set the color to the highlight. - * @Default {null} - */ - color?: string; - - /** To set the opacity to the highlight. - * @Default {0.5} - */ - opacity?: number; - - /** Contains the border properties for highlighting rectangle. - */ - border?: NavigatorStyleSettingsHighlightSettingsBorder; -} - -export interface NavigatorStyleSettingsSelectionSettingsBorder { - - /** To set the border color to the selection. - * @Default {null} - */ - color?: string; - - /** To set the border width to the selection. - * @Default {1} - */ - width?: number; -} - -export interface NavigatorStyleSettingsSelectionSettings { - - /** Enable the selection settings in range navigator. - * @Default {false} - */ - enable?: boolean; - - /** To set the color to the selection. - * @Default {null} - */ - color?: string; - - /** To set the opacity to the selection. - * @Default {0.5} - */ - opacity?: number; - - /** Contains the border properties for selecting the rectangle. - */ - border?: NavigatorStyleSettingsSelectionSettingsBorder; -} - -export interface NavigatorStyleSettings { - - /** Specifies the background color of range navigator. - * @Default {#dddddd} - */ - background?: string; - - /** Options for customizing the border color and width of range navigator. - */ - border?: NavigatorStyleSettingsBorder; - - /** Specifies the left side thumb template in range navigator we can give either div id or HTML string - * @Default {null} - */ - leftThumbTemplate?: string; - - /** Options for customizing the major grid lines. - */ - majorGridLineStyle?: NavigatorStyleSettingsMajorGridLineStyle; - - /** Options for customizing the minor grid lines. - */ - minorGridLineStyle?: NavigatorStyleSettingsMinorGridLineStyle; - - /** Specifies the opacity of RangeNavigator. - * @Default {1} - */ - opacity?: number; - - /** Specifies the right side thumb template in range navigator we can give either div id or HTML string - * @Default {null} - */ - rightThumbTemplate?: string; - - /** Specifies the color of the selected region in range navigator. - * @Default {#EFEFEF} - */ - selectedRegionColor?: string; - - /** Specifies the opacity of Selected Region. - * @Default {0} - */ - selectedRegionOpacity?: number; - - /** Specifies the color of the thumb in range navigator. - * @Default {#2382C3} - */ - thumbColor?: string; - - /** Specifies the radius of the thumb in range navigator. - * @Default {10} - */ - thumbRadius?: number; - - /** Specifies the stroke color of the thumb in range navigator. - * @Default {#303030} - */ - thumbStroke?: string; - - /** Specifies the color of the unselected region in range navigator. - * @Default {#5EABDE} - */ - unselectedRegionColor?: string; - - /** Specifies the opacity of Unselected Region. - * @Default {0.3} - */ - unselectedRegionOpacity?: number; - - /** Contains the options for highlighting the range navigator on mouse over. - */ - highlightSettings?: NavigatorStyleSettingsHighlightSettings; - - /** Contains the options for selection the range navigator on mouse over. - */ - selectionSettings?: NavigatorStyleSettingsSelectionSettings; -} - -export interface RangeSettings { - - /** Specifies the ending range of range navigator. - * @Default {null} - */ - end?: string; - - /** Specifies the starting range of range navigator. - * @Default {null} - */ - start?: string; -} - -export interface SelectedRangeSettings { - - /** Specifies the ending range of range navigator. - * @Default {null} - */ - end?: string; - - /** Specifies the starting range of range navigator. - * @Default {null} - */ - start?: string; -} - -export interface ScrollRangeSettings { - - /** Specifies the ending range of range navigator scrollbar and that should be greater than the rangenavigator datasource end value. - * @Default {null} - */ - end?: string; - - /** Specifies the starting range of range navigator scrollbar and that should be less than the rangenavigator datasource start value. - * @Default {null} - */ - start?: string; -} - -export interface SizeSettings { - - /** Specifies height of the range navigator. - * @Default {null} - */ - height?: string; - - /** Specifies width of the range navigator. - * @Default {null} - */ - width?: string; -} - -export interface TooltipSettingsFont { - - /** Specifies the color of text in tooltip. Tooltip text render in the specified color. - * @Default {#FFFFFF} - */ - color?: string; - - /** Specifies the font family of text in tooltip. Tooltip text render in the specified font family. - * @Default {Segoe UI} - */ - family?: string; - - /** Specifies the font style of text in tooltip. Tooltip text render in the specified font style. - * @Default {ej.datavisualization.RangeNavigator.fontStyle.Normal} - */ - fontStyle?: string; - - /** Specifies the opacity of text in tooltip. Tooltip text render in the specified opacity. - * @Default {1} - */ - opacity?: number; - - /** Specifies the size of text in tooltip. Tooltip text render in the specified size. - * @Default {10px} - */ - size?: string; - - /** Specifies the weight of text in tooltip. Tooltip text render in the specified weight. - * @Default {ej.datavisualization.RangeNavigator.weight.Regular} - */ - weight?: string; -} - -export interface TooltipSettings { - - /** Specifies the background color of tooltip. - * @Default {#303030} - */ - backgroundColor?: string; - - /** Options for customizing the font in tooltip. - */ - font?: TooltipSettingsFont; - - /** Specifies the format of text to be displayed in tooltip. - * @Default {MM/dd/yyyy} - */ - labelFormat?: string; - - /** Specifies the mode of displaying the tooltip. Neither to display the tooltip always nor on demand. - * @Default {null} - */ - tooltipDisplayMode?: string; - - /** Toggles the visibility of tooltip. - * @Default {true} - */ - visible?: boolean; -} - -export interface ValueAxisSettingsAxisLine { - - /** Toggles the visibility of axis line. - * @Default {none} - */ - visible?: string; -} - -export interface ValueAxisSettingsFont { - - /** Text in axis render with the specified size. - * @Default {0px} - */ - size?: string; -} - -export interface ValueAxisSettingsMajorGridLines { - - /** Toggles the visibility of major grid lines. - * @Default {false} - */ - visible?: boolean; -} - -export interface ValueAxisSettingsMajorTickLines { - - /** Specifies the size of the majorTickLines in range navigator - * @Default {0} - */ - size?: number; - - /** Toggles the visibility of major tick lines. - * @Default {true} - */ - visible?: boolean; - - /** Specifies width of the major tick lines. - * @Default {0} - */ - width?: number; -} - -export interface ValueAxisSettings { - - /** Options for customizing the axis line. - */ - axisLine?: ValueAxisSettingsAxisLine; - - /** Options for customizing the font of the axis. - */ - font?: ValueAxisSettingsFont; - - /** Options for customizing the major grid lines. - */ - majorGridLines?: ValueAxisSettingsMajorGridLines; - - /** Options for customizing the major tick lines in axis. - */ - majorTickLines?: ValueAxisSettingsMajorTickLines; - - /** If the range is not given explicitly, range will be calculated automatically. You can customize the automatic range calculation using rangePadding. - * @Default {none} - */ - rangePadding?: string; - - /** Toggles the visibility of axis in range navigator. - * @Default {false} - */ - visible?: boolean; -} -} -namespace RangeNavigator { -enum Type { -//string -Area, -//string -Line, -//string -Spline, -//string -StepArea, -//string -SplineArea, -//string -StepLine, -} -} -namespace RangeNavigator { -enum IntervalType { -//string -Years, -//string -Quarters, -//string -Months, -//string -Weeks, -//string -Days, -//string -Hours, -//string -Minutes, -} -} -namespace RangeNavigator { -enum LabelPlacement { -//string -Inside, -//string -Outside, -} -} -namespace RangeNavigator { -enum Position { -//string -Top, -//string -Bottom, -} -} -namespace RangeNavigator { -enum FontStyle { -//string -Normal, -//string -Bold, -//string -Italic, -} -} -namespace RangeNavigator { -enum FontWeight { -//string -Regular, -//string -Lighter, -} -} -namespace RangeNavigator { -enum HorizontalAlignment { -//string -Middle, -//string -Left, -//string -Right, -} -} -namespace RangeNavigator { -enum RangePadding { -//string -Additional, -//string -Normal, -//string -None, -//string -Round, -} -} -namespace RangeNavigator { -enum ValueType { -//string -Numeric, -//string -DateTime, -} -} - -class BulletGraph extends ej.Widget { - static fn: BulletGraph; - constructor(element: JQuery | Element, options?: BulletGraph.Model); - static Locale: any; - model: BulletGraph.Model; - defaults: BulletGraph.Model; - - /** To destroy the bullet graph - * @returns {void} - */ - destroy(): void; - - /** To redraw the bullet graph - * @returns {void} - */ - redraw(): void; - - /** To set the value for comparative measure in bullet graph. - * @returns {void} - */ - setComparativeMeasureSymbol(): void; - - /** To set the value for feature measure bar. - * @returns {void} - */ - setFeatureMeasureBarValue(): void; -} -export namespace BulletGraph { - -export interface Model { - - /** Toggles the visibility of the range stroke color of the labels. - * @Default {false} - */ - applyRangeStrokeToLabels?: boolean; - - /** Toggles the visibility of the range stroke color of the ticks. - * @Default {false} - */ - applyRangeStrokeToTicks?: boolean; - - /** Contains property to customize the caption in bullet graph. - */ - captionSettings?: CaptionSettings; - - /** Comparative measure bar in bullet graph render till the specified value. - * @Default {0} - */ - comparativeMeasureValue?: number; - - /** Toggles the animation of bullet graph. - * @Default {true} - */ - enableAnimation?: boolean; - - /** Specifies the direction of flow in bullet graph. Neither it may be backward nor forward. - * @Default {forward} - */ - flowDirection?: ej.datavisualization.BulletGraph.FlowDirection|string; - - /** Specifies the height of the bullet graph. - * @Default {90} - */ - height?: number; - - /** Sets a value whether to make the bullet graph responsive on resize. - * @Default {true} - */ - isResponsive?: boolean; - - /** Bullet graph will render in the specified orientation. - * @Default {horizontal} - */ - orientation?: ej.datavisualization.BulletGraph.Orientation|string; - - /** Contains property to customize the qualitative ranges. - */ - qualitativeRanges?: QualitativeRange[]; - - /** Size of the qualitative range depends up on the specified value. - * @Default {32} - */ - qualitativeRangeSize?: number; - - /** Length of the quantitative range depends up on the specified value. - * @Default {475} - */ - quantitativeScaleLength?: number; - - /** Contains all the properties to customize quantitative scale. - */ - quantitativeScaleSettings?: QuantitativeScaleSettings; - - /** By specifying this property the user can change the theme of the bullet graph. - * @Default {flatlight} - */ - theme?: string; - - /** Contains all the properties to customize tooltip. - */ - tooltipSettings?: TooltipSettings; - - /** Feature measure bar in bullet graph render till the specified value. - * @Default {0} - */ - value?: number; - - /** Specifies the width of the bullet graph. - * @Default {595} - */ - width?: number; - - /** Fires on rendering the caption of bullet graph. */ - drawCaption?(e: DrawCaptionEventArgs): void; + /** returns the name of the event + */ + type?: string; + } + + export interface ScrollEndEventArgs { + + /** parameters from RangeNavigator + */ + data?: any; + + /** returns the scrollbar position old start and end range value on change end of scrollbar + */ + dataoldRange?: any; + + /** returns the scrollbar position new start and end range value on change end of scrollbar + */ + datanewRange?: any; + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the RangeNavigator model + */ + model?: any; + + /** returns the name of the event + */ + type?: string; + } + + export interface Border { + + /** Border color of rangenavigator. When enable the scrollbar, the default color will be set as "#B4B4B4". + * @Default {transparent} + */ + color?: string; + + /** Opacity of the rangeNavigator border. + * @Default {1} + */ + opacity?: number; + + /** Width of the RangeNavigator border. + * @Default {1} + */ + width?: number; + } + + export interface Series { + + /** Name of the property in the datasource that contains x value for the series. + * @Default {null} + */ + xName?: string; + + /** Name of the property in the datasource that contains y value for the series. + * @Default {null} + */ + yName?: string; + + /** Specifies the dataSource for the series. It can be an array of JSON objects or an instance of ej.DataManager. + * @Default {null} + */ + dataSource?: any; + + /** Specifies the type of the series to render in chart. + * @Default {column. see Type} + */ + type?: ej.datavisualization.RangeNavigator.Type | string; + + /** Enable/disable the animation of series. + * @Default {false} + */ + enableAnimation?: boolean; + + /** Fill color of the series. + * @Default {null} + */ + fill?: string; + } + + export interface LabelSettingsHigherLevelBorder { + + /** Specifies the border color of grid lines. + * @Default {transparent} + */ + color?: string; + + /** Specifies the border width of grid lines. + * @Default {0.5} + */ + width?: string; + } + + export interface LabelSettingsHigherLevelGridLineStyle { + + /** Specifies the color of grid lines in higher level. + * @Default {#B5B5B5} + */ + color?: string; + + /** Specifies the dashArray of grid lines in higher level. + * @Default {20 5 0} + */ + dashArray?: string; + + /** Specifies the width of grid lines in higher level. + * @Default {#B5B5B5} + */ + width?: string; + } + + export interface LabelSettingsHigherLevelStyleFont { + + /** Specifies the label font color. Labels render with the specified font color. + * @Default {black} + */ + color?: string; + + /** Specifies the label font family. Labels render with the specified font family. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Specifies the label font style. Labels render with the specified font style. + * @Default {Normal} + */ + fontStyle?: string; + + /** Specifies the label font weight. Labels render with the specified font weight. + * @Default {regular} + */ + fontWeight?: string; + + /** Specifies the label opacity. Labels render with the specified opacity. + * @Default {1} + */ + opacity?: number; + + /** Specifies the label font size. Labels render with the specified font size. + * @Default {12px} + */ + size?: string; + } + + export interface LabelSettingsHigherLevelStyle { + + /** Options for customizing the font properties. + */ + font?: LabelSettingsHigherLevelStyleFont; + + /** Specifies the horizontal text alignment of the text in label. + * @Default {middle} + */ + horizontalAlignment?: string; + } + + export interface LabelSettingsHigherLevel { + + /** Options for customizing the border of grid lines in higher level. + */ + border?: LabelSettingsHigherLevelBorder; + + /** Specifies the fill color of higher level labels. + * @Default {transparent} + */ + fill?: string; + + /** Options for customizing the grid line colors, width, dashArray, border. + */ + gridLineStyle?: LabelSettingsHigherLevelGridLineStyle; + + /** Specifies the intervalType for higher level labels. See IntervalType + * @Default {auto} + */ + intervalType?: ej.datavisualization.RangeNavigator.IntervalType | string; + + /** Specifies the position of the labels to render either inside or outside of plot area + * @Default {outside} + */ + labelPlacement?: ej.datavisualization.RangeNavigator.LabelPlacement | string; + + /** Specifies the position of the labels in higher level + * @Default {top} + */ + position?: ej.datavisualization.RangeNavigator.Position | string; + + /** Options for customizing the style of higher level labels. + */ + style?: LabelSettingsHigherLevelStyle; + + /** Toggles the visibility of higher level labels. + * @Default {true} + */ + visible?: boolean; + } + + export interface LabelSettingsLowerLevelBorder { + + /** Specifies the border color of grid lines. + * @Default {transparent} + */ + color?: string; + + /** Specifies the border width of grid lines. + * @Default {0.5} + */ + width?: string; + } + + export interface LabelSettingsLowerLevelGridLineStyle { + + /** Specifies the color of grid lines in lower level. + * @Default {#B5B5B5} + */ + color?: string; + + /** Specifies the dashArray of gridLines in lowerLevel. + * @Default {20 5 0} + */ + dashArray?: string; + + /** Specifies the width of grid lines in lower level. + * @Default {#B5B5B5} + */ + width?: string; + } + + export interface LabelSettingsLowerLevelStyleFont { + + /** Specifies the color of labels. Label text render in this specified color. + * @Default {black} + */ + color?: string; + + /** Specifies the font family of labels. Label text render in this specified font family. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Specifies the font style of labels. Label text render in this specified font style. + * @Default {Normal} + */ + fontStyle?: string; + + /** Specifies the font weight of labels. Label text render in this specified font weight. + * @Default {regular} + */ + fontWeight?: string; + + /** Specifies the opacity of labels. Label text render in this specified opacity. + * @Default {12px} + */ + opacity?: string; + + /** Specifies the size of labels. Label text render in this specified size. + * @Default {12px} + */ + size?: string; + } + + export interface LabelSettingsLowerLevelStyle { + + /** Options for customizing the font of labels. + */ + font?: LabelSettingsLowerLevelStyleFont; + + /** Specifies the horizontal text alignment of the text in label. + * @Default {middle} + */ + horizontalAlignment?: string; + } + + export interface LabelSettingsLowerLevel { + + /** Options for customizing the border of grid lines in lower level. + */ + border?: LabelSettingsLowerLevelBorder; + + /** Specifies the fill color of labels in lower level. + * @Default {transparent} + */ + fill?: string; + + /** Options for customizing the grid lines in lower level. + */ + gridLineStyle?: LabelSettingsLowerLevelGridLineStyle; + + /** Specifies the intervalType of the labels in lower level.See IntervalType + * @Default {auto} + */ + intervalType?: ej.datavisualization.RangeNavigator.IntervalType | string; + + /** Specifies the position of the labels to render either inside or outside of plot area. See LabelPlacement + * @Default {outside} + */ + labelPlacement?: ej.datavisualization.RangeNavigator.LabelPlacement | string; + + /** Specifies the position of the labels in lower level.See Position + * @Default {bottom} + */ + position?: ej.datavisualization.RangeNavigator.Position | string; + + /** Options for customizing the style of labels. + */ + style?: LabelSettingsLowerLevelStyle; + + /** Toggles the visibility of labels in lower level. + * @Default {true} + */ + visible?: boolean; + } + + export interface LabelSettingsStyleFont { + + /** Specifies the label color. This color is applied to the labels in range navigator. + * @Default {#FFFFFF} + */ + color?: string; + + /** Specifies the label font family. Labels render with the specified font family. + * @Default {Segoe UI} + */ + family?: string; + + /** Specifies the label font opacity. Labels render with the specified font opacity. + * @Default {1} + */ + opacity?: number; + + /** Specifies the label font size. Labels render with the specified font size. + * @Default {1px} + */ + size?: string; + + /** Specifies the label font style. Labels render with the specified font style.. + * @Default {Normal} + */ + style?: ej.datavisualization.RangeNavigator.FontStyle | string; + + /** Specifies the label font weight + * @Default {regular} + */ + weight?: ej.datavisualization.RangeNavigator.FontWeight | string; + } + + export interface LabelSettingsStyle { + + /** Options for customizing the font of labels in range navigator. + */ + font?: LabelSettingsStyleFont; + + /** Specifies the horizontalAlignment of the label in RangeNavigator + * @Default {middle} + */ + horizontalAlignment?: ej.datavisualization.RangeNavigator.HorizontalAlignment | string; + } + + export interface LabelSettings { + + /** Options for customizing the higher level labels in range navigator. + */ + higherLevel?: LabelSettingsHigherLevel; + + /** Options for customizing the labels in lower level. + */ + lowerLevel?: LabelSettingsLowerLevel; + + /** Options for customizing the style of labels in range navigator. + */ + style?: LabelSettingsStyle; + } + + export interface NavigatorStyleSettingsBorder { + + /** Specifies the border color of range navigator. + * @Default {transparent} + */ + color?: string; + + /** Specifies the dash array of range navigator. + * @Default {null} + */ + dashArray?: string; + + /** Specifies the border width of range navigator. + * @Default {0.5} + */ + width?: number; + } + + export interface NavigatorStyleSettingsMajorGridLineStyle { + + /** Specifies the color of major grid lines in range navigator. + * @Default {#B5B5B5} + */ + color?: string; + + /** Toggles the visibility of major grid lines. + * @Default {true} + */ + visible?: boolean; + } + + export interface NavigatorStyleSettingsMinorGridLineStyle { + + /** Specifies the color of minor grid lines in range navigator. + * @Default {#B5B5B5} + */ + color?: string; + + /** Toggles the visibility of minor grid lines. + * @Default {true} + */ + visible?: boolean; + } + + export interface NavigatorStyleSettingsHighlightSettingsBorder { + + /** To set the border color to the highlight. + * @Default {null} + */ + color?: string; + + /** To set the border width to the highlight. + * @Default {1} + */ + width?: number; + } + + export interface NavigatorStyleSettingsHighlightSettings { + + /** Enable the highlight settings in range navigator. + * @Default {false} + */ + enable?: boolean; + + /** To set the color to the highlight. + * @Default {null} + */ + color?: string; + + /** To set the opacity to the highlight. + * @Default {0.5} + */ + opacity?: number; + + /** Contains the border properties for highlighting rectangle. + */ + border?: NavigatorStyleSettingsHighlightSettingsBorder; + } + + export interface NavigatorStyleSettingsSelectionSettingsBorder { + + /** To set the border color to the selection. + * @Default {null} + */ + color?: string; + + /** To set the border width to the selection. + * @Default {1} + */ + width?: number; + } + + export interface NavigatorStyleSettingsSelectionSettings { + + /** Enable the selection settings in range navigator. + * @Default {false} + */ + enable?: boolean; + + /** To set the color to the selection. + * @Default {null} + */ + color?: string; + + /** To set the opacity to the selection. + * @Default {0.5} + */ + opacity?: number; + + /** Contains the border properties for selecting the rectangle. + */ + border?: NavigatorStyleSettingsSelectionSettingsBorder; + } + + export interface NavigatorStyleSettings { + + /** Specifies the background color of range navigator. + * @Default {#dddddd} + */ + background?: string; + + /** Options for customizing the border color and width of range navigator. + */ + border?: NavigatorStyleSettingsBorder; + + /** Specifies the left side thumb template in range navigator we can give either div id or HTML string + * @Default {null} + */ + leftThumbTemplate?: string; + + /** Options for customizing the major grid lines. + */ + majorGridLineStyle?: NavigatorStyleSettingsMajorGridLineStyle; + + /** Options for customizing the minor grid lines. + */ + minorGridLineStyle?: NavigatorStyleSettingsMinorGridLineStyle; + + /** Specifies the opacity of RangeNavigator. + * @Default {1} + */ + opacity?: number; + + /** Specifies the right side thumb template in range navigator we can give either div id or HTML string + * @Default {null} + */ + rightThumbTemplate?: string; + + /** Specifies the color of the selected region in range navigator. + * @Default {#EFEFEF} + */ + selectedRegionColor?: string; + + /** Specifies the opacity of Selected Region. + * @Default {0} + */ + selectedRegionOpacity?: number; + + /** Specifies the color of the thumb in range navigator. + * @Default {#2382C3} + */ + thumbColor?: string; + + /** Specifies the radius of the thumb in range navigator. + * @Default {10} + */ + thumbRadius?: number; + + /** Specifies the stroke color of the thumb in range navigator. + * @Default {#303030} + */ + thumbStroke?: string; + + /** Specifies the color of the unselected region in range navigator. + * @Default {#5EABDE} + */ + unselectedRegionColor?: string; + + /** Specifies the opacity of Unselected Region. + * @Default {0.3} + */ + unselectedRegionOpacity?: number; + + /** Contains the options for highlighting the range navigator on mouse over. + */ + highlightSettings?: NavigatorStyleSettingsHighlightSettings; + + /** Contains the options for selection the range navigator on mouse over. + */ + selectionSettings?: NavigatorStyleSettingsSelectionSettings; + } + + export interface RangeSettings { + + /** Specifies the ending range of range navigator. + * @Default {null} + */ + end?: string; + + /** Specifies the starting range of range navigator. + * @Default {null} + */ + start?: string; + } + + export interface SelectedRangeSettings { + + /** Specifies the ending range of range navigator. + * @Default {null} + */ + end?: string; + + /** Specifies the starting range of range navigator. + * @Default {null} + */ + start?: string; + } + + export interface ScrollRangeSettings { + + /** Specifies the ending range of range navigator scrollbar and that should be greater than the rangenavigator datasource end value. + * @Default {null} + */ + end?: string; + + /** Specifies the starting range of range navigator scrollbar and that should be less than the rangenavigator datasource start value. + * @Default {null} + */ + start?: string; + } + + export interface SizeSettings { + + /** Specifies height of the range navigator. + * @Default {null} + */ + height?: string; + + /** Specifies width of the range navigator. + * @Default {null} + */ + width?: string; + } + + export interface TooltipSettingsFont { + + /** Specifies the color of text in tooltip. Tooltip text render in the specified color. + * @Default {#FFFFFF} + */ + color?: string; + + /** Specifies the font family of text in tooltip. Tooltip text render in the specified font family. + * @Default {Segoe UI} + */ + family?: string; + + /** Specifies the font style of text in tooltip. Tooltip text render in the specified font style. + * @Default {ej.datavisualization.RangeNavigator.fontStyle.Normal} + */ + fontStyle?: string; + + /** Specifies the opacity of text in tooltip. Tooltip text render in the specified opacity. + * @Default {1} + */ + opacity?: number; + + /** Specifies the size of text in tooltip. Tooltip text render in the specified size. + * @Default {10px} + */ + size?: string; + + /** Specifies the weight of text in tooltip. Tooltip text render in the specified weight. + * @Default {ej.datavisualization.RangeNavigator.weight.Regular} + */ + weight?: string; + } + + export interface TooltipSettings { + + /** Specifies the background color of tooltip. + * @Default {#303030} + */ + backgroundColor?: string; + + /** Options for customizing the font in tooltip. + */ + font?: TooltipSettingsFont; + + /** Specifies the format of text to be displayed in tooltip. + * @Default {MM/dd/yyyy} + */ + labelFormat?: string; + + /** Specifies the mode of displaying the tooltip. Neither to display the tooltip always nor on demand. + * @Default {null} + */ + tooltipDisplayMode?: string; + + /** Toggles the visibility of tooltip. + * @Default {true} + */ + visible?: boolean; + } + + export interface ValueAxisSettingsAxisLine { + + /** Toggles the visibility of axis line. + * @Default {none} + */ + visible?: string; + } + + export interface ValueAxisSettingsFont { + + /** Text in axis render with the specified size. + * @Default {0px} + */ + size?: string; + } + + export interface ValueAxisSettingsMajorGridLines { + + /** Toggles the visibility of major grid lines. + * @Default {false} + */ + visible?: boolean; + } + + export interface ValueAxisSettingsMajorTickLines { + + /** Specifies the size of the majorTickLines in range navigator + * @Default {0} + */ + size?: number; + + /** Toggles the visibility of major tick lines. + * @Default {true} + */ + visible?: boolean; + + /** Specifies width of the major tick lines. + * @Default {0} + */ + width?: number; + } + + export interface ValueAxisSettings { + + /** Options for customizing the axis line. + */ + axisLine?: ValueAxisSettingsAxisLine; + + /** Options for customizing the font of the axis. + */ + font?: ValueAxisSettingsFont; + + /** Options for customizing the major grid lines. + */ + majorGridLines?: ValueAxisSettingsMajorGridLines; + + /** Options for customizing the major tick lines in axis. + */ + majorTickLines?: ValueAxisSettingsMajorTickLines; + + /** If the range is not given explicitly, range will be calculated automatically. You can customize the automatic range calculation using rangePadding. + * @Default {none} + */ + rangePadding?: string; + + /** Toggles the visibility of axis in range navigator. + * @Default {false} + */ + visible?: boolean; + } + } + namespace RangeNavigator { + enum Type { + //string + Area, + //string + Line, + //string + Spline, + //string + StepArea, + //string + SplineArea, + //string + StepLine, + } + } + namespace RangeNavigator { + enum IntervalType { + //string + Years, + //string + Quarters, + //string + Months, + //string + Weeks, + //string + Days, + //string + Hours, + //string + Minutes, + } + } + namespace RangeNavigator { + enum LabelPlacement { + //string + Inside, + //string + Outside, + } + } + namespace RangeNavigator { + enum Position { + //string + Top, + //string + Bottom, + } + } + namespace RangeNavigator { + enum FontStyle { + //string + Normal, + //string + Bold, + //string + Italic, + } + } + namespace RangeNavigator { + enum FontWeight { + //string + Regular, + //string + Lighter, + } + } + namespace RangeNavigator { + enum HorizontalAlignment { + //string + Middle, + //string + Left, + //string + Right, + } + } + namespace RangeNavigator { + enum RangePadding { + //string + Additional, + //string + Normal, + //string + None, + //string + Round, + } + } + namespace RangeNavigator { + enum ValueType { + //string + Numeric, + //string + DateTime, + } + } + + class BulletGraph extends ej.Widget { + static fn: BulletGraph; + constructor(element: JQuery | Element, options?: BulletGraph.Model); + static Locale: any; + model: BulletGraph.Model; + defaults: BulletGraph.Model; + + /** To destroy the bullet graph + * @returns {void} + */ + destroy(): void; + + /** To redraw the bullet graph + * @returns {void} + */ + redraw(): void; + + /** To set the value for comparative measure in bullet graph. + * @returns {void} + */ + setComparativeMeasureSymbol(): void; + + /** To set the value for feature measure bar. + * @returns {void} + */ + setFeatureMeasureBarValue(): void; + } + export namespace BulletGraph { + + export interface Model { + + /** Toggles the visibility of the range stroke color of the labels. + * @Default {false} + */ + applyRangeStrokeToLabels?: boolean; + + /** Toggles the visibility of the range stroke color of the ticks. + * @Default {false} + */ + applyRangeStrokeToTicks?: boolean; + + /** Contains property to customize the caption in bullet graph. + */ + captionSettings?: CaptionSettings; + + /** Comparative measure bar in bullet graph render till the specified value. + * @Default {0} + */ + comparativeMeasureValue?: number; + + /** Toggles the animation of bullet graph. + * @Default {true} + */ + enableAnimation?: boolean; + + /** Specifies the direction of flow in bullet graph. Neither it may be backward nor forward. + * @Default {forward} + */ + flowDirection?: ej.datavisualization.BulletGraph.FlowDirection | string; + + /** Specifies the height of the bullet graph. + * @Default {90} + */ + height?: number; + + /** Sets a value whether to make the bullet graph responsive on resize. + * @Default {true} + */ + isResponsive?: boolean; + + /** Bullet graph will render in the specified orientation. + * @Default {horizontal} + */ + orientation?: ej.datavisualization.BulletGraph.Orientation | string; + + /** Contains property to customize the qualitative ranges. + */ + qualitativeRanges?: QualitativeRange[]; + + /** Size of the qualitative range depends up on the specified value. + * @Default {32} + */ + qualitativeRangeSize?: number; + + /** Length of the quantitative range depends up on the specified value. + * @Default {475} + */ + quantitativeScaleLength?: number; + + /** Contains all the properties to customize quantitative scale. + */ + quantitativeScaleSettings?: QuantitativeScaleSettings; + + /** By specifying this property the user can change the theme of the bullet graph. + * @Default {flatlight} + */ + theme?: string; + + /** Contains all the properties to customize tooltip. + */ + tooltipSettings?: TooltipSettings; + + /** Feature measure bar in bullet graph render till the specified value. + * @Default {0} + */ + value?: number; + + /** Specifies the width of the bullet graph. + * @Default {595} + */ + width?: number; + + /** Fires on rendering the caption of bullet graph. */ + drawCaption?(e: DrawCaptionEventArgs): void; - /** Fires on rendering the category. */ - drawCategory?(e: DrawCategoryEventArgs): void; - - /** Fires on rendering the comparative measure symbol. */ - drawComparativeMeasureSymbol?(e: DrawComparativeMeasureSymbolEventArgs): void; + /** Fires on rendering the category. */ + drawCategory?(e: DrawCategoryEventArgs): void; + + /** Fires on rendering the comparative measure symbol. */ + drawComparativeMeasureSymbol?(e: DrawComparativeMeasureSymbolEventArgs): void; - /** Fires on rendering the feature measure bar. */ - drawFeatureMeasureBar?(e: DrawFeatureMeasureBarEventArgs): void; + /** Fires on rendering the feature measure bar. */ + drawFeatureMeasureBar?(e: DrawFeatureMeasureBarEventArgs): void; - /** Fires on rendering the indicator of bullet graph. */ - drawIndicator?(e: DrawIndicatorEventArgs): void; + /** Fires on rendering the indicator of bullet graph. */ + drawIndicator?(e: DrawIndicatorEventArgs): void; - /** Fires on rendering the labels. */ - drawLabels?(e: DrawLabelsEventArgs): void; + /** Fires on rendering the labels. */ + drawLabels?(e: DrawLabelsEventArgs): void; - /** Fires on rendering the qualitative ranges. */ - drawQualitativeRanges?(e: DrawQualitativeRangesEventArgs): void; + /** Fires on rendering the qualitative ranges. */ + drawQualitativeRanges?(e: DrawQualitativeRangesEventArgs): void; - /** Fires on loading bullet graph. */ - load?(e: LoadEventArgs): void; -} + /** Fires on loading bullet graph. */ + load?(e: LoadEventArgs): void; + } -export interface DrawCaptionEventArgs { + export interface DrawCaptionEventArgs { - /** returns the object of the bullet graph. - */ - Object?: any; + /** returns the object of the bullet graph. + */ + Object?: any; - /** returns the options of the scale element. - */ - scaleElement?: HTMLElement; + /** returns the options of the scale element. + */ + scaleElement?: HTMLElement; - /** returns the current captionSettings element. - */ - captionElement?: HTMLElement; + /** returns the current captionSettings element. + */ + captionElement?: HTMLElement; - /** returns the type of the captionSettings. - */ - captionType?: string; -} + /** returns the type of the captionSettings. + */ + captionType?: string; + } -export interface DrawCategoryEventArgs { + export interface DrawCategoryEventArgs { - /** returns the object of the bullet graph. - */ - Object?: any; + /** returns the object of the bullet graph. + */ + Object?: any; - /** returns the options of the scale element. - */ - scaleElement?: HTMLElement; + /** returns the options of the scale element. + */ + scaleElement?: HTMLElement; - /** returns the options of category element. - */ - categoryElement?: HTMLElement; + /** returns the options of category element. + */ + categoryElement?: HTMLElement; - /** returns the text value of the category that is drawn. - */ - Value?: string; -} + /** returns the text value of the category that is drawn. + */ + Value?: string; + } -export interface DrawComparativeMeasureSymbolEventArgs { + export interface DrawComparativeMeasureSymbolEventArgs { - /** returns the object of the bullet graph. - */ - Object?: any; + /** returns the object of the bullet graph. + */ + Object?: any; - /** returns the options of the scale element. - */ - scaleElement?: HTMLElement; + /** returns the options of the scale element. + */ + scaleElement?: HTMLElement; - /** returns the options of comparative measure element. - */ - targetElement?: HTMLElement; + /** returns the options of comparative measure element. + */ + targetElement?: HTMLElement; - /** returns the value of the comparative measure symbol. - */ - Value?: number; -} + /** returns the value of the comparative measure symbol. + */ + Value?: number; + } -export interface DrawFeatureMeasureBarEventArgs { + export interface DrawFeatureMeasureBarEventArgs { - /** returns the object of the bullet graph. - */ - Object?: any; + /** returns the object of the bullet graph. + */ + Object?: any; - /** returns the options of the scale element. - */ - scaleElement?: HTMLElement; + /** returns the options of the scale element. + */ + scaleElement?: HTMLElement; - /** returns the options of feature measure element. - */ - currentElement?: HTMLElement; + /** returns the options of feature measure element. + */ + currentElement?: HTMLElement; - /** returns the value of the feature measure bar. - */ - Value?: number; -} + /** returns the value of the feature measure bar. + */ + Value?: number; + } -export interface DrawIndicatorEventArgs { + export interface DrawIndicatorEventArgs { - /** returns an object to customize bullet graph indicator text and symbol before rendering it. - */ - indicatorSettings?: any; + /** returns an object to customize bullet graph indicator text and symbol before rendering it. + */ + indicatorSettings?: any; - /** returns the object of bullet graph. - */ - model?: any; + /** returns the object of bullet graph. + */ + model?: any; - /** returns the type of event. - */ - type?: string; + /** returns the type of event. + */ + type?: string; - /** for canceling the event. - */ - cancel?: boolean; -} + /** for canceling the event. + */ + cancel?: boolean; + } -export interface DrawLabelsEventArgs { - - /** returns the object of the bullet graph. - */ - Object?: any; - - /** returns the options of the scale element. - */ - scaleElement?: HTMLElement; - - /** returns the current label element. - */ - tickElement?: HTMLElement; - - /** returns the label type. - */ - labelType?: string; -} - -export interface DrawQualitativeRangesEventArgs { - - /** returns the object of the bullet graph. - */ - Object?: any; - - /** returns the index of current range. - */ - rangeIndex?: number; - - /** returns the settings for current range. - */ - rangeOptions?: any; - - /** returns the end value of current range. - */ - rangeEndValue?: number; -} - -export interface LoadEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; -} - -export interface CaptionSettingsFont { - - /** Specifies the color of the text in caption. - * @Default {null} - */ - color?: string; - - /** Specifies the fontFamily of caption. Caption text render with this fontFamily - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Specifies the fontStyle of caption - * @Default {Normal} - */ - fontStyle?: ej.datavisualization.BulletGraph.FontStyle|string; - - /** Specifies the fontWeight of caption - * @Default {regular} - */ - fontWeight?: ej.datavisualization.BulletGraph.FontWeight|string; - - /** Specifies the opacity of caption. Caption text render with this opacity. - * @Default {1} - */ - opacity?: number; - - /** Specifies the size of caption. Caption text render with this size - * @Default {12px} - */ - size?: string; -} - -export interface CaptionSettingsIndicatorFont { - - /** Specifies the color of the indicator's text. - * @Default {null} - */ - color?: string; - - /** Specifies the fontFamily of indicator. Indicator text render with this fontFamily. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Specifies the fontStyle of indicator. Indicator text render with this fontStyle. See FontStyle - * @Default {Normal} - */ - fontStyle?: ej.datavisualization.BulletGraph.FontStyle|string; - - /** Specifies the fontWeight of indicator. Indicator text render with this fontWeight. See FontWeight - * @Default {regular} - */ - fontWeight?: ej.datavisualization.BulletGraph.FontWeight|string; - - /** Specifies the opacity of indicator text. Indicator text render with this Opacity. - * @Default {1} - */ - opacity?: number; - - /** Specifies the size of indicator. Indicator text render with this size. - * @Default {12px} - */ - size?: string; -} - -export interface CaptionSettingsIndicatorLocation { - - /** Specifies the horizontal position of the indicator. - * @Default {10} - */ - x?: number; - - /** Specifies the vertical position of the indicator. - * @Default {60} - */ - y?: number; -} - -export interface CaptionSettingsIndicatorSymbolBorder { - - /** Specifies the border color of indicator symbol. - * @Default {null} - */ - color?: string; - - /** Specifies the border width of indicator symbol. - * @Default {1} - */ - width?: number; -} - -export interface CaptionSettingsIndicatorSymbolSize { - - /** Specifies the height of indicator symbol. - * @Default {10} - */ - height?: number; - - /** Specifies the width of indicator symbol. - * @Default {10} - */ - width?: number; -} - -export interface CaptionSettingsIndicatorSymbol { - - /** Contains property to customize the border of indicator symbol. - */ - border?: CaptionSettingsIndicatorSymbolBorder; - - /** Specifies the color of indicator symbol. - * @Default {null} - */ - color?: string; - - /** Specifies the URL of image that represents indicator symbol. - */ - imageURL?: string; - - /** Specifies the opacity of indicator symbol. - * @Default {1} - */ - opacity?: number; - - /** Specifies the shape of indicator symbol. - */ - shape?: string; - - /** Contains property to customize the size of indicator symbol. - */ - size?: CaptionSettingsIndicatorSymbolSize; -} - -export interface CaptionSettingsIndicator { - - /** Contains property to customize the font of indicator. - */ - font?: CaptionSettingsIndicatorFont; - - /** Contains property to customize the location of indicator. - */ - location?: CaptionSettingsIndicatorLocation; - - /** Specifies the padding to be applied when text position is used. - * @Default {2} - */ - padding?: number; - - /** Contains property to customize the symbol of indicator. - */ - symbol?: CaptionSettingsIndicatorSymbol; - - /** Specifies the text to be displayed as indicator text. By default difference between current value and target will be displayed - */ - text?: string; - - /** Specifies the alignment of indicator with respect to scale based on text position - * @Default {'Near'} - */ - textAlignment?: ej.datavisualization.BulletGraph.TextAlignment|string; - - /** Specifies where indicator text should be anchored when indicator overlaps with other caption group text. Text will be anchored when overlapping caption group text are at same position. - * Anchoring is not applicable for float position. - * @Default {'start'} - */ - textAnchor?: ej.datavisualization.BulletGraph.TextAnchor|string; - - /** indicator text render in the specified angle. - * @Default {0} - */ - textAngle?: number; - - /** Specifies where indicator should be placed - * @Default {'float'} - */ - textPosition?: ej.datavisualization.BulletGraph.TextPosition|string; - - /** Specifies the space between indicator symbol and text. - * @Default {3} - */ - textSpacing?: number; - - /** Specifies whether indicator will be visible or not. - * @Default {false} - */ - visible?: boolean; -} - -export interface CaptionSettingsLocation { - - /** Specifies the position in horizontal direction - * @Default {17} - */ - x?: number; - - /** Specifies the position in horizontal direction - * @Default {30} - */ - y?: number; -} - -export interface CaptionSettingsSubTitleFont { - - /** Specifies the color of the subtitle's text. - * @Default {null} - */ - color?: string; - - /** Specifies the fontFamily of subtitle. Subtitle text render with this fontFamily. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Specifies the fontStyle of subtitle. Subtitle text render with this fontStyle. See FontStyle - * @Default {Normal} - */ - fontStyle?: ej.datavisualization.BulletGraph.FontStyle|string; - - /** Specifies the fontWeight of subtitle. Subtitle text render with this fontWeight. See FontWeight - * @Default {regular} - */ - fontWeight?: ej.datavisualization.BulletGraph.FontWeight|string; - - /** Specifies the opacity of subtitle. Subtitle text render with this opacity. - * @Default {1} - */ - opacity?: number; - - /** Specifies the size of subtitle. Subtitle text render with this size. - * @Default {12px} - */ - size?: string; -} - -export interface CaptionSettingsSubTitleLocation { - - /** Specifies the horizontal position of the subtitle. - * @Default {10} - */ - x?: number; - - /** Specifies the vertical position of the subtitle. - * @Default {45} - */ - y?: number; -} - -export interface CaptionSettingsSubTitle { - - /** Contains property to customize the font of subtitle. - */ - font?: CaptionSettingsSubTitleFont; - - /** Contains property to customize the location of subtitle. - */ - location?: CaptionSettingsSubTitleLocation; - - /** Specifies the padding to be applied when text position is used. - * @Default {5} - */ - padding?: number; - - /** Specifies the text to be displayed as subtitle. - */ - text?: string; - - /** Specifies the alignment of sub title text with respect to scale. Alignment will not be applied in float position. - * @Default {'Near'} - */ - textAlignment?: ej.datavisualization.BulletGraph.TextAlignment|string; - - /** Specifies where subtitle text should be anchored when sub title text overlaps with other caption group text. Text will be anchored when overlapping - * caption group text are at same position. Anchoring is not applicable for float position. - * @Default {'start'} - */ - textAnchor?: ej.datavisualization.BulletGraph.TextAnchor|string; - - /** Subtitle render in the specified angle. - * @Default {0} - */ - textAngle?: number; - - /** Specifies where sub title text should be placed. - * @Default {'float'} - */ - textPosition?: ej.datavisualization.BulletGraph.TextPosition|string; -} - -export interface CaptionSettings { - - /** Specifies whether trim the labels will be true or false. - * @Default {true} - */ - enableTrim?: boolean; - - /** Contains property to customize the font of caption. - */ - font?: CaptionSettingsFont; - - /** Contains property to customize the indicator. - */ - indicator?: CaptionSettingsIndicator; - - /** Contains property to customize the location. - */ - location?: CaptionSettingsLocation; - - /** Specifies the padding to be applied when text position is used. - * @Default {5} - */ - padding?: number; - - /** Contains property to customize the subtitle. - */ - subTitle?: CaptionSettingsSubTitle; - - /** Specifies the text to be displayed on bullet graph. - */ - text?: string; - - /** Specifies the alignment of caption text with respect to scale. This property will not be applied when text position is float. - * @Default {'Near'} - */ - textAlignment?: ej.datavisualization.BulletGraph.TextAlignment|string; - - /** Specifies caption text anchoring when caption text overlaps with other caption group text. - * Text will be anchored when overlapping caption group text are at same position. Anchoring is not applicable for float position. - * @Default {'start'} - */ - textAnchor?: ej.datavisualization.BulletGraph.TextAnchor|string; - - /** Specifies the angel in which the caption is rendered. - * @Default {0} - */ - textAngle?: number; - - /** Specifies how caption text should be placed. - * @Default {'float'} - */ - textPosition?: ej.datavisualization.BulletGraph.TextPosition|string; -} - -export interface QualitativeRange { - - /** Specifies the ending range to which the qualitative ranges will render. - * @Default {3} - */ - rangeEnd?: number; - - /** Specifies the opacity for the qualitative ranges. - * @Default {1} - */ - rangeOpacity?: number; - - /** Specifies the stroke for the qualitative ranges. - * @Default {null} - */ - rangeStroke?: string; -} - -export interface QuantitativeScaleSettingsComparativeMeasureSettings { - - /** Specifies the stroke of the comparative measure. - * @Default {null} - */ - stroke?: number; - - /** Specifies the width of the comparative measure. - * @Default {5} - */ - width?: number; -} - -export interface QuantitativeScaleSettingsFeaturedMeasureSettings { - - /** Specifies the Stroke of the featured measure in bullet graph. - * @Default {null} - */ - stroke?: number; - - /** Specifies the width of the featured measure in bullet graph. - * @Default {2} - */ - width?: number; -} - -export interface QuantitativeScaleSettingsFeatureMeasure { - - /** Specifies the category of feature measure. - * @Default {null} - */ - category?: string; - - /** Comparative measure render till the specified value. - * @Default {null} - */ - comparativeMeasureValue?: number; - - /** Feature measure render till the specified value. - * @Default {null} - */ - value?: number; -} - -export interface QuantitativeScaleSettingsFields { - - /** Specifies the category of the bullet graph. - * @Default {null} - */ - category?: string; - - /** Comparative measure render based on the values in the specified field. - * @Default {null} - */ - comparativeMeasure?: string; - - /** Specifies the dataSource for the bullet graph. - * @Default {null} - */ - dataSource?: any; - - /** Feature measure render based on the values in the specified field. - * @Default {null} - */ - featureMeasures?: string; - - /** Specifies the query for fetching the values form data source to render the bullet graph. - * @Default {null} - */ - query?: string; - - /** Specifies the name of the table. - * @Default {null} - */ - tableName?: string; -} - -export interface QuantitativeScaleSettingsLabelSettingsFont { - - /** Specifies the fontFamily of labels in bullet graph. Labels render with this fontFamily. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Specifies the fontStyle of labels in bullet graph. Labels render with this fontStyle. See FontStyle - * @Default {Normal} - */ - fontStyle?: ej.datavisualization.BulletGraph.FontStyle|string; - - /** Specifies the fontWeight of labels in bullet graph. Labels render with this fontWeight. See FontWeight - * @Default {regular} - */ - fontWeight?: ej.datavisualization.BulletGraph.FontWeight|string; - - /** Specifies the opacity of labels in bullet graph. Labels render with this opacity - * @Default {1} - */ - opacity?: number; -} - -export interface QuantitativeScaleSettingsLabelSettings { - - /** Contains property to customize the font of the labels in bullet graph. - */ - font?: QuantitativeScaleSettingsLabelSettingsFont; - - /** Specifies the placement of labels in bullet graph scale. - * @Default {outside} - */ - labelPlacement?: ej.datavisualization.BulletGraph.LabelPlacement|string; - - /** Specifies the prefix to be added with labels in bullet graph. - * @Default {Empty string} - */ - labelPrefix?: string; - - /** Specifies the suffix to be added after labels in bullet graph. - * @Default {Empty string} - */ - labelSuffix?: string; - - /** Specifies the horizontal/vertical padding of labels. - * @Default {15} - */ - offset?: number; - - /** Specifies the position of the labels to render either above or below the graph. See Position - * @Default {below} - */ - position?: ej.datavisualization.BulletGraph.LabelPosition|string; - - /** Specifies the Size of the labels. - * @Default {12} - */ - size?: number; - - /** Specifies the stroke color of the labels in bullet graph. - * @Default {null} - */ - stroke?: string; -} - -export interface QuantitativeScaleSettingsLocation { - - /** This property specifies the x position for rendering quantitative scale. - * @Default {10} - */ - x?: number; - - /** This property specifies the y position for rendering quantitative scale. - * @Default {10} - */ - y?: number; -} - -export interface QuantitativeScaleSettingsMajorTickSettings { - - /** Specifies the size of the major ticks. - * @Default {13} - */ - size?: number; - - /** Specifies the stroke color of the major tick lines. - * @Default {null} - */ - stroke?: string; - - /** Specifies the width of the major tick lines. - * @Default {2} - */ - width?: number; -} - -export interface QuantitativeScaleSettingsMinorTickSettings { - - /** Specifies the size of minor ticks. - * @Default {7} - */ - size?: number; - - /** Specifies the stroke color of minor ticks in bullet graph. - * @Default {null} - */ - stroke?: string; - - /** Specifies the width of the minor ticks in bullet graph. - * @Default {2} - */ - width?: number; -} - -export interface QuantitativeScaleSettings { - - /** Contains property to customize the comparative measure. - */ - comparativeMeasureSettings?: QuantitativeScaleSettingsComparativeMeasureSettings; - - /** Contains property to customize the featured measure. - */ - featuredMeasureSettings?: QuantitativeScaleSettingsFeaturedMeasureSettings; - - /** Contains property to customize the featured measure. - */ - featureMeasures?: QuantitativeScaleSettingsFeatureMeasure[]; - - /** Contains property to customize the fields. - */ - fields?: QuantitativeScaleSettingsFields; - - /** Specifies the interval for the Graph. - * @Default {1} - */ - interval?: number; - - /** Contains property to customize the labels. - */ - labelSettings?: QuantitativeScaleSettingsLabelSettings; - - /** Contains property to customize the position of the quantitative scale - */ - location?: QuantitativeScaleSettingsLocation; - - /** Contains property to customize the major tick lines. - */ - majorTickSettings?: QuantitativeScaleSettingsMajorTickSettings; - - /** Specifies the maximum value of the Graph. - * @Default {10} - */ - maximum?: number; - - /** Specifies the minimum value of the Graph. - * @Default {0} - */ - minimum?: number; - - /** Contains property to customize the minor ticks. - */ - minorTickSettings?: QuantitativeScaleSettingsMinorTickSettings; - - /** The specified number of minor ticks will be rendered per interval. - * @Default {4} - */ - minorTicksPerInterval?: number; - - /** Specifies the placement of ticks to render either inside or outside the scale. - * @Default {ej.datavisualization.BulletGraph.TickPlacement.Outside} - */ - tickPlacement?: ej.datavisualization.BulletGraph.TickPlacement|string; - - /** Specifies the position of the ticks to render either above,below or inside - * @Default {ej.datavisualization.BulletGraph.TickPosition.Far} - */ - tickPosition?: ej.datavisualization.BulletGraph.TickPosition|string; -} - -export interface TooltipSettings { - - /** Specifies template for caption tooltip - * @Default {null} - */ - captionTemplate?: string; - - /** Toggles the visibility of caption tooltip - * @Default {false} - */ - enableCaptionTooltip?: boolean; - - /** Specifies the ID of a div, which is to be displayed as tooltip. - * @Default {null} - */ - template?: string; - - /** Toggles the visibility of tooltip - * @Default {true} - */ - visible?: boolean; -} -} -namespace BulletGraph { -enum FontStyle { -//string -Normal, -//string -Italic, -//string -Oblique, -} -} -namespace BulletGraph { -enum FontWeight { -//string -Normal, -//string -Bold, -//string -Bolder, -//string -Lighter, -} -} -namespace BulletGraph { -enum TextAlignment { -//string -Near, -//string -Far, -//string -Center, -} -} -namespace BulletGraph { -enum TextAnchor { -//string -Start, -//string -Middle, -//string -End, -} -} -namespace BulletGraph { -enum TextPosition { -//string -Top, -//string -Right, -//string -Left, -//string -Bottom, -//string -Float, -} -} -namespace BulletGraph { -enum FlowDirection { -//string -Forward, -//string -Backward, -} -} -namespace BulletGraph { -enum Orientation { -//string -Horizontal, -//string -Vertical, -} -} -namespace BulletGraph { -enum LabelPlacement { -//string -Inside, -//string -Outside, -} -} -namespace BulletGraph { -enum LabelPosition { -//string -Above, -//string -Below, -} -} -namespace BulletGraph { -enum TickPlacement { -//string -Inside, -//string -Outside, -} -} -namespace BulletGraph { -enum TickPosition { -//string -Below, -//string -Above, -//string -Cross, -} -} - -class Barcode extends ej.Widget { - static fn: Barcode; - constructor(element: JQuery | Element, options?: Barcode.Model); - static Locale: any; - model: Barcode.Model; - defaults: Barcode.Model; - - /** To disable the barcode - * @returns {void} - */ - disable(): void; - - /** To enable the barcode - * @returns {void} - */ - enable(): void; -} -export namespace Barcode { - -export interface Model { - - /** Specifies the distance between the barcode and text below it. - */ - barcodeToTextGapHeight?: number; - - /** Specifies the height of bars in the Barcode. By modifying the barHeight, the entire barcode height can be customized. - * Please refer to xDimension for two dimensional barcode height customization. - */ - barHeight?: number; - - /** Specifies the dark bar color of the Barcode. One dimensional barcode contains a series of dark and light bars which are usually colored as black and white respectively. - */ - darkBarColor?: any; - - /** Specifies whether the text below the barcode is visible or hidden. - */ - displayText?: boolean; - - /** Specifies whether the control is enabled. - */ - enabled?: boolean; - - /** Specifies the start and stop encode symbol in the Barcode. In one dimensional barcodes, an additional character is added as start and stop delimiters. - * These symbols are optional and the unique of the symbol allows the reader to determine the direction of the barcode being scanned. - */ - encodeStartStopSymbol?: number; - - /** Specifies the light bar color of the Barcode. One dimensional barcode contains a series of dark and light bars which are usually colored as black and white respectively. - */ - lightBarColor?: any; - - /** Specifies the width of the narrow bars in the barcode. The dark bars in the one dimensional barcode contains random narrow and wide bars based on - * the provided input which can be specified during initialization. - */ - narrowBarWidth?: number; - - /** Specifies the width of the quiet zone. In barcode, a quiet zone is the blank margin on either side of a barcode which informs the reader where a barcode's symbology starts and stops. - * The purpose of a quiet zone is to prevent the reader from picking up unrelated information. - */ - quietZone?: QuietZone; - - /** Specifies the type of the Barcode. See SymbologyType - */ - symbologyType?: ej.datavisualization.Barcode.SymbologyType|string; - - /** Specifies the text to be encoded in the barcode. - */ - text?: string; - - /** Specifies the color of the text/data at the bottom of the barcode. - */ - textColor?: any; - - /** Specifies the width of the wide bars in the barcode. One dimensional barcode usually contains random narrow and wide bars based on the provided which can be customized during initialization. - */ - wideBarWidth?: number; - - /** Specifies the width of the narrowest element(bar or space) in a barcode. The greater the x dimension, the more easily a barcode reader will scan. - */ - xDimension?: number; - - /** Fires after Barcode control is loaded. */ - load?(e: LoadEventArgs): void; -} - -export interface LoadEventArgs { - - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; - - /** returns the barcode model - */ - model?: any; - - /** returns the name of the event - */ - type?: string; - - /** return the barcode state - */ - status?: boolean; -} - -export interface QuietZone { - - /** Specifies the quiet zone around the Barcode. - */ - all?: number; - - /** Specifies the bottom quiet zone of the Barcode. - */ - bottom?: number; - - /** Specifies the left quiet zone of the Barcode. - */ - left?: number; - - /** Specifies the right quiet zone of the Barcode. - */ - right?: number; - - /** Specifies the top quiet zone of the Barcode. - */ - top?: number; -} -} -namespace Barcode { -enum SymbologyType { -//Represents the QR code -QRBarcode, -//Represents the Data Matrix barcode -DataMatrix, -//Represents the Code 39 barcode -Code39, -//Represents the Code 39 Extended barcode -Code39Extended, -//Represents the Code 11 barcode -Code11, -//Represents the Codabar barcode -Codabar, -//Represents the Code 32 barcode -Code32, -//Represents the Code 93 barcode -Code93, -//Represents the Code 93 Extended barcode -Code93Extended, -//Represents the Code 128 A barcode -Code128A, -//Represents the Code 128 B barcode -Code128B, -//Represents the Code 128 C barcode -Code128C, -} -} - -class Map extends ej.Widget { - static fn: Map; - constructor(element: JQuery | Element, options?: Map.Model); - static Locale: any; - model: Map.Model; - defaults: Map.Model; - - /** Method for navigating to specific shape based on latitude, longitude and zoom level. - * @param {number} Pass the latitude value for map - * @param {number} Pass the longitude value for map - * @param {number} Pass the zoom level for map - * @returns {void} - */ - navigateTo(latitude: number, longitude: number, level: number): void; - - /** Method to perform map panning - * @param {string} Pass the direction in which map should be panned - * @returns {void} - */ - pan(direction: string): void; - - /** Method to reload the map. - * @returns {void} - */ - refresh(): void; - - /** Method to reload the shapeLayers with updated values - * @returns {void} - */ - refreshLayers(): void; - - /** Method to reload the navigation control with updated values. - * @param {any} Pass the navigation control instance - * @returns {void} - */ - refreshNavigationControl(navigation: any): void; - - /** Method to perform map zooming. - * @param {number} Pass the zoom level for map to be zoomed - * @param {boolean} Pass the boolean value to enable or disable animation while zooming - * @returns {void} - */ - zoom(level: number, isAnimate: boolean): void; -} -export namespace Map { - -export interface Model { - - /** Specifies the background color for map - * @Default {transparent} - */ - background?: string; - - /** Specifies the index of the map to determine the shape layer to be displayed - * @Default {0} - */ - baseMapIndex?: number; - - /** Specify the center position where map should be displayed - * @Default {[0,0]} - */ - centerPosition?: any; - - /** Enables or Disables the map animation - * @Default {false} - */ - enableAnimation?: boolean; - - /** Enables or Disables the animation for layer change in map - * @Default {false} - */ - enableLayerChangeAnimation?: boolean; - - /** Enables or Disables the map panning - * @Default {true} - */ - enablePan?: boolean; - - /** Determines whether map need to resize when container is resized - * @Default {true} - */ - enableResize?: boolean; - - /** Enables or Disables the Zooming for map. - */ - zoomSettings?: ZoomSettings; - - /** Enables or Disables the navigation control for map to perform zooming and panning on map shapes. - */ - navigationControl?: NavigationControl; - - /** Layer for holding the map shapes - */ - layers?: Layer[]; - - /** Triggered on selecting the map markers. */ - markerSelected?(e: MarkerSelectedEventArgs): void; - - /** Triggers while leaving the hovered map shape */ - mouseleave?(e: MouseleaveEventArgs): void; - - /** Triggers while hovering the map shape. */ - mouseover?(e: MouseoverEventArgs): void; - - /** Triggers once map render completed. */ - onRenderComplete?(e: OnRenderCompleteEventArgs): void; - - /** Triggers when map panning ends. */ - panned?(e: PannedEventArgs): void; - - /** Triggered on selecting the map shapes. */ - shapeSelected?(e: ShapeSelectedEventArgs): void; - - /** Triggered when map is zoomed-in. */ - zoomedIn?(e: ZoomedInEventArgs): void; - - /** Triggers when map is zoomed out. */ - zoomedOut?(e: ZoomedOutEventArgs): void; -} + export interface DrawLabelsEventArgs { + + /** returns the object of the bullet graph. + */ + Object?: any; + + /** returns the options of the scale element. + */ + scaleElement?: HTMLElement; + + /** returns the current label element. + */ + tickElement?: HTMLElement; + + /** returns the label type. + */ + labelType?: string; + } + + export interface DrawQualitativeRangesEventArgs { + + /** returns the object of the bullet graph. + */ + Object?: any; + + /** returns the index of current range. + */ + rangeIndex?: number; + + /** returns the settings for current range. + */ + rangeOptions?: any; + + /** returns the end value of current range. + */ + rangeEndValue?: number; + } + + export interface LoadEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; + } + + export interface CaptionSettingsFont { + + /** Specifies the color of the text in caption. + * @Default {null} + */ + color?: string; + + /** Specifies the fontFamily of caption. Caption text render with this fontFamily + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Specifies the fontStyle of caption + * @Default {Normal} + */ + fontStyle?: ej.datavisualization.BulletGraph.FontStyle | string; + + /** Specifies the fontWeight of caption + * @Default {regular} + */ + fontWeight?: ej.datavisualization.BulletGraph.FontWeight | string; + + /** Specifies the opacity of caption. Caption text render with this opacity. + * @Default {1} + */ + opacity?: number; + + /** Specifies the size of caption. Caption text render with this size + * @Default {12px} + */ + size?: string; + } + + export interface CaptionSettingsIndicatorFont { + + /** Specifies the color of the indicator's text. + * @Default {null} + */ + color?: string; + + /** Specifies the fontFamily of indicator. Indicator text render with this fontFamily. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Specifies the fontStyle of indicator. Indicator text render with this fontStyle. See FontStyle + * @Default {Normal} + */ + fontStyle?: ej.datavisualization.BulletGraph.FontStyle | string; + + /** Specifies the fontWeight of indicator. Indicator text render with this fontWeight. See FontWeight + * @Default {regular} + */ + fontWeight?: ej.datavisualization.BulletGraph.FontWeight | string; + + /** Specifies the opacity of indicator text. Indicator text render with this Opacity. + * @Default {1} + */ + opacity?: number; + + /** Specifies the size of indicator. Indicator text render with this size. + * @Default {12px} + */ + size?: string; + } + + export interface CaptionSettingsIndicatorLocation { + + /** Specifies the horizontal position of the indicator. + * @Default {10} + */ + x?: number; + + /** Specifies the vertical position of the indicator. + * @Default {60} + */ + y?: number; + } + + export interface CaptionSettingsIndicatorSymbolBorder { + + /** Specifies the border color of indicator symbol. + * @Default {null} + */ + color?: string; + + /** Specifies the border width of indicator symbol. + * @Default {1} + */ + width?: number; + } + + export interface CaptionSettingsIndicatorSymbolSize { + + /** Specifies the height of indicator symbol. + * @Default {10} + */ + height?: number; + + /** Specifies the width of indicator symbol. + * @Default {10} + */ + width?: number; + } + + export interface CaptionSettingsIndicatorSymbol { + + /** Contains property to customize the border of indicator symbol. + */ + border?: CaptionSettingsIndicatorSymbolBorder; + + /** Specifies the color of indicator symbol. + * @Default {null} + */ + color?: string; + + /** Specifies the URL of image that represents indicator symbol. + */ + imageURL?: string; + + /** Specifies the opacity of indicator symbol. + * @Default {1} + */ + opacity?: number; + + /** Specifies the shape of indicator symbol. + */ + shape?: string; + + /** Contains property to customize the size of indicator symbol. + */ + size?: CaptionSettingsIndicatorSymbolSize; + } + + export interface CaptionSettingsIndicator { + + /** Contains property to customize the font of indicator. + */ + font?: CaptionSettingsIndicatorFont; + + /** Contains property to customize the location of indicator. + */ + location?: CaptionSettingsIndicatorLocation; + + /** Specifies the padding to be applied when text position is used. + * @Default {2} + */ + padding?: number; + + /** Contains property to customize the symbol of indicator. + */ + symbol?: CaptionSettingsIndicatorSymbol; + + /** Specifies the text to be displayed as indicator text. By default difference between current value and target will be displayed + */ + text?: string; + + /** Specifies the alignment of indicator with respect to scale based on text position + * @Default {'Near'} + */ + textAlignment?: ej.datavisualization.BulletGraph.TextAlignment | string; + + /** Specifies where indicator text should be anchored when indicator overlaps with other caption group text. Text will be anchored when overlapping caption group text are at same position. + * Anchoring is not applicable for float position. + * @Default {'start'} + */ + textAnchor?: ej.datavisualization.BulletGraph.TextAnchor | string; + + /** indicator text render in the specified angle. + * @Default {0} + */ + textAngle?: number; + + /** Specifies where indicator should be placed + * @Default {'float'} + */ + textPosition?: ej.datavisualization.BulletGraph.TextPosition | string; + + /** Specifies the space between indicator symbol and text. + * @Default {3} + */ + textSpacing?: number; + + /** Specifies whether indicator will be visible or not. + * @Default {false} + */ + visible?: boolean; + } + + export interface CaptionSettingsLocation { + + /** Specifies the position in horizontal direction + * @Default {17} + */ + x?: number; + + /** Specifies the position in horizontal direction + * @Default {30} + */ + y?: number; + } + + export interface CaptionSettingsSubTitleFont { + + /** Specifies the color of the subtitle's text. + * @Default {null} + */ + color?: string; + + /** Specifies the fontFamily of subtitle. Subtitle text render with this fontFamily. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Specifies the fontStyle of subtitle. Subtitle text render with this fontStyle. See FontStyle + * @Default {Normal} + */ + fontStyle?: ej.datavisualization.BulletGraph.FontStyle | string; + + /** Specifies the fontWeight of subtitle. Subtitle text render with this fontWeight. See FontWeight + * @Default {regular} + */ + fontWeight?: ej.datavisualization.BulletGraph.FontWeight | string; + + /** Specifies the opacity of subtitle. Subtitle text render with this opacity. + * @Default {1} + */ + opacity?: number; + + /** Specifies the size of subtitle. Subtitle text render with this size. + * @Default {12px} + */ + size?: string; + } + + export interface CaptionSettingsSubTitleLocation { + + /** Specifies the horizontal position of the subtitle. + * @Default {10} + */ + x?: number; + + /** Specifies the vertical position of the subtitle. + * @Default {45} + */ + y?: number; + } + + export interface CaptionSettingsSubTitle { + + /** Contains property to customize the font of subtitle. + */ + font?: CaptionSettingsSubTitleFont; + + /** Contains property to customize the location of subtitle. + */ + location?: CaptionSettingsSubTitleLocation; + + /** Specifies the padding to be applied when text position is used. + * @Default {5} + */ + padding?: number; + + /** Specifies the text to be displayed as subtitle. + */ + text?: string; + + /** Specifies the alignment of sub title text with respect to scale. Alignment will not be applied in float position. + * @Default {'Near'} + */ + textAlignment?: ej.datavisualization.BulletGraph.TextAlignment | string; + + /** Specifies where subtitle text should be anchored when sub title text overlaps with other caption group text. Text will be anchored when overlapping + * caption group text are at same position. Anchoring is not applicable for float position. + * @Default {'start'} + */ + textAnchor?: ej.datavisualization.BulletGraph.TextAnchor | string; + + /** Subtitle render in the specified angle. + * @Default {0} + */ + textAngle?: number; + + /** Specifies where sub title text should be placed. + * @Default {'float'} + */ + textPosition?: ej.datavisualization.BulletGraph.TextPosition | string; + } + + export interface CaptionSettings { + + /** Specifies whether trim the labels will be true or false. + * @Default {true} + */ + enableTrim?: boolean; + + /** Contains property to customize the font of caption. + */ + font?: CaptionSettingsFont; + + /** Contains property to customize the indicator. + */ + indicator?: CaptionSettingsIndicator; + + /** Contains property to customize the location. + */ + location?: CaptionSettingsLocation; + + /** Specifies the padding to be applied when text position is used. + * @Default {5} + */ + padding?: number; + + /** Contains property to customize the subtitle. + */ + subTitle?: CaptionSettingsSubTitle; + + /** Specifies the text to be displayed on bullet graph. + */ + text?: string; + + /** Specifies the alignment of caption text with respect to scale. This property will not be applied when text position is float. + * @Default {'Near'} + */ + textAlignment?: ej.datavisualization.BulletGraph.TextAlignment | string; + + /** Specifies caption text anchoring when caption text overlaps with other caption group text. + * Text will be anchored when overlapping caption group text are at same position. Anchoring is not applicable for float position. + * @Default {'start'} + */ + textAnchor?: ej.datavisualization.BulletGraph.TextAnchor | string; + + /** Specifies the angel in which the caption is rendered. + * @Default {0} + */ + textAngle?: number; + + /** Specifies how caption text should be placed. + * @Default {'float'} + */ + textPosition?: ej.datavisualization.BulletGraph.TextPosition | string; + } + + export interface QualitativeRange { + + /** Specifies the ending range to which the qualitative ranges will render. + * @Default {3} + */ + rangeEnd?: number; + + /** Specifies the opacity for the qualitative ranges. + * @Default {1} + */ + rangeOpacity?: number; + + /** Specifies the stroke for the qualitative ranges. + * @Default {null} + */ + rangeStroke?: string; + } + + export interface QuantitativeScaleSettingsComparativeMeasureSettings { + + /** Specifies the stroke of the comparative measure. + * @Default {null} + */ + stroke?: number; + + /** Specifies the width of the comparative measure. + * @Default {5} + */ + width?: number; + } + + export interface QuantitativeScaleSettingsFeaturedMeasureSettings { + + /** Specifies the Stroke of the featured measure in bullet graph. + * @Default {null} + */ + stroke?: number; + + /** Specifies the width of the featured measure in bullet graph. + * @Default {2} + */ + width?: number; + } + + export interface QuantitativeScaleSettingsFeatureMeasure { + + /** Specifies the category of feature measure. + * @Default {null} + */ + category?: string; + + /** Comparative measure render till the specified value. + * @Default {null} + */ + comparativeMeasureValue?: number; + + /** Feature measure render till the specified value. + * @Default {null} + */ + value?: number; + } + + export interface QuantitativeScaleSettingsFields { + + /** Specifies the category of the bullet graph. + * @Default {null} + */ + category?: string; + + /** Comparative measure render based on the values in the specified field. + * @Default {null} + */ + comparativeMeasure?: string; + + /** Specifies the dataSource for the bullet graph. + * @Default {null} + */ + dataSource?: any; + + /** Feature measure render based on the values in the specified field. + * @Default {null} + */ + featureMeasures?: string; + + /** Specifies the query for fetching the values form data source to render the bullet graph. + * @Default {null} + */ + query?: string; + + /** Specifies the name of the table. + * @Default {null} + */ + tableName?: string; + } + + export interface QuantitativeScaleSettingsLabelSettingsFont { + + /** Specifies the fontFamily of labels in bullet graph. Labels render with this fontFamily. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Specifies the fontStyle of labels in bullet graph. Labels render with this fontStyle. See FontStyle + * @Default {Normal} + */ + fontStyle?: ej.datavisualization.BulletGraph.FontStyle | string; + + /** Specifies the fontWeight of labels in bullet graph. Labels render with this fontWeight. See FontWeight + * @Default {regular} + */ + fontWeight?: ej.datavisualization.BulletGraph.FontWeight | string; + + /** Specifies the opacity of labels in bullet graph. Labels render with this opacity + * @Default {1} + */ + opacity?: number; + } + + export interface QuantitativeScaleSettingsLabelSettings { + + /** Contains property to customize the font of the labels in bullet graph. + */ + font?: QuantitativeScaleSettingsLabelSettingsFont; + + /** Specifies the placement of labels in bullet graph scale. + * @Default {outside} + */ + labelPlacement?: ej.datavisualization.BulletGraph.LabelPlacement | string; + + /** Specifies the prefix to be added with labels in bullet graph. + * @Default {Empty string} + */ + labelPrefix?: string; + + /** Specifies the suffix to be added after labels in bullet graph. + * @Default {Empty string} + */ + labelSuffix?: string; + + /** Specifies the horizontal/vertical padding of labels. + * @Default {15} + */ + offset?: number; + + /** Specifies the position of the labels to render either above or below the graph. See Position + * @Default {below} + */ + position?: ej.datavisualization.BulletGraph.LabelPosition | string; + + /** Specifies the Size of the labels. + * @Default {12} + */ + size?: number; + + /** Specifies the stroke color of the labels in bullet graph. + * @Default {null} + */ + stroke?: string; + } + + export interface QuantitativeScaleSettingsLocation { + + /** This property specifies the x position for rendering quantitative scale. + * @Default {10} + */ + x?: number; + + /** This property specifies the y position for rendering quantitative scale. + * @Default {10} + */ + y?: number; + } + + export interface QuantitativeScaleSettingsMajorTickSettings { + + /** Specifies the size of the major ticks. + * @Default {13} + */ + size?: number; + + /** Specifies the stroke color of the major tick lines. + * @Default {null} + */ + stroke?: string; + + /** Specifies the width of the major tick lines. + * @Default {2} + */ + width?: number; + } + + export interface QuantitativeScaleSettingsMinorTickSettings { + + /** Specifies the size of minor ticks. + * @Default {7} + */ + size?: number; + + /** Specifies the stroke color of minor ticks in bullet graph. + * @Default {null} + */ + stroke?: string; + + /** Specifies the width of the minor ticks in bullet graph. + * @Default {2} + */ + width?: number; + } + + export interface QuantitativeScaleSettings { + + /** Contains property to customize the comparative measure. + */ + comparativeMeasureSettings?: QuantitativeScaleSettingsComparativeMeasureSettings; + + /** Contains property to customize the featured measure. + */ + featuredMeasureSettings?: QuantitativeScaleSettingsFeaturedMeasureSettings; + + /** Contains property to customize the featured measure. + */ + featureMeasures?: QuantitativeScaleSettingsFeatureMeasure[]; + + /** Contains property to customize the fields. + */ + fields?: QuantitativeScaleSettingsFields; + + /** Specifies the interval for the Graph. + * @Default {1} + */ + interval?: number; + + /** Contains property to customize the labels. + */ + labelSettings?: QuantitativeScaleSettingsLabelSettings; + + /** Contains property to customize the position of the quantitative scale + */ + location?: QuantitativeScaleSettingsLocation; + + /** Contains property to customize the major tick lines. + */ + majorTickSettings?: QuantitativeScaleSettingsMajorTickSettings; + + /** Specifies the maximum value of the Graph. + * @Default {10} + */ + maximum?: number; + + /** Specifies the minimum value of the Graph. + * @Default {0} + */ + minimum?: number; + + /** Contains property to customize the minor ticks. + */ + minorTickSettings?: QuantitativeScaleSettingsMinorTickSettings; + + /** The specified number of minor ticks will be rendered per interval. + * @Default {4} + */ + minorTicksPerInterval?: number; + + /** Specifies the placement of ticks to render either inside or outside the scale. + * @Default {ej.datavisualization.BulletGraph.TickPlacement.Outside} + */ + tickPlacement?: ej.datavisualization.BulletGraph.TickPlacement | string; + + /** Specifies the position of the ticks to render either above,below or inside + * @Default {ej.datavisualization.BulletGraph.TickPosition.Far} + */ + tickPosition?: ej.datavisualization.BulletGraph.TickPosition | string; + } + + export interface TooltipSettings { + + /** Specifies template for caption tooltip + * @Default {null} + */ + captionTemplate?: string; + + /** Toggles the visibility of caption tooltip + * @Default {false} + */ + enableCaptionTooltip?: boolean; + + /** Specifies the ID of a div, which is to be displayed as tooltip. + * @Default {null} + */ + template?: string; + + /** Toggles the visibility of tooltip + * @Default {true} + */ + visible?: boolean; + } + } + namespace BulletGraph { + enum FontStyle { + //string + Normal, + //string + Italic, + //string + Oblique, + } + } + namespace BulletGraph { + enum FontWeight { + //string + Normal, + //string + Bold, + //string + Bolder, + //string + Lighter, + } + } + namespace BulletGraph { + enum TextAlignment { + //string + Near, + //string + Far, + //string + Center, + } + } + namespace BulletGraph { + enum TextAnchor { + //string + Start, + //string + Middle, + //string + End, + } + } + namespace BulletGraph { + enum TextPosition { + //string + Top, + //string + Right, + //string + Left, + //string + Bottom, + //string + Float, + } + } + namespace BulletGraph { + enum FlowDirection { + //string + Forward, + //string + Backward, + } + } + namespace BulletGraph { + enum Orientation { + //string + Horizontal, + //string + Vertical, + } + } + namespace BulletGraph { + enum LabelPlacement { + //string + Inside, + //string + Outside, + } + } + namespace BulletGraph { + enum LabelPosition { + //string + Above, + //string + Below, + } + } + namespace BulletGraph { + enum TickPlacement { + //string + Inside, + //string + Outside, + } + } + namespace BulletGraph { + enum TickPosition { + //string + Below, + //string + Above, + //string + Cross, + } + } + + class Barcode extends ej.Widget { + static fn: Barcode; + constructor(element: JQuery | Element, options?: Barcode.Model); + static Locale: any; + model: Barcode.Model; + defaults: Barcode.Model; + + /** To disable the barcode + * @returns {void} + */ + disable(): void; + + /** To enable the barcode + * @returns {void} + */ + enable(): void; + } + export namespace Barcode { + + export interface Model { + + /** Specifies the distance between the barcode and text below it. + */ + barcodeToTextGapHeight?: number; + + /** Specifies the height of bars in the Barcode. By modifying the barHeight, the entire barcode height can be customized. + * Please refer to xDimension for two dimensional barcode height customization. + */ + barHeight?: number; + + /** Specifies the dark bar color of the Barcode. One dimensional barcode contains a series of dark and light bars which are usually colored as black and white respectively. + */ + darkBarColor?: any; + + /** Specifies whether the text below the barcode is visible or hidden. + */ + displayText?: boolean; + + /** Specifies whether the control is enabled. + */ + enabled?: boolean; + + /** Specifies the start and stop encode symbol in the Barcode. In one dimensional barcodes, an additional character is added as start and stop delimiters. + * These symbols are optional and the unique of the symbol allows the reader to determine the direction of the barcode being scanned. + */ + encodeStartStopSymbol?: number; + + /** Specifies the light bar color of the Barcode. One dimensional barcode contains a series of dark and light bars which are usually colored as black and white respectively. + */ + lightBarColor?: any; + + /** Specifies the width of the narrow bars in the barcode. The dark bars in the one dimensional barcode contains random narrow and wide bars based on + * the provided input which can be specified during initialization. + */ + narrowBarWidth?: number; + + /** Specifies the width of the quiet zone. In barcode, a quiet zone is the blank margin on either side of a barcode which informs the reader where a barcode's symbology starts and stops. + * The purpose of a quiet zone is to prevent the reader from picking up unrelated information. + */ + quietZone?: QuietZone; + + /** Specifies the type of the Barcode. See SymbologyType + */ + symbologyType?: ej.datavisualization.Barcode.SymbologyType | string; + + /** Specifies the text to be encoded in the barcode. + */ + text?: string; + + /** Specifies the color of the text/data at the bottom of the barcode. + */ + textColor?: any; + + /** Specifies the width of the wide bars in the barcode. One dimensional barcode usually contains random narrow and wide bars based on the provided which can be customized during initialization. + */ + wideBarWidth?: number; + + /** Specifies the width of the narrowest element(bar or space) in a barcode. The greater the x dimension, the more easily a barcode reader will scan. + */ + xDimension?: number; + + /** Fires after Barcode control is loaded. */ + load?(e: LoadEventArgs): void; + } + + export interface LoadEventArgs { + + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; + + /** returns the barcode model + */ + model?: any; + + /** returns the name of the event + */ + type?: string; + + /** return the barcode state + */ + status?: boolean; + } + + export interface QuietZone { + + /** Specifies the quiet zone around the Barcode. + */ + all?: number; + + /** Specifies the bottom quiet zone of the Barcode. + */ + bottom?: number; + + /** Specifies the left quiet zone of the Barcode. + */ + left?: number; + + /** Specifies the right quiet zone of the Barcode. + */ + right?: number; + + /** Specifies the top quiet zone of the Barcode. + */ + top?: number; + } + } + namespace Barcode { + enum SymbologyType { + //Represents the QR code + QRBarcode, + //Represents the Data Matrix barcode + DataMatrix, + //Represents the Code 39 barcode + Code39, + //Represents the Code 39 Extended barcode + Code39Extended, + //Represents the Code 11 barcode + Code11, + //Represents the Codabar barcode + Codabar, + //Represents the Code 32 barcode + Code32, + //Represents the Code 93 barcode + Code93, + //Represents the Code 93 Extended barcode + Code93Extended, + //Represents the Code 128 A barcode + Code128A, + //Represents the Code 128 B barcode + Code128B, + //Represents the Code 128 C barcode + Code128C, + } + } + + class Map extends ej.Widget { + static fn: Map; + constructor(element: JQuery | Element, options?: Map.Model); + static Locale: any; + model: Map.Model; + defaults: Map.Model; + + /** Method for navigating to specific shape based on latitude, longitude and zoom level. + * @param {number} Pass the latitude value for map + * @param {number} Pass the longitude value for map + * @param {number} Pass the zoom level for map + * @returns {void} + */ + navigateTo(latitude: number, longitude: number, level: number): void; + + /** Method to perform map panning + * @param {string} Pass the direction in which map should be panned + * @returns {void} + */ + pan(direction: string): void; + + /** Method to reload the map. + * @returns {void} + */ + refresh(): void; + + /** Method to reload the shapeLayers with updated values + * @returns {void} + */ + refreshLayers(): void; + + /** Method to reload the navigation control with updated values. + * @param {any} Pass the navigation control instance + * @returns {void} + */ + refreshNavigationControl(navigation: any): void; + + /** Method to perform map zooming. + * @param {number} Pass the zoom level for map to be zoomed + * @param {boolean} Pass the boolean value to enable or disable animation while zooming + * @returns {void} + */ + zoom(level: number, isAnimate: boolean): void; + } + export namespace Map { + + export interface Model { + + /** Specifies the background color for map + * @Default {transparent} + */ + background?: string; + + /** Specifies the index of the map to determine the shape layer to be displayed + * @Default {0} + */ + baseMapIndex?: number; + + /** Specify the center position where map should be displayed + * @Default {[0,0]} + */ + centerPosition?: any; + + /** Enables or Disables the map animation + * @Default {false} + */ + enableAnimation?: boolean; + + /** Enables or Disables the animation for layer change in map + * @Default {false} + */ + enableLayerChangeAnimation?: boolean; + + /** Enables or Disables the map panning + * @Default {true} + */ + enablePan?: boolean; + + /** Determines whether map need to resize when container is resized + * @Default {true} + */ + enableResize?: boolean; + + /** Enables or Disables the Zooming for map. + */ + zoomSettings?: ZoomSettings; + + /** Enables or Disables the navigation control for map to perform zooming and panning on map shapes. + */ + navigationControl?: NavigationControl; + + /** Layer for holding the map shapes + */ + layers?: Layer[]; + + /** Triggered on selecting the map markers. */ + markerSelected?(e: MarkerSelectedEventArgs): void; + + /** Triggers while leaving the hovered map shape */ + mouseleave?(e: MouseleaveEventArgs): void; + + /** Triggers while hovering the map shape. */ + mouseover?(e: MouseoverEventArgs): void; + + /** Triggers once map render completed. */ + onRenderComplete?(e: OnRenderCompleteEventArgs): void; + + /** Triggers when map panning ends. */ + panned?(e: PannedEventArgs): void; + + /** Triggered on selecting the map shapes. */ + shapeSelected?(e: ShapeSelectedEventArgs): void; + + /** Triggered when map is zoomed-in. */ + zoomedIn?(e: ZoomedInEventArgs): void; + + /** Triggers when map is zoomed out. */ + zoomedOut?(e: ZoomedOutEventArgs): void; + } -export interface MarkerSelectedEventArgs { - - /** Returns marker object. - */ - originalEvent?: any; -} - -export interface MouseleaveEventArgs { + export interface MarkerSelectedEventArgs { + + /** Returns marker object. + */ + originalEvent?: any; + } + + export interface MouseleaveEventArgs { - /** Returns hovered map shape object. - */ - originalEvent?: any; -} + /** Returns hovered map shape object. + */ + originalEvent?: any; + } -export interface MouseoverEventArgs { + export interface MouseoverEventArgs { - /** Returns hovered map shape object. - */ - originalEvent?: any; -} + /** Returns hovered map shape object. + */ + originalEvent?: any; + } -export interface OnRenderCompleteEventArgs { + export interface OnRenderCompleteEventArgs { - /** Event parameters from map - */ - originalEvent?: any; -} + /** Event parameters from map + */ + originalEvent?: any; + } -export interface PannedEventArgs { + export interface PannedEventArgs { - /** Event parameters from map - */ - originalEvent?: any; -} + /** Event parameters from map + */ + originalEvent?: any; + } -export interface ShapeSelectedEventArgs { + export interface ShapeSelectedEventArgs { - /** Returns selected shape object. - */ - originalEvent?: any; -} + /** Returns selected shape object. + */ + originalEvent?: any; + } -export interface ZoomedInEventArgs { + export interface ZoomedInEventArgs { - /** Event parameters from map - */ - originalEvent?: any; + /** Event parameters from map + */ + originalEvent?: any; - /** Returns zoom level value for which the map is zoomed. - */ - zoomLevel?: any; -} + /** Returns zoom level value for which the map is zoomed. + */ + zoomLevel?: any; + } -export interface ZoomedOutEventArgs { + export interface ZoomedOutEventArgs { - /** Event parameters from map - */ - originalEvent?: any; + /** Event parameters from map + */ + originalEvent?: any; - /** Returns zoom level value for which the map is zoomed. - */ - zoomLevel?: any; -} + /** Returns zoom level value for which the map is zoomed. + */ + zoomLevel?: any; + } -export interface ZoomSettings { + export interface ZoomSettings { - /** Enables or Disables the zooming of map - * @Default {true} - */ - enableZoom?: boolean; + /** Enables or Disables the zooming of map + * @Default {true} + */ + enableZoom?: boolean; - /** Enables or Disables the zoom on selecting the map shape - * @Default {false} - */ - enableZoomOnSelection?: boolean; + /** Enables or Disables the zoom on selecting the map shape + * @Default {false} + */ + enableZoomOnSelection?: boolean; - /** Specifies the zoom factor for map zoom value. - * @Default {1} - */ - factor?: number; + /** Specifies the zoom factor for map zoom value. + * @Default {1} + */ + factor?: number; - /** Specifies the zoom level value for which map to be zoomed - * @Default {1} - */ - level?: number; - - /** Specifies the minimum zoomSettings level of the map - * @Default {1} - */ - minValue?: number; - - /** Specifies the maximum zoom level of the map - * @Default {100} - */ - maxValue?: number; -} - -export interface NavigationControl { - - /** Set the absolutePosition for navigation control - * @Default {{x:0,y:0}} - */ - absolutePosition?: any; - - /** Specifies the navigation control template for map - * @Default {null} - */ - content?: string; - - /** Set the dockPosition value for navigation control - * @Default {centerleft} - */ - dockPosition?: ej.datavisualization.Map.Position|string; - - /** Enables or Disables the Navigation for handling zooming map - * @Default {false} - */ - enableNavigation?: boolean; - - /** Set the orientation value for navigation control - * @Default {vertical} - */ - orientation?: ej.datavisualization.Map.LabelOrientation|string; -} - -export interface LayersBubbleSettingsColorMappingsRangeColorMapping { - - /** Start range colorMappings in the bubble layer. - * @Default {null} - */ - from?: number; - - /** End range colorMappings in the bubble layer. - * @Default {null} - */ - to?: number; - - /** GradientColors in the bubble layer of map. - */ - gradientColors?: any[]; - - /** Color of the bubble layer. - * @Default {null} - */ - color?: string; -} - -export interface LayersBubbleSettingsColorMappings { - - /** Specifies the range colorMappings in the bubble layer. - * @Default {null} - */ - rangeColorMapping?: LayersBubbleSettingsColorMappingsRangeColorMapping[]; -} - -export interface LayersBubbleSettings { - - /** Specifies the bubble Opacity value of bubbles for shape layer in map - * @Default {0.9} - */ - bubbleOpacity?: number; - - /** Specifies the mouse hover color of the shape layer in map - * @Default {gray} - */ - color?: string; - - /** Specifies the colorMappings of the shape layer in map - * @Default {null} - */ - colorMappings?: LayersBubbleSettingsColorMappings; - - /** Specifies the bubble color valuePath of the shape layer in map - * @Default {null} - */ - colorValuePath?: string; - - /** Specifies the maximum size value of bubbles for shape layer in map - * @Default {20} - */ - maxValue?: number; - - /** Specifies the minimum size value of bubbles for shape layer in map - * @Default {10} - */ - minValue?: number; - - /** Specifies the showBubble visibility status map - * @Default {true} - */ - showBubble?: boolean; - - /** Specifies the tooltip visibility status of the shape layer in map - * @Default {false} - */ - showTooltip?: boolean; - - /** Specifies the bubble tooltip template of the shape layer in map - * @Default {null} - */ - tooltipTemplate?: string; - - /** Specifies the bubble valuePath of the shape layer in map - * @Default {null} - */ - valuePath?: string; -} - -export interface LayersLabelSettings { - - /** enable or disable the enableSmartLabel property - * @Default {false} - */ - enableSmartLabel?: boolean; - - /** set the labelLength property - * @Default {'2'} - */ - labelLength?: number; - - /** set the labelPath property - * @Default {null} - */ - labelPath?: string; - - /** The property specifies whether to show labels or not. - * @Default {false} - */ - showLabels?: boolean; - - /** set the smartLabelSize property - * @Default {fixed} - */ - smartLabelSize?: ej.datavisualization.Map.LabelSize|string; -} - -export interface LayersLegendSettings { - - /** Determines whether the legend should be placed outside or inside the map bounds - * @Default {false} - */ - dockOnMap?: boolean; - - /** Determines the legend placement and it is valid only when dockOnMap is true - * @Default {top} - */ - dockPosition?: ej.datavisualization.Map.DockPosition|string; - - /** height value for legend setting - * @Default {0} - */ - height?: number; - - /** to get icon value for legend setting - * @Default {rectangle} - */ - icon?: ej.datavisualization.Map.LegendIcons|string; - - /** icon height value for legend setting - * @Default {20} - */ - iconHeight?: number; - - /** icon Width value for legend setting - * @Default {20} - */ - iconWidth?: number; - - /** set the orientation of legend labels - * @Default {vertical} - */ - labelOrientation?: ej.datavisualization.Map.LabelOrientation|string; - - /** to get leftLabel value for legend setting - * @Default {null} - */ - leftLabel?: string; - - /** to get mode of legend setting - * @Default {default} - */ - mode?: ej.datavisualization.Map.Mode|string; - - /** set the position of legend settings - * @Default {topleft} - */ - position?: ej.datavisualization.Map.Position|string; - - /** x position value for legend setting - * @Default {0} - */ - positionX?: number; - - /** y position value for legend setting - * @Default {0} - */ - positionY?: number; - - /** to get rightLabel value for legend setting - * @Default {null} - */ - rightLabel?: string; - - /** Enables or Disables the showLabels - * @Default {false} - */ - showLabels?: boolean; - - /** Enables or Disables the showLegend - * @Default {false} - */ - showLegend?: boolean; - - /** to get title of legend setting - * @Default {null} - */ - title?: string; - - /** to get type of legend setting - * @Default {layers} - */ - type?: ej.datavisualization.Map.LegendType|string; - - /** width value for legend setting - * @Default {0} - */ - width?: number; -} - -export interface LayersShapeSettingsColorMappingsRangeColorMapping { - - /** Specifies the start range colorMappings in the shape layer of map. - * @Default {null} - */ - from?: number; - - /** Specifies the to range colorMappings in the shape layer of map. - * @Default {null} - */ - to?: number; - - /** Specifies the gradientColors in the shape layer of map. - * @Default {null} - */ - gradientColors?: any[]; -} - -export interface LayersShapeSettingsColorMappingsEqualColorMapping { - - /** Specifies the equalColorMapping value in the shape layer of map. - * @Default {null} - */ - value?: string; - - /** Specifies the equalColorMapping color in the shape layer of map. - * @Default {null} - */ - color?: string; -} - -export interface LayersShapeSettingsColorMappings { - - /** Specifies the range colorMappings in the shape layer of map. - * @Default {null} - */ - rangeColorMapping?: LayersShapeSettingsColorMappingsRangeColorMapping[]; - - /** Specifies the equalColorMapping in the shape layer of map. - * @Default {null} - */ - equalColorMapping?: LayersShapeSettingsColorMappingsEqualColorMapping[]; -} - -export interface LayersShapeSettings { - - /** Enables or Disables the auto fill colors for shape layer in map. When this property value set to true, shapes will be filled with palette colors. - * @Default {false} - */ - autoFill?: boolean; - - /** Specifies the colorMappings of the shape layer in map - * @Default {null} - */ - colorMappings?: LayersShapeSettingsColorMappings; - - /** Specifies the shape color palette value of the shape layer in map. Accepted colorPalette values are palette1, palette2, palette3 and custompalette. - * @Default {palette1} - */ - colorPalette?: ej.datavisualization.Map.ColorPalette|string; - - /** Specifies the shape color valuePath of the shape layer in map - * @Default {null} - */ - colorValuePath?: string; - - /** Enables or Disables the gradient colors for map shapes. - * @Default {false} - */ - enableGradient?: boolean; - - /** Specifies the shape fill color of the shape layer in map - * @Default {#E5E5E5} - */ - fill?: string; - - /** Specifies the mouse over width of the shape layer in map - * @Default {1} - */ - highlightBorderWidth?: number; - - /** Specifies the mouse hover color of the shape layer in map - * @Default {gray} - */ - highlightColor?: string; - - /** Specifies the mouse over stroke color of the shape layer in map - * @Default {#C1C1C1} - */ - highlightStroke?: string; - - /** Specifies the shape selection color of the shape layer in map - * @Default {gray} - */ - selectionColor?: string; - - /** Specifies the shape selection stroke color of the shape layer in map - * @Default {#C1C1C1} - */ - selectionStroke?: string; - - /** Specifies the shape selection stroke width of the shape layer in map - * @Default {1} - */ - selectionStrokeWidth?: number; - - /** Specifies the shape stroke color of the shape layer in map - * @Default {#C1C1C1} - */ - stroke?: string; - - /** Specifies the shape stroke thickness value of the shape layer in map - * @Default {0.2} - */ - strokeThickness?: number; - - /** Specifies the shape valuePath of the shape layer in map - * @Default {null} - */ - valuePath?: string; -} - -export interface Layer { - - /** to get the type of bing map. - * @Default {aerial} - */ - bingMapType?: ej.datavisualization.Map.BingMapType|string; - - /** Specifies the bubble settings for map - */ - bubbleSettings?: LayersBubbleSettings; - - /** Specifies the datasource for the shape layer - */ - dataSource?: any; - - /** Specifies the data path of shape - */ - shapeDataPath?: string; - - /** Specifies the data path of shape - */ - shapePropertyPath?: string; - - /** Enables or disables the shape mouse hover - * @Default {false} - */ - enableMouseHover?: boolean; - - /** Enables or disables the shape selection - * @Default {true} - */ - enableSelection?: boolean; - - /** to get the key of bing map - * @Default {null} - */ - key?: string; - - /** Options for enabling and configuring labelSettings labelPath, smartLabelSize, labelLength etc., - */ - labelSettings?: LayersLabelSettings; - - /** Specifies the map view type. - * @Default {'geographic'} - */ - geometryType?: ej.datavisualization.Map.GeometryType|string; - - /** Specifies the map type. - * @Default {'geometry'} - */ - layerType?: ej.datavisualization.Map.LayerType|string; - - /** Options for enabling and configuring legendSettings position, height, width, mode, type etc., - */ - legendSettings?: LayersLegendSettings; - - /** Specifies the map items template for shapes. - */ - mapItemsTemplate?: string; - - /** Specify markers for shape layer. - * @Default {[]} - */ - markers?: any[]; - - /** Specifies the map marker template for map layer. - * @Default {null} - */ - markerTemplate?: string; - - /** Specify selectedMapShapes for shape layer - * @Default {[]} - */ - selectedMapShapes?: any[]; - - /** Specifies the selection mode of the map. Accepted selection mode values are Default and Multiple. - * @Default {default} - */ - selectionMode?: ej.datavisualization.Map.SelectionMode|string; - - /** Specifies the shape data for the shape layer - */ - shapeData?: any; - - /** Specifies the shape settings of map layer - */ - shapeSettings?: LayersShapeSettings; - - /** Shows or hides the map items. - * @Default {false} - */ - showMapItems?: boolean; - - /** Shows or hides the tooltip for shapes - * @Default {false} - */ - showTooltip?: boolean; - - /** Specifies the tooltip template for shapes. - */ - tooltipTemplate?: string; - - /** Specifies the URL template for the OSM type map. - * @Default {'http://a.tile.openstreetmap.org/level/tileX/tileY.png'} - */ - urlTemplate?: string; -} -} -namespace Map { -enum Position { -//specifies the none position -None, -//specifies the topleft position -Topleft, -//specifies the topcenter position -Topcenter, -//specifies the topright position -Topright, -//specifies the centerleft position -Centerleft, -//specifies the center position -Center, -//specifies the centerright position -Centerright, -//specifies the bottomleft position -Bottomleft, -//specifies the bottomcenter position -Bottomcenter, -//specifies the bottomright position -Bottomright, -} -} -namespace Map { -enum LabelOrientation { -//specifies the horizontal position -Horizontal, -//specifies the vertical position -Vertical, -} -} -namespace Map { -enum BingMapType { -//specifies the aerial type -Aerial, -//specifies the aerialwithlabel type -Aerialwithlabel, -//specifies the road type -Road, -} -} -namespace Map { -enum LabelSize { -//specifies the fixed size -Fixed, -//specifies the default size -Default, -} -} -namespace Map { -enum GeometryType { -//specifies the geographic view of map -Geographic, -//specifies the normal land view of map -Normal, -} -} -namespace Map { -enum LayerType { -//specifies the geometry type -Geometry, -//specifies the osm type -Osm, -//specifies the bing type -Bing, -} -} -namespace Map { -enum DockPosition { -//specifies the top position -Top, -//specifies the bottom position -Bottom, -//specifies the bottom position -Right, -//specifies the left position -Left, -} -} -namespace Map { -enum LegendIcons { -//specifies the rectangle position -Rectangle, -//specifies the circle position -Circle, -} -} -namespace Map { -enum Mode { -//specifies the default mode -Default, -//specifies the interactive mode -Interactive, -} -} -namespace Map { -enum LegendType { -//specifies the layers type -Layers, -//specifies the bubbles type -Bubbles, -} -} -namespace Map { -enum SelectionMode { -//specifies the default position -Default, -//specifies the multiple position -Multiple, -} -} -namespace Map { -enum ColorPalette { -//specifies the palette1 color -Palette1, -//specifies the palette2 color -Palette2, -//specifies the palette3 color -Palette3, -//specifies the custom color -Custompalette, -} -} - -class TreeMap extends ej.Widget { - static fn: TreeMap; - constructor(element: JQuery | Element, options?: TreeMap.Model); - static Locale: any; - model: TreeMap.Model; - defaults: TreeMap.Model; - - /** Method to reload treemap with updated values. - * @returns {void} - */ - refresh(): void; -} -export namespace TreeMap { - -export interface Model { - - /** Specifies the border brush color of the treemap - * @Default {white} - */ - borderBrush?: string; - - /** Specifies the border thickness of the treemap - * @Default {1} - */ - borderThickness?: number; - - /** Specifies the uniColorMapping settings of the treemap - */ - uniColorMapping?: UniColorMapping; - - /** Specifies the desaturationColorMapping settings of the treemap - */ - desaturationColorMapping?: DesaturationColorMapping; - - /** Specifies the paletteColorMapping of the treemap - */ - paletteColorMapping?: PaletteColorMapping; - - /** Specifies the color value path of the treemap - * @Default {null} - */ - colorValuePath?: string; - - /** Specifies the datasource of the treemap - * @Default {null} - */ - dataSource?: any; - - /** Specifies the dockPosition for legend - * @Default {top} - */ - dockPosition?: ej.datavisualization.TreeMap.DockPosition|string; - - /** specifies the drillDown header color - * @Default {'null'} - */ - drillDownHeaderColor?: string; - - /** specifies the drillDown selection color - * @Default {'#000000'} - */ - drillDownSelectionColor?: string; - - /** Specifies whether datasource is hierarchical or not. - * @Default {false} - */ - isHierarchicalDatasource?: boolean; - - /** Specifies the header for parent item during drilldown. This is applicable only for hierarchical data source. - * @Default {null} - */ - header?: string; - - /** Enable/Disable the drillDown for treemap - * @Default {false} - */ - enableDrillDown?: boolean; - - /** Controls whether Treemap has to be responsive while resizing the window. - * @Default {true} - */ - isResponsive?: boolean; - - /** Specifies whether treemap need to resize when container is resized - * @Default {true} - */ - enableResize?: boolean; - - /** This property is used to select treemap items while clicking and dragging - * @Default {false} - */ - draggingOnSelection?: boolean; - - /** This property is used to select group of treemap items while clicking and dragging - * @Default {false} - */ - draggingGroupOnSelection?: boolean; - - /** Specifies the group color mapping of the treemap - * @Default {[]} - */ - groupColorMapping?: GroupColorMapping[]; - - /** Specifies the legend settings of the treemap - */ - legendSettings?: LegendSettings; - - /** Specifies the highlight border brush of treemap - * @Default {gray} - */ - highlightBorderBrush?: string; - - /** Specifies the border thickness when treemap items is highlighted in the treemap - * @Default {5} - */ - highlightBorderThickness?: number; - - /** Specifies the highlight border brush of treemap - * @Default {gray} - */ - highlightGroupBorderBrush?: string; - - /** Specifies the border thickness when treemap items is highlighted in the treemap - * @Default {5} - */ - highlightGroupBorderThickness?: number; - - /** Specifies whether treemap item need to highlighted on selection - * @Default {false} - */ - highlightGroupOnSelection?: boolean; - - /** Specifies whether treemap item need to highlighted on selection - * @Default {false} - */ - highlightOnSelection?: boolean; - - /** Specifies the items layout mode of the treemap. Accepted itemsLayoutMode values are Squarified, SliceAndDiceHorizontal, SliceAndDiceVertical and SliceAndDiceAuto - * @Default {Squarified} - */ - itemsLayoutMode?: ej.datavisualization.TreeMap.ItemsLayoutMode|string; - - /** Specifies the leaf settings of the treemap - */ - leafItemSettings?: LeafItemSettings; - - /** Specifies the rangeColorMapping settings of the treemap - * @Default {[]} - */ - rangeColorMapping?: RangeColorMapping[]; - - /** Specifies the selection mode of treemap item. Accepted selection mode values are Default and Multiple. - * @Default {default} - */ - selectionMode?: ej.datavisualization.TreeMap.selectionMode|string; - - /** Specifies the selection mode of the treemap. Accepted selection mode values are Default and Multiple. - * @Default {default} - */ - groupSelectionMode?: ej.datavisualization.TreeMap.groupSelectionMode|string; - - /** Specifies the legend visibility status of the treemap - * @Default {false} - */ - showLegend?: boolean; - - /** Specifies whether gradient color has to be applied for treemap items - * @Default {false} - */ - enableGradient?: boolean; - - /** Specifies whether treemap showTooltip need to be visible - */ - showTooltip?: boolean; - - /** Specifies the tooltip template of the treemap - * @Default {null} - */ - tooltipTemplate?: string; - - /** Hold the treeMapItems to be displayed in treemap - * @Default {[]} - */ - treeMapItems?: any[]; - - /** Specify levels of treemap for grouped visualization of data - * @Default {[]} - */ - levels?: Level[]; - - /** Specifies the weight value path of the treemap - * @Default {null} - */ - weightValuePath?: string; - - /** Triggers on treemap item selected. */ - treeMapItemSelected?(e: TreeMapItemSelectedEventArgs): void; -} - -export interface TreeMapItemSelectedEventArgs { - - /** Returns selected treeMapItem object. - */ - originalEvent?: any; -} - -export interface UniColorMapping { - - /** Specifies the uniform color mapping of the treemap - * @Default {null} - */ - color?: string; -} - -export interface DesaturationColorMapping { - - /** Specifies the to value for desaturation color mapping - * @Default {0} - */ - to?: number; - - /** Specifies the color for desaturationColorMapping - * @Default {null} - */ - color?: string; - - /** Specifies the from value for desaturation color mapping - * @Default {0} - */ - from?: number; - - /** Specifies the rangeMaximum value for desaturation color mapping - * @Default {0} - */ - rangeMaximum?: number; - - /** Specifies the rangeMinimum value for desaturation color mapping - * @Default {0} - */ - rangeMinimum?: number; -} - -export interface PaletteColorMapping { - - /** Specifies the colors of the paletteColorMapping - * @Default {[]} - */ - colors?: any[]; -} - -export interface GroupColorMapping { - - /** Specifies the groupID for GroupColorMapping. - * @Default {null} - */ - groupID?: string; -} - -export interface LegendSettings { - - /** Specifies the height for legend - * @Default {30} - */ - height?: number; - - /** Specifies the width for legend - * @Default {100} - */ - width?: number; - - /** Specifies the iconHeight for legend - * @Default {15} - */ - iconHeight?: number; - - /** Specifies the iconWidth for legend - * @Default {15} - */ - iconWidth?: number; - - /** Specifies the template for legendSettings - * @Default {null} - */ - template?: string; - - /** Specifies the mode for legendSettings whether default or interactive mode - * @Default {default} - */ - mode?: string; - - /** Specifies the title text for legend - */ - title?: string; - - /** Specifies the leftLabel text for legend - */ - leftLabel?: string; - - /** Specifies the rightLabel text for legend - */ - rightLabel?: string; - - /** Specifies the dockPosition text for legend - * @Default {top} - */ - dockPosition?: string; - - /** Specifies the alignment text for legend - * @Default {near} - */ - alignment?: string; - - /** Specifies the alignment text for legend - * @Default {0} - */ - columnCount?: number; -} - -export interface LeafItemSettings { - - /** Specifies the border brush color of the leaf item. - * @Default {white} - */ - borderBrush?: string; - - /** Specifies the border thickness of the leaf item. - * @Default {1} - */ - borderThickness?: number; - - /** Specifies the label template of the leaf item. - * @Default {null} - */ - itemTemplate?: string; - - /** Specifies the label path of the leaf item. - * @Default {null} - */ - labelPath?: string; - - /** Specifies the position of the leaf labels. - * @Default {center} - */ - labelPosition?: ej.datavisualization.TreeMap.Position|string; - - /** Specifies the mode of label visibility - * @Default {visible} - */ - labelVisibilityMode?: ej.datavisualization.TreeMap.VisibilityMode|string; - - /** Shows or hides the label of the leaf item. - * @Default {false} - */ - showLabels?: boolean; -} - -export interface RangeColorMapping { - - /** Specifies the color value for rangeColorMapping. - * @Default {null} - */ - color?: string; - - /** specifies the gradient colors for th given range value - * @Default {[]} - */ - gradientColors?: any[]; - - /** Specifies the from value for rangeColorMapping. - * @Default {-1} - */ - from?: number; - - /** Specifies the legend label value for rangeColorMapping. - * @Default {null} - */ - legendLabel?: string; - - /** Specifies the to value for rangeColorMapping. - * @Default {-1} - */ - to?: number; -} - -export interface Level { - - /** specifies the group background - * @Default {null} - */ - groupBackground?: string; - - /** Specifies the group border color for tree map level. - * @Default {null} - */ - groupBorderColor?: string; - - /** Specifies the group border thickness for tree map level. - * @Default {1} - */ - groupBorderThickness?: number; - - /** Specifies the group gap for tree map level. - * @Default {1} - */ - groupGap?: number; - - /** Specifies the group padding for tree map level. - * @Default {4} - */ - groupPadding?: number; - - /** Specifies the group path for tree map level. - */ - groupPath?: string; - - /** Specifies the header height for tree map level. - * @Default {0} - */ - headerHeight?: number; - - /** Specifies the header template for tree map level. - * @Default {null} - */ - headerTemplate?: string; - - /** Specifies the mode of header visibility - * @Default {visible} - */ - headerVisibilityMode?: ej.datavisualization.TreeMap.VisibilityMode|string; - - /** Specifies the position of the labels. - * @Default {center} - */ - labelPosition?: ej.datavisualization.TreeMap.Position|string; - - /** Specifies the label template for tree map level. - * @Default {null} - */ - labelTemplate?: string; - - /** Specifies the mode of label visibility - * @Default {visible} - */ - labelVisibilityMode?: ej.datavisualization.TreeMap.VisibilityMode|string; - - /** Shows or hides the header for tree map level. - * @Default {false} - */ - showHeader?: boolean; - - /** Shows or hides the labels for tree map level. - * @Default {false} - */ - showLabels?: boolean; -} -} -namespace TreeMap { -enum DockPosition { -//specifies the top position -Top, -//specifies the bottom position -Bottom, -//specifies the bottom position -Right, -//specifies the left position -Left, -} -} -namespace TreeMap { -enum ItemsLayoutMode { -//specifies the squarified as layout type position -Squarified, -//specifies the sliceanddicehorizontal as layout type position -Sliceanddicehorizontal, -//specifies the sliceanddicevertical as layout type position -Sliceanddicevertical, -//specifies the sliceanddiceauto as layout type position -Sliceanddiceauto, -} -} -namespace TreeMap { -enum Position { -//specifies the none position -None, -//specifies the topleft position -Topleft, -//specifies the topcenter position -Topcenter, -//specifies the topright position -Topright, -//specifies the centerleft position -Centerleft, -//specifies the center position -Center, -//specifies the centerright position -Centerright, -//specifies the bottomleft position -Bottomleft, -//specifies the bottomcenter position -Bottomcenter, -//specifies the bottomright position -Bottomright, -} -} -namespace TreeMap { -enum VisibilityMode { -//specifies the visible mode -Top, -//specifies the hide on exceeded length mode -Hideonexceededlength, -} -} -namespace TreeMap { -enum selectionMode { -//specifies the default mode -Default, -//specifies the multiple mode -Multiple, -} -} -namespace TreeMap { -enum groupSelectionMode { -//specifies the default mode -Default, -//specifies the multiple mode -Multiple, -} -} - -class Diagram extends ej.Widget { - static fn: Diagram; - constructor(element: JQuery | Element, options?: Diagram.Model); - static Locale: any; - model: Diagram.Model; - defaults: Diagram.Model; - - /** Add nodes and connectors to diagram at runtime - * @param {any} a JSON to define a node/connector or an array of nodes and connector - * @returns {boolean} - */ - add(node: any): boolean; - - /** Add a label to a node at runtime - * @param {string} name of the node to which label will be added - * @param {any} JSON for the new label to be added - * @returns {void} - */ - addLabel(nodeName: string, newLabel: any): void; - - /** Add dynamic Lanes to swimlane at runtime - * @param {any} JSON for the new lane to be added - * @param {number} Index value to add the lane in swimlane - * @returns {void} - */ - addLane(lane: any, index: number): void; - - /** Add a phase to a swimlane at runtime - * @param {string} name of the swimlane to which the phase will be added - * @param {any} JSON object to define the phase to be added - * @returns {void} - */ - addPhase(name: string, options: any): void; - - /** Add a collection of ports to the node specified by name - * @param {string} name of the node to which the ports have to be added - * @param {Array} a collection of ports to be added to the specified node - * @returns {void} - */ - addPorts(name: string, ports: any[]): void; - - /** Add the specified node to selection list - * @param {any} the node to be selected - * @param {boolean} to define whether to clear the existing selection or not - * @returns {void} - */ - addSelection(node: any, clearSelection?: boolean): void; - - /** Align the selected objects based on the reference object and direction - * @param {string} to specify the direction towards which the selected objects are to be aligned("left","right",top","bottom") - * @returns {void} - */ - align(direction: string): void; - - /** Bring the specified portion of the diagram content to the diagram viewport - * @param {any} the rectangular region that is to be brought into diagram viewport - * @returns {void} - */ - bringIntoView(rect: any): void; - - /** Bring the specified portion of the diagram content to the center of the diagram viewport - * @param {any} the rectangular region that is to be brought to the center of diagram viewport - * @returns {void} - */ - bringToCenter(rect: any): void; - - /** Visually move the selected object over all other intersected objects - * @returns {void} - */ - bringToFront(): void; - - /** Remove all the elements from diagram - * @returns {void} - */ - clear(): void; - - /** Clears the actions which is recorded to perform undo/redo operation in the diagram. - * @returns {void} - */ - clearHistory(): void; - - /** Remove the current selection in diagram - * @returns {void} - */ - clearSelection(): void; - - /** Copy the selected object to internal clipboard and get the copied object - * @returns {any} - */ - copy(): any; - - /** Cut the selected object from diagram to diagram internal clipboard - * @returns {void} - */ - cut(): void; - - /** Export the diagram as downloadable files or as data - * @param {Diagram.Options} options to export the desired region of diagram to the desired formats. - * @returns {string} - */ - exportDiagram(options?: Diagram.Options): string; - - /** Read a node/connector object by its name - * @param {string} name of the node/connector that is to be identified - * @returns {any} - */ - findNode(name: string): any; - - /** Fit the diagram content into diagram viewport - * @param {string} to set the mode of fit to command. See [Fit Mode](/api/js/global#fitmode) - * @param {string} to set whether the region to be fit will be based on diagram elements or page settings [Region](/api/js/global#region) - * @param {any} to set the required margin - * @returns {void} - */ - fitToPage(mode?: string, region?: string, margin?: any): void; - - /** Group the selected nodes and connectors - * @returns {void} - */ - group(): void; - - /** Insert a label into a node's label collection at runtime - * @param {string} name of the node to which the label has to be inserted - * @param {any} JSON to define the new label - * @param {number} index to insert the label into the node - * @returns {void} - */ - insertLabel(name: string, label: any, index?: number): void; - - /** Refresh the diagram with the specified layout - * @returns {void} - */ - layout(): void; - - /** Load the diagram - * @param {any} JSON data to load the diagram - * @returns {void} - */ - load(data: any): void; - - /** Visually move the selected object over its closest intersected object - * @returns {void} - */ - moveForward(): void; - - /** Move the selected objects by either one pixel or by the pixels specified through argument - * @param {string} specifies the direction to move the selected objects ("left","right",top","bottom") - * @param {number} specifies the number of pixels by which the selected objects have to be moved - * @returns {void} - */ - nudge(direction: string, delta?: number): void; - - /** Paste the selected object from internal clipboard to diagram - * @param {any} object to be added to diagram - * @param {boolean} to define whether the specified object is to be renamed or not - * @returns {void} - */ - paste(object?: any, rename?: boolean): void; - - /** Print the diagram as image - * @returns {void} - */ - print(): void; - - /** Restore the last action that was reverted - * @returns {void} - */ - redo(): void; - - /** Refresh the diagram at runtime - * @returns {void} - */ - refresh(): void; - - /** Remove either the given node/connector or the selected element from diagram - * @param {any} the node/connector to be removed from diagram - * @returns {void} - */ - remove(node?: any): void; - - /** Remove a particular object from selection list - * @param {any} the node/connector to be removed from selection list - * @returns {void} - */ - removeSelection(node: any): void; - - /** Scale the selected objects to the height of the first selected object - * @returns {void} - */ - sameHeight(): void; - - /** Scale the selected objects to the size of the first selected object - * @returns {void} - */ - sameSize(): void; - - /** Scale the selected objects to the width of the first selected object - * @returns {void} - */ - sameWidth(): void; - - /** Returns the diagram as serialized JSON - * @returns {any} - */ - save(): any; - - /** Bring the node into view - * @param {any} the node/connector to be brought into view - * @returns {void} - */ - scrollToNode(node: any): void; - - /** Select all nodes and connector in diagram - * @returns {void} - */ - selectAll(): void; - - /** Visually move the selected object behind its closest intersected object - * @returns {void} - */ - sendBackward(): void; - - /** Visually move the selected object behind all other intersected objects - * @returns {void} - */ - sendToBack(): void; - - /** Update the horizontal space between the selected objects as equal and within the selection boundary - * @returns {void} - */ - spaceAcross(): void; - - /** Update the vertical space between the selected objects as equal and within the selection boundary - * @returns {void} - */ - spaceDown(): void; - - /** Move the specified label to edit mode - * @param {any} node/connector that contains the label to be edited - * @param {any} to be edited - * @returns {void} - */ - startLabelEdit(node: any, label: any): void; - - /** Reverse the last action that was performed - * @returns {void} - */ - undo(): void; - - /** Ungroup the selected group - * @returns {void} - */ - ungroup(): void; - - /** Update diagram at runtime - * @param {any} JSON to specify the diagram properties that have to be modified - * @returns {void} - */ - update(options: any): void; - - /** Update Connectors at runtime - * @param {string} name of the connector to be updated - * @param {any} JSON to specify the connector properties that have to be updated - * @returns {void} - */ - updateConnector(name: string, options: any): void; - - /** Update the given label at runtime - * @param {string} the name of node/connector which contains the label to be updated - * @param {any} the label to be modified - * @param {any} JSON to specify the label properties that have to be updated - * @returns {any} - */ - updateLabel(nodeName: string, label: any, options: any): any; - - /** Update nodes at runtime - * @param {string} name of the node that is to be updated - * @param {any} JSON to specify the properties of node that have to be updated - * @returns {void} - */ - updateNode(name: string, options: any): void; - - /** Update a port with its modified properties at runtime - * @param {string} the name of node which contains the port to be updated - * @param {any} the port to be updated - * @param {any} JSON to specify the properties of the port that have to be updated - * @returns {void} - */ - updatePort(nodeName: string, port: any, options: any): void; - - /** Update the specified node as selected object - * @param {string} name of the node to be updated as selected object - * @returns {void} - */ - updateSelectedObject(name: string): void; - - /** Update the selection at runtime - * @param {boolean} to specify whether to show the user handles or not - * @returns {void} - */ - updateSelection(showUserHandles?: boolean): void; - - /** Update user handles with respect to the given node - * @param {any} node/connector with respect to which, the user handles have to be updated - * @returns {void} - */ - updateUserHandles(node: any): void; - - /** Update the diagram viewport at runtime - * @returns {void} - */ - updateViewPort(): void; - - /** Upgrade the diagram from old version - * @param {any} to be upgraded - * @returns {void} - */ - upgrade(data: any): void; - - /** Used to zoomIn/zoomOut diagram - * @param {Diagram.Zoom} options to zoom the diagram(zoom factor, zoomIn/zoomOut) - * @returns {void} - */ - zoomTo(Zoom?: Diagram.Zoom): void; -} -export namespace Diagram { - -export interface Options { - - /** name of the file to be downloaded. - */ - fileName?: string; - - /** format of the exported file/data. See [File Formats](/api/js/global#fileformats). - */ - format?: string; - - /** to set whether to export diagram as a file or as raw data. See [Export Modes](/api/js/global#exportmodes). - */ - mode?: string; - - /** to set the region of the diagram to be exported. See [Region](/api/js/global#region). - */ - region?: string; - - /** to export any custom region of diagram. - */ - bounds?: any; - - /** to set margin to the exported data. - */ - margin?: any; - - /** to set stretch to the exported data. - */ - stretch?: string; -} - -export interface Zoom { - - /** Used to increase the zoom-in or zoom-out based on the zoom factor value. - */ - zoomFactor?: number; - - /** Used to zoom-in or zoom-out the diagram. - */ - zoomCommand?: ej.datavisualization.Diagram.ZoomCommand; - - /** Used to zoom-in or zoom-out the diagram based on the point. - */ - focusPoint?: ej.datavisualization.Diagram.ConnectorsSourcePoint; -} - -export interface Model { - - /** Defines the background color of diagram elements - * @Default {transparent} - */ - backgroundColor?: string; - - /** Defines the path of the background image of diagram elements - */ - backgroundImage?: string; - - /** Sets the direction of line bridges. - * @Default {ej.datavisualization.Diagram.BridgeDirection.Top} - */ - bridgeDirection?: ej.datavisualization.Diagram.BridgeDirection|string; - - /** Defines a set of custom commands and binds them with a set of desired key gestures. - */ - commandManager?: CommandManager; - - /** A collection of JSON objects where each object represents a connector - * @Default {[]} - */ - connectors?: Connector[]; - - /** Binds the custom JSON data with connector properties - * @Default {null} - */ - connectorTemplate?: any; - - /** Enables/Disables the default behaviors of the diagram. - * @Default {ej.datavisualization.Diagram.DiagramConstraints.All} - */ - constraints?: ej.datavisualization.Diagram.DiagramConstraints|string; - - /** An object to customize the context menu of diagram - */ - contextMenu?: ContextMenu; - - /** Configures the data source that is to be bound with diagram - */ - dataSourceSettings?: DataSourceSettings; - - /** Initializes the default values for nodes and connectors - * @Default {{}} - */ - defaultSettings?: DefaultSettings; - - /** Sets the type of JSON object to be drawn through drawing tool - * @Default {{}} - */ - drawType?: any; - - /** Enables or disables auto scroll in diagram - * @Default {true} - */ - enableAutoScroll?: boolean; - - /** Enables or disables diagram context menu - * @Default {true} - */ - enableContextMenu?: boolean; - - /** Specifies the height of the diagram - * @Default {null} - */ - height?: string; - - /** Customizes the undo redo functionality - */ - historyManager?: HistoryManager; - - /** Defines the type of the rendering mode of label. - * @Default {Html} - */ - labelRenderingMode?: ej.datavisualization.Diagram.LabelRenderingMode|string; - - /** Automatically arranges the nodes and connectors in a predefined manner. - */ - layout?: Layout; - - /** Defines the current culture of diagram - * @Default {en-US} - */ - locale?: string; + /** Specifies the zoom level value for which map to be zoomed + * @Default {1} + */ + level?: number; + + /** Specifies the minimum zoomSettings level of the map + * @Default {1} + */ + minValue?: number; + + /** Specifies the maximum zoom level of the map + * @Default {100} + */ + maxValue?: number; + } + + export interface NavigationControl { + + /** Set the absolutePosition for navigation control + * @Default {{x:0,y:0}} + */ + absolutePosition?: any; + + /** Specifies the navigation control template for map + * @Default {null} + */ + content?: string; + + /** Set the dockPosition value for navigation control + * @Default {centerleft} + */ + dockPosition?: ej.datavisualization.Map.Position | string; + + /** Enables or Disables the Navigation for handling zooming map + * @Default {false} + */ + enableNavigation?: boolean; + + /** Set the orientation value for navigation control + * @Default {vertical} + */ + orientation?: ej.datavisualization.Map.LabelOrientation | string; + } + + export interface LayersBubbleSettingsColorMappingsRangeColorMapping { + + /** Start range colorMappings in the bubble layer. + * @Default {null} + */ + from?: number; + + /** End range colorMappings in the bubble layer. + * @Default {null} + */ + to?: number; + + /** GradientColors in the bubble layer of map. + */ + gradientColors?: any[]; + + /** Color of the bubble layer. + * @Default {null} + */ + color?: string; + } + + export interface LayersBubbleSettingsColorMappings { + + /** Specifies the range colorMappings in the bubble layer. + * @Default {null} + */ + rangeColorMapping?: LayersBubbleSettingsColorMappingsRangeColorMapping[]; + } + + export interface LayersBubbleSettings { + + /** Specifies the bubble Opacity value of bubbles for shape layer in map + * @Default {0.9} + */ + bubbleOpacity?: number; + + /** Specifies the mouse hover color of the shape layer in map + * @Default {gray} + */ + color?: string; + + /** Specifies the colorMappings of the shape layer in map + * @Default {null} + */ + colorMappings?: LayersBubbleSettingsColorMappings; + + /** Specifies the bubble color valuePath of the shape layer in map + * @Default {null} + */ + colorValuePath?: string; + + /** Specifies the maximum size value of bubbles for shape layer in map + * @Default {20} + */ + maxValue?: number; + + /** Specifies the minimum size value of bubbles for shape layer in map + * @Default {10} + */ + minValue?: number; + + /** Specifies the showBubble visibility status map + * @Default {true} + */ + showBubble?: boolean; + + /** Specifies the tooltip visibility status of the shape layer in map + * @Default {false} + */ + showTooltip?: boolean; + + /** Specifies the bubble tooltip template of the shape layer in map + * @Default {null} + */ + tooltipTemplate?: string; + + /** Specifies the bubble valuePath of the shape layer in map + * @Default {null} + */ + valuePath?: string; + } + + export interface LayersLabelSettings { + + /** enable or disable the enableSmartLabel property + * @Default {false} + */ + enableSmartLabel?: boolean; + + /** set the labelLength property + * @Default {'2'} + */ + labelLength?: number; + + /** set the labelPath property + * @Default {null} + */ + labelPath?: string; + + /** The property specifies whether to show labels or not. + * @Default {false} + */ + showLabels?: boolean; + + /** set the smartLabelSize property + * @Default {fixed} + */ + smartLabelSize?: ej.datavisualization.Map.LabelSize | string; + } + + export interface LayersLegendSettings { + + /** Determines whether the legend should be placed outside or inside the map bounds + * @Default {false} + */ + dockOnMap?: boolean; + + /** Determines the legend placement and it is valid only when dockOnMap is true + * @Default {top} + */ + dockPosition?: ej.datavisualization.Map.DockPosition | string; + + /** height value for legend setting + * @Default {0} + */ + height?: number; + + /** to get icon value for legend setting + * @Default {rectangle} + */ + icon?: ej.datavisualization.Map.LegendIcons | string; + + /** icon height value for legend setting + * @Default {20} + */ + iconHeight?: number; + + /** icon Width value for legend setting + * @Default {20} + */ + iconWidth?: number; + + /** set the orientation of legend labels + * @Default {vertical} + */ + labelOrientation?: ej.datavisualization.Map.LabelOrientation | string; + + /** to get leftLabel value for legend setting + * @Default {null} + */ + leftLabel?: string; + + /** to get mode of legend setting + * @Default {default} + */ + mode?: ej.datavisualization.Map.Mode | string; + + /** set the position of legend settings + * @Default {topleft} + */ + position?: ej.datavisualization.Map.Position | string; + + /** x position value for legend setting + * @Default {0} + */ + positionX?: number; + + /** y position value for legend setting + * @Default {0} + */ + positionY?: number; + + /** to get rightLabel value for legend setting + * @Default {null} + */ + rightLabel?: string; + + /** Enables or Disables the showLabels + * @Default {false} + */ + showLabels?: boolean; + + /** Enables or Disables the showLegend + * @Default {false} + */ + showLegend?: boolean; + + /** to get title of legend setting + * @Default {null} + */ + title?: string; + + /** to get type of legend setting + * @Default {layers} + */ + type?: ej.datavisualization.Map.LegendType | string; + + /** width value for legend setting + * @Default {0} + */ + width?: number; + } + + export interface LayersShapeSettingsColorMappingsRangeColorMapping { + + /** Specifies the start range colorMappings in the shape layer of map. + * @Default {null} + */ + from?: number; + + /** Specifies the to range colorMappings in the shape layer of map. + * @Default {null} + */ + to?: number; + + /** Specifies the gradientColors in the shape layer of map. + * @Default {null} + */ + gradientColors?: any[]; + } + + export interface LayersShapeSettingsColorMappingsEqualColorMapping { + + /** Specifies the equalColorMapping value in the shape layer of map. + * @Default {null} + */ + value?: string; + + /** Specifies the equalColorMapping color in the shape layer of map. + * @Default {null} + */ + color?: string; + } + + export interface LayersShapeSettingsColorMappings { + + /** Specifies the range colorMappings in the shape layer of map. + * @Default {null} + */ + rangeColorMapping?: LayersShapeSettingsColorMappingsRangeColorMapping[]; + + /** Specifies the equalColorMapping in the shape layer of map. + * @Default {null} + */ + equalColorMapping?: LayersShapeSettingsColorMappingsEqualColorMapping[]; + } + + export interface LayersShapeSettings { + + /** Enables or Disables the auto fill colors for shape layer in map. When this property value set to true, shapes will be filled with palette colors. + * @Default {false} + */ + autoFill?: boolean; + + /** Specifies the colorMappings of the shape layer in map + * @Default {null} + */ + colorMappings?: LayersShapeSettingsColorMappings; + + /** Specifies the shape color palette value of the shape layer in map. Accepted colorPalette values are palette1, palette2, palette3 and custompalette. + * @Default {palette1} + */ + colorPalette?: ej.datavisualization.Map.ColorPalette | string; + + /** Specifies the shape color valuePath of the shape layer in map + * @Default {null} + */ + colorValuePath?: string; + + /** Enables or Disables the gradient colors for map shapes. + * @Default {false} + */ + enableGradient?: boolean; + + /** Specifies the shape fill color of the shape layer in map + * @Default {#E5E5E5} + */ + fill?: string; + + /** Specifies the mouse over width of the shape layer in map + * @Default {1} + */ + highlightBorderWidth?: number; + + /** Specifies the mouse hover color of the shape layer in map + * @Default {gray} + */ + highlightColor?: string; + + /** Specifies the mouse over stroke color of the shape layer in map + * @Default {#C1C1C1} + */ + highlightStroke?: string; + + /** Specifies the shape selection color of the shape layer in map + * @Default {gray} + */ + selectionColor?: string; + + /** Specifies the shape selection stroke color of the shape layer in map + * @Default {#C1C1C1} + */ + selectionStroke?: string; + + /** Specifies the shape selection stroke width of the shape layer in map + * @Default {1} + */ + selectionStrokeWidth?: number; + + /** Specifies the shape stroke color of the shape layer in map + * @Default {#C1C1C1} + */ + stroke?: string; + + /** Specifies the shape stroke thickness value of the shape layer in map + * @Default {0.2} + */ + strokeThickness?: number; + + /** Specifies the shape valuePath of the shape layer in map + * @Default {null} + */ + valuePath?: string; + } + + export interface Layer { + + /** to get the type of bing map. + * @Default {aerial} + */ + bingMapType?: ej.datavisualization.Map.BingMapType | string; + + /** Specifies the bubble settings for map + */ + bubbleSettings?: LayersBubbleSettings; + + /** Specifies the datasource for the shape layer + */ + dataSource?: any; + + /** Specifies the data path of shape + */ + shapeDataPath?: string; + + /** Specifies the data path of shape + */ + shapePropertyPath?: string; + + /** Enables or disables the shape mouse hover + * @Default {false} + */ + enableMouseHover?: boolean; + + /** Enables or disables the shape selection + * @Default {true} + */ + enableSelection?: boolean; + + /** to get the key of bing map + * @Default {null} + */ + key?: string; + + /** Options for enabling and configuring labelSettings labelPath, smartLabelSize, labelLength etc., + */ + labelSettings?: LayersLabelSettings; + + /** Specifies the map view type. + * @Default {'geographic'} + */ + geometryType?: ej.datavisualization.Map.GeometryType | string; + + /** Specifies the map type. + * @Default {'geometry'} + */ + layerType?: ej.datavisualization.Map.LayerType | string; + + /** Options for enabling and configuring legendSettings position, height, width, mode, type etc., + */ + legendSettings?: LayersLegendSettings; + + /** Specifies the map items template for shapes. + */ + mapItemsTemplate?: string; + + /** Specify markers for shape layer. + * @Default {[]} + */ + markers?: any[]; + + /** Specifies the map marker template for map layer. + * @Default {null} + */ + markerTemplate?: string; + + /** Specify selectedMapShapes for shape layer + * @Default {[]} + */ + selectedMapShapes?: any[]; + + /** Specifies the selection mode of the map. Accepted selection mode values are Default and Multiple. + * @Default {default} + */ + selectionMode?: ej.datavisualization.Map.SelectionMode | string; + + /** Specifies the shape data for the shape layer + */ + shapeData?: any; + + /** Specifies the shape settings of map layer + */ + shapeSettings?: LayersShapeSettings; + + /** Shows or hides the map items. + * @Default {false} + */ + showMapItems?: boolean; + + /** Shows or hides the tooltip for shapes + * @Default {false} + */ + showTooltip?: boolean; + + /** Specifies the tooltip template for shapes. + */ + tooltipTemplate?: string; + + /** Specifies the URL template for the OSM type map. + * @Default {'http://a.tile.openstreetmap.org/level/tileX/tileY.png'} + */ + urlTemplate?: string; + } + } + namespace Map { + enum Position { + //specifies the none position + None, + //specifies the topleft position + Topleft, + //specifies the topcenter position + Topcenter, + //specifies the topright position + Topright, + //specifies the centerleft position + Centerleft, + //specifies the center position + Center, + //specifies the centerright position + Centerright, + //specifies the bottomleft position + Bottomleft, + //specifies the bottomcenter position + Bottomcenter, + //specifies the bottomright position + Bottomright, + } + } + namespace Map { + enum LabelOrientation { + //specifies the horizontal position + Horizontal, + //specifies the vertical position + Vertical, + } + } + namespace Map { + enum BingMapType { + //specifies the aerial type + Aerial, + //specifies the aerialwithlabel type + Aerialwithlabel, + //specifies the road type + Road, + } + } + namespace Map { + enum LabelSize { + //specifies the fixed size + Fixed, + //specifies the default size + Default, + } + } + namespace Map { + enum GeometryType { + //specifies the geographic view of map + Geographic, + //specifies the normal land view of map + Normal, + } + } + namespace Map { + enum LayerType { + //specifies the geometry type + Geometry, + //specifies the osm type + Osm, + //specifies the bing type + Bing, + } + } + namespace Map { + enum DockPosition { + //specifies the top position + Top, + //specifies the bottom position + Bottom, + //specifies the bottom position + Right, + //specifies the left position + Left, + } + } + namespace Map { + enum LegendIcons { + //specifies the rectangle position + Rectangle, + //specifies the circle position + Circle, + } + } + namespace Map { + enum Mode { + //specifies the default mode + Default, + //specifies the interactive mode + Interactive, + } + } + namespace Map { + enum LegendType { + //specifies the layers type + Layers, + //specifies the bubbles type + Bubbles, + } + } + namespace Map { + enum SelectionMode { + //specifies the default position + Default, + //specifies the multiple position + Multiple, + } + } + namespace Map { + enum ColorPalette { + //specifies the palette1 color + Palette1, + //specifies the palette2 color + Palette2, + //specifies the palette3 color + Palette3, + //specifies the custom color + Custompalette, + } + } + + class TreeMap extends ej.Widget { + static fn: TreeMap; + constructor(element: JQuery | Element, options?: TreeMap.Model); + static Locale: any; + model: TreeMap.Model; + defaults: TreeMap.Model; + + /** Method to reload treemap with updated values. + * @returns {void} + */ + refresh(): void; + } + export namespace TreeMap { + + export interface Model { + + /** Specifies the border brush color of the treemap + * @Default {white} + */ + borderBrush?: string; + + /** Specifies the border thickness of the treemap + * @Default {1} + */ + borderThickness?: number; + + /** Specifies the uniColorMapping settings of the treemap + */ + uniColorMapping?: UniColorMapping; + + /** Specifies the desaturationColorMapping settings of the treemap + */ + desaturationColorMapping?: DesaturationColorMapping; + + /** Specifies the paletteColorMapping of the treemap + */ + paletteColorMapping?: PaletteColorMapping; + + /** Specifies the color value path of the treemap + * @Default {null} + */ + colorValuePath?: string; + + /** Specifies the datasource of the treemap + * @Default {null} + */ + dataSource?: any; + + /** Specifies the dockPosition for legend + * @Default {top} + */ + dockPosition?: ej.datavisualization.TreeMap.DockPosition | string; + + /** specifies the drillDown header color + * @Default {'null'} + */ + drillDownHeaderColor?: string; + + /** specifies the drillDown selection color + * @Default {'#000000'} + */ + drillDownSelectionColor?: string; + + /** Specifies whether datasource is hierarchical or not. + * @Default {false} + */ + isHierarchicalDatasource?: boolean; + + /** Specifies the header for parent item during drilldown. This is applicable only for hierarchical data source. + * @Default {null} + */ + header?: string; + + /** Enable/Disable the drillDown for treemap + * @Default {false} + */ + enableDrillDown?: boolean; + + /** Controls whether Treemap has to be responsive while resizing the window. + * @Default {true} + */ + isResponsive?: boolean; + + /** Specifies whether treemap need to resize when container is resized + * @Default {true} + */ + enableResize?: boolean; + + /** This property is used to select treemap items while clicking and dragging + * @Default {false} + */ + draggingOnSelection?: boolean; + + /** This property is used to select group of treemap items while clicking and dragging + * @Default {false} + */ + draggingGroupOnSelection?: boolean; + + /** Specifies the group color mapping of the treemap + * @Default {[]} + */ + groupColorMapping?: GroupColorMapping[]; + + /** Specifies the legend settings of the treemap + */ + legendSettings?: LegendSettings; + + /** Specifies the highlight border brush of treemap + * @Default {gray} + */ + highlightBorderBrush?: string; + + /** Specifies the border thickness when treemap items is highlighted in the treemap + * @Default {5} + */ + highlightBorderThickness?: number; + + /** Specifies the highlight border brush of treemap + * @Default {gray} + */ + highlightGroupBorderBrush?: string; + + /** Specifies the border thickness when treemap items is highlighted in the treemap + * @Default {5} + */ + highlightGroupBorderThickness?: number; + + /** Specifies whether treemap item need to highlighted on selection + * @Default {false} + */ + highlightGroupOnSelection?: boolean; + + /** Specifies whether treemap item need to highlighted on selection + * @Default {false} + */ + highlightOnSelection?: boolean; + + /** Specifies the items layout mode of the treemap. Accepted itemsLayoutMode values are Squarified, SliceAndDiceHorizontal, SliceAndDiceVertical and SliceAndDiceAuto + * @Default {Squarified} + */ + itemsLayoutMode?: ej.datavisualization.TreeMap.ItemsLayoutMode | string; + + /** Specifies the leaf settings of the treemap + */ + leafItemSettings?: LeafItemSettings; + + /** Specifies the rangeColorMapping settings of the treemap + * @Default {[]} + */ + rangeColorMapping?: RangeColorMapping[]; + + /** Specifies the selection mode of treemap item. Accepted selection mode values are Default and Multiple. + * @Default {default} + */ + selectionMode?: ej.datavisualization.TreeMap.selectionMode | string; + + /** Specifies the selection mode of the treemap. Accepted selection mode values are Default and Multiple. + * @Default {default} + */ + groupSelectionMode?: ej.datavisualization.TreeMap.groupSelectionMode | string; + + /** Specifies the legend visibility status of the treemap + * @Default {false} + */ + showLegend?: boolean; + + /** Specifies whether gradient color has to be applied for treemap items + * @Default {false} + */ + enableGradient?: boolean; + + /** Specifies whether treemap showTooltip need to be visible + */ + showTooltip?: boolean; + + /** Specifies the tooltip template of the treemap + * @Default {null} + */ + tooltipTemplate?: string; + + /** Hold the treeMapItems to be displayed in treemap + * @Default {[]} + */ + treeMapItems?: any[]; + + /** Specify levels of treemap for grouped visualization of data + * @Default {[]} + */ + levels?: Level[]; + + /** Specifies the weight value path of the treemap + * @Default {null} + */ + weightValuePath?: string; + + /** Triggers on treemap item selected. */ + treeMapItemSelected?(e: TreeMapItemSelectedEventArgs): void; + } + + export interface TreeMapItemSelectedEventArgs { + + /** Returns selected treeMapItem object. + */ + originalEvent?: any; + } + + export interface UniColorMapping { + + /** Specifies the uniform color mapping of the treemap + * @Default {null} + */ + color?: string; + } + + export interface DesaturationColorMapping { + + /** Specifies the to value for desaturation color mapping + * @Default {0} + */ + to?: number; + + /** Specifies the color for desaturationColorMapping + * @Default {null} + */ + color?: string; + + /** Specifies the from value for desaturation color mapping + * @Default {0} + */ + from?: number; + + /** Specifies the rangeMaximum value for desaturation color mapping + * @Default {0} + */ + rangeMaximum?: number; + + /** Specifies the rangeMinimum value for desaturation color mapping + * @Default {0} + */ + rangeMinimum?: number; + } + + export interface PaletteColorMapping { + + /** Specifies the colors of the paletteColorMapping + * @Default {[]} + */ + colors?: any[]; + } + + export interface GroupColorMapping { + + /** Specifies the groupID for GroupColorMapping. + * @Default {null} + */ + groupID?: string; + } + + export interface LegendSettings { + + /** Specifies the height for legend + * @Default {30} + */ + height?: number; + + /** Specifies the width for legend + * @Default {100} + */ + width?: number; + + /** Specifies the iconHeight for legend + * @Default {15} + */ + iconHeight?: number; + + /** Specifies the iconWidth for legend + * @Default {15} + */ + iconWidth?: number; + + /** Specifies the template for legendSettings + * @Default {null} + */ + template?: string; + + /** Specifies the mode for legendSettings whether default or interactive mode + * @Default {default} + */ + mode?: string; + + /** Specifies the title text for legend + */ + title?: string; + + /** Specifies the leftLabel text for legend + */ + leftLabel?: string; + + /** Specifies the rightLabel text for legend + */ + rightLabel?: string; + + /** Specifies the dockPosition text for legend + * @Default {top} + */ + dockPosition?: string; + + /** Specifies the alignment text for legend + * @Default {near} + */ + alignment?: string; + + /** Specifies the alignment text for legend + * @Default {0} + */ + columnCount?: number; + } + + export interface LeafItemSettings { + + /** Specifies the border brush color of the leaf item. + * @Default {white} + */ + borderBrush?: string; + + /** Specifies the border thickness of the leaf item. + * @Default {1} + */ + borderThickness?: number; + + /** Specifies the label template of the leaf item. + * @Default {null} + */ + itemTemplate?: string; + + /** Specifies the label path of the leaf item. + * @Default {null} + */ + labelPath?: string; + + /** Specifies the position of the leaf labels. + * @Default {center} + */ + labelPosition?: ej.datavisualization.TreeMap.Position | string; + + /** Specifies the mode of label visibility + * @Default {visible} + */ + labelVisibilityMode?: ej.datavisualization.TreeMap.VisibilityMode | string; + + /** Shows or hides the label of the leaf item. + * @Default {false} + */ + showLabels?: boolean; + } + + export interface RangeColorMapping { + + /** Specifies the color value for rangeColorMapping. + * @Default {null} + */ + color?: string; + + /** specifies the gradient colors for th given range value + * @Default {[]} + */ + gradientColors?: any[]; + + /** Specifies the from value for rangeColorMapping. + * @Default {-1} + */ + from?: number; + + /** Specifies the legend label value for rangeColorMapping. + * @Default {null} + */ + legendLabel?: string; + + /** Specifies the to value for rangeColorMapping. + * @Default {-1} + */ + to?: number; + } + + export interface Level { + + /** specifies the group background + * @Default {null} + */ + groupBackground?: string; + + /** Specifies the group border color for tree map level. + * @Default {null} + */ + groupBorderColor?: string; + + /** Specifies the group border thickness for tree map level. + * @Default {1} + */ + groupBorderThickness?: number; + + /** Specifies the group gap for tree map level. + * @Default {1} + */ + groupGap?: number; + + /** Specifies the group padding for tree map level. + * @Default {4} + */ + groupPadding?: number; + + /** Specifies the group path for tree map level. + */ + groupPath?: string; + + /** Specifies the header height for tree map level. + * @Default {0} + */ + headerHeight?: number; + + /** Specifies the header template for tree map level. + * @Default {null} + */ + headerTemplate?: string; + + /** Specifies the mode of header visibility + * @Default {visible} + */ + headerVisibilityMode?: ej.datavisualization.TreeMap.VisibilityMode | string; + + /** Specifies the position of the labels. + * @Default {center} + */ + labelPosition?: ej.datavisualization.TreeMap.Position | string; + + /** Specifies the label template for tree map level. + * @Default {null} + */ + labelTemplate?: string; + + /** Specifies the mode of label visibility + * @Default {visible} + */ + labelVisibilityMode?: ej.datavisualization.TreeMap.VisibilityMode | string; + + /** Shows or hides the header for tree map level. + * @Default {false} + */ + showHeader?: boolean; + + /** Shows or hides the labels for tree map level. + * @Default {false} + */ + showLabels?: boolean; + } + } + namespace TreeMap { + enum DockPosition { + //specifies the top position + Top, + //specifies the bottom position + Bottom, + //specifies the bottom position + Right, + //specifies the left position + Left, + } + } + namespace TreeMap { + enum ItemsLayoutMode { + //specifies the squarified as layout type position + Squarified, + //specifies the sliceanddicehorizontal as layout type position + Sliceanddicehorizontal, + //specifies the sliceanddicevertical as layout type position + Sliceanddicevertical, + //specifies the sliceanddiceauto as layout type position + Sliceanddiceauto, + } + } + namespace TreeMap { + enum Position { + //specifies the none position + None, + //specifies the topleft position + Topleft, + //specifies the topcenter position + Topcenter, + //specifies the topright position + Topright, + //specifies the centerleft position + Centerleft, + //specifies the center position + Center, + //specifies the centerright position + Centerright, + //specifies the bottomleft position + Bottomleft, + //specifies the bottomcenter position + Bottomcenter, + //specifies the bottomright position + Bottomright, + } + } + namespace TreeMap { + enum VisibilityMode { + //specifies the visible mode + Top, + //specifies the hide on exceeded length mode + Hideonexceededlength, + } + } + namespace TreeMap { + enum selectionMode { + //specifies the default mode + Default, + //specifies the multiple mode + Multiple, + } + } + namespace TreeMap { + enum groupSelectionMode { + //specifies the default mode + Default, + //specifies the multiple mode + Multiple, + } + } + + class Diagram extends ej.Widget { + static fn: Diagram; + constructor(element: JQuery | Element, options?: Diagram.Model); + static Locale: any; + model: Diagram.Model; + defaults: Diagram.Model; + + /** Add nodes and connectors to diagram at runtime + * @param {any} a JSON to define a node/connector or an array of nodes and connector + * @returns {boolean} + */ + add(node: any): boolean; + + /** Add a label to a node at runtime + * @param {string} name of the node to which label will be added + * @param {any} JSON for the new label to be added + * @returns {void} + */ + addLabel(nodeName: string, newLabel: any): void; + + /** Add dynamic Lanes to swimlane at runtime + * @param {any} JSON for the new lane to be added + * @param {number} Index value to add the lane in swimlane + * @returns {void} + */ + addLane(lane: any, index: number): void; + + /** Add a phase to a swimlane at runtime + * @param {string} name of the swimlane to which the phase will be added + * @param {any} JSON object to define the phase to be added + * @returns {void} + */ + addPhase(name: string, options: any): void; + + /** Add a collection of ports to the node specified by name + * @param {string} name of the node to which the ports have to be added + * @param {Array} a collection of ports to be added to the specified node + * @returns {void} + */ + addPorts(name: string, ports: any[]): void; + + /** Add the specified node to selection list + * @param {any} the node to be selected + * @param {boolean} to define whether to clear the existing selection or not + * @returns {void} + */ + addSelection(node: any, clearSelection?: boolean): void; + + /** Align the selected objects based on the reference object and direction + * @param {string} to specify the direction towards which the selected objects are to be aligned("left","right",top","bottom") + * @returns {void} + */ + align(direction: string): void; + + /** Bring the specified portion of the diagram content to the diagram viewport + * @param {any} the rectangular region that is to be brought into diagram viewport + * @returns {void} + */ + bringIntoView(rect: any): void; + + /** Bring the specified portion of the diagram content to the center of the diagram viewport + * @param {any} the rectangular region that is to be brought to the center of diagram viewport + * @returns {void} + */ + bringToCenter(rect: any): void; + + /** Visually move the selected object over all other intersected objects + * @returns {void} + */ + bringToFront(): void; + + /** Remove all the elements from diagram + * @returns {void} + */ + clear(): void; + + /** Clears the actions which is recorded to perform undo/redo operation in the diagram. + * @returns {void} + */ + clearHistory(): void; + + /** Remove the current selection in diagram + * @returns {void} + */ + clearSelection(): void; + + /** Copy the selected object to internal clipboard and get the copied object + * @returns {any} + */ + copy(): any; + + /** Cut the selected object from diagram to diagram internal clipboard + * @returns {void} + */ + cut(): void; + + /** Export the diagram as downloadable files or as data + * @param {Diagram.Options} options to export the desired region of diagram to the desired formats. + * @returns {string} + */ + exportDiagram(options?: Diagram.Options): string; + + /** Read a node/connector object by its name + * @param {string} name of the node/connector that is to be identified + * @returns {any} + */ + findNode(name: string): any; + + /** Fit the diagram content into diagram viewport + * @param {string} to set the mode of fit to command. See [Fit Mode](/api/js/global#fitmode) + * @param {string} to set whether the region to be fit will be based on diagram elements or page settings [Region](/api/js/global#region) + * @param {any} to set the required margin + * @returns {void} + */ + fitToPage(mode?: string, region?: string, margin?: any): void; + + /** Group the selected nodes and connectors + * @returns {void} + */ + group(): void; + + /** Insert a label into a node's label collection at runtime + * @param {string} name of the node to which the label has to be inserted + * @param {any} JSON to define the new label + * @param {number} index to insert the label into the node + * @returns {void} + */ + insertLabel(name: string, label: any, index?: number): void; + + /** Refresh the diagram with the specified layout + * @returns {void} + */ + layout(): void; + + /** Load the diagram + * @param {any} JSON data to load the diagram + * @returns {void} + */ + load(data: any): void; + + /** Visually move the selected object over its closest intersected object + * @returns {void} + */ + moveForward(): void; + + /** Move the selected objects by either one pixel or by the pixels specified through argument + * @param {string} specifies the direction to move the selected objects ("left","right",top","bottom") + * @param {number} specifies the number of pixels by which the selected objects have to be moved + * @returns {void} + */ + nudge(direction: string, delta?: number): void; + + /** Paste the selected object from internal clipboard to diagram + * @param {any} object to be added to diagram + * @param {boolean} to define whether the specified object is to be renamed or not + * @returns {void} + */ + paste(object?: any, rename?: boolean): void; + + /** Print the diagram as image + * @returns {void} + */ + print(): void; + + /** Restore the last action that was reverted + * @returns {void} + */ + redo(): void; + + /** Refresh the diagram at runtime + * @returns {void} + */ + refresh(): void; + + /** Remove either the given node/connector or the selected element from diagram + * @param {any} the node/connector to be removed from diagram + * @returns {void} + */ + remove(node?: any): void; + + /** Remove a particular object from selection list + * @param {any} the node/connector to be removed from selection list + * @returns {void} + */ + removeSelection(node: any): void; + + /** Scale the selected objects to the height of the first selected object + * @returns {void} + */ + sameHeight(): void; + + /** Scale the selected objects to the size of the first selected object + * @returns {void} + */ + sameSize(): void; + + /** Scale the selected objects to the width of the first selected object + * @returns {void} + */ + sameWidth(): void; + + /** Returns the diagram as serialized JSON + * @returns {any} + */ + save(): any; + + /** Bring the node into view + * @param {any} the node/connector to be brought into view + * @returns {void} + */ + scrollToNode(node: any): void; + + /** Select all nodes and connector in diagram + * @returns {void} + */ + selectAll(): void; + + /** Visually move the selected object behind its closest intersected object + * @returns {void} + */ + sendBackward(): void; + + /** Visually move the selected object behind all other intersected objects + * @returns {void} + */ + sendToBack(): void; + + /** Update the horizontal space between the selected objects as equal and within the selection boundary + * @returns {void} + */ + spaceAcross(): void; + + /** Update the vertical space between the selected objects as equal and within the selection boundary + * @returns {void} + */ + spaceDown(): void; + + /** Move the specified label to edit mode + * @param {any} node/connector that contains the label to be edited + * @param {any} to be edited + * @returns {void} + */ + startLabelEdit(node: any, label: any): void; + + /** Reverse the last action that was performed + * @returns {void} + */ + undo(): void; + + /** Ungroup the selected group + * @returns {void} + */ + ungroup(): void; + + /** Update diagram at runtime + * @param {any} JSON to specify the diagram properties that have to be modified + * @returns {void} + */ + update(options: any): void; + + /** Update Connectors at runtime + * @param {string} name of the connector to be updated + * @param {any} JSON to specify the connector properties that have to be updated + * @returns {void} + */ + updateConnector(name: string, options: any): void; + + /** Update the given label at runtime + * @param {string} the name of node/connector which contains the label to be updated + * @param {any} the label to be modified + * @param {any} JSON to specify the label properties that have to be updated + * @returns {any} + */ + updateLabel(nodeName: string, label: any, options: any): any; + + /** Update nodes at runtime + * @param {string} name of the node that is to be updated + * @param {any} JSON to specify the properties of node that have to be updated + * @returns {void} + */ + updateNode(name: string, options: any): void; + + /** Update a port with its modified properties at runtime + * @param {string} the name of node which contains the port to be updated + * @param {any} the port to be updated + * @param {any} JSON to specify the properties of the port that have to be updated + * @returns {void} + */ + updatePort(nodeName: string, port: any, options: any): void; + + /** Update the specified node as selected object + * @param {string} name of the node to be updated as selected object + * @returns {void} + */ + updateSelectedObject(name: string): void; + + /** Update the selection at runtime + * @param {boolean} to specify whether to show the user handles or not + * @returns {void} + */ + updateSelection(showUserHandles?: boolean): void; + + /** Update user handles with respect to the given node + * @param {any} node/connector with respect to which, the user handles have to be updated + * @returns {void} + */ + updateUserHandles(node: any): void; + + /** Update the diagram viewport at runtime + * @returns {void} + */ + updateViewPort(): void; + + /** Upgrade the diagram from old version + * @param {any} to be upgraded + * @returns {void} + */ + upgrade(data: any): void; + + /** Used to zoomIn/zoomOut diagram + * @param {Diagram.Zoom} options to zoom the diagram(zoom factor, zoomIn/zoomOut) + * @returns {void} + */ + zoomTo(Zoom?: Diagram.Zoom): void; + } + export namespace Diagram { + + export interface Options { + + /** name of the file to be downloaded. + */ + fileName?: string; + + /** format of the exported file/data. See [File Formats](/api/js/global#fileformats). + */ + format?: string; + + /** to set whether to export diagram as a file or as raw data. See [Export Modes](/api/js/global#exportmodes). + */ + mode?: string; + + /** to set the region of the diagram to be exported. See [Region](/api/js/global#region). + */ + region?: string; + + /** to export any custom region of diagram. + */ + bounds?: any; + + /** to set margin to the exported data. + */ + margin?: any; + + /** to set stretch to the exported data. + */ + stretch?: string; + } + + export interface Zoom { + + /** Used to increase the zoom-in or zoom-out based on the zoom factor value. + */ + zoomFactor?: number; + + /** Used to zoom-in or zoom-out the diagram. + */ + zoomCommand?: ej.datavisualization.Diagram.ZoomCommand; + + /** Used to zoom-in or zoom-out the diagram based on the point. + */ + focusPoint?: ej.datavisualization.Diagram.ConnectorsSourcePoint; + } + + export interface Model { + + /** Defines the background color of diagram elements + * @Default {transparent} + */ + backgroundColor?: string; + + /** Defines the path of the background image of diagram elements + */ + backgroundImage?: string; + + /** Sets the direction of line bridges. + * @Default {ej.datavisualization.Diagram.BridgeDirection.Top} + */ + bridgeDirection?: ej.datavisualization.Diagram.BridgeDirection | string; + + /** Defines a set of custom commands and binds them with a set of desired key gestures. + */ + commandManager?: CommandManager; + + /** A collection of JSON objects where each object represents a connector + * @Default {[]} + */ + connectors?: Connector[]; + + /** Binds the custom JSON data with connector properties + * @Default {null} + */ + connectorTemplate?: any; + + /** Enables/Disables the default behaviors of the diagram. + * @Default {ej.datavisualization.Diagram.DiagramConstraints.All} + */ + constraints?: ej.datavisualization.Diagram.DiagramConstraints | string; + + /** An object to customize the context menu of diagram + */ + contextMenu?: ContextMenu; + + /** Configures the data source that is to be bound with diagram + */ + dataSourceSettings?: DataSourceSettings; + + /** Initializes the default values for nodes and connectors + * @Default {{}} + */ + defaultSettings?: DefaultSettings; + + /** Sets the type of JSON object to be drawn through drawing tool + * @Default {{}} + */ + drawType?: any; + + /** Enables or disables auto scroll in diagram + * @Default {true} + */ + enableAutoScroll?: boolean; + + /** Enables or disables diagram context menu + * @Default {true} + */ + enableContextMenu?: boolean; + + /** Specifies the height of the diagram + * @Default {null} + */ + height?: string; + + /** Customizes the undo redo functionality + */ + historyManager?: HistoryManager; + + /** Defines the type of the rendering mode of label. + * @Default {Html} + */ + labelRenderingMode?: ej.datavisualization.Diagram.LabelRenderingMode | string; + + /** Automatically arranges the nodes and connectors in a predefined manner. + */ + layout?: Layout; + + /** Defines the current culture of diagram + * @Default {en-US} + */ + locale?: string; - /** Array of JSON objects where each object represents a node - * @Default {[]} - */ - nodes?: Node[]; + /** Array of JSON objects where each object represents a node + * @Default {[]} + */ + nodes?: Node[]; - /** Binds the custom JSON data with node properties - * @Default {null} - */ - nodeTemplate?: any; + /** Binds the custom JSON data with node properties + * @Default {null} + */ + nodeTemplate?: any; - /** Defines the size and appearance of diagram page - */ - pageSettings?: PageSettings; + /** Defines the size and appearance of diagram page + */ + pageSettings?: PageSettings; - /** Defines the zoom value, zoom factor, scroll status and view port size of the diagram - */ - scrollSettings?: ScrollSettings; + /** Defines the zoom value, zoom factor, scroll status and view port size of the diagram + */ + scrollSettings?: ScrollSettings; - /** Defines the size and position of selected items and defines the appearance of selector - */ - selectedItems?: SelectedItems; + /** Defines the size and position of selected items and defines the appearance of selector + */ + selectedItems?: SelectedItems; - /** Enables or disables tooltip of diagram - * @Default {true} - */ - showTooltip?: boolean; + /** Enables or disables tooltip of diagram + * @Default {true} + */ + showTooltip?: boolean; - /** Defines the gridlines and defines how and when the objects have to be snapped - */ - snapSettings?: SnapSettings; + /** Defines the gridlines and defines how and when the objects have to be snapped + */ + snapSettings?: SnapSettings; - /** Enables/Disables the interactive behaviors of diagram. - * @Default {ej.datavisualization.Diagram.Tool.All} - */ - tool?: ej.datavisualization.Diagram.Tool|string; + /** Enables/Disables the interactive behaviors of diagram. + * @Default {ej.datavisualization.Diagram.Tool.All} + */ + tool?: ej.datavisualization.Diagram.Tool | string; - /** An object that defines the description, appearance and alignments of tooltips - * @Default {null} - */ - tooltip?: Tooltip; + /** An object that defines the description, appearance and alignments of tooltips + * @Default {null} + */ + tooltip?: Tooltip; - /** Specifies the width of the diagram - * @Default {null} - */ - width?: string; + /** Specifies the width of the diagram + * @Default {null} + */ + width?: string; - /** Sets the factor by which we can zoom in or zoom out - * @Default {0.2} - */ - zoomFactor?: number; + /** Sets the factor by which we can zoom in or zoom out + * @Default {0.2} + */ + zoomFactor?: number; - /** Triggers When auto scroll is changed */ - autoScrollChange?(e: AutoScrollChangeEventArgs): void; + /** Triggers When auto scroll is changed */ + autoScrollChange?(e: AutoScrollChangeEventArgs): void; - /** Triggers when a node, connector or diagram is clicked */ - click?(e: ClickEventArgs): void; + /** Triggers when a node, connector or diagram is clicked */ + click?(e: ClickEventArgs): void; - /** Triggers when the connection is changed */ - connectionChange?(e: ConnectionChangeEventArgs): void; + /** Triggers when the connection is changed */ + connectionChange?(e: ConnectionChangeEventArgs): void; - /** Triggers when the connector collection is changed */ - connectorCollectionChange?(e: ConnectorCollectionChangeEventArgs): void; + /** Triggers when the connector collection is changed */ + connectorCollectionChange?(e: ConnectorCollectionChangeEventArgs): void; - /** Triggers when the connectors' source point is changed */ - connectorSourceChange?(e: ConnectorSourceChangeEventArgs): void; + /** Triggers when the connectors' source point is changed */ + connectorSourceChange?(e: ConnectorSourceChangeEventArgs): void; - /** Triggers when the connectors' target point is changed */ - connectorTargetChange?(e: ConnectorTargetChangeEventArgs): void; + /** Triggers when the connectors' target point is changed */ + connectorTargetChange?(e: ConnectorTargetChangeEventArgs): void; - /** Triggers before opening the context menu */ - contextMenuBeforeOpen?(e: ContextMenuBeforeOpenEventArgs): void; + /** Triggers before opening the context menu */ + contextMenuBeforeOpen?(e: ContextMenuBeforeOpenEventArgs): void; - /** Triggers when a context menu item is clicked */ - contextMenuClick?(e: ContextMenuClickEventArgs): void; + /** Triggers when a context menu item is clicked */ + contextMenuClick?(e: ContextMenuClickEventArgs): void; - /** Triggers when a node, connector or diagram model is clicked twice */ - doubleClick?(e: DoubleClickEventArgs): void; + /** Triggers when a node, connector or diagram model is clicked twice */ + doubleClick?(e: DoubleClickEventArgs): void; - /** Triggers while dragging the elements in diagram */ - drag?(e: DragEventArgs): void; + /** Triggers while dragging the elements in diagram */ + drag?(e: DragEventArgs): void; - /** Triggers when a symbol is dragged into diagram from symbol palette */ - dragEnter?(e: DragEnterEventArgs): void; + /** Triggers when a symbol is dragged into diagram from symbol palette */ + dragEnter?(e: DragEnterEventArgs): void; - /** Triggers when a symbol is dragged outside of the diagram. */ - dragLeave?(e: DragLeaveEventArgs): void; + /** Triggers when a symbol is dragged outside of the diagram. */ + dragLeave?(e: DragLeaveEventArgs): void; - /** Triggers when a symbol is dragged over diagram */ - dragOver?(e: DragOverEventArgs): void; + /** Triggers when a symbol is dragged over diagram */ + dragOver?(e: DragOverEventArgs): void; - /** Triggers when a symbol is dragged and dropped from symbol palette to drawing area */ - drop?(e: DropEventArgs): void; + /** Triggers when a symbol is dragged and dropped from symbol palette to drawing area */ + drop?(e: DropEventArgs): void; - /** Triggers when editor got focus at the time of node's label or text node editing. */ - editorFocusChange?(e: EditorFocusChangeEventArgs): void; + /** Triggers when editor got focus at the time of node's label or text node editing. */ + editorFocusChange?(e: EditorFocusChangeEventArgs): void; - /** Triggers when a child is added to or removed from a group */ - groupChange?(e: GroupChangeEventArgs): void; + /** Triggers when a child is added to or removed from a group */ + groupChange?(e: GroupChangeEventArgs): void; - /** Triggers when a change is reverted or restored(undo/redo) */ - historyChange?(e: HistoryChangeEventArgs): void; + /** Triggers when a change is reverted or restored(undo/redo) */ + historyChange?(e: HistoryChangeEventArgs): void; - /** Triggers when a diagram element is clicked */ - itemClick?(e: ItemClickEventArgs): void; + /** Triggers when a diagram element is clicked */ + itemClick?(e: ItemClickEventArgs): void; - /** Triggers when mouse enters a node/connector */ - mouseEnter?(e: MouseEnterEventArgs): void; + /** Triggers when mouse enters a node/connector */ + mouseEnter?(e: MouseEnterEventArgs): void; - /** Triggers when mouse leaves node/connector */ - mouseLeave?(e: MouseLeaveEventArgs): void; + /** Triggers when mouse leaves node/connector */ + mouseLeave?(e: MouseLeaveEventArgs): void; - /** Triggers when mouse hovers over a node/connector */ - mouseOver?(e: MouseOverEventArgs): void; + /** Triggers when mouse hovers over a node/connector */ + mouseOver?(e: MouseOverEventArgs): void; - /** Triggers when node collection is changed */ - nodeCollectionChange?(e: NodeCollectionChangeEventArgs): void; + /** Triggers when node collection is changed */ + nodeCollectionChange?(e: NodeCollectionChangeEventArgs): void; - /** Triggers when the node properties(x, y,width and height alone) are changed using nudge commands or updateNode API. */ - propertyChange?(e: PropertyChangeEventArgs): void; + /** Triggers when the node properties(x, y,width and height alone) are changed using nudge commands or updateNode API. */ + propertyChange?(e: PropertyChangeEventArgs): void; - /** Triggers when the diagram elements are rotated */ - rotationChange?(e: RotationChangeEventArgs): void; + /** Triggers when the diagram elements are rotated */ + rotationChange?(e: RotationChangeEventArgs): void; - /** Triggers when the diagram is zoomed or panned */ - scrollChange?(e: ScrollChangeEventArgs): void; + /** Triggers when the diagram is zoomed or panned */ + scrollChange?(e: ScrollChangeEventArgs): void; - /** Triggers when a connector segment is edited */ - segmentChange?(e: SegmentChangeEventArgs): void; + /** Triggers when a connector segment is edited */ + segmentChange?(e: SegmentChangeEventArgs): void; - /** Triggers when the selection is changed in diagram */ - selectionChange?(e: SelectionChangeEventArgs): void; + /** Triggers when the selection is changed in diagram */ + selectionChange?(e: SelectionChangeEventArgs): void; - /** Triggers when a node is resized */ - sizeChange?(e: SizeChangeEventArgs): void; + /** Triggers when a node is resized */ + sizeChange?(e: SizeChangeEventArgs): void; - /** Triggers when label editing is ended */ - textChange?(e: TextChangeEventArgs): void; + /** Triggers when label editing is ended */ + textChange?(e: TextChangeEventArgs): void; - /** Triggered when the diagram is rendered completely. */ - create?(e: CreateEventArgs): void; -} + /** Triggered when the diagram is rendered completely. */ + create?(e: CreateEventArgs): void; + } -export interface AutoScrollChangeEventArgs { + export interface AutoScrollChangeEventArgs { - /** Returns the delay between subsequent auto scrolls - */ - delay?: string; + /** Returns the delay between subsequent auto scrolls + */ + delay?: string; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface ClickEventArgs { + export interface ClickEventArgs { - /** parameter returns the clicked node, connector or diagram - */ - element?: any; + /** parameter returns the clicked node, connector or diagram + */ + element?: any; - /** parameter returns the object that is actually clicked - */ - actualObject?: number; + /** parameter returns the object that is actually clicked + */ + actualObject?: number; - /** parameter returns the horizontal coordinate of the mouse pointer, relative to the diagram - */ - offsetX?: number; + /** parameter returns the horizontal coordinate of the mouse pointer, relative to the diagram + */ + offsetX?: number; - /** parameter returns the vertical coordinate of the mouse pointer, relative to the diagram - */ - offsetY?: number; + /** parameter returns the vertical coordinate of the mouse pointer, relative to the diagram + */ + offsetY?: number; - /** parameter returns the count of how many times the mouse button is pressed - */ - count?: number; + /** parameter returns the count of how many times the mouse button is pressed + */ + count?: number; - /** parameter returns the actual click event arguments that explains which button is clicked - */ - event?: any; + /** parameter returns the actual click event arguments that explains which button is clicked + */ + event?: any; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface ConnectionChangeEventArgs { + export interface ConnectionChangeEventArgs { - /** parameter returns the connection that is changed between nodes, ports or points - */ - element?: any; + /** parameter returns the connection that is changed between nodes, ports or points + */ + element?: any; - /** parameter returns the new source node or target node of the connector - */ - connection?: string; + /** parameter returns the new source node or target node of the connector + */ + connection?: string; - /** parameter returns the new source port or target port of the connector - */ - port?: any; + /** parameter returns the new source port or target port of the connector + */ + port?: any; - /** parameter defines whether to cancel the change or not - */ - cancel?: boolean; + /** parameter defines whether to cancel the change or not + */ + cancel?: boolean; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface ConnectorCollectionChangeEventArgs { + export interface ConnectorCollectionChangeEventArgs { - /** parameter returns whether the connector is inserted or removed - */ - changeType?: string; + /** parameter returns whether the connector is inserted or removed + */ + changeType?: string; - /** parameter returns the connector that is to be added or deleted - */ - element?: any; + /** parameter returns the connector that is to be added or deleted + */ + element?: any; - /** parameter defines whether to cancel the collection change or not - */ - cancel?: boolean; + /** parameter defines whether to cancel the collection change or not + */ + cancel?: boolean; - /** triggers before and after adding the connector in the diagram which can be differentiated through `state` argument. We can cancel the event only before adding the connector. - */ - state?: string; + /** triggers before and after adding the connector in the diagram which can be differentiated through `state` argument. We can cancel the event only before adding the connector. + */ + state?: string; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface ConnectorSourceChangeEventArgs { + export interface ConnectorSourceChangeEventArgs { - /** returns the connector, the source point of which is being dragged - */ - element?: any; + /** returns the connector, the source point of which is being dragged + */ + element?: any; - /** returns the source node of the element - */ - node?: any; + /** returns the source node of the element + */ + node?: any; - /** returns the source point of the element - */ - point?: any; + /** returns the source point of the element + */ + point?: any; - /** returns the source port of the element - */ - port?: any; + /** returns the source port of the element + */ + port?: any; - /** returns the state of connection end point dragging(starting, dragging, completed) - */ - dragState?: string; + /** returns the state of connection end point dragging(starting, dragging, completed) + */ + dragState?: string; - /** parameter defines whether to cancel the change or not - */ - cancel?: boolean; + /** parameter defines whether to cancel the change or not + */ + cancel?: boolean; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface ConnectorTargetChangeEventArgs { + export interface ConnectorTargetChangeEventArgs { - /** parameter returns the connector, the target point of which is being dragged - */ - element?: any; + /** parameter returns the connector, the target point of which is being dragged + */ + element?: any; - /** returns the target node of the element - */ - node?: any; + /** returns the target node of the element + */ + node?: any; - /** returns the target point of the element - */ - point?: any; + /** returns the target point of the element + */ + point?: any; - /** returns the target port of the element - */ - port?: any; + /** returns the target port of the element + */ + port?: any; - /** returns the state of connection end point dragging(starting, dragging, completed) - */ - dragState?: string; + /** returns the state of connection end point dragging(starting, dragging, completed) + */ + dragState?: string; - /** parameter defines whether to cancel the change or not - */ - cancel?: boolean; + /** parameter defines whether to cancel the change or not + */ + cancel?: boolean; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface ContextMenuBeforeOpenEventArgs { + export interface ContextMenuBeforeOpenEventArgs { - /** parameter returns the diagram object - */ - diagram?: any; + /** parameter returns the diagram object + */ + diagram?: any; - /** parameter returns the actual arguments from context menu - */ - contextmenu?: any; + /** parameter returns the actual arguments from context menu + */ + contextmenu?: any; - /** parameter returns the object that was clicked - */ - target?: any; + /** parameter returns the object that was clicked + */ + target?: any; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface ContextMenuClickEventArgs { + export interface ContextMenuClickEventArgs { - /** parameter returns the id of the selected context menu item - */ - id?: string; + /** parameter returns the id of the selected context menu item + */ + id?: string; - /** parameter returns the text of the selected context menu item - */ - text?: string; + /** parameter returns the text of the selected context menu item + */ + text?: string; - /** parameter returns the parent id of the selected context menu item - */ - parentId?: string; + /** parameter returns the parent id of the selected context menu item + */ + parentId?: string; - /** parameter returns the parent text of the selected context menu item - */ - parentText?: string; + /** parameter returns the parent text of the selected context menu item + */ + parentText?: string; - /** parameter returns the object that was clicked - */ - target?: any; + /** parameter returns the object that was clicked + */ + target?: any; - /** parameter defines whether to execute the click event or not - */ - canExecute?: boolean; + /** parameter defines whether to execute the click event or not + */ + canExecute?: boolean; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface DoubleClickEventArgs { + export interface DoubleClickEventArgs { - /** parameter returns the object that is actually clicked - */ - actualObject?: any; + /** parameter returns the object that is actually clicked + */ + actualObject?: any; - /** parameter returns the selected object - */ - element?: any; + /** parameter returns the selected object + */ + element?: any; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface DragEventArgs { + export interface DragEventArgs { - /** parameter returns the node or connector that is being dragged - */ - element?: any; + /** parameter returns the node or connector that is being dragged + */ + element?: any; - /** parameter returns the previous position of the node/connector - */ - oldValue?: any; + /** parameter returns the previous position of the node/connector + */ + oldValue?: any; - /** parameter returns the new position of the node/connector - */ - newValue?: any; + /** parameter returns the new position of the node/connector + */ + newValue?: any; - /** parameter returns the state of drag event (Starting, dragging, completed) - */ - dragState?: string; + /** parameter returns the state of drag event (Starting, dragging, completed) + */ + dragState?: string; - /** parameter returns whether or not to cancel the drag event - */ - cancel?: boolean; + /** parameter returns whether or not to cancel the drag event + */ + cancel?: boolean; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface DragEnterEventArgs { + export interface DragEnterEventArgs { - /** parameter returns the node or connector that is dragged into diagram - */ - element?: any; + /** parameter returns the node or connector that is dragged into diagram + */ + element?: any; - /** parameter returns whether to add or remove the symbol from diagram - */ - cancel?: boolean; + /** parameter returns whether to add or remove the symbol from diagram + */ + cancel?: boolean; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface DragLeaveEventArgs { + export interface DragLeaveEventArgs { - /** parameter returns the node or connector that is dragged outside of the diagram - */ - element?: any; + /** parameter returns the node or connector that is dragged outside of the diagram + */ + element?: any; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface DragOverEventArgs { + export interface DragOverEventArgs { - /** parameter returns the node or connector that is dragged over diagram - */ - element?: any; + /** parameter returns the node or connector that is dragged over diagram + */ + element?: any; - /** parameter defines whether the symbol can be dropped at the current mouse position - */ - allowDrop?: boolean; + /** parameter defines whether the symbol can be dropped at the current mouse position + */ + allowDrop?: boolean; - /** parameter returns the node/connector over which the symbol is dragged - */ - target?: any; + /** parameter returns the node/connector over which the symbol is dragged + */ + target?: any; - /** parameter returns the previous position of the node/connector - */ - oldValue?: any; + /** parameter returns the previous position of the node/connector + */ + oldValue?: any; - /** parameter returns the new position of the node/connector - */ - newValue?: any; + /** parameter returns the new position of the node/connector + */ + newValue?: any; - /** parameter returns whether or not to cancel the dragOver event - */ - cancel?: boolean; + /** parameter returns whether or not to cancel the dragOver event + */ + cancel?: boolean; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface DropEventArgs { + export interface DropEventArgs { - /** parameter returns node or connector that is being dropped - */ - element?: any; + /** parameter returns node or connector that is being dropped + */ + element?: any; - /** parameter returns whether or not to cancel the drop event - */ - cancel?: boolean; + /** parameter returns whether or not to cancel the drop event + */ + cancel?: boolean; - /** parameter returns the object from where the element is dragged - */ - source?: any; + /** parameter returns the object from where the element is dragged + */ + source?: any; - /** parameter returns the object over which the object will be dropped - */ - target?: any; + /** parameter returns the object over which the object will be dropped + */ + target?: any; - /** parameter returns the enum which defines the type of the source - */ - sourceType?: string; + /** parameter returns the enum which defines the type of the source + */ + sourceType?: string; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface EditorFocusChangeEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; -} + export interface EditorFocusChangeEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; + } -export interface GroupChangeEventArgs { + export interface GroupChangeEventArgs { - /** parameter returns the object that is added to/removed from a group - */ - element?: any; + /** parameter returns the object that is added to/removed from a group + */ + element?: any; - /** parameter returns the old parent group(if any) of the object - */ - oldParent?: any; + /** parameter returns the old parent group(if any) of the object + */ + oldParent?: any; - /** parameter returns the new parent group(if any) of the object - */ - newParent?: any; + /** parameter returns the new parent group(if any) of the object + */ + newParent?: any; - /** parameter returns the cause of group change("group", unGroup") - */ - cause?: string; + /** parameter returns the cause of group change("group", unGroup") + */ + cause?: string; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface HistoryChangeEventArgs { + export interface HistoryChangeEventArgs { - /** An array of objects, where each object represents the changes made in last undo/redo. To explore how the changes are defined, refer [Undo Redo Changes](#undo-redo-changes) - */ - changes?: any[]; + /** An array of objects, where each object represents the changes made in last undo/redo. To explore how the changes are defined, refer [Undo Redo Changes](#undo-redo-changes) + */ + changes?: any[]; - /** A collection of objects that are changed in the last undo/redo - */ - Source?: any[]; + /** A collection of objects that are changed in the last undo/redo + */ + Source?: any[]; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface ItemClickEventArgs { + export interface ItemClickEventArgs { - /** parameter returns the object that was actually clicked - */ - actualObject?: any; + /** parameter returns the object that was actually clicked + */ + actualObject?: any; - /** parameter returns the object that is selected - */ - selectedObject?: any; + /** parameter returns the object that is selected + */ + selectedObject?: any; - /** parameter returns whether or not to cancel the drop event - */ - cancel?: boolean; + /** parameter returns whether or not to cancel the drop event + */ + cancel?: boolean; - /** parameter returns the actual click event arguments that explains which button is clicked - */ - event?: any; + /** parameter returns the actual click event arguments that explains which button is clicked + */ + event?: any; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface MouseEnterEventArgs { + export interface MouseEnterEventArgs { - /** parameter returns the target node or connector - */ - element?: any; + /** parameter returns the target node or connector + */ + element?: any; - /** parameter returns the object from where the selected object is dragged - */ - source?: any; + /** parameter returns the object from where the selected object is dragged + */ + source?: any; - /** parameter returns the target object over which the selected object is dragged - */ - target?: any; + /** parameter returns the target object over which the selected object is dragged + */ + target?: any; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface MouseLeaveEventArgs { + export interface MouseLeaveEventArgs { - /** parameter returns the target node or connector - */ - element?: any; + /** parameter returns the target node or connector + */ + element?: any; - /** parameter returns the object from where the selected object is dragged - */ - source?: any; + /** parameter returns the object from where the selected object is dragged + */ + source?: any; - /** parameter returns the target object over which the selected object is dragged - */ - target?: any; + /** parameter returns the target object over which the selected object is dragged + */ + target?: any; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface MouseOverEventArgs { + export interface MouseOverEventArgs { - /** parameter returns the target node or connector - */ - element?: any; + /** parameter returns the target node or connector + */ + element?: any; - /** parameter returns the object from where the element is dragged - */ - source?: any; + /** parameter returns the object from where the element is dragged + */ + source?: any; - /** parameter returns the object over which the element is being dragged. - */ - target?: any; + /** parameter returns the object over which the element is being dragged. + */ + target?: any; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface NodeCollectionChangeEventArgs { + export interface NodeCollectionChangeEventArgs { - /** parameter returns whether the node is to be added or removed - */ - changeType?: string; + /** parameter returns whether the node is to be added or removed + */ + changeType?: string; - /** parameter returns the node which needs to be added or deleted - */ - element?: any; + /** parameter returns the node which needs to be added or deleted + */ + element?: any; - /** parameter defines whether to cancel the collection change or not - */ - cancel?: boolean; + /** parameter defines whether to cancel the collection change or not + */ + cancel?: boolean; - /** triggers before and after adding the node in the diagram which can be differentiated through `state` argument. We can cancel the event only before adding the node - */ - state?: string; + /** triggers before and after adding the node in the diagram which can be differentiated through `state` argument. We can cancel the event only before adding the node + */ + state?: string; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface PropertyChangeEventArgs { + export interface PropertyChangeEventArgs { - /** parameter returns the selected element - */ - element?: any; + /** parameter returns the selected element + */ + element?: any; - /** parameter returns the action is nudge or not - */ - cause?: string; + /** parameter returns the action is nudge or not + */ + cause?: string; - /** parameter returns the new value of the node property that is being changed - */ - newValue?: any; + /** parameter returns the new value of the node property that is being changed + */ + newValue?: any; - /** parameter returns the old value of the property that is being changed - */ - oldValue?: any; + /** parameter returns the old value of the property that is being changed + */ + oldValue?: any; - /** parameter returns the name of the property that is changed - */ - propertyName?: string; + /** parameter returns the name of the property that is changed + */ + propertyName?: string; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface RotationChangeEventArgs { + export interface RotationChangeEventArgs { - /** parameter returns the node that is rotated - */ - element?: any; + /** parameter returns the node that is rotated + */ + element?: any; - /** parameter returns the previous rotation angle - */ - oldValue?: any; + /** parameter returns the previous rotation angle + */ + oldValue?: any; - /** parameter returns the new rotation angle - */ - newValue?: any; + /** parameter returns the new rotation angle + */ + newValue?: any; - /** parameter to specify whether or not to cancel the event - */ - cancel?: boolean; + /** parameter to specify whether or not to cancel the event + */ + cancel?: boolean; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface ScrollChangeEventArgs { + export interface ScrollChangeEventArgs { - /** Parameter returns the new zoom value, horizontal and vertical scroll offsets. - */ - newValues?: any; + /** Parameter returns the new zoom value, horizontal and vertical scroll offsets. + */ + newValues?: any; - /** parameter returns the previous zoom value, horizontal and vertical scroll offsets. - */ - oldValues?: any; + /** parameter returns the previous zoom value, horizontal and vertical scroll offsets. + */ + oldValues?: any; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface SegmentChangeEventArgs { + export interface SegmentChangeEventArgs { - /** Parameter returns the connector that is being edited - */ - element?: any; + /** Parameter returns the connector that is being edited + */ + element?: any; - /** parameter returns the state of editing (starting, dragging, completed) - */ - dragState?: string; + /** parameter returns the state of editing (starting, dragging, completed) + */ + dragState?: string; - /** parameter returns the current mouse position - */ - point?: any; + /** parameter returns the current mouse position + */ + point?: any; - /** parameter to specify whether or not to cancel the event - */ - cancel?: boolean; + /** parameter to specify whether or not to cancel the event + */ + cancel?: boolean; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface SelectionChangeEventArgs { + export interface SelectionChangeEventArgs { - /** parameter returns whether the item is selected or removed selection - */ - changeType?: string; + /** parameter returns whether the item is selected or removed selection + */ + changeType?: string; - /** parameter returns the item which is selected or to be selected - */ - element?: any; + /** parameter returns the item which is selected or to be selected + */ + element?: any; - /** parameter returns the collection of nodes and connectors that have to be removed from selection list - */ - oldItems?: any[]; + /** parameter returns the collection of nodes and connectors that have to be removed from selection list + */ + oldItems?: any[]; - /** parameter returns the collection of nodes and connectors that have to be added to selection list - */ - newItems?: any[]; + /** parameter returns the collection of nodes and connectors that have to be added to selection list + */ + newItems?: any[]; - /** parameter returns the collection of nodes and connectors that will be selected after selection change - */ - selectedItems?: any[]; + /** parameter returns the collection of nodes and connectors that will be selected after selection change + */ + selectedItems?: any[]; - /** parameter to specify whether or not to cancel the selection change event - */ - cancel?: boolean; + /** parameter to specify whether or not to cancel the selection change event + */ + cancel?: boolean; - /** triggers before and after adding the selection to the object in the diagram which can be differentiated through `state` argument. We can cancel the event only before the selection of the object. - */ - state?: string; + /** triggers before and after adding the selection to the object in the diagram which can be differentiated through `state` argument. + * We can cancel the event only before the selection of the object. + */ + state?: string; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface SizeChangeEventArgs { + export interface SizeChangeEventArgs { - /** parameter returns node that was resized - */ - element?: any; + /** parameter returns node that was resized + */ + element?: any; - /** parameter to cancel the size change - */ - cancel?: boolean; + /** parameter to cancel the size change + */ + cancel?: boolean; - /** parameter returns the new width, height, offsetX and offsetY values of the element that is being resized - */ - newValue?: any; + /** parameter returns the new width, height, offsetX and offsetY values of the element that is being resized + */ + newValue?: any; - /** parameter returns the previous width,height,offsetX and offsetY values of the element that is being resized - */ - oldValue?: any; + /** parameter returns the previous width,height,offsetX and offsetY values of the element that is being resized + */ + oldValue?: any; - /** parameter returns the state of resizing(starting,resizing,completed) - */ - resizeState?: string; + /** parameter returns the state of resizing(starting,resizing,completed) + */ + resizeState?: string; - /** parameter returns the difference between new and old value - */ - offset?: any; + /** parameter returns the difference between new and old value + */ + offset?: any; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface TextChangeEventArgs { + export interface TextChangeEventArgs { - /** parameter returns the node that contains the text being edited - */ - element?: any; + /** parameter returns the node that contains the text being edited + */ + element?: any; - /** parameter returns the new text - */ - value?: string; + /** parameter returns the new text + */ + value?: string; - /** parameter returns the keyCode of the key entered - */ - keyCode?: string; + /** parameter returns the keyCode of the key entered + */ + keyCode?: string; - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + /** parameter returns the id of the diagram + */ + diagramId?: string; + } -export interface CreateEventArgs { + export interface CreateEventArgs { + + /** Returns the diagram model. + */ + model?: any; + + /** Returns the name of the event + */ + type?: string; + + /** parameter returns the id of the diagram + */ + diagramId?: string; + } + + export interface BackgroundImage { + + /** Defines how to align the background image over the diagram area. + * @Default {ej.datavisualization.Diagram.ImageAlignment.XMidYMid} + */ + alignment?: ej.datavisualization.Diagram.ImageAlignment | string; + } + + export interface CommandManagerCommandsGesture { + + /** Sets the key value, on recognition of which the command will be executed. + * @Default {ej.datavisualization.Diagram.Keys.None} + */ + key?: ej.datavisualization.Diagram.Keys | string; + + /** Sets a combination of key modifiers, on recognition of which the command will be executed. + * @Default {ej.datavisualization.Diagram.KeyModifiers.None} + */ + keyModifiers?: ej.datavisualization.Diagram.KeyModifiers | string; + } + + export interface CommandManagerCommands { + + /** A method that defines whether the command is executable at the moment or not. + */ + canExecute?: any; + + /** A method that defines what to be executed when the key combination is recognized. + */ + execute?: any; + + /** Defines a combination of keys and key modifiers, on recognition of which the command will be executed + */ + gesture?: CommandManagerCommandsGesture; + + /** Defines any additional parameters that are required at runtime + * @Default {null} + */ + parameter?: any; + } + + export interface CommandManager { + + /** An object that maps a set of command names with the corresponding command objects + * @Default {{}} + */ + commands?: CommandManagerCommands; + } + + export interface ConnectorsLabelsMargin { + + /** To set the margin of the label in right direction + * @Default {0} + */ + right?: number; + + /** To set the margin of the label in left direction + * @Default {0} + */ + left?: number; + + /** To set the margin of the label in top direction + * @Default {0} + */ + top?: number; + + /** To set the margin of the label in bottom direction + * @Default {0} + */ + bottom?: number; + } + + export interface ConnectorsLabel { + + /** Defines how the label should be aligned with respect to the segment + * @Default {ej.datavisualization.Diagram.Alignment.Center} + */ + alignment?: ej.datavisualization.Diagram.Alignment | string; + + /** Enables/disables the bold style + * @Default {false} + */ + bold?: boolean; + + /** Sets the border color of the label + * @Default {transparent} + */ + borderColor?: string; + + /** Sets the border width of the label + * @Default {0} + */ + borderWidth?: number; + + /** Defines whether the label should be aligned within the connector boundaries + * @Default {true} + */ + boundaryConstraints?: boolean; + + /** Sets the fill color of the text area + * @Default {transparent} + */ + fillColor?: string; + + /** Sets the font color of the text + * @Default {black} + */ + fontColor?: string; + + /** Sets the font family of the text + * @Default {Arial} + */ + fontFamily?: string; + + /** Defines the font size of the text + * @Default {12} + */ + fontSize?: number; + + /** Sets the horizontal alignment of the label. + * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Center} + */ + horizontalAlignment?: ej.datavisualization.Diagram.HorizontalAlignment | string; + + /** Sets the hyperlink for the labels in the connectors. + * @Default {none} + */ + hyperlink?: string; + + /** Enables/disables the italic style + * @Default {false} + */ + italic?: boolean; + + /** Gets whether the label is currently being edited or not. + * @Default {ej.datavisualization.Diagram.LabelEditMode.Edit} + */ + mode?: ej.datavisualization.Diagram.LabelEditMode | string; + + /** Sets the unique identifier of the label + */ + name?: string; + + /** Sets the fraction/ratio(relative to connector) that defines the position of the label + * @Default {ej.datavisualization.Diagram.Point(0.5, 0.5)} + */ + offset?: any; + + /** Sets the fraction/ratio(relative to connector) that defines the position of the label + * @Default {ej.datavisualization.Diagram.Point(0.5, 0.5)} + */ + margin?: ConnectorsLabelsMargin; + + /** Defines the transparency of labels + * @Default {1} + */ + opacity?: number; + + /** Defines whether the label is editable or not + * @Default {false} + */ + readOnly?: boolean; + + /** Defines whether the label should be positioned whether relative to segments or connector boundaries + * @Default {ej.datavisualization.Diagram.LabelRelativeMode.SegmentPath} + */ + relativeMode?: ej.datavisualization.Diagram.LabelRelativeMode | string; + + /** Defines the angle to which the label needs to be rotated + * @Default {0} + */ + rotateAngle?: number; + + /** Sets the position of the label with respect to the total segment length + * @Default {0.5} + */ + segmentOffset?: string; + + /** Defines the label text + */ + text?: string; + + /** Defines how to align the text inside the label. + * @Default {ej.datavisualization.Diagram.TextAlign.Center} + */ + textAlign?: ej.datavisualization.Diagram.TextAlign | string; + + /** Sets how to decorate the label text. + * @Default {ej.datavisualization.Diagram.TextDecorations.None} + */ + textDecoration?: ej.datavisualization.Diagram.TextDecorations | string; + + /** Sets the vertical alignment of the label. + * @Default {ej.datavisualization.Diagram.VerticalAlignment.Center} + */ + verticalAlignment?: ej.datavisualization.Diagram.VerticalAlignment | string; + + /** Enables or disables the visibility of the label + * @Default {true} + */ + visible?: boolean; + + /** Sets the width of the label(the maximum value of label width and the connector width will be considered as label width) + * @Default {50} + */ + width?: number; + + /** Defines how the label text needs to be wrapped. + * @Default {ej.datavisualization.Diagram.TextWrapping.WrapWithOverflow} + */ + wrapping?: ej.datavisualization.Diagram.TextWrapping | string; + } + + export interface ConnectorsSegment { + + /** Sets the direction of orthogonal segment + */ + direction?: string; + + /** Describes the length of orthogonal segment + * @Default {undefined} + */ + length?: number; + + /** Describes the end point of bezier/straight segment + * @Default {Diagram.Point()} + */ + point?: ej.datavisualization.Diagram.ConnectorsSourcePoint; + + /** Defines the first control point of the bezier segment + * @Default {null} + */ + point1?: ej.datavisualization.Diagram.ConnectorsSourcePoint; + + /** Defines the second control point of bezier segment + * @Default {null} + */ + point2?: ej.datavisualization.Diagram.ConnectorsSourcePoint; + + /** Sets the type of the segment. + * @Default {ej.datavisualization.Diagram.Segments.Straight} + */ + type?: ej.datavisualization.Diagram.Segments | string; + + /** Describes the length and angle between the first control point and the start point of bezier segment + * @Default {null} + */ + vector1?: any; + + /** Describes the length and angle between the second control point and end point of bezier segment + * @Default {null} + */ + vector2?: any; + } + + export interface ConnectorsShapeMultiplicitySource { + + /** Defines the source label to connector. Applicable, if the connector is of type "UML" + * @Default {true} + */ + optional?: boolean; + + /** Defines the source label to connector. Applicable, if the connector is of type "UML" + * @Default {null} + */ + lowerBounds?: number; + + /** Defines the source label to connector. Applicable, if the connector is of type "UML" + * @Default {null} + */ + upperBounds?: number; + } + + export interface ConnectorsShapeMultiplicity { + + /** Sets the type of the multiplicity. Applicable, if the connector is of type "classifier" + * @Default {ej.datavisualization.Diagram.Multiplicity.OneToOne} + */ + type?: ej.datavisualization.Diagram.Multiplicity | string; + + /** Defines the source label to connector. Applicable, if the connector is of type "UML" + */ + source?: ConnectorsShapeMultiplicitySource; + + /** Defines the target label to connector. Applicable, if the connector is of type "UML" + * @Default {true} + */ + target?: ej.datavisualization.Diagram.ConnectorsShapeMultiplicitySource; + } + + export interface ConnectorsShape { + + /** Sets the type of the connector + * @Default {ej.datavisualization.Diagram.ConnectorShapes.BPMN} + */ + type?: ej.datavisualization.Diagram.ConnectorShapes | string; + + /** Sets the type of the flow in a BPMN Process + * @Default {ej.datavisualization.Diagram.BPMNFlows.Sequence} + */ + flow?: ej.datavisualization.Diagram.BPMNFlows | string; + + /** Sets the type of the Association in a BPMN Process + * @Default {ej.datavisualization.Diagram.AssociationFlows.Default} + */ + association?: ej.datavisualization.Diagram.AssociationFlows | string; + + /** Sets the type of the message flow. Applicable, if the connector is of type "BPMN" + * @Default {ej.datavisualization.Diagram.BPMNMessageFlows.Default} + */ + message?: ej.datavisualization.Diagram.BPMNMessageFlows | string; + + /** Sets the type of BPMN sequence flow + * @Default {ej.datavisualization.Diagram.BPMNSequenceFlows.Normal} + */ + sequence?: ej.datavisualization.Diagram.BPMNSequenceFlows | string; + + /** Defines the role of the connector in a UML Class Diagram. Applicable, if the type of the connector is "classifier". + * @Default {ej.datavisualization.Diagram.ClassifierShapes.Association} + */ + relationship?: ej.datavisualization.Diagram.ClassifierShapes | string; + + /** Defines the multiplicity option of the connector + * @Default {null} + */ + multiplicity?: ConnectorsShapeMultiplicity; + + /** Defines the shape of UMLActivity to connector. Applicable, if the connector is of type UMLActivity + * @Default {ej.datavisualization.Diagram.UMLActivityFlow.Control} + */ + ActivityFlow?: ej.datavisualization.Diagram.UMLActivityFlow | string; + } + + export interface ConnectorsSourceDecorator { + + /** Sets the border color of the source decorator + * @Default {black} + */ + borderColor?: string; + + /** Sets the border width of the decorator + * @Default {1} + */ + borderWidth?: number; + + /** Sets the fill color of the source decorator + * @Default {black} + */ + fillColor?: string; + + /** Sets the height of the source decorator + * @Default {8} + */ + height?: number; + + /** Defines the custom shape of the source decorator + */ + pathData?: string; + + /** Defines the shape of the source decorator. + * @Default {ej.datavisualization.Diagram.DecoratorShapes.Arrow} + */ + shape?: ej.datavisualization.Diagram.DecoratorShapes | string; + + /** Defines the width of the source decorator + * @Default {8} + */ + width?: number; + } + + export interface ConnectorsSourcePoint { + + /** Defines the x-coordinate of a position + * @Default {0} + */ + x?: number; + + /** Defines the y-coordinate of a position + * @Default {0} + */ + y?: number; + } + + export interface ConnectorsTargetDecorator { + + /** Sets the border color of the decorator + * @Default {black} + */ + borderColor?: string; + + /** Sets the color with which the decorator will be filled + * @Default {black} + */ + fillColor?: string; + + /** Defines the height of the target decorator + * @Default {8} + */ + height?: number; + + /** Defines the custom shape of the target decorator + */ + pathData?: string; + + /** Defines the shape of the target decorator. + * @Default {ej.datavisualization.Diagram.DecoratorShapes.Arrow} + */ + shape?: ej.datavisualization.Diagram.DecoratorShapes | string; + + /** Defines the width of the target decorator + * @Default {8} + */ + width?: number; + } + + export interface Connector { + + /** To maintain additional information about connectors + * @Default {null} + */ + addInfo?: any; + + /** Defines the width of the line bridges + * @Default {10} + */ + bridgeSpace?: number; + + /** Enables or disables the behaviors of connectors. + * @Default {ej.datavisualization.Diagram.ConnectorConstraints.Default} + */ + constraints?: ej.datavisualization.Diagram.ConnectorConstraints | string; + + /** Defines the radius of the rounded corner + * @Default {0} + */ + cornerRadius?: number; + + /** Configures the styles of shapes + */ + cssClass?: string; + + /** Sets the horizontal alignment of the connector. Applicable, if the parent of the connector is a container. + * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Left} + */ + horizontalAlign?: ej.datavisualization.Diagram.HorizontalAlignment | string; + + /** A collection of JSON objects where each object represents a label. + * @Default {[]} + */ + labels?: ConnectorsLabel[]; + + /** Sets the stroke color of the connector + * @Default {black} + */ + lineColor?: string; + + /** Sets the pattern of dashes and gaps used to stroke the path of the connector + */ + lineDashArray?: string; + + /** Defines the padding value to ease the interaction with connectors + * @Default {10} + */ + lineHitPadding?: number; + + /** Sets the width of the line + * @Default {1} + */ + lineWidth?: number; + + /** Defines the minimum space to be left between the bottom of parent bounds and the connector. Applicable, if the parent is a container. + * @Default {0} + */ + marginBottom?: number; + + /** Defines the minimum space to be left between the left of parent bounds and the connector. Applicable, if the parent is a container. + * @Default {0} + */ + marginLeft?: number; + + /** Defines the minimum space to be left between the right of parent bounds and the connector. Applicable, if the parent is a container. + * @Default {0} + */ + marginRight?: number; + + /** Defines the minimum space to be left between the top of parent bounds and the connector. Applicable, if the parent is a container. + * @Default {0} + */ + marginTop?: number; + + /** Sets a unique name for the connector + */ + name?: string; + + /** Defines the transparency of the connector + * @Default {1} + */ + opacity?: number; + + /** Defines the size and preview size of the node to add that to symbol palette. To explore palette item, refer Palette Item + * @Default {null} + */ + paletteItem?: any; + + /** Sets the parent name of the connector. + */ + parent?: string; + + /** An array of JSON objects where each object represents a segment + * @Default {[ { type:straight } ]} + */ + segments?: ConnectorsSegment[]; + + /** Defines the role/meaning of the connector + * @Default {null} + */ + shape?: ConnectorsShape; + + /** Defines the source decorator of the connector + * @Default {{ shape:arrow, width: 8, height:8, borderColor:black, fillColor:black }} + */ + sourceDecorator?: ConnectorsSourceDecorator; + + /** Sets the source node of the connector + */ + sourceNode?: string; + + /** Defines the space to be left between the source node and the source point of a connector + * @Default {0} + */ + sourcePadding?: number; + + /** Describes the start point of the connector + * @Default {ej.datavisualization.Diagram.Point()} + */ + sourcePoint?: ConnectorsSourcePoint; + + /** Sets the source port of the connector + */ + sourcePort?: string; + + /** Defines the target decorator of the connector + * @Default {{ shape:arrow, width: 8, height:8, borderColor:black, fillColor:black }} + */ + targetDecorator?: ConnectorsTargetDecorator; + + /** Sets the target node of the connector + */ + targetNode?: string; + + /** Defines the space to be left between the target node and the target point of the connector + * @Default {0} + */ + targetPadding?: number; + + /** Describes the end point of the connector + * @Default {ej.datavisualization.Diagram.Point()} + */ + targetPoint?: ej.datavisualization.Diagram.ConnectorsSourcePoint; + + /** Sets the targetPort of the connector + */ + targetPort?: string; + + /** Defines the tooltip that should be shown when the mouse hovers over connector. For tooltip properties, refer Tooltip + * @Default {null} + */ + tooltip?: any; + + /** To set the vertical alignment of connector (Applicable,if the parent is group). + * @Default {ej.datavisualization.Diagram.VerticalAlignment.Top} + */ + verticalAlign?: ej.datavisualization.Diagram.VerticalAlignment | string; + + /** Enables or disables the visibility of connector + * @Default {true} + */ + visible?: boolean; + + /** Sets the z-index of the connector + * @Default {0} + */ + zOrder?: number; + } + + export interface ContextMenuItem { + + /** Defines the text for the collection of context menu item + * @Default {null} + */ + text?: string; + + /** Defines the name for the collection of context menu items + * @Default {null} + */ + name?: string; + + /** Defines the image url for the collection of context menu items + * @Default {null} + */ + imageUrl?: string; + + /** Defines the CssClass for the collection of context menu items + * @Default {null} + */ + cssClass?: string; + + /** Defines the collection of sub items for the context menu items + * @Default {[]} + */ + subItems?: any[]; + } + + export interface ContextMenu { + + /** Defines the collection of context menu items + * @Default {[]} + */ + items?: ContextMenuItem[]; + + /** To set whether to display the default context menu items or not + * @Default {false} + */ + showCustomMenuItemsOnly?: boolean; + } + + export interface DataSourceSettings { + + /** Defines the data source either as a collection of objects or as an instance of ej.DataManager + * @Default {null} + */ + dataSource?: any; + + /** Sets the unique id of the data source items + */ + id?: string; + + /** Defines the parent id of the data source item + * @Default {''} + */ + parent?: string; + + /** Describes query to retrieve a set of data from the specified datasource + * @Default {null} + */ + query?: string; + + /** Sets the unique id of the root data source item + */ + root?: string; + + /** Describes the name of the table on which the specified query has to be executed + * @Default {null} + */ + tableName?: string; + } + + export interface DefaultSettings { + + /** Initializes the default connector properties + * @Default {null} + */ + connector?: any; + + /** Initializes the default properties of groups + * @Default {null} + */ + group?: any; + + /** Initializes the default properties for nodes + * @Default {null} + */ + node?: any; + } + + export interface HistoryManager { + + /** A method that takes a history entry as argument and returns whether the specific entry can be popped or not + */ + canPop?: any; + + /** A method that ends grouping the changes + */ + closeGroupAction?: any; + + /** A method that removes the history of a recent change made in diagram + */ + pop?: any; + + /** A method that allows to track the custom changes made in diagram + */ + push?: any; + + /** Defines what should be happened while trying to restore a custom change + * @Default {null} + */ + redo?: any; + + /** The redoStack property is used to get the number of redo actions to be stored on the history manager. Its an read-only property and the collection should not be modified. + * @Default {[]} + */ + redoStack?: any[]; + + /** The stackLimit property used to restrict the undo and redo actions to a certain limit. + * @Default {null} + */ + stackLimit?: number; + + /** A method that starts to group the changes to revert/restore them in a single undo or redo + */ + startGroupAction?: any; + + /** Defines what should be happened while trying to revert a custom change + */ + undo?: any; + + /** The undoStack property is used to get the number of undo actions to be stored on the history manager. Its an read-only property and the collection should not be modified. + * @Default {[]} + */ + undoStack?: any[]; + } + + export interface Layout { + + /** Specifies the custom bounds to arrange/align the layout + * @Default {ej.datavisualization.Diagram.Rectangle()} + */ + bounds?: any; + + /** Defines the fixed node with reference to which, the layout will be arranged and fixed node will not be repositioned + */ + fixedNode?: string; + + /** Customizes the orientation of trees/sub trees. For orientations, see Chart Orientations. For chart types, see Chart Types + * @Default {null} + */ + getLayoutInfo?: any; + + /** Sets the space to be horizontally left between nodes + * @Default {30} + */ + horizontalSpacing?: number; + + /** Defines the space to be left between layout bounds and layout. + * @Default {ej.datavisualization.Diagram.Margin()} + */ + margin?: any; + + /** Defines how to horizontally align the layout within the layout bounds + * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Center} + */ + horizontalAlignment?: ej.datavisualization.Diagram.HorizontalAlignment | string; + + /** Defines how to vertically align the layout within the layout bounds + * @Default {ej.datavisualization.Diagram.VerticalAlignment.Center} + */ + verticalAlignment?: ej.datavisualization.Diagram.VerticalAlignment | string; + + /** Sets the orientation/direction to arrange the diagram elements. + * @Default {ej.datavisualization.Diagram.LayoutOrientations.TopToBottom} + */ + orientation?: ej.datavisualization.Diagram.LayoutOrientations | string; + + /** Sets the type of the layout based on which the elements will be arranged. + * @Default {ej.datavisualization.Diagram.LayoutTypes.None} + */ + type?: ej.datavisualization.Diagram.LayoutTypes | string; + + /** Sets the space to be vertically left between nodes + * @Default {30} + */ + verticalSpacing?: number; + } + + export interface NodesAnnotation { + + /** Sets the angle between the BPMN shape and the annotation + * @Default {0} + */ + angle?: number; + + /** Sets the direction of the text annotation + * @Default {ej.datavisualization.Diagram.BPMNAnnotationDirections.Left} + */ + direction?: ej.datavisualization.Diagram.BPMNAnnotationDirection | string; + + /** Sets the height of the text annotation + * @Default {20} + */ + height?: number; + + /** Sets the distance between the BPMN shape and the annotation + * @Default {0} + */ + length?: number; + + /** Defines the additional information about the flow object in a BPMN Process + */ + text?: string; + + /** Sets the width of the text annotation + * @Default {20} + */ + width?: number; + } + + export interface NodesClassAttribute { + + /** Sets the name of the attribute + */ + name?: string; + + /** Sets the data type of attribute + */ + type?: string; + + /** Defines the visibility of the attribute + * @Default {ej.datavisualization.Diagram.ScopeValueDefaults.Public} + */ + scope?: string; + } + + export interface NodesClassMethod { + + /** Sets the visibility of the method. + * @Default {ej.datavisualization.Diagram.ScopeValueDefaults.Public} + */ + scope?: string; + } + + export interface NodesClass { + + /** Sets the name of class. + */ + name?: string; + + /** Defines the collection of attributes + * @Default {[]} + */ + attributes?: NodesClassAttribute[]; + + /** Defines the collection of methods of a Class. + * @Default {[]} + */ + methods?: NodesClassMethod[]; + } + + export interface NodesCollapseIcon { + + /** Sets the border color for collapse icon of node + * @Default {black} + */ + borderColor?: string; + + /** Sets the border width for collapse icon of node + * @Default {1} + */ + borderWidth?: number; + + /** Sets the fill color for collapse icon of node + * @Default {white} + */ + fillColor?: string; + + /** Defines the height for collapse icon of node + * @Default {15} + */ + height?: number; + + /** Sets the horizontal alignment of the icon. + * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Center} + */ + horizontalAlignment?: ej.datavisualization.Diagram.HorizontalAlignment | string; + + /** To set the margin for the collapse icon of node + * @Default {ej.datavisualization.Diagram.Margin()} + */ + margin?: any; + + /** Sets the fraction/ratio(relative to node) that defines the position of the icon + * @Default {ej.datavisualization.Diagram.Point(0.5, 1)} + */ + offset?: any; + + /** Defines the shape of the collapsed state of the node. + * @Default {ej.datavisualization.Diagram.IconShapes.None} + */ + shape?: ej.datavisualization.Diagram.IconShapes | string; + + /** Sets the vertical alignment of the icon. + * @Default {ej.datavisualization.Diagram.VerticalAlignment.Center} + */ + verticalAlignment?: ej.datavisualization.Diagram.VerticalAlignment | string; + } + + export interface NodesContainer { + + /** Defines the orientation of the container. Applicable, if the group is a container. + * @Default {vertical} + */ + orientation?: string; + + /** Sets the type of the container. Applicable if the group is a container. + * @Default {ej.datavisualization.Diagram.ContainerType.Canvas} + */ + type?: ej.datavisualization.Diagram.ContainerType | string; + } + + export interface NodesData { + + /** Sets the type of the BPMN Data object + * @Default {ej.datavisualization.Diagram.BPMNDataObjects.None} + */ + type?: ej.datavisualization.Diagram.BPMNDataObjects | string; + + /** Defines whether the BPMN data object is a collection or not + * @Default {false} + */ + collection?: boolean; + } + + export interface NodesEnumerationMember { + + /** Sets the name of the enumeration member + */ + name?: string; + } + + export interface NodesEnumeration { + + /** Sets the name of the Enumeration + */ + name?: string; + + /** Defines the collection of enumeration members + * @Default {[]} + */ + members?: NodesEnumerationMember[]; + } + + export interface NodesExpandIcon { + + /** Sets the border color for expand icon of node + * @Default {black} + */ + borderColor?: string; + + /** Sets the border width for expand icon of node + * @Default {1} + */ + borderWidth?: number; + + /** Sets the fill color for expand icon of node + * @Default {white} + */ + fillColor?: string; + + /** Defines the height for expand icon of node + * @Default {15} + */ + height?: number; + + /** Sets the horizontal alignment of the icon. + * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Center} + */ + horizontalAlignment?: ej.datavisualization.Diagram.HorizontalAlignment | string; + + /** To set the margin for the expand icon of node + * @Default {ej.datavisualization.Diagram.Margin()} + */ + margin?: any; + + /** Sets the fraction/ratio(relative to node) that defines the position of the icon + * @Default {ej.datavisualization.Diagram.Point(0.5, 1)} + */ + offset?: any; + + /** Defines the shape of the expanded state of the node. + * @Default {ej.datavisualization.Diagram.IconShapes.None} + */ + shape?: ej.datavisualization.Diagram.IconShapes | string; + + /** Sets the vertical alignment of the icon. + * @Default {ej.datavisualization.Diagram.VerticalAlignment.Center} + */ + verticalAlignment?: ej.datavisualization.Diagram.VerticalAlignment | string; + } + + export interface NodesGradientLinearGradient { + + /** Defines the different colors and the region of color transitions + * @Default {[]} + */ + stops?: any[]; + + /** Defines the left most position(relative to node) of the rectangular region that needs to be painted + * @Default {0} + */ + x1?: number; + + /** Defines the right most position(relative to node) of the rectangular region that needs to be painted + * @Default {0} + */ + x2?: number; + + /** Defines the top most position(relative to node) of the rectangular region that needs to be painted + * @Default {0} + */ + y1?: number; + + /** Defines the bottom most position(relative to node) of the rectangular region that needs to be painted + * @Default {0} + */ + y2?: number; + } + + export interface NodesGradientRadialGradient { + + /** Defines the position of the outermost circle + * @Default {0} + */ + cx?: number; + + /** Defines the outer most circle of the radial gradient + * @Default {0} + */ + cy?: number; + + /** Defines the innermost circle of the radial gradient + * @Default {0} + */ + fx?: number; + + /** Defines the innermost circle of the radial gradient + * @Default {0} + */ + fy?: number; + + /** Defines the different colors and the region of color transitions. + * @Default {[]} + */ + stops?: any[]; + } + + export interface NodesGradientStop { + + /** Sets the color to be filled over the specified region + */ + color?: string; + + /** Sets the position where the previous color transition ends and a new color transition starts + * @Default {0} + */ + offset?: number; + + /** Describes the transparency level of the region + * @Default {1} + */ + opacity?: number; + } + + export interface NodesGradient { + + /** Paints the node with linear color transitions + */ + LinearGradient?: NodesGradientLinearGradient; + + /** Paints the node with radial color transitions. A focal point defines the beginning of the gradient, and a circle defines the end point of the gradient. + */ + RadialGradient?: NodesGradientRadialGradient; + + /** Defines the color and a position where the previous color transition ends and a new color transition starts + */ + Stop?: NodesGradientStop; + } + + export interface NodesInterfaceAttribute { + + /** Sets the name of the attribute + */ + name?: string; + + /** Sets the type of the attribute + */ + type?: string; + + /** Sets the visibility of the attribute + */ + scope?: string; + } + + export interface NodesInterfaceMethod { + + /** Sets the visibility of the method + */ + scope?: string; + } + + export interface NodesInterface { + + /** Sets the name of the interface + */ + name?: string; + + /** Defines a collection of attributes of the interface + * @Default {[]} + */ + attributes?: NodesInterfaceAttribute[]; + + /** Defines the collection of public methods of an interface + * @Default {[]} + */ + methods?: NodesInterfaceMethod[]; + } + + export interface NodesLabel { + + /** Enables/disables the bold style + * @Default {false} + */ + bold?: boolean; + + /** Sets the border color of the label + * @Default {transparent} + */ + borderColor?: string; + + /** Sets the border width of the label + * @Default {0} + */ + borderWidth?: number; + + /** Sets the fill color of the text area + * @Default {transparent} + */ + fillColor?: string; + + /** Sets the font color of the text + * @Default {black} + */ + fontColor?: string; + + /** Sets the font family of the text + * @Default {Arial} + */ + fontFamily?: string; + + /** Defines the font size of the text + * @Default {12} + */ + fontSize?: number; + + /** Sets the horizontal alignment of the label. + * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Center} + */ + horizontalAlignment?: ej.datavisualization.Diagram.HorizontalAlignment | string; + + /** Enables/disables the italic style + * @Default {false} + */ + italic?: boolean; + + /** To set the margin of the label + * @Default {ej.datavisualization.Diagram.Margin()} + */ + margin?: any; + + /** Gets whether the label is currently being edited or not. + * @Default {ej.datavisualization.Diagram.LabelEditMode.Edit} + */ + mode?: ej.datavisualization.Diagram.LabelEditMode | string; + + /** Sets the unique identifier of the label + */ + name?: string; + + /** Sets the fraction/ratio(relative to node) that defines the position of the label + * @Default {ej.datavisualization.Diagram.Point(0.5, 0.5)} + */ + offset?: any; + + /** Defines the transparency of the labels + * @Default {1} + */ + opacity?: number; + + /** Sets the overflowType of the labels + * @Default {ej.datavisualization.Diagram.OverflowType.Ellipsis} + */ + overflowType?: ej.datavisualization.Diagram.OverflowType | string; + + /** Defines whether the label is editable or not + * @Default {false} + */ + readOnly?: boolean; + + /** Defines the angle to which the label needs to be rotated + * @Default {0} + */ + rotateAngle?: number; + + /** Defines the label text + */ + text?: string; + + /** Defines how to align the text inside the label. + * @Default {ej.datavisualization.Diagram.TextAlign.Center} + */ + textAlign?: ej.datavisualization.Diagram.TextAlign | string; + + /** Sets how to decorate the label text. + * @Default {ej.datavisualization.Diagram.TextDecorations.None} + */ + textDecoration?: ej.datavisualization.Diagram.TextDecorations | string; + + /** Defines the overflowed content is displayed or not. + * @Default {false} + */ + textOverflow?: boolean; + + /** Sets the vertical alignment of the label. + * @Default {ej.datavisualization.Diagram.VerticalAlignment.Center} + */ + verticalAlignment?: ej.datavisualization.Diagram.VerticalAlignment | string; + + /** Enables or disables the visibility of the label + * @Default {true} + */ + visible?: boolean; + + /** Sets the width of the label(the maximum value of label width and the node width will be considered as label width) + * @Default {50} + */ + width?: number; + + /** Defines how the label text needs to be wrapped. + * @Default {ej.datavisualization.Diagram.TextWrapping.WrapWithOverflow} + */ + wrapping?: ej.datavisualization.Diagram.TextWrapping | string; + } + + export interface NodesLane { + + /** Defines the width of lane + * @Default {0} + */ + width?: number; + + /** Defines the height of lane + * @Default {0} + */ + height?: number; + + /** Defines the z-index of the lane + * @Default {0} + */ + zorder?: number; + + /** Allows to maintain additional information about lane + * @Default {{}} + */ + addInfo?: any; + + /** An array of objects where each object represents a child node of the lane + * @Default {[]} + */ + children?: any[]; + + /** Defines the fill color of the lane + * @Default {white} + */ + fillColor?: string; + + /** Defines the header of the lane + * @Default {{ text: Function, fontSize: 11 }} + */ + header?: any; + + /** Defines the object as a lane + * @Default {false} + */ + isLane?: boolean; + + /** Sets the unique identifier of the lane + */ + name?: string; + + /** Sets the orientation of the lane. + * @Default {vertical} + */ + orientation?: string; + } + + export interface NodesPaletteItem { + + /** Defines whether the symbol should be drawn at its actual size regardless of precedence factors or not + * @Default {true} + */ + enableScale?: boolean; + + /** Defines the height of the symbol + * @Default {0} + */ + height?: number; + + /** Defines the margin of the symbol item + * @Default {{ left: 4, right: 4, top: 4, bottom: 4 }} + */ + margin?: any; + + /** Defines the preview height of the symbol + * @Default {undefined} + */ + previewHeight?: number; + + /** Defines the preview width of the symbol + * @Default {undefined} + */ + previewWidth?: number; + + /** Defines the width of the symbol + * @Default {0} + */ + width?: number; + } + + export interface NodesPhase { + + /** Defines the header of the smaller regions + * @Default {null} + */ + label?: any; + + /** Defines the line color of the splitter that splits adjacent phases. + * @Default {#606060} + */ + lineColor?: string; + + /** Sets the dash array that used to stroke the phase splitter + * @Default {3,3} + */ + lineDashArray?: string; + + /** Sets the lineWidth of the phase + * @Default {1} + */ + lineWidth?: number; + + /** Sets the unique identifier of the phase + */ + name?: string; + + /** Sets the length of the smaller region(phase) of a swimlane + * @Default {100} + */ + offset?: number; + + /** Sets the orientation of the phase + * @Default {horizontal} + */ + orientation?: string; + + /** Sets the type of the object as phase + * @Default {phase} + */ + type?: string; + } + + export interface NodesPort { + + /** Sets the border color of the port + * @Default {#1a1a1a} + */ + borderColor?: string; + + /** Sets the stroke width of the port + * @Default {1} + */ + borderWidth?: number; + + /** Defines the space to be left between the port bounds and its incoming and outgoing connections. + * @Default {0} + */ + connectorPadding?: number; + + /** Defines whether connections can be created with the port + * @Default {ej.datavisualization.Diagram.PortConstraints.Connect} + */ + constraints?: ej.datavisualization.Diagram.PortConstraints | string; + + /** Sets the fill color of the port + * @Default {white} + */ + fillColor?: string; + + /** Sets the unique identifier of the port + */ + name?: string; + + /** Defines the position of the port as fraction/ ratio relative to node + * @Default {ej.datavisualization.Diagram.Point(0, 0)} + */ + offset?: any; + + /** Defines the path data to draw the port. Applicable, if the port shape is path. + */ + pathData?: string; + + /** Defines the shape of the port. + * @Default {ej.datavisualization.Diagram.PortShapes.Square} + */ + shape?: ej.datavisualization.Diagram.PortShapes | string; + + /** Defines the size of the port + * @Default {8} + */ + size?: number; + + /** Defines when the port should be visible. + * @Default {ej.datavisualization.Diagram.PortVisibility.Default} + */ + visibility?: ej.datavisualization.Diagram.PortVisibility | string; + } + + export interface NodesShadow { + + /** Defines the angle of the shadow relative to node + * @Default {45} + */ + angle?: number; + + /** Sets the distance to move the shadow relative to node + * @Default {5} + */ + distance?: number; + + /** Defines the opaque of the shadow + * @Default {0.7} + */ + opacity?: number; + } + + export interface NodesSubProcess { + + /** Defines whether the BPMN sub process is without any prescribed order or not + * @Default {false} + */ + adhoc?: boolean; + + /** Sets the boundary of the BPMN process + * @Default {ej.datavisualization.Diagram.BPMNBoundary.Default} + */ + boundary?: ej.datavisualization.Diagram.BPMNBoundary | string; + + /** Sets whether the BPMN subprocess is triggered as a compensation of a specific activity + * @Default {false} + */ + compensation?: boolean; + + /** Sets whether the BPMN subprocess is triggered as a collapsed of a specific activity + * @Default {true} + */ + collapsed?: boolean; + + /** Sets the type of the event by which the sub-process will be triggered + * @Default {ej.datavisualization.Diagram.BPMNEvents.Start} + */ + event?: ej.datavisualization.Diagram.BPMNEvents | string; + + /** Defines the collection of events that need to be appended with BPMN Sub-Process + */ + events?: any[]; + + /** Defines the loop type of a sub process. + * @Default {ej.datavisualization.Diagram.BPMNLoops.None} + */ + loop?: ej.datavisualization.Diagram.BPMNLoops | string; + + /** Defines the children for BPMN's SubProcess + * @Default {[]} + */ + Processes?: any[]; + + /** Defines the type of the event trigger + * @Default {ej.datavisualization.Diagram.BPMNTriggers.Message} + */ + trigger?: ej.datavisualization.Diagram.BPMNTriggers | string; + + /** Defines the type of a sub process + * @Default {ej.datavisualization.Diagram.BPMNSubProcessTypes.None} + */ + type?: ej.datavisualization.Diagram.BPMNSubProcessTypes | string; + } + + export interface NodesTask { + + /** To set whether the task is a global task or not + * @Default {false} + */ + call?: boolean; + + /** Sets whether the task is triggered as a compensation of another specific activity + * @Default {false} + */ + compensation?: boolean; + + /** Sets the loop type of a BPMN task. + * @Default {ej.datavisualization.Diagram.BPMNLoops.None} + */ + loop?: ej.datavisualization.Diagram.BPMNLoops | string; + + /** Sets the type of the BPMN task. + * @Default {ej.datavisualization.Diagram.BPMNTasks.None} + */ + type?: ej.datavisualization.Diagram.BPMNTasks | string; + } + + export interface Node { + + /** Defines the type of BPMN Activity. Applicable, if the node is a BPMN activity. + * @Default {ej.datavisualization.Diagram.BPMNActivity.Task} + */ + activity?: ej.datavisualization.Diagram.BPMNActivity | string; + + /** To maintain additional information about nodes + * @Default {{}} + */ + addInfo?: any; + + /** Defines the additional information of a process. It is not directly related to the message flows or sequence flows of the process. + * @Default {ej.datavisualization.Diagram.BPMNTextAnnotation()} + */ + annotation?: NodesAnnotation; + + /** Sets the border color of node + * @Default {black} + */ + borderColor?: string; + + /** Sets the pattern of dashes and gaps to stroke the border + */ + borderDashArray?: string; + + /** Sets the border width of the node + * @Default {1} + */ + borderWidth?: number; + + /** Defines whether the group can be ungrouped or not + * @Default {true} + */ + canUngroup?: boolean; + + /** Array of JSON objects where each object represents a child node/connector + * @Default {[]} + */ + children?: any[]; + + /** Sets the type of UML classifier. Applicable, if the node is a UML Class Diagram shape. + * @Default {ej.datavisualization.Diagram.ClassifierShapes.Class} + */ + classifier?: ej.datavisualization.Diagram.ClassifierShapes | string; + + /** Defines the name, attributes and methods of a Class. Applicable, if the node is a Class. + * @Default {null} + */ + class?: NodesClass; + + /** Defines the state of the node is collapsed. + */ + collapseIcon?: NodesCollapseIcon; + + /** Defines the distance to be left between a node and its connections(In coming and out going connections). + * @Default {0} + */ + connectorPadding?: number; + + /** Enables or disables the default behaviors of the node. + * @Default {ej.datavisualization.Diagram.NodeConstraints.Default} + */ + constraints?: ej.datavisualization.Diagram.NodeConstraints | string; + + /** Defines how the child objects need to be arranged(Either in any predefined manner or automatically). Applicable, if the node is a group. + * @Default {null} + */ + container?: NodesContainer; + + /** Defines the corner radius of rectangular shapes. + * @Default {0} + */ + cornerRadius?: number; + + /** Configures the styles of shapes + */ + cssClass?: string; + + /** Defines the BPMN data object + */ + data?: NodesData; + + /** Defines an Enumeration in a UML Class Diagram + * @Default {null} + */ + enumeration?: NodesEnumeration; + + /** Sets the type of the BPMN Events. Applicable, if the node is a BPMN event. + * @Default {ej.datavisualization.Diagram.BPMNEvents.Start} + */ + event?: ej.datavisualization.Diagram.BPMNEvents | string; + + /** Defines whether the node can be automatically arranged using layout or not + * @Default {false} + */ + excludeFromLayout?: boolean; + + /** Defines the state of the node is expanded or collapsed. + */ + expandIcon?: NodesExpandIcon; + + /** Defines the fill color of the node + * @Default {white} + */ + fillColor?: string; + + /** Sets the type of the BPMN Gateway. Applicable, if the node is a BPMN gateway. + * @Default {ej.datavisualization.Diagram.BPMNGateways.None} + */ + gateway?: ej.datavisualization.Diagram.BPMNGateways | string; + + /** Paints the node with a smooth transition from one color to another color + */ + gradient?: NodesGradient; + + /** Sets the type of the BPMN Shapes as group. Applicable, if the node is a BPMN. + * @Default {ej.datavisualization.Diagram.BPMNShapes} + */ + group?: any; + + /** Defines the header of a swimlane/lane + * @Default {{ text: Title, fontSize: 11 }} + */ + header?: any; + + /** Defines the height of the node + * @Default {0} + */ + height?: number; + + /** Sets the horizontal alignment of the node. Applicable, if the parent of the node is a container. + * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Left} + */ + horizontalAlign?: ej.datavisualization.Diagram.HorizontalAlignment | string; + + /** A read only collection of the incoming connectors/edges of the node + * @Default {[]} + */ + inEdges?: any[]; + + /** Defines an interface in a UML Class Diagram + * @Default {null} + */ + interface?: NodesInterface; + + /** Defines whether the sub tree of the node is expanded or collapsed + * @Default {true} + */ + isExpanded?: boolean; + + /** Sets the node as a swimlane + * @Default {false} + */ + isSwimlane?: boolean; + + /** A collection of objects where each object represents a label + * @Default {[]} + */ + labels?: NodesLabel[]; + + /** An array of objects where each object represents a lane. Applicable, if the node is a swimlane. + * @Default {[]} + */ + lanes?: NodesLane[]; + + /** Defines the minimum space to be left between the bottom of parent bounds and the node. Applicable, if the parent is a container. + * @Default {0} + */ + marginBottom?: number; + + /** Defines the minimum space to be left between the left of parent bounds and the node. Applicable, if the parent is a container. + * @Default {0} + */ + marginLeft?: number; + + /** Defines the minimum space to be left between the right of the parent bounds and the node. Applicable, if the parent is a container. + * @Default {0} + */ + marginRight?: number; + + /** Defines the minimum space to be left between the top of parent bounds and the node. Applicable, if the parent is a container. + * @Default {0} + */ + marginTop?: number; + + /** Defines the maximum height limit of the node + * @Default {0} + */ + maxHeight?: number; + + /** Defines the maximum width limit of the node + * @Default {0} + */ + maxWidth?: number; + + /** Defines the minimum height limit of the node + * @Default {0} + */ + minHeight?: number; + + /** Defines the minimum width limit of the node + * @Default {0} + */ + minWidth?: number; + + /** Sets the unique identifier of the node + */ + name?: string; + + /** Defines the position of the node on X-Axis + * @Default {0} + */ + offsetX?: number; + + /** Defines the position of the node on Y-Axis + * @Default {0} + */ + offsetY?: number; + + /** Defines the opaque of the node + * @Default {1} + */ + opacity?: number; + + /** Defines the orientation of nodes. Applicable, if the node is a swimlane. + * @Default {vertical} + */ + orientation?: string; + + /** A read only collection of outgoing connectors/edges of the node + * @Default {[]} + */ + outEdges?: any[]; + + /** Defines the minimum padding value to be left between the bottom most position of a group and its children. Applicable, if the group is a container. + * @Default {0} + */ + paddingBottom?: number; + + /** Defines the minimum padding value to be left between the left most position of a group and its children. Applicable, if the group is a container. + * @Default {0} + */ + paddingLeft?: number; + + /** Defines the minimum padding value to be left between the right most position of a group and its children. Applicable, if the group is a container. + * @Default {0} + */ + paddingRight?: number; + + /** Defines the minimum padding value to be left between the top most position of a group and its children. Applicable, if the group is a container. + * @Default {0} + */ + paddingTop?: number; + + /** Defines the size and preview size of the node to add that to symbol palette + * @Default {null} + */ + paletteItem?: NodesPaletteItem; + + /** Sets the name of the parent group + */ + parent?: string; + + /** Sets the path geometry that defines the shape of a path node + */ + pathData?: string; + + /** An array of objects, where each object represents a smaller region(phase) of a swimlane. + * @Default {[]} + */ + phases?: NodesPhase[]; + + /** Sets the height of the phase headers + * @Default {0} + */ + phaseSize?: number; + + /** Sets the ratio/ fractional value relative to node, based on which the node will be transformed(positioning, scaling and rotation) + * @Default {ej.datavisualization.Diagram.Points(0.5,0.5)} + */ + pivot?: any; + + /** Defines a collection of points to draw a polygon. Applicable, if the shape is a polygon. + * @Default {[]} + */ + points?: any[]; + + /** An array of objects where each object represents a port + * @Default {[]} + */ + ports?: NodesPort[]; + + /** Sets the angle to which the node should be rotated + * @Default {0} + */ + rotateAngle?: number; + + /** Defines the opacity and the position of shadow + * @Default {ej.datavisualization.Diagram.Shadow()} + */ + shadow?: NodesShadow; + + /** Sets the shape of the node. It depends upon the type of node. + * @Default {ej.datavisualization.Diagram.BasicShapes.Rectangle} + */ + shape?: ej.datavisualization.Diagram.BasicShapes | ej.datavisualization.Diagram.FlowShapes | ej.datavisualization.Diagram.BPMNShapes | ej.datavisualization.Diagram.UMLActivityShapes | string; + + /** Sets the source path of the image. Applicable, if the type of the node is image. + */ + source?: string; + + /** Defines the sub process of a BPMN Activity. Applicable, if the type of the BPMN activity is sub process. + * @Default {ej.datavisualization.Diagram.BPMNSubProcess()} + */ + subProcess?: NodesSubProcess; + + /** Defines the task of the BPMN activity. Applicable, if the type of activity is set as task. + * @Default {ej.datavisualization.Diagram.BPMNTask()} + */ + task?: NodesTask; + + /** Sets the id of svg/html templates. Applicable, if the node is HTML or native. + */ + templateId?: string; + + /** Defines the textBlock of a text node + * @Default {null} + */ + textBlock?: any; + + /** Defines the tooltip that should be shown when the mouse hovers over node. For tooltip properties, refer Tooltip + * @Default {null} + */ + tooltip?: any; + + /** Sets the type of BPMN Event Triggers. + * @Default {ej.datavisualization.Diagram.BPMNTriggers.None} + */ + trigger?: ej.datavisualization.Diagram.BPMNTriggers | string; + + /** Defines the type of the node. + * @Default {ej.datavisualization.Diagram.Shapes.Basic} + */ + type?: ej.datavisualization.Diagram.Shapes | string; + + /** Sets the vertical alignment of a node. Applicable, if the parent of a node is a container. + * @Default {ej.datavisualization.Diagram.VerticalAlignment.Top} + */ + verticalAlign?: ej.datavisualization.Diagram.VerticalAlignment | string; + + /** Defines the visibility of the node + * @Default {true} + */ + visible?: boolean; + + /** Defines the width of the node + * @Default {0} + */ + width?: number; + + /** Defines the z-index of the node + * @Default {0} + */ + zOrder?: number; + } + + export interface PageSettings { + + /** Defines the maximum distance to be left between the object and the scroll bar to trigger auto scrolling + * @Default {{ left: 15, top: 15, right: 15, bottom: 15 }} + */ + autoScrollBorder?: any; + + /** Sets whether multiple pages can be created to fit all nodes and connectors + * @Default {false} + */ + multiplePage?: boolean; + + /** Defines the background color of diagram pages + * @Default {#ffffff} + */ + pageBackgroundColor?: string; + + /** Defines the page border color + * @Default {#565656} + */ + pageBorderColor?: string; + + /** Sets the border width of diagram pages + * @Default {0} + */ + pageBorderWidth?: number; + + /** Defines the height of a page + * @Default {null} + */ + pageHeight?: number; + + /** Defines the page margin + * @Default {24} + */ + pageMargin?: number; + + /** Sets the orientation of the page. + * @Default {ej.datavisualization.Diagram.PageOrientations.Portrait} + */ + pageOrientation?: ej.datavisualization.Diagram.PageOrientations | string; + + /** Defines the height of a diagram page + * @Default {null} + */ + pageWidth?: number; + + /** Defines the scrollable area of diagram. Applicable, if the scroll limit is "limited". + * @Default {null} + */ + scrollableArea?: any; + + /** Defines the scrollable region of diagram. + * @Default {ej.datavisualization.Diagram.ScrollLimit.Infinite} + */ + scrollLimit?: ej.datavisualization.Diagram.ScrollLimit | string; + + /** Defines the draggable region of diagram elements. + * @Default {ej.datavisualization.Diagram.BoundaryConstraints.Infinite} + */ + boundaryConstraints?: ej.datavisualization.Diagram.BoundaryConstraints | string; + + /** Enables or disables the page breaks + * @Default {false} + */ + showPageBreak?: boolean; + } + + export interface ScrollSettings { + + /** Allows to read the zoom value of diagram + * @Default {0} + */ + currentZoom?: number; + + /** Sets the horizontal scroll offset + * @Default {0} + */ + horizontalOffset?: number; + + /** Allows to extend the scrollable region that is based on the scroll limit + * @Default {{left: 0, right: 0, top:0, bottom: 0}} + */ + padding?: any; + + /** Sets the vertical scroll offset + * @Default {0} + */ + verticalOffset?: number; + + /** Allows to read the view port height of the diagram + * @Default {0} + */ + viewPortHeight?: number; + + /** Allows to read the view port width of the diagram + * @Default {0} + */ + viewPortWidth?: number; + } + + export interface SelectedItemsUserHandle { + + /** Defines the background color of the user handle + * @Default {#2382c3} + */ + backgroundColor?: string; + + /** Sets the border color of the user handle + * @Default {transparent} + */ + borderColor?: string; + + /** Defines whether the user handle should be added, when more than one element is selected + * @Default {false} + */ + enableMultiSelection?: boolean; + + /** Sets the stroke color of the user handle + * @Default {transparent} + */ + pathColor?: string; + + /** Defines the custom shape of the user handle + */ + pathData?: string; + + /** Defines the position of the user handle + * @Default {ej.datavisualization.Diagram.UserHandlePositions.BottomCenter} + */ + position?: ej.datavisualization.Diagram.UserHandlePositions | string; + + /** Defines the size of the user handle + * @Default {8} + */ + size?: number; + + /** Defines the interactive behaviors of the user handle + */ + tool?: any; + + /** Defines the visibility of the user handle + * @Default {true} + */ + visible?: boolean; + } + + export interface SelectedItems { + + /** A read only collection of the selected items + * @Default {[]} + */ + children?: any[]; + + /** Controls the visibility of selector. + * @Default {ej.datavisualization.Diagram.SelectorConstraints.All} + */ + constraints?: ej.datavisualization.Diagram.SelectorConstraints | string; + + /** Defines a method that dynamically enables/ disables the interaction with multiple selection. + * @Default {null} + */ + getConstraints?: any; + + /** Sets the height of the selected items + * @Default {0} + */ + height?: number; + + /** Sets the x position of the selector + * @Default {0} + */ + offsetX?: number; + + /** Sets the y position of the selector + * @Default {0} + */ + offsetY?: number; + + /** Sets the angle to rotate the selected items + * @Default {0} + */ + rotateAngle?: number; + + /** Sets the angle to rotate the selected items. For tooltip properties, refer Tooltip + * @Default {ej.datavisualization.Diagram.Tooltip()} + */ + tooltip?: any; + + /** A collection of frequently used commands that will be added around the selector + * @Default {[]} + */ + userHandles?: SelectedItemsUserHandle[]; + + /** Sets the width of the selected items + * @Default {0} + */ + width?: number; + } + + export interface SnapSettingsHorizontalGridLines { + + /** Defines the line color of horizontal grid lines + * @Default {lightgray} + */ + lineColor?: string; + + /** Specifies the pattern of dashes and gaps used to stroke horizontal grid lines + */ + lineDashArray?: string; + + /** A pattern of lines and gaps that defines a set of horizontal gridlines + * @Default {[1.25, 18.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75]} + */ + linesInterval?: any[]; + + /** Specifies a set of intervals to snap the objects + * @Default {[20]} + */ + snapInterval?: any[]; + } + + export interface SnapSettingsVerticalGridLines { + + /** Defines the line color of horizontal grid lines + * @Default {lightgray} + */ + lineColor?: string; + + /** Specifies the pattern of dashes and gaps used to stroke horizontal grid lines + */ + lineDashArray?: string; + + /** A pattern of lines and gaps that defines a set of horizontal gridlines + * @Default {[1.25, 18.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75]} + */ + linesInterval?: any[]; + + /** Specifies a set of intervals to snap the objects + * @Default {[20]} + */ + snapInterval?: any[]; + } + + export interface SnapSettings { + + /** Enables or disables snapping nodes/connectors to objects + * @Default {true} + */ + enableSnapToObject?: boolean; + + /** Defines the appearance of horizontal gridlines + */ + horizontalGridLines?: SnapSettingsHorizontalGridLines; + + /** Defines the angle by which the object needs to be snapped + * @Default {5} + */ + snapAngle?: number; + + /** Defines and sets the snapConstraints + */ + snapConstraints?: ej.datavisualization.Diagram.SnapConstraints | string; + + /** Defines the minimum distance between the selected object and the nearest object + * @Default {5} + */ + snapObjectDistance?: number; + + /** Defines the appearance of horizontal gridlines + */ + verticalGridLines?: SnapSettingsVerticalGridLines; + } + + export interface TooltipAlignment { + + /** Defines the horizontal alignment of tooltip. + * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Center} + */ + horizontal?: ej.datavisualization.Diagram.HorizontalAlignment | string; + + /** Defines the vertical alignment of tooltip. + * @Default {ej.datavisualization.Diagram.VerticalAlignment.Bottom} + */ + vertical?: ej.datavisualization.Diagram.VerticalAlignment | string; + } + + export interface Tooltip { + + /** Aligns the tooltip around nodes/connectors + */ + alignment?: TooltipAlignment; + + /** Sets the margin of the tooltip + * @Default {{ left: 5, right: 5, top: 5, bottom: 5 }} + */ + margin?: any; + + /** Defines whether the tooltip should be shown at the mouse position or around node. + * @Default {ej.datavisualization.Diagram.RelativeMode.Object} + */ + relativeMode?: ej.datavisualization.Diagram.RelativeMode | string; + + /** Sets the svg/html template to be bound with tooltip + */ + templateId?: string; + } + } + namespace Diagram { + enum ImageAlignment { + //Scales the graphic content non-uniformly to the width and height of the diagram area + None, + //Used to align the image at the top left of diagram area + XMinYMin, + //Used to align the image at the left center of diagram area + XMinYMid, + //Used to align the image at the bottom left of diagram area + XMinYMax, + //Used to align the image at the top center of diagram area + XMidYMin, + //Used to align the image at the center of diagram area + XMidYMid, + //Used to align the image at the bottom center of diagram area + XMidYMax, + //Used to align the image at the top right of diagram area/node + XMaxYMin, + //Used to align the image at the right center of diagram area/node + XMaxYMid, + //Used to align the image at the bottom right of diagram area/node + XMaxYMax, + } + } + namespace Diagram { + enum BridgeDirection { + //Used to set the direction of line bridges as left + Left, + //Used to set the direction of line bridges as right + Right, + //Used to set the direction of line bridges as top + Top, + //Used to set the direction of line bridges as bottom + Bottom, + } + } + namespace Diagram { + enum Keys { + //No key pressed. + None, + //The A key. + A, + //The B key. + B, + //The C key. + C, + //The D Key. + D, + //The E key. + E, + //The F key. + F, + //The G key. + G, + //The H Key. + H, + //The I key. + I, + //The J key. + J, + //The K key. + K, + //The L Key. + L, + //The M key. + M, + //The N key. + N, + //The O key. + O, + //The P Key. + P, + //The Q key. + Q, + //The R key. + R, + //The S key. + S, + //The T Key. + T, + //The U key. + U, + //The V key. + V, + //The W key. + W, + //The X key. + X, + //The Y key. + Y, + //The Z key. + Z, + //The 0 key. + Number0, + //The 1 key. + Number1, + //The 2 key. + Number2, + //The 3 key. + Number3, + //The 4 key. + Number4, + //The 5 key. + Number5, + //The 6 key. + Number6, + //The 7 key. + Number7, + //The 8 key. + Number8, + //The 9 key. + Number9, + //The LEFT ARROW key. + Left, + //The UP ARROW key. + Up, + //The RIGHT ARROW key. + Right, + //The DOWN ARROW key. + Down, + //The ESC key. + Escape, + //The DEL key. + Delete, + //The TAB key. + Tab, + //The ENTER key. + Enter, + } + } + namespace Diagram { + enum KeyModifiers { + //No modifiers are pressed. + None, + //The ALT key. + Alt, + //The CTRL key. + Control, + //The SHIFT key. + Shift, + } + } + namespace Diagram { + enum ConnectorConstraints { + //Disable all connector Constraints + None, + //Enables connector to be selected + Select, + //Enables connector to be Deleted + Delete, + //Enables connector to be Dragged + Drag, + //Enables connectors source end to be selected + DragSourceEnd, + //Enables connectors target end to be selected + DragTargetEnd, + //Enables control point and end point of every segment in a connector for editing + DragSegmentThumb, + //Enables bridging to the connector + Bridging, + //Enables label of node to be Dragged + DragLabel, + //Enables bridging to the connector + InheritBridging, + //Enables user interaction to the connector + PointerEvents, + //Enables the contrast between clean edges of connector over rendering speed and geometric precision + CrispEdges, + //Enables all constraints + Default, + } + } + namespace Diagram { + enum HorizontalAlignment { + //Used to align text horizontally on left side of node/connector + Left, + //Used to align text horizontally on center of node/connector + Center, + //Used to align text horizontally on right side of node/connector + Right, + } + } + namespace Diagram { + enum Alignment { + //Used to align the label either top or left(before) of the connector segment + Before, + //Used to align the label at center of the connector segment + Center, + //Used to align the label either bottom or right(after) of the connector segment + After, + } + } + namespace Diagram { + enum LabelRelativeMode { + //Sets the relativeMode as SegmentPath + SegmentPath, + //Sets the relativeMode as SegmentBounds + SegmentBounds, + } + } + namespace Diagram { + enum Segments { + //Used to specify the lines as Straight + Straight, + //Used to specify the lines as Orthogonal + Orthogonal, + //Used to specify the lines as Bezier + Bezier, + } + } + namespace Diagram { + enum ConnectorShapes { + //Used to specify connector type as BPMN + BPMN, + //Used to specify connector type as UMLClassifier + UMLClassifier, + //Used to specify connector type as UMLActivity + UMLActivity, + } + } + namespace Diagram { + enum BPMNFlows { + //Used to specify the Sequence flow in a BPMN Process + Sequence, + //Used to specify the Association flow in a BPMN Process + Association, + //Used to specify the Message flow in a BPMN Process + Message, + } + } + namespace Diagram { + enum AssociationFlows { + //Used to notate default association in a BPMN Process + Default, + //Used to notate directional association in a BPMN Process + Directional, + //User to notate bi-directional association in a BPMN Process + BiDirectional, + } + } + namespace Diagram { + enum BPMNMessageFlows { + //Used to notate the default message flow in a BPMN Process + Default, + //Used to notate the instantiating message flow in a BPMN Process + InitiatingMessage, + //Used to notate the non-instantiating message flow in a BPMN Process + NonInitiatingMessage, + } + } + namespace Diagram { + enum BPMNSequenceFlows { + //Used to notate the normal sequence flow in a BPMN Process + Normal, + //Used to notate the conditional sequence flow in a BPMN Process + Conditional, + //Used to notate the default sequence flow in a BPMN Process + Default, + } + } + namespace Diagram { + enum ClassifierShapes { + //Used to define a Class + Class, + //Used to define an Interface + Interface, + //Used to define an Enumeration + Enumeration, + //Used to notate association in UML Class Diagram + Association, + //Used to notate aggregation in a UML Class Diagram + Aggregation, + //Used to notate composition in a UML Class Diagram + Composition, + //Used to notate dependency in a UML Class Diagram + Dependency, + //Used to notate inheritance in a UML Class Diagram + Inheritance, + } + } + namespace Diagram { + enum Multiplicity { + //Each entity instance is related to a single instance of another entity + OneToOne, + //An entity instance can be related to multiple instances of the other entities + OneToMany, + //Multiple instances of an entity can be related to a single instance of the other entity + ManyToOne, + //The entity instances can be related to multiple instances of each other + ManyToMany, + } + } + namespace Diagram { + enum UMLActivityFlow { + //Defines a activity flow as Object in UML Activity Diagram + Object, + //Defines a activity flow as Control in UML Activity Diagram + Control, + //Defines a activity flow as Exception in UML Activity Diagram + Exception, + } + } + namespace Diagram { + enum DecoratorShapes { + //Used to set decorator shape as none + None, + //Used to set decorator shape as Arrow + Arrow, + //Used to set decorator shape as Open Arrow + OpenArrow, + //Used to set decorator shape as Circle + Circle, + //Used to set decorator shape as Diamond + Diamond, + //Used to set decorator shape as path + Path, + } + } + namespace Diagram { + enum VerticalAlignment { + //Used to align text Vertically on left side of node/connector + Top, + //Used to align text Vertically on center of node/connector + Center, + //Used to align text Vertically on bottom of node/connector + Bottom, + } + } + namespace Diagram { + enum DiagramConstraints { + //Disables all DiagramConstraints + None, + //Enables/Disables PageEditing + PageEditable, + //Enables/Disables Bridging + Bridging, + //Enables/Disables Zooming + Zoomable, + //Enables/Disables panning on horizontal axis + PannableX, + //Enables/Disables panning on vertical axis + PannableY, + //Enables/Disables Panning + Pannable, + //Enables/Disables undo actions + Undoable, + //Enables/Disables the sharp edges + CrispEdges, + //Enables all Constraints + Default, + } + } + namespace Diagram { + enum LabelRenderingMode { + //Sets the labelRenderingMode as Html + Html, + //Sets the labelRenderingMode as Svg + Svg, + } + } + namespace Diagram { + enum LayoutOrientations { + //Used to set LayoutOrientation from top to bottom + TopToBottom, + //Used to set LayoutOrientation from bottom to top + BottomToTop, + //Used to set LayoutOrientation from left to right + LeftToRight, + //Used to set LayoutOrientation from right to left + RightToLeft, + } + } + namespace Diagram { + enum LayoutTypes { + //Used not to set any specific layout + None, + //Used to set layout type as hierarchical layout + HierarchicalTree, + //Used to set layout type as organnizational chart + OrganizationalChart, + } + } + namespace Diagram { + enum BPMNActivity { + //Used to set BPMN Activity as None + None, + //Used to set BPMN Activity as Task + Task, + //Used to set BPMN Activity as SubProcess + SubProcess, + } + } + namespace Diagram { + enum BPMNAnnotationDirection { + //Used to set the direction of BPMN Annotation as left + Left, + //Used to set the direction of BPMN Annotation as right + Right, + //Used to set the direction of BPMN Annotation as top + Top, + //Used to set the direction of BPMN Annotation as bottom + Bottom, + } + } + namespace Diagram { + enum IconShapes { + //Used to set collapse icon shape as none + None, + //Used to set collapse icon shape as Arrow(Up/Down) + Arrow, + //Used to set collapse icon shape as Plus + Plus, + //Used to set collapse icon shape as Minus + Minus, + //Used to set collapse icon shape as path + Path, + //Used to set icon shape as template + Template, + //Used to set icon shape as image + Image, + } + } + namespace Diagram { + enum NodeConstraints { + //Disable all node Constraints + None, + //Enables node to be selected + Select, + //Enables node to be Deleted + Delete, + //Enables node to be Dragged + Drag, + //Enables node to be Rotated + Rotate, + //Enables node to be connected + Connect, + //Enables node to be resize north east + ResizeNorthEast, + //Enables node to be resize east + ResizeEast, + //Enables node to be resize south east + ResizeSouthEast, + //Enables node to be resize south + ResizeSouth, + //Enables node to be resize south west + ResizeSouthWest, + //Enables node to be resize west + ResizeWest, + //Enables node to be resize north west + ResizeNorthWest, + //Enables node to be resize north + ResizeNorth, + //Enables node to be Resized + Resize, + //Enables shadow + Shadow, + //Enables label of node to be Dragged + DragLabel, + //Enables panning should be done while node dragging + AllowPan, + //Enables Proportional resize for node + AspectRatio, + //Enables the user interaction with the node + PointerEvents, + //Enables contrast between clean edges for the node over rendering speed and geometric precision + CrispEdges, + //Enables all node constraints + Default, + } + } + namespace Diagram { + enum ContainerType { + //Sets the container type as Canvas + Canvas, + //Sets the container type as Stack + Stack, + } + } + namespace Diagram { + enum BPMNDataObjects { + //Used to notate the Input type BPMN data object + Input, + //Used to notate the Output type BPMN data object + Output, + //Used to set BPMN data object type as None + None, + } + } + namespace Diagram { + enum BPMNEvents { + //Used to set BPMN Event as Start + Start, + //Used to set BPMN Event as Intermediate + Intermediate, + //Used to set BPMN Event as End + End, + //Used to set BPMN Event as NonInterruptingStart + NonInterruptingStart, + //Used to set BPMN Event as NonInterruptingIntermediate + NonInterruptingIntermediate, + //Used to set BPMN Event as ThrowingIntermediate + ThrowingIntermediate, + } + } + namespace Diagram { + enum BPMNGateways { + //Used to set BPMN Gateway as None + None, + //Used to set BPMN Gateway as Exclusive + Exclusive, + //Used to set BPMN Gateway as Inclusive + Inclusive, + //Used to set BPMN Gateway as Parallel + Parallel, + //Used to set BPMN Gateway as Complex + Complex, + //Used to set BPMN Gateway as EventBased + EventBased, + //Used to set BPMN Gateway as ExclusiveEventBased + ExclusiveEventBased, + //Used to set BPMN Gateway as ParallelEventBased + ParallelEventBased, + } + } + namespace Diagram { + enum LabelEditMode { + //Used to set label edit mode as edit + Edit, + //Used to set label edit mode as view + View, + } + } + namespace Diagram { + enum OverflowType { + //Set overflow Type as ellipsis + Ellipsis, + //Set overflow Type as Clip + Clip, + } + } + namespace Diagram { + enum TextAlign { + //Used to align text on left side of node/connector + Left, + //Used to align text on center of node/connector + Center, + //Used to align text on Right side of node/connector + Right, + } + } + namespace Diagram { + enum TextDecorations { + //Used to set text decoration of the label as Underline + Underline, + //Used to set text decoration of the label as Overline + Overline, + //Used to set text decoration of the label as LineThrough + LineThrough, + //Used to set text decoration of the label as None + None, + } + } + namespace Diagram { + enum TextWrapping { + //Disables wrapping + NoWrap, + //Enables Line-break at normal word break points + Wrap, + //Enables Line-break at normal word break points with longer word overflows + WrapWithOverflow, + } + } + namespace Diagram { + enum PortConstraints { + //Disable all constraints + None, + //Enables connections with connector + Connect, + //Enables to create the connection when mouse hover on the port. + ConnectOnDrag, + } + } + namespace Diagram { + enum PortShapes { + //Used to set port shape as X + X, + //Used to set port shape as Circle + Circle, + //Used to set port shape as Square + Square, + //Used to set port shape as Path + Path, + } + } + namespace Diagram { + enum PortVisibility { + //Set the port visibility as Visible + Visible, + //Set the port visibility as Hidden + Hidden, + //Port get visible when hover connector on node + Hover, + //Port gets visible when connect connector to node + Connect, + //Specifies the port visibility as default + Default, + } + } + namespace Diagram { + enum BasicShapes { + //Used to specify node Shape as Rectangle + Rectangle, + //Used to specify node Shape as Ellipse + Ellipse, + //Used to specify node Shape as Path + Path, + //Used to specify node Shape as Polygon + Polygon, + //Used to specify node Shape as Triangle + Triangle, + //Used to specify node Shape as Plus + Plus, + //Used to specify node Shape as Star + Star, + //Used to specify node Shape as Pentagon + Pentagon, + //Used to specify node Shape as Heptagon + Heptagon, + //Used to specify node Shape as Octagon + Octagon, + //Used to specify node Shape as Trapezoid + Trapezoid, + //Used to specify node Shape as Decagon + Decagon, + //Used to specify node Shape as RightTriangle + RightTriangle, + //Used to specify node Shape as Cylinder + Cylinder, + } + } + namespace Diagram { + enum FlowShapes { + //Used to specify node Shape as Process + Process, + //Used to specify node Shape as Decision + Decision, + //Used to specify node Shape as Document + Document, + //Used to specify node Shape as PreDefinedProcess + PreDefinedProcess, + //Used to specify node Shape as Terminator + Terminator, + //Used to specify node Shape as PaperTap + PaperTap, + //Used to specify node Shape as DirectData + DirectData, + //Used to specify node Shape as SequentialData + SequentialData, + //Used to specify node Shape as Sort + Sort, + //Used to specify node Shape as MultiDocument + MultiDocument, + //Used to specify node Shape as Collate + Collate, + //Used to specify node Shape as SummingJunction + SummingJunction, + //Used to specify node Shape as Or + Or, + //Used to specify node Shape as InternalStorage + InternalStorage, + //Used to specify node Shape as Extract + Extract, + //Used to specify node Shape as ManualOperation + ManualOperation, + //Used to specify node Shape as Merge + Merge, + //Used to specify node Shape as OffPageReference + OffPageReference, + //Used to specify node Shape as SequentialAccessStorage + SequentialAccessStorage, + //Used to specify node Shape as Annotation1 + Annotation1, + //Used to specify node Shape as Annotation2 + Annotation2, + //Used to specify node Shape as Data + Data, + //Used to specify node Shape as Card + Card, + } + } + namespace Diagram { + enum BPMNShapes { + //Used to specify node Shape as Event + Event, + //Used to specify node Shape as Gateway + Gateway, + //Used to specify node Shape as Message + Message, + //Used to specify node Shape as DataObject + DataObject, + //Used to specify node Shape as DataSource + DataSource, + //Used to specify node Shape as Activity + Activity, + //Used to specify node Shape as Group + Group, + } + } + namespace Diagram { + enum UMLActivityShapes { + //Used to set UML ActivityShapes as Action + Action, + //Used to set UML ActivityShapes as Decision + Decision, + //Used to set UML ActivityShapes as MergeNode + MergeNode, + //Used to set UML ActivityShapes as InitialNode + InitialNode, + //Used to set UML ActivityShapes as FinalNode + FinalNode, + //Used to set UML ActivityShapes as ForkNode + ForkNode, + //Used to set UML ActivityShapes as JoinNode + JoinNode, + //Used to set UML ActivityShapes as TimeEvent + TimeEvent, + //Used to set UML ActivityShapes as AcceptingEvent + AcceptingEvent, + //Used to set UML ActivityShapes as SendSignal + SendSignal, + //Used to set UML ActivityShapes as ReceiveSignal + ReceiveSignal, + //Used to set UML ActivityShapes as StructuredNode + StructuredNode, + //Used to set UML ActivityShapes as Note + Note, + } + } + namespace Diagram { + enum BPMNBoundary { + //Used to set BPMN SubProcess's Boundary as Default + Default, + //Used to set BPMN SubProcess's Boundary as Call + Call, + //Used to set BPMN SubProcess's Boundary as Event + Event, + } + } + namespace Diagram { + enum BPMNLoops { + //Used to set BPMN Activity's Loop as None + None, + //Used to set BPMN Activity's Loop as Standard + Standard, + //Used to set BPMN Activity's Loop as ParallelMultiInstance + ParallelMultiInstance, + //Used to set BPMN Activity's Loop as SequenceMultiInstance + SequenceMultiInstance, + } + } + namespace Diagram { + enum BPMNSubProcessTypes { + //Used to set BPMN SubProcess type as None + None, + //Used to set BPMN SubProcess type as Transaction + Transaction, + //Used to set BPMN SubProcess type as Event + Event, + } + } + namespace Diagram { + enum BPMNTasks { + //Used to set BPMN Task Type as None + None, + //Used to set BPMN Task Type as Service + Service, + //Used to set BPMN Task Type as Receive + Receive, + //Used to set BPMN Task Type as Send + Send, + //Used to set BPMN Task Type as InstantiatingReceive + InstantiatingReceive, + //Used to set BPMN Task Type as Manual + Manual, + //Used to set BPMN Task Type as BusinessRule + BusinessRule, + //Used to set BPMN Task Type as User + User, + //Used to set BPMN Task Type as Script + Script, + //Used to set BPMN Task Type as Parallel + Parallel, + } + } + namespace Diagram { + enum BPMNTriggers { + //Used to set Event Trigger as None + None, + //Used to set Event Trigger as Message + Message, + //Used to set Event Trigger as Timer + Timer, + //Used to set Event Trigger as Escalation + Escalation, + //Used to set Event Trigger as Link + Link, + //Used to set Event Trigger as Error + Error, + //Used to set Event Trigger as Compensation + Compensation, + //Used to set Event Trigger as Signal + Signal, + //Used to set Event Trigger as Multiple + Multiple, + //Used to set Event Trigger as Parallel + Parallel, + //Used to set Event Trigger as Conditional + Conditional, + //Used to set Event Trigger as Termination + Termination, + //Used to set Event Trigger as Cancel + Cancel, + } + } + namespace Diagram { + enum Shapes { + //Used to specify node type as Text + Text, + //Used to specify node type as Image + Image, + //Used to specify node type as Html + Html, + //Used to specify node type as Native + Native, + //Used to specify node type as Basic + Basic, + //Used to specify node type as Flow + Flow, + //Used to specify node type as BPMN + BPMN, + //Used to specify node type as UMLClassifier + UMLClassifier, + //Used to specify node type as UMLActivity + UMLActivity, + } + } + namespace Diagram { + enum PageOrientations { + //Used to set orientation as Landscape + Landscape, + //Used to set orientation as portrait + Portrait, + } + } + namespace Diagram { + enum ScrollLimit { + //Used to set scrollLimit as Infinite + Infinite, + //Used to set scrollLimit as Diagram + Diagram, + //Used to set scrollLimit as Limited + Limited, + } + } + namespace Diagram { + enum BoundaryConstraints { + //Used to set boundaryConstraints as Infinite + Infinite, + //Used to set boundaryConstraints as Diagram + Diagram, + //Used to set boundaryConstraints as Page + Page, + } + } + namespace Diagram { + enum SelectorConstraints { + //Hides the selector + None, + //Sets the visibility of rotation handle as visible + Rotator, + //Sets the visibility of resize handles as visible + Resizer, + //Sets the visibility of user handles as visible + UserHandles, + //Sets the visibility of all selection handles as visible + All, + } + } + namespace Diagram { + enum UserHandlePositions { + //Set the position of the userhandle as topleft + TopLeft, + //Set the position of the userhandle as topcenter + TopCenter, + //Set the position of the userhandle as topright + TopRight, + //Set the position of the userhandle as middleleft + MiddleLeft, + //Set the position of the userhandle as middleright + MiddleRight, + //Set the position of the userhandle as bottomleft + BottomLeft, + //Set the position of the userhandle as bottomcenter + BottomCenter, + //Set the position of the userhandle as bottom right + BottomRight, + } + } + namespace Diagram { + enum SnapConstraints { + //Enables node to be snapped to horizontal gridlines + None, + //Enables node to be snapped to vertical gridlines + SnapToHorizontalLines, + //Enables node to be snapped to horizontal gridlines + SnapToVerticalLines, + //Enables node to be snapped to gridlines + SnapToLines, + //Enable horizontal lines + ShowHorizontalLines, + //Enable vertical lines + ShowVerticalLines, + //Enable both horizontal and vertical lines + ShowLines, + //Enable all the constraints + All, + } + } + namespace Diagram { + enum Tool { + //Disables all Tools + None, + //Enables/Disables SingleSelect tool + SingleSelect, + //Enables/Disables MultiSelect tool + MultipleSelect, + //Enables/Disables ZoomPan tool + ZoomPan, + //Enables/Disables DrawOnce tool + DrawOnce, + //Enables/Disables ContinuousDraw tool + ContinuesDraw, + } + } + namespace Diagram { + enum RelativeMode { + //Shows tooltip around the node + Object, + //Shows tooltip at the mouse position + Mouse, + } + } + namespace Diagram { + enum ZoomCommand { + //Used to zoom in the Diagram + ZoomIn, + //Used to zoom out the diagram + ZoomOut, + } + } + + class HeatMap extends ej.Widget { + static fn: HeatMap; + constructor(element: JQuery | Element, options?: HeatMap.Model); + static Locale: any; + model: HeatMap.Model; + defaults: HeatMap.Model; + } + export namespace HeatMap { + + export interface Model { + + /** Specifies the width of the heat map. + * @Default {null} + */ + width?: any; + + /** Specifies the width of the heat map. + * @Default {null} + */ + height?: any; + + /** Specifies the name of the heat map. + * @Default {null} + */ + id?: number; + + /** Enables or disables tooltip of heatmap + * @Default {true} + */ + showTooltip?: boolean; + + /** Defines the tooltip that should be shown when the mouse hovers over rows/columns. + */ + tooltipSettings?: TooltipSettings; + + /** Specifies the source data of the heat map. + * @Default {[]} + */ + itemsSource?: any; + + /** Specifies the property of the heat map cell. + * @Default {Null} + */ + heatMapCell?: HeatMapCell; + + /** Specifies can enable responsive mode or not for heat map. + * @Default {false} + */ + isResponsive?: boolean; + + /** Specifies whether the virtualization can be enable or not. + * @Default {false} + */ + enableVirtualization?: boolean; + + /** Specifies the default column properties for all the column style not specified in column properties. + * @Default {[]} + */ + defaultColumnStyle?: DefaultColumnStyle; + + /** Specifies the no of legends can sync with heat map. + * @Default {[]} + */ + legendCollection?: any[]; + + /** Specifies the property and display value of the heat map column. + * @Default {[]} + */ + itemsMapping?: ItemsMapping; + + /** Specifies the color values of the heat map column data. + * @Default {[]} + */ + colorMappingCollection?: ColorMappingCollection[]; + + /** Triggered when the mouse over on the cell. */ + cellMouseOver?(e: CellMouseOverEventArgs): void; + + /** Triggered when the mouse over on the cell. */ + cellMouseEnter?(e: CellMouseEnterEventArgs): void; + + /** Triggered when the mouse over on the cell. */ + cellMouseLeave?(e: CellMouseLeaveEventArgs): void; + + /** Triggered when the mouse over on the cell. */ + cellSelected?(e: CellSelectedEventArgs): void; + } + + export interface CellMouseOverEventArgs { + + /** Value displayed on the cell + */ + cellValue?: string; + + /** Returns the HeatMap cell data + */ + source?: any; + + /** Returns the specific HeatMap cell + */ + cell?: any; + } + + export interface CellMouseEnterEventArgs { + + /** Value displayed on the cell + */ + cellValue?: string; + + /** Returns the HeatMap cell data + */ + source?: any; + + /** Returns the specific HeatMap cell + */ + cell?: any; + } + + export interface CellMouseLeaveEventArgs { + + /** Value displayed on the cell + */ + cellValue?: string; + + /** Returns the HeatMap cell data + */ + source?: any; + + /** Returns the specific HeatMap cell + */ + cell?: any; + } + + export interface CellSelectedEventArgs { + + /** Value displayed on the cell + */ + cellValue?: string; + + /** Returns the HeatMap cell data + */ + source?: any; + + /** Returns the specific HeatMap cell + */ + cell?: any; + } + + export interface TooltipSettingsPositionTarget { - /** Returns the diagram model. - */ - model?: any; + /** Sets the arrow position again popup based on horizontal(x) value + * @Default {center} + */ + horizontal?: ej.datavisualization.HeatMap.Horizontal | string; - /** Returns the name of the event - */ - type?: string; + /** Sets the arrow position again popup based on vertical(y) value + * @Default {top} + */ + vertical?: ej.datavisualization.HeatMap.Vertical | string; + } - /** parameter returns the id of the diagram - */ - diagramId?: string; -} + export interface TooltipSettingsPositionStem { -export interface BackgroundImage { - - /** Defines how to align the background image over the diagram area. - * @Default {ej.datavisualization.Diagram.ImageAlignment.XMidYMid} - */ - alignment?: ej.datavisualization.Diagram.ImageAlignment |string; -} - -export interface CommandManagerCommandsGesture { - - /** Sets the key value, on recognition of which the command will be executed. - * @Default {ej.datavisualization.Diagram.Keys.None} - */ - key?: ej.datavisualization.Diagram.Keys|string; - - /** Sets a combination of key modifiers, on recognition of which the command will be executed. - * @Default {ej.datavisualization.Diagram.KeyModifiers.None} - */ - keyModifiers?: ej.datavisualization.Diagram.KeyModifiers|string; -} - -export interface CommandManagerCommands { - - /** A method that defines whether the command is executable at the moment or not. - */ - canExecute?: any; - - /** A method that defines what to be executed when the key combination is recognized. - */ - execute?: any; - - /** Defines a combination of keys and key modifiers, on recognition of which the command will be executed - */ - gesture?: CommandManagerCommandsGesture; - - /** Defines any additional parameters that are required at runtime - * @Default {null} - */ - parameter?: any; -} - -export interface CommandManager { - - /** An object that maps a set of command names with the corresponding command objects - * @Default {{}} - */ - commands?: CommandManagerCommands; -} - -export interface ConnectorsLabelsMargin { - - /** To set the margin of the label in right direction - * @Default {0} - */ - right?: number; - - /** To set the margin of the label in left direction - * @Default {0} - */ - left?: number; - - /** To set the margin of the label in top direction - * @Default {0} - */ - top?: number; - - /** To set the margin of the label in bottom direction - * @Default {0} - */ - bottom?: number; -} - -export interface ConnectorsLabel { - - /** Defines how the label should be aligned with respect to the segment - * @Default {ej.datavisualization.Diagram.Alignment.Center} - */ - alignment?: ej.datavisualization.Diagram.Alignment|string; - - /** Enables/disables the bold style - * @Default {false} - */ - bold?: boolean; - - /** Sets the border color of the label - * @Default {transparent} - */ - borderColor?: string; - - /** Sets the border width of the label - * @Default {0} - */ - borderWidth?: number; - - /** Defines whether the label should be aligned within the connector boundaries - * @Default {true} - */ - boundaryConstraints?: boolean; - - /** Sets the fill color of the text area - * @Default {transparent} - */ - fillColor?: string; - - /** Sets the font color of the text - * @Default {black} - */ - fontColor?: string; - - /** Sets the font family of the text - * @Default {Arial} - */ - fontFamily?: string; - - /** Defines the font size of the text - * @Default {12} - */ - fontSize?: number; - - /** Sets the horizontal alignment of the label. - * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Center} - */ - horizontalAlignment?: ej.datavisualization.Diagram.HorizontalAlignment|string; - - /** Sets the hyperlink for the labels in the connectors. - * @Default {none} - */ - hyperlink?: string; - - /** Enables/disables the italic style - * @Default {false} - */ - italic?: boolean; - - /** Gets whether the label is currently being edited or not. - * @Default {ej.datavisualization.Diagram.LabelEditMode.Edit} - */ - mode?: ej.datavisualization.Diagram.LabelEditMode|string; - - /** Sets the unique identifier of the label - */ - name?: string; - - /** Sets the fraction/ratio(relative to connector) that defines the position of the label - * @Default {ej.datavisualization.Diagram.Point(0.5, 0.5)} - */ - offset?: any; - - /** Sets the fraction/ratio(relative to connector) that defines the position of the label - * @Default {ej.datavisualization.Diagram.Point(0.5, 0.5)} - */ - margin?: ConnectorsLabelsMargin; - - /** Defines the transparency of labels - * @Default {1} - */ - opacity?: number; - - /** Defines whether the label is editable or not - * @Default {false} - */ - readOnly?: boolean; - - /** Defines whether the label should be positioned whether relative to segments or connector boundaries - * @Default {ej.datavisualization.Diagram.LabelRelativeMode.SegmentPath} - */ - relativeMode?: ej.datavisualization.Diagram.LabelRelativeMode|string; - - /** Defines the angle to which the label needs to be rotated - * @Default {0} - */ - rotateAngle?: number; - - /** Sets the position of the label with respect to the total segment length - * @Default {0.5} - */ - segmentOffset?: string; - - /** Defines the label text - */ - text?: string; - - /** Defines how to align the text inside the label. - * @Default {ej.datavisualization.Diagram.TextAlign.Center} - */ - textAlign?: ej.datavisualization.Diagram.TextAlign|string; - - /** Sets how to decorate the label text. - * @Default {ej.datavisualization.Diagram.TextDecorations.None} - */ - textDecoration?: ej.datavisualization.Diagram.TextDecorations|string; - - /** Sets the vertical alignment of the label. - * @Default {ej.datavisualization.Diagram.VerticalAlignment.Center} - */ - verticalAlignment?: ej.datavisualization.Diagram.VerticalAlignment|string; - - /** Enables or disables the visibility of the label - * @Default {true} - */ - visible?: boolean; - - /** Sets the width of the label(the maximum value of label width and the connector width will be considered as label width) - * @Default {50} - */ - width?: number; - - /** Defines how the label text needs to be wrapped. - * @Default {ej.datavisualization.Diagram.TextWrapping.WrapWithOverflow} - */ - wrapping?: ej.datavisualization.Diagram.TextWrapping|string; -} - -export interface ConnectorsSegment { - - /** Sets the direction of orthogonal segment - */ - direction?: string; - - /** Describes the length of orthogonal segment - * @Default {undefined} - */ - length?: number; - - /** Describes the end point of bezier/straight segment - * @Default {Diagram.Point()} - */ - point?: ej.datavisualization.Diagram.ConnectorsSourcePoint; - - /** Defines the first control point of the bezier segment - * @Default {null} - */ - point1?: ej.datavisualization.Diagram.ConnectorsSourcePoint; - - /** Defines the second control point of bezier segment - * @Default {null} - */ - point2?: ej.datavisualization.Diagram.ConnectorsSourcePoint; - - /** Sets the type of the segment. - * @Default {ej.datavisualization.Diagram.Segments.Straight} - */ - type?: ej.datavisualization.Diagram.Segments|string; - - /** Describes the length and angle between the first control point and the start point of bezier segment - * @Default {null} - */ - vector1?: any; - - /** Describes the length and angle between the second control point and end point of bezier segment - * @Default {null} - */ - vector2?: any; -} - -export interface ConnectorsShapeMultiplicitySource { - - /** Defines the source label to connector. Applicable, if the connector is of type "UML" - * @Default {true} - */ - optional?: boolean; - - /** Defines the source label to connector. Applicable, if the connector is of type "UML" - * @Default {null} - */ - lowerBounds?: number; - - /** Defines the source label to connector. Applicable, if the connector is of type "UML" - * @Default {null} - */ - upperBounds?: number; -} - -export interface ConnectorsShapeMultiplicity { - - /** Sets the type of the multiplicity. Applicable, if the connector is of type "classifier" - * @Default {ej.datavisualization.Diagram.Multiplicity.OneToOne} - */ - type?: ej.datavisualization.Diagram.Multiplicity|string; - - /** Defines the source label to connector. Applicable, if the connector is of type "UML" - */ - source?: ConnectorsShapeMultiplicitySource; - - /** Defines the target label to connector. Applicable, if the connector is of type "UML" - * @Default {true} - */ - target?: ej.datavisualization.Diagram.ConnectorsShapeMultiplicitySource; -} - -export interface ConnectorsShape { - - /** Sets the type of the connector - * @Default {ej.datavisualization.Diagram.ConnectorShapes.BPMN} - */ - type?: ej.datavisualization.Diagram.ConnectorShapes|string; - - /** Sets the type of the flow in a BPMN Process - * @Default {ej.datavisualization.Diagram.BPMNFlows.Sequence} - */ - flow?: ej.datavisualization.Diagram.BPMNFlows|string; - - /** Sets the type of the Association in a BPMN Process - * @Default {ej.datavisualization.Diagram.AssociationFlows.Default} - */ - association?: ej.datavisualization.Diagram.AssociationFlows|string; - - /** Sets the type of the message flow. Applicable, if the connector is of type "BPMN" - * @Default {ej.datavisualization.Diagram.BPMNMessageFlows.Default} - */ - message?: ej.datavisualization.Diagram.BPMNMessageFlows|string; - - /** Sets the type of BPMN sequence flow - * @Default {ej.datavisualization.Diagram.BPMNSequenceFlows.Normal} - */ - sequence?: ej.datavisualization.Diagram.BPMNSequenceFlows|string; - - /** Defines the role of the connector in a UML Class Diagram. Applicable, if the type of the connector is "classifier". - * @Default {ej.datavisualization.Diagram.ClassifierShapes.Association} - */ - relationship?: ej.datavisualization.Diagram.ClassifierShapes|string; - - /** Defines the multiplicity option of the connector - * @Default {null} - */ - multiplicity?: ConnectorsShapeMultiplicity; - - /** Defines the shape of UMLActivity to connector. Applicable, if the connector is of type UMLActivity - * @Default {ej.datavisualization.Diagram.UMLActivityFlow.Control} - */ - ActivityFlow?: ej.datavisualization.Diagram.UMLActivityFlow|string; -} - -export interface ConnectorsSourceDecorator { - - /** Sets the border color of the source decorator - * @Default {black} - */ - borderColor?: string; - - /** Sets the border width of the decorator - * @Default {1} - */ - borderWidth?: number; - - /** Sets the fill color of the source decorator - * @Default {black} - */ - fillColor?: string; - - /** Sets the height of the source decorator - * @Default {8} - */ - height?: number; - - /** Defines the custom shape of the source decorator - */ - pathData?: string; - - /** Defines the shape of the source decorator. - * @Default {ej.datavisualization.Diagram.DecoratorShapes.Arrow} - */ - shape?: ej.datavisualization.Diagram.DecoratorShapes|string; - - /** Defines the width of the source decorator - * @Default {8} - */ - width?: number; -} - -export interface ConnectorsSourcePoint { - - /** Defines the x-coordinate of a position - * @Default {0} - */ - x?: number; - - /** Defines the y-coordinate of a position - * @Default {0} - */ - y?: number; -} - -export interface ConnectorsTargetDecorator { - - /** Sets the border color of the decorator - * @Default {black} - */ - borderColor?: string; - - /** Sets the color with which the decorator will be filled - * @Default {black} - */ - fillColor?: string; - - /** Defines the height of the target decorator - * @Default {8} - */ - height?: number; - - /** Defines the custom shape of the target decorator - */ - pathData?: string; - - /** Defines the shape of the target decorator. - * @Default {ej.datavisualization.Diagram.DecoratorShapes.Arrow} - */ - shape?: ej.datavisualization.Diagram.DecoratorShapes|string; - - /** Defines the width of the target decorator - * @Default {8} - */ - width?: number; -} - -export interface Connector { - - /** To maintain additional information about connectors - * @Default {null} - */ - addInfo?: any; - - /** Defines the width of the line bridges - * @Default {10} - */ - bridgeSpace?: number; - - /** Enables or disables the behaviors of connectors. - * @Default {ej.datavisualization.Diagram.ConnectorConstraints.Default} - */ - constraints?: ej.datavisualization.Diagram.ConnectorConstraints|string; - - /** Defines the radius of the rounded corner - * @Default {0} - */ - cornerRadius?: number; - - /** Configures the styles of shapes - */ - cssClass?: string; - - /** Sets the horizontal alignment of the connector. Applicable, if the parent of the connector is a container. - * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Left} - */ - horizontalAlign?: ej.datavisualization.Diagram.HorizontalAlignment|string; - - /** A collection of JSON objects where each object represents a label. - * @Default {[]} - */ - labels?: ConnectorsLabel[]; - - /** Sets the stroke color of the connector - * @Default {black} - */ - lineColor?: string; - - /** Sets the pattern of dashes and gaps used to stroke the path of the connector - */ - lineDashArray?: string; - - /** Defines the padding value to ease the interaction with connectors - * @Default {10} - */ - lineHitPadding?: number; - - /** Sets the width of the line - * @Default {1} - */ - lineWidth?: number; - - /** Defines the minimum space to be left between the bottom of parent bounds and the connector. Applicable, if the parent is a container. - * @Default {0} - */ - marginBottom?: number; - - /** Defines the minimum space to be left between the left of parent bounds and the connector. Applicable, if the parent is a container. - * @Default {0} - */ - marginLeft?: number; - - /** Defines the minimum space to be left between the right of parent bounds and the connector. Applicable, if the parent is a container. - * @Default {0} - */ - marginRight?: number; - - /** Defines the minimum space to be left between the top of parent bounds and the connector. Applicable, if the parent is a container. - * @Default {0} - */ - marginTop?: number; - - /** Sets a unique name for the connector - */ - name?: string; - - /** Defines the transparency of the connector - * @Default {1} - */ - opacity?: number; - - /** Defines the size and preview size of the node to add that to symbol palette. To explore palette item, refer Palette Item - * @Default {null} - */ - paletteItem?: any; - - /** Sets the parent name of the connector. - */ - parent?: string; - - /** An array of JSON objects where each object represents a segment - * @Default {[ { type:straight } ]} - */ - segments?: ConnectorsSegment[]; - - /** Defines the role/meaning of the connector - * @Default {null} - */ - shape?: ConnectorsShape; - - /** Defines the source decorator of the connector - * @Default {{ shape:arrow, width: 8, height:8, borderColor:black, fillColor:black }} - */ - sourceDecorator?: ConnectorsSourceDecorator; - - /** Sets the source node of the connector - */ - sourceNode?: string; - - /** Defines the space to be left between the source node and the source point of a connector - * @Default {0} - */ - sourcePadding?: number; - - /** Describes the start point of the connector - * @Default {ej.datavisualization.Diagram.Point()} - */ - sourcePoint?: ConnectorsSourcePoint; - - /** Sets the source port of the connector - */ - sourcePort?: string; - - /** Defines the target decorator of the connector - * @Default {{ shape:arrow, width: 8, height:8, borderColor:black, fillColor:black }} - */ - targetDecorator?: ConnectorsTargetDecorator; - - /** Sets the target node of the connector - */ - targetNode?: string; - - /** Defines the space to be left between the target node and the target point of the connector - * @Default {0} - */ - targetPadding?: number; - - /** Describes the end point of the connector - * @Default {ej.datavisualization.Diagram.Point()} - */ - targetPoint?: ej.datavisualization.Diagram.ConnectorsSourcePoint; - - /** Sets the targetPort of the connector - */ - targetPort?: string; - - /** Defines the tooltip that should be shown when the mouse hovers over connector. For tooltip properties, refer Tooltip - * @Default {null} - */ - tooltip?: any; - - /** To set the vertical alignment of connector (Applicable,if the parent is group). - * @Default {ej.datavisualization.Diagram.VerticalAlignment.Top} - */ - verticalAlign?: ej.datavisualization.Diagram.VerticalAlignment|string; - - /** Enables or disables the visibility of connector - * @Default {true} - */ - visible?: boolean; - - /** Sets the z-index of the connector - * @Default {0} - */ - zOrder?: number; -} - -export interface ContextMenuItem { - - /** Defines the text for the collection of context menu item - * @Default {null} - */ - text?: string; - - /** Defines the name for the collection of context menu items - * @Default {null} - */ - name?: string; - - /** Defines the image url for the collection of context menu items - * @Default {null} - */ - imageUrl?: string; - - /** Defines the CssClass for the collection of context menu items - * @Default {null} - */ - cssClass?: string; - - /** Defines the collection of sub items for the context menu items - * @Default {[]} - */ - subItems?: any[]; -} - -export interface ContextMenu { - - /** Defines the collection of context menu items - * @Default {[]} - */ - items?: ContextMenuItem[]; - - /** To set whether to display the default context menu items or not - * @Default {false} - */ - showCustomMenuItemsOnly?: boolean; -} - -export interface DataSourceSettings { - - /** Defines the data source either as a collection of objects or as an instance of ej.DataManager - * @Default {null} - */ - dataSource?: any; - - /** Sets the unique id of the data source items - */ - id?: string; - - /** Defines the parent id of the data source item - * @Default {''} - */ - parent?: string; - - /** Describes query to retrieve a set of data from the specified datasource - * @Default {null} - */ - query?: string; - - /** Sets the unique id of the root data source item - */ - root?: string; - - /** Describes the name of the table on which the specified query has to be executed - * @Default {null} - */ - tableName?: string; -} - -export interface DefaultSettings { - - /** Initializes the default connector properties - * @Default {null} - */ - connector?: any; - - /** Initializes the default properties of groups - * @Default {null} - */ - group?: any; - - /** Initializes the default properties for nodes - * @Default {null} - */ - node?: any; -} - -export interface HistoryManager { - - /** A method that takes a history entry as argument and returns whether the specific entry can be popped or not - */ - canPop?: any; - - /** A method that ends grouping the changes - */ - closeGroupAction?: any; - - /** A method that removes the history of a recent change made in diagram - */ - pop?: any; - - /** A method that allows to track the custom changes made in diagram - */ - push?: any; - - /** Defines what should be happened while trying to restore a custom change - * @Default {null} - */ - redo?: any; - - /** The redoStack property is used to get the number of redo actions to be stored on the history manager. Its an read-only property and the collection should not be modified. - * @Default {[]} - */ - redoStack?: any[]; - - /** The stackLimit property used to restrict the undo and redo actions to a certain limit. - * @Default {null} - */ - stackLimit?: number; - - /** A method that starts to group the changes to revert/restore them in a single undo or redo - */ - startGroupAction?: any; - - /** Defines what should be happened while trying to revert a custom change - */ - undo?: any; - - /** The undoStack property is used to get the number of undo actions to be stored on the history manager. Its an read-only property and the collection should not be modified. - * @Default {[]} - */ - undoStack?: any[]; -} - -export interface Layout { - - /** Specifies the custom bounds to arrange/align the layout - * @Default {ej.datavisualization.Diagram.Rectangle()} - */ - bounds?: any; - - /** Defines the fixed node with reference to which, the layout will be arranged and fixed node will not be repositioned - */ - fixedNode?: string; - - /** Customizes the orientation of trees/sub trees. For orientations, see Chart Orientations. For chart types, see Chart Types - * @Default {null} - */ - getLayoutInfo?: any; - - /** Sets the space to be horizontally left between nodes - * @Default {30} - */ - horizontalSpacing?: number; - - /** Defines the space to be left between layout bounds and layout. - * @Default {ej.datavisualization.Diagram.Margin()} - */ - margin?: any; - - /** Defines how to horizontally align the layout within the layout bounds - * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Center} - */ - horizontalAlignment?: ej.datavisualization.Diagram.HorizontalAlignment|string; - - /** Defines how to vertically align the layout within the layout bounds - * @Default {ej.datavisualization.Diagram.VerticalAlignment.Center} - */ - verticalAlignment?: ej.datavisualization.Diagram.VerticalAlignment|string; - - /** Sets the orientation/direction to arrange the diagram elements. - * @Default {ej.datavisualization.Diagram.LayoutOrientations.TopToBottom} - */ - orientation?: ej.datavisualization.Diagram.LayoutOrientations|string; - - /** Sets the type of the layout based on which the elements will be arranged. - * @Default {ej.datavisualization.Diagram.LayoutTypes.None} - */ - type?: ej.datavisualization.Diagram.LayoutTypes|string; - - /** Sets the space to be vertically left between nodes - * @Default {30} - */ - verticalSpacing?: number; -} - -export interface NodesAnnotation { - - /** Sets the angle between the BPMN shape and the annotation - * @Default {0} - */ - angle?: number; - - /** Sets the direction of the text annotation - * @Default {ej.datavisualization.Diagram.BPMNAnnotationDirections.Left} - */ - direction?: ej.datavisualization.Diagram.BPMNAnnotationDirection|string; - - /** Sets the height of the text annotation - * @Default {20} - */ - height?: number; - - /** Sets the distance between the BPMN shape and the annotation - * @Default {0} - */ - length?: number; - - /** Defines the additional information about the flow object in a BPMN Process - */ - text?: string; - - /** Sets the width of the text annotation - * @Default {20} - */ - width?: number; -} - -export interface NodesClassAttribute { - - /** Sets the name of the attribute - */ - name?: string; - - /** Sets the data type of attribute - */ - type?: string; - - /** Defines the visibility of the attribute - * @Default {ej.datavisualization.Diagram.ScopeValueDefaults.Public} - */ - scope?: string; -} - -export interface NodesClassMethod { - - /** Sets the visibility of the method. - * @Default {ej.datavisualization.Diagram.ScopeValueDefaults.Public} - */ - scope?: string; -} - -export interface NodesClass { - - /** Sets the name of class. - */ - name?: string; - - /** Defines the collection of attributes - * @Default {[]} - */ - attributes?: NodesClassAttribute[]; - - /** Defines the collection of methods of a Class. - * @Default {[]} - */ - methods?: NodesClassMethod[]; -} - -export interface NodesCollapseIcon { - - /** Sets the border color for collapse icon of node - * @Default {black} - */ - borderColor?: string; - - /** Sets the border width for collapse icon of node - * @Default {1} - */ - borderWidth?: number; - - /** Sets the fill color for collapse icon of node - * @Default {white} - */ - fillColor?: string; - - /** Defines the height for collapse icon of node - * @Default {15} - */ - height?: number; - - /** Sets the horizontal alignment of the icon. - * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Center} - */ - horizontalAlignment?: ej.datavisualization.Diagram.HorizontalAlignment|string; - - /** To set the margin for the collapse icon of node - * @Default {ej.datavisualization.Diagram.Margin()} - */ - margin?: any; - - /** Sets the fraction/ratio(relative to node) that defines the position of the icon - * @Default {ej.datavisualization.Diagram.Point(0.5, 1)} - */ - offset?: any; - - /** Defines the shape of the collapsed state of the node. - * @Default {ej.datavisualization.Diagram.IconShapes.None} - */ - shape?: ej.datavisualization.Diagram.IconShapes|string; - - /** Sets the vertical alignment of the icon. - * @Default {ej.datavisualization.Diagram.VerticalAlignment.Center} - */ - verticalAlignment?: ej.datavisualization.Diagram.VerticalAlignment|string; -} - -export interface NodesContainer { - - /** Defines the orientation of the container. Applicable, if the group is a container. - * @Default {vertical} - */ - orientation?: string; - - /** Sets the type of the container. Applicable if the group is a container. - * @Default {ej.datavisualization.Diagram.ContainerType.Canvas} - */ - type?: ej.datavisualization.Diagram.ContainerType|string; -} - -export interface NodesData { - - /** Sets the type of the BPMN Data object - * @Default {ej.datavisualization.Diagram.BPMNDataObjects.None} - */ - type?: ej.datavisualization.Diagram.BPMNDataObjects|string; - - /** Defines whether the BPMN data object is a collection or not - * @Default {false} - */ - collection?: boolean; -} - -export interface NodesEnumerationMember { - - /** Sets the name of the enumeration member - */ - name?: string; -} - -export interface NodesEnumeration { - - /** Sets the name of the Enumeration - */ - name?: string; - - /** Defines the collection of enumeration members - * @Default {[]} - */ - members?: NodesEnumerationMember[]; -} - -export interface NodesExpandIcon { - - /** Sets the border color for expand icon of node - * @Default {black} - */ - borderColor?: string; - - /** Sets the border width for expand icon of node - * @Default {1} - */ - borderWidth?: number; - - /** Sets the fill color for expand icon of node - * @Default {white} - */ - fillColor?: string; - - /** Defines the height for expand icon of node - * @Default {15} - */ - height?: number; - - /** Sets the horizontal alignment of the icon. - * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Center} - */ - horizontalAlignment?: ej.datavisualization.Diagram.HorizontalAlignment|string; - - /** To set the margin for the expand icon of node - * @Default {ej.datavisualization.Diagram.Margin()} - */ - margin?: any; - - /** Sets the fraction/ratio(relative to node) that defines the position of the icon - * @Default {ej.datavisualization.Diagram.Point(0.5, 1)} - */ - offset?: any; - - /** Defines the shape of the expanded state of the node. - * @Default {ej.datavisualization.Diagram.IconShapes.None} - */ - shape?: ej.datavisualization.Diagram.IconShapes|string; - - /** Sets the vertical alignment of the icon. - * @Default {ej.datavisualization.Diagram.VerticalAlignment.Center} - */ - verticalAlignment?: ej.datavisualization.Diagram.VerticalAlignment|string; -} - -export interface NodesGradientLinearGradient { - - /** Defines the different colors and the region of color transitions - * @Default {[]} - */ - stops?: any[]; - - /** Defines the left most position(relative to node) of the rectangular region that needs to be painted - * @Default {0} - */ - x1?: number; - - /** Defines the right most position(relative to node) of the rectangular region that needs to be painted - * @Default {0} - */ - x2?: number; - - /** Defines the top most position(relative to node) of the rectangular region that needs to be painted - * @Default {0} - */ - y1?: number; - - /** Defines the bottom most position(relative to node) of the rectangular region that needs to be painted - * @Default {0} - */ - y2?: number; -} - -export interface NodesGradientRadialGradient { - - /** Defines the position of the outermost circle - * @Default {0} - */ - cx?: number; - - /** Defines the outer most circle of the radial gradient - * @Default {0} - */ - cy?: number; - - /** Defines the innermost circle of the radial gradient - * @Default {0} - */ - fx?: number; - - /** Defines the innermost circle of the radial gradient - * @Default {0} - */ - fy?: number; - - /** Defines the different colors and the region of color transitions. - * @Default {[]} - */ - stops?: any[]; -} - -export interface NodesGradientStop { - - /** Sets the color to be filled over the specified region - */ - color?: string; - - /** Sets the position where the previous color transition ends and a new color transition starts - * @Default {0} - */ - offset?: number; - - /** Describes the transparency level of the region - * @Default {1} - */ - opacity?: number; -} - -export interface NodesGradient { - - /** Paints the node with linear color transitions - */ - LinearGradient?: NodesGradientLinearGradient; - - /** Paints the node with radial color transitions. A focal point defines the beginning of the gradient, and a circle defines the end point of the gradient. - */ - RadialGradient?: NodesGradientRadialGradient; - - /** Defines the color and a position where the previous color transition ends and a new color transition starts - */ - Stop?: NodesGradientStop; -} - -export interface NodesInterfaceAttribute { - - /** Sets the name of the attribute - */ - name?: string; - - /** Sets the type of the attribute - */ - type?: string; - - /** Sets the visibility of the attribute - */ - scope?: string; -} - -export interface NodesInterfaceMethod { - - /** Sets the visibility of the method - */ - scope?: string; -} - -export interface NodesInterface { - - /** Sets the name of the interface - */ - name?: string; - - /** Defines a collection of attributes of the interface - * @Default {[]} - */ - attributes?: NodesInterfaceAttribute[]; - - /** Defines the collection of public methods of an interface - * @Default {[]} - */ - methods?: NodesInterfaceMethod[]; -} - -export interface NodesLabel { - - /** Enables/disables the bold style - * @Default {false} - */ - bold?: boolean; - - /** Sets the border color of the label - * @Default {transparent} - */ - borderColor?: string; - - /** Sets the border width of the label - * @Default {0} - */ - borderWidth?: number; - - /** Sets the fill color of the text area - * @Default {transparent} - */ - fillColor?: string; - - /** Sets the font color of the text - * @Default {black} - */ - fontColor?: string; - - /** Sets the font family of the text - * @Default {Arial} - */ - fontFamily?: string; - - /** Defines the font size of the text - * @Default {12} - */ - fontSize?: number; - - /** Sets the horizontal alignment of the label. - * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Center} - */ - horizontalAlignment?: ej.datavisualization.Diagram.HorizontalAlignment|string; - - /** Enables/disables the italic style - * @Default {false} - */ - italic?: boolean; - - /** To set the margin of the label - * @Default {ej.datavisualization.Diagram.Margin()} - */ - margin?: any; - - /** Gets whether the label is currently being edited or not. - * @Default {ej.datavisualization.Diagram.LabelEditMode.Edit} - */ - mode?: ej.datavisualization.Diagram.LabelEditMode|string; - - /** Sets the unique identifier of the label - */ - name?: string; - - /** Sets the fraction/ratio(relative to node) that defines the position of the label - * @Default {ej.datavisualization.Diagram.Point(0.5, 0.5)} - */ - offset?: any; - - /** Defines the transparency of the labels - * @Default {1} - */ - opacity?: number; - - /** Sets the overflowType of the labels - * @Default {ej.datavisualization.Diagram.OverflowType.Ellipsis} - */ - overflowType?: ej.datavisualization.Diagram.OverflowType|string; - - /** Defines whether the label is editable or not - * @Default {false} - */ - readOnly?: boolean; - - /** Defines the angle to which the label needs to be rotated - * @Default {0} - */ - rotateAngle?: number; - - /** Defines the label text - */ - text?: string; - - /** Defines how to align the text inside the label. - * @Default {ej.datavisualization.Diagram.TextAlign.Center} - */ - textAlign?: ej.datavisualization.Diagram.TextAlign|string; - - /** Sets how to decorate the label text. - * @Default {ej.datavisualization.Diagram.TextDecorations.None} - */ - textDecoration?: ej.datavisualization.Diagram.TextDecorations|string; - - /** Defines the overflowed content is displayed or not. - * @Default {false} - */ - textOverflow?: boolean; - - /** Sets the vertical alignment of the label. - * @Default {ej.datavisualization.Diagram.VerticalAlignment.Center} - */ - verticalAlignment?: ej.datavisualization.Diagram.VerticalAlignment|string; - - /** Enables or disables the visibility of the label - * @Default {true} - */ - visible?: boolean; - - /** Sets the width of the label(the maximum value of label width and the node width will be considered as label width) - * @Default {50} - */ - width?: number; - - /** Defines how the label text needs to be wrapped. - * @Default {ej.datavisualization.Diagram.TextWrapping.WrapWithOverflow} - */ - wrapping?: ej.datavisualization.Diagram.TextWrapping|string; -} - -export interface NodesLane { - - /** Defines the width of lane - * @Default {0} - */ - width?: number; - - /** Defines the height of lane - * @Default {0} - */ - height?: number; - - /** Defines the z-index of the lane - * @Default {0} - */ - zorder?: number; - - /** Allows to maintain additional information about lane - * @Default {{}} - */ - addInfo?: any; - - /** An array of objects where each object represents a child node of the lane - * @Default {[]} - */ - children?: any[]; - - /** Defines the fill color of the lane - * @Default {white} - */ - fillColor?: string; - - /** Defines the header of the lane - * @Default {{ text: Function, fontSize: 11 }} - */ - header?: any; - - /** Defines the object as a lane - * @Default {false} - */ - isLane?: boolean; - - /** Sets the unique identifier of the lane - */ - name?: string; - - /** Sets the orientation of the lane. - * @Default {vertical} - */ - orientation?: string; -} - -export interface NodesPaletteItem { - - /** Defines whether the symbol should be drawn at its actual size regardless of precedence factors or not - * @Default {true} - */ - enableScale?: boolean; - - /** Defines the height of the symbol - * @Default {0} - */ - height?: number; - - /** Defines the margin of the symbol item - * @Default {{ left: 4, right: 4, top: 4, bottom: 4 }} - */ - margin?: any; - - /** Defines the preview height of the symbol - * @Default {undefined} - */ - previewHeight?: number; - - /** Defines the preview width of the symbol - * @Default {undefined} - */ - previewWidth?: number; - - /** Defines the width of the symbol - * @Default {0} - */ - width?: number; -} - -export interface NodesPhase { - - /** Defines the header of the smaller regions - * @Default {null} - */ - label?: any; - - /** Defines the line color of the splitter that splits adjacent phases. - * @Default {#606060} - */ - lineColor?: string; - - /** Sets the dash array that used to stroke the phase splitter - * @Default {3,3} - */ - lineDashArray?: string; - - /** Sets the lineWidth of the phase - * @Default {1} - */ - lineWidth?: number; - - /** Sets the unique identifier of the phase - */ - name?: string; - - /** Sets the length of the smaller region(phase) of a swimlane - * @Default {100} - */ - offset?: number; - - /** Sets the orientation of the phase - * @Default {horizontal} - */ - orientation?: string; - - /** Sets the type of the object as phase - * @Default {phase} - */ - type?: string; -} - -export interface NodesPort { - - /** Sets the border color of the port - * @Default {#1a1a1a} - */ - borderColor?: string; - - /** Sets the stroke width of the port - * @Default {1} - */ - borderWidth?: number; - - /** Defines the space to be left between the port bounds and its incoming and outgoing connections. - * @Default {0} - */ - connectorPadding?: number; - - /** Defines whether connections can be created with the port - * @Default {ej.datavisualization.Diagram.PortConstraints.Connect} - */ - constraints?: ej.datavisualization.Diagram.PortConstraints|string; - - /** Sets the fill color of the port - * @Default {white} - */ - fillColor?: string; - - /** Sets the unique identifier of the port - */ - name?: string; - - /** Defines the position of the port as fraction/ ratio relative to node - * @Default {ej.datavisualization.Diagram.Point(0, 0)} - */ - offset?: any; - - /** Defines the path data to draw the port. Applicable, if the port shape is path. - */ - pathData?: string; - - /** Defines the shape of the port. - * @Default {ej.datavisualization.Diagram.PortShapes.Square} - */ - shape?: ej.datavisualization.Diagram.PortShapes|string; - - /** Defines the size of the port - * @Default {8} - */ - size?: number; - - /** Defines when the port should be visible. - * @Default {ej.datavisualization.Diagram.PortVisibility.Default} - */ - visibility?: ej.datavisualization.Diagram.PortVisibility|string; -} - -export interface NodesShadow { - - /** Defines the angle of the shadow relative to node - * @Default {45} - */ - angle?: number; - - /** Sets the distance to move the shadow relative to node - * @Default {5} - */ - distance?: number; - - /** Defines the opaque of the shadow - * @Default {0.7} - */ - opacity?: number; -} - -export interface NodesSubProcess { - - /** Defines whether the BPMN sub process is without any prescribed order or not - * @Default {false} - */ - adhoc?: boolean; - - /** Sets the boundary of the BPMN process - * @Default {ej.datavisualization.Diagram.BPMNBoundary.Default} - */ - boundary?: ej.datavisualization.Diagram.BPMNBoundary|string; - - /** Sets whether the BPMN subprocess is triggered as a compensation of a specific activity - * @Default {false} - */ - compensation?: boolean; - - /** Sets whether the BPMN subprocess is triggered as a collapsed of a specific activity - * @Default {true} - */ - collapsed?: boolean; - - /** Sets the type of the event by which the sub-process will be triggered - * @Default {ej.datavisualization.Diagram.BPMNEvents.Start} - */ - event?: ej.datavisualization.Diagram.BPMNEvents|string; - - /** Defines the collection of events that need to be appended with BPMN Sub-Process - */ - events?: any[]; - - /** Defines the loop type of a sub process. - * @Default {ej.datavisualization.Diagram.BPMNLoops.None} - */ - loop?: ej.datavisualization.Diagram.BPMNLoops|string; - - /** Defines the children for BPMN's SubProcess - * @Default {[]} - */ - Processes?: any[]; - - /** Defines the type of the event trigger - * @Default {ej.datavisualization.Diagram.BPMNTriggers.Message} - */ - trigger?: ej.datavisualization.Diagram.BPMNTriggers|string; - - /** Defines the type of a sub process - * @Default {ej.datavisualization.Diagram.BPMNSubProcessTypes.None} - */ - type?: ej.datavisualization.Diagram.BPMNSubProcessTypes|string; -} - -export interface NodesTask { - - /** To set whether the task is a global task or not - * @Default {false} - */ - call?: boolean; - - /** Sets whether the task is triggered as a compensation of another specific activity - * @Default {false} - */ - compensation?: boolean; - - /** Sets the loop type of a BPMN task. - * @Default {ej.datavisualization.Diagram.BPMNLoops.None} - */ - loop?: ej.datavisualization.Diagram.BPMNLoops|string; - - /** Sets the type of the BPMN task. - * @Default {ej.datavisualization.Diagram.BPMNTasks.None} - */ - type?: ej.datavisualization.Diagram.BPMNTasks|string; -} - -export interface Node { - - /** Defines the type of BPMN Activity. Applicable, if the node is a BPMN activity. - * @Default {ej.datavisualization.Diagram.BPMNActivity.Task} - */ - activity?: ej.datavisualization.Diagram.BPMNActivity|string; - - /** To maintain additional information about nodes - * @Default {{}} - */ - addInfo?: any; - - /** Defines the additional information of a process. It is not directly related to the message flows or sequence flows of the process. - * @Default {ej.datavisualization.Diagram.BPMNTextAnnotation()} - */ - annotation?: NodesAnnotation; - - /** Sets the border color of node - * @Default {black} - */ - borderColor?: string; - - /** Sets the pattern of dashes and gaps to stroke the border - */ - borderDashArray?: string; - - /** Sets the border width of the node - * @Default {1} - */ - borderWidth?: number; - - /** Defines whether the group can be ungrouped or not - * @Default {true} - */ - canUngroup?: boolean; - - /** Array of JSON objects where each object represents a child node/connector - * @Default {[]} - */ - children?: any[]; - - /** Sets the type of UML classifier. Applicable, if the node is a UML Class Diagram shape. - * @Default {ej.datavisualization.Diagram.ClassifierShapes.Class} - */ - classifier?: ej.datavisualization.Diagram.ClassifierShapes|string; - - /** Defines the name, attributes and methods of a Class. Applicable, if the node is a Class. - * @Default {null} - */ - class?: NodesClass; - - /** Defines the state of the node is collapsed. - */ - collapseIcon?: NodesCollapseIcon; - - /** Defines the distance to be left between a node and its connections(In coming and out going connections). - * @Default {0} - */ - connectorPadding?: number; - - /** Enables or disables the default behaviors of the node. - * @Default {ej.datavisualization.Diagram.NodeConstraints.Default} - */ - constraints?: ej.datavisualization.Diagram.NodeConstraints|string; - - /** Defines how the child objects need to be arranged(Either in any predefined manner or automatically). Applicable, if the node is a group. - * @Default {null} - */ - container?: NodesContainer; - - /** Defines the corner radius of rectangular shapes. - * @Default {0} - */ - cornerRadius?: number; - - /** Configures the styles of shapes - */ - cssClass?: string; - - /** Defines the BPMN data object - */ - data?: NodesData; - - /** Defines an Enumeration in a UML Class Diagram - * @Default {null} - */ - enumeration?: NodesEnumeration; - - /** Sets the type of the BPMN Events. Applicable, if the node is a BPMN event. - * @Default {ej.datavisualization.Diagram.BPMNEvents.Start} - */ - event?: ej.datavisualization.Diagram.BPMNEvents|string; - - /** Defines whether the node can be automatically arranged using layout or not - * @Default {false} - */ - excludeFromLayout?: boolean; - - /** Defines the state of the node is expanded or collapsed. - */ - expandIcon?: NodesExpandIcon; - - /** Defines the fill color of the node - * @Default {white} - */ - fillColor?: string; - - /** Sets the type of the BPMN Gateway. Applicable, if the node is a BPMN gateway. - * @Default {ej.datavisualization.Diagram.BPMNGateways.None} - */ - gateway?: ej.datavisualization.Diagram.BPMNGateways|string; - - /** Paints the node with a smooth transition from one color to another color - */ - gradient?: NodesGradient; - - /** Sets the type of the BPMN Shapes as group. Applicable, if the node is a BPMN. - * @Default {ej.datavisualization.Diagram.BPMNShapes} - */ - group?: any; - - /** Defines the header of a swimlane/lane - * @Default {{ text: Title, fontSize: 11 }} - */ - header?: any; - - /** Defines the height of the node - * @Default {0} - */ - height?: number; - - /** Sets the horizontal alignment of the node. Applicable, if the parent of the node is a container. - * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Left} - */ - horizontalAlign?: ej.datavisualization.Diagram.HorizontalAlignment|string; - - /** A read only collection of the incoming connectors/edges of the node - * @Default {[]} - */ - inEdges?: any[]; - - /** Defines an interface in a UML Class Diagram - * @Default {null} - */ - interface?: NodesInterface; - - /** Defines whether the sub tree of the node is expanded or collapsed - * @Default {true} - */ - isExpanded?: boolean; - - /** Sets the node as a swimlane - * @Default {false} - */ - isSwimlane?: boolean; - - /** A collection of objects where each object represents a label - * @Default {[]} - */ - labels?: NodesLabel[]; - - /** An array of objects where each object represents a lane. Applicable, if the node is a swimlane. - * @Default {[]} - */ - lanes?: NodesLane[]; - - /** Defines the minimum space to be left between the bottom of parent bounds and the node. Applicable, if the parent is a container. - * @Default {0} - */ - marginBottom?: number; - - /** Defines the minimum space to be left between the left of parent bounds and the node. Applicable, if the parent is a container. - * @Default {0} - */ - marginLeft?: number; - - /** Defines the minimum space to be left between the right of the parent bounds and the node. Applicable, if the parent is a container. - * @Default {0} - */ - marginRight?: number; - - /** Defines the minimum space to be left between the top of parent bounds and the node. Applicable, if the parent is a container. - * @Default {0} - */ - marginTop?: number; - - /** Defines the maximum height limit of the node - * @Default {0} - */ - maxHeight?: number; - - /** Defines the maximum width limit of the node - * @Default {0} - */ - maxWidth?: number; - - /** Defines the minimum height limit of the node - * @Default {0} - */ - minHeight?: number; - - /** Defines the minimum width limit of the node - * @Default {0} - */ - minWidth?: number; - - /** Sets the unique identifier of the node - */ - name?: string; - - /** Defines the position of the node on X-Axis - * @Default {0} - */ - offsetX?: number; - - /** Defines the position of the node on Y-Axis - * @Default {0} - */ - offsetY?: number; - - /** Defines the opaque of the node - * @Default {1} - */ - opacity?: number; - - /** Defines the orientation of nodes. Applicable, if the node is a swimlane. - * @Default {vertical} - */ - orientation?: string; - - /** A read only collection of outgoing connectors/edges of the node - * @Default {[]} - */ - outEdges?: any[]; - - /** Defines the minimum padding value to be left between the bottom most position of a group and its children. Applicable, if the group is a container. - * @Default {0} - */ - paddingBottom?: number; - - /** Defines the minimum padding value to be left between the left most position of a group and its children. Applicable, if the group is a container. - * @Default {0} - */ - paddingLeft?: number; - - /** Defines the minimum padding value to be left between the right most position of a group and its children. Applicable, if the group is a container. - * @Default {0} - */ - paddingRight?: number; - - /** Defines the minimum padding value to be left between the top most position of a group and its children. Applicable, if the group is a container. - * @Default {0} - */ - paddingTop?: number; - - /** Defines the size and preview size of the node to add that to symbol palette - * @Default {null} - */ - paletteItem?: NodesPaletteItem; - - /** Sets the name of the parent group - */ - parent?: string; - - /** Sets the path geometry that defines the shape of a path node - */ - pathData?: string; - - /** An array of objects, where each object represents a smaller region(phase) of a swimlane. - * @Default {[]} - */ - phases?: NodesPhase[]; - - /** Sets the height of the phase headers - * @Default {0} - */ - phaseSize?: number; - - /** Sets the ratio/ fractional value relative to node, based on which the node will be transformed(positioning, scaling and rotation) - * @Default {ej.datavisualization.Diagram.Points(0.5,0.5)} - */ - pivot?: any; - - /** Defines a collection of points to draw a polygon. Applicable, if the shape is a polygon. - * @Default {[]} - */ - points?: any[]; - - /** An array of objects where each object represents a port - * @Default {[]} - */ - ports?: NodesPort[]; - - /** Sets the angle to which the node should be rotated - * @Default {0} - */ - rotateAngle?: number; - - /** Defines the opacity and the position of shadow - * @Default {ej.datavisualization.Diagram.Shadow()} - */ - shadow?: NodesShadow; - - /** Sets the shape of the node. It depends upon the type of node. - * @Default {ej.datavisualization.Diagram.BasicShapes.Rectangle} - */ - shape?: ej.datavisualization.Diagram.BasicShapes | ej.datavisualization.Diagram.FlowShapes | ej.datavisualization.Diagram.BPMNShapes | ej.datavisualization.Diagram.UMLActivityShapes|string; - - /** Sets the source path of the image. Applicable, if the type of the node is image. - */ - source?: string; - - /** Defines the sub process of a BPMN Activity. Applicable, if the type of the BPMN activity is sub process. - * @Default {ej.datavisualization.Diagram.BPMNSubProcess()} - */ - subProcess?: NodesSubProcess; - - /** Defines the task of the BPMN activity. Applicable, if the type of activity is set as task. - * @Default {ej.datavisualization.Diagram.BPMNTask()} - */ - task?: NodesTask; - - /** Sets the id of svg/html templates. Applicable, if the node is HTML or native. - */ - templateId?: string; - - /** Defines the textBlock of a text node - * @Default {null} - */ - textBlock?: any; - - /** Defines the tooltip that should be shown when the mouse hovers over node. For tooltip properties, refer Tooltip - * @Default {null} - */ - tooltip?: any; - - /** Sets the type of BPMN Event Triggers. - * @Default {ej.datavisualization.Diagram.BPMNTriggers.None} - */ - trigger?: ej.datavisualization.Diagram.BPMNTriggers|string; - - /** Defines the type of the node. - * @Default {ej.datavisualization.Diagram.Shapes.Basic} - */ - type?: ej.datavisualization.Diagram.Shapes|string; - - /** Sets the vertical alignment of a node. Applicable, if the parent of a node is a container. - * @Default {ej.datavisualization.Diagram.VerticalAlignment.Top} - */ - verticalAlign?: ej.datavisualization.Diagram.VerticalAlignment|string; - - /** Defines the visibility of the node - * @Default {true} - */ - visible?: boolean; - - /** Defines the width of the node - * @Default {0} - */ - width?: number; - - /** Defines the z-index of the node - * @Default {0} - */ - zOrder?: number; -} - -export interface PageSettings { - - /** Defines the maximum distance to be left between the object and the scroll bar to trigger auto scrolling - * @Default {{ left: 15, top: 15, right: 15, bottom: 15 }} - */ - autoScrollBorder?: any; - - /** Sets whether multiple pages can be created to fit all nodes and connectors - * @Default {false} - */ - multiplePage?: boolean; - - /** Defines the background color of diagram pages - * @Default {#ffffff} - */ - pageBackgroundColor?: string; - - /** Defines the page border color - * @Default {#565656} - */ - pageBorderColor?: string; - - /** Sets the border width of diagram pages - * @Default {0} - */ - pageBorderWidth?: number; - - /** Defines the height of a page - * @Default {null} - */ - pageHeight?: number; - - /** Defines the page margin - * @Default {24} - */ - pageMargin?: number; - - /** Sets the orientation of the page. - * @Default {ej.datavisualization.Diagram.PageOrientations.Portrait} - */ - pageOrientation?: ej.datavisualization.Diagram.PageOrientations|string; - - /** Defines the height of a diagram page - * @Default {null} - */ - pageWidth?: number; - - /** Defines the scrollable area of diagram. Applicable, if the scroll limit is "limited". - * @Default {null} - */ - scrollableArea?: any; - - /** Defines the scrollable region of diagram. - * @Default {ej.datavisualization.Diagram.ScrollLimit.Infinite} - */ - scrollLimit?: ej.datavisualization.Diagram.ScrollLimit|string; - - /** Defines the draggable region of diagram elements. - * @Default {ej.datavisualization.Diagram.BoundaryConstraints.Infinite} - */ - boundaryConstraints?: ej.datavisualization.Diagram.BoundaryConstraints|string; - - /** Enables or disables the page breaks - * @Default {false} - */ - showPageBreak?: boolean; -} - -export interface ScrollSettings { - - /** Allows to read the zoom value of diagram - * @Default {0} - */ - currentZoom?: number; - - /** Sets the horizontal scroll offset - * @Default {0} - */ - horizontalOffset?: number; - - /** Allows to extend the scrollable region that is based on the scroll limit - * @Default {{left: 0, right: 0, top:0, bottom: 0}} - */ - padding?: any; - - /** Sets the vertical scroll offset - * @Default {0} - */ - verticalOffset?: number; - - /** Allows to read the view port height of the diagram - * @Default {0} - */ - viewPortHeight?: number; - - /** Allows to read the view port width of the diagram - * @Default {0} - */ - viewPortWidth?: number; -} - -export interface SelectedItemsUserHandle { - - /** Defines the background color of the user handle - * @Default {#2382c3} - */ - backgroundColor?: string; - - /** Sets the border color of the user handle - * @Default {transparent} - */ - borderColor?: string; - - /** Defines whether the user handle should be added, when more than one element is selected - * @Default {false} - */ - enableMultiSelection?: boolean; - - /** Sets the stroke color of the user handle - * @Default {transparent} - */ - pathColor?: string; - - /** Defines the custom shape of the user handle - */ - pathData?: string; - - /** Defines the position of the user handle - * @Default {ej.datavisualization.Diagram.UserHandlePositions.BottomCenter} - */ - position?: ej.datavisualization.Diagram.UserHandlePositions |string; - - /** Defines the size of the user handle - * @Default {8} - */ - size?: number; - - /** Defines the interactive behaviors of the user handle - */ - tool?: any; - - /** Defines the visibility of the user handle - * @Default {true} - */ - visible?: boolean; -} - -export interface SelectedItems { - - /** A read only collection of the selected items - * @Default {[]} - */ - children?: any[]; - - /** Controls the visibility of selector. - * @Default {ej.datavisualization.Diagram.SelectorConstraints.All} - */ - constraints?: ej.datavisualization.Diagram.SelectorConstraints|string; - - /** Defines a method that dynamically enables/ disables the interaction with multiple selection. - * @Default {null} - */ - getConstraints?: any; - - /** Sets the height of the selected items - * @Default {0} - */ - height?: number; - - /** Sets the x position of the selector - * @Default {0} - */ - offsetX?: number; - - /** Sets the y position of the selector - * @Default {0} - */ - offsetY?: number; - - /** Sets the angle to rotate the selected items - * @Default {0} - */ - rotateAngle?: number; - - /** Sets the angle to rotate the selected items. For tooltip properties, refer Tooltip - * @Default {ej.datavisualization.Diagram.Tooltip()} - */ - tooltip?: any; - - /** A collection of frequently used commands that will be added around the selector - * @Default {[]} - */ - userHandles?: SelectedItemsUserHandle[]; - - /** Sets the width of the selected items - * @Default {0} - */ - width?: number; -} - -export interface SnapSettingsHorizontalGridLines { - - /** Defines the line color of horizontal grid lines - * @Default {lightgray} - */ - lineColor?: string; - - /** Specifies the pattern of dashes and gaps used to stroke horizontal grid lines - */ - lineDashArray?: string; - - /** A pattern of lines and gaps that defines a set of horizontal gridlines - * @Default {[1.25, 18.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75]} - */ - linesInterval?: any[]; - - /** Specifies a set of intervals to snap the objects - * @Default {[20]} - */ - snapInterval?: any[]; -} - -export interface SnapSettingsVerticalGridLines { - - /** Defines the line color of horizontal grid lines - * @Default {lightgray} - */ - lineColor?: string; - - /** Specifies the pattern of dashes and gaps used to stroke horizontal grid lines - */ - lineDashArray?: string; - - /** A pattern of lines and gaps that defines a set of horizontal gridlines - * @Default {[1.25, 18.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75, 0.25, 19.75]} - */ - linesInterval?: any[]; - - /** Specifies a set of intervals to snap the objects - * @Default {[20]} - */ - snapInterval?: any[]; -} - -export interface SnapSettings { - - /** Enables or disables snapping nodes/connectors to objects - * @Default {true} - */ - enableSnapToObject?: boolean; - - /** Defines the appearance of horizontal gridlines - */ - horizontalGridLines?: SnapSettingsHorizontalGridLines; - - /** Defines the angle by which the object needs to be snapped - * @Default {5} - */ - snapAngle?: number; - - /** Defines and sets the snapConstraints - */ - snapConstraints?: ej.datavisualization.Diagram.SnapConstraints|string; - - /** Defines the minimum distance between the selected object and the nearest object - * @Default {5} - */ - snapObjectDistance?: number; - - /** Defines the appearance of horizontal gridlines - */ - verticalGridLines?: SnapSettingsVerticalGridLines; -} - -export interface TooltipAlignment { - - /** Defines the horizontal alignment of tooltip. - * @Default {ej.datavisualization.Diagram.HorizontalAlignment.Center} - */ - horizontal?: ej.datavisualization.Diagram.HorizontalAlignment|string; - - /** Defines the vertical alignment of tooltip. - * @Default {ej.datavisualization.Diagram.VerticalAlignment.Bottom} - */ - vertical?: ej.datavisualization.Diagram.VerticalAlignment|string; -} - -export interface Tooltip { - - /** Aligns the tooltip around nodes/connectors - */ - alignment?: TooltipAlignment; - - /** Sets the margin of the tooltip - * @Default {{ left: 5, right: 5, top: 5, bottom: 5 }} - */ - margin?: any; - - /** Defines whether the tooltip should be shown at the mouse position or around node. - * @Default {ej.datavisualization.Diagram.RelativeMode.Object} - */ - relativeMode?: ej.datavisualization.Diagram.RelativeMode|string; - - /** Sets the svg/html template to be bound with tooltip - */ - templateId?: string; -} -} -namespace Diagram { -enum ImageAlignment { -//Scales the graphic content non-uniformly to the width and height of the diagram area -None, -//Used to align the image at the top left of diagram area -XMinYMin, -//Used to align the image at the left center of diagram area -XMinYMid, -//Used to align the image at the bottom left of diagram area -XMinYMax, -//Used to align the image at the top center of diagram area -XMidYMin, -//Used to align the image at the center of diagram area -XMidYMid, -//Used to align the image at the bottom center of diagram area -XMidYMax, -//Used to align the image at the top right of diagram area/node -XMaxYMin, -//Used to align the image at the right center of diagram area/node -XMaxYMid, -//Used to align the image at the bottom right of diagram area/node -XMaxYMax, -} -} -namespace Diagram { -enum BridgeDirection { -//Used to set the direction of line bridges as left -Left, -//Used to set the direction of line bridges as right -Right, -//Used to set the direction of line bridges as top -Top, -//Used to set the direction of line bridges as bottom -Bottom, -} -} -namespace Diagram { -enum Keys { -//No key pressed. -None, -//The A key. -A, -//The B key. -B, -//The C key. -C, -//The D Key. -D, -//The E key. -E, -//The F key. -F, -//The G key. -G, -//The H Key. -H, -//The I key. -I, -//The J key. -J, -//The K key. -K, -//The L Key. -L, -//The M key. -M, -//The N key. -N, -//The O key. -O, -//The P Key. -P, -//The Q key. -Q, -//The R key. -R, -//The S key. -S, -//The T Key. -T, -//The U key. -U, -//The V key. -V, -//The W key. -W, -//The X key. -X, -//The Y key. -Y, -//The Z key. -Z, -//The 0 key. -Number0, -//The 1 key. -Number1, -//The 2 key. -Number2, -//The 3 key. -Number3, -//The 4 key. -Number4, -//The 5 key. -Number5, -//The 6 key. -Number6, -//The 7 key. -Number7, -//The 8 key. -Number8, -//The 9 key. -Number9, -//The LEFT ARROW key. -Left, -//The UP ARROW key. -Up, -//The RIGHT ARROW key. -Right, -//The DOWN ARROW key. -Down, -//The ESC key. -Escape, -//The DEL key. -Delete, -//The TAB key. -Tab, -//The ENTER key. -Enter, -} -} -namespace Diagram { -enum KeyModifiers { -//No modifiers are pressed. -None, -//The ALT key. -Alt, -//The CTRL key. -Control, -//The SHIFT key. -Shift, -} -} -namespace Diagram { -enum ConnectorConstraints { -//Disable all connector Constraints -None, -//Enables connector to be selected -Select, -//Enables connector to be Deleted -Delete, -//Enables connector to be Dragged -Drag, -//Enables connectors source end to be selected -DragSourceEnd, -//Enables connectors target end to be selected -DragTargetEnd, -//Enables control point and end point of every segment in a connector for editing -DragSegmentThumb, -//Enables bridging to the connector -Bridging, -//Enables label of node to be Dragged -DragLabel, -//Enables bridging to the connector -InheritBridging, -//Enables user interaction to the connector -PointerEvents, -//Enables the contrast between clean edges of connector over rendering speed and geometric precision -CrispEdges, -//Enables all constraints -Default, -} -} -namespace Diagram { -enum HorizontalAlignment { -//Used to align text horizontally on left side of node/connector -Left, -//Used to align text horizontally on center of node/connector -Center, -//Used to align text horizontally on right side of node/connector -Right, -} -} -namespace Diagram { -enum Alignment { -//Used to align the label either top or left(before) of the connector segment -Before, -//Used to align the label at center of the connector segment -Center, -//Used to align the label either bottom or right(after) of the connector segment -After, -} -} -namespace Diagram { -enum LabelRelativeMode { -//Sets the relativeMode as SegmentPath -SegmentPath, -//Sets the relativeMode as SegmentBounds -SegmentBounds, -} -} -namespace Diagram { -enum Segments { -//Used to specify the lines as Straight -Straight, -//Used to specify the lines as Orthogonal -Orthogonal, -//Used to specify the lines as Bezier -Bezier, -} -} -namespace Diagram { -enum ConnectorShapes { -//Used to specify connector type as BPMN -BPMN, -//Used to specify connector type as UMLClassifier -UMLClassifier, -//Used to specify connector type as UMLActivity -UMLActivity, -} -} -namespace Diagram { -enum BPMNFlows { -//Used to specify the Sequence flow in a BPMN Process -Sequence, -//Used to specify the Association flow in a BPMN Process -Association, -//Used to specify the Message flow in a BPMN Process -Message, -} -} -namespace Diagram { -enum AssociationFlows { -//Used to notate default association in a BPMN Process -Default, -//Used to notate directional association in a BPMN Process -Directional, -//User to notate bi-directional association in a BPMN Process -BiDirectional, -} -} -namespace Diagram { -enum BPMNMessageFlows { -//Used to notate the default message flow in a BPMN Process -Default, -//Used to notate the instantiating message flow in a BPMN Process -InitiatingMessage, -//Used to notate the non-instantiating message flow in a BPMN Process -NonInitiatingMessage, -} -} -namespace Diagram { -enum BPMNSequenceFlows { -//Used to notate the normal sequence flow in a BPMN Process -Normal, -//Used to notate the conditional sequence flow in a BPMN Process -Conditional, -//Used to notate the default sequence flow in a BPMN Process -Default, -} -} -namespace Diagram { -enum ClassifierShapes { -//Used to define a Class -Class, -//Used to define an Interface -Interface, -//Used to define an Enumeration -Enumeration, -//Used to notate association in UML Class Diagram -Association, -//Used to notate aggregation in a UML Class Diagram -Aggregation, -//Used to notate composition in a UML Class Diagram -Composition, -//Used to notate dependency in a UML Class Diagram -Dependency, -//Used to notate inheritance in a UML Class Diagram -Inheritance, -} -} -namespace Diagram { -enum Multiplicity { -//Each entity instance is related to a single instance of another entity -OneToOne, -//An entity instance can be related to multiple instances of the other entities -OneToMany, -//Multiple instances of an entity can be related to a single instance of the other entity -ManyToOne, -//The entity instances can be related to multiple instances of each other -ManyToMany, -} -} -namespace Diagram { -enum UMLActivityFlow { -//Defines a activity flow as Object in UML Activity Diagram -Object, -//Defines a activity flow as Control in UML Activity Diagram -Control, -//Defines a activity flow as Exception in UML Activity Diagram -Exception, -} -} -namespace Diagram { -enum DecoratorShapes { -//Used to set decorator shape as none -None, -//Used to set decorator shape as Arrow -Arrow, -//Used to set decorator shape as Open Arrow -OpenArrow, -//Used to set decorator shape as Circle -Circle, -//Used to set decorator shape as Diamond -Diamond, -//Used to set decorator shape as path -Path, -} -} -namespace Diagram { -enum VerticalAlignment { -//Used to align text Vertically on left side of node/connector -Top, -//Used to align text Vertically on center of node/connector -Center, -//Used to align text Vertically on bottom of node/connector -Bottom, -} -} -namespace Diagram { -enum DiagramConstraints { -//Disables all DiagramConstraints -None, -//Enables/Disables PageEditing -PageEditable, -//Enables/Disables Bridging -Bridging, -//Enables/Disables Zooming -Zoomable, -//Enables/Disables panning on horizontal axis -PannableX, -//Enables/Disables panning on vertical axis -PannableY, -//Enables/Disables Panning -Pannable, -//Enables/Disables undo actions -Undoable, -//Enables/Disables the sharp edges -CrispEdges, -//Enables all Constraints -Default, -} -} -namespace Diagram { -enum LabelRenderingMode { -//Sets the labelRenderingMode as Html -Html, -//Sets the labelRenderingMode as Svg -Svg, -} -} -namespace Diagram { -enum LayoutOrientations { -//Used to set LayoutOrientation from top to bottom -TopToBottom, -//Used to set LayoutOrientation from bottom to top -BottomToTop, -//Used to set LayoutOrientation from left to right -LeftToRight, -//Used to set LayoutOrientation from right to left -RightToLeft, -} -} -namespace Diagram { -enum LayoutTypes { -//Used not to set any specific layout -None, -//Used to set layout type as hierarchical layout -HierarchicalTree, -//Used to set layout type as organnizational chart -OrganizationalChart, -} -} -namespace Diagram { -enum BPMNActivity { -//Used to set BPMN Activity as None -None, -//Used to set BPMN Activity as Task -Task, -//Used to set BPMN Activity as SubProcess -SubProcess, -} -} -namespace Diagram { -enum BPMNAnnotationDirection { -//Used to set the direction of BPMN Annotation as left -Left, -//Used to set the direction of BPMN Annotation as right -Right, -//Used to set the direction of BPMN Annotation as top -Top, -//Used to set the direction of BPMN Annotation as bottom -Bottom, -} -} -namespace Diagram { -enum IconShapes { -//Used to set collapse icon shape as none -None, -//Used to set collapse icon shape as Arrow(Up/Down) -Arrow, -//Used to set collapse icon shape as Plus -Plus, -//Used to set collapse icon shape as Minus -Minus, -//Used to set collapse icon shape as path -Path, -//Used to set icon shape as template -Template, -//Used to set icon shape as image -Image, -} -} -namespace Diagram { -enum NodeConstraints { -//Disable all node Constraints -None, -//Enables node to be selected -Select, -//Enables node to be Deleted -Delete, -//Enables node to be Dragged -Drag, -//Enables node to be Rotated -Rotate, -//Enables node to be connected -Connect, -//Enables node to be resize north east -ResizeNorthEast, -//Enables node to be resize east -ResizeEast, -//Enables node to be resize south east -ResizeSouthEast, -//Enables node to be resize south -ResizeSouth, -//Enables node to be resize south west -ResizeSouthWest, -//Enables node to be resize west -ResizeWest, -//Enables node to be resize north west -ResizeNorthWest, -//Enables node to be resize north -ResizeNorth, -//Enables node to be Resized -Resize, -//Enables shadow -Shadow, -//Enables label of node to be Dragged -DragLabel, -//Enables panning should be done while node dragging -AllowPan, -//Enables Proportional resize for node -AspectRatio, -//Enables the user interaction with the node -PointerEvents, -//Enables contrast between clean edges for the node over rendering speed and geometric precision -CrispEdges, -//Enables all node constraints -Default, -} -} -namespace Diagram { -enum ContainerType { -//Sets the container type as Canvas -Canvas, -//Sets the container type as Stack -Stack, -} -} -namespace Diagram { -enum BPMNDataObjects { -//Used to notate the Input type BPMN data object -Input, -//Used to notate the Output type BPMN data object -Output, -//Used to set BPMN data object type as None -None, -} -} -namespace Diagram { -enum BPMNEvents { -//Used to set BPMN Event as Start -Start, -//Used to set BPMN Event as Intermediate -Intermediate, -//Used to set BPMN Event as End -End, -//Used to set BPMN Event as NonInterruptingStart -NonInterruptingStart, -//Used to set BPMN Event as NonInterruptingIntermediate -NonInterruptingIntermediate, -//Used to set BPMN Event as ThrowingIntermediate -ThrowingIntermediate, -} -} -namespace Diagram { -enum BPMNGateways { -//Used to set BPMN Gateway as None -None, -//Used to set BPMN Gateway as Exclusive -Exclusive, -//Used to set BPMN Gateway as Inclusive -Inclusive, -//Used to set BPMN Gateway as Parallel -Parallel, -//Used to set BPMN Gateway as Complex -Complex, -//Used to set BPMN Gateway as EventBased -EventBased, -//Used to set BPMN Gateway as ExclusiveEventBased -ExclusiveEventBased, -//Used to set BPMN Gateway as ParallelEventBased -ParallelEventBased, -} -} -namespace Diagram { -enum LabelEditMode { -//Used to set label edit mode as edit -Edit, -//Used to set label edit mode as view -View, -} -} -namespace Diagram { -enum OverflowType { -//Set overflow Type as ellipsis -Ellipsis, -//Set overflow Type as Clip -Clip, -} -} -namespace Diagram { -enum TextAlign { -//Used to align text on left side of node/connector -Left, -//Used to align text on center of node/connector -Center, -//Used to align text on Right side of node/connector -Right, -} -} -namespace Diagram { -enum TextDecorations { -//Used to set text decoration of the label as Underline -Underline, -//Used to set text decoration of the label as Overline -Overline, -//Used to set text decoration of the label as LineThrough -LineThrough, -//Used to set text decoration of the label as None -None, -} -} -namespace Diagram { -enum TextWrapping { -//Disables wrapping -NoWrap, -//Enables Line-break at normal word break points -Wrap, -//Enables Line-break at normal word break points with longer word overflows -WrapWithOverflow, -} -} -namespace Diagram { -enum PortConstraints { -//Disable all constraints -None, -//Enables connections with connector -Connect, -//Enables to create the connection when mouse hover on the port. -ConnectOnDrag, -} -} -namespace Diagram { -enum PortShapes { -//Used to set port shape as X -X, -//Used to set port shape as Circle -Circle, -//Used to set port shape as Square -Square, -//Used to set port shape as Path -Path, -} -} -namespace Diagram { -enum PortVisibility { -//Set the port visibility as Visible -Visible, -//Set the port visibility as Hidden -Hidden, -//Port get visible when hover connector on node -Hover, -//Port gets visible when connect connector to node -Connect, -//Specifies the port visibility as default -Default, -} -} -namespace Diagram { -enum BasicShapes { -//Used to specify node Shape as Rectangle -Rectangle, -//Used to specify node Shape as Ellipse -Ellipse, -//Used to specify node Shape as Path -Path, -//Used to specify node Shape as Polygon -Polygon, -//Used to specify node Shape as Triangle -Triangle, -//Used to specify node Shape as Plus -Plus, -//Used to specify node Shape as Star -Star, -//Used to specify node Shape as Pentagon -Pentagon, -//Used to specify node Shape as Heptagon -Heptagon, -//Used to specify node Shape as Octagon -Octagon, -//Used to specify node Shape as Trapezoid -Trapezoid, -//Used to specify node Shape as Decagon -Decagon, -//Used to specify node Shape as RightTriangle -RightTriangle, -//Used to specify node Shape as Cylinder -Cylinder, -} -} -namespace Diagram { -enum FlowShapes { -//Used to specify node Shape as Process -Process, -//Used to specify node Shape as Decision -Decision, -//Used to specify node Shape as Document -Document, -//Used to specify node Shape as PreDefinedProcess -PreDefinedProcess, -//Used to specify node Shape as Terminator -Terminator, -//Used to specify node Shape as PaperTap -PaperTap, -//Used to specify node Shape as DirectData -DirectData, -//Used to specify node Shape as SequentialData -SequentialData, -//Used to specify node Shape as Sort -Sort, -//Used to specify node Shape as MultiDocument -MultiDocument, -//Used to specify node Shape as Collate -Collate, -//Used to specify node Shape as SummingJunction -SummingJunction, -//Used to specify node Shape as Or -Or, -//Used to specify node Shape as InternalStorage -InternalStorage, -//Used to specify node Shape as Extract -Extract, -//Used to specify node Shape as ManualOperation -ManualOperation, -//Used to specify node Shape as Merge -Merge, -//Used to specify node Shape as OffPageReference -OffPageReference, -//Used to specify node Shape as SequentialAccessStorage -SequentialAccessStorage, -//Used to specify node Shape as Annotation1 -Annotation1, -//Used to specify node Shape as Annotation2 -Annotation2, -//Used to specify node Shape as Data -Data, -//Used to specify node Shape as Card -Card, -} -} -namespace Diagram { -enum BPMNShapes { -//Used to specify node Shape as Event -Event, -//Used to specify node Shape as Gateway -Gateway, -//Used to specify node Shape as Message -Message, -//Used to specify node Shape as DataObject -DataObject, -//Used to specify node Shape as DataSource -DataSource, -//Used to specify node Shape as Activity -Activity, -//Used to specify node Shape as Group -Group, -} -} -namespace Diagram { -enum UMLActivityShapes { -//Used to set UML ActivityShapes as Action -Action, -//Used to set UML ActivityShapes as Decision -Decision, -//Used to set UML ActivityShapes as MergeNode -MergeNode, -//Used to set UML ActivityShapes as InitialNode -InitialNode, -//Used to set UML ActivityShapes as FinalNode -FinalNode, -//Used to set UML ActivityShapes as ForkNode -ForkNode, -//Used to set UML ActivityShapes as JoinNode -JoinNode, -//Used to set UML ActivityShapes as TimeEvent -TimeEvent, -//Used to set UML ActivityShapes as AcceptingEvent -AcceptingEvent, -//Used to set UML ActivityShapes as SendSignal -SendSignal, -//Used to set UML ActivityShapes as ReceiveSignal -ReceiveSignal, -//Used to set UML ActivityShapes as StructuredNode -StructuredNode, -//Used to set UML ActivityShapes as Note -Note, -} -} -namespace Diagram { -enum BPMNBoundary { -//Used to set BPMN SubProcess's Boundary as Default -Default, -//Used to set BPMN SubProcess's Boundary as Call -Call, -//Used to set BPMN SubProcess's Boundary as Event -Event, -} -} -namespace Diagram { -enum BPMNLoops { -//Used to set BPMN Activity's Loop as None -None, -//Used to set BPMN Activity's Loop as Standard -Standard, -//Used to set BPMN Activity's Loop as ParallelMultiInstance -ParallelMultiInstance, -//Used to set BPMN Activity's Loop as SequenceMultiInstance -SequenceMultiInstance, -} -} -namespace Diagram { -enum BPMNSubProcessTypes { -//Used to set BPMN SubProcess type as None -None, -//Used to set BPMN SubProcess type as Transaction -Transaction, -//Used to set BPMN SubProcess type as Event -Event, -} -} -namespace Diagram { -enum BPMNTasks { -//Used to set BPMN Task Type as None -None, -//Used to set BPMN Task Type as Service -Service, -//Used to set BPMN Task Type as Receive -Receive, -//Used to set BPMN Task Type as Send -Send, -//Used to set BPMN Task Type as InstantiatingReceive -InstantiatingReceive, -//Used to set BPMN Task Type as Manual -Manual, -//Used to set BPMN Task Type as BusinessRule -BusinessRule, -//Used to set BPMN Task Type as User -User, -//Used to set BPMN Task Type as Script -Script, -//Used to set BPMN Task Type as Parallel -Parallel, -} -} -namespace Diagram { -enum BPMNTriggers { -//Used to set Event Trigger as None -None, -//Used to set Event Trigger as Message -Message, -//Used to set Event Trigger as Timer -Timer, -//Used to set Event Trigger as Escalation -Escalation, -//Used to set Event Trigger as Link -Link, -//Used to set Event Trigger as Error -Error, -//Used to set Event Trigger as Compensation -Compensation, -//Used to set Event Trigger as Signal -Signal, -//Used to set Event Trigger as Multiple -Multiple, -//Used to set Event Trigger as Parallel -Parallel, -//Used to set Event Trigger as Conditional -Conditional, -//Used to set Event Trigger as Termination -Termination, -//Used to set Event Trigger as Cancel -Cancel, -} -} -namespace Diagram { -enum Shapes { -//Used to specify node type as Text -Text, -//Used to specify node type as Image -Image, -//Used to specify node type as Html -Html, -//Used to specify node type as Native -Native, -//Used to specify node type as Basic -Basic, -//Used to specify node type as Flow -Flow, -//Used to specify node type as BPMN -BPMN, -//Used to specify node type as UMLClassifier -UMLClassifier, -//Used to specify node type as UMLActivity -UMLActivity, -} -} -namespace Diagram { -enum PageOrientations { -//Used to set orientation as Landscape -Landscape, -//Used to set orientation as portrait -Portrait, -} -} -namespace Diagram { -enum ScrollLimit { -//Used to set scrollLimit as Infinite -Infinite, -//Used to set scrollLimit as Diagram -Diagram, -//Used to set scrollLimit as Limited -Limited, -} -} -namespace Diagram { -enum BoundaryConstraints { -//Used to set boundaryConstraints as Infinite -Infinite, -//Used to set boundaryConstraints as Diagram -Diagram, -//Used to set boundaryConstraints as Page -Page, -} -} -namespace Diagram { -enum SelectorConstraints { -//Hides the selector -None, -//Sets the visibility of rotation handle as visible -Rotator, -//Sets the visibility of resize handles as visible -Resizer, -//Sets the visibility of user handles as visible -UserHandles, -//Sets the visibility of all selection handles as visible -All, -} -} -namespace Diagram { -enum UserHandlePositions { -//Set the position of the userhandle as topleft -TopLeft, -//Set the position of the userhandle as topcenter -TopCenter, -//Set the position of the userhandle as topright -TopRight, -//Set the position of the userhandle as middleleft -MiddleLeft, -//Set the position of the userhandle as middleright -MiddleRight, -//Set the position of the userhandle as bottomleft -BottomLeft, -//Set the position of the userhandle as bottomcenter -BottomCenter, -//Set the position of the userhandle as bottom right -BottomRight, -} -} -namespace Diagram { -enum SnapConstraints { -//Enables node to be snapped to horizontal gridlines -None, -//Enables node to be snapped to vertical gridlines -SnapToHorizontalLines, -//Enables node to be snapped to horizontal gridlines -SnapToVerticalLines, -//Enables node to be snapped to gridlines -SnapToLines, -//Enable horizontal lines -ShowHorizontalLines, -//Enable vertical lines -ShowVerticalLines, -//Enable both horizontal and vertical lines -ShowLines, -//Enable all the constraints -All, -} -} -namespace Diagram { -enum Tool { -//Disables all Tools -None, -//Enables/Disables SingleSelect tool -SingleSelect, -//Enables/Disables MultiSelect tool -MultipleSelect, -//Enables/Disables ZoomPan tool -ZoomPan, -//Enables/Disables DrawOnce tool -DrawOnce, -//Enables/Disables ContinuousDraw tool -ContinuesDraw, -} -} -namespace Diagram { -enum RelativeMode { -//Shows tooltip around the node -Object, -//Shows tooltip at the mouse position -Mouse, -} -} -namespace Diagram { -enum ZoomCommand { -//Used to zoom in the Diagram -ZoomIn, -//Used to zoom out the diagram -ZoomOut, -} -} - -class HeatMap extends ej.Widget { - static fn: HeatMap; - constructor(element: JQuery | Element, options?: HeatMap.Model); - static Locale: any; - model: HeatMap.Model; - defaults: HeatMap.Model; -} -export namespace HeatMap { - -export interface Model { - - /** Specifies the width of the heat map. - * @Default {null} - */ - width?: any; - - /** Specifies the width of the heat map. - * @Default {null} - */ - height?: any; - - /** Specifies the name of the heat map. - * @Default {null} - */ - id?: number; - - /** Enables or disables tooltip of heatmap - * @Default {true} - */ - showTooltip?: boolean; - - /** Defines the tooltip that should be shown when the mouse hovers over rows/columns. - */ - tooltipSettings?: TooltipSettings; - - /** Specifies the source data of the heat map. - * @Default {[]} - */ - itemsSource?: any; - - /** Specifies the property of the heat map cell. - * @Default {Null} - */ - heatMapCell?: HeatMapCell; - - /** Specifies can enable responsive mode or not for heat map. - * @Default {false} - */ - isResponsive?: boolean; - - /** Specifies whether the virtualization can be enable or not. - * @Default {false} - */ - enableVirtualization?: boolean; - - /** Specifies the default column properties for all the column style not specified in column properties. - * @Default {[]} - */ - defaultColumnStyle?: DefaultColumnStyle; - - /** Specifies the no of legends can sync with heat map. - * @Default {[]} - */ - legendCollection?: any[]; - - /** Specifies the property and display value of the heat map column. - * @Default {[]} - */ - itemsMapping?: ItemsMapping; - - /** Specifies the color values of the heat map column data. - * @Default {[]} - */ - colorMappingCollection?: ColorMappingCollection[]; - - /** Triggered when the mouse over on the cell. */ - cellMouseOver?(e: CellMouseOverEventArgs): void; - - /** Triggered when the mouse over on the cell. */ - cellMouseEnter?(e: CellMouseEnterEventArgs): void; - - /** Triggered when the mouse over on the cell. */ - cellMouseLeave?(e: CellMouseLeaveEventArgs): void; - - /** Triggered when the mouse over on the cell. */ - cellSelected?(e: CellSelectedEventArgs): void; -} - -export interface CellMouseOverEventArgs { - - /** Value displayed on the cell - */ - cellValue?: string; - - /** Returns the HeatMap cell data - */ - source?: any; - - /** Returns the specific HeatMap cell - */ - cell?: any; -} - -export interface CellMouseEnterEventArgs { - - /** Value displayed on the cell - */ - cellValue?: string; - - /** Returns the HeatMap cell data - */ - source?: any; - - /** Returns the specific HeatMap cell - */ - cell?: any; -} - -export interface CellMouseLeaveEventArgs { - - /** Value displayed on the cell - */ - cellValue?: string; - - /** Returns the HeatMap cell data - */ - source?: any; - - /** Returns the specific HeatMap cell - */ - cell?: any; -} - -export interface CellSelectedEventArgs { - - /** Value displayed on the cell - */ - cellValue?: string; - - /** Returns the HeatMap cell data - */ - source?: any; - - /** Returns the specific HeatMap cell - */ - cell?: any; -} - -export interface TooltipSettingsPositionTarget { + /** Sets the arrow position again popup based on horizontal(x) value + * @Default {center} + */ + horizontal?: ej.datavisualization.HeatMap.Horizontal | string; - /** Sets the arrow position again popup based on horizontal(x) value - * @Default {center} - */ - horizontal?: ej.datavisualization.HeatMap.Horizontal|string; + /** Sets the arrow position again popup based on vertical(y) value + * @Default {bottom} + */ + vertical?: ej.datavisualization.HeatMap.Vertical | string; + } - /** Sets the arrow position again popup based on vertical(y) value - * @Default {top} - */ - vertical?: ej.datavisualization.HeatMap.Vertical|string; -} + export interface TooltipSettingsPosition { -export interface TooltipSettingsPositionStem { + /** Sets the Tooltip position against target. + */ + target?: TooltipSettingsPositionTarget; - /** Sets the arrow position again popup based on horizontal(x) value - * @Default {center} - */ - horizontal?: ej.datavisualization.HeatMap.Horizontal|string; + /** Sets the arrow position again popup. + */ + stem?: TooltipSettingsPositionStem; + } - /** Sets the arrow position again popup based on vertical(y) value - * @Default {bottom} - */ - vertical?: ej.datavisualization.HeatMap.Vertical|string; -} + export interface TooltipSettingsAnimation { -export interface TooltipSettingsPosition { + /** Defines the animation effect for the tooltip that should be shown when the mouse hovers over rows/columns. + * @Default {none} + */ + effect?: ej.datavisualization.HeatMap.Effect | string; - /** Sets the Tooltip position against target. - */ - target?: TooltipSettingsPositionTarget; + /** Defines the animation speed for the tooltip that should be shown when the mouse hovers over rows/columns. + * @Default {0} + */ + speed?: number; + } - /** Sets the arrow position again popup. - */ - stem?: TooltipSettingsPositionStem; -} + export interface TooltipSettings { + + /** Defines the tooltip that should be shown when the mouse hovers over rows/columns. + * @Default {null} + */ + templateId?: string; -export interface TooltipSettingsAnimation { + /** Defines the tooltip of associate that should be shown when the mouse hovers over rows/columns. + * @Default {mouseFollow} + */ + associate?: ej.datavisualization.HeatMap.Associate | string; + + /** Enables/ disables the balloon for the tooltip to be shown + * @Default {true} + */ + isBalloon?: boolean; - /** Defines the animation effect for the tooltip that should be shown when the mouse hovers over rows/columns. - * @Default {none} - */ - effect?: ej.datavisualization.HeatMap.Effect|string; + /** Defines various attributes of the Tooltip position + */ + position?: TooltipSettingsPosition; - /** Defines the animation speed for the tooltip that should be shown when the mouse hovers over rows/columns. - * @Default {0} - */ - speed?: number; -} + /** Defines the tooltip to be triggered. + * @Default {hover} + */ + trigger?: ej.datavisualization.HeatMap.Trigger | string; -export interface TooltipSettings { - - /** Defines the tooltip that should be shown when the mouse hovers over rows/columns. - * @Default {null} - */ - templateId?: string; + /** Defines the animation for the tooltip that should be shown when the mouse hovers over rows/columns. + */ + animation?: TooltipSettingsAnimation; + } + + export interface HeatMapCell { - /** Defines the tooltip of associate that should be shown when the mouse hovers over rows/columns. - * @Default {mouseFollow} - */ - associate?: ej.datavisualization.HeatMap.Associate|string; - - /** Enables/ disables the balloon for the tooltip to be shown - * @Default {true} - */ - isBalloon?: boolean; + /** Specifies whether the cell content can be visible or not. + * @Default {ej.HeatMap.CellVisibility.Visible} + */ + showContent?: ej.datavisualization.HeatMap.CellVisibility | string; + + /** Specifies whether the cell color can be visible or not. + * @Default {true} + */ + showColor?: boolean; + } + + export interface DefaultColumnStyle { + + /** Specifies the alignment mode of the heat map column. + * @Default {ej.HeatMap.TextAlign.Center} + */ + textAlign?: any; + + /** Specifies the template id of the heat map column header. + */ + headerTemplateID?: string; + + /** Specifies the template id of all individual cell data of the heat map. + */ + templateID?: string; + } + + export interface ItemsMappingColumnStyle { + + /** Specifies the width of the heat map column. + * @Default {0} + */ + width?: number; + + /** Specifies the text align mode of the heat map column. + * @Default {ej.HeatMap.TextAlign.Center} + */ + textAlign?: string; + + /** Specifies the template id of the column header. + */ + headerTemplateID?: string; + + /** Specifies the template id of all individual cell data. + */ + templateID?: string; + } + + export interface ItemsMappingColumn { + + /** Specifies the name of the column or row. + */ + propertyName?: string; + + /** Specifies the value of the column or row. + */ + displayName?: string; + } + + export interface ItemsMappingRow { + + /** Specifies the name of the column or row. + */ + propertyName?: string; + + /** Specifies the value of the column or row. + */ + displayName?: string; + } + + export interface ItemsMappingValue { + + /** Specifies the name of the column or row. + */ + propertyName?: string; + + /** Specifies the value of the column or row. + */ + displayName?: string; + } + + export interface ItemsMappingHeaderMapping { + + /** Specifies the name of the column or row. + */ + propertyName?: string; + + /** Specifies the value of the column or row. + */ + displayName?: string; + + /** Specifies the property and display value of the header. + * @Default {null} + */ + columnStyle?: any; + } + + export interface ItemsMapping { + + /** Column settings for the individual heat map column. + * @Default {null} + */ + columnStyle?: ItemsMappingColumnStyle; + + /** Specifies the property and display value of the column. + * @Default {null} + */ + column?: ItemsMappingColumn; + + /** Specifies the property and display value of the heat map.row + * @Default {null} + */ + row?: ItemsMappingRow; + + /** Specifies the property and display value of the column value. + * @Default {null} + */ + value?: ItemsMappingValue; + + /** Specifies the property and display value of the header. + * @Default {null} + */ + headerMapping?: ItemsMappingHeaderMapping; + + /** Specifies the property and display value of the collection of column. + * @Default {[]} + */ + columnMapping?: any[]; + } + + export interface ColorMappingCollectionLabel { + + /** Enables/disables the bold style of the heat map label. + * @Default {false} + */ + bold?: boolean; + + /** Enables/disables the italic style of the heat map label. + * @Default {false} + */ + italic?: boolean; + + /** specifies the text value of the heat map label. + */ + text?: string; + + /** Specifies the text style of the heat map label. + * @Default {ej.HeatMap.TextDecoration.None} + */ + textDecoration?: ej.datavisualization.HeatMap.TextDecoration | string; + + /** Specifies the font size of the heat map label. + * @Default {10} + */ + fontSize?: number; + + /** Specifies the font family of the heat map label. + * @Default {Arial} + */ + fontFamily?: string; + + /** Specifies the font color of the heat map label. + * @Default {black} + */ + fontColor?: string; + } + + export interface ColorMappingCollection { + + /** Specifies the color of the heat map column data. + * @Default {white} + */ + color?: string; + + /** Specifies the color values of the heat map column data. + * @Default {0} + */ + value?: number; + + /** Specifies the label properties of the heat map color. + * @Default {null} + */ + label?: ColorMappingCollectionLabel; + } + } + namespace HeatMap { + enum Associate { + //Used to set the associate of tooltip as Target + Target, + //Used to set the associate of tooltip as MouseFollow + MouseFollow, + //Used to set the associate of tooltip as MouseEnter + MouseEnter, + } + } + namespace HeatMap { + enum Horizontal { + //Used to display the tooltip horizontally on left side of rows/columns + Left, + //Used to display the tooltip horizontally on center side of rows/columns + Center, + //Used to display the tooltip horizontally on right side of rows/columns + Right, + } + } + namespace HeatMap { + enum Vertical { + //Used to display the tooltip horizontally on left side of rows/columns + Top, + //Used to display the tooltip horizontally on center side of rows/columns + Center, + //Used to display the tooltip horizontally on right side of rows/columns + Bottom, + } + } + namespace HeatMap { + enum Trigger { + //Tooltip can be triggered on mouse hovers + Hover, + //Tooltip can be triggered on mouse click + Click, + } + } + namespace HeatMap { + enum Effect { + //Sets tooltip animation as None + None, + //Sets tooltip animation as Fade + Fade, + //Sets tooltip animation as Slide + Slide, + } + } + namespace HeatMap { + enum CellVisibility { + //Display the content of the cell + Visible, + //Hide the content of the cell + Hidden, + } + } + namespace HeatMap { + enum TextDecoration { + //Defines a line below the text + Underline, + //Defines a line above the text + Overline, + //Defines a line through the text + LineThrough, + //Defines a normal text. This is default + None, + } + } + + class HeatMapLegend extends ej.Widget { + static fn: HeatMapLegend; + constructor(element: JQuery | Element, options?: HeatMapLegend.Model); + static Locale: any; + model: HeatMapLegend.Model; + defaults: HeatMapLegend.Model; + } + export namespace HeatMapLegend { + + export interface Model { + + /** Specifies the width of the heatmap legend. + * @Default {null} + */ + width?: any; + + /** Specifies the height of the heatmap legend. + * @Default {null} + */ + height?: any; + + /** Specifies can enable responsive mode or not for heatmap legend. + * @Default {false} + */ + isResponsive?: boolean; + + /** Specifies whether the cell label can be shown or not. + * @Default {false} + */ + showLabel?: boolean; + + /** Specifies the color values of the column data. + * @Default {[]} + */ + colorMappingCollection?: ColorMappingCollection[]; + + /** Specifies the orientation of the heatmap legend + * @Default {ej.HeatMap.LegendOrientation.Horizontal} + */ + orientation?: ej.datavisualization.HeatMap.LegendOrientation | string; + + /** Specifies the legend mode as gradient or list. + * @Default {ej.HeatMap.LegendMode.Gradient} + */ + legendMode?: ej.datavisualization.HeatMap.LegendMode | string; + } + + export interface ColorMappingCollectionLabel { + + /** Enables/disables the bold style of the heatmap legend label. + * @Default {false} + */ + bold?: boolean; + + /** Enables/disables the italic style of the heatmap legend label. + * @Default {false} + */ + italic?: boolean; + + /** specifies the text value of the heatmap legend label. + */ + text?: string; + + /** Specifies the text style of the heatmap legend label. + * @Default {ej.HeatMap.TextDecoration.None} + */ + textDecoration?: ej.datavisualization.HeatMap.TextDecoration | string; + + /** Specifies the font size of the heatmap legend label. + * @Default {10} + */ + fontSize?: number; + + /** Specifies the font family of the heatmap legend label. + * @Default {Arial} + */ + fontFamily?: string; + + /** Specifies the font color of the heatmap legend label. + * @Default {black} + */ + fontColor?: string; + } + + export interface ColorMappingCollection { + + /** Specifies the color of the heatmap legend data. + * @Default {white} + */ + color?: string; + + /** Specifies the color values of the heatmap legend column data. + * @Default {0} + */ + value?: number; + + /** Specifies the label properties of the heatmap legend color. + * @Default {null} + */ + label?: ColorMappingCollectionLabel; + } + } + namespace HeatMap { + enum LegendOrientation { + //Scales the graphic content non-uniformly to the width and height of the diagram area + Horizontal, + //Used to align the image at the top left of diagram area + Vertical, + } + } + namespace HeatMap { + enum LegendMode { + //Scales the graphic content non-uniformly to the width and height of the diagram area + Gradient, + //Used to align the image at the top left of diagram area + List, + } + } + + class Sparkline extends ej.Widget { + static fn: Sparkline; + constructor(element: JQuery | Element, options?: Sparkline.Model); + static Locale: any; + model: Sparkline.Model; + defaults: Sparkline.Model; + + /** Redraws the entire sparkline. You can call this method whenever you update, add or remove points from the data source or whenever you want to refresh the UI. + * @returns {void} + */ + redraw(): void; + } + export namespace Sparkline { + + export interface Model { + + /** Background color of the plot area. + * @Default {transparent} + */ + background?: string; + + /** Fill color for the sparkline series. + * @Default {#33ccff} + */ + fill?: string; + + /** Border color of the series. + * @Default {null} + */ + stroke?: string; + + /** Options for customizing the color, opacity and width of the sparkline border. + */ + border?: Border; + + /** Border width of the series. + * @Default {1} + */ + width?: number; + + /** Opacity of the series. + * @Default {1} + */ + opacity?: number; + + /** Color for series high point. + * @Default {null} + */ + highPointColor?: string; + + /** Color for series low point. + * @Default {null} + */ + lowPointColor?: string; + + /** Color for series start point. + * @Default {null} + */ + startPointColor?: string; + + /** Color for series end point. + * @Default {null} + */ + endPointColor?: string; + + /** Color for series negative point. + * @Default {null} + */ + negativePointColor?: string; + + /** Options for customizing the color, opacity of the sparkline start and end range. + */ + rangeBandSettings?: RangeBandSettings; + + /** Name of a field in data source, where the fill color for all the data points is generated. + */ + palette?: string; + + /** Controls whether sparkline has to be responsive or not. + * @Default {true} + */ + isResponsive?: boolean; + + /** Controls whether Sparkline has to be rendered as Canvas or SVG.Canvas rendering supports all functionalities in SVG rendering. + * @Default {false} + */ + enableCanvasRendering?: boolean; + + /** Specifies the dataSource for the series. It can be an array of JSON objects or an instance of ej.DataManager. + * @Default {null} + */ + dataSource?: any; + + /** Name of the property in the datasource that contains x value for the series. + * @Default {null} + */ + xName?: string; + + /** Name of the property in the datasource that contains y value for the series. + * @Default {null} + */ + yName?: string; + + /** Gap or padding for sparkline. + * @Default {8} + */ + padding?: number; + + /** Specifies the type of the series to render in sparkline. + * @Default {line. See Type} + */ + type?: ej.datavisualization.Sparkline.Type | string; + + /** Specifies the theme for Sparkline. + * @Default {Flatlight. See Theme} + */ + theme?: ej.datavisualization.Sparkline.Theme | string; + + /** Options to customize the tooltip. + */ + tooltip?: Tooltip; + + /** Options for displaying and customizing marker for a data point. + */ + markerSettings?: MarkerSettings; - /** Defines various attributes of the Tooltip position - */ - position?: TooltipSettingsPosition; + /** Options to customize the Sparkline size. + */ + size?: Size; - /** Defines the tooltip to be triggered. - * @Default {hover} - */ - trigger?: ej.datavisualization.HeatMap.Trigger|string; + /** Options for customizing the color,dashArray and width of the axisLine. + */ + axisLineSettings?: AxisLineSettings; - /** Defines the animation for the tooltip that should be shown when the mouse hovers over rows/columns. - */ - animation?: TooltipSettingsAnimation; -} - -export interface HeatMapCell { + /** Fires before loading the sparkline. */ + load?(e: LoadEventArgs): void; + + /** Fires after loaded the sparkline. */ + loaded?(e: LoadedEventArgs): void; - /** Specifies whether the cell content can be visible or not. - * @Default {ej.HeatMap.CellVisibility.Visible} - */ - showContent?: ej.datavisualization.HeatMap.CellVisibility|string; - - /** Specifies whether the cell color can be visible or not. - * @Default {true} - */ - showColor?: boolean; -} - -export interface DefaultColumnStyle { - - /** Specifies the alignment mode of the heat map column. - * @Default {ej.HeatMap.TextAlign.Center} - */ - textAlign?: any; - - /** Specifies the template id of the heat map column header. - */ - headerTemplateID?: string; - - /** Specifies the template id of all individual cell data of the heat map. - */ - templateID?: string; -} - -export interface ItemsMappingColumnStyle { - - /** Specifies the width of the heat map column. - * @Default {0} - */ - width?: number; - - /** Specifies the text align mode of the heat map column. - * @Default {ej.HeatMap.TextAlign.Center} - */ - textAlign?: string; - - /** Specifies the template id of the column header. - */ - headerTemplateID?: string; - - /** Specifies the template id of all individual cell data. - */ - templateID?: string; -} - -export interface ItemsMappingColumn { - - /** Specifies the name of the column or row. - */ - propertyName?: string; - - /** Specifies the value of the column or row. - */ - displayName?: string; -} - -export interface ItemsMappingRow { - - /** Specifies the name of the column or row. - */ - propertyName?: string; - - /** Specifies the value of the column or row. - */ - displayName?: string; -} - -export interface ItemsMappingValue { - - /** Specifies the name of the column or row. - */ - propertyName?: string; - - /** Specifies the value of the column or row. - */ - displayName?: string; -} - -export interface ItemsMappingHeaderMapping { - - /** Specifies the name of the column or row. - */ - propertyName?: string; - - /** Specifies the value of the column or row. - */ - displayName?: string; - - /** Specifies the property and display value of the header. - * @Default {null} - */ - columnStyle?: any; -} - -export interface ItemsMapping { - - /** Column settings for the individual heat map column. - * @Default {null} - */ - columnStyle?: ItemsMappingColumnStyle; - - /** Specifies the property and display value of the column. - * @Default {null} - */ - column?: ItemsMappingColumn; - - /** Specifies the property and display value of the heat map.row - * @Default {null} - */ - row?: ItemsMappingRow; - - /** Specifies the property and display value of the column value. - * @Default {null} - */ - value?: ItemsMappingValue; - - /** Specifies the property and display value of the header. - * @Default {null} - */ - headerMapping?: ItemsMappingHeaderMapping; - - /** Specifies the property and display value of the collection of column. - * @Default {[]} - */ - columnMapping?: any[]; -} - -export interface ColorMappingCollectionLabel { - - /** Enables/disables the bold style of the heat map label. - * @Default {false} - */ - bold?: boolean; - - /** Enables/disables the italic style of the heat map label. - * @Default {false} - */ - italic?: boolean; - - /** specifies the text value of the heat map label. - */ - text?: string; - - /** Specifies the text style of the heat map label. - * @Default {ej.HeatMap.TextDecoration.None} - */ - textDecoration?: ej.datavisualization.HeatMap.TextDecoration |string; - - /** Specifies the font size of the heat map label. - * @Default {10} - */ - fontSize?: number; - - /** Specifies the font family of the heat map label. - * @Default {Arial} - */ - fontFamily?: string; - - /** Specifies the font color of the heat map label. - * @Default {black} - */ - fontColor?: string; -} - -export interface ColorMappingCollection { - - /** Specifies the color of the heat map column data. - * @Default {white} - */ - color?: string; - - /** Specifies the color values of the heat map column data. - * @Default {0} - */ - value?: number; - - /** Specifies the label properties of the heat map color. - * @Default {null} - */ - label?: ColorMappingCollectionLabel; -} -} -namespace HeatMap { -enum Associate { -//Used to set the associate of tooltip as Target -Target, -//Used to set the associate of tooltip as MouseFollow -MouseFollow, -//Used to set the associate of tooltip as MouseEnter -MouseEnter, -} -} -namespace HeatMap { -enum Horizontal { -//Used to display the tooltip horizontally on left side of rows/columns -Left, -//Used to display the tooltip horizontally on center side of rows/columns -Center, -//Used to display the tooltip horizontally on right side of rows/columns -Right, -} -} -namespace HeatMap { -enum Vertical { -//Used to display the tooltip horizontally on left side of rows/columns -Top, -//Used to display the tooltip horizontally on center side of rows/columns -Center, -//Used to display the tooltip horizontally on right side of rows/columns -Bottom, -} -} -namespace HeatMap { -enum Trigger { -//Tooltip can be triggered on mouse hovers -Hover, -//Tooltip can be triggered on mouse click -Click, -} -} -namespace HeatMap { -enum Effect { -//Sets tooltip animation as None -None, -//Sets tooltip animation as Fade -Fade, -//Sets tooltip animation as Slide -Slide, -} -} -namespace HeatMap { -enum CellVisibility { -//Display the content of the cell -Visible, -//Hide the content of the cell -Hidden, -} -} -namespace HeatMap { -enum TextDecoration { -//Defines a line below the text -Underline, -//Defines a line above the text -Overline, -//Defines a line through the text -LineThrough, -//Defines a normal text. This is default -None, -} -} - -class HeatMapLegend extends ej.Widget { - static fn: HeatMapLegend; - constructor(element: JQuery | Element, options?: HeatMapLegend.Model); - static Locale: any; - model: HeatMapLegend.Model; - defaults: HeatMapLegend.Model; -} -export namespace HeatMapLegend { - -export interface Model { - - /** Specifies the width of the heatmap legend. - * @Default {null} - */ - width?: any; - - /** Specifies the height of the heatmap legend. - * @Default {null} - */ - height?: any; - - /** Specifies can enable responsive mode or not for heatmap legend. - * @Default {false} - */ - isResponsive?: boolean; - - /** Specifies whether the cell label can be shown or not. - * @Default {false} - */ - showLabel?: boolean; - - /** Specifies the color values of the column data. - * @Default {[]} - */ - colorMappingCollection?: ColorMappingCollection[]; - - /** Specifies the orientation of the heatmap legend - * @Default {ej.HeatMap.LegendOrientation.Horizontal} - */ - orientation?: ej.datavisualization.HeatMap.LegendOrientation|string; - - /** Specifies the legend mode as gradient or list. - * @Default {ej.HeatMap.LegendMode.Gradient} - */ - legendMode?: ej.datavisualization.HeatMap.LegendMode|string; -} - -export interface ColorMappingCollectionLabel { - - /** Enables/disables the bold style of the heatmap legend label. - * @Default {false} - */ - bold?: boolean; - - /** Enables/disables the italic style of the heatmap legend label. - * @Default {false} - */ - italic?: boolean; - - /** specifies the text value of the heatmap legend label. - */ - text?: string; - - /** Specifies the text style of the heatmap legend label. - * @Default {ej.HeatMap.TextDecoration.None} - */ - textDecoration?: ej.datavisualization.HeatMap.TextDecoration|string; - - /** Specifies the font size of the heatmap legend label. - * @Default {10} - */ - fontSize?: number; - - /** Specifies the font family of the heatmap legend label. - * @Default {Arial} - */ - fontFamily?: string; - - /** Specifies the font color of the heatmap legend label. - * @Default {black} - */ - fontColor?: string; -} - -export interface ColorMappingCollection { - - /** Specifies the color of the heatmap legend data. - * @Default {white} - */ - color?: string; - - /** Specifies the color values of the heatmap legend column data. - * @Default {0} - */ - value?: number; - - /** Specifies the label properties of the heatmap legend color. - * @Default {null} - */ - label?: ColorMappingCollectionLabel; -} -} -namespace HeatMap { -enum LegendOrientation { -//Scales the graphic content non-uniformly to the width and height of the diagram area -Horizontal, -//Used to align the image at the top left of diagram area -Vertical, -} -} -namespace HeatMap { -enum LegendMode { -//Scales the graphic content non-uniformly to the width and height of the diagram area -Gradient, -//Used to align the image at the top left of diagram area -List, -} -} - -class Sparkline extends ej.Widget { - static fn: Sparkline; - constructor(element: JQuery | Element, options?: Sparkline.Model); - static Locale: any; - model: Sparkline.Model; - defaults: Sparkline.Model; - - /** Redraws the entire sparkline. You can call this method whenever you update, add or remove points from the data source or whenever you want to refresh the UI. - * @returns {void} - */ - redraw(): void; -} -export namespace Sparkline { - -export interface Model { - - /** Background color of the plot area. - * @Default {transparent} - */ - background?: string; - - /** Fill color for the sparkline series. - * @Default {#33ccff} - */ - fill?: string; - - /** Border color of the series. - * @Default {null} - */ - stroke?: string; - - /** Options for customizing the color, opacity and width of the sparkline border. - */ - border?: Border; - - /** Border width of the series. - * @Default {1} - */ - width?: number; - - /** Opacity of the series. - * @Default {1} - */ - opacity?: number; - - /** Color for series high point. - * @Default {null} - */ - highPointColor?: string; - - /** Color for series low point. - * @Default {null} - */ - lowPointColor?: string; - - /** Color for series start point. - * @Default {null} - */ - startPointColor?: string; - - /** Color for series end point. - * @Default {null} - */ - endPointColor?: string; - - /** Color for series negative point. - * @Default {null} - */ - negativePointColor?: string; - - /** Options for customizing the color, opacity of the sparkline start and end range. - */ - rangeBandSettings?: RangeBandSettings; - - /** Name of a field in data source, where the fill color for all the data points is generated. - */ - palette?: string; - - /** Controls whether sparkline has to be responsive or not. - * @Default {true} - */ - isResponsive?: boolean; - - /** Controls whether Sparkline has to be rendered as Canvas or SVG.Canvas rendering supports all functionalities in SVG rendering. - * @Default {false} - */ - enableCanvasRendering?: boolean; - - /** Specifies the dataSource for the series. It can be an array of JSON objects or an instance of ej.DataManager. - * @Default {null} - */ - dataSource?: any; - - /** Name of the property in the datasource that contains x value for the series. - * @Default {null} - */ - xName?: string; - - /** Name of the property in the datasource that contains y value for the series. - * @Default {null} - */ - yName?: string; - - /** Gap or padding for sparkline. - * @Default {8} - */ - padding?: number; - - /** Specifies the type of the series to render in sparkline. - * @Default {line. See Type} - */ - type?: ej.datavisualization.Sparkline.Type|string; - - /** Specifies the theme for Sparkline. - * @Default {Flatlight. See Theme} - */ - theme?: ej.datavisualization.Sparkline.Theme|string; - - /** Options to customize the tooltip. - */ - tooltip?: Tooltip; - - /** Options for displaying and customizing marker for a data point. - */ - markerSettings?: MarkerSettings; + /** Fires before rendering trackball tooltip. You can use this event to customize the text displayed in trackball tooltip. */ + tooltipInitialize?(e: TooltipInitializeEventArgs): void; - /** Options to customize the Sparkline size. - */ - size?: Size; + /** Fires before rendering a series. This event is fired for each series in Sparkline. */ + seriesRendering?(e: SeriesRenderingEventArgs): void; - /** Options for customizing the color,dashArray and width of the axisLine. - */ - axisLineSettings?: AxisLineSettings; + /** Fires when mouse is moved over a point. */ + pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; - /** Fires before loading the sparkline. */ - load?(e: LoadEventArgs): void; - - /** Fires after loaded the sparkline. */ - loaded?(e: LoadedEventArgs): void; + /** Fires on clicking a point in sparkline. You can use this event to handle clicks made on points. */ + pointRegionMouseClick?(e: PointRegionMouseClickEventArgs): void; - /** Fires before rendering trackball tooltip. You can use this event to customize the text displayed in trackball tooltip. */ - tooltipInitialize?(e: TooltipInitializeEventArgs): void; + /** Fires on moving mouse over the sparkline. */ + sparklineMouseMove?(e: SparklineMouseMoveEventArgs): void; - /** Fires before rendering a series. This event is fired for each series in Sparkline. */ - seriesRendering?(e: SeriesRenderingEventArgs): void; + /** Fires on moving mouse outside the sparkline. */ + sparklineMouseLeave?(e: SparklineMouseLeaveEventArgs): void; + } - /** Fires when mouse is moved over a point. */ - pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; + export interface LoadEventArgs { - /** Fires on clicking a point in sparkline. You can use this event to handle clicks made on points. */ - pointRegionMouseClick?(e: PointRegionMouseClickEventArgs): void; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Fires on moving mouse over the sparkline. */ - sparklineMouseMove?(e: SparklineMouseMoveEventArgs): void; + /** Instance of the sparkline model object + */ + model?: any; - /** Fires on moving mouse outside the sparkline. */ - sparklineMouseLeave?(e: SparklineMouseLeaveEventArgs): void; -} + /** Name of the event + */ + type?: string; + } -export interface LoadEventArgs { + export interface LoadedEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the sparkline model object - */ - model?: any; + /** Instance of the sparkline model object + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; + } -export interface LoadedEventArgs { + export interface TooltipInitializeEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Instance of the sparkline model object - */ - model?: any; + /** Instance of the sparkline model object + */ + model?: any; - /** Name of the event - */ - type?: string; -} + /** Name of the event + */ + type?: string; -export interface TooltipInitializeEventArgs { + /** X Location of the trackball tooltip in pixels + */ + locationX?: any; - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Y Location of the trackball tooltip in pixels + */ + locationY?: any; - /** Instance of the sparkline model object - */ - model?: any; + /** Index of the point for which trackball tooltip is displayed + */ + pointIndex?: number; - /** Name of the event - */ - type?: string; + /** Text to be displayed in trackball tooltip. Use this option to add custom text in trackball tooltip + */ + currentText?: string; + } - /** X Location of the trackball tooltip in pixels - */ - locationX?: any; + export interface SeriesRenderingEventArgs { - /** Y Location of the trackball tooltip in pixels - */ - locationY?: any; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Index of the point for which trackball tooltip is displayed - */ - pointIndex?: number; + /** Instance of the sparkline model object + */ + model?: any; - /** Text to be displayed in trackball tooltip. Use this option to add custom text in trackball tooltip - */ - currentText?: string; -} + /** Name of the event + */ + type?: string; -export interface SeriesRenderingEventArgs { + /** Minimum x value of the data point + */ + minX?: any; - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Minimum y value of the data point + */ + minY?: any; - /** Instance of the sparkline model object - */ - model?: any; + /** Maximum x value of the data point + */ + maxX?: any; - /** Name of the event - */ - type?: string; + /** Maximum y value of the data point + */ + maxY?: any; + } - /** Minimum x value of the data point - */ - minX?: any; + export interface PointRegionMouseMoveEventArgs { - /** Minimum y value of the data point - */ - minY?: any; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Maximum x value of the data point - */ - maxX?: any; + /** Instance of the sparkline model object + */ + model?: any; - /** Maximum y value of the data point - */ - maxY?: any; -} + /** Name of the event + */ + type?: string; -export interface PointRegionMouseMoveEventArgs { + /** X-coordinate of point in pixel + */ + locationX?: number; - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Y-coordinate of point in pixel + */ + locationY?: number; - /** Instance of the sparkline model object - */ - model?: any; + /** Index of the point in series + */ + pointIndex?: number; - /** Name of the event - */ - type?: string; + /** Type of the series + */ + seriesType?: string; + } - /** X-coordinate of point in pixel - */ - locationX?: number; + export interface PointRegionMouseClickEventArgs { - /** Y-coordinate of point in pixel - */ - locationY?: number; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Index of the point in series - */ - pointIndex?: number; + /** Instance of the sparkline model object + */ + model?: any; - /** Type of the series - */ - seriesType?: string; -} + /** Name of the event + */ + type?: string; -export interface PointRegionMouseClickEventArgs { + /** X-coordinate of point in pixel + */ + locationX?: number; - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Y-coordinate of point in pixel + */ + locationY?: number; - /** Instance of the sparkline model object - */ - model?: any; + /** Index of the point in series + */ + pointIndex?: number; + + /** Type of the series + */ + seriesType?: string; + } + + export interface SparklineMouseMoveEventArgs { - /** Name of the event - */ - type?: string; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** X-coordinate of point in pixel - */ - locationX?: number; + /** Instance of the sparkline model object + */ + model?: any; + + /** Name of the event + */ + type?: string; + } + + export interface SparklineMouseLeaveEventArgs { + + /** Set this option to true to cancel the event + */ + cancel?: boolean; + + /** Instance of the sparkline model object + */ + model?: any; + + /** Name of the event + */ + type?: string; + } + + export interface Border { + + /** Border color of the sparkline. + * @Default {transparent} + */ + color?: string; + + /** Width of the Sparkline border. + * @Default {1} + */ + width?: number; + } + + export interface RangeBandSettings { + + /** Start value of the range band. + * @Default {null} + */ + startRange?: number; + + /** End value of the range band. + * @Default {null} + */ + endRange?: number; + + /** Range band opacity of the series. + * @Default {1} + */ + opacity?: number; + + /** Range band color of the series. + * @Default {transparent} + */ + color?: string; + } + + export interface TooltipBorder { + + /** Border color of the tooltip. + * @Default {transparent} + */ + color?: string; + + /** Border width of the tooltip. + * @Default {1} + */ + width?: number; + } + + export interface TooltipFont { + + /** Font color of the text in the tooltip. + * @Default {#111111} + */ + color?: string; + + /** Font Family for the tooltip. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Specifies the font Style for the tooltip. + * @Default {Normal} + */ + fontStyle?: ej.datavisualization.Sparkline.FontStyle | string; + + /** Specifies the font weight for the tooltip. + * @Default {Regular} + */ + fontWeight?: ej.datavisualization.Sparkline.FontWeight | string; + + /** Opacity for text in the tooltip. + * @Default {1} + */ + opacity?: number; + + /** Font size for text in the tooltip. + * @Default {8px} + */ + size?: string; + } + + export interface Tooltip { + + /** Show/hides the tooltip visibility. + * @Default {false} + */ + visible?: boolean; + + /** Fill color for the sparkline tooltip. + * @Default {white} + */ + fill?: string; + + /** Custom template to the tooltip. + */ + template?: string; + + /** Options for customizing the border of the tooltip. + */ + border?: TooltipBorder; + + /** Options for customizing the font of the tooltip. + */ + font?: TooltipFont; + } + + export interface MarkerSettingsBorder { + + /** Border color of the marker shape. + * @Default {transparent} + */ + color?: string; + + /** Controls the opacity of the marker border. + * @Default {1} + */ + opacity?: number; + + /** Border width of the marker shape. + * @Default {null} + */ + width?: number; + } + + export interface MarkerSettings { + + /** Controls the opacity of the marker. + * @Default {1} + */ + opacity?: number; + + /** Controls the visibility of the marker shape. + * @Default {false} + */ + visible?: boolean; + + /** width of the marker shape. + * @Default {2} + */ + width?: number; + + /** Color of the marker shape. + * @Default {white} + */ + fill?: string; + + /** Options for customizing the border of the marker shape. + */ + border?: MarkerSettingsBorder; + } + + export interface Size { + + /** Height of the Sparkline. Height can be specified in either pixel or percentage. + * @Default {''} + */ + height?: string; + + /** Width of the Sparkline. Width can be specified in either pixel or percentage. + * @Default {''} + */ + width?: string; + } + + export interface AxisLineSettings { + + /** Controls the visibility of the axis. + * @Default {false} + */ + visible?: boolean; + + /** Color of the axis line. + * @Default {'#111111'} + */ + color?: string; + + /** Width of the axis line. + * @Default {1} + */ + width?: number; + + /** Dash array of the axis line. + * @Default {1} + */ + dashArray?: number; + } + } + namespace Sparkline { + enum Type { + //string + Area, + //string + Line, + //string + Column, + //string + Pie, + //string + WinLoss, + } + } + namespace Sparkline { + enum Theme { + //string + Azure, + //string + FlatLight, + //string + FlatDark, + //string + Azuredark, + //string + Lime, + //string + LimeDark, + //string + Saffron, + //string + SaffronDark, + //string + GradientLight, + //string + GradientDark, + } + } + namespace Sparkline { + enum FontStyle { + //string + Normal, + //string + Italic, + } + } + namespace Sparkline { + enum FontWeight { + //string + Regular, + //string + Bold, + //string + Lighter, + } + } + + class SunburstChart extends ej.Widget { + static fn: SunburstChart; + constructor(element: JQuery | Element, options?: SunburstChart.Model); + static Locale: any; + model: SunburstChart.Model; + defaults: SunburstChart.Model; + + /** Redraws the entire sunburst. You can call this method whenever you update, add or remove points from the data source or whenever you want to refresh the UI. + * @returns {void} + */ + redraw(): void; + + /** destroy the sunburst + * @returns {void} + */ + _destroy(): void; + } + export namespace SunburstChart { + + export interface Model { + + /** Background color of the plot area. + * @Default {null} + */ + background?: string; + + /** Bind the data field from the data source. + * @Default {null} + */ + valueMemberPath?: string; + + /** Options for customizing the sunburst border. + */ + border?: Border; + + /** Options for customizing the sunburst segment border. + */ + segmentBorder?: SegmentBorder; + + /** Specifies the dataSource to the sunburst. + * @Default {null} + */ + dataSource?: any; + + /** Palette color for the data points. + * @Default {null} + */ + palette?: string; + + /** Parent node of the data points. + * @Default {null} + */ + parentNode?: string; + + /** Name of the property in the datasource that contains x values. + * @Default {null} + */ + xName?: string; + + /** Name of the property in the datasource that contains y values. + * @Default {null} + */ + yName?: string; + + /** Controls whether sunburst has to be responsive or not. + * @Default {true} + */ + isResponsive?: boolean; + + /** Options to customize the Sunburst size. + */ + size?: Size; + + /** Controls the visibility of sunburst. + * @Default {true} + */ + visible?: boolean; + + /** Options to customize the Sunburst tooltip. + */ + tooltip?: Tooltip; + + /** Options for customizing sunburst points. + */ + points?: Points; + + /** Sunburst rendering will start from the specified value + * @Default {null} + */ + startAngle?: number; + + /** Sunburst rendering will end at the specified value + * @Default {null} + */ + endAngle?: number; + + /** Sunburst outer radius value + * @Default {1} + */ + radius?: number; + + /** Sunburst inner radius value + * @Default {0.4} + */ + innerRadius?: number; + + /** Options to customize the Sunburst dataLabel. + */ + dataLabelSettings?: DataLabelSettings; + + /** Options for customizing the title and subtitle of sunburst. + */ + title?: Title; + + /** Options for customizing the appearance of the levels or point while highlighting. + */ + highlightSettings?: HighlightSettings; - /** Y-coordinate of point in pixel - */ - locationY?: number; + /** Options for customizing the appearance of the levels or data point while selection. + */ + selectionSettings?: SelectionSettings; + + /** Specify levels of sunburst for grouped visualization of data + * @Default {[]} + */ + levels?: Level[]; + + /** Options to customize the legend items and legend title. + */ + legend?: Legend; - /** Index of the point in series - */ - pointIndex?: number; - - /** Type of the series - */ - seriesType?: string; -} - -export interface SparklineMouseMoveEventArgs { + /** Specifies the theme for Sunburst. + * @Default {Flatlight. See Theme} + */ + theme?: ej.datavisualization.Sunburst.SunburstTheme | string; - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Options to customize the left, right, top and bottom margins of sunburst area. + */ + margin?: Margin; - /** Instance of the sparkline model object - */ - model?: any; - - /** Name of the event - */ - type?: string; -} - -export interface SparklineMouseLeaveEventArgs { - - /** Set this option to true to cancel the event - */ - cancel?: boolean; - - /** Instance of the sparkline model object - */ - model?: any; - - /** Name of the event - */ - type?: string; -} - -export interface Border { - - /** Border color of the sparkline. - * @Default {transparent} - */ - color?: string; - - /** Width of the Sparkline border. - * @Default {1} - */ - width?: number; -} - -export interface RangeBandSettings { - - /** Start value of the range band. - * @Default {null} - */ - startRange?: number; - - /** End value of the range band. - * @Default {null} - */ - endRange?: number; - - /** Range band opacity of the series. - * @Default {1} - */ - opacity?: number; - - /** Range band color of the series. - * @Default {transparent} - */ - color?: string; -} - -export interface TooltipBorder { - - /** Border color of the tooltip. - * @Default {transparent} - */ - color?: string; - - /** Border width of the tooltip. - * @Default {1} - */ - width?: number; -} - -export interface TooltipFont { - - /** Font color of the text in the tooltip. - * @Default {#111111} - */ - color?: string; - - /** Font Family for the tooltip. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Specifies the font Style for the tooltip. - * @Default {Normal} - */ - fontStyle?: ej.datavisualization.Sparkline.FontStyle|string; - - /** Specifies the font weight for the tooltip. - * @Default {Regular} - */ - fontWeight?: ej.datavisualization.Sparkline.FontWeight|string; - - /** Opacity for text in the tooltip. - * @Default {1} - */ - opacity?: number; - - /** Font size for text in the tooltip. - * @Default {8px} - */ - size?: string; -} - -export interface Tooltip { - - /** Show/hides the tooltip visibility. - * @Default {false} - */ - visible?: boolean; - - /** Fill color for the sparkline tooltip. - * @Default {white} - */ - fill?: string; - - /** Custom template to the tooltip. - */ - template?: string; - - /** Options for customizing the border of the tooltip. - */ - border?: TooltipBorder; - - /** Options for customizing the font of the tooltip. - */ - font?: TooltipFont; -} - -export interface MarkerSettingsBorder { - - /** Border color of the marker shape. - * @Default {transparent} - */ - color?: string; - - /** Controls the opacity of the marker border. - * @Default {1} - */ - opacity?: number; - - /** Border width of the marker shape. - * @Default {null} - */ - width?: number; -} - -export interface MarkerSettings { - - /** Controls the opacity of the marker. - * @Default {1} - */ - opacity?: number; - - /** Controls the visibility of the marker shape. - * @Default {false} - */ - visible?: boolean; - - /** width of the marker shape. - * @Default {2} - */ - width?: number; - - /** Color of the marker shape. - * @Default {white} - */ - fill?: string; - - /** Options for customizing the border of the marker shape. - */ - border?: MarkerSettingsBorder; -} - -export interface Size { - - /** Height of the Sparkline. Height can be specified in either pixel or percentage. - * @Default {''} - */ - height?: string; - - /** Width of the Sparkline. Width can be specified in either pixel or percentage. - * @Default {''} - */ - width?: string; -} - -export interface AxisLineSettings { - - /** Controls the visibility of the axis. - * @Default {false} - */ - visible?: boolean; - - /** Color of the axis line. - * @Default {'#111111'} - */ - color?: string; - - /** Width of the axis line. - * @Default {1} - */ - width?: number; - - /** Dash array of the axis line. - * @Default {1} - */ - dashArray?: number; -} -} -namespace Sparkline { -enum Type { -//string -Area, -//string -Line, -//string -Column, -//string -Pie, -//string -WinLoss, -} -} -namespace Sparkline { -enum Theme { -//string -Azure, -//string -FlatLight, -//string -FlatDark, -//string -Azuredark, -//string -Lime, -//string -LimeDark, -//string -Saffron, -//string -SaffronDark, -//string -GradientLight, -//string -GradientDark, -} -} -namespace Sparkline { -enum FontStyle { -//string -Normal, -//string -Italic, -} -} -namespace Sparkline { -enum FontWeight { -//string -Regular, -//string -Bold, -//string -Lighter, -} -} - -class SunburstChart extends ej.Widget { - static fn: SunburstChart; - constructor(element: JQuery | Element, options?: SunburstChart.Model); - static Locale: any; - model: SunburstChart.Model; - defaults: SunburstChart.Model; - - /** Redraws the entire sunburst. You can call this method whenever you update, add or remove points from the data source or whenever you want to refresh the UI. - * @returns {void} - */ - redraw(): void; - - /** destroy the sunburst - * @returns {void} - */ - _destroy(): void; -} -export namespace SunburstChart { - -export interface Model { - - /** Background color of the plot area. - * @Default {null} - */ - background?: string; - - /** Bind the data field from the data source. - * @Default {null} - */ - valueMemberPath?: string; - - /** Options for customizing the sunburst border. - */ - border?: Border; - - /** Options for customizing the sunburst segment border. - */ - segmentBorder?: SegmentBorder; - - /** Specifies the dataSource to the sunburst. - * @Default {null} - */ - dataSource?: any; - - /** Palette color for the data points. - * @Default {null} - */ - palette?: string; - - /** Parent node of the data points. - * @Default {null} - */ - parentNode?: string; - - /** Name of the property in the datasource that contains x values. - * @Default {null} - */ - xName?: string; - - /** Name of the property in the datasource that contains y values. - * @Default {null} - */ - yName?: string; - - /** Controls whether sunburst has to be responsive or not. - * @Default {true} - */ - isResponsive?: boolean; - - /** Options to customize the Sunburst size. - */ - size?: Size; - - /** Controls the visibility of sunburst. - * @Default {true} - */ - visible?: boolean; - - /** Options to customize the Sunburst tooltip. - */ - tooltip?: Tooltip; - - /** Options for customizing sunburst points. - */ - points?: Points; - - /** Sunburst rendering will start from the specified value - * @Default {null} - */ - startAngle?: number; - - /** Sunburst rendering will end at the specified value - * @Default {null} - */ - endAngle?: number; - - /** Sunburst outer radius value - * @Default {1} - */ - radius?: number; - - /** Sunburst inner radius value - * @Default {0.4} - */ - innerRadius?: number; - - /** Options to customize the Sunburst dataLabel. - */ - dataLabelSettings?: DataLabelSettings; - - /** Options for customizing the title and subtitle of sunburst. - */ - title?: Title; - - /** Options for customizing the appearance of the levels or point while highlighting. - */ - highlightSettings?: HighlightSettings; + /** Enable/disable the animation for all the levels. + * @Default {false} + */ + enableAnimation?: boolean; - /** Options for customizing the appearance of the levels or data point while selection. - */ - selectionSettings?: SelectionSettings; - - /** Specify levels of sunburst for grouped visualization of data - * @Default {[]} - */ - levels?: Level[]; - - /** Options to customize the legend items and legend title. - */ - legend?: Legend; + /** Opacity of the levels. + * @Default {1} + */ + opacity?: number; - /** Specifies the theme for Sunburst. - * @Default {Flatlight. See Theme} - */ - theme?: ej.datavisualization.Sunburst.SunburstTheme|string; + /** Options for enable zooming feature of chart. + */ + zoomSettings?: ZoomSettings; - /** Options to customize the left, right, top and bottom margins of sunburst area. - */ - margin?: Margin; + /** Animation type of sunburst + * @Default {rotation. See Alignment} + */ + animationType?: ej.datavisualization.Sunburst.Animation | string; - /** Enable/disable the animation for all the levels. - * @Default {false} - */ - enableAnimation?: boolean; + /** Fires before loading. */ + load?(e: LoadEventArgs): void; - /** Opacity of the levels. - * @Default {1} - */ - opacity?: number; + /** Fires before rendering sunburst. */ + preRender?(e: PreRenderEventArgs): void; - /** Options for enable zooming feature of chart. - */ - zoomSettings?: ZoomSettings; + /** Fires after rendering sunburst. */ + loaded?(e: LoadedEventArgs): void; - /** Animation type of sunburst - * @Default {rotation. See Alignment} - */ - animationType?: ej.datavisualization.Sunburst.Animation|string; + /** Fires before rendering the datalabel */ + dataLabelRendering?(e: DataLabelRenderingEventArgs): void; - /** Fires before loading. */ - load?(e: LoadEventArgs): void; + /** Fires before rendering each segment */ + segmentRendering?(e: SegmentRenderingEventArgs): void; - /** Fires before rendering sunburst. */ - preRender?(e: PreRenderEventArgs): void; + /** Fires before rendering sunburst title. */ + titleRendering?(e: TitleRenderingEventArgs): void; - /** Fires after rendering sunburst. */ - loaded?(e: LoadedEventArgs): void; + /** Fires during initialization of tooltip. */ + tooltipInitialize?(e: TooltipInitializeEventArgs): void; - /** Fires before rendering the datalabel */ - dataLabelRendering?(e: DataLabelRenderingEventArgs): void; + /** Fires after clicking the point in sunburst */ + pointRegionClick?(e: PointRegionClickEventArgs): void; - /** Fires before rendering each segment */ - segmentRendering?(e: SegmentRenderingEventArgs): void; + /** Fires while moving the mouse over sunburst points */ + pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; - /** Fires before rendering sunburst title. */ - titleRendering?(e: TitleRenderingEventArgs): void; + /** Fires when clicking the point to perform drilldown. */ + drillDownClick?(e: DrillDownClickEventArgs): void; - /** Fires during initialization of tooltip. */ - tooltipInitialize?(e: TooltipInitializeEventArgs): void; + /** Fires when resetting drilldown points. */ + drillDownBack?(e: DrillDownBackEventArgs): void; - /** Fires after clicking the point in sunburst */ - pointRegionClick?(e: PointRegionClickEventArgs): void; + /** Fires after resetting the sunburst points */ + drillDownReset?(e: DrillDownResetEventArgs): void; + } - /** Fires while moving the mouse over sunburst points */ - pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; + export interface LoadEventArgs { - /** Fires when clicking the point to perform drilldown. */ - drillDownClick?(e: DrillDownClickEventArgs): void; + /** Load event data + */ + data?: string; - /** Fires when resetting drilldown points. */ - drillDownBack?(e: DrillDownBackEventArgs): void; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Fires after resetting the sunburst points */ - drillDownReset?(e: DrillDownResetEventArgs): void; -} + /** Instance of the sunburst model object + */ + model?: any; -export interface LoadEventArgs { + /** Name of the event + */ + type?: string; + } - /** Load event data - */ - data?: string; + export interface PreRenderEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** PreRender event data + */ + data?: string; - /** Instance of the sunburst model object - */ - model?: any; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Name of the event - */ - type?: string; -} + /** Instance of the sunburst model object + */ + model?: any; -export interface PreRenderEventArgs { + /** Name of the event + */ + type?: string; + } - /** PreRender event data - */ - data?: string; + export interface LoadedEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Loaded event data + */ + data?: string; - /** Instance of the sunburst model object - */ - model?: any; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Name of the event - */ - type?: string; -} + /** Instance of the sunburst model object + */ + model?: any; -export interface LoadedEventArgs { + /** Name of the event + */ + type?: string; + } - /** Loaded event data - */ - data?: string; + export interface DataLabelRenderingEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Sunburst datalabel data + */ + data?: string; - /** Instance of the sunburst model object - */ - model?: any; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Name of the event - */ - type?: string; -} + /** Instance of the sunburst model object + */ + model?: any; -export interface DataLabelRenderingEventArgs { + /** Name of the event + */ + type?: string; + } - /** Sunburst datalabel data - */ - data?: string; + export interface SegmentRenderingEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Sunburst datalabel data + */ + data?: string; - /** Instance of the sunburst model object - */ - model?: any; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Name of the event - */ - type?: string; -} + /** Instance of the sunburst model object + */ + model?: any; -export interface SegmentRenderingEventArgs { + /** Name of the event + */ + type?: string; + } - /** Sunburst datalabel data - */ - data?: string; + export interface TitleRenderingEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Sunburst title data + */ + data?: string; - /** Instance of the sunburst model object - */ - model?: any; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Name of the event - */ - type?: string; -} + /** Instance of the sunburst model object + */ + model?: any; -export interface TitleRenderingEventArgs { + /** Name of the event + */ + type?: string; + } - /** Sunburst title data - */ - data?: string; + export interface TooltipInitializeEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Sunburst tooltip data + */ + data?: string; - /** Instance of the sunburst model object - */ - model?: any; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Name of the event - */ - type?: string; -} + /** Instance of the sunburst model object + */ + model?: any; -export interface TooltipInitializeEventArgs { + /** Name of the event + */ + type?: string; + } - /** Sunburst tooltip data - */ - data?: string; + export interface PointRegionClickEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Includes clicked points region data + */ + data?: string; - /** Instance of the sunburst model object - */ - model?: any; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Name of the event - */ - type?: string; -} + /** Instance of the sunburst model object + */ + model?: any; -export interface PointRegionClickEventArgs { + /** Name of the event + */ + type?: string; + } - /** Includes clicked points region data - */ - data?: string; + export interface PointRegionMouseMoveEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Includes data of mouse moved region + */ + data?: string; - /** Instance of the sunburst model object - */ - model?: any; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Name of the event - */ - type?: string; -} + /** Instance of the sunburst model object + */ + model?: any; -export interface PointRegionMouseMoveEventArgs { + /** Name of the event + */ + type?: string; + } - /** Includes data of mouse moved region - */ - data?: string; + export interface DrillDownClickEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Clicked point data + */ + data?: string; - /** Instance of the sunburst model object - */ - model?: any; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Name of the event - */ - type?: string; -} + /** Instance of the sunburst model object + */ + model?: any; -export interface DrillDownClickEventArgs { + /** Name of the event + */ + type?: string; + } - /** Clicked point data - */ - data?: string; + export interface DrillDownBackEventArgs { - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Drill down data of points + */ + data?: string; - /** Instance of the sunburst model object - */ - model?: any; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Name of the event - */ - type?: string; -} + /** Instance of the sunburst model object + */ + model?: any; -export interface DrillDownBackEventArgs { + /** Name of the event + */ + type?: string; + } - /** Drill down data of points - */ - data?: string; + export interface DrillDownResetEventArgs { + + /** Drill down reset data + */ + data?: string; - /** Set this option to true to cancel the event - */ - cancel?: boolean; - - /** Instance of the sunburst model object - */ - model?: any; - - /** Name of the event - */ - type?: string; -} - -export interface DrillDownResetEventArgs { - - /** Drill down reset data - */ - data?: string; - - /** Set this option to true to cancel the event - */ - cancel?: boolean; - - /** Instance of the sunburst model object - */ - model?: any; - - /** Name of the event - */ - type?: string; -} - -export interface Border { - - /** Border color of the sunburst. - * @Default {null} - */ - color?: string; - - /** Width of the Sunburst border. - * @Default {2} - */ - width?: number; -} - -export interface SegmentBorder { - - /** Segment Border color of the sunburst. - * @Default {null} - */ - color?: string; - - /** Width of the Sunburst segment border. - * @Default {2} - */ - width?: number; -} - -export interface Size { - - /** Height of the Sunburst. - * @Default {''} - */ - height?: string; - - /** Width of the Sunburst. - * @Default {''} - */ - width?: string; -} - -export interface TooltipBorder { - - /** Border color of the tooltip. - * @Default {null} - */ - color?: string; - - /** Border width of the tooltip. - * @Default {5} - */ - width?: number; -} - -export interface TooltipFont { - - /** Font color of the text in the tooltip. - * @Default {null} - */ - color?: string; - - /** Font Family for the tooltip. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Specifies the font Style for the tooltip. - * @Default {Normal} - */ - fontStyle?: ej.datavisualization.Sunburst.FontStyle|string; - - /** Specifies the font weight for the tooltip. - * @Default {Regular} - */ - fontWeight?: ej.datavisualization.Sunburst.FontWeight|string; - - /** Opacity for text in the tooltip. - * @Default {1} - */ - opacity?: number; - - /** Font size for text in the tooltip. - * @Default {12px} - */ - size?: string; -} - -export interface Tooltip { - - /** tooltip visibility of the Sunburst. - * @Default {true} - */ - visible?: boolean; - - /** Options for customizing the border of the sunburst tooltip. - */ - border?: TooltipBorder; - - /** Fill color for the sunburst tooltip. - * @Default {null} - */ - fill?: string; - - /** Options for customizing the font of the tooltip. - */ - font?: TooltipFont; - - /** Custom template to the tooltip. - * @Default {null} - */ - template?: string; -} - -export interface Points { - - /** Points x value of the sunburst. - * @Default {null} - */ - x?: string; - - /** Points y value of the sunburst. - * @Default {null} - */ - y?: number; - - /** Points text of the sunburst. - * @Default {null} - */ - text?: string; - - /** Points fill color of the sunburst. - * @Default {null} - */ - fill?: string; -} - -export interface DataLabelSettingsFont { - - /** Font family of the data label. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style of the data label. - * @Default {normal. See FontStyle} - */ - fontStyle?: ej.datavisualization.Sunburst.FontStyle|string; - - /** Font weight of the data label. - * @Default {regular. See FontWeight} - */ - fontWeight?: ej.datavisualization.Sunburst.FontWeight|string; - - /** Opacity of the text. - * @Default {1} - */ - opacity?: number; - - /** Font color of the data label text. - * @Default {null} - */ - color?: string; - - /** Font size of the data label. - * @Default {12px} - */ - size?: string; -} - -export interface DataLabelSettings { - - /** Datalabel visibility of the Sunburst. - * @Default {false} - */ - visible?: boolean; - - /** Alignment of sunburst datalabel - * @Default {Angle. See DatalabelAlignment} - */ - labelRotationMode?: ej.datavisualization.Sunburst.SunburstLabelRotationMode|string; - - /** Options for customizing the data label font. - */ - font?: DataLabelSettingsFont; - - /** Custom template for datalabel - * @Default {null} - */ - template?: string; - - /** Fill color for the datalabel - * @Default {null} - */ - fill?: string; - - /** Datalabel overflow mode - * @Default {Trim. See LabelOverflowMode} - */ - labelOverflowMode?: ej.datavisualization.Sunburst.SunburstLabelOverflowMode|string; -} - -export interface TitleFont { - - /** Font family for Sunburst title. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style for Sunburst title. - * @Default {Normal. See FontStyle} - */ - fontStyle?: ej.datavisualization.Sunburst.FontStyle|string; - - /** Font weight for Sunburst title. - * @Default {Regular. See FontWeight} - */ - fontWeight?: ej.datavisualization.Sunburst.FontWeight|string; - - /** Opacity of the Sunburst title. - * @Default {1} - */ - opacity?: number; - - /** Font size for Sunburst title. - * @Default {20px} - */ - size?: string; -} - -export interface TitleSubtitleFont { - - /** Font family of sub title. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style for sub title. - * @Default {Normal. See FontStyle} - */ - fontStyle?: ej.datavisualization.Sunburst.FontStyle|string; - - /** Font weight for sub title. - * @Default {Regular. See FontWeight} - */ - fontWeight?: ej.datavisualization.Sunburst.FontWeight|string; - - /** Opacity of the sub title. - * @Default {1} - */ - opacity?: number; - - /** Font size for sub title. - * @Default {12px} - */ - size?: string; -} - -export interface TitleSubtitle { - - /** Subtitle text for sunburst - */ - text?: string; - - /** Sub title text visibility for sunburst - * @Default {true} - */ - visible?: string; - - /** Sub title text alignment - * @Default {far. See TextAlignment} - */ - textAlignment?: ej.datavisualization.Sunburst.SunburstAlignment|string; - - /** Options for customizing the font of sub title. - */ - font?: TitleSubtitleFont; -} - -export interface Title { - - /** Title text for sunburst - */ - text?: string; - - /** Title text visibility for sunburst - * @Default {true} - */ - visible?: string; - - /** Title text alignment - * @Default {center. See TextAlignment} - */ - textAlignment?: ej.datavisualization.Sunburst.SunburstAlignment|string; - - /** Options for customizing the font of sunburst title. - */ - font?: TitleFont; - - /** Options to customize the sub title of Sunburst. - */ - subtitle?: TitleSubtitle; -} - -export interface HighlightSettings { - - /** Enables/disables the ability to highlight the levels or point interactively. - * @Default {false} - */ - enable?: boolean; - - /** Specifies whether the levels or point has to be highlighted. - * @Default {point. See Mode} - */ - mode?: ej.datavisualization.Sunburst.SunburstHighlightMode|string; - - /** Color of the levels/point on highlight. - * @Default {red} - */ - color?: string; - - /** Opacity of the levels/point on highlight. - * @Default {0.5} - */ - opacity?: number; - - /** Specifies whether the levels or data point has to be highlighted. - * @Default {opacity. See Mode} - */ - type?: ej.datavisualization.Sunburst.SunburstHighlightType|string; -} - -export interface SelectionSettings { - - /** Enables/disables the ability to select the levels or data point interactively. - * @Default {false} - */ - enable?: boolean; - - /** Specifies whether the levels or data point has to be selected. - * @Default {point. See Mode} - */ - mode?: ej.datavisualization.Sunburst.SunburstHighlightMode|string; - - /** Color of the levels/point on selection. - * @Default {green} - */ - color?: string; - - /** Opacity of the levels/point on selection. - * @Default {0.5} - */ - opacity?: number; - - /** Specifies whether the levels or data point has to be selected. - * @Default {opacity. See Mode} - */ - type?: ej.datavisualization.Sunburst.SunburstHighlightType|string; -} - -export interface Level { - - /** Specifies the group member path - * @Default {null} - */ - groupMemberPath?: string; -} - -export interface LegendBorder { - - /** Border color of the legend. - * @Default {null} - */ - color?: string; - - /** Border width of the legend. - * @Default {1} - */ - width?: number; -} - -export interface LegendFont { - - /** Font family for legend item text. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style for legend item text. - * @Default {Normal. See FontStyle} - */ - fontStyle?: ej.datavisualization.Sunburst.FontStyle|string; - - /** Font weight for legend item text. - * @Default {Regular. See FontWeight} - */ - fontWeight?: ej.datavisualization.Sunburst.FontWeight|string; - - /** Font size for legend item text. - * @Default {12px} - */ - size?: string; -} - -export interface LegendItemStyle { - - /** Height of the shape in legend items. - * @Default {10} - */ - height?: number; - - /** Width of the shape in legend items. - * @Default {10} - */ - width?: number; -} - -export interface LegendLocation { - - /** X value or horizontal offset to position the legend in chart. - * @Default {0} - */ - x?: number; - - /** Y value or vertical offset to position the legend. - * @Default {0} - */ - y?: number; -} - -export interface LegendSize { - - /** Height of the legend. Height can be specified in either pixel or percentage. - * @Default {null} - */ - height?: string; - - /** Width of the legend. Width can be specified in either pixel or percentage. - * @Default {null} - */ - width?: string; -} - -export interface LegendTitleFont { - - /** Font family for the text in legend title. - * @Default {Segoe UI} - */ - fontFamily?: string; - - /** Font style for legend title. - * @Default {normal. See FontStyle} - */ - fontStyle?: ej.datavisualization.Sunburst.FontStyle|string; - - /** Font weight for legend title. - * @Default {normal. See FontWeight} - */ - fontWeight?: ej.datavisualization.Sunburst.FontWeight|string; - - /** Font size for legend title. - * @Default {12px} - */ - size?: string; -} - -export interface LegendTitle { - - /** Options to customize the font used for legend title - */ - font?: LegendTitleFont; - - /** Enables or disables the legend title. - * @Default {true} - */ - visible?: string; - - /** Text to be displayed in legend title. - */ - text?: string; - - /** Alignment of the legend title. - * @Default {center. See Alignment} - */ - textAlignment?: ej.datavisualization.Sunburst.SunburstAlignment|string; -} - -export interface Legend { - - /** Visibility of the legend. - * @Default {false} - */ - visible?: boolean; - - /** Interactive action of legend items. - * @Default {toggleSegmentVisibility. See Alignment} - */ - clickAction?: ej.datavisualization.Sunburst.SunburstClickAction|string; - - /** Horizontal alignment of the legend. - * @Default {Center. See Alignment} - */ - alignment?: ej.datavisualization.Sunburst.SunburstAlignment|string; - - /** Options for customizing the legend border. - */ - border?: LegendBorder; - - /** Number of columns to arrange the legend items. - * @Default {null} - */ - columnCount?: number; - - /** Number of rows to arrange the legend items. - * @Default {null} - */ - rowCount?: number; - - /** Options to customize the font used for legend item text. - */ - font?: LegendFont; - - /** Gap or padding between the legend items. - * @Default {10} - */ - itemPadding?: number; - - /** Options to customize the style of legend items. - */ - itemStyle?: LegendItemStyle; - - /** Options to customize the location of sunburst legend. Legend is placed in provided location only when value of position property is custom - */ - location?: LegendLocation; - - /** Places the legend at specified position. Legend can be placed at left, right, top or bottom of the chart area.To manually specify the location of legend, set custom as value to this property. - * @Default {Bottom. See Position} - */ - position?: ej.datavisualization.Sunburst.SunburstLegendPosition|string; - - /** Shape of the legend items. - * @Default {None. See Shape} - */ - shape?: ej.datavisualization.Sunburst.SunburstLegendShape|string; - - /** Options to customize the size of the legend. - */ - size?: LegendSize; - - /** Options to customize the legend title. - */ - title?: LegendTitle; -} - -export interface Margin { - - /** Spacing for the left margin of chart area. Setting positive value decreases the width of the chart area from left side. - * @Default {10} - */ - left?: number; - - /** Spacing for the right margin of chart area. Setting positive value decreases the width of the chart area from right side. - * @Default {10} - */ - right?: number; - - /** Spacing for the top margin of chart area. Setting positive value decreases the height of the chart area from the top. - * @Default {10} - */ - top?: number; - - /** Spacing for the bottom margin of the chart area. Setting positive value decreases the height of the chart area from the bottom. - * @Default {10} - */ - bottom?: number; -} - -export interface ZoomSettings { - - /** Enables or disables zooming. - * @Default {false} - */ - enable?: boolean; - - /** Toolbar horizontal alignment - * @Default {right. See Alignment} - */ - toolbarHorizontalAlignment?: ej.datavisualization.Sunburst.SunburstHorizontalAlignment|string; - - /** Toolbar vertical alignment - * @Default {top. See Alignment} - */ - toolbarVerticalAlignment?: ej.datavisualization.Sunburst.SunburstVerticalAlignment|string; -} -} -namespace Sunburst { -enum FontStyle { -//string -Normal, -//string -Italic, -} -} -namespace Sunburst { -enum FontWeight { -//string -Regular, -//string -Bold, -//string -Lighter, -} -} -namespace Sunburst { -enum SunburstLabelRotationMode { -//string -Angle, -//string -Normal, -} -} -namespace Sunburst { -enum SunburstLabelOverflowMode { -//string -Trim, -//string -Hide, -//string -None, -} -} -namespace Sunburst { -enum SunburstAlignment { -//string -Center, -//string -Near, -//string -Far, -} -} -namespace Sunburst { -enum SunburstHighlightMode { -//string -Point, -//string -Parent, -//string -Child, -//string -All, -} -} -namespace Sunburst { -enum SunburstHighlightType { -//string -Opacity, -//string -Color, -} -} -namespace Sunburst { -enum SunburstClickAction { -//string -None, -//string -ToggleSegmentVisibility, -//string -ToggleSegmentSelection, -} -} -namespace Sunburst { -enum SunburstLegendPosition { -//string -Left, -//string -Right, -//string -Top, -//string -Bottom, -} -} -namespace Sunburst { -enum SunburstLegendShape { -//string -Diamond, -//string -Pentagon, -//string -Rectangle, -//string -Circle, -//string -Cross, -//string -Triangle, -} -} -namespace Sunburst { -enum SunburstTheme { -//string -FlatLight, -//string -FlatDark, -} -} -namespace Sunburst { -enum SunburstHorizontalAlignment { -//string -Center, -//string -Left, -//string -Right, -} -} -namespace Sunburst { -enum SunburstVerticalAlignment { -//string -Top, -//string -Bottom, -//string -Middle, -} -} -namespace Sunburst { -enum Animation { -//string -Rotation, -//string -FadeIn, -} -} - -class Overview extends ej.Widget { - static fn: Overview; - constructor(element: JQuery | Element, options?: Overview.Model); - static Locale: any; - model: Overview.Model; - defaults: Overview.Model; -} -export namespace Overview { - -export interface Model { - - /** The sourceId property of overview should be set with the corresponding Diagram ID for you need the overall view. - * @Default {null} - */ - sourceID?: string; - - /** Defines the height of the overview - * @Default {400} - */ - height?: number; - - /** Defines the width of the overview - * @Default {250} - */ - width?: number; -} -} + /** Set this option to true to cancel the event + */ + cancel?: boolean; + + /** Instance of the sunburst model object + */ + model?: any; + + /** Name of the event + */ + type?: string; + } + + export interface Border { + + /** Border color of the sunburst. + * @Default {null} + */ + color?: string; + + /** Width of the Sunburst border. + * @Default {2} + */ + width?: number; + } + + export interface SegmentBorder { + + /** Segment Border color of the sunburst. + * @Default {null} + */ + color?: string; + + /** Width of the Sunburst segment border. + * @Default {2} + */ + width?: number; + } + + export interface Size { + + /** Height of the Sunburst. + * @Default {''} + */ + height?: string; + + /** Width of the Sunburst. + * @Default {''} + */ + width?: string; + } + + export interface TooltipBorder { + + /** Border color of the tooltip. + * @Default {null} + */ + color?: string; + + /** Border width of the tooltip. + * @Default {5} + */ + width?: number; + } + + export interface TooltipFont { + + /** Font color of the text in the tooltip. + * @Default {null} + */ + color?: string; + + /** Font Family for the tooltip. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Specifies the font Style for the tooltip. + * @Default {Normal} + */ + fontStyle?: ej.datavisualization.Sunburst.FontStyle | string; + + /** Specifies the font weight for the tooltip. + * @Default {Regular} + */ + fontWeight?: ej.datavisualization.Sunburst.FontWeight | string; + + /** Opacity for text in the tooltip. + * @Default {1} + */ + opacity?: number; + + /** Font size for text in the tooltip. + * @Default {12px} + */ + size?: string; + } + + export interface Tooltip { + + /** tooltip visibility of the Sunburst. + * @Default {true} + */ + visible?: boolean; + + /** Options for customizing the border of the sunburst tooltip. + */ + border?: TooltipBorder; + + /** Fill color for the sunburst tooltip. + * @Default {null} + */ + fill?: string; + + /** Options for customizing the font of the tooltip. + */ + font?: TooltipFont; + + /** Custom template to the tooltip. + * @Default {null} + */ + template?: string; + } + + export interface Points { + + /** Points x value of the sunburst. + * @Default {null} + */ + x?: string; + + /** Points y value of the sunburst. + * @Default {null} + */ + y?: number; + + /** Points text of the sunburst. + * @Default {null} + */ + text?: string; + + /** Points fill color of the sunburst. + * @Default {null} + */ + fill?: string; + } + + export interface DataLabelSettingsFont { + + /** Font family of the data label. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style of the data label. + * @Default {normal. See FontStyle} + */ + fontStyle?: ej.datavisualization.Sunburst.FontStyle | string; + + /** Font weight of the data label. + * @Default {regular. See FontWeight} + */ + fontWeight?: ej.datavisualization.Sunburst.FontWeight | string; + + /** Opacity of the text. + * @Default {1} + */ + opacity?: number; + + /** Font color of the data label text. + * @Default {null} + */ + color?: string; + + /** Font size of the data label. + * @Default {12px} + */ + size?: string; + } + + export interface DataLabelSettings { + + /** Datalabel visibility of the Sunburst. + * @Default {false} + */ + visible?: boolean; + + /** Alignment of sunburst datalabel + * @Default {Angle. See DatalabelAlignment} + */ + labelRotationMode?: ej.datavisualization.Sunburst.SunburstLabelRotationMode | string; + + /** Options for customizing the data label font. + */ + font?: DataLabelSettingsFont; + + /** Custom template for datalabel + * @Default {null} + */ + template?: string; + + /** Fill color for the datalabel + * @Default {null} + */ + fill?: string; + + /** Datalabel overflow mode + * @Default {Trim. See LabelOverflowMode} + */ + labelOverflowMode?: ej.datavisualization.Sunburst.SunburstLabelOverflowMode | string; + } + + export interface TitleFont { + + /** Font family for Sunburst title. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style for Sunburst title. + * @Default {Normal. See FontStyle} + */ + fontStyle?: ej.datavisualization.Sunburst.FontStyle | string; + + /** Font weight for Sunburst title. + * @Default {Regular. See FontWeight} + */ + fontWeight?: ej.datavisualization.Sunburst.FontWeight | string; + + /** Opacity of the Sunburst title. + * @Default {1} + */ + opacity?: number; + + /** Font size for Sunburst title. + * @Default {20px} + */ + size?: string; + } + + export interface TitleSubtitleFont { + + /** Font family of sub title. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style for sub title. + * @Default {Normal. See FontStyle} + */ + fontStyle?: ej.datavisualization.Sunburst.FontStyle | string; + + /** Font weight for sub title. + * @Default {Regular. See FontWeight} + */ + fontWeight?: ej.datavisualization.Sunburst.FontWeight | string; + + /** Opacity of the sub title. + * @Default {1} + */ + opacity?: number; + + /** Font size for sub title. + * @Default {12px} + */ + size?: string; + } + + export interface TitleSubtitle { + + /** Subtitle text for sunburst + */ + text?: string; + + /** Sub title text visibility for sunburst + * @Default {true} + */ + visible?: string; + + /** Sub title text alignment + * @Default {far. See TextAlignment} + */ + textAlignment?: ej.datavisualization.Sunburst.SunburstAlignment | string; + + /** Options for customizing the font of sub title. + */ + font?: TitleSubtitleFont; + } + + export interface Title { + + /** Title text for sunburst + */ + text?: string; + + /** Title text visibility for sunburst + * @Default {true} + */ + visible?: string; + + /** Title text alignment + * @Default {center. See TextAlignment} + */ + textAlignment?: ej.datavisualization.Sunburst.SunburstAlignment | string; + + /** Options for customizing the font of sunburst title. + */ + font?: TitleFont; + + /** Options to customize the sub title of Sunburst. + */ + subtitle?: TitleSubtitle; + } + + export interface HighlightSettings { + + /** Enables/disables the ability to highlight the levels or point interactively. + * @Default {false} + */ + enable?: boolean; + + /** Specifies whether the levels or point has to be highlighted. + * @Default {point. See Mode} + */ + mode?: ej.datavisualization.Sunburst.SunburstHighlightMode | string; + + /** Color of the levels/point on highlight. + * @Default {red} + */ + color?: string; + + /** Opacity of the levels/point on highlight. + * @Default {0.5} + */ + opacity?: number; + + /** Specifies whether the levels or data point has to be highlighted. + * @Default {opacity. See Mode} + */ + type?: ej.datavisualization.Sunburst.SunburstHighlightType | string; + } + + export interface SelectionSettings { + + /** Enables/disables the ability to select the levels or data point interactively. + * @Default {false} + */ + enable?: boolean; + + /** Specifies whether the levels or data point has to be selected. + * @Default {point. See Mode} + */ + mode?: ej.datavisualization.Sunburst.SunburstHighlightMode | string; + + /** Color of the levels/point on selection. + * @Default {green} + */ + color?: string; + + /** Opacity of the levels/point on selection. + * @Default {0.5} + */ + opacity?: number; + + /** Specifies whether the levels or data point has to be selected. + * @Default {opacity. See Mode} + */ + type?: ej.datavisualization.Sunburst.SunburstHighlightType | string; + } + + export interface Level { + + /** Specifies the group member path + * @Default {null} + */ + groupMemberPath?: string; + } + + export interface LegendBorder { + + /** Border color of the legend. + * @Default {null} + */ + color?: string; + + /** Border width of the legend. + * @Default {1} + */ + width?: number; + } + + export interface LegendFont { + + /** Font family for legend item text. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style for legend item text. + * @Default {Normal. See FontStyle} + */ + fontStyle?: ej.datavisualization.Sunburst.FontStyle | string; + + /** Font weight for legend item text. + * @Default {Regular. See FontWeight} + */ + fontWeight?: ej.datavisualization.Sunburst.FontWeight | string; + + /** Font size for legend item text. + * @Default {12px} + */ + size?: string; + } + + export interface LegendItemStyle { + + /** Height of the shape in legend items. + * @Default {10} + */ + height?: number; + + /** Width of the shape in legend items. + * @Default {10} + */ + width?: number; + } + + export interface LegendLocation { + + /** X value or horizontal offset to position the legend in chart. + * @Default {0} + */ + x?: number; + + /** Y value or vertical offset to position the legend. + * @Default {0} + */ + y?: number; + } + + export interface LegendSize { + + /** Height of the legend. Height can be specified in either pixel or percentage. + * @Default {null} + */ + height?: string; + + /** Width of the legend. Width can be specified in either pixel or percentage. + * @Default {null} + */ + width?: string; + } + + export interface LegendTitleFont { + + /** Font family for the text in legend title. + * @Default {Segoe UI} + */ + fontFamily?: string; + + /** Font style for legend title. + * @Default {normal. See FontStyle} + */ + fontStyle?: ej.datavisualization.Sunburst.FontStyle | string; + + /** Font weight for legend title. + * @Default {normal. See FontWeight} + */ + fontWeight?: ej.datavisualization.Sunburst.FontWeight | string; + + /** Font size for legend title. + * @Default {12px} + */ + size?: string; + } + + export interface LegendTitle { + + /** Options to customize the font used for legend title + */ + font?: LegendTitleFont; + + /** Enables or disables the legend title. + * @Default {true} + */ + visible?: string; + + /** Text to be displayed in legend title. + */ + text?: string; + + /** Alignment of the legend title. + * @Default {center. See Alignment} + */ + textAlignment?: ej.datavisualization.Sunburst.SunburstAlignment | string; + } + + export interface Legend { + + /** Visibility of the legend. + * @Default {false} + */ + visible?: boolean; + + /** Interactive action of legend items. + * @Default {toggleSegmentVisibility. See Alignment} + */ + clickAction?: ej.datavisualization.Sunburst.SunburstClickAction | string; + + /** Horizontal alignment of the legend. + * @Default {Center. See Alignment} + */ + alignment?: ej.datavisualization.Sunburst.SunburstAlignment | string; + + /** Options for customizing the legend border. + */ + border?: LegendBorder; + + /** Number of columns to arrange the legend items. + * @Default {null} + */ + columnCount?: number; + + /** Number of rows to arrange the legend items. + * @Default {null} + */ + rowCount?: number; + + /** Options to customize the font used for legend item text. + */ + font?: LegendFont; + + /** Gap or padding between the legend items. + * @Default {10} + */ + itemPadding?: number; + + /** Options to customize the style of legend items. + */ + itemStyle?: LegendItemStyle; + + /** Options to customize the location of sunburst legend. Legend is placed in provided location only when value of position property is custom + */ + location?: LegendLocation; + + /** Places the legend at specified position. Legend can be placed at left, right, top or bottom of the chart area.To manually specify the location of legend, set custom as value to this property. + * @Default {Bottom. See Position} + */ + position?: ej.datavisualization.Sunburst.SunburstLegendPosition | string; + + /** Shape of the legend items. + * @Default {None. See Shape} + */ + shape?: ej.datavisualization.Sunburst.SunburstLegendShape | string; + + /** Options to customize the size of the legend. + */ + size?: LegendSize; + + /** Options to customize the legend title. + */ + title?: LegendTitle; + } + + export interface Margin { + + /** Spacing for the left margin of chart area. Setting positive value decreases the width of the chart area from left side. + * @Default {10} + */ + left?: number; + + /** Spacing for the right margin of chart area. Setting positive value decreases the width of the chart area from right side. + * @Default {10} + */ + right?: number; + + /** Spacing for the top margin of chart area. Setting positive value decreases the height of the chart area from the top. + * @Default {10} + */ + top?: number; + + /** Spacing for the bottom margin of the chart area. Setting positive value decreases the height of the chart area from the bottom. + * @Default {10} + */ + bottom?: number; + } + + export interface ZoomSettings { + + /** Enables or disables zooming. + * @Default {false} + */ + enable?: boolean; + + /** Toolbar horizontal alignment + * @Default {right. See Alignment} + */ + toolbarHorizontalAlignment?: ej.datavisualization.Sunburst.SunburstHorizontalAlignment | string; + + /** Toolbar vertical alignment + * @Default {top. See Alignment} + */ + toolbarVerticalAlignment?: ej.datavisualization.Sunburst.SunburstVerticalAlignment | string; + } + } + namespace Sunburst { + enum FontStyle { + //string + Normal, + //string + Italic, + } + } + namespace Sunburst { + enum FontWeight { + //string + Regular, + //string + Bold, + //string + Lighter, + } + } + namespace Sunburst { + enum SunburstLabelRotationMode { + //string + Angle, + //string + Normal, + } + } + namespace Sunburst { + enum SunburstLabelOverflowMode { + //string + Trim, + //string + Hide, + //string + None, + } + } + namespace Sunburst { + enum SunburstAlignment { + //string + Center, + //string + Near, + //string + Far, + } + } + namespace Sunburst { + enum SunburstHighlightMode { + //string + Point, + //string + Parent, + //string + Child, + //string + All, + } + } + namespace Sunburst { + enum SunburstHighlightType { + //string + Opacity, + //string + Color, + } + } + namespace Sunburst { + enum SunburstClickAction { + //string + None, + //string + ToggleSegmentVisibility, + //string + ToggleSegmentSelection, + } + } + namespace Sunburst { + enum SunburstLegendPosition { + //string + Left, + //string + Right, + //string + Top, + //string + Bottom, + } + } + namespace Sunburst { + enum SunburstLegendShape { + //string + Diamond, + //string + Pentagon, + //string + Rectangle, + //string + Circle, + //string + Cross, + //string + Triangle, + } + } + namespace Sunburst { + enum SunburstTheme { + //string + FlatLight, + //string + FlatDark, + } + } + namespace Sunburst { + enum SunburstHorizontalAlignment { + //string + Center, + //string + Left, + //string + Right, + } + } + namespace Sunburst { + enum SunburstVerticalAlignment { + //string + Top, + //string + Bottom, + //string + Middle, + } + } + namespace Sunburst { + enum Animation { + //string + Rotation, + //string + FadeIn, + } + } + + class Overview extends ej.Widget { + static fn: Overview; + constructor(element: JQuery | Element, options?: Overview.Model); + static Locale: any; + model: Overview.Model; + defaults: Overview.Model; + } + export namespace Overview { + + export interface Model { + + /** The sourceId property of overview should be set with the corresponding Diagram ID for you need the overall view. + * @Default {null} + */ + sourceID?: string; + + /** Defines the height of the overview + * @Default {400} + */ + height?: number; + + /** Defines the width of the overview + * @Default {250} + */ + width?: number; + } + } } interface JQueryXHR { - /** - * Returns the cancel option value. - */ + /** + * Returns the cancel option value. + */ cancel?: boolean; } interface JQueryPromise { - /** - * Returns the cancel option value. - */ + /** + * Returns the cancel option value. + */ cancel?: boolean; } interface JQueryDeferred extends JQueryPromise { - /** - * Returns the cancel option value. - */ + /** + * Returns the cancel option value. + */ cancel?: boolean; } interface JQueryParam { - /** - * Returns the cancel option value. - */ + /** + * Returns the cancel option value. + */ cancel?: boolean; } interface JQuery { - data(key: any): any; + data(key: any): any; } interface Window { - ej: typeof ej; + ej: typeof ej; } interface JQuery { -ejAccordion(options?: ej.Accordion.Model): JQuery; -ejAccordion(memberName: any, value?: any, param?: any): any; + ejAccordion(options?: ej.Accordion.Model): JQuery; + ejAccordion(memberName: any, value?: any, param?: any): any; -ejAutocomplete(options?: ej.Autocomplete.Model): JQuery; -ejAutocomplete(memberName: any, value?: any, param?: any): any; + ejAutocomplete(options?: ej.Autocomplete.Model): JQuery; + ejAutocomplete(memberName: any, value?: any, param?: any): any; -ejBarcode(options?: ej.datavisualization.Barcode.Model): JQuery; -ejBarcode(memberName: any, value?: any, param?: any): any; + ejBarcode(options?: ej.datavisualization.Barcode.Model): JQuery; + ejBarcode(memberName: any, value?: any, param?: any): any; -ejBulletGraph(options?: ej.datavisualization.BulletGraph.Model): JQuery; -ejBulletGraph(memberName: any, value?: any, param?: any): any; + ejBulletGraph(options?: ej.datavisualization.BulletGraph.Model): JQuery; + ejBulletGraph(memberName: any, value?: any, param?: any): any; -ejButton(options?: ej.Button.Model): JQuery; -ejButton(memberName: any, value?: any, param?: any): any; + ejButton(options?: ej.Button.Model): JQuery; + ejButton(memberName: any, value?: any, param?: any): any; -ejCaptcha(options?: ej.Captcha.Model): JQuery; -ejCaptcha(memberName: any, value?: any, param?: any): any; + ejCaptcha(options?: ej.Captcha.Model): JQuery; + ejCaptcha(memberName: any, value?: any, param?: any): any; -ejChart(options?: ej.datavisualization.Chart.Model): JQuery; -ejChart(memberName: any, value?: any, param?: any): any; + ejChart(options?: ej.datavisualization.Chart.Model): JQuery; + ejChart(memberName: any, value?: any, param?: any): any; -ejCheckBox(options?: ej.CheckBox.Model): JQuery; -ejCheckBox(memberName: any, value?: any, param?: any): any; + ejCheckBox(options?: ej.CheckBox.Model): JQuery; + ejCheckBox(memberName: any, value?: any, param?: any): any; -ejCircularGauge(options?: ej.datavisualization.CircularGauge.Model): JQuery; -ejCircularGauge(memberName: any, value?: any, param?: any): any; + ejCircularGauge(options?: ej.datavisualization.CircularGauge.Model): JQuery; + ejCircularGauge(memberName: any, value?: any, param?: any): any; -ejColorPicker(options?: ej.ColorPicker.Model): JQuery; -ejColorPicker(memberName: any, value?: any, param?: any): any; + ejColorPicker(options?: ej.ColorPicker.Model): JQuery; + ejColorPicker(memberName: any, value?: any, param?: any): any; -ejDatePicker(options?: ej.DatePicker.Model): JQuery; -ejDatePicker(memberName: any, value?: any, param?: any): any; + ejDatePicker(options?: ej.DatePicker.Model): JQuery; + ejDatePicker(memberName: any, value?: any, param?: any): any; -ejDateRangePicker(options?: ej.DateRangePicker.Model): JQuery; -ejDateRangePicker(memberName: any, value?: any, param?: any): any; + ejDateRangePicker(options?: ej.DateRangePicker.Model): JQuery; + ejDateRangePicker(memberName: any, value?: any, param?: any): any; -ejDateTimePicker(options?: ej.DateTimePicker.Model): JQuery; -ejDateTimePicker(memberName: any, value?: any, param?: any): any; + ejDateTimePicker(options?: ej.DateTimePicker.Model): JQuery; + ejDateTimePicker(memberName: any, value?: any, param?: any): any; -ejDiagram(options?: ej.datavisualization.Diagram.Model): JQuery; -ejDiagram(memberName: any, value?: any, param?: any): any; + ejDiagram(options?: ej.datavisualization.Diagram.Model): JQuery; + ejDiagram(memberName: any, value?: any, param?: any): any; -ejDialog(options?: ej.Dialog.Model): JQuery; -ejDialog(memberName: any, value?: any, param?: any): any; + ejDialog(options?: ej.Dialog.Model): JQuery; + ejDialog(memberName: any, value?: any, param?: any): any; -ejDigitalGauge(options?: ej.datavisualization.DigitalGauge.Model): JQuery; -ejDigitalGauge(memberName: any, value?: any, param?: any): any; + ejDigitalGauge(options?: ej.datavisualization.DigitalGauge.Model): JQuery; + ejDigitalGauge(memberName: any, value?: any, param?: any): any; -ejDocumentEditor(options?: ej.DocumentEditor.Model): JQuery; -ejDocumentEditor(memberName: any, value?: any, param?: any): any; + ejDocumentEditor(options?: ej.DocumentEditor.Model): JQuery; + ejDocumentEditor(memberName: any, value?: any, param?: any): any; -ejDraggable(options?: ej.Draggable.Model): JQuery; -ejDraggable(memberName: any, value?: any, param?: any): any; + ejDraggable(options?: ej.Draggable.Model): JQuery; + ejDraggable(memberName: any, value?: any, param?: any): any; -ejDropDownList(options?: ej.DropDownList.Model): JQuery; -ejDropDownList(memberName: any, value?: any, param?: any): any; + ejDropDownList(options?: ej.DropDownList.Model): JQuery; + ejDropDownList(memberName: any, value?: any, param?: any): any; -ejDroppable(options?: ej.Droppable.Model): JQuery; -ejDroppable(memberName: any, value?: any, param?: any): any; + ejDroppable(options?: ej.Droppable.Model): JQuery; + ejDroppable(memberName: any, value?: any, param?: any): any; -ejFileExplorer(options?: ej.FileExplorer.Model): JQuery; -ejFileExplorer(memberName: any, value?: any, param?: any): any; + ejFileExplorer(options?: ej.FileExplorer.Model): JQuery; + ejFileExplorer(memberName: any, value?: any, param?: any): any; -ejGantt(options?: ej.Gantt.Model): JQuery; -ejGantt(memberName: any, value?: any, param?: any): any; + ejGantt(options?: ej.Gantt.Model): JQuery; + ejGantt(memberName: any, value?: any, param?: any): any; -ejGrid(options?: ej.Grid.Model): JQuery; -ejGrid(memberName: any, value?: any, param?: any): any; + ejGrid(options?: ej.Grid.Model): JQuery; + ejGrid(memberName: any, value?: any, param?: any): any; -ejGroupButton(options?: ej.GroupButton.Model): JQuery; -ejGroupButton(memberName: any, value?: any, param?: any): any; + ejGroupButton(options?: ej.GroupButton.Model): JQuery; + ejGroupButton(memberName: any, value?: any, param?: any): any; -ejHeatMap(options?: ej.datavisualization.HeatMap.Model): JQuery; -ejHeatMap(memberName: any, value?: any, param?: any): any; + ejHeatMap(options?: ej.datavisualization.HeatMap.Model): JQuery; + ejHeatMap(memberName: any, value?: any, param?: any): any; -ejHeatMapLegend(options?: ej.datavisualization.HeatMapLegend.Model): JQuery; -ejHeatMapLegend(memberName: any, value?: any, param?: any): any; + ejHeatMapLegend(options?: ej.datavisualization.HeatMapLegend.Model): JQuery; + ejHeatMapLegend(memberName: any, value?: any, param?: any): any; -ejKanban(options?: ej.Kanban.Model): JQuery; -ejKanban(memberName: any, value?: any, param?: any): any; + ejKanban(options?: ej.Kanban.Model): JQuery; + ejKanban(memberName: any, value?: any, param?: any): any; -ejLinearGauge(options?: ej.datavisualization.LinearGauge.Model): JQuery; -ejLinearGauge(memberName: any, value?: any, param?: any): any; + ejLinearGauge(options?: ej.datavisualization.LinearGauge.Model): JQuery; + ejLinearGauge(memberName: any, value?: any, param?: any): any; -ejListBox(options?: ej.ListBox.Model): JQuery; -ejListBox(memberName: any, value?: any, param?: any): any; + ejListBox(options?: ej.ListBox.Model): JQuery; + ejListBox(memberName: any, value?: any, param?: any): any; -ejListView(options?: ej.ListView.Model): JQuery; -ejListView(memberName: any, value?: any, param?: any): any; + ejListView(options?: ej.ListView.Model): JQuery; + ejListView(memberName: any, value?: any, param?: any): any; -ejMap(options?: ej.datavisualization.Map.Model): JQuery; -ejMap(memberName: any, value?: any, param?: any): any; + ejMap(options?: ej.datavisualization.Map.Model): JQuery; + ejMap(memberName: any, value?: any, param?: any): any; -ejMaskEdit(options?: ej.MaskEdit.Model): JQuery; -ejMaskEdit(memberName: any, value?: any, param?: any): any; + ejMaskEdit(options?: ej.MaskEdit.Model): JQuery; + ejMaskEdit(memberName: any, value?: any, param?: any): any; -ejMenu(options?: ej.Menu.Model): JQuery; -ejMenu(memberName: any, value?: any, param?: any): any; + ejMenu(options?: ej.Menu.Model): JQuery; + ejMenu(memberName: any, value?: any, param?: any): any; -ejNavigationDrawer(options?: ej.NavigationDrawer.Model): JQuery; -ejNavigationDrawer(memberName: any, value?: any, param?: any): any; + ejNavigationDrawer(options?: ej.NavigationDrawer.Model): JQuery; + ejNavigationDrawer(memberName: any, value?: any, param?: any): any; -ejOverview(options?: ej.datavisualization.Overview.Model): JQuery; -ejOverview(memberName: any, value?: any, param?: any): any; + ejOverview(options?: ej.datavisualization.Overview.Model): JQuery; + ejOverview(memberName: any, value?: any, param?: any): any; -ejPager(options?: ej.Pager.Model): JQuery; -ejPager(memberName: any, value?: any, param?: any): any; + ejPager(options?: ej.Pager.Model): JQuery; + ejPager(memberName: any, value?: any, param?: any): any; -ejPdfViewer(options?: ej.PdfViewer.Model): JQuery; -ejPdfViewer(memberName: any, value?: any, param?: any): any; + ejPdfViewer(options?: ej.PdfViewer.Model): JQuery; + ejPdfViewer(memberName: any, value?: any, param?: any): any; -ejPivotChart(options?: ej.PivotChart.Model): JQuery; -ejPivotChart(memberName: any, value?: any, param?: any): any; + ejPivotChart(options?: ej.PivotChart.Model): JQuery; + ejPivotChart(memberName: any, value?: any, param?: any): any; -ejPivotClient(options?: ej.PivotClient.Model): JQuery; -ejPivotClient(memberName: any, value?: any, param?: any): any; + ejPivotClient(options?: ej.PivotClient.Model): JQuery; + ejPivotClient(memberName: any, value?: any, param?: any): any; -ejPivotGauge(options?: ej.PivotGauge.Model): JQuery; -ejPivotGauge(memberName: any, value?: any, param?: any): any; + ejPivotGauge(options?: ej.PivotGauge.Model): JQuery; + ejPivotGauge(memberName: any, value?: any, param?: any): any; -ejPivotGrid(options?: ej.PivotGrid.Model): JQuery; -ejPivotGrid(memberName: any, value?: any, param?: any): any; + ejPivotGrid(options?: ej.PivotGrid.Model): JQuery; + ejPivotGrid(memberName: any, value?: any, param?: any): any; -ejPivotPager(options?: ej.PivotPager.Model): JQuery; -ejPivotPager(memberName: any, value?: any, param?: any): any; + ejPivotPager(options?: ej.PivotPager.Model): JQuery; + ejPivotPager(memberName: any, value?: any, param?: any): any; -ejPivotSchemaDesigner(options?: ej.PivotSchemaDesigner.Model): JQuery; -ejPivotSchemaDesigner(memberName: any, value?: any, param?: any): any; + ejPivotSchemaDesigner(options?: ej.PivotSchemaDesigner.Model): JQuery; + ejPivotSchemaDesigner(memberName: any, value?: any, param?: any): any; -ejPivotTreeMap(options?: ej.PivotTreeMap.Model): JQuery; -ejPivotTreeMap(memberName: any, value?: any, param?: any): any; + ejPivotTreeMap(options?: ej.PivotTreeMap.Model): JQuery; + ejPivotTreeMap(memberName: any, value?: any, param?: any): any; -ejProgressBar(options?: ej.ProgressBar.Model): JQuery; -ejProgressBar(memberName: any, value?: any, param?: any): any; + ejProgressBar(options?: ej.ProgressBar.Model): JQuery; + ejProgressBar(memberName: any, value?: any, param?: any): any; -ejRadialMenu(options?: ej.RadialMenu.Model): JQuery; -ejRadialMenu(memberName: any, value?: any, param?: any): any; + ejRadialMenu(options?: ej.RadialMenu.Model): JQuery; + ejRadialMenu(memberName: any, value?: any, param?: any): any; -ejRadialSlider(options?: ej.RadialSlider.Model): JQuery; -ejRadialSlider(memberName: any, value?: any, param?: any): any; + ejRadialSlider(options?: ej.RadialSlider.Model): JQuery; + ejRadialSlider(memberName: any, value?: any, param?: any): any; -ejRadioButton(options?: ej.RadioButton.Model): JQuery; -ejRadioButton(memberName: any, value?: any, param?: any): any; + ejRadioButton(options?: ej.RadioButton.Model): JQuery; + ejRadioButton(memberName: any, value?: any, param?: any): any; -ejRangeNavigator(options?: ej.datavisualization.RangeNavigator.Model): JQuery; -ejRangeNavigator(memberName: any, value?: any, param?: any): any; + ejRangeNavigator(options?: ej.datavisualization.RangeNavigator.Model): JQuery; + ejRangeNavigator(memberName: any, value?: any, param?: any): any; -ejRating(options?: ej.Rating.Model): JQuery; -ejRating(memberName: any, value?: any, param?: any): any; + ejRating(options?: ej.Rating.Model): JQuery; + ejRating(memberName: any, value?: any, param?: any): any; -ejRecurrenceEditor(options?: ej.RecurrenceEditor.Model): JQuery; -ejRecurrenceEditor(memberName: any, value?: any, param?: any): any; + ejRecurrenceEditor(options?: ej.RecurrenceEditor.Model): JQuery; + ejRecurrenceEditor(memberName: any, value?: any, param?: any): any; -ejReportViewer(options?: ej.ReportViewer.Model): JQuery; -ejReportViewer(memberName: any, value?: any, param?: any): any; + ejReportViewer(options?: ej.ReportViewer.Model): JQuery; + ejReportViewer(memberName: any, value?: any, param?: any): any; -ejResizable(options?: ej.Resizable.Model): JQuery; -ejResizable(memberName: any, value?: any, param?: any): any; + ejResizable(options?: ej.Resizable.Model): JQuery; + ejResizable(memberName: any, value?: any, param?: any): any; -ejRibbon(options?: ej.Ribbon.Model): JQuery; -ejRibbon(memberName: any, value?: any, param?: any): any; + ejRibbon(options?: ej.Ribbon.Model): JQuery; + ejRibbon(memberName: any, value?: any, param?: any): any; -ejRotator(options?: ej.Rotator.Model): JQuery; -ejRotator(memberName: any, value?: any, param?: any): any; + ejRotator(options?: ej.Rotator.Model): JQuery; + ejRotator(memberName: any, value?: any, param?: any): any; -ejRTE(options?: ej.RTE.Model): JQuery; -ejRTE(memberName: any, value?: any, param?: any): any; + ejRTE(options?: ej.RTE.Model): JQuery; + ejRTE(memberName: any, value?: any, param?: any): any; -ejSchedule(options?: ej.Schedule.Model): JQuery; -ejSchedule(memberName: any, value?: any, param?: any): any; + ejSchedule(options?: ej.Schedule.Model): JQuery; + ejSchedule(memberName: any, value?: any, param?: any): any; -ejScroller(options?: ej.Scroller.Model): JQuery; -ejScroller(memberName: any, value?: any, param?: any): any; + ejScroller(options?: ej.Scroller.Model): JQuery; + ejScroller(memberName: any, value?: any, param?: any): any; -ejSignature(options?: ej.Signature.Model): JQuery; -ejSignature(memberName: any, value?: any, param?: any): any; + ejSignature(options?: ej.Signature.Model): JQuery; + ejSignature(memberName: any, value?: any, param?: any): any; -ejSlider(options?: ej.Slider.Model): JQuery; -ejSlider(memberName: any, value?: any, param?: any): any; + ejSlider(options?: ej.Slider.Model): JQuery; + ejSlider(memberName: any, value?: any, param?: any): any; -ejSparkline(options?: ej.datavisualization.Sparkline.Model): JQuery; -ejSparkline(memberName: any, value?: any, param?: any): any; + ejSparkline(options?: ej.datavisualization.Sparkline.Model): JQuery; + ejSparkline(memberName: any, value?: any, param?: any): any; -ejSpellCheck(options?: ej.SpellCheck.Model): JQuery; -ejSpellCheck(memberName: any, value?: any, param?: any): any; + ejSpellCheck(options?: ej.SpellCheck.Model): JQuery; + ejSpellCheck(memberName: any, value?: any, param?: any): any; -ejSplitButton(options?: ej.SplitButton.Model): JQuery; -ejSplitButton(memberName: any, value?: any, param?: any): any; + ejSplitButton(options?: ej.SplitButton.Model): JQuery; + ejSplitButton(memberName: any, value?: any, param?: any): any; -ejSplitter(options?: ej.Splitter.Model): JQuery; -ejSplitter(memberName: any, value?: any, param?: any): any; + ejSplitter(options?: ej.Splitter.Model): JQuery; + ejSplitter(memberName: any, value?: any, param?: any): any; -ejSpreadsheet(options?: ej.Spreadsheet.Model): JQuery; -ejSpreadsheet(memberName: any, value?: any, param?: any): any; + ejSpreadsheet(options?: ej.Spreadsheet.Model): JQuery; + ejSpreadsheet(memberName: any, value?: any, param?: any): any; -ejSunburstChart(options?: ej.datavisualization.SunburstChart.Model): JQuery; -ejSunburstChart(memberName: any, value?: any, param?: any): any; + ejSunburstChart(options?: ej.datavisualization.SunburstChart.Model): JQuery; + ejSunburstChart(memberName: any, value?: any, param?: any): any; -ejSymbolPalette(options?: ej.datavisualization.SymbolPalette.Model): JQuery; -ejSymbolPalette(memberName: any, value?: any, param?: any): any; - -ejTab(options?: ej.Tab.Model): JQuery; -ejTab(memberName: any, value?: any, param?: any): any; - -ejTagCloud(options?: ej.TagCloud.Model): JQuery; -ejTagCloud(memberName: any, value?: any, param?: any): any; - -ejNumericTextbox(options?: ej.Editor.Model): JQuery; -ejNumericTextbox(memberName: any, value?: any, param?: any): any; - -ejCurrencyTextbox(options?: ej.Editor.Model): JQuery; -ejCurrencyTextbox(memberName: any, value?: any, param?: any): any; - -ejPercentageTextbox(options?: ej.Editor.Model): JQuery; -ejPercentageTextbox(memberName: any, value?: any, param?: any): any; - -ejTile(options?: ej.Tile.Model): JQuery; -ejTile(memberName: any, value?: any, param?: any): any; - -ejTimePicker(options?: ej.TimePicker.Model): JQuery; -ejTimePicker(memberName: any, value?: any, param?: any): any; - -ejToggleButton(options?: ej.ToggleButton.Model): JQuery; -ejToggleButton(memberName: any, value?: any, param?: any): any; - -ejToolbar(options?: ej.Toolbar.Model): JQuery; -ejToolbar(memberName: any, value?: any, param?: any): any; - -ejTooltip(options?: ej.Tooltip.Model): JQuery; -ejTooltip(memberName: any, value?: any, param?: any): any; - -ejTreeGrid(options?: ej.TreeGrid.Model): JQuery; -ejTreeGrid(memberName: any, value?: any, param?: any): any; - -ejTreeMap(options?: ej.datavisualization.TreeMap.Model): JQuery; -ejTreeMap(memberName: any, value?: any, param?: any): any; - -ejTreeView(options?: ej.TreeView.Model): JQuery; -ejTreeView(memberName: any, value?: any, param?: any): any; - -ejUploadbox(options?: ej.Uploadbox.Model): JQuery; -ejUploadbox(memberName: any, value?: any, param?: any): any; - -ejWaitingPopup(options?: ej.WaitingPopup.Model): JQuery; -ejWaitingPopup(memberName: any, value?: any, param?: any): any; - -data(key: "ejAccordion"): ej.Accordion; -data(key: "ejAutocomplete"): ej.Autocomplete; -data(key: "ejBarcode"): ej.datavisualization.Barcode; -data(key: "ejBulletGraph"): ej.datavisualization.BulletGraph; -data(key: "ejButton"): ej.Button; -data(key: "ejCaptcha"): ej.Captcha; -data(key: "ejChart"): ej.datavisualization.Chart; -data(key: "ejCheckBox"): ej.CheckBox; -data(key: "ejCircularGauge"): ej.datavisualization.CircularGauge; -data(key: "ejColorPicker"): ej.ColorPicker; -data(key: "ejDatePicker"): ej.DatePicker; -data(key: "ejDateRangePicker"): ej.DateRangePicker; -data(key: "ejDateTimePicker"): ej.DateTimePicker; -data(key: "ejDiagram"): ej.datavisualization.Diagram; -data(key: "ejDialog"): ej.Dialog; -data(key: "ejDigitalGauge"): ej.datavisualization.DigitalGauge; -data(key: "ejDocumentEditor"): ej.DocumentEditor; -data(key: "ejDraggable"): ej.Draggable; -data(key: "ejDropDownList"): ej.DropDownList; -data(key: "ejDroppable"): ej.Droppable; -data(key: "ejFileExplorer"): ej.FileExplorer; -data(key: "ejGantt"): ej.Gantt; -data(key: "ejGrid"): ej.Grid; -data(key: "ejGroupButton"): ej.GroupButton; -data(key: "ejHeatMap"): ej.datavisualization.HeatMap; -data(key: "ejHeatMapLegend"): ej.datavisualization.HeatMapLegend; -data(key: "ejKanban"): ej.Kanban; -data(key: "ejLinearGauge"): ej.datavisualization.LinearGauge; -data(key: "ejListBox"): ej.ListBox; -data(key: "ejListView"): ej.ListView; -data(key: "ejMap"): ej.datavisualization.Map; -data(key: "ejMaskEdit"): ej.MaskEdit; -data(key: "ejMenu"): ej.Menu; -data(key: "ejNavigationDrawer"): ej.NavigationDrawer; -data(key: "ejOverview"): ej.datavisualization.Overview; -data(key: "ejPager"): ej.Pager; -data(key: "ejPdfViewer"): ej.PdfViewer; -data(key: "ejPivotChart"): ej.PivotChart; -data(key: "ejPivotClient"): ej.PivotClient; -data(key: "ejPivotGauge"): ej.PivotGauge; -data(key: "ejPivotGrid"): ej.PivotGrid; -data(key: "ejPivotPager"): ej.PivotPager; -data(key: "ejPivotSchemaDesigner"): ej.PivotSchemaDesigner; -data(key: "ejPivotTreeMap"): ej.PivotTreeMap; -data(key: "ejProgressBar"): ej.ProgressBar; -data(key: "ejRadialMenu"): ej.RadialMenu; -data(key: "ejRadialSlider"): ej.RadialSlider; -data(key: "ejRadioButton"): ej.RadioButton; -data(key: "ejRangeNavigator"): ej.datavisualization.RangeNavigator; -data(key: "ejRating"): ej.Rating; -data(key: "ejRecurrenceEditor"): ej.RecurrenceEditor; -data(key: "ejReportViewer"): ej.ReportViewer; -data(key: "ejResizable"): ej.Resizable; -data(key: "ejRibbon"): ej.Ribbon; -data(key: "ejRotator"): ej.Rotator; -data(key: "ejRTE"): ej.RTE; -data(key: "ejSchedule"): ej.Schedule; -data(key: "ejScroller"): ej.Scroller; -data(key: "ejSignature"): ej.Signature; -data(key: "ejSlider"): ej.Slider; -data(key: "ejSparkline"): ej.datavisualization.Sparkline; -data(key: "ejSpellCheck"): ej.SpellCheck; -data(key: "ejSplitButton"): ej.SplitButton; -data(key: "ejSplitter"): ej.Splitter; -data(key: "ejSpreadsheet"): ej.Spreadsheet; -data(key: "ejSunburstChart"): ej.datavisualization.SunburstChart; -data(key: "ejSymbolPalette"): ej.datavisualization.SymbolPalette; -data(key: "ejTab"): ej.Tab; -data(key: "ejTagCloud"): ej.TagCloud; -data(key: "ejNumericTextbox"): ej.NumericTextbox; -data(key: "ejCurrencyTextbox"): ej.CurrencyTextbox; -data(key: "ejPercentageTextbox"): ej.PercentageTextbox; -data(key: "ejTile"): ej.Tile; -data(key: "ejTimePicker"): ej.TimePicker; -data(key: "ejToggleButton"): ej.ToggleButton; -data(key: "ejToolbar"): ej.Toolbar; -data(key: "ejTooltip"): ej.Tooltip; -data(key: "ejTreeGrid"): ej.TreeGrid; -data(key: "ejTreeMap"): ej.datavisualization.TreeMap; -data(key: "ejTreeView"): ej.TreeView; -data(key: "ejUploadbox"): ej.Uploadbox; -data(key: "ejWaitingPopup"): ej.WaitingPopup; + ejSymbolPalette(options?: ej.datavisualization.SymbolPalette.Model): JQuery; + ejSymbolPalette(memberName: any, value?: any, param?: any): any; + + ejTab(options?: ej.Tab.Model): JQuery; + ejTab(memberName: any, value?: any, param?: any): any; + + ejTagCloud(options?: ej.TagCloud.Model): JQuery; + ejTagCloud(memberName: any, value?: any, param?: any): any; + + ejNumericTextbox(options?: ej.Editor.Model): JQuery; + ejNumericTextbox(memberName: any, value?: any, param?: any): any; + + ejCurrencyTextbox(options?: ej.Editor.Model): JQuery; + ejCurrencyTextbox(memberName: any, value?: any, param?: any): any; + + ejPercentageTextbox(options?: ej.Editor.Model): JQuery; + ejPercentageTextbox(memberName: any, value?: any, param?: any): any; + + ejTile(options?: ej.Tile.Model): JQuery; + ejTile(memberName: any, value?: any, param?: any): any; + + ejTimePicker(options?: ej.TimePicker.Model): JQuery; + ejTimePicker(memberName: any, value?: any, param?: any): any; + + ejToggleButton(options?: ej.ToggleButton.Model): JQuery; + ejToggleButton(memberName: any, value?: any, param?: any): any; + + ejToolbar(options?: ej.Toolbar.Model): JQuery; + ejToolbar(memberName: any, value?: any, param?: any): any; + + ejTooltip(options?: ej.Tooltip.Model): JQuery; + ejTooltip(memberName: any, value?: any, param?: any): any; + + ejTreeGrid(options?: ej.TreeGrid.Model): JQuery; + ejTreeGrid(memberName: any, value?: any, param?: any): any; + + ejTreeMap(options?: ej.datavisualization.TreeMap.Model): JQuery; + ejTreeMap(memberName: any, value?: any, param?: any): any; + + ejTreeView(options?: ej.TreeView.Model): JQuery; + ejTreeView(memberName: any, value?: any, param?: any): any; + + ejUploadbox(options?: ej.Uploadbox.Model): JQuery; + ejUploadbox(memberName: any, value?: any, param?: any): any; + + ejWaitingPopup(options?: ej.WaitingPopup.Model): JQuery; + ejWaitingPopup(memberName: any, value?: any, param?: any): any; + + data(key: "ejAccordion"): ej.Accordion; + data(key: "ejAutocomplete"): ej.Autocomplete; + data(key: "ejBarcode"): ej.datavisualization.Barcode; + data(key: "ejBulletGraph"): ej.datavisualization.BulletGraph; + data(key: "ejButton"): ej.Button; + data(key: "ejCaptcha"): ej.Captcha; + data(key: "ejChart"): ej.datavisualization.Chart; + data(key: "ejCheckBox"): ej.CheckBox; + data(key: "ejCircularGauge"): ej.datavisualization.CircularGauge; + data(key: "ejColorPicker"): ej.ColorPicker; + data(key: "ejDatePicker"): ej.DatePicker; + data(key: "ejDateRangePicker"): ej.DateRangePicker; + data(key: "ejDateTimePicker"): ej.DateTimePicker; + data(key: "ejDiagram"): ej.datavisualization.Diagram; + data(key: "ejDialog"): ej.Dialog; + data(key: "ejDigitalGauge"): ej.datavisualization.DigitalGauge; + data(key: "ejDocumentEditor"): ej.DocumentEditor; + data(key: "ejDraggable"): ej.Draggable; + data(key: "ejDropDownList"): ej.DropDownList; + data(key: "ejDroppable"): ej.Droppable; + data(key: "ejFileExplorer"): ej.FileExplorer; + data(key: "ejGantt"): ej.Gantt; + data(key: "ejGrid"): ej.Grid; + data(key: "ejGroupButton"): ej.GroupButton; + data(key: "ejHeatMap"): ej.datavisualization.HeatMap; + data(key: "ejHeatMapLegend"): ej.datavisualization.HeatMapLegend; + data(key: "ejKanban"): ej.Kanban; + data(key: "ejLinearGauge"): ej.datavisualization.LinearGauge; + data(key: "ejListBox"): ej.ListBox; + data(key: "ejListView"): ej.ListView; + data(key: "ejMap"): ej.datavisualization.Map; + data(key: "ejMaskEdit"): ej.MaskEdit; + data(key: "ejMenu"): ej.Menu; + data(key: "ejNavigationDrawer"): ej.NavigationDrawer; + data(key: "ejOverview"): ej.datavisualization.Overview; + data(key: "ejPager"): ej.Pager; + data(key: "ejPdfViewer"): ej.PdfViewer; + data(key: "ejPivotChart"): ej.PivotChart; + data(key: "ejPivotClient"): ej.PivotClient; + data(key: "ejPivotGauge"): ej.PivotGauge; + data(key: "ejPivotGrid"): ej.PivotGrid; + data(key: "ejPivotPager"): ej.PivotPager; + data(key: "ejPivotSchemaDesigner"): ej.PivotSchemaDesigner; + data(key: "ejPivotTreeMap"): ej.PivotTreeMap; + data(key: "ejProgressBar"): ej.ProgressBar; + data(key: "ejRadialMenu"): ej.RadialMenu; + data(key: "ejRadialSlider"): ej.RadialSlider; + data(key: "ejRadioButton"): ej.RadioButton; + data(key: "ejRangeNavigator"): ej.datavisualization.RangeNavigator; + data(key: "ejRating"): ej.Rating; + data(key: "ejRecurrenceEditor"): ej.RecurrenceEditor; + data(key: "ejReportViewer"): ej.ReportViewer; + data(key: "ejResizable"): ej.Resizable; + data(key: "ejRibbon"): ej.Ribbon; + data(key: "ejRotator"): ej.Rotator; + data(key: "ejRTE"): ej.RTE; + data(key: "ejSchedule"): ej.Schedule; + data(key: "ejScroller"): ej.Scroller; + data(key: "ejSignature"): ej.Signature; + data(key: "ejSlider"): ej.Slider; + data(key: "ejSparkline"): ej.datavisualization.Sparkline; + data(key: "ejSpellCheck"): ej.SpellCheck; + data(key: "ejSplitButton"): ej.SplitButton; + data(key: "ejSplitter"): ej.Splitter; + data(key: "ejSpreadsheet"): ej.Spreadsheet; + data(key: "ejSunburstChart"): ej.datavisualization.SunburstChart; + data(key: "ejSymbolPalette"): ej.datavisualization.SymbolPalette; + data(key: "ejTab"): ej.Tab; + data(key: "ejTagCloud"): ej.TagCloud; + data(key: "ejNumericTextbox"): ej.NumericTextbox; + data(key: "ejCurrencyTextbox"): ej.CurrencyTextbox; + data(key: "ejPercentageTextbox"): ej.PercentageTextbox; + data(key: "ejTile"): ej.Tile; + data(key: "ejTimePicker"): ej.TimePicker; + data(key: "ejToggleButton"): ej.ToggleButton; + data(key: "ejToolbar"): ej.Toolbar; + data(key: "ejTooltip"): ej.Tooltip; + data(key: "ejTreeGrid"): ej.TreeGrid; + data(key: "ejTreeMap"): ej.datavisualization.TreeMap; + data(key: "ejTreeView"): ej.TreeView; + data(key: "ejUploadbox"): ej.Uploadbox; + data(key: "ejWaitingPopup"): ej.WaitingPopup; } From 4bd3d9ef2b03654c975194d82fe401634b8304de Mon Sep 17 00:00:00 2001 From: Christopher Cortes Date: Fri, 7 Apr 2017 09:57:57 +0200 Subject: [PATCH 220/844] Add missing parameters defaultTranslationText and forceLanguage in $translate service and filter Add missing parameters: - forceLanguage (in service and filter since v 2.9) - defaultTranslationText (in service) --- types/angular-translate/index.d.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/types/angular-translate/index.d.ts b/types/angular-translate/index.d.ts index 3b911ba313..12f48955f5 100644 --- a/types/angular-translate/index.d.ts +++ b/types/angular-translate/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for Angular Translate (pascalprecht.translate module) 2.4 +// Type definitions for Angular Translate (pascalprecht.translate module) 2.15 // Project: https://github.com/PascalPrecht/angular-translate // Definitions by: Michel Salib // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped @@ -45,8 +45,8 @@ declare module 'angular' { } interface ITranslateService { - (translationId: string, interpolateParams?: any, interpolationId?: string): angular.IPromise; - (translationId: string[], interpolateParams?: any, interpolationId?: string): angular.IPromise<{ [key: string]: string }>; + (translationId: string, interpolateParams?: any, interpolationId?: string, defaultTranslationText?: string, forceLanguage?: string): angular.IPromise; + (translationId: string[], interpolateParams?: any, interpolationId?: string, defaultTranslationText?: string, forceLanguage?: string): angular.IPromise<{ [key: string]: string }>; cloakClassName(): string; cloakClassName(name: string): ITranslateProvider; fallbackLanguage(langKey?: string): string; @@ -117,7 +117,7 @@ declare module 'angular' { interface IFilterService { (name: 'translate'): { - (translationId: string, interpolateParams?: any, interpolation?: string): string; + (translationId: string, interpolateParams?: any, interpolation?: string, forceLanguage?: string): string; }; } } From 5de998bdb76c0354d43f5ef0511e08c2aebe96a2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gr=C3=A9gory=20Houllier?= Date: Fri, 7 Apr 2017 10:17:05 +0200 Subject: [PATCH 221/844] Add type definitions for zetapush-js --- types/zetapush-js/index.d.ts | 187 +++++++++++++++++++++++++ types/zetapush-js/tsconfig.json | 22 +++ types/zetapush-js/tslint.json | 1 + types/zetapush-js/zetapush-js-tests.ts | 23 +++ 4 files changed, 233 insertions(+) create mode 100644 types/zetapush-js/index.d.ts create mode 100644 types/zetapush-js/tsconfig.json create mode 100644 types/zetapush-js/tslint.json create mode 100644 types/zetapush-js/zetapush-js-tests.ts diff --git a/types/zetapush-js/index.d.ts b/types/zetapush-js/index.d.ts new file mode 100644 index 0000000000..879f5e6f2c --- /dev/null +++ b/types/zetapush-js/index.d.ts @@ -0,0 +1,187 @@ +// Type definitions for zetapush-js 3.1 +// Project: https://github.com/zetapush/zetapush-js +// Definitions by: ghoullier +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +interface HandshakeFields { + ext: any; +} + +interface AbstractHandshakeOptions { + authType: string; + sandboxId: string; + deploymentId: string; +} + +interface CredentialsHandshakeOptions { + authType: string; + deploymentId: string; + login: string; + password: string; +} + +interface TokenHandshakeOptions { + authType: string; + deploymentId: string; + token: string; +} + +interface AbstractHandshake { + authType: string; + authVersion: string; + sandboxId: string; + deploymentId: string; + getHandshakeFields(client: Client): HandshakeFields; +} + +interface CredentialsAuthData { + login: string; + password: string; +} + +interface CredentialsHandshake extends AbstractHandshake { + login: string; + password: string; + authData: CredentialsAuthData; +} + +interface TokenAuthData { + token: string; +} + +interface TokenHandshake extends AbstractHandshake { + token: string; + authData: TokenAuthData; +} + +type AuthenticationCallback = () => AbstractHandshake; + +type AsyncMacroServicePublisher = (method: string, parameters: any, hardFail?: boolean, debug?: number) => Promise; + +type MacroServicePublisher = (method: string, parameters: any, hardFail?: boolean, debug?: number) => void; + +type ServicePublisher = (method: string, parameters: any) => void; + +interface Options { + apiUrl?: string; + sandboxId: string; + forceHttps?: boolean; + resource?: string; + transports?: any[]; +} + +interface ClientOptions extends Options { + authentication(): AbstractHandshake; +} + +interface WeakClientOptions extends Options { + deploymentId?: string; +} + +interface Services { + Macro: AsyncMacroService; + Messaging: Service; +} + +interface Service { + DEFAULT_DEPLOYMENT_ID: string; + $publish: ServicePublisher; +} + +interface AsyncMacroService { + DEFAULT_DEPLOYMENT_ID: string; + $publish: AsyncMacroServicePublisher; +} + +interface MacroService { + DEFAULT_DEPLOYMENT_ID: string; + $publish: MacroServicePublisher; +} + +interface ServiceDeclaration { + Type: Service; + deploymentId?: string; +} + +interface Token { + token: string; +} + +interface Credentials { + login: string; + password: string; +} + +interface ClientHelper { + authentication: AuthenticationCallback; + servers: Promise; + getUniqRequestId(): string; +} + +type ConnectionStatusHandler = number; + +export class Authentication { + static delegating({ token }: TokenAuthData): TokenHandshake; + static simple({ login, password }: CredentialsAuthData): CredentialsHandshake; + static weak({ token }: TokenAuthData): TokenHandshake; +} + +export interface ConnectionStatusListener { + onConnectionBroken(): void; + onConnectionClosed(): void; + onConnectionEstablished(): void; + onConnectionToServerFail(failure: any): void; + onConnectionWillClose(): void; + onFailedHandshake(failure: any): void; + onMessageLost(): void; + onNoServerUrlAvailable(): void; + onSuccessfulHandshake(authentication: any): void; +} + +export class Client { + helper: ClientHelper; + constructor(options: ClientOptions); + addConnectionStatusListener(listener: ConnectionStatusListener): ConnectionStatusHandler; + connect(): void; + createService(declaration: ServiceDeclaration): Service; + createAsyncMacroService(declaration: ServiceDeclaration): AsyncMacroService; + disconnect(): void; + isConnected(): boolean; + getSandboxId(): string; + getResource(): string; + getUserId(): string; + removeConnectionStatusListener(listener: ConnectionStatusHandler): void; + setAuthentication(authentication: AuthenticationCallback): void; + setLogLevel(level: string): void; + setResource(resource: string): void; + unsubscribe(service: Service): void; + // + onConnectionBroken(handler: () => void): void; + onConnectionClosed(handler: () => void): void; + onConnectionEstablished(handler: () => void): void; + onConnectionToServerFail(handler: (failure: any) => void): void; + onConnectionWillClose(handler: () => void): void; + onFailedHandshake(handler: (failure: any) => void): void; + onMessageLost(handler: () => void): void; + onNoServerUrlAvailable(handler: () => void): void; + onSuccessfulHandshake(handler: (authentication: any) => void): void; +} + +export class SmartClient extends Client { + getCredentials(): any; + getSession(): any; + hasCredentials(): boolean; + isStronglyAuthenticated(session?: any): boolean; + isWeaklyAuthenticated(session?: any): boolean; + setCredentials(credentials: any): void; +} +export class WeakClient extends Client { + constructor(options: WeakClientOptions); + getToken(): Token; +} + +export const services: Services; + +export const VERSION: string; + +export as namespace ZetaPush; diff --git a/types/zetapush-js/tsconfig.json b/types/zetapush-js/tsconfig.json new file mode 100644 index 0000000000..78526186fb --- /dev/null +++ b/types/zetapush-js/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "zetapush-js-tests.ts" + ] +} diff --git a/types/zetapush-js/tslint.json b/types/zetapush-js/tslint.json new file mode 100644 index 0000000000..377cc837d4 --- /dev/null +++ b/types/zetapush-js/tslint.json @@ -0,0 +1 @@ +{ "extends": "../tslint.json" } diff --git a/types/zetapush-js/zetapush-js-tests.ts b/types/zetapush-js/zetapush-js-tests.ts new file mode 100644 index 0000000000..46eb822680 --- /dev/null +++ b/types/zetapush-js/zetapush-js-tests.ts @@ -0,0 +1,23 @@ +import { Authentication, Client, WeakClient } from 'zetapush-js'; + +const weak = new WeakClient({ + sandboxId: '' +}); + +weak.onConnectionEstablished(() => { + // onConnectionEstablished; +}); +weak.connect(); + +const client = new Client({ + apiUrl: '', + sandboxId: '', + authentication: () => Authentication.simple({ + login: 'login', + password: 'password' + }) +}); +client.onConnectionEstablished(() => { + // onConnectionEstablished; +}); +client.connect(); From d7fdf71f8c4ec7a6f7c1ff4deb24e67396f6227b Mon Sep 17 00:00:00 2001 From: Alan Agius Date: Fri, 7 Apr 2017 10:57:56 +0200 Subject: [PATCH 222/844] feat(commander): improve typyings and fix lint issues --- types/commander/commander-tests.ts | 18 +- types/commander/index.d.ts | 380 +++++++++-------------------- 2 files changed, 128 insertions(+), 270 deletions(-) diff --git a/types/commander/commander-tests.ts b/types/commander/commander-tests.ts index 78bd873782..fe09be7b34 100644 --- a/types/commander/commander-tests.ts +++ b/types/commander/commander-tests.ts @@ -15,20 +15,20 @@ if (program['pineapple']) console.log(' - pineapple'); if (program['bbq']) console.log(' - bbq'); console.log(' - %s cheese', program['cheese']); -function range(val:string) { +function range(val: string) { return val.split('..').map(Number); } -function list(val:string) { +function list(val: string) { return val.split(','); } -function collect(val:string, memo:string[]) { +function collect(val: string, memo: string[]) { memo.push(val); return memo; } -function increaseVerbosity(v:any, total:number) { +function increaseVerbosity(v: any, total: number) { return total + 1; } @@ -80,11 +80,11 @@ program }); program - .version('0.0.1') - .arguments(' [env]') - .action(function (cmd, env) { - console.log(cmd, env); - }); + .version('0.0.1') + .arguments(' [env]') + .action((cmd, env) => { + console.log(cmd, env); + }); program.parse(process.argv); diff --git a/types/commander/index.d.ts b/types/commander/index.d.ts index 15a3246710..e109b618fd 100644 --- a/types/commander/index.d.ts +++ b/types/commander/index.d.ts @@ -1,27 +1,53 @@ -// Type definitions for commanderjs 2.3.0 +// Type definitions for commander 2.9 // Project: https://github.com/visionmedia/commander.js -// Definitions by: Marcelo Dezem , vvakame +// Definitions by: Alan Agius // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped /// -declare var commander: commander.IExportedCommand; -export = commander; - declare namespace commander { - interface ICommandStatic { + + interface CommandOptions { + noHelp?: boolean; + isDefault?: boolean; + } + + interface ParseOptionsResult { + args: string[]; + unknown: string[]; + } + + class Option { + /** + * Initialize a new `Option` with the given `flags` and `description`. + * + * @param {string} flags + * @param {string} [description] + */ + constructor(flags: string, description?: string); + } + + class Command extends NodeJS.EventEmitter { + args: string[]; + /** * Initialize a new `Command`. * - * @param {String} name - * @api public + * @param {string} [name] */ - new (name?:string):ICommand; - } + constructor(name?: string); - interface ICommand extends NodeJS.EventEmitter { - args: string[]; - _args: { required:boolean; name: string; }[]; + /** + * Set the program version to `str`. + * + * This method auto-registers the "-V, --version" flag + * which will print the version number when passed. + * + * @param {string} str + * @param {string} [flags] + * @returns {Command} for chaining + */ + version(str: string, flags?: string): Command; /** * Add command `name`. @@ -35,8 +61,7 @@ declare namespace commander { * will be passed as the first arg, followed by * the rest of __ARGV__ remaining. * - * Examples: - * + * @example * program * .version('0.0.1') * .option('-C, --chdir ', 'change the working directory') @@ -46,75 +71,78 @@ declare namespace commander { * program * .command('setup') * .description('run remote setup commands') - * .action(function(){ + * .action(function() { * console.log('setup'); * }); * * program * .command('exec ') * .description('run the given remote command') - * .action(function(cmd){ + * .action(function(cmd) { * console.log('exec "%s"', cmd); * }); * * program + * .command('teardown [otherDirs...]') + * .description('run teardown commands') + * .action(function(dir, otherDirs) { + * console.log('dir "%s"', dir); + * if (otherDirs) { + * otherDirs.forEach(function (oDir) { + * console.log('dir "%s"', oDir); + * }); + * } + * }); + * + * program * .command('*') * .description('deploy the given env') - * .action(function(env){ + * .action(function(env) { * console.log('deploying "%s"', env); * }); * * program.parse(process.argv); * - * @param {String} name - * @param {String} [desc] - * @param {Mixed} [opts] - * @return {Command} the new command - * @api public + * @param {string} name + * @param {string} [desc] for git-style sub-commands + * @param {CommandOptions} [opts] command options + * @returns {Command} the new command */ - command(name:string, desc?:string, opts?: any):ICommand; + command(name: string, desc?: string, opts?: CommandOptions): Command; + /** - * Set / get the arguments usage `str`. - */ - arguments(str: string):ICommand; - - /** - * Add an implicit `help [cmd]` subcommand - * which invokes `--help` for the given command. + * Define argument syntax for the top-level command. * - * @api private + * @param {string} desc + * @returns {Command} for chaining */ - addImplicitHelpCommand():void; + arguments(desc: string): Command; /** * Parse expected `args`. * * For example `["[type]"]` becomes `[{ required: false, name: 'type' }]`. * - * @param {Array} args - * @return {Command} for chaining - * @api public + * @param {string[]} args + * @returns {Command} for chaining */ - parseExpectedArgs(args:string[]):ICommand; - + parseExpectedArgs(args: string[]): Command; /** * Register callback `fn` for the command. * - * Examples: - * + * @example * program * .command('help') * .description('display verbose help') - * .action(function(){ + * .action(function() { * // output help here * }); * - * @param {Function} fn - * @return {Command} for chaining - * @api public - */ - action(fn:(...args:any[])=>void):ICommand; + * @param {(...args: any[]) => void} fn + * @returns {Command} for chaining + */ + action(fn: (...args: any[]) => void): Command; /** * Define option with `flags`, `description` and optional @@ -128,8 +156,7 @@ declare namespace commander { * "-p|--pepper" * "-p --pepper" * - * Examples: - * + *@example * // simple boolean defaulting to false * program.option('-p, --pepper', 'add pepper'); * @@ -157,260 +184,91 @@ declare namespace commander { * // optional argument * program.option('-c, --cheese [type]', 'add cheese [marble]'); * - * @param {String} flags - * @param {String} description - * @param {Function|Mixed} fn or default - * @param {Mixed} defaultValue - * @return {Command} for chaining - * @api public + * @param {string} flags + * @param {string} [description] + * @param {((arg1: any, arg2: any) => void) | RegExp} [fn] function or default + * @param {*} [defaultValue] + * @returns {Command} for chaining */ - option(flags:string, description?:string, fn?:((arg1:any, arg2:any)=>void)|RegExp, defaultValue?:any):ICommand; - option(flags:string, description?:string, defaultValue?:any):ICommand; + option(flags: string, description?: string, fn?: ((arg1: any, arg2: any) => void) | RegExp, defaultValue?: any): Command; + option(flags: string, description?: string, defaultValue?: any): Command; /** * Allow unknown options on the command line. * - * @param {Boolean} arg if `true` or omitted, no error will be thrown - * for unknown options. - * @api public + * @param {boolean} [arg] if `true` or omitted, no error will be thrown for unknown options. + * @returns {Command} for chaining */ - allowUnknownOption(arg?: boolean):ICommand; + allowUnknownOption(arg?: boolean): Command; /** * Parse `argv`, settings options and invoking commands when defined. * - * @param {Array} argv - * @return {Command} for chaining - * @api public + * @param {string[]} argv + * @returns {Command} for chaining */ - parse(argv:string[]):ICommand; + parse(argv: string[]): Command; /** - * Execute a sub-command executable. + * Parse options from `argv` returning `argv` void of these options. * - * @param {Array} argv - * @param {Array} args - * @param {Array} unknown - * @api private + * @param {string[]} argv + * @returns {ParseOptionsResult} */ - executeSubCommand(argv:string[], args:string[], unknown:string[]):any; /* child_process.ChildProcess */ - - /** - * Normalize `args`, splitting joined short flags. For example - * the arg "-abc" is equivalent to "-a -b -c". - * This also normalizes equal sign and splits "--abc=def" into "--abc def". - * - * @param {Array} args - * @return {Array} - * @api private - */ - normalize(args:string[]):string[]; - - /** - * Parse command `args`. - * - * When listener(s) are available those - * callbacks are invoked, otherwise the "*" - * event is emitted and those actions are invoked. - * - * @param {Array} args - * @return {Command} for chaining - * @api private - */ - parseArgs(args:string[], unknown:string[]):ICommand; - - /** - * Return an option matching `arg` if any. - * - * @param {String} arg - * @return {Option} - * @api private - */ - optionFor(arg:string):IOption; - - /** - * Parse options from `argv` returning `argv` - * void of these options. - * - * @param {Array} argv - * @return {Array} - * @api public - */ - parseOptions(argv:string[]): {args:string[]; unknown:string[];}; + parseOptions(argv: string[]): ParseOptionsResult; /** * Return an object containing options as key-value pairs * - * @return {Object} - * @api public + * @returns {{[key: string]: string}} */ - opts():any; - - /** - * Argument `name` is missing. - * - * @param {String} name - * @api private - */ - missingArgument(name:string):void; - - /** - * `Option` is missing an argument, but received `flag` or nothing. - * - * @param {String} option - * @param {String} flag - * @api private - */ - optionMissingArgument(option:{flags:string;}, flag?:string):void; - - /** - * Unknown option `flag`. - * - * @param {String} flag - * @api private - */ - unknownOption(flag:string):void; - - /** - * Set the program version to `str`. - * - * This method auto-registers the "-V, --version" flag - * which will print the version number when passed. - * - * @param {String} str - * @param {String} flags - * @return {Command} for chaining - * @api public - */ - version(str:string, flags?:string):ICommand; + opts(): { [key: string]: string }; /** * Set the description to `str`. * - * @param {String} str - * @return {String|Command} - * @api public + * @param {string} str + * @return {(Command | string)} */ - description(str:string):ICommand; - description():string; + description(str: string): Command; + description(): string; /** - * Set an alias for the command + * Set an alias for the command. * - * @param {String} alias - * @return {String|Command} - * @api public + * @param {string} alias + * @return {(Command | string)} */ - alias(alias:string):ICommand; - alias():string; + alias(alias: string): Command; + alias(): string; /** - * Set / get the command usage `str`. + * Set or get the command usage. * - * @param {String} str - * @return {String|Command} - * @api public + * @param {string} str + * @return {(Command | string)} */ - usage(str:string):ICommand; - usage():string; + usage(str: string): Command; + usage(): string; /** - * Get the name of the command + * Get the name of the command. * - * @param {String} name - * @return {String|Command} - * @api public + * @return {string} */ - name():string; + name(): string; /** - * Return the largest option length. + * Output help information for this command. * - * @return {Number} - * @api private + * @param {() => void} [cb] Callback method */ - largestOptionLength():number; + outputHelp(cb?: () => void): void; - /** - * Return help for options. - * - * @return {String} - * @api private - */ - optionHelp():string; - - /** - * Return command help documentation. - * - * @return {String} - * @api private - */ - commandHelp():string; - - /** - * Return program help documentation. - * - * @return {String} - * @api private - */ - helpInformation():string; - - /** - * Output help information for this command - * - * @api public - */ - outputHelp():void; - - /** - * Output help information and exit. - * - * @api public - */ - help():void; - } - - interface IOptionStatic { - /** - * Initialize a new `Option` with the given `flags` and `description`. - * - * @param {String} flags - * @param {String} description - * @api public - */ - new (flags:string, description?:string):IOption; - } - - interface IOption { - flags:string; - required:boolean; - optional:boolean; - bool:boolean; - short?:string; - long:string; - description:string; - - /** - * Return option name. - * - * @return {String} - * @api private - */ - name():string; - - /** - * Check if `arg` matches the short or long flag. - * - * @param {String} arg - * @return {Boolean} - * @api private - */ - is(arg:string):boolean; - } - - interface IExportedCommand extends ICommand { - Command: commander.ICommandStatic; - Option: commander.IOptionStatic; - [key: string]: any; + /** Output help information and exit. */ + help(): void; } } + +declare var command: commander.Command & { [key: string]: any }; +export = command; From 4c4ffd71988a167025419a662db69a5ba11f4139 Mon Sep 17 00:00:00 2001 From: Alan Agius Date: Fri, 7 Apr 2017 11:00:00 +0200 Subject: [PATCH 223/844] add definitions by --- types/commander/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/commander/index.d.ts b/types/commander/index.d.ts index e109b618fd..0269cfba4a 100644 --- a/types/commander/index.d.ts +++ b/types/commander/index.d.ts @@ -1,6 +1,6 @@ // Type definitions for commander 2.9 // Project: https://github.com/visionmedia/commander.js -// Definitions by: Alan Agius +// Definitions by: Alan Agius , Marcelo Dezem , vvakame // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped /// From 550f778e02830258e503c54bca607ce9cd89de55 Mon Sep 17 00:00:00 2001 From: Alan Agius Date: Fri, 7 Apr 2017 11:01:40 +0200 Subject: [PATCH 224/844] fix export type --- types/commander/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/commander/index.d.ts b/types/commander/index.d.ts index 0269cfba4a..62aa90a536 100644 --- a/types/commander/index.d.ts +++ b/types/commander/index.d.ts @@ -270,5 +270,5 @@ declare namespace commander { } } -declare var command: commander.Command & { [key: string]: any }; +declare var command: commander.Command & commander.Option & { [key: string]: any }; export = command; From fbfa15186b5d4830da1daf10869c4d45992e85e8 Mon Sep 17 00:00:00 2001 From: Alan Agius Date: Fri, 7 Apr 2017 11:01:58 +0200 Subject: [PATCH 225/844] style(commander): fix lint issues --- types/commander/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/commander/index.d.ts b/types/commander/index.d.ts index 62aa90a536..3f6a29dfe6 100644 --- a/types/commander/index.d.ts +++ b/types/commander/index.d.ts @@ -270,5 +270,5 @@ declare namespace commander { } } -declare var command: commander.Command & commander.Option & { [key: string]: any }; +declare var command: commander.Command & commander.Option & { [key: string]: any }; export = command; From 0c90377d9f05d846cd675fded3aa423514c327b1 Mon Sep 17 00:00:00 2001 From: Alan Agius Date: Fri, 7 Apr 2017 11:04:45 +0200 Subject: [PATCH 226/844] add option properties --- types/commander/index.d.ts | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/types/commander/index.d.ts b/types/commander/index.d.ts index 3f6a29dfe6..675ece0417 100644 --- a/types/commander/index.d.ts +++ b/types/commander/index.d.ts @@ -18,6 +18,14 @@ declare namespace commander { } class Option { + flags: string; + required: boolean; + optional: boolean; + bool: boolean; + short?: string; + long: string; + description: string; + /** * Initialize a new `Option` with the given `flags` and `description`. * From 2e2233326acf400dd35d5cd750f0e0645320b332 Mon Sep 17 00:00:00 2001 From: Daniel Roth Date: Fri, 7 Apr 2017 13:17:57 +0200 Subject: [PATCH 227/844] Add support for type number on TextFields --- types/material-ui/index.d.ts | 5 ++++- types/material-ui/material-ui-tests.tsx | 6 ++++++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/types/material-ui/index.d.ts b/types/material-ui/index.d.ts index 5fd8628598..bcf546b267 100644 --- a/types/material-ui/index.d.ts +++ b/types/material-ui/index.d.ts @@ -1,6 +1,6 @@ // Type definitions for material-ui v0.16.0 // Project: https://github.com/callemall/material-ui -// Definitions by: Nathan Brown , Oliver Herrmann +// Definitions by: Nathan Brown , Oliver Herrmann , Daniel Roth // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.2 @@ -1796,6 +1796,9 @@ declare namespace __MaterialUI { underlineStyle?: React.CSSProperties; value?: string | number; autoFocus?: boolean; + min?: number; + max?: number; + step?: number; } export class TextField extends React.Component { blur(): void; diff --git a/types/material-ui/material-ui-tests.tsx b/types/material-ui/material-ui-tests.tsx index 6e60d6fc0e..cf160761d9 100644 --- a/types/material-ui/material-ui-tests.tsx +++ b/types/material-ui/material-ui-tests.tsx @@ -4740,6 +4740,12 @@ const TextFieldExampleSimple = () => (
    + ); From 1eb7cdd9157fbe022736bc7b645987927d913f5e Mon Sep 17 00:00:00 2001 From: Simon Paulger Date: Fri, 7 Apr 2017 14:12:24 +0100 Subject: [PATCH 228/844] Upgrade PouchDB support to v6.1.2 --- types/pouchdb-adapter-fruitdown/index.d.ts | 2 +- types/pouchdb-adapter-http/index.d.ts | 2 +- types/pouchdb-adapter-idb/index.d.ts | 2 +- types/pouchdb-adapter-leveldb/index.d.ts | 2 +- types/pouchdb-adapter-localstorage/index.d.ts | 2 +- types/pouchdb-adapter-memory/index.d.ts | 2 +- types/pouchdb-adapter-node-websql/index.d.ts | 2 +- types/pouchdb-adapter-websql/index.d.ts | 2 +- types/pouchdb-browser/index.d.ts | 5 +- types/pouchdb-core/index.d.ts | 47 +++++++++++++------ types/pouchdb-core/pouchdb-core-tests.ts | 16 ++++++- types/pouchdb-http/index.d.ts | 2 +- types/pouchdb-mapreduce/index.d.ts | 8 ++-- types/pouchdb-node/index.d.ts | 2 +- types/pouchdb-replication/index.d.ts | 2 +- types/pouchdb/index.d.ts | 2 +- 16 files changed, 65 insertions(+), 35 deletions(-) diff --git a/types/pouchdb-adapter-fruitdown/index.d.ts b/types/pouchdb-adapter-fruitdown/index.d.ts index e1323d55bf..cb759cd3ed 100644 --- a/types/pouchdb-adapter-fruitdown/index.d.ts +++ b/types/pouchdb-adapter-fruitdown/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for pouchdb-adapter-fruitdown v5.4.4 +// Type definitions for pouchdb-adapter-fruitdown v6.1.2 // Project: https://pouchdb.com/ // Definitions by: Andy Brown , Brian Geppert , Frederico GalvĂ£o // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped diff --git a/types/pouchdb-adapter-http/index.d.ts b/types/pouchdb-adapter-http/index.d.ts index 44eeb955ac..65b56312c0 100644 --- a/types/pouchdb-adapter-http/index.d.ts +++ b/types/pouchdb-adapter-http/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for pouchdb-http v5.4.4 +// Type definitions for pouchdb-http v6.1.2 // Project: https://pouchdb.com/ // Definitions by: Andy Brown , Brian Geppert , Frederico GalvĂ£o // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped diff --git a/types/pouchdb-adapter-idb/index.d.ts b/types/pouchdb-adapter-idb/index.d.ts index 196739f486..059ad35ab4 100644 --- a/types/pouchdb-adapter-idb/index.d.ts +++ b/types/pouchdb-adapter-idb/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for pouchdb-adapter-idb v5.4.4 +// Type definitions for pouchdb-adapter-idb v6.1.2 // Project: https://pouchdb.com/ // Definitions by: Andy Brown , Brian Geppert , Frederico GalvĂ£o // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped diff --git a/types/pouchdb-adapter-leveldb/index.d.ts b/types/pouchdb-adapter-leveldb/index.d.ts index b335754619..ebe8ed915c 100644 --- a/types/pouchdb-adapter-leveldb/index.d.ts +++ b/types/pouchdb-adapter-leveldb/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for pouchdb-adapter-leveldb v5.4.4 +// Type definitions for pouchdb-adapter-leveldb v6.1.2 // Project: https://pouchdb.com/ // Definitions by: Andy Brown , Brian Geppert , Frederico GalvĂ£o // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped diff --git a/types/pouchdb-adapter-localstorage/index.d.ts b/types/pouchdb-adapter-localstorage/index.d.ts index 207cda4899..2dcb08743a 100644 --- a/types/pouchdb-adapter-localstorage/index.d.ts +++ b/types/pouchdb-adapter-localstorage/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for pouchdb-adapter-localstorage v5.4.4 +// Type definitions for pouchdb-adapter-localstorage v6.1.2 // Project: https://pouchdb.com/ // Definitions by: Andy Brown , Brian Geppert , Frederico GalvĂ£o // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped diff --git a/types/pouchdb-adapter-memory/index.d.ts b/types/pouchdb-adapter-memory/index.d.ts index ae14dfdef8..22c31fa0b0 100644 --- a/types/pouchdb-adapter-memory/index.d.ts +++ b/types/pouchdb-adapter-memory/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for pouchdb-adapter-memory v5.4.4 +// Type definitions for pouchdb-adapter-memory v6.1.2 // Project: https://pouchdb.com/ // Definitions by: Andy Brown , Brian Geppert , Frederico GalvĂ£o // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped diff --git a/types/pouchdb-adapter-node-websql/index.d.ts b/types/pouchdb-adapter-node-websql/index.d.ts index f77a1ebd57..79d7d54172 100644 --- a/types/pouchdb-adapter-node-websql/index.d.ts +++ b/types/pouchdb-adapter-node-websql/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for pouchdb-adapter-node-websql v5.4.4 +// Type definitions for pouchdb-adapter-node-websql v6.1.2 // Project: https://pouchdb.com/ // Definitions by: Andy Brown , Brian Geppert , Frederico GalvĂ£o // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped diff --git a/types/pouchdb-adapter-websql/index.d.ts b/types/pouchdb-adapter-websql/index.d.ts index 4e0ee1cfe9..1fe9fb7809 100644 --- a/types/pouchdb-adapter-websql/index.d.ts +++ b/types/pouchdb-adapter-websql/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for pouchdb-adapter-websql v5.4.4 +// Type definitions for pouchdb-adapter-websql v6.1.2 // Project: https://pouchdb.com/ // Definitions by: Andy Brown , Brian Geppert , Frederico GalvĂ£o // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped diff --git a/types/pouchdb-browser/index.d.ts b/types/pouchdb-browser/index.d.ts index cab27f1e94..aaf72036bc 100644 --- a/types/pouchdb-browser/index.d.ts +++ b/types/pouchdb-browser/index.d.ts @@ -1,10 +1,11 @@ -// Type definitions for pouchdb-browser v5.4.4 +// Type definitions for pouchdb-browser v6.1.2 // Project: https://pouchdb.com/ -// Definitions by: Andy Brown , Brian Geppert , Frederico GalvĂ£o +// Definitions by: Simon Paulger , Andy Brown , Brian Geppert , Frederico GalvĂ£o // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped /// /// +/// /// /// /// diff --git a/types/pouchdb-core/index.d.ts b/types/pouchdb-core/index.d.ts index f591e521ca..ec555101e6 100644 --- a/types/pouchdb-core/index.d.ts +++ b/types/pouchdb-core/index.d.ts @@ -1,6 +1,6 @@ -// Type definitions for pouchdb-core v6.0.7 +// Type definitions for pouchdb-core v6.1.2 // Project: https://pouchdb.com/ -// Definitions by: Jakub Navratil , Andy Brown , Brian Geppert , Frederico GalvĂ£o +// Definitions by: Simon Paulger , Jakub Navratil , Andy Brown , Brian Geppert , Frederico GalvĂ£o // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped /// @@ -55,6 +55,15 @@ declare namespace PouchDB { rev: RevisionId; status: Availability; } + interface RevisionDiffList { + [documentId : string]: string[]; + } + interface RevisionDiff { + [change : string]: string[]; + } + interface RevisionDiffResponse { + [documentId : string]: RevisionDiff + } interface IdMeta { _id: DocumentId; @@ -206,6 +215,13 @@ declare namespace PouchDB { new_edits?: boolean; } + interface BulkGetOptions extends Options { + docs: any, + revs?: boolean, + attachments?: boolean, + binary?: boolean + } + interface ChangesMeta { _conflicts?: RevisionId[]; _deleted?: boolean; @@ -320,6 +336,9 @@ declare namespace PouchDB { /** Return attachment data as Blobs/Buffers, instead of as base64-encoded strings. */ binary?: boolean; + + /** Forces retrieving latest “leaf†revision, no matter what rev was requested. */ + latest?: boolean; } interface GetOpenRevisions extends Options { @@ -332,7 +351,6 @@ declare namespace PouchDB { revs?: boolean; } - /** @todo does this have any other properties? */ interface PutOptions extends Options { } interface PostOptions extends PutOptions { @@ -342,9 +360,6 @@ declare namespace PouchDB { interval?: number; } - interface InfoOptions extends Options { - } - interface RemoveAttachmentResponse extends BasicResponse { rev: Core.RevisionId; } @@ -563,8 +578,6 @@ declare namespace PouchDB { * see inconsistent results. */ put(doc: Core.PutDocument, - id: Core.DocumentId | null, - revision: Core.RevisionId | null, options: Core.PutOptions | null, callback: Core.Callback): void; @@ -577,8 +590,6 @@ declare namespace PouchDB { * see inconsistent results. */ put(doc: Core.PutDocument, - id?: Core.DocumentId, - revision?: Core.RevisionId, options?: Core.PutOptions): Promise; /** Remove a doc from the database */ @@ -602,11 +613,10 @@ declare namespace PouchDB { options?: Core.Options): Promise; /** Get database information */ - info(options: Core.InfoOptions | null, - callback: Core.Callback): void; + info(callback: Core.Callback): void; /** Get database information */ - info(options?: Core.InfoOptions): Promise; + info(): Promise; /** * A list of changes made to documents in the database, in the order they were made. @@ -711,11 +721,18 @@ declare namespace PouchDB { rev: Core.RevisionId): Promise; /** Given a set of document/revision IDs, returns the document bodies (and, optionally, attachment data) for each ID/revision pair specified. */ - bulkGet(options: any, + bulkGet(options: Core.BulkGetOptions, callback: Core.Callback): void; /** Given a set of document/revision IDs, returns the document bodies (and, optionally, attachment data) for each ID/revision pair specified. */ - bulkGet(options: any): Promise; + bulkGet(options: Core.BulkGetOptions): Promise; + + /** Given a set of document/revision IDs, returns the subset of those that do not correspond to revisions stored in the database */ + revsDiff(diff : Core.RevisionDiffList, + callback: Core.Callback): void; + + /** Given a set of document/revision IDs, returns the subset of those that do not correspond to revisions stored in the database */ + revsDiff(diff : Core.RevisionDiffList): Promise; } } diff --git a/types/pouchdb-core/pouchdb-core-tests.ts b/types/pouchdb-core/pouchdb-core-tests.ts index 2f047d40d2..fd8ac57359 100644 --- a/types/pouchdb-core/pouchdb-core-tests.ts +++ b/types/pouchdb-core/pouchdb-core-tests.ts @@ -53,6 +53,18 @@ namespace PouchDBCoreTests { }); } + function testBulkGet() { + const db = new PouchDB<{}>(); + db.bulkGet({docs: [{id: 'a', rev: 'b'}, {id: 'b', rev: 'c'}, {id: 'c', rev: 'd'}]}).then((result) => {}); + db.bulkGet({docs: [{id: 'a', rev: 'b'}, {id: 'b', rev: 'c'}, {id: 'c', rev: 'd'}]}, (error, response) => {}); + } + + function testRevsDiff() { + const db = new PouchDB<{}>(); + db.revsDiff({'a': ['1-a', '2-b']}).then((result) => {}); + db.revsDiff({'a': ['1-a', '2-b']}, (error, response) => {}); + } + function testCompact() { const db = new PouchDB<{}>(); // Promise version @@ -92,12 +104,12 @@ namespace PouchDBCoreTests { db.put(model).then((error) => { }); - db.put(model, null, null, null, (error) => { + db.put(model, null, (error) => { }); db.info().then((info) => { }); - db.info({ ajax: { cache: true }}, (error, result) => { + db.info((error, result) => { }); PouchDB.debug.enable('*'); diff --git a/types/pouchdb-http/index.d.ts b/types/pouchdb-http/index.d.ts index e2e6043138..4c4226f3a3 100644 --- a/types/pouchdb-http/index.d.ts +++ b/types/pouchdb-http/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for pouchdb-http v5.4.4 +// Type definitions for pouchdb-http v6.1.2 // Project: https://pouchdb.com/ // Definitions by: Andy Brown , Brian Geppert , Frederico GalvĂ£o // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped diff --git a/types/pouchdb-mapreduce/index.d.ts b/types/pouchdb-mapreduce/index.d.ts index 9d60fa40ef..41b79da1ac 100644 --- a/types/pouchdb-mapreduce/index.d.ts +++ b/types/pouchdb-mapreduce/index.d.ts @@ -1,6 +1,6 @@ -// Type definitions for pouchdb-mapreduce v5.4.4 +// Type definitions for pouchdb-mapreduce v6.1.2 // Project: https://pouchdb.com/ -// Definitions by: Andy Brown , Brian Geppert , Frederico GalvĂ£o +// Definitions by: Simon Paulger , Andy Brown , Brian Geppert , Frederico GalvĂ£o , Simon Paulger // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped /// @@ -76,7 +76,7 @@ declare namespace PouchDB { * to take up space on disk. viewCleanup() removes these unnecessary * index files. */ - viewCleanup(callback: PouchDB.Core.Callback): void; + viewCleanup(callback: PouchDB.Core.Callback): void; /** * Cleans up any stale map/reduce indexes. * @@ -85,7 +85,7 @@ declare namespace PouchDB { * to take up space on disk. viewCleanup() removes these unnecessary * index files. */ - viewCleanup(): Promise; + viewCleanup(): Promise; /** * Invoke a map/reduce function, which allows you to perform more complex queries diff --git a/types/pouchdb-node/index.d.ts b/types/pouchdb-node/index.d.ts index fe25d5d7b3..10345db296 100644 --- a/types/pouchdb-node/index.d.ts +++ b/types/pouchdb-node/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for pouchdb-node v5.4.4 +// Type definitions for pouchdb-node v6.1.2 // Project: https://pouchdb.com/ // Definitions by: Andy Brown , Brian Geppert , Frederico GalvĂ£o // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped diff --git a/types/pouchdb-replication/index.d.ts b/types/pouchdb-replication/index.d.ts index b1f30a0360..057653bada 100644 --- a/types/pouchdb-replication/index.d.ts +++ b/types/pouchdb-replication/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for pouchdb-replication v6.0.7 +// Type definitions for pouchdb-replication v6.1.2 // Project: https://pouchdb.com/ // Definitions by: Jakub Navratil // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped diff --git a/types/pouchdb/index.d.ts b/types/pouchdb/index.d.ts index 5822e631a8..e14e4c421f 100644 --- a/types/pouchdb/index.d.ts +++ b/types/pouchdb/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for pouchdb v5.4.4 +// Type definitions for pouchdb v6.1.2 // Project: https://pouchdb.com/ // Definitions by: Andy Brown , Brian Geppert , Frederico GalvĂ£o // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped From fe419265a500b074c33818c002b55e02ead131e3 Mon Sep 17 00:00:00 2001 From: SERIN Kevin Date: Fri, 7 Apr 2017 15:14:16 +0200 Subject: [PATCH 229/844] Phonon: add global variable to window --- types/phonon/index.d.ts | 1 + types/phonon/phonon-tests.ts | 1 + 2 files changed, 2 insertions(+) diff --git a/types/phonon/index.d.ts b/types/phonon/index.d.ts index ce07b5a19b..0a5079e3b8 100644 --- a/types/phonon/index.d.ts +++ b/types/phonon/index.d.ts @@ -190,6 +190,7 @@ interface Document { interface Window { on(event: string, callback: (event: Phonon.PhononCustomWindowEvent) => void, useCapture?: boolean): void; off(event: string, callback: (event: Phonon.PhononCustomWindowEvent) => void, useCapture?: boolean): void; + phonon: Phonon.Phonon; } interface Element { on(event: string, callback: (event: any) => void, useCapture?: boolean): void; diff --git a/types/phonon/phonon-tests.ts b/types/phonon/phonon-tests.ts index c31fcbbabb..b76e3282c0 100644 --- a/types/phonon/phonon-tests.ts +++ b/types/phonon/phonon-tests.ts @@ -550,3 +550,4 @@ phonon.options({ }); setupHTML(); phonon.navigator().start(); +window.phonon; From ed4dfea46ece311c63902d59c5573a8821fdac1f Mon Sep 17 00:00:00 2001 From: Simon Paulger Date: Fri, 7 Apr 2017 14:33:36 +0100 Subject: [PATCH 230/844] Fix pouchdb preset tests. --- types/pouchdb/pouchdb-tests.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/types/pouchdb/pouchdb-tests.ts b/types/pouchdb/pouchdb-tests.ts index 89f1c002db..3d580b9bff 100644 --- a/types/pouchdb/pouchdb-tests.ts +++ b/types/pouchdb/pouchdb-tests.ts @@ -92,12 +92,12 @@ namespace PouchDBTests { db.put(model).then((error) => { }); - db.put(model, null, null, null, (error) => { + db.put(model, null, (error) => { }); db.info().then((info) => { }); - db.info({ ajax: { cache: true }}, (error, result) => { + db.info((error, result) => { }); db.viewCleanup().catch((error) => { From 4f295732c51ea42cd2dcc6d545b746936518edf0 Mon Sep 17 00:00:00 2001 From: Simon Paulger Date: Fri, 7 Apr 2017 14:49:27 +0100 Subject: [PATCH 231/844] Remove duplicated author --- types/pouchdb-mapreduce/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/pouchdb-mapreduce/index.d.ts b/types/pouchdb-mapreduce/index.d.ts index 41b79da1ac..8c1fe7d905 100644 --- a/types/pouchdb-mapreduce/index.d.ts +++ b/types/pouchdb-mapreduce/index.d.ts @@ -1,6 +1,6 @@ // Type definitions for pouchdb-mapreduce v6.1.2 // Project: https://pouchdb.com/ -// Definitions by: Simon Paulger , Andy Brown , Brian Geppert , Frederico GalvĂ£o , Simon Paulger +// Definitions by: Simon Paulger , Andy Brown , Brian Geppert , Frederico GalvĂ£o // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped /// From 094e41b9cea377393d6e884a1366b4290ca4f7bf Mon Sep 17 00:00:00 2001 From: Ilko Hoffmann Date: Fri, 7 Apr 2017 17:05:10 +0200 Subject: [PATCH 232/844] added types for eureka-js-client --- .../eureka-js-client-tests.ts | 21 +++++ types/eureka-js-client/index.d.ts | 80 +++++++++++++++++++ types/eureka-js-client/tsconfig.json | 22 +++++ 3 files changed, 123 insertions(+) create mode 100644 types/eureka-js-client/eureka-js-client-tests.ts create mode 100644 types/eureka-js-client/index.d.ts create mode 100644 types/eureka-js-client/tsconfig.json diff --git a/types/eureka-js-client/eureka-js-client-tests.ts b/types/eureka-js-client/eureka-js-client-tests.ts new file mode 100644 index 0000000000..a28a4d7a48 --- /dev/null +++ b/types/eureka-js-client/eureka-js-client-tests.ts @@ -0,0 +1,21 @@ +import { Eureka } from 'eureka-js-client'; + +// example configuration +let client = new Eureka({ + // application instance information + instance: { + app: 'jqservice', + hostName: 'localhost', + ipAddr: '127.0.0.1', + port: 8080, + vipAddress: 'jq.test.something.com', + dataCenterInfo: { + name: 'MyOwn', + }, + }, + eureka: { + // eureka server host / port + host: '192.168.99.100', + port: 32768, + } +}); \ No newline at end of file diff --git a/types/eureka-js-client/index.d.ts b/types/eureka-js-client/index.d.ts new file mode 100644 index 0000000000..d8fb19ac1f --- /dev/null +++ b/types/eureka-js-client/index.d.ts @@ -0,0 +1,80 @@ +// Type definitions for eureka-js-client 4.3.0 +// Project: https://github.com/jquatier/eureka-js-client +// Definitions by: Ilko Hoffmann +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +export declare class Eureka { + constructor(config: EurekaClient.EurekaConfig) + start(): void; + stop(): void; + getInstancesByAppId(appId: string): Array; + getInstancesByVipAddress(vidAddress: string): Array; +} + +declare namespace EurekaClient { + + type InstanceStatus = 'UP' | 'DOWN' | 'STARTING' | 'OUT_OF_SERVICE' | 'UNKNOWN'; + type ActionType = 'ADDED' | 'MODIFIED' | 'DELETED'; + + interface EurekaConfig { + instance: EurekaInstanceConfig, + eureka: EurekaClientConfig + } + interface EurekaInstanceConfig { + app: string, + hostName: string, + ipAddr: string, + vipAddress: string, + dataCenterInfo: DataCenterInfo, + port?: number, + instanceId?: string, + appGroupName?: string, + sid?: string, + securePort?: PortWrapper, + homePageUrl?: string, + statusPageUrl?: string, + healthCheckUrl?: string, + secureHealthCheckUrl?: string, + secureVipAddress?: string, + countryId?: number, + status?: InstanceStatus, + overriddenstatus?: InstanceStatus, + leaseInfo?: LeaseInfo, + isCoordinatingDiscoveryServer?: boolean, + metadata?: Array<[string, string]>, + lastUpdatedTimestamp?: number, + lastDirtyTimestamp?: number, + actionType?: ActionType, + asgName?: string + } + interface EurekaClientConfig { + host: string, + port: number, + heartbeatInterval?: number, + registryFetchInterval?: number, + maxRetries?: number, + requestRetryDelay?: number, + fetchRegistry?: boolean, + filterUpInstances?: boolean, + servicePath?: string, + ssl?: boolean, + useDns?: boolean, + preferSameZone?: boolean, + clusterRefreshInterval?: boolean, + fetchMetadata?: boolean, + registerWithEureka?: boolean, + useLocalMetadata?: boolean, + preferIpAddress?: boolean + } + interface PortWrapper { + enabled: boolean, + port: number + } + interface LeaseInfo { + renewalIntervalInSecs: number; + durationInSecs: number; + } + interface DataCenterInfo { + name: 'Netflix' | 'Amazon' | 'MyOwn'; + } +} \ No newline at end of file diff --git a/types/eureka-js-client/tsconfig.json b/types/eureka-js-client/tsconfig.json new file mode 100644 index 0000000000..5cb950ba75 --- /dev/null +++ b/types/eureka-js-client/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": false, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "eureka-js-client-tests.ts" + ] +} \ No newline at end of file From 9501a2355b5290f56a4109031df0745ee78c9234 Mon Sep 17 00:00:00 2001 From: Niklas Walter Date: Sun, 29 Jan 2017 01:03:23 +0100 Subject: [PATCH 233/844] Update moment-duration-format to work correctly Signed-off-by: Niklas Walter --- moment-duration-format/package.json | 5 +++++ moment-duration-format/tslint.json | 1 + types/moment-duration-format/index.d.ts | 9 +++++---- 3 files changed, 11 insertions(+), 4 deletions(-) create mode 100644 moment-duration-format/package.json create mode 100644 moment-duration-format/tslint.json diff --git a/moment-duration-format/package.json b/moment-duration-format/package.json new file mode 100644 index 0000000000..4c6d24a445 --- /dev/null +++ b/moment-duration-format/package.json @@ -0,0 +1,5 @@ +{ + "dependencies": { + "moment": ">=2.14.0" + } +} \ No newline at end of file diff --git a/moment-duration-format/tslint.json b/moment-duration-format/tslint.json new file mode 100644 index 0000000000..2221e40e4a --- /dev/null +++ b/moment-duration-format/tslint.json @@ -0,0 +1 @@ +{ "extends": "../tslint.json" } \ No newline at end of file diff --git a/types/moment-duration-format/index.d.ts b/types/moment-duration-format/index.d.ts index eb81f2551a..5c8ca1965e 100644 --- a/types/moment-duration-format/index.d.ts +++ b/types/moment-duration-format/index.d.ts @@ -1,11 +1,12 @@ -// Type definitions for moment-duration-format v1.3.0 +// Type definitions for moment-duration-format 1.3 // Project: https://github.com/jsmreese/moment-duration-format -// Definitions by: Swint De Coninck +// Definitions by: Swint De Coninck , Niklas Walter // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +import * as moment from "moment"; -declare namespace moment { +declare module "moment" { interface Duration { format(template: string, precision?: string, settings?: any): string; } -} \ No newline at end of file +} From 3ee5cdec27c545c89313c8dc32d288ec2245e9ae Mon Sep 17 00:00:00 2001 From: Ilko Hoffmann Date: Fri, 7 Apr 2017 18:12:24 +0200 Subject: [PATCH 234/844] added tslint.json --- .../eureka-js-client-tests.ts | 8 +- types/eureka-js-client/index.d.ts | 101 +++++++++--------- types/eureka-js-client/tslint.json | 1 + 3 files changed, 53 insertions(+), 57 deletions(-) create mode 100644 types/eureka-js-client/tslint.json diff --git a/types/eureka-js-client/eureka-js-client-tests.ts b/types/eureka-js-client/eureka-js-client-tests.ts index a28a4d7a48..1eb2a510d5 100644 --- a/types/eureka-js-client/eureka-js-client-tests.ts +++ b/types/eureka-js-client/eureka-js-client-tests.ts @@ -1,8 +1,8 @@ import { Eureka } from 'eureka-js-client'; -// example configuration +// example configuration let client = new Eureka({ - // application instance information + // application instance information instance: { app: 'jqservice', hostName: 'localhost', @@ -14,8 +14,8 @@ let client = new Eureka({ }, }, eureka: { - // eureka server host / port + // eureka server host / port host: '192.168.99.100', port: 32768, } -}); \ No newline at end of file +}); diff --git a/types/eureka-js-client/index.d.ts b/types/eureka-js-client/index.d.ts index d8fb19ac1f..36fcbc2624 100644 --- a/types/eureka-js-client/index.d.ts +++ b/types/eureka-js-client/index.d.ts @@ -3,78 +3,73 @@ // Definitions by: Ilko Hoffmann // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -export declare class Eureka { +export class Eureka { constructor(config: EurekaClient.EurekaConfig) start(): void; stop(): void; - getInstancesByAppId(appId: string): Array; - getInstancesByVipAddress(vidAddress: string): Array; + getInstancesByAppId(appId: string): string[]; + getInstancesByVipAddress(vidAddress: string): string []; } -declare namespace EurekaClient { - +export namespace EurekaClient { type InstanceStatus = 'UP' | 'DOWN' | 'STARTING' | 'OUT_OF_SERVICE' | 'UNKNOWN'; type ActionType = 'ADDED' | 'MODIFIED' | 'DELETED'; + type DataCenterName = 'Netflix' | 'Amazon' | 'MyOwn'; interface EurekaConfig { - instance: EurekaInstanceConfig, - eureka: EurekaClientConfig + instance: EurekaInstanceConfig; + eureka: EurekaClientConfig; } interface EurekaInstanceConfig { - app: string, - hostName: string, - ipAddr: string, - vipAddress: string, - dataCenterInfo: DataCenterInfo, - port?: number, - instanceId?: string, - appGroupName?: string, - sid?: string, - securePort?: PortWrapper, - homePageUrl?: string, - statusPageUrl?: string, - healthCheckUrl?: string, - secureHealthCheckUrl?: string, - secureVipAddress?: string, - countryId?: number, - status?: InstanceStatus, - overriddenstatus?: InstanceStatus, - leaseInfo?: LeaseInfo, - isCoordinatingDiscoveryServer?: boolean, - metadata?: Array<[string, string]>, - lastUpdatedTimestamp?: number, - lastDirtyTimestamp?: number, - actionType?: ActionType, - asgName?: string + app: string; + hostName: string; + ipAddr: string; + vipAddress: string; + dataCenterInfo: DataCenterInfo; + port?: number; + instanceId?: string; + appGroupName?: string; + sid?: string; + securePort?: PortWrapper; + homePageUrl?: string; + statusPageUrl?: string; + healthCheckUrl?: string; + secureHealthCheckUrl?: string; + secureVipAddress?: string; + countryId?: number; + status?: InstanceStatus; + overriddenstatus?: InstanceStatus; + leaseInfo?: LeaseInfo; + isCoordinatingDiscoveryServer?: boolean; } interface EurekaClientConfig { - host: string, - port: number, - heartbeatInterval?: number, - registryFetchInterval?: number, - maxRetries?: number, - requestRetryDelay?: number, - fetchRegistry?: boolean, - filterUpInstances?: boolean, - servicePath?: string, - ssl?: boolean, - useDns?: boolean, - preferSameZone?: boolean, - clusterRefreshInterval?: boolean, - fetchMetadata?: boolean, - registerWithEureka?: boolean, - useLocalMetadata?: boolean, - preferIpAddress?: boolean + host: string; + port: number; + heartbeatInterval?: number; + registryFetchInterval?: number; + maxRetries?: number; + requestRetryDelay?: number; + fetchRegistry?: boolean; + filterUpInstances?: boolean; + servicePath?: string; + ssl?: boolean; + useDns?: boolean; + preferSameZone?: boolean; + clusterRefreshInterval?: boolean; + fetchMetadata?: boolean; + registerWithEureka?: boolean; + useLocalMetadata?: boolean; + preferIpAddress?: boolean; } interface PortWrapper { - enabled: boolean, - port: number + enabled: boolean; + port: number; } interface LeaseInfo { renewalIntervalInSecs: number; durationInSecs: number; } interface DataCenterInfo { - name: 'Netflix' | 'Amazon' | 'MyOwn'; + name: DataCenterName; } -} \ No newline at end of file +} diff --git a/types/eureka-js-client/tslint.json b/types/eureka-js-client/tslint.json new file mode 100644 index 0000000000..2221e40e4a --- /dev/null +++ b/types/eureka-js-client/tslint.json @@ -0,0 +1 @@ +{ "extends": "../tslint.json" } \ No newline at end of file From b1cbf63f91665b266f11ec4d440f25c96805835b Mon Sep 17 00:00:00 2001 From: Niklas Walter Date: Fri, 7 Apr 2017 18:20:08 +0200 Subject: [PATCH 235/844] Add type declaration for settings object to duration format method. --- types/moment-duration-format/index.d.ts | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/types/moment-duration-format/index.d.ts b/types/moment-duration-format/index.d.ts index 5c8ca1965e..a3ce7bb300 100644 --- a/types/moment-duration-format/index.d.ts +++ b/types/moment-duration-format/index.d.ts @@ -7,6 +7,13 @@ import * as moment from "moment"; declare module "moment" { interface Duration { - format(template: string, precision?: string, settings?: any): string; + format(template: string, precision?: string, settings?: DurationFormatSettings): string; + } + + interface DurationFormatSettings { + template: string; + precision: number; + trim: boolean; + forceLength: boolean; } } From 7972e1fb1c8ea323d49b5d026658ee3b1cdf07a0 Mon Sep 17 00:00:00 2001 From: Niklas Walter Date: Fri, 7 Apr 2017 18:25:48 +0200 Subject: [PATCH 236/844] move packages to new folder --- .../moment-duration-format}/package.json | 0 .../moment-duration-format}/tslint.json | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename {moment-duration-format => types/moment-duration-format}/package.json (100%) rename {moment-duration-format => types/moment-duration-format}/tslint.json (100%) diff --git a/moment-duration-format/package.json b/types/moment-duration-format/package.json similarity index 100% rename from moment-duration-format/package.json rename to types/moment-duration-format/package.json diff --git a/moment-duration-format/tslint.json b/types/moment-duration-format/tslint.json similarity index 100% rename from moment-duration-format/tslint.json rename to types/moment-duration-format/tslint.json From 5e1049bce15f9ca048f001d37935ca7946b0be03 Mon Sep 17 00:00:00 2001 From: Jason Killian Date: Fri, 7 Apr 2017 14:15:13 -0400 Subject: [PATCH 237/844] Fix typo in method name --- types/lodash/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/lodash/index.d.ts b/types/lodash/index.d.ts index f3dac0b006..d0df1f9529 100644 --- a/types/lodash/index.d.ts +++ b/types/lodash/index.d.ts @@ -5702,7 +5702,7 @@ declare namespace _ { /** * @see _.zipObjectDeep */ - zipObjectDepp( + zipObjectDeep( props: List|List>, values?: List ): _.Dictionary; From 487c1870e95383aaca07eb4f26533a3de043ccb5 Mon Sep 17 00:00:00 2001 From: Andy Hanson Date: Fri, 7 Apr 2017 15:11:09 -0700 Subject: [PATCH 238/844] highstock.d.ts: Fix indents --- types/highcharts/highstock.d.ts | 44 ++++++++++++++++----------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/types/highcharts/highstock.d.ts b/types/highcharts/highstock.d.ts index 64c3041d49..4541e5d715 100644 --- a/types/highcharts/highstock.d.ts +++ b/types/highcharts/highstock.d.ts @@ -30,10 +30,10 @@ declare namespace Highstock { } interface RangeSelectorButton { - type: string; // Defines the timespan, can be one of 'millisecond', 'second', 'minute', 'day', 'week', 'month', 'ytd' (year to date), 'year' and 'all'. - count?: number; - text: string; - dataGrouping?: any; // not sure how this works + type: string; // Defines the timespan, can be one of 'millisecond', 'second', 'minute', 'day', 'week', 'month', 'ytd' (year to date), 'year' and 'all'. + count?: number; + text: string; + dataGrouping?: any; // not sure how this works } interface RangeSelectorOptions { @@ -61,24 +61,24 @@ declare namespace Highstock { } interface ScrollbarOptions { - barBackgroundColor?: string; - barBorderColor?: string; - barBorderRadius?: number; - barBorderWidth?: number; - buttonArrowColor?: string; - buttonBackgroundColor?: string; - buttonBorderColor?: string; - buttonBorderRadius?: number; - buttonBorderWidth?: number; - enabled?: boolean; - height?: number; - liveRedraw?: boolean; - minWidth?: number; - rifleColor?: string; - trackBackgroundColor?: string; - trackBorderColor?: string; - trackBorderRadius?: number; - trackBorderWidth?: number; + barBackgroundColor?: string; + barBorderColor?: string; + barBorderRadius?: number; + barBorderWidth?: number; + buttonArrowColor?: string; + buttonBackgroundColor?: string; + buttonBorderColor?: string; + buttonBorderRadius?: number; + buttonBorderWidth?: number; + enabled?: boolean; + height?: number; + liveRedraw?: boolean; + minWidth?: number; + rifleColor?: string; + trackBackgroundColor?: string; + trackBorderColor?: string; + trackBorderRadius?: number; + trackBorderWidth?: number; } interface Options extends Highcharts.Options { From b5a573efa06322ed1542f679defca90db2590468 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fa=CC=81bio=20Batista?= Date: Fri, 7 Apr 2017 19:43:25 -0300 Subject: [PATCH 239/844] @types/mongoose: better docs --- types/mongoose/README.md | 16 +++------------- 1 file changed, 3 insertions(+), 13 deletions(-) diff --git a/types/mongoose/README.md b/types/mongoose/README.md index 8684f7f2b6..822e66d1f6 100644 --- a/types/mongoose/README.md +++ b/types/mongoose/README.md @@ -190,25 +190,15 @@ Full example for [Passport Local Mongoose](https://github.com/DefinitelyTyped/De #### FAQ and Common Mistakes **Q: When to use `mongoose.Schema.Types.ObjectId` and `mongoose.Types.ObjectId`**
    -When creating schemas in code use `mongoose.Schema.Types.ObjectId`: +When creating schemas in code use `mongoose.Schema.Types.ObjectId`. This is not a type, this is an instance +of `SchemaType` containing metadata for the ObjectId type: ```typescript var UserSchema = new mongoose.Schema({ id: mongoose.Schema.Types.ObjectId }); ``` -Mongoose uses `mongoose.Schema.Types.ObjectId` internally to create the schema. -However, if you define your interface like this: +When defining your interface, you should use the type definition `mongoose.Types.ObjectId`: ```typescript -interface IUser extends mongoose.Document { - id: mongoose.Schema.Types.ObjectId; -} -... -user.id = new mongoose.Types.ObjectId(); -``` -To use it, you will need to `/// ` in one of your source code files, - - -To assign the new promise library in your code, you will need to use one of the following options (since interface IUser extends mongoose.Document { id: mongoose.Types.ObjectId; // for type-checking, doesn't affect code behaviour } From 0903e768fee5ebd93106e34945ef13df7203f4f0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fa=CC=81bio=20Batista?= Date: Fri, 7 Apr 2017 19:51:54 -0300 Subject: [PATCH 240/844] @types/mongoose: added save options --- types/mongoose/index.d.ts | 17 ++++++++++++++++- types/mongoose/mongoose-tests.ts | 6 +++++- 2 files changed, 21 insertions(+), 2 deletions(-) diff --git a/types/mongoose/index.d.ts b/types/mongoose/index.d.ts index 70771c4398..a8c089c25a 100644 --- a/types/mongoose/index.d.ts +++ b/types/mongoose/index.d.ts @@ -2550,7 +2550,7 @@ declare module "mongoose" { * @param options.validateBeforeSave set to false to save without validating. * @param fn optional callback */ - save(fn?: (err: any, product: this, numAffected: number) => void): Promise; + save(options?: SaveOptions, fn?: (err: any, product: this, numAffected: number) => void): Promise; /** * Version using default version key. See http://mongoosejs.com/docs/guide.html#versionKey @@ -2559,6 +2559,21 @@ declare module "mongoose" { __v?: number; } + interface SaveOptions { + safe?: boolean | WriteConcern; + validateBeforeSave?: boolean; + } + + interface WriteConcern { + j?: boolean; + w?: number | 'majority' | TagSet; + wtimeout?: number; + } + + interface TagSet { + [k: string]: string; + } + interface ModelProperties { /** Base Mongoose instance the model uses. */ base: typeof mongoose; diff --git a/types/mongoose/mongoose-tests.ts b/types/mongoose/mongoose-tests.ts index dc170dccd9..0e8ade55ed 100644 --- a/types/mongoose/mongoose-tests.ts +++ b/types/mongoose/mongoose-tests.ts @@ -1050,7 +1050,7 @@ aggregate.unwind( includeArrayIndex: "idx", preserveNullAndEmptyArrays: true }); - + /* * section schematype.js * http://mongoosejs.com/docs/api.html#schematype-js @@ -1215,6 +1215,10 @@ MongoModel.find({}).$where('indexOf("val") !== -1').exec(function (err, docs) { MongoModel.findById(999, function (err, doc) { doc.increment(); doc.save(cb).then(cb).catch(cb); + doc.save({ validateBeforeSave: false }, cb).then(cb).catch(cb); + doc.save({ safe: true }, cb).then(cb).catch(cb); + doc.save({ safe: { w: 2, j: true } }, cb).then(cb).catch(cb); + doc.save({ safe: { w: 'majority', wtimeout: 10000 } }, cb).then(cb).catch(cb); }); MongoModel = (new MongoModel()).model('MongoModel'); var mongoModel = new MongoModel(); From 16be2fcb11a0571d30bbf68b6649ef14e007d0c0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fa=CC=81bio=20Batista?= Date: Fri, 7 Apr 2017 21:08:24 -0300 Subject: [PATCH 241/844] @types/{bson,mongodb,mongoose}: added Decimal128 type --- types/bson/index.d.ts | 12 ++++++++++-- types/mongodb/index.d.ts | 2 +- types/mongoose/index.d.ts | 16 ++++++++++++++++ types/mongoose/mongoose-tests.ts | 23 ++++++++++++++++++++++- 4 files changed, 49 insertions(+), 4 deletions(-) diff --git a/types/bson/index.d.ts b/types/bson/index.d.ts index b1f622ad47..67df319bf6 100644 --- a/types/bson/index.d.ts +++ b/types/bson/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for bson 1.0 +// Type definitions for bson 1.0.4 // Project: https://github.com/mongodb/js-bson // Definitions by: Hiroki Horiuchi // Federico Caselli @@ -107,6 +107,14 @@ export class Long { toString(radix?: number): string; xor(other: Long): Long; } +export class Decimal128 { + static fromString(s: string): Decimal128; + + constructor(bytes: Buffer); + + toJSON(): string; + toString(): string; +} export class MaxKey { constructor(); } @@ -135,7 +143,7 @@ export class ObjectID { static createFromTime(time: number): ObjectID; /** * Checks if a value is a valid bson ObjectID - * + * * @return {boolean} return true if the value is a valid bson ObjectID, return false otherwise. */ static isValid(id: string | number | ObjectID): boolean; diff --git a/types/mongodb/index.d.ts b/types/mongodb/index.d.ts index e1837c04ed..6f4f5624e1 100644 --- a/types/mongodb/index.d.ts +++ b/types/mongodb/index.d.ts @@ -12,7 +12,7 @@ import { ObjectID } from 'bson'; import { EventEmitter } from 'events'; import { Readable, Writable } from "stream"; -export { Binary, Double, Long, MaxKey, MinKey, ObjectID, Timestamp } from 'bson'; +export { Binary, Double, Long, Decimal128, MaxKey, MinKey, ObjectID, Timestamp } from 'bson'; // Class documentation : http://mongodb.github.io/node-mongodb-native/2.1/api/MongoClient.html export class MongoClient { diff --git a/types/mongoose/index.d.ts b/types/mongoose/index.d.ts index 70771c4398..2c58b764d3 100644 --- a/types/mongoose/index.d.ts +++ b/types/mongoose/index.d.ts @@ -1307,6 +1307,8 @@ declare module "mongoose" { // the ObjectIdConstructor, so we add the interface below interface ObjectId extends mongodb.ObjectID {} + class Decimal128 extends mongodb.Decimal128 {} + /* * section types/embedded.js * http://mongoosejs.com/docs/api.html#types-embedded-js @@ -2019,6 +2021,20 @@ declare module "mongoose" { /** This schema type's name, to defend against minifiers that mangle function names. */ static schemaName: string; } + /* + * section schema/decimal128.js + * http://mongoosejs.com/docs/api.html#schema-decimal128-js + */ + class Decimal128 extends SchemaType { + /** Decimal128 SchemaType constructor. */ + constructor(key: string, options?: Object); + + /** Check if the given value satisfies a required validator. */ + checkRequired(value: any, doc: MongooseDocument): boolean; + + /** This schema type's name, to defend against minifiers that mangle function names. */ + static schemaName: string; + } /* * section schema/mixed.js diff --git a/types/mongoose/mongoose-tests.ts b/types/mongoose/mongoose-tests.ts index dc170dccd9..4fb41ef3b2 100644 --- a/types/mongoose/mongoose-tests.ts +++ b/types/mongoose/mongoose-tests.ts @@ -61,7 +61,10 @@ mongoose.STATES.hasOwnProperty(''); mongoose.connection.on('error', cb); new mongoose.mongo.MongoError('error').stack; mongoose.SchemaTypes.String; +mongoose.SchemaTypes.ObjectId; +mongoose.SchemaTypes.Decimal128; mongoose.Types.ObjectId; +mongoose.Types.Decimal128; mongoose.version.toLowerCase(); /* @@ -228,6 +231,7 @@ var schema: mongoose.Schema = new mongoose.Schema({ age: { type: Number, min: 18, max: 65 }, mixed: mongoose.Schema.Types.Mixed, _someId: mongoose.Schema.Types.ObjectId, + someDecimal:mongoose.Schema.Types.Decimal128, array: [], ofString: [String], ofNumber: [Number], @@ -585,6 +589,23 @@ mongooseBuffer.compare(mongooseBuffer); /* inherited static properties */ mongoose.Types.Buffer.from([1, 2, 3]); +/* + * section types/decimal128.js + * http://mongoosejs.com/docs/api.html#types-decimal128-js + */ +var decimal128: mongoose.Types.Decimal128 = mongoose.Types.Decimal128.fromString('123.45678901234567'); +decimal128 = new mongoose.Types.Decimal128(new Buffer('12345')); +/* practical examples */ +export interface ILargeValuesSchema extends mongoose.MongooseDocument { + sum: mongoose.Schema.Types.Decimal128; +} +export var LargeValuesSchema = new mongoose.Schema({ + sum: { + type: mongoose.Schema.Types.Decimal128, + required: true + } +}); + /* * section types/objectid.js * http://mongoosejs.com/docs/api.html#types-objectid-js @@ -1050,7 +1071,7 @@ aggregate.unwind( includeArrayIndex: "idx", preserveNullAndEmptyArrays: true }); - + /* * section schematype.js * http://mongoosejs.com/docs/api.html#schematype-js From 55051ca1b76ceaf7a316f9fd902a90aec702d74f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fa=CC=81bio=20Batista?= Date: Fri, 7 Apr 2017 21:24:42 -0300 Subject: [PATCH 242/844] @types/mongoose: following @simonxca advice and separating overloads --- types/mongoose/index.d.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/types/mongoose/index.d.ts b/types/mongoose/index.d.ts index a8c089c25a..ee5c2a84e8 100644 --- a/types/mongoose/index.d.ts +++ b/types/mongoose/index.d.ts @@ -2550,7 +2550,8 @@ declare module "mongoose" { * @param options.validateBeforeSave set to false to save without validating. * @param fn optional callback */ - save(options?: SaveOptions, fn?: (err: any, product: this, numAffected: number) => void): Promise; + save(fn?: (err: any, product: this, numAffected: number) => void): Promise; + save(options: SaveOptions, fn?: (err: any, product: this, numAffected: number) => void): Promise; /** * Version using default version key. See http://mongoosejs.com/docs/guide.html#versionKey From c6ff176b82672ab9a967ae7edf41d6c7664dc46f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fa=CC=81bio=20Batista?= Date: Fri, 7 Apr 2017 21:29:22 -0300 Subject: [PATCH 243/844] @types/mongoose: following @simonxca advice and adding more tests --- types/mongoose/mongoose-tests.ts | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/types/mongoose/mongoose-tests.ts b/types/mongoose/mongoose-tests.ts index 0e8ade55ed..8530aa5717 100644 --- a/types/mongoose/mongoose-tests.ts +++ b/types/mongoose/mongoose-tests.ts @@ -1213,12 +1213,13 @@ MongoModel.find({}).$where('indexOf("val") !== -1').exec(function (err, docs) { docs[0].__v; }); MongoModel.findById(999, function (err, doc) { + var handleSave = function(err: Error, product: mongoose.Document, numAffected: number) {}; doc.increment(); - doc.save(cb).then(cb).catch(cb); - doc.save({ validateBeforeSave: false }, cb).then(cb).catch(cb); - doc.save({ safe: true }, cb).then(cb).catch(cb); - doc.save({ safe: { w: 2, j: true } }, cb).then(cb).catch(cb); - doc.save({ safe: { w: 'majority', wtimeout: 10000 } }, cb).then(cb).catch(cb); + doc.save(handleSave).then(cb).catch(cb); + doc.save({ validateBeforeSave: false }, handleSave).then(cb).catch(cb); + doc.save({ safe: true }, handleSave).then(cb).catch(cb); + doc.save({ safe: { w: 2, j: true } }, handleSave).then(cb).catch(cb); + doc.save({ safe: { w: 'majority', wtimeout: 10000 } }, handleSave).then(cb).catch(cb); }); MongoModel = (new MongoModel()).model('MongoModel'); var mongoModel = new MongoModel(); From f44a1808a56e683863beb17cd3e9058498d65035 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fa=CC=81bio=20Batista?= Date: Fri, 7 Apr 2017 22:57:08 -0300 Subject: [PATCH 244/844] @types/mongoose: testing type inference on callbacks --- types/mongoose/mongoose-tests.ts | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/types/mongoose/mongoose-tests.ts b/types/mongoose/mongoose-tests.ts index 8530aa5717..3ab409a2a6 100644 --- a/types/mongoose/mongoose-tests.ts +++ b/types/mongoose/mongoose-tests.ts @@ -1220,6 +1220,13 @@ MongoModel.findById(999, function (err, doc) { doc.save({ safe: true }, handleSave).then(cb).catch(cb); doc.save({ safe: { w: 2, j: true } }, handleSave).then(cb).catch(cb); doc.save({ safe: { w: 'majority', wtimeout: 10000 } }, handleSave).then(cb).catch(cb); + + // test if Typescript can infer the types of (err, product, numAffected) + doc.save(function(err, product, numAffected) { product.save(); }) + .then(function(p) { p.save() }).catch(cb); + doc.save({ validateBeforeSave: false }, function(err, product, numAffected) { + product.save(); + }).then(function(p) { p.save() }).catch(cb); }); MongoModel = (new MongoModel()).model('MongoModel'); var mongoModel = new MongoModel(); From 37c0eb40840d0a9605cdd33b9c29abe0b5bee603 Mon Sep 17 00:00:00 2001 From: Konstantin Vasilev Date: Sat, 8 Apr 2017 11:34:50 +0200 Subject: [PATCH 245/844] update types/archiver typings to v1.3.0 --- types/archiver/archiver-tests.ts | 26 ++++++++++++++++++------- types/archiver/index.d.ts | 33 +++++++++++++++++--------------- types/archiver/tslint.json | 6 ++++++ 3 files changed, 43 insertions(+), 22 deletions(-) create mode 100644 types/archiver/tslint.json diff --git a/types/archiver/archiver-tests.ts b/types/archiver/archiver-tests.ts index f186fb9bcb..57a569ab02 100644 --- a/types/archiver/archiver-tests.ts +++ b/types/archiver/archiver-tests.ts @@ -1,14 +1,16 @@ import Archiver = require('archiver'); import FS = require('fs'); -var archiver = Archiver.create('zip'); +const archiver = Archiver.create('zip'); -var writeStream = FS.createWriteStream('./archiver.d.ts'); -var readStream = FS.createReadStream('./archiver.d.ts'); +const writeStream = FS.createWriteStream('./archiver.d.ts'); +const readStream = FS.createReadStream('./archiver.d.ts'); -archiver.pipe(writeStream); -archiver.append(readStream, {name: 'archiver.d.ts'}); -archiver.finalize(); +archiver.abort(); +archiver.append(readStream, {name: 'archiver.d.ts'}) +.append(readStream, {name: 'archiver.d.ts'}); + +archiver.bulk({ mappaing: {} }); archiver.directory('./path', './someOtherPath'); archiver.directory('./path', { name: "testName"} ); @@ -16,4 +18,14 @@ archiver.directory('./path', { name: "testName"} ); archiver.directory('./', "", {}); archiver.directory('./', {name: 'test'}, {}); -archiver.bulk({ mappaing: {} }); \ No newline at end of file +archiver.file('./path', { name: 'test' }); +archiver.glob('./path', {}, {}); +archiver.finalize(); + +archiver.setFormat('zip'); +archiver.setModule(() => {}); + +archiver.pointer(); +archiver.use(() => {}); + +archiver.pipe(writeStream); diff --git a/types/archiver/index.d.ts b/types/archiver/index.d.ts index 665624143e..967a4fca52 100644 --- a/types/archiver/index.d.ts +++ b/types/archiver/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for archiver v0.15.0 +// Type definitions for archiver v1.3.0 // Project: https://github.com/archiverjs/node-archiver // Definitions by: Esri // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped @@ -18,30 +18,33 @@ import * as FS from 'fs'; import * as STREAM from 'stream'; - -declare function archiver(format: string, options?: archiver.Options): archiver.Archiver; +declare function archiver(format: string, options?: {}): archiver.Archiver; declare namespace archiver { + function create(format: string, options?: {}): Archiver; + function registerFormat(format: string, module: Function): void; - export function create(format: string, options?: Options): Archiver; - - - export interface nameInterface { + interface nameInterface { name?: string; } - export interface Archiver extends STREAM.Transform { - append(source: STREAM.Readable | Buffer | string, name: nameInterface): void; + interface Archiver extends STREAM.Transform { + abort(): this; + append(source: STREAM.Readable | Buffer | string, name: nameInterface): this; - directory(dirpath: string, destpath: nameInterface | string): void; - directory(dirpath: string, destpath: nameInterface | string, data: any | Function): void; + bulk(mappings: any): this; - bulk(mappings: any): void; - finalize(): void; - } + directory(dirpath: string, destpath: nameInterface | string, data?: any | Function): this; - export interface Options { + file(filepath: string, data: any): this; + glob(pattern: string, options: {}, data: any): this; + finalize(): this; + setFormat(format: string): this; + setModule(module: Function): this; + + pointer(): number; + use(plugin: Function): this; } } diff --git a/types/archiver/tslint.json b/types/archiver/tslint.json new file mode 100644 index 0000000000..b0e7084e94 --- /dev/null +++ b/types/archiver/tslint.json @@ -0,0 +1,6 @@ +{ + "extends": "../tslint.json", + "rules": { + "ban-types": false + } +} From f82fb85b43c5db79cd0151dbe03796ddb0203773 Mon Sep 17 00:00:00 2001 From: viskin Date: Sat, 8 Apr 2017 13:28:00 +0300 Subject: [PATCH 246/844] @types/natural: added POS Tagger --- types/natural/index.d.ts | 37 ++++++++++++++++++++++++++++++++++ types/natural/natural-tests.ts | 13 ++++++++++++ 2 files changed, 50 insertions(+) diff --git a/types/natural/index.d.ts b/types/natural/index.d.ts index 3615a50fce..255d8d4dca 100644 --- a/types/natural/index.d.ts +++ b/types/natural/index.d.ts @@ -202,3 +202,40 @@ declare class Spellcheck { isCorrect(word: string): boolean; getCorrections(word: string, maxDistance?: number): string[]; } + +declare class Predicate { + constructor(name: string, parameter1: string, parameter2?: string); + name: string; + parameter1: string; + parameter2?: string; + function?: (tagged_sentence: string[][], i: number, parameter: string) => boolean; + evaluate(tagged_sentence: string[][], position: number): boolean; +} + +declare class TransformationRule { + constructor(c1: string, c2: string, predicate: string, parameter1: string, parameter2?: string); + literal: string[]; + predicate: Predicate; + old_category: string; + new_category: string; + apply(tagged_sentence: string[][], position: number): void; +} + +declare class RuleSet { + constructor(filename: string); + rules: TransformationRule[]; +} + +declare class Lexicon { + constructor(filename: string, defaultCategory: string); + defaultCategory: string; + parseLexicon(data: string): void; + tagWord(word: string): string[]; +} + +declare class BrillPOSTagger { + constructor(lexicon: Lexicon, ruleSet: RuleSet); + lexicon: Lexicon; + ruleSet: RuleSet; + tag(sentence: string[]): string[][]; +} diff --git a/types/natural/natural-tests.ts b/types/natural/natural-tests.ts index c8650c6308..f994928f80 100644 --- a/types/natural/natural-tests.ts +++ b/types/natural/natural-tests.ts @@ -259,3 +259,16 @@ var spellcheck = new natural.Spellcheck(corpus); spellcheck.isCorrect('cat'); // false spellcheck.getCorrections('soemthing', 1); // ['something'] spellcheck.getCorrections('soemthing', 2); // ['something', 'soothing'] + +// POS Tagger + +var rulesFilename = 'fileName'; +var lexiconFilename = 'fileName'; +var defaultCategory = 'N'; + +var lexicon = new natural.Lexicon(lexiconFilename, defaultCategory); +var rules = new natural.RuleSet(rulesFilename); +var tagger = new natural.BrillPOSTagger(lexicon, rules); + +var sentence = ["I", "see", "the", "man", "with", "the", "telescope"]; +tagger.tag(sentence); From a33a4e618d5d7b03915c8b8c578ab907ab3ff321 Mon Sep 17 00:00:00 2001 From: viskin Date: Sat, 8 Apr 2017 13:39:50 +0300 Subject: [PATCH 247/844] @types/natural: increased version --- types/natural/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/natural/index.d.ts b/types/natural/index.d.ts index 255d8d4dca..3208072243 100644 --- a/types/natural/index.d.ts +++ b/types/natural/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for Natural 0.2.1 +// Type definitions for Natural 0.2.2 // Project: https://github.com/NaturalNode/natural // Definitions by: Dylan R. E. Moonfire // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped From bdafe8620261e681a806b43ec7261ae547804ebc Mon Sep 17 00:00:00 2001 From: bglee Date: Sat, 8 Apr 2017 22:32:08 +0900 Subject: [PATCH 248/844] update v2.1.2 --- types/react-ga/index.d.ts | 83 ++++++++++++++----- .../{react-ga-tests.tsx => react-ga-tests.ts} | 39 +++++++++ types/react-ga/tsconfig.json | 4 +- 3 files changed, 105 insertions(+), 21 deletions(-) rename types/react-ga/{react-ga-tests.tsx => react-ga-tests.ts} (57%) diff --git a/types/react-ga/index.d.ts b/types/react-ga/index.d.ts index 1d64b23971..3913840ad0 100644 --- a/types/react-ga/index.d.ts +++ b/types/react-ga/index.d.ts @@ -1,26 +1,71 @@ -// Type definitions for react-ga 1.4 +// Type definitions for react-ga v2.1.2 // Project: https://github.com/react-ga/react-ga // Definitions by: Tim Aldridge // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -export interface EventArgs { - category: string; - action: string; - label?: string; - value?: number; - nonInteraction?: boolean; +declare namespace __reactGA { + export interface EventArgs { + category: string; + action: string; + label?: string; + value?: number; + nonInteraction?: boolean; + } + + interface GaOptions { + name?: string; + clientId?: string; + sampleRate?: number; + siteSpeedSampleRate?: number; + alwaysSendReferrer?: boolean; + allowAnchor?: boolean; + cookieName?: string; + cookieDomain?: string; + cookieExpires?: number; + legacyCookieDomain?: string; + legacyHistoryImport?: boolean; + allowLinker?: boolean; + } + + export interface InitializeOptions { + debug?: boolean; + titleCase?: boolean; + gaOptions?: GaOptions; + } + + export interface FieldsObject { + [i: string]: any; + } + + interface TimingArgs { + category: string; + variable: string; + value: number; + label?: string; + } + + interface Plugin { + require(name: string, options: any): void; + execute(pluginName: string, action: string, actionTypeOrPayload: string|Object, payload?: Object): void; + } + + interface OutboundLinkArgs { + label: string; + } + + export function initialize(trackingCode: string, options?: InitializeOptions): void; + export function ga(): Function; + export function set(fieldsObject: FieldsObject): void; + export function send(fieldsObject: FieldsObject): void; + export function pageview(path: string): void; + export function modalview(name: string): void; + export function timing(args: TimingArgs): void; + export function event(args: EventArgs): void; + export function exception(fieldsObject: FieldsObject): void; + export const plugin: Plugin; + export function outboundLink(args: OutboundLinkArgs, hitCallback: Function): void; } -export interface InitializeOptions { - debug?: boolean; +declare module 'react-ga' { + export = __reactGA; } - -export interface FieldsObject { - [i: string]: any; -} - -export function initialize(trackingCode: string, options?: InitializeOptions): void; -export function pageview(path: string): void; -export function modalview(name: string): void; -export function event(args: EventArgs): void; -export function set(fieldsObject: FieldsObject): void; diff --git a/types/react-ga/react-ga-tests.tsx b/types/react-ga/react-ga-tests.ts similarity index 57% rename from types/react-ga/react-ga-tests.tsx rename to types/react-ga/react-ga-tests.ts index 0db1be21c2..aa9f454e9d 100644 --- a/types/react-ga/react-ga-tests.tsx +++ b/types/react-ga/react-ga-tests.ts @@ -59,3 +59,42 @@ describe("Testing react-ga set calls", () => { ga.set(fieldObject); }); }); + +describe("Testing react-ga v2.1.2", () => { + it("Able to make ga calls", () => { + const gaObject: Function = __reactGA.ga(); + }); + it("Able to make send calls", () => { + let fieldObject: __reactGA.FieldsObject = { + page: '/users' + }; + + __reactGA.send(fieldObject); + }); + it("Able to make timing calls", () => { + __reactGA.timing({ + category: 'string', + variable: 'string', + value: 1, + label: 'string' + }) + }); + it("Able to make exception calls", () => { + let fieldObject: __reactGA.FieldsObject = { + page: '/users' + }; + __reactGA.exception(fieldObject); + }); + it("Able to make plugin object calls", () => { + const execute = __reactGA.plugin.execute; + const require = __reactGA.plugin.require; + const payload = {}; + + execute('name', 'action', payload); + execute('name', 'action', 'type', payload); + require('name', {}); + }); + it("Able to make outboundLink calls", () => { + __reactGA.outboundLink({label: 'string'}, () => {}); + }); +}); diff --git a/types/react-ga/tsconfig.json b/types/react-ga/tsconfig.json index 6d786d97ed..69dc7f887b 100644 --- a/types/react-ga/tsconfig.json +++ b/types/react-ga/tsconfig.json @@ -18,6 +18,6 @@ }, "files": [ "index.d.ts", - "react-ga-tests.tsx" + "react-ga-tests.ts" ] -} \ No newline at end of file +} From d833d06ca03fbb4397e93afcd02fdeccd3169ef2 Mon Sep 17 00:00:00 2001 From: bglee Date: Sat, 8 Apr 2017 22:34:15 +0900 Subject: [PATCH 249/844] update v2.1.2 --- types/react-ga/index.d.ts | 122 ++++++++++++++++++-------------------- 1 file changed, 58 insertions(+), 64 deletions(-) diff --git a/types/react-ga/index.d.ts b/types/react-ga/index.d.ts index 3913840ad0..f0644c18d3 100644 --- a/types/react-ga/index.d.ts +++ b/types/react-ga/index.d.ts @@ -1,71 +1,65 @@ -// Type definitions for react-ga v2.1.2 +// Type definitions for react-ga 2.1.2 // Project: https://github.com/react-ga/react-ga // Definitions by: Tim Aldridge // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -declare namespace __reactGA { - export interface EventArgs { - category: string; - action: string; - label?: string; - value?: number; - nonInteraction?: boolean; - } - - interface GaOptions { - name?: string; - clientId?: string; - sampleRate?: number; - siteSpeedSampleRate?: number; - alwaysSendReferrer?: boolean; - allowAnchor?: boolean; - cookieName?: string; - cookieDomain?: string; - cookieExpires?: number; - legacyCookieDomain?: string; - legacyHistoryImport?: boolean; - allowLinker?: boolean; - } - - export interface InitializeOptions { - debug?: boolean; - titleCase?: boolean; - gaOptions?: GaOptions; - } - - export interface FieldsObject { - [i: string]: any; - } - - interface TimingArgs { - category: string; - variable: string; - value: number; - label?: string; - } - - interface Plugin { - require(name: string, options: any): void; - execute(pluginName: string, action: string, actionTypeOrPayload: string|Object, payload?: Object): void; - } - - interface OutboundLinkArgs { - label: string; - } - - export function initialize(trackingCode: string, options?: InitializeOptions): void; - export function ga(): Function; - export function set(fieldsObject: FieldsObject): void; - export function send(fieldsObject: FieldsObject): void; - export function pageview(path: string): void; - export function modalview(name: string): void; - export function timing(args: TimingArgs): void; - export function event(args: EventArgs): void; - export function exception(fieldsObject: FieldsObject): void; - export const plugin: Plugin; - export function outboundLink(args: OutboundLinkArgs, hitCallback: Function): void; +export interface EventArgs { + category: string; + action: string; + label?: string; + value?: number; + nonInteraction?: boolean; } -declare module 'react-ga' { - export = __reactGA; +interface GaOptions { + name?: string; + clientId?: string; + sampleRate?: number; + siteSpeedSampleRate?: number; + alwaysSendReferrer?: boolean; + allowAnchor?: boolean; + cookieName?: string; + cookieDomain?: string; + cookieExpires?: number; + legacyCookieDomain?: string; + legacyHistoryImport?: boolean; + allowLinker?: boolean; } + +export interface InitializeOptions { + debug?: boolean; + titleCase?: boolean; + gaOptions?: GaOptions; +} + +export interface FieldsObject { + [i: string]: any; +} + +interface TimingArgs { + category: string; + variable: string; + value: number; + label?: string; +} + +interface Plugin { + require(name: string, options: any): void; + execute(pluginName: string, action: string, actionTypeOrPayload: string|Object, payload?: Object): void; +} + +interface OutboundLinkArgs { + label: string; +} + +export function initialize(trackingCode: string, options?: InitializeOptions): void; +export function ga(): Function; +export function set(fieldsObject: FieldsObject): void; +export function send(fieldsObject: FieldsObject): void; +export function pageview(path: string): void; +export function modalview(name: string): void; +export function timing(args: TimingArgs): void; +export function event(args: EventArgs): void; +export function exception(fieldsObject: FieldsObject): void; +export const plugin: Plugin; +export function outboundLink(args: OutboundLinkArgs, hitCallback: Function): void; From ba7f0539754b144083d949b9002efadbf9162cec Mon Sep 17 00:00:00 2001 From: bglee Date: Sat, 8 Apr 2017 22:35:55 +0900 Subject: [PATCH 250/844] update v2.1.2 --- types/react-ga/react-ga-tests.ts | 19 +++++++++---------- types/react-ga/tsconfig.json | 3 +-- 2 files changed, 10 insertions(+), 12 deletions(-) diff --git a/types/react-ga/react-ga-tests.ts b/types/react-ga/react-ga-tests.ts index aa9f454e9d..4396cf9644 100644 --- a/types/react-ga/react-ga-tests.ts +++ b/types/react-ga/react-ga-tests.ts @@ -19,7 +19,6 @@ describe("Testing react-ga initialize object", () => { describe("Testing react-ga pageview calls", () => { it("Able to make pageview calls", () => { ga.initialize("UA-65432-1"); - ga.pageview("http://telshin.com"); }); }); @@ -62,17 +61,17 @@ describe("Testing react-ga set calls", () => { describe("Testing react-ga v2.1.2", () => { it("Able to make ga calls", () => { - const gaObject: Function = __reactGA.ga(); + const gaObject: Function = ga.ga(); }); it("Able to make send calls", () => { - let fieldObject: __reactGA.FieldsObject = { + let fieldObject: ga.FieldsObject = { page: '/users' }; - __reactGA.send(fieldObject); + ga.send(fieldObject); }); it("Able to make timing calls", () => { - __reactGA.timing({ + ga.timing({ category: 'string', variable: 'string', value: 1, @@ -80,14 +79,14 @@ describe("Testing react-ga v2.1.2", () => { }) }); it("Able to make exception calls", () => { - let fieldObject: __reactGA.FieldsObject = { + let fieldObject: ga.FieldsObject = { page: '/users' }; - __reactGA.exception(fieldObject); + ga.exception(fieldObject); }); it("Able to make plugin object calls", () => { - const execute = __reactGA.plugin.execute; - const require = __reactGA.plugin.require; + const execute = ga.plugin.execute; + const require = ga.plugin.require; const payload = {}; execute('name', 'action', payload); @@ -95,6 +94,6 @@ describe("Testing react-ga v2.1.2", () => { require('name', {}); }); it("Able to make outboundLink calls", () => { - __reactGA.outboundLink({label: 'string'}, () => {}); + ga.outboundLink({label: 'string'}, () => {}); }); }); diff --git a/types/react-ga/tsconfig.json b/types/react-ga/tsconfig.json index 69dc7f887b..0e8c21872c 100644 --- a/types/react-ga/tsconfig.json +++ b/types/react-ga/tsconfig.json @@ -13,8 +13,7 @@ ], "types": [], "noEmit": true, - "forceConsistentCasingInFileNames": true, - "jsx": "react" + "forceConsistentCasingInFileNames": true }, "files": [ "index.d.ts", From 428ec7e4f6928efc5b441cd52b06536c42d7f165 Mon Sep 17 00:00:00 2001 From: bglee Date: Sat, 8 Apr 2017 22:43:56 +0900 Subject: [PATCH 251/844] add userId to GaOptions --- types/react-ga/index.d.ts | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/types/react-ga/index.d.ts b/types/react-ga/index.d.ts index f0644c18d3..d951cb2909 100644 --- a/types/react-ga/index.d.ts +++ b/types/react-ga/index.d.ts @@ -11,7 +11,7 @@ export interface EventArgs { nonInteraction?: boolean; } -interface GaOptions { +export interface GaOptions { name?: string; clientId?: string; sampleRate?: number; @@ -24,6 +24,7 @@ interface GaOptions { legacyCookieDomain?: string; legacyHistoryImport?: boolean; allowLinker?: boolean; + userId?: string; } export interface InitializeOptions { @@ -36,19 +37,19 @@ export interface FieldsObject { [i: string]: any; } -interface TimingArgs { +export interface TimingArgs { category: string; variable: string; value: number; label?: string; } -interface Plugin { +export interface Plugin { require(name: string, options: any): void; execute(pluginName: string, action: string, actionTypeOrPayload: string|Object, payload?: Object): void; } -interface OutboundLinkArgs { +export interface OutboundLinkArgs { label: string; } From e71a66fb2880af17d6d476b2ef38cffdafac93c2 Mon Sep 17 00:00:00 2001 From: alexandrepetrillo Date: Sat, 8 Apr 2017 17:42:53 +0200 Subject: [PATCH 252/844] fix Streamjs GroupingResult GroupingResult return an array of element Exemple : Stream.of({'firstname': 'john', 'lastname':'doe'}).groupBy(obj => obj.lastname)['doe'] => is an Array --- types/streamjs/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/streamjs/index.d.ts b/types/streamjs/index.d.ts index fbd47f00f5..bbff6b4f95 100644 --- a/types/streamjs/index.d.ts +++ b/types/streamjs/index.d.ts @@ -126,7 +126,7 @@ declare namespace Stream { } export interface GroupingResult { - [index: string]: T + [index: string]: T[] } export interface Iterator { From b26aa29acd5e3bbfd64f67319874d8311f6d80b1 Mon Sep 17 00:00:00 2001 From: alexandrepetrillo Date: Sat, 8 Apr 2017 17:54:57 +0200 Subject: [PATCH 253/844] Update streamjs-tests.ts --- types/streamjs/streamjs-tests.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/streamjs/streamjs-tests.ts b/types/streamjs/streamjs-tests.ts index c42e4d6be7..c5a6b2b5b1 100644 --- a/types/streamjs/streamjs-tests.ts +++ b/types/streamjs/streamjs-tests.ts @@ -97,7 +97,7 @@ numStream.collect({ }); var groupingResult = myStream.groupBy(lst => lst.name); -var elems = groupingResult["hello"].elems; +var length = groupingResult["hello"].length; groupingResult = myStream.groupingBy(lst => lst.name); groupingResult = myStream.groupBy("name"); groupingResult = myStream.groupingBy("name"); From 9c61fe422bab23547313b3d4d4a87758dd7f917c Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Sat, 8 Apr 2017 21:59:31 +0300 Subject: [PATCH 254/844] Create index.d.ts --- types/prop-types/index.d.ts | 1 + 1 file changed, 1 insertion(+) create mode 100644 types/prop-types/index.d.ts diff --git a/types/prop-types/index.d.ts b/types/prop-types/index.d.ts new file mode 100644 index 0000000000..8b13789179 --- /dev/null +++ b/types/prop-types/index.d.ts @@ -0,0 +1 @@ + From 84a52d292afcfd0d8f735254e3c36d463d7c16b0 Mon Sep 17 00:00:00 2001 From: Francis Saul Date: Thu, 6 Apr 2017 17:51:32 +0100 Subject: [PATCH 255/844] Added sinon-test --- types/sinon-test/index.d.ts | 25 +++++++++++++++++++++++++ types/sinon-test/sinon-test-tests.ts | 25 +++++++++++++++++++++++++ types/sinon-test/tsconfig.json | 22 ++++++++++++++++++++++ types/sinon-test/tslint.json | 1 + 4 files changed, 73 insertions(+) create mode 100644 types/sinon-test/index.d.ts create mode 100644 types/sinon-test/sinon-test-tests.ts create mode 100644 types/sinon-test/tsconfig.json create mode 100644 types/sinon-test/tslint.json diff --git a/types/sinon-test/index.d.ts b/types/sinon-test/index.d.ts new file mode 100644 index 0000000000..01fe7cd484 --- /dev/null +++ b/types/sinon-test/index.d.ts @@ -0,0 +1,25 @@ +// Type definitions for sinon-test v1.0.1 +// Project: https://github.com/sinonjs/sinon-test +// Definitions by: Francis Saul +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +/// + +import * as Sinon from 'sinon'; + +interface Configuration { + injectIntoThis?: boolean; + injectInto?: any; + properties?: Array<"spy"| "stub"| "mock"| "clock"| "server"| "requests">; + useFakeTimers?: boolean; + useFakeServer?: boolean; +} + +interface sinonTest { + configureTest(sinon: Sinon.SinonStatic, config?: Configuration): any; + configureTestCase(sinon: Sinon.SinonStatic, config?: Configuration): any; +} + +declare var sinonTest: sinonTest; + +export = sinonTest; diff --git a/types/sinon-test/sinon-test-tests.ts b/types/sinon-test/sinon-test-tests.ts new file mode 100644 index 0000000000..83f7e5c65c --- /dev/null +++ b/types/sinon-test/sinon-test-tests.ts @@ -0,0 +1,25 @@ +import * as sinon from 'sinon'; +import * as sinonTest from 'sinon-test'; + +function testConfigure() { + const test = sinonTest.configureTest(sinon, { + injectIntoThis: true, + injectInto: true, + properties: ["spy", "stub", "mock", "clock", "server", "requests"], + useFakeTimers: true, + useFakeServer: true + }); +} + +function testConfigureTestCase() { + const test = sinonTest.configureTestCase(sinon, { + injectIntoThis: true, + injectInto: true, + properties: ["spy", "stub", "mock", "clock", "server", "requests"], + useFakeTimers: true, + useFakeServer: true + }); +} + +testConfigure(); +testConfigureTestCase(); diff --git a/types/sinon-test/tsconfig.json b/types/sinon-test/tsconfig.json new file mode 100644 index 0000000000..3f98705174 --- /dev/null +++ b/types/sinon-test/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", + "sinon-test-tests.ts" + ] +} diff --git a/types/sinon-test/tslint.json b/types/sinon-test/tslint.json new file mode 100644 index 0000000000..377cc837d4 --- /dev/null +++ b/types/sinon-test/tslint.json @@ -0,0 +1 @@ +{ "extends": "../tslint.json" } From 1bf4ea2d7fecd4648cc4cc21b3e48e31dabd806a Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Sat, 8 Apr 2017 22:21:31 +0300 Subject: [PATCH 256/844] Update index.d.ts --- types/prop-types/index.d.ts | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/types/prop-types/index.d.ts b/types/prop-types/index.d.ts index 8b13789179..8cf962087e 100644 --- a/types/prop-types/index.d.ts +++ b/types/prop-types/index.d.ts @@ -1 +1,35 @@ +// Type definitions for prop-types v15.5.4 +// Project: https://github.com/reactjs/prop-types +// Definitions by: DovydasNavickas +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.2 +interface Validator { + (object: T, key: string, componentName: string, ...rest: any[]): Error | null; +} + +interface Requireable extends Validator { + isRequired: Validator; +} + +type ValidationMap = {[K in keyof T]?: Validator }; + +declare namespace ReactPropTypes { + export var any: Requireable; + export var array: Requireable; + export var bool: Requireable; + export var func: Requireable; + export var number: Requireable; + export var object: Requireable; + export var string: Requireable; + export var node: Requireable; + export var element: Requireable; + export function instanceOf(expectedClass: {}): Requireable; + export function oneOf(types: any[]): Requireable; + export function oneOfType(types: Validator[]): Requireable; + export function arrayOf(type: Validator): Requireable; + export function objectOf(type: Validator): Requireable; + export function shape(type: ValidationMap): Requireable; +} + +export = ReactPropTypes; From 64d35f13b748416a30fe08aa8a83d835975c8399 Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Sat, 8 Apr 2017 22:29:50 +0300 Subject: [PATCH 257/844] Create tslint.json --- types/prop-types/tslint.json | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 types/prop-types/tslint.json diff --git a/types/prop-types/tslint.json b/types/prop-types/tslint.json new file mode 100644 index 0000000000..f9e30021f4 --- /dev/null +++ b/types/prop-types/tslint.json @@ -0,0 +1,3 @@ +{ + "extends": "../tslint.json" +} From 264faf9a621a943b27272f04ec074b081fe993cc Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Sat, 8 Apr 2017 22:32:56 +0300 Subject: [PATCH 258/844] Create tsconfig.json --- types/prop-types/tsconfig.json | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 types/prop-types/tsconfig.json diff --git a/types/prop-types/tsconfig.json b/types/prop-types/tsconfig.json new file mode 100644 index 0000000000..fca75ffbe7 --- /dev/null +++ b/types/prop-types/tsconfig.json @@ -0,0 +1,18 @@ +{ + "files": [ + "index.d.ts" + ], + "compilerOptions": { + "module": "commonjs", + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + } +} From 11dbb88e36d89345063ebe4327ac366b6c1aa4d7 Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Sat, 8 Apr 2017 22:34:09 +0300 Subject: [PATCH 259/844] Create types-tests.ts --- types/prop-types/types-tests.ts | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 types/prop-types/types-tests.ts diff --git a/types/prop-types/types-tests.ts b/types/prop-types/types-tests.ts new file mode 100644 index 0000000000..209abd4b48 --- /dev/null +++ b/types/prop-types/types-tests.ts @@ -0,0 +1,2 @@ +import * as PropTypes from "prop-types"; + From 9aa18d0acddb2947922075706259d52093f66212 Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Sat, 8 Apr 2017 22:46:20 +0300 Subject: [PATCH 260/844] Update types-tests.ts --- types/prop-types/types-tests.ts | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/types/prop-types/types-tests.ts b/types/prop-types/types-tests.ts index 209abd4b48..43f2fb4424 100644 --- a/types/prop-types/types-tests.ts +++ b/types/prop-types/types-tests.ts @@ -1,2 +1,14 @@ import * as PropTypes from "prop-types"; +let testObj: any = { + anyIsRequired: PropTypes.any.isRequired, + arrayIsRequired: PropTypes.array.isRequired, + boolIsRequired: PropTypes.bool.isRequired, + funcIsRequired: PropTypes.func.isRequired, + numberIsRequired: PropTypes.number.isRequired, + objectIsRequired: PropTypes.object.isRequired, + stringIsRequired: PropTypes.string.isRequired, + nodeIsRequired: PropTypes.node.isRequired, + elementIsRequired: PropTypes.element.isRequired +}; +console.log(testObj); From 5a3da1dcd4c60e456987892d54a1f8f4be3545f7 Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Sat, 8 Apr 2017 22:49:59 +0300 Subject: [PATCH 261/844] Update tsconfig.json --- types/prop-types/tsconfig.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/types/prop-types/tsconfig.json b/types/prop-types/tsconfig.json index fca75ffbe7..b121f84a5e 100644 --- a/types/prop-types/tsconfig.json +++ b/types/prop-types/tsconfig.json @@ -1,6 +1,7 @@ { "files": [ - "index.d.ts" + "index.d.ts", + "types-tests.ts" ], "compilerOptions": { "module": "commonjs", From eca5774205099b8fe41b3a10170a19c3fd65177c Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Sat, 8 Apr 2017 22:55:29 +0300 Subject: [PATCH 262/844] Rename types-tests.ts to prop-types-tests.ts --- types/prop-types/{types-tests.ts => prop-types-tests.ts} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename types/prop-types/{types-tests.ts => prop-types-tests.ts} (100%) diff --git a/types/prop-types/types-tests.ts b/types/prop-types/prop-types-tests.ts similarity index 100% rename from types/prop-types/types-tests.ts rename to types/prop-types/prop-types-tests.ts From 9e35640e2db8df8a45935e4d6ec5390b1514569f Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Sat, 8 Apr 2017 22:56:07 +0300 Subject: [PATCH 263/844] Update README.md --- types/react/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/react/README.md b/types/react/README.md index c09dc060c2..a868f10f72 100644 --- a/types/react/README.md +++ b/types/react/README.md @@ -1,6 +1,6 @@ ## Known Problems & Workarounds -### **The type of `setState` is will be overly strict prior to TS 2.1.5** +### **The type of `setState` is overly strict prior to TS 2.1.5** Starting with TypeScript 2.1, its more correct than it used to be, with a caveat: optional parameters on state interfaces are no longer valid. This issue is corrected in 2.1.5 (and beyond) and thus `Pick` becomes ideal. ```ts From 6d880c06045110ec78a49bbce44e941cec0f553d Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Sat, 8 Apr 2017 22:59:11 +0300 Subject: [PATCH 264/844] Update index.d.ts --- types/prop-types/index.d.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/types/prop-types/index.d.ts b/types/prop-types/index.d.ts index 8cf962087e..f39e8cf1d9 100644 --- a/types/prop-types/index.d.ts +++ b/types/prop-types/index.d.ts @@ -33,3 +33,4 @@ declare namespace ReactPropTypes { } export = ReactPropTypes; + From 28467b7794751477ab13b8e55d00531cb62d32cc Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Sat, 8 Apr 2017 23:01:42 +0300 Subject: [PATCH 265/844] Update index.d.ts --- types/prop-types/index.d.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/types/prop-types/index.d.ts b/types/prop-types/index.d.ts index f39e8cf1d9..8cf962087e 100644 --- a/types/prop-types/index.d.ts +++ b/types/prop-types/index.d.ts @@ -33,4 +33,3 @@ declare namespace ReactPropTypes { } export = ReactPropTypes; - From 32deb5981e42ea8e369c7d7644cc2728d4f03361 Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Sat, 8 Apr 2017 23:01:54 +0300 Subject: [PATCH 266/844] Update tsconfig.json --- types/prop-types/tsconfig.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/prop-types/tsconfig.json b/types/prop-types/tsconfig.json index b121f84a5e..744824bc52 100644 --- a/types/prop-types/tsconfig.json +++ b/types/prop-types/tsconfig.json @@ -1,7 +1,7 @@ { "files": [ "index.d.ts", - "types-tests.ts" + "prop-types-tests.ts" ], "compilerOptions": { "module": "commonjs", From 6ee4dd94c1c98692ba24232c2011a4cf9a781221 Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Sat, 8 Apr 2017 23:04:55 +0300 Subject: [PATCH 267/844] Update tsconfig.json --- types/prop-types/tsconfig.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/types/prop-types/tsconfig.json b/types/prop-types/tsconfig.json index 744824bc52..32e0c3a3f5 100644 --- a/types/prop-types/tsconfig.json +++ b/types/prop-types/tsconfig.json @@ -14,6 +14,7 @@ ], "types": [], "noEmit": true, - "forceConsistentCasingInFileNames": true + "forceConsistentCasingInFileNames": true, + "lib" : [ "es6" ] } } From bab725827830426713c8ac7ac8360f9bc1226c0a Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Sat, 8 Apr 2017 23:07:45 +0300 Subject: [PATCH 268/844] Update prop-types-tests.ts --- types/prop-types/prop-types-tests.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/types/prop-types/prop-types-tests.ts b/types/prop-types/prop-types-tests.ts index 43f2fb4424..68ad75d500 100644 --- a/types/prop-types/prop-types-tests.ts +++ b/types/prop-types/prop-types-tests.ts @@ -11,4 +11,3 @@ let testObj: any = { nodeIsRequired: PropTypes.node.isRequired, elementIsRequired: PropTypes.element.isRequired }; -console.log(testObj); From 29383aa5288d37bfb8a0b202d9c6bffe6fd3aae1 Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Sat, 8 Apr 2017 23:13:34 +0300 Subject: [PATCH 269/844] Update index.d.ts --- types/prop-types/index.d.ts | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/types/prop-types/index.d.ts b/types/prop-types/index.d.ts index 8cf962087e..c902070663 100644 --- a/types/prop-types/index.d.ts +++ b/types/prop-types/index.d.ts @@ -15,21 +15,21 @@ interface Requireable extends Validator { type ValidationMap = {[K in keyof T]?: Validator }; declare namespace ReactPropTypes { - export var any: Requireable; - export var array: Requireable; - export var bool: Requireable; - export var func: Requireable; - export var number: Requireable; - export var object: Requireable; - export var string: Requireable; - export var node: Requireable; - export var element: Requireable; - export function instanceOf(expectedClass: {}): Requireable; - export function oneOf(types: any[]): Requireable; - export function oneOfType(types: Validator[]): Requireable; - export function arrayOf(type: Validator): Requireable; - export function objectOf(type: Validator): Requireable; - export function shape(type: ValidationMap): Requireable; + let any: Requireable; + let array: Requireable; + let bool: Requireable; + let func: Requireable; + let number: Requireable; + let object: Requireable; + let string: Requireable; + let node: Requireable; + let element: Requireable; + function instanceOf(expectedClass: {}): Requireable; + function oneOf(types: any[]): Requireable; + function oneOfType(types: Array>): Requireable; + function arrayOf(type: Validator): Requireable; + function objectOf(type: Validator): Requireable; + function shape(type: ValidationMap): Requireable; } export = ReactPropTypes; From 1083a3a50abf71a53cd355bdf8f1a9228397b082 Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Sat, 8 Apr 2017 23:21:54 +0300 Subject: [PATCH 270/844] Update index.d.ts --- types/prop-types/index.d.ts | 38 ++++++++++++++++--------------------- 1 file changed, 16 insertions(+), 22 deletions(-) diff --git a/types/prop-types/index.d.ts b/types/prop-types/index.d.ts index c902070663..b05b6c3c9a 100644 --- a/types/prop-types/index.d.ts +++ b/types/prop-types/index.d.ts @@ -4,9 +4,7 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.2 -interface Validator { - (object: T, key: string, componentName: string, ...rest: any[]): Error | null; -} +type Validator = (object: T, key: string, componentName: string, ...rest: any[]) => Error | null interface Requireable extends Validator { isRequired: Validator; @@ -14,22 +12,18 @@ interface Requireable extends Validator { type ValidationMap = {[K in keyof T]?: Validator }; -declare namespace ReactPropTypes { - let any: Requireable; - let array: Requireable; - let bool: Requireable; - let func: Requireable; - let number: Requireable; - let object: Requireable; - let string: Requireable; - let node: Requireable; - let element: Requireable; - function instanceOf(expectedClass: {}): Requireable; - function oneOf(types: any[]): Requireable; - function oneOfType(types: Array>): Requireable; - function arrayOf(type: Validator): Requireable; - function objectOf(type: Validator): Requireable; - function shape(type: ValidationMap): Requireable; -} - -export = ReactPropTypes; +declare var any: Requireable; +declare var array: Requireable; +declare var bool: Requireable; +declare var func: Requireable; +declare var number: Requireable; +declare var object: Requireable; +declare var string: Requireable; +declare var node: Requireable; +declare var element: Requireable; +declare function instanceOf(expectedClass: {}): Requireable; +declare function oneOf(types: any[]): Requireable; +declare function oneOfType(types: Array>): Requireable; +declare function arrayOf(type: Validator): Requireable; +declare function objectOf(type: Validator): Requireable; +declare function shape(type: ValidationMap): Requireable; From 7d99ff2df9d135ffb80a62c31031a4076e3677cd Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Sat, 8 Apr 2017 23:25:40 +0300 Subject: [PATCH 271/844] Update index.d.ts --- types/prop-types/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/prop-types/index.d.ts b/types/prop-types/index.d.ts index b05b6c3c9a..4ff5f9faaa 100644 --- a/types/prop-types/index.d.ts +++ b/types/prop-types/index.d.ts @@ -4,7 +4,7 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.2 -type Validator = (object: T, key: string, componentName: string, ...rest: any[]) => Error | null +type Validator = (object: T, key: string, componentName: string, ...rest: any[]) => Error | null; interface Requireable extends Validator { isRequired: Validator; From e80bea1b4cbeca6364ece294a8d6dfb30e0c49ce Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Sat, 8 Apr 2017 23:27:05 +0300 Subject: [PATCH 272/844] Update index.d.ts --- types/prop-types/index.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/types/prop-types/index.d.ts b/types/prop-types/index.d.ts index 4ff5f9faaa..27d44a159e 100644 --- a/types/prop-types/index.d.ts +++ b/types/prop-types/index.d.ts @@ -4,9 +4,9 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.2 -type Validator = (object: T, key: string, componentName: string, ...rest: any[]) => Error | null; +declare type Validator = (object: T, key: string, componentName: string, ...rest: any[]) => Error | null; -interface Requireable extends Validator { +declare interface Requireable extends Validator { isRequired: Validator; } From aac771f6797ea1f380de8fd8dbe002eec3556536 Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Sat, 8 Apr 2017 23:31:59 +0300 Subject: [PATCH 273/844] Update index.d.ts --- types/prop-types/index.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/types/prop-types/index.d.ts b/types/prop-types/index.d.ts index 27d44a159e..4ff5f9faaa 100644 --- a/types/prop-types/index.d.ts +++ b/types/prop-types/index.d.ts @@ -4,9 +4,9 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.2 -declare type Validator = (object: T, key: string, componentName: string, ...rest: any[]) => Error | null; +type Validator = (object: T, key: string, componentName: string, ...rest: any[]) => Error | null; -declare interface Requireable extends Validator { +interface Requireable extends Validator { isRequired: Validator; } From e891e939f42255b2f58fc76f9fbb38e0bcb6fc88 Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Sun, 9 Apr 2017 01:36:27 +0300 Subject: [PATCH 274/844] Update index.d.ts --- types/prop-types/index.d.ts | 47 ++++++++++++++++++++----------------- 1 file changed, 25 insertions(+), 22 deletions(-) diff --git a/types/prop-types/index.d.ts b/types/prop-types/index.d.ts index 4ff5f9faaa..86dc2d8b54 100644 --- a/types/prop-types/index.d.ts +++ b/types/prop-types/index.d.ts @@ -4,26 +4,29 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.2 -type Validator = (object: T, key: string, componentName: string, ...rest: any[]) => Error | null; - -interface Requireable extends Validator { - isRequired: Validator; +declare module 'prop-types' { + + type Validator = (object: T, key: string, componentName: string, ...rest: any[]) => Error | null; + + interface Requireable extends Validator { + isRequired: Validator; + } + + type ValidationMap = {[K in keyof T]?: Validator }; + + var any: Requireable; + var array: Requireable; + var bool: Requireable; + var func: Requireable; + var number: Requireable; + var object: Requireable; + var string: Requireable; + var node: Requireable; + var element: Requireable; + function instanceOf(expectedClass: {}): Requireable; + function oneOf(types: any[]): Requireable; + function oneOfType(types: Array>): Requireable; + function arrayOf(type: Validator): Requireable; + function objectOf(type: Validator): Requireable; + function shape(type: ValidationMap): Requireable; } - -type ValidationMap = {[K in keyof T]?: Validator }; - -declare var any: Requireable; -declare var array: Requireable; -declare var bool: Requireable; -declare var func: Requireable; -declare var number: Requireable; -declare var object: Requireable; -declare var string: Requireable; -declare var node: Requireable; -declare var element: Requireable; -declare function instanceOf(expectedClass: {}): Requireable; -declare function oneOf(types: any[]): Requireable; -declare function oneOfType(types: Array>): Requireable; -declare function arrayOf(type: Validator): Requireable; -declare function objectOf(type: Validator): Requireable; -declare function shape(type: ValidationMap): Requireable; From 6745cbb3bb1139201bd346b65c93812e4d7e4872 Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Sun, 9 Apr 2017 01:47:54 +0300 Subject: [PATCH 275/844] Update index.d.ts --- types/prop-types/index.d.ts | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/types/prop-types/index.d.ts b/types/prop-types/index.d.ts index 86dc2d8b54..0fbc6f8c99 100644 --- a/types/prop-types/index.d.ts +++ b/types/prop-types/index.d.ts @@ -5,24 +5,23 @@ // TypeScript Version: 2.2 declare module 'prop-types' { - type Validator = (object: T, key: string, componentName: string, ...rest: any[]) => Error | null; - + interface Requireable extends Validator { isRequired: Validator; } - + type ValidationMap = {[K in keyof T]?: Validator }; - - var any: Requireable; - var array: Requireable; - var bool: Requireable; - var func: Requireable; - var number: Requireable; - var object: Requireable; - var string: Requireable; - var node: Requireable; - var element: Requireable; + + let any: Requireable; + let array: Requireable; + let bool: Requireable; + let func: Requireable; + let number: Requireable; + let object: Requireable; + let string: Requireable; + let node: Requireable; + let element: Requireable; function instanceOf(expectedClass: {}): Requireable; function oneOf(types: any[]): Requireable; function oneOfType(types: Array>): Requireable; From 92633c2e1ddbf2f178ccbf7d83f397c96bfb9caf Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Sun, 9 Apr 2017 01:59:40 +0300 Subject: [PATCH 276/844] Update index.d.ts --- types/prop-types/index.d.ts | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/types/prop-types/index.d.ts b/types/prop-types/index.d.ts index 0fbc6f8c99..8ee11c99b9 100644 --- a/types/prop-types/index.d.ts +++ b/types/prop-types/index.d.ts @@ -4,7 +4,7 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.2 -declare module 'prop-types' { +declare module PropTypes { type Validator = (object: T, key: string, componentName: string, ...rest: any[]) => Error | null; interface Requireable extends Validator { @@ -29,3 +29,7 @@ declare module 'prop-types' { function objectOf(type: Validator): Requireable; function shape(type: ValidationMap): Requireable; } + +declare module 'prop-types' { + export = PropTypes; +} From 6e4e9d50b2846ad8ef0c0d12c23790c9d8727e31 Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Sun, 9 Apr 2017 03:58:58 +0300 Subject: [PATCH 277/844] Update index.d.ts --- types/prop-types/index.d.ts | 46 ++++++++++++++++--------------------- 1 file changed, 20 insertions(+), 26 deletions(-) diff --git a/types/prop-types/index.d.ts b/types/prop-types/index.d.ts index 8ee11c99b9..11bcf018cc 100644 --- a/types/prop-types/index.d.ts +++ b/types/prop-types/index.d.ts @@ -4,32 +4,26 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.2 -declare module PropTypes { - type Validator = (object: T, key: string, componentName: string, ...rest: any[]) => Error | null; +export type Validator = (object: T, key: string, componentName: string, ...rest: any[]) => Error | null; - interface Requireable extends Validator { - isRequired: Validator; - } - - type ValidationMap = {[K in keyof T]?: Validator }; - - let any: Requireable; - let array: Requireable; - let bool: Requireable; - let func: Requireable; - let number: Requireable; - let object: Requireable; - let string: Requireable; - let node: Requireable; - let element: Requireable; - function instanceOf(expectedClass: {}): Requireable; - function oneOf(types: any[]): Requireable; - function oneOfType(types: Array>): Requireable; - function arrayOf(type: Validator): Requireable; - function objectOf(type: Validator): Requireable; - function shape(type: ValidationMap): Requireable; +export interface Requireable extends Validator { + isRequired: Validator; } -declare module 'prop-types' { - export = PropTypes; -} +export type ValidationMap = {[K in keyof T]?: Validator }; + +export let any: Requireable; +export let array: Requireable; +export let bool: Requireable; +export let func: Requireable; +export let number: Requireable; +export let object: Requireable; +export let string: Requireable; +export let node: Requireable; +export let element: Requireable; +export function instanceOf(expectedClass: {}): Requireable; +export function oneOf(types: any[]): Requireable; +export function oneOfType(types: Array>): Requireable; +export function arrayOf(type: Validator): Requireable; +export function objectOf(type: Validator): Requireable; +export function shape(type: ValidationMap): Requireable; From c6b350dcc22da39b51f572aef30187a4fb8ca7b0 Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Sun, 9 Apr 2017 03:59:29 +0300 Subject: [PATCH 278/844] Update index.d.ts --- types/prop-types/index.d.ts | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/types/prop-types/index.d.ts b/types/prop-types/index.d.ts index 11bcf018cc..8449418fdf 100644 --- a/types/prop-types/index.d.ts +++ b/types/prop-types/index.d.ts @@ -12,15 +12,15 @@ export interface Requireable extends Validator { export type ValidationMap = {[K in keyof T]?: Validator }; -export let any: Requireable; -export let array: Requireable; -export let bool: Requireable; -export let func: Requireable; -export let number: Requireable; -export let object: Requireable; -export let string: Requireable; -export let node: Requireable; -export let element: Requireable; +export const any: Requireable; +export const array: Requireable; +export const bool: Requireable; +export const func: Requireable; +export const number: Requireable; +export const object: Requireable; +export const string: Requireable; +export const node: Requireable; +export const element: Requireable; export function instanceOf(expectedClass: {}): Requireable; export function oneOf(types: any[]): Requireable; export function oneOfType(types: Array>): Requireable; From f22198d51fc0aa7ec29770c01a307e0d00839f47 Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Sun, 9 Apr 2017 04:32:42 +0300 Subject: [PATCH 279/844] Update prop-types-tests.ts --- types/prop-types/prop-types-tests.ts | 33 +++++++++++++++++++--------- 1 file changed, 23 insertions(+), 10 deletions(-) diff --git a/types/prop-types/prop-types-tests.ts b/types/prop-types/prop-types-tests.ts index 68ad75d500..eeb23b79fe 100644 --- a/types/prop-types/prop-types-tests.ts +++ b/types/prop-types/prop-types-tests.ts @@ -1,13 +1,26 @@ import * as PropTypes from "prop-types"; +import * as React from "react"; -let testObj: any = { - anyIsRequired: PropTypes.any.isRequired, - arrayIsRequired: PropTypes.array.isRequired, - boolIsRequired: PropTypes.bool.isRequired, - funcIsRequired: PropTypes.func.isRequired, - numberIsRequired: PropTypes.number.isRequired, - objectIsRequired: PropTypes.object.isRequired, - stringIsRequired: PropTypes.string.isRequired, - nodeIsRequired: PropTypes.node.isRequired, - elementIsRequired: PropTypes.element.isRequired +interface Props { + any: any; + array: string[]; + bool: boolean; + func: () => void; + string: string; + number: number; + object: {}; + node: any; + element: any; +} + +let propTypes: React.ValidationMap = { + any: PropTypes.any.isRequired, + array: PropTypes.array.isRequired, + bool: PropTypes.bool.isRequired, + func: PropTypes.func.isRequired, + number: PropTypes.number.isRequired, + object: PropTypes.object.isRequired, + string: PropTypes.string.isRequired, + node: PropTypes.node.isRequired, + element: PropTypes.element.isRequired }; From a3dea3512bd830cf8e443991d1ed72401c939385 Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Sun, 9 Apr 2017 04:35:36 +0300 Subject: [PATCH 280/844] Update prop-types-tests.ts --- types/prop-types/prop-types-tests.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/prop-types/prop-types-tests.ts b/types/prop-types/prop-types-tests.ts index eeb23b79fe..6e08aa0bd3 100644 --- a/types/prop-types/prop-types-tests.ts +++ b/types/prop-types/prop-types-tests.ts @@ -5,7 +5,7 @@ interface Props { any: any; array: string[]; bool: boolean; - func: () => void; + func: any; string: string; number: number; object: {}; From 3b213274c4e610aec0b622d7b9727931ad11b0a2 Mon Sep 17 00:00:00 2001 From: Michael Cheng Date: Sat, 8 Apr 2017 21:26:24 -0500 Subject: [PATCH 281/844] Add defaultColor to GeoChartOptions in google.visualization typings --- types/google.visualization/google.visualization-tests.ts | 1 + types/google.visualization/index.d.ts | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/types/google.visualization/google.visualization-tests.ts b/types/google.visualization/google.visualization-tests.ts index a51657a592..34999ccc3f 100644 --- a/types/google.visualization/google.visualization-tests.ts +++ b/types/google.visualization/google.visualization-tests.ts @@ -49,6 +49,7 @@ function test_geoChart() { sizeAxis: { minValue: 0, maxValue: 100 }, region: '155', // Western Europe displayMode: 'markers', + defaultColor: '#ffffff', colorAxis: {colors: ['#e7711c', '#4374e0']} // orange to blue }; diff --git a/types/google.visualization/index.d.ts b/types/google.visualization/index.d.ts index 83b08296f8..9e26c3bb2b 100644 --- a/types/google.visualization/index.d.ts +++ b/types/google.visualization/index.d.ts @@ -1,6 +1,6 @@ // Type definitions for Google Visualisation Apis // Project: https://developers.google.com/chart/ -// Definitions by: Dan Ludwig , Gregory Moore , Dan Manastireanu +// Definitions by: Dan Ludwig , Gregory Moore , Dan Manastireanu , Michael Cheng // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped declare namespace google { @@ -301,6 +301,7 @@ declare namespace google { backgroundColor?: any; colorAxis?: ChartColorAxis; datalessRegionColor?: string; + defaultColor?: string; displayMode?: string; enableRegionInteractivity?: boolean; height?: number; From fb1d30cbf8eed4f61ef7cca755107fddfef268be Mon Sep 17 00:00:00 2001 From: bglee Date: Sun, 9 Apr 2017 15:48:06 +0900 Subject: [PATCH 282/844] fix type error --- types/react-ga/index.d.ts | 6 +++--- types/react-ga/react-ga-tests.ts | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/types/react-ga/index.d.ts b/types/react-ga/index.d.ts index d951cb2909..66e8140299 100644 --- a/types/react-ga/index.d.ts +++ b/types/react-ga/index.d.ts @@ -46,7 +46,7 @@ export interface TimingArgs { export interface Plugin { require(name: string, options: any): void; - execute(pluginName: string, action: string, actionTypeOrPayload: string|Object, payload?: Object): void; + execute(pluginName: string, action: string, actionTypeOrPayload: string|any, payload?: any): void; } export interface OutboundLinkArgs { @@ -54,7 +54,7 @@ export interface OutboundLinkArgs { } export function initialize(trackingCode: string, options?: InitializeOptions): void; -export function ga(): Function; +export function ga(): any; export function set(fieldsObject: FieldsObject): void; export function send(fieldsObject: FieldsObject): void; export function pageview(path: string): void; @@ -63,4 +63,4 @@ export function timing(args: TimingArgs): void; export function event(args: EventArgs): void; export function exception(fieldsObject: FieldsObject): void; export const plugin: Plugin; -export function outboundLink(args: OutboundLinkArgs, hitCallback: Function): void; +export function outboundLink(args: OutboundLinkArgs, hitCallback: () => void): void; diff --git a/types/react-ga/react-ga-tests.ts b/types/react-ga/react-ga-tests.ts index 4396cf9644..57d2162e0e 100644 --- a/types/react-ga/react-ga-tests.ts +++ b/types/react-ga/react-ga-tests.ts @@ -61,7 +61,7 @@ describe("Testing react-ga set calls", () => { describe("Testing react-ga v2.1.2", () => { it("Able to make ga calls", () => { - const gaObject: Function = ga.ga(); + ga.ga(); }); it("Able to make send calls", () => { let fieldObject: ga.FieldsObject = { @@ -76,7 +76,7 @@ describe("Testing react-ga v2.1.2", () => { variable: 'string', value: 1, label: 'string' - }) + }); }); it("Able to make exception calls", () => { let fieldObject: ga.FieldsObject = { From b380d77c8cedc2c4b1d2a9023ad153f8ccc64214 Mon Sep 17 00:00:00 2001 From: Avi Vahl Date: Sun, 9 Apr 2017 13:29:32 +0300 Subject: [PATCH 283/844] Match klaw's Options with implementation `pathSorter` and `filter` are callbacks passed to sort/filter of an array of *strings* (that is returned by fs.readdir). See: https://github.com/jprichardson/node-klaw/blob/master/src/index.js#L44 I saw the actual runtime failure when using the current types (a.path/stats is undefined in that context), which made me check the actual implementation. --- types/klaw/index.d.ts | 4 ++-- types/klaw/klaw-tests.ts | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/types/klaw/index.d.ts b/types/klaw/index.d.ts index e996a90033..cbe78af067 100644 --- a/types/klaw/index.d.ts +++ b/types/klaw/index.d.ts @@ -22,9 +22,9 @@ declare module "klaw" { interface Options extends ReadableOptions { queueMethod?: QueueMethod - pathSorter?: (a: Array) => Array + pathSorter?: (pathA: string, pathB: string) => number fs?: any // fs or mock-fs - filter?: (a: Item) => boolean + filter?: (path: string) => boolean } type Event = "close" | "data" | "end" | "readable" | "error" diff --git a/types/klaw/klaw-tests.ts b/types/klaw/klaw-tests.ts index acd8b2fcbf..2487aafd85 100644 --- a/types/klaw/klaw-tests.ts +++ b/types/klaw/klaw-tests.ts @@ -32,8 +32,8 @@ klaw('/some/dir') // README.md: Example (ignore hidden directories): -var filterFunc = function(item: klaw.Item): boolean { - var basename = path.basename(item.path) +var filterFunc = function(item: string): boolean { + var basename = path.basename(item); return basename === '.' || basename[0] !== '.' } From c74b87b930c80f8840767adc4cb8b323fd31b419 Mon Sep 17 00:00:00 2001 From: spacejack Date: Sun, 9 Apr 2017 14:44:29 -0400 Subject: [PATCH 284/844] Add types for Mithril 1.1 global version --- types/mithril-global/index.d.ts | 43 ++++++++++++++++++++ types/mithril-global/mithril-global-tests.ts | 13 ++++++ types/mithril-global/tsconfig.json | 22 ++++++++++ types/mithril-global/tslint.json | 23 +++++++++++ 4 files changed, 101 insertions(+) create mode 100644 types/mithril-global/index.d.ts create mode 100644 types/mithril-global/mithril-global-tests.ts create mode 100644 types/mithril-global/tsconfig.json create mode 100644 types/mithril-global/tslint.json diff --git a/types/mithril-global/index.d.ts b/types/mithril-global/index.d.ts new file mode 100644 index 0000000000..4dd8240303 --- /dev/null +++ b/types/mithril-global/index.d.ts @@ -0,0 +1,43 @@ +// Type definitions for Mithril 1.1 +// Project: https://mithril.js.org/ +// Definitions by: Mike Linkovich , Isiah Meadows +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.2 + +// Global Mithril types + +/// + +import * as mithril from 'mithril'; +import * as stream from 'mithril/stream'; + +declare namespace MithrilGlobal { + export type Lifecycle = mithril.Lifecycle; + export type Hyperscript = mithril.Hyperscript; + export type RouteResolver = mithril.RouteResolver; + export type RouteDefs = mithril.RouteDefs; + export type RouteOptions = mithril.RouteOptions; + export type Route = mithril.Route; + export type RequestOptions = mithril.RequestOptions; + export type JsonpOptions = mithril.JsonpOptions; + export type Child = mithril.Child; + export type ChildArray = mithril.ChildArray; + export type Children = mithril.Children; + export type ChildArrayOrPrimitive = mithril.ChildArrayOrPrimitive; + export type Vnode = mithril.Vnode; + export type VnodeDOM = mithril.VnodeDOM; + export type CVnode = mithril.CVnode; + export type CVnodeDOM = mithril.CVnodeDOM; + export type Component = mithril.Component; + export type Comp = mithril.Comp + export type ClassComponent = mithril.ClassComponent; + export type FactoryComponent = mithril.FactoryComponent; + export type ComponentTypes = mithril.ComponentTypes; + export type Attributes = mithril.Attributes; + export type Stream = stream.Stream; + export type Static = mithril.Static & {stream: stream.Static}; +} + +declare const MithrilGlobal: MithrilGlobal.Static; +export = MithrilGlobal; +export as namespace m; diff --git a/types/mithril-global/mithril-global-tests.ts b/types/mithril-global/mithril-global-tests.ts new file mode 100644 index 0000000000..a8aa577320 --- /dev/null +++ b/types/mithril-global/mithril-global-tests.ts @@ -0,0 +1,13 @@ +// Test global mithril types + +const comp = { + view() { + return m('span', "Test") + } +} as m.Comp<{},{}> + +m.mount(document.getElementById('comp')!, comp) + +const vnode = m('div', 'Test') + +const s: m.Stream = m.stream(1) diff --git a/types/mithril-global/tsconfig.json b/types/mithril-global/tsconfig.json new file mode 100644 index 0000000000..cb58123eb0 --- /dev/null +++ b/types/mithril-global/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": ["es2015", "dom"], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "suppressImplicitAnyIndexErrors": true, + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "baseUrl": "../", + "typeRoots": ["../"], + "types": [] + }, + "files": [ + "index.d.ts", + "mithril-global-tests.ts" + ], + "atom": { + "rewriteTsconfig": false + } +} diff --git a/types/mithril-global/tslint.json b/types/mithril-global/tslint.json new file mode 100644 index 0000000000..250b1b7b5f --- /dev/null +++ b/types/mithril-global/tslint.json @@ -0,0 +1,23 @@ +{ + "extends": "../tslint.json", + "rules": { + "array-type": [false, "array"], + "quotemark": [false, "double"], + "semicolon": [false, "always"], + "space-before-function-paren": [false, "always"], + "max-line-length": [false, 200], + "no-empty-interface": false, + "no-redundant-modifiers": false, + "only-arrow-functions": [false], + "prefer-for-of": false, + "unified-signatures": false, + "whitespace": [ + false, + "check-branch", + "check-decl", + "check-operator", + "check-separator", + "check-type" + ] + } +} From defc1df2f34f3e7fee27a7258f2d667ac805a897 Mon Sep 17 00:00:00 2001 From: mnb Date: Sun, 9 Apr 2017 22:38:14 +0300 Subject: [PATCH 285/844] Master commit --- types/react-native-fetch-blob/index.d.ts | 621 ++++++++++++++++++ .../react-native-fetch-blob-tests.ts | 378 +++++++++++ types/react-native-fetch-blob/tsconfig.json | 22 + types/react-native-fetch-blob/tslint.json | 1 + 4 files changed, 1022 insertions(+) create mode 100644 types/react-native-fetch-blob/index.d.ts create mode 100644 types/react-native-fetch-blob/react-native-fetch-blob-tests.ts create mode 100644 types/react-native-fetch-blob/tsconfig.json create mode 100644 types/react-native-fetch-blob/tslint.json diff --git a/types/react-native-fetch-blob/index.d.ts b/types/react-native-fetch-blob/index.d.ts new file mode 100644 index 0000000000..3e281c523d --- /dev/null +++ b/types/react-native-fetch-blob/index.d.ts @@ -0,0 +1,621 @@ +// Type definitions for react-native-fetch-blob 0.10 +// Project: https://github.com/wkh237/react-native-fetch-blob#readme +// Definitions by: MNB +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +export const RNFetchBlob: RNFetchBlobStatic; +export type RNFetchBlob = RNFetchBlobStatic; +export default RNFetchBlob; + +interface RNFetchBlobStatic { + fetch(method: Methods, url: string, headers?: { [key: string]: string }, body?: any + | null): StatefulPromise; + base64: { encode(input: string): string; decode(input: string): string }; + android: AndroidApi; + ios: IOSApi; + config(options: RNFetchBlobConfig): RNFetchBlobStatic; + session(name: string): RNFetchBlobSession; + fs: FS; + wrap(path: string): string; + net: Net; + polyfill: Polyfill; + // this require external module https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/oboe + JSONStream: any; +} + +interface Polyfill { + Blob: PolyfillBlob; + File: PolyfillFile; + XMLHttpRequest: PolyfillXMLHttpRequest; + ProgressEvent: PolyfillProgressEvent; + Event: PolyfillEvent; + FileReader: PolyfillFileReader; + Fetch: PolyfillFetch; +} + +declare class PolyfillFetch extends RNFetchBlobFetchPolyfill { + constructor(config: RNFetchBlobConfig); +} + +declare class RNFetchBlobFetchPolyfill { + constructor(config: RNFetchBlobConfig); + + build(): (url: string, options: RNFetchBlobConfig) => StatefulPromise; +} + +interface RNFetchBlobFetchRepsonse { + arrayBuffer(): Promise; + blob(): Promise; + json(): Promise; + rawResp(): Promise; + text(): Promise; + bodyUsed: boolean; + headers: any; + ok: boolean; + resp: FetchBlobResponse; + rnfbResp: FetchBlobResponse; + rnfbRespInfo: RNFetchBlobResponseInfo; + status: number; + type: string; +} + +/** + * RNFetchBlob response object class. + */ +interface FetchBlobResponse { + taskId: string; + /** + * get path of response temp file + * @return {string} File path of temp file. + */ + path(): string; + type: "base64" | "path" | "utf8"; + data: any; + /** + * Convert result to javascript RNFetchBlob object. + * @return {Promise} Return a promise resolves Blob object. + */ + blob(contentType: string, sliceSize: number): Promise; + /** + * Convert result to text. + * @return {string} Decoded base64 string. + */ + text(): string | Promise; + /** + * Convert result to JSON object. + * @return {object} Parsed javascript object. + */ + json(): any; + /** + * Return BASE64 string directly. + * @return {string} BASE64 string of response body. + */ + base64(): any; + /** + * Remove cahced file + * @return {Promise} + */ + flush(): void; + respInfo: RNFetchBlobResponseInfo; + session(name: string): RNFetchBlobSession | null; + /** + * Read file content with given encoding, if the response does not contains + * a file path, show warning message + * @param {String} encode Encode type, should be one of `base64`, `ascrii`, `utf8`. + */ + readFile(encode: Encoding): Promise | null; + /** + * Start read stream from cached file + * @param {String} encode Encode type, should be one of `base64`, `ascrii`, `utf8`. + */ + readStream(encode: Encoding): RNFetchBlobStream | null; +} + +interface PolyfillFileReader extends EventTarget { + isRNFBPolyFill: boolean; + onloadstart(e: Event): void; + onprogress(e: Event): void; + onload(e: Event): void; + onabort(e: Event): void; + onerror(e: Event): void; + onloadend(e: Event): void; + + abort(): void; + readAsArrayBuffer(b: PolyfillBlob): void; + readAsBinaryString(b: PolyfillBlob): void; + readAsText(b: PolyfillBlob, label?: string): void; + readAsDataURL(b: PolyfillBlob): void; + + readyState: number; + result: number; +} + +declare namespace PolyfillFileReader { + const EMPTY: number; + const LOADING: number; + const DONE: number; +} + +declare class PolyfillEvent { +} + +interface PolyfillProgressEvent extends EventTarget { + lengthComputable: boolean; + loaded: number; + total: number; +} + +declare class PolyfillBlob extends EventTarget { + /** + * RNFetchBlob Blob polyfill, create a Blob directly from file path, BASE64 + * encoded data, and string. The conversion is done implicitly according to + * given `mime`. However, the blob creation is asynchronously, to register + * event `onCreated` is need to ensure the Blob is creadted. + * + * @param data Content of Blob object + * @param cType Content type settings of Blob object, `text/plain` by default + * @param {boolean} defer When this argument set to `true`, blob constructor will not invoke blob created event automatically. + */ + constructor(data: any, cType: any, defer: boolean); + + /** + * Since Blob content will asynchronously write to a file during creation, + * use this method to register an event handler for Blob initialized event. + * @param {(b:Blob) => void} fn An event handler invoked when Blob created + * @return {Blob} The Blob object instance itself + */ + onCreated(fn: () => void): PolyfillBlob; + + markAsDerived(): void; + + /** + * Get file reference of the Blob object. + * @return {string} Blob file reference which can be consumed by RNFetchBlob fs + */ + getRNFetchBlobRef(): string; + + /** + * Create a Blob object which is sliced from current object + * @param {number} start Start byte number + * @param {number} end End byte number + * @param {string} contentType Optional, content type of new Blob object + * @return {Blob} + */ + slice(start?: number, end?: number, contentType?: string): PolyfillBlob; + + /** + * Read data of the Blob object, this is not standard method. + * @param {string} encoding Read data with encoding + * @return {Promise} + */ + readBlob(encoding: string): Promise; + + /** + * Release the resource of the Blob object. + * @nonstandard + * @return {Promise} + */ + close(): Promise; +} + +declare namespace PolyfillBlob { + function clearCache(): void; + + function build(data: any, cType: any): Promise; + + function setLog(level: number): void; +} + +declare class PolyfillFile extends PolyfillBlob { +} + +interface PolyfillXMLHttpRequest extends PolyfillXMLHttpRequestEventTarget { + upload: PolyfillXMLHttpRequestEventTarget; + readonly UNSENT: number; + readonly OPENED: number; + readonly HEADERS_RECEIVED: number; + readonly LOADING: number; + readonly DONE: number; + + /** + * XMLHttpRequest.open, always async, user and password not supported. When + * this method invoked, headers should becomes empty again. + * @param {string} method Request method + * @param {string} url Request URL + * @param {boolean} async Always async + * @param user NOT SUPPORTED + * @param password NOT SUPPORTED + */ + open(method: string, url: string, async: true, user: any, password: any): void; + + /** + * Invoke this function to send HTTP request, and set body. + * @param body Body in RNfetchblob flavor + */ + send(body: any): void; + + overrideMimeType(mime: string): void; + + setRequestHeader(name: string, value: string): void; + + abort(): void; + + getResponseHeader(field: string): string | null; + + getAllResponseHeaders(): string | null; + + onreadystatechange(e: Event): void; + readyState: number; + status: number; + statusText: string; + response: any; + responseText: any; + responseURL: string; + responseHeaders: any; + timeout: number; + responseType: string; +} + +declare namespace PolyfillXMLHttpRequest { + const binaryContentTypes: string[]; + const UNSENT: number; + const OPENED: number; + const HEADERS_RECEIVED: number; + const LOADING: number; + const DONE: number; + + function setLog(level: number): void; + + function addBinaryContentType(substr: string): void; + + function removeBinaryContentType(): void; +} + +interface PolyfillXMLHttpRequestEventTarget extends EventTarget { + onabort(e: Event): void; + onerror(e: Event): void; + onload(e: Event): void; + onloadstart(e: Event): void; + onprogress(e: Event): void; + ontimeout(e: Event): void; + onloadend(e: Event): void; +} + +interface Net { + /** + * Get cookie according to the given url. + * @param {string} domain Domain of the cookies to be removed, remove all + * @return {Promise>} Cookies of a specific domain. + */ + getCookies(domain: string): Promise; + + /** + * Remove cookies for a specific domain + * @param {?string} domain Domain of the cookies to be removed, remove all + * cookies when this is null. + * @return {Promise} + */ + removeCookies(domain?: string): Promise; +} + +interface FS { + RNFetchBlobSession: RNFetchBlobSession; + + /** + * Remove file at path. + * @param {string} path:string Path of target file. + * @return {Promise} + */ + unlink(path: string): Promise; + + /** + * Create a directory. + * @param {string} path Path of directory to be created + * @return {Promise} + */ + mkdir(path: string): Promise; + + /** + * Get a file cache session + * @param {string} name Stream ID + * @return {RNFetchBlobSession} + */ + session(name: string): RNFetchBlobSession; + + ls(path: string): Promise; + + /** + * Create file stream from file at `path`. + * @param {string} path The file path. + * @param {string} encoding Data encoding, should be one of `base64`, `utf8`, `ascii` + * @param {boolean} bufferSize Size of stream buffer. + * @return {RNFetchBlobStream} RNFetchBlobStream stream instance. + */ + readStream(path: string, encoding: Encoding, bufferSize?: number, tick?: number): Promise; + + mv(path: string, dest: string): Promise; + + cp(path: string, dest: string): Promise; + + /** + * Create write stream to a file. + * @param {string} path Target path of file stream. + * @param {string} encoding Encoding of input data. + * @param {boolean} append A flag represent if data append to existing ones. + * @return {Promise<{}>} A promise resolves a `WriteStream` object. + */ + writeStream(path: string, encoding: Encoding, append?: boolean): Promise; + + /** + * Write data to file. + * @param {string} path Path of the file. + * @param {string | number[]} data Data to write to the file. + * @param {string} encoding Encoding of data (Optional). + * @return {Promise} + */ + writeFile(path: string, data: string | number[], encoding?: Encoding): Promise; + + appendFile(path: string, data: string | number[], encoding?: Encoding): Promise; + + /** + * Wrapper method of readStream. + * @param {string} path Path of the file. + * @param {'base64' | 'utf8' | 'ascii'} encoding Encoding of read stream. + * @return {Promise | string>} + */ + readFile(path: string, encoding: Encoding, bufferSize?: number): Promise; + /** + * Check if file exists and if it is a folder. + * @param {string} path Path to check + * @return {Promise} + */ + exists(path: string): Promise; + + createFile(path: string, data: string, encoding: Encoding): Promise; + + isDir(path: string): Promise; + + /** + * Show statistic data of a path. + * @param {string} path Target path + * @return {RNFetchBlobFile} + */ + stat(path: string): Promise; + + lstat(path: string): Promise; + + /** + * Android only method, request media scanner to scan the file. + * @param {Array>} pairs Array contains Key value pairs with key `path` and `mime`. + * @return {Promise} + */ + scanFile(pairs: Array<{ [key: string]: string }>): Promise; + + dirs: Dirs; + + slice(src: string, dest: string, start: number, end: number): Promise; + asset(path: string): string; + df(): Promise<{ free: number, total: number }>; +} + +interface Dirs { + DocumentDir: string; + CacheDir: string; + PictureDir: string; + MusicDir: string; + MovieDir: string; + DownloadDir: string; + DCIMDir: string; + SDCardDir: string; + MainBundleDir: string; +} + +interface RNFetchBlobWriteStream { + id: string; + encoding: string; + append: boolean; + + write(data: string): Promise; + close(): void; +} + +interface RNFetchBlobReadStream { + path: string; + encoding: Encoding; + bufferSize?: number; + closed: boolean; + tick: number; + + open(): void; + + onData(fn: (chunk: string | number[]) => void): void; + + onError(fn: (err: any) => void): void; + + onEnd(fn: () => void): void; +} + +type Encoding = "utf8" | "ascii" | "base64"; + +/* tslint:disable-next-line interface-name*/ +interface IOSApi { + /** + * Open a file in {@link https://developer.apple.com/reference/uikit/uidocumentinteractioncontroller UIDocumentInteractionController}, + * this is the default document viewer of iOS, supports several kinds of files. On Android, there's an similar method {@link android.actionViewIntent}. + * @param path This is a required field, the path to the document. The path should NOT contains any scheme prefix. + */ + previewDocument(path: string): void; + + /** + * Show options menu for interact with the file. + * @param path This is a required field, the path to the document. The path should NOT contains any scheme prefix. + */ + openDocument(path: string): void; +} + +interface AndroidApi { + /** + * When sending an ACTION_VIEW intent with given file path and MIME type, system will try to open an + * App to handle the file. For example, open Gallery app to view an image, or install APK. + * @param path Path of the file to be opened. + * @param mime Basically system will open an app according to this MIME type. + */ + actionViewIntent(path: string, mime: string): Promise; +} + +type Methods = "POST" | "GET" | "DELETE" | "PUT" | "post" | "get" | "delete" | "put"; + +/** + * A declare class inherits Promise, it has extra method like progress, uploadProgress, + * and cancel which can help managing an asynchronous task's state. + */ +interface StatefulPromise extends Promise { + /** + * Cancel the request when invoke this method. + */ + cancel(cb?: (reason: any) => void): StatefulPromise; + + /** + * Add an event listener which triggers when data receiving from server. + */ + progress(callback: (received: number, total: number) => void): StatefulPromise; + + /** + * Add an event listener with custom configuration + */ + progress(config: { count?: number, interval?: number }, callback: (received: number, total: number) => void): StatefulPromise; + + /** + * Add an event listener with custom configuration. + */ + uploadProgress(callback: (sent: number, total: number) => void): StatefulPromise; + + /** + * Add an event listener with custom configuration + */ + uploadProgress(config: { count?: number, interval?: number }, callback: (sent: number, total: number) => void): StatefulPromise; + + /** + * An IOS only API, when IOS app turns into background network tasks will be terminated after ~180 seconds, + * in order to handle these expired tasks, you can register an event handler, which will be called after the + * app become active. + */ + expire(callback: () => void): StatefulPromise; +} + +declare class RNFetchBlobSession { + constructor(name: string, list: string[]); + + add(path: string): RNFetchBlobSession; + + remove(path: string): RNFetchBlobSession; + + dispose(): Promise; + + list(): string[]; + + name: string; + + static getSession(name: string): any; + + static setSession(name: string): void; + + static removeSession(name: string): void; +} + +/** + * A set of configurations that will be injected into a fetch method, with the following properties. + */ +interface RNFetchBlobConfig { + /** + * When this property is true, the downloaded data will overwrite the existing file. (true by default) + */ + overwrite?: boolean; + + /** + * Set timeout of the request (in milliseconds). + */ + timeout?: number; + + /** + * Set this property to true to display a network indicator on status bar, this feature is only supported on IOS. + */ + indicator?: boolean; + + /** + * Set this property to true will allow the request create connection with server have self-signed SSL + * certification. This is not recommended to use in production. + */ + trusty?: boolean; + + /** + * Set this property to true will makes response data of the fetch stored in a temp file, by default the temp + * file will stored in App's own root folder with file name template RNFetchBlob_tmp${timestamp}. + */ + fileCache?: boolean; + + /** + * Set this property to change temp file extension that created by fetch response data. + */ + appendExt?: string; + + /** + * When this property has value, fetch API will try to store response data in the path ignoring fileCache and + * appendExt property. + */ + path?: string; + + session?: string; + + addAndroidDownloads?: AddAndroidDownloads; +} + +interface AddAndroidDownloads { + /** + * download file using Android download manager or not. + */ + useDownloadManager?: boolean; + /** + * title of the file + */ + title?: string; + /** + * File description of the file. + */ + description?: string; + /** + * The destination which the file will be downloaded, it SHOULD be a location on external storage (DCIMDir). + */ + path?: string; + /** + * MIME type of the file. By default is text/plain + */ + mime?: string; + /** + * A boolean value, see Officail Document + * (https://developer.android.com/reference/android/app/DownloadManager.html#addCompletedDownload(java.lang.String, java.lang.String, boolean, java.lang.String, java.lang.String, long, boolean)) + */ + mediaScannable?: boolean; + /** + * A boolean value decide whether show a notification when download complete. + */ + notification?: boolean; +} + +interface RNFetchBlobResponseInfo { + taskId: string; + state: number; + headers: any; + status: number; + respType: "text" | "blob" | "" | "json"; + rnfbEncode: "path" | "base64" | "ascii" | "utf8"; +} + +interface RNFetchBlobStream { + onData(): void; + onError(): void; + onEnd(): void; +} + +declare class RNFetchBlobFile { +} diff --git a/types/react-native-fetch-blob/react-native-fetch-blob-tests.ts b/types/react-native-fetch-blob/react-native-fetch-blob-tests.ts new file mode 100644 index 0000000000..d276a0a7ab --- /dev/null +++ b/types/react-native-fetch-blob/react-native-fetch-blob-tests.ts @@ -0,0 +1,378 @@ +import {RNFetchBlob} from "react-native-fetch-blob"; + +let BASE64_IMAGE_STRING = 'some base64 image'; +let PATH_TO_THE_FILE = '/some/path.png'; + +// Download example: Fetch files that need authorization token +RNFetchBlob + .fetch('GET', 'http://www.example.com/images/img1.png', {Authorization: 'Bearer access-token...'}) + .then(res => { + let base64Str = res.base64(); + let text = res.text(); + let json = res.json(); + }); + +// Download to storage directly +RNFetchBlob + .config({ + // add this option that makes response data to be stored as a file, + // this is much more performant. + fileCache: true, + }) + .fetch('GET', 'http://www.example.com/file/example.zip', { + // some headers .. + }) + .then((res) => { + // the temp file path + console.log('The file saved to ', res.path()); + }); + +// Set Temp File Extension +RNFetchBlob + .config({ + fileCache: true, + // by adding this option, the temp files will have a file extension + appendExt: 'png' + }) + .fetch('GET', 'http://www.example.com/file/example.zip', { + // some headers .. + }) + .then((res) => { + // the temp file path with file extension `png` + console.log('The file saved to ', res.path()); + // Beware that when using a file path as Image source on Android, + // you must prepend "file://"" before the file path + // imageView = + }); + +// Use Specific File Path +let dirs = RNFetchBlob.fs.dirs; +RNFetchBlob + .config({ + // response data will be saved to this path if it has access right. + path: dirs.DocumentDir + '/path-to-file.anything' + }) + .fetch('GET', 'http://www.example.com/file/example.zip', { + // some headers .. + }) + .then((res) => { + // the path should be dirs.DocumentDir + 'path-to-file.anything' + console.log('The file saved to ', res.path()); + }); + +// Upload example : Dropbox files-upload API +RNFetchBlob.fetch('POST', 'https://content.dropboxapi.com/2/files/upload', { + Authorization: "Bearer access-token...", + 'Dropbox-API-Arg': JSON.stringify({ + path: '/img-from-react-native.png', + mode: 'add', + autorename: true, + mute: false + }), + 'Content-Type': 'application/octet-stream', + // here's the body you're going to send, should be a BASE64 encoded string + // (you can use "base64"(refer to the library 'mathiasbynens/base64') APIs to make one). + // The data will be converted to "byte array"(say, blob) before request sent. +}, BASE64_IMAGE_STRING) + .then((res) => { + console.log(res.text()); + }) + .catch((err) => { + // error handling .. + }); + +// Upload a file from storage +RNFetchBlob.fetch('POST', 'https://content.dropboxapi.com/2/files/upload', { + // dropbox upload headers + Authorization: "Bearer access-token...", + 'Dropbox-API-Arg': JSON.stringify({ + path: '/img-from-react-native.png', + mode: 'add', + autorename: true, + mute: false + }), + 'Content-Type': 'application/octet-stream', + // Change BASE64 encoded data to a file path with prefix `RNFetchBlob-file://`. + // Or simply wrap the file path with RNFetchBlob.wrap(). +}, RNFetchBlob.wrap(PATH_TO_THE_FILE)) + .then((res) => { + console.log(res.text()); + }) + .catch((err) => { + // error handling .. + }); + +// Multipart/form-data example: Post form data with file and data +RNFetchBlob.fetch('POST', 'http://www.example.com/upload-form', { + Authorization: "Bearer access-token", + otherHeader: "foo", + 'Content-Type': 'multipart/form-data', +}, [ + // element with property `filename` will be transformed into `file` in form data + {name: 'avatar', filename: 'avatar.png', data: BASE64_IMAGE_STRING}, + // custom content type + {name: 'avatar-png', filename: 'avatar-png.png', type: 'image/png', data: BASE64_IMAGE_STRING}, + // part file from storage + {name: 'avatar-foo', filename: 'avatar-foo.png', type: 'image/foo', data: RNFetchBlob.wrap(PATH_TO_THE_FILE)}, + // elements without property `filename` will be sent as plain text + {name: 'name', data: 'user'}, + { + name: 'info', data: JSON.stringify({ + mail: 'example@example.com', + tel: '12345678' + }) + }, +]).then((resp) => { + // ... +}).catch((err) => { + // ... +}); + +RNFetchBlob.fetch('POST', 'http://www.example.com/upload-form', { + Authorization: "Bearer access-token", + otherHeader: "foo", + // this is required, otherwise it won't be process as a multipart/form-data request + 'Content-Type': 'multipart/form-data', +}, [ + // append field data from file path + { + name: 'avatar', + filename: 'avatar.png', + // Change BASE64 encoded data to a file path with prefix `RNFetchBlob-file://`. + // Or simply wrap the file path with RNFetchBlob.wrap(). + data: RNFetchBlob.wrap(PATH_TO_THE_FILE) + }, + { + name: 'ringtone', + filename: 'ring.mp3', + // use custom MIME type + type: 'application/mp3', + // upload a file from asset is also possible in version >= 0.6.2 + data: RNFetchBlob.wrap(RNFetchBlob.fs.asset('default-ringtone.mp3')) + }, + // elements without property `filename` will be sent as plain text + {name: 'name', data: 'user'}, + { + name: 'info', data: JSON.stringify({ + mail: 'example@example.com', + tel: '12345678' + }) + }, +]).then((resp) => { + // ... +}).catch((err) => { + // ... +}); + +// Upload/Download progress +RNFetchBlob.fetch('POST', 'http://www.example.com/upload', { + // ... some headers, + 'Content-Type': 'octet-stream' +}, BASE64_IMAGE_STRING) +// listen to upload progress event + .uploadProgress((written, total) => { + console.log('uploaded', written / total); + }) + // listen to download progress event + .progress((received, total) => { + console.log('progress', received / total); + }) + .then((resp) => { + // ... + }) + .catch((err) => { + // ... + }); + +RNFetchBlob.fetch('POST', 'http://www.example.com/upload', { + // ... some headers, + 'Content-Type': 'octet-stream' +}, BASE64_IMAGE_STRING) +// listen to upload progress event, emit every 250ms + .uploadProgress({interval: 250}, (written, total) => { + console.log('uploaded', written / total); + }) + // listen to download progress event, every 10% + .progress({count: 10}, (received, total) => { + console.log('progress', received / total); + }) + .then((resp) => { + // ... + }) + .catch((err) => { + // ... + }); + +// Cancel Request +let task = RNFetchBlob.fetch('GET', 'http://example.com/file/1'); +task.then(() => { +}) +// handle request cancelled rejection + .catch((err) => { + console.log(err); + }); +// cancel the request, the callback function is optional +task.cancel((err: any) => { +}); + +// Media Scanner +RNFetchBlob + .config({ + // DCIMDir is in external storage + path: dirs.DCIMDir + '/music.mp3' + }) + .fetch('GET', 'http://example.com/music.mp3') + .then((res) => RNFetchBlob.fs.scanFile([{path: res.path(), mime: 'audio/mpeg'}])) + .then(() => { + // scan file success + }) + .catch((err) => { + // scan file error + }); + +// Download Manager +RNFetchBlob + .config({ + addAndroidDownloads: { + useDownloadManager: true, // <-- this is the only thing required + // Optional, override notification setting (default to true) + notification: false, + // Optional, but recommended since android DownloadManager will fail when + // the url does not contains a file extension, by default the mime type will be text/plain + mime: 'text/plain', + description: 'File downloaded by download manager.' + } + }) + .fetch('GET', 'http://example.com/file/somefile') + .then((resp) => { + // the path of downloaded file + resp.path(); + }); + +RNFetchBlob.config({ + fileCache: true, + // android only options, these options be a no-op on IOS + addAndroidDownloads: { + // Show notification when response data transmitted + notification: true, + // Title of download notification + title: 'Great ! Download Success ! :O ', + // File description (not notification description) + description: 'An image file.', + mime: 'image/png', + // Make the file scannable by media scanner + mediaScannable: true, + } +}) + .fetch('GET', 'http://example.com/image1.png'); + +const android = RNFetchBlob.android; + +// Open Downloaded File with Intent +RNFetchBlob.config({ + addAndroidDownloads: { + useDownloadManager: true, + title: 'awesome.apk', + description: 'An APK that will be installed', + mime: 'application/vnd.android.package-archive', + mediaScannable: true, + notification: true, + } +}) + .fetch('GET', `http://www.example.com/awesome.apk`) + .then((res) => { + android.actionViewIntent(res.path(), 'application/vnd.android.package-archive'); + // Or show an image in image viewer + android.actionViewIntent(res.path(), 'image/png'); + }); + +// File Stream +let data = ''; +RNFetchBlob.fs.readStream( + // file path + PATH_TO_THE_FILE, + // encoding, should be one of `base64`, `utf8`, `ascii` + 'base64', + // (optional) buffer size, default to 4096 (4095 for BASE64 encoded data) + // when reading file in BASE64 encoding, buffer size must be multiples of 3. + 4095) + .then((ifstream) => { + ifstream.open(); + ifstream.onData((chunk) => { + // when encoding is `ascii`, chunk will be an array contains numbers + // otherwise it will be a string + data += chunk; + }); + ifstream.onError((err) => { + console.log('oops', err); + }); + ifstream.onEnd(() => { + // { + ofstream.write('foo'); + ofstream.write('bar'); + ofstream.close(); + }); + +// Cache File Management +// remove file using RNFetchblobResponse.flush() object method +RNFetchBlob + .config({fileCache: true}) + .fetch('GET', 'http://example.com/download/file') + .then((res) => { + // remove cached file from storage + res.flush(); + }); + +// remove file by specifying a path +RNFetchBlob.fs + .unlink('some-file-path') + .then(() => { + // ... + }); + +RNFetchBlob.config({ + fileCache: true +}) + .fetch('GET', 'http://example.com/download/file') + .then((res) => { + // set session of a response + res.session('foo'); + }); + +RNFetchBlob.config({ + // you can also set session beforehand + session: 'foo', + fileCache: true +}) + .fetch('GET', 'http://example.com/download/file') + .then((res) => { + // ... + }); + +// or put an existing file path to the session +RNFetchBlob.session('foo').add('some-file-path'); +// remove a file path from the session +RNFetchBlob.session('foo').remove('some-file-path'); +// list paths of a session +RNFetchBlob.session('foo').list(); +// remove all files in a session +RNFetchBlob.session('foo').dispose().then(() => { +}); + +// Transfer Encoding +RNFetchBlob.fetch('POST', 'http://example.com/upload', {'Transfer-Encoding': 'Chunked'}, 'bodyData'); + +// Self-Signed SSL Server +RNFetchBlob.config({ + trusty: true +}); diff --git a/types/react-native-fetch-blob/tsconfig.json b/types/react-native-fetch-blob/tsconfig.json new file mode 100644 index 0000000000..18538dfe6c --- /dev/null +++ b/types/react-native-fetch-blob/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6", "dom" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true +}, + "files": [ + "index.d.ts", + "react-native-fetch-blob-tests.ts" + ] +} diff --git a/types/react-native-fetch-blob/tslint.json b/types/react-native-fetch-blob/tslint.json new file mode 100644 index 0000000000..377cc837d4 --- /dev/null +++ b/types/react-native-fetch-blob/tslint.json @@ -0,0 +1 @@ +{ "extends": "../tslint.json" } From c5c2e50f78883ba4587e42323b9e35b33959fa04 Mon Sep 17 00:00:00 2001 From: Karol Janyst Date: Mon, 10 Apr 2017 10:21:22 +0900 Subject: [PATCH 286/844] Add quick redx-form fixes --- types/redux-form/lib/Field.d.ts | 5 ++++- types/redux-form/lib/reduxForm.d.ts | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/types/redux-form/lib/Field.d.ts b/types/redux-form/lib/Field.d.ts index 8c75977f6c..3409c47842 100644 --- a/types/redux-form/lib/Field.d.ts +++ b/types/redux-form/lib/Field.d.ts @@ -185,7 +185,10 @@ interface WrappedFieldProps { /** * These props are meant to be destructured into your component. */ -type EventOrValueHandler = (eventOrValue: Event | FieldValue, newValue: FieldValue, previousValue: FieldValue) => void; +interface EventOrValueHandler { + (event: Event): void; + (value: FieldValue, newValue: FieldValue, previousValue: FieldValue): void; +} interface WrappedFieldInputProps { /** diff --git a/types/redux-form/lib/reduxForm.d.ts b/types/redux-form/lib/reduxForm.d.ts index e4429015e1..0912233154 100644 --- a/types/redux-form/lib/reduxForm.d.ts +++ b/types/redux-form/lib/reduxForm.d.ts @@ -34,7 +34,7 @@ export interface Config { * the name of your form and the key to where your form's state will be * mounted under the redux-form reducer */ - form: string; + form?: string; /** * field names for which onBlur should trigger a call to the asyncValidate From fb72330b03e8d4569fdae5a36190d7596327292c Mon Sep 17 00:00:00 2001 From: Niklas Walter Date: Mon, 10 Apr 2017 09:54:08 +0200 Subject: [PATCH 287/844] Correct type for precision parameter --- types/moment-duration-format/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/moment-duration-format/index.d.ts b/types/moment-duration-format/index.d.ts index a3ce7bb300..34179e6dc4 100644 --- a/types/moment-duration-format/index.d.ts +++ b/types/moment-duration-format/index.d.ts @@ -7,7 +7,7 @@ import * as moment from "moment"; declare module "moment" { interface Duration { - format(template: string, precision?: string, settings?: DurationFormatSettings): string; + format(template: string, precision?: number, settings?: DurationFormatSettings): string; } interface DurationFormatSettings { From f4be347d01d568ee264dc4ff928263216b46eec4 Mon Sep 17 00:00:00 2001 From: cronon Date: Mon, 10 Apr 2017 13:20:44 +0300 Subject: [PATCH 288/844] @types/cookiejs update to cookie_js@1.2.2 --- types/cookiejs/cookiejs-tests.ts | 3 +++ types/cookiejs/index.d.ts | 9 +++++++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/types/cookiejs/cookiejs-tests.ts b/types/cookiejs/cookiejs-tests.ts index d1f382e193..43047f4fb6 100644 --- a/types/cookiejs/cookiejs-tests.ts +++ b/types/cookiejs/cookiejs-tests.ts @@ -27,6 +27,9 @@ cookie.remove('a'); cookie.remove('a', 'b'); cookie.remove(['a', 'b']); +cookie.removeSpecific('a', {path: '/search'}); +cookie.removeSpecific(['a', 'b'], {path: '/search'}); + cookie.empty(); cookie.all(); diff --git a/types/cookiejs/index.d.ts b/types/cookiejs/index.d.ts index ba7f0ee4f1..ad769bcb0e 100644 --- a/types/cookiejs/index.d.ts +++ b/types/cookiejs/index.d.ts @@ -1,5 +1,5 @@ -// Type definitions for cookie.js v1.0.0 -// Project: https://github.com/js-coder/cookie.js +// Type definitions for cookie.js v1.2.2 +// Project: https://github.com/florian/cookie.js // Definitions by: Boltmade // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped /** @@ -27,6 +27,11 @@ declare namespace cookie { export function remove(key : string) : void; export function remove(keys : string[]) : void; export function remove(...args : string[]) : void; + /** + * Remove cookies that were set with custom options (e.g. specifing domain or path) + */ + export function removeSpecific(key : string, options?: any) : void; + export function removeSpecific(keys : string[], options?: any): void; /** * Remove all cookies */ From 0ea3339d8fa33263c418ad06da80841b8ec56a0b Mon Sep 17 00:00:00 2001 From: David Poetzsch-Heffter Date: Mon, 10 Apr 2017 12:40:52 +0200 Subject: [PATCH 289/844] fixed returns --- types/kue/index.d.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/types/kue/index.d.ts b/types/kue/index.d.ts index 3fd5953371..6443ff353f 100644 --- a/types/kue/index.d.ts +++ b/types/kue/index.d.ts @@ -81,8 +81,8 @@ export declare class Job extends events.EventEmitter { get(key: string, fn?: Function): Job; progress(complete: number, total: number, data?: any): Job; delay(ms: number | Date): Job; - removeOnComplete(param: any): void; - backoff(param: any): void; + removeOnComplete(param: any): Job; + backoff(param: any): Job; ttl(param: any): Job; private _getBackoffImpl(): void; priority(level: string | number): Job; From e2f6325d6b5939f1488e40c59792db939731110f Mon Sep 17 00:00:00 2001 From: David Poetzsch-Heffter Date: Mon, 10 Apr 2017 12:50:03 +0200 Subject: [PATCH 290/844] fixed version number --- types/kue/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/kue/index.d.ts b/types/kue/index.d.ts index 6443ff353f..13f2c667fc 100644 --- a/types/kue/index.d.ts +++ b/types/kue/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for kue 0.9.x +// Type definitions for kue 0.11.x // Project: https://github.com/Automattic/kue // Definitions by: Nicholas Penree // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped From 2e1d56dc9baf50a2b86ba53a3ad969e0d548e6d8 Mon Sep 17 00:00:00 2001 From: Alan Date: Mon, 10 Apr 2017 13:05:08 +0200 Subject: [PATCH 291/844] feat(stylelint): update typyings to match new API --- types/stylelint/index.d.ts | 4 +++- types/stylelint/stylelint-tests.ts | 2 ++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/types/stylelint/index.d.ts b/types/stylelint/index.d.ts index 2ec479d2e1..14b769d20e 100644 --- a/types/stylelint/index.d.ts +++ b/types/stylelint/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for stylelint 7.9 +// Type definitions for stylelint 7.10 // Project: https://github.com/stylelint/stylelint // Definitions by: Alan Agius // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped @@ -10,6 +10,8 @@ export interface LinterOptions { configBasedir?: string; configFile?: string; configOverrides?: JSON; + cache?: boolean; + cacheLocation?: string; files?: string | string[]; formatter?: "json" | "string" | "verbose"; ignoreDisables?: boolean; diff --git a/types/stylelint/stylelint-tests.ts b/types/stylelint/stylelint-tests.ts index 0eeb0bdec8..4e017f7083 100644 --- a/types/stylelint/stylelint-tests.ts +++ b/types/stylelint/stylelint-tests.ts @@ -4,6 +4,8 @@ const options: LinterOptions = { code: "div { color: red }", files: ["**/**.scss"], formatter: "json", + cache: true, + cacheLocation: "./stylelint.cache.json", ignoreDisables: true, reportNeedlessDisables: true, ignorePath: true, From 52674e53504c5ac56fad38e384111ff62d2cc077 Mon Sep 17 00:00:00 2001 From: Alan Date: Mon, 10 Apr 2017 13:07:21 +0200 Subject: [PATCH 292/844] remove trailing slash --- types/stylelint/index.d.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/types/stylelint/index.d.ts b/types/stylelint/index.d.ts index 14b769d20e..a9cef5344c 100644 --- a/types/stylelint/index.d.ts +++ b/types/stylelint/index.d.ts @@ -1,6 +1,6 @@ // Type definitions for stylelint 7.10 // Project: https://github.com/stylelint/stylelint -// Definitions by: Alan Agius +// Definitions by: Alan Agius // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped export interface LinterOptions { From 529b57cca43d7f1f1e1437ca39469e73aef8f1b0 Mon Sep 17 00:00:00 2001 From: Dovydas Navickas Date: Mon, 10 Apr 2017 15:42:27 +0300 Subject: [PATCH 293/844] Update prop-types-tests.ts --- types/prop-types/prop-types-tests.ts | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/types/prop-types/prop-types-tests.ts b/types/prop-types/prop-types-tests.ts index 6e08aa0bd3..3f43cc73e5 100644 --- a/types/prop-types/prop-types-tests.ts +++ b/types/prop-types/prop-types-tests.ts @@ -1,5 +1,4 @@ import * as PropTypes from "prop-types"; -import * as React from "react"; interface Props { any: any; @@ -13,7 +12,7 @@ interface Props { element: any; } -let propTypes: React.ValidationMap = { +let propTypes: PropTypes.ValidationMap = { any: PropTypes.any.isRequired, array: PropTypes.array.isRequired, bool: PropTypes.bool.isRequired, From 41d9913c91a108d72ddf62ff06ea41d0d81365c9 Mon Sep 17 00:00:00 2001 From: Jonas Thiel Date: Mon, 10 Apr 2017 15:47:27 +0200 Subject: [PATCH 294/844] =?UTF-8?q?Add=20type=20definition=20for=20?= =?UTF-8?q?=E2=80=9Ereact-native-snap-carousel=E2=80=9C?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- types/react-native-snap-carousel/index.d.ts | 124 ++++++++++++++++++ .../react-native-snap-carousel-tests.tsx | 49 +++++++ .../react-native-snap-carousel/tsconfig.json | 24 ++++ types/react-native-snap-carousel/tslint.json | 1 + 4 files changed, 198 insertions(+) create mode 100644 types/react-native-snap-carousel/index.d.ts create mode 100644 types/react-native-snap-carousel/react-native-snap-carousel-tests.tsx create mode 100644 types/react-native-snap-carousel/tsconfig.json create mode 100644 types/react-native-snap-carousel/tslint.json diff --git a/types/react-native-snap-carousel/index.d.ts b/types/react-native-snap-carousel/index.d.ts new file mode 100644 index 0000000000..8d08f3ff82 --- /dev/null +++ b/types/react-native-snap-carousel/index.d.ts @@ -0,0 +1,124 @@ +// Type definitions for react-native-snap-carousel 2.1 +// Project: https://github.com/archriss/react-native-snap-carousel +// Definitions by: jnbt +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +import * as React from 'react'; +import { + Animated, + ScrollViewProperties, + ScrollViewStyle, + ViewStyle +} from 'react-native'; + +interface CarouselProps extends React.Props { + // Required + + /** + * Width in pixels of your slides, must be the same for all of them + */ + itemWidth: number; + /** + * Width in pixels of your slider + */ + sliderWidth: number; + + // Behavior + + /** + * From slider's center, minimum slide distance to be scrolled before being set to active + */ + activeSlideOffset?: number; + /** + * Since 1.5.0, the snapping effect can now be based on momentum instead of when you're + * releasing your finger. It means that the component will wait until the ScrollView + * isn't moving anymore to snap + */ + enableMomentum?: boolean; + /** + * If enabled, releasing the touch will scroll to the center of the nearest/active item + */ + enableSnap?: boolean; + /** + * Index of the first item to display + */ + firstItem?: number; + /** + * Whether to implement a shouldComponentUpdate strategy to minimize updates + */ + shouldOptimizeUpdates?: boolean; + /** + * Snapping on android is kinda choppy, especially when swiping quickly so you can disable it + */ + snapOnAndroid?: boolean; + /** + * Delta x when swiping to trigger the snap + */ + swipeThreshold?: number; + + // Autoplay + + /** + * Trigger autoplay on mount + */ + autoplay?: boolean; + /** + * Delay before enabling autoplay on startup & after releasing the touch + */ + autoplayDelay?: number; + /** + * Delay in ms until navigating to the next item + */ + autoplayInterval?: number; + + // Style and animation + + /** + * Animated animation to use. Provide the name of the method + */ + animationFunc?: 'decay' | 'timing' | 'spring'; + /** + * Animation options to be merged with the default ones. Can be used w/ animationFunc + */ + animationOptions?: Animated.DecayAnimationConfig | Animated.TimingAnimationConfig | Animated.SpringAnimationConfig; + /** + * Optional styles for Scrollview's global wrapper + */ + containerCustomStyle?: ScrollViewStyle; + /** + * Optional styles for Scrollview's items container + */ + contentContainerCustomStyle?: ScrollViewStyle; + /** + * Value of the opacity effect applied to inactive slides + */ + inactiveSlideOpacity?: number; + /** + * Value of the 'scale' transform applied to inactive slides + */ + inactiveSlideScale?: number; + /** + * Optional style for each item's container (the one whose scale and opacity are animated) + */ + slideStyle?: ViewStyle; + + // Callbacks + + /** + * Callback fired when navigating to an item + */ + onSnapToItem?(slideIndex: number): void; +} + +export interface CarouselStatic extends React.ComponentClass { + currentIndex: number; + startAutoplay(instantly?: boolean): void; + stopAutoplay(): void; + snapToItem(index: number, animated?: boolean): void; + snapToNext(animated?: boolean): void; + snapToPrev(animated?: boolean): void; +} + +export type CarouselProperties = ScrollViewProperties & CarouselProps & React.Props; + +export default class Carousel extends React.Component { } diff --git a/types/react-native-snap-carousel/react-native-snap-carousel-tests.tsx b/types/react-native-snap-carousel/react-native-snap-carousel-tests.tsx new file mode 100644 index 0000000000..88fb764b03 --- /dev/null +++ b/types/react-native-snap-carousel/react-native-snap-carousel-tests.tsx @@ -0,0 +1,49 @@ +import * as React from 'react'; +import { + StyleSheet, + Text, + View, + ViewStyle +} from 'react-native'; + +import Carousel from 'react-native-snap-carousel'; + +class SnapCarouselTest extends React.Component<{}, {}> { + render(): React.ReactElement { + return ( + + + + + Item #1 + + + + ); + } + + private onSnapToItem = (index: number) => { + console.log("Snapped to: ", index); + } +} + +const styles = StyleSheet.create({ + container: { + flex: 1 + } as ViewStyle, + item: { + width: 75 + } as ViewStyle +}); diff --git a/types/react-native-snap-carousel/tsconfig.json b/types/react-native-snap-carousel/tsconfig.json new file mode 100644 index 0000000000..0764309c6f --- /dev/null +++ b/types/react-native-snap-carousel/tsconfig.json @@ -0,0 +1,24 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6", + "dom" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "jsx": "react" + }, + "files": [ + "index.d.ts", + "react-native-snap-carousel-tests.tsx" + ] +} diff --git a/types/react-native-snap-carousel/tslint.json b/types/react-native-snap-carousel/tslint.json new file mode 100644 index 0000000000..377cc837d4 --- /dev/null +++ b/types/react-native-snap-carousel/tslint.json @@ -0,0 +1 @@ +{ "extends": "../tslint.json" } From 49cfecc4df3a8c035d26a084e65ca2dec29e3762 Mon Sep 17 00:00:00 2001 From: ManerFan Date: Mon, 10 Apr 2017 21:58:46 +0800 Subject: [PATCH 295/844] Added type definitions for pigpio 0.4.0 --- types/pigpio/index.d.ts | 412 ++++++++++++++++ types/pigpio/pigpio-tests.ts | 905 +++++++++++++++++++++++++++++++++++ types/pigpio/tsconfig.json | 22 + types/pigpio/tslint.json | 1 + 4 files changed, 1340 insertions(+) create mode 100644 types/pigpio/index.d.ts create mode 100644 types/pigpio/pigpio-tests.ts create mode 100644 types/pigpio/tsconfig.json create mode 100644 types/pigpio/tslint.json diff --git a/types/pigpio/index.d.ts b/types/pigpio/index.d.ts new file mode 100644 index 0000000000..fa89bc56ea --- /dev/null +++ b/types/pigpio/index.d.ts @@ -0,0 +1,412 @@ +// Type definitions for pigpio 0.4.0 +// Project: https://github.com/fivdi/pigpio +// Definitions by: ManerFan +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +/// + +/************************************ + * Gpio + ************************************/ + +/** + * General Purpose Input Output + */ +export class Gpio extends NodeJS.EventEmitter { + /** + * Returns a new Gpio object for accessing a GPIO + * @param gpio an unsigned integer specifying the GPIO number + * @param options object (optional) + */ + constructor( + gpio: number, + options?: { + /** + * INPUT, OUTPUT, ALT0, ALT1, ALT2, ALT3, ALT4, or ALT5 (optional, no default) + */ + mode?: number; + + /** + * PUD_OFF, PUD_DOWN, or PUD_UP (optional, no default) + */ + pullUpDown?: number; + + /** + * interrupt edge for inputs. RISING_EDGE, FALLING_EDGE, or EITHER_EDGE (optional, no default) + */ + edge?: number; + + /** + * interrupt timeout in milliseconds (optional, defaults to 0 meaning no timeout if edge specified) + */ + timeout?: number; + + /** + * boolean specifying whether or not alert events are emitted when the GPIO changes state (optional, default false) + */ + alert?: boolean + } + ); + + /** + * Sets the GPIO mode. + * @param mode INPUT, OUTPUT, ALT0, ALT1, ALT2, ALT3, ALT4, or ALT5 + */ + mode(mode: number): Gpio; + + /** + * Sets or clears the resistor pull type for the GPIO. + * @param pud PUD_OFF, PUD_DOWN, or PUD_UP + */ + pullUpDown(pud: number): Gpio; + + /** + * Returns the GPIO mode. + */ + getMode(): number; + + /** + * Returns the GPIO level, 0 or 1. + */ + digitalRead(): number; + + /** + * Sets the GPIO level to 0 or 1. If PWM or servo pulses are active on the GPIO they are switched off. + * @param levle 0 or 1 + */ + digitalWrite(levle: number): Gpio; + + /** + * Sends a trigger pulse to the GPIO. The GPIO is set to level for pulseLen microseconds and then reset to not level. + * @param pulseLen pulse length in microseconds (1 - 100) + * @param level 0 or 1 + */ + trigger(pulseLen: number, level: number): Gpio; + + /** + * Starts PWM on the GPIO. Returns this. + * @param dutyCycle an unsigned integer >= 0 (off) and <= range (fully on). range defaults to 255. + */ + pwmWrite(dutyCycle: number): Gpio; + + /** + * The same to #pwmWrite. + * @param dutyCycle an unsigned integer >= 0 (off) and <= range (fully on). range defaults to 255. + */ + analogWrite(dutyCycle: number): Gpio; + + /** + * Starts hardware PWM on the GPIO at the specified frequency and dutyCycle. Frequencies above 30MHz are unlikely to work. + * @param frequency an unsigned integer >= 0 and <= 125000000 + * @param dutyCycle an unsigned integer >= 0 (off) and <= 1000000 (fully on). + */ + hardwarePwmWrite(frequency: number, dutyCycle: number): Gpio; + + /** + * Returns the PWM duty cycle setting on the GPIO. + */ + getPwmDutyCycle(): number; + + /** + * Selects the duty cycle range to be used for the GPIO. Subsequent calls to pwmWrite will use a duty cycle between 0 (off) and range (fully on). + * @param range an unsigned integer in the range 25 through 40000 + */ + pwmRange(range: number): Gpio; + + /** + * Returns the duty cycle range used for the GPIO. + * If hardware PWM is active on the GPIO the reported range will be 1000000. + */ + getPwmRange(): number; + + /** + * Returns the real range used for the GPIO. + * If hardware PWM is active on the GPIO the reported real range will be approximately 250M divided by the set PWM frequency. + */ + getPwmRealRange(): number; + + /** + * Sets the frequency in hertz to be used for the GPIO. Returns this. + * @param frequency an unsigned integer >= 0 + */ + pwmFrequency(frequency: number): Gpio; + + /** + * Returns the frequency (in hertz) used for the GPIO. The default frequency is 800Hz. + */ + getPwmFrequency(): number; + + /** + * Starts servo pulses at 50Hz on the GPIO, 0 (off), 500 (most anti-clockwise) to 2500 (most clockwise) + * @param pulseWidth pulse width in microseconds, an unsigned integer, 0 or a number in the range 500 through 2500 + */ + servoWrite(pulseWidth: number): Gpio; + + /** + * Returns the servo pulse width setting on the GPIO. + */ + getServoPulseWidth(): number; + + /** + * Enables interrupts for the GPI + * @param edge RISING_EDGE, FALLING_EDGE, or EITHER_EDGE + * @param timeout interrupt timeout in milliseconds (optional, defaults to 0 meaning no timeout) + */ + enableInterrupt(edge: number, timeout?: number): Gpio; + + /** + * Disables interrupts for the GPIO. Returns this. + */ + disableInterrupt(): Gpio; + + /** + * Enables alerts for the GPIO. + */ + enableAlert(): Gpio; + + /** + * Disables aterts for the GPIO. + */ + disableAlert(): Gpio; + + /*----------------------* + * mode + *----------------------*/ + + /** + * Indicates that the GPIO is an input. + */ + static INPUT: number; + + /** + * Indicates that the GPIO is an output. + */ + static OUTPUT: number; + + /** + * Indicates that the GPIO is in alternative mode 0. + */ + static ALT0: number; + + /** + * Indicates that the GPIO is in alternative mode 1. + */ + static ALT1: number; + + /** + * Indicates that the GPIO is in alternative mode 2. + */ + static ALT2: number; + + /** + * Indicates that the GPIO is in alternative mode 03. + */ + static ALT3: number; + + /** + * Indicates that the GPIO is in alternative mode 4. + */ + static ALT4: number; + + /** + * Indicates that the GPIO is in alternative mode 5. + */ + static ALT5: number; + + /*----------------------* + * pud + *----------------------*/ + + /** + * Niether the pull-up nor the pull-down resistor should be enabled. + */ + static PUD_OFF: number; + + /** + * Enable pull-down resistor. + */ + static PUD_DOWN: number; + + /** + * Enable pull-up resistor. + */ + static PUD_UP: number; + + /*----------------------* + * isr + *----------------------*/ + + /** + * Indicates that the GPIO fires interrupts on rising edges. + */ + static RISING_EDGE: number; + + /** + * Indicates that the GPIO fires interrupts on falling edges. + */ + static FALLING_EDGE: number; + + /** + * Indicates that the GPIO fires interrupts on both rising and falling edges. + */ + static EITHER_EDGE: number; + + /*----------------------* + * timeout + *----------------------*/ + + /** + * The level argument passed to an interrupt event listener when an interrupt timeout expires. + */ + static TIMEOUT: number; + + /*----------------------* + * gpio numbers + *----------------------* + + /** + * The smallest GPIO number. + */ + static MIN_GPIO: number; + + /** + * The largest GPIO number. + */ + static MAX_GPIO: number; + + /** + * The largest user GPIO number. + */ + static MAX_USER_GPIO: number; +} + +/************************************ + * GpioBank + ************************************ + + /** + * Banked General Purpose Input Output + */ +export class GpioBank { + /** + * Returns a new GpioBank object for accessing up to 32 GPIOs as one operation. + * @param bank BANK1 or BANK2 (optional, defaults to BANK1) + */ + constructor(bank?: number); + + /** + * Returns the current level of all GPIOs in the bank. + */ + read(): number; + + /** + * For each GPIO in the bank, sets the GPIO level to 1 if the corresponding bit in bits is set. + * @param bits a bit mask of the the GPIOs to set to 1 + */ + set(bits: number): GpioBank; + + /** + * For each GPIO in the bank, sets the GPIO level to 0 if the corresponding bit in bits is set. + * @param bits a bit mask of the the GPIOs to clear or set to 0 + */ + clear(bits: number): GpioBank; + + /** + * Returns the bank identifier (BANK1 or BANK2.) + */ + bank(): number; + + /** + * Identifies bank 1. + */ + static BANK1: number; + + /** + * Identifies bank 2. + */ + static BACK2: number; +} + +/************************************ + * Notifier + ************************************ + + /** + * Notification Stream + */ +export class Notifier { + /** + * Returns a new Notifier object that contains a stream which provides notifications about state changes on any of GPIOs 0 through 31 concurrently. + * @param options Used to configure which GPIOs notifications should be provided for. + */ + constructor(options?: { + /** + * a bit mask indicating the GPIOs of interest, bit0 corresponds to GPIO0, bit1 corresponds to GPIO1, ..., bit31 corresponds to GPIO31. + * If a bit is set, the corresponding GPIO will be monitored for state changes. (optional, no default) + */ + bits: number; + }) + + /** + * Starts notifications for the GPIOs specified in the bit mask. + * @param bits a bit mask indicating the GPIOs of interest, bit0 corresponds to GPIO0, bit1 corresponds to GPIO1, ..., bit31 corresponds to GPIO31. + * If a bit is set, the corresponding GPIO will be monitored for state changes. + */ + start(bits: number): Notifier; + + /** + * Stops notifications. Notifications can be restarted with the start method. + */ + stop(): Notifier; + + /** + * Stops notifications and releases resources. + */ + close(): Notifier; + + /** + * Returns the notification stream which is a Readable stream. + */ + stream(): NodeJS.ReadableStream; + + /** + * The number of bytes occupied by a notification in the notification stream. + */ + static NOTIFICATION_LENGTH: number; + + /** + * Indicates a keep alive signal on the stream and is sent once a minute in the absence of other notification activity. + */ + static PI_NTFY_FLAGS_ALIVE: number; +} + +/************************************ + * Configuration + ************************************/ + +/** + * PI_CLOCK_PWM + */ +export const CLOCK_PWM: number; + +/** + * PI_CLOCK_PCM + */ +export const CLOCK_PCM: number; + +/** + * Initialize the pigpio package + */ +export function initialize(): void; + +/** + * Terminate the pigpio package + */ +export function terminate(): void; + +/** + * The configureClock function can be used to configure the sample rate and timing peripheral. + * @param microseconds an unsigned integer specifying the sample rate in microseconds (1, 2, 4, 5, 8, or 10) + * @param peripheral an unsigned integer specifying the peripheral for timing (CLOCK_PWM or CLOCK_PCM) + */ +export function configureClock(microseconds: number, peripheral: number): void; diff --git a/types/pigpio/pigpio-tests.ts b/types/pigpio/pigpio-tests.ts new file mode 100644 index 0000000000..ea7f620082 --- /dev/null +++ b/types/pigpio/pigpio-tests.ts @@ -0,0 +1,905 @@ +import * as pigpio from 'pigpio'; +import * as assert from 'assert'; + +(function alert_pwm_measurement(): void { + const Gpio = pigpio.Gpio; + + pigpio.configureClock(1, pigpio.CLOCK_PWM); + + let led = new Gpio(18, { + mode: Gpio.OUTPUT, + alert: true + }); + + led.digitalWrite(0); + + (function closure(): void { + let pulseCounts: number[] = []; + let pulses: number = 0; + let risingTick: number = 0; + let fallingTick: number; + let i: number; + + led.on('alert', function event(level: number, tick: number): void { + let pulseLength: number; + + if (level === 1) { + risingTick = tick; + } else { + fallingTick = tick; + pulseLength = fallingTick - risingTick; + + if (pulseCounts[pulseLength] === undefined) { + pulseCounts[pulseLength] = 0; + } + pulseCounts[pulseLength] += 1; + + pulses += 1; + if (pulses === 1000) { + for (i = 0; i !== pulseCounts.length; i += 1) { + if (pulseCounts[i] !== undefined) { + console.log(i + 'us - ' + pulseCounts[i]); + } + } + + led.digitalWrite(0); + led.disableAlert(); + } + } + }); + }()); + + // frequency 250Hz, duty cycle 7us + led.hardwarePwmWrite(250, 250 * 7); +})(); + +(function alert_trigger_pulse_measurement(): void { + const Gpio = pigpio.Gpio; + let led: pigpio.Gpio; + let iv: NodeJS.Timer; + + // pigpio.configureClock(1, pigpio.CLOCK_PCM); + + led = new Gpio(17, { + mode: Gpio.OUTPUT, + alert: true + }); + + led.digitalWrite(0); + + (function closure(): void { + let pulseCounts: number[] = []; + let pulses: number = 0; + let risingTick: number; + let fallingTick: number; + let i: number; + + led.on('alert', function event(level: number, tick: number): void { + let pulseLength: number; + + if (level === 1) { + risingTick = tick; + } else { + fallingTick = tick; + pulseLength = fallingTick - risingTick; + + if (pulseCounts[pulseLength] === undefined) { + pulseCounts[pulseLength] = 0; + } + pulseCounts[pulseLength] += 1; + + pulses += 1; + if (pulses === 1000) { + for (i = 0; i !== pulseCounts.length; i += 1) { + if (pulseCounts[i] !== undefined) { + console.log(i + 'us - ' + pulseCounts[i]); + } + } + + clearInterval(iv); + led.digitalWrite(0); + led.disableAlert(); + } + } + }); + }()); + + iv = setInterval(function timer() { + led.trigger(10, 1); + }, 2); +})(); + +(function alert(): void { + const Gpio = pigpio.Gpio; + let button = new Gpio(4, { alert: true }); + + button.on('alert', function event(level: number, tick: number): void { + console.log(level + ' ' + tick); + }); + + console.log(' press the momentary push button a few times'); +})(); + +(function banked_leds(): void { + const Gpio = pigpio.Gpio; + const GpioBank = pigpio.GpioBank; + let led17 = new Gpio(17, { mode: Gpio.OUTPUT }); + let led18 = new Gpio(18, { mode: Gpio.OUTPUT }); + let bank1 = new GpioBank(); + let iv: NodeJS.Timer; + + bank1.clear(1 << 18 | 1 << 17); + assert.strictEqual((bank1.read() >> 17) & 0x3, 0, 'expected 0'); + + iv = setInterval(function timer(): void { + let bits = (bank1.read() >> 17) & 0x3; + + if (bits === 0) { + bank1.set(1 << 17); + assert.strictEqual((bank1.read() >> 17) & 0x3, 1, 'expected 1'); + } else if (bits === 1) { + bank1.clear(1 << 17); + bank1.set(1 << 18); + assert.strictEqual((bank1.read() >> 17) & 0x3, 2, 'expected 2'); + } else if (bits === 2) { + bank1.set(1 << 17); + bank1.set(1 << 18); + assert.strictEqual((bank1.read() >> 17) & 0x3, 3, 'expected 3'); + } else if (bits === 3) { + bank1.clear(1 << 17); + bank1.clear(1 << 18); + assert.strictEqual((bank1.read() >> 17) & 0x3, 0, 'expected 0'); + } + }, 250); + + setTimeout(function timer() { + bank1.clear(1 << 18 | 1 << 17); + clearInterval(iv); + }, 2000); +})(); + +(function blinky_pwm(): void { + const Gpio = pigpio.Gpio; + let led = new Gpio(18, { mode: Gpio.OUTPUT }); + + led.hardwarePwmWrite(10, 500000); + + setTimeout(function timer() { + led.digitalWrite(0); + }, 2000); +})(); + +(function blinky(): void { + const Gpio = pigpio.Gpio; + let iv: NodeJS.Timer; + let led = new Gpio(17, { mode: Gpio.OUTPUT }); + + iv = setInterval(function timer() { + led.digitalWrite(led.digitalRead() ^ 1); + }, 100); + + setTimeout(function timer() { + led.digitalWrite(0); + clearInterval(iv); + }, 2000); +})(); + +(function digital_read_performance(): void { + const Gpio = pigpio.Gpio; + let button = new Gpio(4, { + mode: Gpio.INPUT, + pullUpDown: Gpio.PUD_DOWN + }); + let time: [number, number]; + let ops: number; + let i: number; + + time = process.hrtime(); + + for (i = 0; i !== 2000000; i += 1) { + button.digitalRead(); + } + + time = process.hrtime(time); + ops = Math.floor(i / (time[0] + time[1] / 1E9)); + + console.log(' ' + ops + ' read ops per second'); +})(); + +(function digital_write_performance(): void { + const Gpio = pigpio.Gpio; + let led = new Gpio(17, { mode: Gpio.OUTPUT }); + let time: [number, number]; + let ops: number; + let i: number; + + time = process.hrtime(); + + for (i = 0; i !== 2000000; i += 1) { + led.digitalWrite(1); + led.digitalWrite(0); + } + + time = process.hrtime(time); + ops = Math.floor((i * 2) / (time[0] + time[1] / 1E9)); + + console.log(' ' + ops + ' write ops per second'); +})(); + +(function gpio_mode(): void { + const Gpio = pigpio.Gpio; + let gpio7 = new Gpio(7, { mode: Gpio.INPUT }); + let gpio8 = new Gpio(8, { mode: Gpio.OUTPUT }); + + assert.strictEqual(gpio7.getMode(), Gpio.INPUT, 'expected INPUT mode for gpio7'); + assert.strictEqual(gpio8.getMode(), Gpio.OUTPUT, 'expected OUTPUT mode for gpio8'); + + gpio8.mode(Gpio.INPUT); + assert.strictEqual(gpio8.getMode(), Gpio.INPUT, 'expected INPUT mode for gpio8'); + + gpio7.mode(Gpio.OUTPUT); + assert.strictEqual(gpio7.getMode(), Gpio.OUTPUT, 'expected OUTPUT mode for gpio7'); + + gpio7.mode(Gpio.INPUT); + assert.strictEqual(gpio7.getMode(), Gpio.INPUT, 'expected INPUT mode for gpio7'); +})(); + +(function gpio_numbers(): void { + const Gpio = pigpio.Gpio; + + assert.strictEqual(Gpio.MIN_GPIO, 0, 'expected Gpio.MIN_GPIO to be 0'); + assert.strictEqual(Gpio.MAX_GPIO, 53, 'expected Gpio.MAX_GPIO to be 53'); + assert.strictEqual(Gpio.MAX_USER_GPIO, 31, 'expected Gpio.MAX_USER_GPIO to be 31'); +})(); + +(function isr_enable_disable(): void { + const Gpio = pigpio.Gpio; + let input = new Gpio(7, { mode: Gpio.INPUT }); + let output = new Gpio(8, { mode: Gpio.OUTPUT }); + let risingCount = 0; + let fallingCount = 0; + let iv: NodeJS.Timer; + + // Put output (and input) in a known state. + output.digitalWrite(0); + + // Toggle output (and input) every 10 ms + iv = setInterval(function timer() { + output.digitalWrite(output.digitalRead() ^ 1); + }, 10); + + // ISR + input.on('interrupt', function event(level: number) { + if (level === 0) { + fallingCount += 1; + } else if (level === 1) { + risingCount += 1; + } + }); + + function noEdge() { + console.log(' no edge'); + + input.disableInterrupt(); + risingCount = 0; + fallingCount = 0; + + setTimeout(function timer() { + console.log(' ' + risingCount + ' rising edge interrupts (0 expected)'); + console.log(' ' + fallingCount + ' falling edge interrupts (0 expected)'); + + clearInterval(iv); + input.disableInterrupt(); + }, 1000); + } + + function fallingEdge() { + console.log(' falling edge'); + + input.enableInterrupt(Gpio.FALLING_EDGE); + risingCount = 0; + fallingCount = 0; + + setTimeout(function timer() { + console.log(' ' + risingCount + ' rising edge interrupts (0 expected)'); + console.log(' ' + fallingCount + ' falling edge interrupts (~50 expected)'); + + noEdge(); + }, 1000); + } + + function risingEdge() { + console.log(' rising edge'); + + input.enableInterrupt(Gpio.RISING_EDGE); + risingCount = 0; + fallingCount = 0; + + setTimeout(function timer() { + console.log(' ' + risingCount + ' rising edge interrupts (~50 expected)'); + console.log(' ' + fallingCount + ' falling edge interrupts (0 expected)'); + + fallingEdge(); + }, 1000); + } + + (function eitherEdge() { + console.log(' either edge'); + + input.enableInterrupt(Gpio.EITHER_EDGE); + risingCount = 0; + fallingCount = 0; + + setTimeout(function timer() { + console.log(' ' + risingCount + ' rising edge interrupts (~50 expected)'); + console.log(' ' + fallingCount + ' falling edge interrupts (~50 expected)'); + + risingEdge(); + }, 1000); + }()); +})(); + +(function isr_multiple_sources(): void { + const Gpio = pigpio.Gpio; + + [[7, 8], [9, 11]].forEach(function loop(gpioNos: [number, number]) { + let interruptCount = 0; + let input = new Gpio(gpioNos[0], { mode: Gpio.INPUT, edge: Gpio.EITHER_EDGE }); + let output = new Gpio(gpioNos[1], { mode: Gpio.OUTPUT }); + + // Put input and output in a known state + output.digitalWrite(0); + + input.on('interrupt', function event(level: number) { + interruptCount += 1; + output.digitalWrite(level ^ 1); + + if (interruptCount === 1000) { + console.log(' ' + interruptCount + ' interrupts detected on GPIO' + gpioNos[0]); + input.disableInterrupt(); + } + }); + + setTimeout(function timer() { + // Trigger first interrupt + output.digitalWrite(1); + }, 1); + }); +})(); + +(function isr_performance(): void { + const Gpio = pigpio.Gpio; + let interruptCount = 0; + let input = new Gpio(7, { mode: Gpio.INPUT, edge: Gpio.EITHER_EDGE }); + let output = new Gpio(8, { mode: Gpio.OUTPUT }); + + output.digitalWrite(0); + + input.on('interrupt', function event(level: number) { + interruptCount++; + output.digitalWrite(level ^ 1); + }); + + setTimeout(function timer() { + let time = process.hrtime(); + + output.digitalWrite(1); + + setTimeout(function timer() { + let interruptsPerSec: number; + + time = process.hrtime(time); + interruptsPerSec = Math.floor(interruptCount / (time[0] + time[1] / 1E9)); + + console.log(' ' + interruptsPerSec + ' interrupts per second'); + + input.disableInterrupt(); + }, 1000); + }, 1); +})(); + +(function isr_timeouts_2(): void { + const Gpio = pigpio.Gpio; + let timeoutCount = 0; + let input = new Gpio(7, { mode: Gpio.INPUT, edge: Gpio.EITHER_EDGE, timeout: 100 }); + + input.on('interrupt', function timer(level: number) { + if (level === Gpio.TIMEOUT) { + timeoutCount++; + } + }); + + setTimeout(function time() { + console.log(' ' + timeoutCount + ' timeouts detected (~10 expected)'); + + input.enableInterrupt(Gpio.EITHER_EDGE, 1); + timeoutCount = 0; + + setTimeout(function timer() { + input.disableInterrupt(); + console.log(' ' + timeoutCount + ' timeouts detected (~1000 expected)'); + }, 1000); + }, 1000); +})(); + +(function isr_timeouts(): void { + const Gpio = pigpio.Gpio; + let timeoutCount = 0; + let input = new Gpio(7, { mode: Gpio.INPUT, edge: Gpio.EITHER_EDGE, timeout: 10 }); + + input.on('interrupt', function timer(level: number) { + if (level === Gpio.TIMEOUT) { + timeoutCount++; + } + }); + + setTimeout(function timer() { + console.log(' ' + timeoutCount + ' timeouts detected (~100 expected)'); + + input.enableInterrupt(Gpio.EITHER_EDGE); + timeoutCount = 0; + + setTimeout(function timer() { + input.disableInterrupt(); + console.log(' ' + timeoutCount + ' timeouts detected (0 expected)'); + }, 1000); + }, 1000); +})(); + +(function light_switch(): void { + const Gpio = pigpio.Gpio; + let button = new Gpio(4, { + mode: Gpio.INPUT, + pullUpDown: Gpio.PUD_DOWN, + edge: Gpio.EITHER_EDGE + }); + let led = new Gpio(17, { mode: Gpio.OUTPUT }); + + button.on('interrupt', function event(level: number) { + led.digitalWrite(level); + }); + + setTimeout(function timer() { + led.digitalWrite(0); + button.disableInterrupt(); + }, 2000); + + console.log(' press the momentary push button a few times'); +})(); + +(function notifier_leak_check(): void { + const Gpio = pigpio.Gpio; + const Notifier = pigpio.Notifier; + let notifierCount = 0; + + let LED_GPIO = 18; + let FREQUENCY = 25000; + + (function closure() { + let led = new Gpio(LED_GPIO, { mode: Gpio.OUTPUT }); + + led.hardwarePwmWrite(FREQUENCY, 500000); + }()); + + (function next() { + let ledNotifier = new Notifier({ bits: 1 << LED_GPIO }); + let closing = false; + + ledNotifier.stream().on('data', function event() { + if (!closing) { + ledNotifier.stream().on('close', function event() { + notifierCount += 1; + + if (notifierCount % 1000 === 0) { + console.log(notifierCount); + } + + if (notifierCount < 100000) { + next(); + } + }); + + ledNotifier.close(); + closing = true; + } + }); + }()); +})(); + +(function notifier_pwm(): void { + const Gpio = pigpio.Gpio; + const Notifier = pigpio.Notifier; + + let LED_GPIO = 18; + let FREQUENCY = 25000; + + (function closure() { + let led = new Gpio(LED_GPIO, { mode: Gpio.OUTPUT }); + + led.hardwarePwmWrite(FREQUENCY, 500000); + }()); + + (function closure() { + let ledNotifier = new Notifier({ bits: 1 << LED_GPIO }); + let notificationsReceived = 0; + let seqnoErrors = 0; + let ledStateErrors = 0; + let lastSeqno: number; + let lastLedState: number; + let lastTick: number; + let minTickDiff = 0xffffffff; + let maxTickDiff = 0; + + ledNotifier.stream().on('data', function event(buf: Buffer) { + let ix = 0; + + for (ix = 0; ix < buf.length; ix += Notifier.NOTIFICATION_LENGTH) { + let seqno = buf.readUInt16LE(ix); + let tick = buf.readUInt32LE(ix + 4); + let level = buf.readUInt32LE(ix + 8); + + if (notificationsReceived > 0) { + if (lastLedState === (level & (1 << LED_GPIO))) { + console.log(' unexpected led state'); + ledStateErrors += 1; + } + + if ((lastSeqno + 1) !== seqno) { + console.log(' seqno error, was %d, expected %d', seqno, lastSeqno + 1); + seqnoErrors += 1; + } + + if (tick - lastTick < minTickDiff) { + minTickDiff = tick - lastTick; + } + + if (tick - lastTick > maxTickDiff) { + maxTickDiff = tick - lastTick; + } + } + + notificationsReceived += 1; + lastSeqno = seqno; + lastLedState = level & (1 << LED_GPIO); + lastTick = tick; + } + + if (notificationsReceived >= 50000) { + ledNotifier.stream().pause(); + ledNotifier.close(); + console.log(' notifications: %d', notificationsReceived); + console.log(' seqno errors: %d', seqnoErrors); + console.log(' led state errors: %d', ledStateErrors); + console.log(' expected tick diff: %d us', 1000000 / (FREQUENCY * 2)); + console.log(' min tick diff: %d us', minTickDiff); + console.log(' max tick diff: %d us', maxTickDiff); + } + }); + }()); +})(); + +(function notifier_stress(): void { + const Gpio = pigpio.Gpio; + const Notifier = pigpio.Notifier; + + let LED_GPIO = 18; + let FREQUENCY = 150000; + + pigpio.configureClock(1, pigpio.CLOCK_PCM); + + (function closure() { + let led = new Gpio(LED_GPIO, { mode: Gpio.OUTPUT }); + + led.hardwarePwmWrite(FREQUENCY, 500000); + }()); + + (function closure() { + let ledNotifier = new Notifier({ bits: 1 << LED_GPIO }); + let notificationsReceived = 0; + let events = 0; + let seqnoErrors = 0; + let ledStateErrors = 0; + let lastSeqno: number; + let lastLedState: number; + let lastTick: number; + let minTickDiff = 0xffffffff; + let maxTickDiff = 0; + let restBuf: Buffer | null = null; + let iv: NodeJS.Timer; + + function printInfo() { + console.log(); + console.log(' events: %d', events); + console.log(' notifications: %d', notificationsReceived); + console.log(' seqno errors: %d', seqnoErrors); + console.log(' led state errors: %d', ledStateErrors); + console.log(' expected tick diff: %d us', 1000000 / (FREQUENCY * 2)); + console.log(' min tick diff: %d us', minTickDiff); + console.log(' max tick diff: %d us', maxTickDiff); + + minTickDiff = 0xffffffff; + maxTickDiff = 0; + } + + ledNotifier.stream().on('data', function event(buf: Buffer) { + let ix: number; + let entries: number; + let rest: number; + + events += 1; + + if (restBuf !== null) { + buf = Buffer.concat([restBuf, buf]); + } + + entries = Math.floor(buf.length / Notifier.NOTIFICATION_LENGTH); + rest = buf.length % Notifier.NOTIFICATION_LENGTH; + + if (rest === 0) { + restBuf = null; + } else { + restBuf = new Buffer(buf.slice(buf.length - rest)); + } + + for (ix = 0; ix < buf.length - rest; ix += Notifier.NOTIFICATION_LENGTH) { + let seqno = buf.readUInt16LE(ix); + let tick = buf.readUInt32LE(ix + 4); + let level = buf.readUInt32LE(ix + 8); + + if (notificationsReceived > 0) { + if (lastLedState === (level & (1 << LED_GPIO))) { + console.log(' unexpected led state'); + ledStateErrors += 1; + } + + if (((lastSeqno + 1) & 0xffff) !== seqno) { + console.log(' seqno error, was %d, expected %d', seqno, lastSeqno + 1); + seqnoErrors += 1; + } + + if (tick - lastTick < minTickDiff) { + minTickDiff = tick - lastTick; + } + + if (tick - lastTick > maxTickDiff) { + maxTickDiff = tick - lastTick; + } + } + + notificationsReceived += 1; + lastSeqno = seqno; + lastLedState = level & (1 << LED_GPIO); + lastTick = tick; + } + + if (notificationsReceived >= 1e9) { + ledNotifier.stream().pause(); + ledNotifier.close(); + clearInterval(iv); + printInfo(); + } + }); + + iv = setInterval(printInfo, 5000); + }()); +})(); + +(function notifier(): void { + const Gpio = pigpio.Gpio; + const Notifier = pigpio.Notifier; + + let LED_GPIO = 17; + let LED_TOGGLES = 1000; + + (function closure() { + let led = new Gpio(LED_GPIO, { mode: Gpio.OUTPUT }); + let ledToggles = 0; + let lastTime = process.hrtime(); + let minSetIntervalDiff = 0xffffffff; + let maxSetIntervalDiff = 0; + let iv: NodeJS.Timer; + + iv = setInterval(function timer() { + let time = process.hrtime(); + let diff = Math.floor(((time[0] * 1e9 + time[1]) - (lastTime[0] * 1e9 + lastTime[1])) / 1000); + + lastTime = time; + + if (diff < minSetIntervalDiff) { + minSetIntervalDiff = diff; + } + + if (diff > maxSetIntervalDiff) { + maxSetIntervalDiff = diff; + } + + led.digitalWrite(led.digitalRead() ^ 1); + + ledToggles += 1; + if (ledToggles === LED_TOGGLES) { + clearInterval(iv); + + console.log(' led toggles: %d', ledToggles); + console.log(' min setInterval diff: %d us', minSetIntervalDiff); + console.log(' max setInterval diff: %d us', maxSetIntervalDiff); + } + }, 1); + }()); + + (function closure() { + let ledNotifier = new Notifier({ bits: 1 << LED_GPIO }); + let notificationsReceived = 0; + let seqnoErrors = 0; + let ledStateErrors = 0; + let lastSeqno: number; + let lastLedState: number; + let lastTick: number; + let minTickDiff = 0xffffffff; + let maxTickDiff = 0; + + ledNotifier.stream().on('data', function event(buf: Buffer) { + let ix = 0; + + for (ix = 0; ix < buf.length; ix += Notifier.NOTIFICATION_LENGTH) { + let seqno = buf.readUInt16LE(ix); + let tick = buf.readUInt32LE(ix + 4); + let level = buf.readUInt32LE(ix + 8); + + if (notificationsReceived > 0) { + if (lastLedState === (level & (1 << LED_GPIO))) { + console.log(' unexpected led state'); + ledStateErrors += 1; + } + + if ((lastSeqno + 1) !== seqno) { + console.log(' seqno error, was %d, expected %d', seqno, lastSeqno + 1); + seqnoErrors += 1; + } + + if (tick - lastTick < minTickDiff) { + minTickDiff = tick - lastTick; + } + + if (tick - lastTick > maxTickDiff) { + maxTickDiff = tick - lastTick; + } + } + + notificationsReceived += 1; + lastSeqno = seqno; + lastLedState = level & (1 << LED_GPIO); + lastTick = tick; + } + + if (notificationsReceived >= LED_TOGGLES) { + ledNotifier.close(); + console.log(' notifications: %d', notificationsReceived); + console.log(' seqno errors: %d', seqnoErrors); + console.log(' led state errors: %d', ledStateErrors); + console.log(' min tick diff: %d us', minTickDiff); + console.log(' max tick diff: %d us', maxTickDiff); + } + }); + }()); +})(); + +(function pull_up_down(): void { + const Gpio = pigpio.Gpio; + let input = new Gpio(22, { mode: Gpio.INPUT, pullUpDown: Gpio.PUD_UP }); + + assert.strictEqual(input.digitalRead(), 1, 'expected gpio22 to be 1'); + input.pullUpDown(Gpio.PUD_DOWN); + assert.strictEqual(input.digitalRead(), 0, 'expected gpio22 to be 0'); +})(); + +(function pulse_led(): void { + const Gpio = pigpio.Gpio; + let iv: NodeJS.Timer; + let led = new Gpio(17, { mode: Gpio.OUTPUT }); + let dutyCycle = 0; + + iv = setInterval(function timer() { + let dutyCycleRead: number; + + led.pwmWrite(dutyCycle); + + dutyCycleRead = led.getPwmDutyCycle(); + assert.strictEqual(dutyCycleRead, dutyCycle, + 'expected dutyCycle to be ' + dutyCycle + ', not ' + dutyCycleRead + ); + + dutyCycle += 5; + if (dutyCycle > 255) { + dutyCycle = 0; + } + }, 20); + + setTimeout(function timer() { + led.digitalWrite(0); + clearInterval(iv); + }, 2000); +})(); + +(function pwm(): void { + const Gpio = pigpio.Gpio; + let iv: NodeJS.Timer; + let led = new Gpio(18, { mode: Gpio.OUTPUT }); + let dutyCycle: number; + + assert.strictEqual(led.getPwmRange(), 255, 'expected pwm range to be 255'); + assert.strictEqual(led.getPwmRealRange(), 250, 'expected pwm real range to be 250'); + assert.strictEqual(led.getPwmFrequency(), 800, 'expected get pwm frequency to be 800'); + + led.pwmRange(125); + assert.strictEqual(led.getPwmRange(), 125, 'expected pwm range to be 125'); + assert.strictEqual(led.getPwmRealRange(), 250, 'expected pwm real range to be 250'); + assert.strictEqual(led.getPwmFrequency(), 800, 'expected get pwm frequency to be 800'); + + led.pwmFrequency(2000); + assert.strictEqual(led.getPwmRange(), 125, 'expected pwm range to be 125'); + assert.strictEqual(led.getPwmRealRange(), 100, 'expected pwm real range to be 100'); + assert.strictEqual(led.getPwmFrequency(), 2000, 'expected get pwm frequency to be 2000'); + + dutyCycle = Math.floor(led.getPwmRange() / 2); + led.pwmWrite(dutyCycle); + assert.strictEqual(led.getPwmDutyCycle(), dutyCycle, 'expected duty cycle to be ' + dutyCycle); + + led.hardwarePwmWrite(1e7, 500000); + assert.strictEqual(led.getPwmRange(), 1e6, 'expected pwm range to be 1e6'); + assert.strictEqual(led.getPwmRealRange(), 25, 'expected pwm real range to be 25'); + assert.strictEqual(led.getPwmFrequency(), 1e7, 'expected get pwm frequency to be 1e7'); + assert.strictEqual(led.getPwmDutyCycle(), 500000, 'expected duty cycle to be 500000'); + + led.digitalWrite(0); + assert.strictEqual(led.getPwmRange(), 125, 'expected pwm range to be 125'); + assert.strictEqual(led.getPwmRealRange(), 100, 'expected pwm real range to be 100'); + assert.strictEqual(led.getPwmFrequency(), 2000, 'expected get pwm frequency to be 2000'); +}); + +(function servo_control(): void { + const Gpio = pigpio.Gpio; + let iv: NodeJS.Timer; + let motor = new Gpio(17, { mode: Gpio.OUTPUT }); + let pulseWidth = 500; + + motor.servoWrite(0); + assert.strictEqual(motor.getServoPulseWidth(), 0, + 'expected pulseWidth to be 0' + ); + + iv = setInterval(function timer() { + let pulseWidthRead: number; + + motor.servoWrite(pulseWidth); + + pulseWidthRead = motor.getServoPulseWidth(); + assert.strictEqual(pulseWidthRead, pulseWidth, + 'expected pulseWidth to be ' + pulseWidth + ', not ' + pulseWidthRead + ); + + pulseWidth += 25; + if (pulseWidth > 2500) { + pulseWidth = 500; + } + }, 20); + + setTimeout(function timer() { + motor.digitalWrite(0); + clearInterval(iv); + }, 2000); +})(); + +(function tirgger_led(): void { + const Gpio = pigpio.Gpio; + let iv: NodeJS.Timer; + let led = new Gpio(17, { mode: Gpio.OUTPUT }); + + iv = setInterval(function timer() { + led.trigger(100, 1); + }, 2); + + setTimeout(function timer() { + led.digitalWrite(0); + clearInterval(iv); + }, 2000); +})(); diff --git a/types/pigpio/tsconfig.json b/types/pigpio/tsconfig.json new file mode 100644 index 0000000000..0ca0aba095 --- /dev/null +++ b/types/pigpio/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", + "pigpio-tests.ts" + ] +} \ No newline at end of file diff --git a/types/pigpio/tslint.json b/types/pigpio/tslint.json new file mode 100644 index 0000000000..377cc837d4 --- /dev/null +++ b/types/pigpio/tslint.json @@ -0,0 +1 @@ +{ "extends": "../tslint.json" } From bdc9b82fcb18d23a4b019a642abcd6fd9157bba4 Mon Sep 17 00:00:00 2001 From: Jonas Thiel Date: Mon, 10 Apr 2017 16:11:52 +0200 Subject: [PATCH 296/844] =?UTF-8?q?Add=20type=20definition=20for=20?= =?UTF-8?q?=E2=80=9Ereact-native-drawer=E2=80=9C?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- types/react-native-drawer/index.d.ts | 180 ++++++++++++++++++ .../react-native-drawer-tests.tsx | 40 ++++ types/react-native-drawer/tsconfig.json | 24 +++ types/react-native-drawer/tslint.json | 1 + 4 files changed, 245 insertions(+) create mode 100644 types/react-native-drawer/index.d.ts create mode 100644 types/react-native-drawer/react-native-drawer-tests.tsx create mode 100644 types/react-native-drawer/tsconfig.json create mode 100644 types/react-native-drawer/tslint.json diff --git a/types/react-native-drawer/index.d.ts b/types/react-native-drawer/index.d.ts new file mode 100644 index 0000000000..3bba3ebce8 --- /dev/null +++ b/types/react-native-drawer/index.d.ts @@ -0,0 +1,180 @@ +// Type definitions for react-native-drawer 2.3 +// Project: https://github.com/root-two/react-native-drawer +// Definitions by: jnbt +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +import * as React from 'react'; +import { ViewStyle, ScaledSize } from 'react-native'; + +interface NestedViewStyles { + main?: ViewStyle; + drawerOverlay?: ViewStyle; + mainOverlay?: ViewStyle; +} + +interface DrawerStyles extends NestedViewStyles { + drawer?: ViewStyle; +} + +type TweenFunctions = 'linear' | + 'easeInQuad' | + 'easeOutQuad' | + 'easeInOutQuad' | + 'easeInCubic' | + 'easeOutCubic' | + 'easeInOutCubic' | + 'easeInQuart' | + 'easeOutQuart' | + 'easeInOutQuart' | + 'easeInQuint' | + 'easeOutQuint' | + 'easeInOutQuint' | + 'easeInSine' | + 'easeOutSine' | + 'easeInOutSine' | + 'easeInExpo' | + 'easeOutExpo' | + 'easeInOutExpo' | + 'easeInCirc' | + 'easeOutCirc' | + 'easeInOutCirc' | + 'easeInElastic' | + 'easeOutElastic' | + 'easeInOutElastic' | + 'easeInBack' | + 'easeOutBack' | + 'easeInOutBack' | + 'easeInBounce' | + 'easeOutBounce' | + 'easeInOutBounce'; + +export interface DrawerProperties { + // Important + + /** + * Menu component + */ + content?: React.ReactNode; + /** + * Type of drawer + */ + type?: 'displace' | 'overlay' | 'static'; + /** + * If true will trigger drawer open, if false will trigger close. + */ + open?: boolean; + /** + * Can either be a integer (pixel value) or decimal (ratio of screen width). Defines the right hand margin when + * the drawer is open. Or, can be function which returns offset + */ + openDrawerOffset?: ((viewport: ScaledSize) => number) | number; + /** + * Same as openDrawerOffset, except defines left hand margin when drawer is closed + */ + closedDrawerOffset?: (() => number) | number; + /** + * If true the drawer can not be opened and will not respond to pans + */ + disabled?: boolean; + /** + * Styles for the drawer, main, drawerOverlay and mainOverlay container Views + */ + styles?: DrawerStyles; + + // Animation / Tween + + /** + * Takes in the pan ratio (decimal 0 to 1) that represents the tween percent. Returns an object of + * native props to be set on the constituent views + */ + tweenHandler?(ratio: number): NestedViewStyles; + /** + * The duration of the open/close animation + */ + tweenDuration?: number; + /** + * A easing type supported by tween-functions + */ + tweenEasing?: TweenFunctions; + + // Event Handlers + + /** + * Will be called immediately after the drawer has entered the open state + */ + onOpen?(): void; + /** + * Callback fired at the start of an open animation + */ + onOpenStart?(): void; + /** + * Will be called immediately after the drawer has entered the closed state + */ + onClose?(): void; + /** + * Ccallback fired at the start of a close animation + */ + onCloseStart?(): void; + + // Gestures + + /** + * If true, will capture all gestures inside of the pan mask. If 'open' will + * only capture when drawer is open + */ + captureGestures?: boolean | 'open' | 'closed'; + /** + * Toggle drawer when double tap occurs within pan mask? + */ + acceptDoubleTap?: boolean; + /** + * Toggle drawer when any tap occurs within pan mask? + */ + acceptTap?: boolean; + /** + * Allow for drawer pan (on touch drag). Set to false to effectively + * disable the drawer while still allowing programmatic control + */ + acceptPan?: boolean; + /** + * Same as acceptTap, except only for close + */ + tapToClose?: boolean; + /** + * If true, attempts to handle only horizontal swipes, making it play well with a child ScrollView + */ + negotiatePan?: boolean; + + // Additional Configurations + + /** + * Ratio of screen width that must be travelled to trigger a drawer open/close + */ + panThreshold?: number; + /** + * Ratio of screen width that is valid for the start of a pan open action. If null -> defaults to max(.05, closedDrawerOffset) + */ + panOpenMask?: number; + /** + * Ratio of screen width that is valid for the start of a pan close action. If null -> defaults to max(.05, openDrawerOffset) + */ + panCloseMask?: number; + /** + * Initialize with drawer open + */ + initializeOpen?: number; + /** + * which side the drawer should be on. + */ + side?: 'left' | 'right'; + /** + * if true will run InteractionManager for open/close animations. + */ + useInteractionManager?: boolean; + /** + * (Android-only) Sets the elevation of the drawer using Android's underlying elevation API + */ + elevation?: number; +} + +export default class Drawer extends React.Component { } diff --git a/types/react-native-drawer/react-native-drawer-tests.tsx b/types/react-native-drawer/react-native-drawer-tests.tsx new file mode 100644 index 0000000000..dbc1d06b0e --- /dev/null +++ b/types/react-native-drawer/react-native-drawer-tests.tsx @@ -0,0 +1,40 @@ +import * as React from 'react'; +import { + ScaledSize, + StyleSheet, + View, + ViewStyle +} from 'react-native'; +import Drawer from 'react-native-drawer'; + +class DrawerTest extends React.Component<{}, {open: boolean}> { + constructor(props: {}) { + super(props); + this.state = { + open: true + }; + } + + render() { + return ( + } + onOpen={this.onOpen} + onClose={this.onClose} + closedDrawerOffset={100} + openDrawerOffset={(viewport: ScaledSize) => 50} + > + + ); + } + + private onOpen = () => { + this.setState({open: true}); + } + + private onClose = () => { + this.setState({open: false}); + } +} diff --git a/types/react-native-drawer/tsconfig.json b/types/react-native-drawer/tsconfig.json new file mode 100644 index 0000000000..ae7203c8c2 --- /dev/null +++ b/types/react-native-drawer/tsconfig.json @@ -0,0 +1,24 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6", + "dom" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "jsx": "react" + }, + "files": [ + "index.d.ts", + "react-native-drawer-tests.tsx" + ] +} diff --git a/types/react-native-drawer/tslint.json b/types/react-native-drawer/tslint.json new file mode 100644 index 0000000000..377cc837d4 --- /dev/null +++ b/types/react-native-drawer/tslint.json @@ -0,0 +1 @@ +{ "extends": "../tslint.json" } From bb9c2f1208c5454e4734294685c87ebd9012ca9e Mon Sep 17 00:00:00 2001 From: Andy Hanson Date: Mon, 10 Apr 2017 07:43:59 -0700 Subject: [PATCH 297/844] masonry-layout: Masonry class is directly exported --- types/masonry-layout/index.d.ts | 81 +++++++++----------- types/masonry-layout/masonry-layout-tests.ts | 41 +++++----- types/masonry-layout/tslint.json | 1 + 3 files changed, 59 insertions(+), 64 deletions(-) create mode 100644 types/masonry-layout/tslint.json diff --git a/types/masonry-layout/index.d.ts b/types/masonry-layout/index.d.ts index 4517606ce7..140dd7f257 100644 --- a/types/masonry-layout/index.d.ts +++ b/types/masonry-layout/index.d.ts @@ -1,50 +1,45 @@ // Type definitions for Masonry 4.0 // Project: https://github.com/desandro/masonry -// Definitions by: Mark Wilson +// Definitions by: Mark Wilson , Travis Brown // Definitions: https://github.com/borisyankov/DefinitelyTyped /// -// Modified from original definitions by: -// Travis Brown < https://github.com/warriorrocker> +export = Masonry; + +declare class Masonry { + constructor(options?: Masonry.Options); + constructor(selector: string, options?: Masonry.Options); + + masonry?(): void; + masonry?(eventName: string, listener: any): void; + + // layout + layout?(): void; + layoutItems?(items: any[], isStill?: boolean): void; + stamp?(elements: any[]): void; + unstamp?(elements: any[]): void; + + // add and remove items + appended?(elements: any[]): void; + prepended?(elements: any[]): void; + addItems?(elements: any[]): void; + remove?(elements: any[]): void; + + // events + on?(eventName: string, listener: any): void; + off?(eventName: string, listener: any): void; + once?(eventName: string, listener: any): void; + + // utilities + reloadItems?(): void; + destroy?(): void; + getItemElements?(): any[]; + data?(element: Element): Masonry; +} declare namespace Masonry { - - class Masonry implements MasonryGrid { - constructor(options?: MasonryOptions); - constructor(selector: string, options?: MasonryOptions); - } - - interface MasonryGrid { - masonry?(): void; - masonry?(eventName: string, listener: any): void; - - // layout - layout?(): void; - layoutItems?(items: any[], isStill?: boolean): void; - stamp?(elements: any[]): void; - unstamp?(elements: any[]): void; - - // add and remove items - appended?(elements: any[]): void; - prepended?(elements: any[]): void; - addItems?(elements: any[]): void; - remove?(elements: any[]): void; - - // events - on?(eventName: string, listener: any): void; - off?(eventName: string, listener: any): void; - once?(eventName: string, listener: any): void; - - // utilities - reloadItems?(): void; - destroy?(): void; - getItemElements?(): any[]; - data?(element: Element): Masonry; - } - - interface MasonryOptions { - + interface Options { // layout itemSelector?: string; columnWidth?: any; @@ -63,8 +58,8 @@ declare namespace Masonry { } } -export = Masonry; - -interface JQuery { - masonry(options?: Masonry.MasonryOptions): JQuery; +declare global { + interface JQuery { + masonry(options?: Masonry.Options): JQuery; + } } diff --git a/types/masonry-layout/masonry-layout-tests.ts b/types/masonry-layout/masonry-layout-tests.ts index 7a4f023fae..30378f356e 100644 --- a/types/masonry-layout/masonry-layout-tests.ts +++ b/types/masonry-layout/masonry-layout-tests.ts @@ -1,36 +1,35 @@ -// test file for masonry-layout.d.ts import * as $ from "jquery"; -import { Masonry } from "./index"; +import Masonry = require("masonry-layout"); // responsive layouts -// function testResponsiveLayouts() { -// $(document).ready(function () { -// $('.grid').masonry({ -// itemSelector: '.grid-item', -// columnWidth: '.grid-sizer', -// percentPosition: true -// }); -// }); -// }; +function testResponsiveLayouts() { + $(document).ready(() => { + $('.grid').masonry({ + itemSelector: '.grid-item', + columnWidth: '.grid-sizer', + percentPosition: true + }); + }); +} // recommended Options function testRecommendedOptions() { - // $(document).ready(function () { - // $('.grid').masonry({ - // columnWidth: 200, - // itemSelector: '.grid-item' - // }); - // }); + $(document).ready(() => { + $('.grid').masonry({ + columnWidth: 200, + itemSelector: '.grid-item' + }); + }); - var msnry = new Masonry('.grid', { + const msnry = new Masonry('.grid', { columnWidth: 200, itemSelector: '.grid-item' }); -}; +} // extended Options function testExtendedOptions() { - var msnry = new Masonry('.grid', { + const msnry = new Masonry('.grid', { itemSelector: '.grid-item', columnWidth: '.grid-sizer', percentPosition: true, @@ -46,4 +45,4 @@ function testExtendedOptions() { resize: true, initLayout: true }); -}; +} diff --git a/types/masonry-layout/tslint.json b/types/masonry-layout/tslint.json new file mode 100644 index 0000000000..2221e40e4a --- /dev/null +++ b/types/masonry-layout/tslint.json @@ -0,0 +1 @@ +{ "extends": "../tslint.json" } \ No newline at end of file From 55e0fe068ad4eab0963154f27b3e3eee473a1df8 Mon Sep 17 00:00:00 2001 From: Andy Date: Mon, 10 Apr 2017 09:02:34 -0700 Subject: [PATCH 298/844] maquette: Provides its own types (#15647) --- notNeededPackages.json | 6 + types/maquette/index.d.ts | 387 ------------------------------- types/maquette/maquette-tests.ts | 100 -------- types/maquette/tsconfig.json | 23 -- 4 files changed, 6 insertions(+), 510 deletions(-) delete mode 100644 types/maquette/index.d.ts delete mode 100644 types/maquette/maquette-tests.ts delete mode 100644 types/maquette/tsconfig.json diff --git a/notNeededPackages.json b/notNeededPackages.json index 8b83fb195e..0c3a536d70 100644 --- a/notNeededPackages.json +++ b/notNeededPackages.json @@ -192,6 +192,12 @@ "sourceRepoURL": "https://github.com/blakeembrey/lower-case-first", "asOfVersion": "1.0.1" }, + { + "libraryName": "maquette", + "typingsPackageName": "maquette", + "sourceRepoURL": "http://maquettejs.org/", + "asOfVersion": "2.1.6" + }, { "libraryName": "mobservable", "typingsPackageName": "mobservable", diff --git a/types/maquette/index.d.ts b/types/maquette/index.d.ts deleted file mode 100644 index 7f110f74a3..0000000000 --- a/types/maquette/index.d.ts +++ /dev/null @@ -1,387 +0,0 @@ -// Type definitions for maquette -// Project: http://maquettejs.org/ -// Definitions by: Johan Gorter -// Definitions: https://github.com/johan-gorter/DefinitelyTyped - - /** - * The main object in maquette is the maquette object. - * It is either bound to `window.maquette` or it can be obtained using {@link http://browserify.org/|browserify} or {@link http://requirejs.org/|requirejs}. - */ -declare namespace maquette { - - // Needed for typescript pre-1.5? - interface Touch { - clientX: number; - clientY: number; - identifier: number; - pageX: number; - pageY: number; - screenX: number; - screenY: number; - target: EventTarget; - } - interface TouchList { - length: number; - item(index: number): Touch; - [index: number]: Touch; - } - interface TouchEvent extends UIEvent { - altKey: boolean; - changedTouches: TouchList; - ctrlKey: boolean; - metaKey: boolean; - shiftKey: boolean; - targetTouches: TouchList; - touches: TouchList; - } - - - export interface VNodeProperties { - enterAnimation?: ((element: Element, properties?: VNodeProperties) => void) | string; - exitAnimation?: ((element: Element, removeElement: () => void, properties?: VNodeProperties) => void) | string; - updateAnimation?: (element: Element, properties?: VNodeProperties, previousProperties?: VNodeProperties) => void; - afterCreate?: (element: Element, projectionOptions: ProjectionOptions, vnodeSelector: string, properties: VNodeProperties, - children: VNode[]) => void; - afterUpdate?: (element: Element, projectionOptions: ProjectionOptions, vnodeSelector: string, properties: VNodeProperties, - children: VNode[]) => void; - key?: Object; - classes?: {[index:string]: boolean}; - styles?: {[index:string]: string}; - - // From Element - ontouchcancel?: (ev?: TouchEvent) => boolean|void; - ontouchend?: (ev?: TouchEvent) => boolean|void; - ontouchmove?: (ev?: TouchEvent) => boolean|void; - ontouchstart?: (ev?: TouchEvent) => boolean|void; - // From HTMLFormElement - action?: string; - encoding?: string; - enctype?: string; - method?: string; - name?: string; - target?: string; - // From HTMLElement - onblur?: (ev?: FocusEvent) => boolean|void; - onchange?: (ev?: Event) => boolean|void; - onclick?: (ev?: MouseEvent) => boolean|void; - ondblclick?: (ev?: MouseEvent) => boolean|void; - onfocus?: (ev?: FocusEvent) => boolean|void; - oninput?: (ev?: Event) => boolean|void; - onkeydown?: (ev?: KeyboardEvent) => boolean|void; - onkeypress?: (ev?: KeyboardEvent) => boolean|void; - onkeyup?: (ev?: KeyboardEvent) => boolean|void; - onload?: (ev?: Event) => boolean|void; - onmousedown?: (ev?: MouseEvent) => boolean|void; - onmouseenter?: (ev?: MouseEvent) => boolean|void; - onmouseleave?: (ev?: MouseEvent) => boolean|void; - onmousemove?: (ev?: MouseEvent) => boolean|void; - onmouseout?: (ev?: MouseEvent) => boolean|void; - onmouseover?: (ev?: MouseEvent) => boolean|void; - onmouseup?: (ev?: MouseEvent) => boolean|void; - onmousewheel?: (ev?: MouseWheelEvent) => boolean|void; - onscroll?: (ev?: UIEvent) => boolean|void; - onsubmit?: (ev?: Event) => boolean|void; - spellcheck?: boolean; - tabIndex?: number; - title?: string; - accessKey?: string; - id?: string; - // From HTMLInputElement - autocomplete?: string; - checked?: boolean; - placeholder?: string; - readOnly?: boolean; - src?: string; - value?: string; - // From HTMLImageElement - alt?: string; - srcset?: string; - - // Everything else (uncommon or custom properties and attributes) - [index: string]: Object; - } - - export interface ProjectionOptions { - transitions?: { - enter: (element: Element, properties: VNodeProperties, enterAnimation: string) => void; - exit: (element: Element, properties: VNodeProperties, exitAnimation: string, removeElement: () => void) => void; - } - } - - // The following line is not possible in Typescript, hence the workaround in the two lines below - // export type VNodeChild = string|VNode|Array - export interface VNodeChildren extends Array {} // A bit of a hack to create a recursive type - export type VNodeChild = string|VNode|VNodeChildren; - - export var dom: MaquetteDom; - - /** - * Creates a {@link CalculationCache} object, useful for caching {@link VNode} trees. - * In practice, caching of {@link VNode} trees is not needed, because achieving 60 frames per second is almost never a problem. - * @returns {CalculationCache} - */ - export function createCache(): CalculationCache; - - /** - * Creates a {@link Mapping} instance that keeps an array of result objects synchronized with an array of source objects. - * @param {function} getSourceKey - `function(source)` that must return a key to identify each source object. The result must eather be a string or a number. - * @param {function} createResult - `function(source, index)` that must create a new result object from a given source. This function is identical argument of `Array.map`. - * @param {function} updateResult - `function(source, target, index)` that updates a result to an updated source. - * @returns {Mapping} - */ - export function createMapping( - getSourceKey: (source: Source) => (string|number), - createResult: (source: Source, index:number) => Target, - updateResult: (source: Source, target: Target, index: number) => void): Mapping; - - /** - * Creates a {@link Projector} instance using the provided projectionOptions. - * @param {Object} projectionOptions - Options that influence how the DOM is rendered and updated. - * projectionOptions.transitions - A transition strategy to invoke when - * enterAnimation and exitAnimation properties are provided as strings. - * The module `cssTransitions` in the provided `css-transitions.js` file provides such a strategy. - * A transition strategy is not needed when enterAnimation and exitAnimation properties are provided as functions. - * @returns {Projector} - */ - export function createProjector(projectionOptions? : ProjectionOptions) : Projector; - - /** - * Creates a virtual DOM node, used to render a real DOM later. - * The `h` stands for (virtual) hyperscript. - * - * @param {string} selector - Contains the tagName, id and fixed css classnames in CSS selector format. It is formatted as follows: `tagname.cssclass1.cssclass2#id`. - * @param {Object} properties - An object literal containing attributes, properties, event handlers and more be placed on the DOM node. - * @param {Array} children - An array of virtual DOM nodes and strings to add as child nodes. May contain nested arrays, null or undefined. - * - * @returns {VNode} A VNode object, used to render a real DOM later. - */ - export function h(selector: string, properties: VNodeProperties, children: Array): VNode; - /** - * Creates a virtual DOM node, used to render a real DOM later. - * The `h` stands for (virtual) hyperscript. - * - * @param {string} selector - Contains the tagName, id and fixed css classnames in CSS selector format. It is formatted as follows: `tagname.cssclass1.cssclass2#id`. - * @param {Array} children - An array of virtual DOM nodes and strings to add as child nodes. May contain nested arrays, null or undefined. - * - * @returns {VNode} A VNode object, used to render a real DOM later. - */ - export function h(selector: string, children: Array): VNode; - /** - * Creates a virtual DOM node, used to render a real DOM later. - * The `h` stands for (virtual) hyperscript. - * - * @param {string} selector - Contains the tagName, id and fixed css classnames in CSS selector format. It is formatted as follows: `tagname.cssclass1.cssclass2#id`. - * @param {Object} properties - An object literal containing attributes, properties, event handlers and more be placed on the DOM node. - * - * @returns {VNode} A VNode object, used to render a real DOM later. - */ - export function h(selector: string, properties: VNodeProperties): VNode; - /** - * Creates a virtual DOM node, used to render a real DOM later. - * The `h` stands for (virtual) hyperscript. - * - * @param {string} selector - Contains the tagName, id and fixed css classnames in CSS selector format. It is formatted as follows: `tagname.cssclass1.cssclass2#id`. - * - * @returns {VNode} A VNode object, used to render a real DOM later. - */ - export function h(selector: string): VNode; - - /** - * A virtual representation of a DOM Node. Maquette assumes that {@link VNode} objects are never modified externally. - * Instances of {@link VNode} can be created using {@link module:maquette.h}. - */ - export interface VNode { - vnodeSelector: string; - properties: VNodeProperties; - children: Array; - } - - // Not used anywhere in the maquette sourcecode, but it is a widely used pattern. - export interface Component { - renderMaquette() : VNode; - } - - /** - * A CalculationCache object remembers the previous outcome of a calculation along with the inputs. - * On subsequent calls the previous outcome is returned if the inputs are identical. - * This object can be used to bypass both rendering and diffing of a virtual DOM subtree. - * Instances of {@link CalculationCache} can be created using {@link module:maquette.createCache}. - */ - export interface CalculationCache { - /** - * Manually invalidates the cached outcome. - */ - invalidate(): void; - /** - * If the inputs array matches the inputs array from the previous invocation, this method returns the result of the previous invocation. - * Otherwise, the calculation function is invoked and its result is cached and returned. - * Objects in the inputs array are compared using ===. - * @param {Object[]} inputs - Array of objects that are to be compared using === with the inputs from the previous invocation. - * These objects are assumed to be immutable primitive values. - * @param {function} calculation - Function that takes zero arguments and returns an object (A {@link VNode} assumably) that can be cached. - */ - result(inputs: Array, calculation: () => Result):Result; - } - - /** - * Keeps an array of result objects synchronized with an array of source objects. - * Mapping provides a {@link Mapping#map} function that updates the {@link Mapping#results}. - * The {@link Mapping#map} function can be called multiple times and the results will get created, removed and updated accordingly. - * A {@link Mapping} can be used to keep an array of components (objects with a `renderMaquette` method) synchronized with an array of data. - * Instances of {@link Mapping} can be created using {@link module:maquette.createMapping}. - */ - export interface Mapping { - /** - * The array of results. These results will be synchronized with the latest array of sources that were provided using {@link Mapping#map}. - * @type {Object[]} - */ - results: Array; - /** - * Maps a new array of sources and updates {@link Mapping#results}. - * @param {Object[]} newSources - The new array of sources. - */ - map(newSources: Array): void; - } - - /** - * Contains simple low-level utility functions to manipulate the real DOM. The singleton instance is available under {@link module:maquette.dom}. - */ - export interface MaquetteDom { - /** - * Appends a new childnode to the DOM which is generated from a {@link VNode}. - * This is a low-level method. Users wil typically use a {@link Projector} instead. - * @param {Element} parentNode - The parent node for the new childNode. - * @param {VNode} vnode - The root of the virtual DOM tree that was created using the {@link module:maquette.h} function. NOTE: {@link VNode} objects may only be rendered once. - * @param {Object} projectionOptions - Options to be used to create and update the projection, see {@link module:maquette.createProjector}. - * @returns {Projection} The {@link Projection} that was created. - */ - append(parentNode: Element, vnode: VNode, projectionOptions?: ProjectionOptions): Projection; - /** - * Creates a real DOM tree from a {@link VNode}. The {@link Projection} object returned will contain the resulting DOM Node under the {@link Projection#domNode} property. - * This is a low-level method. Users wil typically use a {@link Projector} instead. - * @param {VNode} vnode - The root of the virtual DOM tree that was created using the {@link module:maquette.h} function. NOTE: {@link VNode} objects may only be rendered once. - * @param {Object} projectionOptions - Options to be used to create and update the projection, see {@link module:maquette.createProjector}. - * @returns {Projection} The {@link Projection} which contains the DOM Node that was created. - */ - create(vnode: VNode, projectionOptions?: ProjectionOptions): Projection; - /** - * Inserts a new DOM node which is generated from a {@link VNode}. - * This is a low-level method. Users wil typically use a {@link Projector} instead. - * @param {Element} beforeNode - The node that the DOM Node is inserted before. - * @param {VNode} vnode - The root of the virtual DOM tree that was created using the {@link module:maquette.h} function. NOTE: {@link VNode} objects may only be rendered once. - * @param {Object} projectionOptions - Options to be used to create and update the projection, see {@link module:maquette.createProjector}. - * @returns {Projection} The {@link Projection} that was created. - */ - insertBefore(beforeNode: Element, vnode: VNode): Projection; - /** - * Merges a new DOM node which is generated from a {@link VNode} with an existing DOM Node. - * This means that the virtual DOM and real DOM have one overlapping element. - * Therefore the selector for the root {VNode} will be ignored, but its properties and children will be applied to the Element provided - * This is a low-level method. Users wil typically use a {@link Projector} instead. - * @param {Element} domNode - The existing element to adopt as the root of the new virtual DOM. Existing attributes and childnodes are preserved. - * @param {VNode} vnode - The root of the virtual DOM tree that was created using the {@link module:maquette.h} function. NOTE: {@link VNode} objects may only be rendered once. - * @param {Object} projectionOptions - Options to be used to create and update the projection, see {@link module:maquette.createProjector}. - * @returns {Projection} The {@link Projection} that was created. - */ - merge(domNode: Element, vnode: VNode): Projection; - } - - /** - * Represents a {@link VNode} tree that has been rendered to a real DOM tree. - */ - export interface Projection { - /** - * Updates the projection with the new virtual DOM tree. - * @param {VNode} updatedVnode - The updated virtual DOM tree. Note: The selector for the root of the tree must remain constant. - */ - update(updatedVnode:VNode): void; - /** - * The DOM node that is used as the root of this {@link Projection}. - * @type {Element} - */ - domNode: Element; - } - - - /** - * Used to create and update the DOM. - * Use {@link Projector#append}, {@link Projector#merge}, {@link Projector#insertBefore} and {@link Projector#replace} - * to create the DOM. - * The `renderMaquetteFunction` callbacks will be called immediately to create the DOM. Afterwards, these functions - * will be called again to update the DOM on the next animation-frame after: - * - * - The {@link Projector#scheduleRender} function was called - * - An event handler (like `onclick`) on a rendered {@link VNode} was called. - * - * The projector stops when {@link Projector#stop} is called or when an error is thrown during rendering. - * It is possible to use `window.onerror` to handle these errors. - * Instances of {@link Projector} can be created using {@link module:maquette.createProjector}. - */ - export interface Projector { - /** - * Appends a new childnode to the DOM using the result from the provided `renderMaquetteFunction`. - * The `renderMaquetteFunction` will be invoked again to update the DOM when needed. - * @param {Element} parentNode - The parent node for the new childNode. - * @param {function} renderMaquetteFunction - Function with zero arguments that returns a {@link VNode} tree. - */ - append(parentNode: Element, renderMaquetteFunction: () => VNode): void; - /** - * Stops running the `renderMaquetteFunction` to update the DOM. The `renderMaquetteFunction` must have been - * registered using [[append]], [[merge]], [[insertBefore]] or [[replace]]. - * - * @returns The [[Projection]] which was created using this `renderMaquetteFunction`. - * The [[Projection]] contains a reference to the DOM Node that was rendered. - */ - detach(renderMaquetteFunction: () => VNode): Projection; - /** - * Scans the document for `