smart-webcomponents

import {BaseElement, Animation} from "./smart.element" export interface GanttChartProperties { /** * Determines whether nonworkingDays/nonworkingHours are taken into considuration when determining the dateEnd of the tasks. When this property is enabled the dateEnd of the tasks is calculated to include only the actual working time. By default it's disabled and only calendar time is used. * Default value: false */ adjustToNonworkingTime?: boolean; /** * Recalculates the tasks that are connected and re-schedules them according to their connections. If no connections are present, autoScheduling has no effect until a connection is created. Connection types determines the start/end date limits of the tasks. * Default value: false */ autoSchedule?: boolean; /** * Affects the tasks only when autoSchedule is enabled. When set to true, the tasks are strictly scheduled ( according to their connections ) and dragging is not allowed. Users can set lag to specific connections to determine a delay of overlap of between the two tasks ( interval of time in miliseconds ). Lag one of the attributes of a task connection and should be set in the dataSource where the task connections are defined. * Default value: false */ autoScheduleStrictMode?: boolean; /** * Determines the scroll speed when dragging when autoScroll property is set. * Default value: 5 */ autoScrollStep?: number; /** * Enabled/Disables the colummn header menu. When enabled and the user hovers a column header, a drop down button will appear that triggers a column menu for quick actions like sorting, filtering, etc. The actions depend on the enabled Gantt features, for example the filtering action will be available only if filtering is enabled for the element. * Default value: false */ columnMenu?: boolean; /** * Determines whether the Table columns are resizable or not. When enabled it is possible to resize the columns from the header cells of the Table in both Task and Resource timelines. * Default value: false */ columnResize?: boolean; /** * Determines resize feedback is used during column resizing. This property is applicable only when columnResize is enabled. * Default value: false */ columnResizeFeedback?: boolean; /** * Gantt's current time. By default it is the today's date. * Default value: */ currentTime?: string | Date; /** * Enables/Disables the current time indicator. Current time indicator shows the current time in the appropriate view cells. * Default value: false */ currentTimeIndicator?: boolean; /** * Determines the refresh interval in seconds for the currentTimeIndicator. * Default value: 1 */ currentTimeIndicatorInterval?: number; /** * Sets the GanttChart's Data Export options. * Default value: [object Object] */ dataExport?: GanttChartDataExport; /** * Determines the tasks that will be loaded inside the Timeline. Each item represents an object that should contain the following properties: label - the label of the TaskdateStart - the starting date of the Task. Should be a string representing a valid date.dateEnd - the ending date of the Task. Should be a string representing a valid date.type - determines the type of the task. Whether it's a simple task, a project or a milestone. Each type of task has specific behavior and additional attributes.. Additional properties: connections - an array of objects representing the connection between two tasks. Each connection (object) should have the following properties : target - a number representing the index of the target tasktype - a number representing the type of the connection. Four types of connections are available: 0 - is a connection of type Start-to-Start 1 - is a connection of type End-to-Start 2 - is a connection of type End-to-End3 - is a connection of type Start-to-End lag - a number that determines the delay between two connected auto scheduled tasks. Lag property can be a positive or a negative number. When negative it determines the overlap between two connected tasks. This property is used in conjuction with autoSchedule.duration - determines the duration of a Task in days, hours, minutes, seconds or miliseconds. Very usefull when the the dateEnd of a Task is unknown. The duration always shows the calendar time whether it is in days/hours or other.minDuration - sets the minimum duration of a task. maxDuration - sets the maximum duration of a task.minDateStart - determines the mininum date that a task can start from. Must be if type string and should represent a valid date.maxDateStart - determines the maximum date that a task can start from. Must be if type string and should represent a valid date.minDateEnd - determines the mininum date that a task can end. Must be if type string and should represent a valid date.maxDateEnd - determines the maximum date that a task can end. Must be if type string and should represent a valid date.progress - a number that determines the progress of a task ( from 0 to 100 ).overdue - a boolean that indicates whether the task's dateEnd has surpassed it's deadline date.disableDrag - a boolean property that disables the dragging of a task when set to true.disableResize - a boolean property that disables the resizing of a task when set to true.dragProject - a boolean that determines whether or not the whole project (along with the tasks) can be dragged while dragging the project task. Applicalbe only to Projects.segments - an array of objects that allows to devide a task into multiple segements. Each segment (except the first) can have a different starting date, duration and label.synchronized - a boolean that if set the project task's start/end dates are automatically calculated based on the tasks. By default a synchronized project task can't be dragged alone. Applicable only to Project tasks.expanded - a boolean that determines if a project is expanded or not. If not all of it's sub-tasks are not visible. Only the project task itself is visible. By default no projects are expanded. Applicable only to project tasks..GanttChart also accepts a DataAdapter instance as dataSource. You can read more about the dataAdapter here - https://www.htmlelements.com/docs/data-adapter/. * Default value: */ dataSource?: any; /** * Determines the format of the dates in the timeline header when they represent days. * Default value: short */ dayFormat?: GanttDayFormat | string; /** * Determines a specific end date for the Timeline. Usefull when the user wants custom ending date for the Timeline. If no date is set the end date of the timeline is automatically determined from the tasks. * Default value: */ dateEnd?: string | Date; /** * Determines a specific starting date for the Timeline. Usefull when the user wants custom starting date for the Timeline. If no date is set the start date of the timeline is automatically determined from the tasks. * Default value: */ dateStart?: string | Date; /** * Determines the date markers that will be displayed inside the timeline. Date markers allow to mark and even label specific dates (including time) inside the GanttChart timeline. * Default value: null */ dateMarkers?: GanttChartDateMarker[]; /** * Enables or disables the element. * Default value: false */ disabled?: boolean; /** * Disables auto scrolling while dragging/resizing a task bar inside the Timeline. * Default value: false */ disableAutoScroll?: boolean; /** * Disables dragging of tasks in the Timeline. * Default value: false */ disableTaskDrag?: boolean; /** * Disables task progress changing in the Timeline. * Default value: false */ disableTaskProgressChange?: boolean; /** * Disables resizing of tasks in the Timeline. * Default value: false */ disableTaskResize?: boolean; /** * Disables the selection inside the GanttChart. * Default value: false */ disableSelection?: boolean; /** * Disables the task segment dragging. * Default value: false */ disableSegmentDrag?: boolean; /** * Disables the task segment resizing. * Default value: false */ disableSegmentResize?: boolean; /** * Disables the window editor for the GanttChart. * Default value: false */ disableWindowEditor?: boolean; /** * Determines in what unit is task duration property measured. * Default value: milisecond */ durationUnit?: Duration | string; /** * Determines whether a dedicated filter row is used for Table filtering instead of the default filter input. This property has no effect if filtering is not enabled. * Default value: false */ filterRow?: boolean; /** * Determines the view start day. Sunday is 0, Monday is 1, Saturday is 6. By default it's Sunday. * Default value: -1 */ firstDayOfWeek?: number; /** * Groups the tasks inside the Task timeline according to the resources they are assigned to. Unassigned tasks are placed in a default group labeled 'Unassigned'. * Default value: false */ groupByResources?: boolean; /** * Allows to create a custom header content for the Task Panel. The attribute accepts an HTMLTemplate element, it's id or a function. * Default value: null */ headerTemplate?: any; /** * Determines whether the dateMarkers are visible or not. * Default value: false */ hideDateMarkers?: boolean; /** * By default the Timeline has a three level header - timeline details, timeline second details and timeline header. This property hides the header container( the bottom container ). * Default value: false */ hideTimelineHeader?: boolean; /** * By default the Timeline has a three level header - timeline details, timeline second details and timeline header. This property hides the header details container( the top container ). * Default value: false */ hideTimelineHeaderDetails?: boolean; /** * By default the Timeline has a three level header - timeline details and timeline header. This property hides the second header details container( the middle container ). * Default value: true */ hideTimelineSecondHeaderDetails?: boolean; /** * Hides the Resource panel regardless of the resources availability By default the Resource panel is visible if resources are added to the GanttChart. This property allows to hide the Resource panel permanently. * Default value: false */ hideResourcePanel?: boolean; /** * Determines weather or not horizontal scrollbar is shown. * Default value: auto */ horizontalScrollBarVisibility?: HorizontalScrollBarVisibility | string; /** * Determines the format of the dates inside the timeline header when they represent hours. * Default value: numeric */ hourFormat?: HourFormat | string; /** * When enabled, scrolling to the end of the horizotal timeline, triggers the creation of additional to extend the time range. The number of cells to be added when the scrollbar reaches the end position is determined by the infiniteTimelineStep. * Default value: false */ infiniteTimeline?: boolean; /** * Determines the number of cells to be added when the horizontal scroll bar of the Timeline reaches it's end position when infiniteTimeline is enabled. * Default value: 5 */ infiniteTimelineStep?: number; /** * When set the Timeline is positioned on the left side while the Task Tree is positioned on the right. By default it's vice versa. * Default value: false */ inverted?: boolean; /** * Determines whether keyboard navigation inside the Table is enabled or not. Keyboard navigation affects both Task and Resource Tables. It allows to navigate between items. the following keyboard shortcut keys are available for focused tasks inside the Task Table: Enter - opens the Window editor to edit the currently focused task.Delete - opens a confirmation window regarding the deletion of the currently focused task. * Default value: false */ keyboardNavigation?: boolean; /** * Sets or gets the unlockKey which unlocks the product. * Default value: "" */ unlockKey?: string; /** * Determines the language of the GanttChart. * Default value: "en" */ locale?: string; /** * Detetmines the maximum possible date of the Timeline. * Default value: 2100-1-1 */ max?: string | Date; /** * Detetmines the minimum possible date of the Timeline. * Default value: 1900-1-1 */ min?: string | Date; /** * Sets or gets an object specifying strings used in the widget that can be localized. Used in conjunction with the property locale. * Default value: * [object Object] */ messages?: any; /** * Determines the format of the dates the timeline header when they represent months. * Default value: short */ monthFormat?: MonthFormat | string; /** * Determines the scale in Month view. * Default value: week */ monthScale?: MonthScale | string; /** * Determines the nonworking days of the week from 0 to 6, where 0 is the first day of the week and 6 is the last day. Nonworking days will be displayed with colored cells inside the timeline and will not affect the dateEnd of the tasks unless the adjustToNonworkingTime property is enabled. * Default value: */ nonworkingDays?: number[]; /** * Determines the nonworking hours of a day. Hours are represented as numbers inside an array (e.g. [1,2,3] - means 1,2 and 3 AM) or number ranges represented as nested arrays(e.g. [[0,6]] - means from 0 to 6 AM). In the timline the cells that represent nonworking days are colored differently from the rest and will not affect the dateEnd of the tasks unless the adjustToNonworkingTime property is enabled. * Default value: */ nonworkingHours?: number[] | number[][]; /** * A function that can be used to completly customize the task element. The function has five arguments: task - the task object.segment - the task current segment object. If the task has only one segment, the task object is passed again.taskElement - the task's html element.segmentElement - the task's segment html element.labelElement - the task's segment label html element. * Default value: null */ onTaskRender?: any; /** * A function that can be used to completly customize the task element. The function has two arguments: task - the task object.taskElement - the task's html element. * Default value: null */ taskFormatFunction?: any; /** * A function that can be used to completly customize the tooltip. The function has three arguments: tooltipObject - the tooltip object.event - the event that triggered the tooltip.content - the tooltip's label element. * Default value: null */ tooltipFormatFunction?: any; /** * A function that can be used to completly customize the popup Window that is used to interact width tasks by changing their properties. The function as three arguments: target - the target popup Window that is about to be opened.type - the type of the window. The type determines the purpose of the window. Three possible values: 'task' (task editing), 'confirm' ( confirmation window), 'connection' (used when deleting a connection between tasks). item - the connection/task object that is the target of the window. * Default value: null */ popupWindowCustomizationFunction?: any; /** * Determines which Tab items are visible inside the popup window. Three possible values are allowed: general - the general tab with task properties determines by the taskColumns property.dependency - the dependency tab which shows the connections to the task and allows to create/delete connections.segments - the segments tab which shows the segments of the task and allows to created/delete segments.. * Default value: ['general', 'dependency', 'segments'] */ popupWindowTabs?: string[]; /** * A format function for the Timeline task progress label. The expected result from the function is a string. The label is hidden by default can be shown with the showProgressLabel property. * Default value: null */ progressLabelFormatFunction?: any; /** * Determines the format of the dates the timeline header when they represent quarters. * Default value: short */ quarterFormat?: QuarterFormat | string; /** * A getter that returns a flat structure as an array of all resources inside the element. * Default value: null */ resources?: GanttChartResource[]; /** * Deteremines the columns that will be visible in the Resource Tree. Each entry in the value of this property must be of type Object. It should contain the label and value keys. The value of label determines the column header label inside the Task Tree. The value of value determines the content of the cells in the column. By default, one column with all resource labels is visible. Additional properties: formatFunction - a function that allows to customize the content of each record in the column. The function accepts two arguments - the actual label as string that is going to be inserted and the index of the resource. The function must return a string as the new content. min - controls the min size of the column max - controls the max size of the columnsize - controls the actual size of the column * Default value: { "label": "resourceColumnLabel", "value": "label" } */ resourceColumns?: GanttChartResourceColumn[]; /** * Determines whether the Resource Table is filterable or not. * Default value: false */ resourceFiltering?: boolean; /** * A format function that allows to re-format the group row labels when groupByResources is enabled. * Default value: null */ resourceGroupFormatFunction?: any; /** * Allows to create a custom header content for the Resource Panel. The attribute accepts an HTMLTemplate element, it's id or a function. * Default value: null */ resourcePanelHeaderTemplate?: any; /** * Determines the min size of the Resource Panel. * Default value: 100 */ resourcePanelMin?: number | string; /** * Determines the size of the Resource Panel. * Default value: */ resourcePanelSize?: number | string; /** * Determines the refresh rate of the Resource Panel when dragging/resizing/progress changing a Task from the Timeline. This property allows to customize the interval between resource Tree/Timeline refreshes. By default they refresh immediately after a change. * Default value: 0 */ resourcePanelRefreshRate?: number; /** * A callback that can be used to customize the content of the resource Timeline cells. The callback accepts three arguments: taskIndexes - an array of task indexes that are assigned to the resource for the current cell.resourceIndex - the index of the resource.cellDate - the date of the current cell. This property is used when resourceTimelineView is set to custom. Depending on the resourceTimelineMode, it should return: string - when the resourceTimelineMode is set to 'diagram'.object - when the resourceTimelineMode is set to 'histogram'. The object should have two attributes: capacity and maxCapacity, in order to be visualized as a histogram.. Another usage of this callback is to customize the timeline resource representation completely if resourceTimelineMode is set to custom. * Default value: null */ resourceTimelineFormatFunction?: any; /** * Determines how the capacity of the resources will be visualized inside the resource timeline. By default, the capacity is measured in hours depending on the view property of the element. * Default value: diagram */ resourceTimelineMode?: GanttChartResourceTimelineMode | string; /** * Determines how the resources will be displayed inside the resource Timeline. * Default value: hours */ resourceTimelineView?: GanttChartResourceTimelineView | string; /** * Sets or gets the value indicating whether the element is aligned to support locales using right-to-left fonts. * Default value: false */ rightToLeft?: boolean; /** * Sets which tasks to select by their id or gets the currently selected task ids. If no id is provided for the task, an internal id is generated for each task according to it's index(tree path). * Default value: */ selectedTaskIds?: number[] | string[]; /** * Sets which resources to select by their id or gets the currently selected resource ids. If no id is provided for the resource, an internal id is generated for each resource according to it's index(tree path). * Default value: */ selectedResourceIds?: number[] | string[]; /** * Sets or gets the selection mode. Only applicable when selection is enabled. * Default value: many */ selectionMode?: GanttChartSelectionMode | string; /** * Enables/Disables the current time shader. If enabled all cells that represent past time will be shaded. * Default value: false */ shadeUntilCurrentTime?: boolean; /** * Shows the selection column of the Task/Resource Table. When applied a checkbox column is displayed that allows to select tasks/resources. * Default value: false */ showSelectionColumn?: boolean; /** * Determines whether the baselnes of the tasks are visible or not. Baselines are defined via the 'planned' attribute on the task objects of the dataSource property. * Default value: false */ showBaseline?: boolean; /** * Shows the progress label inside the progress bars of the Timeline tasks. * Default value: false */ showProgressLabel?: boolean; /** * If set the dateStart/dateEnd of the tasks will be coerced to the nearest timeline cell date ( according to the view ). Affects the dragging operation as well. * Default value: false */ snapToNearest?: boolean; /** * Allows to set a custom sorting function to be executed when a column is sorted. Can be used to override the default sorting behavior. The function contains the following parameters: dataSource - the Table's data sourcesortColumns - an array of the data fields of columns to be sorted bydirections - an array of sort directions to be sorted by (corresponding to sortColumns)defaultCompareFunctions - an array of default compare functions to be sorted by (corresponding to sortColumns), useful if the sorting of some columns does not have to be overridden. * Default value: null */ sortFunction?: { (dataSource: any, sortColumns: string[], directions: string[], defaultCompareFunctions: { (firstRecord: any, secondRecord: any): number }[]): void }; /** * Determines whether the GanttChart can be sorted by one, more then one or no columns. * Default value: none */ sortMode?: GanttChartSortMode | string; /** * A getter that returns a flat structure as an array of all tasks inside the element. * Default value: */ tasks?: GanttChartTask[]; /** * Deteremines the columns that will be visible in the Task Tree. Each entry in the value of this property must be of type Object. It should contain the label and value keys. The value of label determines the column header label inside the Task Tree. The value of value determines the content of the cells in the column. It should reference a task attribute from the dataSource. By default, one column with all task labels is visible. Additional properties: formatFunction - a function that allows to customize the content of each record in the column. The function accepts one argument - the actual label as string that is going to be inserted and must return some content. min - controls the min size of the column max - controls the max size of the column size - controls the actual size of the columncustomEditor - a callback that can be used to set a custom editor for the column when editing via the window. It accepts two arguments label - the label of the columnvalue - the value of the column. The callback must return the editor.setCustomEditorValue - a callback that is used to set the value of the custom editor.getCustomEditorValue - a callback that is used to get the value of the custom editor. * Default value: { "label": "Task Name", "value": "label" } */ taskColumns?: GanttChartTaskColumn[]; /** * Determines whether the Task Table is filterable or not. * Default value: false */ taskFiltering?: boolean; /** * Determines the min size of the Task Panel. Used when Resource Panel is visible. * Default value: 200 */ taskPanelMin?: string | number; /** * Determines the size of the Task Panel. Used when Resource Panel is visible. * Default value: */ taskPanelSize?: string | number; /** * Determines the min width of the timeline. * Default value: 200 */ timelineMin?: string | number; /** * Determines the min width of the task table. * Default value: 100 */ treeMin?: string | number; /** * Determines the size(width) of the task table. * Default value: 100 */ treeSize?: string | number; /** * A format function for the Header of the Timeline. The function provides the following arguments: date - a Date object that represets the date for the current cell.type - a string that represents the type of date that the cell is showing, e.g. 'month', 'week', 'day', etc.isHeaderDetails - a boolean that indicates whether the current cell is part of the Header Details Container or not.value - a string that represents the default value for the cell provided by the element. * Default value: null */ timelineHeaderFormatFunction?: any; /** * Determines whether the tooltips are enabled or not. Tooltips are available for timeline tasks, resources, connections, indicators and segments. * Default value: [object Object] */ tooltip?: GanttChartTooltip; /** * Determines weather or not vertical scrollbar is shown. * Default value: auto */ verticalScrollBarVisibility?: VerticalScrollBarVisibility | string; /** * Determines the viewing date range of the timeline. Possible values: day - The timeline show the hours of the day.week - the timeline shows the days of the week.month - the timeline shows the days of the month.year - the timeline shows the months of the year.resource - displays the current tasks by grouping them according to the resources they have assigned. The unassigned tasks will be placed in a separate group called 'Unassigned'. The timeline has a header section that contains the labels of each cell according to the date inside them. The header is splitted in two sections in order to give a more detailed information of the dates. * Default value: year */ view?: GanttChartView | string; /** * Determines the format of the dates inside the timeline header when they represent years. * Default value: numeric */ yearFormat?: YearFormat | string; /** * Determines the format of the dates inside the timeline header when they represent weeks. * Default value: long */ weekFormat?: WeekFormat | string; /** * Sets or gets the element's visual theme. * Default value: "" */ theme?: string; /** * Sets or gets if the element can be focused. * Default value: false */ unfocusable?: boolean; } /** Gantt charts are specialized bar charts that help clearly represent how tasks and resources are allocated over time in planning, project management, and scheduling applications. */ export interface GanttChart extends BaseElement, GanttChartProperties { /* Get a member by its name */ [name: string]: any; /** * This event is triggered when a batch update was started after executing the beginUpdate method. * @param event. The custom event. */ onBeginUpdate?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when a batch update was ended from after executing the endUpdate method. * @param event. The custom event. */ onEndUpdate?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the user starts connecting one task to another. This event allows to cancel the operation by calling event.preventDefault() in the event handler function. * @param event. The custom event. Custom data event was created with: ev.detail(startIndex) * startIndex - The index of the task that a connection is started from. */ onConnectionStart?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the user completes a connection between two tasks. * @param event. The custom event. Custom data event was created with: ev.detail(id, startTaskId, startIndex, endIndex, endTaskId, type) * id - The id of the connection that was created. * startTaskId - The id of the task that a connection is started from. * startIndex - The index of the task that a connection is started from. * endIndex - The index of the task that a connection ended to. * endTaskId - The id of the task that a connection ended to. * type - The type of connection. Fours types are available: <ul><li>0 - start-to-start</li><li>1 - end-to-start</li><li>2 - end-to-end</li><li>3 - start-to-end</li></ul> */ onConnectionEnd?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when a Task is selected/unselected. * @param event. The custom event. Custom data event was created with: ev.detail(value, oldValue) * value - The index of the new selected task. * oldValue - The index of the previously selected task. */ onChange: ((this: any, ev: Event) => any) | null; /** * This event is triggered when a Tree column is resized. Column resizing is controled by the columnResize property. * @param event. The custom event. Custom data event was created with: ev.detail(dataField, headerCellElement, widthInPercentages, width) * dataField - The name of the column. Corresponds to the value attribute of a taskColumns/resourceColumns object. * headerCellElement - The HTMLElement column cell element that was resized. * widthInPercentages - The new width of the column in percentages. * width - The new width of the column in pixels. */ onColumnResize?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered just before the window for task editing or tooltip is closing. The closing operation can be canceled by calling event.preventDefault() in the event handler function. * @param event. The custom event. Custom data event was created with: ev.detail(owner, item, target, type) * owner - The HTMLElement that is the owner of the tooltip. This attribute is defined only when the event is related to the tooltip. * item - The item object that is related to the tooltip owner. It can be a task/segment/resource/indicator object. This attribute is defined only when the event is related to the tooltip. * target - The instance of the window/tooltip that is going to close. * type - The type of window/tooltip that is going to close. There are three types of windows inside GanttChart: <ul><li>confirm - a confirm window. This type of window is usually used to confirm the deletion of a task.</li><li>task - a window used for task editing.</li><li>connection - a window used to delete a connection.</li></ul>. If the event is a tooltip event, there are several tooltip types: <ul><li>indicator - when the tooltip owner is an indicator.</li><li>segment - when the tooltip owner is a task segment.</li><li>task - when the tooltip owner is a task.</li><li>resource - when the tooltip target is a resource.</li></ul> */ onClosing?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the window for task editing is closed( hidden ) * @param event. The custom event. Custom data event was created with: ev.detail(owner, item, target, type) * owner - The HTMLElement that is the owner of the tooltip. This attribute is defined only when the event is related to the tooltip * item - The item object that is related to the tooltip owner. It can be a task/segment/resource/indicator object. This attribute is defined only when the event is related to the tooltip. * target - The instance of the window/tooltip that is closed. * type - The type of window/tooltip that is closed. There are three types of windows inside GanttChart: <ul><li>confirm - a confirm window. This type of window is usually used to confirm the deletion of a task.</li><li>task - a window used for task editing.</li><li>connection - a window used to delete a connection.</li></ul>. If the event is a tooltip event, there are several tooltip types: <ul><li>indicator - when the tooltip owner is an indicator.</li><li>segment - when the tooltip owner is a task segment.</li><li>task - when the tooltip owner is a task.</li><li>resource - when the tooltip target is a resource.</li></ul> */ onClose: ((this: any, ev: Event) => any) | null; /** * This event is triggered when an item is collapsed. * @param event. The custom event. Custom data event was created with: ev.detail(isGroup, item, index, label, value) * isGroup - A boolean flag indicating whether the collapsed item is a resource group. This is the case when groupByResoruces is enabled. * item - The object details of the collapsed item. * index - The index of the collapsed item. * label - The label of the collapsed item. * value - The value of the collapsed item. */ onCollapse?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when dragging of a task starts. This event allows to cancel the operation by calling event.preventDefault() in the event handler function. * @param event. The custom event. Custom data event was created with: ev.detail(id, item, dateStart, dateEnd, segment) * id - The id of the task that is going to be dragged. * item - The object of the task that is going to be dragged. * dateStart - The start date of the task that is going to be dragged. * dateEnd - The end date of the task that is going to be dragged. * segment - The segment object that is going to be dragged. This attribute is undefined if a segment is not going to be dragged. */ onDragStart: ((this: any, ev: Event) => any) | null; /** * This event is triggered when dragging of a task finishes. * @param event. The custom event. Custom data event was created with: ev.detail(id, item, dateStart, dateEnd, segment) * id - The id of the task that is was dragged. * item - The object of the task that is was dragged. * dateStart - The start date of the task that is was dragged. * dateEnd - The end date of the task that is was dragged. * segment - The segment object that was dragged. This attribute is undefined if a segment has not been dragged. */ onDragEnd: ((this: any, ev: Event) => any) | null; /** * This event is triggered when an item is expanded. * @param event. The custom event. Custom data event was created with: ev.detail(isGroup, item, index, label, value) * isGroup - A boolean flag indicating whether the collapsed item is a resource group. This is the case when groupByResoruces is enabled. * item - The index of the expanded item. * index - The index of the expanded item. * label - The label of the expanded item. * value - The value of the expanded item. */ onExpand?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the GanttChart is filtered. * @param event. The custom event. Custom data event was created with: ev.detail(type, action, filters) * type - The type of items that have been filtered ( task or resource ). * action - The name of the filtering action (whether filtering is added or removed). * filters - The filters that have been applied. Filters represent JQX.Utilities.FilterGroup objects. */ onFilter?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when a task, resource or connection is clicked inside the Timeline or the Tree columns. * @param event. The custom event. Custom data event was created with: ev.detail(id, item, type, originalEvent) * id - The id of the task. * item - The item that was clicked. It can be a task, resource or connection. * type - The type of item. Possible values are: 'task', 'project', 'resource', 'connection'. * originalEvent - The original DOM event. */ onItemClick?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when a Task/Resource/Connection is inserted. * @param event. The custom event. Custom data event was created with: ev.detail(type, item) * type - The type of item that has been modified. The type could be: 'connection', 'task', 'project', 'resource'. * item - An object that represents the actual item with it's attributes. */ onItemInsert?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when a Task/Resource/Connection is removed. * @param event. The custom event. Custom data event was created with: ev.detail(id, type, item) * id - The id of the task. * type - The type of item that has been modified. The type could be: 'connection', 'task', 'project', 'resource'. * item - An object that represents the actual item with it's attributes. */ onItemRemove?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when a Task/Resource/Connection is updated. * @param event. The custom event. Custom data event was created with: ev.detail(id, type, item) * id - The id of the task. * type - The type of item that has been modified. The type could be: 'connection', 'task', 'project', 'resource'. * item - An object that represents the actual item with it's attributes. */ onItemUpdate?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered just before the window for task editing or tooltip is opening. The opening operation can be canceled by calling event.preventDefault() in the event handler function. * @param event. The custom event. Custom data event was created with: ev.detail(owner, item, target, type) * owner - The HTMLElement that is the owner of the tooltip. This attribute is defined only when the event is related to the tooltip * item - The item object that is related to the tooltip owner. It can be a task/segment/resource/indicator object. This attribute is defined only when the event is related to the tooltip. * target - The instance of the window/tooltip that is going to open. * type - The type of window/tooltip that is going to open. There are three types of windows inside GanttChart: <ul><li>confirm - a confirm window. This type of window is usually used to confirm the deletion of a task.</li><li>task - a window used for task editing.</li><li>connection - a window used to delete a connection.</li></ul>. If the event is a tooltip event, there are several tooltip types: <ul><li>indicator - when the tooltip owner is an indicator.</li><li>segment - when the tooltip owner is a task segment.</li><li>task - when the tooltip owner is a task.</li><li>resource - when the tooltip target is a resource.</li></ul> */ onOpening?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the window for task editing is opened( visible ) or when the tooltip is opened. * @param event. The custom event. Custom data event was created with: ev.detail(owner, item, target, type) * owner - The HTMLElement that is the owner of the tooltip. This attribute is defined only when the event is related to the tooltip * item - The item object that is related to the tooltip owner. It can be a task/segment/resource/indicator object. This attribute is defined only when the event is related to the tooltip. * target - The instance of the window/tooltip that is opened. * type - The type of window/tooltip that is opened. There are three types of windows inside GanttChart: <ul><li>confirm - a confirm window. This type of window is usually used to confirm the deletion of a task.</li><li>task - a window used for task editing.</li><li>connection - a window used to delete a connection.</li></ul>. If the event is a tooltip event, there are several tooltip types: <ul><li>indicator - when the tooltip owner is an indicator.</li><li>segment - when the tooltip owner is a task segment.</li><li>task - when the tooltip owner is a task.</li><li>resource - when the tooltip target is a resource.</li></ul> */ onOpen?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the progress of a task bar starts to change as a result of user interaction. This event allows to cancel the operation by calling event.preventDefault() in the event handler function. * @param event. The custom event. Custom data event was created with: ev.detail(id, index, progress) * id - The id of the task. * index - The index of the task which progress is going to be changed. * progress - The progress of the task before it is changed. */ onProgressChangeStart?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the progress of a task is changed. * @param event. The custom event. Custom data event was created with: ev.detail(id, index, progress) * id - The id of the task. * index - The index of the task which progress is has been changed. * progress - The progress of the task after it was changed. */ onProgressChangeEnd?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when resizing of a task starts. This event allows to cancel the operation by calling event.preventDefault() in the event handler function. * @param event. The custom event. Custom data event was created with: ev.detail(id, item, dateStart, dateEnd, segment) * id - The id of the task that is going to be resized. * item - The object of the task that is going to be resized. * dateStart - The start date of the task that is going to be resized. * dateEnd - The end date of the task that is going to be resized. * segment - The segment object that is going to be resized. This attribute is undefined if a segment is not going to be resized. */ onResizeStart?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the resizing of a task finishes. * @param event. The custom event. Custom data event was created with: ev.detail(id, item, dateStart, dateEnd, segment) * id - The id of the task that was resized. * item - The object of the task that was resized. * dateStart - The start date of the task that was resized. * dateEnd - The end date of the task that was resized. * segment - The segment object that was resized. This attribute is undefined if a segment has not been resized. */ onResizeEnd?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the GanttChart is sorted by some column. * @param event. The custom event. Custom data event was created with: ev.detail(type, columns, sortDataFields, sortOrders, sortDataTypes) * type - The type of columns that have been sorted ( task or resource column ). * columns - An array of objects that contains the currently sorted column objects. * sortDataFields - The dataFields of the columns that have been sorted. The dataField corresponds to the value property of a taskColumns/resourceColumns object. * sortOrders - The orders of the columns that have been sorted. * sortDataTypes - The data types of the columns that have been sorted. */ onSort?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the Timeline has been scrolled to the bottom. * @param event. The custom event. */ onScrollBottomReached?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the Timeline has been scrolled to the top. * @param event. The custom event. */ onScrollTopReached?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the Timeline has been scrolled to the beginning (horizontally). * @param event. The custom event. */ onScrollLeftReached?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * This event is triggered when the Timeline has been scrolled to the end (horizontally). * @param event. The custom event. */ onScrollRightReached?: ((this: any, ev: Event) => any) | ((this: any, ev: CustomEvent<any>) => any) | null; /** * Adds a custom filter to a specific column (task or resource column). * @param {any} columns. An object or an array of objects with the following syntax: <ul><li>type - indicates the type of column to filter. Possible values are 'task' or 'resource'.</li><li>value - the value of the column that must match the value attribute of a taskColumns/resourceColumns object(e.g. 'label', 'dateStart', etc).</li></ul>. * @param {any} filterGroup. A Smart.Utilities.FilterGroup object. Here's an example for creating a FilterGroup object: <pre>const filterGroup = new window.Smart.Utilities.FilterGroup(), filterObject = filterGroup.createFilter('string', 'Task B', 'STARTS_WITH_CASE_SENSITIVE'); filterGroup.addFilter('or', filterObject); gantt.addFilter({ type: 'task', value: 'label' }, filterGroup);</pre> */ addFilter(columns: any, filterGroup: any): void; /** * Clears the currently applied filters. */ clearFilters(): void; /** * Clears the currently applied column sorting. */ clearSort(): void; /** * Unselects all currently selected items inside the GanttChart including Tasks and Resources. It also clears the assignment highlgihters. */ clearSelection(): void; /** * Removes a previously saved state of the element form LocalStorage according to it's id. Requires an id to be set to the element. */ clearState(): void; /** * Removes all tasks. */ clearTasks(): void; /** * Removes all resources. */ clearResources(): void; /** * Creates a connection between two tasks. * @param {number | string} startTaskIndex. The id of the start task or the connection string like '2-3-0'. If the complete connections string is provided as the first argument, the rest of the method arguments are not necessary * @param {number | string} taskEndIndex?. The id of the end task. * @param {number} connectionType?. The type of the connection. A numeric value from 0 to 3. The connection type can be: <ul><li>0 - Start-to-Start connection.</li><li>1 - End-to-Start connection.</li><li>2 - End-to-End connection.</li><li>3 - Start-to-End connection.</li></ul> * @param {number} lag?. The connection lag in miliseconds. Used by the Auto scheduling algorithm in order allow some slack time slack time before or after the next task begins/ends. Lag is measured in miliseconds. It can be a negative (lead) or a positive (lag) number. */ createConnection(startTaskIndex: number | string, taskEndIndex?: number | string, connectionType?: number, lag?: number): void; /** * Collapses an expanded project. * @param {string | number} id. The id of a project item that should be collapsed. */ collapse(id: string | number): void; /** * Starts an update operation. This is appropriate when calling multiple methods or set multiple properties at once. */ beginUpdate(): void; /** * Ends the update operation. This method will resume the rendering and will refresh the GanttChart. */ endUpdate(): void; /** * Refereshes the GanttChart after resizing by recalculating the Scrollbars. * @param {boolean} fullRefresh?. If set the GanttChart will be re-rendered completely. */ refresh(fullRefresh?: boolean): void; /** * Makes sure a Task is visible by scrolling to it. * @param {string | number} taskId. The id of the target Task. */ ensureVisible(taskId: string | number): void; /** * Expands a collapsed project with tasks. * @param {string | number} id. The id of a project task that should be expanded. */ expand(id: string | number): void; /** * Exports the data of Tree of the GanttChart. * @param {string} dataFormat. Determines the format of the exported file. Three possible values are available: <ul><li>pdf</li><li>xlsx</li><li>html</li><li>tsv</li><li>csv</li><li>xml</li></ul> * @param {any} callback?. A callback that allows to format the exported data based on a condition. For additional details, refer ro the Smart Export Documentation. */ exportData(dataFormat: string, callback?: any): void; /** * Returns all existing connections. The connections a