UNPKG

3.12 kBTypeScriptView Raw
1/**
2 * ============================================================================
3 * IMPORTS
4 * ============================================================================
5 * @hidden
6 */
7import { AxisFill, IAxisFillProperties, IAxisFillAdapters, IAxisFillEvents } from "./AxisFill";
8import { Axis } from "./Axis";
9import { Percent } from "../../core/utils/Percent";
10/**
11 * ============================================================================
12 * REQUISITES
13 * ============================================================================
14 * @hidden
15 */
16/**
17 * Defines properties for [[AxisFillCircular]].
18 */
19export interface IAxisFillCircularProperties extends IAxisFillProperties {
20 /**
21 * Inner radius. Relative ir absolute.
22 */
23 innerRadius?: number | Percent;
24 /**
25 * Outer radius. Relative or absolute.
26 */
27 radius?: number | Percent;
28 /**
29 * Corner radius for the fill. In pixels.
30 */
31 cornerRadius?: number;
32}
33/**
34 * Defines events for [[AxisFillCircular]].
35 */
36export interface IAxisFillCircularEvents extends IAxisFillEvents {
37}
38/**
39 * Defines adapters for [[AxisFillCircular]].
40 *
41 * @see {@link Adapter}
42 */
43export interface IAxisFillCircularAdapters extends IAxisFillAdapters, IAxisFillCircularProperties {
44}
45/**
46 * ============================================================================
47 * MAIN CLASS
48 * ============================================================================
49 * @hidden
50 */
51/**
52 * Provides fill element functionality for circular Axes.
53 *
54 * @see {@link IAxisFillCircularEvents} for a list of available events
55 * @see {@link IAxisFillCircularAdapters} for a list of available Adapters
56 * @todo Needs description
57 */
58export declare class AxisFillCircular extends AxisFill {
59 /**
60 * Defines available properties.
61 */
62 _properties: IAxisFillCircularProperties;
63 /**
64 * Defines available adapters.
65 */
66 _adapter: IAxisFillCircularAdapters;
67 /**
68 * Defines available events.
69 */
70 _events: IAxisFillCircularEvents;
71 /**
72 * An SVG path, used to draw fill shape.
73 *
74 * @ignore Exclude from docs
75 * @todo Description (review)
76 */
77 fillPath: string;
78 /**
79 * Constructor.
80 *
81 * @param axis Axis
82 */
83 constructor(axis: Axis);
84 /**
85 * Draws the fill element.
86 *
87 * @ignore Exclude from docs
88 */
89 draw(): void;
90 /**
91 * Inner radius of the fill. Relative ([[Percent]]) or absolute (pixels).
92 *
93 * @param value Inner radius
94 */
95 /**
96 * @return Inner radius
97 */
98 innerRadius: number | Percent;
99 /**
100 * Outer radius of the fill. Relative ([[Percent]]) or absolute (pixels).
101 *
102 * @param value Outer radius
103 */
104 /**
105 * @return Outer radius
106 */
107 radius: number | Percent;
108 /**
109 * Corner radius for the fill. In pixels.
110 *
111 * @param value Corner radius (px)
112 */
113 /**
114 * @return Corner radius (px)
115 */
116 cornerRadius: number;
117}