PolarGrid

Parent Components

PolarGrid consumes context provided by these components:

Props

  • angleAxisIdnumber | stringoptional

    DEFAULT: 0

  • cxnumber | stringoptional

    The x-coordinate of center. When used inside a chart context, this prop is calculated based on the chart's dimensions, and this prop is ignored.

    This is only used when rendered outside a chart context.

  • cynumber | stringoptional

    The y-coordinate of center. When used inside a chart context, this prop is calculated based on the chart's dimensions, and this prop is ignored.

    This is only used when rendered outside a chart context.

  • fillstringoptional

    The background color used to fill the space between grid lines.

    DEFAULT: "none"

  • fillOpacitynumber | stringoptional

    The opacity of the background used to fill the space between grid lines.

  • gridType"circle" | "polygon"optional

    The type of polar grids.

    DEFAULT: "polygon"

  • innerRadiusnumberoptional

    The radius of the inner polar grid. When used inside a chart context, this prop is calculated based on the chart's dimensions, and this prop is ignored.

    This is only used when rendered outside a chart context.

  • outerRadiusnumberoptional

    The radius of the outer polar grid. When used inside a chart context, this prop is calculated based on the chart's dimensions, and this prop is ignored.

    This is only used when rendered outside a chart context.

  • polarAnglesArray<number>optional

    The array of every line grid's angle.

  • polarRadiusArray<number>optional

    The array of every circle grid's radius.

  • radialLinesbooleanoptional

    DEFAULT: true

  • radiusAxisIdnumber | stringoptional

    DEFAULT: 0

  • strokestringoptional

    The stroke color. If "none", no line will be drawn.

    DEFAULT: "#ccc"

  • strokeDasharraynumber | stringoptional

    The pattern of dashes and gaps used to paint the lines of the grid.

  • strokeWidthnumber | stringoptional

    The width of the stroke.

    DEFAULT: 1

  • zIndexnumberoptional

    Z-Index of this component and its children. The higher the value, the more on top it will be rendered. Components with higher zIndex will appear in front of components with lower zIndex. If undefined or 0, the content is rendered in the default layer without portals.

    DEFAULT: -100