Skip to content

Commit 4a67db9

Browse files
committed
[update] complete baselines config description
1 parent db762d0 commit 4a67db9

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

data/api/gantt_baselines_config.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,27 @@ gantt.init("gantt_here");
2020
@descr:
2121
This config defines how baselines are handled and displayed in the Gantt chart. It can be set as an object to customize the display or as a boolean to enable or disable the feature. The object configuration contains the following properties:
2222

23-
- **datastore** (*string*) - the name of the datastore used for storing baseline entries. For related functionality, see the `getDatastore` method.
24-
- **render_mode** (*boolean | string*) - determines how baselines are displayed:
25-
- `false` - baselines are not shown.
26-
- `"taskRow"` - baselines are displayed in the same row with the task bar.
27-
- `"separateRow"` - baselines are shown in a separate subrow, expanding the task row height.
28-
- `"individualRow"` - each baseline is displayed in its own subrow beneath the task.
29-
- **dataprocessor_baselines** (*boolean*) - specifies whether baseline updates trigger the DataProcessor as individual entries.
30-
- **row_height** (*number*) - defines the height of the subrow for baselines, applicable only when `render_mode` is set to `"separateRow"` or `"individualRow"`.
31-
- **bar_height** (*number*) - sets the height of the baseline bar.
23+
- <span class=subproperty>**datastore**</span> - (*string*) - the name of the datastore used for storing baseline entries. For related functionality,
24+
see the `getDatastore` method.
25+
- <span class=subproperty>**render_mode**</span> - (*boolean | string*) - determines how baselines are displayed:
26+
- **_false_** - baselines are not shown.
27+
- **_"taskRow"_** - baselines are displayed in the same row with the task bar.
28+
- **_"separateRow"_** - baselines are shown in a separate subrow, expanding the task row height.
29+
- **_"individualRow"_** - each baseline is displayed in its own subrow beneath the task.
30+
- <span class=subproperty>**dataprocessor_baselines**</span> - (*boolean*) - specifies whether baseline updates trigger the DataProcessor as individual entries.
31+
- <span class=subproperty>**row_height** - (*number*)</span> - defines the height of the subrow for baselines, applicable only when `render_mode`
32+
is set to `"separateRow"` or `"individualRow"`.
33+
- <span class=subproperty>**bar_height**</span> - (*number*) - sets the height of the baseline bar.
34+
35+
@related:
36+
desktop/inbuilt_baselines.md
3237

3338
@relatedapi:
3439
api/gantt_getdatastore.md
3540

3641
@relatedsample:
37-
04_customization/15_baselines.html
42+
04_customization/15_baselines.html
43+
44+
@edition: pro
45+
46+
@changelog: added in v9.0

0 commit comments

Comments
 (0)