diff --git a/package.json b/package.json index 39fc912f3..1bdf1665a 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ihme-ui", "description": "Visualization tools from the Institute for Health Metrics and Evaluation", - "version": "0.23.0", + "version": "0.24.0", "license": "MIT", "browser": "dist/ihme-ui.min.js", "main": "lib/index.js", diff --git a/src/ui/shape/README.md b/src/ui/shape/README.md index 80b7e4401..85dfe576c 100644 --- a/src/ui/shape/README.md +++ b/src/ui/shape/README.md @@ -95,13 +95,14 @@ Property | Required | Type(s) | Defaults | Description `onMouseLeave` | | func | CommonDefaultProps.noop | onMouseLeave callback.
signature: (SyntheticEvent, datum, instance) => {...} `onMouseMove` | | func | CommonDefaultProps.noop | onMouseMove callback.
signature: (SyntheticEvent, datum, instance) => {...} `onMouseOver` | | func | CommonDefaultProps.noop | onMouseOver callback.
signature: (SyntheticEvent, datum, instance) => {...} -`scales` | true | object | | `x` and `y` scales for positioning ``s.
Object with keys: `x`, and `y`. +`scales` | | object | { x: scaleLinear(), y: scaleLinear() } | `x` and `y` scales for positioning ``s.
Object with keys: `x`, and `y`. `selectedClassName` | | [CommonPropTypes.className](https://github.com/ihmeuw/ihme-ui/blob/master/src/utils/props.js#L11) | | className applied to ``s if selected `selection` | | array | | Array of datum objects corresponding to selected ``s `size` | | number | 64 | Size of ``s; area in square pixels.
If not provided, `` provides a default of 64 (8px x 8px). -`style` | | [CommonPropTypes.style](https://github.com/ihmeuw/ihme-ui/blob/master/src/utils/props.js#L16) | | Inline styles passed to each `` +`style` | | [CommonPropTypes.style](https://github.com/ihmeuw/ihme-ui/blob/master/src/utils/props.js#L16) | | Inline styles applied to wrapping element (``) of scatter shapes `shapeClassName` | | [CommonPropTypes.className](https://github.com/ihmeuw/ihme-ui/blob/master/src/utils/props.js#L11) | | className applied to each `` `shapeScale` | | func | | If provided, used in conjunction with `dataAccessors.shape` (or `dataAccessors.key` if not provided)
to determine type of shape to render +`shapeStyle` | | CommonDefaultProps.style | | Inline styles passed to each `` `shapeType` | | string | 'circle' | Type of shape to render; use in lieu of `props.shapeScale`
if you want all `` to be of the same type. ---