From 9b92cd9ea0f4139143b33853eb57f788c33ca985 Mon Sep 17 00:00:00 2001 From: focus1691 Date: Thu, 21 Nov 2024 18:54:46 +0000 Subject: [PATCH] Update documentation --- docs/classes/lib.ZScores.ZScore.html | 4 +-- docs/classes/lib.ZScores.ZScoreOutput.html | 4 +-- docs/enums/constants.FIBONACCI_NUMBERS.html | 4 +-- docs/enums/constants.HARMONIC_PATTERNS.html | 4 +-- docs/enums/constants.INTERVALS.html | 4 +-- docs/enums/constants.ImbalanceType.html | 4 +-- docs/enums/constants.MARKET_PROFILE_DAYS.html | 4 +-- docs/enums/constants.MARKET_PROFILE_OPEN.html | 4 +-- .../constants.MARKET_PROFILE_PERIODS.html | 4 +-- docs/enums/constants.SIGNAL_DIRECTION.html | 4 +-- docs/enums/types.MA_Periods.html | 4 +-- ...ndlestickPatterns.findEngulfingCandle.html | 2 +- .../lib.CandlestickPatterns.isExcess.html | 2 +- .../functions/lib.Harmonics.findPatterns.html | 2 +- .../lib.Harmonics.findXABCDCombinations.html | 2 +- docs/functions/lib.MarketProfile.build.html | 2 +- .../lib.MovingAverage.calculateEMA.html | 2 +- .../lib.MovingAverage.calculateEmas.html | 2 +- .../lib.MovingAverage.calculateSMA.html | 2 +- .../lib.MovingAverage.detectCrossing.html | 2 +- ...b.Orderflow.adjustOrderFlowResolution.html | 2 +- .../lib.Orderflow.detectImbalances.html | 2 +- ...lib.Orderflow.detectStackedImbalances.html | 2 +- .../lib.Orderflow.findHighVolumeNodes.html | 4 +-- .../lib.PeakDetector.findSignals.html | 4 +-- .../lib.PeakDetector.getPeakRanges.html | 2 +- .../lib.PivotPoints.calculatePivotPoints.html | 2 +- docs/functions/lib.RSI.calculateRSI.html | 2 +- .../lib.RangeBuilder.findRanges.html | 2 +- docs/functions/lib.VWAP.calculateVWAP.html | 2 +- docs/functions/lib.ValueArea.calculate.html | 2 +- docs/functions/lib.VolumeProfile.build.html | 2 +- ...VolumeProfile.findNakedPointOfControl.html | 2 +- docs/functions/lib.ZigZags.create.html | 2 +- .../constants.IFibonacciRetracement.html | 4 +-- docs/interfaces/types.EmaCrossingResult.html | 4 +-- docs/interfaces/types.ICandle.html | 4 +-- docs/interfaces/types.IEmaOutcome.html | 2 +- .../types.IEngulfingCandleConfig.html | 6 ++-- .../types.IFindHighVolumeNodeConfig.html | 4 +-- docs/interfaces/types.IFootPrintCandle.html | 4 +-- docs/interfaces/types.IHarmonic.html | 28 +++++++++---------- docs/interfaces/types.IHighVolumeNode.html | 4 +-- docs/interfaces/types.IInitialBalance.html | 6 ++-- docs/interfaces/types.ILocalRange.html | 4 +-- docs/interfaces/types.IMarketProfile.html | 4 +-- .../types.IMarketProfileBuilderConfig.html | 14 +++++----- .../types.IMarketProfileStructure.html | 4 +-- .../types.INakedPointOfControl.html | 4 +-- docs/interfaces/types.IPeak.html | 4 +-- docs/interfaces/types.IPeakRange.html | 4 +-- docs/interfaces/types.IPivotPoints.html | 4 +-- docs/interfaces/types.ISignalsConfig.html | 12 ++++---- .../types.IStackedImbalanceConfig.html | 8 +++--- .../types.IStackedImbalancesResult.html | 4 +-- docs/interfaces/types.ITimeFrame.html | 4 +-- docs/interfaces/types.IValueArea.html | 4 +-- docs/interfaces/types.IVolumeProfile.html | 4 +-- .../types.IVolumeProfileConfig.html | 14 +++++----- .../types.IVolumeProfileObservation.html | 8 +++--- .../types.IVolumeProfileResult.html | 6 ++-- docs/interfaces/types.IVolumeRow.html | 4 +-- docs/interfaces/types.IXABCDPattern.html | 22 +++++++-------- docs/interfaces/types.IXABCDRatio.html | 10 +++---- docs/interfaces/types.IZigZag.html | 4 +-- docs/interfaces/types.Imbalance.html | 4 +-- docs/interfaces/types.OrderFlowRow.html | 4 +-- docs/modules/constants.html | 2 +- docs/modules/lib.CandlestickPatterns.html | 2 +- docs/modules/lib.Harmonics.html | 2 +- docs/modules/lib.MarketProfile.html | 2 +- docs/modules/lib.MovingAverage.html | 2 +- docs/modules/lib.Orderflow.html | 2 +- docs/modules/lib.PeakDetector.html | 2 +- docs/modules/lib.PivotPoints.html | 2 +- docs/modules/lib.RSI.html | 2 +- docs/modules/lib.RangeBuilder.html | 2 +- docs/modules/lib.VWAP.html | 2 +- docs/modules/lib.ValueArea.html | 2 +- docs/modules/lib.VolumeProfile.html | 2 +- docs/modules/lib.ZScores.html | 2 +- docs/modules/lib.ZigZags.html | 2 +- docs/modules/lib.html | 2 +- docs/modules/types.html | 2 +- docs/types/types.EmaCrossingMultiResult.html | 2 +- docs/types/types.zigzagType.html | 2 +- docs/variables/constants.BAT_RATIOS.html | 2 +- .../variables/constants.BUTTERFLY_RATIOS.html | 2 +- docs/variables/constants.CRAB_RATIOS.html | 2 +- docs/variables/constants.CYPHER_RATIOS.html | 2 +- .../variables/constants.DEEP_CRAB_RATIOS.html | 2 +- ...tants.EXCESS_TAIL_LENGTH_SIGNIFICANCE.html | 2 +- docs/variables/constants.GARTLEY_RATIOS.html | 2 +- ...OR_HIGH_LOW_KLINE_LENGTH_SIGNIFICANCE.html | 2 +- docs/variables/constants.SHARK_RATIOS.html | 2 +- ...NGLE_PRINTS_KLINE_LENGTH_SIGNIFICANCE.html | 2 +- docs/variables/constants.TPO_LETTERS.html | 2 +- docs/variables/constants.harmonicRatios.html | 2 +- 98 files changed, 188 insertions(+), 188 deletions(-) diff --git a/docs/classes/lib.ZScores.ZScore.html b/docs/classes/lib.ZScores.ZScore.html index bf7eedc..b14dd9b 100644 --- a/docs/classes/lib.ZScores.ZScore.html +++ b/docs/classes/lib.ZScores.ZScore.html @@ -1,7 +1,7 @@ -ZScore | chart-patterns

Class ZScore

Constructors

constructor +ZScore | chart-patterns

Class ZScore

Constructors

constructor

Methods

avg calc normaliseData stdDev sum -

Constructors

constructor

Methods

Static Private avg

Static calc

Static Private normaliseData

Static Private stdDev

Static Private sum

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Methods

Static Private avg

Static calc

Static Private normaliseData

Static Private stdDev

Static Private sum

Settings

Member Visibility

Theme

On This Page

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 459ccda..56dd80e 100644 --- a/docs/classes/lib.ZScores.ZScoreOutput.html +++ b/docs/classes/lib.ZScores.ZScoreOutput.html @@ -1,7 +1,7 @@ -ZScoreOutput | chart-patterns

Class ZScoreOutput

Constructors

constructor +ZScoreOutput | chart-patterns

Class ZScoreOutput

Constructors

constructor

Properties

avgFilter filtered_stddev input peakCount signals -

Constructors

constructor

Properties

avgFilter

avgFilter: number[]

filtered_stddev

filtered_stddev: number[]

input

input: number[]

peakCount

peakCount: number = 0

signals

signals: number[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Constructors

constructor

Properties

avgFilter

avgFilter: number[]

filtered_stddev

filtered_stddev: number[]

input

input: number[]

peakCount

peakCount: number = 0

signals

signals: number[]

Settings

Member Visibility

Theme

On This Page

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 202635f..6325432 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 ONE ONE_SIX_EIGHT SEVEN_EIGHT_SIX @@ -7,4 +7,4 @@ THREE_EIGHT_TWO TWO_THREE_SIX ZERO -

Enumeration Members

FIVE

FIVE: 0.5

ONE

ONE: 1

ONE_SIX_EIGHT

ONE_SIX_EIGHT: 1.618

SEVEN_EIGHT_SIX

SEVEN_EIGHT_SIX: 0.786

SIX_ONE_EIGHT

SIX_ONE_EIGHT: 0.618

SIX_SIX

SIX_SIX: 0.66

THREE_EIGHT_TWO

THREE_EIGHT_TWO: 0.382

TWO_THREE_SIX

TWO_THREE_SIX: 0.236

ZERO

ZERO: 0

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

FIVE

FIVE: 0.5

ONE

ONE: 1

ONE_SIX_EIGHT

ONE_SIX_EIGHT: 1.618

SEVEN_EIGHT_SIX

SEVEN_EIGHT_SIX: 0.786

SIX_ONE_EIGHT

SIX_ONE_EIGHT: 0.618

SIX_SIX

SIX_SIX: 0.66

THREE_EIGHT_TWO

THREE_EIGHT_TWO: 0.382

TWO_THREE_SIX

TWO_THREE_SIX: 0.236

ZERO

ZERO: 0

Settings

Member Visibility

Theme

On This Page

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 63e4fe6..6353bd6 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 BUTTERFLY CRAB CYPHER DEEP_CRAB GARTLEY SHARK -

Enumeration Members

BAT

BAT: "bat"

BUTTERFLY

BUTTERFLY: "butterfly"

CRAB

CRAB: "crab"

CYPHER

CYPHER: "cypher"

DEEP_CRAB

DEEP_CRAB: "deep_crab"

GARTLEY

GARTLEY: "gartley"

SHARK

SHARK: "shark"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

BAT

BAT: "bat"

BUTTERFLY

BUTTERFLY: "butterfly"

CRAB

CRAB: "crab"

CYPHER

CYPHER: "cypher"

DEEP_CRAB

DEEP_CRAB: "deep_crab"

GARTLEY

GARTLEY: "gartley"

SHARK

SHARK: "shark"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

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

Enumeration INTERVALS

Enumeration Members

EIGHT_HOURS +INTERVALS | chart-patterns

Enumeration INTERVALS

Enumeration Members

EIGHT_HOURS FIFTEEN_MINUTES FIVE_MINUTES FOUR_HOURS @@ -18,4 +18,4 @@ TWELVE_HOURS TWO_HOURS TWO_YEARS -

Enumeration Members

EIGHT_HOURS

EIGHT_HOURS: "8h"

FIFTEEN_MINUTES

FIFTEEN_MINUTES: "15m"

FIVE_MINUTES

FIVE_MINUTES: "5m"

FOUR_HOURS

FOUR_HOURS: "4h"

ONE_DAY

ONE_DAY: "1d"

ONE_HOUR

ONE_HOUR: "1h"

ONE_MINUTE

ONE_MINUTE: "1m"

ONE_MONTH

ONE_MONTH: "1M"

ONE_WEEK

ONE_WEEK: "1w"

ONE_YEAR

ONE_YEAR: "1y"

SIX_HOURS

SIX_HOURS: "6h"

SIX_MONTHS

SIX_MONTHS: "6M"

THIRTY_MINUTES

THIRTY_MINUTES: "30m"

THREE_DAYS

THREE_DAYS: "3d"

THREE_HOURS

THREE_HOURS: "3h"

THREE_MINUTES

THREE_MINUTES: "3m"

THREE_MONTHS

THREE_MONTHS: "3M"

TWELVE_HOURS

TWELVE_HOURS: "12h"

TWO_HOURS

TWO_HOURS: "2h"

TWO_YEARS

TWO_YEARS: "2y"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

EIGHT_HOURS

EIGHT_HOURS: "8h"

FIFTEEN_MINUTES

FIFTEEN_MINUTES: "15m"

FIVE_MINUTES

FIVE_MINUTES: "5m"

FOUR_HOURS

FOUR_HOURS: "4h"

ONE_DAY

ONE_DAY: "1d"

ONE_HOUR

ONE_HOUR: "1h"

ONE_MINUTE

ONE_MINUTE: "1m"

ONE_MONTH

ONE_MONTH: "1M"

ONE_WEEK

ONE_WEEK: "1w"

ONE_YEAR

ONE_YEAR: "1y"

SIX_HOURS

SIX_HOURS: "6h"

SIX_MONTHS

SIX_MONTHS: "6M"

THIRTY_MINUTES

THIRTY_MINUTES: "30m"

THREE_DAYS

THREE_DAYS: "3d"

THREE_HOURS

THREE_HOURS: "3h"

THREE_MINUTES

THREE_MINUTES: "3m"

THREE_MONTHS

THREE_MONTHS: "3M"

TWELVE_HOURS

TWELVE_HOURS: "12h"

TWO_HOURS

TWO_HOURS: "2h"

TWO_YEARS

TWO_YEARS: "2y"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/constants.ImbalanceType.html b/docs/enums/constants.ImbalanceType.html index f98f683..9351000 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

BUYING_IMBALANCE SELLING_IMBALANCE -

Enumeration Members

BUYING_IMBALANCE

BUYING_IMBALANCE: 1

SELLING_IMBALANCE

SELLING_IMBALANCE: 0

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

BUYING_IMBALANCE

BUYING_IMBALANCE: 1

SELLING_IMBALANCE

SELLING_IMBALANCE: 0

Settings

Member Visibility

Theme

On This Page

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 8f6b5ea..b5b081c 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 DOUBLE_DISTRIBUTION NEUTRAL NORMAL P_SHAPE TREND -

Enumeration Members

B_SHAPE

B_SHAPE: "b_shape"

DOUBLE_DISTRIBUTION

DOUBLE_DISTRIBUTION: "double_distribution"

NEUTRAL

NEUTRAL: "neutral"

NORMAL

NORMAL: "normal"

P_SHAPE

P_SHAPE: "p_shape"

TREND

TREND: "trend"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

B_SHAPE

B_SHAPE: "b_shape"

DOUBLE_DISTRIBUTION

DOUBLE_DISTRIBUTION: "double_distribution"

NEUTRAL

NEUTRAL: "neutral"

NORMAL

NORMAL: "normal"

P_SHAPE

P_SHAPE: "p_shape"

TREND

TREND: "trend"

Settings

Member Visibility

Theme

On This Page

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 9f67ab8..127080d 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_DRIVE OPEN_REJECTION_REVERSE OPEN_TEST_DRIVE -

Enumeration Members

OPEN_AUCTION

OPEN_AUCTION: "Open Auction"

OPEN_DRIVE

OPEN_DRIVE: "Open Drive"

OPEN_REJECTION_REVERSE

OPEN_REJECTION_REVERSE: "Open Rejection Reverse"

OPEN_TEST_DRIVE

OPEN_TEST_DRIVE: "Open Test Drive"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

OPEN_AUCTION

OPEN_AUCTION: "Open Auction"

OPEN_DRIVE

OPEN_DRIVE: "Open Drive"

OPEN_REJECTION_REVERSE

OPEN_REJECTION_REVERSE: "Open Rejection Reverse"

OPEN_TEST_DRIVE

OPEN_TEST_DRIVE: "Open Test Drive"

Settings

Member Visibility

Theme

On This Page

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 fed55c5..2985a98 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

DAILY MONTHLY WEEKLY -

Enumeration Members

DAILY

DAILY: "daily"

MONTHLY

MONTHLY: "monthly"

WEEKLY

WEEKLY: "weekly"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

DAILY

DAILY: "daily"

MONTHLY

MONTHLY: "monthly"

WEEKLY

WEEKLY: "weekly"

Settings

Member Visibility

Theme

On This Page

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 5e6ddcc..8baaa25 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

BEARISH BOTH BULLISH -

Enumeration Members

BEARISH

BEARISH: "bearish"

BOTH

BOTH: "both"

BULLISH

BULLISH: "bullish"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

BEARISH

BEARISH: "bearish"

BOTH

BOTH: "both"

BULLISH

BULLISH: "bullish"

Settings

Member Visibility

Theme

On This Page

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 bbcc92f..3cc7ad3 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

FIFTY FIVE NINE ONE_HUNDRED @@ -7,4 +7,4 @@ THREE TWENTY_ONE TWO_HUNDRED -

Enumeration Members

FIFTY

FIFTY: 50

FIVE

FIVE: 5

NINE

NINE: 9

ONE_HUNDRED

ONE_HUNDRED: 100

SEVEN

SEVEN: 7

THIRTY

THIRTY: 30

THREE

THREE: 3

TWENTY_ONE

TWENTY_ONE: 21

TWO_HUNDRED

TWO_HUNDRED: 200

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

FIFTY

FIFTY: 50

FIVE

FIVE: 5

NINE

NINE: 9

ONE_HUNDRED

ONE_HUNDRED: 100

SEVEN

SEVEN: 7

THIRTY

THIRTY: 30

THREE

THREE: 3

TWENTY_ONE

TWENTY_ONE: 21

TWO_HUNDRED

TWO_HUNDRED: 200

Settings

Member Visibility

Theme

On This Page

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 36261c5..c44ce68 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 });
-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

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 6bd158e..9b328ce 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);
-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

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 659d978..997ca10 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
-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

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 c2eec08..ecd5ff5 100644 --- a/docs/functions/lib.Harmonics.findXABCDCombinations.html +++ b/docs/functions/lib.Harmonics.findXABCDCombinations.html @@ -1,4 +1,4 @@ findXABCDCombinations | chart-patterns

Function findXABCDCombinations

  • findXABCDCombinations(zigzags): number[][]

  • 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.

    -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.MarketProfile.build.html b/docs/functions/lib.MarketProfile.build.html index fd84602..3644eed 100644 --- a/docs/functions/lib.MarketProfile.build.html +++ b/docs/functions/lib.MarketProfile.build.html @@ -8,4 +8,4 @@

Example

// Assuming 'candles' is an array of ICandle objects representing the price data
// Create a volume profile with a specified tick size
const marketProfile: IMarketProfile = MarketProfile.build({ candles, tickSize: 0.1, tickMultiplier: 100, pricePrecision: 2, period: MARKET_PROFILE_PERIODS.DAILY, timezone: 'Europe/London' });
-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

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 0335b9a..97b611b 100644 --- a/docs/functions/lib.MovingAverage.calculateEMA.html +++ b/docs/functions/lib.MovingAverage.calculateEMA.html @@ -1 +1 @@ -calculateEMA | chart-patterns

Function calculateEMA

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function calculateEMA

Settings

Member Visibility

Theme

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 7e291df..f613bb8 100644 --- a/docs/functions/lib.MovingAverage.calculateEmas.html +++ b/docs/functions/lib.MovingAverage.calculateEmas.html @@ -1 +1 @@ -calculateEmas | chart-patterns

Function calculateEmas

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function calculateEmas

Settings

Member Visibility

Theme

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 d370842..1f2be25 100644 --- a/docs/functions/lib.MovingAverage.calculateSMA.html +++ b/docs/functions/lib.MovingAverage.calculateSMA.html @@ -1 +1 @@ -calculateSMA | chart-patterns

Function calculateSMA

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function calculateSMA

Settings

Member Visibility

Theme

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 86d4f86..89bc567 100644 --- a/docs/functions/lib.MovingAverage.detectCrossing.html +++ b/docs/functions/lib.MovingAverage.detectCrossing.html @@ -1 +1 @@ -detectCrossing | chart-patterns

Function detectCrossing

Settings

Member Visibility

Theme

Generated using TypeDoc

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

Function detectCrossing

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.Orderflow.adjustOrderFlowResolution.html b/docs/functions/lib.Orderflow.adjustOrderFlowResolution.html index 2b03014..b4c72d6 100644 --- a/docs/functions/lib.Orderflow.adjustOrderFlowResolution.html +++ b/docs/functions/lib.Orderflow.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.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.Orderflow.detectImbalances.html b/docs/functions/lib.Orderflow.detectImbalances.html index 21d01e6..bbc9ae1 100644 --- a/docs/functions/lib.Orderflow.detectImbalances.html +++ b/docs/functions/lib.Orderflow.detectImbalances.html @@ -2,4 +2,4 @@

Parameters

Returns Imbalance[]

An array of Imbalance objects.

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.Orderflow.detectStackedImbalances.html b/docs/functions/lib.Orderflow.detectStackedImbalances.html index d85eea0..24b1317 100644 --- a/docs/functions/lib.Orderflow.detectStackedImbalances.html +++ b/docs/functions/lib.Orderflow.detectStackedImbalances.html @@ -2,4 +2,4 @@

Parameters

Returns IStackedImbalancesResult[]

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

-

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/functions/lib.Orderflow.findHighVolumeNodes.html b/docs/functions/lib.Orderflow.findHighVolumeNodes.html index 2a054fa..2164d7f 100644 --- a/docs/functions/lib.Orderflow.findHighVolumeNodes.html +++ b/docs/functions/lib.Orderflow.findHighVolumeNodes.html @@ -5,6 +5,6 @@
  • config: IFindHighVolumeNodeConfig

    Configuration object containing the threshold.

    • Returns IHighVolumeNode[]

    An array of high volume nodes, each containing price, total volume, 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 }]
+
    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 }]
 
    
-

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 87a21d7..036c5e7 100644 --- a/docs/functions/lib.PeakDetector.findSignals.html +++ b/docs/functions/lib.PeakDetector.findSignals.html @@ -1,5 +1,5 @@ findSignals | chart-patterns

    Function findSignals

    • findSignals(config): IPeak[][] | IPeak[]

    • Finds and groups signals representing peaks based on the provided configuration.

      Parameters

      Returns IPeak[][] | IPeak[]

      Peak are grouped by direction: (-1, -1, 1, 1, -1, -1) or +

    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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 0e42c82..d0a3c36 100644 --- a/docs/functions/lib.PeakDetector.getPeakRanges.html +++ b/docs/functions/lib.PeakDetector.getPeakRanges.html @@ -2,4 +2,4 @@

    Parameters

    • groupedSignals: IPeak[][]

      Groups of peak signals.

    • timestamps: number[]

      Array of timestamps corresponding to each data point.

    Returns IPeakRange[]

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

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 2bcdd70..9bc532f 100644 --- a/docs/functions/lib.PivotPoints.calculatePivotPoints.html +++ b/docs/functions/lib.PivotPoints.calculatePivotPoints.html @@ -6,4 +6,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, 2);

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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 55af0d3..aa6048e 100644 --- a/docs/functions/lib.RSI.calculateRSI.html +++ b/docs/functions/lib.RSI.calculateRSI.html @@ -1 +1 @@ -calculateRSI | chart-patterns

    Function calculateRSI

    • calculateRSI(candles, period?, numElements?): number[]

    • Parameters

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

      Returns number[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function calculateRSI

    • calculateRSI(candles, period?, numElements?): number[]

    • Parameters

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

      Returns number[]

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/functions/lib.RangeBuilder.findRanges.html b/docs/functions/lib.RangeBuilder.findRanges.html index 4d14988..52ee0ff 100644 --- a/docs/functions/lib.RangeBuilder.findRanges.html +++ b/docs/functions/lib.RangeBuilder.findRanges.html @@ -1 +1 @@ -findRanges | chart-patterns

    Function findRanges

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function findRanges

    Settings

    Member Visibility

    Theme

    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 338636b..4915e59 100644 --- a/docs/functions/lib.VWAP.calculateVWAP.html +++ b/docs/functions/lib.VWAP.calculateVWAP.html @@ -1 +1 @@ -calculateVWAP | chart-patterns

    Function calculateVWAP

    • calculateVWAP(candles, pricePrecision): number

    • Parameters

      • candles: ICandle[]
      • pricePrecision: number

      Returns number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Function calculateVWAP

    • calculateVWAP(candles, pricePrecision): number

    • Parameters

      • candles: ICandle[]
      • pricePrecision: number

      Returns number

    Settings

    Member Visibility

    Theme

    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 0af242b..69b1153 100644 --- a/docs/functions/lib.ValueArea.calculate.html +++ b/docs/functions/lib.ValueArea.calculate.html @@ -3,4 +3,4 @@
  • valueAreaRowSize: number = 24

    The number of Value Area rows.

  • valueAreaVolume: number = 0.7

    The Value Area percentage.

    • Returns IValueArea

    Value Area Object.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 9f72c38..f2b37a0 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' });
    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 d814207..721747e 100644 --- a/docs/functions/lib.VolumeProfile.findNakedPointOfControl.html +++ b/docs/functions/lib.VolumeProfile.findNakedPointOfControl.html @@ -1,3 +1,3 @@ findNakedPointOfControl | chart-patterns

    Function findNakedPointOfControl

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    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 4944984..de19fe0 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.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/constants.IFibonacciRetracement.html b/docs/interfaces/constants.IFibonacciRetracement.html index a1ee6ff..fd810a7 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

    0: number

    0.236

    0.236: number

    0.382

    0.382: number

    0.5

    0.5: number

    0.618

    0.618: number

    0.66

    0.66: number

    0.786

    0.786: number

    1

    1: number

    1.618

    1.618: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    0

    0: number

    0.236

    0.236: number

    0.382

    0.382: number

    0.5

    0.5: number

    0.618

    0.618: number

    0.66

    0.66: number

    0.786

    0.786: number

    1

    1: number

    1.618

    1.618: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.EmaCrossingResult.html b/docs/interfaces/types.EmaCrossingResult.html index 03c7464..cb060a9 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 interval longPeriod shortPeriod time -

    Properties

    direction

    direction: SIGNAL_DIRECTION

    interval

    interval: INTERVALS

    longPeriod

    longPeriod: MA_Periods

    shortPeriod

    shortPeriod: MA_Periods

    time

    time: Date

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    direction

    direction: SIGNAL_DIRECTION

    interval

    interval: INTERVALS

    longPeriod

    longPeriod: MA_Periods

    shortPeriod

    shortPeriod: MA_Periods

    time

    time: Date

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface ICandle

    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

    interface ICandle {
        close: number;
        closeTime: Date;
        high: number;
        interval: string;
        low: number;
        open: number;
        openTime: Date;
        symbol: string;
        volume: number;
    }

    Properties

    close closeTime high interval @@ -7,4 +7,4 @@ openTime symbol volume -

    Properties

    close

    close: number

    closeTime

    closeTime: Date

    high

    high: number

    interval

    interval: string

    low

    low: number

    open

    open: number

    openTime

    openTime: Date

    symbol

    symbol: string

    volume

    volume: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    close

    close: number

    closeTime

    closeTime: Date

    high

    high: number

    interval

    interval: string

    low

    low: number

    open

    open: number

    openTime

    openTime: Date

    symbol

    symbol: string

    volume

    volume: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IEmaOutcome.html b/docs/interfaces/types.IEmaOutcome.html index 1ffaa37..58ea4ae 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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Interface IEmaOutcome

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

    Indexable

    [period: string]: number

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IEngulfingCandleConfig.html b/docs/interfaces/types.IEngulfingCandleConfig.html index 6a0337e..1d821c4 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

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

    Properties

    candles index?

    Properties

    candles

    candles: ICandle[]

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

    -

    Optional index

    index?: number

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

    Optional index

    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.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IFindHighVolumeNodeConfig.html b/docs/interfaces/types.IFindHighVolumeNodeConfig.html index 54940ce..edc6c1b 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

    threshold -

    Properties

    threshold

    threshold: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface IFindHighVolumeNodeConfig

    interface IFindHighVolumeNodeConfig {
        threshold: number;
    }

    Properties

    threshold +

    Properties

    threshold

    threshold: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IFootPrintCandle.html b/docs/interfaces/types.IFootPrintCandle.html index 2a5f24c..1bccbd6 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

    close closeTime closeTimeMs high @@ -10,4 +10,4 @@ symbol trades volume -

    Properties

    close

    close: number

    closeTime

    closeTime: Date

    closeTimeMs

    closeTimeMs: number

    high

    high: number

    interval

    interval: string

    low

    low: number

    open

    open: number

    openTime

    openTime: Date

    openTimeMs

    openTimeMs: number

    symbol

    symbol: string

    trades

    trades: Record<string, OrderFlowRow>

    volume

    volume: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    close

    close: number

    closeTime

    closeTime: Date

    closeTimeMs

    closeTimeMs: number

    high

    high: number

    interval

    interval: string

    low

    low: number

    open

    open: number

    openTime

    openTime: Date

    openTimeMs

    openTimeMs: number

    symbol

    symbol: string

    trades

    trades: Record<string, OrderFlowRow>

    volume

    volume: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IHarmonic.html b/docs/interfaces/types.IHarmonic.html index 8307947..6be5c8f 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

    A

    A: IZigZag

    The second point of the XABCD pattern.

    -

    ABC

    ABC: number

    The ratio of the BC segment to the AB segment.

    -

    B

    B: IZigZag

    The third point of the XABCD pattern.

    -

    BCD

    BCD: number

    The ratio of the CD segment to the BC segment.

    -

    C

    C: IZigZag

    The fourth point of the XABCD pattern.

    -

    Optional D

    D?: IZigZag

    The fifth and final point of the XABCD pattern.

    -

    X

    X: IZigZag

    The starting point of the XABCD pattern.

    -

    XAB

    XAB: number

    The ratio of the AB segment to the XA segment.

    -

    XAD

    XAD: number

    The ratio of the XD segment to the XA segment.

    -

    Optional error

    error?: number

    The error rate in the pattern recognition process.

    -

    isDeveloping

    isDeveloping: boolean

    Indicates whether the pattern is currently developing or completed.

    -

    Optional lastTimestamp

    lastTimestamp?: number

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

    -

    type

    type: HARMONIC_PATTERNS

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    ABC

    ABC: number

    The ratio of the BC segment to the AB segment.

    +

    B

    B: IZigZag

    The third point of the XABCD pattern.

    +

    BCD

    BCD: number

    The ratio of the CD segment to the BC segment.

    +

    C

    C: IZigZag

    The fourth point of the XABCD pattern.

    +

    Optional D

    D?: IZigZag

    The fifth and final point of the XABCD pattern.

    +

    X

    X: IZigZag

    The starting point of the XABCD pattern.

    +

    XAB

    XAB: number

    The ratio of the AB segment to the XA segment.

    +

    XAD

    XAD: number

    The ratio of the XD segment to the XA segment.

    +

    Optional error

    error?: number

    The error rate in the pattern recognition process.

    +

    isDeveloping

    isDeveloping: boolean

    Indicates whether the pattern is currently developing or completed.

    +

    Optional lastTimestamp

    lastTimestamp?: number

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

    +

    type

    type: HARMONIC_PATTERNS

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

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IHighVolumeNode.html b/docs/interfaces/types.IHighVolumeNode.html index 94648cd..2fe397d 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 bidVolume price totalVolume -

    Properties

    askVolume

    askVolume: number

    bidVolume

    bidVolume: number

    price

    price: number

    totalVolume

    totalVolume: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    askVolume

    askVolume: number

    bidVolume

    bidVolume: number

    price

    price: number

    totalVolume

    totalVolume: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IInitialBalance.html b/docs/interfaces/types.IInitialBalance.html index b65454b..1bc4f21 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

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

    Properties

    high low

    Properties

    high

    high: number

    The highest price within the initial balance period.

    -

    low

    low: number

    The lowest price within the initial balance period.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    low

    low: number

    The lowest price within the initial balance period.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.ILocalRange.html b/docs/interfaces/types.ILocalRange.html index c2f468e..22ec907 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? end? fibs? resistance? start? support? -

    Properties

    Optional direction

    direction?: SIGNAL_DIRECTION

    Optional end

    end?: string | number

    Optional fibs

    fibs?: {
        highToLow?: IFibonacciRetracement;
        lowToHigh?: IFibonacciRetracement;
    }

    Type declaration

    Optional resistance

    resistance?: number

    Optional start

    start?: string | number

    Optional support

    support?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional direction

    direction?: SIGNAL_DIRECTION

    Optional end

    end?: string | number

    Optional fibs

    fibs?: {
        highToLow?: IFibonacciRetracement;
        lowToHigh?: IFibonacciRetracement;
    }

    Type declaration

    Optional resistance

    resistance?: number

    Optional start

    start?: string | number

    Optional support

    support?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IMarketProfile.html b/docs/interfaces/types.IMarketProfile.html index 2aab2b8..2db278e 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

    IB? endTime excess? failedAuction? @@ -8,4 +8,4 @@ startTime structure valueArea? -

    Properties

    Optional IB

    IB?: IInitialBalance

    endTime

    endTime: string | number | Date

    Optional excess

    excess?: IVolumeProfileObservation[]

    Optional failedAuction

    failedAuction?: IVolumeProfileObservation[]

    Optional ledges

    ledges?: IVolumeProfileObservation[]

    Optional poorHighLow

    poorHighLow?: IVolumeProfileObservation[]

    Optional singlePrints

    singlePrints?: IVolumeProfileObservation[]

    startTime

    startTime: string | number | Date

    structure

    structure: IMarketProfileStructure

    Optional valueArea

    valueArea?: IValueArea

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional IB

    IB?: IInitialBalance

    endTime

    endTime: string | number | Date

    Optional excess

    excess?: IVolumeProfileObservation[]

    Optional failedAuction

    failedAuction?: IVolumeProfileObservation[]

    Optional ledges

    ledges?: IVolumeProfileObservation[]

    Optional poorHighLow

    poorHighLow?: IVolumeProfileObservation[]

    Optional singlePrints

    singlePrints?: IVolumeProfileObservation[]

    startTime

    startTime: string | number | Date

    structure

    structure: IMarketProfileStructure

    Optional valueArea

    valueArea?: IValueArea

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface IMarketProfileBuilderConfig

    Configuration interface for building a Market Profile.

    IMarketProfileBuilderConfig

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

    Properties

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

    Properties

    candles period pricePrecision tickMultiplier tickSize timezone

    Properties

    candles

    candles: ICandle[]

    An array of candle objects.

    -

    period

    period: MARKET_PROFILE_PERIODS

    The time period for which to generate the market profile.

    -

    pricePrecision

    pricePrecision: number

    The number of decimal places to use when rounding prices. +

    period

    period: MARKET_PROFILE_PERIODS

    The time period for which to generate the market profile.

    +

    pricePrecision

    pricePrecision: number

    The number of decimal places to use when rounding prices. This affects the precision of price levels in the resulting market profile.

    -

    tickMultiplier

    tickMultiplier: number

    A multiplier applied to the tick size. This can be used +

    tickMultiplier

    tickMultiplier: number

    A multiplier applied to the tick size. This can be used to adjust the scale of the price levels.

    -

    tickSize

    tickSize: number

    The size of each price tick. This determines the granularity +

    tickSize

    tickSize: number

    The size of each price tick. This determines the granularity of the price levels in the market profile.

    -

    timezone

    timezone: string

    The timezone to use for time-based calculations, e.g., 'Europe/London'. +

    timezone

    timezone: string

    The timezone to use for time-based calculations, e.g., 'Europe/London'. This ensures consistent time handling across different market sessions.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IMarketProfileStructure.html b/docs/interfaces/types.IMarketProfileStructure.html index cf2aa89..e0d2f77 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

    endTime startTime -

    Properties

    endTime

    endTime: string | number | Date

    startTime

    startTime: string | number | Date

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    endTime

    endTime: string | number | Date

    startTime

    startTime: string | number | Date

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.INakedPointOfControl.html b/docs/interfaces/types.INakedPointOfControl.html index 74e6398..83d05f6 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

    resistance? support? -

    Properties

    Optional resistance

    resistance?: number

    Optional support

    support?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional resistance

    resistance?: number

    Optional support

    support?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IPeak.html b/docs/interfaces/types.IPeak.html index 6bc42ed..825d28f 100644 --- a/docs/interfaces/types.IPeak.html +++ b/docs/interfaces/types.IPeak.html @@ -1,3 +1,3 @@ -IPeak | chart-patterns

    Interface IPeak

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

    Hierarchy

    Properties

    direction +IPeak | chart-patterns

    Interface IPeak

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

    Hierarchy

    Properties

    direction position? -

    Properties

    direction

    direction: 1 | -1

    Optional position

    position?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    direction

    direction: 1 | -1

    Optional position

    position?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IPeakRange.html b/docs/interfaces/types.IPeakRange.html index d6c5ce9..08fc6de 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 end? position? start? -

    Properties

    direction

    direction: 1 | -1

    Optional end

    end?: number

    Optional position

    position?: number

    Optional start

    start?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    direction

    direction: 1 | -1

    Optional end

    end?: number

    Optional position

    position?: number

    Optional start

    start?: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IPivotPoints.html b/docs/interfaces/types.IPivotPoints.html index 758a960..96b586f 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 resistance1 resistance2 resistance3 support1 support2 support3 -

    Properties

    pivot

    pivot: number

    resistance1

    resistance1: number

    resistance2

    resistance2: number

    resistance3

    resistance3: number

    support1

    support1: number

    support2

    support2: number

    support3

    support3: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    pivot

    pivot: number

    resistance1

    resistance1: number

    resistance2

    resistance2: number

    resistance3

    resistance3: number

    support1

    support1: number

    support2

    support2: number

    support3

    support3: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.ISignalsConfig.html b/docs/interfaces/types.ISignalsConfig.html index 03968e0..57690e3 100644 --- a/docs/interfaces/types.ISignalsConfig.html +++ b/docs/interfaces/types.ISignalsConfig.html @@ -1,12 +1,12 @@ 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;
        normaliseData?: boolean;
        threshold: number;
        values: number[];
    }

    Properties

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

    Properties

    flatten? influence lag normaliseData? threshold values -

    Properties

    Optional flatten

    flatten?: boolean

    influence

    influence: number

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

    -

    lag

    lag: number

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

    -

    Optional normaliseData

    normaliseData?: boolean

    threshold

    threshold: number

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

    -

    values

    values: number[]

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional flatten

    flatten?: boolean

    influence

    influence: number

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

    +

    lag

    lag: number

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

    +

    Optional normaliseData

    normaliseData?: boolean

    threshold

    threshold: number

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

    +

    values

    values: number[]

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

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IStackedImbalanceConfig.html b/docs/interfaces/types.IStackedImbalanceConfig.html index 7ef4ac3..681b0ce 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? threshold? tickSize?

    Properties

    Optional stackCount

    stackCount?: number

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

    -

    Optional threshold

    threshold?: number

    The threshold percentage to determine an imbalance. +

    Optional threshold

    threshold?: number

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

    -

    Optional tickSize

    tickSize?: number

    The size of the price tick.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional tickSize

    tickSize?: number

    The size of the price tick.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IStackedImbalancesResult.html b/docs/interfaces/types.IStackedImbalancesResult.html index d7d3a0c..4c5cc49 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 endPrice startPrice -

    Properties

    count

    count: number

    endPrice

    endPrice: number

    startPrice

    startPrice: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    count

    count: number

    endPrice

    endPrice: number

    startPrice

    startPrice: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.ITimeFrame.html b/docs/interfaces/types.ITimeFrame.html index 388f6fc..189b127 100644 --- a/docs/interfaces/types.ITimeFrame.html +++ b/docs/interfaces/types.ITimeFrame.html @@ -1,4 +1,4 @@ -ITimeFrame | chart-patterns

    Interface ITimeFrame

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

    Properties

    candles +ITimeFrame | chart-patterns

    Interface ITimeFrame

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

    Properties

    candles endTime startTime -

    Properties

    candles

    candles: ICandle[]

    endTime

    endTime: string | number | Date

    startTime

    startTime: string | number | Date

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    candles

    candles: ICandle[]

    endTime

    endTime: string | number | Date

    startTime

    startTime: string | number | Date

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IValueArea.html b/docs/interfaces/types.IValueArea.html index 02123ed..168ad3f 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

    EQ POC VAH VAL high low -

    Properties

    EQ

    EQ: number

    POC

    POC: number

    VAH

    VAH: number

    VAL

    VAL: number

    high

    high: number

    low

    low: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    EQ

    EQ: number

    POC

    POC: number

    VAH

    VAH: number

    VAL

    VAL: number

    high

    high: number

    low

    low: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IVolumeProfile.html b/docs/interfaces/types.IVolumeProfile.html index ac922ae..2ef03e2 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

    IB? endTime excess? failedAuction? @@ -7,4 +7,4 @@ singlePrints? startTime valueArea? -

    Properties

    Optional IB

    IB?: IInitialBalance

    endTime

    endTime: string | number | Date

    Optional excess

    excess?: IVolumeProfileObservation[]

    Optional failedAuction

    failedAuction?: IVolumeProfileObservation[]

    Optional ledges

    ledges?: IVolumeProfileObservation[]

    Optional poorHighLow

    poorHighLow?: IVolumeProfileObservation[]

    Optional singlePrints

    singlePrints?: IVolumeProfileObservation[]

    startTime

    startTime: string | number | Date

    Optional valueArea

    valueArea?: IValueArea

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    Optional IB

    IB?: IInitialBalance

    endTime

    endTime: string | number | Date

    Optional excess

    excess?: IVolumeProfileObservation[]

    Optional failedAuction

    failedAuction?: IVolumeProfileObservation[]

    Optional ledges

    ledges?: IVolumeProfileObservation[]

    Optional poorHighLow

    poorHighLow?: IVolumeProfileObservation[]

    Optional singlePrints

    singlePrints?: IVolumeProfileObservation[]

    startTime

    startTime: string | number | Date

    Optional valueArea

    valueArea?: IValueArea

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IVolumeProfileConfig.html b/docs/interfaces/types.IVolumeProfileConfig.html index f6040c3..69fb1a0 100644 --- a/docs/interfaces/types.IVolumeProfileConfig.html +++ b/docs/interfaces/types.IVolumeProfileConfig.html @@ -1,15 +1,15 @@ IVolumeProfileConfig | chart-patterns

    Interface IVolumeProfileConfig

    Configuration used for building Volume Profile.

    IVolumeProfileConfig

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

    Properties

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

    Properties

    candles period tickSize timezone valueAreaRowSize? valueAreaVolume?

    Properties

    candles

    candles: ICandle[]

    Candle Array.

    -

    period

    period: MARKET_PROFILE_PERIODS

    Specifies the time period over which the Volume Profile is calculated.

    -

    tickSize

    tickSize: number

    The minimum price increment defining price level resolution, e.g., 0.1 for BTCUSDT.

    -

    timezone

    timezone: string

    The timezone to use for time-based calculations, e.g., 'Europe/London'.

    -

    Optional valueAreaRowSize

    valueAreaRowSize?: number

    The number of Value Area rows.

    -

    Optional valueAreaVolume

    valueAreaVolume?: number

    The Value Area percentage.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    period

    period: MARKET_PROFILE_PERIODS

    Specifies the time period over which the Volume Profile is calculated.

    +

    tickSize

    tickSize: number

    The minimum price increment defining price level resolution, e.g., 0.1 for BTCUSDT.

    +

    timezone

    timezone: string

    The timezone to use for time-based calculations, e.g., 'Europe/London'.

    +

    Optional valueAreaRowSize

    valueAreaRowSize?: number

    The number of Value Area rows.

    +

    Optional valueAreaVolume

    valueAreaVolume?: number

    The Value Area percentage.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IVolumeProfileObservation.html b/docs/interfaces/types.IVolumeProfileObservation.html index f6434a0..34463cb 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

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

    Properties

    peakValue? period? troughValue?

    Properties

    Optional peakValue

    peakValue?: number

    The peak value associated with the observation.

    -

    Optional period

    period?: string

    The specific period or session of the observation.

    -

    Optional troughValue

    troughValue?: number

    The trough or lowest value associated with the observation.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional period

    period?: string

    The specific period or session of the observation.

    +

    Optional troughValue

    troughValue?: number

    The trough or lowest value associated with the observation.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IVolumeProfileResult.html b/docs/interfaces/types.IVolumeProfileResult.html index 0ded182..33fd277 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

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

    Properties

    npoc? volumeProfiles?

    Properties

    Optional npoc

    npoc?: INakedPointOfControl

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

    -

    Optional volumeProfiles

    volumeProfiles?: IVolumeProfile[]

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Optional volumeProfiles

    volumeProfiles?: IVolumeProfile[]

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

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IVolumeRow.html b/docs/interfaces/types.IVolumeRow.html index 4fc2326..aceac7b 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

    high low mid volume -

    Properties

    high

    high: number

    low

    low: number

    mid

    mid: number

    volume

    volume: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    high

    high: number

    low

    low: number

    mid

    mid: number

    volume

    volume: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IXABCDPattern.html b/docs/interfaces/types.IXABCDPattern.html index 83c95f5..2f877f7 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

    A

    A: IZigZag

    The second point of the XABCD pattern.

    -

    ABC

    ABC: number

    The ratio of the BC segment to the AB segment.

    -

    B

    B: IZigZag

    The third point of the XABCD pattern.

    -

    BCD

    BCD: number

    The ratio of the CD segment to the BC segment.

    -

    C

    C: IZigZag

    The fourth point of the XABCD pattern.

    -

    Optional D

    D?: IZigZag

    The fifth and final point of the XABCD pattern.

    -

    X

    X: IZigZag

    The starting point of the XABCD pattern.

    -

    XAB

    XAB: number

    The ratio of the AB segment to the XA segment.

    -

    XAD

    XAD: number

    The ratio of the XD segment to the XA segment.

    -

    Optional error

    error?: number

    The error rate in the pattern recognition process.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    ABC

    ABC: number

    The ratio of the BC segment to the AB segment.

    +

    B

    B: IZigZag

    The third point of the XABCD pattern.

    +

    BCD

    BCD: number

    The ratio of the CD segment to the BC segment.

    +

    C

    C: IZigZag

    The fourth point of the XABCD pattern.

    +

    Optional D

    D?: IZigZag

    The fifth and final point of the XABCD pattern.

    +

    X

    X: IZigZag

    The starting point of the XABCD pattern.

    +

    XAB

    XAB: number

    The ratio of the AB segment to the XA segment.

    +

    XAD

    XAD: number

    The ratio of the XD segment to the XA segment.

    +

    Optional error

    error?: number

    The error rate in the pattern recognition process.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.IXABCDRatio.html b/docs/interfaces/types.IXABCDRatio.html index fdb6c70..ee8b634 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

    ABC BCD XAB XAD

    Properties

    ABC

    ABC: [number, number]

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

    -

    BCD

    BCD: [number, number]

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

    -

    XAB

    XAB: [number, number]

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

    -

    XAD

    XAD: [number, number]

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

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    BCD

    BCD: [number, number]

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

    +

    XAB

    XAB: [number, number]

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

    +

    XAD

    XAD: [number, number]

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

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

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

    Interface IZigZag

    interface IZigZag {
        direction: zigzagType;
        price: number;
        timestamp: number;
    }

    Properties

    direction +IZigZag | chart-patterns

    Interface IZigZag

    interface IZigZag {
        direction: zigzagType;
        price: number;
        timestamp: number;
    }

    Properties

    direction price timestamp -

    Properties

    direction

    direction: zigzagType

    price

    price: number

    timestamp

    timestamp: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    direction

    direction: zigzagType

    price

    price: number

    timestamp

    timestamp: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.Imbalance.html b/docs/interfaces/types.Imbalance.html index bebbfa4..13e5a64 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 price volSumAsk volSumBid -

    Properties

    imbalanceType

    imbalanceType: ImbalanceType

    price

    price: number

    volSumAsk

    volSumAsk: number

    volSumBid

    volSumBid: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    imbalanceType

    imbalanceType: ImbalanceType

    price

    price: number

    volSumAsk

    volSumAsk: number

    volSumBid

    volSumBid: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/interfaces/types.OrderFlowRow.html b/docs/interfaces/types.OrderFlowRow.html index 971f4f3..f168bb1 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

    volSumAsk volSumBid -

    Properties

    volSumAsk

    volSumAsk: number

    volSumBid

    volSumBid: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Properties

    volSumAsk

    volSumAsk: number

    volSumBid

    volSumBid: number

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/constants.html b/docs/modules/constants.html index 9dc1a85..b84e3f0 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 bf94fa1..1c766fa 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

    Namespace CandlestickPatterns

    Index

    Functions

    findEngulfingCandle isExcess

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/lib.Harmonics.html b/docs/modules/lib.Harmonics.html index 7f28389..372a007 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

    Namespace Harmonics

    Index

    Functions

    findPatterns findXABCDCombinations

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Namespace MarketProfile

    Index

    Functions

    build +MarketProfile | chart-patterns

    Namespace MarketProfile

    Index

    Functions

    build

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/lib.MovingAverage.html b/docs/modules/lib.MovingAverage.html index 5a66516..0db9313 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.html b/docs/modules/lib.Orderflow.html index d083a9f..f66f92e 100644 --- a/docs/modules/lib.Orderflow.html +++ b/docs/modules/lib.Orderflow.html @@ -1,4 +1,4 @@ -Orderflow | chart-patterns

    Namespace Orderflow

    Index

    Functions

    adjustOrderFlowResolution +Orderflow | chart-patterns

    Namespace Orderflow

    Index

    Functions

    adjustOrderFlowResolution detectImbalances detectStackedImbalances findHighVolumeNodes diff --git a/docs/modules/lib.PeakDetector.html b/docs/modules/lib.PeakDetector.html index 453f8d6..7af65b7 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

    Namespace PeakDetector

    Index

    Functions

    findSignals getPeakRanges

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/lib.PivotPoints.html b/docs/modules/lib.PivotPoints.html index 52e156f..9ce3d0a 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

    Namespace PivotPoints

    Index

    Functions

    calculatePivotPoints

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Namespace RSI

    Index

    Functions

    calculateRSI +RSI | chart-patterns

    Namespace RSI

    Index

    Functions

    calculateRSI

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Namespace RangeBuilder

    Index

    Functions

    findRanges +RangeBuilder | chart-patterns

    Namespace RangeBuilder

    Index

    Functions

    findRanges

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/lib.VWAP.html b/docs/modules/lib.VWAP.html index c2eeb57..bf987e5 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

    calculateVWAP

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/lib.ValueArea.html b/docs/modules/lib.ValueArea.html index 535583b..af59121 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

    calculate

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/lib.VolumeProfile.html b/docs/modules/lib.VolumeProfile.html index 86ac194..ff47d6b 100644 --- a/docs/modules/lib.VolumeProfile.html +++ b/docs/modules/lib.VolumeProfile.html @@ -1,3 +1,3 @@ -VolumeProfile | chart-patterns

    Namespace VolumeProfile

    Index

    Functions

    build +VolumeProfile | chart-patterns

    Namespace VolumeProfile

    Index

    Functions

    build findNakedPointOfControl

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/lib.ZScores.html b/docs/modules/lib.ZScores.html index ca84097..c1cc5ab 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

    Namespace ZScores

    Index

    Classes

    ZScore ZScoreOutput

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/modules/lib.ZigZags.html b/docs/modules/lib.ZigZags.html index b2937e7..fc19f94 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

    create

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Module lib

    Index

    Namespaces

    CandlestickPatterns +lib | chart-patterns

    Module lib

    Index

    Namespaces

    CandlestickPatterns Harmonics MarketProfile MovingAverage diff --git a/docs/modules/types.html b/docs/modules/types.html index b536786..16558de 100644 --- a/docs/modules/types.html +++ b/docs/modules/types.html @@ -1,4 +1,4 @@ -types | chart-patterns

    Module types

    Index

    Enumerations

    MA_Periods +types | chart-patterns

    Module types

    Index

    Enumerations

    MA_Periods

    Interfaces

    EmaCrossingResult ICandle IEmaOutcome diff --git a/docs/types/types.EmaCrossingMultiResult.html b/docs/types/types.EmaCrossingMultiResult.html index a7b1b73..f14caf4 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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias EmaCrossingMultiResult

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

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias zigzagType

    zigzagType: "PEAK" | "TROUGH"

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Type alias zigzagType

    zigzagType: "PEAK" | "TROUGH"

    Settings

    Member Visibility

    Theme

    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 c428a8a..173ee8d 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 = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Variable BAT_RATIOSConst

    BAT_RATIOS: IXABCDRatio = ...

    Settings

    Member Visibility

    Theme

    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 f8b555a..a796d62 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 = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Variable BUTTERFLY_RATIOSConst

    BUTTERFLY_RATIOS: IXABCDRatio = ...

    Settings

    Member Visibility

    Theme

    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 cc22f5b..42353dd 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 = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Variable CRAB_RATIOSConst

    CRAB_RATIOS: IXABCDRatio = ...

    Settings

    Member Visibility

    Theme

    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 b89b9a2..fc3a2f9 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 = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Variable CYPHER_RATIOSConst

    CYPHER_RATIOS: IXABCDRatio = ...

    Settings

    Member Visibility

    Theme

    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 da3a9e5..9ddd9c8 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 = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Variable DEEP_CRAB_RATIOSConst

    DEEP_CRAB_RATIOS: IXABCDRatio = ...

    Settings

    Member Visibility

    Theme

    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 d8b34f9..656e02b 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

    Settings

    Member Visibility

    Theme

    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

    Settings

    Member Visibility

    Theme

    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 98540be..b45e1fa 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 = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Variable GARTLEY_RATIOSConst

    GARTLEY_RATIOS: IXABCDRatio = ...

    Settings

    Member Visibility

    Theme

    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 9eb1d3c..671beb2 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

    Settings

    Member Visibility

    Theme

    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

    Settings

    Member Visibility

    Theme

    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 a6563ec..c5acd2f 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 = ...

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Variable SHARK_RATIOSConst

    SHARK_RATIOS: IXABCDRatio = ...

    Settings

    Member Visibility

    Theme

    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 3dc22ec..7ce178a 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

    Settings

    Member Visibility

    Theme

    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

    Settings

    Member Visibility

    Theme

    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 b03ce98..60477a2 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'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

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

    Variable TPO_LETTERSConst

    TPO_LETTERS: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz123456789" = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz123456789'

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/variables/constants.harmonicRatios.html b/docs/variables/constants.harmonicRatios.html index 9f5471d..f658702 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

    Settings

    Member Visibility

    Theme

    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

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file