Skip to content

Commit 1088c5c

Browse files
committed
[update] docs of startDate/endDate options for Heatmap chart
1 parent b1e02d0 commit 1088c5c

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/chart/api/chart_series_config.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -445,7 +445,7 @@ series: [
445445
</tr>
446446
<tr>
447447
<td><b>endDate</b></td>
448-
<td>(optional) the end date of the calendar heatmap; by default, the 31st of December of the maximal year specified in the dataset. <a href="../../../chart/configuration_properties/#default-range-of-dates">Read the details</a></td>
448+
<td>(optional) the end date of the calendar heatmap; by default, the 31st of December of the maximal year specified in the dataset. <a href="../../../chart/configuration_properties/#default-range-of-dates">Read the details.</a><br>If you use a string value to specify the end date, it should match the format specified via the <b>dateFormat</b> option.</td>
449449
</tr>
450450
<tr>
451451
<td><b>maxValue</b></td>
@@ -461,7 +461,7 @@ series: [
461461
</tr>
462462
<tr>
463463
<td><b>startDate</b></td>
464-
<td>(optional) the date starting from which the calendar heatmap will be displayed; by default, the 1st of January of the minimal year specified in the dataset. <a href="../../../chart/configuration_properties/#default-range-of-dates">Read the details</a></td>
464+
<td>(optional) the date starting from which the calendar heatmap will be displayed; by default, the 1st of January of the minimal year specified in the dataset. <a href="../../../chart/configuration_properties/#default-range-of-dates">Read the details.</a><br>If you use a string value to specify the start date, it should match the format specified via the <b>dateFormat</b> option.</td>
465465
</tr>
466466
<tr>
467467
<td><b>tooltip</b></td>

0 commit comments

Comments
 (0)