| SnapshotList Class |
Inheritance HierarchyQlik.EngineQixClassBase
Qlik.EngineGenericObject
Qlik.Sense.Client.SnapshotSnapshotList
Namespace: Qlik.Sense.Client.Snapshot
Assembly: Qlik.Sense.Client (in Qlik.Sense.Client.dll) Version: 1.1.0.0 (1.1.0.0)
SyntaxThe SnapshotList type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SnapshotList | Initializes a new instance of the SnapshotList class |
Methods| Name | Description | |
|---|---|---|
| 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. |
| AbortListObjectSearchAsync | 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. |
| 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. |
| AcceptListObjectSearchAsync | 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. |
| 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 session is over, soft properties are cleared. Soft properties apply only to generic objects.Applying a patch takes less time than resetting all the properties. |
| ApplyPatchesAsync | 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 session is over, soft properties are cleared. Soft properties apply only to generic objects.Applying a patch takes less time than resetting all the properties. |
| 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. Example: 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. |
| BeginSelectionsAsync | 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. Example: 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. |
| ClearSelections | Clears the selections in a dimension of a visualization. |
| ClearSelectionsAsync | Clears the selections in a dimension of a visualization. |
| 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. |
| ClearSoftPatchesAsync | Clears the soft properties of a generic object. For more information on how to add soft properties to a generic object, see ApplyPatches method. |
| 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. |
| CollapseLeftAsync | 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. |
| 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. |
| CollapseTopAsync | 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. |
| 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. |
| CopyFromAsync | 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. |
| CreateChildT |
Creation of child generic object
(Inherited from GenericObject.) |
| CreateChildAsyncT |
Async creation of child generic object
(Inherited from GenericObject.) |
| DefCount |
Retrieves the total number of HyperCube/ListObject definitions contained in this generic object
(Inherited from GenericObject.) |
| DefCountAsync |
Retrieves the total number of HyperCube/ListObject definitions contained in this generic object asyncronously
(Inherited from GenericObject.) |
| DefPathAtIndex(Int32) |
Converts an existing index to its equivalent path value
(Inherited from GenericObject.) |
| DefPathAtIndex(Int32) |
Converts existing index values to their equivalent path values
(Inherited from GenericObject.) |
| DefPathAtIndexAsync(Int32) |
Converts an existing index to its equivalent path value asyncronously
(Inherited from GenericObject.) |
| DefPathAtIndexAsync(Int32) |
Converts existing index values to their equivalent path values asyncronously
(Inherited from GenericObject.) |
| DestroyAllChildren | Removes all children and all children to the children on an object. |
| DestroyAllChildrenAsync | Removes all children and all children to the children on an object. |
| 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. |
| DestroyChildAsync(String, GenericObjectProperties, AsyncHandle) |
Async destruction of child.
(Inherited from GenericObject.) |
| DestroyChildAsyncT(String, GenericObjectProperties, FuncResponse, T, AsyncHandle) |
Async destruction of child.
(Inherited from GenericObject.) |
| Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from QixClassBase.) |
| 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. |
| DrillUpAsync | 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. |
| DuplicateAs |
DuplicateAs
(Inherited from GenericObject.) |
| DuplicateAsAsync |
DuplicateAs
(Inherited from GenericObject.) |
| 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. |
| EmbedSnapshotObjectAsync | 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. |
| 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. |
| EndSelectionsAsync | Ends the selection mode on a visualization. The selections are accepted or aborted when exiting the selection mode, depending on the qAccept parameter value. |
| 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. |
| ExpandLeftAsync | 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. |
| 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. |
| ExpandTopAsync | 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. |
| 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. |
| ExportDataAsync(NxExportFileType, String, String, NxExportState, AsyncHandle) | 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. |
| ExportDataAsyncT(NxExportFileType, String, String, NxExportState, FuncResponse, T, AsyncHandle) | 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. |
| GetChild | Returns the type of the object and the corresponding handle. |
| GetChildAsync(String, AsyncHandle) | Returns the type of the object and the corresponding handle. |
| GetChildAsyncT(String, FuncResponse, T, AsyncHandle) | Returns the type of the object and the corresponding handle. |
| 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. |
| GetChildInfosAsync(AsyncHandle) | 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. |
| GetChildInfosAsyncT(FuncResponse, T, AsyncHandle) | 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. |
| GetFullPropertyTree | Gets the properties of: * a generic object * the children of the generic object * the bookmarks/embedded snapshots of the generic object |
| GetFullPropertyTreeAsync(AsyncHandle) | Gets the properties of: * a generic object * the children of the generic object * the bookmarks/embedded snapshots of the generic object |
| GetFullPropertyTreeAsyncT(FuncResponse, T, AsyncHandle) | Gets the properties of: * a generic object * the children of the generic object * the bookmarks/embedded snapshots of the generic object |
| GetHyperCubeData | Retrieves the values of a chart, a table, or a scatter plot. It is possible to retrieve specific pages of data. This method does not apply to stacked tables. |
| GetHyperCubeDataAsync(String, IEnumerableNxPage, AsyncHandle) | Retrieves the values of a chart, a table, or a scatter plot. It is possible to retrieve specific pages of data. This method does not apply to stacked tables. |
| GetHyperCubeDataAsyncT(String, IEnumerableNxPage, FuncResponse, T, AsyncHandle) | Retrieves the values of a chart, a table, or a scatter plot. It is possible to retrieve specific pages of data. This method does not apply to stacked tables. |
| GetHyperCubePivotData | Retrieves the values of a pivot table. It is possible to retrieve specific pages of data. |
| GetHyperCubePivotDataAsync(String, IEnumerableNxPage, AsyncHandle) | Retrieves the values of a pivot table. It is possible to retrieve specific pages of data. |
| GetHyperCubePivotDataAsyncT(String, IEnumerableNxPage, FuncResponse, T, AsyncHandle) | Retrieves the values of a pivot table. It is possible to retrieve specific pages of data. |
| 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. ** Bar chart or line chart data reduction ** For the data reduction to happen, the following conditions must be fulfilled: * The values cannot fit in the defined page (parameter qPages). * The zoom factor is not 0 (parameter qZoomFactor). * The reduction mode must be set to D1. 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. Example: 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. ** Scatter plot chart data reduction ** 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. ** Scatter plot chart resolution reduction ** The reduction mode must be set to S. The resolution is reduced according to the zoom factor (parameter qZoomFactor). Example: If you have a scatter plot chart and the zoom factor is set to 2, the scatter plot chart resolution is reduced by 4. |
| GetHyperCubeReducedDataAsync(String, IEnumerableNxPage, Int32, NxDataReductionMode, AsyncHandle) | 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. ** Bar chart or line chart data reduction ** For the data reduction to happen, the following conditions must be fulfilled: * The values cannot fit in the defined page (parameter qPages). * The zoom factor is not 0 (parameter qZoomFactor). * The reduction mode must be set to D1. 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. Example: 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. ** Scatter plot chart data reduction ** 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. ** Scatter plot chart resolution reduction ** The reduction mode must be set to S. The resolution is reduced according to the zoom factor (parameter qZoomFactor). Example: If you have a scatter plot chart and the zoom factor is set to 2, the scatter plot chart resolution is reduced by 4. |
| GetHyperCubeReducedDataAsyncT(String, IEnumerableNxPage, Int32, NxDataReductionMode, FuncResponse, T, AsyncHandle) | 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. ** Bar chart or line chart data reduction ** For the data reduction to happen, the following conditions must be fulfilled: * The values cannot fit in the defined page (parameter qPages). * The zoom factor is not 0 (parameter qZoomFactor). * The reduction mode must be set to D1. 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. Example: 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. ** Scatter plot chart data reduction ** 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. ** Scatter plot chart resolution reduction ** The reduction mode must be set to S. The resolution is reduced according to the zoom factor (parameter qZoomFactor). Example: If you have a scatter plot chart and the zoom factor is set to 2, the scatter plot chart resolution is reduced by 4. |
| GetHyperCubeStackData | Retrieves the values of a stacked pivot table. It is possible to retrieve specific pages of data. |
| GetHyperCubeStackDataAsync(String, IEnumerableNxPage, Int32, AsyncHandle) | Retrieves the values of a stacked pivot table. It is possible to retrieve specific pages of data. |
| GetHyperCubeStackDataAsyncT(String, IEnumerableNxPage, Int32, FuncResponse, T, AsyncHandle) | Retrieves the values of a stacked pivot table. It is possible to retrieve specific pages of data. |
| GetInfo | Returns the type and identifier of the object. |
| GetInfoAsync(AsyncHandle) | Returns the type and identifier of the object. |
| GetInfoAsyncT(FuncResponse, T, AsyncHandle) | Returns the type and identifier of the object. |
| 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. |
| GetLayoutAsync(AsyncHandle) | 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. |
| GetLayoutAsyncT(FuncResponse, T, AsyncHandle) | (Inherited from GenericObject.) |
| GetLinkedObjects | Lists the linked objects to a generic object, a dimension or a measure. |
| GetLinkedObjectsAsync(AsyncHandle) | Lists the linked objects to a generic object, a dimension or a measure. |
| GetLinkedObjectsAsyncT(FuncResponse, T, AsyncHandle) | Lists the linked objects to a generic object, a dimension or a measure. |
| GetListObjectData | Retrieves the values of a list object. |
| GetListObjectDataAsync(String, IEnumerableNxPage, AsyncHandle) | Retrieves the values of a list object. |
| GetListObjectDataAsyncT(String, IEnumerableNxPage, FuncResponse, T, AsyncHandle) | Retrieves the values of a list object. |
| GetProperties | Returns the identifier and the type of the object. Because it is not mandatory to set all properties when you define an object, the method GetProperties may show properties that were not set. In that case, default values are given. If the member delta is set to true in the request object, only the delta is retrieved. |
| GetPropertiesAsync(AsyncHandle) | Returns the identifier and the type of the object. Because it is not mandatory to set all properties when you define an object, the method GetProperties may show properties that were not set. In that case, default values are given. If the member delta is set to true in the request object, only the delta is retrieved. |
| GetPropertiesAsyncT(FuncResponse, T, AsyncHandle) | (Inherited from GenericObject.) |
| GetSnapshotObject | Returns the type of the object and the corresponding handle. |
| GetSnapshotObjectAsync(AsyncHandle) | Returns the type of the object and the corresponding handle. |
| GetSnapshotObjectAsyncT(FuncResponse, T, AsyncHandle) | Returns the type of the object and the corresponding handle. |
| IndexOfDefPath(String) |
Converts an existing path to its equivalent index value
(Inherited from GenericObject.) |
| IndexOfDefPath(String) |
Converts existing paths to their equivalent index values
(Inherited from GenericObject.) |
| IndexOfDefPathAsync(String) |
Converts an existing path to its equivalent index value asyncronously
(Inherited from GenericObject.) |
| IndexOfDefPathAsync(String) |
Converts existing paths to their equivalent index values asyncronously
(Inherited from GenericObject.) |
| Link |
Link master object
(Inherited from GenericObject.) |
| LinkAsync |
Link master object
(Inherited from GenericObject.) |
| Lock | * Locks all selected values of a specific field if the target (or handle ) is a field * Locks selected values of a generic object if the target (or handle ) is a generic object |
| LockAsync | * Locks all selected values of a specific field if the target (or handle ) is a field * Locks selected values of a generic object if the target (or handle ) is a generic object |
| Publish | Publishes a generic object. This method applies only if running in server mode. |
| PublishAsync | Publishes a generic object. This method applies only if running in server mode. |
| RangeSelectHyperCubeValues | Make range selections in measures. This method applies to hypercubes. For example, bar charts, tables and scatter plots. |
| RangeSelectHyperCubeValuesAsync(String, IEnumerableNxRangeSelectInfo, IEnumerableInt32, Boolean, Boolean, AsyncHandle) | Make range selections in measures. This method applies to hypercubes. For example, bar charts, tables and scatter plots. |
| RangeSelectHyperCubeValuesAsyncT(String, IEnumerableNxRangeSelectInfo, IEnumerableInt32, Boolean, Boolean, FuncResponse, T, AsyncHandle) | Make range selections in measures. This method applies to hypercubes. For example, bar charts, tables and scatter plots. |
| ResetMadeSelections | Resets all selections made in selection mode. |
| ResetMadeSelectionsAsync | Resets all selections made in selection mode. |
| ResumeLayout | (Inherited from GenericObject.) |
| 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. |
| SearchListObjectForAsync(String, String, AsyncHandle) | 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. |
| SearchListObjectForAsyncT(String, String, FuncResponse, T, AsyncHandle) | 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. |
| SelectHyperCubeCells | Makes selections in multiple dimensions and measures. This method applies to hypercubes, such as bar charts, tables and scatter plots. |
| SelectHyperCubeCellsAsync(String, IEnumerableInt32, IEnumerableInt32, Boolean, Boolean, AsyncHandle) | Makes selections in multiple dimensions and measures. This method applies to hypercubes, such as bar charts, tables and scatter plots. |
| SelectHyperCubeCellsAsyncT(String, IEnumerableInt32, IEnumerableInt32, Boolean, Boolean, FuncResponse, T, AsyncHandle) | Makes selections in multiple dimensions and measures. This method applies to hypercubes, such as bar charts, tables and scatter plots. |
| SelectHyperCubeValues | Selects some values in one dimension. The values are identified by their element numbers. This method applies to charts, tables and scatter plots. |
| SelectHyperCubeValuesAsync(String, Int32, IEnumerableInt32, Boolean, AsyncHandle) | Selects some values in one dimension. The values are identified by their element numbers. This method applies to charts, tables and scatter plots. |
| SelectHyperCubeValuesAsyncT(String, Int32, IEnumerableInt32, Boolean, FuncResponse, T, AsyncHandle) | Selects some values in one dimension. The values are identified by their element numbers. This method applies to charts, tables and scatter plots. |
| SelectListObjectAll | Selects all values of a field. This method applies to list objects (objects with one dimension). |
| SelectListObjectAllAsync(String, Boolean, AsyncHandle) | Selects all values of a field. This method applies to list objects (objects with one dimension). |
| SelectListObjectAllAsyncT(String, Boolean, FuncResponse, T, AsyncHandle) | Selects all values of a field. This method applies to list objects (objects with one dimension). |
| 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. |
| SelectListObjectAlternativeAsync(String, Boolean, AsyncHandle) | 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. |
| SelectListObjectAlternativeAsyncT(String, Boolean, FuncResponse, T, AsyncHandle) | 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. |
| SelectListObjectExcluded | Inverts the current selections in a specific field. This method applies to list objects (objects with one dimension). |
| SelectListObjectExcludedAsync(String, Boolean, AsyncHandle) | Inverts the current selections in a specific field. This method applies to list objects (objects with one dimension). |
| SelectListObjectExcludedAsyncT(String, Boolean, FuncResponse, T, AsyncHandle) | Inverts the current selections in a specific field. This method applies to list objects (objects with one dimension). |
| SelectListObjectPossible | Selects all possible values of a list object. This method applies to list objects (objects with one dimension). |
| SelectListObjectPossibleAsync(String, Boolean, AsyncHandle) | Selects all possible values of a list object. This method applies to list objects (objects with one dimension). |
| SelectListObjectPossibleAsyncT(String, Boolean, FuncResponse, T, AsyncHandle) | Selects all possible values of a list object. This method applies to list objects (objects with one dimension). |
| SelectListObjectValues | Makes single selections in dimensions. This method applies to list objects only. |
| SelectListObjectValuesAsync(String, IEnumerableInt32, Boolean, Boolean, AsyncHandle) | Makes single selections in dimensions. This method applies to list objects only. |
| SelectListObjectValuesAsyncT(String, IEnumerableInt32, Boolean, Boolean, FuncResponse, T, AsyncHandle) | Makes single selections in dimensions. This method applies to list objects only. |
| 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. (Inherited from GenericObject.)** Pivot table ** Makes selections in the top or left dimension cells of a pivot table or in the data matrix. Only expanded dimensions can be selected. ** Stacked table ** Makes selections in the left dimension cells of a stacked table or in the data matrix. There is no top dimensions in a stacked table.** Example of a pivot table ** |
| SelectPivotCellsAsync(String, IEnumerableNxSelectionCell, Boolean, Boolean, AsyncHandle) | 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. (Inherited from GenericObject.)** Pivot table ** Makes selections in the top or left dimension cells of a pivot table or in the data matrix. Only expanded dimensions can be selected. ** Stacked table ** Makes selections in the left dimension cells of a stacked table or in the data matrix. There is no top dimensions in a stacked table.** Example of a pivot table ** |
| SelectPivotCellsAsyncT(String, IEnumerableNxSelectionCell, Boolean, Boolean, FuncResponse, T, AsyncHandle) | 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. (Inherited from GenericObject.)** Pivot table ** Makes selections in the top or left dimension cells of a pivot table or in the data matrix. Only expanded dimensions can be selected. ** Stacked table ** Makes selections in the left dimension cells of a stacked table or in the data matrix. There is no top dimensions in a stacked table.** Example of a pivot table ** |
| 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). |
| SetChildArrayOrderAsync | 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). |
| 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. |
| SetFullPropertyTreeAsync | 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. |
| SetProperties | Sets some properties for a generic object. |
| SetPropertiesAsync | Sets some properties for a generic object. |
| SuspendLayout | (Inherited from GenericObject.) |
| Unlink |
Unlink master object
(Inherited from GenericObject.) |
| UnlinkAsync |
Unlink master object
(Inherited from GenericObject.) |
| Unlock | * Unlocks all selected values of a specific field if the target (or handle ) is a field * Unlocks selected values of a generic object if the target (or handle ) is a generic object |
| UnlockAsync | * Unlocks all selected values of a specific field if the target (or handle ) is a field * Unlocks selected values of a generic object if the target (or handle ) is a generic object |
| UnPublish | Unpublishes a generic object. This method applies only if running in server mode. |
| UnPublishAsync | Unpublishes a generic object. This method applies only if running in server mode. |
Extension Methods| Name | Description | |
|---|---|---|
 | CreateListbox |
Create a Listbox
(Defined by ClientExtension.) |
| CreateListboxAsync |
Create a Listbox
(Defined by ClientExtension.) |
| SingleUrl | (Defined by UrlExtensions.) |
Properties| Name | Description | |
|---|---|---|
 | Error | (Inherited from GenericObject.) |
| ExtendsId | (Inherited from GenericObject.) |
| Handle |
The handle of the Qlik Sense entity.
(Inherited from QixClassBase.) |
| HasSoftPatches | (Inherited from GenericObject.) |
| Id |
The id of the Qlik Sense entity.
(Inherited from QixClassBase.) |
| Info | (Inherited from GenericObject.) |
| Items | |
| Meta | (Inherited from GenericObject.) |
| NxInfo | |
| NxLayoutErrors | |
| NxMeta | |
| NxSelectionInfo | |
| Properties | |
| SelectionInfo | (Inherited from GenericObject.) |
| Session |
The session this entity resides in.
(Inherited from QixClassBase.) |
| SuspendedLayout |
Indicated that the subscriptions are suspended
(Inherited from GenericObject.) |
| Type |
The type of the Qlik Sense entity.
(Inherited from QixClassBase.) |
Events| Name | Description | |
|---|---|---|
 | Changed |
This event fires every time the Qlik Sense entity needs to be updated due to changes in either selectionstate, data or entity properties
(Inherited from QixClassBase.) |
| Closed |
This event fires when the Qlik Sense entity has been removed or deleted.
(Inherited from QixClassBase.) |
See Also