| 1 | /**
|
| 2 | * ============================================================================
|
| 3 | * IMPORTS
|
| 4 | * ============================================================================
|
| 5 | * @hidden
|
| 6 | */
|
| 7 | import { Sprite, ISpriteProperties, ISpriteAdapters, ISpriteEvents } from "../../core/Sprite";
|
| 8 | import { Axis, AxisItemLocation, AxisDataItem } from "./Axis";
|
| 9 | /**
|
| 10 | * ============================================================================
|
| 11 | * REQUISITES
|
| 12 | * ============================================================================
|
| 13 | * @hidden
|
| 14 | */
|
| 15 | /**
|
| 16 | * Defines properties for [[AxisFill]].
|
| 17 | */
|
| 18 | export interface IAxisFillProperties extends ISpriteProperties {
|
| 19 | /**
|
| 20 | * Start position. (0-1)
|
| 21 | */
|
| 22 | startPosition?: number;
|
| 23 | /**
|
| 24 | * End position. (0-1)
|
| 25 | */
|
| 26 | endPosition?: number;
|
| 27 | /**
|
| 28 | * Location within the axis.
|
| 29 | */
|
| 30 | location?: number;
|
| 31 | /**
|
| 32 | * Normally fill goes below series. Set this to `true` to go above.
|
| 33 | *
|
| 34 | * @default false
|
| 35 | */
|
| 36 | above?: boolean;
|
| 37 | }
|
| 38 | /**
|
| 39 | * Defines events for [[AxisFill]].
|
| 40 | */
|
| 41 | export interface IAxisFillEvents extends ISpriteEvents {
|
| 42 | }
|
| 43 | /**
|
| 44 | * Defines adapters for [[AxisFill]].
|
| 45 | *
|
| 46 | * @see {@link Adapter}
|
| 47 | */
|
| 48 | export interface IAxisFillAdapters extends ISpriteAdapters, IAxisFillProperties {
|
| 49 | }
|
| 50 | /**
|
| 51 | * ============================================================================
|
| 52 | * MAIN CLASS
|
| 53 | * ============================================================================
|
| 54 | * @hidden
|
| 55 | */
|
| 56 | /**
|
| 57 | * AxisFill is a base class used to defines fill shapes for various
|
| 58 | * type-specific Axes.
|
| 59 | *
|
| 60 | * Axis fills are used to add fills to specific ranges of those axes.
|
| 61 | *
|
| 62 | * @see {@link IAxisFillEvents} for a list of available events
|
| 63 | * @see {@link IAxisFillAdapters} for a list of available Adapters
|
| 64 | * @important
|
| 65 | */
|
| 66 | export declare class AxisFill extends Sprite {
|
| 67 | /**
|
| 68 | * Defines available properties.
|
| 69 | */
|
| 70 | _properties: IAxisFillProperties;
|
| 71 | /**
|
| 72 | * Defines available adapters.
|
| 73 | */
|
| 74 | _adapter: IAxisFillAdapters;
|
| 75 | /**
|
| 76 | * Defines available events.
|
| 77 | */
|
| 78 | _events: IAxisFillEvents;
|
| 79 | /**
|
| 80 | * A referecent to Axis element this fill is applied to.
|
| 81 | */
|
| 82 | axis: Axis;
|
| 83 | /**
|
| 84 | * An SVG path, used to draw fill shape.
|
| 85 | *
|
| 86 | * @ignore Exclude from docs
|
| 87 | * @todo Description (review)
|
| 88 | */
|
| 89 | fillPath: string;
|
| 90 | /**
|
| 91 | * [_dataItem description]
|
| 92 | *
|
| 93 | * Not sure what this is doing here?
|
| 94 | *
|
| 95 | * @todo Description
|
| 96 | */
|
| 97 | _dataItem: AxisDataItem;
|
| 98 | /**
|
| 99 | * Constructor.
|
| 100 | *
|
| 101 | * @param axis Axis
|
| 102 | */
|
| 103 | constructor(axis: Axis);
|
| 104 | /**
|
| 105 | * @ignore
|
| 106 | */
|
| 107 | protected setDisabled(value: boolean): boolean;
|
| 108 | /**
|
| 109 | * Draws the fill element.
|
| 110 | *
|
| 111 | * @ignore Exclude from docs
|
| 112 | */
|
| 113 | draw(): void;
|
| 114 | /**
|
| 115 | * An actual starting position of the fill.
|
| 116 | *
|
| 117 | * @param value Starting position
|
| 118 | */
|
| 119 | /**
|
| 120 | * @return Start position
|
| 121 | */
|
| 122 | startPosition: number;
|
| 123 | /**
|
| 124 | * An actual end position of the fill.
|
| 125 | *
|
| 126 | * @param value End position
|
| 127 | */
|
| 128 | /**
|
| 129 | * @return End position
|
| 130 | */
|
| 131 | endPosition: number;
|
| 132 | /**
|
| 133 | * Relative location of the fill. (0-1)
|
| 134 | *
|
| 135 | * @param value Location (0-1)
|
| 136 | */
|
| 137 | /**
|
| 138 | * @return Location (0-1)
|
| 139 | */
|
| 140 | location: AxisItemLocation;
|
| 141 | /**
|
| 142 | * @ignore
|
| 143 | */
|
| 144 | protected setPath(value: string): boolean;
|
| 145 | /**
|
| 146 | * Normally fill goes below series. Set this to `true` to go above.
|
| 147 | *
|
| 148 | * @default false
|
| 149 | * @since 4.5.9
|
| 150 | * @param value Draw above series?
|
| 151 | */
|
| 152 | /**
|
| 153 | * @return Draw above series?
|
| 154 | */
|
| 155 | above: boolean;
|
| 156 | }
|