Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IFilterBase

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

Defines the interface to a DataSeries in SciChart's High Performance Real-time JavaScript Charts

remarks

A DataSeries stores the data to render. This is independent from the RenderableSeries which defines how that data should be rendered.

See derived types of BaseDataSeries to find out what data-series are available. See derived types of IRenderableSeries to find out what 2D JavaScript Chart types are available.

Hierarchy

Implemented by

Index

Properties

Methods

Properties

Readonly originalSeries

originalSeries: IDataSeries

The IDataSeries to be filtered

Methods

delete

  • delete(): void

  • Deletes native (WebAssembly) memory used by this type, after which it cannot be used.

    remarks

    Call .delete() before finishing with the object to ensure that WebAssmembly memory leaks do not occur.

    All elements within SciChart's High Performance Realtime JavaScript Charts which implement IDeletable must be deleted manually to free native (WebAssembly) memory

    Returns void

detachFromOriginalSeries

  • detachFromOriginalSeries(): void

  • Removes reference to the original IDataSeries and prevents them from being deleted as an effect of the filter deletion.

    remarks

    Makes the filter unusable, but allows deleting it separately from the original data series.

    Returns void

Generated using TypeDoc