Type Alias NativeGenericMeasureFunctions

type NativeGenericMeasureFunctions = {
    applyPatches: (patches: NxPatch[]) => Promise<void>;
    approve: () => Promise<void>;
    getInfo: () => Promise<NxInfo>;
    getLayout: () => Promise<GenericMeasureLayout>;
    getLinkedObjects: () => Promise<NxLinkedObjectInfo[]>;
    getMeasure: () => Promise<NxLibraryMeasureDef>;
    getProperties: () => Promise<GenericMeasureProperties>;
    publish: () => Promise<void>;
    setProperties: (prop: GenericMeasureProperties) => Promise<void>;
    unApprove: () => Promise<void>;
    unPublish: () => Promise<void>;
}
Index

Properties

applyPatches: (patches: NxPatch[]) => Promise<void>

Applies a patch to the properties of an object. Allows an update to some of the properties. It should not be possible to patch "/qInfo/qId", and it will be forbidden in the near future.

Applying a patch takes less time than resetting all the properties.

Parameters:

  • patches - Array of patches.

Stability: locked

approve: () => Promise<void>

Adds the generic measure to the list of approved objects

This operation is possible only in Qlik Sense Enterprise.

Stability: locked

getInfo: () => Promise<NxInfo>

Returns the type and identifier of the object.

Stability: locked

getLayout: () => Promise<GenericMeasureLayout>

Evaluates a measure and displays its properties, including the dynamic properties.

Stability: locked

getLinkedObjects: () => Promise<NxLinkedObjectInfo[]>

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

Stability: locked

getMeasure: () => Promise<NxLibraryMeasureDef>

Returns the definition of a measure.

Stability: locked

getProperties: () => Promise<GenericMeasureProperties>

Shows the properties of an object. Returns the identifier and the definition of the measure.

If the member delta is set to true in the request object, only the delta is retrieved.
The following is always returned in the output:

Stability: locked

publish: () => Promise<void>

Publishes a measure.

This operation is not applicable for Qlik Sense Desktop.

Stability: locked

setProperties: (prop: GenericMeasureProperties) => Promise<void>

Sets some properties for a measure.

Parameters:

  • prop - Information about the measure.

Stability: locked

unApprove: () => Promise<void>

Removes the generic measure from the list of approved objects

This operation is possible only in Qlik Sense Enterprise.

Stability: locked

unPublish: () => Promise<void>

Unpublishes a measure.

This operation is not applicable for Qlik Sense Desktop.

Stability: locked