Class AbstractMetric<T>`Abstract`

Abstract class to represent a metric.

Author

Tiago Grosso tiagogrosso99@gmail.com

Since

0.1.0

Type Parameters

T

the type of the 'values' object.

Hierarchy

AbstractMetric
- ComplexMetric
- SimpleMetric

Index

Constructors

Properties

Methods

getMetricData getMetricDescription getMetricId getMetricName getMetricPeriod getMetricTitle getMetricValues

Constructors

constructor

new AbstractMetric<T>(metricData: BasicInsightsMetricData<T>): AbstractMetric<T>
The constructor.
Type Parameters
- T
Parameters
- metricData: BasicInsightsMetricData<T>
  
  the metric data.
Returns AbstractMetric<T>
- Defined in main/requests/data/insights/AbstractMetric.ts:22

Properties

`Protected` metricData

metricData: BasicInsightsMetricData<T>

The metric data.

Methods

getMetricData

getMetricData(): BasicInsightsMetricData<T>
Gets the metric data.

Returns
the metric data.

Returns BasicInsightsMetricData<T>
- Defined in main/requests/data/insights/AbstractMetric.ts:31

getMetricDescription

getMetricDescription(): string
Gets the metric description.

Returns
the metric description.

Returns string
- Defined in main/requests/data/insights/AbstractMetric.ts:67

getMetricId

getMetricId(): string
Gets the metric id.

Returns
the metric id.

Returns string
- Defined in main/requests/data/insights/AbstractMetric.ts:76

getMetricName

getMetricName(): string
Gets the metric name.

Returns
the metric name.

Returns string
- Defined in main/requests/data/insights/AbstractMetric.ts:40

getMetricPeriod

getMetricPeriod(): string
Gets the metric period.

Returns
the metric period.

Returns string
- Defined in main/requests/data/insights/AbstractMetric.ts:49

getMetricTitle

getMetricTitle(): string
Gets the metric title.

Returns
the metric title.

Returns string
- Defined in main/requests/data/insights/AbstractMetric.ts:58

getMetricValues

getMetricValues(): T
Gets the metric values.

Returns
the metric values.

Returns T
- Defined in main/requests/data/insights/AbstractMetric.ts:85

Generated using TypeDoc