Class SimpleMetric

Class to represent a simple metric.

Author

Tiago Grosso tiagogrosso99@gmail.com

Since

0.1.0

Hierarchy

AbstractMetric<MetricValue<number>[]>
- SimpleMetric

Index

Constructors

constructor

new SimpleMetric(metricData: BasicInsightsMetricData<MetricValue<number>[]>): SimpleMetric
The constructor.
Parameters
- metricData: BasicInsightsMetricData<MetricValue<number>[]>
  
  the metric data.
Returns SimpleMetric
Inherited from AbstractMetric.constructor
- Defined in main/requests/data/insights/AbstractMetric.ts:22

Properties

`Protected` metricData

metricData: BasicInsightsMetricData<MetricValue<number>[]>

The metric data.

Methods

getBetween

getBetween(lower: number, upper: number): MetricValue<number>[]
Gets the metric values between the provided bounds (non-inclusive).

Returns
the metric values between the provided bounds (non-inclusive).
Parameters
- lower: number
  
  the lower bound.
- upper: number
  
  the upper bound.
Returns MetricValue<number>[]
- Defined in main/requests/data/insights/SimpleMetric.ts:85

getByExpression

getByExpression(expression: ((elem: MetricValue<number>) => boolean)): MetricValue<number>[]
Gets the metric values that match the provided expression.

Returns
the metric values that match the provided expression.
Parameters
- expression: ((elem: MetricValue<number>) => boolean)
  
  expression to match the values to.
  - - (elem: MetricValue<number>): boolean
    - Parameters
      
      elem: MetricValue<number>
      
      Returns boolean
Returns MetricValue<number>[]
- Defined in main/requests/data/insights/SimpleMetric.ts:18

getEqual

getEqual(value: number): MetricValue<number>[]
Gets the metric values equal to the provided value.

Returns
the metric values equal to the provided value.
Parameters
- value: number
  
  the limit.
Returns MetricValue<number>[]
- Defined in main/requests/data/insights/SimpleMetric.ts:73

getGreaterThan

getGreaterThan(limit: number): MetricValue<number>[]
Gets the metric values greater than the provided limit.

Returns
the metric values greater than the provided limit.
Parameters
- limit: number
  
  the limit.
Returns MetricValue<number>[]
- Defined in main/requests/data/insights/SimpleMetric.ts:29

getGreaterThanOrEqual

getGreaterThanOrEqual(limit: number): MetricValue<number>[]
Gets the metric values greater than or equal to the provided limit.

Returns
the metric values greater than or equal to the provided limit.
Parameters
- limit: number
  
  the limit.
Returns MetricValue<number>[]
- Defined in main/requests/data/insights/SimpleMetric.ts:40

getHighest

getHighest(): undefined | MetricValue<number>
Returns the highest value of the metric. In case of a tie, the first value found is returned.

Returns
the highest value of the metric.

Returns undefined | MetricValue<number>
- Defined in main/requests/data/insights/SimpleMetric.ts:94

getLessThan

getLessThan(limit: number): MetricValue<number>[]
Gets the metric values smaller than the provided limit.

Returns
the metric values smaller than the provided limit.
Parameters
- limit: number
  
  the limit.
Returns MetricValue<number>[]
- Defined in main/requests/data/insights/SimpleMetric.ts:51

getLessThanOrEqual

getLessThanOrEqual(limit: number): MetricValue<number>[]
Gets the metric values smaller than or equal to the provided limit.

Returns
the metric values smaller than or equal to the provided limit.
Parameters
- limit: number
  
  the limit.
Returns MetricValue<number>[]
- Defined in main/requests/data/insights/SimpleMetric.ts:62

getLowest

getLowest(): undefined | MetricValue<number>
Returns the lowest value of the metric. In case of a tie, the first value found is returned.

Returns
the lowest value of the metric.

Returns undefined | MetricValue<number>
- Defined in main/requests/data/insights/SimpleMetric.ts:109

getMetricData

getMetricData(): BasicInsightsMetricData<MetricValue<number>[]>
Gets the metric data.

Returns
the metric data.

Returns BasicInsightsMetricData<MetricValue<number>[]>
Inherited from AbstractMetric.getMetricData
- Defined in main/requests/data/insights/AbstractMetric.ts:31

getMetricDescription

getMetricDescription(): string
Gets the metric description.

Returns
the metric description.

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

getMetricId

getMetricId(): string
Gets the metric id.

Returns
the metric id.

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

getMetricName

getMetricName(): string
Gets the metric name.

Returns
the metric name.

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

getMetricPeriod

getMetricPeriod(): string
Gets the metric period.

Returns
the metric period.

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

getMetricTitle

getMetricTitle(): string
Gets the metric title.

Returns
the metric title.

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

getMetricValues

getMetricValues(): MetricValue<number>[]
Gets the metric values.

Returns
the metric values.

Returns MetricValue<number>[]
Inherited from AbstractMetric.getMetricValues
- Defined in main/requests/data/insights/AbstractMetric.ts:85

Class SimpleMetric

Author

Since

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

metricData: BasicInsightsMetricData<MetricValue<number>[]>

Returns SimpleMetric

Properties

Protected metricData

Methods

getBetween

Returns

Parameters

lower: number

upper: number

Returns MetricValue<number>[]

getByExpression

Returns

Parameters

expression: ((elem: MetricValue<number>) => boolean)

Parameters

elem: MetricValue<number>

Returns boolean

Returns MetricValue<number>[]

getEqual

Returns

Parameters

value: number

Returns MetricValue<number>[]

getGreaterThan

Returns

Parameters

limit: number

Returns MetricValue<number>[]

getGreaterThanOrEqual

Returns

Parameters

limit: number

Returns MetricValue<number>[]

getHighest

Returns

Returns undefined | MetricValue<number>

getLessThan

Returns

Parameters

limit: number

Returns MetricValue<number>[]

getLessThanOrEqual

Returns

Parameters

limit: number

Returns MetricValue<number>[]

getLowest

Returns

Returns undefined | MetricValue<number>

getMetricData

Returns

Returns BasicInsightsMetricData<MetricValue<number>[]>

getMetricDescription

Returns

Returns string

getMetricId

Returns

Returns string

getMetricName

Returns

Returns string

getMetricPeriod

Returns

Returns string

getMetricTitle

Returns

Returns string

getMetricValues

`Protected` metricData