GenericObject Class

Indicates whether or not this object is a session object.

Aborts the results of a search in a list object.

Aborts the results of a search in a list object.

Aborts the results of a search in a list object.

Accept the results of a search in a list object. The search results become selected in the field.

Accept the results of a search in a list object. The search results become selected in the field.

Accept the results of a search in a list object. The search results become selected in the field.

Applies a patch to the properties of an object. Allows an update to some of the properties.

It is possible to apply a patch to the properties of a generic object, that is not persistent. Such a patch is called a soft patch.

In that case, the result of the operation on the properties (add, remove or delete) is not shown when doing GetProperties , and only a GetLayout call shows the result of the operation.

Properties that are not persistent are called soft properties. Once the engine session is over, soft properties are cleared. It should not be possible to patch "/qInfo/qId",

and it will be forbidden in the near future.

Applies a patch to the properties of an object. Allows an update to some of the properties.

It is possible to apply a patch to the properties of a generic object, that is not persistent. Such a patch is called a soft patch.

In that case, the result of the operation on the properties (add, remove or delete) is not shown when doing GetProperties , and only a GetLayout call shows the result of the operation.

Properties that are not persistent are called soft properties. Once the engine session is over, soft properties are cleared. It should not be possible to patch "/qInfo/qId",

and it will be forbidden in the near future.

Applies a patch to the properties of an object. Allows an update to some of the properties.

It is possible to apply a patch to the properties of a generic object, that is not persistent. Such a patch is called a soft patch.

In that case, the result of the operation on the properties (add, remove or delete) is not shown when doing GetProperties , and only a GetLayout call shows the result of the operation.

Properties that are not persistent are called soft properties. Once the engine session is over, soft properties are cleared. It should not be possible to patch "/qInfo/qId",

and it will be forbidden in the near future.

Adds the generic object to the list of approved objects

Adds the generic object to the list of approved objects

Adds the generic object to the list of approved objects

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.

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.

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.

Clears the selections in a dimension of a visualization.

Clears the selections in a dimension of a visualization.

Clears the selections in a dimension of a visualization.

Clears the soft properties of a generic object.

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

Clears the soft properties of a generic object.

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

Clears the soft properties of a generic object.

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

Creation of child generic object

Async creation of child generic object

Async creation of child generic object

Retrieves the total number of HyperCube/ListObject definitions contained in this generic object

Retrieves the total number of HyperCube/ListObject definitions contained in this generic object asynchronously

Converts an existing index to its equivalent path value

Converts existing index values to their equivalent path values

Converts an existing index to its equivalent path value asynchronously

Converts existing index values to their equivalent path values asynchronously

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

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

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

Removes a child object.

Removes a child object.

Removes a child object.

Removes a child object.

Callback after create, this method can be overridden to customize the behavior after a child has been created.

Callback after destroy, this method can be overridden to customize the behavior after a child has been destroyed.

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.

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.

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

DuplicateAs

Adds a snapshot to a generic object.

Adds a snapshot to a generic object.

Adds a snapshot to a generic object.

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

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

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

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.

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.

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.

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.

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.

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.

Exports the data of any generic object to an Excel file or a open XML file. If the object contains excluded values, those excluded values are not exported.

This API has limited functionality and will not support CSV export from all types of objects. Consider using Excel export instead. Treemap and bar chart are not supported.

Default limitations in number of rows and columns

The default maximum number of rows and columns in the Excel export file is:

* 1048566 rows per sheet. For pivot tables: 1048566 column dimensions. 10 rows can be added after the export.

* 16384 columns per sheet. If the number of columns exceeds the limit, the exported file is truncated and a warning message is sent.

Default limitation in number of columns

The default maximum number of columns in the export file is:

* 1000 to export to a CSV file

The exported file is truncated if the number of cells exceeds the limit. A warning message with code 1000 is sent.

Default limitation in size

If the exported file is larger than the maximum value, then an out-of-memory error with code 13000 is returned.

Exports the data of any generic object to an Excel file or a open XML file. If the object contains excluded values, those excluded values are not exported.

This API has limited functionality and will not support CSV export from all types of objects. Consider using Excel export instead. Treemap and bar chart are not supported.

Default limitations in number of rows and columns

The default maximum number of rows and columns in the Excel export file is:

* 1048566 rows per sheet. For pivot tables: 1048566 column dimensions. 10 rows can be added after the export.

* 16384 columns per sheet. If the number of columns exceeds the limit, the exported file is truncated and a warning message is sent.

Default limitation in number of columns

The default maximum number of columns in the export file is:

* 1000 to export to a CSV file

The exported file is truncated if the number of cells exceeds the limit. A warning message with code 1000 is sent.

Default limitation in size

If the exported file is larger than the maximum value, then an out-of-memory error with code 13000 is returned.

Exports the data of any generic object to an Excel file or a open XML file. If the object contains excluded values, those excluded values are not exported.

This API has limited functionality and will not support CSV export from all types of objects. Consider using Excel export instead. Treemap and bar chart are not supported.

Default limitations in number of rows and columns

The default maximum number of rows and columns in the Excel export file is:

* 1048566 rows per sheet. For pivot tables: 1048566 column dimensions. 10 rows can be added after the export.

* 16384 columns per sheet. If the number of columns exceeds the limit, the exported file is truncated and a warning message is sent.

Default limitation in number of columns

The default maximum number of columns in the export file is:

* 1000 to export to a CSV file

The exported file is truncated if the number of cells exceeds the limit. A warning message with code 1000 is sent.

Default limitation in size

If the exported file is larger than the maximum value, then an out-of-memory error with code 13000 is returned.

Exports the data of any generic object to an Excel file or a open XML file. If the object contains excluded values, those excluded values are not exported.

This API has limited functionality and will not support CSV export from all types of objects. Consider using Excel export instead. Treemap and bar chart are not supported.

Default limitations in number of rows and columns

The default maximum number of rows and columns in the Excel export file is:

* 1048566 rows per sheet. For pivot tables: 1048566 column dimensions. 10 rows can be added after the export.

* 16384 columns per sheet. If the number of columns exceeds the limit, the exported file is truncated and a warning message is sent.

Default limitation in number of columns

The default maximum number of columns in the export file is:

* 1000 to export to a CSV file

The exported file is truncated if the number of cells exceeds the limit. A warning message with code 1000 is sent.

Default limitation in size

If the exported file is larger than the maximum value, then an out-of-memory error with code 13000 is returned.

Get hypercube paging interfaces for all hypercubes in the object.

Get hypercube paging interfaces for all hypercubes in the object.

Get list object paging interfaces for all list objects in the object.

Returns the type of the object and the corresponding handle.

Returns the type of the object and the corresponding handle.

Returns the type of the object and the corresponding handle.

Returns the type of the object and the corresponding handle.

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

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

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

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

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

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

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

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

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.

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.

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.

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.

Gets the properties of:

* A generic object.

* The children of the generic object.

* The bookmarks/embedded snapshots of the generic object.

Gets the properties of:

* A generic object.

* The children of the generic object.

* The bookmarks/embedded snapshots of the generic object.

Gets the properties of:

* A generic object.

* The children of the generic object.

* The bookmarks/embedded snapshots of the generic object.

Gets the properties of:

* A generic object.

* The children of the generic object.

* The bookmarks/embedded snapshots of the generic object.

This method supports data binning.

When a generic object with two or three measures and one dimension contains a lot of data, groups of points (for example, cells) can be rendered instead of points.

A zone of interest can be refined (for zooming in) up to a maximum refinement level (set in the qQueryLevel parameter) or coarsened (for zoom out).

The grid of cells is adaptive (not static), meaning that it adapts to different length scales.

The GetHyperCubeBinnedData method gives information about the adaptive grid and the values of the generic object.

The number of points in a cell and the coordinates (expressed in the measure range) of each cell are returned.

Dimension values and measure values are rendered at point level (highest detailed level).

Adaptive Grid

More details about the properties of the adaptive grid are given in this paragraph.

When the refinement is not the highest (cells are rendered), information about the adaptive grid is returned through several arrays.

The first array contains the following properties:

Please refer to Engine API reference for table definition.

The next arrays give the coordinates of each cell in the page.

Each array contains the following properties:

Please refer to Engine API reference for table definition.

Dimension values and measures values

More details about the properties, when dimension and measure values are returned, are given in this paragraph.

When the refinement is high, points are rendered (not cells) and dimension and measure values for each cell are returned.

The first array is empty because no information on the adaptive grid is needed.

The next arrays bring information about the dimension and the measure values.

Please refer to Engine API reference for table definition.

This method supports data binning.

When a generic object with two or three measures and one dimension contains a lot of data, groups of points (for example, cells) can be rendered instead of points.

A zone of interest can be refined (for zooming in) up to a maximum refinement level (set in the qQueryLevel parameter) or coarsened (for zoom out).

The grid of cells is adaptive (not static), meaning that it adapts to different length scales.

The GetHyperCubeBinnedData method gives information about the adaptive grid and the values of the generic object.

The number of points in a cell and the coordinates (expressed in the measure range) of each cell are returned.

Dimension values and measure values are rendered at point level (highest detailed level).

Adaptive Grid

More details about the properties of the adaptive grid are given in this paragraph.

When the refinement is not the highest (cells are rendered), information about the adaptive grid is returned through several arrays.

The first array contains the following properties:

Please refer to Engine API reference for table definition.

The next arrays give the coordinates of each cell in the page.

Each array contains the following properties:

Please refer to Engine API reference for table definition.

Dimension values and measures values

More details about the properties, when dimension and measure values are returned, are given in this paragraph.

When the refinement is high, points are rendered (not cells) and dimension and measure values for each cell are returned.

The first array is empty because no information on the adaptive grid is needed.

The next arrays bring information about the dimension and the measure values.

Please refer to Engine API reference for table definition.

This method supports data binning.

When a generic object with two or three measures and one dimension contains a lot of data, groups of points (for example, cells) can be rendered instead of points.

A zone of interest can be refined (for zooming in) up to a maximum refinement level (set in the qQueryLevel parameter) or coarsened (for zoom out).

The grid of cells is adaptive (not static), meaning that it adapts to different length scales.

The GetHyperCubeBinnedData method gives information about the adaptive grid and the values of the generic object.

The number of points in a cell and the coordinates (expressed in the measure range) of each cell are returned.

Dimension values and measure values are rendered at point level (highest detailed level).

Adaptive Grid

More details about the properties of the adaptive grid are given in this paragraph.

When the refinement is not the highest (cells are rendered), information about the adaptive grid is returned through several arrays.

The first array contains the following properties:

Please refer to Engine API reference for table definition.

The next arrays give the coordinates of each cell in the page.

Each array contains the following properties:

Please refer to Engine API reference for table definition.

Dimension values and measures values

More details about the properties, when dimension and measure values are returned, are given in this paragraph.

When the refinement is high, points are rendered (not cells) and dimension and measure values for each cell are returned.

The first array is empty because no information on the adaptive grid is needed.

The next arrays bring information about the dimension and the measure values.

Please refer to Engine API reference for table definition.

This method supports data binning.

When a generic object with two or three measures and one dimension contains a lot of data, groups of points (for example, cells) can be rendered instead of points.

A zone of interest can be refined (for zooming in) up to a maximum refinement level (set in the qQueryLevel parameter) or coarsened (for zoom out).

The grid of cells is adaptive (not static), meaning that it adapts to different length scales.

The GetHyperCubeBinnedData method gives information about the adaptive grid and the values of the generic object.

The number of points in a cell and the coordinates (expressed in the measure range) of each cell are returned.

Dimension values and measure values are rendered at point level (highest detailed level).

Adaptive Grid

More details about the properties of the adaptive grid are given in this paragraph.

When the refinement is not the highest (cells are rendered), information about the adaptive grid is returned through several arrays.

The first array contains the following properties:

Please refer to Engine API reference for table definition.

The next arrays give the coordinates of each cell in the page.

Each array contains the following properties:

Please refer to Engine API reference for table definition.

Dimension values and measures values

More details about the properties, when dimension and measure values are returned, are given in this paragraph.

When the refinement is high, points are rendered (not cells) and dimension and measure values for each cell are returned.

The first array is empty because no information on the adaptive grid is needed.

The next arrays bring information about the dimension and the measure values.

Please refer to Engine API reference for table definition.

Retrieves and packs compressed hypercube and axis data. It is possible to retrieve specific pages of data.

Retrieves and packs compressed hypercube and axis data. It is possible to retrieve specific pages of data.

Retrieves and packs compressed hypercube and axis data. It is possible to retrieve specific pages of data.

Retrieves and packs compressed hypercube and axis data. It is possible to retrieve specific pages of data.

Retrieves the calculated data for a chart, a table, or a scatter plot. It is possible to retrieve specific pages of data.

A data set is returned.

Retrieves the calculated data for a chart, a table, or a scatter plot. It is possible to retrieve specific pages of data.

A data set is returned.

Retrieves the calculated data for a chart, a table, or a scatter plot. It is possible to retrieve specific pages of data.

A data set is returned.

Retrieves the calculated data for a chart, a table, or a scatter plot. It is possible to retrieve specific pages of data.

A data set is returned.

Get a hypercube paging interface for a hypercube at the specified path.

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

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

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

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

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.

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.

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.

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.

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

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

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

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

Retrieves data for nodes in a tree structure. It is possible to retrieve specific pages of data.

Retrieves data for nodes in a tree structure. It is possible to retrieve specific pages of data.

Retrieves data for nodes in a tree structure. It is possible to retrieve specific pages of data.

Retrieves data for nodes in a tree structure. It is possible to retrieve specific pages of data.

Returns the type and identifier of the object.

Returns the type and identifier of the object.

Returns the type and identifier of the object.

Returns the type and identifier of the object.

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.

Example:

A is a generic object and is the parent of the objects B and C. B is the parent of the objects D and E.

Please refer to Engine API reference for illustrations.

A GetLayout call on A returns information on the objects A, B and C.

A GetLayout call on B returns information on the objects B, D and E.

A GetLayout call on C returns information on the object C.

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.

Example:

A is a generic object and is the parent of the objects B and C. B is the parent of the objects D and E.

Please refer to Engine API reference for illustrations.

A GetLayout call on A returns information on the objects A, B and C.

A GetLayout call on B returns information on the objects B, D and E.

A GetLayout call on C returns information on the object C.

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.

Example:

A is a generic object and is the parent of the objects B and C. B is the parent of the objects D and E.

Please refer to Engine API reference for illustrations.

A GetLayout call on A returns information on the objects A, B and C.

A GetLayout call on B returns information on the objects B, D and E.

A GetLayout call on C returns information on the object C.

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

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

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

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

Retrieves the values of a list object.

A data set is returned.

Retrieves the values of a list object.

A data set is returned.

Retrieves the values of a list object.

A data set is returned.

Retrieves the values of a list object.

A data set is returned.

Get a list object paging interface for a list box at the specified path.

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

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

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

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

Returns the identifier, the type and the properties of the object.

Because it is not mandatory to set all properties when you define an object, the GetProperties method may show properties that were not set. In that case, default values are given.

If the object contains some soft properties, the soft properties are not returned by the GetProperties method. Use the GetEffectiveProperties method instead.

If the object is linked to another object, the properties of the linking object are not returned by the GetProperties method. Use the GetEffectiveProperties method instead.

Returns the identifier, the type and the properties of the object.

Because it is not mandatory to set all properties when you define an object, the GetProperties method may show properties that were not set. In that case, default values are given.

If the object contains some soft properties, the soft properties are not returned by the GetProperties method. Use the GetEffectiveProperties method instead.

If the object is linked to another object, the properties of the linking object are not returned by the GetProperties method. Use the GetEffectiveProperties method instead.

Returns the identifier, the type and the properties of the object.

Because it is not mandatory to set all properties when you define an object, the GetProperties method may show properties that were not set. In that case, default values are given.

If the object contains some soft properties, the soft properties are not returned by the GetProperties method. Use the GetEffectiveProperties method instead.

If the object is linked to another object, the properties of the linking object are not returned by the GetProperties method. Use the GetEffectiveProperties method instead.

Returns the type of the object and the corresponding handle.

Returns the type of the object and the corresponding handle.

Returns the type of the object and the corresponding handle.

Returns the type of the object and the corresponding handle.

Converts an existing path to its equivalent index value

Converts existing paths to their equivalent index values

Converts an existing path to its equivalent index value asynchronously

Converts existing paths to their equivalent index values asynchronously

Link master object

Link master object

Link master object

Locks the selected values of a generic object.

Locks the selected values of a generic object.

Locks the selected values of a generic object.

Mark object as being a session object and ensure that it is correctly destroyed when the .NET object is disposed.

Makes multiple range selections in measures.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Makes multiple range selections in measures.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Makes multiple range selections in measures.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Makes multiple range selections in measures.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Async callback for create child async

Async callback for destroy

Async callback for get

Publishes a generic object.

Publishes a generic object.

Publishes a generic object.

Makes range selections in measures.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Makes range selections in measures.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Makes range selections in measures.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Makes range selections in measures.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Resets all selections made in selection mode.

Resets all selections made in selection mode.

Resets all selections made in selection mode.

Searches for a string in a list object.

Searches for a string in a list object.

Searches for a string in a list object.

Searches for a string in a list object.

Makes selections in multiple dimensions and measures.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Makes selections in multiple dimensions and measures.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Makes selections in multiple dimensions and measures.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Makes selections in multiple dimensions and measures.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

The following is returned in the output:

The following is returned in the output:

The following is returned in the output:

The following is returned in the output:

Selects some values in one dimension.

The values are identified by their element numbers.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Selects some values in one dimension.

The values are identified by their element numbers.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Selects some values in one dimension.

The values are identified by their element numbers.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Selects some values in one dimension.

The values are identified by their element numbers.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Selects all values of a field.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Selects all values of a field.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Selects all values of a field.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Selects all values of a field.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Selects all alternative values in a specific field.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Selects all alternative values in a specific field.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Selects all alternative values in a specific field.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Selects all alternative values in a specific field.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

The following is returned in the output:

The following is returned in the output:

The following is returned in the output:

The following is returned in the output:

Inverts the current selections in a specific field.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Inverts the current selections in a specific field.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Inverts the current selections in a specific field.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Inverts the current selections in a specific field.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Selects all possible values of a list object.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Selects all possible values of a list object.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Selects all possible values of a list object.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Selects all possible values of a list object.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Makes single selections in dimensions.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Makes single selections in dimensions.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Makes single selections in dimensions.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Makes single selections in dimensions.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

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.

Example of a pivot table

Please refer to Engine API reference for illustrations.

In the representation above:

Please refer to Engine API reference for table definition.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

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.

Example of a pivot table

Please refer to Engine API reference for illustrations.

In the representation above:

Please refer to Engine API reference for table definition.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

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.

Example of a pivot table

Please refer to Engine API reference for illustrations.

In the representation above:

Please refer to Engine API reference for table definition.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

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.

Example of a pivot table

Please refer to Engine API reference for illustrations.

In the representation above:

Please refer to Engine API reference for table definition.

The member Change returns the handles of the objects that are updated following the selections.

qSuccess is set to true if the selections are successful and is set to false in the following cases:

* The object contains some invalid fields (fields that are not in the data model).

* The selection applies to a locked field.

* A range selection is performed and the parameter OneAndOnlyOne is set to true in the definition of the object.

Sets the order of the children in a generic object.

Sets the order of the children in a generic object.

Sets the order of the children in a generic object.

Sets the properties of:

* A generic object.

* The children of the generic object.

* The bookmarks/embedded snapshots of the generic object.

Sets the properties of:

* A generic object.

* The children of the generic object.

* The bookmarks/embedded snapshots of the generic object.

Sets the properties of:

* A generic object.

* The children of the generic object.

* The bookmarks/embedded snapshots of the generic object.

Sets some properties for a generic object.

Sets some properties for a generic object.

Sets some properties for a generic object.

Removes the generic object from the list of approved objects

Removes the generic object from the list of approved objects

Removes the generic object from the list of approved objects

Unlink master object

Unlink master object

Unlink master object

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

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

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

Unpublishes a generic object.

Unpublishes a generic object.

Unpublishes a generic object.

Callback before create

Callback before destroy