docs(option): document missing option properties#516
Merged
Conversation
9bd9279 to
96b3985
Compare
96b3985 to
2f60a75
Compare
2f60a75 to
55fa104
Compare
plainheart
approved these changes
Jun 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
toolbox.backgroundColorin English and Chinese option docsdataZoom-slider.textStyledocs to include supported text box styles while keeping unsupportedalign,verticalAlign, andrichhiddenchildrenforseries-tree.dataitemsdatasetId,grid.opacity,series.tooltip.show,series.tooltip.trigger,series.data.tooltip.show,series-bar.encode.label,series-pie.encode.itemName,series-heatmap.dimensions,series-graph.links.tooltip,series-sankey.links.tooltip,series-sankey.data.label.formatter,series-custom.renderItem.return_text.style.rich, andseries-pie.label.silentseries-pie.label.showtotrueNot included
option.textStyle.backgroundColor: not documented becauseGlobalTextStyleOptionin ECharts source does not supportbackgroundColordataZoom-slider.dataBackgroundColor: not documented because it is a deprecated legacy option;borderColoris the current documented optionseries-pie.label.textStyle: not documented becausetextStyleunderlabelis a deprecated compatibility hierarchy that is flattened by the preprocessor; current docs already document the flattenedlabelstyle propertiesseries-custom.label: not documented because it is marked@deprecatedinCustomSeriesOptionseries-candlestick.markArea.label.formatterandseries-scatter.markArea.data.0.label.formatter: not changed because both are already generated in the option schemacalendarheatmapencodebehavior mentioned in [Bug] 'encode' fails in heatmap series with calendar coordinate system. dimensions works instead echarts#20748 is a runtime issue and is not addressed here; this PR only documents the supportedseries-heatmap.dimensionsoptionVerification
npm run buildgit diff --checkgrid.opacity,series.datasetId,series.tooltip.trigger,series.data.tooltip.show,series-bar.encode.label,series-pie.encode.itemName,series-heatmap.dimensions,series-graph.links.tooltip.show,series-sankey.links.tooltip.show,series-sankey.data.label.formatter,series-custom.renderItem.return_text.style.rich,series-pie.label.silent, andseries-pie.label.showwith defaulttrueFixes apache/echarts#21643