| 1 | /**
|
| 2 | * DateAxisBreak includes functionality to add breaks on a [[DateAxis]].
|
| 3 | *
|
| 4 | * A "break" can be used to "cut out" specific ranges of the axis scale, e.g.
|
| 5 | * weekends and holidays out of the Date-based axis.
|
| 6 | */
|
| 7 | /**
|
| 8 | * ============================================================================
|
| 9 | * IMPORTS
|
| 10 | * ============================================================================
|
| 11 | * @hidden
|
| 12 | */
|
| 13 | import { ValueAxisBreak, IValueAxisBreakProperties, IValueAxisBreakAdapters, IValueAxisBreakEvents } from "./ValueAxisBreak";
|
| 14 | import { DateAxis } from "./DateAxis";
|
| 15 | import { ITimeInterval } from "../../core/defs/ITimeInterval";
|
| 16 | /**
|
| 17 | * ============================================================================
|
| 18 | * REQUISITES
|
| 19 | * ============================================================================
|
| 20 | * @hidden
|
| 21 | */
|
| 22 | /**
|
| 23 | * Defines properties for [[DateAxisBreak]].
|
| 24 | */
|
| 25 | export interface IDateAxisBreakProperties extends IValueAxisBreakProperties {
|
| 26 | /**
|
| 27 | * A `Date` break starts on.
|
| 28 | */
|
| 29 | startDate?: Date;
|
| 30 | /**
|
| 31 | * A `Date` break ends on.
|
| 32 | */
|
| 33 | endDate?: Date;
|
| 34 | }
|
| 35 | /**
|
| 36 | * Defines events for [[DateAxisBreak]]
|
| 37 | */
|
| 38 | export interface IDateAxisBreakEvents extends IValueAxisBreakEvents {
|
| 39 | }
|
| 40 | /**
|
| 41 | * Defines adapters for [[DateAxisBreak]].
|
| 42 | *
|
| 43 | * @see {@link Adapter}
|
| 44 | */
|
| 45 | export interface IDateAxisBreakAdapters extends IValueAxisBreakAdapters, IDateAxisBreakProperties {
|
| 46 | }
|
| 47 | /**
|
| 48 | * ============================================================================
|
| 49 | * MAIN CLASS
|
| 50 | * ============================================================================
|
| 51 | * @hidden
|
| 52 | */
|
| 53 | /**
|
| 54 | * Class used to define breaks for [[DateAxis]].
|
| 55 | *
|
| 56 | * A "break" can be used to "cut out" specific ranges of the axis scale, e.g.
|
| 57 | * weekends and holidays out of the Date-based axis.
|
| 58 | *
|
| 59 | * @see {@link IDateAxisBreakEvents} for a list of available events
|
| 60 | * @see {@link IDateAxisBreakAdapters} for a list of available Adapters
|
| 61 | * @important
|
| 62 | */
|
| 63 | export declare class DateAxisBreak extends ValueAxisBreak {
|
| 64 | /**
|
| 65 | * Defines available properties.
|
| 66 | */
|
| 67 | _properties: IDateAxisBreakProperties;
|
| 68 | /**
|
| 69 | * Defines available adapters.
|
| 70 | */
|
| 71 | _adapter: IDateAxisBreakAdapters;
|
| 72 | /**
|
| 73 | * Defines available events.
|
| 74 | */
|
| 75 | _events: IDateAxisBreakEvents;
|
| 76 | /**
|
| 77 | * Defines the type of the Axis this break is used for.
|
| 78 | */
|
| 79 | _axisType: DateAxis;
|
| 80 | /**
|
| 81 | * [gridInterval description]
|
| 82 | *
|
| 83 | * @ignore Exclude from docs
|
| 84 | * @todo Description
|
| 85 | */
|
| 86 | gridInterval: ITimeInterval;
|
| 87 | /**
|
| 88 | * [gridDate description]
|
| 89 | *
|
| 90 | * @ignore Exclude from docs
|
| 91 | * @todo Description
|
| 92 | */
|
| 93 | gridDate: Date;
|
| 94 | /**
|
| 95 | * Constructor
|
| 96 | */
|
| 97 | constructor();
|
| 98 | /**
|
| 99 | * Starting date for the break.
|
| 100 | *
|
| 101 | * @param value Start date
|
| 102 | */
|
| 103 | /**
|
| 104 | * @return Start date
|
| 105 | */
|
| 106 | startDate: Date;
|
| 107 | /**
|
| 108 | * Ending date for the break.
|
| 109 | *
|
| 110 | * @param value End date
|
| 111 | */
|
| 112 | /**
|
| 113 | * @return End date
|
| 114 | */
|
| 115 | endDate: Date;
|
| 116 | }
|