@amcharts/amcharts4
Version:
amCharts 4
106 lines (105 loc) • 2.7 kB
TypeScript
/**
* Pointed rectangle module.
*/
/**
* ============================================================================
* IMPORTS
* ============================================================================
* @hidden
*/
import { PointedShape, IPointedShapeProperties, IPointedShapeAdapters, IPointedShapeEvents } from "../../core/elements/PointedShape";
/**
* ============================================================================
* REQUISITES
* ============================================================================
* @hidden
*/
/**
* Defines properties for [[PointedCircle]].
*/
export interface IPointedCircleProperties extends IPointedShapeProperties {
/**
* Radius of a pin, in pixels.
*
* @default 18
*/
radius?: number;
/**
* Angle of a pointer, in degrees.
*
* @default 90
*/
pointerAngle?: number;
}
/**
* Defines events for [[PointedCircle]].
*/
export interface IPointedCircleEvents extends IPointedShapeEvents {
}
/**
* Defines adapters for [[PointedCircle]].
*
* @see {@link Adapter}
*/
export interface IPointedCircleAdapters extends IPointedShapeAdapters, IPointedCircleProperties {
}
/**
* ============================================================================
* MAIN CLASS
* ============================================================================
* @hidden
*/
/**
* Draws a circle with a pointer.
*
* @since 4.5.7
* @see {@link https://www.amcharts.com/docs/v4/tutorials/plugin-bullets/} for usage instructions.
* @see {@link IPointedCircleEvents} for a list of available events
* @see {@link IPointedCircleAdapters} for a list of available Adapters
*/
export declare class PointedCircle extends PointedShape {
/**
* Defines available properties.
*/
_properties: IPointedCircleProperties;
/**
* Defines available adapters.
*/
_adapter: IPointedCircleAdapters;
/**
* Defines available events.
*/
_events: IPointedCircleEvents;
/**
* Constructor
*/
constructor();
/**
* Draws the element.
*
* @ignore Exclude from docs
*/
draw(): void;
/**
* Radius of a circle in pixels.
*
* @default 18
* @param value Radius (px)
*/
/**
* @return Radius (px)
*/
radius: number;
/**
* Angle of a pointer, in degrees.
*
* @default 90
* @param value Angle (degrees)
*/
/**
* @return Angle of a pointer, in degrees.
*/
pointerAngle: number;
getTooltipY(): number;
getTooltipX(): number;
}