Class FrameStats

Class containing all counters, timers and events of the current frame.

internal

Hierarchy

FrameStats

Index

Properties

Methods

Properties

Readonly entries

entries: Map<string, number> = new Map()

Optional messages

messages: string[] = undefined

Methods

addMessage

addMessage(message: string): void

- Defined in @here/harp-mapview/lib/Statistics.ts:831
Add a text message to the frame, like "Font XYZ has been loaded"

Parameters
- message: string
  
  The message to add.
Returns void

addValue

addValue(name: string, value: number): void

- Defined in @here/harp-mapview/lib/Statistics.ts:821
Add a value to the current value of the performance number. If the performance is not known, it will be initialized with value.

Parameters
- name: string
  
  Value to be added to the performance number.
- value: number
Returns void

getValue

getValue(name: string): number | undefined

- Defined in @here/harp-mapview/lib/Statistics.ts:800
Retrieve the value of the performance number.

Parameters
- name: string
  
  Name of the performance number.
Returns number | undefined

The value of the performance number or undefined if it has not been declared by setValue before.

reset

reset(): void

- Defined in @here/harp-mapview/lib/Statistics.ts:841
Reset all known performance values to 0 and the messages to undefined.

Returns void

setValue

setValue(name: string, value: number): void

- Defined in @here/harp-mapview/lib/Statistics.ts:810
Set the value of the performance number.

Parameters
- name: string
  
  New value of the performance number.
- value: number
Returns void

Generated using TypeDoc