@devexperts/dxcharts-lite
Version:
54 lines (53 loc) • 2.06 kB
TypeScript
/*
* Copyright (C) 2019 - 2025 Devexperts Solutions IE Limited
* This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
* If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
*/
import { Unit } from './scaling/viewport.model';
import { PriceMovement } from './candle-series.model';
export declare const BASIC_CANDLE_WIDTH: Unit;
/**
* @doc-tags model
* @doc-tags-name Candle
*/
export interface Candle {
readonly id: string;
readonly hi: number;
readonly lo: number;
readonly open: number;
readonly close: number;
readonly timestamp: number;
volume: number;
readonly expansion?: boolean;
idx?: number;
readonly impVolatility?: number;
/**
* @deprecated might be removed in next major version
*/
readonly vwap?: number;
readonly typicalPrice?: number;
}
export declare const defaultSortCandles: (candles: Candle[]) => Candle[];
export declare const generateCandleId: (timestamp: number, hashValue: number | string) => string;
/**
* Provides the name of candle difference
* @param {Number} open
* @param {Number} close
* @returns {String}
*/
export declare function nameDirection(open: number, close: number): PriceMovement;
/**
* Provides the name of candle difference for hollow chart type
* @param {Number} open
* @param {Number} close
* @returns {String}
*/
export declare function hollowDirection(open: number, close: number): PriceMovement;
/**
* Creates a new Candle object based on the provided base object, with the option to modify the prices.
* @param {Candle} base - The base object to copy.
* @param {number} idx - The index of the new Candle object.
* @param {boolean} pricesAsClose - If true, the high, low, and open prices will be set to the close price.
* @returns {Candle} A new Candle object with the same properties as the base object, with the option to modify the prices.
*/
export declare function copyCandle(base: Candle, idx: number, pricesAsClose?: boolean): Candle;