Options
All
  • Public
  • Public/Protected
  • All
Menu

XYData Generator API Documentation

Index

Type aliases

OHLCData

OHLCData: [number, number, number, number, number]

OHLC data timestamp, open, high, low, close

ParametricFunction

ParametricFunction: (t: number) => number

Type declaration

    • (t: number): number
    • Parameters

      • t: number

      Returns number

StreamContinueHandler

StreamContinueHandler: () => boolean

Type declaration

    • (): boolean
    • Returns boolean

WaterDropData

WaterDropData: number[][]

Type definition for data generated by WaterDropDataGenerator.

Multidimensional number Array, where intensity value at given row & column can be accessed by:

const intensity = WaterDropData[ row ][ column ]

Functions

createDeltaFunctionGenerator

  • Create a new Delta function generator with default values. The generator creates flat progressive data with random spikes.

    Returns DeltaFunctionGenerator

createOHLCGenerator

  • Create a new OHLC data generator with default values. The generator creates random OHLC data.

    Returns OHLCGenerator

createParametricFunctionGenerator

  • Create a new Parametric Function generator with default values. The generator samples a given X and Y functions for each t step in the start - end range.

    Returns ParametricFunctionGenerator

createProgressiveFunctionGenerator

  • Create a new Progressive Function generator with default values. The generator samples a given function x times between given X range.

    Returns ProgressiveFunctionGenerator

createProgressiveRandomGenerator

  • Create a new Progressive Random Generator with default values. The generator creates random data on Y-axis with progressive X-axis.

    Returns ProgressiveRandomGenerator

createProgressiveTraceGenerator

  • Create a new Progressive Trace generator with default values. The generator creates random data with progressive X axis and random Y axis.

    Returns ProgressiveTraceGenerator

createSampledDataGenerator

  • Create a new Sampled data generator with default values. The generator samples the given input data array at specific frequency.

    Type parameters

    • T

      Data type for the data that the generator samples.

    Returns SampledDataGenerator<T>

createSpectrumDataGenerator

  • Create a new Spectrum Data Generator with default values.

    Returns SpectrumDataGenerator

createTraceGenerator

  • Create a new Trace generator with default values. The generator creates random XY data where each point is based on previous point.

    Returns TraceGenerator

createWaterDropDataGenerator

  • Create a new WaterDropDataGenerator with default values.

    Returns WaterDropDataGenerator

createWhiteNoiseGenerator

  • Create a new White noise generator with default values. The generator creates white noise between -1 and 1.

    Returns WhiteNoiseGenerator

Object literals

Const defaultOptions

defaultOptions: object

amplitudes

amplitudes: number[] = [15, 50, 3]

columnPositionsNormalized

columnPositionsNormalized: number[] = [0.6, 0.5, 0.3]

columns

columns: number = 10

frequencyStability

frequencyStability: number = 1

narrowFactor1

narrowFactor1: number = 8

narrowFactor2

narrowFactor2: number = 24

numberOfSamples

numberOfSamples: number = 1000

offsetLevel

offsetLevel: number = 47

rowPositionsNormalized

rowPositionsNormalized: number[] = [0.2, 0.5, 0.7]

rows

rows: number = 10

sampleSize

sampleSize: number = 10

variation

variation: number = 10

volatility

volatility: number = 25