Class UIMetrics

An user-interface compoment to vizualize real-time metrics

Index

Constructors

Accessors

averageDisplayWidth displayableCount graphMargin labelWidth legendFontSize lineHeight stepSize textMargin

Methods

Constructors

constructor

new UIMetrics(ui: HTMLElement): UIMetrics
Parameters
- ui: HTMLElement
Returns UIMetrics
- Defined in src/ui/UIMetrics.ts:116

Accessors

averageDisplayWidth

get averageDisplayWidth(): number
Return the space width available to display average metric

Returns number
- Defined in src/ui/UIMetrics.ts:92

displayableCount

get displayableCount(): number
Return the count of displayable metrics regarding the space available on the screen

Returns number
- Defined in src/ui/UIMetrics.ts:100

graphMargin

get graphMargin(): number
get graph margin in pixels

Returns number
- Defined in src/ui/UIMetrics.ts:14
set graphMargin(value: number): void
set graph margin in pixels
Parameters
- value: number
Returns void
- Defined in src/ui/UIMetrics.ts:20

labelWidth

get labelWidth(): number
get label width in pixels

Returns number
- Defined in src/ui/UIMetrics.ts:53
set labelWidth(value: number): void
set label width in pixels
Parameters
- value: number
Returns void
- Defined in src/ui/UIMetrics.ts:59

legendFontSize

get legendFontSize(): number
get legend font size in pixels

Returns number
- Defined in src/ui/UIMetrics.ts:66
set legendFontSize(value: number): void
set legend font size in pixels
Parameters
- value: number
Returns void
- Defined in src/ui/UIMetrics.ts:72

lineHeight

get lineHeight(): number
get metric line height in pixels

Returns number
- Defined in src/ui/UIMetrics.ts:40
set lineHeight(value: number): void
set metric line height in pixels
Parameters
- value: number
Returns void
- Defined in src/ui/UIMetrics.ts:46

stepSize

get stepSize(): number
get the metric unit-step in pixels

Returns number
- Defined in src/ui/UIMetrics.ts:79
set stepSize(value: number): void
set the metric unit-step in pixels
Parameters
- value: number
Returns void
- Defined in src/ui/UIMetrics.ts:85

textMargin

get textMargin(): number
get text margin in pixels

Returns number
- Defined in src/ui/UIMetrics.ts:27
set textMargin(value: number): void
set text margin in pixels
Parameters
- value: number
Returns void
- Defined in src/ui/UIMetrics.ts:33

Methods

display

display(stats: Map<string, (string | number)[]>): void
build metric from stats
Parameters
- stats: Map<string, (string | number)[]>
  Map with stats per entry
Returns void
- Defined in src/ui/UIMetrics.ts:146

reset

reset(): void
Reset metrics stats, essentially rescaling the metrics

Returns void
- Defined in src/ui/UIMetrics.ts:137