@amcharts/amcharts4
Version:
amCharts 4
106 lines (105 loc) • 2.68 kB
TypeScript
/**
* Module for a multi-part arched line.
*/
/**
* ============================================================================
* IMPORTS
* ============================================================================
* @hidden
*/
import { Polyline, IPolylineProperties, IPolylineAdapters, IPolylineEvents } from "./Polyline";
/**
* ============================================================================
* REQUISITES
* ============================================================================
* @hidden
*/
/**
* Defines properties for [[Polyarc]].
*/
export interface IPolyarcProperties extends IPolylineProperties {
/**
* Relative position along the line the control point is. (0-1)
*
* @default 0.5
*/
controlPointPosition: number;
/**
* Relative distance of the control point. (0-1)
*
* Default is half the length of the line. (0.5)
*
* @default 0.5
*/
controlPointDistance: number;
}
/**
* Defines events for [[Polyarc]].
*/
export interface IPolyarcEvents extends IPolylineEvents {
}
/**
* Defines adapters for [[Polyarc]].
*
* @see {@link Adapter}
*/
export interface IPolyarcAdapters extends IPolylineAdapters, IPolyarcProperties {
}
/**
* ============================================================================
* MAIN CLASS
* ============================================================================
* @hidden
*/
/**
* Draws a multi-part arched line.
*
* @see {@link IPolyarcEvents} for a list of available events
* @see {@link IPolyarcAdapters} for a list of available Adapters
*/
export declare class Polyarc extends Polyline {
/**
* Defines available properties.
*/
_properties: IPolyarcProperties;
/**
* Defines available adapters.
*/
_adapter: IPolyarcAdapters;
/**
* Defines available events.
*/
_events: IPolyarcEvents;
/**
* Constructor
*/
constructor();
/**
* Creats and adds an SVG path for the arc.
*
* @ignore Exclude from docs
*/
makePath(): void;
/**
* Relative position along the line the control point is. (0-1)
*
* @default 0.5
* @param value Position (0-1)
*/
/**
* @return Position (0-1)
*/
controlPointPosition: number;
/**
* Relative distance of the control point. (0-1)
*
* Default is half the length of the line. (0.5)
*
* @default 0.5
* @param value Distance (0-1)
*/
/**
* @return Distance (0-1)
*/
controlPointDistance: number;
}