Information noteSTABLE.
This API is reliable and breaking changes are unlikely.
This API is reliable and breaking changes are unlikely.
qlik.app.variable.create(qProp)
Creates a variable.
Information noteA new implementation of the create method was introduced in version 2.1. The legacy implementation of the method will continue to work but it is recommended to use the new implementation.
Version history
| Version state | Details |
|---|---|
| Introduced | 1.0 |
| Updated | 2.1 |
Parameters
qProp
Type: String | Object
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. |
| qComment | String |
Optional. Comment related to the variable. |
| 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. |
Returns
Returns a promise of a variable model.
Tip noteFor more information regarding a promise, see The Promise API.
Examples
Example: Current implementation - object
var app = qlik.openApp('c31e2aba-3b46-4b13-8b87-c5c2514dea1d', config);
app.variable.create({qName : 'myvar', qDefinition: 'Month'});| Name | Type | Description |
|---|---|---|
| Name | String |