@syncfusion/ej2-gantt 19.4.56 → 20.1.47-1460716

package/dist/ts/gantt/models/column.ts

@@ -0,0 +1,464 @@
+import { NumberFormatOptions, DateFormatOptions, merge } from '@syncfusion/ej2-base';
+import { TextAlign, ClipMode, ValueAccessor, IEditCell, IFilter } from '@syncfusion/ej2-grids';
+import { IGanttCellFormatter } from '../base/interface';
+import { SortComparer} from '@syncfusion/ej2-grids';
+/**
+ * Configures column collection in Gantt.
+ */
+export class Column {
+    /**
+     * If `allowEditing` set to false, then it disables editing of a particular column.
+     * By default all columns are editable.
+     *
+     * @default true
+     */
+    public allowEditing: boolean = true;
+
+    /**
+     * If `allowReordering` set to false, then it disables reorder of a particular column.
+     * By default all columns can be reorder.
+     *
+     * @default true
+     */
+    public allowReordering: boolean = true;
+
+    /**
+     * If `allowResizing` is set to false, it disables resize option of a particular column.
+     * By default all the columns can be resized.
+     *
+     * @default true
+     */
+    public allowResizing: boolean = true;
+
+    /**
+     * If `allowSorting` set to false, then it disables sorting option of a particular column.
+     * By default all columns are sortable.
+     *
+     * @default true
+     */
+    public allowSorting: boolean = true;
+
+    /**
+     * If `allowFiltering` set to false, then it disables filtering option and filter bar element of a particular column.
+     * By default all columns are filterable.
+     *
+     * @default true
+     */
+    public allowFiltering: boolean = true;
+
+    /**
+     * It is used to customize the default filter options for a specific columns.
+     * * ui - to render custom component for specific column it has following functions.
+     * * ui.create – It is used for creating custom components.
+     * * ui.read -  It is used for read the value from the component.
+     * * ui.write - It is used to apply component model as dynamically.
+     *
+     * @default null
+     */
+    public filter: IFilter;
+
+    /**
+     * Defines the cell content's overflow mode. The available modes are
+     * * `Clip` -  Truncates the cell content when it overflows its area.
+     * * `Ellipsis` -  Displays ellipsis when the cell content overflows its area.
+     * * `EllipsisWithTooltip` - Displays ellipsis when the cell content overflows its area
+     * also it will display tooltip while hover on ellipsis applied cell.
+     *
+     * @default Syncfusion.EJ2.Grids.ClipMode.EllipsisWithTooltip
+     * @isEnumeration true
+     * @aspType Syncfusion.EJ2.Grids.ClipMode
+     */
+    public clipMode: ClipMode;
+
+    /**
+     * The CSS styles and attributes of the content cells of a particular column can be customized.
+     *
+     * @default null
+     */
+    public customAttributes: { [x: string]: Object };
+
+    /**
+     * If `disableHtmlEncode` is set to true, it encodes the HTML of the header and content cells.
+     *
+     * @default false
+     */
+    public disableHtmlEncode: boolean;
+
+    /**
+     * If `displayAsCheckBox` is set to true, it displays the column value as a check box instead of Boolean value.
+     *
+     * @default false
+     */
+    public displayAsCheckBox: boolean;
+
+    /**
+     * Defines the type of component for editing.
+     *
+     * @default 'stringedit'
+     */
+    public editType: string;
+                
+    /**
+     * Defines the custom sort comparer function.
+     */
+    public sortComparer: SortComparer | string;
+    
+    /**
+     * Defines the field name of column which is mapped with mapping name of DataSource.
+     * The `field` name must be a valid JavaScript identifier,
+     * the first character must be an alphabet and should not contain spaces and special characters.
+     */
+    public field: string;
+
+    /**
+     * It is used to change display value with the given format and does not affect the original data.
+     * Gets the format from the user which can be standard or custom
+     * [`number`](../../../common/internationalization/#number-formatting)
+     * and [`date`](../../../common/internationalization/#formatting) formats.
+     *
+     * @default null
+     * @aspType string
+     */
+    public format: string | NumberFormatOptions | DateFormatOptions;
+
+    /**
+     * Defines the method which is used to achieve custom formatting from an external function.
+     * This function triggers before rendering of each cell.
+     *
+     * @default null
+     */
+    public formatter: { new(): IGanttCellFormatter } | Function | IGanttCellFormatter;
+
+    /**
+     * Defines the header template as string or HTML element ID which is used to add customized element in the column header.
+     *
+     * @default null
+     */
+    public headerTemplate: string;
+
+    /**
+     * Defines the header text of column which is used to display in column header.
+     * If `headerText` is not defined, then field name value will be assigned to header text.
+     *
+     * @default null
+     */
+    public headerText: string;
+
+    /**
+     * Define the alignment of column header which is used to align the text of column header.
+     *
+     * @default Syncfusion.EJ2.Grids.TextAlign.Left
+     * @isEnumeration true
+     * @aspType Syncfusion.EJ2.Grids.TextAlign
+     */
+    public headerTextAlign: TextAlign;
+
+    /**
+     * Column visibility can change based on [`Media Queries`](http://cssmediaqueries.com/what-are-css-media-queries.html).
+     * `hideAtMedia` accepts only valid Media Queries.
+     *
+     * @default null
+     */
+    public hideAtMedia: string;
+
+    /**
+     * Defines the maximum width of the column in pixel or percentage, which will restrict resizing beyond this pixel or percentage.
+     *
+     * @default null
+     */
+    public maxWidth: string | number;
+
+    /**
+     * Defines the minimum width of the column in pixels or percentage.
+     *
+     * @default null
+     */
+    public minWidth: string | number;
+
+    /**
+     * Defines the column template that renders customized element in each cell of the column.
+     * It accepts either template string or HTML element ID.
+     *
+     * @default null
+     */
+    public template: string;
+
+    /**
+     * Defines the alignment of the column in both header and content cells.
+     *
+     * @default Syncfusion.EJ2.Grids.TextAlign.Left
+     * @isEnumeration true
+     * @aspType Syncfusion.EJ2.Grids.TextAlign
+     */
+    public textAlign: TextAlign;
+
+    /**
+     * Defines the method used to apply custom cell values from external function and display this on each cell rendered.
+     *
+     * @default null
+     */
+    public valueAccessor: ValueAccessor | string;
+
+    /**
+     * If `visible` is set to false, hides the particular column. By default, columns are displayed.
+     *
+     * @default true
+     */
+    public visible: boolean;
+
+    /**
+     * Defines the width of the column in pixels or percentage.
+     *
+     * @default null
+     */
+    public width: string | number;
+    /**
+     * If `isPrimaryKey` is set to true, considers this column as the primary key constraint.
+     *
+     * @default false
+     */
+    public isPrimaryKey: boolean;
+    /**
+     * Defines the `IEditCell` object to customize default edit cell.
+     *
+     * @default {}
+     */
+    public edit: IEditCell = {};
+
+    constructor(options: ColumnModel) {
+        merge(this, options);
+    }
+}
+
+/**
+ * Interface for a class GanttColumn
+ */
+export interface ColumnModel {
+    /**
+     * If `allowEditing` set to false, then it disables editing of a particular column.
+     * By default all columns are editable.
+     *
+     * @default true
+     */
+    allowEditing?: boolean;
+
+    /**
+     * If `allowReordering` set to false, then it disables reorder of a particular column.
+     * By default all columns can be reorder.
+     *
+     * @default true
+     */
+    allowReordering?: boolean;
+
+    /**
+     * If `allowResizing` is set to false, it disables resize option of a particular column.
+     * By default all the columns can be resized.
+     *
+     * @default true
+     */
+    allowResizing?: boolean;
+
+    /**
+     * If `allowSorting` set to false, then it disables sorting option of a particular column.
+     * By default all columns are sortable.
+     *
+     * @default true
+     */
+    allowSorting?: boolean;
+
+    /**
+     * If `allowFiltering` set to false, then it disables filtering option and filter bar element of a particular column.
+     * By default all columns are filterable.
+     *
+     * @default true
+     */
+    allowFiltering?: boolean;
+
+    /**
+     * It is used to customize the default filter options for a specific columns.
+     * * ui - to render custom component for specific column it has following functions.
+     * * ui.create – It is used for creating custom components.
+     * * ui.read -  It is used for read the value from the component.
+     * * ui.write - It is used to apply component model as dynamically.
+     *
+     * @default null
+     */
+    filter?: IFilter;
+
+    /**
+     * Defines the cell content's overflow mode. The available modes are
+     * * `Clip` -  Truncates the cell content when it overflows its area.
+     * * `Ellipsis` -  Displays ellipsis when the cell content overflows its area.
+     * * `EllipsisWithTooltip` - Displays ellipsis when the cell content overflows its area
+     * also it will display tooltip while hover on ellipsis applied cell.
+     *
+     * @default Syncfusion.EJ2.Grids.ClipMode.EllipsisWithTooltip
+     * @isEnumeration true
+     * @aspType Syncfusion.EJ2.Grids.ClipMode
+     */
+    clipMode?: ClipMode;
+
+    /**
+     * The CSS styles and attributes of the content cells of a particular column can be customized.
+     *
+     * @default null
+     */
+    customAttributes?: { [x: string]: Object };
+
+    /**
+     * If `disableHtmlEncode` is set to true, it encodes the HTML of the header and content cells.
+     *
+     * @default false
+     */
+    disableHtmlEncode?: boolean;
+
+    /**
+     * If `displayAsCheckBox` is set to true, it displays the column value as a check box instead of Boolean value.
+     *
+     * @default false
+     */
+    displayAsCheckBox?: boolean;
+
+    /**
+     * Defines the field name of column which is mapped with mapping name of DataSource.
+     * The `field` name must be a valid JavaScript identifier,
+     * the first character must be an alphabet and should not contain spaces and special characters.
+     *
+     * @default null
+     */
+    field?: string;
+
+    /**
+     * Defines the type of component for editing.
+     *
+     * @default 'stringedit'
+     */
+    editType?: string;
+
+    /**
+     * It is used to change display value with the given format and does not affect the original data.
+     * Gets the format from the user which can be standard or custom
+     * [`number`](../../../common/internationalization/#number-formatting)
+     * and [`date`](../../../common/internationalization/#formatting) formats.
+     *
+     * @default null
+     * @aspType string
+     */
+    format?: string | NumberFormatOptions | DateFormatOptions;
+
+    /**
+     * Defines the method which is used to achieve custom formatting from an external function.
+     * This function triggers before rendering of each cell.
+     *
+     * @default null
+     */
+    formatter?: { new(): IGanttCellFormatter } | Function | IGanttCellFormatter;
+
+    /**
+     * Defines the header template as string or HTML element ID which is used to add customized element in the column header.
+     *
+     * @default null
+     */
+    headerTemplate?: string;
+
+    /**
+     * Defines the header text of column which is used to display in column header.
+     * If `headerText` is not defined, then field name value will be assigned to header text.
+     *
+     * @default null
+     */
+    headerText?: string;
+
+    /**
+     * Define the alignment of column header which is used to align the text of column header.
+     *
+     * @default Syncfusion.EJ2.Grids.TextAlign.Left
+     * @isEnumeration true
+     * @aspType Syncfusion.EJ2.Grids.TextAlign
+     */
+    headerTextAlign?: TextAlign;
+
+    /**
+     * Column visibility can change based on [`Media Queries`](http://cssmediaqueries.com/what-are-css-media-queries.html).
+     * `hideAtMedia` accepts only valid Media Queries.
+     *
+     * @default null
+     */
+    hideAtMedia?: string;
+
+    /**
+     * Defines the maximum width of the column in pixel or percentage, which will restrict resizing beyond this pixel or percentage.
+     *
+     * @default null
+     */
+    maxWidth?: string | number;
+
+    /**
+     * Defines the minimum width of the column in pixels or percentage.
+     *
+     * @default null
+     */
+    minWidth?: string | number;
+
+    /**
+     * Defines the column template that renders customized element in each cell of the column.
+     * It accepts either template string or HTML element ID.
+     *
+     * @default null
+     */
+    template?: string;
+
+    /**
+     * Defines the alignment of the column in both header and content cells.
+     *
+     * @default Syncfusion.EJ2.Grids.TextAlign.Left
+     * @isEnumeration true
+     * @aspType Syncfusion.EJ2.Grids.TextAlign
+     */
+    textAlign?: TextAlign;
+
+    /**
+     * Defines the method used to apply custom cell values from external function and display this on each cell rendered.
+     *
+     * @default null
+     */
+    valueAccessor?: ValueAccessor | string;
+
+    /**
+     * If `visible` is set to false, hides the particular column. By default, columns are displayed.
+     *
+     * @default true
+     */
+    visible?: boolean;
+
+    /**
+     * Defines the width of the column in pixels or percentage.
+     *
+     * @default null
+     */
+    width?: string | number;
+    /**
+     * If `isPrimaryKey` is set to true, considers this column as the primary key constraint.
+     *
+     * @default false
+     */
+    isPrimaryKey?: boolean;
+    /**
+     * Defines the `IEditCell` object to customize default edit cell.
+     *
+     * @default {}
+     */
+    edit?: IEditCell;
+    /**
+     * To define column type.
+     *
+     * @private
+     */
+    type?: string;
+    /**
+     * Defines the sort comparer property.
+     *
+     * @default null
+     */
+     sortComparer?: SortComparer | string;
+}

package/dist/ts/gantt/models/day-working-time.ts

@@ -0,0 +1,22 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+
+/**
+ * Defines working time of day in project.
+ */
+
+export class DayWorkingTime extends ChildProperty<DayWorkingTime> {
+    /**
+     * Defines start time of working time range.
+     *
+     * @default null
+     */
+    @Property(null)
+    public from: number;
+    /**
+     * Defines end time of working time range.
+     *
+     * @default null
+     */
+    @Property(null)
+    public to: number;
+}

package/dist/ts/gantt/models/edit-dialog-field-settings.ts

@@ -0,0 +1,33 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+import { DialogFieldType } from '../base/enum';
+/**
+ * Defines dialog fields of edit dialog.
+ */
+export class EditDialogFieldSettings extends ChildProperty<EditDialogFieldSettings> {
+    /**
+     * Defines types of tab which contains editor for columns.
+     * * `General` - Defines tab container type as general.
+     * * `Dependency` - Defines tab as dependency editor.
+     * * `Resources` - Defines tab as resources editor.
+     * * `Notes` - Defines tab as notes editor.
+     * * `Custom` - Defines tab as custom column editor.
+     *
+     * @default null
+     */
+    @Property(null)
+    public type: DialogFieldType;
+    /**
+     * Defines header text of tab item.
+     *
+     * @default null
+     */
+    @Property(null)
+    public headerText: string;
+    /**
+     * Defines edited column fields placed inside the tab.
+     *
+     * @default null
+     */
+    @Property([])
+    public fields: string[];
+}

package/dist/ts/gantt/models/edit-settings.ts

@@ -0,0 +1,79 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+import { EditMode, RowPosition  } from '../base/enum';
+
+/**
+ * Configures edit settings of Gantt.
+ */
+export class EditSettings extends ChildProperty<EditSettings> {
+    /**
+     * If `allowEditing` is set to true, values can be updated in the existing record.
+     *
+     * @default false
+     */
+    @Property(false)
+    public allowEditing: boolean;
+
+    /**
+     * If `allowAdding` is set to true, new records can be added to the Gantt.
+     *
+     * @default false
+     */
+    @Property(false)
+    public allowAdding: boolean;
+
+    /**
+     * If `allowDeleting` is set to true, existing record can be deleted from the Gantt.
+     *
+     * @default false
+     */
+    @Property(false)
+    public allowDeleting: boolean;
+
+    /**
+     * Defines edit mode in Gantt.
+     * * `Auto` - Defines cell edit mode in grid side and dialog mode in chart side.
+     * * `Dialog` - Defines dialog edit mode on both sides.
+     *
+     * @default Auto
+     * @isEnumeration true
+     */
+    @Property('Auto')
+    public mode: EditMode;
+
+    /**
+     * Defines the row position for new records. The available row positions are:
+     * * Top
+     * * Bottom
+     * * Above
+     * * Below
+     * * Child
+     *
+     * @default Top
+     */
+    @Property('Top')
+    public newRowPosition: RowPosition;
+
+    /**
+     * If `showDeleteConfirmDialog` is set to true, confirm dialog will show delete action. You can also cancel delete command.
+     *
+     * @default false
+     */
+    @Property(false)
+    public showDeleteConfirmDialog: boolean;
+
+    /**
+     * Enabled or disables taskbar resizing, taskbar dragging, progress bar resizing and
+     * predecessor draw action in chart side.
+     *
+     * @default false
+     */
+    @Property(false)
+    public allowTaskbarEditing: boolean;
+    /**
+     * If `allowNextRowEdit` is set as true, editing is continued to next row with keyboard navigation.
+     *
+     * @default false
+     */
+    @Property(false)
+    public allowNextRowEdit : boolean;
+}

package/dist/ts/gantt/models/event-marker.ts

@@ -0,0 +1,27 @@
+import { Property, ChildProperty } from '@syncfusion/ej2-base';
+/**
+ * Defines event marker collection in Gantt.
+ */
+export class EventMarker extends ChildProperty<EventMarker> {
+    /**
+     * Defines day of event marker.
+     *
+     * @default null
+     */
+    @Property(null)
+    public day: Date | string;
+    /**
+     * Defines label of event marker.
+     *
+     * @default null
+     */
+    @Property(null)
+    public label: string;
+    /**
+     * Define custom css class for event marker to customize line and label.
+     *
+     * @default null
+     */
+    @Property(null)
+    public cssClass: string;
+}

package/dist/ts/gantt/models/filter-settings.ts

@@ -0,0 +1,53 @@
+import { Property, ChildProperty, Collection } from '@syncfusion/ej2-base';
+import { PredicateModel, Predicate, ICustomOptr } from '@syncfusion/ej2-grids';
+import { FilterType, FilterHierarchyMode } from '../base/enum';
+/**
+ * Configures the filtering behavior of the Gantt.
+ */
+export class FilterSettings extends ChildProperty<FilterSettings> {
+    /**
+     * Specifies the columns to be filtered at initial rendering of the Gantt.
+     * You can also get the columns that were currently filtered.
+     *
+     * @default []
+     */
+    @Collection<PredicateModel[]>([], Predicate)
+    public columns: PredicateModel[];
+
+    /**
+     * Defines filter type of Gantt.
+     * * `Menu` - Enables menu filters in Grid.
+     *
+     * @hidden
+     */
+    @Property('Menu')
+    public type: FilterType;
+
+    /**
+     * The `operators` is used to override the default operators in filter menu. This should be defined by type wise
+     * (string, number, date and boolean). Based on the column type, this customize operator list will render in filter menu.
+     *
+     * @default null
+     */
+    @Property()
+    public operators: ICustomOptr;
+    /**
+     * If ignoreAccent set to true, then filter ignores the diacritic characters or accents while filtering.
+     *
+     * @default false
+     */
+    @Property(false)
+    public ignoreAccent: boolean;
+    /**
+     * Defines the filter types. The available options are,
+     * `Parent`: Shows the filtered record with parent record.
+     * `Child`: Shows the filtered record with child record.
+     * `Both` : shows the filtered record with both parent and child record.
+     * `None` : Shows only filtered record.
+     *
+     * @default Parent
+     * @isEnumeration true
+     */
+    @Property('Parent')
+    public hierarchyMode: FilterHierarchyMode;
+}