victory-pie 37.2.0 → 37.3.1

package/es/helper-methods.js

@@ -39,6 +39,30 @@ const getSlices = (props, data) => {
   });
   return layoutFunction(data);
 };
+const getCategoriesFromProps = props => Array.isArray(props.categories) ? props.categories : props?.categories?.x ?? [];
+
+/**
+ * Sorts data by props.categories or props.categories.x. If all of the data keys aren't
+ * included in categories, any remaining data will be appended to the data array.
+ * If extraneous categories are included in the categories prop, the will be ignored and
+ * have no effect on the rendered component.
+ */
+const getDataSortedByCategories = (props, data) => {
+  const sorted = [];
+  getCategoriesFromProps(props).forEach(category => {
+    const idx = data.findIndex(_ref => {
+      let {
+        x
+      } = _ref;
+      return x === category;
+    });
+    if (idx >= 0) {
+      const datum = data.splice(idx, 1)[0];
+      sorted.push(datum);
+    }
+  });
+  return [...sorted, ...data];
+};
 const getCalculatedValues = props => {
   const {
     colorScale,
@@ -50,7 +74,7 @@ const getCalculatedValues = props => {
   const padding = Helpers.getPadding(props);
   const defaultRadius = getRadius(props, padding);
   const origin = getOrigin(props, padding);
-  const data = Data.getData(props);
+  const data = getDataSortedByCategories(props, Data.getData(props));
   const slices = getSlices(props, data);
   return Object.assign({}, props, {
     style,

package/es/victory-pie.d.ts

@@ -1,8 +1,7 @@
 import React from "react";
-import { Data, ColorScalePropType, EventPropTypeInterface, NumberOrCallback, OriginType, SliceNumberOrCallback, StringOrNumberOrCallback, VictoryCommonProps, VictoryLabelableProps, VictoryMultiLabelableProps, VictoryStyleInterface, EventsMixinClass, VictoryDatableProps } from "victory-core";
+import { Data, EventPropTypeInterface, NumberOrCallback, SliceNumberOrCallback, StringOrNumberOrCallback, VictoryCommonProps, VictoryMultiLabelableProps, VictoryStyleInterface, EventsMixinClass, VictoryDatableProps } from "victory-core";
 import { SliceProps, VictorySliceTTargetType, VictorySliceLabelPlacementType, VictorySliceLabelPositionType } from "./slice";
-export interface VictoryPieProps extends Omit<VictoryCommonProps, "polar">, VictoryDatableProps, VictoryLabelableProps, VictoryMultiLabelableProps {
-    colorScale?: ColorScalePropType;
+export interface VictoryPieProps extends Omit<VictoryCommonProps, "polar">, VictoryDatableProps, VictoryMultiLabelableProps {
     cornerRadius?: SliceNumberOrCallback<SliceProps, "cornerRadius">;
     endAngle?: number;
     events?: EventPropTypeInterface<VictorySliceTTargetType, StringOrNumberOrCallback | string[] | number[]>[];
@@ -15,7 +14,6 @@ export interface VictoryPieProps extends Omit<VictoryCommonProps, "polar">, Vict
     labelPosition?: VictorySliceLabelPositionType | ((props: SliceProps) => VictorySliceLabelPositionType);
     labelIndicatorComponent?: React.ReactElement;
     labelRadius?: number | ((props: SliceProps) => number);
-    origin?: OriginType;
     padAngle?: NumberOrCallback;
     radius?: NumberOrCallback;
     startAngle?: number;

package/lib/helper-methods.js

@@ -49,6 +49,30 @@ const getSlices = (props, data) => {
   });
   return layoutFunction(data);
 };
+const getCategoriesFromProps = props => Array.isArray(props.categories) ? props.categories : props?.categories?.x ?? [];
+
+/**
+ * Sorts data by props.categories or props.categories.x. If all of the data keys aren't
+ * included in categories, any remaining data will be appended to the data array.
+ * If extraneous categories are included in the categories prop, the will be ignored and
+ * have no effect on the rendered component.
+ */
+const getDataSortedByCategories = (props, data) => {
+  const sorted = [];
+  getCategoriesFromProps(props).forEach(category => {
+    const idx = data.findIndex(_ref => {
+      let {
+        x
+      } = _ref;
+      return x === category;
+    });
+    if (idx >= 0) {
+      const datum = data.splice(idx, 1)[0];
+      sorted.push(datum);
+    }
+  });
+  return [...sorted, ...data];
+};
 const getCalculatedValues = props => {
   const {
     colorScale,
@@ -60,7 +84,7 @@ const getCalculatedValues = props => {
   const padding = _victoryCore.Helpers.getPadding(props);
   const defaultRadius = getRadius(props, padding);
   const origin = getOrigin(props, padding);
-  const data = _victoryCore.Data.getData(props);
+  const data = getDataSortedByCategories(props, _victoryCore.Data.getData(props));
   const slices = getSlices(props, data);
   return Object.assign({}, props, {
     style,

package/lib/victory-pie.d.ts

@@ -1,8 +1,7 @@
 import React from "react";
-import { Data, ColorScalePropType, EventPropTypeInterface, NumberOrCallback, OriginType, SliceNumberOrCallback, StringOrNumberOrCallback, VictoryCommonProps, VictoryLabelableProps, VictoryMultiLabelableProps, VictoryStyleInterface, EventsMixinClass, VictoryDatableProps } from "victory-core";
+import { Data, EventPropTypeInterface, NumberOrCallback, SliceNumberOrCallback, StringOrNumberOrCallback, VictoryCommonProps, VictoryMultiLabelableProps, VictoryStyleInterface, EventsMixinClass, VictoryDatableProps } from "victory-core";
 import { SliceProps, VictorySliceTTargetType, VictorySliceLabelPlacementType, VictorySliceLabelPositionType } from "./slice";
-export interface VictoryPieProps extends Omit<VictoryCommonProps, "polar">, VictoryDatableProps, VictoryLabelableProps, VictoryMultiLabelableProps {
-    colorScale?: ColorScalePropType;
+export interface VictoryPieProps extends Omit<VictoryCommonProps, "polar">, VictoryDatableProps, VictoryMultiLabelableProps {
     cornerRadius?: SliceNumberOrCallback<SliceProps, "cornerRadius">;
     endAngle?: number;
     events?: EventPropTypeInterface<VictorySliceTTargetType, StringOrNumberOrCallback | string[] | number[]>[];
@@ -15,7 +14,6 @@ export interface VictoryPieProps extends Omit<VictoryCommonProps, "polar">, Vict
     labelPosition?: VictorySliceLabelPositionType | ((props: SliceProps) => VictorySliceLabelPositionType);
     labelIndicatorComponent?: React.ReactElement;
     labelRadius?: number | ((props: SliceProps) => number);
-    origin?: OriginType;
     padAngle?: NumberOrCallback;
     radius?: NumberOrCallback;
     startAngle?: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "victory-pie",
-  "version": "37.2.0",
+  "version": "37.3.1",
   "description": "Pie Component for Victory",
   "keywords": [
     "data visualization",
@@ -21,8 +21,8 @@
   "license": "MIT",
   "dependencies": {
     "lodash": "^4.17.19",
-    "victory-core": "37.2.0",
-    "victory-vendor": "37.2.0"
+    "victory-core": "37.3.1",
+    "victory-vendor": "37.3.1"
   },
   "peerDependencies": {
     "react": ">=16.6.0"

package/src/helper-methods.ts

@@ -3,6 +3,8 @@ import { defaults, isPlainObject } from "lodash";
 import * as d3Shape from "victory-vendor/d3-shape";
 
 import { Helpers, Data, Style } from "victory-core";
+import { VictoryPieProps } from "./victory-pie";
+import { getCategories } from "victory-core/lib/victory-util/data";
 
 const checkForValidText = (text) => {
   if (text === undefined || text === null || Helpers.isFunction(text)) {
@@ -59,6 +61,29 @@ const getSlices = (props, data) => {
   return layoutFunction(data);
 };
 
+const getCategoriesFromProps = (props: VictoryPieProps) =>
+  Array.isArray(props.categories)
+    ? props.categories
+    : (props?.categories as { x: string[] })?.x ?? [];
+
+/**
+ * Sorts data by props.categories or props.categories.x. If all of the data keys aren't
+ * included in categories, any remaining data will be appended to the data array.
+ * If extraneous categories are included in the categories prop, the will be ignored and
+ * have no effect on the rendered component.
+ */
+const getDataSortedByCategories = (props: VictoryPieProps, data) => {
+  const sorted: string[] = [];
+  getCategoriesFromProps(props).forEach((category) => {
+    const idx = data.findIndex(({ x }) => x === category);
+    if (idx >= 0) {
+      const datum = data.splice(idx, 1)[0];
+      sorted.push(datum);
+    }
+  });
+  return [...sorted, ...data];
+};
+
 const getCalculatedValues = (props) => {
   const { colorScale, theme } = props;
   const styleObject = Helpers.getDefaultStyles(props, "pie");
@@ -69,7 +94,7 @@ const getCalculatedValues = (props) => {
   const padding = Helpers.getPadding(props);
   const defaultRadius = getRadius(props, padding);
   const origin = getOrigin(props, padding);
-  const data = Data.getData(props);
+  const data = getDataSortedByCategories(props, Data.getData(props));
   const slices = getSlices(props, data);
   return Object.assign({}, props, {
     style,

package/src/victory-pie.tsx

@@ -33,9 +33,7 @@ import {
 export interface VictoryPieProps
   extends Omit<VictoryCommonProps, "polar">,
     VictoryDatableProps,
-    VictoryLabelableProps,
     VictoryMultiLabelableProps {
-  colorScale?: ColorScalePropType;
   cornerRadius?: SliceNumberOrCallback<SliceProps, "cornerRadius">;
   endAngle?: number;
   events?: EventPropTypeInterface<
@@ -56,7 +54,6 @@ export interface VictoryPieProps
 
   labelIndicatorComponent?: React.ReactElement;
   labelRadius?: number | ((props: SliceProps) => number);
-  origin?: OriginType;
   padAngle?: NumberOrCallback;
   radius?: NumberOrCallback;
   startAngle?: number;