Interface CalculatedMeasure

Interface for a Calculated Measure, extending Measure.

See

Using the JAQL to Add A Formula (opens new window)

Methods

format

format(format): Measure

Formats the measure according to the given format definition.

Parameters

Parameter	Type	Description
format	string	Format string

Returns

Measure

A formatted instance of this measure

---

getFormat

getFormat(): string | undefined

Gets the formatting string of this measure.

Returns

string | undefined

Formatting string

---

getSort

getSort(): Sort

Gets the sort definition of this measure.

Returns

Sort

---

sort

sort(sort): Measure

Sorts the measure by the given sort definition.

Parameters

Parameter	Type	Description
sort	Sort	Sort definition

Returns

Measure

A sorted instance of measure

Properties

context

context: MeasureContext

Context of the calculated measure

---

expression

expression: string

Expression of the calculated measure

---

name

name: string

Element name

---

type

readonly type: string

Element type