| 1 | /**
|
| 2 | * Axis Tick module
|
| 3 | */
|
| 4 | /**
|
| 5 | * ============================================================================
|
| 6 | * IMPORTS
|
| 7 | * ============================================================================
|
| 8 | * @hidden
|
| 9 | */
|
| 10 | import { Tick, ITickProperties, ITickAdapters, ITickEvents } from "../elements/Tick";
|
| 11 | import { AxisItemLocation, AxisDataItem, Axis } from "./Axis";
|
| 12 | /**
|
| 13 | * ============================================================================
|
| 14 | * REQUISITES
|
| 15 | * ============================================================================
|
| 16 | * @hidden
|
| 17 | */
|
| 18 | /**
|
| 19 | * Defines properties for [[AxisTick]].
|
| 20 | */
|
| 21 | export interface IAxisTickProperties extends ITickProperties {
|
| 22 | /**
|
| 23 | * Relative location of the tick. (0-1)
|
| 24 | */
|
| 25 | location?: number;
|
| 26 | /**
|
| 27 | * Draw the tick on the inside of the Axis?
|
| 28 | */
|
| 29 | inside?: boolean;
|
| 30 | /**
|
| 31 | * Normally fill goes below series. Set this to `true` to go above.
|
| 32 | *
|
| 33 | * @default false
|
| 34 | */
|
| 35 | above?: boolean;
|
| 36 | }
|
| 37 | /**
|
| 38 | * Defines events for [[AxisTick]].
|
| 39 | */
|
| 40 | export interface IAxisTickEvents extends ITickEvents {
|
| 41 | }
|
| 42 | /**
|
| 43 | * Defines adapter for [[AxisTick]].
|
| 44 | *
|
| 45 | * @see {@link Adapter}
|
| 46 | */
|
| 47 | export interface IAxisTickAdapters extends ITickAdapters, IAxisTickProperties {
|
| 48 | }
|
| 49 | /**
|
| 50 | * ============================================================================
|
| 51 | * MAIN CLASS
|
| 52 | * ============================================================================
|
| 53 | * @hidden
|
| 54 | */
|
| 55 | /**
|
| 56 | * Draws an axis tick
|
| 57 | * @see {@link IAxisTickEvents} for a list of available events
|
| 58 | * @see {@link IAxisTickAdapters} for a list of available Adapters
|
| 59 | */
|
| 60 | export declare class AxisTick extends Tick {
|
| 61 | /**
|
| 62 | * Defines available properties
|
| 63 | */
|
| 64 | _properties: IAxisTickProperties;
|
| 65 | /**
|
| 66 | * Defines available adapters
|
| 67 | */
|
| 68 | _adapter: IAxisTickAdapters;
|
| 69 | /**
|
| 70 | * Defines available events.
|
| 71 | */
|
| 72 | _events: IAxisTickEvents;
|
| 73 | _dataItem: AxisDataItem;
|
| 74 | /**
|
| 75 | * A referece to Axis element this tick is placed on.
|
| 76 | */
|
| 77 | axis: Axis;
|
| 78 | constructor();
|
| 79 | /**
|
| 80 | * Relative location of the tick. (0-1)
|
| 81 | *
|
| 82 | * @param value Location (0-1)
|
| 83 | */
|
| 84 | /**
|
| 85 | * @return Location (0-1)
|
| 86 | */
|
| 87 | location: AxisItemLocation;
|
| 88 | /**
|
| 89 | * Sets if tick should be drawn inside axis.
|
| 90 | *
|
| 91 | * @param value Inside?
|
| 92 | */
|
| 93 | /**
|
| 94 | * Returns if label is set to be drawn inside axis.
|
| 95 | *
|
| 96 | * @return Inside?
|
| 97 | */
|
| 98 | inside: boolean;
|
| 99 | /**
|
| 100 | * Normally tick goes below series. Set this to `true` to go above.
|
| 101 | *
|
| 102 | * @default false
|
| 103 | * @since 4.5.9
|
| 104 | * @param value Draw above series?
|
| 105 | */
|
| 106 | /**
|
| 107 | * @return Draw above series?
|
| 108 | */
|
| 109 | above: boolean;
|
| 110 | /**
|
| 111 | * @ignore
|
| 112 | */
|
| 113 | protected setDisabled(value: boolean): boolean;
|
| 114 | }
|