Skip to content

Commit 1fe25d2

Browse files
committed
[fix] remove unused 'task' parameter from calendar methods descriptions
1 parent b34f160 commit 1fe25d2

File tree

1 file changed

+2
-6
lines changed

1 file changed

+2
-6
lines changed

data/api/gantt_calendar_other.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,6 @@ calendar.unsetWorkTime({ date: new Date(2025, 5, 6), hours: true });
9191
- **_config_** - (*Date | object*) - either a date to check or the [configuration object](api/gantt_isworktime.md#configurationobjectproperties) of a time span:
9292
- **_date_** - (*Date*) - a date to check
9393
- **_unit?_** - (*string*) - optional, a time unit: "minute", "hour", "day", "week", "month", "year"
94-
- **_task?_** - (*Task*) - optional, the object of the task the duration of which should be calculated
9594
- **_time_unit?_** - (*string*) - optional, a time unit: "minute", "hour", "day", "week", "month", "year". Not needed at all when the first parameter is specified as an object
9695

9796
~~~js
@@ -110,24 +109,22 @@ calendar.isWorkTime({ date: new Date(2025, 5, 6), unit: "hour" });
110109
- **_date_** - (*Date*) - a date to get the closest working time for
111110
- **_dir?_** - (*string*) - optional, specifies the direction of the closest time: "future" or "past"
112111
- **_unit?_** - (*string*) - optional, a time unit to search for the closest working time
113-
- **_task?_** - (*Task*) - optional, the object of the task to use its calendar
114112

115113
~~~js
116114
calendar.getClosestWorkTime(new Date(2025, 5, 6));
117115
calendar.getClosestWorkTime({
118116
date: new Date(2025, 5, 6),
119-
unit: "hour",
120-
task: gantt.getTask(2),
117+
unit: "hour",
121118
dir: "past"
122119
});
123120
~~~
124121

122+
125123
- <span class=submethod>**calculateEndDate (config, duration, unit): Date**</span> - calculates the end date of a task
126124
- **_config_** - (*Date | object*) - either the date when a task is scheduled to begin or the [configuration object](api/gantt_calculateenddate.md#configurationobjectproperties) of a time span:
127125
- **_start_date_** - (*Date*) - the date when a task is scheduled to begin
128126
- **_duration_** - (*number*) - the duration of a task
129127
- **_unit?_** - (*string*) - optional, the time unit of the duration: "minute", "hour", "day", "week", "month", "year"
130-
- **_task?_** - (*Task*) - optional, the object of the task the duration of which should be calculated
131128
- **_duration?_** - (*number*) - optional, the duration of a task. Not needed at all when the first parameter is specified as an object
132129
- **_unit?_** - (*string*) - optional, the time unit of the duration. Not needed at all when the first parameter is specified as an object<br>
133130

@@ -144,7 +141,6 @@ calendar.calculateEndDate({
144141
- **_config_** - (*Date | object*) - either the date when a task is scheduled to begin or the [configuration object](api/gantt_calculateduration.md#configurationobjectproperties) of a time span:
145142
- **_start_date_** - (*Date*) - the date when a task is scheduled to begin
146143
- **_end_date_** - (*Date*) - the date when a task is scheduled to be completed
147-
- **_task?_** - (*Task*) - optional, the object of the task the duration of which should be calculated
148144
- **_end?_** - (*Date*) - the date when a task is scheduled to be completed. Not needed at all when the first parameter is specified as an object<br>
149145

150146
~~~js

0 commit comments

Comments
 (0)