diff --git a/README.md b/README.md index c43a2b4e..aa6de05f 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,8 @@ I am building various technical indicators not available elsewhere. These includ - Market Profile - A distribution to identify value in relation to time. - Volume Profile - A distribution to identify value in relation to volume. -- Stacked Imbalances - Orderflow data to identify stacks of buying/selling discrepancies at certain prices. +- Stacked Imbalances - Identify stacks of buying/selling imbalances on the price level (needs orderflow data). +- High Volume Node - Identify nodes where a large trade volume occurred (needs orderflow data). ```ts import { MarketProfile, VolumeProfile } from 'chart-patterns' diff --git a/docs/classes/lib.RangeBuilder.default.html b/docs/classes/lib.RangeBuilder.default.html index 23c6e03c..fb99552b 100644 --- a/docs/classes/lib.RangeBuilder.default.html +++ b/docs/classes/lib.RangeBuilder.default.html @@ -1,4 +1,4 @@ -default | chart-patterns

Constructors

constructor +default | chart-patterns

Constructors

Methods

Generated using TypeDoc

\ No newline at end of file +

Constructors

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/lib.ZScores.ZScore.html b/docs/classes/lib.ZScores.ZScore.html index 2f3c45fe..d4ae0d08 100644 --- a/docs/classes/lib.ZScores.ZScore.html +++ b/docs/classes/lib.ZScores.ZScore.html @@ -1,6 +1,6 @@ -ZScore | chart-patterns

Constructors

constructor +ZScore | chart-patterns

Constructors

Methods

Constructors

Methods

Generated using TypeDoc

\ No newline at end of file +

Constructors

Methods

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/lib.ZScores.ZScoreOutput.html b/docs/classes/lib.ZScores.ZScoreOutput.html index b4b33eef..28e3b7f8 100644 --- a/docs/classes/lib.ZScores.ZScoreOutput.html +++ b/docs/classes/lib.ZScores.ZScoreOutput.html @@ -1,7 +1,7 @@ -ZScoreOutput | chart-patterns

Constructors

constructor +ZScoreOutput | chart-patterns

Constructors

Properties

avgFilter: number[]
filtered_stddev: number[]
input: number[]
peakCount: number = 0
signals: number[]

Generated using TypeDoc

\ No newline at end of file +

Constructors

Properties

avgFilter: number[]
filtered_stddev: number[]
input: number[]
peakCount: number = 0
signals: number[]

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/constants.FIBONACCI_NUMBERS.html b/docs/enums/constants.FIBONACCI_NUMBERS.html index 449f5803..ea76fe02 100644 --- a/docs/enums/constants.FIBONACCI_NUMBERS.html +++ b/docs/enums/constants.FIBONACCI_NUMBERS.html @@ -1,4 +1,4 @@ -FIBONACCI_NUMBERS | chart-patterns

Enumeration FIBONACCI_NUMBERS

Enumeration Members

FIVE +FIBONACCI_NUMBERS | chart-patterns

Enumeration FIBONACCI_NUMBERS

Enumeration Members

FIVE: 0.5
ONE: 1
ONE_SIX_EIGHT: 1.618
SEVEN_EIGHT_SIX: 0.786
SIX_ONE_EIGHT: 0.618
SIX_SIX: 0.66
THREE_EIGHT_TWO: 0.382
TWO_THREE_SIX: 0.236
ZERO: 0

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

FIVE: 0.5
ONE: 1
ONE_SIX_EIGHT: 1.618
SEVEN_EIGHT_SIX: 0.786
SIX_ONE_EIGHT: 0.618
SIX_SIX: 0.66
THREE_EIGHT_TWO: 0.382
TWO_THREE_SIX: 0.236
ZERO: 0

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/constants.HARMONIC_PATTERNS.html b/docs/enums/constants.HARMONIC_PATTERNS.html index 55cba193..c188a379 100644 --- a/docs/enums/constants.HARMONIC_PATTERNS.html +++ b/docs/enums/constants.HARMONIC_PATTERNS.html @@ -1,8 +1,8 @@ -HARMONIC_PATTERNS | chart-patterns

Enumeration HARMONIC_PATTERNS

Enumeration Members

BAT +HARMONIC_PATTERNS | chart-patterns

Enumeration HARMONIC_PATTERNS

Enumeration Members

BAT: "bat"
BUTTERFLY: "butterfly"
CRAB: "crab"
CYPHER: "cypher"
DEEP_CRAB: "deep_crab"
GARTLEY: "gartley"
SHARK: "shark"

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

BAT: "bat"
BUTTERFLY: "butterfly"
CRAB: "crab"
CYPHER: "cypher"
DEEP_CRAB: "deep_crab"
GARTLEY: "gartley"
SHARK: "shark"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/constants.INTERVALS.html b/docs/enums/constants.INTERVALS.html index 0756e618..6217aa3b 100644 --- a/docs/enums/constants.INTERVALS.html +++ b/docs/enums/constants.INTERVALS.html @@ -1,4 +1,4 @@ -INTERVALS | chart-patterns

Enumeration Members

EIGHT_HOURS +INTERVALS | chart-patterns

Enumeration Members

EIGHT_HOURS: "8h"
FIFTEEN_MINUTES: "15m"
FIVE_MINUTES: "5m"
FOUR_HOURS: "4h"
ONE_DAY: "1d"
ONE_HOUR: "1h"
ONE_MINUTE: "1m"
ONE_MONTH: "1M"
ONE_WEEK: "1w"
ONE_YEAR: "1y"
SIX_HOURS: "6h"
SIX_MONTHS: "6M"
THIRTY_MINUTES: "30m"
THREE_DAYS: "3d"
THREE_HOURS: "3h"
THREE_MINUTES: "3m"
THREE_MONTHS: "3M"
TWELVE_HOURS: "12h"
TWO_HOURS: "2h"
TWO_YEARS: "2y"

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

EIGHT_HOURS: "8h"
FIFTEEN_MINUTES: "15m"
FIVE_MINUTES: "5m"
FOUR_HOURS: "4h"
ONE_DAY: "1d"
ONE_HOUR: "1h"
ONE_MINUTE: "1m"
ONE_MONTH: "1M"
ONE_WEEK: "1w"
ONE_YEAR: "1y"
SIX_HOURS: "6h"
SIX_MONTHS: "6M"
THIRTY_MINUTES: "30m"
THREE_DAYS: "3d"
THREE_HOURS: "3h"
THREE_MINUTES: "3m"
THREE_MONTHS: "3M"
TWELVE_HOURS: "12h"
TWO_HOURS: "2h"
TWO_YEARS: "2y"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/constants.ImbalanceType.html b/docs/enums/constants.ImbalanceType.html index aaaf6508..e38a1c68 100644 --- a/docs/enums/constants.ImbalanceType.html +++ b/docs/enums/constants.ImbalanceType.html @@ -1,3 +1,3 @@ -ImbalanceType | chart-patterns

Enumeration ImbalanceType

Enumeration Members

BUYING_IMBALANCE +ImbalanceType | chart-patterns

Enumeration ImbalanceType

Enumeration Members

Enumeration Members

BUYING_IMBALANCE: 1
SELLING_IMBALANCE: 0

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

BUYING_IMBALANCE: 1
SELLING_IMBALANCE: 0

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/constants.MARKET_PROFILE_DAYS.html b/docs/enums/constants.MARKET_PROFILE_DAYS.html index f1104564..8047dd94 100644 --- a/docs/enums/constants.MARKET_PROFILE_DAYS.html +++ b/docs/enums/constants.MARKET_PROFILE_DAYS.html @@ -1,7 +1,7 @@ -MARKET_PROFILE_DAYS | chart-patterns

Enumeration MARKET_PROFILE_DAYS

Enumeration Members

B_SHAPE +MARKET_PROFILE_DAYS | chart-patterns

Enumeration MARKET_PROFILE_DAYS

Enumeration Members

B_SHAPE: "b_shape"
DOUBLE_DISTRIBUTION: "double_distribution"
NEUTRAL: "neutral"
NORMAL: "normal"
P_SHAPE: "p_shape"
TREND: "trend"

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

B_SHAPE: "b_shape"
DOUBLE_DISTRIBUTION: "double_distribution"
NEUTRAL: "neutral"
NORMAL: "normal"
P_SHAPE: "p_shape"
TREND: "trend"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/constants.MARKET_PROFILE_OPEN.html b/docs/enums/constants.MARKET_PROFILE_OPEN.html index 08a415f7..8da68011 100644 --- a/docs/enums/constants.MARKET_PROFILE_OPEN.html +++ b/docs/enums/constants.MARKET_PROFILE_OPEN.html @@ -1,5 +1,5 @@ -MARKET_PROFILE_OPEN | chart-patterns

Enumeration MARKET_PROFILE_OPEN

Enumeration Members

OPEN_AUCTION +MARKET_PROFILE_OPEN | chart-patterns

Enumeration MARKET_PROFILE_OPEN

Enumeration Members

OPEN_AUCTION: "Open Auction"
OPEN_DRIVE: "Open Drive"
OPEN_REJECTION_REVERSE: "Open Rejection Reverse"
OPEN_TEST_DRIVE: "Open Test Drive"

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

OPEN_AUCTION: "Open Auction"
OPEN_DRIVE: "Open Drive"
OPEN_REJECTION_REVERSE: "Open Rejection Reverse"
OPEN_TEST_DRIVE: "Open Test Drive"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/constants.MARKET_PROFILE_PERIODS.html b/docs/enums/constants.MARKET_PROFILE_PERIODS.html index 3a48e6a7..d58a43d4 100644 --- a/docs/enums/constants.MARKET_PROFILE_PERIODS.html +++ b/docs/enums/constants.MARKET_PROFILE_PERIODS.html @@ -1,4 +1,4 @@ -MARKET_PROFILE_PERIODS | chart-patterns

Enumeration MARKET_PROFILE_PERIODS

Enumeration Members

DAILY +MARKET_PROFILE_PERIODS | chart-patterns

Enumeration MARKET_PROFILE_PERIODS

Enumeration Members

Enumeration Members

DAILY: "daily"
MONTHLY: "monthly"
WEEKLY: "weekly"

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

DAILY: "daily"
MONTHLY: "monthly"
WEEKLY: "weekly"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/constants.SIGNAL_DIRECTION.html b/docs/enums/constants.SIGNAL_DIRECTION.html index 3aee5b88..855edb57 100644 --- a/docs/enums/constants.SIGNAL_DIRECTION.html +++ b/docs/enums/constants.SIGNAL_DIRECTION.html @@ -1,4 +1,4 @@ -SIGNAL_DIRECTION | chart-patterns

Enumeration SIGNAL_DIRECTION

Enumeration Members

BEARISH +SIGNAL_DIRECTION | chart-patterns

Enumeration SIGNAL_DIRECTION

Enumeration Members

Enumeration Members

BEARISH: "bearish"
BOTH: "both"
BULLISH: "bullish"

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

BEARISH: "bearish"
BOTH: "both"
BULLISH: "bullish"

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/types.MA_Periods.html b/docs/enums/types.MA_Periods.html index abe22df2..90a48f01 100644 --- a/docs/enums/types.MA_Periods.html +++ b/docs/enums/types.MA_Periods.html @@ -1,4 +1,4 @@ -MA_Periods | chart-patterns

Enumeration MA_Periods

Enumeration Members

FIFTY +MA_Periods | chart-patterns

Enumeration MA_Periods

Enumeration Members

Enumeration Members

FIFTY: 50
FIVE: 5
NINE: 9
ONE_HUNDRED: 100
SEVEN: 7
THIRTY: 30
THREE: 3
TWENTY_ONE: 21
TWO_HUNDRED: 200

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

FIFTY: 50
FIVE: 5
NINE: 9
ONE_HUNDRED: 100
SEVEN: 7
THIRTY: 30
THREE: 3
TWENTY_ONE: 21
TWO_HUNDRED: 200

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.CandlestickPatterns.findEngulfingCandle.html b/docs/functions/lib.CandlestickPatterns.findEngulfingCandle.html index 6198d905..6cce1c06 100644 --- a/docs/functions/lib.CandlestickPatterns.findEngulfingCandle.html +++ b/docs/functions/lib.CandlestickPatterns.findEngulfingCandle.html @@ -3,4 +3,4 @@

Returns SIGNAL_DIRECTION

The engulfing candle signal if found, or null otherwise.

Example

import { CandlestickPatterns } from 'chart-patterns';

// Assuming 'candles' is an array of candle data
const engulfingCandle: SIGNAL_DIRECTION | null = CandlestickPatterns.findEngulfingCandle({ candles, index: 10 });
-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.CandlestickPatterns.isExcess.html b/docs/functions/lib.CandlestickPatterns.isExcess.html index 07ea1b81..6e28ffc0 100644 --- a/docs/functions/lib.CandlestickPatterns.isExcess.html +++ b/docs/functions/lib.CandlestickPatterns.isExcess.html @@ -4,4 +4,4 @@

Returns boolean

True if the candle is an excess candle, otherwise false.

Example

import { CandlestickPatterns } from '@focus1691/chart-patterns';

// Assuming 'candle' is an ICandle object
const isExcessCandle: boolean = CandlestickPatterns.isExcess(candle);
-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.Harmonics.findPatterns.html b/docs/functions/lib.Harmonics.findPatterns.html index c6c8ab76..5c24c387 100644 --- a/docs/functions/lib.Harmonics.findPatterns.html +++ b/docs/functions/lib.Harmonics.findPatterns.html @@ -3,4 +3,4 @@

Returns IHarmonic[]

An array of identified harmonic patterns.

Example

// Parameters for generating ZigZag points
const lag: number = 5;
const threshold: number = 2;
const influence: number = 0.3;

// Assuming 'candles' is an array of ICandle objects representing the price data
// Generate ZigZag points from candlestick data
const zigzags: IZigZag[] = ZigZags.create(candles, lag, threshold, influence);

// Find harmonic patterns from the generated ZigZag points
const harmonics: IHarmonic[] = Harmonics.findPatterns(zigzags);

// 'harmonics' now contains an array of identified harmonic patterns
console.log(harmonics); // Outputs the identified harmonic patterns
-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.Harmonics.findXABCDCombinations.html b/docs/functions/lib.Harmonics.findXABCDCombinations.html index 8d1e25fc..75951e05 100644 --- a/docs/functions/lib.Harmonics.findXABCDCombinations.html +++ b/docs/functions/lib.Harmonics.findXABCDCombinations.html @@ -1,4 +1,4 @@ findXABCDCombinations | chart-patterns
  • Generates all possible combinations of five points from an array of zigzag points to form potential XABCD patterns.

    Parameters

    • zigzags: IZigZag[]

      An array of zigzag points to generate combinations from.

    Returns number[][]

    An array of combinations, where each combination is an array of indices representing a potential XABCD pattern.

    -

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.MovingAverage.calculateEMA.html b/docs/functions/lib.MovingAverage.calculateEMA.html index b7d7f89a..e92409c1 100644 --- a/docs/functions/lib.MovingAverage.calculateEMA.html +++ b/docs/functions/lib.MovingAverage.calculateEMA.html @@ -1 +1 @@ -calculateEMA | chart-patterns

Generated using TypeDoc

\ No newline at end of file +calculateEMA | chart-patterns

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.MovingAverage.calculateEmas.html b/docs/functions/lib.MovingAverage.calculateEmas.html index 1ab05502..63ab2cc4 100644 --- a/docs/functions/lib.MovingAverage.calculateEmas.html +++ b/docs/functions/lib.MovingAverage.calculateEmas.html @@ -1 +1 @@ -calculateEmas | chart-patterns

Generated using TypeDoc

\ No newline at end of file +calculateEmas | chart-patterns

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.MovingAverage.calculateSMA.html b/docs/functions/lib.MovingAverage.calculateSMA.html index c7f9928f..f4599611 100644 --- a/docs/functions/lib.MovingAverage.calculateSMA.html +++ b/docs/functions/lib.MovingAverage.calculateSMA.html @@ -1 +1 @@ -calculateSMA | chart-patterns

Generated using TypeDoc

\ No newline at end of file +calculateSMA | chart-patterns

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.MovingAverage.detectCrossing.html b/docs/functions/lib.MovingAverage.detectCrossing.html index defeb63b..6f231cc5 100644 --- a/docs/functions/lib.MovingAverage.detectCrossing.html +++ b/docs/functions/lib.MovingAverage.detectCrossing.html @@ -1 +1 @@ -detectCrossing | chart-patterns

Generated using TypeDoc

\ No newline at end of file +detectCrossing | chart-patterns

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.Orderflow.HighVolumeNode.findHighVolumeNodes.html b/docs/functions/lib.Orderflow.HighVolumeNode.findHighVolumeNodes.html index 4db2e830..853c9b79 100644 --- a/docs/functions/lib.Orderflow.HighVolumeNode.findHighVolumeNodes.html +++ b/docs/functions/lib.Orderflow.HighVolumeNode.findHighVolumeNodes.html @@ -7,4 +7,4 @@ ask volume, and bid volume.

Example

const trades = { 
"100.5": { volSumAsk: 500, volSumBid: 600 },
"101.0": { volSumAsk: 300, volSumBid: 400 }
};
const totalVol = 1800;
const config = { threshold: 0.5 };
const highVolNodes = findHighVolumeNodes(trades, totalVol, config);
// Returns: [{ price: 100.5, totalVolume: 1100, askVolume: 500, bidVolume: 600 }]
-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.Orderflow.OrderflowUtils.adjustOrderFlowResolution.html b/docs/functions/lib.Orderflow.OrderflowUtils.adjustOrderFlowResolution.html index 2faea3a7..006a3a7b 100644 --- a/docs/functions/lib.Orderflow.OrderflowUtils.adjustOrderFlowResolution.html +++ b/docs/functions/lib.Orderflow.OrderflowUtils.adjustOrderFlowResolution.html @@ -9,4 +9,4 @@

Remarks

This function is optimised for performance, using a traditional for loop and avoiding unnecessary object creation. It's particularly useful for adjusting the granularity of orderflow data, which can be helpful for analysis at different price resolutions.

-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.Orderflow.StackedImbalances.detectImbalances.html b/docs/functions/lib.Orderflow.StackedImbalances.detectImbalances.html index 584e6f2b..65f03e7a 100644 --- a/docs/functions/lib.Orderflow.StackedImbalances.detectImbalances.html +++ b/docs/functions/lib.Orderflow.StackedImbalances.detectImbalances.html @@ -2,4 +2,4 @@

Parameters

Returns Imbalance[]

An array of Imbalance objects.

-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.Orderflow.StackedImbalances.detectStackedImbalances.html b/docs/functions/lib.Orderflow.StackedImbalances.detectStackedImbalances.html index d641fabe..12e05afe 100644 --- a/docs/functions/lib.Orderflow.StackedImbalances.detectStackedImbalances.html +++ b/docs/functions/lib.Orderflow.StackedImbalances.detectStackedImbalances.html @@ -2,4 +2,4 @@

Parameters

Returns IStackedImbalancesResult[]

An array of IStackedImbalancesResult, where each element represents the range of a stacked imbalance.

-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.PeakDetector.findSignals.html b/docs/functions/lib.PeakDetector.findSignals.html index 1bf9bfb2..9f173815 100644 --- a/docs/functions/lib.PeakDetector.findSignals.html +++ b/docs/functions/lib.PeakDetector.findSignals.html @@ -2,4 +2,4 @@

Parameters

Returns IPeak[][] | IPeak[]

Peak are grouped by direction: (-1, -1, 1, 1, -1, -1) or a flattened version: (-1, -1, 1, 1, -1, -1) becomes -1, 1, -1

-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.PeakDetector.getPeakRanges.html b/docs/functions/lib.PeakDetector.getPeakRanges.html index 30b12d05..d3659208 100644 --- a/docs/functions/lib.PeakDetector.getPeakRanges.html +++ b/docs/functions/lib.PeakDetector.getPeakRanges.html @@ -2,4 +2,4 @@

Parameters

Returns IPeakRange[]

An array of peak ranges, each with a direction, start, and end timestamp.

-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.PivotPoints.calculatePivotPoints.html b/docs/functions/lib.PivotPoints.calculatePivotPoints.html index 770e5663..717001f7 100644 --- a/docs/functions/lib.PivotPoints.calculatePivotPoints.html +++ b/docs/functions/lib.PivotPoints.calculatePivotPoints.html @@ -5,4 +5,4 @@

Returns IPivotPoints

The calculated pivot points.

Example

// Assuming 'dailyCandles' is an array of ICandle objects from a single day
const pivotPoints: IPivotPoints = calculatePivotPoints(dailyCandles);

// Assuming 'yesterdayCandle' is a single ICandle object representing yesterday's day candle
const pivotPoints: IPivotPoints = calculatePivotPoints(yesterdayCandle);
-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.RSI.calculateRSI.html b/docs/functions/lib.RSI.calculateRSI.html index e5f3ebfc..b1061b5d 100644 --- a/docs/functions/lib.RSI.calculateRSI.html +++ b/docs/functions/lib.RSI.calculateRSI.html @@ -1 +1 @@ -calculateRSI | chart-patterns
  • Parameters

    • candles: ICandle[]
    • period: number = 14
    • numElements: number = 2

    Returns number[]

Generated using TypeDoc

\ No newline at end of file +calculateRSI | chart-patterns
  • Parameters

    • candles: ICandle[]
    • period: number = 14
    • numElements: number = 2

    Returns number[]

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.VWAP.calculateVWAP.html b/docs/functions/lib.VWAP.calculateVWAP.html index 1d61f571..2c2cb1ff 100644 --- a/docs/functions/lib.VWAP.calculateVWAP.html +++ b/docs/functions/lib.VWAP.calculateVWAP.html @@ -1 +1 @@ -calculateVWAP | chart-patterns

Generated using TypeDoc

\ No newline at end of file +calculateVWAP | chart-patterns

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.ValueArea.calculate.html b/docs/functions/lib.ValueArea.calculate.html index 03bb0a73..e19f9786 100644 --- a/docs/functions/lib.ValueArea.calculate.html +++ b/docs/functions/lib.ValueArea.calculate.html @@ -1,4 +1,4 @@ calculate | chart-patterns
  • analyses a set of candlesticks to calculate the value area and related metrics for a specific period.

    Parameters

    • candles: ICandle[]

      An array of candlesticks for the period to analyse.

    Returns IValueArea

    An object representing the value area metrics, including VAH, VAL, POC, EQ (Equilibrium), and the low and high prices.

    -

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.VolumeProfile.build.html b/docs/functions/lib.VolumeProfile.build.html index a6a62700..c2f2bdd9 100644 --- a/docs/functions/lib.VolumeProfile.build.html +++ b/docs/functions/lib.VolumeProfile.build.html @@ -12,4 +12,4 @@

Example

// Assuming 'candles' is an array of ICandle objects representing the price data
// Create a volume profile with a specified tick size
const volumeProfile: IVolumeProfile = VolumeProfile.build({ candles, tickSize: 0.5, period: MARKET_PROFILE_PERIODS.DAILY, timezone: 'Europe/London' });
-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.VolumeProfile.findExcess.html b/docs/functions/lib.VolumeProfile.findExcess.html index 6e269f0c..e198261d 100644 --- a/docs/functions/lib.VolumeProfile.findExcess.html +++ b/docs/functions/lib.VolumeProfile.findExcess.html @@ -11,4 +11,4 @@

Returns IVolumeProfileObservation[]

An array of volume profile observations indicating excess points.

Note

The significance of an excess point is determined by comparing the length of the candle's tail (upper or lower) to its overall length. A long tail relative to the candle's body, extending beyond the value area, indicates a significant excess point.

-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.VolumeProfile.findNakedPointOfControl.html b/docs/functions/lib.VolumeProfile.findNakedPointOfControl.html index 8c0d0325..337405c3 100644 --- a/docs/functions/lib.VolumeProfile.findNakedPointOfControl.html +++ b/docs/functions/lib.VolumeProfile.findNakedPointOfControl.html @@ -1,3 +1,3 @@ findNakedPointOfControl | chart-patterns

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.VolumeProfile.findSinglePrints.html b/docs/functions/lib.VolumeProfile.findSinglePrints.html index d284d602..d6bb5d5e 100644 --- a/docs/functions/lib.VolumeProfile.findSinglePrints.html +++ b/docs/functions/lib.VolumeProfile.findSinglePrints.html @@ -10,4 +10,4 @@

Returns IVolumeProfileObservation[]

An array of volume profile observations indicating single prints.

Note

The function identifies single prints by looking for long candles that create new highs or lows without subsequent price retracement. This indicates a rapid price movement with minimal trading activity at these levels, characteristic of single prints.

-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.VolumeProfile.isFailedAuction.html b/docs/functions/lib.VolumeProfile.isFailedAuction.html index b5e1c792..35bf588a 100644 --- a/docs/functions/lib.VolumeProfile.isFailedAuction.html +++ b/docs/functions/lib.VolumeProfile.isFailedAuction.html @@ -8,4 +8,4 @@

Returns IVolumeProfileObservation[]

An array of volume profile observations indicating failed auctions.

Note

The function is based on volume profile theory, which is a technique used in financial trading to analyse price movements and trading volumes over a certain period. It helps in identifying key trading ranges and potential turning points in the market.

-

Generated using TypeDoc

\ No newline at end of file +

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.ZigZags.create.html b/docs/functions/lib.ZigZags.create.html index 67df7484..cf9e4a2a 100644 --- a/docs/functions/lib.ZigZags.create.html +++ b/docs/functions/lib.ZigZags.create.html @@ -4,4 +4,4 @@
  • threshold: number

    The threshold value for identifying significant price changes.

  • influence: number

    The influence factor for adjusting the impact of recent signals on the algorithm.

  • Returns IZigZag[]

    An array of ZigZag points representing significant price changes.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 29a9e764..c0e3308b 100644 --- a/docs/index.html +++ b/docs/index.html @@ -4,7 +4,8 @@
    import { MarketProfile, VolumeProfile } from 'chart-patterns'

    const marketProfiles = MarketProfile.build({
    candles,
    period: MARKET_PROFILE_PERIODS.DAILY,
    tickSize: 0.1,
    tickMultiplier: 100,
    timezone: 'Europe/London'
    });

    const volumeProfiles: IVolumeProfile = VolumeProfile.create({
    candles,
    tickSize: 0.1,
    period: MARKET_PROFILE_PERIODS.DAY,
    timezone: 'Europe/London'
    })
    diff --git a/docs/interfaces/constants.IFibonacciRetracement.html b/docs/interfaces/constants.IFibonacciRetracement.html index 4dad8b45..354912a1 100644 --- a/docs/interfaces/constants.IFibonacciRetracement.html +++ b/docs/interfaces/constants.IFibonacciRetracement.html @@ -1,4 +1,4 @@ -IFibonacciRetracement | chart-patterns

    Interface IFibonacciRetracement

    interface IFibonacciRetracement {
        0: number;
        0.236: number;
        0.382: number;
        0.5: number;
        0.618: number;
        0.66: number;
        0.786: number;
        1: number;
        1.618: number;
    }

    Properties

    0 +IFibonacciRetracement | chart-patterns

    Interface IFibonacciRetracement

    interface IFibonacciRetracement {
        0: number;
        0.236: number;
        0.382: number;
        0.5: number;
        0.618: number;
        0.66: number;
        0.786: number;
        1: number;
        1.618: number;
    }

    Properties

    0 0.236 0.382 0.5 @@ -7,4 +7,4 @@ 0.786 1 1.618 -

    Properties

    0: number
    0.236: number
    0.382: number
    0.5: number
    0.618: number
    0.66: number
    0.786: number
    1: number
    1.618: number

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    0: number
    0.236: number
    0.382: number
    0.5: number
    0.618: number
    0.66: number
    0.786: number
    1: number
    1.618: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.EmaCrossingResult.html b/docs/interfaces/types.EmaCrossingResult.html index ab8ee169..57d964a5 100644 --- a/docs/interfaces/types.EmaCrossingResult.html +++ b/docs/interfaces/types.EmaCrossingResult.html @@ -1,6 +1,6 @@ -EmaCrossingResult | chart-patterns

    Interface EmaCrossingResult

    interface EmaCrossingResult {
        direction: SIGNAL_DIRECTION;
        interval: INTERVALS;
        longPeriod: MA_Periods;
        shortPeriod: MA_Periods;
        time: Date;
    }

    Properties

    direction +EmaCrossingResult | chart-patterns

    Interface EmaCrossingResult

    interface EmaCrossingResult {
        direction: SIGNAL_DIRECTION;
        interval: INTERVALS;
        longPeriod: MA_Periods;
        shortPeriod: MA_Periods;
        time: Date;
    }

    Properties

    direction: SIGNAL_DIRECTION
    interval: INTERVALS
    longPeriod: MA_Periods
    shortPeriod: MA_Periods
    time: Date

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    direction: SIGNAL_DIRECTION
    interval: INTERVALS
    longPeriod: MA_Periods
    shortPeriod: MA_Periods
    time: Date

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.ICandle.html b/docs/interfaces/types.ICandle.html index 26570e35..3c983332 100644 --- a/docs/interfaces/types.ICandle.html +++ b/docs/interfaces/types.ICandle.html @@ -1,4 +1,4 @@ -ICandle | chart-patterns
    interface ICandle {
        close: number;
        closeTime: Date;
        high: number;
        interval: string;
        low: number;
        open: number;
        openTime: Date;
        symbol: string;
        volume: number;
    }

    Properties

    close +ICandle | chart-patterns
    interface ICandle {
        close: number;
        closeTime: Date;
        high: number;
        interval: string;
        low: number;
        open: number;
        openTime: Date;
        symbol: string;
        volume: number;
    }

    Properties

    Properties

    close: number
    closeTime: Date
    high: number
    interval: string
    low: number
    open: number
    openTime: Date
    symbol: string
    volume: number

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    close: number
    closeTime: Date
    high: number
    interval: string
    low: number
    open: number
    openTime: Date
    symbol: string
    volume: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IEmaOutcome.html b/docs/interfaces/types.IEmaOutcome.html index ffa5b35a..8e6b0401 100644 --- a/docs/interfaces/types.IEmaOutcome.html +++ b/docs/interfaces/types.IEmaOutcome.html @@ -1 +1 @@ -IEmaOutcome | chart-patterns

    Interface IEmaOutcome

    interface IEmaOutcome {
        [period: string]: number;
    }

    Indexable

    [period: string]: number

    Generated using TypeDoc

    \ No newline at end of file +IEmaOutcome | chart-patterns

    Interface IEmaOutcome

    interface IEmaOutcome {
        [period: string]: number;
    }

    Indexable

    [period: string]: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IEngulfingCandleConfig.html b/docs/interfaces/types.IEngulfingCandleConfig.html index b9e46d98..4c1fa918 100644 --- a/docs/interfaces/types.IEngulfingCandleConfig.html +++ b/docs/interfaces/types.IEngulfingCandleConfig.html @@ -1,10 +1,10 @@ IEngulfingCandleConfig | chart-patterns

    Interface IEngulfingCandleConfig

    Configuration for finding engulfing candle patterns. This interface defines the structure of the configuration object required to identify engulfing candle patterns in a series of candles.

    -
    interface IEngulfingCandleConfig {
        candles: ICandle[];
        index?: number;
    }

    Properties

    interface IEngulfingCandleConfig {
        candles: ICandle[];
        index?: number;
    }

    Properties

    Properties

    candles: ICandle[]

    An array of candles to analyse for engulfing patterns. Each candle in the array should conform to the ICandle interface.

    -
    index?: number

    The index of the specific candle in the candles array to check for an engulfing pattern. +

    index?: number

    The index of the specific candle in the candles array to check for an engulfing pattern. If not provided, the function will default to checking the last candle in the array.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IFindHighVolumeNodeConfig.html b/docs/interfaces/types.IFindHighVolumeNodeConfig.html index 63fcc520..9d10d425 100644 --- a/docs/interfaces/types.IFindHighVolumeNodeConfig.html +++ b/docs/interfaces/types.IFindHighVolumeNodeConfig.html @@ -1,2 +1,2 @@ -IFindHighVolumeNodeConfig | chart-patterns

    Interface IFindHighVolumeNodeConfig

    interface IFindHighVolumeNodeConfig {
        threshold: number;
    }

    Properties

    Properties

    threshold: number

    Generated using TypeDoc

    \ No newline at end of file +IFindHighVolumeNodeConfig | chart-patterns

    Interface IFindHighVolumeNodeConfig

    interface IFindHighVolumeNodeConfig {
        threshold: number;
    }

    Properties

    Properties

    threshold: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IFootPrintCandle.html b/docs/interfaces/types.IFootPrintCandle.html index 6f47d898..2895610f 100644 --- a/docs/interfaces/types.IFootPrintCandle.html +++ b/docs/interfaces/types.IFootPrintCandle.html @@ -1,4 +1,4 @@ -IFootPrintCandle | chart-patterns

    Interface IFootPrintCandle

    interface IFootPrintCandle {
        close: number;
        closeTime: Date;
        closeTimeMs: number;
        high: number;
        interval: string;
        low: number;
        open: number;
        openTime: Date;
        openTimeMs: number;
        symbol: string;
        trades: Record<string, OrderFlowRow>;
        volume: number;
    }

    Properties

    close +IFootPrintCandle | chart-patterns

    Interface IFootPrintCandle

    interface IFootPrintCandle {
        close: number;
        closeTime: Date;
        closeTimeMs: number;
        high: number;
        interval: string;
        low: number;
        open: number;
        openTime: Date;
        openTimeMs: number;
        symbol: string;
        trades: Record<string, OrderFlowRow>;
        volume: number;
    }

    Properties

    Properties

    close: number
    closeTime: Date
    closeTimeMs: number
    high: number
    interval: string
    low: number
    open: number
    openTime: Date
    openTimeMs: number
    symbol: string
    trades: Record<string, OrderFlowRow>
    volume: number

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    close: number
    closeTime: Date
    closeTimeMs: number
    high: number
    interval: string
    low: number
    open: number
    openTime: Date
    openTimeMs: number
    symbol: string
    trades: Record<string, OrderFlowRow>
    volume: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IHarmonic.html b/docs/interfaces/types.IHarmonic.html index ecd2252d..71333db4 100644 --- a/docs/interfaces/types.IHarmonic.html +++ b/docs/interfaces/types.IHarmonic.html @@ -1,5 +1,5 @@ IHarmonic | chart-patterns

    Interface IHarmonic

    Represents a harmonic pattern extended from an XABCD pattern with additional properties.

    -
    interface IHarmonic {
        A: IZigZag;
        ABC: number;
        B: IZigZag;
        BCD: number;
        C: IZigZag;
        D?: IZigZag;
        X: IZigZag;
        XAB: number;
        XAD: number;
        error?: number;
        isDeveloping: boolean;
        lastTimestamp?: number;
        type: HARMONIC_PATTERNS;
    }

    Hierarchy

    Properties

    A +
    interface IHarmonic {
        A: IZigZag;
        ABC: number;
        B: IZigZag;
        BCD: number;
        C: IZigZag;
        D?: IZigZag;
        X: IZigZag;
        XAB: number;
        XAD: number;
        error?: number;
        isDeveloping: boolean;
        lastTimestamp?: number;
        type: HARMONIC_PATTERNS;
    }

    Hierarchy

    Properties

    A ABC B BCD @@ -13,16 +13,16 @@ lastTimestamp? type

    Properties

    The second point of the XABCD pattern.

    -
    ABC: number

    The ratio of the BC segment to the AB segment.

    -

    The third point of the XABCD pattern.

    -
    BCD: number

    The ratio of the CD segment to the BC segment.

    -

    The fourth point of the XABCD pattern.

    -

    The fifth and final point of the XABCD pattern.

    -

    The starting point of the XABCD pattern.

    -
    XAB: number

    The ratio of the AB segment to the XA segment.

    -
    XAD: number

    The ratio of the XD segment to the XA segment.

    -
    error?: number

    The error rate in the pattern recognition process.

    -
    isDeveloping: boolean

    Indicates whether the pattern is currently developing or completed.

    -
    lastTimestamp?: number

    The timestamp of the last point in the pattern, useful for tracking the pattern's progression over time.

    -

    The specific type of harmonic pattern, e.g., Gartley, Butterfly, etc.

    -

    Generated using TypeDoc

    \ No newline at end of file +
    ABC: number

    The ratio of the BC segment to the AB segment.

    +
    B: IZigZag

    The third point of the XABCD pattern.

    +
    BCD: number

    The ratio of the CD segment to the BC segment.

    +
    C: IZigZag

    The fourth point of the XABCD pattern.

    +
    D?: IZigZag

    The fifth and final point of the XABCD pattern.

    +
    X: IZigZag

    The starting point of the XABCD pattern.

    +
    XAB: number

    The ratio of the AB segment to the XA segment.

    +
    XAD: number

    The ratio of the XD segment to the XA segment.

    +
    error?: number

    The error rate in the pattern recognition process.

    +
    isDeveloping: boolean

    Indicates whether the pattern is currently developing or completed.

    +
    lastTimestamp?: number

    The timestamp of the last point in the pattern, useful for tracking the pattern's progression over time.

    +
    type: HARMONIC_PATTERNS

    The specific type of harmonic pattern, e.g., Gartley, Butterfly, etc.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IHighVolumeNode.html b/docs/interfaces/types.IHighVolumeNode.html index d5114ceb..62637ad6 100644 --- a/docs/interfaces/types.IHighVolumeNode.html +++ b/docs/interfaces/types.IHighVolumeNode.html @@ -1,5 +1,5 @@ -IHighVolumeNode | chart-patterns

    Interface IHighVolumeNode

    interface IHighVolumeNode {
        askVolume: number;
        bidVolume: number;
        price: number;
        totalVolume: number;
    }

    Properties

    askVolume +IHighVolumeNode | chart-patterns

    Interface IHighVolumeNode

    interface IHighVolumeNode {
        askVolume: number;
        bidVolume: number;
        price: number;
        totalVolume: number;
    }

    Properties

    askVolume: number
    bidVolume: number
    price: number
    totalVolume: number

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    askVolume: number
    bidVolume: number
    price: number
    totalVolume: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IInitialBalance.html b/docs/interfaces/types.IInitialBalance.html index e2ec80a4..7699e868 100644 --- a/docs/interfaces/types.IInitialBalance.html +++ b/docs/interfaces/types.IInitialBalance.html @@ -1,6 +1,6 @@ IInitialBalance | chart-patterns

    Interface IInitialBalance

    Represents the initial balance of a trading session in volume profile, defined by its high and low price points.

    -
    interface IInitialBalance {
        high: number;
        low: number;
    }

    Properties

    interface IInitialBalance {
        high: number;
        low: number;
    }

    Properties

    Properties

    high: number

    The highest price within the initial balance period.

    -
    low: number

    The lowest price within the initial balance period.

    -

    Generated using TypeDoc

    \ No newline at end of file +
    low: number

    The lowest price within the initial balance period.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.ILocalRange.html b/docs/interfaces/types.ILocalRange.html index 615e453e..e9fbafc0 100644 --- a/docs/interfaces/types.ILocalRange.html +++ b/docs/interfaces/types.ILocalRange.html @@ -1,7 +1,7 @@ -ILocalRange | chart-patterns

    Interface ILocalRange

    interface ILocalRange {
        direction?: SIGNAL_DIRECTION;
        end?: string | number;
        fibs?: {
            highToLow?: IFibonacciRetracement;
            lowToHigh?: IFibonacciRetracement;
        };
        resistance?: number;
        start?: string | number;
        support?: number;
    }

    Properties

    direction? +ILocalRange | chart-patterns

    Interface ILocalRange

    interface ILocalRange {
        direction?: SIGNAL_DIRECTION;
        end?: string | number;
        fibs?: {
            highToLow?: IFibonacciRetracement;
            lowToHigh?: IFibonacciRetracement;
        };
        resistance?: number;
        start?: string | number;
        support?: number;
    }

    Properties

    direction?: SIGNAL_DIRECTION
    end?: string | number
    fibs?: {
        highToLow?: IFibonacciRetracement;
        lowToHigh?: IFibonacciRetracement;
    }

    Type declaration

    resistance?: number
    start?: string | number
    support?: number

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    direction?: SIGNAL_DIRECTION
    end?: string | number
    fibs?: {
        highToLow?: IFibonacciRetracement;
        lowToHigh?: IFibonacciRetracement;
    }

    Type declaration

    resistance?: number
    start?: string | number
    support?: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IMarketProfile.html b/docs/interfaces/types.IMarketProfile.html index 677d6288..7924848d 100644 --- a/docs/interfaces/types.IMarketProfile.html +++ b/docs/interfaces/types.IMarketProfile.html @@ -1,4 +1,4 @@ -IMarketProfile | chart-patterns

    Interface IMarketProfile

    interface IMarketProfile {
        IB?: IInitialBalance;
        endTime: string | number | Date;
        excess?: IVolumeProfileObservation[];
        failedAuction?: IVolumeProfileObservation[];
        ledges?: IVolumeProfileObservation[];
        poorHighLow?: IVolumeProfileObservation[];
        singlePrints?: IVolumeProfileObservation[];
        startTime: string | number | Date;
        structure: IMarketProfileStructure;
        valueArea?: IValueArea;
    }

    Properties

    IB? +IMarketProfile | chart-patterns

    Interface IMarketProfile

    interface IMarketProfile {
        IB?: IInitialBalance;
        endTime: string | number | Date;
        excess?: IVolumeProfileObservation[];
        failedAuction?: IVolumeProfileObservation[];
        ledges?: IVolumeProfileObservation[];
        poorHighLow?: IVolumeProfileObservation[];
        singlePrints?: IVolumeProfileObservation[];
        startTime: string | number | Date;
        structure: IMarketProfileStructure;
        valueArea?: IValueArea;
    }

    Properties

    endTime: string | number | Date
    failedAuction?: IVolumeProfileObservation[]
    singlePrints?: IVolumeProfileObservation[]
    startTime: string | number | Date
    valueArea?: IValueArea

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    endTime: string | number | Date
    failedAuction?: IVolumeProfileObservation[]
    singlePrints?: IVolumeProfileObservation[]
    startTime: string | number | Date
    valueArea?: IValueArea

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IMarketProfileBuilderConfig.html b/docs/interfaces/types.IMarketProfileBuilderConfig.html index 2c820156..1e9cbdb9 100644 --- a/docs/interfaces/types.IMarketProfileBuilderConfig.html +++ b/docs/interfaces/types.IMarketProfileBuilderConfig.html @@ -1,6 +1,6 @@ -IMarketProfileBuilderConfig | chart-patterns

    Interface IMarketProfileBuilderConfig

    interface IMarketProfileBuilderConfig {
        candles: ICandle[];
        period: MARKET_PROFILE_PERIODS;
        tickMultiplier: number;
        tickSize: number;
        timezone: string;
    }

    Properties

    candles +IMarketProfileBuilderConfig | chart-patterns

    Interface IMarketProfileBuilderConfig

    interface IMarketProfileBuilderConfig {
        candles: ICandle[];
        period: MARKET_PROFILE_PERIODS;
        tickMultiplier: number;
        tickSize: number;
        timezone: string;
    }

    Properties

    candles: ICandle[]
    tickMultiplier: number
    tickSize: number
    timezone: string

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    candles: ICandle[]
    tickMultiplier: number
    tickSize: number
    timezone: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IMarketProfileStructure.html b/docs/interfaces/types.IMarketProfileStructure.html index ca807361..cd3e06d6 100644 --- a/docs/interfaces/types.IMarketProfileStructure.html +++ b/docs/interfaces/types.IMarketProfileStructure.html @@ -1,3 +1,3 @@ -IMarketProfileStructure | chart-patterns

    Interface IMarketProfileStructure

    interface IMarketProfileStructure {
        endTime: string | number | Date;
        startTime: string | number | Date;
    }

    Properties

    endTime +IMarketProfileStructure | chart-patterns

    Interface IMarketProfileStructure

    interface IMarketProfileStructure {
        endTime: string | number | Date;
        startTime: string | number | Date;
    }

    Properties

    Properties

    endTime: string | number | Date
    startTime: string | number | Date

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    endTime: string | number | Date
    startTime: string | number | Date

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.INakedPointOfControl.html b/docs/interfaces/types.INakedPointOfControl.html index 1948a8ec..8fc14ffb 100644 --- a/docs/interfaces/types.INakedPointOfControl.html +++ b/docs/interfaces/types.INakedPointOfControl.html @@ -1,3 +1,3 @@ -INakedPointOfControl | chart-patterns

    Interface INakedPointOfControl

    interface INakedPointOfControl {
        resistance?: number;
        support?: number;
    }

    Properties

    resistance? +INakedPointOfControl | chart-patterns

    Interface INakedPointOfControl

    interface INakedPointOfControl {
        resistance?: number;
        support?: number;
    }

    Properties

    Properties

    resistance?: number
    support?: number

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    resistance?: number
    support?: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IPeak.html b/docs/interfaces/types.IPeak.html index 99db4249..bfc9e7f4 100644 --- a/docs/interfaces/types.IPeak.html +++ b/docs/interfaces/types.IPeak.html @@ -1,3 +1,3 @@ -IPeak | chart-patterns
    interface IPeak {
        direction: 1 | -1;
        position?: number;
    }

    Hierarchy

    Properties

    direction +IPeak | chart-patterns
    interface IPeak {
        direction: 1 | -1;
        position?: number;
    }

    Hierarchy

    Properties

    Properties

    direction: 1 | -1
    position?: number

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    direction: 1 | -1
    position?: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IPeakRange.html b/docs/interfaces/types.IPeakRange.html index 20660ab7..30efa4d2 100644 --- a/docs/interfaces/types.IPeakRange.html +++ b/docs/interfaces/types.IPeakRange.html @@ -1,5 +1,5 @@ -IPeakRange | chart-patterns

    Interface IPeakRange

    interface IPeakRange {
        direction: 1 | -1;
        end?: number;
        position?: number;
        start?: number;
    }

    Hierarchy

    Properties

    direction +IPeakRange | chart-patterns

    Interface IPeakRange

    interface IPeakRange {
        direction: 1 | -1;
        end?: number;
        position?: number;
        start?: number;
    }

    Hierarchy

    Properties

    direction: 1 | -1
    end?: number
    position?: number
    start?: number

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    direction: 1 | -1
    end?: number
    position?: number
    start?: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IPivotPoints.html b/docs/interfaces/types.IPivotPoints.html index 59a18601..8d82a4ec 100644 --- a/docs/interfaces/types.IPivotPoints.html +++ b/docs/interfaces/types.IPivotPoints.html @@ -1,8 +1,8 @@ -IPivotPoints | chart-patterns

    Interface IPivotPoints

    interface IPivotPoints {
        pivot: number;
        resistance1: number;
        resistance2: number;
        resistance3: number;
        support1: number;
        support2: number;
        support3: number;
    }

    Properties

    pivot +IPivotPoints | chart-patterns

    Interface IPivotPoints

    interface IPivotPoints {
        pivot: number;
        resistance1: number;
        resistance2: number;
        resistance3: number;
        support1: number;
        support2: number;
        support3: number;
    }

    Properties

    pivot: number
    resistance1: number
    resistance2: number
    resistance3: number
    support1: number
    support2: number
    support3: number

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    pivot: number
    resistance1: number
    resistance2: number
    resistance3: number
    support1: number
    support2: number
    support3: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IRanges.html b/docs/interfaces/types.IRanges.html index 59858325..fec21068 100644 --- a/docs/interfaces/types.IRanges.html +++ b/docs/interfaces/types.IRanges.html @@ -1,3 +1,3 @@ -IRanges | chart-patterns
    interface IRanges {
        global?: ILocalRange;
        local?: ILocalRange[];
    }

    Properties

    global? +IRanges | chart-patterns
    interface IRanges {
        global?: ILocalRange;
        local?: ILocalRange[];
    }

    Properties

    Properties

    global?: ILocalRange
    local?: ILocalRange[]

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    global?: ILocalRange
    local?: ILocalRange[]

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.ISignalsConfig.html b/docs/interfaces/types.ISignalsConfig.html index d3b112ec..67fcaf21 100644 --- a/docs/interfaces/types.ISignalsConfig.html +++ b/docs/interfaces/types.ISignalsConfig.html @@ -1,11 +1,11 @@ ISignalsConfig | chart-patterns

    Interface ISignalsConfig

    Configuration object used for generating signals, particularly in the context of peak detection algorithms.

    -
    interface ISignalsConfig {
        flatten?: boolean;
        influence: number;
        lag: number;
        threshold: number;
        values: number[];
    }

    Properties

    interface ISignalsConfig {
        flatten?: boolean;
        influence: number;
        lag: number;
        threshold: number;
        values: number[];
    }

    Properties

    flatten?: boolean
    influence: number

    A factor that determines the influence of signals on subsequent calculations, affecting how strongly the identified signals affect the moving average.

    -
    lag: number

    The number of periods (or candles) that will be considered for calculating the moving average, which is used in signal detection.

    -
    threshold: number

    The threshold value for determining significant deviations from the moving average, used in identifying potential signals.

    -
    values: number[]

    An array of numerical values (e.g., closing prices of candles) to be analysed.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    flatten?: boolean
    influence: number

    A factor that determines the influence of signals on subsequent calculations, affecting how strongly the identified signals affect the moving average.

    +
    lag: number

    The number of periods (or candles) that will be considered for calculating the moving average, which is used in signal detection.

    +
    threshold: number

    The threshold value for determining significant deviations from the moving average, used in identifying potential signals.

    +
    values: number[]

    An array of numerical values (e.g., closing prices of candles) to be analysed.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IStackedImbalanceConfig.html b/docs/interfaces/types.IStackedImbalanceConfig.html index 4cff8926..e94e3791 100644 --- a/docs/interfaces/types.IStackedImbalanceConfig.html +++ b/docs/interfaces/types.IStackedImbalanceConfig.html @@ -1,9 +1,9 @@ -IStackedImbalanceConfig | chart-patterns

    Interface IStackedImbalanceConfig

    interface IStackedImbalanceConfig {
        stackCount?: number;
        threshold?: number;
        tickSize?: number;
    }

    Properties

    stackCount? +IStackedImbalanceConfig | chart-patterns

    Interface IStackedImbalanceConfig

    interface IStackedImbalanceConfig {
        stackCount?: number;
        threshold?: number;
        tickSize?: number;
    }

    Properties

    stackCount?: number

    The minimum number of consecutive imbalances required to form a stack. Default is 3.

    -
    threshold?: number

    The threshold percentage to determine an imbalance. +

    threshold?: number

    The threshold percentage to determine an imbalance. Default is 300.

    -
    tickSize?: number

    The size of the price tick.

    -

    Generated using TypeDoc

    \ No newline at end of file +
    tickSize?: number

    The size of the price tick.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IStackedImbalancesResult.html b/docs/interfaces/types.IStackedImbalancesResult.html index 3ff7e461..f362ea5a 100644 --- a/docs/interfaces/types.IStackedImbalancesResult.html +++ b/docs/interfaces/types.IStackedImbalancesResult.html @@ -1,4 +1,4 @@ -IStackedImbalancesResult | chart-patterns

    Interface IStackedImbalancesResult

    interface IStackedImbalancesResult {
        count: number;
        endPrice: number;
        startPrice: number;
    }

    Properties

    count +IStackedImbalancesResult | chart-patterns

    Interface IStackedImbalancesResult

    interface IStackedImbalancesResult {
        count: number;
        endPrice: number;
        startPrice: number;
    }

    Properties

    count: number
    endPrice: number
    startPrice: number

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    count: number
    endPrice: number
    startPrice: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.ITimeFrame.html b/docs/interfaces/types.ITimeFrame.html index 0c3c1654..ee279eaf 100644 --- a/docs/interfaces/types.ITimeFrame.html +++ b/docs/interfaces/types.ITimeFrame.html @@ -1,5 +1,5 @@ -ITimeFrame | chart-patterns

    Interface ITimeFrame

    interface ITimeFrame {
        candles: ICandle[];
        endTime: string | number | Date;
        startTime: string | number | Date;
        timeFrameKey?: string;
    }

    Properties

    candles +ITimeFrame | chart-patterns

    Interface ITimeFrame

    interface ITimeFrame {
        candles: ICandle[];
        endTime: string | number | Date;
        startTime: string | number | Date;
        timeFrameKey?: string;
    }

    Properties

    candles: ICandle[]
    endTime: string | number | Date
    startTime: string | number | Date
    timeFrameKey?: string

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    candles: ICandle[]
    endTime: string | number | Date
    startTime: string | number | Date
    timeFrameKey?: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IValueArea.html b/docs/interfaces/types.IValueArea.html index 29150d2d..e4e97abf 100644 --- a/docs/interfaces/types.IValueArea.html +++ b/docs/interfaces/types.IValueArea.html @@ -1,7 +1,7 @@ -IValueArea | chart-patterns

    Interface IValueArea

    interface IValueArea {
        EQ: number;
        POC: number;
        VAH: number;
        VAL: number;
        high: number;
        low: number;
    }

    Properties

    EQ +IValueArea | chart-patterns

    Interface IValueArea

    interface IValueArea {
        EQ: number;
        POC: number;
        VAH: number;
        VAL: number;
        high: number;
        low: number;
    }

    Properties

    Properties

    EQ: number
    POC: number
    VAH: number
    VAL: number
    high: number
    low: number

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    EQ: number
    POC: number
    VAH: number
    VAL: number
    high: number
    low: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IVolumeProfile.html b/docs/interfaces/types.IVolumeProfile.html index 2cca2e89..ffb1f548 100644 --- a/docs/interfaces/types.IVolumeProfile.html +++ b/docs/interfaces/types.IVolumeProfile.html @@ -1,4 +1,4 @@ -IVolumeProfile | chart-patterns

    Interface IVolumeProfile

    interface IVolumeProfile {
        IB?: IInitialBalance;
        endTime: string | number | Date;
        excess?: IVolumeProfileObservation[];
        failedAuction?: IVolumeProfileObservation[];
        ledges?: IVolumeProfileObservation[];
        poorHighLow?: IVolumeProfileObservation[];
        singlePrints?: IVolumeProfileObservation[];
        startTime: string | number | Date;
        valueArea?: IValueArea;
    }

    Properties

    IB? +IVolumeProfile | chart-patterns

    Interface IVolumeProfile

    interface IVolumeProfile {
        IB?: IInitialBalance;
        endTime: string | number | Date;
        excess?: IVolumeProfileObservation[];
        failedAuction?: IVolumeProfileObservation[];
        ledges?: IVolumeProfileObservation[];
        poorHighLow?: IVolumeProfileObservation[];
        singlePrints?: IVolumeProfileObservation[];
        startTime: string | number | Date;
        valueArea?: IValueArea;
    }

    Properties

    endTime: string | number | Date
    failedAuction?: IVolumeProfileObservation[]
    singlePrints?: IVolumeProfileObservation[]
    startTime: string | number | Date
    valueArea?: IValueArea

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    endTime: string | number | Date
    failedAuction?: IVolumeProfileObservation[]
    singlePrints?: IVolumeProfileObservation[]
    startTime: string | number | Date
    valueArea?: IValueArea

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IVolumeProfileConfig.html b/docs/interfaces/types.IVolumeProfileConfig.html index 2988cdfe..fe608103 100644 --- a/docs/interfaces/types.IVolumeProfileConfig.html +++ b/docs/interfaces/types.IVolumeProfileConfig.html @@ -1,10 +1,10 @@ IVolumeProfileConfig | chart-patterns

    Interface IVolumeProfileConfig

    Configuration object used for calculating the volume profile.

    -
    interface IVolumeProfileConfig {
        candles: ICandle[];
        period: MARKET_PROFILE_PERIODS;
        tickSize: number;
        timezone: string;
    }

    Properties

    interface IVolumeProfileConfig {
        candles: ICandle[];
        period: MARKET_PROFILE_PERIODS;
        tickSize: number;
        timezone: string;
    }

    Properties

    candles: ICandle[]

    An array of candle objects representing the price data over a specific time period.

    -

    Specifies the time period over which the volume profile is calculated. +

    Specifies the time period over which the volume profile is calculated. Can be day, week, or month.

    -
    tickSize: number

    The size of a single tick, which is the smallest measurable movement in the price of the trading asset.

    -
    timezone: string

    Generated using TypeDoc

    \ No newline at end of file +
    tickSize: number

    The size of a single tick, which is the smallest measurable movement in the price of the trading asset.

    +
    timezone: string

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IVolumeProfileObservation.html b/docs/interfaces/types.IVolumeProfileObservation.html index b945fb69..df4527c3 100644 --- a/docs/interfaces/types.IVolumeProfileObservation.html +++ b/docs/interfaces/types.IVolumeProfileObservation.html @@ -1,8 +1,8 @@ IVolumeProfileObservation | chart-patterns

    Interface IVolumeProfileObservation

    Extends a trading signal with additional volume profile specific information.

    -
    interface IVolumeProfileObservation {
        peakValue?: number;
        period?: string;
        troughValue?: number;
    }

    Properties

    interface IVolumeProfileObservation {
        peakValue?: number;
        period?: string;
        troughValue?: number;
    }

    Properties

    peakValue?: number

    The peak value associated with the observation.

    -
    period?: string

    The specific period or session of the observation.

    -
    troughValue?: number

    The trough or lowest value associated with the observation.

    -

    Generated using TypeDoc

    \ No newline at end of file +
    period?: string

    The specific period or session of the observation.

    +
    troughValue?: number

    The trough or lowest value associated with the observation.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IVolumeProfileResult.html b/docs/interfaces/types.IVolumeProfileResult.html index eb80aba0..f6e0fe2b 100644 --- a/docs/interfaces/types.IVolumeProfileResult.html +++ b/docs/interfaces/types.IVolumeProfileResult.html @@ -1,6 +1,6 @@ IVolumeProfileResult | chart-patterns

    Interface IVolumeProfileResult

    Represents the overall structure of the volume profile analysis for a trading session or asset.

    -
    interface IVolumeProfileResult {
        npoc?: INakedPointOfControl;
        volumeProfiles?: IVolumeProfile[];
    }

    Properties

    interface IVolumeProfileResult {
        npoc?: INakedPointOfControl;
        volumeProfiles?: IVolumeProfile[];
    }

    Properties

    The naked points of control indicating untested price levels with significant past activity.

    -
    volumeProfiles?: IVolumeProfile[]

    An array of detailed volume profile findings for individual sessions or periods.

    -

    Generated using TypeDoc

    \ No newline at end of file +
    volumeProfiles?: IVolumeProfile[]

    An array of detailed volume profile findings for individual sessions or periods.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IVolumeRow.html b/docs/interfaces/types.IVolumeRow.html index bdd2bf69..69c5e853 100644 --- a/docs/interfaces/types.IVolumeRow.html +++ b/docs/interfaces/types.IVolumeRow.html @@ -1,5 +1,5 @@ -IVolumeRow | chart-patterns

    Interface IVolumeRow

    interface IVolumeRow {
        high: number;
        low: number;
        mid: number;
        volume: number;
    }

    Properties

    high +IVolumeRow | chart-patterns

    Interface IVolumeRow

    interface IVolumeRow {
        high: number;
        low: number;
        mid: number;
        volume: number;
    }

    Properties

    Properties

    high: number
    low: number
    mid: number
    volume: number

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    high: number
    low: number
    mid: number
    volume: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IXABCDPattern.html b/docs/interfaces/types.IXABCDPattern.html index 9ae2ca09..108b5b47 100644 --- a/docs/interfaces/types.IXABCDPattern.html +++ b/docs/interfaces/types.IXABCDPattern.html @@ -1,5 +1,5 @@ IXABCDPattern | chart-patterns

    Interface IXABCDPattern

    Represents the XABCD pattern with its points and calculated ratios, typically used in harmonic pattern analysis.

    -
    interface IXABCDPattern {
        A: IZigZag;
        ABC: number;
        B: IZigZag;
        BCD: number;
        C: IZigZag;
        D?: IZigZag;
        X: IZigZag;
        XAB: number;
        XAD: number;
        error?: number;
    }

    Hierarchy

    Properties

    A +
    interface IXABCDPattern {
        A: IZigZag;
        ABC: number;
        B: IZigZag;
        BCD: number;
        C: IZigZag;
        D?: IZigZag;
        X: IZigZag;
        XAB: number;
        XAD: number;
        error?: number;
    }

    Hierarchy

    Properties

    A ABC B BCD @@ -10,13 +10,13 @@ XAD error?

    Properties

    The second point of the XABCD pattern.

    -
    ABC: number

    The ratio of the BC segment to the AB segment.

    -

    The third point of the XABCD pattern.

    -
    BCD: number

    The ratio of the CD segment to the BC segment.

    -

    The fourth point of the XABCD pattern.

    -

    The fifth and final point of the XABCD pattern.

    -

    The starting point of the XABCD pattern.

    -
    XAB: number

    The ratio of the AB segment to the XA segment.

    -
    XAD: number

    The ratio of the XD segment to the XA segment.

    -
    error?: number

    The error rate in the pattern recognition process.

    -

    Generated using TypeDoc

    \ No newline at end of file +
    ABC: number

    The ratio of the BC segment to the AB segment.

    +
    B: IZigZag

    The third point of the XABCD pattern.

    +
    BCD: number

    The ratio of the CD segment to the BC segment.

    +
    C: IZigZag

    The fourth point of the XABCD pattern.

    +
    D?: IZigZag

    The fifth and final point of the XABCD pattern.

    +
    X: IZigZag

    The starting point of the XABCD pattern.

    +
    XAB: number

    The ratio of the AB segment to the XA segment.

    +
    XAD: number

    The ratio of the XD segment to the XA segment.

    +
    error?: number

    The error rate in the pattern recognition process.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IXABCDRatio.html b/docs/interfaces/types.IXABCDRatio.html index 07b53675..b17f9796 100644 --- a/docs/interfaces/types.IXABCDRatio.html +++ b/docs/interfaces/types.IXABCDRatio.html @@ -1,10 +1,10 @@ IXABCDRatio | chart-patterns

    Interface IXABCDRatio

    Defines the acceptable ratio ranges for each segment in an XABCD pattern, used in harmonic pattern analysis.

    -
    interface IXABCDRatio {
        ABC: [number, number];
        BCD: [number, number];
        XAB: [number, number];
        XAD: [number, number];
    }

    Properties

    ABC +
    interface IXABCDRatio {
        ABC: [number, number];
        BCD: [number, number];
        XAB: [number, number];
        XAD: [number, number];
    }

    Properties

    Properties

    ABC: [number, number]

    The acceptable minimum and maximum ratio range for the BC segment relative to the AB segment.

    -
    BCD: [number, number]

    The acceptable minimum and maximum ratio range for the CD segment relative to the BC segment.

    -
    XAB: [number, number]

    The acceptable minimum and maximum ratio range for the AB segment relative to the XA segment.

    -
    XAD: [number, number]

    The acceptable minimum and maximum ratio range for the XD segment relative to the XA segment.

    -

    Generated using TypeDoc

    \ No newline at end of file +
    BCD: [number, number]

    The acceptable minimum and maximum ratio range for the CD segment relative to the BC segment.

    +
    XAB: [number, number]

    The acceptable minimum and maximum ratio range for the AB segment relative to the XA segment.

    +
    XAD: [number, number]

    The acceptable minimum and maximum ratio range for the XD segment relative to the XA segment.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IZigZag.html b/docs/interfaces/types.IZigZag.html index 3e731e4c..240aaef8 100644 --- a/docs/interfaces/types.IZigZag.html +++ b/docs/interfaces/types.IZigZag.html @@ -1,4 +1,4 @@ -IZigZag | chart-patterns
    interface IZigZag {
        direction: zigzagType;
        price: number;
        timestamp: number;
    }

    Properties

    direction +IZigZag | chart-patterns
    interface IZigZag {
        direction: zigzagType;
        price: number;
        timestamp: number;
    }

    Properties

    direction: zigzagType
    price: number
    timestamp: number

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    direction: zigzagType
    price: number
    timestamp: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.Imbalance.html b/docs/interfaces/types.Imbalance.html index 8d7a7ca8..311c1f42 100644 --- a/docs/interfaces/types.Imbalance.html +++ b/docs/interfaces/types.Imbalance.html @@ -1,5 +1,5 @@ -Imbalance | chart-patterns

    Interface Imbalance

    interface Imbalance {
        imbalanceType: ImbalanceType;
        price: number;
        volSumAsk: number;
        volSumBid: number;
    }

    Properties

    imbalanceType +Imbalance | chart-patterns

    Interface Imbalance

    interface Imbalance {
        imbalanceType: ImbalanceType;
        price: number;
        volSumAsk: number;
        volSumBid: number;
    }

    Properties

    imbalanceType: ImbalanceType
    price: number
    volSumAsk: number
    volSumBid: number

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    imbalanceType: ImbalanceType
    price: number
    volSumAsk: number
    volSumBid: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.OrderFlowRow.html b/docs/interfaces/types.OrderFlowRow.html index ae8a5996..12ba8f50 100644 --- a/docs/interfaces/types.OrderFlowRow.html +++ b/docs/interfaces/types.OrderFlowRow.html @@ -1,3 +1,3 @@ -OrderFlowRow | chart-patterns

    Interface OrderFlowRow

    interface OrderFlowRow {
        volSumAsk: number;
        volSumBid: number;
    }

    Properties

    volSumAsk +OrderFlowRow | chart-patterns

    Interface OrderFlowRow

    interface OrderFlowRow {
        volSumAsk: number;
        volSumBid: number;
    }

    Properties

    Properties

    volSumAsk: number
    volSumBid: number

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    volSumAsk: number
    volSumBid: number

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/constants.html b/docs/modules/constants.html index ab68e4a8..6cd3b669 100644 --- a/docs/modules/constants.html +++ b/docs/modules/constants.html @@ -1,4 +1,4 @@ -constants | chart-patterns

    Module constants

    Index

    Enumerations

    FIBONACCI_NUMBERS +constants | chart-patterns

    Module constants

    Index

    Enumerations

    FIBONACCI_NUMBERS HARMONIC_PATTERNS INTERVALS ImbalanceType diff --git a/docs/modules/lib.CandlestickPatterns.html b/docs/modules/lib.CandlestickPatterns.html index b029912c..2f65517a 100644 --- a/docs/modules/lib.CandlestickPatterns.html +++ b/docs/modules/lib.CandlestickPatterns.html @@ -1,3 +1,3 @@ -CandlestickPatterns | chart-patterns

    Namespace CandlestickPatterns

    Index

    Functions

    findEngulfingCandle +CandlestickPatterns | chart-patterns

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/lib.Harmonics.html b/docs/modules/lib.Harmonics.html index ab8a0e33..7d91c0b0 100644 --- a/docs/modules/lib.Harmonics.html +++ b/docs/modules/lib.Harmonics.html @@ -1,3 +1,3 @@ -Harmonics | chart-patterns

    Namespace Harmonics

    Index

    Functions

    findPatterns +Harmonics | chart-patterns

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/lib.MovingAverage.html b/docs/modules/lib.MovingAverage.html index 149fb001..8a28e784 100644 --- a/docs/modules/lib.MovingAverage.html +++ b/docs/modules/lib.MovingAverage.html @@ -1,4 +1,4 @@ -MovingAverage | chart-patterns

    Namespace MovingAverage

    Index

    Functions

    calculateEMA +MovingAverage | chart-patterns

    Namespace MovingAverage

    Index

    Functions

    calculateEMA calculateEmas calculateSMA detectCrossing diff --git a/docs/modules/lib.Orderflow.HighVolumeNode.html b/docs/modules/lib.Orderflow.HighVolumeNode.html index 3f527082..c12d5890 100644 --- a/docs/modules/lib.Orderflow.HighVolumeNode.html +++ b/docs/modules/lib.Orderflow.HighVolumeNode.html @@ -1,2 +1,2 @@ -HighVolumeNode | chart-patterns

    Index

    Functions

    findHighVolumeNodes +HighVolumeNode | chart-patterns

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/lib.Orderflow.OrderflowUtils.html b/docs/modules/lib.Orderflow.OrderflowUtils.html index 27ae3104..13a9d64f 100644 --- a/docs/modules/lib.Orderflow.OrderflowUtils.html +++ b/docs/modules/lib.Orderflow.OrderflowUtils.html @@ -1,2 +1,2 @@ -OrderflowUtils | chart-patterns

    Index

    Functions

    adjustOrderFlowResolution +OrderflowUtils | chart-patterns

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/lib.Orderflow.StackedImbalances.html b/docs/modules/lib.Orderflow.StackedImbalances.html index 684b8f83..fa341b41 100644 --- a/docs/modules/lib.Orderflow.StackedImbalances.html +++ b/docs/modules/lib.Orderflow.StackedImbalances.html @@ -1,3 +1,3 @@ -StackedImbalances | chart-patterns

    Index

    Functions

    detectImbalances +StackedImbalances | chart-patterns

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/lib.Orderflow.html b/docs/modules/lib.Orderflow.html index d922a7b0..d6d71979 100644 --- a/docs/modules/lib.Orderflow.html +++ b/docs/modules/lib.Orderflow.html @@ -1,4 +1,4 @@ -Orderflow | chart-patterns

    Namespace Orderflow

    Index

    Namespaces

    HighVolumeNode +Orderflow | chart-patterns

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/lib.PeakDetector.html b/docs/modules/lib.PeakDetector.html index 56f2e09a..c8397feb 100644 --- a/docs/modules/lib.PeakDetector.html +++ b/docs/modules/lib.PeakDetector.html @@ -1,3 +1,3 @@ -PeakDetector | chart-patterns

    Namespace PeakDetector

    Index

    Functions

    findSignals +PeakDetector | chart-patterns

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/lib.PivotPoints.html b/docs/modules/lib.PivotPoints.html index 4ddbf967..b948959e 100644 --- a/docs/modules/lib.PivotPoints.html +++ b/docs/modules/lib.PivotPoints.html @@ -1,2 +1,2 @@ -PivotPoints | chart-patterns

    Namespace PivotPoints

    Index

    Functions

    calculatePivotPoints +PivotPoints | chart-patterns

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/lib.RSI.html b/docs/modules/lib.RSI.html index ce4efe04..eee27d04 100644 --- a/docs/modules/lib.RSI.html +++ b/docs/modules/lib.RSI.html @@ -1,2 +1,2 @@ -RSI | chart-patterns

    Index

    Functions

    calculateRSI +RSI | chart-patterns

    Index

    Functions

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/lib.RangeBuilder.html b/docs/modules/lib.RangeBuilder.html index e29586c7..997ffcd0 100644 --- a/docs/modules/lib.RangeBuilder.html +++ b/docs/modules/lib.RangeBuilder.html @@ -1,2 +1,2 @@ -RangeBuilder | chart-patterns

    Namespace RangeBuilder

    Index

    Classes

    default +RangeBuilder | chart-patterns

    Namespace RangeBuilder

    Index

    Classes

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/lib.VWAP.html b/docs/modules/lib.VWAP.html index b98fc4b7..89aa1476 100644 --- a/docs/modules/lib.VWAP.html +++ b/docs/modules/lib.VWAP.html @@ -1,2 +1,2 @@ -VWAP | chart-patterns

    Namespace VWAP

    Index

    Functions

    calculateVWAP +VWAP | chart-patterns

    Namespace VWAP

    Index

    Functions

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/lib.ValueArea.html b/docs/modules/lib.ValueArea.html index 11dcfd87..c1b8e22d 100644 --- a/docs/modules/lib.ValueArea.html +++ b/docs/modules/lib.ValueArea.html @@ -1,2 +1,2 @@ -ValueArea | chart-patterns

    Namespace ValueArea

    Index

    Functions

    calculate +ValueArea | chart-patterns

    Namespace ValueArea

    Index

    Functions

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/lib.VolumeProfile.html b/docs/modules/lib.VolumeProfile.html index bdf8087d..1072f321 100644 --- a/docs/modules/lib.VolumeProfile.html +++ b/docs/modules/lib.VolumeProfile.html @@ -1,4 +1,4 @@ -VolumeProfile | chart-patterns

    Namespace VolumeProfile

    Index

    Functions

    build +VolumeProfile | chart-patterns

    Namespace VolumeProfile

    Index

    Functions

    build findExcess findNakedPointOfControl findSinglePrints diff --git a/docs/modules/lib.ZScores.html b/docs/modules/lib.ZScores.html index 8913f506..96be680d 100644 --- a/docs/modules/lib.ZScores.html +++ b/docs/modules/lib.ZScores.html @@ -1,3 +1,3 @@ -ZScores | chart-patterns

    Namespace ZScores

    Index

    Classes

    ZScore +ZScores | chart-patterns

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/lib.ZigZags.html b/docs/modules/lib.ZigZags.html index 14837698..f10fad20 100644 --- a/docs/modules/lib.ZigZags.html +++ b/docs/modules/lib.ZigZags.html @@ -1,2 +1,2 @@ -ZigZags | chart-patterns

    Namespace ZigZags

    Index

    Functions

    create +ZigZags | chart-patterns

    Namespace ZigZags

    Index

    Functions

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/lib.html b/docs/modules/lib.html index 688e3e79..a8b553f6 100644 --- a/docs/modules/lib.html +++ b/docs/modules/lib.html @@ -1,4 +1,4 @@ -lib | chart-patterns

    Index

    Namespaces

    CandlestickPatterns +lib | chart-patterns

    Index

    Namespaces

    CandlestickPatterns Harmonics MovingAverage Orderflow diff --git a/docs/modules/types.html b/docs/modules/types.html index bb4449dc..01ea91ed 100644 --- a/docs/modules/types.html +++ b/docs/modules/types.html @@ -1,4 +1,4 @@ -types | chart-patterns

    Index

    Enumerations

    MA_Periods +types | chart-patterns

    Index

    Enumerations

    Interfaces

    EmaCrossingResult ICandle IEmaOutcome diff --git a/docs/types/types.EmaCrossingMultiResult.html b/docs/types/types.EmaCrossingMultiResult.html index d7a04850..1b4341cf 100644 --- a/docs/types/types.EmaCrossingMultiResult.html +++ b/docs/types/types.EmaCrossingMultiResult.html @@ -1 +1 @@ -EmaCrossingMultiResult | chart-patterns

    Type alias EmaCrossingMultiResult

    EmaCrossingMultiResult: {
        [key: string]: EmaCrossingResult;
    }

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +EmaCrossingMultiResult | chart-patterns

    Type alias EmaCrossingMultiResult

    EmaCrossingMultiResult: {
        [key: string]: EmaCrossingResult;
    }

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/types/types.zigzagType.html b/docs/types/types.zigzagType.html index 25a830cb..c7b307ff 100644 --- a/docs/types/types.zigzagType.html +++ b/docs/types/types.zigzagType.html @@ -1 +1 @@ -zigzagType | chart-patterns

    Type alias zigzagType

    zigzagType: "PEAK" | "TROUGH"

    Generated using TypeDoc

    \ No newline at end of file +zigzagType | chart-patterns

    Type alias zigzagType

    zigzagType: "PEAK" | "TROUGH"

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/constants.BAT_RATIOS.html b/docs/variables/constants.BAT_RATIOS.html index 7e3ebbd5..22f5d6dc 100644 --- a/docs/variables/constants.BAT_RATIOS.html +++ b/docs/variables/constants.BAT_RATIOS.html @@ -1 +1 @@ -BAT_RATIOS | chart-patterns

    Variable BAT_RATIOSConst

    BAT_RATIOS: IXABCDRatio = ...

    Generated using TypeDoc

    \ No newline at end of file +BAT_RATIOS | chart-patterns

    Variable BAT_RATIOSConst

    BAT_RATIOS: IXABCDRatio = ...

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/constants.BUTTERFLY_RATIOS.html b/docs/variables/constants.BUTTERFLY_RATIOS.html index db4296a3..07b5ea7e 100644 --- a/docs/variables/constants.BUTTERFLY_RATIOS.html +++ b/docs/variables/constants.BUTTERFLY_RATIOS.html @@ -1 +1 @@ -BUTTERFLY_RATIOS | chart-patterns

    Variable BUTTERFLY_RATIOSConst

    BUTTERFLY_RATIOS: IXABCDRatio = ...

    Generated using TypeDoc

    \ No newline at end of file +BUTTERFLY_RATIOS | chart-patterns

    Variable BUTTERFLY_RATIOSConst

    BUTTERFLY_RATIOS: IXABCDRatio = ...

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/constants.CRAB_RATIOS.html b/docs/variables/constants.CRAB_RATIOS.html index 091d07ea..5d8f95c1 100644 --- a/docs/variables/constants.CRAB_RATIOS.html +++ b/docs/variables/constants.CRAB_RATIOS.html @@ -1 +1 @@ -CRAB_RATIOS | chart-patterns

    Variable CRAB_RATIOSConst

    CRAB_RATIOS: IXABCDRatio = ...

    Generated using TypeDoc

    \ No newline at end of file +CRAB_RATIOS | chart-patterns

    Variable CRAB_RATIOSConst

    CRAB_RATIOS: IXABCDRatio = ...

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/constants.CYPHER_RATIOS.html b/docs/variables/constants.CYPHER_RATIOS.html index 5eb64470..49515685 100644 --- a/docs/variables/constants.CYPHER_RATIOS.html +++ b/docs/variables/constants.CYPHER_RATIOS.html @@ -1 +1 @@ -CYPHER_RATIOS | chart-patterns

    Variable CYPHER_RATIOSConst

    CYPHER_RATIOS: IXABCDRatio = ...

    Generated using TypeDoc

    \ No newline at end of file +CYPHER_RATIOS | chart-patterns

    Variable CYPHER_RATIOSConst

    CYPHER_RATIOS: IXABCDRatio = ...

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/constants.DEEP_CRAB_RATIOS.html b/docs/variables/constants.DEEP_CRAB_RATIOS.html index deb2a426..66b27528 100644 --- a/docs/variables/constants.DEEP_CRAB_RATIOS.html +++ b/docs/variables/constants.DEEP_CRAB_RATIOS.html @@ -1 +1 @@ -DEEP_CRAB_RATIOS | chart-patterns

    Variable DEEP_CRAB_RATIOSConst

    DEEP_CRAB_RATIOS: IXABCDRatio = ...

    Generated using TypeDoc

    \ No newline at end of file +DEEP_CRAB_RATIOS | chart-patterns

    Variable DEEP_CRAB_RATIOSConst

    DEEP_CRAB_RATIOS: IXABCDRatio = ...

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/constants.EXCESS_TAIL_LENGTH_SIGNIFICANCE.html b/docs/variables/constants.EXCESS_TAIL_LENGTH_SIGNIFICANCE.html index f66e65cb..f3a5f8f0 100644 --- a/docs/variables/constants.EXCESS_TAIL_LENGTH_SIGNIFICANCE.html +++ b/docs/variables/constants.EXCESS_TAIL_LENGTH_SIGNIFICANCE.html @@ -1 +1 @@ -EXCESS_TAIL_LENGTH_SIGNIFICANCE | chart-patterns

    Variable EXCESS_TAIL_LENGTH_SIGNIFICANCEConst

    EXCESS_TAIL_LENGTH_SIGNIFICANCE: 15 = 15

    Generated using TypeDoc

    \ No newline at end of file +EXCESS_TAIL_LENGTH_SIGNIFICANCE | chart-patterns

    Variable EXCESS_TAIL_LENGTH_SIGNIFICANCEConst

    EXCESS_TAIL_LENGTH_SIGNIFICANCE: 15 = 15

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/constants.GARTLEY_RATIOS.html b/docs/variables/constants.GARTLEY_RATIOS.html index ffe0ee5d..322fe1c2 100644 --- a/docs/variables/constants.GARTLEY_RATIOS.html +++ b/docs/variables/constants.GARTLEY_RATIOS.html @@ -1 +1 @@ -GARTLEY_RATIOS | chart-patterns

    Variable GARTLEY_RATIOSConst

    GARTLEY_RATIOS: IXABCDRatio = ...

    Generated using TypeDoc

    \ No newline at end of file +GARTLEY_RATIOS | chart-patterns

    Variable GARTLEY_RATIOSConst

    GARTLEY_RATIOS: IXABCDRatio = ...

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/constants.POOR_HIGH_LOW_KLINE_LENGTH_SIGNIFICANCE.html b/docs/variables/constants.POOR_HIGH_LOW_KLINE_LENGTH_SIGNIFICANCE.html index faca1a63..e03b87be 100644 --- a/docs/variables/constants.POOR_HIGH_LOW_KLINE_LENGTH_SIGNIFICANCE.html +++ b/docs/variables/constants.POOR_HIGH_LOW_KLINE_LENGTH_SIGNIFICANCE.html @@ -1 +1 @@ -POOR_HIGH_LOW_KLINE_LENGTH_SIGNIFICANCE | chart-patterns

    Variable POOR_HIGH_LOW_KLINE_LENGTH_SIGNIFICANCEConst

    POOR_HIGH_LOW_KLINE_LENGTH_SIGNIFICANCE: 15 = 15

    Generated using TypeDoc

    \ No newline at end of file +POOR_HIGH_LOW_KLINE_LENGTH_SIGNIFICANCE | chart-patterns

    Variable POOR_HIGH_LOW_KLINE_LENGTH_SIGNIFICANCEConst

    POOR_HIGH_LOW_KLINE_LENGTH_SIGNIFICANCE: 15 = 15

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/constants.SHARK_RATIOS.html b/docs/variables/constants.SHARK_RATIOS.html index 7d11210d..f51f0947 100644 --- a/docs/variables/constants.SHARK_RATIOS.html +++ b/docs/variables/constants.SHARK_RATIOS.html @@ -1 +1 @@ -SHARK_RATIOS | chart-patterns

    Variable SHARK_RATIOSConst

    SHARK_RATIOS: IXABCDRatio = ...

    Generated using TypeDoc

    \ No newline at end of file +SHARK_RATIOS | chart-patterns

    Variable SHARK_RATIOSConst

    SHARK_RATIOS: IXABCDRatio = ...

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/constants.SINGLE_PRINTS_KLINE_LENGTH_SIGNIFICANCE.html b/docs/variables/constants.SINGLE_PRINTS_KLINE_LENGTH_SIGNIFICANCE.html index 5946a757..a157bdc8 100644 --- a/docs/variables/constants.SINGLE_PRINTS_KLINE_LENGTH_SIGNIFICANCE.html +++ b/docs/variables/constants.SINGLE_PRINTS_KLINE_LENGTH_SIGNIFICANCE.html @@ -1 +1 @@ -SINGLE_PRINTS_KLINE_LENGTH_SIGNIFICANCE | chart-patterns

    Variable SINGLE_PRINTS_KLINE_LENGTH_SIGNIFICANCEConst

    SINGLE_PRINTS_KLINE_LENGTH_SIGNIFICANCE: 5 = 5

    Generated using TypeDoc

    \ No newline at end of file +SINGLE_PRINTS_KLINE_LENGTH_SIGNIFICANCE | chart-patterns

    Variable SINGLE_PRINTS_KLINE_LENGTH_SIGNIFICANCEConst

    SINGLE_PRINTS_KLINE_LENGTH_SIGNIFICANCE: 5 = 5

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/constants.TPO_LETTERS.html b/docs/variables/constants.TPO_LETTERS.html index 442e6b96..b0713d92 100644 --- a/docs/variables/constants.TPO_LETTERS.html +++ b/docs/variables/constants.TPO_LETTERS.html @@ -1 +1 @@ -TPO_LETTERS | chart-patterns

    Variable TPO_LETTERSConst

    TPO_LETTERS: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz123456789" = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz123456789'

    Generated using TypeDoc

    \ No newline at end of file +TPO_LETTERS | chart-patterns

    Variable TPO_LETTERSConst

    TPO_LETTERS: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz123456789" = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz123456789'

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/constants.harmonicRatios.html b/docs/variables/constants.harmonicRatios.html index caf8962a..04251d12 100644 --- a/docs/variables/constants.harmonicRatios.html +++ b/docs/variables/constants.harmonicRatios.html @@ -1 +1 @@ -harmonicRatios | chart-patterns

    Variable harmonicRatiosConst

    harmonicRatios: Readonly<{
        bat: IXABCDRatio;
        butterfly: IXABCDRatio;
        crab: IXABCDRatio;
        cypher: IXABCDRatio;
        deep_crab: IXABCDRatio;
        gartley: IXABCDRatio;
        shark: IXABCDRatio;
    }> = ...

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file +harmonicRatios | chart-patterns

    Variable harmonicRatiosConst

    harmonicRatios: Readonly<{
        bat: IXABCDRatio;
        butterfly: IXABCDRatio;
        crab: IXABCDRatio;
        cypher: IXABCDRatio;
        deep_crab: IXABCDRatio;
        gartley: IXABCDRatio;
        shark: IXABCDRatio;
    }> = ...

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/package.json b/package.json index 0a2d70f3..5bb0b557 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "chart-patterns", - "version": "0.0.78", + "version": "0.0.79", "description": "Trading Chart Patterns", "repository": "git@github-focus1691:focus1691/chart-patterns.git", "author": "focus1691",