MetricDimensionBuilder
Defined in: builder/metric.ts:11
A builder for a dimension attached to a metric.
Extends
Section titled “Extends”Properties
Section titled “Properties”key:
string
Defined in: builder/metric.ts:20
readonlyprn:string
Defined in: builder/index.ts:32
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”addSubject()
Section titled “addSubject()”addSubject(
subject):this
Defined in: builder/metric.ts:18
Subjects are the reference for a particular metric. For example a country template may be supplied: in this case the dimensions will be instances of that template (Australia, New Zealand) that are items in the workspace.
Parameters
Section titled “Parameters”subject
Section titled “subject”TemplateBuilder | UnionBuilder
Returns
Section titled “Returns”this
setDescription()
Section titled “setDescription()”setDescription(
description):this
Defined in: builder/index.ts:33
Parameters
Section titled “Parameters”description
Section titled “description”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”toDefinition()
Section titled “toDefinition()”toDefinition():
MetricDimensionDefinition
Defined in: builder/metric.ts:25
Returns the definition structure of this metric deminsion.