createSessionVariable method
Information noteSTABLE.
This API is reliable and breaking changes are unlikely.
This API is reliable and breaking changes are unlikely.
qlik.app.variable.createSessionVariable(qProp)
Creates a session variable, that is a temporary variable which is not persisted and needs to be recreated for each new session.
Version history
Version state | Details |
---|---|
Introduced | 2.1 |
Parameters
qProp
Type: Object
Variable properties:
Name | Type | Description |
---|---|---|
qInfo.qId | String |
Optional. Variable id. |
qName | String | Variable name. |
qComment | String |
Optional. Comment. |
qDefinition | String |
Optional. Variable definition. |
qNumberPresentation | Object | Optional. |
qIncludeInBookmark | Boolean |
Optional. Include in bookmark flag. |
Returns
A promise of a variable model.
Tip noteFor more information regarding a promise, see The Promise API.
Example
var app = qlik.openApp('c31e2aba-3b46-4b13-8b87-c5c2514dea1d', config);
app.variable.createSessionVariable({qName : 'myvar', qDefinition: 'Month'});