@trackunit/shared-utils 0.0.14 → 0.0.16-alpha-500b40a315.0

package/index.cjs.js

@@ -133,6 +133,34 @@ const getMultipleCoordinatesFromGeoJsonObject = (geoObject) => {
     }
 };
 
+/**
+ * Group data that has smaller count then 0.5% (smallestCount) of total count if there is more than 3% (limitToStartGrouping) of them to "Others" group.
+ * It can help charts to look better.
+ *
+ * @param data Input data
+ * @param smallestCount Breaking point to start considering the item as candidate to "Others" group [in percentage] - default 0,5%
+ * @param limitToStartGrouping Lowest limit of candidates for grouping to "Others" [in percentage] - default 3%
+ */
+function groupTinyDataToOthers(data, smallestCount = 0.5, limitToStartGrouping = 3) {
+    if (!data || data.length < 2) {
+        return data;
+    }
+    const breakingPoint = (data.reduce((x, y) => ({ key: "GroupedOthers", count: x.count + y.count })).count * smallestCount) / 100;
+    if (data.filter(x => x.count <= breakingPoint).length < 2) {
+        return data;
+    }
+    const others = data
+        .filter(x => x.count <= breakingPoint)
+        .reduce((x, y) => ({ key: "GroupedOthers", count: x.count + y.count }));
+    const canGroupToOthers = others.count / data.reduce((x, y) => ({ key: "GroupedOthers", count: x.count + y.count })).count >
+        limitToStartGrouping / 100;
+    if (!canGroupToOthers) {
+        return data;
+    }
+    const temp = data.filter(x => x.count > breakingPoint);
+    return [...temp, others].sort((a, b) => a.count - b.count);
+}
+
 /**
  * Converts meters to yards
  *
@@ -965,6 +993,7 @@ exports.getPointCoordinateFromGeoJsonObject = getPointCoordinateFromGeoJsonObjec
 exports.getResizedDimensions = getResizedDimensions;
 exports.getStartOfDay = getStartOfDay;
 exports.groupBy = groupBy;
+exports.groupTinyDataToOthers = groupTinyDataToOthers;
 exports.hourIntervals = hourIntervals;
 exports.intersection = intersection;
 exports.isStringArrayEqual = isStringArrayEqual;

package/index.esm.js

@@ -129,6 +129,34 @@ const getMultipleCoordinatesFromGeoJsonObject = (geoObject) => {
     }
 };
 
+/**
+ * Group data that has smaller count then 0.5% (smallestCount) of total count if there is more than 3% (limitToStartGrouping) of them to "Others" group.
+ * It can help charts to look better.
+ *
+ * @param data Input data
+ * @param smallestCount Breaking point to start considering the item as candidate to "Others" group [in percentage] - default 0,5%
+ * @param limitToStartGrouping Lowest limit of candidates for grouping to "Others" [in percentage] - default 3%
+ */
+function groupTinyDataToOthers(data, smallestCount = 0.5, limitToStartGrouping = 3) {
+    if (!data || data.length < 2) {
+        return data;
+    }
+    const breakingPoint = (data.reduce((x, y) => ({ key: "GroupedOthers", count: x.count + y.count })).count * smallestCount) / 100;
+    if (data.filter(x => x.count <= breakingPoint).length < 2) {
+        return data;
+    }
+    const others = data
+        .filter(x => x.count <= breakingPoint)
+        .reduce((x, y) => ({ key: "GroupedOthers", count: x.count + y.count }));
+    const canGroupToOthers = others.count / data.reduce((x, y) => ({ key: "GroupedOthers", count: x.count + y.count })).count >
+        limitToStartGrouping / 100;
+    if (!canGroupToOthers) {
+        return data;
+    }
+    const temp = data.filter(x => x.count > breakingPoint);
+    return [...temp, others].sort((a, b) => a.count - b.count);
+}
+
 /**
  * Converts meters to yards
  *
@@ -932,4 +960,4 @@ const titleCase = (s) => {
  */
 const removeLeftPadding = (id) => Number(id === null || id === void 0 ? void 0 : id.replace(/-/g, "").replace(/^0+/, ""));
 
-export { DateTimeFormat, HoursAndMinutesFormat, align, arrayLengthCompare, arrayNotEmpty, booleanCompare, capitalize, convertBlobToBase64, convertMetersToYards, convertYardsToMeters, dateCompare, deleteUndefinedKeys, difference, doNothing, ensureArray, enumFromValue, enumFromValueTypesafe, enumOrUndefinedFromValue, exhaustiveCheck, filterByMultiple, formatAddress, formatCoordinates, fuzzySearch, getDifferenceBetweenDates, getEndOfDay, getISOStringFromDate, getMultipleCoordinatesFromGeoJsonObject, getPointCoordinateFromGeoJsonObject, getResizedDimensions, getStartOfDay, groupBy, hourIntervals, intersection, isStringArrayEqual, isUUID, isValidImage, nonNullable, numberCompare, numberCompareUnknownAfterHighest, objNotEmpty, removeLeftPadding, resizeBlob, resizeImage, size, stringCompare, stringCompareFromKey, stringNaturalCompare, titleCase, toID, toIDs, toUUID, toggle, trimIds, trimPath, truthy, unionArraysByKey };
+export { DateTimeFormat, HoursAndMinutesFormat, align, arrayLengthCompare, arrayNotEmpty, booleanCompare, capitalize, convertBlobToBase64, convertMetersToYards, convertYardsToMeters, dateCompare, deleteUndefinedKeys, difference, doNothing, ensureArray, enumFromValue, enumFromValueTypesafe, enumOrUndefinedFromValue, exhaustiveCheck, filterByMultiple, formatAddress, formatCoordinates, fuzzySearch, getDifferenceBetweenDates, getEndOfDay, getISOStringFromDate, getMultipleCoordinatesFromGeoJsonObject, getPointCoordinateFromGeoJsonObject, getResizedDimensions, getStartOfDay, groupBy, groupTinyDataToOthers, hourIntervals, intersection, isStringArrayEqual, isUUID, isValidImage, nonNullable, numberCompare, numberCompareUnknownAfterHighest, objNotEmpty, removeLeftPadding, resizeBlob, resizeImage, size, stringCompare, stringCompareFromKey, stringNaturalCompare, titleCase, toID, toIDs, toUUID, toggle, trimIds, trimPath, truthy, unionArraysByKey };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/shared-utils",
-  "version": "0.0.14",
+  "version": "0.0.16-alpha-500b40a315.0",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

package/src/GroupingUtility.d.ts

@@ -0,0 +1,13 @@
+export interface GroupingUtilityData {
+    key: string;
+    count: number;
+}
+/**
+ * Group data that has smaller count then 0.5% (smallestCount) of total count if there is more than 3% (limitToStartGrouping) of them to "Others" group.
+ * It can help charts to look better.
+ *
+ * @param data Input data
+ * @param smallestCount Breaking point to start considering the item as candidate to "Others" group [in percentage] - default 0,5%
+ * @param limitToStartGrouping Lowest limit of candidates for grouping to "Others" [in percentage] - default 3%
+ */
+export declare function groupTinyDataToOthers(data: GroupingUtilityData[] | undefined, smallestCount?: number, limitToStartGrouping?: number): GroupingUtilityData[] | undefined;

package/src/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./DateTimeFormat";
 export * from "./DateUtils";
 export * from "./GeoJsonUtils";
+export * from "./GroupingUtility";
 export * from "./UnitOfMeasurementConverter";
 export * from "./addressUtils";
 export * from "./arrayUtils";