diff --git a/node-jose/index.d.ts b/node-jose/index.d.ts new file mode 100644 index 0000000000..93ae198493 --- /dev/null +++ b/node-jose/index.d.ts @@ -0,0 +1,1380 @@ +// 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 +// 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. +// 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/types/xml-js/tsconfig.json b/node-jose/tsconfig.json similarity index 93% rename from types/xml-js/tsconfig.json rename to node-jose/tsconfig.json index 09b2ed9cff..0de8c3967e 100644 --- a/types/xml-js/tsconfig.json +++ b/node-jose/tsconfig.json @@ -17,6 +17,6 @@ }, "files": [ "index.d.ts", - "xml-js-tests.ts" + "node-jose-tests.ts" ] -} \ No newline at end of file +} diff --git a/notNeededPackages.json b/notNeededPackages.json index 90a63f066e..182d9133b8 100644 --- a/notNeededPackages.json +++ b/notNeededPackages.json @@ -24,6 +24,12 @@ "sourceRepoURL": "https://github.com/mzabriskie/axios", "asOfVersion": "0.14.0" }, + { + "libraryName": "Bugsnag Browser", + "typingsPackageName": "bugsnag-js", + "sourceRepoURL": "https://github.com/bugsnag/bugsnag-js", + "asOfVersion": "3.1.0" + }, { "libraryName": "camel-case", "typingsPackageName": "camel-case", @@ -36,6 +42,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", @@ -72,6 +84,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", @@ -84,6 +102,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 +181,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", @@ -174,6 +198,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", @@ -336,6 +366,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", @@ -378,6 +414,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/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", 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/acorn/index.d.ts b/types/acorn/index.d.ts index 441deb29c3..ce7da6d368 100644 --- a/types/acorn/index.d.ts +++ b/types/acorn/index.d.ts @@ -63,7 +63,7 @@ declare namespace acorn { class SourceLocation implements ESTree.SourceLocation { start: Position; end: Position; - source?: string; + source?: string | null; constructor(p: Parser, start: Position, end: Position); } diff --git a/types/aws-lambda/aws-lambda-tests.ts b/types/aws-lambda/aws-lambda-tests.ts index 3aede36d4c..e793442177 100644 --- a/types/aws-lambda/aws-lambda-tests.ts +++ b/types/aws-lambda/aws-lambda-tests.ts @@ -5,12 +5,17 @@ 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; 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; @@ -87,6 +92,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; @@ -119,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, 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; @@ -170,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); @@ -183,3 +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.CustomAuthorizerCallback) => { }; diff --git a/types/aws-lambda/index.d.ts b/types/aws-lambda/index.d.ts index c5e49d54c6..a5fa271699 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; @@ -180,6 +187,43 @@ 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 | [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 { + [name: string]: string | number | boolean; +} + /** * AWS Lambda handler function. * http://docs.aws.amazon.com/lambda/latest/dg/nodejs-prog-model-handler.html @@ -190,6 +234,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?: CustomAuthorizerCallback) => void; /** * Optional callback parameter. @@ -200,5 +245,6 @@ export type ProxyHandler = (event: APIGatewayEvent, context: Context, callback?: */ 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; diff --git a/types/boom/boom-tests.ts b/types/boom/boom-tests.ts index 8b5c3bdce6..382eb24bbd 100644 --- a/types/boom/boom-tests.ts +++ b/types/boom/boom-tests.ts @@ -1,8 +1,41 @@ - import Boom = require('boom'); +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.wrap(new Error('test'), 400); -Boom.badRequest('Invalid cookies'); + +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 index e8cfb5722f..863e2deafc 100644 --- a/types/boom/index.d.ts +++ b/types/boom/index.d.ts @@ -1,6 +1,6 @@ -// Type definitions for boom +// Type definitions for boom 4.3 // Project: http://github.com/hapijs/boom -// Definitions by: Igor Rogatty +// Definitions by: Igor Rogatty , AJP // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped /// @@ -9,53 +9,294 @@ export = Boom; declare namespace Boom { - export interface BoomError { - data: any; - reformat: () => void; + /** + * 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; - name: string; + /** 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: any; - payload: 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. */ + 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; - export function unauthorized(message?: string, scheme?: any, attributes?: 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; - export function methodNotAllowed(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/v3/boom-tests.ts b/types/boom/v3/boom-tests.ts new file mode 100644 index 0000000000..8b5c3bdce6 --- /dev/null +++ b/types/boom/v3/boom-tests.ts @@ -0,0 +1,8 @@ + + +import Boom = require('boom'); + +Boom.create(500, 'Internal server error', { timestamp: Date.now() }); +Boom.wrap(new Error('test'), 400); +Boom.badRequest('Invalid cookies'); +Boom.unauthorized() as Error; diff --git a/types/boom/v3/index.d.ts b/types/boom/v3/index.d.ts new file mode 100644 index 0000000000..2c0a3ce21d --- /dev/null +++ b/types/boom/v3/index.d.ts @@ -0,0 +1,61 @@ +// Type definitions for boom 3.2 +// Project: http://github.com/hapijs/boom +// Definitions by: Igor Rogatty +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +/// + +export = Boom; + +declare namespace Boom { + + export interface BoomError { + data: any; + reformat: () => void; + isBoom: boolean; + isServer: boolean; + message: string; + output: Output; + name: string; + } + + export interface Output { + statusCode: number; + headers: any; + payload: any; + } + + export function wrap(error: Error, statusCode?: number, message?: string): BoomError; + export function create(statusCode: number, message?: string, data?: any): BoomError; + + // 4xx + export function badRequest(message?: string, data?: any): BoomError; + export function unauthorized(message?: string, scheme?: any, attributes?: any): BoomError; + export function forbidden(message?: string, data?: any): BoomError; + export function notFound(message?: string, data?: any): BoomError; + export function methodNotAllowed(message?: string, data?: any): BoomError; + export function notAcceptable(message?: string, data?: any): BoomError; + export function proxyAuthRequired(message?: string, data?: any): BoomError; + export function clientTimeout(message?: string, data?: any): BoomError; + export function conflict(message?: string, data?: any): BoomError; + export function resourceGone(message?: string, data?: any): BoomError; + export function lengthRequired(message?: string, data?: any): BoomError; + export function preconditionFailed(message?: string, data?: any): BoomError; + export function entityTooLarge(message?: string, data?: any): BoomError; + export function uriTooLong(message?: string, data?: any): BoomError; + export function unsupportedMediaType(message?: string, data?: any): BoomError; + export function rangeNotSatisfiable(message?: string, data?: any): BoomError; + export function expectationFailed(message?: string, data?: any): BoomError; + export function badData(message?: string, data?: any): BoomError; + export function locked(message?: string, data?: any): BoomError; + export function preconditionRequired(message?: string, data?: any): BoomError; + export function tooManyRequests(message?: string, data?: any): BoomError; + export function illegal(message?: string, data?: any): BoomError; + + // 5xx + export function badImplementation(message?: string, data?: any): BoomError; + export function notImplemented(message?: string, data?: any): BoomError; + export function badGateway(message?: string, data?: any): BoomError; + export function serverUnavailable(message?: string, data?: any): BoomError; + export function gatewayTimeout(message?: string, data?: any): BoomError; +} diff --git a/types/fast-simplex-noise/tsconfig.json b/types/boom/v3/tsconfig.json similarity index 69% rename from types/fast-simplex-noise/tsconfig.json rename to types/boom/v3/tsconfig.json index 396315e587..689f5dec00 100644 --- a/types/fast-simplex-noise/tsconfig.json +++ b/types/boom/v3/tsconfig.json @@ -7,16 +7,21 @@ "noImplicitAny": true, "noImplicitThis": true, "strictNullChecks": false, - "baseUrl": "../", + "baseUrl": "../../", "typeRoots": [ - "../" + "../../" ], "types": [], + "paths": { + "boom": [ + "boom/v3" + ] + }, "noEmit": true, "forceConsistentCasingInFileNames": true }, "files": [ "index.d.ts", - "fast-simplex-noise-tests.ts" + "boom-tests.ts" ] } \ No newline at end of file diff --git a/types/bson/index.d.ts b/types/bson/index.d.ts index e34462b2b7..67df319bf6 100644 --- a/types/bson/index.d.ts +++ b/types/bson/index.d.ts @@ -1,6 +1,7 @@ -// 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 // 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,63 @@ 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 Decimal128 { + static fromString(s: string): Decimal128; + + constructor(bytes: Buffer); + + toJSON(): string; + toString(): string; } export class MaxKey { constructor(); @@ -61,17 +121,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 +178,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/bugsnag/bugsnag-tests.ts b/types/bugsnag/bugsnag-tests.ts deleted file mode 100644 index 033abe2a34..0000000000 --- a/types/bugsnag/bugsnag-tests.ts +++ /dev/null @@ -1,27 +0,0 @@ - - -Bugsnag.apiKey = "API-KEY"; - -Bugsnag.releaseStage = "beta"; -Bugsnag.appVersion = "2.4.56"; - -Bugsnag.user = { - name: "Robert K. User", - email: "robbie@example.com" -}; - -Bugsnag.metaData = { - account: { - name: "Acme Co", - plan: "hacker" - } -} - -Bugsnag.notifyException(new Error("Something broke")); - -Bugsnag.notify("Serious Problem", "We are out of cookies"); - -Bugsnag.notify("Serious Problem", - "We are out of cookies", - { remaining_snacks: ["carrots", "biscuits"] }, - "error"); diff --git a/types/bugsnag/index.d.ts b/types/bugsnag/index.d.ts deleted file mode 100644 index 1ba14de2ef..0000000000 --- a/types/bugsnag/index.d.ts +++ /dev/null @@ -1,90 +0,0 @@ -// Type definitions for Bugsnag v2.5.0 -// Project: https://github.com/bugsnag/bugsnag-js -// Definitions by: Delisa Mason -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -interface BugsnagUser { - id?: string, - name?: string, - email?: string -} - -interface BugsnagStatic { - /** Bugsnag project API key */ - apiKey: string; - /** The client application version */ - appVersion: string; - /** true if Bugsnag should be automatically notified of errors which are - * sent to `window.onerror` - */ - autoNotify: boolean; - /** Callback run before error reports are sent to Bugsnag. - * Payload and metadata information can be altered or removed altogether. - * To cancel sending the report, return false from this function. - */ - beforeNotify: (payload: any, metaData: any) => boolean; - /** The pathname of the current page, not including the fragment identifier - * nor search parameters - */ - context: string; - /** Disables console-based logging. Defaults to false. */ - disableLog: boolean; - /** The address used to send errors to Bugsnag. The default is - * `https://notify.bugsnag.com/js` - */ - endpoint: string; - /** Enables sending inline scripts on the page to Bugsnag to assist with - * debugging. Defaults to true - */ - inlineScript: boolean; - /** The maximum depth to parse the error stack */ - maxDepth: number; - /** Additional metadata to send to Bugsnag with every error. */ - metaData: any; - /** The method used for the notify request. The default is a temporary - * JavaScript image object, however Chrome apps/extensions and other - * applications where XHR is needed can use `xhr` instead. - */ - notifyHandler: string; - /** The releases stages during which Bugsnag will be notified of errors. */ - notifyReleaseStages: string[]; - /** The recorded root of the project. The default is the current host - * address (protocol and domain). - */ - projectRoot: string; - /** Current phase of the application release process. The default is - * `production` - */ - releaseStage: string; - /** Information about the current user which is sent to Bugsnag with - * exception reports - */ - user: BugsnagUser; - - /** Continue catching exceptions after the page error limit is reached. - * Useful for long-running single-page apps - */ - refresh(): void; - - /** Remove Bugsnag from the window object and restore the previous - * binding - */ - noConflict(): BugsnagStatic; - - /** Send caught exceptions to Bugsnag. Valid severity values are `info`, - * `warning`, and `error`, in order of increasing severity. - */ - notifyException(exception: Error, name?: string, metaData?: any, - severity?: string): void; - - /** Send custom errors to Bugsnag */ - notify(name: string, message: string, metaData?: any, - severity?: string): void; -} - -declare var Bugsnag: BugsnagStatic; - -declare module "Bugsnag" { - export = Bugsnag; -} - diff --git a/types/bugsnag/tsconfig.json b/types/bugsnag/tsconfig.json deleted file mode 100644 index 480f98a223..0000000000 --- a/types/bugsnag/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", - "bugsnag-tests.ts" - ] -} \ No newline at end of file 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..a040c43249 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 // @@ -21,10 +22,11 @@ declare namespace Chai { 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: string /* 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: string /* 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: string /* 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: string /* 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: string /* 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: string /* 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: string /* 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: string /* 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: string /* 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: string /* 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; 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/chrome/index.d.ts b/types/chrome/index.d.ts index 8c0c3bf5f2..8fe0f9b993 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> {} @@ -7100,12 +7106,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 {} @@ -7215,7 +7222,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 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; 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..0a715f52bf 100644 --- a/types/ej.web.all/index.d.ts +++ b/types/ej.web.all/index.d.ts @@ -7,7 +7,7 @@ /*! * 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 @@ -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,64692 +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; - - /** 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; - - /** 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; - - /** 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 {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. - * @returns {void} - */ - addTabGroupContent(tabIndex: number, groupIndex: number, subGroupIndex: number, content: any, contentIndex?: 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} sub group index in the ribbon group, - * @returns {void} - */ - removeTabGroupContent(tabIndex: number, groupText: string, 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 the Kanban is bound with data during initial rendering. */ - dataBound?(e: DataBoundEventArgs): void; + /** Triggered before the context menu is opened. */ + contextOpen?(e: ContextOpenEventArgs): void; - /** Triggered when Kanban going to destroy. */ - destroy?(e: DestroyEventArgs): void; + /** Triggered when context menu item is clicked in Kanban */ + contextClick?(e: ContextClickEventArgs): void; - /** Triggered after the card is deleted. */ - endDelete?(e: EndDeleteEventArgs): void; + /** Triggered the Kanban is bound with data during initial rendering. */ + dataBound?(e: DataBoundEventArgs): void; - /** Triggered after the card is edited. */ - endEdit?(e: EndEditEventArgs): void; + /** Triggered when Kanban going to destroy. */ + destroy?(e: DestroyEventArgs): void; - /** Triggers after the header is clicked. */ - headerClick?(e: HeaderClickEventArgs): void; + /** Triggered after the card is deleted. */ + endDelete?(e: EndDeleteEventArgs): void; - /** Triggered initial load. */ - load?(e: LoadEventArgs): void; + /** Triggered after the card is edited. */ + endEdit?(e: EndEditEventArgs): void; - /** Triggered when toolbar item is clicked in Kanban. */ - toolbarClick?(e: ToolbarClickEventArgs): void; + /** Triggers after the header is clicked. */ + headerClick?(e: HeaderClickEventArgs): void; - /** Triggered every time a single card rendered request is made to access particular card information. */ - queryCellInfo?(e: QueryCellInfoEventArgs): void; + /** Triggered initial load. */ + load?(e: LoadEventArgs): void; - /** Triggered before the context menu is opened. */ - contextOpen?(e: ContextOpenEventArgs): void; -} + /** Triggered every time a single card rendered request is made to access particular card information. */ + queryCellInfo?(e: QueryCellInfoEventArgs): void; -export interface ActionBeginEventArgs { + /** Triggered when toolbar item is clicked in Kanban. */ + toolbarClick?(e: ToolbarClickEventArgs): void; + } - /** Returns the Kanban model. - */ - model?: any; + export interface ActionBeginEventArgs { - /** Returns the name of the event. - */ - type?: string; + /** Returns the Kanban model. + */ + model?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the name of the event. + */ + type?: string; - /** Returns the current action event type. - */ - originalEventType?: string; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns primary key value. - */ - primaryKeyValue?: string; + /** Returns the current action event type. + */ + originalEventType?: string; - /** Returns request type. - */ - requestType?: string; + /** Returns primary key value. + */ + primaryKeyValue?: string; - /** Returns the edited row index. - */ - rowIndex?: number; + /** Returns request type. + */ + requestType?: string; - /** Returns the card object (JSON). - */ - data?: any; + /** Returns the edited row index. + */ + rowIndex?: number; - /** Returns current filtering object field name. - */ - currentFilteringobject?: any; + /** Returns the card object (JSON). + */ + data?: any; - /** Returns filter details. - */ - filterCollection?: any; -} + /** Returns current filtering object field name. + */ + currentFilteringobject?: any; -export interface ActionCompleteEventArgs { + /** Returns filter details. + */ + filterCollection?: any; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface ActionCompleteEventArgs { - /** Returns the Kanban model. - */ - model?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns request type. - */ - requestType?: string; + /** Returns the Kanban model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns request type. + */ + requestType?: string; - /** Returns current action event type. - */ - originalEventType?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns primary key. - */ - primaryKey?: string; + /** Returns current action event type. + */ + originalEventType?: string; - /** Returns primary key value. - */ - primaryKeyValue?: string; + /** Returns primary key. + */ + primaryKey?: string; - /** Returns Kanban element. - */ - target?: any; + /** Returns primary key value. + */ + primaryKeyValue?: string; - /** Returns the card object (JSON). - */ - data?: any; + /** Returns Kanban element. + */ + target?: any; - /** Returns the selectedRow index. - */ - selectedRow?: number; + /** Returns the card object (JSON). + */ + data?: any; - /** Returns current filtering column field name. - */ - currentFilteringColumn?: string; + /** Returns the selectedRow index. + */ + selectedRow?: number; - /** Returns filter details. - */ - filterCollection?: any; -} + /** Returns current filtering column field name. + */ + currentFilteringColumn?: string; -export interface ActionFailureEventArgs { + /** Returns filter details. + */ + filterCollection?: any; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface ActionFailureEventArgs { - /** Returns the Kanban model. - */ - model?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns request type. - */ - requestType?: string; + /** Returns the Kanban model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns request type. + */ + requestType?: string; - /** Returns the error return by server. - */ - error?: any; + /** Returns the name of the event. + */ + type?: string; - /** Returns current action event type. - */ - originalEventType?: string; + /** Returns the error return by server. + */ + error?: any; - /** Returns primary key value. - */ - primaryKeyValue?: string; + /** Returns current action event type. + */ + originalEventType?: string; - /** Returns Kanban element. - */ - target?: any; + /** Returns primary key value. + */ + primaryKeyValue?: string; - /** Returns the card object (JSON). - */ - data?: any; + /** Returns Kanban element. + */ + target?: any; - /** Returns current filtering column field name. - */ - currentFilteringColumn?: string; + /** Returns the card object (JSON). + */ + data?: any; - /** Returns filter details. - */ - filterCollection?: any; -} + /** Returns current filtering column field name. + */ + currentFilteringColumn?: string; -export interface BeginEditEventArgs { + /** Returns filter details. + */ + filterCollection?: any; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface BeginEditEventArgs { - /** Returns the Kanban model. - */ - model?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns primary key value. - */ - primaryKeyValue?: string; + /** Returns the Kanban model. + */ + model?: any; - /** Returns begin edit data. - */ - data?: any; + /** Returns primary key value. + */ + primaryKeyValue?: string; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns begin edit data. + */ + data?: any; -export interface BeginAddEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the Kanban model. - */ - model?: any; + export interface BeginAddEventArgs { - /** Returns primary key value. - */ - primaryKeyValue?: string; + /** Returns the Kanban model. + */ + model?: any; - /** Returns beginAdd data. - */ - data?: any; + /** Returns primary key value. + */ + primaryKeyValue?: string; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns beginAdd data. + */ + data?: any; -export interface BeforeCardSelectEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface BeforeCardSelectEventArgs { - /** Returns the select cell index value. - */ - cellIndex?: number; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the select card index value. - */ - cardIndex?: number; + /** Returns the select cell index value. + */ + cellIndex?: number; - /** Returns the select cell element - */ - currentCell?: any; + /** Returns the select card index value. + */ + cardIndex?: number; - /** Returns the previously select the card element - */ - previousCard?: any; + /** Returns the select cell element + */ + currentCell?: any; - /** Returns the previously select card indexes - */ - previousRowcellindex?: any[]; + /** Returns the previously select the card element + */ + previousCard?: any; - /** Returns the Target item. - */ - Target?: any; + /** Returns the previously select card indexes + */ + previousRowcellindex?: any[]; - /** Returns the Kanban model. - */ - model?: any; + /** Returns the Target item. + */ + Target?: any; - /** Returns select card data. - */ - data?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns select card data. + */ + data?: any; -export interface CardClickEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface CardClickEventArgs { - /** Returns current record object (JSON). - */ - data?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the current card to the Kanban. - */ - currentCard?: string; + /** Returns current record object (JSON). + */ + data?: any; - /** Returns Kanban element. - */ - target?: any; + /** Returns the current card to the Kanban. + */ + currentCard?: string; - /** Returns the Kanban model. - */ - model?: any; + /** Returns Kanban element. + */ + target?: any; - /** Returns the Header text of the column corresponding to the selected card. - */ - columnName?: string; + /** Returns the Kanban model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the Header text of the column corresponding to the selected card. + */ + columnName?: string; -export interface CardDragEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface CardDragEventArgs { - /** Returns drag data. - */ - data?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns drag start element. - */ - dragtarget?: any; + /** Returns drag data. + */ + data?: any; - /** Returns dragged element. - */ - draggedElement?: any; + /** Returns drag start element. + */ + dragtarget?: any; - /** Returns the Kanban model. - */ - model?: any; + /** Returns dragged element. + */ + draggedElement?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the Kanban model. + */ + model?: any; -export interface CardDragStartEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface CardDragStartEventArgs { - /** Returns card drag start data. - */ - data?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns dragged element. - */ - draggedElement?: any; + /** Returns card drag start data. + */ + data?: any; - /** Returns the Kanban model. - */ - model?: any; + /** Returns dragged element. + */ + draggedElement?: any; - /** Returns drag start element. - */ - dragtarget?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns drag start element. + */ + dragtarget?: any; -export interface CardDragStopEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface CardDragStopEventArgs { - /** Returns dragged element. - */ - draggedElement?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Kanban model. - */ - model?: any; + /** Returns dragged element. + */ + draggedElement?: any; - /** Returns drag stop element. - */ - droptarget?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns drag stop data. - */ - data?: any; + /** Returns drag stop element. + */ + droptarget?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns drag stop data. + */ + data?: any; -export interface CardDropEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface CardDropEventArgs { - /** Returns dragged element. - */ - draggedElement?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns previous parent of dragged element - */ - draggedParent?: any; + /** Returns dragged element. + */ + draggedElement?: any; - /** Returns dragged data. - */ - data?: any; + /** Returns previous parent of dragged element + */ + draggedParent?: any; - /** Returns the Kanban model. - */ - model?: any; + /** Returns dragged data. + */ + data?: any; - /** Returns drop element. - */ - target?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns drop element. + */ + target?: any; -export interface CardSelectEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the select cell index value. - */ - cellIndex?: number; + export interface CardSelectEventArgs { - /** Returns the select card index value. - */ - cardIndex?: number; + /** Returns the select cell index value. + */ + cellIndex?: number; - /** Returns the select cell element - */ - currentCell?: any; + /** Returns the select card index value. + */ + cardIndex?: number; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the select cell element + */ + currentCell?: any; - /** Returns the previously select the card element - */ - previousCard?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the previously select card indexes - */ - previousRowcellindex?: any[]; + /** Returns the previously select the card element + */ + previousCard?: any; - /** Returns the current item. - */ - currentTarget?: any; + /** Returns the previously select card indexes + */ + previousRowcellindex?: any[]; - /** Returns the Kanban model. - */ - model?: any; + /** Returns the current item. + */ + currentTarget?: any; - /** Returns select card data. - */ - data?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns select card data. + */ + data?: any; -export interface CardDoubleClickEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface CardDoubleClickEventArgs { - /** Returns current card object (JSON). - */ - data?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Kanban model. - */ - model?: any; + /** Returns current card object (JSON). + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the Kanban model. + */ + model?: any; -export interface CardSelectingEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the selecting cell index value. - */ - cellIndex?: number; + export interface CardSelectingEventArgs { - /** Returns the selecting card index value. - */ - cardIndex?: number; + /** Returns the selecting cell index value. + */ + cellIndex?: number; - /** Returns the selecting cell element - */ - currentCell?: any; + /** Returns the selecting card index value. + */ + cardIndex?: number; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the selecting cell element + */ + currentCell?: any; - /** Returns the previously selecting the card element - */ - previousCard?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the previously rowcell is selecting card indexes - */ - previousRowcellindex?: any[]; + /** Returns the previously selecting the card element + */ + previousCard?: any; - /** Returns the current item. - */ - currentTarget?: any; + /** Returns the previously rowcell is selecting card indexes + */ + previousRowcellindex?: any[]; - /** Returns the Kanban model. - */ - model?: any; + /** Returns the current item. + */ + currentTarget?: any; - /** Returns added data. - */ - data?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns added data. + */ + data?: any; -export interface CreateEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface CreateEventArgs { - /** Returns the kanban model. - */ - model?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the kanban model. + */ + model?: any; -export interface CellClickEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface CellClickEventArgs { - /** Returns the kanban model. - */ - model?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the name of the event. - */ - type?: string; + /** Returns the kanban model. + */ + model?: any; - /** Returns the select cell index value. - */ - cellIndex?: number; + /** Returns the name of the event. + */ + type?: string; - /** Returns the edited row index. - */ - rowIndex?: number; -} + /** Returns the select cell index value. + */ + cellIndex?: number; -export interface DataBoundEventArgs { + /** Returns the edited row index. + */ + rowIndex?: number; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface ContextOpenEventArgs { - /** Returns the Kanban model. - */ - model?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the Kanban model. + */ + model?: any; -export interface DestroyEventArgs { + /** Returns the name of the event. + */ + type?: string; - /** Returns the kanban model. - */ - model?: any; + /** Returns the current item. + */ + currentTarget?: any; - /** Returns deleted data. - */ - data?: any; + /** Returns the status of contextmenu item which denotes its enabled state. + */ + status?: boolean; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the target item. + */ + target?: any; + } -export interface EndDeleteEventArgs { + export interface ContextClickEventArgs { - /** Returns the Kanban model. - */ - model?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns request type. - */ - requestType?: string; + /** Returns the Kanban model. + */ + model?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the name of the event. + */ + type?: string; - /** Returns deleted data. - */ - data?: any; + /** Returns the current item. + */ + currentTarget?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the status of contextmenu item which denotes its enabled state. + */ + status?: boolean; - /** Current action name - */ - action?: string; -} + /** Returns the target item. + */ + target?: any; + } -export interface EndEditEventArgs { + export interface DataBoundEventArgs { - /** Returns the Kanban model. - */ - model?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns request type. - */ - requestType?: string; + /** Returns the Kanban model. + */ + model?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns modified data. - */ - data?: any; + export interface DestroyEventArgs { - /** Returns the name of the event. - */ - type?: string; + /** Returns the kanban model. + */ + model?: any; - /** Current Action name - */ - action?: string; -} + /** Returns deleted data. + */ + data?: any; -export interface HeaderClickEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface EndDeleteEventArgs { - /** Returns the kanban model. - */ - model?: any; + /** Returns the Kanban model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns request type. + */ + requestType?: string; - /** Returns the select cell index value. - */ - cellIndex?: number; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the column object. - */ - columnData?: any; -} + /** Returns deleted data. + */ + data?: any; -export interface LoadEventArgs { + /** Returns the name of the event. + */ + type?: string; - /** Returns the kanban model. - */ - model?: any; + /** Current action name + */ + action?: string; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface EndEditEventArgs { - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the Kanban model. + */ + model?: any; -export interface ToolbarClickEventArgs { + /** Returns request type. + */ + requestType?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the current item. - */ - currentTarget?: any; + /** Returns modified data. + */ + data?: any; - /** Returns the item id of that current element. - */ - itemId?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the item index of that current element. - */ - itemIndex?: number; + /** Current Action name + */ + action?: string; + } - /** Returns the item name of that current element. - */ - itemName?: string; + export interface HeaderClickEventArgs { - /** Returns the item text of that current element. - */ - itemText?: string; + /** 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 toolbar object of the Kanban. - */ - toolbarData?: any; -} + /** Returns the select cell index value. + */ + cellIndex?: number; -export interface QueryCellInfoEventArgs { + /** Returns the column object. + */ + columnData?: any; + } - /** Returns Kanban card. - */ - card?: any; + export interface LoadEventArgs { - /** Returns Kanban card. - */ - cell?: any; + /** Returns the kanban model. + */ + model?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns current row record object (JSON). - */ - data?: any; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the column object. - */ - column?: any; + export interface QueryCellInfoEventArgs { - /** Returns the Kanban model. - */ - model?: any; - - /** Returns the name of the event. - */ - type?: string; -} - -export interface ContextOpenEventArgs { + /** Returns Kanban card. + */ + card?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; - - /** Returns the Kanban model. - */ - model?: any; + /** Returns Kanban card. + */ + cell?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** 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. - * @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 current row record object (JSON). + */ + data?: any; - /** To customize the searching string. - */ - key?: string; + /** Returns the column object. + */ + column?: any; - /** To customize the operator based on searching. - * @Default {contains} - */ - operator?: string; + /** Returns the Kanban model. + */ + model?: any; - /** To customize the ignore case based on searching. - * @Default {true} - */ - ignoreCase?: boolean; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface StackedHeaderRowsStackedHeaderColumn { + export interface ToolbarClickEventArgs { - /** Gets or sets a value that indicates the headerText for the particular stacked header column. - * @Default {null} - */ - headerText?: string; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Gets or sets a value that indicates the column for the particular stacked header column. - * @Default {null} - */ - column?: string; -} + /** Returns the current item. + */ + currentTarget?: any; + + /** Returns the item id of that current element. + */ + itemId?: string; -export interface StackedHeaderRow { + /** Returns the item index of that current element. + */ + itemIndex?: number; + + /** Returns the item name of that current element. + */ + itemName?: string; - /** Gets or sets a value that indicates whether to add stacked header columns into the stacked header rows. - * @Default {Array} - */ - stackedHeaderColumns?: StackedHeaderRowsStackedHeaderColumn[]; -} + /** Returns the item text of that current element. + */ + itemText?: string; -export interface TooltipSettings { + /** 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 enable or disable the tooltip display. - * @Default {false} - */ - enable?: boolean; + /** To customize the searching string. + */ + key?: string; - /** To customize the tooltip display based on your requirements. - * @Default {null} - */ - template?: string; -} + /** To customize the operator based on searching. + * @Default {contains} + */ + operator?: string; -export interface Workflow { + /** To customize the ignore case based on searching. + * @Default {true} + */ + ignoreCase?: boolean; + } - /** Gets or sets an object that indicates to render the Kanban with specified workflows key. - * @Default {null} - */ - key?: string|number; + export interface StackedHeaderRowsStackedHeaderColumn { - /** Gets or sets an object that indicates to render the Kanban with specified workflows allowed Transitions. - * @Default {null} - */ - allowedTransitions?: string; -} + /** Gets or sets a value that indicates the headerText for the particular stacked header column. + * @Default {null} + */ + headerText?: string; -enum Target { + /** Gets or sets a value that indicates the column for the particular stacked header column. + * @Default {null} + */ + column?: string; + } - ///Sets context menu to Kanban header - Header, + export interface StackedHeaderRow { - ///Sets context menu to Kanban content - Content, + /** Gets or sets a value that indicates whether to add stacked header columns into the stacked header rows. + * @Default {Array} + */ + stackedHeaderColumns?: StackedHeaderRowsStackedHeaderColumn[]; + } - ///Sets context menu to Kanban card - Card, + export interface TooltipSettings { - ///Sets context menu to Kanban - All -} + /** To enable or disable the tooltip display. + * @Default {false} + */ + enable?: boolean; + /** To customize the tooltip display based on your requirements. + * @Default {null} + */ + template?: string; + } -enum EditMode { + export interface Workflow { - ///Creates Kanban with editMode as Dialog - Dialog, + /** Gets or sets an object that indicates to render the Kanban with specified workflows key. + * @Default {null} + */ + key?: string | number; - ///Creates Kanban with editMode as DialogTemplate - DialogTemplate, + /** Gets or sets an object that indicates to render the Kanban with specified workflows allowed Transitions. + * @Default {null} + */ + allowedTransitions?: string; + } - ///Creates Kanban with editMode as ExternalForm - ExternalForm, + enum Target { - ///Creates Kanban with editMode as ExternalFormTemplate - ExternalFormTemplate -} + ///Sets context menu to Kanban header + Header, + ///Sets context menu to Kanban content + Content, -enum EditingType { + ///Sets context menu to Kanban card + Card, - ///Allows to set edit type as string edit type - String, + ///Sets context menu to Kanban + All + } - ///Allows to set edit type as numeric edit type - Numeric, - ///Allows to set edit type as drop down edit type - Dropdown, + enum EditMode { - ///Allows to set edit type as date picker edit type - DatePicker, + ///Creates Kanban with editMode as Dialog + Dialog, - ///Allows to set edit type as date time picker edit type - DateTimePicker, + ///Creates Kanban with editMode as DialogTemplate + DialogTemplate, - ///Allows to set edit type as text area edit type - TextArea, + ///Creates Kanban with editMode as ExternalForm + ExternalForm, - ///Allows to set edit type as RTE edit type - RTE -} + ///Creates Kanban with editMode as ExternalFormTemplate + ExternalFormTemplate + } -enum FormPosition { + enum EditingType { - ///Form position is bottom. - Bottom, + ///Allows to set edit type as string edit type + String, - ///Form position is right. - Right -} + ///Allows to set edit type as numeric edit type + Numeric, + ///Allows to set edit type as drop down edit type + Dropdown, -enum SelectionType { + ///Allows to set edit type as date picker edit type + DatePicker, - ///Support for Single selection in Kanban - Single, + ///Allows to set edit type as date time picker edit type + DateTimePicker, - ///Support for multiple selections in Kanban - Multiple -} + ///Allows to set edit type as text area edit type + TextArea, -} + ///Allows to set edit type as RTE edit type + RTE + } -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; + enum FormPosition { - /** Enables the Rotator control. - * @returns {void} - */ - enable(): void; + ///Form position is bottom. + Bottom, - /** This method is used to get the current slide index. - * @returns {number} - */ - getIndex(): number; + ///Form position is right. + Right + } - /** 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; + enum SelectionType { - /** This method is used to move slides continuously (or start autoplay) in the specified autoplay direction. - * @returns {void} - */ - play(): void; + ///Support for Single selection in Kanban + Single, - /** 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; + ///Support for multiple selections in Kanban + Multiple + } - /** 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; + class Rotator extends ej.Widget { + static fn: Rotator; + constructor(element: JQuery | Element, options?: Rotator.Model); + static Locale: any; + model: Rotator.Model; + defaults: Rotator.Model; - /** returns the rotator model - */ - model?: ej.Rotator.Model; + /** Disables the Rotator control. + * @returns {void} + */ + disable(): void; - /** returns the name of the event - */ - type?: string; + /** Enables the Rotator control. + * @returns {void} + */ + enable(): void; - /** the current rotator id. - */ - itemId?: string; + /** This method is used to get the current slide index. + * @returns {number} + */ + getIndex(): number; - /** returns the current slide index. - */ - activeItemIndex?: 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; -export interface CreateEventArgs { + /** This method is used to pause autoplay. + * @returns {void} + */ + pause(): void; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** This method is used to move slides continuously (or start autoplay) in the specified autoplay direction. + * @returns {void} + */ + play(): void; - /** returns the rotator model - */ - model?: ej.Rotator.Model; + /** 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; - /** returns the name of the event - */ - type?: string; -} + /** 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 { -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; -} + /** the current rotator id. + */ + itemId?: string; -export interface PagerClickEventArgs { + /** returns the current slide index. + */ + activeItemIndex?: number; + } - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + export interface CreateEventArgs { - /** returns the rotator model - */ - model?: ej.Rotator.Model; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the name of the event - */ - type?: string; + /** returns the rotator model + */ + model?: ej.Rotator.Model; - /** the current rotator id. - */ - itemId?: string; + /** returns the name of the event + */ + type?: string; + } - /** returns the current slide index. - */ - activeItemIndex?: number; -} + export interface DestroyEventArgs { -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; + export interface PagerClickEventArgs { - /** the current rotator id. - */ - itemId?: string; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the current slide index. - */ - activeItemIndex?: number; -} + /** returns the rotator model + */ + model?: ej.Rotator.Model; -export interface StopEventArgs { + /** returns the name of the event + */ + type?: string; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** the current rotator id. + */ + itemId?: string; - /** returns the rotator model - */ - model?: ej.Rotator.Model; + /** returns the current slide index. + */ + activeItemIndex?: number; + } - /** returns the name of the event - */ - type?: string; + export interface StartEventArgs { - /** the current rotator id. - */ - itemId?: string; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the current slide index. - */ - activeItemIndex?: number; -} + /** returns the rotator model + */ + model?: ej.Rotator.Model; -export interface ThumbItemClickEventArgs { + /** returns the name of the event + */ + type?: string; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** the current rotator id. + */ + itemId?: string; - /** returns the rotator model - */ - model?: ej.Rotator.Model; + /** returns the current slide index. + */ + activeItemIndex?: number; + } - /** returns the name of the event - */ - type?: string; + export interface StopEventArgs { - /** the current rotator id. - */ - itemId?: string; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the current slide index. - */ - activeItemIndex?: number; -} + /** returns the rotator model + */ + model?: ej.Rotator.Model; -export interface Fields { + /** returns the name of the event + */ + type?: string; - /** Specifies a link for the image. - */ - linkAttribute?: string; + /** the current rotator id. + */ + itemId?: string; - /** Specifies where to open a given link. - */ - targetAttribute?: string; + /** returns the current slide index. + */ + activeItemIndex?: number; + } - /** Specifies a caption for the image. - */ - text?: string; + export interface ThumbItemClickEventArgs { - /** Specifies a caption for the thumbnail image. - */ - thumbnailText?: string; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Specifies the URL for an thumbnail image. - */ - thumbnailUrl?: string; + /** returns the rotator model + */ + model?: ej.Rotator.Model; - /** 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; + /** returns the name of the event + */ + type?: string; - /** Fires before the RTE Edit area is rendered and after the toolbar is rendered. */ - preRender?(e: PreRenderEventArgs): void; + /** the current rotator id. + */ + itemId?: string; - /** Fires when the text is selected in the text area */ - select?(e: SelectEventArgs): void; -} + /** returns the current slide index. + */ + activeItemIndex?: number; + } -export interface ChangeEventArgs { + export interface Fields { - /** When the event is canceled; otherwise, false. - */ - cancel?: boolean; + /** Specifies a link for the image. + */ + linkAttribute?: string; - /** returns the RTE model - */ - model?: any; + /** Specifies where to open a given link. + */ + targetAttribute?: string; - /** returns the name of the event - */ - type?: string; -} + /** Specifies a caption for the image. + */ + text?: string; -export interface CreateEventArgs { + /** Specifies a caption for the thumbnail image. + */ + thumbnailText?: string; - /** When the event is canceled; otherwise, false. - */ - cancel?: boolean; + /** Specifies the URL for an thumbnail image. + */ + thumbnailUrl?: string; - /** Returns the RTE model - */ - model?: any; + /** 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; - /** Returns the name of the event - */ - type?: string; -} + /** Fires before the RTE Edit area is rendered and after the toolbar is rendered. */ + preRender?(e: PreRenderEventArgs): void; -export interface ContextMenuClickEventArgs { + /** Fires when the text is selected in the text area */ + select?(e: SelectEventArgs): void; + } - /** returns clicked menu item text. - */ - text?: string; + export interface ChangeEventArgs { - /** returns clicked menu item element. - */ - element?: any; + /** When the event is canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the selected item. - */ - selectedItem?: number; -} + /** returns the RTE model + */ + model?: any; -export interface DestroyEventArgs { + /** returns the name of the event + */ + type?: string; + } - /** When the event is canceled; otherwise, false. - */ - cancel?: boolean; + export interface CreateEventArgs { - /** Returns the RTE model - */ - model?: any; + /** When the event is canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the name of the event - */ - type?: string; -} + /** Returns the RTE model + */ + model?: any; -export interface ExecuteEventArgs { + /** Returns the name of the event + */ + type?: string; + } - /** When the event is canceled; otherwise, false. - */ - cancel?: boolean; + export interface ContextMenuClickEventArgs { - /** Returns the RTE model - */ - model?: any; + /** returns clicked menu item text. + */ + text?: string; - /** Returns the name of the event - */ - type?: string; -} + /** returns clicked menu item element. + */ + element?: any; -export interface KeydownEventArgs { + /** returns the selected item. + */ + selectedItem?: number; + } - /** When the event is canceled; otherwise, false. - */ - cancel?: boolean; + export interface DestroyEventArgs { - /** Returns the RTE model - */ - model?: any; + /** When the event is canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the name of the event - */ - type?: string; -} + /** Returns the RTE model + */ + model?: any; -export interface KeyupEventArgs { + /** Returns the name of the event + */ + type?: string; + } - /** When the event is canceled; otherwise, false. - */ - cancel?: boolean; + export interface ExecuteEventArgs { - /** Returns the RTE model - */ - model?: any; + /** When the event is canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the name of the event - */ - type?: string; -} + /** Returns the RTE model + */ + model?: any; -export interface PreRenderEventArgs { + /** Returns the name of the event + */ + type?: string; + } - /** When the event is canceled; otherwise, false. - */ - cancel?: boolean; + export interface KeydownEventArgs { - /** Returns the RTE model - */ - model?: any; + /** When the event is canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the name of the event - */ - type?: string; -} + /** Returns the RTE model + */ + model?: any; -export interface SelectEventArgs { + /** Returns the name of the event + */ + type?: string; + } - /** When the event is canceled; otherwise, false. - */ - cancel?: boolean; + export interface KeyupEventArgs { - /** Returns the RTE model - */ - model?: any; + /** When the event is canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the name of the event - */ - type?: string; + /** Returns the RTE model + */ + model?: any; - /** Returns the event object - */ - event?: any; -} + /** Returns the name of the event + */ + type?: string; + } -export interface ExportToPdfSettings { + export interface PreRenderEventArgs { - /** This API is used to receive the server-side handler for export related operations. - */ - url?: string; + /** When the event is canceled; otherwise, false. + */ + cancel?: boolean; - /** Specifies the file name for the exported pdf file. - */ - fileName?: string; -} + /** Returns the RTE model + */ + model?: any; -export interface ExportToWordSettings { + /** Returns the name of the event + */ + type?: string; + } - /** This API is used to receive the server-side handler for export related operations. - */ - url?: string; + export interface SelectEventArgs { - /** Specifies the file name for the exported word file. - */ - fileName?: string; -} + /** When the event is canceled; otherwise, false. + */ + cancel?: boolean; -export interface FileBrowser { + /** Returns the RTE model + */ + model?: any; - /** This API is used to receive the server-side handler for file related operations. - */ - ajaxAction?: string; + /** Returns the name of the event + */ + type?: string; - /** Specifies the file type extension shown in the file browser window. - */ - extensionAllow?: string; + /** Returns the event object + */ + event?: any; + } - /** 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 ExportToPdfSettings { -export interface ImageBrowser { + /** 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 the file related operations. - */ - ajaxAction?: string; + /** Specifies the file name for the exported pdf file. + */ + fileName?: string; + } - /** Specifies the file type extension shown in the image browser window. - */ - extensionAllow?: string; + export interface ExportToWordSettings { - /** 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; -} + /** This API is used to receive the server-side handler for export related operations. + */ + url?: string; -export interface ImportSettings { + /** Specifies the file name for the exported word file. + */ + fileName?: string; + } - /** This API is used to receive the server-side handler for import operations. - */ - url?: string; -} + export interface FileBrowser { -export interface ToolsCustomOrderedList { + /** This API is used to receive the server-side handler for file related operations. + */ + ajaxAction?: string; - /** Specifies the name for customOrderedList item. - */ - name?: string; + /** Specifies the file type extension shown in the file browser window. + */ + extensionAllow?: string; - /** Specifies the title for customOrderedList item. - */ - tooltip?: 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 styles for customOrderedList item. - */ - css?: string; + export interface ImageBrowser { - /** Specifies the text for customOrderedList item. - */ - text?: string; + /** This API is used to receive the server-side handler for the file related operations. + */ + ajaxAction?: string; - /** Specifies the list style for customOrderedList item. - */ - listStyle?: string; + /** Specifies the file type extension shown in the image browser window. + */ + extensionAllow?: string; - /** Specifies the image for customOrderedList item. - */ - listImage?: 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 ToolsCustomUnorderedList { + export interface ImportSettings { - /** Specifies the name for customUnorderedList item. - */ - name?: string; + /** This API is used to receive the server-side handler for import operations. + */ + url?: string; + } - /** Specifies the title for customUnorderedList item. - */ - tooltip?: string; + export interface ToolsCustomOrderedList { - /** Specifies the styles for customUnorderedList item. - */ - css?: string; + /** Specifies the name for customOrderedList item. + */ + name?: string; - /** Specifies the text for customUnorderedList item. - */ - text?: string; + /** Specifies the title for customOrderedList item. + */ + tooltip?: string; - /** Specifies the list style for customUnorderedList item. - */ - listStyle?: string; + /** Specifies the styles for customOrderedList item. + */ + css?: string; - /** Specifies the image for customUnorderedList item. - */ - listImage?: string; -} + /** Specifies the text for customOrderedList item. + */ + text?: string; -export interface Tools { + /** Specifies the list style for customOrderedList item. + */ + listStyle?: string; - /** Specifies the alignment tools and the display order of this tool in the RTE toolbar. - */ - alignment?: any; + /** Specifies the image for customOrderedList item. + */ + listImage?: string; + } - /** Specifies the casing tools and the display order of this tool in the RTE toolbar. - */ - casing?: any[]; + export interface ToolsCustomUnorderedList { - /** 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 name for customUnorderedList item. + */ + name?: string; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** Specifies the title for customUnorderedList item. + */ + tooltip?: string; - /** returns current handle number or index - */ - sliderIndex?: number; + /** Specifies the styles for customUnorderedList item. + */ + css?: string; - /** returns slider id. - */ - id?: string; - - /** returns the slider model. - */ - model?: ej.Slider.Model; + /** Specifies the text for customUnorderedList item. + */ + text?: string; - /** returns the name of the event. - */ - type?: string; + /** Specifies the list style for customUnorderedList item. + */ + listStyle?: string; - /** returns the slider value. - */ - value?: number; + /** Specifies the image for customUnorderedList item. + */ + listImage?: string; + } - /** returns true if event triggered by interaction else returns false. - */ - isInteraction?: boolean; -} + export interface Tools { -export interface CreateEventArgs { + /** Specifies the alignment tools and the display order of this tool in the RTE toolbar. + */ + alignment?: any; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** Specifies the casing tools and the display order of this tool in the RTE toolbar. + */ + casing?: any[]; - /** returns the slider model - */ - model?: ej.Slider.Model; + /** 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 { - /** returns the name of the event - */ - type?: string; -} + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; -export interface DestroyEventArgs { + /** returns current handle number or index + */ + sliderIndex?: number; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns slider id. + */ + id?: string; + + /** returns the slider model. + */ + model?: ej.Slider.Model; - /** 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 name of the event. + */ + type?: string; - /** Fires before menu of the split button control is opened. */ - beforeOpen?(e: BeforeOpenEventArgs): void; + /** returns the slider value. + */ + value?: number; - /** Fires when Button control is clicked successfully */ - click?(e: ClickEventArgs): void; + /** returns true if event triggered by interaction else returns false. + */ + isInteraction?: boolean; + } - /** Fires before the list content of Button control is closed */ - close?(e: CloseEventArgs): void; + export interface CreateEventArgs { - /** Fires after Split Button control is created. */ - create?(e: CreateEventArgs): void; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Fires when the Split Button is destroyed successfully */ - destroy?(e: DestroyEventArgs): void; + /** returns the slider model + */ + model?: ej.Slider.Model; - /** Fires when a menu item is Hovered out successfully */ - itemMouseOut?(e: ItemMouseOutEventArgs): void; + /** returns the name of the event + */ + type?: string; + } - /** Fires when a menu item is Hovered in successfully */ - itemMouseOver?(e: ItemMouseOverEventArgs): void; + export interface DestroyEventArgs { - /** Fires when a menu item is clicked successfully */ - itemSelected?(e: ItemSelectedEventArgs): void; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Fires before the list content of Button control is opened */ - open?(e: OpenEventArgs): void; -} + /** 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; -export interface BeforeOpenEventArgs { + /** Fires before menu of the split button control is opened. */ + beforeOpen?(e: BeforeOpenEventArgs): void; - /** returns the cancel option value - */ - cancel?: boolean; + /** Fires when Button control is clicked successfully */ + click?(e: ClickEventArgs): void; - /** returns the split button model - */ - model?: ej.SplitButton.Model; + /** Fires before the list content of Button control is closed */ + close?(e: CloseEventArgs): void; - /** returns the name of the event - */ - type?: string; -} + /** Fires after Split Button control is created. */ + create?(e: CreateEventArgs): void; -export interface ClickEventArgs { + /** Fires when the Split Button is destroyed successfully */ + destroy?(e: DestroyEventArgs): void; - /** returns the cancel option value - */ - cancel?: boolean; + /** Fires when a menu item is Hovered out successfully */ + itemMouseOut?(e: ItemMouseOutEventArgs): void; - /** returns the split button model - */ - model?: ej.SplitButton.Model; + /** Fires when a menu item is Hovered in successfully */ + itemMouseOver?(e: ItemMouseOverEventArgs): void; - /** returns the name of the event - */ - type?: string; + /** Fires when a menu item is clicked successfully */ + itemSelected?(e: ItemSelectedEventArgs): void; - /** returns the target of the current object. - */ - target?: any; + /** Fires before the list content of Button control is opened */ + open?(e: OpenEventArgs): void; + } - /** return the button state - */ - status?: boolean; -} + export interface BeforeOpenEventArgs { -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 ClickEventArgs { -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; -} + /** returns the target of the current object. + */ + target?: any; -export interface DestroyEventArgs { + /** return the button state + */ + status?: boolean; + } - /** returns the cancel option value - */ - cancel?: boolean; + export interface CloseEventArgs { - /** returns the split button model - */ - model?: ej.SplitButton.Model; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the name of the event - */ - type?: string; -} + /** returns the split button model + */ + model?: ej.SplitButton.Model; -export interface ItemMouseOutEventArgs { + /** returns the name of the event + */ + type?: string; + } - /** returns the cancel option value - */ - cancel?: boolean; + export interface CreateEventArgs { - /** returns the split button model - */ - model?: ej.SplitButton.Model; + /** returns the cancel option value + */ + cancel?: boolean; - /** 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 split button model + */ + model?: ej.SplitButton.Model; - /** Triggered before a tab item activated. */ - beforeActive?(e: BeforeActiveEventArgs): void; + /** returns the name of the event + */ + type?: string; + } - /** Triggered before a tab item remove. */ - beforeItemRemove?(e: BeforeItemRemoveEventArgs): void; - - /** Triggered before a tab item Create. */ - create?(e: CreateEventArgs): void; + export interface DestroyEventArgs { - /** Triggered before a tab item destroy. */ - destroy?(e: DestroyEventArgs): void; + /** returns the cancel option value + */ + cancel?: boolean; - /** Triggered after new tab item add */ - itemAdd?(e: ItemAddEventArgs): void; + /** returns the split button model + */ + model?: ej.SplitButton.Model; - /** Triggered after tab item removed. */ - itemRemove?(e: ItemRemoveEventArgs): void; -} + /** returns the name of the event + */ + type?: string; + } -export interface ItemActiveEventArgs { + export interface ItemMouseOutEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns the cancel option value + */ + cancel?: boolean; - /** returns the tab model. - */ - model?: ej.Tab.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 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 previous active tab header. - */ - prevActiveHeader?: HTMLElement; + /** Triggered before a tab item activated. */ + beforeActive?(e: BeforeActiveEventArgs): void; - /** returns previous active index. - */ - prevActiveIndex?: number; + /** Triggered before a tab item remove. */ + beforeItemRemove?(e: BeforeItemRemoveEventArgs): void; + + /** Triggered before a tab item Create. */ + create?(e: CreateEventArgs): void; - /** returns current active tab header . - */ - activeHeader?: HTMLElement; + /** Triggered before a tab item destroy. */ + destroy?(e: DestroyEventArgs): void; - /** returns current active index. - */ - activeIndex?: number; + /** Triggered after new tab item add */ + itemAdd?(e: ItemAddEventArgs): void; - /** returns, is it triggered by interaction or not. - */ - isInteraction?: boolean; -} + /** Triggered after tab item removed. */ + itemRemove?(e: ItemRemoveEventArgs): void; + } -export interface AjaxBeforeLoadEventArgs { + 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 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 AjaxBeforeLoadEventArgs { -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 previous active tab header. + */ + prevActiveHeader?: HTMLElement; - /** returns AJAX data details. - */ - data?: any; + /** returns previous active index. + */ + prevActiveIndex?: number; - /** returns the URL of AJAX request. - */ - URL?: string; -} + /** returns current active tab header . + */ + activeHeader?: HTMLElement; -export interface AjaxLoadEventArgs { + /** returns current active index. + */ + activeIndex?: number; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns the URL of AJAX request + */ + URL?: string; - /** returns the tab model. - */ - model?: ej.Tab.Model; + /** returns, is it triggered by interaction or not. + */ + isInteraction?: boolean; + } - /** returns the name of the event. - */ - type?: string; + export interface AjaxErrorEventArgs { - /** returns previous active tab header. - */ - prevActiveHeader?: HTMLElement; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns previous active index. - */ - prevActiveIndex?: number; + /** returns the tab model. + */ + model?: ej.Tab.Model; - /** returns current active tab header . - */ - activeHeader?: HTMLElement; + /** returns the name of the event. + */ + type?: string; - /** returns current active index. - */ - activeIndex?: number; + /** returns AJAX data details. + */ + data?: any; - /** 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; -} + export interface AjaxLoadEventArgs { -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; + /** returns previous active tab header. + */ + prevActiveHeader?: HTMLElement; - /** return AJAX data. - */ - data?: any; + /** returns previous active index. + */ + prevActiveIndex?: number; - /** returns AJAX URL - */ - URL?: string; + /** returns current active tab header . + */ + activeHeader?: HTMLElement; - /** returns content of AJAX request. - */ - content?: any; -} + /** returns current active index. + */ + activeIndex?: number; -export interface BeforeActiveEventArgs { + /** returns the URL of AJAX request + */ + URL?: string; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns, is it triggered by interaction or not. + */ + isInteraction?: boolean; + } - /** returns the tab model. - */ - model?: ej.Tab.Model; + export interface AjaxSuccessEventArgs { - /** returns the name of the event. - */ - type?: string; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns previous active tab header. - */ - prevActiveHeader?: HTMLElement; + /** returns the tab model. + */ + model?: ej.Tab.Model; - /** returns previous active index. - */ - prevActiveIndex?: number; + /** returns the name of the event. + */ + type?: string; - /** returns current active tab header . - */ - activeHeader?: HTMLElement; + /** return AJAX data. + */ + data?: any; - /** returns current active index. - */ - activeIndex?: number; + /** returns AJAX URL + */ + URL?: string; - /** returns, is it triggered by interaction or not. - */ - isInteraction?: boolean; -} + /** returns content of AJAX request. + */ + content?: any; + } -export interface BeforeItemRemoveEventArgs { + 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 current tab item index - */ - index?: number; -} + /** returns previous active tab header. + */ + prevActiveHeader?: HTMLElement; -export interface CreateEventArgs { + /** returns previous active index. + */ + prevActiveIndex?: number; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns current active tab header . + */ + activeHeader?: HTMLElement; - /** returns the tab model. - */ - model?: ej.Tab.Model; + /** returns current active index. + */ + activeIndex?: number; - /** returns the name of the event. - */ - type?: string; -} + /** returns, is it triggered by interaction or not. + */ + isInteraction?: boolean; + } -export interface DestroyEventArgs { + 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; -export interface ItemAddEventArgs { + /** returns current tab item index + */ + index?: number; + } - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + export interface CreateEventArgs { - /** returns the tab model. - */ - model?: ej.Tab.Model; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the name of the event. - */ - type?: string; + /** returns the tab model. + */ + model?: ej.Tab.Model; - /** returns new added tab header. - */ - tabHeader?: HTMLElement; + /** returns the name of the event. + */ + type?: string; + } - /** returns new added tab content panel. - */ - tabContent?: any; -} + export interface DestroyEventArgs { -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; + export interface ItemAddEventArgs { - /** returns removed tab header. - */ - removedTab?: HTMLElement; -} + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; -export interface AjaxSettings { + /** returns the tab model. + */ + model?: ej.Tab.Model; - /** It specifies, whether to enable or disable asynchronous request. - * @Default {true} - */ - async?: boolean; + /** returns the name of the event. + */ + type?: string; - /** It specifies the page will be cached in the web browser. - * @Default {false} - */ - cache?: boolean; + /** returns new added tab header. + */ + tabHeader?: HTMLElement; - /** It specifies the type of data is send in the query string. - * @Default {html} - */ - contentType?: string; + /** returns new added tab content panel. + */ + tabContent?: any; + } - /** It specifies the data as an object, will be passed in the query string. - * @Default {{}} - */ - data?: any; + export interface ItemRemoveEventArgs { - /** It specifies the type of data that you're expecting back from the response. - * @Default {html} - */ - dataType?: string; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** 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; + /** returns the tab model. + */ + model?: ej.Tab.Model; - /** Specifies the list of HTML attributes to be added to TagCloud control. - * @Default {{}} - */ - htmlAttributes?: any; + /** returns the name of the event. + */ + type?: string; - /** Defines the format for the TagCloud to display the tag items.See Format - * @Default {ej.Format.Cloud} - */ - format?: string|ej.Format; + /** returns removed tab header. + */ + removedTab?: HTMLElement; + } - /** 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; + export interface AjaxSettings { - /** 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; + /** It specifies, whether to enable or disable asynchronous request. + * @Default {true} + */ + async?: boolean; - /** 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; + /** It specifies the page will be cached in the web browser. + * @Default {false} + */ + cache?: boolean; - /** 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; + /** It specifies the type of data is send in the query string. + * @Default {html} + */ + contentType?: string; - /** 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; + /** It specifies the data as an object, will be passed in the query string. + * @Default {{}} + */ + data?: any; - /** Fires when the TimePicker is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; + /** It specifies the type of data that you're expecting back from the response. + * @Default {html} + */ + dataType?: string; - /** Fires when the TimePicker control gets focus. */ - focusIn?(e: FocusInEventArgs): void; + /** 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; - /** Fires when the TimePicker control get lost focus. */ - focusOut?(e: FocusOutEventArgs): void; + /** Specifies the list of HTML attributes to be added to TagCloud control. + * @Default {{}} + */ + htmlAttributes?: any; - /** Fires when the TimePicker popup opened. */ - open?(e: OpenEventArgs): void; + /** Defines the format for the TagCloud to display the tag items.See Format + * @Default {ej.Format.Cloud} + */ + format?: string | ej.Format; - /** Fires when the value is selected from the TimePicker dropdown list. */ - select?(e: SelectEventArgs): void; -} + /** 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; -export interface BeforeChangeEventArgs { + /** 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; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** 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; - /** returns the TimePicker model - */ - model?: ej.TimePicker.Model; + /** 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; - /** returns the name of the event - */ - type?: string; + /** 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; - /** returns the previously selected time value - */ - prevTime?: string; + /** Fires when the TimePicker is destroyed successfully. */ + destroy?(e: DestroyEventArgs): void; - /** returns the modified time value - */ - value?: string; -} + /** Fires when the TimePicker control gets focus. */ + focusIn?(e: FocusInEventArgs): void; -export interface BeforeOpenEventArgs { + /** Fires when the TimePicker control get lost focus. */ + focusOut?(e: FocusOutEventArgs): void; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** Fires when the TimePicker popup opened. */ + open?(e: OpenEventArgs): void; - /** returns the TimePicker model - */ - model?: ej.TimePicker.Model; + /** Fires when the value is selected from the TimePicker dropdown list. */ + select?(e: SelectEventArgs): void; + } - /** returns the name of the event - */ - type?: string; + export interface BeforeChangeEventArgs { - /** returns the previously selected time value - */ - prevTime?: string; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the time value - */ - value?: string; -} + /** returns the TimePicker model + */ + model?: ej.TimePicker.Model; -export interface ChangeEventArgs { + /** returns the name of the event + */ + type?: string; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns the previously selected time value + */ + prevTime?: string; - /** returns the TimePicker model - */ - model?: ej.TimePicker.Model; + /** returns the modified time value + */ + value?: string; + } - /** returns the name of the event - */ - type?: string; + export interface BeforeOpenEventArgs { - /** returns true when the value changed by user interaction otherwise returns false - */ - isInteraction?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the previously selected time value - */ - prevTime?: string; + /** returns the TimePicker model + */ + model?: ej.TimePicker.Model; - /** returns the modified time value - */ - value?: string; -} + /** returns the name of the event + */ + type?: string; -export interface CloseEventArgs { + /** returns the previously selected time value + */ + prevTime?: string; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns the time value + */ + value?: string; + } - /** returns the TimePicker model - */ - model?: ej.TimePicker.Model; + export interface ChangeEventArgs { - /** returns the name of the event - */ - type?: string; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the previously selected time value - */ - prevTime?: string; + /** returns the TimePicker model + */ + model?: ej.TimePicker.Model; - /** returns the time value - */ - value?: string; -} + /** returns the name of the event + */ + type?: string; -export interface CreateEventArgs { + /** returns true when the value changed by user interaction otherwise returns false + */ + isInteraction?: boolean; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns the previously selected time value + */ + prevTime?: string; - /** returns the TimePicker model - */ - model?: ej.TimePicker.Model; + /** returns the modified time value + */ + value?: string; + } - /** returns the name of the event - */ - type?: string; -} + export interface CloseEventArgs { -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; -} + /** returns the previously selected time value + */ + prevTime?: string; -export interface FocusInEventArgs { + /** returns the time value + */ + value?: string; + } - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + export interface CreateEventArgs { - /** returns the TimePicker model - */ - model?: ej.TimePicker.Model; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the name of the event - */ - type?: string; + /** returns the TimePicker model + */ + model?: ej.TimePicker.Model; - /** returns the previously selected time value - */ - prevTime?: string; + /** returns the name of the event + */ + type?: string; + } - /** returns the current time value - */ - value?: string; -} + export interface DestroyEventArgs { -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; + export interface FocusInEventArgs { - /** returns the previously selected time value - */ - prevTime?: string; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the current time value - */ - value?: string; -} + /** returns the TimePicker model + */ + model?: ej.TimePicker.Model; -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; + /** returns the name of the event + */ + type?: string; - /** Fires after Toolbar control is created. */ - create?(e: CreateEventArgs): void; - - /** Fires after Toolbar control is focused. */ - focusOut?(e: FocusOutEventArgs): void; + /** returns the previously selected time value + */ + prevTime?: string; - /** Fires when the Toolbar is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; + /** returns the current time value + */ + value?: string; + } - /** Fires after Toolbar control item is hovered. */ - itemHover?(e: ItemHoverEventArgs): void; + export interface FocusOutEventArgs { - /** 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; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Fires when the overflow popup of toolbar is closed. */ - overflowClose?(e: OverflowCloseEventArgs): void; -} + /** returns the TimePicker model + */ + model?: ej.TimePicker.Model; -export interface ClickEventArgs { + /** returns the name of the event + */ + type?: string; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns the previously selected time value + */ + prevTime?: string; - /** returns the Toolbar model - */ - model?: ej.Toolbar.Model; + /** returns the current time value + */ + value?: string; + } - /** returns the name of the event - */ - type?: 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; - /** returns the target of the current object. - */ - target?: any; + /** Fires after Toolbar control is created. */ + create?(e: CreateEventArgs): void; + + /** Fires after Toolbar control is focused. */ + focusOut?(e: FocusOutEventArgs): void; - /** returns the target of the current object. - */ - currentTarget?: any; + /** Fires when the Toolbar is destroyed successfully. */ + destroy?(e: DestroyEventArgs): void; - /** return the Toolbar state - */ - status?: boolean; -} + /** Fires after Toolbar control item is hovered. */ + itemHover?(e: ItemHoverEventArgs): void; -export interface CreateEventArgs { + /** 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; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** Fires when the overflow popup of toolbar is closed. */ + overflowClose?(e: OverflowCloseEventArgs): void; + } - /** returns the Toolbar model - */ - model?: ej.Toolbar.Model; + export interface ClickEventArgs { - /** returns the name of the event - */ - type?: string; -} + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; -export interface FocusOutEventArgs { + /** returns the Toolbar model + */ + model?: ej.Toolbar.Model; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns the name of the event + */ + type?: string; - /** returns the Toolbar model - */ - model?: ej.Toolbar.Model; + /** returns the target of the current object. + */ + target?: any; - /** returns the name of the event - */ - type?: string; -} + /** returns the target of the current object. + */ + currentTarget?: any; -export interface DestroyEventArgs { + /** return the Toolbar state + */ + status?: boolean; + } - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + export interface CreateEventArgs { - /** returns the Toolbar model - */ - model?: ej.Toolbar.Model; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the name of the event - */ - type?: string; -} + /** returns the Toolbar model + */ + model?: ej.Toolbar.Model; -export interface ItemHoverEventArgs { + /** returns the name of the event + */ + type?: string; + } - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + export interface FocusOutEventArgs { - /** returns the Toolbar model - */ - model?: ej.Toolbar.Model; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the name of the event - */ - type?: string; + /** returns the Toolbar model + */ + model?: ej.Toolbar.Model; - /** returns the target of the current object. - */ - target?: any; + /** returns the name of the event + */ + type?: string; + } - /** returns the target of the current object. - */ - currentTarget?: any; + export interface DestroyEventArgs { - /** return the Toolbar state - */ - status?: boolean; -} + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; -export interface ItemLeaveEventArgs { + /** returns the Toolbar model + */ + model?: ej.Toolbar.Model; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns the name of the event + */ + type?: string; + } - /** returns the Toolbar model - */ - model?: ej.Toolbar.Model; + export interface ItemHoverEventArgs { - /** returns the name of the event - */ - type?: string; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the target of the current object. - */ - target?: any; + /** returns the Toolbar model + */ + model?: ej.Toolbar.Model; - /** returns the target of the current object. - */ - currentTarget?: any; + /** returns the name of the event + */ + type?: string; - /** return the Toolbar state - */ - status?: boolean; -} + /** returns the target of the current object. + */ + target?: any; -export interface OverflowOpenEventArgs { + /** returns the target of the current object. + */ + currentTarget?: any; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** return the Toolbar state + */ + status?: boolean; + } - /** returns the Toolbar model - */ - model?: ej.Toolbar.Model; + export interface ItemLeaveEventArgs { - /** returns the name of the event - */ - type?: string; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the current X position of the target . - */ - clientX?: number; + /** returns the Toolbar model + */ + model?: ej.Toolbar.Model; - /** Returns the current Y position of the target . - */ - clientY?: number; + /** returns the name of the event + */ + type?: string; - /** returns the target of the current object. - */ - currentTarget?: any; -} + /** returns the target of the current object. + */ + target?: any; -export interface OverflowCloseEventArgs { + /** returns the target of the current object. + */ + currentTarget?: any; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** return the Toolbar state + */ + status?: boolean; + } - /** returns the Toolbar model - */ - model?: ej.Toolbar.Model; + export interface OverflowOpenEventArgs { - /** returns the name of the event - */ - type?: string; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the current X position of the target . - */ - clientX?: number; + /** returns the Toolbar model + */ + model?: ej.Toolbar.Model; - /** Returns the current Y position of the target . - */ - clientY?: number; + /** returns the name of the event + */ + type?: string; - /** returns the target of the current object. - */ - currentTarget?: any; -} + /** Returns the current X position of the target . + */ + clientX?: number; -export interface Fields { + /** Returns the current Y position of the target . + */ + clientY?: number; - /** Defines the group name for the item. - */ - group?: string; + /** returns the target of the current object. + */ + currentTarget?: any; + } - /** Defines the HTML attributes such as id, class, styles for the item to extend the capability. - */ - htmlAttributes?: any; + export interface OverflowCloseEventArgs { - /** Defines id for the tag. - */ - id?: string; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Defines the image attributes such as height, width, styles and so on. - */ - imageAttributes?: string; + /** returns the Toolbar model + */ + model?: ej.Toolbar.Model; - /** 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; + /** returns the name of the event + */ + type?: string; - /** Specifies the child nodes to be loaded on demand - * @Default {false} - */ - loadOnDemand?: boolean; + /** Returns the current X position of the target . + */ + clientX?: 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; + /** Returns the current Y position of the target . + */ + clientY?: 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[]; + /** returns the target of the current object. + */ + currentTarget?: any; + } - /** Gets or sets a value that indicates whether to display or hide checkbox for all TreeView nodes. - * @Default {false} - */ - showCheckbox?: boolean; + export interface Fields { - /** By using sortSettings property, you can customize the sorting option in TreeView control. - */ - sortSettings?: SortSettings; + /** Defines the group name for the item. + */ + group?: string; - /** Allow us to use custom template in order to create TreeView. - * @Default {null} - */ - template?: string; + /** Defines the HTML attributes such as id, class, styles for the item to extend the capability. + */ + htmlAttributes?: any; - /** Defines the width of the TreeView. - * @Default {Null} - */ - width?: string|number; + /** Defines id for the tag. + */ + id?: string; - /** Fires before adding node to TreeView. */ - beforeAdd?(e: BeforeAddEventArgs): void; + /** Defines the image attributes such as height, width, styles and so on. + */ + imageAttributes?: string; - /** Fires before collapse a node. */ - beforeCollapse?(e: BeforeCollapseEventArgs): void; + /** 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; - /** Fires before cut node in TreeView. */ - beforeCut?(e: BeforeCutEventArgs): void; + /** Specifies the child nodes to be loaded on demand + * @Default {false} + */ + loadOnDemand?: boolean; - /** Fires before deleting node in TreeView. */ - beforeDelete?(e: BeforeDeleteEventArgs): void; + /** 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; - /** Fires before editing the node in TreeView. */ - beforeEdit?(e: BeforeEditEventArgs): void; + /** 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[]; - /** Fires before expanding the node. */ - beforeExpand?(e: BeforeExpandEventArgs): void; + /** Gets or sets a value that indicates whether to display or hide checkbox for all TreeView nodes. + * @Default {false} + */ + showCheckbox?: boolean; - /** Fires before loading nodes to TreeView. */ - beforeLoad?(e: BeforeLoadEventArgs): void; + /** By using sortSettings property, you can customize the sorting option in TreeView control. + */ + sortSettings?: SortSettings; - /** Fires before paste node in TreeView. */ - beforePaste?(e: BeforePasteEventArgs): void; + /** Allow us to use custom template in order to create TreeView. + * @Default {null} + */ + template?: string; - /** Fires before selecting node in TreeView. */ - beforeSelect?(e: BeforeSelectEventArgs): void; + /** Defines the width of the TreeView. + * @Default {Null} + */ + width?: string | number; - /** Fires when TreeView created successfully. */ - create?(e: CreateEventArgs): void; + /** Fires before adding node to TreeView. */ + beforeAdd?(e: BeforeAddEventArgs): void; - /** Fires when TreeView destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; + /** Fires before collapse a node. */ + beforeCollapse?(e: BeforeCollapseEventArgs): void; - /** Fires before nodeEdit Successful. */ - inlineEditValidation?(e: InlineEditValidationEventArgs): void; + /** Fires before cut node in TreeView. */ + beforeCut?(e: BeforeCutEventArgs): void; - /** Fires when key pressed successfully. */ - keyPress?(e: KeyPressEventArgs): void; + /** Fires before deleting node in TreeView. */ + beforeDelete?(e: BeforeDeleteEventArgs): void; - /** Fires when data load fails. */ - loadError?(e: LoadErrorEventArgs): void; + /** Fires before editing the node in TreeView. */ + beforeEdit?(e: BeforeEditEventArgs): void; - /** Fires when data loaded successfully. */ - loadSuccess?(e: LoadSuccessEventArgs): void; + /** Fires before expanding the node. */ + beforeExpand?(e: BeforeExpandEventArgs): void; - /** Fires once node added successfully. */ - nodeAdd?(e: NodeAddEventArgs): void; + /** Fires before loading nodes to TreeView. */ + beforeLoad?(e: BeforeLoadEventArgs): void; - /** Fires once node checked successfully. */ - nodeCheck?(e: NodeCheckEventArgs): void; + /** Fires before paste node in TreeView. */ + beforePaste?(e: BeforePasteEventArgs): void; - /** Fires when node clicked successfully. */ - nodeClick?(e: NodeClickEventArgs): void; + /** Fires before selecting node in TreeView. */ + beforeSelect?(e: BeforeSelectEventArgs): void; - /** Fires when node collapsed successfully. */ - nodeCollapse?(e: NodeCollapseEventArgs): void; + /** Fires when TreeView created successfully. */ + create?(e: CreateEventArgs): void; - /** Fires when node cut successfully. */ - nodeCut?(e: NodeCutEventArgs): void; + /** Fires when TreeView destroyed successfully. */ + destroy?(e: DestroyEventArgs): void; - /** Fires when node deleted successfully. */ - nodeDelete?(e: NodeDeleteEventArgs): void; + /** Fires before nodeEdit Successful. */ + inlineEditValidation?(e: InlineEditValidationEventArgs): void; - /** Fires when node dragging. */ - nodeDrag?(e: NodeDragEventArgs): void; + /** Fires when key pressed successfully. */ + keyPress?(e: KeyPressEventArgs): void; - /** Fires once node drag start successfully. */ - nodeDragStart?(e: NodeDragStartEventArgs): void; + /** Fires when data load fails. */ + loadError?(e: LoadErrorEventArgs): void; - /** Fires before the dragged node to be dropped. */ - nodeDragStop?(e: NodeDragStopEventArgs): void; + /** Fires when data loaded successfully. */ + loadSuccess?(e: LoadSuccessEventArgs): void; - /** Fires once node dropped successfully. */ - nodeDropped?(e: NodeDroppedEventArgs): void; + /** Fires once node added successfully. */ + nodeAdd?(e: NodeAddEventArgs): void; - /** Fires once node edited successfully. */ - nodeEdit?(e: NodeEditEventArgs): void; + /** Fires once node checked successfully. */ + nodeCheck?(e: NodeCheckEventArgs): void; - /** Fires once node expanded successfully. */ - nodeExpand?(e: NodeExpandEventArgs): void; + /** Fires when node clicked successfully. */ + nodeClick?(e: NodeClickEventArgs): void; - /** Fires once node pasted successfully. */ - nodePaste?(e: NodePasteEventArgs): void; + /** Fires when node collapsed successfully. */ + nodeCollapse?(e: NodeCollapseEventArgs): void; - /** Fires when node selected successfully. */ - nodeSelect?(e: NodeSelectEventArgs): void; + /** Fires when node cut successfully. */ + nodeCut?(e: NodeCutEventArgs): void; - /** Fires once node unchecked successfully. */ - nodeUncheck?(e: NodeUncheckEventArgs): void; + /** Fires when node deleted successfully. */ + nodeDelete?(e: NodeDeleteEventArgs): void; - /** Fires once node unselected successfully. */ - nodeUnselect?(e: NodeUnselectEventArgs): void; + /** Fires when node dragging. */ + nodeDrag?(e: NodeDragEventArgs): void; - /** Fires when TreeView nodes are loaded successfully */ - ready?(e: ReadyEventArgs): void; -} + /** Fires once node drag start successfully. */ + nodeDragStart?(e: NodeDragStartEventArgs): void; -export interface BeforeAddEventArgs { + /** Fires before the dragged node to be dropped. */ + nodeDragStop?(e: NodeDragStopEventArgs): void; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** Fires once node dropped successfully. */ + nodeDropped?(e: NodeDroppedEventArgs): void; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** Fires once node edited successfully. */ + nodeEdit?(e: NodeEditEventArgs): void; - /** returns the name of the event - */ - type?: string; + /** Fires once node expanded successfully. */ + nodeExpand?(e: NodeExpandEventArgs): void; - /** returns the given new node data - */ - data?: string|any; + /** Fires once node pasted successfully. */ + nodePaste?(e: NodePasteEventArgs): void; - /** returns the parent element, the given new nodes to be appended to the given parent element - */ - targetParent?: any; + /** Fires when node selected successfully. */ + nodeSelect?(e: NodeSelectEventArgs): void; - /** returns the given parent node details - */ - parentDetails?: any; -} + /** Fires once node unchecked successfully. */ + nodeUncheck?(e: NodeUncheckEventArgs): void; -export interface BeforeCollapseEventArgs { + /** Fires once node unselected successfully. */ + nodeUnselect?(e: NodeUnselectEventArgs): void; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** Fires when TreeView nodes are loaded successfully */ + ready?(e: ReadyEventArgs): void; + } - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + export interface BeforeAddEventArgs { - /** returns the name of the event - */ - type?: string; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the value of the node - */ - value?: string; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the current element of the node clicked - */ - currentElement?: any; + /** returns the name of the event + */ + type?: string; - /** returns the child nodes are loaded or not - */ - isChildLoaded?: boolean; + /** returns the given new node data + */ + data?: string | any; - /** returns the id of currently clicked node - */ - id?: string; + /** returns the parent element, the given new nodes to be appended to the given parent element + */ + targetParent?: any; - /** returns the parent id of currently clicked node - */ - parentId?: string; + /** returns the given parent node details + */ + parentDetails?: any; + } - /** returns the format asynchronous or synchronous - */ - async?: boolean; -} + export interface BeforeCollapseEventArgs { -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 value of the node + */ + value?: string; - /** returns the event object - */ - event?: any; + /** returns the current element of the node clicked + */ + currentElement?: any; - /** returns the target element, the given node to be cut - */ - target?: any; + /** returns the child nodes are loaded or not + */ + isChildLoaded?: boolean; - /** returns the given target node values - */ - nodeDetails?: any; + /** returns the id of currently clicked node + */ + id?: string; - /** returns the key pressed key code value - */ - keyCode?: number; -} + /** returns the parent id of currently clicked node + */ + parentId?: string; -export interface BeforeDeleteEventArgs { + /** returns the format asynchronous or synchronous + */ + async?: boolean; + } - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + export interface BeforeCutEventArgs { - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the name of the event - */ - type?: string; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the event object - */ - event?: any; + /** returns the name of the event + */ + type?: string; - /** returns the target element, the given node to be deleted - */ - target?: any; + /** returns the event object + */ + event?: any; - /** returns the given target node values - */ - nodeDetails?: any; + /** returns the target element, the given node to be cut + */ + target?: any; - /** returns the current parent element of the target node - */ - parentElement?: any; + /** returns the given target node values + */ + nodeDetails?: any; - /** returns the parent node values - */ - parentDetails?: any; + /** returns the key pressed key code value + */ + keyCode?: number; + } - /** returns the currently removed nodes - */ - removedNodes?: any[]; -} + export interface BeforeDeleteEventArgs { -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 event object + */ + event?: any; - /** returns the current element of the node clicked - */ - currentElement?: any; -} + /** returns the target element, the given node to be deleted + */ + target?: any; -export interface BeforeExpandEventArgs { + /** returns the given target node values + */ + nodeDetails?: any; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns the current parent element of the target node + */ + parentElement?: any; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the parent node values + */ + parentDetails?: any; - /** returns the name of the event - */ - type?: string; + /** returns the currently removed nodes + */ + removedNodes?: any[]; + } - /** returns the value of the node - */ - value?: string; + export interface BeforeEditEventArgs { - /** if the child node is ready to expanded state; otherwise, false. - */ - isChildLoaded?: boolean; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the current element of the node clicked - */ - currentElement?: any; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the id of currently clicked node - */ - id?: string; + /** returns the name of the event + */ + type?: string; - /** returns the parent id of currently clicked node - */ - parentId?: string; + /** returns the current element of the node clicked + */ + currentElement?: any; + } - /** returns the format asynchronous or synchronous - */ - async?: boolean; -} + export interface BeforeExpandEventArgs { -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 value of the node + */ + value?: string; - /** returns the AJAX settings object - */ - AjaxOptions?: any; -} + /** if the child node is ready to expanded state; otherwise, false. + */ + isChildLoaded?: boolean; -export interface BeforePasteEventArgs { + /** returns the current element of the node clicked + */ + currentElement?: any; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns the id of currently clicked node + */ + id?: string; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the parent id of currently clicked node + */ + parentId?: string; - /** returns the name of the event - */ - type?: string; + /** returns the format asynchronous or synchronous + */ + async?: boolean; + } - /** returns the event object - */ - event?: any; + export interface BeforeLoadEventArgs { - /** returns the target element, the given node to be pasted - */ - target?: any; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the given target node values - */ - nodeDetails?: any; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the key pressed key code value - */ - keyCode?: number; -} + /** returns the name of the event + */ + type?: string; -export interface BeforeSelectEventArgs { + /** returns the AJAX settings object + */ + AjaxOptions?: any; + } - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + export interface BeforePasteEventArgs { - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the name of the event - */ - type?: string; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the target element, the given node to be selected - */ - target?: any; + /** returns the name of the event + */ + type?: string; - /** returns the given target node values - */ - nodeDetails?: any; -} + /** returns the event object + */ + event?: any; -export interface CreateEventArgs { + /** returns the target element, the given node to be pasted + */ + target?: any; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns the given target node values + */ + nodeDetails?: any; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the key pressed key code value + */ + keyCode?: number; + } - /** returns the name of the event - */ - type?: string; -} + export interface BeforeSelectEventArgs { -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; -} + /** returns the target element, the given node to be selected + */ + target?: any; -export interface InlineEditValidationEventArgs { + /** returns the given target node values + */ + nodeDetails?: any; + } - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + export interface CreateEventArgs { - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the name of the event - */ - type?: string; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the new entered text for the node - */ - newText?: string; + /** returns the name of the event + */ + type?: string; + } - /** returns the current node element id - */ - id?: any; + export interface DestroyEventArgs { - /** returns the old node text - */ - oldText?: string; -} + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; -export interface KeyPressEventArgs { + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns the name of the event + */ + type?: string; + } - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + export interface InlineEditValidationEventArgs { - /** returns the name of the event - */ - type?: string; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the event object - */ - event?: any; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the current element of the node clicked - */ - currentElement?: any; + /** returns the name of the event + */ + type?: string; - /** returns the value of the node - */ - value?: string; + /** returns the new entered text for the node + */ + newText?: string; - /** returns node path from root element - */ - path?: string; + /** returns the current node element id + */ + id?: any; - /** returns the key pressed key code value - */ - keyCode?: number; + /** returns the old node text + */ + oldText?: string; + } - /** it returns when the current node is in expanded state; otherwise, false. - */ - isExpanded?: boolean; + export interface KeyPressEventArgs { - /** returns the id of current TreeView node - */ - id?: string; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the parentId of current TreeView node - */ - parentId?: string; -} + /** returns the TreeView model + */ + model?: ej.TreeView.Model; -export interface LoadErrorEventArgs { + /** returns the name of the event + */ + type?: string; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns the event object + */ + event?: any; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the current element of the node clicked + */ + currentElement?: any; - /** returns the name of the event - */ - type?: string; + /** returns the value of the node + */ + value?: string; - /** returns the AJAX error object - */ - error?: any; -} + /** returns node path from root element + */ + path?: string; -export interface LoadSuccessEventArgs { + /** returns the key pressed key code value + */ + keyCode?: number; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** it returns when the current node is in expanded state; otherwise, false. + */ + isExpanded?: boolean; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the id of current TreeView node + */ + id?: string; - /** returns the name of the event - */ - type?: string; + /** returns the parentId of current TreeView node + */ + parentId?: string; + } - /** returns the success data from the URL - */ - data?: any; + export interface LoadErrorEventArgs { - /** returns the target parent element, the data returned from the URL to be appended to the given parent element, else in TreeView - */ - targetParent?: any; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the given parent node details - */ - parentDetails?: any; -} + /** returns the TreeView model + */ + model?: ej.TreeView.Model; -export interface NodeAddEventArgs { + /** returns the name of the event + */ + type?: string; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns the AJAX error object + */ + error?: any; + } - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + export interface LoadSuccessEventArgs { - /** returns the name of the event - */ - type?: string; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the added data, that are given initially - */ - data?: any; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the newly added elements - */ - nodes?: any; + /** returns the name of the event + */ + type?: string; - /** returns the target parent element of the added element - */ - parentElement?: any; + /** returns the success data from the URL + */ + data?: any; - /** returns the given parent node details - */ - parentDetails?: 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; -export interface NodeCheckEventArgs { + /** returns the given parent node details + */ + parentDetails?: any; + } - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + export interface NodeAddEventArgs { - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the name of the event - */ - type?: string; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the event object - */ - event?: any; + /** returns the name of the event + */ + type?: string; - /** returns the value of the node - */ - value?: string; + /** returns the added data, that are given initially + */ + data?: any; - /** returns the id of the current element of the node clicked - */ - id?: string; + /** returns the newly added elements + */ + nodes?: any; - /** returns the id of the parent element of current element of the node clicked - */ - parentId?: string; + /** returns the target parent element of the added element + */ + parentElement?: any; - /** returns the current element of the node clicked - */ - currentElement?: any; + /** returns the given parent node details + */ + parentDetails?: any; + } - /** it returns true when the node checkbox is checked; otherwise, false. - */ - isChecked?: boolean; + export interface NodeCheckEventArgs { - /** it returns the currently checked node name - */ - currentNode?: any[]; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** it returns the currently checked and its child node details - */ - currentCheckedNodes?: any[]; -} + /** returns the TreeView model + */ + model?: ej.TreeView.Model; -export interface NodeClickEventArgs { + /** returns the name of the event + */ + type?: string; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns the event object + */ + event?: any; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the value of the node + */ + value?: string; - /** returns the name of the event - */ - type?: string; + /** returns the id of the current element of the node clicked + */ + id?: string; - /** returns the event object - */ - event?: any; + /** 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; - /** returns the id of currently clicked TreeView node - */ - id?: string; + /** it returns true when the node checkbox is checked; otherwise, false. + */ + isChecked?: boolean; - /** returns the parentId of currently clicked TreeView node - */ - parentId?: string; -} + /** it returns the currently checked node name + */ + currentNode?: any[]; -export interface NodeCollapseEventArgs { + /** it returns the currently checked and its child node details + */ + currentCheckedNodes?: any[]; + } - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + export interface NodeClickEventArgs { - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the id of the current element of the node clicked - */ - id?: string; + /** 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 parent element of current element of the node clicked - */ - parentId?: string; + /** returns the event object + */ + event?: any; - /** 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 id of currently clicked TreeView node + */ + id?: string; - /** returns the child nodes are loaded or not - */ - isChildLoaded?: boolean; + /** returns the parentId of currently clicked TreeView node + */ + parentId?: string; + } - /** returns the format asynchronous or synchronous - */ - async?: boolean; -} + export interface NodeCollapseEventArgs { -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 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 event object - */ - event?: any; + /** returns the id of the parent element of current element of the node clicked + */ + parentId?: string; - /** returns the current parent element of the cut node - */ - parentElement?: any; + /** returns the value of the node + */ + value?: string; - /** returns the given parent node details - */ - parentDetails?: any; + /** returns the current element of the node clicked + */ + currentElement?: any; - /** returns the key pressed key code value - */ - keyCode?: number; -} + /** returns the child nodes are loaded or not + */ + isChildLoaded?: boolean; -export interface NodeDeleteEventArgs { + /** returns the format asynchronous or synchronous + */ + async?: boolean; + } - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + export interface NodeCutEventArgs { - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the name of the event - */ - type?: string; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the event object - */ - event?: any; + /** returns the name of the event + */ + type?: string; - /** returns the current parent element of the deleted node - */ - parentElement?: any; + /** returns the event object + */ + event?: any; - /** returns the given parent node details - */ - parentDetails?: any; + /** returns the current parent element of the cut node + */ + parentElement?: any; - /** returns the currently removed nodes - */ - removedNodes?: any[]; -} + /** returns the given parent node details + */ + parentDetails?: any; -export interface NodeDragEventArgs { + /** returns the key pressed key code value + */ + keyCode?: number; + } - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + export interface NodeDeleteEventArgs { - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the name of the event - */ - type?: string; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the original drag target - */ - dragTarget?: any; + /** returns the name of the event + */ + type?: string; - /** returns the current target TreeView node - */ - target?: any; + /** returns the event object + */ + event?: any; - /** returns the current target details - */ - targetElementData?: any; + /** returns the current parent element of the deleted node + */ + parentElement?: any; - /** returns the current parent element of the target node - */ - draggedElement?: any; + /** returns the given parent node details + */ + parentDetails?: any; - /** returns the given parent node details - */ - draggedElementData?: any; + /** returns the currently removed nodes + */ + removedNodes?: any[]; + } - /** returns the event object - */ - event?: any; -} + export interface NodeDragEventArgs { -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 target TreeView node + */ + target?: any; - /** returns the current dragging parent TreeView node - */ - parentElement?: any; + /** returns the current target details + */ + targetElementData?: any; - /** returns the current dragging parent TreeView node details - */ - parentElementData?: any; + /** returns the current parent element of the target node + */ + draggedElement?: any; - /** returns the current parent element of the dragging node - */ - target?: any; + /** returns the given parent node details + */ + draggedElementData?: any; - /** returns the given parent node details - */ - targetElementData?: any; + /** returns the event object + */ + event?: any; + } - /** returns the event object - */ - event?: any; -} + export interface NodeDragStartEventArgs { -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 drag target + */ + dragTarget?: any; - /** returns the original drop target - */ - dropTarget?: any; + /** returns the current dragging parent TreeView node + */ + parentElement?: any; - /** returns the current dragged TreeView node - */ - draggedElement?: any; + /** returns the current dragging parent TreeView node details + */ + parentElementData?: any; - /** returns the current dragged TreeView node details - */ - draggedElementData?: any; + /** returns the current parent element of the dragging 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 event object + */ + event?: any; + } - /** returns the drop position such as before, after or over - */ - position?: string; + export interface NodeDragStopEventArgs { - /** returns the event object - */ - event?: any; -} + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; -export interface NodeDroppedEventArgs { + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns the name of the event + */ + type?: string; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the original drop target + */ + dropTarget?: any; - /** returns the name of the event - */ - type?: string; + /** returns the current dragged TreeView node + */ + draggedElement?: any; - /** returns the original drop target - */ - dropTarget?: any; + /** returns the current dragged TreeView node details + */ + draggedElementData?: any; - /** returns the current dropped TreeView node - */ - droppedElement?: any; + /** returns the current parent element of the dragged node + */ + target?: any; - /** returns the current dropped TreeView node details - */ - droppedElementData?: any; + /** returns the given parent node details + */ + targetElementData?: any; - /** returns the current parent element of the dropped node - */ - target?: any; + /** returns the drop position such as before, after or over + */ + position?: string; - /** returns the given parent node details - */ - targetElementData?: any; + /** returns the event object + */ + event?: any; + } - /** returns the drop position such as before, after or over - */ - position?: string; + export interface NodeDroppedEventArgs { - /** returns the event object - */ - event?: any; -} + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; -export interface NodeEditEventArgs { + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns the name of the event + */ + type?: string; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the original drop target + */ + dropTarget?: any; - /** returns the name of the event - */ - type?: string; + /** returns the current dropped TreeView node + */ + droppedElement?: any; - /** returns the id of the element - */ - id?: string; + /** returns the current dropped TreeView node details + */ + droppedElementData?: any; - /** returns the oldText of the element - */ - oldText?: string; + /** returns the current parent element of the dropped node + */ + target?: any; - /** returns the newText of the element - */ - newText?: string; + /** returns the given parent node details + */ + targetElementData?: any; - /** returns the event object - */ - event?: any; + /** returns the drop position such as before, after or over + */ + position?: string; - /** returns the target element, the given node to be cut - */ - target?: any; + /** returns the event object + */ + event?: any; + } - /** returns the given target node values - */ - nodeDetails?: any; -} + export interface NodeEditEventArgs { -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 id of the element + */ + id?: string; - /** returns the value of the node - */ - value?: string; + /** returns the oldText of the element + */ + oldText?: string; - /** if the child node is ready to expanded state; otherwise, false. - */ - isChildLoaded?: boolean; + /** returns the newText of the element + */ + newText?: string; - /** returns the current element of the node clicked - */ - currentElement?: any; + /** returns the event object + */ + event?: any; - /** returns the id of currently clicked node - */ - id?: string; + /** returns the target element, the given node to be cut + */ + target?: any; - /** returns the parent id of currently clicked node - */ - parentId?: string; + /** returns the given target node values + */ + nodeDetails?: any; + } - /** returns the format asynchronous or synchronous - */ - async?: boolean; -} + export interface NodeExpandEventArgs { -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 value of the node + */ + value?: string; - /** returns the event object - */ - event?: any; + /** if the child node is ready to expanded state; otherwise, false. + */ + isChildLoaded?: boolean; - /** returns the pasted element - */ - target?: any; + /** returns the current element of the node clicked + */ + currentElement?: any; - /** returns the given target node values - */ - nodeDetails?: any; + /** returns the id of currently clicked node + */ + id?: string; - /** returns the key pressed key code value - */ - keyCode?: number; -} + /** returns the parent id of currently clicked node + */ + parentId?: string; -export interface NodeSelectEventArgs { + /** returns the format asynchronous or synchronous + */ + async?: boolean; + } - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + export interface NodePasteEventArgs { - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the name of the event - */ - type?: string; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** returns the id of the current element of the node clicked - */ - id?: any; + /** returns the name of the event + */ + type?: string; - /** returns the id of the parent element of current element of the node clicked - */ - parentId?: any; + /** returns the event object + */ + event?: any; - /** returns the current selected nodes index of TreeView - */ - selectedNodes?: any[]; + /** returns the pasted element + */ + target?: any; - /** returns the value of the node - */ - value?: string; + /** returns the given target node values + */ + nodeDetails?: any; - /** returns the current element of the node clicked - */ - currentElement?: any; -} + /** returns the key pressed key code value + */ + keyCode?: number; + } -export interface NodeUncheckEventArgs { + 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 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 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; + } - /** it returns true when the node checkbox is checked; otherwise, false. - */ - isChecked?: boolean; + export interface NodeUncheckEventArgs { - /** it returns currently unchecked node name - */ - currentNode?: string; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** it returns currently unchecked node and its child node details. - */ - currentUncheckedNodes?: any[]; -} + /** returns the TreeView model + */ + model?: ej.TreeView.Model; -export interface NodeUnselectEventArgs { + /** returns the name of the event + */ + type?: string; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns the event object + */ + event?: any; - /** returns the current element of the node unselected - */ - currentElement?: any; + /** returns the id of the current element of the node clicked + */ + id?: any; - /** returns the id of the current element of the node unselected - */ - id?: string; + /** returns the id of the parent element of current element of the node clicked + */ + parentId?: any; - /** returns the TreeView model - */ - model?: ej.TreeView.Model; + /** returns the value of the node + */ + value?: string; - /** returns the id of the parent element of current element of the node unselected - */ - parentId?: string; + /** returns the current element of the node clicked + */ + currentElement?: any; - /** returns the current selected nodes index of TreeView - */ - selectedNodes?: any[]; + /** it returns true when the node checkbox is checked; otherwise, false. + */ + isChecked?: boolean; - /** returns the name of the event - */ - type?: string; + /** it returns currently unchecked node name + */ + currentNode?: 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; + /** it returns currently unchecked node and its child node details. + */ + currentUncheckedNodes?: any[]; + } - /** Sets the width of the browse button. - * @Default {100px} - */ - width?: string; + export interface NodeUnselectEventArgs { - /** Fires when the upload progress beforeSend. */ - beforeSend?(e: BeforeSendEventArgs): void; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Fires when the upload progress begins. */ - begin?(e: BeginEventArgs): void; + /** returns the current element of the node unselected + */ + currentElement?: any; - /** Fires when the upload progress is cancelled. */ - cancel?(e: CancelEventArgs): void; + /** returns the id of the current element of the node unselected + */ + id?: string; - /** Fires when the file upload progress is completed. */ - complete?(e: CompleteEventArgs): void; + /** returns the TreeView model + */ + model?: ej.TreeView.Model; - /** Fires when the file upload progress is succeeded. */ - success?(e: SuccessEventArgs): void; + /** returns the id of the parent element of current element of the node unselected + */ + parentId?: string; - /** Fires when the Uploadbox control is created. */ - create?(e: CreateEventArgs): void; + /** returns the current selected nodes index of TreeView + */ + selectedNodes?: any[]; - /** Fires when the Uploadbox control is destroyed. */ - destroy?(e: DestroyEventArgs): void; + /** returns the name of the event + */ + type?: string; - /** Fires when the Upload process ends in Error. */ - error?(e: ErrorEventArgs): void; + /** 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; - /** Fires when the file is selected for upload successfully. */ - fileSelect?(e: FileSelectEventArgs): void; + /** Sets the width of the browse button. + * @Default {100px} + */ + width?: string; - /** Fires when the file is uploading. */ - inProgress?(e: InProgressEventArgs): void; + /** Fires when the upload progress beforeSend. */ + beforeSend?(e: BeforeSendEventArgs): void; - /** Fires when the uploaded file is removed successfully. */ - remove?(e: RemoveEventArgs): void; -} + /** Fires when the upload progress begins. */ + begin?(e: BeginEventArgs): void; -export interface BeforeSendEventArgs { + /** Fires when the upload progress is cancelled. */ + cancel?(e: CancelEventArgs): void; - /** Selected FileList Object. - */ - files?: any; + /** Fires when the file upload progress is completed. */ + complete?(e: CompleteEventArgs): void; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** Fires when the file upload progress is succeeded. */ + success?(e: SuccessEventArgs): void; - /** returns the Uploadbox model - */ - model?: any; + /** Fires when the Uploadbox control is created. */ + create?(e: CreateEventArgs): void; - /** XHR-AJAX Object for reference. - */ - xhr?: any; + /** Fires when the Uploadbox control is destroyed. */ + destroy?(e: DestroyEventArgs): void; - /** returns the name of the event. - */ - type?: string; -} + /** Fires when the Upload process ends in Error. */ + error?(e: ErrorEventArgs): void; -export interface BeginEventArgs { + /** Fires when the file is selected for upload successfully. */ + fileSelect?(e: FileSelectEventArgs): void; - /** To pass additional information to the server. - */ - data?: any; + /** Fires when the file is uploading. */ + inProgress?(e: InProgressEventArgs): void; - /** Selected FileList Object. - */ - files?: any; + /** Fires when the uploaded file is removed successfully. */ + remove?(e: RemoveEventArgs): void; + } - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + export interface BeforeSendEventArgs { - /** returns the Uploadbox model - */ - model?: any; + /** Selected FileList Object. + */ + files?: any; - /** returns the name of the event. - */ - type?: string; -} + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; -export interface CancelEventArgs { + /** returns the Uploadbox model + */ + model?: any; - /** Canceled FileList Object. - */ - fileStatus?: any; + /** XHR-AJAX Object for reference. + */ + xhr?: 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 BeginEventArgs { -export interface CompleteEventArgs { + /** To pass additional information to the server. + */ + data?: any; - /** AJAX event argument for reference. - */ - e?: any; + /** Selected FileList Object. + */ + files?: any; - /** Uploaded file list. - */ - files?: any; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** response from the server. - */ - responseText?: string; + /** returns the Uploadbox model + */ + model?: any; - /** XHR-AJAX Object for reference. - */ - xhr?: any; + /** returns the name of the event. + */ + type?: string; + } - /** returns the Uploadbox model - */ - model?: any; + export interface CancelEventArgs { - /** returns the name of the event. - */ - type?: string; -} + /** Canceled FileList Object. + */ + fileStatus?: any; -export interface SuccessEventArgs { + /** returns the Uploadbox model + */ + model?: any; - /** response from the server. - */ - responseText?: string; + /** returns the name of the event. + */ + type?: string; + } - /** AJAX event argument for reference. - */ - e?: any; + export interface CompleteEventArgs { - /** successfully uploaded files list. - */ - success?: any; + /** AJAX event argument for reference. + */ + e?: any; - /** Uploaded file list. - */ - files?: any; + /** Uploaded file list. + */ + files?: any; - /** XHR-AJAX Object for reference. - */ - xhr?: any; + /** response from the server. + */ + responseText?: string; - /** returns the Uploadbox model - */ - model?: any; + /** XHR-AJAX Object for reference. + */ + xhr?: any; - /** returns the name of the event. - */ - type?: string; -} + /** returns the Uploadbox model + */ + model?: any; -export interface CreateEventArgs { + /** returns the name of the event. + */ + type?: string; + } - /** returns the Uploadbox model - */ - model?: any; + export interface SuccessEventArgs { - /** returns the name of the event. - */ - type?: string; -} + /** response from the server. + */ + responseText?: string; -export interface DestroyEventArgs { + /** AJAX event argument for reference. + */ + e?: any; - /** returns the Uploadbox model - */ - model?: any; + /** successfully uploaded files list. + */ + success?: any; - /** returns the name of the event. - */ - type?: string; -} + /** Uploaded file list. + */ + files?: any; -export interface ErrorEventArgs { + /** XHR-AJAX Object for reference. + */ + xhr?: any; - /** details about the error information. - */ - error?: string; + /** returns the Uploadbox model + */ + model?: any; - /** returns the name of the event. - */ - type?: string; + /** returns the name of the event. + */ + type?: string; + } - /** error event action details. - */ - action?: string; + export interface CreateEventArgs { - /** returns the file details of the file uploaded - */ - files?: any; -} + /** returns the Uploadbox model + */ + model?: any; -export interface FileSelectEventArgs { + /** returns the name of the event. + */ + type?: string; + } - /** returns Selected FileList objects - */ - files?: any; + 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 InProgressEventArgs { + export interface ErrorEventArgs { - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** details about the error information. + */ + error?: string; - /** AJAX event argument for reference. - */ - e?: any; + /** returns the name of the event. + */ + type?: string; - /** returns Selected FileList objects - */ - files?: any; + /** error event action details. + */ + action?: string; - /** returns the Uploadbox model - */ - model?: any; + /** returns the file details of the file uploaded + */ + files?: any; + } - /** returns the current progress percentage. - */ - percentage?: any; + export interface FileSelectEventArgs { - /** returns the name of the event. - */ - type?: string; -} + /** returns Selected FileList objects + */ + files?: any; -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; + export interface InProgressEventArgs { - /** returns the file details of the file object - */ - fileStatus?: any; -} + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; -export interface ButtonText { + /** AJAX event argument for reference. + */ + e?: any; - /** Sets the text for the browse button. - */ - browse?: string; + /** returns Selected FileList objects + */ + files?: any; - /** Sets the text for the cancel button. - */ - cancel?: string; + /** returns the Uploadbox model + */ + model?: any; - /** Sets the text for the close button. - */ - Close?: string; + /** returns the current progress percentage. + */ + percentage?: any; - /** Sets the text for the Upload button inside the dialog popup. - */ - upload?: string; -} + /** returns the name of the event. + */ + type?: 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 reorderd. - * @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 a field during editing. - * @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 RemoveEventArgs { - /** Default Value: - * @Default {false} - */ - showColumnChooser?: boolean; + /** returns the Uploadbox model + */ + model?: any; - /** 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; + /** returns the name of the event. + */ + type?: string; - /** 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; + /** returns the file details of the file object + */ + fileStatus?: any; + } - /** Gets or sets a value that indicates whether to customize the sorting behavior of the grid. - */ - sortSettings?: SortSettings; + export interface ButtonText { - /** Gets or sets an object that indicates to managing the collection of stacked header rows for the grid. - * @Default {[]} - */ - stackedHeaderRows?: StackedHeaderRow[]; + /** Sets the text for the browse button. + */ + browse?: string; - /** Gets or sets an object that indicates to managing the collection of summary rows for the grid. - * @Default {[]} - */ - summaryRows?: SummaryRow[]; + /** Sets the text for the cancel button. + */ + cancel?: string; - /** Gets or sets an object that indicates whether to auto wrap the grid header or content or both - */ - textWrapSettings?: TextWrapSettings; + /** Sets the text for the close button. + */ + Close?: string; - /** Gets or sets an object that indicates whether to enable the toolbar in the grid and add toolbar items - */ - toolbarSettings?: ToolbarSettings; + /** Sets the text for the Upload button inside the dialog popup. + */ + upload?: string; + } - /** Triggered for every grid action before its starts. */ - actionBegin?(e: ActionBeginEventArgs): void; + 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; - /** Triggered for every grid action success event. */ - actionComplete?(e: ActionCompleteEventArgs): void; + /** Default Value: + * @Default {false} + */ + showColumnChooser?: boolean; - /** Triggered for every grid action server failure event. */ - actionFailure?(e: ActionFailureEventArgs): void; + /** 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; - /** Triggered when record batch add. */ - batchAdd?(e: BatchAddEventArgs): void; + /** 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; - /** Triggered when record batch delete. */ - batchDelete?(e: BatchDeleteEventArgs): void; + /** Gets or sets a value that indicates whether to customize the sorting behavior of the grid. + */ + sortSettings?: SortSettings; - /** Triggered before the batch add. */ - beforeBatchAdd?(e: BeforeBatchAddEventArgs): void; + /** Gets or sets an object that indicates to managing the collection of stacked header rows for the grid. + * @Default {[]} + */ + stackedHeaderRows?: StackedHeaderRow[]; - /** Triggered before the batch delete. */ - beforeBatchDelete?(e: BeforeBatchDeleteEventArgs): void; + /** Gets or sets an object that indicates to managing the collection of summary rows for the grid. + * @Default {[]} + */ + summaryRows?: SummaryRow[]; - /** Triggered before the batch save. */ - beforeBatchSave?(e: BeforeBatchSaveEventArgs): void; + /** Gets or sets an object that indicates whether to auto wrap the grid header or content or both + */ + textWrapSettings?: TextWrapSettings; - /** Triggered before the print. */ - beforePrint?(e: BeforePrintEventArgs): void; + /** Gets or sets an object that indicates whether to enable the toolbar in the grid and add toolbar items + */ + toolbarSettings?: ToolbarSettings; - /** Triggered before row drop in the grid */ - beforeRowDrop?(e: BeforeRowDropEventArgs): void; + /** Triggered for every grid action before its starts. */ + actionBegin?(e: ActionBeginEventArgs): void; - /** Triggered before the record is going to be edited. */ - beginEdit?(e: BeginEditEventArgs): void; + /** Triggered for every grid action success event. */ + actionComplete?(e: ActionCompleteEventArgs): void; - /** Triggered when record cell edit. */ - cellEdit?(e: CellEditEventArgs): void; + /** Triggered for every grid action server failure event. */ + actionFailure?(e: ActionFailureEventArgs): void; - /** Triggered when record cell save. */ - cellSave?(e: CellSaveEventArgs): void; + /** Triggered when record batch add. */ + batchAdd?(e: BatchAddEventArgs): void; - /** Triggered after the cell is selected. */ - cellSelected?(e: CellSelectedEventArgs): void; + /** Triggered when record batch delete. */ + batchDelete?(e: BatchDeleteEventArgs): void; - /** Triggered before the cell is going to be selected. */ - cellSelecting?(e: CellSelectingEventArgs): void; + /** Triggered before the batch add. */ + beforeBatchAdd?(e: BeforeBatchAddEventArgs): void; - /** Triggered after the cell is deselected. */ - cellDeselected?(e: CellDeselectedEventArgs): void; + /** Triggered before the batch delete. */ + beforeBatchDelete?(e: BeforeBatchDeleteEventArgs): void; - /** Triggered before the cell is going to be deselected. */ - cellDeselecting?(e: CellDeselectingEventArgs): void; + /** Triggered before the batch save. */ + beforeBatchSave?(e: BeforeBatchSaveEventArgs): void; - /** Triggered when the column is being dragged. */ - columnDrag?(e: ColumnDragEventArgs): void; + /** Triggered before the print. */ + beforePrint?(e: BeforePrintEventArgs): void; - /** Triggered when column dragging begins. */ - columnDragStart?(e: ColumnDragStartEventArgs): void; + /** Triggered before row drop in the grid */ + beforeRowDrop?(e: BeforeRowDropEventArgs): void; - /** Triggered when the column is dropped. */ - columnDrop?(e: ColumnDropEventArgs): void; + /** Triggered before the record is going to be edited. */ + beginEdit?(e: BeginEditEventArgs): void; - /** Triggered when the row is being dragged. */ - rowDrag?(e: RowDragEventArgs): void; + /** Triggered when record cell edit. */ + cellEdit?(e: CellEditEventArgs): void; - /** Triggered when row dragging begins. */ - rowDragStart?(e: RowDragStartEventArgs): void; + /** Triggered when record cell save. */ + cellSave?(e: CellSaveEventArgs): void; - /** Triggered when the row is dropped. */ - rowDrop?(e: RowDropEventArgs): void; + /** Triggered after the cell is selected. */ + cellSelected?(e: CellSelectedEventArgs): void; - /** Triggered after the column is selected. */ - columnSelected?(e: ColumnSelectedEventArgs): void; + /** Triggered before the cell is going to be selected. */ + cellSelecting?(e: CellSelectingEventArgs): void; - /** Triggered before the column is going to be selected. */ - columnSelecting?(e: ColumnSelectingEventArgs): void; + /** Triggered after the cell is deselected. */ + cellDeselected?(e: CellDeselectedEventArgs): void; - /** Triggered after the column is deselected. */ - columnDeselected?(e: ColumnDeselectedEventArgs): void; + /** Triggered before the cell is going to be deselected. */ + cellDeselecting?(e: CellDeselectingEventArgs): void; - /** Triggered before the column is going to be deselected. */ - columnDeselecting?(e: ColumnDeselectingEventArgs): void; + /** Triggered when the column is being dragged. */ + columnDrag?(e: ColumnDragEventArgs): void; - /** Triggered when context menu item is clicked */ - contextClick?(e: ContextClickEventArgs): void; + /** Triggered when column dragging begins. */ + columnDragStart?(e: ColumnDragStartEventArgs): void; - /** Triggered before the context menu is opened. */ - contextOpen?(e: ContextOpenEventArgs): void; + /** Triggered when the column is dropped. */ + columnDrop?(e: ColumnDropEventArgs): void; - /** Triggered when the grid is rendered completely. */ - create?(e: CreateEventArgs): void; + /** Triggered when the row is being dragged. */ + rowDrag?(e: RowDragEventArgs): void; - /** Triggered when the grid is bound with data during initial rendering. */ - dataBound?(e: DataBoundEventArgs): void; + /** Triggered when row dragging begins. */ + rowDragStart?(e: RowDragStartEventArgs): void; - /** Triggered when grid going to destroy. */ - destroy?(e: DestroyEventArgs): void; + /** Triggered when the row is dropped. */ + rowDrop?(e: RowDropEventArgs): void; - /** Triggered when detail template row is clicked to collapse. */ - detailsCollapse?(e: DetailsCollapseEventArgs): void; + /** Triggered after the column is selected. */ + columnSelected?(e: ColumnSelectedEventArgs): void; - /** Triggered detail template row is initialized. */ - detailsDataBound?(e: DetailsDataBoundEventArgs): void; + /** Triggered before the column is going to be selected. */ + columnSelecting?(e: ColumnSelectingEventArgs): void; - /** Triggered when detail template row is clicked to expand. */ - detailsExpand?(e: DetailsExpandEventArgs): void; + /** Triggered after the column is deselected. */ + columnDeselected?(e: ColumnDeselectedEventArgs): void; - /** Triggered after the record is added. */ - endAdd?(e: EndAddEventArgs): void; + /** Triggered before the column is going to be deselected. */ + columnDeselecting?(e: ColumnDeselectingEventArgs): void; - /** Triggered after the record is deleted. */ - endDelete?(e: EndDeleteEventArgs): void; + /** Triggered when context menu item is clicked */ + contextClick?(e: ContextClickEventArgs): void; - /** Triggered after the record is edited. */ - endEdit?(e: EndEditEventArgs): void; + /** Triggered before the context menu is opened. */ + contextOpen?(e: ContextOpenEventArgs): void; - /** Triggered initial load. */ - load?(e: LoadEventArgs): void; + /** Triggered when the grid is rendered completely. */ + create?(e: CreateEventArgs): void; - /** Triggered every time a request is made to access particular cell information, element and data. */ - mergeCellInfo?(e: MergeCellInfoEventArgs): void; + /** Triggered when the grid is bound with data during initial rendering. */ + dataBound?(e: DataBoundEventArgs): void; - /** Triggered every time a request is made to access particular cell information, element and data. */ - queryCellInfo?(e: QueryCellInfoEventArgs): void; + /** Triggered when grid going to destroy. */ + destroy?(e: DestroyEventArgs): void; - /** Triggered when record is clicked. */ - recordClick?(e: RecordClickEventArgs): void; + /** Triggered when detail template row is clicked to collapse. */ + detailsCollapse?(e: DetailsCollapseEventArgs): void; - /** Triggered when record is double clicked. */ - recordDoubleClick?(e: RecordDoubleClickEventArgs): void; + /** Triggered detail template row is initialized. */ + detailsDataBound?(e: DetailsDataBoundEventArgs): void; - /** Triggered after column resized. */ - resized?(e: ResizedEventArgs): void; + /** Triggered when detail template row is clicked to expand. */ + detailsExpand?(e: DetailsExpandEventArgs): void; - /** Triggered when column resize end. */ - resizeEnd?(e: ResizeEndEventArgs): void; + /** Triggered after the record is added. */ + endAdd?(e: EndAddEventArgs): void; - /** Triggered when column resize start. */ - resizeStart?(e: ResizeStartEventArgs): void; + /** Triggered after the record is deleted. */ + endDelete?(e: EndDeleteEventArgs): void; - /** Triggered when right clicked on grid element. */ - rightClick?(e: RightClickEventArgs): void; + /** Triggered after the record is edited. */ + endEdit?(e: EndEditEventArgs): void; - /** Triggered every time a request is made to access row information, element and data. */ - rowDataBound?(e: RowDataBoundEventArgs): void; + /** Triggered initial load. */ + load?(e: LoadEventArgs): void; - /** Triggered after the row is selected. */ - rowSelected?(e: RowSelectedEventArgs): void; + /** Triggered every time a request is made to access particular cell information, element and data. */ + mergeCellInfo?(e: MergeCellInfoEventArgs): void; - /** Triggered before the row is going to be selected. */ - rowSelecting?(e: RowSelectingEventArgs): void; + /** Triggered every time a request is made to access particular cell information, element and data. */ + queryCellInfo?(e: QueryCellInfoEventArgs): void; - /** Triggered after the row is deselected. */ - rowDeselected?(e: RowDeselectedEventArgs): void; + /** Triggered when record is clicked. */ + recordClick?(e: RecordClickEventArgs): void; - /** Triggered before the row is going to be deselected. */ - rowDeselecting?(e: RowDeselectingEventArgs): void; + /** Triggered when record is double clicked. */ + recordDoubleClick?(e: RecordDoubleClickEventArgs): void; - /** Triggered when refresh the template column elements in the Grid. */ - templateRefresh?(e: TemplateRefreshEventArgs): void; + /** Triggered after column resized. */ + resized?(e: ResizedEventArgs): void; - /** Triggered when toolbar item is clicked in grid. */ - toolbarClick?(e: ToolbarClickEventArgs): void; -} + /** Triggered when column resize end. */ + resizeEnd?(e: ResizeEndEventArgs): void; -export interface ActionBeginEventArgs { + /** Triggered when column resize start. */ + resizeStart?(e: ResizeStartEventArgs): void; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Triggered when right clicked on grid element. */ + rightClick?(e: RightClickEventArgs): void; - /** Returns the grid model. - */ - model?: any; + /** Triggered every time a request is made to access row information, element and data. */ + rowDataBound?(e: RowDataBoundEventArgs): void; - /** Returns the name of the event. - */ - type?: string; + /** Triggered after the row is selected. */ + rowSelected?(e: RowSelectedEventArgs): void; - /** Returns the current selected page number. - */ - currentPage?: number; + /** Triggered before the row is going to be selected. */ + rowSelecting?(e: RowSelectingEventArgs): void; - /** Returns the previous selected page number. - */ - previousPage?: number; + /** Triggered after the row is deselected. */ + rowDeselected?(e: RowDeselectedEventArgs): void; - /** Returns the end row index of that current page. - */ - endIndex?: number; + /** Triggered before the row is going to be deselected. */ + rowDeselecting?(e: RowDeselectingEventArgs): void; - /** Returns request type. - */ - requestType?: string; + /** Triggered when refresh the template column elements in the Grid. */ + templateRefresh?(e: TemplateRefreshEventArgs): void; - /** Returns the start row index of that current page. - */ - startIndex?: number; + /** Triggered when toolbar item is clicked in grid. */ + toolbarClick?(e: ToolbarClickEventArgs): void; + } - /** Returns the current grouped column field name. - */ - columnName?: string; + export interface ActionBeginEventArgs { - /** Returns the column sort direction. - */ - columnSortDirection?: string; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns current edited row. - */ - row?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the current action event type. - */ - originalEventType?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns primary key. - */ - primaryKey?: string; + /** Returns the current selected page number. + */ + currentPage?: number; - /** Returns primary key value. - */ - primaryKeyValue?: string; + /** Returns the previous selected page number. + */ + previousPage?: number; - /** Returns the edited row index. - */ - rowIndex?: number; + /** Returns the end row index of that current page. + */ + endIndex?: number; - /** Returns the record object (JSON). - */ - data?: any; + /** Returns request type. + */ + requestType?: string; - /** Returns the foreign key record object (JSON). - */ - foreignKeyData?: any; + /** Returns the start row index of that current page. + */ + startIndex?: number; - /** Returns the selected row index. - */ - selectedRow?: number; + /** Returns the current grouped column field name. + */ + columnName?: string; - /** Returns selected row for delete. - */ - tr?: any; + /** Returns the column sort direction. + */ + columnSortDirection?: string; - /** Returns current filtering column field name. - */ - currentFilteringColumn?: any; + /** Returns current edited row. + */ + row?: any; - /** Returns current filtering object. - */ - currentFilterObject?: any; + /** Returns the current action event type. + */ + originalEventType?: string; - /** Returns filter details. - */ - filterCollection?: any; + /** Returns primary key. + */ + primaryKey?: string; - /** Returns type of the column like number, string and so on. - */ - columnType?: string; + /** Returns primary key value. + */ + primaryKeyValue?: string; - /** Returns the excel filter model. - */ - filtermodel?: any; + /** Returns the edited row index. + */ + rowIndex?: number; - /** Returns the dataSource. - */ - dataSource?: any; + /** Returns the record object (JSON). + */ + data?: any; - /** Returns the query manager. - */ - query?: any; + /** Returns the foreign key record object (JSON). + */ + foreignKeyData?: any; - /** Returns the customfilter option value. - */ - isCustomFilter?: boolean; -} + /** Returns the selected row index. + */ + selectedRow?: number; -export interface ActionCompleteEventArgs { + /** Returns selected row for delete. + */ + tr?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns current filtering column field name. + */ + currentFilteringColumn?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns current filtering object. + */ + currentFilterObject?: any; - /** Returns request type. - */ - requestType?: string; + /** Returns filter details. + */ + filterCollection?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns type of the column like number, string and so on. + */ + columnType?: string; - /** Returns the current selected page number. - */ - currentPage?: number; + /** Returns the excel filter model. + */ + filtermodel?: any; - /** Returns the previous selected page number. - */ - previousPage?: number; + /** Returns the dataSource. + */ + dataSource?: any; - /** Returns the end row index of that current page. - */ - endIndex?: number; + /** Returns the query manager. + */ + query?: any; - /** Returns current action event type. - */ - originalEventType?: string; + /** Returns the customfilter option value. + */ + isCustomFilter?: boolean; + } - /** Returns the start row index of the current page. - */ - startIndex?: number; + export interface ActionCompleteEventArgs { - /** Returns grid element. - */ - target?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the current sorted column field name. - */ - columnName?: string; + /** Returns the grid model. + */ + model?: any; - /** Returns the column sort direction. - */ - columnSortDirection?: string; + /** Returns request type. + */ + requestType?: string; - /** Returns current edited row. - */ - row?: any; + /** Returns the name of the event. + */ + type?: string; - /** Returns primary key. - */ - primaryKey?: string; + /** Returns the current selected page number. + */ + currentPage?: number; - /** Returns primary key value. - */ - primaryKeyValue?: string; + /** Returns the previous selected page number. + */ + previousPage?: number; - /** Returns the edited row index. - */ - rowIndex?: number; + /** Returns the end row index of that current page. + */ + endIndex?: number; - /** Returns the record object (JSON). - */ - data?: any; + /** Returns current action event type. + */ + originalEventType?: string; - /** Returns the selectedRow index. - */ - selectedRow?: number; + /** Returns the start row index of the current page. + */ + startIndex?: number; - /** Returns the foreign key record object (JSON). - */ - foreignKeyData?: any; + /** Returns grid element. + */ + target?: any; - /** Returns selected row for delete. - */ - tr?: any; + /** Returns the current sorted column field name. + */ + columnName?: string; - /** Returns current filtering column field name. - */ - currentFilteringColumn?: string; + /** Returns the column sort direction. + */ + columnSortDirection?: string; - /** Returns current filtering object. - */ - currentFilterObject?: any; + /** Returns current edited row. + */ + row?: any; - /** Returns filter details. - */ - filterCollection?: any; + /** Returns primary key. + */ + primaryKey?: string; - /** Returns the dataSource. - */ - dataSource?: any; + /** Returns primary key value. + */ + primaryKeyValue?: string; - /** Returns the excel filter model. - */ - filtermodel?: any; + /** Returns the edited row index. + */ + rowIndex?: number; - /** Returns type of the column like number, string and so on. - */ - columnType?: string; + /** Returns the record object (JSON). + */ + data?: any; - /** Returns the customfilter option value. - */ - isCustomFilter?: boolean; -} + /** Returns the selectedRow index. + */ + selectedRow?: number; -export interface ActionFailureEventArgs { + /** Returns the foreign key record object (JSON). + */ + foreignKeyData?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns selected row for delete. + */ + tr?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns current filtering column field name. + */ + currentFilteringColumn?: string; - /** Returns request type. - */ - requestType?: string; + /** Returns current filtering object. + */ + currentFilterObject?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns filter details. + */ + filterCollection?: any; - /** Returns the error return by server. - */ - error?: any; + /** Returns the dataSource. + */ + dataSource?: any; - /** Returns the current selected page number. - */ - currentPage?: number; + /** Returns the excel filter model. + */ + filtermodel?: any; - /** Returns the previous selected page number. - */ - previousPage?: number; + /** Returns type of the column like number, string and so on. + */ + columnType?: string; - /** Returns the end row index of that current page. - */ - endIndex?: number; + /** Returns the customfilter option value. + */ + isCustomFilter?: boolean; + } - /** Returns current action event type. - */ - originalEventType?: string; + export interface ActionFailureEventArgs { - /** Returns the start row index of the current page. - */ - startIndex?: number; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns grid element. - */ - target?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the current sorted column field name. - */ - columnName?: string; + /** Returns request type. + */ + requestType?: string; - /** Returns the column sort direction. - */ - columnSortDirection?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns current edited row. - */ - row?: any; + /** Returns the error return by server. + */ + error?: any; - /** Returns primary key. - */ - primaryKey?: string; + /** Returns the current selected page number. + */ + currentPage?: number; - /** Returns primary key value. - */ - primaryKeyValue?: string; + /** Returns the previous selected page number. + */ + previousPage?: number; - /** Returns the edited row index. - */ - rowIndex?: number; + /** Returns the end row index of that current page. + */ + endIndex?: number; - /** Returns the record object (JSON). - */ - data?: any; + /** Returns current action event type. + */ + originalEventType?: string; - /** Returns the selectedRow index. - */ - selectedRow?: number; + /** Returns the start row index of the current page. + */ + startIndex?: number; - /** Returns the foreign key record object (JSON). - */ - foreignKeyData?: any; + /** Returns grid element. + */ + target?: any; - /** Returns selected row for delete. - */ - tr?: any; + /** Returns the current sorted column field name. + */ + columnName?: string; - /** Returns current filtering column field name. - */ - currentFilteringColumn?: string; + /** Returns the column sort direction. + */ + columnSortDirection?: string; - /** Returns current filtering object. - */ - currentFilterObject?: any; + /** Returns current edited row. + */ + row?: any; - /** Returns filter details. - */ - filterCollection?: any; -} + /** Returns primary key. + */ + primaryKey?: string; -export interface BatchAddEventArgs { + /** Returns primary key value. + */ + primaryKeyValue?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the edited row index. + */ + rowIndex?: number; - /** Returns the grid model. - */ - model?: any; + /** Returns the record object (JSON). + */ + data?: any; - /** Returns deleted data. - */ - data?: any; + /** Returns the selectedRow index. + */ + selectedRow?: number; - /** Returns the name of the event. - */ - type?: string; + /** Returns the foreign key record object (JSON). + */ + foreignKeyData?: any; - /** Returns the column object. - */ - columnObject?: any; + /** Returns selected row for delete. + */ + tr?: any; - /** Returns the column index. - */ - columnIndex?: number; + /** Returns current filtering column field name. + */ + currentFilteringColumn?: string; - /** Returns the row element. - */ - row?: any; + /** Returns current filtering object. + */ + currentFilterObject?: any; - /** Returns the primaryKey. - */ - primaryKey?: any; + /** Returns filter details. + */ + filterCollection?: any; + } - /** Returns the cell object. - */ - cell?: any; -} + export interface BatchAddEventArgs { -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 column object. + */ + columnObject?: any; - /** Returns the primary key. - */ - primaryKey?: any; + /** Returns the column index. + */ + columnIndex?: number; - /** Returns the row Index. - */ - rowIndex?: number; -} + /** Returns the row element. + */ + row?: any; -export interface BeforeBatchAddEventArgs { + /** Returns the primaryKey. + */ + primaryKey?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cell object. + */ + cell?: any; + } - /** Returns the grid model. - */ - model?: any; + export interface BatchDeleteEventArgs { - /** Returns deleted data. - */ - data?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the name of the event. - */ - type?: string; + /** Returns the grid model. + */ + model?: any; - /** Returns the default data object. - */ - defaultData?: any; + /** Returns deleted data. + */ + data?: any; - /** Returns the primaryKey. - */ - primaryKey?: any; -} + /** Returns the name of the event. + */ + type?: string; -export interface BeforeBatchDeleteEventArgs { + /** Returns the primary key. + */ + primaryKey?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the row Index. + */ + rowIndex?: number; + } - /** Returns deleted data. - */ - data?: any; + export interface BeforeBatchAddEventArgs { - /** Returns the name of the event. - */ - type?: string; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the primaryKey. - */ - primaryKey?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the row index. - */ - rowIndex?: number; + /** Returns deleted data. + */ + data?: any; - /** Returns the row data. - */ - rowData?: any; + /** Returns the name of the event. + */ + type?: string; - /** Returns the row element. - */ - row?: any; -} + /** Returns the default data object. + */ + defaultData?: any; -export interface BeforeBatchSaveEventArgs { + /** Returns the primaryKey. + */ + primaryKey?: any; + } - /** Returns the grid model. - */ - model?: any; + export interface BeforeBatchDeleteEventArgs { - /** Returns deleted data. - */ - data?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns deleted data. + */ + data?: any; - /** Returns the changed record object. - */ - batchChanges?: any; -} + /** Returns the name of the event. + */ + type?: string; -export interface BeforePrintEventArgs { + /** Returns the primaryKey. + */ + primaryKey?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the row index. + */ + rowIndex?: number; - /** Returns the name of the event. - */ - type?: string; + /** Returns the row data. + */ + rowData?: any; - /** Returns the Grid element. - */ - element?: any; + /** Returns the row element. + */ + row?: any; + } - /** Returns the selected records. - */ - selectedRows?: any; -} + export interface BeforeBatchSaveEventArgs { -export interface BeforeRowDropEventArgs { + /** Returns the grid model. + */ + model?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns deleted data. + */ + data?: any; - /** Returns the targeted row. - */ - target?: any; + /** Returns the name of the event. + */ + type?: string; - /** Returns the targeted row index. - */ - targetIndex?: any; + /** Returns the changed record object. + */ + batchChanges?: any; + } - /** Returns the dragged record details - */ - draggedRecords?: any; + export interface BeforePrintEventArgs { - /** Returns the drop details - */ - dropDetails?: any; -} + /** Returns the grid model. + */ + model?: any; -export interface BeginEditEventArgs { + /** Returns the name of the event. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the Grid element. + */ + element?: any; - /** Returns the current edited row. - */ - row?: any; + /** Returns the selected records. + */ + selectedRows?: any; + } - /** Returns the grid model. - */ - model?: any; + export interface BeforeRowDropEventArgs { - /** Returns the primary key. - */ - primaryKey?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the primary key value. - */ - primaryKeyValue?: any; + /** Returns the targeted row. + */ + target?: any; - /** Returns the edited row index. - */ - rowIndex?: number; + /** Returns the targeted row index. + */ + targetIndex?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the dragged record details + */ + draggedRecords?: any; -export interface CellEditEventArgs { + /** Returns the drop details + */ + dropDetails?: any; + } - /** Returns the grid model. - */ - model?: any; + export interface BeginEditEventArgs { - /** Returns deleted data. - */ - data?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the name of the event. - */ - type?: string; + /** Returns the current edited row. + */ + row?: any; - /** Returns the validation rules. - */ - validationRules?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the column name. - */ - columnName?: string; + /** Returns the primary key. + */ + primaryKey?: any; - /** Returns the cell value. - */ - value?: string; + /** Returns the primary key value. + */ + primaryKeyValue?: any; - /** Returns the row data object. - */ - rowData?: any; + /** Returns the edited row index. + */ + rowIndex?: number; - /** Returns the previous value of the cell. - */ - previousValue?: string; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the column object. - */ - columnObject?: any; + export interface CellEditEventArgs { - /** Returns the cell object. - */ - cell?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns isForeignKey option value. - */ - isForeignKey?: boolean; -} + /** Returns deleted data. + */ + data?: any; -export interface CellSaveEventArgs { + /** Returns the name of the event. + */ + type?: string; - /** Returns the grid model. - */ - model?: any; + /** Returns the validation rules. + */ + validationRules?: any; - /** Returns deleted data. - */ - data?: any; + /** Returns the column name. + */ + columnName?: string; - /** Returns the name of the event. - */ - type?: string; + /** Returns the cell value. + */ + value?: string; - /** Returns the column name. - */ - columnName?: string; + /** Returns the row data object. + */ + rowData?: any; - /** Returns the cell value. - */ - value?: string; + /** Returns the previous value of the cell. + */ + previousValue?: string; - /** Returns the row data object. - */ - rowData?: any; + /** Returns the column object. + */ + columnObject?: any; - /** Returns the previous value of the cell. - */ - previousValue?: string; + /** Returns the cell object. + */ + cell?: any; - /** Returns the column object. - */ - columnObject?: any; + /** Returns isForeignKey option value. + */ + isForeignKey?: boolean; + } - /** Returns the cell object. - */ - cell?: any; + export interface CellSaveEventArgs { - /** Returns isForeignKey option value. - */ - isForeignKey?: boolean; -} + /** Returns the grid model. + */ + model?: any; -export interface CellSelectedEventArgs { + /** Returns deleted data. + */ + data?: any; - /** Returns the selected cell index value. - */ - cellIndex?: number; + /** Returns the name of the event. + */ + type?: string; - /** Returns the previous selected cell index value. - */ - previousRowCellIndex?: number; + /** Returns the column name. + */ + columnName?: string; - /** Returns the selected cell element. - */ - currentCell?: any; + /** Returns the cell value. + */ + value?: string; - /** Returns the previous selected cell element. - */ - previousRowCell?: any; + /** Returns the row data object. + */ + rowData?: any; - /** Returns current record object (JSON). - */ - data?: any; + /** Returns the previous value of the cell. + */ + previousValue?: string; - /** Returns the selected row cell index values. - */ - selectedRowCellIndex?: any[]; + /** Returns the column object. + */ + columnObject?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cell object. + */ + cell?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns isForeignKey option value. + */ + isForeignKey?: boolean; + } - /** Returns the name of the event. - */ - type?: string; -} + export interface CellSelectedEventArgs { -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 the selected row cell index values. + */ + selectedRowCellIndex?: any[]; - /** Returns whether the ctrl key is pressed while selecting cell - */ - isCtrlKeyPressed?: boolean; + /** Returns the cancel option value. + */ + cancel?: 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 CellSelectingEventArgs { -export interface CellDeselectedEventArgs { + /** Returns the selected cell index value. + */ + cellIndex?: number; - /** Returns the deselected cell index value. - */ - cellIndex?: number; + /** Returns the previous selected cell index value. + */ + previousRowCellIndex?: number; - /** Returns the deselected cell element. - */ - currentCell?: any; + /** Returns the selected cell element. + */ + currentCell?: any; - /** Returns current record object (JSON). - */ - data?: any; + /** Returns the previous selected cell element. + */ + previousRowCell?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns current record object (JSON). + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns whether the ctrl key is pressed while selecting cell + */ + isCtrlKeyPressed?: boolean; -export interface CellDeselectingEventArgs { + /** Returns whether the shift key is pressed while selecting cell + */ + isShiftKeyPressed?: boolean; - /** Returns the deselecting cell index value. - */ - cellIndex?: number; + /** Returns the grid model. + */ + model?: any; - /** Returns the deselecting cell element. - */ - currentCell?: any; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns current record object (JSON). - */ - data?: any; + export interface CellDeselectedEventArgs { - /** Returns whether the ctrl key is pressed while deselecting cell - */ - isCtrlKeyPressed?: boolean; + /** Returns the deselected cell index value. + */ + cellIndex?: number; - /** Returns whether the shift key is pressed while deselecting cell - */ - isShiftKeyPressed?: boolean; + /** Returns the deselected cell element. + */ + currentCell?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns current record object (JSON). + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the grid model. + */ + model?: any; -export interface ColumnDragEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface CellDeselectingEventArgs { - /** Returns draggable element type. - */ - draggableType?: any; + /** Returns the deselecting cell index value. + */ + cellIndex?: number; - /** Returns the draggable column object. - */ - column?: any; + /** Returns the deselecting cell element. + */ + currentCell?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns current record object (JSON). + */ + data?: any; - /** Returns target elements based on mouse move position. - */ - target?: any; + /** Returns whether the ctrl key is pressed while deselecting cell + */ + isCtrlKeyPressed?: boolean; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns whether the shift key is pressed while deselecting cell + */ + isShiftKeyPressed?: boolean; -export interface ColumnDragStartEventArgs { + /** Returns the grid model. + */ + model?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns draggable element type. - */ - draggableType?: any; + export interface ColumnDragEventArgs { - /** Returns the draggable column object. - */ - column?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the grid model. - */ - model?: any; + /** Returns draggable element type. + */ + draggableType?: any; - /** Returns drag start element. - */ - target?: any; + /** Returns the draggable column object. + */ + column?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the grid model. + */ + model?: any; -export interface ColumnDropEventArgs { + /** Returns target elements based on mouse move position. + */ + target?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns draggable element type. - */ - draggableType?: string; + export interface ColumnDragStartEventArgs { - /** Returns the draggable column object. - */ - column?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the grid model. - */ - model?: any; + /** Returns draggable element type. + */ + draggableType?: any; - /** Returns dropped dragged element. - */ - target?: any; + /** Returns the draggable column object. + */ + column?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the grid model. + */ + model?: any; -export interface RowDragEventArgs { + /** Returns drag start element. + */ + target?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns draggable element type. - */ - draggableType?: any; + export interface ColumnDropEventArgs { - /** Returns the draggable row object. - */ - target?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the grid model. - */ - model?: any; + /** Returns draggable element type. + */ + draggableType?: string; - /** Returns target elements based on mouse move position. - */ - currentTarget?: any; + /** Returns the draggable column object. + */ + column?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the grid model. + */ + model?: any; - /** Returns JSON data of dragged rows. - */ - data?: any; -} + /** Returns dropped dragged element. + */ + target?: any; -export interface RowDragStartEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface RowDragEventArgs { - /** Returns draggable element type. - */ - draggableType?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the draggable row object. - */ - target?: any; + /** Returns draggable element type. + */ + draggableType?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the draggable row object. + */ + target?: any; - /** Returns drag start element cell. - */ - currentTarget?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns target elements based on mouse move position. + */ + currentTarget?: any; - /** Returns the JSON data of dragged rows. - */ - data?: any; -} + /** Returns the name of the event. + */ + type?: string; -export interface RowDropEventArgs { + /** Returns JSON data of dragged rows. + */ + data?: any; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface RowDragStartEventArgs { - /** Returns draggable element type. - */ - draggableType?: string; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the draggable row object. - */ - rows?: any; + /** Returns draggable element type. + */ + draggableType?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the draggable row object. + */ + target?: any; - /** Returns the current mouse position cell element. - */ - target?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns drag start element cell. + */ + currentTarget?: any; - /** Returns the JSON data of dragged rows. - */ - data?: any; -} + /** Returns the name of the event. + */ + type?: string; -export interface ColumnSelectedEventArgs { + /** Returns the JSON data of dragged rows. + */ + data?: any; + } - /** Returns the selected cell index value. - */ - columnIndex?: number; + export interface RowDropEventArgs { - /** Returns the previous selected column index value. - */ - previousColumnIndex?: number; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the selected header cell element. - */ - headerCell?: any; + /** Returns draggable element type. + */ + draggableType?: string; - /** Returns the previous selected header cell element. - */ - prevColumnHeaderCell?: any; + /** Returns the draggable row object. + */ + rows?: any; - /** Returns corresponding column object (JSON). - */ - column?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the selected columns values. - */ - selectedColumnsIndex?: any[]; + /** Returns the current mouse position cell element. + */ + target?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the name of the event. + */ + type?: string; - /** Returns the grid model. - */ - model?: any; + /** Returns the JSON data of dragged rows. + */ + data?: any; + } - /** Returns the name of the event. - */ - type?: string; -} + export interface ColumnSelectedEventArgs { -export interface ColumnSelectingEventArgs { + /** Returns the selected cell 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 the selected columns values. + */ + selectedColumnsIndex?: any[]; - /** Returns whether the ctrl key is pressed while selecting cell - */ - isCtrlKeyPressed?: boolean; + /** Returns the cancel option value. + */ + cancel?: 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 ColumnSelectingEventArgs { -export interface ColumnDeselectedEventArgs { + /** Returns the selected column index value. + */ + columnIndex?: number; - /** Returns the Deselected column index value. - */ - columnIndex?: number; + /** Returns the previous selected column index value. + */ + previousColumnIndex?: number; - /** Returns the Deselected column header element. - */ - headerCell?: any; + /** Returns the selected header cell element. + */ + headerCell?: any; - /** Returns corresponding column object (JSON). - */ - column?: any; + /** Returns the previous selected header cell element. + */ + prevColumnHeaderCell?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns corresponding column object (JSON). + */ + column?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns whether the ctrl key is pressed while selecting cell + */ + isCtrlKeyPressed?: boolean; -export interface ColumnDeselectingEventArgs { + /** Returns whether the shift key is pressed while selecting cell + */ + isShiftKeyPressed?: boolean; - /** Returns the deselecting column index value. - */ - columnIndex?: number; + /** Returns the grid model. + */ + model?: any; - /** Returns the deselecting column header element. - */ - headerCell?: any; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns corresponding column object (JSON). - */ - column?: any; + export interface ColumnDeselectedEventArgs { - /** Returns whether the ctrl key is pressed while deselecting column - */ - isCtrlKeyPressed?: boolean; + /** Returns the Deselected column index value. + */ + columnIndex?: number; - /** Returns whether the shift key is pressed while deselecting column - */ - isShiftKeyPressed?: boolean; + /** Returns the Deselected column header element. + */ + headerCell?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns corresponding column object (JSON). + */ + column?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the grid model. + */ + model?: any; -export interface ContextClickEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface ColumnDeselectingEventArgs { - /** Returns the current item. - */ - currentTarget?: any; + /** Returns the deselecting column index value. + */ + columnIndex?: number; - /** Returns the grid model. - */ - model?: any; + /** Returns the deselecting column header element. + */ + headerCell?: any; - /** Returns the status of contextmenu item which denotes its enabled state - */ - status?: boolean; + /** Returns corresponding column object (JSON). + */ + column?: any; - /** Returns the target item. - */ - target?: any; + /** Returns whether the ctrl key is pressed while deselecting column + */ + isCtrlKeyPressed?: boolean; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns whether the shift key is pressed while deselecting column + */ + isShiftKeyPressed?: boolean; -export interface ContextOpenEventArgs { + /** Returns the grid model. + */ + model?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the current item. - */ - currentTarget?: any; + export interface ContextClickEventArgs { - /** Returns the grid model. - */ - model?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the status of contextmenu item which denotes its enabled state - */ - status?: boolean; + /** Returns the current item. + */ + currentTarget?: any; - /** Returns the target item. - */ - target?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the status of contextmenu item which denotes its enabled state + */ + status?: boolean; -export interface CreateEventArgs { + /** Returns the target item. + */ + target?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the grid model. - */ - model?: any; + export interface ContextOpenEventArgs { - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the cancel option value. + */ + cancel?: boolean; -export interface DataBoundEventArgs { + /** Returns the current item. + */ + currentTarget?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** 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 name of the event. - */ - type?: string; -} + /** Returns the target item. + */ + target?: any; -export interface DestroyEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the grid model. - */ - model?: any; + export interface CreateEventArgs { - /** Returns deleted data. - */ - data?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the grid model. + */ + model?: any; -export interface DetailsCollapseEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface DataBoundEventArgs { - /** Returns detail row element. - */ - detailsRow?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns master row of detail row record object (JSON). - */ - masterData?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the foreign key record object (JSON). - */ - foreignKeyData?: any; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns master row element. - */ - masterRow?: any; + export interface DestroyEventArgs { - /** Returns the grid model. - */ - model?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns deleted data. + */ + data?: any; -export interface DetailsDataBoundEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface DetailsCollapseEventArgs { - /** Returns details row element. - */ - detailsElement?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the details row data. - */ - data?: any; + /** Returns detail row element. + */ + detailsRow?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns master row of detail row record object (JSON). + */ + masterData?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the foreign key record object (JSON). + */ + foreignKeyData?: any; -export interface DetailsExpandEventArgs { + /** Returns master row element. + */ + masterRow?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the grid model. + */ + model?: any; - /** Returns detail row element. - */ - detailsRow?: any; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns master row of detail row record object (JSON). - */ - masterData?: any; + export interface DetailsDataBoundEventArgs { - /** Returns the foreign key record object (JSON). - */ - foreignKeyData?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns master row element. - */ - masterRow?: any; + /** Returns details row element. + */ + detailsElement?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the details row data. + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the grid model. + */ + model?: any; -export interface EndAddEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the grid model. - */ - model?: any; + export interface DetailsExpandEventArgs { - /** Returns added data. - */ - data?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns detail row element. + */ + detailsRow?: any; -export interface EndDeleteEventArgs { + /** Returns master row of detail row record object (JSON). + */ + masterData?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the foreign key record object (JSON). + */ + foreignKeyData?: any; - /** Returns deleted data. - */ - data?: any; + /** Returns master row element. + */ + masterRow?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the grid model. + */ + model?: any; -export interface EndEditEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the grid model. - */ - model?: any; + export interface EndAddEventArgs { - /** Returns modified data. - */ - data?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns added data. + */ + data?: any; -export interface LoadEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the grid model. - */ - model?: any; + export interface EndDeleteEventArgs { - /** Returns deleted data. - */ - data?: any; + /** 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 name of the event. + */ + type?: string; + } -export interface MergeCellInfoEventArgs { + export interface EndEditEventArgs { - /** Returns grid cell. - */ - cell?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns modified data. + */ + data?: any; - /** Returns current row record object (JSON). - */ - data?: any; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the text value in the cell. - */ - text?: string; + export interface LoadEventArgs { - /** Returns the column object. - */ - column?: any; + /** Returns the grid model. + */ + model?: any; - /** Method to merge Grid rows. - */ - rowMerge?: any; + /** Returns deleted data. + */ + data?: any; - /** Method to merge Grid columns. - */ - colMerge?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Method to merge Grid rows and columns. - */ - merge?: any; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the grid model. - */ - model?: any; + export interface MergeCellInfoEventArgs { - /** Returns the name of the event. - */ - type?: string; -} + /** Returns grid cell. + */ + cell?: any; -export interface QueryCellInfoEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns grid cell. - */ - cell?: any; + /** Returns current row record object (JSON). + */ + data?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the text value in the cell. + */ + text?: string; - /** Returns current row record object (JSON). - */ - data?: any; + /** Returns the column object. + */ + column?: any; - /** Returns the text value in the cell. - */ - text?: string; + /** Method to merge Grid rows. + */ + rowMerge?: any; - /** Returns the column object. - */ - column?: any; + /** Method to merge Grid columns. + */ + colMerge?: any; - /** Returns the foreign key record object (JSON). - */ - foreignKeyData?: 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 RecordClickEventArgs { + export interface QueryCellInfoEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns grid cell. + */ + cell?: any; - /** Returns current record object (JSON). - */ - data?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the row index of the selected row. - */ - rowIndex?: number; + /** Returns current row record object (JSON). + */ + data?: any; - /** Returns the jQuery object of the current selected row. - */ - row?: any; + /** Returns the text value in the cell. + */ + text?: string; - /** Returns the current selected cell. - */ - cell?: any; + /** Returns the column object. + */ + column?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the foreign key record object (JSON). + */ + foreignKeyData?: any; - /** Returns the cell index value. - */ - cellIndex?: number; + /** Returns the grid model. + */ + model?: any; - /** Returns the corresponding cell value. - */ - cellValue?: string; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the Header text of the column corresponding to the selected cell. - */ - columnName?: string; + export interface RecordClickEventArgs { - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the cancel option value. + */ + cancel?: boolean; -export interface RecordDoubleClickEventArgs { + /** Returns current record object (JSON). + */ + data?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the row index of the selected row. + */ + rowIndex?: number; - /** Returns current record object (JSON). - */ - data?: any; + /** Returns the jQuery object of the current selected row. + */ + row?: any; - /** Returns the row index of the selected row. - */ - rowIndex?: number; + /** Returns the current selected cell. + */ + cell?: any; - /** Returns the jQuery object of the current selected row. - */ - row?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the current selected cell. - */ - cell?: any; + /** Returns the cell index value. + */ + cellIndex?: number; - /** Returns the grid model. - */ - model?: any; + /** Returns the corresponding cell value. + */ + cellValue?: string; - /** Returns the selected cell index value. - */ - cellIndex?: number; + /** Returns the Header text of the column corresponding to the selected cell. + */ + columnName?: string; - /** Returns the corresponding cell value. - */ - cellValue?: string; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the Header text of the column corresponding to the selected cell. - */ - columnName?: string; + export interface RecordDoubleClickEventArgs { - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the cancel option value. + */ + cancel?: boolean; -export interface ResizedEventArgs { + /** Returns current record object (JSON). + */ + data?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the row index of the selected row. + */ + rowIndex?: number; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the jQuery object of the current selected row. + */ + row?: any; - /** Returns deleted data. - */ - data?: any; + /** Returns the current selected cell. + */ + cell?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the grid model. + */ + model?: any; - /** Returns the column index. - */ - columnIndex?: number; + /** Returns the selected cell index value. + */ + cellIndex?: number; - /** Returns the column object. - */ - column?: any; + /** Returns the corresponding cell value. + */ + cellValue?: string; - /** Returns the grid object. - */ - target?: any; + /** Returns the Header text of the column corresponding to the selected cell. + */ + columnName?: string; - /** Returns the old width value. - */ - oldWidth?: number; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the new width value. - */ - newWidth?: number; -} + export interface ResizedEventArgs { -export interface ResizeEndEventArgs { + /** Returns the grid model. + */ + model?: any; - /** Returns the grid model. - */ - model?: any; + /** 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; + } - /** Returns the extra width value. - */ - extra?: number; -} + export interface ResizeEndEventArgs { -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; -} + /** Returns the new width value. + */ + newWidth?: number; -export interface RightClickEventArgs { + /** Returns the extra width value. + */ + extra?: number; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface ResizeStartEventArgs { - /** Returns current record object (JSON). - */ - currentData?: any; + /** Returns the grid model. + */ + model?: any; - /** Returns the row index of the selected row. - */ - rowIndex?: number; + /** Returns deleted data. + */ + data?: any; - /** Returns the current selected row. - */ - row?: any; + /** Returns the name of the event. + */ + type?: string; - /** Returns the selected row data object. - */ - data?: any; + /** Returns the column index. + */ + columnIndex?: number; - /** Returns the cell index of the selected cell. - */ - cellIndex?: number; + /** Returns the column object. + */ + column?: any; - /** Returns the cell value. - */ - cellValue?: string; + /** Returns the grid object. + */ + target?: any; - /** Returns the cell object. - */ - cell?: any; + /** Returns the old width value. + */ + oldWidth?: number; + } - /** Returns the grid model. - */ - model?: any; + export interface RightClickEventArgs { - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the cancel option value. + */ + cancel?: boolean; -export interface RowDataBoundEventArgs { + /** Returns current record object (JSON). + */ + currentData?: any; - /** Returns grid row. - */ - row?: any; + /** Returns the row index of the selected row. + */ + rowIndex?: number; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the current selected row. + */ + row?: any; - /** Returns current row record object (JSON). - */ - data?: any; + /** Returns the selected row data object. + */ + data?: any; - /** Returns the foreign key record object (JSON). - */ - foreignKeyData?: any; + /** Returns the cell index of the selected cell. + */ + cellIndex?: number; - /** Returns the grid model. - */ - model?: any; + /** Returns the cell value. + */ + cellValue?: string; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the cell object. + */ + cell?: any; -export interface RowSelectedEventArgs { + /** Returns the grid model. + */ + model?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns current record object (JSON). - */ - data?: any; + export interface RowDataBoundEventArgs { - /** Returns the foreign key record object (JSON). - */ - foreignKeyData?: any; + /** Returns grid row. + */ + row?: any; - /** Returns the row index of the selected row. - */ - rowIndex?: number; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the current selected row. - */ - row?: any; + /** Returns current row record object (JSON). + */ + data?: any; - /** Returns the previous selected row element. - */ - prevRow?: any; + /** Returns the foreign key record object (JSON). + */ + foreignKeyData?: any; - /** 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 RowSelectedEventArgs { -export interface RowSelectingEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the selected row index value. - */ - rowIndex?: number; + /** Returns current record object (JSON). + */ + data?: any; - /** Returns the selected row element. - */ - row?: any; + /** Returns the foreign key record object (JSON). + */ + foreignKeyData?: any; - /** Returns the previous selected row element. - */ - prevRow?: any; + /** Returns the row index of the selected row. + */ + rowIndex?: number; - /** Returns the previous selected row index. - */ - prevRowIndex?: number; + /** Returns the current selected row. + */ + row?: any; - /** Returns current record object (JSON). - */ - data?: any; + /** Returns the previous selected row element. + */ + prevRow?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** 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 RowDeselectedEventArgs { + export interface RowSelectingEventArgs { - /** Returns current record object (JSON). - */ - data?: any; + /** Returns the selected row index value. + */ + rowIndex?: number; - /** Returns the row index of the deselected row. - */ - rowIndex?: number; + /** Returns the selected row element. + */ + row?: any; - /** Returns the current deselected row element. - */ - row?: any; + /** Returns the previous selected row element. + */ + prevRow?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns the previous selected row index. + */ + prevRowIndex?: number; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns current record object (JSON). + */ + data?: any; -export interface RowDeselectingEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the deselecting row index value. - */ - rowIndex?: number; + /** Returns the grid model. + */ + model?: any; - /** Returns the deselecting row element. - */ - row?: any; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns current record object (JSON). - */ - data?: any; + export interface RowDeselectedEventArgs { - /** Returns whether the ctrl key is pressed while deselecting row - */ - isCtrlKeyPressed?: boolean; + /** Returns current record object (JSON). + */ + data?: any; - /** Returns whether the shift key is pressed while deselecting row - */ - isShiftKeyPressed?: boolean; + /** Returns the row index of the deselected row. + */ + rowIndex?: number; - /** Returns the grid model. - */ - model?: any; + /** Returns the current deselected row element. + */ + row?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the grid model. + */ + model?: any; -export interface TemplateRefreshEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface RowDeselectingEventArgs { - /** Returns the cell object. - */ - cell?: any; + /** Returns the deselecting row index value. + */ + rowIndex?: number; - /** Returns the column object. - */ - column?: any; + /** Returns the deselecting row element. + */ + row?: any; - /** Returns the current row data. - */ - data?: any; + /** Returns current record object (JSON). + */ + data?: any; - /** Returns the grid model. - */ - model?: any; + /** Returns whether the ctrl key is pressed while deselecting row + */ + isCtrlKeyPressed?: boolean; - /** Returns the current row index. - */ - rowIndex?: number; + /** Returns whether the shift key is pressed while deselecting row + */ + isShiftKeyPressed?: boolean; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the grid model. + */ + model?: any; -export interface ToolbarClickEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface TemplateRefreshEventArgs { - /** Returns the current item. - */ - currentTarget?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the grid model. - */ - model?: any; + /** Returns the cell object. + */ + cell?: 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 column object. + */ + column?: any; - /** 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; + /** Returns the current row data. + */ + data?: any; - /** Gets or sets a value that indicates to add the template for the summary value of dataMember given. - * @Default {null} - */ - template?: string; -} + /** Returns the grid model. + */ + model?: any; -export interface SummaryRow { + /** Returns the current row index. + */ + rowIndex?: number; - /** 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; + /** Returns the name of the event. + */ + type?: string; + } - /** 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; + export interface ToolbarClickEventArgs { - /** 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; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Gets or sets a value that indicates whether to add summary columns into the summary rows. - * @Default {[]} - */ - summaryColumns?: SummaryRowsSummaryColumn[]; + /** Returns the current item. + */ + currentTarget?: any; - /** This specifies the grid to show the title for the summary rows. - */ - title?: string; + /** Returns the grid model. + */ + model?: any; - /** This specifies the grid to show the title of summary row in the specified column. - * @Default {null} - */ - titleColumn?: 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; -export interface TextWrapSettings { + /** 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; - /** 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; -} + /** Gets or sets a value that indicates to add the template for the summary value of dataMember given. + * @Default {null} + */ + template?: string; + } -export interface ToolbarSettings { + export interface SummaryRow { - /** 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 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 enable toolbar in the grid. - * @Default {false} - */ - showToolbar?: 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 add the default editing actions as a toolbar items - * @Default {[]} - */ - toolbarItems?: Array; -} + /** 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; -enum GridLines { + /** Gets or sets a value that indicates whether to add summary columns into the summary rows. + * @Default {[]} + */ + summaryColumns?: SummaryRowsSummaryColumn[]; - ///Displays both the horizontal and vertical grid lines. - Both, + /** This specifies the grid to show the title for the summary rows. + */ + title?: string; - ///Displays the horizontal grid lines only. - Horizontal, + /** This specifies the grid to show the title of summary row in the specified column. + * @Default {null} + */ + titleColumn?: string; + } - ///Displays the vertical grid lines only. - Vertical, + export interface TextWrapSettings { - ///No grid lines are displayed. - None -} + /** 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 { -enum ClipMode { + /** 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[]; - ///Shows ellipsis for the overflown cell. - Ellipsis, + /** Gets or sets a value that indicates whether to enable toolbar in the grid. + * @Default {false} + */ + showToolbar?: boolean; - ///Truncate the text in the cell - Clip, + /** Gets or sets a value that indicates whether to add the default editing actions as a toolbar items + * @Default {[]} + */ + toolbarItems?: Array; + } - ///Shows ellipsis and tooltip for the overflown cell. - EllipsisWithTooltip -} + enum GridLines { + ///Displays both the horizontal and vertical grid lines. + Both, -enum ColumnLayout { + ///Displays the horizontal grid lines only. + Horizontal, - ///Column layout is auto(based on width). - Auto, + ///Displays the vertical grid lines only. + Vertical, - ///Column layout is fixed(based on width). - Fixed -} + ///No grid lines are displayed. + None + } -enum UnboundType { + enum ClipMode { - ///Unbound type is edit. - Edit, + ///Shows ellipsis for the overflown cell. + Ellipsis, - ///Unbound type is save. - Save, + ///Truncate the text in the cell + Clip, - ///Unbound type is delete. - Delete, + ///Shows ellipsis and tooltip for the overflown cell. + EllipsisWithTooltip + } - ///Unbound type is cancel. - Cancel -} + enum ColumnLayout { -enum EditingType { + ///Column layout is auto(based on width). + Auto, - ///Specifies editing type as string edit. - String, + ///Column layout is fixed(based on width). + Fixed + } - ///Specifies editing type as boolean edit. - Boolean, - ///Specifies editing type as numeric edit. - Numeric, + enum UnboundType { - ///Specifies editing type as dropdown edit. - Dropdown, + ///Unbound type is edit. + Edit, - ///Specifies editing type as datepicker. - DatePicker, + ///Unbound type is save. + Save, - ///Specifies editing type as datetime picker. - DateTimePicker -} + ///Unbound type is delete. + Delete, + ///Unbound type is cancel. + Cancel + } -enum FilterType { - ///Specifies the filter type as menu. - Menu, + enum EditingType { - ///Specifies the filter type as excel. - Excel -} + ///Specifies editing type as string edit. + String, + ///Specifies editing type as boolean edit. + Boolean, -enum EditMode { + ///Specifies editing type as numeric edit. + Numeric, - ///Edit mode is normal. - Normal, + ///Specifies editing type as dropdown edit. + Dropdown, - ///Edit mode is dialog. - Dialog, + ///Specifies editing type as datepicker. + DatePicker, - ///Edit mode is dialog template. - DialogTemplate, + ///Specifies editing type as datetime picker. + DateTimePicker + } - ///Edit mode is batch. - Batch, - ///Edit mode is inline form. - InlineForm, + enum FilterType { - ///Edit mode is inline template form. - InlineTemplateForm, + ///Specifies the filter type as menu. + Menu, - ///Edit mode is external form. - ExternalForm, + ///Specifies the filter type as excel. + Excel + } - ///Edit mode is external form template. - ExternalFormTemplate -} + enum EditMode { -enum FormPosition { + ///Edit mode is normal. + Normal, - ///Form position is bottomleft. - BottomLeft, + ///Edit mode is dialog. + Dialog, - ///Form position is topright. - TopRight -} + ///Edit mode is dialog template. + DialogTemplate, + ///Edit mode is batch. + Batch, -enum RowPosition { + ///Edit mode is inline form. + InlineForm, - ///Specifies position of add new row as top. - Top, + ///Edit mode is inline template form. + InlineTemplateForm, - ///Specifies position of add new row as bottom. - Bottom -} + ///Edit mode is external form. + ExternalForm, + ///Edit mode is external form template. + ExternalFormTemplate + } -enum FilterBarMode { - ///Initiate filter operation on typing the filter query. - Immediate, + enum FormPosition { - ///Initiate filter operation after Enter key is pressed. - OnEnter -} + ///Form position is bottomleft. + BottomLeft, + ///Form position is topright. + TopRight + } -enum PrintMode { - ///Prints all pages. - AllPages, + enum RowPosition { - ///Prints current page. - CurrentPage -} + ///Specifies position of add new row as top. + Top, + ///Specifies position of add new row as bottom. + Bottom + } -enum ResizeMode { - ///New column size will be adjusted by all other Columns - Normal, + enum FilterBarMode { - ///New column Size will be adjusted using next column. - NextColumn, + ///Initiate filter operation on typing the filter query. + Immediate, - ///New column Size will be adjusted using entire control - Control -} + ///Initiate filter operation after Enter key is pressed. + OnEnter + } -enum SelectionType { + enum PrintMode { - ///Specifies the selection type as single. - Single, + ///Prints all pages. + AllPages, - ///Specifies the selection type as multiple. - Multiple -} + ///Prints current page. + CurrentPage + } -enum VirtualScrollMode { + enum ResizeMode { - ///virtual scroll mode is normal. - Normal, + ///New column size will be adjusted by all other Columns + Normal, - ///virtual scroll mode is continuous. - Continuous -} + ///New column Size will be adjusted using next column. + NextColumn, + ///New column Size will be adjusted using entire control + Control + } -enum SummaryType { - ///Summary type is average. - Average, + enum SelectionType { - ///Summary type is minimum. - Minimum, + ///Specifies the selection type as single. + Single, - ///Summary type is maximum. - Maximum, + ///Specifies the selection type as multiple. + Multiple + } - ///Summary type is count. - Count, - ///Summary type is sum. - Sum, + enum VirtualScrollMode { - ///Summary type is custom. - Custom, + ///virtual scroll mode is normal. + Normal, - ///Summary type is true count. - TrueCount, + ///virtual scroll mode is continuous. + Continuous + } - ///Summary type is false count. - FalseCount -} + enum SummaryType { -enum WrapMode { + ///Summary type is average. + Average, - ///Auto wrap is applied for both content and header. - Both, + ///Summary type is minimum. + Minimum, - ///Auto wrap is applied only for content. - Content, + ///Summary type is maximum. + Maximum, - ///Auto wrap is applied only for header. - Header -} + ///Summary type is count. + Count, + ///Summary type is sum. + Sum, -enum ToolBarItems { + ///Summary type is custom. + Custom, - ///Toolbar item is add. - Add, + ///Summary type is true count. + TrueCount, - ///Toolbar item is edit. - Edit, + ///Summary type is false count. + FalseCount + } - ///Toolbar item is delete. - Delete, - ///Toolbar item is update. - Update, + enum WrapMode { - ///Toolbar item is cancel. - Cancel, + ///Auto wrap is applied for both content and header. + Both, - ///Toolbar item is search. - Search, + ///Auto wrap is applied only for content. + Content, - ///Toolbar item is pdfExport. - PdfExport, + ///Auto wrap is applied only for header. + Header + } - ///Toolbar item is printGrid. - PrintGrid, - ///Toolbar item is wordExport. - WordExport -} + enum ToolBarItems { -} + ///Toolbar item is add. + Add, -class Sparkline extends ej.Widget { - static fn: Sparkline; - constructor(element: JQuery | Element, options?: Sparkline.Model); - static Locale: any; - model: Sparkline.Model; - defaults: Sparkline.Model; + ///Toolbar item is edit. + Edit, - /** 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 { + ///Toolbar item is delete. + Delete, -export interface Model { + ///Toolbar item is update. + Update, - /** Background color of the plot area. - * @Default {transparent} - */ - background?: string; + ///Toolbar item is cancel. + Cancel, - /** Fill color for the sparkline series. - * @Default {#33ccff} - */ - fill?: string; + ///Toolbar item is search. + Search, - /** Border color of the series. - * @Default {null} - */ - stroke?: string; + ///Toolbar item is pdfExport. + PdfExport, - /** Options for customizing the color, opacity and width of the sparkline border. - */ - border?: Border; + ///Toolbar item is printGrid. + PrintGrid, - /** Border width of the series. - * @Default {1} - */ - width?: number; + ///Toolbar item is wordExport. + WordExport + } - /** Opacity of the series. - * @Default {1} - */ - opacity?: number; + } - /** Color for series high point. - * @Default {null} - */ - highPointColor?: string; + class Sparkline extends ej.Widget { + static fn: Sparkline; + constructor(element: JQuery | Element, options?: Sparkline.Model); + static Locale: any; + model: Sparkline.Model; + defaults: Sparkline.Model; - /** Color for series low point. - * @Default {null} - */ - lowPointColor?: string; + /** 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 { - /** Color for series start point. - * @Default {null} - */ - startPointColor?: string; + export interface Model { - /** Color for series end point. - * @Default {null} - */ - endPointColor?: string; + /** Background color of the plot area. + * @Default {transparent} + */ + background?: string; - /** Color for series negative point. - * @Default {null} - */ - negativePointColor?: string; + /** Fill color for the sparkline series. + * @Default {#33ccff} + */ + fill?: 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; + /** Border color of the series. + * @Default {null} + */ + stroke?: string; - /** Options to customize the Sparkline size. - */ - size?: Size; + /** Options for customizing the color, opacity and width of the sparkline border. + */ + border?: Border; - /** Options for customizing the color,dashArray and width of the axisLine. - */ - axisLineSettings?: AxisLineSettings; + /** Border width of the series. + * @Default {1} + */ + width?: number; - /** Fires before loading the sparkline. */ - load?(e: LoadEventArgs): void; - - /** Fires after loaded the sparkline. */ - loaded?(e: LoadedEventArgs): void; + /** Opacity of the series. + * @Default {1} + */ + opacity?: number; - /** Fires before rendering trackball tooltip. You can use this event to customize the text displayed in trackball tooltip. */ - tooltipInitialize?(e: TooltipInitializeEventArgs): void; + /** Color for series high point. + * @Default {null} + */ + highPointColor?: string; - /** Fires before rendering a series. This event is fired for each series in Sparkline. */ - seriesRendering?(e: SeriesRenderingEventArgs): void; + /** Color for series low point. + * @Default {null} + */ + lowPointColor?: string; - /** Fires when mouse is moved over a point. */ - pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; + /** Color for series start point. + * @Default {null} + */ + startPointColor?: string; - /** Fires on clicking a point in sparkline. You can use this event to handle clicks made on points. */ - pointRegionMouseClick?(e: PointRegionMouseClickEventArgs): void; + /** Color for series end point. + * @Default {null} + */ + endPointColor?: string; - /** Fires on moving mouse over the sparkline. */ - sparklineMouseMove?(e: SparklineMouseMoveEventArgs): void; + /** Color for series negative point. + * @Default {null} + */ + negativePointColor?: string; - /** Fires on moving mouse outside the sparkline. */ - sparklineMouseLeave?(e: SparklineMouseLeaveEventArgs): void; -} + /** 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; -export interface LoadEventArgs { + /** Options to customize the Sparkline size. + */ + size?: Size; - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Options for customizing the color,dashArray and width of the axisLine. + */ + axisLineSettings?: AxisLineSettings; - /** Instance of the sparkline model object - */ - model?: any; + /** Fires before loading the sparkline. */ + load?(e: LoadEventArgs): void; + + /** Fires after loaded the sparkline. */ + loaded?(e: LoadedEventArgs): void; - /** Name of the event - */ - type?: string; -} + /** Fires before rendering trackball tooltip. You can use this event to customize the text displayed in trackball tooltip. */ + tooltipInitialize?(e: TooltipInitializeEventArgs): void; -export interface LoadedEventArgs { + /** Fires before rendering a series. This event is fired for each series in Sparkline. */ + seriesRendering?(e: SeriesRenderingEventArgs): void; - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Fires when mouse is moved over a point. */ + pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; - /** Instance of the sparkline model object - */ - model?: any; + /** Fires on clicking a point in sparkline. You can use this event to handle clicks made on points. */ + pointRegionMouseClick?(e: PointRegionMouseClickEventArgs): void; - /** Name of the event - */ - type?: string; -} + /** Fires on moving mouse over the sparkline. */ + sparklineMouseMove?(e: SparklineMouseMoveEventArgs): void; -export interface TooltipInitializeEventArgs { + /** Fires on moving mouse outside the sparkline. */ + sparklineMouseLeave?(e: SparklineMouseLeaveEventArgs): void; + } - /** Set this option to true to cancel the event - */ - cancel?: boolean; + export interface LoadEventArgs { - /** Instance of the sparkline model object - */ - model?: any; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Name of the event - */ - type?: string; + /** Instance of the sparkline model object + */ + model?: any; - /** X Location of the trackball tooltip in pixels - */ - locationX?: any; + /** Name of the event + */ + type?: string; + } - /** Y Location of the trackball tooltip in pixels - */ - locationY?: any; + export interface LoadedEventArgs { - /** Index of the point for which trackball tooltip is displayed - */ - pointIndex?: number; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Text to be displayed in trackball tooltip. Use this option to add custom text in trackball tooltip - */ - currentText?: string; -} + /** Instance of the sparkline model object + */ + model?: any; -export interface SeriesRenderingEventArgs { + /** Name of the event + */ + type?: string; + } - /** Set this option to true to cancel the event - */ - cancel?: boolean; + export interface TooltipInitializeEventArgs { - /** Instance of the sparkline model object - */ - model?: any; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Name of the event - */ - type?: string; + /** Instance of the sparkline model object + */ + model?: any; - /** Minimum x value of the data point - */ - minX?: any; + /** Name of the event + */ + type?: string; - /** Minimum y value of the data point - */ - minY?: any; + /** X Location of the trackball tooltip in pixels + */ + locationX?: any; - /** Maximum x value of the data point - */ - maxX?: any; + /** Y Location of the trackball tooltip in pixels + */ + locationY?: any; - /** Maximum y value of the data point - */ - maxY?: any; -} + /** Index of the point for which trackball tooltip is displayed + */ + pointIndex?: number; -export interface PointRegionMouseMoveEventArgs { + /** Text to be displayed in trackball tooltip. Use this option to add custom text in trackball tooltip + */ + currentText?: string; + } - /** Set this option to true to cancel the event - */ - cancel?: boolean; + export interface SeriesRenderingEventArgs { - /** Instance of the sparkline model object - */ - model?: any; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Name of the event - */ - type?: string; + /** Instance of the sparkline model object + */ + model?: any; - /** X-coordinate of point in pixel - */ - locationX?: number; + /** Name of the event + */ + type?: string; - /** Y-coordinate of point in pixel - */ - locationY?: number; + /** Minimum x value of the data point + */ + minX?: any; - /** Index of the point in series - */ - pointIndex?: number; + /** Minimum y value of the data point + */ + minY?: any; - /** Type of the series - */ - seriesType?: string; -} + /** Maximum x value of the data point + */ + maxX?: any; -export interface PointRegionMouseClickEventArgs { + /** Maximum y value of the data point + */ + maxY?: any; + } - /** Set this option to true to cancel the event - */ - cancel?: boolean; + export interface PointRegionMouseMoveEventArgs { - /** Instance of the sparkline model object - */ - model?: any; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Name of the event - */ - type?: string; + /** Instance of the sparkline model object + */ + model?: any; - /** X-coordinate of point in pixel - */ - locationX?: number; + /** Name of the event + */ + type?: string; - /** Y-coordinate of point in pixel - */ - locationY?: number; + /** X-coordinate of point in pixel + */ + locationX?: number; - /** Index of the point in series - */ - pointIndex?: number; - - /** Type of the series - */ - seriesType?: string; -} - -export interface SparklineMouseMoveEventArgs { + /** 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; - - /** 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; + /** Type of the series + */ + seriesType?: string; + } - /** 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; + export interface PointRegionMouseClickEventArgs { - /** 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; - /** Enable/disable the animation for all the levels. - * @Default {false} - */ - enableAnimation?: boolean; + /** Name of the event + */ + type?: string; - /** Opacity of the levels. - * @Default {1} - */ - opacity?: number; + /** X-coordinate of point in pixel + */ + locationX?: number; - /** Options for enable zooming feature of chart. - */ - zoomSettings?: ZoomSettings; + /** Y-coordinate of point in pixel + */ + locationY?: number; - /** Animation type of sunburst - * @Default {rotation. See Alignment} - */ - animationType?: ej.datavisualization.Sunburst.Animation|string; + /** Index of the point in series + */ + pointIndex?: number; + + /** Type of the series + */ + seriesType?: string; + } + + export interface SparklineMouseMoveEventArgs { - /** Fires before loading. */ - load?(e: LoadEventArgs): void; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Fires before rendering sunburst. */ - preRender?(e: PreRenderEventArgs): void; + /** 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; - /** Fires after rendering sunburst. */ - loaded?(e: LoadedEventArgs): void; + /** 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; - /** Fires before rendering the datalabel */ - dataLabelRendering?(e: DataLabelRenderingEventArgs): void; + /** Specifies the theme for Sunburst. + * @Default {Flatlight. See Theme} + */ + theme?: ej.datavisualization.Sunburst.SunburstTheme | string; - /** Fires before rendering each segment */ - segmentRendering?(e: SegmentRenderingEventArgs): void; + /** Options to customize the left, right, top and bottom margins of sunburst area. + */ + margin?: Margin; - /** Fires before rendering sunburst title. */ - titleRendering?(e: TitleRenderingEventArgs): void; + /** Enable/disable the animation for all the levels. + * @Default {false} + */ + enableAnimation?: boolean; - /** Fires during initialization of tooltip. */ - tooltipInitialize?(e: TooltipInitializeEventArgs): void; + /** Opacity of the levels. + * @Default {1} + */ + opacity?: number; - /** Fires after clicking the point in sunburst */ - pointRegionClick?(e: PointRegionClickEventArgs): void; + /** Options for enable zooming feature of chart. + */ + zoomSettings?: ZoomSettings; - /** Fires while moving the mouse over sunburst points */ - pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; + /** Animation type of sunburst + * @Default {rotation. See Alignment} + */ + animationType?: ej.datavisualization.Sunburst.Animation | string; - /** Fires when clicking the point to perform drilldown. */ - drillDownClick?(e: DrillDownClickEventArgs): void; + /** Fires before loading. */ + load?(e: LoadEventArgs): void; - /** Fires when resetting drilldown points. */ - drillDownBack?(e: DrillDownBackEventArgs): void; + /** Fires before rendering sunburst. */ + preRender?(e: PreRenderEventArgs): void; - /** Fires after resetting the sunburst points */ - drillDownReset?(e: DrillDownResetEventArgs): void; -} + /** Fires after rendering sunburst. */ + loaded?(e: LoadedEventArgs): void; -export interface LoadEventArgs { + /** Fires before rendering the datalabel */ + dataLabelRendering?(e: DataLabelRenderingEventArgs): void; - /** Load event data - */ - data?: string; + /** Fires before rendering each segment */ + segmentRendering?(e: SegmentRenderingEventArgs): void; - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Fires before rendering sunburst title. */ + titleRendering?(e: TitleRenderingEventArgs): void; - /** Instance of the sunburst model object - */ - model?: any; + /** Fires during initialization of tooltip. */ + tooltipInitialize?(e: TooltipInitializeEventArgs): void; - /** Name of the event - */ - type?: string; -} + /** Fires after clicking the point in sunburst */ + pointRegionClick?(e: PointRegionClickEventArgs): void; -export interface PreRenderEventArgs { + /** Fires while moving the mouse over sunburst points */ + pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; - /** PreRender event data - */ - data?: string; + /** Fires when clicking the point to perform drilldown. */ + drillDownClick?(e: DrillDownClickEventArgs): void; - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Fires when resetting drilldown points. */ + drillDownBack?(e: DrillDownBackEventArgs): void; - /** Instance of the sunburst model object - */ - model?: any; + /** Fires after resetting the sunburst points */ + drillDownReset?(e: DrillDownResetEventArgs): void; + } - /** Name of the event - */ - type?: string; -} + export interface LoadEventArgs { -export interface LoadedEventArgs { + /** Load 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 PreRenderEventArgs { -export interface DataLabelRenderingEventArgs { + /** PreRender event 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 LoadedEventArgs { -export interface SegmentRenderingEventArgs { + /** Loaded event 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 DataLabelRenderingEventArgs { -export interface TitleRenderingEventArgs { + /** Sunburst datalabel 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 SegmentRenderingEventArgs { -export interface TooltipInitializeEventArgs { + /** Sunburst datalabel 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 TitleRenderingEventArgs { -export interface PointRegionClickEventArgs { + /** Sunburst title 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 TooltipInitializeEventArgs { -export interface PointRegionMouseMoveEventArgs { + /** Sunburst tooltip data + */ + 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 PointRegionClickEventArgs { -export interface DrillDownClickEventArgs { + /** Includes clicked points region 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 PointRegionMouseMoveEventArgs { -export interface DrillDownBackEventArgs { + /** Includes data of mouse moved region + */ + 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 DrillDownClickEventArgs { -export interface DrillDownResetEventArgs { - - /** Drill down reset data - */ - data?: string; + /** 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 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; - /** 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; + /** Instance of the sunburst model object + */ + model?: any; - /** Allows the user to set the localized language for the widget. - * @Default {en-US} - */ - locale?: string; + /** Name of the event + */ + type?: 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; + export interface DrillDownBackEventArgs { - /** Allows the user to set custom name for the methods at service-end, communicated during AJAX post. - * @Default {{}} - */ - serviceMethodSettings?: ServiceMethodSettings; + /** Drill down data of points + */ + data?: string; - /** Connects the service using the specified URL for any server updates. - * @Default {“â€} - */ - url?: string; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Triggers when it reaches client-side after any AJAX request. */ - afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; + /** Instance of the sunburst model object + */ + model?: any; - /** Triggers before any AJAX request is passed from PivotGrid to service methods. */ - beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; + /** Name of the event + */ + type?: string; + } - /** Triggers before Pivot Engine starts to populate. */ - beforePivotEnginePopulate?(e: BeforePivotEnginePopulateEventArgs): void; + export interface DrillDownResetEventArgs { + + /** Drill down reset data + */ + data?: string; - /** Triggers when double click action is performed over a cell. */ - cellDoubleClick?(e: CellDoubleClickEventArgs): void; + /** 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; - /** Triggers when right-click action is performed on a cell. */ - cellContext?(e: CellContextEventArgs): void; + /** 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; - /** Triggers when a specific range of value cells are selected. */ - cellSelection?(e: CellSelectionEventArgs): void; + /** Allows the user to set the localized language for the widget. + * @Default {en-US} + */ + locale?: string; - /** Triggers when the hyperlink of column header is clicked. */ - columnHeaderHyperlinkClick?(e: ColumnHeaderHyperlinkClickEventArgs): void; + /** 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; - /** Triggers after performing drill operation in PivotGrid. */ - drillSuccess?(e: DrillSuccessEventArgs): void; + /** Allows the user to set custom name for the methods at service-end, communicated during AJAX post. + * @Default {{}} + */ + serviceMethodSettings?: ServiceMethodSettings; - /** Triggers while clicking "OK" button in the drill-through dialog. */ - drillThrough?(e: DrillThroughEventArgs): void; + /** Connects the service using the specified URL for any server updates. + * @Default {“â€Â} + */ + url?: string; - /** Triggers when PivotGrid loading is initiated. */ - load?(e: LoadEventArgs): void; + /** Triggers when it reaches client-side after any AJAX request. */ + afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; - /** Triggers when PivotGrid widget completes all operations at client-side after any AJAX request. */ - renderComplete?(e: RenderCompleteEventArgs): void; + /** Triggers before any AJAX request is passed from PivotGrid to service methods. */ + beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; - /** Triggers when any error occurred during AJAX request. */ - renderFailure?(e: RenderFailureEventArgs): void; + /** Triggers before Pivot Engine starts to populate. */ + beforePivotEnginePopulate?(e: BeforePivotEnginePopulateEventArgs): void; - /** Triggers when PivotGrid successfully reaches client-side after any AJAX request. */ - renderSuccess?(e: RenderSuccessEventArgs): void; + /** Triggers when double click action is performed over a cell. */ + cellDoubleClick?(e: CellDoubleClickEventArgs): void; - /** Triggers when the hyperlink of row header is clicked. */ - rowHeaderHyperlinkClick?(e: RowHeaderHyperlinkClickEventArgs): void; + /** Triggers when right-click action is performed on a cell. */ + cellContext?(e: CellContextEventArgs): void; - /** Triggers when the hyperlink of summary cell is clicked. */ - summaryCellHyperlinkClick?(e: SummaryCellHyperlinkClickEventArgs): void; + /** Triggers when a specific range of value cells are selected. */ + cellSelection?(e: CellSelectionEventArgs): void; - /** Triggers when the hyperlink of value cell is clicked. */ - valueCellHyperlinkClick?(e: ValueCellHyperlinkClickEventArgs): void; + /** Triggers when the hyperlink of column header is clicked. */ + columnHeaderHyperlinkClick?(e: ColumnHeaderHyperlinkClickEventArgs): void; - /** Triggers before saving the current report to database. */ - saveReport?(e: SaveReportEventArgs): void; + /** Triggers after performing drill operation in PivotGrid. */ + drillSuccess?(e: DrillSuccessEventArgs): void; - /** Triggers before loading a report from database. */ - loadReport?(e: LoadReportEventArgs): void; + /** Triggers while clicking "OK" button in the drill-through dialog. */ + drillThrough?(e: DrillThroughEventArgs): void; - /** Triggers before performing exporting in pivot grid. */ - beforeExport?(e: BeforeExportEventArgs): void; + /** Triggers when PivotGrid loading is initiated. */ + load?(e: LoadEventArgs): void; - /** Triggers before editing the cells. */ - cellEdit?(e: CellEditEventArgs): void; -} + /** Triggers when PivotGrid widget completes all operations at client-side after any AJAX request. */ + renderComplete?(e: RenderCompleteEventArgs): void; -export interface AfterServiceInvokeEventArgs { + /** Triggers when any error occurred during AJAX request. */ + renderFailure?(e: RenderFailureEventArgs): void; - /** returns the current action of PivotGrid control. - */ - action?: string; + /** Triggers when PivotGrid successfully reaches client-side after any AJAX request. */ + renderSuccess?(e: RenderSuccessEventArgs): void; - /** returns the custom object bound with PivotGrid control. - */ - customObject?: any; + /** Triggers when the hyperlink of row header is clicked. */ + rowHeaderHyperlinkClick?(e: RowHeaderHyperlinkClickEventArgs): void; - /** returns the HTML element of PivotGrid control. - */ - element?: any; -} + /** Triggers when the hyperlink of summary cell is clicked. */ + summaryCellHyperlinkClick?(e: SummaryCellHyperlinkClickEventArgs): void; -export interface BeforeServiceInvokeEventArgs { + /** Triggers when the hyperlink of value cell is clicked. */ + valueCellHyperlinkClick?(e: ValueCellHyperlinkClickEventArgs): void; - /** returns the current action of PivotGrid control. - */ - action?: string; + /** Triggers before saving the current report to database. */ + saveReport?(e: SaveReportEventArgs): void; - /** returns the custom object bound with PivotGrid control. - */ - customObject?: any; + /** Triggers before loading a report from database. */ + loadReport?(e: LoadReportEventArgs): void; - /** returns the HTML element of PivotGrid control. - */ - element?: any; -} + /** Triggers before performing exporting in pivot grid. */ + beforeExport?(e: BeforeExportEventArgs): void; -export interface BeforePivotEnginePopulateEventArgs { + /** Triggers before editing the cells. */ + cellEdit?(e: CellEditEventArgs): void; + } - /** returns the PivotGrid object - */ - pivotGridObject?: any; -} + export interface AfterServiceInvokeEventArgs { -export interface CellDoubleClickEventArgs { + /** returns the current action of PivotGrid control. + */ + action?: string; - /** 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 BeforeServiceInvokeEventArgs { -export interface CellContextEventArgs { + /** returns the current action of PivotGrid control. + */ + action?: string; - /** returns the cell position (row index and column index) in table. - */ - cellPosition?: string; + /** returns the custom object bound with PivotGrid control. + */ + customObject?: any; - /** returns the type of the cell. - */ - cellType?: string; + /** returns the HTML element of PivotGrid control. + */ + element?: any; + } - /** returns the content of the cell. - */ - cellValue?: string; + export interface BeforePivotEnginePopulateEventArgs { - /** returns the unique name of levels/members. - */ - uniqueName?: string; + /** returns the PivotGrid object + */ + pivotGridObject?: any; + } - /** returns the role of the cell in PivotGrid. - */ - role?: string; + export interface CellDoubleClickEventArgs { - /** returns JSON record corresponding to the selected cell. - */ - rawdata?: any; + /** returns the JSON details of the double clicked cell. + */ + selectedData?: any[]; - /** returns the original event object. - */ - args?: any; -} + /** returns the custom object bound with PivotGrid control. + */ + customObject?: any; -export interface CellSelectionEventArgs { + /** returns the HTML element of PivotGrid control. + */ + element?: any; + } - /** returns the JSON records of the selected range of cells. - */ - JSONRecords?: any; + export interface CellContextEventArgs { - /** Returns the row headers corresponding to the selected value cells. - */ - rowheader?: any; + /** returns the cell position (row index and column index) in table. + */ + cellPosition?: string; - /** Returns the column headers corresponding to the selected value cells. - */ - columnheader?: any; + /** returns the type of the cell. + */ + cellType?: string; - /** Returns the information about the measure associated with the selected cell. - */ - measureCount?: string; -} + /** returns the content of the cell. + */ + cellValue?: string; -export interface ColumnHeaderHyperlinkClickEventArgs { + /** returns the unique name of levels/members. + */ + uniqueName?: string; - /** returns the information about the clicked cell - */ - args?: any; + /** returns the role of the cell in PivotGrid. + */ + role?: string; - /** returns the HTML element of the control. - */ - element?: any; + /** returns JSON record corresponding to the selected cell. + */ + rawdata?: any; - /** returns the custom object bound to the control. - */ - customObject?: any; -} + /** returns the original event object. + */ + args?: any; + } -export interface DrillSuccessEventArgs { + export interface CellSelectionEventArgs { - /** returns the HTML element of the control. - */ - args?: any; -} + /** returns the JSON records of the selected range of cells. + */ + JSONRecords?: any; -export interface DrillThroughEventArgs { + /** Returns the row headers corresponding to the selected value cells. + */ + rowheader?: any; - /** return the JSON records of the generated cells on drill-through operation. - */ - data?: any; + /** Returns the column headers corresponding to the selected value cells. + */ + columnheader?: any; - /** returns the HTML element of PivotGrid control. - */ - element?: any; -} + /** Returns the information about the measure associated with the selected cell. + */ + measureCount?: string; + } -export interface LoadEventArgs { + export interface ColumnHeaderHyperlinkClickEventArgs { - /** returns the custom object bound with the control. - */ - customObject?: any; + /** returns the information about the clicked cell + */ + args?: any; - /** returns the HTML element of PivotGrid control. - */ - element?: any; -} + /** returns the HTML element of the control. + */ + element?: any; -export interface RenderCompleteEventArgs { + /** returns the custom object bound to the control. + */ + customObject?: any; + } - /** returns the current action of PivotGrid control. - */ - action?: string; + export interface DrillSuccessEventArgs { - /** returns the custom object bound with the control. - */ - customObject?: any; + /** returns the HTML element of the control. + */ + args?: any; + } - /** returns the HTML element of PivotGrid control. - */ - element?: any; -} + export interface DrillThroughEventArgs { -export interface RenderFailureEventArgs { + /** return the JSON records of the generated cells on drill-through operation. + */ + data?: any; - /** returns the current action of PivotGrid control. - */ - action?: string; + /** returns the HTML element of PivotGrid control. + */ + element?: any; + } - /** returns the custom object bound with the control. - */ - customObject?: any; + export interface LoadEventArgs { - /** returns the HTML element of PivotGrid control. - */ - element?: any; + /** returns the custom object bound with the control. + */ + customObject?: any; - /** returns the error message with error code. - */ - message?: string; -} + /** returns the HTML element of PivotGrid control. + */ + element?: any; + } -export interface RenderSuccessEventArgs { + 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 RowHeaderHyperlinkClickEventArgs { + export interface RenderFailureEventArgs { - /** returns the information about the clicked cell - */ - args?: any; + /** returns the current action of PivotGrid control. + */ + action?: string; - /** returns the HTML element of the control. - */ - element?: any; + /** returns the custom object bound with the control. + */ + customObject?: any; - /** returns the custom object bound to the control. - */ - customObject?: any; -} + /** returns the HTML element of PivotGrid control. + */ + element?: any; -export interface SummaryCellHyperlinkClickEventArgs { + /** returns the error message with error code. + */ + message?: string; + } - /** returns the information about the clicked cell - */ - args?: any; + export interface RenderSuccessEventArgs { - /** returns the HTML element of the control. - */ - element?: any; + /** returns the current action of PivotGrid control. + */ + action?: string; - /** returns the custom object bound to the control. - */ - customObject?: any; -} + /** returns the custom object bound with the control. + */ + customObject?: any; -export interface ValueCellHyperlinkClickEventArgs { + /** returns the HTML element of PivotGrid control. + */ + element?: any; + } - /** returns the information about the clicked cell - */ - args?: any; + export interface RowHeaderHyperlinkClickEventArgs { - /** returns the HTML element of the control. - */ - element?: any; + /** returns the information about the clicked cell + */ + args?: any; - /** returns the custom object bound to the control. - */ - customObject?: any; -} + /** returns the HTML element of the control. + */ + element?: any; -export interface SaveReportEventArgs { + /** returns the custom object bound to the control. + */ + customObject?: any; + } - /** returns the report to be stored in database. - */ - report?: any; -} + export interface SummaryCellHyperlinkClickEventArgs { -export interface LoadReportEventArgs { + /** returns the information about the clicked cell + */ + args?: any; - /** returns the PivotGrid object. - */ - targetControl?: any; + /** returns the HTML element of the control. + */ + element?: any; - /** returns whether the control is bound with OLAP or Relational data source. - */ - dataModel?: string; -} + /** returns the custom object bound to the control. + */ + customObject?: any; + } -export interface BeforeExportEventArgs { + export interface ValueCellHyperlinkClickEventArgs { - /** contains the url of the service responsible for exporting. - */ - url?: string; + /** returns the information about the clicked cell + */ + args?: any; - /** contains the name of the exporting file. - */ - fileName?: string; -} + /** returns the HTML element of the control. + */ + element?: any; -export interface CellEditEventArgs { + /** returns the custom object bound to the control. + */ + customObject?: any; + } - /** contains the array of cells selected for editing. - */ - editCellsInfo?: any[]; -} + export interface SaveReportEventArgs { -export interface DataSourceColumnsAdvancedFilter { + /** returns the report to be stored in database. + */ + report?: any; + } - /** Allows the user to provide level unique name to perform advanced filtering. - */ - name?: string; + export interface LoadReportEventArgs { - /** 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; + /** returns the PivotGrid object. + */ + targetControl?: any; - /** Allows the user to set the filtering type while performing advanced filtering. - */ - advancedFilterType?: string; + /** returns whether the control is bound with OLAP or Relational data source. + */ + dataModel?: 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 BeforeExportEventArgs { -export interface DataSourceColumnsFilterItems { + /** contains the url of the service responsible for exporting. + */ + url?: 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 name of the exporting file. + */ + fileName?: 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; -} + export interface CellEditEventArgs { -export interface LoadEventArgs { - - /** returns the current action of PivotChart control. - */ - action?: string; + /** contains the array of cells selected for editing. + */ + editCellsInfo?: any[]; + } - /** returns the custom object bound with PivotChart control. - */ - customObject?: any; + export interface DataSourceColumnsAdvancedFilter { - /** returns the HTML element of PivotChart control. - */ - element?: any; -} + /** Allows the user to provide level unique name to perform advanced filtering. + */ + name?: string; -export interface AfterServiceInvokeEventArgs { + /** 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; - /** returns the current action of PivotChart control. - */ - action?: string; + /** Allows the user to set the filtering type while performing advanced filtering. + */ + advancedFilterType?: string; - /** returns the custom object bound with PivotChart control. - */ - customObject?: 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[]; + } - /** returns the HTML element of PivotChart control. - */ - element?: any; -} + export interface DataSourceColumnsFilterItems { -export interface BeforeServiceInvokeEventArgs { + /** Sets the type of filter whether to include/exclude the mentioned values. + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ + filterType?: ej.PivotAnalysis.FilterType | string; - /** returns the current action of PivotChart control. - */ - action?: 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; + } - /** returns the custom object bound with PivotChart control. - */ - customObject?: any; + export interface LoadEventArgs { + + /** returns the current action of PivotChart control. + */ + action?: string; - /** returns the HTML element of PivotChart control. - */ - element?: any; -} + /** returns the custom object bound with PivotChart control. + */ + customObject?: any; -export interface DrillSuccessEventArgs { + /** returns the HTML element of PivotChart control. + */ + element?: any; + } - /** returns the current instance of PivotChart. - */ - chartObj?: any; + export interface AfterServiceInvokeEventArgs { - /** returns the drill action of PivotChart. - */ - drillAction?: string; + /** returns the current action of PivotChart control. + */ + action?: string; - /** contains the name of the member drilled. - */ - drilledMember?: string; + /** returns the custom object bound with PivotChart control. + */ + customObject?: any; - /** returns the event object. - */ - event?: any; -} + /** returns the HTML element of PivotChart control. + */ + element?: any; + } -export interface RenderCompleteEventArgs { + 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 RenderFailureEventArgs { + export interface DrillSuccessEventArgs { - /** returns the current action of PivotChart control. - */ - action?: string; + /** returns the current instance of PivotChart. + */ + chartObj?: any; - /** returns the custom object bound with PivotChart control. - */ - customObject?: any; + /** returns the drill action of PivotChart. + */ + drillAction?: string; - /** returns the HTML element of PivotChart control. - */ - element?: any; + /** contains the name of the member drilled. + */ + drilledMember?: string; - /** returns the error stack trace of the original exception. - */ - message?: string; -} + /** returns the event object. + */ + event?: any; + } -export interface RenderSuccessEventArgs { + export interface RenderCompleteEventArgs { - /** returns the current instance of PivotChart. - */ - args?: any; -} + /** returns the current action of PivotChart control. + */ + action?: string; -export interface BeforeExportEventArgs { + /** returns the custom object bound with PivotChart control. + */ + customObject?: any; - /** contains the url of the service responsible for exporting. - */ - url?: string; + /** returns the HTML element of PivotChart control. + */ + element?: any; + } - /** contains the name of the exporting file. - */ - fileName?: string; -} + export interface RenderFailureEventArgs { -export interface Zooming { + /** returns the current action of PivotChart control. + */ + action?: string; - /** Enables or disables horizontal scrollbar. - * @Default {false} - */ - enableScrollbar?: boolean; -} + /** returns the custom object bound with PivotChart control. + */ + customObject?: any; -export interface CommonSeriesOptions { + /** returns the HTML element of PivotChart control. + */ + element?: any; - /** Allows the user to set the specific chart type for PivotChart widget. - * @Default {ej.PivotChart.ChartTypes.Column} - */ - type?: ej.PivotChart.ChartTypes|string; -} + /** returns the error stack trace of the original exception. + */ + message?: string; + } -export interface DataSourceColumnsFilterItems { + export interface RenderSuccessEventArgs { - /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ - filterType?: ej.PivotAnalysis.FilterType|string; + /** returns the current instance of PivotChart. + */ + args?: any; + } - /** Contains the collection of items to be included/excluded among the field members. - * @Default {[]} - */ - values?: any[]; -} + export interface BeforeExportEventArgs { -export interface DataSourceColumn { + /** contains the url of the service responsible for exporting. + */ + url?: string; - /** Allows the user to bind the item by using its unique name as field name. - */ - fieldName?: string; + /** contains the name of the exporting file. + */ + fileName?: string; + } - /** Allows the user to set the display caption for an item. - */ - fieldCaption?: string; + export interface Zooming { - /** 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; -} + /** Enables or disables horizontal scrollbar. + * @Default {false} + */ + enableScrollbar?: boolean; + } -export interface DataSource { + export interface CommonSeriesOptions { - /** Contains the respective cube name from OLAP database as string type. - * @Default {“â€} - */ - cube?: string; + /** Allows the user to set the specific chart type for PivotChart widget. + * @Default {ej.PivotChart.ChartTypes.Column} + */ + type?: ej.PivotChart.ChartTypes | string; + } - /** Provides the raw data source for the PivotChart. - * @Default {null} - */ - data?: any; + export interface DataSourceColumnsFilterItems { - /** 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; + /** Sets the type of filter whether to include/exclude the mentioned values. + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ + filterType?: ej.PivotAnalysis.FilterType | string; - /** Lists out the items to be displayed as series of PivotChart. - * @Default {[]} - */ - columns?: DataSourceColumn[]; + /** Contains the collection of items to be included/excluded among the field members. + * @Default {[]} + */ + values?: any[]; + } - /** Lists out the items to be displayed as segments of PivotChart. - * @Default {[]} - */ - rows?: DataSourceRow[]; + export interface DataSourceColumn { - /** Lists out the items supports calculation in PivotChart. - * @Default {[]} - */ - values?: DataSourceValue[]; + /** Allows the user to bind the item by using its unique name as field name. + */ + fieldName?: string; - /** Lists out the items which supports filtering of values without displaying the members in UI in PivotChart. - * @Default {[]} - */ - filters?: DataSourceFilter[]; -} + /** Allows the user to set the display caption for an item. + */ + fieldCaption?: string; -export interface ServiceMethodSettings { + /** 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 set the custom name for the service method responsible for drilling up/down operation in PivotChart. - * @Default {DrillChart} - */ - drillDown?: string; + export interface DataSource { - /** Allows the user to set the custom name for the service method responsible for exporting. - * @Default {Export} - */ - exportPivotChart?: string; + /** Contains the respective cube name from OLAP database as string type. + * @Default {“â€Â} + */ + cube?: string; - /** Allows the user to set the custom name for the service method responsible for initializing PivotChart. - * @Default {InitializeChart} - */ - initialize?: string; + /** Provides the raw data source for the PivotChart. + * @Default {null} + */ + data?: any; - /** 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, + /** 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; - ///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 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; + /** Lists out the items to be displayed as series of PivotChart. + * @Default {[]} + */ + columns?: DataSourceColumn[]; - /** Sets the title for PivotClient widget. - */ - title?: string; + /** Lists out the items to be displayed as segments of PivotChart. + * @Default {[]} + */ + rows?: DataSourceRow[]; - /** Connects the service using the specified URL for any server updates. - */ - url?: string; + /** Lists out the items supports calculation in PivotChart. + * @Default {[]} + */ + values?: DataSourceValue[]; - /** Triggers when it reaches client-side after any AJAX request. */ - afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; + /** Lists out the items which supports filtering of values without displaying the members in UI in PivotChart. + * @Default {[]} + */ + filters?: DataSourceFilter[]; + } - /** Triggers before any AJAX request is passed from client-side to service methods. */ - beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; + export interface ServiceMethodSettings { - /** Triggers before saving the current collection of reports. */ - saveReport?(e: SaveReportEventArgs): void; + /** Allows the user to set the custom name for the service method responsible for drilling up/down operation in PivotChart. + * @Default {DrillChart} + */ + drillDown?: string; - /** Triggers before loading a saved collection of reports. */ - loadReport?(e: LoadReportEventArgs): void; + /** Allows the user to set the custom name for the service method responsible for exporting. + * @Default {Export} + */ + exportPivotChart?: string; - /** Triggers before fetching the report collection from storage. */ - fetchReport?(e: FetchReportEventArgs): void; + /** Allows the user to set the custom name for the service method responsible for initializing PivotChart. + * @Default {InitializeChart} + */ + initialize?: string; - /** Triggers before exporting the control. */ - beforeExport?(e: BeforeExportEventArgs): void; + /** 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, - /** Triggers before rendering the PivotChart. */ - chartLoad?(e: ChartLoadEventArgs): void; + ///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; - /** Triggers before rendering the PivotTreeMap. */ - treeMapLoad?(e: TreeMapLoadEventArgs): void; + /** Sets the title for PivotClient widget. + */ + title?: string; - /** Triggers while we initiate loading of the widget. */ - load?(e: LoadEventArgs): void; + /** Connects the service using the specified URL for any server updates. + */ + url?: string; - /** Triggers when PivotClient widget completes all operations at client-end after any AJAX request. */ - renderComplete?(e: RenderCompleteEventArgs): void; + /** Triggers when it reaches client-side after any AJAX request. */ + afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; - /** Triggers when any error occurred during AJAX request. */ - renderFailure?(e: RenderFailureEventArgs): void; + /** Triggers before any AJAX request is passed from client-side to service methods. */ + beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; - /** Triggers when PivotClient successfully completes rendering. */ - renderSuccess?(e: RenderSuccessEventArgs): void; -} + /** Triggers before saving the current collection of reports. */ + saveReport?(e: SaveReportEventArgs): void; -export interface AfterServiceInvokeEventArgs { + /** Triggers before loading a saved collection of reports. */ + loadReport?(e: LoadReportEventArgs): void; - /** returns the current action of PivotClient control. - */ - action?: string; + /** Triggers before fetching the report collection from storage. */ + fetchReport?(e: FetchReportEventArgs): void; - /** returns the custom object bounds with PivotClient control. - */ - customObject?: any; + /** Triggers before exporting the control. */ + beforeExport?(e: BeforeExportEventArgs): void; - /** returns the HTML element of PivotClient control. - */ - element?: any; -} + /** Triggers before rendering the PivotChart. */ + chartLoad?(e: ChartLoadEventArgs): void; -export interface BeforeServiceInvokeEventArgs { + /** Triggers before rendering the PivotTreeMap. */ + treeMapLoad?(e: TreeMapLoadEventArgs): void; - /** returns the current action of PivotClient control. - */ - action?: string; + /** Triggers while we initiate loading of the widget. */ + load?(e: LoadEventArgs): void; - /** returns the custom object bounds with PivotClient control. - */ - customObject?: any; + /** Triggers when PivotClient widget completes all operations at client-end after any AJAX request. */ + renderComplete?(e: RenderCompleteEventArgs): void; - /** returns the HTML element of PivotClient control. - */ - element?: any; -} + /** Triggers when any error occurred during AJAX request. */ + renderFailure?(e: RenderFailureEventArgs): void; -export interface SaveReportEventArgs { + /** Triggers when PivotClient successfully completes rendering. */ + renderSuccess?(e: RenderSuccessEventArgs): void; + } - /** returns the current instance of PivotClient control. - */ - targetControl?: any; + export interface AfterServiceInvokeEventArgs { - /** returns the object which holds the necessary parameters required for saving the report collection. - */ - saveReportSetting?: any; -} + /** returns the current action of PivotClient control. + */ + action?: string; -export interface LoadReportEventArgs { + /** returns the custom object bounds with PivotClient control. + */ + customObject?: any; - /** returns the current instance of PivotClient control. - */ - targetControl?: any; + /** returns the HTML element of PivotClient control. + */ + element?: any; + } - /** returns the object which holds the necessary parameters required for loading a report collection from database. - */ - loadReportSetting?: any; -} + export interface BeforeServiceInvokeEventArgs { -export interface FetchReportEventArgs { + /** returns the current action of PivotClient control. + */ + action?: string; - /** returns the current instance of PivotClient control. - */ - targetControl?: any; + /** returns the custom object bounds with PivotClient control. + */ + customObject?: any; - /** returns the object which holds the necessary parameters required for fetching the report names stored in database. - */ - fetchReportSetting?: any; -} + /** returns the HTML element of PivotClient control. + */ + element?: any; + } -export interface BeforeExportEventArgs { + export interface SaveReportEventArgs { - /** holds the url of the service method responsible for exporting the PivotClient control. - */ - url?: string; + /** returns the current instance of PivotClient control. + */ + targetControl?: any; - /** holds the name of the file to be exported. - */ - fileName?: string; -} + /** returns the object which holds the necessary parameters required for saving the report collection. + */ + saveReportSetting?: any; + } -export interface ChartLoadEventArgs { + export interface LoadReportEventArgs { - /** returns the current action of PivotChart control. - */ - action?: string; + /** returns the current instance of PivotClient control. + */ + targetControl?: any; - /** returns the custom object bound with PivotChart control. - */ - customObject?: any; + /** returns the object which holds the necessary parameters required for loading a report collection from database. + */ + loadReportSetting?: any; + } - /** returns the HTML element of PivotChart control. - */ - element?: any; -} + export interface FetchReportEventArgs { -export interface TreeMapLoadEventArgs { + /** returns the current instance of PivotClient control. + */ + targetControl?: any; - /** returns the current action of PivotTreeMap control. - */ - action?: string; + /** returns the object which holds the necessary parameters required for fetching the report names stored in database. + */ + fetchReportSetting?: any; + } - /** returns the custom object bound with PivotTreeMap control. - */ - customObject?: any; + export interface BeforeExportEventArgs { - /** returns the HTML element of PivotTreeMap control. - */ - element?: any; -} + /** holds the url of the service method responsible for exporting the PivotClient control. + */ + url?: string; -export interface LoadEventArgs { + /** holds the name of the file to be exported. + */ + fileName?: string; + } - /** returns the HTML element of PivotClient component. - */ - element?: any; + export interface ChartLoadEventArgs { - /** returns the custom object bound with PivotTreeMap control. - */ - customObject?: any; -} + /** returns the current action of PivotChart control. + */ + action?: string; -export interface RenderCompleteEventArgs { + /** returns the custom object bound with PivotChart control. + */ + customObject?: any; - /** returns the HTML element of PivotClient component. - */ - element?: any; + /** returns the HTML element of PivotChart control. + */ + element?: any; + } - /** returns the custom object bound with PivotTreeMap control. - */ - customObject?: any; -} + export interface TreeMapLoadEventArgs { -export interface RenderFailureEventArgs { + /** returns the current action of PivotTreeMap control. + */ + action?: string; - /** returns the custom object bound with the control. - */ - customObject?: any; + /** returns the custom object bound with PivotTreeMap control. + */ + customObject?: any; - /** returns the HTML element of PivotClient control. - */ - element?: any; + /** returns the HTML element of PivotTreeMap control. + */ + element?: any; + } - /** returns the error message with error code. - */ - message?: string; -} + export interface LoadEventArgs { -export interface RenderSuccessEventArgs { + /** returns the HTML element of PivotClient component. + */ + element?: any; - /** returns the object of PivotClient control at that instant. - */ - args?: any; -} + /** returns the custom object bound with PivotTreeMap control. + */ + customObject?: any; + } -export interface DataSourceColumnsAdvancedFilter { + export interface RenderCompleteEventArgs { - /** Allows the user to provide level unique name to perform advanced filtering. - */ - name?: string; + /** returns the HTML element of PivotClient component. + */ + element?: any; - /** 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; + /** returns the custom object bound with PivotTreeMap control. + */ + customObject?: any; + } - /** Allows the user to set the filtering type while performing advanced filtering. - */ - advancedFilterType?: string; + export interface RenderFailureEventArgs { - /** 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 { + /** returns the custom object bound with the control. + */ + customObject?: any; - /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ - filterType?: ej.PivotAnalysis.FilterType|string; + /** returns the HTML element of PivotClient control. + */ + element?: any; - /** 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; - - /** 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} - */ - 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; + /** returns the error message with error code. + */ + message?: 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; + export interface RenderSuccessEventArgs { - /** 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; + /** returns the object of PivotClient control at that instant. + */ + args?: any; + } - /** 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; + export interface DataSourceColumnsAdvancedFilter { - /** 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 provide level unique name to perform advanced filtering. + */ + name?: 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 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 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 filtering type while performing advanced filtering. + */ + advancedFilterType?: string; - /** Returns the JSON records required to render the PivotGauge on performing any action with OLAP data source. - * @returns {void} - */ - getJSONData(): void; -} -export namespace PivotGauge { + /** 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 Model { + /** Sets the type of filter whether to include/exclude the mentioned values. + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ + filterType?: ej.PivotAnalysis.FilterType | string; - /** Sets the number of columns to arrange the Pivot Gauges. - * @Default {0} - */ - columnsCount?: number; + /** 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; - /** Specifies the CSS class to PivotGauge to achieve custom theme. - * @Default {“â€} - */ - cssClass?: 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; - /** 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; + /** 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; - /** Triggers when PivotGauge started loading at client-side. */ - load?(e: LoadEventArgs): void; + /** 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; - /** Triggers when PivotGauge widget completes all operations at client-side after any AJAX request. */ - renderComplete?(e: RenderCompleteEventArgs): void; + /** 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; - /** 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; -} + /** 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; -export interface AfterServiceInvokeEventArgs { + /** 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; - /** returns the custom object bound with PivotGauge control. - */ - customObject?: any; + /** 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 HTML element of PivotGauge control. - */ - element?: any; -} + /** 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 BeforeServiceInvokeEventArgs { + export interface Model { - /** returns the custom object bound with PivotGauge control. - */ - customObject?: any; + /** Sets the number of columns to arrange the Pivot Gauges. + * @Default {0} + */ + columnsCount?: number; - /** returns the HTML element of PivotGauge control. - */ - element?: any; -} + /** Specifies the CSS class to PivotGauge to achieve custom theme. + * @Default {“â€Â} + */ + cssClass?: string; -export interface BeforePivotEnginePopulateEventArgs { + /** 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; - /** returns the current instance of PivotGauge control. - */ - gaugeObject?: any; -} + /** Triggers when PivotGauge started loading at client-side. */ + load?(e: LoadEventArgs): void; -export interface LoadEventArgs { + /** Triggers when PivotGauge widget completes all operations at client-side after any AJAX request. */ + renderComplete?(e: RenderCompleteEventArgs): void; - /** returns the current action of PivotGauge control. - */ - action?: string; + /** 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; + } - /** returns the model of PivotGauge control. - */ - model?: any; + export interface AfterServiceInvokeEventArgs { - /** returns the HTML element of the widget. - */ - element?: any; + /** returns the custom object bound with PivotGauge control. + */ + customObject?: any; - /** returns the custom object bound to the control. - */ - customObject?: any; -} + /** returns the HTML element of PivotGauge control. + */ + element?: any; + } -export interface RenderCompleteEventArgs { + 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 RenderFailureEventArgs { + export interface BeforePivotEnginePopulateEventArgs { - /** returns the HTML element of PivotGauge control. - */ - element?: any; + /** returns the current instance of PivotGauge control. + */ + gaugeObject?: any; + } - /** returns the custom object bound with the control. - */ - customObject?: any; + export interface LoadEventArgs { - /** returns the error message with error code. - */ - message?: string; -} + /** returns the current action of PivotGauge control. + */ + action?: string; -export interface RenderSuccessEventArgs { + /** returns the model of PivotGauge control. + */ + model?: any; - /** returns the HTML element of PivotGauge control. - */ - element?: any; + /** returns the HTML element of the widget. + */ + element?: any; - /** returns the custom object bound with the control. - */ - customObject?: any; -} + /** returns the custom object bound to the control. + */ + customObject?: any; + } -export interface DataSourceColumnsFilterItems { + export interface RenderCompleteEventArgs { - /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ - filterType?: ej.PivotAnalysis.FilterType|string; + /** returns the custom object bound with PivotGauge control. + */ + customObject?: any; - /** Contains the collection of items to be included/excluded among the field members. - * @Default {[]} - */ - values?: any[]; -} + /** returns the HTML element of PivotGauge control. + */ + element?: any; + } -export interface DataSourceColumn { + export interface RenderFailureEventArgs { - /** Allows the user to bind the item by using its unique name as field name. - */ - fieldName?: string; + /** returns the HTML element of PivotGauge control. + */ + element?: any; - /** Applies filter to the field members. - * @Default {null} - */ - filterItems?: DataSourceColumnsFilterItems; -} + /** returns the custom object bound with the control. + */ + customObject?: any; -export interface DataSourceRowsFilterItems { + /** returns the error message with error code. + */ + message?: string; + } - /** Sets the type of filter whether to include/exclude the mentioned values. - * @Default {ej.PivotAnalysis.FilterType.Exclude} - */ - filterType?: ej.PivotAnalysis.FilterType|string; + export interface RenderSuccessEventArgs { - /** 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; + /** returns the HTML element of PivotGauge control. + */ + element?: 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[]; -} + /** returns the custom object bound with the control. + */ + customObject?: any; + } -export interface DataSourceFilter { - - /** Allows the user to bind the item by using its unique name as field name. - */ - fieldName?: string; + export interface DataSourceColumnsFilterItems { - /** Applies filter to the field members. - * @Default {null} - */ - filterItems?: DataSourceFiltersFilterItems; -} + /** Sets the type of filter whether to include/exclude the mentioned values. + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ + filterType?: ej.PivotAnalysis.FilterType | string; -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; + /** Contains the collection of items to be included/excluded among the field members. + * @Default {[]} + */ + values?: any[]; + } - /** This function receives the JSON formatted datasource to render the PivotTreeMap control. - * @returns {void} - */ - renderTreeMapFromJSON(): void; + export interface DataSourceColumn { - /** This function receives the update from service-end, which would be utilized for rendering the widget. - * @returns {void} - */ - renderControlSuccess(): void; -} -export namespace PivotTreeMap { + /** Allows the user to bind the item by using its unique name as field name. + */ + fieldName?: string; -export interface Model { + /** Applies filter to the field members. + * @Default {null} + */ + filterItems?: DataSourceColumnsFilterItems; + } - /** Specifies the CSS class to PivotTreeMap to achieve custom theme. - * @Default {“â€} - */ - cssClass?: string; + export interface DataSourceRowsFilterItems { - /** Initializes the data source for the PivotTreeMap widget, when it functions completely on client-side. - * @Default {{}} - */ - dataSource?: DataSource; + /** Sets the type of filter whether to include/exclude the mentioned values. + * @Default {ej.PivotAnalysis.FilterType.Exclude} + */ + filterType?: ej.PivotAnalysis.FilterType | string; - /** Object utilized to pass additional information between client-end and service-end. - * @Default {{}} - */ - customObject?: any; + /** 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 enable PivotTreeMap’s responsiveness in the browser layout. - * @Default {false} - */ - isResponsive?: 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 { + + /** 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[]; + } - /** Allows the user to set the localized language for the widget. - * @Default {en-US} - */ - locale?: string; + export interface DataSourceFilter { + + /** Allows the user to bind the item by using its unique name as field name. + */ + fieldName?: 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; + /** Applies filter to the field members. + * @Default {null} + */ + filterItems?: DataSourceFiltersFilterItems; + } - /** Allows the user to set custom name for the methods at service-end, communicated on AJAX post. - * @Default {{}} - */ - serviceMethodSettings?: ServiceMethodSettings; + 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; - /** Connects the service using the specified URL for any server updates. - * @Default {“â€} - */ - url?: string; + /** This function receives the JSON formatted datasource to render the PivotTreeMap control. + * @returns {void} + */ + renderTreeMapFromJSON(): void; - /** Triggers when it reaches client-side after any AJAX request. */ - afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; + /** This function receives the update from service-end, which would be utilized for rendering the widget. + * @returns {void} + */ + renderControlSuccess(): void; + } + export namespace PivotTreeMap { - /** Triggers before any AJAX request is passed from PivotTreeMap to service methods. */ - beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; + export interface Model { - /** Triggers when PivotTreeMap starts to render. */ - load?(e: LoadEventArgs): void; + /** Specifies the CSS class to PivotTreeMap to achieve custom theme. + * @Default {“â€Â} + */ + cssClass?: string; - /** 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; + /** Initializes the data source for the PivotTreeMap widget, when it functions completely on client-side. + * @Default {{}} + */ + dataSource?: DataSource; - /** Triggers when PivotTreeMap widget completes all operations at client-side after any AJAX request. */ - renderComplete?(e: RenderCompleteEventArgs): void; + /** Object utilized to pass additional information between client-end and service-end. + * @Default {{}} + */ + customObject?: any; - /** Triggers when any error occurred during AJAX request. */ - renderFailure?(e: RenderFailureEventArgs): void; + /** Allows the user to enable PivotTreeMap’s responsiveness in the browser layout. + * @Default {false} + */ + isResponsive?: boolean; - /** Triggers when PivotTreeMap successfully reaches client-side after any AJAX request. */ - renderSuccess?(e: RenderSuccessEventArgs): void; -} + /** Allows the user to set the localized language for the widget. + * @Default {en-US} + */ + locale?: string; -export interface AfterServiceInvokeEventArgs { + /** 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; - /** returns the current action of PivotTreeMap control. - */ - action?: string; + /** Allows the user to set custom name for the methods at service-end, communicated on AJAX post. + * @Default {{}} + */ + serviceMethodSettings?: ServiceMethodSettings; - /** returns the custom object bound with PivotTreeMap control. - */ - customObject?: any; + /** Connects the service using the specified URL for any server updates. + * @Default {“â€Â} + */ + url?: string; - /** returns the HTML element of PivotTreeMap control. - */ - element?: any; -} + /** Triggers when it reaches client-side after any AJAX request. */ + afterServiceInvoke?(e: AfterServiceInvokeEventArgs): void; -export interface BeforeServiceInvokeEventArgs { + /** Triggers before any AJAX request is passed from PivotTreeMap to service methods. */ + beforeServiceInvoke?(e: BeforeServiceInvokeEventArgs): void; - /** returns the current action of PivotTreeMap control. - */ - action?: string; + /** Triggers when PivotTreeMap starts to render. */ + load?(e: LoadEventArgs): void; - /** returns the custom object bound with PivotTreeMap control. - */ - customObject?: any; + /** 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; - /** returns the HTML element of PivotTreeMap control. - */ - element?: any; -} + /** Triggers when PivotTreeMap widget completes all operations at client-side after any AJAX request. */ + renderComplete?(e: RenderCompleteEventArgs): void; -export interface LoadEventArgs { + /** Triggers when any error occurred during AJAX request. */ + renderFailure?(e: RenderFailureEventArgs): void; - /** returns the current action of PivotTreeMap control. - */ - action?: string; + /** Triggers when PivotTreeMap successfully reaches client-side after any AJAX request. */ + renderSuccess?(e: RenderSuccessEventArgs): void; + } - /** returns the custom object bound with PivotTreeMap control. - */ - customObject?: any; + export interface AfterServiceInvokeEventArgs { - /** returns the HTML element of PivotTreeMap control. - */ - element?: any; -} + /** returns the current action of PivotTreeMap control. + */ + action?: string; -export interface BeforePivotEnginePopulateEventArgs { + /** returns the custom object bound with PivotTreeMap control. + */ + customObject?: any; - /** returns the current instance of PivotTreeMap control. - */ - treeMapObject?: any; -} + /** returns the HTML element of PivotTreeMap control. + */ + element?: any; + } -export interface DrillSuccessEventArgs { + export interface BeforeServiceInvokeEventArgs { - /** return the HTML element of PivotTreeMap control. - */ - element?: any; -} + /** returns the current action of PivotTreeMap control. + */ + action?: string; -export interface RenderCompleteEventArgs { + /** returns the custom object bound with PivotTreeMap control. + */ + customObject?: any; - /** returns the current action of PivotTreeMap control. - */ - action?: string; + /** returns the HTML element of PivotTreeMap control. + */ + element?: any; + } - /** returns the custom object bound with PivotTreeMap control. - */ - customObject?: any; + export interface LoadEventArgs { - /** returns the HTML element of PivotTreeMap control. - */ - element?: any; -} + /** returns the current action of PivotTreeMap control. + */ + action?: string; -export interface RenderFailureEventArgs { + /** returns the custom object bound with PivotTreeMap control. + */ + customObject?: any; - /** returns the current action of PivotTreeMap control. - */ - action?: string; + /** returns the HTML element of PivotTreeMap control. + */ + element?: any; + } - /** returns the custom object bound with PivotTreeMap control. - */ - customObject?: any; + export interface BeforePivotEnginePopulateEventArgs { - /** returns the HTML element of PivotTreeMap control. - */ - element?: any; + /** returns the current instance of PivotTreeMap control. + */ + treeMapObject?: any; + } - /** returns the error stack trace of the original exception. - */ - message?: string; -} + export interface DrillSuccessEventArgs { -export interface RenderSuccessEventArgs { + /** return the HTML element of PivotTreeMap control. + */ + element?: any; + } - /** returns the current action of PivotTreeMap control. - */ - action?: string; + export interface RenderCompleteEventArgs { - /** returns the custom object bound with PivotTreeMap control. - */ - customObject?: any; + /** returns the current action of PivotTreeMap control. + */ + action?: string; - /** returns the HTML element of PivotTreeMap control. - */ - element?: any; -} + /** returns the custom object bound with PivotTreeMap control. + */ + customObject?: any; -export interface DataSourceColumnsFilterItems { + /** returns the HTML element of PivotTreeMap control. + */ + element?: any; + } - /** Contains the collection of items to be excluded among the field members. - * @Default {[]} - */ - values?: any[]; -} + export interface RenderFailureEventArgs { -export interface DataSourceColumn { + /** returns the current action of PivotTreeMap control. + */ + action?: string; - /** Allows the user to bind the item by using its unique name as field name. - */ - fieldName?: string; + /** returns the custom object bound with PivotTreeMap control. + */ + customObject?: any; - /** Allows the user to indicate whether the added item is a named set or not. - * @Default {false} - */ - isNamedSets?: boolean; + /** returns the HTML element of PivotTreeMap control. + */ + element?: any; - /** 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 { + /** returns the error stack trace of the original exception. + */ + message?: 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; - - /** 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; + export interface RenderSuccessEventArgs { - /** Accepts the id value of the template layout defined for the all-day cells and customizes it. - * @Default {null} - */ - allDayCellsTemplateId?: string; + /** returns the current action of PivotTreeMap control. + */ + action?: string; - /** Accepts the id value of the template layout defined for the work cells and month cells. - * @Default {null} - */ - workCellsTemplateId?: string; + /** returns the custom object bound with PivotTreeMap control. + */ + customObject?: any; - /** Accepts the id value of the template layout defined for the date header cells and customizes it. - * @Default {null} - */ - dateHeaderTemplateId?: string; + /** returns the HTML element of PivotTreeMap control. + */ + element?: any; + } - /** 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; + export interface DataSourceColumnsFilterItems { - /** 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; + /** Contains the collection of items to be excluded among the field members. + * @Default {[]} + */ + values?: any[]; + } - /** When set to true, displays the other months days from the current month on the Schedule. - * @Default {true} - */ - showNextPrevMonth?: boolean; + export interface DataSourceColumn { - /** 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; + /** Allows the user to bind the item by using its unique name as field name. + */ + fieldName?: string; - /** Triggers on the beginning of every action that starts within the Schedule. */ - actionBegin?(e: ActionBeginEventArgs): void; + /** Allows the user to indicate whether the added item is a named set or not. + * @Default {false} + */ + isNamedSets?: boolean; - /** Triggers after the completion of every action within the Schedule. */ - actionComplete?(e: ActionCompleteEventArgs): void; + /** 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 { - /** Triggers after an appointment is clicked. */ - appointmentClick?(e: AppointmentClickEventArgs): void; + /** 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; - /** Triggers before the appointment is being removed from the Scheduler. */ - beforeAppointmentRemove?(e: BeforeAppointmentRemoveEventArgs): void; + /** Accepts the id value of the template layout defined for the all-day cells and customizes it. + * @Default {null} + */ + allDayCellsTemplateId?: string; - /** Triggers before the edited appointment is being saved. */ - beforeAppointmentChange?(e: BeforeAppointmentChangeEventArgs): void; + /** Accepts the id value of the template layout defined for the work cells and month cells. + * @Default {null} + */ + workCellsTemplateId?: string; - /** Triggers on hovering the mouse over the appointments. */ - appointmentHover?(e: AppointmentHoverEventArgs): void; + /** Accepts the id value of the template layout defined for the date header cells and customizes it. + * @Default {null} + */ + dateHeaderTemplateId?: string; - /** Triggers before the new appointment gets saved. */ - beforeAppointmentCreate?(e: BeforeAppointmentCreateEventArgs): void; + /** 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; - /** Triggers before the appointment window opens. */ - appointmentWindowOpen?(e: AppointmentWindowOpenEventArgs): void; + /** 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; - /** Triggers before the context menu opens. */ - beforeContextMenuOpen?(e: BeforeContextMenuOpenEventArgs): void; + /** When set to true, displays the other months days from the current month on the Schedule. + * @Default {true} + */ + showNextPrevMonth?: boolean; - /** Triggers after the cell is clicked. */ - cellClick?(e: CellClickEventArgs): void; + /** 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 after the cell is clicked twice. */ - cellDoubleClick?(e: CellDoubleClickEventArgs): void; + /** Triggers on the beginning of every action that starts within the Schedule. */ + actionBegin?(e: ActionBeginEventArgs): void; - /** Triggers on hovering the mouse overs the cells. */ - cellHover?(e: CellHoverEventArgs): void; + /** Triggers after the completion of every action within the Schedule. */ + actionComplete?(e: ActionCompleteEventArgs): void; - /** Triggers when the Scheduler completely renders on the page. */ - create?(e: CreateEventArgs): void; + /** Triggers after an appointment is clicked. */ + appointmentClick?(e: AppointmentClickEventArgs): void; - /** Triggers when the Scheduler and all its sub-components gets destroyed. */ - destroy?(e: DestroyEventArgs): void; + /** Triggers before the appointment is being removed from the Scheduler. */ + beforeAppointmentRemove?(e: BeforeAppointmentRemoveEventArgs): void; - /** Triggers while the appointment is being dragged over the work cells. */ - drag?(e: DragEventArgs): void; + /** Triggers before the edited appointment is being saved. */ + beforeAppointmentChange?(e: BeforeAppointmentChangeEventArgs): void; - /** Triggers when the appointment dragging begins. */ - dragStart?(e: DragStartEventArgs): void; + /** Triggers on hovering the mouse over the appointments. */ + appointmentHover?(e: AppointmentHoverEventArgs): void; - /** Triggers when the appointment is dropped. */ - dragStop?(e: DragStopEventArgs): void; + /** Triggers before the new appointment gets saved. */ + beforeAppointmentCreate?(e: BeforeAppointmentCreateEventArgs): void; - /** Triggers after the menu/sub-menu items within the context menu is clicked. */ - menuItemClick?(e: MenuItemClickEventArgs): void; + /** Triggers before the appointment window opens. */ + appointmentWindowOpen?(e: AppointmentWindowOpenEventArgs): void; - /** Triggers after the Schedule view or date is navigated. */ - navigation?(e: NavigationEventArgs): void; + /** Triggers before the context menu opens. */ + beforeContextMenuOpen?(e: BeforeContextMenuOpenEventArgs): 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 after the cell is clicked. */ + cellClick?(e: CellClickEventArgs): void; - /** Triggers when the reminder is raised for an appointment based on the alertBefore value. */ - reminder?(e: ReminderEventArgs): void; + /** Triggers after the cell is clicked twice. */ + cellDoubleClick?(e: CellDoubleClickEventArgs): void; - /** Triggers while resizing the appointment. */ - resize?(e: ResizeEventArgs): void; + /** Triggers on hovering the mouse overs the cells. */ + cellHover?(e: CellHoverEventArgs): void; - /** Triggers when the appointment resizing begins. */ - resizeStart?(e: ResizeStartEventArgs): void; + /** Triggers when the Scheduler completely renders on the page. */ + create?(e: CreateEventArgs): void; - /** Triggers when an appointment resizing stops. */ - resizeStop?(e: ResizeStopEventArgs): void; + /** Triggers when the Scheduler and all its sub-components gets destroyed. */ + destroy?(e: DestroyEventArgs): void; - /** Triggers when the overflow button is clicked. */ - overflowButtonClick?(e: OverflowButtonClickEventArgs): void; + /** Triggers while the appointment is being dragged over the work cells. */ + drag?(e: DragEventArgs): void; - /** Triggers while mouse hovering on the overflow button. */ - overflowButtonHover?(e: OverflowButtonHoverEventArgs): void; + /** Triggers when the appointment dragging begins. */ + dragStart?(e: DragStartEventArgs): void; - /** Triggers when any of the keyboard keys are pressed. */ - keyDown?(e: KeyDownEventArgs): void; + /** Triggers when the appointment is dropped. */ + dragStop?(e: DragStopEventArgs): void; - /** Triggers after the new appointment is saved. */ - appointmentCreated?(e: AppointmentCreatedEventArgs): void; + /** Triggers after the menu/sub-menu items within the context menu is clicked. */ + menuItemClick?(e: MenuItemClickEventArgs): void; - /** Triggers after an existing appointment is edited. */ - appointmentChanged?(e: AppointmentChangedEventArgs): void; + /** Triggers after the Schedule view or date is navigated. */ + navigation?(e: NavigationEventArgs): void; - /** Triggers after the appointment is deleted. */ - appointmentRemoved?(e: AppointmentRemovedEventArgs): 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; -export interface ActionBeginEventArgs { + /** Triggers when the reminder is raised for an appointment based on the alertBefore value. */ + reminder?(e: ReminderEventArgs): void; - /** Returns the current date value. - */ - currentDate?: any; + /** Triggers while resizing the appointment. */ + resize?(e: ResizeEventArgs): void; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Triggers when the appointment resizing begins. */ + resizeStart?(e: ResizeStartEventArgs): void; - /** Returns the current view value. - */ - currentView?: string; + /** Triggers when an appointment resizing stops. */ + resizeStop?(e: ResizeStopEventArgs): void; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Triggers when the overflow button is clicked. */ + overflowButtonClick?(e: OverflowButtonClickEventArgs): void; - /** Returns the action begin request type. - */ - requestType?: string; + /** Triggers while mouse hovering on the overflow button. */ + overflowButtonHover?(e: OverflowButtonHoverEventArgs): void; - /** Returns the target of the click. - */ - target?: any; + /** Triggers when any of the keyboard keys are pressed. */ + keyDown?(e: KeyDownEventArgs): void; - /** Returns the name of the event. - */ - type?: string; + /** Triggers after the new appointment is saved. */ + appointmentCreated?(e: AppointmentCreatedEventArgs): void; - /** Returns the save appointment value. - */ - data?: any; + /** Triggers after an existing appointment is edited. */ + appointmentChanged?(e: AppointmentChangedEventArgs): void; - /** Returns the id of delete appointment. - */ - id?: number; -} + /** Triggers after the appointment is deleted. */ + appointmentRemoved?(e: AppointmentRemovedEventArgs): void; + } -export interface ActionCompleteEventArgs { + export interface ActionBeginEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the current date value. + */ + currentDate?: any; - /** Returns the data about view change action. - */ - data?: 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 action complete request type. - */ - requestType?: string; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the name of the event. - */ - type?: string; + /** Returns the action begin request type. + */ + requestType?: string; - /** Returns the appointment data dropped. - */ - appointment?: any; -} + /** Returns the target of the click. + */ + target?: any; -export interface AppointmentClickEventArgs { + /** Returns the name of the event. + */ + type?: string; - /** Returns the object of appointmentClick event. - */ - object?: any; + /** Returns the save appointment value. + */ + data?: any; - /** Returns the clicked appointment object. - */ - appointment?: any; + /** Returns the id of delete appointment. + */ + id?: number; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface ActionCompleteEventArgs { - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the data about view change action. + */ + data?: any; -export interface BeforeAppointmentRemoveEventArgs { + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the action complete request type. + */ + requestType?: string; - /** Returns the deleted appointment object. - */ - appointment?: any; + /** Returns the name of the event. + */ + type?: string; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the appointment data dropped. + */ + appointment?: any; + } - /** Returns the name of the Scheduler event. - */ - type?: string; -} + export interface AppointmentClickEventArgs { -export interface BeforeAppointmentChangeEventArgs { + /** Returns the object of appointmentClick event. + */ + object?: any; - /** Returns the edited 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 Scheduler event. - */ - type?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface AppointmentHoverEventArgs { + export interface BeforeAppointmentRemoveEventArgs { - /** Returns the object of appointmentHover event. - */ - object?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the hovered appointment object. - */ - appointment?: any; + /** Returns the deleted appointment object. + */ + appointment?: any; - /** 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 event. - */ - type?: string; -} + export interface BeforeAppointmentChangeEventArgs { -export interface BeforeAppointmentCreateEventArgs { + /** Returns the edited 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 AppointmentHoverEventArgs { -export interface AppointmentWindowOpenEventArgs { + /** Returns the object of appointmentHover event. + */ + 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 hovered appointment object. + */ + appointment?: 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 Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the action name that triggers window open. - */ - originalEventType?: string; + export interface BeforeAppointmentCreateEventArgs { - /** Returns the start time of the double clicked cell. - */ - startTime?: any; + /** Returns the appointment object. + */ + appointment?: any; - /** Returns the target of the double clicked cell. - */ - target?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the name of the event. - */ - type?: string; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the edit appointment object. - */ - appointment?: any; + /** Returns the name of the Scheduler event. + */ + type?: string; + } - /** Returns the edit occurrence option value. - */ - edit?: boolean; -} + export interface AppointmentWindowOpenEventArgs { -export interface BeforeContextMenuOpenEventArgs { + /** 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 beforeContextMenuOpen 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 current cell index value. - */ - cellIndex?: number; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the current date value. - */ - currentDate?: any; + /** Returns the action name that triggers window open. + */ + originalEventType?: string; - /** Returns the current resource details, when multiple resources are present, otherwise returns null. - */ - resources?: any; + /** Returns the start time of the double clicked cell. + */ + startTime?: any; - /** Returns the current appointment details while opening the menu from appointment. - */ - appointment?: any; + /** Returns the target of the double clicked cell. + */ + target?: any; - /** Returns the object of before opening menu target. - */ - events?: any; + /** Returns the name of the event. + */ + type?: string; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the edit appointment object. + */ + appointment?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the edit occurrence option value. + */ + edit?: boolean; + } -export interface CellClickEventArgs { + export interface BeforeContextMenuOpenEventArgs { - /** Returns the object of cellClick 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 end time of the clicked cell. - */ - endTime?: any; + /** Returns the current cell index value. + */ + cellIndex?: number; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the current date value. + */ + currentDate?: any; - /** Returns the start time of the clicked cell. - */ - startTime?: any; + /** Returns the current resource details, when multiple resources are present, otherwise returns null. + */ + resources?: any; - /** Returns the target of the clicked cell. - */ - target?: any; + /** Returns the current appointment details while opening the menu from appointment. + */ + appointment?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the object of before opening menu target. + */ + events?: any; -export interface CellDoubleClickEventArgs { + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the object of cellDoubleClick event. - */ - object?: any; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface CellClickEventArgs { - /** Returns the end time of the double clicked cell. - */ - endTime?: any; + /** Returns the object of cellClick event. + */ + object?: any; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the start time of the double clicked cell. - */ - startTime?: any; + /** Returns the end time of the clicked cell. + */ + endTime?: any; - /** Returns the target of the double clicked cell. - */ - target?: any; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the start time of the clicked cell. + */ + startTime?: any; -export interface CellHoverEventArgs { + /** Returns the target of the clicked cell. + */ + target?: any; - /** Returns the object of cellHover event. - */ - object?: any; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface CellDoubleClickEventArgs { - /** Returns the index of the hovered cell. - */ - cellIndex?: any; + /** Returns the object of cellDoubleClick event. + */ + object?: any; - /** Returns the current date of the hovered cell. - */ - currentDate?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the end time of the double clicked cell. + */ + endTime?: any; - /** Returns the target of the clicked cell. - */ - target?: any; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the start time of the double clicked cell. + */ + startTime?: any; -export interface CreateEventArgs { + /** Returns the target of the double clicked cell. + */ + target?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + export interface CellHoverEventArgs { - /** Returns the name of the Scheduler event. - */ - type?: string; -} + /** Returns the object of cellHover event. + */ + object?: any; -export interface DestroyEventArgs { + /** 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 Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the current date of the hovered cell. + */ + currentDate?: any; - /** Returns the name of the Scheduler event. - */ - type?: string; -} + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; -export interface DragEventArgs { + /** Returns the target of the clicked cell. + */ + target?: any; - /** Returns the object of dragOver event. - */ - object?: any; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface CreateEventArgs { - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the target of the drag over appointment. - */ - target?: any; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the name of the Scheduler event. + */ + type?: string; + } -export interface DragStartEventArgs { + export interface DestroyEventArgs { - /** 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 name of the Scheduler event. + */ + type?: string; + } - /** Returns the target of the dragging appointment. - */ - target?: any; + export interface DragEventArgs { - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the object of dragOver event. + */ + object?: any; -export interface DragStopEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the object of dragDrop event. - */ - object?: any; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the dropped appointment object. - */ - appointment?: any; + /** Returns the target of the drag over appointment. + */ + target?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + export interface DragStartEventArgs { - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the object of dragStart event. + */ + object?: any; -export interface MenuItemClickEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the object of menuItemClick event. - */ - object?: any; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the target of the dragging appointment. + */ + target?: any; - /** Returns the object of menu item event. - */ - events?: any; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + export interface DragStopEventArgs { - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the object of dragDrop event. + */ + object?: any; -export interface NavigationEventArgs { + /** Returns the dropped appointment object. + */ + appointment?: 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 name of the event. + */ + type?: string; + } - /** Returns the current view value. - */ - currentView?: string; + export interface MenuItemClickEventArgs { - /** Returns the previous view value. - */ - previousView?: string; + /** Returns the object of menuItemClick event. + */ + object?: any; - /** Returns the target of the action. - */ - target?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the name of the event. - */ - type?: string; + /** Returns the object of menu item event. + */ + events?: any; - /** Returns the previous date of the Schedule. - */ - previousDate?: any; -} + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; -export interface QueryCellInfoEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface NavigationEventArgs { - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the current date object. + */ + currentDate?: any; - /** Returns the current appointment data. - */ - appointment?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the currently rendering DOM element. - */ - element?: any; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the name of the currently rendering element on the scheduler. - */ - requestType?: string; + /** Returns the current view value. + */ + currentView?: string; - /** Returns the cell type which is currently rendering on the Scheduler. - */ - cellType?: string; + /** Returns the previous view value. + */ + previousView?: string; - /** Returns the start date of the currently rendering appointment. - */ - currentAppointmentDate?: any; + /** Returns the target of the action. + */ + target?: any; - /** Returns the currently rendering cell information. - */ - cell?: any; + /** Returns the name of the event. + */ + type?: string; - /** Returns the currently rendering resource details. - */ - resource?: any; + /** Returns the previous date of the Schedule. + */ + previousDate?: any; + } - /** Returns the currently rendering date information. - */ - currentDay?: any; -} + export interface QueryCellInfoEventArgs { -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 current appointment data. + */ + appointment?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the currently rendering DOM element. + */ + element?: any; - /** Returns the appointment object for which the reminder is raised. - */ - reminderAppointment?: any; -} + /** Returns the name of the currently rendering element on the scheduler. + */ + requestType?: string; -export interface ResizeEventArgs { + /** Returns the cell type which is currently rendering on the Scheduler. + */ + cellType?: string; - /** Returns the object of resizing event. - */ - object?: any; + /** Returns the start date of the currently rendering appointment. + */ + currentAppointmentDate?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the currently rendering cell information. + */ + cell?: any; - /** Returns the resize element value. - */ - element?: any; + /** Returns the currently rendering resource details. + */ + resource?: any; - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the currently rendering date information. + */ + currentDay?: any; + } - /** Returns the name of the event. - */ - type?: string; -} + export interface ReminderEventArgs { -export interface ResizeStartEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the object of resizeStart event. - */ - object?: any; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the name of the event. + */ + type?: string; - /** Returns the resize element value. - */ - element?: any; + /** Returns the appointment object for which the reminder is raised. + */ + reminderAppointment?: any; + } - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + export interface ResizeEventArgs { - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the object of resizing event. + */ + object?: any; -export interface ResizeStopEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the object of resizeStop event. - */ - object?: any; + /** Returns the resize element value. + */ + element?: any; - /** Returns the resized appointment value. - */ - appointment?: any; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + export interface ResizeStartEventArgs { - /** Returns the target of the resized appointment. - */ - target?: any; + /** Returns the object of resizeStart event. + */ + object?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the cancel option value. + */ + cancel?: boolean; -export interface OverflowButtonClickEventArgs { + /** Returns the resize element value. + */ + element?: 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 Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the object of menu item event. - */ - events?: any; + export interface ResizeStopEventArgs { - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + /** Returns the object of resizeStop event. + */ + object?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the resized appointment value. + */ + appointment?: any; -export interface OverflowButtonHoverEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; - /** 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 Schedule model. + */ + model?: ej.Schedule.Model; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the target of the resized appointment. + */ + target?: any; - /** Returns the object of menu item event. - */ - events?: any; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the Schedule model. - */ - model?: ej.Schedule.Model; + export interface OverflowButtonClickEventArgs { - /** Returns the name of the event. - */ - type?: string; -} + /** 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; -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 OverflowButtonHoverEventArgs { -export interface AppointmentCreatedEventArgs { + /** 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 appointment object. - */ - appointment?: 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 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 event. + */ + type?: 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; + export interface KeyDownEventArgs { - /** To Specify the JsRender script Id to customize the task bar with our preference - */ - taskbarTemplate?: string; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** To Specify the JsRender script Id to customize the mile stone with our preference - */ - milestoneTemplate?: string; + /** Returns the object of menu item event. + */ + events?: any; - /** Enables or disables Gantt to read-only mode - * @Default {false} - */ - readOnly?: boolean; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Specifies the template id for tooltip on mouse action on taskbars - */ - taskbarTooltipTemplateId?: string; + /** Returns the name of the event. + */ + type?: string; + } - /** Specifies the mapping property path for task Id in datasource - */ - taskIdMapping?: string; + export interface AppointmentCreatedEventArgs { - /** Specifies the mapping property path for task name in datasource - */ - taskNameMapping?: string; + /** Returns the appointment object. + */ + appointment?: any; - /** Specifies the toolbarSettings options. - */ - toolbarSettings?: ToolbarSettings; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Specifies the tree expander column in Gantt - * @Default {0} - */ - treeColumnIndex?: number; + /** Returns the Schedule model. + */ + model?: ej.Schedule.Model; - /** Specifies the type of selection whether to select row or cell. - * @Default {ej.Gantt.SelectionMode.Row} - */ - selectionMode?: ej.Gantt.SelectionMode|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; - /** Specifies the weekendBackground color in Gantt - * @Default {#F2F2F2} - */ - weekendBackground?: 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; - /** Specifies the working time schedule of day - * @Default {ej.Gantt.workingTimeScale.TimeScale8Hours} - */ - workingTimeScale?: ej.Gantt.workingTimeScale|string; + /** To Specify the JsRender script Id to customize the task bar with our preference + */ + taskbarTemplate?: string; - /** Triggered for every Gantt action before its starts. */ - actionBegin?(e: ActionBeginEventArgs): void; + /** To Specify the JsRender script Id to customize the mile stone with our preference + */ + milestoneTemplate?: string; - /** Triggered for every Gantt action success event. */ - actionComplete?(e: ActionCompleteEventArgs): void; + /** Enables or disables Gantt to read-only mode + * @Default {false} + */ + readOnly?: boolean; - /** Triggered while enter the edit mode in the TreeGrid cell */ - beginEdit?(e: BeginEditEventArgs): void; + /** Specifies the template id for tooltip on mouse action on taskbars + */ + taskbarTooltipTemplateId?: string; - /** Triggered before selecting a cell */ - cellSelecting?(e: CellSelectingEventArgs): void; + /** Specifies the mapping property path for task Id in datasource + */ + taskIdMapping?: string; - /** Triggered after selected a cell */ - cellSelected?(e: CellSelectedEventArgs): void; + /** Specifies the mapping property path for task name in datasource + */ + taskNameMapping?: string; - /** Triggered while dragging a row in Gantt control */ - rowDrag?(e: RowDragEventArgs): void; + /** Specifies the toolbarSettings options. + */ + toolbarSettings?: ToolbarSettings; - /** Triggered while start to drag row in Gantt control */ - rowDragStart?(e: RowDragStartEventArgs): void; + /** Specifies the tree expander column in Gantt + * @Default {0} + */ + treeColumnIndex?: number; - /** Triggered while drop a row in Gantt control */ - rowDragStop?(e: RowDragStopEventArgs): void; + /** Specifies the type of selection whether to select row or cell. + * @Default {ej.Gantt.SelectionMode.Row} + */ + selectionMode?: ej.Gantt.SelectionMode | string; - /** Triggered after collapsed the Gantt record */ - collapsed?(e: CollapsedEventArgs): void; + /** Specifies the weekendBackground color in Gantt + * @Default {#F2F2F2} + */ + weekendBackground?: string; - /** Triggered while collapsing the Gantt record */ - collapsing?(e: CollapsingEventArgs): void; + /** Specifies the working time schedule of day + * @Default {ej.Gantt.workingTimeScale.TimeScale8Hours} + */ + workingTimeScale?: ej.Gantt.workingTimeScale | string; - /** Triggered while Context Menu is rendered in Gantt control */ - contextMenuOpen?(e: ContextMenuOpenEventArgs): void; + /** Triggered for every Gantt action before its starts. */ + actionBegin?(e: ActionBeginEventArgs): void; - /** Triggered when Gantt is rendered completely. */ - create?(e: CreateEventArgs): void; + /** Triggered for every Gantt action success event. */ + actionComplete?(e: ActionCompleteEventArgs): void; - /** Triggered after save the modified cellValue in Gantt. */ - endEdit?(e: EndEditEventArgs): void; + /** Triggered while enter the edit mode in the TreeGrid cell */ + beginEdit?(e: BeginEditEventArgs): void; - /** Triggered after expand the record */ - expanded?(e: ExpandedEventArgs): void; + /** Triggered before selecting a cell */ + cellSelecting?(e: CellSelectingEventArgs): void; - /** Triggered while expanding the Gantt record */ - expanding?(e: ExpandingEventArgs): void; + /** Triggered after selected a cell */ + cellSelected?(e: CellSelectedEventArgs): void; - /** Triggered while Gantt is loaded */ - load?(e: LoadEventArgs): void; + /** Triggered while dragging a row in Gantt control */ + rowDrag?(e: RowDragEventArgs): void; - /** Triggered while rendering each cell in the TreeGrid */ - queryCellInfo?(e: QueryCellInfoEventArgs): void; + /** Triggered while start to drag row in Gantt control */ + rowDragStart?(e: RowDragStartEventArgs): void; - /** Triggered while rendering each taskbar in the Gantt */ - queryTaskbarInfo?(e: QueryTaskbarInfoEventArgs): void; + /** Triggered while drop a row in Gantt control */ + rowDragStop?(e: RowDragStopEventArgs): void; - /** Triggered while rendering each row */ - rowDataBound?(e: RowDataBoundEventArgs): void; + /** Triggered after collapsed the Gantt record */ + collapsed?(e: CollapsedEventArgs): void; - /** Triggered after the row is selected. */ - rowSelected?(e: RowSelectedEventArgs): void; + /** Triggered while collapsing the Gantt record */ + collapsing?(e: CollapsingEventArgs): void; - /** Triggered before the row is going to be selected. */ - rowSelecting?(e: RowSelectingEventArgs): void; + /** Triggered while Context Menu is rendered in Gantt control */ + contextMenuOpen?(e: ContextMenuOpenEventArgs): void; - /** Triggered after completing the editing operation in taskbar */ - taskbarEdited?(e: TaskbarEditedEventArgs): void; + /** Triggered when Gantt is rendered completely. */ + create?(e: CreateEventArgs): void; - /** Triggered while editing the Gantt chart (dragging, resizing the taskbar ) */ - taskbarEditing?(e: TaskbarEditingEventArgs): void; + /** Triggered after save the modified cellValue in Gantt. */ + endEdit?(e: EndEditEventArgs): void; - /** Triggered when taskbar item is clicked in Gantt. */ - taskbarClick?(e: TaskbarClickEventArgs): void; + /** Triggered after expand the record */ + expanded?(e: ExpandedEventArgs): void; - /** Triggered when toolbar item is clicked in Gantt. */ - toolbarClick?(e: ToolbarClickEventArgs): void; -} + /** Triggered while expanding the Gantt record */ + expanding?(e: ExpandingEventArgs): void; -export interface ActionBeginEventArgs { + /** Triggered while Gantt is loaded */ + load?(e: LoadEventArgs): void; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Triggered while rendering each cell in the TreeGrid */ + queryCellInfo?(e: QueryCellInfoEventArgs): void; - /** Returns the grid model. - */ - model?: any; + /** Triggered while rendering each taskbar in the Gantt */ + queryTaskbarInfo?(e: QueryTaskbarInfoEventArgs): void; - /** Returns the name of the event. - */ - type?: string; + /** Triggered while rendering each row */ + rowDataBound?(e: RowDataBoundEventArgs): void; - /** Returns the current grouped column field name. - */ - columnName?: string; + /** Triggered after the row is selected. */ + rowSelected?(e: RowSelectedEventArgs): void; - /** Returns request type. - */ - requestType?: string; + /** Triggered before the row is going to be selected. */ + rowSelecting?(e: RowSelectingEventArgs): void; - /** Returns the direction of sorting ascending or descending - */ - columnSortDirection?: string; + /** Triggered after completing the editing operation in taskbar */ + taskbarEdited?(e: TaskbarEditedEventArgs): void; - /** Returns the value of searching element. - */ - keyValue?: string; + /** Triggered while editing the Gantt chart (dragging, resizing the taskbar ) */ + taskbarEditing?(e: TaskbarEditingEventArgs): void; - /** Returns the data of deleting element. - */ - data?: string; + /** Triggered when taskbar item is clicked in Gantt. */ + taskbarClick?(e: TaskbarClickEventArgs): void; - /** Returns selected record index - */ - recordIndex?: number; -} + /** Triggered when toolbar item is clicked in Gantt. */ + toolbarClick?(e: ToolbarClickEventArgs): void; + } -export interface ActionCompleteEventArgs { + 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 searched element. - */ - keyValue?: string; + /** Returns the value of searching element. + */ + keyValue?: string; - /** Returns the data of deleted 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 BeginEditEventArgs { + export interface ActionCompleteEventArgs { - /** 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 grid model. + */ + model?: any; - /** Returns the Element of editing cell. - */ - cellElement?: any; + /** Returns the name of the event. + */ + type?: string; - /** Returns the data of current cell record. - */ - data?: any; + /** Returns the current grouped column field name. + */ + columnName?: string; - /** Returns the column Index of cell belongs. - */ - columnIndex?: number; -} + /** Returns request type. + */ + requestType?: string; -export interface CellSelectingEventArgs { + /** Returns the direction of sorting ascending or descending + */ + columnSortDirection?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the value of searched element. + */ + keyValue?: string; - /** Returns the cell index on the selection. - */ - cellIndex?: number; + /** Returns the data of deleted element. + */ + data?: string; - /** Returns the row index on the selection - */ - rowIndex?: number; + /** Returns selected record index + */ + recordIndex?: number; + } - /** Returns the selecting cell element - */ - targetCell?: any; + export interface BeginEditEventArgs { - /** Returns the selecting row element - */ - targetRow?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the selecting record object - */ - data?: any; + /** Returns the row element of editing cell. + */ + rowElement?: any; - /** Returns the Gantt object Model - */ - model?: any; -} + /** Returns the Element of editing cell. + */ + cellElement?: any; -export interface CellSelectedEventArgs { + /** Returns the data of current cell record. + */ + data?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the column Index of cell belongs. + */ + columnIndex?: number; + } - /** Returns the cell index on the selection. - */ - cellIndex?: number; + export interface CellSelectingEventArgs { - /** Returns the row index on the selection - */ - rowIndex?: number; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the selecting cell element - */ - targetCell?: any; + /** Returns the cell index on the selection. + */ + cellIndex?: number; - /** Returns the selecting row element - */ - targetRow?: any; + /** Returns the row index on the selection + */ + rowIndex?: number; - /** Returns the selecting record object - */ - data?: any; + /** Returns the selecting cell element + */ + targetCell?: any; - /** Returns the Gantt object Model - */ - model?: any; + /** Returns the selecting row element + */ + targetRow?: any; - /** Returns the previously selected row data - */ - previousData?: any; + /** Returns the selecting record object + */ + data?: any; - /** Returns the previously selected cell index - */ - previousCellIndex?: any; + /** Returns the Gantt object Model + */ + model?: any; + } - /** Returns the previously selected row index - */ - previousRowIndex?: any; + export interface CellSelectedEventArgs { - /** Returns the previously selected cell element - */ - previousTargetCell?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the previously selected row element - */ - previousTargetRow?: any; -} + /** Returns the cell index on the selection. + */ + cellIndex?: number; -export interface RowDragEventArgs { + /** Returns the row index on the selection + */ + rowIndex?: number; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the selecting cell element + */ + targetCell?: any; - /** Returns the row which we start to drag. - */ - draggedRow?: any; + /** Returns the selecting row element + */ + targetRow?: any; - /** Returns the row index which we start to drag. - */ - draggedRowIndex?: number; + /** Returns the selecting record object + */ + data?: any; - /** Returns the row on which we are dragging. - */ - targetRow?: any; + /** Returns the Gantt object Model + */ + model?: any; - /** Returns the row index on which we are dragging. - */ - targetRowIndex?: number; + /** Returns the previously selected row data + */ + previousData?: any; - /** Returns that we can drop over that record or not. - */ - canDrop?: boolean; + /** Returns the previously selected cell index + */ + previousCellIndex?: any; - /** Returns the Gantt model. - */ - model?: any; + /** Returns the previously selected row index + */ + previousRowIndex?: any; - /** Returns request type. - */ - requestType?: string; + /** Returns the previously selected cell element + */ + previousTargetCell?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the previously selected row element + */ + previousTargetRow?: any; + } -export interface RowDragStartEventArgs { + 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?: boolean; + /** Returns the row index which we start to drag. + */ + draggedRowIndex?: number; - /** Returns the Gantt model. - */ - model?: any; + /** Returns the row on which we are dragging. + */ + targetRow?: any; - /** Returns request type. - */ - requestType?: string; + /** Returns the row index on which we are dragging. + */ + targetRowIndex?: number; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns that we can drop over that record or not. + */ + canDrop?: boolean; -export interface RowDragStopEventArgs { + /** Returns the Gantt model. + */ + model?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns request type. + */ + requestType?: string; - /** Returns the row which we start to drag. - */ - draggedRow?: any; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the row index which we start to drag. - */ - draggedRowIndex?: number; + export interface RowDragStartEventArgs { - /** Returns the row which we are dropped to row. - */ - targetRow?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the row index which we are dropped to row. - */ - targetRowIndex?: number; + /** Returns the row which we start to drag. + */ + draggedRow?: any; - /** Returns the Gantt model. - */ - model?: any; + /** Returns the row index which we start to drag. + */ + draggedRowIndex?: boolean; - /** Returns request type. - */ - requestType?: string; + /** Returns the Gantt model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns request type. + */ + requestType?: string; -export interface CollapsedEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface RowDragStopEventArgs { - /** Returns the row index of collapsed record. - */ - recordIndex?: number; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the data of collapsed record. - */ - data?: any; + /** Returns the row which we start to drag. + */ + draggedRow?: any; - /** Returns Request Type. - */ - requestType?: string; + /** Returns the row index which we start to drag. + */ + draggedRowIndex?: number; - /** Returns state of a record whether it is in expanded or collapsed state. - */ - expanded?: boolean; -} + /** Returns the row which we are dropped to row. + */ + targetRow?: any; -export interface CollapsingEventArgs { + /** Returns the row index which we are dropped to row. + */ + targetRowIndex?: number; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the Gantt model. + */ + model?: any; - /** Returns the row index of collapsing record. - */ - recordIndex?: number; + /** Returns request type. + */ + requestType?: string; - /** Returns the data of edited cell record.. - */ - data?: any; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns state of a record whether it is in expanded or collapsed state. - */ - expanded?: boolean; -} + export interface CollapsedEventArgs { -export interface ContextMenuOpenEventArgs { + /** 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 default context menu items to which we add custom items. - */ - contextMenuItems?: any[]; + /** Returns the data of collapsed record. + */ + data?: any; - /** Returns the Gantt model. - */ - model?: 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 the name of the event. - */ - type?: string; -} + export interface CollapsingEventArgs { -export interface CreateEventArgs { + /** 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 Gantt model - */ - model?: any; + /** Returns the data of edited cell record.. + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns state of a record whether it is in expanded or collapsed state. + */ + expanded?: boolean; + } -export interface EndEditEventArgs { + export interface ContextMenuOpenEventArgs { - /** 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 default context menu items to which we add custom items. + */ + contextMenuItems?: any[]; - /** Returns the Element of editing cell. - */ - cellElement?: any; + /** Returns the Gantt model. + */ + model?: any; - /** Returns the data of edited cell record. - */ - data?: any; + /** Returns request type. + */ + requestType?: string; - /** Returns the column name of edited cell belongs. - */ - columnName?: string; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the column object of edited cell belongs. - */ - columnObject?: any; -} + export interface CreateEventArgs { -export interface ExpandedEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the Gantt model + */ + model?: any; - /** Returns the row index of record. - */ - recordIndex?: number; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the data of expanded record. - */ - data?: any; + export interface EndEditEventArgs { - /** Returns Request Type. - */ - requestType?: string; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns state of a record whether it is in expanded or collapsed state. - */ - expanded?: boolean; -} + /** Returns the row element of editing cell. + */ + rowElement?: any; -export interface ExpandingEventArgs { + /** Returns the Element of editing cell. + */ + cellElement?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the data of edited cell record. + */ + data?: any; - /** Returns the row index of record. - */ - recordIndex?: any; + /** Returns the column name of edited cell belongs. + */ + columnName?: string; - /** Returns the data of edited cell record.. - */ - data?: any; + /** Returns the column object of edited cell belongs. + */ + columnObject?: any; + } - /** Returns state of a record whether it is in expanded or collapsed state. - */ - expanded?: boolean; -} + export interface ExpandedEventArgs { -export interface LoadEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the row index of record. + */ + recordIndex?: number; - /** Returns the Gantt model - */ - model?: any; + /** Returns the data of expanded record. + */ + data?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns Request Type. + */ + requestType?: string; -export interface QueryCellInfoEventArgs { + /** Returns state of a record whether it is in expanded or collapsed state. + */ + expanded?: boolean; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface ExpandingEventArgs { - /** Returns the selecting cell element. - */ - cellElement?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the value of cell. - */ - cellValue?: string; + /** Returns the row index of record. + */ + recordIndex?: any; - /** Returns the data of current cell record. - */ - data?: any; + /** Returns the data of edited cell record.. + */ + data?: any; - /** Returns the column of cell belongs. - */ - column?: any; -} + /** Returns state of a record whether it is in expanded or collapsed state. + */ + expanded?: boolean; + } -export interface QueryTaskbarInfoEventArgs { + export interface LoadEventArgs { - /** 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 Gantt model + */ + model?: any; - /** Returns the progressbar background of current item. - */ - ProgressbarBackground?: string; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the parent taskbar background of current item. - */ - parentTaskbarBackground?: string; + export interface QueryCellInfoEventArgs { - /** Returns the parent progressbar background of current item. - */ - parentProgressbarBackground?: string; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the data of the record. - */ - data?: any; -} + /** Returns the selecting cell element. + */ + cellElement?: any; -export interface RowDataBoundEventArgs { + /** Returns the value of cell. + */ + cellValue?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the data of current cell record. + */ + data?: any; - /** Returns the row element of rendering row. - */ - rowElement?: any; + /** Returns the column of cell belongs. + */ + column?: any; + } - /** Returns the data of rendering row record.. - */ - data?: any; -} + export interface QueryTaskbarInfoEventArgs { -export interface RowSelectedEventArgs { + /** 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 selecting row element. - */ - targetRow?: any; + /** Returns the progressbar background of current item. + */ + ProgressbarBackground?: string; - /** Returns the index of selecting row record. - */ - recordIndex?: number; + /** Returns the parent taskbar background of current item. + */ + parentTaskbarBackground?: string; - /** Returns the data of selected record. - */ - data?: any; -} + /** Returns the parent progressbar background of current item. + */ + parentProgressbarBackground?: string; -export interface RowSelectingEventArgs { + /** Returns the data of the record. + */ + data?: any; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface RowDataBoundEventArgs { - /** Returns the data selecting record. - */ - data?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the index of selecting row record. - */ - recordIndex?: string; + /** Returns the row element of rendering row. + */ + rowElement?: any; - /** Returns the selecting row chart element. - */ - targetChartRow?: any; + /** Returns the data of rendering row record.. + */ + data?: any; + } - /** Returns the selecting row grid element. - */ - targetGridRow?: any; + export interface RowSelectedEventArgs { - /** Returns the previous selected data. - */ - previousData?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the previous selected row index. - */ - previousIndex?: string; + /** Returns the selecting row element. + */ + targetRow?: any; - /** Returns the previous selected row chart element. - */ - previousChartRow?: any; + /** Returns the index of selecting row record. + */ + recordIndex?: number; - /** Returns the previous selected row grid element. - */ - previousGridRow?: any; -} + /** Returns the data of selected record. + */ + data?: any; + } -export interface TaskbarEditedEventArgs { + export interface RowSelectingEventArgs { - /** 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 selecting record. + */ + data?: any; - /** Returns the previous data value of edited record. - */ - previousData?: any; + /** Returns the index of selecting row record. + */ + recordIndex?: string; - /** Returns 'true' if taskbar is dragged. - */ - dragging?: boolean; + /** Returns the selecting row chart element. + */ + targetChartRow?: any; - /** Returns 'true' if taskbar is left resized. - */ - leftResizing?: boolean; + /** Returns the selecting row grid element. + */ + targetGridRow?: any; - /** Returns 'true' if taskbar is right resized. - */ - rightResizing?: boolean; + /** Returns the previous selected data. + */ + previousData?: any; - /** Returns 'true' if taskbar is progress resized. - */ - progressResizing?: boolean; + /** Returns the previous selected row index. + */ + previousIndex?: string; - /** Returns the field values of record being edited. - */ - editingFields?: any; + /** Returns the previous selected row chart element. + */ + previousChartRow?: any; - /** Returns the Gantt model. - */ - model?: any; -} + /** Returns the previous selected row grid element. + */ + previousGridRow?: any; + } -export interface TaskbarEditingEventArgs { + export interface TaskbarEditedEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the Gantt model. - */ - model?: any; + /** Returns the data of edited record. + */ + data?: any; - /** Returns the row object being edited. - */ - rowData?: any; + /** Returns the previous data value of edited record. + */ + previousData?: any; - /** Returns the field values of record being edited. - */ - editingFields?: any; + /** Returns 'true' if taskbar is dragged. + */ + dragging?: boolean; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns 'true' if taskbar is left resized. + */ + leftResizing?: boolean; -export interface TaskbarClickEventArgs { + /** Returns 'true' if taskbar is right resized. + */ + rightResizing?: boolean; - /** Returns currently clicked row data - */ - data?: any; + /** Returns 'true' if taskbar is progress resized. + */ + progressResizing?: boolean; - /** 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 field values of record being edited. + */ + editingFields?: any; - /** 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 Gantt model. + */ + model?: any; + } - /** Specified the format for year view in schedule header - * @Default {yyyy} - */ - yearHeaderFormat?: string; + export interface TaskbarEditingEventArgs { - /** 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; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Specifies the start day of the week in week timescale mode - * @Default {0} - */ - weekStartDay?: number; -} + /** Returns the Gantt model. + */ + model?: any; -export interface SizeSettings { + /** Returns the row object being edited. + */ + rowData?: any; - /** Specifies the height of Gantt control - * @Default {450px} - */ - height?: string; + /** Returns the field values of record being edited. + */ + editingFields?: any; - /** Specifies the width of Gantt control - * @Default {1000px} - */ - width?: string; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface SelectedCellIndex { + export interface TaskbarClickEventArgs { - /** Specifies the row index of the cell to be selected Gantt control - */ - rowIndex?: number; + /** Returns currently clicked row data + */ + data?: any; - /** Specifies the cell index to be selected in the row. - * @Default { } - */ - cellIndex?: number; -} + /** 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 { -export interface SortSettings { + /** 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; - /** Specifies the sorted columns for Gantt - * @Default {[]} - */ - sortedColumns?: any[]; -} + /** Specified the format for year view in schedule header + * @Default {yyyy} + */ + yearHeaderFormat?: string; -export interface ToolbarSettings { + /** 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 state of enabling or disabling toolbar - * @Default {true} - */ - showToolbar?: boolean; + /** Specifies the start day of the week in week timescale mode + * @Default {0} + */ + weekStartDay?: number; + } - /** Specifies the list of toolbar items to be rendered in Gantt toolbar - * @Default {[]} - */ - toolbarItems?: any[]; -} + export interface SizeSettings { -enum DurationUnit { + /** Specifies the height of Gantt control + * @Default {450px} + */ + height?: string; - ///Sets the Duration Unit as day. - Day, + /** Specifies the width of Gantt control + * @Default {1000px} + */ + width?: string; + } - ///Sets the Duration Unit as hour. - Hour, + export interface SelectedCellIndex { - ///Sets the Duration Unit as minute. - Minute -} + /** 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; + } -enum BeginEditAction { + export interface SortSettings { - ///you can begin the editing at double click - DblClick, + /** Specifies the sorted columns for Gantt + * @Default {[]} + */ + sortedColumns?: any[]; + } - ///you can begin the editing at single click - Click -} + export interface ToolbarSettings { + /** Specifies the state of enabling or disabling toolbar + * @Default {true} + */ + showToolbar?: boolean; -enum RowPosition { + /** Specifies the list of toolbar items to be rendered in Gantt toolbar + * @Default {[]} + */ + toolbarItems?: any[]; + } - ///you can add a new row at top. - Top, + enum DurationUnit { - ///you can add a new row at bottom. - Bottom, + ///Sets the Duration Unit as day. + Day, - ///you can add a new row to above selected row. - AboveSelectedRow, + ///Sets the Duration Unit as hour. + Hour, - ///you can add a new row to below selected row. - BelowSelectedRow, + ///Sets the Duration Unit as minute. + Minute + } - ///you can add a new row as a child for selected row. - Child -} + enum BeginEditAction { -enum TaskType { + ///you can begin the editing at double click + DblClick, - ///Resource unit remains constant while editing the work and duration values. - FixedUnit, + ///you can begin the editing at single click + Click + } - ///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 -} + enum RowPosition { + ///you can add a new row at top. + Top, -enum WorkUnit { + ///you can add a new row at bottom. + Bottom, - ///Displays the work involved in a task in days. - Day, + ///you can add a new row to above selected row. + AboveSelectedRow, - ///Displays the work involved in a task in hours. - Hour, + ///you can add a new row to below selected row. + BelowSelectedRow, - ///Displays the work involved in a task in minutes - Minute -} + ///you can add a new row as a child for selected row. + Child + } -enum TaskSchedulingMode { + enum TaskType { - ///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, + ///Resource unit remains constant while editing the work and duration values. + FixedUnit, - ///All the tasks in the project will be displayed in manually scheduled mode. - Manual, + ///Work value of a task remains constant while editing duration and resource unit values. + FixedWork, - ///Project consists of tasks with both auto and manually scheduled modes, based on the datasource values - Custom -} + ///Duration value remains constant while editing work and resource unit values. + FixedDuration + } -enum SelectionType { + enum WorkUnit { - ///you can select a single row. - Single, + ///Displays the work involved in a task in days. + Day, - ///you can select a multiple row. - Multiple -} + ///Displays the work involved in a task in hours. + Hour, + ///Displays the work involved in a task in minutes + Minute + } -enum minutesPerInterval { - ///Sets the interval automatically according with schedule start and end date. - Auto, + enum TaskSchedulingMode { - ///Sets one minute intervals per hour. - OneMinute, + ///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, - ///Sets Five minute intervals per hour. - FiveMinutes, + ///All the tasks in the project will be displayed in manually scheduled mode. + Manual, - ///Sets fifteen minute intervals per hour. - FifteenMinutes, + ///Project consists of tasks with both auto and manually scheduled modes, based on the datasource values + Custom + } - ///Sets thirty minute intervals per hour. - ThirtyMinutes -} + enum SelectionType { -enum ScheduleHeaderType { + ///you can select a single row. + Single, - ///Sets year Schedule Mode. - Year, + ///you can select a multiple row. + Multiple + } - ///Sets month Schedule Mode. - Month, - ///Sets week Schedule Mode. - Week, + enum minutesPerInterval { - ///Sets day Schedule Mode. - Day, + ///Sets the interval automatically according with schedule start and end date. + Auto, - ///Sets hour Schedule Mode. - Hour -} + ///Sets one minute intervals per hour. + OneMinute, + ///Sets Five minute intervals per hour. + FiveMinutes, -enum TimescaleRoundMode { + ///Sets fifteen minute intervals per hour. + FifteenMinutes, - ///The round-off value will be automatically calculated based on the data source values. - Auto, + ///Sets thirty minute intervals per hour. + ThirtyMinutes + } - ///Schedule header start date will round-off to the immediate week. - Week, - ///Schedule headers start date will round off to the immediate month - Month, + enum ScheduleHeaderType { - ///Schedule headers start date will round off to the immediate year - Year -} + ///Sets year Schedule Mode. + Year, + ///Sets month Schedule Mode. + Month, -enum SelectionMode { + ///Sets week Schedule Mode. + Week, - ///you can select a row. - Row, + ///Sets day Schedule Mode. + Day, - ///you can select a cell. - Cell -} + ///Sets hour Schedule Mode. + Hour + } -enum workingTimeScale { + enum TimescaleRoundMode { - ///Sets eight hour timescale. - TimeScale8Hours, + ///The round-off value will be automatically calculated based on the data source values. + Auto, - ///Sets twenty four hour timescale. - TimeScale24Hours -} + ///Schedule header start date will round-off to the immediate week. + Week, -} + ///Schedule headers start date will round off to the immediate month + Month, -class ReportViewer extends ej.Widget { - static fn: ReportViewer; - constructor(element: JQuery | Element, options?: ReportViewer.Model); - static Locale: any; - model: ReportViewer.Model; - defaults: ReportViewer.Model; + ///Schedule headers start date will round off to the immediate year + Year + } - /** Export the report to the specified format. - * @returns {void} - */ - exportReport(): void; - /** Fit the report page to the container. - * @returns {void} - */ - fitToPage(): void; + enum SelectionMode { - /** Fit the report page height to the container. - * @returns {void} - */ - fitToPageHeight(): void; + ///you can select a row. + Row, - /** Fit the report page width to the container. - * @returns {void} - */ - fitToPageWidth(): void; + ///you can select a cell. + Cell + } - /** Get the available datasets name of the rdlc report. - * @returns {void} - */ - getDataSetNames(): void; - /** Get the available parameters of the report. - * @returns {void} - */ - getParameters(): void; + enum workingTimeScale { - /** Navigate to first page of report. - * @returns {void} - */ - gotoFirstPage(): void; + ///Sets eight hour timescale. + TimeScale8Hours, - /** 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; + ///Sets twenty four hour timescale. + TimeScale24Hours + } - /** 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; + class ReportViewer extends ej.Widget { + static fn: ReportViewer; + constructor(element: JQuery | Element, options?: ReportViewer.Model); + static Locale: any; + model: ReportViewer.Model; + defaults: ReportViewer.Model; - /** 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; + /** Export the report to the specified format. + * @returns {void} + */ + exportReport(): 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; + /** Fit the report page to the container. + * @returns {void} + */ + fitToPage(): 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; + /** Fit the report page height to the container. + * @returns {void} + */ + fitToPageHeight(): void; - /** Fires when click the View Report Button. */ - viewReportClick?(e: ViewReportClickEventArgs): void; -} + /** Fit the report page width to the container. + * @returns {void} + */ + fitToPageWidth(): void; -export interface DestroyEventArgs { + /** Get the available datasets name of the rdlc report. + * @returns {void} + */ + getDataSetNames(): void; - /** true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** Get the available parameters of the report. + * @returns {void} + */ + getParameters(): void; - /** returns the report model. - */ - model?: any; + /** Navigate to first page of report. + * @returns {void} + */ + gotoFirstPage(): void; - /** returns the name of the event. - */ - type?: string; -} + /** 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; -export interface DrillThroughEventArgs { + /** 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; - /** true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** 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; - /** returns the actionInfo's parameters bookmarkLink, hyperLink, reportName, parameters. - */ - actionInfo?: any; + /** 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; - /** returns the report model. - */ - model?: any; + /** 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; - /** returns the name of the event. - */ - type?: string; -} + /** 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; -export interface RenderingBeginEventArgs { + /** Fires when click the View Report Button. */ + viewReportClick?(e: ViewReportClickEventArgs): void; + } - /** true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + export interface DestroyEventArgs { - /** returns the report model. - */ - model?: any; + /** true if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the name of the event. - */ - type?: string; -} + /** returns the report model. + */ + model?: any; -export interface RenderingCompleteEventArgs { + /** returns the name of the event. + */ + type?: string; + } - /** true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + export interface DrillThroughEventArgs { - /** returns the report model. - */ - model?: any; + /** true if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the name of the event. - */ - type?: string; + /** returns the actionInfo's parameters bookmarkLink, hyperLink, reportName, parameters. + */ + actionInfo?: any; - /** returns the collection of parameters. - */ - reportParameters?: any; -} + /** returns the report model. + */ + model?: any; -export interface ReportErrorEventArgs { + /** returns the name of the event. + */ + type?: string; + } - /** true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + export interface RenderingBeginEventArgs { - /** returns the error details. - */ - error?: string; + /** 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 ReportExportEventArgs { + 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; -export interface ReportLoadedEventArgs { + /** returns the collection of parameters. + */ + reportParameters?: any; + } - /** true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + export interface ReportErrorEventArgs { - /** returns the report model. - */ - model?: any; + /** true if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the name of the event. - */ - type?: string; -} + /** returns the error details. + */ + error?: 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[]; -} + /** returns the report model. + */ + model?: any; -export interface ExportSettings { + /** returns the name of the event. + */ + type?: string; + } - /** Specifies the export formats. - * @Default {ej.ReportViewer.ExportOptions.All} - */ - exportOptions?: ej.ReportViewer.ExportOptions|string; + export interface ReportExportEventArgs { - /** Specifies the excel export format. - * @Default {ej.ReportViewer.ExcelFormats.Excel97to2003} - */ - excelFormat?: ej.ReportViewer.ExcelFormats|string; + /** true if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Specifies the word export format. - * @Default {ej.ReportViewer.WordFormats.Doc} - */ - wordFormat?: ej.ReportViewer.WordFormats|string; -} + /** returns the report model. + */ + model?: any; -export interface PageSettings { + /** returns the name of the event. + */ + type?: string; + } - /** Specifies the print layout orientation. - * @Default {null} - */ - orientation?: ej.ReportViewer.Orientation|string; + export interface ReportLoadedEventArgs { - /** Specifies the paper size of print layout. - * @Default {null} - */ - paperSize?: ej.ReportViewer.PaperSize|string; -} + /** true if the event should be canceled; otherwise, false. + */ + cancel?: boolean; -export interface Parameter { + /** returns the report model. + */ + model?: any; - /** Gets or sets the parameter labels. - * @Default {null} - */ - labels?: any[]; + /** returns the name of the event. + */ + type?: string; + } - /** Gets or sets the name of the parameter. - * @Default {empty} - */ - name?: 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[]; + } - /** Gets or sets whether the parameter allows nullable value or not. - * @Default {false} - */ - nullable?: boolean; + export interface ExportSettings { - /** Gets or sets the prompt message associated with the specified parameter. - * @Default {empty} - */ - prompt?: string; + /** Specifies the export formats. + * @Default {ej.ReportViewer.ExportOptions.All} + */ + exportOptions?: ej.ReportViewer.ExportOptions | string; - /** Gets or sets the parameter values. - * @Default {[]} - */ - values?: any[]; -} + /** Specifies the excel export format. + * @Default {ej.ReportViewer.ExcelFormats.Excel97to2003} + */ + excelFormat?: ej.ReportViewer.ExcelFormats | string; -export interface ToolbarSettings { + /** Specifies the word export format. + * @Default {ej.ReportViewer.WordFormats.Doc} + */ + wordFormat?: ej.ReportViewer.WordFormats | string; + } - /** Fires when user click on toolbar item in the toolbar. - * @Default {empty} - */ - click?: string; + export interface PageSettings { - /** Specifies the toolbar items. - * @Default {ej.ReportViewer.ToolbarItems.All} - */ - items?: ej.ReportViewer.ToolbarItems|string; + /** Specifies the print layout orientation. + * @Default {null} + */ + orientation?: ej.ReportViewer.Orientation | string; - /** Shows or hides the toolbar. - * @Default {true} - */ - showToolbar?: boolean; + /** Specifies the paper size of print layout. + * @Default {null} + */ + paperSize?: ej.ReportViewer.PaperSize | string; + } - /** Shows or hides the tooltip of toolbar items. - * @Default {true} - */ - showTooltip?: boolean; + export interface Parameter { - /** Specifies the toolbar template ID. - * @Default {empty} - */ - templateId?: string; -} + /** Gets or sets the parameter labels. + * @Default {null} + */ + labels?: any[]; -enum ExportOptions { + /** Gets or sets the name of the parameter. + * @Default {empty} + */ + name?: string; - ///Specifies the All property in ExportOptions to get all available options. - All, + /** Gets or sets whether the parameter allows nullable value or not. + * @Default {false} + */ + nullable?: boolean; - ///Specifies the PDF property in ExportOptions to get PDF option. - PDF, + /** Gets or sets the prompt message associated with the specified parameter. + * @Default {empty} + */ + prompt?: string; - ///Specifies the Word property in ExportOptions to get Word option. - Word, + /** Gets or sets the parameter values. + * @Default {[]} + */ + values?: any[]; + } - ///Specifies the Excel property in ExportOptions to get Excel option. - Excel, + export interface ToolbarSettings { - ///Specifies the HTML property in ExportOptions to get HTML option. - HTML -} + /** 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; -enum ExcelFormats { + /** Shows or hides the toolbar. + * @Default {true} + */ + showToolbar?: boolean; - ///Specifies the Excel97to2003 property in ExcelFormats to get specified version of exported format. - Excel97to2003, + /** Shows or hides the tooltip of toolbar items. + * @Default {true} + */ + showTooltip?: boolean; - ///Specifies the Excel2007 property in ExcelFormats to get specified version of exported format. - Excel2007, + /** Specifies the toolbar template ID. + * @Default {empty} + */ + templateId?: string; + } - ///Specifies the Excel2010 property in ExcelFormats to get specified version of exported format. - Excel2010, + enum ExportOptions { - ///Specifies the Excel2013 property in ExcelFormats to get specified version of exported format. - Excel2013 -} + ///Specifies the All property in ExportOptions to get all available options. + All, + ///Specifies the PDF property in ExportOptions to get PDF option. + PDF, -enum WordFormats { + ///Specifies the Word property in ExportOptions to get Word option. + Word, - ///Specifies the Doc property in WordFormats to get specified version of exported format. - Doc, + ///Specifies the Excel property in ExportOptions to get Excel option. + Excel, - ///Specifies the Dot property in WordFormats to get specified version of exported format. - Dot, + ///Specifies the HTML property in ExportOptions to get HTML option. + HTML + } - ///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, + enum ExcelFormats { - ///Specifies the Word2010 property in WordFormats to get specified version of exported format. - Word2010, + ///Specifies the Excel97to2003 property in ExcelFormats to get specified version of exported format. + Excel97to2003, - ///Specifies the Word2013 property in WordFormats to get specified version of exported format. - Word2013, + ///Specifies the Excel2007 property in ExcelFormats to get specified version of exported format. + Excel2007, - ///Specifies the Word2007Dotx property in WordFormats to get specified version of exported format. - Word2007Dotx, + ///Specifies the Excel2010 property in ExcelFormats to get specified version of exported format. + Excel2010, - ///Specifies the Word2010Dotx property in WordFormats to get specified version of exported format. - Word2010Dotx, + ///Specifies the Excel2013 property in ExcelFormats to get specified version of exported format. + Excel2013 + } - ///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, + enum WordFormats { - ///Specifies the Word2010Docm property in WordFormats to get specified version of exported format. - Word2010Docm, + ///Specifies the Doc property in WordFormats to get specified version of exported format. + Doc, - ///Specifies the Word2013Docm property in WordFormats to get specified version of exported format. - Word2013Docm, + ///Specifies the Dot property in WordFormats to get specified version of exported format. + Dot, - ///Specifies the Word2007Dotm property in WordFormats to get specified version of exported format. - Word2007Dotm, + ///Specifies the DOCX property in WordFormats to get specified version of exported format. + DOCX, - ///Specifies the Word2010Dotm property in WordFormats to get specified version of exported format. - Word2010Dotm, + ///Specifies the Word2007 property in WordFormats to get specified version of exported format. + Word2007, - ///Specifies the Word2013Dotm property in WordFormats to get specified version of exported format. - Word2013Dotm, + ///Specifies the Word2010 property in WordFormats to get specified version of exported format. + Word2010, - ///Specifies the RTF property in WordFormats to get specified version of exported format. - RTF, + ///Specifies the Word2013 property in WordFormats to get specified version of exported format. + Word2013, - ///Specifies the Txt property in WordFormats to get specified version of exported format. - Txt, + ///Specifies the Word2007Dotx property in WordFormats to get specified version of exported format. + Word2007Dotx, - ///Specifies the EPUB property in WordFormats to get specified version of exported format. - EPUB, + ///Specifies the Word2010Dotx property in WordFormats to get specified version of exported format. + Word2010Dotx, - ///Specifies the HTML property in WordFormats to get specified version of exported format. - HTML, + ///Specifies the Word2013Dotx property in WordFormats to get specified version of exported format. + Word2013Dotx, - ///Specifies the XML property in WordFormats to get specified version of exported format. - XML, + ///Specifies the Word2007Docm property in WordFormats to get specified version of exported format. + Word2007Docm, - ///Specifies the Automatic property in WordFormats to get specified version of exported format. - Automatic -} + ///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, -enum Orientation { + ///Specifies the Word2007Dotm property in WordFormats to get specified version of exported format. + Word2007Dotm, - ///Specifies the Landscape property in pageSettings.orientation to get specified layout. - Landscape, + ///Specifies the Word2010Dotm property in WordFormats to get specified version of exported format. + Word2010Dotm, - ///Specifies the portrait property in pageSettings.orientation to get specified layout. - Portrait -} + ///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, -enum PaperSize { + ///Specifies the Txt property in WordFormats to get specified version of exported format. + Txt, - ///Specifies the A3 as value in pageSettings.paperSize to get specified size. - A3, + ///Specifies the EPUB property in WordFormats to get specified version of exported format. + EPUB, - ///Specifies the A4 as value in pageSettings.paperSize to get specified size. - Portrait, + ///Specifies the HTML property in WordFormats to get specified version of exported format. + HTML, - ///Specifies the B4(JIS) as value in pageSettings.paperSize to get specified size. - B4_JIS, + ///Specifies the XML property in WordFormats to get specified version of exported format. + XML, - ///Specifies the B5(JIS) as value in pageSettings.paperSize to get specified size. - B5_JIS, + ///Specifies the Automatic property in WordFormats to get specified version of exported format. + Automatic + } - ///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, + enum Orientation { - ///Specifies the Executive as value in pageSettings.paperSize to get specified size. - Executive, + ///Specifies the Landscape property in pageSettings.orientation to get specified layout. + Landscape, - ///Specifies the Legal as value in pageSettings.paperSize to get specified size. - Legal, + ///Specifies the portrait property in pageSettings.orientation to get specified layout. + Portrait + } - ///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, + enum PaperSize { - ///Specifies the Custom as value in pageSettings.paperSize to get specified size. - Custom -} + ///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, -enum PrintOptions { + ///Specifies the B4(JIS) as value in pageSettings.paperSize to get specified size. + B4_JIS, - ///Specifies the Default property in printOptions. - Default, + ///Specifies the B5(JIS) as value in pageSettings.paperSize to get specified size. + B5_JIS, - ///Specifies the NewTab property in printOptions. - NewTab, + ///Specifies the Envelope #10 as value in pageSettings.paperSize to get specified size. + Envelope_10, - ///Specifies the None property in printOptions. - None -} + ///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, -enum ProcessingMode { + ///Specifies the Legal as value in pageSettings.paperSize to get specified size. + Legal, - ///Specifies the Remote property in processingMode. - Remote, + ///Specifies the Letter as value in pageSettings.paperSize to get specified size. + Letter, - ///Specifies the Local property in processingMode. - Local -} + ///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 + } -enum RenderMode { - ///Specifies the Default property in RenderMode to get default output. - Default, + enum PrintOptions { - ///Specifies the Mobile property in RenderMode to get specified output. - Mobile, + ///Specifies the Default property in printOptions. + Default, - ///Specifies the Desktop property in RenderMode to get specified output. - Desktop -} + ///Specifies the NewTab property in printOptions. + NewTab, + ///Specifies the None property in printOptions. + None + } -enum ToolbarItems { - ///Specifies the Print as value in ToolbarItems to get specified item. - Print, + enum ProcessingMode { - ///Specifies the Refresh as value in ToolbarItems to get specified item. - Refresh, + ///Specifies the Remote property in processingMode. + Remote, - ///Specifies the Zoom as value in ToolbarItems to get specified item. - Zoom, + ///Specifies the Local property in processingMode. + Local + } - ///Specifies the FittoPage as value in ToolbarItems to get specified item. - FittoPage, - ///Specifies the Export as value in ToolbarItems to get specified item. - Export, + enum RenderMode { - ///Specifies the PageNavigation as value in ToolbarItems to get specified item. - PageNavigation, + ///Specifies the Default property in RenderMode to get default output. + Default, - ///Specifies the Parameters as value in ToolbarItems to get specified item. - Parameters, + ///Specifies the Mobile property in RenderMode to get specified output. + Mobile, - ///Specifies the PrintLayout as value in ToolbarItems to get specified item. - PrintLayout, + ///Specifies the Desktop property in RenderMode to get specified output. + Desktop + } - ///Specifies the PageSetup as value in ToolbarItems to get specified item. - PageSetup -} -} + enum ToolbarItems { -class TreeGrid extends ej.Widget { - static fn: TreeGrid; - constructor(element: JQuery | Element, options?: TreeGrid.Model); - static Locale: any; - model: TreeGrid.Model; - defaults: TreeGrid.Model; + ///Specifies the Print as value in ToolbarItems to get specified item. + Print, - /** 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 Refresh as value in ToolbarItems to get specified item. + Refresh, - /** Specifies the visibility of summary row - * @Default {false} - */ - showSummaryRow?: boolean; + ///Specifies the Zoom as value in ToolbarItems to get specified item. + Zoom, - /** Specifies the visibility of total summary row for the corresponding summary column - * @Default {false} - */ - showTotalSummary?: boolean; + ///Specifies the FittoPage as value in ToolbarItems to get specified item. + FittoPage, - /** Specifies the summary row collection object to be displayed - * @Default {[]} - */ - summaryRows?: any[]; + ///Specifies the Export as value in ToolbarItems to get specified item. + Export, - /** Specifies whether to show tooltip when mouse is hovered on the cell. - * @Default {true} - */ - showGridCellTooltip?: boolean; + ///Specifies the PageNavigation as value in ToolbarItems to get specified item. + PageNavigation, - /** Specifies whether to show tooltip for the cells, which has expander button. - * @Default {true} - */ - showGridExpandCellTooltip?: boolean; + ///Specifies the Parameters as value in ToolbarItems to get specified item. + Parameters, - /** Options for setting width and height for TreeGrid. - */ - sizeSettings?: SizeSettings; + ///Specifies the PrintLayout as value in ToolbarItems to get specified item. + PrintLayout, - /** Options for sorting the rows. - */ - sortSettings?: SortSettings; + ///Specifies the PageSetup as value in ToolbarItems to get specified item. + PageSetup + } - /** 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; + class TreeGrid extends ej.Widget { + static fn: TreeGrid; + constructor(element: JQuery | Element, options?: TreeGrid.Model); + static Locale: any; + model: TreeGrid.Model; + defaults: TreeGrid.Model; - /** Triggered before every success event of TreeGrid action. */ - actionBegin?(e: ActionBeginEventArgs): void; + /** 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; - /** Triggered for every TreeGrid action success event. */ - actionComplete?(e: ActionCompleteEventArgs): void; + /** Specifies the visibility of summary row + * @Default {false} + */ + showSummaryRow?: boolean; - /** Triggered while enter the edit mode in the TreeGrid cell */ - beginEdit?(e: BeginEditEventArgs): void; + /** Specifies the visibility of total summary row for the corresponding summary column + * @Default {false} + */ + showTotalSummary?: boolean; - /** Triggered after collapsed the TreeGrid record */ - collapsed?(e: CollapsedEventArgs): void; + /** Specifies the summary row collection object to be displayed + * @Default {[]} + */ + summaryRows?: any[]; - /** Triggered while collapsing the TreeGrid record */ - collapsing?(e: CollapsingEventArgs): void; + /** Specifies whether to show tooltip when mouse is hovered on the cell. + * @Default {true} + */ + showGridCellTooltip?: boolean; - /** Triggered while clicking a row, even when allowSelection property is disabled. */ - recordClick?(e: RecordClickEventArgs): void; + /** Specifies whether to show tooltip for the cells, which has expander button. + * @Default {true} + */ + showGridExpandCellTooltip?: boolean; - /** Triggered when you start to drag a column */ - columnDragStart?(e: ColumnDragStartEventArgs): void; + /** Options for setting width and height for TreeGrid. + */ + sizeSettings?: SizeSettings; - /** Triggered while dragging a column */ - columnDrag?(e: ColumnDragEventArgs): void; + /** Options for sorting the rows. + */ + sortSettings?: SortSettings; - /** Triggered when a column is dropped */ - columnDrop?(e: ColumnDropEventArgs): void; + /** Options for displaying and customizing the toolbar items. + */ + toolbarSettings?: ToolbarSettings; - /** Triggered after a column resized */ - columnResized?(e: ColumnResizedEventArgs): void; + /** 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 while start to resize a column */ - columnResizeStart?(e: ColumnResizeStartEventArgs): void; + /** Triggered before every success event of TreeGrid action. */ + actionBegin?(e: ActionBeginEventArgs): void; - /** Triggered when a column has been resized */ - columnResizeEnd?(e: ColumnResizeEndEventArgs): void; + /** Triggered for every TreeGrid action success event. */ + actionComplete?(e: ActionCompleteEventArgs): void; - /** Triggered while Context Menu is rendered in TreeGrid control */ - contextMenuOpen?(e: ContextMenuOpenEventArgs): void; + /** Triggered while enter the edit mode in the TreeGrid cell */ + beginEdit?(e: BeginEditEventArgs): void; - /** Triggered when TreeGrid is rendered completely */ - create?(e: CreateEventArgs): void; + /** Triggered after collapsed the TreeGrid record */ + collapsed?(e: CollapsedEventArgs): void; - /** Triggered after saved the modified cellValue in TreeGrid */ - endEdit?(e: EndEditEventArgs): void; + /** Triggered while collapsing the TreeGrid record */ + collapsing?(e: CollapsingEventArgs): void; - /** Triggered after expand the record */ - expanded?(e: ExpandedEventArgs): void; + /** Triggered while clicking a row, even when allowSelection property is disabled. */ + recordClick?(e: RecordClickEventArgs): void; - /** Triggered while expanding the TreeGrid record */ - expanding?(e: ExpandingEventArgs): void; + /** Triggered when you start to drag a column */ + columnDragStart?(e: ColumnDragStartEventArgs): void; - /** Triggered while Treegrid is loaded */ - load?(e: LoadEventArgs): void; + /** Triggered while dragging a column */ + columnDrag?(e: ColumnDragEventArgs): void; - /** Triggered while rendering each cell in the TreeGrid */ - queryCellInfo?(e: QueryCellInfoEventArgs): void; + /** Triggered when a column is dropped */ + columnDrop?(e: ColumnDropEventArgs): void; - /** Triggered while rendering each row */ - rowDataBound?(e: RowDataBoundEventArgs): void; + /** Triggered after a column resized */ + columnResized?(e: ColumnResizedEventArgs): void; - /** Triggered while dragging a row in TreeGrid control */ - rowDrag?(e: RowDragEventArgs): void; + /** Triggered while start to resize a column */ + columnResizeStart?(e: ColumnResizeStartEventArgs): void; - /** Triggered while start to drag row in TreeGrid control */ - rowDragStart?(e: RowDragStartEventArgs): void; + /** Triggered when a column has been resized */ + columnResizeEnd?(e: ColumnResizeEndEventArgs): void; - /** Triggered while drop a row in TreeGrid control */ - rowDragStop?(e: RowDragStopEventArgs): void; + /** Triggered while Context Menu is rendered in TreeGrid control */ + contextMenuOpen?(e: ContextMenuOpenEventArgs): void; - /** Triggered before selecting a cell */ - cellSelecting?(e: CellSelectingEventArgs): void; + /** Triggered when TreeGrid is rendered completely */ + create?(e: CreateEventArgs): void; - /** Triggered after selected a cell */ - cellSelected?(e: CellSelectedEventArgs): void; + /** Triggered after saved the modified cellValue in TreeGrid */ + endEdit?(e: EndEditEventArgs): void; - /** Triggered after the row is selected. */ - rowSelected?(e: RowSelectedEventArgs): void; + /** Triggered after expand the record */ + expanded?(e: ExpandedEventArgs): void; - /** Triggered before the row is going to be selected. */ - rowSelecting?(e: RowSelectingEventArgs): void; + /** Triggered while expanding the TreeGrid record */ + expanding?(e: ExpandingEventArgs): void; - /** Triggered when toolbar item is clicked in TreeGrid. */ - toolbarClick?(e: ToolbarClickEventArgs): void; -} + /** Triggered while Treegrid is loaded */ + load?(e: LoadEventArgs): void; -export interface ActionBeginEventArgs { + /** Triggered while rendering each cell in the TreeGrid */ + queryCellInfo?(e: QueryCellInfoEventArgs): void; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Triggered while rendering each row */ + rowDataBound?(e: RowDataBoundEventArgs): void; - /** Returns the current grouped column field name. - */ - columnName?: string; + /** Triggered while dragging a row in TreeGrid control */ + rowDrag?(e: RowDragEventArgs): void; - /** Returns the TreeGrid model. - */ - model?: any; + /** Triggered while start to drag row in TreeGrid control */ + rowDragStart?(e: RowDragStartEventArgs): void; - /** Returns request type. - */ - requestType?: string; + /** Triggered while drop a row in TreeGrid control */ + rowDragStop?(e: RowDragStopEventArgs): void; - /** Returns the name of the event. - */ - type?: string; + /** Triggered before selecting a cell */ + cellSelecting?(e: CellSelectingEventArgs): void; - /** Returns the direction of sorting ascending or descending. - */ - columnSortDirection?: string; + /** Triggered after selected a cell */ + cellSelected?(e: CellSelectedEventArgs): void; - /** Returns the value of expanding parent element. - */ - keyValue?: string; + /** Triggered after the row is selected. */ + rowSelected?(e: RowSelectedEventArgs): void; - /** Returns the data or deleting element. - */ - data?: string; -} + /** Triggered before the row is going to be selected. */ + rowSelecting?(e: RowSelectingEventArgs): void; -export interface ActionCompleteEventArgs { + /** Triggered when toolbar item is clicked in TreeGrid. */ + toolbarClick?(e: ToolbarClickEventArgs): void; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface ActionBeginEventArgs { - /** Returns the grid model. - */ - model?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** 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 the TreeGrid model. + */ + model?: any; - /** Returns request type. - */ - requestType?: string; + /** Returns request type. + */ + requestType?: string; - /** Returns the direction of sorting ascending or descending - */ - columnSortDirection?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the value of searched element. - */ - keyValue?: string; + /** Returns the direction of sorting ascending or descending. + */ + columnSortDirection?: string; - /** Returns the data of deleted element. - */ - data?: string; + /** Returns the value of expanding parent element. + */ + keyValue?: string; - /** Returns selected record index - */ - recordIndex?: number; -} + /** Returns the data or deleting element. + */ + data?: string; + } -export interface BeginEditEventArgs { + export interface ActionCompleteEventArgs { - /** 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 grid model. + */ + model?: any; - /** Returns the Element of editing cell. - */ - cellElement?: any; + /** Returns the name of the event. + */ + type?: string; - /** Returns the data of current cell record. - */ - data?: any; + /** Returns the current grouped column field name. + */ + columnName?: string; - /** Returns the column Index of cell belongs. - */ - columnIndex?: number; -} + /** Returns request type. + */ + requestType?: string; -export interface CollapsedEventArgs { + /** Returns the direction of sorting ascending or descending + */ + columnSortDirection?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the value of searched element. + */ + keyValue?: string; - /** Returns the row index of collapsed record. - */ - recordIndex?: number; + /** Returns the data of deleted element. + */ + data?: string; - /** Returns the data of collapsed record.. - */ - data?: any; + /** Returns selected record index + */ + recordIndex?: number; + } - /** Returns Request Type. - */ - requestType?: string; + export interface BeginEditEventArgs { - /** Returns state of a record whether it is in expanded or collapsed state. - */ - expanded?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the event type. - */ - type?: string; -} + /** Returns the row element of editing cell. + */ + rowElement?: any; -export interface CollapsingEventArgs { + /** Returns the Element of editing cell. + */ + cellElement?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the data of current cell record. + */ + data?: any; - /** Returns the row index of collapsing record. - */ - recordIndex?: number; + /** Returns the column Index of cell belongs. + */ + columnIndex?: number; + } - /** Returns the data of collapsing record.. - */ - data?: any; + export interface CollapsedEventArgs { - /** Returns the event Type. - */ - type?: string; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns state of a record whether it is in expanded or collapsing state. - */ - expanded?: boolean; -} + /** Returns the row index of collapsed record. + */ + recordIndex?: number; -export interface RecordClickEventArgs { + /** Returns the data of collapsed record.. + */ + data?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns Request Type. + */ + requestType?: string; - /** Returns the element of clicked cell. - */ - cell?: any; + /** Returns state of a record whether it is in expanded or collapsed state. + */ + expanded?: boolean; - /** Returns the index of the clicked cell. - */ - cellIndex?: number; + /** Returns the event type. + */ + type?: string; + } - /** Returns the data of clicked cell. - */ - cellValue?: any; + export interface CollapsingEventArgs { - /** Returns the element of the clicked row. - */ - row?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the index of the clicked row. - */ - rowIndex?: number; + /** Returns the row index of collapsing record. + */ + recordIndex?: number; - /** Returns the column name of the clicked cell. - */ - columnName?: string; -} + /** Returns the data of collapsing record.. + */ + data?: any; -export interface ColumnDragStartEventArgs { + /** Returns the event Type. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns state of a record whether it is in expanded or collapsing state. + */ + expanded?: boolean; + } - /** Returns the control model values. - */ - model?: any; + export interface RecordClickEventArgs { - /** Returns the event Type. - */ - type?: string; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the column data which is dragged - */ - draggedColumn?: any; + /** Returns the element of clicked cell. + */ + cell?: any; - /** Returns the index of the column being dragged - */ - draggedColumnIndex?: number; -} + /** Returns the index of the clicked cell. + */ + cellIndex?: number; -export interface ColumnDragEventArgs { + /** Returns the data of clicked cell. + */ + cellValue?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the element of the clicked row. + */ + row?: any; - /** Returns the control model values. - */ - model?: any; + /** Returns the index of the clicked row. + */ + rowIndex?: number; - /** Returns the event Type. - */ - type?: string; + /** Returns the column name of the clicked cell. + */ + columnName?: string; + } - /** Returns the column data which is dragged - */ - draggedColumn?: any; + export interface ColumnDragStartEventArgs { - /** Returns the index of the column being dragged - */ - draggedColumnIndex?: number; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the target column data - */ - targetColumn?: any; + /** Returns the control model values. + */ + model?: any; - /** Returns the index of the target column - */ - targetColumnIndex?: number; + /** Returns the event Type. + */ + type?: string; - /** Returns that we can drop over the column or not. - */ - canDrop?: boolean; -} + /** Returns the column data which is dragged + */ + draggedColumn?: any; -export interface ColumnDropEventArgs { + /** Returns the index of the column being dragged + */ + draggedColumnIndex?: number; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface ColumnDragEventArgs { - /** Returns the control model values. - */ - model?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the event Type. - */ - type?: string; + /** Returns the control model values. + */ + model?: any; - /** Returns the column data which is dragged - */ - draggedColumn?: any; + /** Returns the event Type. + */ + type?: string; - /** Returns the index of the column being dragged - */ - draggedColumnIndex?: number; + /** Returns the column data which is dragged + */ + draggedColumn?: any; - /** Returns the target column data - */ - targetColumn?: any; + /** Returns the index of the column being dragged + */ + draggedColumnIndex?: number; - /** Returns the index of the target column - */ - targetColumnIndex?: number; -} + /** Returns the target column data + */ + targetColumn?: any; -export interface ColumnResizedEventArgs { + /** Returns the index of the target column + */ + targetColumnIndex?: number; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns that we can drop over the column or not. + */ + canDrop?: boolean; + } - /** Returns the control model values. - */ - model?: any; + export interface ColumnDropEventArgs { - /** Returns the event Type. - */ - type?: string; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the column data which is resized - */ - column?: any; + /** Returns the control model values. + */ + model?: any; - /** Returns the index of the column being resized. - */ - columnIndex?: number; + /** Returns the event Type. + */ + type?: string; - /** Returns resized column width after resized. - */ - newWidth?: number; + /** Returns the column data which is dragged + */ + draggedColumn?: any; - /** Returns resized column width before resizing - */ - oldWidth?: number; -} + /** Returns the index of the column being dragged + */ + draggedColumnIndex?: number; -export interface ColumnResizeStartEventArgs { + /** Returns the target column data + */ + targetColumn?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the index of the target column + */ + targetColumnIndex?: number; + } - /** Returns the control model values. - */ - model?: any; + export interface ColumnResizedEventArgs { - /** Returns the event Type. - */ - type?: string; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the column data in which the resizing started - */ - column?: any; + /** Returns the control model values. + */ + model?: any; - /** Returns the column index in which the resizing started - */ - columnIndex?: number; + /** Returns the event Type. + */ + type?: string; - /** Returns column width before dragging - */ - oldWidth?: number; + /** Returns the column data which is resized + */ + column?: any; - /** Returns initial column element object. - */ - target?: any; -} + /** Returns the index of the column being resized. + */ + columnIndex?: number; -export interface ColumnResizeEndEventArgs { + /** Returns resized column width after resized. + */ + newWidth?: number; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns resized column width before resizing + */ + oldWidth?: number; + } - /** Returns the control model values. - */ - model?: any; + export interface ColumnResizeStartEventArgs { - /** Returns the event Type. - */ - type?: string; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the column data in which the resizing started - */ - column?: any; + /** Returns the control model values. + */ + model?: any; - /** Returns the column index in which the resizing started - */ - columnIndex?: number; + /** Returns the event Type. + */ + type?: string; - /** Returns the column width difference, before and after the resizing - */ - extra?: number; + /** Returns the column data in which the resizing started + */ + column?: any; - /** Returns the new column width after resized - */ - newWidth?: 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 ContextMenuOpenEventArgs { + export interface ColumnResizeEndEventArgs { - /** 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 control model values. + */ + model?: any; - /** Returns the TreeGrid model. - */ - model?: any; + /** Returns the event Type. + */ + type?: string; - /** Returns request type. - */ - requestType?: string; + /** Returns the column data in which the resizing started + */ + column?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the column index in which the resizing started + */ + columnIndex?: number; -export interface CreateEventArgs { + /** Returns the column width difference, before and after the resizing + */ + extra?: number; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the new column width after resized + */ + newWidth?: number; - /** Returns the TreeGrid model - */ - model?: any; + /** Returns column width before dragging + */ + oldWidth?: number; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns initial column element object. + */ + target?: any; + } -export interface EndEditEventArgs { + export interface ContextMenuOpenEventArgs { - /** 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 default context menu items to which we add custom items. + */ + contextMenuItems?: any[]; - /** Returns the Element of editing cell. - */ - cellElement?: any; + /** Returns the TreeGrid model. + */ + model?: any; - /** Returns the data of edited cell record. - */ - data?: any; + /** Returns request type. + */ + requestType?: string; - /** Returns the column name of edited cell belongs. - */ - columnName?: string; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the column object of edited cell belongs. - */ - columnObject?: any; -} + export interface CreateEventArgs { -export interface ExpandedEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the TreeGrid model + */ + model?: any; - /** Returns the row index of expanded record. - */ - recordIndex?: number; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the data of expanded record.. - */ - data?: any; + export interface EndEditEventArgs { - /** Returns Request Type. - */ - requestType?: string; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns state of a record whether it is in expanded or expanded state. - */ - expanded?: boolean; + /** Returns the row element of editing cell. + */ + rowElement?: any; - /** Returns the event type. - */ - type?: string; -} + /** Returns the Element of editing cell. + */ + cellElement?: any; -export interface ExpandingEventArgs { + /** Returns the data of edited cell record. + */ + data?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the column name of edited cell belongs. + */ + columnName?: string; - /** Returns the row index of expanding record. - */ - recordIndex?: number; + /** Returns the column object of edited cell belongs. + */ + columnObject?: any; + } - /** Returns the data of expanding record.. - */ - data?: any; + export interface ExpandedEventArgs { - /** Returns the event Type. - */ - type?: string; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns state of a record whether it is in expanded or collapsed state. - */ - expanded?: boolean; -} + /** Returns the row index of expanded record. + */ + recordIndex?: number; -export interface LoadEventArgs { + /** Returns the data of expanded record.. + */ + data?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns Request Type. + */ + requestType?: string; - /** Returns the TreeGrid model - */ - model?: any; + /** Returns state of a record whether it is in expanded or expanded state. + */ + expanded?: boolean; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the event type. + */ + type?: string; + } -export interface QueryCellInfoEventArgs { + export interface ExpandingEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the selecting cell element. - */ - cellElement?: any; + /** Returns the row index of expanding record. + */ + recordIndex?: number; - /** Returns the value of cell. - */ - cellValue?: string; + /** Returns the data of expanding record.. + */ + data?: any; - /** Returns the data of current cell record. - */ - data?: any; + /** Returns the event Type. + */ + type?: string; - /** Returns the column of cell belongs. - */ - column?: any; -} + /** Returns state of a record whether it is in expanded or collapsed state. + */ + expanded?: boolean; + } -export interface RowDataBoundEventArgs { + export interface LoadEventArgs { - /** 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 TreeGrid model + */ + model?: any; - /** Returns the data of rendering row record. - */ - data?: any; -} + /** Returns the name of the event. + */ + type?: string; + } -export interface RowDragEventArgs { + export interface QueryCellInfoEventArgs { - /** 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 selecting cell element. + */ + cellElement?: any; - /** Returns the row index which we start to drag. - */ - draggedRowIndex?: number; + /** Returns the value of cell. + */ + cellValue?: string; - /** Returns the row on which we are dragging. - */ - targetRow?: any; + /** Returns the data of current cell record. + */ + data?: any; - /** Returns the row index on which we are dragging. - */ - targetRowIndex?: number; + /** Returns the column of cell belongs. + */ + column?: any; + } - /** Returns that we can drop over that record or not. - */ - canDrop?: boolean; + export interface RowDataBoundEventArgs { - /** Returns the TreeGrid model. - */ - model?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns request type. - */ - requestType?: string; + /** Returns the row element of rendering row. + */ + rowElement?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the data of rendering row record. + */ + data?: any; + } -export interface RowDragStartEventArgs { + 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?: boolean; + /** Returns the row index which we start to drag. + */ + draggedRowIndex?: number; - /** Returns the TreeGrid model. - */ - model?: any; + /** Returns the row on which we are dragging. + */ + targetRow?: any; - /** Returns request type. - */ - requestType?: string; + /** Returns the row index on which we are dragging. + */ + targetRowIndex?: number; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns that we can drop over that record or not. + */ + canDrop?: boolean; -export interface RowDragStopEventArgs { + /** Returns the TreeGrid model. + */ + model?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns request type. + */ + requestType?: string; - /** Returns the row which we start to drag. - */ - draggedRow?: any; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the row index which we start to drag. - */ - draggedRowIndex?: number; + export interface RowDragStartEventArgs { - /** Returns the row which we are dropped to row. - */ - targetRow?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the row index which we are dropped to row. - */ - targetRowIndex?: number; + /** Returns the row which we start to drag. + */ + draggedRow?: any; - /** Returns the TreeGrid model. - */ - model?: any; + /** Returns the row index which we start to drag. + */ + draggedRowIndex?: boolean; - /** Returns request type. - */ - requestType?: string; + /** Returns the TreeGrid model. + */ + model?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns request type. + */ + requestType?: string; -export interface CellSelectingEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface RowDragStopEventArgs { - /** Returns the cell index on the selection. - */ - cellIndex?: number; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the row index on the selection - */ - rowIndex?: number; + /** Returns the row which we start to drag. + */ + draggedRow?: any; - /** Returns the selecting cell element - */ - targetCell?: any; + /** Returns the row index which we start to drag. + */ + draggedRowIndex?: number; - /** Returns the selecting row element - */ - targetRow?: any; + /** Returns the row which we are dropped to row. + */ + targetRow?: any; - /** Returns the selecting record object - */ - data?: any; + /** Returns the row index which we are dropped to row. + */ + targetRowIndex?: number; - /** Returns the Gantt object Model - */ - model?: any; -} + /** Returns the TreeGrid model. + */ + model?: any; -export interface CellSelectedEventArgs { + /** Returns request type. + */ + requestType?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cell index on the selection. - */ - cellIndex?: number; + export interface CellSelectingEventArgs { - /** Returns the row index on the selection - */ - rowIndex?: number; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the selecting cell element - */ - targetCell?: any; + /** Returns the cell index on the selection. + */ + cellIndex?: number; - /** Returns the selecting row element - */ - targetRow?: any; + /** Returns the row index on the selection + */ + rowIndex?: number; - /** Returns the selecting record object - */ - data?: any; + /** Returns the selecting cell element + */ + targetCell?: any; - /** Returns the Gantt object Model - */ - model?: any; + /** Returns the selecting row element + */ + targetRow?: any; - /** Returns the previously selected row data - */ - previousData?: any; + /** Returns the selecting record object + */ + data?: any; - /** Returns the previously selected cell index - */ - previousCellIndex?: any; + /** Returns the Gantt object Model + */ + model?: any; + } - /** Returns the previously selected row index - */ - previousRowIndex?: any; + export interface CellSelectedEventArgs { - /** Returns the previously selected cell element - */ - previousTargetCell?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the previously selected row element - */ - previousTargetRow?: any; -} + /** Returns the cell index on the selection. + */ + cellIndex?: number; -export interface RowSelectedEventArgs { + /** Returns the row index on the selection + */ + rowIndex?: number; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the selecting cell element + */ + targetCell?: any; - /** 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 selecting record object + */ + data?: any; - /** Returns the data of selected record. - */ - data?: any; + /** Returns the Gantt object Model + */ + model?: any; - /** Returns the event type. - */ - type?: string; -} + /** Returns the previously selected row data + */ + previousData?: 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 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; + /** Returns the previously selected cell index + */ + previousCellIndex?: any; - /** Specifies the Custom template for Pager control. - * @Default {null} - */ - template?: string; -} + /** Returns the previously selected row index + */ + previousRowIndex?: any; -export interface SelectionSettings { + /** Returns the previously selected cell element + */ + previousTargetCell?: any; - /** Specifies the type of selection whether to select row or cell. - * @Default {ej.TreeGrid.SelectionMode.Row} - */ - selectionMode?: ej.TreeGrid.SelectionMode|string; + /** Returns the previously selected row element + */ + previousTargetRow?: any; + } - /** Specifies the type of selection whether single, multiple or checkbox. - * @Default {ej.TreeGrid.SelectionType.Single} - */ - selectionType?: ej.TreeGrid.SelectionType|string; + export interface RowSelectedEventArgs { - /** Enables or disables the selection by hierarchy in check box selection - * @Default {true} - */ - enableHierarchySelection?: boolean; + /** Returns the cancel option value. + */ + cancel?: 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; -} + /** Returns the selecting row element. + */ + targetRow?: any; -export interface SizeSettings { + /** Returns the index of selecting row record. + */ + recordIndex?: number; - /** Height of the TreeGrid. - * @Default {null} - */ - height?: string; + /** Returns the data of selected record. + */ + data?: any; - /** Width of the TreeGrid. - * @Default {null} - */ - width?: string; -} + /** Returns the event type. + */ + type?: string; + } -export interface SortSettings { + 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; - /** Option to add columns based on which the rows have to be sorted recursively. - * @Default {[]} - */ - sortedColumns?: any[]; -} + /** Specifies the Custom template for Pager control. + * @Default {null} + */ + template?: string; + } -export interface ToolbarSettings { + export interface SelectionSettings { - /** Shows/hides the toolbar. - * @Default {false} - */ - showToolbar?: boolean; + /** Specifies the type of selection whether to select row or cell. + * @Default {ej.TreeGrid.SelectionMode.Row} + */ + selectionMode?: ej.TreeGrid.SelectionMode | string; - /** Specifies the list of toolbar items to be rendered in TreeGrid toolbar - * @Default {[]} - */ - toolbarItems?: any[]; -} + /** Specifies the type of selection whether single, multiple or checkbox. + * @Default {ej.TreeGrid.SelectionType.Single} + */ + selectionType?: ej.TreeGrid.SelectionType | string; -enum EditingType { + /** Enables or disables the selection by hierarchy in check box selection + * @Default {true} + */ + enableHierarchySelection?: boolean; - ///It Specifies String edit type. - String, + /** Toggles the visibility of the checkbox in column header, using which all the check boxes can be selected or unselected. + * @Default {true} + */ + enableSelectAll?: boolean; + } - ///It Specifies Boolean edit type. - Boolean, + export interface SizeSettings { - ///It Specifies Numeric edit type. - Numeric, + /** Height of the TreeGrid. + * @Default {null} + */ + height?: string; - ///It Specifies Dropdown edit type. - Dropdown, + /** Width of the TreeGrid. + * @Default {null} + */ + width?: string; + } - ///It Specifies DatePicker edit type. - DatePicker, + export interface SortSettings { - ///It Specifies DateTimePicker edit type. - DateTimePicker, + /** Option to add columns based on which the rows have to be sorted recursively. + * @Default {[]} + */ + sortedColumns?: any[]; + } - ///It Specifies Maskedit edit type. - Maskedit -} + export interface ToolbarSettings { + /** Shows/hides the toolbar. + * @Default {false} + */ + showToolbar?: boolean; -enum BeginEditAction { + /** Specifies the list of toolbar items to be rendered in TreeGrid toolbar + * @Default {[]} + */ + toolbarItems?: any[]; + } - ///you can begin the editing at double click - DblClick, + enum EditingType { - ///you can begin the editing at single click - Click -} + ///It Specifies String edit type. + String, + ///It Specifies Boolean edit type. + Boolean, -enum EditMode { + ///It Specifies Numeric edit type. + Numeric, - ///you can edit a cell. - CellEditing, + ///It Specifies Dropdown edit type. + Dropdown, - ///you can edit a row. - RowEditing -} + ///It Specifies DatePicker edit type. + DatePicker, + ///It Specifies DateTimePicker edit type. + DateTimePicker, -enum RowPosition { + ///It Specifies Maskedit edit type. + Maskedit + } - ///you can add a new row at top. - Top, - ///you can add a new row at bottom. - Bottom, + enum BeginEditAction { - ///you can add a new row to above selected row. - Above, + ///you can begin the editing at double click + DblClick, - ///you can add a new row to below selected row. - Below, + ///you can begin the editing at single click + Click + } - ///you can add a new row as a child for selected row. - Child -} + enum EditMode { -enum PageSizeMode { + ///you can edit a cell. + CellEditing, - ///To count all the parent and child records. - All, + ///you can edit a row. + RowEditing + } - ///To count the Zeroth level parent records. - Root -} + enum RowPosition { -enum SelectionMode { + ///you can add a new row at top. + Top, - ///you can select a row. - Row, + ///you can add a new row at bottom. + Bottom, - ///you can select a cell. - Cell -} + ///you can add a new row to above selected row. + Above, + ///you can add a new row to below selected row. + Below, -enum SelectionType { + ///you can add a new row as a child for selected row. + Child + } - ///you can select a single row. - Single, - ///you can select a multiple row. - Multiple, + enum PageSizeMode { - ///you can select rows using checkbox. - Checkbox -} + ///To count all the parent and child records. + All, -} + ///To count the Zeroth level parent records. + Root + } -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; + enum SelectionMode { - /** 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; + ///you can select a row. + Row, - /** Disables the GroupButton control - * @returns {void} - */ - disable(): void; + ///you can select a cell. + Cell + } - /** 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; + enum SelectionType { - /** 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; + ///you can select a single row. + Single, - /** Event object - */ - event?: any; + ///you can select a multiple row. + Multiple, - /** Return the button element ID. - */ - id?: string; + ///you can select rows using checkbox. + Checkbox + } - /** Button item index. - */ - index?: number; + } - /** returns the button model - */ - model?: ej.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; - /** Boolean value based on whether the button element is selected or not. - */ - selected?: boolean; + /** Remove the selection state of the specified the button element from the GroupButton + * @param {JQuery} Specific button element + * @returns {void} + */ + deselectItem(element: JQuery): void; - /** returns the name of the event - */ - type?: string; + /** 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; - /** return the button state - */ - status?: boolean; -} + /** Disables the GroupButton control + * @returns {void} + */ + disable(): void; -export interface CreateEventArgs { + /** Disable the specified button element from the ejGroupButton control. + * @param {JQuery} Specific button element + * @returns {void} + */ + disableItem(element: JQuery): void; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** Enables the disabled ejGroupButton control. + * @returns {void} + */ + enable(): void; - /** returns the GroupButton model - */ - model?: ej.GroupButton.Model; + /** 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; - /** returns the name of the event - */ - type?: string; -} + /** Event object + */ + event?: any; -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 { + /** Return the button element ID. + */ + id?: string; - /** returns true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** Button item index. + */ + index?: number; - /** returns the name of the event. - */ - type?: string; + /** returns the button model + */ + model?: ej.GroupButton.Model; - /** returns the model value of the control. - */ - model?: ej.NavigationDrawer.Model; -} + /** Boolean value based on whether the button element is selected or not. + */ + selected?: boolean; -export interface AjaxErrorEventArgs { + /** returns the name of the event + */ + type?: string; - /** returns true if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** return the button state + */ + status?: boolean; + } - /** returns the name of the event. - */ - type?: string; + export interface CreateEventArgs { - /** returns the model value of the control. - */ - model?: ej.NavigationDrawer.Model; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** returns the error thrown in the AJAX post. - */ - errorThrown?: any; + /** returns the GroupButton model + */ + model?: ej.GroupButton.Model; - /** returns the status. - */ - textStatus?: any; -} + /** returns the name of the event + */ + type?: string; + } -export interface AjaxSuccessEventArgs { + 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; + } - /** returns the AJAX current content. - */ - content?: string; + export interface AjaxErrorEventArgs { - /** returns the current URL of the AJAX post. - */ - URL?: string; -} + /** returns true if the event should be canceled; otherwise, false. + */ + cancel?: boolean; -export interface BeforeCloseEventArgs { + /** returns the name of the event. + */ + type?: string; - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** returns the model value of the control. + */ + model?: ej.NavigationDrawer.Model; - /** returns the Navigation Drawer model - */ - model?: ej.NavigationDrawer.Model; + /** returns the error thrown in the AJAX post. + */ + errorThrown?: any; - /** returns the name of the event - */ - type?: string; -} + /** returns the status. + */ + textStatus?: 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; + export interface AjaxSuccessEventArgs { - /** returns the name of the event - */ - type?: string; -} + /** returns true if the event should be canceled; otherwise, false. + */ + cancel?: boolean; -export interface ItemsBadge { + /** returns the name of the event. + */ + type?: string; - /** Specifies whether to enable radialmenu item badge or not. - */ - enabled?: boolean; - - /** Specifies the value of radial menu item badge. - */ - value?: number; -} - -export interface ItemsSliderSettings { + /** returns the model value of the control. + */ + model?: ej.NavigationDrawer.Model; - /** Specifies the sliderSettings ticks values of nested radial menu items. - */ - ticks?: any[]; + /** returns the AJAX current content. + */ + content?: string; - /** 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; + /** returns the current URL of the AJAX post. + */ + URL?: string; + } - /** Sets position for tile badge. - * @Default {“bottomrightâ€} - */ - position?: ej.Tile.BadgePosition|string; -} + export interface BeforeCloseEventArgs { -export interface Caption { + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Specifies whether the tile text to be shown or hidden. - * @Default {true} - */ - enabled?: boolean; + /** returns the Navigation Drawer model + */ + model?: ej.NavigationDrawer.Model; - /** Changes the text of a tile. - * @Default {Text} - */ - text?: string; + /** returns the name of the event + */ + type?: string; + } - /** It is used to align the text of a tile. - * @Default {normal} - */ - alignment?: ej.Tile.CaptionAlignment|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; - /** It is used to specify the caption position like Inner top, inner bottom and outer. - * @Default {Innerbottom} - */ - position?: ej.Tile.CaptionPosition|string; + /** returns the name of the event + */ + type?: string; + } - /** sets the icon instead of text. - * @Default {null} - */ - icon?: string; -} + export interface ItemsBadge { -export interface LiveTile { + /** 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 liveTile or not. - * @Default {false} - */ - enabled?: boolean; + /** Specifies the sliderSettings ticks values of nested radial menu items. + */ + ticks?: any[]; - /** Specifies liveTile images in CSS classes. - * @Default {null} - */ - imageClass?: 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 liveTile images in templates. - * @Default {null} - */ - imageTemplateId?: any[]; + /** Sets position for tile badge. + * @Default {“bottomrightâ€Â} + */ + position?: ej.Tile.BadgePosition | string; + } - /** Specifies liveTile images in CSS classes. - * @Default {null} - */ - imageUrl?: any[]; + export interface Caption { - /** Specifies liveTile type for Tile. See orientation - * @Default {flip} - */ - type?: ej.Tile.liveTileType|string; + /** Specifies whether the tile text to be shown or hidden. + * @Default {true} + */ + enabled?: boolean; - /** Specifies time interval between two successive liveTile animation - * @Default {2000} - */ - updateInterval?: number; + /** Changes the text of a tile. + * @Default {Text} + */ + text?: string; - /** Sets the text to each living tile - * @Default {Null} - */ - text?: any[]; -} + /** It is used to align the text of a tile. + * @Default {normal} + */ + alignment?: ej.Tile.CaptionAlignment | string; -enum BadgePosition { + /** It is used to specify the caption position like Inner top, inner bottom and outer. + * @Default {Innerbottom} + */ + position?: ej.Tile.CaptionPosition | string; - ///To set the topright position of tile badge - Topright, + /** sets the icon instead of text. + * @Default {null} + */ + icon?: string; + } - ///To set the bottomright of tile badge - Bottomright -} + export interface LiveTile { + /** Specifies whether to enable liveTile or not. + * @Default {false} + */ + enabled?: boolean; -enum CaptionAlignment { + /** Specifies liveTile images in CSS classes. + * @Default {null} + */ + imageClass?: any[]; - ///To set the normal alignment of text in tile control - Normal, + /** Specifies liveTile images in templates. + * @Default {null} + */ + imageTemplateId?: any[]; - ///To set the left alignment of text in tile control - Left, + /** Specifies liveTile images in CSS classes. + * @Default {null} + */ + imageUrl?: any[]; - ///To set the right alignment of text in tile control - Right, + /** Specifies liveTile type for Tile. See orientation + * @Default {flip} + */ + type?: ej.Tile.liveTileType | string; - ///To set the center alignment of text in tile control - Center -} + /** Specifies time interval between two successive liveTile animation + * @Default {2000} + */ + updateInterval?: number; + /** Sets the text to each living tile + * @Default {Null} + */ + text?: any[]; + } -enum CaptionPosition { + enum BadgePosition { - ///To set the inner top position of the tile text - Innertop, + ///To set the topright position of tile badge + Topright, - ///To set the inner bottom position of the tile text - Innerbottom, + ///To set the bottomright of tile badge + Bottomright + } - ///To set the outer position of the tile text - Outer -} + enum CaptionAlignment { -enum ImagePosition { + ///To set the normal alignment of text in tile control + Normal, - ///To set the center position of tile image - Center, + ///To set the left alignment of text in tile control + Left, - ///To set the top center position of tile image - TopCenter, + ///To set the right alignment of text in tile control + Right, - ///To set the bottom center position of tile image - BottomCenter, + ///To set the center alignment of text in tile control + Center + } - ///To set the right center position of tile image - RightCenter, - ///To set the left center position of tile image - LeftCenter, + enum CaptionPosition { - ///To set the topleft position of tile image - TopLeft, + ///To set the inner top position of the tile text + Innertop, - ///To set the topright position of tile image - TopRight, + ///To set the inner bottom position of the tile text + Innerbottom, - ///To set the bottomright position of tile image - BottomRight, + ///To set the outer position of the tile text + Outer + } - ///To set the bottomleft position of tile image - BottomLeft, - ///To set the fill position of tile image - Fill -} + enum ImagePosition { + ///To set the center position of tile image + Center, -enum liveTileType { + ///To set the top center position of tile image + TopCenter, - ///To set flip type of liveTile for tile control - Flip, + ///To set the bottom center position of tile image + BottomCenter, - ///To set slide type of liveTile for tile control - Slide, + ///To set the right center position of tile image + RightCenter, - ///To set carousel type of liveTile for tile control - Carousel -} + ///To set the left center position of tile image + LeftCenter, + ///To set the topleft position of tile image + TopLeft, -enum TileSize { + ///To set the topright position of tile image + TopRight, - ///To set the medium size for tile control - Medium, + ///To set the bottomright position of tile image + BottomRight, - ///To set the small size for tile control - Small, + ///To set the bottomleft position of tile image + BottomLeft, - ///To set the large size for tile control - Large, + ///To set the fill position of tile image + Fill + } - ///To set the wide size for tile control - Wide -} -} + enum liveTileType { -class Signature extends ej.Widget { - static fn: Signature; - constructor(element: JQuery | Element, options?: Signature.Model); - static Locale: any; - model: Signature.Model; - defaults: Signature.Model; + ///To set flip type of liveTile for tile control + Flip, - /** Clears the strokes in the signature. - * @returns {void} - */ - clear(): void; + ///To set slide type of liveTile for tile control + Slide, - /** Destroys the signature widget. - * @returns {void} - */ - destroy(): void; + ///To set carousel type of liveTile for tile control + Carousel + } - /** Disables the signature widget. - * @returns {void} - */ - disable(): void; - /** Enables the signature widget. - * @returns {void} - */ - enable(): void; + enum TileSize { - /** Hides the signature widget. - * @returns {void} - */ - hide(): void; + ///To set the medium size for tile control + Medium, - /** redo the last drawn stroke of the signature - * @returns {void} - */ - redo(): void; + ///To set the small size for tile control + Small, - /** used to save the drawn image. - * @returns {void} - */ - save(): void; + ///To set the large size for tile control + Large, - /** Used to Show the signature widget, if it is already hided. - * @returns {void} - */ - show(): void; + ///To set the wide size for tile control + Wide + } - /** undo the last drawn stroke of the signature. - * @returns {void} - */ - undo(): void; -} -export namespace Signature { + } -export interface 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; - /** This property is used to set the background color for the signature. - * @Default {#ffffff} - */ - backgroundColor?: string; + /** Clears the strokes in the signature. + * @returns {void} + */ + clear(): void; - /** This property is used to set the background image for the signature. - */ - backgroundImage?: string; + /** Destroys the signature widget. + * @returns {void} + */ + destroy(): void; - /** Enables or disables the Signature textbox widget. - * @Default {true} - */ - enabled?: boolean; + /** Disables the signature widget. + * @returns {void} + */ + disable(): void; - /** Sets the height of the Signature control. - * @Default {100%} - */ - height?: string; + /** Enables the signature widget. + * @returns {void} + */ + enable(): 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; + /** Hides the signature widget. + * @returns {void} + */ + hide(): 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; -} + /** redo the last drawn stroke of the signature + * @returns {void} + */ + redo(): 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; + /** used to save the drawn image. + * @returns {void} + */ + save(): void; - /** Gives the last stored image - */ - lastImage?: string; -} + /** Used to Show the signature widget, if it is already hided. + * @returns {void} + */ + show(): void; -export interface MouseDownEventArgs { - - /** Set this option to true to cancel the event. - */ - cancel?: boolean; + /** undo the last drawn stroke of the signature. + * @returns {void} + */ + undo(): void; + } + export namespace Signature { - /** Instance of the signature model object. - */ - model?: ej.Signature.Model; + export interface 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; + /** This property is used to set the background color for the signature. + * @Default {#ffffff} + */ + backgroundColor?: string; - /** To show the radialslider - * @returns {void} - */ - show(): void; - - /** To hide the radialslider - * @returns {void} - */ - hide(): void; -} -export namespace RadialSlider { - -export interface Model { + /** This property is used to set the background image for the signature. + */ + backgroundImage?: string; - /** To show the RadialSlider in initial render. - * @Default {false} - */ - autoOpen?: boolean; + /** Enables or disables the Signature textbox widget. + * @Default {true} + */ + enabled?: 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 height of the Signature control. + * @Default {100%} + */ + height?: string; - /** 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; + /** 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; - /** 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; + /** 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; + } - /** if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + 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; - /** returns the initial value of Radial slider - */ - oldValue?: number; + /** Gives the last stored image + */ + lastImage?: string; + } - /** returns the name of the event - */ - type?: string; + export interface MouseDownEventArgs { + + /** Set this option to true to cancel the event. + */ + cancel?: boolean; - /** returns the current value of the Radial slider - */ - value?: number; -} + /** Instance of the signature model object. + */ + model?: ej.Signature.Model; -export interface CreateEventArgs { + /** 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; - /** 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`. If it is `false` 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 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} - */ - 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; - - 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 {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; - - /** 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 {any} Row index and column index of the cell which you want to freeze. - * @returns {void} - */ - freezePanes(cell: any): 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; -} - -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; + /** To show the radialslider + * @returns {void} + */ + show(): void; + + /** To hide the radialslider + * @returns {void} + */ + hide(): void; + } + export namespace RadialSlider { + + export interface Model { - /** Gets or sets a value that indicates to define the common height for each row in the sheet. - * @Default {20} - */ - rowHeight?: number; + /** To show the RadialSlider in initial render. + * @Default {false} + */ + autoOpen?: boolean; - /** Gets or sets an object that indicates to customize the scroll options in the Spreadsheet. - */ - scrollSettings?: ScrollSettings; + /** 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; - /** Gets or sets an object that indicates to customize the selection options in the Spreadsheet. - */ - selectionSettings?: SelectionSettings; + /** 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; - /** Gets or sets a value that indicates to define the number of sheets to be created at the initial load. - * @Default {1} - */ - sheetCount?: 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; - /** Gets or sets an object that indicates to customize the sheet behavior in Spreadsheet. - */ - sheets?: Sheet[]; + /** if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Gets or sets a value that indicates whether to show or hide pager in the Spreadsheet. - * @Default {true} - */ - showPager?: boolean; + /** returns the initial value of Radial slider + */ + oldValue?: number; - /** Gets or sets a value that indicates whether to show or hide ribbon in the Spreadsheet. - * @Default {true} - */ - showRibbon?: boolean; + /** returns the name of the event + */ + type?: string; - /** This is used to set the number of undo-redo steps in the Spreadsheet. - * @Default {20} - */ - undoRedoStep?: number; + /** returns the current value of the Radial slider + */ + value?: number; + } - /** Define the username for the Spreadsheet which is displayed in comment. - * @Default {User Name} - */ - userName?: string; + export interface CreateEventArgs { - /** Triggered for every action before its starts. */ - actionBegin?(e: ActionBeginEventArgs): void; + /** 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; - /** Triggered for every action complete. */ - actionComplete?(e: ActionCompleteEventArgs): void; + /** Gets or sets a value that indicates to define the common height for each row in the sheet. + * @Default {20} + */ + rowHeight?: number; - /** Triggered when the auto fill operation begins. */ - autoFillBegin?(e: AutoFillBeginEventArgs): void; + /** Gets or sets an object that indicates to customize the scroll options in the Spreadsheet. + */ + scrollSettings?: ScrollSettings; - /** Triggered when the auto fill operation completes. */ - autoFillComplete?(e: AutoFillCompleteEventArgs): void; + /** Gets or sets an object that indicates to customize the selection options in the Spreadsheet. + */ + selectionSettings?: SelectionSettings; - /** Triggered before the batch save. */ - beforeBatchSave?(e: BeforeBatchSaveEventArgs): void; + /** Gets or sets a value that indicates to define the number of sheets to be created at the initial load. + * @Default {1} + */ + sheetCount?: number; - /** Triggered before the cells to be formatted. */ - beforeCellFormat?(e: BeforeCellFormatEventArgs): void; + /** Gets or sets an object that indicates to customize the sheet behavior in Spreadsheet. + */ + sheets?: Sheet[]; - /** Triggered before the cell selection. */ - beforeCellSelect?(e: BeforeCellSelectEventArgs): void; + /** Gets or sets a value that indicates whether to show or hide pager in the Spreadsheet. + * @Default {true} + */ + showPager?: boolean; - /** Triggered before the selected cells are dropped. */ - beforeDrop?(e: BeforeDropEventArgs): void; + /** Gets or sets a value that indicates whether to show or hide ribbon in the Spreadsheet. + * @Default {true} + */ + showRibbon?: boolean; - /** Triggered while start to edit the comment. */ - beforeEditComment?(e: BeforeEditCommentEventArgs): void; + /** This is used to set the number of undo-redo steps in the Spreadsheet. + * @Default {20} + */ + undoRedoStep?: number; - /** Triggered before the contextmenu is open. */ - beforeOpen?(e: BeforeOpenEventArgs): void; + /** Define the username for the Spreadsheet which is displayed in comment. + * @Default {User Name} + */ + userName?: string; - /** Triggered before the activation panel is open. */ - beforePanelOpen?(e: BeforePanelOpenEventArgs): void; + /** Triggered for every action before its starts. */ + actionBegin?(e: ActionBeginEventArgs): void; - /** Triggered when click on sheet cell. */ - cellClick?(e: CellClickEventArgs): void; + /** Triggered for every action complete. */ + actionComplete?(e: ActionCompleteEventArgs): void; - /** Triggered when the cell is edited. */ - cellEdit?(e: CellEditEventArgs): void; + /** Triggered when the auto fill operation begins. */ + autoFillBegin?(e: AutoFillBeginEventArgs): void; - /** Triggered while cell is formatting. */ - cellFormatting?(e: CellFormattingEventArgs): void; + /** Triggered when the auto fill operation completes. */ + autoFillComplete?(e: AutoFillCompleteEventArgs): void; - /** Triggered when mouse hover on cell in sheets. */ - cellHover?(e: CellHoverEventArgs): void; + /** Triggered before the batch save. */ + beforeBatchSave?(e: BeforeBatchSaveEventArgs): void; - /** Triggered when save the edited cell. */ - cellSave?(e: CellSaveEventArgs): void; + /** Triggered before the cells to be formatted. */ + beforeCellFormat?(e: BeforeCellFormatEventArgs): void; - /** Triggered when the cell is selected. */ - cellSelected?(e: CellSelectedEventArgs): void; + /** Triggered before the cell selection. */ + beforeCellSelect?(e: BeforeCellSelectEventArgs): void; - /** Triggered when click the contextmenu items. */ - contextMenuClick?(e: ContextMenuClickEventArgs): void; + /** Triggered before the selected cells are dropped. */ + beforeDrop?(e: BeforeDropEventArgs): void; - /** Triggered when the selected cells are being dragged. */ - drag?(e: DragEventArgs): void; + /** Triggered while start to edit the comment. */ + beforeEditComment?(e: BeforeEditCommentEventArgs): void; - /** Triggered when you start to drag the picture or chart. */ - dragShape?(e: DragShapeEventArgs): void; + /** Triggered before the contextmenu is open. */ + beforeOpen?(e: BeforeOpenEventArgs): void; - /** Triggered when the selected cells are initiated to drag. */ - dragStart?(e: DragStartEventArgs): void; + /** Triggered before the activation panel is open. */ + beforePanelOpen?(e: BeforePanelOpenEventArgs): void; - /** Triggered when the selected cells are dropped. */ - drop?(e: DropEventArgs): void; + /** Triggered when click on sheet cell. */ + cellClick?(e: CellClickEventArgs): void; - /** Triggered before the range editing starts. */ - editRangeBegin?(e: EditRangeBeginEventArgs): void; + /** Triggered when the cell is edited. */ + cellEdit?(e: CellEditEventArgs): void; - /** Triggered after range editing completes. */ - editRangeComplete?(e: EditRangeCompleteEventArgs): void; + /** Triggered while cell is formatting. */ + cellFormatting?(e: CellFormattingEventArgs): void; - /** Triggered when the key is pressed down. */ - keyDown?(e: KeyDownEventArgs): void; + /** Triggered when mouse hover on cell in sheets. */ + cellHover?(e: CellHoverEventArgs): void; - /** Triggered when the key is released. */ - keyUp?(e: KeyUpEventArgs): void; + /** Triggered when save the edited cell. */ + cellSave?(e: CellSaveEventArgs): void; - /** Triggered before the sheet is loaded. */ - load?(e: LoadEventArgs): void; + /** Triggered when the cell is selected. */ + cellSelected?(e: CellSelectedEventArgs): void; - /** Triggered after the sheet is loaded. */ - loadComplete?(e: LoadCompleteEventArgs): void; + /** Triggered when click the contextmenu items. */ + contextMenuClick?(e: ContextMenuClickEventArgs): void; - /** Triggered every click of the menu item. */ - menuClick?(e: MenuClickEventArgs): void; + /** Triggered when the selected cells are being dragged. */ + drag?(e: DragEventArgs): void; - /** Triggered when a file is imported. */ - onImport?(e: OnImportEventArgs): void; + /** Triggered when you start to drag the picture or chart. */ + dragShape?(e: DragShapeEventArgs): void; - /** Triggered when import sheet is failed to open. */ - openFailure?(e: OpenFailureEventArgs): void; + /** Triggered when the selected cells are initiated to drag. */ + dragStart?(e: DragStartEventArgs): void; - /** Triggered when pager item is clicked in the Spreadsheet. */ - pagerClick?(e: PagerClickEventArgs): void; + /** Triggered when the selected cells are dropped. */ + drop?(e: DropEventArgs): void; - /** Triggered when you start resizing the chart, picture, row and column. */ - resizeStart?(e: ResizeStartEventArgs): void; + /** Triggered before the range editing starts. */ + editRangeBegin?(e: EditRangeBeginEventArgs): void; - /** Triggered after end of resizing the chart, picture, row and column. */ - resizeEnd?(e: ResizeEndEventArgs): void; + /** Triggered after range editing completes. */ + editRangeComplete?(e: EditRangeCompleteEventArgs): void; - /** Triggered when click on the ribbon. */ - ribbonClick?(e: RibbonClickEventArgs): void; + /** Triggered when the key is pressed down. */ + keyDown?(e: KeyDownEventArgs): void; - /** Triggered when the chart series rendering. */ - seriesRendering?(e: SeriesRenderingEventArgs): void; + /** Triggered when the key is released. */ + keyUp?(e: KeyUpEventArgs): void; - /** Triggered when click the ribbon tab. */ - tabClick?(e: TabClickEventArgs): void; + /** Triggered before the sheet is loaded. */ + load?(e: LoadEventArgs): void; - /** Triggered when select the ribbon tab. */ - tabSelect?(e: TabSelectEventArgs): void; -} + /** Triggered after the sheet is loaded. */ + loadComplete?(e: LoadCompleteEventArgs): void; -export interface ActionBeginEventArgs { + /** Triggered every click of the menu item. */ + menuClick?(e: MenuClickEventArgs): void; - /** Returns the applied style format object. - */ - afterFormat?: any; + /** Triggered when a file is imported. */ + onImport?(e: OnImportEventArgs): void; - /** Returns the applied style format object. - */ - beforeFormat?: any; + /** Triggered when import sheet is failed to open. */ + openFailure?(e: OpenFailureEventArgs): void; - /** Returns the sheet index. - */ - sheetIdx?: number; + /** Triggered when pager item is clicked in the Spreadsheet. */ + pagerClick?(e: PagerClickEventArgs): void; - /** Returns the cell range. - */ - range?: any[]; + /** Triggered when you start resizing the chart, picture, row and column. */ + resizeStart?(e: ResizeStartEventArgs): void; - /** Returns the action format. - */ - reqType?: string; + /** Triggered after end of resizing the chart, picture, row and column. */ + resizeEnd?(e: ResizeEndEventArgs): void; - /** Returns goto index while paging. - */ - gotoIdx?: number; + /** Triggered when click on the ribbon. */ + ribbonClick?(e: RibbonClickEventArgs): void; - /** Returns boolean value. If create new sheet it returns true. - */ - newSheet?: boolean; + /** Triggered when the chart series rendering. */ + seriesRendering?(e: SeriesRenderingEventArgs): void; - /** Return column name while sorting. - */ - columnName?: string; + /** Triggered when click the ribbon tab. */ + tabClick?(e: TabClickEventArgs): void; - /** Returns selected columns while sorting or filtering begins. - */ - colSelected?: number; + /** Triggered when select the ribbon tab. */ + tabSelect?(e: TabSelectEventArgs): void; + } - /** Returns sort direction while sort action begins. - */ - sortDirection?: string; -} + export interface ActionBeginEventArgs { -export interface ActionCompleteEventArgs { + /** Returns the applied style format object. + */ + afterFormat?: any; - /** Returns Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the applied style format object. + */ + beforeFormat?: any; - /** Returns the applied cell format object. - */ - selectedCell?: any[]|any; + /** Returns the sheet index. + */ + sheetIdx?: number; - /** Returns the sheet index. - */ - sheetIdx?: number; + /** Returns the cell range. + */ + range?: any[]; - /** Returns the request type. - */ - reqType?: string; + /** Returns the action format. + */ + reqType?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns goto index while paging. + */ + gotoIdx?: number; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns boolean value. If create new sheet it returns true. + */ + newSheet?: boolean; -export interface AutoFillBeginEventArgs { + /** Return column name while sorting. + */ + columnName?: string; - /** Returns auto fill begin cell range. - */ - dataRange?: any[]; + /** Returns selected columns while sorting or filtering begins. + */ + colSelected?: number; - /** Returns which direction drag the auto fill. - */ - direction?: string; + /** Returns sort direction while sort action begins. + */ + sortDirection?: string; + } - /** Returns fill cells range. - */ - fillRange?: any[]; + export interface ActionCompleteEventArgs { - /** Returns the auto fill type. - */ - fillType?: string; + /** Returns Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the sheet index. - */ - sheetIdx?: number; + /** Returns the applied cell format object. + */ + selectedCell?: any[] | any; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the sheet index. + */ + sheetIdx?: number; - /** Returns the name of the event. - */ - type?: string; + /** Returns the request type. + */ + reqType?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the cancel option value. + */ + cancel?: boolean; -export interface AutoFillCompleteEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** Returns auto fill begin cell range. - */ - dataRange?: any[]; + export interface AutoFillBeginEventArgs { - /** Returns which direction to drag the auto fill. - */ - direction?: string; + /** Returns auto fill begin cell range. + */ + dataRange?: any[]; - /** Returns fill cells range. - */ - fillRange?: any[]; + /** Returns which direction drag the auto fill. + */ + direction?: string; - /** Returns the auto fill type. - */ - fillType?: string; + /** Returns fill cells range. + */ + fillRange?: any[]; - /** Returns the sheet index. - */ - sheetIdx?: number; + /** Returns the auto fill type. + */ + fillType?: string; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the sheet index. + */ + sheetIdx?: number; - /** 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 name of the event. + */ + type?: string; -export interface BeforeBatchSaveEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; + } - /** Returns the sheet index. - */ - sheetIdx?: number; + export interface AutoFillCompleteEventArgs { - /** Returns the query, primary key,batch changes for the data Source. - */ - dataSetting?: any; + /** Returns auto fill begin cell range. + */ + dataRange?: any[]; - /** Returns the changed record object. - */ - batchChanges?: any; -} + /** Returns which direction to drag the auto fill. + */ + direction?: string; -export interface BeforeCellFormatEventArgs { + /** Returns fill cells range. + */ + fillRange?: any[]; - /** Returns the sheet index. - */ - sheetIdx?: number; + /** Returns the auto fill type. + */ + fillType?: string; - /** Returns the applied style format object. - */ - format?: any; + /** Returns the sheet index. + */ + sheetIdx?: number; - /** 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 name of the event. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; + } - /** Returns the name of the event. - */ - type?: string; -} + export interface BeforeBatchSaveEventArgs { -export interface BeforeCellSelectEventArgs { + /** Returns the sheet index. + */ + sheetIdx?: number; - /** Returns the previous cell range. - */ - prevRange?: any[]; + /** Returns the query, primary key,batch changes for the data Source. + */ + dataSetting?: any; - /** Returns the current cell range. - */ - currRange?: any[]; + /** Returns the changed record object. + */ + batchChanges?: any; + } - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + export interface BeforeCellFormatEventArgs { - /** Returns the name of the event. - */ - type?: string; + /** Returns the sheet index. + */ + sheetIdx?: number; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the applied style format object. + */ + format?: any; -export interface BeforeDropEventArgs { + /** Returns the selected cells. + */ + cells?: any[] | any; - /** Returns the sheet index. - */ - sheetIdx?: number; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the current cell row and column index. - */ - currentCell?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the drag cells range object. - */ - dragAndDropRange?: any; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cell Overwriting alert option value. - */ - preventAlert?: boolean; + export interface BeforeCellSelectEventArgs { - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the previous cell range. + */ + prevRange?: any[]; - /** Returns the target item. - */ - target?: HTMLElement; + /** Returns the current cell range. + */ + currRange?: any[]; - /** 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 name of the event. + */ + type?: string; -export interface BeforeEditCommentEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; + } - /** Returns the sheet index. - */ - sheetIdx?: number; + export interface BeforeDropEventArgs { - /** Returns the comment cell index. - */ - cellIndex?: any; + /** Returns the sheet index. + */ + sheetIdx?: number; - /** Returns the disable option value. - */ - disable?: boolean; + /** Returns the current cell row and column index. + */ + currentCell?: any; - /** Returns the Spreadsheet model. - */ - model?: any; + /** Returns the drag cells range object. + */ + dragAndDropRange?: any; - /** Returns the value of the comment - */ - value?: string; + /** Returns the cell Overwriting alert option value. + */ + preventAlert?: boolean; - /** 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 target item. + */ + target?: HTMLElement; -export interface BeforeOpenEventArgs { + /** Returns the name of the event. + */ + type?: string; - /** Returns the target element. - */ - target?: HTMLElement; + /** Returns the cancel option value. + */ + cancel?: boolean; + } - /** Returns the name of the event. - */ - type?: string; + export interface BeforeEditCommentEventArgs { - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the sheet index. + */ + sheetIdx?: number; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the comment cell index. + */ + cellIndex?: any; -export interface BeforePanelOpenEventArgs { + /** Returns the disable option value. + */ + disable?: boolean; - /** Returns the sheet index. - */ - sheetIdx?: number; + /** Returns the Spreadsheet model. + */ + model?: any; - /** Returns the activation panel element. - */ - activationPanel?: any; + /** Returns the value of the comment + */ + value?: string; - /** Returns the range option value. - */ - range?: any; + /** 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 name of the event. - */ - type?: string; + export interface BeforeOpenEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the target element. + */ + target?: HTMLElement; -export interface CellClickEventArgs { + /** Returns the name of the event. + */ + type?: string; - /** Returns the click cell element. - */ - cell?: HTMLElement; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the column index of clicked cell. - */ - columnIndex?: number; + /** Returns the cancel option value. + */ + cancel?: boolean; + } - /** Returns the row index of clicked cell. - */ - rowIndex?: number; + export interface BeforePanelOpenEventArgs { - /** Returns the column name of clicked cell. - */ - columnName?: string; + /** Returns the sheet index. + */ + sheetIdx?: number; - /** Returns the column information. - */ - columnObject?: any; + /** Returns the activation panel element. + */ + activationPanel?: any; - /** 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 Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the target element. - */ - target?: HTMLElement; + /** Returns the name of the event. + */ + type?: 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 CellClickEventArgs { -export interface CellEditEventArgs { + /** 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 columnName of clicked cell. - */ - columnName?: string; + /** Returns the row index of clicked cell. + */ + rowIndex?: number; - /** Returns the column field information. - */ - columnObject?: any; + /** Returns the column name of clicked cell. + */ + columnName?: string; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the column information. + */ + columnObject?: any; - /** Returns the name of the event. - */ - type?: string; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the target element. - */ - target?: HTMLElement; + /** Returns the name of the event. + */ + type?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the target element. + */ + target?: HTMLElement; -export interface CellFormattingEventArgs { + /** Returns the value of the cell. + */ + value?: string; - /** Returns the sheet index - */ - SheetIdx?: number; + /** Returns the cancel option value. + */ + cancel?: boolean; + } - /** Returns the applied style format object - */ - Format?: any; + export interface CellEditEventArgs { - /** Returns the cell index. - */ - Cell?: number; + /** Returns the click cell element. + */ + cell?: HTMLElement; - /** Returns the name of the CSS theme. - */ - cssClass?: string; + /** Returns the columnName of clicked cell. + */ + columnName?: string; - /** Returns the name of the event. - */ - type?: string; + /** Returns the column field information. + */ + columnObject?: any; - /** Returns the target element. - */ - target?: HTMLElement; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; -} + /** Returns the name of the event. + */ + type?: string; -export interface CellHoverEventArgs { + /** Returns the target element. + */ + target?: HTMLElement; - /** Returns the target element. - */ - target?: HTMLElement; + /** Returns the cancel option value. + */ + cancel?: boolean; + } - /** Returns the name of the event. - */ - type?: string; + export interface CellFormattingEventArgs { - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the sheet index + */ + SheetIdx?: number; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the applied style format object + */ + Format?: any; -export interface CellSaveEventArgs { + /** Returns the cell index. + */ + Cell?: number; - /** Returns the save cell element. - */ - cell?: HTMLElement; + /** Returns the name of the CSS theme. + */ + cssClass?: string; - /** Returns the columnName of clicked cell. - */ - columnName?: string; + /** Returns the name of the event. + */ + type?: string; - /** Returns the column field information. - */ - columnObject?: any; + /** Returns the target element. + */ + target?: HTMLElement; - /** Returns the index of the row. - */ - rowIndex?: number; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; + } - /** Returns the index of the column. - */ - colIndex?: number; + export interface CellHoverEventArgs { - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the target element. + */ + target?: HTMLElement; - /** 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 Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; + } - /** Returns the target element. - */ - target?: HTMLElement; + export interface CellSaveEventArgs { - /** Returns the cell value. - */ - value?: string; -} + /** Returns the save cell element. + */ + cell?: HTMLElement; -export interface CellSelectedEventArgs { + /** Returns the columnName of clicked cell. + */ + columnName?: string; - /** Returns the active sheet index. - */ - sheetIdx?: number; + /** Returns the column field information. + */ + columnObject?: any; - /** Returns the selected range. - */ - selectedRange?: any[]; + /** Returns the index of the row. + */ + rowIndex?: number; - /** Returns the target element. - */ - target?: HTMLElement; + /** Returns the index of the column. + */ + colIndex?: number; - /** Returns Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the name of the event. - */ - type?: string; + /** Returns the cell previous value. + */ + pValue?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the name of the event. + */ + type?: string; -export interface ContextMenuClickEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns target element Id. - */ - Id?: string; + /** Returns the target element. + */ + target?: HTMLElement; - /** Returns the target element. - */ - element?: HTMLElement; + /** Returns the cell value. + */ + value?: string; + } - /** Returns event information. - */ - event?: any; + export interface CellSelectedEventArgs { - /** Returns target element and event information. - */ - events?: any; + /** Returns the active sheet index. + */ + sheetIdx?: number; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the selected range. + */ + selectedRange?: any[]; - /** Returns target element parent Id. - */ - parentId?: string; + /** Returns the target element. + */ + target?: HTMLElement; - /** Returns target element parent text. - */ - parentText?: string; + /** Returns Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** 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 ContextMenuClickEventArgs { -export interface DragEventArgs { + /** Returns target element Id. + */ + Id?: string; - /** Returns the sheet index. - */ - sheetIdx?: number; + /** Returns the target element. + */ + element?: HTMLElement; - /** Returns the current cell row and column index. - */ - currentCell?: any; + /** Returns event information. + */ + event?: any; - /** Returns the drag cells range object. - */ - dragAndDropRange?: 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 the target item. - */ - target?: HTMLElement; + /** Returns target element parent Id. + */ + parentId?: string; - /** Returns the name of the event. - */ - type?: string; + /** Returns target element parent text. + */ + parentText?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns target element text. + */ + text?: string; -export interface DragShapeEventArgs { + /** Returns the name of the event. + */ + type?: string; - /** Returns the Spreadsheet model. - */ - model?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; + } - /** Returns the name of the event. - */ - type?: string; + export interface DragEventArgs { - /** Returns the target element. - */ - target?: HTMLElement; + /** Returns the sheet index. + */ + sheetIdx?: number; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the current cell row and column index. + */ + currentCell?: any; -export interface DragStartEventArgs { + /** Returns the drag cells range object. + */ + dragAndDropRange?: any; - /** Returns the sheet index. - */ - sheetIdx?: number; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the current cell row and column index. - */ - currentCell?: any; + /** Returns the target item. + */ + target?: HTMLElement; - /** Returns the drag cells range object. - */ - dragAndDropRange?: any; + /** 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 target item. - */ - target?: HTMLElement; + export interface DragShapeEventArgs { - /** Returns the name of the event. - */ - type?: string; + /** Returns the Spreadsheet model. + */ + model?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the name of the event. + */ + type?: string; -export interface DropEventArgs { + /** Returns the target element. + */ + target?: HTMLElement; - /** Returns the sheet index. - */ - sheetIdx?: number; + /** Returns the cancel option value. + */ + cancel?: boolean; + } - /** Returns the current cell row and column index. - */ - currentCell?: any; + export interface DragStartEventArgs { - /** Returns the drag cells range object. - */ - dragAndDropRange?: any; + /** Returns the sheet index. + */ + sheetIdx?: number; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the current cell row and column index. + */ + currentCell?: any; - /** Returns the target item. - */ - target?: HTMLElement; + /** Returns the drag cells range object. + */ + dragAndDropRange?: any; - /** 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 target item. + */ + target?: HTMLElement; -export interface EditRangeBeginEventArgs { + /** Returns the name of the event. + */ + type?: string; - /** Returns the sheet index. - */ - sheetIdx?: number; + /** Returns the cancel option value. + */ + cancel?: boolean; + } - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + export interface DropEventArgs { - /** Returns the range option value. - */ - range?: any; + /** Returns the sheet index. + */ + sheetIdx?: number; - /** Returns the name of the event. - */ - type?: string; + /** Returns the current cell row and column index. + */ + currentCell?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the drag cells range object. + */ + dragAndDropRange?: any; -export interface EditRangeCompleteEventArgs { + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the sheet index. - */ - sheetIdx?: number; + /** Returns the target item. + */ + target?: HTMLElement; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the name of the event. + */ + type?: string; - /** Returns the range option value. - */ - range?: any; + /** Returns the cancel option value. + */ + cancel?: boolean; + } - /** Returns the name of the event. - */ - type?: string; + export interface EditRangeBeginEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the sheet index. + */ + sheetIdx?: number; -export interface KeyDownEventArgs { + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the sheet index. - */ - sheetIndex?: number; + /** 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 boolean value. - */ - isCommentEdit?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; + } - /** Returns the boolean value. - */ - isEdit?: boolean; + export interface EditRangeCompleteEventArgs { - /** Returns the boolean value. - */ - isSheetRename?: boolean; + /** Returns the sheet index. + */ + sheetIdx?: number; - /** Returns the target element. - */ - target?: HTMLElement; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the name of the event. - */ - type?: string; + /** Returns the range option value. + */ + range?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the name of the event. + */ + type?: string; -export interface KeyUpEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; + } - /** Returns the sheet index. - */ - sheetIndex?: number; + export interface KeyDownEventArgs { - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the sheet index. + */ + sheetIndex?: number; - /** Returns the boolean value. - */ - isCommentEdit?: boolean; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the boolean value. - */ - isEdit?: boolean; + /** Returns the boolean value. + */ + isCommentEdit?: boolean; - /** Returns the boolean value. - */ - isSheetRename?: boolean; + /** Returns the boolean value. + */ + isEdit?: boolean; - /** Returns the target element. - */ - target?: HTMLElement; + /** Returns the boolean value. + */ + isSheetRename?: boolean; - /** Returns the name of the event. - */ - type?: string; + /** Returns the target element. + */ + target?: HTMLElement; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the name of the event. + */ + type?: string; -export interface LoadEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; + } - /** Returns the name of the event. - */ - type?: string; + export interface KeyUpEventArgs { - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the sheet index. + */ + sheetIndex?: number; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the active sheet index. - */ - sheetIndex?: number; -} + /** Returns the boolean value. + */ + isCommentEdit?: boolean; -export interface LoadCompleteEventArgs { + /** Returns the boolean value. + */ + isEdit?: boolean; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the boolean value. + */ + isSheetRename?: boolean; - /** Returns the name of the event. - */ - type?: string; + /** Returns the target element. + */ + target?: HTMLElement; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the name of the event. + */ + type?: string; -export interface MenuClickEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; + } - /** Returns menu click element. - */ - element?: HTMLElement; + export interface LoadEventArgs { - /** Returns the event information. - */ - event?: any; + /** 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 target element parent Id. - */ - parentId?: string; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns target element parent text. - */ - parentText?: string; + /** Returns the active sheet index. + */ + sheetIndex?: number; + } - /** Returns target element text. - */ - text?: string; + export interface LoadCompleteEventArgs { - /** 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 name of the event. + */ + type?: string; -export interface OnImportEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; + } - /** Returns the name of the event. - */ - type?: string; + export interface MenuClickEventArgs { - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns menu click element. + */ + element?: HTMLElement; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the event information. + */ + event?: any; - /** Returns the imported data. - */ - importData?: any; -} + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; -export interface OpenFailureEventArgs { + /** Returns target element parent Id. + */ + parentId?: string; - /** Returns the failure type. - */ - failureType?: string; + /** Returns target element parent text. + */ + parentText?: string; - /** Returns the status index. - */ - status?: number; + /** Returns target element text. + */ + text?: string; - /** Returns the status in text. - */ - statusText?: string; + /** 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 name of the event. - */ - type?: string; + export interface OnImportEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the name of the event. + */ + type?: string; -export interface PagerClickEventArgs { + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; - /** Returns the active sheet index. - */ - activeSheet?: number; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the new sheet index. - */ - gotoSheet?: number; + /** Returns the imported data. + */ + importData?: any; + } - /** Returns whether new sheet icon is clicked. - */ - newSheet?: boolean; + export interface OpenFailureEventArgs { - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the failure type. + */ + failureType?: string; - /** Returns the name of the event. - */ - type?: string; + /** Returns the status index. + */ + status?: number; - /** Returns the target element. - */ - target?: HTMLElement; + /** Returns the status in text. + */ + statusText?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; -export interface ResizeStartEventArgs { + /** Returns the name of the event. + */ + type?: string; - /** Returns the column index which column you start to resize. - */ - colIndex?: number; + /** Returns the cancel option value. + */ + cancel?: boolean; + } - /** Returns the row index which row you start to resize. - */ - rowIndex?: number; + export interface PagerClickEventArgs { - /** Returns the Spreadsheet model. - */ - model?: any; + /** Returns the active sheet index. + */ + activeSheet?: number; - /** Returns type of the request. - */ - reqType?: string; + /** Returns the new sheet index. + */ + gotoSheet?: number; - /** Returns the name of the event. - */ - type?: string; + /** Returns whether new sheet icon is clicked. + */ + newSheet?: boolean; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; -export interface ResizeEndEventArgs { + /** Returns the name of the event. + */ + type?: string; - /** Returns the column index which you resized. - */ - colIndex?: number; + /** Returns the target element. + */ + target?: HTMLElement; - /** Returns old width of the column or shape. - */ - oldWidth?: number; + /** Returns the cancel option value. + */ + cancel?: boolean; + } - /** Returns new width of the column or shape. - */ - newWidth?: number; + export interface ResizeStartEventArgs { - /** Returns the row index which you resized. - */ - rowIndex?: number; + /** Returns the column index which column you start to resize. + */ + colIndex?: number; - /** Returns old height of the row or shape. - */ - oldHeight?: number; + /** Returns the row index which row you start to resize. + */ + rowIndex?: 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 ResizeEndEventArgs { -export interface RibbonClickEventArgs { + /** Returns the column index which you resized. + */ + colIndex?: number; - /** Returns element Id. - */ - Id?: string; + /** Returns old width of the column or shape. + */ + oldWidth?: number; - /** Returns target information. - */ - prop?: any; + /** Returns new width of the column or shape. + */ + newWidth?: number; - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; + /** Returns the row index which you resized. + */ + rowIndex?: number; - /** Returns status. - */ - status?: boolean; + /** Returns old height of the row or shape. + */ + oldHeight?: number; - /** Returns isChecked in boolean. - */ - isChecked?: boolean; + /** Returns new height of the row or shape. + */ + newHeight?: number; - /** Returns the name of the event. - */ - type?: string; + /** Returns the Spreadsheet model. + */ + model?: any; - /** Returns the target element. - */ - target?: HTMLElement; + /** Returns type of the request. + */ + reqType?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the name of the event. + */ + type?: string; -export interface SeriesRenderingEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; + } - /** Returns chart data and chart information. - */ - data?: any; + export interface RibbonClickEventArgs { - /** Returns the chart model. - */ - model?: ej.Spreadsheet.Model; + /** Returns element Id. + */ + Id?: string; - /** Returns the name of the event. - */ - type?: string; + /** Returns target information. + */ + prop?: any; - /** Returns the cancel option value. - */ - cancel?: boolean; -} + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; -export interface TabClickEventArgs { + /** Returns status. + */ + status?: boolean; - /** Returns the active tab index. - */ - activeIndex?: number; + /** Returns isChecked in boolean. + */ + isChecked?: boolean; - /** Returns active tab header element. - */ - activeHeader?: any; + /** Returns the name of the event. + */ + type?: string; - /** Returns previous active tab header element. - */ - prevActiveHeader?: any; + /** Returns the target element. + */ + target?: HTMLElement; - /** Returns previous active tab index. - */ - prevActiveIndex?: number; + /** Returns the cancel option value. + */ + cancel?: boolean; + } - /** Returns the Spreadsheet model. - */ - model?: ej.Spreadsheet.Model; - - /** Returns the name of the event. - */ - type?: string; + export interface SeriesRenderingEventArgs { - /** Returns the target element. - */ - target?: HTMLElement; - - /** Returns the cancel option value. - */ - cancel?: boolean; -} - -export interface TabSelectEventArgs { + /** Returns chart data and chart information. + */ + data?: any; - /** Returns the active tab index. - */ - activeIndex?: number; - - /** Returns active tab header element. - */ - activeHeader?: any; + /** Returns the chart model. + */ + model?: ej.Spreadsheet.Model; - /** 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 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; - - /** 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 the name of the event. + */ + type?: string; - /** To hide the specified rows in Spreadsheet. - * @Default {[]} - */ - hideRows?: any[]; + /** Returns the cancel option value. + */ + cancel?: boolean; + } - /** To merge specified ranges in Spreadsheet. - * @Default {[]} - */ - mergeCells?: any[]; + export interface TabClickEventArgs { - /** Specifies the primary key for the datasource in Spreadsheet. - */ - primaryKey?: string; + /** Returns the active tab index. + */ + activeIndex?: number; - /** Specifies the query for the dataSource in Spreadsheet. - * @Default {null} - */ - query?: any; + /** Returns active tab header element. + */ + activeHeader?: any; - /** Specifies single range or multiple range settings for a sheet in Spreadsheet. - * @Default {[]} - */ - rangeSettings?: SheetsRangeSetting[]; + /** Returns previous active tab header element. + */ + prevActiveHeader?: any; - /** Gets or sets a value that indicates to define row count in the Spreadsheet. - * @Default {20} - */ - rowCount?: number; + /** Returns previous active tab index. + */ + prevActiveIndex?: number; - /** Specifies the rows for a sheet in Spreadsheet. - * @Default {[]} - */ - rows?: SheetsRow[]; + /** Returns the Spreadsheet model. + */ + model?: ej.Spreadsheet.Model; + + /** Returns the name of the event. + */ + type?: string; - /** Gets or sets a value that indicates whether to show or hide grid lines in the Spreadsheet. - * @Default {true} - */ - showGridlines?: boolean; + /** Returns the target element. + */ + target?: HTMLElement; + + /** Returns the cancel option value. + */ + cancel?: boolean; + } + + export interface TabSelectEventArgs { - /** Gets or sets a value that indicates whether to enable or disable the datasource header in Spreadsheet. - * @Default {true} - */ - showHeader?: boolean; + /** Returns the active tab index. + */ + activeIndex?: number; + + /** Returns active tab header element. + */ + activeHeader?: any; - /** Gets or sets a value that indicates whether to show or hide headings in the Spreadsheet. - * @Default {true} - */ - showHeadings?: boolean; + /** 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[]; - /** Specifies the start cell for the datasource range in Spreadsheet. - * @Default {A1} - */ - startCell?: string; -} + /** To hide the specified rows in Spreadsheet. + * @Default {[]} + */ + hideRows?: any[]; -enum AutoFillOptions { + /** To merge specified ranges in Spreadsheet. + * @Default {[]} + */ + mergeCells?: any[]; - ///Specifies the CopyCells property in AutoFillOptions. - CopyCells, + /** Specifies the primary key for the datasource in Spreadsheet. + */ + primaryKey?: string; - ///Specifies the FillSeries property in AutoFillOptions. - FillSeries, + /** Specifies the query for the dataSource in Spreadsheet. + * @Default {null} + */ + query?: any; - ///Specifies the FillFormattingOnly property in AutoFillOptions. - FillFormattingOnly, + /** Specifies single range or multiple range settings for a sheet in Spreadsheet. + * @Default {[]} + */ + rangeSettings?: SheetsRangeSetting[]; - ///Specifies the FillWithoutFormatting property in AutoFillOptions. - FillWithoutFormatting, + /** Gets or sets a value that indicates to define row count in the Spreadsheet. + * @Default {20} + */ + rowCount?: number; - ///Specifies the FlashFill property in AutoFillOptions. - FlashFill -} + /** 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; -enum scrollMode { + /** Gets or sets a value that indicates whether to enable or disable the datasource header in Spreadsheet. + * @Default {true} + */ + showHeader?: boolean; - ///To enable Infinite scroll mode for Spreadsheet. - Infinite, + /** Gets or sets a value that indicates whether to show or hide headings in the Spreadsheet. + * @Default {true} + */ + showHeadings?: boolean; - ///To enable Normal scroll mode for Spreadsheet. - Normal -} + /** Specifies the start cell for the datasource range in Spreadsheet. + * @Default {A1} + */ + startCell?: string; + } + enum AutoFillOptions { -enum SelectionType { + ///Specifies the CopyCells property in AutoFillOptions. + CopyCells, - ///To select only Column in Spreadsheet. - Column, + ///Specifies the FillSeries property in AutoFillOptions. + FillSeries, - ///To select only Row in Spreadsheet. - Row, + ///Specifies the FillFormattingOnly property in AutoFillOptions. + FillFormattingOnly, - ///To select both Column/Row in Spreadsheet. - Default -} + ///Specifies the FillWithoutFormatting property in AutoFillOptions. + FillWithoutFormatting, + ///Specifies the FlashFill property in AutoFillOptions. + FlashFill + } -enum SelectionUnit { - ///To enable Single selection in Spreadsheet - Single, + enum scrollMode { - ///To enable Range selection in Spreadsheet - Range, + ///To enable Infinite scroll mode for Spreadsheet. + Infinite, - ///To enable MultiRange selection in Spreadsheet - MultiRange -} + ///To enable Normal scroll mode for Spreadsheet. + Normal + } -enum BorderType { + enum SelectionType { - ///To apply top border for the given range of cell. - Top, + ///To select only Column in Spreadsheet. + Column, - ///To apply left border for the given range of cell. - Left, + ///To select only Row in Spreadsheet. + Row, - ///To apply right border for the given range of cell. - Right, + ///To select both Column/Row in Spreadsheet. + Default + } - ///To apply bottom border for the given range of cell. - Bottom, - ///To apply outside border for the given range of cell. - OutSide, + enum SelectionUnit { - ///To apply all border for the given range of cell. - AllBorder, + ///To enable Single selection in Spreadsheet + Single, - ///To apply thick box border for the given range of cell. - ThickBox, + ///To enable Range selection in Spreadsheet + Range, - ///To apply thick bottom border for the given range of cell. - ThickBottom, + ///To enable MultiRange selection in Spreadsheet + MultiRange + } - ///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 -} + enum BorderType { + ///To apply top border for the given range of cell. + Top, -enum CFormatRule { + ///To apply left border for the given range of cell. + Left, - ///To identify greater than values in the given range of cells. - GreaterThan, + ///To apply right border for the given range of cell. + Right, - ///To identify less than values in the given range of cells. - LessThan, + ///To apply bottom border for the given range of cell. + Bottom, - ///To identify in between values in the given range of cells. - Between, + ///To apply outside border for the given range of cell. + OutSide, - ///To identify the equal values in the given range of cells. - EqualTo, + ///To apply all border for the given range of cell. + AllBorder, - ///To identify the specified text in the range of cells. - TextContains, + ///To apply thick box border for the given range of cell. + ThickBox, - ///To identify the specified date in the range of cells. - DateOccurs -} + ///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, -enum CFormatHighlightColor { + ///To apply top and thick bottom border for the given range of cell. + TopandThickBottom + } - ///Highlights red with dark red text color. - RedFillwithDarkRedText, - ///Highlights yellow with dark yellow text color. - YellowFillwithDarkYellowText, + enum CFormatRule { - ///Highlights green with dark green text color. - GreenFillwithDarkGreenText, + ///To identify greater than values in the given range of cells. + GreaterThan, - ///Highlights with red fill. - RedFill, + ///To identify less than values in the given range of cells. + LessThan, - ///Highlights with red text. - RedText -} + ///To identify in between values in the given range of cells. + Between, + ///To identify the equal values in the given range of cells. + EqualTo, -enum ChartProperties { + ///To identify the specified text in the range of cells. + TextContains, - ///Specifies to make the data label center of the chart. - DataLabelCenter, + ///To identify the specified date in the range of cells. + DateOccurs + } - ///Specifies to make the data label inside base of the chart. - DataLabelInsideBase, - ///Specifies to make the data label inside end of the chart. - DataLabelInsideEnd, + enum CFormatHighlightColor { - ///Specifies to make the data label none of the chart. - DataLabelNone, + ///Highlights red with dark red text color. + RedFillwithDarkRedText, - ///Specifies to make the data label outside end of the chart. - DataLabelOutsideEnd, + ///Highlights yellow with dark yellow text color. + YellowFillwithDarkYellowText, - ///Specifies to make the legends to bottom of the chart. - LegendsBottom, + ///Highlights green with dark green text color. + GreenFillwithDarkGreenText, - ///Specifies to make the legends to left of the chart. - LegendsLeft, + ///Highlights with red fill. + RedFill, - ///Specifies to make the legends to none of the chart. - LegendsNone, + ///Highlights with red text. + RedText + } - ///Specifies to make the legends to right of the chart. - LegendsRight, - ///Specifies to make the legends to top of the chart. - LegendsTop, + enum ChartProperties { - ///To set the primary horizontal of the chart. - PrimaryHorizontal, + ///Specifies to make the data label center of the chart. + DataLabelCenter, - ///To set the primary horizontal axis title of the chart. - PrimaryHorizontalAxisTitle, + ///Specifies to make the data label inside base of the chart. + DataLabelInsideBase, - ///To set the primary major horizontal of the chart. - PrimaryMajorHorizontal, + ///Specifies to make the data label inside end of the chart. + DataLabelInsideEnd, - ///To set the primary major vertical of the chart. - PrimaryMajorVertical, + ///Specifies to make the data label none of the chart. + DataLabelNone, - ///To set the primary minor horizontal of the chart. - PrimaryMinorHorizontal, + ///Specifies to make the data label outside end of the chart. + DataLabelOutsideEnd, - ///To set the primary minor vertical of the chart. - PrimaryMinorVertical, + ///Specifies to make the legends to bottom of the chart. + LegendsBottom, - ///To set the primary vertical of the chart. - PrimaryVertical, + ///Specifies to make the legends to left of the chart. + LegendsLeft, - ///To set the primary vertical axis title of the chart. - PrimaryVerticalAxisTitle, + ///Specifies to make the legends to none of the chart. + LegendsNone, - ///Specifies to make the title to center of the chart. - TitleCenter, + ///Specifies to make the legends to right of the chart. + LegendsRight, - ///Specifies to make the title to far of the chart. - TitleFar, + ///Specifies to make the legends to top of the chart. + LegendsTop, - ///Specifies to make the title to near of the chart. - TitleNear, + ///To set the primary horizontal of the chart. + PrimaryHorizontal, - ///Specifies to make the title to none of the chart. - TitleNone -} + ///To set the primary horizontal axis title of the chart. + PrimaryHorizontalAxisTitle, -} + ///To set the primary major horizontal of the chart. + PrimaryMajorHorizontal, -class PdfViewer extends ej.Widget { - static fn: PdfViewer; - constructor(element: JQuery | Element, options?: PdfViewer.Model); - static Locale: any; - model: PdfViewer.Model; - defaults: PdfViewer.Model; + ///To set the primary major vertical of the chart. + PrimaryMajorVertical, - /** 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; + ///To set the primary minor horizontal of the chart. + PrimaryMinorHorizontal, - /** Shows/hides the toolbar in the PDF viewer. - * @param {boolean} shows/hides the toolbar - * @returns {void} - */ - showToolbar(show: boolean): void; + ///To set the primary minor vertical of the chart. + PrimaryMinorVertical, - /** Prints the PDF document. - * @returns {void} - */ - print(): void; + ///To set the primary vertical of the chart. + PrimaryVertical, - /** 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; + ///To set the primary vertical axis title of the chart. + PrimaryVerticalAxisTitle, - /** Specifies the location of the supporting PDF service - */ - pdfService?: ej.PdfViewer.PdfService|string; + ///Specifies to make the title to center of the chart. + TitleCenter, - /** Specifies the open state of the hyperlink in the PDF document. - */ - hyperlinkOpenState?: ej.PdfViewer.LinkTarget|string; + ///Specifies to make the title to far of the chart. + TitleFar, - /** Enables or disables the hyperlinks in PDF document. - */ - enableHyperlink?: boolean; + ///Specifies to make the title to near of the chart. + TitleNear, - /** Enables or disables the text selection in PDF document. - */ - enableTextSelection?: boolean; + ///Specifies to make the title to none of the chart. + TitleNone + } - /** 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; + class PdfViewer extends ej.Widget { + static fn: PdfViewer; + constructor(element: JQuery | Element, options?: PdfViewer.Model); + static Locale: any; + model: PdfViewer.Model; + defaults: PdfViewer.Model; - /** Enables or disables the buffering of the PDF pages in the client side. - */ - allowClientBuffering?: boolean; + /** 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; - /** Gets the name of the PDF document which loaded in the ejPdfViewer control for downloading. - */ - fileName?: string; + /** Shows/hides the toolbar in the PDF viewer. + * @param {boolean} shows/hides the toolbar + * @returns {void} + */ + showToolbar(show: boolean): void; - /** Triggers when the PDF document gets loaded and is ready to view in the Control. */ - documentLoad?(e: DocumentLoadEventArgs): void; + /** Prints the PDF document. + * @returns {void} + */ + print(): void; - /** Triggers when there is change in current page number. */ - pageChange?(e: PageChangeEventArgs): 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; - /** Triggers when there is change in the magnification value. */ - zoomChange?(e: ZoomChangeEventArgs): void; + /** Specifies the location of the supporting PDF service + */ + pdfService?: ej.PdfViewer.PdfService | string; - /** Triggers when hyperlink in the PDF Document is clicked */ - hyperlinkClick?(e: HyperlinkClickEventArgs): void; + /** Specifies the open state of the hyperlink in the PDF document. + */ + hyperlinkOpenState?: ej.PdfViewer.LinkTarget | string; - /** Triggers before the printing starts. */ - beforePrint?(e: BeforePrintEventArgs): void; + /** Enables or disables the hyperlinks in PDF document. + */ + enableHyperlink?: boolean; - /** Triggers after the printing is completed. */ - afterPrint?(e: AfterPrintEventArgs): void; + /** Enables or disables the text selection in PDF document. + */ + enableTextSelection?: boolean; - /** Triggers when the mouse click is performed over the page of the PDF document. */ - pageClick?(e: PageClickEventArgs): void; + /** Enables or disables the responsiveness of the PDF viewer control during the window resize. + */ + isResponsive?: boolean; - /** Triggers when the client buffering process starts. */ - bufferStart?(e: BufferStartEventArgs): void; + /** Checks whether the PDF document is edited. + */ + isDocumentEdited?: boolean; - /** Triggers when the client buffering process ends. */ - bufferEnd?(e: BufferEndEventArgs): void; + /** Enables or disables the buffering of the PDF pages in the client side. + */ + allowClientBuffering?: boolean; - /** Triggers when PDF viewer control is destroyed successfully. */ - destroy?(e: DestroyEventArgs): void; -} + /** Gets the name of the PDF document which loaded in the ejPdfViewer control for downloading. + */ + fileName?: string; -export interface DocumentLoadEventArgs { + /** Triggers when the PDF document gets loaded and is ready to view in the Control. */ + documentLoad?(e: DocumentLoadEventArgs): void; - /** true, if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** Triggers when the PDF document gets unloaded from the PDF viewer. */ + documentUnload?(e: DocumentUnloadEventArgs): void; - /** Returns the PDF viewer model - */ - model?: any; + /** Triggers when there is change in current page number. */ + pageChange?(e: PageChangeEventArgs): void; - /** Returns the name of the event - */ - type?: string; -} + /** Triggers when there is change in the magnification value. */ + zoomChange?(e: ZoomChangeEventArgs): void; -export interface PageChangeEventArgs { + /** Triggers when hyperlink in the PDF Document is clicked */ + hyperlinkClick?(e: HyperlinkClickEventArgs): void; - /** true, if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** Triggers before the printing starts. */ + beforePrint?(e: BeforePrintEventArgs): void; - /** Returns the PDF viewer model - */ - model?: any; + /** Triggers after the printing is completed. */ + afterPrint?(e: AfterPrintEventArgs): void; - /** Returns the name of the event - */ - type?: string; + /** Triggers when the mouse click is performed over the page of the PDF document. */ + pageClick?(e: PageClickEventArgs): void; - /** Returns the current page number in view. - */ - currentPageNumber?: number; -} + /** Triggers when the client buffering process starts. */ + bufferStart?(e: BufferStartEventArgs): void; -export interface ZoomChangeEventArgs { + /** Triggers when the client buffering process ends. */ + bufferEnd?(e: BufferEndEventArgs): void; - /** true, if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** Triggers when PDF viewer control is destroyed successfully. */ + destroy?(e: DestroyEventArgs): void; + } - /** Returns the PDF viewer model - */ - model?: any; + export interface DocumentLoadEventArgs { - /** Returns the name of the event. - */ - type?: string; + /** true, if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the previous zoom percentage of the PDF viewer control - */ - previousZoomPercentage?: number; + /** Returns the PDF viewer model + */ + model?: any; - /** Returns the current zoom percentage of the PDF viewer control - */ - currentZoomPercentage?: number; -} + /** Returns the name of the event + */ + type?: string; -export interface HyperlinkClickEventArgs { + /** Returns the PDF document name displaying in the PDF viewer. + */ + fileName?: string; + } - /** true, if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + export interface DocumentUnloadEventArgs { - /** Returns the PDF viewer model - */ - model?: any; + /** true, if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the name of the event - */ - type?: string; + /** Returns the PDF viewer model + */ + model?: any; - /** Returns the clicked hyperlink - */ - hyperlink?: string; -} + /** Returns the name of the event + */ + type?: string; + } -export interface BeforePrintEventArgs { + 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; -export interface AfterPrintEventArgs { + /** Returns the current page number in view. + */ + currentPageNumber?: number; + } - /** True, if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + export interface ZoomChangeEventArgs { - /** Returns the PDF viewer model - */ - model?: any; + /** true, if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the name of the event - */ - type?: string; -} + /** Returns the PDF viewer model + */ + model?: any; -export interface PageClickEventArgs { + /** Returns the name of the event. + */ + type?: string; - /** True, if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** Returns the previous zoom percentage of the PDF viewer control + */ + previousZoomPercentage?: number; - /** Returns the PDF viewer model - */ - model?: any; + /** Returns the current zoom percentage of the PDF viewer control + */ + currentZoomPercentage?: number; + } - /** Returns the name of the event - */ - type?: string; + export interface HyperlinkClickEventArgs { - /** Returns the current X position - */ - offsetX?: number; + /** true, if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the current Y position - */ - offsetY?: number; -} + /** Returns the PDF viewer model + */ + model?: any; -export interface BufferStartEventArgs { + /** Returns the name of the event + */ + type?: string; - /** True, if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + /** Returns the clicked hyperlink + */ + hyperlink?: string; + } - /** Returns the PDF viewer model - */ - model?: any; + export interface BeforePrintEventArgs { - /** Returns the name of the event - */ - type?: string; + /** True, if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Specifies the state of the buffering - */ - isBuffering?: boolean; -} + /** Returns the PDF viewer model + */ + model?: any; -export interface BufferEndEventArgs { + /** Returns the name of the event + */ + type?: string; + } - /** True, if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + export interface AfterPrintEventArgs { - /** Returns the PDF viewer model - */ - model?: any; + /** True, if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Returns the name of the event - */ - type?: string; + /** Returns the PDF viewer model + */ + model?: any; - /** Specifies the state of the buffering - */ - isBuffering?: boolean; -} + /** Returns the name of the event + */ + type?: string; + } -export interface DestroyEventArgs { + 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; -export interface ToolbarSettings { + /** Returns the current X position + */ + offsetX?: number; - /** Shows or hides the tooltip of the toolbar items. - */ - showToolTip?: boolean; + /** Returns the current Y position + */ + offsetY?: number; + } - /** Shows or hides the grouped items in the toolbar with the help of enum ej.PdfViewer.ToolbarItems - */ - toolbarItem?: ej.PdfViewer.ToolbarItems|string; -} + export interface BufferStartEventArgs { -export interface ServerActionSettings { + /** True, if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - /** Specifies the name of the action method used for loading the PDF document. - */ - load?: string; + /** Returns the PDF viewer model + */ + model?: any; - /** Specifies the name of the action method used for uploading the PDF document to the PDF viewer control. - */ - fileUpload?: string; + /** Returns the name of the event + */ + type?: string; - /** Specifies the name of the action method used for printing the PDF document in the PDF viewer control. - */ - print?: string; + /** Specifies the state of the buffering + */ + isBuffering?: boolean; + } - /** Specifies the name of the action method used for downloading the PDF document from the PDF viewer control. - */ - download?: string; -} + export interface BufferEndEventArgs { -enum ToolbarItems { + /** True, if the event should be canceled; otherwise, false. + */ + cancel?: boolean; - ///Shows only magnification tools in the toolbar. - MagnificationTools, - - ///Shows only page navigation tools in the toolbar. - PageNavigationTools, + /** Returns the PDF viewer model + */ + model?: any; - ///Shows only print tool in the toolbar. - PrintTools, + /** Returns the name of the event + */ + type?: string; - ///Shows only download tool in the toolbar. - DownloadTool, + /** Specifies the state of the buffering + */ + isBuffering?: boolean; + } - ///Shows all the toolbar items. - All -} + export interface DestroyEventArgs { + /** True, if the event should be canceled; otherwise, false. + */ + cancel?: boolean; -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; + /** Returns the PDF viewer model + */ + model?: 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; + /** Returns the name of the event + */ + type?: string; + } - /** 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 ToolbarSettings { -export interface ActionSuccessEventArgs { + /** Shows or hides the tooltip of the toolbar items. + */ + showToolTip?: boolean; - /** Returns the error word highlighted string. - */ - resultHTML?: string; + /** Shows or hides the grouped items in the toolbar with the help of enum ej.PdfViewer.ToolbarItems + */ + toolbarItem?: ej.PdfViewer.ToolbarItems | string; + } - /** Returns the error word details of the given input. - */ - errorWordDetails?: any; + export interface ServerActionSettings { - /** Returns the request type value. - */ - requestType?: string; + /** Specifies the name of the action method used for loading the PDF document. + */ + load?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Specifies the name of the action method used for uploading the PDF document to the PDF viewer control. + */ + fileUpload?: string; - /** Returns the SpellCheck model. - */ - model?: ej.SpellCheck.Model; + /** Specifies the name of the action method used for printing the PDF document in the PDF viewer control. + */ + print?: string; - /** Returns the name of the event. - */ - type?: string; -} + /** Specifies the name of the action method used for downloading the PDF document from the PDF viewer control. + */ + download?: string; + } -export interface ActionBeginEventArgs { + enum ToolbarItems { - /** Returns the input string. - */ - targetSentence?: string; + ///Shows only magnification tools in the toolbar. + MagnificationTools, + + ///Shows only page navigation tools in the toolbar. + PageNavigationTools, - /** Returns the misspellWordCss class name. - */ - misspellWordCss?: string; + ///Shows only print tool in the toolbar. + PrintTools, - /** Returns the request type value. - */ - requestType?: string; + ///Shows only download tool in the toolbar. + DownloadTool, - /** Returns the cancel option value. - */ - cancel?: boolean; + ///Shows all the toolbar items. + All + } - /** Returns the SpellCheck model. - */ - model?: ej.SpellCheck.Model; - /** Returns the name of the event. - */ - type?: string; -} + 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; -export interface ActionFailureEventArgs { + /** 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; - /** Returns AJAX request failure error message. - */ - errorMessage?: string; + /** 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; + } - /** Returns the request type value. - */ - requestType?: string; + export interface ActionSuccessEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the error word highlighted string. + */ + resultHTML?: string; - /** Returns the SpellCheck model. - */ - model?: ej.SpellCheck.Model; + /** Returns the error word details of the given input. + */ + errorWordDetails?: any; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the request type value. + */ + requestType?: string; -export interface StartEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the input string. - */ - targetSentence?: string; + /** Returns the SpellCheck model. + */ + model?: ej.SpellCheck.Model; - /** Returns the error words details. - */ - errorWords?: any; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the request type value. - */ - requestType?: string; + export interface ActionBeginEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the input string. + */ + targetSentence?: string; - /** Returns the SpellCheck model. - */ - model?: ej.SpellCheck.Model; + /** Returns the misspellWordCss class name. + */ + misspellWordCss?: string; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the request type value. + */ + requestType?: string; -export interface CompleteEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the error word highlighted string. - */ - resultHTML?: string; + /** Returns the SpellCheck model. + */ + model?: ej.SpellCheck.Model; - /** Returns the request type value. - */ - requestType?: string; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface ActionFailureEventArgs { - /** Returns the SpellCheck model. - */ - model?: ej.SpellCheck.Model; + /** Returns AJAX request failure error message. + */ + errorMessage?: string; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the request type value. + */ + requestType?: string; -export interface ContextOpenEventArgs { + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the selected error word. - */ - selectedErrorWord?: string; + /** Returns the SpellCheck model. + */ + model?: ej.SpellCheck.Model; - /** Returns the request type value. - */ - requestType?: string; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the cancel option value. - */ - cancel?: boolean; + export interface StartEventArgs { - /** Returns the SpellCheck model. - */ - model?: ej.SpellCheck.Model; + /** Returns the input string. + */ + targetSentence?: string; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the error words details. + */ + errorWords?: any; -export interface ContextClickEventArgs { + /** Returns the request type value. + */ + requestType?: string; - /** Returns the selected error word. - */ - selectedValue?: string; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the selected option in the context menu. - */ - selectedOption?: string; + /** Returns the SpellCheck model. + */ + model?: ej.SpellCheck.Model; - /** Returns the input string. - */ - targetContent?: string; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the request type value. - */ - requestType?: string; + export interface CompleteEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the error word highlighted string. + */ + resultHTML?: string; - /** Returns the SpellCheck model. - */ - model?: ej.SpellCheck.Model; + /** Returns the request type value. + */ + requestType?: string; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the cancel option value. + */ + cancel?: boolean; -export interface DialogBeforeOpenEventArgs { + /** Returns the SpellCheck model. + */ + model?: ej.SpellCheck.Model; - /** Returns the spell check window details. - */ - spellCheckDialog?: any; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the request type value. - */ - requestType?: string; + export interface ContextOpenEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the selected error word. + */ + selectedErrorWord?: string; - /** Returns the SpellCheck model. - */ - model?: ej.SpellCheck.Model; + /** Returns the request type value. + */ + requestType?: string; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the cancel option value. + */ + cancel?: boolean; -export interface DialogOpenEventArgs { + /** Returns the SpellCheck model. + */ + model?: ej.SpellCheck.Model; - /** Returns the target input. - */ - targetText?: string; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the request type value. - */ - requestType?: string; + export interface ContextClickEventArgs { - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the selected error word. + */ + selectedValue?: string; - /** Returns the SpellCheck model. - */ - model?: ej.SpellCheck.Model; + /** Returns the selected option in the context menu. + */ + selectedOption?: string; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the input string. + */ + targetContent?: string; -export interface DialogCloseEventArgs { + /** Returns the request type value. + */ + requestType?: string; - /** Returns the error corrected string. - */ - updatedText?: string; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the request type value. - */ - requestType?: string; + /** Returns the SpellCheck model. + */ + model?: ej.SpellCheck.Model; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the SpellCheck model. - */ - model?: ej.SpellCheck.Model; + export interface DialogBeforeOpenEventArgs { - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the spell check window details. + */ + spellCheckDialog?: any; -export interface ValidatingEventArgs { + /** Returns the request type value. + */ + requestType?: string; - /** Returns the cancel option value. - */ - cancel?: boolean; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** Returns the error word to ignore. - */ - ignoreWord?: string; + /** Returns the SpellCheck model. + */ + model?: ej.SpellCheck.Model; - /** Returns the target content. - */ - targetContent?: string; + /** Returns the name of the event. + */ + type?: string; + } - /** Returns the index of an error word. - */ - index?: number; + export interface DialogOpenEventArgs { - /** Returns the SpellCheck model. - */ - model?: ej.SpellCheck.Model; + /** Returns the target input. + */ + targetText?: string; - /** Returns the validating request type. - */ - requestType?: string; + /** Returns the request type value. + */ + requestType?: string; - /** Returns the name of the event. - */ - type?: string; + /** Returns the cancel option value. + */ + cancel?: boolean; - /** 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 SpellCheck model. + */ + model?: ej.SpellCheck.Model; -export interface OnRequestNavigateEventArgs { + /** Returns the name of the event. + */ + type?: string; + } - /** true, if the event should be canceled; otherwise, false. - */ - cancel?: boolean; + export interface DialogCloseEventArgs { - /** Returns the document editor model. - */ - model?: any; + /** Returns the error corrected string. + */ + updatedText?: string; - /** Returns the link type and navigation link. - */ - hyperlink?: any; + /** Returns the request type value. + */ + requestType?: string; - /** Returns the name of the event. - */ - type?: string; -} + /** Returns the cancel option value. + */ + cancel?: boolean; -export interface ImportExportSettings { + /** Returns the SpellCheck model. + */ + model?: ej.SpellCheck.Model; - /** Gets or sets URL of Web API that should be used to parse the document while loading. - */ - importUrl?: string; -} -} + /** 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} + */ + 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 { + + /** 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; + } + } } 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; + /** Sets the arrow position again popup based on horizontal(x) value + * @Default {center} + */ + horizontal?: ej.datavisualization.HeatMap.Horizontal | 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 { + /** Sets the arrow position again popup based on vertical(y) value + * @Default {bottom} + */ + vertical?: ej.datavisualization.HeatMap.Vertical | string; + } - /** Value displayed on the cell - */ - cellValue?: string; - - /** Returns the HeatMap cell data - */ - source?: any; + export interface TooltipSettingsPosition { - /** Returns the specific HeatMap cell - */ - cell?: any; -} + /** Sets the Tooltip position against target. + */ + target?: TooltipSettingsPositionTarget; -export interface TooltipSettingsPositionTarget { + /** Sets the arrow position again popup. + */ + stem?: TooltipSettingsPositionStem; + } - /** Sets the arrow position again popup based on horizontal(x) value - * @Default {center} - */ - horizontal?: ej.datavisualization.HeatMap.Horizontal|string; + export interface TooltipSettingsAnimation { - /** Sets the arrow position again popup based on vertical(y) value - * @Default {top} - */ - vertical?: ej.datavisualization.HeatMap.Vertical|string; -} + /** 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; -export interface TooltipSettingsPositionStem { + /** 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 based on horizontal(x) value - * @Default {center} - */ - horizontal?: ej.datavisualization.HeatMap.Horizontal|string; + export interface TooltipSettings { + + /** Defines the tooltip that should be shown when the mouse hovers over rows/columns. + * @Default {null} + */ + templateId?: string; - /** Sets the arrow position again popup based on vertical(y) value - * @Default {bottom} - */ - vertical?: ej.datavisualization.HeatMap.Vertical|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; + + /** Enables/ disables the balloon for the tooltip to be shown + * @Default {true} + */ + isBalloon?: boolean; -export interface TooltipSettingsPosition { + /** Defines various attributes of the Tooltip position + */ + position?: TooltipSettingsPosition; - /** Sets the Tooltip position against target. - */ - target?: TooltipSettingsPositionTarget; + /** Defines the tooltip to be triggered. + * @Default {hover} + */ + trigger?: ej.datavisualization.HeatMap.Trigger | string; - /** Sets the arrow position again popup. - */ - stem?: TooltipSettingsPositionStem; -} + /** Defines the animation for the tooltip that should be shown when the mouse hovers over rows/columns. + */ + animation?: TooltipSettingsAnimation; + } + + export interface HeatMapCell { -export interface TooltipSettingsAnimation { + /** 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 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; + /** Options to customize the Sparkline size. + */ + size?: Size; - /** Defines the animation speed for the tooltip that should be shown when the mouse hovers over rows/columns. - * @Default {0} - */ - speed?: number; -} + /** Options for customizing the color,dashArray and width of the axisLine. + */ + axisLineSettings?: AxisLineSettings; -export interface TooltipSettings { + /** Fires before loading the sparkline. */ + load?(e: LoadEventArgs): void; + + /** Fires after loaded the sparkline. */ + loaded?(e: LoadedEventArgs): void; - /** Defines the tooltip that should be shown when the mouse hovers over rows/columns. - * @Default {null} - */ - templateId?: string; + /** Fires before rendering trackball tooltip. You can use this event to customize the text displayed in trackball tooltip. */ + tooltipInitialize?(e: TooltipInitializeEventArgs): void; - /** Defines the tooltip of associate that should be shown when the mouse hovers over rows/columns. - */ - associate?: ej.datavisualization.HeatMap.Associate|string; + /** Fires before rendering a series. This event is fired for each series in Sparkline. */ + seriesRendering?(e: SeriesRenderingEventArgs): void; - /** Enables/ disables the balloon for the tooltip to be shown - * @Default {true} - */ - isBalloon?: boolean; + /** Fires when mouse is moved over a point. */ + pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; - /** Defines various attributes of the Tooltip position - */ - position?: TooltipSettingsPosition; + /** Fires on clicking a point in sparkline. You can use this event to handle clicks made on points. */ + pointRegionMouseClick?(e: PointRegionMouseClickEventArgs): void; - /** Defines the tooltip to be triggered. - * @Default {hover} - */ - trigger?: ej.datavisualization.HeatMap.Trigger|string; + /** Fires on moving mouse over the sparkline. */ + sparklineMouseMove?(e: SparklineMouseMoveEventArgs): void; - /** Defines the animation for the tooltip that should be shown when the mouse hovers over rows/columns. - */ - animation?: TooltipSettingsAnimation; -} + /** Fires on moving mouse outside the sparkline. */ + sparklineMouseLeave?(e: SparklineMouseLeaveEventArgs): void; + } -export interface HeatMapCell { + export interface LoadEventArgs { - /** Specifies whether the cell content can be visible or not. - * @Default {ej.HeatMap.CellVisibility.Visible} - */ - showContent?: ej.datavisualization.HeatMap.CellVisibility|string; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** 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; + /** Instance of the sparkline model object + */ + model?: any; - /** Options to customize the Sparkline size. - */ - size?: Size; + /** Name of the event + */ + type?: string; + } - /** Options for customizing the color,dashArray and width of the axisLine. - */ - axisLineSettings?: AxisLineSettings; + export interface LoadedEventArgs { - /** Fires before loading the sparkline. */ - load?(e: LoadEventArgs): void; - - /** Fires after loaded the sparkline. */ - loaded?(e: LoadedEventArgs): void; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Fires before rendering trackball tooltip. You can use this event to customize the text displayed in trackball tooltip. */ - tooltipInitialize?(e: TooltipInitializeEventArgs): void; + /** Instance of the sparkline model object + */ + model?: any; - /** Fires before rendering a series. This event is fired for each series in Sparkline. */ - seriesRendering?(e: SeriesRenderingEventArgs): void; + /** Name of the event + */ + type?: string; + } - /** Fires when mouse is moved over a point. */ - pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; + export interface TooltipInitializeEventArgs { - /** 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 { + /** 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; + } -export interface LoadedEventArgs { + 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; -export interface TooltipInitializeEventArgs { + /** 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; + } - /** X Location of the trackball tooltip in pixels - */ - locationX?: any; + export interface PointRegionMouseMoveEventArgs { - /** 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 { + /** 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; + } - /** Minimum x value of the data point - */ - minX?: any; + export interface PointRegionMouseClickEventArgs { - /** 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; + + /** 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; + /** Specifies the theme for Sunburst. + * @Default {Flatlight. See Theme} + */ + theme?: ej.datavisualization.Sunburst.SunburstTheme | string; - /** Type of the series - */ - seriesType?: string; -} + /** Options to customize the left, right, top and bottom margins of sunburst area. + */ + margin?: Margin; -export interface PointRegionMouseClickEventArgs { + /** Enable/disable the animation for all the levels. + * @Default {false} + */ + enableAnimation?: boolean; - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Opacity of the levels. + * @Default {1} + */ + opacity?: number; - /** Instance of the sparkline model object - */ - model?: any; + /** Options for enable zooming feature of chart. + */ + zoomSettings?: ZoomSettings; - /** Name of the event - */ - type?: string; + /** Animation type of sunburst + * @Default {rotation. See Alignment} + */ + animationType?: ej.datavisualization.Sunburst.Animation | string; - /** X-coordinate of point in pixel - */ - locationX?: number; + /** Fires before loading. */ + load?(e: LoadEventArgs): void; - /** Y-coordinate of point in pixel - */ - locationY?: number; + /** Fires before rendering sunburst. */ + preRender?(e: PreRenderEventArgs): void; - /** Index of the point in series - */ - pointIndex?: number; - - /** Type of the series - */ - seriesType?: string; -} - -export interface SparklineMouseMoveEventArgs { + /** Fires after rendering sunburst. */ + loaded?(e: LoadedEventArgs): void; - /** Set this option to true to cancel the event - */ - cancel?: boolean; + /** Fires before rendering the datalabel */ + dataLabelRendering?(e: DataLabelRenderingEventArgs): void; - /** 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; + /** Fires before rendering each segment */ + segmentRendering?(e: SegmentRenderingEventArgs): void; - /** 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; + /** Fires before rendering sunburst title. */ + titleRendering?(e: TitleRenderingEventArgs): void; - /** Specifies the theme for Sunburst. - * @Default {Flatlight. See Theme} - */ - theme?: ej.datavisualization.Sunburst.SunburstTheme|string; + /** Fires during initialization of tooltip. */ + tooltipInitialize?(e: TooltipInitializeEventArgs): void; - /** Options to customize the left, right, top and bottom margins of sunburst area. - */ - margin?: Margin; + /** Fires after clicking the point in sunburst */ + pointRegionClick?(e: PointRegionClickEventArgs): void; - /** Enable/disable the animation for all the levels. - * @Default {false} - */ - enableAnimation?: boolean; + /** Fires while moving the mouse over sunburst points */ + pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; - /** Opacity of the levels. - * @Default {1} - */ - opacity?: number; + /** Fires when clicking the point to perform drilldown. */ + drillDownClick?(e: DrillDownClickEventArgs): void; - /** Options for enable zooming feature of chart. - */ - zoomSettings?: ZoomSettings; + /** Fires when resetting drilldown points. */ + drillDownBack?(e: DrillDownBackEventArgs): void; - /** Animation type of sunburst - * @Default {rotation. See Alignment} - */ - animationType?: ej.datavisualization.Sunburst.Animation|string; + /** Fires after resetting the sunburst points */ + drillDownReset?(e: DrillDownResetEventArgs): void; + } - /** Fires before loading. */ - load?(e: LoadEventArgs): void; + export interface LoadEventArgs { - /** Fires before rendering sunburst. */ - preRender?(e: PreRenderEventArgs): void; + /** Load event data + */ + data?: string; - /** Fires after rendering sunburst. */ - loaded?(e: LoadedEventArgs): void; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Fires before rendering the datalabel */ - dataLabelRendering?(e: DataLabelRenderingEventArgs): void; + /** Instance of the sunburst model object + */ + model?: any; - /** Fires before rendering each segment */ - segmentRendering?(e: SegmentRenderingEventArgs): void; + /** Name of the event + */ + type?: string; + } - /** Fires before rendering sunburst title. */ - titleRendering?(e: TitleRenderingEventArgs): void; + export interface PreRenderEventArgs { - /** Fires during initialization of tooltip. */ - tooltipInitialize?(e: TooltipInitializeEventArgs): void; + /** PreRender event data + */ + data?: string; - /** Fires after clicking the point in sunburst */ - pointRegionClick?(e: PointRegionClickEventArgs): void; + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Fires while moving the mouse over sunburst points */ - pointRegionMouseMove?(e: PointRegionMouseMoveEventArgs): void; + /** Instance of the sunburst model object + */ + model?: any; - /** Fires when clicking the point to perform drilldown. */ - drillDownClick?(e: DrillDownClickEventArgs): void; + /** Name of the event + */ + type?: string; + } - /** Fires when resetting drilldown points. */ - drillDownBack?(e: DrillDownBackEventArgs): void; + export interface LoadedEventArgs { - /** Fires after resetting the sunburst points */ - drillDownReset?(e: DrillDownResetEventArgs): void; -} + /** Loaded event data + */ + data?: string; -export interface LoadEventArgs { + /** Set this option to true to cancel the event + */ + cancel?: boolean; - /** Load 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 DataLabelRenderingEventArgs { - /** Name of the event - */ - type?: string; -} + /** Sunburst datalabel 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 SegmentRenderingEventArgs { - /** Name of the event - */ - type?: string; -} + /** Sunburst datalabel 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 TitleRenderingEventArgs { - /** Name of the event - */ - type?: string; -} + /** Sunburst title 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 TooltipInitializeEventArgs { - /** Name of the event - */ - type?: string; -} + /** Sunburst tooltip 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 PointRegionClickEventArgs { - /** Name of the event - */ - type?: string; -} + /** Includes clicked points region 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 PointRegionMouseMoveEventArgs { - /** Name of the event - */ - type?: string; -} + /** Includes data of mouse moved region + */ + 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 DrillDownClickEventArgs { - /** Name of the event - */ - type?: string; -} + /** Clicked point 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 DrillDownBackEventArgs { - /** Name of the event - */ - type?: string; -} + /** Drill down data of points + */ + 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 DrillDownResetEventArgs { + + /** Drill down reset data + */ + data?: string; - /** 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} - */ - 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; } 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; /** diff --git a/types/estree/estree-tests.ts b/types/estree/estree-tests.ts index 0d4b8f5bd9..ace67225a4 100644 --- a/types/estree/estree-tests.ts +++ b/types/estree/estree-tests.ts @@ -123,7 +123,7 @@ expression = expressionStatement.expression; var ifStatement: ESTree.IfStatement; expression = ifStatement.test; statement = ifStatement.consequent; -var statementOrNull: ESTree.Statement | undefined = ifStatement.alternate; +var statementOrNull: ESTree.Statement | null | undefined = ifStatement.alternate; // LabeledStatement var labeledStatement: ESTree.LabeledStatement; @@ -141,18 +141,18 @@ switchCase = switchStatement.cases[0]; // ReturnStatement var returnStatement: ESTree.ReturnStatement; -var expressionMaybe: ESTree.Expression | undefined = returnStatement.argument; +var expressionMaybe: ESTree.Expression | null | undefined = returnStatement.argument; // TryStatement var tryStatement: ESTree.TryStatement; blockStatement = tryStatement.block; -var catchClauseMaybe: ESTree.CatchClause | undefined = tryStatement.handler; -var blockStatementMaybe: ESTree.BlockStatement | undefined = tryStatement.finalizer; +var catchClauseMaybe: ESTree.CatchClause | null | undefined = tryStatement.handler; +var blockStatementMaybe: ESTree.BlockStatement | null | undefined = tryStatement.finalizer; // ForStatement var forStatement: ESTree.ForStatement; -var variableDeclaratorOrExpressionMaybe: typeof variableDeclaratorOrExpression | undefined = forStatement.init; -var expressionMaybe: ESTree.Expression | undefined = forStatement.update; +var variableDeclaratorOrExpressionMaybe: typeof variableDeclaratorOrExpression | null | undefined = forStatement.init; +var expressionMaybe: ESTree.Expression | null | undefined = forStatement.update; // ForInStatement var forInStatement: ESTree.ForInStatement; @@ -176,7 +176,7 @@ string = property.kind; // FunctionExpression var functionExpression: ESTree.FunctionExpression; -var identifierMaybe: ESTree.Identifier | undefined = functionExpression.id; +var identifierMaybe: ESTree.Identifier | null | undefined = functionExpression.id; pattern = functionExpression.params[0]; pattern = assignmentPattern.left; expression = assignmentPattern.right; diff --git a/types/estree/flow.d.ts b/types/estree/flow.d.ts index 76c76008e6..605765e8ec 100644 --- a/types/estree/flow.d.ts +++ b/types/estree/flow.d.ts @@ -26,20 +26,20 @@ declare namespace ESTree { interface ClassImplements extends Node { id: Identifier; - typeParameters?: TypeParameterInstantiation; + typeParameters?: TypeParameterInstantiation | null; } interface ClassProperty { key: Expression; - value?: Expression; - typeAnnotation?: TypeAnnotation; + value?: Expression | null; + typeAnnotation?: TypeAnnotation | null; computed: boolean; static: boolean; } interface DeclareClass extends FlowDeclaration { id: Identifier; - typeParameters?: TypeParameterDeclaration; + typeParameters?: TypeParameterDeclaration | null; body: ObjectTypeAnnotation; extends: Array; } @@ -60,8 +60,8 @@ declare namespace ESTree { interface FunctionTypeAnnotation extends FlowTypeAnnotation { params: Array; returnType: FlowTypeAnnotation; - rest?: FunctionTypeParam; - typeParameters?: TypeParameterDeclaration; + rest?: FunctionTypeParam | null; + typeParameters?: TypeParameterDeclaration | null; } interface FunctionTypeParam { @@ -72,17 +72,17 @@ declare namespace ESTree { interface GenericTypeAnnotation extends FlowTypeAnnotation { id: Identifier | QualifiedTypeIdentifier; - typeParameters?: TypeParameterInstantiation; + typeParameters?: TypeParameterInstantiation | null; } interface InterfaceExtends extends Node { id: Identifier | QualifiedTypeIdentifier; - typeParameters?: TypeParameterInstantiation; + typeParameters?: TypeParameterInstantiation | null; } interface InterfaceDeclaration extends FlowDeclaration { id: Identifier; - typeParameters?: TypeParameterDeclaration; + typeParameters?: TypeParameterDeclaration | null; extends: Array; body: ObjectTypeAnnotation; } @@ -115,7 +115,7 @@ declare namespace ESTree { interface TypeAlias extends FlowDeclaration { id: Identifier; - typeParameters?: TypeParameterDeclaration; + typeParameters?: TypeParameterDeclaration | null; right: FlowTypeAnnotation; } diff --git a/types/estree/index.d.ts b/types/estree/index.d.ts index 26bccf1731..b7a4005add 100644 --- a/types/estree/index.d.ts +++ b/types/estree/index.d.ts @@ -28,7 +28,7 @@ interface BaseNode { leadingComments?: Array; trailingComments?: Array; - loc?: SourceLocation; + loc?: SourceLocation | null; range?: [number, number]; } export type Node = @@ -42,7 +42,7 @@ export interface Comment { } interface SourceLocation { - source?: string; + source?: string | null; start: Position; end: Position; } @@ -100,7 +100,7 @@ export interface IfStatement extends BaseStatement { type: "IfStatement"; test: Expression; consequent: Statement; - alternate?: Statement; + alternate?: Statement | null; } export interface LabeledStatement extends BaseStatement { @@ -111,12 +111,12 @@ export interface LabeledStatement extends BaseStatement { export interface BreakStatement extends BaseStatement { type: "BreakStatement"; - label?: Identifier; + label?: Identifier | null; } export interface ContinueStatement extends BaseStatement { type: "ContinueStatement"; - label?: Identifier; + label?: Identifier | null; } export interface WithStatement extends BaseStatement { @@ -133,7 +133,7 @@ export interface SwitchStatement extends BaseStatement { export interface ReturnStatement extends BaseStatement { type: "ReturnStatement"; - argument?: Expression; + argument?: Expression | null; } export interface ThrowStatement extends BaseStatement { @@ -144,8 +144,8 @@ export interface ThrowStatement extends BaseStatement { export interface TryStatement extends BaseStatement { type: "TryStatement"; block: BlockStatement; - handler?: CatchClause; - finalizer?: BlockStatement; + handler?: CatchClause | null; + finalizer?: BlockStatement | null; } export interface WhileStatement extends BaseStatement { @@ -162,9 +162,9 @@ export interface DoWhileStatement extends BaseStatement { export interface ForStatement extends BaseStatement { type: "ForStatement"; - init?: VariableDeclaration | Expression; - test?: Expression; - update?: Expression; + init?: VariableDeclaration | Expression | null; + test?: Expression | null; + update?: Expression | null; body: Statement; } @@ -201,7 +201,7 @@ export interface VariableDeclaration extends BaseDeclaration { export interface VariableDeclarator extends BaseNode { type: "VariableDeclarator"; id: Pattern; - init?: Expression; + init?: Expression | null; } type Expression = @@ -239,7 +239,7 @@ export interface Property extends BaseNode { } export interface FunctionExpression extends BaseFunction, BaseExpression { - id?: Identifier; + id?: Identifier | null; type: "FunctionExpression"; body: BlockStatement; } @@ -319,7 +319,7 @@ interface BasePattern extends BaseNode { } export interface SwitchCase extends BaseNode { type: "SwitchCase"; - test?: Expression; + test?: Expression | null; consequent: Array; } @@ -389,7 +389,7 @@ export interface ArrowFunctionExpression extends BaseExpression, BaseFunction { export interface YieldExpression extends BaseExpression { type: "YieldExpression"; - argument?: Expression; + argument?: Expression | null; delegate: boolean; } @@ -443,7 +443,7 @@ export interface AssignmentPattern extends BasePattern { export type Class = ClassDeclaration | ClassExpression; interface BaseClass extends BaseNode { - superClass?: Expression; + superClass?: Expression | null; body: ClassBody; } @@ -468,7 +468,7 @@ export interface ClassDeclaration extends BaseClass, BaseDeclaration { export interface ClassExpression extends BaseClass, BaseExpression { type: "ClassExpression"; - id?: Identifier; + id?: Identifier | null; } export interface MetaProperty extends BaseExpression { @@ -510,9 +510,9 @@ export interface ImportNamespaceSpecifier extends BaseModuleSpecifier { export interface ExportNamedDeclaration extends BaseModuleDeclaration { type: "ExportNamedDeclaration"; - declaration?: Declaration; + declaration?: Declaration | null; specifiers: Array; - source?: Literal; + source?: Literal | null; } export interface ExportSpecifier extends BaseModuleSpecifier { 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..1eb2a510d5 --- /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, + } +}); diff --git a/types/eureka-js-client/index.d.ts b/types/eureka-js-client/index.d.ts new file mode 100644 index 0000000000..36fcbc2624 --- /dev/null +++ b/types/eureka-js-client/index.d.ts @@ -0,0 +1,75 @@ +// 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 class Eureka { + constructor(config: EurekaClient.EurekaConfig) + start(): void; + stop(): void; + getInstancesByAppId(appId: string): string[]; + getInstancesByVipAddress(vidAddress: string): string []; +} + +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; + } + 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; + } + 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: DataCenterName; + } +} diff --git a/types/cheap-ruler/tsconfig.json b/types/eureka-js-client/tsconfig.json similarity index 92% rename from types/cheap-ruler/tsconfig.json rename to types/eureka-js-client/tsconfig.json index a693c8bcf3..5cb950ba75 100644 --- a/types/cheap-ruler/tsconfig.json +++ b/types/eureka-js-client/tsconfig.json @@ -17,6 +17,6 @@ }, "files": [ "index.d.ts", - "cheap-ruler-tests.ts" + "eureka-js-client-tests.ts" ] } \ 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 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/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/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..3f35b82112 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. diff --git a/types/hapi/index.d.ts b/types/hapi/index.d.ts index 9d8f8f0120..dbfa3bf038 100644 --- a/types/hapi/index.d.ts +++ b/types/hapi/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for hapi 16.0.0 +// Type definitions for hapi 16.0.1 // Project: http://github.com/spumko/hapi // Definitions by: Jason Swearingen // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped @@ -16,16 +16,9 @@ interface IDictionary { [key: string]: T; } -interface IThenable { - then(onFulfilled?: (value: R) => U | IThenable, onRejected?: (error: any) => U | IThenable): IThenable; - then(onFulfilled?: (value: R) => U | IThenable, onRejected?: (error: any) => void): IThenable; -} +export declare type IThenable = PromiseLike -interface IPromise extends IThenable { - then(onFulfilled?: (value: R) => U | IThenable, onRejected?: (error: any) => U | IThenable): IPromise; - then(onFulfilled?: (value: R) => U | IThenable, onRejected?: (error: any) => void): IPromise; - catch(onRejected?: (error: any) => U | IThenable): IPromise; -} +export declare type IPromise = Promise export interface IHeaderOptions { append?: boolean; 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 { 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 { diff --git a/types/inert/index.d.ts b/types/inert/index.d.ts index 9acbd6f1a7..cb9b8e8edb 100644 --- a/types/inert/index.d.ts +++ b/types/inert/index.d.ts @@ -1,15 +1,87 @@ -// 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 { + /** 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. + */ + 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. */ + 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..38830694cd 100644 --- a/types/inert/inert-tests.ts +++ b/types/inert/inert-tests.ts @@ -3,3 +3,34 @@ 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: function(){ + if(Math.random() > 0.5) { + return ''; + } + else if(Math.random() > 0) { + return ['']; + } + return new Error(''); + }, + listing: true, +} 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" } 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 diff --git a/types/karma/index.d.ts b/types/karma/index.d.ts index 8cae4a0fa4..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` @@ -205,6 +230,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. diff --git a/types/leaflet/index.d.ts b/types/leaflet/index.d.ts index 043a8eabe9..41da11d362 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 { 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; 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 `