Skip to content

Latest commit

 

History

History
22 lines (20 loc) · 1.79 KB

README.md

File metadata and controls

22 lines (20 loc) · 1.79 KB

<AxisChart />

import { AxisChart } from 'ihme-ui'

Wraps and provides its child charting components with height, width, scales, and padding

Property Required Type(s) Defaults Description
autoFormatAxes bool false auto-calculate chart padding needed for tick/axes labels and whether tick labels need rotation (will only be applied to axes whose scale type is categorical in nature (i.e., 'point', 'ordinal', 'band')).
axisStyle CommonPropTypes.style inline styles applied to axis component
className CommonPropTypes.className className applied to outermost svg element
clipPath bool apply clipping path to charting area
height true number pixel height of line chart
loading bool delay rendering while fetching data
minTickLabelSpacing number 4 Minimum spacing (in px) between horizontal axis tick labels. Used to determine the width at which tick labels should rotate.
padding object {
top: 20,
right: 20,
bottom: 30,
left: 50,
}
padding around the chart contents, space for Axis and Label
style object inline styles to apply to outermost svg element
width true number pixel width of line chart
xDomain array [min, max] for xScale (i.e., the domain of the data)
xScaleType one of: SCALE_TYPES type of x scale
name of d3 scale scale function
yDomain array [min, max] yScale (i.e., the range of the data)
yScaleType one of: SCALE_TYPES type of y scale
name of d3 scale scale function