@amcharts/amcharts4
Version:
amCharts 4
128 lines (127 loc) • 3.47 kB
TypeScript
/**
* ConeSeries module
* Not recommended using if you use scrollbars or your chart is zoomable in some other way.
*/
/**
* ============================================================================
* IMPORTS
* ============================================================================
* @hidden
*/
import { ColumnSeries, IColumnSeriesDataFields, IColumnSeriesProperties, IColumnSeriesAdapters, IColumnSeriesEvents, ColumnSeriesDataItem } from "./ColumnSeries";
import { ConeColumn } from "../elements/ConeColumn";
/**
* ============================================================================
* DATA ITEM
* ============================================================================
* @hidden
*/
/**
* Defines a [[DataItem]] for [[ConeSeries]].
*
* @see {@link DataItem}
*/
export declare class ConeSeriesDataItem extends ColumnSeriesDataItem {
/**
* A sprite used to draw the column.
*/
_column: ConeColumn;
/**
* Defines a type of [[Component]] this data item is used for.
*/
_component: ConeSeries;
/**
* Constructor
*/
constructor();
}
/**
* ============================================================================
* REQUISITES
* ============================================================================
* @hidden
*/
/**
* Defines data fields for [[ConeSeries]].
*/
export interface IConeSeriesDataFields extends IColumnSeriesDataFields {
}
/**
* Defines properties for [[ConeSeries]].
*/
export interface IConeSeriesProperties extends IColumnSeriesProperties {
}
/**
* Defines events for [[ConeSeries]].
*/
export interface IConeSeriesEvents extends IColumnSeriesEvents {
}
/**
* Defines adapters for [[ConeSeries]].
*
* @see {@link Adapter}
*/
export interface IConeSeriesAdapters extends IColumnSeriesAdapters, IConeSeriesProperties {
}
/**
* ============================================================================
* MAIN CLASS
* ============================================================================
* @hidden
*/
/**
* Defines [[Series]] for a cone graph.
*
* @see {@link IConeSeriesEvents} for a list of available Events
* @see {@link IConeSeriesAdapters} for a list of available Adapters
* @todo Example
* @important
*/
export declare class ConeSeries extends ColumnSeries {
/**
* Type of column.
*/
_column: ConeColumn;
/**
*/
_dataItem: ConeSeriesDataItem;
/**
* Defines the type of data fields used for the series.
*/
_dataFields: IConeSeriesDataFields;
/**
* Defines available properties.
*/
_properties: IConeSeriesProperties;
/**
* Defines available adapters.
*/
_adapter: IConeSeriesAdapters;
/**
* Defines available events.
*/
_events: IConeSeriesEvents;
/**
* Constructor
*/
constructor();
/**
* Returns an element to use for Candlestick
* @ignore
* @return Element.
*/
protected createColumnTemplate(): this["_column"];
/**
* Returns an SVG path to use as series mask.
*
* @return SVG path
*/
protected getMaskPath(): string;
/**
* Validates data item's elements.
*
* @ignore Exclude from docs
* @param dataItem Data item
*/
validateDataElementReal(dataItem: this["_dataItem"]): void;
}