) => 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: - type - indicates the type of column to filter. Possible values are 'task' or 'resource'.
- value - the value of the column that must match the value attribute of a taskColumns/resourceColumns object(e.g. 'label', 'dateStart', etc).
.
* @param {any} filterGroup. A Smart.Utilities.FilterGroup object. Here's an example for creating a FilterGroup object: 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);
*/
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: - 0 - Start-to-Start connection.
- 1 - End-to-Start connection.
- 2 - End-to-End connection.
- 3 - Start-to-End connection.
* @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:
* @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 are returned as objects that contain detailed information. Each object in the array has the following keys: 'id' - connection id, 'type' - connection type, 'startTaskId' - connection's start task id, 'endTaskId' - connection's end task id, 'startIndex' - connection's start task index, 'endIndex' - connection's end task index, 'lag' - lag time.
* @returns {any}
*/
getConnections(): any;
/**
* Returns the connection details for the target connection which includes: startTask, endTask, startTaskId, endTaskId and type of the corresponding connection. Connection types are described in detail under the `connectionEnd` event description in this document and in a dedicated topic available on the website.
* @param {string} connectionId. A connection id. Each connection has a unique id that is assigned when a connection is created.
* @returns {any}
*/
getConnectionDetails(connectionId: string): any;
/**
* Returns a JSON representation of all tasks inside the element along with their connections and settings.
* @returns {any[]}
*/
getState(): any[];
/**
* Returns the Tree path of a task/resource. The tree path is used as task/resource id if no id is provided by the user.
* @param {any} item. A GattChartTask/GanttChartResource item object.
* @returns {string}
*/
getItemPath(item: any): string;
/**
* Returns the task object that corresponds to the id/path.
* @param {string | number} itemId. The id/path of a task.
* @returns {any}
*/
getTask(itemId: string | number): any;
/**
* Returns an array of all GanttChart tasks.
* @returns {any[]}
*/
getTasks(): any[];
/**
* Returns the index of a task.
* @param {any} task. A GattChartTask object.
* @returns {number}
*/
getTaskIndex(task: any): number;
/**
* Returns the connections definitions of a task.
* @param {any} taskId. A GanttChartTask object or it's id.
* @returns {any}
*/
getTaskConnections(taskId: any): any;
/**
* Returns the Project of a task or undefined if it does not have one.
* @param {any} task. A GantChartTask object.
* @returns {any}
*/
getTaskProject(task: any): any;
/**
* Returns the resource object that corresponds to the id/path.
* @param {string | number} itemId. The id/path of a resource.
* @returns {any}
*/
getResource(itemId: string | number): any;
/**
* Returns an array of all GanttChart resources.
* @returns {any[]}
*/
getResources(): any[];
/**
* Returns the index of a resource.
* @param {any} resource. A GanttChartResource object.
* @returns {number}
*/
getResourceIndex(resource: any): number;
/**
* Returns the tasks that are assigned to the resource.
* @param {any} resource. A GanttChartResource object or it's id.
* @returns {any}
*/
getResourceTasks(resource: any): any;
/**
* Returns the currently selected tasks/resource ids. If selection is disabled or no items are selected returns null.
* @returns {any}
*/
getSelectedIds(): any;
/**
* Returns the currently selected tasks.
* @returns {any}
*/
getSelectedTasks(): any;
/**
* Returns the currently selected resources.
* @returns {any}
*/
getSelectedResources(): any;
/**
* Returns the working hours of the day as numbers.
* @returns {any}
*/
getWorkingHours(): any;
/**
* Hides the tooltip if it's visible.
* @returns {any}
*/
hideTooltip(): any;
/**
* Depending on the nonworkingDays property, returns true or false whether the target date is on a working day or not.
* @param {Date} date. A javascript Date object or a string/number which represents a valid JS Date.
*/
isWorkingDay(date: Date): void;
/**
* Loads a previously saved state of the element or checks LocalStorage for any saved states if no argument is passed to the method.
* @param {any[]} state?. An Array containing a valid structure of Gantt Chart tasks.
*/
loadState(state?: any[]): void;
/**
* Removes all connections between tasks.
*/
removeAllConnections(): void;
/**
* Removes a connection between tasks. The function accepts three arguments(task's start index, end index and connection type) or one connection string argument which describes the connection.
* @param {number | string} startTaskIndex. The index of the start task or the connection string like '2-3-0.
* @param {number} taskEndIndex?. The index of the end task.
* @param {number} connectionType?. The type of the connection. A numeric value from 0 to 3.
* @returns {any}
*/
removeConnection(startTaskIndex: number | string, taskEndIndex?: number, connectionType?: number): any;
/**
* Removes all connections of a task or between two tasks if the second argument is provided and valid.
* @param {any} taskStart. The start task object or it's id.
* @param {any} taskEnd?. The end task object or it's id.
*/
removeTaskConnection(taskStart: any, taskEnd?: any): void;
/**
* Shows the tooltip for a specific element.
* @param {HTMLElement} target. The HTMLElement that will be the target of the tooltip.
* @param {string} content?. Allows to set a custom content for the Tooltip.
*/
showTooltip(target: HTMLElement, content?: string): void;
/**
* Scrolls to a date.
* @param {Date} date. The date to scroll to.
*/
scrollToDate(date: Date): void;
/**
* Saves the current settings of the element to LocalStorage. Requires an id to be set to the element.
* @param {any[]} state?. An Array containing a valid structure of Gantt Chart tasks.
*/
saveState(state?: any[]): void;
/**
* Inserts a new task in the timeline. The new task can be inserted as a sub task of a project by passing the appropriate argument for the project id or as a root level item.
* @param {any} taskObject. An object describing a Gantt Chart task.
* @param {any} project?. A number or string that represents the id of a project (e.g. '0') or a project object definition present in the GanttChart. This parameter determines the parent project of the task that will be inserted. If null is passed as an arguemnt the new task will be inserted at root level without a parent project.
* @param {number} index?. The index where the new item should be inserted(e.g. 2). This index will determine the position of the newly inserted task.
* @returns {string | number | undefined}
*/
insertTask(taskObject: any, project?: any, index?: number): string | number | undefined;
/**
* Updates a task/project/milestone.
* @param {any} taskId. A number or string that represents the id of a task/project(e.g. '0') or the object definition of the task/project.
* @param {any} taskObject. An object describing a Gantt Chart task. The properties of this object will be applied to the desired task.
*/
updateTask(taskId: any, taskObject: any): void;
/**
* Removes a task from the timeline.
* @param {any} taskId. A number or string that represents the id of a task or the actual item object.
*/
removeTask(taskId: any): void;
/**
* Inserts a new resource.
* @param {string | number} resourceId. A string that represents the id of a resource or it's hierarchical position, e.g. '0' ( following SmartTree syntax), or a number that represents the index of a resource.
* @param {any} resourceObject?. An object describing a Gantt Chart resource.
*/
insertResource(resourceId: string | number, resourceObject?: any): void;
/**
* Updates an existing resource.
* @param {any} resourceId. A string that represents the id of a resource or it's hierarchical position, e.g. '0' ( following SmartTree syntax), or a number that represents the index of a resource.
* @param {any} taskObject. An object describing a Gantt Chart resource. The properties of this object will be applied to the target resource.
*/
updateResource(resourceId: any, taskObject: any): void;
/**
* Removes a resource.
* @param {any} resourceId. A string that represents the id of a resource or it's hierarchical position, e.g. '0' ( following SmartTree syntax), or a number that represents the index of a resource.
*/
removeResource(resourceId: any): void;
/**
* Opens the popup Window for specific task to edit or to delete a connection if a connection string is passed.
* @param {any} taskId. A string or number that represents the id of a task or the task object that is going to be edited or a connection string(e.g. '2-0-0').
*/
openWindow(taskId: any): void;
/**
* Closes an opened popup Window. The method will close any opened popup window inside the element.
*/
closeWindow(): void;
/**
* Prepares the GanttChart for printing by opening the browser's Print Preview.
*/
print(): void;
/**
* Allows to sets the working days and hours at once.
* @param settings. An object definition that contains the days and hours that should be working. The days and hours can be defined as an array of numbers where each number is a day/hour, strings where each string represents a range of days/hours (e.g. '1-5' or '2:00-8:00') or nested array of numbers (e.g. [[1,5]] or [[2, 8]]) which means from 1 to 5 or 2 to 8.
*/
setWorkTime(settings: { days: (number | string | number[])[], hours: (number | string | number[])[] }): void;
/**
* Allows to select a task based on it's id.
* @param {string | number} id. The id of the task to select.
*/
selectTask(id: string | number): void;
/**
* Allows to select a resource based on it's id.
* @param {string | number} id. The id of the resource to select.
*/
selectResource(id: string | number): void;
/**
* Allows to unselect a task based on it's id.
* @param {string | number} id. The id of the task to unselect.
*/
unselectTask(id: string | number): void;
/**
* Allows to unselect a resource based on it's id.
* @param {string | number} id. The id of the resource to unselect.
*/
unselectResource(id: string | number): void;
/**
* Allows to unset previously set working time. The opposte method for setWorkingTime.
* @param settings. An object definition that contains the days and hours that should not be working. The days and hours can be defined as an array of numbers where each number is a day/hour, strings where each string represents a range of days/hours (e.g. '1-5' or '2:00-8:00') or nested array of numbers (e.g. [[1,5]] or [[2, 8]]) which means from 1 to 5 or 2 to 8.
*/
unsetWorkTime(settings: { days: (number | string | number[])[], hours: (number | string | number[])[] }): void;
/**
* Sorts the GanttChart tasks/resources if sortable is enabled.
* @param {any} columns. An Array of objects which determine which columns to be sorted, the sort order and the type of item to sort: task or resource. If no arguments are provided sorting will be removed.
An object should have the following properties: - value - a string that represents the value of a taskColumn to sort.
- sortOrder - a string that represents the sorting order for the column: 'asc' (asscending sorting) or 'desc' (descending) are possible values.
- type - a string that represents the type of item to sort. This property determines which panel will be sorted. Two possible values: 'task', 'resource'.
*/
sort(columns: any): void;
}
/**Sets the GanttChart's Data Export options. */
export interface GanttChartDataExport {
/**
* Determines whether to export filtered items or not. By default filtered data is not exported.
* Default value: false
*/
exportFiltered?: boolean;
/**
* Sets the exported file's name.
* Default value: "jqxGanttChart"
*/
fileName?: string;
/**
* Determines the type of items that is going to be exported.
* Default value: task
*/
itemType?: GanttChartDataExportItemType | string;
}
export interface GanttChartDateMarker {
/**
* Determines the marker label.
* Default value:
*/
label?: string | null;
/**
* Determines the date for the marker. The date can include time as well.
* Default value: null
*/
date?: string | Date | number;
/**
* Allows to add a custom class name to the marker.
* Default value: "null"
*/
className?: string;
}
export interface GanttChartResource {
/**
* Resource class. Used to style the resource Timeline.
* Default value: ""
*/
class?: string;
/**
* The capacity of a resource. By default it is used to determine the working capacity ( in hours ) of the resource.
* Default value: 8
*/
capacity?: number;
/**
* Resource visibility.
* Default value: false
*/
hidden?: boolean | undefined;
/**
* Resource id. The unique id of the resource.
* Default value: ""
*/
id?: string;
/**
* Resource label.
* Default value: 0
*/
label?: string | null;
/**
* Resource min capacity
* Default value: 0
*/
minCapacity?: number;
/**
* Resource max capacity. By default this property is used for the resource timeline histogram where maxCapacity is the maximum working capacity in hours of the resource.
* Default value: 0
*/
maxCapacity?: number;
/**
* Resource progress. Progress is the total progress of the resource based on the tasks it is assigned to. This property is automatically calculated.
* Default value: 0
*/
progress?: number;
/**
* Resource type.
* Default value:
*/
type?: any;
/**
* Resource value.
* Default value:
*/
value?: any;
/**
* Resource workload. Workload is the total working time in hours of a resource based on the tasks it is assigned to. This property is automatically calculated.
* Default value: 0
*/
workload?: string | number;
}
export interface GanttChartResourceColumn {
/**
* Column's label.
* Default value:
*/
label?: string | null;
/**
* Column's value. The value shold reference an actual resoruce attribute.
* Default value:
*/
value?: string | null;
/**
* Column's min size.
* Default value: 0
*/
min?: string | number | null;
/**
* Column's size.
* Default value: 0
*/
size?: string | number | null;
/**
* Column's format function. You can use it to customize the column label's rendering.
* Default value: null
*/
formatFunction?: any;
}
export interface GanttChartTask {
/**
* Tasks connection.
* Default value: undefined
*/
connections?: any;
/**
* Project, Task or Milestone CSS class.
* Default value: ""
*/
class?: string;
/**
* Project, Task or Milestone start date.
* Default value:
*/
dateStart?: string | Date;
/**
* Project, Task or Milestone end date.
* Default value:
*/
dateEnd?: string | Date;
/**
* Determines the deadline for the Project, Task or Milestone.
* Default value:
*/
deadline?: string | Date;
/**
* Project, Task or Milestone with disabled resources.
* Default value: false
*/
disableResources?: boolean;
/**
* Project, Task or Milestone dragging is disabled.
* Default value: false
*/
disableDrag?: boolean;
/**
* Project, Task or Milestone resizing is disabled.
* Default value: false
*/
disableResize?: boolean;
/**
* Project, Task or Milestone drag enabled in the view.
* Default value: true
*/
dragProject?: boolean;
/**
* The duration of the tasks in miliseconds. The duration unit can be changed via the durationUnit property.
* Default value: 0
*/
duration?: number | undefined;
/**
* Project, Task or Milestone expanded state in the view.
* Default value: false
*/
expanded?: boolean;
/**
* Task visibility.
* Default value: false
*/
hidden?: boolean | undefined;
/**
* Project, Task or Milestone id.
* Default value:
*/
id?: string | null;
/**
* Determines the indicators for the task. Task indicators represent special dates that are displayed inside the task's row.
* Default value: null
*/
indicators?: GanttChartTaskIndicator[];
/**
* Project, Task or Milestone label.
* Default value:
*/
label?: string | null;
/**
* Project, Task or Milestone format function.
* Default value: null
*/
formatFunction?: any;
/**
* Project, Task or Milestone format function. The function gets passed the following arguments: task, segment, taskElement, segmentElement, labelElement. 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
*/
onRender?: any;
/**
* Project, Task or Milestone max start date.
* Default value:
*/
maxDateStart?: string | Date;
/**
* Project, Task or Milestone min start date.
* Default value:
*/
minDateStart?: string | Date;
/**
* Project, Task or Milestone max end date.
* Default value:
*/
maxDateEnd?: string | Date;
/**
* Project, Task or Milestone min end date.
* Default value:
*/
minDateEnd?: string | Date;
/**
* The minimum duration of the Project, Task or Milestone in miliseconds. The units can be changed via the durationUnit property.
* Default value: 0
*/
minDuration?: number | undefined;
/**
* The maximum duration of the Project, Task or Milestone in miliseconds. The unit can be changed via the durationUnit property.
* Default value: 0
*/
maxDuration?: number | undefined;
/**
* Determines whether the task is overdue it's deadline date or not. The property acts only as a getter. By default it's false, unless there's a deadline defined for the task and the dateEnd has surpassed the deadline date.
* Default value: false
*/
overdue?: boolean;
/**
* Determines the planned dateStart/dateEnd for as the baseline for the task.
* Default value: undefined
*/
planned?: GanttChartTaskPlanned;
/**
* Project, Task or Milestone progress.
* Default value: 0
*/
progress?: number;
/**
* Project, Task or Milestone resources.
* Default value:
*/
resources?: any;
/**
* Determines the segments of a task. GanttChart items of type 'task' can be segmented into smaller pieces. This property stores the segment definitions. At least two segments need to be defined in order to segment a task. The first segment should start on the same date as the task. The Last segment should end on the same date as the task.
* Default value: null
*/
segments?: GanttChartTaskSegment[];
/**
* Project, Task or Milestone synchronized in the view.
* Default value: false
*/
synchronized?: boolean;
/**
* Project's tasks. Only projects can have tasks.
* Default value:
*/
tasks?: any;
/**
* Project, Task or Milestone type. Possible values are 'project', 'milestone' and 'task'
* Default value: task
*/
type?: GanttChartTaskType | string;
/**
* Project, Task or Milestone value.
* Default value:
*/
value?: any;
}
export interface GanttChartTaskIndicator {
/**
* Indicator label.
* Default value: ""
*/
label?: string;
/**
* Indicator date(can include time).
* Default value:
*/
date?: string | Date;
/**
* A custom class name that can be applied to the indicator's element in order to apply some styling via CSS.
* Default value: "null"
*/
className?: string;
/**
* Represents the code for an icon that will be displayed infront of the indicator label inside the timeline.
* Default value: "null"
*/
icon?: string;
/**
* Determines the tooltip content for the indicator. By default indicators do not show tooltips when hovered.
* Default value: "null"
*/
tooltip?: string;
}
/**Determines the planned dateStart/dateEnd for as the baseline for the task. */
export interface GanttChartTaskPlanned {
/**
* Determines the planned dateStart of the task.
* Default value:
*/
dateStart?: string | Date;
/**
* Determines the planned dateEnd of the task.
* Default value:
*/
dateEnd?: string | Date;
/**
* Determines the planned duration of the task.
* Default value: 0
*/
duration?: number | undefined;
}
export interface GanttChartTaskSegment {
/**
* Segment label.
* Default value:
*/
label?: string | null;
/**
* Segment start date.
* Default value:
*/
dateStart?: string | Date;
/**
* Segment end date.
* Default value:
*/
dateEnd?: string | Date;
/**
* Determines whether segment dragging is disabled.
* Default value: false
*/
disableDrag?: boolean;
/**
* Determines whether segment resizing is disabled.
* Default value: false
*/
disableResize?: boolean;
/**
* The duration of a segment in miliseconds(unit). The duration unit can be changed via the durationUnit property.
* Default value: 0
*/
duration?: number | undefined;
/**
* Segment label format function.
* Default value: null
*/
formatFunction?: any;
}
export interface GanttChartTaskColumn {
/**
* Determines whether the task propery determined by column can be edited from the Window editor or not. By default editing is enabled.
* Default value: false
*/
disableEdit?: boolean;
/**
* Applies only to column's that display dates (e.g. dateStart/dateEnd, etc). This property allows to define a JS Intl.DateTimeFormat object in order to format the dates of the column. Here is an example value of the property: dateFormat: { year: '2-digit', month: 'long', day: 'numeric' }. Another option is to use a date format string. Built-in Date formats:// short date pattern'd' - 'M/d/yyyy',// long date pattern'D' - 'dddd, MMMM dd, yyyy',// short time pattern't' - 'h:mm tt',// long time pattern'T' - 'h:mm:ss tt',// long date, short time pattern'f' - 'dddd, MMMM dd, yyyy h:mm tt',// long date, long time pattern'F' - 'dddd, MMMM dd, yyyy h:mm:ss tt',// month/day pattern'M' - 'MMMM dd',// month/year pattern'Y' - 'yyyy MMMM',// S is a sortable format that does not vary by culture'S' - 'yyyy'-'MM'-'dd'T'HH':'mm':'ss'Date format strings:'d'-the day of the month;'dd'-the day of the month'ddd'-the abbreviated name of the day of the week'dddd'- the full name of the day of the week'h'-the hour, using a 12-hour clock from 1 to 12'hh'-the hour, using a 12-hour clock from 01 to 12'H'-the hour, using a 24-hour clock from 0 to 23'HH'- the hour, using a 24-hour clock from 00 to 23'm'-the minute, from 0 through 59'mm'-the minutes,from 00 though59'M'- the month, from 1 through 12'MM'- the month, from 01 through 12'MMM'-the abbreviated name of the month'MMMM'-the full name of the month's'-the second, from 0 through 59'ss'-the second, from 00 through 59't'- the first character of the AM/PM designator'tt'-the AM/PM designator'y'- the year, from 0 to 99'yy'- the year, from 00 to 99'yyy'-the year, with a minimum of three digits'yyyy'-the year as a four-digit number;'yyyyy'-the year as a four-digit number.
* Default value: null
*/
dateFormat?: any;
/**
* Applies only to column's that display numbers. This property allows to define a JS Intl.NumberFormat object in order to format the numbers of the column. Another option is to use a number format string. Number format strings: 'd' - decimal numbers.'f' - floating-point numbers.'n' - integer numbers.'c' - currency numbers.'p' - percentage numbers.For adding decimal places to the numbers, add a number after the formatting striFor example: 'c3' displays a number in this format $25.256
* Default value: null
*/
numberFormat?: any;
/**
* Column's label.
* Default value:
*/
label?: string | null;
/**
* Column's value.
* Default value:
*/
value?: string | null;
/**
* Column's size.
* Default value: 0
*/
size?: string | number | null;
/**
* Column's min width.
* Default value: 0
*/
minWidth?: string | number | null;
/**
* Column's format function. You can use it to customize the column label's rendering.
* Default value: null
*/
formatFunction?: any;
/**
* A function that allows to set a custom editor for the column's value in the Editor Window. The function must return an HTMLElement. The function has two arguments: name - the name of the task property that is going to be edited.value - the value of the task property that is going to be edited. It's also important to define a getCustomEditorValue to return the value from the custom editor.
* Default value: null
*/
customEditor?: any;
/**
* A function that is used in conjunction with customEditor allows to return the value of the custom editor. Since the editor is unknown by the element, this function allows to return the expected result from the editor. It has one argument - an HTMLElement that contains the custom editor that was previously defined by the customEditor function.
* Default value: null
*/
getCustomEditorValue?: any;
/**
* A function that is used in conjunction with customEditor allows to set the value of the custom editor. Since the editor is unknown by the element, this function allows to set the expected value to the editor. It has three arguments - editor - an HTMLElement that contains the custom editor that was previously defined by the customEditor function.columnValue - the value property of the column.value - the value of the task property that the column displays(the editor value).
* Default value: null
*/
setCustomEditorValue?: any;
}
/**Determines whether the tooltips are enabled or not. Tooltips are available for timeline tasks, resources, connections, indicators and segments. */
export interface GanttChartTooltip {
/**
* Determines whether the tooltip will have an arrow or not.
* Default value: false
*/
arrow?: boolean;
/**
* Determines the delay (in miliseconds) before the tooltip is opened.
* Default value: 50
*/
delay?: number;
/**
* Enabled or disables the tooltips.
* Default value: false
*/
enabled?: boolean;
/**
* Determines the [horizontal, vertical] offset (in pixels) for the tooltip position when opened.
* Default value:
*/
offset?: number[];
}
declare global {
interface Document {
createElement(tagName: "smart-gantt-chart"): GanttChart;
querySelector(selectors: "smart-gantt-chart"): GanttChart | null;
querySelectorAll(selectors: "smart-gantt-chart"): NodeListOf;
getElementsByTagName(qualifiedName: "smart-gantt-chart"): HTMLCollectionOf;
getElementsByName(elementName: "smart-gantt-chart"): NodeListOf;
}
}
/**Determines the type of items that is going to be exported. */
export declare type GanttChartDataExportItemType = 'task' | 'resource';
/**Determines the format of the dates in the timeline header when they represent days. */
export declare type GanttDayFormat = '2-digit' | 'numeric' | 'long' | 'short' | 'narrow';
/**Determines in what unit is task duration property measured. */
export declare type Duration = 'day' | 'hour' | 'minute' | 'second' | 'milisecond';
/**Determines weather or not horizontal scrollbar is shown. */
export declare type HorizontalScrollBarVisibility = 'auto' | 'disabled' | 'hidden' | 'visible';
/**Determines the format of the dates inside the timeline header when they represent hours. */
export declare type HourFormat = 'default' | '2-digit' | 'numeric';
/**Determines the format of the dates the timeline header when they represent months. */
export declare type MonthFormat = '2-digit' | 'numeric' | 'long' | 'short' | 'narrow';
/**Determines the scale in Month view. */
export declare type MonthScale = 'day' | 'week';
/**Determines the format of the dates the timeline header when they represent quarters. */
export declare type QuarterFormat = 'numeric' | 'long' | 'short';
/**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. */
export declare type GanttChartResourceTimelineMode = 'diagram' | 'histogram' | 'custom';
/**Determines how the resources will be displayed inside the resource Timeline. */
export declare type GanttChartResourceTimelineView = 'hours' | 'tasks' | 'custom';
/**Sets or gets the selection mode. Only applicable when selection is enabled. */
export declare type GanttChartSelectionMode = 'one' | 'many' | 'extended';
/**Determines whether the GanttChart can be sorted by one, more then one or no columns. */
export declare type GanttChartSortMode = 'none' | 'one' | 'many';
/**Project, Task or Milestone type. Possible values are 'project', 'milestone' and 'task' */
export declare type GanttChartTaskType = 'project' | 'milestone' | 'task';
/**Determines weather or not vertical scrollbar is shown. */
export declare type VerticalScrollBarVisibility = 'auto' | 'disabled' | 'hidden' | 'visible';
/**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. */
export declare type GanttChartView = 'day' | 'week' | 'month' | 'quarter' | 'year';
/**Determines the format of the dates inside the timeline header when they represent years. */
export declare type YearFormat = '2-digit' | 'numeric';
/**Determines the format of the dates inside the timeline header when they represent weeks. */
export declare type WeekFormat = 'long' | 'numeric';