Options
All
  • Public
  • Public/Protected
  • All
Menu

Options for the XyRatioFilter

Hierarchy

Index

Properties

Optional capacity

capacity: number

Gets or sets the capacity of the data series. This is the amount of memory reserved for the data. For a normal dataSeries this will grow as data is appended. You can avoid memory fragmentation by creating your series with a larger capacity if you know it will grow to that.

Optional containsNaN

containsNaN: boolean

Gets or sets whether the Y data contains NaN values.

Optional dataEvenlySpacedInX

dataEvenlySpacedInX: boolean

When true, the Data is evenly spaced in X.

remarks

The user must specify this flag (defaults to true) in order to choose the correct, and fastest algorithms for drawing, indexing and ranging. If you experience glitches or strange drawing, it may be because you have set data with uneven spacing in X but not set this flag.

Optional dataIsSortedInX

dataIsSortedInX: boolean

When true, the Data is sorted in X. Same as isSorted.

remarks

The user must specify this parameter if the data is not sorted in X in order to have correct rendering. This parameter is used to choose the correct algorithms for zooming, panning and ranging and ensure best performance.

Optional dataSeriesName

dataSeriesName: string

The DataSeries name, used in legends, tooltips to identify the chart series

Optional divisorField

divisorField: EDataSeriesField

The field in the divisor series to use

divisorSeries

divisorSeries: BaseDataSeries

The dataSeries to divide by

Optional field

The field that will be returned by getOriginalYValues.

Optional fifoCapacity

fifoCapacity: number

Set the maximum size of the dataSeries in FIFO (First In First Out) mode. This can only be set in the constructor options. If set, the dataSeries does not support insert/insertRange or remove/removeRange. Any data that is appended once the dataSeries has reached fifoCapacity will cause the oldest data to be discarded. This is much more efficient than appending and removing for achieving scrolling data. Spline series and Stacked series currently do not support fifo mode. To get the scrolling effect, you need to consider the behaviour of your X Axis. You can either Use a CategoryAxis Use a NumericAxis with increasing x values, and update the visibleRange (or use zoomExtents)

Optional fifoStartIndex

fifoStartIndex: number

Sets the starting index of data for fifo mode.

Optional fifoSweeping

fifoSweeping: boolean

If true, data in fifo mode will not be "unwrapped" before drawing, giving ecg style sweeping mode. To get the sweeping effect, you need to consider the behaviour of your X Axis. You can either Use a CategoryAxis Use a NumericAxis and make your x values an offset from the first value, eg by doing x % fifoCapcity

Optional fifoSweepingGap

fifoSweepingGap: number

In fifo sweeping mode, the number of earliest points to skip to create a gap between the latest and earliest data

Optional id

id: string

A unique Id for the IDataSeries

Optional isSorted

isSorted: boolean

When true, the Data is sorted in X. Same as dataIsSortedInX.

remarks

The user must specify this parameter if the data is not sorted in X in order to have correct rendering. This parameter is used to choose the correct algorithms for zooming, panning and ranging and ensure best performance.

Optional metadata

metadata: IPointMetadata[] | IPointMetadata | { data?: any; type: string }

The Metadata values of type IPointMetadata to pre-populate the XyDataSeries If a single metadata value is supplied, this will be used as a template for all data values. If type is specified, it should refer to a registered metadataGenerator IMetadataGenerator, which can provide all metadata, based on the data provided, or a single object that will be used when adding data if no metadata is provided.

Optional xField

The field that will be returned by getOriginalXValues.

Optional xValues

xValues: NumberArray

The X-values array to pre-populate the XyDataSeries

Optional yValues

yValues: NumberArray

The Y-values array to pre-populate the XyDataSeries

Generated using TypeDoc