angular-qlik-api/class/document.class.d.ts

AngulerQlikApi is the angular wrapper for Qlik Engine API. It facilitates the usage and handles the synchronization.

import { Deferred } from './deferred.class';
import { HyperCube } from './hyper-cube.class';
import { List } from './list.class';
import { QGenericBookmarkProperties } from '../interface/q-generic-bookmark-properties.interface';
import { QConnection } from '../interface/q-connection.interface';
import { QGenericDimensionProperties } from '../interface/q-generic-dimension-properties.interface';
import { QGenericMeasureProperties } from '../interface/q-generic-measure-properties.interface';
import { QGenericObjectProperties } from '../interface/q-generic-object-properties.interface';
import { QGenericVariableProperties } from '../interface/q-generic-variable-properties.interface';
import { QMode } from '../enum/q-mode.enum';
import { QInfo } from '../interface/q-info.interface';
import { QFilterInfo } from '../interface/q-filter-info.interface';
import { QFileDataFormat } from '../interface/q-file-data-format.interface';
import { QLineageInfo } from '../interface/q-lineage-info.interface';
import { QMatchingFieldMode } from '../enum/q-matching-field-mode.enum';
import { QObjectOptions } from '../interface/q-object-options.interface';
import { QSearchCombinationOptions } from '../interface/q-search-combination.interface';
import { QSize } from '../interface/q-size.interface';
import { QSearchPage } from '../interface/q-search-page.interface';
import { QSearchObjectOptions } from '../interface/q-search-object-options.interface';
import { QCommand } from '../enum/q-command.enum';
import { QAppProperties } from '../interface/q-app-properties.interface';
import { QEditorBreakpoint } from '../interface/q-editor-breakpoint.interface';
import { Bookmark } from './bookmark.class';
import { Field } from './field.class';
import { GenericMeasure } from './generic-measure.class';
import { GenericDimension } from './generic-dimension.class';
export declare class Document {
    globalService: any;
    id: number;
    docId: string;
    deferred: Deferred<number>;
    hyperCubeList: any;
    listList: any;
    bookmarkList: any;
    fieldList: any;
    constructor(docId: string, service: any);
    createHyperCube(): HyperCube;
    removeHyperCube(id: string): void;
    createList(): List;
    refreshAll(): void;
    private onDocumentOpened(m);
    private bookmarkCreated(m);
    private fieldCreated(m);
    private measure(m);
    abortModal(qAccept: boolean): Promise<any>;
    addFieldFromExpression(qName: string, qExpr: string): Promise<any>;
    applyBookmark(qId: string): Promise<any>;
    backCount(): Promise<any>;
    back(): Promise<any>;
    checkExpression(qExpr: string, qLabels: string): Promise<any>;
    checkNumberOrExpression(qExpr: string): Promise<any>;
    checkScriptSyntax(): Promise<any>;
    clearAll(qLockedAlso?: boolean, qStateName?: boolean): Promise<any>;
    clearUndoBuffer(): Promise<any>;
    cloneBookmark(qId: string): Promise<any>;
    cloneDimension(qId: string): Promise<any>;
    cloneMeasure(qId: string): Promise<any>;
    cloneObject(qId: string): Promise<any>;
    commitDraft(qId: string): Promise<any>;
    createBookmark(qGenericBookmarkProperties: QGenericBookmarkProperties): Bookmark;
    createConnection(qConnection: QConnection): Promise<any>;
    createDimension(qGenericDimensionProperties: QGenericDimensionProperties): Promise<any>;
    createDraft(qId: string): Promise<any>;
    createMeasure(qGenericMeasureProperties: QGenericMeasureProperties): Promise<any>;
    createObject(qGenericObjectProperties: QGenericObjectProperties): Promise<any>;
    createSessionObject(qGenericObjectProperties: QGenericObjectProperties): Promise<any>;
    createSessionVariable(qGenericVariableProperties: QGenericVariableProperties): Promise<any>;
    createVariableEx(qGenericVariableProperties: QGenericVariableProperties): Promise<any>;
    deleteConnection(qConnectionId: string): Promise<any>;
    destroyBookmark(qId: string): Promise<any>;
    destroyDimension(qId: string): Promise<any>;
    destroyDraft(qId: string, qSourceId: string): Promise<any>;
    destroyMeasure(qId: string): Promise<any>;
    destroyObject(qId: string): Promise<any>;
    destroySessionObject(qId: string): Promise<any>;
    destroySessionVariable(qId: string): Promise<any>;
    destroyVariableById(qId: string): Promise<any>;
    destroyVariableByName(qName: string): Promise<any>;
    doReload(qPartial?: boolean, qDebug?: boolean, qMode?: QMode): Promise<any>;
    doReloadEx(qPartial?: boolean, qDebug?: boolean, qMode?: QMode): Promise<any>;
    doSave(qFileName?: string): Promise<any>;
    evaluate(qExpression: string): Promise<any>;
    evaluateEx(qExpression: string): Promise<any>;
    findMatchingFields(qFieldName: string, qTags: Array<string>): Promise<any>;
    forward(): Promise<any>;
    forwardCount(): Promise<any>;
    getAllInfos(qInfos: QInfo): Promise<any>;
    getAppLayout(): Promise<any>;
    getAppProperties(): Promise<any>;
    getAssociationScores(qTable1: string, qTable2: string): Promise<any>;
    getBookmark(qId: string): Bookmark;
    getBookmarks(qTypes?: Array<string>, qData?: {
        'qMeta': {};
    }): Promise<any>;
    getConnection(qConnectionId: string): Promise<any>;
    getConnections(): Promise<any>;
    getContentLibraries(): Promise<any>;
    getDatabaseInfo(qConnectionId: string): Promise<any>;
    getDatabaseOwners(qConnectionId: string, qDatabase?: string): Promise<any>;
    getDatabaseTableFields(qConnectionId: string, qTable: string, qDatabase?: string, qOwner?: string): Promise<any>;
    getDatabaseTablePreview(qConnectionId: string, qTable: string, qDatabase?: string, qOwner?: string, qConditions?: QFilterInfo): Promise<any>;
    getDatabaseTables(qConnectionId: string, qDatabase?: string, qOwner?: string): Promise<any>;
    getDatabases(qConnectionId: string, qDatabase?: string, qOwner?: string): Promise<any>;
    /**
     *
     */
    getDimension(qId: string): Promise<any>;
    getEmptyScript(qLocalizedMainSection?: string): Promise<any>;
    getFavoriteVariables(): Promise<any>;
    getField(qFieldName: string, qStateName?: string): Field;
    getFieldDescription(qFieldName: string): Promise<any>;
    getFieldOnTheFlyByName(qFieldName: string): Promise<any>;
    /**
     *
     * QFileDataFormat not completed
     */
    getFileTableFields(qConnectionId: string, qDataFormat: QFileDataFormat, qTable: string, qRelativePath?: string): Promise<any>;
    getFileTablePreview(qReadableName: string): Promise<any>;
    getFileTables(qConnectionId: string, qDataFormat: QFileDataFormat, qRelativePath?: string): Promise<any>;
    getFileTablesEx(qConnectionId: string, qDataFormat: QFileDataFormat, qRelativePath?: string): Promise<any>;
    getFolderItemsForConnection(qConnectionId: string, qRelativePath?: string): Promise<any>;
    getIncludeFileContent(qPath: string): Promise<any>;
    getLibraryContent(qName: string): Promise<any>;
    getLineage(qLineage: Array<QLineageInfo>): Promise<any>;
    getLocaleInfo(): Promise<any>;
    getLooselyCoupledVector(): Promise<any>;
    getMatchingFields(qTags: Array<string>, qMatchingFieldMode?: QMatchingFieldMode): Promise<any>;
    getMeasure(qId: string): Promise<any>;
    getMediaList(): Promise<any>;
    getObject(qId: string): Promise<any>;
    getObjects(qObjectOptions: QObjectOptions): Promise<any>;
    getScript(): Promise<any>;
    getScriptBreakpoints(): Promise<any>;
    getScriptEx(): Promise<any>;
    getTableData(qOffset: number, qRows: number, qSyntheticMode: boolean, qTableName: string): Promise<any>;
    getTablesAndKeys(qWindowSize: QSize, qNullSize: QSize, qCellHeight: number, qSyntheticMode: boolean, qIncludeSysVars: boolean): Promise<any>;
    getTextMacros(): Promise<any>;
    getVariable(qName: string): Promise<any>;
    getVariableById(qId: string): Promise<any>;
    getVariableByName(qName: string): Promise<any>;
    getViewDlgSaveInfo(): Promise<any>;
    guessFileType(qConnectionId: string, qRelativePath?: string): Promise<any>;
    lockAll(qStateName?: string): Promise<any>;
    modifyConnection(qConnectionId: string, qConnection?: QConnection, qOverrideCredentials?: boolean): Promise<any>;
    publish(qStreamId: string, qName?: string): Promise<any>;
    redo(): Promise<any>;
    removeAlternateState(qStateName: string): Promise<any>;
    resume(): Promise<any>;
    saveObjects(): Promise<any>;
    scramble(qFieldName: string): Promise<any>;
    searchAssociations(qOptions: QSearchCombinationOptions, qTerms: Array<string>, qPage: QSearchPage): Promise<any>;
    searchObjects(qOptions: QSearchObjectOptions, qTerms: Array<string>, qPage: QSearchPage): Promise<any>;
    searchResults(qOptions: QSearchCombinationOptions, qTerms: Array<string>, qPage: QSearchPage): Promise<any>;
    searchSuggest(qOptions: QSearchCombinationOptions, qTerms: Array<string>): Promise<any>;
    selectAssociations(qOptions: QSearchCombinationOptions, qTerms: Array<string>, qMatchIx: number, qSoftLock?: boolean): Promise<any>;
    GendGenericCommandToCustomConnector(qProvider: string, qCommand: QCommand, qMethod: string, qParameters: Array<string>, qAppendConnection: string): Promise<any>;
    setAppProperties(qProp: QAppProperties): Promise<any>;
    setFavoriteVariables(qNames: Array<string>): Promise<any>;
    setFetchLimit(qLimit: number): Promise<any>;
    setScript(qScript: string): Promise<any>;
    setScriptBreakpoints(qBreakpoints: Array<QEditorBreakpoint>): Promise<any>;
    undo(): Promise<any>;
    unlockAll(qStateName: string): Promise<any>;
    $getMeasureList(): Promise<any>;
    $getMeasure(qId: string): GenericMeasure;
    $createMeasure(): GenericMeasure;
    $getDimensionList(): Promise<any>;
    $getDimension(qId: string): GenericDimension;
    $createDimension(): GenericDimension;
}