Accept the results of a search in a list object. The search results become selected in the field.
Parameters:
path
- Path to the definition of the list object.
For example, /qListObjectDef .toggleMode
- 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.softLock
- Set to true to ignore locks; in that case, locked fields can be selected.
The default value is false.Stability: locked
You can use the AddGroupMembers method with any object that contains an object grouping definition. This method allows you to add one or more members to an existing group of objects directly.
Parameters:
path
- Path to the definition of the object to be selected.
For exampleb /qNxGroupDef .members
- Array of IDs for the objects and/or subgroups to add to the group.targetGroupId
- Name of the group the Members will be added to (if not the called object).posId
- Id of the member whose position to insert into.Stability: experimental
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. It should not be possible to patch "/qInfo/qId", and it will be forbidden in the near future.
Parameters:
patches
- Array of patches.softPatch
- 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.Stability: locked
Adds the generic object to the list of approved objects
Stability: locked
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:
A sheet contains a list object and a chart. If the list object is in selection mode then the chart cannot be in selection mode. No selection on the chart can be made until the list object exits the selection mode.
Parameters:
paths
- List of the paths to the definition of the objects to enter selection mode.
For example, /qListObjectDef .Stability: locked
Clears the selections in a dimension of a visualization.
Parameters:
path
- Path to the definition of the visualization.
For example, /qListObjectDef .colIndices
- 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.Stability: locked
Clears the soft properties of a generic object. For more information on how to add soft properties to a generic object, see ApplyPatches Method.
Stability: locked
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:
path
- Path to the definition of the object to be collapsed.
For example, /qHyperCubeDef .row
- Row index in the data matrix.
Indexing starts from 0.col
- Column index. The index is based on the left dimension indexes.
Indexing starts from 0.all
- 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).Stability: locked
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:
path
- Path to the definition of the object to be collapsed
For example, /qHyperCubeDef .row
- Row index. The index is based on the top dimension indexes.
Indexing starts from 0.col
- Column index in the data matrix.
Indexing starts from 0.all
- 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).Stability: locked
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.
Parameters:
fromId
- Identifier of the object to copy.Stability: locked
Creates a generic object that is a child of another generic object.
Parameters:
prop
- Information about the child.
It is possible to create a child that is linked to another object.propForThis
- 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.Stability: locked
You can use the CreateGroup method with any object that contains an object grouping definition. This method allows you to create a new subgroup of objects directly and add it to a group's members. Returns the ID of the created subgroup.
Parameters:
path
- Path to the definition of the object to be selected.
For example /qNxGroupDef .groupDef
- Definition of the new group.targetGroupId
- Id of the group to create the new subgroup in (if not the called object).Stability: experimental
Removes all children and all children to the children on an object.
Parameters:
propForThis
- 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.Stability: locked
Removes a child object.
Parameters:
id
- Identifier of the child to remove.propForThis
- 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.Stability: locked
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:
path
- Path to the definition of the object to be selected.
For example, /qHyperCubeDef .dimNo
- Dimension number or index starting from 0.
The default value is 0.nbrSteps
- Number of steps you want to drill up.
The default value is 0.Stability: locked
Adds a snapshot to a generic object.
Parameters:
id
- Identifier of the bookmark.Stability: locked
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:
accept
- Set this parameter to true to accept the selections before exiting the selection mode.Stability: locked
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:
path
- Path to the definition of the object to be expanded.
For example, /qHyperCubeDef .row
- Row index in the data matrix to expand.
Indexing starts from 0.col
- Column index. The index is based on the left dimension indexes.
Indexing starts from 0.all
- 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).Stability: locked
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:
path
- Path to the definition of the object to be expanded.
For example, /qHyperCubeDef .row
- Row index. The index is based on the top dimension indexes.
Indexing starts from 0.col
- Column index in the data matrix.
Indexing starts from 0.all
- 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).Stability: locked
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.
The default maximum number of rows and columns in the Excel export file is:
The default maximum number of columns in the export file is:
The default maximum number of cells in the export file is:
The exported file is truncated if the number of cells exceeds the limit. A warning message with code 1000 is sent.
If the exported file is larger than the maximum value, then an out-of-memory error with code 13000 is returned.
Parameters:
fileType
- Type of the file to export.One of:
path
- 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 .fileName
- Name of the exported file after download from browser.
This parameter is optional and only used in Qlik Sense Desktop.exportState
- Defines the values to be exported.
The default value is A.One of:
serveOnce
- If the exported file should be served only once
This parameter is optional and only used in Qlik Sense Enterprise (Windows)
Default value: falseStability: locked
Optional
genericReturns the type of the object and the corresponding handle.
Parameters:
id
- Identifier of the object.Stability: locked
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.
Stability: locked
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.
Stability: locked
Gets the properties of:
Stability: locked
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).
More details about the properties of the adaptive grid are given in this paragraph. When the refinement is not the highest (cells are rendered), information about the adaptive grid is returned through several arrays. The first array contains the following properties:
Name | Description | Type |
---|---|---|
qNum | Maximum number of points that a cell can contain. | String |
qElemNumber | Is set to 0. | Boolean |
qState | The default value is L. | One of:
|
The next arrays give the coordinates of each cell in the page. Each array contains the following properties:
Name | Description | Type |
---|---|---|
qText | Coordinates of a cell in the measure range. “qText”: “[[<left>, <top>, <right>, <bottom>], [<left>, <top>, <right>, <bottom>], .... [<left>, <top>, <right>, <bottom>]] Where: < left >, < top >, < right > and < bottom > are the coordinates of the cell in the measure range. |
String |
qNum | Number of points in the cell. | Double precision floating point |
qElemNumber | Unique identifier for each cell, calculated by the engine during the construction of the grid. This element number is not stored in the database and can have a positive or a negative value. |
Integer |
qState | The default value is L. | One of:
|
More details about the properties, when dimension and measure values are returned, are given in this paragraph. When the refinement is high, points are rendered (not cells) and dimension and measure values for each cell are returned. The first array is empty because no information on the adaptive grid is needed. The next arrays bring information about the dimension and the measure values.
Name | Description | Type |
---|---|---|
qText | Text value of the dimension or the measure. | String |
qNum | Numerical value of the dimension or the measure. Is set to 0 if the value is only text. |
Double precision floating point |
qElemNumber | Unique identifier for each cell, calculated by the engine during the construction of the grid. This element number is not stored in the database and can have a positive or a negative value. |
Integer |
qState | The default value is L. | One of:
|
Parameters:
path
- Path to the definition of the object.
For example, /qHyperCubeDef .pages
- 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 .viewport
- Defines the canvas and the zoom level.
This parameter is not yet used and is optional.dataRanges
- 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 ).maxNbrCells
- Maximum number of cells in the grid.queryLevel
- 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.binningMethod
- Selects the algorithm.
The default value is 0.
One of:Stability: locked
Retrieves and packs compressed hypercube and axis data. It is possible to retrieve specific pages of data.
Parameters:
path
- Path to the definition of the object.
For example, /qHyperCubeDef .options
- Defines the data to return.reverseSort
- If set to true the returned data pages are reverse sorted.
Optional.Stability: locked
Retrieves the calculated data for a chart, a table, or a scatter plot. It is possible to retrieve specific pages of data.
The maximum for the combined total number of cells across all pages is:
Parameters:
path
- Path to the definition of the object to be selected.
For example, /qHyperCubeDef .pages
- Array of pages to retrieve.Stability: locked
Retrieves the values of a pivot table. It is possible to retrieve specific pages of data.
Parameters:
path
- Path to the definition of the object to be selected.
For example, /qHyperCubeDef .pages
- Array of pages to retrieve.Stability: locked
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.
For the data reduction to happen, the following conditions must be fulfilled:
The reduction algorithm keeps the shape of the visualizations and works whatever the number of dimensions in the chart. The global profile of the chart is reduced, and not only a specific dimension. A visualization that has been reduced contains fewer values but its shape is the same. Data of all types can be reduced. Therefore it is hard to relate the values before and after a reduction especially when reducing string values.
If you have a chart with 1 million data, and you have set the zoom factor to 5, the GetHyperCubeReducedData method reduces the chart and retrieves 200 000 data.
The reduction mode must be set to C. This reduction mechanism follows the 2D K-Means algorithm. Data are reduced into a number of clusters. Each data is assigned to a specific centroid. The number of centroids can be defined in the parameter qZoomFactor.
The reduction mode must be set to S. The resolution is reduced according to the zoom factor (parameter qZoomFactor ).
If you have a scatter plot chart and the zoom factor is set to 2, the scatter plot chart resolution is reduced by 4.
Parameters:
path
- Path to the definition of the object to be selected.
For example, /qHyperCubeDef .pages
- Array of pages.zoomFactor
- Defines the zoom factor.
If set to -1, the engine decides of the zoom factor.reductionMode
- Defines the reduction mode.One of:
Stability: locked
Retrieves the values of a stacked pivot table. It is possible to retrieve specific pages of data.
Parameters:
path
- Path to the definition of the object to be selected.
For example, /qHyperCubeDef .pages
- Array of pages to retrieve.maxNbrCells
- Maximum number of cells at outer level.
The default value is 10 000.Stability: locked
Retrieves data for nodes in a tree structure. It is possible to retrieve specific pages of data.
Parameters:
path
- Path to the definition of the object to be selected.nodeOptions
- Specifies all the paging filters needed to define the tree to be fetched. If left out the complete tree is returned.Stability: stable
Returns the type and identifier of the object.
Stability: locked
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.
A is a generic object and is the parent of the objects B and C. B is the parent of the objects D and E. A GetLayout call on A returns information on the objects A, B and C. A GetLayout call on B returns information on the objects B, D and E. A GetLayout call on C returns information on the object C.
Stability: locked
Lists the linked objects to a generic object, a dimension or a measure.
Stability: locked
Retrieves the values of a list object. A data set is returned.
The maximum for the combined total number of cells across all pages is:
Parameters:
path
- Path to the definition of the object to be selected.
For example, /qListObjectDef .pages
- Array of pages you are interested in.Stability: locked
Returns the type of the object and the corresponding handle to the parent object in the hiearchy.
Stability: locked
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.
Stability: locked
Returns the type of the object and the corresponding handle.
Stability: locked
Locks the selected values of a generic object.
Parameters:
path
- Path to the definition of the object.
For example, /qListObjectDef .colIndices
- 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.Stability: locked
Makes multiple range selections in measures.
Parameters:
path
- Path to the definition of the object to be selected.
For example, /qHyperCubeDef .ranges
- Ranges of selections.orMode
- 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.deselectOnlyOneSelected
- 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.Stability: locked
Publishes a generic object.
Stability: locked
Makes range selections in measures.
Parameters:
path
- Path to the definition of the object to be selected.
For example, /qHyperCubeDef .ranges
- Ranges of selections.columnsToSelect
- Indicates which dimensions to select.
The dimensions numbering starts at 0 (first dimension is 0).
If the array is empty, all dimensions are selected.orMode
- 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.deselectOnlyOneSelected
- 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.Stability: locked
You can use the RemoveGroup method with any object that contains an object grouping definition. This method allows you to remove a group of objects directly. This action only removes the group, not any of its members.
Parameters:
path
- Path to the definition of the object to be selected.
For example /qNxGroupDef .groupId
- Name of the group to be removed.
May not be an empty string.Stability: experimental
You can use the RemoveGroupMembers method with any object that contains an object grouping definition. This method allows you to remove one or more members from an existing group of objects directly.
Parameters:
path
- Path to the definition of the object to be selected.
For example /qNxGroupDef .members
- Array of IDs for the objects and/or subgroups to remove from the group.targetGroupId
- Name of the group the Members will be removed from (if not the called object).Stability: experimental
Resets all selections made in selection mode.
Stability: locked
Searches for a string in a list object.
Parameters:
path
- Path to the definition of the list object.
For example, /qListObjectDef .match
- Search string.
Wild card characters are allowed. The search is not case sensitive.
Examples:P*U*
: retrieves only values that start with P and contain UP U S
: retrieves values that start with P, U or SStability: locked
Makes selections in multiple dimensions and measures.
Parameters:
path
- Path to the definition of the object to be selected.
For example, /qHyperCubeDef .rowIndices
- Array of row indexes to select, starting from 0.
If the array is empty [ ] , all rows are selected.colIndices
- 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:If the array is empty [ ] , all columns are selected.
softLock
- Set to true to ignore locks; in that case, locked fields can be selected.deselectOnlyOneSelected
- 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.Stability: locked
The following is returned in the output:
Parameters:
path
- Path to the definition of the object.
For example, /qHyperCubeDef .ranges
- 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.softLock
- Set to true to ignore locks; in that case, locked fields can be selected.
The default value is false.Stability: locked
Selects some values in one dimension. The values are identified by their element numbers.
Parameters:
path
- Path to the definition of the object to be selected.
For example, /qHyperCubeDef .dimNo
- Dimension number or index to select.
Dimension numbers/index start from 0.values
- Element numbers of the field to select.
You can select multiple elements; the separator is the comma.toggleMode
- Set to true to toggle.Stability: locked
Selects all values of a field.
Parameters:
path
- Path to the definition of the object to be selected.
For example, /qListObjectDef .softLock
- Set to true to ignore locks; in that case, locked fields can be selected.
The default value is false.Stability: locked
Selects all alternative values in a specific field.
Parameters:
path
- Path to the definition of the object to be selected.
For example, /qListObjectDef .softLock
- Set to true to ignore locks; in that case, locked fields can be selected.
The default value is false.Stability: locked
The following is returned in the output:
Parameters:
path
- Path to the definition of the object.
For example, /qHyperCubeDef .ranges
- 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.softLock
- Set to true to ignore locks; in that case, locked fields can be selected.
The default value is false.Stability: locked
Inverts the current selections in a specific field.
Parameters:
path
- Path to the definition of the object to be selected.
For example, /qListObjectDef .softLock
- Set to true to ignore locks; in that case, locked fields can be selected.
The default value is false.Stability: locked
Selects all possible values of a list object.
Parameters:
path
- Path to the definition of the object to be selected.
For example, /qListObjectDef .softLock
- Set to true to ignore locks; in that case, locked fields can be selected.
The default value is false.Stability: locked
Makes single selections in dimensions.
Parameters:
path
- Path to the definition of the object to be selected.
For example, /qListObjectDef .values
- Element numbers to select.
You can select multiple values; the separator is the comma.toggleMode
- Set to true to toggle.softLock
- Set to true to ignore locks; in that case, locked fields can be selected.
The default value is false.Stability: locked
Makes selections in the top or left dimension cells of a pivot table or in the data matrix. Only expanded dimensions can be selected.
Makes selections in the left dimension cells of a stacked table or in the data matrix.
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:
Parameters:
path
- Path to the definition of the object.
For example, /qHyperCubeDef .selections
- Information about the selections to perform.softLock
- Set to true to ignore locks; in that case, locked fields can be selected.deselectOnlyOneSelected
- 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.Stability: locked
You can use the SetActiveField method with any object that contains a cyclic group as a dimension. This method allows you to jump to a specific field in a cyclic dimension. If NewIndex is out-of-bounds of the dimension's fields then no action is taken. A hypercube will avoid field collisions with its other dimensions when setting the active field in this manner. If there are any collisions then no action is performed.
Parameters:
path
- Path to the definition of the object to be selected.
For example, /qHyperCubeDef .dimNo
- Dimension number or index starting from 0.
The default value is 0.newIndex
- Index of the field to jump to.Stability: experimental
Sets the order of the children in a generic object.
Parameters:
ids
- List of the children identifiers.Stability: locked
Sets the properties of:
Parameters:
propEntry
- Information about the generic object entry.Stability: locked
You can use the SetGroupLabel method with any object that contains an object grouping definition. This method allows you to change the label of an existing group of objects directly.
Parameters:
path
- Path to the definition of the object to be selected.
For example /qNxGroupDef .newLabel
- New label for the group.
A label starting with an '=' will be evaluated as an expression.targetGroupId
- Id of the group whose label will be set (if not the called object).Stability: experimental
Sets some properties for a generic object.
Parameters:
prop
- Information about the generic object.Stability: locked
You can use the StepCycle method with any object that contains a cyclic group as a dimension. This method allows you to move between different fields in a cyclic dimension. A hypercube will avoid field collisions with its other dimensions when cycling in this manner. If all other fields cause collisions then no cycling is performed.
Parameters:
path
- Path to the definition of the object to be selected.
For example, /qHyperCubeDef .dimNo
- Dimension number or index starting from 0.
The default value is 0.nbrSteps
- Number of steps you want to cycle.
Positive values cycle forwards while negative values cycle backwards. A value of 0 leads to no action being taken.Stability: experimental
Removes the generic object from the list of approved objects
Stability: locked
Unlocks the selected values of a generic object if the target (or handle ) is a generic object
Parameters:
path
- Path to the definition of the object.
For example, /qListObjectDef .colIndices
- 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.Stability: locked
Unpublishes a generic object.
Stability: locked
Aborts the results of a search in a list object.
Parameters:
path
- Path to the definition of the list object. For example, /qListObjectDef .Stability: locked