Skip to content

Commit ea48a40

Browse files
committed
[dev] add bar_height_padding description, remove deleted pages
1 parent f049594 commit ea48a40

File tree

9 files changed

+50
-40
lines changed

9 files changed

+50
-40
lines changed
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
bar_height_padding
2+
=============
3+
4+
@short: adjusts the padding around task bars in the timeline when `bar_height` is set to "full"
5+
6+
@type: number
7+
@default: 9
8+
@example:
9+
gantt.config.bar_height_padding = 5;
10+
gantt.init("gantt_here");
11+
12+
@template: api_config
13+
@descr:
14+
The `bar_height_padding` config defines the vertical padding for task bars in the timeline when `gantt.config.bar_height` is set to "full". The height of a task bar is calculated as `gantt.config.row_height - gantt.config.bar_height_padding`.
15+
16+
- Setting this config to `0` will make the task bars occupy the full height of the row.
17+
- Increasing the value adds more space above and below the bars.
18+
19+
The example below shows a smaller padding value, which leaves less space around the task bars:
20+
21+
~~~js
22+
gantt.config.bar_height_padding = 3;
23+
~~~
24+
25+
<img src="api/bar_height_padding_small.png">
26+
27+
In this example, a larger padding value leaves more empty space above and below the task bars:
28+
29+
~~~js
30+
gantt.config.bar_height_padding = 14;
31+
~~~
32+
33+
<img src="api/bar_height_padding_large.png">
34+
35+
@relatedapi:
36+
api/gantt_bar_height_config.md
37+
api/gantt_row_height_config.md

data/api/gantt_task_height_offset_config.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

data/api/refs/gantt.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Gantt API
1515
- api/gantt_addshortcut.md - adds a new keyboard shortcut
1616
- api/gantt_addtask.md - adds a new task
1717
- api/gantt_addtasklayer.md - displays an additional layer with custom elements for a task in the timeline area
18-
- api/gantt_adjusttaskheightforbaselines.md -
18+
- api/gantt_adjusttaskheightforbaselines.md - adjusts the task's row height for proper display of baseline elements
1919
- api/gantt_alert.md - calls an alert message box
2020
- api/gantt_assert.md - if the specified expression is false, an errorMessage is shown in the red popup at the top right corner of the screen
2121
- api/gantt_attachevent.md - attaches the handler to an inner event of dhtmlxGantt
@@ -227,7 +227,6 @@ Gantt API
227227
- api/gantt_onafterquickinfo_event.md - fires after the pop-up edit form is closed
228228
- api/gantt_onafterredo_event.md - fires after the redo() method was called
229229
- api/gantt_onafterrowresize_event.md - fires after resizing of the row height is finished
230-
- api/gantt_onafterselect_event.md -
231230
- api/gantt_onaftersort_event.md - fires after tasks are sorted in the grid
232231
- api/gantt_onaftertaskadd_event.md - fires after the user adds a task to the Gantt chart
233232
- api/gantt_onaftertaskautoschedule_event.md - fires for each task which has been autoscheduled
@@ -236,7 +235,6 @@ Gantt API
236235
- api/gantt_onaftertaskmove_event.md - fires after a task was moved to a new vertical position
237236
- api/gantt_onaftertaskupdate_event.md - fires after the user updates a task
238237
- api/gantt_onafterundo_event.md - fires after the undo() method was called
239-
- api/gantt_onafterunselect_event.md -
240238
- api/gantt_onajaxerror_event.md - fires if the server returns an error
241239
- api/gantt_onautoschedulecircularlink_event.md - fires if some dependency loops were found during auto scheduling
242240
- api/gantt_onbeforeautoschedule_event.md - fires before auto scheduling
@@ -261,7 +259,6 @@ Gantt API
261259
- api/gantt_onbeforerowdragmove_event.md - fires before a row of the grid is dragged vertically to a different position
262260
- api/gantt_onbeforerowresize_event.md - fires before the user starts to resize the row height by drag-and-drop
263261
- api/gantt_onbeforerowresizeend_event.md - fires before resizing of the row height is completed
264-
- api/gantt_onbeforeselect_event.md -
265262
- api/gantt_onbeforesplittaskdisplay_event.md - fires before a part of the split task is displayed on the Gantt chart
266263
- api/gantt_onbeforetaskadd_event.md - fires before a new task is added to the Gantt chart
267264
- api/gantt_onbeforetaskautoschedule_event.md - fires for each task which is rescheduled
@@ -353,7 +350,8 @@ Gantt API
353350
- api/gantt_autosize_config.md - forces the Gantt chart to automatically change its size to show all tasks without scrolling
354351
- api/gantt_autosize_min_width_config.md - sets the minimum width (in pixels) that the Gantt chart can take in the horizontal 'autosize' mode
355352
- api/gantt_bar_height_config.md - sets the height of task bars in the timeline area
356-
- api/gantt_baselines_config.md -
353+
- api/gantt_bar_height_padding_config.md - adjusts the padding around task bars in the timeline when `bar_height` is set to "full"
354+
- api/gantt_baselines_config.md - configures the functionality of baselines in the Gantt chart
357355
- api/gantt_branch_loading_config.md - enables dynamic loading in the Gantt chart
358356
- api/gantt_branch_loading_property_config.md - specifies that the task has children that are not yet loaded from the backend
359357
- api/gantt_buttons_left_config.md - stores a collection of buttons resided in the left bottom corner of the lightbox
@@ -370,7 +368,7 @@ Gantt API
370368
- api/gantt_date_format_config.md - sets the date format that is used to parse data from a data set and to send dates back to the server
371369
- api/gantt_date_grid_config.md - sets the format of dates in the "Start time" column of the table
372370
- api/gantt_date_scale_config.md - sets the format of the time scale (X-Axis)
373-
- api/gantt_deadlines_config.md -
371+
- api/gantt_deadlines_config.md - enables or disables the display of deadline elements for tasks
374372
- api/gantt_deepcopy_on_parse_config.md - defines whether gantt will perform a deep copy of data objects passed into the gantt.parse() method
375373
- api/gantt_details_on_create_config.md - 'says' to open the lightbox while creating new events by clicking the '+' button
376374
- api/gantt_details_on_dblclick_config.md - 'says' to open the lightbox after double clicking on a task
@@ -414,7 +412,7 @@ Gantt API
414412
- api/gantt_link_arrow_size_config.md - sets the size of the link arrow
415413
- api/gantt_link_attribute_config.md - sets the name of the attribute that will specify the id of the link's HTML element
416414
- api/gantt_link_line_width_config.md - sets the width of dependency links in the timeline area
417-
- api/gantt_link_radius_config.md -
415+
- api/gantt_link_radius_config.md - sets the radius for rounding corners of link lines in the timeline
418416
- api/gantt_link_wrapper_width_config.md - sets the width of the area (over the link) sensitive to clicks
419417
- api/gantt_links_config.md - stores the types of links dependencies
420418
- api/gantt_min_column_width_config.md - sets the minimum width for a column in the timeline area
@@ -485,7 +483,6 @@ Gantt API
485483
- api/gantt_task_date_config.md - sets the format of the date label in the 'Time period' section of the lightbox
486484
- api/gantt_task_grid_row_resizer_attribute_config.md - sets the name of the attribute of the resizer's DOM element of the grid row. The attribute presents the row's index
487485
- api/gantt_task_height_config.md - sets the height of task bars in the timeline area
488-
- api/gantt_task_height_offset_config.md -
489486
- api/gantt_task_scroll_offset_config.md - sets the offset (in pixels) of the nearest task from the left border in the timeline
490487
- api/gantt_time_picker_config.md - sets the format of the time drop-down selector in the lightbox
491488
- api/gantt_time_step_config.md - sets the minimum step (in minutes) for the task's time values
@@ -516,7 +513,7 @@ Gantt API
516513
<div class='h2'>Templates</div>
517514

518515
{{api
519-
- api/gantt_baseline_text_template.md -
516+
- api/gantt_baseline_text_template.md - specifies the text displayed inside the baseline element
520517
- api/gantt_date_grid_template.md - specifies the content of columns that show dates (return `Date` values) in grid
521518
- api/gantt_drag_link_template.md - specifies the text of tooltips that are displayed when the user creates a new dependency link
522519
- api/gantt_drag_link_class_template.md - specifies the CSS class that will be applied to the pop-up that appears when a user drags a link

data/api/refs/gantt_events.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ Events
1313
- api/gantt_onafterquickinfo_event.md - fires after the pop-up edit form is closed
1414
- api/gantt_onafterredo_event.md - fires after the redo() method was called
1515
- api/gantt_onafterrowresize_event.md - fires after resizing of the row height is finished
16-
- api/gantt_onafterselect_event.md -
1716
- api/gantt_onaftersort_event.md - fires after tasks are sorted in the grid
1817
- api/gantt_onaftertaskadd_event.md - fires after the user adds a task to the Gantt chart
1918
- api/gantt_onaftertaskautoschedule_event.md - fires for each task which has been autoscheduled
@@ -22,7 +21,6 @@ Events
2221
- api/gantt_onaftertaskmove_event.md - fires after a task was moved to a new vertical position
2322
- api/gantt_onaftertaskupdate_event.md - fires after the user updates a task
2423
- api/gantt_onafterundo_event.md - fires after the undo() method was called
25-
- api/gantt_onafterunselect_event.md -
2624
- api/gantt_onajaxerror_event.md - fires if the server returns an error
2725
- api/gantt_onautoschedulecircularlink_event.md - fires if some dependency loops were found during auto scheduling
2826
- api/gantt_onbeforeautoschedule_event.md - fires before auto scheduling
@@ -47,7 +45,6 @@ Events
4745
- api/gantt_onbeforerowdragmove_event.md - fires before a row of the grid is dragged vertically to a different position
4846
- api/gantt_onbeforerowresize_event.md - fires before the user starts to resize the row height by drag-and-drop
4947
- api/gantt_onbeforerowresizeend_event.md - fires before resizing of the row height is completed
50-
- api/gantt_onbeforeselect_event.md -
5148
- api/gantt_onbeforesplittaskdisplay_event.md - fires before a part of the split task is displayed on the Gantt chart
5249
- api/gantt_onbeforetaskadd_event.md - fires before a new task is added to the Gantt chart
5350
- api/gantt_onbeforetaskautoschedule_event.md - fires for each task which is rescheduled
@@ -131,7 +128,6 @@ Events
131128
- api/gantt_onafterquickinfo_event.md
132129
- api/gantt_onafterredo_event.md
133130
- api/gantt_onafterrowresize_event.md
134-
- api/gantt_onafterselect_event.md
135131
- api/gantt_onaftersort_event.md
136132
- api/gantt_onaftertaskadd_event.md
137133
- api/gantt_onaftertaskautoschedule_event.md
@@ -140,7 +136,6 @@ Events
140136
- api/gantt_onaftertaskmove_event.md
141137
- api/gantt_onaftertaskupdate_event.md
142138
- api/gantt_onafterundo_event.md
143-
- api/gantt_onafterunselect_event.md
144139
- api/gantt_onajaxerror_event.md
145140
- api/gantt_onautoschedulecircularlink_event.md
146141
- api/gantt_onbeforeautoschedule_event.md
@@ -165,7 +160,6 @@ Events
165160
- api/gantt_onbeforerowdragmove_event.md
166161
- api/gantt_onbeforerowresize_event.md
167162
- api/gantt_onbeforerowresizeend_event.md
168-
- api/gantt_onbeforeselect_event.md
169163
- api/gantt_onbeforesplittaskdisplay_event.md
170164
- api/gantt_onbeforetaskadd_event.md
171165
- api/gantt_onbeforetaskautoschedule_event.md

data/api/refs/gantt_methods.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Methods
1111
- api/gantt_addshortcut.md - adds a new keyboard shortcut
1212
- api/gantt_addtask.md - adds a new task
1313
- api/gantt_addtasklayer.md - displays an additional layer with custom elements for a task in the timeline area
14-
- api/gantt_adjusttaskheightforbaselines.md -
14+
- api/gantt_adjusttaskheightforbaselines.md - adjusts the task's row height for proper display of baseline elements
1515
- api/gantt_alert.md - calls an alert message box
1616
- api/gantt_assert.md - if the specified expression is false, an errorMessage is shown in the red popup at the top right corner of the screen
1717
- api/gantt_attachevent.md - attaches the handler to an inner event of dhtmlxGantt

data/api/refs/gantt_props.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ Properties
1818
- api/gantt_autosize_config.md - forces the Gantt chart to automatically change its size to show all tasks without scrolling
1919
- api/gantt_autosize_min_width_config.md - sets the minimum width (in pixels) that the Gantt chart can take in the horizontal 'autosize' mode
2020
- api/gantt_bar_height_config.md - sets the height of task bars in the timeline area
21-
- api/gantt_baselines_config.md -
21+
- api/gantt_bar_height_padding_config.md - adjusts the padding around task bars in the timeline when `bar_height` is set to "full"
22+
- api/gantt_baselines_config.md - configures the functionality of baselines in the Gantt chart
2223
- api/gantt_branch_loading_config.md - enables dynamic loading in the Gantt chart
2324
- api/gantt_branch_loading_property_config.md - specifies that the task has children that are not yet loaded from the backend
2425
- api/gantt_buttons_left_config.md - stores a collection of buttons resided in the left bottom corner of the lightbox
@@ -35,7 +36,7 @@ Properties
3536
- api/gantt_date_format_config.md - sets the date format that is used to parse data from a data set and to send dates back to the server
3637
- api/gantt_date_grid_config.md - sets the format of dates in the "Start time" column of the table
3738
- api/gantt_date_scale_config.md - sets the format of the time scale (X-Axis)
38-
- api/gantt_deadlines_config.md -
39+
- api/gantt_deadlines_config.md - enables or disables the display of deadline elements for tasks
3940
- api/gantt_deepcopy_on_parse_config.md - defines whether gantt will perform a deep copy of data objects passed into the gantt.parse() method
4041
- api/gantt_details_on_create_config.md - 'says' to open the lightbox while creating new events by clicking the '+' button
4142
- api/gantt_details_on_dblclick_config.md - 'says' to open the lightbox after double clicking on a task
@@ -79,7 +80,7 @@ Properties
7980
- api/gantt_link_arrow_size_config.md - sets the size of the link arrow
8081
- api/gantt_link_attribute_config.md - sets the name of the attribute that will specify the id of the link's HTML element
8182
- api/gantt_link_line_width_config.md - sets the width of dependency links in the timeline area
82-
- api/gantt_link_radius_config.md -
83+
- api/gantt_link_radius_config.md - sets the radius for rounding corners of link lines in the timeline
8384
- api/gantt_link_wrapper_width_config.md - sets the width of the area (over the link) sensitive to clicks
8485
- api/gantt_links_config.md - stores the types of links dependencies
8586
- api/gantt_min_column_width_config.md - sets the minimum width for a column in the timeline area
@@ -150,7 +151,6 @@ Properties
150151
- api/gantt_task_date_config.md - sets the format of the date label in the 'Time period' section of the lightbox
151152
- api/gantt_task_grid_row_resizer_attribute_config.md - sets the name of the attribute of the resizer's DOM element of the grid row. The attribute presents the row's index
152153
- api/gantt_task_height_config.md - sets the height of task bars in the timeline area
153-
- api/gantt_task_height_offset_config.md -
154154
- api/gantt_task_scroll_offset_config.md - sets the offset (in pixels) of the nearest task from the left border in the timeline
155155
- api/gantt_time_picker_config.md - sets the format of the time drop-down selector in the lightbox
156156
- api/gantt_time_step_config.md - sets the minimum step (in minutes) for the task's time values
@@ -192,6 +192,7 @@ Properties
192192
- api/gantt_autosize_config.md
193193
- api/gantt_autosize_min_width_config.md
194194
- api/gantt_bar_height_config.md
195+
- api/gantt_bar_height_padding_config.md
195196
- api/gantt_baselines_config.md
196197
- api/gantt_branch_loading_config.md
197198
- api/gantt_branch_loading_property_config.md
@@ -324,7 +325,6 @@ Properties
324325
- api/gantt_task_date_config.md
325326
- api/gantt_task_grid_row_resizer_attribute_config.md
326327
- api/gantt_task_height_config.md
327-
- api/gantt_task_height_offset_config.md
328328
- api/gantt_task_scroll_offset_config.md
329329
- api/gantt_time_picker_config.md
330330
- api/gantt_time_step_config.md

data/api/refs/gantt_templates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Templates
44
=======
55

66
{{api
7-
- api/gantt_baseline_text_template.md -
7+
- api/gantt_baseline_text_template.md - specifies the text displayed inside the baseline element
88
- api/gantt_date_grid_template.md - specifies the content of columns that show dates (return `Date` values) in grid
99
- api/gantt_drag_link_template.md - specifies the text of tooltips that are displayed when the user creates a new dependency link
1010
- api/gantt_drag_link_class_template.md - specifies the CSS class that will be applied to the pop-up that appears when a user drags a link
21.9 KB
Loading
22.4 KB
Loading

0 commit comments

Comments
 (0)