Class ComplexMetric

Class to represent a complex metric.

As a metric class, it expects to receive an array of values. However, for complex metrics that array has a single element. This class assumes that to always be true to simplify the access the values.

Author

Tiago Grosso tiagogrosso99@gmail.com

Since

0.1.0

Hierarchy

AbstractMetric<MetricValue<ComplexMetricValue>[]>
- ComplexMetric

Constructors

constructor

new ComplexMetric(data: BasicInsightsMetricData<MetricValue<ComplexMetricValue>[]>): ComplexMetric
The constructor.
Parameters
- data: BasicInsightsMetricData<MetricValue<ComplexMetricValue>[]>
  
  the metric data.
Returns ComplexMetric
Overrides AbstractMetric.constructor
- Defined in main/requests/data/insights/ComplexMetric.ts:38

Properties

`Private` endTime

endTime: Date

The end time.

`Protected` metricData

metricData: BasicInsightsMetricData<MetricValue<ComplexMetricValue>[]>

The metric data.

`Private` value

value: ComplexMetricValue

The value.

Methods

getByExpression

getByExpression(expression: ((pair: [key: string, value: number]) => boolean)): ComplexMetricValue
Gets the entries that match the provided expression.

Returns
the entries that match the provided expression.
Parameters
- expression: ((pair: [key: string, value: number]) => boolean)
  
  expression to match the values to.
  - - (pair: [key: string, value: number]): boolean
    - Parameters
      
      pair: [key: string, value: number]
      
      Returns boolean
Returns ComplexMetricValue
- Defined in main/requests/data/insights/ComplexMetric.ts:137

getByGreaterThan

getByGreaterThan(limit: number): ComplexMetricValue
Gets the entries of the values that are greater than the provided limit.

Returns
the entries of the values that are greater than the provided limit.
Parameters
- limit: number
  
  the limit.
Returns ComplexMetricValue
- Defined in main/requests/data/insights/ComplexMetric.ts:154

getByGreaterThanOrEqualTo

getByGreaterThanOrEqualTo(limit: number): ComplexMetricValue
Gets the entries of the values that are greater than or equal to the provided limit.

Returns
the entries of the values that are greater than or equal to the provided limit.
Parameters
- limit: number
  
  the limit.
Returns ComplexMetricValue
- Defined in main/requests/data/insights/ComplexMetric.ts:165

getByKeys

getByKeys(...keys: string[]): ComplexMetricValue
Gets the entries of the provided keys.

Returns
the entries of the provided keys.
Parameters
- Rest ...keys: string[]
Returns ComplexMetricValue
- Defined in main/requests/data/insights/ComplexMetric.ts:198

getByLessThan

getByLessThan(limit: number): ComplexMetricValue
Gets the entries of the values that are equal than the provided limit.

Returns
the entries of the values that are equal than the provided limit.
Parameters
- limit: number
  
  the limit.
Returns ComplexMetricValue
- Defined in main/requests/data/insights/ComplexMetric.ts:176

getByLessThanOrEqualTo

getByLessThanOrEqualTo(limit: number): ComplexMetricValue
Gets the entries of the values that are greater than or equal to the provided limit.

Returns
the entries of the values that are greater than or equal to the provided limit.
Parameters
- limit: number
  
  the limit.
Returns ComplexMetricValue
- Defined in main/requests/data/insights/ComplexMetric.ts:187

getEndTime

getEndTime(): Date
Gets the end time of the metric value.

Returns
the end time of the metric value.

Returns Date
- Defined in main/requests/data/insights/ComplexMetric.ts:58

getHighest

getHighest(): undefined | {
key: string;
value: 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 | {
key: string;
value: number;
}
- Defined in main/requests/data/insights/ComplexMetric.ts:207

getHighestKey

getHighestKey(): undefined | string
Returns the key of the highest value of the metric. In case of a tie, the key of the first value found is returned.

Returns
the key of highest value of the metric.

Returns undefined | string
- Defined in main/requests/data/insights/ComplexMetric.ts:222

getKeysByEqualTo

getKeysByEqualTo(valueToCompare: number): string[]
Gets the keys of the values that are equal to the provided value.

Returns
the keys of the values that are equal to the provided value.
Parameters
- valueToCompare: number
  
  the value to compare to.
Returns string[]
- Defined in main/requests/data/insights/ComplexMetric.ts:126

getKeysByExpression

getKeysByExpression(expression: ((pair: [key: string, value: number]) => boolean)): string[]
Gets the keys that match the provided expression.

Returns
the keys that match the provided expression.
Parameters
- expression: ((pair: [key: string, value: number]) => boolean)
  
  expression to match the values to.
  - - (pair: [key: string, value: number]): boolean
    - Parameters
      
      pair: [key: string, value: number]
      
      Returns boolean
Returns string[]
- Defined in main/requests/data/insights/ComplexMetric.ts:69

getKeysByGreaterThan

getKeysByGreaterThan(limit: number): string[]
Gets the keys of the values that are greater than the provided limit.

Returns
the keys of the values that are greater than the provided limit.
Parameters
- limit: number
  
  the limit.
Returns string[]
- Defined in main/requests/data/insights/ComplexMetric.ts:82

getKeysByGreaterThanOrEqualTo

getKeysByGreaterThanOrEqualTo(limit: number): string[]
Gets the keys of the values that are greater than or equal to the provided limit.

Returns
the keys of the values that are greater than or equal to the provided limit.
Parameters
- limit: number
  
  the limit.
Returns string[]
- Defined in main/requests/data/insights/ComplexMetric.ts:93

getKeysByLessThan

getKeysByLessThan(limit: number): string[]
Gets the keys of the values that are smaller than to the provided limit.

Returns
the keys of the values that are smaller than to the provided limit.
Parameters
- limit: number
  
  the limit.
Returns string[]
- Defined in main/requests/data/insights/ComplexMetric.ts:104

getKeysByLessThanOrEqualTo

getKeysByLessThanOrEqualTo(limit: number): string[]
Gets the keys of the values that are smaller than or equal to the provided limit.

Returns
the keys of the values that are smaller than or equal to the provided limit.
Parameters
- limit: number
  
  the limit.
Returns string[]
- Defined in main/requests/data/insights/ComplexMetric.ts:115

getLowest

getLowest(): undefined | {
key: string;
value: 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 | {
key: string;
value: number;
}
- Defined in main/requests/data/insights/ComplexMetric.ts:231

getLowestKey

getLowestKey(): undefined | string
Returns the key of the lowest value of the metric. In case of a tie, the key of the first value found is returned.

Returns
the key of lowest value of the metric.

Returns undefined | string
- Defined in main/requests/data/insights/ComplexMetric.ts:246

getMetricData

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

Returns
the metric data.

Returns BasicInsightsMetricData<MetricValue<ComplexMetricValue>[]>
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<ComplexMetricValue>[]
Gets the metric values.

Returns
the metric values.

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

getValue

getValue(): ComplexMetricValue
Gets the value of the metric.

Returns
the value of the metric.

Returns ComplexMetricValue
- Defined in main/requests/data/insights/ComplexMetric.ts:49

Class ComplexMetric

Author

Since

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

data: BasicInsightsMetricData<MetricValue<ComplexMetricValue>[]>

Returns ComplexMetric

Properties

Private endTime

Protected metricData

Private value

Methods

getByExpression

Returns

Parameters

expression: ((pair: [key: string, value: number]) => boolean)

Parameters

pair: [key: string, value: number]

Returns boolean

Returns ComplexMetricValue

getByGreaterThan

Returns

Parameters

limit: number

Returns ComplexMetricValue

getByGreaterThanOrEqualTo

Returns

Parameters

limit: number

Returns ComplexMetricValue

getByKeys

Returns

Parameters

Rest ...keys: string[]

Returns ComplexMetricValue

getByLessThan

Returns

Parameters

limit: number

Returns ComplexMetricValue

getByLessThanOrEqualTo

Returns

Parameters

limit: number

Returns ComplexMetricValue

getEndTime

Returns

Returns Date

getHighest

Returns

Returns undefined | { key: string; value: number; }

getHighestKey

Returns

Returns undefined | string

getKeysByEqualTo

Returns

Parameters

valueToCompare: number

Returns string[]

getKeysByExpression

Returns

Parameters

expression: ((pair: [key: string, value: number]) => boolean)

Parameters

pair: [key: string, value: number]

Returns boolean

Returns string[]

getKeysByGreaterThan

Returns

Parameters

limit: number

Returns string[]

getKeysByGreaterThanOrEqualTo

Returns

`Private` endTime

`Protected` metricData

`Private` value

`Rest` ...keys: string[]

Returns undefined | {
key: string;
value: number;
}

Returns undefined | {
key: string;
value: number;
}