angular-qlik-api/class/generic-dimension.class.d.ts

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

import { Document } from './document.class';
import { Deferred } from './deferred.class';
import { QPatches } from '../interface/q-patches.interface';
import { QGenericDimensionProperties } from '../interface/q-generic-dimension-properties.interface';
import { QLinkedObjectInfo } from '../interface/q-linked-object-info.interface';
export declare class GenericDimension {
    qProp: QGenericDimensionProperties;
    globalService: any;
    doc: Deferred<number>;
    deferred: Deferred<number>;
    outerDoc: Document;
    genericDimensionId: string;
    constructor(deferred: Deferred<number>, globalService: any, doc: Document, genericDimensionId: string);
    $$setHandle(handle: number): void;
    /**
     * Applying a patch takes less time than resetting all the properties.
     * @param {Array<QPatches>} qPatches
     * @returns {Promise<any>}
     */
    applyPatches(qPatches: Array<QPatches>): Promise<any>;
    /**
     * Returns the definition of a dimension.
     * @returns {Promise<any>}
     */
    getDimension(): Promise<any>;
    /**
     * Returns the type and identifier of the object.
     * @returns {Promise<any>}
     */
    getInfo(): Promise<any>;
    /**
     * Evaluates a dimension and displays its properties, including the dynamic properties.
     * @param {QGenericDimensionProperties} qLayout
     * @returns {Promise<any>}
     */
    getLayout(qLayout: QGenericDimensionProperties): Promise<any>;
    /**
     * Lists the linked objects to a generic object, a dimension or a measure.
     * @param {Array<QLinkedObjectInfo>} qItems
     * @returns {Promise<any>}
     */
    getLinkedObjects(qItems: Array<QLinkedObjectInfo>): Promise<any>;
    /**
     * Shows the properties of an object. Returns the identifier and the definition of the dimension
     * @returns {Promise<any>}
     */
    getProperties(): Promise<any>;
    /**
     * Publishes a dimension.
     * @returns {Promise<any>}
     */
    publish(): Promise<any>;
    /**
     * Sets some properties for a dimension.
     * @param {QGenericDimensionProperties} qProp
     * @returns {Promise<any>}
     */
    setProperties(qProp: QGenericDimensionProperties): Promise<any>;
    /**
     * Unpublishes a dimension.
     * @returns {Promise<any>}
     */
    unPublish(): Promise<any>;
    /**
     * Module helper method
     * Sets the title. If presist set to true, then it will automatically save the document object the dimension is atached to.
     * @param {string} title
     * @param {boolean} presist
     * @returns {GenericDimension}
     */
    $setTitle(title: string, presist?: boolean): GenericDimension;
    /**
     * Module helper method
     * Sets the field definition. If presist set to true, then it will automatically save the document object the dimension is atached to.
     * @param {Array<string>} qFieldDefs
     * @param {boolean} presist
     * @returns {GenericDimension}
     */
    $setFieldDefs(qFieldDefs: Array<string>, presist?: boolean): GenericDimension;
    /**
     * Module helper method
     * Sets the field labels. If presist set to true, then it will automatically save the document object the dimension is atached to.
     * @param {Array<string>} qFieldLabels
     * @param {boolean} presist
     * @returns {GenericDimension}
     */
    $setFieldLabels(qFieldLabels: Array<string>, presist?: boolean): GenericDimension;
    /**
     * Module helper method
     * Sets the tags. If presist set to true, then it will automatically save the document object the dimension is atached to.
     * @param {Array<string>} tags
     * @param {boolean} presist
     * @returns {GenericDimension}
     */
    $setTags(tags: Array<string>, presist?: boolean): GenericDimension;
    /**
     * Module helper method
     * Sets the description. If presist set to true, then it will automatically save the document object the dimension is atached to.
     * @param {string} description
     * @param {boolean} presist
     * @returns {GenericDimension}
     */
    $setDescription(description: string, presist?: boolean): GenericDimension;
}