<Recharts />

ReferenceArea

Properties

• xAxisIdString | Number

  参考区域对应的 x 轴的 id。

  默认值：0

• yAxisIdString | Number

  参考区域对应的 y 轴的 id。

  默认值：0

• x1Number | Stringoptional

  用来描述参考区域 x 坐标的一个边界值，当 x 轴是数值类型的坐标轴时，这个值必须为数值类型。当 x 轴为类目轴时， 这个值必须为 x 轴 domain 中的一个元素。

• x2Number | Stringoptional

  用来描述参考区域 x 坐标的一个边界值，当 x 轴是数值类型的坐标轴时，这个值必须为数值类型。当 x 轴为类目轴时， 这个值必须为 x 轴 domain 中的一个元素。

• y1Number | Stringoptional

  用来描述参考区域 y 坐标的一个边界值，当 y 轴是数值类型的坐标轴时，这个值必须为数值类型。当 y 轴为类目轴时， 这个值必须为 y 轴 domain 中的一个元素。

• y2Number | Stringoptional

  用来描述参考区域 y 坐标的一个边界值，当 y 轴是数值类型的坐标轴时，这个值必须为数值类型。当 y 轴为类目轴时， 这个值必须为 y 轴 domain 中的一个元素。

• alwaysShowBoolean@deprecated

  Use 'ifOverflow' instead.

  默认值：false

• ifOverflow'discard' | 'hidden' | 'visible' | 'extendDomain'

  定義如果參考區域部分落在畫布之外，如何繪製參考區域 如果設置為“discard“，則根本不會繪製參考區域 如果設置為“hidden”，參考區域將被裁剪到畫布上 如果設置為“visible“，參考區域將被完全繪製 如果設置為“extendDomain”，溢出軸的域將被擴展，以便參考區域適合畫布

  默认值：'discard'

  示例：

  • A LineChart with domain extending ReferenceArea

• viewBoxObject

  图表的可视区域。

• xAxisObject

  x 轴配置。

• yAxisObject

  y 轴配置。

• labelString | Number | ReactElement | Functionoptional

  当值为简单类型的数值或者字符串时，这个值会被渲染成文字标签。当值为 React element，会克隆这个元素来渲染文字标签。

  格式：

  <ReferenceArea x1="01" x2="08" label="MAX"/>
  <ReferenceArea y1={100} y2={500} label={<CustomizedLabel />}/>

  示例：

  • ReferenceLines with label

• shapeReactElement | Functionoptional

  Renders a svg returned by the react element or function.

  格式：

  <ReferenceArea shape={<CustomSvgShape/>}/>

  示例：

  • ReferenceArea with shape

• isFrontBoolean

  是否展示在图表的最上层。

  默认值：false