Click or drag to resize
ICombochart Interface

Namespace: Qlik.Sense.Client.Visualizations
Assembly: Qlik.Sense.Client (in Qlik.Sense.Client.dll) Version: 2.1.0.0+Build:7.origin/release/ms13
Syntax
public interface ICombochart : IVisualizationBase, 
	IGenericObject, IQixClassBase, IDisposable, IChangeNotifier

The ICombochart type exposes the following members.

Methods
  NameDescription
Public methodAbortListObjectSearch

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.
(Inherited from IGenericObject.)
Public methodAbortListObjectSearchAsync(String)

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.
(Inherited from IGenericObject.)
Public methodAbortListObjectSearchAsync(AsyncHandle, String)

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.
(Inherited from IGenericObject.)
Public methodAcceptListObjectSearch

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.
(Inherited from IGenericObject.)
Public methodAcceptListObjectSearchAsync(String, Boolean, Boolean)

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.
(Inherited from IGenericObject.)
Public methodAcceptListObjectSearchAsync(AsyncHandle, String, Boolean, Boolean)

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.
(Inherited from IGenericObject.)
Public methodApplyPatches

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.
(Inherited from IGenericObject.)
Public methodApplyPatchesAsync(IEnumerableNxPatch, Boolean)

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.
(Inherited from IGenericObject.)
Public methodApplyPatchesAsync(AsyncHandle, IEnumerableNxPatch, Boolean)

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.
(Inherited from IGenericObject.)
Public methodBeginSelections
Public methodBeginSelections(IEnumerableString)

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.

(Inherited from IGenericObject.)
Public methodBeginSelectionsAsync
Public methodBeginSelectionsAsync(IEnumerableString)

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.

(Inherited from IGenericObject.)
Public methodBeginSelectionsAsync(AsyncHandle, IEnumerableString)

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.

(Inherited from IGenericObject.)
Public methodClearSelections(IEnumerableInt32)
Public methodClearSelections(String, IEnumerableInt32)

Clears the selections in a dimension of a visualization.

(Inherited from IGenericObject.)
Public methodClearSelectionsAsync(IEnumerableInt32)
Public methodClearSelectionsAsync(String, IEnumerableInt32)

Clears the selections in a dimension of a visualization.

(Inherited from IGenericObject.)
Public methodClearSelectionsAsync(AsyncHandle, String, IEnumerableInt32)

Clears the selections in a dimension of a visualization.

(Inherited from IGenericObject.)
Public methodClearSoftPatches

Clears the soft properties of a generic object.

For more information on how to add soft properties to a generic object, see ApplyPatches method.

(Inherited from IGenericObject.)
Public methodClearSoftPatchesAsync

Clears the soft properties of a generic object.

For more information on how to add soft properties to a generic object, see ApplyPatches method.

(Inherited from IGenericObject.)
Public methodClearSoftPatchesAsync(AsyncHandle)

Clears the soft properties of a generic object.

For more information on how to add soft properties to a generic object, see ApplyPatches method.

(Inherited from IGenericObject.)
Public methodCollapseLeft

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.

(Inherited from IGenericObject.)
Public methodCollapseLeftAsync(String, Int32, Int32, Boolean)

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.

(Inherited from IGenericObject.)
Public methodCollapseLeftAsync(AsyncHandle, String, Int32, Int32, Boolean)

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.

(Inherited from IGenericObject.)
Public methodCollapseTop

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.

(Inherited from IGenericObject.)
Public methodCollapseTopAsync(String, Int32, Int32, Boolean)

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.

(Inherited from IGenericObject.)
Public methodCollapseTopAsync(AsyncHandle, String, Int32, Int32, Boolean)

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.

(Inherited from IGenericObject.)
Public methodCopyFrom

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.
(Inherited from IGenericObject.)
Public methodCopyFromAsync(String)

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.
(Inherited from IGenericObject.)
Public methodCopyFromAsync(AsyncHandle, String)

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.
(Inherited from IGenericObject.)
Public methodCreateChildT
Creation of child generic object
(Inherited from IGenericObject.)
Public methodCreateChildAsyncT(GenericObjectProperties, GenericObjectProperties)
Creation of child generic object
(Inherited from IGenericObject.)
Public methodCreateChildAsyncT(AsyncHandle, FuncResponse, T, GenericObjectProperties, GenericObjectProperties)
Creation of child generic object
(Inherited from IGenericObject.)
Public methodDefCount
Retrieves the total number of HyperCube/ListObject definitions contained in this generic object
(Inherited from IGenericObject.)
Public methodDefCountAsync
Retrieves the total number of HyperCube/ListObject definitions contained in this generic object asynchronously
(Inherited from IGenericObject.)
Public methodDefPathAtIndex(Int32)
Converts an existing index to its equivalent path value
(Inherited from IGenericObject.)
Public methodDefPathAtIndex(Int32)
Converts existing index values to their equivalent path values
(Inherited from IGenericObject.)
Public methodDefPathAtIndexAsync(Int32)
Converts an existing index to its equivalent path value asynchronously
(Inherited from IGenericObject.)
Public methodDefPathAtIndexAsync(Int32)
Converts existing index values to their equivalent path values asynchronously
(Inherited from IGenericObject.)
Public methodDestroyAllChildren

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

(Inherited from IGenericObject.)
Public methodDestroyAllChildrenAsync(GenericObjectProperties)

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

(Inherited from IGenericObject.)
Public methodDestroyAllChildrenAsync(AsyncHandle, GenericObjectProperties)

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

(Inherited from IGenericObject.)
Public methodDestroyChild

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.
(Inherited from IGenericObject.)
Public methodDestroyChildAsync(String, GenericObjectProperties)

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.
(Inherited from IGenericObject.)
Public methodDestroyChildAsync(AsyncHandle, String, GenericObjectProperties)

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.
(Inherited from IGenericObject.)
Public methodDestroyChildAsyncT(AsyncHandle, FuncResponse, T, String, GenericObjectProperties)

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.
(Inherited from IGenericObject.)
Public methodDrillUp(Int32, Int32)
Public methodDrillUp(String, Int32, Int32)

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.

(Inherited from IGenericObject.)
Public methodDrillUpAsync(Int32, Int32)
Public methodDrillUpAsync(String, Int32, Int32)

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.

(Inherited from IGenericObject.)
Public methodDrillUpAsync(AsyncHandle, String, Int32, Int32)

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.

(Inherited from IGenericObject.)
Public methodEmbedSnapshotObject

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.
(Inherited from IGenericObject.)
Public methodEmbedSnapshotObjectAsync(String)

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.
(Inherited from IGenericObject.)
Public methodEmbedSnapshotObjectAsync(AsyncHandle, String)

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.
(Inherited from IGenericObject.)
Public methodEndSelections

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

(Inherited from IGenericObject.)
Public methodEndSelectionsAsync(Boolean)

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

(Inherited from IGenericObject.)
Public methodEndSelectionsAsync(AsyncHandle, Boolean)

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

(Inherited from IGenericObject.)
Public methodExpandLeft

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.

(Inherited from IGenericObject.)
Public methodExpandLeftAsync(String, Int32, Int32, Boolean)

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.

(Inherited from IGenericObject.)
Public methodExpandLeftAsync(AsyncHandle, String, Int32, Int32, Boolean)

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.

(Inherited from IGenericObject.)
Public methodExpandTop

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.

(Inherited from IGenericObject.)
Public methodExpandTopAsync(String, Int32, Int32, Boolean)

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.

(Inherited from IGenericObject.)
Public methodExpandTopAsync(AsyncHandle, String, Int32, Int32, Boolean)

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.

(Inherited from IGenericObject.)
Public methodExportData

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.

(Inherited from IGenericObject.)
Public methodExportDataAsync(NxExportFileType, String, String, NxExportState)

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.

(Inherited from IGenericObject.)
Public methodExportDataAsync(AsyncHandle, NxExportFileType, String, String, NxExportState)

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.

(Inherited from IGenericObject.)
Public methodExportDataAsyncT(AsyncHandle, FuncResponse, T, NxExportFileType, String, String, NxExportState)

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.

(Inherited from IGenericObject.)
Public methodGetAllHyperCubePagers
Get hypercube paging interfaces for all hypercubes in the object.
(Inherited from IGenericObject.)
Public methodGetAllListObjectPagers
Get list object paging interfaces for all list objects in the object.
(Inherited from IGenericObject.)
Public methodGetBinnedData
Public methodGetBinnedDataAsync
Public methodGetChild

Returns the type of the object and the corresponding handle.

(Inherited from IGenericObject.)
Public methodGetChildAsync(String)

Returns the type of the object and the corresponding handle.

(Inherited from IGenericObject.)
Public methodGetChildAsync(AsyncHandle, String)

Returns the type of the object and the corresponding handle.

(Inherited from IGenericObject.)
Public methodGetChildAsyncT(AsyncHandle, FuncResponse, T, String)

Returns the type of the object and the corresponding handle.

(Inherited from IGenericObject.)
Public methodGetChildInfos

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.

(Inherited from IGenericObject.)
Public methodGetChildInfosAsync

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.

(Inherited from IGenericObject.)
Public methodGetChildInfosAsync(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.

(Inherited from IGenericObject.)
Public methodGetChildInfosAsyncT(AsyncHandle, FuncResponse, T)

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.

(Inherited from IGenericObject.)
Public methodGetData
Public methodGetDataAsync
Public methodGetEffectiveProperties

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.

(Inherited from IGenericObject.)
Public methodGetEffectivePropertiesAsync

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.

(Inherited from IGenericObject.)
Public methodGetEffectivePropertiesAsync(AsyncHandle)

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.

(Inherited from IGenericObject.)
Public methodGetEffectivePropertiesAsyncT(AsyncHandle, FuncResponse, T)

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.

(Inherited from IGenericObject.)
Public methodGetFullPropertyTree

Gets the properties of:

* a generic object

* the children of the generic object

* the bookmarks/embedded snapshots of the generic object

(Inherited from IGenericObject.)
Public methodGetFullPropertyTreeAsync

Gets the properties of:

* a generic object

* the children of the generic object

* the bookmarks/embedded snapshots of the generic object

(Inherited from IGenericObject.)
Public methodGetFullPropertyTreeAsync(AsyncHandle)

Gets the properties of:

* a generic object

* the children of the generic object

* the bookmarks/embedded snapshots of the generic object

(Inherited from IGenericObject.)
Public methodGetFullPropertyTreeAsyncT(AsyncHandle, FuncResponse, T)

Gets the properties of:

* a generic object

* the children of the generic object

* the bookmarks/embedded snapshots of the generic object

(Inherited from IGenericObject.)
Public methodGetHyperCubeBinnedData

This method supports data binning.

When a generic object with two measures and one dimension contains a lot of data, groups of points (i.e 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 GetHyperCubeBinnedDatamethod gives information about the adaptive grid and the values of the generic object.

The generic object should contain two measures and one dimension.

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).

(Inherited from IGenericObject.)
Public methodGetHyperCubeBinnedDataAsync(String, IEnumerableNxPage, NxViewPort, IEnumerableNxDataAreaPage, Int32, Int32, Int32)

This method supports data binning.

When a generic object with two measures and one dimension contains a lot of data, groups of points (i.e 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 GetHyperCubeBinnedDatamethod gives information about the adaptive grid and the values of the generic object.

The generic object should contain two measures and one dimension.

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).

(Inherited from IGenericObject.)
Public methodGetHyperCubeBinnedDataAsync(AsyncHandle, String, IEnumerableNxPage, NxViewPort, IEnumerableNxDataAreaPage, Int32, Int32, Int32)

This method supports data binning.

When a generic object with two measures and one dimension contains a lot of data, groups of points (i.e 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 GetHyperCubeBinnedDatamethod gives information about the adaptive grid and the values of the generic object.

The generic object should contain two measures and one dimension.

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).

(Inherited from IGenericObject.)
Public methodGetHyperCubeBinnedDataAsyncT(AsyncHandle, FuncResponse, T, String, IEnumerableNxPage, NxViewPort, IEnumerableNxDataAreaPage, Int32, Int32, Int32)

This method supports data binning.

When a generic object with two measures and one dimension contains a lot of data, groups of points (i.e 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 GetHyperCubeBinnedDatamethod gives information about the adaptive grid and the values of the generic object.

The generic object should contain two measures and one dimension.

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).

(Inherited from IGenericObject.)
Public methodGetHyperCubeData

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.
(Inherited from IGenericObject.)
Public methodGetHyperCubeDataAsync(String, IEnumerableNxPage)

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.
(Inherited from IGenericObject.)
Public methodGetHyperCubeDataAsync(AsyncHandle, String, IEnumerableNxPage)

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.
(Inherited from IGenericObject.)
Public methodGetHyperCubeDataAsyncT(AsyncHandle, FuncResponse, T, String, IEnumerableNxPage)

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.
(Inherited from IGenericObject.)
Public methodGetHyperCubePager
Get a hypercube paging interface for a hypercube at the specified path.
(Inherited from IGenericObject.)
Public methodGetHyperCubePivotData

Retrieves the values of a pivot table. It is possible to retrieve specific pages of data.

(Inherited from IGenericObject.)
Public methodGetHyperCubePivotDataAsync(String, IEnumerableNxPage)

Retrieves the values of a pivot table. It is possible to retrieve specific pages of data.

(Inherited from IGenericObject.)
Public methodGetHyperCubePivotDataAsync(AsyncHandle, String, IEnumerableNxPage)

Retrieves the values of a pivot table. It is possible to retrieve specific pages of data.

(Inherited from IGenericObject.)
Public methodGetHyperCubePivotDataAsyncT(AsyncHandle, FuncResponse, T, String, IEnumerableNxPage)

Retrieves the values of a pivot table. It is possible to retrieve specific pages of data.

(Inherited from IGenericObject.)
Public methodGetHyperCubeReducedData

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.

** 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.

(Inherited from IGenericObject.)
Public methodGetHyperCubeReducedDataAsync(String, IEnumerableNxPage, Int32, NxDataReductionMode)

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.

** 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.

(Inherited from IGenericObject.)
Public methodGetHyperCubeReducedDataAsync(AsyncHandle, String, IEnumerableNxPage, Int32, NxDataReductionMode)

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.

** 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.

(Inherited from IGenericObject.)
Public methodGetHyperCubeReducedDataAsyncT(AsyncHandle, FuncResponse, T, String, IEnumerableNxPage, Int32, NxDataReductionMode)

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.

** 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.

(Inherited from IGenericObject.)
Public methodGetHyperCubeStackData

Retrieves the values of a stacked pivot table. It is possible to retrieve specific pages of data.

(Inherited from IGenericObject.)
Public methodGetHyperCubeStackDataAsync(String, IEnumerableNxPage, Int32)

Retrieves the values of a stacked pivot table. It is possible to retrieve specific pages of data.

(Inherited from IGenericObject.)
Public methodGetHyperCubeStackDataAsync(AsyncHandle, String, IEnumerableNxPage, Int32)

Retrieves the values of a stacked pivot table. It is possible to retrieve specific pages of data.

(Inherited from IGenericObject.)
Public methodGetHyperCubeStackDataAsyncT(AsyncHandle, FuncResponse, T, String, IEnumerableNxPage, Int32)

Retrieves the values of a stacked pivot table. It is possible to retrieve specific pages of data.

(Inherited from IGenericObject.)
Public methodGetInfo

Returns the type and identifier of the object.

(Inherited from IGenericObject.)
Public methodGetInfoAsync

Returns the type and identifier of the object.

(Inherited from IGenericObject.)
Public methodGetInfoAsync(AsyncHandle)

Returns the type and identifier of the object.

(Inherited from IGenericObject.)
Public methodGetInfoAsyncT(AsyncHandle, FuncResponse, T)

Returns the type and identifier of the object.

(Inherited from IGenericObject.)
Public methodGetLayout

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.

(Inherited from IGenericObject.)
Public methodGetLayoutAsync

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.

(Inherited from IGenericObject.)
Public methodGetLayoutAsync(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.

(Inherited from IGenericObject.)
Public methodGetLayoutAsyncT(AsyncHandle, FuncResponse, T)

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.

(Inherited from IGenericObject.)
Public methodGetLinkedObjects

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

(Inherited from IGenericObject.)
Public methodGetLinkedObjectsAsync

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

(Inherited from IGenericObject.)
Public methodGetLinkedObjectsAsync(AsyncHandle)

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

(Inherited from IGenericObject.)
Public methodGetLinkedObjectsAsyncT(AsyncHandle, FuncResponse, T)

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

(Inherited from IGenericObject.)
Public methodGetListObjectData

Retrieves the values of a list object.

(Inherited from IGenericObject.)
Public methodGetListObjectDataAsync(String, IEnumerableNxPage)

Retrieves the values of a list object.

(Inherited from IGenericObject.)
Public methodGetListObjectDataAsync(AsyncHandle, String, IEnumerableNxPage)

Retrieves the values of a list object.

(Inherited from IGenericObject.)
Public methodGetListObjectDataAsyncT(AsyncHandle, FuncResponse, T, String, IEnumerableNxPage)

Retrieves the values of a list object.

(Inherited from IGenericObject.)
Public methodGetListObjectPager
Get a list object paging interface for a list box at the specified path.
(Inherited from IGenericObject.)
Public methodGetPivotData
Public methodGetPivotDataAsync
Public methodGetProperties

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 method GetProperties 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.

If the member delta is set to true in the request object, only the delta is retrieved.
(Inherited from IGenericObject.)
Public methodGetPropertiesAsync

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 method GetProperties 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.

If the member delta is set to true in the request object, only the delta is retrieved.
(Inherited from IGenericObject.)
Public methodGetPropertiesAsync(AsyncHandle)

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 method GetProperties 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.

If the member delta is set to true in the request object, only the delta is retrieved.
(Inherited from IGenericObject.)
Public methodGetPropertiesAsyncT(AsyncHandle, FuncResponse, T)

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 method GetProperties 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.

If the member delta is set to true in the request object, only the delta is retrieved.
(Inherited from IGenericObject.)
Public methodGetReducedData
Public methodGetReducedDataAsync
Public methodGetSnapshotObject

Returns the type of the object and the corresponding handle.

(Inherited from IGenericObject.)
Public methodGetSnapshotObjectAsync

Returns the type of the object and the corresponding handle.

(Inherited from IGenericObject.)
Public methodGetSnapshotObjectAsync(AsyncHandle)

Returns the type of the object and the corresponding handle.

(Inherited from IGenericObject.)
Public methodGetSnapshotObjectAsyncT(AsyncHandle, FuncResponse, T)

Returns the type of the object and the corresponding handle.

(Inherited from IGenericObject.)
Public methodGetStackData
Public methodGetStackDataAsync
Public methodIndexOfDefPath(String)
Converts an existing path to its equivalent index value
(Inherited from IGenericObject.)
Public methodIndexOfDefPath(String)
Converts existing paths to their equivalent index values
(Inherited from IGenericObject.)
Public methodIndexOfDefPathAsync(String)
Converts an existing path to its equivalent index value asynchronously
(Inherited from IGenericObject.)
Public methodIndexOfDefPathAsync(String)
Converts existing paths to their equivalent index values asynchronously
(Inherited from IGenericObject.)
Public methodLock(IEnumerableInt32)
Public methodLock(String, IEnumerableInt32)

Locks the selected values of a generic object.

(Inherited from IGenericObject.)
Public methodLockAsync(IEnumerableInt32)
Public methodLockAsync(String, IEnumerableInt32)

Locks the selected values of a generic object.

(Inherited from IGenericObject.)
Public methodLockAsync(AsyncHandle, String, IEnumerableInt32)

Locks the selected values of a generic object.

(Inherited from IGenericObject.)
Public methodPublish

Publishes a generic object.

This method applies only if running in server mode.
(Inherited from IGenericObject.)
Public methodPublishAsync

Publishes a generic object.

This method applies only if running in server mode.
(Inherited from IGenericObject.)
Public methodPublishAsync(AsyncHandle)

Publishes a generic object.

This method applies only if running in server mode.
(Inherited from IGenericObject.)
Public methodRangeSelectHyperCubeValues

Make range selections in measures.

This method applies to hypercubes. For example, bar charts, tables and scatter plots.
(Inherited from IGenericObject.)
Public methodRangeSelectHyperCubeValuesAsync(String, IEnumerableNxRangeSelectInfo, IEnumerableInt32, Boolean, Boolean)

Make range selections in measures.

This method applies to hypercubes. For example, bar charts, tables and scatter plots.
(Inherited from IGenericObject.)
Public methodRangeSelectHyperCubeValuesAsync(AsyncHandle, String, IEnumerableNxRangeSelectInfo, IEnumerableInt32, Boolean, Boolean)

Make range selections in measures.

This method applies to hypercubes. For example, bar charts, tables and scatter plots.
(Inherited from IGenericObject.)
Public methodRangeSelectHyperCubeValuesAsyncT(AsyncHandle, FuncResponse, T, String, IEnumerableNxRangeSelectInfo, IEnumerableInt32, Boolean, Boolean)

Make range selections in measures.

This method applies to hypercubes. For example, bar charts, tables and scatter plots.
(Inherited from IGenericObject.)
Public methodRangeSelectValues
Public methodRangeSelectValuesAsync
Public methodResetMadeSelections

Resets all selections made in selection mode.

(Inherited from IGenericObject.)
Public methodResetMadeSelectionsAsync

Resets all selections made in selection mode.

(Inherited from IGenericObject.)
Public methodResetMadeSelectionsAsync(AsyncHandle)

Resets all selections made in selection mode.

(Inherited from IGenericObject.)
Public methodResumeLayout
(Inherited from IGenericObject.)
Public methodSearchListObjectFor

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.
(Inherited from IGenericObject.)
Public methodSearchListObjectForAsync(String, String)

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.
(Inherited from IGenericObject.)
Public methodSearchListObjectForAsync(AsyncHandle, String, String)

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.
(Inherited from IGenericObject.)
Public methodSearchListObjectForAsyncT(AsyncHandle, FuncResponse, T, String, String)

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.
(Inherited from IGenericObject.)
Public methodSelectCells
Public methodSelectCellsAsync
Public methodSelectHyperCubeCells

Makes selections in multiple dimensions and measures.

This method applies to hypercubes, such as bar charts, tables and scatter plots.
(Inherited from IGenericObject.)
Public methodSelectHyperCubeCellsAsync(String, IEnumerableInt32, IEnumerableInt32, Boolean, Boolean)

Makes selections in multiple dimensions and measures.

This method applies to hypercubes, such as bar charts, tables and scatter plots.
(Inherited from IGenericObject.)
Public methodSelectHyperCubeCellsAsync(AsyncHandle, String, IEnumerableInt32, IEnumerableInt32, Boolean, Boolean)

Makes selections in multiple dimensions and measures.

This method applies to hypercubes, such as bar charts, tables and scatter plots.
(Inherited from IGenericObject.)
Public methodSelectHyperCubeCellsAsyncT(AsyncHandle, FuncResponse, T, String, IEnumerableInt32, IEnumerableInt32, Boolean, Boolean)

Makes selections in multiple dimensions and measures.

This method applies to hypercubes, such as bar charts, tables and scatter plots.
(Inherited from IGenericObject.)
Public methodSelectHyperCubeValues

Selects some values in one dimension.

The values are identified by their element numbers.

This method applies to charts, tables and scatter plots.
(Inherited from IGenericObject.)
Public methodSelectHyperCubeValuesAsync(String, Int32, IEnumerableInt32, Boolean)

Selects some values in one dimension.

The values are identified by their element numbers.

This method applies to charts, tables and scatter plots.
(Inherited from IGenericObject.)
Public methodSelectHyperCubeValuesAsync(AsyncHandle, String, Int32, IEnumerableInt32, Boolean)

Selects some values in one dimension.

The values are identified by their element numbers.

This method applies to charts, tables and scatter plots.
(Inherited from IGenericObject.)
Public methodSelectHyperCubeValuesAsyncT(AsyncHandle, FuncResponse, T, String, Int32, IEnumerableInt32, Boolean)

Selects some values in one dimension.

The values are identified by their element numbers.

This method applies to charts, tables and scatter plots.
(Inherited from IGenericObject.)
Public methodSelectListObjectAll

Selects all values of a field.

This method applies to list objects (objects with one dimension).
(Inherited from IGenericObject.)
Public methodSelectListObjectAllAsync(String, Boolean)

Selects all values of a field.

This method applies to list objects (objects with one dimension).
(Inherited from IGenericObject.)
Public methodSelectListObjectAllAsync(AsyncHandle, String, Boolean)

Selects all values of a field.

This method applies to list objects (objects with one dimension).
(Inherited from IGenericObject.)
Public methodSelectListObjectAllAsyncT(AsyncHandle, FuncResponse, T, String, Boolean)

Selects all values of a field.

This method applies to list objects (objects with one dimension).
(Inherited from IGenericObject.)
Public methodSelectListObjectAlternative

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.
(Inherited from IGenericObject.)
Public methodSelectListObjectAlternativeAsync(String, Boolean)

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.
(Inherited from IGenericObject.)
Public methodSelectListObjectAlternativeAsync(AsyncHandle, String, Boolean)

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.
(Inherited from IGenericObject.)
Public methodSelectListObjectAlternativeAsyncT(AsyncHandle, FuncResponse, T, String, Boolean)

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.
(Inherited from IGenericObject.)
Public methodSelectListObjectExcluded

Inverts the current selections in a specific field.

This method applies to list objects (objects with one dimension).
(Inherited from IGenericObject.)
Public methodSelectListObjectExcludedAsync(String, Boolean)

Inverts the current selections in a specific field.

This method applies to list objects (objects with one dimension).
(Inherited from IGenericObject.)
Public methodSelectListObjectExcludedAsync(AsyncHandle, String, Boolean)

Inverts the current selections in a specific field.

This method applies to list objects (objects with one dimension).
(Inherited from IGenericObject.)
Public methodSelectListObjectExcludedAsyncT(AsyncHandle, FuncResponse, T, String, Boolean)

Inverts the current selections in a specific field.

This method applies to list objects (objects with one dimension).
(Inherited from IGenericObject.)
Public methodSelectListObjectPossible

Selects all possible values of a list object.

This method applies to list objects (objects with one dimension).
(Inherited from IGenericObject.)
Public methodSelectListObjectPossibleAsync(String, Boolean)

Selects all possible values of a list object.

This method applies to list objects (objects with one dimension).
(Inherited from IGenericObject.)
Public methodSelectListObjectPossibleAsync(AsyncHandle, String, Boolean)

Selects all possible values of a list object.

This method applies to list objects (objects with one dimension).
(Inherited from IGenericObject.)
Public methodSelectListObjectPossibleAsyncT(AsyncHandle, FuncResponse, T, String, Boolean)

Selects all possible values of a list object.

This method applies to list objects (objects with one dimension).
(Inherited from IGenericObject.)
Public methodSelectListObjectValues

Makes single selections in dimensions.

This method applies to list objects only.
(Inherited from IGenericObject.)
Public methodSelectListObjectValuesAsync(String, IEnumerableInt32, Boolean, Boolean)

Makes single selections in dimensions.

This method applies to list objects only.
(Inherited from IGenericObject.)
Public methodSelectListObjectValuesAsync(AsyncHandle, String, IEnumerableInt32, Boolean, Boolean)

Makes single selections in dimensions.

This method applies to list objects only.
(Inherited from IGenericObject.)
Public methodSelectListObjectValuesAsyncT(AsyncHandle, FuncResponse, T, String, IEnumerableInt32, Boolean, Boolean)

Makes single selections in dimensions.

This method applies to list objects only.
(Inherited from IGenericObject.)
Public methodSelectPivotCells
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.

** 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 **

In the representation above:

(Inherited from IGenericObject.)
Public methodSelectPivotCellsAsync(String, IEnumerableNxSelectionCell, Boolean, Boolean)
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.

** 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 **

In the representation above:

(Inherited from IGenericObject.)
Public methodSelectPivotCellsAsync(AsyncHandle, String, IEnumerableNxSelectionCell, Boolean, Boolean)
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.

** 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 **

In the representation above:

(Inherited from IGenericObject.)
Public methodSelectPivotCellsAsyncT(AsyncHandle, FuncResponse, T, String, IEnumerableNxSelectionCell, Boolean, Boolean)
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.

** 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 **

In the representation above:

(Inherited from IGenericObject.)
Public methodSelectValues
Public methodSetChildArrayOrder

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).
(Inherited from IGenericObject.)
Public methodSetChildArrayOrderAsync(IEnumerableString)

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).
(Inherited from IGenericObject.)
Public methodSetChildArrayOrderAsync(AsyncHandle, IEnumerableString)

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).
(Inherited from IGenericObject.)
Public methodSetFullPropertyTree

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.
(Inherited from IGenericObject.)
Public methodSetFullPropertyTreeAsync(GenericObjectEntry)

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.
(Inherited from IGenericObject.)
Public methodSetFullPropertyTreeAsync(AsyncHandle, GenericObjectEntry)

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.
(Inherited from IGenericObject.)
Public methodSetProperties

Sets some properties for a generic object.

(Inherited from IGenericObject.)
Public methodSetPropertiesAsync(GenericObjectProperties)

Sets some properties for a generic object.

(Inherited from IGenericObject.)
Public methodSetPropertiesAsync(AsyncHandle, GenericObjectProperties)

Sets some properties for a generic object.

(Inherited from IGenericObject.)
Public methodSuspendLayout
(Inherited from IGenericObject.)
Public methodUnlock(IEnumerableInt32)
Public methodUnlock(String, IEnumerableInt32)

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

(Inherited from IGenericObject.)
Public methodUnlockAsync(IEnumerableInt32)
Public methodUnlockAsync(String, IEnumerableInt32)

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

(Inherited from IGenericObject.)
Public methodUnlockAsync(AsyncHandle, String, IEnumerableInt32)

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

(Inherited from IGenericObject.)
Public methodUnPublish

Unpublishes a generic object.

This method applies only if running in server mode.
(Inherited from IGenericObject.)
Public methodUnPublishAsync

Unpublishes a generic object.

This method applies only if running in server mode.
(Inherited from IGenericObject.)
Public methodUnPublishAsync(AsyncHandle)

Unpublishes a generic object.

This method applies only if running in server mode.
(Inherited from IGenericObject.)
Top
Extension Methods
  NameDescription
Public Extension MethodSingleUrl (Defined by UrlExtensions.)
Top
Properties
  NameDescription
Public propertyBarGrouping
Reference to property Layout.BarGrouping
Public propertyColor
Reference to property Layout.Color
Public propertyConsiderDirty
Forces send of GetProperties and GetLayout calls to engine for this object even when the layout and properties are up to date.
(Inherited from IQixClassBase.)
Public propertyConsideredDirty
Forces send of GetProperties and GetLayout calls to engine for this object even when the layout and properties are up to date. Resume normal behavior when disposed.
(Inherited from IQixClassBase.)
Public propertyCustomErrorMessage
Reference to property Layout.HyperCube.CustomErrorMessage
Public propertyDataPages
Reference to property Layout.HyperCube.DataPages
Public propertyDataPoint
Reference to property Layout.DataPoint
Public propertyDimensionAxis
Reference to property Layout.DimensionAxis
Public propertyDimensionInfo
Reference to property Layout.HyperCube.DimensionInfo
Public propertyDynamicStructure
Reference to property Layout.LayoutExclude
Public propertyEffectiveInterColumnSortOrder
Reference to property Layout.HyperCube.EffectiveInterColumnSortOrder
Public propertyError
Reference to property Layout.Error
(Inherited from IGenericObject.)
Public propertyExtendsId
Reference to property Layout.ExtendsId
(Inherited from IGenericObject.)
Public propertyFootnote
Reference to property Layout.Footnote
(Inherited from IVisualizationBase.)
Public propertyGrandTotalRow
Reference to property Layout.HyperCube.GrandTotalRow
Public propertyHandle
The handle of the Qlik Sense entity.
(Inherited from IQixClassBase.)
Public propertyHasSoftPatches
Reference to property Layout.HasSoftPatches
(Inherited from IGenericObject.)
Public propertyHyperCubePager
DataPager for property Properties.HyperCubeDef
Public propertyId
The id of the Qlik Sense entity.
(Inherited from IQixClassBase.)
Public propertyIndentMode
Reference to property Layout.HyperCube.IndentMode
Public propertyInfo
Reference to property Layout.Info
(Inherited from IGenericObject.)
Public propertyLastExpandedPos
Reference to property Layout.HyperCube.LastExpandedPos
Public propertyLayoutExclude
Reference to property Layout.LayoutExclude
(Inherited from IVisualizationBase.)
Public propertyLegend
Reference to property Layout.Legend
Public propertyMeasureAxes
Reference to property Layout.MeasureAxes
Public propertyMeasureInfo
Reference to property Layout.HyperCube.MeasureInfo
Public propertyMeta
Reference to property Layout.Meta
(Inherited from IGenericObject.)
Public propertyMode
Reference to property Layout.HyperCube.Mode
Public propertyNoOfLeftDims
Reference to property Layout.HyperCube.NoOfLeftDims
Public propertyNullMode
Reference to property Layout.NullMode
Public propertyNxInfo
Reference to property Layout.Info
(Inherited from IVisualizationBase.)
Public propertyNxLayoutErrors
Reference to property Layout.Error
(Inherited from IVisualizationBase.)
Public propertyNxMeta
Reference to property Layout.Meta
(Inherited from IVisualizationBase.)
Public propertyNxSelectionInfo
Reference to property Layout.SelectionInfo
(Inherited from IVisualizationBase.)
Public propertyNxValidationError
Reference to property Layout.HyperCube.Error
Public propertyOrientation
Reference to property Layout.Orientation
Public propertyPivotDataPages
Reference to property Layout.HyperCube.PivotDataPages
Public propertyProperties
Public propertyQlikConnection
Reference to property Layout.Session
(Inherited from IVisualizationBase.)
Public propertySelectionInfo
Reference to property Layout.SelectionInfo
(Inherited from IGenericObject.)
Public propertyShowTitles
Reference to property Layout.ShowTitles
(Inherited from IVisualizationBase.)
Public propertySize
Reference to property Layout.HyperCube.Size
Public propertyStackedDataPages
Reference to property Layout.HyperCube.StackedDataPages
Public propertyStateName
Reference to property Layout.HyperCube.StateName
Public propertySubtitle
Reference to property Layout.Subtitle
(Inherited from IVisualizationBase.)
Public propertySuspendedLayout
Stops incoming changes from altering the object, resumes normal behavior after disposed.
(Inherited from IGenericObject.)
Public propertyTitle
Reference to property Layout.Title
(Inherited from IVisualizationBase.)
Public propertyType
The type of the Qlik Sense entity.
(Inherited from IQixClassBase.)
Public propertyVisualization
Reference to property Layout.Visualization
(Inherited from IVisualizationBase.)
Top
Events
  NameDescription
Public eventChanged
This event fires when to notify subscribers that a change has occured.
(Inherited from IChangeNotifier.)
Public eventClosed
This event fires when the Qlik Sense entity has been removed or deleted.
(Inherited from IQixClassBase.)
Top
See Also