Skip to content

GenericObject

QIX methods for version 12.251.0.

AbortListObjectSearch

Aborts the results of a search in a list object.
This method applies to list objects (objects with one dimension). After an abort on a list object search, the GetLayout Method does not return any more search results but it does return the values in the field.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the list object.
For example, /qListObjectDef .

No return values.

AcceptListObjectSearch

Accept the results of a search in a list object. The search results become selected in the field.
This method applies to list objects (objects with one dimension). The search results are displayed using the GetLayout Method.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the list object.
For example, /qListObjectDef .
qToggleMode boolean Yes 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.
qSoftLock boolean No Set to true to ignore locks; in that case, locked fields can be selected.
The default value is false.

No return values.

ApplyPatches

Applies a patch to the properties of an object. Allows an update to some of the properties.
It is possible to apply a patch to the properties of a generic object, that is not persistent. Such a patch is called a soft patch.
In that case, the result of the operation on the properties (add, remove or delete) is not shown when doing GetProperties , and only a GetLayout call shows the result of the operation.
Properties that are not persistent are called soft properties. Once the engine session is over, soft properties are cleared.
Soft properties apply only to generic objects.

Parameters:

Name Type Mandatory Description
qPatches NxPatch Yes Array of patches.
qSoftPatch boolean No If set to true, it means that the properties to be applied are not persistent. The patch is a soft patch.
The default value is false.

No return values.

Approve

Adds the generic object to the list of approved objects
This operation is possible only in Qlik Sense Enterprise.

Required permissions: approve

No parameters.

No return values.

BeginSelections

Begins the selection mode. The app enters the modal state. The specified object enters the selection mode and a modal window is opened. The selection mode can apply to only one object in an app at a time.
When a visualization is in selection mode, selections can be made in this visualization. The visualization is not sorted until the selection mode is ended. Once the selection mode is ended and if the selections are accepted, the visualization is sorted according to the sort criteria. For more information about:
- Ending the selection mode, see EndSelections Method.
- The sort criteria, see ListObjectDef or HyperCubeDef.

Parameters:

Name Type Mandatory Description
qPaths array Yes List of the paths to the definition of the objects to enter selection mode.
For example, /qListObjectDef .

No return values.

ClearSelections

Clears the selections in a dimension of a visualization.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the visualization.
For example, /qListObjectDef .
qColIndices array No Array of dimension numbers or indexes. The selections are cleared in the specified dimensions.
Dimension numbers/indexes start from 0.
If this parameter is not set, all dimensions are cleared.

No return values.

ClearSoftPatches

Clears the soft properties of a generic object.
For more information on how to add soft properties to a generic object, see ApplyPatches Method.

No parameters.

No return values.

CollapseLeft

Collapses the left dimensions of a pivot table. This method applies only to pivot tables that are not always fully expanded.
In the definition of the hypercube (in HyperCubeDef ), the parameter qAlwaysFullyExpanded must be set to false.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object to be collapsed.
For example, /qHyperCubeDef .
qRow integer Yes Row index in the data matrix.
Indexing starts from 0.
qCol integer Yes Column index. The index is based on the left dimension indexes.
Indexing starts from 0.
qAll boolean Yes If set to true, it collapses all cells.
Parameters qRow and qCol are not used if qAll is set to true, but they need to be set (for example to 0).

No return values.

CollapseTop

Collapses the top dimensions of a pivot table. This method applies only to pivot tables that are not always fully expanded.
In the definition of the hypercube (in HyperCubeDef ), the parameter qAlwaysFullyExpanded must be set to false.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object to be collapsed
For example, /qHyperCubeDef .
qRow integer Yes Row index. The index is based on the top dimension indexes.
Indexing starts from 0.
qCol integer Yes Column index in the data matrix.
Indexing starts from 0.
qAll boolean Yes If set to true, it collapses all cells.
Parameters qRow and qCol are not used if qAll is set to true, but they need to be set (for example to 0).

No return values.

CopyFrom

Copies the properties of a generic object and its children.
The source object is specified by the parameter qFromId and the destination object is referenced by its handle.
The identifier of the destination object is the same as before the copy takes place.

Required permissions: update

Parameters:

Name Type Mandatory Description
qFromId string Yes Identifier of the object to copy.

No return values.

CreateChild

Creates a generic object that is a child of another generic object.
It is possible to update the properties of the child's parent at the same time that the child is created. Both operations are performed by the same call. It is possible to create a child that is linked to another generic object. The two objects have the same properties.

Required permissions: update

Parameters:

Name Type Mandatory Description
qProp GenericObjectProperties Yes Information about the child.
It is possible to create a child that is linked to another object.
qPropForThis GenericObjectProperties No Identifier of the parent's object.
Should be set to update the properties of the parent's object at the same time the child is created.

Returns:

Name Type Description
qInfo NxInfo {"qId":"<identifier of the child>","qType":"<type of the child>"}
qReturn ObjectInterface { "qType": "GenericObject", "qHandle": <handle of the child> }

DestroyAllChildren

Removes all children and all children to the children on an object.

Required permissions: update

Parameters:

Name Type Mandatory Description
qPropForThis GenericObjectProperties No Identifier of the parent's object and property to update.
Should be set to update the properties of the parent's object at the same time the child is created.

No return values.

DestroyChild

Removes a child object.
It is possible to update the properties of the child's parent at the same time that the child is removed. Both operations are performed by the same call. Removing a linked object, invalidate the linking object.

The operation is successful if qSuccess is set to true.

Required permissions: update

Parameters:

Name Type Mandatory Description
qId string Yes Identifier of the child to remove.
qPropForThis GenericObjectProperties No Identifier of the parent's object and property to update.
Should be set to update the properties of the parent's object at the same time the child is created.

Returns:

Name Type Description
qSuccess boolean <true or false>

DrillUp

You can use the drillUp method with any object that contains a drill-down group as a dimension.
This method allows you to move between different levels of information (from a detailed level to a less detailed level of information). You can go back to previous visualizations up to the highest level of the hierarchy.
If you try to drill up more steps than there are available levels, the first level of the hierarchy is displayed.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object to be selected.
For example, /qHyperCubeDef .
qDimNo integer Yes Dimension number or index starting from 0.
The default value is 0.
qNbrSteps integer Yes Number of steps you want to drill up.
The default value is 0.

No return values.

EmbedSnapshotObject

Adds a snapshot to a generic object.
Only one snapshot can be embedded in a generic object. If you embed a snapshot in an object that already contains a snapshot, the new snapshot overwrites the previous one.

Required permissions: update

Parameters:

Name Type Mandatory Description
qId string Yes Identifier of the bookmark.

No return values.

EndSelections

Ends the selection mode on a visualization. The selections are accepted or aborted when exiting the selection mode, depending on the qAccept parameter value.

Parameters:

Name Type Mandatory Description
qAccept boolean Yes Set this parameter to true to accept the selections before exiting the selection mode.

No return values.

ExpandLeft

Expands the left dimensions of a pivot table. This method applies only to pivot tables that are not always fully expanded.
In the definition of the hypercube (in HyperCubeDef ), the parameter qAlwaysFullyExpanded must be set to false.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object to be expanded.
For example, /qHyperCubeDef .
qRow integer Yes Row index in the data matrix to expand.
Indexing starts from 0.
qCol integer Yes Column index. The index is based on the left dimension indexes.
Indexing starts from 0.
qAll boolean Yes If set to true, it expands all cells.
Parameters qRow and qCol are not used if qAll is set to true, but they need to be set (for example to 0).

No return values.

ExpandTop

Expands the top dimensions of a pivot table. This method applies only to pivot tables that are not always fully expanded.
In the definition of the hypercube (in HyperCubeDef ), the parameter qAlwaysFullyExpanded must be set to false.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object to be expanded.
For example, /qHyperCubeDef .
qRow integer Yes Row index. The index is based on the top dimension indexes.
Indexing starts from 0.
qCol integer Yes Column index in the data matrix.
Indexing starts from 0.
qAll boolean Yes If set to true, it expands all cells.
Parameters qRow and qCol are not used if qAll is set to true, but they need to be set (for example to 0).

No return values.

ExportData

Exports the data of any generic object to an Excel file or a open XML file. If the object contains excluded values, those excluded values are not exported.
This API has limited functionality and will not support CSV export from all types of objects. Consider using Excel export instead. Treemap and bar chart are not supported.

Parameters:

Name Type Mandatory Description
qFileType string Yes Type of the file to export.

One of:
- CSV_C or EXPORT_CSV_C
- CSV_T or EXPORT_CSV_T
- OOXML or EXPORT_OOXML
qPath string No Path to the definition of the object to be exported.
For example, /qHyperCubeDef .
This parameter is mandatory if the file type is CSV_C or CSV_T .
qFileName string No Name of the exported file after download from browser.
This parameter is optional and only used in Qlik Sense Desktop.
qExportState string No Defines the values to be exported.
The default value is A.

One of:
- P or EXPORT_POSSIBLE
- A or EXPORT_ALL

Returns:

Name Type Description
qUrl string <url of the exported file>
qWarnings array<integer> [1000] Maximum number of cells in exported file exceeded. Data has been truncated.

GetChild

Returns the type of the object and the corresponding handle.

Parameters:

Name Type Mandatory Description
qId string Yes Identifier of the object.

Returns:

Name Type Description
qReturn ObjectInterface { "qType": "GenericObject", "qHandle": <handle of the object> }

GetChildInfos

Returns the identifier and the type for each child in an app object. If the child contains extra properties in qInfos , these properties are returned.

Full dynamic properties are optional and are returned if they exist in the definition of the object.

No parameters.

Returns:

Name Type Description
qInfos array<NxInfo> [ { "qId": "<identifier of the child 1>", "qType": "<type of the child 1>"
}, { "qId": "<identifier of the child 2>", "qType": "<type of the child 2>", "<FullDynamicProperty>": "<value>" }
...
]

GetEffectiveProperties

Returns the identifier, the type and the properties of the object.
If the object contains some soft properties, the soft properties are returned.
If the object is linked to another object, the properties of the linking object are returned.
GetEffectiveProperties method
Returns the identifier, the type and the properties of the object.
If the object contains some soft properties, the soft properties are returned.
If the object is linked to another object, the properties of the linking object are returned.

No parameters.

Returns:

Name Type Description
qProp GenericObjectProperties Information about the generic object.

GetFullPropertyTree

Gets the properties of:
- A generic object.
- The children of the generic object.
- The bookmarks/embedded snapshots of the generic object.

No parameters.

Returns:

Name Type Description
qPropEntry GenericObjectEntry Information about the properties.

GetHyperCubeBinnedData

This method supports data binning.
When a generic object with two or three measures and one dimension contains a lot of data, groups of points (for example, cells) can be rendered instead of points.
A zone of interest can be refined (for zooming in) up to a maximum refinement level (set in the qQueryLevel parameter) or coarsened (for zoom out).
The grid of cells is adaptive (not static), meaning that it adapts to different length scales.
The GetHyperCubeBinnedData method gives information about the adaptive grid and the values of the generic object.
The number of points in a cell and the coordinates (expressed in the measure range) of each cell are returned.
Dimension values and measure values are rendered at point level (highest detailed level).
The generic object should contain two or three measures and one dimension. When the refinement is high, the first two measures are represented on the x-axis and on the y-axis, while the third measure is visualized as color or point size.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object.
For example, /qHyperCubeDef .
qPages NxPage Yes Array of pages to retrieve.
Since the generic object contains two measures and one dimension, qWidth should be set to 3.
If the value of a measure is Null, the value cannot be rendered. Therefore, the number of elements rendered in a page can be less than the number defined in the property qHeight .
qViewport NxViewPort Yes Defines the canvas and the zoom level.
This parameter is not yet used and is optional.
qDataRanges NxDataAreaPage Yes Range of the data to render.
This range applies to the measure values.
The lowest and highest values of a measure can be retrieved by using the GetLayout method (in /qHyperCube/qMeasureInfo ).
qMaxNbrCells integer Yes Maximum number of cells in the grid.
qQueryLevel integer Yes Level of details. The higher the level, the more detailed information you get (zoom-in).
When the number of points to render falls below a certain threshold, the values are no longer rendered as cells but as points.
The query level should be no greater than 20.
qBinningMethod integer Yes Selects the algorithm.
The default value is 0.
One of:
- 0: Adaptive grid
- 1: Hexagonal grid
- 2: Uniform grid

Returns:

Name Type Description
qDataPages array<NxDataPage> Information about the data set.
Depending on the refinement level, the information is about:
- The adaptive grid. Occurs when cells are rendered and not points.
or
- The dimension values and the measure values. Occurs when the level of detail is high (points are rendered).

GetHyperCubeContinuousData

Retrieves and packs compressed hypercube and axis data. It is possible to retrieve specific pages of data.
Binning is done on the time stamp data as well as the date. This means that you can zoom in to a level of granularity as low as seconds.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object.
For example, /qHyperCubeDef .
qOptions NxContinuousDataOptions Yes Defines the data to return.
qReverseSort boolean No If set to true the returned data pages are reverse sorted.
Optional.

Returns:

Name Type Description
qDataPages array<NxDataPage> Array of pages to retrieve.
The dimension values and the measure values.
qAxisData NxAxisData List of x-axis data including name, ticks and tags.
Only days are returned, not time.

GetHyperCubeData

Retrieves the calculated data for a chart, a table, or a scatter plot. It is possible to retrieve specific pages of data.
This method works for a hypercube in DATA_MODE_STRAIGHT.
A data set is returned.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object to be selected.
For example, /qHyperCubeDef .
qPages NxPage Yes Array of pages to retrieve.

Returns:

Name Type Description
qDataPages array<NxDataPage> A data set

GetHyperCubePivotData

Retrieves the values of a pivot table. It is possible to retrieve specific pages of data.
This method works for a hypercube in DATA_MODE_PIVOT.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object to be selected.
For example, /qHyperCubeDef .
qPages NxPage Yes Array of pages to retrieve.

Returns:

Name Type Description
qDataPages array<NxPivotPage> A data set.

GetHyperCubeReducedData

Reduces the data of a bar chart, a line chart or a scatter plot chart and retrieves them.
The reduction is dependent on the zoom factor (parameter qZoomFactor ) and on the reduction mode.
This method can be used to create mini charts.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object to be selected.
For example, /qHyperCubeDef .
qPages NxPage Yes Array of pages.
qZoomFactor integer Yes Defines the zoom factor.
If set to -1, the engine decides of the zoom factor.
- If the reduction mode is D1 or S , the zoom factor is 2ⁿ. If the zoom factor is 5, the data are reduced by a factor 32.
- If the reduction mode is C , the zoom factor defines the number of centroids.
qReductionMode string Yes Defines the reduction mode.

One of:
- N or DATA_REDUCTION_NONE
- D1 or DATA_REDUCTION_ONEDIM
- S or DATA_REDUCTION_SCATTERED
- C or DATA_REDUCTION_CLUSTERED
- ST or DATA_REDUCTION_STACKED

Returns:

Name Type Description
qDataPages array<NxDataPage> A data set.

GetHyperCubeStackData

Retrieves the values of a stacked pivot table. It is possible to retrieve specific pages of data.
This method works for a hypercube in DATA_MODE_PIVOT_STACK.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object to be selected.
For example, /qHyperCubeDef .
qPages NxPage Yes Array of pages to retrieve.
qMaxNbrCells integer No Maximum number of cells at outer level.
The default value is 10 000.

Returns:

Name Type Description
qDataPages array<NxStackPage> A data set.

GetHyperCubeTreeData

Stability Index: Experimental

Retrieves data for nodes in a tree structure. It is possible to retrieve specific pages of data.
This method works for a treedata object or a hypercube in DATA_MODE_TREE.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object to be selected.
qNodeOptions NxTreeDataOption No Specifies all the paging filters needed to define the tree to be fetched. If left out the complete tree is returned.

Returns:

Name Type Description
qNodes array<NxTreeNode> Represents the nodes and dimensions of the defined tree.

GetInfo

Returns the type and identifier of the object.

No parameters.

Returns:

Name Type Description
qInfo NxInfo {"qId":"<identifier>","qType":"<type>"}

GetLayout

Evaluates an object and displays its properties including the dynamic properties.
If the member delta is set to true in the request object, only the delta is evaluated. A GetLayout call on a generic object, returns up to one level down in the hierarchy.

No parameters.

Returns:

Name Type Description
qLayout GenericObjectLayout Information on the object.

GetLinkedObjects

Lists the linked objects to a generic object, a dimension or a measure.

No parameters.

Returns:

Name Type Description
qItems array<NxLinkedObjectInfo> List of the linked objects.

GetListObjectData

Retrieves the values of a list object.
A data set is returned.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object to be selected.
For example, /qListObjectDef .
qPages NxPage Yes Array of pages you are interested in.

Returns:

Name Type Description
qDataPages array<NxDataPage> A data set.

GetParent

Returns the type of the object and the corresponding handle to the parent object in the hiearchy.

No parameters.

Returns:

Name Type Description
qReturn ObjectInterface { "qType": "GenericObject", "qHandle": <handle of the object> }

GetProperties

Returns the identifier, the type and the properties of the object.
Because it is not mandatory to set all properties when you define an object, the GetProperties method may show properties that were not set. In that case, default values are given.
If the object contains some soft properties, the soft properties are not returned by the GetProperties method. Use the GetEffectiveProperties method instead.
If the object is linked to another object, the properties of the linking object are not returned by the GetProperties method. Use the GetEffectiveProperties method instead.
The properties depends on the generic object type, see GenericObjectLayout.
If the member delta is set to true in the request object, only the delta is retrieved.

No parameters.

Returns:

Name Type Description
qProp GenericObjectProperties Information about the generic object.

GetSnapshotObject

Returns the type of the object and the corresponding handle.

No parameters.

Returns:

Name Type Description
qReturn ObjectInterface { "qType": "GenericBookmark", "qHandle": <Handle of the snapshot> }

Lock

Locks the selected values of a generic object.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object.
For example, /qListObjectDef .
qColIndices array No Dimension numbers or dimension indexes where the lock should apply.
Dimension numbers/indexes start from 0.
If this parameter is not set, the selected values in all dimensions are locked.

No return values.

MultiRangeSelectHyperCubeValues

Makes multiple range selections in measures.
This method applies to hypercubes. For example, bar charts, tables and scatter plots.
The member Change returns the handles of the objects that are updated following the selections.
qSuccess is set to true if the selections are successful and is set to false in the following cases:
- The object contains some invalid fields (fields that are not in the data model).
- The selection applies to a locked field.
- A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object to be selected.
For example, /qHyperCubeDef .
qRanges NxMultiRangeSelectInfo Yes Ranges of selections.
qOrMode boolean No Applies to hypercubes with multiple measures.
If set to true, it means that at least one of the measures must be in the range of selections for the group of measures to be selected.
If set to false, it means that all measures must be in the range of selections for the group of measures to be selected.
The default value is false.
qDeselectOnlyOneSelected boolean No Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field.
The default value is false.

Returns:

Name Type Description
qSuccess boolean true/false

MultiRangeSelectTreeDataValues

Stability Index: Experimental

No details.

Parameters:

Name Type Mandatory Description
qPath string Yes No description.
qRanges NxTreeMultiRangeSelectInfo Yes No description.
qOrMode boolean No No description.
qDeselectOnlyOneSelected boolean No No description.

Returns:

Name Type Description
qSuccess boolean No description.

Publish

Publishes a generic object.
This operation is not applicable for Qlik Sense Desktop.

Required permissions: publish

No parameters.

No return values.

RangeSelectHyperCubeValues

Makes range selections in measures.
This method applies to hypercubes. For example, bar charts, tables and scatter plots.
The member Change returns the handles of the objects that are updated following the selections.
qSuccess is set to true if the selections are successful and is set to false in the following cases:
- The object contains some invalid fields (fields that are not in the data model).
- The selection applies to a locked field.
- A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object to be selected.
For example, /qHyperCubeDef .
qRanges NxRangeSelectInfo Yes Ranges of selections.
qColumnsToSelect array No Indicates which dimensions to select.
The dimensions numbering starts at 0 (first dimension is 0).
If the array is empty, all dimensions are selected.
qOrMode boolean No Applies to hypercubes with multiple measures.
If set to true, it means that at least one of the measures must be in the range of selections for the group of measures to be selected.
If set to false, it means that all measures must be in the range of selections for the group of measures to be selected.
The default value is false.
qDeselectOnlyOneSelected boolean No Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field.
The default value is false.

Returns:

Name Type Description
qSuccess boolean true/false

ResetMadeSelections

Resets all selections made in selection mode.

No parameters.

No return values.

SearchListObjectFor

Searches for a string in a list object.
This method applies to list objects (objects with one dimension). The search results can be displayed using the GetLayout Method.

The operation is successful if qSuccess is set to true.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the list object.
For example, /qListObjectDef .
qMatch string Yes Search string.
Wild card characters are allowed. The search is not case sensitive.
Examples:
- PU: retrieves only values that start with P and contain U
- P U S: retrieves values that start with P, U or S

Returns:

Name Type Description
qSuccess boolean true

SelectHyperCubeCells

Makes selections in multiple dimensions and measures.
This method applies to hypercubes, such as bar charts, tables and scatter plots.
The member Change returns the handles of the objects that are updated following the selections.
qSuccess is set to true if the selections are successful and is set to false in the following cases:
- The object contains some invalid fields (fields that are not in the data model).
- The selection applies to a locked field.
- A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object to be selected.
For example, /qHyperCubeDef .
qRowIndices array Yes Array of row indexes to select, starting from 0.
If the array is empty [ ] , all rows are selected.
qColIndices array Yes Indexes of the columns to select, starting from 0.
A column corresponds to a dimension in the order they are added to the hypercube.
If a column is hidden it is ignored, qColIndex n refers to the n:th visible column (starting from zero).
Example:
If the hypercube has two dimensions:
- [0] selects the first column (i.e the first dimension).
- [1] selects the second column (i.e the second dimension).

If the array is empty [ ] , all columns are selected.
qSoftLock boolean No Set to true to ignore locks; in that case, locked fields can be selected.
qDeselectOnlyOneSelected boolean No Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field.
The default value is false.

Returns:

Name Type Description
qSuccess boolean true/false

SelectHyperCubeContinuousRange

The following is returned in the output:
The operation is successful if qSuccess is set to true.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object.
For example, /qHyperCubeDef .
qRanges NxContinuousRangeSelectInfo Yes Selects ranges in a hypercube in (Ranges[N].Min,Ranges[N].Max) intervals.
If either Ranges[N].MinInclEq or Ranges[N].MaxInclEq, or both flags are set to true then Min and Max values will be selected.
qSoftLock boolean No Set to true to ignore locks; in that case, locked fields can be selected.
The default value is false.

Returns:

Name Type Description
qSuccess boolean <true or false>

SelectHyperCubeValues

Selects some values in one dimension.
The values are identified by their element numbers.
This method applies to charts, tables and scatter plots.
The member Change returns the handles of the objects that are updated following the selections.
qSuccess is set to true if the selections are successful and is set to false in the following cases:
- The object contains some invalid fields (fields that are not in the data model).
- The selection applies to a locked field.
- A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object to be selected.
For example, /qHyperCubeDef .
qDimNo integer Yes Dimension number or index to select.
Dimension numbers/index start from 0.
qValues array Yes Element numbers of the field to select.
You can select multiple elements; the separator is the comma.
qToggleMode boolean Yes Set to true to toggle.

Returns:

Name Type Description
qSuccess boolean true/false

SelectListObjectAll

Selects all values of a field.
This method applies to list objects (objects with one dimension).
The member Change returns the handles of the objects that are updated following the selections.
qSuccess is set to true if the selections are successful and is set to false in the following cases:
- The object contains some invalid fields (fields that are not in the data model).
- The selection applies to a locked field.
- A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object to be selected.
For example, /qListObjectDef .
qSoftLock boolean No Set to true to ignore locks; in that case, locked fields can be selected.
The default value is false.

Returns:

Name Type Description
qSuccess boolean true/false

SelectListObjectAlternative

Selects all alternative values in a specific field.
This method applies to list objects (objects with one dimension). If a field contains at least one selected value, the values that are neither selected nor excluded are alternatives values.
The member Change returns the handles of the objects that are updated following the selections.
qSuccess is set to true if the selections are successful and is set to false in the following cases:
- The object contains some invalid fields (fields that are not in the data model).
- The selection applies to a locked field.
- A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object to be selected.
For example, /qListObjectDef .
qSoftLock boolean No Set to true to ignore locks; in that case, locked fields can be selected.
The default value is false.

Returns:

Name Type Description
qSuccess boolean true/false

SelectListObjectContinuousRange

The following is returned in the output:
The operation is successful if qSuccess is set to true.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object.
For example, /qHyperCubeDef .
qRanges Range Yes Selects ranges in a hypercube in (Ranges[N].Min,Ranges[N].Max) intervals.
If either Ranges[N].MinInclEq or Ranges[N].MaxInclEq, or both flags are set to true then Min and Max values will be selected.
qSoftLock boolean No Set to true to ignore locks; in that case, locked fields can be selected.
The default value is false.

Returns:

Name Type Description
qSuccess boolean <true or false>

SelectListObjectExcluded

Inverts the current selections in a specific field.
This method applies to list objects (objects with one dimension).
The member Change returns the handles of the objects that are updated following the selections.
qSuccess is set to true if the selections are successful and is set to false in the following cases:
- The object contains some invalid fields (fields that are not in the data model).
- The selection applies to a locked field.
- A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object to be selected.
For example, /qListObjectDef .
qSoftLock boolean No Set to true to ignore locks; in that case, locked fields can be selected.
The default value is false.

Returns:

Name Type Description
qSuccess boolean true/false

SelectListObjectPossible

Selects all possible values of a list object.
This method applies to list objects (objects with one dimension).
The member Change returns the handles of the objects that are updated following the selections.
qSuccess is set to true if the selections are successful and is set to false in the following cases:
- The object contains invalid fields (fields that are not in the data model).
- The selection applies to a locked field.
- A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object to be selected.
For example, /qListObjectDef .
qSoftLock boolean No Set to true to ignore locks; in that case, locked fields can be selected.
The default value is false.

Returns:

Name Type Description
qSuccess boolean true/false

SelectListObjectValues

Makes single selections in dimensions.
This method applies to list objects only.
The member Change returns the handles of the objects that are updated following the selections.
qSuccess is set to true if the selections are successful and is set to false in the following cases:
- The object contains invalid fields (fields that are not in the data model).
- The selection applies to a locked field.
- A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object to be selected.
For example, /qListObjectDef .
qValues array Yes Element numbers to select.
You can select multiple values; the separator is the comma.
qToggleMode boolean Yes Set to true to toggle.
qSoftLock boolean No Set to true to ignore locks; in that case, locked fields can be selected.
The default value is false.

Returns:

Name Type Description
qSuccess boolean true/false

SelectPivotCells

This method only applies to hypercubes that are not represented as straight tables. The parameter qMode in HyperCubeDef must be set either to P  or K .

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object.
For example, /qHyperCubeDef .
qSelections NxSelectionCell Yes Information about the selections to perform.
qSoftLock boolean No Set to true to ignore locks; in that case, locked fields can be selected.
qDeselectOnlyOneSelected boolean No Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field.
The default value is false.

Returns:

Name Type Description
qSuccess boolean true/false

SetChildArrayOrder

Sets the order of the children in a generic object.
To change the order of the children in a generic object, the identifiers of all the children must be included in the list of the identifiers (in qIds ).

Required permissions: update

Parameters:

Name Type Mandatory Description
qIds array Yes List of the children identifiers.

No return values.

SetFullPropertyTree

Sets the properties of:
- A generic object.
- The children of the generic object.
- The bookmarks/embedded snapshots of the generic object.

If the SetFullPropertyTree method is asked to set some properties to a child that does not exist, it creates the child. The type of an object cannot be updated.

Required permissions: update

Parameters:

Name Type Mandatory Description
qPropEntry GenericObjectEntry Yes Information about the generic object entry.

No return values.

SetProperties

Sets some properties for a generic object.
The properties depends on the generic object type, see GenericObjectProperties.

Required permissions: update

Parameters:

Name Type Mandatory Description
qProp GenericObjectProperties Yes Information about the generic object.

No return values.

UnApprove

Removes the generic object from the list of approved objects
This operation is possible only in Qlik Sense Enterprise.

Required permissions: approve

No parameters.

No return values.

UnPublish

Unpublishes a generic object.
This operation is not applicable for Qlik Sense Desktop.

Required permissions: publish

No parameters.

No return values.

Unlock

Unlocks the selected values of a generic object if the target (or handle ) is a generic object

Parameters:

Name Type Mandatory Description
qPath string Yes Path to the definition of the object.
For example, /qListObjectDef .
qColIndices array No Dimension numbers/indexes where the unlock should apply.
Dimension numbers/indexes start from 0.
If this parameter is not set, the locked values in all dimensions are unlocked.

No return values.