echarts v5.0.0-rc.3 Release Notes
Release Date: 2020-11-20 // about 4 years ago-
v5.0.0-rc.3
- Migrate codebase to TypeScript:
- The entire code base have been migrated to TypeScript.
- Provide
types/dist/echarts.d.ts
for the upper TS based applications, where the TS version supported is down to 3.4. - See more details in #13563
- [Feature] States enhancement:
- Support state transition animation, which brings better interaction effect when highlighting or downplaying some part of the chart.
- Besides the state "emphasis" we already have, v5.0 provides two more configurable state: "select" and "blur" in all series. The option of them are the same as the existing "emphasis". "blur" is used the elements need to fade out when focusing some other elements. "select" is used when the element is selected by mouse/touch click or API triggering.
- Support to blur other graphic elements when highlighting specified data through mouseover or hover linking. See examples bar-label-rotation, bar-polar-stack, bar-stack, area-stack, dataset-link, scatter-weight, tree-basic.
- Unify the previous different state configurations in series, like
highlightPolicy
,focusNodeAdjacency
,hoverOffset
, by the optionfocus
,blurScope
andscale
. See examples sankey-energy, graph, sunburst-drink. - See more details in #12925 and #12911.
- 👍 [Feature] Provide a more powerful label support:
- Use some strategies to bring better displayed labels, including:
- Smarter text color strategy to make labels more easy to be distinguished from different background.
- Smarter label layout in pie chart, especially when there are too many labels or insufficient space. And related issue: #6050.
- Provide more overflow configurations.
- Provide option set
labelLayout
to enable more abilities for developers to tweak the layout of the labels after it's originally positioned by the chart itself. With the options inlabelLayout
, developers can: - Avoid labels overlap (see scatter-label-align-right),
- Make special label alignment, and adjust label position, etc.. See the examples pie-alignTo, pie-labelLine-adjust, pie-label-distanceToLabelLine, pie-label-bleedMargin.
- Make label draggable.
- Support
labelLine
for all series, which is very useful for guiding element to related labels when labels have to be far away from the elements. See examples scatter-label-align-right, scatter-label-align-top. Related issues: #11534, #12971. - See more details in #12911.
- [Feature] Chart racing, bar realtime sorting and label animation:
- Bar race and line race is a popular way to show time series data, and visualize the change in trends over time.
- We provide this capability by bar sorting (
series.sort
andseries.realtimeSort
) and end label animation (series.label.valueAnimation
,series.endLabel
). And this individual options can be used in other related scenarios. - See examples bar-race, and see more details in the original pull request #12484, #13246 and #13045.
- Other the racing of some special customized chart can be implemented by custom series and the callback of renderItem
during
. See the example custom-spiral-race, and see more details in #12775.
- 👍 [Feature] Support data transform plug-in:
- Data transform is a new set of configurations and APIs to enable data transformation based on
dataset
in declarative way. Built-in or third-party data transformer can be made as plug-ins to provide various transform algorithms. ECharts users can use those transformers in ECharts option. - See examples data-transform-filter, data-transform-sort-bar, data-transform-multiple-pie, doc-example/data-transform-multiple-sort-bar, boxplot-light-velocity, bar-histogram, scatter-clustering, scatter-exponential-regression, scatter-linear-regression, scatter-logarithmic-regression, scatter-polynomial-regression. See more details in #13065, #13127](#13127).
- Data transform is a new set of configurations and APIs to enable data transformation based on
- [Feature] Provide more smarter time axis label and tick arrangement:
- See more details in #12859.
- 👍 [Feature] Support
decal
:- Decal provides a new visual type that does not only augment aria scenarios but also enrich visual effects.
- See more details in #13304.
- 💅 [Feature] Provide custom series animation configuration in transform, style, shape morphing/combining/separating.
- See examples custom-combine-separate-morph, custom-one-to-one-morph, custom-story-transition, custom-spiral-race, custom-gauge.
- See more details in #12775, #13468, #13271.
- [Feature] Provide a more powerful gauge:
- See examples gauge-barometer, gauge-clock, gauge-multi-title, gauge-progress, gauge-ring, gauge-grade, gauge-simple, gauge-temperature.
- See more details in #13416.
- 💅 [Feature] The default theme and interaction have been greatly enhanced. Some new options are provided for the style and interaction configuration:
- Tooltip style enhancement: #12947, #13398, #13242.
- Provide configurable dash style: #12961.
- Axis style enhancement: #13046.
- DataZoom support both brush and drag: #13025.
- Support
darkMode
. 12911. - Enhance resize & dataZoom animation: #12965
- Change the closing direction of a single bar, #12543.
- Enhance pie chart animation #12553.
- Other component style enhancement: #13008, #13013.
- [Feature] Make i18n registerable and change the product.
- 👍 [Feature] Support rounded corner in pie and sunburst:
- 🔧 [Feature] Make tooltip more configurable:
- 🚚 [Feature] Support to partially remove components or replace components:
- See details in #12987.
- 🐎 [Enhancement] Enhance performance in some scenarios:
- 🛠 Other small features, enhancements and bug-fixes:
- [Feature] Enhance
parseDate
#13044. - [Feature] Make line bolder when line is in emphasis state #13013.
- [Feature] Sankey supports
lineStyle: {color: 'gradient'}
. - [Feature]
markPoint.data.type
andmarkArea.data.type
support the value'median'
. - [Feature] Support axis filter in specific cases. #12832.
- [Fix] Fix bmap first layout may be incorrect if container's layout is flex or grid. #13432.
- [Fix] Hide tooltip when mouse leaves the chart #13382.
- [Fix] Fix bmap personalization style does not work. #13214.
- [Fix] Fix the bug of overriding title when click the stack button. #13372.
- [Fix] Fix ECharts keeps rendering white blanks with large datasets on single canvas mode #13283.
- [Fix] Make
contentToOption
totally optional. #13139. - [Fix] Keep axis tooltip open on refresh. #13100.
- [Fix] Skip rendering for data out of axis content in heatmap. #12991.
- [Feature] Enhance
- [Break] Breaking changes against v4.9:
- Remove built-in map geoJSON. #13565.
- If the upper application previously imported
src/echarts.js
,src/chart/*.js
andsrc/component/*.js
, it can not work any more because all of the files in/src
folder are migrated to*.ts
. Instead, the upper application can importesm/echarts.js
,esm/chart/*.js
andesm/component/*.js
. - Drop the support of the legacy IE8. The previous VML renderer (necessary in IE8) will not be updated to work in v5.0 util someone proposed with their real scenario.
- The priority of the visuals between
visualMap
anditemStyle
|lineStyle
|areaStyle
are reversed. That is, previously, the visuals (i.e., color, symbol, symbolSize, ...) that generated by the componentvisualMap
has highest priority, which will overwrite the same visuals specified initemStyle
|lineStyle
|areaStyle
. That brought trouble to specify specific style to some certain data items. Since v5.0, the visuals specified initemStyle
|lineStyle
|areaStyle
has highest priority. - The behavior of
rich.?.padding
are changed. Previouslyrich.?.padding: [11, 22, 33, 44]
indicates that the top padding is33
and the bottom padding is11
, which is a buggy implementation because it is different from what CSS did. Since v5.0, we fix it:rich.?.padding: [11, 22, 33, 44]
indicates the top padding is11
and the bottom padding is33
. aria
is not included indist/echarts.simple(.min).js
since v5.0. But it is still included indist/echarts.common(.min).js
anddist/echarts(.min).js
.
- 🗄 [Deprecated] Deprecated usages since v5.0:
- Transform related props of a graphic element are changed:
- Changes:
position: [number, number]
are changed tox: number
/y: number
.scale: [number, number]
are changed toscaleX: number
/scaleY: number
.origin: [number, number]
are changed tooriginX: number
/originY: number
.
- The
position
,scale
andorigin
are still supported but deprecated. - It effects these places:
- In the
graphic
components: the declarations of each element. - In
custom series
: the declarations of each element in the return ofrenderItem
. - Directly use zrender graphic elements.
- In the
- Text related props on graphic elements are changed:
- Changes:
- The declaration of attached text (or say, rect text) are changed.
- Prop
style.text
are deprecated in elements exceptText
. Instead, Prop settextContent
andtextConfig
are provided to support more powerful capabilities. - These related props at the left part below are deprecated. Use the right part below instead.
- textPosition => textConfig.position
- textOffset => textConfig.offset
- textRotation => textConfig.rotation
- textDistance => textConfig.distance
- The props at the left part below are deprecated in
style
andstyle.rich.?
. Use the props at the right part below instead. - textFill => fill
- textStroke => stroke
- textFont => font
- textStrokeWidth => lineWidth
- textAlign => align
- textVerticalAlign => verticalAlign);
- textLineHeight =>
- textWidth => width
- textHeight => hight
- textBackgroundColor => backgroundColor
- textPadding => padding
- textBorderColor => borderColor
- textBorderWidth => borderWidth
- textBorderRadius => borderRadius
- textBoxShadowColor => shadowColor
- textBoxShadowBlur => shadowBlur
- textBoxShadowOffsetX => shadowOffsetX
- textBoxShadowOffsetY => shadowOffsetY
- Note: these props are not changed:
- textShadowColor
- textShadowBlur
- textShadowOffsetX
- textShadowOffsetY
- It effects these places:
- In the
graphic
components: the declarations of each element. [compat, but not accurately the same in some complicated cases.] - In
custom series
: the declarations of each element in the return ofrenderItem
. [compat, but not accurately the same in some complicated cases]. - Directly use zrender graphic elements. [No compat, breaking change].
- In the
- Chart instance
chart.one(...)
is deprecated.label
:- In props
color
,textBorderColor
,backgroundColor
andborderColor
, the value'auto'
is deprecated. Use the value'inherit'
instead. hoverAnimation
:- option
series.hoverAnimation
is deprecated. Useseries.emphasis.scale
instead. line series
:- option
series.clipOverflow
is deprecated. Useseries.clip
instead. custom series
:- In
renderItem
, theapi.style(...)
andapi.styleEmphasis(...)
are deprecated. Because it is not really necessary and hard to ensure backward compatibility. Users can fetch system designated visual byapi.visual(...)
. sunburst series
:- Action type
highlight
is deprecated. UsesunburstHighlight
instead. - Action type
downplay
is deprecated. UsesunburstUnhighlight
instead. - option
series.downplay
is deprecated. Useseries.blur
instead. - option
series.highlightPolicy
is deprecated. Useseries.emphasis.focus
instead. pie series
:- The action type at the left part below are deprecated. Use the right part instead:
pieToggleSelect
=>toggleSelect
pieSelect
=>select
pieUnSelect
=>unselect
- The event type at the left part below are deprecated. Use the right part instead:
pieselectchanged
=>selectchanged
pieselected
=>selected
pieunselected
=>unselected
- option
series.label.margin
is deprecated. Useseries.label.edgeDistance
instead. - option
series.clockWise
is deprecated. Useseries.clockwise
instead. - option
series.hoverOffset
is deprecated. Useseries.emphasis.scaleSize
instead. map series
:- The action type at the left part below are deprecated. Use the right part instead:
mapToggleSelect
=>toggleSelect
mapSelect
=>select
mapUnSelect
=>unselect
- The event type at the left part below are deprecated. Use the right part instead:
mapselectchanged
=>selectchanged
mapselected
=>selected
mapunselected
=>unselected
- option
series.mapType
is deprecated. Useseries.map
instead. - option
series.mapLocation
is deprecated. graph series
:- option
series.focusNodeAdjacency
is deprecated. Useseries.emphasis: { focus: 'adjacency'}
instead. gauge series
:- option
series.clockWise
is deprecated. Useseries.clockwise
instead. - option
series.hoverOffset
is deprecated. Useseries.emphasis.scaleSize
instead. dataZoom component
:- option
dataZoom.handleIcon
need prefixpath://
if using SVGPath. radar
:- option
radar.name
is deprecated. Useradar.axisName
instead. - option
radar.nameGap
is deprecated. Useradar.axisNameGap
instead. - Parse and format:
echarts.format.formatTime
is deprecated. Useecharts.time.format
instead.echarts.number.parseDate
is deprecated. Useecharts.time.parse
instead.echarts.format.getTextRect
is deprecated.
- Migrate codebase to TypeScript: