Class UIMetrics

An user-interface compoment to vizualize real-time metrics

Constructors

constructor

Properties

_graphMargin _html? _labelWidth _legendFontSize _lineHeight _mouseX? _ranges _stepSize _textMargin _ui

Accessors

averageDisplayWidth displayableCount graphMargin labelWidth legendFontSize lineHeight stepSize textMargin

Methods

_drawCircle display reset

Constructors

constructor

Properties

Private _graphMargin

_graphMargin: number

Private Optional _html

_html?: string

Private _labelWidth

_labelWidth: number

Private _legendFontSize

_legendFontSize: number

Private _lineHeight

_lineHeight: number

Private Optional _mouseX

_mouseX?: number

Private _ranges

_ranges: {
    [key: string]: {
        max: number;
        min: number;
    };
}

Type declaration

  • [key: string]: {
        max: number;
        min: number;
    }
    • max: number
    • min: number

Private _stepSize

_stepSize: number

Private _textMargin

_textMargin: number

Private _ui

_ui: HTMLElement

Accessors

averageDisplayWidth

  • get averageDisplayWidth(): number

  • Return the space width available to display average metric

    Returns number

displayableCount

  • get displayableCount(): number

  • Return the count of displayable metrics regarding the space available on the screen

    Returns number

graphMargin

  • get graphMargin(): number

  • get graph margin in pixels

    Returns number

  • set graphMargin(value): void

  • set graph margin in pixels

    Parameters

    • value: number

    Returns void

labelWidth

legendFontSize

  • get legendFontSize(): number

  • get legend font size in pixels

    Returns number

  • set legendFontSize(value): void

  • set legend font size in pixels

    Parameters

    • value: number

    Returns void

lineHeight

  • get lineHeight(): number

  • get metric line height in pixels

    Returns number

  • set lineHeight(value): void

  • set metric line height in pixels

    Parameters

    • value: number

    Returns void

stepSize

  • get stepSize(): number

  • get the metric unit-step in pixels

    Returns number

  • set stepSize(value): void

  • set the metric unit-step in pixels

    Parameters

    • value: number

    Returns void

textMargin

Methods

Private _drawCircle

  • _drawCircle(x, y, value, color?, fontStyle?): string

  • Parameters

    • x: number
    • y: number
    • value: number
    • color: string = 'green'
    • fontStyle: string = 'italic'

    Returns string

display

  • display(stats): void

  • build metric from stats

    Parameters

    • stats: Map<string, (string | number)[]>

      Map with stats per entry

    Returns void

reset

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc