Skip to content

GenericDimension

QIX methods for version 12.171.0.

ApplyPatches

Applies a patch to the properties of an object. Allows an update to some of the properties.
Applying a patch takes less time than resetting all the properties.

Parameters:

Name Type Mandatory Description
qPatches NxPatch Yes Array of patches.

No return values.

Approve

Adds the generic dimension to the list of approved objects
This operation is possible only in Qlik Sense Enterprise.

No parameters.

No return values.

GetDimension

Returns the definition of a dimension.

The definition of the dimension is returned.

No parameters.

Returns:

Name Type Description
qDim NxLibraryDimensionDef {"qGrouping":"...","qFieldDefs":["..."],"qFieldLabels":["..."]}

GetInfo

Returns the type and identifier of the object.

No parameters.

Returns:

Name Type Description
qInfo NxInfo {"qId":"<identifier>","qType":"<type>"}

GetLayout

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

No parameters.

Returns:

Name Type Description
qLayout GenericDimensionLayout Information on the object.

GetLinkedObjects

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

No parameters.

Returns:

Name Type Description
qItems array<NxLinkedObjectInfo> List of the linked objects.

GetProperties

Shows the properties of an object.
Returns the identifier and the definition of the dimension.
If the member delta is set to true in the request object, only the delta is retrieved.

No parameters.

Returns:

Name Type Description
qProp GenericDimensionProperties Information about the generic object.

Publish

Publishes a dimension.

No parameters.

No return values.

SetProperties

Sets some properties for a dimension.

Parameters:

Name Type Mandatory Description
qProp GenericDimensionProperties Yes Information about the dimension.

No return values.

UnApprove

Removes the generic dimension from the list of approved objects
This operation is possible only in Qlik Sense Enterprise.

No parameters.

No return values.

UnPublish

Unpublishes a dimension.

No parameters.

No return values.