Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MemoryUsageHelper

Go to JavaScript Charting Documentation
Go to JavaScript Chart Examples
Go to SciChart.js on Github

MemoryUsageHelper provides tools for tracking, debugging, and testing common issus related to lifecycle of SciChart entities.

Hierarchy

  • MemoryUsageHelper

Index

Properties

Accessors

Methods

Properties

Static Protected isMemoryUsageDebugEnabledProperty

isMemoryUsageDebugEnabledProperty: boolean = false

Static objectRegistry

objectRegistry: ObjectRegistry

Accessors

Static isMemoryUsageDebugEnabled

  • get isMemoryUsageDebugEnabled(): boolean
  • set isMemoryUsageDebugEnabled(value: boolean): void

  • Gets or sets the Memory Usage Debug Mode. Enabling the mode, provides warnings about wrong usage or cleanup. Also it wraps SciChart entities and adds them to the objectRegistry to track their lifecycle

    Returns boolean

  • Gets or sets the Memory Usage Debug Mode. Enabling the mode, provides warnings about wrong usage or cleanup. Also it wraps SciChart entities and adds them to the objectRegistry to track their lifecycle

    Parameters

    • value: boolean

    Returns void

Methods

Static destroyAllCharts

  • destroyAllCharts(): void

  • Calls delete on all charts

    Returns void

Static destroyMultiChart

  • destroyMultiChart(): void

Static destroyPieCharts

  • destroyPieCharts(): void

  • Calls delete on all charts instantiated with SciChartPieSurface.create

    Returns void

Static destroySingleCharts

  • destroySingleCharts(): void

Static register

  • register(entity: any, id?: string): void

  • Adds entity to the object registry to keep track of it being collected

    Parameters

    • entity: any
    • Optional id: string

      optional custom ID of the entity

    Returns void

Static unregister

  • unregister(id: string): void

  • Removes entity from the object registry

    Parameters

    • id: string

      ID of the entity

    Returns void

Generated using TypeDoc