Class PerformanceDebugHelper

Go to JavaScript Charting Documentation

Go to JavaScript Chart Examples

Go to SciChart.js on Github

experimental: An util used for adding performance checkpoints which can be then used for analyzing the chart performance. The checkpoints are created via the Performance API
remarks: By default it is disabled, to make use of the utils set PerformanceDebugHelper.enableDebug. Some checkpoints are set implicitly. Custom checkpoints could be set using PerformanceDebugHelper.mark. To output the results use PerformanceDebugHelper.outputLogs.

Hierarchy

PerformanceDebugHelper

Index

Properties

Methods

Properties

separator

separator: string = "_"

Static debugLevel

debugLevel: EPerformanceDebugLevel = EPerformanceDebugLevel.Info

Static enableDebug

enableDebug: boolean = false

Static instance

instance: PerformanceDebugHelper = new PerformanceDebugHelper()

Static measuredMarks

measuredMarks: string[] = []

Methods

addMark

addMark<TDetail>(type: EPerformanceMarkType | string, options?: TPerformanceMarkOptions<TDetail>): TSciChartPerformanceMark<TDetail>

- Defined in src/utils/performance.ts
Processes and creates a TSciChartPerformanceMark entry accordingly to provided options.

remarks

Make sure to provide a correct level option to define which marks are relevance. Default: EPerformanceDebugLevel.Info

Type parameters
- TDetail: TPerformanceDetail
Parameters
- type: EPerformanceMarkType | string
- Optional options: TPerformanceMarkOptions<TDetail>
Returns TSciChartPerformanceMark<TDetail>

clearMarks

clearMarks(name?: string): void

- Defined in src/utils/performance.ts
Removes a specific mark by name or all marks if no name provided

remarks

the default implementation removes marks the browser's performance timeline as well.

Parameters
- Optional name: string
Returns void

Protected createMark

createMark<TDetail>(type: EPerformanceMarkType | string, groupId: string, detail: TProcessedDetail<TDetail>): TSciChartPerformanceMark<TDetail>

- Defined in src/utils/performance.ts
Creates and returns TSciChartPerformanceMark

remarks

default implementation adds mark to the browser's performance timeline. Alternatively, override this to add a mark to a separate collection without polluting the global object. MDN Reference

Type parameters
- TDetail: TPerformanceDetail
Parameters
- type: EPerformanceMarkType | string
- groupId: string
- detail: TProcessedDetail<TDetail>
Returns TSciChartPerformanceMark<TDetail>

createMeasure

createMeasure(type: EPerformanceMarkType | string, name?: string, contextId?: string): PerformanceMeasure

- Defined in src/utils/performance.ts
Creates a performance measure based on the given mark type

Parameters
- type: EPerformanceMarkType | string
- Optional name: string
- Optional contextId: string
Returns PerformanceMeasure

createMeasureFromEndMark

createMeasureFromEndMark(mark: PerformanceMark, name?: string): PerformanceMeasure

- Defined in src/utils/performance.ts
Parameters
- mark: PerformanceMark
- Optional name: string
Returns PerformanceMeasure

getMarks

getMarks(): TSciChartPerformanceMark<TPerformanceDetail>[]

- Defined in src/utils/performance.ts
Retrieves the marks.

remarks

the default implementation will return all PerformanceMark instances the browser's performance timeline (e.g. created via performance.mark)

Returns TSciChartPerformanceMark<TPerformanceDetail>[]

getMeasures

getMeasures(): PerformanceEntryList

- Defined in src/utils/performance.ts
Returns PerformanceEntryList

Static clearMarks

clearMarks(name?: string): void

- Defined in src/utils/performance.ts
Parameters
- Optional name: string
Returns void

Static getMarks

getMarks(): TSciChartPerformanceMark<TPerformanceDetail>[]

- Defined in src/utils/performance.ts
inheritdoc

{@link PerformanceDebugHelper.getMarks{}

Returns TSciChartPerformanceMark<TPerformanceDetail>[]

Static getMeasures

getMeasures(): PerformanceEntryList

- Defined in src/utils/performance.ts
Returns PerformanceEntryList

Static mark

mark<TDetail>(type: EPerformanceMarkType | string, options?: TPerformanceMarkOptions<TDetail>): TSciChartPerformanceMark<TDetail>

- Defined in src/utils/performance.ts
Type parameters
- TDetail: TPerformanceDetail
Parameters
- type: EPerformanceMarkType | string
- Optional options: TPerformanceMarkOptions<TDetail>
Returns TSciChartPerformanceMark<TDetail>

Static measure

measure(type: EPerformanceMarkType | string, name?: string, contextId?: string): PerformanceMeasure

- Defined in src/utils/performance.ts
Parameters
- type: EPerformanceMarkType | string
- Optional name: string
- Optional contextId: string
Returns PerformanceMeasure

Static outputLogs

outputLogs(): void

- Defined in src/utils/performance.ts
Returns void

Static toJSON

toJSON(): TSciChartPerformanceData

- Defined in src/utils/performance.ts
Returns TSciChartPerformanceData

Generated using TypeDoc