@syncfusion/ej2-gantt 20.3.61 → 20.4.40

package/src/gantt/base/gantt.d.ts

@@ -21,7 +21,7 @@ import { ZoomEventArgs, IActionBeginEventArgs, CellSelectingEventArgs, RowDesele
 import { ITimeSpanEventArgs, ZoomTimelineSettings, QueryCellInfoEventArgs, RowDataBoundEventArgs, RowSelectEventArgs } from './interface';
 import { TaskFieldsModel, TimelineSettingsModel, SplitterSettingsModel, SortSettingsModel } from '../models/models';
 import { EventMarkerModel, AddDialogFieldSettingsModel, EditDialogFieldSettingsModel, EditSettingsModel } from '../models/models';
-import { HolidayModel, DayWorkingTimeModel, FilterSettingsModel, SelectionSettingsModel } from '../models/models';
+import { HolidayModel, DayWorkingTimeModel, FilterSettingsModel, SelectionSettingsModel, LoadingIndicatorModel } from '../models/models';
 import { LabelSettingsModel } from '../models/models';
 import { SearchSettingsModel, ResourceFieldsModel } from '../models/models';
 import { ItemModel, ClickEventArgs } from '@syncfusion/ej2-navigations';
@@ -82,6 +82,19 @@ export declare class Gantt extends Component<HTMLElement> implements INotifyProp
     /** @hidden */
     treeGridPane: HTMLElement;
     /** @hidden */
+    private contentMaskTable;
+    /** @hidden */
+    private headerMaskTable;
+    /** @hidden */
+    columnLoop: any;
+    showIndicator: boolean;
+    singleTier: number;
+    isVirtualScroll: boolean;
+    scrollLeftValue: any;
+    isToolBarClick: any;
+    /** @hidden */
+    topBottomHeader: any;
+    /** @hidden */
     splitterElement: HTMLElement;
     /** @hidden */
     toolbarModule: Toolbar;
@@ -307,6 +320,18 @@ export declare class Gantt extends Component<HTMLElement> implements INotifyProp
      * @default true
      */
     disableHtmlEncode: boolean;
+    /**
+     * Configures the loading indicator of the Gantt Chart. Specifies whether to display spinner or shimmer effect during the waiting time on any actions performed in Gantt Chart.
+     *
+     * @default {indicatorType: 'Spinner'}
+     */
+    loadingIndicator: LoadingIndicatorModel;
+    /**
+     * Specifies whether to display shimmer effect during scrolling action in virtual scrolling feature. If disabled, spinner is shown instead of shimmer effect.
+     *
+     * @default true
+     */
+    enableVirtualMaskRow: boolean;
     /**
      * Enables or disables the focusing the task bar on click action.
      *
@@ -419,6 +444,8 @@ export declare class Gantt extends Component<HTMLElement> implements INotifyProp
     renderBaseline: boolean;
     /**
      * Configures the grid lines in tree grid and gantt chart.
+     *
+     *  @default 'Horizontal'
      */
     gridLines: GridLine;
     /**
@@ -446,6 +473,8 @@ export declare class Gantt extends Component<HTMLElement> implements INotifyProp
     milestoneTemplate: string;
     /**
      * Defines the baseline bar color.
+     *
+     *  @default null
      */
     baselineColor: string;
     /**
@@ -523,6 +552,7 @@ export declare class Gantt extends Component<HTMLElement> implements INotifyProp
     /**
      * Defines height of taskbar element in Gantt.
      *
+     * @default null
      * @aspType int?
      */
     taskbarHeight: number;
@@ -627,6 +657,8 @@ export declare class Gantt extends Component<HTMLElement> implements INotifyProp
     taskType: TaskType;
     /**
      * Defines the view type of the Gantt.
+     *
+     *  @default 'ProjectView'
      */
     viewType: ViewType;
     /**
@@ -783,6 +815,8 @@ export declare class Gantt extends Component<HTMLElement> implements INotifyProp
     showOverAllocation: boolean;
     /**
      * Specifies task schedule mode for a project.
+     *
+     * @default 'Auto'
      */
     taskMode: ScheduleMode;
     /**
@@ -1249,7 +1283,7 @@ export declare class Gantt extends Component<HTMLElement> implements INotifyProp
     /**
      * To check whether the date is in DST.
      *
-     * @param {Date} date .
+     * @param {Date} date - Defines the date to check whether it is DST.
      * @returns {boolean} .
      * @private
      */
@@ -1278,6 +1312,15 @@ export declare class Gantt extends Component<HTMLElement> implements INotifyProp
      * @private
      */
     protected render(): void;
+    hideMaskRow(): void;
+    showMaskRow(): void;
+    private renderHeaderBackground;
+    private renderBackGround;
+    private createMaskTable;
+    private createEmptyTimeLineTable;
+    private applyTimelineMaskRow;
+    private createEmptyMaskTable;
+    private applyMaskRow;
     /**
      * Method used to show spinner.
      *
@@ -1296,7 +1339,7 @@ export declare class Gantt extends Component<HTMLElement> implements INotifyProp
      */
     processTimeline(): void;
     /**
-     * @param {boolean} isChange .
+     * @param {boolean} isChange -Defines whether task data is changed.
      * @returns {void} .
      * @private
      */
@@ -1314,7 +1357,7 @@ export declare class Gantt extends Component<HTMLElement> implements INotifyProp
     /**
      * Method for updating row height value in connector line collections
      *
-     * @param {IConnectorLineObject[]} collection .
+     * @param {IConnectorLineObject[]} collection  -Defines the CollectorLine collection.
      * @returns {void} .
      * @private
      */
@@ -1331,13 +1374,13 @@ export declare class Gantt extends Component<HTMLElement> implements INotifyProp
     protected renderTreeGrid(): void;
     private updateCurrentViewData;
     /**
-     * @param {IGanttData} records .
+     * @param {IGanttData} records -Defines the delete record collections.
      * @returns {IGanttData} .
      * @private
      */
     getRecordFromFlatdata(records: IGanttData[]): IGanttData[];
     /**
-     * @param {object} args .
+     * @param {object} args -Update the gantt element content height.
      * @returns {void} .
      * @private
      */
@@ -1407,8 +1450,8 @@ export declare class Gantt extends Component<HTMLElement> implements INotifyProp
     /**
      * Called internally, if any of the property value changed.
      *
-     * @param {GanttModel} newProp .
-     * @param {GanttModel} oldProp .
+     * @param {GanttModel} newProp - Defines the New GanttModel.
+     * @param {GanttModel} oldProp - Defines the old GanttModel.
      * @returns {void} .
      * @private
      */
@@ -1509,7 +1552,7 @@ export declare class Gantt extends Component<HTMLElement> implements INotifyProp
     removeSortColumn(columnName: string): void;
     /**
      *
-     * @param {object} args .
+     * @param {object} args -Defines the edited event args.
      * @returns {void} .
      * @private
      */
@@ -1547,8 +1590,8 @@ export declare class Gantt extends Component<HTMLElement> implements INotifyProp
     /**
      * Get parent task by clone parent item.
      *
-     * @param {IGanttData} ganttRecord .
-     * @param {number} level .
+     * @param {IGanttData} ganttRecord -Defines the Gantt record.
+     * @param {number} level -Defines the selected record level.
      * @returns {IGanttData} .
      * @hidden
      */
@@ -1625,7 +1668,7 @@ export declare class Gantt extends Component<HTMLElement> implements INotifyProp
     /**
      * To update timeline at start point with one unit.
      *
-     * @param {string} mode .
+     * @param {string} mode - Render previous span of Timeline.
      * @returns {void} .
      * @public
      */
@@ -1633,7 +1676,7 @@ export declare class Gantt extends Component<HTMLElement> implements INotifyProp
     /**
      * To update timeline at end point with one unit.
      *
-     * @param {string} mode .
+     * @param {string} mode - Render next span of Timeline.
      * @returns {void} .
      * @public
      */
@@ -1682,7 +1725,7 @@ export declare class Gantt extends Component<HTMLElement> implements INotifyProp
     /**
      * Method to clear edited collections in gantt set edit flag value
      *
-     * @param {boolean} isStart .
+     * @param {boolean} isStart -Defines whether to initiate edit action.
      * @returns {void} .
      * @private
      */
@@ -1775,8 +1818,8 @@ export declare class Gantt extends Component<HTMLElement> implements INotifyProp
     /**
      * To update existing taskId with new unique Id.
      *
-     * @param {number | string} currentId .
-     * @param {number | string} newId .
+     * @param {number | string} currentId - Defines the current Id of the record.
+     * @param {number | string} newId - Defines the new Id of the record.
      * @returns {void} .
      */
     updateTaskId(currentId: number | string, newId: number | string): void;
@@ -1841,9 +1884,9 @@ export declare class Gantt extends Component<HTMLElement> implements INotifyProp
     /**
      * Reorder the rows based on given indexes and position
      *
-     * @param {number[]} fromIndexes .
-     * @param {number} toIndex .
-     * @param {string} position .
+     * @param {number[]} fromIndexes - Defines the Dragged record index.
+     * @param {number} toIndex - Defines the Dropped record index.
+     * @param {string} position -Defines the position of the dropped row.
      * @returns {void} .
      */
     reorderRows(fromIndexes: number[], toIndex: number, position: string): void;
@@ -1931,7 +1974,7 @@ export declare class Gantt extends Component<HTMLElement> implements INotifyProp
     /**
      * Method to get class name for unscheduled tasks
      *
-     * @param {ITaskData} ganttProp .
+     * @param {ITaskData} ganttProp -Defines the Gantt propertie.
      * @returns {boolean} .
      * @private
      */
@@ -2113,7 +2156,7 @@ export declare class Gantt extends Component<HTMLElement> implements INotifyProp
     /**
      * To change the mode of a record.
      *
-     * @param {object} data .
+     * @param {object} data - Use to change the TaskMode either manual, auto or custom.
      * @returns {void} .
      */
     changeTaskMode(data: Object): void;