Class ProfilerIndexStat

Full definition and all data captured for given profiler stat.

Hierarchy

FrameworkObject
- ProfilerIndexStat

Index

Constructors

Methods

getColorHue getIndex getMetadata getPoint getPointAfter getPoints getStatIdentifier getTimeRange

Constructors

`Protected`constructor

new ProfilerIndexStat(isInternalConstructor?): ProfilerIndexStat
Parameters
- OptionalisInternalConstructor: boolean
Returns ProfilerIndexStat
Overrides FrameworkObject.constructor

Methods

getColorHue

getColorHue(): number
Returns color hue that is assigned (in a way randomly) to the sample upon its insertion into profiler index.

Returns number
Hue that should be used for colors representing this index.

getIndex

getIndex(): ProfilerIndex
Returns profiler index to which this stat belongs.

Returns ProfilerIndex
Profiler index that created this stat.

getMetadata

getMetadata(): Immutable<ProfilerStatMetadata>
Returns stat definition captured by profiler runtime.

Returns Immutable<ProfilerStatMetadata>
Raw stat definition data.

getPoint

getPoint(nanoseconds): Immutable<ProfilerDatabaseStatPoint>
Returns value applicable for given time point. That means that it will return the first value with time lower or equal to given parameter. If no such value exists, this will return a default StatPoint. This also returns a default StatPoint if there are no points recorded for this Stat.
Parameters
- nanoseconds: number
  Required time of returned time point.
Returns Immutable<ProfilerDatabaseStatPoint>
Found value or default value if nothing was found.

getPointAfter

getPointAfter(nanoseconds): Immutable<ProfilerDatabaseStatPoint>
Finds and returns first recorded point after given time.
Parameters
- nanoseconds: number
  Time from which to search for next time point.
Returns Immutable<ProfilerDatabaseStatPoint>
Data point after given time. Returns default value if nothing was found.

getPoints

getPoints(nanosecondsBegin?, nanosecondsEnd?): ProfilerDatabaseStatPoint[]
Returns all values between two given times. This begins with the first value with time lower or equal to nanosecondsBegin (if such value exists) and ends with the last value with time lower than nanosecondsEnd. The resulting values are ordered by time, from oldest to newest.
Parameters
- OptionalnanosecondsBegin: number
  First time in required range.
- OptionalnanosecondsEnd: number
  Last time in required range.
Returns ProfilerDatabaseStatPoint[]
Values that belong to given time range.

getStatIdentifier

getStatIdentifier(): Immutable<ProfilerDatabaseIdentifier>
Returns stat definition captured by profiler runtime.

Returns Immutable<ProfilerDatabaseIdentifier>
Raw stat definition data.

getTimeRange

getTimeRange(): ProfilerTimeRange
Returns the range of times of stat points in this stat.

Returns ProfilerTimeRange
Time range of stat.