From e41fb0af3145e3c6e07806cce09fc7daf5b5b5ec Mon Sep 17 00:00:00 2001 From: Andy Date: Mon, 23 Oct 2017 13:18:06 -0700 Subject: [PATCH] qlik-visualizationextensions: Fix lint (#20911) --- types/qlik-visualizationextensions/index.d.ts | 550 +++++++++--------- 1 file changed, 276 insertions(+), 274 deletions(-) diff --git a/types/qlik-visualizationextensions/index.d.ts b/types/qlik-visualizationextensions/index.d.ts index 38cf9935b8..7e6f3384b4 100644 --- a/types/qlik-visualizationextensions/index.d.ts +++ b/types/qlik-visualizationextensions/index.d.ts @@ -687,18 +687,18 @@ declare namespace BackendAPI { /** * Accepts the result of a search in a list object and the search result is selected in the field. - * @param {boolean} toggleMode - If true, toggle state for selected values + * @param toggleMode - If true, toggle state for selected values */ acceptSearch(toggleMode: boolean): void; /** * Updates the properties for this object. - * @param {array} qPatches - Array of patches. Each path contains: + * @param qPatches - Array of patches. Each path contains: * #qOp: Add/Remove/Replace * #qPath: Path to property * #qValue: The new value in string format. Strings need to be surrounded by \". - * @param {boolean} qSoftPatch - Set to True if properties should be soft, that is not persisted. - * @return {Promise} - A promise of a Qlik engine reply. + * @param qSoftPatch - Set to True if properties should be soft, that is not persisted. + * @return - A promise of a Qlik engine reply. */ applyPatches(qPatches: any[], qSoftPatch: boolean): ng.IPromise; @@ -710,171 +710,171 @@ declare namespace BackendAPI { /** * Clears all soft patches that has previously been applied for this object using the * applyPatches method. - * @return {Promise} - A promise of a Qlik engine reply. + * @return - A promise of a Qlik engine reply. */ clearSoftPatches(): ng.IPromise; /** * Collapse the left dimensions of a pivot table. Only works for hypercubes with * qMode = P which are not always fully expanded. - * @param {number} qRow - Row index. - * @param {number} qCol - Column index. - * @param {boolean} [qAll] - Optional. If set to true, qRow and qCol are ignored and all cells are collapsed. - * @return {Promise} - A promise of a Qlik engine reply. + * @param qRow - Row index. + * @param qCol - Column index. + * @param [qAll] - Optional. If set to true, qRow and qCol are ignored and all cells are collapsed. + * @return - A promise of a Qlik engine reply. */ collapseLeft(qRow: number, qCol: number, qAll?: boolean): ng.IPromise; /** * Collapse the top dimensions of a pivot table. Only works for hypercubes with * qMode = P which are not always fully expanded. - * @param {number} qRow - Row index. - * @param {number} qCol - Column index. - * @param {boolean} [qAll] - Optional. If set to true, qRow and qCol are ignored and all cells are collapsed. - * @return {Promise} - A promise of a Qlik engine reply. + * @param qRow - Row index. + * @param qCol - Column index. + * @param [qAll] - Optional. If set to true, qRow and qCol are ignored and all cells are collapsed. + * @return - A promise of a Qlik engine reply. */ collapseTop(qRow: number, qCol: number, qAll?: boolean): ng.IPromise; /** * Loops through data rows for this object. Only rows that are available client side will be used. - * @param {function} callback - Function to call for each row. + * @param callback - Function to call for each row. * Parameters are row number and row data as an array of NxCell objects. * The loop is terminated if the function returns false. - * @return {NxCell[]} - An array of NxCell. + * @return - An array of NxCell. */ eachDataRow(callback: any): INxCell[]; /** * Expands the left dimensions of a pivot table. Only works for hypercubes with * qMode = P which are not always fully expanded. - * @param {number} qRow - Row index. - * @param {number} qCol - Column index. - * @param {boolean} [qAll] - Optional. If set to true, qRow and qCol are ignored and all cells are collapsed. - * @return {Promise} - A promise of a Qlik engine reply. + * @param qRow - Row index. + * @param qCol - Column index. + * @param [qAll] - Optional. If set to true, qRow and qCol are ignored and all cells are collapsed. + * @return - A promise of a Qlik engine reply. */ expandLeft(qRow: number, qCol: number, qAll?: boolean): ng.IPromise; /** * Expands the top dimensions of a pivot table. Only works for hypercubes with * qMode = P which are not always fully expanded. - * @param {number} qRow - Row index. - * @param {number} qCol - Column index. - * @param {boolean} [qAll] - Optional. If set to true, qRow and qCol are ignored and all cells are collapsed. - * @return {Promise} - A promise of a Qlik engine reply. + * @param qRow - Row index. + * @param qCol - Column index. + * @param [qAll] - Optional. If set to true, qRow and qCol are ignored and all cells are collapsed. + * @return - A promise of a Qlik engine reply. */ expandTop(qRow: number, qCol: number, qAll?: boolean): ng.IPromise; /** * Geta data from Qlik engine for this object. - * @param {array} qPages - An array of NxPage objects. - * @return {Promise} - A promise of qDataPages. + * @param qPages - An array of NxPage objects. + * @return - A promise of qDataPages. */ getData(qPages: INxPage[]): ng.IPromise; /** * Gets a data row for this object. - * @param {number} rownum - The row number. - * @return {NxCell} - A row of NxCell or null if the row is not available client side + * @param rownum - The row number. + * @return - A row of NxCell or null if the row is not available client side * and need to be fetched with getData method. */ getDataRow(rownum: number): INxCell; /** * Gets qDimensionInfo for this object. - * @return {NxDimensionInfo[]} - An array of qDimensionInfo objects. + * @return - An array of qDimensionInfo objects. */ getDimensionInfos(): INxDimensionInfo[]; /** * Gets qMeasureInfo for this object. - * @return {NxMeasureInfo} - An array of qMeasureInfo objects. + * @return - An array of qMeasureInfo objects. */ getMeasureInfos(): INxMeasureInfo; /** * Gets pivot data from the Qlik engine for this object. Only works for hypercubes with qMode = P. - * @param {array} qPages - An array of request page objects. - * @return {Promise} - A promise of pivot data pages. + * @param qPages - An array of request page objects. + * @return - A promise of pivot data pages. */ getPivotData(qPages: INxPage[]): ng.IPromise; /** * Get properties for this object. - * @return {Promise} - A promise of object properties. + * @return - A promise of object properties. */ getProperties(): ng.IPromise; /** * Get reduced data from the Qlik engine for this object. This method is intended for preserving the * shape of the data, not for viewing the actual data points. - * @param {array} qPages - An array of request page objects. - * @param {number} qZoomFactor - Zoom factor. + * @param qPages - An array of request page objects. + * @param qZoomFactor - Zoom factor. * If set to -1, the Qlik engine decides of the zoom factor. * If qReductionMode is D1 or S, the zoom factor is 2n. * If the zoom factor is 5, the data are reduced by a factor 32. * If qReductionMode is C, the zoom factor defines the number of centroids. - * @param {string} qReductionMode - Reduction mode.Can be: + * @param qReductionMode - Reduction mode.Can be: * # N for no data reduction. * # D1 to reduce a bar chart or line chart. * The profile of the chart is reduced whatever the number of dimensions in the chart. * # S to reduce the resolution of a scatter plot. * # C to reduce the data of a scatter plot chart. * # ST to reduce the data of a stacked pivot table. - * @return {Promise} - A promise of reduced data pages. + * @return - A promise of reduced data pages. */ getReducedData(qPages: INxPage[], qZoomFactor: number, qReductionMode: string): ng.IPromise; /** * Get total number of data rows for this object. - * @return {Number} - A number. + * @return - A number. */ getRowCount(): number; /** * Get stacked data from the Qlik engine for this object. Only works for hypercubes with qMode = S. - * @param {array} qPages - An array of request page objects. - * @param {number} qMaxNbrCells - Maximum number of cells at outer level. - * @return {Promise} - A promise of stack data pages. + * @param qPages - An array of request page objects. + * @param qMaxNbrCells - Maximum number of cells at outer level. + * @return - A promise of stack data pages. */ getStackedData(qPages: INxPage[], qMaxNbrCells: number): ng.IPromise; /** * Find out if there are unconfirmed selections for this object. - * @return {boolean} - True if there are unconfirmed selections. + * @return - True if there are unconfirmed selections. */ hasSelections(): boolean; /** * Save this object. - * @return {Promise} - A promise. In case of success, it returns "undefined". In case of failure it returns the error. + * @return - A promise. In case of success, it returns "undefined". In case of failure it returns the error. */ save(): ng.IPromise; /** * Search for a term in a list object. Results in an updated layout, containing only matching records. - * @param {string} term - Term to search for. + * @param term - Term to search for. */ search(term: string): void; /** * Select values in this object using ranges. - * @param {array} qRanges - Array of ranges to select. - * @param {boolean} qOrMode - If true only one of the measures needs to be in range. + * @param qRanges - Array of ranges to select. + * @param qOrMode - If true only one of the measures needs to be in range. */ selectRange(qRanges: IRange[], qOrMode: boolean): void; /** * Select values in this object with a Qlik engine call which triggers a repaint of the object. - * @param {number} qDimNo - Dimension number. 0 = first dimension. - * @param {array} qValues - Array of values (qElemNumber in the matrix from the Qlik engine) to select or deselect. - * @param {boolean} qToggleMode - If true, values in the field are selected in addition to any previously selected items. + * @param qDimNo - Dimension number. 0 = first dimension. + * @param qValues - Array of values (qElemNumber in the matrix from the Qlik engine) to select or deselect. + * @param qToggleMode - If true, values in the field are selected in addition to any previously selected items. * If false, values in the field are selected while previously selected items are deselected. */ selectValues(qDimNo: number, qValues: any[], qToggleMode: boolean): void; /** * Set properties for this object. - * @param {object} props - The properties to set. - * @return {Promise} - A promise of a Qlik engine reply. + * @param props - The properties to set. + * @return - A promise of a Qlik engine reply. */ setProperties(props: any): ng.IPromise; } @@ -975,26 +975,26 @@ declare namespace RootAPI { interface IRoot { /** * Calls the Qlik Sense repository. - * @param {string} path - Path to the Qlik Sense repository. + * @param path - Path to the Qlik Sense repository. * Refer to Qlik Sense repository documentation for the available paths. - * @param {string} [method] - Optional. HTTP method. Default is GET. - * @param {string} [body] - Optional. Body of the post. - * @return {Promise} - A promise of a Qlik engine reply. + * @param [method] - Optional. HTTP method. Default is GET. + * @param [body] - Optional. Body of the post. + * @return - A promise of a Qlik engine reply. */ callRepository(path: string, method?: string, body?: string): ng.IPromise; - /** currApp + /** * Gets a reference to the current app. Use the currApp method in an extension to get a reference to the app currently displayed. - * @param {object} [reference] - Optional. Reference to extension object. Introduced in version 1.1. - * @return {IApp} - An App JavaScript object with app methods. + * @param [reference] - Optional. Reference to extension object. Introduced in version 1.1. + * @return - An App JavaScript object with app methods. */ currApp(object?: any): AppAPI.IApp; /** * Gets a list of Qlik Sense apps that you potentially can connect to and registers a callback to receive the data. * The getAppList method opens a WebSocket, gets the app list, and then closes the WebSocket. - * @param {function} callback - Callback method. - * @param {object} [config] - Optional. Additional configuration parameters: + * @param callback - Callback method. + * @param [config] - Optional. Additional configuration parameters: * Name | Type | Descr | Name * host | String | Optional. Qlik host. | host * port | String or integer | Port number. | port @@ -1008,28 +1008,29 @@ declare namespace RootAPI { /** * Gets a list of extensions installed for Qlik Sense. The reply contains all extensions, * that is widget libraries, visualization extensions and mashups. - * @param {function} [callback] - Optional. Callback method. - * @return {Promise} - A promise of a Qlik engine reply. + * @param [callback] - Optional. Callback method. + * @return - A promise of a Qlik engine reply. */ getExtensionList(callback?: any): ng.IPromise; /** * Opens a WebSocekt connection to the Qlik engine for global methods. - * @param {object} [config] - Optional. Parameters: + * @param [config] - Optional. Parameters: * Name | Type | Description * host | String | Qlik Sense host * port | String | Port number * prefix | String | Qlik Sense virtual proxy. / if no virtual proxy * isSecure | Boolean | Use SSL * identity | String | Unique identity for the session. If omitted, the session will be shared. - * @return {ANY} - A global JavaScript object with global methods. + * @return - A global JavaScript object with global methods. */ getGlobal(config: any): any; - /** Opens a Qlik Sense app. You can open multiple apps. - * Most other methods are defined on the app. Returns: App JavaScript object with app methods. - * @param {string} appId The app id. - * @param {object} [config] Optional. Additional configuration parameters: + /** + * Opens a Qlik Sense app. You can open multiple apps. + * Most other methods are defined on the app. + * @param appId The app id. + * @param [config] Optional. Additional configuration parameters: * Name | Type | Descr * host | String | Optional. Qlik host. * port | String or Integer | Port number. @@ -1038,7 +1039,7 @@ declare namespace RootAPI { * openWithoutData | Boolean | Optional. Open app without loading data. Introduced in version 1.1. * identity | String | Optional. Unique identity for the session. If omitted, the session will be shared. * Parameter updated in version 2.2. - * @return {any} - App JavaScript object with app methods. + * @return - App JavaScript object with app methods. */ openApp(appId: string, config?: any): any; @@ -1047,30 +1048,30 @@ declare namespace RootAPI { * Qlik Sense server and only available in the session where it is created. * As long as a JavaScript module is created in the correct format, it can be sent to * the registerExtension function. - * @param {string} id - Set the ID of the visualization extension. - * @param {object} impl - Set the extension implementation. - * @param {object} [metadata] - Optional. Extension meta-data, same format as the QEXT file. Default: {"type":"visualization"} + * @param id - Set the ID of the visualization extension. + * @param impl - Set the extension implementation. + * @param [metadata] - Optional. Extension meta-data, same format as the QEXT file. Default: {"type":"visualization"} */ registerExtension(id: string, impl: any, metadata?: any): void; /** * Sends a resize event to all Qlik Sense objects. - * @param {string} [ID] - Object id. Optional: if no ID resize event will be sent to all objects. + * @param [ID] - Object id. Optional: if no ID resize event will be sent to all objects. */ resize(ID?: string): void; /** * Creates a session app JavaScript object with app methods. - * @param {any} [config] - Additional configuration parameters - * @return {any} - App JavaScript object with app methods. + * @param [config] - Additional configuration parameters + * @return - App JavaScript object with app methods. */ sessionApp(config?: ISessionAppConfig): AppAPI.IApp; /** * Creates a session app JavaScript object with app methods from an existing app. You can create one session app per app. - * @param {string} [appId] - App id of the app to base the session app upon. - * @param {any} [config] - Additional configuration parameters. - * @return {any} - App JavaScript object with app methods. + * @param [appId] - App id of the app to base the session app upon. + * @param [config] - Additional configuration parameters. + * @return - App JavaScript object with app methods. */ sessionAppFromApp(appId: string, config?: ISessionAppConfig): AppAPI.IApp; @@ -1078,7 +1079,7 @@ declare namespace RootAPI { * Sets a specific language for the Qlik Sense session. * Language should be defined before the app is opened meaning the setLanguage * method should be called before the openApp method is called. - * @param {string} lang - Language code. Can be: + * @param lang - Language code. Can be: * # German: short: de long: de-DE * # English: short: en long: en-US * # Spanish: short: es long: es-ES @@ -1100,16 +1101,16 @@ declare namespace RootAPI { /** * Registers a callback for error handling. Standard Qlik Sense error * handling is used if this method is not called. - * @param {function} onError - Error handling function - * @param {function} [onWarning] - Optional. Warning handling function. Introduced in version 2.1. + * @param onError - Error handling function + * @param [onWarning] - Optional. Warning handling function. Introduced in version 2.1. */ setOnError(onError: any, onWarning?: any): void; /** * Create a QTable object that wraps data in your extension and provides an object oriented interface. - * @param {object} ext - Extension or angular scope for the extension. - * @param {string} [path] - Optional. Path to the hypercube. Default: qHyperCube - * @return {QTable} - A QTable object that holds data and options for the table. + * @param ext - Extension or angular scope for the extension. + * @param [path] - Optional. Path to the hypercube. Default: qHyperCube + * @return - A QTable object that holds data and options for the table. */ table(ext: any, path?: string): TableAPI.IQTable; @@ -1123,22 +1124,22 @@ declare namespace AppAPI { * Adds an alternate state in the app. Multiple states within a Qlik Sense * app can be created and applied to specific objects within the app. * Objects in a given state are not affected by user selection in the other states. - * @param {string} qStateName - Mandatory. Alternate state name. - * @return {Promise} - A promise of a Qlik engine reply. + * @param qStateName - Mandatory. Alternate state name. + * @return - A promise of a Qlik engine reply. */ addAlternateState(qStateName: string): ng.IPromise; /** * Steps back in the list of selections. - * @return {Promise} - A promise of a Qlik engine reply. + * @return - A promise of a Qlik engine reply. */ back(): ng.IPromise; /** * Clears all selections in all fields of the current Qlik Sense app. - * @param {boolean} [lockedAlso] - Optional. Alternate state name. Default: false Introduced in version 2.1. - * @param {string} [state] - Optional. Alternate state name. Default: $ Introduced in version 2.1. - * @return {Promise} - A promise of a Qlik engine reply. + * @param [lockedAlso] - Optional. Alternate state name. Default: false Introduced in version 2.1. + * @param [state] - Optional. Alternate state name. Default: $ Introduced in version 2.1. + * @return - A promise of a Qlik engine reply. */ clearAll(lockedAlso?: boolean, state?: string): ng.IPromise; @@ -1149,9 +1150,9 @@ declare namespace AppAPI { /** * Defines a hypercube and registers a callback to receive the data. - * @param {object} qHyperCubeDef - Cube definition. - * @param {function} [callback] - Optional. Callback method. Parameter will contain a qHyperCube. - * @return {Promise} - A promise of an object model. + * @param qHyperCubeDef - Cube definition. + * @param [callback] - Optional. Callback method. Parameter will contain a qHyperCube. + * @return - A promise of an object model. */ createCube(qHyperCubeDef: any, callback?: any): ng.IPromise; @@ -1164,29 +1165,29 @@ declare namespace AppAPI { * The callback method will be called whenever the selection state changes * in a way that affects the generic object. * The parameter will be the evaluated version of the definition. - * @param {object} [def] - Optional. Generic object definition - * @param {function} [callback] - Optional. Callback method. - * @return {Promise} - A promise of an object model. + * @param [def] - Optional. Generic object definition + * @param [callback] - Optional. Callback method. + * @return - A promise of an object model. */ createGenericObject(def?: any, callback?: any): ng.IPromise; /** * Defines a list of field values and registers a callback to receive the data. - * @param {object} qListObjectDef - List definition. - * @param {function} [callback] - Optional. Callback method. Parameter will contain a qListObject. - * @return {Promise} - A promise of an object model. + * @param qListObjectDef - List definition. + * @param [callback] - Optional. Callback method. Parameter will contain a qListObject. + * @return - A promise of an object model. */ createList(qListObjectDef: any, callback?: any): ng.IPromise; /** * Defines a hypercube for a table and is the entry point to the Table API. * It creates a table object that wraps the hypercube. - * @param {Array.} dimensions - Dimensions to use. + * @param dimensions - Dimensions to use. * Should, for each entry, be a field name or a NxDimension structure. - * @param {Array.} measures - Measures to use. + * @param measures - Measures to use. * Should, for each entry, be an expression or a NxMeasure structure. - * @param {object} [options] - Optional. Options to set. - * @return {QTable} - A table object of type QTable, which is initially + * @param [options] - Optional. Options to set. + * @return - A table object of type QTable, which is initially * empty but that eventually will contain data. * The table object will be updated when selection state changes. */ @@ -1197,73 +1198,73 @@ declare namespace AppAPI { * method or any of createCube, createList or getList methods. * Calling this method removes the object from the Qlik engine, * no more updates are sent to the client and all methods on the object are invalid. - * @param {string} id - Session object id. - * @return {Promise} - A promise of a Qlik engine reply. + * @param id - Session object id. + * @return - A promise of a Qlik engine reply. */ destroySessionObject(id: string): ng.IPromise; /** * Reloads the data in a Qlik Sense app. - * @param {string} [qMode] - Optional. Error handling mode: + * @param [qMode] - Optional. Error handling mode: * # 0 = default mode. * # 1 = attempt recovery on all errors. * # 2 = fail on all errors. - * @param {boolean} [qPartial] - Optional. Set to true for partial reload. - * @param {boolean} [qDebug] - Optional. Set to true if debug breakpoints are honored. Execution of the script will be in debug mode. - * @return {Promise} - A promise of a Qlik engine reply. + * @param [qPartial] - Optional. Set to true for partial reload. + * @param [qDebug] - Optional. Set to true if debug breakpoints are honored. Execution of the script will be in debug mode. + * @return - A promise of a Qlik engine reply. */ doReload(qMode?: string, qPartial?: boolean, qDebug?: boolean): ng.IPromise; /** * Saves a Qlik Sense app, including all objects and data in the data model. - * @param {string} [qFileName] - Optional. File name of the file to save. - * @return {Promise} - A promise of a Qlik engine reply. + * @param [qFileName] - Optional. File name of the file to save. + * @return - A promise of a Qlik engine reply. */ doSave(qFileName?: string): ng.IPromise; /** * Gets a field reference with methods that can be used to manipulate the field. - * @param {string} [field] - Optional. Name of the field. - * @param {string} [state] - Optional. Alternate state name. Default is $. - * @return {QField} - A QField object with methods and properties that can be used to manipulate the field. + * @param [field] - Optional. Name of the field. + * @param [state] - Optional. Alternate state name. Default is $. + * @return - A QField object with methods and properties that can be used to manipulate the field. */ field(field?: string, state?: string): FieldAPI.IQField; /** * Step forward in list of selections. - * @return {Promise} - A promise of a Qlik engine reply. + * @return - A promise of a Qlik engine reply. */ forward(): ng.IPromise; /** * Gets a layout for this Qlik Sense app and registers a callback to receive the data. * Returns the dynamic properties (if any) in addition to the fixed properties. - * @param {function} [callback] - Optional. Callback method. - * @return {Promise} - A promise of a Qlik engine reply. + * @param [callback] - Optional. Callback method. + * @return - A promise of a Qlik engine reply. */ getAppLayout(callback?: any): ng.IPromise; /** * Gets a list of sheets and visualizations and registers a callback to receive the data. - * @param {string} [field] - Optional. Type of object. One of: + * @param [field] - Optional. Type of object. One of: * # sheet * # masterobject * Default is sheet. - * @param {function} [callback] - Optional. Callback method. + * @param [callback] - Optional. Callback method. */ getAppObjectList(type?: string, callback?: any): void; /** * Gets properties for a generic object, the children of the generic object * and the bookmarks and/or embedded snapshots of the generic object. - * @param {string} id - Object id. - * @return {Promise} - A promise of an object model. + * @param id - Object id. + * @return - A promise of an object model. */ getFullPropertyTree(id: string): ng.IPromise; /** * Gets a list of internal Qlik Sense objects and registers a callback to receive the data. - * @param {string} type - Type of object: + * @param type - Type of object: * # FieldList * # MeasureList * # DimensionList @@ -1275,8 +1276,8 @@ declare namespace AppAPI { * # MasterObject (Introduced in version 1.1) * # VariableList (Introduced in version 2.0) * # story (Introduced in version 2.1) - * @param {function} [callback] - Optional. Registers a callback that is executed every time data is returned. - * @return {Promise} - A promise of an object model. + * @param [callback] - Optional. Registers a callback that is executed every time data is returned. + * @return - A promise of an object model. */ getList(type: string, callback?: any): ng.IPromise; @@ -1285,30 +1286,30 @@ declare namespace AppAPI { * it into a HTML element. The object fills the HTML object, so you can size * and position the element to determine how large the Qlik Sense object will be. * If you supply only one parameter, you get the model without displaying the object. - * @param {string} id - Object id or 'CurrentSelections' if used for Selections bar. - * @param {Element | string} [elem] - Optional. HTML element. + * @param id - Object id or 'CurrentSelections' if used for Selections bar. + * @param [elem] - Optional. HTML element. * Since version 1.1 it is also possible to define a string of the HTML element id. - * @param {object} [options] - Optional. + * @param [options] - Optional. * Name | Type | Description * noInteraction | Boolean | Set to true if you want to disable interaction, * including selections, in the visualization. * Introduced in version 1.1 and updated in version 3.0. * noSelections | Boolean | Set to true if you want to disable selections in the visualization. * Introduced in version 3.0. - * @return {Promise} - A promise of an object model. + * @return - A promise of an object model. */ getObject(id: string, elem?: any | string, options?: any): ng.IPromise; /** * Gets properties for a Qlik Sense object. - * @param {string} id - Object id. - * @return {Promise} - A promise of an object model. + * @param id - Object id. + * @return - A promise of an object model. */ getObjectProperties(id: string): ng.IPromise; /** * Gets the data load script of this app. - * @return {Promise} - A promise of an qScript object. + * @return - A promise of an qScript object. */ getScript(): ng.IPromise; @@ -1317,37 +1318,37 @@ declare namespace AppAPI { * the HTML object so you can size and position the element to determine * how large the Qlik Sense object will be. If you only supply one parameter, * you will just get the model without displaying the object. - * @param {string} id - Snapshot ID. - * @param {element | string} [elem] - Optional. HTML element or string with HTML element id. - * @return {Promise} - A promise of an object model. + * @param id - Snapshot ID. + * @param [elem] - Optional. HTML element or string with HTML element id. + * @return - A promise of an object model. */ getSnapshot(id: string, elem?: any | string): ng.IPromise; /** * Locks all selections. - * @param {string} [state=$] - Optional. Alternate state name. + * @param [state=$] - Optional. Alternate state name. * Default: $ * Introduced in version 2.1. - * @return {Promise} - A promise of a Qlik engine reply. + * @return - A promise of a Qlik engine reply. */ lockAll(state?: string): ng.IPromise; /** * Removes an alternate state in the app. - * @param {string} qStateName - Alternate state name. - * @return {Promise} - A promise of a Qlik engine reply. + * @param qStateName - Alternate state name. + * @return - A promise of a Qlik engine reply. */ removeAlternateState(qStateName: string): ng.IPromise; /** * Searches for one or more terms in the values of a Qlik Sense app. - * @param {array} qTerms - Terms to search for. - * @param {object} qPage - Properties: + * @param qTerms - Terms to search for. + * @param qPage - Properties: * Name | Type | Description * qOffset | Number | Position from the top, starting from 0. * qCount | Number | Number of search results to return. * qMaxNbrFieldMatches | Number | Maximum number of matching values to return per search result. - * @param {object} qOptions - Properties + * @param qOptions - Properties * Name | Type | Description * qSearchFields | Array | List of search fields. * qContext | | Search context. Can be one of: @@ -1364,15 +1365,15 @@ declare namespace AppAPI { * are made on top of the current selections. If no selections were * made before the search, this mode is identical to the Cleared context. * | | Default value is LockedFieldsOnly. - * @param {function} [callback] - Optional. Callback method. - * @return {Promise} - A promise of a Qlik engine reply. + * @param [callback] - Optional. Callback method. + * @return - A promise of a Qlik engine reply. */ searchAssociations(qTerms: any[], qPage: any, qOptions: any, callback?: any): ng.IPromise; /** * Searches for one or more terms in the values of a Qlik Sense app. - * @param {array} qTerms - Terms to search for. - * @param {object} qPage - Properties: + * @param qTerms - Terms to search for. + * @param qPage - Properties: * Name | Type | Description * qOffset | Number | Position from the top, starting from 0. * qCount | Number | Number of search results to return. @@ -1395,49 +1396,49 @@ declare namespace AppAPI { * are made on top of the current selections. If no selections were * made before the search, this mode is identical to the Cleared context. * | | Default value is LockedFieldsOnly. - * @param {function} [callback] - Optional. Callback method. - * @return {Promise} - A promise of a Qlik engine reply. + * @param [callback] - Optional. Callback method. + * @return - A promise of a Qlik engine reply. */ searchResults(qTerms: any[], qPage: any, qOptions?: any, callback?: any): ng.IPromise; /** * Returns suggestions of words from the values entered in the search. Acts as a helper for the searchAssociations method. - * @param {array} qTerms - Terms to search for. - * @param {object} [qOptions] - Optional. Search options. Properties: + * @param qTerms - Terms to search for. + * @param [qOptions] - Optional. Search options. Properties: * Name | Type | Description * qSearchFields | Array | List of search fields. - * @param {function} [callback] - Optional. Callback method. - * @return {Promise} - A promise of a Qlik engine reply. + * @param [callback] - Optional. Callback method. + * @return - A promise of a Qlik engine reply. */ searchSuggest(qTerms: any[], qOptions?: any, callback?: any): ng.IPromise; /** * Makes a selection based on searchAssociation results. - * @param {number} qMatchIx - Index to search result. - * @param {array} qTerms - Values to select. - * @param {object} qOptions - Values to select. - * @param {array} [qTerms] - Optional. Parameter sent to the Qlik engine containing information about the search fields and the search context. - * @param {object} [qSoftLock] - Optional. This parameter was deprecated in version 2.0 and is ignored in newer versions. Use the qOtions.qContext parameter instead. - * @return {Promise} - A promise of a Qlik engine reply. + * @param qMatchIx - Index to search result. + * @param qTerms - Values to select. + * @param qOptions - Values to select. + * @param [qTerms] - Optional. Parameter sent to the Qlik engine containing information about the search fields and the search context. + * @param [qSoftLock] - Optional. This parameter was deprecated in version 2.0 and is ignored in newer versions. Use the qOtions.qContext parameter instead. + * @return - A promise of a Qlik engine reply. */ selectAssociations(qMatchIx: number, qTerms: any[], qOptions?: any, qSoftLock?: any): ng.IPromise; /** * Sets the data load script of this app. Also validates the script syntax and returns the syntax errors if errors exist. - * @param {string} [state] - Optional. Sets the state. Default is $. + * @param [state] - Optional. Sets the state. Default is $. */ selectionState(state?: string): SelectionStateAPI.IQSelectionState; /** * Creates a QSelectionState object that encapsulates the selection state. Entry point to the Selection API. - * @param {string} [script] - The script content. - * @return {Promise} - A promise of an empty object or a list of syntax errors depending on the validation result. + * @param [script] - The script content. + * @return - A promise of an empty object or a list of syntax errors depending on the validation result. */ setScript(script: string): ng.IPromise; /** * Unlocks all selections that has previously been locked. - * @param {string} [state] - Optional. Alternate state name. Default: $ Introduced in version 2.1. + * @param [state] - Optional. Alternate state name. Default: $ Introduced in version 2.1. */ unlockAll(state?: string): ng.IPromise; } @@ -1447,24 +1448,24 @@ declare namespace BookmarkAPI { interface IBookmark { /** * Applies a bookmark. - * @param {string} id - Bookmark id. - * @return {Promise} - A promise of a Qlik engine reply. + * @param id - Bookmark id. + * @return - A promise of a Qlik engine reply. */ apply(id: string): ng.IPromise; /** * Creates a bookmark based on the current selection. - * @param {string} title - Bookmark title. - * @param {string} description - Bookmark description. - * @param {string} [sheetId] - Optional. Bookmark sheet id. Introduced in version 2.2. - * @return {Promise} - A promise of a Qlik engine reply. + * @param title - Bookmark title. + * @param description - Bookmark description. + * @param [sheetId] - Optional. Bookmark sheet id. Introduced in version 2.2. + * @return - A promise of a Qlik engine reply. */ create(title: string, description: string, sheetId?: string): ng.IPromise; /** * Removes a bookmark. - * @param {string} id - Bookmark id. - * @return {Promise} - A promise of a Qlik engine reply. + * @param id - Bookmark id. + * @return - A promise of a Qlik engine reply. */ remove(id: string): ng.IPromise; } @@ -1474,14 +1475,14 @@ declare namespace FieldAPI { interface IQField { /** * Clears a field selection. - * @return {Promise} - A promise. + * @return - A promise. */ clear(): ng.IPromise; /** * Clears all fields except the selected one. - * @param {boolean} [softlock] - Optional. If true, locked selections can be overridden. - * @return {Promise} - A promise. + * @param [softlock] - Optional. If true, locked selections can be overridden. + * @return - A promise. */ clearOther(softlock?: boolean): ng.IPromise; @@ -1489,7 +1490,7 @@ declare namespace FieldAPI { * Gets field data. The values are available as QFieldValue in array * field.rows and will updated when the selection state changes. * Notification OnData will be triggered after each update. - * @param {boolean} [options] - Optional. Properties: + * @param [options] - Optional. Properties: * Name | Type | Description * rows | Number | Number of rows to fetch. Default: 200. * frequencyMode | String | Can be one of: @@ -1498,89 +1499,89 @@ declare namespace FieldAPI { * # R=Relative * # N=No frequency * | | Default: V. - * @return {IQField} - The field object. + * @return - The field object. */ getData(options?: boolean): IQField; /** * Gets more data for your field. Notification OnData is triggered when complete. - * @return {IQField} - The field object. + * @return - The field object. */ getMoreData(): IQField; /** * Locks a field selection. - * @return {Promise} - A promise. + * @return - A promise. */ lock(): ng.IPromise; /** * Selects field values using indexes. - * @param {number[]} Array - Array of index values to select - * @param {boolean} [toggle] - Optional. If true, toggle selected state. - * @param {boolean} [softlock] - Optional. If true, locked selections can be overridden. - * @return {Promise} - A promise. + * @param Array - Array of index values to select + * @param [toggle] - Optional. If true, toggle selected state. + * @param [softlock] - Optional. If true, locked selections can be overridden. + * @return - A promise. */ select(Array: number[], toggle?: boolean, softlock?: boolean): ng.IPromise; /** * Selects all values in a field. - * @param {boolean} [softlock] - Optional. If true, locked selections can be overridden. - * @return {Promise} - A promise. + * @param [softlock] - Optional. If true, locked selections can be overridden. + * @return - A promise. */ selectAll(softlock?: boolean): ng.IPromise; /** * Selects alternative values in a field. - * @param {boolean} [softlock] - Optional. If true, locked selections can be overridden. - * @return {Promise} - A promise. + * @param [softlock] - Optional. If true, locked selections can be overridden. + * @return - A promise. */ selectAlternative(softlock?: boolean): ng.IPromise; /** * Selects excluded values in a field. - * @param {boolean} [softlock] - Optional. If true, locked selections can be overridden. - * @return {Promise} - A promise. + * @param [softlock] - Optional. If true, locked selections can be overridden. + * @return - A promise. */ selectExcluded(softlock?: boolean): ng.IPromise; /** * Selects matching field values. - * @param {string} match - Match string. - * @param {boolean} [softlock] - Optional. If true, locked selections can be overridden. - * @return {Promise} - A promise. + * @param match - Match string. + * @param [softlock] - Optional. If true, locked selections can be overridden. + * @return - A promise. */ selectMatch(match: string, softlock?: boolean): ng.IPromise; /** * Selects possible values in a field. - * @param {boolean} [softlock] - Optional. If true, locked selections can be overridden. - * @return {Promise} - A promise. + * @param [softlock] - Optional. If true, locked selections can be overridden. + * @return - A promise. */ selectPossible(softlock?: boolean): ng.IPromise; /** * Selects specific values in a field. - * @param {array} array - Array of qFieldValues to select. A simplified syntax with + * @param array - Array of qFieldValues to select. A simplified syntax with * strings or numbers also works since version 1.1. * For a numeric field you need to provide the numeric value. - * @param {boolean} [toggle] - Optional. If true, toggle selected state. - * @param {boolean} [softlock] - Optional. If true, locked selections can be overridden. - * @return {Promise} - A promise. + * @param [toggle] - Optional. If true, toggle selected state. + * @param [softlock] - Optional. If true, locked selections can be overridden. + * @return - A promise. */ selectValues(array: IQFieldValue[], toggle?: boolean, softlock?: boolean): ng.IPromise; /** * Toggles a field selection. - * @param {string} match - Match string. - * @param {boolean} [softlock] - Optional. If true, locked selections can be overridden. - * @return {Promise} - A promise. + * @param match - Match string. + * @param [softlock] - Optional. If true, locked selections can be overridden. + * @return - A promise. */ toggleSelect(match: string, softlock?: boolean): ng.IPromise; /** * Unlocks field selections. - * @return {Promise} - A promise. + * @return - A promise. */ unlock(): ng.IPromise; @@ -1629,9 +1630,9 @@ declare namespace FieldAPI { /** * Selects a field value. - * @param {boolean} [toggle] - Optional. If true, toggle selected state. - * @param {boolean} [softlock] - Optional. If true, locked selections can be overridden. - * @return {Promise} - A promise. + * @param [toggle] - Optional. If true, toggle selected state. + * @param [softlock] - Optional. If true, locked selections can be overridden. + * @return - A promise. */ select(toggle?: boolean, softlock?: boolean): ng.IPromise; } @@ -1641,7 +1642,7 @@ declare namespace GlobalAPI { interface IGlobal { /** * Cancels an ongoing reload. The reload of the app is stopped. - * @return {Promise} - A promise of a Qlik engine reply. + * @return - A promise of a Qlik engine reply. */ cancelReload(): ng.IPromise; @@ -1650,45 +1651,45 @@ declare namespace GlobalAPI { * registers a callback to receive the data. Calling the getAppList method * opens a WebSocket, gets the app list, and then keeps the WebSocket open * for you to make other calls as well. - * @param {Function} callback - Callback method. + * @param callback - Callback method. */ getAppList(callback: any): void; /** * Gets information (user directory and user id) about the authenticated user. - * @param {Function} [callback] - Optional. Callback method. - * @return {Promise} - A promise of a Qlik engine reply. + * @param [callback] - Optional. Callback method. + * @return - A promise of a Qlik engine reply. */ getAuthenticatedUser(callback?: any): ng.IPromise; /** * Gets information about progress of doReload and doSave calls. - * @param {Number} qRequestId - Request id from doReload call or 0. + * @param qRequestId - Request id from doReload call or 0. * Complete information is returned if the identifier of the request is specified. * If qRequestId = 0, less information is returned. - * @param {Function} [callback] - Optional. Callback method. - * @return {Promise} - A promise of a Qlik engine reply. + * @param [callback] - Optional. Callback method. + * @return - A promise of a Qlik engine reply. */ getProgress(qRequestId: number, callback?: any): ng.IPromise; /** * Gets the product version. - * @param {Function} [callback] - Optional. Callback method. - * @return {Promise} - A promise of a Qlik engine reply. + * @param [callback] - Optional. Callback method. + * @return - A promise of a Qlik engine reply. */ getProductVersion(callback?: any): ng.IPromise; /** * Gets the Qlik product name. - * @param {Function} [callback] - Optional. Callback method. - * @return {Promise} - A promise of a Qlik engine reply. + * @param [callback] - Optional. Callback method. + * @return - A promise of a Qlik engine reply. */ getQTProduct(callback?: any): ng.IPromise; /** * Gets the Qlik Sense version number. - * @param {Function} [callback] - Optional. Callback method. - * @return {Promise} - A promise. + * @param [callback] - Optional. Callback method. + * @return - A promise. */ getQvVersion(callback?: any): ng.IPromise; @@ -1696,8 +1697,8 @@ declare namespace GlobalAPI { * Gets information if the user is working in personal mode * (returns true if Qlik Sense Desktop is used) or not * (returns false if Qlik Sense Desktop is not used). - * @param {Function} [callback] - Optional. Callback method. - * @return {Promise} - A promise of a Qlik engine reply. + * @param [callback] - Optional. Callback method. + * @return - A promise of a Qlik engine reply. */ isPersonalMode(callback?: any): ng.IPromise; } @@ -1742,7 +1743,8 @@ declare namespace NavigationAPI { errorMsg: string; } - /** Navigation API for Qlik Sense. The Navigation API allows you to navigate + /** + * Navigation API for Qlik Sense. The Navigation API allows you to navigate * within a Qlik Sense app, and is meant to be used in visualization extensions * and will not work in Mashup scenarios. */ @@ -1759,37 +1761,37 @@ declare namespace NavigationAPI { /** * Gets the current sheet ID. - * @return {NavigationResult} - A navigation result object. + * @return - A navigation result object. */ getCurrentSheetId(): NavigationResult; /** * Gets the current mode. - * @return {string} - The current mode as a string. + * @return - The current mode as a string. */ getMode(): string; /** * Navigate to a given sheet in the current app. * The method will return before the actual navigation takes place. - * @param {string} sheetId - Set the sheet ID to navigate to. - * @return {NavigationResult} - A navigation result object. + * @param sheetId - Set the sheet ID to navigate to. + * @return - A navigation result object. */ gotoSheet(sheetId: string): NavigationResult; /** * Navigate to a given story in the current app. * The method will return before the actual navigation takes place. - * @param {string} storyId - Set the story ID to navigate to. - * @return {NavigationResult} - A navigation result object. + * @param storyId - Set the story ID to navigate to. + * @return - A navigation result object. */ gotoStory(storyId: string): NavigationResult; /** * Checks if a given mode is allowed. - * @param {NavigationModeType} mode - Can be one of the strings: edit | analysis + * @param mode - Can be one of the strings: edit | analysis * or one of the constants: qlik.navigation.EDIT | qlik.navigation.ANALYSIS - * @return {boolean} - A Boolean value (true or false). + * @return - A Boolean value (true or false). */ isModeAllowed(mode: NavigationModeType): boolean; @@ -1797,7 +1799,7 @@ declare namespace NavigationAPI { * Go to the next sheet in the current app. * It will do nothing if you do not have sheets in the current context. * The method will return before the actual navigation takes place. - * @return {NavigationResult} - A navigation result object. + * @return - A navigation result object. */ nextSheet(): NavigationResult; @@ -1805,23 +1807,23 @@ declare namespace NavigationAPI { * Jumps to the previous sheet in the current app. * It will do nothing if you do not have sheets in the current context. * The method will return before the actual navigation takes place - * @return {NavigationResult} - A navigation result object. + * @return - A navigation result object. */ prevSheet(): NavigationResult; /** * Sets the current working mode of Qlik Sense. - * @param {string | constant} mode - Can be one of the strings: edit | analysis + * @param mode - Can be one of the strings: edit | analysis * or one of the constants: qlik.navigation.EDIT | qlik.navigation.ANALYSIS - * @return {NavigationResult} - A navigation result object. + * @return - A navigation result object. */ setMode(mode: string): NavigationResult; /** * Switches the working mode of Qlik Sense. - * @param {NavigationModeType} mode - Can be one of the strings: edit | analysis + * @param mode - Can be one of the strings: edit | analysis * or one of the constants: qlik.navigation.EDIT | qlik.navigation.ANALYSIS - * @return {NavigationResult} - A navigation result object. + * @return - A navigation result object. */ switchMode(mode: NavigationModeType): NavigationResult; } @@ -1916,20 +1918,20 @@ declare namespace SelectionStateAPI { /** * Cleara all selections in this state. - * @param {boolean} lockedAlso - Use to also clear locked fields. - * @return {Promise} - A promise of a Qlik engine reply. + * @param lockedAlso - Use to also clear locked fields. + * @return - A promise of a Qlik engine reply. */ clearAll(lockedAlso: boolean): ng.IPromise; /** * Locks all selections in this state. - * @return {Promise} - A promise of a Qlik engine reply. + * @return - A promise of a Qlik engine reply. */ lockAll(): ng.IPromise; /** * Unlocks all selections in this state. - * @return {Promise} - A promise of a Qlik engine reply. + * @return - A promise of a Qlik engine reply. */ unlockAll(): ng.IPromise; } @@ -1964,7 +1966,7 @@ declare namespace TableAPI { /** * Exports data of the underlying hypercube in OOXML or CSV format. - * @param {object} [options] - Optional. Properties: + * @param [options] - Optional. Properties: * Name | Type | Description * format | String | Data format. Can be one of: * # OOXML: open XML, default @@ -1976,14 +1978,14 @@ declare namespace TableAPI { * # A: all values * # P: possible values (default) * download | Boolean | Automatically start download of file (with window.open). - * @param {Function} [callback] - Optional. Callback function returning the link to the exported file. + * @param [callback] - Optional. Callback function returning the link to the exported file. */ exportData(options?: any, callback?: any): void; /** * Gets the column number for a given field name. - * @param {string} fld - Field name. - * @return {number} - Column number, starting with zero. Undefined if no column with that name exists. + * @param fld - Field name. + * @return - Column number, starting with zero. Undefined if no column with that name exists. */ getColByName(fld: string): number; @@ -2072,11 +2074,11 @@ declare namespace TableAPI { /** * Select a range in this measure. - * @param {number} min - Sets the minimum value of the range. - * @param {number} max - Sets the maximum value of the range. - * @param {boolean} [inclMin] - Optional. Set to true to include minimum value. - * @param {boolean} [inclMax] - Optional. Set to true to include maximum value. - * @return {Promise} - A promise. + * @param min - Sets the minimum value of the range. + * @param max - Sets the maximum value of the range. + * @param [inclMin] - Optional. Set to true to include minimum value. + * @param [inclMax] - Optional. Set to true to include maximum value. + * @return - A promise. */ selectRange(min: number, max: number, inclMin?: boolean, inclMax?: boolean): ng.IPromise; } @@ -2143,7 +2145,7 @@ declare namespace VariableAPI { interface IVariable { /** * Creates a variable. - * @param {string | object} qProp - Variable name or properties. Properties: + * @param qProp - Variable name or properties. Properties: * Name | Type | Description * qInfo.qId | String | Optional. Variable id. If the selected ID is already in use, a new ID is automatically set by the engine. * qName | String | Variable name. The name must be unique. @@ -2151,14 +2153,14 @@ declare namespace VariableAPI { * qDefinition | String | Optional. Variable definition. * qNumberPresentation | Object | Optional. Defines the format of the value. * qIncludeInBookmark | Boolean | Optional. Set to true to update the variable when applying a bookmark. The variable value will be persisted in the bookmark. - * @return {Promise} - Returns a promise of a variable model. + * @return - Returns a promise of a variable model. */ create(qProp: string | any): ng.IPromise; /** * Creates a session variable, that is a temporary variable which is not * persisted and needs to be recreated for each new session. - * @param {object} qProp - Variable properties: + * @param qProp - Variable properties: * Name | Type | Description * qInfo.qId | String | Optional. Variable id. * qName | String | Variable name. @@ -2166,53 +2168,53 @@ declare namespace VariableAPI { * qDefinition | String | Optional. Variable definition. * qNumberPresentation | Object | Optional. * qIncludeInBookmark | Boolean | Optional. Include in bookmark flag. - * @return {Promise} - A promise of a variable model. + * @return - A promise of a variable model. */ createSessionVariable(qProp: any): ng.IPromise; /** * Gets a variable by id. - * @param {string} qId - Variable id. - * @return {Promise} - A promise of a variable model. + * @param qId - Variable id. + * @return - A promise of a variable model. */ get(qId: string): ng.IPromise; /** * Gets a variable by name. - * @param {string} qName - Variable name. - * @return {Promise} - A promise of a variable model. + * @param qName - Variable name. + * @return - A promise of a variable model. */ getByName(qName: string): ng.IPromise; /** * Gets variable content. - * @param {string} name - Variable name. - * @param {Function} callback - Callback to receive the content. - * @return {Promise} - A promise of a Qlik engine reply. + * @param name - Variable name. + * @param callback - Callback to receive the content. + * @return - A promise of a Qlik engine reply. */ getContent(name: string, callback: any): ng.IPromise; /** * Sets the content of a variable. - * @param {string} name - Variable name. - * @param {string} content - Variable content. - * @return {Promise} - A promise of a Qlik engine reply. + * @param name - Variable name. + * @param content - Variable content. + * @return - A promise of a Qlik engine reply. */ setContent(name: string, content: string): ng.IPromise; /** * Sets a numeric value as a variable. - * @param {string} qName - Variable name. - * @param {Number} qVal - Variable value. - * @return {Promise} - A promise of a Qlik engine reply. + * @param qName - Variable name. + * @param qVal - Variable value. + * @return - A promise of a Qlik engine reply. */ setNumValue(qName: string, qVal: number): ng.IPromise; /** * Sets variable string value. - * @param {string} qName - Variable name. - * @param {string} qVal - Variable value. - * @return {Promise} - A promise of a Qlik engine reply. + * @param qName - Variable name. + * @param qVal - Variable value. + * @return - A promise of a Qlik engine reply. */ setStringValue(qName: string, qVal: string): ng.IPromise; } @@ -2226,7 +2228,7 @@ declare namespace VisualizationAPI { /** * Create a new visualization on the fly based on a session object * and will not be persisted in the app. - * @param {VisualizationType} type - Visualization type. Can be: + * @param type - Visualization type. Can be: * # barchart * # combochart * # gauge @@ -2238,22 +2240,22 @@ declare namespace VisualizationAPI { * # table * # treemap * # extension - * @param {array} [cols] - Optional. Column definitions, dimensions and measures. + * @param [cols] - Optional. Column definitions, dimensions and measures. * Each entry can be of the following structures: * # String * # NxDimension * # NxMeasure * If the NxDimension or the NxMeasure refer to a library dimension * or a library measure, you also need to add qType : "measure" or "dimension". - * @param {object} [options] - Optional. Options to set. - * @return {Promise} - A promise of a QVisualization. + * @param [options] - Optional. Options to set. + * @return - A promise of a QVisualization. */ create(type: VisualizationType, cols?: any[], options?: any): ng.IPromise; /** * Gets an existing visualization. - * @param {string} id - Id for an existing visualization. - * @return {Promise} - A promise of a QVisualization. + * @param id - Id for an existing visualization. + * @return - A promise of a QVisualization. */ get(id: string): ng.IPromise; } @@ -2267,7 +2269,7 @@ declare namespace VisualizationAPI { /** * Closes a visualization and releases the session object. - * @return {Promise} - A promise. + * @return - A promise. */ close(): ng.IPromise; @@ -2278,14 +2280,14 @@ declare namespace VisualizationAPI { /** * Sets options for a visualization. - * @param {object} options - Options to set (using applyPatches). + * @param options - Options to set (using applyPatches). */ setOptions(options?: any): void; /** * Shows the visualization in an HTML element. - * @param {Element | string} [element] - Optional. HTML element or HTML element ID. - * @param {object} [options] - Optional. + * @param [element] - Optional. HTML element or HTML element ID. + * @param [options] - Optional. * Name | Type | Description * noInteraction | Boolean | Set to true if you want to disable all interaction, including selections, in the visualization. * noSelections | Boolean | Set to true if you want to disable selections in the visualization.