Qlik Sense Engine (qix)
The JSON-RPC API over WebSocket API that enables you to interact with the Qlik Associative Engine for Qlik Sense applications.
Field
Clear()
const result = await field.clear()
Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "Clear"}
Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": true }}
Maintains the selections in the current field while clearing the selections in the other fields.
Parameters
- qSoftLockboolean
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.
Response
- qReturnboolean
Errors
arrayClearAllButThis(qSoftLock?)
const result = await field.clearAllButThis(true)
Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "ClearAllButThis", "params": { "qSoftLock": true }}
Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": true }}
GetAndMode()
const result = await field.getAndMode()
Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetAndMode"}
Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": true }}
Retrieves the number of distinct values in a field.
Response
- qReturninteger
Errors
arrayGetCardinal()
const result = await field.getCardinal()
Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetCardinal"}
Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": 123 }}
Gets the properties of a field.
Response
- qPropertiesobject
qProperties properties
- qOneAndOnlyOneboolean
This parameter is set to true, if the field has one and only one selection (not 0 and not more than 1). If this property is set to true, the field cannot be cleared anymore and no more selections can be performed in that field.
The property _OneAndOnlyOne_ can be set to true if one and only value has been selected in the field prior to setting the property.
-
Errors
arrayGetNxProperties()
const result = await field.getNxProperties()
Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "GetNxProperties"}
Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qProperties": { "qOneAndOnlyOne": true } }}
Lock()
const result = await field.lock()
Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "Lock"}
Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": true }}
Selects some values in a field, by entering the element numbers related to the values to select.
Parameters
- qValuesarray of integersRequired
Indexes (or element numbers) of the values to select.
- qToggleModebooleanRequired
Set to true to keep any selections present in the list object. If this parameter is set to false, selections made before accepting the list object search become alternative.
- qSoftLockboolean
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.
Response
- qReturnboolean
Errors
arrayLowLevelSelect(qValues, qToggleMode, qSoftLock?)
const result = await field.lowLevelSelect([ 123], true, true)
Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "LowLevelSelect", "params": { "qValues": [ 123 ], "qToggleMode": true, "qSoftLock": true }}
Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": true }}
Selects field values matching a search string.
Parameters
- qMatchstringRequired
String to search for. Can contain wild cards or numeric search criteria. The characters <>"~()='[] have pre-defined meanings when used at the start of the string. To use them, EnableSpecialCharacterEscapingInSearch needs to be enabled and the delimiter \ needs to precede the special character.
- qSoftLockboolean
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.
- qExcludedValuesModeinteger
Include excluded values in search.
Response
- qReturnboolean
Errors
arraySelect(qMatch, qSoftLock?, qExcludedValuesMode?)
const result = await field.select("value", true, 123)
Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "Select", "params": { "qMatch": "value", "qSoftLock": true, "qExcludedValuesMode": 123 }}
Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": true }}
Selects all values of a field. Excluded values are also selected.
Parameters
- qSoftLockboolean
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.
Response
- qReturnboolean
Errors
arraySelectAll(qSoftLock?)
const result = await field.selectAll(true)
Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "SelectAll", "params": { "qSoftLock": true }}
Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": true }}
Selects all alternatives values in a specific field.
Parameters
- qSoftLockboolean
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.
Response
- qReturnboolean
Errors
arraySelectAlternative(qSoftLock?)
const result = await field.selectAlternative(true)
Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "SelectAlternative", "params": { "qSoftLock": true }}
Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": true }}
Inverts the current selections.
Parameters
- qSoftLockboolean
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.
Response
- qReturnboolean
Errors
arraySelectExcluded(qSoftLock?)
const result = await field.selectExcluded(true)
Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "SelectExcluded", "params": { "qSoftLock": true }}
Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": true }}
Selects all possible values in a specific field.
Parameters
- qSoftLockboolean
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.
Response
- qReturnboolean
Errors
arraySelectPossible(qSoftLock?)
const result = await field.selectPossible(true)
Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "SelectPossible", "params": { "qSoftLock": true }}
Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": true }}
Selects some values in a field, by entering the values to select.
Parameters
- qFieldValuesarray of objectsRequired
List of the values to select.
qFieldValues properties
- qTextstring
Text related to the field value. This parameter is optional.
- qIsNumericboolean
Is set to true if the value is a numeric. This parameter is optional. Default is false.
- qNumbernumber
Numeric value of the field. This parameter is displayed if qIsNumeric is set to true. This parameter is optional.
-
- qToggleModeboolean
The default value is false.
- qSoftLockboolean
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.
Response
- qReturnboolean
Errors
arraySelectValues(qFieldValues, qToggleMode?, qSoftLock?)
const result = await field.selectValues([ { "qText": "value", "qIsNumeric": true, "qNumber": 123 }], true, true)
Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "SelectValues", "params": { "qFieldValues": [ { "qText": "value", "qIsNumeric": true, "qNumber": 123 } ], "qToggleMode": true, "qSoftLock": true }}
Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": true }}
Sets a field in the AND mode.
Parameters
- qAndModebooleanRequired
Specifies if the AND mode applies to the field. Set this parameter to true to enter the AND mode.
Response
objectErrors
arraySetAndMode(qAndMode)
const result = await field.setAndMode(true)
Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "SetAndMode", "params": { "qAndMode": true }}
Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}
Sets some properties to a field.
Parameters
- qPropertiesobjectRequired
Information about the properties of the field.
qProperties properties
- qOneAndOnlyOneboolean
This parameter is set to true, if the field has one and only one selection (not 0 and not more than 1). If this property is set to true, the field cannot be cleared anymore and no more selections can be performed in that field.
The property _OneAndOnlyOne_ can be set to true if one and only value has been selected in the field prior to setting the property.
-
Response
objectErrors
arraySetNxProperties(qProperties)
const result = await field.setNxProperties({ "qOneAndOnlyOne": true})
Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "SetNxProperties", "params": { "qProperties": { "qOneAndOnlyOne": true } }}
Response
{ "jsonrpc": "2.0", "id": 1, "result": {}}
Toggle selects field values matching a search string.
Parameters
- qMatchstringRequired
String to search for. Can contain wild cards or numeric search criteria.
- qSoftLockboolean
Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.
- qExcludedValuesModeinteger
Include excluded values in search.
Response
- qReturnboolean
Errors
arrayToggleSelect(qMatch, qSoftLock?, qExcludedValuesMode?)
const result = await field.toggleSelect("value", true, 123)
Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "ToggleSelect", "params": { "qMatch": "value", "qSoftLock": true, "qExcludedValuesMode": 123 }}
Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": true }}
Unlocks all selected values of a specific field if the target (or handle ) is a field.
Response
- qReturnboolean
Errors
arrayUnlock()
const result = await field.unlock()
Request
{ "jsonrpc": "2.0", "id": 1, "handle": 3, "method": "Unlock"}
Response
{ "jsonrpc": "2.0", "id": 1, "result": { "qReturn": true }}