angular-qlik-api/class/generic-measure.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 { QGenericMeasureProperties, QGrouping } from '../';
import { QLinkedObjectInfo } from '../interface/q-linked-object-info.interface';
export declare class GenericMeasure {
    qProp: QGenericMeasureProperties;
    globalService: any;
    doc: Deferred<number>;
    deferred: Deferred<number>;
    outerDoc: Document;
    genericMeasureId: string;
    constructor(deferred: Deferred<number>, globalService: any, doc: Document, genericMeasureId: string);
    setHandle(handle: number): void;
    /**
     * Applies a patch to the properties of an object. Allows an update to some of the properties.
     * @param {Array<QPatches>} qPatches
     * @returns {Promise<any>}
     */
    applyPatches(qPatches: Array<QPatches>): Promise<any>;
    /**
     * Returns the type and identifier of the object.
     * @returns {Promise<any>}
     */
    getInfo(): Promise<any>;
    /**
     * Evaluates a measure and displays its properties, including the dynamic properties.
     * @param {QGenericMeasureProperties} qLayout
     * @returns {Promise<any>}
     */
    getLayout(qLayout: QGenericMeasureProperties): 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>;
    /**
     * Returns the definition of a measure.
     * @returns {Promise<any>}
     */
    getMeasure(): Promise<any>;
    /**
     * Shows the properties of an object.
     * Returns the identifier and the definition of the measure.
     * @returns {Promise<any>}
     */
    getProperties(): Promise<any>;
    /**
     * Publishes a measure.
     * @returns {Promise<any>}
     */
    publish(): Promise<any>;
    /**
     * Sets some properties for a measure.
     * @param {QGenericMeasureProperties} qProp
     * @returns {Promise<any>}
     */
    setProperties(qProp: QGenericMeasureProperties): Promise<any>;
    /**
     * Unpublishes a measure.
     * @returns {Promise<any>}
     */
    unPublish(): Promise<any>;
    /**
     * Module helper method
     * Sets the title. If presist true will automatically save the object
     * @param {string} title
     * @param {boolean} presist
     * @returns {GenericMeasure}
     */
    $setTitle(title: string, presist?: boolean): GenericMeasure;
    /**
     * Module helper method
     * Sets the description. If presist param set to true will, then the GenericMeasure object is saved automatically
     * @param {string} description
     * @param {boolean} presist
     * @returns {Promise<any>}
     */
    $setDescription(description: string, presist?: boolean): GenericMeasure;
    /**
     * Module helper method
     * Sets the tag property. If presist param set to true will, then the GenericMeasure object is saved automatically
     * @param {Array<string>} tags
     * @param {boolean} presist
     * @returns {Promise<any>}
     */
    $setTags(tags: Array<string>, presist?: boolean): GenericMeasure;
    /**
     * Module helper method
     * Sets the Measure expression. If presist param set to true will, then the GenericMeasure object is saved automatically
     * @param {string} expression
     * @param {boolean} presist
     * @returns {Promise<any>}
     */
    $setFormula(expression: string, presist?: boolean): GenericMeasure;
    /**
     * Module helper method
     * Sets the grouping property. If presist param set to true will, then the GenericMeasure object is saved automatically
     * @param {QGrouping} qGroup
     * @param {boolean} presist
     * @returns {Promise<any>}
     */
    $setGrouping(qGroup: QGrouping, presist?: boolean): GenericMeasure;
    /**
     * Module helper method
     * Sets the labelExpression property. If presist param set to true will, then the GenericMeasure object is saved automatically
     * @param {string} expression
     * @param {boolean} presist
     * @returns {Promise<any>}
     */
    $setLabelExpression(expression: string, presist?: boolean): GenericMeasure;
    /**
     * Module helper method
     * Sets the coloring property. If presist param set to true will, then the GenericMeasure object is saved automatically
     * @param {string} hexColor
     * @param {boolean} presist
     * @returns {Promise<any>}
     */
    $setColor(hexColor: string, presist?: boolean): GenericMeasure;
}