Skip to content

EChartOption Type documentation

Index signature: [ key: string ]: any
Properties
dataZoom?: DataZoomComponentOption[]
grid?: (GridComponentOption | GridComponentOption[])
legend?: LegendComponentOption[]
series?: EChartSeries

Types Documentation

Properties
backgroundColor?: ZRColor
borderColor?: ZRColor
borderWidth?: number
bottom?: PositionSizeOption from BoxLayoutOptionMixin.bottom
Deprecated: Use grid.outerBounds instead. Whether grid size contains axis labels. This approach estimates the size by sample labels. It works for most case but it does not strictly contain all labels in some cases.
containLabel?: boolean
coord?: CoordinateSystemDataCoord from ComponentOption.coord
coordinateSystem?: string from ComponentOption.coordinateSystem
coordinateSystemUsage?: CoordinateSystemUsageOption from ComponentOption.coordinateSystemUsage
height?: PositionSizeOption from BoxLayoutOptionMixin.height
id?: OptionId from ComponentOption.id
left?: PositionSizeOption from BoxLayoutOptionMixin.left
mainType?: "grid"
name?: OptionName from ComponentOption.name
{left, right, top, bottom, width, height}: Define a outerBounds rect, based on: - the canvas by default. - or the dataToLayout result if a boxCoordinateSystem is specified.
outerBounds?: BoxLayoutOptionMixin
outerBoundsClampHeight?: (string | number)
Available only when outerBoundsMode is not 'none'. Offer a constraint to not to shrink the grid rect causing smaller that width/height. A string means percent, like '30%', based on the original rect size determined by grid.top/right/bottom/left/width/height .
outerBoundsClampWidth?: (string | number)
- 'all': Default. Contains the cartesian rect and axis labels and axis name. - 'axisLabel': Contains the cartesian rect and axis labels. This effect differs slightly from the previous option containLabel but more precise. - 'auto'/null/undefined: Default. be 'axisLabel' if containLabel:true , otherwise 'all'.
outerBoundsContain?: ("all" | "auto" | "axisLabel" | NullUndefined$1)
Define a constrains rect. Axis lines is firstly laid out based on the rect defined by grid.left/right/top/bottom/width/height . (for axis line alignment requirements between multiple grids) But if axisLabel and/or axisName overflow the outerBounds, shrink the layout to avoid that overflow.

Options: - 'none': outerBounds is infinity. - 'same': outerBounds is the same as the layout rect defined by grid.left/right/top/bottom/width/height . - 'auto'/null/undefined: Default. Use outerBounds , or 'same' if containLabel:true .

Note: grid.containLabel is equivalent to {outerBoundsMode: 'same', outerBoundsContain: 'axisLabel'} .

outerBoundsMode?: ("auto" | "none" | "same" | NullUndefined$1)
right?: PositionSizeOption from BoxLayoutOptionMixin.right
shadowBlur?: number from ShadowOptionMixin.shadowBlur
shadowColor?: string from ShadowOptionMixin.shadowColor
shadowOffsetX?: number from ShadowOptionMixin.shadowOffsetX
shadowOffsetY?: number from ShadowOptionMixin.shadowOffsetY
show?: boolean
tooltip?: any
top?: PositionSizeOption from BoxLayoutOptionMixin.top
type?: string from ComponentOption.type
width?: PositionSizeOption from BoxLayoutOptionMixin.width
z?: number from ComponentOption.z
zlevel?: number from ComponentOption.zlevel
imported from echarts
imported from echarts
imported from echarts
imported from echarts
imported from echarts
imported from echarts
imported from echarts
import
imported from echarts
imported from echarts
imported from echarts
imported from echarts
imported from echarts
imported from echarts
imported from echarts
imported from echarts
imported from echarts
imported from echarts
imported from echarts
imported from echarts
imported from echarts
imported from echarts
imported from echarts
imported from echarts
imported from echarts
imported from echarts

Except where otherwise noted, content on this site is licensed under MIT License.