| 1 | /**
|
| 2 | * Axis Label module
|
| 3 | */
|
| 4 | /**
|
| 5 | * ============================================================================
|
| 6 | * IMPORTS
|
| 7 | * ============================================================================
|
| 8 | * @hidden
|
| 9 | */
|
| 10 | import { Label, ILabelProperties, ILabelAdapters, ILabelEvents } from "../../core/elements/Label";
|
| 11 | import { AxisItemLocation, AxisDataItem, Axis } from "./Axis";
|
| 12 | /**
|
| 13 | * ============================================================================
|
| 14 | * REQUISITES
|
| 15 | * ============================================================================
|
| 16 | * @hidden
|
| 17 | */
|
| 18 | /**
|
| 19 | * Defines properties for [[AxisLabel]].
|
| 20 | */
|
| 21 | export interface IAxisLabelProperties extends ILabelProperties {
|
| 22 | /**
|
| 23 | * Relative location of the label. (0-1)
|
| 24 | */
|
| 25 | location?: number;
|
| 26 | /**
|
| 27 | * Draw the label on the inside of the Axis?
|
| 28 | */
|
| 29 | inside?: boolean;
|
| 30 | }
|
| 31 | /**
|
| 32 | * Defines events for [[AxisLabel]].
|
| 33 | */
|
| 34 | export interface IAxisLabelEvents extends ILabelEvents {
|
| 35 | }
|
| 36 | /**
|
| 37 | * Defines adapters for [[AxisLabel]].
|
| 38 | *
|
| 39 | * @see {@link Adapter}
|
| 40 | */
|
| 41 | export interface IAxisLabelAdapters extends ILabelAdapters, IAxisLabelProperties {
|
| 42 | }
|
| 43 | /**
|
| 44 | * ============================================================================
|
| 45 | * MAIN CLASS
|
| 46 | * ============================================================================
|
| 47 | * @hidden
|
| 48 | */
|
| 49 | /**
|
| 50 | * Use to create labels on Axis.
|
| 51 | *
|
| 52 | * @see {@link IAxisLabelEvents} for a list of available events
|
| 53 | * @see {@link IAxisLabelAdapters} for a list of available Adapters
|
| 54 | * @important
|
| 55 | */
|
| 56 | export declare class AxisLabel extends Label {
|
| 57 | /**
|
| 58 | * Defines available properties.
|
| 59 | */
|
| 60 | _properties: IAxisLabelProperties;
|
| 61 | /**
|
| 62 | * Defines available adapters.
|
| 63 | */
|
| 64 | _adapter: IAxisLabelAdapters;
|
| 65 | /**
|
| 66 | * Defines available events.
|
| 67 | */
|
| 68 | _events: IAxisLabelEvents;
|
| 69 | /**
|
| 70 | * Related data item.
|
| 71 | */
|
| 72 | _dataItem: AxisDataItem;
|
| 73 | /**
|
| 74 | * A referecent to Axis element this fill is applied to.
|
| 75 | */
|
| 76 | axis: Axis;
|
| 77 | /**
|
| 78 | * Constructor
|
| 79 | */
|
| 80 | constructor();
|
| 81 | /**
|
| 82 | * Relative location of the label. (0-1)
|
| 83 | *
|
| 84 | * @param value Location (0-1)
|
| 85 | */
|
| 86 | /**
|
| 87 | * @return Location (0-1)
|
| 88 | */
|
| 89 | location: AxisItemLocation;
|
| 90 | /**
|
| 91 | * Sets if label should be drawn inside axis.
|
| 92 | *
|
| 93 | * @param value Inside?
|
| 94 | */
|
| 95 | /**
|
| 96 | * Returns if label is set to be drawn inside axis.
|
| 97 | *
|
| 98 | * @return Inside?
|
| 99 | */
|
| 100 | inside: boolean;
|
| 101 | /**
|
| 102 | * @ignore
|
| 103 | */
|
| 104 | protected setDisabled(value: boolean): boolean;
|
| 105 | }
|