@amcharts/amcharts4
Version:
amCharts 4
189 lines (188 loc) • 5 kB
TypeScript
/**
* Axis Bullet module.
*/
/**
* ============================================================================
* IMPORTS
* ============================================================================
* @hidden
*/
import { Container, IContainerAdapters, IContainerEvents, IContainerProperties } from "../../core/Container";
import { AxisItemLocation, AxisDataItem, Axis } from "./Axis";
/**
* ============================================================================
* REQUISITES
* ============================================================================
* @hidden
*/
/**
* Defines properties for [[AxisBullet]].
*/
export interface IAxisBulletProperties extends IContainerProperties {
/**
* Relative position within cell/range.
*
* Value range is from from `0` (beginning) to `1` (end).
*
* @default 0.5
*/
location?: number;
/**
* Draw inside plot area (`true`) or outside it (`false`).
*
* @default false
*/
inside?: boolean;
}
/**
* Defines events for [[AxisBullet]].
*/
export interface IAxisBulletEvents extends IContainerEvents {
}
/**
* Defines adapter for [[AxisBullet]].
*
* @see {@link Adapter}
*/
export interface IAxisBulletAdapters extends IContainerAdapters, IAxisBulletProperties {
}
/**
* ============================================================================
* MAIN CLASS
* ============================================================================
* @hidden
*/
/**
* Used to draw a positioned bullet (element) on an Axis.
*
* ```TypeScript
* let range = dateAxis.axisRanges.create();
* range.date = new Date(2018, 0, 5);
*
* let flag = new am4plugins_bullets.FlagBullet();
* flag.label.text = "Hello";
*
* range.bullet = flag;
* ```
* ```JavaScript
* var range = dateAxis.axisRanges.create();
* range.date = new Date(2018, 0, 5);
*
* var flag = new am4plugins_bullets.FlagBullet();
* flag.label.text = "Hello";
*
* range.bullet = flag;
* ```
* ```JSON
* {
* // ...
* "xAxes": [{
* "type": "DateAxis",
* // ...
* "axisRanges": [{
* "date": new Date(2018, 0, 5),
* "bullet: {
* "type": "FlagBullet",
* "label": {
* "text": "Hello"
* }
* }
* }]
* }]
* }
* ```
*
* @since 4.5.9
* @see {@link IAxisBulletEvents} for a list of available events
* @see {@link IAxisBulletAdapters} for a list of available Adapters
* @important
*/
export declare class AxisBullet extends Container {
/**
* Defines available properties
*/
_properties: IAxisBulletProperties;
/**
* Defines available adapters
*/
_adapter: IAxisBulletAdapters;
/**
* Defines available events.
*/
_events: IAxisBulletEvents;
/**
* Data item.
*/
_dataItem: AxisDataItem;
/**
* A referecent to Axis element this fill is applied to.
*/
axis: Axis;
constructor();
/**
* Relative position within cell/range.
*
* Value range is from from `0` (beginning) to `1` (end).
*
* NOTE: `location` is relative to the parent axis range's scope, i.e.
* between its `date` and `endDate` for [[DateAxis]], or `value`/`endValue`
* ([[ValueAxis]]), or `category`/`endCategory` ([[categoryAxis]]).
*
* ```TypeScript
* let range = dateAxis.axisRanges.create();
* range.date = new Date(2018, 0, 5);
* range.endDate = new Date(2018, 0, 6);
*
* let bullet = new am4charts.AxisBullet();
* bullet.location = 1;
*
* let flag = bullet.createChild(am4plugins_bullets.FlagBullet);
* flag.label.text = "Hello";
* ```
* ```JavaScript
* var range = dateAxis.axisRanges.create();
* range.date = new Date(2018, 0, 5);
* range.endDate = new Date(2018, 0, 6);
*
* var bullet = new am4charts.AxisBullet();
* bullet.location = 1;
*
* var flag = bullet.createChild(am4plugins_bullets.FlagBullet);
* flag.label.text = "Hello";
* ```
* ```JSON
* {
* // ...
* "xAxes": [{
* "type": "DateAxis",
* // ...
* "axisRanges": [{
* "date": new Date(2018, 0, 5),
* "endDate": new Date(2018, 0, 6),
* "bullet: {
* "type": "AxisBullet",
* "location": 1,
* "children": [{
* "type": "FlagBullet",
* "label": {
* "text": "Hello"
* }
* }]
* }
* }]
* }]
* }
* ```
*
* @default 0.5
* @param value Location (0-1)
*/
/**
* @return Location (0-1)
*/
location: AxisItemLocation;
/**
* @ignore
*/
protected setDisabled(value: boolean): boolean;
}