woocommerce/plugins/woocommerce-admin/docs/components/analytics/report-summary.md

42 lines
588 B
Markdown

`ReportSummary` (component)
===========================
Component to render summary numbers in reports.
Props
-----
### `charts`
- **Required**
- Type: Array
- Default: null
Properties of all the charts available for that report.
### `endpoint`
- **Required**
- Type: String
- Default: null
The endpoint to use in API calls.
### `query`
- **Required**
- Type: Object
- Default: null
The query string represented in object form.
### `selectedChart`
- **Required**
- Type: Object
- key: String - Key of the selected chart.
- Default: null
Properties of the selected chart.