Interface IAppMixin

interface IAppMixin {
    genericType: string;
    global: IGlobal;
    handle: number;
    id: string;
    session: ISession;
    type: string;
    abortModal(qAccept): Promise<void>;
    addAlternateState(qStateName): Promise<void>;
    addFieldFromExpression(qName, qExpr): Promise<boolean>;
    applyBookmark(qId): Promise<boolean>;
    back(): Promise<void>;
    backCount(): Promise<number>;
    checkExpression(qExpr, qLabels?): Promise<ICheckExpressionResult>;
    checkNumberOrExpression(qExpr): Promise<ICheckNumberOrExpressionResult>;
    checkScriptSyntax(): Promise<IScriptSyntaxError[]>;
    clearAll(qLockedAlso, qStateName?): Promise<void>;
    clearSelections(qPath, qColIndices?): Promise<void>;
    clearUndoBuffer(): Promise<void>;
    cloneBookmark(qId): Promise<string>;
    cloneDimension(qId): Promise<string>;
    cloneMeasure(qId): Promise<string>;
    cloneObject(qId): Promise<string>;
    commitDraft(qId): Promise<void>;
    createBookmark(qProp): Promise<IGenericBookmark>;
    createConnection(qConnection): Promise<string>;
    createDimension(qProp): Promise<IGenericDimension>;
    createDraft(qId): Promise<string>;
    createMeasure(qProp): Promise<IGenericMeasure>;
    createObject(qProp): Promise<IGenericObject>;
    createObject(qProp): Promise<IGenericList>;
    createObject(qProp): Promise<IHyperCubeObject>;
    createObject(qProp): Promise<ISelectionListObject>;
    createObject(qProp): Promise<IBookmarkListObject>;
    createObject(qProp): Promise<IMeassureListObject>;
    createObject(qProp): Promise<IDimensionListObject>;
    createObject(qProp): Promise<IVariableListObject>;
    createObject(qProp): Promise<IFieldListObject>;
    createSessionObject(qProp): Promise<IGenericObject>;
    createSessionObject(qProp): Promise<IGenericList>;
    createSessionObject(qProp): Promise<IHyperCubeObject>;
    createSessionObject(qProp): Promise<ISelectionListObject>;
    createSessionObject(qProp): Promise<IBookmarkListObject>;
    createSessionObject(qProp): Promise<IMeassureListObject>;
    createSessionObject(qProp): Promise<IDimensionListObject>;
    createSessionObject(qProp): Promise<IVariableListObject>;
    createSessionObject(qProp): Promise<IFieldListObject>;
    createSessionVariable(qProp): Promise<IGenericVariable>;
    createVariable(qName): Promise<boolean>;
    createVariableEx(qProp): Promise<INxInfo>;
    deleteConnection(qConnectionId): Promise<void>;
    destroyBookmark(qId): Promise<boolean>;
    destroyDimension(qId): Promise<boolean>;
    destroyDraft(qId, qSourceId): Promise<boolean>;
    destroyMeasure(qId): Promise<boolean>;
    destroyObject(qId): Promise<boolean>;
    destroySessionObject(qId): Promise<boolean>;
    destroySessionVariable(qId): Promise<boolean>;
    destroyVariableById(qId): Promise<boolean>;
    destroyVariableByName(qName): Promise<boolean>;
    doReload(qMode?, qPartial?, qDebug?): Promise<boolean>;
    doReloadEx(qParams?): Promise<IDoReloadExResult>;
    doSave(qFileName?): Promise<void>;
    emit(event): void;
    evaluate(qExpression): Promise<string>;
    evaluateEx(qExpression): Promise<IFieldValue>;
    exportReducedData(qOptions?): Promise<{
        qDownloadInfo: any;
    }>;
    findMatchingFields(qFieldName, qTags): Promise<INxMatchingFieldInfo[]>;
    forward(): Promise<void>;
    forwardCount(): Promise<number>;
    getAllInfos(): Promise<INxInfo[]>;
    getAppLayout(): Promise<INxAppLayout>;
    getAppProperties(): Promise<INxAppProperties>;
    getAssociationScores(qTable1, qTable2): Promise<IAssociationScore>;
    getBookmark(qId): Promise<IGenericBookmark>;
    getBookmarks(qOptions): Promise<INxContainerEntry<any>>;
    getConnection(qConnectionId): Promise<IConnection>;
    getConnections(): Promise<IConnection[]>;
    getContentLibraries(): Promise<IContentLibraryList>;
    getDatabaseInfo(qConnectionId): Promise<IDatabaseInfo>;
    getDatabaseOwners(qConnectionId, qDatabase?): Promise<IDatabaseOwner[]>;
    getDatabaseTableFields(qConnectionId, qTable, qDatabase?, qOwner?): Promise<IDataField[]>;
    getDatabaseTablePreview(qConnectionId, qTable, qDatabase?, qOwner?): Promise<IDataRecord[]>;
    getDatabaseTables(qConnectionId, qDatabase?, qOwner?): Promise<IDataTable[]>;
    getDatabases(qConnectionId): Promise<IDatabase[]>;
    getDimension(qId): Promise<IGenericDimension>;
    getEmptyScript(qLocalizedMainSection?): Promise<string>;
    getFavoriteVariables(): Promise<string[]>;
    getField(qFieldName, qStateName?): Promise<IField>;
    getFieldDescription(qFieldName): Promise<IFieldDescription>;
    getFieldOnTheFlyByName(qReadableName): Promise<{
        qName: string;
    }>;
    getFileTableFields(qConnectionId, qDataFormat, qTable, qRelativePath?): Promise<{
        qFields: IDataField[];
        qFormatSpec: string;
    }>;
    getFileTablePreview(qConnectionId, qRelativePath, qDataFormat, qTable): Promise<{
        qFormatSpec: string;
        qPreview: IDataRecord[];
    }>;
    getFileTables(qConnectionId, qRelativePath, qDataFormat): Promise<IDataTable[]>;
    getFileTablesEx(qConnectionId, qRelativePath, qDataFormat): Promise<IDataTableEx[]>;
    getFolderItemsForConnection(qConnectionId, qRelativePath): Promise<IFolderItem[]>;
    getIncludeFileContent(qLibPath): Promise<string>;
    getLibraryContent(qName): Promise<IStaticContentList>;
    getLineage(): Promise<{
        qLineage: {
            qDiscriminator: string;
        }[];
    }>;
    getLocaleInfo(): Promise<ILocaleInfo>;
    getLooselyCoupledVector(): Promise<number[]>;
    getMatchingFields(qTags, qMatchingFieldMode?): Promise<INxMatchingFieldInfo[]>;
    getMeasure(qId): Promise<IGenericMeasure>;
    getMediaList(): Promise<MediaList[]>;
    getObject(qId): Promise<IGenericObject>;
    getObjects(qOptions): Promise<INxContainerEntry<any>>;
    getProperties(): Promise<INxAppProperties>;
    getScript(): Promise<string>;
    getScriptBreakpoints(): Promise<IEditorBreakpoint[]>;
    getSetAnalysis(qStateName?, qBookmarkId?): Promise<string>;
    getTableData(qOffset, qRows, qSyntheticMode, qTableName): Promise<ITableRow[]>;
    getTablesAndKeys(qWindowSize, qNullSize, qCellHeight, qSyntheticMode, qIncludeSysVars): Promise<{
        qk: ISourceKeyRecord[];
        qtr: ITableRecord[];
    }>;
    getTextMacros(): Promise<ITextMacro[]>;
    getVariable(qName): Promise<IVariable>;
    getVariableById(qId): Promise<IGenericVariable>;
    getVariableByName(qName): Promise<IGenericVariable>;
    getViewDlgSaveInfo(): Promise<ITableViewDlgSaveInfo>;
    guessFileType(qConnectionId, qRelativePath?): Promise<IFileDataFormat>;
    lockAll(qStateName?): Promise<void>;
    mBuild(arg): Promise<IUnbuildApp>;
    mCloneBookmark(sourceBookmarkId, title, description?, state?): Promise<string>;
    mCreateBookmarkFromMeta(bookmarkMeta, title, description?): Promise<string>;
    mCreateSessionListbox(fieldName, options?): Promise<{
        layout: IGenericBaseLayoutExt;
        obj: IGenericObject;
        props: IGenericObjectPropertiesExt;
        flattenData(): INxCellListBox[];
    }>;
    mExtensionObjectsAll(): Promise<IExtension[]>;
    mGetBookmarkMeta(bookmarkId, state?): Promise<IMBookmarkMeta>;
    mGetBookmarkValues(bookmarkId, state?): Promise<IBookmarkValue[]>;
    mGetBookmarksMeta(state?): Promise<IMBookmarkMeta[]>;
    mGetFields(): Promise<string[]>;
    mGetSyntheticTables(): Promise<ITableRecord[]>;
    mGetTables(): Promise<string[]>;
    mGetTablesAndFields(): Promise<{
        field: string;
        table: string;
    }[]>;
    mSelectInField(fieldName, values, toggle?, state?): Promise<{
        destroy: void;
        selectMore: void;
        selection: boolean;
    }>;
    mSelectInFieldBySearch(fieldName, searchTerm, toggle?, state?): Promise<boolean>;
    mSelectionsAll(): Promise<ISelectionListObject>;
    mSelectionsFields(): Promise<string[]>;
    mSelectionsSimple(): Promise<{
        field: string;
        values: string[];
    }[]>;
    mSelectionsSimpleGrouped(): Promise<{
        field: string;
        value: string;
    }[]>;
    mUnbuild(sections?): Promise<IUnbuildApp>;
    mVariableCreate(name, definition?, comment?): Promise<IGenericVariableProperties>;
    mVariableGetAll(showSession?, showReserved?): Promise<INxVariableListItem[]>;
    mVariableUpdateById(id, name?, definition?, comment?): Promise<IGenericVariableProperties>;
    mVariableUpdateByName(name, newName, definition?, comment?): Promise<IGenericVariableProperties>;
    migrateDerivedFields(): Promise<void>;
    migrateVariables(): Promise<void>;
    modifyConnection(qConnectionId, qConnection, qOverrideCredentials): Promise<void>;
    on(event, func): void;
    publish(qStreamId, qName): Promise<void>;
    redo(): Promise<boolean>;
    removeAlternateState(qStateName): Promise<void>;
    removeVariable(qName): Promise<boolean>;
    resume(): Promise<void>;
    saveObjects(): Promise<void>;
    scramble(qFieldName): Promise<void>;
    searchAssociations(qOptions, qTerms, qPage): Promise<void>;
    searchObjects(qOptions, qTerms, qPage): Promise<ISearchResult>;
    searchResults(qOptions, qTerms, qPage): Promise<ISearchResult>;
    searchSuggest(qOptions, qTerms): Promise<ISearchSuggestionResult>;
    selectAssociations(qOptions, qTerms, qMatchIx, qSoftLock): Promise<void>;
    sendGenericCommandToCustomConnector(qProvider, qCommand, qMethod, qParameters, qAppendConnection): Promise<string>;
    setAppProperties(qProp): Promise<void>;
    setFavoriteVariables(qNames): Promise<void>;
    setFetchLimit(qLimit): Promise<void>;
    setLooselyCoupledVector(qv): Promise<boolean>;
    setScript(qScript): Promise<void>;
    setScriptBreakpoints(qBreakpoints): Promise<void>;
    setViewDlgSaveInfo(qInfo): Promise<void>;
    undo(): Promise<boolean>;
    unlockAll(qStateName?): Promise<void>;
}

Hierarchy

  • IApp
    • IAppMixin

Properties

genericType global handle id session type

Methods

abortModal addAlternateState addFieldFromExpression applyBookmark back backCount checkExpression checkNumberOrExpression checkScriptSyntax clearAll clearSelections clearUndoBuffer cloneBookmark cloneDimension cloneMeasure cloneObject commitDraft createBookmark createConnection createDimension createDraft createMeasure createObject createSessionObject createSessionVariable createVariable createVariableEx deleteConnection destroyBookmark destroyDimension destroyDraft destroyMeasure destroyObject destroySessionObject destroySessionVariable destroyVariableById destroyVariableByName doReload doReloadEx doSave emit evaluate evaluateEx exportReducedData findMatchingFields forward forwardCount getAllInfos getAppLayout getAppProperties getAssociationScores getBookmark getBookmarks getConnection getConnections getContentLibraries getDatabaseInfo getDatabaseOwners getDatabaseTableFields getDatabaseTablePreview getDatabaseTables getDatabases getDimension getEmptyScript getFavoriteVariables getField getFieldDescription getFieldOnTheFlyByName getFileTableFields getFileTablePreview getFileTables getFileTablesEx getFolderItemsForConnection getIncludeFileContent getLibraryContent getLineage getLocaleInfo getLooselyCoupledVector getMatchingFields getMeasure getMediaList getObject getObjects getProperties getScript getScriptBreakpoints getSetAnalysis getTableData getTablesAndKeys getTextMacros getVariable getVariableById getVariableByName getViewDlgSaveInfo guessFileType lockAll mBuild mCloneBookmark mCreateBookmarkFromMeta mCreateSessionListbox mExtensionObjectsAll mGetBookmarkMeta mGetBookmarkValues mGetBookmarksMeta mGetFields mGetSyntheticTables mGetTables mGetTablesAndFields mSelectInField mSelectInFieldBySearch mSelectionsAll mSelectionsFields mSelectionsSimple mSelectionsSimpleGrouped mUnbuild mVariableCreate mVariableGetAll mVariableUpdateById mVariableUpdateByName migrateDerivedFields migrateVariables modifyConnection on publish redo removeAlternateState removeVariable resume saveObjects scramble searchAssociations searchObjects searchResults searchSuggest selectAssociations sendGenericCommandToCustomConnector setAppProperties setFavoriteVariables setFetchLimit setLooselyCoupledVector setScript setScriptBreakpoints setViewDlgSaveInfo undo unlockAll

Properties

genericType

genericType: string

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

global

global: IGlobal

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

abortModal

  • abortModal(qAccept): Promise<void>

  • Aborts any selection mode in an app. For more information about selection mode!

    Parameters

    • qAccept: boolean

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

    Returns Promise<void>

    • A promise of a Qlik engine reply.

addAlternateState

  • addAlternateState(qStateName): Promise<void>

  • You can create multiple states within a Qlik Sense app and apply these states to specific objects within the app. Objects in a given state are not affected by user selections in the other states.

    Parameters

    • qStateName: string

      Name of the alternate state. >> This parameter is mandatory.

    Returns Promise<void>

    • A promise of a Qlik engine reply.

addFieldFromExpression

  • addFieldFromExpression(qName, qExpr): Promise<boolean>

  • Adds a field on the fly. The expression of a field on the fly is persisted but not its values.

    Parameters

    • qName: string

      Name of the field.

    • qExpr: string

      Expression value. It is not possible to use all aggregation functions. For example, you cannot add a field on the fly with an expression that uses the Sum or Count aggregation functions.

    Returns Promise<boolean>

    • true or false

applyBookmark

  • applyBookmark(qId): Promise<boolean>

  • Applies a bookmark.

    Parameters

    • qId: string

      Identifier of the bookmark.

    Returns Promise<boolean>

    • true or false

back

  • back(): Promise<void>

  • Loads the last logical operation (if any).

    Returns Promise<void>

backCount

  • backCount(): Promise<number>

  • Returns the number of entries on the Back stack..

    Returns Promise<number>

    • "qReturn":

checkExpression

  • checkExpression(qExpr, qLabels?): Promise<ICheckExpressionResult>

  • Checks if a given expression is valid.

    Note: The expression is correct if the parameters qErrorMsg, qBadFieldNames and qDangerousFieldNames are empty.

    Parameters

    • qExpr: string

      Expression to check..

    • Optional qLabels: string[]

      (Array of String) List of labels. This parameter is optional.

    Returns Promise<ICheckExpressionResult>

    • A promise of a Qlik engine reply.

checkNumberOrExpression

  • checkNumberOrExpression(qExpr): Promise<ICheckNumberOrExpressionResult>

  • Checks if:

    • a given expression is valid
    • a number is correct according to the locale.

    Note: The expression is correct if the parameters qErrorMsg and qBadFieldNames are empty.

    Parameters

    • qExpr: string

      Expression to check.

    Returns Promise<ICheckNumberOrExpressionResult>

    • A promise of a Qlik engine reply.

checkScriptSyntax

  • checkScriptSyntax(): Promise<IScriptSyntaxError[]>

  • Checks the syntax of a script. If there are errors, the engine returns the following properties in the response:

    • qErrLen: (Integer) Length of the word where the error is located
    • qTabIx: (Integer) Number of the faulty section
    • qLineInTab: (Integer) Line number in the section where the error is located
    • qColInLine: (Integer) Position of the erroneous text from the beginning of the line
    • qTextPos: (Integer) Position of the erroneous text from the beginning of the script.
    • qSecondaryFailure: (Boolean) The default value is false.

    Note: The first area is the primary error area, the second area is the secondary error area. The second area is optional and is shown only if qSecondaryFailure is set to true. The second area ends when the next statement in the script begins.

    Returns Promise<IScriptSyntaxError[]>

clearAll

  • clearAll(qLockedAlso, qStateName?): Promise<void>

  • Clears all selections in all fields of the current app.

    Parameters

    • qLockedAlso: boolean

      This parameter is optional. Default is false. Selections on locked fields are not cleared. Set this parameter to true to clear all selections, including the locked fields.

    • Optional qStateName: string

      Name of the alternate state. If an alternate state is defined in qStateName, only the selections related to this alternate state are cleared. This parameter is optional. Default state is current selections.

    Returns Promise<void>

    • A promise of a Qlik engine reply.

clearSelections

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

  • Parameters

    • qPath: "/qListObjectDef"
    • Optional qColIndices: number[]

    Returns Promise<void>

clearUndoBuffer

  • clearUndoBuffer(): Promise<void>

  • Clears entirely the undo and redo buffer.

    Returns Promise<void>

    • A promise of a Qlik engine reply.

cloneBookmark

  • cloneBookmark(qId): Promise<string>

  • Clones a bookmark.

    Parameters

    • qId: string

      Identifier of the object to clone

    Returns Promise<string>

    • A promise of a Qlik engine reply.

cloneDimension

  • cloneDimension(qId): Promise<string>

  • Clones a dimension.

    Note: The identifier is set by the engine.

    Parameters

    • qId: string

      Identifier of the object to clone

    Returns Promise<string>

    • A promise of a Qlik engine reply.

cloneMeasure

  • cloneMeasure(qId): Promise<string>

  • Clones a measure.

    Note: The identifier is set by the engine.

    Parameters

    • qId: string

      Identifier of the object to clone

    Returns Promise<string>

    • A promise of a Qlik engine reply.

cloneObject

  • cloneObject(qId): Promise<string>

  • Clones any visualizations, sheets and stories. The clone method works for both app objects and child objects. When you clone an object that contains children, the children are cloned as well.

    Note: The identifier is set by the engine.

    Parameters

    • qId: string

      Identifier of the object to clone

    Returns Promise<string>

    • A promise of a Qlik engine reply.

commitDraft

  • commitDraft(qId): Promise<void>

  • Commits the draft of an object that was previously created by invoking the CreateDraft method. Committing a draft replaces the corresponding published object.

    Note: The identifier is set by the engine.

    Parameters

    • qId: string

      Identifier of the draft to commit.

    Returns Promise<void>

    • A promise of a Qlik engine reply.

createBookmark

  • createBookmark(qProp): Promise<IGenericBookmark>

  • Creates a bookmark.

    Parameters

    • qProp: IGenericBookmarkProperties

      Information about the object. >> This parameter is mandatory.

    Returns Promise<IGenericBookmark>

    • A promise of a Qlik engine reply.

createConnection

  • createConnection(qConnection): Promise<string>

  • Creates a connection. A connection indicates from which data source, the data should be taken.

    Parameters

    • qConnection: IConnection

      Information about the connection. >> This parameter is mandatory.

    Returns Promise<string>

    • returns a ConnectionId

createDimension

  • createDimension(qProp): Promise<IGenericDimension>

  • Creates a master dimension. A master dimension is stored in the library of an app and can be used in many objects. Several generic objects can contain the same dimension.

    Parameters

    • qProp: IGenericDimensionProperties

      Information about the properties. >> This parameter is mandatory.

    Returns Promise<IGenericDimension>

    • returns a GenericDimension object

createDraft

  • createDraft(qId): Promise<string>

  • Creates a draft of an object. This method can be used to create a draft of a sheet or a story that is published. This is a way to continue working on a sheet or a story that is published. Replace the published object by the content of the draft by invoking the CommitDraft method.

    Note: The identifier is set by the engine.

    Parameters

    • qId: string

      Identifier of the object to create a draft from.

    Returns Promise<string>

    • returns a DraftId

createMeasure

  • createMeasure(qProp): Promise<IGenericMeasure>

  • Creates a master measure. A master measure is stored in the library of an app and can be used in many objects. Several generic objects can contain the same measure.

    Parameters

    • qProp: IGenericMeasureProperties

    Returns Promise<IGenericMeasure>

    • returns a GenericMeasure

createObject

  • createObject(qProp): Promise<IGenericObject>

  • Creates a generic object at app level. It is possible to create a generic object that is linked to another object. A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in qExtendsId). The linked object has the same properties as the linking object. Notre: The linking object cannot be a transient object.

    Parameters

    • qProp: IGenericObjectProperties

    Returns Promise<IGenericObject>

    • returns a GenericObject
  • createObject(qProp): Promise<IGenericList>

  • Parameters

    • qProp: IGenericListProperties

    Returns Promise<IGenericList>

  • createObject(qProp): Promise<IHyperCubeObject>

  • Parameters

    • qProp: IGenericHyperCubeProperties

    Returns Promise<IHyperCubeObject>

  • createObject(qProp): Promise<ISelectionListObject>

  • Parameters

    • qProp: IGenericSelectionListProperties

    Returns Promise<ISelectionListObject>

  • createObject(qProp): Promise<IBookmarkListObject>

  • Parameters

    • qProp: IGenericBookmarkListProperties

    Returns Promise<IBookmarkListObject>

  • createObject(qProp): Promise<IMeassureListObject>

  • Parameters

    • qProp: IGenericMeasureListProperties

    Returns Promise<IMeassureListObject>

  • createObject(qProp): Promise<IDimensionListObject>

  • Parameters

    • qProp: IGenericDimensionsListProperties

    Returns Promise<IDimensionListObject>

  • createObject(qProp): Promise<IVariableListObject>

  • Parameters

    • qProp: IGenericVariableListProperties

    Returns Promise<IVariableListObject>

  • createObject(qProp): Promise<IFieldListObject>

  • Parameters

    • qProp: IGenericFieldListProperties

    Returns Promise<IFieldListObject>

createSessionObject

  • createSessionObject(qProp): Promise<IGenericObject>

  • Creates a transient object. For example, you can use a transient object to create an app overview or a story overview. It is possible to create a transient object that is linked to another object. A linked object is an object that points to a linking object. The linking object is defined in the properties of the linked object (in qExtendsId). The linked object has the same properties as the linking object.

    Parameters

    • qProp: IGenericObjectProperties

    Returns Promise<IGenericObject>

    • returns a GenericObject
  • createSessionObject(qProp): Promise<IGenericList>

  • Parameters

    • qProp: IGenericListProperties

    Returns Promise<IGenericList>

  • createSessionObject(qProp): Promise<IHyperCubeObject>

  • Parameters

    • qProp: IGenericHyperCubeProperties

    Returns Promise<IHyperCubeObject>

  • createSessionObject(qProp): Promise<ISelectionListObject>

  • Parameters

    • qProp: IGenericSelectionListProperties

    Returns Promise<ISelectionListObject>

  • createSessionObject(qProp): Promise<IBookmarkListObject>

  • Parameters

    • qProp: IGenericBookmarkListProperties

    Returns Promise<IBookmarkListObject>

  • createSessionObject(qProp): Promise<IMeassureListObject>

  • Parameters

    • qProp: IGenericMeasureListProperties

    Returns Promise<IMeassureListObject>

  • createSessionObject(qProp): Promise<IDimensionListObject>

  • Parameters

    • qProp: IGenericDimensionsListProperties

    Returns Promise<IDimensionListObject>

  • createSessionObject(qProp): Promise<IVariableListObject>

  • Parameters

    • qProp: IGenericVariableListProperties

    Returns Promise<IVariableListObject>

  • createSessionObject(qProp): Promise<IFieldListObject>

  • Parameters

    • qProp: IGenericFieldListProperties

    Returns Promise<IFieldListObject>

createSessionVariable

  • createSessionVariable(qProp): Promise<IGenericVariable>

  • Creates a transient variable.

    Parameters

    • qProp: IGenericVariableProperties

    Returns Promise<IGenericVariable>

    • returns a GenericVariable

createVariable

  • createVariable(qName): Promise<boolean>

  • Creates a variable.

    Note: This method is deprecated (not recommended to use). Use CreateVariableEx method instead.

    Parameters

    • qName: string

      Name of the variable. Variable names are case sensitive. >> This parameter is mandatory.

    Returns Promise<boolean>

    • returns a Boolean

createVariableEx

  • createVariableEx(qProp): Promise<INxInfo>

  • Creates a variable.

    Note: This method is deprecated (not recommended to use). Use CreateVariableEx method instead.

    Parameters

    • qProp: IGenericVariableProperties

      Name of the variable. Variable names are case sensitive and must be unique. >> This parameter is mandatory.

    Returns Promise<INxInfo>

    • returns a NxInfo. Identifier and type of the object. >> This parameter is mandatory.

deleteConnection

  • deleteConnection(qConnectionId): Promise<void>

  • Deletes a connection. The AttachedFiles connection can only be removed by the administrator of the system.

    Note: In Qlik Sense Enterprise, there is an additional file connection named AttachedFiles.

    Parameters

    • qConnectionId: string

      Identifier of the connection to remove. >> This parameter is mandatory.

    Returns Promise<void>

    • A promise of a Qlik engine reply.

destroyBookmark

  • destroyBookmark(qId): Promise<boolean>

  • Removes a bookmark.

    Note: The operation is successful if qSuccess is set to true.

    Parameters

    • qId: string

      Identifier of the bookmark

    Returns Promise<boolean>

    • A promise of Boolean

destroyDimension

  • destroyDimension(qId): Promise<boolean>

  • Removes a dimension.

    Note: The operation is successful if qSuccess is set to true.

    Parameters

    • qId: string

      Identifier of the dimension to remove. >> This parameter is mandatory.

    Returns Promise<boolean>

    • A promise of Boolean

destroyDraft

  • destroyDraft(qId, qSourceId): Promise<boolean>

  • Removes a dimension.

    Note: The operation is successful if qSuccess is set to true.

    Parameters

    • qId: string

      Identifier of the draft object to remove. >> This parameter is mandatory.

    • qSourceId: string

      Identifier of the source object (the object from which a draft was created).

    Returns Promise<boolean>

    • A promise of Boolean

destroyMeasure

  • destroyMeasure(qId): Promise<boolean>

  • Removes a generic measure.

    Note: The operation is successful if qSuccess is set to true.

    Parameters

    • qId: string

      Identifier of the measure to remove. >> This parameter is mandatory.

    Returns Promise<boolean>

    • A promise of Boolean

destroyObject

  • destroyObject(qId): Promise<boolean>

  • Removes an app object.

    Note: The operation is successful if qSuccess is set to true.

    Parameters

    • qId: string

      Identifier of the object to remove. >> This parameter is mandatory.

    Returns Promise<boolean>

    • A promise of Boolean

destroySessionObject

  • destroySessionObject(qId): Promise<boolean>

  • Removes a transient object.

    Note: The operation is successful if qSuccess is set to true.

    Parameters

    • qId: string

      Identifier of the object to remove. >> This parameter is mandatory.

    Returns Promise<boolean>

    • A promise of Boolean

destroySessionVariable

  • destroySessionVariable(qId): Promise<boolean>

  • Removes a transient variable.

    Note: The operation is successful if qSuccess is set to true.

    Parameters

    • qId: string

      Identifier of the object to remove. >> This parameter is mandatory.

    Returns Promise<boolean>

    • A promise of Boolean

destroyVariableById

  • destroyVariableById(qId): Promise<boolean>

  • Removes a variable.

    Note: The operation is successful if qSuccess is set to true. Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method.

    Parameters

    • qId: string

      Identifier of the variable.

    Returns Promise<boolean>

    • A promise of Boolean

destroyVariableByName

  • destroyVariableByName(qName): Promise<boolean>

  • Removes a variable.

    Note: The operation is successful if qSuccess is set to true. Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method.

    Parameters

    • qName: string

      Name of the variable..

    Returns Promise<boolean>

    • A promise of Boolean

doReload

  • doReload(qMode?, qPartial?, qDebug?): Promise<boolean>

  • Reloads the script that is set in an app.

    Note: The operation is successful if qSuccess is set to true.

    Parameters

    • Optional qMode: number

      Error handling mode.

      0: for default mode 1: for ABEND; the reload of the script ends if an error occurs 2: for ignore; the reload of the script continues even if an error is detected in the script.

      This parameter is optional.

    • Optional qPartial: boolean

      Set to true for partial reload. This parameter is optional. The default value is false.

    • Optional qDebug: boolean

      Set to true if debug breakpoints are to be honored. The execution of the script will be in debug mode. This parameter is optional. The default value is false.

    Returns Promise<boolean>

    • A promise of Boolean

doReloadEx

  • doReloadEx(qParams?): Promise<IDoReloadExResult>

  • Reloads the script that is set in an app and returns the path to the script log file.

    Note: A log file is created per reload.

    Parameters

    • Optional qParams: IDoReloadExParams

      This parameter is optional.

    Returns Promise<IDoReloadExResult>

    • If the data load has successfully finished, no matter how the indexing behaves, true is returned. This happens even if there is a timeout, a memory limit is reached or any other error occurs during the indexing.

doSave

  • doSave(qFileName?): Promise<void>

  • Saves an app. All objects and data in the data model are saved. Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method.

    Parameters

    • Optional qFileName: string

      Name of the file to save. This parameter is optional.

    Returns Promise<void>

    • A promise of a Qlik engine reply.

emit

  • emit(event): void

  • manual emit an events

    Parameters

    • event: "closed" | "changed"

      event that occures

    Returns void

evaluate

  • evaluate(qExpression): Promise<string>

  • Evaluates an expression as a string. Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method.

    Parameters

    • qExpression: string

      Expression to evaluate.

    Returns Promise<string>

    • return a expression evaluated as a string

evaluateEx

  • evaluateEx(qExpression): Promise<IFieldValue>

  • Evaluates an expression as a dual. Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method.

    Parameters

    • qExpression: string

      Expression to evaluate.

    Returns Promise<IFieldValue>

    • return a Promise with a FieldValue

exportReducedData

  • exportReducedData(qOptions?): Promise<{
        qDownloadInfo: any;
    }>

  • Export an Qlik QVF with a reduced datamodel

    Parameters

    • Optional qOptions: {
          qBookmarkId?: string;
          qExpires?: number;
      }

      qBookmarkId - bookmark to export qExpires - download expires in [s]

      • Optional qBookmarkId?: string
      • Optional qExpires?: number

    Returns Promise<{
        qDownloadInfo: any;
    }>

    • return a Promise with the qDownloadInfo

findMatchingFields

  • findMatchingFields(qFieldName, qTags): Promise<INxMatchingFieldInfo[]>

  • Retrieves any fields that belong to the same archipelago as the specified field and that match at least one of the specified tags. Tags set by Qlik Sense are prefixed by the $ sign.

    Parameters

    • qFieldName: string

      Name of the field. This method looks for fields that belong to the same archipelago as this specified field.

    • qTags: string[]

      List of tags. This method looks for fields that match at least one of the tags in this list.

    Returns Promise<INxMatchingFieldInfo[]>

    • A promise of FieldValue.

forward

  • forward(): Promise<void>

  • Loads the next logical operation (if any).

    Returns Promise<void>

    • A promise of a Qlik engine reply.

forwardCount

  • forwardCount(): Promise<number>

  • Returns the number of entries on the Forward stack.

    Returns Promise<number>

    • A promise and Number of entries in the forward stack

getAllInfos

  • getAllInfos(): Promise<INxInfo[]>

  • Returns the identifier and the type of any generic object in the app. Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method.

    Returns Promise<INxInfo[]>

    • return a Promise Array of INxInfo

getAppLayout

  • getAppLayout(): Promise<INxAppLayout>

  • Returns dynamic properties (if any) in addition to the engine (fixed) properties. Script-defined variables cannot be removed using the DestroyVariableById method or the DestroyVariableByName method.

    Returns Promise<INxAppLayout>

    • return a Promise of a data set NxAppLayout

getAppProperties

  • getAppProperties(): Promise<INxAppProperties>

  • Gets the properties of an app.

    Returns Promise<INxAppProperties>

    • return a Promise of NxAppProperties qProp. Information about the properties of the app.

getAssociationScores

  • getAssociationScores(qTable1, qTable2): Promise<IAssociationScore>

  • Computes a set of association scores for each pair of fields between two given tables that have been loaded in an app.

    Parameters

    • qTable1: string

      Name of the first table.

    • qTable2: string

      Name of the second table.

    Returns Promise<IAssociationScore>

    • return a Promise of IAssociationScore qScore.

getBookmark

  • getBookmark(qId): Promise<IGenericBookmark>

  • Returns the handle of a bookmark.

    Parameters

    • qId: string

      Identifier of the bookmark.

    Returns Promise<IGenericBookmark>

    • return a Promise of IGenericBookmark.

getBookmarks

  • getBookmarks(qOptions): Promise<INxContainerEntry<any>>

  • Returns a list of bookmarks in the app.

    Parameters

    • qOptions: INxGetBookmarkOptions

      Information about the list of bookmarks.

    Returns Promise<INxContainerEntry<any>>

    • return a Promise of INxContainerEntry.

getConnection

  • getConnection(qConnectionId): Promise<IConnection>

  • Retrieves a connection and returns:

    • The creation time of the connection
    • The identifier of the connection
    • The type of the connection
    • The name of the connection
    • The connection string

    Parameters

    • qConnectionId: string

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

    Returns Promise<IConnection>

    • return a Connection.

getConnections

  • getConnections(): Promise<IConnection[]>

  • Lists the connections in an app.

    Note: In Qlik Sense Enterprise, there is an additional file connection named AttachedFiles. This connection is stored in the Qlik Sense repository.

    Returns Promise<IConnection[]>

    • return a Promise of Array of Connection.

getContentLibraries

  • getContentLibraries(): Promise<IContentLibraryList>

  • Lists the content libraries. To differentiate a global content library from an app specific content library, you can check the property qAppSpecific. If this property is set to true, it means that the content library is app specific.

    Note: There is always one specific content library per app.

    Returns Promise<IContentLibraryList>

    • return a Promise of ContentLibraryList.

getDatabaseInfo

  • getDatabaseInfo(qConnectionId): Promise<IDatabaseInfo>

  • Gives information about an ODBC, OLEDB or CUSTOM connection.

    Parameters

    • qConnectionId: string

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

    Returns Promise<IDatabaseInfo>

    • return a Promise of DatabaseInfo.

getDatabaseOwners

  • getDatabaseOwners(qConnectionId, qDatabase?): Promise<IDatabaseOwner[]>

  • Lists the owners of a database for a ODBC, OLEDB or CUSTOM connection.

    Parameters

    • qConnectionId: string

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

    • Optional qDatabase: string

      Name of the database. >> This parameter is mandatory.

    Returns Promise<IDatabaseOwner[]>

    • return a Promise Array of DatabaseOwner.

getDatabaseTableFields

  • getDatabaseTableFields(qConnectionId, qTable, qDatabase?, qOwner?): Promise<IDataField[]>

  • Lists the fields inside a table of a database for a ODBC, OLEDB or CUSTOM connection.

    Parameters

    • qConnectionId: string

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

    • qTable: string

      Name of the table. >> This parameter is mandatory.

    • Optional qDatabase: string

      Name of the database. >> This parameter is mandatory. (If qDatabase is not set then qOwner must be set.)

    • Optional qOwner: string

      Owner of the database. >> This parameter is mandatory. (If qOwner is not set then qDatabase must be set.)

    Returns Promise<IDataField[]>

    • return a Promise Array of DataField.

getDatabaseTablePreview

  • getDatabaseTablePreview(qConnectionId, qTable, qDatabase?, qOwner?): Promise<IDataRecord[]>

  • Retrieves the values of the specified table of a database for a ODBC, OLEDB or CUSTOM connection.

    Parameters

    • qConnectionId: string

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

    • qTable: string

      Name of the table. >> This parameter is mandatory.

    • Optional qDatabase: string

      Name of the database. >> This parameter is mandatory. (If qDatabase is not set then qOwner must be set.)

    • Optional qOwner: string

      Owner of the database. >> This parameter is mandatory. (If qOwner is not set then qDatabase must be set.)

    Returns Promise<IDataRecord[]>

    • return a Promise Array of DataRecord.

getDatabaseTables

  • getDatabaseTables(qConnectionId, qDatabase?, qOwner?): Promise<IDataTable[]>

  • Lists the tables inside a database for a ODBC, OLEDB or CUSTOM connection.

    Parameters

    • qConnectionId: string

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

    • Optional qDatabase: string

      Name of the database. >> This parameter is mandatory. (If qDatabase is not set then qOwner must be set.)

    • Optional qOwner: string

      Owner of the database. >> This parameter is mandatory. (If qOwner is not set then qDatabase must be set.)

    Returns Promise<IDataTable[]>

    • return a Promise Array of DataTable.

getDatabases

  • getDatabases(qConnectionId): Promise<IDatabase[]>

  • Lists the databases inside a ODBC, OLEDB or CUSTOM data source.

    Parameters

    • qConnectionId: string

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

    Returns Promise<IDatabase[]>

    • return a Promise Array of Database.

getDimension

  • getDimension(qId): Promise<IGenericDimension>

  • Returns the handle of a dimension.

    Parameters

    • qId: string

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

    Returns Promise<IGenericDimension>

    • return a Promise GenericDimension.

getEmptyScript

  • getEmptyScript(qLocalizedMainSection?): Promise<string>

  • Creates a script that contains one section. This section contains Set statements that give localized information from the regional settings of the computer.

    Note: The computer regional settings are retrieved when the engine starts.

    Parameters

    • Optional qLocalizedMainSection: string

      Name of the script section. The default value is Main. This parameter is optional.

    Returns Promise<string>

    • return a Promise .

getFavoriteVariables

  • getFavoriteVariables(): Promise<string[]>

  • Retrieves the variables that are tagged as favorite.

    Returns Promise<string[]>

    • return a Promise Array of String

getField

  • getField(qFieldName, qStateName?): Promise<IField>

  • Retrieves the description of a field.

    Parameters

    • qFieldName: string

      Name of the field. >> This parameter is mandatory.

    • Optional qStateName: string

      Name of the alternate state. This parameter is optional. Default state is current selections.

    Returns Promise<IField>

    • return a Promise of FieldDescription.

getFieldDescription

  • getFieldDescription(qFieldName): Promise<IFieldDescription>

  • Retrieves the description of a field.

    Parameters

    • qFieldName: string

      Name of the field. >> This parameter is mandatory

    Returns Promise<IFieldDescription>

    • return a Promise of FieldDescription.

getFieldOnTheFlyByName

  • getFieldOnTheFlyByName(qReadableName): Promise<{
        qName: string;
    }>

  • Fetches the Expression behind a Field that is declared with DECLARE FIELD DEFINITIO

    Parameters

    • qReadableName: string

    Returns Promise<{
        qName: string;
    }>

    qname wich contains the expression

getFileTableFields

  • getFileTableFields(qConnectionId, qDataFormat, qTable, qRelativePath?): Promise<{
        qFields: IDataField[];
        qFormatSpec: string;
    }>

  • Lists the fields of a table for a folder connection.

    Parameters

    • qConnectionId: string

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

    • qDataFormat: IFileDataFormat

      Type of the file.

    • qTable: string

      Name of the table. This parameter must be set for XLS, XLSX, HTML and XML files.

    • Optional qRelativePath: string

      Path of the connection file. This parameter is optional.

    Returns Promise<{
        qFields: IDataField[];
        qFormatSpec: string;
    }>

    • return a Promise Array of DataField or String.

getFileTablePreview

  • getFileTablePreview(qConnectionId, qRelativePath, qDataFormat, qTable): Promise<{
        qFormatSpec: string;
        qPreview: IDataRecord[];
    }>

  • Lists the values in a table for a folder connection.

    Parameters

    • qConnectionId: string

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

    • qRelativePath: string

      Path of the connection file. This parameter is optional.

    • qDataFormat: IFileDataFormat

      Type of the file.

    • qTable: string

      Name of the table. This parameter must be set for XLS, XLSX, HTML and XML files.

    Returns Promise<{
        qFormatSpec: string;
        qPreview: IDataRecord[];
    }>

    • return a Promise or .

getFileTables

  • getFileTables(qConnectionId, qRelativePath, qDataFormat): Promise<IDataTable[]>

  • Lists the tables for a folder connection.

    Parameters

    • qConnectionId: string

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

    • qRelativePath: string

      Path of the connection file. This parameter is optional.

    • qDataFormat: IFileDataFormat

      Type of the file.

    Returns Promise<IDataTable[]>

    • return a Promise Array of DataTable.

getFileTablesEx

  • getFileTablesEx(qConnectionId, qRelativePath, qDataFormat): Promise<IDataTableEx[]>

  • Lists the tables and fields of a JSON or XML file for a folder connection.

    Parameters

    • qConnectionId: string

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

    • qRelativePath: string

      Path of the connection file. This parameter is optional.

    • qDataFormat: IFileDataFormat

      Type of the file.

    Returns Promise<IDataTableEx[]>

    • return a Promise Array of DataTableEx.

getFolderItemsForConnection

  • getFolderItemsForConnection(qConnectionId, qRelativePath): Promise<IFolderItem[]>

  • There are two ways to specify the directory to retrieve the files from:

    • Enter the connection identifier; the directory associated to the connection is used.
    • Enter the connection identifier and a relative path

    Parameters

    • qConnectionId: string

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

    • qRelativePath: string

      Path of the connection file. This parameter is optional.

    Returns Promise<IFolderItem[]>

    • return a Promise Array of FolderItem.

getIncludeFileContent

  • getIncludeFileContent(qLibPath): Promise<string>

  • Gets the content of a file.

    Parameters

    • qLibPath: string

      ["lib://CONNECTION_NAME\.txt"] or

      • ["lib://Connection_Name\\.txt"]
      • should be used when having a lib reference in the first variable.

    Returns Promise<string>

    • return a Promise of String.

getLibraryContent

  • getLibraryContent(qName): Promise<IStaticContentList>

  • Returns the content of a library.

    Parameters

    • qName: string

      Name of the content library. It corresponds to the property qContentLibraryListItem/qName returned by the GetContentLibraries method.

    Returns Promise<IStaticContentList>

    • return a Promise of StaticContentList.

getLineage

  • getLineage(): Promise<{
        qLineage: {
            qDiscriminator: string;
        }[];
    }>

  • Returns the lineage of the datamodel.

    Returns Promise<{
        qLineage: {
            qDiscriminator: string;
        }[];
    }>

    • return a Promise of qLineage.

getLocaleInfo

  • getLocaleInfo(): Promise<ILocaleInfo>

  • Retrieves locale information.

    Returns Promise<ILocaleInfo>

    • return a Promise of LocaleInfo.

getLooselyCoupledVector

  • getLooselyCoupledVector(): Promise<number[]>

  • Returns a vector of loosely coupled state flags, one element for each table in the app. so that the circular references do not create a loop. Where is an array of state flags, one for each table in the app.

    0 means that the table is not loose 1 means that the table is loose 2 means that the table is always loose and cannot be unloose using the Qlik Engine API.

    Note: The last three values in the vector are extra values. These values are for internal use. Note: In case of circular references, the engine automatically create loosely coupled tables

    Returns Promise<number[]>

    • return a Promise .

getMatchingFields

  • getMatchingFields(qTags, qMatchingFieldMode?): Promise<INxMatchingFieldInfo[]>

  • Retrieves any fields that match all or one of the specified tags in the data model of an app.

    Note: Tags set by Qlik Sense are prefixed by the $ sign.

    Parameters

    • qTags: string[]

      List of tags. Array of String The GetMatchingFields method looks for fields that match one or all of the tags in this list, depending on the value of qMatchingFieldMode.

    • Optional qMatchingFieldMode: boolean

      Matching field mode. This parameter is optional. The default value is 0.

    Returns Promise<INxMatchingFieldInfo[]>

    • return a Promise Array of NxMatchingFieldInfo.

getMeasure

  • getMeasure(qId): Promise<IGenericMeasure>

  • Returns the handle of a measure.

    Parameters

    • qId: string

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

    Returns Promise<IGenericMeasure>

    • return a Promise String GenericMeasure

getMediaList

  • getMediaList(): Promise<MediaList[]>

  • Lists the media files.

    Note: This method is deprecated (not recommended to use). Use GetLibraryContent method instead.

    Returns Promise<MediaList[]>

    • return a Promise Boolean or MediaList

getObject

  • getObject(qId): Promise<IGenericObject>

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

    Parameters

    • qId: string

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

    Returns Promise<IGenericObject>

    • return a Promise String GenericObject

getObjects

  • getObjects(qOptions): Promise<INxContainerEntry<any>>

  • Returns a list of objects in the app.

    Parameters

    • qOptions: INxGetObjectOptions

      Information about the list of objects.

    Returns Promise<INxContainerEntry<any>>

    • return a Promise array of NxContainerEntry.

getProperties

  • getProperties(): Promise<INxAppProperties>

  • Shows the properties of an object.

    Returns the identifier and the definition of the measure.

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

    Returns Promise<INxAppProperties>

    • return a Promise GenericObject

getScript

  • getScript(): Promise<string>

  • Gets values in script.

    Returns Promise<string>

    • return a Promise String