Interface IGenericObject

interface IGenericObject {
    app: IApp;
    genericType: string;
    handle: number;
    id: string;
    session: ISession;
    type: string;
    abortListObjectSearch(qPath): Promise<void>;
    acceptListObjectSearch(qPath, qToggleMode, qSoftLock?): Promise<void>;
    applyPatches(qPatches, qSoftPatch?): Promise<void>;
    beginSelections(qPaths): Promise<void>;
    clearSelections(qPath, qColIndices?): Promise<void>;
    clearSoftPatches(): Promise<void>;
    collapseLeft(qPath, qRow, qCol, qAll): Promise<void>;
    collapseTop(qPath, qRow, qCol, qAll): Promise<void>;
    copyFrom(qFromId): Promise<void>;
    createChild(qProp, qPropForThis?): Promise<IGenericObject>;
    destroyAllChildren(qPropForThis?): Promise<void>;
    destroyChild(qid, qPropForThis?): Promise<boolean>;
    drillUp(qPath, qDimNo, qNbrSteps): Promise<void>;
    embedSnapshotObject(qId): Promise<void>;
    emit(event): void;
    endSelections(qAccept): Promise<void>;
    expandLeft(qPath, qRow, qCol, qAll): Promise<void>;
    expandTop(qPath, qRow, qCol, qAll): Promise<void>;
    exportData(qFileType, qPath, qFileName?, qExportState?): Promise<string>;
    getChild(qId): Promise<IGenericObject>;
    getChildInfos(): Promise<INxInfo[]>;
    getEffectiveProperties(): Promise<IGenericObjectProperties>;
    getFullPropertyTree(): Promise<IGenericObjectEntry>;
    getHyperCubeBinnedData(qPath, qPages, qViewport, qDataRanges, qMaxNbrCells, qQueryLevel, qBinningMethod): Promise<INxDataPage[]>;
    getHyperCubeContinuousData(qPath, qOptions): Promise<{
        qAxisData: INxAxisData[];
        qDataPages: INxDataPage[];
    }>;
    getHyperCubeData(qPath, qPages): Promise<INxDataPage[]>;
    getHyperCubePivotData(qPath, qPages): Promise<INxPivotPage[]>;
    getHyperCubeReducedData(qPath, qPages, qZoomFactor, qReductionMode): Promise<INxDataPage[]>;
    getHyperCubeStackData(qPath, qPages, qMaxNbrCells?): Promise<INxStackPage[]>;
    getHyperCubeTreeData(qPath, qNodeOptions): Promise<INxTreeNode>;
    getInfo(): Promise<INxInfo>;
    getLayout(): Promise<IGenericBaseLayout>;
    getLinkedObjects(): Promise<INxLinkedObjectInfo[]>;
    getListObjectContinuousData(qPath, qOptions): Promise<{
        qAxisData: INxAxisData[];
        qDataPages: INxDataPage;
    }>;
    getListObjectData(qPath, qPages): Promise<INxDataPage[]>;
    getProperties(): Promise<IGenericObjectProperties>;
    getSnapshotObject(): Promise<IGenericBookmark>;
    lock(qPath, qColIndices?): Promise<void>;
    multiRangeSelectHyperCubeValues(qPath, qRanges, qDeselectOnlyOneSelected, qColumnsToSelect?, qOrMode?): Promise<boolean>;
    on(event, func): void;
    publish(): Promise<void>;
    rangeSelectHyperCubeValues(qPath, qRanges, qDeselectOnlyOneSelected, qColumnsToSelect?, qOrMode?): Promise<boolean>;
    resetMadeSelections(): Promise<void>;
    searchListObjectFor(qPath, qMatch): Promise<boolean>;
    selectHyperCubeCells(qPath, qRowIndices, qColIndices, qSoftLock, qDeselectOnlyOneSelected): Promise<boolean>;
    selectHyperCubeContinuousRange(qPath, qRanges, qSoftLock): Promise<boolean>;
    selectHyperCubeValues(qPath, qDimNo, qValues, qToggleMode): Promise<boolean>;
    selectListObjectAll(qPath, qSoftLock?): Promise<boolean>;
    selectListObjectAlternative(qPath, qSoftLock?): Promise<boolean>;
    selectListObjectContinuousRange(qPath, qRanges, qSoftLock?): Promise<boolean>;
    selectListObjectExcluded(qPath, qSoftLock?): Promise<boolean>;
    selectListObjectPossible(qPath, qSoftLock?): Promise<boolean>;
    selectListObjectValues(qPath, qValues, qToggleMode, qSoftLock?): Promise<boolean>;
    selectPivotCells(qPath, qSelections, qDeselectOnlyOneSelected, qSoftLock?): Promise<boolean>;
    setChildArrayOrder(qIds): Promise<void>;
    setFullPropertyTree(qPropEntry): Promise<void>;
    setProperties(qProp): Promise<void>;
    unPublish(): Promise<void>;
    unlock(qPath, qColIndices?): Promise<void>;
}

Hierarchy

  • IGenericObject
    • IGenericObject

Properties

app genericType handle id session type

Methods

abortListObjectSearch acceptListObjectSearch applyPatches beginSelections clearSelections clearSoftPatches collapseLeft collapseTop copyFrom createChild destroyAllChildren destroyChild drillUp embedSnapshotObject emit endSelections expandLeft expandTop exportData getChild getChildInfos getEffectiveProperties getFullPropertyTree getHyperCubeBinnedData getHyperCubeContinuousData getHyperCubeData getHyperCubePivotData getHyperCubeReducedData getHyperCubeStackData getHyperCubeTreeData getInfo getLayout getLinkedObjects getListObjectContinuousData getListObjectData getProperties getSnapshotObject lock multiRangeSelectHyperCubeValues on publish rangeSelectHyperCubeValues resetMadeSelections searchListObjectFor selectHyperCubeCells selectHyperCubeContinuousRange selectHyperCubeValues selectListObjectAll selectListObjectAlternative selectListObjectContinuousRange selectListObjectExcluded selectListObjectPossible selectListObjectValues selectPivotCells setChildArrayOrder setFullPropertyTree setProperties unPublish unlock

Properties

app

app: IApp

app describes all the methods that apply at app level.

genericType

genericType: string

Despite the name, this property corresponds to the qInfo.qType property on your generic object's properties object.

handle

handle: number

This property contains the handle QIX Engine assigned to the API. Used internally in enigma.js for caches and JSON-RPC

id

id: string

This property contains the unique identifier for this API.

session

session: ISession

This property contains a reference to the session that this API belongs to.

type

type: string

This property contains the schema class name for this API.

Methods

abortListObjectSearch

  • abortListObjectSearch(qPath): Promise<void>

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

    Parameters

    • qPath: string

      Path to the definition of the list object. For example, /qListObjectDef.

    Returns Promise<void>

acceptListObjectSearch

  • acceptListObjectSearch(qPath, qToggleMode, qSoftLock?): Promise<void>

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

    Note: This method applies to list objects (objects with one dimension). Note: The search results are displayed using the GetLayout method.

    Parameters

    • qPath: string

      Path to the definition of the list object. For example, /qListObjectDef.

    • qToggleMode: boolean

      Set to true to keep any selections present in the list object. If this parameter is set to false, selections made before accepting the list object search become alternative.

      This parameter is mandatory.

    • Optional qSoftLock: boolean

      Set to true to ignore locks; in that case, locked fields can be selected. The default value is false. This parameter is optional.

    Returns Promise<void>

applyPatches

  • applyPatches(qPatches, qSoftPatch?): Promise<void>

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

    Note: Soft properties apply only to generic objects. Check: Applying a patch takes less time than resetting all the properties.

    Parameters

    • qPatches: INxPatch[]

      Array of patches.

    • Optional qSoftPatch: boolean

      If set to true, it means that the properties to be applied are not persistent. The patch is a soft patch. This parameter is optional. Default is false.

    Returns Promise<void>

beginSelections

  • beginSelections(qPaths): Promise<void>

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

    Parameters

    • qPaths: string[]

      List of the paths to the definition of the objects to enter selection mode. For example, /qListObjectDef.

    Returns Promise<void>

clearSelections

  • clearSelections(qPath, qColIndices?): Promise<void>

  • Clears the selections in a dimension of a visualization.

    Parameters

    • qPath: string

      Path to the definition of the visualization. For example, /qListObjectDef.

    • Optional qColIndices: number[]

      Array of dimension numbers or indexes. The selections are cleared in the specified dimensions. Dimension numbers/indexes start from 0. This parameter is optional. If this parameter is not set, all dimensions are cleared.

    Returns Promise<void>

clearSoftPatches

  • clearSoftPatches(): Promise<void>

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

    Returns Promise<void>

collapseLeft

  • collapseLeft(qPath, qRow, qCol, qAll): Promise<void>

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

    Parameters

    • qPath: string

      Path to the definition of the object to be collapsed For example, /qHyperCubeDef.

      This parameter is mandatory.

    • qRow: number

      Row index in the data matrix. Indexing starts from 0.

    • qCol: number

      Column index. The index is based on the left dimension indexes. Indexing starts from 0.

    • qAll: boolean

      If set to true, it collapses all cells. Parameters qRow and qCol are not used if qAll is set to true, but they need to be set (for example to 0).

    Returns Promise<void>

collapseTop

  • collapseTop(qPath, qRow, qCol, qAll): Promise<void>

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

    Parameters

    • qPath: string

      Path to the definition of the object to be collapsed For example, /qHyperCubeDef.

      This parameter is mandatory.

    • qRow: number

      Row index in the data matrix. Indexing starts from 0.

    • qCol: number

      Column index. The index is based on the left dimension indexes. Indexing starts from 0.

    • qAll: boolean

      If set to true, it collapses all cells. Parameters qRow and qCol are not used if qAll is set to true, but they need to be set (for example to 0).

    Returns Promise<void>

copyFrom

  • copyFrom(qFromId): Promise<void>

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

    Note: The identifier of the destination object is the same as before the copy takes place.

    Parameters

    • qFromId: IGenericObjectProperties

      Identifier of the object to copy.

    Returns Promise<void>

createChild

  • createChild(qProp, qPropForThis?): Promise<IGenericObject>

  • Creates a generic object that is a child of another generic object.

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

    Note: In addition to the parameters specified above, the parameter qProp can get any properties defined in the Generic objects section.

    Parameters

    • qProp: IGenericObjectProperties

      Information about the child

      This parameter is mandatory. It is possible to create a child that is linked to another object.

    • Optional qPropForThis: IGenericObjectProperties

      This parameter is optional. Identifier of the parent's object. Should be set to update the properties of the parent's object at the same time the child is created.

    Returns Promise<IGenericObject>

    • A Promise of GenericObject

destroyAllChildren

  • destroyAllChildren(qPropForThis?): Promise<void>

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

    Parameters

    • Optional qPropForThis: IGenericObjectProperties

      This parameter is optional. Identifier of the parent's object and property to update. Should be set to update the properties of the parent's object at the same time the child is created.

    Returns Promise<void>

destroyChild

  • destroyChild(qid, qPropForThis?): Promise<boolean>

  • Removes a child object. Note: 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.

    Note: Removing a linked object, invalidate the linking object.

    Parameters

    • qid: string

      Identifier of the child to remove.

      This parameter is mandatory.

    • Optional qPropForThis: IGenericObjectProperties

      This parameter is optional. Identifier of the parent's object and property to update. Should be set to update the properties of the parent's object at the same time the child is created.

    Returns Promise<boolean>

    • true or false

drillUp

  • drillUp(qPath, qDimNo, qNbrSteps): Promise<void>

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

    Parameters

    • qPath: string

      Path to the definition of the object to be selected. For example, /qHyperCubeDef.

      This parameter is mandatory.

    • qDimNo: number

      Dimension number or index starting from 0 The default value is 0.

    • qNbrSteps: number

      Number of steps you want to drill up. The default value is 0.

    Returns Promise<void>

embedSnapshotObject

  • embedSnapshotObject(qId): Promise<void>

  • Adds a snapshot to a generic object.

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

    Parameters

    • qId: string

      Identifier of the bookmark. >> This parameter is mandatory.

    Returns Promise<void>

emit

  • emit(event): void

  • manual emit an events

    Parameters

    • event: "closed" | "changed"

      event that occures

    Returns void

endSelections

  • endSelections(qAccept): Promise<void>

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

    Parameters

    • qAccept: boolean

      Set this parameter to true to accept the selections before exiting the selection mode.

    Returns Promise<void>

expandLeft

  • expandLeft(qPath, qRow, qCol, qAll): Promise<void>

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

    Parameters

    • qPath: string

      Path to the definition of the object to be collapsed For example, /qHyperCubeDef.

      This parameter is mandatory.

    • qRow: number

      Row index in the data matrix. Indexing starts from 0.

    • qCol: number

      Column index. The index is based on the left dimension indexes. Indexing starts from 0.

    • qAll: boolean

      If set to true, it collapses all cells. Parameters qRow and qCol are not used if qAll is set to true, but they need to be set (for example to 0).

    Returns Promise<void>

expandTop

  • expandTop(qPath, qRow, qCol, qAll): Promise<void>

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

    Parameters

    • qPath: string

      Path to the definition of the object to be collapsed For example, /qHyperCubeDef.

      This parameter is mandatory.

    • qRow: number

      Row index in the data matrix. Indexing starts from 0.

    • qCol: number

      Column index. The index is based on the left dimension indexes. Indexing starts from 0.

    • qAll: boolean

      If set to true, it collapses all cells. Parameters qRow and qCol are not used if qAll is set to true, but they need to be set (for example to 0).

    Returns Promise<void>

exportData

  • exportData(qFileType, qPath, qFileName?, qExportState?): Promise<string>

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

    Note: There is an option to export only the possible values (qExportState is P).

    -- Default limitation in size -- The default size limit of an export file is: 10241024800 for an export to an Excel file. If the exported file is larger than the maximum value, then an out of memory error with code 13000 is returned.

    Note: Exported files are temporary and are available only for a certain time span and only to the user who created them.

    Parameters

    • qFileType: FileType

      Type of the file to export. >> This parameter is mandatory.

    • qPath: string

      Path to the definition of the object to be exported. For example, /qHyperCubeDef.

      This parameter is mandatory if the file type is CSV_C or CSV_T.

    • Optional qFileName: string

      Name of the exported file after download from browser. This parameter is optional and only used in Qlik Sense Desktop.

    • Optional qExportState: ExportStateType

      Defines the values to be exported. This parameter is optional. One of: P to export only the possible values A to export all values (default)

    Returns Promise<string>

    • A Promise of String qUrl: and qWarnings: [1000] only if exported data is truncated

getChild

  • getChild(qId): Promise<IGenericObject>

  • Returns the type of the object and the corresponding handle.

    Parameters

    • qId: string

      Identifier of the object.

      This parameter is mandatory.

    Returns Promise<IGenericObject>

    • A Promise of GenericObject

getChildInfos

  • getChildInfos(): Promise<INxInfo[]>

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

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

    Returns Promise<INxInfo[]>

    • A Promise Array of NxInfo

getEffectiveProperties

  • getEffectiveProperties(): Promise<IGenericObjectProperties>

  • 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 Promise<IGenericObjectProperties>

    • A Promise of GenericObjectProperties

getFullPropertyTree

  • getFullPropertyTree(): Promise<IGenericObjectEntry>

  • Gets the properties of: - a generic object - the children of the generic object - the bookmarks/embedded snapshots of the generic object

    Returns Promise<IGenericObjectEntry>

    • A Promise GenericObjectEntry

getHyperCubeBinnedData

  • getHyperCubeBinnedData(qPath, qPages, qViewport, qDataRanges, qMaxNbrCells, qQueryLevel, qBinningMethod): Promise<INxDataPage[]>

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

    Note: The generic object should contain two or three measures and one dimension. When the refinement is high, the first two measures are represented on the x-axis and on the y-axis, while the third measure is visualized as color or point size.

    Parameters

    • qPath: string

      Path to the definition of the object. For example, /qHyperCubeDef.

      This parameter is mandatory.

    • qPages: INxPage[]

      Array of pages to retrieve. Since the generic object contains two measures and one dimension, qWidth should be set to 3. If the value of a measure is Null, the value cannot be rendered. Therefore, the number of elements rendered in a page can be less than the number defined in the property qHeight.

      This parameter is mandatory.

    • qViewport: INxViewPort

      Defines the canvas and the zoom level. This parameter is not yet used and is optional.

    • qDataRanges: INxDataAreaPage

      Range of the data to render. This range applies to the measure values. The lowest and highest values of a measure can be retrieved by using the GetLayout method ( in /qHyperCube/qMeasureInfo).

      This parameter is mandatory.

    • qMaxNbrCells: number

      Maximum number of cells in the grid.

      This parameter is mandatory.

    • qQueryLevel: number

      Level of details. The higher the level, the more detailed information you get (zoom-in). When the number of points to render falls below a certain threshold, the values are no longer rendered as cells but as points. The query level should be no greater than 20. This parameter is optional.

    • qBinningMethod: number

      Selects the algorithm. The default value is 0. One of: 0: Adaptive grid

    Returns Promise<INxDataPage[]>

    • A Promise Array of NxDataPage

getHyperCubeContinuousData

  • getHyperCubeContinuousData(qPath, qOptions): Promise<{
        qAxisData: INxAxisData[];
        qDataPages: INxDataPage[];
    }>

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

    Note: Binning is done on the time stamp data as well as the date. This means that you can zoom in to a level of granularity as low as seconds.

    Parameters

    • qPath: string

      Path to the definition of the object. For example, /qHyperCubeDef. >> This parameter is mandatory.

    • qOptions: IContinuousDataOptions[]

      Array of (NxContinuousDataOptions) Options.NbrPoints is number of bins for binning. Options.MaxNbrTicks - maximum number of ticks.

    Returns Promise<{
        qAxisData: INxAxisData[];
        qDataPages: INxDataPage[];
    }>

    • A Promise or or

getHyperCubeData

  • getHyperCubeData(qPath, qPages): Promise<INxDataPage[]>

  • Retrieves the values of a chart, a table, or a scatter plot. It is possible to retrieve specific pages of data. Note: This method does not apply to stacked tables.

    Parameters

    • qPath: string

      Path to the definition of the object to be selected. For example, /qHyperCubeDef.

      This parameter is mandatory.

    • qPages: INxPage[]

      to retrieve.

      This parameter is mandatory.

    Returns Promise<INxDataPage[]>

    • A data set Array of NxDataPage

getHyperCubePivotData

  • getHyperCubePivotData(qPath, qPages): Promise<INxPivotPage[]>

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

    Parameters

    • qPath: string

      Path to the definition of the object to be selected. For example, /qHyperCubeDef.

      This parameter is mandatory.

    • qPages: INxPage[]

      Array of pages to retrieve

      This parameter is mandatory.

    Returns Promise<INxPivotPage[]>

    • A data set Array of NxPivotPage

getHyperCubeReducedData

  • getHyperCubeReducedData(qPath, qPages, qZoomFactor, qReductionMode): Promise<INxDataPage[]>

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

    Note: 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.

    Parameters

    • qPath: string

      Path to the definition of the object to be selected. For example, /qHyperCubeDef.

    • qPages: INxPage[]
    • qZoomFactor: number

      Defines the zoom factor. If set to -1, the engine decides of the zoom factor. If the reduction mode is D1 or S, the zoom factor is 2n. If the zoom factor is 5, the data are reduced by a factor 32. If the reduction mode is C, the zoom factor defines the number of centroids.

    • qReductionMode: ReductionModeType

      Defines the reduction mode. One of: - N for no data reduction. - D1 to reduce a bar chart or line chart. The profile of the chart is reduced whatever the number of dimensions in the chart. - S to reduce the resolution of a scatter plot. - C to reduce the data of a scatter plot chart. - ST to reduce the data of a stacked pivot table.

    Returns Promise<INxDataPage[]>

    • A data set Array of NxDataPage.

getHyperCubeStackData

  • getHyperCubeStackData(qPath, qPages, qMaxNbrCells?): Promise<INxStackPage[]>

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

    Parameters

    • qPath: string

      Path to the definition of the object to be selected. For example, /qHyperCubeDef.

    • qPages: INxPage[]
    • Optional qMaxNbrCells: number

      Maximum number of cells at outer level.

      This parameter is optional. The default value is 10 000.

    Returns Promise<INxStackPage[]>

    • A data set Array of NxStackPage.

getHyperCubeTreeData

  • getHyperCubeTreeData(qPath, qNodeOptions): Promise<INxTreeNode>

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

    Parameters

    • qPath: string

      Path to the definition of the object to be selected. For example, /qHyperCubeDef.

    • qNodeOptions: INxTreeDataOption[]

      Specifies all the paging filters needed to define the tree to be fetched.

    Returns Promise<INxTreeNode>

    • A data set Array of NxTreeNode.

getInfo

  • getInfo(): Promise<INxInfo>

  • Returns the type and identifier of the object.

    Returns Promise<INxInfo>

    • A Promise of NxInfo.

getLayout

  • getLayout(): Promise<IGenericBaseLayout>

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

    Note: In addition to the parameters displayed above, the GetLayout method can return other properties according to what is defined in the generic object. For example, if qHyperCubeDef is defined in the generic object, the GetLayout method returns the properties described in HyperCube.

    Returns Promise<IGenericBaseLayout>

    • A Promise of GenericBaseLayout.

getLinkedObjects

  • getLinkedObjects(): Promise<INxLinkedObjectInfo[]>

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

    Returns Promise<INxLinkedObjectInfo[]>

    • Array of NxLinkedObjectInfo

getListObjectContinuousData

  • getListObjectContinuousData(qPath, qOptions): Promise<{
        qAxisData: INxAxisData[];
        qDataPages: INxDataPage;
    }>

  • GetListObjectContinuousData method

    Parameters

    • qPath: string

      Path to the definition of the object. For example, /qHyperCubeDef. This parameter is mandatory.

    • qOptions: IContinuousDataOptions

      Options.NbrPoints is number of bins for binning.

      • Options.MaxNbrTicks - maximum number of ticks.

    Returns Promise<{
        qAxisData: INxAxisData[];
        qDataPages: INxDataPage;
    }>

    • A data set Array of (NxDataPage) or (NxAxisData)

getListObjectData

  • getListObjectData(qPath, qPages): Promise<INxDataPage[]>

  • Retrieves the values of a list object.

    Parameters

    • qPath: string

      Path to the definition of the object to be selected. For example, /qListObjectDef.

    • qPages: INxPage[]

      Array of pages you are interested in.

    Returns Promise<INxDataPage[]>

    • Array of NxDataPage

getProperties

  • getProperties(): Promise<IGenericObjectProperties>

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

    Note: If the member delta is set to true in the request object, only the delta is retrieved.

    Returns Promise<IGenericObjectProperties>

    • A Promise of GenericObjectProperties

getSnapshotObject

  • getSnapshotObject(): Promise<IGenericBookmark>

  • Returns the type of the object and the corresponding handle.

    Returns Promise<IGenericBookmark>

    • A Promise of GenericBookmark

lock

  • lock(qPath, qColIndices?): Promise<void>

  • Locks the selected values of a generic object.

    Parameters

    • qPath: string

      Path to the definition of the object. For example, /qListObjectDef.

    • Optional qColIndices: number[]

      Dimension numbers or dimension indexes where the lock should apply. Dimension numbers/indexes start from 0. This parameter is optional. If this parameter is not set, the selected values in all dimensions are locked.

    Returns Promise<void>

multiRangeSelectHyperCubeValues

  • multiRangeSelectHyperCubeValues(qPath, qRanges, qDeselectOnlyOneSelected, qColumnsToSelect?, qOrMode?): Promise<boolean>

  • Make range selections in measures.

    Note: This method applies to hypercubes. For example, bar charts, tables and scatter plots.

    Parameters

    • qPath: string

      Path to the definition of the object. For example, /qListObjectDef.

      This parameter is mandatory.

    • qRanges: INxMultiRangeSelectInfo

      Ranges of selection.

      This parameter is mandatory.

    • qDeselectOnlyOneSelected: boolean

      Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field.

      The default value is false.

    • Optional qColumnsToSelect: number[]

      Indicates which dimensions to select. The dimensions numbering starts at 0 (first dimension is 0). If the array is empty, all dimensions are selected.

      This parameter is optional.

    • Optional qOrMode: boolean

      Applies to hypercubes with multiple measures. If set to true, it means that at least one of the measures must be in the range of selections for the group of measures to be selected. If set to false, it means that all measures must be in the range of selections for the group of measures to be selected. This parameter is optional. The default value is false.

    Returns Promise<boolean>

    • true or false

on

  • on(event, func): void

  • register a function for events

    Parameters

    • event: "closed" | "changed"

      function called if this event occures

    • func: (() => void)

      function that is called

        • (): void

        • Returns void

    Returns void

publish

  • publish(): Promise<void>

  • Publishes a generic object.

    Note: This operation is possible only in Qlik Sense Enterprise.

    Returns Promise<void>

rangeSelectHyperCubeValues

  • rangeSelectHyperCubeValues(qPath, qRanges, qDeselectOnlyOneSelected, qColumnsToSelect?, qOrMode?): Promise<boolean>

  • Make range selections in measures. Note: This method applies to hypercubes. For example, bar charts, tables and scatter plots.

    Parameters

    • qPath: string

      Path to the definition of the object to be selected. For example, /qHyperCubeDef.

      This parameter is mandatory.

    • qRanges: INxRangeSelectInfo[]

      Ranges of selection.

      This parameter is mandatory.

    • qDeselectOnlyOneSelected: boolean

      Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field.

      The default value is false.

    • Optional qColumnsToSelect: number[]

      Indicates which dimensions to select. The dimensions numbering starts at 0 (first dimension is 0). If the array is empty, all dimensions are selected.

      This parameter is optional.

    • Optional qOrMode: boolean

      Applies to hypercubes with multiple measures. If set to true, it means that at least one of the measures must be in the range of selections for the group of measures to be selected. If set to false, it means that all measures must be in the range of selections for the group of measures to be selected. This parameter is optional. The default value is false.

    Returns Promise<boolean>

    • true or false

resetMadeSelections

  • resetMadeSelections(): Promise<void>

  • Resets all selections made in selection mode.

    Returns Promise<void>

searchListObjectFor

  • searchListObjectFor(qPath, qMatch): Promise<boolean>

  • Searches for a string in a list object.

    Note: This method applies to list objects (objects with one dimension). Note: The search results can be displayed using the GetLayout method.

    Parameters

    • qPath: string

      Path to the definition of the list object. For example, /qListObjectDef.

    • qMatch: string

      Search string. Wild card characters are allowed. The search is not case sensitive. Examples: PU: retrieves only values that start with P and contain U P U S: retrieves values that start with P, U or S

    Returns Promise<boolean>

    • The operation is successful if qSuccess is set to true.

selectHyperCubeCells

  • selectHyperCubeCells(qPath, qRowIndices, qColIndices, qSoftLock, qDeselectOnlyOneSelected): Promise<boolean>

  • Makes selections in multiple dimensions and measures.

    Note: This method applies to hypercubes, such as bar charts, tables and scatter plots.

    Parameters

    • qPath: string

      Path to the definition of the object to be selected. For example, /qHyperCubeDef. This parameter is mandatory.

    • qRowIndices: number[]

      Array of row indexes to select, starting from 0. If the array is empty [ ], all rows are selected.

      This parameter is mandatory.

    • qColIndices: number[]

      Indexes of the columns to select, starting from 0. A column corresponds to a dimension or a measure depending on the definition of the hypercube. Example: If the hypercube has two dimensions and one measure: [0] selects the first column (i.e the first dimension) [1] selects the second column (i.e the second dimension) [2] selects the third column (i.e the measure) If the array is empty [ ], all columns are selected.

      This parameter is mandatory.

    • qSoftLock: boolean

      Set to true to ignore locks; in that case, locked fields can be selected.

      This parameter is mandatory.

    • qDeselectOnlyOneSelected: boolean

      Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field. The default value is false.

    Returns Promise<boolean>

    • true or false.

selectHyperCubeContinuousRange

  • selectHyperCubeContinuousRange(qPath, qRanges, qSoftLock): Promise<boolean>

  • SelectHyperCubeContinuousRange method

    Parameters

    • qPath: string

      Path to the definition of the object. For example, /qHyperCubeDef.

      This parameter is mandatory.

    • qRanges: INxContinuousRangeSelectInfo[]

      Selects ranges in a hypercube in (Ranges[N].Min,Ranges[N].Max) intervals. If either Ranges[N].MinInclEq or Ranges[N].MaxInclEq, or both flags are set to true then Min and Max values will be selected.

    • qSoftLock: boolean

      Set to true to ignore locks; in that case, locked fields can be selected.

      This parameter is mandatory.

    Returns Promise<boolean>

    • true or false.

selectHyperCubeValues

  • selectHyperCubeValues(qPath, qDimNo, qValues, qToggleMode): Promise<boolean>

  • Selects some values in one dimension. The values are identified by their element numbers.

    Note: This method applies to charts, tables and scatter plots.

    Parameters

    • qPath: string

      Path to the definition of the object. For example, /qHyperCubeDef.

      This parameter is mandatory.

    • qDimNo: number

      Dimension number or index to select. Dimension numbers/index start from 0.

      This parameter is mandatory.

    • qValues: number[]

      Element numbers of the field to select. You can select multiple elements; the separator is the comma.

      This parameter is mandatory.

    • qToggleMode: boolean

      Set to true to toggle.

      This parameter is mandatory.

    Returns Promise<boolean>

    • true or false.

selectListObjectAll

  • selectListObjectAll(qPath, qSoftLock?): Promise<boolean>

  • Selects all values of a field.

    Note: This method applies to list objects (objects with one dimension).

    Parameters

    • qPath: string

      Path to the definition of the object to be selected. For example, /qListObjectDef.

      This parameter is mandatory.

    • Optional qSoftLock: boolean

      Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

      This parameter is optional.

    Returns Promise<boolean>

    • true or false.

selectListObjectAlternative

  • selectListObjectAlternative(qPath, qSoftLock?): Promise<boolean>

  • Selects all values of a field.

    Note: This method applies to list objects (objects with one dimension).

    Parameters

    • qPath: string

      Path to the definition of the object to be selected. For example, /qListObjectDef.

      This parameter is mandatory.

    • Optional qSoftLock: boolean

      Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

      This parameter is optional.

    Returns Promise<boolean>

    • true or false.

selectListObjectContinuousRange

  • selectListObjectContinuousRange(qPath, qRanges, qSoftLock?): Promise<boolean>

  • Parameters

    • qPath: string

      Path to the definition of the object to be selected. For example, /qListObjectDef.

      This parameter is mandatory.

    • qRanges: IRange[]

      Selects ranges in a hypercube in (Ranges[N].Min,Ranges[N].Max) intervals. If either Ranges[N].MinInclEq or Ranges[N].MaxInclEq, or both flags are set to true then Min and Max values will be selected.

    • Optional qSoftLock: boolean

      Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

      This parameter is optional.

    Returns Promise<boolean>

    • true or false.

selectListObjectExcluded

  • selectListObjectExcluded(qPath, qSoftLock?): Promise<boolean>

  • Inverts the current selections in a specific field.

    Note: This method applies to list objects (objects with one dimension).

    Parameters

    • qPath: string

      Path to the definition of the object to be selected. For example, /qListObjectDef.

      This parameter is mandatory.

    • Optional qSoftLock: boolean

      Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

      This parameter is optional.

    Returns Promise<boolean>

    • true or false.

selectListObjectPossible

  • selectListObjectPossible(qPath, qSoftLock?): Promise<boolean>

  • Selects all possible values of a list object.

    Note: This method applies to list objects (objects with one dimension).

    Parameters

    • qPath: string

      Path to the definition of the object to be selected. For example, /qListObjectDef.

      This parameter is mandatory.

    • Optional qSoftLock: boolean

      Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

      This parameter is optional.

    Returns Promise<boolean>

    • true or false.

selectListObjectValues

  • selectListObjectValues(qPath, qValues, qToggleMode, qSoftLock?): Promise<boolean>

  • Makes single selections in dimensions.

    Note: This method applies to list objects only.

    Parameters

    • qPath: string

      Path to the definition of the object to be selected. For example, /qListObjectDef.

      This parameter is mandatory.

    • qValues: number[]

      Element numbers to select. You can select multiple values; the separator is the comma.

      This parameter is mandatory.

    • qToggleMode: boolean

      Set to true to toggle.

      This parameter is mandatory.

    • Optional qSoftLock: boolean

      Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

      This parameter is optional.

    Returns Promise<boolean>

    • true or false.

selectPivotCells

  • selectPivotCells(qPath, qSelections, qDeselectOnlyOneSelected, qSoftLock?): Promise<boolean>

  • Note: 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.

    Note: There is no top dimensions in a stacked table. A stacked table can only contain one measure.

    Parameters

    • qPath: string

      Path to the definition of the object to be selected. For example, /qHyperCubeDef.

      This parameter is mandatory.

    • qSelections: INxSelectionCell[]

      Information about the selections to perform

    • qDeselectOnlyOneSelected: boolean

      Set this parameter to true to unselect the last single selected value. There must be only one selected value in the field. The default value is false.

    • Optional qSoftLock: boolean

      Set to true to ignore locks; in that case, locked fields can be selected. The default value is false.

      This parameter is optional.

    Returns Promise<boolean>

    • true or false.

setChildArrayOrder

  • setChildArrayOrder(qIds): Promise<void>

  • Sets the order of the children in a generic object.

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

    Parameters

    • qIds: string[]

    Returns Promise<void>

setFullPropertyTree

  • setFullPropertyTree(qPropEntry): Promise<void>

  • Sets the properties of:

    • a generic object
    • the children of the generic object
    • the bookmarks/embedded snapshots of the generic object

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

    Parameters

    • qPropEntry: IGenericObjectEntry

    Returns Promise<void>

setProperties

  • setProperties(qProp): Promise<void>

  • Sets some properties for a generic object.

    Note: In addition to the parameters specified above, the object can get any properties defined in the Generic objects section.

    Parameters

    • qProp: IGenericObjectProperties

    Returns Promise<void>

unPublish

  • unPublish(): Promise<void>

  • Unpublishes a generic object.

    Note: This operation is possible only in Qlik Sense Enterprise.

    Returns Promise<void>

unlock

  • unlock(qPath, qColIndices?): Promise<void>

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

    Parameters

    • qPath: string

      Path to the definition of the object. For example, /qListObjectDef.

    • Optional qColIndices: number[]

      Dimension numbers/indexes where the unlock should apply. Dimension numbers/indexes start from 0. This parameter is optional. If this parameter is not set, the locked values in all dimensions are unlocked.

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page