| 1 | /**
|
| 2 | * A module defining functionality for axis grid elements.
|
| 3 | */
|
| 4 | /**
|
| 5 | * ============================================================================
|
| 6 | * IMPORTS
|
| 7 | * ============================================================================
|
| 8 | * @hidden
|
| 9 | */
|
| 10 | import { Sprite, ISpriteProperties, ISpriteEvents, ISpriteAdapters } from "../../core/Sprite";
|
| 11 | import { AxisItemLocation, AxisDataItem, Axis } from "./Axis";
|
| 12 | /**
|
| 13 | * ============================================================================
|
| 14 | * REQUISITES
|
| 15 | * ============================================================================
|
| 16 | * @hidden
|
| 17 | */
|
| 18 | /**
|
| 19 | * Defines properties for [[Grid]].
|
| 20 | */
|
| 21 | export interface IGridProperties extends ISpriteProperties {
|
| 22 | /**
|
| 23 | * Location of the grid item within cell. (0-1)
|
| 24 | */
|
| 25 | location?: AxisItemLocation;
|
| 26 | /**
|
| 27 | * Normally fill goes below series. Set this to `true` to go above.
|
| 28 | *
|
| 29 | * @default false
|
| 30 | */
|
| 31 | above?: boolean;
|
| 32 | }
|
| 33 | /**
|
| 34 | * Defines events for [[Grid]].
|
| 35 | */
|
| 36 | export interface IGridEvents extends ISpriteEvents {
|
| 37 | }
|
| 38 | /**
|
| 39 | * Defines adapters for [[Grid]].
|
| 40 | *
|
| 41 | * @see {@link Adapter}
|
| 42 | */
|
| 43 | export interface IGridAdapters extends ISpriteAdapters, IGridProperties {
|
| 44 | }
|
| 45 | /**
|
| 46 | * ============================================================================
|
| 47 | * MAIN CLASS
|
| 48 | * ============================================================================
|
| 49 | * @hidden
|
| 50 | */
|
| 51 | /**
|
| 52 | * Displays an axis grid line.
|
| 53 | *
|
| 54 | * @see {@link IGridEvents} for a list of available events
|
| 55 | * @see {@link IGridAdapters} for a list of available Adapters
|
| 56 | * @todo Review: container is better, as we'll be able to attach something to the grid, also with 3d charts we might need some additional elements
|
| 57 | * @important
|
| 58 | */
|
| 59 | export declare class Grid extends Sprite {
|
| 60 | /**
|
| 61 | * Defines available properties.
|
| 62 | */
|
| 63 | _properties: IGridProperties;
|
| 64 | /**
|
| 65 | * Defines available adapters.
|
| 66 | */
|
| 67 | _adapter: IGridAdapters;
|
| 68 | /**
|
| 69 | * Defines available events.
|
| 70 | */
|
| 71 | _events: IGridEvents;
|
| 72 | /**
|
| 73 | * An axis data item that corresponds to the this grid element.
|
| 74 | */
|
| 75 | _dataItem: AxisDataItem;
|
| 76 | /**
|
| 77 | * A referecent to Axis element this fill is applied to.
|
| 78 | */
|
| 79 | axis: Axis;
|
| 80 | /**
|
| 81 | * Constructor
|
| 82 | */
|
| 83 | constructor();
|
| 84 | /**
|
| 85 | * Location within axis cell to place grid line on.
|
| 86 | *
|
| 87 | * * 0 - start
|
| 88 | * * 0.5 - middle
|
| 89 | * * 1 - end
|
| 90 | *
|
| 91 | * @param value Location (0-1)
|
| 92 | */
|
| 93 | /**
|
| 94 | * @return Location (0-1)
|
| 95 | */
|
| 96 | location: AxisItemLocation;
|
| 97 | /**
|
| 98 | * Normally fill goes below series. Set this to `true` to go above.
|
| 99 | *
|
| 100 | * @default false
|
| 101 | * @since 4.5.9
|
| 102 | * @param value Draw above series?
|
| 103 | */
|
| 104 | /**
|
| 105 | * @return Draw above series?
|
| 106 | */
|
| 107 | above: boolean;
|
| 108 | /**
|
| 109 | * @ignore
|
| 110 | */
|
| 111 | protected setDisabled(value: boolean): boolean;
|
| 112 | }
|