@amcharts/amcharts4
Version:
amCharts 4
89 lines (88 loc) • 2.2 kB
TypeScript
/**
* Module that defines everything related to building OHLCs.
*/
/**
* ============================================================================
* IMPORTS
* ============================================================================
* @hidden
*/
import { Candlestick, ICandlestickProperties, ICandlestickAdapters, ICandlestickEvents } from "./Candlestick";
import { Line } from "../../core/elements/Line";
/**
* ============================================================================
* REQUISITES
* ============================================================================
* @hidden
*/
/**
* Defines properties for [[OHLC]].
*/
export interface IOHLCProperties extends ICandlestickProperties {
}
/**
* Defines events for [[OHLC]].
*/
export interface IOHLCEvents extends ICandlestickEvents {
}
/**
* Defines adapters for [[OHLC]].
*
* @see {@link Adapter}
*/
export interface IOHLCAdapters extends ICandlestickAdapters, IOHLCProperties {
}
/**
* ============================================================================
* MAIN CLASS
* ============================================================================
* @hidden
*/
/**
* Class used to creates OHLCs.
*
* @see {@link IOHLCEvents} for a list of available events
* @see {@link IOHLCAdapters} for a list of available Adapters
* @todo Usage example
* @important
*/
export declare class OHLC extends Candlestick {
/**
* Defines available properties.
*/
_properties: IOHLCProperties;
/**
* Defines available adapters.
*/
_adapter: IOHLCAdapters;
/**
* Defines available events.
*/
_events: IOHLCEvents;
/**
* Open line element
*/
openLine: Line;
/**
* Close line element
*/
closeLine: Line;
/**
* High-low line element
*/
highLowLine: Line;
/**
* Constructor
*/
constructor();
/**
* @ignore
*/
protected createAssets(): void;
/**
* Copies all parameters from another [[OHLC]].
*
* @param source Source OHLC
*/
copyFrom(source: this): void;
}