Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
woocommerce/plugins/woocommerce-admin/docs/components/analytics/report-summary.md

842 B
Raw Blame History

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 to populate the Summary Numbers. For example, if taxes is provided, data will be fetched from the report taxes endpoint (ie: /wc/v3/reports/taxes/stats). If the provided endpoint doesn't exist, an error will be shown to the user with ReportError.

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.