@amcharts/amcharts5 5.13.6 → 5.14.0

package/.internal/charts/gantt/Gantt.d.ts

@@ -0,0 +1,216 @@
+import type { ITimeInterval } from "../../core/util/Time";
+import { Button } from "../../core/render/Button";
+import { ConfirmButton } from "../../core/render/ConfirmButton";
+import { Percent } from "../../core/util/Percent";
+import { GanttDateAxis, IGanttDateAxisDataItem } from "./GanttDateAxis";
+import { XYChart } from "../xy/XYChart";
+import { GanttSeries } from "./GanttSeries";
+import { Color, ColorSet, Container, DataItem, IContainerEvents, IContainerPrivate, IContainerSettings, Scrollbar } from "../../..";
+import { GanttCategoryAxis } from "./GanttCategoryAxis";
+import { GanttCategoryAxisRenderer } from "./GanttCategoryAxisRenderer";
+import { GanttDateAxisRenderer } from "./GanttDateAxisRenderer";
+import { ColorPicker } from "../../plugins/colorPicker/ColorPicker";
+import { ColorPickerButton } from "../../plugins/colorPicker/ColorPickerButton";
+export interface IGanttSettings extends IContainerSettings {
+    /**
+     * If set to `true`, the user will be able to edit the chart via UI.
+     *
+     * @default true
+     */
+    editable?: boolean;
+    /**
+     * A unit to be used for when calculating "duration" of Gantt items.
+     *
+     * @see {@link https://www.amcharts.com/docs/v5/charts/gantt/#Duration_units} for more information
+     * @default "day"
+     */
+    durationUnit?: "year" | "month" | "week" | "day" | "hour" | "minute" | "second";
+    /**
+     * An array of weekend days, e.g. `[0, 6]` for Sunday and Saturday.
+     *
+     * @default [0, 6]
+     * @see {@link https://www.amcharts.com/docs/v5/charts/gantt/#Weekends_and_holidays} for more information
+     */
+    weekends?: Array<number>;
+    /**
+     * An array of dates to treat as a holiday.
+     *
+     * @see {@link https://www.amcharts.com/docs/v5/charts/gantt/#Weekends_and_holidays} for more information
+     */
+    holidays?: Array<Date>;
+    /**
+     * If set to `true`, weekends will be excluded from the chart.
+     *
+     * @see {@link https://www.amcharts.com/docs/v5/charts/gantt/#Weekends_and_holidays} for more information
+     */
+    excludeWeekends?: boolean;
+    /**
+     * An absolute or relative width of the left-side category column.
+     *
+     * @see {@link https://www.amcharts.com/docs/v5/charts/gantt/#Category_axis_width} for more information
+     * @default 30%
+     */
+    sidebarWidth?: number | Percent;
+    /**
+     * A relative vertical cell position to treat as the threshold for snapping
+     * bars.
+     *
+     * Available range of values: `0` (left) to `1` (right).
+     *
+     * This will be used when resizing or dragging a bar. If the position is
+     * bigger than `snapThreshold` the bar will snap to the right, if it is
+     * smaller than `snapThreshold`, it will snap to the left.
+     *
+     * @see {@link https://www.amcharts.com/docs/v5/charts/gantt/#Snapping_behavior} for more information
+     * @default 0.5
+     */
+    snapThreshold?: number;
+    /**
+     * A [[ColorSet]] to use when asigning colors for series.
+     *
+     * @see {@link https://www.amcharts.com/docs/v5/charts/xy-chart/series/#Series_colors} for more info
+     */
+    colors?: ColorSet;
+    /**
+     * Grid intervals.
+     *
+     * @see {@link https://www.amcharts.com/docs/v5/charts/gantt/#Timeline_horizontal_axis} for more info
+     */
+    gridIntervals?: {
+        [index: string]: Array<ITimeInterval>;
+    };
+    /**
+     * If this is set to `true`, when a new task is added, it will be automatically linked to the previous task.
+     *
+     * @default true
+     */
+    linkNewTasks?: boolean;
+}
+export interface IGanttPrivate extends IContainerPrivate {
+}
+export interface IGanttEvents extends IContainerEvents {
+    datemarked: {
+        date: number | undefined;
+        dataItem: DataItem<IGanttDateAxisDataItem>;
+    };
+    dateunmarked: {
+        date: number | undefined;
+        dataItem?: DataItem<IGanttDateAxisDataItem>;
+    };
+    valueschanged: {};
+}
+/**
+ * Creates a [[Gantt]] chart.
+ *
+ * @see {@link https://www.amcharts.com/docs/v5/charts/gantt/} for more info
+ * @important
+ * @since 5.14.0
+ */
+export declare class Gantt extends Container {
+    _settings: IGanttSettings;
+    _privateSettings: IGanttPrivate;
+    _events: IGanttEvents;
+    static className: string;
+    static classNames: Array<string>;
+    /**
+     * A scrollbar for horizontal scrolling.
+     */
+    scrollbarX: Scrollbar;
+    /**
+     * A scrollbar for vertical scrolling.
+     */
+    scrollbarY: Scrollbar;
+    /**
+     * A reference to the [[XYChart]] that holds the Gantt chart.
+     */
+    xyChart: XYChart;
+    /**
+     * A reference to the [[GanttSeries]] that shows the Gantt tasks bars.
+     */
+    series: GanttSeries;
+    /**
+     * A reference to the [[GanttDateAxis]] used as the main X-axis.
+     */
+    xAxis: GanttDateAxis<GanttDateAxisRenderer>;
+    /**
+     * A reference to the [[GanttDateAxis]] used as the secondary X-axis.
+     */
+    xAxisMinor: GanttDateAxis<GanttDateAxisRenderer>;
+    /**
+     * A reference to the [[GanttCategoryAxis]] used as the Y-axis.
+     */
+    yAxis: GanttCategoryAxis<GanttCategoryAxisRenderer>;
+    /**
+     * Controls (add, color picker, expand, collaps, clear buttons) container.
+     */
+    controls: Container;
+    zoomControls: Container;
+    /**
+     * The [[Button]] element to add new tasks.
+     */
+    readonly addButton: Button;
+    /**
+     * The [[ColorPickerButton]] element to select colors for tasks.
+     */
+    readonly colorPickerButton: ColorPickerButton;
+    /**
+     * The [[Button]] elements to expand and collapse all tasks.
+     */
+    readonly expandButton: Button;
+    /**
+     * The [[Button]] elements to collapse all tasks.
+     */
+    readonly collapseButton: Button;
+    /**
+     * The [[Button]] element to toggle `linkNewTasks` setting.
+     */
+    readonly linkButton: Button;
+    /**
+     * The [[Button]] element to horizontally fit visible tasks into a view.
+     */
+    readonly fitButton: Button;
+    /**
+     * The [[Button]] element to zoom out the X axis.
+     */
+    readonly zoomOutButton: Button;
+    /**
+     * The [[Button]] element to clear all tasks.
+     */
+    readonly clearButton: ConfirmButton;
+    /**
+     * The [[ColorPicker]] element to select colors for tasks.
+     */
+    readonly colorPicker: ColorPicker;
+    protected _customColor: Color | undefined;
+    protected _afterNew(): void;
+    _prepareChildren(): void;
+    clearAll(): void;
+    _updateChildren(): void;
+    protected _updateScrollbar(): void;
+    /**
+     * Adds a new task to the Gantt chart.
+     *
+     * @param category        The category name for the task. If not provided, will be auto-generated.
+     * @param start           The start time of the task in milliseconds. If not provided, will be determined based on context.
+     * @param duration        The duration of the task. If not provided, defaults to 1.
+     * @param parentId        The parent category if this is a subtask.
+     * @param progress        The initial progress of the task (0-1). Defaults to 0.
+     * @param linkToPrevious  Should the task automatically link to the previous one?
+     */
+    addNewTask(name?: string, start?: number, duration?: number, parentId?: string, progress?: number, linkToPrevious?: boolean): void;
+    _nextColor(): Color | undefined;
+    /**
+     * Marks a date on the minor date axis.
+     *
+     * @param date  Date to be marked
+     */
+    markDate(date: number): void;
+    /**
+     * Unmarks a date on the minor date axis.
+     *
+     * @param date  Date to be unmarked
+     */
+    unmarkDate(date: number): void;
+    protected _toggleEditable(value: boolean): void;
+}
+//# sourceMappingURL=Gantt.d.ts.map

package/.internal/charts/gantt/Gantt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Gantt.d.ts","sourceRoot":"","sources":["../../../../../src/.internal/charts/gantt/Gantt.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAG1D,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AAEhE,OAAO,EAAE,OAAO,EAAW,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,aAAa,EAAE,sBAAsB,EAAE,MAAM,iBAAiB,CAAC;AACxE,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAS,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,kBAAkB,EAAa,SAAS,EAAW,MAAM,UAAU,CAAC;AAC/J,OAAO,EAAE,iBAAiB,EAA8B,MAAM,qBAAqB,CAAC;AACpF,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AACxE,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAEhE,OAAO,EAAE,WAAW,EAAE,MAAM,uCAAuC,CAAC;AACpE,OAAO,EAAE,iBAAiB,EAAE,MAAM,6CAA6C,CAAC;AAOhF,MAAM,WAAW,cAAe,SAAQ,kBAAkB;IAEzD;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAEhF;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAEvB;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAEhC;;;;;;;;;;;;OAYG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,MAAM,CAAC,EAAE,QAAQ,CAAC;IAElB;;;;OAIG;IACH,aAAa,CAAC,EAAE;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,aAAa,CAAC,CAAA;KAAE,CAAC;IAE1D;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,aAAc,SAAQ,iBAAiB;CAAI;AAE5D,MAAM,WAAW,YAAa,SAAQ,gBAAgB;IACrD,UAAU,EAAE;QAAE,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,QAAQ,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAA;KAAE,CAAC;IACrF,YAAY,EAAE;QAAE,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,sBAAsB,CAAC,CAAA;KAAE,CAAC;IACxF,aAAa,EAAE,EAAE,CAAC;CAClB;AAED;;;;;;GAMG;AACH,qBAAa,KAAM,SAAQ,SAAS;IACpB,SAAS,EAAE,cAAc,CAAC;IAC1B,gBAAgB,EAAE,aAAa,CAAC;IAChC,OAAO,EAAE,YAAY,CAAC;IACrC,OAAc,SAAS,EAAE,MAAM,CAAW;IAC1C,OAAc,UAAU,EAAE,KAAK,CAAC,MAAM,CAAC,CAAkD;IAEzF;;OAEG;IACI,UAAU,EAAE,SAAS,CAEzB;IAEH;;OAEG;IACI,UAAU,EAAE,SAAS,CAEzB;IAEH;;OAEG;IACI,OAAO,EAAG,OAAO,CAAC;IAEzB;;OAEG;IACI,MAAM,EAAG,WAAW,CAAC;IAE5B;;OAEG;IACI,KAAK,EAAG,aAAa,CAAC,qBAAqB,CAAC,CAAC;IAEpD;;OAEG;IACI,UAAU,EAAG,aAAa,CAAC,qBAAqB,CAAC,CAAC;IAEzD;;OAEG;IACI,KAAK,EAAG,iBAAiB,CAAC,yBAAyB,CAAC,CAAC;IAE5D;;OAEG;IACI,QAAQ,EAAE,SAAS,CAGxB;IAEK,YAAY,EAAE,SAAS,CAE3B;IAEH;;OAEG;IACH,SAAgB,SAAS,EAAE,MAAM,CAI7B;IAEJ;;OAEG;IACH,SAAgB,iBAAiB,EAAE,iBAAiB,CAGhD;IAEJ;;OAEG;IACH,SAAgB,YAAY,EAAE,MAAM,CAIhC;IAEJ;;OAEG;IACH,SAAgB,cAAc,EAAE,MAAM,CAIlC;IAEJ;;OAEG;IACH,SAAgB,UAAU,EAAE,MAAM,CAI9B;IAEJ;;OAEG;IACH,SAAgB,SAAS,EAAE,MAAM,CAI7B;IAEJ;;OAEG;IACH,SAAgB,aAAa,EAAE,MAAM,CAIjC;IAEJ;;OAEG;IACH,SAAgB,WAAW,EAAE,aAAa,CAKtC;IAEJ;;OAEG;IACH,SAAgB,WAAW,EAAE,WAAW,CAAuE;IAE/G,SAAS,CAAC,YAAY,EAAE,KAAK,GAAG,SAAS,CAAC;IAI1C,SAAS,CAAC,SAAS;IAkUZ,gBAAgB,IAAI,IAAI;IAOxB,QAAQ;IAqBR,eAAe;IA2BtB,SAAS,CAAC,gBAAgB;IAQ1B;;;;;;;;;OASG;IACI,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,QAAQ,GAAE,MAAU,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,GAAE,MAAU,EAAE,cAAc,CAAC,EAAE,OAAO;IAuJjI,UAAU,IAAI,KAAK,GAAG,SAAS;IAUtC;;;;OAIG;IACI,QAAQ,CAAC,IAAI,EAAE,MAAM;IAa5B;;;;OAIG;IACI,UAAU,CAAC,IAAI,EAAE,MAAM;IAgB9B,SAAS,CAAC,eAAe,CAAC,KAAK,EAAE,OAAO;CA4BxC"}