woocommerce/plugins/woocommerce-admin/client/dashboard/dashboard-charts/config.js

112 lines
2.5 KiB
JavaScript
Raw Normal View History

2019-05-20 01:57:06 +00:00
/**
* External dependencies
*/
import { __ } from '@wordpress/i18n';
2019-05-20 01:57:06 +00:00
import { applyFilters } from '@wordpress/hooks';
/**
* Internal dependencies
*/
import { charts as ordersCharts } from '../../analytics/report/orders/config';
import { charts as productsCharts } from '../../analytics/report/products/config';
import { charts as revenueCharts } from '../../analytics/report/revenue/config';
import { charts as couponsCharts } from '../../analytics/report/coupons/config';
import { charts as taxesCharts } from '../../analytics/report/taxes/config';
import { charts as downloadsCharts } from '../../analytics/report/downloads/config';
2019-05-20 01:57:06 +00:00
const DASHBOARD_CHARTS_FILTER = 'woocommerce_admin_dashboard_charts_filter';
const charts = {
revenue: revenueCharts,
orders: ordersCharts,
products: productsCharts,
coupons: couponsCharts,
taxes: taxesCharts,
downloads: downloadsCharts,
};
const defaultCharts = [
{
label: __( 'Total sales', 'woocommerce' ),
report: 'revenue',
Correcting and clarifying analytics terms and calculations (https://github.com/woocommerce/woocommerce-admin/pull/3104) * Relabel Net Revenue to Net Sales, revert previous refund work on Gross revenue and rename to total sales. Update the orer of all the things * Add gross sales calculation to revenue stats endpoint. * Restore coupon_total when updating order stats. * Wire up gross sales to revenue report. * Fix revenue report refunds calculation when there are no refunds. * update net sales labels and cases in order, product and category tables * Subtract refunded shipping and taxes from gross sales. * pluses to minuses to fix the gross revenue and refund totals when refunding * Add gross_sales to revenue stats orderby enum. * Change refund labels to Returns * Remove usage of defunct coupon_total column. * Store refunded amount in stats table. * Rename "gross_total" column to "total_sales". * Net total for refund orders can be used instead of a new column. * Rename gross_revenue to total_sales. * Coalesce coupons total in order stats query. SUM()ing all nulls gives null, not zero. * Use segmentation selections to backfill missing data. Fo when report columns and segmentation columns don't match. * Remove errant gross_sales from expected interval test data. * Fix gross sales tests for revenue/stats. * Move missing segment fills back to their original locations. * Fix remaining tests failing because of gross sales. * Fix db upgrade function rename of gross_total column. * Fix linter errors.
2019-11-22 15:06:14 +00:00
key: 'total_sales',
},
{
label: __( 'Net sales', 'woocommerce' ),
report: 'revenue',
key: 'net_revenue',
},
{
label: __( 'Orders', 'woocommerce' ),
report: 'orders',
key: 'orders_count',
},
{
label: __( 'Average order value', 'woocommerce' ),
report: 'orders',
key: 'avg_order_value',
},
{
label: __( 'Items sold', 'woocommerce' ),
report: 'products',
key: 'items_sold',
},
{
label: __( 'Returns', 'woocommerce' ),
report: 'revenue',
key: 'refunds',
},
{
label: __( 'Discounted orders', 'woocommerce' ),
report: 'coupons',
key: 'orders_count',
},
{
label: __( 'Gross discounted', 'woocommerce' ),
report: 'coupons',
key: 'amount',
},
{
label: __( 'Total tax', 'woocommerce' ),
report: 'taxes',
key: 'total_tax',
},
{
label: __( 'Order tax', 'woocommerce' ),
report: 'taxes',
key: 'order_tax',
},
{
label: __( 'Shipping tax', 'woocommerce' ),
report: 'taxes',
key: 'shipping_tax',
},
{
label: __( 'Shipping', 'woocommerce' ),
report: 'revenue',
key: 'shipping',
},
{
label: __( 'Downloads', 'woocommerce' ),
report: 'downloads',
key: 'download_count',
},
];
/**
* Dashboard Charts section charts.
*
* @filter woocommerce_admin_dashboard_charts_filter
* @param {Array.<Object>} charts Array of visible charts.
*/
export const uniqCharts = applyFilters(
DASHBOARD_CHARTS_FILTER,
defaultCharts.map( ( chartDef ) => ( {
...charts[ chartDef.report ].find(
( chart ) => chart.key === chartDef.key
),
label: chartDef.label,
endpoint: chartDef.report,
} ) )
);